Follow-up r84814: revert redundant summary message addition.
[lhc/web/wiklou.git] / includes / ImageFunctions.php
index c031d7e..8eaebd2 100644 (file)
-<?php\r
-\r
-/**\r
- * Returns the image directory of an image\r
- * If the directory does not exist, it is created.\r
- * The result is an absolute path.\r
- *\r
- * This function is called from thumb.php before Setup.php is included\r
- *\r
- * @param $fname String: file name of the image file.\r
- * @public\r
- */\r
-function wfImageDir( $fname ) {\r
-       global $wgUploadDirectory, $wgHashedUploadDirectory;\r
-\r
-       if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }\r
-\r
-       $hash = md5( $fname );\r
-       $oldumask = umask(0);\r
-       $dest = $wgUploadDirectory . '/' . $hash{0};\r
-       if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }\r
-       $dest .= '/' . substr( $hash, 0, 2 );\r
-       if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }\r
-\r
-       umask( $oldumask );\r
-       return $dest;\r
-}\r
-\r
-/**\r
- * Returns the image directory of an image's thubnail\r
- * If the directory does not exist, it is created.\r
- * The result is an absolute path.\r
- *\r
- * This function is called from thumb.php before Setup.php is included\r
- *\r
- * @param $fname String: file name of the original image file\r
- * @param $shared Boolean: (optional) use the shared upload directory (default: 'false').\r
- * @public\r
- */\r
-function wfImageThumbDir( $fname, $shared = false ) {\r
-       $base = wfImageArchiveDir( $fname, 'thumb', $shared );\r
-       if ( Image::isHashed( $shared ) ) {\r
-               $dir =  "$base/$fname";\r
-\r
-               if ( !is_dir( $base ) ) {\r
-                       $oldumask = umask(0);\r
-                       @mkdir( $base, 0777 );\r
-                       umask( $oldumask );\r
-               }\r
-\r
-               if ( ! is_dir( $dir ) ) {\r
-                       if ( is_file( $dir ) ) {\r
-                               // Old thumbnail in the way of directory creation, kill it\r
-                               unlink( $dir );\r
-                       }\r
-                       $oldumask = umask(0);\r
-                       @mkdir( $dir, 0777 );\r
-                       umask( $oldumask );\r
-               }\r
-       } else {\r
-               $dir = $base;\r
-       }\r
-\r
-       return $dir;\r
-}\r
-\r
-/**\r
- * Old thumbnail directory, kept for conversion\r
- */\r
-function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {\r
-       return wfImageArchiveDir( $thumbName, $subdir, $shared );\r
-}\r
-\r
-/**\r
- * Returns the image directory of an image's old version\r
- * If the directory does not exist, it is created.\r
- * The result is an absolute path.\r
- *\r
- * This function is called from thumb.php before Setup.php is included\r
- *\r
- * @param $fname String: file name of the thumbnail file, including file size prefix.\r
- * @param $subdir String: subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'.\r
- * @param $shared Boolean use the shared upload directory (only relevant for other functions which call this one). Default is 'false'.\r
- * @public\r
- */\r
-function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {\r
-       global $wgUploadDirectory, $wgHashedUploadDirectory;\r
-       global $wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;\r
-       $dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;\r
-       $hashdir = $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;\r
-       if (!$hashdir) { return $dir.'/'.$subdir; }\r
-       $hash = md5( $fname );\r
-       $oldumask = umask(0);\r
-\r
-       # Suppress warning messages here; if the file itself can't\r
-       # be written we'll worry about it then.\r
-       wfSuppressWarnings();\r
-\r
-       $archive = $dir.'/'.$subdir;\r
-       if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }\r
-       $archive .= '/' . $hash{0};\r
-       if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }\r
-       $archive .= '/' . substr( $hash, 0, 2 );\r
-       if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }\r
-\r
-       wfRestoreWarnings();\r
-       umask( $oldumask );\r
-       return $archive;\r
-}\r
-\r
-\r
-/*\r
- * Return the hash path component of an image path (URL or filesystem),\r
- * e.g. "/3/3c/", or just "/" if hashing is not used.\r
- *\r
- * @param $dbkey The filesystem / database name of the file\r
- * @param $fromSharedDirectory Use the shared file repository? It may\r
- *   use different hash settings from the local one.\r
- */\r
-function wfGetHashPath ( $dbkey, $fromSharedDirectory = false ) {\r
-       if( Image::isHashed( $fromSharedDirectory ) ) {\r
-               $hash = md5($dbkey);\r
-               return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';\r
-       } else {\r
-               return '/';\r
-       }\r
-}\r
-\r
-/**\r
- * Returns the image URL of an image's old version\r
- *\r
- * @param $name String: file name of the image file\r
- * @param $subdir String: (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'\r
- * @public\r
- */\r
-function wfImageArchiveUrl( $name, $subdir='archive' ) {\r
-       global $wgUploadPath, $wgHashedUploadDirectory;\r
-\r
-       if ($wgHashedUploadDirectory) {\r
-               $hash = md5( substr( $name, 15) );\r
-               $url = $wgUploadPath.'/'.$subdir.'/' . $hash{0} . '/' .\r
-                 substr( $hash, 0, 2 ) . '/'.$name;\r
-       } else {\r
-               $url = $wgUploadPath.'/'.$subdir.'/'.$name;\r
-       }\r
-       return wfUrlencode($url);\r
-}\r
-\r
-/**\r
- * Return a rounded pixel equivalent for a labeled CSS/SVG length.\r
- * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers\r
- *\r
- * @param $length String: CSS/SVG length.\r
- * @return Integer: length in pixels\r
- */\r
-function wfScaleSVGUnit( $length ) {\r
-       static $unitLength = array(\r
-               'px' => 1.0,\r
-               'pt' => 1.25,\r
-               'pc' => 15.0,\r
-               'mm' => 3.543307,\r
-               'cm' => 35.43307,\r
-               'in' => 90.0,\r
-               ''   => 1.0, // "User units" pixels by default\r
-               '%'  => 2.0, // Fake it!\r
-               );\r
-       if( preg_match( '/^(\d+(?:\.\d+)?)(em|ex|px|pt|pc|cm|mm|in|%|)$/', $length, $matches ) ) {\r
-               $length = floatval( $matches[1] );\r
-               $unit = $matches[2];\r
-               return round( $length * $unitLength[$unit] );\r
-       } else {\r
-               // Assume pixels\r
-               return round( floatval( $length ) );\r
-       }\r
-}\r
-\r
-/**\r
- * Compatible with PHP getimagesize()\r
- * @todo support gzipped SVGZ\r
- * @todo check XML more carefully\r
- * @todo sensible defaults\r
- *\r
- * @param $filename String: full name of the file (passed to php fopen()).\r
- * @return array\r
- */\r
-function wfGetSVGsize( $filename ) {\r
-       $width = 256;\r
-       $height = 256;\r
-\r
-       // Read a chunk of the file\r
-       $f = fopen( $filename, "rt" );\r
-       if( !$f ) return false;\r
-       $chunk = fread( $f, 4096 );\r
-       fclose( $f );\r
-\r
-       // Uber-crappy hack! Run through a real XML parser.\r
-       if( !preg_match( '/<svg\s*([^>]*)\s*>/s', $chunk, $matches ) ) {\r
-               return false;\r
-       }\r
-       $tag = $matches[1];\r
-       if( preg_match( '/\bwidth\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {\r
-               $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );\r
-       }\r
-       if( preg_match( '/\bheight\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {\r
-               $height = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );\r
-       }\r
-\r
-       return array( $width, $height, 'SVG',\r
-               "width=\"$width\" height=\"$height\"" );\r
-}\r
-\r
-/**\r
- * Determine if an image exists on the 'bad image list'.\r
- *\r
- * @param $name String: the image name to check\r
- * @return bool\r
- */\r
-function wfIsBadImage( $name ) {\r
-       static $titleList = false;\r
-       \r
-       if( !$titleList ) {\r
-               # Build the list now\r
-               $titleList = array();\r
-               $lines = explode( "\n", wfMsgForContent( 'bad_image_list' ) );\r
-               foreach( $lines as $line ) {\r
-                       if( preg_match( '/^\*\s*\[\[:?(.*?)\]\]/i', $line, $matches ) ) {\r
-                               $title = Title::newFromText( $matches[1] );\r
-                               if( is_object( $title ) && $title->getNamespace() == NS_IMAGE )\r
-                                       $titleList[ $title->getDBkey() ] = true;\r
-                       }\r
-               }\r
-       }\r
-       return array_key_exists( $name, $titleList );\r
-}\r
-\r
-/**\r
- * Calculate the largest thumbnail width for a given original file size\r
- * such that the thumbnail's height is at most $maxHeight.\r
- * @param $boxWidth Integer Width of the thumbnail box.\r
- * @param $boxHeight Integer Height of the thumbnail box.\r
- * @param $maxHeight Integer Maximum height expected for the thumbnail.\r
- * @return Integer.\r
- */\r
-function wfFitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {\r
-       $idealWidth = $boxWidth * $maxHeight / $boxHeight;\r
-       $roundedUp = ceil( $idealWidth );\r
-       if( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight )\r
-               return floor( $idealWidth );\r
-       else\r
-               return $roundedUp;\r
-}\r
-\r
-\r
-?>\r
+<?php
+/**
+ * Global functions related to images
+ *
+ * @file
+ */
+
+/**
+ * Determine if an image exists on the 'bad image list'.
+ *
+ * The format of MediaWiki:Bad_image_list is as follows:
+ *    * Only list items (lines starting with "*") are considered
+ *    * The first link on a line must be a link to a bad image
+ *    * Any subsequent links on the same line are considered to be exceptions,
+ *      i.e. articles where the image may occur inline.
+ *
+ * @param $name string the image name to check
+ * @param $contextTitle Title: the page on which the image occurs, if known
+ * @return bool
+ */
+function wfIsBadImage( $name, $contextTitle = false ) {
+       static $badImages = false;
+       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 ) {
+               # Build the list now
+               $badImages = array();
+               $lines = explode( "\n", wfMsgForContentNoTrans( 'bad_image_list' ) );
+               foreach( $lines as $line ) {
+                       # List items only
+                       if ( substr( $line, 0, 1 ) !== '*' ) {
+                               continue;
+                       }
+
+                       # Find all links
+                       $m = array();
+                       if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
+                               continue;
+                       }
+
+                       $exceptions = array();
+                       $imageDBkey = false;
+                       foreach ( $m[1] as $i => $titleText ) {
+                               $title = Title::newFromText( $titleText );
+                               if ( !is_null( $title ) ) {
+                                       if ( $i == 0 ) {
+                                               $imageDBkey = $title->getDBkey();
+                                       } else {
+                                               $exceptions[$title->getPrefixedDBkey()] = true;
+                                       }
+                               }
+                       }
+
+                       if ( $imageDBkey !== false ) {
+                               $badImages[$imageDBkey] = $exceptions;
+                       }
+               }
+       }
+
+       $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;
+}