lib/PageList.php

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