2 /***************************************************************
5 * (c) 1999-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
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.
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.
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.
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
28 * Contains class for icon generation in the backend
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
37 * [CLASS/FUNCTION INDEX of SCRIPT]
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)
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)
53 * (This index is automatically created/updated by the extension "extdeveval")
67 * Icon generation, backend
68 * This library has functions that returns - and if necessary creates - the icon for an element in TYPO3
70 * Expects global vars:
73 * - $TCA, $PAGES_TYPES
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()"
81 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
85 final class t3lib_iconWorks
{
88 * Returns an icon image tag, 18x16 pixels, based on input information.
89 * This function is recommended to use in your backend modules.
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
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="')) {
110 * Creates the icon for input table/row
111 * Returns filename for the image icon, relative to PATH_typo3
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()
120 public static function getIcon($table, $row = array(), $shaded = FALSE
) {
121 global $TCA, $PAGES_TYPES, $ICON_TYPES;
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...
128 if ($TCA[$table]['ctrl']['versioningWS']) {
129 switch((int)$row['t3ver_state']) {
131 return 'gfx/i/shadow_hide.png';
134 return 'gfx/i/shadow_delete.png';
137 return 'gfx/i/shadow_moveto_plh.png';
140 return 'gfx/i/shadow_moveto_pointer.png';
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
150 if (!$iconfile = $PAGES_TYPES[$row['doktype']]['icon']) {
151 $iconfile = $PAGES_TYPES['default']['icon'];
153 if ($row['module'] && $ICON_TYPES[$row['module']]['icon']) {
154 $iconfile = $ICON_TYPES[$row['module']]['icon'];
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');
162 // Setting path of iconfile if not already set. Default is "gfx/i/"
163 if (!strstr($iconfile, '/')) {
164 $iconfile = 'gfx/i/'.$iconfile;
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);
171 $absfile = PATH_typo3
.$iconfile;
174 // Initializing variables, all booleans except otherwise stated:
177 $futuretiming = FALSE
;
178 $user = FALSE
; // In fact an integer value...
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!
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.
197 $futuretiming = TRUE
; // End-timing WILL apply in the future for this element.
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!
208 // If "deleted" flag is set (only when listing records which are also deleted!)
209 if ($col = $row[$TCA[$table]['ctrl']['delete']]) {
212 // Detecting extendToSubpages (for pages only)
213 if ($table=='pages' && $row['extendToSubpages'] && ($hidden ||
$timing ||
$futuretiming ||
$user)) {
214 $protectSection = TRUE
;
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) {
224 } elseif ($noIconFound) { // This is ONLY for creating icons with "?" on easily...
225 $string = 'no_icon_found';
228 if ($hidden) $string.='hidden';
229 if ($timing) $string.='timing';
230 if (!$string && $futuretiming) {
231 $string = 'futuretiming';
235 ($hidden ?
'h' : '').
236 ($timing ?
't' : '').
237 ($futuretiming ?
'f' : '').
239 ($protectSection ?
'p' : '').
240 ($shaded ?
's' : '');
243 // Create tagged icon file name:
244 $iconFileName_stateTagged = ereg_replace('.([[:alnum:]]+)$', '__'.$flags.'.\1', basename($iconfile));
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;
254 return 'gfx/i/no_icon_found.gif';
256 } else { // Otherwise, create the icon:
257 $theRes = t3lib_iconWorks
::makeIcon($GLOBALS['BACK_PATH'].$iconfile, $string, $user, $protectSection, $absfile, $iconFileName_stateTagged);
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
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]'
277 public static function skinImg($backPath, $src, $wHattribs = '', $outputMode = 0) {
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));
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:
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
293 if ($fExt && !@is_file
($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'] . $lookUpName)) {
294 // fallback to original filename if icon with forced extension doesn't exists
295 $lookUpName = $srcKey;
298 if (@is_file
($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'].$lookUpName)) { // If there is a file...
299 $iInfo = @getimagesize
($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'].$lookUpName); // Get width/height:
301 // Set $src and $wHattribs:
302 $src = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['relDir'].$lookUpName;
303 $wHattribs = 'width="'.round($iInfo[0]*$scaleFactor).'" height="'.round($iInfo[1]*$scaleFactor).'"';
306 // 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.
307 $GLOBALS['TBE_STYLES']['skinImg'][$srcKey] = array($src, $wHattribs); // Set default...
310 // DEBUG: This doubles the size of all icons - for testing/debugging:
311 # if (ereg('^width="([0-9]+)" height="([0-9]+)"$', $wHattribs, $reg)) $wHattribs='width="'.($reg[1]*2).'" height="'.($reg[2]*2).'"';
314 // rendering disabled (greyed) icons using _i (inactive) as name suffix ("_d" is already used)
316 $srcBasename = basename($src);
317 if (preg_match('/(.*)_i(\....)$/', $srcBasename, $matches)) {
318 $temp_path = dirname(PATH_thisScript
).'/';
319 if(!@is_file
($temp_path.$backPath.$src)) {
320 $srcOrg = preg_replace('/_i'.preg_quote($matches[2]).'$/', $matches[2], $src);
321 $src = t3lib_iconWorks
::makeIcon($backPath.$srcOrg, 'disabled', 0, false
, $temp_path.$backPath.$srcOrg, $srcBasename);
326 // Return icon source/wHattributes:
328 switch($outputMode) {
330 $output = ' src="'.$backPath.$src.'" '.$wHattribs;
333 $output = $backPath.$src;
336 $output = $wHattribs;
352 /***********************************
356 ***********************************/
359 * Creates the icon file for the function getIcon()
361 * @param string Original unprocessed Icon file, relative path to PATH_typo3
362 * @param string Mode string, eg. "deleted" or "futuretiming" determining how the icon will look
363 * @param integer The number of the fe_group record uid if applicable
364 * @param boolean Flag determines if the protected-section icon should be applied.
365 * @param string Absolute path to file from which to create the icon.
366 * @param string The filename that this icon should have had, basically [icon base name]_[flags].[extension] - used for part of temporary filename
367 * @return string Filename relative to PATH_typo3
370 public static function makeIcon($iconfile, $mode, $user, $protectSection, $absFile, $iconFileName_stateTagged) {
371 $iconFileName = 'icon_'.t3lib_div
::shortMD5($iconfile.'|'.$mode.'|-'.$user.'|'.$protectSection).'_'.$iconFileName_stateTagged.'.'.($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']?
'png':'gif');
372 $mainpath = '../typo3temp/'.$iconFileName;
373 $path = PATH_site
.'typo3temp/'.$iconFileName;
376 if (file_exists(PATH_typo3
.'icons/'.$iconFileName)) { // Returns if found in typo3/icons/
377 return 'icons/'.$iconFileName;
378 } elseif (file_exists($path)) { // Returns if found in ../typo3temp/icons/
380 } else { // Makes icon:
381 if (file_exists($absFile)) {
382 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']) {
384 // Create image pointer, if possible
385 $im = t3lib_iconworks
::imagecreatefrom($absFile);
386 if ($im<0) return $iconfile;
388 // Converting to gray scale, dimming the icon:
389 if (($mode=='disabled') OR ($mode!='futuretiming' && $mode!='no_icon_found' && !(!$mode && $user))) {
390 for ($c = 0; $c<ImageColorsTotal($im); $c++
) {
391 $cols = ImageColorsForIndex($im, $c);
392 $newcol = round(($cols['red']+
$cols['green']+
$cols['blue'])/3);
393 $lighten = ($mode=='disabled') ?
2.5 : 2;
394 $newcol = round(255-((255-$newcol)/$lighten));
395 ImageColorSet($im, $c, $newcol, $newcol, $newcol);
398 // Applying user icon, if there are access control on the item:
400 if ($user < 100) { // Apply user number only if lower than 100
401 $black = ImageColorAllocate($im, 0, 0, 0);
402 imagefilledrectangle($im, 0, 0, (($user>10)?
9:5), 8, $black);
404 $white = ImageColorAllocate($im, 255, 255, 255);
405 imagestring($im, 1, 1, 1, $user, $white);
408 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_group.gif');
409 if ($ol_im<0) return $iconfile;
411 t3lib_iconworks
::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
413 // Applying overlay based on mode:
418 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_deleted.gif');
421 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_timing.gif');
424 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_timing.gif');
427 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_hidden_timing.gif');
429 case 'no_icon_found':
430 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_no_icon_found.gif');
433 // is already greyed - nothing more
438 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_hidden.gif');
441 if ($ol_im<0) return $iconfile;
443 t3lib_iconworks
::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
446 // Protect-section icon:
447 if ($protectSection) {
448 $ol_im = t3lib_iconworks
::imagecreatefrom($GLOBALS['BACK_PATH'].'gfx/overlay_sub5.gif');
449 if ($ol_im<0) return $iconfile;
450 t3lib_iconworks
::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
453 // Create the image as file, destroy GD image and return:
454 @t3lib_iconWorks
::imagemake($im, $path);
455 t3lib_div
::gif_compress($path, 'IM');
462 return $GLOBALS['BACK_PATH'].'gfx/fileicons/default.gif';
468 * The necessity of using this function for combining two images if GD is version 2 is that
469 * GD2 cannot manage to combine two indexed-color images without totally spoiling everything.
470 * In class.t3lib_stdgraphic this was solved by combining the images onto a first created true color image
471 * However it has turned out that this method will not work if the indexed png-files contains transparency.
472 * So I had to turn my attention to ImageMagick - my 'enemy of death'.
473 * And so it happend - ImageMagick is now used to combine my two indexed-color images with transparency. And that works.
474 * 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+)
475 * 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.
477 * For parameters, see PHP function "imagecopyresized()"
479 * @param pointer see PHP function "imagecopyresized()"
480 * @param pointer 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 * @param integer see PHP function "imagecopyresized()"
486 * @param integer see PHP function "imagecopyresized()"
487 * @param integer see PHP function "imagecopyresized()"
488 * @param integer see PHP function "imagecopyresized()"
492 public static function imagecopyresized(&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h) {
493 imagecopyresized($im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h);
497 * Create new image pointer from input file (either gif/png, in case the wrong format it is converted by t3lib_div::read_png_gif())
499 * @param string Absolute filename of the image file from which to start the icon creation.
500 * @return mixed If success, image pointer, otherwise "-1"
502 * @see t3lib_div::read_png_gif
504 public static function imagecreatefrom($file) {
505 $file = t3lib_div
::read_png_gif($file, $GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']);
506 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
507 return $file ?
imagecreatefrompng($file) : -1;
509 return $file ?
imagecreatefromgif($file) : -1;
514 * Write the icon in $im pointer to $path
516 * @param pointer Pointer to GDlib image resource
517 * @param string Absolute path to the filename in which to write the icon.
521 public static function imagemake($im, $path) {
522 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
523 @ImagePng
($im, $path);
525 @ImageGif
($im, $path);