mirror of
https://github.com/gabehf/Tdarr_Plugins.git
synced 2026-03-14 01:36:08 -07:00
Merge pull request #589 from Marnalas/flowPluginApplyRadarrSonarrNamingPolicy
Flow plugin apply radarr sonarr naming policy
This commit is contained in:
HaveAGitGat
GitHub
commit
8472813c74
2 changed files with 581 additions and 0 deletions
|
|
@ -0,0 +1,293 @@
|
|||
import fileMoveOrCopy from '../../../../FlowHelpers/1.0.0/fileMoveOrCopy';
|
||||
import {
|
||||
getContainer, getFileAbosluteDir, getFileName,
|
||||
} from '../../../../FlowHelpers/1.0.0/fileUtils';
|
||||
import {
|
||||
IpluginDetails,
|
||||
IpluginInputArgs,
|
||||
IpluginOutputArgs,
|
||||
} from '../../../../FlowHelpers/1.0.0/interfaces/interfaces';
|
||||
|
||||
const details = (): IpluginDetails => ({
|
||||
name: 'Apply Radarr or Sonarr naming policy',
|
||||
description:
|
||||
'Apply Radarr or Sonarr naming policy to a file. This plugin should be called after the original file has been '
|
||||
+ 'replaced and Radarr or Sonarr has been notified. Radarr or Sonarr should also be notified after this plugin.',
|
||||
style: {
|
||||
borderColor: 'green',
|
||||
},
|
||||
tags: '',
|
||||
isStartPlugin: false,
|
||||
pType: '',
|
||||
requiresVersion: '2.11.01',
|
||||
sidebarPosition: -1,
|
||||
icon: 'faPenToSquare',
|
||||
inputs: [
|
||||
{
|
||||
label: 'Arr',
|
||||
name: 'arr',
|
||||
type: 'string',
|
||||
defaultValue: 'radarr',
|
||||
inputUI: {
|
||||
type: 'dropdown',
|
||||
options: ['radarr', 'sonarr'],
|
||||
},
|
||||
tooltip: 'Specify which arr to use',
|
||||
},
|
||||
{
|
||||
label: 'Arr API Key',
|
||||
name: 'arr_api_key',
|
||||
type: 'string',
|
||||
defaultValue: '',
|
||||
inputUI: {
|
||||
type: 'text',
|
||||
},
|
||||
tooltip: 'Input your arr api key here',
|
||||
},
|
||||
{
|
||||
label: 'Arr Host',
|
||||
name: 'arr_host',
|
||||
type: 'string',
|
||||
defaultValue: 'http://192.168.1.1:7878',
|
||||
inputUI: {
|
||||
type: 'text',
|
||||
},
|
||||
tooltip: 'Input your arr host here.'
|
||||
+ '\\nExample:\\n'
|
||||
+ 'http://192.168.1.1:7878\\n'
|
||||
+ 'http://192.168.1.1:8989\\n'
|
||||
+ 'https://radarr.domain.com\\n'
|
||||
+ 'https://sonarr.domain.com\\n',
|
||||
},
|
||||
],
|
||||
outputs: [
|
||||
{
|
||||
number: 1,
|
||||
tooltip: 'Radarr or Sonarr notified',
|
||||
},
|
||||
{
|
||||
number: 2,
|
||||
tooltip: 'Radarr or Sonarr do not know this file',
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
interface IHTTPHeaders {
|
||||
'Content-Type': string,
|
||||
'X-Api-Key': string,
|
||||
Accept: string,
|
||||
}
|
||||
interface IFileInfo {
|
||||
id: string,
|
||||
seasonNumber?: number,
|
||||
episodeNumber?: number
|
||||
}
|
||||
interface ILookupResponse {
|
||||
data: [{ id: number }],
|
||||
}
|
||||
interface IParseResponse {
|
||||
data: {
|
||||
movie?: { id: number },
|
||||
series?: { id: number },
|
||||
parsedEpisodeInfo?: {
|
||||
episodeNumbers: number[],
|
||||
seasonNumber: number
|
||||
},
|
||||
},
|
||||
}
|
||||
interface IFileToRename {
|
||||
newPath: string,
|
||||
episodeNumbers?: number[]
|
||||
}
|
||||
interface IPreviewRenameResponse {
|
||||
data: IFileToRename[]
|
||||
}
|
||||
interface IArrApp {
|
||||
name: string,
|
||||
host: string,
|
||||
headers: IHTTPHeaders,
|
||||
content: string,
|
||||
delegates: {
|
||||
getFileInfoFromLookupResponse:
|
||||
(lookupResponse: ILookupResponse, fileName: string) => IFileInfo,
|
||||
getFileInfoFromParseResponse:
|
||||
(parseResponse: IParseResponse) => IFileInfo,
|
||||
buildPreviewRenameResquestUrl:
|
||||
(fileInfo: IFileInfo) => string,
|
||||
getFileToRenameFromPreviewRenameResponse:
|
||||
(previewRenameResponse: IPreviewRenameResponse, fileInfo: IFileInfo) => IFileToRename | undefined
|
||||
}
|
||||
}
|
||||
|
||||
const getFileInfoFromLookup = async (
|
||||
args: IpluginInputArgs,
|
||||
arrApp: IArrApp,
|
||||
fileName: string,
|
||||
)
|
||||
: Promise<IFileInfo> => {
|
||||
let fInfo: IFileInfo = { id: '-1' };
|
||||
const imdbId = /\b(tt|nm|co|ev|ch|ni)\d{7,10}?\b/i.exec(fileName)?.at(0) ?? '';
|
||||
if (imdbId !== '') {
|
||||
const lookupResponse: ILookupResponse = await args.deps.axios({
|
||||
method: 'get',
|
||||
url: `${arrApp.host}/api/v3/${arrApp.name === 'radarr' ? 'movie' : 'series'}/lookup?term=imdb:${imdbId}`,
|
||||
headers: arrApp.headers,
|
||||
});
|
||||
fInfo = arrApp.delegates.getFileInfoFromLookupResponse(lookupResponse, fileName);
|
||||
args.jobLog(`${arrApp.content} ${fInfo.id !== '-1' ? `'${fInfo.id}' found` : 'not found'}`
|
||||
+ ` for imdb '${imdbId}'`);
|
||||
}
|
||||
return fInfo;
|
||||
};
|
||||
|
||||
const getFileInfoFromParse = async (
|
||||
args: IpluginInputArgs,
|
||||
arrApp: IArrApp,
|
||||
fileName: string,
|
||||
)
|
||||
: Promise<IFileInfo> => {
|
||||
let fInfo: IFileInfo = { id: '-1' };
|
||||
const parseResponse: IParseResponse = await args.deps.axios({
|
||||
method: 'get',
|
||||
url: `${arrApp.host}/api/v3/parse?title=${encodeURIComponent(getFileName(fileName))}`,
|
||||
headers: arrApp.headers,
|
||||
});
|
||||
fInfo = arrApp.delegates.getFileInfoFromParseResponse(parseResponse);
|
||||
args.jobLog(`${arrApp.content} ${fInfo.id !== '-1' ? `'${fInfo.id}' found` : 'not found'}`
|
||||
+ ` for '${getFileName(fileName)}'`);
|
||||
return fInfo;
|
||||
};
|
||||
|
||||
const getFileInfo = async (
|
||||
args: IpluginInputArgs,
|
||||
arrApp: IArrApp,
|
||||
fileName: string,
|
||||
)
|
||||
: Promise<IFileInfo> => {
|
||||
const fInfo = await getFileInfoFromLookup(args, arrApp, fileName);
|
||||
return (fInfo.id === '-1' || (arrApp.name === 'sonarr' && (fInfo.seasonNumber === -1 || fInfo.episodeNumber === -1)))
|
||||
? getFileInfoFromParse(args, arrApp, fileName)
|
||||
: fInfo;
|
||||
};
|
||||
|
||||
const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
|
||||
const lib = require('../../../../../methods/lib')();
|
||||
// eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
|
||||
args.inputs = lib.loadDefaultValues(args.inputs, details);
|
||||
|
||||
let newPath = '';
|
||||
let isSuccessful = false;
|
||||
const arr = String(args.inputs.arr);
|
||||
const arr_host = String(args.inputs.arr_host).trim();
|
||||
const arrHost = arr_host.endsWith('/') ? arr_host.slice(0, -1) : arr_host;
|
||||
const originalFileName = args.originalLibraryFile?._id ?? '';
|
||||
const currentFileName = args.inputFileObj?._id ?? '';
|
||||
const headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'X-Api-Key': String(args.inputs.arr_api_key),
|
||||
Accept: 'application/json',
|
||||
};
|
||||
|
||||
const arrApp: IArrApp = arr === 'radarr'
|
||||
? {
|
||||
name: arr,
|
||||
host: arrHost,
|
||||
headers,
|
||||
content: 'Movie',
|
||||
delegates: {
|
||||
getFileInfoFromLookupResponse:
|
||||
(lookupResponse) => ({ id: String(lookupResponse?.data?.at(0)?.id ?? -1) }),
|
||||
getFileInfoFromParseResponse:
|
||||
(parseResponse) => ({ id: String(parseResponse?.data?.movie?.id ?? -1) }),
|
||||
buildPreviewRenameResquestUrl:
|
||||
(fInfo) => `${arrHost}/api/v3/rename?movieId=${fInfo.id}`,
|
||||
getFileToRenameFromPreviewRenameResponse:
|
||||
(previewRenameResponse) => previewRenameResponse.data?.at(0),
|
||||
},
|
||||
}
|
||||
: {
|
||||
name: arr,
|
||||
host: arrHost,
|
||||
headers,
|
||||
content: 'Serie',
|
||||
delegates: {
|
||||
getFileInfoFromLookupResponse:
|
||||
(lookupResponse, fileName) => {
|
||||
const fInfo: IFileInfo = { id: String(lookupResponse?.data?.at(0)?.id ?? -1) };
|
||||
if (fInfo.id !== '-1') {
|
||||
const seasonEpisodenumber = /\bS\d{1,3}E\d{1,4}\b/i.exec(fileName)?.at(0) ?? '';
|
||||
const episodeNumber = /\d{1,4}$/i.exec(seasonEpisodenumber)?.at(0) ?? '';
|
||||
fInfo.seasonNumber = Number(/\d{1,3}/i
|
||||
.exec(seasonEpisodenumber.slice(0, -episodeNumber.length))
|
||||
?.at(0) ?? '-1');
|
||||
fInfo.episodeNumber = Number(episodeNumber !== '' ? episodeNumber : -1);
|
||||
}
|
||||
return fInfo;
|
||||
},
|
||||
getFileInfoFromParseResponse:
|
||||
(parseResponse) => ({
|
||||
id: String(parseResponse?.data?.series?.id ?? -1),
|
||||
seasonNumber: parseResponse?.data?.parsedEpisodeInfo?.seasonNumber ?? 1,
|
||||
episodeNumber: parseResponse?.data?.parsedEpisodeInfo?.episodeNumbers?.at(0) ?? 1,
|
||||
}),
|
||||
buildPreviewRenameResquestUrl:
|
||||
(fInfo) => `${arrHost}/api/v3/rename?seriesId=${fInfo.id}&seasonNumber=${fInfo.seasonNumber}`,
|
||||
getFileToRenameFromPreviewRenameResponse:
|
||||
(previewRenameResponse, fInfo) => previewRenameResponse.data
|
||||
?.find((episodeFile) => episodeFile.episodeNumbers?.at(0) === fInfo.episodeNumber),
|
||||
},
|
||||
};
|
||||
|
||||
args.jobLog('Going to apply new name');
|
||||
args.jobLog(`Renaming ${arrApp.name}...`);
|
||||
|
||||
// Retrieving movie or serie id, plus season and episode number for serie
|
||||
let fInfo = await getFileInfo(args, arrApp, originalFileName);
|
||||
// Useful in some edge cases
|
||||
if (fInfo.id === '-1' && currentFileName !== originalFileName) {
|
||||
fInfo = await getFileInfo(args, arrApp, currentFileName);
|
||||
}
|
||||
|
||||
// Checking that the file has been found
|
||||
if (fInfo.id !== '-1') {
|
||||
// Using rename endpoint to get ids of all the files that need renaming
|
||||
const previewRenameRequestResult = await args.deps.axios({
|
||||
method: 'get',
|
||||
url: arrApp.delegates.buildPreviewRenameResquestUrl(fInfo),
|
||||
headers,
|
||||
});
|
||||
const fileToRename = arrApp.delegates
|
||||
.getFileToRenameFromPreviewRenameResponse(previewRenameRequestResult, fInfo);
|
||||
|
||||
// Only if there is a rename to execute
|
||||
if (fileToRename !== undefined) {
|
||||
newPath = `${getFileAbosluteDir(currentFileName)
|
||||
}/${getFileName(fileToRename.newPath)
|
||||
}.${getContainer(fileToRename.newPath)}`;
|
||||
|
||||
isSuccessful = await fileMoveOrCopy({
|
||||
operation: 'move',
|
||||
sourcePath: currentFileName,
|
||||
destinationPath: newPath,
|
||||
args,
|
||||
});
|
||||
} else {
|
||||
isSuccessful = true;
|
||||
args.jobLog('✔ No rename necessary.');
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
outputFileObj:
|
||||
isSuccessful && newPath !== ''
|
||||
? { ...args.inputFileObj, _id: newPath }
|
||||
: args.inputFileObj,
|
||||
outputNumber: isSuccessful ? 1 : 2,
|
||||
variables: args.variables,
|
||||
};
|
||||
};
|
||||
|
||||
export {
|
||||
details,
|
||||
plugin,
|
||||
};
|
||||
Loading…
Add table
Add a link
Reference in a new issue