[TASK] Remove SVN auto properties $Id$
[Packages/TYPO3.CMS.git] / t3lib / thumbs.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Generates a thumbnail and returns an image stream, either GIF/PNG or JPG
29 *
30 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
31 *
32 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
33 */
34 /**
35 * [CLASS/FUNCTION INDEX of SCRIPT]
36 *
37 *
38 *
39 * 113: class SC_t3lib_thumbs
40 * 134: function init()
41 * 164: function main()
42 *
43 * SECTION: OTHER FUNCTIONS:
44 * 267: function errorGif($l1,$l2,$l3)
45 * 319: function fontGif($font)
46 * 366: function wrapFileName($inputName)
47 *
48 * TOTAL FUNCTIONS: 5
49 * (This index is automatically created/updated by the extension "extdeveval")
50 *
51 */
52
53
54 // *******************************
55 // Set error reporting
56 // *******************************
57 if (defined('E_DEPRECATED')) {
58 error_reporting(E_ALL ^ E_NOTICE ^ E_DEPRECATED);
59 } else {
60 error_reporting(E_ALL ^ E_NOTICE);
61 }
62
63
64
65 // ******************
66 // Constants defined
67 // ******************
68 define('TYPO3_OS', stristr(PHP_OS,'win')&&!stristr(PHP_OS,'darwin')?'WIN':'');
69 define('TYPO3_MODE','BE');
70
71 if(!defined('PATH_thisScript')) {
72 define('PATH_thisScript', str_replace('//', '/', str_replace('\\', '/',
73 (PHP_SAPI == 'fpm-fcgi' || PHP_SAPI == 'cgi' || PHP_SAPI == 'isapi' || PHP_SAPI == 'cgi-fcgi') &&
74 ($_SERVER['ORIG_PATH_TRANSLATED'] ? $_SERVER['ORIG_PATH_TRANSLATED'] : $_SERVER['PATH_TRANSLATED']) ?
75 ($_SERVER['ORIG_PATH_TRANSLATED'] ? $_SERVER['ORIG_PATH_TRANSLATED'] : $_SERVER['PATH_TRANSLATED']) :
76 ($_SERVER['ORIG_SCRIPT_FILENAME'] ? $_SERVER['ORIG_SCRIPT_FILENAME'] : $_SERVER['SCRIPT_FILENAME']))));
77 }
78
79 if(!defined('PATH_site')) define('PATH_site', preg_replace('/[^\/]*.[^\/]*$/','',PATH_thisScript)); // the path to the website folder (see init.php)
80 if(!defined('PATH_t3lib')) define('PATH_t3lib', PATH_site.'t3lib/');
81 define('PATH_typo3conf', PATH_site.'typo3conf/');
82 define('TYPO3_mainDir', 'typo3/'); // This is the directory of the backend administration for the sites of this TYPO3 installation.
83 define('PATH_typo3', PATH_site.TYPO3_mainDir);
84
85
86 // ******************
87 // Including config
88 // ******************
89 require_once(PATH_t3lib.'class.t3lib_div.php');
90 require_once(PATH_t3lib.'class.t3lib_extmgm.php');
91
92 require(PATH_t3lib.'config_default.php');
93 if (!defined ('TYPO3_db')) die ('The configuration file was not included.');
94 if (!$TYPO3_CONF_VARS['GFX']['image_processing']) die ('ImageProcessing was disabled!');
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112 /**
113 * Class for generating a thumbnail from the input parameters given to the script
114 *
115 * Input GET var, &file: relative or absolute reference to an imagefile. WILL be validated against PATH_site / lockRootPath
116 * Input GET var, &size: integer-values defining size of thumbnail, format '[int]' or '[int]x[int]'
117 *
118 * Relative paths MUST BE the first two characters ONLY: eg: '../dir/file.gif', otherwise it is expect to be absolute
119 *
120 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
121 * @package TYPO3
122 * @subpackage t3lib
123 */
124 class SC_t3lib_thumbs {
125 var $include_once = array();
126
127 var $outdir = 'typo3temp/'; // The output directory of temporary files in PATH_site
128 var $output = '';
129 var $sizeDefault='56x56';
130
131 var $imageList; // Coming from $TYPO3_CONF_VARS['GFX']['imagefile_ext']
132 var $input; // Contains the absolute path to the file for which to make a thumbnail (after init())
133
134 // Internal, static: GPvar:
135 var $file; // Holds the input filename (GET: file)
136 var $size; // Holds the input size (GET: size)
137 var $mtime = 0; // Last modification time of the supplied file
138
139
140 /**
141 * Initialize; reading parameters with GPvar and checking file path
142 * Results in internal var, $this->input, being set to the absolute path of the file for which to make the thumbnail.
143 *
144 * @return void
145 */
146 function init() {
147 global $TYPO3_CONF_VARS;
148
149 // Setting GPvars:
150 $file = t3lib_div::_GP('file');
151 $size = t3lib_div::_GP('size');
152 $md5sum = t3lib_div::_GP('md5sum');
153
154 // Image extension list is set:
155 $this->imageList = $TYPO3_CONF_VARS['GFX']['imagefile_ext']; // valid extensions. OBS: No spaces in the list, all lowercase...
156
157 // If the filereference $this->file is relative, we correct the path
158 if (substr($file,0,3)=='../') {
159 $file = PATH_site.substr($file,3);
160 }
161
162 // Now the path is absolute.
163 // Checking for backpath and double slashes + the thumbnail can be made from files which are in the PATH_site OR the lockRootPath only!
164 if (t3lib_div::isAllowedAbsPath($file)) {
165 $mtime = filemtime($file);
166 }
167
168 // Do an MD5 check to prevent viewing of images without permission
169 $OK = FALSE;
170 if ($mtime) {
171 // Always use the absolute path for this check!
172 $check = basename($file).':'.$mtime.':'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
173 $md5_real = t3lib_div::shortMD5($check);
174 if (!strcmp($md5_real,$md5sum)) {
175 $OK = TRUE;
176 }
177 }
178
179 if ($OK) {
180 $this->input = $file;
181 $this->size = $size;
182 $this->mtime = $mtime;
183 } else {
184 throw new RuntimeException(
185 'TYPO3 Fatal Error: Image does not exist and/or MD5 checksum did not match.',
186 1270853950
187 );
188 }
189 }
190
191 /**
192 * Create the thumbnail
193 * Will exit before return if all is well.
194 *
195 * @return void
196 */
197 function main() {
198 global $TYPO3_CONF_VARS;
199
200 // If file exists, we make a thumbsnail of the file.
201 if ($this->input && file_exists($this->input)) {
202
203 // Check file extension:
204 $reg = array();
205 if (preg_match('/(.*)\.([^\.]*$)/',$this->input,$reg)) {
206 $ext=strtolower($reg[2]);
207 $ext=($ext=='jpeg')?'jpg':$ext;
208 if ($ext=='ttf') {
209 $this->fontGif($this->input); // Make font preview... (will not return)
210 } elseif (!t3lib_div::inList($this->imageList, $ext)) {
211 $this->errorGif('Not imagefile!',$ext,basename($this->input));
212 }
213 } else {
214 $this->errorGif('Not imagefile!','No ext!',basename($this->input));
215 }
216
217 // ... so we passed the extension test meaning that we are going to make a thumbnail here:
218 if (!$this->size) $this->size = $this->sizeDefault; // default
219
220 // I added extra check, so that the size input option could not be fooled to pass other values. That means the value is exploded, evaluated to an integer and the imploded to [value]x[value]. Furthermore you can specify: size=340 and it'll be translated to 340x340.
221 $sizeParts = explode('x', $this->size.'x'.$this->size); // explodes the input size (and if no "x" is found this will add size again so it is the same for both dimensions)
222 $sizeParts = array(t3lib_div::intInRange($sizeParts[0],1,1000),t3lib_div::intInRange($sizeParts[1],1,1000)); // Cleaning it up, only two parameters now.
223 $this->size = implode('x',$sizeParts); // Imploding the cleaned size-value back to the internal variable
224 $sizeMax = max($sizeParts); // Getting max value
225
226 // Init
227 $outpath = PATH_site.$this->outdir;
228
229 // Should be - ? 'png' : 'gif' - , but doesn't work (ImageMagick prob.?)
230 // René: png work for me
231 $thmMode = t3lib_div::intInRange($TYPO3_CONF_VARS['GFX']['thumbnails_png'],0);
232 $outext = ($ext!='jpg' || ($thmMode & 2)) ? ($thmMode & 1 ? 'png' : 'gif') : 'jpg';
233
234 $outfile = 'tmb_'.substr(md5($this->input.$this->mtime.$this->size),0,10).'.'.$outext;
235 $this->output = $outpath.$outfile;
236
237 if ($TYPO3_CONF_VARS['GFX']['im']) {
238 // If thumbnail does not exist, we generate it
239 if (!file_exists($this->output)) {
240 $parameters = '-sample ' . $this->size . ' ' . $this->wrapFileName($this->input) . '[0] ' . $this->wrapFileName($this->output);
241 $cmd = t3lib_div::imageMagickCommand('convert', $parameters);
242 t3lib_utility_Command::exec($cmd);
243 if (!file_exists($this->output)) {
244 $this->errorGif('No thumb','generated!',basename($this->input));
245 } else {
246 t3lib_div::fixPermissions($this->output);
247 }
248 }
249 // The thumbnail is read and output to the browser
250 if($fd = @fopen($this->output,'rb')) {
251 header('Content-type: image/'.$outext);
252 fpassthru($fd);
253 fclose($fd);
254 } else {
255 $this->errorGif('Read problem!','',$this->output);
256 }
257 } else exit;
258 } else {
259 $this->errorGif('No valid','inputfile!',basename($this->input));
260 }
261 }
262
263
264
265
266
267
268
269
270
271
272
273 /***************************
274 *
275 * OTHER FUNCTIONS:
276 *
277 ***************************/
278
279 /**
280 * Creates error image based on gfx/notfound_thumb.png
281 * Requires GD lib enabled, otherwise it will exit with the three textstrings outputted as text.
282 * Outputs the image stream to browser and exits!
283 *
284 * @param string Text line 1
285 * @param string Text line 2
286 * @param string Text line 3
287 * @return void
288 */
289 function errorGif($l1,$l2,$l3) {
290 global $TYPO3_CONF_VARS;
291
292 if (!$TYPO3_CONF_VARS['GFX']['gdlib']) {
293 throw new RuntimeException(
294 'TYPO3 Fatal Error: No gdlib. ' . $l1 . ' ' . $l2 . ' ' . $l3,
295 1270853952
296 );
297 }
298
299 // Creates the basis for the error image
300 if ($TYPO3_CONF_VARS['GFX']['gdlib_png']) {
301 header('Content-type: image/png');
302 $im = imagecreatefrompng(PATH_typo3.'gfx/notfound_thumb.png');
303 } else {
304 header('Content-type: image/gif');
305 $im = imagecreatefromgif(PATH_typo3.'gfx/notfound_thumb.gif');
306 }
307 // Sets background color and print color.
308 $white = imageColorAllocate($im, 0,0,0);
309 $black = imageColorAllocate($im, 255,255,0);
310
311 // Prints the text strings with the build-in font functions of GD
312 $x=0;
313 $font=0;
314 if ($l1) {
315 imagefilledrectangle($im, $x, 9, 56, 16, $black);
316 imageString($im,$font,$x,9,$l1,$white);
317 }
318 if ($l2) {
319 imagefilledrectangle($im, $x, 19, 56, 26, $black);
320 imageString($im,$font,$x,19,$l2,$white);
321 }
322 if ($l3) {
323 imagefilledrectangle($im, $x, 29, 56, 36, $black);
324 imageString($im,$font,$x,29,substr($l3,-14),$white);
325 }
326
327 // Outputting the image stream and exit
328 if ($TYPO3_CONF_VARS['GFX']['gdlib_png']) {
329 imagePng($im);
330 } else {
331 imageGif($im);
332 }
333 imagedestroy($im);
334 exit;
335 }
336
337 /**
338 * Creates a font-preview thumbnail.
339 * This means a PNG/GIF file with the text "AaBbCc...." set with the font-file given as input and in various sizes to show how the font looks
340 * Requires GD lib enabled.
341 * Outputs the image stream to browser and exits!
342 *
343 * @param string The filepath to the font file (absolute, probably)
344 * @return void
345 */
346 function fontGif($font) {
347 global $TYPO3_CONF_VARS;
348
349 if (!$TYPO3_CONF_VARS['GFX']['gdlib']) {
350 throw new RuntimeException(
351 'TYPO3 Fatal Error: No gdlib.',
352 1270853953
353 );
354 }
355
356 // Create image and set background color to white.
357 $im = imageCreate(250,76);
358 $white = imageColorAllocate($im, 255,255,255);
359 $col = imageColorAllocate($im, 0,0,0);
360
361 // The test string and offset in x-axis.
362 $string = 'AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZzÆæØøÅåÄäÖöÜüß';
363 $x=13;
364
365 // Print (with non-ttf font) the size displayed
366 imagestring ($im, 1, 0, 2, '10', $col);
367 imagestring ($im, 1, 0, 15, '12', $col);
368 imagestring ($im, 1, 0, 30, '14', $col);
369 imagestring ($im, 1, 0, 47, '18', $col);
370 imagestring ($im, 1, 0, 68, '24', $col);
371
372 // Print with ttf-font the test string
373 imagettftext ($im, t3lib_div::freetypeDpiComp(10), 0, $x, 8, $col, $font, $string);
374 imagettftext ($im, t3lib_div::freetypeDpiComp(12), 0, $x, 21, $col, $font, $string);
375 imagettftext ($im, t3lib_div::freetypeDpiComp(14), 0, $x, 36, $col, $font, $string);
376 imagettftext ($im, t3lib_div::freetypeDpiComp(18), 0, $x, 53, $col, $font, $string);
377 imagettftext ($im, t3lib_div::freetypeDpiComp(24), 0, $x, 74, $col, $font, $string);
378
379 // Output PNG or GIF based on $TYPO3_CONF_VARS['GFX']['gdlib_png']
380 if ($TYPO3_CONF_VARS['GFX']['gdlib_png']) {
381 header('Content-type: image/png');
382 imagePng($im);
383 } else {
384 header('Content-type: image/gif');
385 imageGif($im);
386 }
387 imagedestroy($im);
388 exit;
389 }
390
391 /**
392 * Escapes a file name so it can safely be used on the command line.
393 *
394 * @param string $inputName filename to safeguard, must not be empty
395 *
396 * @return string $inputName escaped as needed
397 */
398 protected function wrapFileName($inputName) {
399 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['UTF8filesystem']) {
400 $currentLocale = setlocale(LC_CTYPE, 0);
401 setlocale(LC_CTYPE, $GLOBALS['TYPO3_CONF_VARS']['SYS']['systemLocale']);
402 }
403 $escapedInputName = escapeshellarg($inputName);
404 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['UTF8filesystem']) {
405 setlocale(LC_CTYPE, $currentLocale);
406 }
407 return $escapedInputName;
408 }
409 }
410
411 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/thumbs.php'])) {
412 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/thumbs.php']);
413 }
414
415
416
417
418 // Make instance:
419 $SOBE = t3lib_div::makeInstance('SC_t3lib_thumbs');
420 $SOBE->init();
421 $SOBE->main();
422
423 ?>