<?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);
* The convenience functions wfLocalFile() and wfFindFile() should be sufficient
* in most cases.
*
- * @addtogroup FileRepo
+ * @ingroup FileRepo
*/
abstract class File {
const DELETED_FILE = 1;
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.
*/
/**
* The following member variables are not lazy-initialised
*/
- var $repo, $title, $lastError, $redirected;
+ var $repo, $title, $lastError, $redirected, $redirectedTitle;
/**
* Call this constructor from child classes
'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 ) ) {
}
}
+ /**
+ * 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
return array( $mime, 'unknown' );
}
}
-
+
/**
* Return the name of this file
*/
if ( !isset( $this->name ) ) {
$this->name = $this->repo->getNameFromTitle( $this->title );
}
- return $this->name;
+ return $this->name;
}
/**
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;
* Return the associated title object
*/
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
}
/**
- * 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
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
* 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
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
}
return $this->isSafeFile;
}
-
+
/** Accessor for __get() */
protected function getIsSafeFile() {
return $this->isSafeFile();
* 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 boolean Whether file exists in the repository and is includable.
* @public
*/
- function isVisible() {
+ function isVisible() {
return $this->exists();
}
*
* @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 boolean $render Deprecated
*
* @return ThumbnailImage or null on failure
*
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
+ * @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
* @return MediaTransformOutput
$normalisedParams = $params;
$this->handler->normaliseParams( $this, $normalisedParams );
- $thumbName = $this->thumbName( $normalisedParams );
+ $thumbName = $this->thumbName( $normalisedParams );
$thumbPath = $this->getThumbPath( $thumbName );
$thumbUrl = $this->getThumbUrl( $thumbName );
-
+
if ( $this->repo->canTransformVia404() && !($flags & self::RENDER_NOW ) ) {
$thumb = $this->handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
break;
}
}
- if ( $wgUseSquid ) {
+ // 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);
return $thumb;
}
- /**
+ /**
* Hook into transform() to allow migration of thumbnail files
* STUB
* Overridden by LocalFile
/**
* Get a MediaHandler instance for this file
*/
- function getHandler() {
+ function getHandler() {
if ( !isset( $this->handler ) ) {
$this->handler = MediaHandler::getHandler( $this->getMimeType() );
}
$title->purgeSquid();
}
}
-
+
/**
* Purge metadata and all affected pages when the file is created,
* deleted, or majorly updated.
* @param $end timestamp Only revisions newer than $end will be returned
*/
function getHistory($limit = null, $start = null, $end = null) {
- return false;
+ 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
+ * 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
$path .= '/' . rawurlencode( $suffix );
}
return $path;
- }
+ }
/**
* @return bool
* 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 the archive name on success
+ * or an empty string if it was a new file, and a wikitext-formatted
+ * WikiError object on failure.
*
* 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
+ * 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 The archive name on success or an empty string if it was a new
+ * file, and a wikitext-formatted WikiError object on failure.
*
* STUB
* Overridden by LocalFile
} 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";
+ $sql = "SELECT page_namespace,page_title,page_id,page_len,page_is_redirect,
+ FROM $page,$imagelinks WHERE page_id=il_from AND il_to=$encName $options";
$res = $db->query( $sql, __METHOD__ );
$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 );
$retVal[] = $titleObj;
}
}
*
* @return bool
*/
- function isLocal() {
- return $this->getRepoName() == 'local';
+ function isLocal() {
+ return $this->getRepoName() == 'local';
}
/**
*
* @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;
}
/**
return $title && $title->isDeleted() > 0;
}
+ /**
+ * 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.
*
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
* Get the HTML text of the description page, if available
*/
function getDescriptionText() {
+ global $wgMemc;
if ( !$this->repo->fetchDescription ) {
return false;
}
$renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName() );
if ( $renderUrl ) {
+ if ( $this->repo->descriptionCacheExpiry > 0 ) {
+ wfDebug("Attempting to get the description from cache...");
+ $key = wfMemcKey( 'RemoteFileDescription', 'url', md5($renderUrl) );
+ $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 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 ) );
}
/**
function getSha1() {
return self::sha1Base36( $this->getPath() );
}
-
+
/**
* 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
+ * @param int $field
* @return bool
*/
function userCan( $field ) {
* 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.
+ * @param mixed $ext 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;
}
/**
- * 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.
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;
define( 'MW_IMG_DELETED_COMMENT', File::DELETED_COMMENT );
define( 'MW_IMG_DELETED_USER', File::DELETED_USER );
define( 'MW_IMG_DELETED_RESTRICTED', File::DELETED_RESTRICTED );
-
-
dépôts / lhc / web / wiklou.git / blobdiff