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