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