-<?php\r
-\r
-/*\r
- * Created on Monday, January 28, 2008\r
- *\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2008 Brent Garber\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ('ApiQueryBase.php');\r
-}\r
-\r
-/**\r
- * Query module to get list of random pages\r
- * \r
- * @addtogroup API\r
- */\r
- \r
- class ApiQueryRandom extends ApiQueryGeneratorBase {\r
-\r
- public function __construct($query, $moduleName) {\r
- parent :: __construct($query, $moduleName, 'rn');\r
- }\r
- \r
- public function execute() {\r
- $this->run();\r
- }\r
- \r
- public function executeGenerator($resultPageSet) {\r
- $this->run($resultPageSet);\r
- }\r
-\r
- public function run($resultPageSet = null) {\r
- $params = $this->extractRequestParams();\r
- $result = $this->getResult();\r
- $randstr = wfRandom();\r
- $data = array();\r
-\r
- $this->addTables('page');\r
- $this->addOption('LIMIT', $params['limit']);\r
- $this->addWhereFld('page_namespace', $params['namespace']);\r
- $this->addWhereRange('page_random', 'newer', $randstr, null);\r
- $this->addWhere(array('page_is_redirect' => 0));\r
- $this->addOption('USE INDEX', 'page_random');\r
- if(is_null($resultPageSet))\r
- $this->addFields(array('page_id', 'page_title', 'page_namespace'));\r
- else\r
- $this->addFields($resultPageSet->getPageTableFields());\r
-\r
- $db = $this->getDB();\r
- $res = $this->select(__METHOD__);\r
- while($row = $db->fetchObject($res)) {\r
- if(is_null($resultPageSet))\r
- $data[] = $this->extractRowInfo($row);\r
- else\r
- $resultPageSet->processDbRow($row);\r
- }\r
- $db->freeResult($res);\r
-\r
- if(is_null($resultPageSet)) {\r
- $result->setIndexedTagName($data, 'page');\r
- $result->addValue('query', $this->getModuleName(), $data);\r
- } \r
- }\r
-\r
- private function extractRowInfo($row) {\r
- $title = Title::makeTitle($row->page_namespace, $row->page_title);\r
- $vals = array();\r
- $vals['title'] = $title->getPrefixedText();\r
- $vals['ns'] = $row->page_namespace;\r
- $vals['id'] = $row->page_id;\r
- return $vals;\r
- }\r
- \r
- protected function getAllowedParams() {\r
- return array (\r
- 'namespace' => array(\r
- ApiBase :: PARAM_TYPE => 'namespace',\r
- ApiBase :: PARAM_ISMULTI => true\r
- ),\r
- 'limit' => array (\r
- ApiBase :: PARAM_TYPE => 'limit',\r
- ApiBase :: PARAM_DFLT => 1,\r
- ApiBase :: PARAM_MIN => 1,\r
- ApiBase :: PARAM_MAX => 10,\r
- ApiBase :: PARAM_MAX2 => 20\r
- ),\r
- );\r
- }\r
-\r
- protected function getParamDescription() {\r
- return array (\r
- 'namespace' => 'Return pages in these namespaces only',\r
- 'limit' => 'Limit how many random pages will be returned'\r
- );\r
- }\r
-\r
- protected function getDescription() {\r
- return array( 'Get a set of random pages',\r
- 'NOTE: When using a namespace filter, this module may return an empty result. In that case, retry the request'\r
- );\r
- }\r
-\r
- protected function getExamples() {\r
- return 'api.php?action=query&list=random&rnnamespace=0&rnlimit=2';\r
- }\r
-\r
- public function getVersion() {\r
- return __CLASS__ . ': $Id: ApiQueryRandom.php overlordq$';\r
- }\r
-}\r
+<?php
+
+/**
+ *
+ *
+ * Created on Monday, January 28, 2008
+ *
+ * Copyright © 2008 Brent Garber
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+if ( !defined( 'MEDIAWIKI' ) ) {
+ // Eclipse helper - will be ignored in production
+ require_once( 'ApiQueryBase.php' );
+}
+
+/**
+ * Query module to get list of random pages
+ *
+ * @ingroup API
+ */
+
+ class ApiQueryRandom extends ApiQueryGeneratorBase {
+
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'rn' );
+ }
+
+ public function execute() {
+ $this->run();
+ }
+
+ public function executeGenerator( $resultPageSet ) {
+ $this->run( $resultPageSet );
+ }
+
+ protected function prepareQuery( $randstr, $limit, $namespace, &$resultPageSet, $redirect ) {
+ $this->resetQueryParams();
+ $this->addTables( 'page' );
+ $this->addOption( 'LIMIT', $limit );
+ $this->addWhereFld( 'page_namespace', $namespace );
+ $this->addWhereRange( 'page_random', 'newer', $randstr, null );
+ $this->addWhereFld( 'page_is_redirect', $redirect );
+ $this->addOption( 'USE INDEX', 'page_random' );
+ if ( is_null( $resultPageSet ) ) {
+ $this->addFields( array( 'page_id', 'page_title', 'page_namespace' ) );
+ } else {
+ $this->addFields( $resultPageSet->getPageTableFields() );
+ }
+ }
+
+ protected function runQuery( &$resultPageSet ) {
+ $res = $this->select( __METHOD__ );
+ $count = 0;
+ foreach ( $res as $row ) {
+ $count++;
+ if ( is_null( $resultPageSet ) ) {
+ // Prevent duplicates
+ if ( !in_array( $row->page_id, $this->pageIDs ) ) {
+ $fit = $this->getResult()->addValue(
+ array( 'query', $this->getModuleName() ),
+ null, $this->extractRowInfo( $row ) );
+ if ( !$fit ) {
+ // We can't really query-continue a random list.
+ // Return an insanely high value so
+ // $count < $limit is false
+ return 1E9;
+ }
+ $this->pageIDs[] = $row->page_id;
+ }
+ } else {
+ $resultPageSet->processDbRow( $row );
+ }
+ }
+
+ return $count;
+ }
+
+ public function run( $resultPageSet = null ) {
+ $params = $this->extractRequestParams();
+ $result = $this->getResult();
+ $this->pageIDs = array();
+
+ $this->prepareQuery( wfRandom(), $params['limit'], $params['namespace'], $resultPageSet, $params['redirect'] );
+ $count = $this->runQuery( $resultPageSet );
+ if ( $count < $params['limit'] ) {
+ /* We got too few pages, we probably picked a high value
+ * for page_random. We'll just take the lowest ones, see
+ * also the comment in Title::getRandomTitle()
+ */
+ $this->prepareQuery( 0, $params['limit'] - $count, $params['namespace'], $resultPageSet, $params['redirect'] );
+ $this->runQuery( $resultPageSet );
+ }
+
+ if ( is_null( $resultPageSet ) ) {
+ $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
+ }
+ }
+
+ private function extractRowInfo( $row ) {
+ $title = Title::makeTitle( $row->page_namespace, $row->page_title );
+ $vals = array();
+ $vals['id'] = intval( $row->page_id );
+ ApiQueryBase::addTitleInfo( $vals, $title );
+ return $vals;
+ }
+
+ public function getCacheMode( $params ) {
+ return 'public';
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'namespace' => array(
+ ApiBase::PARAM_TYPE => 'namespace',
+ ApiBase::PARAM_ISMULTI => true
+ ),
+ 'limit' => array(
+ ApiBase::PARAM_TYPE => 'limit',
+ ApiBase::PARAM_DFLT => 1,
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => 10,
+ ApiBase::PARAM_MAX2 => 20
+ ),
+ 'redirect' => false,
+ );
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'namespace' => 'Return pages in these namespaces only',
+ 'limit' => 'Limit how many random pages will be returned',
+ 'redirect' => 'Load a random redirect instead of a random page'
+ );
+ }
+
+ public function getDescription() {
+ return array(
+ 'Get a set of random pages',
+ 'NOTE: Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, "Main Page" is the first ',
+ ' random page on your list, "List of fictional monkeys" will *always* be second, "List of people on stamps of Vanuatu" third, etc',
+ 'NOTE: If the number of pages in the namespace is lower than rnlimit, you will get fewer pages. You will not get the same page twice'
+ );
+ }
+
+ protected function getExamples() {
+ return 'api.php?action=query&list=random&rnnamespace=0&rnlimit=2';
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id: ApiQueryRandom.php overlordq$';
+ }
+}