lib/PageList.php

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