includes/api/ApiQuery.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 7, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   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 ('ApiBase.php');
  29 }
  30
  31 /**
  32  * This is the main query class. It behaves similar to ApiMain: based on the parameters given,
  33  * it will create a list of titles to work on (an instance of the ApiPageSet object)
  34  * instantiate and execute various property/list/meta modules,
  35  * and assemble all resulting data into a single ApiResult object.
  36  *
  37  * In the generator mode, a generator will be first executed to populate a second ApiPageSet object,
  38  * and that object will be used for all subsequent modules.
  39  *
  40  * @addtogroup API
  41  */
  42 class ApiQuery extends ApiBase {
  43
  44         private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames;
  45         private $mPageSet;
  46         private $params, $redirect;
  47
  48         private $mQueryPropModules = array (
  49                 'info' => 'ApiQueryInfo',
  50                 'revisions' => 'ApiQueryRevisions',
  51                 'links' => 'ApiQueryLinks',
  52                 'langlinks' => 'ApiQueryLangLinks',
  53                 'images' => 'ApiQueryImages',
  54                 'templates' => 'ApiQueryLinks',
  55                 'categories' => 'ApiQueryCategories',
  56                 'extlinks' => 'ApiQueryExternalLinks',
  57         );
  58         //      'categories' => 'ApiQueryCategories',
  59         //      'imageinfo' => 'ApiQueryImageinfo',
  60         //      'templates' => 'ApiQueryTemplates',
  61
  62         private $mQueryListModules = array (
  63                 'allpages' => 'ApiQueryAllpages',
  64                 'logevents' => 'ApiQueryLogEvents',
  65                 'watchlist' => 'ApiQueryWatchlist',
  66                 'recentchanges' => 'ApiQueryRecentChanges',
  67                 'backlinks' => 'ApiQueryBacklinks',
  68                 'embeddedin' => 'ApiQueryBacklinks',
  69                 'imageusage' => 'ApiQueryBacklinks',
  70                 'usercontribs' => 'ApiQueryContributions'
  71         );
  72         //      'categorymembers' => 'ApiQueryCategorymembers',
  73         //      'recentchanges' => 'ApiQueryRecentchanges',
  74         //      'users' => 'ApiQueryUsers',
  75         //      'watchlist' => 'ApiQueryWatchlist',
  76
  77         private $mQueryMetaModules = array (
  78                 'siteinfo' => 'ApiQuerySiteinfo'
  79         );
  80         //      'userinfo' => 'ApiQueryUserinfo',
  81
  82         private $mSlaveDB = null;
  83         private $mNamedDB = array();
  84
  85         public function __construct($main, $action) {
  86                 parent :: __construct($main, $action);
  87
  88                 // Allow custom modules to be added in LocalSettings.php
  89                 global $wgApiQueryPropModules, $wgApiQueryListModules, $wgApiQueryMetaModules;
  90                 self :: appendUserModules($this->mQueryPropModules, $wgApiQueryPropModules);
  91                 self :: appendUserModules($this->mQueryListModules, $wgApiQueryListModules);
  92                 self :: appendUserModules($this->mQueryMetaModules, $wgApiQueryMetaModules);
  93
  94                 $this->mPropModuleNames = array_keys($this->mQueryPropModules);
  95                 $this->mListModuleNames = array_keys($this->mQueryListModules);
  96                 $this->mMetaModuleNames = array_keys($this->mQueryMetaModules);
  97
  98                 // Allow the entire list of modules at first,
  99                 // but during module instantiation check if it can be used as a generator.
 100                 $this->mAllowedGenerators = array_merge($this->mListModuleNames, $this->mPropModuleNames);
 101         }
 102
 103         /**
 104          * Helper function to append any add-in modules to the list
 105          */
 106         private static function appendUserModules(&$modules, $newModules) {
 107                 if (is_array( $newModules )) {
 108                         foreach ( $newModules as $moduleName => $moduleClass) {
 109                                 $modules[$moduleName] = $moduleClass;
 110                         }
 111                 }
 112         }
 113
 114         /**
 115          * Gets a default slave database connection object
 116          */
 117         public function getDB() {
 118                 if (!isset ($this->mSlaveDB)) {
 119                         $this->profileDBIn();
 120                         $this->mSlaveDB = wfGetDB(DB_SLAVE);
 121                         $this->profileDBOut();
 122                 }
 123                 return $this->mSlaveDB;
 124         }
 125
 126         /**
 127          * Get the query database connection with the given name.
 128          * If no such connection has been requested before, it will be created.
 129          * Subsequent calls with the same $name will return the same connection
 130          * as the first, regardless of $db or $groups new values.
 131          */
 132         public function getNamedDB($name, $db, $groups) {
 133                 if (!array_key_exists($name, $this->mNamedDB)) {
 134                         $this->profileDBIn();
 135                         $this->mNamedDB[$name] = wfGetDB($db, $groups);
 136                         $this->profileDBOut();
 137                 }
 138                 return $this->mNamedDB[$name];
 139         }
 140
 141         /**
 142          * Gets the set of pages the user has requested (or generated)
 143          */
 144         public function getPageSet() {
 145                 return $this->mPageSet;
 146         }
 147
 148         /**
 149          * Query execution happens in the following steps:
 150          * #1 Create a PageSet object with any pages requested by the user
 151          * #2 If using generator, execute it to get a new PageSet object
 152          * #3 Instantiate all requested modules.
 153          *    This way the PageSet object will know what shared data is required,
 154          *    and minimize DB calls.
 155          * #4 Output all normalization and redirect resolution information
 156          * #5 Execute all requested modules
 157          */
 158         public function execute() {
 159
 160                 $this->params = $this->extractRequestParams();
 161                 $this->redirects = $this->params['redirects'];
 162
 163                 //
 164                 // Create PageSet
 165                 //
 166                 $this->mPageSet = new ApiPageSet($this, $this->redirects);
 167
 168                 //
 169                 // Instantiate requested modules
 170                 //
 171                 $modules = array ();
 172                 $this->InstantiateModules($modules, 'prop', $this->mQueryPropModules);
 173                 $this->InstantiateModules($modules, 'list', $this->mQueryListModules);
 174                 $this->InstantiateModules($modules, 'meta', $this->mQueryMetaModules);
 175
 176                 //
 177                 // If given, execute generator to substitute user supplied data with generated data.
 178                 //
 179                 if (isset ($this->params['generator'])) {
 180                         $this->executeGeneratorModule($this->params['generator'], $modules);
 181                 } else {
 182                         // Append custom fields and populate page/revision information
 183                         $this->addCustomFldsToPageSet($modules, $this->mPageSet);
 184                         $this->mPageSet->execute();
 185                 }
 186
 187                 //
 188                 // Record page information (title, namespace, if exists, etc)
 189                 //
 190                 $this->outputGeneralPageInfo();
 191
 192                 //
 193                 // Execute all requested modules.
 194                 //
 195                 foreach ($modules as $module) {
 196                         $module->profileIn();
 197                         $module->execute();
 198                         $module->profileOut();
 199                 }
 200         }
 201
 202         /**
 203          * Query modules may optimize data requests through the $this->getPageSet() object
 204          * by adding extra fields from the page table.
 205          * This function will gather all the extra request fields from the modules.
 206          */
 207         private function addCustomFldsToPageSet($modules, $pageSet) {
 208                 // Query all requested modules.
 209                 foreach ($modules as $module) {
 210                         $module->requestExtraData($pageSet);
 211                 }
 212         }
 213
 214         /**
 215          * Create instances of all modules requested by the client
 216          */
 217         private function InstantiateModules(&$modules, $param, $moduleList) {
 218                 $list = $this->params[$param];
 219                 if (isset ($list))
 220                         foreach ($list as $moduleName)
 221                                 $modules[] = new $moduleList[$moduleName] ($this, $moduleName);
 222         }
 223
 224         /**
 225          * Appends an element for each page in the current pageSet with the most general
 226          * information (id, title), plus any title normalizations and missing title/pageids/revids.
 227          */
 228         private function outputGeneralPageInfo() {
 229
 230                 $pageSet = $this->getPageSet();
 231                 $result = $this->getResult();
 232
 233                 // Title normalizations
 234                 $normValues = array ();
 235                 foreach ($pageSet->getNormalizedTitles() as $rawTitleStr => $titleStr) {
 236                         $normValues[] = array (
 237                                 'from' => $rawTitleStr,
 238                                 'to' => $titleStr
 239                         );
 240                 }
 241
 242                 if (!empty ($normValues)) {
 243                         $result->setIndexedTagName($normValues, 'n');
 244                         $result->addValue('query', 'normalized', $normValues);
 245                 }
 246
 247                 // Show redirect information
 248                 $redirValues = array ();
 249                 foreach ($pageSet->getRedirectTitles() as $titleStrFrom => $titleStrTo) {
 250                         $redirValues[] = array (
 251                                 'from' => $titleStrFrom,
 252                                 'to' => $titleStrTo
 253                         );
 254                 }
 255
 256                 if (!empty ($redirValues)) {
 257                         $result->setIndexedTagName($redirValues, 'r');
 258                         $result->addValue('query', 'redirects', $redirValues);
 259                 }
 260
 261                 //
 262                 // Missing revision elements
 263                 //
 264                 $missingRevIDs = $pageSet->getMissingRevisionIDs();
 265                 if (!empty ($missingRevIDs)) {
 266                         $revids = array ();
 267                         foreach ($missingRevIDs as $revid) {
 268                                 $revids[$revid] = array (
 269                                         'revid' => $revid
 270                                 );
 271                         }
 272                         $result->setIndexedTagName($revids, 'rev');
 273                         $result->addValue('query', 'badrevids', $revids);
 274                 }
 275
 276                 //
 277                 // Page elements
 278                 //
 279                 $pages = array ();
 280
 281                 // Report any missing titles
 282                 $fakepageid = -1;
 283                 foreach ($pageSet->getMissingTitles() as $title) {
 284                         $vals = array();
 285                         ApiQueryBase :: addTitleInfo($vals, $title, true);
 286                         $vals['missing'] = '';
 287                         $pages[$fakepageid--] = $vals;
 288                 }
 289
 290                 // Report any missing page ids
 291                 foreach ($pageSet->getMissingPageIDs() as $pageid) {
 292                         $pages[$pageid] = array (
 293                                 'pageid' => $pageid,
 294                                 'missing' => ''
 295                         );
 296                 }
 297
 298                 // Output general page information for found titles
 299                 foreach ($pageSet->getGoodTitles() as $pageid => $title) {
 300                         $vals = array();
 301                         $vals['pageid'] = $pageid;
 302                         ApiQueryBase :: addTitleInfo($vals, $title, true);
 303                         $pages[$pageid] = $vals;
 304                 }
 305
 306                 if (!empty ($pages)) {
 307
 308                         if ($this->params['indexpageids']) {
 309                                 $pageIDs = array_keys($pages);
 310                                 // json treats all map keys as strings - converting to match
 311                                 $pageIDs = array_map('strval', $pageIDs);
 312                                 $result->setIndexedTagName($pageIDs, 'id');
 313                                 $result->addValue('query', 'pageids', $pageIDs);
 314                         }
 315
 316                         $result->setIndexedTagName($pages, 'page');
 317                         $result->addValue('query', 'pages', $pages);
 318                 }
 319         }
 320
 321         /**
 322          * For generator mode, execute generator, and use its output as new pageSet
 323          */
 324         protected function executeGeneratorModule($generatorName, $modules) {
 325
 326                 // Find class that implements requested generator
 327                 if (isset ($this->mQueryListModules[$generatorName])) {
 328                         $className = $this->mQueryListModules[$generatorName];
 329                 } elseif (isset ($this->mQueryPropModules[$generatorName])) {
 330                         $className = $this->mQueryPropModules[$generatorName];
 331                 } else {
 332                         ApiBase :: dieDebug(__METHOD__, "Unknown generator=$generatorName");
 333                 }
 334
 335                 // Generator results
 336                 $resultPageSet = new ApiPageSet($this, $this->redirects);
 337
 338                 // Create and execute the generator
 339                 $generator = new $className ($this, $generatorName);
 340                 if (!$generator instanceof ApiQueryGeneratorBase)
 341                         $this->dieUsage("Module $generatorName cannot be used as a generator", "badgenerator");
 342
 343                 $generator->setGeneratorMode();
 344
 345                 // Add any additional fields modules may need
 346                 $generator->requestExtraData($this->mPageSet);
 347                 $this->addCustomFldsToPageSet($modules, $resultPageSet);
 348
 349                 // Populate page information with the original user input
 350                 $this->mPageSet->execute();
 351
 352                 // populate resultPageSet with the generator output
 353                 $generator->profileIn();
 354                 $generator->executeGenerator($resultPageSet);
 355                 $resultPageSet->finishPageSetGeneration();
 356                 $generator->profileOut();
 357
 358                 // Swap the resulting pageset back in
 359                 $this->mPageSet = $resultPageSet;
 360         }
 361
 362         /**
 363          * Returns the list of allowed parameters for this module.
 364          * Qurey module also lists all ApiPageSet parameters as its own.
 365          */
 366         protected function getAllowedParams() {
 367                 return array (
 368                         'prop' => array (
 369                                 ApiBase :: PARAM_ISMULTI => true,
 370                                 ApiBase :: PARAM_TYPE => $this->mPropModuleNames
 371                         ),
 372                         'list' => array (
 373                                 ApiBase :: PARAM_ISMULTI => true,
 374                                 ApiBase :: PARAM_TYPE => $this->mListModuleNames
 375                         ),
 376                         'meta' => array (
 377                                 ApiBase :: PARAM_ISMULTI => true,
 378                                 ApiBase :: PARAM_TYPE => $this->mMetaModuleNames
 379                         ),
 380                         'generator' => array (
 381                                 ApiBase :: PARAM_TYPE => $this->mAllowedGenerators
 382                         ),
 383                         'redirects' => false,
 384                         'indexpageids' => false,
 385                 );
 386         }
 387
 388         /**
 389          * Override the parent to generate help messages for all available query modules.
 390          */
 391         public function makeHelpMsg() {
 392
 393                 $msg = '';
 394
 395                 // Make sure the internal object is empty
 396                 // (just in case a sub-module decides to optimize during instantiation)
 397                 $this->mPageSet = null;
 398                 $this->mAllowedGenerators = array();    // Will be repopulated
 399
 400                 $astriks = str_repeat('--- ', 8);
 401                 $msg .= "\n$astriks Query: Prop  $astriks\n\n";
 402                 $msg .= $this->makeHelpMsgHelper($this->mQueryPropModules, 'prop');
 403                 $msg .= "\n$astriks Query: List  $astriks\n\n";
 404                 $msg .= $this->makeHelpMsgHelper($this->mQueryListModules, 'list');
 405                 $msg .= "\n$astriks Query: Meta  $astriks\n\n";
 406                 $msg .= $this->makeHelpMsgHelper($this->mQueryMetaModules, 'meta');
 407
 408                 // Perform the base call last because the $this->mAllowedGenerators
 409                 // will be updated inside makeHelpMsgHelper()
 410                 // Use parent to make default message for the query module
 411                 $msg = parent :: makeHelpMsg() . $msg;
 412
 413                 return $msg;
 414         }
 415
 416         /**
 417          * For all modules in $moduleList, generate help messages and join them together
 418          */
 419         private function makeHelpMsgHelper($moduleList, $paramName) {
 420
 421                 $moduleDscriptions = array ();
 422
 423                 foreach ($moduleList as $moduleName => $moduleClass) {
 424                         $module = new $moduleClass ($this, $moduleName, null);
 425
 426                         $msg = ApiMain::makeHelpMsgHeader($module, $paramName);
 427                         $msg2 = $module->makeHelpMsg();
 428                         if ($msg2 !== false)
 429                                 $msg .= $msg2;
 430                         if ($module instanceof ApiQueryGeneratorBase) {
 431                                 $this->mAllowedGenerators[] = $moduleName;
 432                                 $msg .= "Generator:\n  This module may be used as a generator\n";
 433                         }
 434                         $moduleDscriptions[] = $msg;
 435                 }
 436
 437                 return implode("\n", $moduleDscriptions);
 438         }
 439
 440         /**
 441          * Override to add extra parameters from PageSet
 442          */
 443         public function makeHelpMsgParameters() {
 444                 $psModule = new ApiPageSet($this);
 445                 return $psModule->makeHelpMsgParameters() . parent :: makeHelpMsgParameters();
 446         }
 447
 448         protected function getParamDescription() {
 449                 return array (
 450                         'prop' => 'Which properties to get for the titles/revisions/pageids',
 451                         'list' => 'Which lists to get',
 452                         'meta' => 'Which meta data to get about the site',
 453                         'generator' => 'Use the output of a list as the input for other prop/list/meta items',
 454                         'redirects' => 'Automatically resolve redirects',
 455                         'indexpageids' => 'Include an additional pageids section listing all returned page IDs.'
 456                 );
 457         }
 458
 459         protected function getDescription() {
 460                 return array (
 461                         'Query API module allows applications to get needed pieces of data from the MediaWiki databases,',
 462                         'and is loosely based on the Query API interface currently available on all MediaWiki servers.',
 463                         'All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.'
 464                 );
 465         }
 466
 467         protected function getExamples() {
 468                 return array (
 469                         'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment'
 470                 );
 471         }
 472
 473         public function getVersion() {
 474                 $psModule = new ApiPageSet($this);
 475                 $vers = array ();
 476                 $vers[] = __CLASS__ . ': $Id$';
 477                 $vers[] = $psModule->getVersion();
 478                 return $vers;
 479         }
 480 }
 481 ?>