lib/plugin/ListPages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /*
   4  Copyright 2004 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   8  PhpWiki is free software; you can redistribute it and/or modify
   9  it under the terms of the GNU General Public License as published by
  10  the Free Software Foundation; either version 2 of the License, or
  11  (at your option) any later version.
  12
  13  PhpWiki is distributed in the hope that it will be useful,
  14  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  GNU General Public License for more details.
  17
  18  You should have received a copy of the GNU General Public License
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 require_once('lib/PageList.php');
  24
  25 /**
  26  * ListPages - List pages that are explicitly given as the pages argument.
  27  *
  28  * Mainly used to see some ratings and recommendations.
  29  * But also possible to list some Categories or Users, or as generic
  30  * frontend for plugin-list page lists.
  31  *
  32  * @author: Dan Frankowski
  33  */
  34 class WikiPlugin_ListPages
  35 extends WikiPlugin
  36 {
  37     function getName() {
  38         return _("ListPages");
  39     }
  40
  41     function getDescription() {
  42         return _("List pages that are explicitly given as the pages argument.");
  43     }
  44
  45     function getVersion() {
  46         return preg_replace("/[Revision: $]/", '',
  47                             "\$Revision$");
  48     }
  49
  50     function getDefaultArguments() {
  51         return array_merge
  52             (
  53              PageList::supportedArgs(),
  54              array('pages'    => false,
  55                    //'exclude'  => false,
  56                    'info'     => 'pagename',
  57                    'dimension' => 0,
  58                    ));
  59     }
  60
  61     // info arg allows multiple columns
  62     // info=mtime,hits,summary,version,author,locked,minor
  63     // additional info args:
  64     //   top3recs      : recommendations
  65     //   numbacklinks  : number of backlinks (links to the given page)
  66     //   numpagelinks  : number of forward links (links at the given page)
  67
  68     function run($dbi, $argstr, &$request, $basepage) {
  69         $args = $this->getArgs($argstr, $request);
  70
  71         if (!empty($args['limit']) && !is_numeric($args['limit'])) {
  72             return $this->error(_("Illegal 'limit' argument: must be numeric"));
  73         }
  74
  75         extract($args);
  76         // If the ratings table does not exist, or on dba it will break otherwise.
  77         // Check if WikiTheme isa 'wikilens'
  78         if ($info == 'pagename' and isa($GLOBALS['WikiTheme'], 'wikilens'))
  79             $info .= ",top3recs";
  80         if ($info)
  81             $info = split(',', $info);
  82         else
  83             $info = array();
  84
  85         if (in_array('top3recs', $info)) {
  86             require_once('lib/wikilens/Buddy.php');
  87             require_once('lib/wikilens/PageListColumns.php');
  88
  89             $active_user   = $request->getUser();
  90             $active_userid = $active_user->_userid;
  91
  92             // if userids is null or empty, fill it with just the active user
  93             if (!isset($userids) || !is_array($userids) || !count($userids)) {
  94                 // TKL: moved getBuddies call inside if statement because it was
  95                 // causing the userids[] parameter to be ignored
  96                 if (is_string($active_userid)
  97                     and strlen($active_userid)
  98                     and $active_user->isSignedIn())
  99                 {
 100                     $userids = getBuddies($active_userid, $dbi);
 101                 } else {
 102                     $userids = array();
 103                     // XXX: this wipes out the category caption...
 104                     $caption = _("You must be logged in to view ratings.");
 105                 }
 106             }
 107
 108             // find out which users we should show ratings for
 109             $allowed_users = array();
 110             foreach ($userids as $userid) {
 111                 $user = new RatingsUser($userid);
 112                 if ($user->allow_view_ratings($active_user)) {
 113                     array_push($allowed_users, $user);
 114                 }
 115                 // PHP's silly references... (the behavior with this line commented
 116                 // out is... odd)
 117                 unset($user);
 118             }
 119             $options = array('dimension' => $dimension,
 120                              'users' => $allowed_users);
 121             $args = array_merge($options, $args);
 122         }
 123         if (empty($pages) and $pages != '0')
 124             return '';
 125
 126         if (in_array('numbacklinks', $info)) {
 127             $args['types']['numbacklinks'] = new _PageList_Column_ListPages_count('numbacklinks', _("#"), true);
 128         }
 129         if (in_array('numpagelinks', $info)) {
 130             $args['types']['numpagelinks'] = new _PageList_Column_ListPages_count('numpagelinks', _("#"));
 131         }
 132
 133         $pagelist = new PageList($info, $exclude, $args);
 134         $pages_array = is_string($pages) ? explodePageList($pages) : (is_array($pages) ? $pages : array());
 135         $pagelist->addPageList($pages_array);
 136         return $pagelist;
 137     }
 138 };
 139
 140 // how many back-/forwardlinks for this page
 141 class _PageList_Column_ListPages_count extends _PageList_Column {
 142     function _PageList_Column_ListPages_count($field, $display, $backwards = false) {
 143         $this->_direction = $backwards;
 144         return $this->_PageList_Column($field, $display, 'center');
 145     }
 146     function _getValue($page, &$revision_handle) {
 147         $iter = $page->getLinks($this->_direction);
 148         $count = $iter->count();
 149         return $count;
 150     }
 151 }
 152
 153 // Local Variables:
 154 // mode: php
 155 // tab-width: 8
 156 // c-basic-offset: 4
 157 // c-hanging-comment-ender-p: nil
 158 // indent-tabs-mode: nil
 159 // End:
 160 ?>