a4ba6a0fc624e182b3ffc38ccaf24a8f1fc3f583
[Packages/TYPO3.CMS.git] / t3lib / thumbs.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2006 Kasper Skaarhoj (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 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 113: class SC_t3lib_thumbs
41 * 134: function init()
42 * 164: function main()
43 *
44 * SECTION: OTHER FUNCTIONS:
45 * 267: function errorGif($l1,$l2,$l3)
46 * 319: function fontGif($font)
47 * 366: function wrapFileName($inputName)
48 *
49 * TOTAL FUNCTIONS: 5
50 * (This index is automatically created/updated by the extension "extdeveval")
51 *
52 */
53
54
55 // *******************************
56 // Set error reporting
57 // *******************************
58 error_reporting (E_ALL ^ E_NOTICE);
59
60
61
62 // ******************
63 // Constants defined
64 // ******************
65 define('TYPO3_OS', stristr(PHP_OS,'win')&&!stristr(PHP_OS,'darwin')?'WIN':'');
66 define('TYPO3_MODE','BE');
67 if(!defined('PATH_thisScript')) define('PATH_thisScript',str_replace('//','/', str_replace('\\','/', (php_sapi_name()=='cgi'||php_sapi_name()=='isapi' ||php_sapi_name()=='cgi-fcgi')&&($_SERVER['ORIG_PATH_TRANSLATED']?$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED'])? ($_SERVER['ORIG_PATH_TRANSLATED']?$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED']):($_SERVER['ORIG_SCRIPT_FILENAME']?$_SERVER['ORIG_SCRIPT_FILENAME']:$_SERVER['SCRIPT_FILENAME']))));
68 if(!defined('PATH_site')) define('PATH_site', ereg_replace('[^/]*.[^/]*$','',PATH_thisScript)); // the path to the website folder (see init.php)
69 if(!defined('PATH_t3lib')) define('PATH_t3lib', PATH_site.'t3lib/');
70 define('PATH_typo3conf', PATH_site.'typo3conf/');
71 define('TYPO3_mainDir', 'typo3/'); // This is the directory of the backend administration for the sites of this TYPO3 installation.
72 define('PATH_typo3', PATH_site.TYPO3_mainDir);
73
74
75 // ******************
76 // Including config
77 // ******************
78 require_once(PATH_t3lib.'class.t3lib_div.php');
79 require_once(PATH_t3lib.'class.t3lib_extmgm.php');
80
81 require(PATH_t3lib.'config_default.php');
82 if (!defined ('TYPO3_db')) die ('The configuration file was not included.');
83 if (!$TYPO3_CONF_VARS['GFX']['image_processing']) die ('ImageProcessing was disabled!');
84
85 require_once(PATH_t3lib.'class.t3lib_db.php'); // The database library
86 $TYPO3_DB = t3lib_div::makeInstance('t3lib_DB');
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103 /**
104 * Class for generating a thumbnail from the input parameters given to the script
105 *
106 * Input GET var, &file: relative or absolute reference to an imagefile. WILL be validated against PATH_site / lockRootPath
107 * Input GET var, &size: integer-values defining size of thumbnail, format '[int]' or '[int]x[int]'
108 *
109 * Relative paths MUST BE the first two characters ONLY: eg: '../dir/file.gif', otherwise it is expect to be absolute
110 *
111 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
112 * @package TYPO3
113 * @subpackage t3lib
114 */
115 class SC_t3lib_thumbs {
116 var $include_once=array();
117
118 var $outdir = 'typo3temp/'; // The output directory of temporary files in PATH_site
119 var $output = '';
120 var $sizeDefault='56x56';
121
122 var $imageList; // Coming from $TYPO3_CONF_VARS['GFX']['imagefile_ext']
123 var $input; // Contains the absolute path to the file for which to make a thumbnail (after init())
124
125 // Internal, static: GPvar:
126 var $file; // Holds the input filename (GET: file)
127 var $size; // Holds the input size (GET: size)
128
129
130 /**
131 * Initialize; reading parameters with GPvar and checking file path
132 * Results in internal var, $this->input, being set to the absolute path of the file for which to make the thumbnail.
133 *
134 * @return void
135 */
136 function init() {
137 global $TYPO3_CONF_VARS;
138
139 // Setting GPvars:
140 $this->file = t3lib_div::_GP('file');
141 $this->size = t3lib_div::_GP('size');
142
143 // Image extension list is set:
144 $this->imageList = $TYPO3_CONF_VARS['GFX']['imagefile_ext']; // valid extensions. OBS: No spaces in the list, all lowercase...
145
146 // if the filereference $this->file is relative, we correct the path
147 if (substr($this->file,0,3)=='../') {
148 $this->input = PATH_site.substr($this->file,3);
149 } else {
150 $this->input = $this->file;
151 }
152
153 // Now the path is absolute.
154 // Checking for backpath and double slashes + the thumbnail can be made from files which are in the PATH_site OR the lockRootPath only!
155 if (!t3lib_div::isAllowedAbsPath($this->input)) {
156 $this->input='';
157 }
158 }
159
160 /**
161 * Create the thumbnail
162 * Will exit before return if all is well.
163 *
164 * @return void
165 */
166 function main() {
167 global $TYPO3_CONF_VARS;
168
169 // If file exists, we make a thumbsnail of the file.
170 if ($this->input && @file_exists($this->input)) {
171
172 // Check file extension:
173 $reg = array();
174 if (ereg('(.*)\.([^\.]*$)',$this->input,$reg)) {
175 $ext=strtolower($reg[2]);
176 $ext=($ext=='jpeg')?'jpg':$ext;
177 if ($ext=='ttf') {
178 $this->fontGif($this->input); // Make font preview... (will not return)
179 } elseif (!t3lib_div::inList($this->imageList, $ext)) {
180 $this->errorGif('Not imagefile!',$ext,basename($this->input));
181 }
182 } else {
183 $this->errorGif('Not imagefile!','No ext!',basename($this->input));
184 }
185
186 // ... so we passed the extension test meaning that we are going to make a thumbnail here:
187 $this->size = $this->size ? $this->size : $this->sizeDefault; // default
188
189 // 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.
190 $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)
191 $sizeParts = array(t3lib_div::intInRange($sizeParts[0],1,1000),t3lib_div::intInRange($sizeParts[1],1,1000)); // Cleaning it up, only two parameters now.
192 $this->size = implode('x',$sizeParts); // Imploding the cleaned size-value back to the internal variable
193 $sizeMax = max($sizeParts); // Getting max value
194
195 // Init
196 $mtime = filemtime($this->input);
197 $outpath = PATH_site.$this->outdir;
198
199 // Should be - ? 'png' : 'gif' - , but doesn't work (ImageMagick prob.?)
200 // René: png work for me
201 $thmMode = t3lib_div::intInRange($TYPO3_CONF_VARS['GFX']['thumbnails_png'],0);
202 $outext = ($ext!='jpg' || ($thmMode & 2)) ? ($thmMode & 1 ? 'png' : 'gif') : 'jpg';
203
204 $outfile = 'tmb_'.substr(md5($this->input.$mtime.$this->size),0,10).'.'.$outext;
205 $this->output = $outpath.$outfile;
206
207 if ($TYPO3_CONF_VARS['GFX']['im']) {
208 // If thumbnail does not exist, we generate it
209 if (!@file_exists($this->output)) {
210 /* if (strstr($this->input,' ') || strstr($this->output,' ')) {
211 $this->errorGif('Spaces in','filepath',basename($this->input));
212 }
213 */ // 16 colors for small (56) thumbs, 64 for bigger and all for jpegs
214 if ($outext=='jpg') {
215 $colors = '';
216 } else {
217 $colors = ($sizeMax>56)?'-colors 64':'-colors 16';
218 }
219 $path = $TYPO3_CONF_VARS['GFX']['im_path_lzw'] ? $TYPO3_CONF_VARS['GFX']['im_path_lzw'] : $TYPO3_CONF_VARS['GFX']['im_path'];
220 $parameters = '-sample '.$this->size.' '.$colors.' '.$this->wrapFileName($this->input.'[0]').' '.$this->wrapFileName($this->output);
221 $cmd = t3lib_div::imageMagickCommand('convert', $parameters);
222 exec($cmd);
223 if (!@file_exists($this->output)) {
224 $this->errorGif('No thumb','generated!',basename($this->input));
225 }
226 }
227 // The thumbnail is read and output to the browser
228 if($fd = @fopen($this->output,'rb')) {
229 Header('Content-type: image/'.$outext);
230 while (!feof($fd)) {
231 echo fread($fd, 10000);
232 }
233 fclose( $fd );
234 } else {
235 $this->errorGif('Read problem!','',$this->output);
236 }
237 } else exit;
238 } else {
239 $this->errorGif('No valid','inputfile!',basename($this->input));
240 }
241 }
242
243
244
245
246
247
248
249
250
251
252
253 /***************************
254 *
255 * OTHER FUNCTIONS:
256 *
257 ***************************/
258
259 /**
260 * Creates error image based on gfx/notfound_thumb.png
261 * Requires GD lib enabled, otherwise it will exit with the three textstrings outputted as text.
262 * Outputs the image stream to browser and exits!
263 *
264 * @param string Text line 1
265 * @param string Text line 2
266 * @param string Text line 3
267 * @return void
268 */
269 function errorGif($l1,$l2,$l3) {
270 global $TYPO3_CONF_VARS;
271
272 if (!$TYPO3_CONF_VARS['GFX']['gdlib']) die($l1.' '.$l2.' '.$l3);
273
274 // Creates the basis for the error image
275 if ($TYPO3_CONF_VARS['GFX']['gdlib_png']) {
276 Header('Content-type: image/png');
277 $im = imagecreatefrompng(PATH_typo3.'gfx/notfound_thumb.png');
278 } else {
279 Header('Content-type: image/gif');
280 $im = imagecreatefromgif(PATH_typo3.'gfx/notfound_thumb.gif');
281 }
282 // Sets background color and print color.
283 $white = ImageColorAllocate($im, 0,0,0);
284 $black = ImageColorAllocate($im, 255,255,0);
285
286 // Prints the text strings with the build-in font functions of GD
287 $x=0;
288 $font=0;
289 if ($l1) {
290 imagefilledrectangle($im, $x, 9, 56, 16, $black);
291 ImageString($im,$font,$x,9,$l1,$white);
292 }
293 if ($l2) {
294 imagefilledrectangle($im, $x, 19, 56, 26, $black);
295 ImageString($im,$font,$x,19,$l2,$white);
296 }
297 if ($l3) {
298 imagefilledrectangle($im, $x, 29, 56, 36, $black);
299 ImageString($im,$font,$x,29,substr($l3,-14),$white);
300 }
301
302 // Outputting the image stream and exit
303 if ($TYPO3_CONF_VARS['GFX']['gdlib_png']) {
304 imagePng($im);
305 } else {
306 imageGif($im);
307 }
308 imagedestroy($im);
309 exit;
310 }
311
312 /**
313 * Creates a font-preview thumbnail.
314 * 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
315 * Requires GD lib enabled.
316 * Outputs the image stream to browser and exits!
317 *
318 * @param string The filepath to the font file (absolute, probably)
319 * @return void
320 */
321 function fontGif($font) {
322 global $TYPO3_CONF_VARS;
323
324 if (!$TYPO3_CONF_VARS['GFX']['gdlib']) die('');
325
326 // Create image and set background color to white.
327 $im = ImageCreate(250,76);
328 $white = ImageColorAllocate($im, 255,255,255);
329 $col = ImageColorAllocate($im, 0,0,0);
330
331 // The test string and offset in x-axis.
332 $string = 'AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZzÆæØøÅåÄäÖöÜüß';
333 $x=13;
334
335 // Print (with non-ttf font) the size displayed
336 imagestring ($im, 1, 0, 2, '10', $col);
337 imagestring ($im, 1, 0, 15, '12', $col);
338 imagestring ($im, 1, 0, 30, '14', $col);
339 imagestring ($im, 1, 0, 47, '18', $col);
340 imagestring ($im, 1, 0, 68, '24', $col);
341
342 // Print with ttf-font the test string
343 imagettftext ($im, t3lib_div::freetypeDpiComp(10), 0, $x, 8, $col, $font, $string);
344 imagettftext ($im, t3lib_div::freetypeDpiComp(12), 0, $x, 21, $col, $font, $string);
345 imagettftext ($im, t3lib_div::freetypeDpiComp(14), 0, $x, 36, $col, $font, $string);
346 imagettftext ($im, t3lib_div::freetypeDpiComp(18), 0, $x, 53, $col, $font, $string);
347 imagettftext ($im, t3lib_div::freetypeDpiComp(24), 0, $x, 74, $col, $font, $string);
348
349 // Output PNG or GIF based on $TYPO3_CONF_VARS['GFX']['gdlib_png']
350 if ($TYPO3_CONF_VARS['GFX']['gdlib_png']) {
351 Header('Content-type: image/png');
352 imagePng($im);
353 } else {
354 Header('Content-type: image/gif');
355 imageGif($im);
356 }
357 imagedestroy($im);
358 exit;
359 }
360
361 /**
362 * Wrapping the input filename in double-quotes
363 *
364 * @param string Input filename
365 * @return string The output wrapped in "" (if there are spaces in the filepath)
366 * @access private
367 */
368 function wrapFileName($inputName) {
369 if (strstr($inputName,' ')) {
370 $inputName='"'.$inputName.'"';
371 }
372 return $inputName;
373 }
374 }
375
376 // Include extension class?
377 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/thumbs.php']) {
378 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/thumbs.php']);
379 }
380
381
382
383
384 // Make instance:
385 $SOBE = t3lib_div::makeInstance('SC_t3lib_thumbs');
386 $SOBE->init();
387 $SOBE->main();
388 ?>