-<?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
+<?php
+/**
+ *
+ *
+ * Created on December 12, 2007
+ *
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@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.,
+ * 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 enumerate all categories, even the ones that don't have
+ * category pages.
+ *
+ * @ingroup API
+ */
+class ApiQueryAllCategories extends ApiQueryGeneratorBase {
+
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'ac' );
+ }
+
+ public function execute() {
+ $this->run();
+ }
+
+ public function getCacheMode( $params ) {
+ return 'public';
+ }
+
+ public function executeGenerator( $resultPageSet ) {
+ $this->run( $resultPageSet );
+ }
+
+ private function run( $resultPageSet = null ) {
+ $db = $this->getDB();
+ $params = $this->extractRequestParams();
+
+ $this->addTables( 'category' );
+ $this->addFields( 'cat_title' );
+
+ $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( 'cat_title', $dir, $from, $to );
+
+ if ( isset( $params['prefix'] ) ) {
+ $this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
+ }
+
+ $this->addOption( 'LIMIT', $params['limit'] + 1 );
+ $this->addOption( 'ORDER BY', 'cat_title' . ( $params['dir'] == 'descending' ? ' DESC' : '' ) );
+
+ $prop = array_flip( $params['prop'] );
+ $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
+ if ( isset( $prop['hidden'] ) ) {
+ $this->addTables( array( 'page', 'page_props' ) );
+ $this->addJoinConds( array(
+ 'page' => array( 'LEFT JOIN', array(
+ 'page_namespace' => NS_CATEGORY,
+ 'page_title=cat_title' ) ),
+ 'page_props' => array( 'LEFT JOIN', array(
+ 'pp_page=page_id',
+ 'pp_propname' => 'hiddencat' ) ),
+ ) );
+ $this->addFields( 'pp_propname AS cat_hidden' );
+ }
+
+ $res = $this->select( __METHOD__ );
+
+ $pages = array();
+
+ $result = $this->getResult();
+ $count = 0;
+ foreach ( $res as $row ) {
+ if ( ++ $count > $params['limit'] ) {
+ // We've reached the one extra which shows that there are additional cats to be had. Stop here...
+ // TODO: Security issue - if the user has no right to view next title, it will still be shown
+ $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) );
+ break;
+ }
+
+ // Normalize titles
+ $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
+ if ( !is_null( $resultPageSet ) ) {
+ $pages[] = $titleObj->getPrefixedText();
+ } else {
+ $item = array();
+ $result->setContent( $item, $titleObj->getText() );
+ if ( isset( $prop['size'] ) ) {
+ $item['size'] = intval( $row->cat_pages );
+ $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
+ $item['files'] = intval( $row->cat_files );
+ $item['subcats'] = intval( $row->cat_subcats );
+ }
+ if ( isset( $prop['hidden'] ) && $row->cat_hidden ) {
+ $item['hidden'] = '';
+ }
+ $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
+ if ( !$fit ) {
+ $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) );
+ break;
+ }
+ }
+ }
+
+ if ( is_null( $resultPageSet ) ) {
+ $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
+ } else {
+ $resultPageSet->populateFromTitles( $pages );
+ }
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'from' => null,
+ 'to' => null,
+ 'prefix' => null,
+ 'dir' => array(
+ ApiBase::PARAM_DFLT => 'ascending',
+ ApiBase::PARAM_TYPE => array(
+ 'ascending',
+ 'descending'
+ ),
+ ),
+ '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
+ ),
+ 'prop' => array(
+ ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
+ ApiBase::PARAM_DFLT => '',
+ ApiBase::PARAM_ISMULTI => true
+ ),
+ );
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'from' => 'The category to start enumerating from',
+ 'to' => 'The category to stop enumerating at',
+ 'prefix' => 'Search for all category titles that begin with this value',
+ 'dir' => 'Direction to sort in',
+ 'limit' => 'How many categories to return',
+ 'prop' => array(
+ 'Which properties to get',
+ ' size - Adds number of pages in the category',
+ ' hidden - Tags categories that are hidden with __HIDDENCAT__',
+ ),
+ );
+ }
+
+ public function getDescription() {
+ return 'Enumerate all categories';
+ }
+
+ protected function getExamples() {
+ return array(
+ 'api.php?action=query&list=allcategories&acprop=size',
+ 'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
+ );
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff