lib/PageList.php

   1 <?php
   2 rcs_id('$Id$');
   3 /* Copyright (C) 2004-2009 $ThePhpWikiProgrammingTeam
   4  * Copyright (C) 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with PhpWiki; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  * List a number of pagenames, optionally as table with various columns.
  25  * This library relieves some work for these plugins:
  26  *
  27  * AllPages, BackLinks, LikePages, MostPopular, TitleSearch, WikiAdmin* and more
  28  *
  29  * It also allows dynamic expansion of those plugins to include more
  30  * columns in their output.
  31  *
  32  * Column 'info=' arguments:
  33  *
  34  * 'pagename' _("Page Name")
  35  * 'mtime'    _("Last Modified")
  36  * 'hits'     _("Hits")
  37  * 'summary'  _("Last Summary")
  38  * 'version'  _("Version")),
  39  * 'author'   _("Last Author")),
  40  * 'locked'   _("Locked"), _("locked")
  41  * 'minor'    _("Minor Edit"), _("minor")
  42  * 'markup'   _("Markup")
  43  * 'size'     _("Size")
  44  * 'creator'  _("Creator")
  45  * 'owner'    _("Owner")
  46  * 'checkbox'  selectable checkbox at the left.
  47  * 'content'
  48  *
  49  * Special, custom columns: Either theme or plugin (WikiAdmin*) specific.
  50  * 'remove'   _("Remove")
  51  * 'perm'     _("Permission Mask")
  52  * 'acl'      _("ACL")
  53  * 'renamed_pagename'   _("Rename to")
  54  * 'ratingwidget', ... wikilens theme specific.
  55  * 'custom'   See plugin/_WikiTranslation
  56  *
  57  * Symbolic 'info=' arguments:
  58  * 'all'       All columns except the special columns
  59  * 'most'      pagename, mtime, author, size, hits, ...
  60  * 'some'      pagename, mtime, author
  61  *
  62  * FIXME: In this refactoring I (Jeff) have un-implemented _ctime, _cauthor, and
  63  * number-of-revision.  Note the _ctime and _cauthor as they were implemented
  64  * were somewhat flawed: revision 1 of a page doesn't have to exist in the
  65  * database.  If lots of revisions have been made to a page, it's more than likely
  66  * that some older revisions (include revision 1) have been cleaned (deleted).
  67  *
  68  * DONE:
  69  *   paging support: limit, offset args
  70  *   check PagePerm "list" access-type,
  71  *   all columns are sortable. Thanks to the wikilens team.
  72  *   cols > 1, comma, azhead, ordered (OL lists)
  73  *   ->supportedArgs() which arguments are supported, so that the plugin
  74  *                     doesn't explictly need to declare it
  75  * TODO:
  76  *   fix sortby logic, fix multiple sortby and other paging args per page.
  77  *   info=relation,linkto nopage=1
  78  *   use custom format method (RecentChanges, rss, ...)
  79  *
  80  * FIXED:
  81  *   fix memory exhaustion on large pagelists with old --memory-limit php's only.
  82  *   Status: improved 2004-06-25 16:19:36 rurban
  83  */
  84 class _PageList_Column_base {
  85     var $_tdattr = array();
  86
  87     function _PageList_Column_base ($default_heading, $align = false) {
  88         $this->_heading = $default_heading;
  89
  90         if ($align) {
  91             // align="char" isn't supported by any browsers yet :(
  92             //if (is_array($align))
  93             //    $this->_tdattr = $align;
  94             //else
  95             $this->_tdattr['align'] = $align;
  96         }
  97     }
  98
  99     function format ($pagelist, $page_handle, &$revision_handle) {
 100         $nbsp = HTML::raw('&nbsp;');
 101         return HTML::td($this->_tdattr,
 102                         $nbsp,
 103                         $this->_getValue($page_handle, $revision_handle),
 104                         $nbsp);
 105     }
 106
 107     function getHeading () {
 108         return $this->_heading;
 109     }
 110
 111     function setHeading ($heading) {
 112         $this->_heading = $heading;
 113     }
 114
 115     // old-style heading
 116     function heading () {
 117         global $request;
 118         $nbsp = HTML::raw('&nbsp;');
 119         // allow sorting?
 120         if (1 /* or in_array($this->_field, PageList::sortable_columns())*/) {
 121             // multiple comma-delimited sortby args: "+hits,+pagename"
 122             // asc or desc: +pagename, -pagename
 123             $sortby = PageList::sortby($this->_field, 'flip_order');
 124             //Fixme: pass all also other GET args along. (limit, p[])
 125             //TODO: support GET and POST
 126             $s = HTML::a(array('href' =>
 127                                $request->GetURLtoSelf(array('sortby' => $sortby)),
 128                                'class' => 'pagetitle',
 129                                'title' => sprintf(_("Sort by %s"), $this->_field)),
 130                          $nbsp, HTML::u($this->_heading), $nbsp);
 131         } else {
 132             $s = HTML($nbsp, HTML::u($this->_heading), $nbsp);
 133         }
 134         return HTML::th(array('align' => 'center'),$s);
 135     }
 136
 137     // new grid-style sortable heading
 138     // TODO: via activeui.js ? (fast dhtml sorting)
 139     function button_heading (&$pagelist, $colNum) {
 140         global $WikiTheme, $request;
 141         // allow sorting?
 142         $nbsp = HTML::raw('&nbsp;');
 143         if (!$WikiTheme->DUMP_MODE /* or in_array($this->_field, PageList::sortable_columns()) */) {
 144             // TODO: add to multiple comma-delimited sortby args: "+hits,+pagename"
 145             $src = false;
 146             $noimg_src = $WikiTheme->getButtonURL('no_order');
 147             if ($noimg_src)
 148                 $noimg = HTML::img(array('src'    => $noimg_src,
 149                                          'border' => 0,
 150                                          'alt'    => '.'));
 151             else
 152                 $noimg = $nbsp;
 153             if ($pagelist->sortby($colNum, 'check')) { // show icon? request or plugin arg
 154                 $sortby = $pagelist->sortby($colNum, 'flip_order');
 155                 $desc = (substr($sortby,0,1) == '-'); // +pagename or -pagename
 156                 $src = $WikiTheme->getButtonURL($desc ? 'asc_order' : 'desc_order');
 157                 $reverse = $desc ? _("reverse")." " : "";
 158             } else {
 159                 // initially unsorted
 160                 $sortby = $pagelist->sortby($colNum, 'get');
 161             }
 162             if (!$src) {
 163                 $img = $noimg;
 164                 $reverse = "";
 165                 $img->setAttr('alt', ".");
 166             } else {
 167                 $img = HTML::img(array('src' => $src,
 168                                        'border' => 0,
 169                                        'alt' => _("Click to reverse sort order")));
 170             }
 171             $s = HTML::a(array('href' =>
 172                                  //Fixme: pass all also other GET args along. (limit is ok, p[])
 173                                  $request->GetURLtoSelf(array('sortby' => $sortby,
 174                                                               'id' => $pagelist->id)),
 175                                'class' => 'gridbutton',
 176                                'title' => sprintf(_("Click to sort by %s"), $reverse . $this->_field)),
 177                          $nbsp, $noimg,
 178                          $nbsp, $this->_heading,
 179                          $nbsp, $img,
 180                          $nbsp);
 181         } else {
 182             $s = HTML($nbsp, $this->_heading, $nbsp);
 183         }
 184         return HTML::th(array('align' => 'center', 'valign' => 'middle',
 185                               'class' => 'gridbutton'), $s);
 186     }
 187
 188     /**
 189      * Take two columns of this type and compare them.
 190      * An undefined value is defined to be < than the smallest defined value.
 191      * This base class _compare only works if the value is simple (e.g., a number).
 192      *
 193      * @param  $colvala  $this->_getValue() of column a
 194      * @param  $colvalb  $this->_getValue() of column b
 195      *
 196      * @return -1 if $a < $b, 1 if $a > $b, 0 otherwise.
 197      */
 198     function _compare($colvala, $colvalb) {
 199         if (is_string($colvala))
 200             return strcmp($colvala,$colvalb);
 201         $ret = 0;
 202         if (($colvala === $colvalb) || (!isset($colvala) && !isset($colvalb))) {
 203             ;
 204         } else {
 205             $ret = (!isset($colvala) || ($colvala < $colvalb)) ? -1 : 1;
 206         }
 207         return $ret;
 208     }
 209 };
 210
 211 class _PageList_Column extends _PageList_Column_base {
 212     function _PageList_Column ($field, $default_heading, $align = false) {
 213         $this->_PageList_Column_base($default_heading, $align);
 214
 215         $this->_need_rev = substr($field, 0, 4) == 'rev:';
 216         $this->_iscustom = substr($field, 0, 7) == 'custom:';
 217         if ($this->_iscustom) {
 218             $this->_field = substr($field, 7);
 219         }
 220         elseif ($this->_need_rev)
 221             $this->_field = substr($field, 4);
 222         else
 223             $this->_field = $field;
 224     }
 225
 226     function _getValue ($page_handle, &$revision_handle) {
 227         if ($this->_need_rev) {
 228             if (!$revision_handle)
 229                 // columns which need the %content should override this. (size, hi_content)
 230                 $revision_handle = $page_handle->getCurrentRevision(false);
 231             return $revision_handle->get($this->_field);
 232         }
 233         else {
 234             return $page_handle->get($this->_field);
 235         }
 236     }
 237
 238     function _getSortableValue ($page_handle, &$revision_handle) {
 239         $val = $this->_getValue($page_handle, $revision_handle);
 240         if ($this->_field == 'hits')
 241             return (int) $val;
 242         elseif (is_object($val) && method_exists($val, 'asString'))
 243             return $val->asString();
 244         else
 245             return (string) $val;
 246     }
 247 };
 248
 249 /* overcome a call_user_func limitation by not being able to do:
 250  * call_user_func_array(array(&$class, $class_name), $params);
 251  * So we need $class = new $classname($params);
 252  * And we add a 4th param to get at the parent $pagelist object
 253  */
 254 class _PageList_Column_custom extends _PageList_Column {
 255     function _PageList_Column_custom($params) {
 256         $this->_pagelist =& $params[3];
 257         $this->_PageList_Column($params[0], $params[1], $params[2]);
 258     }
 259 }
 260
 261 class _PageList_Column_size extends _PageList_Column {
 262     function format (&$pagelist, $page_handle, &$revision_handle) {
 263         return HTML::td($this->_tdattr,
 264                         HTML::raw('&nbsp;'),
 265                         $this->_getValue($pagelist, $page_handle, $revision_handle),
 266                         HTML::raw('&nbsp;'));
 267     }
 268
 269     function _getValue (&$pagelist, $page_handle, &$revision_handle) {
 270         if (!$revision_handle or (!$revision_handle->_data['%content']
 271                                   or $revision_handle->_data['%content'] === true)) {
 272             $revision_handle = $page_handle->getCurrentRevision(true);
 273             unset($revision_handle->_data['%pagedata']['_cached_html']);
 274         }
 275         $size = $this->_getSize($revision_handle);
 276         // we can safely purge the content when it is not sortable
 277         if (empty($pagelist->_sortby[$this->_field]))
 278             unset($revision_handle->_data['%content']);
 279         return $size;
 280     }
 281
 282     function _getSortableValue ($page_handle, &$revision_handle) {
 283         if (!$revision_handle)
 284             $revision_handle = $page_handle->getCurrentRevision(true);
 285         return (empty($revision_handle->_data['%content']))
 286                ? 0 : strlen($revision_handle->_data['%content']);
 287     }
 288
 289     function _getSize($revision_handle) {
 290         $bytes = @strlen($revision_handle->_data['%content']);
 291         return ByteFormatter($bytes);
 292     }
 293 }
 294
 295
 296 class _PageList_Column_bool extends _PageList_Column {
 297     function _PageList_Column_bool ($field, $default_heading, $text = 'yes') {
 298         $this->_PageList_Column($field, $default_heading, 'center');
 299         $this->_textIfTrue = $text;
 300         $this->_textIfFalse = new RawXml('&#8212;'); //mdash
 301     }
 302
 303     function _getValue ($page_handle, &$revision_handle) {
 304         //FIXME: check if $this is available in the parent (->need_rev)
 305         $val = _PageList_Column::_getValue($page_handle, $revision_handle);
 306         return $val ? $this->_textIfTrue : $this->_textIfFalse;
 307     }
 308 };
 309
 310 class _PageList_Column_checkbox extends _PageList_Column {
 311     function _PageList_Column_checkbox ($field, $default_heading, $name='p') {
 312         $this->_name = $name;
 313         $heading = HTML::input(array('type'  => 'button',
 314                                      'title' => _("Click to de-/select all pages"),
 315                                      'name'  => $default_heading,
 316                                      'value' => $default_heading,
 317                                      'onclick' => "flipAll(this.form)"
 318                                      ));
 319         $this->_PageList_Column($field, $heading, 'center');
 320     }
 321     function _getValue ($pagelist, $page_handle, &$revision_handle) {
 322         $pagename = $page_handle->getName();
 323         $selected = !empty($pagelist->_selected[$pagename]);
 324         if (strstr($pagename,'[') or strstr($pagename,']')) {
 325             $pagename = str_replace(array('[',']'),array('%5B','%5D'),$pagename);
 326         }
 327         if ($selected) {
 328             return HTML::input(array('type' => 'checkbox',
 329                                      'name' => $this->_name . "[$pagename]",
 330                                      'value' => 1,
 331                                      'checked' => 'checked'));
 332         } else {
 333             return HTML::input(array('type' => 'checkbox',
 334                                      'name' => $this->_name . "[$pagename]",
 335                                      'value' => 1));
 336         }
 337     }
 338     function format ($pagelist, $page_handle, &$revision_handle) {
 339         return HTML::td($this->_tdattr,
 340                         HTML::raw('&nbsp;'),
 341                         $this->_getValue($pagelist, $page_handle, $revision_handle),
 342                         HTML::raw('&nbsp;'));
 343     }
 344     // don't sort this javascript button
 345     function button_heading ($pagelist, $colNum) {
 346         $s = HTML(HTML::raw('&nbsp;'), $this->_heading, HTML::raw('&nbsp;'));
 347         return HTML::th(array('align' => 'center', 'valign' => 'middle',
 348                               'class' => 'gridbutton'), $s);
 349     }
 350 };
 351
 352 class _PageList_Column_time extends _PageList_Column {
 353     function _PageList_Column_time ($field, $default_heading) {
 354         $this->_PageList_Column($field, $default_heading, 'right');
 355         global $WikiTheme;
 356         $this->WikiTheme = &$WikiTheme;
 357     }
 358
 359     function _getValue ($page_handle, &$revision_handle) {
 360         $time = _PageList_Column::_getValue($page_handle, $revision_handle);
 361         return $this->WikiTheme->formatDateTime($time);
 362     }
 363
 364     function _getSortableValue ($page_handle, &$revision_handle) {
 365         return _PageList_Column::_getValue($page_handle, $revision_handle);
 366     }
 367 };
 368
 369 class _PageList_Column_version extends _PageList_Column {
 370     function _getValue ($page_handle, &$revision_handle) {
 371         if (!$revision_handle)
 372             $revision_handle = $page_handle->getCurrentRevision();
 373         return $revision_handle->getVersion();
 374     }
 375 };
 376
 377 // Output is hardcoded to limit of first 50 bytes. Otherwise
 378 // on very large Wikis this will fail if used with AllPages
 379 // (PHP memory limit exceeded)
 380 class _PageList_Column_content extends _PageList_Column {
 381     function _PageList_Column_content ($field, $default_heading, $align = false, $search = false) {
 382         $this->_PageList_Column($field, $default_heading, $align);
 383         $this->bytes = 50;
 384         $this->search = $search;
 385         if ($field == 'content') {
 386             $this->_heading .= sprintf(_(" ... first %d bytes"),
 387                                        $this->bytes);
 388         } elseif ($field == 'rev:hi_content') {
 389             global $HTTP_POST_VARS;
 390             if (!$this->search and !empty($HTTP_POST_VARS['admin_replace'])) {
 391                 $this->search = $HTTP_POST_VARS['admin_replace']['from'];
 392             }
 393             $this->_heading .= sprintf(_(" ... around %s"),
 394                                       '»'.$this->search.'«');
 395         }
 396     }
 397
 398     function _getValue ($page_handle, &$revision_handle) {
 399         if (!$revision_handle or (!$revision_handle->_data['%content']
 400                                   or $revision_handle->_data['%content'] === true)) {
 401             $revision_handle = $page_handle->getCurrentRevision(true);
 402         }
 403         // Not sure why implode is needed here, I thought
 404         // getContent() already did this, but it seems necessary.
 405         $c = implode("\n", $revision_handle->getContent());
 406         if (empty($pagelist->_sortby[$this->_field]))
 407             unset($revision_handle->_data['%content']);
 408         if ($this->_field == 'hi_content') {
 409             if (!empty($revision_handle->_data['%pagedata'])) {
 410                 $revision_handle->_data['%pagedata']['_cached_html'] = '';
 411                 // PHP Fatal error:  Cannot unset string offsets
 412                 //unset($revision_handle->_data['%pagedata']['_cached_html']);
 413             }
 414             $search = $this->search;
 415             $score = '';
 416             if (is_object($page_handle) and !empty($page_handle->score))
 417                 $score = $page_handle->score;
 418             elseif (is_array($page_handle) and !empty($page_handle['score']))
 419                 $score = $page_handle['score'];
 420             if ($search and ($i = strpos(strtolower($c), strtolower($search))) !== false) {
 421                 $l = strlen($search);
 422                 $j = max(0, $i - ($this->bytes / 2));
 423                 return HTML::div(array('style' => 'font-size:x-small'),
 424                                  HTML::div(array('class' => 'transclusion'),
 425                                            HTML::span("...".substr($c, $j, ($this->bytes / 2))),
 426                                            HTML::span(array("style"=>"background:yellow"),substr($c, $i, $l)),
 427                                            HTML::span(substr($c, $i+$l, ($this->bytes / 2))."..."." ".($score ? sprintf("[%0.1f]",$score):""))));
 428             } else {
 429                 if (strpos($c," ") !== false)
 430                     $c = "";
 431                 else
 432                     $c = sprintf(_("%s not found"), '»'.$search.'«');
 433                 return HTML::div(array('style' => 'font-size:x-small','align'=>'center'),
 434                                  $c." ".($score ? sprintf("[%0.1f]",$score):""));
 435             }
 436         } elseif (($len = strlen($c)) > $this->bytes) {
 437             $c = substr($c, 0, $this->bytes);
 438         }
 439         include_once('lib/BlockParser.php');
 440         // false --> don't bother processing hrefs for embedded WikiLinks
 441         $ct = TransformText($c, $revision_handle->get('markup'), false);
 442         if (empty($pagelist->_sortby[$this->_field]))
 443             unset($revision_handle->_data['%pagedata']['_cached_html']);
 444         return HTML::div(array('style' => 'font-size:x-small'),
 445                          HTML::div(array('class' => 'transclusion'), $ct),
 446                          // Don't show bytes here if size column present too
 447                          ($this->parent->_columns_seen['size'] or !$len) ? "" :
 448                            ByteFormatter($len, /*$longformat = */true));
 449     }
 450     function _getSortableValue ($page_handle, &$revision_handle) {
 451         if (is_object($page_handle) and !empty($page_handle->score))
 452             return $page_handle->score;
 453         elseif (is_array($page_handle) and !empty($page_handle['score']))
 454             return $page_handle['score'];
 455         else
 456             return substr(_PageList_Column::_getValue($page_handle, $revision_handle),0,50);
 457     }
 458 };
 459
 460 class _PageList_Column_author extends _PageList_Column {
 461     function _PageList_Column_author ($field, $default_heading, $align = false) {
 462         _PageList_Column::_PageList_Column($field, $default_heading, $align);
 463         $this->dbi =& $GLOBALS['request']->getDbh();
 464     }
 465
 466     function _getValue ($page_handle, &$revision_handle) {
 467         $author = _PageList_Column::_getValue($page_handle, $revision_handle);
 468         if ($this->dbi->isWikiPage($author))
 469             return WikiLink($author);
 470         else
 471             return $author;
 472     }
 473
 474     function _getSortableValue ($page_handle, &$revision_handle) {
 475         return _PageList_Column::_getValue($page_handle, $revision_handle);
 476     }
 477 };
 478
 479 class _PageList_Column_owner extends _PageList_Column_author {
 480     function _getValue ($page_handle, &$revision_handle) {
 481         $author = $page_handle->getOwner();
 482         if ($this->dbi->isWikiPage($author))
 483             return WikiLink($author);
 484         else
 485             return $author;
 486     }
 487     function _getSortableValue ($page_handle, &$revision_handle) {
 488         return _PageList_Column::_getValue($page_handle, $revision_handle);
 489     }
 490 };
 491
 492 class _PageList_Column_creator extends _PageList_Column_author {
 493     function _getValue ($page_handle, &$revision_handle) {
 494         $author = $page_handle->getCreator();
 495         if ($this->dbi->isWikiPage($author))
 496             return WikiLink($author);
 497         else
 498             return $author;
 499     }
 500     function _getSortableValue ($page_handle, &$revision_handle) {
 501         return _PageList_Column::_getValue($page_handle, $revision_handle);
 502     }
 503 };
 504
 505 class _PageList_Column_pagename extends _PageList_Column_base {
 506     var $_field = 'pagename';
 507
 508     function _PageList_Column_pagename () {
 509         $this->_PageList_Column_base(_("Page Name"));
 510         global $request;
 511         $this->dbi = &$request->getDbh();
 512     }
 513
 514     function _getValue ($page_handle, &$revision_handle) {
 515         if ($this->dbi->isWikiPage($page_handle->getName()))
 516             return WikiLink($page_handle, 'known');
 517         else
 518             return WikiLink($page_handle, 'unknown');
 519     }
 520
 521     function _getSortableValue ($page_handle, &$revision_handle) {
 522         return $page_handle->getName();
 523     }
 524
 525     /**
 526      * Compare two pagenames for sorting.  See _PageList_Column::_compare.
 527      **/
 528     function _compare($colvala, $colvalb) {
 529         return strcmp($colvala, $colvalb);
 530     }
 531 };
 532
 533 class PageList {
 534     var $_group_rows = 3;
 535     var $_columns = array();
 536     var $_columnsMap = array();      // Maps column name to column number.
 537     var $_excluded_pages = array();
 538     var $_pages = array();
 539     var $_caption = "";
 540     var $_pagename_seen = false;
 541     var $_types = array();
 542     var $_options = array();
 543     var $_selected = array();
 544     var $_sortby = array();
 545     var $_maxlen = 0;
 546
 547     function PageList ($columns = false, $exclude = false, $options = false) {
 548         // unique id per pagelist on each page.
 549         if (!isset($GLOBALS['request']->_pagelist))
 550             $GLOBALS['request']->_pagelist = 0;
 551         else
 552             $GLOBALS['request']->_pagelist++;
 553         $this->id = $GLOBALS['request']->_pagelist;
 554         if ($GLOBALS['request']->getArg('count'))
 555             $options['count'] = $GLOBALS['request']->getArg('count');
 556         if ($options)
 557             $this->_options = $options;
 558
 559         $this->_initAvailableColumns();
 560         // let plugins predefine only certain objects, such its own custom pagelist columns
 561         $symbolic_columns =
 562             array(
 563                   'all' =>  array_diff(array_keys($this->_types), // all but...
 564                                        array('checkbox','remove','renamed_pagename',
 565                                              'content','hi_content','perm','acl')),
 566                   'most' => array('pagename','mtime','author','hits'),
 567                   'some' => array('pagename','mtime','author')
 568                   );
 569         if (isset($this->_options['listtype'])
 570             and $this->_options['listtype'] == 'dl')
 571             $this->_options['nopage'] = 1;
 572         if ($columns) {
 573             if (!is_array($columns))
 574                 $columns = explode(',', $columns);
 575             // expand symbolic columns:
 576             foreach ($symbolic_columns as $symbol => $cols) {
 577                 if (in_array($symbol,$columns)) { // e.g. 'checkbox,all'
 578                     $columns = array_diff(array_merge($columns,$cols),array($symbol));
 579                 }
 580             }
 581             unset($cols);
 582             if (empty($this->_options['nopage']) and !in_array('pagename',$columns))
 583                 $this->_addColumn('pagename');
 584             foreach ($columns as $col) {
 585                 if (!empty($col))
 586                     $this->_addColumn($col);
 587             }
 588             unset($col);
 589         }
 590         // If 'pagename' is already present, _addColumn() will not add it again
 591         if (empty($this->_options['nopage']))
 592             $this->_addColumn('pagename');
 593
 594         if (!empty($this->_options['types'])) {
 595             foreach ($this->_options['types'] as $type) {
 596                 $this->_types[$type->_field] = $type;
 597                 $this->_addColumn($type->_field);
 598             }
 599             unset($this->_options['types']);
 600         }
 601
 602         global $request;
 603         // explicit header options: ?id=x&sortby=... override options[]
 604         // support multiple sorts. check multiple, no nested elseif
 605         if (($this->id == $request->getArg("id"))
 606              and $request->getArg('sortby'))
 607         {
 608             // add it to the front of the sortby array
 609             $this->sortby($request->getArg('sortby'), 'init');
 610             $this->_options['sortby'] = $request->getArg('sortby');
 611         } // plugin options
 612         if (!empty($options['sortby'])) {
 613             if (empty($this->_options['sortby']))
 614                 $this->_options['sortby'] = $options['sortby'];
 615             $this->sortby($options['sortby'], 'init');
 616         } // global options
 617         if (!isset($request->args["id"]) and $request->getArg('sortby')
 618              and empty($this->_options['sortby']))
 619         {
 620             $this->_options['sortby'] = $request->getArg('sortby');
 621             $this->sortby($this->_options['sortby'], 'init');
 622         }
 623         // same as above but without the special sortby push, and mutually exclusive (elseif)
 624         foreach ($this->pagingArgs() as $key) {
 625             if ($key == 'sortby') continue;
 626             if (($this->id == $request->getArg("id"))
 627                 and $request->getArg($key))
 628             {
 629                 $this->_options[$key] = $request->getArg($key);
 630             } // plugin options
 631             elseif (!empty($options) and !empty($options[$key])) {
 632                 $this->_options[$key] = $options[$key];
 633             } // global options
 634             elseif (!isset($request->args["id"]) and $request->getArg($key)) {
 635                 $this->_options[$key] = $request->getArg($key);
 636             }
 637             else
 638                 $this->_options[$key] = false;
 639         }
 640         if ($exclude) {
 641             if (is_string($exclude) and !is_array($exclude))
 642                 $exclude = $this->explodePageList($exclude, false,
 643                                                   $this->_options['sortby'],
 644                                                   $this->_options['limit']);
 645             $this->_excluded_pages = $exclude;
 646         }
 647         $this->_messageIfEmpty = _("<no matches>");
 648     }
 649
 650     // Currently PageList takes these arguments:
 651     // 1: info, 2: exclude, 3: hash of options
 652     // Here we declare which options are supported, so that
 653     // the calling plugin may simply merge this with its own default arguments
 654     function supportedArgs () {
 655         // Todo: add all supported Columns, like locked, minor, ...
 656         return array(// Currently supported options:
 657                      /* what columns, what pages */
 658                      'info'     => 'pagename',
 659                      'exclude'  => '',          // also wildcards, comma-seperated lists
 660                                                 // and <!plugin-list !> arrays
 661                      /* select pages by meta-data: */
 662                      'author'   => false, // current user by []
 663                      'owner'    => false, // current user by []
 664                      'creator'  => false, // current user by []
 665
 666                      /* for the sort buttons in <th> */
 667                      'sortby'   => '', // same as for WikiDB::getAllPages
 668                                        // (unsorted is faster)
 669
 670                      /* PageList pager options:
 671                       * These options may also be given to _generate(List|Table) later
 672                       * But limit and offset might help the query WikiDB::getAllPages()
 673                       */
 674                      'limit'    => 50,       // number of rows (pagesize)
 675                      'paging'   => 'auto',  // 'auto'   top + bottom rows if applicable
 676                      //                     // 'top'    top only if applicable
 677                      //                     // 'bottom' bottom only if applicable
 678                      //                     // 'none'   don't page at all
 679                      // (TODO: clarify what if $paging==false ?)
 680
 681                      /* list-style options (with single pagename column only so far) */
 682                      'cols'     => 1,       // side-by-side display of list (1-3)
 683                      'azhead'   => 0,       // 1: group by initials
 684                                             // 2: provide shortcut links to initials also
 685                      'comma'    => 0,       // condensed comma-seperated list,
 686                                             // 1 if without links, 2 if with
 687                      'commasep' => false,   // Default: ', '
 688                      'listtype' => '',      // ul (default), ol, dl, comma
 689                      'ordered'  => false,   // OL or just UL lists (ignored for comma)
 690                      'linkmore' => '',      // If count>0 and limit>0 display a link with
 691                      // the number of all results, linked to the given pagename.
 692
 693                      'nopage'   => false,   // for info=col omit the pagename column
 694                      // array_keys($this->_types). filter by columns: e.g. locked=1
 695                      'pagename' => null, // string regex
 696                      'locked'   => null,
 697                      'minor'    => null,
 698                      'mtime'    => null,
 699                      'hits'     => null,
 700                      'size'     => null,
 701                      'version'  => null,
 702                      'markup'   => null,
 703                      );
 704     }
 705
 706     function pagingArgs() {
 707         return array('sortby','limit','paging','count','dosort');
 708     }
 709
 710     function setCaption ($caption_string) {
 711         $this->_caption = $caption_string;
 712     }
 713
 714     function addCaption ($caption_string) {
 715         $this->_caption = HTML($this->_caption," ",$caption_string);
 716     }
 717
 718     function getCaption () {
 719         // put the total into the caption if needed
 720         if (is_string($this->_caption) && strstr($this->_caption, '%d'))
 721             return sprintf($this->_caption, $this->getTotal());
 722         return $this->_caption;
 723     }
 724
 725     function setMessageIfEmpty ($msg) {
 726         $this->_messageIfEmpty = $msg;
 727     }
 728
 729
 730     function getTotal () {
 731         return !empty($this->_options['count'])
 732                ? (integer) $this->_options['count'] : count($this->_pages);
 733     }
 734
 735     function isEmpty () {
 736         return empty($this->_pages);
 737     }
 738
 739     function addPage($page_handle) {
 740         if (!empty($this->_excluded_pages)) {
 741             if (!in_array((is_string($page_handle) ? $page_handle : $page_handle->getName()),
 742                           $this->_excluded_pages))
 743                 $this->_pages[] = $page_handle;
 744         } else {
 745             $this->_pages[] = $page_handle;
 746         }
 747     }
 748
 749     function pageNames() {
 750         $pages = array();
 751         $limit = @$this->_options['limit'];
 752         foreach ($this->_pages as $page_handle) {
 753             $pages[] = $page_handle->getName();
 754             if ($limit and count($pages) > $limit)
 755                 break;
 756         }
 757         return $pages;
 758     }
 759
 760     function _getPageFromHandle($page_handle) {
 761         if (is_string($page_handle)) {
 762             if (empty($page_handle)) return $page_handle;
 763             //$dbi = $GLOBALS['request']->getDbh(); // no, safe some memory!
 764             $page_handle = $GLOBALS['request']->_dbi->getPage($page_handle);
 765         }
 766         return $page_handle;
 767     }
 768
 769     /**
 770      * Take a PageList_Page object, and return an HTML object to display
 771      * it in a table or list row.
 772      */
 773     function _renderPageRow (&$page_handle, $i = 0) {
 774         $page_handle = $this->_getPageFromHandle($page_handle);
 775         //FIXME. only on sf.net
 776         if (!is_object($page_handle)) {
 777             trigger_error("PageList: Invalid page_handle $page_handle", E_USER_WARNING);
 778             return;
 779         }
 780         if (!isset($page_handle)
 781             or empty($page_handle)
 782             or (!empty($this->_excluded_pages)
 783                 and in_array($page_handle->getName(), $this->_excluded_pages)))
 784             return; // exclude page.
 785
 786         // enforce view permission
 787         if (!mayAccessPage('view', $page_handle->getName()))
 788             return;
 789
 790         $group = (int)($i / $this->_group_rows);
 791         $class = ($group % 2) ? 'oddrow' : 'evenrow';
 792         $revision_handle = false;
 793         $this->_maxlen = max($this->_maxlen, strlen($page_handle->getName()));
 794
 795         if (count($this->_columns) > 1) {
 796             $row = HTML::tr(array('class' => $class));
 797             $j = 0;
 798             foreach ($this->_columns as $col) {
 799                 $col->current_row = $i;
 800                 $col->current_column = $j;
 801                 $row->pushContent($col->format($this, $page_handle, $revision_handle));
 802                 $j++;
 803             }
 804         } else {
 805             $col = $this->_columns[0];
 806             $col->current_row = $i;
 807             $col->current_column = 0;
 808             $row = $col->_getValue($page_handle, $revision_handle);
 809         }
 810
 811         return $row;
 812     }
 813
 814     /* ignore from, but honor limit */
 815     function addPages ($page_iter) {
 816         // TODO: if limit check max(strlen(pagename))
 817         $i = 0; $from = 0;
 818         if (isa($page_iter->_iter, "WikiDB_backend_dbaBase_pageiter")) {
 819             $limit = 0;
 820         }
 821         elseif (isset($this->_options['limit'])) { // extract from,count from limit
 822             list($from, $limit) = WikiDB_backend::limit($this->_options['limit']);
 823             $limit += $from;
 824         } else {
 825             $limit = 0;
 826         }
 827         while ($page = $page_iter->next()) {
 828             $i++;
 829             if ($from and $i < $from)
 830                 continue;
 831             if (!$limit or ($limit and $i < $limit))
 832                 $this->addPage($page);
 833         }
 834         if (empty($this->_options['count']))
 835             $this->_options['count'] = $i;
 836     }
 837
 838     function addPageList (&$list) {
 839         if (empty($list)) return;  // Protect reset from a null arg
 840         if (isset($this->_options['limit'])) { // extract from,count from limit
 841             list($from, $limit) = WikiDB_backend::limit($this->_options['limit']);
 842             $limit += $from;
 843         } else {
 844             $limit = 0;
 845         }
 846         $i = 0;
 847         foreach ($list as $page) {
 848             $i++;
 849             if ($from and $i < $from)
 850                 continue;
 851             if (!$limit or ($limit and $i < $limit)) {
 852                 if (is_object($page)) $page = $page->_pagename;
 853                 $this->addPage((string)$page);
 854             }
 855         }
 856     }
 857
 858     function maxLen() {
 859         global $request;
 860         $dbi =& $request->getDbh();
 861         if (isa($dbi,'WikiDB_SQL')) {
 862             extract($dbi->_backend->_table_names);
 863             $res = $dbi->_backend->_dbh->getOne("SELECT max(length(pagename)) FROM $page_tbl");
 864             if (DB::isError($res) || empty($res)) return false;
 865             else return $res;
 866         } elseif (isa($dbi,'WikiDB_ADODB')) {
 867             extract($dbi->_backend->_table_names);
 868             $row = $dbi->_backend->_dbh->getRow("SELECT max(length(pagename)) FROM $page_tbl");
 869             return $row ? $row[0] : false;
 870         } else
 871             return false;
 872     }
 873
 874     function getContent() {
 875         // Note that the <caption> element wants inline content.
 876         $caption = $this->getCaption();
 877
 878         if ($this->isEmpty())
 879             return $this->_emptyList($caption);
 880         elseif (isset($this->_options['listtype'])
 881                 and in_array($this->_options['listtype'],
 882                              array('ol','ul','comma','dl')))
 883             return $this->_generateList($caption);
 884         elseif (count($this->_columns) == 1)
 885             return $this->_generateList($caption);
 886         else
 887             return $this->_generateTable($caption);
 888     }
 889
 890     function printXML() {
 891         PrintXML($this->getContent());
 892     }
 893
 894     function asXML() {
 895         return AsXML($this->getContent());
 896     }
 897
 898     /**
 899      * Handle sortby requests for the DB iterator and table header links.
 900      * Prefix the column with + or - like "+pagename","-mtime", ...
 901      *
 902      * Supported actions:
 903      *   'init'       :   unify with predefined order. "pagename" => "+pagename"
 904      *   'flip_order' :   "mtime" => "+mtime" => "-mtime" ...
 905      *   'db'         :   "-pagename" => "pagename DESC"
 906      *   'check'      :
 907      *
 908      * Now all columns are sortable. (patch by DanFr)
 909      * Some columns have native DB backend methods, some not.
 910      */
 911     function sortby ($column, $action, $valid_fields=false) {
 912         global $request;
 913
 914         if (empty($column)) return '';
 915         if (is_int($column)) {
 916             $column = $this->_columns[$column - 1]->_field;
 917             //$column = $col->_field;
 918         }
 919         //if (!is_string($column)) return '';
 920         // support multiple comma-delimited sortby args: "+hits,+pagename"
 921         // recursive concat
 922         if (strstr($column, ',')) {
 923             $result = ($action == 'check') ? true : array();
 924             foreach (explode(',', $column) as $col) {
 925                 if ($action == 'check')
 926                     $result = $result && $this->sortby($col, $action, $valid_fields);
 927                 else
 928                     $result[] = $this->sortby($col, $action, $valid_fields);
 929             }
 930             // 'check' returns true/false for every col. return true if all are true.
 931             // i.e. the unsupported 'every' operator in functional languages.
 932             if ($action == 'check')
 933                 return $result;
 934             else
 935                 return join(",", $result);
 936         }
 937         if (substr($column,0,1) == '+') {
 938             $order = '+'; $column = substr($column,1);
 939         } elseif (substr($column,0,1) == '-') {
 940             $order = '-'; $column = substr($column,1);
 941         }
 942         // default initial order: +pagename, -mtime, -hits
 943         if (empty($order)) {
 944             if (!empty($this->_sortby[$column]))
 945                 $order = $this->_sortby[$column];
 946             else {
 947                 if (in_array($column, array('mtime','hits')))
 948                     $order = '-';
 949                 else
 950                     $order = '+';
 951             }
 952         }
 953         if ($action == 'get') {
 954             return $order . $column;
 955         } elseif ($action == 'flip_order') {
 956             if (0 and DEBUG)
 957                 trigger_error("flip $order $column ".$this->id,  E_USER_NOTICE);
 958             return ($order == '+' ? '-' : '+') . $column;
 959         } elseif ($action == 'init') { // only allowed from PageList::PageList
 960             if (0 and DEBUG) {
 961                 if ($this->sortby($column, 'clicked')) {
 962                     trigger_error("clicked $order $column $this->id",  E_USER_NOTICE);
 963                 //$order = ($order == '+' ? '-' : '+'); // $this->sortby($sortby, 'flip_order');
 964                 }
 965             }
 966             $this->_sortby[$column] = $order; // forces show icon
 967             return $order . $column;
 968         } elseif ($action == 'check') {   // show icon?
 969             //if specified via arg or if clicked
 970             $show = (!empty($this->_sortby[$column]) or $this->sortby($column, 'clicked'));
 971             if (0 and $show and DEBUG) {
 972                 trigger_error("show $order $column ".$this->id, E_USER_NOTICE);
 973             }
 974             return $show;
 975         } elseif ($action == 'clicked') { // flip sort order?
 976             global $request;
 977             $arg = $request->getArg('sortby');
 978             return ($arg
 979                     and strstr($arg, $column)
 980                     and (!isset($request->args['id'])
 981                          or $this->id == $request->getArg('id')));
 982         } elseif ($action == 'db') {
 983             // Performance enhancement: use native DB sort if possible.
 984             if (($valid_fields and in_array($column, $valid_fields))
 985                 or (method_exists($request->_dbi->_backend, 'sortable_columns')
 986                     and (in_array($column, $request->_dbi->_backend->sortable_columns())))) {
 987                 // omit this sort method from the _sortPages call at rendering
 988                 // asc or desc: +pagename, -pagename
 989                 return $column . ($order == '+' ? ' ASC' : ' DESC');
 990             } else {
 991                 return '';
 992             }
 993         }
 994         return '';
 995     }
 996
 997     /* Splits pagelist string into array.
 998      * Test* or Test1,Test2
 999      * Limitation: Doesn't split into comma-sep and then expand wildcards.
1000      * "Test1*,Test2*" is expanded into TextSearch "Test1* Test2*"
1001      *
1002      * echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
1003      */
1004     function explodePageList($input, $include_empty=false, $sortby='',
1005                              $limit='', $exclude='')
1006     {
1007         if (empty($input)) return array();
1008         if (is_array($input)) return $input;
1009         // expand wildcards from list of all pages
1010         if (preg_match('/[\?\*]/', $input) or substr($input,0,1) == "^") {
1011             include_once("lib/TextSearchQuery.php");
1012             $search = new TextSearchQuery(str_replace(",", " ", $input), true,
1013                                          (substr($input,0,1) == "^") ? 'posix' : 'glob');
1014             $dbi = $GLOBALS['request']->getDbh();
1015             $iter = $dbi->titleSearch($search, $sortby, $limit, $exclude);
1016             $pages = array();
1017             while ($pagehandle = $iter->next()) {
1018                 $pages[] = $pagehandle->getName();
1019             }
1020             return $pages;
1021             /*
1022             //TODO: need an SQL optimization here
1023             $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit,
1024                                                 $exclude);
1025             while ($pagehandle = $allPagehandles->next()) {
1026                 $allPages[] = $pagehandle->getName();
1027             }
1028             return explodeList($input, $allPages);
1029             */
1030         } else {
1031             //TODO: do the sorting, normally not needed if used for exclude only
1032             return explode(',', $input);
1033         }
1034     }
1035
1036     // TODO: optimize getTotal => store in count
1037     function allPagesByAuthor($wildcard, $include_empty=false, $sortby='',
1038                               $limit='', $exclude='')
1039     {
1040         $dbi = $GLOBALS['request']->getDbh();
1041         $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
1042         $allPages = array();
1043         if ($wildcard === '[]') {
1044             $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
1045             if (!$wildcard) return $allPages;
1046         }
1047         $do_glob = preg_match('/[\?\*]/', $wildcard);
1048         while ($pagehandle = $allPagehandles->next()) {
1049             $name = $pagehandle->getName();
1050             $author = $pagehandle->getAuthor();
1051             if ($author) {
1052                 if ($do_glob) {
1053                     if (glob_match($wildcard, $author))
1054                         $allPages[] = $name;
1055                 } elseif ($wildcard == $author) {
1056                       $allPages[] = $name;
1057                 }
1058             }
1059             // TODO: purge versiondata_cache
1060         }
1061         return $allPages;
1062     }
1063
1064     function allPagesByOwner($wildcard, $include_empty=false, $sortby='',
1065                              $limit='', $exclude='') {
1066         $dbi = $GLOBALS['request']->getDbh();
1067         $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
1068         $allPages = array();
1069         if ($wildcard === '[]') {
1070             $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
1071             if (!$wildcard) return $allPages;
1072         }
1073         $do_glob = preg_match('/[\?\*]/', $wildcard);
1074         while ($pagehandle = $allPagehandles->next()) {
1075             $name = $pagehandle->getName();
1076             $owner = $pagehandle->getOwner();
1077             if ($owner) {
1078                 if ($do_glob) {
1079                     if (glob_match($wildcard, $owner))
1080                         $allPages[] = $name;
1081                 } elseif ($wildcard == $owner) {
1082                       $allPages[] = $name;
1083                 }
1084             }
1085         }
1086         return $allPages;
1087     }
1088
1089     function allPagesByCreator($wildcard, $include_empty=false, $sortby='',
1090                                $limit='', $exclude='') {
1091         $dbi = $GLOBALS['request']->getDbh();
1092         $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
1093         $allPages = array();
1094         if ($wildcard === '[]') {
1095             $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
1096             if (!$wildcard) return $allPages;
1097         }
1098         $do_glob = preg_match('/[\?\*]/', $wildcard);
1099         while ($pagehandle = $allPagehandles->next()) {
1100             $name = $pagehandle->getName();
1101             $creator = $pagehandle->getCreator();
1102             if ($creator) {
1103                 if ($do_glob) {
1104                     if (glob_match($wildcard, $creator))
1105                         $allPages[] = $name;
1106                 } elseif ($wildcard == $creator) {
1107                       $allPages[] = $name;
1108                 }
1109             }
1110         }
1111         return $allPages;
1112     }
1113
1114     // UserPages are pages NOT created by ADMIN_USER
1115     function allUserPages($include_empty=false, $sortby='',
1116                           $limit='', $exclude='') {
1117         $dbi = $GLOBALS['request']->getDbh();
1118         $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
1119         $allPages = array();
1120         while ($pagehandle = $allPagehandles->next()) {
1121             $name = $pagehandle->getName();
1122             $creator = $pagehandle->getCreator();
1123             if ($creator !== ADMIN_USER) {
1124                  $allPages[] = $name;
1125             }
1126         }
1127         return $allPages;
1128     }
1129
1130     ////////////////////
1131     // private
1132     ////////////////////
1133     /** Plugin and theme hooks:
1134      *  If the pageList is initialized with $options['types'] these types are also initialized,
1135      *  overriding the standard types.
1136      */
1137     function _initAvailableColumns() {
1138         global $customPageListColumns;
1139         $standard_types =
1140             array(
1141                   'content'
1142                   => new _PageList_Column_content('rev:content', _("Content")),
1143                   // new: plugin specific column types initialised by the relevant plugins
1144                   /*
1145                   'hi_content' // with highlighted search for SearchReplace
1146                   => new _PageList_Column_content('rev:hi_content', _("Content")),
1147                   'remove'
1148                   => new _PageList_Column_remove('remove', _("Remove")),
1149                   // initialised by the plugin
1150                   'renamed_pagename'
1151                   => new _PageList_Column_renamed_pagename('rename', _("Rename to")),
1152                   'perm'
1153                   => new _PageList_Column_perm('perm', _("Permission")),
1154                   'acl'
1155                   => new _PageList_Column_acl('acl', _("ACL")),
1156                   */
1157                   'checkbox'
1158                   => new _PageList_Column_checkbox('p', _("All")),
1159                   'pagename'
1160                   => new _PageList_Column_pagename,
1161                   'mtime'
1162                   => new _PageList_Column_time('rev:mtime', _("Last Modified")),
1163                   'hits'
1164                   => new _PageList_Column('hits', _("Hits"), 'right'),
1165                   'size'
1166                   => new _PageList_Column_size('rev:size', _("Size"), 'right'),
1167                                               /*array('align' => 'char', 'char' => ' ')*/
1168                   'summary'
1169                   => new _PageList_Column('rev:summary', _("Last Summary")),
1170                   'version'
1171                   => new _PageList_Column_version('rev:version', _("Version"),
1172                                                  'right'),
1173                   'author'
1174                   => new _PageList_Column_author('rev:author', _("Last Author")),
1175                   'owner'
1176                   => new _PageList_Column_owner('author_id', _("Owner")),
1177                   'creator'
1178                   => new _PageList_Column_creator('author_id', _("Creator")),
1179                   /*
1180                   'group'
1181                   => new _PageList_Column_author('group', _("Group")),
1182                   */
1183                   'locked'
1184                   => new _PageList_Column_bool('locked', _("Locked"),
1185                                                _("locked")),
1186                   'minor'
1187                   => new _PageList_Column_bool('rev:is_minor_edit',
1188                                                _("Minor Edit"), _("minor")),
1189                   'markup'
1190                   => new _PageList_Column('rev:markup', _("Markup")),
1191                   // 'rating' initialised by the wikilens theme hook: addPageListColumn
1192                   /*
1193                   'rating'
1194                   => new _PageList_Column_rating('rating', _("Rate")),
1195                   */
1196                   );
1197         if (empty($this->_types))
1198             $this->_types = array();
1199         // add plugin specific pageList columns, initialized by $options['types']
1200         $this->_types = array_merge($standard_types, $this->_types);
1201         // add theme custom specific pageList columns:
1202         //   set the 4th param as the current pagelist object.
1203         if (!empty($customPageListColumns)) {
1204             foreach ($customPageListColumns as $column => $params) {
1205                 $class_name = array_shift($params);
1206                 $params[3] =& $this;
1207                 // ref to a class does not work with php-4
1208                 $this->_types[$column] = new $class_name($params);
1209             }
1210         }
1211     }
1212
1213     function getOption($option) {
1214         if (array_key_exists($option, $this->_options)) {
1215             return $this->_options[$option];
1216         }
1217         else {
1218             return null;
1219         }
1220     }
1221
1222     /**
1223      * Add a column to this PageList, given a column name.
1224      * The name is a type, and optionally has a : and a label. Examples:
1225      *
1226      *   pagename
1227      *   pagename:This page
1228      *   mtime
1229      *   mtime:Last modified
1230      *
1231      * If this function is called multiple times for the same type, the
1232      * column will only be added the first time, and ignored the succeeding times.
1233      * If you wish to add multiple columns of the same type, use addColumnObject().
1234      *
1235      * @param column name
1236      * @return  true if column is added, false otherwise
1237      */
1238     function _addColumn ($column) {
1239
1240         if (isset($this->_columns_seen[$column]))
1241             return false;       // Already have this one.
1242         if (!isset($this->_types[$column]))
1243             $this->_initAvailableColumns();
1244         $this->_columns_seen[$column] = true;
1245
1246         if (strstr($column, ':'))
1247             list ($column, $heading) = explode(':', $column, 2);
1248
1249         // FIXME: these column types have hooks (objects) elsewhere
1250         // Omitting this warning should be overridable by the extension
1251         if (!isset($this->_types[$column])) {
1252             $silently_ignore = array('numbacklinks',
1253                                      'rating','ratingvalue',
1254                                      'coagreement', 'minmisery',
1255                                      /*'prediction',*/
1256                                      'averagerating', 'top3recs',
1257                                      'relation', 'linkto');
1258             if (!in_array($column, $silently_ignore))
1259                 trigger_error(sprintf("%s: Bad column", $column), E_USER_NOTICE);
1260             return false;
1261         }
1262         // FIXME: anon users might rate and see ratings also.
1263         // Defer this logic to the plugin.
1264         if ($column == 'rating' and !$GLOBALS['request']->_user->isSignedIn())
1265             return false;
1266
1267         $this->addColumnObject($this->_types[$column]);
1268
1269         return true;
1270     }
1271
1272     /**
1273      * Add a column to this PageList, given a column object.
1274      *
1275      * @param $col object   An object derived from _PageList_Column.
1276      **/
1277     function addColumnObject($col) {
1278         if (is_array($col)) {// custom column object
1279             $params =& $col;
1280             $class_name = array_shift($params);
1281             $params[3] =& $this;
1282             $col = new $class_name($params);
1283         }
1284         $heading = $col->getHeading();
1285         if (!empty($heading))
1286             $col->setHeading($heading);
1287
1288         $this->_columns[] = $col;
1289         $this->_columnsMap[$col->_field] = count($this->_columns); // start with 1
1290     }
1291
1292     /**
1293      * Compare _PageList_Page objects.
1294      **/
1295     function _pageCompare(&$a, &$b) {
1296         if (empty($this->_sortby) or count($this->_sortby) == 0) {
1297             // No columns to sort by
1298             return 0;
1299         }
1300         else {
1301             $pagea = $this->_getPageFromHandle($a);  // If a string, convert to page
1302             assert(isa($pagea, 'WikiDB_Page'));
1303             $pageb = $this->_getPageFromHandle($b);  // If a string, convert to page
1304             assert(isa($pageb, 'WikiDB_Page'));
1305             foreach ($this->_sortby as $colNum => $direction) {
1306                 // get column type object
1307                 if (!is_int($colNum)) { // or column fieldname
1308                     if (isset($this->_columnsMap[$colNum]))
1309                         $col = $this->_columns[$this->_columnsMap[$colNum] - 1];
1310                     elseif (isset($this->_types[$colNum]))
1311                         $col = $this->_types[$colNum];
1312                 }
1313                 if (empty($col)){
1314                     return 0;
1315                 }
1316                 assert(isset($col));
1317                 $revision_handle = false;
1318                 $aval = $col->_getSortableValue($pagea, $revision_handle);
1319                 $revision_handle = false;
1320                 $bval = $col->_getSortableValue($pageb, $revision_handle);
1321
1322                 $cmp = $col->_compare($aval, $bval);
1323                 if ($direction === "-")  // Reverse the sense of the comparison
1324                     $cmp *= -1;
1325
1326                 if ($cmp !== 0)
1327                     // This is the first comparison that is not equal-- go with it
1328                     return $cmp;
1329             }
1330             return 0;
1331         }
1332     }
1333
1334     /**
1335      * Put pages in order according to the sortby arg, if given
1336      * If the sortby cols are already sorted by the DB call, don't do usort.
1337      * TODO: optimize for multiple sortable cols
1338      */
1339     function _sortPages() {
1340         if (count($this->_sortby) > 0) {
1341             $need_sort = $this->_options['dosort'];
1342             if (!$need_sort)
1343               foreach ($this->_sortby as $col => $dir) {
1344                 if (! $this->sortby($col, 'db'))
1345                     $need_sort = true;
1346               }
1347             if ($need_sort) { // There are some columns to sort by
1348                 // TODO: consider nopage
1349                 usort($this->_pages, array($this, '_pageCompare'));
1350             }
1351         }
1352         //unset($GLOBALS['PhpWiki_pagelist']);
1353     }
1354
1355     function limit($limit) {
1356         if (is_array($limit)) return $limit;
1357         if (strstr($limit, ','))
1358             return split(',', $limit);
1359         else
1360             return array(0, $limit);
1361     }
1362
1363     function pagingTokens($numrows = false, $ncolumns = false, $limit = false) {
1364         if ($numrows === false)
1365             $numrows = $this->getTotal();
1366         if ($limit === false)
1367             $limit = $this->_options['limit'];
1368         if ($ncolumns === false)
1369             $ncolumns = count($this->_columns);
1370
1371         list($offset, $pagesize) = $this->limit($limit);
1372         if (!$pagesize or
1373             (!$offset and $numrows < $pagesize) or
1374             (($offset + $pagesize) < 0))
1375             return false;
1376
1377         $request = &$GLOBALS['request'];
1378         $pagename = $request->getArg('pagename');
1379         $defargs = array_merge(array('id' => $this->id), $request->args);
1380         if (USE_PATH_INFO) unset($defargs['pagename']);
1381         if (isset($defargs['action']) and ($defargs['action'] == 'browse')) {
1382             unset($defargs['action']);
1383         }
1384         $prev = $defargs;
1385
1386         $tokens = array();
1387         $tokens['PREV'] = false; $tokens['PREV_LINK'] = "";
1388         $tokens['COLS'] = $ncolumns;
1389         $tokens['COUNT'] = $numrows;
1390         $tokens['OFFSET'] = $offset;
1391         $tokens['SIZE'] = $pagesize;
1392         $tokens['NUMPAGES'] = (int) ceil($numrows / $pagesize);
1393         $tokens['ACTPAGE'] = (int) ceil(($offset / $pagesize)+1);
1394         if ($offset > 0) {
1395             $prev['limit'] = max(0, $offset - $pagesize) . ",$pagesize";
1396             $prev['count'] = $numrows;
1397             $tokens['LIMIT'] = $prev['limit'];
1398             $tokens['PREV'] = true;
1399             $tokens['PREV_LINK'] = WikiURL($pagename, $prev);
1400             $prev['limit'] = "0,$pagesize";
1401             $tokens['FIRST_LINK'] = WikiURL($pagename, $prev);
1402         }
1403         $next = $defargs;
1404         $tokens['NEXT'] = false; $tokens['NEXT_LINK'] = "";
1405         if (($offset + $pagesize) < $numrows) {
1406             $next['limit'] = min($offset + $pagesize, $numrows - $pagesize) . ",$pagesize";
1407             $next['count'] = $numrows;
1408             $tokens['LIMIT'] = $next['limit'];
1409             $tokens['NEXT'] = true;
1410             $tokens['NEXT_LINK'] = WikiURL($pagename, $next);
1411             $next['limit'] = $numrows - $pagesize . ",$pagesize";
1412             $tokens['LAST_LINK'] = WikiURL($pagename, $next);
1413         }
1414         return $tokens;
1415     }
1416
1417     // make a table given the caption
1418     function _generateTable($caption) {
1419         if (count($this->_sortby) > 0) $this->_sortPages();
1420
1421         // wikiadminutils hack. that's a way to pagelist non-pages
1422         $rows = isset($this->_rows) ? $this->_rows : array();
1423         $i = 0;
1424         $count = $this->getTotal();
1425         $do_paging = ( isset($this->_options['paging'])
1426                        and !empty($this->_options['limit'])
1427                        and $count
1428                        and $this->_options['paging'] != 'none' );
1429         if ($do_paging) {
1430             $tokens = $this->pagingTokens($count,
1431                                            count($this->_columns),
1432                                            $this->_options['limit']);
1433             if ($tokens)
1434                 $this->_pages = array_slice($this->_pages, $tokens['OFFSET'], $tokens['COUNT']);
1435         }
1436         foreach ($this->_pages as $pagenum => $page) {
1437             $rows[] = $this->_renderPageRow($page, $i++);
1438         }
1439         $table = HTML::table(array('cellpadding' => 0,
1440                                    'cellspacing' => 1,
1441                                    'border'      => 0,
1442                                    'width'       => '100%',
1443                                    'class'       => 'pagelist',
1444                                    ));
1445         if ($caption) {
1446             $table->pushContent(HTML::caption(array('align'=>'top'), $caption));
1447         }
1448
1449         $row = HTML::tr();
1450         $table_summary = array();
1451         $i = 1; // start with 1!
1452         foreach ($this->_columns as $col) {
1453             $heading = $col->button_heading($this, $i);
1454             if ( $do_paging
1455                  and isset($col->_field)
1456                  and $col->_field == 'pagename'
1457                  and ($maxlen = $this->maxLen())) {
1458                // $heading->setAttr('width', $maxlen * 7);
1459             }
1460             $row->pushContent($heading);
1461             if (is_string($col->getHeading()))
1462                 $table_summary[] = $col->getHeading();
1463             $i++;
1464         }
1465         // Table summary for non-visual browsers.
1466         $table->setAttr('summary', sprintf(_("Columns: %s."),
1467                                            join(", ", $table_summary)));
1468         $table->pushContent(HTML::colgroup(array('span' => count($this->_columns))));
1469         if ( $do_paging ) {
1470             if ($tokens === false) {
1471                 $table->pushContent(HTML::thead($row),
1472                                     HTML::tbody(false, $rows));
1473                 return $table;
1474             }
1475
1476             $paging = Template("pagelink", $tokens);
1477             if ($this->_options['paging'] != 'bottom')
1478                 $table->pushContent(HTML::thead($paging));
1479             if ($this->_options['paging'] != 'top')
1480                 $table->pushContent(HTML::tfoot($paging));
1481             $table->pushContent(HTML::tbody(false, HTML($row, $rows)));
1482             return $table;
1483         } else {
1484             $table->pushContent(HTML::thead($row),
1485                                 HTML::tbody(false, $rows));
1486             return $table;
1487         }
1488     }
1489
1490     /* recursive stack for private sublist options (azhead, cols) */
1491     function _saveOptions($opts) {
1492         $stack = array('pages' => $this->_pages);
1493         foreach ($opts as $k => $v) {
1494             $stack[$k] = $this->_options[$k];
1495             $this->_options[$k] = $v;
1496         }
1497         if (empty($this->_stack))
1498             $this->_stack = new Stack();
1499         $this->_stack->push($stack);
1500     }
1501     function _restoreOptions() {
1502         assert($this->_stack);
1503         $stack = $this->_stack->pop();
1504         $this->_pages = $stack['pages'];
1505         unset($stack['pages']);
1506         foreach ($stack as $k => $v) {
1507             $this->_options[$k] = $v;
1508         }
1509     }
1510
1511     // 'cols'   - split into several columns
1512     // 'azhead' - support <h3> grouping into initials
1513     // 'ordered' - OL or UL list (not yet inherited to all plugins)
1514     // 'comma'  - condensed comma-list only, 1: no links, >1: with links
1515     // FIXME: only unique list entries, esp. with nopage
1516     function _generateList($caption='') {
1517         if (empty($this->_pages)) return; // stop recursion
1518         if (!isset($this->_options['listtype']))
1519             $this->_options['listtype'] = '';
1520         $out = HTML();
1521         if ($caption)
1522             $out->pushContent(HTML::p($caption));
1523         // Semantic Search et al: only unique list entries, esp. with nopage
1524         if (!is_array($this->_pages[0]) and is_string($this->_pages[0])) {
1525             $this->_pages = array_unique($this->_pages);
1526         }
1527         if (count($this->_sortby) > 0) $this->_sortPages();
1528         $count = $this->getTotal();
1529         $do_paging = ( isset($this->_options['paging'])
1530                        and !empty($this->_options['limit'])
1531                        and $count
1532                        and $this->_options['paging'] != 'none' );
1533         if ( $do_paging ) {
1534             $tokens = $this->pagingTokens($count,
1535                                           count($this->_columns),
1536                                           $this->_options['limit']);
1537             if ($tokens) {
1538                 $paging = Template("pagelink", $tokens);
1539                 $out->pushContent(HTML::table(array('width'=>'50%'), $paging));
1540             }
1541         }
1542
1543         // need a recursive switch here for the azhead and cols grouping.
1544         if (!empty($this->_options['cols']) and $this->_options['cols'] > 1) {
1545             $count = count($this->_pages);
1546             $length = intval($count / ($this->_options['cols']));
1547             // If division does not give an integer, we need one more line
1548             // E.g. 13 pages to display in 3 columns.
1549             if (($length * ($this->_options['cols'])) != $count) {
1550                 $length += 1;
1551             }
1552             $width = sprintf("%d", 100 / $this->_options['cols']).'%';
1553             $cols = HTML::tr(array('valign' => 'top'));
1554             for ($i=0; $i < $count; $i += $length) {
1555                 $this->_saveOptions(array('cols' => 0, 'paging' => 'none'));
1556                 $this->_pages = array_slice($this->_pages, $i, $length);
1557                 $cols->pushContent(HTML::td(/*array('width' => $width),*/
1558                                             $this->_generateList()));
1559                 $this->_restoreOptions();
1560             }
1561             // speed up table rendering by defining colgroups
1562             $out->pushContent(HTML::table(HTML::colgroup(array('span' => $this->_options['cols'],
1563                                                                'width' => $width)),
1564                                           $cols));
1565             return $out;
1566         }
1567
1568         // Ignore azhead if not sorted by pagename
1569         if (!empty($this->_options['azhead'])
1570             and strstr($this->sortby($this->_options['sortby'], 'init'), "pagename")
1571             )
1572         {
1573             $cur_h = substr($this->_pages[0]->getName(), 0, 1);
1574             $out->pushContent(HTML::h3($cur_h));
1575             // group those pages together with same $h
1576             $j = 0;
1577             for ($i=0; $i < count($this->_pages); $i++) {
1578                 $page =& $this->_pages[$i];
1579                 $h = substr($page->getName(), 0, 1);
1580                 if ($h != $cur_h and $i > $j) {
1581                     $this->_saveOptions(array('cols' => 0, 'azhead' => 0));
1582                     $this->_pages = array_slice($this->_pages, $j, $i - $j);
1583                     $out->pushContent($this->_generateList());
1584                     $this->_restoreOptions();
1585                     $j = $i;
1586                     $out->pushContent(HTML::h3($h));
1587                     $cur_h = $h;
1588                 }
1589             }
1590             if ($i > $j) { // flush the rest
1591                 $this->_saveOptions(array('cols' => 0, 'azhead' => 0));
1592                 $this->_pages = array_slice($this->_pages, $j, $i - $j);
1593                 $out->pushContent($this->_generateList());
1594                 $this->_restoreOptions();
1595             }
1596             return $out;
1597         }
1598
1599         if ($this->_options['listtype'] == 'comma')
1600             $this->_options['comma'] = 2;
1601         if (!empty($this->_options['comma'])) {
1602             if ($this->_options['comma'] == 1)
1603                 $out->pushContent($this->_generateCommaListAsString());
1604             else
1605                 $out->pushContent($this->_generateCommaList($this->_options['comma']));
1606             return $out;
1607         }
1608
1609         if ($this->_options['listtype'] == 'ol')
1610             $this->_options['ordered'] = 1;
1611         elseif ($this->_options['listtype'] == 'ul')
1612             $this->_options['ordered'] = 0;
1613         if (!empty($this->_options['ordered']))
1614             $list = HTML::ol(array('class' => 'pagelist'));
1615         elseif ($this->_options['listtype'] == 'dl') {
1616             $list = HTML::dl(array('class' => 'pagelist'));
1617         } else {
1618             $list = HTML::ul(array('class' => 'pagelist'));
1619         }
1620         $i = 0;
1621         //TODO: currently we ignore limit here and hope that the backend didn't ignore it. (BackLinks)
1622         if (!empty($this->_options['limit']))
1623             list($offset, $pagesize) = $this->limit($this->_options['limit']);
1624         else
1625             $pagesize=0;
1626         foreach ($this->_pages as $pagenum => $page) {
1627             $pagehtml = $this->_renderPageRow($page);
1628             if (!$pagehtml) continue;
1629             $group = ($i++ / $this->_group_rows);
1630             //TODO: here we switch every row, in tables every third.
1631             //      unification or parametrized?
1632             $class = ($group % 2) ? 'oddrow' : 'evenrow';
1633             if ($this->_options['listtype'] == 'dl') {
1634                 $header = WikiLink($page);
1635                 //if ($this->_sortby['hi_content'])
1636                 $list->pushContent(HTML::dt(array('class' => $class), $header),
1637                                    HTML::dd(array('class' => $class), $pagehtml));
1638             } else
1639                 $list->pushContent(HTML::li(array('class' => $class), $pagehtml));
1640             if ($pagesize and $i > $pagesize) break;
1641         }
1642         $out->pushContent($list);
1643         if ( $do_paging and $tokens ) {
1644             $out->pushContent(HTML::table($paging));
1645         }
1646         return $out;
1647     }
1648
1649     // comma=1
1650     // Condense list without a href links: "Page1, Page2, ..."
1651     // Alternative $seperator = HTML::Raw(' &middot; ')
1652     // FIXME: only unique list entries, esp. with nopage
1653     function _generateCommaListAsString() {
1654         if (defined($this->_options['commasep']))
1655             $seperator = $this->_options['commasep'];
1656         else
1657             $seperator = ', ';
1658         $pages = array();
1659         foreach ($this->_pages as $pagenum => $page) {
1660             if ($s = $this->_renderPageRow($page)) // some pages are not viewable
1661                 $pages[] = is_string($s) ? $s : $s->asString();
1662         }
1663         return HTML(join($seperator, $pages));
1664     }
1665
1666     // comma=2
1667     // Normal WikiLink list.
1668     // Future: 1 = reserved for plain string (see above)
1669     //         2 and more => HTML link specialization?
1670     // FIXME: only unique list entries, esp. with nopage
1671     function _generateCommaList($style = false) {
1672         if (defined($this->_options['commasep']))
1673             $seperator = HTLM::Raw($this->_options['commasep']);
1674         else
1675             $seperator = ', ';
1676         $html = HTML();
1677         $html->pushContent($this->_renderPageRow($this->_pages[0]));
1678         next($this->_pages);
1679         foreach ($this->_pages as $pagenum => $page) {
1680             if ($s = $this->_renderPageRow($page)) // some pages are not viewable
1681                 $html->pushContent($seperator, $s);
1682         }
1683         return $html;
1684     }
1685
1686     function _emptyList($caption) {
1687         $html = HTML();
1688         if ($caption)
1689             $html->pushContent(HTML::p($caption));
1690         if ($this->_messageIfEmpty)
1691             $html->pushContent(HTML::blockquote(HTML::p($this->_messageIfEmpty)));
1692         return $html;
1693     }
1694
1695 };
1696
1697 /* List pages with checkboxes to select from.
1698  * The [Select] button toggles via Javascript flipAll
1699  */
1700
1701 class PageList_Selectable
1702 extends PageList {
1703
1704     function PageList_Selectable ($columns=false, $exclude='', $options = false) {
1705         if ($columns) {
1706             if (!is_array($columns))
1707                 $columns = explode(',', $columns);
1708             if (!in_array('checkbox',$columns))
1709                 array_unshift($columns,'checkbox');
1710         } else {
1711             $columns = array('checkbox','pagename');
1712         }
1713         $this->PageList($columns, $exclude, $options);
1714     }
1715
1716     function addPageList ($array) {
1717         while (list($pagename,$selected) = each($array)) {
1718             if ($selected) $this->addPageSelected((string)$pagename);
1719             $this->addPage((string)$pagename);
1720         }
1721     }
1722
1723     function addPageSelected ($pagename) {
1724         $this->_selected[$pagename] = 1;
1725     }
1726 }
1727
1728 class PageList_Unselectable
1729 extends PageList {
1730
1731     function PageList_Unselectable ($columns=false, $exclude='', $options = false) {
1732         if ($columns) {
1733             if (!is_array($columns))
1734                 $columns = explode(',', $columns);
1735         } else {
1736             $columns = array('pagename');
1737         }
1738         $this->PageList($columns, $exclude, $options);
1739     }
1740
1741     function addPageList ($array) {
1742         while (list($pagename,$selected) = each($array)) {
1743             if ($selected) $this->addPageSelected((string)$pagename);
1744             $this->addPage((string)$pagename);
1745         }
1746     }
1747
1748     function addPageSelected ($pagename) {
1749         $this->_selected[$pagename] = 1;
1750     }
1751 }
1752
1753 // (c-file-style: "gnu")
1754 // Local Variables:
1755 // mode: php
1756 // tab-width: 8
1757 // c-basic-offset: 4
1758 // c-hanging-comment-ender-p: nil
1759 // indent-tabs-mode: nil
1760 // End:
1761 ?>