X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryAllpages.php;h=c4ac486cf656f199846d4e72e33723df0ceff7a3;hb=b63b22fc4716287ac91d77ed0655ceb7a4b46f8b;hp=e1bc280f202dd46248c9627d6d592acf6ad6a764;hpb=550c083a18d0be82ae41db174360c17c687a974e;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryAllpages.php b/includes/api/ApiQueryAllpages.php index e1bc280f20..c4ac486cf6 100644 --- a/includes/api/ApiQueryAllpages.php +++ b/includes/api/ApiQueryAllpages.php @@ -1,12 +1,11 @@ + * Copyright (C) 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 @@ -29,6 +28,11 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * Query module to enumerate all available pages. + * + * @ingroup API + */ class ApiQueryAllpages extends ApiQueryGeneratorBase { public function __construct($query, $moduleName) { @@ -47,72 +51,97 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { } private function run($resultPageSet = null) { - $limit = $from = $namespace = $filterredir = null; - extract($this->extractRequestParams()); $db = $this->getDB(); - $where = array ( - 'page_namespace' => $namespace - ); - - if (isset ($from)) { - $where[] = 'page_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($from)); + $params = $this->extractRequestParams(); + + // Page filters + $this->addTables('page'); + if (!$this->addWhereIf('page_is_redirect = 1', $params['filterredir'] === 'redirects')) + $this->addWhereIf('page_is_redirect = 0', $params['filterredir'] === 'nonredirects'); + $this->addWhereFld('page_namespace', $params['namespace']); + $dir = ($params['dir'] == 'descending' ? 'older' : 'newer'); + $from = (is_null($params['from']) ? null : $this->titleToKey($params['from'])); + $this->addWhereRange('page_title', $dir, $from, null); + if (isset ($params['prefix'])) + $this->addWhere("page_title LIKE '" . $db->escapeLike($this->titleToKey($params['prefix'])) . "%'"); + + $forceNameTitleIndex = true; + if (isset ($params['minsize'])) { + $this->addWhere('page_len>=' . intval($params['minsize'])); + $forceNameTitleIndex = false; } - - if (isset ($prefix)) { - $where[] = "page_title LIKE '{$db->strencode(ApiQueryBase :: titleToKey($prefix))}%'"; + + if (isset ($params['maxsize'])) { + $this->addWhere('page_len<=' . intval($params['maxsize'])); + $forceNameTitleIndex = false; } - if ($filterredir === 'redirects') { - $where['page_is_redirect'] = 1; + // Page protection filtering + if (isset ($params['prtype'])) { + $this->addTables('page_restrictions'); + $this->addWhere('page_id=pr_page'); + $this->addWhere('pr_expiry>' . $db->addQuotes($db->timestamp())); + $this->addWhereFld('pr_type', $params['prtype']); + + $prlevel = $params['prlevel']; + if (!is_null($prlevel) && $prlevel != '' && $prlevel != '*') + $this->addWhereFld('pr_level', $prlevel); + + $this->addOption('DISTINCT'); + + $forceNameTitleIndex = false; + + } else if (isset ($params['prlevel'])) { + $this->dieUsage('prlevel may not be used without prtype', 'params'); } - elseif ($filterredir === 'nonredirects') { - $where['page_is_redirect'] = 0; + + 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; + } else if($params['filterlanglinks'] == 'withlanglinks') { + $this->addTables('langlinks'); + $this->addWhere('page_id=ll_from'); + $forceNameTitleIndex = false; } + if ($forceNameTitleIndex) + $this->addOption('USE INDEX', 'name_title'); if (is_null($resultPageSet)) { - $fields = array ( + $this->addFields(array ( 'page_id', 'page_namespace', 'page_title' - ); + )); } else { - $fields = $resultPageSet->getPageTableFields(); + $this->addFields($resultPageSet->getPageTableFields()); } - $options = array ( - 'USE INDEX' => 'name_title', - 'LIMIT' => $limit +1, - 'ORDER BY' => 'page_namespace, page_title' - ); - - $this->profileDBIn(); - $res = $db->select('page', $fields, $where, __METHOD__, $options); - $this->profileDBOut(); + $limit = $params['limit']; + $this->addOption('LIMIT', $limit+1); + $res = $this->select(__METHOD__); $data = array (); $count = 0; while ($row = $db->fetchObject($res)) { 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); + $data[] = array( + 'pageid' => intval($row->page_id), + 'ns' => intval($title->getNamespace()), + 'title' => $title->getPrefixedText()); + } else { + $resultPageSet->processDbRow($row); } } $db->freeResult($res); @@ -124,41 +153,80 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { } } - protected function getAllowedParams() { + public function getAllowedParams() { + global $wgRestrictionTypes, $wgRestrictionLevels; return array ( 'from' => null, 'prefix' => null, 'namespace' => array ( ApiBase :: PARAM_DFLT => 0, - ApiBase :: PARAM_TYPE => $this->getQuery()->getValidNamespaces()), + ApiBase :: PARAM_TYPE => 'namespace', + ), 'filterredir' => array ( ApiBase :: PARAM_DFLT => 'all', ApiBase :: PARAM_TYPE => array ( 'all', 'redirects', 'nonredirects' - )), + ) + ), + 'minsize' => array ( + ApiBase :: PARAM_TYPE => 'integer', + ), + 'maxsize' => array ( + ApiBase :: PARAM_TYPE => 'integer', + ), + 'prtype' => array ( + ApiBase :: PARAM_TYPE => $wgRestrictionTypes, + ApiBase :: PARAM_ISMULTI => true + ), + 'prlevel' => array ( + ApiBase :: PARAM_TYPE => $wgRestrictionLevels, + ApiBase :: PARAM_ISMULTI => true + ), 'limit' => array ( ApiBase :: PARAM_DFLT => 10, ApiBase :: PARAM_TYPE => 'limit', ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX1 => ApiBase :: LIMIT_BIG1, + 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' + ) + ); } - protected function getParamDescription() { + public 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.', + '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 apprtype= parameter)', + 'filterlanglinks' => 'Filter based on whether a page has langlinks', 'limit' => 'How many total pages to return.' ); } - protected function getDescription() { + public function getDescription() { return 'Enumerate all pages sequentially in a given namespace'; } @@ -179,4 +247,3 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { return __CLASS__ . ': $Id$'; } } -?> \ No newline at end of file