[PLUGINS] Add new plugin runner for managing webhooks and API calls

Author: Josh5

unmanic/libs/uiserver.py

@@ -353,11 +353,16 @@ def make_web_app(self):
         # Add widgets routes
         from unmanic.webserver.plugins import DataPanelRequestHandler
         from unmanic.webserver.plugins import PluginStaticFileHandler
+        from unmanic.webserver.plugins import PluginAPIRequestHandler
         app.add_handlers(r'.*', [
             (
                 PathMatches(r"/unmanic/panel/[^/]+(/(?!static/|assets$).*)?$"),
                 DataPanelRequestHandler
             ),
+            (
+                PathMatches(r"/unmanic/plugin_api/[^/]+(/(?!static/|assets$).*)?$"),
+                PluginAPIRequestHandler
+            ),
             (r"/unmanic/panel/.*/static/(.*)", PluginStaticFileHandler, dict(
                 path=tornado_settings['static_img']
             )),

unmanic/libs/unplugins/executor.py

@@ -55,6 +55,10 @@ def __init__(self, plugins_directory=None):
                 'id':       'frontend.panel',
                 'has_flow': False,
             },
+            {
+                'id':       'frontend.plugin_api',
+                'has_flow': False,
+            },
             {
                 'id':       'library_management.file_test',
                 'has_flow': True,

unmanic/libs/unplugins/plugin_types/frontend/plugin_api.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+    unmanic.plugin_api.py
+
+    Written by:               Josh.5 <[email protected]>
+    Date:                     05 Mar 2022, (11:38 PM)
+
+    Copyright:
+           Copyright (C) Josh Sunnex - All Rights Reserved
+
+           Permission is hereby granted, free of charge, to any person obtaining a copy
+           of this software and associated documentation files (the "Software"), to deal
+           in the Software without restriction, including without limitation the rights
+           to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+           copies of the Software, and to permit persons to whom the Software is
+           furnished to do so, subject to the following conditions:
+
+           The above copyright notice and this permission notice shall be included in all
+           copies or substantial portions of the Software.
+
+           THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+           EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+           MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+           IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+           DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+           OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+           OR OTHER DEALINGS IN THE SOFTWARE.
+
+"""
+
+from ..plugin_type_base import PluginType
+
+
+class PluginAPI(PluginType):
+    name = "Frontend - PluginAPI"
+    runner = "render_plugin_api"
+    runner_docstring = """
+    Runner function - provide a custom API endpoint managed by a plugin.
+
+    The 'data' object argument includes:
+        content_type                    - The content type to be set when writing back to the browser.
+        content                         - The content to print to the browser.
+        path                            - The path received after the '/unmanic/plugin_api' path.
+        arguments                       - A dictionary of GET arguments received.
+
+    :param data:
+    :return:
+    """
+    data_schema = {
+        "content_type": {
+            "required": True,
+            "type":     str,
+        },
+        "content":      {
+            "required": True,
+            "type":     dict,
+        },
+        "path":         {
+            "required": False,
+            "type":     str,
+        },
+        "arguments":    {
+            "required": False,
+            "type":     dict,
+        },
+    }
+    test_data = {
+        'content_type': 'application/json',
+        'content':      {},
+        'path':         "/webhook",
+        'arguments':    {'param': [b'true'], 'foo': [b'ba']},
+    }

unmanic/webserver/helpers/plugins.py

@@ -159,11 +159,40 @@ def get_enabled_plugin_data_panels():
     return plugin_handler.get_enabled_plugin_modules_by_type('frontend.panel')
 
 
-def exec_plugin_runner(data, plugin_id):
+def exec_data_panels_plugin_runner(data, plugin_id):
+    """
+    Exec a frontend.panel plugin runner
+
+    :param data:
+    :param plugin_id:
+    :return:
+    """
     plugin_handler = PluginsHandler()
     return plugin_handler.exec_plugin_runner(data, plugin_id, 'frontend.panel')
 
 
+def get_enabled_plugin_plugin_apis():
+    """
+    Returns a list of all enabled plugin APIs
+
+    :return:
+    """
+    plugin_handler = PluginsHandler()
+    return plugin_handler.get_enabled_plugin_modules_by_type('frontend.plugin_api')
+
+
+def exec_plugin_api_plugin_runner(data, plugin_id):
+    """
+    Exec a frontend.plugin_api plugin runner
+
+    :param data:
+    :param plugin_id:
+    :return:
+    """
+    plugin_handler = PluginsHandler()
+    return plugin_handler.exec_plugin_runner(data, plugin_id, 'frontend.plugin_api')
+
+
 def save_enabled_plugin_flows_for_plugin_type(plugin_type, library_id, plugin_flow):
     """
     Save a plugin flow given the plugin type and library ID
@@ -363,6 +392,7 @@ def prepare_plugin_info_and_settings(plugin_id, prefer_local=True, library_id=No
 
     return plugin_data
 
+
 def check_if_plugin_is_installed(plugin_id):
     """
     Returns true if the given plugin is installed
@@ -381,6 +411,7 @@ def check_if_plugin_is_installed(plugin_id):
 
     return plugin_installed
 
+
 def update_plugin_settings(plugin_id, settings, library_id=None):
     """
     Updates the settings for the requested plugin_id

unmanic/webserver/plugins.py

@@ -30,6 +30,8 @@
 
 """
 import os
+import sys
+import traceback
 
 import tornado.web
 import tornado.log
@@ -39,9 +41,15 @@
 
 def get_plugin_by_path(path):
     # Get the plugin ID from the url
-    plugin_id = path.split('/')[3]
-    # Fetch all frontend plugins
-    results = plugins.get_enabled_plugin_data_panels()
+    split_path = path.split('/')
+    plugin_type = split_path[2]
+    plugin_id = split_path[3]
+    if plugin_type == 'plugin_api':
+        # Fetch all api plugins
+        results = plugins.get_enabled_plugin_plugin_apis()
+    else:
+        # Fetch all frontend plugins
+        results = plugins.get_enabled_plugin_data_panels()
     # Check if their path matches
     plugin_module = None
     for result in results:
@@ -75,7 +83,7 @@ def handle_panel_request(self):
             'path':         "/" + "/".join(path),
             'uri':          self.request.uri,
             'query':        self.request.query,
-            'arguments':    self.request.arguments
+            'arguments':    self.request.arguments,
         }
         plugin_module = get_plugin_by_path(self.request.path)
         if not plugin_module:
@@ -84,10 +92,9 @@ def handle_panel_request(self):
             return
 
         # Run plugin and fetch return data
-        if not plugins.exec_plugin_runner(data, plugin_module.get('plugin_id')):
+        if not plugins.exec_data_panels_plugin_runner(data, plugin_module.get('plugin_id')):
             tornado.log.app_log.exception(
-                "Exception while carrying out plugin runner on postprocessor task result '{}'".format(
-                    plugin_module.get('plugin_id')))
+                "Exception while carrying out plugin runner on DataPanel '{}'".format(plugin_module.get('plugin_id')))
 
         self.render_data(data)
         return
@@ -97,6 +104,68 @@ def render_data(self, data):
         self.write(data.get('content'))
 
 
+class PluginAPIRequestHandler(tornado.web.RequestHandler):
+    name = None
+
+    def initialize(self):
+        self.name = 'PluginAPI'
+
+    def get(self, path):
+        self.handle_panel_request()
+
+    def post(self, path):
+        self.handle_panel_request()
+
+    def handle_panel_request(self):
+        path = list(filter(None, self.request.path.split('/')[4:]))
+
+        # Generate default data
+        data = {
+            'content_type': 'application/json',
+            'content':      {},
+            'path':         "/" + "/".join(path),
+            'uri':          self.request.uri,
+            'query':        self.request.query,
+            'arguments':    self.request.arguments,
+            'body':         self.request.body,
+        }
+        plugin_module = get_plugin_by_path(self.request.path)
+        if not plugin_module:
+            self.set_status(404, reason="404 Not Found")
+            status_code = self.get_status()
+            self.write({
+                'error':    "%(code)d: %(message)s" % {"code": status_code, "message": self._reason},
+                'messages': {},
+            })
+            return
+
+        # Run plugin and fetch return data
+        try:
+            if not plugins.exec_plugin_api_plugin_runner(data, plugin_module.get('plugin_id')):
+                tornado.log.app_log.exception(
+                    "Exception while carrying out plugin runner on PluginAPI '{}'".format(plugin_module.get('plugin_id')))
+        except Exception as e:
+            self.set_status(500, reason="Error running plugin API: {}".format(str(e)))
+            status_code = self.get_status()
+            exc_info = sys.exc_info()
+            traceback_lines = []
+            if exc_info and exc_info[0]:
+                for line in traceback.format_exception(*exc_info):
+                    traceback_lines.append(line)
+            self.write({
+                'error':     "%(code)d: %(message)s" % {"code": status_code, "message": self._reason},
+                'messages':  {},
+                'traceback': traceback_lines
+            })
+            return
+
+        self.render_data(data)
+
+    def render_data(self, data):
+        self.set_header("Content-Type", data.get('content_type', 'application/json'))
+        self.write(data.get('content'))
+
+
 class PluginStaticFileHandler(tornado.web.StaticFileHandler):
     """
     A static file handler which serves static content from a plugin '/static/' directory.