// This is for db migrations that require code
+use activitypub_federation::core::signatures::generate_actor_keypair;
use diesel::{
sql_types::{Nullable, Text},
- *,
+ ExpressionMethods,
+ IntoSql,
+ QueryDsl,
+ TextExpressionMethods,
};
-use lemmy_db_queries::{
- source::{comment::Comment_, post::Post_, private_message::PrivateMessage_},
- Crud,
+use diesel_async::RunQueryDsl;
+use lemmy_api_common::{
+ generate_followers_url,
+ generate_inbox_url,
+ generate_local_apub_endpoint,
+ generate_shared_inbox_url,
+ generate_site_inbox_url,
+ lemmy_db_views::structs::SiteView,
+ EndpointType,
};
use lemmy_db_schema::{
- naive_now,
source::{
- comment::Comment,
- community::{Community, CommunityForm},
- post::Post,
- private_message::PrivateMessage,
- user::{UserForm, User_},
+ comment::{Comment, CommentUpdateForm},
+ community::{Community, CommunityUpdateForm},
+ instance::Instance,
+ local_site::{LocalSite, LocalSiteInsertForm},
+ local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitInsertForm},
+ local_user::{LocalUser, LocalUserInsertForm},
+ person::{Person, PersonInsertForm, PersonUpdateForm},
+ post::{Post, PostUpdateForm},
+ private_message::{PrivateMessage, PrivateMessageUpdateForm},
+ site::{Site, SiteInsertForm, SiteUpdateForm},
},
+ traits::Crud,
+ utils::{get_conn, naive_now, DbPool},
};
-use lemmy_utils::{
- apub::{generate_actor_keypair, make_apub_endpoint, EndpointType},
- settings::Settings,
- LemmyError,
-};
-use log::info;
-
-pub fn run_advanced_migrations(conn: &PgConnection) -> Result<(), LemmyError> {
- user_updates_2020_04_02(&conn)?;
- community_updates_2020_04_02(&conn)?;
- post_updates_2020_04_03(&conn)?;
- comment_updates_2020_04_03(&conn)?;
- private_message_updates_2020_05_05(&conn)?;
- post_thumbnail_url_updates_2020_07_27(&conn)?;
+use lemmy_utils::{error::LemmyError, settings::structs::Settings};
+use tracing::info;
+use url::Url;
+
+pub async fn run_advanced_migrations(pool: &DbPool, settings: &Settings) -> Result<(), LemmyError> {
+ let protocol_and_hostname = &settings.get_protocol_and_hostname();
+ user_updates_2020_04_02(pool, protocol_and_hostname).await?;
+ community_updates_2020_04_02(pool, protocol_and_hostname).await?;
+ post_updates_2020_04_03(pool, protocol_and_hostname).await?;
+ comment_updates_2020_04_03(pool, protocol_and_hostname).await?;
+ private_message_updates_2020_05_05(pool, protocol_and_hostname).await?;
+ post_thumbnail_url_updates_2020_07_27(pool, protocol_and_hostname).await?;
+ apub_columns_2021_02_02(pool).await?;
+ instance_actor_2022_01_28(pool, protocol_and_hostname).await?;
+ regenerate_public_keys_2022_07_05(pool).await?;
+ initialize_local_site_2022_10_10(pool, settings).await?;
Ok(())
}
-fn user_updates_2020_04_02(conn: &PgConnection) -> Result<(), LemmyError> {
- use lemmy_db_schema::schema::user_::dsl::*;
+async fn user_updates_2020_04_02(
+ pool: &DbPool,
+ protocol_and_hostname: &str,
+) -> Result<(), LemmyError> {
+ use lemmy_db_schema::schema::person::dsl::{actor_id, local, person};
+ let conn = &mut get_conn(pool).await?;
info!("Running user_updates_2020_04_02");
// Update the actor_id, private_key, and public_key, last_refreshed_at
- let incorrect_users = user_
- .filter(actor_id.like("changeme_%"))
+ let incorrect_persons = person
+ .filter(actor_id.like("http://changeme%"))
.filter(local.eq(true))
- .load::<User_>(conn)?;
+ .load::<Person>(conn)
+ .await?;
- for cuser in &incorrect_users {
+ for cperson in &incorrect_persons {
let keypair = generate_actor_keypair()?;
- let form = UserForm {
- name: cuser.name.to_owned(),
- email: Some(cuser.email.to_owned()),
- matrix_user_id: Some(cuser.matrix_user_id.to_owned()),
- avatar: Some(cuser.avatar.to_owned()),
- banner: Some(cuser.banner.to_owned()),
- password_encrypted: cuser.password_encrypted.to_owned(),
- preferred_username: Some(cuser.preferred_username.to_owned()),
- published: Some(cuser.published),
- updated: None,
- admin: cuser.admin,
- banned: Some(cuser.banned),
- show_nsfw: cuser.show_nsfw,
- theme: cuser.theme.to_owned(),
- default_sort_type: cuser.default_sort_type,
- default_listing_type: cuser.default_listing_type,
- lang: cuser.lang.to_owned(),
- show_avatars: cuser.show_avatars,
- send_notifications_to_email: cuser.send_notifications_to_email,
- actor_id: Some(make_apub_endpoint(EndpointType::User, &cuser.name).to_string()),
- bio: Some(cuser.bio.to_owned()),
- local: cuser.local,
- private_key: Some(keypair.private_key),
- public_key: Some(keypair.public_key),
- last_refreshed_at: Some(naive_now()),
- };
-
- User_::update(&conn, cuser.id, &form)?;
+ let form = PersonUpdateForm::builder()
+ .actor_id(Some(generate_local_apub_endpoint(
+ EndpointType::Person,
+ &cperson.name,
+ protocol_and_hostname,
+ )?))
+ .private_key(Some(Some(keypair.private_key)))
+ .public_key(Some(keypair.public_key))
+ .last_refreshed_at(Some(naive_now()))
+ .build();
+
+ Person::update(pool, cperson.id, &form).await?;
}
- info!("{} user rows updated.", incorrect_users.len());
+ info!("{} person rows updated.", incorrect_persons.len());
Ok(())
}
-fn community_updates_2020_04_02(conn: &PgConnection) -> Result<(), LemmyError> {
- use lemmy_db_schema::schema::community::dsl::*;
+async fn community_updates_2020_04_02(
+ pool: &DbPool,
+ protocol_and_hostname: &str,
+) -> Result<(), LemmyError> {
+ use lemmy_db_schema::schema::community::dsl::{actor_id, community, local};
+ let conn = &mut get_conn(pool).await?;
info!("Running community_updates_2020_04_02");
// Update the actor_id, private_key, and public_key, last_refreshed_at
let incorrect_communities = community
- .filter(actor_id.like("changeme_%"))
+ .filter(actor_id.like("http://changeme%"))
.filter(local.eq(true))
- .load::<Community>(conn)?;
+ .load::<Community>(conn)
+ .await?;
for ccommunity in &incorrect_communities {
let keypair = generate_actor_keypair()?;
-
- let form = CommunityForm {
- name: ccommunity.name.to_owned(),
- title: ccommunity.title.to_owned(),
- description: ccommunity.description.to_owned(),
- category_id: ccommunity.category_id,
- creator_id: ccommunity.creator_id,
- removed: None,
- deleted: None,
- nsfw: ccommunity.nsfw,
- updated: None,
- actor_id: Some(make_apub_endpoint(EndpointType::Community, &ccommunity.name).to_string()),
- local: ccommunity.local,
- private_key: Some(keypair.private_key),
- public_key: Some(keypair.public_key),
- last_refreshed_at: Some(naive_now()),
- published: None,
- icon: Some(ccommunity.icon.to_owned()),
- banner: Some(ccommunity.banner.to_owned()),
- };
-
- Community::update(&conn, ccommunity.id, &form)?;
+ let community_actor_id = generate_local_apub_endpoint(
+ EndpointType::Community,
+ &ccommunity.name,
+ protocol_and_hostname,
+ )?;
+
+ let form = CommunityUpdateForm::builder()
+ .actor_id(Some(community_actor_id.clone()))
+ .private_key(Some(Some(keypair.private_key)))
+ .public_key(Some(keypair.public_key))
+ .last_refreshed_at(Some(naive_now()))
+ .build();
+
+ Community::update(pool, ccommunity.id, &form).await?;
}
info!("{} community rows updated.", incorrect_communities.len());
Ok(())
}
-fn post_updates_2020_04_03(conn: &PgConnection) -> Result<(), LemmyError> {
- use lemmy_db_schema::schema::post::dsl::*;
+async fn post_updates_2020_04_03(
+ pool: &DbPool,
+ protocol_and_hostname: &str,
+) -> Result<(), LemmyError> {
+ use lemmy_db_schema::schema::post::dsl::{ap_id, local, post};
+ let conn = &mut get_conn(pool).await?;
info!("Running post_updates_2020_04_03");
// Update the ap_id
let incorrect_posts = post
- .filter(ap_id.eq("changeme_%"))
+ .filter(ap_id.like("http://changeme%"))
.filter(local.eq(true))
- .load::<Post>(conn)?;
+ .load::<Post>(conn)
+ .await?;
for cpost in &incorrect_posts {
- let apub_id = make_apub_endpoint(EndpointType::Post, &cpost.id.to_string()).to_string();
- Post::update_ap_id(&conn, cpost.id, apub_id)?;
+ let apub_id = generate_local_apub_endpoint(
+ EndpointType::Post,
+ &cpost.id.to_string(),
+ protocol_and_hostname,
+ )?;
+ Post::update(
+ pool,
+ cpost.id,
+ &PostUpdateForm::builder().ap_id(Some(apub_id)).build(),
+ )
+ .await?;
}
info!("{} post rows updated.", incorrect_posts.len());
Ok(())
}
-fn comment_updates_2020_04_03(conn: &PgConnection) -> Result<(), LemmyError> {
- use lemmy_db_schema::schema::comment::dsl::*;
+async fn comment_updates_2020_04_03(
+ pool: &DbPool,
+ protocol_and_hostname: &str,
+) -> Result<(), LemmyError> {
+ use lemmy_db_schema::schema::comment::dsl::{ap_id, comment, local};
+ let conn = &mut get_conn(pool).await?;
info!("Running comment_updates_2020_04_03");
// Update the ap_id
let incorrect_comments = comment
- .filter(ap_id.eq("changeme_%"))
+ .filter(ap_id.like("http://changeme%"))
.filter(local.eq(true))
- .load::<Comment>(conn)?;
+ .load::<Comment>(conn)
+ .await?;
for ccomment in &incorrect_comments {
- let apub_id = make_apub_endpoint(EndpointType::Comment, &ccomment.id.to_string()).to_string();
- Comment::update_ap_id(&conn, ccomment.id, apub_id)?;
+ let apub_id = generate_local_apub_endpoint(
+ EndpointType::Comment,
+ &ccomment.id.to_string(),
+ protocol_and_hostname,
+ )?;
+ Comment::update(
+ pool,
+ ccomment.id,
+ &CommentUpdateForm::builder().ap_id(Some(apub_id)).build(),
+ )
+ .await?;
}
info!("{} comment rows updated.", incorrect_comments.len());
Ok(())
}
-fn private_message_updates_2020_05_05(conn: &PgConnection) -> Result<(), LemmyError> {
- use lemmy_db_schema::schema::private_message::dsl::*;
+async fn private_message_updates_2020_05_05(
+ pool: &DbPool,
+ protocol_and_hostname: &str,
+) -> Result<(), LemmyError> {
+ use lemmy_db_schema::schema::private_message::dsl::{ap_id, local, private_message};
+ let conn = &mut get_conn(pool).await?;
info!("Running private_message_updates_2020_05_05");
// Update the ap_id
let incorrect_pms = private_message
- .filter(ap_id.eq("changeme_%"))
+ .filter(ap_id.like("http://changeme%"))
.filter(local.eq(true))
- .load::<PrivateMessage>(conn)?;
+ .load::<PrivateMessage>(conn)
+ .await?;
for cpm in &incorrect_pms {
- let apub_id = make_apub_endpoint(EndpointType::PrivateMessage, &cpm.id.to_string()).to_string();
- PrivateMessage::update_ap_id(&conn, cpm.id, apub_id)?;
+ let apub_id = generate_local_apub_endpoint(
+ EndpointType::PrivateMessage,
+ &cpm.id.to_string(),
+ protocol_and_hostname,
+ )?;
+ PrivateMessage::update(
+ pool,
+ cpm.id,
+ &PrivateMessageUpdateForm::builder()
+ .ap_id(Some(apub_id))
+ .build(),
+ )
+ .await?;
}
info!("{} private message rows updated.", incorrect_pms.len());
Ok(())
}
-fn post_thumbnail_url_updates_2020_07_27(conn: &PgConnection) -> Result<(), LemmyError> {
- use lemmy_db_schema::schema::post::dsl::*;
+async fn post_thumbnail_url_updates_2020_07_27(
+ pool: &DbPool,
+ protocol_and_hostname: &str,
+) -> Result<(), LemmyError> {
+ use lemmy_db_schema::schema::post::dsl::{post, thumbnail_url};
+ let conn = &mut get_conn(pool).await?;
info!("Running post_thumbnail_url_updates_2020_07_27");
- let domain_prefix = format!(
- "{}/pictrs/image/",
- Settings::get().get_protocol_and_hostname(),
- );
+ let domain_prefix = format!("{}/pictrs/image/", protocol_and_hostname,);
let incorrect_thumbnails = post.filter(thumbnail_url.not_like("http%"));
.concat(thumbnail_url),
),
)
- .get_results::<Post>(conn)?;
+ .get_results::<Post>(conn)
+ .await?;
info!("{} Post thumbnail_url rows updated.", res.len());
Ok(())
}
+
+/// We are setting inbox and follower URLs for local and remote actors alike, because for now
+/// all federated instances are also Lemmy and use the same URL scheme.
+async fn apub_columns_2021_02_02(pool: &DbPool) -> Result<(), LemmyError> {
+ let conn = &mut get_conn(pool).await?;
+ info!("Running apub_columns_2021_02_02");
+ {
+ use lemmy_db_schema::schema::person::dsl::{inbox_url, person, shared_inbox_url};
+ let persons = person
+ .filter(inbox_url.like("http://changeme%"))
+ .load::<Person>(conn)
+ .await?;
+
+ for p in &persons {
+ let inbox_url_ = generate_inbox_url(&p.actor_id)?;
+ let shared_inbox_url_ = generate_shared_inbox_url(&p.actor_id)?;
+ diesel::update(person.find(p.id))
+ .set((
+ inbox_url.eq(inbox_url_),
+ shared_inbox_url.eq(shared_inbox_url_),
+ ))
+ .get_result::<Person>(conn)
+ .await?;
+ }
+ }
+
+ {
+ use lemmy_db_schema::schema::community::dsl::{
+ community,
+ followers_url,
+ inbox_url,
+ shared_inbox_url,
+ };
+ let communities = community
+ .filter(inbox_url.like("http://changeme%"))
+ .load::<Community>(conn)
+ .await?;
+
+ for c in &communities {
+ let followers_url_ = generate_followers_url(&c.actor_id)?;
+ let inbox_url_ = generate_inbox_url(&c.actor_id)?;
+ let shared_inbox_url_ = generate_shared_inbox_url(&c.actor_id)?;
+ diesel::update(community.find(c.id))
+ .set((
+ followers_url.eq(followers_url_),
+ inbox_url.eq(inbox_url_),
+ shared_inbox_url.eq(shared_inbox_url_),
+ ))
+ .get_result::<Community>(conn)
+ .await?;
+ }
+ }
+
+ Ok(())
+}
+
+/// Site object turns into an actor, so that things like instance description can be federated. This
+/// means we need to add actor columns to the site table, and initialize them with correct values.
+/// Before this point, there is only a single value in the site table which refers to the local
+/// Lemmy instance, so thats all we need to update.
+async fn instance_actor_2022_01_28(
+ pool: &DbPool,
+ protocol_and_hostname: &str,
+) -> Result<(), LemmyError> {
+ info!("Running instance_actor_2021_09_29");
+ if let Ok(site_view) = SiteView::read_local(pool).await {
+ let site = site_view.site;
+ // if site already has public key, we dont need to do anything here
+ if !site.public_key.is_empty() {
+ return Ok(());
+ }
+ let key_pair = generate_actor_keypair()?;
+ let actor_id = Url::parse(protocol_and_hostname)?;
+ let site_form = SiteUpdateForm::builder()
+ .actor_id(Some(actor_id.clone().into()))
+ .last_refreshed_at(Some(naive_now()))
+ .inbox_url(Some(generate_site_inbox_url(&actor_id.into())?))
+ .private_key(Some(Some(key_pair.private_key)))
+ .public_key(Some(key_pair.public_key))
+ .build();
+ Site::update(pool, site.id, &site_form).await?;
+ }
+ Ok(())
+}
+
+/// Fix for bug #2347, which can result in community/person public keys being overwritten with
+/// empty string when the database value is updated. We go through all actors, and if the public
+/// key field is empty, generate a new keypair. It would be possible to regenerate only the pubkey,
+/// but thats more complicated and has no benefit, as federation is already broken for these actors.
+/// https://github.com/LemmyNet/lemmy/issues/2347
+async fn regenerate_public_keys_2022_07_05(pool: &DbPool) -> Result<(), LemmyError> {
+ let conn = &mut get_conn(pool).await?;
+ info!("Running regenerate_public_keys_2022_07_05");
+
+ {
+ // update communities with empty pubkey
+ use lemmy_db_schema::schema::community::dsl::{community, local, public_key};
+ let communities: Vec<Community> = community
+ .filter(local.eq(true))
+ .filter(public_key.eq(""))
+ .load::<Community>(conn)
+ .await?;
+ for community_ in communities {
+ info!(
+ "local community {} has empty public key field, regenerating key",
+ community_.name
+ );
+ let key_pair = generate_actor_keypair()?;
+ let form = CommunityUpdateForm::builder()
+ .public_key(Some(key_pair.public_key))
+ .private_key(Some(Some(key_pair.private_key)))
+ .build();
+ Community::update(pool, community_.id, &form).await?;
+ }
+ }
+
+ {
+ // update persons with empty pubkey
+ use lemmy_db_schema::schema::person::dsl::{local, person, public_key};
+ let persons = person
+ .filter(local.eq(true))
+ .filter(public_key.eq(""))
+ .load::<Person>(conn)
+ .await?;
+ for person_ in persons {
+ info!(
+ "local user {} has empty public key field, regenerating key",
+ person_.name
+ );
+ let key_pair = generate_actor_keypair()?;
+ let form = PersonUpdateForm::builder()
+ .public_key(Some(key_pair.public_key))
+ .private_key(Some(Some(key_pair.private_key)))
+ .build();
+ Person::update(pool, person_.id, &form).await?;
+ }
+ }
+ Ok(())
+}
+
+/// This ensures that your local site is initialized and exists.
+///
+/// If a site already exists, the DB migration should generate a local_site row.
+/// This will only be run for brand new sites.
+async fn initialize_local_site_2022_10_10(
+ pool: &DbPool,
+ settings: &Settings,
+) -> Result<(), LemmyError> {
+ info!("Running initialize_local_site_2022_10_10");
+
+ // Check to see if local_site exists
+ if LocalSite::read(pool).await.is_ok() {
+ return Ok(());
+ }
+ info!("No Local Site found, creating it.");
+
+ let domain = settings
+ .get_hostname_without_port()
+ .expect("must have domain");
+
+ // Upsert this to the instance table
+ let instance = Instance::create(pool, &domain).await?;
+
+ if let Some(setup) = &settings.setup {
+ let person_keypair = generate_actor_keypair()?;
+ let person_actor_id = generate_local_apub_endpoint(
+ EndpointType::Person,
+ &setup.admin_username,
+ &settings.get_protocol_and_hostname(),
+ )?;
+
+ // Register the user if there's a site setup
+ let person_form = PersonInsertForm::builder()
+ .name(setup.admin_username.clone())
+ .admin(Some(true))
+ .instance_id(instance.id)
+ .actor_id(Some(person_actor_id.clone()))
+ .private_key(Some(person_keypair.private_key))
+ .public_key(person_keypair.public_key)
+ .inbox_url(Some(generate_inbox_url(&person_actor_id)?))
+ .shared_inbox_url(Some(generate_shared_inbox_url(&person_actor_id)?))
+ .build();
+ let person_inserted = Person::create(pool, &person_form).await?;
+
+ let local_user_form = LocalUserInsertForm::builder()
+ .person_id(person_inserted.id)
+ .password_encrypted(setup.admin_password.clone())
+ .email(setup.admin_email.clone())
+ .build();
+ LocalUser::create(pool, &local_user_form).await?;
+ };
+
+ // Add an entry for the site table
+ let site_key_pair = generate_actor_keypair()?;
+ let site_actor_id = Url::parse(&settings.get_protocol_and_hostname())?;
+
+ let site_form = SiteInsertForm::builder()
+ .name(
+ settings
+ .setup
+ .clone()
+ .map(|s| s.site_name)
+ .unwrap_or_else(|| "New Site".to_string()),
+ )
+ .instance_id(instance.id)
+ .actor_id(Some(site_actor_id.clone().into()))
+ .last_refreshed_at(Some(naive_now()))
+ .inbox_url(Some(generate_site_inbox_url(&site_actor_id.into())?))
+ .private_key(Some(site_key_pair.private_key))
+ .public_key(Some(site_key_pair.public_key))
+ .build();
+ let site = Site::create(pool, &site_form).await?;
+
+ // Finally create the local_site row
+ let local_site_form = LocalSiteInsertForm::builder()
+ .site_id(site.id)
+ .site_setup(Some(settings.setup.is_some()))
+ .build();
+ let local_site = LocalSite::create(pool, &local_site_form).await?;
+
+ // Create the rate limit table
+ let local_site_rate_limit_form = LocalSiteRateLimitInsertForm::builder()
+ // TODO these have to be set, because the database defaults are too low for the federation
+ // tests to pass, and there's no way to live update the rate limits without restarting the
+ // server.
+ // This can be removed once live rate limits are enabled.
+ .message(Some(999))
+ .post(Some(999))
+ .register(Some(999))
+ .image(Some(999))
+ .comment(Some(999))
+ .search(Some(999))
+ .local_site_id(local_site.id)
+ .build();
+ LocalSiteRateLimit::create(pool, &local_site_rate_limit_form).await?;
+
+ Ok(())
+}