* Fixed various things in file processing, t3lib_extFileFunc et al.
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_iconworks.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 Kasper Skaarhoj (kasper@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 * Contains class for icon generation in the backend
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 *
34 * @author Kasper Skaarhoj <kasper@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 85: class t3lib_iconWorks
42 * 100: function getIconImage($table,$row=array(),$backPath,$params='',$shaded=FALSE)
43 * 118: function getIcon($table,$row=array(),$shaded=FALSE)
44 * 254: function skinImg($backPath,$src,$wHattribs='',$outputMode=0)
45 *
46 * SECTION: Other functions
47 * 328: function makeIcon($iconfile,$mode, $user, $protectSection,$absFile,$iconFileName_stateTagged)
48 * 444: function imagecopyresized(&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h)
49 * 477: function imagecreatefrom($file)
50 * 494: function imagemake($im, $path)
51 *
52 * TOTAL FUNCTIONS: 7
53 * (This index is automatically created/updated by the extension "extdeveval")
54 *
55 */
56
57
58
59
60
61
62
63
64
65
66 /**
67 * Icon generation, backend
68 * This library has functions that returns - and if necessary creates - the icon for an element in TYPO3
69 *
70 * Expects global vars:
71 * - $BACK_PATH
72 * - PATH_typo3
73 * - $TCA, $PAGES_TYPES
74 *
75 *
76 * Notes:
77 * These functions are strongly related to the interface of TYPO3.
78 * The class is included in eg. init.php
79 * ALL functions called without making a class instance, eg. "t3lib_iconWorks::getIconImage()"
80 *
81 * @author Kasper Skaarhoj <kasper@typo3.com>
82 * @package TYPO3
83 * @subpackage t3lib
84 */
85 class t3lib_iconWorks {
86
87 /**
88 * Returns an icon image tag, 18x16 pixels, based on input information.
89 * This function is recommended to use in your backend modules.
90 * Usage: 60
91 *
92 * @param string The table name
93 * @param array The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
94 * @param string The backpath to the main TYPO3 directory (relative path back to PATH_typo3)
95 * @param string Additional attributes for the image tag
96 * @param boolean If set, the icon will be grayed/shaded
97 * @return string <img>-tag
98 * @see getIcon()
99 */
100 function getIconImage($table,$row=array(),$backPath,$params='',$shaded=FALSE) {
101 $str='<img'.t3lib_iconWorks::skinImg($backPath,t3lib_iconWorks::getIcon($table,$row,$shaded),'width="18" height="16"').(trim($params)?' '.trim($params):'');
102 if (!stristr($str,'alt="')) $str.=' alt=""';
103 $str.=' />';
104 return $str;
105 }
106
107 /**
108 * Creates the icon for input table/row
109 * Returns filename for the image icon, relative to PATH_typo3
110 * Usage: 24
111 *
112 * @param string The table name
113 * @param array The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
114 * @param boolean If set, the icon will be grayed/shaded
115 * @return string Icon filename
116 * @see getIconImage()
117 */
118 function getIcon($table,$row=array(),$shaded=FALSE) {
119 global $TCA, $PAGES_TYPES, $ICON_TYPES;
120
121 // Flags:
122 $doNotGenerateIcon = $GLOBALS['TYPO3_CONF_VARS']['GFX']['noIconProc']; // If set, the icon will NOT be generated with GDlib. Rather the icon will be looked for as [iconfilename]_X.[extension]
123 $doNotRenderUserGroupNumber = TRUE; // If set, then the usergroup number will NOT be printed unto the icon. NOTICE. the icon is generated only if a default icon for groups is not found... So effectively this is ineffective...
124
125 // First, find the icon file name. This can depend on configuration in TCA, field values and more:
126 if ($table=='pages') {
127 if (!$iconfile = $PAGES_TYPES[$row['doktype']]['icon']) {
128 $iconfile = $PAGES_TYPES['default']['icon'];
129 }
130 if ($row['module'] && $ICON_TYPES[$row['module']]['icon']) {
131 $iconfile = $ICON_TYPES[$row['module']]['icon'];
132 }
133 } else {
134 if (!$iconfile = $TCA[$table]['ctrl']['typeicons'][$row[$TCA[$table]['ctrl']['typeicon_column']]]) {
135 $iconfile = (($TCA[$table]['ctrl']['iconfile']) ? $TCA[$table]['ctrl']['iconfile'] : $table.'.gif');
136 }
137 }
138
139 // Setting path of iconfile if not already set. Default is "gfx/i/"
140 if (!strstr($iconfile,'/')) {
141 $iconfile = 'gfx/i/'.$iconfile;
142 }
143
144 // Setting the absolute path where the icon should be found as a file:
145 if (substr($iconfile,0,3)=='../') {
146 $absfile=PATH_site.substr($iconfile,3);
147 } else {
148 $absfile=PATH_typo3.$iconfile;
149 }
150
151 // Initializing variables, all booleans except otherwise stated:
152 $hidden = FALSE;
153 $timing = FALSE;
154 $futuretiming = FALSE;
155 $user = FALSE; // In fact an integer value...
156 $deleted = FALSE;
157 $protectSection = FALSE; // Set, if a page-record (only pages!) has the extend-to-subpages flag set.
158 $noIconFound = $row['_NO_ICON_FOUND'] ? TRUE : FALSE;
159 // + $shaded which is also boolean!
160
161 // Icon state based on "enableFields":
162 if (is_array($TCA[$table]['ctrl']['enablecolumns'])) {
163 $enCols = $TCA[$table]['ctrl']['enablecolumns'];
164 // If "hidden" is enabled:
165 if ($enCols['disabled']) { if ($row[$enCols['disabled']]) { $hidden = TRUE; }}
166 // If a "starttime" is set and higher than current time:
167 if ($enCols['starttime']) { if (time() < intval($row[$enCols['starttime']])) { $timing = TRUE; }}
168 // If an "endtime" is set:
169 if ($enCols['endtime']) {
170 if (intval($row[$enCols['endtime']]) > 0) {
171 if (intval($row[$enCols['endtime']]) < time()) {
172 $timing = TRUE; // End-timing applies at this point.
173 } else {
174 $futuretiming = TRUE; // End-timing WILL apply in the future for this element.
175 }
176 }
177 }
178 // If a user-group field is set:
179 if ($enCols['fe_group']) {
180 $user = $row[$enCols['fe_group']];
181 if ($user && $doNotRenderUserGroupNumber) $user=100; // Limit for user number rendering!
182 }
183 }
184
185 // If "deleted" flag is set (only when listing records which are also deleted!)
186 if ($col=$row[$TCA[$table]['ctrl']['delete']]) {
187 $deleted = TRUE;
188 }
189 // Detecting extendToSubpages (for pages only)
190 if ($table=='pages' && $row['extendToSubpages'] && ($hidden || $timing || $futuretiming || $user)) {
191 $protectSection = TRUE;
192 }
193
194 // If ANY of the booleans are set it means we have to alter the icon:
195 if ($hidden || $timing || $futuretiming || $user || $deleted || $shaded || $noIconFound) {
196 $flags='';
197 $string='';
198 if ($deleted) {
199 $string='deleted';
200 $flags='d';
201 } elseif ($noIconFound) { // This is ONLY for creating icons with "?" on easily...
202 $string='no_icon_found';
203 $flags='x';
204 } else {
205 if ($hidden) $string.='hidden';
206 if ($timing) $string.='timing';
207 if (!$string && $futuretiming) {
208 $string='futuretiming';
209 }
210
211 $flags.=
212 ($hidden ? 'h' : '').
213 ($timing ? 't' : '').
214 ($futuretiming ? 'f' : '').
215 ($user ? 'u' : '').
216 ($protectSection ? 'p' : '').
217 ($shaded ? 's' : '');
218 }
219
220 // Create tagged icon file name:
221 $iconFileName_stateTagged = ereg_replace('.([[:alnum:]]+)$','__'.$flags.'.\1',basename($iconfile));
222
223 // Check if tagged icon file name exists (a tagget icon means the icon base name with the flags added between body and extension of the filename, prefixed with underscore)
224 if (@is_file(dirname($absfile).'/'.$iconFileName_stateTagged)) { // Look for [iconname]_xxxx.[ext]
225 return dirname($iconfile).'/'.$iconFileName_stateTagged;
226 } elseif ($doNotGenerateIcon) { // If no icon generation can be done, try to look for the _X icon:
227 $iconFileName_X = ereg_replace('.([[:alnum:]]+)$','__x.\1',basename($iconfile));
228 if (@is_file(dirname($absfile).'/'.$iconFileName_X)) {
229 return dirname($iconfile).'/'.$iconFileName_X;
230 } else {
231 return 'gfx/i/no_icon_found.gif';
232 }
233 } else { // Otherwise, create the icon:
234 $theRes= t3lib_iconWorks::makeIcon($GLOBALS['BACK_PATH'].$iconfile, $string, $user, $protectSection, $absfile, $iconFileName_stateTagged);
235 return $theRes;
236 }
237 } else {
238 return $iconfile;
239 }
240 }
241
242 /**
243 * Returns the src=... for the input $src value OR any alternative found in $TBE_STYLES['skinImg']
244 * Used for skinning the TYPO3 backend with an alternative set of icons
245 * Usage: 336
246 *
247 * @param string Current backpath to PATH_typo3 folder
248 * @param string Icon file name relative to PATH_typo3 folder
249 * @param string Default width/height, defined like 'width="12" height="14"'
250 * @param integer Mode: 0 (zero) is default and returns src/width/height. 1 returns value of src+backpath, 2 returns value of w/h.
251 * @return string Returns ' src="[backPath][src]" [wHattribs]'
252 * @see skinImgFile()
253 */
254 function skinImg($backPath,$src,$wHattribs='',$outputMode=0) {
255
256 // Setting source key. If the icon is refered to inside an extension, we homogenize the prefix to "ext/":
257 $srcKey = ereg_replace('^(\.\.\/typo3conf\/ext|sysext|ext)\/','ext/',$src);
258 #if ($src!=$srcKey)debug(array($src,$srcKey));
259
260 // LOOKING for alternative icons:
261 if ($GLOBALS['TBE_STYLES']['skinImg'][$srcKey]) { // Slower or faster with is_array()? Could be used.
262 list($src,$wHattribs) = $GLOBALS['TBE_STYLES']['skinImg'][$srcKey];
263 } elseif ($GLOBALS['TBE_STYLES']['skinImgAutoCfg']) { // Otherwise, test if auto-detection is enabled:
264
265 // Search for alternative icon automatically:
266 $fExt = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['forceFileExtension'];
267 $scaleFactor = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['scaleFactor'] ? $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['scaleFactor'] : 1; // Scaling factor
268 $lookUpName = $fExt ? ereg_replace('\.[[:alnum:]]+$','',$srcKey).'.'.$fExt : $srcKey; // Set filename to look for
269
270 // If file is found:
271 if (@is_file($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'].$lookUpName)) { // If there is a file...
272 $iInfo = @getimagesize($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'].$lookUpName); // Get width/height:
273
274 // Set $src and $wHattribs:
275 $src = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['relDir'].$lookUpName;
276 $wHattribs = 'width="'.round($iInfo[0]*$scaleFactor).'" height="'.round($iInfo[1]*$scaleFactor).'"';
277 }
278
279 // In anycase, set currect src / wHattrib - this way we make sure that an entry IS found next time we hit the function, regardless of whether it points to a alternative icon or just the current.
280 $GLOBALS['TBE_STYLES']['skinImg'][$srcKey] = array($src,$wHattribs); // Set default...
281 }
282
283 // DEBUG: This doubles the size of all icons - for testing/debugging:
284 # if (ereg('^width="([0-9]+)" height="([0-9]+)"$',$wHattribs,$reg)) $wHattribs='width="'.($reg[1]*2).'" height="'.($reg[2]*2).'"';
285
286 // Return icon source/wHattributes:
287 switch($outputMode) {
288 case 0:
289 return ' src="'.$backPath.$src.'" '.$wHattribs;
290 break;
291 case 1:
292 return $backPath.$src;
293 break;
294 case 2:
295 return $wHattribs;
296 break;
297 }
298 }
299
300
301
302
303
304
305
306
307
308
309
310 /***********************************
311 *
312 * Other functions
313 *
314 ***********************************/
315
316 /**
317 * Creates the icon file for the function getIcon()
318 *
319 * @param string Original unprocessed Icon file, relative path to PATH_typo3
320 * @param string Mode string, eg. "deleted" or "futuretiming" determining how the icon will look
321 * @param integer The number of the fe_group record uid if applicable
322 * @param boolean Flag determines if the protected-section icon should be applied.
323 * @param string Absolute path to file from which to create the icon.
324 * @param string The filename that this icon should have had, basically [icon base name]_[flags].[extension] - used for part of temporary filename
325 * @return string Filename relative to PATH_typo3
326 * @access private
327 */
328 function makeIcon($iconfile,$mode, $user, $protectSection,$absFile,$iconFileName_stateTagged) {
329 $iconFileName = 'icon_'.t3lib_div::shortMD5($iconfile.'|'.$mode.'|-'.$user.'|'.$protectSection).'_'.$iconFileName_stateTagged.'.'.($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']?'png':'gif');
330 $mainpath = '../typo3temp/'.$iconFileName;
331 $path = PATH_site.'typo3temp/'.$iconFileName;
332
333
334 if (@file_exists(PATH_typo3.'icons/'.$iconFileName)) { // Returns if found in typo3/icons/
335 return 'icons/'.$iconFileName;
336 } elseif (@file_exists($path)) { // Returns if found in ../typo3temp/icons/
337 return $mainpath;
338 } else { // Makes icon:
339 if (@file_exists($absFile)) {
340 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']) {
341
342 // Create image pointer, if possible:
343 $im = t3lib_iconworks::imagecreatefrom($absFile);
344 if ($im<0) return $iconfile;
345
346 // Converting to gray scale, dimming the icon:
347 if ($mode!='futuretiming' && $mode!='no_icon_found' && !(!$mode && $user)) {
348 for ($c=0; $c<ImageColorsTotal($im); $c++) {
349 $cols = ImageColorsForIndex($im,$c);
350 $newcol = round(($cols['red']+$cols['green']+$cols['blue'])/3);
351 $lighten = 2;
352 $newcol = round(255-((255-$newcol)/$lighten));
353 ImageColorSet($im,$c,$newcol,$newcol,$newcol);
354 }
355 }
356 // Applying user icon, if there are access control on the item:
357 if ($user) {
358 if ($user < 100) { // Apply user number only if lower than 100
359 $black = ImageColorAllocate($im, 0,0,0);
360 imagefilledrectangle($im, 0,0,(($user>10)?9:5),8,$black);
361
362 $white = ImageColorAllocate($im, 255,255,255);
363 imagestring($im, 1, 1, 1, $user, $white);
364 }
365
366 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_group.gif');
367 if ($ol_im<0) return $iconfile;
368
369 t3lib_iconworks::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
370 }
371 // Applying overlay based on mode:
372 if ($mode) {
373 unset($ol_im);
374 switch($mode) {
375 case 'deleted':
376 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_deleted.gif');
377 break;
378 case 'futuretiming':
379 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_timing.gif');
380 break;
381 case 'timing':
382 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_timing.gif');
383 break;
384 case 'hiddentiming':
385 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_hidden_timing.gif');
386 break;
387 case 'no_icon_found':
388 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_no_icon_found.gif');
389 break;
390 case 'hidden':
391 default:
392 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_hidden.gif');
393 break;
394 }
395 if ($ol_im<0) return $iconfile;
396 t3lib_iconworks::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
397 }
398 // Protect-section icon:
399 if ($protectSection) {
400 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_sub5.gif');
401 if ($ol_im<0) return $iconfile;
402 t3lib_iconworks::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
403 }
404
405 // Create the image as file, destroy GD image and return:
406 @t3lib_iconWorks::imagemake($im, $path);
407 t3lib_div::gif_compress($path, 'IM');
408 ImageDestroy($im);
409 return $mainpath;
410 } else {
411 return $iconfile;
412 }
413 } else {
414 return $GLOBALS['BACK_PATH'].'gfx/fileicons/default.gif';
415 }
416 }
417 }
418
419 /**
420 * The necessity of using this function for combining two images if GD is version 2 is that
421 * GD2 cannot manage to combine two indexed-color images without totally spoiling everything.
422 * In class.t3lib_stdgraphic this was solved by combining the images onto a first created true color image
423 * However it has turned out that this method will not work if the indexed png-files contains transparency.
424 * So I had to turn my attention to ImageMagick - my 'enemy of death'.
425 * And so it happend - ImageMagick is now used to combine my two indexed-color images with transparency. And that works.
426 * Of course it works only if ImageMagick is able to create valid png-images - which you cannot be sure of with older versions (still 5+)
427 * The only drawback is (apparently) that IM creates true-color png's. The transparency of these will not be shown by MSIE on windows at this time (although it's straight 0%/100% transparency!) and the file size may be larger.
428 *
429 * For parameters, see PHP function "imagecopyresized()"
430 *
431 * @param pointer see PHP function "imagecopyresized()"
432 * @param pointer see PHP function "imagecopyresized()"
433 * @param integer see PHP function "imagecopyresized()"
434 * @param integer see PHP function "imagecopyresized()"
435 * @param integer see PHP function "imagecopyresized()"
436 * @param integer see PHP function "imagecopyresized()"
437 * @param integer see PHP function "imagecopyresized()"
438 * @param integer see PHP function "imagecopyresized()"
439 * @param integer see PHP function "imagecopyresized()"
440 * @param integer see PHP function "imagecopyresized()"
441 * @return void
442 * @access private
443 */
444 function imagecopyresized(&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h) {
445 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_2'] && $GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) { // Maybe I'll have to change this if GD2/gif does not work either...
446 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path']) {
447 $cmd=$GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path'].
448 ($GLOBALS['TYPO3_CONF_VARS']['GFX']['im_combine_filename']?$GLOBALS['TYPO3_CONF_VARS']['GFX']['im_combine_filename']:'combine').
449 ' -compose over ';
450 $tempBaseName = PATH_site.'typo3temp/ICRZ_'.md5(uniqid('.'));
451
452 ImagePng($im, $tempBaseName.'_im.png');
453 ImagePng($cpImg, $tempBaseName.'_cpImg.png');
454 exec($cmd.
455 $tempBaseName.'_cpImg.png '.
456 $tempBaseName.'_im.png '.
457 $tempBaseName.'_out.png '
458 );
459 $im = imagecreatefrompng($tempBaseName.'_out.png');
460 unlink($tempBaseName.'_im.png');
461 unlink($tempBaseName.'_cpImg.png');
462 unlink($tempBaseName.'_out.png');
463 }
464 } else {
465 imagecopyresized($im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h);
466 }
467 }
468
469 /**
470 * Create new image pointer from input file (either gif/png, in case the wrong format it is converted by t3lib_div::read_png_gif())
471 *
472 * @param string Absolute filename of the image file from which to start the icon creation.
473 * @return mixed If success, image pointer, otherwise "-1"
474 * @access private
475 * @see t3lib_div::read_png_gif
476 */
477 function imagecreatefrom($file) {
478 $file = t3lib_div::read_png_gif($file,$GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']);
479 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
480 return $file ? imagecreatefrompng($file) : -1;
481 } else {
482 return $file ? imagecreatefromgif($file) : -1;
483 }
484 }
485
486 /**
487 * Write the icon in $im pointer to $path
488 *
489 * @param pointer Pointer to GDlib image resource
490 * @param string Absolute path to the filename in which to write the icon.
491 * @return void
492 * @access private
493 */
494 function imagemake($im, $path) {
495 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
496 @ImagePng($im, $path);
497 } else {
498 @ImageGif($im, $path);
499 }
500 }
501 }
502 ?>