dd5138b65e839915e71d442e690070eea3aff2aa
[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 = 'sysext/core/Resources/Public/JavaScript/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.Notification.error(
1425 TYPO3.l10n.localize("extDirect_timeoutHeader"),
1426 TYPO3.l10n.localize("extDirect_timeoutMessage")
1427 );
1428 } else {
1429 var backtrace = "";
1430 if (event.code === "parse") {
1431 extDirectDebug(
1432 "<p>" + event.xhr.responseText + "<\\/p>",
1433 event.type,
1434 "ExtDirect - Exception"
1435 );
1436 } else if (event.code === "router") {
1437 top.TYPO3.Notification.error(
1438 event.code,
1439 event.message
1440 );
1441 } else if (event.where) {
1442 backtrace = "<p style=\\"margin-top: 20px;\\">" +
1443 "<strong>Backtrace:<\\/strong><br \\/>" +
1444 event.where.replace(/#/g, "<br \\/>#") +
1445 "<\\/p>";
1446 extDirectDebug(
1447 "<p>" + event.message + "<\\/p>" + backtrace,
1448 event.method,
1449 "ExtDirect - Exception"
1450 );
1451 }
1452
1453
1454 }
1455 });
1456
1457 Ext.Direct.on("event", function(event, provider) {
1458 if (typeof event.debug !== "undefined" && event.debug !== "") {
1459 extDirectDebug(event.debug, event.method, "ExtDirect - Debug");
1460 }
1461 });
1462 ', TRUE);
1463 }
1464
1465 /**
1466 * Adds CSS file
1467 *
1468 * @param string $file
1469 * @param string $rel
1470 * @param string $media
1471 * @param string $title
1472 * @param bool $compress
1473 * @param bool $forceOnTop
1474 * @param string $allWrap
1475 * @param bool $excludeFromConcatenation
1476 * @param string $splitChar The char used to split the allWrap value, default is "|"
1477 * @return void
1478 */
1479 public function addCssFile($file, $rel = 'stylesheet', $media = 'all', $title = '', $compress = TRUE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|') {
1480 if (!isset($this->cssFiles[$file])) {
1481 $this->cssFiles[$file] = array(
1482 'file' => $file,
1483 'rel' => $rel,
1484 'media' => $media,
1485 'title' => $title,
1486 'compress' => $compress,
1487 'forceOnTop' => $forceOnTop,
1488 'allWrap' => $allWrap,
1489 'excludeFromConcatenation' => $excludeFromConcatenation,
1490 'splitChar' => $splitChar
1491 );
1492 }
1493 }
1494
1495 /**
1496 * Adds CSS file
1497 *
1498 * @param string $file
1499 * @param string $rel
1500 * @param string $media
1501 * @param string $title
1502 * @param bool $compress
1503 * @param bool $forceOnTop
1504 * @param string $allWrap
1505 * @param bool $excludeFromConcatenation
1506 * @param string $splitChar The char used to split the allWrap value, default is "|"
1507 * @return void
1508 */
1509 public function addCssLibrary($file, $rel = 'stylesheet', $media = 'all', $title = '', $compress = TRUE, $forceOnTop = FALSE, $allWrap = '', $excludeFromConcatenation = FALSE, $splitChar = '|') {
1510 if (!isset($this->cssLibs[$file])) {
1511 $this->cssLibs[$file] = array(
1512 'file' => $file,
1513 'rel' => $rel,
1514 'media' => $media,
1515 'title' => $title,
1516 'compress' => $compress,
1517 'forceOnTop' => $forceOnTop,
1518 'allWrap' => $allWrap,
1519 'excludeFromConcatenation' => $excludeFromConcatenation,
1520 'splitChar' => $splitChar
1521 );
1522 }
1523 }
1524
1525 /**
1526 * Adds CSS inline code
1527 *
1528 * @param string $name
1529 * @param string $block
1530 * @param bool $compress
1531 * @param bool $forceOnTop
1532 * @return void
1533 */
1534 public function addCssInlineBlock($name, $block, $compress = FALSE, $forceOnTop = FALSE) {
1535 if (!isset($this->cssInline[$name]) && !empty($block)) {
1536 $this->cssInline[$name] = array(
1537 'code' => $block,
1538 'compress' => $compress,
1539 'forceOnTop' => $forceOnTop
1540 );
1541 }
1542 }
1543
1544 /**
1545 * Call this function if you need to include the jQuery library
1546 *
1547 * @param null|string $version The jQuery version that should be included, either "latest" or any available version
1548 * @param null|string $source The location of the jQuery source, can be "local", "google", "msn", "jquery" or just an URL to your jQuery lib
1549 * @param string $namespace The namespace in which the jQuery object of the specific version should be stored.
1550 * @return void
1551 * @throws \UnexpectedValueException
1552 */
1553 public function loadJquery($version = NULL, $source = NULL, $namespace = self::JQUERY_NAMESPACE_DEFAULT) {
1554 // Set it to the version that is shipped with the TYPO3 core
1555 if ($version === NULL || $version === 'latest') {
1556 $version = self::JQUERY_VERSION_LATEST;
1557 }
1558 // Check if the source is set, otherwise set it to "default"
1559 if ($source === NULL) {
1560 $source = 'local';
1561 }
1562 if ($source === 'local' && !in_array($version, $this->availableLocalJqueryVersions)) {
1563 throw new \UnexpectedValueException('The requested jQuery version is not available in the local filesystem.', 1341505305);
1564 }
1565 if (!preg_match('/^[a-zA-Z0-9]+$/', $namespace)) {
1566 throw new \UnexpectedValueException('The requested namespace contains non alphanumeric characters.', 1341571604);
1567 }
1568 $this->jQueryVersions[$namespace] = array(
1569 'version' => $version,
1570 'source' => $source
1571 );
1572 }
1573
1574 /**
1575 * Call function if you need the requireJS library
1576 * this automatically adds the JavaScript path of all loaded extensions in the requireJS path option
1577 * so it resolves names like TYPO3/CMS/MyExtension/MyJsFile to EXT:MyExtension/Resources/Public/JavaScript/MyJsFile.js
1578 * when using requireJS
1579 *
1580 * @return void
1581 */
1582 public function loadRequireJs() {
1583
1584 // load all paths to map to package names / namespaces
1585 if (count($this->requireJsConfig) === 0) {
1586 // first, load all paths for the namespaces, and configure contrib libs.
1587 $this->requireJsConfig['paths'] = array(
1588 'jquery-ui' => $this->backPath . 'sysext/core/Resources/Public/JavaScript/Contrib/jquery-ui',
1589 'jquery' => $this->backPath . 'contrib/jquery',
1590 'datatables' => $this->backPath . 'sysext/core/Resources/Public/JavaScript/Contrib/jquery.dataTables',
1591 'nprogress' => $this->backPath . 'sysext/core/Resources/Public/JavaScript/Contrib/nprogress',
1592 'moment' => $this->backPath . 'sysext/core/Resources/Public/JavaScript/Contrib/moment/moment',
1593 'bootstrap' => $this->backPath . 'contrib/twbs/bootstrap.min',
1594 'twbs/bootstrap-datetimepicker' => $this->backPath . 'sysext/core/Resources/Public/JavaScript/Contrib/bootstrap-datetimepicker',
1595 );
1596 // get all extensions that are loaded
1597 $loadedExtensions = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getLoadedExtensionListArray();
1598 foreach ($loadedExtensions as $packageName) {
1599 $fullJsPath = 'EXT:' . $packageName . '/Resources/Public/JavaScript/';
1600 $fullJsPath = GeneralUtility::getFileAbsFileName($fullJsPath);
1601 $fullJsPath = \TYPO3\CMS\Core\Utility\PathUtility::getRelativePath(PATH_typo3, $fullJsPath);
1602 $fullJsPath = rtrim($fullJsPath, '/');
1603 if ($fullJsPath) {
1604 $this->requireJsConfig['paths']['TYPO3/CMS/' . GeneralUtility::underscoredToUpperCamelCase($packageName)] = $this->backPath . $fullJsPath;
1605 }
1606 }
1607
1608 // check if additional AMD modules need to be loaded if a single AMD module is initialized
1609 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['RequireJS']['postInitializationModules'])) {
1610 $this->addInlineSettingArray('RequireJS.PostInitializationModules', $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['RequireJS']['postInitializationModules']);
1611 }
1612 }
1613
1614 $this->addRequireJs = TRUE;
1615 }
1616
1617 /**
1618 * Add additional configuration to require js.
1619 *
1620 * Configuration will be merged recursive with overrule.
1621 *
1622 * To add another path mapping deliver the following configuration:
1623 * 'paths' => array(
1624 * 'EXTERN/mybootstrapjs' => 'contrib/twbs/bootstrap.min',
1625 * ),
1626 *
1627 * @author Daniel Siepmann <daniel.siepmann@typo3.org>
1628 *
1629 * @param array $configuration The configuration that will be merged with existing one.
1630 * @return void
1631 */
1632 public function addRequireJsConfiguration(array $configuration) {
1633 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($this->requireJsConfig, $configuration);
1634 }
1635
1636 /**
1637 * includes a AMD-compatible JS file by resolving the ModuleName, and then requires the file via a requireJS request,
1638 * additionally allowing to execute JavaScript code afterwards
1639 *
1640 * this function only works for AMD-ready JS modules, used like "define('TYPO3/CMS/Backend/FormEngine..."
1641 * in the JS file
1642 *
1643 * TYPO3/CMS/Backend/FormEngine =>
1644 * "TYPO3": Vendor Name
1645 * "CMS": Product Name
1646 * "Backend": Extension Name
1647 * "FormEngine": FileName in the Resources/Public/JavaScript folder
1648 *
1649 * @param string $mainModuleName Must be in the form of "TYPO3/CMS/PackageName/ModuleName" e.g. "TYPO3/CMS/Backend/FormEngine"
1650 * @param string $callBackFunction loaded right after the requireJS loading, must be wrapped in function() {}
1651 * @return void
1652 */
1653 public function loadRequireJsModule($mainModuleName, $callBackFunction = NULL) {
1654 $inlineCodeKey = $mainModuleName;
1655 // make sure requireJS is initialized
1656 $this->loadRequireJs();
1657
1658 // execute the main module, and load a possible callback function
1659 $javaScriptCode = 'require(["' . $mainModuleName . '"]';
1660 if ($callBackFunction !== NULL) {
1661 $inlineCodeKey .= sha1($callBackFunction);
1662 $javaScriptCode .= ', ' . $callBackFunction;
1663 }
1664 $javaScriptCode .= ');';
1665 $this->addJsInlineCode('RequireJS-Module-' . $inlineCodeKey, $javaScriptCode);
1666 }
1667
1668 /**
1669 * Call function if you need the prototype library
1670 *
1671 * @return void
1672 */
1673 public function loadPrototype() {
1674 $this->addPrototype = TRUE;
1675 }
1676
1677 /**
1678 * Call function if you need the Scriptaculous library
1679 *
1680 * @param string $modules Add modules you need. use "all" if you need complete modules
1681 * @return void
1682 */
1683 public function loadScriptaculous($modules = 'all') {
1684 // Scriptaculous require prototype, so load prototype too.
1685 $this->addPrototype = TRUE;
1686 $this->addScriptaculous = TRUE;
1687 if ($modules) {
1688 if ($modules == 'all') {
1689 foreach ($this->addScriptaculousModules as $key => $value) {
1690 $this->addScriptaculousModules[$key] = TRUE;
1691 }
1692 } else {
1693 $mods = GeneralUtility::trimExplode(',', $modules);
1694 foreach ($mods as $mod) {
1695 if (isset($this->addScriptaculousModules[strtolower($mod)])) {
1696 $this->addScriptaculousModules[strtolower($mod)] = TRUE;
1697 }
1698 }
1699 }
1700 }
1701 }
1702
1703 /**
1704 * call this function if you need the extJS library
1705 *
1706 * @param bool $css Flag, if set the ext-css will be loaded
1707 * @param bool $theme Flag, if set the ext-theme "grey" will be loaded
1708 * @param string $adapter Choose alternative adapter, possible values: yui, prototype, jquery
1709 * @return void
1710 */
1711 public function loadExtJS($css = TRUE, $theme = TRUE, $adapter = '') {
1712 if ($adapter) {
1713 // Empty $adapter will always load the ext adapter
1714 switch (GeneralUtility::strtolower(trim($adapter))) {
1715 case self::EXTJS_ADAPTER_YUI:
1716 $this->extJSadapter = 'yui/ext-yui-adapter.js';
1717 break;
1718 case self::EXTJS_ADAPTER_PROTOTYPE:
1719 $this->extJSadapter = 'prototype/ext-prototype-adapter.js';
1720 break;
1721 case self::EXTJS_ADAPTER_JQUERY:
1722 $this->extJSadapter = 'jquery/ext-jquery-adapter.js';
1723 break;
1724 }
1725 }
1726 $this->addExtJS = TRUE;
1727 $this->extJStheme = $theme;
1728 $this->extJScss = $css;
1729 }
1730
1731 /**
1732 * Enables ExtJs QuickTips
1733 * Need extJs loaded
1734 *
1735 * @return void
1736 */
1737 public function enableExtJSQuickTips() {
1738 $this->enableExtJSQuickTips = TRUE;
1739 }
1740
1741 /**
1742 * Call function if you need the ExtCore library
1743 *
1744 * @return void
1745 */
1746 public function loadExtCore() {
1747 $this->addExtCore = TRUE;
1748 }
1749
1750 /**
1751 * Call this function to load debug version of ExtJS. Use this for development only
1752 *
1753 * @return void
1754 */
1755 public function enableExtJsDebug() {
1756 $this->enableExtJsDebug = TRUE;
1757 }
1758
1759 /**
1760 * Call this function to load debug version of ExtCore. Use this for development only
1761 *
1762 * @return void
1763 */
1764 public function enableExtCoreDebug() {
1765 $this->enableExtCoreDebug = TRUE;
1766 }
1767
1768 /**
1769 * Adds Javascript Inline Label. This will occur in TYPO3.lang - object
1770 * The label can be used in scripts with TYPO3.lang.<key>
1771 * Need extJs loaded
1772 *
1773 * @param string $key
1774 * @param string $value
1775 * @return void
1776 */
1777 public function addInlineLanguageLabel($key, $value) {
1778 $this->inlineLanguageLabels[$key] = $value;
1779 }
1780
1781 /**
1782 * Adds Javascript Inline Label Array. This will occur in TYPO3.lang - object
1783 * The label can be used in scripts with TYPO3.lang.<key>
1784 * Array will be merged with existing array.
1785 * Need extJs loaded
1786 *
1787 * @param array $array
1788 * @return void
1789 */
1790 public function addInlineLanguageLabelArray(array $array) {
1791 $this->inlineLanguageLabels = array_merge($this->inlineLanguageLabels, $array);
1792 }
1793
1794 /**
1795 * Gets labels to be used in JavaScript fetched from a locallang file.
1796 *
1797 * @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.
1798 * @param string $selectionPrefix Prefix to select the correct labels (default: '')
1799 * @param string $stripFromSelectionName Sub-prefix to be removed from label names in the result (default: '')
1800 * @param int $errorMode Error mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception
1801 * @return void
1802 */
1803 public function addInlineLanguageLabelFile($fileRef, $selectionPrefix = '', $stripFromSelectionName = '', $errorMode = 0) {
1804 $index = md5($fileRef . $selectionPrefix . $stripFromSelectionName);
1805 if ($fileRef && !isset($this->inlineLanguageLabelFiles[$index])) {
1806 $this->inlineLanguageLabelFiles[$index] = array(
1807 'fileRef' => $fileRef,
1808 'selectionPrefix' => $selectionPrefix,
1809 'stripFromSelectionName' => $stripFromSelectionName,
1810 'errorMode' => $errorMode
1811 );
1812 }
1813 }
1814
1815 /**
1816 * Adds Javascript Inline Setting. This will occur in TYPO3.settings - object
1817 * The label can be used in scripts with TYPO3.setting.<key>
1818 * Need extJs loaded
1819 *
1820 * @param string $namespace
1821 * @param string $key
1822 * @param string $value
1823 * @return void
1824 */
1825 public function addInlineSetting($namespace, $key, $value) {
1826 if ($namespace) {
1827 if (strpos($namespace, '.')) {
1828 $parts = explode('.', $namespace);
1829 $a = &$this->inlineSettings;
1830 foreach ($parts as $part) {
1831 $a = &$a[$part];
1832 }
1833 $a[$key] = $value;
1834 } else {
1835 $this->inlineSettings[$namespace][$key] = $value;
1836 }
1837 } else {
1838 $this->inlineSettings[$key] = $value;
1839 }
1840 }
1841
1842 /**
1843 * Adds Javascript Inline Setting. This will occur in TYPO3.settings - object
1844 * The label can be used in scripts with TYPO3.setting.<key>
1845 * Array will be merged with existing array.
1846 * Need extJs loaded
1847 *
1848 * @param string $namespace
1849 * @param array $array
1850 * @return void
1851 */
1852 public function addInlineSettingArray($namespace, array $array) {
1853 if ($namespace) {
1854 if (strpos($namespace, '.')) {
1855 $parts = explode('.', $namespace);
1856 $a = &$this->inlineSettings;
1857 foreach ($parts as $part) {
1858 $a = &$a[$part];
1859 }
1860 $a = array_merge((array)$a, $array);
1861 } else {
1862 $this->inlineSettings[$namespace] = array_merge((array)$this->inlineSettings[$namespace], $array);
1863 }
1864 } else {
1865 $this->inlineSettings = array_merge($this->inlineSettings, $array);
1866 }
1867 }
1868
1869 /**
1870 * Adds content to body content
1871 *
1872 * @param string $content
1873 * @return void
1874 */
1875 public function addBodyContent($content) {
1876 $this->bodyContent .= $content;
1877 }
1878
1879 /*****************************************************/
1880 /* */
1881 /* Render Functions */
1882 /* */
1883 /*****************************************************/
1884 /**
1885 * Render the section (Header or Footer)
1886 *
1887 * @param int $part Section which should be rendered: self::PART_COMPLETE, self::PART_HEADER or self::PART_FOOTER
1888 * @return string Content of rendered section
1889 */
1890 public function render($part = self::PART_COMPLETE) {
1891 $this->prepareRendering();
1892 list($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs) = $this->renderJavaScriptAndCss();
1893 $metaTags = implode(LF, $this->metaTags);
1894 $markerArray = $this->getPreparedMarkerArray($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs, $metaTags);
1895 $template = $this->getTemplateForPart($part);
1896
1897 // The page renderer needs a full reset, even when only rendering one part of the page
1898 // This means that you can only register footer files *after* the header has been already rendered.
1899 // In case you render the footer part first, header files can only be added *after* the footer has been rendered
1900 $this->reset();
1901 return trim(\TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerArray($template, $markerArray, '###|###'));
1902 }
1903
1904 /**
1905 * Render the page but not the JavaScript and CSS Files
1906 *
1907 * @param string $substituteHash The hash that is used for the placehoder markers
1908 * @access private
1909 * @return string Content of rendered section
1910 */
1911 public function renderPageWithUncachedObjects($substituteHash) {
1912 $this->prepareRendering();
1913 $markerArray = $this->getPreparedMarkerArrayForPageWithUncachedObjects($substituteHash);
1914 $template = $this->getTemplateForPart(self::PART_COMPLETE);
1915 return trim(\TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerArray($template, $markerArray, '###|###'));
1916 }
1917
1918 /**
1919 * Renders the JavaScript and CSS files that have been added during processing
1920 * of uncached content objects (USER_INT, COA_INT)
1921 *
1922 * @param string $cachedPageContent
1923 * @param string $substituteHash The hash that is used for the placehoder markers
1924 * @access private
1925 * @return string
1926 */
1927 public function renderJavaScriptAndCssForProcessingOfUncachedContentObjects($cachedPageContent, $substituteHash) {
1928 $this->prepareRendering();
1929 list($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs) = $this->renderJavaScriptAndCss();
1930 $title = $this->title ? str_replace('|', htmlspecialchars($this->title), $this->titleTag) : '';
1931 $markerArray = array(
1932 '<!-- ###TITLE' . $substituteHash . '### -->' => $title,
1933 '<!-- ###CSS_LIBS' . $substituteHash . '### -->' => $cssLibs,
1934 '<!-- ###CSS_INCLUDE' . $substituteHash . '### -->' => $cssFiles,
1935 '<!-- ###CSS_INLINE' . $substituteHash . '### -->' => $cssInline,
1936 '<!-- ###JS_INLINE' . $substituteHash . '### -->' => $jsInline,
1937 '<!-- ###JS_INCLUDE' . $substituteHash . '### -->' => $jsFiles,
1938 '<!-- ###JS_LIBS' . $substituteHash . '### -->' => $jsLibs,
1939 '<!-- ###HEADERDATA' . $substituteHash . '### -->' => implode(LF, $this->headerData),
1940 '<!-- ###FOOTERDATA' . $substituteHash . '### -->' => implode(LF, $this->footerData),
1941 '<!-- ###JS_LIBS_FOOTER' . $substituteHash . '### -->' => $jsFooterLibs,
1942 '<!-- ###JS_INCLUDE_FOOTER' . $substituteHash . '### -->' => $jsFooterFiles,
1943 '<!-- ###JS_INLINE_FOOTER' . $substituteHash . '### -->' => $jsFooterInline
1944 );
1945 foreach ($markerArray as $placeHolder => $content) {
1946 $cachedPageContent = str_replace($placeHolder, $content, $cachedPageContent);
1947 }
1948 $this->reset();
1949 return $cachedPageContent;
1950 }
1951
1952 /**
1953 * Remove ending slashes from static header block
1954 * if the page is beeing rendered as html (not xhtml)
1955 * and define property $this->endingSlash for further use
1956 *
1957 * @return void
1958 */
1959 protected function prepareRendering() {
1960 if ($this->getRenderXhtml()) {
1961 $this->endingSlash = ' /';
1962 } else {
1963 $this->metaCharsetTag = str_replace(' />', '>', $this->metaCharsetTag);
1964 $this->baseUrlTag = str_replace(' />', '>', $this->baseUrlTag);
1965 $this->shortcutTag = str_replace(' />', '>', $this->shortcutTag);
1966 $this->endingSlash = '';
1967 }
1968 }
1969
1970 /**
1971 * Renders all JavaScript and CSS
1972 *
1973 * @return array<string>
1974 */
1975 protected function renderJavaScriptAndCss() {
1976 $this->executePreRenderHook();
1977 $mainJsLibs = $this->renderMainJavaScriptLibraries();
1978 if ($this->concatenateFiles || $this->concatenateJavascript || $this->concatenateCss) {
1979 // Do the file concatenation
1980 $this->doConcatenate();
1981 }
1982 if ($this->compressCss || $this->compressJavascript) {
1983 // Do the file compression
1984 $this->doCompress();
1985 }
1986 $this->executeRenderPostTransformHook();
1987 $cssLibs = $this->renderCssLibraries();
1988 $cssFiles = $this->renderCssFiles();
1989 $cssInline = $this->renderCssInline();
1990 list($jsLibs, $jsFooterLibs) = $this->renderAdditionalJavaScriptLibraries();
1991 list($jsFiles, $jsFooterFiles) = $this->renderJavaScriptFiles();
1992 list($jsInline, $jsFooterInline) = $this->renderInlineJavaScript();
1993 $jsLibs = $mainJsLibs . $jsLibs;
1994 if ($this->moveJsFromHeaderToFooter) {
1995 $jsFooterLibs = $jsLibs . LF . $jsFooterLibs;
1996 $jsLibs = '';
1997 $jsFooterFiles = $jsFiles . LF . $jsFooterFiles;
1998 $jsFiles = '';
1999 $jsFooterInline = $jsInline . LF . $jsFooterInline;
2000 $jsInline = '';
2001 }
2002 $this->executePostRenderHook($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs);
2003 return array($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs);
2004 }
2005
2006 /**
2007 * Fills the marker array with the given strings and trims each value
2008 *
2009 * @param $jsLibs string
2010 * @param $jsFiles string
2011 * @param $jsFooterFiles string
2012 * @param $cssLibs string
2013 * @param $cssFiles string
2014 * @param $jsInline string
2015 * @param $cssInline string
2016 * @param $jsFooterInline string
2017 * @param $jsFooterLibs string
2018 * @param $metaTags string
2019 * @return array Marker array
2020 */
2021 protected function getPreparedMarkerArray($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs, $metaTags) {
2022 $markerArray = array(
2023 'XMLPROLOG_DOCTYPE' => $this->xmlPrologAndDocType,
2024 'HTMLTAG' => $this->htmlTag,
2025 'HEADTAG' => $this->headTag,
2026 'METACHARSET' => $this->charSet ? str_replace('|', htmlspecialchars($this->charSet), $this->metaCharsetTag) : '',
2027 'INLINECOMMENT' => $this->inlineComments ? LF . LF . '<!-- ' . LF . implode(LF, $this->inlineComments) . '-->' . LF . LF : '',
2028 'BASEURL' => $this->baseUrl ? str_replace('|', $this->baseUrl, $this->baseUrlTag) : '',
2029 'SHORTCUT' => $this->favIcon ? sprintf($this->shortcutTag, htmlspecialchars($this->favIcon), $this->iconMimeType) : '',
2030 'CSS_LIBS' => $cssLibs,
2031 'CSS_INCLUDE' => $cssFiles,
2032 'CSS_INLINE' => $cssInline,
2033 'JS_INLINE' => $jsInline,
2034 'JS_INCLUDE' => $jsFiles,
2035 'JS_LIBS' => $jsLibs,
2036 'TITLE' => $this->title ? str_replace('|', htmlspecialchars($this->title), $this->titleTag) : '',
2037 'META' => $metaTags,
2038 'HEADERDATA' => $this->headerData ? implode(LF, $this->headerData) : '',
2039 'FOOTERDATA' => $this->footerData ? implode(LF, $this->footerData) : '',
2040 'JS_LIBS_FOOTER' => $jsFooterLibs,
2041 'JS_INCLUDE_FOOTER' => $jsFooterFiles,
2042 'JS_INLINE_FOOTER' => $jsFooterInline,
2043 'BODY' => $this->bodyContent
2044 );
2045 $markerArray = array_map('trim', $markerArray);
2046 return $markerArray;
2047 }
2048
2049 /**
2050 * Fills the marker array with the given strings and trims each value
2051 *
2052 * @param string $substituteHash The hash that is used for the placehoder markers
2053 * @return array Marker array
2054 */
2055 protected function getPreparedMarkerArrayForPageWithUncachedObjects($substituteHash) {
2056 $markerArray = array(
2057 'XMLPROLOG_DOCTYPE' => $this->xmlPrologAndDocType,
2058 'HTMLTAG' => $this->htmlTag,
2059 'HEADTAG' => $this->headTag,
2060 'METACHARSET' => $this->charSet ? str_replace('|', htmlspecialchars($this->charSet), $this->metaCharsetTag) : '',
2061 'INLINECOMMENT' => $this->inlineComments ? LF . LF . '<!-- ' . LF . implode(LF, $this->inlineComments) . '-->' . LF . LF : '',
2062 'BASEURL' => $this->baseUrl ? str_replace('|', $this->baseUrl, $this->baseUrlTag) : '',
2063 'SHORTCUT' => $this->favIcon ? sprintf($this->shortcutTag, htmlspecialchars($this->favIcon), $this->iconMimeType) : '',
2064 'META' => implode(LF, $this->metaTags),
2065 'BODY' => $this->bodyContent,
2066 'TITLE' => '<!-- ###TITLE' . $substituteHash . '### -->',
2067 'CSS_LIBS' => '<!-- ###CSS_LIBS' . $substituteHash . '### -->',
2068 'CSS_INCLUDE' => '<!-- ###CSS_INCLUDE' . $substituteHash . '### -->',
2069 'CSS_INLINE' => '<!-- ###CSS_INLINE' . $substituteHash . '### -->',
2070 'JS_INLINE' => '<!-- ###JS_INLINE' . $substituteHash . '### -->',
2071 'JS_INCLUDE' => '<!-- ###JS_INCLUDE' . $substituteHash . '### -->',
2072 'JS_LIBS' => '<!-- ###JS_LIBS' . $substituteHash . '### -->',
2073 'HEADERDATA' => '<!-- ###HEADERDATA' . $substituteHash . '### -->',
2074 'FOOTERDATA' => '<!-- ###FOOTERDATA' . $substituteHash . '### -->',
2075 'JS_LIBS_FOOTER' => '<!-- ###JS_LIBS_FOOTER' . $substituteHash . '### -->',
2076 'JS_INCLUDE_FOOTER' => '<!-- ###JS_INCLUDE_FOOTER' . $substituteHash . '### -->',
2077 'JS_INLINE_FOOTER' => '<!-- ###JS_INLINE_FOOTER' . $substituteHash . '### -->'
2078 );
2079 $markerArray = array_map('trim', $markerArray);
2080 return $markerArray;
2081 }
2082
2083 /**
2084 * Reads the template file and returns the requested part as string
2085 *
2086 * @param int $part
2087 * @return string
2088 */
2089 protected function getTemplateForPart($part) {
2090 $templateFile = GeneralUtility::getFileAbsFileName($this->templateFile, TRUE);
2091 $template = GeneralUtility::getUrl($templateFile);
2092 if ($this->removeLineBreaksFromTemplate) {
2093 $template = strtr($template, array(LF => '', CR => ''));
2094 }
2095 if ($part !== self::PART_COMPLETE) {
2096 $templatePart = explode('###BODY###', $template);
2097 $template = $templatePart[$part - 1];
2098 }
2099 return $template;
2100 }
2101
2102 /**
2103 * Helper function for render the main JavaScript libraries,
2104 * currently: RequireJS, jQuery, PrototypeJS, Scriptaculous, ExtJs
2105 *
2106 * @return string Content with JavaScript libraries
2107 */
2108 protected function renderMainJavaScriptLibraries() {
2109 $out = '';
2110
2111 // Include RequireJS
2112 if ($this->addRequireJs) {
2113 // load the paths of the requireJS configuration
2114 $out .= GeneralUtility::wrapJS('var require = ' . json_encode($this->requireJsConfig)) . LF;
2115 // directly after that, include the require.js file
2116 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->requireJsPath . 'require.js')) . '" type="text/javascript"></script>' . LF;
2117 }
2118
2119 // Include jQuery Core for each namespace, depending on the version and source
2120 if (!empty($this->jQueryVersions)) {
2121 foreach ($this->jQueryVersions as $namespace => $jQueryVersion) {
2122 $out .= $this->renderJqueryScriptTag($jQueryVersion['version'], $jQueryVersion['source'], $namespace);
2123 }
2124 }
2125 if ($this->addPrototype) {
2126 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->prototypePath . 'prototype.js')) . '" type="text/javascript"></script>' . LF;
2127 unset($this->jsFiles[$this->backPath . $this->prototypePath . 'prototype.js']);
2128 }
2129 if ($this->addScriptaculous) {
2130 $mods = array();
2131 foreach ($this->addScriptaculousModules as $key => $value) {
2132 if ($this->addScriptaculousModules[$key]) {
2133 $mods[] = $key;
2134 }
2135 }
2136 // Resolve dependencies
2137 if (in_array('dragdrop', $mods) || in_array('controls', $mods)) {
2138 $mods = array_merge(array('effects'), $mods);
2139 }
2140 if (count($mods)) {
2141 foreach ($mods as $module) {
2142 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->scriptaculousPath . $module . '.js')) . '" type="text/javascript"></script>' . LF;
2143 unset($this->jsFiles[$this->backPath . $this->scriptaculousPath . $module . '.js']);
2144 }
2145 }
2146 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->scriptaculousPath . 'scriptaculous.js')) . '" type="text/javascript"></script>' . LF;
2147 unset($this->jsFiles[$this->backPath . $this->scriptaculousPath . 'scriptaculous.js']);
2148 }
2149 // Include extCore, but only if ExtJS is not included
2150 if ($this->addExtCore && !$this->addExtJS) {
2151 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->extCorePath . 'ext-core' . ($this->enableExtCoreDebug ? '-debug' : '') . '.js')) . '" type="text/javascript"></script>' . LF;
2152 unset($this->jsFiles[$this->backPath . $this->extCorePath . 'ext-core' . ($this->enableExtCoreDebug ? '-debug' : '') . '.js']);
2153 }
2154 // Include extJS
2155 if ($this->addExtJS) {
2156 // Use the base adapter all the time
2157 $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;
2158 $out .= '<script src="' . $this->processJsFile(($this->backPath . $this->extJsPath . 'ext-all' . ($this->enableExtJsDebug ? '-debug' : '') . '.js')) . '" type="text/javascript"></script>' . LF;
2159 // Add extJS localization
2160 // Load standard ISO mapping and modify for use with ExtJS
2161 $localeMap = $this->locales->getIsoMapping();
2162 $localeMap[''] = 'en';
2163 $localeMap['default'] = 'en';
2164 // Greek
2165 $localeMap['gr'] = 'el_GR';
2166 // Norwegian Bokmaal
2167 $localeMap['no'] = 'no_BO';
2168 // Swedish
2169 $localeMap['se'] = 'se_SV';
2170 $extJsLang = isset($localeMap[$this->lang]) ? $localeMap[$this->lang] : $this->lang;
2171 // @todo autoconvert file from UTF8 to current BE charset if necessary!!!!
2172 $extJsLocaleFile = $this->extJsPath . 'locale/ext-lang-' . $extJsLang . '.js';
2173 if (file_exists(PATH_typo3 . $extJsLocaleFile)) {
2174 $out .= '<script src="' . $this->processJsFile(($this->backPath . $extJsLocaleFile)) . '" type="text/javascript" charset="utf-8"></script>' . LF;
2175 }
2176 // Remove extjs from JScodeLibArray
2177 unset($this->jsFiles[$this->backPath . $this->extJsPath . 'ext-all.js'], $this->jsFiles[$this->backPath . $this->extJsPath . 'ext-all-debug.js']);
2178 }
2179 $this->loadJavaScriptLanguageStrings();
2180 if (TYPO3_MODE === 'BE') {
2181 $this->addAjaxUrlsToInlineSettings();
2182 }
2183 $inlineSettings = $this->inlineLanguageLabels ? 'TYPO3.lang = ' . json_encode($this->inlineLanguageLabels) . ';' : '';
2184 $inlineSettings .= $this->inlineSettings ? 'TYPO3.settings = ' . json_encode($this->inlineSettings) . ';' : '';
2185 if ($this->addExtCore || $this->addExtJS) {
2186 // Set clear.gif, move it on top, add handler code
2187 $code = '';
2188 if (count($this->extOnReadyCode)) {
2189 foreach ($this->extOnReadyCode as $block) {
2190 $code .= $block;
2191 }
2192 }
2193 $out .= $this->inlineJavascriptWrap[0] . '
2194 Ext.ns("TYPO3");
2195 Ext.BLANK_IMAGE_URL = "' . htmlspecialchars(GeneralUtility::locationHeaderUrl(($this->backPath . 'gfx/clear.gif'))) . '";
2196 Ext.SSL_SECURE_URL = "' . htmlspecialchars(GeneralUtility::locationHeaderUrl(($this->backPath . 'gfx/clear.gif'))) . '";' . LF
2197 . $inlineSettings
2198 . 'Ext.onReady(function() {'
2199 . ($this->enableExtJSQuickTips ? 'Ext.QuickTips.init();' . LF : '')
2200 . $code
2201 . ' });'
2202 . $this->inlineJavascriptWrap[1];
2203 $this->extOnReadyCode = array();
2204 // Include TYPO3.l10n object
2205 if (TYPO3_MODE === 'BE') {
2206 $out .= '<script src="' . $this->processJsFile(($this->backPath . 'sysext/lang/Resources/Public/JavaScript/Typo3Lang.js')) . '" type="text/javascript" charset="utf-8"></script>' . LF;
2207 }
2208 if ($this->extJScss) {
2209 if (isset($GLOBALS['TBE_STYLES']['extJS']['all'])) {
2210 $this->addCssLibrary($this->backPath . $GLOBALS['TBE_STYLES']['extJS']['all'], 'stylesheet', 'all', '', TRUE);
2211 } else {
2212 $this->addCssLibrary($this->backPath . $this->extJsPath . 'resources/css/ext-all-notheme.css', 'stylesheet', 'all', '', TRUE);
2213 }
2214 }
2215 if ($this->extJStheme) {
2216 if (isset($GLOBALS['TBE_STYLES']['extJS']['theme'])) {
2217 $this->addCssLibrary($this->backPath . $GLOBALS['TBE_STYLES']['extJS']['theme'], 'stylesheet', 'all', '', TRUE);
2218 } else {
2219 $this->addCssLibrary($this->backPath . $this->extJsPath . 'resources/css/xtheme-blue.css', 'stylesheet', 'all', '', TRUE);
2220 }
2221 }
2222 } else {
2223 // no extJS loaded, but still inline settings
2224 if ($inlineSettings !== '') {
2225 // make sure the global TYPO3 is available
2226 $inlineSettings = 'var TYPO3 = TYPO3 || {};' . CRLF . $inlineSettings;
2227 $out .= $this->inlineJavascriptWrap[0] . $inlineSettings . $this->inlineJavascriptWrap[1];
2228 if (TYPO3_MODE === 'BE') {
2229 $this->loadRequireJsModule('TYPO3/CMS/Lang/Lang');
2230 }
2231 }
2232 }
2233 return $out;
2234 }
2235
2236 /**
2237 * Load the language strings into JavaScript
2238 */
2239 protected function loadJavaScriptLanguageStrings() {
2240 if (count($this->inlineLanguageLabelFiles)) {
2241 foreach ($this->inlineLanguageLabelFiles as $languageLabelFile) {
2242 $this->includeLanguageFileForInline($languageLabelFile['fileRef'], $languageLabelFile['selectionPrefix'], $languageLabelFile['stripFromSelectionName'], $languageLabelFile['errorMode']);
2243 }
2244 }
2245 $this->inlineLanguageLabelFiles = array();
2246 // Convert labels/settings back to UTF-8 since json_encode() only works with UTF-8:
2247 if (TYPO3_MODE === 'FE' && $this->getCharSet() !== 'utf-8') {
2248 if ($this->inlineLanguageLabels) {
2249 $this->csConvObj->convArray($this->inlineLanguageLabels, $this->getCharSet(), 'utf-8');
2250 }
2251 if ($this->inlineSettings) {
2252 $this->csConvObj->convArray($this->inlineSettings, $this->getCharSet(), 'utf-8');
2253 }
2254 }
2255 }
2256
2257 /**
2258 * Make URLs to all backend ajax handlers available as inline setting.
2259 */
2260 protected function addAjaxUrlsToInlineSettings() {
2261 $ajaxUrls = array();
2262 foreach ($GLOBALS['TYPO3_CONF_VARS']['BE']['AJAX'] as $ajaxHandler => $_) {
2263 $ajaxUrls[$ajaxHandler] = BackendUtility::getAjaxUrl($ajaxHandler);
2264 }
2265 $this->inlineSettings['ajaxUrls'] = $ajaxUrls;
2266 }
2267
2268 /**
2269 * Renders the HTML script tag for the given jQuery version.
2270 *
2271 * @param string $version The jQuery version that should be included, either "latest" or any available version
2272 * @param string $source The location of the jQuery source, can be "local", "google", "msn" or "jquery
2273 * @param string $namespace The namespace in which the jQuery object of the specific version should be stored
2274 * @return string
2275 */
2276 protected function renderJqueryScriptTag($version, $source, $namespace) {
2277 switch (TRUE) {
2278 case isset($this->jQueryCdnUrls[$source]):
2279 if ($this->enableJqueryDebug) {
2280 $minifyPart = '';
2281 } else {
2282 $minifyPart = '.min';
2283 }
2284 $jQueryFileName = sprintf($this->jQueryCdnUrls[$source], $version, $minifyPart);
2285 break;
2286 case $source === 'local':
2287 $jQueryFileName = $this->backPath . $this->jQueryPath . 'jquery-' . rawurlencode($version);
2288 if ($this->enableJqueryDebug) {
2289 $jQueryFileName .= '.js';
2290 } else {
2291 $jQueryFileName .= '.min.js';
2292 }
2293 break;
2294 default:
2295 $jQueryFileName = $source;
2296 }
2297 // Include the jQuery Core
2298 $scriptTag = '<script src="' . htmlspecialchars($jQueryFileName) . '" type="text/javascript"></script>' . LF;
2299 // Set the noConflict mode to be available via "TYPO3.jQuery" in all installations
2300 switch ($namespace) {
2301 case self::JQUERY_NAMESPACE_DEFAULT_NOCONFLICT:
2302 $scriptTag .= GeneralUtility::wrapJS('jQuery.noConflict();') . LF;
2303 break;
2304 case self::JQUERY_NAMESPACE_NONE:
2305 break;
2306 case self::JQUERY_NAMESPACE_DEFAULT:
2307
2308 default:
2309 $scriptTag .= GeneralUtility::wrapJS('var TYPO3 = TYPO3 || {}; TYPO3.' . $namespace . ' = jQuery.noConflict(true);') . LF;
2310 }
2311 return $scriptTag;
2312 }
2313
2314 /**
2315 * Render CSS library files
2316 *
2317 * @return string
2318 */
2319 protected function renderCssLibraries() {
2320 $cssFiles = '';
2321 if (count($this->cssLibs)) {
2322 foreach ($this->cssLibs as $file => $properties) {
2323 $file = GeneralUtility::resolveBackPath($file);
2324 $file = GeneralUtility::createVersionNumberedFilename($file);
2325 $tag = '<link rel="' . htmlspecialchars($properties['rel'])
2326 . '" type="text/css" href="' . htmlspecialchars($file)
2327 . '" media="' . htmlspecialchars($properties['media']) . '"'
2328 . ($properties['title'] ? ' title="' . htmlspecialchars($properties['title']) . '"' : '')
2329 . $this->endingSlash . '>';
2330 if ($properties['allWrap']) {
2331 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2332 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2333 }
2334 $tag .= LF;
2335 if ($properties['forceOnTop']) {
2336 $cssFiles = $tag . $cssFiles;
2337 } else {
2338 $cssFiles .= $tag;
2339 }
2340 }
2341 }
2342 return $cssFiles;
2343 }
2344
2345 /**
2346 * Render CSS files
2347 *
2348 * @return string
2349 */
2350 protected function renderCssFiles() {
2351 $cssFiles = '';
2352 if (count($this->cssFiles)) {
2353 foreach ($this->cssFiles as $file => $properties) {
2354 $file = GeneralUtility::resolveBackPath($file);
2355 $file = GeneralUtility::createVersionNumberedFilename($file);
2356 $tag = '<link rel="' . htmlspecialchars($properties['rel'])
2357 . '" type="text/css" href="' . htmlspecialchars($file)
2358 . '" media="' . htmlspecialchars($properties['media']) . '"'
2359 . ($properties['title'] ? ' title="' . htmlspecialchars($properties['title']) . '"' : '')
2360 . $this->endingSlash . '>';
2361 if ($properties['allWrap']) {
2362 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2363 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2364 }
2365 $tag .= LF;
2366 if ($properties['forceOnTop']) {
2367 $cssFiles = $tag . $cssFiles;
2368 } else {
2369 $cssFiles .= $tag;
2370 }
2371 }
2372 }
2373 return $cssFiles;
2374 }
2375
2376 /**
2377 * Render inline CSS
2378 *
2379 * @return string
2380 */
2381 protected function renderCssInline() {
2382 $cssInline = '';
2383 if (count($this->cssInline)) {
2384 foreach ($this->cssInline as $name => $properties) {
2385 $cssCode = '/*' . htmlspecialchars($name) . '*/' . LF . $properties['code'] . LF;
2386 if ($properties['forceOnTop']) {
2387 $cssInline = $cssCode . $cssInline;
2388 } else {
2389 $cssInline .= $cssCode;
2390 }
2391 }
2392 $cssInline = $this->inlineCssWrap[0] . $cssInline . $this->inlineCssWrap[1];
2393 }
2394 return $cssInline;
2395 }
2396
2397 /**
2398 * Render JavaScipt libraries
2399 *
2400 * @return array<string> jsLibs and jsFooterLibs strings
2401 */
2402 protected function renderAdditionalJavaScriptLibraries() {
2403 $jsLibs = '';
2404 $jsFooterLibs = '';
2405 if (count($this->jsLibs)) {
2406 foreach ($this->jsLibs as $properties) {
2407 $properties['file'] = GeneralUtility::resolveBackPath($properties['file']);
2408 $properties['file'] = GeneralUtility::createVersionNumberedFilename($properties['file']);
2409 $async = ($properties['async']) ? ' async="async"' : '';
2410 $tag = '<script src="' . htmlspecialchars($properties['file']) . '" type="' . htmlspecialchars($properties['type']) . '"' . $async . '></script>';
2411 if ($properties['allWrap']) {
2412 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2413 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2414 }
2415 $tag .= LF;
2416 if ($properties['forceOnTop']) {
2417 if ($properties['section'] === self::PART_HEADER) {
2418 $jsLibs = $tag . $jsLibs;
2419 } else {
2420 $jsFooterLibs = $tag . $jsFooterLibs;
2421 }
2422 } else {
2423 if ($properties['section'] === self::PART_HEADER) {
2424 $jsLibs .= $tag;
2425 } else {
2426 $jsFooterLibs .= $tag;
2427 }
2428 }
2429 }
2430 }
2431 if ($this->moveJsFromHeaderToFooter) {
2432 $jsFooterLibs = $jsLibs . LF . $jsFooterLibs;
2433 $jsLibs = '';
2434 }
2435 return array($jsLibs, $jsFooterLibs);
2436 }
2437
2438 /**
2439 * Render JavaScript files
2440 *
2441 * @return array<string> jsFiles and jsFooterFiles strings
2442 */
2443 protected function renderJavaScriptFiles() {
2444 $jsFiles = '';
2445 $jsFooterFiles = '';
2446 if (count($this->jsFiles)) {
2447 foreach ($this->jsFiles as $file => $properties) {
2448 $file = GeneralUtility::resolveBackPath($file);
2449 $file = GeneralUtility::createVersionNumberedFilename($file);
2450 $async = ($properties['async']) ? ' async="async"' : '';
2451 $tag = '<script src="' . htmlspecialchars($file) . '" type="' . htmlspecialchars($properties['type']) . '"' . $async . '></script>';
2452 if ($properties['allWrap']) {
2453 $wrapArr = explode($properties['splitChar'] ?: '|', $properties['allWrap'], 2);
2454 $tag = $wrapArr[0] . $tag . $wrapArr[1];
2455 }
2456 $tag .= LF;
2457 if ($properties['forceOnTop']) {
2458 if ($properties['section'] === self::PART_HEADER) {
2459 $jsFiles = $tag . $jsFiles;
2460 } else {
2461 $jsFooterFiles = $tag . $jsFooterFiles;
2462 }
2463 } else {
2464 if ($properties['section'] === self::PART_HEADER) {
2465 $jsFiles .= $tag;
2466 } else {
2467 $jsFooterFiles .= $tag;
2468 }
2469 }
2470 }
2471 }
2472 if ($this->moveJsFromHeaderToFooter) {
2473 $jsFooterFiles = $jsFiles . $jsFooterFiles;
2474 $jsFiles = '';
2475 }
2476 return array($jsFiles, $jsFooterFiles);
2477 }
2478
2479 /**
2480 * Render inline JavaScript
2481 *
2482 * @return array<string> jsInline and jsFooterInline string
2483 */
2484 protected function renderInlineJavaScript() {
2485 $jsInline = '';
2486 $jsFooterInline = '';
2487 if (count($this->jsInline)) {
2488 foreach ($this->jsInline as $name => $properties) {
2489 $jsCode = '/*' . htmlspecialchars($name) . '*/' . LF . $properties['code'] . LF;
2490 if ($properties['forceOnTop']) {
2491 if ($properties['section'] === self::PART_HEADER) {
2492 $jsInline = $jsCode . $jsInline;
2493 } else {
2494 $jsFooterInline = $jsCode . $jsFooterInline;
2495 }
2496 } else {
2497 if ($properties['section'] === self::PART_HEADER) {
2498 $jsInline .= $jsCode;
2499 } else {
2500 $jsFooterInline .= $jsCode;
2501 }
2502 }
2503 }
2504 }
2505 if ($jsInline) {
2506 $jsInline = $this->inlineJavascriptWrap[0] . $jsInline . $this->inlineJavascriptWrap[1];
2507 }
2508 if ($jsFooterInline) {
2509 $jsFooterInline = $this->inlineJavascriptWrap[0] . $jsFooterInline . $this->inlineJavascriptWrap[1];
2510 }
2511 if ($this->moveJsFromHeaderToFooter) {
2512 $jsFooterInline = $jsInline . $jsFooterInline;
2513 $jsInline = '';
2514 }
2515 return array($jsInline, $jsFooterInline);
2516 }
2517
2518 /**
2519 * Include language file for inline usage
2520 *
2521 * @param string $fileRef
2522 * @param string $selectionPrefix
2523 * @param string $stripFromSelectionName
2524 * @param int $errorMode
2525 * @return void
2526 * @throws \RuntimeException
2527 */
2528 protected function includeLanguageFileForInline($fileRef, $selectionPrefix = '', $stripFromSelectionName = '', $errorMode = 0) {
2529 if (!isset($this->lang) || !isset($this->charSet)) {
2530 throw new \RuntimeException('Language and character encoding are not set.', 1284906026);
2531 }
2532 $labelsFromFile = array();
2533 $allLabels = $this->readLLfile($fileRef, $errorMode);
2534 // Regular expression to strip the selection prefix and possibly something from the label name:
2535 $labelPattern = '#^' . preg_quote($selectionPrefix, '#') . '(' . preg_quote($stripFromSelectionName, '#') . ')?#';
2536 if ($allLabels !== FALSE) {
2537 // Merge language specific translations:
2538 if ($this->lang !== 'default' && isset($allLabels[$this->lang])) {
2539 $labels = array_merge($allLabels['default'], $allLabels[$this->lang]);
2540 } else {
2541 $labels = $allLabels['default'];
2542 }
2543 // Iterate through all locallang labels:
2544 foreach ($labels as $label => $value) {
2545 if ($selectionPrefix === '') {
2546 $labelsFromFile[$label] = $value;
2547 } elseif (strpos($label, $selectionPrefix) === 0) {
2548 preg_replace($labelPattern, '', $label);
2549 $labelsFromFile[$label] = $value;
2550 }
2551 }
2552 $this->inlineLanguageLabels = array_merge($this->inlineLanguageLabels, $labelsFromFile);
2553 }
2554 }
2555
2556 /**
2557 * Reads a locallang file.
2558 *
2559 * @param string $fileRef Reference to a relative filename to include.
2560 * @param int $errorMode Error mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception
2561 * @return array Returns the $LOCAL_LANG array found in the file. If no array found, returns empty array.
2562 */
2563 protected function readLLfile($fileRef, $errorMode = 0) {
2564 if ($this->lang !== 'default') {
2565 $languages = array_reverse($this->languageDependencies);
2566 // At least we need to have English
2567 if (empty($languages)) {
2568 $languages[] = 'default';
2569 }
2570 } else {
2571 $languages = array('default');
2572 }
2573
2574 $localLanguage = array();
2575 foreach ($languages as $language) {
2576 $tempLL = GeneralUtility::readLLfile($fileRef, $language, $this->charSet, $errorMode);
2577 $localLanguage['default'] = $tempLL['default'];
2578 if (!isset($localLanguage[$this->lang])) {
2579 $localLanguage[$this->lang] = $localLanguage['default'];
2580 }
2581 if ($this->lang !== 'default' && isset($tempLL[$language])) {
2582 // Merge current language labels onto labels from previous language
2583 // This way we have a labels with fall back applied
2584 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($localLanguage[$this->lang], $tempLL[$language], TRUE, FALSE);
2585 }
2586 }
2587
2588 return $localLanguage;
2589 }
2590
2591
2592 /*****************************************************/
2593 /* */
2594 /* Tools */
2595 /* */
2596 /*****************************************************/
2597 /**
2598 * Concatenate files into one file
2599 * registered handler
2600 *
2601 * @return void
2602 */
2603 protected function doConcatenate() {
2604 $this->doConcatenateCss();
2605 $this->doConcatenateJavaScript();
2606 }
2607
2608 /**
2609 * Concatenate JavaScript files according to the configuration.
2610 *
2611 * @return void
2612 */
2613 protected function doConcatenateJavaScript() {
2614 if ($this->concatenateFiles || $this->concatenateJavascript) {
2615 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsConcatenateHandler'])) {
2616 // use external concatenation routine
2617 $params = array(
2618 'jsLibs' => &$this->jsLibs,
2619 'jsFiles' => &$this->jsFiles,
2620 'jsFooterFiles' => &$this->jsFooterFiles,
2621 'headerData' => &$this->headerData,
2622 'footerData' => &$this->footerData
2623 );
2624 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsConcatenateHandler'], $params, $this);
2625 } else {
2626 $this->jsLibs = $this->getCompressor()->concatenateJsFiles($this->jsLibs);
2627 $this->jsFiles = $this->getCompressor()->concatenateJsFiles($this->jsFiles);
2628 $this->jsFooterFiles = $this->getCompressor()->concatenateJsFiles($this->jsFooterFiles);
2629 }
2630 }
2631 }
2632
2633 /**
2634 * Concatenate CSS files according to configuration.
2635 *
2636 * @return void
2637 */
2638 protected function doConcatenateCss() {
2639 if ($this->concatenateFiles || $this->concatenateCss) {
2640 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssConcatenateHandler'])) {
2641 // use external concatenation routine
2642 $params = array(
2643 'cssFiles' => &$this->cssFiles,
2644 'headerData' => &$this->headerData,
2645 'footerData' => &$this->footerData
2646 );
2647 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssConcatenateHandler'], $params, $this);
2648 } else {
2649 $cssOptions = array();
2650 if (TYPO3_MODE === 'BE') {
2651 $cssOptions = array('baseDirectories' => $GLOBALS['TBE_TEMPLATE']->getSkinStylesheetDirectories());
2652 }
2653 $this->cssFiles = $this->getCompressor()->concatenateCssFiles($this->cssFiles, $cssOptions);
2654 }
2655 }
2656 }
2657
2658 /**
2659 * Compresses inline code
2660 *
2661 * @return void
2662 */
2663 protected function doCompress() {
2664 $this->doCompressJavaScript();
2665 $this->doCompressCss();
2666 }
2667
2668 /**
2669 * Compresses CSS according to configuration.
2670 *
2671 * @return void
2672 */
2673 protected function doCompressCss() {
2674 if ($this->compressCss) {
2675 // Use external compression routine
2676 $params = array(
2677 'cssInline' => &$this->cssInline,
2678 'cssFiles' => &$this->cssFiles,
2679 'headerData' => &$this->headerData,
2680 'footerData' => &$this->footerData
2681 );
2682 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssCompressHandler'])) {
2683 // use external concatenation routine
2684 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssCompressHandler'], $params, $this);
2685 } else {
2686 $this->cssFiles = $this->getCompressor()->compressCssFiles($this->cssFiles);
2687 }
2688 }
2689 }
2690
2691 /**
2692 * Compresses JavaScript according to configuration.
2693 *
2694 * @return void
2695 */
2696 protected function doCompressJavaScript() {
2697 if ($this->compressJavascript) {
2698 if (!empty($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsCompressHandler'])) {
2699 // Use external compression routine
2700 $params = array(
2701 'jsInline' => &$this->jsInline,
2702 'jsFooterInline' => &$this->jsFooterInline,
2703 'jsLibs' => &$this->jsLibs,
2704 'jsFiles' => &$this->jsFiles,
2705 'jsFooterFiles' => &$this->jsFooterFiles,
2706 'headerData' => &$this->headerData,
2707 'footerData' => &$this->footerData
2708 );
2709 GeneralUtility::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsCompressHandler'], $params, $this);
2710 } else {
2711 // Traverse the arrays, compress files
2712 if (count($this->jsInline)) {
2713 foreach ($this->jsInline as $name => $properties) {
2714 if ($properties['compress']) {
2715 $error = '';
2716 $this->jsInline[$name]['code'] = GeneralUtility::minifyJavaScript($properties['code'], $error);
2717 if ($error) {
2718 $this->compressError .= 'Error with minify JS Inline Block "' . $name . '": ' . $error . LF;
2719 }
2720 }
2721 }
2722 }
2723 $this->jsLibs = $this->getCompressor()->compressJsFiles($this->jsLibs);
2724 $this->jsFiles = $this->getCompressor()->compressJsFiles($this->jsFiles);
2725 $this->jsFooterFiles = $this->getCompressor()->compressJsFiles($this->jsFooterFiles);
2726 }
2727 }
2728 }
2729
2730 /**
2731 * Returns instance of \TYPO3\CMS\Core\Resource\ResourceCompressor
2732 *
2733 * @return \TYPO3\CMS\Core\Resource\ResourceCompressor
2734 */
2735 protected function getCompressor() {
2736 if ($this->compressor === NULL) {
2737 $this->compressor = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Resource\ResourceCompressor::class);
2738 }
2739 return $this->compressor;
2740 }
2741
2742 /**
2743 * Processes a Javascript file dependent on the current context
2744 *
2745 * Adds the version number for Frontend, compresses the file for Backend
2746 *
2747 * @param string $filename Filename
2748 * @return string New filename
2749 */
2750 protected function processJsFile($filename) {
2751 switch (TYPO3_MODE) {
2752 case 'FE':
2753 if ($this->compressJavascript) {
2754 $filename = $this->getCompressor()->compressJsFile($filename);
2755 } else {
2756 $filename = GeneralUtility::createVersionNumberedFilename($filename);
2757 }
2758 break;
2759 case 'BE':
2760 if ($this->compressJavascript) {
2761 $filename = $this->getCompressor()->compressJsFile($filename);
2762 }
2763 break;
2764 }
2765 return $filename;
2766 }
2767
2768 /*****************************************************/
2769 /* */
2770 /* Hooks */
2771 /* */
2772 /*****************************************************/
2773 /**
2774 * Execute PreRenderHook for possible manipulation
2775 *
2776 * @return void
2777 */
2778 protected function executePreRenderHook() {
2779 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-preProcess'])) {
2780 $params = array(
2781 'jsLibs' => &$this->jsLibs,
2782 'jsFooterLibs' => &$this->jsFooterLibs,
2783 'jsFiles' => &$this->jsFiles,
2784 'jsFooterFiles' => &$this->jsFooterFiles,
2785 'cssFiles' => &$this->cssFiles,
2786 'headerData' => &$this->headerData,
2787 'footerData' => &$this->footerData,
2788 'jsInline' => &$this->jsInline,
2789 'jsFooterInline' => &$this->jsFooterInline,
2790 'cssInline' => &$this->cssInline
2791 );
2792 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-preProcess'] as $hook) {
2793 GeneralUtility::callUserFunction($hook, $params, $this);
2794 }
2795 }
2796 }
2797
2798 /**
2799 * PostTransform for possible manipulation of concatenated and compressed files
2800 *
2801 * @return void
2802 */
2803 protected function executeRenderPostTransformHook() {
2804 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postTransform'])) {
2805 $params = array(
2806 'jsLibs' => &$this->jsLibs,
2807 'jsFooterLibs' => &$this->jsFooterLibs,
2808 'jsFiles' => &$this->jsFiles,
2809 'jsFooterFiles' => &$this->jsFooterFiles,
2810 'cssFiles' => &$this->cssFiles,
2811 'headerData' => &$this->headerData,
2812 'footerData' => &$this->footerData,
2813 'jsInline' => &$this->jsInline,
2814 'jsFooterInline' => &$this->jsFooterInline,
2815 'cssInline' => &$this->cssInline
2816 );
2817 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postTransform'] as $hook) {
2818 GeneralUtility::callUserFunction($hook, $params, $this);
2819 }
2820 }
2821 }
2822
2823 /**
2824 * Execute postRenderHook for possible manipulation
2825 *
2826 * @param $jsLibs string
2827 * @param $jsFiles string
2828 * @param $jsFooterFiles string
2829 * @param $cssLibs string
2830 * @param $cssFiles string
2831 * @param $jsInline string
2832 * @param $cssInline string
2833 * @param $jsFooterInline string
2834 * @param $jsFooterLibs string
2835 * @return void
2836 */
2837 protected function executePostRenderHook(&$jsLibs, &$jsFiles, &$jsFooterFiles, &$cssLibs, &$cssFiles, &$jsInline, &$cssInline, &$jsFooterInline, &$jsFooterLibs) {
2838 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postProcess'])) {
2839 $params = array(
2840 'jsLibs' => &$jsLibs,
2841 'jsFiles' => &$jsFiles,
2842 'jsFooterFiles' => &$jsFooterFiles,
2843 'cssLibs' => &$cssLibs,
2844 'cssFiles' => &$cssFiles,
2845 'headerData' => &$this->headerData,
2846 'footerData' => &$this->footerData,
2847 'jsInline' => &$jsInline,
2848 'cssInline' => &$cssInline,
2849 'xmlPrologAndDocType' => &$this->xmlPrologAndDocType,
2850 'htmlTag' => &$this->htmlTag,
2851 'headTag' => &$this->headTag,
2852 'charSet' => &$this->charSet,
2853 'metaCharsetTag' => &$this->metaCharsetTag,
2854 'shortcutTag' => &$this->shortcutTag,
2855 'inlineComments' => &$this->inlineComments,
2856 'baseUrl' => &$this->baseUrl,
2857 'baseUrlTag' => &$this->baseUrlTag,
2858 'favIcon' => &$this->favIcon,
2859 'iconMimeType' => &$this->iconMimeType,
2860 'titleTag' => &$this->titleTag,
2861 'title' => &$this->title,
2862 'metaTags' => &$this->metaTags,
2863 'jsFooterInline' => &$jsFooterInline,
2864 'jsFooterLibs' => &$jsFooterLibs,
2865 'bodyContent' => &$this->bodyContent
2866 );
2867 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_pagerenderer.php']['render-postProcess'] as $hook) {
2868 GeneralUtility::callUserFunction($hook, $params, $this);
2869 }
2870 }
2871 }
2872
2873 }