Implement FERRIT_SFW_ONLY #24

sigaloid · 2022-10-05T22:39:24Z

Fixes #23

There is also a briefcase emoji displayed in the header as well as a message in the settings menu (hiding the NSFW-related settings).

Daniel-Valentine

Left comments on your changes. The modifications to the navigation bar and settings represent a good start, but I'm thinking we take care of #13 first (I can take that on) so that we don't have to modify the post.html/duplicates.html/user.html templates.

Daniel-Valentine · 2022-10-05T23:31:11Z

src/duplicates.rs

-					let query: Vec<&str> = query_str.split('&').collect::<Vec<&str>>();
-
-					for param in query.into_iter() {
+					for param in query_str.split('&') {


Thanks for catching this. I'm a Rust neophyte so any way my code can be optimized is good by me.

Daniel-Valentine · 2022-10-05T23:32:05Z

templates/base.html

@@ -30,7 +30,7 @@
 		<nav>
 			<div id="logo">
 				<a id="libbacon" href="/"><span id="lib">lib</span><span id="bacon">bacon.</span></a>
-				<span id="version">v{{ env!("CARGO_PKG_VERSION") }}</span>
+				<span id="version">v{{ env!("CARGO_PKG_VERSION") }}{% if crate::utils::sfw_only() %} - 💼{% endif %}</span>


The briefcase to communicate the status of the instance is an excellent idea, but I'm not crazy about the hyphen.

On the briefcase itself, can we get a hover-over help tip to explain what the suitcase means?

Daniel-Valentine · 2022-10-05T23:33:53Z

templates/duplicates.html

@@ -23,8 +23,12 @@
        <!-- DUPLICATES -->
        {% if post.num_duplicates == 0 %}
            <span class="listing_warn">(No duplicates found)</span>
-        {% else if post.flags.nsfw && prefs.show_nsfw != "on" %}
+        {% else if true %}


else if true is unnecessary. Move the if-else blocks that are inside this block into the larger one.

Daniel-Valentine · 2022-10-05T23:37:26Z

templates/duplicates.html

-        {% else if post.flags.nsfw && prefs.show_nsfw != "on" %}
+        {% else if true %}
+            {% if crate::utils::sfw_only()  %}
+            <span class="listing_warn">SFW-only mode enabled.</span>


So, I'd like to implement #13 so that any attempt to view NSFW content when NSFW-mode is disabled results in the wall, the same template rendered for quarantined and banned subs. When that goes in, I don't think we'll need to handle the case of utils::sfw_only() at all since the handlers for posts and duplicates respectively will render the wall templates and not the templates containing post content (post.html and duplicates.html).

Daniel-Valentine · 2022-10-05T23:39:18Z

templates/search.html

@@ -58,6 +58,9 @@
 		{% endif %}

 		{% if all_posts_hidden_nsfw %}
+		{% if crate::utils::sfw_only() %} 
+		<span class="listing_warn">All posts are hidden because they are NSFW. This is an SFW-only instance.</span>


I'd prefer: The results for your query are all NSFW. Since this is a SFW-only instance, they are hidden.

Daniel-Valentine · 2022-10-05T23:39:37Z

templates/settings.html

@@ -116,6 +118,10 @@
 	<div id="settings_note">
 		<p><b>Note:</b> settings and subscriptions are saved in browser cookies. Clearing your cookies will reset them.</p><br>
 		<p>You can restore your current settings and subscriptions after clearing your cookies using <a href="/settings/restore/?theme={{ prefs.theme }}&front_page={{ prefs.front_page }}&layout={{ prefs.layout }}&wide={{ prefs.wide }}&post_sort={{ prefs.post_sort }}&comment_sort={{ prefs.comment_sort }}&show_nsfw={{ prefs.show_nsfw }}&blur_nsfw={{ prefs.blur_nsfw }}&use_hls={{ prefs.use_hls }}&hide_hls_notification={{ prefs.hide_hls_notification }}&subscriptions={{ prefs.subscriptions.join("%2B") }}&filters={{ prefs.filters.join("%2B") }}">this link</a>.</p>
+		{% if crate::utils::sfw_only() %}
+		<br>


Daniel-Valentine · 2022-10-05T23:41:26Z

templates/subreddit.html

@@ -17,7 +17,9 @@

 {% block body %}
 	<main>
-		{% if !is_filtered %}
+		{% if all_posts_hidden_nsfw && crate::utils::sfw_only() %}
+		<p><span class="listing_warn">All posts are hidden because they are NSFW. This is an SFW-only instance.</span></p>


All posts for this NSFW subreddit are hidden because this is a SFW-only instance.

(But per my comment on templates/duplicates.html:26 we won't need to check for this in the template if the item handlers in post.rs/duplicates.rs return a new wall template; see #13.)

Daniel-Valentine · 2022-10-05T23:43:03Z

templates/user.html

@@ -33,16 +33,19 @@
 			</form>

 			{% if all_posts_hidden_nsfw %}
-			<center>All posts are hidden because they are NSFW. Enable "Show NSFW posts" in settings to view.</center>
+			{% if crate::utils::sfw_only() %} 
+			<span class="listing_warn">All posts are hidden because they are NSFW. This is an SFW-only instance.</span>


Posts for this user, all NSFW, are hidden because this is a SFW-only instance.

Daniel-Valentine · 2022-10-05T23:51:24Z

src/utils.rs

+// Set the LIBBACON_SFW_ONLY environment variable to anything, to enable SFW-only mode.
+// If environment variable is set, this bool will be true. Otherwise it will be false.
+pub fn sfw_only() -> bool {
+	env::var("LIBBACON_SFW_ONLY").is_ok()


~~The env var should be LIBBACON_DEFAULT_SFW_ONLY to be consistent with the other setting names.~~ I've changed my mind about this; this isn't a user setting, so we shouldn't call it a "default." I agree with FERRIT_SFW_ONLY.

If we're going to sidestep the settings generation in utils::setting(), we should justify why in a comment. Obviously we don't want this user-configurable, which is why we're checking for the variable's existence here and not in utils::setting(), but we should document this. Also:

Use ///. (A future task I want to take on is adding and improving documentation that exists.)

This new variable should also be added to the Heroku manifest at app.json.

Daniel-Valentine · 2022-10-06T06:31:09Z

I've opened up #25, which resolves #13. I'd like that to go in before we take care of #23. When #25 goes in, we can just change the message in the landing page to state that the content is forbidden from view since the instance is SFW-only, and we can modify the condition governing whether to render the landing page based on that too.

For example, this line in src/post.rs:

if setting(&req, "show_nsfw") != "on" && post.nsfw {

would become

if (utils::sfw_only() || setting(&req, "show_nsfw") != "on") && post.nsfw {

Daniel-Valentine · 2022-10-07T14:49:46Z

@sigaloid: #25 is now merged. Per my comments earlier, use templates/nsfw_landing.html to tell the user that they are forbidden from viewing NSFW content.

There are merge conflicts, so you can either resolve them (preferring the content in master) or start afresh. Fine either way.

Daniel-Valentine · 2022-10-12T23:22:58Z

@sigaloid: There've been a significant number of changes since this PR was opened so I'm thinking you should redo this. I'll refer to my previous two comments (1, 2) as to what I think we should to with respect to both the templates and the logic that determines when to return the NSFW landing page.

sigaloid · 2022-10-13T22:33:40Z

Hi, I'll redo this PR. Apologies for the stagnation, I've been dealing with a bios issue on my PC. Hoping to have this done over the weekend.

sigaloid · 2022-10-20T15:07:03Z

Hi @Daniel-Valentine, I've redone this PR and force-pushed it. It now renders the NSFW landing page. I also changed the logic to show the instance error if it's a SFW instance, regardless of whether the setting is enabled or not - I need to add the logic to hide the NSFW settings to the settings page, though.

Daniel-Valentine

LGTM.

I've also changed the title of this PR to reflect the new env var name with the project name change.

Daniel-Valentine · 2022-10-05T23:51:41Z

src/utils.rs

+// Set the LIBBACON_SFW_ONLY environment variable to anything, to enable SFW-only mode.
+// If environment variable is set, this bool will be true. Otherwise it will be false.
+pub fn sfw_only() -> bool {
+	env::var("LIBBACON_SFW_ONLY").is_ok()


This new variable should also be added to the Heroku manifest at app.json.

sigaloid requested a review from Daniel-Valentine October 5, 2022 22:39

Daniel-Valentine suggested changes Oct 5, 2022

View reviewed changes

Daniel-Valentine reviewed Oct 5, 2022

View reviewed changes

Redo PR

48b5008

sigaloid force-pushed the sfw-only-23 branch from f5492dc to 48b5008 Compare October 20, 2022 15:00

sigaloid requested a review from Daniel-Valentine October 20, 2022 15:03

Hide NSFW settings when SFW enabled, change env var to FERRIT_SFW_ONLY

3881364

sigaloid force-pushed the sfw-only-23 branch from f60e723 to 3881364 Compare October 20, 2022 15:12

Daniel-Valentine approved these changes Oct 22, 2022

View reviewed changes

Daniel-Valentine changed the title ~~Implement LIBBACON_SFW_ONLY~~ Implement FERRIT_SFW_ONLY Oct 22, 2022

Daniel-Valentine merged commit 8906b66 into master Oct 22, 2022

Daniel-Valentine deleted the sfw-only-23 branch October 22, 2022 00:21

Daniel-Valentine mentioned this pull request Nov 2, 2022

PSA: Ferrit v0.1.0, a fork of Libreddit, released libreddit/libreddit#599

Closed

sphars mentioned this pull request Nov 3, 2022

Add instance configuration properties to the schema libreddit/libreddit-instances#9

Open

Daniel-Valentine mentioned this pull request Dec 5, 2022

Landing page for NSFW content, SFW-only mode libreddit/libreddit#656

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement FERRIT_SFW_ONLY #24

Implement FERRIT_SFW_ONLY #24

sigaloid commented Oct 5, 2022

Daniel-Valentine left a comment •

edited

Loading

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022

Daniel-Valentine Oct 5, 2022 •

edited

Loading

Daniel-Valentine Oct 5, 2022

Daniel-Valentine commented Oct 6, 2022

Daniel-Valentine commented Oct 7, 2022 •

edited

Loading

Daniel-Valentine commented Oct 12, 2022

sigaloid commented Oct 13, 2022

sigaloid commented Oct 20, 2022

Daniel-Valentine left a comment •

edited

Loading

Daniel-Valentine Oct 5, 2022

Implement FERRIT_SFW_ONLY #24

Implement FERRIT_SFW_ONLY #24

Conversation

sigaloid commented Oct 5, 2022

Daniel-Valentine left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Daniel-Valentine Oct 5, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Daniel-Valentine commented Oct 6, 2022

Daniel-Valentine commented Oct 7, 2022 • edited Loading

Daniel-Valentine commented Oct 12, 2022

sigaloid commented Oct 13, 2022

sigaloid commented Oct 20, 2022

Daniel-Valentine left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Daniel-Valentine left a comment •

edited

Loading

Daniel-Valentine Oct 5, 2022 •

edited

Loading

Daniel-Valentine commented Oct 7, 2022 •

edited

Loading

Daniel-Valentine left a comment •

edited

Loading