From bb0e2c23b8b24b1cd17cb3f745fe75f21229fa28 Mon Sep 17 00:00:00 2001 From: Matthew Esposito Date: Sun, 21 Jul 2024 14:01:39 -0400 Subject: [PATCH] feat(rss): implement URLs for RSS --- README.md | 1 + app.json | 3 +++ src/config.rs | 5 +++++ src/instance_info.rs | 11 +++++++---- src/subreddit.rs | 6 +++--- src/user.rs | 6 +++--- src/utils.rs | 20 +++++++++++++++++++- 7 files changed, 41 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 92f25de..85b7c1d 100644 --- a/README.md +++ b/README.md @@ -382,6 +382,7 @@ Assign a default value for each instance-specific setting by passing environment | `PUSHSHIFT_FRONTEND` | String | `undelete.pullpush.io` | Allows the server to set the Pushshift frontend to be used with "removed" links. | | `PORT` | Integer 0-65535 | `8080` | The **internal** port Redlib listens on. | | `ENABLE_RSS` | `["on", "off"]` | `off` | Enables RSS feed generation. | +| `FULL_URL` | String | (empty) | Allows for proper URLs (for now, only needed by RSS) ## Default user settings Assign a default value for each user-modifiable setting by passing environment variables to Redlib in the format `REDLIB_DEFAULT_{Y}`. Replace `{Y}` with the setting name (see list below) in capital letters. diff --git a/app.json b/app.json index b08b1fa..c05b26d 100644 --- a/app.json +++ b/app.json @@ -73,6 +73,9 @@ }, "REDLIB_ENABLE_RSS": { "required": false + }, + "REDLIB_FULL_URL": { + "required": false } } } diff --git a/src/config.rs b/src/config.rs index f220f48..034afc7 100644 --- a/src/config.rs +++ b/src/config.rs @@ -106,6 +106,9 @@ pub struct Config { #[serde(rename = "REDLIB_ENABLE_RSS")] pub(crate) enable_rss: Option, + + #[serde(rename = "REDLIB_FULL_URL")] + pub(crate) full_url: Option, } impl Config { @@ -152,6 +155,7 @@ impl Config { robots_disable_indexing: parse("REDLIB_ROBOTS_DISABLE_INDEXING"), pushshift: parse("REDLIB_PUSHSHIFT_FRONTEND"), enable_rss: parse("REDLIB_ENABLE_RSS"), + full_url: parse("REDLIB_FULL_URL"), } } } @@ -180,6 +184,7 @@ fn get_setting_from_config(name: &str, config: &Config) -> Option { "REDLIB_ROBOTS_DISABLE_INDEXING" => config.robots_disable_indexing.clone(), "REDLIB_PUSHSHIFT_FRONTEND" => config.pushshift.clone(), "REDLIB_ENABLE_RSS" => config.enable_rss.clone(), + "REDLIB_FULL_URL" => config.full_url.clone(), _ => None, } } diff --git a/src/instance_info.rs b/src/instance_info.rs index 37088ea..36182c1 100644 --- a/src/instance_info.rs +++ b/src/instance_info.rs @@ -126,6 +126,8 @@ impl InstanceInfo { ["Compile mode", &self.compile_mode], ["SFW only", &convert(&self.config.sfw_only)], ["Pushshift frontend", &convert(&self.config.pushshift)], + ["RSS enabled", &convert(&self.config.enable_rss)], + ["Full URL", &convert(&self.config.full_url)], //TODO: fallback to crate::config::DEFAULT_PUSHSHIFT_FRONTEND ]) .with_header_row(["Settings"]), @@ -148,7 +150,6 @@ impl InstanceInfo { ["Hide HLS notification", &convert(&self.config.default_hide_hls_notification)], ["Subscriptions", &convert(&self.config.default_subscriptions)], ["Filters", &convert(&self.config.default_filters)], - ["RSS enabled", &convert(&self.config.enable_rss)], ]) .with_header_row(["Default preferences"]), ); @@ -166,6 +167,8 @@ impl InstanceInfo { Compile mode: {}\n SFW only: {:?}\n Pushshift frontend: {:?}\n + RSS enabled: {:?}\n + Full URL: {:?}\n Config:\n Banner: {:?}\n Hide awards: {:?}\n @@ -182,8 +185,7 @@ impl InstanceInfo { Default use HLS: {:?}\n Default hide HLS notification: {:?}\n Default subscriptions: {:?}\n - Default filters: {:?}\n - RSS enabled: {:?}\n", + Default filters: {:?}\n", self.package_name, self.crate_version, self.git_commit, @@ -191,6 +193,8 @@ impl InstanceInfo { self.deploy_unix_ts, self.compile_mode, self.config.sfw_only, + self.config.enable_rss, + self.config.full_url, self.config.pushshift, self.config.banner, self.config.default_hide_awards, @@ -208,7 +212,6 @@ impl InstanceInfo { self.config.default_hide_hls_notification, self.config.default_subscriptions, self.config.default_filters, - self.config.enable_rss, ) } StringType::Html => self.to_table(), diff --git a/src/subreddit.rs b/src/subreddit.rs index c038c43..6ea65d7 100644 --- a/src/subreddit.rs +++ b/src/subreddit.rs @@ -1,4 +1,4 @@ -use crate::config; +use crate::{config, utils}; // CRATES use crate::utils::{ catch_random, error, filter_posts, format_num, format_url, get_filters, nsfw_landing, param, redirect, rewrite_urls, setting, template, val, Post, Preferences, Subreddit, @@ -490,8 +490,8 @@ pub async fn rss(req: Request) -> Result, String> { posts .into_iter() .map(|post| Item { - title: Some(post.title), - link: Some(post.permalink), + title: Some(post.title.to_string()), + link: Some(utils::get_post_url(&post)), author: Some(post.author.name), content: Some(rewrite_urls(&post.body)), ..Default::default() diff --git a/src/user.rs b/src/user.rs index 47d0dd4..6ad8fbd 100644 --- a/src/user.rs +++ b/src/user.rs @@ -1,8 +1,8 @@ // CRATES use crate::client::json; -use crate::config; use crate::server::RequestExt; use crate::utils::{error, filter_posts, format_url, get_filters, nsfw_landing, param, setting, template, Post, Preferences, User}; +use crate::{config, utils}; use askama::Template; use hyper::{Body, Request, Response}; use time::{macros::format_description, OffsetDateTime}; @@ -160,8 +160,8 @@ pub async fn rss(req: Request) -> Result, String> { posts .into_iter() .map(|post| Item { - title: Some(post.title), - link: Some(post.permalink), + title: Some(post.title.to_string()), + link: Some(utils::get_post_url(&post)), author: Some(post.author.name), content: Some(rewrite_urls(&post.body)), ..Default::default() diff --git a/src/utils.rs b/src/utils.rs index 4fb3b13..ee1fc66 100644 --- a/src/utils.rs +++ b/src/utils.rs @@ -1,5 +1,5 @@ #![allow(dead_code)] -use crate::config::get_setting; +use crate::config::{self, get_setting}; // // CRATES // @@ -15,6 +15,7 @@ use serde_json::Value; use std::collections::{HashMap, HashSet}; use std::env; use std::str::FromStr; +use std::string::ToString; use time::{macros::format_description, Duration, OffsetDateTime}; use url::Url; @@ -327,6 +328,7 @@ pub struct Post { pub gallery: Vec, pub awards: Awards, pub nsfw: bool, + pub out_url: Option, pub ws_url: String, } @@ -435,6 +437,7 @@ impl Post { awards, nsfw: post["data"]["over_18"].as_bool().unwrap_or_default(), ws_url: val(post, "websocket_url"), + out_url: post["data"]["url_overridden_by_dest"].as_str().map(|a| a.to_string()), }); } Ok((posts, res["data"]["after"].as_str().unwrap_or_default().to_string())) @@ -770,6 +773,7 @@ pub async fn parse_post(post: &Value) -> Post { awards, nsfw: post["data"]["over_18"].as_bool().unwrap_or_default(), ws_url: val(post, "websocket_url"), + out_url: post["data"]["url_overridden_by_dest"].as_str().map(|a| a.to_string()), } } @@ -1147,6 +1151,20 @@ pub fn url_path_basename(path: &str) -> String { } } +// Returns the URL of a post, as needed by RSS feeds +pub fn get_post_url(post: &Post) -> String { + if let Some(out_url) = &post.out_url { + // Handle cross post + if out_url.starts_with("/r/") { + format!("{}{}", config::get_setting("REDLIB_FULL_URL").unwrap_or_default(), out_url) + } else { + out_url.to_string() + } + } else { + format!("{}{}", config::get_setting("REDLIB_FULL_URL").unwrap_or_default(), post.permalink) + } +} + #[cfg(test)] mod tests { use super::{format_num, format_url, rewrite_urls};