xref: /plugin/acknowledge/action.php (revision 5773dd375a3cbf135e65b74d1b5793a79b587f9e)

<?php
/**
 * DokuWiki Plugin acknowledge (Action Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Andreas Gohr, Anna Dabrowska <dokuwiki@cosmocode.de>
 */

use dokuwiki\Form\Form;

class action_plugin_acknowledge extends DokuWiki_Action_Plugin
{

    /** @inheritDoc */
    public function register(Doku_Event_Handler $controller)
    {
        $controller->register_hook('COMMON_WIKIPAGE_SAVE', 'AFTER', $this, 'handlePageSave');
        $controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'handleAjax');
    }

    /**
     * Manage page meta data
     *
     * FIXME do we track ALL pages? or do we check for assignments?
     *
     * Store page last modified date
     * Handle page deletions
     * Remove assignments on page save, they get readded on rendering if needed
     *
     * @param Doku_Event $event
     * @param $param
     */
    public function handlePageSave(Doku_Event $event, $param)
    {
        /** @var helper_plugin_acknowledge $helper */
        $helper = plugin_load('helper', 'acknowledge');

        if ($event->data['changeType'] === DOKU_CHANGE_TYPE_DELETE) {
            $helper->removePage($event->data['id']);
        } elseif ($event->data['changeType'] !== DOKU_CHANGE_TYPE_MINOR_EDIT) {
            $helper->storePageDate($event->data['id'], $event->data['newRevision']);
        }

        $helper->clearAssignments($event->data['id']);
    }

    /**
     * @param Doku_Event $event
     * @param $param
     */
    public function handleAjax(Doku_Event $event, $param)
    {
        if ($event->data === 'plugin_acknowledge_assign') {
            echo $this->html();
            $event->stopPropagation();
            $event->preventDefault();
        }
    }

    /**
     * Returns the acknowledgment form/confirmation
     *
     * @return string The HTML to display
     */
    protected function html()
    {
        global $INPUT;
        global $USERINFO;
        $id = $INPUT->str('id');
        $ackSubmitted = $INPUT->str('ack') === 'true';
        $user = $INPUT->server->str('REMOTE_USER');
        if ($id === '' || $user === '') return '';

        /** @var helper_plugin_acknowledge $helper */
        $helper = plugin_load('helper', 'acknowledge');

        if ($ackSubmitted) {
            $helper->saveAcknowledgement($id, $user);
        }

        $html = '';

        $ack = $helper->hasUserAcknowledged($id, $user);
        if ($ack) {

            $html .= '<div>';
            $html .= $this->getLang('ackGranted') . sprintf('%s', dformat($ack));
            $html .= '</div>';
        } elseif ($helper->isUserAssigned($id, $user, $USERINFO['grps'])) {
            $form = new Form(['id' => 'ackForm']);
            $form->addCheckbox('ack');
            $form->addLabel($this->getLang('ackText'), 'ack');
            $form->addHTML('<button type="submit" name="acksubmit" id="ack-submit">Acknowledge</button>');

            // attach submit listener to the newly injected form
            $inlineScript = '<script>';
            $inlineScript .= '
                jQuery("#ackForm").submit(function(event) {
                    event.preventDefault();
                    var $form = jQuery( this ),
                        ack = $form.find( "input[name=\'ack\']" )[0];

                    jQuery(".plugin-acknowledge").load(
                        DOKU_BASE + "lib/exe/ajax.php",
                        {
                            call: "plugin_acknowledge_html",
                            id: JSINFO.id,
                            ack: ack.checked
                        }
                    );
                });
            ';
            $inlineScript .= '</script>';

            $html .= '<div>';
            $html .= $this->getLang('ackRequired') . ':<br>';
            $html .= $form->toHTML();
            $html .= $inlineScript;
            $html .= '</div>';
        }

        return $html;
    }
}