feat: add a setting for special episodes (#1193)

* feat: add a setting for special episodes

This PR adds a separate setting for special episodes and disables them by default, to avoid unwanted
library status updates.

* refactor(settings): re-order setting for allow specials request

---------

Co-authored-by: fallenbagel <98979876+Fallenbagel@users.noreply.github.com>

server/entity/MediaRequest.ts

@@ -58,6 +58,7 @@ export class MediaRequest {
     const mediaRepository = getRepository(Media);
     const requestRepository = getRepository(MediaRequest);
     const userRepository = getRepository(User);
+    const settings = getSettings();
 
     let requestUser = user;
 
@@ -258,7 +259,11 @@ export class MediaRequest {
       >;
       const requestedSeasons =
         requestBody.seasons === 'all'
-          ? tmdbMediaShow.seasons.map((season) => season.season_number)
+          ? settings.main.enableSpecialEpisodes
+            ? tmdbMediaShow.seasons.map((season) => season.season_number)
+            : tmdbMediaShow.seasons
+                .map((season) => season.season_number)
+                .filter((sn) => sn > 0)
           : (requestBody.seasons as number[]);
       let existingSeasons: number[] = [];
 

server/interfaces/api/settingsInterfaces.ts

@@ -37,6 +37,7 @@ export interface PublicSettingsResponse {
   originalLanguage: string;
   mediaServerType: number;
   partialRequestsEnabled: boolean;
+  enableSpecialEpisodes: boolean;
   cacheImages: boolean;
   vapidPublic: string;
   enablePushRegistration: boolean;

server/lib/scanners/plex/index.ts

@@ -277,8 +277,13 @@ class PlexScanner
 
     const seasons = tvShow.seasons;
     const processableSeasons: ProcessableSeason[] = [];
+    const settings = getSettings();
 
-    for (const season of seasons) {
+    const filteredSeasons = settings.main.enableSpecialEpisodes
+      ? seasons
+      : seasons.filter((sn) => sn.season_number !== 0);
+
+    for (const season of filteredSeasons) {
       const matchedPlexSeason = metadata.Children?.Metadata.find(
         (md) => Number(md.index) === season.season_number
       );

server/lib/scanners/sonarr/index.ts

@@ -102,9 +102,12 @@ class SonarrScanner
       }
 
       const tmdbId = tvShow.id;
+      const settings = getSettings();
 
-      const filteredSeasons = sonarrSeries.seasons.filter((sn) =>
-        tvShow.seasons.find((s) => s.season_number === sn.seasonNumber)
+      const filteredSeasons = sonarrSeries.seasons.filter(
+        (sn) =>
+          tvShow.seasons.find((s) => s.season_number === sn.seasonNumber) &&
+          (!settings.main.partialRequestsEnabled ? sn.seasonNumber !== 0 : true)
       );
 
       for (const season of filteredSeasons) {

server/lib/settings/index.ts

@@ -131,6 +131,7 @@ export interface MainSettings {
   trustProxy: boolean;
   mediaServerType: number;
   partialRequestsEnabled: boolean;
+  enableSpecialEpisodes: boolean;
   locale: string;
   proxy: ProxySettings;
 }
@@ -154,6 +155,7 @@ interface FullPublicSettings extends PublicSettings {
   jellyfinForgotPasswordUrl?: string;
   jellyfinServerName?: string;
   partialRequestsEnabled: boolean;
+  enableSpecialEpisodes: boolean;
   cacheImages: boolean;
   vapidPublic: string;
   enablePushRegistration: boolean;
@@ -343,6 +345,7 @@ class Settings {
         trustProxy: false,
         mediaServerType: MediaServerType.NOT_CONFIGURED,
         partialRequestsEnabled: true,
+        enableSpecialEpisodes: false,
         locale: 'en',
         proxy: {
           enabled: false,
@@ -587,6 +590,7 @@ class Settings {
       originalLanguage: this.data.main.originalLanguage,
       mediaServerType: this.main.mediaServerType,
       partialRequestsEnabled: this.data.main.partialRequestsEnabled,
+      enableSpecialEpisodes: this.data.main.enableSpecialEpisodes,
       cacheImages: this.data.main.cacheImages,
       vapidPublic: this.vapidPublic,
       enablePushRegistration: this.data.notifications.agents.webpush.enabled,