Skip to content

Commit

Permalink
Adding shortname fetching for users and communities. Fixes #1662 (#1663)
Browse files Browse the repository at this point in the history
  • Loading branch information
dessalines authored and Nutomic committed Jul 30, 2021
1 parent 90e3850 commit 7fcd435
Show file tree
Hide file tree
Showing 10 changed files with 92 additions and 50 deletions.
21 changes: 13 additions & 8 deletions crates/api/src/site.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use lemmy_api_common::{
is_admin,
site::*,
};
use lemmy_apub::fetcher::search::search_by_apub_id;
use lemmy_apub::{build_actor_id_from_shortname, fetcher::search::search_by_apub_id, EndpointType};
use lemmy_db_queries::{
from_opt_str_to_opt_enum,
source::site::Site_,
Expand Down Expand Up @@ -167,7 +167,11 @@ impl Perform for Search {
let listing_type: Option<ListingType> = from_opt_str_to_opt_enum(&data.listing_type);
let search_type: SearchType = from_opt_str_to_opt_enum(&data.type_).unwrap_or(SearchType::All);
let community_id = data.community_id;
let community_name = data.community_name.to_owned();
let community_actor_id = data
.community_name
.as_ref()
.map(|t| build_actor_id_from_shortname(EndpointType::Community, t).ok())
.unwrap_or(None);
let creator_id = data.creator_id;
match search_type {
SearchType::Posts => {
Expand All @@ -179,7 +183,7 @@ impl Perform for Search {
.show_read_posts(show_read_posts)
.listing_type(listing_type)
.community_id(community_id)
.community_name(community_name)
.community_actor_id(community_actor_id)
.creator_id(creator_id)
.my_person_id(person_id)
.search_term(q)
Expand All @@ -197,7 +201,7 @@ impl Perform for Search {
.search_term(q)
.show_bot_accounts(show_bot_accounts)
.community_id(community_id)
.community_name(community_name)
.community_actor_id(community_actor_id)
.creator_id(creator_id)
.my_person_id(person_id)
.page(page)
Expand Down Expand Up @@ -234,6 +238,7 @@ impl Perform for Search {
// If the community or creator is included, dont search communities or users
let community_or_creator_included =
data.community_id.is_some() || data.community_name.is_some() || data.creator_id.is_some();
let community_actor_id_2 = community_actor_id.to_owned();

posts = blocking(context.pool(), move |conn| {
PostQueryBuilder::create(conn)
Expand All @@ -243,7 +248,7 @@ impl Perform for Search {
.show_read_posts(show_read_posts)
.listing_type(listing_type)
.community_id(community_id)
.community_name(community_name)
.community_actor_id(community_actor_id_2)
.creator_id(creator_id)
.my_person_id(person_id)
.search_term(q)
Expand All @@ -254,7 +259,7 @@ impl Perform for Search {
.await??;

let q = data.q.to_owned();
let community_name = data.community_name.to_owned();
let community_actor_id = community_actor_id.to_owned();

comments = blocking(context.pool(), move |conn| {
CommentQueryBuilder::create(conn)
Expand All @@ -263,7 +268,7 @@ impl Perform for Search {
.search_term(q)
.show_bot_accounts(show_bot_accounts)
.community_id(community_id)
.community_name(community_name)
.community_actor_id(community_actor_id)
.creator_id(creator_id)
.my_person_id(person_id)
.page(page)
Expand Down Expand Up @@ -316,7 +321,7 @@ impl Perform for Search {
.listing_type(listing_type)
.my_person_id(person_id)
.community_id(community_id)
.community_name(community_name)
.community_actor_id(community_actor_id)
.creator_id(creator_id)
.url_search(q)
.page(page)
Expand Down
1 change: 1 addition & 0 deletions crates/api_common/src/community.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use serde::{Deserialize, Serialize};
#[derive(Deserialize)]
pub struct GetCommunity {
pub id: Option<CommunityId>,
/// Example: star_trek , or star_trek@xyz.tld
pub name: Option<String>,
pub auth: Option<String>,
}
Expand Down
1 change: 1 addition & 0 deletions crates/api_common/src/person.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ pub struct LoginResponse {
#[derive(Deserialize)]
pub struct GetPersonDetails {
pub person_id: Option<PersonId>, // One of these two are required
/// Example: dessalines , or dessalines@xyz.tld
pub username: Option<String>,
pub sort: Option<String>,
pub page: Option<i64>,
Expand Down
9 changes: 7 additions & 2 deletions crates/api_crud/src/comment/read.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use crate::PerformCrud;
use actix_web::web::Data;
use lemmy_api_common::{blocking, comment::*, get_local_user_view_from_jwt_opt};
use lemmy_apub::{build_actor_id_from_shortname, EndpointType};
use lemmy_db_queries::{from_opt_str_to_opt_enum, ListingType, SortType};
use lemmy_db_views::comment_view::CommentQueryBuilder;
use lemmy_utils::{ApiError, ConnectionId, LemmyError};
Expand All @@ -27,7 +28,11 @@ impl PerformCrud for GetComments {
let listing_type: Option<ListingType> = from_opt_str_to_opt_enum(&data.type_);

let community_id = data.community_id;
let community_name = data.community_name.to_owned();
let community_actor_id = data
.community_name
.as_ref()
.map(|t| build_actor_id_from_shortname(EndpointType::Community, t).ok())
.unwrap_or(None);
let saved_only = data.saved_only;
let page = data.page;
let limit = data.limit;
Expand All @@ -37,7 +42,7 @@ impl PerformCrud for GetComments {
.sort(sort)
.saved_only(saved_only)
.community_id(community_id)
.community_name(community_name)
.community_actor_id(community_actor_id)
.my_person_id(person_id)
.show_bot_accounts(show_bot_accounts)
.page(page)
Expand Down
12 changes: 5 additions & 7 deletions crates/api_crud/src/community/read.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
use crate::PerformCrud;
use actix_web::web::Data;
use lemmy_api_common::{blocking, community::*, get_local_user_view_from_jwt_opt};
use lemmy_db_queries::{
from_opt_str_to_opt_enum,
source::community::Community_,
ListingType,
SortType,
};
use lemmy_apub::{build_actor_id_from_shortname, EndpointType};
use lemmy_db_queries::{from_opt_str_to_opt_enum, ApubObject, ListingType, SortType};
use lemmy_db_schema::source::community::*;
use lemmy_db_views_actor::{
community_moderator_view::CommunityModeratorView,
Expand All @@ -32,8 +28,10 @@ impl PerformCrud for GetCommunity {
Some(id) => id,
None => {
let name = data.name.to_owned().unwrap_or_else(|| "main".to_string());
let community_actor_id = build_actor_id_from_shortname(EndpointType::Community, &name)?;

blocking(context.pool(), move |conn| {
Community::read_from_name(conn, &name)
Community::read_from_apub_id(conn, &community_actor_id)
})
.await?
.map_err(|_| ApiError::err("couldnt_find_community"))?
Expand Down
9 changes: 7 additions & 2 deletions crates/api_crud/src/post/read.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use crate::PerformCrud;
use actix_web::web::Data;
use lemmy_api_common::{blocking, get_local_user_view_from_jwt_opt, mark_post_as_read, post::*};
use lemmy_apub::{build_actor_id_from_shortname, EndpointType};
use lemmy_db_queries::{from_opt_str_to_opt_enum, ListingType, SortType};
use lemmy_db_views::{
comment_view::CommentQueryBuilder,
Expand Down Expand Up @@ -111,7 +112,11 @@ impl PerformCrud for GetPosts {
let page = data.page;
let limit = data.limit;
let community_id = data.community_id;
let community_name = data.community_name.to_owned();
let community_actor_id = data
.community_name
.as_ref()
.map(|t| build_actor_id_from_shortname(EndpointType::Community, t).ok())
.unwrap_or(None);
let saved_only = data.saved_only;

let posts = blocking(context.pool(), move |conn| {
Expand All @@ -122,7 +127,7 @@ impl PerformCrud for GetPosts {
.show_bot_accounts(show_bot_accounts)
.show_read_posts(show_read_posts)
.community_id(community_id)
.community_name(community_name)
.community_actor_id(community_actor_id)
.saved_only(saved_only)
.my_person_id(person_id)
.page(page)
Expand Down
15 changes: 9 additions & 6 deletions crates/api_crud/src/user/read.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
use crate::PerformCrud;
use actix_web::web::Data;
use lemmy_api_common::{blocking, get_local_user_view_from_jwt_opt, person::*};
use lemmy_db_queries::{from_opt_str_to_opt_enum, source::person::Person_, SortType};
use lemmy_apub::{build_actor_id_from_shortname, EndpointType};
use lemmy_db_queries::{from_opt_str_to_opt_enum, ApubObject, SortType};
use lemmy_db_schema::source::person::*;
use lemmy_db_views::{comment_view::CommentQueryBuilder, post_view::PostQueryBuilder};
use lemmy_db_views_actor::{
Expand Down Expand Up @@ -34,15 +35,17 @@ impl PerformCrud for GetPersonDetails {

let sort: Option<SortType> = from_opt_str_to_opt_enum(&data.sort);

let username = data
.username
.to_owned()
.unwrap_or_else(|| "admin".to_string());
let person_details_id = match data.person_id {
Some(id) => id,
None => {
let name = data
.username
.to_owned()
.unwrap_or_else(|| "admin".to_string());
let actor_id = build_actor_id_from_shortname(EndpointType::Person, &name)?;

let person = blocking(context.pool(), move |conn| {
Person::find_by_name(conn, &username)
Person::read_from_apub_id(conn, &actor_id)
})
.await?;
person
Expand Down
45 changes: 35 additions & 10 deletions crates/apub/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -277,10 +277,11 @@ pub enum EndpointType {
PrivateMessage,
}

/// Generates the ActivityPub ID for a given object type and ID.
pub fn generate_apub_endpoint(
/// Generates an apub endpoint for a given domain, IE xyz.tld
pub fn generate_apub_endpoint_for_domain(
endpoint_type: EndpointType,
name: &str,
domain: &str,
) -> Result<DbUrl, ParseError> {
let point = match endpoint_type {
EndpointType::Community => "c",
Expand All @@ -290,14 +291,18 @@ pub fn generate_apub_endpoint(
EndpointType::PrivateMessage => "private_message",
};

Ok(
Url::parse(&format!(
"{}/{}/{}",
Settings::get().get_protocol_and_hostname(),
point,
name
))?
.into(),
Ok(Url::parse(&format!("{}/{}/{}", domain, point, name))?.into())
}

/// Generates the ActivityPub ID for a given object type and ID.
pub fn generate_apub_endpoint(
endpoint_type: EndpointType,
name: &str,
) -> Result<DbUrl, ParseError> {
generate_apub_endpoint_for_domain(
endpoint_type,
name,
&Settings::get().get_protocol_and_hostname(),
)
}

Expand Down Expand Up @@ -328,6 +333,26 @@ pub fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError
Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
}

/// Takes in a shortname of the type dessalines@xyz.tld or dessalines (assumed to be local), and outputs the actor id.
/// Used in the API for communities and users.
pub fn build_actor_id_from_shortname(
endpoint_type: EndpointType,
short_name: &str,
) -> Result<DbUrl, ParseError> {
let split = short_name.split('@').collect::<Vec<&str>>();

let name = split[0];

// If there's no @, its local
let domain = if split.len() == 1 {
Settings::get().get_protocol_and_hostname()
} else {
format!("https://{}", split[1])
};

generate_apub_endpoint_for_domain(endpoint_type, name, &domain)
}

/// Store a sent or received activity in the database, for logging purposes. These records are not
/// persistent.
pub async fn insert_activity<T>(
Expand Down
15 changes: 7 additions & 8 deletions crates/db_views/src/comment_view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ use lemmy_db_schema::{
},
CommentId,
CommunityId,
DbUrl,
PersonId,
PostId,
};
Expand Down Expand Up @@ -175,7 +176,7 @@ pub struct CommentQueryBuilder<'a> {
listing_type: Option<ListingType>,
sort: Option<SortType>,
community_id: Option<CommunityId>,
community_name: Option<String>,
community_actor_id: Option<DbUrl>,
post_id: Option<PostId>,
creator_id: Option<PersonId>,
recipient_id: Option<PersonId>,
Expand All @@ -195,7 +196,7 @@ impl<'a> CommentQueryBuilder<'a> {
listing_type: None,
sort: None,
community_id: None,
community_name: None,
community_actor_id: None,
post_id: None,
creator_id: None,
recipient_id: None,
Expand Down Expand Up @@ -244,8 +245,8 @@ impl<'a> CommentQueryBuilder<'a> {
self
}

pub fn community_name<T: MaybeOptional<String>>(mut self, community_name: T) -> Self {
self.community_name = community_name.get_optional();
pub fn community_actor_id<T: MaybeOptional<DbUrl>>(mut self, community_actor_id: T) -> Self {
self.community_actor_id = community_actor_id.get_optional();
self
}

Expand Down Expand Up @@ -362,10 +363,8 @@ impl<'a> CommentQueryBuilder<'a> {
query = query.filter(post::community_id.eq(community_id));
}

if let Some(community_name) = self.community_name {
query = query
.filter(community::name.eq(community_name))
.filter(comment::local.eq(true));
if let Some(community_actor_id) = self.community_actor_id {
query = query.filter(community::actor_id.eq(community_actor_id))
}

if let Some(post_id) = self.post_id {
Expand Down
14 changes: 7 additions & 7 deletions crates/db_views/src/post_view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ use lemmy_db_schema::{
post::{Post, PostRead, PostSaved},
},
CommunityId,
DbUrl,
PersonId,
PostId,
};
Expand Down Expand Up @@ -159,7 +160,7 @@ pub struct PostQueryBuilder<'a> {
sort: Option<SortType>,
creator_id: Option<PersonId>,
community_id: Option<CommunityId>,
community_name: Option<String>,
community_actor_id: Option<DbUrl>,
my_person_id: Option<PersonId>,
search_term: Option<String>,
url_search: Option<String>,
Expand All @@ -179,7 +180,7 @@ impl<'a> PostQueryBuilder<'a> {
sort: None,
creator_id: None,
community_id: None,
community_name: None,
community_actor_id: None,
my_person_id: None,
search_term: None,
url_search: None,
Expand Down Expand Up @@ -212,8 +213,8 @@ impl<'a> PostQueryBuilder<'a> {
self
}

pub fn community_name<T: MaybeOptional<String>>(mut self, community_name: T) -> Self {
self.community_name = community_name.get_optional();
pub fn community_actor_id<T: MaybeOptional<DbUrl>>(mut self, community_actor_id: T) -> Self {
self.community_actor_id = community_actor_id.get_optional();
self
}

Expand Down Expand Up @@ -334,10 +335,9 @@ impl<'a> PostQueryBuilder<'a> {
.then_order_by(post_aggregates::stickied.desc());
}

if let Some(community_name) = self.community_name {
if let Some(community_actor_id) = self.community_actor_id {
query = query
.filter(community::name.eq(community_name))
.filter(community::local.eq(true))
.filter(community::actor_id.eq(community_actor_id))
.then_order_by(post_aggregates::stickied.desc());
}

Expand Down

0 comments on commit 7fcd435

Please sign in to comment.