Updated Copyright notices
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_iconworks.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2008 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 * 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 <kasperYYYY@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 * 264: function skinImg($backPath,$src,$wHattribs='',$outputMode=0)
45 *
46 * SECTION: Other functions
47 * 353: function makeIcon($iconfile,$mode, $user, $protectSection,$absFile,$iconFileName_stateTagged)
48 * 475: function imagecopyresized(&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h)
49 * 505: function imagecreatefrom($file)
50 * 522: 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 <kasperYYYY@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 // Shadow:
126 if ($TCA[$table]['ctrl']['versioningWS']) {
127 switch((int)$row['t3ver_state']) {
128 case 1:
129 return 'gfx/i/shadow_hide.png';
130 break;
131 case 2:
132 return 'gfx/i/shadow_delete.png';
133 break;
134 case 3:
135 return 'gfx/i/shadow_moveto_plh.png';
136 break;
137 case 4:
138 return 'gfx/i/shadow_moveto_pointer.png';
139 break;
140 }
141 }
142
143 // First, find the icon file name. This can depend on configuration in TCA, field values and more:
144 if ($table=='pages') {
145 // @TODO: RFC #7370: doktype 2&5 are deprecated since TYPO3 4.2-beta1
146 if ($row['nav_hide'] && ($row['doktype']==1||$row['doktype']==2)) $row['doktype']=5; // Workaround to change the icon if "Hide in menu" was set
147
148 if (!$iconfile = $PAGES_TYPES[$row['doktype']]['icon']) {
149 $iconfile = $PAGES_TYPES['default']['icon'];
150 }
151 if ($row['module'] && $ICON_TYPES[$row['module']]['icon']) {
152 $iconfile = $ICON_TYPES[$row['module']]['icon'];
153 }
154 } else {
155 if (!$iconfile = $TCA[$table]['ctrl']['typeicons'][$row[$TCA[$table]['ctrl']['typeicon_column']]]) {
156 $iconfile = (($TCA[$table]['ctrl']['iconfile']) ? $TCA[$table]['ctrl']['iconfile'] : $table.'.gif');
157 }
158 }
159
160 // Setting path of iconfile if not already set. Default is "gfx/i/"
161 if (!strstr($iconfile,'/')) {
162 $iconfile = 'gfx/i/'.$iconfile;
163 }
164
165 // Setting the absolute path where the icon should be found as a file:
166 if (substr($iconfile,0,3)=='../') {
167 $absfile=PATH_site.substr($iconfile,3);
168 } else {
169 $absfile=PATH_typo3.$iconfile;
170 }
171
172 // Initializing variables, all booleans except otherwise stated:
173 $hidden = FALSE;
174 $timing = FALSE;
175 $futuretiming = FALSE;
176 $user = FALSE; // In fact an integer value...
177 $deleted = FALSE;
178 $protectSection = FALSE; // Set, if a page-record (only pages!) has the extend-to-subpages flag set.
179 $noIconFound = $row['_NO_ICON_FOUND'] ? TRUE : FALSE;
180 // + $shaded which is also boolean!
181
182 // Icon state based on "enableFields":
183 if (is_array($TCA[$table]['ctrl']['enablecolumns'])) {
184 $enCols = $TCA[$table]['ctrl']['enablecolumns'];
185 // If "hidden" is enabled:
186 if ($enCols['disabled']) { if ($row[$enCols['disabled']]) { $hidden = TRUE; }}
187 // If a "starttime" is set and higher than current time:
188 if ($enCols['starttime']) { if (time() < intval($row[$enCols['starttime']])) { $timing = TRUE; }}
189 // If an "endtime" is set:
190 if ($enCols['endtime']) {
191 if (intval($row[$enCols['endtime']]) > 0) {
192 if (intval($row[$enCols['endtime']]) < time()) {
193 $timing = TRUE; // End-timing applies at this point.
194 } else {
195 $futuretiming = TRUE; // End-timing WILL apply in the future for this element.
196 }
197 }
198 }
199 // If a user-group field is set:
200 if ($enCols['fe_group']) {
201 $user = $row[$enCols['fe_group']];
202 if ($user && $doNotRenderUserGroupNumber) $user=100; // Limit for user number rendering!
203 }
204 }
205
206 // If "deleted" flag is set (only when listing records which are also deleted!)
207 if ($col=$row[$TCA[$table]['ctrl']['delete']]) {
208 $deleted = TRUE;
209 }
210 // Detecting extendToSubpages (for pages only)
211 if ($table=='pages' && $row['extendToSubpages'] && ($hidden || $timing || $futuretiming || $user)) {
212 $protectSection = TRUE;
213 }
214
215 // If ANY of the booleans are set it means we have to alter the icon:
216 if ($hidden || $timing || $futuretiming || $user || $deleted || $shaded || $noIconFound) {
217 $flags='';
218 $string='';
219 if ($deleted) {
220 $string='deleted';
221 $flags='d';
222 } elseif ($noIconFound) { // This is ONLY for creating icons with "?" on easily...
223 $string='no_icon_found';
224 $flags='x';
225 } else {
226 if ($hidden) $string.='hidden';
227 if ($timing) $string.='timing';
228 if (!$string && $futuretiming) {
229 $string='futuretiming';
230 }
231
232 $flags.=
233 ($hidden ? 'h' : '').
234 ($timing ? 't' : '').
235 ($futuretiming ? 'f' : '').
236 ($user ? 'u' : '').
237 ($protectSection ? 'p' : '').
238 ($shaded ? 's' : '');
239 }
240
241 // Create tagged icon file name:
242 $iconFileName_stateTagged = ereg_replace('.([[:alnum:]]+)$','__'.$flags.'.\1',basename($iconfile));
243
244 // 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)
245 if (@is_file(dirname($absfile).'/'.$iconFileName_stateTagged)) { // Look for [iconname]_xxxx.[ext]
246 return dirname($iconfile).'/'.$iconFileName_stateTagged;
247 } elseif ($doNotGenerateIcon) { // If no icon generation can be done, try to look for the _X icon:
248 $iconFileName_X = ereg_replace('.([[:alnum:]]+)$','__x.\1',basename($iconfile));
249 if (@is_file(dirname($absfile).'/'.$iconFileName_X)) {
250 return dirname($iconfile).'/'.$iconFileName_X;
251 } else {
252 return 'gfx/i/no_icon_found.gif';
253 }
254 } else { // Otherwise, create the icon:
255 $theRes = t3lib_iconWorks::makeIcon($GLOBALS['BACK_PATH'].$iconfile, $string, $user, $protectSection, $absfile, $iconFileName_stateTagged);
256 return $theRes;
257 }
258 } else {
259 return $iconfile;
260 }
261 }
262
263 /**
264 * Returns the src=... for the input $src value OR any alternative found in $TBE_STYLES['skinImg']
265 * Used for skinning the TYPO3 backend with an alternative set of icons
266 * Usage: 336
267 *
268 * @param string Current backpath to PATH_typo3 folder
269 * @param string Icon file name relative to PATH_typo3 folder
270 * @param string Default width/height, defined like 'width="12" height="14"'
271 * @param integer Mode: 0 (zero) is default and returns src/width/height. 1 returns value of src+backpath, 2 returns value of w/h.
272 * @return string Returns ' src="[backPath][src]" [wHattribs]'
273 * @see skinImgFile()
274 */
275 function skinImg($backPath,$src,$wHattribs='',$outputMode=0) {
276
277 // Setting source key. If the icon is refered to inside an extension, we homogenize the prefix to "ext/":
278 $srcKey = ereg_replace('^(\.\.\/typo3conf\/ext|sysext|ext)\/','ext/',$src);
279 #if ($src!=$srcKey)debug(array($src,$srcKey));
280
281 // LOOKING for alternative icons:
282 if ($GLOBALS['TBE_STYLES']['skinImg'][$srcKey]) { // Slower or faster with is_array()? Could be used.
283 list($src,$wHattribs) = $GLOBALS['TBE_STYLES']['skinImg'][$srcKey];
284 } elseif ($GLOBALS['TBE_STYLES']['skinImgAutoCfg']) { // Otherwise, test if auto-detection is enabled:
285
286 // Search for alternative icon automatically:
287 $fExt = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['forceFileExtension'];
288 $scaleFactor = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['scaleFactor'] ? $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['scaleFactor'] : 1; // Scaling factor
289 $lookUpName = $fExt ? ereg_replace('\.[[:alnum:]]+$','',$srcKey).'.'.$fExt : $srcKey; // Set filename to look for
290
291 // If file is found:
292 if (@is_file($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'].$lookUpName)) { // If there is a file...
293 $iInfo = @getimagesize($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'].$lookUpName); // Get width/height:
294
295 // Set $src and $wHattribs:
296 $src = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['relDir'].$lookUpName;
297 $wHattribs = 'width="'.round($iInfo[0]*$scaleFactor).'" height="'.round($iInfo[1]*$scaleFactor).'"';
298 }
299
300 // 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.
301 $GLOBALS['TBE_STYLES']['skinImg'][$srcKey] = array($src,$wHattribs); // Set default...
302 }
303
304 // DEBUG: This doubles the size of all icons - for testing/debugging:
305 # if (ereg('^width="([0-9]+)" height="([0-9]+)"$',$wHattribs,$reg)) $wHattribs='width="'.($reg[1]*2).'" height="'.($reg[2]*2).'"';
306
307
308 // rendering disabled (greyed) icons using _i (inactive) as name suffix ("_d" is already used)
309 $matches = array();
310 $srcBasename = basename($src);
311 if (preg_match('/(.*)_i(\....)$/', $srcBasename, $matches)) {
312 $temp_path = dirname(PATH_thisScript).'/';
313 if(!@is_file($temp_path.$backPath.$src)) {
314 $srcOrg = preg_replace('/_i'.preg_quote($matches[2]).'$/', $matches[2], $src);
315 $src = t3lib_iconWorks::makeIcon($backPath.$srcOrg, 'disabled', 0, false, $temp_path.$backPath.$srcOrg, $srcBasename);
316 }
317 }
318
319
320 // Return icon source/wHattributes:
321 $output = '';
322 switch($outputMode) {
323 case 0:
324 $output = ' src="'.$backPath.$src.'" '.$wHattribs;
325 break;
326 case 1:
327 $output = $backPath.$src;
328 break;
329 case 2:
330 $output = $wHattribs;
331 break;
332 }
333 return $output;
334 }
335
336
337
338
339
340
341
342
343
344
345
346 /***********************************
347 *
348 * Other functions
349 *
350 ***********************************/
351
352 /**
353 * Creates the icon file for the function getIcon()
354 *
355 * @param string Original unprocessed Icon file, relative path to PATH_typo3
356 * @param string Mode string, eg. "deleted" or "futuretiming" determining how the icon will look
357 * @param integer The number of the fe_group record uid if applicable
358 * @param boolean Flag determines if the protected-section icon should be applied.
359 * @param string Absolute path to file from which to create the icon.
360 * @param string The filename that this icon should have had, basically [icon base name]_[flags].[extension] - used for part of temporary filename
361 * @return string Filename relative to PATH_typo3
362 * @access private
363 */
364 function makeIcon($iconfile,$mode, $user, $protectSection,$absFile,$iconFileName_stateTagged) {
365 $iconFileName = 'icon_'.t3lib_div::shortMD5($iconfile.'|'.$mode.'|-'.$user.'|'.$protectSection).'_'.$iconFileName_stateTagged.'.'.($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']?'png':'gif');
366 $mainpath = '../typo3temp/'.$iconFileName;
367 $path = PATH_site.'typo3temp/'.$iconFileName;
368
369
370 if (@file_exists(PATH_typo3.'icons/'.$iconFileName)) { // Returns if found in typo3/icons/
371 return 'icons/'.$iconFileName;
372 } elseif (@file_exists($path)) { // Returns if found in ../typo3temp/icons/
373 return $mainpath;
374 } else { // Makes icon:
375 if (@file_exists($absFile)) {
376 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']) {
377
378 // Create image pointer, if possible
379 $im = t3lib_iconworks::imagecreatefrom($absFile);
380 if ($im<0) return $iconfile;
381
382 // Converting to gray scale, dimming the icon:
383 if (($mode=='disabled') OR ($mode!='futuretiming' && $mode!='no_icon_found' && !(!$mode && $user))) {
384 for ($c=0; $c<ImageColorsTotal($im); $c++) {
385 $cols = ImageColorsForIndex($im,$c);
386 $newcol = round(($cols['red']+$cols['green']+$cols['blue'])/3);
387 $lighten = ($mode=='disabled') ? 2.5 : 2;
388 $newcol = round(255-((255-$newcol)/$lighten));
389 ImageColorSet($im,$c,$newcol,$newcol,$newcol);
390 }
391 }
392 // Applying user icon, if there are access control on the item:
393 if ($user) {
394 if ($user < 100) { // Apply user number only if lower than 100
395 $black = ImageColorAllocate($im, 0,0,0);
396 imagefilledrectangle($im, 0,0,(($user>10)?9:5),8,$black);
397
398 $white = ImageColorAllocate($im, 255,255,255);
399 imagestring($im, 1, 1, 1, $user, $white);
400 }
401
402 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_group.gif');
403 if ($ol_im<0) return $iconfile;
404
405 t3lib_iconworks::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
406 }
407 // Applying overlay based on mode:
408 if ($mode) {
409 unset($ol_im);
410 switch($mode) {
411 case 'deleted':
412 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_deleted.gif');
413 break;
414 case 'futuretiming':
415 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_timing.gif');
416 break;
417 case 'timing':
418 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_timing.gif');
419 break;
420 case 'hiddentiming':
421 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_hidden_timing.gif');
422 break;
423 case 'no_icon_found':
424 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_no_icon_found.gif');
425 break;
426 case 'disabled':
427 // is already greyed - nothing more
428 $ol_im = 0;
429 break;
430 case 'hidden':
431 default:
432 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_hidden.gif');
433 break;
434 }
435 if ($ol_im<0) return $iconfile;
436 if ($ol_im) {
437 t3lib_iconworks::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
438 }
439 }
440 // Protect-section icon:
441 if ($protectSection) {
442 $ol_im = t3lib_iconworks::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_sub5.gif');
443 if ($ol_im<0) return $iconfile;
444 t3lib_iconworks::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
445 }
446
447 // Create the image as file, destroy GD image and return:
448 @t3lib_iconWorks::imagemake($im, $path);
449 t3lib_div::gif_compress($path, 'IM');
450 ImageDestroy($im);
451 return $mainpath;
452 } else {
453 return $iconfile;
454 }
455 } else {
456 return $GLOBALS['BACK_PATH'].'gfx/fileicons/default.gif';
457 }
458 }
459 }
460
461 /**
462 * The necessity of using this function for combining two images if GD is version 2 is that
463 * GD2 cannot manage to combine two indexed-color images without totally spoiling everything.
464 * In class.t3lib_stdgraphic this was solved by combining the images onto a first created true color image
465 * However it has turned out that this method will not work if the indexed png-files contains transparency.
466 * So I had to turn my attention to ImageMagick - my 'enemy of death'.
467 * And so it happend - ImageMagick is now used to combine my two indexed-color images with transparency. And that works.
468 * 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+)
469 * 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.
470 *
471 * For parameters, see PHP function "imagecopyresized()"
472 *
473 * @param pointer see PHP function "imagecopyresized()"
474 * @param pointer see PHP function "imagecopyresized()"
475 * @param integer see PHP function "imagecopyresized()"
476 * @param integer see PHP function "imagecopyresized()"
477 * @param integer see PHP function "imagecopyresized()"
478 * @param integer see PHP function "imagecopyresized()"
479 * @param integer see PHP function "imagecopyresized()"
480 * @param integer see PHP function "imagecopyresized()"
481 * @param integer see PHP function "imagecopyresized()"
482 * @param integer see PHP function "imagecopyresized()"
483 * @return void
484 * @access private
485 */
486 function imagecopyresized(&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h) {
487 imagecopyresized($im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h);
488 }
489
490 /**
491 * Create new image pointer from input file (either gif/png, in case the wrong format it is converted by t3lib_div::read_png_gif())
492 *
493 * @param string Absolute filename of the image file from which to start the icon creation.
494 * @return mixed If success, image pointer, otherwise "-1"
495 * @access private
496 * @see t3lib_div::read_png_gif
497 */
498 function imagecreatefrom($file) {
499 $file = t3lib_div::read_png_gif($file,$GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']);
500 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
501 return $file ? imagecreatefrompng($file) : -1;
502 } else {
503 return $file ? imagecreatefromgif($file) : -1;
504 }
505 }
506
507 /**
508 * Write the icon in $im pointer to $path
509 *
510 * @param pointer Pointer to GDlib image resource
511 * @param string Absolute path to the filename in which to write the icon.
512 * @return void
513 * @access private
514 */
515 function imagemake($im, $path) {
516 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
517 @ImagePng($im, $path);
518 } else {
519 @ImageGif($im, $path);
520 }
521 }
522 }
523 ?>