a1a6f2691cde36f9f05fe523b1f5f2f854675890
3 * Foreign file accessible through api.php requests.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileAbstraction
25 * Foreign file accessible through api.php requests.
26 * Very hacky and inefficient, do not use :D
28 * @ingroup FileAbstraction
30 class ForeignAPIFile
extends File
{
33 protected $repoClass = 'ForeignApiRepo';
37 * @param $repo ForeignApiRepo
41 function __construct( $title, $repo, $info, $exists = false ) {
42 parent
::__construct( $title, $repo );
45 $this->mExists
= $exists;
47 $this->assertRepoDefined();
52 * @param $repo ForeignApiRepo
53 * @return ForeignAPIFile|null
55 static function newFromTitle( Title
$title, $repo ) {
56 $data = $repo->fetchImageQuery( array(
57 'titles' => 'File:' . $title->getDBkey(),
58 'iiprop' => self
::getProps(),
59 'prop' => 'imageinfo',
60 'iimetadataversion' => MediaHandler
::getMetadataVersion()
63 $info = $repo->getImageInfo( $data );
66 $lastRedirect = isset( $data['query']['redirects'] )
67 ?
count( $data['query']['redirects'] ) - 1
69 if ( $lastRedirect >= 0 ) {
70 $newtitle = Title
::newFromText( $data['query']['redirects'][$lastRedirect]['to'] );
71 $img = new self( $newtitle, $repo, $info, true );
73 $img->redirectedFrom( $title->getDBkey() );
76 $img = new self( $title, $repo, $info, true );
85 * Get the property string for iiprop and aiprop
88 static function getProps() {
89 return 'timestamp|user|comment|url|size|sha1|metadata|mime|mediatype';
97 public function exists() {
98 return $this->mExists
;
104 public function getPath() {
109 * @param array $params
111 * @return bool|MediaTransformOutput
113 function transform( $params, $flags = 0 ) {
114 if ( !$this->canRender() ) {
116 return parent
::transform( $params, $flags );
119 // Note, the this->canRender() check above implies
120 // that we have a handler, and it can do makeParamString.
121 $otherParams = $this->handler
->makeParamString( $params );
122 $width = isset( $params['width'] ) ?
$params['width'] : -1;
123 $height = isset( $params['height'] ) ?
$params['height'] : -1;
125 $thumbUrl = $this->repo
->getThumbUrlFromCache(
131 if ( $thumbUrl === false ) {
133 return $this->repo
->getThumbError(
141 return $this->handler
->getTransform( $this, 'bogus', $thumbUrl, $params );
144 // Info we can get from API...
150 public function getWidth( $page = 1 ) {
151 return isset( $this->mInfo
['width'] ) ?
intval( $this->mInfo
['width'] ) : 0;
158 public function getHeight( $page = 1 ) {
159 return isset( $this->mInfo
['height'] ) ?
intval( $this->mInfo
['height'] ) : 0;
163 * @return bool|null|string
165 public function getMetadata() {
166 if ( isset( $this->mInfo
['metadata'] ) ) {
167 return serialize( self
::parseMetadata( $this->mInfo
['metadata'] ) );
173 * @return array|null extended metadata (see imageinfo API for format) or null on error
175 public function getExtendedMetadata() {
176 if ( isset( $this->mInfo
['extmetadata'] ) ) {
177 return $this->mInfo
['extmetadata'];
183 * @param $metadata array
186 public static function parseMetadata( $metadata ) {
187 if ( !is_array( $metadata ) ) {
191 foreach ( $metadata as $meta ) {
192 $ret[$meta['name']] = self
::parseMetadata( $meta['value'] );
198 * @return bool|int|null
200 public function getSize() {
201 return isset( $this->mInfo
['size'] ) ?
intval( $this->mInfo
['size'] ) : null;
205 * @return null|string
207 public function getUrl() {
208 return isset( $this->mInfo
['url'] ) ?
strval( $this->mInfo
['url'] ) : null;
212 * @param string $method
213 * @return int|null|string
215 public function getUser( $method = 'text' ) {
216 return isset( $this->mInfo
['user'] ) ?
strval( $this->mInfo
['user'] ) : null;
220 * @return null|string
222 public function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
223 return isset( $this->mInfo
['comment'] ) ?
strval( $this->mInfo
['comment'] ) : null;
227 * @return null|String
230 return isset( $this->mInfo
['sha1'] )
231 ?
wfBaseConvert( strval( $this->mInfo
['sha1'] ), 16, 36, 31 )
236 * @return bool|Mixed|string
238 function getTimestamp() {
239 return wfTimestamp( TS_MW
,
240 isset( $this->mInfo
['timestamp'] )
241 ?
strval( $this->mInfo
['timestamp'] )
249 function getMimeType() {
250 if ( !isset( $this->mInfo
['mime'] ) ) {
251 $magic = MimeMagic
::singleton();
252 $this->mInfo
['mime'] = $magic->guessTypesForExtension( $this->getExtension() );
254 return $this->mInfo
['mime'];
260 function getMediaType() {
261 if ( isset( $this->mInfo
['mediatype'] ) ) {
262 return $this->mInfo
['mediatype'];
264 $magic = MimeMagic
::singleton();
265 return $magic->getMediaType( null, $this->getMimeType() );
269 * @return bool|string
271 function getDescriptionUrl() {
272 return isset( $this->mInfo
['descriptionurl'] )
273 ?
$this->mInfo
['descriptionurl']
278 * Only useful if we're locally caching thumbs anyway...
279 * @param $suffix string
280 * @return null|string
282 function getThumbPath( $suffix = '' ) {
283 if ( $this->repo
->canCacheThumbs() ) {
284 $path = $this->repo
->getZonePath( 'thumb' ) . '/' . $this->getHashPath( $this->getName() );
286 $path = $path . $suffix . '/';
297 function getThumbnails() {
298 $dir = $this->getThumbPath( $this->getName() );
299 $iter = $this->repo
->getBackend()->getFileList( array( 'dir' => $dir ) );
302 foreach ( $iter as $file ) {
310 * @see File::purgeCache()
312 function purgeCache( $options = array() ) {
313 $this->purgeThumbnails( $options );
314 $this->purgeDescriptionPage();
317 function purgeDescriptionPage() {
318 global $wgMemc, $wgContLang;
320 $url = $this->repo
->getDescriptionRenderUrl( $this->getName(), $wgContLang->getCode() );
321 $key = $this->repo
->getLocalCacheKey( 'RemoteFileDescription', 'url', md5( $url ) );
323 $wgMemc->delete( $key );
327 * @param $options array
329 function purgeThumbnails( $options = array() ) {
332 $key = $this->repo
->getLocalCacheKey( 'ForeignAPIRepo', 'ThumbUrl', $this->getName() );
333 $wgMemc->delete( $key );
335 $files = $this->getThumbnails();
336 // Give media handler a chance to filter the purge list
337 $handler = $this->getHandler();
339 $handler->filterThumbnailPurgeList( $files, $options );
342 $dir = $this->getThumbPath( $this->getName() );
343 $purgeList = array();
344 foreach ( $files as $file ) {
345 $purgeList[] = "{$dir}{$file}";
348 # Delete the thumbnails
349 $this->repo
->quickPurgeBatch( $purgeList );
350 # Clear out the thumbnail directory if empty
351 $this->repo
->quickCleanDir( $dir );