passing thumbnail params to getThumbType, as suggested by TimStarling in a comment...
[lhc/web/wiklou.git] / includes / filerepo / File.php
index 7e222a0..1469668 100644 (file)
@@ -1,15 +1,15 @@
 <?php
 
 /**
- * Implements some public methods and some protected utility functions which 
- * are required by multiple child classes. Contains stub functionality for 
+ * Implements some public methods and some protected utility functions which
+ * are required by multiple child classes. Contains stub functionality for
  * unimplemented public methods.
  *
- * Stub functions which should be overridden are marked with STUB. Some more 
+ * Stub functions which should be overridden are marked with STUB. Some more
  * concrete functions are also typically overridden by child classes.
  *
  * Note that only the repo object knows what its file class is called. You should
- * never name a file class explictly outside of the repo class. Instead use the 
+ * never name a file class explictly outside of the repo class. Instead use the
  * repo's factory functions to generate file objects, for example:
  *
  * RepoGroup::singleton()->getLocalRepo()->newFile($title);
@@ -17,7 +17,7 @@
  * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
  * in most cases.
  *
- * @addtogroup FileRepo
+ * @ingroup FileRepo
  */
 abstract class File {
        const DELETED_FILE = 1;
@@ -28,17 +28,17 @@ abstract class File {
 
        const DELETE_SOURCE = 1;
 
-       /** 
-        * Some member variables can be lazy-initialised using __get(). The 
+       /**
+        * Some member variables can be lazy-initialised using __get(). The
         * initialisation function for these variables is always a function named
-        * like getVar(), where Var is the variable name with upper-case first 
+        * like getVar(), where Var is the variable name with upper-case first
         * letter.
         *
         * The following variables are initialised in this way in this base class:
-        *    name, extension, handler, path, canRender, isSafeFile, 
+        *    name, extension, handler, path, canRender, isSafeFile,
         *    transformScript, hashPath, pageCount, url
         *
-        * Code within this class should generally use the accessor function 
+        * Code within this class should generally use the accessor function
         * directly, since __get() isn't re-entrant and therefore causes bugs that
         * depend on initialisation order.
         */
@@ -46,7 +46,7 @@ abstract class File {
        /**
         * The following member variables are not lazy-initialised
         */
-       var $repo, $title, $lastError;
+       var $repo, $title, $lastError, $redirected, $redirectedTitle;
 
        /**
         * Call this constructor from child classes
@@ -79,7 +79,8 @@ abstract class File {
                        'htm' => 'html',
                        'jpeg' => 'jpg',
                        'mpeg' => 'mpg',
-                       'tiff' => 'tif' );
+                       'tiff' => 'tif',
+                       'ogv' => 'ogg' );
                if( isset( $squish[$lower] ) ) {
                        return $squish[$lower];
                } elseif( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
@@ -89,6 +90,21 @@ abstract class File {
                }
        }
 
+       /**
+        * Checks if file extensions are compatible
+        *
+        * @param $old File Old file
+        * @param $new string New name
+        */
+       static function checkExtensionCompatibility( File $old, $new ) {
+               $oldMime = $old->getMimeType();
+               $n = strrpos( $new, '.' );
+               $newExt = self::normalizeExtension(
+                       $n ? substr( $new, $n + 1 ) : '' );
+               $mimeMagic = MimeMagic::singleton();
+               return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
+       }
+
        /**
         * Upgrade the database row if there is one
         * Called by ImagePage
@@ -110,7 +126,7 @@ abstract class File {
                        return array( $mime, 'unknown' );
                }
        }
-       
+
        /**
         * Return the name of this file
         */
@@ -118,7 +134,7 @@ abstract class File {
                if ( !isset( $this->name ) ) {
                        $this->name = $this->repo->getNameFromTitle( $this->title );
                }
-               return $this->name; 
+               return $this->name;
        }
 
        /**
@@ -127,7 +143,7 @@ abstract class File {
        function getExtension() {
                if ( !isset( $this->extension ) ) {
                        $n = strrpos( $this->getName(), '.' );
-                       $this->extension = self::normalizeExtension( 
+                       $this->extension = self::normalizeExtension(
                                $n ? substr( $this->getName(), $n + 1 ) : '' );
                }
                return $this->extension;
@@ -135,34 +151,37 @@ abstract class File {
 
        /**
         * Return the associated title object
-        * @public
         */
-       function getTitle() { return $this->title; }
+       public function getTitle() { return $this->title; }
+       
+       /**
+        * Return the title used to find this file
+        */
+       public function getOriginalTitle() {
+               if ( $this->redirected )
+                       return $this->getRedirectedTitle();
+               return $this->title;
+       }
 
        /**
         * Return the URL of the file
-        * @public
         */
-       function getUrl() { 
+       public function getUrl() {
                if ( !isset( $this->url ) ) {
                        $this->url = $this->repo->getZoneUrl( 'public' ) . '/' . $this->getUrlRel();
                }
-               return $this->url; 
+               return $this->url;
        }
-       
+
        /**
         * Return a fully-qualified URL to the file.
         * Upload URL paths _may or may not_ be fully qualified, so
         * we check. Local paths are assumed to belong on $wgServer.
-        * @return string
+        *
+        * @return String
         */
        public function getFullUrl() {
-               $url = $this->getUrl();
-               if( substr( $url, 0, 1 ) == '/' ) {
-                       global $wgServer;
-                       return $wgServer . $url;
-               }
-               return $url;
+               return wfExpandUrl( $this->getUrl() );
        }
 
        function getViewURL() {
@@ -188,10 +207,8 @@ abstract class File {
        * or in hashed paths like /images/3/3c.
        *
        * May return false if the file is not locally accessible.
-       *
-       * @public
        */
-       function getPath() {
+       public function getPath() {
                if ( !isset( $this->path ) ) {
                        $this->path = $this->repo->getZonePath('public') . '/' . $this->getRel();
                }
@@ -200,14 +217,13 @@ abstract class File {
 
        /**
        * Alias for getPath()
-       * @public
        */
-       function getFullPath() {
+       public function getFullPath() {
                return $this->getPath();
        }
 
        /**
-        * Return the width of the image. Returns false if the width is unknown 
+        * Return the width of the image. Returns false if the width is unknown
         * or undefined.
         *
         * STUB
@@ -216,7 +232,7 @@ abstract class File {
        public function getWidth( $page = 1 ) { return false; }
 
        /**
-        * Return the height of the image. Returns false if the height is unknown 
+        * Return the height of the image. Returns false if the height is unknown
         * or undefined
         *
         * STUB
@@ -224,6 +240,14 @@ abstract class File {
         */
        public function getHeight( $page = 1 ) { return false; }
 
+       /**
+        * Returns ID or name of user who uploaded the file
+        * STUB
+        *
+        * @param $type string 'text' or 'id'
+        */
+       public function getUser( $type='text' ) { return null; }
+
        /**
         * Get the duration of a media file in seconds
         */
@@ -241,7 +265,14 @@ abstract class File {
         * Overridden by LocalFile, UnregisteredLocalFile
         * STUB
         */
-       function getMetadata() { return false; }
+       public function getMetadata() { return false; }
+
+       /**
+        * Return the bit depth of the file
+        * Overridden by LocalFile
+        * STUB
+        */
+       public function getBitDepth() { return 0; }
 
        /**
         * Return the size of the image file, in bytes
@@ -266,8 +297,8 @@ abstract class File {
        function getMediaType() { return MEDIATYPE_UNKNOWN; }
 
        /**
-        * Checks if the output of transform() for this file is likely 
-        * to be valid. If this is false, various user elements will 
+        * Checks if the output of transform() for this file is likely
+        * to be valid. If this is false, various user elements will
         * display a placeholder instead.
         *
         * Currently, this checks if the file is an image format
@@ -327,7 +358,7 @@ abstract class File {
                }
                return $this->isSafeFile;
        }
-       
+
        /** Accessor for __get() */
        protected function getIsSafeFile() {
                return $this->isSafeFile();
@@ -373,13 +404,24 @@ abstract class File {
         * Returns true if file exists in the repository.
         *
         * Overridden by LocalFile to avoid unnecessary stat calls.
-        * 
+        *
         * @return boolean Whether file exists in the repository.
         */
        public function exists() {
                return $this->getPath() && file_exists( $this->path );
        }
 
+       /**
+        * Returns true if file exists in the repository and can be included in a page.
+        * It would be unsafe to include private images, making public thumbnails inadvertently
+        *
+        * @return boolean Whether file exists in the repository and is includable.
+        * @public
+        */
+       function isVisible() {
+               return $this->exists();
+       }
+
        function getTransformScript() {
                if ( !isset( $this->transformScript ) ) {
                        $this->transformScript = false;
@@ -396,26 +438,21 @@ abstract class File {
        /**
         * Get a ThumbnailImage which is the same size as the source
         */
-       function getUnscaledThumb( $page = false ) {
+       function getUnscaledThumb( $handlerParams = array() ) {
+               $hp =& $handlerParams;
+               $page = isset( $hp['page'] ) ? $hp['page'] : false;
                $width = $this->getWidth( $page );
                if ( !$width ) {
                        return $this->iconThumb();
                }
-               if ( $page ) {
-                       $params = array(
-                               'page' => $page,
-                               'width' => $this->getWidth( $page )
-                       );
-               } else {
-                       $params = array( 'width' => $this->getWidth() );
-               }
-               return $this->transform( $params );
+               $hp['width'] = $width;
+               return $this->transform( $hp );
        }
 
        /**
         * Return the file name of a thumbnail with the specified parameters
         *
-        * @param array $params Handler-specific parameters
+        * @param $params Array: handler-specific parameters
         * @private -ish
         */
        function thumbName( $params ) {
@@ -423,7 +460,7 @@ abstract class File {
                        return null;
                }
                $extension = $this->getExtension();
-               list( $thumbExt, $thumbMime ) = $this->handler->getThumbType( $extension, $this->getMimeType() );
+               list( $thumbExt, $thumbMime ) = $this->handler->getThumbType( $extension, $this->getMimeType(), $params );
                $thumbName = $this->handler->makeParamString( $params ) . '-' . $this->getName();
                if ( $thumbExt != $extension ) {
                        $thumbName .= ".$thumbExt";
@@ -443,8 +480,8 @@ abstract class File {
         * specified, the generated image will be no bigger than width x height,
         * and will also have correct aspect ratio.
         *
-        * @param integer $width        maximum width of the generated thumbnail
-        * @param integer $height       maximum height of the image (optional)
+        * @param $width Integer: maximum width of the generated thumbnail
+        * @param $height Integer: maximum height of the image (optional)
         */
        public function createThumb( $width, $height = -1 ) {
                $params = array( 'width' => $width );
@@ -459,14 +496,13 @@ abstract class File {
        /**
         * As createThumb, but returns a ThumbnailImage object. This can
         * provide access to the actual file, the real size of the thumb,
-        * and can produce a convenient <img> tag for you.
+        * and can produce a convenient \<img\> tag for you.
         *
         * For non-image formats, this may return a filetype-specific icon.
         *
-        * @param integer $width        maximum width of the generated thumbnail
-        * @param integer $height       maximum height of the image (optional)
-        * @param boolean $render       True to render the thumbnail if it doesn't exist,
-        *                              false to just return the URL
+        * @param $width Integer: maximum width of the generated thumbnail
+        * @param $height Integer: maximum height of the image (optional)
+        * @param $render Integer: Deprecated
         *
         * @return ThumbnailImage or null on failure
         *
@@ -477,20 +513,19 @@ abstract class File {
                if ( $height != -1 ) {
                        $params['height'] = $height;
                }
-               $flags = $render ? self::RENDER_NOW : 0;
-               return $this->transform( $params, $flags );
+               return $this->transform( $params, 0 );
        }
 
        /**
         * Transform a media file
         *
-        * @param array $params An associative array of handler-specific parameters. Typical 
-        *                      keys are width, height and page.
-        * @param integer $flags A bitfield, may contain self::RENDER_NOW to force rendering
+        * @param $params Array: an associative array of handler-specific parameters.
+        *                Typical keys are width, height and page.
+        * @param $flags Integer: a bitfield, may contain self::RENDER_NOW to force rendering
         * @return MediaTransformOutput
         */
        function transform( $params, $flags = 0 ) {
-               global $wgUseSquid, $wgIgnoreImageErrors;
+               global $wgUseSquid, $wgIgnoreImageErrors, $wgThumbnailEpoch, $wgServer;
 
                wfProfileIn( __METHOD__ );
                do {
@@ -500,16 +535,24 @@ abstract class File {
                                break;
                        }
 
+                       // Get the descriptionUrl to embed it as comment into the thumbnail. Bug 19791.
+                       $descriptionUrl =  $this->getDescriptionUrl();
+                       if ( $descriptionUrl ) {
+                               $params['descriptionUrl'] = $wgServer . $descriptionUrl;
+                       }
+
                        $script = $this->getTransformScript();
                        if ( $script && !($flags & self::RENDER_NOW) ) {
-                               // Use a script to transform on client request
+                               // Use a script to transform on client request, if possible
                                $thumb = $this->handler->getScriptedTransform( $this, $script, $params );
-                               break;
+                               if( $thumb ) {
+                                       break;
+                               }
                        }
 
                        $normalisedParams = $params;
                        $this->handler->normaliseParams( $this, $normalisedParams );
-                       $thumbName = $this->thumbName( $normalisedParams );     
+                       $thumbName = $this->thumbName( $normalisedParams );
                        $thumbPath = $this->getThumbPath( $thumbName );
                        $thumbUrl = $this->getThumbUrl( $thumbName );
 
@@ -520,9 +563,14 @@ abstract class File {
 
                        wfDebug( __METHOD__.": Doing stat for $thumbPath\n" );
                        $this->migrateThumbFile( $thumbName );
-                       if ( file_exists( $thumbPath ) ) {
-                               $thumb = $this->handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
-                               break;
+                       if ( file_exists( $thumbPath )) {
+                               $thumbTime = filemtime( $thumbPath );
+                               if ( $thumbTime !== FALSE &&
+                                    gmdate( 'YmdHis', $thumbTime ) >= $wgThumbnailEpoch ) { 
+       
+                                       $thumb = $this->handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
+                                       break;
+                               }
                        }
                        $thumb = $this->handler->doTransform( $this, $thumbPath, $thumbUrl, $params );
 
@@ -536,16 +584,19 @@ abstract class File {
                                }
                        }
                        
-                       if ( $wgUseSquid ) {
-                               wfPurgeSquidServers( array( $thumbUrl ) );
+                       // Purge. Useful in the event of Core -> Squid connection failure or squid 
+                       // purge collisions from elsewhere during failure. Don't keep triggering for 
+                       // "thumbs" which have the main image URL though (bug 13776)
+                       if ( $wgUseSquid && ( !$thumb || $thumb->isError() || $thumb->getUrl() != $this->getURL()) ) {
+                               SquidUpdate::purge( array( $thumbUrl ) );
                        }
                } while (false);
 
                wfProfileOut( __METHOD__ );
-               return $thumb;
+               return is_object( $thumb ) ? $thumb : false;
        }
 
-       /** 
+       /**
         * Hook into transform() to allow migration of thumbnail files
         * STUB
         * Overridden by LocalFile
@@ -555,7 +606,7 @@ abstract class File {
        /**
         * Get a MediaHandler instance for this file
         */
-       function getHandler() { 
+       function getHandler() {
                if ( !isset( $this->handler ) ) {
                        $this->handler = MediaHandler::getHandler( $this->getMimeType() );
                }
@@ -600,7 +651,7 @@ abstract class File {
         * STUB
         * Overridden by LocalFile
         */
-       function purgeCache( $archiveFiles = array() ) {}
+       function purgeCache() {}
 
        /**
         * Purge the file description page, but don't go after
@@ -614,7 +665,7 @@ abstract class File {
                        $title->purgeSquid();
                }
        }
-       
+
        /**
         * Purge metadata and all affected pages when the file is created,
         * deleted, or majorly updated.
@@ -633,8 +684,21 @@ abstract class File {
        }
 
        /**
-        * Return the history of this file, line by line. Starts with current version, 
-        * then old versions. Should return an object similar to an image/oldimage 
+        * Return a fragment of the history of file.
+        *
+        * STUB
+        * @param $limit integer Limit of rows to return
+        * @param $start timestamp Only revisions older than $start will be returned
+        * @param $end timestamp Only revisions newer than $end will be returned
+        * @param $inc bool Include the endpoints of the time range
+        */
+       function getHistory($limit = null, $start = null, $end = null, $inc=true) {
+               return array();
+       }
+
+       /**
+        * Return the history of this file, line by line. Starts with current version,
+        * then old versions. Should return an object similar to an image/oldimage
         * database row.
         *
         * STUB
@@ -689,23 +753,18 @@ abstract class File {
                return $path;
        }
 
-       /** Get relative path for a thumbnail file */
-       function getThumbRel( $suffix = false ) {
-               $path = 'thumb/' . $this->getRel();
-               if ( $suffix !== false ) {
-                       $path .= '/' . $suffix;
-               }
-               return $path;
-       }
-
        /** Get the path of the archive directory, or a particular file if $suffix is specified */
        function getArchivePath( $suffix = false ) {
-               return $this->repo->getZonePath('public') . '/' . $this->getArchiveRel();
+               return $this->repo->getZonePath('public') . '/' . $this->getArchiveRel( $suffix );
        }
 
        /** Get the path of the thumbnail directory, or a particular file if $suffix is specified */
        function getThumbPath( $suffix = false ) {
-               return $this->repo->getZonePath('public') . '/' . $this->getThumbRel( $suffix );
+               $path = $this->repo->getZonePath('thumb') . '/' . $this->getRel();
+               if ( $suffix !== false ) {
+                       $path .= '/' . $suffix;
+               }
+               return $path;
        }
 
        /** Get the URL of the archive directory, or a particular file if $suffix is specified */
@@ -721,7 +780,7 @@ abstract class File {
 
        /** Get the URL of the thumbnail directory, or a particular file if $suffix is specified */
        function getThumbUrl( $suffix = false ) {
-               $path = $this->repo->getZoneUrl('public') . '/thumb/' . $this->getUrlRel();
+               $path = $this->repo->getZoneUrl('thumb') . '/' . $this->getUrlRel();
                if ( $suffix !== false ) {
                        $path .= '/' . rawurlencode( $suffix );
                }
@@ -741,7 +800,7 @@ abstract class File {
 
        /** Get the virtual URL for a thumbnail file or directory */
        function getThumbVirtualUrl( $suffix = false ) {
-               $path = $this->repo->getVirtualUrl() . '/public/thumb/' . $this->getUrlRel();
+               $path = $this->repo->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
                if ( $suffix !== false ) {
                        $path .= '/' . rawurlencode( $suffix );
                }
@@ -755,7 +814,7 @@ abstract class File {
                        $path .= '/' . rawurlencode( $suffix );
                }
                return $path;
-       }       
+       }
 
        /**
         * @return bool
@@ -773,25 +832,24 @@ abstract class File {
         * STUB
         * Overridden by LocalFile
         */
-       function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) { 
-               $this->readOnlyError(); 
+       function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) {
+               $this->readOnlyError();
        }
 
        /**
-        * Move or copy a file to its public location. If a file exists at the  
-        * destination, move it to an archive. Returns the archive name on success 
-        * or an empty string if it was a new file, and a wikitext-formatted 
-        * WikiError object on failure. 
+        * Move or copy a file to its public location. If a file exists at the
+        * destination, move it to an archive. Returns a FileRepoStatus object with
+        * the archive name in the "value" member on success.
         *
         * The archive name should be passed through to recordUpload for database
         * registration.
         *
-        * @param string $sourcePath Local filesystem path to the source image
-        * @param integer $flags A bitwise combination of:
-        *     File::DELETE_SOURCE    Delete the source file, i.e. move 
+        * @param $srcPath String: local filesystem path to the source image
+        * @param $flags Integer: a bitwise combination of:
+        *     File::DELETE_SOURCE    Delete the source file, i.e. move
         *         rather than copy
-        * @return The archive name on success or an empty string if it was a new 
-        *     file, and a wikitext-formatted WikiError object on failure. 
+        * @return FileRepoStatus object. On success, the value member contains the
+        *     archive name, or an empty string if it was a new file.
         *
         * STUB
         * Overridden by LocalFile
@@ -808,27 +866,29 @@ abstract class File {
         *
         * @deprecated Use HTMLCacheUpdate, this function uses too much memory
         */
-       function getLinksTo( $options = '' ) {
+       function getLinksTo( $options = array() ) {
                wfProfileIn( __METHOD__ );
 
                // Note: use local DB not repo DB, we want to know local links
-               if ( $options ) {
+               if ( count( $options ) > 0 ) {
                        $db = wfGetDB( DB_MASTER );
                } else {
                        $db = wfGetDB( DB_SLAVE );
                }
-               $linkCache =& LinkCache::singleton();
+               $linkCache = LinkCache::singleton();
 
-               list( $page, $imagelinks ) = $db->tableNamesN( 'page', 'imagelinks' );
                $encName = $db->addQuotes( $this->getName() );
-               $sql = "SELECT page_namespace,page_title,page_id FROM $page,$imagelinks WHERE page_id=il_from AND il_to=$encName $options";
-               $res = $db->query( $sql, __METHOD__ );
+               $res = $db->select( array( 'page', 'imagelinks'), 
+                                                       array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
+                                                       array( 'page_id' => 'il_from', 'il_to' => $encName ),
+                                                       __METHOD__,
+                                                       $options );
 
                $retVal = array();
                if ( $db->numRows( $res ) ) {
                        while ( $row = $db->fetchObject( $res ) ) {
-                               if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
-                                       $linkCache->addGoodLinkObj( $row->page_id, $titleObj );
+                               if ( $titleObj = Title::newFromRow( $row ) ) {
+                                       $linkCache->addGoodLinkObj( $row->page_id, $titleObj, $row->page_len, $row->page_is_redirect, $row->page_latest );
                                        $retVal[] = $titleObj;
                                }
                        }
@@ -850,8 +910,9 @@ abstract class File {
         *
         * @return bool
         */
-       function isLocal() { 
-               return $this->getRepoName() == 'local'; 
+       function isLocal() {
+               $repo = $this->getRepo();
+               return $repo && $repo->isLocal();
        }
 
        /**
@@ -859,8 +920,14 @@ abstract class File {
         *
         * @return string
         */
-       function getRepoName() { 
-               return $this->repo ? $this->repo->getName() : 'unknown'; 
+       function getRepoName() {
+               return $this->repo ? $this->repo->getName() : 'unknown';
+       }
+       /*
+        * Returns the repository
+        */
+       function getRepo() {
+               return $this->repo;
        }
 
        /**
@@ -878,6 +945,14 @@ abstract class File {
        function isDeleted( $field ) {
                return false;
        }
+       
+       /**
+        * Return the deletion bitfield
+        * STUB
+        */     
+       function getVisibility() {
+               return 0;
+       }
 
        /**
         * Was this file ever deleted from the wiki?
@@ -886,9 +961,25 @@ abstract class File {
         */
        function wasDeleted() {
                $title = $this->getTitle();
-               return $title && $title->isDeleted() > 0;
+               return $title && $title->isDeletedQuick();
        }
 
+       /**
+        * Move file to the new title
+        *
+        * Move current, old version and all thumbnails
+        * to the new filename. Old file is deleted.
+        *
+        * Cache purging is done; checks for validity
+        * and logging are caller's responsibility
+        *
+        * @param $target Title New file name
+        * @return FileRepoStatus object.
+        */
+        function move( $target ) {
+               $this->readOnlyError();
+        }
+
        /**
         * Delete all versions of the file.
         *
@@ -897,12 +988,13 @@ abstract class File {
         *
         * Cache purging is done; logging is caller's responsibility.
         *
-        * @param $reason
+        * @param $reason String
+        * @param $suppress Boolean: hide content from sysops?
         * @return true on success, false on some kind of failure
         * STUB
         * Overridden by LocalFile
         */
-       function delete( $reason, $suppress=false ) {
+       function delete( $reason, $suppress = false ) {
                $this->readOnlyError();
        }
 
@@ -914,18 +1006,20 @@ abstract class File {
         *
         * @param $versions set of record ids of deleted items to restore,
         *                    or empty to restore all revisions.
+        * @param $unsuppress remove restrictions on content upon restoration?
         * @return the number of file revisions restored if successful,
         *         or false on failure
         * STUB
         * Overridden by LocalFile
         */
-       function restore( $versions=array(), $Unsuppress=false ) {
+       function restore( $versions=array(), $unsuppress=false ) {
                $this->readOnlyError();
        }
 
        /**
-        * Returns 'true' if this image is a multipage document, e.g. a DJVU
-        * document.
+        * Returns 'true' if this file is a type which supports multiple pages, 
+        * e.g. DJVU or PDF. Note that this may be true even if the file in 
+        * question only has a single page.
         *
         * @return Bool
         */
@@ -959,13 +1053,13 @@ abstract class File {
                        return round( $srcHeight * $dstWidth / $srcWidth );
                }
        }
-       
+
        /**
-        * Get an image size array like that returned by getimagesize(), or false if it 
+        * Get an image size array like that returned by getImageSize(), or false if it
         * can't be determined.
         *
-        * @param string $fileName The filename
-        * @return array
+        * @param $fileName String: The filename
+        * @return Array
         */
        function getImageSize( $fileName ) {
                if ( !$this->getHandler() ) {
@@ -986,28 +1080,52 @@ abstract class File {
         * Get the HTML text of the description page, if available
         */
        function getDescriptionText() {
+               global $wgMemc, $wgLang;
                if ( !$this->repo->fetchDescription ) {
                        return false;
                }
-               $renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName() );
+               $renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName(), $wgLang->getCode() );
                if ( $renderUrl ) {
+                       if ( $this->repo->descriptionCacheExpiry > 0 ) {
+                               wfDebug("Attempting to get the description from cache...");
+                               $key = $this->repo->getLocalCacheKey( 'RemoteFileDescription', 'url', $wgLang->getCode(), 
+                                                                       $this->getName() );
+                               $obj = $wgMemc->get($key);
+                               if ($obj) {
+                                       wfDebug("success!\n");
+                                       return $obj;
+                               }
+                               wfDebug("miss\n");
+                       }
                        wfDebug( "Fetching shared description from $renderUrl\n" );
-                       return Http::get( $renderUrl );
+                       $res = Http::get( $renderUrl );
+                       if ( $res && $this->repo->descriptionCacheExpiry > 0 ) {
+                               $wgMemc->set( $key, $res, $this->repo->descriptionCacheExpiry );
+                       }
+                       return $res;
                } else {
                        return false;
                }
        }
 
+       /**
+        * Get discription of file revision
+        * STUB
+        */
+       function getDescription() {
+               return null;
+       }
+
        /**
         * Get the 14-character timestamp of the file upload, or false if
-        * it doesn't exist 
+        * it doesn't exist
         */
        function getTimestamp() {
                $path = $this->getPath();
                if ( !file_exists( $path ) ) {
                        return false;
                }
-               return wfTimestamp( filemtime( $path ) );
+               return wfTimestamp( TS_MW, filemtime( $path ) );
        }
 
        /**
@@ -1016,13 +1134,26 @@ abstract class File {
        function getSha1() {
                return self::sha1Base36( $this->getPath() );
        }
-       
+
+       /**
+        * Get the deletion archive key, <sha1>.<ext>
+        */
+       function getStorageKey() {
+               $hash = $this->getSha1();
+               if ( !$hash ) {
+                       return false;
+               }
+               $ext = $this->getExtension();
+               $dotExt = $ext === '' ? '' : ".$ext";
+               return $hash . $dotExt;                         
+       }
+
        /**
         * Determine if the current user is allowed to view a particular
         * field of this file, if it's marked as deleted.
         * STUB
-        * @param int $field                                    
-        * @return bool
+        * @param $field Integer
+        * @return Boolean
         */
        function userCan( $field ) {
                return true;
@@ -1031,14 +1162,14 @@ abstract class File {
        /**
         * Get an associative array containing information about a file in the local filesystem.
         *
-        * @param string $path Absolute local filesystem path
-        * @param mixed $ext The file extension, or true to extract it from the filename. 
-        *                   Set it to false to ignore the extension.
+        * @param $path String: absolute local filesystem path
+        * @param $ext Mixed: the file extension, or true to extract it from the filename.
+        *             Set it to false to ignore the extension.
         */
        static function getPropsFromPath( $path, $ext = true ) {
                wfProfileIn( __METHOD__ );
                wfDebug( __METHOD__.": Getting file info for $path\n" );
-               $info = array( 
+               $info = array(
                        'fileExists' => file_exists( $path ) && !is_dir( $path )
                );
                $gis = false;
@@ -1066,7 +1197,7 @@ abstract class File {
 
                        wfDebug(__METHOD__.": $path loaded, {$info['size']} bytes, {$info['mime']}.\n");
                } else {
-                       $info['mime'] = NULL;
+                       $info['mime'] = null;
                        $info['media_type'] = MEDIATYPE_UNKNOWN;
                        $info['metadata'] = '';
                        $info['sha1'] = '';
@@ -1091,8 +1222,8 @@ abstract class File {
        }
 
        /**
-        * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case 
-        * encoding, zero padded to 31 digits. 
+        * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
+        * encoding, zero padded to 31 digits.
         *
         * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
         * fairly neatly.
@@ -1115,7 +1246,7 @@ abstract class File {
                if ( $handler ) {
                        return $handler->getLongDesc( $this );
                } else {
-                       return MediaHandler::getLongDesc( $this );
+                       return MediaHandler::getGeneralLongDesc( $this );
                }
        }
 
@@ -1124,7 +1255,7 @@ abstract class File {
                if ( $handler ) {
                        return $handler->getShortDesc( $this );
                } else {
-                       return MediaHandler::getShortDesc( $this );
+                       return MediaHandler::getGeneralShortDesc( $this );
                }
        }
 
@@ -1136,6 +1267,26 @@ abstract class File {
                        return '';
                }
        }
+
+       function getRedirected() {
+               return $this->redirected;
+       }
+       
+       function getRedirectedTitle() {
+               if ( $this->redirected ) {
+                       if ( !$this->redirectTitle )
+                               $this->redirectTitle = Title::makeTitle( NS_FILE, $this->redirected );
+                       return $this->redirectTitle;
+               }
+       }
+
+       function redirectedFrom( $from ) {
+               $this->redirected = $from;
+       }
+
+       function isMissing() {
+               return false;
+       }
 }
 /**
  * Aliases for backwards compatibility with 1.6
@@ -1144,5 +1295,3 @@ define( 'MW_IMG_DELETED_FILE', File::DELETED_FILE );
 define( 'MW_IMG_DELETED_COMMENT', File::DELETED_COMMENT );
 define( 'MW_IMG_DELETED_USER', File::DELETED_USER );
 define( 'MW_IMG_DELETED_RESTRICTED', File::DELETED_RESTRICTED );
-
-