includes/filerepo/ForeignAPIRepo.php

   1 <?php
   2
   3 /**
   4  * A foreign repository with a remote MediaWiki with an API thingy
   5  * Very hacky and inefficient
   6  * do not use except for testing :D
   7  *
   8  * Example config:
   9  *
  10  * $wgForeignFileRepos[] = array(
  11  *   'class'                  => 'ForeignAPIRepo',
  12  *   'name'                   => 'shared',
  13  *   'apibase'                => 'http://en.wikipedia.org/w/api.php',
  14  *   'fetchDescription'       => true, // Optional
  15  *   'descriptionCacheExpiry' => 3600,
  16  * );
  17  *
  18  * @ingroup FileRepo
  19  */
  20 class ForeignAPIRepo extends FileRepo {
  21         var $fileFactory = array( 'ForeignAPIFile', 'newFromTitle' );
  22         var $apiThumbCacheExpiry = 0;
  23         protected $mQueryCache = array();
  24
  25         function __construct( $info ) {
  26                 parent::__construct( $info );
  27                 $this->mApiBase = $info['apibase']; // http://commons.wikimedia.org/w/api.php
  28                 if( !$this->scriptDirUrl ) {
  29                         // hack for description fetches
  30                         $this->scriptDirUrl = dirname( $this->mApiBase );
  31                 }
  32         }
  33
  34 /**
  35  * No-ops
  36  */
  37         function storeBatch( $triplets, $flags = 0 ) {
  38                 return false;
  39         }
  40         function storeTemp( $originalName, $srcPath ) {
  41                 return false;
  42         }
  43         function publishBatch( $triplets, $flags = 0 ) {
  44                 return false;
  45         }
  46         function deleteBatch( $sourceDestPairs ) {
  47                 return false;
  48         }
  49         function getFileProps( $virtualUrl ) {
  50                 return false;
  51         }
  52
  53         protected function queryImage( $query ) {
  54                 $data = $this->fetchImageQuery( $query );
  55
  56                 if( isset( $data['query']['pages'] ) ) {
  57                         foreach( $data['query']['pages'] as $pageid => $info ) {
  58                                 if( isset( $info['imageinfo'][0] ) ) {
  59                                         return $info['imageinfo'][0];
  60                                 }
  61                         }
  62                 }
  63                 return false;
  64         }
  65
  66         protected function fetchImageQuery( $query ) {
  67                 global $wgMemc;
  68
  69                 $url = $this->mApiBase .
  70                         '?' .
  71                         wfArrayToCgi(
  72                                 array_merge( $query,
  73                                         array(
  74                                                 'format' => 'json',
  75                                                 'action' => 'query',
  76                                                 'prop' => 'imageinfo' ) ) );
  77
  78                 if( !isset( $this->mQueryCache[$url] ) ) {
  79                         $key = wfMemcKey( 'ForeignAPIRepo', 'Metadata', md5( $url ) );
  80                         $data = $wgMemc->get( $key );
  81                         if( !$data ) {
  82                                 $data = Http::get( $url );
  83                                 $wgMemc->set( $key, $data, 3600 );
  84                         }
  85
  86                         if( count( $this->mQueryCache ) > 100 ) {
  87                                 // Keep the cache from growing infinitely
  88                                 $this->mQueryCache = array();
  89                         }
  90                         $this->mQueryCache[$url] = $data;
  91                 }
  92                 return json_decode( $this->mQueryCache[$url], true );
  93         }
  94
  95         function getImageInfo( $title, $time = false ) {
  96                 return $this->queryImage( array(
  97                         'titles' => 'Image:' . $title->getText(),
  98                         'iiprop' => 'timestamp|user|comment|url|size|sha1|metadata|mime' ) );
  99         }
 100
 101         function getThumbUrl( $name, $width=-1, $height=-1 ) {
 102                 $info = $this->queryImage( array(
 103                         'titles' => 'Image:' . $name,
 104                         'iiprop' => 'url',
 105                         'iiurlwidth' => $width,
 106                         'iiurlheight' => $height ) );
 107                 if( $info ) {
 108                         wfDebug( __METHOD__ . " got remote thumb " . $info['thumburl'] . "\n" );
 109                         return $info['thumburl'];
 110                 } else {
 111                         return false;
 112                 }
 113         }
 114
 115         function getThumbUrlFromCache( $name, $width, $height ) {
 116                 global $wgMemc, $wgUploadPath, $wgServer, $wgUploadDirectory;
 117
 118                 if ( !$this->canCacheThumbs() ) {
 119                         return $this->getThumbUrl( $name, $width, $height );
 120                 }
 121
 122                 $key = wfMemcKey( 'ForeignAPIRepo', 'ThumbUrl', $name );
 123                 if ( $thumbUrl = $wgMemc->get($key) ) {
 124                         wfDebug("Got thumb from local cache. $thumbUrl \n");
 125                         return $thumbUrl;
 126                 }
 127                 else {
 128                         $foreignUrl = $this->getThumbUrl( $name, $width, $height );
 129
 130                         // We need the same filename as the remote one :)
 131                         $fileName = ltrim( substr( $foreignUrl, strrpos( $foreignUrl, '/' ),
 132                                                                 strlen ( $foreignUrl ) ), '/' );
 133                         $path = 'thumb/' . $this->getHashPath( $this->getName() );
 134                         if ( !is_dir($wgUploadDirectory . '/' . $path) ) {
 135                                 wfMkdirParents($wgUploadDirectory . '/' . $path);
 136                         }
 137
 138                         $localUrl =  $wgServer . $wgUploadPath . '/' . $path . $fileName;
 139                         $thumb = Http::get( $foreignUrl );
 140                         # FIXME: Delete old thumbs that aren't being used. Maintenance script?
 141                         file_put_contents($wgUploadDirectory . '/' . $path . $fileName, $thumb );
 142                         $wgMemc->set( $key, $localUrl, $this->apiThumbCacheExpiry );
 143                         wfDebug( __METHOD__ . " got local thumb $localUrl, saving to cache \n" );
 144                         return $localUrl;
 145                 }
 146         }
 147
 148         /**
 149          * Are we locally caching the thumbnails?
 150          * @return bool
 151          */
 152         public function canCacheThumbs() {
 153                 return ( $this->apiThumbCacheExpiry > 0 );
 154         }
 155 }