includes/api/ApiQueryImages.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 <FirstnameLastname@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  * @addtogroup API
  33  */
  34 class ApiQueryImages extends ApiQueryGeneratorBase {
  35
  36         public function __construct($query, $moduleName) {
  37                 parent :: __construct($query, $moduleName, 'im');
  38         }
  39
  40         public function execute() {
  41                 $this->run();
  42         }
  43
  44         public function executeGenerator($resultPageSet) {
  45                 $this->run($resultPageSet);
  46         }
  47
  48         private function run($resultPageSet = null) {
  49
  50                 if ($this->getPageSet()->getGoodTitleCount() == 0)
  51                         return; // nothing to do
  52
  53                 $this->addFields(array (
  54                         'il_from',
  55                         'il_to'
  56                 ));
  57
  58                 $this->addTables('imagelinks');
  59                 $this->addWhereFld('il_from', array_keys($this->getPageSet()->getGoodTitles()));
  60                 $this->addOption('ORDER BY', "il_from, il_to");
  61
  62                 $db = $this->getDB();
  63                 $res = $this->select(__METHOD__);
  64
  65                 if (is_null($resultPageSet)) {
  66
  67                         $data = array();
  68                         $lastId = 0;    // database has no ID 0
  69                         while ($row = $db->fetchObject($res)) {
  70                                 if ($lastId != $row->il_from) {
  71                                         if($lastId != 0) {
  72                                                 $this->addPageSubItems($lastId, $data);
  73                                                 $data = array();
  74                                         }
  75                                         $lastId = $row->il_from;
  76                                 }
  77
  78                                 $title = Title :: makeTitle(NS_IMAGE, $row->il_to);
  79                                 // do not check userCanRead() -- page content is already accessible,
  80                                 // and images are listed there.
  81
  82                                 $vals = array();
  83                                 ApiQueryBase :: addTitleInfo($vals, $title);
  84                                 $data[] = $vals;
  85                         }
  86
  87                         if($lastId != 0) {
  88                                 $this->addPageSubItems($lastId, $data);
  89                         }
  90
  91                 } else {
  92
  93                         $titles = array();
  94                         while ($row = $db->fetchObject($res)) {
  95                                 $titles[] = Title :: makeTitle(NS_IMAGE, $row->il_to);
  96                         }
  97                         $resultPageSet->populateFromTitles($titles);
  98                 }
  99
 100                 $db->freeResult($res);
 101         }
 102
 103         private function addPageSubItems($pageId, $data) {
 104                 $result = $this->getResult();
 105                 $result->setIndexedTagName($data, 'im');
 106                 $result->addValue(array ('query', 'pages', intval($pageId)),
 107                         'images',
 108                         $data);
 109         }
 110
 111         protected function getDescription() {
 112                 return 'Returns all links from the given page(s)';
 113         }
 114
 115         protected function getExamples() {
 116                 return array (
 117                                 "Get a list of images used in the [[Main Page]]:",
 118                                 "  api.php?action=query&prop=images&titles=Main%20Page",
 119                                 "Get information about all images used in the [[Main Page]]:",
 120                                 "  api.php?action=query&generator=images&titles=Main%20Page&prop=info"
 121                         );
 122         }
 123
 124         public function getVersion() {
 125                 return __CLASS__ . ': $Id$';
 126         }
 127 }
 128 ?>