lib/PageList.php

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