includes/api/ApiQueryCategories.php

   1 <?php
   2
   3 /*
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ("ApiQueryBase.php");
  29 }
  30
  31 /**
  32  * A query module to enumerate categories the set of pages belong to.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryCategories extends ApiQueryGeneratorBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'cl');
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator($resultPageSet) {
  47                 $this->run($resultPageSet);
  48         }
  49
  50         private function run($resultPageSet = null) {
  51
  52                 if ($this->getPageSet()->getGoodTitleCount() == 0)
  53                         return; // nothing to do
  54
  55                 $params = $this->extractRequestParams();
  56                 $prop = $params['prop'];
  57
  58                 $this->addFields(array (
  59                         'cl_from',
  60                         'cl_to'
  61                 ));
  62
  63                 $fld_sortkey = false;
  64                 if (!is_null($prop)) {
  65                         foreach($prop as $p) {
  66                                 switch ($p) {
  67                                         case 'sortkey':
  68                                                 $this->addFields('cl_sortkey');
  69                                                 $fld_sortkey = true;
  70                                                 break;
  71                                         default :
  72                                                 ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p");
  73                                 }
  74                         }
  75                 }
  76
  77                 $this->addTables('categorylinks');
  78                 $this->addWhereFld('cl_from', array_keys($this->getPageSet()->getGoodTitles()));
  79                 $this->addOption('ORDER BY', "cl_from, cl_to");
  80
  81                 $db = $this->getDB();
  82                 $res = $this->select(__METHOD__);
  83
  84                 if (is_null($resultPageSet)) {
  85
  86                         $data = array();
  87                         $lastId = 0;    // database has no ID 0
  88                         while ($row = $db->fetchObject($res)) {
  89                                 if ($lastId != $row->cl_from) {
  90                                         if($lastId != 0) {
  91                                                 $this->addPageSubItems($lastId, $data);
  92                                                 $data = array();
  93                                         }
  94                                         $lastId = $row->cl_from;
  95                                 }
  96
  97                                 $title = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
  98                                 // do not check userCanRead() -- page content is already accessible,
  99                                 // and category is listed there.
 100
 101                                 $vals = array();
 102                                 ApiQueryBase :: addTitleInfo($vals, $title, true);
 103                                 if ($fld_sortkey)
 104                                         $vals['sortkey'] = $row->cl_sortkey;
 105
 106                                 $data[] = $vals;
 107                         }
 108
 109                         if($lastId != 0) {
 110                                 $this->addPageSubItems($lastId, $data);
 111                         }
 112
 113                 } else {
 114
 115                         $titles = array();
 116                         while ($row = $db->fetchObject($res)) {
 117                                 $title = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
 118                                 if($title->userCanRead())
 119                                         $titles[] = $title;
 120                         }
 121                         $resultPageSet->populateFromTitles($titles);
 122                 }
 123
 124                 $db->freeResult($res);
 125         }
 126
 127         private function addPageSubItems($pageId, $data) {
 128                 $result = $this->getResult();
 129                 $result->setIndexedTagName($data, 'cl');
 130                 $result->addValue(array ('query', 'pages', intval($pageId)),
 131                         'categories',
 132                         $data);
 133         }
 134
 135         protected function getAllowedParams() {
 136                 return array (
 137                         'prop' => array (
 138                                 ApiBase :: PARAM_ISMULTI => true,
 139                                 ApiBase :: PARAM_TYPE => array (
 140                                         'sortkey',
 141                                 )
 142                         )
 143                 );
 144         }
 145
 146         protected function getParamDescription() {
 147                 return array (
 148                         'prop' => 'Which additional properties to get for each category.',
 149                 );
 150         }
 151
 152         protected function getDescription() {
 153                 return 'List all categories the page(s) belong to';
 154         }
 155
 156         protected function getExamples() {
 157                 return array (
 158                                 "Get a list of categories [[Albert Einstein]] belongs to:",
 159                                 "  api.php?action=query&prop=categories&titles=Albert%20Einstein",
 160                                 "Get information about all categories used in the [[Albert Einstein]]:",
 161                                 "  api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
 162                         );
 163         }
 164
 165         public function getVersion() {
 166                 return __CLASS__ . ': $Id$';
 167         }
 168 }
 169