lib/plugins/plugin_manager/plugins_form_html.py

"""
MIT License

Copyright (C) 2023 ROCKY4546
https://github.com/rocky4546

This file is part of Cabernet

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.
"""

import logging

import lib.common.utils as utils
import lib.common.exceptions as exceptions

from lib.common.decorators import getrequest
from lib.common.decorators import postrequest
from lib.web.pages.templates import web_templates
from lib.db.db_plugins import DBPlugins
from lib.plugins.plugin_manager.plugin_manager import PluginManager

@getrequest.route('/api/pluginsform')
def get_plugins_form_html(_webserver, _namespace=None, _sort_col=None, _sort_dir=None, filter_dict=None):
    plugins_form = PluginsFormHTML(_webserver.config)

    _area = _webserver.query_data.get('area')
    _plugin = _webserver.query_data.get('plugin')
    _repo = _webserver.query_data.get('repo')
    
    if _area is None and _plugin is None and _repo is None:
        _webserver.do_mime_response(
            404, 'text/html', web_templates['htmlError']
            .format('404 - Badly formed request'))
    elif _area:
            try:
                form = plugins_form.get(_area)
                _webserver.do_mime_response(200, 'text/html', form)
            except exceptions.CabernetException as ex:
                _webserver.do_mime_response(
                    404, 'text/html', web_templates['htmlError']
                    .format('404 - Badly formed area request'))
    elif _plugin and _repo:
        try:
            form = plugins_form.get_plugin(_repo, _plugin)
            _webserver.do_mime_response(200, 'text/html', form)
        except exceptions.CabernetException as ex:
            _webserver.do_mime_response(
                404, 'text/html', web_templates['htmlError']
                .format('404 - Badly formed plugin request'))
    else:
        # case where plugin and repo are not provided together
        _webserver.do_mime_response(
            404, 'text/html', web_templates['htmlError']
            .format('404 - Badly formed plugin/repo request'))


@postrequest.route('/api/pluginsform')
def post_plugins_html(_webserver):
    action = _webserver.query_data.get('action')
    pluginid = _webserver.query_data.get('pluginId')
    repoid = _webserver.query_data.get('repoId')
    if action and pluginid and repoid:
        action = action[0]
        pluginid = pluginid[0]
        repoid = repoid[0]
        if action == "deletePlugin":
            pm = PluginManager(_webserver.plugins)
            results = pm.delete_plugin(repoid, pluginid, _webserver.sched_queue)
            _webserver.do_mime_response(200, 'text/html', 'STATUS: Deleting plugin: {}:{}<br> '.format(repoid, pluginid) + str(results))
        if action == "addInstance":
            pm = PluginManager(_webserver.plugins)
            results = pm.add_instance(repoid, pluginid, _webserver.sched_queue)
            _webserver.do_mime_response(200, 'text/html', 'STATUS: Adding Instance plugin: {}:{}<br> '.format(repoid, pluginid) + str(results))
        elif action == "installPlugin":
            pm = PluginManager(_webserver.plugins)
            results = pm.install_plugin(repoid, pluginid, _webserver.sched_queue)
            _webserver.do_mime_response(200, 'text/html', 'STATUS: Installing plugin: {}:{}<br> '.format(repoid, pluginid) + str(results))
        elif action == "upgradePlugin":
            pm = PluginManager(_webserver.plugins)
            results = pm.upgrade_plugin(repoid, pluginid, _webserver.sched_queue)
            _webserver.do_mime_response(200, 'text/html', 'STATUS: Installing plugin: {}:{}<br> '.format(repoid, pluginid) + str(results))
        else:
            _webserver.do_mime_response(200, 'text/html', "doing something else"+str(action[0]))
    else:
        _webserver.do_mime_response(
            404, 'text/html', web_templates['htmlError']
            .format('404 - Badly formed request'))


class PluginsFormHTML:

    def __init__(self, _config):
        self.logger = logging.getLogger(__name__)
        self.config = _config
        self.plugin_db = DBPlugins(self.config)
        self.active_tab_name = None
        self.num_of_plugins = 0
        self.plugin_data = None
        self.area = None

    def get(self, _area):
        self.area = _area
        return ''.join([self.header, self.body])

    def get_plugin(self, _repo_id, _plugin_id):
        plugin_defn = self.plugin_db.get_plugins(
                _installed=None,
                _repo_id=_repo_id,
                _plugin_id=_plugin_id)
        if not plugin_defn:
            self.logger.warning(
                'HTTP request: Unknown plugin: {}'
                .format(_plugin_id))
            raise exceptions.CabernetException(
                'Unknown Plugin: {}'
                .format(_plugin_id))
        plugin_defn = plugin_defn[0]
        return ''.join([self.get_plugin_header(plugin_defn), self.get_menu_section(plugin_defn), self.get_plugin_section(plugin_defn)])

    def get_menu_top_section(self, _plugin_defn):
        return ''.join([
            '<ul class="menuList">',
            '<li class="menuItem" style="display: flex;">',
            '<div style="position: relative; padding-left: 0.5em;">',
            '<img class="icon-size" src="/api/manifest?plugin=',
                _plugin_defn['name'], '&key=icon" alt="',
                _plugin_defn['name'],'">',
            '</div>',
            '<div style="position: relative; padding: 0.5em;display: flex; flex-direction: column; justify-content: center;">',
            _plugin_defn['name'],
            '</div>',

            '</li>',
            '</ul>'
            ])

    def get_menu_items(self, _plugin_defn):
        if not _plugin_defn['external']:
            menu_list=''
        elif _plugin_defn['version']['installed']:
            # delete and possible upgrade...
            menu_list = ''
            if _plugin_defn['version']['latest'] != _plugin_defn['version']['current']:
                menu_list = ''.join([
                    '<li class="menuItem">',
                    '<button type="submit" name="action" value="upgradePlugin" class="menuButton" ',
                    'title="Download and install latest version of plugin. Restart required">',
                    '<i class="md-icon" style="padding-right: 5px; font-size: 1.7em;">upgrade</i>',
                    'Upgrade Plugin',
                    '</button>',
                    '</li>'
                    ])
            menu_list += ''.join([
                '<li class="menuItem">',
                '<button type="submit" name="action" value="deletePlugin" class="menuButton" ',
                'title="Deletes the plugin folder and scheduled events">',
                '<i class="md-icon" style="padding-right: 5px; font-size: 1.7em;">delete</i>',
                'Delete Plugin',
                '</button>',
                '</li>'
                ])
        else:
            # install
            menu_list = ''.join([
            '<li class="menuItem">',
            '<button type="submit" name="action" value="installPlugin" class="menuButton" ',
            'title="Download and install latest version of plugin, updates handler and schedule events">',
            '<i class="md-icon" style="padding-right: 5px; font-size: 1.7em;">download</i>',
            'Install Plugin',
            '</button>',
            '</li>'
            ])
        return menu_list

    def get_menu_section(self, _plugin_defn):
        pluginid = _plugin_defn['id']
        repoid = _plugin_defn['repoid']

        return ''.join([
            '<div id="menuActionStatus"></div>',
            '<form action="/api/pluginsform" method="post">'
            '<input type="hidden" name="action" value="">',
            '<input type="hidden" name="pluginId" value="',
            pluginid, '">',
            '<input type="hidden" name="repoId" value="',
            repoid, '">',
            '<div id="pluginActions" class="menuCanvas listItemHide">',
            '<div class="menuPanel">',
            self.get_menu_top_section(_plugin_defn),
            '<ul class="menuList">',
            self.get_menu_items(_plugin_defn),
            '</ul>',
            '</div>',
            '</div></form>'])

    def get_plugin_header(self, _plugin_defn):
        instances = self.plugin_db.get_instances(_namespace=_plugin_defn['name'])
        if instances:
            # array of instance names
            instances = instances[_plugin_defn['name']]
        else:
            instances = None
        
        if not _plugin_defn['version'].get('latest'):
            _plugin_defn['version']['latest'] = None

        html = ''.join([
            '<div><div style="display: flex;"><div class="pluginIcon">',
            '<a href="#" onclick=\'display_plugins()\'>',
            '<div ><i class="md-icon">arrow_back</i></div></a></div>',
            '<div class="pluginSectionName">',
            str(_plugin_defn['name']), '</div></div>',

            '<div>', str(_plugin_defn['summary']), '</div>',

            '<div style="position: relative; padding-left: 0.5em;">',
            '<img class="image-size" src="/api/manifest?plugin=',
                _plugin_defn['name'], '&key=icon" alt="',
                _plugin_defn['name'],'">',
            '</div>',

            '<div>',
            str(_plugin_defn['description']),
            '</div>',
            '<div style="background: var(--docked-drawer-background);">'
        ])
        return html
    
    def get_plugin_section(self, _plugin_defn):
        pluginid = _plugin_defn['id']
        repoid = _plugin_defn['repoid']
        instances = self.plugin_db.get_instances(_namespace=_plugin_defn['name'])
        if instances:
            # array of instance names
            instances = instances[_plugin_defn['name']]
        else:
            instances = None
        
        if not _plugin_defn['version'].get('latest'):
            _plugin_defn['version']['latest'] = None

        latest_version = _plugin_defn['version']['latest']
        upgrade_available = ''
        if latest_version != _plugin_defn['version']['current'] and _plugin_defn['external']:
            upgrade_available = ''.join([
            
                '<form action="/api/pluginsform" method="post">'
                '<input type="hidden" name="action" value="">',
                '<input type="hidden" name="pluginId" value="',
                pluginid, '">',
                '<input type="hidden" name="repoId" value="',
                repoid, '">',
                '<button class="menuIconButton" type="submit" name="action" value="upgradePlugin" style="margin-left:10px;">Upgrade to {}</button>' \
                .format(latest_version),
                '</form>'
                ])

        if _plugin_defn['version']['installed']:
            version_installed_div = ''.join([
                '<div class="pluginSection">',
                '<div class="pluginSectionName">Version Installed: </div>',
                '<div style="float:left; margin-top:3px;" class="pluginValue">',
                str(_plugin_defn['version']['current']), '</div>',
                upgrade_available,
                '</div>',
                ])
        else:
            version_installed_div = ''

        if _plugin_defn.get('changelog'):
            changelog_div = ''.join([
                '<div class="pluginSection">',
                '<div class="pluginSectionName">Change Log: </div>',
                '<div style="float:left; margin-top:3px;" class="pluginValue">',
                '<code>',
                str(_plugin_defn['changelog']), '</code></div>',
                '</div>',
                ])
        else:
            changelog_div = ''
            

        html = ''.join([
            '<button class="menuIconButton menuSection" type="button" onclick="show_menu(this, \'pluginActions\');">',
            '<i class="md-icon" STYLE="font-size: 1.5em;">menu</i>',
            '</button>',
            version_installed_div,
            '<div class="pluginSection">',
            '<div class="pluginSectionName">Latest Version: </div>',
            '<div class="pluginValue">',
            str(_plugin_defn['version']['latest']),
            '</div>',
            '</div>',

            changelog_div,

            '<div class="pluginSection">',
            '<div class="pluginSectionName">Dependencies: </div>',
            '<div class="pluginValue">',
            str(_plugin_defn['dependencies']), 
            '</div>',
            '</div>',

            '<div class="pluginSection">',
            '<div class="pluginSectionName">Source: </div>',
            '<div class="pluginValue">',
            str(_plugin_defn['source']),
            '</div>',
            '</div>',

            '<div class="pluginSection">',
            '<div class="pluginSectionName">License: </div>',
            '<div class="pluginValue">',
            str(_plugin_defn['license']),
            '</div>',
            '</div>',

            '<div class="pluginSection">',
            '<div class="pluginSectionName">Author: </div>',
            '<div class="pluginValue">',
            str(_plugin_defn['provider-name']),
            '</div>',
            '</div>',

            '<div class="pluginSection">',
            '<div class="pluginSectionName">Origin: </div>',
            '<div class="pluginValue">',
            'Cabernet Plugin Repository',
            '</div>',
            '</div>',

            '<div class="pluginSection">',
            '<div class="pluginSectionName">Category: </div>',
            '<div class="pluginValue">',
            str(_plugin_defn['category']),
            '</div>',
            '</div>',

            '<div class="pluginSection">',
            '<div class="pluginSectionName">Related Website: </div>',
            '<div class="pluginValue">',
            str(_plugin_defn['website']),
            '</div>',
            '</div>',

            '<div class="pluginSection">',
            '<div class="pluginSectionName">Instances: </div>',
            '<div class="pluginValue">',
            str(instances),
            '</div>',
            '</div>',

            '</div>',
            '</div>'
        ])
        return html

    def form_plugins(self, _is_installed):
        plugin_defns = self.plugin_db.get_plugins(
            _is_installed, None, None)

        if not plugin_defns:
            if self.area == 'My_Plugins':
                return ''.join([
                    'No plugins are installed.  Go to Catalog and select a plugin to install.'
                    ])
            elif self.area == 'Catalog':
                return ''.join([
                    'All available plugins are installed'
                    ])

        plugins_list = ''
        for plugin_defn in sorted(plugin_defns, key=lambda p: p['id']):
            repo_id = plugin_defn['repoid']
            plugin_id = plugin_defn['id']
            plugin_name = plugin_defn['name']

            img_size = self.lookup_config_size()

            latest_version = plugin_defn['version']['latest']
            upgrade_available = ''
            if _is_installed and plugin_defn['external']:
                if latest_version != plugin_defn['version']['current']:
                    upgrade_available = '<div class="bottom-left">Upgrade to {}</div>' \
                        .format(latest_version)
                current_version = plugin_defn['version']['current']
            elif not _is_installed:
                current_version = plugin_defn['version']['latest']
            else:
                current_version = 'Internal'

            plugins_list += ''.join([
                '<button class="plugin_item" type="button"',
                ' onclick=\'load_plugin_url("/api/pluginsform?',
                'plugin=', plugin_id, 
                '&repo=', repo_id,
                '")\'>',
                '<div>',
                '<div style="position: relative;">',
                '<img src="/api/manifest?plugin=',
                plugin_name, '&key=icon" width="', str(img_size), '" alt="',
                plugin_name,'">',
                upgrade_available,
                
                '</div><div>', plugin_name,
                '</div><div class="pluginText-secondary">',
                str(current_version), '</div></div>',
                '</button>'
                ])
        return plugins_list

    @property
    def header(self):
        return ''.join([
            '<html><head>',
            '</head>'
        ])

    @property
    def form(self):
        if self.area == 'My_Plugins':
            forms_html = ''.join([
                '<div class="plugin_list">',
                self.form_plugins(True), '</div>'])
        elif self.area == 'Catalog':
            forms_html = ''.join([
                'Plugins Available To Install:'
                '<div class="plugin_list">',
                self.form_plugins(_is_installed=False), 
                '</div>'])
        else:
            self.logger.warning('HTTP request: unknown area: {}'.format(self.area))
            raise exceptions.CabernetException('Unknown Tab: {}'.format(self.area))
        return forms_html

    @property
    def body(self):
        return ''.join([
            '<body>', self.form, '</body>'])

    def lookup_config_size(self):
        size_text = self.config['channels']['thumbnail_size']
        if size_text == 'None':
            return 0
        elif size_text == 'Tiny(16)':
            return 16
        elif size_text == 'Small(48)':
            return 48
        elif size_text == 'Medium(128)':
            return 128
        elif size_text == 'Large(180)':
            return 180
        elif size_text == 'X-Large(270)':
            return 270
        elif size_text == 'Full-Size':
            return None
        else:
            return None