Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions seerr-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7755,6 +7755,32 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/OverrideRule'
/overrideRule/advancedRequest:
post:
summary: Advanced override rule request
description: Processes an advanced override rule request.
tags:
- overriderule
responses:
'200':
description: Advanced override rule request processed
content:
application/json:
schema:
type: object
properties:
rootFolder:
type: string
nullable: true
profileId:
type: number
nullable: true
tags:
type: array
items:
type: number
nullable: true

security:
- cookieAuth: []
- apiKey: []
131 changes: 14 additions & 117 deletions server/entity/MediaRequest.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
import TheMovieDb from '@server/api/themoviedb';
import { ANIME_KEYWORD_ID } from '@server/api/themoviedb/constants';
import type { TmdbKeyword } from '@server/api/themoviedb/interfaces';
import {
MediaRequestStatus,
MediaStatus,
MediaType,
} from '@server/constants/media';
import { getRepository } from '@server/datasource';
import OverrideRule from '@server/entity/OverrideRule';
import type { MediaRequestBody } from '@server/interfaces/api/requestInterfaces';
import notificationManager, { Notification } from '@server/lib/notifications';
import overrideRules from '@server/lib/overrideRules';
import { Permission } from '@server/lib/permissions';
import { getSettings } from '@server/lib/settings';
import logger from '@server/logger';
Expand Down Expand Up @@ -211,121 +209,20 @@ export class MediaRequest {
let tags = requestBody.tags;

if (useOverrides) {
const defaultRadarrId = requestBody.is4k
? settings.radarr.findIndex((r) => r.is4k && r.isDefault)
: settings.radarr.findIndex((r) => !r.is4k && r.isDefault);
const defaultSonarrId = requestBody.is4k
? settings.sonarr.findIndex((s) => s.is4k && s.isDefault)
: settings.sonarr.findIndex((s) => !s.is4k && s.isDefault);

const overrideRuleRepository = getRepository(OverrideRule);
const overrideRules = await overrideRuleRepository.find({
where:
requestBody.mediaType === MediaType.MOVIE
? { radarrServiceId: defaultRadarrId }
: { sonarrServiceId: defaultSonarrId },
});

const appliedOverrideRules = overrideRules.filter((rule) => {
const hasAnimeKeyword =
'results' in tmdbMedia.keywords &&
tmdbMedia.keywords.results.some(
(keyword: TmdbKeyword) => keyword.id === ANIME_KEYWORD_ID
);

// Skip override rules if the media is an anime TV show as anime TV
// is handled by default and override rules do not explicitly include
// the anime keyword
if (
requestBody.mediaType === MediaType.TV &&
hasAnimeKeyword &&
(!rule.keywords ||
!rule.keywords.split(',').map(Number).includes(ANIME_KEYWORD_ID))
) {
return false;
}

if (
rule.users &&
!rule.users
.split(',')
.some((userId) => Number(userId) === requestUser.id)
) {
return false;
}
if (
rule.genre &&
!rule.genre
.split(',')
.some((genreId) =>
tmdbMedia.genres
.map((genre) => genre.id)
.includes(Number(genreId))
)
) {
return false;
}
if (
rule.language &&
!rule.language
.split('|')
.some((languageId) => languageId === tmdbMedia.original_language)
) {
return false;
}
if (
rule.keywords &&
!rule.keywords.split(',').some((keywordId) => {
let keywordList: TmdbKeyword[] = [];

if ('keywords' in tmdbMedia.keywords) {
keywordList = tmdbMedia.keywords.keywords;
} else if ('results' in tmdbMedia.keywords) {
keywordList = tmdbMedia.keywords.results;
}

return keywordList
.map((keyword: TmdbKeyword) => keyword.id)
.includes(Number(keywordId));
})
) {
return false;
}
return true;
const overrideRulesResult = await overrideRules({
mediaType: requestBody.mediaType,
is4k: requestBody.is4k || false,
tmdbMedia,
requestUser,
});

// hacky way to prioritize rules
// TODO: make this better
const prioritizedRule = appliedOverrideRules.sort((a, b) => {
const keys: (keyof OverrideRule)[] = ['genre', 'language', 'keywords'];

const aSpecificity = keys.filter((key) => a[key] !== null).length;
const bSpecificity = keys.filter((key) => b[key] !== null).length;

// Take the rule with the most specific condition first
return bSpecificity - aSpecificity;
})[0];

if (prioritizedRule) {
if (prioritizedRule.rootFolder) {
rootFolder = prioritizedRule.rootFolder;
}
if (prioritizedRule.profileId) {
profileId = prioritizedRule.profileId;
}
if (prioritizedRule.tags) {
tags = [
...new Set([
...(tags || []),
...prioritizedRule.tags.split(',').map((tag) => Number(tag)),
]),
];
}

logger.debug('Override rule applied.', {
label: 'Media Request',
overrides: prioritizedRule,
});
if (overrideRulesResult.rootFolder) {
rootFolder = overrideRulesResult.rootFolder;
}
if (overrideRulesResult.profileId) {
profileId = overrideRulesResult.profileId;
}
if (overrideRulesResult.tags) {
tags = overrideRulesResult.tags;
}
}

Expand Down
153 changes: 153 additions & 0 deletions server/lib/overrideRules.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
import { ANIME_KEYWORD_ID } from '@server/api/themoviedb/constants';
import type {
TmdbKeyword,
TmdbMovieDetails,
TmdbTvDetails,
} from '@server/api/themoviedb/interfaces';
import { MediaType } from '@server/constants/media';
import { getRepository } from '@server/datasource';
import OverrideRule from '@server/entity/OverrideRule';
import type { User } from '@server/entity/User';
import { getSettings } from '@server/lib/settings';
import logger from '@server/logger';

export type OverrideRulesResult = {
rootFolder: string | null;
profileId: number | null;
tags: number[] | null;
};

async function overrideRules({
mediaType,
is4k,
tmdbMedia,
requestUser,
}: {
mediaType: MediaType;
is4k: boolean;
tmdbMedia: TmdbMovieDetails | TmdbTvDetails;
requestUser: User;
}): Promise<OverrideRulesResult> {
const settings = getSettings();

let rootFolder: string | null = null;
let profileId: number | null = null;
let tags: number[] | null = null;

const defaultRadarrId = is4k
? settings.radarr.findIndex((r) => r.is4k && r.isDefault)
: settings.radarr.findIndex((r) => !r.is4k && r.isDefault);
const defaultSonarrId = is4k
? settings.sonarr.findIndex((s) => s.is4k && s.isDefault)
: settings.sonarr.findIndex((s) => !s.is4k && s.isDefault);

const overrideRuleRepository = getRepository(OverrideRule);
const overrideRules = await overrideRuleRepository.find({
where:
mediaType === MediaType.MOVIE
? { radarrServiceId: defaultRadarrId }
: { sonarrServiceId: defaultSonarrId },
});

const appliedOverrideRules = overrideRules.filter((rule) => {
const hasAnimeKeyword =
'results' in tmdbMedia.keywords &&
tmdbMedia.keywords.results.some(
(keyword: TmdbKeyword) => keyword.id === ANIME_KEYWORD_ID
);

// Skip override rules if the media is an anime TV show as anime TV
// is handled by default and override rules do not explicitly include
// the anime keyword
if (
mediaType === MediaType.TV &&
hasAnimeKeyword &&
(!rule.keywords ||
!rule.keywords.split(',').map(Number).includes(ANIME_KEYWORD_ID))
) {
return false;
}

if (
rule.users &&
!rule.users.split(',').some((userId) => Number(userId) === requestUser.id)
) {
return false;
}
if (
rule.genre &&
!rule.genre
.split(',')
.some((genreId) =>
tmdbMedia.genres.map((genre) => genre.id).includes(Number(genreId))
)
) {
return false;
}
if (
rule.language &&
!rule.language
.split('|')
.some((languageId) => languageId === tmdbMedia.original_language)
) {
return false;
}
if (
rule.keywords &&
!rule.keywords.split(',').some((keywordId) => {
let keywordList: TmdbKeyword[] = [];

if ('keywords' in tmdbMedia.keywords) {
keywordList = tmdbMedia.keywords.keywords;
} else if ('results' in tmdbMedia.keywords) {
keywordList = tmdbMedia.keywords.results;
}

return keywordList
.map((keyword: TmdbKeyword) => keyword.id)
.includes(Number(keywordId));
})
) {
return false;
}
return true;
});

// hacky way to prioritize rules
// TODO: make this better
const prioritizedRule = appliedOverrideRules.sort((a, b) => {
const keys: (keyof OverrideRule)[] = ['genre', 'language', 'keywords'];

const aSpecificity = keys.filter((key) => a[key] !== null).length;
const bSpecificity = keys.filter((key) => b[key] !== null).length;

// Take the rule with the most specific condition first
return bSpecificity - aSpecificity;
})[0];

if (prioritizedRule) {
if (prioritizedRule.rootFolder) {
rootFolder = prioritizedRule.rootFolder;
}
if (prioritizedRule.profileId) {
profileId = prioritizedRule.profileId;
}
if (prioritizedRule.tags) {
tags = [
...new Set([
...(tags || []),

Check warning

Code scanning / CodeQL

Useless conditional Warning

This use of variable 'tags' always evaluates to false.

Copilot Autofix

AI 3 days ago

To fix the problem, simply remove the unnecessary conditional (tags || []) on line 138 and replace it with just tags. This maintains existing functionality and clarifies the code by removing an always-true/always-false (useless) conditional. Only modify line 138 within the file server/lib/overrideRules.ts. No additional imports or definitions are needed.


Suggested changeset 1
server/lib/overrideRules.ts

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/server/lib/overrideRules.ts b/server/lib/overrideRules.ts
--- a/server/lib/overrideRules.ts
+++ b/server/lib/overrideRules.ts
@@ -135,7 +135,7 @@
     if (prioritizedRule.tags) {
       tags = [
         ...new Set([
-          ...(tags || []),
+          ...tags,
           ...prioritizedRule.tags.split(',').map((tag) => Number(tag)),
         ]),
       ];
EOF
@@ -135,7 +135,7 @@
if (prioritizedRule.tags) {
tags = [
...new Set([
...(tags || []),
...tags,
...prioritizedRule.tags.split(',').map((tag) => Number(tag)),
]),
];
Copilot is powered by AI and may make mistakes. Always verify output.
...prioritizedRule.tags.split(',').map((tag) => Number(tag)),
]),
];
}

logger.debug('Override rule applied.', {
label: 'Media Request',
overrides: prioritizedRule,
});
}

return { rootFolder, profileId, tags };
}

export default overrideRules;
40 changes: 40 additions & 0 deletions server/routes/overrideRule.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import TheMovieDb from '@server/api/themoviedb';
import { MediaType } from '@server/constants/media';
import { getRepository } from '@server/datasource';
import OverrideRule from '@server/entity/OverrideRule';
import { User } from '@server/entity/User';
import type { OverrideRuleResultsResponse } from '@server/interfaces/api/overrideRuleInterfaces';
import overrideRules, {
type OverrideRulesResult,
} from '@server/lib/overrideRules';
import { Permission } from '@server/lib/permissions';
import { isAuthenticated } from '@server/middleware/auth';
import { Router } from 'express';
Expand Down Expand Up @@ -61,6 +67,40 @@ overrideRuleRoutes.post<
}
});

overrideRuleRoutes.post(
'/advancedRequest',
isAuthenticated(Permission.REQUEST_ADVANCED),
async (req, res, next) => {
try {
const tmdb = new TheMovieDb();
const tmdbMedia =
req.body.mediaType === MediaType.MOVIE
? await tmdb.getMovie({ movieId: req.body.tmdbId })
: await tmdb.getTvShow({ tvId: req.body.tmdbId });

const userRepository = getRepository(User);
const user = await userRepository.findOne({
where: { id: req.body.requestUser },
relations: { requests: true },
});
if (!user) {
return next({ status: 404, message: 'User not found.' });
}

const overrideRulesResult: OverrideRulesResult = await overrideRules({
mediaType: req.body.mediaType,
is4k: req.body.is4k,
tmdbMedia,
requestUser: user,
});

res.status(200).json(overrideRulesResult);
} catch {
next({ status: 404, message: 'Media not found' });
}
}
);

overrideRuleRoutes.put<
{ ruleId: string },
OverrideRule,
Expand Down
Loading
Loading