xref: /plugin/discussion/syntax/threads.php (revision 4c4d91c62c549aeb8edd5d78f70d8feaea0b8cef) 
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' => 'Gina Häußge, Michael Klier, Esther Brunner',
23      'email'  => 'dokuwiki@chimeric.de',
24      'date'   => '2007-01-16',
25      'name'   => 'Discussion Plugin (threads component)',
26      'desc'   => 'Displays a list of recently active discussions',
27      'url'    => 'http://wiki.splitbrain.org/plugin:discussion',
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($match, $flags) = explode('&', $match, 2);
44    $flags = explode('&', $flags);
45    list($ns, $refine) = explode(' ', $match, 2);
46
47    if (($ns == '*') || ($ns == ':')) $ns = '';
48    elseif ($ns == '.') $ns = getNS($ID);
49    else $ns = cleanID($ns);
50
51    return array($ns, $flags, $refine);
52  }
53
54  function render($mode, &$renderer, $data){
55    list($ns, $flags, $refine) = $data;
56
57    if ($my =& plugin_load('helper', 'discussion')) $pages = $my->getThreads($ns);
58
59    // use tag refinements?
60    if ($refine){
61      if (plugin_isdisabled('tag') || (!$tag = plugin_load('helper', 'tag'))){
62        msg('The Tag Plugin must be installed to use tag refinements.', -1);
63      } else {
64        $pages = $tag->tagRefine($pages, $refine);
65      }
66    }
67
68    if (!$pages){
69      if ((auth_quickaclcheck($ns.':*') >= AUTH_CREATE) && ($mode == 'xhtml')){
70        $renderer->info['cache'] = false;
71        $renderer->doc .= $this->_newThreadForm($ns);
72      }
73      return true; // nothing to display
74    }
75
76    if ($mode == 'xhtml'){
77
78      // prevent caching to ensure content is always fresh
79      $renderer->info['cache'] = false;
80
81      // show form to start a new discussion thread?
82      $perm_create = (auth_quickaclcheck($ns.':*') >= AUTH_CREATE);
83      if ($perm_create && ($this->getConf('threads_formposition') == 'top'))
84        $renderer->doc .= $this->_newThreadForm($ns);
85
86      // let Pagelist Plugin do the work for us
87      if (plugin_isdisabled('pagelist')
88        || (!$pagelist =& plugin_load('helper', 'pagelist'))){
89        msg('The Pagelist Plugin must be installed for threads lists to work.', -1);
90        return false;
91      }
92      $pagelist->column['comments'] = true;
93      $pagelist->setFlags($flags);
94      $pagelist->startList();
95      foreach ($pages as $page){
96        $pagelist->addPage($page);
97      }
98      $renderer->doc .= $pagelist->finishList();
99
100      // show form to start a new discussion thread?
101      if ($perm_create && ($this->getConf('threads_formposition') == 'bottom'))
102        $renderer->doc .= $this->_newThreadForm($ns);
103
104      return true;
105
106    // for metadata renderer
107    } elseif ($mode == 'metadata'){
108      foreach ($pages as $page){
109        $renderer->meta['relation']['references'][$page['id']] = true;
110      }
111
112      return true;
113    }
114    return false;
115  }
116
117/* ---------- (X)HTML Output Functions ---------- */
118
119  /**
120   * Show the form to start a new discussion thread
121   */
122  function _newThreadForm($ns){
123    global $ID;
124    global $lang;
125
126    return '<div class="newthread_form">'.DOKU_LF.
127      '<form id="discussion__newthread_form"  method="post" action="'.script().'" accept-charset="'.$lang['encoding'].'">'.DOKU_LF.
128      DOKU_TAB.'<fieldset>'.DOKU_LF.
129      DOKU_TAB.DOKU_TAB.'<legend> '.$this->getLang('newthread').': </legend>'.DOKU_LF.
130      DOKU_TAB.DOKU_TAB.'<input type="hidden" name="id" value="'.$ID.'" />'.DOKU_LF.
131      DOKU_TAB.DOKU_TAB.'<input type="hidden" name="do" value="newthread" />'.DOKU_LF.
132      DOKU_TAB.DOKU_TAB.'<input type="hidden" name="ns" value="'.$ns.'" />'.DOKU_LF.
133      DOKU_TAB.DOKU_TAB.'<input class="edit" type="text" name="title" id="discussion__newthread_title" size="40" tabindex="1" />'.DOKU_LF.
134      DOKU_TAB.DOKU_TAB.'<input class="button" type="submit" value="'.$lang['btn_create'].'" tabindex="2" />'.DOKU_LF.
135      DOKU_TAB.'</fieldset>'.DOKU_LF.
136      '</form>'.DOKU_LF.
137      '</div>'.DOKU_LF;
138  }
139
140}
141
142//Setup VIM: ex: et ts=4 enc=utf-8 :
143