lib/wikilens/RatingsUser.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id$');
   3 /* Copyright (C) 2004 Dan Frankowski
   4  *
   5  * This file is part of PhpWiki.
   6  *
   7  * PhpWiki is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * PhpWiki is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with PhpWiki; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 require_once("lib/wikilens/RatingsDb.php");
  23
  24 /**
  25  * Get a RatingsUser instance (possibly from a cache).
  26  */
  27 class RatingsUserFactory {
  28     function & getUser($userid) {
  29         //print "getUser($userid) ";
  30         global $_ratingsUserCache;
  31         if (!isset($_ratingsUserCache)) {
  32             $_ratingsUserCache = array();
  33         }
  34         if (!array_key_exists($userid, $_ratingsUserCache)) {
  35             //print "MISS ";
  36             $_ratingsUserCache[$userid] = new RatingsUser($userid);
  37         }
  38         else {
  39             //print "HIT ";
  40         }
  41         return $_ratingsUserCache[$userid];
  42     }
  43 }
  44
  45 /**
  46  * This class represents a user that gets ratings
  47  */
  48 class RatingsUser {
  49     var $_userid;
  50     var $_ratings_loaded;
  51     var $_ratings;
  52     var $_num_ratings;
  53     var $_mean_ratings;
  54     var $_pearson_sims;
  55
  56     function RatingsUser($userid) {
  57         $this->_userid = $userid;
  58         $this->_ratings_loaded = false;
  59         $this->_ratings = array();
  60         $this->_num_ratings = 0;
  61         $this->_mean_ratings = array();
  62         $this->_pearson_sims = array();
  63     }
  64
  65     function getId() {
  66         return $this->_userid;
  67     }
  68
  69     function & _get_rating_dbi() {
  70         // This is a hack, because otherwise this object doesn't know about a
  71         // DBI at all.  Perhaps all this ratings stuff should live somewhere
  72         // else that's less of a base class.
  73         if (isset($this->_rdbi))
  74             return $this->_rdbi;
  75         $this->_rdbi = RatingsDb::getTheRatingsDb();
  76         return $this->_rdbi;
  77     }
  78
  79     // XXX: may want to think about caching ratings in the PHP session
  80     // since a WikiUser is created for *every* access, in which case rate.php
  81     // will want to change to use this object instead of direct db access
  82
  83     /**
  84      * Check whether $user is allowed to view this user's ratings
  85      *
  86      * @return bool True if $user can view this user's ratings, false otherwise
  87      */
  88     function allow_view_ratings($user)
  89     {
  90         return true;
  91     }
  92
  93     /**
  94      * Gets this user's ratings
  95      *
  96      * @return array Assoc. array [page_name][dimension] = _UserRating object
  97      */
  98     function get_ratings()
  99     {
 100         $this->_load_ratings();
 101         return $this->_ratings;
 102     }
 103
 104     /**
 105     * Gets this user's mean rating across a dimension
 106     *
 107     * @return float Mean rating
 108     */
 109     function mean_rating($dimension = 0)
 110     {
 111         // use memoized result if available
 112         if (isset($this->_mean_ratings[$dimension]))
 113         {
 114             return $this->_mean_ratings[$dimension];
 115         }
 116
 117         $ratings = $this->get_ratings();
 118         $total = 0;
 119         $n = 0;
 120
 121         // walk the ratings and aggregate those in this dimension
 122         foreach($ratings as $page => $rating)
 123         {
 124             if (isset($rating[$dimension]))
 125             {
 126                 $total += $rating[$dimension]->get_rating();
 127                 $n++;
 128             }
 129         }
 130
 131         // memoize and return result
 132         $this->_mean_ratings[$dimension] = ($n == 0 ? 0 : $total / $n);
 133         return $this->_mean_ratings[$dimension];
 134     }
 135
 136     // Note: the following has_rated, get_rating, set_rating, and unset_rating
 137     // methods are colossally inefficient as they do a full ratings load from
 138     // the database before performing their intended operation -- as such, the
 139     // rate.php script still uses the direct database methods (plus, it's very
 140     // ephemeral and doesn't particularly care about the ratings count or any
 141     // other features that these methods might provide down the road)
 142
 143     function has_rated($pagename, $dimension = null)
 144     {
 145         // XXX: does this really want to do a full ratings load?  (scalability?)
 146         $this->_load_ratings();
 147         if (isset($dimension))
 148         {
 149
 150
 151             if (isset($this->_ratings[$pagename][$dimension]))
 152             {
 153                 return true;
 154             }
 155         }
 156         else
 157         {
 158             if (isset($this->_ratings[$pagename]))
 159             {
 160                 return true;
 161             }
 162         }
 163         return false;
 164     }
 165
 166     function get_rating($pagename, $dimension = 0)
 167     {
 168         // XXX: does this really want to do a full ratings load?  (scalability?)
 169         if (RATING_STORAGE == 'SQL')
 170             $this->_load_ratings();
 171         else {
 172             $rdbi = $this->_get_rating_dbi();
 173             return $rdbi->metadata_get_rating($this->getId(), $pagename, $dimension);
 174         }
 175
 176         if ($this->has_rated($pagename, $dimension))
 177         {
 178             return $this->_ratings[$pagename][$dimension]->get_rating();
 179         }
 180         return false;
 181     }
 182
 183     function set_rating($pagename, $dimension, $rating)
 184     {
 185         // XXX: does this really want to do a full ratings load?  (scalability?)
 186         $this->_load_ratings();
 187
 188         // XXX: what to do on failure?
 189         $dbi = $this->_get_rating_dbi();
 190         if (!($dbi->rate($this->_userid, $pagename, $dimension, $rating)))
 191         {
 192             return;
 193         }
 194
 195         if ($this->has_rated($pagename, $dimension))
 196         {
 197             $this->_ratings[$pagename][$dimension]->set_rating($rating);
 198         }
 199         else
 200         {
 201             $this->_num_ratings++;
 202             $this->_ratings[$rating['pagename']][$rating['dimension']]
 203               = new _UserRating($this->_userid, $pagename, $dimension, $rating);
 204         }
 205     }
 206
 207     function unset_rating($pagename, $dimension)
 208     {
 209         // XXX: does this really want to do a full ratings load?  (scalability?)
 210         $this->_load_ratings();
 211         if ($this->has_rated($pagename, $dimension))
 212         {
 213             // XXX: what to do on failure?
 214             if ($this->_dbi->delete_rating($this->_userid,$pagename,$dimension))
 215             {
 216                 $this->_num_ratings--;
 217                 unset($this->_ratings[$pagename][$dimension]);
 218                 if (!count($this->_ratings[$pagename]))
 219                 {
 220                     unset($this->_ratings[$pagename]);
 221                 }
 222             }
 223         }
 224     }
 225
 226     function pearson_similarity($user, $dimension = 0)
 227     {
 228         // use memoized result if available
 229         if (isset($this->_pearson_sims[$user->getId()][$dimension]))
 230         {
 231             return $this->_pearson_sims[$user->getId()][$dimension];
 232         }
 233
 234         $ratings1 = $this->get_ratings();
 235         $mean1    = $this->mean_rating($dimension);
 236         // XXX: sanify user input?
 237         $ratings2 = $user->get_ratings();
 238         $mean2    = $user->mean_rating($dimension);
 239
 240         // swap if it would speed things up a bit
 241         if (count($ratings1) < count($ratings2))
 242         {
 243             $tmp = $ratings1;
 244             $ratings1 = $ratings2;
 245             $ratings2 = $tmp;
 246             $tmp = $mean1;
 247             $mean1 = $mean2;
 248             $mean2 = $tmp;
 249         }
 250
 251         list($sum11, $sum22, $sum12, $n) = array(0,0,0,0);
 252
 253         // compute sum(x*x), sum(y*y), sum(x*y) over co-rated items
 254         foreach ($ratings1 as $page => $rating1)
 255         {
 256             if (isset($rating1[$dimension]) && isset($ratings2[$page]))
 257             {
 258                 $rating2 = $ratings2[$page];
 259                 if (isset($rating2[$dimension]))
 260                 {
 261                     $r1 = $rating1[$dimension]->get_rating();
 262                     $r2 = $rating2[$dimension]->get_rating();
 263                     // print "co-rating with " . $user->getId() . " $page $r1 $r2<BR>";
 264
 265                     $r1 -= $mean1;
 266                     $r2 -= $mean2;
 267
 268                     $sum11 += $r1 * $r1;
 269                     $sum22 += $r2 * $r2;
 270                     $sum12 += $r1 * $r2;
 271                     $n++;
 272                 }
 273             }
 274         }
 275
 276         // this returns both the computed similarity and the number of co-rated
 277         // items that the similarity was based on
 278
 279         // prevent division-by-zero
 280         if (sqrt($sum11) == 0 || sqrt($sum12) == 0)
 281             $sim = array(0, $n);
 282         else
 283         // Pearson similarity
 284             $sim = array($sum12 / (sqrt($sum11) * sqrt($sum22)), $n);
 285
 286         // print "sim is " . $sim[0] . "<BR><BR>";
 287
 288         // memoize result
 289         $this->_pearson_sims[$user->getId()][$dimension] = $sim;
 290         return $this->_pearson_sims[$user->getId()][$dimension] = $sim;
 291     }
 292
 293     function knn_uu_predict($pagename, &$neighbors, $dimension = 0)
 294     {
 295         /*
 296         print "<PRE>";
 297         var_dump($this->_pearson_sims);
 298         var_dump($this->_ratings);
 299         print "</PRE>";
 300         print "pred for $pagename<BR>";
 301         */
 302         $total = 0;
 303         $total_sim = 0;
 304
 305         // foreach($neighbors as $nbor)
 306         // {
 307         for($i = 0; $i < count($neighbors); $i++)
 308         {
 309             // more silly PHP references...
 310             $nbor =& $neighbors[$i];
 311
 312             // ignore self-neighbor
 313             if ($this->getId() == $nbor->getId())
 314                 continue;
 315
 316             if ($nbor->has_rated($pagename, $dimension))
 317             {
 318                 list($sim, $n_items) = $this->pearson_similarity($nbor);
 319                 // ignore absolute sims below 0.1, negative sims??
 320                 // XXX: no filtering done... small-world = too few neighbors
 321                 if (1 || ($sim > 0 && abs($sim) >= 0.1))
 322                 {
 323                     // n/50 sig weighting
 324                     if ($n_items < 50)
 325                         $sim *= $n_items / 50;
 326                     /*
 327                     print "neighbor is " . $nbor->getId() . "<BR>";
 328                     print "weighted sim is " . $sim . "<BR>";
 329                     print "dev from mean is " . ($nbor->get_rating($pagename, $dimension) - $nbor->mean_rating($dimension)) . "<BR>";
 330                     */
 331                     $total += $sim * ($nbor->get_rating($pagename, $dimension) - $nbor->mean_rating($dimension));
 332                     $total_sim += abs($sim);
 333                 }
 334             }
 335         }
 336
 337         $my_mean = $this->mean_rating($dimension);
 338         /*
 339         print "your mean is $my_mean<BR>";
 340         print "pred dev from mean is " . ($total_sim == 0 ? -1 : ($total / $total_sim)) . "<BR>";
 341         print "pred is " . ($total_sim == 0 ? -1 : ($total / $total_sim + $my_mean)) . "<BR><BR>";
 342         */
 343         // XXX: what to do if no neighbors have rated pagename?
 344         return ($total_sim == 0 ? 0 : ($total / $total_sim + $my_mean));
 345     }
 346
 347     function _load_ratings($force = false)
 348     {
 349         if (!$this->_ratings_loaded || $force)
 350         {
 351             // print "load " . $this->getId() . "<BR>";
 352             $this->_ratings = array();
 353             $this->_num_ratings = 0;
 354             // only signed-in users have ratings (XXX: authenticated?)
 355
 356             // passing null as first parameter to indicate all dimensions
 357             $dbi = $this->_get_rating_dbi();
 358
 359             //$rating_iter = $dbi->sql_get_rating(null, $this->_userid, null);
 360             //($dimension=null, $rater=null, $ratee=null, $orderby = null, $pageinfo = "ratee")
 361             $rating_iter = $dbi->get_rating_page(null, $this->_userid);
 362
 363             while($rating = $rating_iter->next())
 364             {
 365                 $this->_num_ratings++;
 366                 $this->_ratings[$rating['pagename']][$rating['dimension']]
 367                   = new _UserRating($this->_userid,
 368                                     $rating['pagename'],
 369                                     $rating['dimension'],
 370                                     $rating['ratingvalue']);
 371             }
 372
 373             $this->_ratings_loaded = true;
 374         }
 375     }
 376 }
 377
 378 /** Represent a rating. */
 379 class _UserRating
 380 {
 381     function _UserRating ($rater, $ratee, $dimension, $rating)
 382     {
 383         $this->rater     = (string)$rater;
 384         $this->ratee     = (string)$ratee;
 385         $this->dimension = (int)$dimension;
 386         $this->rating    = (float)$rating;
 387     }
 388
 389     function get_rater()
 390     {
 391         return $this->rater;
 392     }
 393
 394     function get_ratee()
 395     {
 396         return $this->ratee;
 397     }
 398
 399     function get_rating()
 400     {
 401         return $this->rating;
 402     }
 403
 404     function get_dimension()
 405     {
 406         return $this->dimension;
 407     }
 408
 409     function set_rater()
 410     {
 411         $this->rater = (string)$rater;
 412     }
 413
 414     function set_ratee()
 415     {
 416         $this->ratee = (string)$ratee;
 417     }
 418
 419     function set_rating()
 420     {
 421         $this->rating = (float)$rating;
 422     }
 423
 424     function set_dimension()
 425     {
 426         $this->dimension = (int)$dimension;
 427     }
 428 }
 429
 430 // Local Variables:
 431 // mode: php
 432 // tab-width: 8
 433 // c-basic-offset: 4
 434 // c-hanging-comment-ender-p: nil
 435 // indent-tabs-mode: nil
 436 // End:
 437 ?>