4 * Copyright 2004,2007,2009 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
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.
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.
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.
24 * RateIt: A recommender system, based on MovieLens and "suggest".
25 * Store user ratings per pagename. The wikilens theme displays a navbar image bar
26 * with some nice javascript magic and this plugin shows various recommendations.
28 * There should be two methods to store ratings:
29 * In a SQL database as in wikilens http://dickens.cs.umn.edu/dfrankow/wikilens
31 * The most important fact: A page has more than one rating. There can
32 * be (and will be!) many ratings per page (ratee): different raters
33 * (users), in different dimensions. Are those stored per page
34 * (ratee)? Then what if I wish to access the ratings per rater
36 * wikilens plans several user-centered applications like:
38 * b) show my buddies' ratings
39 * c) show how my ratings are like my buddies'
40 * d) show where I agree/disagree with my buddy
41 * e) show what this group of people agree/disagree on
43 * If the ratings are stored in a real DB in a table, we can index the
44 * ratings by rater and ratee, and be confident in
45 * performance. Currently MovieLens has 80,000 users, 7,000 items,
46 * 10,000,000 ratings. This is an average of 1400 ratings/page if each
47 * page were rated equally. However, they're not: the most popular
48 * things have tens of thousands of ratings (e.g., "Pulp Fiction" has
49 * 42,000 ratings). If ratings are stored per page, you would have to
50 * save/read huge page metadata every time someone submits a
51 * rating. Finally, the movie domain has an unusually small number of
52 * items-- I'd expect a lot more in music, for example.
54 * For a simple rating system one can also store the rating in the page
57 * Recommender Engines:
58 * Recommendation/Prediction is a special field of "Data Mining"
59 * For a list of (also free) software see
60 * http://www.the-data-mine.com/bin/view/Software/WebIndex
61 * - movielens: (Java Server) will be gpl'd in summer 2004 (weighted)
62 * - suggest: is free for non-commercial use, available as compiled library
64 * - Autoclass: simple public domain C library
65 * - MLC++: C++ library http://www.sgi.com/tech/mlc/
67 * Usage: <<RateIt >> just the widget without text
68 * Note: The wikilens theme or any derivate must be enabled, to enable this plugin!
69 * <<RateIt show=top >> text plus widget below
70 * <<RateIt show=ratings >> to show my ratings
71 * TODO: <<RateIt show=buddies >> to show my buddies
72 * <<RateIt show=ratings dimension=1 >>
73 * TODO: <<RateIt show=text >> just text, no widget, for dumps
75 * @author: Dan Frankowski (wikilens author), Reini Urban (as plugin)
78 * - finish mysuggest.c (external engine with data from mysql)
81 require_once 'lib/WikiPlugin.php';
82 require_once 'lib/wikilens/RatingsDb.php';
84 class WikiPlugin_RateIt
95 function getDescription()
97 return _("Rating system. Store user ratings per page.");
100 function RatingWidgetJavascript()
103 if (!empty($this->imgPrefix))
104 $imgPrefix = $this->imgPrefix;
105 elseif (defined("RATEIT_IMGPREFIX"))
106 $imgPrefix = RATEIT_IMGPREFIX; else $imgPrefix = '';
107 if ($imgPrefix and !$WikiTheme->_findData("images/RateIt" . $imgPrefix . "Nk0.png", 1))
109 $img = substr($WikiTheme->_findData("images/RateIt" . $imgPrefix . "Nk0.png"), 0, -7);
110 $urlprefix = WikiURL("", 0, 1); // TODO: check actions USE_PATH_INFO=false
111 $js_globals = "var rateit_imgsrc = '" . $img . "';
112 var rateit_action = '" . urlencode("RateIt") . "';
114 $WikiTheme->addMoreHeaders
116 array('src' => $WikiTheme->_findData('themes/wikilens/wikilens.js'))));
117 return JavaScript($js_globals);
120 function actionImgPath()
123 return $WikiTheme->_findFile("images/RateItAction.png", 1);
127 * Take a string and quote it sufficiently to be passed as a Javascript
130 private function _javascript_quote_string($s)
132 return str_replace("'", "\'", $s);
135 function getDefaultArguments()
137 return array('pagename' => '[pagename]',
140 'imgPrefix' => '', // '' or BStar or Star
141 'dimension' => false,
149 { // early side-effects (before body)
152 if (!empty($_already)) return;
154 $WikiTheme->addMoreHeaders(JavaScript(
155 "var prediction = new Array; var rating = new Array;
156 var avg = new Array; var numusers = new Array;
157 var canRate = new Array;
158 var msg_rating_votes = '" . _("Rating: %.1f (%d votes)") . "';
159 var msg_curr_rating = '" . _("Your current rating: ") . "';
160 var msg_curr_prediction = '" . _("Your current prediction: ") . "';
161 var msg_chg_rating = '" . _("Change your rating from ") . "';
162 var msg_to = '" . _(" to ") . "';
163 var msg_add_rating = '" . _("Add your rating: ") . "';
164 var msg_thanks = '" . _("Thanks!") . "';
165 var msg_rating_deleted = '" . _("Rating deleted!") . "';
167 $WikiTheme->addMoreHeaders($this->RatingWidgetJavascript());
170 function displayActionImg($mode)
172 global $WikiTheme, $request;
173 if (!empty($request->_is_buffering_output))
174 ob_end_clean(); // discard any previous output
176 $page = $request->getPage();
177 //$page->set('_cached_html', false);
178 $request->cacheControl('MUST-REVALIDATE');
179 $dbi = $request->getDbh();
181 //fake validators without args
182 $request->appendValidators(array('wikiname' => WIKI_NAME,
183 'args' => wikihash('')));
184 $request->discardOutput();
185 $actionImg = $WikiTheme->_path . $this->actionImgPath();
186 if (file_exists($actionImg)) {
187 header('Content-type: image/png');
188 readfile($actionImg);
190 header('Content-type: image/png');
191 echo base64_decode('iVBORw0KGgoAAAANSUhEUgAAAAIAAAACAQMAAABIeJ9nAAAAA1BMVEX///'
192 . '+nxBvIAAAAAXRSTlMAQObYZgAAABNJREFUeF4NwAEBAAAAgJD+r5YGAAQAAXHhfPAAAAAASUVORK5CYII=');
197 // Only for signed users done in template only yet.
198 function run($dbi, $argstr, &$request, $basepage)
201 //$this->_request = & $request;
202 //$this->_dbi = & $dbi;
203 $user = $request->getUser();
204 //FIXME: fails on test with DumpHtml:RateIt
205 if (!is_object($user)) {
206 return HTML::raw('');
208 $this->userid = $user->getId();
209 if (!$this->userid) {
210 return HTML::raw('');
212 $args = $this->getArgs($argstr, $request);
213 $this->dimension = $args['dimension'];
214 $this->imgPrefix = $args['imgPrefix'];
215 if ($this->dimension == '') {
216 $this->dimension = 0;
217 $args['dimension'] = 0;
219 if ($args['pagename']) {
220 // Expand relative page names.
221 $page = new WikiPageName($args['pagename'], $basepage);
222 $args['pagename'] = $page->name;
224 if (empty($args['pagename'])) {
225 return $this->error(_("no page specified"));
227 $this->pagename = $args['pagename'];
229 $rdbi = RatingsDb::getTheRatingsDb();
230 $this->_rdbi =& $rdbi;
232 if ($args['mode'] === 'add') {
233 //if (!$user->isSignedIn()) return $this->error(_("You must sign in"));
234 $this->rating = $request->getArg('rating');
235 $rdbi->addRating($this->rating, $this->userid, $this->pagename, $this->dimension);
236 $this->displayActionImg('add');
238 } elseif ($args['mode'] === 'delete') {
239 //if (!$user->isSignedIn()) return $this->error(_("You must sign in"));
240 $rdbi->deleteRating($this->userid, $this->pagename, $this->dimension);
241 unset($this->rating);
242 $this->displayActionImg('delete');
243 } elseif (!$args['show']) {
244 return $this->RatingWidgetHtml($args['pagename'], $args['version'], $args['imgPrefix'],
245 $args['dimension'], $args['small']);
247 //if (!$user->isSignedIn()) return $this->error(_("You must sign in"));
249 $this->rating = $rdbi->getRating($this->userid, $this->pagename, $this->dimension);
250 $this->avg = $rdbi->getAvg($this->pagename, $this->dimension);
251 $this->numusers = $rdbi->getNumUsers($this->pagename, $this->dimension);
252 // Update this text on rateit in javascript. needed: NumUsers, Avg
255 HTML::span(array('class' => 'rateit'),
256 sprintf(_("Rating: %.1f (%d votes)"),
257 $this->avg, $this->numusers)));
258 if ($args['show'] == 'top') {
259 if (ENABLE_PAGE_PUBLIC) {
260 $page = $dbi->getPage($this->pagename);
261 if ($page->get('public'))
262 $html->setAttr('class', "public");
264 $html->setAttr('id', "rateit-widget-top");
265 $html->pushContent(HTML::br(),
266 $this->RatingWidgetHtml($args['pagename'], $args['version'],
268 $args['dimension'], $args['small']));
269 } elseif ($args['show'] == 'text') {
270 if (!$WikiTheme->DUMP_MODE)
271 $html->pushContent(HTML::br(),
272 sprintf(_("Your rating was %.1f"),
274 } elseif ($this->rating) {
275 $html->pushContent(HTML::br(),
276 sprintf(_("Your rating was %.1f"),
279 $this->pred = $rdbi->getPrediction($this->userid, $this->pagename, $this->dimension);
280 if (is_string($this->pred))
281 $html->pushContent(HTML::br(),
282 sprintf(_("Prediction: %s"),
285 $html->pushContent(HTML::br(),
286 sprintf(_("Prediction: %.1f"),
294 // box is used to display a fixed-width, narrow version with common header
295 function box($args = false, $request = false, $basepage = false)
297 if (!$request) $request =& $GLOBALS['request'];
298 if (!$request->_user->isSignedIn()) {
301 if (!isset($args)) $args = array();
304 foreach ($args as $key => $value)
305 $argstr .= $key . "=" . $value;
306 $widget = $this->run($request->_dbi, $argstr, $request, $basepage);
308 return $this->makeBox(WikiLink(_("RateIt"), '', _("Rate It")),
313 * HTML widget display
315 * This needs to be put in the <body> section of the page.
317 * @param pagename Name of the page to rate
318 * @param version Version of the page to rate (may be "" for current)
319 * @param imgPrefix Prefix of the names of the images that display the rating
320 * You can have two widgets for the same page displayed at
321 * once iff the imgPrefix-s are different.
322 * @param dimension Id of the dimension to rate
323 * @param small Makes a smaller ratings widget if non-false
325 * Limitations: Currently this can only print the current users ratings.
326 * And only the widget, but no value (for buddies) also.
328 function RatingWidgetHtml($pagename, $version, $imgPrefix, $dimension, $small = false)
330 global $WikiTheme, $request;
332 $dbi =& $request->_dbi;
333 $version = $dbi->_backend->get_latest_version($pagename);
334 $pageid = sprintf("%u", crc32($pagename)); // MangleXmlIdentifier($pagename)
335 $imgId = 'RateIt' . $pageid;
336 $actionImgName = 'RateIt' . $pageid . 'Action';
338 //$rdbi =& $this->_rdbi;
339 $rdbi = RatingsDb::getTheRatingsDb();
341 // check if the imgPrefix icons exist.
342 if (!$WikiTheme->_findData("images/RateIt" . $imgPrefix . "Nk0.png", true))
345 // Protect against \'s, though not \r or \n
346 $reImgPrefix = $this->_javascript_quote_string($imgPrefix);
347 $reImgId = $this->_javascript_quote_string($imgId);
348 $reActionImgName = $this->_javascript_quote_string($actionImgName);
349 $rePagename = $this->_javascript_quote_string($pagename);
350 //$dimension = $args['pagename'] . "rat";
352 $html = HTML::span(array("class" => "rateit-widget", "id" => $imgId));
353 for ($i = 0; $i < 2; $i++) {
354 $ok[$i] = $WikiTheme->_findData("images/RateIt" . $imgPrefix . "Ok" . $i . ".png"); // empty
355 $nk[$i] = $WikiTheme->_findData("images/RateIt" . $imgPrefix . "Nk" . $i . ".png"); // rated
356 $rk[$i] = $WikiTheme->_findData("images/RateIt" . $imgPrefix . "Rk" . $i . ".png"); // pred
359 if (empty($this->userid)) {
360 $user = $request->getUser();
361 $this->userid = $user->getId();
363 if (empty($this->rating)) {
364 $this->rating = $rdbi->getRating($this->userid, $pagename, $dimension);
365 if (!$this->rating and empty($this->pred)) {
366 $this->pred = $rdbi->getPrediction($this->userid, $pagename, $dimension);
370 for ($i = 1; $i <= 10; $i++) {
372 $a1 = HTML::a(array('href' => "javascript:clickRating('$reImgPrefix','$rePagename','$version',"
373 . "'$reImgId','$dimension',$j)"));
375 $img_attr['src'] = $nk[$i % 2];
377 $img_attr['src'] = $ok[$i % 2];
378 $img_attr['onmouseover'] = "displayRating('$reImgId','$reImgPrefix',$j,0,1)";
379 $img_attr['onmouseout'] = "displayRating('$reImgId','$reImgPrefix',$this->rating,0,1)";
380 } else if (!$this->rating and $this->pred) {
381 $img_attr['src'] = $rk[$i % 2];
382 $img_attr['onmouseover'] = "displayRating('$reImgId','$reImgPrefix',$j,1,1)";
383 $img_attr['onmouseout'] = "displayRating('$reImgId','$reImgPrefix',$this->pred,1,1)";
385 $img_attr['onmouseover'] = "displayRating('$reImgId','$reImgPrefix',$j,0,1)";
386 $img_attr['onmouseout'] = "displayRating('$reImgId','$reImgPrefix',0,0,1)";
388 //$imgName = 'RateIt'.$reImgId.$i;
389 $img_attr['id'] = $imgId . $i;
390 $img_attr['alt'] = $img_attr['id'];
391 $a1->pushContent(HTML::img($img_attr));
392 //$a1->addToolTip(_("Rate the topic of this page"));
393 $html->pushContent($a1);
395 //This adds a space between the rating smilies:
396 //if (($i%2) == 0) $html->pushContent("\n");
398 $html->pushContent(HTML::raw(" "));
400 $a0 = HTML::a(array('href' => "javascript:clickRating('$reImgPrefix','$rePagename','$version',"
401 . "'$reImgId','$dimension','X')"));
402 $msg = _("Cancel your rating");
403 $imgprops = array('src' => $WikiTheme->getImageUrl("RateIt" . $imgPrefix . "Cancel"),
404 'id' => $imgId . $imgPrefix . 'Cancel',
408 $imgprops['style'] = 'display:none';
409 $a0->pushContent(HTML::img($imgprops));
410 $a0->addToolTip($msg);
411 $html->pushContent($a0);
414 $msg = _("No opinion");
415 $html->pushContent(HTML::img(array('src' => $WikiTheme->getImageUrl("RateItCancelN"),
416 'id' => $imgPrefix.'Cancel',
418 //$a0->addToolTip($msg);
419 //$html->pushContent($a0);
422 $img_attr['src'] = $WikiTheme->_findData("images/spacer.png");
423 $img_attr['id'] = $actionImgName;
424 $img_attr['alt'] = $img_attr['id'];
425 $img_attr['height'] = 15;
426 $img_attr['width'] = 20;
427 $html->pushContent(HTML::img($img_attr));
429 // Display your current rating if there is one, or the current prediction
430 // or the empty widget.
431 $pred = empty($this->pred) ? 0 : $this->pred;
433 if (!empty($this->avg))
434 $js .= "avg['$reImgId']=$this->avg; numusers['$reImgId']=$this->numusers;\n";
436 $js .= "rating['$reImgId']=$this->rating; prediction['$reImgId']=$pred;\n";
437 $html->pushContent(JavaScript($js
438 . "displayRating('$reImgId','$reImgPrefix',$this->rating,0,1);"));
439 } elseif (!empty($this->pred)) {
440 $js .= "rating['$reImgId']=0; prediction['$reImgId']=$this->pred;\n";
441 $html->pushContent(JavaScript($js
442 . "displayRating('$reImgId','$reImgPrefix',$this->pred,1,1);"));
444 $js .= "rating['$reImgId']=0; prediction['$reImgId']=0;\n";
445 $html->pushContent(JavaScript($js
446 . "displayRating('$reImgId','$reImgPrefix',0,0,1);"));
457 // c-hanging-comment-ender-p: nil
458 // indent-tabs-mode: nil