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