xref: /plugin/discussion/syntax/threads.php (revision 0e0effa11e1ca47c311ad435570d533162e1423e) 
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 getInfo(){
21    return array(
22      'author' => 'Esther Brunner',
23      'email'  => 'wikidesign@gmail.com',
24      'date'   => '2007-01-12',
25      'name'   => 'Discussion Plugin (threads component)',
26      'desc'   => 'Displays a list of recently active discussions',
27      'url'    => 'http://www.wikidesign.ch/en/plugin/discussion/start',
28    );
29  }
30
31  function getType(){ return 'substition'; }
32  function getPType(){ return 'block'; }
33  function getSort(){ return 306; }
34
35  function connectTo($mode){
36    $this->Lexer->addSpecialPattern('\{\{threads>.+?\}\}', $mode, 'plugin_discussion_threads');
37  }
38
39  function handle($match, $state, $pos, &$handler){
40    global $ID;
41
42    $match = substr($match, 10, -2); // strip {{threads> from start and }} from end
43    list($ns, $flags) = explode('&', $match, 2);
44    $flags = explode('&', $flags);
45
46    if (($ns == '*') || ($ns == ':')) $ns = '';
47    elseif ($ns == '.') $ns = getNS($ID);
48    else $ns = cleanID($ns);
49
50    return array($ns, $flags);
51  }
52
53  function render($mode, &$renderer, $data){
54    list($ns, $flags) = $data;
55
56    if ($my =& plugin_load('helper', 'discussion')) $pages = $my->getThreads($ns);
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        $pagelist->addPage($page);
86      }
87      $renderer->doc .= $pagelist->finishList();
88
89      // show form to start a new discussion thread?
90      if ($perm_create && ($this->getConf('threads_formposition') == 'bottom'))
91        $renderer->doc .= $this->_newThreadForm($ns);
92
93      return true;
94
95    // for metadata renderer
96    } elseif ($mode == 'metadata'){
97      foreach ($pages as $page){
98        $renderer->meta['relation']['references'][$page['id']] = true;
99      }
100
101      return true;
102    }
103    return false;
104  }
105
106/* ---------- (X)HTML Output Functions ---------- */
107
108  /**
109   * Show the form to start a new discussion thread
110   */
111  function _newThreadForm($ns){
112    global $ID;
113    global $lang;
114
115    return '<div class="newthread_form">'.DOKU_LF.
116      '<form id="discussion__newthread_form"  method="post" action="'.script().'" accept-charset="'.$lang['encoding'].'">'.DOKU_LF.
117      DOKU_TAB.'<fieldset>'.DOKU_LF.
118      DOKU_TAB.DOKU_TAB.'<legend> '.$this->getLang('newthread').': </legend>'.DOKU_LF.
119      DOKU_TAB.DOKU_TAB.'<input type="hidden" name="id" value="'.$ID.'" />'.DOKU_LF.
120      DOKU_TAB.DOKU_TAB.'<input type="hidden" name="do" value="newthread" />'.DOKU_LF.
121      DOKU_TAB.DOKU_TAB.'<input type="hidden" name="ns" value="'.$ns.'" />'.DOKU_LF.
122      DOKU_TAB.DOKU_TAB.'<input class="edit" type="text" name="title" id="discussion__newthread_title" size="40" tabindex="1" />'.DOKU_LF.
123      DOKU_TAB.DOKU_TAB.'<input class="button" type="submit" value="'.$lang['btn_create'].'" tabindex="2" />'.DOKU_LF.
124      DOKU_TAB.'</fieldset>'.DOKU_LF.
125      '</form>'.DOKU_LF.
126      '</div>'.DOKU_LF;
127  }
128
129}
130
131//Setup VIM: ex: et ts=4 enc=utf-8 :
132