includes/api/ApiQueryImageInfo.php

   1 <?php
   2
   3 /*
   4  * Created on July 6, 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 action to get image information and upload history.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryImageInfo extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'ii');
  40         }
  41
  42         public function execute() {
  43                 $params = $this->extractRequestParams();
  44
  45                 $history = $params['history'];
  46
  47                 $prop = array_flip($params['prop']);
  48                 $fld_timestamp = isset($prop['timestamp']);
  49                 $fld_user = isset($prop['user']);
  50                 $fld_comment = isset($prop['comment']);
  51                 $fld_url = isset($prop['url']);
  52                 $fld_size = isset($prop['size']);
  53                 $fld_sha1 = isset($prop['sha1']);
  54
  55                 $pageIds = $this->getPageSet()->getAllTitlesByNamespace();
  56                 if (!empty($pageIds[NS_IMAGE])) {
  57                         foreach ($pageIds[NS_IMAGE] as $dbKey => $pageId) {
  58
  59                                 $title = Title :: makeTitle(NS_IMAGE, $dbKey);
  60                                 $img = wfFindFile($title);
  61
  62                                 $data = array();
  63                                 if ( !$img ) {
  64                                         $repository = '';
  65                                 } else {
  66
  67                                         $repository = $img->getRepoName();
  68
  69                                         $isCur = true;
  70                                         while($line = $img->nextHistoryLine()) { // assignment
  71                                                 $row = get_object_vars( $line );
  72                                                 $vals = array();
  73                                                 $prefix = $isCur ? 'img' : 'oi';
  74
  75                                                 if ($fld_timestamp)
  76                                                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row["${prefix}_timestamp"]);
  77                                                 if ($fld_user) {
  78                                                         $vals['user'] = $row["${prefix}_user_text"];
  79                                                         if(!$row["${prefix}_user"])
  80                                                                 $vals['anon'] = '';
  81                                                 }
  82                                                 if ($fld_size) {
  83                                                         $vals['size'] = intval($row["{$prefix}_size"]);
  84                                                         $vals['width'] = intval($row["{$prefix}_width"]);
  85                                                         $vals['height'] = intval($row["{$prefix}_height"]);
  86                                                 }
  87                                                 if ($fld_url)
  88                                                         $vals['url'] = $isCur ? $img->getURL() : $img->getArchiveUrl($row["oi_archive_name"]);
  89                                                 if ($fld_comment)
  90                                                         $vals['comment'] = $row["{$prefix}_description"];
  91
  92                                                 if ($fld_sha1)
  93                                                         $vals['sha1'] = wfBaseConvert($row["{$prefix}_sha1"], 36, 16, 40);
  94
  95                                                 $data[] = $vals;
  96
  97                                                 if (!$history)  // Stop after the first line.
  98                                                         break;
  99
 100                                                 $isCur = false;
 101                                         }
 102
 103                                         $img->resetHistory();
 104                                 }
 105
 106                 $this->getResult()->addValue(array ('query', 'pages', intval($pageId)),
 107                     'imagerepository',
 108                     $repository);
 109                 if (!empty($data))
 110                     $this->addPageSubItems($pageId, $data);
 111                         }
 112                 }
 113         }
 114
 115         protected function getAllowedParams() {
 116                 return array (
 117                         'prop' => array (
 118                                 ApiBase :: PARAM_ISMULTI => true,
 119                                 ApiBase :: PARAM_DFLT => 'timestamp|user',
 120                                 ApiBase :: PARAM_TYPE => array (
 121                                         'timestamp',
 122                                         'user',
 123                                         'comment',
 124                                         'url',
 125                                         'size',
 126                                         'sha1'
 127                                 )
 128                         ),
 129                         'history' => false,
 130                 );
 131         }
 132
 133         protected function getParamDescription() {
 134                 return array (
 135                         'prop' => 'What image information to get.',
 136                         'history' => 'Include upload history',
 137                 );
 138         }
 139
 140         protected function getDescription() {
 141                 return array (
 142                         'Returns image information and upload history'
 143                 );
 144         }
 145
 146         protected function getExamples() {
 147                 return array (
 148                         'api.php?action=query&titles=Image:Albert%20Einstein%20Head.jpg&prop=imageinfo',
 149                         'api.php?action=query&titles=Image:Test.jpg&prop=imageinfo&iihistory&iiprop=timestamp|user|url',
 150                 );
 151         }
 152
 153         public function getVersion() {
 154                 return __CLASS__ . ': $Id$';
 155         }
 156 }