Page.php

<?php
/**
 * Copyright 2003-2014 Horde LLC (http://www.horde.org/)
 *
 * See the enclosed file COPYING for license information (GPL). If you
 * did not receive this file, see http://www.horde.org/licenses/gpl.
 *
 * @category Horde
 * @license  http://www.horde.org/licenses/gpl GPL
 * @author   Tyler Colbert <tyler@colberts.us>
 * @package  Wicked
 */

/**
 * Abstract page class.
 *
 * @category Horde
 * @license  http://www.horde.org/licenses/gpl GPL
 * @author   Tyler Colbert <tyler@colberts.us>
 * @package  Wicked
 */
class Wicked_Page
{
    const MATCH_LEFT = 1;
    const MATCH_RIGHT = 2;
    const MATCH_ENDS = 3;
    const MATCH_ANY = 4;

    /**
     * Display modes supported by this page. Possible modes:
     *
     *   Wicked::MODE_CONTENT
     *   Wicked::MODE_DISPLAY
     *   Wicked::MODE_EDIT
     *   Wicked::MODE_REMOVE
     *   Wicked::MODE_HISTORY
     *   Wicked::MODE_DIFF
     *   Wicked::MODE_LOCKING
     *   Wicked::MODE_UNLOCKING
     *   Wicked::MODE_CREATE
     *
     * @var array
     */
    public $supportedModes = array();

    /**
     * Instance of a Text_Wiki processor.
     *
     * @var Text_Wiki
     */
    protected $_proc;

    /**
     * The loaded page info.
     *
     * @var array
     */
    protected $_page;

    /**
     * Is this a validly loaded page?
     *
     * @return boolean  True if we've loaded data, false otherwise.
     */
    public function isValid()
    {
        return !empty($this->_page);
    }

    /**
     * Retrieve this user's permissions for this page. If a
     * permissions object does not exist, we assume reasonable
     * defaults.
     *
     * @return integer  The permissions bitmask.
     */
    public function getPermissions($pageName = null)
    {
        global $wicked;

        if (is_null($pageName)) {
            $pageName = $this->pageName();
        }

        $pageId = $wicked->getPageId($pageName);
        $permName = 'wicked:pages:' . $pageId;
        $perms = $GLOBALS['injector']->getInstance('Horde_Perms');

        if ($pageId !== false && $perms->exists($permName)) {
            return $perms->getPermissions($permName, $GLOBALS['registry']->getAuth());
        } elseif ($perms->exists('wicked:pages')) {
            return $perms->getPermissions('wicked:pages', $GLOBALS['registry']->getAuth());
        } else {
            if (!$GLOBALS['registry']->getAuth()) {
                return Horde_Perms::SHOW | Horde_Perms::READ;
            } else {
                return Horde_Perms::SHOW | Horde_Perms::READ | Horde_Perms::EDIT | Horde_Perms::DELETE;
            }
        }
    }

    /**
     * Returns if the page allows a mode. Access rights and user state
     * are taken into consideration.
     *
     * @see $supportedModes
     *
     * @param integer $mode  The mode to check for.
     *
     * @return boolean  True if the mode is allowed.
     */
    public function allows($mode)
    {
        global $browser;

        $pagePerms = $this->getPermissions();

        switch ($mode) {
        case Wicked::MODE_CREATE:
            // Special mode for pages that don't exist yet - generic
            // to all pages.
            if ($browser->isRobot()) {
                return false;
            }

            if ($GLOBALS['registry']->isAdmin()) {
                return true;
            }

            $permName = 'wicked:pages';
            $perms = $GLOBALS['injector']->getInstance('Horde_Perms');

            if ($perms->exists($permName)) {
                return $perms->hasPermission($permName, $GLOBALS['registry']->getAuth(), Horde_Perms::EDIT);
            } else {
                return $GLOBALS['registry']->getAuth();
            }
            break;

        case Wicked::MODE_EDIT:
            if ($browser->isRobot()) {
                return false;
            }

            if ($GLOBALS['registry']->isAdmin()) {
                return true;
            }

            if (($pagePerms & Horde_Perms::EDIT) == 0) {
                return false;
            }
            break;

        case Wicked::MODE_REMOVE:
            if ($browser->isRobot()) {
                return false;
            }

            if ($GLOBALS['registry']->isAdmin()) {
                return true;
            }

            if (($pagePerms & Horde_Perms::DELETE) == 0) {
                return false;
            }
            break;

        // All other modes require READ permissions.
        default:
            if ($GLOBALS['registry']->isAdmin()) {
                return true;
            }

            if (($pagePerms & Horde_Perms::READ) == 0) {
                return false;
            }
            break;
        }

        return $this->supports($mode);
    }

    /**
     * See if the page supports a particular mode.
     * @see $supportedModes
     *
     * @param integer $mode      Which mode to check for
     *
     * @return boolean            True or false
     */
    public function supports($mode)
    {
        return !empty($this->supportedModes[$mode]);
    }

    /**
     * Returns the page we are currently on.
     *
     * @return Wicked_Page  The current page.
     * @throws Wicked_Exception
     */
    static public function getCurrentPage()
    {
        return Wicked_Page::getPage(rtrim(Horde_Util::getFormData('page'), '/'),
                                    Horde_Util::getFormData('version'),
                                    Horde_Util::getFormData('referrer'));
    }

    /**
     * Returns the requested page.
     *
     * @return Wicked_Page  The requested page.
     * @throws Wicked_Exception
     */
    static public function getPage($pagename, $pagever = null, $referrer = null)
    {
        global $conf, $notification, $wicked;

        if (empty($pagename)) {
            $pagename = 'Wiki/Home';
        }

        $classname = 'Wicked_Page_' . $pagename;
        if ($pagename == basename($pagename) && class_exists($classname)) {
            return new $classname($referrer);
        }

        /* If we have a version, but it is actually the most recent version,
         * ignore it. */
        if (!empty($pagever)) {
            $page = new Wicked_Page_StandardPage($pagename, false, null);
            if ($page->isValid() && $page->version() == $pagever) {
                return $page;
            }
            return new Wicked_Page_StandardHistoryPage($pagename, $pagever);
        }

        $page = new Wicked_Page_StandardPage($pagename);
        if ($page->isValid() || !$page->allows(Wicked::MODE_EDIT)) {
            return $page;
        }

        return new Wicked_Page_AddPage($pagename);
    }

    public function versionCreated()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    public function formatVersionCreated()
    {
        try {
            $v = $this->versionCreated();
            if ($v) {
                return strftime($GLOBALS['prefs']->getValue('date_format'), $v);
            }
        } catch (Wicked_Exception $e) {}
        return _("Never");
    }

    public function author()
    {
        if (isset($this->_page['change_author'])) {
            $modify = $this->_page['change_author'];
        } else {
            return _("Guest");
        }

        $identity = $GLOBALS['injector']->getInstance('Horde_Core_Factory_Identity')->create($modify);
        $name = $identity->getValue('fullname');
        if (!empty($name)) {
            $modify = $name;
        }

        return $modify;
    }

    public function hits()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    public function version()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    /**
     * Returns the previous version number for this page.
     *
     * @return string  A string containing the previous version or null if this
     *                 is the first version.
     * @throws Wicked_Exception
     */
    public function previousVersion()
    {
        global $wicked;

        $this->version();
        $history = $wicked->getHistory($this->pageName());

        if (count($history) == 0) {
            return null;
        }
        if ($this->isOld()) {
            for ($i = 0; $i < count($history); $i++) {
                if ($history[$i]['page_version'] == $this->version()) {
                    if ($i + 1 < count($history)) {
                        $i++;
                        break;
                    } else {
                        return null;
                    }
                }
            }

            if ($i == count($history)) {
                return null;
            }
        } else {
            $i = 0;
        }

        return $history[$i]['page_version'];
    }

    public function isOld()
    {
        return false;
    }

    /**
     * Renders this page in display mode.
     *
     * This must be overridden if the page is to be anything like a real page.
     *
     * @throws Wicked_Exception
     */
    public function display()
    {
        global $injector;

        // Get content first, it might throw an exception.
        $inner = $this->displayContents(false);

        $view = $injector->createInstance('Horde_View');
        $topbar = $injector->getInstance('Horde_View_Topbar');
        try {
            $view->version = $this->version();
            $diff_url = Horde::url('diff.php')
                ->add(array(
                    'page' => $this->pageName(),
                    'v1' => '?',
                    'v2' => $view->version
                ));

            $diff_alt = sprintf(_("Show changes for %s"), $view->version);
            $topbar->subinfo = $diff_url->link(array('title' => $diff_alt))
                . sprintf(_("Last Modified %s by %s"),
                          $this->formatVersionCreated(),
                          $this->author())
                . '</a>';
        } catch (Wicked_Exception $e) {
        }

        $view->name = $this->pageName();
        if ($this->referrer()) {
            $view->referrer = Wicked::url($this->referrer())->link()
                . htmlspecialchars($this->referrer()) . '</a>';
        }
        $view->isOld = $this->isOld();
        $view->refresh = $this->pageUrl()
            ->link(array('title' => _("Reload Page")))
            . Horde::img('reload.png', _("Reload Page")) . '</a>';
        if ($this->isLocked()) {
            $this->locked = Horde::img('locked.png', _("Locked"));
        }

        return $view->render('display/title') . $inner;
    }

    /**
     * Perform any pre-display checks for permissions, searches,
     * etc. Called before any output is sent so the page can do
     * redirects. If the page wants to take control of flow from here,
     * it can, and is entirely responsible for handling the user
     * (should call exit after redirecting, for example).
     *
     * $param integer $mode    The page render mode.
     * $param array   $params  Any page parameters.
     */
    public function preDisplay($mode, $params)
    {
    }

    /**
     * Renders this page for displaying in a block.
     *
     * This must be overridden if the page is to be anything like a real page.
     *
     * @return string  The content.
     * @throws Wicked_Exception
     */
    public function block()
    {
        return $this->displayContents(true);
    }

    public function displayContents($isBlock)
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    /**
     * Renders this page in remove mode.
     */
    public function remove()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    /**
     * Renders this page in history mode.
     */
    public function history()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    /**
     * Renders this page in diff mode.
     *
     * @param string $version  The version to diff this page against.
     */
    public function diff($version)
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    public function getProcessor($output_format = 'Xhtml')
    {
        if (isset($this->_proc)) {
            return $this->_proc;
        }

        $view_url = Wicked::url('%s')
            ->setRaw(true)
            ->add('referrer', $this->pageName());
        $view_url = str_replace(array(urlencode('%s'), urlencode('/')), array('%s', '%' . urlencode('/')), $view_url);

        /* Create format-specific Text_Wiki object */
        $class = 'Text_Wiki_' . $GLOBALS['conf']['wicked']['format'];
        $this->_proc = new $class();

        /* Use a non-printable delimiter character that is still a valid UTF-8
         * character. See http://pear.php.net/bugs/bug.php?id=12490. */
        $this->_proc->delim = chr(1);

        /* Override rules */
        $this->_proc->insertRule('Heading2', 'Heading');
        $this->_proc->deleteRule('Heading');
        $this->_proc->loadParseObj('Paragraph');
        $skip = $this->_proc->parseObj['Paragraph']->getConf('skip');
        $skip[] = 'heading2';
        $this->_proc->setParseConf('Paragraph', 'skip', $skip);

        if ($GLOBALS['conf']['wicked']['format'] == 'Default' ||
            $GLOBALS['conf']['wicked']['format'] == 'Cowiki' ||
            $GLOBALS['conf']['wicked']['format'] == 'Tiki') {
            $this->_proc->insertRule('Toc2', 'Toc');
        }
        $this->_proc->deleteRule('Toc');

        switch ($output_format) {
        case 'Xhtml':
            if ($GLOBALS['conf']['wicked']['format'] != 'Creole') {
                $this->_proc->insertRule('Code2', 'Code');
            }
            $this->_proc->deleteRule('Code');

            if ($GLOBALS['conf']['wicked']['format'] == 'BBCode') {
                $this->_proc->insertRule('Wickedblock', 'Code2');
            } else {
                $this->_proc->insertRule('Wikilink2', 'Wikilink');
                $this->_proc->setParseConf('Wikilink2', 'utf-8', true);

                $this->_proc->insertRule('Wickedblock', 'Raw');
            }
            $this->_proc->deleteRule('Wikilink');

            if ($GLOBALS['conf']['wicked']['format'] == 'Default' ||
                $GLOBALS['conf']['wicked']['format'] == 'Cowiki' ||
                $GLOBALS['conf']['wicked']['format'] == 'Tiki') {
                $this->_proc->insertRule('Freelink2', 'Freelink');
            }
            $this->_proc->deleteRule('Freelink');

            $this->_proc->insertRule('Image2', 'Image');
            $this->_proc->deleteRule('Image');
            $this->_proc->insertRule('RegistryLink', 'Wickedblock');
            $this->_proc->insertRule('Attribute', 'RegistryLink');

            $this->_proc->deleteRule('Include');
            $this->_proc->deleteRule('Embed');

            $this->_proc->setFormatConf('Xhtml', 'charset', 'UTF-8');
            $this->_proc->setFormatConf('Xhtml', 'translate', HTML_SPECIALCHARS);
            $create = $this->allows(Wicked::MODE_CREATE) ? 1 : 0;
            $linkConf = array(
                'pages' => $GLOBALS['wicked']->getPages(),
                'view_url' => $view_url,
                'new_url' => $create ? $view_url : false,
                'new_text_pos' => false,
                'css_new' => 'newpage',
                'ext_chars' => true,
            );

            $this->_proc->setRenderConf('Xhtml', 'Wikilink2', $linkConf);
            $this->_proc->setRenderConf('Xhtml', 'Freelink2', $linkConf);
            $this->_proc->setRenderConf('Xhtml', 'Toc2',
                                        array('title' => '<h2>' . _("Table of Contents") . '</h2>'));
            $this->_proc->setRenderConf('Xhtml', 'Table',
                                        array('css_table' => 'horde-table'));

            break;

        case 'Rst':
            require_once __DIR__ . '/Text_Wiki/Render/Rst.php';
            break;
        }

        $autoloader = $GLOBALS['injector']->getInstance('Horde_Autoloader');
        $autoloader->addClassPathMapper(
            new Horde_Autoloader_ClassPathMapper_Prefix(
                '/^Text_Wiki_Render_' . $output_format . '/',
                WICKED_BASE . '/lib/Text_Wiki/Render/' . $output_format
            )
        );
        $autoloader->addClassPathMapper(
            new Horde_Autoloader_ClassPathMapper_Prefix(
                '/^Text_Wiki_Parse/',
                WICKED_BASE . '/lib/Text_Wiki/Parse/' . $GLOBALS['conf']['wicked']['format']
            )
        );

        return $this->_proc;
    }

    public function render($mode, $params = null)
    {
        switch ($mode) {
        case Wicked::MODE_CONTENT:
            return $this->content($params);

        case Wicked::MODE_DISPLAY:
            return $this->display($params);

        case Wicked::MODE_BLOCK:
            return $this->block($params);

        case Wicked::MODE_REMOVE:
            return $this->remove();

        case Wicked::MODE_HISTORY:
            return $this->history();

        case Wicked::MODE_DIFF:
            return $this->diff($params);

        default:
            throw new Wicked_Exception(_("Unsupported"));
        }
    }

    /**
     * Returns an object with Horde_View properties.
     *
     * The returned object is supposed to be used with the _page.html.php
     * partial.
     *
     * @return object  A simple object.
     * @throws Wicked_Exception
     */
    public function toView()
    {
        return (object)array(
            'author' => $this->author(),
            'date' => $this->formatVersionCreated(),
            'name' => $this->pageUrl()
                ->link(array(
                    'title' => sprintf(_("Display %s"), $this->pageName())
                ))
                . htmlspecialchars($this->pageName()) . '</a>',
            'timestamp' => $this->versionCreated(),
            'version' => $this->pageUrl()
                ->link(array(
                    'title' => sprintf(_("Display Version %s"), $this->version())
                ))
                . $this->version() . '</a>',
        );
    }

    public function isLocked()
    {
        return false;
    }

    public function lock()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    public function unlock()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    public function updateText($newtext, $changelog)
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    public function getText()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

    public function pageName()
    {
        return null;
    }

    public function referrer()
    {
        return null;
    }

    public function pageUrl($linkpage = null, $actionId = null)
    {
        $params = array('page' => $this->pageName());
        if ($this->referrer()) {
            $params['referrer'] = $this->referrer();
        }
        if ($actionId) {
            $params['actionID'] = $actionId;
        }

        if (!$linkpage) {
            $url = Wicked::url($this->pageName());
            unset($params['page']);
        } else {
            $url = Horde::url($linkpage);
        }

        return $url->add($params);
    }

    public function pageTitle()
    {
        return $this->pageName();
    }

    public function handleAction()
    {
        throw new Wicked_Exception(_("Unsupported"));
    }

}