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

<?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();

if (!defined('DOKU_LF')) define('DOKU_LF', "\n");
if (!defined('DOKU_TAB')) define('DOKU_TAB', "\t");
if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');

require_once(DOKU_PLUGIN.'syntax.php');

class syntax_plugin_discussion_threads extends DokuWiki_Syntax_Plugin {

  function getInfo(){
    return array(
      'author' => 'Esther Brunner',
      'email'  => 'wikidesign@gmail.com',
      'date'   => '2007-01-16',
      'name'   => 'Discussion Plugin (threads component)',
      'desc'   => 'Displays a list of recently active discussions',
      'url'    => 'http://www.wikidesign.ch/en/plugin/discussion/start',
    );
  }

  function getType(){ return 'substition'; }
  function getPType(){ return 'block'; }
  function getSort(){ return 306; }

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

  function handle($match, $state, $pos, &$handler){
    global $ID;

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

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

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

  function render($mode, &$renderer, $data){
    list($ns, $flags, $refine) = $data;

    if ($my =& plugin_load('helper', 'discussion')) $pages = $my->getThreads($ns);

    // use tag refinements?
    if ($refine){
      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;
        $renderer->doc .= $this->_newThreadForm($ns);
      }
      return true; // nothing to display
    }

    if ($mode == 'xhtml'){

      // prevent caching to ensure content is always fresh
      $renderer->info['cache'] = false;

      // show form to start a new discussion thread?
      $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
      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){
        $pagelist->addPage($page);
      }
      $renderer->doc .= $pagelist->finishList();

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

      return true;

    // for metadata renderer
    } elseif ($mode == '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
   */
  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;
  }

}

//Setup VIM: ex: et ts=4 enc=utf-8 :