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