-
-
Notifications
You must be signed in to change notification settings - Fork 160
/
Controller.php
1576 lines (1324 loc) · 41.1 KB
/
Controller.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
* This file is part of Contao.
*
* (c) Leo Feyer
*
* @license LGPL-3.0-or-later
*/
namespace Contao;
use Contao\CoreBundle\Asset\ContaoContext;
use Contao\CoreBundle\Exception\AccessDeniedException;
use Contao\CoreBundle\Exception\AjaxRedirectResponseException;
use Contao\CoreBundle\Exception\PageNotFoundException;
use Contao\CoreBundle\Exception\RedirectResponseException;
use Contao\CoreBundle\Fragment\Reference\ContentElementReference;
use Contao\CoreBundle\Framework\ContaoFramework;
use Contao\CoreBundle\Security\ContaoCorePermissions;
use Contao\CoreBundle\Twig\Inheritance\TemplateHierarchyInterface;
use Contao\Database\Result;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\Glob;
/**
* Abstract parent class for Controllers
*
* Some of the methods have been made static in Contao 3 and can be used in
* non-object context as well.
*
* Usage:
*
* echo Controller::getTheme();
*
* Inside a controller:
*
* public function generate()
* {
* return $this->getArticle(2);
* }
*/
abstract class Controller extends System
{
/**
* @var array
*/
protected static $arrQueryCache = array();
/**
* Find a particular template file and return its path
*
* @param string $strTemplate The name of the template
*
* @return string The path to the template file
*
* @throws \RuntimeException If the template group folder is insecure
*/
public static function getTemplate($strTemplate)
{
$strTemplate = basename($strTemplate);
$request = System::getContainer()->get('request_stack')->getCurrentRequest();
// Check for a theme folder
if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isFrontendRequest($request))
{
/** @var PageModel|null $objPage */
global $objPage;
if ($objPage->templateGroup ?? null)
{
if (Validator::isInsecurePath($objPage->templateGroup))
{
throw new \RuntimeException('Invalid path ' . $objPage->templateGroup);
}
return TemplateLoader::getPath($strTemplate, 'html5', $objPage->templateGroup);
}
}
return TemplateLoader::getPath($strTemplate, 'html5');
}
/**
* Return all template files of a particular group as array
*
* @param string $strPrefix The template name prefix (e.g. "ce_")
* @param array $arrAdditionalMapper An additional mapper array
* @param string $strDefaultTemplate An optional default template
*
* @return array An array of template names
*/
public static function getTemplateGroup($strPrefix, array $arrAdditionalMapper=array(), $strDefaultTemplate='')
{
if (str_contains($strPrefix, '/') || str_contains($strDefaultTemplate, '/'))
{
throw new \InvalidArgumentException(sprintf('Using %s() with modern fragment templates is not supported. Use the "contao.twig.finder_factory" service instead.', __METHOD__));
}
$arrTemplates = array();
$arrBundleTemplates = array();
$arrMapper = array_merge
(
$arrAdditionalMapper,
array
(
'ce' => array_keys(array_merge(...array_values($GLOBALS['TL_CTE']))),
'form' => array_keys($GLOBALS['TL_FFL']),
'mod' => array_keys(array_merge(...array_values($GLOBALS['FE_MOD']))),
)
);
// Add templates that are not directly associated with a form field
$arrMapper['form'][] = 'row';
$arrMapper['form'][] = 'row_double';
$arrMapper['form'][] = 'xml';
$arrMapper['form'][] = 'wrapper';
$arrMapper['form'][] = 'message';
// Add templates that are not directly associated with a module
$arrMapper['mod'][] = 'article';
$arrMapper['mod'][] = 'message';
/** @var TemplateHierarchyInterface $templateHierarchy */
$templateHierarchy = System::getContainer()->get('contao.twig.filesystem_loader');
$identifierPattern = sprintf('/^%s%s/', preg_quote($strPrefix, '/'), !str_ends_with($strPrefix, '_') ? '($|_)' : '');
$prefixedFiles = array_merge(
array_filter(
array_keys($templateHierarchy->getInheritanceChains()),
static fn (string $identifier): bool => 1 === preg_match($identifierPattern, $identifier),
),
// Merge with the templates from the TemplateLoader for backwards
// compatibility in case someone has added templates manually
TemplateLoader::getPrefixedFiles($strPrefix),
);
foreach ($prefixedFiles as $strTemplate)
{
if ($strTemplate != $strPrefix)
{
list($k, $strKey) = explode('_', $strTemplate, 2);
if (isset($arrMapper[$k]) && \in_array($strKey, $arrMapper[$k]))
{
$arrBundleTemplates[] = $strTemplate;
continue;
}
}
$arrTemplates[$strTemplate][] = 'root';
}
$strGlobPrefix = $strPrefix;
$projectDir = System::getContainer()->getParameter('kernel.project_dir');
$arrCustomized = self::braceGlob($projectDir . '/templates/' . $strGlobPrefix . '*.html5');
// Add the customized templates
if (!empty($arrCustomized) && \is_array($arrCustomized))
{
$blnIsGroupPrefix = preg_match('/^[a-z]+_$/', $strPrefix);
foreach ($arrCustomized as $strFile)
{
$strTemplate = basename($strFile, strrchr($strFile, '.'));
if (str_contains($strTemplate, '-'))
{
throw new \RuntimeException(sprintf('Using hyphens in the template name "%s" is not allowed, use snake_case instead.', $strTemplate));
}
// Ignore bundle templates, e.g. mod_article and mod_article_list
if (\in_array($strTemplate, $arrBundleTemplates))
{
continue;
}
// Also ignore custom templates belonging to a different bundle template,
// e.g. mod_article and mod_article_list_custom
if (!$blnIsGroupPrefix)
{
foreach ($arrBundleTemplates as $strKey)
{
if (str_starts_with($strTemplate, $strKey . '_'))
{
continue 2;
}
}
}
$arrTemplates[$strTemplate][] = $GLOBALS['TL_LANG']['MSC']['global'] ?? 'global';
}
}
$arrDefaultPlaces = array();
if ($strDefaultTemplate)
{
$arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['default'];
if (file_exists($projectDir . '/templates/' . $strDefaultTemplate . '.html5'))
{
$arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['global'];
}
}
// Do not look for back end templates in theme folders (see #5379)
if ($strPrefix != 'be_' && $strPrefix != 'mail_')
{
// Try to select the themes (see #5210)
try
{
$objTheme = ThemeModel::findAll(array('order'=>'name'));
}
catch (\Throwable $e)
{
$objTheme = null;
}
// Add the theme templates
if ($objTheme !== null)
{
while ($objTheme->next())
{
if (!$objTheme->templates)
{
continue;
}
if ($strDefaultTemplate && file_exists($projectDir . '/' . $objTheme->templates . '/' . $strDefaultTemplate . '.html5'))
{
$arrDefaultPlaces[] = $objTheme->name;
}
$arrThemeTemplates = self::braceGlob($projectDir . '/' . $objTheme->templates . '/' . $strGlobPrefix . '*.html5');
if (!empty($arrThemeTemplates) && \is_array($arrThemeTemplates))
{
foreach ($arrThemeTemplates as $strFile)
{
$strTemplate = basename($strFile, strrchr($strFile, '.'));
$arrTemplates[$strTemplate][] = $objTheme->name;
}
}
}
}
}
// Show the template sources (see #6875)
foreach ($arrTemplates as $k=>$v)
{
$v = array_filter($v, static function ($a) {
return $a != 'root';
});
if (empty($v))
{
$arrTemplates[$k] = $k;
}
else
{
$arrTemplates[$k] = $k . ' (' . implode(', ', $v) . ')';
}
}
// Sort the template names
ksort($arrTemplates);
if ($strDefaultTemplate)
{
if (!empty($arrDefaultPlaces))
{
$strDefaultTemplate .= ' (' . implode(', ', $arrDefaultPlaces) . ')';
}
$arrTemplates = array('' => $strDefaultTemplate) + $arrTemplates;
}
return $arrTemplates;
}
/**
* Generate a front end module and return it as string
*
* @param mixed $intId A module ID or a Model object
* @param string $strColumn The name of the column
*
* @return string The module HTML markup
*/
public static function getFrontendModule($intId, $strColumn='main')
{
if (!\is_object($intId) && !\strlen($intId))
{
return '';
}
/** @var PageModel $objPage */
global $objPage;
// Articles
if (!\is_object($intId) && $intId == 0)
{
// Show a particular article only
if ($objPage->type == 'regular' && Input::get('articles'))
{
$strArticle = Input::get('articles');
if (str_contains($strArticle, ':'))
{
trigger_deprecation('contao/core-bundle', '5.3', 'Passing the column of an article in the URL is deprecated. Only provide the article alias instead.');
list(, $strArticle) = explode(':', Input::get('articles'));
}
$objArticle = ArticleModel::findPublishedByIdOrAliasAndPid($strArticle, $objPage->id);
// Send a 404 header if there is no published article
if (null === $objArticle)
{
throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
}
if ($objArticle->inColumn == $strColumn)
{
// Send a 403 header if the article cannot be accessed
if (!static::isVisibleElement($objArticle))
{
throw new AccessDeniedException('Access denied: ' . Environment::get('uri'));
}
return static::getArticle($objArticle);
}
}
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['getArticles']) && \is_array($GLOBALS['TL_HOOKS']['getArticles']))
{
foreach ($GLOBALS['TL_HOOKS']['getArticles'] as $callback)
{
$return = static::importStatic($callback[0])->{$callback[1]}($objPage->id, $strColumn);
if (\is_string($return))
{
return $return;
}
}
}
// Show all articles (no else block here, see #4740)
$objArticles = ArticleModel::findPublishedByPidAndColumn($objPage->id, $strColumn);
if ($objArticles === null)
{
return '';
}
$return = '';
$blnMultiMode = $objArticles->count() > 1;
while ($objArticles->next())
{
$return .= static::getArticle($objArticles->current(), $blnMultiMode, false, $strColumn);
}
return $return;
}
// Other modules
if (\is_object($intId))
{
$objRow = $intId;
}
else
{
$objRow = ModuleModel::findByPk($intId);
if ($objRow === null)
{
return '';
}
}
// Check the visibility (see #6311)
if (!static::isVisibleElement($objRow))
{
return '';
}
$strClass = Module::findClass($objRow->type);
// Return if the class does not exist
if (!class_exists($strClass))
{
System::getContainer()->get('monolog.logger.contao.error')->error('Module class "' . $strClass . '" (module "' . $objRow->type . '") does not exist');
return '';
}
$strStopWatchId = 'contao.frontend_module.' . $objRow->type . ' (ID ' . $objRow->id . ')';
if (System::getContainer()->getParameter('kernel.debug') && System::getContainer()->has('debug.stopwatch'))
{
$objStopwatch = System::getContainer()->get('debug.stopwatch');
$objStopwatch->start($strStopWatchId, 'contao.layout');
}
$objRow->typePrefix = 'mod_';
/** @var Module $objModule */
$objModule = new $strClass($objRow, $strColumn);
$strBuffer = $objModule->generate();
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['getFrontendModule']) && \is_array($GLOBALS['TL_HOOKS']['getFrontendModule']))
{
foreach ($GLOBALS['TL_HOOKS']['getFrontendModule'] as $callback)
{
$strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objModule);
}
}
// Disable indexing if protected
if ($objModule->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
{
$strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
}
if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
{
$objStopwatch->stop($strStopWatchId);
}
return $strBuffer;
}
/**
* Generate an article and return it as string
*
* @param mixed $varId The article ID or a Model object
* @param boolean $blnMultiMode If true, only teasers will be shown
* @param boolean $blnIsInsertTag If true, there will be no page relation
* @param string $strColumn The name of the column
*
* @return string|boolean The article HTML markup or false
*/
public static function getArticle($varId, $blnMultiMode=false, $blnIsInsertTag=false, $strColumn='main')
{
/** @var PageModel $objPage */
global $objPage;
if (\is_object($varId))
{
$objRow = $varId;
}
else
{
if (!$varId)
{
return '';
}
$objRow = ArticleModel::findByIdOrAliasAndPid($varId, !$blnIsInsertTag ? $objPage->id : null);
if ($objRow === null)
{
return false;
}
}
// Check the visibility (see #6311)
if (!static::isVisibleElement($objRow))
{
return '';
}
$objRow->headline = $objRow->title;
$objRow->multiMode = $blnMultiMode;
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['getArticle']) && \is_array($GLOBALS['TL_HOOKS']['getArticle']))
{
foreach ($GLOBALS['TL_HOOKS']['getArticle'] as $callback)
{
static::importStatic($callback[0])->{$callback[1]}($objRow);
}
}
$strStopWatchId = 'contao.article (ID ' . $objRow->id . ')';
if (System::getContainer()->getParameter('kernel.debug') && System::getContainer()->has('debug.stopwatch'))
{
$objStopwatch = System::getContainer()->get('debug.stopwatch');
$objStopwatch->start($strStopWatchId, 'contao.layout');
}
$objArticle = new ModuleArticle($objRow, $strColumn);
$strBuffer = $objArticle->generate($blnIsInsertTag);
// Disable indexing if protected
if ($objArticle->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
{
$strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
}
if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
{
$objStopwatch->stop($strStopWatchId);
}
return $strBuffer;
}
/**
* Generate a content element and return it as string
*
* @param mixed $intId A content element ID, a Model object or a ContentElementReference
* @param string $strColumn The column the element is in
*
* @return string The content element HTML markup
*/
public static function getContentElement($intId, $strColumn='main')
{
$contentElementReference = null;
if ($intId instanceof ContentElementReference)
{
if (\func_num_args() > 1)
{
throw new \InvalidArgumentException('Passing a column name is not supported when using a ContentElementReference.');
}
$contentElementReference = $intId;
$strColumn = $contentElementReference->getSection();
$intId = $contentElementReference->getContentModel();
}
if (\is_object($intId))
{
$objRow = $intId;
}
else
{
if ($intId < 1 || !\strlen($intId))
{
return '';
}
$objRow = ContentModel::findByPk($intId);
if ($objRow === null)
{
return '';
}
}
// Check the visibility (see #6311)
if (!static::isVisibleElement($objRow))
{
return '';
}
$strClass = ContentElement::findClass($objRow->type);
// Return if the class does not exist
if (!class_exists($strClass))
{
System::getContainer()->get('monolog.logger.contao.error')->error('Content element class "' . $strClass . '" (content element "' . $objRow->type . '") does not exist');
return '';
}
$objRow->typePrefix = 'ce_';
$strStopWatchId = 'contao.content_element.' . $objRow->type . ' (ID ' . $objRow->id . ')';
if ($objRow->type != 'module' && System::getContainer()->getParameter('kernel.debug') && System::getContainer()->has('debug.stopwatch'))
{
$objStopwatch = System::getContainer()->get('debug.stopwatch');
$objStopwatch->start($strStopWatchId, 'contao.layout');
}
$isContentProxy = is_a($strClass, ContentProxy::class, true);
$compositor = System::getContainer()->get('contao.fragment.compositor');
if ($isContentProxy && $contentElementReference)
{
$objElement = new $strClass($contentElementReference, $strColumn);
}
elseif ($isContentProxy && $objRow->id && $compositor->supportsNesting(ContentElementReference::TAG_NAME . '.' . $objRow->type))
{
$objElement = new $strClass(
$objRow,
$strColumn,
$compositor->getNestedFragments(ContentElementReference::TAG_NAME . '.' . $objRow->type, $objRow->id)
);
}
else
{
/** @var ContentElement $objElement */
$objElement = new $strClass($objRow, $strColumn);
}
$strBuffer = $objElement->generate();
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['getContentElement']) && \is_array($GLOBALS['TL_HOOKS']['getContentElement']))
{
foreach ($GLOBALS['TL_HOOKS']['getContentElement'] as $callback)
{
$strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
}
}
// Disable indexing if protected
if ($objElement->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
{
$strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
}
if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
{
$objStopwatch->stop($strStopWatchId);
}
return $strBuffer;
}
/**
* Generate a form and return it as string
*
* @param mixed $varId A form ID or a Model object
* @param string $strColumn The column the form is in
* @param boolean $blnModule Render the form as module
*
* @return string The form HTML markup
*/
public static function getForm($varId, $strColumn='main', $blnModule=false)
{
if (\is_object($varId))
{
$objRow = $varId;
}
else
{
if (!$varId)
{
return '';
}
$objRow = FormModel::findByIdOrAlias($varId);
if ($objRow === null)
{
return '';
}
}
$strClass = $blnModule ? Module::findClass('form') : ContentElement::findClass('form');
if (!class_exists($strClass))
{
System::getContainer()->get('monolog.logger.contao.error')->error('Form class "' . $strClass . '" does not exist');
return '';
}
$objRow->typePrefix = $blnModule ? 'mod_' : 'ce_';
$objRow->form = $objRow->id;
/** @var Form $objElement */
$objElement = new $strClass($objRow, $strColumn);
$strBuffer = $objElement->generate();
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['getForm']) && \is_array($GLOBALS['TL_HOOKS']['getForm']))
{
foreach ($GLOBALS['TL_HOOKS']['getForm'] as $callback)
{
$strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
}
}
return $strBuffer;
}
/**
* Calculate the page status icon name based on the page parameters
*
* @param PageModel|Result|\stdClass $objPage The page object
*
* @return string The status icon name
*/
public static function getPageStatusIcon($objPage)
{
$sub = 0;
$type = \in_array($objPage->type, array('regular', 'root', 'forward', 'redirect', 'error_401', 'error_403', 'error_404', 'error_503', 'logout'), true) ? $objPage->type : 'regular';
$image = $type . '.svg';
// Page not published or not active
if (!$objPage->published || ($objPage->start && $objPage->start > time()) || ($objPage->stop && $objPage->stop <= time()))
{
++$sub;
}
// Page hidden from menu
if ($objPage->hide && !\in_array($type, array('root', 'error_401', 'error_403', 'error_404', 'error_503')))
{
$sub += 2;
}
// Page protected
if ($objPage->protected && !\in_array($type, array('root', 'error_401', 'error_403', 'error_404', 'error_503')))
{
$sub += 4;
}
// Change icon if root page is published and in maintenance mode
if ($sub == 0 && $objPage->type == 'root' && $objPage->maintenanceMode)
{
$sub = 2;
}
// Get the image name
if ($sub > 0)
{
$image = $type . '_' . $sub . '.svg';
}
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['getPageStatusIcon']) && \is_array($GLOBALS['TL_HOOKS']['getPageStatusIcon']))
{
foreach ($GLOBALS['TL_HOOKS']['getPageStatusIcon'] as $callback)
{
$image = static::importStatic($callback[0])->{$callback[1]}($objPage, $image);
}
}
return $image;
}
/**
* Check whether an element is visible in the front end
*
* @param Model|ContentModel|ModuleModel $objElement The element model
*
* @return boolean True if the element is visible
*/
public static function isVisibleElement(Model $objElement)
{
$blnReturn = true;
$request = System::getContainer()->get('request_stack')->getCurrentRequest();
// Only apply the restrictions in the front end
if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isFrontendRequest($request) && $objElement->protected)
{
$groups = StringUtil::deserialize($objElement->groups, true);
$security = System::getContainer()->get('security.helper');
$blnReturn = $security->isGranted(ContaoCorePermissions::MEMBER_IN_GROUPS, $groups);
}
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['isVisibleElement']) && \is_array($GLOBALS['TL_HOOKS']['isVisibleElement']))
{
foreach ($GLOBALS['TL_HOOKS']['isVisibleElement'] as $callback)
{
$blnReturn = static::importStatic($callback[0])->{$callback[1]}($objElement, $blnReturn);
}
}
return $blnReturn;
}
/**
* Replace the dynamic script tags (see #4203)
*
* @param string $strBuffer The string with the tags to be replaced
*
* @return string The string with the replaced tags
*/
public static function replaceDynamicScriptTags($strBuffer)
{
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']) && \is_array($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']))
{
foreach ($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags'] as $callback)
{
$strBuffer = static::importStatic($callback[0])->{$callback[1]}($strBuffer);
}
}
$arrReplace = array();
$strScripts = '';
// Add the internal jQuery scripts
if (!empty($GLOBALS['TL_JQUERY']) && \is_array($GLOBALS['TL_JQUERY']))
{
$strScripts .= implode('', array_unique($GLOBALS['TL_JQUERY']));
}
$nonce = ContaoFramework::getNonce();
$arrReplace["[[TL_JQUERY_$nonce]]"] = $strScripts;
$strScripts = '';
// Add the internal MooTools scripts
if (!empty($GLOBALS['TL_MOOTOOLS']) && \is_array($GLOBALS['TL_MOOTOOLS']))
{
$strScripts .= implode('', array_unique($GLOBALS['TL_MOOTOOLS']));
}
$arrReplace["[[TL_MOOTOOLS_$nonce]]"] = $strScripts;
$strScripts = '';
// Add the internal <body> tags
if (!empty($GLOBALS['TL_BODY']) && \is_array($GLOBALS['TL_BODY']))
{
$strScripts .= implode('', array_unique($GLOBALS['TL_BODY']));
}
/** @var PageModel|null $objPage */
global $objPage;
$objLayout = ($objPage !== null) ? LayoutModel::findByPk($objPage->layoutId) : null;
$blnCombineScripts = $objLayout !== null && $objLayout->combineScripts;
$arrReplace["[[TL_BODY_$nonce]]"] = $strScripts;
$strScripts = '';
$objCombiner = new Combiner();
// Add the CSS framework style sheets
if (!empty($GLOBALS['TL_FRAMEWORK_CSS']) && \is_array($GLOBALS['TL_FRAMEWORK_CSS']))
{
foreach (array_unique($GLOBALS['TL_FRAMEWORK_CSS']) as $stylesheet)
{
$objCombiner->add($stylesheet);
}
}
// Add the internal style sheets
if (!empty($GLOBALS['TL_CSS']) && \is_array($GLOBALS['TL_CSS']))
{
foreach (array_unique($GLOBALS['TL_CSS']) as $stylesheet)
{
$options = StringUtil::resolveFlaggedUrl($stylesheet);
if ($options->static)
{
$objCombiner->add($stylesheet, $options->mtime, $options->media);
}
else
{
$strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
}
}
}
// Add the user style sheets
if (!empty($GLOBALS['TL_USER_CSS']) && \is_array($GLOBALS['TL_USER_CSS']))
{
foreach (array_unique($GLOBALS['TL_USER_CSS']) as $stylesheet)
{
$options = StringUtil::resolveFlaggedUrl($stylesheet);
if ($options->static)
{
$objCombiner->add($stylesheet, $options->mtime, $options->media);
}
else
{
$strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
}
}
}
// Create the aggregated style sheet
if ($objCombiner->hasEntries())
{
if ($blnCombineScripts)
{
$strScripts .= Template::generateStyleTag($objCombiner->getCombinedFile(), 'all');
}
else
{
foreach ($objCombiner->getFileUrls() as $strUrl)
{
$options = StringUtil::resolveFlaggedUrl($strUrl);
$strScripts .= Template::generateStyleTag($strUrl, $options->media, $options->mtime);
}
}
}
$arrReplace["[[TL_CSS_$nonce]]"] = $strScripts;
$strScripts = '';
// Add the internal scripts
if (!empty($GLOBALS['TL_JAVASCRIPT']) && \is_array($GLOBALS['TL_JAVASCRIPT']))
{
$objCombiner = new Combiner();
$objCombinerAsync = new Combiner();
$objCombinerDefer = new Combiner();
foreach (array_unique($GLOBALS['TL_JAVASCRIPT']) as $javascript)
{
$options = StringUtil::resolveFlaggedUrl($javascript);
if ($options->static)
{
if ($options->async)
{
$objCombinerAsync->add($javascript, $options->mtime);
}
elseif ($options->defer)
{
$objCombinerDefer->add($javascript, $options->mtime);
}
else
{
$objCombiner->add($javascript, $options->mtime);
}
}
else
{
$strScripts .= Template::generateScriptTag(static::addAssetsUrlTo($javascript), $options->async, $options->mtime, null, null, null, $options->defer);
}
}
// Create the aggregated script and add it before the non-static scripts (see #4890)
if ($objCombiner->hasEntries())
{
if ($blnCombineScripts)
{
$strScripts = Template::generateScriptTag($objCombiner->getCombinedFile()) . $strScripts;
}
else
{
$arrReversed = array_reverse($objCombiner->getFileUrls());
foreach ($arrReversed as $strUrl)
{
$options = StringUtil::resolveFlaggedUrl($strUrl);
$strScripts = Template::generateScriptTag($strUrl, false, $options->mtime) . $strScripts;
}
}
}
if ($objCombinerAsync->hasEntries())
{
if ($blnCombineScripts)
{
$strScripts = Template::generateScriptTag($objCombinerAsync->getCombinedFile(), true) . $strScripts;
}
else
{
$arrReversed = array_reverse($objCombinerAsync->getFileUrls());
foreach ($arrReversed as $strUrl)
{
$options = StringUtil::resolveFlaggedUrl($strUrl);
$strScripts = Template::generateScriptTag($strUrl, true, $options->mtime) . $strScripts;
}
}
}
if ($objCombinerDefer->hasEntries())
{
if ($blnCombineScripts)
{
$strScripts = Template::generateScriptTag($objCombinerDefer->getCombinedFile(), true) . $strScripts;
}
else
{
$arrReversed = array_reverse($objCombinerDefer->getFileUrls());
foreach ($arrReversed as $strUrl)
{
$options = StringUtil::resolveFlaggedUrl($strUrl);
$strScripts = Template::generateScriptTag($strUrl, false, $options->mtime, null, null, null, true) . $strScripts;
}
}
}
}
// Add the internal <head> tags
if (!empty($GLOBALS['TL_HEAD']) && \is_array($GLOBALS['TL_HEAD']))
{
foreach (array_unique($GLOBALS['TL_HEAD']) as $head)
{
$strScripts .= $head;
}
}
$arrReplace["[[TL_HEAD_$nonce]]"] = $strScripts;
return str_replace(array_keys($arrReplace), $arrReplace, $strBuffer);
}
/**
* Add a request string to the current URL