Fix fixme on r107328, attempting to use $this in a static method
[lhc/web/wiklou.git] / includes / ImageFunctions.php
index 931fdff..4b90e24 100644 (file)
@@ -1,177 +1,9 @@
 <?php
-
-/**
- * Returns the image directory of an image
- * The result is an absolute path.
- *
- * This function is called from thumb.php before Setup.php is included
- *
- * @param $fname String: file name of the image file.
- * @public
- */
-function wfImageDir( $fname ) {
-       global $wgUploadDirectory, $wgHashedUploadDirectory;
-
-       if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
-
-       $hash = md5( $fname );
-       $dest = $wgUploadDirectory . '/' . $hash{0} . '/' . substr( $hash, 0, 2 );
-
-       return $dest;
-}
-
-/**
- * Returns the image directory of an image's thubnail
- * The result is an absolute path.
- *
- * This function is called from thumb.php before Setup.php is included
- *
- * @param $fname String: file name of the original image file
- * @param $shared Boolean: (optional) use the shared upload directory (default: 'false').
- * @public
- */
-function wfImageThumbDir( $fname, $shared = false ) {
-       $base = wfImageArchiveDir( $fname, 'thumb', $shared );
-       if ( Image::isHashed( $shared ) ) {
-               $dir =  "$base/$fname";
-       } else {
-               $dir = $base;
-       }
-
-       return $dir;
-}
-
-/**
- * Old thumbnail directory, kept for conversion
- */
-function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {
-       return wfImageArchiveDir( $thumbName, $subdir, $shared );
-}
-
 /**
- * Returns the image directory of an image's old version
- * The result is an absolute path.
+ * Global functions related to images
  *
- * This function is called from thumb.php before Setup.php is included
- *
- * @param $fname String: file name of the thumbnail file, including file size prefix.
- * @param $subdir String: subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'.
- * @param $shared Boolean use the shared upload directory (only relevant for other functions which call this one). Default is 'false'.
- * @public
+ * @file
  */
-function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
-       global $wgUploadDirectory, $wgHashedUploadDirectory;
-       global $wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;
-       $dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;
-       $hashdir = $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
-       if (!$hashdir) { return $dir.'/'.$subdir; }
-       $hash = md5( $fname );
-
-       return $dir.'/'.$subdir.'/'.$hash[0].'/'.substr( $hash, 0, 2 );
-}
-
-
-/*
- * Return the hash path component of an image path (URL or filesystem),
- * e.g. "/3/3c/", or just "/" if hashing is not used.
- *
- * @param $dbkey The filesystem / database name of the file
- * @param $fromSharedDirectory Use the shared file repository? It may
- *   use different hash settings from the local one.
- */
-function wfGetHashPath ( $dbkey, $fromSharedDirectory = false ) {
-       if( Image::isHashed( $fromSharedDirectory ) ) {
-               $hash = md5($dbkey);
-               return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
-       } else {
-               return '/';
-       }
-}
-
-/**
- * Returns the image URL of an image's old version
- *
- * @param $name String: file name of the image file
- * @param $subdir String: (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'
- * @public
- */
-function wfImageArchiveUrl( $name, $subdir='archive' ) {
-       global $wgUploadPath, $wgHashedUploadDirectory;
-
-       if ($wgHashedUploadDirectory) {
-               $hash = md5( substr( $name, 15) );
-               $url = $wgUploadPath.'/'.$subdir.'/' . $hash{0} . '/' .
-                 substr( $hash, 0, 2 ) . '/'.$name;
-       } else {
-               $url = $wgUploadPath.'/'.$subdir.'/'.$name;
-       }
-       return wfUrlencode($url);
-}
-
-/**
- * Return a rounded pixel equivalent for a labeled CSS/SVG length.
- * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
- *
- * @param $length String: CSS/SVG length.
- * @return Integer: length in pixels
- */
-function wfScaleSVGUnit( $length ) {
-       static $unitLength = array(
-               'px' => 1.0,
-               'pt' => 1.25,
-               'pc' => 15.0,
-               'mm' => 3.543307,
-               'cm' => 35.43307,
-               'in' => 90.0,
-               ''   => 1.0, // "User units" pixels by default
-               '%'  => 2.0, // Fake it!
-               );
-       $matches = array();
-       if( preg_match( '/^(\d+(?:\.\d+)?)(em|ex|px|pt|pc|cm|mm|in|%|)$/', $length, $matches ) ) {
-               $length = floatval( $matches[1] );
-               $unit = $matches[2];
-               return round( $length * $unitLength[$unit] );
-       } else {
-               // Assume pixels
-               return round( floatval( $length ) );
-       }
-}
-
-/**
- * Compatible with PHP getimagesize()
- * @todo support gzipped SVGZ
- * @todo check XML more carefully
- * @todo sensible defaults
- *
- * @param $filename String: full name of the file (passed to php fopen()).
- * @return array
- */
-function wfGetSVGsize( $filename ) {
-       $width = 256;
-       $height = 256;
-
-       // Read a chunk of the file
-       $f = fopen( $filename, "rt" );
-       if( !$f ) return false;
-       $chunk = fread( $f, 4096 );
-       fclose( $f );
-
-       // Uber-crappy hack! Run through a real XML parser.
-       $matches = array();
-       if( !preg_match( '/<svg\s*([^>]*)\s*>/s', $chunk, $matches ) ) {
-               return false;
-       }
-       $tag = $matches[1];
-       if( preg_match( '/\bwidth\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
-               $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
-       }
-       if( preg_match( '/\bheight\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
-               $height = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
-       }
-
-       return array( $width, $height, 'SVG',
-               "width=\"$width\" height=\"$height\"" );
-}
 
 /**
  * Determine if an image exists on the 'bad image list'.
@@ -182,25 +14,38 @@ function wfGetSVGsize( $filename ) {
  *    * Any subsequent links on the same line are considered to be exceptions,
  *      i.e. articles where the image may occur inline.
  *
- * @param string $name the image name to check
- * @param Title $contextTitle The page on which the image occurs, if known
+ * @param $name string the image name to check
+ * @param $contextTitle Title|bool the page on which the image occurs, if known
+ * @param $blacklist string wikitext of a file blacklist
  * @return bool
  */
-function wfIsBadImage( $name, $contextTitle = false ) {
-       static $badImages = false;
+function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
+       static $badImageCache = null; // based on bad_image_list msg
        wfProfileIn( __METHOD__ );
 
+       # Handle redirects
+       $redirectTitle = RepoGroup::singleton()->checkRedirect( Title::makeTitle( NS_FILE, $name ) );
+       if( $redirectTitle ) {
+               $name = $redirectTitle->getDbKey();
+       }
+
        # Run the extension hook
        $bad = false;
        if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
                wfProfileOut( __METHOD__ );
                return $bad;
        }
-
-       if( !$badImages ) {
+       $cacheable = ( $blacklist === null );
+       if( $cacheable && $badImageCache !== null ) {
+               $badImages = $badImageCache;
+       } else { // cache miss
+               if ( $blacklist === null ) {
+                       $blacklist = wfMsgForContentNoTrans( 'bad_image_list' ); // site list
+               }
                # Build the list now
                $badImages = array();
-               $lines = explode( "\n", wfMsgForContentNoTrans( 'bad_image_list' ) );
+               $lines = explode( "\n", $blacklist );
                foreach( $lines as $line ) {
                        # List items only
                        if ( substr( $line, 0, 1 ) !== '*' ) {
@@ -230,30 +75,13 @@ function wfIsBadImage( $name, $contextTitle = false ) {
                                $badImages[$imageDBkey] = $exceptions;
                        }
                }
+               if ( $cacheable ) {
+                       $badImageCache = $badImages;
+               }
        }
-       
+
        $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
        $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
        wfProfileOut( __METHOD__ );
        return $bad;
 }
-
-/**
- * Calculate the largest thumbnail width for a given original file size
- * such that the thumbnail's height is at most $maxHeight.
- * @param $boxWidth Integer Width of the thumbnail box.
- * @param $boxHeight Integer Height of the thumbnail box.
- * @param $maxHeight Integer Maximum height expected for the thumbnail.
- * @return Integer.
- */
-function wfFitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
-       $idealWidth = $boxWidth * $maxHeight / $boxHeight;
-       $roundedUp = ceil( $idealWidth );
-       if( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight )
-               return floor( $idealWidth );
-       else
-               return $roundedUp;
-}
-
-
-?>