lib/plugin/ListPages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: ListPages.php,v 1.10 2005-09-27 17:34:19 rurban Exp $');
   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: 1.10 $");
  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         extract($args);
  71         // If the ratings table does not exist, or on dba it will break otherwise.
  72         // Check if Theme isa 'wikilens'
  73         if ($info == 'pagename' and isa($GLOBALS['WikiTheme'], 'wikilens'))
  74             $info .= ",top3recs";
  75         if ($info)
  76             $info = split(',', $info);
  77         else
  78             $info = array();
  79
  80         if (in_array('top3recs', $info)) {
  81             require_once('lib/wikilens/Buddy.php');
  82             require_once('lib/wikilens/PageListColumns.php');
  83
  84             $active_user   = $request->getUser();
  85             $active_userid = $active_user->_userid;
  86
  87             // if userids is null or empty, fill it with just the active user
  88             if (!isset($userids) || !is_array($userids) || !count($userids)) {
  89                 // TKL: moved getBuddies call inside if statement because it was
  90                 // causing the userids[] parameter to be ignored
  91                 if (is_string($active_userid)
  92                     and strlen($active_userid)
  93                     and $active_user->isSignedIn())
  94                 {
  95                     $userids = getBuddies($active_userid, $dbi);
  96                 } else {
  97                     $userids = array();
  98                     // XXX: this wipes out the category caption...
  99                     $caption = _("You must be logged in to view ratings.");
 100                 }
 101             }
 102
 103             // find out which users we should show ratings for
 104             $allowed_users = array();
 105             foreach ($userids as $userid) {
 106                 $user = new RatingsUser($userid);
 107                 if ($user->allow_view_ratings($active_user)) {
 108                     array_push($allowed_users, $user);
 109                 }
 110                 // PHP's silly references... (the behavior with this line commented
 111                 // out is... odd)
 112                 unset($user);
 113             }
 114             $options = array('dimension' => $dimension,
 115                              'users' => $allowed_users);
 116             $args = array_merge($options, $args);
 117         }
 118         if (empty($pages) and $pages != '0')
 119             return '';
 120
 121         if (in_array('numbacklinks', $info)) {
 122             $args['types']['numbacklinks'] = new _PageList_Column_ListPages_count('numbacklinks', _("#"), true);
 123         }
 124         if (in_array('numpagelinks', $info)) {
 125             $args['types']['numpagelinks'] = new _PageList_Column_ListPages_count('numpagelinks', _("#"));
 126         }
 127
 128         $pagelist = new PageList($info, $exclude, $args);
 129         $pages_array = is_string($pages) ? explodePageList($pages) : (is_array($pages) ? $pages : array());
 130         $pagelist->addPageList($pages_array);
 131         return $pagelist;
 132     }
 133 };
 134
 135 // how many back-/forwardlinks for this page
 136 class _PageList_Column_ListPages_count extends _PageList_Column {
 137     function _PageList_Column_ListPages_count($field, $display, $backwards = false) {
 138         $this->_direction = $backwards;
 139         return $this->_PageList_Column($field, $display, 'center');
 140     }
 141     function _getValue($page, &$revision_handle) {
 142         $iter = $page->getLinks($this->_direction);
 143         $count = $iter->count();
 144         return $count;
 145     }
 146 }
 147
 148 // $Log: not supported by cvs2svn $
 149 // Revision 1.9  2004/11/23 15:17:19  rurban
 150 // better support for case_exact search (not caseexact for consistency),
 151 // plugin args simplification:
 152 //   handle and explode exclude and pages argument in WikiPlugin::getArgs
 153 //     and exclude in advance (at the sql level if possible)
 154 //   handle sortby and limit from request override in WikiPlugin::getArgs
 155 // ListSubpages: renamed pages to maxpages
 156 //
 157 // Revision 1.8  2004/10/14 19:19:34  rurban
 158 // loadsave: check if the dumped file will be accessible from outside.
 159 // and some other minor fixes. (cvsclient native not yet ready)
 160 //
 161 // Revision 1.7  2004/09/25 16:33:52  rurban
 162 // add support for all PageList options
 163 //
 164 // Revision 1.6  2004/09/14 10:33:39  rurban
 165 // simplify exclude, add numbacklinks+numpagelinks
 166 //
 167 // Revision 1.5  2004/09/06 08:37:31  rurban
 168 // plugin-list support for pages and exclude args
 169 //
 170 // Revision 1.4  2004/07/08 20:30:07  rurban
 171 // plugin->run consistency: request as reference, added basepage.
 172 // encountered strange bug in AllPages (and the test) which destroys ->_dbi
 173 //
 174 // Revision 1.3  2004/06/28 18:58:18  rurban
 175 // fixed another pass-by-reference
 176 //
 177 // Revision 1.2  2004/06/18 14:42:17  rurban
 178 // added wikilens libs (not yet merged good enough, some work for DanFr)
 179 //
 180 // Revision 1.1  2004/06/08 13:49:43  rurban
 181 // List pages that are explicitly given as the pages argument, by DanFr
 182 //
 183
 184 // Local Variables:
 185 // mode: php
 186 // tab-width: 8
 187 // c-basic-offset: 4
 188 // c-hanging-comment-ender-p: nil
 189 // indent-tabs-mode: nil
 190 // End:
 191 ?>