xref: /plugin/farmer/action/ajax.php (revision f64a85f7ef8593a387609801c962a904fe407d36)

<?php

use dokuwiki\Extension\ActionPlugin;
use dokuwiki\Extension\EventHandler;
use dokuwiki\Extension\Event;

/**
 * DokuWiki Plugin farmer (Action Component)
 *
 * Manage AJAX features
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Michael Große <grosse@cosmocode.de>
 * @author  Andreas Gohr <gohr@cosmocode.de>
 */
class action_plugin_farmer_ajax extends ActionPlugin
{
    /**
     * plugin should use this method to register its handlers with the DokuWiki's event controller
     *
     * @param EventHandler $controller DokuWiki's event controller object. Also available as global $EVENT_HANDLER
     */
    public function register(EventHandler $controller)
    {
        $controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'handleAjaxCall');
    }

    /**
     * handle ajax requests
     *
     * @param Event $event
     * @param $param
     */
    public function handleAjaxCall(Event $event, $param)
    {
        if (!str_starts_with($event->data, 'plugin_farmer')) {
            return;
        }
        //no other ajax call handlers needed
        $event->stopPropagation();
        $event->preventDefault();

        if (!auth_isadmin()) die('Only admins allowed');

        if (substr($event->data, 14) === 'getPluginMatrix') {
            $this->printPluginMatrix($event, $param);
            return;
        }
        if (substr($event->data, 14) === 'modPlugin') {
            $this->togglePluginState($event, $param);
            return;
        }
        if (substr($event->data, 14, 10) === 'getPlugins') {
            $this->printAnimalPlugins($event, $param);
            return;
        }
        if (substr($event->data, 14, 10) === 'checkSetup') {
            $this->checkSetup($event, $param);
        }
    }

    /**
     * Always return an empty response
     *
     * This function exists in order to provide a positive (i.e. 200) response
     * to an ajax request to a non-existing animal.
     *
     * @param Event $event
     * @param $param
     */
    public function checkSetup(Event $event, $param)
    {
        $data = '';
        header('Content-Type: application/json');
        json_encode($data);
    }

    /**
     * Turn a plugin on or off
     *
     * @param Event $event
     * @param $param
     */
    public function togglePluginState(Event $event, $param)
    {
        global $INPUT;

        /** @var helper_plugin_farmer $helper */
        $helper = plugin_load('helper', 'farmer');

        $pname = $INPUT->str('plugin');
        $animal = $INPUT->str('ani');


        $plugins = $helper->getAnimalPluginRealState($animal);
        if (!isset($plugins[$pname])) die('no such plugin');
        $plugin = $plugins[$pname];

        // figure out what to toggle to
        if ($plugin['isdefault']) {
            $new = (int) !$plugin['actual'];
        } else {
            $new = -1;
        }
        $helper->setPluginState($pname, $animal, $new);

        // show new state
        $plugins = $helper->getAnimalPluginRealState($animal);
        $plugin = $plugins[$pname];
        header('Content-Type: text/html; charset=utf-8');
        echo $this->createPluginMatrixCell($plugin, $animal);
    }

    /**
     * Create a matrix of all animals and plugin states
     *
     * @param Event $event
     * @param $param
     */
    public function printPluginMatrix(Event $event, $param)
    {
        /** @var helper_plugin_farmer $helper */
        $helper = plugin_load('helper', 'farmer');

        $animals = $helper->getAllAnimals();
        $plugins = $helper->getAnimalPluginRealState($animals[0]);

        header('Content-Type: text/html; charset=utf-8');

        echo '<div class="table pluginmatrix">';
        echo '<table>';
        echo '<thead>';
        echo '<tr>';
        echo '<th></th>';
        foreach ($plugins as $plugin) {
            echo '<th><div>' . hsc($plugin['name']) . '</div></th>';
        }
        echo '</tr>';
        echo '</thead>';

        echo '<tbody>';

        echo '<tr>';
        echo '<th>Default</th>';
        foreach ($plugins as $plugin) {
            echo $this->createPluginMatrixCell($plugin, $this->getLang('plugin_default'), true);
        }
        echo '</tr>';

        foreach ($animals as $animal) {
            $plugins = $helper->getAnimalPluginRealState($animal);
            echo '<tr>';
            echo '<th>' . hsc($animal) . '</th>';
            foreach ($plugins as $plugin) {
                echo $this->createPluginMatrixCell($plugin, $animal);
            }
            echo '</tr>';
        }
        echo '</tbody>';
        echo '</table>';
        echo '</div>';
    }

    /**
     * create a single cell in the matrix
     *
     * @param array $plugin
     * @param string $animal
     * @param bool $defaults show the defaults
     * @return string
     */
    protected function createPluginMatrixCell($plugin, $animal, $defaults = false)
    {
        if ($defaults) {
            $current = $plugin['default'];
            $isdefault = true;
            $td = 'th';
        } else {
            $current = $plugin['actual'];
            $isdefault = $plugin['isdefault'];
            $td = 'td';
        }

        if ($current) {
            $class = 'on';
            $lbl = '✓';
        } else {
            $class = 'off';
            $lbl = '✗';
        }
        if ($isdefault) $class .= ' default';


        $attrs = [
            'class' => $class,
            'title' => $animal . ': ' . $plugin['name'],
            'data-animal' => $animal,
            'data-plugin' => $plugin['name']
        ];
        $attr = buildAttributes($attrs);

        return "<$td $attr>$lbl</$td>";
    }

    /**
     * Create an overview on all plugins for a given animal
     *
     * @param Event $event
     * @param $param
     */
    public function printAnimalPlugins(Event $event, $param)
    {
        $animal = substr($event->data, 25);
        /** @var helper_plugin_farmer $helper */
        $helper = plugin_load('helper', 'farmer');

        $plugins = $helper->getAnimalPluginRealState($animal);

        header('Content-Type: text/html; charset=utf-8');

        echo '<table>';
        echo '<tr>';
        echo '<th>' . $this->getLang('plugin') . '</th>';
        echo '<th>' . $this->getLang('plugin_default') . '</th>';
        echo '<th>' . $this->getLang('plugin_enabled') . '</th>';
        echo '<th>' . $this->getLang('plugin_disabled') . '</th>';
        echo '</tr>';

        foreach ($plugins as $plugin) {
            echo '<tr>';
            echo '<th>' . hsc($plugin['name']) . '</th>';

            echo '<td>';
            $attr = [];
            $attr['type'] = 'radio';
            $attr['name'] = 'bulk_plugins[' . $plugin['name'] . ']';
            $attr['value'] = '-1';
            if ($plugin['isdefault']) {
                $attr['checked'] = 'checked';
            }
            echo '<label>';
            echo '<input ' . buildAttributes($attr) . ' />';
            if ($plugin['default']) {
                echo ' (' . $this->getLang('plugin_on') . ')';
            } else {
                echo ' (' . $this->getLang('plugin_off') . ')';
            }
            echo '</label>';
            echo '</td>';

            echo '<td>';
            $attr = [];
            $attr['type'] = 'radio';
            $attr['name'] = 'bulk_plugins[' . $plugin['name'] . ']';
            $attr['value'] = '1';
            if (!$plugin['isdefault'] && $plugin['actual']) {
                $attr['checked'] = 'checked';
            }
            echo '<label>';
            echo '<input ' . buildAttributes($attr) . ' />';
            echo ' ' . $this->getLang('plugin_on');
            echo '</label>';
            echo '</td>';

            echo '<td>';
            $attr = [];
            $attr['type'] = 'radio';
            $attr['name'] = 'bulk_plugins[' . $plugin['name'] . ']';
            $attr['value'] = '0';
            if (!$plugin['isdefault'] && !$plugin['actual']) {
                $attr['checked'] = 'checked';
            }
            echo '<label>';
            echo '<input ' . buildAttributes($attr) . ' />';
            echo ' ' . $this->getLang('plugin_off');
            echo '</label>';
            echo '</td>';

            echo '</tr>';
        }
    }
}