lib/plugin/UserRatings.php

   1 <?php
   2
   3 /**
   4  * Copyright 2004 Dan Frankowski
   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 along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 require_once 'lib/PageList.php';
  24 require_once 'lib/wikilens/Buddy.php';
  25 require_once 'lib/wikilens/PageListColumns.php';
  26
  27 if (ENABLE_USER_NEW)
  28     require_once 'lib/WikiUserNew.php';
  29 else
  30     require_once 'lib/WikiUser.php';
  31
  32 /**
  33  * Show a user's ratings in a table, using PageList.
  34  * Usage:
  35  * <<UserRatings >>
  36  *
  37  * This only works with the "wikilens" theme.
  38  */
  39
  40 class WikiPlugin_UserRatings
  41     extends WikiPlugin
  42 {
  43     function getDescription()
  44     {
  45         return _("List the user's ratings.");
  46     }
  47
  48     function getDefaultArguments()
  49     {
  50         return array('dimension' => '0',
  51             // array of userids to display ratings for; null/empty for
  52             // active user only
  53             'userids' => null,
  54             // array of pageids to display ratings for; null for all
  55             // of current active user's ratings
  56             'pageids' => null,
  57             // a category to display ratings for; null for no category;
  58             // has higher precedence than pageids
  59             'category' => null,
  60             'pagename' => '[pagename]', // hackish
  61             'exclude' => '',
  62             'limit' => 0, // limit of <=0 is show-all
  63             'noheader' => 0,
  64             'userPage' => false,
  65             'nobuds' => false,
  66             // rating columns are added later
  67             'info' => 'pagename');
  68         // getting a bit crowded with the buddies...
  69         // 'info'     => 'hits,pagename,author,ratingwidget');
  70     }
  71
  72     // info arg allows multiple columns
  73     // info=mtime,hits,summary,version,author,locked,minor
  74     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  75
  76     function run($dbi, $argstr, &$request, $basepage)
  77     {
  78         extract($this->getArgs($argstr, $request));
  79
  80         // XXX: fix to reflect multi-user ratings?
  81         $caption = _("Displaying %d ratings:");
  82
  83         $active_user = $request->getUser();
  84         $active_userid = $active_user->_userid;
  85
  86         // check for request to display a category's ratings
  87         if (isset($category) && is_string($category) && strlen($category)) {
  88             $pageids = array();
  89             $category_page = $dbi->getPage($category);
  90             $iter = $category_page->getLinks();
  91             while ($item = $iter->next()) {
  92                 array_push($pageids, $item->getName());
  93             }
  94             // XXX: is there a way to retrieve the preferred plural
  95             // representation of a category name?
  96             // XXX: should the category text be a link?  can it be one easily?
  97
  98             $caption = sprintf(_("Showing all %ss (%%d):"), $category);
  99         } // if null is passed as the pageids argument and no category was passed,
 100         // show active user's ratings
 101         elseif (!isset($pageids) || !is_array($pageids)) {
 102             // XXX: need support for sorted ratings
 103             // bug: pages excluded from the PageList via the "exclude" argument
 104             // count toward the limit!
 105             $pageids = array();
 106
 107             $active_user_ratings_user = & RatingsUserFactory::getUser($active_user->getId());
 108             $current_user_ratings = $active_user_ratings_user->get_ratings();
 109
 110             if ($userPage) {
 111                 //we're on a user's homepage, get *their* ratings
 112                 $this_page_user = & RatingsUserFactory::getUser($userPage);
 113                 $caption = _("Here are $userPage" . "'s %d page ratings:");
 114                 $ratings = $this_page_user->get_ratings();
 115             } else {
 116                 $caption = _("Here are your %d page ratings:");
 117                 $ratings = $current_user_ratings;
 118             }
 119
 120             $i = 0;
 121             foreach ($ratings as $pagename => $page_ratings) {
 122                 // limit is currently only honored for "own" ratings
 123                 if ($limit > 0 && $i >= $limit) {
 124                     break;
 125                 }
 126                 if (isset($page_ratings[$dimension])) {
 127                     array_push($pageids, $pagename);
 128                     $i++;
 129                 }
 130             }
 131             // $caption = _("Here are your %d page ratings:");
 132             //make $ratings the user's ratings again if it had been treated as the current page
 133             // name's ratings
 134             $ratings = $current_user_ratings;
 135         }
 136
 137         // if userids is null or empty, fill it with just the active user
 138         if (!isset($userids) || !is_array($userids) || !count($userids)) {
 139             // TKL: moved getBuddies call inside if statement because it was
 140             // causing the userids[] parameter to be ignored
 141             if (is_string($active_userid) && strlen($active_userid) && $active_user->isSignedIn() && !$userPage) {
 142                 if (isset($category_page)) {
 143                     $userids = getBuddies($active_userid, $dbi, $category_page->getName());
 144                 } else {
 145                     $userids = getBuddies($active_userid, $dbi);
 146                 }
 147             } elseif ($userPage) {
 148                 //we're on a user page, show that user's ratings as the only column
 149                 $userids = array();
 150                 array_push($userids, $userPage);
 151             } else {
 152                 $userids = array();
 153                 // XXX: this wipes out the category caption...
 154                 // $caption = _("You must be logged in to view ratings.");
 155             }
 156         }
 157
 158         // find out which users we should show ratings for
 159
 160         // users allowed in the prediction calculation
 161         $allowed_users = array();
 162         // users actually allowed to be shown to the user
 163         $allowed_users_toshow = array();
 164         foreach ($userids as $userid) {
 165             $user = & RatingsUserFactory::getUser($userid);
 166             if ($user->allow_view_ratings($active_user)) {
 167                 array_push($allowed_users_toshow, $user);
 168             }
 169             // all users should be allowed in calculation
 170             array_push($allowed_users, $user);
 171             // This line ensures $user is not a reference type after this loop
 172             // If it is a reference type, that can produce very unexpected behavior!
 173             unset($user);
 174         }
 175         // if no buddies, use allusers in prediction calculation
 176
 177         if (count($userids) == 0 || $userPage) {
 178             $allowed_users = array();
 179             //$people_iter = $dbi->get_users_rated();
 180             $people_dbi = RatingsDb::getTheRatingsDb();
 181             $people_iter = $people_dbi->sql_get_users_rated();
 182             while ($people_array = $people_iter->next()) {
 183                 if (isset($people_array['pagename'])) {
 184                     $userid = $people_array['pagename'];
 185                     $user = & RatingsUserFactory::getUser($userid);
 186                     array_push($allowed_users, $user);
 187                 }
 188             }
 189
 190         }
 191
 192         $columns = $info ? explode(",", $info) : array();
 193         // build our table...
 194         $pagelist = new PageList($columns, $exclude, array('dimension' => $dimension, 'users' => $allowed_users_toshow));
 195
 196         // augment columns
 197         //$preds = new _PageList_Column_prediction('prediction', _("Pred"), 'right', $dimension, $allowed_users);
 198         $preds = array('_PageList_column_prediction', 'custom:prediction', _("Pred"), 'right', ' ', $allowed_users);
 199         $pagelist->addColumnObject($preds);
 200
 201         //$widget = new _PageList_Column_ratingwidget('ratingwidget', _("Rate"), 'left', $dimension);
 202         $widget = array('_PageList_column_ratingwidget', 'custom:ratingwidget', _("Rate"), 'center');
 203         $pagelist->addColumnObject($widget);
 204
 205         $noRatingUsers = array();
 206         if (!$nobuds) {
 207             foreach ($allowed_users_toshow as $idx => $user) {
 208                 // For proper caching behavior, get a ref, don't user $user
 209                 $u = & $allowed_users_toshow[$idx];
 210                 //$col = & new _PageList_Column_ratingvalue('ratingvalue', $u->getId(), 'right', $dimension, $u);
 211                 $col = array('_PageList_Column_ratingvalue', 'custom:ratingvalue', $u->getId(), 'right', ' ', $u);
 212                 $pagelist->addColumnObject($col);
 213                 unset($u);
 214             }
 215         }
 216
 217         // add rows -- each row represents an item (page)
 218         foreach ($pageids as $pagename) {
 219             // addPage can deal with cases where it is passed a string
 220             $pagelist->addPage($pagename);
 221         }
 222
 223         if (!$noheader) {
 224             $pagelist->setCaption(_($caption));
 225         }
 226
 227         return $pagelist;
 228     }
 229 }
 230
 231 // Local Variables:
 232 // mode: php
 233 // tab-width: 8
 234 // c-basic-offset: 4
 235 // c-hanging-comment-ender-p: nil
 236 // indent-tabs-mode: nil
 237 // End: