Minimal version of IC functionality.
[lhc/web/wiklou.git] / includes / ImageFunctions.php
1 <?php
2
3 /**
4 * Returns the image directory of an image
5 * The result is an absolute path.
6 *
7 * This function is called from thumb.php before Setup.php is included
8 *
9 * @param $fname String: file name of the image file.
10 * @public
11 */
12 function wfImageDir( $fname ) {
13 global $wgUploadDirectory, $wgHashedUploadDirectory;
14
15 if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
16
17 $hash = md5( $fname );
18 $dest = $wgUploadDirectory . '/' . $hash{0} . '/' . substr( $hash, 0, 2 );
19
20 return $dest;
21 }
22
23 /**
24 * Returns the image directory of an image's thubnail
25 * The result is an absolute path.
26 *
27 * This function is called from thumb.php before Setup.php is included
28 *
29 * @param $fname String: file name of the original image file
30 * @param $shared Boolean: (optional) use the shared upload directory (default: 'false').
31 * @public
32 */
33 function wfImageThumbDir( $fname, $shared = false ) {
34 $base = wfImageArchiveDir( $fname, 'thumb', $shared );
35 if ( Image::isHashed( $shared ) ) {
36 $dir = "$base/$fname";
37 } else {
38 $dir = $base;
39 }
40
41 return $dir;
42 }
43
44 /**
45 * Old thumbnail directory, kept for conversion
46 */
47 function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {
48 return wfImageArchiveDir( $thumbName, $subdir, $shared );
49 }
50
51 /**
52 * Returns the image directory of an image's old version
53 * The result is an absolute path.
54 *
55 * This function is called from thumb.php before Setup.php is included
56 *
57 * @param $fname String: file name of the thumbnail file, including file size prefix.
58 * @param $subdir String: subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'.
59 * @param $shared Boolean use the shared upload directory (only relevant for other functions which call this one). Default is 'false'.
60 * @public
61 */
62 function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
63 global $wgUploadDirectory, $wgHashedUploadDirectory;
64 global $wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;
65 $dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;
66 $hashdir = $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
67 if (!$hashdir) { return $dir.'/'.$subdir; }
68 $hash = md5( $fname );
69
70 return $dir.'/'.$subdir.'/'.$hash[0].'/'.substr( $hash, 0, 2 );
71 }
72
73
74 /*
75 * Return the hash path component of an image path (URL or filesystem),
76 * e.g. "/3/3c/", or just "/" if hashing is not used.
77 *
78 * @param $dbkey The filesystem / database name of the file
79 * @param $fromSharedDirectory Use the shared file repository? It may
80 * use different hash settings from the local one.
81 * TODO:@param $fromInstantCommons Use the InstantCommons repository? - this is calculated by the IC Api
82 */
83 function wfGetHashPath ( $dbkey, $fromSharedDirectory = false, $fromInstantCommons = false ) {
84 if($fromInstantCommons)
85 {//we will display a local image that indicates that this file is being downloaded
86 return;
87 }
88 elseif( Image::isHashed( $fromSharedDirectory ) ) {
89 $hash = md5($dbkey);
90 return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
91 } else {
92 return '/';
93 }
94 }
95
96 /**
97 * Returns the image URL of an image's old version
98 *
99 * @param $name String: file name of the image file
100 * @param $subdir String: (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'
101 * @public
102 */
103 function wfImageArchiveUrl( $name, $subdir='archive' ) {
104 global $wgUploadPath, $wgHashedUploadDirectory;
105
106 if ($wgHashedUploadDirectory) {
107 $hash = md5( substr( $name, 15) );
108 $url = $wgUploadPath.'/'.$subdir.'/' . $hash{0} . '/' .
109 substr( $hash, 0, 2 ) . '/'.$name;
110 } else {
111 $url = $wgUploadPath.'/'.$subdir.'/'.$name;
112 }
113 return wfUrlencode($url);
114 }
115
116 /**
117 * Return a rounded pixel equivalent for a labeled CSS/SVG length.
118 * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
119 *
120 * @param $length String: CSS/SVG length.
121 * @return Integer: length in pixels
122 */
123 function wfScaleSVGUnit( $length ) {
124 static $unitLength = array(
125 'px' => 1.0,
126 'pt' => 1.25,
127 'pc' => 15.0,
128 'mm' => 3.543307,
129 'cm' => 35.43307,
130 'in' => 90.0,
131 '' => 1.0, // "User units" pixels by default
132 '%' => 2.0, // Fake it!
133 );
134 $matches = array();
135 if( preg_match( '/^(\d+(?:\.\d+)?)(em|ex|px|pt|pc|cm|mm|in|%|)$/', $length, $matches ) ) {
136 $length = floatval( $matches[1] );
137 $unit = $matches[2];
138 return round( $length * $unitLength[$unit] );
139 } else {
140 // Assume pixels
141 return round( floatval( $length ) );
142 }
143 }
144
145 /**
146 * Compatible with PHP getimagesize()
147 * @todo support gzipped SVGZ
148 * @todo check XML more carefully
149 * @todo sensible defaults
150 *
151 * @param $filename String: full name of the file (passed to php fopen()).
152 * @return array
153 */
154 function wfGetSVGsize( $filename ) {
155 $width = 256;
156 $height = 256;
157
158 // Read a chunk of the file
159 $f = fopen( $filename, "rt" );
160 if( !$f ) return false;
161 $chunk = fread( $f, 4096 );
162 fclose( $f );
163
164 // Uber-crappy hack! Run through a real XML parser.
165 $matches = array();
166 if( !preg_match( '/<svg\s*([^>]*)\s*>/s', $chunk, $matches ) ) {
167 return false;
168 }
169 $tag = $matches[1];
170 if( preg_match( '/\bwidth\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
171 $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
172 }
173 if( preg_match( '/\bheight\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
174 $height = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
175 }
176
177 return array( $width, $height, 'SVG',
178 "width=\"$width\" height=\"$height\"" );
179 }
180
181 /**
182 * Determine if an image exists on the 'bad image list'.
183 *
184 * The format of MediaWiki:Bad_image_list is as follows:
185 * * Only list items (lines starting with "*") are considered
186 * * The first link on a line must be a link to a bad image
187 * * Any subsequent links on the same line are considered to be exceptions,
188 * i.e. articles where the image may occur inline.
189 *
190 * @param string $name the image name to check
191 * @param Title $contextTitle The page on which the image occurs, if known
192 * @return bool
193 */
194 function wfIsBadImage( $name, $contextTitle = false ) {
195 static $badImages = false;
196 wfProfileIn( __METHOD__ );
197
198 # Run the extension hook
199 $bad = false;
200 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
201 wfProfileOut( __METHOD__ );
202 return $bad;
203 }
204
205 if( !$badImages ) {
206 # Build the list now
207 $badImages = array();
208 $lines = explode( "\n", wfMsgForContentNoTrans( 'bad_image_list' ) );
209 foreach( $lines as $line ) {
210 # List items only
211 if ( substr( $line, 0, 1 ) !== '*' ) {
212 continue;
213 }
214
215 # Find all links
216 $m = array();
217 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
218 continue;
219 }
220
221 $exceptions = array();
222 $imageDBkey = false;
223 foreach ( $m[1] as $i => $titleText ) {
224 $title = Title::newFromText( $titleText );
225 if ( !is_null( $title ) ) {
226 if ( $i == 0 ) {
227 $imageDBkey = $title->getDBkey();
228 } else {
229 $exceptions[$title->getPrefixedDBkey()] = true;
230 }
231 }
232 }
233
234 if ( $imageDBkey !== false ) {
235 $badImages[$imageDBkey] = $exceptions;
236 }
237 }
238 }
239
240 $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
241 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
242 wfProfileOut( __METHOD__ );
243 return $bad;
244 }
245
246 /**
247 * Calculate the largest thumbnail width for a given original file size
248 * such that the thumbnail's height is at most $maxHeight.
249 * @param $boxWidth Integer Width of the thumbnail box.
250 * @param $boxHeight Integer Height of the thumbnail box.
251 * @param $maxHeight Integer Maximum height expected for the thumbnail.
252 * @return Integer.
253 */
254 function wfFitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
255 $idealWidth = $boxWidth * $maxHeight / $boxHeight;
256 $roundedUp = ceil( $idealWidth );
257 if( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight )
258 return floor( $idealWidth );
259 else
260 return $roundedUp;
261 }
262
263
264 ?>