2 /***************************************************************
5 * (c) 2004-2010 Kasper Skårhøj (kasper@typo3.com)
6 * (c) 2004-2010 Philipp Borgmann <philipp.borgmann@gmx.de>
7 * (c) 2004-2010 Stanislas Rolland <typo3(arobas)sjbr.ca>
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
30 * A RTE using the htmlArea editor
32 * @author Philipp Borgmann <philipp.borgmann@gmx.de>
33 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
38 class tx_rtehtmlarea_base
extends t3lib_rteapi
{
39 // Configuration of supported browsers
40 var $conf_supported_browser = array (
89 // Always hide these toolbar buttons (TYPO3 button name)
90 var $conf_toolbar_hide = array (
91 'showhelp', // Has no content yet
94 // The order of the toolbar: the name is the TYPO3-button name
95 var $defaultToolbarOrder;
97 // Conversion array: TYPO3 button names to htmlArea button names
98 var $convertToolbarForHtmlAreaArray = array (
99 'showhelp' => 'ShowHelp',
101 'bar' => 'separator',
102 'linebreak' => 'linebreak',
105 var $pluginButton = array();
106 var $pluginLabel = array();
107 // Alternative style for RTE <div> tag.
109 // Relative path to this extension. It ends with "/"
111 public $backPath = '';
118 // Identifies the RTE as being the one from the "rtehtmlarea" extension if any external code needs to know
119 var $ID = 'rtehtmlarea';
120 // If set, the content goes into a regular TEXT area field - for developing testing of transformations.
121 var $debugMode = FALSE;
126 * Reference to parent object, which is an instance of the TCEforms
128 * @var t3lib_TCEforms
140 public $contentTypo3Language;
141 public $contentISOLanguage;
142 public $contentCharset;
143 public $OutputCharset;
146 var $toolbar = array(); // Save the buttons for the toolbar
147 var $toolbarOrderArray = array();
148 protected $pluginEnabledArray = array(); // Array of plugin id's enabled in the current RTE editing area
149 protected $pluginEnabledCumulativeArray = array(); // Cumulative array of plugin id's enabled so far in any of the RTE editing areas of the form
150 protected $cumulativeScripts = array();
151 public $registeredPlugins = array(); // Array of registered plugins indexed by their plugin Id's
152 protected $fullScreen = false;
155 * Returns true if the RTE is available. Here you check if the browser requirements are met.
156 * If there are reasons why the RTE cannot be displayed you simply enter them as text in ->errorLog
158 * @return boolean TRUE if this RTE object offers an RTE in the current browser environment
161 function isAvailable() {
162 global $TYPO3_CONF_VARS;
164 $this->client
= $this->clientInfo();
165 $this->errorLog
= array();
166 if (!$this->debugMode
) { // If debug-mode, let any browser through
168 $rteConfBrowser = $this->conf_supported_browser
;
169 if (is_array($rteConfBrowser)) {
170 foreach ($rteConfBrowser as $browser => $browserConf) {
171 if ($browser == $this->client
['browser']) {
172 // Config for Browser found, check it:
173 if (is_array($browserConf)) {
174 foreach ($browserConf as $browserConfNr => $browserConfSub) {
175 if ($browserConfSub['version'] <= $this->client
['version'] ||
empty($browserConfSub['version'])) {
176 // Version is correct
177 if ($browserConfSub['system'] == $this->client
['system'] ||
empty($browserConfSub['system'])) {
178 // System is correctly
182 }// End of foreach-BrowserSubpart
184 // no config for this browser found, so all versions or system with this browsers are allow
187 } // End of Browser Check
188 } // foreach: Browser Check
190 // no Browser config for this RTE-Editor, so all Clients are allow
192 if (!$rteIsAvailable) {
193 $this->errorLog
[] = 'rte: Browser not supported. Only msie Version 5 or higher and Mozilla based client 1. and higher.';
195 if (t3lib_div
::int_from_ver(TYPO3_version
) < 4000000) {
197 $this->errorLog
[] = 'rte: This version of htmlArea RTE cannot run under this version of TYPO3.';
200 if ($rteIsAvailable) return true;
204 * Draws the RTE as an iframe
206 * @param object Reference to parent object, which is an instance of the TCEforms.
207 * @param string The table name
208 * @param string The field name
209 * @param array The current row from which field is being rendered
210 * @param array Array of standard content for rendering form fields from TCEforms. See TCEforms for details on this. Includes for instance the value and the form field name, java script actions and more.
211 * @param array "special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
212 * @param array Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
213 * @param string Record "type" field value.
214 * @param string Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
215 * @param integer PID value of record (true parent page id)
216 * @return string HTML code for RTE!
219 function drawRTE($parentObject, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue) {
220 global $BE_USER, $LANG, $TYPO3_DB, $TYPO3_CONF_VARS;
222 $this->TCEform
= $parentObject;
223 $inline = $this->TCEform
->inline
;
224 $LANG->includeLLFile('EXT:' . $this->ID
. '/locallang.xml');
225 $this->client
= $this->clientInfo();
226 $this->typoVersion
= t3lib_div
::int_from_ver(TYPO3_version
);
227 $this->userUid
= 'BE_' . $BE_USER->user
['uid'];
229 // Draw form element:
230 if ($this->debugMode
) { // Draws regular text area (debug mode)
231 $item = parent
::drawRTE($this->TCEform
, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue);
232 } else { // Draw real RTE
234 /* =======================================
235 * INIT THE EDITOR-SETTINGS
236 * =======================================
239 $this->backPath
= $this->TCEform
->backPath
;
240 // Get the path to this extension:
241 $this->extHttpPath
= $this->backPath
. t3lib_extMgm
::extRelPath($this->ID
);
243 $this->siteURL
= t3lib_div
::getIndpEnv('TYPO3_SITE_URL');
245 $this->hostURL
= $this->siteURL
. TYPO3_mainDir
;
247 $this->elementId
= $PA['itemFormElName']; // Form element name
248 $this->elementParts
= explode('][',preg_replace('/\]$/','',preg_replace('/^(TSFE_EDIT\[data\]\[|data\[)/','',$this->elementId
)));
249 // Find the page PIDs:
250 list($this->tscPID
,$this->thePid
) = t3lib_BEfunc
::getTSCpid(trim($this->elementParts
[0]),trim($this->elementParts
[1]),$thePidValue);
252 // Record "types" field value:
253 $this->typeVal
= $RTEtypeVal; // TCA "types" value for record
255 // Find "thisConfig" for record/editor:
256 unset($this->RTEsetup
);
257 $this->RTEsetup
= $BE_USER->getTSConfig('RTE',t3lib_BEfunc
::getPagesTSconfig($this->tscPID
));
258 $this->thisConfig
= $thisConfig;
260 // Special configuration and default extras:
261 $this->specConf
= $specConf;
263 if ($this->thisConfig
['forceHTTPS']) {
264 $this->extHttpPath
= preg_replace('/^(http|https)/', 'https', $this->extHttpPath
);
265 $this->siteURL
= preg_replace('/^(http|https)/', 'https', $this->siteURL
);
266 $this->hostURL
= preg_replace('/^(http|https)/', 'https', $this->hostURL
);
269 /* =======================================
270 * LANGUAGES & CHARACTER SETS
271 * =======================================
274 // Languages: interface and content
275 $this->language
= $LANG->lang
;
276 if ($this->language
=='default' ||
!$this->language
) {
277 $this->language
='en';
279 $this->contentTypo3Language
= $this->language
;
280 $this->contentISOLanguage
= 'en';
281 $this->contentLanguageUid
= ($row['sys_language_uid'] > 0) ?
$row['sys_language_uid'] : 0;
282 if (t3lib_extMgm
::isLoaded('static_info_tables')) {
283 if ($this->contentLanguageUid
) {
284 $tableA = 'sys_language';
285 $tableB = 'static_languages';
286 $languagesUidsList = $this->contentLanguageUid
;
287 $selectFields = $tableA . '.uid,' . $tableB . '.lg_iso_2,' . $tableB . '.lg_country_iso_2,' . $tableB . '.lg_typo3';
288 $tableAB = $tableA . ' LEFT JOIN ' . $tableB . ' ON ' . $tableA . '.static_lang_isocode=' . $tableB . '.uid';
289 $whereClause = $tableA . '.uid IN (' . $languagesUidsList . ') ';
290 $whereClause .= t3lib_BEfunc
::BEenableFields($tableA);
291 $whereClause .= t3lib_BEfunc
::deleteClause($tableA);
292 $res = $TYPO3_DB->exec_SELECTquery($selectFields, $tableAB, $whereClause);
293 while($languageRow = $TYPO3_DB->sql_fetch_assoc($res)) {
294 $this->contentISOLanguage
= strtolower(trim($languageRow['lg_iso_2']).(trim($languageRow['lg_country_iso_2'])?
'_'.trim($languageRow['lg_country_iso_2']):''));
295 $this->contentTypo3Language
= strtolower(trim($languageRow['lg_typo3']));
298 $this->contentISOLanguage
= trim($this->thisConfig
['defaultContentLanguage']) ?
trim($this->thisConfig
['defaultContentLanguage']) : 'en';
299 $selectFields = 'lg_iso_2, lg_typo3';
300 $tableAB = 'static_languages';
301 $whereClause = 'lg_iso_2 = ' . $TYPO3_DB->fullQuoteStr(strtoupper($this->contentISOLanguage
), $tableAB);
302 $res = $TYPO3_DB->exec_SELECTquery($selectFields, $tableAB, $whereClause);
303 while($languageRow = $TYPO3_DB->sql_fetch_assoc($res)) {
304 $this->contentTypo3Language
= strtolower(trim($languageRow['lg_typo3']));
309 // Character sets: interface and content
310 $this->charset
= $LANG->charSet
;
311 $this->OutputCharset
= $this->charset
;
313 $this->contentCharset
= $LANG->csConvObj
->charSetArray
[$this->contentTypo3Language
];
314 $this->contentCharset
= $this->contentCharset ?
$this->contentCharset
: 'iso-8859-1';
315 $this->origContentCharSet
= $this->contentCharset
;
316 $this->contentCharset
= (trim($TYPO3_CONF_VARS['BE']['forceCharset']) ?
trim($TYPO3_CONF_VARS['BE']['forceCharset']) : $this->contentCharset
);
318 /* =======================================
319 * TOOLBAR CONFIGURATION
320 * =======================================
322 $this->initializeToolbarConfiguration();
324 /* =======================================
326 * =======================================
329 $RTEWidth = isset($BE_USER->userTS
['options.']['RTESmallWidth']) ?
$BE_USER->userTS
['options.']['RTESmallWidth'] : '530';
330 $RTEHeight = isset($BE_USER->userTS
['options.']['RTESmallHeight']) ?
$BE_USER->userTS
['options.']['RTESmallHeight'] : '380';
331 $RTEWidth = $RTEWidth +
($this->TCEform
->docLarge ?
(isset($BE_USER->userTS
['options.']['RTELargeWidthIncrement']) ?
$BE_USER->userTS
['options.']['RTELargeWidthIncrement'] : '150') : 0);
332 $RTEWidth -= ($inline->getStructureDepth() > 0 ?
($inline->getStructureDepth()+
1)*$inline->getLevelMargin() : 0);
333 if (isset($this->thisConfig
['RTEWidthOverride'])) {
334 if (strstr($this->thisConfig
['RTEWidthOverride'], '%')) {
335 if ($this->client
['browser'] != 'msie') {
336 $RTEWidth = (intval($this->thisConfig
['RTEWidthOverride']) > 0) ?
$this->thisConfig
['RTEWidthOverride'] : '100%';
339 $RTEWidth = (intval($this->thisConfig
['RTEWidthOverride']) > 0) ?
intval($this->thisConfig
['RTEWidthOverride']) : $RTEWidth;
342 $RTEWidth = strstr($RTEWidth, '%') ?
$RTEWidth : $RTEWidth . 'px';
343 $RTEHeight = $RTEHeight +
($this->TCEform
->docLarge ?
(isset($BE_USER->userTS
['options.']['RTELargeHeightIncrement']) ?
$BE_USER->userTS
['options.']['RTELargeHeightIncrement'] : 0) : 0);
344 $RTEHeightOverride = intval($this->thisConfig
['RTEHeightOverride']);
345 $RTEHeight = ($RTEHeightOverride > 0) ?
$RTEHeightOverride : $RTEHeight;
346 $editorWrapWidth = '99%';
347 $editorWrapHeight = '100%';
348 $this->RTEdivStyle
= 'position:relative; left:0px; top:0px; height:' . $RTEHeight . 'px; width:'.$RTEWidth.'; border: 1px solid black; padding: 2px 2px 2px 2px;';
350 /* =======================================
351 * LOAD CSS AND JAVASCRIPT
352 * =======================================
354 // Preloading the pageStyle and including RTE skin stylesheets
355 $this->addPageStyle();
357 // Loading JavaScript files and code
358 if ($this->TCEform
->RTEcounter
== 1) {
359 $this->TCEform
->additionalJS_pre
['rtehtmlarea-loadJScode'] = $this->loadJScode($this->TCEform
->RTEcounter
);
361 $this->TCEform
->additionalCode_pre
['rtehtmlarea-loadJSfiles'] = $this->loadJSfiles($this->TCEform
->RTEcounter
);
362 $pageRenderer = $GLOBALS['SOBE']->doc
->getPageRenderer();
363 $pageRenderer->enableExtJSQuickTips();
364 if (!$GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->ID
]['enableCompressedScripts']) {
365 $pageRenderer->enableExtJsDebug();
367 $pageRenderer->addJsFile('../t3lib/js/extjs/notifications.js');
368 /* =======================================
370 * =======================================
374 $value = $this->transformContent('rte',$PA['itemFormElValue'],$table,$field,$row,$specConf,$thisConfig,$RTErelPath,$thePidValue);
376 // Further content transformation by registered plugins
377 foreach ($this->registeredPlugins
as $pluginId => $plugin) {
378 if ($this->isPluginEnabled($pluginId) && method_exists($plugin, "transformContent")) {
379 $value = $plugin->transformContent($value);
382 // Register RTE windows
383 $this->TCEform
->RTEwindows
[] = $PA['itemFormElName'];
384 $textAreaId = preg_replace('/[^a-zA-Z0-9_:.-]/', '_', $PA['itemFormElName']);
385 $textAreaId = htmlspecialchars(preg_replace('/^[^a-zA-Z]/', 'x', $textAreaId));
387 // Check if wizard_rte called this for fullscreen edtition; if so, change the size of the RTE to fullscreen using JS
388 if (basename(PATH_thisScript
) == 'wizard_rte.php') {
389 $this->fullScreen
= true;
390 $editorWrapWidth = '100%';
391 $editorWrapHeight = '100%';
392 $this->RTEdivStyle
= 'position:relative; left:0px; top:0px; height:100%; width:100%; border: 1px solid black; padding: 2px 0px 2px 2px;';
395 // Register RTE in JS:
396 $this->TCEform
->additionalJS_post
[] = $this->registerRTEinJS($this->TCEform
->RTEcounter
, $table, $row['uid'], $field, $textAreaId);
398 // Set the save option for the RTE:
399 $this->TCEform
->additionalJS_submit
[] = $this->setSaveRTE($this->TCEform
->RTEcounter
, $this->TCEform
->formName
, $textAreaId, $PA['itemFormElName']);
400 $this->TCEform
->additionalJS_delete
[] = $this->setDeleteRTE($this->TCEform
->RTEcounter
, $this->TCEform
->formName
, $textAreaId);
403 $visibility = 'hidden';
404 $item = $this->triggerField($PA['itemFormElName']).'
405 <div id="pleasewait' . $textAreaId . '" class="pleasewait" style="display: block;" >' . $LANG->getLL('Please wait') . '</div>
406 <div id="editorWrap' . $textAreaId . '" class="editorWrap" style="visibility: hidden; width:' . $editorWrapWidth . '; height:' . $editorWrapHeight . ';">
407 <textarea id="RTEarea' . $textAreaId . '" name="'.htmlspecialchars($PA['itemFormElName']).'" rows="0" cols="0" style="'.t3lib_div
::deHSCentities(htmlspecialchars($this->RTEdivStyle
)).'">'.t3lib_div
::formatForTextarea($value).'</textarea>
408 </div>' . ($TYPO3_CONF_VARS['EXTCONF'][$this->ID
]['enableDebugMode'] ?
'<div id="HTMLAreaLog"></div>' : '') . '
417 * Add link to content style sheet to document header
421 protected function addPageStyle() {
422 // Get stylesheet file name from Page TSConfig if any
423 $filename = trim($this->thisConfig
['contentCSS']) ?
trim($this->thisConfig
['contentCSS']) : 'EXT:' . $this->ID
. '/res/contentcss/default.css';
424 $this->addStyleSheet(
425 'rtehtmlarea-page-style',
426 $this->getFullFileName($filename),
427 'htmlArea RTE Content CSS',
428 'alternate stylesheet'
433 * Add links to skin style sheet(s) to document header
437 protected function addSkin() {
438 // Get skin file name from Page TSConfig if any
439 $skinFilename = trim($this->thisConfig
['skin']) ?
trim($this->thisConfig
['skin']) : 'EXT:' . $this->ID
. '/htmlarea/skins/default/htmlarea.css';
440 $this->editorCSS
= $this->getFullFileName($skinFilename);
441 $skinDir = dirname($this->editorCSS
);
442 // Editing area style sheet
443 $this->editedContentCSS
= $skinDir . '/htmlarea-edited-content.css';
444 $this->addStyleSheet(
445 'rtehtmlarea-editing-area-skin',
446 $this->editedContentCSS
449 $this->addStyleSheet(
453 // Additional icons from registered plugins
454 foreach ($this->pluginEnabledCumulativeArray
[$this->TCEform
->RTEcounter
] as $pluginId) {
455 if (is_object($this->registeredPlugins
[$pluginId])) {
456 $pathToSkin = $this->registeredPlugins
[$pluginId]->getPathToSkin();
458 $key = $this->registeredPlugins
[$pluginId]->getExtensionKey();
459 $this->addStyleSheet(
460 'rtehtmlarea-plugin-' . $pluginId . '-skin',
461 ($this->is_FE() ? t3lib_extMgm
::siteRelPath($key) : $this->backPath
. t3lib_extMgm
::extRelPath($key)) . $pathToSkin
469 * Add style sheet file to document header
471 * @param string $key: some key identifying the style sheet
472 * @param string $href: uri to the style sheet file
473 * @param string $title: value for the title attribute of the link element
474 * @return string $relation: value for the rel attribute of the link element
477 protected function addStyleSheet($key, $href, $title='', $relation='stylesheet') {
478 // If it was not known that an RTE-enabled would be created when the page was first created, the css would not be added to head
479 if (is_object($this->TCEform
->inline
) && $this->TCEform
->inline
->isAjaxCall
) {
480 $this->TCEform
->additionalCode_pre
[$key] = '<link rel="' . $relation . '" type="text/css" href="' . $href . '" title="' . $title. '" />';
482 $pageRenderer = $GLOBALS['SOBE']->doc
->getPageRenderer();
483 $pageRenderer->addCssFile($href, $relation, 'screen', $title);
488 * Initialize toolbar configuration and enable registered plugins
492 protected function initializeToolbarConfiguration() {
494 // Enable registred plugins
495 $this->enableRegisteredPlugins();
500 // Check if some plugins need to be disabled
503 // Merge the list of enabled plugins with the lists from the previous RTE editing areas on the same form
504 $this->pluginEnabledCumulativeArray
[$this->TCEform
->RTEcounter
] = $this->pluginEnabledArray
;
505 if ($this->TCEform
->RTEcounter
> 1 && isset($this->pluginEnabledCumulativeArray
[$this->TCEform
->RTEcounter
-1]) && is_array($this->pluginEnabledCumulativeArray
[$this->TCEform
->RTEcounter
-1])) {
506 $this->pluginEnabledCumulativeArray
[$this->TCEform
->RTEcounter
] = array_unique(array_values(array_merge($this->pluginEnabledArray
,$this->pluginEnabledCumulativeArray
[$this->TCEform
->RTEcounter
-1])));
511 * Add registered plugins to the array of enabled plugins
514 function enableRegisteredPlugins() {
515 global $TYPO3_CONF_VARS;
516 // Traverse registered plugins
517 if (is_array($TYPO3_CONF_VARS['EXTCONF'][$this->ID
]['plugins'])) {
518 foreach($TYPO3_CONF_VARS['EXTCONF'][$this->ID
]['plugins'] as $pluginId => $pluginObjectConfiguration) {
520 if (is_array($pluginObjectConfiguration) && count($pluginObjectConfiguration)) {
521 $plugin = t3lib_div
::getUserObj($pluginObjectConfiguration['objectReference']);
523 if (is_object($plugin)) {
524 if ($plugin->main($this)) {
525 $this->registeredPlugins
[$pluginId] = $plugin;
526 // Override buttons from previously registered plugins
527 $pluginButtons = t3lib_div
::trimExplode(',', $plugin->getPluginButtons(), 1);
528 foreach ($this->pluginButton
as $previousPluginId => $buttonList) {
529 $this->pluginButton
[$previousPluginId] = implode(',',array_diff(t3lib_div
::trimExplode(',', $this->pluginButton
[$previousPluginId], 1), $pluginButtons));
531 $this->pluginButton
[$pluginId] = $plugin->getPluginButtons();
532 $pluginLabels = t3lib_div
::trimExplode(',', $plugin->getPluginLabels(), 1);
533 foreach ($this->pluginLabel
as $previousPluginId => $labelList) {
534 $this->pluginLabel
[$previousPluginId] = implode(',',array_diff(t3lib_div
::trimExplode(',', $this->pluginLabel
[$previousPluginId], 1), $pluginLabels));
536 $this->pluginLabel
[$pluginId] = $plugin->getPluginLabels();
537 $this->pluginEnabledArray
[] = $pluginId;
543 $hidePlugins = array();
544 foreach ($this->registeredPlugins
as $pluginId => $plugin) {
545 if ($plugin->addsButtons() && !$this->pluginButton
[$pluginId]) {
546 $hidePlugins[] = $pluginId;
549 $this->pluginEnabledArray
= array_unique(array_diff($this->pluginEnabledArray
, $hidePlugins));
553 * Set the toolbar config (only in this PHP-Object, not in JS):
557 function setToolbar() {
560 if ($this->client
['browser'] == 'msie' ||
$this->client
['browser'] == 'opera') {
561 $this->thisConfig
['keepButtonGroupTogether'] = 0;
564 $this->defaultToolbarOrder
= 'bar, blockstylelabel, blockstyle, space, textstylelabel, textstyle, linebreak,
565 bar, formattext, bold, strong, italic, emphasis, big, small, insertedtext, deletedtext, citation, code, definition, keyboard, monospaced, quotation, sample, variable, bidioverride, strikethrough, subscript, superscript, underline, span,
566 bar, fontstyle, space, fontsize, bar, formatblock, insertparagraphbefore, insertparagraphafter, blockquote, line,
567 bar, left, center, right, justifyfull,
568 bar, orderedlist, unorderedlist, definitionlist, definitionitem, outdent, indent, bar, lefttoright, righttoleft, language, showlanguagemarks,
569 bar, textcolor, bgcolor, textindicator,
570 bar, emoticon, insertcharacter, link, unlink, image, table,' . (($this->thisConfig
['hideTableOperationsInToolbar'] && is_array($this->thisConfig
['buttons.']) && is_array($this->thisConfig
['buttons.']['toggleborders.']) && $this->thisConfig
['buttons.']['toggleborders.']['keepInToolbar']) ?
' toggleborders,': '') . ' user, acronym, bar, findreplace, spellcheck,
571 bar, chMode, inserttag, removeformat, bar, copy, cut, paste, pastetoggle, pastebehaviour, bar, undo, redo, bar, showhelp, about, linebreak,
572 ' . ($this->thisConfig
['hideTableOperationsInToolbar'] ?
'': 'bar, toggleborders,') . ' bar, tableproperties, tablerestyle, bar, rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit, bar,
573 columnproperties, columninsertbefore, columninsertafter, columndelete, columnsplit, bar,
574 cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge';
576 // Additional buttons from registered plugins
577 foreach($this->registeredPlugins
as $pluginId => $plugin) {
578 if ($this->isPluginEnabled($pluginId)) {
579 $this->defaultToolbarOrder
= $plugin->addButtonsToToolbar();
582 $toolbarOrder = $this->thisConfig
['toolbarOrder'] ?
$this->thisConfig
['toolbarOrder'] : $this->defaultToolbarOrder
;
584 // Getting rid of undefined buttons
585 $this->toolbarOrderArray
= array_intersect(t3lib_div
::trimExplode(',', $toolbarOrder, 1), t3lib_div
::trimExplode(',', $this->defaultToolbarOrder
, 1));
586 $toolbarOrder = array_unique(array_values($this->toolbarOrderArray
));
588 // Fetching specConf for field from backend
589 $pList = is_array($this->specConf
['richtext']['parameters']) ?
implode(',',$this->specConf
['richtext']['parameters']) : '';
590 if ($pList != '*') { // If not all
591 $show = is_array($this->specConf
['richtext']['parameters']) ?
$this->specConf
['richtext']['parameters'] : array();
592 if ($this->thisConfig
['showButtons']) {
593 if (!t3lib_div
::inList($this->thisConfig
['showButtons'],'*')) {
594 $show = array_unique(array_merge($show,t3lib_div
::trimExplode(',',$this->thisConfig
['showButtons'],1)));
596 $show = array_unique(array_merge($show, $toolbarOrder));
599 if (is_array($this->thisConfig
['showButtons.'])) {
600 foreach ($this->thisConfig
['showButtons.'] as $buttonId => $value) {
601 if ($value) $show[] = $buttonId;
603 $show = array_unique($show);
606 $show = $toolbarOrder;
609 // Resticting to RTEkeyList for backend user
610 if(is_object($BE_USER)) {
611 $RTEkeyList = isset($BE_USER->userTS
['options.']['RTEkeyList']) ?
$BE_USER->userTS
['options.']['RTEkeyList'] : '*';
612 if ($RTEkeyList != '*') { // If not all
613 $show = array_intersect($show, t3lib_div
::trimExplode(',',$RTEkeyList,1));
617 // Hiding buttons of disabled plugins
618 $hideButtons = array('space', 'bar', 'linebreak');
619 foreach ($this->pluginButton
as $pluginId => $buttonList) {
620 if (!$this->isPluginEnabled($pluginId)) {
621 $buttonArray = t3lib_div
::trimExplode(',',$buttonList,1);
622 foreach ($buttonArray as $button) {
623 $hideButtons[] = $button;
628 // Hiding labels of disabled plugins
629 foreach ($this->pluginLabel
as $pluginId => $label) {
630 if (!$this->isPluginEnabled($pluginId)) {
631 $hideButtons[] = $label;
636 $show = array_diff($show, $this->conf_toolbar_hide
, t3lib_div
::trimExplode(',',$this->thisConfig
['hideButtons'],1));
638 // Apply toolbar constraints from registered plugins
639 foreach ($this->registeredPlugins
as $pluginId => $plugin) {
640 if ($this->isPluginEnabled($pluginId) && method_exists($plugin, "applyToolbarConstraints")) {
641 $show = $plugin->applyToolbarConstraints($show);
644 // Getting rid of the buttons for which we have no position
645 $show = array_intersect($show, $toolbarOrder);
646 $this->toolbar
= $show;
650 * Disable some plugins
653 function setPlugins() {
655 // Disabling a plugin that adds buttons if none of its buttons is in the toolbar
656 $hidePlugins = array();
657 foreach ($this->pluginButton
as $pluginId => $buttonList) {
658 if ($this->registeredPlugins
[$pluginId]->addsButtons()) {
660 $buttonArray = t3lib_div
::trimExplode(',', $buttonList, 1);
661 foreach ($buttonArray as $button) {
662 if (in_array($button, $this->toolbar
)) {
667 $hidePlugins[] = $pluginId;
671 $this->pluginEnabledArray
= array_diff($this->pluginEnabledArray
, $hidePlugins);
673 // Hiding labels of disabled plugins
674 $hideLabels = array();
675 foreach ($this->pluginLabel
as $pluginId => $label) {
676 if (!$this->isPluginEnabled($pluginId)) {
677 $hideLabels[] = $label;
680 $this->toolbar
= array_diff($this->toolbar
, $hideLabels);
682 // Adding plugins declared as prerequisites by enabled plugins
683 $requiredPlugins = array();
684 foreach ($this->registeredPlugins
as $pluginId => $plugin) {
685 if ($this->isPluginEnabled($pluginId)) {
686 $requiredPlugins = array_merge($requiredPlugins, t3lib_div
::trimExplode(',', $plugin->getRequiredPlugins(), 1));
689 $requiredPlugins = array_unique($requiredPlugins);
690 foreach ($requiredPlugins as $pluginId) {
691 if (is_object($this->registeredPlugins
[$pluginId]) && !$this->isPluginEnabled($pluginId)) {
692 $this->pluginEnabledArray
[] = $pluginId;
695 $this->pluginEnabledArray
= array_unique($this->pluginEnabledArray
);
697 // Completing the toolbar conversion array for htmlArea
698 foreach ($this->registeredPlugins
as $pluginId => $plugin) {
699 if ($this->isPluginEnabled($pluginId)) {
700 $this->convertToolbarForHtmlAreaArray
= array_unique(array_merge($this->convertToolbarForHtmlAreaArray
, $plugin->getConvertToolbarForHtmlAreaArray()));
706 * Convert the TYPO3 names of buttons into the names for htmlArea RTE
708 * @param string buttonname (typo3-name)
709 * @return string buttonname (htmlarea-name)
712 function convertToolbarForHTMLArea($button) {
713 return $this->convertToolbarForHtmlAreaArray
[$button];
716 * Return the HTML code for loading the Javascript files
718 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
720 * @return string the html code for loading the Javascript Files
722 function loadJSfiles($RTEcounter) {
723 // Re-initialize the scripts array so that only the cumulative set of plugins of the last RTE on the page is used
724 $this->cumulativeScripts
[$RTEcounter] = array();
725 $this->writeTemporaryFile('EXT:' . $this->ID
. '/htmlarea/htmlarea.js', 'htmlarea', 'js', '', TRUE);
726 if ($this->client
['browser'] == 'msie') {
727 $this->writeTemporaryFile('EXT:' . $this->ID
. '/htmlarea/htmlarea-ie.js', 'htmlarea-ie', 'js', '', TRUE);
729 $this->writeTemporaryFile('EXT:' . $this->ID
. '/htmlarea/htmlarea-gecko.js', 'htmlarea-gecko', 'js', '', TRUE);
731 foreach ($this->pluginEnabledCumulativeArray
[$RTEcounter] as $pluginId) {
732 $extensionKey = is_object($this->registeredPlugins
[$pluginId]) ?
$this->registeredPlugins
[$pluginId]->getExtensionKey() : $this->ID
;
733 $this->writeTemporaryFile('EXT:' . $extensionKey . '/htmlarea/plugins/' . $pluginId . '/' . strtolower(preg_replace('/([a-z])([A-Z])([a-z])/', "$1".'-'."$2"."$3", $pluginId)) . '.js', $pluginId, 'js', '', TRUE);
735 $this->buildJSMainLangFile($RTEcounter);
736 // Avoid re-initialization on AJax call when RTEarea object was already initialized
737 $loadJavascriptCode = '<script type="text/javascript" src="' . $this->doConcatenate($RTEcounter) . '"></script>'. LF
;
738 $loadJavascriptCode .= t3lib_div
::wrapJS('
739 if (typeof(RTEarea) == "undefined") {
740 RTEarea = new Object();
741 RTEarea[0] = new Object();
742 RTEarea[0].version = "' . $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->ID
]['version'] . '";
743 RTEarea[0].editorUrl = "' . $this->extHttpPath
. 'htmlarea/";
744 RTEarea[0].editorCSS = "' . t3lib_div
::createVersionNumberedFilename($this->editorCSS
) . '";
745 RTEarea[0].editorSkin = "' . dirname($this->editorCSS
) . '/";
746 RTEarea[0].editedContentCSS = "' . t3lib_div
::createVersionNumberedFilename($this->editedContentCSS
) . '";
747 RTEarea[0].hostUrl = "' . $this->hostURL
. '";
748 RTEarea[0].enableDebugMode = ' . ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->ID
]['enableDebugMode'] ?
'true' : 'false') . ';
749 RTEarea.init = function() {
750 if (typeof(HTMLArea) == "undefined" || !Ext.isReady) {
751 window.setTimeout("RTEarea.init();", 40);
753 Ext.QuickTips.init();
757 RTEarea.initEditor = function(editorNumber) {
758 if (typeof(HTMLArea) == "undefined") {
759 RTEarea.initEditor.defer(40, null, [editorNumber]);
761 HTMLArea.initEditor(editorNumber);
766 return $loadJavascriptCode;
770 * Return the Javascript code for initializing the RTE
772 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
774 * @return string the Javascript code for initializing the RTE
776 function loadJScode($RTEcounter) {
777 return TAB
. 'RTEarea.init();';
781 * Return the Javascript code for configuring the RTE
783 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
784 * @param string $table: The table that includes this RTE (optional, necessary for IRRE).
785 * @param string $uid: The uid of that table that includes this RTE (optional, necessary for IRRE).
786 * @param string $field: The field of that record that includes this RTE (optional).
788 * @return string the Javascript code for configuring the RTE
790 function registerRTEinJS($RTEcounter, $table='', $uid='', $field='', $textAreaId = '') {
791 $configureRTEInJavascriptString = '
792 if (typeof(configureEditorInstance) == "undefined") {
793 configureEditorInstance = new Object();
795 configureEditorInstance["' . $textAreaId . '"] = function() {
796 if (typeof(RTEarea) == "undefined" || typeof(HTMLArea) == "undefined") {
797 window.setTimeout("configureEditorInstance[\'' . $textAreaId . '\']();", 40);
799 editornumber = "' . $textAreaId . '";
800 RTEarea[editornumber] = new Object();
801 RTEarea[editornumber].RTEtsConfigParams = "&RTEtsConfigParams=' . rawurlencode($this->RTEtsConfigParams()) . '";
802 RTEarea[editornumber].number = editornumber;
803 RTEarea[editornumber].deleted = false;
804 RTEarea[editornumber].textAreaId = "' . $textAreaId . '";
805 RTEarea[editornumber].id = "RTEarea" + editornumber;
806 RTEarea[editornumber].RTEWidthOverride = "' . trim($this->thisConfig
['RTEWidthOverride']) . '";
807 RTEarea[editornumber].RTEHeightOverride = "' . trim($this->thisConfig
['RTEHeightOverride']) . '";
808 RTEarea[editornumber].fullScreen = ' . ($this->fullScreen ?
'true' : 'false') . ';
809 RTEarea[editornumber].showStatusBar = ' . (trim($this->thisConfig
['showStatusBar'])?
'true':'false') . ';
810 RTEarea[editornumber].enableWordClean = ' . (trim($this->thisConfig
['enableWordClean'])?
'true':'false') . ';
811 RTEarea[editornumber].htmlRemoveComments = ' . (trim($this->thisConfig
['removeComments'])?
'true':'false') . ';
812 RTEarea[editornumber].disableEnterParagraphs = ' . (trim($this->thisConfig
['disableEnterParagraphs'])?
'true':'false') . ';
813 RTEarea[editornumber].disableObjectResizing = ' . (trim($this->thisConfig
['disableObjectResizing'])?
'true':'false') . ';
814 RTEarea[editornumber].removeTrailingBR = ' . (trim($this->thisConfig
['removeTrailingBR'])?
'true':'false') . ';
815 RTEarea[editornumber].useCSS = ' . (trim($this->thisConfig
['useCSS'])?
'true':'false') . ';
816 RTEarea[editornumber].keepButtonGroupTogether = ' . (trim($this->thisConfig
['keepButtonGroupTogether'])?
'true':'false') . ';
817 RTEarea[editornumber].disablePCexamples = ' . (trim($this->thisConfig
['disablePCexamples'])?
'true':'false') . ';
818 RTEarea[editornumber].showTagFreeClasses = ' . (trim($this->thisConfig
['showTagFreeClasses'])?
'true':'false') . ';
819 RTEarea[editornumber].useHTTPS = ' . ((trim(stristr($this->siteURL
, 'https')) ||
$this->thisConfig
['forceHTTPS'])?
'true':'false') . ';
820 RTEarea[editornumber].tceformsNested = ' . (is_object($this->TCEform
) && method_exists($this->TCEform
, 'getDynNestedStack') ?
$this->TCEform
->getDynNestedStack(true) : '[]') . ';
821 RTEarea[editornumber].dialogueWindows = new Object();
822 RTEarea[editornumber].dialogueWindows.defaultPositionFromTop = ' . (isset($this->thisConfig
['dialogueWindows.']['defaultPositionFromTop'])?
intval($this->thisConfig
['dialogueWindows.']['defaultPositionFromTop']) : '100') . ';
823 RTEarea[editornumber].dialogueWindows.defaultPositionFromLeft = ' . (isset($this->thisConfig
['dialogueWindows.']['defaultPositionFromLeft'])?
intval($this->thisConfig
['dialogueWindows.']['defaultPositionFromLeft']) : '100') . ';
824 RTEarea[editornumber].dialogueWindows.doNotResize = ' . (trim($this->thisConfig
['dialogueWindows.']['doNotResize'])?
'true':'false') . ';
825 RTEarea[editornumber].dialogueWindows.doNotCenter = ' . (trim($this->thisConfig
['dialogueWindows.']['doNotCenter'])?
'true':'false') . ';';
827 // The following properties apply only to the backend
828 if (!$this->is_FE()) {
829 $configureRTEInJavascriptString .= '
830 RTEarea[editornumber].sys_language_content = "' . $this->contentLanguageUid
. '";
831 RTEarea[editornumber].typo3ContentLanguage = "' . $this->contentTypo3Language
. '";
832 RTEarea[editornumber].typo3ContentCharset = "' . $this->contentCharset
. '";
833 RTEarea[editornumber].userUid = "' . $this->userUid
. '";';
836 // Setting the plugin flags
837 $configureRTEInJavascriptString .= '
838 RTEarea[editornumber].plugin = new Object();
839 RTEarea[editornumber].pathToPluginDirectory = new Object();';
840 foreach ($this->pluginEnabledArray
as $pluginId) {
841 $configureRTEInJavascriptString .= '
842 RTEarea[editornumber].plugin.'.$pluginId.' = true;';
843 if (is_object($this->registeredPlugins
[$pluginId])) {
844 $pathToPluginDirectory = $this->registeredPlugins
[$pluginId]->getPathToPluginDirectory();
845 if ($pathToPluginDirectory) {
846 $configureRTEInJavascriptString .= '
847 RTEarea[editornumber].pathToPluginDirectory.'.$pluginId.' = "' . $pathToPluginDirectory . '";';
852 // Setting the buttons configuration
853 $configureRTEInJavascriptString .= '
854 RTEarea[editornumber].buttons = new Object();';
855 if (is_array($this->thisConfig
['buttons.'])) {
856 foreach ($this->thisConfig
['buttons.'] as $buttonIndex => $conf) {
857 $button = substr($buttonIndex, 0, -1);
858 $configureRTEInJavascriptString .= '
859 RTEarea[editornumber].buttons.'.$button.' = ' . $this->buildNestedJSArray($conf) . ';';
863 // Setting the list of tags to be removed if specified in the RTE config
864 if (trim($this->thisConfig
['removeTags'])) {
865 $configureRTEInJavascriptString .= '
866 RTEarea[editornumber].htmlRemoveTags = /^(' . implode('|', t3lib_div
::trimExplode(',', $this->thisConfig
['removeTags'], 1)) . ')$/i;';
869 // Setting the list of tags to be removed with their contents if specified in the RTE config
870 if (trim($this->thisConfig
['removeTagsAndContents'])) {
871 $configureRTEInJavascriptString .= '
872 RTEarea[editornumber].htmlRemoveTagsAndContents = /^(' . implode('|', t3lib_div
::trimExplode(',', $this->thisConfig
['removeTagsAndContents'], 1)) . ')$/i;';
874 // Process default style configuration
875 $configureRTEInJavascriptString .= '
876 RTEarea[editornumber].defaultPageStyle = "' . $this->writeTemporaryFile('', 'defaultPageStyle', 'css', $this->buildStyleSheet()) . '";';
877 // Setting the pageStyle
878 $filename = trim($this->thisConfig
['contentCSS']) ?
trim($this->thisConfig
['contentCSS']) : 'EXT:' . $this->ID
. '/res/contentcss/default.css';
879 $configureRTEInJavascriptString .= '
880 RTEarea[editornumber].pageStyle = "' . t3lib_div
::createVersionNumberedFilename($this->getFullFileName($filename)) .'";';
881 // Process classes configuration
882 $classesConfigurationRequired = false;
883 foreach ($this->registeredPlugins
as $pluginId => $plugin) {
884 if ($this->isPluginEnabled($pluginId)) {
885 $classesConfigurationRequired = $classesConfigurationRequired ||
$plugin->requiresClassesConfiguration();
888 if ($classesConfigurationRequired) {
889 $configureRTEInJavascriptString .= $this->buildJSClassesConfig($RTEcounter);
891 // Add Javascript configuration for registered plugins
892 foreach ($this->registeredPlugins
as $pluginId => $plugin) {
893 if ($this->isPluginEnabled($pluginId)) {
894 $configureRTEInJavascriptString .= $plugin->buildJavascriptConfiguration('editornumber');
897 // Avoid premature reference to HTMLArea when being initially loaded by IRRE Ajax call
898 $configureRTEInJavascriptString .= '
899 RTEarea[editornumber].toolbar = ' . $this->getJSToolbarArray() . ';
900 RTEarea[editornumber].convertButtonId = ' . json_encode(array_flip($this->convertToolbarForHtmlAreaArray
)) . ';
901 RTEarea.initEditor(editornumber);
904 configureEditorInstance["' . $textAreaId . '"]();';
905 return $configureRTEInJavascriptString;
909 * Return true, if the plugin can be loaded
911 * @param string $pluginId: The identification string of the plugin
913 * @return boolean true if the plugin can be loaded
916 function isPluginEnabled($pluginId) {
917 return in_array($pluginId, $this->pluginEnabledArray
);
921 * Build the default content style sheet
923 * @return string Style sheet
925 function buildStyleSheet() {
927 if (!trim($this->thisConfig
['ignoreMainStyleOverride'])) {
928 $mainStyle_font = $this->thisConfig
['mainStyle_font'] ?
$this->thisConfig
['mainStyle_font']: 'Verdana,sans-serif';
930 $mainElements = array();
931 $mainElements['P'] = $this->thisConfig
['mainStyleOverride_add.']['P'];
932 $elList = explode(',','H1,H2,H3,H4,H5,H6,PRE');
933 foreach ($elList as $elListName) {
934 if ($this->thisConfig
['mainStyleOverride_add.'][$elListName]) {
935 $mainElements[$elListName] = $this->thisConfig
['mainStyleOverride_add.'][$elListName];
939 $addElementCode = '';
940 foreach ($mainElements as $elListName => $elValue) {
941 $addElementCode .= strToLower($elListName) . ' {' . $elValue . '}' . LF
;
944 $stylesheet = $this->thisConfig
['mainStyleOverride'] ?
$this->thisConfig
['mainStyleOverride'] : LF
.
945 'body.htmlarea-content-body { font-family: ' . $mainStyle_font .
946 '; font-size: '.($this->thisConfig
['mainStyle_size'] ?
$this->thisConfig
['mainStyle_size'] : '12px') .
947 '; color: '.($this->thisConfig
['mainStyle_color']?
$this->thisConfig
['mainStyle_color'] : 'black') .
948 '; background-color: '.($this->thisConfig
['mainStyle_bgcolor'] ?
$this->thisConfig
['mainStyle_bgcolor'] : 'white') .
949 ';'.$this->thisConfig
['mainStyleOverride_add.']['BODY'].'}' . LF
.
950 'td { ' . $this->thisConfig
['mainStyleOverride_add.']['TD'].'}' . LF
.
951 'div { ' . $this->thisConfig
['mainStyleOverride_add.']['DIV'].'}' . LF
.
952 'pre { ' . $this->thisConfig
['mainStyleOverride_add.']['PRE'].'}' . LF
.
953 'ol { ' . $this->thisConfig
['mainStyleOverride_add.']['OL'].'}' . LF
.
954 'ul { ' . $this->thisConfig
['mainStyleOverride_add.']['UL'].'}' . LF
.
955 'blockquote { ' . $this->thisConfig
['mainStyleOverride_add.']['BLOCKQUOTE'].'}' . LF
.
958 if (is_array($this->thisConfig
['inlineStyle.'])) {
959 $stylesheet .= LF
. implode(LF
, $this->thisConfig
['inlineStyle.']) . LF
;
962 $stylesheet = '/* mainStyleOverride and inlineStyle properties ignored. */';
968 * Return Javascript configuration of classes
970 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
972 * @return string Javascript configuration of classes
974 function buildJSClassesConfig($RTEcounter) {
975 // Build JS array of lists of classes
976 $classesTagList = 'classesCharacter, classesParagraph, classesImage, classesTable, classesLinks, classesTD';
977 $classesTagConvert = array( 'classesCharacter' => 'span', 'classesParagraph' => 'div', 'classesImage' => 'img', 'classesTable' => 'table', 'classesLinks' => 'a', 'classesTD' => 'td');
978 $classesTagArray = t3lib_div
::trimExplode(',' , $classesTagList);
979 $configureRTEInJavascriptString = '
980 RTEarea[editornumber].classesTag = new Object();';
981 foreach ($classesTagArray as $classesTagName) {
982 $HTMLAreaJSClasses = ($this->thisConfig
[$classesTagName])?
('"' . $this->cleanList($this->thisConfig
[$classesTagName]) . '";'):'null;';
983 $configureRTEInJavascriptString .= '
984 RTEarea[editornumber].classesTag.'. $classesTagConvert[$classesTagName] .' = '. $HTMLAreaJSClasses;
986 // Include JS arrays of configured classes
987 $configureRTEInJavascriptString .= '
988 RTEarea[editornumber].classesUrl = "' . $this->writeTemporaryFile('', 'classes_'.$LANG->lang
, 'js', $this->buildJSClassesArray()) . '";';
989 return $configureRTEInJavascriptString;
993 * Return JS arrays of classes configuration
995 * @return string JS classes arrays
997 function buildJSClassesArray() {
998 if ($this->is_FE()) {
999 $RTEProperties = $this->RTEsetup
;
1001 $RTEProperties = $this->RTEsetup
['properties'];
1003 $classesArray = array('labels' => array(), 'values' => array(), 'noShow' => array(), 'alternating' => array(), 'counting' => array(), 'XOR' => array());
1004 $JSClassesArray = '';
1005 // Scanning the list of classes if specified in the RTE config
1006 if (is_array($RTEProperties['classes.'])) {
1007 foreach ($RTEProperties['classes.'] as $className => $conf) {
1008 $className = rtrim($className, '.');
1009 $classesArray['labels'][$className] = $this->getPageConfigLabel($conf['name'], FALSE);
1010 $classesArray['values'][$className] = str_replace('\\\'', '\'', $conf['value']);
1011 if (isset($conf['noShow'])) {
1012 $classesArray['noShow'][$className] = $conf['noShow'];
1014 if (is_array($conf['alternating.'])) {
1015 $classesArray['alternating'][$className] = $conf['alternating.'];
1017 if (is_array($conf['counting.'])) {
1018 $classesArray['counting'][$className] = $conf['counting.'];
1022 // Scanning the list of sets of mutually exclusives classes if specified in the RTE config
1023 if (is_array($RTEProperties['mutuallyExclusiveClasses.'])) {
1024 foreach ($RTEProperties['mutuallyExclusiveClasses.'] as $listName => $conf) {
1025 $classSet = t3lib_div
::trimExplode(',', $conf, 1);
1026 $classList = implode(',', $classSet);
1027 foreach ($classSet as $className) {
1028 $classesArray['XOR'][$className] = '/^(' . implode('|', t3lib_div
::trimExplode(',', t3lib_div
::rmFromList($className, $classList), 1)) . ')$/';
1032 foreach ($classesArray as $key => $subArray) {
1033 $JSClassesArray .= 'HTMLArea.classes' . ucfirst($key) . ' = ' . $this->buildNestedJSArray($subArray) . ';' . LF
;
1035 return $JSClassesArray;
1039 * Translate Page TS Config array in JS nested array definition
1040 * Replace 0 values with false
1041 * Unquote regular expression values
1042 * Replace empty arrays with empty objects
1044 * @param array $conf: Page TSConfig configuration array
1046 * @return string nested JS array definition
1048 function buildNestedJSArray($conf) {
1049 $convertedConf = t3lib_div
::removeDotsFromTS($conf);
1050 if ($this->is_FE()) {
1051 $GLOBALS['TSFE']->csConvObj
->convArray($convertedConf, ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'] ?
$GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'] : 'iso-8859-1'), 'utf-8');
1053 $GLOBALS['LANG']->csConvObj
->convArray($convertedConf, $GLOBALS['LANG']->charSet
, 'utf-8');
1055 return str_replace(array(':"0"', ':"\/^(', ')$\/i"', ':"\/^(', ')$\/"', '[]'), array(':false', ':/^(', ')$/i', ':/^(', ')$/', '{}'), json_encode($convertedConf));
1059 * Return a Javascript localization array for htmlArea RTE
1061 * @return string Javascript localization array
1063 function buildJSMainLangArray() {
1064 $JSLanguageArray = 'HTMLArea.I18N = new Object();' . LF
;
1065 $labelsArray = array('tooltips' => array(), 'msg' => array(), 'dialogs' => array());
1066 foreach ($labelsArray as $labels => $subArray) {
1067 $LOCAL_LANG = t3lib_div
::readLLfile('EXT:' . $this->ID
. '/htmlarea/locallang_' . $labels . '.xml', $this->language
, 'utf-8');
1068 if (!empty($LOCAL_LANG[$this->language
])) {
1069 $LOCAL_LANG[$this->language
] = t3lib_div
::array_merge_recursive_overrule($LOCAL_LANG['default'], $LOCAL_LANG[$this->language
]);
1071 $LOCAL_LANG[$this->language
] = $LOCAL_LANG['default'];
1073 $labelsArray[$labels] = $LOCAL_LANG[$this->language
];
1075 $JSLanguageArray .= 'HTMLArea.I18N = ' . json_encode($labelsArray) . ';' . LF
;
1076 return $JSLanguageArray;
1080 * Writes contents in a file in typo3temp/rtehtmlarea directory and returns the file name
1082 * @param string $sourceFileName: The name of the file from which the contents should be extracted
1083 * @param string $label: A label to insert at the beginning of the name of the file
1084 * @param string $fileExtension: The file extension of the file, defaulting to 'js'
1085 * @param string $contents: The contents to write into the file if no $sourceFileName is provided
1087 * @return string The name of the file writtten to typo3temp/rtehtmlarea
1089 public function writeTemporaryFile($sourceFileName='', $label, $fileExtension='js', $contents='', $concatenate = FALSE) {
1090 global $TYPO3_CONF_VARS;
1092 if ($sourceFileName) {
1094 $source = t3lib_div
::getFileAbsFileName($sourceFileName);
1095 $output = file_get_contents($source);
1097 $output = $contents;
1099 $compress = $TYPO3_CONF_VARS['EXTCONF'][$this->ID
]['enableCompressedScripts'] && ($fileExtension == 'js') && ($output != '');
1100 $relativeFilename = 'typo3temp/' . $this->ID
. '/' . str_replace('-','_',$label) . '_' . t3lib_div
::shortMD5(($TYPO3_CONF_VARS['EXTCONF'][$this->ID
]['version'] . ($sourceFileName ?
$sourceFileName : $output)), 20) . ($compress ?
'_compressed' : '') . '.' . $fileExtension;
1101 $destination = PATH_site
. $relativeFilename;
1102 if(!file_exists($destination)) {
1103 $compressedJavaScript = '';
1104 if ($compress && $fileExtension == 'js') {
1105 $compressedJavaScript = t3lib_div
::minifyJavaScript($output);
1107 $failure = t3lib_div
::writeFileToTypo3tempDir($destination, $compressedJavaScript ?
$compressedJavaScript : $output);
1112 if ($concatenate && $fileExtension == 'js') {
1113 $this->cumulativeScripts
[$this->TCEform
->RTEcounter
][] = $destination;
1115 if ($this->is_FE()) {
1116 $filename = ($GLOBALS['TSFE']->absRefPrefix ?
$GLOBALS['TSFE']->absRefPrefix
: '') . t3lib_div
::createVersionNumberedFilename($relativeFilename);
1118 $filename = t3lib_div
::createVersionNumberedFilename(($this->isFrontendEditActive() ?
'' : ($this->backPath
. '../')) . $relativeFilename);
1120 return t3lib_div
::resolveBackPath($filename);
1123 * Concatenates all accumulated scripts in a file in typo3temp/rtehtmlarea directory and returns the file name
1125 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
1127 * @return string The name of the file writtten to typo3temp/rtehtmlarea
1129 protected function doConcatenate($RTEcounter) {
1130 $fileExtension = 'js';
1131 $compress = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->ID
]['enableCompressedScripts'];
1132 $token = implode('|', $this->cumulativeScripts
[$RTEcounter]);
1133 $relativeFilename = 'typo3temp/' . $this->ID
. '/' . 'htmlarea_cumulative' . '_' . t3lib_div
::shortMD5(($TYPO3_CONF_VARS['EXTCONF'][$this->ID
]['version'] . $token ), 20) . ($compress ?
'_compressed' : '') . '.' . $fileExtension;
1134 $destination = PATH_site
. $relativeFilename;
1135 if (!file_exists($destination)) {
1136 foreach ($this->cumulativeScripts
[$RTEcounter] as $fileName) {
1137 $contents = file_get_contents($fileName);
1138 if (!file_exists($destination)) {
1139 $failure = t3lib_div
::writeFileToTypo3tempDir($destination, $contents);
1144 $success = file_put_contents($destination, $contents, FILE_APPEND
);
1146 die('Could not append script' +
$fileName);
1151 if ($this->is_FE()) {
1152 $filename = ($GLOBALS['TSFE']->absRefPrefix ?
$GLOBALS['TSFE']->absRefPrefix
: '') . t3lib_div
::createVersionNumberedFilename($relativeFilename);
1155 $compressor = t3lib_div
::makeInstance('t3lib_Compressor');
1156 $filename = $compressor->compressJsFile(($this->isFrontendEditActive() ?
'' : $this->backPath
) . '../' . $relativeFilename);
1157 if ($this->isFrontendEditActive()) {
1158 $filename = preg_replace('/^..\//', '', $filename);
1161 $filename = t3lib_div
::createVersionNumberedFilename(($this->isFrontendEditActive() ?
'' : ($this->backPath
. '../')) . $relativeFilename);
1164 return t3lib_div
::resolveBackPath($filename);
1168 * Return a file name containing the main JS language array for HTMLArea
1170 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
1172 * @return string filename
1174 function buildJSMainLangFile($RTEcounter) {
1175 $contents = $this->buildJSMainLangArray() . LF
;
1176 foreach ($this->pluginEnabledCumulativeArray
[$RTEcounter] as $pluginId) {
1177 $contents .= $this->buildJSLangArray($pluginId) . LF
;
1179 return $this->writeTemporaryFile('', $this->language
.'_'.$this->OutputCharset
, 'js', $contents, TRUE);
1183 * Return a Javascript localization array for the plugin
1185 * @param string $plugin: identification string of the plugin
1187 * @return string Javascript localization array
1190 function buildJSLangArray($plugin) {
1191 $LOCAL_LANG = FALSE;
1192 $extensionKey = is_object($this->registeredPlugins
[$plugin]) ?
$this->registeredPlugins
[$plugin]->getExtensionKey() : $this->ID
;
1193 $LOCAL_LANG = t3lib_div
::readLLfile('EXT:' . $extensionKey . '/htmlarea/plugins/' . $plugin . '/locallang.xml', $this->language
, 'utf-8', 1);
1194 $linebreak = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->ID
]['enableCompressedScripts'] ?
'' : LF
;
1195 $JSLanguageArray = 'HTMLArea.I18N["' . $plugin . '"] = new Object();' . $linebreak;
1196 if (is_array($LOCAL_LANG)) {
1197 if (!empty($LOCAL_LANG[$this->language
])) {
1198 $LOCAL_LANG[$this->language
] = t3lib_div
::array_merge_recursive_overrule($LOCAL_LANG['default'],$LOCAL_LANG[$this->language
]);
1200 $LOCAL_LANG[$this->language
] = $LOCAL_LANG['default'];
1202 $JSLanguageArray .= 'HTMLArea.I18N["' . $plugin . '"] = ' . json_encode($LOCAL_LANG[$this->language
]) . ';'. LF
;
1204 return $JSLanguageArray;
1208 * Return the JS code of the toolbar configuration for the HTMLArea editor
1210 * @return string the JS code as nested JS arrays
1212 protected function getJSToolbarArray() {
1213 // The toolbar array
1215 // The current row; a "linebreak" ends the current row
1217 // The current group; each group is between "bar"s; a "linebreak" ends the current group
1219 // Process each toolbar item in the toolbar order list
1220 foreach ($this->toolbarOrderArray
as $item) {
1223 // Add row to toolbar if not empty
1224 if (!empty($group)) {
1234 // Add group to row if not empty
1235 if (!empty($group)) {
1241 if (end($group) != $this->convertToolbarForHTMLArea($item)) {
1242 $group[] = $this->convertToolbarForHTMLArea($item);
1246 if (in_array($item, $this->toolbar
)) {
1247 // Add the item to the group
1248 $convertedItem = $this->convertToolbarForHTMLArea($item);
1249 if ($convertedItem) {
1250 $group[] = $convertedItem;
1256 // Add the last group and last line, if not empty
1257 if (!empty($group)) {
1263 return json_encode($toolbar);
1266 public function getLLContent($string) {
1269 $BE_lang = $LANG->lang
;
1270 $BE_charSet = $LANG->charSet
;
1271 $LANG->lang
= $this->contentTypo3Language
;
1272 $LANG->charSet
= $this->contentCharset
;
1273 $LLString = $LANG->JScharCode($LANG->sL($string));
1274 $LANG->lang
= $BE_lang;
1275 $LANG->charSet
= $BE_charSet;
1279 public function getPageConfigLabel($string,$JScharCode=1) {
1280 global $LANG, $TSFE, $TYPO3_CONF_VARS;
1282 if ($this->is_FE()) {
1283 if (strcmp(substr($string,0,4),'LLL:') && $TYPO3_CONF_VARS['BE']['forceCharset']) {
1284 // A pure string coming from Page TSConfig must be in forceCharset, otherwise we just don't know..
1285 $label = $TSFE->csConvObj
->conv($TSFE->sL(trim($string)), $TYPO3_CONF_VARS['BE']['forceCharset'], $this->OutputCharset
);
1287 $label = $TSFE->csConvObj
->conv($TSFE->sL(trim($string)), $this->charset
, $this->OutputCharset
);
1289 $label = str_replace('"', '\"', str_replace('\\\'', '\'', $label));
1290 $label = $JScharCode ?
$this->feJScharCode($label) : $label;
1292 if (strcmp(substr($string,0,4),'LLL:')) {
1295 $label = $LANG->sL(trim($string));
1297 $label = str_replace('"', '\"', str_replace('\\\'', '\'', $label));
1298 $label = $JScharCode ?
$LANG->JScharCode($label): $label;
1303 function feJScharCode($str) {
1305 // Convert string to UTF-8:
1306 if ($this->OutputCharset
!= 'utf-8') $str = $TSFE->csConvObj
->utf8_encode($str,$this->OutputCharset
);
1307 // Convert the UTF-8 string into a array of char numbers:
1308 $nArr = $TSFE->csConvObj
->utf8_to_numberarray($str);
1309 return 'String.fromCharCode('.implode(',',$nArr).')';
1312 public function getFullFileName($filename) {
1313 if (substr($filename,0,4)=='EXT:') { // extension
1314 list($extKey,$local) = explode('/',substr($filename,4),2);
1316 if (strcmp($extKey,'') && t3lib_extMgm
::isLoaded($extKey) && strcmp($local,'')) {
1317 $newFilename = (($this->is_FE() ||
$this->isFrontendEditActive()) ? t3lib_extMgm
::siteRelPath($extKey) : $this->backPath
. t3lib_extMgm
::extRelPath($extKey)) . $local;
1319 } elseif (substr($filename,0,1) != '/') {
1320 $newFilename = (($this->is_FE() ||
$this->isFrontendEditActive()) ?
'' : ($this->backPath
. '../')) . $filename;
1322 $newFilename = (($this->is_FE() ||
$this->isFrontendEditActive()) ?
'' : ($this->backPath
. '../')) . substr($filename, 1);
1324 return t3lib_div
::resolveBackPath($newFilename);
1328 * Return the Javascript code for copying the HTML code from the editor into the hidden input field.
1329 * This is for submit function of the form.
1331 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
1332 * @param string $formName: the name of the form
1333 * @param string $textareaId: the id of the textarea
1334 * @param string $textareaName: the name of the textarea
1336 * @return string Javascript code
1338 function setSaveRTE($RTEcounter, $formName, $textareaId, $textareaName) {
1339 return 'if (RTEarea["' . $textareaId . '"]) { document.' . $formName . '["' . $textareaName . '"].value = RTEarea["' . $textareaId . '"].editor.getHTML(); } else { OK = 0; };';
1343 * Return the Javascript code for copying the HTML code from the editor into the hidden input field.
1344 * This is for submit function of the form.
1346 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
1347 * @param string $formName: the name of the form
1348 * @param string $textareaId: the id of the textarea
1350 * @return string Javascript code
1352 function setDeleteRTE($RTEcounter, $formName, $textareaId) {
1353 return 'if (RTEarea["' . $textareaId . '"]) { RTEarea["' . $textareaId . '"].deleted = true;}';
1357 * Return true if we are in the FE, but not in the FE editing feature of BE.
1363 return is_object($GLOBALS['TSFE']) && !$this->isFrontendEditActive() && TYPO3_MODE
=='FE';
1367 * Checks whether frontend editing is active.
1371 public function isFrontendEditActive() {
1372 return is_object($GLOBALS['TSFE']) && $GLOBALS['TSFE']->beUserLogin
&& ($GLOBALS['BE_USER']->frontendEdit
instanceof t3lib_frontendedit
);
1375 * Client Browser Information
1377 * @param string $userAgent: The useragent string, t3lib_div::getIndpEnv('HTTP_USER_AGENT')
1378 * @return array Contains keys "useragent", "browser", "version", "system"
1379 * where "browser" is limited to the engines
1380 * and where "version" is a floating number
1382 function clientInfo ($userAgent='') {
1384 $userAgent = t3lib_div
::getIndpEnv('HTTP_USER_AGENT');
1386 $browserInfo = t3lib_utility_Client
::getBrowserInfo($userAgent);
1387 // Known engines: order is not irrelevant!
1388 $knownEngines = array('opera', 'msie', 'gecko', 'webkit');
1389 if (is_array($browserInfo['all'])) {
1390 foreach ($knownEngines as $engine) {
1391 if ($browserInfo['all'][$engine]) {
1392 $browserInfo['browser'] = $engine;
1393 $browserInfo['version'] = t3lib_utility_Client
::getVersion($browserInfo['all'][$engine]);
1398 if ($browserInfo['system'] == 'mac') {
1399 if (strstr($userAgent,'iPad')) {
1400 $browserInfo['system'] = 'iPad';
1401 } elseif (strstr($userAgent,'iPhone')) {
1402 $browserInfo['system'] = 'iPhone';
1403 } elseif (strstr($userAgent,'iPod')) {
1404 $browserInfo['system'] = 'iPod';
1407 return $browserInfo;
1409 /***************************
1411 * OTHER FUNCTIONS: (from Classic RTE)
1413 ***************************/
1415 * @return [type] ...
1419 function RTEtsConfigParams() {
1420 if($this->is_FE()) {
1423 $p = t3lib_BEfunc
::getSpecConfParametersFromArray($this->specConf
['rte_transform']['parameters']);
1424 return $this->elementParts
[0].':'.$this->elementParts
[1].':'.$this->elementParts
[2].':'.$this->thePid
.':'.$this->typeVal
.':'.$this->tscPID
.':'.$p['imgpath'];
1428 public function cleanList($str) {
1429 if (strstr($str,'*')) {
1432 $str = implode(',',array_unique(t3lib_div
::trimExplode(',',$str,1)));
1437 function filterStyleEl($elValue,$matchList) {
1438 $matchParts = t3lib_div
::trimExplode(',',$matchList,1);
1439 $styleParts = explode(';',$elValue);
1441 foreach ($styleParts as $k => $p) {
1442 $pp = t3lib_div
::trimExplode(':',$p);
1443 if ($pp[0]&&$pp[1]) {
1444 foreach ($matchParts as $el) {
1445 $star=substr($el,-1)=='*';
1446 if (!strcmp($pp[0],$el) ||
($star && t3lib_div
::isFirstPartOfStr($pp[0],substr($el,0,-1)) )) {
1447 $nStyle[]=$pp[0].':'.$pp[1];
1448 } else unset($styleParts[$k]);
1451 unset($styleParts[$k]);
1454 return implode('; ',$nStyle);
1457 // Hook on lorem_ipsum extension to insert text into the RTE in wysiwyg mode
1458 function loremIpsumInsert($params) {
1460 if (typeof(lorem_ipsum) == 'function' && " . $params['element'] . ".tagName.toLowerCase() == 'textarea' ) lorem_ipsum(" . $params['element'] . ", lipsum_temp_strings[lipsum_temp_pointer]);
1464 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['ext/rtehtmlarea/class.tx_rtehtmlarea_base.php']) {
1465 include_once($TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['ext/rtehtmlarea/class.tx_rtehtmlarea_base.php']);