xref: /plugin/discussion/syntax/threads.php (revision c2a7577f624b66e7ed4371ffc84009e7f26aea7a)

<?php
/**
 * Discussion Plugin, threads component: displays a list of recently active discussions
 *
 * @license  GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author   Esther Brunner <wikidesign@gmail.com>
 */

// must be run within Dokuwiki
if(!defined('DOKU_INC')) die();

/**
 * Class syntax_plugin_discussion_threads
 */
class syntax_plugin_discussion_threads extends DokuWiki_Syntax_Plugin {

    /**
     * Syntax Type
     *
     * @return string
     */
    function getType() { return 'substition'; }

    /**
     * Paragraph Type
     *
     * @see Doku_Handler_Block
     * @return string
     */
    function getPType() { return 'block'; }

    /**
     * Sort for applying this mode
     *
     * @return int
     */
    function getSort() { return 306; }

    /**
     * @param string $mode
     */
    function connectTo($mode) {
        $this->Lexer->addSpecialPattern('\{\{threads>.+?\}\}', $mode, 'plugin_discussion_threads');
    }

    /**
     * Handler to prepare matched data for the rendering process
     *
     * @param   string       $match   The text matched by the patterns
     * @param   int          $state   The lexer state for the match
     * @param   int          $pos     The character position of the matched text
     * @param   Doku_Handler $handler The Doku_Handler object
     * @return  array Return an array with all data you want to use in render
     */
    function handle($match, $state, $pos, Doku_Handler $handler) {
        global $ID;
        $customFlags = array();

        $match = substr($match, 10, -2); // strip {{threads> from start and }} from end
        list($match, $flags) = explode('&', $match, 2);
        $flags = explode('&', $flags);

        // Identify the count/skipempty flag and remove it before passing it to pagelist
        foreach($flags as $key => $flag) {
            if (substr($flag, 0, 5) == "count") {
                $tmp = explode('=', $flag);
                $customFlags['count'] = $tmp[1];
                unset($flags[$key]);
            } elseif (substr($flag, 0, 9) == "skipempty") {
                $customFlags['skipempty'] = true;
                unset($flags[$key]);
            } elseif (substr($flag, 0, 15) == "nonewthreadform") {
                $customFlags['nonewthreadform'] = true;
                unset($flags[$key]);
            }
        }

        // Ignore params if invalid values have been passed
        if(!array_key_exists('count', $customFlags) || $customFlags['count'] <= 0 || !is_numeric($customFlags['count'])) $customFlags['count'] = false;
        if(!array_key_exists('skipempty', $customFlags) && !$customFlags['skipempty']) $customFlags['skipempty'] = false;

        list($ns, $refine) = explode(' ', $match, 2);

        if (($ns == '*') || ($ns == ':')) $ns = '';
        elseif ($ns == '.') $ns = getNS($ID);
        else $ns = cleanID($ns);

        return array($ns, $flags, $refine, $customFlags);
    }

    /**
     * Handles the actual output creation.
     *
     * @param   $mode   string        output format being rendered
     * @param   $renderer Doku_Renderer the current renderer object
     * @param   $data     array         data created by handler()
     * @return  boolean                 rendered correctly?
     */
    function render($mode, Doku_Renderer $renderer, $data) {
        list($ns, $flags, $refine, $customFlags) = $data;
        $count = $customFlags['count'];
        $skipEmpty = $customFlags['skipempty'];
        $noNewThreadForm = $customFlags['nonewthreadform'];
        $i = 0;

        $pages = array();
        /** @var helper_plugin_discussion $my */
        if ($my =& plugin_load('helper', 'discussion')) $pages = $my->getThreads($ns, null, $skipEmpty);

        // use tag refinements?
        if ($refine) {
            /** @var helper_plugin_tag $tag */
            if (plugin_isdisabled('tag') || (!$tag = plugin_load('helper', 'tag'))) {
                msg('The Tag Plugin must be installed to use tag refinements.', -1);
            } else {
                $pages = $tag->tagRefine($pages, $refine);
            }
        }

        if (!$pages) {
            if ((auth_quickaclcheck($ns.':*') >= AUTH_CREATE) && ($mode == 'xhtml')) {
                $renderer->info['cache'] = false;
                if ($noNewThreadForm !== true) {
                    $renderer->doc .= $this->_newThreadForm($ns);
                }
            }
            return true; // nothing to display
        }

        if ($mode == 'xhtml') {
            /** @var $renderer Doku_Renderer_xhtml */
            // prevent caching to ensure content is always fresh
            $renderer->info['cache'] = false;

            // show form to start a new discussion thread?
            if ($noNewThreadForm !== true) {
                $perm_create = (auth_quickaclcheck($ns.':*') >= AUTH_CREATE);
                if ($perm_create && ($this->getConf('threads_formposition') == 'top')) {
                    $renderer->doc .= $this->_newThreadForm($ns);
                }
            }

            // let Pagelist Plugin do the work for us
            /** @var $pagelist helper_plugin_pagelist */
            if (plugin_isdisabled('pagelist')
                    || (!$pagelist =& plugin_load('helper', 'pagelist'))) {
                msg('The Pagelist Plugin must be installed for threads lists to work.', -1);
                return false;
            }
            $pagelist->column['comments'] = true;
            $pagelist->setFlags($flags);
            $pagelist->startList();
            foreach ($pages as $page) {
                $page['class'] = 'discussion_status'.$page['status'];
                $pagelist->addPage($page);

                $i++;
                if($count != false && $i >= $count) break; // Only display the n discussion threads specified by the count flag
            }
            $renderer->doc .= $pagelist->finishList();

            // show form to start a new discussion thread?
            if ($noNewThreadForm !== true) {
                if ($perm_create && ($this->getConf('threads_formposition') == 'bottom')) {
                    $renderer->doc .= $this->_newThreadForm($ns);
                }
            }

            return true;

            // for metadata renderer
        } elseif ($mode == 'metadata') {
            /** @var $renderer Doku_Renderer_metadata */
            foreach ($pages as $page) {
                $renderer->meta['relation']['references'][$page['id']] = true;
            }

            return true;
        }
        return false;
    }

    /* ---------- (X)HTML Output Functions ---------- */

    /**
     * Show the form to start a new discussion thread
     *
     * @param string $ns
     * @return string
     */
    function _newThreadForm($ns) {
        global $ID;
        global $lang;

        return '<div class="newthread_form">'.DOKU_LF.
            '<form id="discussion__newthread_form"  method="post" action="'.script().'" accept-charset="'.$lang['encoding'].'">'.DOKU_LF.
            DOKU_TAB.'<fieldset>'.DOKU_LF.
            DOKU_TAB.DOKU_TAB.'<legend> '.$this->getLang('newthread').': </legend>'.DOKU_LF.
            DOKU_TAB.DOKU_TAB.'<input type="hidden" name="id" value="'.$ID.'" />'.DOKU_LF.
            DOKU_TAB.DOKU_TAB.'<input type="hidden" name="do" value="newthread" />'.DOKU_LF.
            DOKU_TAB.DOKU_TAB.'<input type="hidden" name="ns" value="'.$ns.'" />'.DOKU_LF.
            DOKU_TAB.DOKU_TAB.'<input class="edit" type="text" name="title" id="discussion__newthread_title" size="40" tabindex="1" />'.DOKU_LF.
            DOKU_TAB.DOKU_TAB.'<input class="button" type="submit" value="'.$lang['btn_create'].'" tabindex="2" />'.DOKU_LF.
            DOKU_TAB.'</fieldset>'.DOKU_LF.
            '</form>'.DOKU_LF.
            '</div>'.DOKU_LF;
    }
}
// vim:ts=4:sw=4:et:enc=utf-8: