redsunlib/src/settings.rs

#![allow(clippy::cmp_owned)]

use std::collections::HashMap;

// CRATES
use crate::server::ResponseExt;
use crate::utils::{redirect, template, Preferences};
use cookie::Cookie;
use futures_lite::StreamExt;
use hyper::{Body, Request, Response};
use rinja::Template;
use time::{Duration, OffsetDateTime};

// STRUCTS
#[derive(Template)]
#[template(path = "settings.html")]
struct SettingsTemplate {
	prefs: Preferences,
	url: String,
}

// CONSTANTS

const PREFS: [&str; 17] = [
	"theme",
	"front_page",
	"layout",
	"wide",
	"comment_sort",
	"post_sort",
	"blur_spoiler",
	"show_nsfw",
	"blur_nsfw",
	"use_hls",
	"hide_hls_notification",
	"autoplay_videos",
	"hide_sidebar_and_summary",
	"fixed_navbar",
	"hide_awards",
	"hide_score",
	"disable_visit_reddit_confirmation",
];

// FUNCTIONS

// Retrieve cookies from request "Cookie" header
pub async fn get(req: Request<Body>) -> Result<Response<Body>, String> {
	let url = req.uri().to_string();
	Ok(template(&SettingsTemplate {
		prefs: Preferences::new(&req),
		url,
	}))
}

// Set cookies using response "Set-Cookie" header
pub async fn set(req: Request<Body>) -> Result<Response<Body>, String> {
	// Split the body into parts
	let (parts, mut body) = req.into_parts();

	// Grab existing cookies
	let _cookies: Vec<Cookie<'_>> = parts
		.headers
		.get_all("Cookie")
		.iter()
		.filter_map(|header| Cookie::parse(header.to_str().unwrap_or_default()).ok())
		.collect();

	// Aggregate the body...
	// let whole_body = hyper::body::aggregate(req).await.map_err(|e| e.to_string())?;
	let body_bytes = body
		.try_fold(Vec::new(), |mut data, chunk| {
			data.extend_from_slice(&chunk);
			Ok(data)
		})
		.await
		.map_err(|e| e.to_string())?;

	let form = url::form_urlencoded::parse(&body_bytes).collect::<HashMap<_, _>>();

	let mut response = redirect("/settings");

	for &name in &PREFS {
		match form.get(name) {
			Some(value) => response.insert_cookie(
				Cookie::build((name.to_owned(), value.clone()))
					.path("/")
					.http_only(true)
					.expires(OffsetDateTime::now_utc() + Duration::weeks(52))
					.into(),
			),
			None => response.remove_cookie(name.to_string()),
		};
	}

	Ok(response)
}

fn set_cookies_method(req: Request<Body>, remove_cookies: bool) -> Response<Body> {
	// Split the body into parts
	let (parts, _) = req.into_parts();

	// Grab existing cookies
	let _cookies: Vec<Cookie<'_>> = parts
		.headers
		.get_all("Cookie")
		.iter()
		.filter_map(|header| Cookie::parse(header.to_str().unwrap_or_default()).ok())
		.collect();

	let query = parts.uri.query().unwrap_or_default().as_bytes();

	let form = url::form_urlencoded::parse(query).collect::<HashMap<_, _>>();

	let path = match form.get("redirect") {
		Some(value) => format!("/{}", value.replace("%26", "&").replace("%23", "#")),
		None => "/".to_string(),
	};

	let mut response = redirect(&path);

	for name in [PREFS.to_vec(), vec!["subscriptions", "filters"]].concat() {
		match form.get(name) {
			Some(value) => response.insert_cookie(
				Cookie::build((name.to_owned(), value.clone()))
					.path("/")
					.http_only(true)
					.expires(OffsetDateTime::now_utc() + Duration::weeks(52))
					.into(),
			),
			None => {
				if remove_cookies {
					response.remove_cookie(name.to_string());
				}
			}
		};
	}

	response
}

// Set cookies using response "Set-Cookie" header
pub async fn restore(req: Request<Body>) -> Result<Response<Body>, String> {
	Ok(set_cookies_method(req, true))
}

pub async fn update(req: Request<Body>) -> Result<Response<Body>, String> {
	Ok(set_cookies_method(req, false))
}
Fix parts of CI (#304) * Run cargo fmt, hide clippy::cmp_owned errors * Bump deps * Fix failing test * Update src/client.rs --------- Co-authored-by: Matthew Esposito <matt@matthew.science> 2024-11-01 15:50:50 +13:00			`#![allow(clippy::cmp_owned)]`

Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`use std::collections::HashMap;`

Settings with Layouts 2021-01-06 15:04:49 +13:00			`// CRATES`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`use crate::server::ResponseExt;`
Categorize utilities 2021-02-25 18:29:23 +13:00			`use crate::utils::{redirect, template, Preferences};`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`use cookie::Cookie;`
			`use futures_lite::StreamExt;`
			`use hyper::{Body, Request, Response};`
Replace `askama` with `rinja` (#276) 2024-10-03 10:43:13 +13:00			`use rinja::Template;`
Settings with Layouts 2021-01-06 15:04:49 +13:00			`use time::{Duration, OffsetDateTime};`

			`// STRUCTS`
			`#[derive(Template)]`
Default Comment Sort Setting 2021-01-08 05:38:05 +13:00			`#[template(path = "settings.html")]`
Settings with Layouts 2021-01-06 15:04:49 +13:00			`struct SettingsTemplate {`
Unify preferences under one struct 2021-01-09 14:50:03 +13:00			`prefs: Preferences,`
Add "open in reddit" button to all pages (#304) * Pass the url parameter to all templates. Add a reddit_link to the navbar, which opens the current url on reddit. * Add icon for reddit link Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-11-15 15:39:33 +13:00			`url: String,`
Settings with Layouts 2021-01-06 15:04:49 +13:00			`}`

HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`// CONSTANTS`

feat: add support to blur spoiler previews 2024-06-22 22:16:12 +12:00			`const PREFS: [&str; 17] = [`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`"theme",`
			`"front_page",`
			`"layout",`
			`"wide",`
			`"comment_sort",`
			`"post_sort",`
feat: add support to blur spoiler previews 2024-06-22 22:16:12 +12:00			`"blur_spoiler",`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`"show_nsfw",`
Blur NSFW posts. Reimplementation of libreddit/libreddit#482. Co-authored by: Daniel Valentine <Daniel-Valentine@users.noreply.github.com> 2022-09-27 14:35:23 +13:00			`"blur_nsfw",`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`"use_hls",`
			`"hide_hls_notification",`
Add setting to autoplay videos 2021-10-26 17:27:55 +13:00			`"autoplay_videos",`
feat: adds hide summary sidebar option 2024-05-14 09:49:59 +12:00			`"hide_sidebar_and_summary",`
Make the fixed navbar optional Adds another on/off preference (default: on, keeps same behaviour) for the fixed navbar. When off the navbar will not remain at the top of the page when scrolling. This is useful for small displays such as phones where otherwise the navbar takes up a sizeable portion of the viewport. 2022-06-19 09:53:30 +12:00			`"fixed_navbar",`
Add hide_awards config 2023-01-02 15:39:38 +13:00			`"hide_awards",`
Use a bullet instead of empty margin when score is hidden This is prettier and keeps consistency across the app. 2023-03-24 07:29:28 +13:00			`"hide_score",`
added leaving reddit dialog (#643) 2023-01-12 21:46:56 +13:00			`"disable_visit_reddit_confirmation",`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`];`

Settings with Layouts 2021-01-06 15:04:49 +13:00			`// FUNCTIONS`

			`// Retrieve cookies from request "Cookie" header`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`pub async fn get(req: Request<Body>) -> Result<Response<Body>, String> {`
Add "open in reddit" button to all pages (#304) * Pass the url parameter to all templates. Add a reddit_link to the navbar, which opens the current url on reddit. * Add icon for reddit link Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-11-15 15:39:33 +13:00			`let url = req.uri().to_string();`
Add many Clippy's, fix many Clippy's 2024-01-20 14:16:17 +13:00			`Ok(template(&SettingsTemplate {`
Add hide_awards config 2023-01-02 15:39:38 +13:00			`prefs: Preferences::new(&req),`
Update crates and optimize parameters 2021-11-15 15:51:36 +13:00			`url,`
Add many Clippy's, fix many Clippy's 2024-01-20 14:16:17 +13:00			`}))`
Settings with Layouts 2021-01-06 15:04:49 +13:00			`}`

			`// Set cookies using response "Set-Cookie" header`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`pub async fn set(req: Request<Body>) -> Result<Response<Body>, String> {`
			`// Split the body into parts`
			`let (parts, mut body) = req.into_parts();`

			`// Grab existing cookies`
Add many Clippy's, fix many Clippy's 2024-01-20 14:16:17 +13:00			`let _cookies: Vec<Cookie<'_>> = parts`
Optimizations and commenting 2021-05-21 07:24:06 +12:00			`.headers`
			`.get_all("Cookie")`
			`.iter()`
			`.filter_map(\|header\| Cookie::parse(header.to_str().unwrap_or_default()).ok())`
			`.collect();`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00
			`// Aggregate the body...`
			`// let whole_body = hyper::body::aggregate(req).await.map_err(\|e\| e.to_string())?;`
			`let body_bytes = body`
			`.try_fold(Vec::new(), \|mut data, chunk\| {`
			`data.extend_from_slice(&chunk);`
			`Ok(data)`
			`})`
			`.await`
			`.map_err(\|e\| e.to_string())?;`

			`let form = url::form_urlencoded::parse(&body_bytes).collect::<HashMap<_, _>>();`
Move from Actix Web to Tide (#99) * Initial commit * Port posts * Pinpoint Tide Bug * Revert testing * Add basic sub support * Unwrap nested routes * Front page & sync templates * Port remaining functions * Log request errors * Clean main and settings * Handle /w/ requests * Create template() util * Reduce caching time to 30s * Fix subscription redirects * Handle frontpage sorting 2021-02-10 06:38:52 +13:00
Add many Clippy's, fix many Clippy's 2024-01-20 14:16:17 +13:00			`let mut response = redirect("/settings");`
Settings with Layouts 2021-01-06 15:04:49 +13:00
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`for &name in &PREFS {`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`match form.get(name) {`
Optimizations and commenting 2021-05-21 07:24:06 +12:00			`Some(value) => response.insert_cookie(`
Update cookie + changes 2023-12-27 10:24:53 +13:00			`Cookie::build((name.to_owned(), value.clone()))`
Add "hide nsfw" option 2021-01-09 14:35:04 +13:00			`.path("/")`
			`.http_only(true)`
			`.expires(OffsetDateTime::now_utc() + Duration::weeks(52))`
Update cookie + changes 2023-12-27 10:24:53 +13:00			`.into(),`
Add "hide nsfw" option 2021-01-09 14:35:04 +13:00			`),`
Optimizations and commenting 2021-05-21 07:24:06 +12:00			`None => response.remove_cookie(name.to_string()),`
Add "hide nsfw" option 2021-01-09 14:35:04 +13:00			`};`
			`}`
Default Comment Sort Setting 2021-01-08 05:38:05 +13:00
Optimizations and commenting 2021-05-21 07:24:06 +12:00			`Ok(response)`
Settings with Layouts 2021-01-06 15:04:49 +13:00			`}`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`fn set_cookies_method(req: Request<Body>, remove_cookies: bool) -> Response<Body> {`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`// Split the body into parts`
			`let (parts, _) = req.into_parts();`

			`// Grab existing cookies`
Add many Clippy's, fix many Clippy's 2024-01-20 14:16:17 +13:00			`let _cookies: Vec<Cookie<'_>> = parts`
Optimizations and commenting 2021-05-21 07:24:06 +12:00			`.headers`
			`.get_all("Cookie")`
			`.iter()`
			`.filter_map(\|header\| Cookie::parse(header.to_str().unwrap_or_default()).ok())`
			`.collect();`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00
			`let query = parts.uri.query().unwrap_or_default().as_bytes();`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`let form = url::form_urlencoded::parse(query).collect::<HashMap<_, _>>();`

			`let path = match form.get("redirect") {`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`Some(value) => format!("/{}", value.replace("%26", "&").replace("%23", "#")),`
Templatize redirects 2021-02-14 12:02:38 +13:00			`None => "/".to_string(),`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00			`};`

Add many Clippy's, fix many Clippy's 2024-01-20 14:16:17 +13:00			`let mut response = redirect(&path);`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00
Filter subreddits and users (#317) * Initial work on filtering subreddits and users * Fix doubly-prefixed subreddit name in search alt text (e.g. r/r/pics) * Don't set post title to "Comment" if empty - this could throw off actual posts with the title "Comment" * Filter search results * Fix filtering to differentiate between "this subject itself is filtered" vs "all posts on this current page have been filtered" * Remove unnecessary check * Clean up * Cargo format * Collapse comments from filtered users Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-11-26 17:02:04 +13:00			`for name in [PREFS.to_vec(), vec!["subscriptions", "filters"]].concat() {`
Rewrite server and client using Hyper 2021-03-18 11:30:33 +13:00			`match form.get(name) {`
Optimizations and commenting 2021-05-21 07:24:06 +12:00			`Some(value) => response.insert_cookie(`
Update cookie + changes 2023-12-27 10:24:53 +13:00			`Cookie::build((name.to_owned(), value.clone()))`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00			`.path("/")`
			`.http_only(true)`
			`.expires(OffsetDateTime::now_utc() + Duration::weeks(52))`
Update cookie + changes 2023-12-27 10:24:53 +13:00			`.into(),`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00			`),`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`None => {`
			`if remove_cookies {`
Fix #272 2021-09-10 12:28:55 +12:00			`response.remove_cookie(name.to_string());`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`}`
			`}`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00			`};`
			`}`

Optimizations and commenting 2021-05-21 07:24:06 +12:00			`response`
HLS video playback (#182) * HLS video playback Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Add LibreJS compliance * Locally host hls.js * Notification about HLS under videos that support it Signed-off-by: Adrian Lebioda <adrianlebioda@gmail.com> * Use .contains() instead of .find() == None * Make list of preferences constant * Change headers_keys from Vector into Array * Fix incorrect detecting of # in paths * Remove trailing-slash-appending if statement * Change HLS notification styling Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-05-10 13:25:52 +12:00			`}`

			`// Set cookies using response "Set-Cookie" header`
			`pub async fn restore(req: Request<Body>) -> Result<Response<Body>, String> {`
			`Ok(set_cookies_method(req, true))`
			`}`

			`pub async fn update(req: Request<Body>) -> Result<Response<Body>, String> {`
			`Ok(set_cookies_method(req, false))`
Generate URL to restore settings, including subscriptions. Closes #89 (#116) * Start recursive comments * Update comment.html * Fix move error * Comment improvements * Fix merge * Remove extra endif from post.html * Fix post.html * Restore setting from link * Tweak settings page Co-authored-by: spikecodes <19519553+spikecodes@users.noreply.github.com> 2021-02-14 09:55:23 +13:00			`}`