X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryAllpages.php;h=32765b43da71cb41696bcd1297a87300591de2a8;hb=2b78de3f023660acec4fa20c8123768722c87b72;hp=0966445ece1611b830914053cbbb520b4ca74520;hpb=d7a95b125c849c4db1a8e83018bdf810a11fb006;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryAllpages.php b/includes/api/ApiQueryAllpages.php index 0966445ece..32765b43da 100644 --- a/includes/api/ApiQueryAllpages.php +++ b/includes/api/ApiQueryAllpages.php @@ -1,12 +1,10 @@ + * Created on Sep 25, 2006 + * + * Copyright © 2006 Yuri Astrakhan @gmail.com * * 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 @@ -20,149 +18,302 @@ * * 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., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html + * + * @file */ -if (!defined('MEDIAWIKI')) { +if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ('ApiQueryBase.php'); + require_once( 'ApiQueryBase.php' ); } +/** + * Query module to enumerate all available pages. + * + * @ingroup API + */ class ApiQueryAllpages extends ApiQueryGeneratorBase { - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'ap'); + public function __construct( $query, $moduleName ) { + parent::__construct( $query, $moduleName, 'ap' ); } public function execute() { $this->run(); } - public function executeGenerator($resultPageSet) { - if ($resultPageSet->isResolvingRedirects()) - $this->dieUsage('Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params'); - - $this->run($resultPageSet); + public function getCacheMode( $params ) { + return 'public'; } - private function run($resultPageSet = null) { - $limit = $from = $namespace = $filterredir = null; - extract($this->extractRequestParams()); + /** + * @param $resultPageSet ApiPageSet + * @return void + */ + public function executeGenerator( $resultPageSet ) { + if ( $resultPageSet->isResolvingRedirects() ) { + $this->dieUsage( 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params' ); + } + $this->run( $resultPageSet ); + } + + /** + * @param $resultPageSet ApiPageSet + * @return void + */ + private function run( $resultPageSet = null ) { $db = $this->getDB(); - $where = array ( - 'page_namespace' => $namespace - ); + $params = $this->extractRequestParams(); - if (isset ($from)) { - $where[] = 'page_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($from)); - } - - if (isset ($prefix)) { - $where[] = "page_title LIKE '{$db->strencode(ApiQueryBase :: titleToKey($prefix))}%'"; - } + // Page filters + $this->addTables( 'page' ); - if ($filterredir === 'redirects') { - $where['page_is_redirect'] = 1; + if ( $params['filterredir'] == 'redirects' ) { + $this->addWhereFld( 'page_is_redirect', 1 ); + } elseif ( $params['filterredir'] == 'nonredirects' ) { + $this->addWhereFld( 'page_is_redirect', 0 ); } - elseif ($filterredir === 'nonredirects') { - $where['page_is_redirect'] = 0; + + $this->addWhereFld( 'page_namespace', $params['namespace'] ); + $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' ); + $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) ); + $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) ); + $this->addWhereRange( 'page_title', $dir, $from, $to ); + + if ( isset( $params['prefix'] ) ) { + $this->addWhere( 'page_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) ); } - if (is_null($resultPageSet)) { - $fields = array ( - 'page_id', + if ( is_null( $resultPageSet ) ) { + $selectFields = array( 'page_namespace', - 'page_title' + 'page_title', + 'page_id' ); } else { - $fields = $resultPageSet->getPageTableFields(); + $selectFields = $resultPageSet->getPageTableFields(); } - $options = array ( - 'USE INDEX' => 'name_title', - 'LIMIT' => $limit +1, - 'ORDER BY' => 'page_namespace, page_title' - ); + $this->addFields( $selectFields ); + $forceNameTitleIndex = true; + if ( isset( $params['minsize'] ) ) { + $this->addWhere( 'page_len>=' . intval( $params['minsize'] ) ); + $forceNameTitleIndex = false; + } + + if ( isset( $params['maxsize'] ) ) { + $this->addWhere( 'page_len<=' . intval( $params['maxsize'] ) ); + $forceNameTitleIndex = false; + } - $this->profileDBIn(); - $res = $db->select('page', $fields, $where, __METHOD__, $options); - $this->profileDBOut(); + // Page protection filtering + if ( count( $params['prtype'] ) || $params['prexpiry'] != 'all' ) { + $this->addTables( 'page_restrictions' ); + $this->addWhere( 'page_id=pr_page' ); + $this->addWhere( 'pr_expiry>' . $db->addQuotes( $db->timestamp() ) ); + + if ( count( $params['prtype'] ) ) { + $this->addWhereFld( 'pr_type', $params['prtype'] ); + + if ( isset( $params['prlevel'] ) ) { + // Remove the empty string and '*' from the prlevel array + $prlevel = array_diff( $params['prlevel'], array( '', '*' ) ); + + if ( count( $prlevel ) ) { + $this->addWhereFld( 'pr_level', $prlevel ); + } + } + if ( $params['prfiltercascade'] == 'cascading' ) { + $this->addWhereFld( 'pr_cascade', 1 ); + } elseif ( $params['prfiltercascade'] == 'noncascading' ) { + $this->addWhereFld( 'pr_cascade', 0 ); + } + + $this->addOption( 'DISTINCT' ); + } + $forceNameTitleIndex = false; + + if ( $params['prexpiry'] == 'indefinite' ) { + $this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" ); + } elseif ( $params['prexpiry'] == 'definite' ) { + $this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" ); + } + + } elseif ( isset( $params['prlevel'] ) ) { + $this->dieUsage( 'prlevel may not be used without prtype', 'params' ); + } + + if ( $params['filterlanglinks'] == 'withoutlanglinks' ) { + $this->addTables( 'langlinks' ); + $this->addJoinConds( array( 'langlinks' => array( 'LEFT JOIN', 'page_id=ll_from' ) ) ); + $this->addWhere( 'll_from IS NULL' ); + $forceNameTitleIndex = false; + } elseif ( $params['filterlanglinks'] == 'withlanglinks' ) { + $this->addTables( 'langlinks' ); + $this->addWhere( 'page_id=ll_from' ); + $this->addOption( 'STRAIGHT_JOIN' ); + // We have to GROUP BY all selected fields to stop + // PostgreSQL from whining + $this->addOption( 'GROUP BY', implode( ', ', $selectFields ) ); + $forceNameTitleIndex = false; + } + + if ( $forceNameTitleIndex ) { + $this->addOption( 'USE INDEX', 'name_title' ); + } + + $limit = $params['limit']; + $this->addOption( 'LIMIT', $limit + 1 ); + $res = $this->select( __METHOD__ ); - $data = array (); $count = 0; - while ($row = $db->fetchObject($res)) { - if (++ $count > $limit) { + $result = $this->getResult(); + foreach ( $res as $row ) { + if ( ++ $count > $limit ) { // We've reached the one extra which shows that there are additional pages to be had. Stop here... - $this->setContinueEnumParameter('from', ApiQueryBase :: keyToTitle($row->page_title)); + // TODO: Security issue - if the user has no right to view next title, it will still be shown + $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title ) ); break; } - $title = Title :: makeTitle($row->page_namespace, $row->page_title); - // skip any pages that user has no rights to read - if ($title->userCanRead()) { - - if (is_null($resultPageSet)) { - $id = intval($row->page_id); - $data[$id] = array ( - 'id' => $id, - 'ns' => $title->getNamespace(), - 'title' => $title->getPrefixedText()); - } else { - $resultPageSet->processDbRow($row); + if ( is_null( $resultPageSet ) ) { + $title = Title::makeTitle( $row->page_namespace, $row->page_title ); + $vals = array( + 'pageid' => intval( $row->page_id ), + 'ns' => intval( $title->getNamespace() ), + 'title' => $title->getPrefixedText() + ); + $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title ) ); + break; } + } else { + $resultPageSet->processDbRow( $row ); } } - $db->freeResult($res); - if (is_null($resultPageSet)) { - ApiResult :: setIndexedTagName($data, 'p'); - $this->getResult()->addValue('query', $this->getModuleName(), $data); + if ( is_null( $resultPageSet ) ) { + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'p' ); } } - protected function getAllowedParams() { + public function getAllowedParams() { + global $wgRestrictionLevels; - return array ( + return array( 'from' => null, + 'to' => null, 'prefix' => null, - 'namespace' => array ( - ApiBase :: PARAM_DFLT => 0, - ApiBase :: PARAM_TYPE => $this->getQuery()->getValidNamespaces()), - 'filterredir' => array ( - ApiBase :: PARAM_DFLT => 'all', - ApiBase :: PARAM_TYPE => array ( + 'namespace' => array( + ApiBase::PARAM_DFLT => 0, + ApiBase::PARAM_TYPE => 'namespace', + ), + 'filterredir' => array( + ApiBase::PARAM_DFLT => 'all', + ApiBase::PARAM_TYPE => array( 'all', 'redirects', 'nonredirects' - )), - 'limit' => array ( - ApiBase :: PARAM_DFLT => 10, - ApiBase :: PARAM_TYPE => 'limit', - ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX1 => 500, - ApiBase :: PARAM_MAX2 => 5000 - )); + ) + ), + 'minsize' => array( + ApiBase::PARAM_TYPE => 'integer', + ), + 'maxsize' => array( + ApiBase::PARAM_TYPE => 'integer', + ), + 'prtype' => array( + ApiBase::PARAM_TYPE => Title::getFilteredRestrictionTypes( true ), + ApiBase::PARAM_ISMULTI => true + ), + 'prlevel' => array( + ApiBase::PARAM_TYPE => $wgRestrictionLevels, + ApiBase::PARAM_ISMULTI => true + ), + 'prfiltercascade' => array( + ApiBase::PARAM_DFLT => 'all', + ApiBase::PARAM_TYPE => array( + 'cascading', + 'noncascading', + 'all' + ), + ), + 'limit' => array( + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 + ), + 'dir' => array( + ApiBase::PARAM_DFLT => 'ascending', + ApiBase::PARAM_TYPE => array( + 'ascending', + 'descending' + ) + ), + 'filterlanglinks' => array( + ApiBase::PARAM_TYPE => array( + 'withlanglinks', + 'withoutlanglinks', + 'all' + ), + ApiBase::PARAM_DFLT => 'all' + ), + 'prexpiry' => array( + ApiBase::PARAM_TYPE => array( + 'indefinite', + 'definite', + 'all' + ), + ApiBase::PARAM_DFLT => 'all' + ), + ); } - protected function getParamDescription() { - return array ( - 'from' => 'The page title to start enumerating from.', - 'prefix' => 'Search for all page titles that begin with this value.', - 'namespace' => 'The namespace to enumerate.', - 'filterredir' => 'Which pages to list.', - 'limit' => 'How many total pages to return.' + public function getParamDescription() { + $p = $this->getModulePrefix(); + return array( + 'from' => 'The page title to start enumerating from', + 'to' => 'The page title to stop enumerating at', + 'prefix' => 'Search for all page titles that begin with this value', + 'namespace' => 'The namespace to enumerate', + 'filterredir' => 'Which pages to list', + 'dir' => 'The direction in which to list', + 'minsize' => 'Limit to pages with at least this many bytes', + 'maxsize' => 'Limit to pages with at most this many bytes', + 'prtype' => 'Limit to protected pages only', + 'prlevel' => "The protection level (must be used with {$p}prtype= parameter)", + 'prfiltercascade' => "Filter protections based on cascadingness (ignored when {$p}prtype isn't set)", + 'filterlanglinks' => 'Filter based on whether a page has langlinks', + 'limit' => 'How many total pages to return.', + 'prexpiry' => array( + 'Which protection expiry to filter the page on', + ' indefinite - Get only pages with indefinite protection expiry', + ' definite - Get only pages with a definite (specific) protection expiry', + ' all - Get pages with any protections expiry' + ), ); } - protected function getDescription() { + public function getDescription() { return 'Enumerate all pages sequentially in a given namespace'; } - protected function getExamples() { - return array ( + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'code' => 'params', 'info' => 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator' ), + array( 'code' => 'params', 'info' => 'prlevel may not be used without prtype' ), + ) ); + } + + public function getExamples() { + return array( 'Simple Use', ' Show a list of pages starting at the letter "B"', ' api.php?action=query&list=allpages&apfrom=B', @@ -174,8 +325,11 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { ); } + public function getHelpUrls() { + return 'http://www.mediawiki.org/wiki/API:Allpages'; + } + public function getVersion() { return __CLASS__ . ': $Id$'; } } -?> \ No newline at end of file