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