r103587 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r103586‎ | r103587 | r103588 >
Date:14:14, 18 November 2011
Author:jeroendedauw
Status:reverted
Tags:
Comment:
importing Reviews extension
Modified paths:
  • /trunk/extensions/Reviews (added) (history)
  • /trunk/extensions/Reviews/COPYING (added) (history)
  • /trunk/extensions/Reviews/INSTALL (added) (history)
  • /trunk/extensions/Reviews/README (added) (history)
  • /trunk/extensions/Reviews/RELEASE-NOTES (added) (history)
  • /trunk/extensions/Reviews/Reviews.alias.php (added) (history)
  • /trunk/extensions/Reviews/Reviews.hooks.php (added) (history)
  • /trunk/extensions/Reviews/Reviews.i18n.php (added) (history)
  • /trunk/extensions/Reviews/Reviews.php (added) (history)
  • /trunk/extensions/Reviews/Reviews.settings.php (added) (history)
  • /trunk/extensions/Reviews/api (added) (history)
  • /trunk/extensions/Reviews/includes (added) (history)
  • /trunk/extensions/Reviews/includes/ReviewsDBObject.php (added) (history)
  • /trunk/extensions/Reviews/resources (added) (history)
  • /trunk/extensions/Reviews/sql (added) (history)
  • /trunk/extensions/Reviews/sql/Reviews.sql (added) (history)

Diff [purge]

Index: trunk/extensions/Reviews/sql/Reviews.sql
Index: trunk/extensions/Reviews/Reviews.alias.php
@@ -0,0 +1,21 @@
 2+<?php
 3+
 4+/**
 5+ * Aliases for the special pages of the Reviews extension.
 6+ *
 7+ * @since 0.1
 8+ *
 9+ * @file Reviews.alias.php
 10+ * @ingroup Reviews
 11+ *
 12+ * @licence GNU GPL v3+
 13+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 14+ */
 15+
 16+$specialPageAliases = array();
 17+
 18+/** English (English) */
 19+$specialPageAliases['en'] = array(
 20+ 'Reviews' => array( 'Reviews' ),
 21+ 'MyReviews' => array( 'MyReviews', 'My Reviews' ),
 22+);
Index: trunk/extensions/Reviews/INSTALL
@@ -0,0 +1,42 @@
 2+These is the install file for the Reviews extension.
 3+
 4+Extension page on mediawiki.org: https://www.mediawiki.org/wiki/Extension:Reviews
 5+Latest version of the install file: http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/Reviews/INSTALL?view=co
 6+
 7+
 8+== Requirements ==
 9+
 10+Reviews requires:
 11+
 12+* MediaWiki 1.18 or above
 13+* PHP 5.3 or above
 14+* MySQL
 15+
 16+== Download ==
 17+
 18+You can get the code directly from SVN. Tags can be obtained via
 19+
 20+ svn checkout <nowiki>http://svn.wikimedia.org/svnroot/mediawiki/tags/extensions/Reviews/REL_version</nowiki>
 21+
 22+Where 'version' is the version number of the tag, such as 0_1 (see the [http://svn.wikimedia.org/svnroot/mediawiki/tags/extensions/Reviews/ available tags]).
 23+The latest code can be obtained from trunk:
 24+
 25+ svn checkout <nowiki>http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Reviews/</nowiki>
 26+
 27+== Installation ==
 28+
 29+Once you have downloaded the code, place the ''Reviews'' directory within your MediaWiki
 30+'extensions' directory. Then add the following code to your [[Manual:LocalSettings.php|LocalSettings.php]] file:
 31+
 32+# Reviews
 33+require_once( "$IP/extensions/Reviews/Reviews.php" );
 34+
 35+== Configuration ==
 36+
 37+Configuration of Reviews is done by assigning to $egReviewsSettings in your
 38+[[Manual:LocalSettings.php|LocalSettings.php]] file, AFTER the inclusion of the
 39+extension. The options are listed below and their default is set in the Reviews settings file:
 40+http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/Reviews/Reviews.settings.php?view=markup
 41+You should NOT modify the settings file, but can have a look at it to get an idea of
 42+how to use the settings, in case the below descriptions do not suffice.
 43+
Index: trunk/extensions/Reviews/RELEASE-NOTES
@@ -0,0 +1,13 @@
 2+These are the release notes for the Reviews extension.
 3+
 4+Extension page on mediawiki.org: https://www.mediawiki.org/wiki/Extension:Reviews
 5+Latest version of the release notes: http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/Reviews/RELEASE-NOTES?view=co
 6+
 7+
 8+
 9+=== Version 0.1 ===
 10+(trunk)
 11+
 12+Initial release with these features:
 13+
 14+*
\ No newline at end of file
Index: trunk/extensions/Reviews/includes/ReviewsDBObject.php
@@ -0,0 +1,846 @@
 2+<?php
 3+
 4+/**
 5+ * Abstract base class for representing objects that are stored in some DB table.
 6+ *
 7+ * @since 0.1
 8+ *
 9+ * @file ReviewDBObject.php
 10+ * @ingroup Review
 11+ *
 12+ * @licence GNU GPL v3 or later
 13+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 14+ */
 15+abstract class ReviewDBObject {
 16+
 17+ /**
 18+ * The fields of the object.
 19+ * field name (w/o prefix) => value
 20+ *
 21+ * @since 0.1
 22+ * @var array
 23+ */
 24+ protected $fields = array( 'id' => null );
 25+
 26+ /**
 27+ * The database connection to use for read operations.
 28+ *
 29+ * @since 0.2
 30+ * @var integer DB_ enum
 31+ */
 32+ protected static $readDb = DB_SLAVE;
 33+
 34+ /**
 35+ * Constructor.
 36+ *
 37+ * @since 0.1
 38+ *
 39+ * @param array|null $fields
 40+ * @param boolean $loadDefaults
 41+ */
 42+ public function __construct( $fields, $loadDefaults = false ) {
 43+ if ( !is_array( $fields ) ) {
 44+ $fields = array();
 45+ }
 46+
 47+ if ( $loadDefaults ) {
 48+ $fields = array_merge( $this->getDefaults(), $fields );
 49+ }
 50+
 51+ $this->setFields( $fields );
 52+ }
 53+
 54+ /**
 55+ * Load the specified fields from the database.
 56+ *
 57+ * @since 0.1
 58+ *
 59+ * @param array|null $fields
 60+ * @param boolean $override
 61+ *
 62+ * @return Success indicator
 63+ */
 64+ public function loadFields( $fields = null, $override = true ) {
 65+ if ( is_null( $this->getId() ) ) {
 66+ return false;
 67+ }
 68+
 69+ if ( is_null( $fields ) ) {
 70+ $fields = array_keys( $this->getFieldTypes() );
 71+ }
 72+
 73+ $results = $this->rawSelect(
 74+ $this->getPrefixedFields( $fields ),
 75+ array( $this->getPrefixedField( 'id' ) => $this->getId() ),
 76+ array( 'LIMIT' => 1 )
 77+ );
 78+
 79+ foreach ( $results as $result ) {
 80+ $this->setFields( $this->getFieldsFromDBResult( $result ), $override );
 81+ return true;
 82+ }
 83+
 84+ return false;
 85+ }
 86+
 87+ /**
 88+ * Returns the name of the database table objects of this type are stored in.
 89+ *
 90+ * @since 0.1
 91+ *
 92+ * @return string
 93+ */
 94+ public abstract function getDBTable();
 95+
 96+ /**
 97+ * Gets the db field prefix.
 98+ *
 99+ * @since 0.1
 100+ *
 101+ * @return string
 102+ */
 103+ protected abstract function getFieldPrefix();
 104+
 105+ /**
 106+ * Gets the value of a field.
 107+ *
 108+ * @since 0.1
 109+ *
 110+ * @param string $name
 111+ *
 112+ * @throws MWException
 113+ * @return mixed
 114+ */
 115+ public function getField( $name ) {
 116+ if ( $this->hasField( $name ) ) {
 117+ return $this->fields[$name];
 118+ } else {
 119+ throw new MWException( 'Attempted to get not-set field ' . $name );
 120+ }
 121+ }
 122+
 123+ /**
 124+ * Remove a field.
 125+ *
 126+ * @since 0.1
 127+ *
 128+ * @param string $name
 129+ */
 130+ public function removeField( $name ) {
 131+ unset( $this->fields[$name] );
 132+ }
 133+
 134+ /**
 135+ * Returns the objects database id.
 136+ *
 137+ * @since 0.1
 138+ *
 139+ * @return integer|null
 140+ */
 141+ public function getId() {
 142+ return $this->getField( 'id' );
 143+ }
 144+
 145+ /**
 146+ * Sets the objects database id.
 147+ *
 148+ * @since 0.1
 149+ *
 150+ * @param integere|null $id
 151+ */
 152+ public function setId( $id ) {
 153+ return $this->setField( 'id', $id );
 154+ }
 155+
 156+ /**
 157+ * Gets if a certain field is set.
 158+ *
 159+ * @since 0.1
 160+ *
 161+ * @param string $name
 162+ *
 163+ * @return boolean
 164+ */
 165+ public function hasField( $name ) {
 166+ return array_key_exists( $name, $this->fields );
 167+ }
 168+
 169+ /**
 170+ * Gets if the id field is set.
 171+ *
 172+ * @since 0.1
 173+ *
 174+ * @return boolean
 175+ */
 176+ public function hasIdField() {
 177+ return $this->hasField( 'id' )
 178+ && !is_null( $this->getField( 'id' ) );
 179+ }
 180+
 181+ /**
 182+ * Sets multiple fields.
 183+ *
 184+ * @since 0.1
 185+ *
 186+ * @param array $fields The fields to set
 187+ * @param boolean $override Override already set fields with the provided values?
 188+ */
 189+ public function setFields( array $fields, $override = true ) {
 190+ foreach ( $fields as $name => $value ) {
 191+ if ( $override || !$this->hasField( $name ) ) {
 192+ $this->setField( $name, $value );
 193+ }
 194+ }
 195+ }
 196+
 197+ /**
 198+ * Gets the fields => values to write to the table.
 199+ *
 200+ * @since 0.1
 201+ *
 202+ * @return array
 203+ */
 204+ protected function getWriteValues() {
 205+ $values = array();
 206+
 207+ foreach ( $this->getFieldTypes() as $name => $type ) {
 208+ if ( array_key_exists( $name, $this->fields ) ) {
 209+ $value = $this->fields[$name];
 210+
 211+ switch ( $type ) {
 212+ case 'array':
 213+ $value = serialize( (array)$value );
 214+ }
 215+
 216+ $values[$this->getFieldPrefix() . $name] = $value;
 217+ }
 218+ }
 219+
 220+ return $values;
 221+ }
 222+
 223+ /**
 224+ * Serializes the object to an associative array which
 225+ * can then easily be converted into JSON or similar.
 226+ *
 227+ * @since 0.1
 228+ *
 229+ * @param null|array $fields
 230+ * @param boolean $incNullId
 231+ *
 232+ * @return array
 233+ */
 234+ public function toArray( $fields = null, $incNullId = false ) {
 235+ $data = array();
 236+ $setFields = array();
 237+
 238+ if ( !is_array( $fields ) ) {
 239+ $setFields = $this->getSetFieldNames();
 240+ } else {
 241+ foreach ( $fields as $field ) {
 242+ if ( $this->hasField( $field ) ) {
 243+ $setFields[] = $field;
 244+ }
 245+ }
 246+ }
 247+
 248+ foreach ( $setFields as $field ) {
 249+ if ( $incNullId || $field != 'id' || $this->hasIdField() ) {
 250+ $data[$field] = $this->getField( $field );
 251+ }
 252+ }
 253+
 254+ return $data;
 255+ }
 256+
 257+ /**
 258+ * Load the default values, via getDefaults.
 259+ *
 260+ * @since 0.1
 261+ *
 262+ * @param boolean $override
 263+ */
 264+ public function loadDefaults( $override = true ) {
 265+ $this->setFields( $this->getDefaults(), $override );
 266+ }
 267+
 268+ /**
 269+ * Writes the answer to the database, either updating it
 270+ * when it already exists, or inserting it when it doesn't.
 271+ *
 272+ * @since 0.1
 273+ *
 274+ * @return boolean Success indicator
 275+ */
 276+ public function writeToDB() {
 277+ if ( $this->hasIdField() ) {
 278+ return $this->updateInDB();
 279+ } else {
 280+ return $this->insertIntoDB();
 281+ }
 282+ }
 283+
 284+ /**
 285+ * Updates the object in the database.
 286+ *
 287+ * @since 0.1
 288+ *
 289+ * @return boolean Success indicator
 290+ */
 291+ protected function updateInDB() {
 292+ $dbw = wfGetDB( DB_MASTER );
 293+
 294+ return $dbw->update(
 295+ $this->getDBTable(),
 296+ $this->getWriteValues(),
 297+ array( $this->getFieldPrefix() . 'id' => $this->getId() ),
 298+ __METHOD__
 299+ );
 300+ }
 301+
 302+ /**
 303+ * Inserts the object into the database.
 304+ *
 305+ * @since 0.1
 306+ *
 307+ * @return boolean Success indicator
 308+ */
 309+ protected function insertIntoDB() {
 310+ $dbw = wfGetDB( DB_MASTER );
 311+
 312+ $result = $dbw->insert(
 313+ $this->getDBTable(),
 314+ $this->getWriteValues(),
 315+ __METHOD__,
 316+ array( 'IGNORE' )
 317+ );
 318+
 319+ $this->setField( 'id', $dbw->insertId() );
 320+
 321+ return $result;
 322+ }
 323+
 324+ /**
 325+ * Removes the object from the database.
 326+ *
 327+ * @since 0.1
 328+ *
 329+ * @return boolean Success indicator
 330+ */
 331+ public function removeFromDB() {
 332+ $success = $this->delete( array( 'id' => $this->getId() ) );
 333+
 334+ if ( $success ) {
 335+ $this->setField( 'id', null );
 336+ }
 337+
 338+ return $success;
 339+ }
 340+
 341+ /**
 342+ * Return the names and values of the fields.
 343+ *
 344+ * @since 0.1
 345+ *
 346+ * @return array
 347+ */
 348+ public function getFields() {
 349+ return $this->fields;
 350+ }
 351+
 352+ /**
 353+ * Return the names of the fields.
 354+ *
 355+ * @since 0.1
 356+ *
 357+ * @return array
 358+ */
 359+ public function getSetFieldNames() {
 360+ return array_keys( $this->fields );
 361+ }
 362+
 363+ /**
 364+ * Sets the value of a field.
 365+ * Strings can be provided for other types,
 366+ * so this method can be called from unserialization handlers.
 367+ *
 368+ * @since 0.1
 369+ *
 370+ * @param string $name
 371+ * @param mixed $value
 372+ *
 373+ * @throws MWException
 374+ */
 375+ public function setField( $name, $value ) {
 376+ $fields = $this->getFieldTypes();
 377+
 378+ if ( array_key_exists( $name, $fields ) ) {
 379+ switch ( $fields[$name] ) {
 380+ case 'int':
 381+ $value = (int)$value;
 382+ break;
 383+ case 'float':
 384+ $value = (float)$value;
 385+ break;
 386+ case 'bool':
 387+ if ( is_string( $value ) ) {
 388+ $value = $value !== '0';
 389+ } elseif ( is_int( $value ) ) {
 390+ $value = $value !== 0;
 391+ }
 392+ break;
 393+ case 'array':
 394+ if ( is_string( $value ) ) {
 395+ $value = unserialize( $value );
 396+ }
 397+ break;
 398+ case 'id':
 399+ if ( is_string( $value ) ) {
 400+ $value = (int)$value;
 401+ }
 402+ break;
 403+ }
 404+
 405+ $this->fields[$name] = $value;
 406+ } else {
 407+ throw new MWException( 'Attempted to set unknown field ' . $name );
 408+ }
 409+ }
 410+
 411+ /**
 412+ * Returns an array with the fields and their types this object contains.
 413+ * This corresponds directly to the fields in the database, without prefix.
 414+ *
 415+ * field name => type
 416+ *
 417+ * Allowed types:
 418+ * * id
 419+ * * str
 420+ * * int
 421+ * * float
 422+ * * bool
 423+ * * array
 424+ *
 425+ * @since 0.1
 426+ *
 427+ * @return array
 428+ */
 429+ protected abstract function getFieldTypes();
 430+
 431+ /**
 432+ * Returns a list of default field values.
 433+ * field name => field value
 434+ *
 435+ * @since 0.1
 436+ *
 437+ * @return array
 438+ */
 439+ public abstract function getDefaults();
 440+
 441+ /**
 442+ * Get a new instance of the class from an array.
 443+ *
 444+ * @since 0.1
 445+ *
 446+ * @param array $data
 447+ * @param boolean $loadDefaults
 448+ *
 449+ * @return ReviewDBObject
 450+ */
 451+ public static function newFromArray( array $data, $loadDefaults = false ) {
 452+ return new static( $data, $loadDefaults );
 453+ }
 454+
 455+ //
 456+ //
 457+ // All below methods ought to be static, but can't be since this would require LSB introduced in PHP 5.3.
 458+ //
 459+ //
 460+
 461+ /**
 462+ * Get the database type used for read operations.
 463+ *
 464+ * @since 0.2
 465+ * @return integer DB_ enum
 466+ */
 467+ public function getReadDb() {
 468+ return self::$readDb;
 469+ }
 470+
 471+ /**
 472+ * Set the database type to use for read operations.
 473+ *
 474+ * @param integer $db
 475+ *
 476+ * @since 0.2
 477+ */
 478+ public function setReadDb( $db ) {
 479+ self::$readDb = $db;
 480+ }
 481+
 482+ /**
 483+ * Gets if the object can take a certain field.
 484+ *
 485+ * @since 0.1
 486+ *
 487+ * @param string $name
 488+ *
 489+ * @return boolean
 490+ */
 491+ public function canHasField( $name ) {
 492+ return array_key_exists( $name, $this->getFieldTypes() );
 493+ }
 494+
 495+ /**
 496+ * Takes in a field or array of fields and returns an
 497+ * array with their prefixed versions, ready for db usage.
 498+ *
 499+ * @since 0.1
 500+ *
 501+ * @param array|string $fields
 502+ *
 503+ * @return array
 504+ */
 505+ public function getPrefixedFields( $fields ) {
 506+ $fields = (array)$fields;
 507+
 508+ foreach ( $fields as &$field ) {
 509+ $field = $this->getFieldPrefix() . $field;
 510+ }
 511+
 512+ return $fields;
 513+ }
 514+
 515+ /**
 516+ * Takes in a field and returns an it's prefixed version, ready for db usage.
 517+ *
 518+ * @since 0.1
 519+ *
 520+ * @param string $field
 521+ *
 522+ * @return string
 523+ */
 524+ public function getPrefixedField( $field ) {
 525+ return $this->getFieldPrefix() . $field;
 526+ }
 527+
 528+ /**
 529+ * Takes in an associative array with field names as keys and
 530+ * their values as value. The field names are prefixed with the
 531+ * db field prefix.
 532+ *
 533+ * @since 0.1
 534+ *
 535+ * @param array $values
 536+ *
 537+ * @return array
 538+ */
 539+ public function getPrefixedValues( array $values ) {
 540+ $prefixedValues = array();
 541+
 542+ foreach ( $values as $field => $value ) {
 543+ $prefixedValues[$this->getFieldPrefix() . $field] = $value;
 544+ }
 545+
 546+ return $prefixedValues;
 547+ }
 548+
 549+ /**
 550+ * Get an array with fields from a database result,
 551+ * that can be fed directly to the constructor or
 552+ * to setFields.
 553+ *
 554+ * @since 0.1
 555+ *
 556+ * @param object $result
 557+ *
 558+ * @return array
 559+ */
 560+ protected function getFieldsFromDBResult( $result ) {
 561+ $result = (array)$result;
 562+ $data = array();
 563+ $idFieldLength = strlen( $this->getFieldPrefix() );
 564+
 565+ foreach ( $result as $name => $value ) {
 566+ $data[substr( $name, $idFieldLength )] = $value;
 567+ }
 568+
 569+ return $data;
 570+ }
 571+
 572+ /**
 573+ * Get a new instance of the class from a database result.
 574+ *
 575+ * @since 0.1
 576+ *
 577+ * @param object $result
 578+ *
 579+ * @return ReviewDBObject
 580+ */
 581+ public function newFromDBResult( $result ) {
 582+ return $this->newFromArray( $this->getFieldsFromDBResult( $result ) );
 583+ }
 584+
 585+ /**
 586+ * Removes the object from the database.
 587+ *
 588+ * @since 0.1
 589+ *
 590+ * @param array $conditions
 591+ *
 592+ * @return boolean Success indicator
 593+ */
 594+ public function delete( array $conditions ) {
 595+ return wfGetDB( DB_MASTER )->delete(
 596+ $this->getDBTable(),
 597+ $this->getPrefixedValues( $conditions )
 598+ );
 599+ }
 600+
 601+ /**
 602+ * Add an amount (can be negative) to the specified field (needs to be numeric).
 603+ *
 604+ * @since 0.1
 605+ *
 606+ * @param string $field
 607+ * @param integer $amount
 608+ *
 609+ * @return boolean Success indicator
 610+ */
 611+ public function addToField( $field, $amount ) {
 612+ if ( $amount == 0 ) {
 613+ return true;
 614+ }
 615+
 616+ if ( !$this->hasIdField() ) {
 617+ return false;
 618+ }
 619+
 620+ $absoluteAmount = abs( $amount );
 621+ $isNegative = $amount < 0;
 622+
 623+ $dbw = wfGetDB( DB_MASTER );
 624+
 625+ $fullField = $this->getPrefixedField( $field );
 626+
 627+ $success = $dbw->update(
 628+ $this->getDBTable(),
 629+ array( "$fullField=$fullField" . ( $isNegative ? '-' : '+' ) . $absoluteAmount ),
 630+ array( $this->getPrefixedField( 'id' ) => $this->getId() ),
 631+ __METHOD__
 632+ );
 633+
 634+ if ( $success && $this->hasField( $field ) ) {
 635+ $this->setField( $field, $this->getField( $field ) + $amount );
 636+ }
 637+
 638+ return $success;
 639+ }
 640+
 641+ /**
 642+ * Selects the the specified fields of the records matching the provided
 643+ * conditions. Field names get prefixed.
 644+ *
 645+ * @since 0.1
 646+ *
 647+ * @param array|string|null $fields
 648+ * @param array $conditions
 649+ * @param array $options
 650+ *
 651+ * @return array of self
 652+ */
 653+ public function select( $fields = null, array $conditions = array(), array $options = array() ) {
 654+ if ( is_null( $fields ) ) {
 655+ $fields = array_keys( $this->getFieldTypes() );
 656+ }
 657+
 658+ $result = $this->rawSelect(
 659+ $this->getPrefixedFields( $fields ),
 660+ $this->getPrefixedValues( $conditions ),
 661+ $options
 662+ );
 663+
 664+ $objects = array();
 665+
 666+ foreach ( $result as $record ) {
 667+ $objects[] = $this->newFromDBResult( $record );
 668+ }
 669+
 670+ return $objects;
 671+ }
 672+
 673+ /**
 674+ * Selects the the specified fields of the first matching record.
 675+ * Field names get prefixed.
 676+ *
 677+ * @since 0.1
 678+ *
 679+ * @param array|string|null $fields
 680+ * @param array $conditions
 681+ * @param array $options
 682+ *
 683+ * @return self|false
 684+ */
 685+ public function selectRow( $fields = null, array $conditions = array(), array $options = array() ) {
 686+ $options['LIMIT'] = 1;
 687+
 688+ $objects = $this->select( $fields, $conditions, $options );
 689+
 690+ return count( $objects ) > 0 ? $objects[0] : false;
 691+ }
 692+
 693+ /**
 694+ * Returns if there is at least one record matching the provided conditions.
 695+ * Condition field names get prefixed.
 696+ *
 697+ * @since 0.1
 698+ *
 699+ * @param array $conditions
 700+ *
 701+ * @return boolean
 702+ */
 703+ public function has( array $conditions = array() ) {
 704+ return $this->selectRow( array( 'id' ), $conditions ) !== false;
 705+ }
 706+
 707+ /**
 708+ * Returns the amount of matching records.
 709+ * Condition field names get prefixed.
 710+ *
 711+ * @since 0.1
 712+ *
 713+ * @param array $conditions
 714+ * @param array $options
 715+ *
 716+ * @return integer
 717+ */
 718+ public function count( array $conditions = array(), array $options = array() ) {
 719+ $res = $this->rawSelect(
 720+ array( 'COUNT(*) AS rowcount' ),
 721+ $this->getPrefixedValues( $conditions ),
 722+ $options
 723+ )->fetchObject();
 724+
 725+ return $res->rowcount;
 726+ }
 727+
 728+ /**
 729+ * Selects the the specified fields of the records matching the provided
 730+ * conditions. Field names do NOT get prefixed.
 731+ *
 732+ * @since 0.1
 733+ *
 734+ * @param array|null $fields
 735+ * @param array $conditions
 736+ * @param array $options
 737+ *
 738+ * @return ResultWrapper
 739+ */
 740+ public function rawSelect( $fields = null, array $conditions = array(), array $options = array() ) {
 741+ $dbr = wfGetDB( $this->getReadDb() );
 742+
 743+ return $dbr->select(
 744+ $this->getDBTable(),
 745+ $fields,
 746+ count( $conditions ) == 0 ? '' : $conditions,
 747+ __METHOD__,
 748+ $options
 749+ );
 750+ }
 751+
 752+ /**
 753+ * Update the records matching the provided conditions by
 754+ * setting the fields that are keys in the $values patam to
 755+ * their corresponding values.
 756+ *
 757+ * @since 0.1
 758+ *
 759+ * @param array $values
 760+ * @param array $conditions
 761+ *
 762+ * @return boolean Success indicator
 763+ */
 764+ public function update( array $values, array $conditions = array() ) {
 765+ $dbw = wfGetDB( DB_MASTER );
 766+
 767+ return $dbw->update(
 768+ $this->getDBTable(),
 769+ $this->getPrefixedValues( $values ),
 770+ $this->getPrefixedValues( $conditions ),
 771+ __METHOD__
 772+ );
 773+ }
 774+
 775+ /**
 776+ * Return the names of the fields.
 777+ *
 778+ * @since 0.1
 779+ *
 780+ * @return array
 781+ */
 782+ public function getFieldNames() {
 783+ return array_keys( $this->getFieldTypes() );
 784+ }
 785+
 786+ /**
 787+ * Returns an array with the fields and their descriptions.
 788+ *
 789+ * field name => field description
 790+ *
 791+ * @since 0.1
 792+ *
 793+ * @return array
 794+ */
 795+ public function getFieldDescriptions() {
 796+ return array();
 797+ }
 798+
 799+ /**
 800+ * Get API parameters for the fields supported by this object.
 801+ *
 802+ * @since 0.1
 803+ *
 804+ * @param boolean $requireParams
 805+ * @param boolean $setDefaults
 806+ *
 807+ * @return array
 808+ */
 809+ public function getAPIParams( $requireParams = false, $setDefaults = false ) {
 810+ $typeMap = array(
 811+ 'id' => 'integer',
 812+ 'int' => 'integer',
 813+ 'float' => 'NULL',
 814+ 'str' => 'string',
 815+ 'bool' => 'integer',
 816+ 'array' => 'string'
 817+ );
 818+
 819+ $params = array();
 820+ $defaults = $this->getDefaults();
 821+
 822+ foreach ( $this->getFieldTypes() as $field => $type ) {
 823+ if ( $field == 'id' ) {
 824+ continue;
 825+ }
 826+
 827+ $hasDefault = array_key_exists( $field, $defaults );
 828+
 829+ $params[$field] = array(
 830+ ApiBase::PARAM_TYPE => $typeMap[$type],
 831+ ApiBase::PARAM_REQUIRED => $requireParams && !$hasDefault
 832+ );
 833+
 834+ if ( $type == 'array' ) {
 835+ $params[$field][ApiBase::PARAM_ISMULTI] = true;
 836+ }
 837+
 838+ if ( $setDefaults && $hasDefault ) {
 839+ $default = is_array( $defaults[$field] ) ? implode( '|', $defaults[$field] ) : $defaults[$field];
 840+ $params[$field][ApiBase::PARAM_DFLT] = $default;
 841+ }
 842+ }
 843+
 844+ return $params;
 845+ }
 846+
 847+}
Index: trunk/extensions/Reviews/COPYING
@@ -0,0 +1,682 @@
 2+The license text below "----" applies to all files within this distribution, other
 3+than those that are in a directory which contains files named "LICENSE" or
 4+"COPYING", or a subdirectory thereof. For those files, the license text contained in
 5+said file overrides any license information contained in directories of smaller depth.
 6+Alternative licenses are typically used for software that is provided by external
 7+parties, and merely packaged with this software for convenience.
 8+----
 9+
 10+ GNU GENERAL PUBLIC LICENSE
 11+ Version 3, 29 June 2007
 12+
 13+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
 14+ Everyone is permitted to copy and distribute verbatim copies
 15+ of this license document, but changing it is not allowed.
 16+
 17+ Preamble
 18+
 19+ The GNU General Public License is a free, copyleft license for
 20+software and other kinds of works.
 21+
 22+ The licenses for most software and other practical works are designed
 23+to take away your freedom to share and change the works. By contrast,
 24+the GNU General Public License is intended to guarantee your freedom to
 25+share and change all versions of a program--to make sure it remains free
 26+software for all its users. We, the Free Software Foundation, use the
 27+GNU General Public License for most of our software; it applies also to
 28+any other work released this way by its authors. You can apply it to
 29+your programs, too.
 30+
 31+ When we speak of free software, we are referring to freedom, not
 32+price. Our General Public Licenses are designed to make sure that you
 33+have the freedom to distribute copies of free software (and charge for
 34+them if you wish), that you receive source code or can get it if you
 35+want it, that you can change the software or use pieces of it in new
 36+free programs, and that you know you can do these things.
 37+
 38+ To protect your rights, we need to prevent others from denying you
 39+these rights or asking you to surrender the rights. Therefore, you have
 40+certain responsibilities if you distribute copies of the software, or if
 41+you modify it: responsibilities to respect the freedom of others.
 42+
 43+ For example, if you distribute copies of such a program, whether
 44+gratis or for a fee, you must pass on to the recipients the same
 45+freedoms that you received. You must make sure that they, too, receive
 46+or can get the source code. And you must show them these terms so they
 47+know their rights.
 48+
 49+ Developers that use the GNU GPL protect your rights with two steps:
 50+(1) assert copyright on the software, and (2) offer you this License
 51+giving you legal permission to copy, distribute and/or modify it.
 52+
 53+ For the developers' and authors' protection, the GPL clearly explains
 54+that there is no warranty for this free software. For both users' and
 55+authors' sake, the GPL requires that modified versions be marked as
 56+changed, so that their problems will not be attributed erroneously to
 57+authors of previous versions.
 58+
 59+ Some devices are designed to deny users access to install or run
 60+modified versions of the software inside them, although the manufacturer
 61+can do so. This is fundamentally incompatible with the aim of
 62+protecting users' freedom to change the software. The systematic
 63+pattern of such abuse occurs in the area of products for individuals to
 64+use, which is precisely where it is most unacceptable. Therefore, we
 65+have designed this version of the GPL to prohibit the practice for those
 66+products. If such problems arise substantially in other domains, we
 67+stand ready to extend this provision to those domains in future versions
 68+of the GPL, as needed to protect the freedom of users.
 69+
 70+ Finally, every program is threatened constantly by software patents.
 71+States should not allow patents to restrict development and use of
 72+software on general-purpose computers, but in those that do, we wish to
 73+avoid the special danger that patents applied to a free program could
 74+make it effectively proprietary. To prevent this, the GPL assures that
 75+patents cannot be used to render the program non-free.
 76+
 77+ The precise terms and conditions for copying, distribution and
 78+modification follow.
 79+
 80+ TERMS AND CONDITIONS
 81+
 82+ 0. Definitions.
 83+
 84+ "This License" refers to version 3 of the GNU General Public License.
 85+
 86+ "Copyright" also means copyright-like laws that apply to other kinds of
 87+works, such as semiconductor masks.
 88+
 89+ "The Program" refers to any copyrightable work licensed under this
 90+License. Each licensee is addressed as "you". "Licensees" and
 91+"recipients" may be individuals or organizations.
 92+
 93+ To "modify" a work means to copy from or adapt all or part of the work
 94+in a fashion requiring copyright permission, other than the making of an
 95+exact copy. The resulting work is called a "modified version" of the
 96+earlier work or a work "based on" the earlier work.
 97+
 98+ A "covered work" means either the unmodified Program or a work based
 99+on the Program.
 100+
 101+ To "propagate" a work means to do anything with it that, without
 102+permission, would make you directly or secondarily liable for
 103+infringement under applicable copyright law, except executing it on a
 104+computer or modifying a private copy. Propagation includes copying,
 105+distribution (with or without modification), making available to the
 106+public, and in some countries other activities as well.
 107+
 108+ To "convey" a work means any kind of propagation that enables other
 109+parties to make or receive copies. Mere interaction with a user through
 110+a computer network, with no transfer of a copy, is not conveying.
 111+
 112+ An interactive user interface displays "Appropriate Legal Notices"
 113+to the extent that it includes a convenient and prominently visible
 114+feature that (1) displays an appropriate copyright notice, and (2)
 115+tells the user that there is no warranty for the work (except to the
 116+extent that warranties are provided), that licensees may convey the
 117+work under this License, and how to view a copy of this License. If
 118+the interface presents a list of user commands or options, such as a
 119+menu, a prominent item in the list meets this criterion.
 120+
 121+ 1. Source Code.
 122+
 123+ The "source code" for a work means the preferred form of the work
 124+for making modifications to it. "Object code" means any non-source
 125+form of a work.
 126+
 127+ A "Standard Interface" means an interface that either is an official
 128+standard defined by a recognized standards body, or, in the case of
 129+interfaces specified for a particular programming language, one that
 130+is widely used among developers working in that language.
 131+
 132+ The "System Libraries" of an executable work include anything, other
 133+than the work as a whole, that (a) is included in the normal form of
 134+packaging a Major Component, but which is not part of that Major
 135+Component, and (b) serves only to enable use of the work with that
 136+Major Component, or to implement a Standard Interface for which an
 137+implementation is available to the public in source code form. A
 138+"Major Component", in this context, means a major essential component
 139+(kernel, window system, and so on) of the specific operating system
 140+(if any) on which the executable work runs, or a compiler used to
 141+produce the work, or an object code interpreter used to run it.
 142+
 143+ The "Corresponding Source" for a work in object code form means all
 144+the source code needed to generate, install, and (for an executable
 145+work) run the object code and to modify the work, including scripts to
 146+control those activities. However, it does not include the work's
 147+System Libraries, or general-purpose tools or generally available free
 148+programs which are used unmodified in performing those activities but
 149+which are not part of the work. For example, Corresponding Source
 150+includes interface definition files associated with source files for
 151+the work, and the source code for shared libraries and dynamically
 152+linked subprograms that the work is specifically designed to require,
 153+such as by intimate data communication or control flow between those
 154+subprograms and other parts of the work.
 155+
 156+ The Corresponding Source need not include anything that users
 157+can regenerate automatically from other parts of the Corresponding
 158+Source.
 159+
 160+ The Corresponding Source for a work in source code form is that
 161+same work.
 162+
 163+ 2. Basic Permissions.
 164+
 165+ All rights granted under this License are granted for the term of
 166+copyright on the Program, and are irrevocable provided the stated
 167+conditions are met. This License explicitly affirms your unlimited
 168+permission to run the unmodified Program. The output from running a
 169+covered work is covered by this License only if the output, given its
 170+content, constitutes a covered work. This License acknowledges your
 171+rights of fair use or other equivalent, as provided by copyright law.
 172+
 173+ You may make, run and propagate covered works that you do not
 174+convey, without conditions so long as your license otherwise remains
 175+in force. You may convey covered works to others for the sole purpose
 176+of having them make modifications exclusively for you, or provide you
 177+with facilities for running those works, provided that you comply with
 178+the terms of this License in conveying all material for which you do
 179+not control copyright. Those thus making or running the covered works
 180+for you must do so exclusively on your behalf, under your direction
 181+and control, on terms that prohibit them from making any copies of
 182+your copyrighted material outside their relationship with you.
 183+
 184+ Conveying under any other circumstances is permitted solely under
 185+the conditions stated below. Sublicensing is not allowed; section 10
 186+makes it unnecessary.
 187+
 188+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
 189+
 190+ No covered work shall be deemed part of an effective technological
 191+measure under any applicable law fulfilling obligations under article
 192+11 of the WIPO copyright treaty adopted on 20 December 1996, or
 193+similar laws prohibiting or restricting circumvention of such
 194+measures.
 195+
 196+ When you convey a covered work, you waive any legal power to forbid
 197+circumvention of technological measures to the extent such circumvention
 198+is effected by exercising rights under this License with respect to
 199+the covered work, and you disclaim any intention to limit operation or
 200+modification of the work as a means of enforcing, against the work's
 201+users, your or third parties' legal rights to forbid circumvention of
 202+technological measures.
 203+
 204+ 4. Conveying Verbatim Copies.
 205+
 206+ You may convey verbatim copies of the Program's source code as you
 207+receive it, in any medium, provided that you conspicuously and
 208+appropriately publish on each copy an appropriate copyright notice;
 209+keep intact all notices stating that this License and any
 210+non-permissive terms added in accord with section 7 apply to the code;
 211+keep intact all notices of the absence of any warranty; and give all
 212+recipients a copy of this License along with the Program.
 213+
 214+ You may charge any price or no price for each copy that you convey,
 215+and you may offer support or warranty protection for a fee.
 216+
 217+ 5. Conveying Modified Source Versions.
 218+
 219+ You may convey a work based on the Program, or the modifications to
 220+produce it from the Program, in the form of source code under the
 221+terms of section 4, provided that you also meet all of these conditions:
 222+
 223+ a) The work must carry prominent notices stating that you modified
 224+ it, and giving a relevant date.
 225+
 226+ b) The work must carry prominent notices stating that it is
 227+ released under this License and any conditions added under section
 228+ 7. This requirement modifies the requirement in section 4 to
 229+ "keep intact all notices".
 230+
 231+ c) You must license the entire work, as a whole, under this
 232+ License to anyone who comes into possession of a copy. This
 233+ License will therefore apply, along with any applicable section 7
 234+ additional terms, to the whole of the work, and all its parts,
 235+ regardless of how they are packaged. This License gives no
 236+ permission to license the work in any other way, but it does not
 237+ invalidate such permission if you have separately received it.
 238+
 239+ d) If the work has interactive user interfaces, each must display
 240+ Appropriate Legal Notices; however, if the Program has interactive
 241+ interfaces that do not display Appropriate Legal Notices, your
 242+ work need not make them do so.
 243+
 244+ A compilation of a covered work with other separate and independent
 245+works, which are not by their nature extensions of the covered work,
 246+and which are not combined with it such as to form a larger program,
 247+in or on a volume of a storage or distribution medium, is called an
 248+"aggregate" if the compilation and its resulting copyright are not
 249+used to limit the access or legal rights of the compilation's users
 250+beyond what the individual works permit. Inclusion of a covered work
 251+in an aggregate does not cause this License to apply to the other
 252+parts of the aggregate.
 253+
 254+ 6. Conveying Non-Source Forms.
 255+
 256+ You may convey a covered work in object code form under the terms
 257+of sections 4 and 5, provided that you also convey the
 258+machine-readable Corresponding Source under the terms of this License,
 259+in one of these ways:
 260+
 261+ a) Convey the object code in, or embodied in, a physical product
 262+ (including a physical distribution medium), accompanied by the
 263+ Corresponding Source fixed on a durable physical medium
 264+ customarily used for software interchange.
 265+
 266+ b) Convey the object code in, or embodied in, a physical product
 267+ (including a physical distribution medium), accompanied by a
 268+ written offer, valid for at least three years and valid for as
 269+ long as you offer spare parts or customer support for that product
 270+ model, to give anyone who possesses the object code either (1) a
 271+ copy of the Corresponding Source for all the software in the
 272+ product that is covered by this License, on a durable physical
 273+ medium customarily used for software interchange, for a price no
 274+ more than your reasonable cost of physically performing this
 275+ conveying of source, or (2) access to copy the
 276+ Corresponding Source from a network server at no charge.
 277+
 278+ c) Convey individual copies of the object code with a copy of the
 279+ written offer to provide the Corresponding Source. This
 280+ alternative is allowed only occasionally and noncommercially, and
 281+ only if you received the object code with such an offer, in accord
 282+ with subsection 6b.
 283+
 284+ d) Convey the object code by offering access from a designated
 285+ place (gratis or for a charge), and offer equivalent access to the
 286+ Corresponding Source in the same way through the same place at no
 287+ further charge. You need not require recipients to copy the
 288+ Corresponding Source along with the object code. If the place to
 289+ copy the object code is a network server, the Corresponding Source
 290+ may be on a different server (operated by you or a third party)
 291+ that supports equivalent copying facilities, provided you maintain
 292+ clear directions next to the object code saying where to find the
 293+ Corresponding Source. Regardless of what server hosts the
 294+ Corresponding Source, you remain obligated to ensure that it is
 295+ available for as long as needed to satisfy these requirements.
 296+
 297+ e) Convey the object code using peer-to-peer transmission, provided
 298+ you inform other peers where the object code and Corresponding
 299+ Source of the work are being offered to the general public at no
 300+ charge under subsection 6d.
 301+
 302+ A separable portion of the object code, whose source code is excluded
 303+from the Corresponding Source as a System Library, need not be
 304+included in conveying the object code work.
 305+
 306+ A "User Product" is either (1) a "consumer product", which means any
 307+tangible personal property which is normally used for personal, family,
 308+or household purposes, or (2) anything designed or sold for incorporation
 309+into a dwelling. In determining whether a product is a consumer product,
 310+doubtful cases shall be resolved in favor of coverage. For a particular
 311+product received by a particular user, "normally used" refers to a
 312+typical or common use of that class of product, regardless of the status
 313+of the particular user or of the way in which the particular user
 314+actually uses, or expects or is expected to use, the product. A product
 315+is a consumer product regardless of whether the product has substantial
 316+commercial, industrial or non-consumer uses, unless such uses represent
 317+the only significant mode of use of the product.
 318+
 319+ "Installation Information" for a User Product means any methods,
 320+procedures, authorization keys, or other information required to install
 321+and execute modified versions of a covered work in that User Product from
 322+a modified version of its Corresponding Source. The information must
 323+suffice to ensure that the continued functioning of the modified object
 324+code is in no case prevented or interfered with solely because
 325+modification has been made.
 326+
 327+ If you convey an object code work under this section in, or with, or
 328+specifically for use in, a User Product, and the conveying occurs as
 329+part of a transaction in which the right of possession and use of the
 330+User Product is transferred to the recipient in perpetuity or for a
 331+fixed term (regardless of how the transaction is characterized), the
 332+Corresponding Source conveyed under this section must be accompanied
 333+by the Installation Information. But this requirement does not apply
 334+if neither you nor any third party retains the ability to install
 335+modified object code on the User Product (for example, the work has
 336+been installed in ROM).
 337+
 338+ The requirement to provide Installation Information does not include a
 339+requirement to continue to provide support service, warranty, or updates
 340+for a work that has been modified or installed by the recipient, or for
 341+the User Product in which it has been modified or installed. Access to a
 342+network may be denied when the modification itself materially and
 343+adversely affects the operation of the network or violates the rules and
 344+protocols for communication across the network.
 345+
 346+ Corresponding Source conveyed, and Installation Information provided,
 347+in accord with this section must be in a format that is publicly
 348+documented (and with an implementation available to the public in
 349+source code form), and must require no special password or key for
 350+unpacking, reading or copying.
 351+
 352+ 7. Additional Terms.
 353+
 354+ "Additional permissions" are terms that supplement the terms of this
 355+License by making exceptions from one or more of its conditions.
 356+Additional permissions that are applicable to the entire Program shall
 357+be treated as though they were included in this License, to the extent
 358+that they are valid under applicable law. If additional permissions
 359+apply only to part of the Program, that part may be used separately
 360+under those permissions, but the entire Program remains governed by
 361+this License without regard to the additional permissions.
 362+
 363+ When you convey a copy of a covered work, you may at your option
 364+remove any additional permissions from that copy, or from any part of
 365+it. (Additional permissions may be written to require their own
 366+removal in certain cases when you modify the work.) You may place
 367+additional permissions on material, added by you to a covered work,
 368+for which you have or can give appropriate copyright permission.
 369+
 370+ Notwithstanding any other provision of this License, for material you
 371+add to a covered work, you may (if authorized by the copyright holders of
 372+that material) supplement the terms of this License with terms:
 373+
 374+ a) Disclaiming warranty or limiting liability differently from the
 375+ terms of sections 15 and 16 of this License; or
 376+
 377+ b) Requiring preservation of specified reasonable legal notices or
 378+ author attributions in that material or in the Appropriate Legal
 379+ Notices displayed by works containing it; or
 380+
 381+ c) Prohibiting misrepresentation of the origin of that material, or
 382+ requiring that modified versions of such material be marked in
 383+ reasonable ways as different from the original version; or
 384+
 385+ d) Limiting the use for publicity purposes of names of licensors or
 386+ authors of the material; or
 387+
 388+ e) Declining to grant rights under trademark law for use of some
 389+ trade names, trademarks, or service marks; or
 390+
 391+ f) Requiring indemnification of licensors and authors of that
 392+ material by anyone who conveys the material (or modified versions of
 393+ it) with contractual assumptions of liability to the recipient, for
 394+ any liability that these contractual assumptions directly impose on
 395+ those licensors and authors.
 396+
 397+ All other non-permissive additional terms are considered "further
 398+restrictions" within the meaning of section 10. If the Program as you
 399+received it, or any part of it, contains a notice stating that it is
 400+governed by this License along with a term that is a further
 401+restriction, you may remove that term. If a license document contains
 402+a further restriction but permits relicensing or conveying under this
 403+License, you may add to a covered work material governed by the terms
 404+of that license document, provided that the further restriction does
 405+not survive such relicensing or conveying.
 406+
 407+ If you add terms to a covered work in accord with this section, you
 408+must place, in the relevant source files, a statement of the
 409+additional terms that apply to those files, or a notice indicating
 410+where to find the applicable terms.
 411+
 412+ Additional terms, permissive or non-permissive, may be stated in the
 413+form of a separately written license, or stated as exceptions;
 414+the above requirements apply either way.
 415+
 416+ 8. Termination.
 417+
 418+ You may not propagate or modify a covered work except as expressly
 419+provided under this License. Any attempt otherwise to propagate or
 420+modify it is void, and will automatically terminate your rights under
 421+this License (including any patent licenses granted under the third
 422+paragraph of section 11).
 423+
 424+ However, if you cease all violation of this License, then your
 425+license from a particular copyright holder is reinstated (a)
 426+provisionally, unless and until the copyright holder explicitly and
 427+finally terminates your license, and (b) permanently, if the copyright
 428+holder fails to notify you of the violation by some reasonable means
 429+prior to 60 days after the cessation.
 430+
 431+ Moreover, your license from a particular copyright holder is
 432+reinstated permanently if the copyright holder notifies you of the
 433+violation by some reasonable means, this is the first time you have
 434+received notice of violation of this License (for any work) from that
 435+copyright holder, and you cure the violation prior to 30 days after
 436+your receipt of the notice.
 437+
 438+ Termination of your rights under this section does not terminate the
 439+licenses of parties who have received copies or rights from you under
 440+this License. If your rights have been terminated and not permanently
 441+reinstated, you do not qualify to receive new licenses for the same
 442+material under section 10.
 443+
 444+ 9. Acceptance Not Required for Having Copies.
 445+
 446+ You are not required to accept this License in order to receive or
 447+run a copy of the Program. Ancillary propagation of a covered work
 448+occurring solely as a consequence of using peer-to-peer transmission
 449+to receive a copy likewise does not require acceptance. However,
 450+nothing other than this License grants you permission to propagate or
 451+modify any covered work. These actions infringe copyright if you do
 452+not accept this License. Therefore, by modifying or propagating a
 453+covered work, you indicate your acceptance of this License to do so.
 454+
 455+ 10. Automatic Licensing of Downstream Recipients.
 456+
 457+ Each time you convey a covered work, the recipient automatically
 458+receives a license from the original licensors, to run, modify and
 459+propagate that work, subject to this License. You are not responsible
 460+for enforcing compliance by third parties with this License.
 461+
 462+ An "entity transaction" is a transaction transferring control of an
 463+organization, or substantially all assets of one, or subdividing an
 464+organization, or merging organizations. If propagation of a covered
 465+work results from an entity transaction, each party to that
 466+transaction who receives a copy of the work also receives whatever
 467+licenses to the work the party's predecessor in interest had or could
 468+give under the previous paragraph, plus a right to possession of the
 469+Corresponding Source of the work from the predecessor in interest, if
 470+the predecessor has it or can get it with reasonable efforts.
 471+
 472+ You may not impose any further restrictions on the exercise of the
 473+rights granted or affirmed under this License. For example, you may
 474+not impose a license fee, royalty, or other charge for exercise of
 475+rights granted under this License, and you may not initiate litigation
 476+(including a cross-claim or counterclaim in a lawsuit) alleging that
 477+any patent claim is infringed by making, using, selling, offering for
 478+sale, or importing the Program or any portion of it.
 479+
 480+ 11. Patents.
 481+
 482+ A "contributor" is a copyright holder who authorizes use under this
 483+License of the Program or a work on which the Program is based. The
 484+work thus licensed is called the contributor's "contributor version".
 485+
 486+ A contributor's "essential patent claims" are all patent claims
 487+owned or controlled by the contributor, whether already acquired or
 488+hereafter acquired, that would be infringed by some manner, permitted
 489+by this License, of making, using, or selling its contributor version,
 490+but do not include claims that would be infringed only as a
 491+consequence of further modification of the contributor version. For
 492+purposes of this definition, "control" includes the right to grant
 493+patent sublicenses in a manner consistent with the requirements of
 494+this License.
 495+
 496+ Each contributor grants you a non-exclusive, worldwide, royalty-free
 497+patent license under the contributor's essential patent claims, to
 498+make, use, sell, offer for sale, import and otherwise run, modify and
 499+propagate the contents of its contributor version.
 500+
 501+ In the following three paragraphs, a "patent license" is any express
 502+agreement or commitment, however denominated, not to enforce a patent
 503+(such as an express permission to practice a patent or covenant not to
 504+sue for patent infringement). To "grant" such a patent license to a
 505+party means to make such an agreement or commitment not to enforce a
 506+patent against the party.
 507+
 508+ If you convey a covered work, knowingly relying on a patent license,
 509+and the Corresponding Source of the work is not available for anyone
 510+to copy, free of charge and under the terms of this License, through a
 511+publicly available network server or other readily accessible means,
 512+then you must either (1) cause the Corresponding Source to be so
 513+available, or (2) arrange to deprive yourself of the benefit of the
 514+patent license for this particular work, or (3) arrange, in a manner
 515+consistent with the requirements of this License, to extend the patent
 516+license to downstream recipients. "Knowingly relying" means you have
 517+actual knowledge that, but for the patent license, your conveying the
 518+covered work in a country, or your recipient's use of the covered work
 519+in a country, would infringe one or more identifiable patents in that
 520+country that you have reason to believe are valid.
 521+
 522+ If, pursuant to or in connection with a single transaction or
 523+arrangement, you convey, or propagate by procuring conveyance of, a
 524+covered work, and grant a patent license to some of the parties
 525+receiving the covered work authorizing them to use, propagate, modify
 526+or convey a specific copy of the covered work, then the patent license
 527+you grant is automatically extended to all recipients of the covered
 528+work and works based on it.
 529+
 530+ A patent license is "discriminatory" if it does not include within
 531+the scope of its coverage, prohibits the exercise of, or is
 532+conditioned on the non-exercise of one or more of the rights that are
 533+specifically granted under this License. You may not convey a covered
 534+work if you are a party to an arrangement with a third party that is
 535+in the business of distributing software, under which you make payment
 536+to the third party based on the extent of your activity of conveying
 537+the work, and under which the third party grants, to any of the
 538+parties who would receive the covered work from you, a discriminatory
 539+patent license (a) in connection with copies of the covered work
 540+conveyed by you (or copies made from those copies), or (b) primarily
 541+for and in connection with specific products or compilations that
 542+contain the covered work, unless you entered into that arrangement,
 543+or that patent license was granted, prior to 28 March 2007.
 544+
 545+ Nothing in this License shall be construed as excluding or limiting
 546+any implied license or other defenses to infringement that may
 547+otherwise be available to you under applicable patent law.
 548+
 549+ 12. No Surrender of Others' Freedom.
 550+
 551+ If conditions are imposed on you (whether by court order, agreement or
 552+otherwise) that contradict the conditions of this License, they do not
 553+excuse you from the conditions of this License. If you cannot convey a
 554+covered work so as to satisfy simultaneously your obligations under this
 555+License and any other pertinent obligations, then as a consequence you may
 556+not convey it at all. For example, if you agree to terms that obligate you
 557+to collect a royalty for further conveying from those to whom you convey
 558+the Program, the only way you could satisfy both those terms and this
 559+License would be to refrain entirely from conveying the Program.
 560+
 561+ 13. Use with the GNU Affero General Public License.
 562+
 563+ Notwithstanding any other provision of this License, you have
 564+permission to link or combine any covered work with a work licensed
 565+under version 3 of the GNU Affero General Public License into a single
 566+combined work, and to convey the resulting work. The terms of this
 567+License will continue to apply to the part which is the covered work,
 568+but the special requirements of the GNU Affero General Public License,
 569+section 13, concerning interaction through a network will apply to the
 570+combination as such.
 571+
 572+ 14. Revised Versions of this License.
 573+
 574+ The Free Software Foundation may publish revised and/or new versions of
 575+the GNU General Public License from time to time. Such new versions will
 576+be similar in spirit to the present version, but may differ in detail to
 577+address new problems or concerns.
 578+
 579+ Each version is given a distinguishing version number. If the
 580+Program specifies that a certain numbered version of the GNU General
 581+Public License "or any later version" applies to it, you have the
 582+option of following the terms and conditions either of that numbered
 583+version or of any later version published by the Free Software
 584+Foundation. If the Program does not specify a version number of the
 585+GNU General Public License, you may choose any version ever published
 586+by the Free Software Foundation.
 587+
 588+ If the Program specifies that a proxy can decide which future
 589+versions of the GNU General Public License can be used, that proxy's
 590+public statement of acceptance of a version permanently authorizes you
 591+to choose that version for the Program.
 592+
 593+ Later license versions may give you additional or different
 594+permissions. However, no additional obligations are imposed on any
 595+author or copyright holder as a result of your choosing to follow a
 596+later version.
 597+
 598+ 15. Disclaimer of Warranty.
 599+
 600+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
 601+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
 602+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
 603+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
 604+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 605+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
 606+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
 607+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
 608+
 609+ 16. Limitation of Liability.
 610+
 611+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
 612+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
 613+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
 614+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
 615+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
 616+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
 617+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
 618+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
 619+SUCH DAMAGES.
 620+
 621+ 17. Interpretation of Sections 15 and 16.
 622+
 623+ If the disclaimer of warranty and limitation of liability provided
 624+above cannot be given local legal effect according to their terms,
 625+reviewing courts shall apply local law that most closely approximates
 626+an absolute waiver of all civil liability in connection with the
 627+Program, unless a warranty or assumption of liability accompanies a
 628+copy of the Program in return for a fee.
 629+
 630+ END OF TERMS AND CONDITIONS
 631+
 632+ How to Apply These Terms to Your New Programs
 633+
 634+ If you develop a new program, and you want it to be of the greatest
 635+possible use to the public, the best way to achieve this is to make it
 636+free software which everyone can redistribute and change under these terms.
 637+
 638+ To do so, attach the following notices to the program. It is safest
 639+to attach them to the start of each source file to most effectively
 640+state the exclusion of warranty; and each file should have at least
 641+the "copyright" line and a pointer to where the full notice is found.
 642+
 643+ <one line to give the program's name and a brief idea of what it does.>
 644+ Copyright (C) <year> <name of author>
 645+
 646+ This program is free software: you can redistribute it and/or modify
 647+ it under the terms of the GNU General Public License as published by
 648+ the Free Software Foundation, either version 3 of the License, or
 649+ (at your option) any later version.
 650+
 651+ This program is distributed in the hope that it will be useful,
 652+ but WITHOUT ANY WARRANTY; without even the implied warranty of
 653+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 654+ GNU General Public License for more details.
 655+
 656+ You should have received a copy of the GNU General Public License
 657+ along with this program. If not, see <http://www.gnu.org/licenses/>.
 658+
 659+Also add information on how to contact you by electronic and paper mail.
 660+
 661+ If the program does terminal interaction, make it output a short
 662+notice like this when it starts in an interactive mode:
 663+
 664+ <program> Copyright (C) <year> <name of author>
 665+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
 666+ This is free software, and you are welcome to redistribute it
 667+ under certain conditions; type `show c' for details.
 668+
 669+The hypothetical commands `show w' and `show c' should show the appropriate
 670+parts of the General Public License. Of course, your program's commands
 671+might be different; for a GUI interface, you would use an "about box".
 672+
 673+ You should also get your employer (if you work as a programmer) or school,
 674+if any, to sign a "copyright disclaimer" for the program, if necessary.
 675+For more information on this, and how to apply and follow the GNU GPL, see
 676+<http://www.gnu.org/licenses/>.
 677+
 678+ The GNU General Public License does not permit incorporating your program
 679+into proprietary programs. If your program is a subroutine library, you
 680+may consider it more useful to permit linking proprietary applications with
 681+the library. If this is what you want to do, use the GNU Lesser General
 682+Public License instead of this License. But first, please read
 683+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
\ No newline at end of file
Index: trunk/extensions/Reviews/Reviews.i18n.php
@@ -0,0 +1,41 @@
 2+<?php
 3+
 4+/**
 5+ * Internationalization file for the Reviews extension.
 6+ *
 7+ * @since 0.1
 8+ *
 9+ * @file Reviews.i18n.php
 10+ * @ingroup Reviews
 11+ *
 12+ * @licence GNU GPL v3+
 13+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 14+ */
 15+
 16+$messages = array();
 17+
 18+/** English
 19+ * @author Jeroen De Dauw
 20+ */
 21+$messages['en'] = array(
 22+ 'reviews-desc' => 'Allow users to post reviews per article.',
 23+
 24+ // Misc
 25+ 'reviews-toplink' => 'My reviews',
 26+
 27+ // Rights
 28+ 'right-reviewsadmin' => 'Manage reviews',
 29+ 'right-reviewer' => 'Post reviews',
 30+
 31+ 'action-reviewsadmin' => 'manage reviews',
 32+ 'action-reviewer' => 'post reviews',
 33+
 34+ // Groups
 35+ 'group-reviewsadmin' => 'Review admins',
 36+ 'group-reviewsadmin-member' => '{{GENDER:$1|review administrator}}',
 37+ 'grouppage-reviewsadmin' => '{{ns:project}}:Review_administrators',
 38+
 39+ 'group-reviewer' => 'Reviewer',
 40+ 'group-reviewer-member' => '{{GENDER:$1|Reviewer}}',
 41+ 'grouppage-reviewer' => '{{ns:project}}:Reviewers',
 42+);
Index: trunk/extensions/Reviews/Reviews.settings.php
@@ -0,0 +1,76 @@
 2+<?php
 3+
 4+/**
 5+ * File defining the settings for the Reviews extension.
 6+ * More info can be found at https://www.mediawiki.org/wiki/Extension:Reviews#Settings
 7+ *
 8+ * NOTICE:
 9+ * Changing one of these settings can be done by assigning to $egReviewsSettings,
 10+ * AFTER the inclusion of the extension itself.
 11+ *
 12+ * @since 0.1
 13+ *
 14+ * @file Reviews.settings.php
 15+ * @ingroup Reviews
 16+ *
 17+ * @licence GNU GPL v3+
 18+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 19+ */
 20+class ReviewsSettings {
 21+
 22+ /**
 23+ * Returns the default values for the settings.
 24+ * setting name (string) => setting value (mixed)
 25+ *
 26+ * @since 0.1
 27+ *
 28+ * @return array
 29+ */
 30+ protected static function getDefaultSettings() {
 31+ return array(
 32+ );
 33+ }
 34+
 35+ /**
 36+ * Retruns an array with all settings after making sure they are
 37+ * initialized (ie set settings have been merged with the defaults).
 38+ * setting name (string) => setting value (mixed)
 39+ *
 40+ * @since 0.1
 41+ *
 42+ * @return array
 43+ */
 44+ public static function getSettings() {
 45+ static $settings = false;
 46+
 47+ if ( $settings === false ) {
 48+ $settings = array_merge(
 49+ self::getDefaultSettings(),
 50+ $GLOBALS['egReviewsSettings']
 51+ );
 52+ }
 53+
 54+ return $settings;
 55+ }
 56+
 57+ /**
 58+ * Gets the value of the specified setting.
 59+ *
 60+ * @since 0.1
 61+ *
 62+ * @param string $settingName
 63+ *
 64+ * @throws MWException
 65+ * @return mixed
 66+ */
 67+ public static function get( $settingName ) {
 68+ $settings = self::getSettings();
 69+
 70+ if ( !array_key_exists( $settingName, $settings ) ) {
 71+ throw new MWException( 'Attempt to get non-existing setting "' . $settingName . '"' );
 72+ }
 73+
 74+ return $settings[$settingName];
 75+ }
 76+
 77+}
Index: trunk/extensions/Reviews/Reviews.php
@@ -0,0 +1,97 @@
 2+<?php
 3+
 4+/**
 5+ * Initialization file for the Reviews extension.
 6+ *
 7+ * Documentation: https://www.mediawiki.org/wiki/Extension:Reviews
 8+ * Support https://www.mediawiki.org/wiki/Extension_talk:Reviews
 9+ * Source code: http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/Reviews
 10+ *
 11+ * @file Reviews.php
 12+ * @ingroup Reviews
 13+ *
 14+ * @licence GNU GPL v3+
 15+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 16+ */
 17+
 18+/**
 19+ * This documentation group collects source code files belonging to Reviews.
 20+ *
 21+ * @defgroup Reviews Reviews
 22+ */
 23+
 24+if ( !defined( 'MEDIAWIKI' ) ) {
 25+ die( 'Not an entry point.' );
 26+}
 27+
 28+if ( version_compare( $wgVersion, '1.18c', '<' ) ) { // Needs to be 1.18c because version_compare() works in confusing ways
 29+ die( '<b>Error:</b> Reviews requires MediaWiki 1.18 or above.' );
 30+}
 31+
 32+define( 'REVIEWS_VERSION', '0.2 alpha' );
 33+
 34+$wgExtensionCredits['other'][] = array(
 35+ 'path' => __FILE__,
 36+ 'name' => 'Reviews',
 37+ 'version' => REVIEWS_VERSION,
 38+ 'author' => array(
 39+ '[http://www.mediawiki.org/wiki/User:Jeroen_De_Dauw Jeroen De Dauw]',
 40+ ),
 41+ 'url' => 'http://www.mediawiki.org/wiki/Extension:Reviews',
 42+ 'descriptionmsg' => 'reviews-desc'
 43+);
 44+
 45+// i18n
 46+$wgExtensionMessagesFiles['Reviews'] = dirname( __FILE__ ) . '/Reviews.i18n.php';
 47+$wgExtensionMessagesFiles['ReviewsAlias'] = dirname( __FILE__ ) . '/Reviews.alias.php';
 48+
 49+// Autoloading
 50+$wgAutoloadClasses['ReviewsHooks'] = dirname( __FILE__ ) . '/Reviews.hooks.php';
 51+$wgAutoloadClasses['ReviewsSettings'] = dirname( __FILE__ ) . '/Reviews.settings.php';
 52+
 53+
 54+// Special pages
 55+$wgSpecialPages['Reviews'] = 'SpecialReviews';
 56+$wgSpecialPages['MyReviews'] = 'SpecialMyReviews';
 57+
 58+$wgSpecialPageGroups['Reviews'] = 'reviews';
 59+$wgSpecialPageGroups['MyReviews'] = 'reviews';
 60+
 61+// API
 62+
 63+// Hooks
 64+$wgHooks['LoadExtensionSchemaUpdates'][] = 'ReviewsHooks::onSchemaUpdate';
 65+$wgHooks['UnitTestsList'][] = 'ReviewsHooks::registerUnitTests';
 66+$wgHooks['PersonalUrls'][] = 'ReviewsHooks::onPersonalUrls';
 67+$wgHooks['GetPreferences'][] = 'ReviewsHooks::onGetPreferences';
 68+
 69+// Rights
 70+$wgAvailableRights[] = 'reviewsadmin';
 71+$wgAvailableRights[] = 'reviewer';
 72+
 73+# Users that can manage the reviews.
 74+$wgGroupPermissions['*' ]['reviewsadmin'] = false;
 75+//$wgGroupPermissions['user' ]['reviewsadmin'] = false;
 76+//$wgGroupPermissions['autoconfirmed']['reviewsadmin'] = false;
 77+//$wgGroupPermissions['bot' ]['reviewsadmin'] = false;
 78+$wgGroupPermissions['sysop' ]['reviewsadmin'] = true;
 79+$wgGroupPermissions['reviewsadmin' ]['reviewsadmin'] = true;
 80+
 81+# Users that can post reviews.
 82+$wgGroupPermissions['*' ]['reviewer'] = false;
 83+$wgGroupPermissions['user' ]['reviewer'] = true;
 84+//$wgGroupPermissions['autoconfirmed']['reviewer'] = true;
 85+//$wgGroupPermissions['bot' ]['reviewer'] = false;
 86+$wgGroupPermissions['sysop' ]['reviewer'] = true;
 87+$wgGroupPermissions['reviewer']['reviewer'] = true;
 88+
 89+
 90+// Resource loader modules
 91+$moduleTemplate = array(
 92+ 'localBasePath' => dirname( __FILE__ ) . '/resources',
 93+ 'remoteExtPath' => 'Reviews/resources'
 94+);
 95+
 96+unset( $moduleTemplate );
 97+
 98+$egReviewsSettings = array();
Index: trunk/extensions/Reviews/Reviews.hooks.php
@@ -0,0 +1,106 @@
 2+<?php
 3+
 4+/**
 5+ * Static class for hooks handled by the Reviews extension.
 6+ *
 7+ * @since 0.1
 8+ *
 9+ * @file Reviews.hooks.php
 10+ * @ingroup Reviews
 11+ *
 12+ * @licence GNU GPL v3+
 13+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 14+ */
 15+final class ReviewsHooks {
 16+
 17+ /**
 18+ * Schema update to set up the needed database tables.
 19+ *
 20+ * @since 0.1
 21+ *
 22+ * @param DatabaseUpdater $updater
 23+ *
 24+ * @return true
 25+ */
 26+ public static function onSchemaUpdate( /* DatabaseUpdater */ $updater = null ) {
 27+
 28+ return true;
 29+ }
 30+
 31+ /**
 32+ * Hook to add PHPUnit test cases.
 33+ *
 34+ * @since 0.1
 35+ *
 36+ * @param array $files
 37+ *
 38+ * @return true
 39+ */
 40+ public static function registerUnitTests( array &$files ) {
 41+ $testDir = dirname( __FILE__ ) . '/test/';
 42+
 43+ //$files[] = $testDir . 'ContestValidationTests.php';
 44+
 45+ return true;
 46+ }
 47+
 48+
 49+ /**
 50+ * Called after the personal URLs have been set up, before they are shown.
 51+ * @see https://www.mediawiki.org/wiki/Manual:Hooks/PersonalUrls
 52+ *
 53+ * @since 0.1
 54+ *
 55+ * @param array $personal_urls
 56+ * @param Title $title
 57+ *
 58+ * @return true
 59+ */
 60+ public static function onPersonalUrls( array &$personal_urls, Title &$title ) {
 61+ if ( ReviewsSettings::get( 'enableTopLink' ) ) {
 62+ global $wgUser;
 63+
 64+ // Find the watchlist item and replace it by the my reviews link and itself.
 65+ if ( $wgUser->isLoggedIn() && $wgUser->getOption( 'reviews_showtoplink' ) ) {
 66+ $keys = array_keys( $personal_urls );
 67+ $watchListLocation = array_search( 'watchlist', $keys );
 68+ $watchListItem = $personal_urls[$keys[$watchListLocation]];
 69+
 70+ $url = SpecialPage::getTitleFor( 'MyReviews' )->getLinkUrl();
 71+ $myReviews = array(
 72+ 'text' => wfMsg( 'reviews-toplink' ),
 73+ 'href' => $url,
 74+ 'active' => ( $url == $title->getLinkUrl() )
 75+ );
 76+
 77+ array_splice( $personal_urls, $watchListLocation, 1, array( $myReviews, $watchListItem ) );
 78+ }
 79+ }
 80+
 81+ return true;
 82+ }
 83+
 84+ /**
 85+ * Adds the preferences of Reviews to the list of available ones.
 86+ * @see https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences
 87+ *
 88+ * @since 0.1
 89+ *
 90+ * @param User $user
 91+ * @param array $preferences
 92+ *
 93+ * @return true
 94+ */
 95+ public static function onGetPreferences( User $user, array &$preferences ) {
 96+ if ( ReviewsSettings::get( 'enableTopLink' ) ) {
 97+ $preferences['reviews_showtoplink'] = array(
 98+ 'type' => 'toggle',
 99+ 'label-message' => 'reviews-prefs-showtoplink',
 100+ 'section' => 'reviews',
 101+ );
 102+ }
 103+
 104+ return true;
 105+ }
 106+
 107+}
Index: trunk/extensions/Reviews/README
@@ -0,0 +1,29 @@
 2+These is the readme file for the Reviews extension.
 3+
 4+Extension page on mediawiki.org: https://www.mediawiki.org/wiki/Extension:Reviews
 5+Latest version of the readme file: http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/Reviews/README?view=co
 6+
 7+== About ==
 8+
 9+Reviews is a MediaWiki extension.
 10+
 11+=== Feature overview ===
 12+
 13+
 14+
 15+== Credits to other projects ==
 16+
 17+=== jQuery ===
 18+
 19+This extension uses code from the jQuery library.
 20+jQuery is dual licensed under the MIT [0] and GPL [1] licenses.
 21+
 22+=== jQuery UI ===
 23+
 24+This extension uses code from the jQuery UI library.
 25+jQuery is dual licensed under the MIT [0] and GPL [1] licenses.
 26+
 27+
 28+
 29+[0] http://www.opensource.org/licenses/mit-license.php
 30+[1] http://www.opensource.org/licenses/gpl-license.php

Status & tagging log