feat: Filter hubs for restrictions

Author: lostb1t

Makefile

@@ -32,7 +32,8 @@ run:
 	REPLEX_DISABLE_USER_STATE=0 \
 	REPLEX_ENABLE_CONSOLE=0 \
 	REPLEX_CACHE_TTL=600 \
-	RUST_LOG="info,replex=info" \
+  REPLEX_HUB_RESTRICTIONS=0 \
+	RUST_LOG="info,replex=debug" \
     REPLEX_NTF_WATCHLIST_FORCE=1 \
     RUSTFLAGS=-Awarnings \
 	cargo watch -w src -x run

README.md

@@ -10,6 +10,7 @@ Remix your plex recommendations.
 - Remove watched items from recommendations.
 - Choose between styles, shelf (default) or hero.
 - Auto load artwork for hero styles.
+- Filter hubs by its restrictions (per user hub)
 - Disable user state: remove unplayed badges from row items.
 - Disable leaf count: remove episode count from artwork.
 - Force maximum quality.
@@ -77,6 +78,7 @@ Settings are set via [environment variables](https://kinsta.com/knowledgebase/wh
 | REPLEX_TOKEN              |        	 | server admin plex token, needed for hero images. To find your token see: https://support.plex.tv/articles/204059436-finding-an-authentication                                      	  |
 | REPLEX_INTERLEAVE         | true      | Interleave home recommendations. Collection rows with the same name from different libraries are interleaved (combined) into one.                                           	  |
 | REPLEX_EXCLUDE_WATCHED    | true    | If set to true, hide watched items for recommended rows                                     |
+| REPLEX_HUB_RESTRICTIONS   | true      | Apply collections restrictions to their hub's. Plex does not apply restrictions to hubs, so you cannot have different collection hubs for users. this fixes that.                                       	  |
 | REPLEX_DISABLE_CONTINUE_WATCHING | false    | Disable/remove the continue watching row |
 | REPLEX_DISABLE_USER_STATE | false    | Remove unplayed badges from row items |
 | REPLEX_DISABLE_LEAF_COUNT| false    | Remove episode count label from show artwork.                              |

src/config.rs

@@ -22,6 +22,11 @@ pub struct Config {
         default = "default_as_true",
         deserialize_with = "figment::util::bool_from_str_or_int"
     )]
+    pub hub_restrictions: bool,
+    #[serde(
+        default = "default_as_true",
+        deserialize_with = "figment::util::bool_from_str_or_int"
+    )]
     pub exclude_watched: bool,
     #[serde(default = "default_cache_ttl")]
     pub cache_ttl: u64,

src/routes.rs

@@ -616,6 +616,7 @@ pub async fn transform_hubs_home(
     container.content_type = content_type;
 
     TransformBuilder::new(plex_client, params.clone())
+        .with_filter(HubRestrictionsFilter)
         .with_transform(HubStyleTransform { is_home: true })
         .with_transform(HubWatchedTransform)
         .with_transform(HubInterleaveTransform)
@@ -671,6 +672,7 @@ pub async fn get_hubs_sections(
     container.content_type = content_type;
 
     TransformBuilder::new(plex_client, params.clone())
+        .with_filter(HubRestrictionsFilter)
         .with_transform(HubSectionDirectoryTransform)
         .with_transform(HubStyleTransform { is_home: false })
         .with_transform(HubWatchedTransform)
@@ -728,6 +730,7 @@ pub async fn get_collections_children(
 
     // filtering of watched happens in the transform
     TransformBuilder::new(plex_client, params.clone())
+        .with_filter(HubRestrictionsFilter)
         .with_transform(LibraryInterleaveTransform {
             collection_ids: collection_ids.clone(),
             offset,

src/transform.rs

@@ -235,18 +235,21 @@ impl TransformBuilder {
     }
 }
 
-// const T: usize;
 #[derive(Default)]
-pub struct CollectionHubPermissionFilter;
+pub struct HubRestrictionsFilter;
 
 #[async_trait]
-impl Filter for CollectionHubPermissionFilter {
+impl Filter for HubRestrictionsFilter {
     async fn filter_metadata(
         &self,
         item: &mut MetaData,
         plex_client: PlexClient,
         options: PlexContext,
     ) -> bool {
+        let config: Config = Config::figment().extract().unwrap();
+        if !config.hub_restrictions {
+            return true;
+        }
         tracing::debug!("filter collection permissions");
 
         if item.is_hub() && !item.is_collection_hub() {
@@ -263,8 +266,7 @@ impl Filter for CollectionHubPermissionFilter {
                 .library_section_id
                 .expect("Missing Library section id")
         });
-        // dbg!(section_id);
-        // let mut custom_collections = plex_client.get_section_collections(section_id).await.unwrap();
+
         let mut custom_collections = plex_client
             .clone()
             .get_cached(
@@ -273,7 +275,7 @@ impl Filter for CollectionHubPermissionFilter {
             )
             .await
             .unwrap();
-        // dbg!(&custom_collections);
+
         let custom_collections_ids: Vec<String> = custom_collections
             .media_container
             .children()