xref: /plugin/approve/action/approve.php (revision 3c40d78b32f4ff5a3e229d58909dd2ad72cb88be)

<?php

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

class action_plugin_approve_approve extends ActionPlugin {
    /**
     * @inheritDoc
     */
    public function register(EventHandler $controller) {
        $controller->register_hook('TPL_ACT_RENDER', 'AFTER', $this, 'handle_diff_accept');
        $controller->register_hook('HTML_SHOWREV_OUTPUT', 'BEFORE', $this, 'handle_showrev');
        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_approve');
        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_mark_ready_for_approval');
        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_viewer');
        $controller->register_hook('TPL_ACT_RENDER', 'BEFORE', $this, 'handle_display_banner');
        $controller->register_hook('COMMON_WIKIPAGE_SAVE', 'AFTER', $this, 'handle_pagesave_after');
    }

    /**
     * @param Event $event
     */
    public function handle_diff_accept(Event $event) {
        global $INFO;

        /** @var helper_plugin_approve_acl $acl */
        $acl = $this->loadHelper('approve_acl');

        if (!$acl->useApproveHere($INFO['id'])) return;

        if ($event->data == 'diff' && isset($_GET['approve'])) {
            $href = wl($INFO['id'], ['approve' => 'approve']);
            echo '<a href="' . $href . '">'.$this->getLang('approve').'</a>';
        }

        if ($this->getConf('ready_for_approval') && $event->data == 'diff' && isset($_GET['ready_for_approval'])) {
            $href = wl($INFO['id'], ['ready_for_approval' => 'ready_for_approval']);
            echo '<a href="' . $href . '">'.$this->getLang('approve_ready').'</a>';
        }
    }

    /**
     * @param Event $event
     */
    public function handle_showrev(Event $event) {
        global $INFO;

        /** @var helper_plugin_approve_db $db */
        $db = $this->loadHelper('approve_db');
        /** @var helper_plugin_approve_acl $acl */
        $acl = $this->loadHelper('approve_acl');

        if (!$acl->useApproveHere($INFO['id'])) return;

        $last_approved_rev = $db->getLastDbRev($INFO['id'], 'approved');
        if ($last_approved_rev == $INFO['rev']) {
            $event->preventDefault();
        }
    }

    /**
     * @param Event $event
     */
    public function handle_approve(Event $event) {
        global $INFO;

        /** @var helper_plugin_approve_acl $acl */
        $acl = $this->loadHelper('approve_acl');

        if ($event->data != 'show') return;
        if (!isset($_GET['approve'])) return;
        if (!$acl->useApproveHere($INFO['id'])) return;
        if (!$acl->clientCanApprove($INFO['id'])) return;

        /** @var helper_plugin_approve_db $db */
        $db = $this->loadHelper('approve_db');
        $db->setApprovedStatus($INFO['id']);

        header('Location: ' . wl($INFO['id']));
    }

    /**
     * @param Event $event
     */
    public function handle_mark_ready_for_approval(Event $event) {
        global $INFO;

        /** @var helper_plugin_approve_acl $acl */
        $acl = $this->loadHelper('approve_acl');

        if ($event->data != 'show') return;
        if (!isset($_GET['ready_for_approval'])) return;
        if (!$acl->useApproveHere($INFO['id'])) return;
        if (!$acl->clientCanMarkReadyForApproval($INFO['id'])) return;

        /** @var helper_plugin_approve_db $db */
        $db = $this->loadHelper('approve_db');
        $db->setReadyForApprovalStatus($INFO['id']);

        header('Location: ' . wl($INFO['id']));
    }

    /**
     * Redirect to latest approved page for user that don't have EDIT permission.
     *
     * @param Event $event
     */
    public function handle_viewer(Event $event) {
        global $INFO;

        /** @var helper_plugin_approve_acl $acl */
        $acl = $this->loadHelper('approve_acl');

        if ($event->data != 'show') return;
        //apply only to current page
        if ($INFO['rev'] != 0) return;
        if (!$acl->useApproveHere($INFO['id'])) return;
        if ($acl->clientCanSeeDrafts($INFO['id'])) return;

        /** @var helper_plugin_approve_db $db */
        $db = $this->loadHelper('approve_db');
        $last_approved_rev = $db->getLastDbRev($INFO['id'], 'approved');

        //no page is approved
        if (!$last_approved_rev) return;

        $last_change_date = @filemtime(wikiFN($INFO['id']));
        // current page is approved
        if ($last_approved_rev == $last_change_date) return;

        header("Location: " . wl($INFO['id'], ['rev' => $last_approved_rev], false, '&'));
    }

    /**
     * @param Event $event
     */
    public function handle_display_banner(Event $event) {
        global $INFO;

        if ($event->data != 'show' || !$INFO['exists']) return;

        /* Return true if banner should not be displayed for users with or below read only permission. */
        if (auth_quickaclcheck($INFO['id']) <= AUTH_READ && !$this->getConf('display_banner_for_readonly')) {
            return;
        }

        /** @var helper_plugin_approve_acl $acl */
        $acl = $this->loadHelper('approve_acl');
        if (!$acl->useApproveHere($INFO['id'])) return;

        $last_change_date = @filemtime(wikiFN($INFO['id']));
        $rev = !$INFO['rev'] ? $last_change_date : $INFO['rev'];


        /** @var helper_plugin_approve_db $db */
        $db = $this->loadHelper('approve_db');

        $page_revision = $db->getPageRevision($INFO['id'], $rev);
        $last_approved_rev = $db->getLastDbRev($INFO['id'], 'approved');

        $classes = [];
        if ($page_revision['status'] == 'approved' && $rev == $last_approved_rev) {
            $classes[] = 'plugin__approve_approved';
        } elseif ($page_revision['status'] == 'approved') {
            $classes[] = 'plugin__approve_old_approved';
        } elseif ($this->getConf('ready_for_approval') && $page_revision['status'] == 'ready_for_approval') {
            $classes[] = 'plugin__approve_ready';
        } else {
            $classes[] = 'plugin__approve_draft';
        }

        echo '<div id="plugin__approve" class="' . implode(' ', $classes) . '">';


        if ($page_revision['status'] == 'approved') {
            echo '<strong>'.$this->getLang('approved').'</strong>';
            echo ' ' . dformat(strtotime($page_revision['approved']));

            if($this->getConf('banner_long')) {
                echo ' ' . $this->getLang('by') . ' ' . userlink($page_revision['approved_by'], true);
                echo ' (' . $this->getLang('version') .  ': ' . $page_revision['version'] . ')';
            }

            //not the newest page
            if ($rev != $last_change_date) {
                // we can see drafts
                if ($acl->clientCanSeeDrafts($INFO['id'])) {
                    echo ' <a href="' . wl($INFO['id']) . '">';
                    echo $this->getLang($last_approved_rev == $last_change_date ? 'newest_approved' : 'newest_draft');
                    echo '</a>';
                    // we cannot see link to draft but there is some newer approved version
                } elseif ($last_approved_rev != $rev) {
                    $urlParameters = [];
                    if ($last_approved_rev != $last_change_date) {
                        $urlParameters['rev'] = $last_approved_rev;
                    }
                    echo ' <a href="' . wl($INFO['id'], $urlParameters) . '">';
                    echo $this->getLang('newest_approved');
                    echo '</a>';
                }
            }

        } else {
            if ($this->getConf('ready_for_approval') && $page_revision['status'] == 'ready_for_approval') {
                echo '<strong>'.$this->getLang('marked_approve_ready').'</strong>';
                echo ' ' . dformat(strtotime($page_revision['ready_for_approval']));
                echo ' ' . $this->getLang('by') . ' ' . userlink($page_revision['ready_for_approval_by'], true);
            } else {
                echo '<strong>'.$this->getLang('draft').'</strong>';
            }

            // not exists approve for current page
            if ($last_approved_rev == null) {
                // not the newest page
                if ($rev != $last_change_date) {
                    echo ' <a href="'.wl($INFO['id']).'">';
                    echo $this->getLang('newest_draft');
                    echo '</a>';
                }
            } else {
                $urlParameters = [];
                if ($last_approved_rev != $last_change_date) {
                    $urlParameters['rev'] = $last_approved_rev;
                }
                echo ' <a href="' . wl($INFO['id'], $urlParameters) . '">';
                echo $this->getLang('newest_approved');
                echo '</a>';
            }

            //we are in current page
            if ($rev == $last_change_date) {
                if ($this->getConf('ready_for_approval') &&
                    $acl->clientCanMarkReadyForApproval($INFO['id']) &&
                    $page_revision['status'] != 'ready_for_approval') {

                    $urlParameters = [
                        'rev' => $last_approved_rev,
                        'do' => 'diff',
                        'ready_for_approval' => 'ready_for_approval'
                    ];
                    echo ' | <a href="'.wl($INFO['id'], $urlParameters).'">';
                    echo $this->getLang('approve_ready');
                    echo '</a>';
                }

                if ($acl->clientCanApprove($INFO['id'])) {
                    $urlParameters = [
                        'rev' => $last_approved_rev,
                        'do' => 'diff',
                        'approve' => 'approve'
                    ];
                    echo ' | <a href="'.wl($INFO['id'], $urlParameters).'">';
                    echo $this->getLang('approve');
                    echo '</a>';
                }
            }
        }

        if (isset($page_metadata['approver']) & $this->getConf('banner_long')) {
            echo ' | ' . $this->getLang('approver') . ': ' . userlink($page_metadata['approver'], true);
        }

        echo '</div>';
    }

    /**
     *
     * @param Event $event
     */
    public function handle_pagesave_after(Event $event) {
        //no content was changed
        if (!$event->data['contentChanged']) return;

        /** @var helper_plugin_approve_db $db */
        $db = $this->loadHelper('approve_db');

        $id = $event->data['id'];
        switch ($event->data['changeType']) {
            case DOKU_CHANGE_TYPE_CREATE:
            case DOKU_CHANGE_TYPE_EDIT:
            case DOKU_CHANGE_TYPE_MINOR_EDIT:
            case DOKU_CHANGE_TYPE_REVERT:
                $db->handlePageEdit($id);
                break;
            case DOKU_CHANGE_TYPE_DELETE:
                $db->handlePageDelete($id);
                break;
        }
    }
}