xref: /plugin/discussion/syntax/threads.php (revision b8efbcc2bc3516a7bfc8875ffe6c14c5a948c807) 
1<?php
2/**
3 * Discussion Plugin, threads component: displays a list of recently active discussions
4 *
5 * @license  GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author   Esther Brunner <wikidesign@gmail.com>
7 */
8
9// must be run within Dokuwiki
10if(!defined('DOKU_INC')) die();
11
12if (!defined('DOKU_LF')) define('DOKU_LF', "\n");
13if (!defined('DOKU_TAB')) define('DOKU_TAB', "\t");
14if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
15
16require_once(DOKU_PLUGIN.'syntax.php');
17
18class syntax_plugin_discussion_threads extends DokuWiki_Syntax_Plugin {
19
20    function getType() { return 'substition'; }
21    function getPType() { return 'block'; }
22    function getSort() { return 306; }
23
24    function connectTo($mode) {
25        $this->Lexer->addSpecialPattern('\{\{threads>.+?\}\}', $mode, 'plugin_discussion_threads');
26    }
27
28    function handle($match, $state, $pos, &$handler) {
29        global $ID;
30
31        $match = substr($match, 10, -2); // strip {{threads> from start and }} from end
32        list($match, $flags) = explode('&', $match, 2);
33        $flags = explode('&', $flags);
34        list($ns, $refine) = explode(' ', $match, 2);
35
36        if (($ns == '*') || ($ns == ':')) $ns = '';
37        elseif ($ns == '.') $ns = getNS($ID);
38        else $ns = cleanID($ns);
39
40        return array($ns, $flags, $refine);
41    }
42
43    function render($mode, &$renderer, $data) {
44        list($ns, $flags, $refine) = $data;
45
46        if ($my =& plugin_load('helper', 'discussion')) $pages = $my->getThreads($ns);
47
48        // use tag refinements?
49        if ($refine) {
50            if (plugin_isdisabled('tag') || (!$tag = plugin_load('helper', 'tag'))) {
51                msg('The Tag Plugin must be installed to use tag refinements.', -1);
52            } else {
53                $pages = $tag->tagRefine($pages, $refine);
54            }
55        }
56
57        if (!$pages) {
58            if ((auth_quickaclcheck($ns.':*') >= AUTH_CREATE) && ($mode == 'xhtml')) {
59                $renderer->info['cache'] = false;
60                $renderer->doc .= $this->_newThreadForm($ns);
61            }
62            return true; // nothing to display
63        }
64
65        if ($mode == 'xhtml') {
66
67            // prevent caching to ensure content is always fresh
68            $renderer->info['cache'] = false;
69
70            // show form to start a new discussion thread?
71            $perm_create = (auth_quickaclcheck($ns.':*') >= AUTH_CREATE);
72            if ($perm_create && ($this->getConf('threads_formposition') == 'top'))
73                $renderer->doc .= $this->_newThreadForm($ns);
74
75            // let Pagelist Plugin do the work for us
76            if (plugin_isdisabled('pagelist')
77                    || (!$pagelist =& plugin_load('helper', 'pagelist'))) {
78                msg('The Pagelist Plugin must be installed for threads lists to work.', -1);
79                return false;
80            }
81            $pagelist->column['comments'] = true;
82            $pagelist->setFlags($flags);
83            $pagelist->startList();
84            foreach ($pages as $page) {
85                $page['class'] = 'discussion_status'.$page['status'];
86                $pagelist->addPage($page);
87            }
88            $renderer->doc .= $pagelist->finishList();
89
90            // show form to start a new discussion thread?
91            if ($perm_create && ($this->getConf('threads_formposition') == 'bottom'))
92                $renderer->doc .= $this->_newThreadForm($ns);
93
94            return true;
95
96            // for metadata renderer
97        } elseif ($mode == 'metadata') {
98            foreach ($pages as $page) {
99                $renderer->meta['relation']['references'][$page['id']] = true;
100            }
101
102            return true;
103        }
104        return false;
105    }
106
107    /* ---------- (X)HTML Output Functions ---------- */
108
109    /**
110     * Show the form to start a new discussion thread
111     */
112    function _newThreadForm($ns) {
113        global $ID;
114        global $lang;
115
116        return '<div class="newthread_form">'.DOKU_LF.
117            '<form id="discussion__newthread_form"  method="post" action="'.script().'" accept-charset="'.$lang['encoding'].'">'.DOKU_LF.
118            DOKU_TAB.'<fieldset>'.DOKU_LF.
119            DOKU_TAB.DOKU_TAB.'<legend> '.$this->getLang('newthread').': </legend>'.DOKU_LF.
120            DOKU_TAB.DOKU_TAB.'<input type="hidden" name="id" value="'.$ID.'" />'.DOKU_LF.
121            DOKU_TAB.DOKU_TAB.'<input type="hidden" name="do" value="newthread" />'.DOKU_LF.
122            DOKU_TAB.DOKU_TAB.'<input type="hidden" name="ns" value="'.$ns.'" />'.DOKU_LF.
123            DOKU_TAB.DOKU_TAB.'<input class="edit" type="text" name="title" id="discussion__newthread_title" size="40" tabindex="1" />'.DOKU_LF.
124            DOKU_TAB.DOKU_TAB.'<input class="button" type="submit" value="'.$lang['btn_create'].'" tabindex="2" />'.DOKU_LF.
125            DOKU_TAB.'</fieldset>'.DOKU_LF.
126            '</form>'.DOKU_LF.
127            '</div>'.DOKU_LF;
128    }
129}
130// vim:ts=4:sw=4:et:enc=utf-8:
131