includes/api/ApiQueryWatchlistRaw.php

   1 <?php
   2
   3 /*
   4  * Created on Oct 4, 2008
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( 'ApiQueryBase.php' );
  29 }
  30
  31 /**
  32  * This query action allows clients to retrieve a list of pages
  33  * on the logged-in user's watchlist.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {
  38
  39         public function __construct( $query, $moduleName ) {
  40                 parent :: __construct( $query, $moduleName, 'wr' );
  41         }
  42
  43         public function execute() {
  44                 $this->run();
  45         }
  46
  47         public function executeGenerator( $resultPageSet ) {
  48                 $this->run( $resultPageSet );
  49         }
  50
  51         private function run( $resultPageSet = null ) {
  52                 global $wgUser;
  53
  54                 $this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' );
  55
  56                 if ( !$wgUser->isLoggedIn() )
  57                         $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
  58                 $params = $this->extractRequestParams();
  59                 $prop = array_flip( (array)$params['prop'] );
  60                 $show = array_flip( (array)$params['show'] );
  61                 if ( isset( $show['changed'] ) && isset( $show['!changed'] ) )
  62                         $this->dieUsageMsg( array( 'show' ) );
  63
  64                 $this->addTables( 'watchlist' );
  65                 $this->addFields( array( 'wl_namespace', 'wl_title' ) );
  66                 $this->addFieldsIf( 'wl_notificationtimestamp', isset( $prop['changed'] ) );
  67                 $this->addWhereFld( 'wl_user', $wgUser->getId() );
  68                 $this->addWhereFld( 'wl_namespace', $params['namespace'] );
  69                 $this->addWhereIf( 'wl_notificationtimestamp IS NOT NULL', isset( $show['changed'] ) );
  70                 $this->addWhereIf( 'wl_notificationtimestamp IS NULL', isset( $show['!changed'] ) );
  71
  72                 if ( isset( $params['continue'] ) )
  73                 {
  74                         $cont = explode( '|', $params['continue'] );
  75                         if ( count( $cont ) != 2 )
  76                                 $this->dieUsage( "Invalid continue param. You should pass the " .
  77                                         "original value returned by the previous query", "_badcontinue" );
  78                         $ns = intval( $cont[0] );
  79                         $title = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
  80                         $this->addWhere( "wl_namespace > '$ns' OR " .
  81                                         "(wl_namespace = '$ns' AND " .
  82                                         "wl_title >= '$title')" );
  83                 }
  84
  85                 // Don't ORDER BY wl_namespace if it's constant in the WHERE clause
  86                 if ( count( $params['namespace'] ) == 1 )
  87                         $this->addOption( 'ORDER BY', 'wl_title' );
  88                 else
  89                         $this->addOption( 'ORDER BY', 'wl_namespace, wl_title' );
  90                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  91                 $res = $this->select( __METHOD__ );
  92
  93                 $db = $this->getDB();
  94                 $titles = array();
  95                 $count = 0;
  96                 while ( $row = $db->fetchObject( $res ) )
  97                 {
  98                         if ( ++$count > $params['limit'] )
  99                         {
 100                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 101                                 $this->setContinueEnumParameter( 'continue', $row->wl_namespace . '|' .
 102                                                                         $this->keyToTitle( $row->wl_title ) );
 103                                 break;
 104                         }
 105                         $t = Title::makeTitle( $row->wl_namespace, $row->wl_title );
 106
 107                         if ( is_null( $resultPageSet ) )
 108                         {
 109                                 $vals = array();
 110                                 ApiQueryBase::addTitleInfo( $vals, $t );
 111                                 if ( isset( $prop['changed'] ) && !is_null( $row->wl_notificationtimestamp ) )
 112                                         $vals['changed'] = wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp );
 113                                 $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals );
 114                                 if ( !$fit )
 115                                 {
 116                                         $this->setContinueEnumParameter( 'continue', $row->wl_namespace . '|' .
 117                                                                         $this->keyToTitle( $row->wl_title ) );
 118                                         break;
 119                                 }
 120                         }
 121                         else
 122                                 $titles[] = $t;
 123                 }
 124                 if ( is_null( $resultPageSet ) )
 125                         $this->getResult()->setIndexedTagName_internal( $this->getModuleName(), 'wr' );
 126                 else
 127                         $resultPageSet->populateFromTitles( $titles );
 128         }
 129
 130         public function getAllowedParams() {
 131                 return array (
 132                         'continue' => null,
 133                         'namespace' => array (
 134                                 ApiBase :: PARAM_ISMULTI => true,
 135                                 ApiBase :: PARAM_TYPE => 'namespace'
 136                         ),
 137                         'limit' => array (
 138                                 ApiBase :: PARAM_DFLT => 10,
 139                                 ApiBase :: PARAM_TYPE => 'limit',
 140                                 ApiBase :: PARAM_MIN => 1,
 141                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 142                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 143                         ),
 144                         'prop' => array (
 145                                 ApiBase :: PARAM_ISMULTI => true,
 146                                 ApiBase :: PARAM_TYPE => array (
 147                                         'changed',
 148                                 )
 149                         ),
 150                         'show' => array (
 151                                 ApiBase :: PARAM_ISMULTI => true,
 152                                 ApiBase :: PARAM_TYPE => array (
 153                                         'changed',
 154                                         '!changed',
 155                                 )
 156                         )
 157                 );
 158         }
 159
 160         public function getParamDescription() {
 161                 return array (
 162                         'continue' => 'When more results are available, use this to continue',
 163                         'namespace' => 'Only list pages in the given namespace(s).',
 164                         'limit' => 'How many total results to return per request.',
 165                         'prop' => 'Which additional properties to get (non-generator mode only).',
 166                         'show' => 'Only list items that meet these criteria.',
 167                 );
 168         }
 169
 170         public function getDescription() {
 171                 return "Get all pages on the logged in user's watchlist";
 172         }
 173
 174         public function getPossibleErrors() {
 175                 return array_merge( parent::getPossibleErrors(), array(
 176                         array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
 177                         array( 'show' ),
 178                 ) );
 179         }
 180
 181         protected function getExamples() {
 182                 return array (
 183                         'api.php?action=query&list=watchlistraw',
 184                         'api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=revisions',
 185                 );
 186         }
 187
 188         public function getVersion() {
 189                 return __CLASS__ . ': $Id$';
 190         }
 191 }