1 <?php rcs_id('$Id: PageList.php,v 1.139 2007-01-25 07:42:01 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 * info=relation,linkto nopage=1
59 * fix memory exhaustion on large pagelists with old --memory-limit php's only.
60 * Status: improved 2004-06-25 16:19:36 rurban
61 * but needs further testing.
63 class _PageList_Column_base {
64 var $_tdattr = array();
66 function _PageList_Column_base ($default_heading, $align = false) {
67 $this->_heading = $default_heading;
70 // align="char" isn't supported by any browsers yet :(
71 //if (is_array($align))
72 // $this->_tdattr = $align;
74 $this->_tdattr['align'] = $align;
78 function format ($pagelist, $page_handle, &$revision_handle) {
79 return HTML::td($this->_tdattr,
81 $this->_getValue($page_handle, $revision_handle),
85 function getHeading () {
86 return $this->_heading;
89 function setHeading ($heading) {
90 $this->_heading = $heading;
96 if (1 /* or in_array($this->_field, PageList::sortable_columns())*/) {
97 // multiple comma-delimited sortby args: "+hits,+pagename"
98 // asc or desc: +pagename, -pagename
99 $sortby = PageList::sortby($this->_field, 'flip_order');
100 //Fixme: pass all also other GET args along. (limit, p[])
101 //TODO: support GET and POST
102 $s = HTML::a(array('href' =>
103 $GLOBALS['request']->GetURLtoSelf(array('sortby' => $sortby,
105 'class' => 'pagetitle',
106 'title' => sprintf(_("Sort by %s"), $this->_field)),
107 HTML::raw(' '), HTML::u($this->_heading), HTML::raw(' '));
109 $s = HTML(HTML::raw(' '), HTML::u($this->_heading), HTML::raw(' '));
111 return HTML::th(array('align' => 'center'),$s);
114 // new grid-style sortable heading
115 // TODO: via activeui.js ? (fast dhtml sorting)
116 function button_heading ($pagelist, $colNum) {
117 global $WikiTheme, $request;
119 if (1 /* or in_array($this->_field, PageList::sortable_columns()) */) {
120 // multiple comma-delimited sortby args: "+hits,+pagename"
122 $noimg_src = $WikiTheme->getButtonURL('no_order');
124 $noimg = HTML::img(array('src' => $noimg_src,
130 $noimg = HTML::raw(' ');
131 if ($request->getArg('sortby')) {
132 if ($pagelist->sortby($colNum, 'check')) { // show icon?
133 $sortby = $pagelist->sortby($request->getArg('sortby'), 'flip_order');
134 //$request->setArg('sortby', $sortby);
135 $desc = (substr($sortby,0,1) == '-'); // asc or desc? (+pagename, -pagename)
136 $src = $WikiTheme->getButtonURL($desc ? 'asc_order' : 'desc_order');
138 $sortby = $pagelist->sortby($colNum, 'init');
141 $sortby = $pagelist->sortby($colNum, 'init');
145 //$img->setAttr('alt', _("Click to sort"));
147 $img = HTML::img(array('src' => $src,
151 'alt' => _("Click to reverse sort order")));
153 $s = HTML::a(array('href' =>
154 //Fixme: pass all also other GET args along. (limit is ok, p[])
155 //Fixme: convert to POST submit[sortby]
156 $request->GetURLtoSelf(array('sortby' => $sortby,
157 /*'nocache' => '1'*/)),
158 'class' => 'gridbutton',
159 'title' => sprintf(_("Click to sort by %s"), $this->_field)),
166 HTML::raw(' '));
168 $s = HTML(HTML::raw(' '), $this->_heading, HTML::raw(' '));
170 return HTML::th(array('align' => 'center', 'valign' => 'middle',
171 'class' => 'gridbutton'), $s);
175 * Take two columns of this type and compare them.
176 * An undefined value is defined to be < than the smallest defined value.
177 * This base class _compare only works if the value is simple (e.g., a number).
179 * @param $colvala $this->_getValue() of column a
180 * @param $colvalb $this->_getValue() of column b
182 * @return -1 if $a < $b, 1 if $a > $b, 0 otherwise.
184 function _compare($colvala, $colvalb) {
185 if (is_string($colvala))
186 return strcmp($colvala,$colvalb);
188 if (($colvala === $colvalb) || (!isset($colvala) && !isset($colvalb))) {
191 $ret = (!isset($colvala) || ($colvala < $colvalb)) ? -1 : 1;
197 class _PageList_Column extends _PageList_Column_base {
198 function _PageList_Column ($field, $default_heading, $align = false) {
199 $this->_PageList_Column_base($default_heading, $align);
201 $this->_need_rev = substr($field, 0, 4) == 'rev:';
202 $this->_iscustom = substr($field, 0, 7) == 'custom:';
203 if ($this->_iscustom) {
204 $this->_field = substr($field, 7);
206 elseif ($this->_need_rev)
207 $this->_field = substr($field, 4);
209 $this->_field = $field;
212 function _getValue ($page_handle, &$revision_handle) {
213 if ($this->_need_rev) {
214 if (!$revision_handle)
215 // columns which need the %content should override this. (size, hi_content)
216 $revision_handle = $page_handle->getCurrentRevision(false);
217 return $revision_handle->get($this->_field);
220 return $page_handle->get($this->_field);
224 function _getSortableValue ($page_handle, &$revision_handle) {
225 $val = $this->_getValue($page_handle, $revision_handle);
226 if ($this->_field == 'hits')
228 elseif (is_object($val))
229 return $val->asString();
231 return (string) $val;
235 /* overcome a call_user_func limitation by not being able to do:
236 * call_user_func_array(array(&$class, $class_name), $params);
237 * So we need $class = new $classname($params);
238 * And we add a 4th param to get at the parent $pagelist object
240 class _PageList_Column_custom extends _PageList_Column {
241 function _PageList_Column_custom($params) {
242 $this->_pagelist =& $params[3];
243 $this->_PageList_Column($params[0], $params[1], $params[2]);
247 class _PageList_Column_size extends _PageList_Column {
248 function format (&$pagelist, $page_handle, &$revision_handle) {
249 return HTML::td($this->_tdattr,
251 $this->_getValue($pagelist, $page_handle, $revision_handle),
252 HTML::raw(' '));
255 function _getValue (&$pagelist, $page_handle, &$revision_handle) {
256 if (!$revision_handle or (!$revision_handle->_data['%content']
257 or $revision_handle->_data['%content'] === true)) {
258 $revision_handle = $page_handle->getCurrentRevision(true);
259 unset($revision_handle->_data['%pagedata']['_cached_html']);
261 $size = $this->_getSize($revision_handle);
262 // we can safely purge the content when it is not sortable
263 if (empty($pagelist->_sortby[$this->_field]))
264 unset($revision_handle->_data['%content']);
268 function _getSortableValue ($page_handle, &$revision_handle) {
269 if (!$revision_handle)
270 $revision_handle = $page_handle->getCurrentRevision(true);
271 return (empty($revision_handle->_data['%content']))
272 ? 0 : strlen($revision_handle->_data['%content']);
275 function _getSize($revision_handle) {
276 $bytes = @strlen($revision_handle->_data['%content']);
277 return ByteFormatter($bytes);
282 class _PageList_Column_bool extends _PageList_Column {
283 function _PageList_Column_bool ($field, $default_heading, $text = 'yes') {
284 $this->_PageList_Column($field, $default_heading, 'center');
285 $this->_textIfTrue = $text;
286 $this->_textIfFalse = new RawXml('—'); //mdash
289 function _getValue ($page_handle, &$revision_handle) {
290 //FIXME: check if $this is available in the parent (->need_rev)
291 $val = _PageList_Column::_getValue($page_handle, $revision_handle);
292 return $val ? $this->_textIfTrue : $this->_textIfFalse;
296 class _PageList_Column_checkbox extends _PageList_Column {
297 function _PageList_Column_checkbox ($field, $default_heading, $name='p') {
298 $this->_name = $name;
299 $heading = HTML::input(array('type' => 'button',
300 'title' => _("Click to de-/select all pages"),
302 'name' => $default_heading,
303 'value' => $default_heading,
304 'onclick' => "flipAll(this.form)"
306 $this->_PageList_Column($field, $heading, 'center');
308 function _getValue ($pagelist, $page_handle, &$revision_handle) {
309 $pagename = $page_handle->getName();
310 $selected = !empty($pagelist->_selected[$pagename]);
311 if (strstr($pagename,'[') or strstr($pagename,']')) {
312 $pagename = str_replace(array('[',']'),array('%5B','%5D'),$pagename);
315 return HTML::input(array('type' => 'checkbox',
316 'name' => $this->_name . "[$pagename]",
318 'checked' => 'CHECKED'));
320 return HTML::input(array('type' => 'checkbox',
321 'name' => $this->_name . "[$pagename]",
325 function format ($pagelist, $page_handle, &$revision_handle) {
326 return HTML::td($this->_tdattr,
328 $this->_getValue($pagelist, $page_handle, $revision_handle),
329 HTML::raw(' '));
331 // don't sort this javascript button
332 function button_heading ($pagelist, $colNum) {
333 $s = HTML(HTML::raw(' '), $this->_heading, HTML::raw(' '));
334 return HTML::th(array('align' => 'center', 'valign' => 'middle',
335 'class' => 'gridbutton'), $s);
339 class _PageList_Column_time extends _PageList_Column {
340 function _PageList_Column_time ($field, $default_heading) {
341 $this->_PageList_Column($field, $default_heading, 'right');
343 $this->Theme = &$WikiTheme;
346 function _getValue ($page_handle, &$revision_handle) {
347 $time = _PageList_Column::_getValue($page_handle, $revision_handle);
348 return $this->Theme->formatDateTime($time);
352 class _PageList_Column_version extends _PageList_Column {
353 function _getValue ($page_handle, &$revision_handle) {
354 if (!$revision_handle)
355 $revision_handle = $page_handle->getCurrentRevision();
356 return $revision_handle->getVersion();
360 // Output is hardcoded to limit of first 50 bytes. Otherwise
361 // on very large Wikis this will fail if used with AllPages
362 // (PHP memory limit exceeded)
363 class _PageList_Column_content extends _PageList_Column {
364 function _PageList_Column_content ($field, $default_heading, $align = false) {
365 $this->_PageList_Column($field, $default_heading, $align);
367 if ($field == 'content') {
368 $this->_heading .= sprintf(_(" ... first %d bytes"),
370 } elseif ($field == 'hi_content') {
371 global $HTTP_POST_VARS;
372 if (!empty($HTTP_POST_VARS['admin_replace'])) {
373 $search = $HTTP_POST_VARS['admin_replace']['from'];
374 $this->_heading .= sprintf(_(" ... around %s"),
380 function _getValue ($page_handle, &$revision_handle) {
381 if (!$revision_handle or (!$revision_handle->_data['%content']
382 or $revision_handle->_data['%content'] === true)) {
383 $revision_handle = $page_handle->getCurrentRevision(true);
385 // Not sure why implode is needed here, I thought
386 // getContent() already did this, but it seems necessary.
387 $c = implode("\n", $revision_handle->getContent());
388 if (empty($pagelist->_sortby[$this->_field]))
389 unset($revision_handle->_data['%content']);
390 if ($this->_field == 'hi_content') {
391 global $HTTP_POST_VARS;
392 unset($revision_handle->_data['%pagedata']['_cached_html']);
393 $search = $HTTP_POST_VARS['admin_replace']['from'];
394 if ($search and ($i = strpos($c,$search))) {
395 $l = strlen($search);
396 $j = max(0,$i - ($this->bytes / 2));
397 return HTML::div(array('style' => 'font-size:x-small'),
398 HTML::div(array('class' => 'transclusion'),
399 HTML::span(substr($c, $j, ($this->bytes / 2))),
400 HTML::span(array("style"=>"background:yellow"),$search),
401 HTML::span(substr($c, $i+$l, ($this->bytes / 2))))
404 $c = sprintf(_("%s not found"),
406 return HTML::div(array('style' => 'font-size:x-small','align'=>'center'),
409 } elseif (($len = strlen($c)) > $this->bytes) {
410 $c = substr($c, 0, $this->bytes);
412 include_once('lib/BlockParser.php');
413 // false --> don't bother processing hrefs for embedded WikiLinks
414 $ct = TransformText($c, $revision_handle->get('markup'), false);
415 if (empty($pagelist->_sortby[$this->_field]))
416 unset($revision_handle->_data['%pagedata']['_cached_html']);
417 return HTML::div(array('style' => 'font-size:x-small'),
418 HTML::div(array('class' => 'transclusion'), $ct),
419 // Don't show bytes here if size column present too
420 ($this->parent->_columns_seen['size'] or !$len) ? "" :
421 ByteFormatter($len, /*$longformat = */true));
424 function _getSortableValue ($page_handle, &$revision_handle) {
425 return substr(_PageList_Column::_getValue($page_handle, $revision_handle),0,50);
429 class _PageList_Column_author extends _PageList_Column {
430 function _PageList_Column_author ($field, $default_heading, $align = false) {
431 _PageList_Column::_PageList_Column($field, $default_heading, $align);
432 $this->dbi =& $GLOBALS['request']->getDbh();
435 function _getValue ($page_handle, &$revision_handle) {
436 $author = _PageList_Column::_getValue($page_handle, $revision_handle);
437 if (isWikiWord($author) && $this->dbi->isWikiPage($author))
438 return WikiLink($author);
444 class _PageList_Column_owner extends _PageList_Column_author {
445 function _getValue ($page_handle, &$revision_handle) {
446 $author = $page_handle->getOwner();
447 if (isWikiWord($author) && $this->dbi->isWikiPage($author))
448 return WikiLink($author);
454 class _PageList_Column_creator extends _PageList_Column_author {
455 function _getValue ($page_handle, &$revision_handle) {
456 $author = $page_handle->getCreator();
457 if (isWikiWord($author) && $this->dbi->isWikiPage($author))
458 return WikiLink($author);
464 class _PageList_Column_pagename extends _PageList_Column_base {
465 var $_field = 'pagename';
467 function _PageList_Column_pagename () {
468 $this->_PageList_Column_base(_("Page Name"));
470 $this->dbi = &$request->getDbh();
473 function _getValue ($page_handle, &$revision_handle) {
474 if ($this->dbi->isWikiPage($page_handle->getName()))
475 return WikiLink($page_handle, 'known');
477 return WikiLink($page_handle, 'unknown');
480 function _getSortableValue ($page_handle, &$revision_handle) {
481 return $page_handle->getName();
485 * Compare two pagenames for sorting. See _PageList_Column::_compare.
487 function _compare($colvala, $colvalb) {
488 return strcmp($colvala, $colvalb);
493 var $_group_rows = 3;
494 var $_columns = array();
495 var $_columnsMap = array(); // Maps column name to column number.
496 var $_excluded_pages = array();
497 var $_pages = array();
499 var $_pagename_seen = false;
500 var $_types = array();
501 var $_options = array();
502 var $_selected = array();
503 var $_sortby = array();
506 function PageList ($columns = false, $exclude = false, $options = false) {
508 $this->_options = $options;
510 // let plugins predefine only certain objects, such its own custom pagelist columns
511 if (!empty($this->_options['types'])) {
512 $this->_types = $this->_options['types'];
513 unset($this->_options['types']);
515 $this->_initAvailableColumns();
518 'all' => array_diff(array_keys($this->_types), // all but...
519 array('checkbox','remove','renamed_pagename',
520 'content','hi_content','perm','acl')),
521 'most' => array('pagename','mtime','author','hits'),
522 'some' => array('pagename','mtime','author')
525 if (!is_array($columns))
526 $columns = explode(',', $columns);
527 // expand symbolic columns:
528 foreach ($symbolic_columns as $symbol => $cols) {
529 if (in_array($symbol,$columns)) { // e.g. 'checkbox,all'
530 $columns = array_diff(array_merge($columns,$cols),array($symbol));
533 if (empty($this->_options['nopage']) and !in_array('pagename',$columns))
534 $this->_addColumn('pagename');
535 foreach ($columns as $col) {
537 $this->_addColumn($col);
540 // If 'pagename' is already present, _addColumn() will not add it again
541 if (empty($this->_options['nopage']))
542 $this->_addColumn('pagename');
544 foreach (array('sortby','limit','paging','count','dosort') as $key) {
545 if (!empty($options) and !empty($options[$key])) {
546 $this->_options[$key] = $options[$key];
548 $this->_options[$key] = $GLOBALS['request']->getArg($key);
551 $this->_options['sortby'] = $this->sortby($this->_options['sortby'], 'init');
553 if (is_string($exclude) and !is_array($exclude))
554 $exclude = $this->explodePageList($exclude, false,
555 $this->_options['sortby'],
556 $this->_options['limit']);
557 $this->_excluded_pages = $exclude;
559 $this->_messageIfEmpty = _("<no matches>");
562 // Currently PageList takes these arguments:
563 // 1: info, 2: exclude, 3: hash of options
564 // Here we declare which options are supported, so that
565 // the calling plugin may simply merge this with its own default arguments
566 function supportedArgs () {
567 return array(// Currently supported options:
568 /* what columns, what pages */
569 'info' => 'pagename',
570 'exclude' => '', // also wildcards, comma-seperated lists
571 // and <!plugin-list !> arrays
572 /* select pages by meta-data: */
573 'author' => false, // current user by []
574 'owner' => false, // current user by []
575 'creator' => false, // current user by []
577 /* for the sort buttons in <th> */
578 'sortby' => '', // same as for WikiDB::getAllPages
579 // (unsorted is faster)
581 /* PageList pager options:
582 * These options may also be given to _generate(List|Table) later
583 * But limit and offset might help the query WikiDB::getAllPages()
585 'limit' => 0, // number of rows (pagesize)
586 'paging' => 'auto', // 'auto' top + bottom rows if applicable
587 // // 'top' top only if applicable
588 // // 'bottom' bottom only if applicable
589 // // 'none' don't page at all
590 // (TODO: clarify what if $paging==false ?)
592 /* list-style options (with single pagename column only so far) */
593 'cols' => 1, // side-by-side display of list (1-3)
594 'azhead' => 0, // 1: group by initials
595 // 2: provide shortcut links to initials also
596 'comma' => 0, // condensed comma-seperated list,
597 // 1 if without links, 2 if with
598 'commasep' => false, // Default: ', '
599 'ordered' => false, // OL or just UL lists (ignored for comma)
600 'linkmore' => '', // If count>0 and limit>0 display a link with
601 // the number of all results, linked to the given pagename.
603 'nopage' => false, // for info=col omit the pagename column
607 function setCaption ($caption_string) {
608 $this->_caption = $caption_string;
611 function addCaption ($caption_string) {
612 $this->_caption = HTML($this->_caption," ",$caption_string);
615 function getCaption () {
616 // put the total into the caption if needed
617 if (is_string($this->_caption) && strstr($this->_caption, '%d'))
618 return sprintf($this->_caption, $this->getTotal());
619 return $this->_caption;
622 function setMessageIfEmpty ($msg) {
623 $this->_messageIfEmpty = $msg;
627 function getTotal () {
628 return !empty($this->_options['count'])
629 ? (integer) $this->_options['count'] : count($this->_pages);
632 function isEmpty () {
633 return empty($this->_pages);
636 function addPage($page_handle) {
637 if (!empty($this->_excluded_pages)) {
638 if (!in_array((is_string($page_handle) ? $page_handle : $page_handle->getName()),
639 $this->_excluded_pages))
640 $this->_pages[] = $page_handle;
642 $this->_pages[] = $page_handle;
646 function pageNames() {
648 $limit = @$this->_options['limit'];
649 foreach ($this->_pages as $page_handle) {
650 $pages[] = $page_handle->getName();
651 if ($limit and count($pages) > $limit)
657 function _getPageFromHandle($page_handle) {
658 if (is_string($page_handle)) {
659 if (empty($page_handle)) return $page_handle;
660 //$dbi = $GLOBALS['request']->getDbh(); // no, safe some memory!
661 $page_handle = $GLOBALS['request']->_dbi->getPage($page_handle);
667 * Take a PageList_Page object, and return an HTML object to display
668 * it in a table or list row.
670 function _renderPageRow (&$page_handle, $i = 0) {
671 $page_handle = $this->_getPageFromHandle($page_handle);
672 //FIXME. only on sf.net
673 if (!is_object($page_handle)) {
674 trigger_error("PageList: Invalid page_handle $page_handle", E_USER_WARNING);
677 if (!isset($page_handle)
678 or empty($page_handle)
679 or (!empty($this->_excluded_pages)
680 and in_array($page_handle->getName(), $this->_excluded_pages)))
681 return; // exclude page.
683 // enforce view permission
684 if (!mayAccessPage('view', $page_handle->getName()))
687 $group = (int)($i / $this->_group_rows);
688 $class = ($group % 2) ? 'oddrow' : 'evenrow';
689 $revision_handle = false;
690 $this->_maxlen = max($this->_maxlen, strlen($page_handle->getName()));
692 if (count($this->_columns) > 1) {
693 $row = HTML::tr(array('class' => $class));
695 foreach ($this->_columns as $col) {
696 $col->current_row = $i;
697 $col->current_column = $j;
698 $row->pushContent($col->format($this, $page_handle, $revision_handle));
702 $col = $this->_columns[0];
703 $col->current_row = $i;
704 $col->current_column = 0;
705 $row = $col->_getValue($page_handle, $revision_handle);
711 function addPages ($page_iter) {
712 //Todo: if limit check max(strlen(pagename))
713 while ($page = $page_iter->next()) {
714 $this->addPage($page);
718 function addPageList (&$list) {
719 if (empty($list)) return; // Protect reset from a null arg
720 foreach ($list as $page) {
721 if (is_object($page))
722 $page = $page->_pagename;
723 $this->addPage((string)$page);
729 $dbi =& $request->getDbh();
730 if (isa($dbi,'WikiDB_SQL')) {
731 extract($dbi->_backend->_table_names);
732 $res = $dbi->_backend->_dbh->getOne("SELECT max(length(pagename)) FROM $page_tbl");
733 if (DB::isError($res) || empty($res)) return false;
735 } elseif (isa($dbi,'WikiDB_ADODB')) {
736 extract($dbi->_backend->_table_names);
737 $row = $dbi->_backend->_dbh->getRow("SELECT max(length(pagename)) FROM $page_tbl");
738 return $row ? $row[0] : false;
743 function getContent() {
744 // Note that the <caption> element wants inline content.
745 $caption = $this->getCaption();
747 if ($this->isEmpty())
748 return $this->_emptyList($caption);
749 elseif (count($this->_columns) == 1)
750 return $this->_generateList($caption);
752 return $this->_generateTable($caption);
755 function printXML() {
756 PrintXML($this->getContent());
760 return AsXML($this->getContent());
764 * Handle sortby requests for the DB iterator and table header links.
765 * Prefix the column with + or - like "+pagename","-mtime", ...
768 * 'init' : unify with predefined order. "pagename" => "+pagename"
769 * 'flip_order' : "mtime" => "+mtime" => "-mtime" ...
770 * 'db' : "-pagename" => "pagename DESC"
773 * Now all columns are sortable. (patch by DanFr)
774 * Some columns have native DB backend methods, some not.
776 function sortby ($column, $action, $valid_fields=false) {
779 if (empty($column)) return '';
780 if (is_int($column)) {
781 $column = $this->_columns[$column - 1]->_field;
782 //$column = $col->_field;
784 //if (!is_string($column)) return '';
785 // support multiple comma-delimited sortby args: "+hits,+pagename"
787 if (strstr($column, ',')) {
788 $result = ($action == 'check') ? true : array();
789 foreach (explode(',', $column) as $col) {
790 if ($action == 'check')
791 $result = $result && $this->sortby($col, $action, $valid_fields);
793 $result[] = $this->sortby($col, $action, $valid_fields);
795 // 'check' returns true/false for every col. return true if all are true.
796 // i.e. the unsupported 'every' operator in functional languages.
797 if ($action == 'check')
800 return join(",", $result);
802 if (substr($column,0,1) == '+') {
803 $order = '+'; $column = substr($column,1);
804 } elseif (substr($column,0,1) == '-') {
805 $order = '-'; $column = substr($column,1);
807 // default initial order: +pagename, -mtime, -hits
809 if (in_array($column, array('mtime','hits')))
813 if ($action == 'flip_order') {
814 return ($order == '+' ? '-' : '+') . $column;
815 } elseif ($action == 'init') {
816 $this->_sortby[$column] = $order;
817 return $order . $column;
818 } elseif ($action == 'check') {
819 return (!empty($this->_sortby[$column])
820 or ($request->getArg('sortby')
821 and strstr($request->getArg('sortby'),$column)));
822 } elseif ($action == 'db') {
823 // Performance enhancement: use native DB sort if possible.
824 if (($valid_fields and in_array($column, $valid_fields))
825 or (method_exists($request->_dbi->_backend, 'sortable_columns')
826 and (in_array($column, $request->_dbi->_backend->sortable_columns())))) {
827 // omit this sort method from the _sortPages call at rendering
828 // asc or desc: +pagename, -pagename
829 return $column . ($order == '+' ? ' ASC' : ' DESC');
837 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
838 function explodePageList($input, $include_empty=false, $sortby='',
839 $limit='', $exclude='')
841 if (empty($input)) return array();
842 // expand wildcards from list of all pages
843 if (preg_match('/[\?\*]/', $input)) {
844 include_once("lib/TextSearchQuery.php");
845 $search = new TextSearchQuery(str_replace(",", " ", $input), true, 'glob');
846 $dbi = $GLOBALS['request']->getDbh();
847 $iter = $dbi->titleSearch($search, $sortby, $limit, $exclude);
849 while ($pagehandle = $iter->next()) {
850 $pages[] = $pagehandle->getName();
854 //TODO: need an SQL optimization here
855 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit,
857 while ($pagehandle = $allPagehandles->next()) {
858 $allPages[] = $pagehandle->getName();
860 return explodeList($input, $allPages);
863 //TODO: do the sorting, normally not needed if used for exclude only
864 return explode(',', $input);
868 // TODO: optimize getTotal => store in count
869 function allPagesByAuthor($wildcard, $include_empty=false, $sortby='',
870 $limit='', $exclude='')
872 $dbi = $GLOBALS['request']->getDbh();
873 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
875 if ($wildcard === '[]') {
876 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
877 if (!$wildcard) return $allPages;
879 $do_glob = preg_match('/[\?\*]/', $wildcard);
880 while ($pagehandle = $allPagehandles->next()) {
881 $name = $pagehandle->getName();
882 $author = $pagehandle->getAuthor();
885 if (glob_match($wildcard, $author))
887 } elseif ($wildcard == $author) {
891 // TODO: purge versiondata_cache
896 function allPagesByOwner($wildcard, $include_empty=false, $sortby='',
897 $limit='', $exclude='') {
898 $dbi = $GLOBALS['request']->getDbh();
899 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
901 if ($wildcard === '[]') {
902 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
903 if (!$wildcard) return $allPages;
905 $do_glob = preg_match('/[\?\*]/', $wildcard);
906 while ($pagehandle = $allPagehandles->next()) {
907 $name = $pagehandle->getName();
908 $owner = $pagehandle->getOwner();
911 if (glob_match($wildcard, $owner))
913 } elseif ($wildcard == $owner) {
921 function allPagesByCreator($wildcard, $include_empty=false, $sortby='',
922 $limit='', $exclude='') {
923 $dbi = $GLOBALS['request']->getDbh();
924 $allPagehandles = $dbi->getAllPages($include_empty, $sortby, $limit, $exclude);
926 if ($wildcard === '[]') {
927 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
928 if (!$wildcard) return $allPages;
930 $do_glob = preg_match('/[\?\*]/', $wildcard);
931 while ($pagehandle = $allPagehandles->next()) {
932 $name = $pagehandle->getName();
933 $creator = $pagehandle->getCreator();
936 if (glob_match($wildcard, $creator))
938 } elseif ($wildcard == $creator) {
949 /** Plugin and theme hooks:
950 * If the pageList is initialized with $options['types'] these types are also initialized,
951 * overriding the standard types.
953 function _initAvailableColumns() {
954 global $customPageListColumns;
958 => new _PageList_Column_content('rev:content', _("Content")),
959 // new: plugin specific column types initialised by the relevant plugins
961 'hi_content' // with highlighted search for SearchReplace
962 => new _PageList_Column_content('rev:hi_content', _("Content")),
964 => new _PageList_Column_remove('remove', _("Remove")),
965 // initialised by the plugin
967 => new _PageList_Column_renamed_pagename('rename', _("Rename to")),
969 => new _PageList_Column_perm('perm', _("Permission")),
971 => new _PageList_Column_acl('acl', _("ACL")),
974 => new _PageList_Column_checkbox('p', _("Select")),
976 => new _PageList_Column_pagename,
978 => new _PageList_Column_time('rev:mtime', _("Last Modified")),
980 => new _PageList_Column('hits', _("Hits"), 'right'),
982 => new _PageList_Column_size('rev:size', _("Size"), 'right'),
983 /*array('align' => 'char', 'char' => ' ')*/
985 => new _PageList_Column('rev:summary', _("Last Summary")),
987 => new _PageList_Column_version('rev:version', _("Version"),
990 => new _PageList_Column_author('rev:author', _("Last Author")),
992 => new _PageList_Column_owner('author_id', _("Owner")),
994 => new _PageList_Column_creator('author_id', _("Creator")),
997 => new _PageList_Column_author('group', _("Group")),
1000 => new _PageList_Column_bool('locked', _("Locked"),
1003 => new _PageList_Column_bool('rev:is_minor_edit',
1004 _("Minor Edit"), _("minor")),
1006 => new _PageList_Column('rev:markup', _("Markup")),
1007 // 'rating' initialised by the wikilens theme hook: addPageListColumn
1010 => new _PageList_Column_rating('rating', _("Rate")),
1013 if (empty($this->_types))
1014 $this->_types = array();
1015 // add plugin specific pageList columns, initialized by $options['types']
1016 $this->_types = array_merge($standard_types, $this->_types);
1017 // add theme custom specific pageList columns:
1018 // set the 4th param as the current pagelist object.
1019 if (!empty($customPageListColumns)) {
1020 foreach ($customPageListColumns as $column => $params) {
1021 $class_name = array_shift($params);
1022 $params[3] =& $this;
1023 $class = new $class_name($params);
1024 $this->_types[$column] =& $class;
1029 function getOption($option) {
1030 if (array_key_exists($option, $this->_options)) {
1031 return $this->_options[$option];
1039 * Add a column to this PageList, given a column name.
1040 * The name is a type, and optionally has a : and a label. Examples:
1043 * pagename:This page
1045 * mtime:Last modified
1047 * If this function is called multiple times for the same type, the
1048 * column will only be added the first time, and ignored the succeeding times.
1049 * If you wish to add multiple columns of the same type, use addColumnObject().
1051 * @param column name
1052 * @return true if column is added, false otherwise
1054 function _addColumn ($column) {
1056 if (isset($this->_columns_seen[$column]))
1057 return false; // Already have this one.
1058 if (!isset($this->_types[$column]))
1059 $this->_initAvailableColumns();
1060 $this->_columns_seen[$column] = true;
1062 if (strstr($column, ':'))
1063 list ($column, $heading) = explode(':', $column, 2);
1065 // FIXME: these column types have hooks (objects) elsewhere
1066 // Omitting this warning should be overridable by the extension
1067 if (!isset($this->_types[$column])) {
1068 $silently_ignore = array('numbacklinks',
1069 'rating',/*'ratingwidget',*/
1070 'coagreement', 'minmisery',
1072 'averagerating', 'top3recs',
1073 'relation', 'linkto');
1074 if (!in_array($column, $silently_ignore))
1075 trigger_error(sprintf("%s: Bad column", $column), E_USER_NOTICE);
1078 // FIXME: anon users might rate and see ratings also.
1079 // Defer this logic to the plugin.
1080 if ($column == 'rating' and !$GLOBALS['request']->_user->isSignedIn())
1083 $this->addColumnObject($this->_types[$column]);
1089 * Add a column to this PageList, given a column object.
1091 * @param $col object An object derived from _PageList_Column.
1093 function addColumnObject($col) {
1094 if (is_array($col)) {// custom column object
1096 $class_name = array_shift($params);
1097 $params[3] =& $this;
1098 $col = new $class_name($params);
1100 $heading = $col->getHeading();
1101 if (!empty($heading))
1102 $col->setHeading($heading);
1104 $this->_columns[] = $col;
1105 $this->_columnsMap[$col->_field] = count($this->_columns); // start with 1
1109 * Compare _PageList_Page objects.
1111 function _pageCompare(&$a, &$b) {
1112 if (empty($this->_sortby) or count($this->_sortby) == 0) {
1113 // No columns to sort by
1117 $pagea = $this->_getPageFromHandle($a); // If a string, convert to page
1118 assert(isa($pagea, 'WikiDB_Page'));
1119 $pageb = $this->_getPageFromHandle($b); // If a string, convert to page
1120 assert(isa($pageb, 'WikiDB_Page'));
1121 foreach ($this->_sortby as $colNum => $direction) {
1122 if (!is_int($colNum)) // or column fieldname
1123 $colNum = $this->_columnsMap[$colNum];
1124 $col = $this->_columns[$colNum - 1];
1126 assert(isset($col));
1127 $revision_handle = false;
1128 $aval = $col->_getSortableValue($pagea, $revision_handle);
1129 $bval = $col->_getSortableValue($pageb, $revision_handle);
1131 $cmp = $col->_compare($aval, $bval);
1132 if ($direction === "-") // Reverse the sense of the comparison
1136 // This is the first comparison that is not equal-- go with it
1144 * Put pages in order according to the sortby arg, if given
1145 * If the sortby cols are already sorted by the DB call, don't do usort.
1146 * TODO: optimize for multiple sortable cols
1148 function _sortPages() {
1149 if (count($this->_sortby) > 0) {
1150 $need_sort = $this->_options['dosort'];
1151 foreach ($this->_sortby as $col => $dir) {
1152 if (! $this->sortby($col, 'db'))
1155 if ($need_sort) { // There are some columns to sort by
1156 // only if sortby=pagename then. consider nopage
1157 usort($this->_pages, array($this, '_pageCompare'));
1160 //unset($GLOBALS['PhpWiki_pagelist']);
1163 function limit($limit) {
1164 if (is_array($limit)) return $limit;
1165 if (strstr($limit, ','))
1166 return split(',', $limit);
1168 return array(0, $limit);
1171 function pagingTokens($numrows = false, $ncolumns = false, $limit = false) {
1172 if ($numrows === false)
1173 $numrows = $this->getTotal();
1174 if ($limit === false)
1175 $limit = $this->_options['limit'];
1176 if ($ncolumns === false)
1177 $ncolumns = count($this->_columns);
1179 list($offset, $pagesize) = $this->limit($limit);
1181 (!$offset and $numrows <= $pagesize) or
1182 ($offset + $pagesize < 0))
1185 $request = &$GLOBALS['request'];
1186 $pagename = $request->getArg('pagename');
1187 $defargs = $request->args;
1188 if (USE_PATH_INFO) unset($defargs['pagename']);
1189 if ($defargs['action'] == 'browse') unset($defargs['action']);
1193 $tokens['PREV'] = false; $tokens['PREV_LINK'] = "";
1194 $tokens['COLS'] = count($this->_columns);
1195 $tokens['COUNT'] = $numrows;
1196 $tokens['OFFSET'] = $offset;
1197 $tokens['SIZE'] = $pagesize;
1198 $tokens['NUMPAGES'] = (int)($numrows / $pagesize)+1;
1199 $tokens['ACTPAGE'] = (int) (($offset+1) / $pagesize)+1;
1201 $prev['limit'] = max(0, $offset - $pagesize) . ",$pagesize";
1202 $prev['count'] = $numrows;
1203 $tokens['LIMIT'] = $prev['limit'];
1204 $tokens['PREV'] = true;
1205 $tokens['PREV_LINK'] = WikiURL($pagename, $prev);
1206 $prev['limit'] = "0,$pagesize";
1207 $tokens['FIRST_LINK'] = WikiURL($pagename, $prev);
1210 $tokens['NEXT'] = false; $tokens['NEXT_LINK'] = "";
1211 if ($offset + $pagesize < $numrows) {
1212 $next['limit'] = min($offset + $pagesize, $numrows - $pagesize) . ",$pagesize";
1213 $next['count'] = $numrows;
1214 $tokens['LIMIT'] = $next['limit'];
1215 $tokens['NEXT'] = true;
1216 $tokens['NEXT_LINK'] = WikiURL($pagename, $next);
1217 $next['limit'] = $numrows - $pagesize . ",$pagesize";
1218 $tokens['LAST_LINK'] = WikiURL($pagename, $next);
1223 // make a table given the caption
1224 function _generateTable($caption) {
1225 if (count($this->_sortby) > 0) $this->_sortPages();
1227 // wikiadminutils hack. that's a way to pagelist non-pages
1228 $rows = isset($this->_rows) ? $this->_rows : array(); $i = 0;
1229 $count = $this->getTotal();
1230 $do_paging = ( isset($this->_options['paging'])
1231 and !empty($this->_options['limit'])
1233 and $this->_options['paging'] != 'none' );
1235 $tokens = $this->pagingTokens($count,
1236 count($this->_columns),
1237 $this->_options['limit']);
1238 $this->_pages = array_slice($this->_pages, $tokens['OFFSET'], $tokens['NUMPAGES']);
1240 foreach ($this->_pages as $pagenum => $page) {
1241 $rows[] = $this->_renderPageRow($page, $i++);
1243 $table = HTML::table(array('cellpadding' => 0,
1246 'class' => 'pagelist',
1249 $table->pushContent(HTML::caption(array('align'=>'top'), $caption));
1250 $table->setAttr('width', '100%');
1253 //Warning: This is quite fragile. It depends solely on a private variable
1254 // in ->_addColumn()
1255 if (!empty($this->_columns_seen['checkbox'])) {
1256 $table->pushContent($this->_jsFlipAll());
1260 $table_summary = array();
1261 $i = 1; // start with 1!
1262 foreach ($this->_columns as $col) {
1263 $heading = $col->button_heading($this, $i);
1265 and isset($col->_field)
1266 and $col->_field == 'pagename'
1267 and ($maxlen = $this->maxLen())) {
1268 $heading->setAttr('width', $maxlen * 7);
1270 $row->pushContent($heading);
1271 if (is_string($col->getHeading()))
1272 $table_summary[] = $col->getHeading();
1275 // Table summary for non-visual browsers.
1276 $table->setAttr('summary', sprintf(_("Columns: %s."),
1277 join(", ", $table_summary)));
1278 $table->pushContent(HTML::colgroup(array('span' => count($this->_columns))));
1280 if ($tokens === false) {
1281 $table->pushContent(HTML::thead($row),
1282 HTML::tbody(false, $rows));
1286 $paging = Template("pagelink", $tokens);
1287 if ($this->_options['paging'] != 'bottom')
1288 $table->pushContent(HTML::thead($paging));
1289 $table->pushContent(HTML::tbody(false, HTML($row, $rows)));
1290 if ($this->_options['paging'] != 'top')
1291 $table->pushContent(HTML::tfoot($paging));
1294 $table->pushContent(HTML::thead($row),
1295 HTML::tbody(false, $rows));
1300 function _jsFlipAll() {
1302 function flipAll(formObj) {
1303 var isFirstSet = -1;
1304 for (var i=0; i < formObj.length; i++) {
1305 fldObj = formObj.elements[i];
1306 if ((fldObj.type == 'checkbox') && (fldObj.name.substring(0,2) == 'p[')) {
1307 if (isFirstSet == -1)
1308 isFirstSet = (fldObj.checked) ? true : false;
1309 fldObj.checked = (isFirstSet) ? false : true;
1315 /* recursive stack for private sublist options (azhead, cols) */
1316 function _saveOptions($opts) {
1317 $stack = array('pages' => $this->_pages);
1318 foreach ($opts as $k => $v) {
1319 $stack[$k] = $this->_options[$k];
1320 $this->_options[$k] = $v;
1322 if (empty($this->_stack))
1323 $this->_stack = new Stack();
1324 $this->_stack->push($stack);
1326 function _restoreOptions() {
1327 assert($this->_stack);
1328 $stack = $this->_stack->pop();
1329 $this->_pages = $stack['pages'];
1330 unset($stack['pages']);
1331 foreach ($stack as $k => $v) {
1332 $this->_options[$k] = $v;
1336 // 'cols' - split into several columns
1337 // 'azhead' - support <h3> grouping into initials
1338 // 'ordered' - OL or UL list (not yet inherited to all plugins)
1339 // 'comma' - condensed comma-list only, 1: no links, >1: with links
1340 // TODO: only unique list entries, esp. with nopage
1341 function _generateList($caption='') {
1342 if (empty($this->_pages)) return; // stop recursion
1345 $out->pushContent(HTML::p($caption));
1346 // Semantic Search et al: only unique list entries, esp. with nopage
1347 if (!is_array($this->_pages[0]) and is_string($this->_pages[0])) {
1348 $this->_pages = array_unique($this->_pages);
1351 // need a recursive switch here for the azhead and cols grouping.
1352 if (!empty($this->_options['cols']) and $this->_options['cols'] > 1) {
1353 $count = count($this->_pages);
1354 $length = $count / $this->_options['cols'];
1355 $width = sprintf("%d", 100 / $this->_options['cols']).'%';
1356 $cols = HTML::tr(array('valign' => 'top'));
1357 for ($i=0; $i < $count; $i += $length) {
1358 $this->_saveOptions(array('cols' => 0));
1359 $this->_pages = array_slice($this->_pages, $i, $length);
1360 $cols->pushContent(HTML::td(/*array('width' => $width),*/
1361 $this->_generateList()));
1362 $this->_restoreOptions();
1364 // speed up table rendering by defining colgroups
1365 $out->pushContent(HTML::table(HTML::colgroup(array('span' => $this->_options['cols'],
1366 'width' => $width)),
1371 // Ignore azhead if not sorted by pagename
1372 if (!empty($this->_options['azhead'])
1373 and strstr($this->sortby($this->_options['sortby'], 'init'), "pagename")
1376 $cur_h = substr($this->_pages[0]->getName(), 0, 1);
1377 $out->pushContent(HTML::h3($cur_h));
1378 // group those pages together with same $h
1380 for ($i=0; $i < count($this->_pages); $i++) {
1381 $page =& $this->_pages[$i];
1382 $h = substr($page->getName(), 0, 1);
1383 if ($h != $cur_h and $i > $j) {
1384 $this->_saveOptions(array('cols' => 0, 'azhead' => 0));
1385 $this->_pages = array_slice($this->_pages, $j, $i - $j);
1386 $out->pushContent($this->_generateList());
1387 $this->_restoreOptions();
1389 $out->pushContent(HTML::h3($h));
1393 if ($i > $j) { // flush the rest
1394 $this->_saveOptions(array('cols' => 0, 'azhead' => 0));
1395 $this->_pages = array_slice($this->_pages, $j, $i - $j);
1396 $out->pushContent($this->_generateList());
1397 $this->_restoreOptions();
1402 if (!empty($this->_options['comma'])) {
1403 if ($this->_options['comma'] == 1)
1404 $out->pushContent($this->_generateCommaListAsString());
1406 $out->pushContent($this->_generateCommaList($this->_options['comma']));
1410 $do_paging = ( isset($this->_options['paging'])
1411 and !empty($this->_options['limit'])
1412 and $this->getTotal()
1413 and $this->_options['paging'] != 'none' );
1415 $tokens = $this->pagingTokens($this->getTotal(),
1416 count($this->_columns),
1417 $this->_options['limit']);
1419 $paging = Template("pagelink", $tokens);
1420 $out->pushContent(HTML::table($paging));
1423 if (!empty($this->_options['ordered']))
1424 $list = HTML::ol(array('class' => 'pagelist'));
1426 $list = HTML::ul(array('class' => 'pagelist'));
1428 //TODO: currently we ignore limit here and hope that the backend didn't ignore it. (BackLinks)
1429 if (!empty($this->_options['limit']))
1430 list($offset, $pagesize) = $this->limit($this->_options['limit']);
1433 foreach ($this->_pages as $pagenum => $page) {
1434 $pagehtml = $this->_renderPageRow($page);
1435 $group = ($i++ / $this->_group_rows);
1436 //TODO: here we switch every row, in tables every third.
1437 // unification or parametrized?
1438 $class = ($group % 2) ? 'oddrow' : 'evenrow';
1439 $list->pushContent(HTML::li(array('class' => $class), $pagehtml));
1440 if ($pagesize and $i > $pagesize) break;
1442 $out->pushContent($list);
1443 if ( $do_paging and $tokens ) {
1444 $out->pushContent(HTML::table($paging));
1450 // Condense list without a href links: "Page1, Page2, ..."
1451 // Alternative $seperator = HTML::Raw(' · ')
1452 function _generateCommaListAsString() {
1453 if (defined($this->_options['commasep']))
1454 $seperator = $this->_options['commasep'];
1458 foreach ($this->_pages as $pagenum => $page) {
1459 if ($s = $this->_renderPageRow($page)) // some pages are not viewable
1460 $pages[] = is_string($s) ? $s : $s->asString();
1462 return HTML(join($seperator, $pages));
1466 // Normal WikiLink list.
1467 // Future: 1 = reserved for plain string (see above)
1468 // 2 and more => HTML link specialization?
1469 function _generateCommaList($style = false) {
1470 if (defined($this->_options['commasep']))
1471 $seperator = HTLM::Raw($this->_options['commasep']);
1475 $html->pushContent($this->_renderPageRow($this->_pages[0]));
1476 next($this->_pages);
1477 foreach ($this->_pages as $pagenum => $page) {
1478 if ($s = $this->_renderPageRow($page)) // some pages are not viewable
1479 $html->pushContent($seperator, $s);
1484 function _emptyList($caption) {
1487 $html->pushContent(HTML::p($caption));
1488 if ($this->_messageIfEmpty)
1489 $html->pushContent(HTML::blockquote(HTML::p($this->_messageIfEmpty)));
1495 /* List pages with checkboxes to select from.
1496 * The [Select] button toggles via _jsFlipAll
1499 class PageList_Selectable
1502 function PageList_Selectable ($columns=false, $exclude='', $options = false) {
1504 if (!is_array($columns))
1505 $columns = explode(',', $columns);
1506 if (!in_array('checkbox',$columns))
1507 array_unshift($columns,'checkbox');
1509 $columns = array('checkbox','pagename');
1511 $this->PageList($columns, $exclude, $options);
1514 function addPageList ($array) {
1515 while (list($pagename,$selected) = each($array)) {
1516 if ($selected) $this->addPageSelected((string)$pagename);
1517 $this->addPage((string)$pagename);
1521 function addPageSelected ($pagename) {
1522 $this->_selected[$pagename] = 1;
1526 // $Log: not supported by cvs2svn $
1527 // Revision 1.138 2007/01/20 11:24:15 rurban
1528 // Support paging limit if ->_pages is not yet limited by the backend (AllPagesByMe)
1530 // Revision 1.137 2007/01/07 18:43:08 rurban
1531 // Honor predefined ->_rows: hack to (re-)allow non-pagenames, used by WikiAdminUtils
1533 // Revision 1.136 2007/01/02 13:18:46 rurban
1534 // 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.
1536 // Revision 1.135 2005/09/14 05:59:03 rurban
1537 // optimized explodePageList to use SQL when available
1538 // (titleSearch instead of getAllPages)
1540 // Revision 1.134 2005/09/11 14:55:05 rurban
1541 // implement fulltext stoplist
1543 // Revision 1.133 2005/08/27 09:41:37 rurban
1544 // new helper method
1546 // Revision 1.132 2005/04/09 09:16:15 rurban
1547 // fix recursive PageList azhead+cols listing
1549 // Revision 1.131 2005/02/04 10:48:06 rurban
1550 // fix usort ref warning. Thanks to Charles Corrigan
1552 // Revision 1.130 2005/01/28 12:07:36 rurban
1555 // Revision 1.129 2005/01/25 06:58:21 rurban
1558 // Revision 1.128 2004/12/26 17:31:35 rurban
1559 // fixed prev link logic
1561 // Revision 1.127 2004/12/26 17:19:28 rurban
1562 // dont break sideeffecting sortby flips on paging urls (MostPopular)
1564 // Revision 1.126 2004/12/16 18:26:57 rurban
1565 // Avoid double calculation
1567 // Revision 1.125 2004/11/25 17:20:49 rurban
1568 // and again a couple of more native db args: backlinks
1570 // Revision 1.124 2004/11/23 15:17:14 rurban
1571 // better support for case_exact search (not caseexact for consistency),
1572 // plugin args simplification:
1573 // handle and explode exclude and pages argument in WikiPlugin::getArgs
1574 // and exclude in advance (at the sql level if possible)
1575 // handle sortby and limit from request override in WikiPlugin::getArgs
1576 // ListSubpages: renamed pages to maxpages
1578 // Revision 1.123 2004/11/23 13:35:31 rurban
1579 // add case_exact search
1581 // Revision 1.122 2004/11/21 11:59:15 rurban
1582 // remove final \n to be ob_cache independent
1584 // Revision 1.121 2004/11/20 17:35:47 rurban
1585 // improved WantedPages SQL backends
1586 // PageList::sortby new 3rd arg valid_fields (override db fields)
1587 // WantedPages sql pager inexact for performance reasons:
1588 // assume 3 wantedfrom per page, to be correct, no getTotal()
1589 // support exclude argument for get_all_pages, new _sql_set()
1591 // Revision 1.120 2004/11/20 11:28:49 rurban
1592 // fix a yet unused PageList customPageListColumns bug (merge class not decl to _types)
1593 // change WantedPages to use PageList
1594 // change WantedPages to print the list of referenced pages, not just the count.
1595 // the old version was renamed to WantedPagesOld
1596 // fix and add handling of most standard PageList arguments (limit, exclude, ...)
1597 // TODO: pagename sorting, dumb/WantedPagesIter and SQL optimization
1599 // Revision 1.119 2004/11/11 14:34:11 rurban
1600 // minor clarifications
1602 // Revision 1.118 2004/11/01 10:43:55 rurban
1603 // seperate PassUser methods into seperate dir (memory usage)
1604 // fix WikiUser (old) overlarge data session
1605 // remove wikidb arg from various page class methods, use global ->_dbi instead
1608 // Revision 1.117 2004/10/14 21:06:01 rurban
1609 // fix dumphtml with USE_PATH_INFO (again). fix some PageList refs
1611 // Revision 1.116 2004/10/14 19:19:33 rurban
1612 // loadsave: check if the dumped file will be accessible from outside.
1613 // and some other minor fixes. (cvsclient native not yet ready)
1615 // Revision 1.115 2004/10/14 17:15:05 rurban
1616 // remove class _PageList_Page, fix sortby=0 (start with 1, use strings), fix _PageList_Column_content for old phps, hits as int
1618 // Revision 1.114 2004/10/12 13:13:19 rurban
1619 // php5 compatibility (5.0.1 ok)
1621 // Revision 1.113 2004/10/05 17:00:03 rurban
1622 // support paging for simple lists
1623 // fix RatingDb sql backend.
1624 // remove pages from AllPages (this is ListPages then)
1626 // Revision 1.112 2004/10/04 23:39:58 rurban
1627 // list of page objects
1629 // Revision 1.111 2004/09/24 18:50:45 rurban
1630 // fix paging of SqlResult
1632 // Revision 1.110 2004/09/17 14:43:31 rurban
1635 // Revision 1.109 2004/09/17 14:22:10 rurban
1638 // Revision 1.108 2004/09/17 12:46:22 rurban
1639 // seperate pagingTokens()
1640 // support new default args: comma (1 and 2), commasep, ordered, cols,
1643 // Revision 1.107 2004/09/14 10:29:08 rurban
1644 // exclude pages already in addPages to simplify plugins
1646 // Revision 1.106 2004/09/06 10:22:14 rurban
1647 // oops, forgot global request
1649 // Revision 1.105 2004/09/06 08:38:30 rurban
1650 // modularize paging helper (for SqlResult)
1652 // Revision 1.104 2004/08/18 11:01:55 rurban
1653 // fixed checkbox list Select button:
1654 // no GET request on click,
1655 // only select the list checkbox entries, no other options.
1657 // Revision 1.103 2004/07/09 10:06:49 rurban
1658 // Use backend specific sortby and sortable_columns method, to be able to
1659 // select between native (Db backend) and custom (PageList) sorting.
1660 // Fixed PageList::AddPageList (missed the first)
1661 // Added the author/creator.. name to AllPagesBy...
1662 // display no pages if none matched.
1663 // Improved dba and file sortby().
1664 // Use &$request reference
1666 // Revision 1.102 2004/07/08 21:32:35 rurban
1667 // Prevent from more warnings, minor db and sort optimizations
1669 // Revision 1.101 2004/07/08 19:04:41 rurban
1670 // more unittest fixes (file backend, metadata RatingsDb)
1672 // Revision 1.100 2004/07/07 15:02:26 dfrankow
1673 // Take out if that prevents column sorting
1675 // Revision 1.99 2004/07/02 18:49:02 dfrankow
1676 // Change one line so that if addPageList() is passed null, it is still
1677 // okay. The unit tests do this (ask to list AllUsers where there are no
1678 // users, or something like that).
1680 // Revision 1.98 2004/07/01 08:51:22 rurban
1681 // dumphtml: added exclude, print pagename before processing
1683 // Revision 1.97 2004/06/29 09:11:10 rurban
1684 // More memory optimization:
1685 // don't cache unneeded _cached_html and %content for content and size columns
1686 // (only if sortable, which will fail for too many pages)
1688 // Revision 1.96 2004/06/29 08:47:42 rurban
1689 // Memory optimization (reference to parent, smart bool %content)
1690 // Fixed class grouping in table
1692 // Revision 1.95 2004/06/28 19:00:01 rurban
1693 // removed non-portable LIMIT 1 (it's getOne anyway)
1694 // removed size from info=most: needs to much memory
1696 // Revision 1.94 2004/06/27 10:26:02 rurban
1697 // oci8 patch by Philippe Vanhaesendonck + some ADODB notes+fixes
1699 // Revision 1.93 2004/06/25 14:29:17 rurban
1700 // WikiGroup refactoring:
1701 // global group attached to user, code for not_current user.
1702 // improved helpers for special groups (avoid double invocations)
1703 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
1704 // fixed a XHTML validation error on userprefs.tmpl
1706 // Revision 1.92 2004/06/21 17:01:39 rurban
1707 // fix typo and rating method call
1709 // Revision 1.91 2004/06/21 16:22:29 rurban
1710 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
1711 // fixed dumping buttons locally (images/buttons/),
1712 // support pages arg for dumphtml,
1713 // optional directory arg for dumpserial + dumphtml,
1714 // fix a AllPages warning,
1715 // show dump warnings/errors on DEBUG,
1716 // don't warn just ignore on wikilens pagelist columns, if not loaded.
1717 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
1719 // Revision 1.90 2004/06/18 14:38:21 rurban
1720 // adopt new PageList style
1722 // Revision 1.89 2004/06/17 13:16:08 rurban
1723 // apply wikilens work to PageList: all columns are sortable (slightly fixed)
1725 // Revision 1.88 2004/06/14 11:31:35 rurban
1726 // renamed global $Theme to $WikiTheme (gforge nameclash)
1727 // inherit PageList default options from PageList
1728 // default sortby=pagename
1729 // use options in PageList_Selectable (limit, sortby, ...)
1730 // added action revert, with button at action=diff
1731 // added option regex to WikiAdminSearchReplace
1733 // Revision 1.87 2004/06/13 16:02:12 rurban
1734 // empty list of pages if user=[] and not authenticated.
1736 // Revision 1.86 2004/06/13 15:51:37 rurban
1737 // Support pagelist filter for current author,owner,creator by []
1739 // Revision 1.85 2004/06/13 15:33:19 rurban
1740 // new support for arguments owner, author, creator in most relevant
1741 // PageList plugins. in WikiAdmin* via preSelectS()
1743 // Revision 1.84 2004/06/08 13:51:56 rurban
1744 // some comments only
1746 // Revision 1.83 2004/05/18 13:35:39 rurban
1747 // improve Pagelist layout by equal pagename width for limited lists
1749 // Revision 1.82 2004/05/16 22:07:35 rurban
1750 // check more config-default and predefined constants
1751 // various PagePerm fixes:
1752 // fix default PagePerms, esp. edit and view for Bogo and Password users
1753 // implemented Creator and Owner
1754 // BOGOUSERS renamed to BOGOUSER
1755 // fixed syntax errors in signin.tmpl
1757 // Revision 1.81 2004/05/13 12:30:35 rurban
1758 // fix for MacOSX border CSS attr, and if sort buttons are not found
1760 // Revision 1.80 2004/04/20 00:56:00 rurban
1761 // more paging support and paging fix for shorter lists
1763 // Revision 1.79 2004/04/20 00:34:16 rurban
1764 // more paging support
1766 // Revision 1.78 2004/04/20 00:06:03 rurban
1767 // themable paging support
1769 // Revision 1.77 2004/04/18 01:11:51 rurban
1770 // more numeric pagename fixes.
1771 // fixed action=upload with merge conflict warnings.
1772 // charset changed from constant to global (dynamic utf-8 switching)
1775 // (c-file-style: "gnu")
1779 // c-basic-offset: 4
1780 // c-hanging-comment-ender-p: nil
1781 // indent-tabs-mode: nil