From e613e3c08c0b807e012ce08e41afa565d57ed39d Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Tue, 30 Apr 2024 16:34:40 -0400 Subject: [PATCH 01/10] feat: optional `trending_enabled` and `search_enabled` params added --- config/config.example.yml | 16 ++++++ src/invidious/config.cr | 2 + src/invidious/routes/api/v1/feeds.cr | 5 ++ src/invidious/routes/api/v1/search.cr | 5 ++ src/invidious/routes/feeds.cr | 29 +++++----- src/invidious/routes/preferences.cr | 8 +++ src/invidious/routes/search.cr | 67 +++++++++++++----------- src/invidious/views/user/preferences.ecr | 9 ++++ 8 files changed, 98 insertions(+), 43 deletions(-) diff --git a/config/config.example.yml b/config/config.example.yml index 38085a20b..9f0c252a5 100644 --- a/config/config.example.yml +++ b/config/config.example.yml @@ -210,6 +210,22 @@ https_only: false ## #popular_enabled: true +## +## Enable/Disable the "Trending" tab on the main page. +## +## Accepted values: true, false +## Default: true +## +#trending_enabled: true + +## +## Enable/Disable "Search" on the main page. +## +## Accepted values: true, false +## Default: true +## +#search_enabled: true + ## ## Enable/Disable statstics (available at /api/v1/stats). ## The following data is available: diff --git a/src/invidious/config.cr b/src/invidious/config.cr index 09c2168b8..f6146cd78 100644 --- a/src/invidious/config.cr +++ b/src/invidious/config.cr @@ -91,6 +91,8 @@ class Config # Subscribe to channels using PubSubHubbub (requires domain, hmac_key) property use_pubsub_feeds : Bool | Int32 = false property popular_enabled : Bool = true + property trending_enabled : Bool = true + property search_enabled : Bool = true property captcha_enabled : Bool = true property login_enabled : Bool = true property registration_enabled : Bool = true diff --git a/src/invidious/routes/api/v1/feeds.cr b/src/invidious/routes/api/v1/feeds.cr index 41865f34b..f6feab5ff 100644 --- a/src/invidious/routes/api/v1/feeds.cr +++ b/src/invidious/routes/api/v1/feeds.cr @@ -4,6 +4,11 @@ module Invidious::Routes::API::V1::Feeds env.response.content_type = "application/json" + if !CONFIG.trending_enabled + error_message = {"error" => "Administrator has disabled this endpoint."}.to_json + haltf env, 400, error_message + end + region = env.params.query["region"]? trending_type = env.params.query["type"]? diff --git a/src/invidious/routes/api/v1/search.cr b/src/invidious/routes/api/v1/search.cr index 2922b0601..526914b09 100644 --- a/src/invidious/routes/api/v1/search.cr +++ b/src/invidious/routes/api/v1/search.cr @@ -5,6 +5,11 @@ module Invidious::Routes::API::V1::Search env.response.content_type = "application/json" + if !CONFIG.search_enabled + error_message = {"error" => "Administrator has disabled this endpoint."}.to_json + haltf env, 400, error_message + end + query = Invidious::Search::Query.new(env.params.query, :regular, region) begin diff --git a/src/invidious/routes/feeds.cr b/src/invidious/routes/feeds.cr index e20a7139e..22a23a7e5 100644 --- a/src/invidious/routes/feeds.cr +++ b/src/invidious/routes/feeds.cr @@ -44,20 +44,25 @@ module Invidious::Routes::Feeds def self.trending(env) locale = env.get("preferences").as(Preferences).locale + + if CONFIG.trending_enabled + trending_type = env.params.query["type"]? + trending_type ||= "Default" + + region = env.params.query["region"]? + region ||= env.get("preferences").as(Preferences).region + + begin + trending, plid = fetch_trending(trending_type, region, locale) + rescue ex + return error_template(500, ex) + end - trending_type = env.params.query["type"]? - trending_type ||= "Default" - - region = env.params.query["region"]? - region ||= env.get("preferences").as(Preferences).region - - begin - trending, plid = fetch_trending(trending_type, region, locale) - rescue ex - return error_template(500, ex) + templated "feeds/trending" + else + message = translate(locale, "The Trending feed has been disabled by the administrator.") + templated "message" end - - templated "feeds/trending" end def self.subscriptions(env) diff --git a/src/invidious/routes/preferences.cr b/src/invidious/routes/preferences.cr index 112535bd4..9aee0d8c9 100644 --- a/src/invidious/routes/preferences.cr +++ b/src/invidious/routes/preferences.cr @@ -198,6 +198,14 @@ module Invidious::Routes::PreferencesRoute popular_enabled ||= "off" CONFIG.popular_enabled = popular_enabled == "on" + trending_enabled = env.params.body["trending_enabled"]?.try &.as(String) + trending_enabled ||= "off" + CONFIG.trending_enabled = trending_enabled == "on" + + search_enabled = env.params.body["search_enabled"]?.try &.as(String) + search_enabled ||= "off" + CONFIG.search_enabled = search_enabled == "on" + captcha_enabled = env.params.body["captcha_enabled"]?.try &.as(String) captcha_enabled ||= "off" CONFIG.captcha_enabled = captcha_enabled == "on" diff --git a/src/invidious/routes/search.cr b/src/invidious/routes/search.cr index 5be335339..ae7d98336 100644 --- a/src/invidious/routes/search.cr +++ b/src/invidious/routes/search.cr @@ -40,41 +40,46 @@ module Invidious::Routes::Search prefs = env.get("preferences").as(Preferences) locale = prefs.locale - region = env.params.query["region"]? || prefs.region + if CONFIG.search_enabled + region = env.params.query["region"]? || prefs.region - query = Invidious::Search::Query.new(env.params.query, :regular, region) + query = Invidious::Search::Query.new(env.params.query, :regular, region) - if query.empty? - # Display the full page search box implemented in #1977 - env.set "search", "" - templated "search_homepage", navbar_search: false - else - user = env.get? "user" - - begin - items = query.process - rescue ex : ChannelSearchException - return error_template(404, "Unable to find channel with id of '#{HTML.escape(ex.channel)}'. Are you sure that's an actual channel id? It should look like 'UC4QobU6STFB0P71PMvOGN5A'.") - rescue ex - return error_template(500, ex) - end - - redirect_url = Invidious::Frontend::Misc.redirect_url(env) - - # Pagination - page_nav_html = Frontend::Pagination.nav_numeric(locale, - base_url: "/search?#{query.to_http_params}", - current_page: query.page, - show_next: (items.size >= 20) - ) - - if query.type == Invidious::Search::Query::Type::Channel - env.set "search", "channel:#{query.channel} #{query.text}" + if query.empty? + # Display the full page search box implemented in #1977 + env.set "search", "" + templated "search_homepage", navbar_search: false else - env.set "search", query.text + user = env.get? "user" + + begin + items = query.process + rescue ex : ChannelSearchException + return error_template(404, "Unable to find channel with id of '#{HTML.escape(ex.channel)}'. Are you sure that's an actual channel id? It should look like 'UC4QobU6STFB0P71PMvOGN5A'.") + rescue ex + return error_template(500, ex) + end + + redirect_url = Invidious::Frontend::Misc.redirect_url(env) + + # Pagination + page_nav_html = Frontend::Pagination.nav_numeric(locale, + base_url: "/search?#{query.to_http_params}", + current_page: query.page, + show_next: (items.size >= 20) + ) + + if query.type == Invidious::Search::Query::Type::Channel + env.set "search", "channel:#{query.channel} #{query.text}" + else + env.set "search", query.text + end + + templated "search" end - - templated "search" + else + message = translate(locale, "Search has been disabled by the administrator.") + templated "message" end end diff --git a/src/invidious/views/user/preferences.ecr b/src/invidious/views/user/preferences.ecr index 55349c5a2..4cda84212 100644 --- a/src/invidious/views/user/preferences.ecr +++ b/src/invidious/views/user/preferences.ecr @@ -287,6 +287,15 @@ checked<% end %>> +
+ + checked<% end %>> +
+ +
+ + checked<% end %>> +
From 5fa293541b05aa9fc0be404e5e872cb991cbe423 Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Fri, 3 May 2024 10:36:43 -0400 Subject: [PATCH 02/10] fix(feeds.cr): http status code --- src/invidious/routes/api/v1/feeds.cr | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/invidious/routes/api/v1/feeds.cr b/src/invidious/routes/api/v1/feeds.cr index f6feab5ff..3a4835260 100644 --- a/src/invidious/routes/api/v1/feeds.cr +++ b/src/invidious/routes/api/v1/feeds.cr @@ -6,7 +6,7 @@ module Invidious::Routes::API::V1::Feeds if !CONFIG.trending_enabled error_message = {"error" => "Administrator has disabled this endpoint."}.to_json - haltf env, 400, error_message + haltf env, 403, error_message end region = env.params.query["region"]? @@ -36,7 +36,7 @@ module Invidious::Routes::API::V1::Feeds if !CONFIG.popular_enabled error_message = {"error" => "Administrator has disabled this endpoint."}.to_json - haltf env, 400, error_message + haltf env, 403, error_message end JSON.build do |json| From 3abf21625cc88d92815814a6217d7a173eec1336 Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Fri, 3 May 2024 10:38:57 -0400 Subject: [PATCH 03/10] fix(search.cr): http status code --- src/invidious/routes/api/v1/search.cr | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/invidious/routes/api/v1/search.cr b/src/invidious/routes/api/v1/search.cr index 526914b09..3c44a989d 100644 --- a/src/invidious/routes/api/v1/search.cr +++ b/src/invidious/routes/api/v1/search.cr @@ -7,7 +7,7 @@ module Invidious::Routes::API::V1::Search if !CONFIG.search_enabled error_message = {"error" => "Administrator has disabled this endpoint."}.to_json - haltf env, 400, error_message + haltf env, 403, error_message end query = Invidious::Search::Query.new(env.params.query, :regular, region) From e0f20b06418e1a93ae6c0e27e8e2871970c92803 Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Fri, 3 May 2024 14:00:28 -0400 Subject: [PATCH 04/10] style(feeds.cr): fix code formatting --- src/invidious/routes/feeds.cr | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/invidious/routes/feeds.cr b/src/invidious/routes/feeds.cr index 22a23a7e5..693becb83 100644 --- a/src/invidious/routes/feeds.cr +++ b/src/invidious/routes/feeds.cr @@ -44,7 +44,7 @@ module Invidious::Routes::Feeds def self.trending(env) locale = env.get("preferences").as(Preferences).locale - + if CONFIG.trending_enabled trending_type = env.params.query["type"]? trending_type ||= "Default" From da422fae05da70740be881c12f82c955f9fb14b7 Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Sun, 30 Jun 2024 18:05:26 -0400 Subject: [PATCH 05/10] feat(invidious): specific pages are disabled with the use of an array --- config/config.example.yml | 27 ++++++------------------ src/invidious.cr | 2 +- src/invidious/config.cr | 9 +++++--- src/invidious/routes/api/v1/feeds.cr | 4 ++-- src/invidious/routes/api/v1/search.cr | 2 +- src/invidious/routes/feeds.cr | 4 ++-- src/invidious/routes/preferences.cr | 19 ++++++----------- src/invidious/routes/search.cr | 4 ++-- src/invidious/views/user/preferences.ecr | 6 +++--- 9 files changed, 30 insertions(+), 47 deletions(-) diff --git a/config/config.example.yml b/config/config.example.yml index 9f0c252a5..8749ec572 100644 --- a/config/config.example.yml +++ b/config/config.example.yml @@ -203,28 +203,13 @@ https_only: false # ----------------------------- ## -## Enable/Disable the "Popular" tab on the main page. +## Enable/Disable specific pages on the main page. +## Example: +## pages_enabled: +## trending: true +## popular: true +## search: true ## -## Accepted values: true, false -## Default: true -## -#popular_enabled: true - -## -## Enable/Disable the "Trending" tab on the main page. -## -## Accepted values: true, false -## Default: true -## -#trending_enabled: true - -## -## Enable/Disable "Search" on the main page. -## -## Accepted values: true, false -## Default: true -## -#search_enabled: true ## ## Enable/Disable statstics (available at /api/v1/stats). diff --git a/src/invidious.cr b/src/invidious.cr index e0bd01015..d0a02a3dd 100644 --- a/src/invidious.cr +++ b/src/invidious.cr @@ -176,7 +176,7 @@ if (CONFIG.use_pubsub_feeds.is_a?(Bool) && CONFIG.use_pubsub_feeds.as(Bool)) || Invidious::Jobs.register Invidious::Jobs::SubscribeToFeedsJob.new(PG_DB, HMAC_KEY) end -if CONFIG.popular_enabled +if CONFIG.page_enabled?("popular") Invidious::Jobs.register Invidious::Jobs::PullPopularVideosJob.new(PG_DB) end diff --git a/src/invidious/config.cr b/src/invidious/config.cr index f6146cd78..085aeef89 100644 --- a/src/invidious/config.cr +++ b/src/invidious/config.cr @@ -90,9 +90,7 @@ class Config property domain : String? # Subscribe to channels using PubSubHubbub (requires domain, hmac_key) property use_pubsub_feeds : Bool | Int32 = false - property popular_enabled : Bool = true - property trending_enabled : Bool = true - property search_enabled : Bool = true + property pages_enabled : Hash(String, Bool) = {"trending" => true, "popular" => true, "search" => true} property captcha_enabled : Bool = true property login_enabled : Bool = true property registration_enabled : Bool = true @@ -154,6 +152,11 @@ class Config end end + def page_enabled?(page : String) : Bool + @pages_enabled[page]? || false + end + + def self.load # Load config from file or YAML string env var env_config_file = "INVIDIOUS_CONFIG_FILE" diff --git a/src/invidious/routes/api/v1/feeds.cr b/src/invidious/routes/api/v1/feeds.cr index 3a4835260..bfec4fb6f 100644 --- a/src/invidious/routes/api/v1/feeds.cr +++ b/src/invidious/routes/api/v1/feeds.cr @@ -4,7 +4,7 @@ module Invidious::Routes::API::V1::Feeds env.response.content_type = "application/json" - if !CONFIG.trending_enabled + if !CONFIG.page_enabled?("trending") error_message = {"error" => "Administrator has disabled this endpoint."}.to_json haltf env, 403, error_message end @@ -34,7 +34,7 @@ module Invidious::Routes::API::V1::Feeds env.response.content_type = "application/json" - if !CONFIG.popular_enabled + if !CONFIG.page_enabled?("popular") error_message = {"error" => "Administrator has disabled this endpoint."}.to_json haltf env, 403, error_message end diff --git a/src/invidious/routes/api/v1/search.cr b/src/invidious/routes/api/v1/search.cr index 3c44a989d..48df3a2ba 100644 --- a/src/invidious/routes/api/v1/search.cr +++ b/src/invidious/routes/api/v1/search.cr @@ -5,7 +5,7 @@ module Invidious::Routes::API::V1::Search env.response.content_type = "application/json" - if !CONFIG.search_enabled + if !CONFIG.page_enabled?("search") error_message = {"error" => "Administrator has disabled this endpoint."}.to_json haltf env, 403, error_message end diff --git a/src/invidious/routes/feeds.cr b/src/invidious/routes/feeds.cr index 693becb83..114b9edc7 100644 --- a/src/invidious/routes/feeds.cr +++ b/src/invidious/routes/feeds.cr @@ -34,7 +34,7 @@ module Invidious::Routes::Feeds def self.popular(env) locale = env.get("preferences").as(Preferences).locale - if CONFIG.popular_enabled + if CONFIG.page_enabled?("popular") templated "feeds/popular" else message = translate(locale, "The Popular feed has been disabled by the administrator.") @@ -45,7 +45,7 @@ module Invidious::Routes::Feeds def self.trending(env) locale = env.get("preferences").as(Preferences).locale - if CONFIG.trending_enabled + if CONFIG.page_enabled?("trending") trending_type = env.params.query["type"]? trending_type ||= "Default" diff --git a/src/invidious/routes/preferences.cr b/src/invidious/routes/preferences.cr index 9aee0d8c9..9106d4cf3 100644 --- a/src/invidious/routes/preferences.cr +++ b/src/invidious/routes/preferences.cr @@ -194,17 +194,12 @@ module Invidious::Routes::PreferencesRoute end CONFIG.default_user_preferences.feed_menu = admin_feed_menu - popular_enabled = env.params.body["popular_enabled"]?.try &.as(String) - popular_enabled ||= "off" - CONFIG.popular_enabled = popular_enabled == "on" - - trending_enabled = env.params.body["trending_enabled"]?.try &.as(String) - trending_enabled ||= "off" - CONFIG.trending_enabled = trending_enabled == "on" - - search_enabled = env.params.body["search_enabled"]?.try &.as(String) - search_enabled ||= "off" - CONFIG.search_enabled = search_enabled == "on" + pages_enabled = { + "popular" => (env.params.body["popular_enabled"]?.try &.as(String) || "off") == "on", + "trending" => (env.params.body["trending_enabled"]?.try &.as(String) || "off") == "on", + "search" => (env.params.body["search_enabled"]?.try &.as(String) || "off") == "on" + } + CONFIG.pages_enabled = pages_enabled captcha_enabled = env.params.body["captcha_enabled"]?.try &.as(String) captcha_enabled ||= "off" @@ -355,4 +350,4 @@ module Invidious::Routes::PreferencesRoute env.redirect referer end -end +end \ No newline at end of file diff --git a/src/invidious/routes/search.cr b/src/invidious/routes/search.cr index ae7d98336..f825ffc7b 100644 --- a/src/invidious/routes/search.cr +++ b/src/invidious/routes/search.cr @@ -40,7 +40,7 @@ module Invidious::Routes::Search prefs = env.get("preferences").as(Preferences) locale = prefs.locale - if CONFIG.search_enabled + if CONFIG.page_enabled?("search") region = env.params.query["region"]? || prefs.region query = Invidious::Search::Query.new(env.params.query, :regular, region) @@ -115,4 +115,4 @@ module Invidious::Routes::Search templated "hashtag" end -end +end \ No newline at end of file diff --git a/src/invidious/views/user/preferences.ecr b/src/invidious/views/user/preferences.ecr index 4cda84212..564eca9e8 100644 --- a/src/invidious/views/user/preferences.ecr +++ b/src/invidious/views/user/preferences.ecr @@ -284,17 +284,17 @@
- checked<% end %>> + checked<% end %>>
- checked<% end %>> + checked<% end %>>
- checked<% end %>> + checked<% end %>>
From ba7e504fd1eb6fe2932089a3de267a24cdc037fa Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Sun, 30 Jun 2024 18:11:56 -0400 Subject: [PATCH 06/10] chore(search.cr): add newline at end of file --- src/invidious/routes/search.cr | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/invidious/routes/search.cr b/src/invidious/routes/search.cr index f825ffc7b..8c500e02a 100644 --- a/src/invidious/routes/search.cr +++ b/src/invidious/routes/search.cr @@ -115,4 +115,4 @@ module Invidious::Routes::Search templated "hashtag" end -end \ No newline at end of file +end From bfe51590b1bae0a8a86ad68c0b35c3ba63e4d390 Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Mon, 1 Jul 2024 14:48:55 -0400 Subject: [PATCH 07/10] chore(lint): format with crystal tool --- src/invidious/config.cr | 1 - src/invidious/routes/preferences.cr | 6 +++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/invidious/config.cr b/src/invidious/config.cr index 085aeef89..4adadc48a 100644 --- a/src/invidious/config.cr +++ b/src/invidious/config.cr @@ -156,7 +156,6 @@ class Config @pages_enabled[page]? || false end - def self.load # Load config from file or YAML string env var env_config_file = "INVIDIOUS_CONFIG_FILE" diff --git a/src/invidious/routes/preferences.cr b/src/invidious/routes/preferences.cr index 9106d4cf3..1dfc472a4 100644 --- a/src/invidious/routes/preferences.cr +++ b/src/invidious/routes/preferences.cr @@ -195,9 +195,9 @@ module Invidious::Routes::PreferencesRoute CONFIG.default_user_preferences.feed_menu = admin_feed_menu pages_enabled = { - "popular" => (env.params.body["popular_enabled"]?.try &.as(String) || "off") == "on", + "popular" => (env.params.body["popular_enabled"]?.try &.as(String) || "off") == "on", "trending" => (env.params.body["trending_enabled"]?.try &.as(String) || "off") == "on", - "search" => (env.params.body["search_enabled"]?.try &.as(String) || "off") == "on" + "search" => (env.params.body["search_enabled"]?.try &.as(String) || "off") == "on", } CONFIG.pages_enabled = pages_enabled @@ -350,4 +350,4 @@ module Invidious::Routes::PreferencesRoute env.redirect referer end -end \ No newline at end of file +end From 2ec34f36f5e3bd1f5905b7d970281ee52d30db91 Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Mon, 1 Jul 2024 19:32:53 -0400 Subject: [PATCH 08/10] Update config/config.example.yml Co-authored-by: Samantaz Fox --- config/config.example.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/config/config.example.yml b/config/config.example.yml index 8749ec572..2b0e23232 100644 --- a/config/config.example.yml +++ b/config/config.example.yml @@ -204,11 +204,11 @@ https_only: false ## ## Enable/Disable specific pages on the main page. -## Example: -## pages_enabled: -## trending: true -## popular: true -## search: true +## +#pages_enabled: +# trending: true +# popular: true +# search: true ## ## From b0cbd29563d3d03d8e978dab24270f93a5724a5a Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Mon, 1 Jul 2024 19:36:14 -0400 Subject: [PATCH 09/10] feat(en-US.json): add translation key and value --- locales/en-US.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/locales/en-US.json b/locales/en-US.json index 3987f796e..faf98fff1 100644 --- a/locales/en-US.json +++ b/locales/en-US.json @@ -496,5 +496,7 @@ "toggle_theme": "Toggle Theme", "carousel_slide": "Slide {{current}} of {{total}}", "carousel_skip": "Skip the Carousel", - "carousel_go_to": "Go to slide `x`" + "carousel_go_to": "Go to slide `x`", + "preferences_trending_enabled_label": "Trending enabled: ", + "preferences_search_enabled_label": "Search enabled: " } From fdec9046b1352eb7877a24df3235a84fe7fdc3f2 Mon Sep 17 00:00:00 2001 From: Richard Lora Date: Mon, 1 Jul 2024 19:36:33 -0400 Subject: [PATCH 10/10] Update src/invidious/views/user/preferences.ecr Co-authored-by: Samantaz Fox --- src/invidious/views/user/preferences.ecr | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/invidious/views/user/preferences.ecr b/src/invidious/views/user/preferences.ecr index 564eca9e8..e1633cbce 100644 --- a/src/invidious/views/user/preferences.ecr +++ b/src/invidious/views/user/preferences.ecr @@ -288,12 +288,12 @@
- + checked<% end %>>
- + checked<% end %>>