Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Adding anime specific Sonarr/Radarr instance support #3664

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from
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
20 changes: 20 additions & 0 deletions overseerr-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,9 @@ components:
is4k:
type: boolean
example: false
isAnime:
type: boolean
example: false
minimumAvailability:
type: string
example: 'In Cinema'
Expand All @@ -385,6 +388,7 @@ components:
- activeProfileName
- activeDirectory
- is4k
- isAnime
- minimumAvailability
- isDefault
SonarrSettings:
Expand Down Expand Up @@ -439,6 +443,9 @@ components:
is4k:
type: boolean
example: false
isAnime:
type: boolean
example: false
enableSeasonFolders:
type: boolean
example: false
Expand All @@ -464,6 +471,7 @@ components:
- activeProfileName
- activeDirectory
- is4k
- isAnime
- enableSeasonFolders
- isDefault
ServarrTag:
Expand Down Expand Up @@ -1028,6 +1036,9 @@ components:
is4k:
type: boolean
example: false
isAnime:
type: boolean
example: false
serverId:
type: number
profileId:
Expand Down Expand Up @@ -5018,6 +5029,9 @@ paths:
is4k:
type: boolean
example: false
isAnime:
type: boolean
example: false
serverId:
type: number
profileId:
Expand Down Expand Up @@ -5122,6 +5136,9 @@ paths:
is4k:
type: boolean
example: false
isAnime:
type: boolean
example: false
serverId:
type: number
profileId:
Expand Down Expand Up @@ -5763,6 +5780,9 @@ paths:
is4k:
type: boolean
example: false
isAnime:
type: boolean
example: false
responses:
'200':
description: Returned media
Expand Down
69 changes: 51 additions & 18 deletions server/entity/MediaRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import type {
} from '@server/api/servarr/sonarr';
import SonarrAPI from '@server/api/servarr/sonarr';
import TheMovieDb from '@server/api/themoviedb';
import { ANIME_KEYWORD_ID } from '@server/api/themoviedb/constants';
import {
MediaRequestStatus,
MediaStatus,
Expand Down Expand Up @@ -157,6 +156,7 @@ export class MediaRequest {
.leftJoin('request.media', 'media')
.leftJoinAndSelect('request.requestedBy', 'user')
.where('request.is4k = :is4k', { is4k: requestBody.is4k })
.andWhere('request.isAnime = :isAnime', { isAnime: requestBody.isAnime })
.andWhere('media.tmdbId = :tmdbId', { tmdbId: tmdbMedia.id })
.andWhere('media.mediaType = :mediaType', {
mediaType: requestBody.mediaType,
Expand All @@ -173,6 +173,7 @@ export class MediaRequest {
tmdbId: tmdbMedia.id,
mediaType: requestBody.mediaType,
is4k: requestBody.is4k,
isAnime: requestBody.isAnime,
label: 'Media Request',
});

Expand Down Expand Up @@ -231,6 +232,7 @@ export class MediaRequest {
? user
: undefined,
is4k: requestBody.is4k,
isAnime: requestBody.isAnime,
serverId: requestBody.serverId,
profileId: requestBody.profileId,
rootFolder: requestBody.rootFolder,
Expand Down Expand Up @@ -260,6 +262,7 @@ export class MediaRequest {
.filter(
(request) =>
request.is4k === requestBody.is4k &&
request.isAnime === requestBody.isAnime &&
request.status !== MediaRequestStatus.DECLINED
)
.reduce((seasons, request) => {
Expand Down Expand Up @@ -334,6 +337,7 @@ export class MediaRequest {
? user
: undefined,
is4k: requestBody.is4k,
isAnime: requestBody.isAnime,
serverId: requestBody.serverId,
profileId: requestBody.profileId,
rootFolder: requestBody.rootFolder,
Expand Down Expand Up @@ -414,6 +418,9 @@ export class MediaRequest {
@Column({ default: false })
public is4k: boolean;

@Column({ default: false })
public isAnime: boolean;

@Column({ nullable: true })
public serverId: number;

Expand Down Expand Up @@ -665,9 +672,20 @@ export class MediaRequest {
}

let radarrSettings = settings.radarr.find(
(radarr) => radarr.isDefault && radarr.is4k === this.is4k
(radarr) =>
radarr.isDefault &&
radarr.is4k === this.is4k &&
radarr.isAnime === this.isAnime
);

// Fallback for requesting anime if there is no default anime server
// This will sent the anime request to the regular default Radarr instance for single-instance setups
if (!radarrSettings && this.isAnime) {
radarrSettings = settings.radarr.find(
(radarr) => radarr.isDefault && radarr.is4k === this.is4k
);
}

if (
this.serverId !== null &&
this.serverId >= 0 &&
Expand All @@ -689,9 +707,9 @@ export class MediaRequest {
if (!radarrSettings) {
logger.warn(
`There is no default ${
this.is4k ? '4K ' : ''
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}Radarr server configured. Did you set any of your ${
this.is4k ? '4K ' : ''
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}Radarr servers as default?`,
{
label: 'Media Request',
Expand Down Expand Up @@ -900,9 +918,20 @@ export class MediaRequest {
}

let sonarrSettings = settings.sonarr.find(
(sonarr) => sonarr.isDefault && sonarr.is4k === this.is4k
(sonarr) =>
sonarr.isDefault &&
sonarr.is4k === this.is4k &&
sonarr.isAnime == this.isAnime
);

// Fallback for requesting anime if there is no default anime server
// This will sent the anime request to the regular default Sonarr instance for single-instance setups
if (!sonarrSettings && this.isAnime) {
sonarrSettings = settings.sonarr.find(
(sonarr) => sonarr.isDefault && sonarr.is4k === this.is4k
);
}

if (
this.serverId !== null &&
this.serverId >= 0 &&
Expand All @@ -924,9 +953,9 @@ export class MediaRequest {
if (!sonarrSettings) {
logger.warn(
`There is no default ${
this.is4k ? '4K ' : ''
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}Sonarr server configured. Did you set any of your ${
this.is4k ? '4K ' : ''
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}Sonarr servers as default?`,
{
label: 'Media Request',
Expand Down Expand Up @@ -979,11 +1008,7 @@ export class MediaRequest {
let seriesType: SonarrSeries['seriesType'] = 'standard';

// Change series type to anime if the anime keyword is present on tmdb
if (
series.keywords.results.some(
(keyword) => keyword.id === ANIME_KEYWORD_ID
)
) {
if (this.isAnime) {
seriesType = sonarrSettings.animeSeriesType ?? 'anime';
}

Expand Down Expand Up @@ -1171,30 +1196,38 @@ export class MediaRequest {

switch (type) {
case Notification.MEDIA_APPROVED:
event = `${this.is4k ? '4K ' : ''}${mediaType} Request Approved`;
event = `${
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}${mediaType} Request Approved`;
notifyAdmin = false;
break;
case Notification.MEDIA_DECLINED:
event = `${this.is4k ? '4K ' : ''}${mediaType} Request Declined`;
event = `${
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}${mediaType} Request Declined`;
notifyAdmin = false;
break;
case Notification.MEDIA_PENDING:
event = `New ${this.is4k ? '4K ' : ''}${mediaType} Request`;
event = `New ${
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}${mediaType} Request`;
break;
case Notification.MEDIA_AUTO_REQUESTED:
event = `${
this.is4k ? '4K ' : ''
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}${mediaType} Request Automatically Submitted`;
notifyAdmin = false;
notifySystem = false;
break;
case Notification.MEDIA_AUTO_APPROVED:
event = `${
this.is4k ? '4K ' : ''
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}${mediaType} Request Automatically Approved`;
break;
case Notification.MEDIA_FAILED:
event = `${this.is4k ? '4K ' : ''}${mediaType} Request Failed`;
event = `${
this.isAnime ? 'Anime ' : this.is4k ? '4K ' : ''
}${mediaType} Request Failed`;
break;
}

Expand Down
1 change: 1 addition & 0 deletions server/interfaces/api/requestInterfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export type MediaRequestBody = {
tvdbId?: number;
seasons?: number[] | 'all';
is4k?: boolean;
isAnime?: boolean;
serverId?: number;
profileId?: number;
rootFolder?: string;
Expand Down
1 change: 1 addition & 0 deletions server/interfaces/api/serviceInterfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface ServiceCommonServer {
id: number;
name: string;
is4k: boolean;
isAnime: boolean;
isDefault: boolean;
activeProfileId: number;
activeDirectory: string;
Expand Down
1 change: 1 addition & 0 deletions server/lib/settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ export interface DVRSettings {
activeDirectory: string;
tags: number[];
is4k: boolean;
isAnime: boolean;
isDefault: boolean;
externalUrl?: string;
syncEnabled: boolean;
Expand Down
33 changes: 33 additions & 0 deletions server/migration/1698786580184-AddMediaRequestIsAnimeField.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import type { MigrationInterface, QueryRunner } from 'typeorm';

export class AddMediaRequestIsAnimeField1698786580184
implements MigrationInterface
{
name = 'AddMediaRequestIsAnimeField1698786580184';

public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`CREATE TABLE "temporary_media_request" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "status" integer NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), "type" varchar NOT NULL, "mediaId" integer, "requestedById" integer, "modifiedById" integer, "is4k" boolean NOT NULL DEFAULT (0), "isAnime" boolean NOT NULL DEFAULT (0), "serverId" integer, "profileId" integer, "rootFolder" varchar, "languageProfileId" integer, "tags" text, "isAutoRequest" boolean NOT NULL DEFAULT (0), CONSTRAINT "FK_a1aa713f41c99e9d10c48da75a0" FOREIGN KEY ("mediaId") REFERENCES "media" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_6997bee94720f1ecb7f31137095" FOREIGN KEY ("requestedById") REFERENCES "user" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_f4fc4efa14c3ba2b29c4525fa15" FOREIGN KEY ("modifiedById") REFERENCES "user" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`
);
await queryRunner.query(
`INSERT INTO "temporary_media_request"("id", "status", "createdAt", "updatedAt", "type", "mediaId", "requestedById", "modifiedById", "is4k", "serverId", "profileId", "rootFolder", "languageProfileId", "tags", "isAutoRequest") SELECT "id", "status", "createdAt", "updatedAt", "type", "mediaId", "requestedById", "modifiedById", "is4k", "serverId", "profileId", "rootFolder", "languageProfileId", "tags", "isAutoRequest" FROM "media_request"`
);
await queryRunner.query(`DROP TABLE "media_request"`);
await queryRunner.query(
`ALTER TABLE "temporary_media_request" RENAME TO "media_request"`
);
}

public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "media_request" RENAME TO "temporary_media_request"`
);
await queryRunner.query(
`CREATE TABLE "media_request" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "status" integer NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), "type" varchar NOT NULL, "mediaId" integer, "requestedById" integer, "modifiedById" integer, "is4k" boolean NOT NULL DEFAULT (0), "serverId" integer, "profileId" integer, "rootFolder" varchar, "languageProfileId" integer, "tags" text, "isAutoRequest" boolean NOT NULL DEFAULT (0), CONSTRAINT "FK_a1aa713f41c99e9d10c48da75a0" FOREIGN KEY ("mediaId") REFERENCES "media" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_6997bee94720f1ecb7f31137095" FOREIGN KEY ("requestedById") REFERENCES "user" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_f4fc4efa14c3ba2b29c4525fa15" FOREIGN KEY ("modifiedById") REFERENCES "user" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`
);
await queryRunner.query(
`INSERT INTO "media_request"("id", "status", "createdAt", "updatedAt", "type", "mediaId", "requestedById", "modifiedById", "is4k", "serverId", "profileId", "rootFolder", "languageProfileId", "tags", "isAutoRequest") SELECT "id", "status", "createdAt", "updatedAt", "type", "mediaId", "requestedById", "modifiedById", "is4k", "serverId", "profileId", "rootFolder", "languageProfileId", "tags", "isAutoRequest" FROM "temporary_media_request"`
);
await queryRunner.query(`DROP TABLE "temporary_media_request"`);
}
}
4 changes: 4 additions & 0 deletions server/routes/service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ serviceRoutes.get('/radarr', async (req, res) => {
id: radarr.id,
name: radarr.name,
is4k: radarr.is4k,
isAnime: radarr.isAnime,
isDefault: radarr.isDefault,
activeDirectory: radarr.activeDirectory,
activeProfileId: radarr.activeProfileId,
Expand Down Expand Up @@ -59,6 +60,7 @@ serviceRoutes.get<{ radarrId: string }>(
id: radarrSettings.id,
name: radarrSettings.name,
is4k: radarrSettings.is4k,
isAnime: radarrSettings.isAnime,
isDefault: radarrSettings.isDefault,
activeDirectory: radarrSettings.activeDirectory,
activeProfileId: radarrSettings.activeProfileId,
Expand Down Expand Up @@ -87,6 +89,7 @@ serviceRoutes.get('/sonarr', async (req, res) => {
id: sonarr.id,
name: sonarr.name,
is4k: sonarr.is4k,
isAnime: sonarr.isAnime,
isDefault: sonarr.isDefault,
activeDirectory: sonarr.activeDirectory,
activeProfileId: sonarr.activeProfileId,
Expand Down Expand Up @@ -133,6 +136,7 @@ serviceRoutes.get<{ sonarrId: string }>(
id: sonarrSettings.id,
name: sonarrSettings.name,
is4k: sonarrSettings.is4k,
isAnime: sonarrSettings.isAnime,
isDefault: sonarrSettings.isDefault,
activeDirectory: sonarrSettings.activeDirectory,
activeProfileId: sonarrSettings.activeProfileId,
Expand Down
12 changes: 10 additions & 2 deletions server/routes/settings/radarr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ radarrRoutes.post('/', (req, res) => {
// and are the default
if (req.body.isDefault) {
settings.radarr
.filter((radarrInstance) => radarrInstance.is4k === req.body.is4k)
.filter(
(radarrInstance) =>
radarrInstance.is4k === req.body.is4k &&
radarrInstance.isAnime === req.body.isAnime
)
.forEach((radarrInstance) => {
radarrInstance.isDefault = false;
});
Expand Down Expand Up @@ -92,7 +96,11 @@ radarrRoutes.put<{ id: string }, RadarrSettings, RadarrSettings>(
// and are the default
if (req.body.isDefault) {
settings.radarr
.filter((radarrInstance) => radarrInstance.is4k === req.body.is4k)
.filter(
(radarrInstance) =>
radarrInstance.is4k === req.body.is4k &&
radarrInstance.isAnime === req.body.isAnime
)
.forEach((radarrInstance) => {
radarrInstance.isDefault = false;
});
Expand Down
Loading