]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/api/ApiQueryWatchlistRaw.php
MediaWiki 1.16.0
[autoinstallsdev/mediawiki.git] / includes / api / ApiQueryWatchlistRaw.php
index e9951b42988ab847656325731344bb27986016f4..42d4005b9c5d437e1b364de19e5984f19198bb34 100644 (file)
@@ -23,9 +23,9 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ('ApiQueryBase.php');
+       require_once ( 'ApiQueryBase.php' );
 }
 
 /**
@@ -36,90 +36,95 @@ if (!defined('MEDIAWIKI')) {
  */
 class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {
 
-       public function __construct($query, $moduleName) {
-               parent :: __construct($query, $moduleName, 'wr');
+       public function __construct( $query, $moduleName ) {
+               parent :: __construct( $query, $moduleName, 'wr' );
        }
 
        public function execute() {
                $this->run();
        }
 
-       public function executeGenerator($resultPageSet) {
-               $this->run($resultPageSet);
+       public function executeGenerator( $resultPageSet ) {
+               $this->run( $resultPageSet );
        }
 
-       private function run($resultPageSet = null) {
+       private function run( $resultPageSet = null ) {
                global $wgUser;
 
-               $this->selectNamedDB('watchlist', DB_SLAVE, 'watchlist');
+               $this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' );
 
-               if (!$wgUser->isLoggedIn())
-                       $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');    
+               if ( !$wgUser->isLoggedIn() )
+                       $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
                $params = $this->extractRequestParams();
-               $prop = array_flip((array)$params['prop']);
-               $show = array_flip((array)$params['show']);
-               if(isset($show['changed']) && isset($show['!changed']))
-                       $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
-
-               $this->addTables('watchlist');
-               $this->addFields(array('wl_namespace', 'wl_title'));
-               $this->addFieldsIf('wl_notificationtimestamp', isset($prop['changed']));
-               $this->addWhereFld('wl_user', $wgUser->getId());
-               $this->addWhereFld('wl_namespace', $params['namespace']);
-               $this->addWhereIf('wl_notificationtimestamp IS NOT NULL', isset($show['changed']));
-               $this->addWhereIf('wl_notificationtimestamp IS NULL', isset($show['!changed']));
-               if(isset($params['continue']))
+               $prop = array_flip( (array)$params['prop'] );
+               $show = array_flip( (array)$params['show'] );
+               if ( isset( $show['changed'] ) && isset( $show['!changed'] ) )
+                       $this->dieUsageMsg( array( 'show' ) );
+
+               $this->addTables( 'watchlist' );
+               $this->addFields( array( 'wl_namespace', 'wl_title' ) );
+               $this->addFieldsIf( 'wl_notificationtimestamp', isset( $prop['changed'] ) );
+               $this->addWhereFld( 'wl_user', $wgUser->getId() );
+               $this->addWhereFld( 'wl_namespace', $params['namespace'] );
+               $this->addWhereIf( 'wl_notificationtimestamp IS NOT NULL', isset( $show['changed'] ) );
+               $this->addWhereIf( 'wl_notificationtimestamp IS NULL', isset( $show['!changed'] ) );
+
+               if ( isset( $params['continue'] ) )
                {
-                       $cont = explode('|', $params['continue']);
-                       if(count($cont) != 2)
-                               $this->dieUsage("Invalid continue param. You should pass the " .
-                                       "original value returned by the previous query", "_badcontinue");
-                       $ns = intval($cont[0]);
-                       $title = $this->getDB()->strencode($this->titleToKey($cont[1]));
-                       $this->addWhere("wl_namespace > '$ns' OR ".
-                                       "(wl_namespace = '$ns' AND ".
-                                       "wl_title >= '$title')");
+                       $cont = explode( '|', $params['continue'] );
+                       if ( count( $cont ) != 2 )
+                               $this->dieUsage( "Invalid continue param. You should pass the " .
+                                       "original value returned by the previous query", "_badcontinue" );
+                       $ns = intval( $cont[0] );
+                       $title = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
+                       $this->addWhere( "wl_namespace > '$ns' OR " .
+                                       "(wl_namespace = '$ns' AND " .
+                                       "wl_title >= '$title')" );
                }
+
                // Don't ORDER BY wl_namespace if it's constant in the WHERE clause
-               if(count($params['namespace']) == 1)
-                       $this->addOption('ORDER BY', 'wl_title');
+               if ( count( $params['namespace'] ) == 1 )
+                       $this->addOption( 'ORDER BY', 'wl_title' );
                else
-                       $this->addOption('ORDER BY', 'wl_namespace, wl_title');
-               $this->addOption('LIMIT', $params['limit'] + 1);
-               $res = $this->select(__METHOD__);
+                       $this->addOption( 'ORDER BY', 'wl_namespace, wl_title' );
+               $this->addOption( 'LIMIT', $params['limit'] + 1 );
+               $res = $this->select( __METHOD__ );
                
                $db = $this->getDB();
-               $data = array();
                $titles = array();
                $count = 0;
-               while($row = $db->fetchObject($res))
+               while ( $row = $db->fetchObject( $res ) )
                {
-                       if(++$count > $params['limit'])
+                       if ( ++$count > $params['limit'] )
                        {
                                // We've reached the one extra which shows that there are additional pages to be had. Stop here...
-                               $this->setContinueEnumParameter('continue', $row->wl_namespace . '|' .
-                                                                       $this->keyToTitle($row->wl_title));
+                               $this->setContinueEnumParameter( 'continue', $row->wl_namespace . '|' .
+                                                                       $this->keyToTitle( $row->wl_title ) );
                                break;
                        }
-                       $t = Title::makeTitle($row->wl_namespace, $row->wl_title);
-                       if(is_null($resultPageSet))
+                       $t = Title::makeTitle( $row->wl_namespace, $row->wl_title );
+
+                       if ( is_null( $resultPageSet ) )
                        {
                                $vals = array();
-                               ApiQueryBase::addTitleInfo($vals, $t);
-                               if(isset($prop['changed']) && !is_null($row->wl_notificationtimestamp))
-                                       $vals['changed'] = wfTimestamp(TS_ISO_8601, $row->wl_notificationtimestamp);
-                               $data[] = $vals;
+                               ApiQueryBase::addTitleInfo( $vals, $t );
+                               if ( isset( $prop['changed'] ) && !is_null( $row->wl_notificationtimestamp ) )
+                                       $vals['changed'] = wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp );
+                               $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals );
+                               if ( !$fit )
+                               {
+                                       $this->setContinueEnumParameter( 'continue', $row->wl_namespace . '|' .
+                                                                       $this->keyToTitle( $row->wl_title ) );
+                                       break;
+                               }
                        }
                        else
                                $titles[] = $t;
                }
-               if(is_null($resultPageSet))
-               {
-                       $this->getResult()->setIndexedTagName($data, 'wr');
-                       $this->getResult()->addValue(null, $this->getModuleName(), $data);
-               }
+               if ( is_null( $resultPageSet ) )
+                       $this->getResult()->setIndexedTagName_internal( $this->getModuleName(), 'wr' );
                else
-                       $resultPageSet->populateFromTitles($titles);
+                       $resultPageSet->populateFromTitles( $titles );
        }
 
        public function getAllowedParams() {
@@ -165,6 +170,13 @@ class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {
        public function getDescription() {
                return "Get all pages on the logged in user's watchlist";
        }
+       
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
+                       array( 'show' ),
+               ) );
+       }
 
        protected function getExamples() {
                return array (
@@ -174,6 +186,6 @@ class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryWatchlistRaw.php 41651 2008-10-04 14:30:33Z catrope $';
+               return __CLASS__ . ': $Id: ApiQueryWatchlistRaw.php 69578 2010-07-20 02:46:20Z tstarling $';
        }
-}
+}
\ No newline at end of file