Merge "Implement routing for HTCP purges"
[lhc/web/wiklou.git] / includes / ImageFunctions.php
index cbe3fe4..4b90e24 100644 (file)
@@ -1,68 +1,9 @@
 <?php
 /**
- * Return a rounded pixel equivalent for a labeled CSS/SVG length.
- * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
+ * Global functions related to images
  *
- * @param $length String: CSS/SVG length.
- * @return Integer: length in pixels
+ * @file
  */
-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( '/(?:^|\s)width\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
-               $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
-       }
-       if( preg_match( '/(?:^|\s)height\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'.
@@ -73,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 ) !== '*' ) {
@@ -121,6 +75,9 @@ function wfIsBadImage( $name, $contextTitle = false ) {
                                $badImages[$imageDBkey] = $exceptions;
                        }
                }
+               if ( $cacheable ) {
+                       $badImageCache = $badImages;
+               }
        }
 
        $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
@@ -128,20 +85,3 @@ function wfIsBadImage( $name, $contextTitle = false ) {
        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;
-}