<?php
namespace TYPO3\CMS\Frontend\Imaging;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 1999-2013 Kasper Skårhøj (kasperYYYY@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * GIFBUILDER
 *
 * Generating gif/png-files from TypoScript
 * Used by the menu-objects and imgResource in TypoScript.
 *
 * This class allows for advanced rendering of images with various layers of images, text and graphical primitives.
 * The concept is known from TypoScript as "GIFBUILDER" where you can define a "numerical array" (TypoScript term as well) of "GIFBUILDER OBJECTS" (like "TEXT", "IMAGE", etc.) and they will be rendered onto an image one by one.
 * The name "GIFBUILDER" comes from the time where GIF was the only file format supported. PNG is just as well to create today (configured with TYPO3_CONF_VARS[GFX])
 * Not all instances of this class is truely building gif/png files by layers; You may also see the class instantiated for the purpose of using the scaling functions in the parent class.
 *
 * Here is an example of how to use this class (from tslib_content.php, function getImgResource):
 *
 * $gifCreator = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\Imaging\\GifBuilder');
 * $gifCreator->init();
 * $theImage='';
 * if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']) {
 * $gifCreator->start($fileArray, $this->data);
 * $theImage = $gifCreator->gifBuild();
 * }
 * return $gifCreator->getImageDimensions($theImage);
 *
 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
 */
class GifBuilder extends \TYPO3\CMS\Core\Imaging\GraphicalFunctions {

	// Internal
	// the main image
	/**
	 * @todo Define visibility
	 */
	public $im = '';

	// the image-width
	/**
	 * @todo Define visibility
	 */
	public $w = 0;

	// the image-height
	/**
	 * @todo Define visibility
	 */
	public $h = 0;

	// map-data
	/**
	 * @todo Define visibility
	 */
	public $map;

	/**
	 * @todo Define visibility
	 */
	public $workArea;

	// This holds the operational setup for gifbuilder. Basically this is a TypoScript array with properties.
	/**
	 * @todo Define visibility
	 */
	public $setup = array();

	// Contains all text strings used on this image
	/**
	 * @todo Define visibility
	 */
	public $combinedTextStrings = array();

	// Contains all filenames (basename without extension) used on this image
	/**
	 * @todo Define visibility
	 */
	public $combinedFileNames = array();

	// This is the array from which data->field: [key] is fetched. So this is the current record!
	/**
	 * @todo Define visibility
	 */
	public $data = array();

	/**
	 * @todo Define visibility
	 */
	public $objBB = array();

	/**
	 * @todo Define visibility
	 */
	public $myClassName = 'gifbuilder';

	/**
	 * @todo Define visibility
	 */
	public $charRangeMap = array();

	/**
	 * Initialization of the GIFBUILDER objects, in particular TEXT and IMAGE. This includes finding the bounding box, setting dimensions and offset values before the actual rendering is started.
	 * Modifies the ->setup, ->objBB internal arrays
	 * Should be called after the ->init() function which initializes the parent class functions/variables in general.
	 * The class \TYPO3\CMS\Frontend\ContentObject\Menu\GraphicalMenuContentObject also uses gifbuilder and here there is an interesting use since the function findLargestDims() from that class calls the init() and start() functions to find the total dimensions before starting the rendering of the images.
	 *
	 * @param array $conf TypoScript properties for the GIFBUILDER session. Stored internally in the variable ->setup
	 * @param array $data The current data record from \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer. Stored internally in the variable ->data
	 * @return void
	 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getImgResource(), \TYPO3\CMS\Frontend\ContentObject\Menu\GraphicalMenuContentObject::makeGifs(), \TYPO3\CMS\Frontend\ContentObject\Menu\GraphicalMenuContentObject::findLargestDims()
	 * @todo Define visibility
	 */
	public function start($conf, $data) {
		if (is_array($conf)) {
			$this->setup = $conf;
			$this->data = $data;
			$this->cObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
			$this->cObj->start($this->data);
			// Hook preprocess gifbuilder conf
			// Added by Julle for 3.8.0
			//
			// Let's you pre-process the gifbuilder configuration. for
			// example you can split a string up into lines and render each
			// line as TEXT obj, see extension julle_gifbconf
			if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_gifbuilder.php']['gifbuilder-ConfPreProcess'])) {
				foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_gifbuilder.php']['gifbuilder-ConfPreProcess'] as $_funcRef) {
					$_params = $this->setup;
					$this->setup = \TYPO3\CMS\Core\Utility\GeneralUtility::callUserFunction($_funcRef, $_params, $this);
				}
			}
			// Initializing global Char Range Map
			$this->charRangeMap = array();
			if (is_array($GLOBALS['TSFE']->tmpl->setup['_GIFBUILDER.']['charRangeMap.'])) {
				foreach ($GLOBALS['TSFE']->tmpl->setup['_GIFBUILDER.']['charRangeMap.'] as $cRMcfgkey => $cRMcfg) {
					if (is_array($cRMcfg)) {
						// Initializing:
						$cRMkey = $GLOBALS['TSFE']->tmpl->setup['_GIFBUILDER.']['charRangeMap.'][substr($cRMcfgkey, 0, -1)];
						$this->charRangeMap[$cRMkey] = array();
						$this->charRangeMap[$cRMkey]['charMapConfig'] = $cRMcfg['charMapConfig.'];
						$this->charRangeMap[$cRMkey]['cfgKey'] = substr($cRMcfgkey, 0, -1);
						$this->charRangeMap[$cRMkey]['multiplicator'] = (double) $cRMcfg['fontSizeMultiplicator'];
						$this->charRangeMap[$cRMkey]['pixelSpace'] = intval($cRMcfg['pixelSpaceFontSizeRef']);
					}
				}
			}
			// Getting sorted list of TypoScript keys from setup.
			$sKeyArray = \TYPO3\CMS\Core\TypoScript\TemplateService::sortedKeyList($this->setup);
			// Setting the background color, passing it through stdWrap
			if ($conf['backColor.'] || $conf['backColor']) {
				$this->setup['backColor'] = isset($this->setup['backColor.']) ? trim($this->cObj->stdWrap($this->setup['backColor'], $this->setup['backColor.'])) : $this->setup['backColor'];
			}
			if (!$this->setup['backColor']) {
				$this->setup['backColor'] = 'white';
			}
			if ($conf['transparentColor.'] || $conf['transparentColor']) {
				$this->setup['transparentColor_array'] = isset($this->setup['transparentColor.']) ? explode('|', trim($this->cObj->stdWrap($this->setup['transparentColor'], $this->setup['transparentColor.']))) : explode('|', trim($this->setup['transparentColor']));
			}
			if (isset($this->setup['transparentBackground.'])) {
				$this->setup['transparentBackground'] = $this->cObj->stdWrap($this->setup['transparentBackground'], $this->setup['transparentBackground.']);
			}
			if (isset($this->setup['reduceColors.'])) {
				$this->setup['reduceColors'] = $this->cObj->stdWrap($this->setup['reduceColors'], $this->setup['reduceColors.']);
			}
			// Set default dimensions
			if (isset($this->setup['XY.'])) {
				$this->setup['XY'] = $this->cObj->stdWrap($this->setup['XY'], $this->setup['XY.']);
			}
			if (!$this->setup['XY']) {
				$this->setup['XY'] = '120,50';
			}
			// Checking TEXT and IMAGE objects for files. If any errors the objects are cleared.
			// The Bounding Box for the objects is stored in an array
			foreach ($sKeyArray as $theKey) {
				$theValue = $this->setup[$theKey];
				if (intval($theKey) && ($conf = $this->setup[$theKey . '.'])) {
					// Swipes through TEXT and IMAGE-objects
					switch ($theValue) {
					case 'TEXT':
						if ($this->setup[$theKey . '.'] = $this->checkTextObj($conf)) {
							// Adjust font width if max size is set:
							$maxWidth = isset($this->setup[$theKey . '.']['maxWidth.']) ? $this->cObj->stdWrap($this->setup[$theKey . '.']['maxWidth'], $this->setup[$theKey . '.']['maxWidth.']) : $this->setup[$theKey . '.']['maxWidth'];
							if ($maxWidth) {
								$this->setup[$theKey . '.']['fontSize'] = $this->fontResize($this->setup[$theKey . '.']);
							}
							// Calculate bounding box:
							$txtInfo = $this->calcBBox($this->setup[$theKey . '.']);
							$this->setup[$theKey . '.']['BBOX'] = $txtInfo;
							$this->objBB[$theKey] = $txtInfo;
							$this->setup[$theKey . '.']['imgMap'] = 0;
						}
						break;
					case 'IMAGE':
						$fileInfo = $this->getResource($conf['file'], $conf['file.']);
						if ($fileInfo) {
							$this->combinedFileNames[] = preg_replace('/\\.[[:alnum:]]+$/', '', basename($fileInfo[3]));
							$this->setup[$theKey . '.']['file'] = $fileInfo[3];
							$this->setup[$theKey . '.']['BBOX'] = $fileInfo;
							$this->objBB[$theKey] = $fileInfo;
							if ($conf['mask']) {
								$maskInfo = $this->getResource($conf['mask'], $conf['mask.']);
								if ($maskInfo) {
									$this->setup[$theKey . '.']['mask'] = $maskInfo[3];
								} else {
									$this->setup[$theKey . '.']['mask'] = '';
								}
							}
						} else {
							unset($this->setup[$theKey . '.']);
						}
						break;
					}
					// Checks if disabled is set... (this is also done in menu.php / imgmenu!!)
					if ($conf['if.']) {
						$cObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
						$cObj->start($this->data);
						if (!$cObj->checkIf($conf['if.'])) {
							unset($this->setup[$theKey]);
							unset($this->setup[$theKey . '.']);
						}
					}
				}
			}
			// Calculate offsets on elements
			$this->setup['XY'] = $this->calcOffset($this->setup['XY']);
			if (isset($this->setup['offset.'])) {
				$this->setup['offset'] = $this->cObj->stdWrap($this->setup['offset'], $this->setup['offset.']);
			}
			$this->setup['offset'] = $this->calcOffset($this->setup['offset']);
			if (isset($this->setup['workArea.'])) {
				$this->setup['workArea'] = $this->cObj->stdWrap($this->setup['workArea'], $this->setup['workArea.']);
			}
			$this->setup['workArea'] = $this->calcOffset($this->setup['workArea']);
			foreach ($sKeyArray as $theKey) {
				$theValue = $this->setup[$theKey];
				if (intval($theKey) && ($conf = $this->setup[$theKey . '.'])) {
					switch ($theValue) {
					case 'TEXT':

					case 'IMAGE':
						if (isset($this->setup[$theKey . '.']['offset.'])) {
							$this->setup[$theKey . '.']['offset'] = $this->cObj->stdWrap($this->setup[$theKey . '.']['offset'], $this->setup[$theKey . '.']['offset.']);
						}
						if ($this->setup[$theKey . '.']['offset']) {
							$this->setup[$theKey . '.']['offset'] = $this->calcOffset($this->setup[$theKey . '.']['offset']);
						}
						break;
					case 'BOX':

					case 'ELLIPSE':
						if (isset($this->setup[$theKey . '.']['dimensions.'])) {
							$this->setup[$theKey . '.']['dimensions'] = $this->cObj->stdWrap($this->setup[$theKey . '.']['dimensions'], $this->setup[$theKey . '.']['dimensions.']);
						}
						if ($this->setup[$theKey . '.']['dimensions']) {
							$this->setup[$theKey . '.']['dimensions'] = $this->calcOffset($this->setup[$theKey . '.']['dimensions']);
						}
						break;
					case 'WORKAREA':
						if (isset($this->setup[$theKey . '.']['set.'])) {
							$this->setup[$theKey . '.']['set'] = $this->cObj->stdWrap($this->setup[$theKey . '.']['set'], $this->setup[$theKey . '.']['set.']);
						}
						if ($this->setup[$theKey . '.']['set']) {
							$this->setup[$theKey . '.']['set'] = $this->calcOffset($this->setup[$theKey . '.']['set']);
						}
						break;
					case 'CROP':
						if (isset($this->setup[$theKey . '.']['crop.'])) {
							$this->setup[$theKey . '.']['crop'] = $this->cObj->stdWrap($this->setup[$theKey . '.']['crop'], $this->setup[$theKey . '.']['crop.']);
						}
						if ($this->setup[$theKey . '.']['crop']) {
							$this->setup[$theKey . '.']['crop'] = $this->calcOffset($this->setup[$theKey . '.']['crop']);
						}
						break;
					case 'SCALE':
						if (isset($this->setup[$theKey . '.']['width.'])) {
							$this->setup[$theKey . '.']['width'] = $this->cObj->stdWrap($this->setup[$theKey . '.']['width'], $this->setup[$theKey . '.']['width.']);
						}
						if ($this->setup[$theKey . '.']['width']) {
							$this->setup[$theKey . '.']['width'] = $this->calcOffset($this->setup[$theKey . '.']['width']);
						}
						if (isset($this->setup[$theKey . '.']['height.'])) {
							$this->setup[$theKey . '.']['height'] = $this->cObj->stdWrap($this->setup[$theKey . '.']['height'], $this->setup[$theKey . '.']['height.']);
						}
						if ($this->setup[$theKey . '.']['height']) {
							$this->setup[$theKey . '.']['height'] = $this->calcOffset($this->setup[$theKey . '.']['height']);
						}
						break;
					}
				}
			}
			// Get trivial data
			$XY = \TYPO3\CMS\Core\Utility\GeneralUtility::intExplode(',', $this->setup['XY']);
			$maxWidth = isset($this->setup['maxWidth.']) ? intval($this->cObj->stdWrap($this->setup['maxWidth'], $this->setup['maxWidth.'])) : intval($this->setup['maxWidth']);
			$maxHeight = isset($this->setup['maxHeight.']) ? intval($this->cObj->stdWrap($this->setup['maxHeight'], $this->setup['maxHeight.'])) : intval($this->setup['maxHeight']);
			$XY[0] = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange($XY[0], 1, $maxWidth ? $maxWidth : 2000);
			$XY[1] = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange($XY[1], 1, $maxHeight ? $maxHeight : 2000);
			$this->XY = $XY;
			$this->w = $XY[0];
			$this->h = $XY[1];
			$this->OFFSET = \TYPO3\CMS\Core\Utility\GeneralUtility::intExplode(',', $this->setup['offset']);
			// this sets the workArea
			$this->setWorkArea($this->setup['workArea']);
			// this sets the default to the current;
			$this->defaultWorkArea = $this->workArea;
		}
	}

	/**
	 * Initiates the image file generation if ->setup is TRUE and if the file did not exist already.
	 * Gets filename from fileName() and if file exists in typo3temp/ dir it will - of course - not be rendered again.
	 * Otherwise rendering means calling ->make(), then ->output(), then ->destroy()
	 *
	 * @return string The filename for the created GIF/PNG file. The filename will be prefixed "GB_
	 * @see make(), fileName()
	 * @todo Define visibility
	 */
	public function gifBuild() {
		if ($this->setup) {
			// Relative to PATH_site
			$gifFileName = $this->fileName('GB/');
			// File exists
			if (!file_exists($gifFileName)) {
				// Create temporary directory if not done:
				$this->createTempSubDir('GB/');
				// Create file:
				$this->make();
				$this->output($gifFileName);
				$this->destroy();
			}
			return $gifFileName;
		}
	}

	/**
	 * The actual rendering of the image file.
	 * Basically sets the dimensions, the background color, the traverses the array of GIFBUILDER objects and finally setting the transparent color if defined.
	 * Creates a GDlib resource in $this->im and works on that
	 * Called by gifBuild()
	 *
	 * @return void
	 * @access private
	 * @see gifBuild()
	 * @todo Define visibility
	 */
	public function make() {
		// Get trivial data
		$XY = $this->XY;
		// Reset internal properties
		$this->saveAlphaLayer = FALSE;
		// Gif-start
		$this->im = imagecreatetruecolor($XY[0], $XY[1]);
		$this->w = $XY[0];
		$this->h = $XY[1];
		// Transparent layer as background if set and requirements are met
		if (!empty($this->setup['backColor']) && $this->setup['backColor'] === 'transparent' && $this->png_truecolor && !$this->setup['reduceColors'] && (empty($this->setup['format']) || $this->setup['format'] === 'png')) {
			// Set transparency properties
			imagesavealpha($this->im, TRUE);
			// Fill with a transparent background
			$transparentColor = imagecolorallocatealpha($this->im, 0, 0, 0, 127);
			imagefill($this->im, 0, 0, $transparentColor);
			// Set internal properties to keep the transparency over the rendering process
			$this->saveAlphaLayer = TRUE;
			// Force PNG in case no format is set
			$this->setup['format'] = 'png';
		} else {
			// Fill the background with the given color
			$BGcols = $this->convertColor($this->setup['backColor']);
			$Bcolor = ImageColorAllocate($this->im, $BGcols[0], $BGcols[1], $BGcols[2]);
			ImageFilledRectangle($this->im, 0, 0, $XY[0], $XY[1], $Bcolor);
		}
		// Traverse the GIFBUILDER objects an render each one:
		if (is_array($this->setup)) {
			$sKeyArray = \TYPO3\CMS\Core\TypoScript\TemplateService::sortedKeyList($this->setup);
			foreach ($sKeyArray as $theKey) {
				$theValue = $this->setup[$theKey];
				if (intval($theKey) && ($conf = $this->setup[$theKey . '.'])) {
					// apply stdWrap to all properties, except for TEXT objects
					// all properties of the TEXT sub-object have already been stdWrap-ped
					// before in ->checkTextObj()
					if ($theValue !== 'TEXT') {
						$isStdWrapped = array();
						foreach ($conf as $key => $value) {
							$parameter = rtrim($key, '.');
							if (!$isStdWrapped[$parameter] && isset($conf[$parameter . '.'])) {
								$conf[$parameter] = $this->cObj->stdWrap($conf[$parameter], $conf[$parameter . '.']);
								$isStdWrapped[$parameter] = 1;
							}
						}
					}

					switch ($theValue) {
					case 'IMAGE':
						if ($conf['mask']) {
							$this->maskImageOntoImage($this->im, $conf, $this->workArea);
						} else {
							$this->copyImageOntoImage($this->im, $conf, $this->workArea);
						}
						break;
					case 'TEXT':
						if (!$conf['hide']) {
							if (is_array($conf['shadow.'])) {
								$isStdWrapped = array();
								foreach ($conf['shadow.'] as $key => $value) {
									$parameter = rtrim($key, '.');
									if (!$isStdWrapped[$parameter] && isset($conf[$parameter . '.'])) {
										$conf['shadow.'][$parameter] = $this->cObj->stdWrap($conf[$parameter], $conf[$parameter . '.']);
										$isStdWrapped[$parameter] = 1;
									}
								}
								$this->makeShadow($this->im, $conf['shadow.'], $this->workArea, $conf);
							}
							if (is_array($conf['emboss.'])) {
								$isStdWrapped = array();
								foreach ($conf['emboss.'] as $key => $value) {
									$parameter = rtrim($key, '.');
									if (!$isStdWrapped[$parameter] && isset($conf[$parameter . '.'])) {
										$conf['emboss.'][$parameter] = $this->cObj->stdWrap($conf[$parameter], $conf[$parameter . '.']);
										$isStdWrapped[$parameter] = 1;
									}
								}
								$this->makeEmboss($this->im, $conf['emboss.'], $this->workArea, $conf);
							}
							if (is_array($conf['outline.'])) {
								$isStdWrapped = array();
								foreach ($conf['outline.'] as $key => $value) {
									$parameter = rtrim($key, '.');
									if (!$isStdWrapped[$parameter] && isset($conf[$parameter . '.'])) {
										$conf['outline.'][$parameter] = $this->cObj->stdWrap($conf[$parameter], $conf[$parameter . '.']);
										$isStdWrapped[$parameter] = 1;
									}
								}
								$this->makeOutline($this->im, $conf['outline.'], $this->workArea, $conf);
							}
							$conf['imgMap'] = 1;
							$this->makeText($this->im, $conf, $this->workArea);
						}
						break;
					case 'OUTLINE':
						if ($this->setup[$conf['textObjNum']] == 'TEXT' && ($txtConf = $this->checkTextObj($this->setup[$conf['textObjNum'] . '.']))) {
							$this->makeOutline($this->im, $conf, $this->workArea, $txtConf);
						}
						break;
					case 'EMBOSS':
						if ($this->setup[$conf['textObjNum']] == 'TEXT' && ($txtConf = $this->checkTextObj($this->setup[$conf['textObjNum'] . '.']))) {
							$this->makeEmboss($this->im, $conf, $this->workArea, $txtConf);
						}
						break;
					case 'SHADOW':
						if ($this->setup[$conf['textObjNum']] == 'TEXT' && ($txtConf = $this->checkTextObj($this->setup[$conf['textObjNum'] . '.']))) {
							$this->makeShadow($this->im, $conf, $this->workArea, $txtConf);
						}
						break;
					case 'BOX':
						$this->makeBox($this->im, $conf, $this->workArea);
						break;
					case 'EFFECT':
						$this->makeEffect($this->im, $conf);
						break;
					case 'ADJUST':
						$this->adjust($this->im, $conf);
						break;
					case 'CROP':
						$this->crop($this->im, $conf);
						break;
					case 'SCALE':
						$this->scale($this->im, $conf);
						break;
					case 'WORKAREA':
						if ($conf['set']) {
							// this sets the workArea
							$this->setWorkArea($conf['set']);
						}
						if (isset($conf['clear'])) {
							// This sets the current to the default;
							$this->workArea = $this->defaultWorkArea;
						}
						break;
					case 'ELLIPSE':
						$this->makeEllipse($this->im, $conf, $this->workArea);
						break;
					}
				}
			}
		}
		// Preserve alpha transparency
		if (!$this->saveAlphaLayer) {
			if ($this->setup['transparentBackground']) {
				// Auto transparent background is set
				$Bcolor = ImageColorClosest($this->im, $BGcols[0], $BGcols[1], $BGcols[2]);
				imagecolortransparent($this->im, $Bcolor);
			} elseif (is_array($this->setup['transparentColor_array'])) {
				// Multiple transparent colors are set. This is done via the trick that all transparent colors get
				// converted to one color and then this one gets set as transparent as png/gif can just have one
				// transparent color.
				$Tcolor = $this->unifyColors($this->im, $this->setup['transparentColor_array'], intval($this->setup['transparentColor.']['closest']));
				if ($Tcolor >= 0) {
					imagecolortransparent($this->im, $Tcolor);
				}
			}
		}
	}

	/*********************************************
	 *
	 * Various helper functions
	 *
	 ********************************************/
	/**
	 * Initializing/Cleaning of TypoScript properties for TEXT GIFBUILDER objects
	 *
	 * 'cleans' TEXT-object; Checks fontfile and other vital setup
	 * Finds the title if its a 'variable' (instantiates a cObj and loads it with the ->data record)
	 * Performs caseshift if any.
	 *
	 * @param array $conf GIFBUILDER object TypoScript properties
	 * @return array Modified $conf array IF the "text" property is not blank
	 * @access private
	 * @todo Define visibility
	 */
	public function checkTextObj($conf) {
		$cObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
		$cObj->start($this->data);
		$isStdWrapped = array();
		foreach ($conf as $key => $value) {
			$parameter = rtrim($key, '.');
			if (!$isStdWrapped[$parameter] && isset($conf[$parameter . '.'])) {
				$conf[$parameter] = $cObj->stdWrap($conf[$parameter], $conf[$parameter . '.']);
				$isStdWrapped[$parameter] = 1;
			}
		}
		$conf['fontFile'] = $this->checkFile($conf['fontFile']);
		if (!$conf['fontFile']) {
			$conf['fontFile'] = 'typo3/sysext/core/Resources/Private/Font/nimbus.ttf';
		}
		if (!$conf['iterations']) {
			$conf['iterations'] = 1;
		}
		if (!$conf['fontSize']) {
			$conf['fontSize'] = 12;
		}
		// If any kind of spacing applys, we cannot use angles!!
		if ($conf['spacing'] || $conf['wordSpacing']) {
			$conf['angle'] = 0;
		}
		if (!isset($conf['antiAlias'])) {
			$conf['antiAlias'] = 1;
		}
		$conf['fontColor'] = trim($conf['fontColor']);
		// Strip HTML
		if (!$conf['doNotStripHTML']) {
			$conf['text'] = strip_tags($conf['text']);
		}
		$this->combinedTextStrings[] = strip_tags($conf['text']);
		// Max length = 100 if automatic line braks are not defined:
		if (!isset($conf['breakWidth']) || !$conf['breakWidth']) {
			$tlen = intval($conf['textMaxLength']) ? intval($conf['textMaxLength']) : 100;
			if ($this->nativeCharset) {
				$conf['text'] = $this->csConvObj->substr($this->nativeCharset, $conf['text'], 0, $tlen);
			} else {
				$conf['text'] = substr($conf['text'], 0, $tlen);
			}
		}
		if ((string) $conf['text'] != '') {
			// Char range map thingie:
			$fontBaseName = basename($conf['fontFile']);
			if (is_array($this->charRangeMap[$fontBaseName])) {
				// Initialize splitRendering array:
				if (!is_array($conf['splitRendering.'])) {
					$conf['splitRendering.'] = array();
				}
				$cfgK = $this->charRangeMap[$fontBaseName]['cfgKey'];
				// Do not impose settings if a splitRendering object already exists:
				if (!isset($conf['splitRendering.'][$cfgK])) {
					// Set configuration:
					$conf['splitRendering.'][$cfgK] = 'charRange';
					$conf['splitRendering.'][$cfgK . '.'] = $this->charRangeMap[$fontBaseName]['charMapConfig'];
					// Multiplicator of fontsize:
					if ($this->charRangeMap[$fontBaseName]['multiplicator']) {
						$conf['splitRendering.'][$cfgK . '.']['fontSize'] = round($conf['fontSize'] * $this->charRangeMap[$fontBaseName]['multiplicator']);
					}
					// Multiplicator of pixelSpace:
					if ($this->charRangeMap[$fontBaseName]['pixelSpace']) {
						$travKeys = array('xSpaceBefore', 'xSpaceAfter', 'ySpaceBefore', 'ySpaceAfter');
						foreach ($travKeys as $pxKey) {
							if (isset($conf['splitRendering.'][$cfgK . '.'][$pxKey])) {
								$conf['splitRendering.'][$cfgK . '.'][$pxKey] = round($conf['splitRendering.'][($cfgK . '.')][$pxKey] * ($conf['fontSize'] / $this->charRangeMap[$fontBaseName]['pixelSpace']));
							}
						}
					}
				}
			}
			if (is_array($conf['splitRendering.'])) {
				foreach ($conf['splitRendering.'] as $key => $value) {
					if (is_array($conf['splitRendering.'][$key])) {
						if (isset($conf['splitRendering.'][$key]['fontFile'])) {
							$conf['splitRendering.'][$key]['fontFile'] = $this->checkFile($conf['splitRendering.'][$key]['fontFile']);
						}
					}
				}
			}
			return $conf;
		}
	}

	/**
	 * Calculation of offset using "splitCalc" and insertion of dimensions from other GIFBUILDER objects.
	 *
	 * Example:
	 * Input: 2+2, 2*3, 123, [10.w]
	 * Output: 4,6,123,45  (provided that the width of object in position 10 was 45 pixels wide)
	 *
	 * @param string $string The string to resolve/calculate the result of. The string is divided by a comma first and each resulting part is calculated into an integer.
	 * @return string The resolved string with each part (separated by comma) returned separated by comma
	 * @access private
	 * @todo Define visibility
	 */
	public function calcOffset($string) {
		$value = array();
		$numbers = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->calculateFunctions($string));
		foreach ($numbers as $key => $val) {
			if ((string) $val == (string) intval($val)) {
				$value[$key] = intval($val);
			} else {
				$value[$key] = $this->calculateValue($val);
			}
		}
		$string = implode(',', $value);
		return $string;
	}

	/**
	 * Returns an "imgResource" creating an instance of the ContentObjectRenderer class and calling ContentObjectRenderer::getImgResource
	 *
	 * @param string $file Filename value OR the string "GIFBUILDER", see documentation in TSref for the "datatype" called "imgResource
	 * @param array $fileArray TypoScript properties passed to the function. Either GIFBUILDER properties or imgResource properties, depending on the value of $file (whether that is "GIFBUILDER" or a file reference)
	 * @return array Returns an array with file information if an image was returned. Otherwise FALSE.
	 * @access private
	 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getImgResource()
	 * @todo Define visibility
	 */
	public function getResource($file, $fileArray) {
		if (!\TYPO3\CMS\Core\Utility\GeneralUtility::inList($this->imageFileExt, $fileArray['ext'])) {
			$fileArray['ext'] = $this->gifExtension;
		}
		$cObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
		$cObj->start($this->data);
		return $cObj->getImgResource($file, $fileArray);
	}

	/**
	 * Returns the reference to a "resource" in TypoScript.
	 *
	 * @param string $file The resource value.
	 * @return string Returns the relative filepath
	 * @access private
	 * @see \TYPO3\CMS\Core\TypoScript\TemplateService::getFileName()
	 * @todo Define visibility
	 */
	public function checkFile($file) {
		return $GLOBALS['TSFE']->tmpl->getFileName($file);
	}

	/**
	 * Calculates the GIFBUILDER output filename/path based on a serialized, hashed value of this->setup
	 *
	 * @param string $pre Filename prefix, eg. "GB_
	 * @return string The relative filepath (relative to PATH_site)
	 * @access private
	 * @todo Define visibility
	 */
	public function fileName($pre) {
		$meaningfulPrefix = '';
		if ($GLOBALS['TSFE']->config['config']['meaningfulTempFilePrefix']) {
			/** @var $basicFileFunctions \TYPO3\CMS\Core\Utility\File\BasicFileUtility */
			$basicFileFunctions = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Utility\\File\\BasicFileUtility');
			$meaningfulPrefix = implode('_', array_merge($this->combinedTextStrings, $this->combinedFileNames));
			$meaningfulPrefix = $basicFileFunctions->cleanFileName($meaningfulPrefix);
			$meaningfulPrefixLength = intval($GLOBALS['TSFE']->config['config']['meaningfulTempFilePrefix']);
			if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['UTF8filesystem']) {
				/** @var $t3libCsInstance \TYPO3\CMS\Core\Charset\CharsetConverter */
				$t3libCsInstance = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Charset\\CharsetConverter');
				$meaningfulPrefix = $t3libCsInstance->substr('utf-8', $meaningfulPrefix, 0, $meaningfulPrefixLength);
			} else {
				$meaningfulPrefix = substr($meaningfulPrefix, 0, $meaningfulPrefixLength);
			}
			$meaningfulPrefix .= '_';
		}
		// WARNING: In PHP5 I discovered that rendering with freetype of Japanese letters was totally corrupt.
		// Not only the wrong glyphs are printed but also some memory stack overflow resulted in strange additional
		// chars - and finally the reason for this investigation: The Bounding box data was changing all the time
		// resulting in new images being generated all the time. With PHP4 it works fine.
		return $this->tempPath . $pre . $meaningfulPrefix . \TYPO3\CMS\Core\Utility\GeneralUtility::shortMD5(serialize($this->setup)) . '.' . $this->extension();
	}

	/**
	 * Returns the file extension used in the filename
	 *
	 * @return string Extension; "jpg" or "gif"/"png
	 * @access private
	 * @todo Define visibility
	 */
	public function extension() {
		switch (strtolower($this->setup['format'])) {
		case 'jpg':

		case 'jpeg':
			return 'jpg';
			break;
		case 'png':
			return 'png';
			break;
		case 'gif':
			return 'gif';
			break;
		default:
			return $this->gifExtension;
			break;
		}
	}

	/**
	 * Calculates the value concerning the dimensions of objects.
	 *
	 * @param string $string The string to be calculated (e.g. "[20.h]+13")
	 * @return integer The calculated value (e.g. "23")
	 * @see calcOffset()
	 */
	protected function calculateValue($string) {
		$calculatedValue = 0;
		$parts = \TYPO3\CMS\Core\Utility\GeneralUtility::splitCalc($string, '+-*/%');
		foreach ($parts as $part) {
			$theVal = $part[1];
			$sign = $part[0];
			if ((string) intval($theVal) == (string) $theVal) {
				$theVal = intval($theVal);
			} elseif ('[' . substr($theVal, 1, -1) . ']' == $theVal) {
				$objParts = explode('.', substr($theVal, 1, -1));
				$theVal = 0;
				if (isset($this->objBB[$objParts[0]])) {
					if ($objParts[1] == 'w') {
						$theVal = $this->objBB[$objParts[0]][0];
					} elseif ($objParts[1] == 'h') {
						$theVal = $this->objBB[$objParts[0]][1];
					} elseif ($objParts[1] == 'lineHeight') {
						$theVal = $this->objBB[$objParts[0]][2]['lineHeight'];
					}
					$theVal = intval($theVal);
				}
			} elseif (floatval($theVal)) {
				$theVal = floatval($theVal);
			} else {
				$theVal = 0;
			}
			if ($sign == '-') {
				$calculatedValue -= $theVal;
			} elseif ($sign == '+') {
				$calculatedValue += $theVal;
			} elseif ($sign == '/' && $theVal) {
				$calculatedValue = $calculatedValue / $theVal;
			} elseif ($sign == '*') {
				$calculatedValue = $calculatedValue * $theVal;
			} elseif ($sign == '%' && $theVal) {
				$calculatedValue %= $theVal;
			}
		}
		return round($calculatedValue);
	}

	/**
	 * Calculates special functions:
	 * + max([10.h], [20.h])	-> gets the maximum of the given values
	 *
	 * @param string $string The raw string with functions to be calculated
	 * @return string The calculated values
	 */
	protected function calculateFunctions($string) {
		if (preg_match_all('#max\\(([^)]+)\\)#', $string, $matches)) {
			foreach ($matches[1] as $index => $maxExpression) {
				$string = str_replace($matches[0][$index], $this->calculateMaximum($maxExpression), $string);
			}
		}
		return $string;
	}

	/**
	 * Calculates the maximum of a set of values defined like "[10.h],[20.h],1000"
	 *
	 * @param string $string The string to be used to calculate the maximum (e.g. "[10.h],[20.h],1000")
	 * @return integer The maxium value of the given comma separated and calculated values
	 */
	protected function calculateMaximum($string) {
		$parts = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->calcOffset($string), TRUE);
		$maximum = count($parts) ? max($parts) : 0;
		return $maximum;
	}

}


?>