1 <?php rcs_id('$Id: PageList.php,v 1.86 2004-06-13 15:51:37 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 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"), //todo: implement this again for PagePerm
25 * 'owner' _("Owner"), //todo: implement this again for PagePerm
26 * 'checkbox' A selectable checkbox appears at the left.
27 * Todo: move this admin action away, not really an info column
30 * Special, custom columns: Either theme or plugin specific.
31 * 'remove' _("Remove")
32 * 'perm' _("Permission Mask")
34 * 'renamed_pagename' _("Rename to")
35 * 'rating' wikilens theme specific.
36 * 'custom' See plugin/WikiTranslation
38 * Symbolic 'info=' arguments:
39 * 'all' All columns except the special columns
40 * 'most' pagename, mtime, author, size, hits, ...
41 * 'some' pagename, mtime, author
43 * FIXME: In this refactoring I (Jeff) have un-implemented _ctime, _cauthor, and
44 * number-of-revision. Note the _ctime and _cauthor as they were implemented
45 * were somewhat flawed: revision 1 of a page doesn't have to exist in the
46 * database. If lots of revisions have been made to a page, it's more than likely
47 * that some older revisions (include revision 1) have been cleaned (deleted).
50 * check PagePerm "list" access-type
53 * limit, offset, rows arguments for multiple pages/multiple rows.
55 * ->supportedArgs() which arguments are supported, so that the plugin
56 * doesn't explictly need to declare it
58 * list not as <ul> or table, but as simple comma-seperated list
60 class _PageList_Column_base {
61 var $_tdattr = array();
63 function _PageList_Column_base ($default_heading, $align = false) {
64 $this->_heading = $default_heading;
67 // align="char" isn't supported by any browsers yet :(
68 //if (is_array($align))
69 // $this->_tdattr = $align;
71 $this->_tdattr['align'] = $align;
75 function format ($pagelist, $page_handle, &$revision_handle) {
76 return HTML::td($this->_tdattr,
78 $this->_getValue($page_handle, $revision_handle),
82 function setHeading ($heading) {
83 $this->_heading = $heading;
88 if (in_array($this->_field,PageList::sortable_columns())) {
89 // multiple comma-delimited sortby args: "+hits,+pagename"
90 // asc or desc: +pagename, -pagename
91 $sortby = PageList::sortby($this->_field,'flip_order');
92 //Fixme: pass all also other GET args along. (limit, p[])
93 $s = HTML::a(array('href' =>
94 $GLOBALS['request']->GetURLtoSelf(array('sortby' => $sortby,
96 'class' => 'pagetitle',
97 'title' => sprintf(_("Sort by %s"),$this->_field)),
98 HTML::raw(' '), HTML::u($this->_heading), HTML::raw(' '));
100 $s = HTML(HTML::raw(' '), HTML::u($this->_heading), HTML::raw(' '));
102 return HTML::th(array('align' => 'center'),$s);
107 function button_heading () {
108 global $Theme, $request;
110 if (in_array($this->_field,PageList::sortable_columns())) {
111 // multiple comma-delimited sortby args: "+hits,+pagename"
113 $noimg_src = $Theme->getButtonURL('no_order');
115 $noimg = HTML::img(array('src' => $noimg_src,
120 else $noimg = HTML::raw(' ');
121 if ($request->getArg('sortby')) {
122 if (PageList::sortby($this->_field,'check')) { // show icon?
123 $sortby = PageList::sortby($request->getArg('sortby'),'flip_order');
124 $request->setArg('sortby',$sortby);
125 $desc = (substr($sortby,0,1) == '-'); // asc or desc? (+pagename, -pagename)
126 $src = $Theme->getButtonURL($desc ? 'asc_order' : 'desc_order');
128 $sortby = PageList::sortby($this->_field,'init');
131 $sortby = PageList::sortby($this->_field,'init');
135 //$img->setAttr('alt', _("Click to sort"));
137 $img = HTML::img(array('src' => $src,
141 'alt' => _("Click to reverse sort order")));
143 $s = HTML::a(array('href' =>
144 //Fixme: pass all also other GET args along. (limit, p[])
145 //Fixme: convert to POST submit[sortby]
146 $request->GetURLtoSelf(array('sortby' => $sortby,
148 'class' => 'gridbutton',
149 'title' => sprintf(_("Click to sort by %s"),$this->_field)),
156 HTML::raw(' '));
158 $s = HTML(HTML::raw(' '), $this->_heading, HTML::raw(' '));
160 return HTML::th(array('align' => 'center', 'valign' => 'middle',
161 'class' => 'gridbutton'), $s);
165 class _PageList_Column extends _PageList_Column_base {
166 function _PageList_Column ($field, $default_heading, $align = false) {
167 $this->_PageList_Column_base($default_heading, $align);
169 $this->_need_rev = substr($field, 0, 4) == 'rev:';
170 $this->_iscustom = substr($field, 0, 7) == 'custom:';
171 if ($this->_iscustom)
172 $this->_field = substr($field, 7);
173 elseif ($this->_need_rev)
174 $this->_field = substr($field, 4);
176 $this->_field = $field;
179 function _getValue ($page_handle, &$revision_handle) {
180 if ($this->_need_rev) {
181 if (!$revision_handle)
182 $revision_handle = $page_handle->getCurrentRevision();
183 return $revision_handle->get($this->_field);
186 return $page_handle->get($this->_field);
191 class _PageList_Column_size extends _PageList_Column {
192 function _getValue ($page_handle, &$revision_handle) {
193 if (!$revision_handle)
194 $revision_handle = $page_handle->getCurrentRevision();
195 return $this->_getSize($revision_handle);
198 function _getSize($revision_handle) {
199 $bytes = @strlen($revision_handle->_data['%content']);
200 return ByteFormatter($bytes);
205 class _PageList_Column_bool extends _PageList_Column {
206 function _PageList_Column_bool ($field, $default_heading, $text = 'yes') {
207 $this->_PageList_Column($field, $default_heading, 'center');
208 $this->_textIfTrue = $text;
209 $this->_textIfFalse = new RawXml('—'); //mdash
212 function _getValue ($page_handle, &$revision_handle) {
213 $val = _PageList_Column::_getValue($page_handle, $revision_handle);
214 return $val ? $this->_textIfTrue : $this->_textIfFalse;
218 class _PageList_Column_checkbox extends _PageList_Column {
219 function _PageList_Column_checkbox ($field, $default_heading, $name='p') {
220 $this->_name = $name;
221 $heading = HTML::input(array('type' => 'button',
222 'title' => _("Click to de-/select all pages"),
224 'name' => $default_heading,
225 'value' => $default_heading,
226 'onclick' => "flipAll(this.form)"
228 $this->_PageList_Column($field, $heading, 'center');
230 function _getValue ($pagelist, $page_handle, &$revision_handle) {
231 $pagename = $page_handle->getName();
232 $selected = !empty($pagelist->_selected[$pagename]);
233 if (strstr($pagename,'[') or strstr($pagename,']')) {
234 $pagename = str_replace(array('[',']'),array('%5B','%5D'),$pagename);
237 return HTML::input(array('type' => 'checkbox',
238 'name' => $this->_name . "[$pagename]",
240 'checked' => 'CHECKED'));
242 return HTML::input(array('type' => 'checkbox',
243 'name' => $this->_name . "[$pagename]",
247 function format ($pagelist, $page_handle, &$revision_handle) {
248 return HTML::td($this->_tdattr,
250 $this->_getValue($pagelist, $page_handle, $revision_handle),
251 HTML::raw(' '));
255 class _PageList_Column_time extends _PageList_Column {
256 function _PageList_Column_time ($field, $default_heading) {
257 $this->_PageList_Column($field, $default_heading, 'right');
259 $this->Theme = &$Theme;
262 function _getValue ($page_handle, &$revision_handle) {
263 $time = _PageList_Column::_getValue($page_handle, $revision_handle);
264 return $this->Theme->formatDateTime($time);
268 class _PageList_Column_version extends _PageList_Column {
269 function _getValue ($page_handle, &$revision_handle) {
270 if (!$revision_handle)
271 $revision_handle = $page_handle->getCurrentRevision();
272 return $revision_handle->getVersion();
276 // Output is hardcoded to limit of first 50 bytes. Otherwise
277 // on very large Wikis this will fail if used with AllPages
278 // (PHP memory limit exceeded)
279 // FIXME: old PHP without superglobals
280 class _PageList_Column_content extends _PageList_Column {
281 function _PageList_Column_content ($field, $default_heading, $align = false) {
282 _PageList_Column::_PageList_Column($field, $default_heading, $align);
284 if ($field == 'content') {
285 $this->_heading .= sprintf(_(" ... first %d bytes"),
287 } elseif ($field == 'hi_content') {
288 if (!empty($_POST['admin_replace'])) {
289 $search = $_POST['admin_replace']['from'];
290 $this->_heading .= sprintf(_(" ... around %s"),
295 function _getValue ($page_handle, &$revision_handle) {
296 if (!$revision_handle)
297 $revision_handle = $page_handle->getCurrentRevision();
298 // Not sure why implode is needed here, I thought
299 // getContent() already did this, but it seems necessary.
300 $c = implode("\n", $revision_handle->getContent());
301 if ($this->_field == 'hi_content') {
302 $search = $_POST['admin_replace']['from'];
303 if ($search and ($i = strpos($c,$search))) {
304 $l = strlen($search);
305 $j = max(0,$i - ($this->bytes / 2));
306 return HTML::div(array('style' => 'font-size:x-small'),
307 HTML::div(array('class' => 'transclusion'),
308 HTML::span(substr($c, $j, ($this->bytes / 2))),
309 HTML::span(array("style"=>"background:yellow"),$search),
310 HTML::span(substr($c, $i+$l, ($this->bytes / 2))))
313 $c = sprintf(_("%s not found"),
315 return HTML::div(array('style' => 'font-size:x-small','align'=>'center'),
318 } elseif (($len = strlen($c)) > $this->bytes) {
319 $c = substr($c, 0, $this->bytes);
321 include_once('lib/BlockParser.php');
322 // false --> don't bother processing hrefs for embedded WikiLinks
323 $ct = TransformText($c, $revision_handle->get('markup'), false);
324 return HTML::div(array('style' => 'font-size:x-small'),
325 HTML::div(array('class' => 'transclusion'), $ct),
326 // Don't show bytes here if size column present too
327 ($this->parent->_columns_seen['size'] or !$len) ? "" :
328 ByteFormatter($len, /*$longformat = */true));
332 class _PageList_Column_author extends _PageList_Column {
333 function _PageList_Column_author ($field, $default_heading, $align = false) {
334 _PageList_Column::_PageList_Column($field, $default_heading, $align);
335 $this->dbi =& $GLOBALS['request']->getDbh();
338 function _getValue ($page_handle, &$revision_handle) {
339 $author = _PageList_Column::_getValue($page_handle, $revision_handle);
340 if (isWikiWord($author) && $this->dbi->isWikiPage($author))
341 return WikiLink($author);
347 class _PageList_Column_owner extends _PageList_Column_author {
348 function _getValue ($page_handle, &$revision_handle) {
349 $author = $page_handle->getOwner();
350 if (isWikiWord($author) && $this->dbi->isWikiPage($author))
351 return WikiLink($author);
356 class _PageList_Column_creator extends _PageList_Column_author {
357 function _getValue ($page_handle, &$revision_handle) {
358 $author = $page_handle->getCreator();
359 if (isWikiWord($author) && $this->dbi->isWikiPage($author))
360 return WikiLink($author);
366 // DONE: only if RateIt is used
367 // class _PageList_Column_rating extends _PageList_Column
368 // moved to theme/wikilens/themeinfo.php
370 class _PageList_Column_pagename extends _PageList_Column_base {
371 var $_field = 'pagename';
373 function _PageList_Column_pagename () {
374 $this->_PageList_Column_base(_("Page Name"));
376 $this->dbi = &$request->getDbh();
379 function _getValue ($page_handle, &$revision_handle) {
380 if ($this->dbi->isWikiPage($page_handle->getName()))
381 return WikiLink($page_handle);
383 return WikiLink($page_handle, 'unknown');
390 var $_group_rows = 3;
391 var $_columns = array();
392 var $_excluded_pages = array();
393 var $_rows = array();
395 var $_pagename_seen = false;
396 var $_types = array();
397 var $_options = array();
398 var $_selected = array();
399 var $_sortby = array();
402 function PageList ($columns = false, $exclude = false, $options = false) {
403 // let plugins predefine only certain objects, such its own custom pagelist columns
404 if (!empty($options['types'])) {
405 $this->_types = $options['types'];
406 unset($options['types']);
408 $this->_initAvailableColumns();
411 'all' => array_diff(array_keys($this->_types), // all but...
412 array('checkbox','remove','renamed_pagename',
413 'content','hi_content','perm','acl')),
414 'most' => array('pagename','mtime','author','size','hits'),
415 'some' => array('pagename','mtime','author')
418 if (!is_array($columns))
419 $columns = explode(',', $columns);
420 // expand symbolic columns:
421 foreach ($symbolic_columns as $symbol => $cols) {
422 if (in_array($symbol,$columns)) { // e.g. 'checkbox,all'
423 $columns = array_diff(array_merge($columns,$cols),array($symbol));
426 if (!in_array('pagename',$columns))
427 $this->_addColumn('pagename');
428 foreach ($columns as $col) {
429 $this->_addColumn($col);
432 $this->_addColumn('pagename');
434 $this->_options = $options;
435 foreach (array('sortby','limit','paging','count') as $key) {
436 if (!empty($options) and !empty($options[$key])) {
437 $this->_options[$key] = $options[$key];
439 $this->_options[$key] = $GLOBALS['request']->getArg($key);
442 $this->_options['sortby'] = $this->sortby($this->_options['sortby'], 'init');
444 if (!is_array($exclude))
445 $exclude = $this->explodePageList($exclude,false,
446 $this->_options['sortby'],
447 $this->_options['limit']);
448 $this->_excluded_pages = $exclude;
450 $this->_messageIfEmpty = _("<no matches>");
453 // Currently PageList takes these arguments:
454 // 1: info, 2: exclude, 3: hash of options
455 // Here we declare which options are supported, so that
456 // the calling plugin may simply merge this with its own default arguments
457 function supportedArgs () {
458 return array(//Currently supported options:
459 'info' => 'pagename',
460 'exclude' => '', // also wildcards and comma-seperated lists
462 // for the sort buttons in <th>
463 'sortby' => '', // same as for WikiDB::getAllPages
465 //PageList pager options:
466 // These options may also be given to _generate(List|Table) later
467 // But limit and offset might help the query WikiDB::getAllPages()
468 'cols' => 1, // side-by-side display of list (1-3)
469 'limit' => 50, // number of rows
470 'paging' => 'auto', // 'auto' normal paging mode
471 // // 'smart' drop 'info' columns and enhance rows
472 // // when the list becomes large
473 // // 'none' don't page at all
474 //'azhead' => 0 // provide shortcut links to pages starting with different letters
478 function setCaption ($caption_string) {
479 $this->_caption = $caption_string;
482 function getCaption () {
483 // put the total into the caption if needed
484 if (is_string($this->_caption) && strstr($this->_caption, '%d'))
485 return sprintf($this->_caption, $this->getTotal());
486 return $this->_caption;
489 function setMessageIfEmpty ($msg) {
490 $this->_messageIfEmpty = $msg;
494 function getTotal () {
495 return !empty($this->_options['count'])
496 ? (integer) $this->_options['count'] : count($this->_rows);
499 function isEmpty () {
500 return empty($this->_rows);
503 function addPage ($page_handle) {
504 if (is_string($page_handle)) {
505 if ($page_handle == '') return;
506 if (in_array($page_handle, $this->_excluded_pages))
507 return; // exclude page.
508 $dbi = $GLOBALS['request']->getDbh();
509 $page_handle = $dbi->getPage($page_handle);
510 } elseif (is_object($page_handle)) {
511 if (in_array($page_handle->getName(), $this->_excluded_pages))
512 return; // exclude page.
514 //FIXME. only on sf.net
515 if (!is_object($page_handle)) {
516 trigger_error("PageList: Invalid page_handle $page_handle", E_USER_WARNING);
519 // enforce view permission
520 if (!mayAccessPage('view',$page_handle->getName()))
523 $group = (int)(count($this->_rows) / $this->_group_rows);
524 $class = ($group % 2) ? 'oddrow' : 'evenrow';
525 $revision_handle = false;
526 $this->_maxlen = max($this->_maxlen,strlen($page_handle->getName()));
528 if (count($this->_columns) > 1) {
529 $row = HTML::tr(array('class' => $class));
530 foreach ($this->_columns as $col)
531 $row->pushContent($col->format($this, $page_handle, $revision_handle));
534 $col = $this->_columns[0];
535 $row = $col->_getValue($page_handle, $revision_handle);
538 $this->_rows[] = $row;
541 function addPages ($page_iter) {
542 //Todo: if limit check max(strlen(pagename))
543 while ($page = $page_iter->next())
544 $this->addPage($page);
547 function addPageList (&$list) {
549 while ($page = next($list))
550 $this->addPage((string)$page);
554 global $DBParams, $request;
555 if ($DBParams['dbtype'] == 'SQL' or $DBParams['dbtype'] == 'ADODB') {
556 $dbi =& $request->getDbh();
557 extract($dbi->_backend->_table_names);
558 if ($DBParams['dbtype'] == 'SQL') {
559 $res = $dbi->_backend->_dbh->getOne("SELECT max(length(pagename)) FROM $page_tbl LIMIT 1");
560 if (DB::isError($res) || empty($res)) return false;
562 } elseif ($DBParams['dbtype'] == 'ADODB') {
563 $row = $dbi->_backend->_dbh->getRow("SELECT max(length(pagename)) FROM $page_tbl LIMIT 1");
564 return $row ? $row[0] : false;
570 function getContent() {
571 // Note that the <caption> element wants inline content.
572 $caption = $this->getCaption();
574 if ($this->isEmpty())
575 return $this->_emptyList($caption);
576 elseif (count($this->_columns) == 1)
577 return $this->_generateList($caption);
579 return $this->_generateTable($caption);
582 function printXML() {
583 PrintXML($this->getContent());
587 return AsXML($this->getContent());
590 function sortable_columns() {
591 return array('pagename','mtime','hits');
595 * Handle sortby requests for the DB iterator and table header links.
596 * Prefix the column with + or - like "+pagename","-mtime", ...
597 * db supported columns: 'pagename','mtime','hits'
598 * supported actions: 'flip_order' "mtime" => "+mtime" => "-mtime" ...
599 * 'db' "-pagename" => "pagename DESC"
600 * which other column types should be sortable?
602 function sortby ($column, $action) {
603 if (empty($column)) return;
604 //support multiple comma-delimited sortby args: "+hits,+pagename"
605 if (strstr($column,',')) {
607 foreach (explode(',',$column) as $col) {
608 $result[] = $this->sortby($col,$action);
610 return join(",",$result);
612 if (substr($column,0,1) == '+') {
613 $order = '+'; $column = substr($column,1);
614 } elseif (substr($column,0,1) == '-') {
615 $order = '-'; $column = substr($column,1);
617 if (in_array($column,PageList::sortable_columns())) {
618 // default order: +pagename, -mtime, -hits
620 if (in_array($column,array('mtime','hits')))
624 if ($action == 'flip_order') {
625 return ($order == '+' ? '-' : '+') . $column;
626 } elseif ($action == 'init') {
627 $this->_sortby[$column] = $order;
628 return $order . $column;
629 } elseif ($action == 'check') {
630 return (!empty($this->_sortby[$column]) or
631 ($GLOBALS['request']->getArg('sortby') and
632 strstr($GLOBALS['request']->getArg('sortby'),$column)));
633 } elseif ($action == 'db') {
634 // asc or desc: +pagename, -pagename
635 return $column . ($order == '+' ? ' ASC' : ' DESC');
641 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
642 function explodePageList($input, $perm = false, $sortby=false, $limit=false) {
643 // expand wildcards from list of all pages
644 if (preg_match('/[\?\*]/',$input)) {
645 $dbi = $GLOBALS['request']->getDbh();
646 $allPagehandles = $dbi->getAllPages($perm,$sortby,$limit);
647 while ($pagehandle = $allPagehandles->next()) {
648 $allPages[] = $pagehandle->getName();
650 return explodeList($input, $allPages);
652 //TODO: do the sorting, normally not needed if used for exclude only
653 return explode(',',$input);
657 function allPagesByAuthor($wildcard, $perm=false, $sortby=false, $limit=false) {
658 $dbi = $GLOBALS['request']->getDbh();
659 $allPagehandles = $dbi->getAllPages($perm, $sortby, $limit);
661 if ($wildcard === '[]') {
662 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
663 if (!$wildcard) return $allPages;
665 while ($pagehandle = $allPagehandles->next()) {
666 $name = $pagehandle->getName();
667 $author = $pagehandle->getAuthor();
669 if (preg_match('/[\?\*]/', $wildcard)) {
670 if (glob_match($wildcard, $author))
672 } elseif ($wildcard == $author) {
680 function allPagesByOwner($wildcard, $perm=false, $sortby=false, $limit=false) {
681 $dbi = $GLOBALS['request']->getDbh();
682 $allPagehandles = $dbi->getAllPages($perm, $sortby, $limit);
684 if ($wildcard === '[]') {
685 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
686 if (!$wildcard) return $allPages;
688 while ($pagehandle = $allPagehandles->next()) {
689 $name = $pagehandle->getName();
690 $owner = $pagehandle->getOwner();
692 if (preg_match('/[\?\*]/', $wildcard)) {
693 if (glob_match($wildcard, $owner))
695 } elseif ($wildcard == $owner) {
703 function allPagesByCreator($wildcard, $perm=false, $sortby=false, $limit=false) {
704 $dbi = $GLOBALS['request']->getDbh();
705 $allPagehandles = $dbi->getAllPages($perm, $sortby, $limit);
707 if ($wildcard === '[]') {
708 $wildcard = $GLOBALS['request']->_user->getAuthenticatedId();
709 if (!$wildcard) return $allPages;
711 while ($pagehandle = $allPagehandles->next()) {
712 $name = $pagehandle->getName();
713 $creator = $pagehandle->getCreator();
715 if (preg_match('/[\?\*]/', $wildcard)) {
716 if (glob_match($wildcard, $creator))
718 } elseif ($wildcard == $creator) {
729 /** Plugin and theme hooks:
730 * If the pageList is initialized with $options['types'] these types are also initialized,
731 * overriding the standard types.
733 function _initAvailableColumns() {
734 global $customPageListColumns;
738 => new _PageList_Column_content('rev:content', _("Content")),
739 // new: plugin specific column types initialised by the relevant plugins
741 'hi_content' // with highlighted search for SearchReplace
742 => new _PageList_Column_content('rev:hi_content', _("Content")),
744 => new _PageList_Column_remove('remove', _("Remove")),
745 // initialised by the plugin
747 => new _PageList_Column_renamed_pagename('rename', _("Rename to")),
749 => new _PageList_Column_perm('perm', _("Permission")),
751 => new _PageList_Column_acl('acl', _("ACL")),
754 => new _PageList_Column_checkbox('p', _("Select")),
756 => new _PageList_Column_pagename,
758 => new _PageList_Column_time('rev:mtime', _("Last Modified")),
760 => new _PageList_Column('hits', _("Hits"), 'right'),
762 => new _PageList_Column_size('rev:size', _("Size"), 'right'),
763 /*array('align' => 'char', 'char' => ' ')*/
765 => new _PageList_Column('rev:summary', _("Last Summary")),
767 => new _PageList_Column_version('rev:version', _("Version"),
770 => new _PageList_Column_author('rev:author', _("Last Author")),
772 => new _PageList_Column_owner('author_id', _("Owner")),
774 => new _PageList_Column_creator('author_id', _("Creator")),
777 => new _PageList_Column_author('group', _("Group")),
780 => new _PageList_Column_bool('locked', _("Locked"),
783 => new _PageList_Column_bool('rev:is_minor_edit',
784 _("Minor Edit"), _("minor")),
786 => new _PageList_Column('rev:markup', _("Markup")),
787 // 'rating' initialised by the wikilens theme hook: addPageListColumn
790 => new _PageList_Column_rating('rating', _("Rate")),
793 if (empty($this->_types))
794 $this->_types = array();
795 // add plugin specific pageList columns, initialized by $options['types']
796 $this->_types = array_merge($standard_types, $this->_types);
797 // add theme specific pageList columns
798 if (!empty($customPageListColumns))
799 $this->_types = array_merge($this->_types, $customPageListColumns);
802 function _addColumn ($column) {
804 if (isset($this->_columns_seen[$column]))
805 return false; // Already have this one.
806 if (!isset($this->_types[$column]))
807 $this->_initAvailableColumns();
808 $this->_columns_seen[$column] = true;
810 if (strstr($column, ':'))
811 list ($column, $heading) = explode(':', $column, 2);
813 if (!isset($this->_types[$column])) {
814 //trigger_error(sprintf("%s: Bad column", $column), E_USER_NOTICE);
817 if ($column == 'rating' and !$GLOBALS['request']->_user->isSignedIn())
820 $col = $this->_types[$column];
821 if (!empty($heading))
822 $col->setHeading($heading);
824 $this->_columns[] = $col;
829 function limit($limit) {
830 if (strstr($limit,','))
831 return split(',',$limit);
833 return array(0,$limit);
836 // make a table given the caption
837 function _generateTable($caption) {
838 $table = HTML::table(array('cellpadding' => 0,
841 'class' => 'pagelist'));
843 $table->pushContent(HTML::caption(array('align'=>'top'), $caption));
845 //Warning: This is quite fragile. It depends solely on a private variable
847 if (!empty($this->_columns_seen['checkbox'])) {
848 $table->pushContent($this->_jsFlipAll());
850 $do_paging = ( isset($this->_options['paging']) and
851 !empty($this->_options['limit']) and $this->getTotal() and
852 $this->_options['paging'] != 'none' );
854 $table_summary = array();
855 foreach ($this->_columns as $col) {
856 $heading = $col->button_heading();
858 isset($col->_field) and $col->_field == 'pagename' and
859 ($maxlen = $this->maxLen()))
860 $heading->setAttr('width',$maxlen * 7);
861 $row->pushContent($heading);
862 if (is_string($col->_heading))
863 $table_summary[] = $col->_heading;
865 // Table summary for non-visual browsers.
866 $table->setAttr('summary', sprintf(_("Columns: %s."),
867 implode(", ", $table_summary)));
870 // if there are more pages than the limit, show a table-header, -footer
871 list($offset,$pagesize) = $this->limit($this->_options['limit']);
872 $numrows = $this->getTotal();
874 (!$offset and $numrows <= $pagesize) or
875 ($offset + $pagesize < 0))
877 $table->pushContent(HTML::thead($row),
878 HTML::tbody(false, $this->_rows));
882 include_once('lib/Template.php');
885 $pagename = $request->getArg('pagename');
886 $defargs = $request->args;
887 unset($defargs['pagename']); unset($defargs['action']);
888 //$defargs['nocache'] = 1;
890 $tokens['PREV'] = false; $tokens['PREV_LINK'] = "";
891 $tokens['COLS'] = count($this->_columns);
892 $tokens['COUNT'] = $numrows;
893 $tokens['OFFSET'] = $offset;
894 $tokens['SIZE'] = $pagesize;
895 $tokens['NUMPAGES'] = (int)($numrows / $pagesize)+1;
896 $tokens['ACTPAGE'] = (int) (($offset+1) / $pagesize)+1;
898 $prev['limit'] = min(0,$offset - $pagesize) . ",$pagesize";
899 $prev['count'] = $numrows;
900 $tokens['LIMIT'] = $prev['limit'];
901 $tokens['PREV'] = true;
902 $tokens['PREV_LINK'] = WikiURL($pagename,$prev);
903 $prev['limit'] = "0,$pagesize";
904 $tokens['FIRST_LINK'] = WikiURL($pagename,$prev);
907 $tokens['NEXT'] = false; $tokens['NEXT_LINK'] = "";
908 if ($offset + $pagesize < $numrows) {
909 $next['limit'] = min($offset + $pagesize,$numrows - $pagesize) . ",$pagesize";
910 $next['count'] = $numrows;
911 $tokens['LIMIT'] = $next['limit'];
912 $tokens['NEXT'] = true;
913 $tokens['NEXT_LINK'] = WikiURL($pagename,$next);
914 $next['limit'] = $numrows - $pagesize . ",$pagesize";
915 $tokens['LAST_LINK'] = WikiURL($pagename,$next);
917 $paging = new Template("pagelink", $request, $tokens);
918 $table->pushContent(HTML::thead($paging),
919 HTML::tbody(false,HTML($row,$this->_rows)),
920 HTML::tfoot($paging));
923 $table->pushContent(HTML::thead($row),
924 HTML::tbody(false, $this->_rows));
928 function _jsFlipAll() {
930 function flipAll(formObj) {
932 for (var i=0;i < formObj.length;i++) {
933 fldObj = formObj.elements[i];
934 if (fldObj.type == 'checkbox') {
935 if (isFirstSet == -1)
936 isFirstSet = (fldObj.checked) ? true : false;
937 fldObj.checked = (isFirstSet) ? false : true;
943 function _generateList($caption) {
944 $list = HTML::ul(array('class' => 'pagelist'));
946 foreach ($this->_rows as $page) {
947 $group = ($i++ / $this->_group_rows);
948 $class = ($group % 2) ? 'oddrow' : 'evenrow';
949 $list->pushContent(HTML::li(array('class' => $class),$page));
952 //Warning: This is quite fragile. It depends solely on a private variable
954 // Questionable if its of use here anyway. This is a one-col pagename list only.
955 //if (!empty($this->_columns_seen['checkbox'])) $out->pushContent($this->_jsFlipAll());
957 $out->pushContent(HTML::p($caption));
958 $out->pushContent($list);
962 function _emptyList($caption) {
965 $html->pushContent(HTML::p($caption));
966 if ($this->_messageIfEmpty)
967 $html->pushContent(HTML::blockquote(HTML::p($this->_messageIfEmpty)));
971 // Condense list: "Page1, Page2, ..."
972 // Alternative $seperator = HTML::Raw(' · ')
973 function _generateCommaList($seperator = ', ') {
974 return HTML(join($seperator, $list));
979 /* List pages with checkboxes to select from.
980 * The [Select] button toggles via _jsFlipAll
983 class PageList_Selectable
986 function PageList_Selectable ($columns=false, $exclude=false) {
988 if (!is_array($columns))
989 $columns = explode(',', $columns);
990 if (!in_array('checkbox',$columns))
991 array_unshift($columns,'checkbox');
993 $columns = array('checkbox','pagename');
995 PageList::PageList($columns,$exclude);
998 function addPageList ($array) {
999 while (list($pagename,$selected) = each($array)) {
1000 if ($selected) $this->addPageSelected((string)$pagename);
1001 $this->addPage((string)$pagename);
1005 function addPageSelected ($pagename) {
1006 $this->_selected[$pagename] = 1;
1009 //insert javascript when clicked on Selected Select/Deselect all
1012 // $Log: not supported by cvs2svn $
1013 // Revision 1.85 2004/06/13 15:33:19 rurban
1014 // new support for arguments owner, author, creator in most relevant
1015 // PageList plugins. in WikiAdmin* via preSelectS()
1017 // Revision 1.84 2004/06/08 13:51:56 rurban
1018 // some comments only
1020 // Revision 1.83 2004/05/18 13:35:39 rurban
1021 // improve Pagelist layout by equal pagename width for limited lists
1023 // Revision 1.82 2004/05/16 22:07:35 rurban
1024 // check more config-default and predefined constants
1025 // various PagePerm fixes:
1026 // fix default PagePerms, esp. edit and view for Bogo and Password users
1027 // implemented Creator and Owner
1028 // BOGOUSERS renamed to BOGOUSER
1029 // fixed syntax errors in signin.tmpl
1031 // Revision 1.81 2004/05/13 12:30:35 rurban
1032 // fix for MacOSX border CSS attr, and if sort buttons are not found
1034 // Revision 1.80 2004/04/20 00:56:00 rurban
1035 // more paging support and paging fix for shorter lists
1037 // Revision 1.79 2004/04/20 00:34:16 rurban
1038 // more paging support
1040 // Revision 1.78 2004/04/20 00:06:03 rurban
1041 // themable paging support
1043 // Revision 1.77 2004/04/18 01:11:51 rurban
1044 // more numeric pagename fixes.
1045 // fixed action=upload with merge conflict warnings.
1046 // charset changed from constant to global (dynamic utf-8 switching)
1049 // (c-file-style: "gnu")
1053 // c-basic-offset: 4
1054 // c-hanging-comment-ender-p: nil
1055 // indent-tabs-mode: nil