Skip to content

Commit

Permalink
Merge pull request #632 from HaveAGitGat/apprise
Browse files Browse the repository at this point in the history
Add Apprise
  • Loading branch information
HaveAGitGat committed May 14, 2024
2 parents 5eb2a98 + 5f953a0 commit cf60dec
Show file tree
Hide file tree
Showing 4 changed files with 227 additions and 6 deletions.
123 changes: 123 additions & 0 deletions FlowPlugins/CommunityFlowPlugins/tools/apprise/1.0.0/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.plugin = exports.details = void 0;
var cliUtils_1 = require("../../../../FlowHelpers/1.0.0/cliUtils");
/* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
var details = function () { return ({
name: 'Apprise',
description: 'Use Apprise to send notifications.',
style: {
borderColor: 'green',
},
tags: '',
isStartPlugin: false,
pType: '',
requiresVersion: '2.11.01',
sidebarPosition: -1,
icon: 'faBell',
inputs: [
{
label: 'Command',
name: 'command',
type: 'string',
defaultValue: '-vv -t "Success" -b "File {{{args.inputFileObj._id}}}" "discord://xxx/xxxx"',
inputUI: {
type: 'textarea',
style: {
height: '100px',
},
},
tooltip: "Visit the following for more information on Apprise: https://github.com/caronc/apprise\n \\nExample\\n\n -vv -t \"Success\" -b \"File {{{args.inputFileObj._id}}}\" \"discord://xxx/xxxx\"\n\n\n \\nExample\\n\n -vv -t \"Processing\" -b \"File {{{args.inputFileObj._id}}}\" "
+ "\"discord://{{{args.userVariables.global.discord_webhook}}}\"\n ",
},
],
outputs: [
{
number: 1,
tooltip: 'Continue to next plugin',
},
],
}); };
exports.details = details;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function () {
var lib, command, cliArgs, cli, res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
lib = require('../../../../../methods/lib')();
// eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
args.inputs = lib.loadDefaultValues(args.inputs, details);
command = args.inputs.command;
cliArgs = __spreadArray([], args.deps.parseArgsStringToArgv(command, '', ''), true);
cli = new cliUtils_1.CLI({
cli: 'apprise',
spawnArgs: cliArgs,
spawnOpts: {},
jobLog: args.jobLog,
outputFilePath: '',
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
});
return [4 /*yield*/, cli.runCli()];
case 1:
res = _a.sent();
if (res.cliExitCode !== 0) {
args.jobLog('Running Apprise failed');
throw new Error('Running Apprise failed');
}
return [2 /*return*/, {
outputFileObj: args.inputFileObj,
outputNumber: 1,
variables: args.variables,
}];
}
});
}); };
exports.plugin = plugin;
9 changes: 6 additions & 3 deletions FlowPlugins/FlowHelpers/1.0.0/cliUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -289,23 +289,26 @@ var CLI = /** @class */ (function () {
thread.on('error', function () {
// catches execution error (bad file)
// eslint-disable-next-line no-console
console.log(1, "Error executing binary: ".concat(_this.config.cli));
console.log("Error executing binary: ".concat(_this.config.cli));
_this.config.jobLog("Error executing binary: ".concat(_this.config.cli));
resolve(1);
});
// thread.stdout.pipe(process.stdout);
// thread.stderr.pipe(process.stderr);
thread.on('close', function (code) {
if (code !== 0) {
// eslint-disable-next-line no-console
console.log(code, 'CLI error');
console.log("CLI error code: ".concat(code));
_this.config.jobLog("CLI error code: ".concat(code));
}
resolve(code);
});
}
catch (err) {
// catches execution error (no file)
// eslint-disable-next-line no-console
console.log(1, "Error executing binary: ".concat(_this.config.cli));
console.log("Error executing binary: ".concat(_this.config.cli, ": ").concat(err));
_this.config.jobLog("Error executing binary: ".concat(_this.config.cli, ": ").concat(err));
resolve(1);
}
})];
Expand Down
92 changes: 92 additions & 0 deletions FlowPluginsTs/CommunityFlowPlugins/tools/apprise/1.0.0/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import { CLI } from '../../../../FlowHelpers/1.0.0/cliUtils';
import {
IpluginDetails,
IpluginInputArgs,
IpluginOutputArgs,
} from '../../../../FlowHelpers/1.0.0/interfaces/interfaces';

/* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
const details = ():IpluginDetails => ({
name: 'Apprise',
description: 'Use Apprise to send notifications.',
style: {
borderColor: 'green',
},
tags: '',
isStartPlugin: false,
pType: '',
requiresVersion: '2.11.01',
sidebarPosition: -1,
icon: 'faBell',
inputs: [
{
label: 'Command',
name: 'command',
type: 'string',
defaultValue: '-vv -t "Success" -b "File {{{args.inputFileObj._id}}}" "discord://xxx/xxxx"',
inputUI: {
type: 'textarea',
style: {
height: '100px',
},
},
tooltip: `Visit the following for more information on Apprise: https://github.com/caronc/apprise
\\nExample\\n
-vv -t "Success" -b "File {{{args.inputFileObj._id}}}" "discord://xxx/xxxx"
\\nExample\\n
-vv -t "Processing" -b "File {{{args.inputFileObj._id}}}" `

+ `"discord://{{{args.userVariables.global.discord_webhook}}}"
`,
},
],
outputs: [
{
number: 1,
tooltip: 'Continue to next plugin',
},
],
});

// eslint-disable-next-line @typescript-eslint/no-unused-vars
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);

const { command } = args.inputs;

const cliArgs = [
...args.deps.parseArgsStringToArgv(command, '', ''),
];

const cli = new CLI({
cli: 'apprise',
spawnArgs: cliArgs,
spawnOpts: {},
jobLog: args.jobLog,
outputFilePath: '',
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
});

const res = await cli.runCli();

if (res.cliExitCode !== 0) {
args.jobLog('Running Apprise failed');
throw new Error('Running Apprise failed');
}

return {
outputFileObj: args.inputFileObj,
outputNumber: 1,
variables: args.variables,
};
};
export {
details,
plugin,
};
9 changes: 6 additions & 3 deletions FlowPluginsTs/FlowHelpers/1.0.0/cliUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,8 @@ class CLI {
thread.on('error', () => {
// catches execution error (bad file)
// eslint-disable-next-line no-console
console.log(1, `Error executing binary: ${this.config.cli}`);
console.log(`Error executing binary: ${this.config.cli}`);
this.config.jobLog(`Error executing binary: ${this.config.cli}`);
resolve(1);
});

Expand All @@ -324,14 +325,16 @@ class CLI {
thread.on('close', (code: number) => {
if (code !== 0) {
// eslint-disable-next-line no-console
console.log(code, 'CLI error');
console.log(`CLI error code: ${code}`);
this.config.jobLog(`CLI error code: ${code}`);
}
resolve(code);
});
} catch (err) {
// catches execution error (no file)
// eslint-disable-next-line no-console
console.log(1, `Error executing binary: ${this.config.cli}`);
console.log(`Error executing binary: ${this.config.cli}: ${err}`);
this.config.jobLog(`Error executing binary: ${this.config.cli}: ${err}`);
resolve(1);
}
});
Expand Down

0 comments on commit cf60dec

Please sign in to comment.