includes/filerepo/ForeignAPIFile.php

   1 <?php
   2 /**
   3  * Foreign file accessible through api.php requests.
   4  *
   5  * @file
   6  * @ingroup FileRepo
   7  */
   8
   9 /**
  10  * Foreign file accessible through api.php requests.
  11  * Very hacky and inefficient, do not use :D
  12  *
  13  * @ingroup FileRepo
  14  */
  15 class ForeignAPIFile extends File {
  16
  17         private $mExists;
  18
  19         function __construct( $title, $repo, $info, $exists = false ) {
  20                 parent::__construct( $title, $repo );
  21                 $this->mInfo = $info;
  22                 $this->mExists = $exists;
  23         }
  24
  25         /**
  26          * @static
  27          * @param  $title Title
  28          * @param  $repo ForeignApiRepo
  29          * @return ForeignAPIFile|null
  30          */
  31         static function newFromTitle( $title, $repo ) {
  32                 $data = $repo->fetchImageQuery( array(
  33                         'titles' => 'File:' . $title->getDBKey(),
  34                         'iiprop' => self::getProps(),
  35                         'prop' => 'imageinfo' ) );
  36
  37                 $info = $repo->getImageInfo( $data );
  38
  39                 if( $info ) {
  40                         $lastRedirect = isset( $data['query']['redirects'] )
  41                                 ? count( $data['query']['redirects'] ) - 1
  42                                 : -1;
  43                         if( $lastRedirect >= 0 ) {
  44                                 $newtitle = Title::newFromText( $data['query']['redirects'][$lastRedirect]['to']);
  45                                 $img = new ForeignAPIFile( $newtitle, $repo, $info, true );
  46                                 if( $img ) {
  47                                         $img->redirectedFrom( $title->getDBkey() );
  48                                 }
  49                         } else {
  50                                 $img = new ForeignAPIFile( $title, $repo, $info, true );
  51                         }
  52                         return $img;
  53                 } else {
  54                         return null;
  55                 }
  56         }
  57
  58         /**
  59          * Get the property string for iiprop and aiprop
  60          */
  61         static function getProps() {
  62                 return 'timestamp|user|comment|url|size|sha1|metadata|mime';
  63         }
  64
  65         // Dummy functions...
  66         public function exists() {
  67                 return $this->mExists;
  68         }
  69
  70         public function getPath() {
  71                 return false;
  72         }
  73
  74         function transform( $params, $flags = 0 ) {
  75                 if( !$this->canRender() ) {
  76                         // show icon
  77                         return parent::transform( $params, $flags );
  78                 }
  79
  80                 $otherParams = "";
  81                 // Not using implode, since associative array.
  82                 foreach ( $params as $name => $value ) {
  83                         if ( $name === 'width' || $name === 'height' ) {
  84                                 continue;
  85                         }
  86                         $otherParams .= "{$name}={$value}|";
  87                 }
  88                 // Remove the last |
  89                 if ( $otherParams !== "" ) {
  90                         $otherParams = substr( $otherParams, 0, -1 );
  91                 }
  92
  93                 $thumbUrl = $this->repo->getThumbUrlFromCache(
  94                         $this->getName(),
  95                         isset( $params['width'] ) ? $params['width'] : -1,
  96                         isset( $params['height'] ) ? $params['height'] : -1,
  97                         $otherParams );
  98                 return $this->handler->getTransform( $this, 'bogus', $thumbUrl, $params );
  99         }
 100
 101         // Info we can get from API...
 102         public function getWidth( $page = 1 ) {
 103                 return intval( @$this->mInfo['width'] );
 104         }
 105
 106         public function getHeight( $page = 1 ) {
 107                 return intval( @$this->mInfo['height'] );
 108         }
 109
 110         public function getMetadata() {
 111                 if ( isset( $this->mInfo['metadata'] ) ) {
 112                         return serialize( self::parseMetadata( $this->mInfo['metadata'] ) );
 113                 }
 114                 return null;
 115         }
 116
 117         public static function parseMetadata( $metadata ) {
 118                 if( !is_array( $metadata ) ) {
 119                         return $metadata;
 120                 }
 121                 $ret = array();
 122                 foreach( $metadata as $meta ) {
 123                         $ret[ $meta['name'] ] = self::parseMetadata( $meta['value'] );
 124                 }
 125                 return $ret;
 126         }
 127
 128         public function getSize() {
 129                 return isset( $this->mInfo['size'] ) ? intval( $this->mInfo['size'] ) : null;
 130         }
 131
 132         public function getUrl() {
 133                 return isset( $this->mInfo['url'] ) ? strval( $this->mInfo['url'] ) : null;
 134         }
 135
 136         public function getUser( $method='text' ) {
 137                 return isset( $this->mInfo['user'] ) ? strval( $this->mInfo['user'] ) : null;
 138         }
 139
 140         public function getDescription() {
 141                 return isset( $this->mInfo['comment'] ) ? strval( $this->mInfo['comment'] ) : null;
 142         }
 143
 144         function getSha1() {
 145                 return isset( $this->mInfo['sha1'] ) ?
 146                         wfBaseConvert( strval( $this->mInfo['sha1'] ), 16, 36, 31 ) :
 147                         null;
 148         }
 149
 150         function getTimestamp() {
 151                 return wfTimestamp( TS_MW,
 152                         isset( $this->mInfo['timestamp'] ) ?
 153                         strval( $this->mInfo['timestamp'] ) :
 154                         null
 155                 );
 156         }
 157
 158         function getMimeType() {
 159                 if( !isset( $this->mInfo['mime'] ) ) {
 160                         $magic = MimeMagic::singleton();
 161                         $this->mInfo['mime'] = $magic->guessTypesForExtension( $this->getExtension() );
 162                 }
 163                 return $this->mInfo['mime'];
 164         }
 165
 166         /// @todo Fixme: may guess wrong on file types that can be eg audio or video
 167         function getMediaType() {
 168                 $magic = MimeMagic::singleton();
 169                 return $magic->getMediaType( null, $this->getMimeType() );
 170         }
 171
 172         function getDescriptionUrl() {
 173                 return isset( $this->mInfo['descriptionurl'] )
 174                         ? $this->mInfo['descriptionurl']
 175                         : false;
 176         }
 177
 178         /**
 179          * Only useful if we're locally caching thumbs anyway...
 180          */
 181         function getThumbPath( $suffix = '' ) {
 182                 if ( $this->repo->canCacheThumbs() ) {
 183                         $path = $this->repo->getZonePath('thumb') . '/' . $this->getHashPath( $this->getName() );
 184                         if ( $suffix ) {
 185                                 $path = $path . $suffix . '/';
 186                         }
 187                         return $path;
 188                 } else {
 189                         return null;
 190                 }
 191         }
 192
 193         function getThumbnails() {
 194                 $files = array();
 195                 $dir = $this->getThumbPath( $this->getName() );
 196                 if ( is_dir( $dir ) ) {
 197                         $handle = opendir( $dir );
 198                         if ( $handle ) {
 199                                 while ( false !== ( $file = readdir($handle) ) ) {
 200                                         if ( $file{0} != '.'  ) {
 201                                                 $files[] = $file;
 202                                         }
 203                                 }
 204                                 closedir( $handle );
 205                         }
 206                 }
 207                 return $files;
 208         }
 209
 210         function purgeCache() {
 211                 $this->purgeThumbnails();
 212                 $this->purgeDescriptionPage();
 213         }
 214
 215         function purgeDescriptionPage() {
 216                 global $wgMemc, $wgContLang;
 217                 $url = $this->repo->getDescriptionRenderUrl( $this->getName(), $wgContLang->getCode() );
 218                 $key = $this->repo->getLocalCacheKey( 'RemoteFileDescription', 'url', md5($url) );
 219                 $wgMemc->delete( $key );
 220         }
 221
 222         function purgeThumbnails() {
 223                 global $wgMemc;
 224                 $key = $this->repo->getLocalCacheKey( 'ForeignAPIRepo', 'ThumbUrl', $this->getName() );
 225                 $wgMemc->delete( $key );
 226                 $files = $this->getThumbnails();
 227                 $dir = $this->getThumbPath( $this->getName() );
 228                 foreach ( $files as $file ) {
 229                         unlink( $dir . $file );
 230                 }
 231                 if ( is_dir( $dir ) ) {
 232                         rmdir( $dir ); // Might have already gone away, spews errors if we don't.
 233                 }
 234         }
 235 }