0009a7cc85436067daba5901205f49a66d636d72
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Page / PageRenderer.php
1 <?php
2 namespace TYPO3\CMS\Core\Page;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Backend\Utility\BackendUtility;
18 use TYPO3\CMS\Core\Utility\GeneralUtility;
19
20 /**
21 * TYPO3 pageRender class (new in TYPO3 4.3.0)
22 * This class render the HTML of a webpage, usable for BE and FE
23 *
24 * @author Steffen Kamper <info@sk-typo3.de>
25 * @author Kai Vogel <kai.vogel@speedprogs.de>
26 */
27 class PageRenderer implements \TYPO3\CMS\Core\SingletonInterface {
28
29 // Constants for the part to be rendered
30 const PART_COMPLETE = 0;
31 const PART_HEADER = 1;
32 const PART_FOOTER = 2;
33 // Available adapters for extJs
34 const EXTJS_ADAPTER_JQUERY = 'jquery';
35 const EXTJS_ADAPTER_PROTOTYPE = 'prototype';
36 const EXTJS_ADAPTER_YUI = 'yui';
37 // jQuery Core version that is shipped with TYPO3
38 const JQUERY_VERSION_LATEST = '1.11.2';
39 // jQuery namespace options
40 const JQUERY_NAMESPACE_NONE = 'none';
41 const JQUERY_NAMESPACE_DEFAULT = 'jQuery';
42 const JQUERY_NAMESPACE_DEFAULT_NOCONFLICT = 'defaultNoConflict';
43
44 /**
45 * @var bool
46 */
47 protected $compressJavascript = FALSE;
48
49 /**
50 * @var bool
51 */
52 protected $compressCss = FALSE;
53
54 /**
55 * @var bool
56 */
57 protected $removeLineBreaksFromTemplate = FALSE;
58
59 /**
60 * @var bool
61 */
62 protected $concatenateFiles = FALSE;
63
64 /**
65 * @var bool
66 */
67 protected $concatenateJavascript = FALSE;
68
69 /**
70 * @var bool
71 */
72 protected $concatenateCss = FALSE;
73
74 /**
75 * @var bool
76 */
77 protected $moveJsFromHeaderToFooter = FALSE;
78
79 /**
80 * @var \TYPO3\CMS\Core\Charset\CharsetConverter
81 */
82 protected $csConvObj;
83
84 /**
85 * @var \TYPO3\CMS\Core\Localization\Locales
86 */
87 protected $locales;
88
89 /**
90 * The language key
91 * Two character string or 'default'
92 *
93 * @var string
94 */
95 protected $lang;
96
97 /**
98 * List of language dependencies for actual language. This is used for local variants of a language
99 * that depend on their "main" language, like Brazilian Portuguese or Canadian French.
100 *
101 * @var array
102 */
103 protected $languageDependencies = array();
104
105 /**
106 * @var \TYPO3\CMS\Core\Resource\ResourceCompressor
107 */
108 protected $compressor;
109
110 // Arrays containing associative array for the included files
111 /**
112 * @var array
113 */
114 protected $jsFiles = array();
115
116 /**
117 * @var array
118 */
119 protected $jsFooterFiles = array();
120
121 /**
122 * @var array
123 */
124 protected $jsLibs = array();
125
126 /**
127 * @var array
128 */
129 protected $jsFooterLibs = array();
130
131 /**
132 * @var array
133 */
134 protected $cssFiles = array();
135
136 /**
137 * @var array
138 */
139 protected $cssLibs = array();
140
141 /**
142 * The title of the page
143 *
144 * @var string
145 */
146 protected $title;
147
148 /**
149 * Charset for the rendering
150 *
151 * @var string
152 */
153 protected $charSet;
154
155 /**
156 * @var string
157 */
158 protected $favIcon;
159
160 /**
161 * @var string
162 */
163 protected $baseUrl;
164
165 /**
166 * @var bool
167 */
168 protected $renderXhtml = TRUE;
169
170 // Static header blocks
171 /**
172 * @var string
173 */
174 protected $xmlPrologAndDocType = '';
175
176 /**
177 * @var array
178 */
179 protected $metaTags = array();
180
181 /**
182 * @var array
183 */
184 protected $inlineComments = array();
185
186 /**
187 * @var array
188 */
189 protected $headerData = array();
190
191 /**
192 * @var array
193 */
194 protected $footerData = array();
195
196 /**
197 * @var string
198 */
199 protected $titleTag = '<title>|</title>';
200
201 /**
202 * @var string
203 */
204 protected $metaCharsetTag = '<meta http-equiv="Content-Type" content="text/html; charset=|" />';
205
206 /**
207 * @var string
208 */
209 protected $htmlTag = '<html>';
210
211 /**
212 * @var string
213 */
214 protected $headTag = '<head>';
215
216 /**
217 * @var string
218 */
219 protected $baseUrlTag = '<base href="|" />';
220
221 /**
222 * @var string
223 */
224 protected $iconMimeType = '';
225
226 /**
227 * @var string
228 */
229 protected $shortcutTag = '<link rel="shortcut icon" href="%1$s"%2$s />';
230
231 // Static inline code blocks
232 /**
233 * @var array
234 */
235 protected $jsInline = array();
236
237 /**
238 * @var array
239 */
240 protected $jsFooterInline = array();
241
242 /**
243 * @var array
244 */
245 protected $extOnReadyCode = array();
246
247 /**
248 * @var array
249 */
250 protected $cssInline = array();
251
252 /**
253 * @var string
254 */
255 protected $bodyContent;
256
257 /**
258 * @var string
259 */
260 protected $templateFile;
261
262 /**
263 * @var array
264 */
265 protected $jsLibraryNames = array('prototype', 'scriptaculous', 'extjs');
266
267 // Paths to contibuted libraries
268
269 /**
270 * default path to the requireJS library, relative to the typo3/ directory
271 * @var string
272 */
273 protected $requireJsPath = 'sysext/core/Resources/Public/JavaScript/Contrib/requirejs/';
274
275 /**
276 * @var string
277 */
278 protected $prototypePath = 'contrib/prototype/';
279
280 /**
281 * @var string
282 */
283 protected $scriptaculousPath = 'contrib/scriptaculous/';
284
285 /**
286 * @var string
287 */
288 protected $extCorePath = 'contrib/extjs/';
289
290 /**
291 * @var string
292 */
293 protected $extJsPath = 'contrib/extjs/';
294
295 /**
296 * The local directory where one can find jQuery versions and plugins
297 *
298 * @var string
299 */
300 protected $jQueryPath = 'contrib/jquery/';
301
302 // Internal flags for JS-libraries
303 /**
304 * This array holds all jQuery versions that should be included in the
305 * current page.
306 * Each version is described by "source", "version" and "namespace"
307 *
308 * The namespace of every particular version is the key
309 * of that array, because only one version per namespace can exist.
310 *
311 * The type "source" describes where the jQuery core should be included from
312 * currently, TYPO3 supports "local" (make use of jQuery path), "google",
313 * "jquery" and "msn".
314 * Currently there are downsides to "local" and "jquery", as "local" only
315 * supports the latest/shipped jQuery core out of the box, and
316 * "jquery" does not have SSL support.
317 *
318 * @var array
319 */
320 protected $jQueryVersions = array();
321
322 /**
323 * Array of jQuery version numbers shipped with the core
324 *
325 * @var array
326 */
327 protected $availableLocalJqueryVersions = array(
328 '1.8.2', // jquery version shipped with TYPO3 6.0, still available in the contrib/ directory
329 '1.9.1',
330 '1.11.0',
331 '1.11.1',
332 self::JQUERY_VERSION_LATEST
333 );
334
335 /**
336 * Array of jQuery CDNs with placeholders
337 *
338 * @var array
339 */
340 protected $jQueryCdnUrls = array(
341 'google' => '//ajax.googleapis.com/ajax/libs/jquery/%1$s/jquery%2$s.js',
342 'msn' => '//ajax.aspnetcdn.com/ajax/jQuery/jquery-%1$s%2$s.js',
343 'jquery' => 'http://code.jquery.com/jquery-%1$s%2$s.js'
344 );
345
346 /**
347 * if set, the requireJS library is included
348 * @var bool
349 */
350 protected $addRequireJs = FALSE;
351
352 /**
353 * inline configuration for requireJS
354 * @var array
355 */
356 protected $requireJsConfig = array();
357
358 /**
359 * @var bool
360 */
361 protected $addPrototype = FALSE;
362
363 /**
364 * @var bool
365 */
366 protected $addScriptaculous = FALSE;
367
368 /**
369 * @var array
370 */
371 protected $addScriptaculousModules = array('builder' => FALSE, 'effects' => FALSE, 'dragdrop' => FALSE, 'controls' => FALSE, 'slider' => FALSE);
372
373 /**
374 * @var bool
375 */
376 protected $addExtJS = FALSE;
377
378 /**
379 * @var bool
380 */
381 protected $addExtCore = FALSE;
382
383 /**
384 * @var string
385 */
386 protected $extJSadapter = 'ext/ext-base.js';
387
388 /**
389 * @var bool
390 */
391 protected $extDirectCodeAdded = FALSE;
392
393 /**
394 * @var bool
395 */
396 protected $enableExtJsDebug = FALSE;
397
398 /**
399 * @var bool
400 */
401 protected $enableExtCoreDebug = FALSE;
402
403 /**
404 * @var bool
405 */
406 protected $enableJqueryDebug = FALSE;
407
408 /**
409 * @var bool
410 */
411 protected $extJStheme = TRUE;
412
413 /**
414 * @var bool
415 */
416 protected $extJScss = TRUE;
417
418 /**
419 * @var bool
420 */
421 protected $enableExtJSQuickTips = FALSE;
422
423 /**
424 * @var array
425 */
426 protected $inlineLanguageLabels = array();
427
428 /**
429 * @var array
430 */
431 protected $inlineLanguageLabelFiles = array();
432
433 /**
434 * @var array
435 */
436 protected $inlineSettings = array();
437
438 /**
439 * @var array
440 */
441 protected $inlineJavascriptWrap = array();
442
443 /**
444 * Saves error messages generated during compression
445 *
446 * @var string
447 */
448 protected $compressError = '';
449
450 /**
451 * Is empty string for HTML and ' /' for XHTML rendering
452 *
453 * @var string
454 */
455 protected $endingSlash = '';
456
457 /**
458 * Used by BE modules
459 *
460 * @var null|string
461 */
462 public $backPath;
463
464 /**
465 * @param string $templateFile Declare the used template file. Omit this parameter will use default template
466 * @param string $backPath Relative path to typo3-folder. It varies for BE modules, in FE it will be typo3/
467 */
468 public function __construct($templateFile = '', $backPath = NULL) {
469 $this->reset();
470 $this->csConvObj = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Charset\CharsetConverter::class);
471 $this->locales = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Localization\Locales::class);
472 if ($templateFile !== '') {
473 $this->templateFile = $templateFile;
474 }
475 $this->backPath = isset($backPath) ? $backPath : $GLOBALS['BACK_PATH'];
476 $this->inlineJavascriptWrap = array(
477 '<script type="text/javascript">' . LF . '/*<![CDATA[*/' . LF,
478 '/*]]>*/' . LF . '</script>' . LF
479 );
480 $this->inlineCssWrap = array(
481 '<style type="text/css">' . LF . '/*<![CDATA[*/' . LF . '<!-- ' . LF,
482 '-->' . LF . '/*]]>*/' . LF . '</style>' . LF
483 );
484 }
485
486 /**
487 * Reset all vars to initial values
488 *
489 * @return void
490 */
491 protected function reset() {
492 $this->templateFile = 'EXT:core/Resources/Private/Templates/PageRenderer.html';
493 $this->jsFiles = array();
494 $this->jsFooterFiles = array();
495 $this->jsInline = array();
496 $this->jsFooterInline = array();
497 $this->jsLibs = array();
498 $this->cssFiles = array();
499 $this->cssInline = array();
500 $this->metaTags = array();
501 $this->inlineComments = array();
502 $this->headerData = array();
503 $this->footerData = array();
504 $this->extOnReadyCode = array();
505 $this->jQueryVersions = array();
506 }
507
508 /*****************************************************/
509 /* */
510 /* Public Setters */
511 /* */
512 /* */
513 /*****************************************************/
514 /**
515 * Sets the title
516 *
517 * @param string $title title of webpage
518 * @return void
519 */
520 public function setTitle($title) {
521 $this->title = $title;
522 }
523
524 /**
525 * Enables/disables rendering of XHTML code
526 *
527 * @param bool $enable Enable XHTML
528 * @return void
529 */
530 public function setRenderXhtml($enable) {
531 $this->renderXhtml = $enable;
532 }
533
534 /**
535 * Sets xml prolog and docType
536 *
537 * @param string $xmlPrologAndDocType Complete tags for xml prolog and docType
538 * @return void
539 */
540 public function setXmlPrologAndDocType($xmlPrologAndDocType) {
541 $this->xmlPrologAndDocType = $xmlPrologAndDocType;
542 }
543
544 /**
545 * Sets meta charset
546 *
547 * @param string $charSet Used charset
548 * @return void
549 */
550 public function setCharSet($charSet) {
551 $this->charSet = $charSet;
552 }
553
554 /**
555 * Sets language
556 *
557 * @param string $lang Used language
558 * @return void
559 */
560 public function setLanguage($lang) {
561 $this->lang = $lang;
562 $this->languageDependencies = array();
563
564 // Language is found. Configure it:
565 if (in_array($this->lang, $this->locales->getLocales())) {
566 $this->languageDependencies[] = $this->lang;
567 foreach ($this->locales->getLocaleDependencies($this->lang) as $language) {
568 $this->languageDependencies[] = $language;
569 }
570 }
571 }
572
573 /**
574 * Set the meta charset tag
575 *
576 * @param string $metaCharsetTag
577 * @return void
578 */
579 public function setMetaCharsetTag($metaCharsetTag) {
580 $this->metaCharsetTag = $metaCharsetTag;
581 }
582
583 /**
584 * Sets html tag
585 *
586 * @param string $htmlTag Html tag
587 * @return void
588 */
589 public function setHtmlTag($htmlTag) {
590 $this->htmlTag = $htmlTag;
591 }
592
593 /**
594 * Sets HTML head tag
595 *
596 * @param string $headTag HTML head tag
597 * @return void
598 */
599 public function setHeadTag($headTag) {
600 $this->headTag = $headTag;
601 }
602
603 /**
604 * Sets favicon
605 *
606 * @param string $favIcon
607 * @return void
608 */
609 public function setFavIcon($favIcon) {
610 $this->favIcon = $favIcon;
611 }
612
613 /**
614 * Sets icon mime type
615 *
616 * @param string $iconMimeType
617 * @return void
618 */
619 public function setIconMimeType($iconMimeType) {
620 $this->iconMimeType = $iconMimeType;
621 }
622
623 /**
624 * Sets HTML base URL
625 *
626 * @param string $baseUrl HTML base URL
627 * @return void
628 */
629 public function setBaseUrl($baseUrl) {
630 $this->baseUrl = $baseUrl;
631 }
632
633 /**
634 * Sets template file
635 *
636 * @param string $file
637 * @return void
638 */
639 public function setTemplateFile($file) {
640 $this->templateFile = $file;
641 }
642
643 /**
644 * Sets back path
645 *
646 * @param string $backPath
647 * @return void
648 */
649 public function setBackPath($backPath) {
650 $this->backPath = $backPath;
651 }
652
653 /**
654 * Sets Content for Body
655 *
656 * @param string $content
657 * @return void
658 */
659 public function setBodyContent($content) {
660 $this->bodyContent = $content;
661 }
662
663 /**
664 * Sets path to requireJS library (relative to typo3 directory)
665 *
666 * @param string $path Path to requireJS library
667 * @return void
668 */
669 public function setRequireJsPath($path) {
670 $this->requireJsPath = $path;
671 }
672
673 /**
674 * Sets path to prototype library (relative to typo3 directory)
675 *
676 * @param string $path Path to prototype library
677 * @return void
678 */
679 public function setPrototypePath($path) {
680 $this->prototypePath = $path;
681 }
682
683 /**
684 * Sets Path for scriptaculous library (relative to typo3 directory)
685 *
686 * @param string $path
687 * @return void
688 */
689 public function setScriptaculousPath($path) {
690 $this->scriptaculousPath = $path;
691 }
692
693 /**
694 * Sets Path for Ext Core library (relative to typo3 directory)
695 *
696 * @param string $path
697 * @return void
698 */
699 public function setExtCorePath($path) {
700 $this->extCorePath = $path;
701 }
702
703 /**
704 * Sets Path for ExtJs library (relative to typo3 directory)
705 *
706 * @param string $path
707 * @return void
708 */
709 public function setExtJsPath($path) {
710 $this->extJsPath = $path;
711 }
712
713 /*****************************************************/
714 /* */
715 /* Public Enablers / Disablers */
716 /* */
717 /* */
718 /*****************************************************/
719 /**
720 * Enables MoveJsFromHeaderToFooter
721 *
722 * @return void
723 */
724 public function enableMoveJsFromHeaderToFooter() {
725 $this->moveJsFromHeaderToFooter = TRUE;
726 }
727
728 /**
729 * Disables MoveJsFromHeaderToFooter
730 *
731 * @return void
732 */
733 public function disableMoveJsFromHeaderToFooter() {
734 $this->moveJsFromHeaderToFooter = FALSE;
735 }
736
737 /**
738 * Enables compression of javascript
739 *
740 * @return void
741 */
742 public function enableCompressJavascript() {
743 $this->compressJavascript = TRUE;
744 }
745
746 /**
747 * Disables compression of javascript
748 *
749 * @return void
750 */
751 public function disableCompressJavascript() {
752 $this->compressJavascript = FALSE;
753 }
754
755 /**
756 * Enables compression of css
757 *
758 * @return void
759 */
760 public function enableCompressCss() {
761 $this->compressCss = TRUE;
762 }
763
764 /**
765 * Disables compression of css
766 *
767 * @return void
768 */
769 public function disableCompressCss() {
770 $this->compressCss = FALSE;
771 }
772
773 /**
774 * Enables concatenation of js and css files
775 *
776 * @return void
777 */
778 public function enableConcatenateFiles() {
779 $this->concatenateFiles = TRUE;
780 }
781
782 /**
783 * Disables concatenation of js and css files
784 *
785 * @return void
786 */
787 public function disableConcatenateFiles() {
788 $this->concatenateFiles = FALSE;
789 }
790
791 /**
792 * Enables concatenation of js files
793 *
794 * @return void
795 */
796 public function enableConcatenateJavascript() {
797 $this->concatenateJavascript = TRUE;
798 }
799
800 /**
801 * Disables concatenation of js files
802 *
803 * @return void
804 */
805 public function disableConcatenateJavascript() {
806 $this->concatenateJavascript = FALSE;
807 }
808
809 /**
810 * Enables concatenation of css files
811 *
812 * @return void
813 */
814 public function enableConcatenateCss() {
815 $this->concatenateCss = TRUE;
816 }
817
818 /**
819 * Disables concatenation of css files
820 *
821 * @return void
822 */
823 public function disableConcatenateCss() {
824 $this->concatenateCss = FALSE;
825 }
826
827 /**
828 * Sets removal of all line breaks in template
829 *
830 * @return void
831 */
832 public function enableRemoveLineBreaksFromTemplate() {
833 $this->removeLineBreaksFromTemplate = TRUE;
834 }
835
836 /**
837 * Unsets removal of all line breaks in template
838 *
839 * @return void
840 */
841 public function disableRemoveLineBreaksFromTemplate() {
842 $this->removeLineBreaksFromTemplate = FALSE;
843 }
844
845 /**
846 * Enables Debug Mode
847 * This is a shortcut to switch off all compress/concatenate features to enable easier debug
848 *
849 * @return void
850 */
851 public function enableDebugMode() {
852 $this->compressJavascript = FALSE;
853 $this->compressCss = FALSE;
854 $this->concatenateFiles = FALSE;
855 $this->removeLineBreaksFromTemplate = FALSE;
856 $this->enableExtCoreDebug = TRUE;
857 $this->enableExtJsDebug = TRUE;
858 $this->enableJqueryDebug = TRUE;
859 }
860
861 /*****************************************************/
862 /* */
863 /* Public Getters */
864 /* */
865 /* */
866 /*****************************************************/
867 /**
868 * Gets the title
869 *
870 * @return string $title Title of webpage
871 */
872 public function getTitle() {
873 return $this->title;
874 }
875
876 /**
877 * Gets the charSet
878 *
879 * @return string $charSet
880 */
881 public function getCharSet() {
882 return $this->charSet;
883 }
884
885 /**
886 * Gets the language
887 *
888 * @return string $lang
889 */
890 public function getLanguage() {
891 return $this->lang;
892 }
893
894 /**
895 * Returns rendering mode XHTML or HTML
896 *
897 * @return bool TRUE if XHTML, FALSE if HTML
898 */
899 public function getRenderXhtml() {
900 return $this->renderXhtml;
901 }
902
903 /**
904 * Gets html tag
905 *
906 * @return string $htmlTag Html tag
907 */
908 public function getHtmlTag() {
909 return $this->htmlTag;
910 }
911
912 /**
913 * Get meta charset
914 *
915 * @return string
916 */
917 public function getMetaCharsetTag() {
918 return $this->metaCharsetTag;
919 }
920
921 /**
922 * Gets head tag
923 *
924 * @return string $tag Head tag
925 */
926 public function getHeadTag() {
927 return $this->headTag;
928 }
929
930 /**
931 * Gets favicon
932 *
933 * @return string $favIcon
934 */
935 public function getFavIcon() {
936 return $this->favIcon;
937 }
938
939 /**
940 * Gets icon mime type
941 *
942 * @return string $iconMimeType
943 */
944 public function getIconMimeType() {
945 return $this->iconMimeType;
946 }
947
948 /**
949 * Gets HTML base URL
950 *
951 * @return string $url
952 */
953 public function getBaseUrl() {
954 return $this->baseUrl;
955 }
956
957 /**
958 * Gets template file
959 *
960 * @return string
961 */
962 public function getTemplateFile() {
963 return $this->templateFile;
964 }
965
966 /**
967 * Gets MoveJsFromHeaderToFooter
968 *
969 * @return bool
970 */
971 public function getMoveJsFromHeaderToFooter() {
972 return $this->moveJsFromHeaderToFooter;
973 }
974
975 /**
976 * Gets compress of javascript
977 *
978 * @return bool
979 */
980 public function getCompressJavascript() {
981 return $this->compressJavascript;
982 }
983
984 /**
985 * Gets compress of css
986 *
987 * @return bool
988 */
989 public function getCompressCss() {
990 return $this->compressCss;
991 }
992
993 /**
994 * Gets concatenate of js and css files
995 *
996 * @return bool
997 */
998 public function getConcatenateFiles() {
999 return $this->concatenateFiles;
1000 }
1001
1002 /**
1003 * Gets concatenate of js files
1004 *
1005 * @return bool
1006 */
1007 public function getConcatenateJavascript() {
1008 return $this->concatenateJavascript;
1009 }
1010
1011 /**
1012 * Gets concatenate of css files
1013 *
1014 * @return bool
1015 */
1016 public function getConcatenateCss() {
1017 return $this->concatenateCss;
1018 }
1019
1020 /**
1021 * Gets remove of empty lines from template
1022 *
1023 * @return bool
1024 */
1025 public function getRemoveLineBreaksFromTemplate() {
1026 return $this->removeLineBreaksFromTemplate;
1027 }
1028
1029 /**
1030 * Gets content for body
1031 *
1032 * @return string
1033 */
1034 public function getBodyContent() {
1035 return $this->bodyContent;
1036 }
1037
1038 /**
1039 * Gets Path for prototype library (relative to typo3 directory)
1040 *
1041 * @return string
1042 */
1043 public function getPrototypePath() {
1044 return $this->prototypePath;
1045 }
1046
1047 /**
1048 * Gets Path for scriptaculous library (relative to typo3 directory)
1049 *
1050 * @return string
1051 */
1052 public function getScriptaculousPath() {
1053 return $this->scriptaculousPath;
1054 }
1055
1056 /**
1057 * Gets Path for Ext Core library (relative to typo3 directory)
1058 *
1059 * @return string
1060 */
1061 public function getExtCorePath() {
1062 return $this->extCorePath;
1063 }
1064
1065 /**
1066 * Gets Path for ExtJs library (relative to typo3 directory)
1067 *
1068 * @return string
1069 */
1070 public function getExtJsPath() {
1071 return $this->extJsPath;
1072 }
1073
1074 /**
1075 * Gets the inline language labels.
1076 *
1077 * @return array The inline language labels
1078 */
1079 public function getInlineLanguageLabels() {
1080 return $this->inlineLanguageLabels;
1081 }
1082
1083 /**
1084 * Gets the inline language files
1085 *
1086 * @return array
1087 */
1088 public function getInlineLanguageLabelFiles() {
1089 return $this->inlineLanguageLabelFiles;
1090 }
1091
1092 /*****************************************************/
1093 /* */
1094 /* Public Functions to add Data */
1095 /* */
1096 /* */
1097 /*****************************************************/
1098 /**
1099 * Adds meta data
1100 *
1101 * @param string $meta Meta data (complete metatag)
1102 * @return void
1103 */
1104 public function addMetaTag($meta) {
1105 if (!in_array($meta, $this->metaTags)) {
1106 $this->metaTags[] = $meta;
1107 }
1108 }
1109
1110 /**
1111 * Adds inline HTML comment
1112 *
1113 * @param string $comment
1114 * @return void
1115 */
1116 public function addInlineComment($comment) {
1117 if (!in_array($comment, $this->inlineComments)) {
1118 $this->inlineComments[] = $comment;
1119 }
1120 }
1121
1122 /**
1123 * Adds header data
1124 *
1125 * @param string $data Free header data for HTML header
1126 * @return void
1127 */
1128 public function addHeaderData($data) {
1129 if (!in_array($data, $this->headerData)) {
1130 $this->headerData[] = $data;
1131 }
1132 }
1133
1134 /**
1135 * Adds footer data
1136 *
1137 * @param string $data Free header data for HTML header
1138 * @return void
1139 */
1140 public function addFooterData($data) {
1141 if (!in_array($data, $this->footerData)) {
1142 $this->footerData[] = $data;
1143 }
1144 }
1145
1146 /**
1147 * Adds JS Library. JS Library block is rendered on top of the JS files.
1148 *
1149 * @param string $name Arbitrary identifier
1150 * @param string $file File name
1151 * @param string $type Content Type
1152 * @param bool $compress Flag if library should be compressed
1153 * @param bool $forceOnTop Flag if added library should be inserted at begin of this block
1154 * @param string $allWrap
1155 * @param bool $excludeFromConcatenation
1156 * @param string $splitChar The char used to split the allWrap value, default is "|"
1157 * @param bool $async Flag if property 'async="async"' should be added to JavaScript tags
1158 * @return void
1159 */
1160 public function addJsLibrary($name, $file, $type = 'text/javascript', $compress = FALSE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|', $async = FALSE) {
1161 if (!$type) {
1162 $type = 'text/javascript';
1163 }
1164 if (!in_array(strtolower($name), $this->jsLibs)) {
1165 $this->jsLibs[strtolower($name)] = array(
1166 'file' => $file,
1167 'type' => $type,
1168 'section' => self::PART_HEADER,
1169 'compress' => $compress,
1170 'forceOnTop' => $forceOnTop,
1171 'allWrap' => $allWrap,
1172 'excludeFromConcatenation' => $excludeFromConcatenation,
1173 'splitChar' => $splitChar,
1174 'async' => $async
1175 );
1176 }
1177 }
1178
1179 /**
1180 * Adds JS Library to Footer. JS Library block is rendered on top of the Footer JS files.
1181 *
1182 * @param string $name Arbitrary identifier
1183 * @param string $file File name
1184 * @param string $type Content Type
1185 * @param bool $compress Flag if library should be compressed
1186 * @param bool $forceOnTop Flag if added library should be inserted at begin of this block
1187 * @param string $allWrap
1188 * @param bool $excludeFromConcatenation
1189 * @param string $splitChar The char used to split the allWrap value, default is "|"
1190 * @param bool $async Flag if property 'async="async"' should be added to JavaScript tags
1191 * @return void
1192 */
1193 public function addJsFooterLibrary($name, $file, $type = 'text/javascript', $compress = FALSE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|', $async = FALSE) {
1194 if (!$type) {
1195 $type = 'text/javascript';
1196 }
1197 if (!in_array(strtolower($name), $this->jsLibs)) {
1198 $this->jsLibs[strtolower($name)] = array(
1199 'file' => $file,
1200 'type' => $type,
1201 'section' => self::PART_FOOTER,
1202 'compress' => $compress,
1203 'forceOnTop' => $forceOnTop,
1204 'allWrap' => $allWrap,
1205 'excludeFromConcatenation' => $excludeFromConcatenation,
1206 'splitChar' => $splitChar,
1207 'async' => $async
1208 );
1209 }
1210 }
1211
1212 /**
1213 * Adds JS file
1214 *
1215 * @param string $file File name
1216 * @param string $type Content Type
1217 * @param bool $compress
1218 * @param bool $forceOnTop
1219 * @param string $allWrap
1220 * @param bool $excludeFromConcatenation
1221 * @param string $splitChar The char used to split the allWrap value, default is "|"
1222 * @param bool $async Flag if property 'async="async"' should be added to JavaScript tags
1223 * @return void
1224 */
1225 public function addJsFile($file, $type = 'text/javascript', $compress = TRUE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|', $async = FALSE) {
1226 if (!$type) {
1227 $type = 'text/javascript';
1228 }
1229 if (!isset($this->jsFiles[$file])) {
1230 if (strpos($file, 'ajax.php?') !== FALSE) {
1231 $compress = FALSE;
1232 }
1233 $this->jsFiles[$file] = array(
1234 'file' => $file,
1235 'type' => $type,
1236 'section' => self::PART_HEADER,
1237 'compress' => $compress,
1238 'forceOnTop' => $forceOnTop,
1239 'allWrap' => $allWrap,
1240 'excludeFromConcatenation' => $excludeFromConcatenation,
1241 'splitChar' => $splitChar,
1242 'async' => $async
1243 );
1244 }
1245 }
1246
1247 /**
1248 * Adds JS file to footer
1249 *
1250 * @param string $file File name
1251 * @param string $type Content Type
1252 * @param bool $compress
1253 * @param bool $forceOnTop
1254 * @param string $allWrap
1255 * @param bool $excludeFromConcatenation
1256 * @param string $splitChar The char used to split the allWrap value, default is "|"
1257 * @param bool $async Flag if property 'async="async"' should be added to JavaScript tags
1258 * @return void
1259 */
1260 public function addJsFooterFile($file, $type = 'text/javascript', $compress = TRUE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|', $async = FALSE) {
1261 if (!$type) {
1262 $type = 'text/javascript';
1263 }
1264 if (!isset($this->jsFiles[$file])) {
1265 if (strpos($file, 'ajax.php?') !== FALSE) {
1266 $compress = FALSE;
1267 }
1268 $this->jsFiles[$file] = array(
1269 'file' => $file,
1270 'type' => $type,
1271 'section' => self::PART_FOOTER,
1272 'compress' => $compress,
1273 'forceOnTop' => $forceOnTop,
1274 'allWrap' => $allWrap,
1275 'excludeFromConcatenation' => $excludeFromConcatenation,
1276 'splitChar' => $splitChar,
1277 'async' => $async
1278 );
1279 }
1280 }
1281
1282 /**
1283 * Adds JS inline code
1284 *
1285 * @param string $name
1286 * @param string $block
1287 * @param bool $compress
1288 * @param bool $forceOnTop
1289 * @return void
1290 */
1291 public function addJsInlineCode($name, $block, $compress = TRUE, $forceOnTop = FALSE) {
1292 if (!isset($this->jsInline[$name]) && !empty($block)) {
1293 $this->jsInline[$name] = array(
1294 'code' => $block . LF,
1295 'section' => self::PART_HEADER,
1296 'compress' => $compress,
1297 'forceOnTop' => $forceOnTop
1298 );
1299 }
1300 }
1301
1302 /**
1303 * Adds JS inline code to footer
1304 *
1305 * @param string $name
1306 * @param string $block
1307 * @param bool $compress
1308 * @param bool $forceOnTop
1309 * @return void
1310 */
1311 public function addJsFooterInlineCode($name, $block, $compress = TRUE, $forceOnTop = FALSE) {
1312 if (!isset($this->jsInline[$name]) && !empty($block)) {
1313 $this->jsInline[$name] = array(
1314 'code' => $block . LF,
1315 'section' => self::PART_FOOTER,
1316 'compress' => $compress,
1317 'forceOnTop' => $forceOnTop
1318 );
1319 }
1320 }
1321
1322 /**
1323 * Adds Ext.onready code, which will be wrapped in Ext.onReady(function() {...});
1324 *
1325 * @param string $block Javascript code
1326 * @param bool $forceOnTop Position of the javascript code (TRUE for putting it on top, default is FALSE = bottom)
1327 * @return void
1328 */
1329 public function addExtOnReadyCode($block, $forceOnTop = FALSE) {
1330 if (!in_array($block, $this->extOnReadyCode)) {
1331 if ($forceOnTop) {
1332 array_unshift($this->extOnReadyCode, $block);
1333 } else {
1334 $this->extOnReadyCode[] = $block;
1335 }
1336 }
1337 }
1338
1339 /**
1340 * Adds the ExtDirect code
1341 *
1342 * @param array $filterNamespaces Limit the output to defined namespaces. If empty, all namespaces are generated
1343 * @return void
1344 */
1345 public function addExtDirectCode(array $filterNamespaces = array()) {
1346 if ($this->extDirectCodeAdded) {
1347 return;
1348 }
1349 $this->extDirectCodeAdded = TRUE;
1350 if (count($filterNamespaces) === 0) {
1351 $filterNamespaces = array('TYPO3');
1352 }
1353 // @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8
1354 // add compatibility mapping for the old flashmessage API
1355 $this->addJsFile(GeneralUtility::resolveBackPath($this->backPath .
1356 'sysext/backend/Resources/Public/JavaScript/flashmessage_compatibility.js'));
1357
1358 // Add language labels for ExtDirect
1359 if (TYPO3_MODE === 'FE') {
1360 $this->addInlineLanguageLabelArray(array(
1361 'extDirect_timeoutHeader' => $GLOBALS['TSFE']->sL('LLL:EXT:lang/locallang_misc.xlf:extDirect_timeoutHeader'),
1362 'extDirect_timeoutMessage' => $GLOBALS['TSFE']->sL('LLL:EXT:lang/locallang_misc.xlf:extDirect_timeoutMessage')
1363 ));
1364 } else {
1365 $this->addInlineLanguageLabelArray(array(
1366 'extDirect_timeoutHeader' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:extDirect_timeoutHeader'),
1367 'extDirect_timeoutMessage' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:extDirect_timeoutMessage')
1368 ));
1369 }
1370 $token = ($api = '');
1371 if (TYPO3_MODE === 'BE') {
1372 $formprotection = \TYPO3\CMS\Core\FormProtection\FormProtectionFactory::get();
1373 $token = $formprotection->generateToken('extDirect');
1374 }
1375 /** @var $extDirect \TYPO3\CMS\Core\ExtDirect\ExtDirectApi */
1376 $extDirect = GeneralUtility::makeInstance(\TYPO3\CMS\Core\ExtDirect\ExtDirectApi::class);
1377 $api = $extDirect->getApiPhp($filterNamespaces);
1378 if ($api) {
1379 $this->addJsInlineCode('TYPO3ExtDirectAPI', $api, FALSE);
1380 }
1381 // Note: we need to iterate thru the object, because the addProvider method
1382 // does this only with multiple arguments
1383 $this->addExtOnReadyCode('
1384 (function() {
1385 TYPO3.ExtDirectToken = "' . $token . '";
1386 for (var api in Ext.app.ExtDirectAPI) {
1387 var provider = Ext.Direct.addProvider(Ext.app.ExtDirectAPI[api]);
1388 provider.on("beforecall", function(provider, transaction, meta) {
1389 if (transaction.data) {
1390 transaction.data[transaction.data.length] = TYPO3.ExtDirectToken;
1391 } else {
1392 transaction.data = [TYPO3.ExtDirectToken];
1393 }
1394 });
1395
1396 provider.on("call", function(provider, transaction, meta) {
1397 if (transaction.isForm) {
1398 transaction.params.securityToken = TYPO3.ExtDirectToken;
1399 }
1400 });
1401 }
1402 })();
1403
1404 var extDirectDebug = function(message, header, group) {
1405 var TYPO3ViewportInstance = null;
1406
1407 if (top && top.TYPO3 && typeof top.TYPO3.Backend === "object") {
1408 TYPO3ViewportInstance = top.TYPO3.Backend;
1409 } else if (typeof TYPO3 === "object" && typeof TYPO3.Backend === "object") {
1410 TYPO3ViewportInstance = TYPO3.Backend;
1411 }
1412
1413 if (TYPO3ViewportInstance !== null) {
1414 TYPO3ViewportInstance.DebugConsole.addTab(message, header, group);
1415 } else if (typeof console === "object") {
1416 console.log(message);
1417 } else {
1418 document.write(message);
1419 }
1420 };
1421
1422 Ext.Direct.on("exception", function(event) {
1423 if (event.code === Ext.Direct.exceptions.TRANSPORT && !event.where) {
1424 top.TYPO3.Flashmessage.display(
1425 top.TYPO3.Severity.error,
1426 TYPO3.l10n.localize("extDirect_timeoutHeader"),
1427 TYPO3.l10n.localize("extDirect_timeoutMessage"),
1428 30
1429 );
1430 } else {
1431 var backtrace = "";
1432 if (event.code === "parse") {
1433 extDirectDebug(
1434 "<p>" + event.xhr.responseText + "<\\/p>",
1435 event.type,
1436 "ExtDirect - Exception"
1437 );
1438 } else if (event.code === "router") {
1439 top.TYPO3.Flashmessage.display(
1440 top.TYPO3.Severity.error,
1441 event.code,
1442 event.message,
1443 30
1444 );
1445 } else if (event.where) {
1446 backtrace = "<p style=\\"margin-top: 20px;\\">" +
1447 "<strong>Backtrace:<\\/strong><br \\/>" +
1448 event.where.replace(/#/g, "<br \\/>#") +
1449 "<\\/p>";
1450 extDirectDebug(
1451 "<p>" + event.message + "<\\/p>" + backtrace,
1452 event.method,
1453 "ExtDirect - Exception"
1454 );
1455 }
1456
1457
1458 }
1459 });
1460
1461 Ext.Direct.on("event", function(event, provider) {
1462 if (typeof event.debug !== "undefined" && event.debug !== "") {
1463 extDirectDebug(event.debug, event.method, "ExtDirect - Debug");
1464 }
1465 });
1466 ', TRUE);
1467 }
1468
1469 /**
1470 * Adds CSS file
1471 *
1472 * @param string $file
1473 * @param string $rel
1474 * @param string $media
1475 * @param string $title
1476 * @param bool $compress
1477 * @param bool $forceOnTop
1478 * @param string $allWrap
1479 * @param bool $excludeFromConcatenation
1480 * @param string $splitChar The char used to split the allWrap value, default is "|"
1481 * @return void
1482 */
1483 public function addCssFile($file, $rel = 'stylesheet', $media = 'all', $title = '', $compress = TRUE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|') {
1484 if (!isset($this->cssFiles[$file])) {
1485 $this->cssFiles[$file] = array(
1486 'file' => $file,
1487 'rel' => $rel,
1488 'media' => $media,
1489 'title' => $title,
1490 'compress' => $compress,
1491 'forceOnTop' => $forceOnTop,
1492 'allWrap' => $allWrap,
1493 'excludeFromConcatenation' => $excludeFromConcatenation,
1494 'splitChar' => $splitChar
1495 );
1496 }
1497 }
1498
1499 /**
1500 * Adds CSS file
1501 *
1502 * @param string $file
1503 * @param string $rel
1504 * @param string $media
1505 * @param string $title
1506 * @param bool $compress
1507 * @param bool $forceOnTop
1508 * @param string $allWrap
1509 * @param bool $excludeFromConcatenation
1510 * @param string $splitChar The char used to split the allWrap value, default is "|"
1511 * @return void
1512 */
1513 public function addCssLibrary($file, $rel = 'stylesheet', $media = 'all', $title = '', $compress = TRUE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|') {
1514 if (!isset($this->cssLibs[$file])) {
1515 $this->cssLibs[$file] = array(
1516 'file' => $file,
1517 'rel' => $rel,
1518 'media' => $media,
1519 'title' => $title,
1520 'compress' => $compress,
1521 'forceOnTop' => $forceOnTop,
1522 'allWrap' => $allWrap,
1523 'excludeFromConcatenation' => $excludeFromConcatenation,
1524 'splitChar' => $splitChar
1525 );
1526 }
1527 }
1528
1529 /**
1530 * Adds CSS inline code
1531 *
1532 * @param string $name
1533 * @param string $block
1534 * @param bool $compress
1535 * @param bool $forceOnTop
1536 * @return void
1537 */
1538 public function addCssInlineBlock($name, $block, $compress = FALSE, $forceOnTop = FALSE) {
1539 if (!isset($this->cssInline[$name]) && !empty($block)) {
1540 $this->cssInline[$name] = array(
1541 'code' => $block,
1542 'compress' => $compress,
1543 'forceOnTop' => $forceOnTop
1544 );
1545 }
1546 }
1547
1548 /**
1549 * Call this function if you need to include the jQuery library
1550 *
1551 * @param null|string $version The jQuery version that should be included, either "latest" or any available version
1552 * @param null|string $source The location of the jQuery source, can be "local", "google", "msn", "jquery" or just an URL to your jQuery lib
1553 * @param string $namespace The namespace in which the jQuery object of the specific version should be stored.
1554 * @return void
1555 * @throws \UnexpectedValueException
1556 */
1557 public function loadJquery($version = NULL, $source = NULL, $namespace = self::JQUERY_NAMESPACE_DEFAULT) {
1558 // Set it to the version that is shipped with the TYPO3 core
1559 if ($version === NULL || $version === 'latest') {
1560 $version = self::JQUERY_VERSION_LATEST;
1561 }
1562 // Check if the source is set, otherwise set it to "default"
1563 if ($source === NULL) {
1564 $source = 'local';
1565 }
1566 if ($source === 'local' && !in_array($version, $this->availableLocalJqueryVersions)) {
1567 throw new \UnexpectedValueException('The requested jQuery version is not available in the local filesystem.', 1341505305);
1568 }
1569 if (!preg_match('/^[a-zA-Z0-9]+$/', $namespace)) {
1570 throw new \UnexpectedValueException('The requested namespace contains non alphanumeric characters.', 1341571604);
1571 }
1572 $this->jQueryVersions[$namespace] = array(
1573 'version' => $version,
1574 'source' => $source
1575 );
1576 }
1577
1578 /**
1579 * Call function if you need the requireJS library
1580 * this automatically adds the JavaScript path of all loaded extensions in the requireJS path option
1581 * so it resolves names like TYPO3/CMS/MyExtension/MyJsFile to EXT:MyExtension/Resources/Public/JavaScript/MyJsFile.js
1582 * when using requireJS
1583 *
1584 * @return void
1585 */
1586 public function loadRequireJs() {
1587
1588 // load all paths to map to package names / namespaces
1589 if (count($this->requireJsConfig) === 0) {
1590 // first, load all paths for the namespaces, and configure contrib libs.
1591 $this->requireJsConfig['paths'] = array(
1592 'jquery-ui' => $this->backPath . 'contrib/jquery-ui',
1593 'jquery' => $this->backPath . 'contrib/jquery',
1594 'datatables' => $this->backPath . 'contrib/jquery/jquery.dataTables.min',
1595 'nprogress' => $this->backPath . 'contrib/nprogress/nprogress',
1596 'moment' => $this->backPath . 'sysext/core/Resources/Public/JavaScript/Contrib/moment/moment',
1597 'twbs' => $this->backPath . 'contrib/twbs/bootstrap.min',
1598 'twbs/bootstrap-datetimepicker' => $this->backPath . 'contrib/twbs/bootstrap-datetimepicker.min',
1599 );
1600 // get all extensions that are loaded
1601 $loadedExtensions = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getLoadedExtensionListArray();
1602 foreach ($loadedExtensions as $packageName) {
1603 $fullJsPath = 'EXT:' . $packageName . '/Resources/Public/JavaScript/';
1604 $fullJsPath = GeneralUtility::getFileAbsFileName($fullJsPath);
1605 $fullJsPath = \TYPO3\CMS\Core\Utility\PathUtility::getRelativePath(PATH_typo3, $fullJsPath);
1606 $fullJsPath = rtrim($fullJsPath, '/');
1607 if ($fullJsPath) {
1608 $this->requireJsConfig['paths']['TYPO3/CMS/' . GeneralUtility::underscoredToUpperCamelCase($packageName)] = $this->backPath . $fullJsPath;
1609 }
1610 }
1611
1612 // check if additional AMD modules need to be loaded if a single AMD module is initialized
1613 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['RequireJS']['postInitializationModules'])) {
1614 $this->addInlineSettingArray('RequireJS.PostInitializationModules', $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['RequireJS']['postInitializationModules']);
1615 }
1616 }
1617
1618 $this->addRequireJs = TRUE;
1619 }
1620
1621 /**
1622 * Add additional configuration to require js.
1623 *
1624 * Configuration will be merged recursive with overrule.
1625 *
1626 * To add another path mapping deliver the following configuration:
1627 * 'paths' => array(
1628 * 'EXTERN/mybootstrapjs' => 'contrib/twbs/bootstrap.min',
1629 * ),
1630 *
1631 * @author Daniel Siepmann <daniel.siepmann@typo3.org>
1632 *
1633 * @param array $configuration The configuration that will be merged with existing one.
1634 * @return void
1635 */
1636 public function addRequireJsConfiguration(array $configuration) {
1637 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($this->requireJsConfig, $configuration);
1638 }
1639
1640 /**
1641 * includes a AMD-compatible JS file by resolving the ModuleName, and then requires the file via a requireJS request,
1642 * additionally allowing to execute JavaScript code afterwards
1643 *
1644 * this function only works for AMD-ready JS modules, used like "define('TYPO3/CMS/Backend/FormEngine..."
1645 * in the JS file
1646 *
1647 * TYPO3/CMS/Backend/FormEngine =>
1648 * "TYPO3": Vendor Name
1649 * "CMS": Product Name
1650 * "Backend": Extension Name
1651 * "FormEngine": FileName in the Resources/Public/JavaScript folder
1652 *
1653 * @param string $mainModuleName Must be in the form of "TYPO3/CMS/PackageName/ModuleName" e.g. "TYPO3/CMS/Backend/FormEngine"
1654 * @param string $callBackFunction loaded right after the requireJS loading, must be wrapped in function() {}
1655 * @return void
1656 */
1657 public function loadRequireJsModule($mainModuleName, $callBackFunction = NULL) {
1658 $inlineCodeKey = $mainModuleName;
1659 // make sure requireJS is initialized
1660 $this->loadRequireJs();
1661
1662 // execute the main module, and load a possible callback function
1663 $javaScriptCode = 'require(["' . $mainModuleName . '"]';
1664 if ($callBackFunction !== NULL) {
1665 $inlineCodeKey .= sha1($callBackFunction);
1666 $javaScriptCode .= ', ' . $callBackFunction;
1667 }
1668 $javaScriptCode .= ');';
1669 $this->addJsInlineCode('RequireJS-Module-' . $inlineCodeKey, $javaScriptCode);
1670 }
1671
1672 /**
1673 * Call function if you need the prototype library
1674 *
1675 * @return void
1676 */
1677 public function loadPrototype() {
1678 $this->addPrototype = TRUE;
1679 }
1680
1681 /**
1682 * Call function if you need the Scriptaculous library
1683 *
1684 * @param string $modules Add modules you need. use "all" if you need complete modules
1685 * @return void
1686 */
1687 public function loadScriptaculous($modules = 'all') {
1688 // Scriptaculous require prototype, so load prototype too.
1689 $this->addPrototype = TRUE;
1690 $this->addScriptaculous = TRUE;
1691 if ($modules) {
1692 if ($modules == 'all') {
1693 foreach ($this->addScriptaculousModules as $key => $value) {
1694 $this->addScriptaculousModules[$key] = TRUE;
1695 }
1696 } else {
1697 $mods = GeneralUtility::trimExplode(',', $modules);
1698 foreach ($mods as $mod) {
1699 if (isset($this->addScriptaculousModules[strtolower($mod)])) {
1700 $this->addScriptaculousModules[strtolower($mod)] = TRUE;
1701 }
1702 }
1703 }
1704 }
1705 }
1706
1707 /**
1708 * call this function if you need the extJS library
1709 *
1710 * @param bool $css Flag, if set the ext-css will be loaded
1711 * @param bool $theme Flag, if set the ext-theme "grey" will be loaded
1712 * @param string $adapter Choose alternative adapter, possible values: yui, prototype, jquery
1713 * @return void
1714 */
1715 public function loadExtJS($css = TRUE, $theme = TRUE, $adapter = '') {
1716 if ($adapter) {
1717 // Empty $adapter will always load the ext adapter
1718 switch (GeneralUtility::strtolower(trim($adapter))) {
1719 case self::EXTJS_ADAPTER_YUI:
1720 $this->extJSadapter = 'yui/ext-yui-adapter.js';
1721 break;
1722 case self::EXTJS_ADAPTER_PROTOTYPE:
1723 $this->extJSadapter = 'prototype/ext-prototype-adapter.js';
1724 break;
1725 case self::EXTJS_ADAPTER_JQUERY:
1726 $this->extJSadapter = 'jquery/ext-jquery-adapter.js';
1727 break;
1728 }
1729 }
1730 $this->addExtJS = TRUE;
1731 $this->extJStheme = $theme;
1732 $this->extJScss = $css;
1733 }
1734
1735 /**
1736 * Enables ExtJs QuickTips
1737 * Need extJs loaded
1738 *
1739 * @return void
1740 */
1741 public function enableExtJSQuickTips() {
1742 $this->enableExtJSQuickTips = TRUE;
1743 }
1744
1745 /**
1746 * Call function if you need the ExtCore library
1747 *
1748 * @return void
1749 */
1750 public function loadExtCore() {
1751 $this->addExtCore = TRUE;
1752 }
1753
1754 /**
1755 * Call this function to load debug version of ExtJS. Use this for development only
1756 *
1757 * @return void
1758 */
1759 public function enableExtJsDebug() {
1760 $this->enableExtJsDebug = TRUE;
1761 }
1762
1763 /**
1764 * Call this function to load debug version of ExtCore. Use this for development only
1765 *
1766 * @return void
1767 */
1768 public function enableExtCoreDebug() {
1769 $this->enableExtCoreDebug = TRUE;
1770 }
1771
1772 /**
1773 * Adds Javascript Inline Label. This will occur in TYPO3.lang - object
1774 * The label can be used in scripts with TYPO3.lang.<key>
1775 * Need extJs loaded
1776 *
1777 * @param string $key
1778 * @param string $value
1779 * @return void
1780 */
1781 public function addInlineLanguageLabel($key, $value) {
1782 $this->inlineLanguageLabels[$key] = $value;
1783 }
1784
1785 /**
1786 * Adds Javascript Inline Label Array. This will occur in TYPO3.lang - object
1787 * The label can be used in scripts with TYPO3.lang.<key>
1788 * Array will be merged with existing array.
1789 * Need extJs loaded
1790 *
1791 * @param array $array
1792 * @return void
1793 */
1794 public function addInlineLanguageLabelArray(array $array) {
1795 $this->inlineLanguageLabels = array_merge($this->inlineLanguageLabels, $array);
1796 }
1797
1798 /**
1799 * Gets labels to be used in JavaScript fetched from a locallang file.
1800 *
1801 * @param string $fileRef Input is a file-reference (see GeneralUtility::getFileAbsFileName). That file is expected to be a 'locallang.xlf' file containing a valid XML TYPO3 language structure.
1802 * @param string $selectionPrefix Prefix to select the correct labels (default: '')
1803 * @param string $stripFromSelectionName Sub-prefix to be removed from label names in the result (default: '')
1804 * @param int $errorMode Error mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception
1805 * @return void
1806 */
1807 public function addInlineLanguageLabelFile($fileRef, $selectionPrefix = '', $stripFromSelectionName = '', $errorMode = 0) {
1808 $index = md5($fileRef . $selectionPrefix . $stripFromSelectionName);
1809 if ($fileRef && !isset($this->inlineLanguageLabelFiles[$index])) {
1810 $this->inlineLanguageLabelFiles[$index] = array(
1811 'fileRef' => $fileRef,
1812 'selectionPrefix' => $selectionPrefix,
1813 'stripFromSelectionName' => $stripFromSelectionName,
1814 'errorMode' => $errorMode
1815 );
1816 }
1817 }
1818
1819 /**
1820 * Adds Javascript Inline Setting. This will occur in TYPO3.settings - object
1821 * The label can be used in scripts with TYPO3.setting.<key>
1822 * Need extJs loaded
1823 *
1824 * @param string $namespace
1825 * @param string $key
1826 * @param string $value
1827 * @return void
1828 */
1829 public function addInlineSetting($namespace, $key, $value) {
1830 if ($namespace) {
1831 if (strpos($namespace, '.')) {
1832 $parts = explode('.', $namespace);
1833 $a = &$this->inlineSettings;
1834 foreach ($parts as $part) {
1835 $a = &$a[$part];
1836 }
1837 $a[$key] = $value;
1838 } else {
1839 $this->inlineSettings[$namespace][$key] = $value;
1840 }
1841 } else {
1842 $this->inlineSettings[$key] = $value;
1843 }
1844 }
1845
1846 /**
1847 * Adds Javascript Inline Setting. This will occur in TYPO3.settings - object
1848 * The label can be used in scripts with TYPO3.setting.<key>
1849 * Array will be merged with existing array.
1850 * Need extJs loaded
1851 *
1852 * @param string $namespace
1853 * @param array $array
1854 * @return void
1855 */
1856 public function addInlineSettingArray($namespace, array $array) {
1857 if ($namespace) {
1858 if (strpos($namespace, '.')) {
1859 $parts = explode('.', $namespace);
1860 $a = &$this->inlineSettings;
1861 foreach ($parts as $part) {
1862 $a = &$a[$part];
1863 }
1864 $a = array_merge((array)$a, $array);
1865 } else {
1866 $this->inlineSettings[$namespace] = array_merge((array)$this->inlineSettings[$namespace], $array);
1867 }
1868 } else {
1869 $this->inlineSettings = array_merge($this->inlineSettings, $array);
1870 }
1871 }
1872
1873 /**
1874 * Adds content to body content
1875 *
1876 * @param string $content
1877 * @return void
1878 */
1879 public function addBodyContent($content) {
1880 $this->bodyContent .= $content;
1881 }
1882
1883 /*****************************************************/
1884 /* */
1885 /* Render Functions */
1886 /* */
1887 /*****************************************************/
1888 /**
1889 * Render the section (Header or Footer)
1890 *
1891 * @param int $part Section which should be rendered: self::PART_COMPLETE, self::PART_HEADER or self::PART_FOOTER
1892 * @return string Content of rendered section
1893 */
1894 public function render($part = self::PART_COMPLETE) {
1895 $this->prepareRendering();
1896 list($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs) = $this->renderJavaScriptAndCss();
1897 $metaTags = implode(LF, $this->metaTags);
1898 $markerArray = $this->getPreparedMarkerArray($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs, $metaTags);
1899 $template = $this->getTemplateForPart($part);
1900
1901 // The page renderer needs a full reset, even when only rendering one part of the page
1902 // This means that you can only register footer files *after* the header has been already rendered.
1903 // In case you render the footer part first, header files can only be added *after* the footer has been rendered
1904 $this->reset();
1905 return trim(\TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerArray($template, $markerArray, '###|###'));
1906 }
1907
1908 /**
1909 * Render the page but not the JavaScript and CSS Files
1910 *
1911 * @param string $substituteHash The hash that is used for the placehoder markers
1912 * @access private
1913 * @return string Content of rendered section
1914 */
1915 public function renderPageWithUncachedObjects($substituteHash) {
1916 $this->prepareRendering();
1917 $markerArray = $this->getPreparedMarkerArrayForPageWithUncachedObjects($substituteHash);
1918 $template = $this->getTemplateForPart(self::PART_COMPLETE);
1919 return trim(\TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerArray($template, $markerArray, '###|###'));
1920 }
1921
1922 /**
1923 * Renders the JavaScript and CSS files that have been added during processing
1924 * of uncached content objects (USER_INT, COA_INT)
1925 *
1926 * @param string $cachedPageContent
1927 * @param string $substituteHash The hash that is used for the placehoder markers
1928 * @access private
1929 * @return string
1930 */
1931 public function renderJavaScriptAndCssForProcessingOfUncachedContentObjects($cachedPageContent, $substituteHash) {
1932 $this->prepareRendering();
1933 list($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs) = $this->renderJavaScriptAndCss();
1934 $title = $this->title ? str_replace('|', htmlspecialchars($this->title), $this->titleTag) : '';
1935 $markerArray = array(
1936 '<!-- ###TITLE' . $substituteHash . '### -->' => $title,
1937 '<!-- ###CSS_LIBS' . $substituteHash . '### -->' => $cssLibs,
1938 '<!-- ###CSS_INCLUDE' . $substituteHash . '### -->' => $cssFiles,
1939 '<!-- ###CSS_INLINE' . $substituteHash . '### -->' => $cssInline,
1940 '<!-- ###JS_INLINE' . $substituteHash . '### -->' => $jsInline,
1941 '<!-- ###JS_INCLUDE' . $substituteHash . '### -->' => $jsFiles,
1942 '<!-- ###JS_LIBS' . $substituteHash . '### -->' => $jsLibs,
1943 '<!-- ###HEADERDATA' . $substituteHash . '### -->' => implode(LF, $this->headerData),
1944 '<!-- ###FOOTERDATA' . $substituteHash . '### -->' => implode(LF, $this->footerData),
1945 '<!-- ###JS_LIBS_FOOTER' . $substituteHash . '### -->' => $jsFooterLibs,
1946 '<!-- ###JS_INCLUDE_FOOTER' . $substituteHash . '### -->' => $jsFooterFiles,
1947 '<!-- ###JS_INLINE_FOOTER' . $substituteHash . '### -->' => $jsFooterInline
1948 );
1949 foreach ($markerArray as $placeHolder => $content) {
1950 $cachedPageContent = str_replace($placeHolder, $content, $cachedPageContent);
1951 }
1952 $this->reset();
1953 return $cachedPageContent;
1954 }
1955
1956 /**
1957 * Remove ending slashes from static header block
1958 * if the page is beeing rendered as html (not xhtml)
1959 * and define property $this->endingSlash for further use
1960 *
1961 * @return void
1962 */
1963 protected function prepareRendering() {
1964 if ($this->getRenderXhtml()) {
1965 $this->endingSlash = ' /';
1966 } else {
1967 $this->metaCharsetTag = str_replace(' />', '>', $this->metaCharsetTag);
1968 $this->baseUrlTag = str_replace(' />', '>', $this->baseUrlTag);
1969 $this->shortcutTag = str_replace(' />', '>', $this->shortcutTag);
1970 $this->endingSlash = '';
1971 }
1972 }
1973
1974 /**
1975 * Renders all JavaScript and CSS
1976 *
1977 * @return array<string>
1978 */
1979 protected function renderJavaScriptAndCss() {
1980 $this->executePreRenderHook();
1981 $mainJsLibs = $this->renderMainJavaScriptLibraries();
1982 if ($this->concatenateFiles || $this->concatenateJavascript || $this->concatenateCss) {
1983 // Do the file concatenation
1984 $this->doConcatenate();
1985 }
1986 if ($this->compressCss || $this->compressJavascript) {
1987 // Do the file compression
1988 $this->doCompress();
1989 }
1990 $this->executeRenderPostTransformHook();
1991 $cssLibs = $this->renderCssLibraries();
1992 $cssFiles = $this->renderCssFiles();
1993 $cssInline = $this->renderCssInline();
1994 list($jsLibs, $jsFooterLibs) = $this->renderAdditionalJavaScriptLibraries();
1995 list($jsFiles, $jsFooterFiles) = $this->renderJavaScriptFiles();
1996 list($jsInline, $jsFooterInline) = $this->renderInlineJavaScript();
1997 $jsLibs = $mainJsLibs . $jsLibs;
1998 if ($this->moveJsFromHeaderToFooter) {
1999 $jsFooterLibs = $jsLibs . LF . $jsFooterLibs;
2000 $jsLibs = '';
2001 $jsFooterFiles = $jsFiles . LF . $jsFooterFiles;
2002 $jsFiles = '';
2003 $jsFooterInline = $jsInline . LF . $jsFooterInline;
2004 $jsInline = '';
2005 }
2006 $this->executePostRenderHook($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs);
2007 return array($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs);
2008 }
2009
2010 /**
2011 * Fills the marker array with the given strings and trims each value
2012 *
2013 * @param $jsLibs string
2014 * @param $jsFiles string
2015 * @param $jsFooterFiles string
2016 * @param $cssLibs string
2017 * @param $cssFiles string
2018 * @param $jsInline string
2019 * @param $cssInline string
2020 * @param $jsFooterInline string
2021 * @param $jsFooterLibs string
2022 * @param $metaTags string
2023 * @return array Marker array
2024 */
2025 protected function getPreparedMarkerArray($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs, $metaTags) {
2026 $markerArray = array(
2027 'XMLPROLOG_DOCTYPE' => $this->xmlPrologAndDocType,
2028 'HTMLTAG' => $this->htmlTag,
2029 'HEADTAG' => $this->headTag,
2030 'METACHARSET' => $this->charSet ? str_replace('|', htmlspecialchars($this->charSet), $this->metaCharsetTag) : '',
2031 'INLINECOMMENT' => $this->inlineComments ? LF . LF . '<!-- ' . LF . implode(LF, $this->inlineComments) . '-->' . LF . LF : '',
2032 'BASEURL' => $this->baseUrl ? str_replace('|', $this->baseUrl, $this->baseUrlTag) : '',
2033 'SHORTCUT' => $this->favIcon ? sprintf($this->shortcutTag, htmlspecialchars($this->favIcon), $this->iconMimeType) : '',
2034 'CSS_LIBS' => $cssLibs,
2035 'CSS_INCLUDE' => $cssFiles,
2036 'CSS_INLINE' => $cssInline,
2037 'JS_INLINE' => $jsInline,
2038 'JS_INCLUDE' => $jsFiles,
2039 'JS_LIBS' => $jsLibs,
2040 'TITLE' => $this->title ? str_replace('|', htmlspecialchars($this->title), $this->titleTag) : '',
2041 'META' => $metaTags,
2042 'HEADERDATA' => $this->headerData ? implode(LF, $this->headerData) : '',
2043 'FOOTERDATA' => $this->footerData ? implode(LF, $this->footerData) : '',
2044 'JS_LIBS_FOOTER' => $jsFooterLibs,
2045 'JS_INCLUDE_FOOTER' => $jsFooterFiles,
2046 'JS_INLINE_FOOTER' => $jsFooterInline,
2047 'BODY' => $this->bodyContent
2048 );
2049 $markerArray = array_map('trim', $markerArray);
2050 return $markerArray;
2051 }
2052
2053 /**
2054 * Fills the marker array with the given strings and trims each value
2055 *
2056 * @param string $substituteHash The hash that is used for the placehoder markers
2057 * @return array Marker array
2058 */
2059 protected function getPreparedMarkerArrayForPageWithUncachedObjects($substituteHash) {
2060 $markerArray = array(
2061 'XMLPROLOG_DOCTYPE' => $this->xmlPrologAndDocType,
2062 'HTMLTAG' => $this->htmlTag,
2063 'HEADTAG' => $this->headTag,
2064 'METACHARSET' => $this->charSet ? str_replace('|', htmlspecialchars($this->charSet), $this->metaCharsetTag) : '',
2065 'INLINECOMMENT' => $this->inlineComments ? LF . LF . '<!-- ' . LF . implode(LF, $this->inlineComments) . '-->' . LF . LF : '',
2066 'BASEURL' => $this->baseUrl ? str_replace('|', $this->baseUrl, $this->baseUrlTag) : '',
2067 'SHORTCUT' => $this->favIcon ? sprintf($this->shortcutTag, htmlspecialchars($this->favIcon), $this->iconMimeType) : '',
2068 'META' => implode(LF, $this->metaTags),
2069 'BODY' => $this->bodyContent,
2070 'TITLE' => '<!-- ###TITLE' . $substituteHash . '### -->',
2071 'CSS_LIBS' => '<!-- ###CSS_LIBS' . $substituteHash . '### -->',
2072 'CSS_INCLUDE' => '<!-- ###CSS_INCLUDE' . $substituteHash . '### -->',
2073 'CSS_INLINE' => '<!-- ###CSS_INLINE' . $substituteHash . '### -->',
2074 'JS_INLINE' => '<!-- ###JS_INLINE' . $substituteHash . '### -->',
2075 'JS_INCLUDE' => '<!-- ###JS_INCLUDE' . $substituteHash . '### -->',
2076 'JS_LIBS' => '<!-- ###JS_LIBS' . $substituteHash . '### -->',
2077 'HEADERDATA' => '<!-- ###HEADERDATA' . $substituteHash . '### -->',
2078 'FOOTERDATA' => '<!-- ###FOOTERDATA' . $substituteHash . '### -->',
2079 'JS_LIBS_FOOTER' => '<!-- ###JS_LIBS_FOOTER' . $substituteHash . '### -->',
2080 'JS_INCLUDE_FOOTER' => '<!-- ###JS_INCLUDE_FOOTER' . $substituteHash . '### -->',
2081 'JS_INLINE_FOOTER' => '<!-- ###JS_INLINE_FOOTER' . $substituteHash . '### -->'
2082 );
2083 $markerArray = array_map('trim', $markerArray);
2084 return $markerArray;
2085 }
2086
2087 /**
2088 * Reads the template file and returns the requested part as string
2089 *
2090 * @param int $part
2091 * @return string
2092 */
2093 protected function getTemplateForPart($part) {
2094 $templateFile = GeneralUtility::getFileAbsFileName($this->templateFile, TRUE);
2095 $template = GeneralUtility::getUrl($templateFile);
2096 if ($this->removeLineBreaksFromTemplate) {
2097 $template = strtr($template, array(LF => '', CR => ''));
2098 }
2099 if ($part !== self::PART_COMPLETE) {
2100 $templatePart = explode('###BODY###', $template);
2101 $template = $templatePart[$part - 1];
2102 }
2103 return $template;
2104 }
2105
2106 /**
2107 * Helper function for render the main JavaScript libraries,
2108 * currently: RequireJS, jQuery, PrototypeJS, Scriptaculous, ExtJs
2109 *
2110 * @return string Content with JavaScript libraries
2111 */
2112 protected function renderMainJavaScriptLibraries() {
2113 $out = '';
2114
2115 // Include RequireJS
2116 if ($this->addRequireJs) {
2117 // load the paths of the requireJS configuration
2118 $out .= GeneralUtility::wrapJS('var require = ' . json_encode($this->requireJsConfig)) . LF;
2119 // directly after that, include the require.js file
2120 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->requireJsPath . 'require.js')) . '" type="text/javascript"></script>' . LF;
2121 }
2122
2123 // Include jQuery Core for each namespace, depending on the version and source
2124 if (!empty($this->jQueryVersions)) {
2125 foreach ($this->jQueryVersions as $namespace => $jQueryVersion) {
2126 $out .= $this->renderJqueryScriptTag($jQueryVersion['version'], $jQueryVersion['source'], $namespace);
2127 }
2128 }
2129 if ($this->addPrototype) {
2130 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->prototypePath . 'prototype.js')) . '" type="text/javascript"></script>' . LF;
2131 unset($this->jsFiles[$this->backPath . $this->prototypePath . 'prototype.js']);
2132 }
2133 if ($this->addScriptaculous) {
2134 $mods = array();
2135 foreach ($this->addScriptaculousModules as $key => $value) {
2136 if ($this->addScriptaculousModules[$key]) {
2137 $mods[] = $key;
2138 }
2139 }
2140 // Resolve dependencies
2141 if (in_array('dragdrop', $mods) || in_array('controls', $mods)) {
2142 $mods = array_merge(array('effects'), $mods);
2143 }
2144 if (count($mods)) {
2145 foreach ($mods as $module) {
2146 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->scriptaculousPath . $module . '.js')) . '" type="text/javascript"></script>' . LF;
2147 unset($this->jsFiles[$this->backPath . $this->scriptaculousPath . $module . '.js']);
2148 }
2149 }
2150 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->scriptaculousPath . 'scriptaculous.js')) . '" type="text/javascript"></script>' . LF;
2151 unset($this->jsFiles[$this->backPath . $this->scriptaculousPath . 'scriptaculous.js']);
2152 }
2153 // Include extCore, but only if ExtJS is not included
2154 if ($this->addExtCore && !$this->addExtJS) {
2155 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->extCorePath . 'ext-core' . ($this->enableExtCoreDebug ? '-debug' : '') . '.js')) . '" type="text/javascript"></script>' . LF;
2156 unset($this->jsFiles[$this->backPath . $this->extCorePath . 'ext-core' . ($this->enableExtCoreDebug ? '-debug' : '') . '.js']);
2157 }
2158 // Include extJS
2159 if ($this->addExtJS) {
2160 // Use the base adapter all the time
2161 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->extJsPath . 'adapter/' . ($this->enableExtJsDebug ? str_replace('.js', '-debug.js', $this->extJSadapter) : $this->extJSadapter))) . '" type="text/javascript"></script>' . LF;
2162 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->extJsPath . 'ext-all' . ($this->enableExtJsDebug ? '-debug' : '') . '.js')) . '" type="text/javascript"></script>' . LF;
2163 // Add extJS localization
2164 // Load standard ISO mapping and modify for use with ExtJS
2165 $localeMap = $this->locales->getIsoMapping();
2166 $localeMap[''] = 'en';
2167 $localeMap['default'] = 'en';
2168 // Greek
2169 $localeMap['gr'] = 'el_GR';
2170 // Norwegian Bokmaal
2171 $localeMap['no'] = 'no_BO';
2172 // Swedish
2173 $localeMap['se'] = 'se_SV';
2174 $extJsLang = isset($localeMap[$this->lang]) ? $localeMap[$this->lang] : $this->lang;
2175 // @todo autoconvert file from UTF8 to current BE charset if necessary!!!!
2176 $extJsLocaleFile = $this->extJsPath . 'locale/ext-lang-' . $extJsLang . '.js';
2177 if (file_exists(PATH_typo3 . $extJsLocaleFile)) {
2178 $out .= '<script src="' . $this->processJsFile(($this->backPath . $extJsLocaleFile)) . '" type="text/javascript" charset="utf-8"></script>' . LF;
2179 }
2180 // Remove extjs from JScodeLibArray
2181 unset($this->jsFiles[$this->backPath . $this->extJsPath . 'ext-all.js'], $this->jsFiles[$this->backPath . $this->extJsPath . 'ext-all-debug.js']);
2182 }
2183 $this->loadJavaScriptLanguageStrings();
2184 if (TYPO3_MODE === 'BE') {
2185 $this->addAjaxUrlsToInlineSettings();
2186 }
2187 $inlineSettings = $this->inlineLanguageLabels ? 'TYPO3.lang = ' . json_encode($this->inlineLanguageLabels) . ';' : '';
2188 $inlineSettings .= $this->inlineSettings ? 'TYPO3.settings = ' . json_encode($this->inlineSettings) . ';' : '';
2189 if ($this->addExtCore || $this->addExtJS) {
2190 // Set clear.gif, move it on top, add handler code
2191 $code = '';
2192 if (count($this->extOnReadyCode)) {
2193 foreach ($this->extOnReadyCode as $block) {
2194 $code .= $block;
2195 }
2196 }
2197 $out .= $this->inlineJavascriptWrap[0] . '
2198 Ext.ns("TYPO3");
2199 Ext.BLANK_IMAGE_URL = "' . htmlspecialchars(GeneralUtility::locationHeaderUrl(($this->backPath . 'gfx/clear.gif'))) . '";
2200 Ext.SSL_SECURE_URL = "' . htmlspecialchars(GeneralUtility::locationHeaderUrl(($this->backPath . 'gfx/clear.gif'))) . '";' . LF
2201 . $inlineSettings
2202 . 'Ext.onReady(function() {'
2203 . ($this->enableExtJSQuickTips ? 'Ext.QuickTips.init();' . LF : '')
2204 . $code
2205 . ' });'
2206 . $this->inlineJavascriptWrap[1];
2207 $this->extOnReadyCode = array();
2208 // Include TYPO3.l10n object
2209 if (TYPO3_MODE === 'BE') {
2210 $out .= '<script src="' . $this->processJsFile(($this->backPath . 'sysext/lang/Resources/Public/JavaScript/Typo3Lang.js')) . '" type="text/javascript" charset="utf-8"></script>' . LF;
2211 }
2212 if ($this->extJScss) {
2213 if (isset($GLOBALS['TBE_STYLES']['extJS']['all'])) {
2214 $this->addCssLibrary($this->backPath . $GLOBALS['TBE_STYLES']['extJS']['all'], 'stylesheet', 'all', '', TRUE);
2215 } else {
2216 $this->addCssLibrary($this->backPath . $this->extJsPath . 'resources/css/ext-all-notheme.css', 'stylesheet', 'all', '', TRUE);
2217 }
2218 }
2219 if ($this->extJStheme) {
2220 if (isset($GLOBALS['TBE_STYLES']['extJS']['theme'])) {
2221 $this->addCssLibrary($this->backPath . $GLOBALS['TBE_STYLES']['extJS']['theme'], 'stylesheet', 'all', '', TRUE);
2222 } else {
2223 $this->addCssLibrary($this->backPath . $this->extJsPath . 'resources/css/xtheme-blue.css', 'stylesheet', 'all', '', TRUE);
2224 }
2225 }
2226 } else {
2227 // no extJS loaded, but still inline settings
2228 if ($inlineSettings !== '') {
2229 // make sure the global TYPO3 is available
2230 $inlineSettings = 'var TYPO3 = TYPO3 || {};' . CRLF . $inlineSettings;
2231 $out .= $this->inlineJavascriptWrap[0] . $inlineSettings . $this->inlineJavascriptWrap[1];
2232 if (TYPO3_MODE === 'BE') {
2233 $this->loadRequireJsModule('TYPO3/CMS/Lang/Lang');
2234 }
2235 }
2236 }
2237 return $out;
2238 }
2239
2240 /**
2241 * Load the language strings into JavaScript
2242 */
2243 protected function loadJavaScriptLanguageStrings() {
2244 if (count($this->inlineLanguageLabelFiles)) {
2245 foreach ($this->inlineLanguageLabelFiles as $languageLabelFile) {
2246 $this->includeLanguageFileForInline($languageLabelFile['fileRef'], $languageLabelFile['selectionPrefix'], $languageLabelFile['stripFromSelectionName'], $languageLabelFile['errorMode']);
2247 }
2248 }
2249 $this->inlineLanguageLabelFiles = array();
2250 // Convert labels/settings back to UTF-8 since json_encode() only works with UTF-8:
2251 if (TYPO3_MODE === 'FE' && $this->getCharSet() !== 'utf-8') {
2252 if ($this->inlineLanguageLabels) {
2253 $this->csConvObj->convArray($this->inlineLanguageLabels, $this->getCharSet(), 'utf-8');
2254 }
2255 if ($this->inlineSettings) {
2256 $this->csConvObj->convArray($this->inlineSettings, $this->getCharSet(), 'utf-8');
2257 }
2258 }
2259 }
2260
2261 /**
2262 * Make URLs to all backend ajax handlers available as inline setting.
2263 */
2264 protected function addAjaxUrlsToInlineSettings() {
2265 $ajaxUrls = array();
2266 foreach ($GLOBALS['TYPO3_CONF_VARS']['BE']['AJAX'] as $ajaxHandler => $_) {
2267 $ajaxUrls[$ajaxHandler] = BackendUtility::getAjaxUrl($ajaxHandler);
2268 }
2269 $this->inlineSettings['ajaxUrls'] = $ajaxUrls;
2270 }
2271
2272 /**
2273 * Renders the HTML script tag for the given jQuery version.
2274 *
2275 * @param string $version The jQuery version that should be included, either "latest" or any available version
2276 * @param string $source The location of the jQuery source, can be "local", "google", "msn" or "jquery
2277 * @param string $namespace The namespace in which the jQuery object of the specific version should be stored
2278 * @return string
2279 */
2280 protected function renderJqueryScriptTag($version, $source, $namespace) {
2281 switch (TRUE) {
2282 case isset($this->jQueryCdnUrls[$source]):
2283 if ($this->enableJqueryDebug) {
2284 $minifyPart = '';
2285 } else {
2286 $minifyPart = '.min';
2287 }
2288 $jQueryFileName = sprintf($this->jQueryCdnUrls[$source], $version, $minifyPart);
2289 break;
2290 case $source === 'local':
2291 $jQueryFileName = $this->backPath . $this->jQueryPath . 'jquery-' . rawurlencode($version);
2292 if ($this->enableJqueryDebug) {
2293 $jQueryFileName .= '.js';
2294 } else {
2295 $jQueryFileName .= '.min.js';
2296 }
2297 break;
2298 default:
2299 $jQueryFileName = $source;
2300 }
2301 // Include the jQuery Core
2302 $scriptTag = '<script src="' . htmlspecialchars($jQueryFileName) . '" type="text/javascript"></script>' . LF;
2303 // Set the noConflict mode to be available via "TYPO3.jQuery" in all installations
2304 switch ($namespace) {
2305 case self::JQUERY_NAMESPACE_DEFAULT_NOCONFLICT:
2306 $scriptTag .= GeneralUtility::wrapJS('jQuery.noConflict();') . LF;
2307 break;
2308 case self::JQUERY_NAMESPACE_NONE:
2309 break;
2310 case self::JQUERY_NAMESPACE_DEFAULT:
2311
2312 default:
2313 $scriptTag .= GeneralUtility::wrapJS('var TYPO3 = TYPO3 || {}; TYPO3.' . $namespace . ' = jQuery.noConflict(true);') . LF;
2314 }
2315 return $scriptTag;
2316 }
2317
2318 /**
2319 * Render CSS library files
2320 *
2321 * @return string
2322 */
2323 protected function renderCssLibraries() {
2324 $cssFiles = '';
2325 if (count($this->cssLibs)) {
2326 foreach ($this->cssLibs as $file => $properties) {
2327 $file = GeneralUtility::resolveBackPath($file);
2328 $file = GeneralUtility::createVersionNumberedFilename($file);
2329 $tag = '<link rel="' . htmlspecialchars($properties['rel'])
2330 . '" type="text/css" href="' . htmlspecialchars($file)
2331 . '" media="' . htmlspecialchars($properties['media']) . '"'
2332 . ($properties['title'] ? ' title="' . htmlspecialchars($properties['title']) . '"' : '')
2333 . $this->endingSlash . '>';
2334 if ($properties['allWrap']) {
2335 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2336 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2337 }
2338 $tag .= LF;
2339 if ($properties['forceOnTop']) {
2340 $cssFiles = $tag . $cssFiles;
2341 } else {
2342 $cssFiles .= $tag;
2343 }
2344 }
2345 }
2346 return $cssFiles;
2347 }
2348
2349 /**
2350 * Render CSS files
2351 *
2352 * @return string
2353 */
2354 protected function renderCssFiles() {
2355 $cssFiles = '';
2356 if (count($this->cssFiles)) {
2357 foreach ($this->cssFiles as $file => $properties) {
2358 $file = GeneralUtility::resolveBackPath($file);
2359 $file = GeneralUtility::createVersionNumberedFilename($file);
2360 $tag = '<link rel="' . htmlspecialchars($properties['rel'])
2361 . '" type="text/css" href="' . htmlspecialchars($file)
2362 . '" media="' . htmlspecialchars($properties['media']) . '"'
2363 . ($properties['title'] ? ' title="' . htmlspecialchars($properties['title']) . '"' : '')
2364 . $this->endingSlash . '>';
2365 if ($properties['allWrap']) {
2366 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2367 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2368 }
2369 $tag .= LF;
2370 if ($properties['forceOnTop']) {
2371 $cssFiles = $tag . $cssFiles;
2372 } else {
2373 $cssFiles .= $tag;
2374 }
2375 }
2376 }
2377 return $cssFiles;
2378 }
2379
2380 /**
2381 * Render inline CSS
2382 *
2383 * @return string
2384 */
2385 protected function renderCssInline() {
2386 $cssInline = '';
2387 if (count($this->cssInline)) {
2388 foreach ($this->cssInline as $name => $properties) {
2389 $cssCode = '/*' . htmlspecialchars($name) . '*/' . LF . $properties['code'] . LF;
2390 if ($properties['forceOnTop']) {
2391 $cssInline = $cssCode . $cssInline;
2392 } else {
2393 $cssInline .= $cssCode;
2394 }
2395 }
2396 $cssInline = $this->inlineCssWrap[0] . $cssInline . $this->inlineCssWrap[1];
2397 }
2398 return $cssInline;
2399 }
2400
2401 /**
2402 * Render JavaScipt libraries
2403 *
2404 * @return array<string> jsLibs and jsFooterLibs strings
2405 */
2406 protected function renderAdditionalJavaScriptLibraries() {
2407 $jsLibs = '';
2408 $jsFooterLibs = '';
2409 if (count($this->jsLibs)) {
2410 foreach ($this->jsLibs as $properties) {
2411 $properties['file'] = GeneralUtility::resolveBackPath($properties['file']);
2412 $properties['file'] = GeneralUtility::createVersionNumberedFilename($properties['file']);
2413 $async = ($properties['async']) ? ' async="async"' : '';
2414 $tag = '<script src="' . htmlspecialchars($properties['file']) . '" type="' . htmlspecialchars($properties['type']) . '"' . $async . '></script>';
2415 if ($properties['allWrap']) {
2416 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2417 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2418 }
2419 $tag .= LF;
2420 if ($properties['forceOnTop']) {
2421 if ($properties['section'] === self::PART_HEADER) {
2422 $jsLibs = $tag . $jsLibs;
2423 } else {
2424 $jsFooterLibs = $tag . $jsFooterLibs;
2425 }
2426 } else {
2427 if ($properties['section'] === self::PART_HEADER) {
2428 $jsLibs .= $tag;
2429 } else {
2430 $jsFooterLibs .= $tag;
2431 }
2432 }
2433 }
2434 }
2435 if ($this->moveJsFromHeaderToFooter) {
2436 $jsFooterLibs = $jsLibs . LF . $jsFooterLibs;
2437 $jsLibs = '';
2438 }
2439 return array($jsLibs, $jsFooterLibs);
2440 }
2441
2442 /**
2443 * Render JavaScript files
2444 *
2445 * @return array<string> jsFiles and jsFooterFiles strings
2446 */
2447 protected function renderJavaScriptFiles() {
2448 $jsFiles = '';
2449 $jsFooterFiles = '';
2450 if (count($this->jsFiles)) {
2451 foreach ($this->jsFiles as $file => $properties) {
2452 $file = GeneralUtility::resolveBackPath($file);
2453 $file = GeneralUtility::createVersionNumberedFilename($file);
2454 $async = ($properties['async']) ? ' async="async"' : '';
2455 $tag = '<script src="' . htmlspecialchars($file) . '" type="' . htmlspecialchars($properties['type']) . '"' . $async . '></script>';
2456 if ($properties['allWrap']) {
2457 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2458 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2459 }
2460 $tag .= LF;
2461 if ($properties['forceOnTop']) {
2462 if ($properties['section'] === self::PART_HEADER) {
2463 $jsFiles = $tag . $jsFiles;
2464 } else {
2465 $jsFooterFiles = $tag . $jsFooterFiles;
2466 }
2467 } else {
2468 if ($properties['section'] === self::PART_HEADER) {
2469 $jsFiles .= $tag;
2470 } else {
2471 $jsFooterFiles .= $tag;
2472 }
2473 }
2474 }
2475 }
2476 if ($this->moveJsFromHeaderToFooter) {
2477 $jsFooterFiles = $jsFiles . $jsFooterFiles;
2478 $jsFiles = '';
2479 }
2480 return array($jsFiles, $jsFooterFiles);
2481 }
2482
2483 /**
2484 * Render inline JavaScript
2485 *
2486 * @return array<string> jsInline and jsFooterInline string
2487 */
2488 protected function renderInlineJavaScript() {
2489 $jsInline = '';
2490 $jsFooterInline = '';
2491 if (count($this->jsInline)) {
2492 foreach ($this->jsInline as $name => $properties) {
2493 $jsCode = '/*' . htmlspecialchars($name) . '*/' . LF . $properties['code'] . LF;
2494 if ($properties['forceOnTop']) {
2495 if ($properties['section'] === self::PART_HEADER) {
2496 $jsInline = $jsCode . $jsInline;
2497 } else {
2498 $jsFooterInline = $jsCode . $jsFooterInline;
2499 }
2500 } else {
2501 if ($properties['section'] === self::PART_HEADER) {
2502 $jsInline .= $jsCode;
2503 } else {
2504 $jsFooterInline .= $jsCode;
2505 }
2506 }
2507 }
2508 }
2509 if ($jsInline) {
2510 $jsInline = $this->inlineJavascriptWrap[0] . $jsInline . $this->inlineJavascriptWrap[1];
2511 }
2512 if ($jsFooterInline) {
2513 $jsFooterInline = $this->inlineJavascriptWrap[0] . $jsFooterInline . $this->inlineJavascriptWrap[1];
2514 }
2515 if ($this->moveJsFromHeaderToFooter) {
2516 $jsFooterInline = $jsInline . $jsFooterInline;
2517 $jsInline = '';
2518 }
2519 return array($jsInline, $jsFooterInline);
2520 }
2521
2522 /**
2523 * Include language file for inline usage
2524 *
2525 * @param string $fileRef
2526 * @param string $selectionPrefix
2527 * @param string $stripFromSelectionName
2528 * @param int $errorMode
2529 * @return void
2530 * @throws \RuntimeException
2531 */
2532 protected function includeLanguageFileForInline($fileRef, $selectionPrefix = '', $stripFromSelectionName = '', $errorMode = 0) {
2533 if (!isset($this->lang) || !isset($this->charSet)) {
2534 throw new \RuntimeException('Language and character encoding are not set.', 1284906026);
2535 }
2536 $labelsFromFile = array();
2537 $allLabels = $this->readLLfile($fileRef, $errorMode);
2538 // Regular expression to strip the selection prefix and possibly something from the label name:
2539 $labelPattern = '#^' . preg_quote($selectionPrefix, '#') . '(' . preg_quote($stripFromSelectionName, '#') . ')?#';
2540 if ($allLabels !== FALSE) {
2541 // Merge language specific translations:
2542 if ($this->lang !== 'default' && isset($allLabels[$this->lang])) {
2543 $labels = array_merge($allLabels['default'], $allLabels[$this->lang]);
2544 } else {
2545 $labels = $allLabels['default'];
2546 }
2547 // Iterate through all locallang labels:
2548 foreach ($labels as $label => $value) {
2549 if ($selectionPrefix === '') {
2550 $labelsFromFile[$label] = $value;
2551 } elseif (strpos($label, $selectionPrefix) === 0) {
2552 preg_replace($labelPattern, '', $label);
2553 $labelsFromFile[$label] = $value;
2554 }
2555 }
2556 $this->inlineLanguageLabels = array_merge($this->inlineLanguageLabels, $labelsFromFile);
2557 }
2558 }
2559
2560 /**
2561 * Reads a locallang file.
2562 *
2563 * @param string $fileRef Reference to a relative filename to include.
2564 * @param int $errorMode Error mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception
2565 * @return array Returns the $LOCAL_LANG array found in the file. If no array found, returns empty array.
2566 */
2567 protected function readLLfile($fileRef, $errorMode = 0) {
2568 if ($this->lang !== 'default') {
2569 $languages = array_reverse($this->languageDependencies);
2570 // At least we need to have English
2571 if (empty($languages)) {
2572 $languages[] = 'default';
2573 }
2574 } else {
2575 $languages = array('default');
2576 }
2577
2578 $localLanguage = array();
2579 foreach ($languages as $language) {
2580 $tempLL = GeneralUtility::readLLfile($fileRef, $language, $this->charSet, $errorMode);
2581 $localLanguage['default'] = $tempLL['default'];
2582 if (!isset($localLanguage[$this->lang])) {
2583 $localLanguage[$this->lang] = $localLanguage['default'];
2584 }
2585 if ($this->lang !== 'default' && isset($tempLL[$language])) {
2586 // Merge current language labels onto labels from previous language
2587 // This way we have a labels with fall back applied
2588 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($localLanguage[$this->lang], $tempLL[$language], TRUE, FALSE);
2589 }
2590 }
2591
2592 return $localLanguage;
2593 }
2594
2595
2596 /*****************************************************/
2597 /* */
2598 /* Tools */
2599 /* */
2600 /*****************************************************/
2601 /**
2602 * Concatenate files into one file
2603 * registered handler
2604 *
2605 * @return void
2606 */
2607 protected function doConcatenate() {
2608 $this->doConcatenateCss();
2609 $this->doConcatenateJavaScript();
2610 }
2611
2612 /**
2613 * Concatenate JavaScript files according to the configuration.
2614 *
2615 * @return void
2616 */
2617 protected function doConcatenateJavaScript() {
2618 if ($this->concatenateFiles || $this->concatenateJavascript) {
2619 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsConcatenateHandler'])) {
2620 // use external concatenation routine
2621 $params = array(
2622 'jsLibs' => &$this->jsLibs,
2623 'jsFiles' => &$this->jsFiles,
2624 'jsFooterFiles' => &$this->jsFooterFiles,
2625 'headerData' => &$this->headerData,
2626 'footerData' => &$this->footerData
2627 );
2628 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsConcatenateHandler'], $params, $this);
2629 } else {
2630 $this->jsLibs = $this->getCompressor()->concatenateJsFiles($this->jsLibs);
2631 $this->jsFiles = $this->getCompressor()->concatenateJsFiles($this->jsFiles);
2632 $this->jsFooterFiles = $this->getCompressor()->concatenateJsFiles($this->jsFooterFiles);
2633 }
2634 }
2635 }
2636
2637 /**
2638 * Concatenate CSS files according to configuration.
2639 *
2640 * @return void
2641 */
2642 protected function doConcatenateCss() {
2643 if ($this->concatenateFiles || $this->concatenateCss) {
2644 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssConcatenateHandler'])) {
2645 // use external concatenation routine
2646 $params = array(
2647 'cssFiles' => &$this->cssFiles,
2648 'headerData' => &$this->headerData,
2649 'footerData' => &$this->footerData
2650 );
2651 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssConcatenateHandler'], $params, $this);
2652 } else {
2653 $cssOptions = array();
2654 if (TYPO3_MODE === 'BE') {
2655 $cssOptions = array('baseDirectories' => $GLOBALS['TBE_TEMPLATE']->getSkinStylesheetDirectories());
2656 }
2657 $this->cssFiles = $this->getCompressor()->concatenateCssFiles($this->cssFiles, $cssOptions);
2658 }
2659 }
2660 }
2661
2662 /**
2663 * Compresses inline code
2664 *
2665 * @return void
2666 */
2667 protected function doCompress() {
2668 $this->doCompressJavaScript();
2669 $this->doCompressCss();
2670 }
2671
2672 /**
2673 * Compresses CSS according to configuration.
2674 *
2675 * @return void
2676 */
2677 protected function doCompressCss() {
2678 if ($this->compressCss) {
2679 // Use external compression routine
2680 $params = array(
2681 'cssInline' => &$this->cssInline,
2682 'cssFiles' => &$this->cssFiles,
2683 'headerData' => &$this->headerData,
2684 'footerData' => &$this->footerData
2685 );
2686 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssCompressHandler'])) {
2687 // use external concatenation routine
2688 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssCompressHandler'], $params, $this);
2689 } else {
2690 $this->cssFiles = $this->getCompressor()->compressCssFiles($this->cssFiles);
2691 }
2692 }
2693 }
2694
2695 /**
2696 * Compresses JavaScript according to configuration.
2697 *
2698 * @return void
2699 */
2700 protected function doCompressJavaScript() {
2701 if ($this->compressJavascript) {
2702 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsCompressHandler'])) {
2703 // Use external compression routine
2704 $params = array(
2705 'jsInline' => &$this->jsInline,
2706 'jsFooterInline' => &$this->jsFooterInline,
2707 'jsLibs' => &$this->jsLibs,
2708 'jsFiles' => &$this->jsFiles,
2709 'jsFooterFiles' => &$this->jsFooterFiles,
2710 'headerData' => &$this->headerData,
2711 'footerData' => &$this->footerData
2712 );
2713 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsCompressHandler'], $params, $this);
2714 } else {
2715 // Traverse the arrays, compress files
2716 if (count($this->jsInline)) {
2717 foreach ($this->jsInline as $name => $properties) {
2718 if ($properties['compress']) {
2719 $error = '';
2720 $this->jsInline[$name]['code'] = GeneralUtility::minifyJavaScript($properties['code'], $error);
2721 if ($error) {
2722 $this->compressError .= 'Error with minify JS Inline Block "' . $name . '": ' . $error . LF;
2723 }
2724 }
2725 }
2726 }
2727 $this->jsLibs = $this->getCompressor()->compressJsFiles($this->jsLibs);
2728 $this->jsFiles = $this->getCompressor()->compressJsFiles($this->jsFiles);
2729 $this->jsFooterFiles = $this->getCompressor()->compressJsFiles($this->jsFooterFiles);
2730 }
2731 }
2732 }
2733
2734 /**
2735 * Returns instance of \TYPO3\CMS\Core\Resource\ResourceCompressor
2736 *
2737 * @return \TYPO3\CMS\Core\Resource\ResourceCompressor
2738 */
2739 protected function getCompressor() {
2740 if ($this->compressor === NULL) {
2741 $this->compressor = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Resource\ResourceCompressor::class);
2742 }
2743 return $this->compressor;
2744 }
2745
2746 /**
2747 * Processes a Javascript file dependent on the current context
2748 *
2749 * Adds the version number for Frontend, compresses the file for Backend
2750 *
2751 * @param string $filename Filename
2752 * @return string New filename
2753 */
2754 protected function processJsFile($filename) {
2755 switch (TYPO3_MODE) {
2756 case 'FE':
2757 if ($this->compressJavascript) {
2758 $filename = $this->getCompressor()->compressJsFile($filename);
2759 } else {
2760 $filename = GeneralUtility::createVersionNumberedFilename($filename);
2761 }
2762 break;
2763 case 'BE':
2764 if ($this->compressJavascript) {
2765 $filename = $this->getCompressor()->compressJsFile($filename);
2766 }
2767 break;
2768 }
2769 return $filename;
2770 }
2771
2772 /*****************************************************/
2773 /* */
2774 /* Hooks */
2775 /* */
2776 /*****************************************************/
2777 /**
2778 * Execute PreRenderHook for possible manipulation
2779 *
2780 * @return void
2781 */
2782 protected function executePreRenderHook() {
2783 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-preProcess'])) {
2784 $params = array(
2785 'jsLibs' => &$this->jsLibs,
2786 'jsFooterLibs' => &$this->jsFooterLibs,
2787 'jsFiles' => &$this->jsFiles,
2788 'jsFooterFiles' => &$this->jsFooterFiles,
2789 'cssFiles' => &$this->cssFiles,
2790 'headerData' => &$this->headerData,
2791 'footerData' => &$this->footerData,
2792 'jsInline' => &$this->jsInline,
2793 'jsFooterInline' => &$this->jsFooterInline,
2794 'cssInline' => &$this->cssInline
2795 );
2796 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-preProcess'] as $hook) {
2797 GeneralUtility::callUserFunction($hook, $params, $this);
2798 }
2799 }
2800 }
2801
2802 /**
2803 * PostTransform for possible manipulation of concatenated and compressed files
2804 *
2805 * @return void
2806 */
2807 protected function executeRenderPostTransformHook() {
2808 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postTransform'])) {
2809 $params = array(
2810 'jsLibs' => &$this->jsLibs,
2811 'jsFooterLibs' => &$this->jsFooterLibs,
2812 'jsFiles' => &$this->jsFiles,
2813 'jsFooterFiles' => &$this->jsFooterFiles,
2814 'cssFiles' => &$this->cssFiles,
2815 'headerData' => &$this->headerData,
2816 'footerData' => &$this->footerData,
2817 'jsInline' => &$this->jsInline,
2818 'jsFooterInline' => &$this->jsFooterInline,
2819 'cssInline' => &$this->cssInline
2820 );
2821 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postTransform'] as $hook) {
2822 GeneralUtility::callUserFunction($hook, $params, $this);
2823 }
2824 }
2825 }
2826
2827 /**
2828 * Execute postRenderHook for possible manipulation
2829 *
2830 * @param $jsLibs string
2831 * @param $jsFiles string
2832 * @param $jsFooterFiles string
2833 * @param $cssLibs string
2834 * @param $cssFiles string
2835 * @param $jsInline string
2836 * @param $cssInline string
2837 * @param $jsFooterInline string
2838 * @param $jsFooterLibs string
2839 * @return void
2840 */
2841 protected function executePostRenderHook(&$jsLibs, &$jsFiles, &$jsFooterFiles, &$cssLibs, &$cssFiles, &$jsInline, &$cssInline, &$jsFooterInline, &$jsFooterLibs) {
2842 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postProcess'])) {
2843 $params = array(
2844 'jsLibs' => &$jsLibs,
2845 'jsFiles' => &$jsFiles,
2846 'jsFooterFiles' => &$jsFooterFiles,
2847 'cssLibs' => &$cssLibs,
2848 'cssFiles' => &$cssFiles,
2849 'headerData' => &$this->headerData,
2850 'footerData' => &$this->footerData,
2851 'jsInline' => &$jsInline,
2852 'cssInline' => &$cssInline,
2853 'xmlPrologAndDocType' => &$this->xmlPrologAndDocType,
2854 'htmlTag' => &$this->htmlTag,
2855 'headTag' => &$this->headTag,
2856 'charSet' => &$this->charSet,
2857 'metaCharsetTag' => &$this->metaCharsetTag,
2858 'shortcutTag' => &$this->shortcutTag,
2859 'inlineComments' => &$this->inlineComments,
2860 'baseUrl' => &$this->baseUrl,
2861 'baseUrlTag' => &$this->baseUrlTag,
2862 'favIcon' => &$this->favIcon,
2863 'iconMimeType' => &$this->iconMimeType,
2864 'titleTag' => &$this->titleTag,
2865 'title' => &$this->title,
2866 'metaTags' => &$this->metaTags,
2867 'jsFooterInline' => &$jsFooterInline,
2868 'jsFooterLibs' => &$jsFooterLibs,
2869 'bodyContent' => &$this->bodyContent
2870 );
2871 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postProcess'] as $hook) {
2872 GeneralUtility::callUserFunction($hook, $params, $this);
2873 }
2874 }
2875 }
2876
2877 }