includes/api/ApiQueryRandom.php

   1 <?php
   2
   3 /*
   4  * Created on Monday, January 28, 2008
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2008 Brent Garber
   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  * Query module to get list of random pages
  33  *
  34  * @addtogroup API
  35  */
  36
  37  class ApiQueryRandom extends ApiQueryGeneratorBase {
  38
  39         public function __construct($query, $moduleName) {
  40                 parent :: __construct($query, $moduleName, 'rn');
  41         }
  42
  43         public function execute() {
  44                 $this->run();
  45         }
  46
  47         public function executeGenerator($resultPageSet) {
  48                 $this->run($resultPageSet);
  49         }
  50
  51         public function run($resultPageSet = null) {
  52                 $params = $this->extractRequestParams();
  53                 $result = $this->getResult();
  54                 $randstr = wfRandom();
  55                 $data = array();
  56
  57                 $this->addTables('page');
  58                 $this->addOption('LIMIT', $params['limit']);
  59                 $this->addWhereFld('page_namespace', $params['namespace']);
  60                 $this->addWhereRange('page_random', 'newer', $randstr, null);
  61                 $this->addWhere(array('page_is_redirect' => 0));
  62                 $this->addOption('USE INDEX', 'page_random');
  63                 if(is_null($resultPageSet))
  64                         $this->addFields(array('page_id', 'page_title', 'page_namespace'));
  65                 else
  66                         $this->addFields($resultPageSet->getPageTableFields());
  67
  68                 $db = $this->getDB();
  69                 $res = $this->select(__METHOD__);
  70                 while($row = $db->fetchObject($res)) {
  71                         if(is_null($resultPageSet))
  72                                 $data[] = $this->extractRowInfo($row);
  73                         else
  74                                 $resultPageSet->processDbRow($row);
  75                 }
  76                 $db->freeResult($res);
  77
  78                 if(is_null($resultPageSet)) {
  79                         $result->setIndexedTagName($data, 'page');
  80                         $result->addValue('query', $this->getModuleName(), $data);
  81                 }
  82         }
  83
  84         private function extractRowInfo($row) {
  85                 $title = Title::makeTitle($row->page_namespace, $row->page_title);
  86                 $vals = array();
  87                 $vals['title'] = $title->getPrefixedText();
  88                 $vals['ns'] = $row->page_namespace;
  89                 $vals['id'] = $row->page_id;
  90                 return $vals;
  91         }
  92
  93         public function getAllowedParams() {
  94                 return array (
  95                         'namespace' => array(
  96                                 ApiBase :: PARAM_TYPE => 'namespace',
  97                                 ApiBase :: PARAM_ISMULTI => true
  98                         ),
  99                         'limit' => array (
 100                                 ApiBase :: PARAM_TYPE => 'limit',
 101                                 ApiBase :: PARAM_DFLT => 1,
 102                                 ApiBase :: PARAM_MIN => 1,
 103                                 ApiBase :: PARAM_MAX => 10,
 104                                 ApiBase :: PARAM_MAX2 => 20
 105                         ),
 106                 );
 107         }
 108
 109         public function getParamDescription() {
 110                 return array (
 111                         'namespace' => 'Return pages in these namespaces only',
 112                         'limit' => 'Limit how many random pages will be returned'
 113                 );
 114         }
 115
 116         public function getDescription() {
 117                 return array(   'Get a set of random pages',
 118                                 'NOTE: When using a namespace filter, this module may return an empty result. In that case, retry the request'
 119                 );
 120         }
 121
 122         protected function getExamples() {
 123                 return 'api.php?action=query&list=random&rnnamespace=0&rnlimit=2';
 124         }
 125
 126         public function getVersion() {
 127                 return __CLASS__ . ': $Id: ApiQueryRandom.php overlordq$';
 128         }
 129 }