From: Yuri Astrakhan Date: Sat, 16 Jun 2007 00:39:01 +0000 (+0000) Subject: API: Added categorymembers list ability. X-Git-Tag: 1.31.0-rc.0~52538 X-Git-Url: http://git.cyclocoop.org/%22.htmlspecialchars%28%24url_syndic%29.%22?a=commitdiff_plain;h=6f82fb146b41cde58e16cf2b8877d4e381a70431;p=lhc%2Fweb%2Fwiklou.git API: Added categorymembers list ability. --- diff --git a/RELEASE-NOTES b/RELEASE-NOTES index 7e0f50583b..937920ef70 100644 --- a/RELEASE-NOTES +++ b/RELEASE-NOTES @@ -206,6 +206,7 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN values of all returned page items * (bug 10147) Now interwiki titles are not processed but added to a separate "interwiki" section of the output. +* Added categorymembers list to query for pages in a category. == Maintenance script changes since 1.10 == diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index 3670c9f5dd..849be069c8 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -305,6 +305,7 @@ function __autoload($className) { 'ApiQueryBase' => 'includes/api/ApiQueryBase.php', 'ApiQueryBacklinks' => 'includes/api/ApiQueryBacklinks.php', 'ApiQueryCategories' => 'includes/api/ApiQueryCategories.php', + 'ApiQueryCategoryMembers' => 'includes/api/ApiQueryCategoryMembers.php', 'ApiQueryContributions' => 'includes/api/ApiQueryUserContributions.php', 'ApiQueryExternalLinks' => 'includes/api/ApiQueryExternalLinks.php', 'ApiQueryImages' => 'includes/api/ApiQueryImages.php', diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index befa075728..65fe66d069 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -61,15 +61,15 @@ class ApiQuery extends ApiBase { private $mQueryListModules = array ( 'allpages' => 'ApiQueryAllpages', - 'logevents' => 'ApiQueryLogEvents', - 'watchlist' => 'ApiQueryWatchlist', - 'recentchanges' => 'ApiQueryRecentChanges', 'backlinks' => 'ApiQueryBacklinks', + 'categorymembers' => 'ApiQueryCategoryMembers', 'embeddedin' => 'ApiQueryBacklinks', 'imageusage' => 'ApiQueryBacklinks', - 'usercontribs' => 'ApiQueryContributions' + 'logevents' => 'ApiQueryLogEvents', + 'recentchanges' => 'ApiQueryRecentChanges', + 'usercontribs' => 'ApiQueryContributions', + 'watchlist' => 'ApiQueryWatchlist', ); - // 'categorymembers' => 'ApiQueryCategorymembers', // 'recentchanges' => 'ApiQueryRecentchanges', // 'users' => 'ApiQueryUsers', // 'watchlist' => 'ApiQueryWatchlist', diff --git a/includes/api/ApiQueryCategories.php b/includes/api/ApiQueryCategories.php index d71005bf9c..cb08bc93a6 100644 --- a/includes/api/ApiQueryCategories.php +++ b/includes/api/ApiQueryCategories.php @@ -150,12 +150,12 @@ class ApiQueryCategories extends ApiQueryGeneratorBase { } protected function getDescription() { - return 'Returns all links from the given page(s)'; + return 'List all categories the page(s) belong to'; } protected function getExamples() { return array ( - "Get a list of categories used in the [[Albert Einstein]]:", + "Get a list of categories [[Albert Einstein]] belongs to:", " api.php?action=query&prop=categories&titles=Albert%20Einstein", "Get information about all categories used in the [[Albert Einstein]]:", " api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info" diff --git a/includes/api/ApiQueryCategoryMembers.php b/includes/api/ApiQueryCategoryMembers.php new file mode 100644 index 0000000000..06203cedc7 --- /dev/null +++ b/includes/api/ApiQueryCategoryMembers.php @@ -0,0 +1,210 @@ +@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 + * 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., + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * http://www.gnu.org/copyleft/gpl.html + */ + +if (!defined('MEDIAWIKI')) { + // Eclipse helper - will be ignored in production + require_once ("ApiQueryBase.php"); +} + +/** + * A query module to enumerate pages that belong to a category. + * + * @addtogroup API + */ +class ApiQueryCategoryMembers extends ApiQueryGeneratorBase { + + public function __construct($query, $moduleName) { + parent :: __construct($query, $moduleName, 'cm'); + } + + public function execute() { + $this->run(); + } + + public function executeGenerator($resultPageSet) { + $this->run($resultPageSet); + } + + private function run($resultPageSet = null) { + + $params = $this->extractRequestParams(); + + $category = $params['category']; + if (is_null($category)) + $this->dieUsage("Category parameter is required", 'param_category'); + $categoryTitle = Title::makeTitleSafe( NS_CATEGORY, $category ); + if ( is_null( $categoryTitle ) ) + $this->dieUsage("Category name $category is not valid", 'param_category'); + + $prop = array_flip($params['prop']); + $fld_ids = isset($prop['ids']); + $fld_title = isset($prop['title']); + $fld_sortkey = isset($prop['sortkey']); + + if (is_null($resultPageSet)) { + $this->addFields(array('cl_sortkey', 'page_namespace', 'page_title')); + $this->addFieldsIf('page_id', $fld_ids); + } else { + $this->addFields($resultPageSet->getPageTableFields()); // will include page_ id, ns, title + $this->addFields('cl_sortkey'); + } + + $this->addTables(array('page','categorylinks')); // must be in this order for 'USE INDEX' + $this->addOption('USE INDEX', 'cl_sortkey'); // Not needed after bug 10280 is applied to servers + + $this->addWhere('cl_from=page_id'); + $this->setContinuation($params['continue']); + $this->addWhereFld('cl_to', $categoryTitle->getDBkey()); + $this->addWhereFld('page_namespace', $params['namespace']); + $this->addOption('ORDER BY', "cl_to, cl_sortkey, cl_from"); + + $limit = $params['limit']; + $this->addOption('LIMIT', $limit +1); + + $db = $this->getDB(); + + $data = array (); + $count = 0; + $lastSortKey = null; + $res = $this->select(__METHOD__); + 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('continue', $this->getContinueStr($row, $lastSortKey)); + break; + } + + $lastSortKey = $row->cl_sortkey; // detect duplicate sortkeys + + if (is_null($resultPageSet)) { + $title = Title :: makeTitle($row->page_namespace, $row->page_title); + if ($title->userCanRead()) { + $vals = array(); + if ($fld_ids) + $vals['pageid'] = intval($row->page_id); + if ($fld_title) { + $vals['ns'] = intval($title->getNamespace()); + $vals['title'] = $title->getPrefixedText(); + } + if ($fld_sortkey) + $vals['sortkey'] = $row->cl_sortkey; + $data[] = $vals; + } + } else { + $resultPageSet->processDbRow($row); + } + } + $db->freeResult($res); + + if (is_null($resultPageSet)) { + $this->getResult()->setIndexedTagName($data, 'cm'); + $this->getResult()->addValue('query', $this->getModuleName(), $data); + } + } + + private function getContinueStr($row, $lastSortKey) { + $ret = $row->cl_sortkey . '|'; + if ($row->cl_sortkey == $lastSortKey) // duplicate sort key, add cl_from + $ret .= $row->cl_from; + return $ret; + } + + /** + * Add DB WHERE clause to continue previous query based on 'continue' parameter + */ + private function setContinuation($continue) { + if (is_null($continue)) + return; // This is not a continuation request + + $continueList = explode('|', $continue); + if (count($continueList) != 2) + $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue"); + + $sortKey = $this->getDB()->addQuotes($continueList[0]); + $from = intval($continueList[1]); + + if ($from != 0) { + // Duplicate sort key continue + $this->addWhere( "cl_sortkey>$sortKey OR (cl_sortkey=$sortKey AND cl_from>=$from)" ); + } else { + $this->addWhere( "cl_sortkey>=$sortKey" ); + } + } + + protected function getAllowedParams() { + return array ( + 'category' => null, + 'prop' => array ( + ApiBase :: PARAM_DFLT => 'ids|title', + ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_TYPE => array ( + 'ids', + 'title', + 'sortkey', + ) + ), + 'namespace' => array ( + ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_TYPE => 'namespace', + ), + 'continue' => null, + 'limit' => array ( + ApiBase :: PARAM_TYPE => 'limit', + ApiBase :: PARAM_DFLT => 10, + ApiBase :: PARAM_MIN => 1, + ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, + ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 + ), + ); + } + + protected function getParamDescription() { + return array ( + 'category' => 'Which category to enumerate (required)', + 'prop' => 'What pieces of infromation to include', + 'namespace' => 'Only include pages in these namespaces', + 'continue' => 'For large categories, give the value retured from previous query', + 'limit' => 'The maximum number of pages to return.', + ); + } + + protected function getDescription() { + return 'List all pages in a given category'; + } + + protected function getExamples() { + return array ( + "Get first 10 pages in the categories [[Physics]]:", + " api.php?action=query&list=categorymembers&cmcategory=Physics", + "Get page info about first 10 pages in the categories [[Physics]]:", + " api.php?action=query&generator=categorymembers&gcmcategory=Physics&prop=info", + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id$'; + } +} +?> diff --git a/includes/api/ApiQueryUserContributions.php b/includes/api/ApiQueryUserContributions.php index 519e0e3b64..2c1fd688c9 100644 --- a/includes/api/ApiQueryUserContributions.php +++ b/includes/api/ApiQueryUserContributions.php @@ -47,16 +47,13 @@ class ApiQueryContributions extends ApiQueryBase { // Parse some parameters $this->params = $this->extractRequestParams(); - $prop = $this->params['prop']; - if (!is_null($prop)) { - $prop = array_flip($prop); - - $this->fld_ids = isset($prop['ids']); - $this->fld_title = isset($prop['title']); - $this->fld_comment = isset($prop['comment']); - $this->fld_flags = isset($prop['flags']); - $this->fld_timestamp = isset($prop['timestamp']); - } + + $prop = array_flip($this->params['prop']); + $this->fld_ids = isset($prop['ids']); + $this->fld_title = isset($prop['title']); + $this->fld_comment = isset($prop['comment']); + $this->fld_flags = isset($prop['flags']); + $this->fld_timestamp = isset($prop['timestamp']); // TODO: if the query is going only against the revision table, should this be done? $this->selectNamedDB('contributions', DB_SLAVE, 'contributions');