crates/routes/src/feeds.rs

   1 use actix_web::{error::ErrorBadRequest, *};
   2 use anyhow::anyhow;
   3 use chrono::{DateTime, NaiveDateTime, Utc};
   4 use diesel::PgConnection;
   5 use lemmy_api_common::utils::blocking;
   6 use lemmy_db_schema::{
   7   newtypes::LocalUserId,
   8   source::{community::Community, local_user::LocalUser, person::Person},
   9   traits::{ApubActor, Crud},
  10   ListingType,
  11   SortType,
  12 };
  13 use lemmy_db_views::{
  14   comment_view::CommentQueryBuilder,
  15   post_view::PostQueryBuilder,
  16   structs::{CommentView, PostView, SiteView},
  17 };
  18 use lemmy_db_views_actor::{
  19   person_mention_view::PersonMentionQueryBuilder,
  20   structs::PersonMentionView,
  21 };
  22 use lemmy_utils::{claims::Claims, error::LemmyError, utils::markdown_to_html};
  23 use lemmy_websocket::LemmyContext;
  24 use once_cell::sync::Lazy;
  25 use rss::{
  26   extension::dublincore::DublinCoreExtensionBuilder,
  27   ChannelBuilder,
  28   GuidBuilder,
  29   Item,
  30   ItemBuilder,
  31 };
  32 use serde::Deserialize;
  33 use std::{collections::BTreeMap, str::FromStr};
  34 use strum::ParseError;
  35
  36 const RSS_FETCH_LIMIT: i64 = 20;
  37
  38 #[derive(Deserialize)]
  39 struct Params {
  40   sort: Option<String>,
  41 }
  42
  43 enum RequestType {
  44   Community,
  45   User,
  46   Front,
  47   Inbox,
  48 }
  49
  50 pub fn config(cfg: &mut web::ServiceConfig) {
  51   cfg
  52     .route("/feeds/{type}/{name}.xml", web::get().to(get_feed))
  53     .route("/feeds/all.xml", web::get().to(get_all_feed))
  54     .route("/feeds/local.xml", web::get().to(get_local_feed));
  55 }
  56
  57 static RSS_NAMESPACE: Lazy<BTreeMap<String, String>> = Lazy::new(|| {
  58   let mut h = BTreeMap::new();
  59   h.insert(
  60     "dc".to_string(),
  61     rss::extension::dublincore::NAMESPACE.to_string(),
  62   );
  63   h
  64 });
  65
  66 #[tracing::instrument(skip_all)]
  67 async fn get_all_feed(
  68   info: web::Query<Params>,
  69   context: web::Data<LemmyContext>,
  70 ) -> Result<HttpResponse, Error> {
  71   let sort_type = get_sort_type(info).map_err(ErrorBadRequest)?;
  72   Ok(get_feed_data(&context, ListingType::All, sort_type).await?)
  73 }
  74
  75 #[tracing::instrument(skip_all)]
  76 async fn get_local_feed(
  77   info: web::Query<Params>,
  78   context: web::Data<LemmyContext>,
  79 ) -> Result<HttpResponse, Error> {
  80   let sort_type = get_sort_type(info).map_err(ErrorBadRequest)?;
  81   Ok(get_feed_data(&context, ListingType::Local, sort_type).await?)
  82 }
  83
  84 #[tracing::instrument(skip_all)]
  85 async fn get_feed_data(
  86   context: &LemmyContext,
  87   listing_type: ListingType,
  88   sort_type: SortType,
  89 ) -> Result<HttpResponse, LemmyError> {
  90   let site_view = blocking(context.pool(), SiteView::read_local).await??;
  91
  92   let posts = blocking(context.pool(), move |conn| {
  93     PostQueryBuilder::create(conn)
  94       .listing_type(listing_type)
  95       .sort(sort_type)
  96       .limit(RSS_FETCH_LIMIT)
  97       .list()
  98   })
  99   .await??;
 100
 101   let items = create_post_items(posts, &context.settings().get_protocol_and_hostname())?;
 102
 103   let mut channel_builder = ChannelBuilder::default();
 104   channel_builder
 105     .namespaces(RSS_NAMESPACE.to_owned())
 106     .title(&format!("{} - {}", site_view.site.name, listing_type))
 107     .link(context.settings().get_protocol_and_hostname())
 108     .items(items);
 109
 110   if let Some(site_desc) = site_view.site.description {
 111     channel_builder.description(&site_desc);
 112   }
 113
 114   let rss = channel_builder.build().to_string();
 115   Ok(
 116     HttpResponse::Ok()
 117       .content_type("application/rss+xml")
 118       .body(rss),
 119   )
 120 }
 121
 122 #[tracing::instrument(skip_all)]
 123 async fn get_feed(
 124   req: HttpRequest,
 125   info: web::Query<Params>,
 126   context: web::Data<LemmyContext>,
 127 ) -> Result<HttpResponse, Error> {
 128   let sort_type = get_sort_type(info).map_err(ErrorBadRequest)?;
 129
 130   let req_type: String = req.match_info().get("type").unwrap_or("none").parse()?;
 131   let param: String = req.match_info().get("name").unwrap_or("none").parse()?;
 132
 133   let request_type = match req_type.as_str() {
 134     "u" => RequestType::User,
 135     "c" => RequestType::Community,
 136     "front" => RequestType::Front,
 137     "inbox" => RequestType::Inbox,
 138     _ => return Err(ErrorBadRequest(LemmyError::from(anyhow!("wrong_type")))),
 139   };
 140
 141   let jwt_secret = context.secret().jwt_secret.to_owned();
 142   let protocol_and_hostname = context.settings().get_protocol_and_hostname();
 143
 144   let builder = blocking(context.pool(), move |conn| match request_type {
 145     RequestType::User => get_feed_user(conn, &sort_type, &param, &protocol_and_hostname),
 146     RequestType::Community => get_feed_community(conn, &sort_type, &param, &protocol_and_hostname),
 147     RequestType::Front => get_feed_front(
 148       conn,
 149       &jwt_secret,
 150       &sort_type,
 151       &param,
 152       &protocol_and_hostname,
 153     ),
 154     RequestType::Inbox => get_feed_inbox(conn, &jwt_secret, &param, &protocol_and_hostname),
 155   })
 156   .await?
 157   .map_err(ErrorBadRequest)?;
 158
 159   let rss = builder.build().to_string();
 160
 161   Ok(
 162     HttpResponse::Ok()
 163       .content_type("application/rss+xml")
 164       .body(rss),
 165   )
 166 }
 167
 168 fn get_sort_type(info: web::Query<Params>) -> Result<SortType, ParseError> {
 169   let sort_query = info
 170     .sort
 171     .to_owned()
 172     .unwrap_or_else(|| SortType::Hot.to_string());
 173   SortType::from_str(&sort_query)
 174 }
 175
 176 #[tracing::instrument(skip_all)]
 177 fn get_feed_user(
 178   conn: &PgConnection,
 179   sort_type: &SortType,
 180   user_name: &str,
 181   protocol_and_hostname: &str,
 182 ) -> Result<ChannelBuilder, LemmyError> {
 183   let site_view = SiteView::read_local(conn)?;
 184   let person = Person::read_from_name(conn, user_name)?;
 185
 186   let posts = PostQueryBuilder::create(conn)
 187     .listing_type(ListingType::All)
 188     .sort(*sort_type)
 189     .creator_id(person.id)
 190     .limit(RSS_FETCH_LIMIT)
 191     .list()?;
 192
 193   let items = create_post_items(posts, protocol_and_hostname)?;
 194
 195   let mut channel_builder = ChannelBuilder::default();
 196   channel_builder
 197     .namespaces(RSS_NAMESPACE.to_owned())
 198     .title(&format!("{} - {}", site_view.site.name, person.name))
 199     .link(person.actor_id.to_string())
 200     .items(items);
 201
 202   Ok(channel_builder)
 203 }
 204
 205 #[tracing::instrument(skip_all)]
 206 fn get_feed_community(
 207   conn: &PgConnection,
 208   sort_type: &SortType,
 209   community_name: &str,
 210   protocol_and_hostname: &str,
 211 ) -> Result<ChannelBuilder, LemmyError> {
 212   let site_view = SiteView::read_local(conn)?;
 213   let community = Community::read_from_name(conn, community_name)?;
 214
 215   let posts = PostQueryBuilder::create(conn)
 216     .listing_type(ListingType::Community)
 217     .sort(*sort_type)
 218     .community_id(community.id)
 219     .limit(RSS_FETCH_LIMIT)
 220     .list()?;
 221
 222   let items = create_post_items(posts, protocol_and_hostname)?;
 223
 224   let mut channel_builder = ChannelBuilder::default();
 225   channel_builder
 226     .namespaces(RSS_NAMESPACE.to_owned())
 227     .title(&format!("{} - {}", site_view.site.name, community.name))
 228     .link(community.actor_id.to_string())
 229     .items(items);
 230
 231   if let Some(community_desc) = community.description {
 232     channel_builder.description(&community_desc);
 233   }
 234
 235   Ok(channel_builder)
 236 }
 237
 238 #[tracing::instrument(skip_all)]
 239 fn get_feed_front(
 240   conn: &PgConnection,
 241   jwt_secret: &str,
 242   sort_type: &SortType,
 243   jwt: &str,
 244   protocol_and_hostname: &str,
 245 ) -> Result<ChannelBuilder, LemmyError> {
 246   let site_view = SiteView::read_local(conn)?;
 247   let local_user_id = LocalUserId(Claims::decode(jwt, jwt_secret)?.claims.sub);
 248   let local_user = LocalUser::read(conn, local_user_id)?;
 249
 250   let posts = PostQueryBuilder::create(conn)
 251     .listing_type(ListingType::Subscribed)
 252     .my_person_id(local_user.person_id)
 253     .show_bot_accounts(local_user.show_bot_accounts)
 254     .show_read_posts(local_user.show_read_posts)
 255     .sort(*sort_type)
 256     .limit(RSS_FETCH_LIMIT)
 257     .list()?;
 258
 259   let items = create_post_items(posts, protocol_and_hostname)?;
 260
 261   let mut channel_builder = ChannelBuilder::default();
 262   channel_builder
 263     .namespaces(RSS_NAMESPACE.to_owned())
 264     .title(&format!("{} - Subscribed", site_view.site.name))
 265     .link(protocol_and_hostname)
 266     .items(items);
 267
 268   if let Some(site_desc) = site_view.site.description {
 269     channel_builder.description(&site_desc);
 270   }
 271
 272   Ok(channel_builder)
 273 }
 274
 275 #[tracing::instrument(skip_all)]
 276 fn get_feed_inbox(
 277   conn: &PgConnection,
 278   jwt_secret: &str,
 279   jwt: &str,
 280   protocol_and_hostname: &str,
 281 ) -> Result<ChannelBuilder, LemmyError> {
 282   let site_view = SiteView::read_local(conn)?;
 283   let local_user_id = LocalUserId(Claims::decode(jwt, jwt_secret)?.claims.sub);
 284   let local_user = LocalUser::read(conn, local_user_id)?;
 285   let person_id = local_user.person_id;
 286   let show_bot_accounts = local_user.show_bot_accounts;
 287
 288   let sort = SortType::New;
 289
 290   let replies = CommentQueryBuilder::create(conn)
 291     .recipient_id(person_id)
 292     .my_person_id(person_id)
 293     .show_bot_accounts(show_bot_accounts)
 294     .sort(sort)
 295     .limit(RSS_FETCH_LIMIT)
 296     .list()?;
 297
 298   let mentions = PersonMentionQueryBuilder::create(conn)
 299     .recipient_id(person_id)
 300     .my_person_id(person_id)
 301     .sort(sort)
 302     .limit(RSS_FETCH_LIMIT)
 303     .list()?;
 304
 305   let items = create_reply_and_mention_items(replies, mentions, protocol_and_hostname)?;
 306
 307   let mut channel_builder = ChannelBuilder::default();
 308   channel_builder
 309     .namespaces(RSS_NAMESPACE.to_owned())
 310     .title(&format!("{} - Inbox", site_view.site.name))
 311     .link(format!("{}/inbox", protocol_and_hostname,))
 312     .items(items);
 313
 314   if let Some(site_desc) = site_view.site.description {
 315     channel_builder.description(&site_desc);
 316   }
 317
 318   Ok(channel_builder)
 319 }
 320
 321 #[tracing::instrument(skip_all)]
 322 fn create_reply_and_mention_items(
 323   replies: Vec<CommentView>,
 324   mentions: Vec<PersonMentionView>,
 325   protocol_and_hostname: &str,
 326 ) -> Result<Vec<Item>, LemmyError> {
 327   let mut reply_items: Vec<Item> = replies
 328     .iter()
 329     .map(|r| {
 330       let reply_url = format!(
 331         "{}/post/{}/comment/{}",
 332         protocol_and_hostname, r.post.id, r.comment.id
 333       );
 334       build_item(
 335         &r.creator.name,
 336         &r.comment.published,
 337         &reply_url,
 338         &r.comment.content,
 339         protocol_and_hostname,
 340       )
 341     })
 342     .collect::<Result<Vec<Item>, LemmyError>>()?;
 343
 344   let mut mention_items: Vec<Item> = mentions
 345     .iter()
 346     .map(|m| {
 347       let mention_url = format!(
 348         "{}/post/{}/comment/{}",
 349         protocol_and_hostname, m.post.id, m.comment.id
 350       );
 351       build_item(
 352         &m.creator.name,
 353         &m.comment.published,
 354         &mention_url,
 355         &m.comment.content,
 356         protocol_and_hostname,
 357       )
 358     })
 359     .collect::<Result<Vec<Item>, LemmyError>>()?;
 360
 361   reply_items.append(&mut mention_items);
 362   Ok(reply_items)
 363 }
 364
 365 #[tracing::instrument(skip_all)]
 366 fn build_item(
 367   creator_name: &str,
 368   published: &NaiveDateTime,
 369   url: &str,
 370   content: &str,
 371   protocol_and_hostname: &str,
 372 ) -> Result<Item, LemmyError> {
 373   let mut i = ItemBuilder::default();
 374   i.title(format!("Reply from {}", creator_name));
 375   let author_url = format!("{}/u/{}", protocol_and_hostname, creator_name);
 376   i.author(format!(
 377     "/u/{} <a href=\"{}\">(link)</a>",
 378     creator_name, author_url
 379   ));
 380   let dt = DateTime::<Utc>::from_utc(*published, Utc);
 381   i.pub_date(dt.to_rfc2822());
 382   i.comments(url.to_owned());
 383   let guid = GuidBuilder::default().permalink(true).value(url).build();
 384   i.guid(guid);
 385   i.link(url.to_owned());
 386   // TODO add images
 387   let html = markdown_to_html(content);
 388   i.description(html);
 389   Ok(i.build())
 390 }
 391
 392 #[tracing::instrument(skip_all)]
 393 fn create_post_items(
 394   posts: Vec<PostView>,
 395   protocol_and_hostname: &str,
 396 ) -> Result<Vec<Item>, LemmyError> {
 397   let mut items: Vec<Item> = Vec::new();
 398
 399   for p in posts {
 400     let mut i = ItemBuilder::default();
 401     let mut dc_extension = DublinCoreExtensionBuilder::default();
 402
 403     i.title(p.post.name);
 404
 405     dc_extension.creators(vec![p.creator.actor_id.to_string()]);
 406
 407     let dt = DateTime::<Utc>::from_utc(p.post.published, Utc);
 408     i.pub_date(dt.to_rfc2822());
 409
 410     let post_url = format!("{}/post/{}", protocol_and_hostname, p.post.id);
 411     i.link(post_url.to_owned());
 412     i.comments(post_url.to_owned());
 413     let guid = GuidBuilder::default()
 414       .permalink(true)
 415       .value(&post_url)
 416       .build();
 417     i.guid(guid);
 418
 419     let community_url = format!("{}/c/{}", protocol_and_hostname, p.community.name);
 420
 421     // TODO add images
 422     let mut description = format!("submitted by <a href=\"{}\">{}</a> to <a href=\"{}\">{}</a><br>{} points | <a href=\"{}\">{} comments</a>",
 423     p.creator.actor_id,
 424     p.creator.name,
 425     community_url,
 426     p.community.name,
 427     p.counts.score,
 428     post_url,
 429     p.counts.comments);
 430
 431     // If its a url post, add it to the description
 432     if let Some(url) = p.post.url {
 433       let link_html = format!("<br><a href=\"{url}\">{url}</a>", url = url);
 434       description.push_str(&link_html);
 435     }
 436
 437     if let Some(body) = p.post.body {
 438       let html = markdown_to_html(&body);
 439       description.push_str(&html);
 440     }
 441
 442     i.description(description);
 443
 444     i.dublin_core_ext(dc_extension.build());
 445     items.push(i.build());
 446   }
 447
 448   Ok(items)
 449 }