gabehf/Tdarr_Plugins
1
0
Fork 0
mirror of https://github.com/gabehf/Tdarr_Plugins.git synced 2026-03-16 18:45:53 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added new output to the plugin for the case when file is not found

Browse source
This commit is contained in:
jeanchristophe.mqt@gmail.com 2024-02-03 13:11:17 +01:00
parent 3937c799dd
commit 4b7e10f304
2 changed files with 150 additions and 111 deletions
Download patch file Download diff file Expand all files Collapse all files

143
FlowPlugins/CommunityFlowPlugins/tools/applyRadarrOrSonarrNamingPolicy/1.0.0/index.js
View file

@ -106,15 +106,20 @@ var details = function () { return ({
outputs: [ outputs: [
{ {
number: 1, number: 1,
tooltip: 'Continue to next plugin', tooltip: 'Radarr or Sonnar notified',
}, },
], {
number: 2,
tooltip: 'Radarr or Sonnar do not know this file',
}
]
}); }; }); };
exports.details = details; exports.details = details;
var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function () { var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function () {
var lib, _a, arr, arr_api_key, arr_host, arrHost, fileName, getNewPath, pathWithNewName, episodeNumber_1; var lib, _a, arr, arr_api_key, arr_host, arrHost, filePath, fileName, getNewPath, episodeNumber, getNewPathTypes, newPathOutput;
return __generator(this, function (_b) { var _b, _c;
switch (_b.label) { return __generator(this, function (_d) {
switch (_d.label) {
case 0: case 0:
lib = require('../../../../../methods/lib')(); lib = require('../../../../../methods/lib')();
// eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign // eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
@ -122,15 +127,19 @@ var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function
_a = args.inputs, arr = _a.arr, arr_api_key = _a.arr_api_key; _a = args.inputs, arr = _a.arr, arr_api_key = _a.arr_api_key;
arr_host = String(args.inputs.arr_host).trim(); arr_host = String(args.inputs.arr_host).trim();
arrHost = arr_host.endsWith('/') ? arr_host.slice(0, -1) : arr_host; arrHost = arr_host.endsWith('/') ? arr_host.slice(0, -1) : arr_host;
fileName = (0, fileUtils_1.getFileName)(args.inputFileObj._id); filePath = (_c = (_b = args.originalLibraryFile) === null || _b === void 0 ? void 0 : _b._id) !== null && _c !== void 0 ? _c : '';
getNewPath = function (delegates) { return __awaiter(void 0, void 0, void 0, function () { fileName = (0, fileUtils_1.getFileName)(filePath);
var pathWithNewName, headers, parseRequestConfig, parseRequestResult, id, previewRenameRequestConfig, previewRenameRequestResult, fileToRename; getNewPath = function (getNewPathType) { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) { var output, headers, parseRequestConfig, parseRequestResult, id, previewRenameRequestConfig, previewRenameRequestResult, fileToRename, _a;
switch (_a.label) { return __generator(this, function (_b) {
switch (_b.label) {
case 0: case 0:
pathWithNewName = ''; output = {
args.jobLog('Going to force rename'); newPath: '',
args.jobLog("Renaming ".concat(arr === 'radarr' ? 'Radarr' : 'Sonarr', "...")); isSuccessful: false
};
args.jobLog('Going to apply new name');
args.jobLog("Renaming ".concat(getNewPathType.appName, "..."));
headers = { headers = {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
'X-Api-Key': arr_api_key, 'X-Api-Key': arr_api_key,
@ -143,83 +152,85 @@ var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function
}; };
return [4 /*yield*/, args.deps.axios(parseRequestConfig)]; return [4 /*yield*/, args.deps.axios(parseRequestConfig)];
case 1: case 1:
parseRequestResult = _a.sent(); parseRequestResult = _b.sent();
id = delegates.getIdFromParseRequestResult(parseRequestResult); id = getNewPathType.delegates.getIdFromParseRequestResult(parseRequestResult);
if (!(id !== '-1')) return [3 /*break*/, 6]; if (!(id !== '-1')) return [3 /*break*/, 6];
previewRenameRequestConfig = { previewRenameRequestConfig = {
method: 'get', method: 'get',
url: delegates.buildPreviewRenameResquestUrl(id, parseRequestResult), url: getNewPathType.delegates.buildPreviewRenameResquestUrl(id, parseRequestResult),
headers: headers, headers: headers,
}; };
return [4 /*yield*/, args.deps.axios(previewRenameRequestConfig)]; return [4 /*yield*/, args.deps.axios(previewRenameRequestConfig)];
case 2: case 2:
previewRenameRequestResult = _a.sent(); previewRenameRequestResult = _b.sent();
fileToRename = delegates.getFileToRenameFromPreviewRenameRequestResult(previewRenameRequestResult); fileToRename = getNewPathType.delegates.getFileToRenameFromPreviewRenameRequestResult(previewRenameRequestResult);
if (!(fileToRename !== undefined)) return [3 /*break*/, 4]; if (!(fileToRename !== undefined)) return [3 /*break*/, 4];
pathWithNewName = "".concat((0, fileUtils_1.getFileAbosluteDir)(args.inputFileObj._id), "/").concat((0, fileUtils_1.getFileName)(fileToRename.newPath), ".").concat((0, fileUtils_1.getContainer)(fileToRename.newPath)); output.newPath = "".concat((0, fileUtils_1.getFileAbosluteDir)(args.inputFileObj._id), "/").concat((0, fileUtils_1.getFileName)(fileToRename.newPath), ".").concat((0, fileUtils_1.getContainer)(fileToRename.newPath));
_a = output;
return [4 /*yield*/, (0, fileMoveOrCopy_1.default)({ return [4 /*yield*/, (0, fileMoveOrCopy_1.default)({
operation: 'move', operation: 'move',
sourcePath: args.inputFileObj._id, sourcePath: args.inputFileObj._id,
destinationPath: pathWithNewName, destinationPath: output.newPath,
args: args, args: args,
})]; })];
case 3: case 3:
_a.sent(); _a.isSuccessful = _b.sent();
args.jobLog("\u2714 Renamed ".concat(arr === 'radarr' ? 'movie' : 'serie', " ").concat(id, " : '").concat(args.inputFileObj._id, "' => '").concat(pathWithNewName, "'.")); args.jobLog("\u2714 Renamed ".concat(getNewPathType.contentName, " ").concat(id, " : '").concat(filePath, "' => '").concat(output.newPath, "'."));
return [3 /*break*/, 5]; return [3 /*break*/, 5];
case 4: case 4:
output.isSuccessful = true;
args.jobLog('✔ No rename necessary.'); args.jobLog('✔ No rename necessary.');
_a.label = 5; _b.label = 5;
case 5: return [3 /*break*/, 7]; case 5: return [3 /*break*/, 7];
case 6: case 6:
args.jobLog("No ".concat(arr === 'radarr' ? 'movie' : 'serie', " with a file named '").concat(fileName, "'.")); args.jobLog("No ".concat(getNewPathType.appName, " with a file named '").concat(fileName, "'."));
_a.label = 7; _b.label = 7;
case 7: return [2 /*return*/, pathWithNewName]; case 7: return [2 /*return*/, output];
} }
}); });
}); }; }); };
pathWithNewName = ''; episodeNumber = 0;
if (!(arr === 'radarr')) return [3 /*break*/, 2]; getNewPathTypes = {
return [4 /*yield*/, getNewPath({ radarr: {
getIdFromParseRequestResult: function (parseRequestResult) { var _a, _b, _c, _d; return String((_d = (_c = (_b = (_a = parseRequestResult.data) === null || _a === void 0 ? void 0 : _a.movie) === null || _b === void 0 ? void 0 : _b.movieFile) === null || _c === void 0 ? void 0 : _c.movieId) !== null && _d !== void 0 ? _d : -1); }, appName: 'Radarr',
buildPreviewRenameResquestUrl: function (id, parseRequestResult) { return "".concat(arrHost, "/api/v3/rename?movieId=").concat(id); }, contentName: 'movie',
getFileToRenameFromPreviewRenameRequestResult: function (previewRenameRequestResult) { delegates: {
var _a, _b; getIdFromParseRequestResult: function (parseRequestResult) { var _a, _b, _c, _d; return String((_d = (_c = (_b = (_a = parseRequestResult.data) === null || _a === void 0 ? void 0 : _a.movie) === null || _b === void 0 ? void 0 : _b.movieFile) === null || _c === void 0 ? void 0 : _c.movieId) !== null && _d !== void 0 ? _d : -1); },
return (((_b = (_a = previewRenameRequestResult.data) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0) ? buildPreviewRenameResquestUrl: function (id, parseRequestResult) { return "".concat(arrHost, "/api/v3/rename?movieId=").concat(id); },
previewRenameRequestResult.data[0] getFileToRenameFromPreviewRenameRequestResult: function (previewRenameRequestResult) {
: undefined; var _a, _b;
return (((_b = (_a = previewRenameRequestResult.data) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0) ?
previewRenameRequestResult.data[0]
: undefined;
}
} }
})]; },
sonarr: {
appName: 'Sonarr',
contentName: 'serie',
delegates: {
getIdFromParseRequestResult: function (parseRequestResult) { var _a, _b, _c; return String((_c = (_b = (_a = parseRequestResult.data) === null || _a === void 0 ? void 0 : _a.series) === null || _b === void 0 ? void 0 : _b.id) !== null && _c !== void 0 ? _c : -1); },
buildPreviewRenameResquestUrl: function (id, parseRequestResult) {
episodeNumber = parseRequestResult.data.parsedEpisodeInfo.episodeNumbers[0];
return "".concat(arrHost, "/api/v3/rename?seriesId=").concat(id, "&seasonNumber=").concat(parseRequestResult.data.parsedEpisodeInfo.seasonNumber);
},
getFileToRenameFromPreviewRenameRequestResult: function (previewRenameRequestResult) {
var _a, _b;
return (((_b = (_a = previewRenameRequestResult.data) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0) ?
previewRenameRequestResult.data.find(function (episodeFile) { var _a, _b; return (((_b = (_a = episodeFile.episodeNumbers) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0) ? episodeFile.episodeNumbers[0] === episodeNumber : false; })
: undefined;
}
}
}
};
return [4 /*yield*/, getNewPath(arr === 'radarr' ? getNewPathTypes.radarr : getNewPathTypes.sonarr)];
case 1: case 1:
pathWithNewName = _b.sent(); newPathOutput = _d.sent();
return [3 /*break*/, 5]; return [2 /*return*/, {
case 2: outputFileObj: newPathOutput.isSuccessful ? __assign(__assign({}, args.inputFileObj), { _id: newPathOutput.newPath }) : args.inputFileObj,
if (!(arr === 'sonarr')) return [3 /*break*/, 4]; outputNumber: newPathOutput.isSuccessful ? 1 : 2,
episodeNumber_1 = 0; variables: args.variables,
return [4 /*yield*/, getNewPath({ }];
getIdFromParseRequestResult: function (parseRequestResult) { var _a, _b, _c; return String((_c = (_b = (_a = parseRequestResult.data) === null || _a === void 0 ? void 0 : _a.series) === null || _b === void 0 ? void 0 : _b.id) !== null && _c !== void 0 ? _c : -1); },
buildPreviewRenameResquestUrl: function (id, parseRequestResult) {
episodeNumber_1 = parseRequestResult.data.parsedEpisodeInfo.episodeNumbers[0];
return "".concat(arrHost, "/api/v3/rename?seriesId=").concat(id, "&seasonNumber=").concat(parseRequestResult.data.parsedEpisodeInfo.seasonNumber);
},
getFileToRenameFromPreviewRenameRequestResult: function (previewRenameRequestResult) {
var _a, _b;
return (((_b = (_a = previewRenameRequestResult.data) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0) ?
previewRenameRequestResult.data.find(function (episodeFile) { var _a, _b; return (((_b = (_a = episodeFile.episodeNumbers) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0) ? episodeFile.episodeNumbers[0] === episodeNumber_1 : false; })
: undefined;
}
})];
case 3:
pathWithNewName = _b.sent();
return [3 /*break*/, 5];
case 4:
args.jobLog('No arr specified in plugin inputs.');
_b.label = 5;
case 5: return [2 /*return*/, {
outputFileObj: pathWithNewName !== '' ? __assign(__assign({}, args.inputFileObj), { _id: pathWithNewName }) : args.inputFileObj,
outputNumber: 1,
variables: args.variables,
}];
} }
}); });
}); }; }); };

118
FlowPluginsTs/CommunityFlowPlugins/tools/applyRadarrOrSonarrNamingPolicy/1.0.0/index.ts
View file

@ -61,9 +61,13 @@ const details = (): IpluginDetails => ({
outputs: [ outputs: [
{ {
number: 1, number: 1,
tooltip: 'Continue to next plugin', tooltip: 'Radarr or Sonnar notified',
}, },
], {
number: 2,
tooltip: 'Radarr or Sonnar do not know this file',
}
]
}); });
interface IGetNewPathDelegates { interface IGetNewPathDelegates {
@ -71,6 +75,19 @@ interface IGetNewPathDelegates {
buildPreviewRenameResquestUrl: (id: string, parseRequestResult: any) => string, buildPreviewRenameResquestUrl: (id: string, parseRequestResult: any) => string,
getFileToRenameFromPreviewRenameRequestResult: (previewRenameRequestResult: any) => any getFileToRenameFromPreviewRenameRequestResult: (previewRenameRequestResult: any) => any
} }
interface IGetNewPathType {
appName: string,
contentName: string,
delegates: IGetNewPathDelegates
}
interface IGetNewPathTypes {
radarr: IGetNewPathType,
sonarr: IGetNewPathType
}
interface IGetNewPathOutput {
newPath: string,
isSuccessful: boolean
}
const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => { const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
const lib = require('../../../../../methods/lib')(); const lib = require('../../../../../methods/lib')();
@ -80,14 +97,18 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
const { arr, arr_api_key } = args.inputs; const { arr, arr_api_key } = args.inputs;
const arr_host = String(args.inputs.arr_host).trim(); const arr_host = String(args.inputs.arr_host).trim();
const arrHost = arr_host.endsWith('/') ? arr_host.slice(0, -1) : arr_host; const arrHost = arr_host.endsWith('/') ? arr_host.slice(0, -1) : arr_host;
const fileName = getFileName(args.inputFileObj._id); const filePath = args.originalLibraryFile?._id ?? '';
const fileName = getFileName(filePath);
const getNewPath = async (delegates: IGetNewPathDelegates) const getNewPath = async (getNewPathType: IGetNewPathType)
: Promise<string> => { : Promise<IGetNewPathOutput> => {
let pathWithNewName = ''; const output : IGetNewPathOutput = {
newPath: '',
isSuccessful: false
}
args.jobLog('Going to force rename'); args.jobLog('Going to apply new name');
args.jobLog(`Renaming ${arr === 'radarr' ? 'Radarr' : 'Sonarr'}...`); args.jobLog(`Renaming ${getNewPathType.appName}...`);
const headers = { const headers = {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
@ -102,7 +123,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
headers, headers,
}; };
const parseRequestResult = await args.deps.axios(parseRequestConfig); const parseRequestResult = await args.deps.axios(parseRequestConfig);
const id = delegates.getIdFromParseRequestResult(parseRequestResult); const id = getNewPathType.delegates.getIdFromParseRequestResult(parseRequestResult);
// Checking that the file has been found. A file not found might be caused because Radarr/Sonarr hasn't been notified of a file rename (notify plugin missing ?) // Checking that the file has been found. A file not found might be caused because Radarr/Sonarr hasn't been notified of a file rename (notify plugin missing ?)
// or because Radarr/Sonarr has upgraded the movie/serie to another release before the end of the plugin stack execution. // or because Radarr/Sonarr has upgraded the movie/serie to another release before the end of the plugin stack execution.
@ -110,61 +131,68 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
// Using rename endpoint to get ids of all the files that need renaming. // Using rename endpoint to get ids of all the files that need renaming.
const previewRenameRequestConfig = { const previewRenameRequestConfig = {
method: 'get', method: 'get',
url: delegates.buildPreviewRenameResquestUrl(id, parseRequestResult), url: getNewPathType.delegates.buildPreviewRenameResquestUrl(id, parseRequestResult),
headers, headers,
}; };
const previewRenameRequestResult = await args.deps.axios(previewRenameRequestConfig); const previewRenameRequestResult = await args.deps.axios(previewRenameRequestConfig);
const fileToRename = delegates.getFileToRenameFromPreviewRenameRequestResult(previewRenameRequestResult); const fileToRename = getNewPathType.delegates.getFileToRenameFromPreviewRenameRequestResult(previewRenameRequestResult);
// Only if there is a rename to execute // Only if there is a rename to execute
if (fileToRename !== undefined) { if (fileToRename !== undefined) {
pathWithNewName = `${getFileAbosluteDir(args.inputFileObj._id)}/${getFileName(fileToRename.newPath)}.${getContainer(fileToRename.newPath)}`; output.newPath = `${getFileAbosluteDir(args.inputFileObj._id)}/${getFileName(fileToRename.newPath)}.${getContainer(fileToRename.newPath)}`;
await fileMoveOrCopy({ output.isSuccessful = await fileMoveOrCopy({
operation: 'move', operation: 'move',
sourcePath: args.inputFileObj._id, sourcePath: args.inputFileObj._id,
destinationPath: pathWithNewName, destinationPath: output.newPath,
args, args,
}); });
args.jobLog(`✔ Renamed ${arr === 'radarr' ? 'movie' : 'serie'} ${id} : '${args.inputFileObj._id}' => '${pathWithNewName}'.`); args.jobLog(`✔ Renamed ${getNewPathType.contentName} ${id} : '${filePath}' => '${output.newPath}'.`);
} else } else {
output.isSuccessful = true;
args.jobLog('✔ No rename necessary.'); args.jobLog('✔ No rename necessary.');
}
} else } else
args.jobLog(`No ${arr === 'radarr' ? 'movie' : 'serie'} with a file named '${fileName}'.`); args.jobLog(`No ${getNewPathType.appName} with a file named '${fileName}'.`);
return pathWithNewName; return output;
}; };
let pathWithNewName = ''; let episodeNumber = 0;
if (arr === 'radarr') { const getNewPathTypes: IGetNewPathTypes = {
pathWithNewName = await getNewPath({ radarr: {
getIdFromParseRequestResult: (parseRequestResult) => String(parseRequestResult.data?.movie?.movieFile?.movieId ?? -1), appName: 'Radarr',
buildPreviewRenameResquestUrl: (id, parseRequestResult) => `${arrHost}/api/v3/rename?movieId=${id}`, contentName: 'movie',
getFileToRenameFromPreviewRenameRequestResult: (previewRenameRequestResult) => delegates: {
((previewRenameRequestResult.data?.length ?? 0) > 0) ? getIdFromParseRequestResult: (parseRequestResult) => String(parseRequestResult.data?.movie?.movieFile?.movieId ?? -1),
previewRenameRequestResult.data[0] buildPreviewRenameResquestUrl: (id, parseRequestResult) => `${arrHost}/api/v3/rename?movieId=${id}`,
: undefined getFileToRenameFromPreviewRenameRequestResult: (previewRenameRequestResult) =>
}); ((previewRenameRequestResult.data?.length ?? 0) > 0) ?
} else if (arr === 'sonarr') { previewRenameRequestResult.data[0]
let episodeNumber = 0; : undefined
pathWithNewName = await getNewPath({ }
getIdFromParseRequestResult: (parseRequestResult) => String(parseRequestResult.data?.series?.id ?? -1), },
buildPreviewRenameResquestUrl: (id, parseRequestResult) => { sonarr: {
episodeNumber = parseRequestResult.data.parsedEpisodeInfo.episodeNumbers[0]; appName: 'Sonarr',
return `${arrHost}/api/v3/rename?seriesId=${id}&seasonNumber=${parseRequestResult.data.parsedEpisodeInfo.seasonNumber}`; contentName: 'serie',
}, delegates: {
getFileToRenameFromPreviewRenameRequestResult: (previewRenameRequestResult) => getIdFromParseRequestResult: (parseRequestResult) => String(parseRequestResult.data?.series?.id ?? -1),
((previewRenameRequestResult.data?.length ?? 0) > 0) ? buildPreviewRenameResquestUrl: (id, parseRequestResult) => {
previewRenameRequestResult.data.find((episodeFile: { episodeNumbers: number[]; }) => ((episodeFile.episodeNumbers?.length ?? 0) > 0) ? episodeFile.episodeNumbers[0] === episodeNumber : false) episodeNumber = parseRequestResult.data.parsedEpisodeInfo.episodeNumbers[0];
: undefined return `${arrHost}/api/v3/rename?seriesId=${id}&seasonNumber=${parseRequestResult.data.parsedEpisodeInfo.seasonNumber}`;
}); },
} else { getFileToRenameFromPreviewRenameRequestResult: (previewRenameRequestResult) =>
args.jobLog('No arr specified in plugin inputs.'); ((previewRenameRequestResult.data?.length ?? 0) > 0) ?
previewRenameRequestResult.data.find((episodeFile: { episodeNumbers: number[]; }) => ((episodeFile.episodeNumbers?.length ?? 0) > 0) ? episodeFile.episodeNumbers[0] === episodeNumber : false)
: undefined
}
}
} }
const newPathOutput = await getNewPath(arr === 'radarr' ? getNewPathTypes.radarr : getNewPathTypes.sonarr);
return { return {
outputFileObj: pathWithNewName !== '' ? { ...args.inputFileObj, _id: pathWithNewName } : args.inputFileObj, outputFileObj: newPathOutput.isSuccessful ? { ...args.inputFileObj, _id: newPathOutput.newPath } : args.inputFileObj,
outputNumber: 1, outputNumber: newPathOutput.isSuccessful ? 1 : 2,
variables: args.variables, variables: args.variables,
}; };
}; };