summaryrefslogtreecommitdiff
path: root/includes/api/ApiQueryImageInfo.php
blob: 3d568ba1662817371f963050383c3b6dd11c053e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?php

/*
 * Created on July 6, 2007
 *
 * API for MediaWiki 1.8+
 *
 * Copyright (C) 2006 Yuri Astrakhan <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.,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 * http://www.gnu.org/copyleft/gpl.html
 */

if (!defined('MEDIAWIKI')) {
	// Eclipse helper - will be ignored in production
	require_once ('ApiQueryBase.php');
}

/**
 * A query action to get image information and upload history.
 * 
 * @addtogroup API
 */
class ApiQueryImageInfo extends ApiQueryBase {

	public function __construct($query, $moduleName) {
		parent :: __construct($query, $moduleName, 'ii');
	}

	public function execute() {
		$params = $this->extractRequestParams();

		$history = $params['history'];

		$prop = array_flip($params['prop']);		
		$fld_timestamp = isset($prop['timestamp']);
		$fld_user = isset($prop['user']);
		$fld_comment = isset($prop['comment']);
		$fld_url = isset($prop['url']);
		$fld_size = isset($prop['size']);
		$fld_sha1 = isset($prop['sha1']);

		$pageIds = $this->getPageSet()->getAllTitlesByNamespace();
		if (!empty($pageIds[NS_IMAGE])) {
			foreach ($pageIds[NS_IMAGE] as $dbKey => $pageId) {
								
				$title = Title :: makeTitle(NS_IMAGE, $dbKey);
				$img = wfFindFile($title);

				$data = array();
				if ( !$img ) {
					$repository = '';
				} else {

					$repository = $img->getRepoName();

					$isCur = true;
					while($line = $img->nextHistoryLine()) { // assignment
						$row = get_object_vars( $line );
						$vals = array();
						$prefix = $isCur ? 'img' : 'oi';

						if ($fld_timestamp)
							$vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row["${prefix}_timestamp"]);
						if ($fld_user) {
							$vals['user'] = $row["${prefix}_user_text"];
							if(!$row["${prefix}_user"])
								$vals['anon'] = '';
						}
						if ($fld_size) {
							$vals['size'] = intval($row["{$prefix}_size"]);
							$vals['width'] = intval($row["{$prefix}_width"]);
							$vals['height'] = intval($row["{$prefix}_height"]);
						}
						if ($fld_url)
							$vals['url'] = $isCur ? $img->getURL() : $img->getArchiveUrl($row["oi_archive_name"]);
						if ($fld_comment)
							$vals['comment'] = $row["{$prefix}_description"];
							
						if ($fld_sha1)
							$vals['sha1'] = wfBaseConvert($row["{$prefix}_sha1"], 36, 16, 40);

						$data[] = $vals;
						
						if (!$history)	// Stop after the first line.
							break;
							
						$isCur = false;
					}
					
					$img->resetHistory();
				}

                $this->getResult()->addValue(array ('query', 'pages', intval($pageId)),
                    'imagerepository',
                    $repository);
                if (!empty($data))
                    $this->addPageSubItems($pageId, $data);
			}
		}
	}

	protected function getAllowedParams() {
		return array (
			'prop' => array (
				ApiBase :: PARAM_ISMULTI => true,
				ApiBase :: PARAM_DFLT => 'timestamp|user',
				ApiBase :: PARAM_TYPE => array (
					'timestamp',
					'user',
					'comment',
					'url',
					'size',
					'sha1'
				)
			),
			'history' => false,
		);
	}

	protected function getParamDescription() {
		return array (
			'prop' => 'What image information to get.',
			'history' => 'Include upload history',
		);
	}

	protected function getDescription() {
		return array (
			'Returns image information and upload history'
		);
	}

	protected function getExamples() {
		return array (
			'api.php?action=query&titles=Image:Albert%20Einstein%20Head.jpg&prop=imageinfo',
			'api.php?action=query&titles=Image:Test.jpg&prop=imageinfo&iihistory&iiprop=timestamp|user|url',
		);
	}

	public function getVersion() {
		return __CLASS__ . ': $Id: ApiQueryImageInfo.php 25456 2007-09-03 19:58:05Z catrope $';
	}
}