--- /dev/null
+<?php\r
+\r
+/*\r
+ * Created on December 12, 2007\r
+ *\r
+ * API for MediaWiki 1.8+\r
+ *\r
+ * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl\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 enumerate all categories, even the ones that don't have\r
+ * category pages.\r
+ * \r
+ * @addtogroup API\r
+ */\r
+class ApiQueryAllCategories extends ApiQueryGeneratorBase {\r
+\r
+ public function __construct($query, $moduleName) {\r
+ parent :: __construct($query, $moduleName, 'ac');\r
+ }\r
+\r
+ public function execute() {\r
+ $this->run();\r
+ }\r
+\r
+ public function executeGenerator($resultPageSet) {\r
+ $this->run($resultPageSet);\r
+ }\r
+\r
+ private function run($resultPageSet = null) {\r
+\r
+ $db = $this->getDB();\r
+ $params = $this->extractRequestParams();\r
+\r
+ $this->addTables('categorylinks');\r
+ $this->addFields('cl_to');\r
+ \r
+ if (!is_null($params['from']))\r
+ $this->addWhere('cl_to>=' . $db->addQuotes(ApiQueryBase :: titleToKey($params['from'])));\r
+ if (isset ($params['prefix']))\r
+ $this->addWhere("cl_to LIKE '" . $db->escapeLike(ApiQueryBase :: titleToKey($params['prefix'])) . "%'");\r
+\r
+ $this->addOption('LIMIT', $params['limit']+1);\r
+ $this->addOption('ORDER BY', 'cl_to' . ($params['dir'] == 'ZtoA' ? ' DESC' : ''));\r
+ $this->addOption('DISTINCT');\r
+\r
+ $res = $this->select(__METHOD__);\r
+\r
+ $pages = array();\r
+ $count = 0;\r
+ while ($row = $db->fetchObject($res)) {\r
+ if (++ $count > $params['limit']) {\r
+ // We've reached the one extra which shows that there are additional cats to be had. Stop here...\r
+ // TODO: Security issue - if the user has no right to view next title, it will still be shown\r
+ $this->setContinueEnumParameter('from', ApiQueryBase :: keyToTitle($row->cl_to));\r
+ break;\r
+ }\r
+ \r
+ // Normalize titles\r
+ if(!is_null($resultPageSet))\r
+ $titleObj = Title::newFromText('Category:' . $row->cl_to);\r
+ else\r
+ $titleObj = Title::newFromText($row->cl_to);\r
+ $pages[] = $titleObj->getPrefixedText();\r
+ }\r
+ $db->freeResult($res);\r
+\r
+ if (is_null($resultPageSet)) {\r
+ $result = $this->getResult();\r
+ $result->setIndexedTagName($pages, 'c');\r
+ $result->addValue('query', $this->getModuleName(), $pages);\r
+ } else {\r
+ $resultPageSet->populateFromTitles($pages);\r
+ }\r
+ }\r
+\r
+ protected function getAllowedParams() {\r
+ return array (\r
+ 'from' => null,\r
+ 'prefix' => null,\r
+ 'dir' => array(\r
+ ApiBase :: PARAM_DFLT => 'AtoZ',\r
+ ApiBase :: PARAM_TYPE => array(\r
+ 'AtoZ',\r
+ 'ZtoA'\r
+ ),\r
+ ),\r
+ 'limit' => array (\r
+ ApiBase :: PARAM_DFLT => 10,\r
+ ApiBase :: PARAM_TYPE => 'limit',\r
+ ApiBase :: PARAM_MIN => 1,\r
+ ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,\r
+ ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2\r
+ )\r
+ );\r
+ }\r
+\r
+ protected function getParamDescription() {\r
+ return array (\r
+ 'from' => 'The category to start enumerating from.',\r
+ 'prefix' => 'Search for all category titles that begin with this value.',\r
+ 'dir' => 'Direction to sort in.',\r
+ 'limit' => 'How many categories to return.'\r
+ );\r
+ }\r
+\r
+ protected function getDescription() {\r
+ return 'Enumerate all categories';\r
+ }\r
+\r
+ protected function getExamples() {\r
+ return array (\r
+ 'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',\r
+ );\r
+ }\r
+\r
+ public function getVersion() {\r
+ return __CLASS__ . ': $Id: ApiQueryAllLinks.php 28216 2007-12-06 18:33:18Z vasilievvv $';\r
+ }\r
+}\r