1 <?php rcs_id('$Id: PageList.php,v 1.154 2008-03-17 19:07:51 rurban Exp $');
4 * List a number of pagenames, optionally as table with various columns.
5 * This library relieves some work for these plugins:
7 * AllPages, BackLinks, LikePages, MostPopular, TitleSearch, WikiAdmin* and more
9 * It also allows dynamic expansion of those plugins to include more
10 * columns in their output.
12 * Column 'info=' arguments:
14 * 'pagename' _("Page Name")
15 * 'mtime' _("Last Modified")
17 * 'summary' _("Last Summary")
18 * 'version' _("Version")),
19 * 'author' _("Last Author")),
20 * 'locked' _("Locked"), _("locked")
21 * 'minor' _("Minor Edit"), _("minor")
22 * 'markup' _("Markup")
24 * 'creator' _("Creator")
26 * 'checkbox' selectable checkbox at the left.
29 * Special, custom columns: Either theme or plugin (WikiAdmin*) specific.
30 * 'remove' _("Remove")
31 * 'perm' _("Permission Mask")
33 * 'renamed_pagename' _("Rename to")
34 * 'ratingwidget', ... wikilens theme specific.
35 * 'custom' See plugin/_WikiTranslation
37 * Symbolic 'info=' arguments:
38 * 'all' All columns except the special columns
39 * 'most' pagename, mtime, author, size, hits, ...
40 * 'some' pagename, mtime, author
42 * FIXME: In this refactoring I (Jeff) have un-implemented _ctime, _cauthor, and
43 * number-of-revision. Note the _ctime and _cauthor as they were implemented
44 * were somewhat flawed: revision 1 of a page doesn't have to exist in the
45 * database. If lots of revisions have been made to a page, it's more than likely
46 * that some older revisions (include revision 1) have been cleaned (deleted).
49 * paging support: limit, offset args
50 * check PagePerm "list" access-type,
51 * all columns are sortable. Thanks to the wikilens team.
52 * cols > 1, comma, azhead, ordered (OL lists)
53 * ->supportedArgs() which arguments are supported, so that the plugin
54 * doesn't explictly need to declare it
56 * fix sortby logic, fix multiple sortby and other paging args per page.
57 * info=relation,linkto nopage=1
58 * use custom format method (RecentChanges, rss, ...)
61 * fix memory exhaustion on large pagelists with old --memory-limit php's only.
62 * Status: improved 2004-06-25 16:19:36 rurban
64 class _PageList_Column_base {
65 var $_tdattr = array();
67 function _PageList_Column_base ($default_heading, $align = false) {
68 $this->_heading = $default_heading;
71 // align="char" isn't supported by any browsers yet :(
72 //if (is_array($align))
73 // $this->_tdattr = $align;
75 $this->_tdattr['align'] = $align;
79 function format ($pagelist, $page_handle, &$revision_handle) {
80 $nbsp = HTML::raw(' ');
81 return HTML::td($this->_tdattr,
83 $this->_getValue($page_handle, $revision_handle),
87 function getHeading () {
88 return $this->_heading;
91 function setHeading ($heading) {
92 $this->_heading = $heading;
98 $nbsp = HTML::raw(' ');
100 if (1 /* or in_array($this->_field, PageList::sortable_columns())*/) {
101 // multiple comma-delimited sortby args: "+hits,+pagename"
102 // asc or desc: +pagename, -pagename
103 $sortby = PageList::sortby($this->_field, 'flip_order');
104 //Fixme: pass all also other GET args along. (limit, p[])
105 //TODO: support GET and POST
106 $s = HTML::a(array('href' =>
107 $request->GetURLtoSelf(array('sortby' => $sortby)),
108 'class' => 'pagetitle',
109 'title' => sprintf(_("Sort by %s"), $this->_field)),
110 $nbsp, HTML::u($this->_heading), $nbsp);
112 $s = HTML($nbsp, HTML::u($this->_heading), $nbsp);
114 return HTML::th(array('align' => 'center'),$s);
117 // new grid-style sortable heading
118 // TODO: via activeui.js ? (fast dhtml sorting)
119 function button_heading (&$pagelist, $colNum) {
120 global $WikiTheme, $request;
122 $nbsp = HTML::raw(' ');
123 if (!$WikiTheme->DUMP_MODE /* or in_array($this->_field, PageList::sortable_columns()) */) {
124 // TODO: add to multiple comma-delimited sortby args: "+hits,+pagename"
126 $noimg_src = $WikiTheme->getButtonURL('no_order');
128 $noimg = HTML::img(array('src' => $noimg_src,
135 if ($pagelist->sortby($colNum, 'check')) { // show icon? request or plugin arg
136 $sortby = $pagelist->sortby($colNum, 'flip_order');
137 $desc = (substr($sortby,0,1) == '-'); // +pagename or -pagename
138 $src = $WikiTheme->getButtonURL($desc ? 'asc_order' : 'desc_order');
139 $reverse = $desc ? _("reverse")." " : "";
141 // initially unsorted
142 $sortby = $pagelist->sortby($colNum, 'get');
147 $img->setAttr('alt', ".");
149 $img = HTML::img(array('src' => $src,
153 'alt' => _("Click to reverse sort order")));
155 $s = HTML::a(array('href' =>
156 //Fixme: pass all also other GET args along. (limit is ok, p[])
157 $request->GetURLtoSelf(array('sortby' => $sortby,
158 'id' => $pagelist->id)),
159 'class' => 'gridbutton',
160 'title' => sprintf(_("Click to sort by %s"), $reverse . $this->_field)),
162 $nbsp, $this->_heading,
166 $s = HTML($nbsp, $this->_heading, $nbsp);
168 return HTML::th(array('align' => 'center', 'valign' => 'middle',
169 'class' => 'gridbutton'), $s);
173 * Take two columns of this type and compare them.
174 * An undefined value is defined to be < than the smallest defined value.
175 * This base class _compare only works if the value is simple (e.g., a number).
177 * @param $colvala $this->_getValue() of column a
178 * @param $colvalb $this->_getValue() of column b
180 * @return -1 if $a < $b, 1 if $a > $b, 0 otherwise.
182 function _compare($colvala, $colvalb) {
183 if (is_string($colvala))
184 return strcmp($colvala,$colvalb);
186 if (($colvala === $colvalb) || (!isset($colvala) && !isset($colvalb))) {
189 $ret = (!isset($colvala) || ($colvala < $colvalb)) ? -1 : 1;
195 class _PageList_Column extends _PageList_Column_base {
196 function _PageList_Column ($field, $default_heading, $align = false) {
197 $this->_PageList_Column_base($default_heading, $align);
199 $this->_need_rev = substr($field, 0, 4) == 'rev:';
200 $this->_iscustom = substr($field, 0, 7) == 'custom:';
201 if ($this->_iscustom) {
202 $this->_field = substr($field, 7);
204 elseif ($this->_need_rev)
205 $this->_field = substr($field, 4);
207 $this->_field = $field;
210 function _getValue ($page_handle, &$revision_handle) {
211 if ($this->_need_rev) {
212 if (!$revision_handle)
213 // columns which need the %content should override this. (size, hi_content)
214 $revision_handle = $page_handle->getCurrentRevision(false);
215 return $revision_handle->get($this->_field);
218 return $page_handle->get($this->_field);
222 function _getSortableValue ($page_handle, &$revision_handle) {
223 $val = $this->_getValue($page_handle, $revision_handle);
224 if ($this->_field == 'hits')
226 elseif (is_object($val) && method_exists($val, 'asString'))
227 return $val->asString();
229 return (string) $val;
233 /* overcome a call_user_func limitation by not being able to do:
234 * call_user_func_array(array(&$class, $class_name), $params);
235 * So we need $class = new $classname($params);
236 * And we add a 4th param to get at the parent $pagelist object
238 class _PageList_Column_custom extends _PageList_Column {
239 function _PageList_Column_custom($params) {
240 $this->_pagelist =& $params[3];
241 $this->_PageList_Column($params[0], $params[1], $params[2]);
245 class _PageList_Column_size extends _PageList_Column {
246 function format (&$pagelist, $page_handle, &$revision_handle) {
247 return HTML::td($this->_tdattr,
249 $this->_getValue($pagelist, $page_handle, $revision_handle),
250 HTML::raw(' '));
253 function _getValue (&$pagelist, $page_handle, &$revision_handle) {
254 if (!$revision_handle or (!$revision_handle->_data['%content']
255 or $revision_handle->_data['%content'] === true)) {
256 $revision_handle = $page_handle->getCurrentRevision(true);
257 unset($revision_handle->_data['%pagedata']['_cached_html']);
259 $size = $this->_getSize($revision_handle);
260 // we can safely purge the content when it is not sortable
261 if (empty($pagelist->_sortby[$this->_field]))
262 unset($revision_handle->_data['%content']);
266 function _getSortableValue ($page_handle, &$revision_handle) {
267 if (!$revision_handle)
268 $revision_handle = $page_handle->getCurrentRevision(true);
269 return (empty($revision_handle->_data['%content']))
270 ? 0 : strlen($revision_handle->_data['%content']);
273 function _getSize($revision_handle) {
274 $bytes = @strlen($revision_handle->_data['%content']);
275 return ByteFormatter($bytes);
280 class _PageList_Column_bool extends _PageList_Column {
281 function _PageList_Column_bool ($field, $default_heading, $text = 'yes') {
282 $this->_PageList_Column($field, $default_heading, 'center');
283 $this->_textIfTrue = $text;
284 $this->_textIfFalse = new RawXml('—'); //mdash
287 function _getValue ($page_handle, &$revision_handle) {
288 //FIXME: check if $this is available in the parent (->need_rev)
289 $val = _PageList_Column::_getValue($page_handle, $revision_handle);
290 return $val ? $this->_textIfTrue : $this->_textIfFalse;
294 class _PageList_Column_checkbox extends _PageList_Column {
295 function _PageList_Column_checkbox ($field, $default_heading, $name='p') {
296 $this->_name = $name;
297 $heading = HTML::input(array('type' => 'button',
298 'title' => _("Click to de-/select all pages"),
300 'name' => $default_heading,
301 'value' => $default_heading,
302 'onclick' => "flipAll(this.form)"
304 $this->_PageList_Column($field, $heading, 'center');
306 function _getValue ($pagelist, $page_handle, &$revision_handle) {
307 $pagename = $page_handle->getName();
308 $selected = !empty($pagelist->_selected[$pagename]);
309 if (strstr($pagename,'[') or strstr($pagename,']')) {
310 $pagename = str_replace(array('[',']'),array('%5B','%5D'),$pagename);
313 return HTML::input(array('type' => 'checkbox',
314 'name' => $this->_name . "[$pagename]",
316 'checked' => 'CHECKED'));
318 return HTML::input(array('type' => 'checkbox',
319 'name' => $this->_name . "[$pagename]",
323 function format ($pagelist, $page_handle, &$revision_handle) {
324 return HTML::td($this->_tdattr,
326 $this->_getValue($pagelist, $page_handle, $revision_handle),
327 HTML::raw(' '));
329 // don't sort this javascript button
330 function button_heading ($pagelist, $colNum) {
331 $s = HTML(HTML::raw(' '), $this->_heading, HTML::raw(' '));
332 return HTML::th(array('align' => 'center', 'valign' => 'middle',
333 'class' => 'gridbutton'), $s);
337 class _PageList_Column_time extends _PageList_Column {
338 function _PageList_Column_time ($field, $default_heading) {
339 $this->_PageList_Column($field, $default_heading, 'right');
341 $this->Theme = &$WikiTheme;
344 function _getValue ($page_handle, &$revision_handle) {
345 $time = _PageList_Column::_getValue($page_handle, $revision_handle);
346 return $this->Theme->formatDateTime($time);
349 function _getSortableValue ($page_handle, &$revision_handle) {
350 return _PageList_Column::_getValue($page_handle, $revision_handle);
354 class _PageList_Column_version extends _PageList_Column {
355 function _getValue ($page_handle, &$revision_handle) {
356 if (!$revision_handle)
357 $revision_handle = $page_handle->getCurrentRevision();
358 return $revision_handle->getVersion();
362 // Output is hardcoded to limit of first 50 bytes. Otherwise
363 // on very large Wikis this will fail if used with AllPages
364 // (PHP memory limit exceeded)
365 class _PageList_Column_content extends _PageList_Column {
366 function _PageList_Column_content ($field, $default_heading, $align = false, $search = false) {
367 $this->_PageList_Column($field, $default_heading, $align);
369 $this->search = $search;
370 if ($field == 'content') {
371 $this->_heading .= sprintf(_(" ... first %d bytes"),
373 } elseif ($field == 'rev:hi_content') {
374 global $HTTP_POST_VARS;
375 if (!$this->search and !empty($HTTP_POST_VARS['admin_replace'])) {
376 $this->search = $HTTP_POST_VARS['admin_replace']['from'];
378 $this->_heading .= sprintf(_(" ... around %s"),
379 '»'.$this->search.'«');
383 function _getValue ($page_handle, &$revision_handle) {
384 if (!$revision_handle or (!$revision_handle->_data['%content']
385 or $revision_handle->_data['%content'] === true)) {
386 $revision_handle = $page_handle->getCurrentRevision(true);
388 // Not sure why implode is needed here, I thought
389 // getContent() already did this, but it seems necessary.
390 $c = implode("\n", $revision_handle->getContent());
391 if (empty($pagelist->_sortby[$this->_field]))
392 unset($revision_handle->_data['%content']);
393 if ($this->_field == 'hi_content') {
394 if (!empty($revision_handle->_data['%pagedata']))
395 unset($revision_handle->_data['%pagedata']['_cached_html']);
396 $search = $this->search;
398 if (!empty($page_handle->score))
399 $score = $page_handle->score;
400 elseif (!empty($page_handle['score']))
401 $score = $page_handle['score'];
402 if ($search and ($i = strpos(strtolower($c), strtolower($search)))) {
403 $l = strlen($search);
404 $j = max(0, $i - ($this->bytes / 2));
405 return HTML::div(array('style' => 'font-size:x-small'),
406 HTML::div(array('class' => 'transclusion'),
407 HTML::span("...".substr($c, $j, ($this->bytes / 2))),
408 HTML::span(array("style"=>"background:yellow"),substr($c, $i, $l)),
409 HTML::span(substr($c, $i+$l, ($this->bytes / 2))."..."." ".($score ? sprintf("[%0.1f]",$score):""))));
414 $c = sprintf(_("%s not found"), '»'.$search.'«');
415 return HTML::div(array('style' => 'font-size:x-small','align'=>'center'),
416 $c." ".($score ? sprintf("[%0.1f]",$score):""));
418 } elseif (($len = strlen($c)) > $this->bytes) {
419 $c = substr($c, 0, $this->bytes);
421 include_once('lib/BlockParser.php');
422 // false --> don't bother processing hrefs for embedded WikiLinks
423 $ct = TransformText($c, $revision_handle->get('markup'), false);
424 if (empty($pagelist->_sortby[$this->_field]))
425 unset($revision_handle->_data['%pagedata']['_cached_html']);
426 return HTML::div(array('style' => 'font-size:x-small'),
427 HTML::div(array('class' => 'transclusion'), $ct),
428 // Don't show bytes here if size column present too
429 ($this->parent->_columns_seen['size'] or !$len) ? "" :
430 ByteFormatter($len, /*$longformat = */true));
432 function _getSortableValue ($page_handle, &$revision_handle) {
433 if (!empty($page_handle->score))
434 return $page_handle->score;
435 elseif (!empty($page_handle['score']))
436 return $page_handle['score'];
438 return substr(_PageList_Column::_getValue($page_handle, $revision_handle),0,50);
442 class _PageList_Column_author extends _PageList_Column {
443 function _PageList_Column_author ($field, $default_heading, $align = false) {
444 _PageList_Column::_PageList_Column($field, $default_heading, $align);
445 $this->dbi =& $GLOBALS['request']->getDbh();
448 function _getValue ($page_handle, &$revision_handle) {
449 $author = _PageList_Column::_getValue($page_handle, $revision_handle);
450 if ($this->dbi->isWikiPage($author))
451 return WikiLink($author);
456 function _getSortableValue ($page_handle, &$revision_handle) {
457 return _PageList_Column::_getValue($page_handle, $revision_handle);
461 class _PageList_Column_owner extends _PageList_Column_author {
462 function _getValue ($page_handle, &$revision_handle) {
463 $author = $page_handle->getOwner();
464 if ($this->dbi->isWikiPage($author))
465 return WikiLink($author);
469 function _getSortableValue ($page_handle, &$revision_handle) {
470 return _PageList_Column::_getValue($page_handle, $revision_handle);
474 class _PageList_Column_creator extends _PageList_Column_author {
475 function _getValue ($page_handle, &$revision_handle) {
476 $author = $page_handle->getCreator();
477 if ($this->dbi->isWikiPage($author))
478 return WikiLink($author);
482 function _getSortableValue ($page_handle, &$revision_handle) {
483 return _PageList_Column::_getValue($page_handle, $revision_handle);
487 class _PageList_Column_pagename extends _PageList_Column_base {
488 var $_field = 'pagename';
490 function _PageList_Column_pagename () {
491 $this->_PageList_Column_base(_("Page Name"));
493 $this->dbi = &$request->getDbh();
496 function _getValue ($page_handle, &$revision_handle) {
497 if ($this->dbi->isWikiPage($page_handle->getName()))
498 return WikiLink($page_handle, 'known');
500 return WikiLink($page_handle, 'unknown');
503 function _getSortableValue ($page_handle, &$revision_handle) {
504 return $page_handle->getName();
508 * Compare two pagenames for sorting. See _PageList_Column::_compare.
510 function _compare($colvala, $colvalb) {
511 return strcmp($colvala, $colvalb);
516 var $_group_rows = 3;
517 var $_columns = array();
518 var $_columnsMap = array(); // Maps column name to column number.
519 var $_excluded_pages = array();
520 var $_pages = array();
522 var $_pagename_seen = false;
523 var $_types = array();
524 var $_options = array();
525 var $_selected = array();
526 var $_sortby = array();
529 function PageList ($columns = false, $exclude = false, $options = false) {
530 // unique id per pagelist on each page.
531 if (!isset($GLOBALS['request']->_pagelist))
532 $GLOBALS['request']->_pagelist = 0;
534 $GLOBALS['request']->_pagelist++;
535 $this->id = $GLOBALS['request']->_pagelist;
536 if ($GLOBALS['request']->getArg('count'))
537 $options['count'] = $GLOBALS['request']->getArg('count');
539 $this->_options = $options;
541 $this->_initAvailableColumns();
542 // let plugins predefine only certain objects, such its own custom pagelist columns
545 'all' => array_diff(array_keys($this->_types), // all but...
546 array('checkbox','remove','renamed_pagename',
547 'content','hi_content','perm','acl')),
548 'most' => array('pagename','mtime','author','hits'),
549 'some' => array('pagename','mtime','author')
551 if (isset($this->_options['listtype'])
552 and $this->_options['listtype'] == 'dl')
553 $this->_options['nopage'] = 1;
555 if (!is_array($columns))
556 $columns = explode(',', $columns);
557 // expand symbolic columns:
558 foreach ($symbolic_columns as $symbol => $cols) {
559 if (in_array($symbol,$columns)) { // e.g. 'checkbox,all'
560 $columns = array_diff(array_merge($columns,$cols),array($symbol));
564 if (empty($this->_options['nopage']) and !in_array('pagename',$columns))
565 $this->_addColumn('pagename');
566 foreach ($columns as $col) {
568 $this->_addColumn($col);
572 // If 'pagename' is already present, _addColumn() will not add it again
573 if (empty($this->_options['nopage']))
574 $this->_addColumn('pagename');
576 if (!empty($this->_options['types'])) {
577 foreach ($this->_options['types'] as $type) {
578 $this->_types[$type->_field] = $type;
579 $this->_addColumn($type->_field);
581 unset($this->_options['types']);
585 // explicit header options: ?id=x&sortby=... override options[]
586 // support multiple sorts. check multiple, no nested elseif
587 if (($this->id == $request->getArg("id"))
588 and $request->getArg('sortby'))
590 // add it to the front of the sortby array
591 $this->sortby($request->getArg('sortby'), 'init');
592 $this->_options['sortby'] = $request->getArg('sortby');
594 if (!empty($options['sortby'])) {
595 if (empty($this->_options['sortby']))
596 $this->_options['sortby'] = $options['sortby'];
597 $this->sortby($options['sortby'], 'init');
599 if (!isset($request->args["id"]) and $request->getArg('sortby')
600 and empty($this->_options['sortby']))
602 $this->_options['sortby'] = $request->getArg('sortby');
603 $this->sortby($this->_options['sortby'], 'init');
605 // same as above but without the special sortby push, and mutually exclusive (elseif)
606 foreach ($this->pagingArgs() as $key) {
607 if ($key == 'sortby') continue;
608 if (($this->id == $request->getArg("id"))
609 and $request->getArg($key))
611 $this->_options[$key] = $request->getArg($key);
613 elseif (!empty($options) and !empty($options[$key])) {
614 $this->_options[$key] = $options[$key];
616 elseif (!isset($request->args["id"]) and $request->getArg($key)) {
617 $this->_options[$key] = $request->getArg($key);
620 $this->_options[$key] = false;
623 if (is_string($exclude) and !is_array($exclude))
624 $exclude = $this->explodePageList($exclude, false,
625 $this->_options['sortby'],
626 $this->_options['limit']);
627 $this->_excluded_pages = $exclude;
629 $this->_messageIfEmpty = _("<no matches>");
632 // Currently PageList takes these arguments:
633 // 1: info, 2: exclude, 3: hash of options
634 // Here we declare which options are supported, so that
635 // the calling plugin may simply merge this with its own default arguments
636 function supportedArgs () {
637 // Todo: add all supported Columns, like locked, minor, ...
638 return array(// Currently supported options:
639 /* what columns, what pages */
640 'info' => 'pagename',
641 'exclude' => '', // also wildcards, comma-seperated lists
642 // and <!plugin-list !> arrays
643 /* select pages by meta-data: */
644 'author' => false, // current user by []
645 'owner' => false, // current user by []
646 'creator' => false, // current user by []
648 /* for the sort buttons in <th> */
649 'sortby' => '', // same as for WikiDB::getAllPages
650 // (unsorted is faster)
652 /* PageList pager options:
653 * These options may also be given to _generate(List|Table) later
654 * But limit and offset might help the query WikiDB::getAllPages()
656 'limit' => 50, // number of rows (pagesize)
657 'paging' => 'auto', // 'auto' top + bottom rows if applicable
658 // // 'top' top only if applicable
659 // // 'bottom' bottom only if applicable
660 // // 'none' don't page at all
661 // (TODO: clarify what if $paging==false ?)
663 /* list-style options (with single pagename column only so far) */
664 'cols' => 1, // side-by-side display of list (1-3)
665 'azhead' => 0, // 1: group by initials
666 // 2: provide shortcut links to initials also
667 'comma' => 0, // condensed comma-seperated list,
668 // 1 if without links, 2 if with
669 'commasep' => false, // Default: ', '
670 'listtype' => '', // ul (default), ol, dl, comma
671 'ordered' => false, // OL or just UL lists (ignored for comma)
672 'linkmore' => '', // If count>0 and limit>0 display a link with
673 // the number of all results, linked to the given pagename.
675 'nopage' => false, // for info=col omit the pagename column
676 // array_keys($this->_types). filter by columns: e.g. locked=1
677 'pagename' => null, // string regex
688 function pagingArgs() {
689 return array('sortby','limit','paging','count','dosort');
692 function setCaption ($caption_string) {
693 $this->_caption = $caption_string;
696 function addCaption ($caption_string) {
697 $this->_caption = HTML($this->_caption," ",$caption_string);
700 function getCaption () {
701 // put the total into the caption if needed
702 if (is_string($this->_caption) && strstr($this->_caption, '%d'))
703 return sprintf($this->_caption, $this->getTotal());
704 return $this->_caption;
707 function setMessageIfEmpty ($msg) {
708 $this->_messageIfEmpty = $msg;
712 function getTotal () {
713 return !empty($this->_options['count'])
714 ? (integer) $this->_options['count'] : count($this->_pages);
717 function isEmpty () {
718 return empty($this->_pages);
721 function addPage($page_handle) {
722 if (!empty($this->_excluded_pages)) {
723 if (!in_array((is_string($page_handle) ? $page_handle : $page_handle->getName()),
724 $this->_excluded_pages))
725 $this->_pages[] = $page_handle;
727 $this->_pages[] = $page_handle;
731 function pageNames() {
733 $limit = @$this->_options['limit'];
734 foreach ($this->_pages as $page_handle) {
735 $pages[] = $page_handle->getName();
736 if ($limit and count($pages) > $limit)
742 function _getPageFromHandle($page_handle) {
743 if (is_string($page_handle)) {
744 if (empty($page_handle)) return $page_handle;
745 //$dbi = $GLOBALS['request']->getDbh(); // no, safe some memory!
746 $page_handle = $GLOBALS['request']->_dbi->getPage($page_handle);
752 * Take a PageList_Page object, and return an HTML object to display
753 * it in a table or list row.
755 function _renderPageRow (&$page_handle, $i = 0) {
756 $page_handle = $this->_getPageFromHandle($page_handle);
757 //FIXME. only on sf.net
758 if (!is_object($page_handle)) {
759 trigger_error("PageList: Invalid page_handle $page_handle", E_USER_WARNING);
762 if (!isset($page_handle)
763 or empty($page_handle)
764 or (!empty($this->_excluded_pages)
765 and in_array($page_handle->getName(), $this->_excluded_pages)))
766 return; // exclude page.
768 // enforce view permission
769 if (!mayAccessPage('view', $page_handle->getName()))
772 $group = (int)($i / $this->_group_rows);
773 $class = ($group % 2) ? 'oddrow' : 'evenrow';
774 $revision_handle = false;
775 $this->_maxlen = max($this->_maxlen, strlen($page_handle->getName()));
777 if (count($this->_columns) > 1) {
778 $row = HTML::tr(array('class' => $class));
780 foreach ($this->_columns as $col) {
781 $col->current_row = $i;
782 $col->current_column = $j;
783 $row->pushContent($col->format($this, $page_handle, $revision_handle));
787 $col = $this->_columns[0];
788 $col->current_row = $i;
789 $col->current_column = 0;
790 $row = $col->_getValue($page_handle, $revision_handle);
796 /* ignore from, but honor limit */
797 function addPages ($page_iter) {
798 // TODO: if limit check max(strlen(pagename))
800 if (isset($this->_options['limit'])) { // extract from,count from limit
801 list($from, $limit) = WikiDB_backend::limit($this->_options['limit']);
806 while ($page = $page_iter->next()) {
808 if ($from and $i < $from)
810 if (!$limit or ($limit and $i < $limit))
811 $this->addPage($page);
813 if (empty($this->_options['count']))
814 $this->_options['count'] = $i;
817 function addPageList (&$list) {
818 if (empty($list)) return; // Protect reset from a null arg
819 if (isset($this->_options['limit'])) { // extract from,count from limit
820 list($from, $limit) = WikiDB_backend::limit($this->_options['limit']);
826 foreach ($list as $page) {
828 if ($from and $i < $from)
830 if (!$limit or ($limit and $i < $limit)) {
831 if (is_object($page)) $page = $page->_pagename;
832 $this->addPage((string)$page);
839 $dbi =& $request->getDbh();
840 if (isa($dbi,'WikiDB_SQL')) {
841 extract($dbi->_backend->_table_names);
842 $res = $dbi->_backend->_dbh->getOne("SELECT max(length(pagename)) FROM $page_tbl");
843 if (DB::isError($res) || empty($res)) return false;
845 } elseif (isa($dbi,'WikiDB_ADODB')) {
846 extract($dbi->_backend->_table_names);
847 $row = $dbi->_backend->_dbh->getRow("SELECT max(length(pagename)) FROM $page_tbl");
848 return $row ? $row[0] : false;
853 function getContent() {
854 // Note that the <caption> element wants inline content.
855 $caption = $this->getCaption();
857 if ($this->isEmpty())
858 return $this->_emptyList($caption);
859 elseif (isset($this->_options['listtype'])
860 and in_array($this->_options['listtype'],
861 array('ol','ul','comma','dl')))
862 return $this->_generateList($caption);
863 elseif (count($this->_columns) == 1)
864 return $this->_generateList($caption);
866 return $this->_generateTable($caption);
869 function printXML() {
870 PrintXML($this->getContent());
874 return AsXML($this->getContent());
878 * Handle sortby requests for the DB iterator and table header links.
879 * Prefix the column with + or - like "+pagename","-mtime", ...
882 * 'init' : unify with predefined order. "pagename" => "+pagename"
883 * 'flip_order' : "mtime" => "+mtime" => "-mtime" ...
884 * 'db' : "-pagename" => "pagename DESC"
887 * Now all columns are sortable. (patch by DanFr)
888 * Some columns have native DB backend methods, some not.
890 function sortby ($column, $action, $valid_fields=false) {
893 if (empty($column)) return '';
894 if (is_int($column)) {
895 $column = $this->_columns[$column - 1]->_field;
896 //$column = $col->_field;
898 //if (!is_string($column)) return '';
899 // support multiple comma-delimited sortby args: "+hits,+pagename"
901 if (strstr($column, ',')) {
902 $result = ($action == 'check') ? true : array();
903 foreach (explode(',', $column) as $col) {
904 if ($action == 'check')
905 $result = $result && $this->sortby($col, $action, $valid_fields);
907 $result[] = $this->sortby($col, $action, $valid_fields);
909 // 'check' returns true/false for every col. return true if all are true.
910 // i.e. the unsupported 'every' operator in functional languages.
911 if ($action == 'check')
914 return join(",", $result);
916 if (substr($column,0,1) == '+') {
917 $order = '+'; $column = substr($column,1);
918 } elseif (substr($column,0,1) == '-') {
919 $order = '-'; $column = substr($column,1);
921 // default initial order: +pagename, -mtime, -hits
923 if (!empty($this->_sortby[$column]))
924 $order = $this->_sortby[$column];
926 if (in_array($column, array('mtime','hits')))
932 if ($action == 'get') {
933 return $order . $column;
934 } elseif ($action == 'flip_order') {
936 trigger_error("flip $order $column ".$this->id, E_USER_NOTICE);
937 return ($order == '+' ? '-' : '+') . $column;
938 } elseif ($action == 'init') { // only allowed from PageList::PageList
939 if ($this->sortby($column, 'clicked')) {
941 trigger_error("clicked $order $column $this->id", E_USER_NOTICE);
942 //$order = ($order == '+' ? '-' : '+'); // $this->sortby($sortby, 'flip_order');
944 $this->_sortby[$column] = $order; // forces show icon
945 return $order . $column;
946 } elseif ($action == 'check') { // show icon?
947 //if specified via arg or if clicked
948 $show = (!empty($this->_sortby[$column]) or $this->sortby($column, 'clicked'));
949 if (0 and $show and DEBUG) {
950 trigger_error("show $order $column ".$this->id, E_USER_NOTICE);
953 } elseif ($action == 'clicked') { // flip sort order?
955 $arg = $request->getArg('sortby');
957 and strstr($arg, $column)
958 and (!isset($request->args['id'])
959 or $this->id == $request->getArg('id')));
960 } elseif ($action == 'db') {
961 // Performance enhancement: use native DB sort if possible.
962 if (($valid_fields and in_array($column, $valid_fields))
963 or (method_exists($request->_dbi->_backend, 'sortable_columns')
964 and (in_array($column, $request->_dbi->_backend->sortable_columns())))) {
965 // omit this sort method from the _sortPages call at rendering
966 // asc or desc: +pagename, -pagename
967 return $column . ($order == '+' ? ' ASC' : ' DESC');
975 /* Splits pagelist string into array.
976 * Test* or Test1,Test2
977 * Limitation: Doesn't split into comma-sep and then expand wildcards.
978 * "Test1*,Test2*" is expanded into TextSearch "Test1* Test2*"
980 * echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
982 function explodePageList($input, $include_empty=false, $sortby='',
983 $limit='', $exclude='')
985 if (empty($input)) return array();
986 if (is_array($input)) return $input;
987 // expand wildcards from list of all pages
988 if (preg_match('/[\?\*]/', $input) or substr($input,0,1) == "^") {
989 include_once("lib/TextSearchQuery.php");
990 $search = new TextSearchQuery(str_replace(",", " ", $input), true,
991 (substr($input,0,1) == "^") ? 'posix' : 'glob');
992 $dbi = $GLOBALS['request']->getDbh();
993 $iter = $dbi->titleSearch($search, $sortby, $limit, $exclude);
995 while ($pagehandle = $iter->next()) {
996 $pages[] = $pagehandle->getName();
1000 //TODO: need an SQL optimization here
1001 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit,
1003 while ($pagehandle = $allPagehandles->next()) {
1004 $allPages[] = $pagehandle->getName();
1006 return explodeList($input, $allPages);
1009 //TODO: do the sorting, normally not needed if used for exclude only
1010 return explode(',', $input);
1014 // TODO: optimize getTotal => store in count
1015 function allPagesByAuthor($wildcard, $include_empty=false, $sortby='',
1016 $limit='', $exclude='')
1018 $dbi = $GLOBALS['request']->getDbh();
1019 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
1020 $allPages = array();
1021 if ($wildcard === '[]') {
1022 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
1023 if (!$wildcard) return $allPages;
1025 $do_glob = preg_match('/[\?\*]/', $wildcard);
1026 while ($pagehandle = $allPagehandles->next()) {
1027 $name = $pagehandle->getName();
1028 $author = $pagehandle->getAuthor();
1031 if (glob_match($wildcard, $author))
1032 $allPages[] = $name;
1033 } elseif ($wildcard == $author) {
1034 $allPages[] = $name;
1037 // TODO: purge versiondata_cache
1042 function allPagesByOwner($wildcard, $include_empty=false, $sortby='',
1043 $limit='', $exclude='') {
1044 $dbi = $GLOBALS['request']->getDbh();
1045 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
1046 $allPages = array();
1047 if ($wildcard === '[]') {
1048 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
1049 if (!$wildcard) return $allPages;
1051 $do_glob = preg_match('/[\?\*]/', $wildcard);
1052 while ($pagehandle = $allPagehandles->next()) {
1053 $name = $pagehandle->getName();
1054 $owner = $pagehandle->getOwner();
1057 if (glob_match($wildcard, $owner))
1058 $allPages[] = $name;
1059 } elseif ($wildcard == $owner) {
1060 $allPages[] = $name;
1067 function allPagesByCreator($wildcard, $include_empty=false, $sortby='',
1068 $limit='', $exclude='') {
1069 $dbi = $GLOBALS['request']->getDbh();
1070 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
1071 $allPages = array();
1072 if ($wildcard === '[]') {
1073 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
1074 if (!$wildcard) return $allPages;
1076 $do_glob = preg_match('/[\?\*]/', $wildcard);
1077 while ($pagehandle = $allPagehandles->next()) {
1078 $name = $pagehandle->getName();
1079 $creator = $pagehandle->getCreator();
1082 if (glob_match($wildcard, $creator))
1083 $allPages[] = $name;
1084 } elseif ($wildcard == $creator) {
1085 $allPages[] = $name;
1092 ////////////////////
1094 ////////////////////
1095 /** Plugin and theme hooks:
1096 * If the pageList is initialized with $options['types'] these types are also initialized,
1097 * overriding the standard types.
1099 function _initAvailableColumns() {
1100 global $customPageListColumns;
1104 => new _PageList_Column_content('rev:content', _("Content")),
1105 // new: plugin specific column types initialised by the relevant plugins
1107 'hi_content' // with highlighted search for SearchReplace
1108 => new _PageList_Column_content('rev:hi_content', _("Content")),
1110 => new _PageList_Column_remove('remove', _("Remove")),
1111 // initialised by the plugin
1113 => new _PageList_Column_renamed_pagename('rename', _("Rename to")),
1115 => new _PageList_Column_perm('perm', _("Permission")),
1117 => new _PageList_Column_acl('acl', _("ACL")),
1120 => new _PageList_Column_checkbox('p', _("All")),
1122 => new _PageList_Column_pagename,
1124 => new _PageList_Column_time('rev:mtime', _("Last Modified")),
1126 => new _PageList_Column('hits', _("Hits"), 'right'),
1128 => new _PageList_Column_size('rev:size', _("Size"), 'right'),
1129 /*array('align' => 'char', 'char' => ' ')*/
1131 => new _PageList_Column('rev:summary', _("Last Summary")),
1133 => new _PageList_Column_version('rev:version', _("Version"),
1136 => new _PageList_Column_author('rev:author', _("Last Author")),
1138 => new _PageList_Column_owner('author_id', _("Owner")),
1140 => new _PageList_Column_creator('author_id', _("Creator")),
1143 => new _PageList_Column_author('group', _("Group")),
1146 => new _PageList_Column_bool('locked', _("Locked"),
1149 => new _PageList_Column_bool('rev:is_minor_edit',
1150 _("Minor Edit"), _("minor")),
1152 => new _PageList_Column('rev:markup', _("Markup")),
1153 // 'rating' initialised by the wikilens theme hook: addPageListColumn
1156 => new _PageList_Column_rating('rating', _("Rate")),
1159 if (empty($this->_types))
1160 $this->_types = array();
1161 // add plugin specific pageList columns, initialized by $options['types']
1162 $this->_types = array_merge($standard_types, $this->_types);
1163 // add theme custom specific pageList columns:
1164 // set the 4th param as the current pagelist object.
1165 if (!empty($customPageListColumns)) {
1166 foreach ($customPageListColumns as $column => $params) {
1167 $class_name = array_shift($params);
1168 $params[3] =& $this;
1169 // ref to a class does not work with php-4
1170 $this->_types[$column] = new $class_name($params);
1175 function getOption($option) {
1176 if (array_key_exists($option, $this->_options)) {
1177 return $this->_options[$option];
1185 * Add a column to this PageList, given a column name.
1186 * The name is a type, and optionally has a : and a label. Examples:
1189 * pagename:This page
1191 * mtime:Last modified
1193 * If this function is called multiple times for the same type, the
1194 * column will only be added the first time, and ignored the succeeding times.
1195 * If you wish to add multiple columns of the same type, use addColumnObject().
1197 * @param column name
1198 * @return true if column is added, false otherwise
1200 function _addColumn ($column) {
1202 if (isset($this->_columns_seen[$column]))
1203 return false; // Already have this one.
1204 if (!isset($this->_types[$column]))
1205 $this->_initAvailableColumns();
1206 $this->_columns_seen[$column] = true;
1208 if (strstr($column, ':'))
1209 list ($column, $heading) = explode(':', $column, 2);
1211 // FIXME: these column types have hooks (objects) elsewhere
1212 // Omitting this warning should be overridable by the extension
1213 if (!isset($this->_types[$column])) {
1214 $silently_ignore = array('numbacklinks',
1215 'rating','ratingvalue',
1216 'coagreement', 'minmisery',
1218 'averagerating', 'top3recs',
1219 'relation', 'linkto');
1220 if (!in_array($column, $silently_ignore))
1221 trigger_error(sprintf("%s: Bad column", $column), E_USER_NOTICE);
1224 // FIXME: anon users might rate and see ratings also.
1225 // Defer this logic to the plugin.
1226 if ($column == 'rating' and !$GLOBALS['request']->_user->isSignedIn())
1229 $this->addColumnObject($this->_types[$column]);
1235 * Add a column to this PageList, given a column object.
1237 * @param $col object An object derived from _PageList_Column.
1239 function addColumnObject($col) {
1240 if (is_array($col)) {// custom column object
1242 $class_name = array_shift($params);
1243 $params[3] =& $this;
1244 $col = new $class_name($params);
1246 $heading = $col->getHeading();
1247 if (!empty($heading))
1248 $col->setHeading($heading);
1250 $this->_columns[] = $col;
1251 $this->_columnsMap[$col->_field] = count($this->_columns); // start with 1
1255 * Compare _PageList_Page objects.
1257 function _pageCompare(&$a, &$b) {
1258 if (empty($this->_sortby) or count($this->_sortby) == 0) {
1259 // No columns to sort by
1263 $pagea = $this->_getPageFromHandle($a); // If a string, convert to page
1264 assert(isa($pagea, 'WikiDB_Page'));
1265 $pageb = $this->_getPageFromHandle($b); // If a string, convert to page
1266 assert(isa($pageb, 'WikiDB_Page'));
1267 foreach ($this->_sortby as $colNum => $direction) {
1268 // get column type object
1269 if (!is_int($colNum)) { // or column fieldname
1270 if (isset($this->_columnsMap[$colNum]))
1271 $col = $this->_columns[$this->_columnsMap[$colNum] - 1];
1272 elseif (isset($this->_types[$colNum]))
1273 $col = $this->_types[$colNum];
1276 assert(isset($col));
1277 $revision_handle = false;
1278 $aval = $col->_getSortableValue($pagea, $revision_handle);
1279 $revision_handle = false;
1280 $bval = $col->_getSortableValue($pageb, $revision_handle);
1282 $cmp = $col->_compare($aval, $bval);
1283 if ($direction === "-") // Reverse the sense of the comparison
1287 // This is the first comparison that is not equal-- go with it
1295 * Put pages in order according to the sortby arg, if given
1296 * If the sortby cols are already sorted by the DB call, don't do usort.
1297 * TODO: optimize for multiple sortable cols
1299 function _sortPages() {
1300 if (count($this->_sortby) > 0) {
1301 $need_sort = $this->_options['dosort'];
1303 foreach ($this->_sortby as $col => $dir) {
1304 if (! $this->sortby($col, 'db'))
1307 if ($need_sort) { // There are some columns to sort by
1308 // TODO: consider nopage
1309 usort($this->_pages, array($this, '_pageCompare'));
1312 //unset($GLOBALS['PhpWiki_pagelist']);
1315 function limit($limit) {
1316 if (is_array($limit)) return $limit;
1317 if (strstr($limit, ','))
1318 return split(',', $limit);
1320 return array(0, $limit);
1323 function pagingTokens($numrows = false, $ncolumns = false, $limit = false) {
1324 if ($numrows === false)
1325 $numrows = $this->getTotal();
1326 if ($limit === false)
1327 $limit = $this->_options['limit'];
1328 if ($ncolumns === false)
1329 $ncolumns = count($this->_columns);
1331 list($offset, $pagesize) = $this->limit($limit);
1333 (!$offset and $numrows < $pagesize) or
1334 (($offset + $pagesize) < 0))
1337 $request = &$GLOBALS['request'];
1338 $pagename = $request->getArg('pagename');
1339 $defargs = array_merge(array('id' => $this->id), $request->args);
1340 if (USE_PATH_INFO) unset($defargs['pagename']);
1341 if ($defargs['action'] == 'browse') unset($defargs['action']);
1345 $tokens['PREV'] = false; $tokens['PREV_LINK'] = "";
1346 $tokens['COLS'] = $ncolumns;
1347 $tokens['COUNT'] = $numrows;
1348 $tokens['OFFSET'] = $offset;
1349 $tokens['SIZE'] = $pagesize;
1350 $tokens['NUMPAGES'] = (int) ceil($numrows / $pagesize);
1351 $tokens['ACTPAGE'] = (int) ceil(($offset / $pagesize)+1);
1353 $prev['limit'] = max(0, $offset - $pagesize) . ",$pagesize";
1354 $prev['count'] = $numrows;
1355 $tokens['LIMIT'] = $prev['limit'];
1356 $tokens['PREV'] = true;
1357 $tokens['PREV_LINK'] = WikiURL($pagename, $prev);
1358 $prev['limit'] = "0,$pagesize";
1359 $tokens['FIRST_LINK'] = WikiURL($pagename, $prev);
1362 $tokens['NEXT'] = false; $tokens['NEXT_LINK'] = "";
1363 if (($offset + $pagesize) < $numrows) {
1364 $next['limit'] = min($offset + $pagesize, $numrows - $pagesize) . ",$pagesize";
1365 $next['count'] = $numrows;
1366 $tokens['LIMIT'] = $next['limit'];
1367 $tokens['NEXT'] = true;
1368 $tokens['NEXT_LINK'] = WikiURL($pagename, $next);
1369 $next['limit'] = $numrows - $pagesize . ",$pagesize";
1370 $tokens['LAST_LINK'] = WikiURL($pagename, $next);
1375 // make a table given the caption
1376 function _generateTable($caption) {
1377 if (count($this->_sortby) > 0) $this->_sortPages();
1379 // wikiadminutils hack. that's a way to pagelist non-pages
1380 $rows = isset($this->_rows) ? $this->_rows : array(); $i = 0;
1381 $count = $this->getTotal();
1382 $do_paging = ( isset($this->_options['paging'])
1383 and !empty($this->_options['limit'])
1385 and $this->_options['paging'] != 'none' );
1387 $tokens = $this->pagingTokens($count,
1388 count($this->_columns),
1389 $this->_options['limit']);
1391 $this->_pages = array_slice($this->_pages, $tokens['OFFSET'], $tokens['COUNT']);
1393 foreach ($this->_pages as $pagenum => $page) {
1394 $rows[] = $this->_renderPageRow($page, $i++);
1396 $table = HTML::table(array('cellpadding' => 0,
1399 'class' => 'pagelist',
1402 $table->pushContent(HTML::caption(array('align'=>'top'), $caption));
1403 $table->setAttr('width', '100%');
1406 //Warning: This is quite fragile. It depends solely on a private variable
1407 // in ->_addColumn()
1408 if (!empty($this->_columns_seen['checkbox'])) {
1409 $table->pushContent($this->_jsFlipAll());
1413 $table_summary = array();
1414 $i = 1; // start with 1!
1415 foreach ($this->_columns as $col) {
1416 $heading = $col->button_heading($this, $i);
1418 and isset($col->_field)
1419 and $col->_field == 'pagename'
1420 and ($maxlen = $this->maxLen())) {
1421 $heading->setAttr('width', $maxlen * 7);
1423 $row->pushContent($heading);
1424 if (is_string($col->getHeading()))
1425 $table_summary[] = $col->getHeading();
1428 // Table summary for non-visual browsers.
1429 $table->setAttr('summary', sprintf(_("Columns: %s."),
1430 join(", ", $table_summary)));
1431 $table->pushContent(HTML::colgroup(array('span' => count($this->_columns))));
1433 if ($tokens === false) {
1434 $table->pushContent(HTML::thead($row),
1435 HTML::tbody(false, $rows));
1439 $paging = Template("pagelink", $tokens);
1440 if ($this->_options['paging'] != 'bottom')
1441 $table->pushContent(HTML::thead($paging));
1442 if ($this->_options['paging'] != 'top')
1443 $table->pushContent(HTML::tfoot($paging));
1444 $table->pushContent(HTML::tbody(false, HTML($row, $rows)));
1447 $table->pushContent(HTML::thead($row),
1448 HTML::tbody(false, $rows));
1453 function _jsFlipAll() {
1455 function flipAll(formObj) {
1456 var isFirstSet = -1;
1457 for (var i=0; i < formObj.length; i++) {
1458 fldObj = formObj.elements[i];
1459 if ((fldObj.type == 'checkbox') && (fldObj.name.substring(0,2) == 'p[')) {
1460 if (isFirstSet == -1)
1461 isFirstSet = (fldObj.checked) ? true : false;
1462 fldObj.checked = (isFirstSet) ? false : true;
1468 /* recursive stack for private sublist options (azhead, cols) */
1469 function _saveOptions($opts) {
1470 $stack = array('pages' => $this->_pages);
1471 foreach ($opts as $k => $v) {
1472 $stack[$k] = $this->_options[$k];
1473 $this->_options[$k] = $v;
1475 if (empty($this->_stack))
1476 $this->_stack = new Stack();
1477 $this->_stack->push($stack);
1479 function _restoreOptions() {
1480 assert($this->_stack);
1481 $stack = $this->_stack->pop();
1482 $this->_pages = $stack['pages'];
1483 unset($stack['pages']);
1484 foreach ($stack as $k => $v) {
1485 $this->_options[$k] = $v;
1489 // 'cols' - split into several columns
1490 // 'azhead' - support <h3> grouping into initials
1491 // 'ordered' - OL or UL list (not yet inherited to all plugins)
1492 // 'comma' - condensed comma-list only, 1: no links, >1: with links
1493 // FIXME: only unique list entries, esp. with nopage
1494 function _generateList($caption='') {
1495 if (empty($this->_pages)) return; // stop recursion
1496 if (!isset($this->_options['listtype']))
1497 $this->_options['listtype'] = '';
1500 $out->pushContent(HTML::p($caption));
1501 // Semantic Search et al: only unique list entries, esp. with nopage
1502 if (!is_array($this->_pages[0]) and is_string($this->_pages[0])) {
1503 $this->_pages = array_unique($this->_pages);
1505 if (count($this->_sortby) > 0) $this->_sortPages();
1506 $count = $this->getTotal();
1507 $do_paging = ( isset($this->_options['paging'])
1508 and !empty($this->_options['limit'])
1510 and $this->_options['paging'] != 'none' );
1512 $tokens = $this->pagingTokens($count,
1513 count($this->_columns),
1514 $this->_options['limit']);
1516 $paging = Template("pagelink", $tokens);
1517 $out->pushContent(HTML::table(array('width'=>'50%'), $paging));
1521 // need a recursive switch here for the azhead and cols grouping.
1522 if (!empty($this->_options['cols']) and $this->_options['cols'] > 1) {
1523 $count = count($this->_pages);
1524 $length = $count / $this->_options['cols'];
1525 $width = sprintf("%d", 100 / $this->_options['cols']).'%';
1526 $cols = HTML::tr(array('valign' => 'top'));
1527 for ($i=0; $i < $count; $i += $length) {
1528 $this->_saveOptions(array('cols' => 0, 'paging' => 'none'));
1529 $this->_pages = array_slice($this->_pages, $i, $length);
1530 $cols->pushContent(HTML::td(/*array('width' => $width),*/
1531 $this->_generateList()));
1532 $this->_restoreOptions();
1534 // speed up table rendering by defining colgroups
1535 $out->pushContent(HTML::table(HTML::colgroup(array('span' => $this->_options['cols'],
1536 'width' => $width)),
1541 // Ignore azhead if not sorted by pagename
1542 if (!empty($this->_options['azhead'])
1543 and strstr($this->sortby($this->_options['sortby'], 'init'), "pagename")
1546 $cur_h = substr($this->_pages[0]->getName(), 0, 1);
1547 $out->pushContent(HTML::h3($cur_h));
1548 // group those pages together with same $h
1550 for ($i=0; $i < count($this->_pages); $i++) {
1551 $page =& $this->_pages[$i];
1552 $h = substr($page->getName(), 0, 1);
1553 if ($h != $cur_h and $i > $j) {
1554 $this->_saveOptions(array('cols' => 0, 'azhead' => 0));
1555 $this->_pages = array_slice($this->_pages, $j, $i - $j);
1556 $out->pushContent($this->_generateList());
1557 $this->_restoreOptions();
1559 $out->pushContent(HTML::h3($h));
1563 if ($i > $j) { // flush the rest
1564 $this->_saveOptions(array('cols' => 0, 'azhead' => 0));
1565 $this->_pages = array_slice($this->_pages, $j, $i - $j);
1566 $out->pushContent($this->_generateList());
1567 $this->_restoreOptions();
1572 if ($this->_options['listtype'] == 'comma')
1573 $this->_options['comma'] = 2;
1574 if (!empty($this->_options['comma'])) {
1575 if ($this->_options['comma'] == 1)
1576 $out->pushContent($this->_generateCommaListAsString());
1578 $out->pushContent($this->_generateCommaList($this->_options['comma']));
1582 if ($this->_options['listtype'] == 'ol')
1583 $this->_options['ordered'] = 1;
1584 elseif ($this->_options['listtype'] == 'ul')
1585 $this->_options['ordered'] = 0;
1586 if (!empty($this->_options['ordered']))
1587 $list = HTML::ol(array('class' => 'pagelist'));
1588 elseif ($this->_options['listtype'] == 'dl') {
1589 $list = HTML::dl(array('class' => 'pagelist'));
1591 $list = HTML::ul(array('class' => 'pagelist'));
1594 //TODO: currently we ignore limit here and hope that the backend didn't ignore it. (BackLinks)
1595 if (!empty($this->_options['limit']))
1596 list($offset, $pagesize) = $this->limit($this->_options['limit']);
1599 foreach ($this->_pages as $pagenum => $page) {
1600 $pagehtml = $this->_renderPageRow($page);
1601 if (!$pagehtml) continue;
1602 $group = ($i++ / $this->_group_rows);
1603 //TODO: here we switch every row, in tables every third.
1604 // unification or parametrized?
1605 $class = ($group % 2) ? 'oddrow' : 'evenrow';
1606 if ($this->_options['listtype'] == 'dl') {
1607 $header = WikiLink($page);
1608 //if ($this->_sortby['hi_content'])
1609 $list->pushContent(HTML::dt(array('class' => $class), $header),
1610 HTML::dd(array('class' => $class), $pagehtml));
1612 $list->pushContent(HTML::li(array('class' => $class), $pagehtml));
1613 if ($pagesize and $i > $pagesize) break;
1615 $out->pushContent($list);
1616 if ( $do_paging and $tokens ) {
1617 $out->pushContent(HTML::table($paging));
1623 // Condense list without a href links: "Page1, Page2, ..."
1624 // Alternative $seperator = HTML::Raw(' · ')
1625 // FIXME: only unique list entries, esp. with nopage
1626 function _generateCommaListAsString() {
1627 if (defined($this->_options['commasep']))
1628 $seperator = $this->_options['commasep'];
1632 foreach ($this->_pages as $pagenum => $page) {
1633 if ($s = $this->_renderPageRow($page)) // some pages are not viewable
1634 $pages[] = is_string($s) ? $s : $s->asString();
1636 return HTML(join($seperator, $pages));
1640 // Normal WikiLink list.
1641 // Future: 1 = reserved for plain string (see above)
1642 // 2 and more => HTML link specialization?
1643 // FIXME: only unique list entries, esp. with nopage
1644 function _generateCommaList($style = false) {
1645 if (defined($this->_options['commasep']))
1646 $seperator = HTLM::Raw($this->_options['commasep']);
1650 $html->pushContent($this->_renderPageRow($this->_pages[0]));
1651 next($this->_pages);
1652 foreach ($this->_pages as $pagenum => $page) {
1653 if ($s = $this->_renderPageRow($page)) // some pages are not viewable
1654 $html->pushContent($seperator, $s);
1659 function _emptyList($caption) {
1662 $html->pushContent(HTML::p($caption));
1663 if ($this->_messageIfEmpty)
1664 $html->pushContent(HTML::blockquote(HTML::p($this->_messageIfEmpty)));
1670 /* List pages with checkboxes to select from.
1671 * The [Select] button toggles via _jsFlipAll
1674 class PageList_Selectable
1677 function PageList_Selectable ($columns=false, $exclude='', $options = false) {
1679 if (!is_array($columns))
1680 $columns = explode(',', $columns);
1681 if (!in_array('checkbox',$columns))
1682 array_unshift($columns,'checkbox');
1684 $columns = array('checkbox','pagename');
1686 $this->PageList($columns, $exclude, $options);
1689 function addPageList ($array) {
1690 while (list($pagename,$selected) = each($array)) {
1691 if ($selected) $this->addPageSelected((string)$pagename);
1692 $this->addPage((string)$pagename);
1696 function addPageSelected ($pagename) {
1697 $this->_selected[$pagename] = 1;
1701 // $Log: not supported by cvs2svn $
1702 // Revision 1.153 2008/02/15 19:52:04 vargenau
1703 // Corrected bug #1847961: In AllPages with a limit, last page is incorrectly numbered
1705 // Revision 1.152 2008/02/15 19:46:12 vargenau
1706 // Allow sorting by hits; test method_exists
1708 // Revision 1.151 2008/02/14 18:42:53 rurban
1709 // ref to a class does not work with php-4, add ratingvalue
1711 // Revision 1.150 2008/01/31 20:28:47 vargenau
1712 // Valid HTML code: tfoot must be before tbody
1714 // Revision 1.149 2008/01/26 14:13:29 vargenau
1715 // XHTML is case-sensitive; use correct case
1717 // Revision 1.148 2007/09/19 18:00:49 rurban
1718 // enable "^A or ^B" pages argument for PageLists: e.g. large htmldump-s
1720 // Revision 1.147 2007/09/15 12:26:25 rurban
1721 // add explodePageList comments
1723 // Revision 1.146 2007/09/12 19:33:29 rurban
1724 // allow array to be exploded (comma problem)
1726 // Revision 1.145 2007/08/25 17:58:14 rurban
1727 // more limit fixes: limit earlier, fix COUNT slice
1729 // Revision 1.143 2007/07/14 12:03:19 rurban
1730 // support listtype=dl and ranked search
1732 // Revision 1.142 2007/07/01 09:09:19 rurban
1733 // fix PageList with multiple lists: added id, fixed sortby REQUEST logic
1735 // Revision 1.141 2007/05/24 18:40:55 rurban
1736 // display list with tokens problem
1738 // Revision 1.140 2007/05/13 18:12:55 rurban
1739 // force adding a options[type] column: fixes LinkDatabase
1741 // Revision 1.139 2007/01/25 07:42:01 rurban
1744 // Revision 1.138 2007/01/20 11:24:15 rurban
1745 // Support paging limit if ->_pages is not yet limited by the backend (AllPagesByMe)
1747 // Revision 1.137 2007/01/07 18:43:08 rurban
1748 // Honor predefined ->_rows: hack to (re-)allow non-pagenames, used by WikiAdminUtils
1750 // Revision 1.136 2007/01/02 13:18:46 rurban
1751 // filter pageNames through limit, needed for xmlrpc. publish col->current_row and col->current_column counters during iteration. use table width=100% with captions. Clarify API: sortby,limit and exclude are strings.
1753 // Revision 1.135 2005/09/14 05:59:03 rurban
1754 // optimized explodePageList to use SQL when available
1755 // (titleSearch instead of getAllPages)
1757 // Revision 1.134 2005/09/11 14:55:05 rurban
1758 // implement fulltext stoplist
1760 // Revision 1.133 2005/08/27 09:41:37 rurban
1761 // new helper method
1763 // Revision 1.132 2005/04/09 09:16:15 rurban
1764 // fix recursive PageList azhead+cols listing
1766 // Revision 1.131 2005/02/04 10:48:06 rurban
1767 // fix usort ref warning. Thanks to Charles Corrigan
1769 // Revision 1.130 2005/01/28 12:07:36 rurban
1772 // Revision 1.129 2005/01/25 06:58:21 rurban
1775 // Revision 1.128 2004/12/26 17:31:35 rurban
1776 // fixed prev link logic
1778 // Revision 1.127 2004/12/26 17:19:28 rurban
1779 // dont break sideeffecting sortby flips on paging urls (MostPopular)
1781 // Revision 1.126 2004/12/16 18:26:57 rurban
1782 // Avoid double calculation
1784 // Revision 1.125 2004/11/25 17:20:49 rurban
1785 // and again a couple of more native db args: backlinks
1787 // Revision 1.124 2004/11/23 15:17:14 rurban
1788 // better support for case_exact search (not caseexact for consistency),
1789 // plugin args simplification:
1790 // handle and explode exclude and pages argument in WikiPlugin::getArgs
1791 // and exclude in advance (at the sql level if possible)
1792 // handle sortby and limit from request override in WikiPlugin::getArgs
1793 // ListSubpages: renamed pages to maxpages
1795 // Revision 1.123 2004/11/23 13:35:31 rurban
1796 // add case_exact search
1798 // Revision 1.122 2004/11/21 11:59:15 rurban
1799 // remove final \n to be ob_cache independent
1801 // Revision 1.121 2004/11/20 17:35:47 rurban
1802 // improved WantedPages SQL backends
1803 // PageList::sortby new 3rd arg valid_fields (override db fields)
1804 // WantedPages sql pager inexact for performance reasons:
1805 // assume 3 wantedfrom per page, to be correct, no getTotal()
1806 // support exclude argument for get_all_pages, new _sql_set()
1808 // Revision 1.120 2004/11/20 11:28:49 rurban
1809 // fix a yet unused PageList customPageListColumns bug (merge class not decl to _types)
1810 // change WantedPages to use PageList
1811 // change WantedPages to print the list of referenced pages, not just the count.
1812 // the old version was renamed to WantedPagesOld
1813 // fix and add handling of most standard PageList arguments (limit, exclude, ...)
1814 // TODO: pagename sorting, dumb/WantedPagesIter and SQL optimization
1816 // Revision 1.119 2004/11/11 14:34:11 rurban
1817 // minor clarifications
1819 // Revision 1.118 2004/11/01 10:43:55 rurban
1820 // seperate PassUser methods into seperate dir (memory usage)
1821 // fix WikiUser (old) overlarge data session
1822 // remove wikidb arg from various page class methods, use global ->_dbi instead
1825 // Revision 1.117 2004/10/14 21:06:01 rurban
1826 // fix dumphtml with USE_PATH_INFO (again). fix some PageList refs
1828 // Revision 1.116 2004/10/14 19:19:33 rurban
1829 // loadsave: check if the dumped file will be accessible from outside.
1830 // and some other minor fixes. (cvsclient native not yet ready)
1832 // Revision 1.115 2004/10/14 17:15:05 rurban
1833 // remove class _PageList_Page, fix sortby=0 (start with 1, use strings), fix _PageList_Column_content for old phps, hits as int
1835 // Revision 1.114 2004/10/12 13:13:19 rurban
1836 // php5 compatibility (5.0.1 ok)
1838 // Revision 1.113 2004/10/05 17:00:03 rurban
1839 // support paging for simple lists
1840 // fix RatingDb sql backend.
1841 // remove pages from AllPages (this is ListPages then)
1843 // Revision 1.112 2004/10/04 23:39:58 rurban
1844 // list of page objects
1846 // Revision 1.111 2004/09/24 18:50:45 rurban
1847 // fix paging of SqlResult
1849 // Revision 1.110 2004/09/17 14:43:31 rurban
1852 // Revision 1.109 2004/09/17 14:22:10 rurban
1855 // Revision 1.108 2004/09/17 12:46:22 rurban
1856 // seperate pagingTokens()
1857 // support new default args: comma (1 and 2), commasep, ordered, cols,
1860 // Revision 1.107 2004/09/14 10:29:08 rurban
1861 // exclude pages already in addPages to simplify plugins
1863 // Revision 1.106 2004/09/06 10:22:14 rurban
1864 // oops, forgot global request
1866 // Revision 1.105 2004/09/06 08:38:30 rurban
1867 // modularize paging helper (for SqlResult)
1869 // Revision 1.104 2004/08/18 11:01:55 rurban
1870 // fixed checkbox list Select button:
1871 // no GET request on click,
1872 // only select the list checkbox entries, no other options.
1874 // Revision 1.103 2004/07/09 10:06:49 rurban
1875 // Use backend specific sortby and sortable_columns method, to be able to
1876 // select between native (Db backend) and custom (PageList) sorting.
1877 // Fixed PageList::AddPageList (missed the first)
1878 // Added the author/creator.. name to AllPagesBy...
1879 // display no pages if none matched.
1880 // Improved dba and file sortby().
1881 // Use &$request reference
1883 // Revision 1.102 2004/07/08 21:32:35 rurban
1884 // Prevent from more warnings, minor db and sort optimizations
1886 // Revision 1.101 2004/07/08 19:04:41 rurban
1887 // more unittest fixes (file backend, metadata RatingsDb)
1889 // Revision 1.100 2004/07/07 15:02:26 dfrankow
1890 // Take out if that prevents column sorting
1892 // Revision 1.99 2004/07/02 18:49:02 dfrankow
1893 // Change one line so that if addPageList() is passed null, it is still
1894 // okay. The unit tests do this (ask to list AllUsers where there are no
1895 // users, or something like that).
1897 // Revision 1.98 2004/07/01 08:51:22 rurban
1898 // dumphtml: added exclude, print pagename before processing
1900 // Revision 1.97 2004/06/29 09:11:10 rurban
1901 // More memory optimization:
1902 // don't cache unneeded _cached_html and %content for content and size columns
1903 // (only if sortable, which will fail for too many pages)
1905 // Revision 1.96 2004/06/29 08:47:42 rurban
1906 // Memory optimization (reference to parent, smart bool %content)
1907 // Fixed class grouping in table
1909 // Revision 1.95 2004/06/28 19:00:01 rurban
1910 // removed non-portable LIMIT 1 (it's getOne anyway)
1911 // removed size from info=most: needs to much memory
1913 // Revision 1.94 2004/06/27 10:26:02 rurban
1914 // oci8 patch by Philippe Vanhaesendonck + some ADODB notes+fixes
1916 // Revision 1.93 2004/06/25 14:29:17 rurban
1917 // WikiGroup refactoring:
1918 // global group attached to user, code for not_current user.
1919 // improved helpers for special groups (avoid double invocations)
1920 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
1921 // fixed a XHTML validation error on userprefs.tmpl
1923 // Revision 1.92 2004/06/21 17:01:39 rurban
1924 // fix typo and rating method call
1926 // Revision 1.91 2004/06/21 16:22:29 rurban
1927 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
1928 // fixed dumping buttons locally (images/buttons/),
1929 // support pages arg for dumphtml,
1930 // optional directory arg for dumpserial + dumphtml,
1931 // fix a AllPages warning,
1932 // show dump warnings/errors on DEBUG,
1933 // don't warn just ignore on wikilens pagelist columns, if not loaded.
1934 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
1936 // Revision 1.90 2004/06/18 14:38:21 rurban
1937 // adopt new PageList style
1939 // Revision 1.89 2004/06/17 13:16:08 rurban
1940 // apply wikilens work to PageList: all columns are sortable (slightly fixed)
1942 // Revision 1.88 2004/06/14 11:31:35 rurban
1943 // renamed global $Theme to $WikiTheme (gforge nameclash)
1944 // inherit PageList default options from PageList
1945 // default sortby=pagename
1946 // use options in PageList_Selectable (limit, sortby, ...)
1947 // added action revert, with button at action=diff
1948 // added option regex to WikiAdminSearchReplace
1950 // Revision 1.87 2004/06/13 16:02:12 rurban
1951 // empty list of pages if user=[] and not authenticated.
1953 // Revision 1.86 2004/06/13 15:51:37 rurban
1954 // Support pagelist filter for current author,owner,creator by []
1956 // Revision 1.85 2004/06/13 15:33:19 rurban
1957 // new support for arguments owner, author, creator in most relevant
1958 // PageList plugins. in WikiAdmin* via preSelectS()
1960 // Revision 1.84 2004/06/08 13:51:56 rurban
1961 // some comments only
1963 // Revision 1.83 2004/05/18 13:35:39 rurban
1964 // improve Pagelist layout by equal pagename width for limited lists
1966 // Revision 1.82 2004/05/16 22:07:35 rurban
1967 // check more config-default and predefined constants
1968 // various PagePerm fixes:
1969 // fix default PagePerms, esp. edit and view for Bogo and Password users
1970 // implemented Creator and Owner
1971 // BOGOUSERS renamed to BOGOUSER
1972 // fixed syntax errors in signin.tmpl
1974 // Revision 1.81 2004/05/13 12:30:35 rurban
1975 // fix for MacOSX border CSS attr, and if sort buttons are not found
1977 // Revision 1.80 2004/04/20 00:56:00 rurban
1978 // more paging support and paging fix for shorter lists
1980 // Revision 1.79 2004/04/20 00:34:16 rurban
1981 // more paging support
1983 // Revision 1.78 2004/04/20 00:06:03 rurban
1984 // themable paging support
1986 // Revision 1.77 2004/04/18 01:11:51 rurban
1987 // more numeric pagename fixes.
1988 // fixed action=upload with merge conflict warnings.
1989 // charset changed from constant to global (dynamic utf-8 switching)
1992 // (c-file-style: "gnu")
1996 // c-basic-offset: 4
1997 // c-hanging-comment-ender-p: nil
1998 // indent-tabs-mode: nil