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