plugins.php

<?php
/**
 * Common Utilities Famework for Xoops
 *
 * Copyright © 2015 Eduardo Cortés http://www.redmexico.com.mx
 * -------------------------------------------------------------
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * -------------------------------------------------------------
 * @copyright    Eduardo Cortés (http://www.redmexico.com.mx)
 * @license      GNU GPL 2
 * @package      rmcommon
 * @author       Eduardo Cortés (AKA bitcero)    <i.bitcero@gmail.com>
 * @url          http://www.redmexico.com.mx
 * @url          http://www.eduardocortes.mx
 */
require_once dirname(__DIR__) . '/../include/cp_header.php';

$p = isset($_REQUEST['p']) ? $_REQUEST['p'] : '';
if ('' == $p) {
    $common->location = 'plugins';
} else {
    $common->location = $p . '-main';
}

require_once XOOPS_ROOT_PATH . '/modules/rmcommon/admin-loader.php';

function rm_reload_plugins()
{
    $path = RMCPATH . '/plugins';
    $dir_list = XoopsLists::getDirListAsArray($path);

    $installed_plugins = [];

    foreach ($dir_list as $dir) {
        $oldFile = $path . '/' . $dir . '/' . mb_strtolower($dir) . '-plugin.php';
        $newFile = $path . '/' . $dir . '/' . mb_strtolower($dir) . '.php';

        if (!file_exists($oldFile) && !file_exists($newFile)) {
            continue;
        }

        $phand = new RMPlugin($dir); // PLugin handler

        if (!$phand->isNew() && $phand->getVar('status')) {
            $installed_plugins[] = $phand;
        }
    }

    $plugins = [];
    foreach ($installed_plugins as $p) {
        $plugins[] = $p->getVar('dir');
    }

    file_put_contents(XOOPS_CACHE_PATH . '/plgs.cnf', json_encode($plugins));
}

function show_rm_plugins()
{
    global $rmTpl;

    $path = RMCPATH . '/plugins';
    $dir_list = XoopsLists::getDirListAsArray($path);

    $available_plugins = [];
    $installed_plugins = [];

    foreach ($dir_list as $dir) {
        $oldFile = $path . '/' . $dir . '/' . mb_strtolower($dir) . '-plugin.php';
        $newFile = $path . '/' . $dir . '/' . mb_strtolower($dir) . '.php';

        if (!file_exists($oldFile) && !file_exists($newFile)) {
            continue;
        }

        $phand = new RMPlugin($dir); // PLugin handler

        if ($phand->isNew()) {
            $phand->setVar('dir', $dir);
            $available_plugins[] = $phand;
        } else {
            $installed_plugins[] = $phand;
        }
    }

    rm_reload_plugins();

    RMBreadCrumb::get()->add_crumb(__('Plugins Manager', 'rmcommon'));

    $rmTpl->assign('xoops_pagetitle', __('Plugins Manager', 'rmcommon'));

    //RMFunctions::create_toolbar();
    xoops_cp_header();

    include RMTemplate::getInstance()->path('rmc-plugins.php', 'module', 'rmcommon');

    xoops_cp_footer();
}

/**
 * This function install a plugin and all their functionallity
 */
function install_rm_plugin()
{
    $name = rmc_server_var($_GET, 'plugin', '');
    if ('' == $name) {
        redirectMsg('plugins.php', __('You must specify a existing plugin', 'rmcommon'), 1);
        die();
    }

    $plugin = new RMPlugin($name);

    if (!$plugin->isNew()) {
        redirectMsg('plugins.php', __('Specified plugin is installed already!', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->load_from_dir($name)) {
        redirectMsg('plugins.php', sprintf(__('%s is not a valid plugin!', 'rmcommon'), $name), 1);
        die();
    }

    if (!$plugin->save()) {
        redirectMsg('plugins.php', __('Plugin could not be installed, please try again.', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->on_install()) {
        redirectMsg('plugins.php', __('The plugin has been inserted on database, but erros ocurred on this process.', 'rmcommon') . '<br>' . $plugin->errors(), 1);
        die();
    }

    rm_reload_plugins();

    redirectMsg('plugins.php', __('Plugin installed succesfully!', 'rmcommon'), 0);
}

function uninstall_rm_plugin()
{
    $name = rmc_server_var($_GET, 'plugin', '');
    if ('' == $name) {
        redirectMsg('plugins.php', __('You must specify a existing plugin', 'rmcommon'), 1);
        die();
    }

    $plugin = new RMPlugin($name);

    if ($plugin->isNew()) {
        redirectMsg('plugins.php', __('Specified plugin is not installed yet!', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->delete()) {
        redirectMsg('plugins.php', __('Plugin could not be uninstalled, please try again.', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->on_uninstall()) {
        redirectMsg('plugins.php', __('The plugin has been deleted from database, but erros ocurred on this process.', 'rmcommon') . '<br>' . $plugin->errors(), 1);
        die();
    }

    rm_reload_plugins();

    redirectMsg('plugins.php', __('Plugin uninstalled succesfully!', 'rmcommon'), 0);
}

function update_rm_plugin()
{
    $name = rmc_server_var($_GET, 'plugin', '');
    if ('' == $name) {
        redirectMsg('plugins.php', __('You must specify a existing plugin', 'rmcommon'), 1);
        die();
    }

    $plugin = new RMPlugin($name);

    if ($plugin->isNew()) {
        redirectMsg('plugins.php', __('Specified plugin is not installed yet!', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->save()) {
        redirectMsg('plugins.php', __('Plugin could not be updated, please try again.', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->on_update()) {
        redirectMsg('plugins.php', __('The database has been updated, but erros ocurred on this process.', 'rmcommon') . '<br>' . $plugin->errors(), 1);
        die();
    }

    rm_reload_plugins();

    redirectMsg('plugins.php', __('Plugin updated succesfully!', 'rmcommon'), 0);
}

function activate_rm_plugin($q)
{
    $name = rmc_server_var($_GET, 'plugin', '');
    if ('' == $name) {
        redirectMsg('plugins.php', __('You must specify a existing plugin', 'rmcommon'), 1);
        die();
    }

    $plugin = new RMPlugin($name);

    if ($plugin->isNew()) {
        redirectMsg('plugins.php', __('Specified plugin is not installed yet!', 'rmcommon'), 1);
        die();
    }

    $plugin->setVar('status', $q);

    if (!$plugin->save()) {
        redirectMsg('plugins.php', __('Plugin could not be updated, please try again.', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->on_activate($q)) {
        redirectMsg('plugins.php', __('The database has been updated, but erros ocurred on this process.', 'rmcommon') . '<br>' . $plugin->errors(), 1);
        die();
    }

    rm_reload_plugins();

    redirectMsg('plugins.php', __('Plugin status changed succesfully!', 'rmcommon'), 0);
}

function configure_rm_plugin()
{
    global $rmTpl, $common;

    $name = rmc_server_var($_GET, 'plugin', '');
    if ('' == $name) {
        redirectMsg('plugins.php', __('You must specify a existing plugin', 'rmcommon'), 1);
        die();
    }

    $plugin = new RMPlugin($name);

    if ($plugin->isNew()) {
        redirectMsg('plugins.php', __('Specified plugin is not installed yet!', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->getVar('status')) {
        redirectMsg('plugins.php', __('Specified plugin is not active!', 'rmcommon'), 1);
        die();
    }

    $cuSettings = RMSettings::cu_settings();
    $settings = $common->settings()->plugin_settings($name, true);

    $form = new RMForm(sprintf(__('%s configuration', 'rmcommon'), $plugin->getVar('name')), 'frmconfig', 'plugins.php');
    $form->fieldClass = '';
    $form->addElement(new RMFormHidden('plugin', $plugin->getVar('dir')));
    $form->addElement(new RMFormHidden('action', 'savesettings'));

    foreach ($plugin->options() as $config => $option) {
        if (!array_key_exists('field', $option)) {
            $option['field'] = $option['fieldtype'];
        }

        if (isset($settings->{$config})) {
            $option['value'] = $settings->{$config};
        }

        if (isset($option['separator']) && !empty($option['separator'])) {
            $form->addElement(new RMFormSubTitle($option['separator']['title'], 1, '', $option['separator']['desc']));
            continue;
        }

        switch ($option['field']) {
            case 'checkbox_groups':
            case 'group_multi':
                $ele = new RMFormGroups($option['caption'], 'conf_' . $config, 1, 1, 3, [$option['value']]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'radio_groups':
                $ele = new RMFormGroups($option['caption'], 'conf_' . $config, 0, 1, 3, [$option['value']]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'group':
            case 'select_groups':
                $ele = new RMFormGroups($option['caption'], 'conf_' . $config, 0, 0, 3, [$option['value']]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'select_groups_multi':
                $ele = new RMFormGroups($option['caption'], 'conf_' . $config, 1, 0, 3, [$option['value']]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'editor':
                if ('tiny' == $cuSettings->editor_type) {
                    $tiny = TinyEditor::getInstance();
                    $tiny->add_config('elements', 'conf_' . $config);
                }
                $ele = new RMFormEditor($option['caption'], 'conf_' . $config, is_numeric($option['size']) ? '90%' : $option['size'], '300px', $option['value'], '', 1, ['op']);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'theme':
            case 'select_theme':
                $ele = new RMFormTheme($option['caption'], 'conf_' . $config, 0, 0, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'theme_multi':
            case 'select_theme_multi':
                $ele = new RMFormTheme($option['caption'], 'conf_' . $config, 0, 1, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'checkbox_theme':
                $ele = new RMFormTheme($option['caption'], 'conf_' . $config, 1, 1, $option['value'], 4);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'select_theme_admin':
                $ele = new RMFormTheme($option['caption'], 'conf_' . $config, 0, 0, $option['value'], 3, 'GUI');
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'yesno':
                $ele = new RMFormYesNo([
                    'caption' => $option['caption'],
                    'name' => 'conf_' . $config,
                    'value' => $option['value'],
                    'description' => $option['desc'],
                ]);

                break;
            case 'select':
                $ele = new RMFormSelect($option['caption'], 'conf_' . $config, 0, [$option['value']]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                foreach ($option['options'] as $value => $caption) {
                    $ele->addOption($value, $caption, $value == $option['value'] ? 1 : 0);
                }

                break;
            case 'select_multi':
                $ele = new RMFormSelect($option['caption'], 'conf_' . $config . '[]', 1, $option['value']);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                foreach ($option['options'] as $op => $opvalue) {
                    $ele->addOption($opvalue, $op);
                }

                break;
            case 'language':
            case 'select_language':
                $ele = new RMFormLanguageField($option['caption'], 'conf_' . $config, 0, 0, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'select_language_multi':
                $ele = new RMFormLanguageField($option['caption'], 'conf_' . $config, 1, 0, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'checkbox_language':
                $ele = new RMFormLanguageField($option['caption'], 'conf_' . $config, 1, 1, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'startpage':
            case 'select_modules':
                $ele = new RMFormModules($option['caption'], 'conf_' . $config, 0, 0, $option['value'], 3);
                $ele->setInserted(['--' => __('None', 'rmcommon')]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'select_modules_multi':
                $ele = new RMFormModules($option['caption'], 'conf_' . $config, 1, 0, $option['value'], 3);
                $ele->setInserted(['--' => __('None', 'rmcommon')]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'checkbox_modules':
                $ele = new RMFormModules($option['caption'], 'conf_' . $config, 1, 1, $option['value'], 3);
                $ele->setInserted(['--' => __('None', 'rmcommon')]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'radio_modules':
                $ele = new RMFormModules($option['caption'], 'conf_' . $config, 0, 1, $option['value'], 3);
                $ele->setInserted(['--' => __('None', 'rmcommon')]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'timezone':
            case 'select_timezone':
                $ele = new RMFormTimeZoneField($option['caption'], 'conf_' . $config, 0, 0, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'select_timezone_multi':
                $ele = new RMFormTimeZoneField($option['caption'], 'conf_' . $config, 0, 1, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'checkbox_timezone':
                $ele = new RMFormTimeZoneField($option['caption'], 'conf_' . $config, 1, 1, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'radio_timezone':
                $ele = new RMFormTimeZoneField($option['caption'], 'conf_' . $config, 1, 0, $option['value'], 3);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'tplset':
                $ele = new RMFormSelect($option['caption'], 'conf_' . $config);
                $tplsetHandler = exm_gethandler('tplset');
                $tplsetlist = &$tplsetHandler->getList();
                asort($tplsetlist);
                foreach ($tplsetlist as $key => $name) {
                    $ele->addOption($key, $name, $option['value'] == $key ? 1 : 0);
                }

                break;
            case 'textarea':
                $ele = new RMFormTextArea($option['caption'], 'conf_' . $config, 5, $option['size'] > 0 ? $option['size'] : 50, 'array' == $option['valuetype'] ? TextCleaner::getInstance()->specialchars(implode('|', $option['value'])) : TextCleaner::getInstance()->specialchars($option['value']));
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'module_cache':
                $ele = new RMFormCacheModuleField($option['caption'], 'conf_' . $config, $option['value']);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'user_select':
                $ele = new RMFormUser($option['caption'], 'conf_' . $config, $form->getName(), $option['value'], 'select', $limit = '300', '');
                $ele->setOnPage("document.forms[0].op.value='config';");
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }

                break;
            case 'radio':
                $ele = new RMFormRadio([
                    'caption' => $option['caption'],
                    'name' => 'conf_' . $config,
                    'value' => $option['value'],
                    'description' => $option['desc'],
                ]);
                //$ele = new RMFormRadio($option['caption'], 'conf_' . $config, 1);
                //if ($option['desc'] != '') $ele->setDescription($option['desc']);

                foreach ($option['options'] as $op => $opvalue) {
                    $ele->addOption($op, $opvalue, $opvalue == $option['value'] ? 1 : 0);
                }

                break;
            case 'select_editor':
                $ele = new RMFormSelect($option['caption'], 'conf_' . $config, 0, [$option['value']]);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }
                $ele->addOption('tiny', __('Visual Editor', 'rmcommon'));
                $ele->addOption('markdown', __('Markdown Editor', 'rmcommon'));
                $ele->addOption('textarea', __('Simple Editor', 'rmcommon'));
                $ele->addOption('html', __('HTML Editor', 'rmcommon'));

                break;
            case 'email':
                $ele = new RMFormText([
                    'type' => 'email',
                    'caption' => $option['caption'],
                    'name' => 'conf_' . $config,
                    'value' => $option['value'],
                ]);
                break;
            case 'textbox':
            case 'password':
            default:
                $ele = new RMFormText($option['caption'], 'conf_' . $config, isset($option['size']) ? $option['size'] : 50, null, 'array' == $option['valuetype'] ? implode('|', $option['value']) : $option['value'], 'password' == $option['fieldtype'] ? 1 : 0);
                if ('' != $option['desc']) {
                    $ele->setDescription($option['desc']);
                }
                //$form->addElement($ele, false, $option['valuetype']=='int' || $option['valuetype']=='float' ? 'num' : '');
                break;
        }

        /**
         * New field types
         */
        $ele = RMEvents::get()->trigger('rmcommon.load.form.field', $ele, (object) $option);

        $controls = [
            'text',
            'textbox',
            'password',
            'email',
            'file',
            'select_editor',
            'font_select',
            'textarea',
            'tplset',
            'select_timezone',
            'select_timezone_multi',
            'select_modules',
            'select_modules_multi',
            'startpage',
            'select_language',
            'language',
            'select_language_multi',
            'select',
            'select_multi',
            'select_theme_admin',
            'select_theme_multi',
            'select_theme',
            'group',
            'select_group',
        ];

        if (in_array($option['fieldtype'], $controls, true)) {
            $ele->add('class', 'form-control');
        }

        $form->addElement($ele);
    }

    $ele = new RMFormButtonGroup();
    $ele->addButton(new RMFormButton([
        'caption' => __('Save Settings', 'rmcommon'),
        'type' => 'submit',
        'class' => 'btn btn-primary btn-lg',
        'name' => 'send',
    ]));
    $ele->addButton(new RMFormButton([
        'caption' => __('Cancel', 'rmcommon'),
        'type' => 'button',
        'onclick' => 'history.go(-1);',
        'class' => 'btn btn-default btn-lg',
    ]));

    $form->addElement($ele);

    // Other components can add items to database
    $form = RMEvents::get()->run_event('rmcommon.settings.form', $form, $plugin);

    //RMFunctions::create_toolbar();

    RMBreadCrumb::get()->add_crumb(__('Plugins Manager', 'rmcommon'), 'plugins.php');
    RMBreadCrumb::get()->add_crumb(__('Configure Plugin ', 'rmcommon'));

    $rmTpl->assign('xoops_pagetitle', __('Configure Plugin ', 'rmcommon'));

    xoops_cp_header();
    $form->display();
    xoops_cp_footer();
}

function save_settings_rm_plugin()
{
    global $xoopsSecurity;

    $name = rmc_server_var($_POST, 'plugin', '');
    if ('' == $name) {
        redirectMsg('plugins.php', __('You must specify a existing plugin', 'rmcommon'), 1);
        die();
    }

    $plugin = new RMPlugin($name);

    if ($plugin->isNew()) {
        redirectMsg('plugins.php', __('Specified plugin is not installed yet!', 'rmcommon'), 1);
        die();
    }

    if (!$plugin->getVar('status')) {
        redirectMsg('plugins.php', __('Specified plugin is not active!', 'rmcommon'), 1);
        die();
    }

    if (!$xoopsSecurity->check()) {
        redirectMsg('plugins.php?action=configure&plugin=' . $name, __('Session token expired!', 'rmcommon'), 1);
        die();
    }

    $options = $plugin->options();
    $db = XoopsDatabaseFactory::getDatabaseConnection();
    $confs = [];
    foreach ($options as $k => $option) {
        if (!isset($_POST['conf_' . $k])) {
            continue;
        }
        $value = $_POST['conf_' . $k];
        $option['value'] = is_array($value) ? serialize($value) : $value;

        $db->queryF('UPDATE ' . $db->prefix('mod_rmcommon_settings') . " SET value='$option[value]' WHERE element='$name' AND type='plugin' AND name='$k'");
    }

    $events = RMEvents::get();
    /**
     * Evnet params
     * 1: Options as array
     * 2: PLugin dir name
     * 3: Plugin object
     */
    $events->run_event('rmcommon.save.plugin.settings', $options, $plugin->getVar('dir'), $plugin);

    redirectMsg('plugins.php', __('Settings updated!', 'rmcommon'), 0);
}

/**
 * This function allows to plugins to show their own options
 * @param mixed $dir
 */
function main_rm_plugin($dir)
{
    $path = RMCPATH . '/plugins';

    $oldFile = $path . '/' . $dir . '/' . mb_strtolower($dir) . '-plugin.php';
    $newFile = $path . '/' . $dir . '/' . mb_strtolower($dir) . '.php';

    if (!file_exists($oldFile) && !file_exists($newFile)) {
        header('location: plugins.php');
        die();
    }

    $plugin = new RMPlugin($dir);
    if ($plugin->isNew()) {
        header('location: plugins.php');
        die();
    }

    if (!$plugin->get_info('hasmain')) {
        header('location: plugins.php');
        die();
    }

    $plugin = Common\Core\Helpers\Plugins::getInstance()->load($dir);

    if (!method_exists($plugin, 'main')) {
        header('location: plugins.php');
        die();
    }

    load_plugin_locale($dir);

    $plugin->main();
}

// Allow to plugins to take control over this section and show their own options
RMEvents::get()->run_event('rmcommon.plugins.check.actions');

/**
 * If plugin have a control panel then we need to detect when user is
 * requesting this.
 */
$dir = $common->httpRequest()->request('p', 'string', '');

if ('' != $dir) {
    main_rm_plugin($dir);
    die();
}

/**
 * Trigger action
 */
$action = $common->httpRequest()->request('action', 'string', '');

switch ($action) {
    case 'install':
        install_rm_plugin();
        break;
    case 'uninstall':
        uninstall_rm_plugin();
        break;
    case 'update':
        update_rm_plugin();
        break;
    case 'enable':
        activate_rm_plugin(1);
        break;
    case 'disable':
        activate_rm_plugin(0);
        break;
    case 'configure':
        configure_rm_plugin();
        break;
    case 'savesettings':
        save_settings_rm_plugin();
        break;
    default:
        show_rm_plugins();
        break;
}