-
-
Notifications
You must be signed in to change notification settings - Fork 158
/
Module.php
478 lines (410 loc) · 11.7 KB
/
Module.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
<?php
/*
* This file is part of Contao.
*
* (c) Leo Feyer
*
* @license LGPL-3.0-or-later
*/
namespace Contao;
use Contao\Model\Collection;
use FOS\HttpCache\ResponseTagger;
/**
* Parent class for front end modules.
*
* @property integer $id
* @property integer $pid
* @property integer $tstamp
* @property string $name
* @property string $headline
* @property string $type
* @property integer $levelOffset
* @property integer $showLevel
* @property boolean $hardLimit
* @property boolean $showProtected
* @property boolean $defineRoot
* @property integer $rootPage
* @property string $navigationTpl
* @property string $customTpl
* @property array $pages
* @property string $orderPages
* @property boolean $showHidden
* @property string $customLabel
* @property boolean $autologin
* @property integer $jumpTo
* @property boolean $redirectBack
* @property string $cols
* @property array $editable
* @property string $memberTpl
* @property integer $form
* @property string $queryType
* @property boolean $fuzzy
* @property string $contextLength
* @property integer $minKeywordLength
* @property integer $perPage
* @property string $searchType
* @property string $searchTpl
* @property string $inColumn
* @property integer $skipFirst
* @property boolean $loadFirst
* @property string $singleSRC
* @property string $url
* @property string $imgSize
* @property boolean $useCaption
* @property boolean $fullsize
* @property string $multiSRC
* @property string $orderSRC
* @property string $html
* @property integer $rss_cache
* @property string $rss_feed
* @property string $rss_template
* @property integer $numberOfItems
* @property boolean $disableCaptcha
* @property string $reg_groups
* @property boolean $reg_allowLogin
* @property boolean $reg_skipName
* @property string $reg_close
* @property boolean $reg_assignDir
* @property string $reg_homeDir
* @property boolean $reg_activate
* @property integer $reg_jumpTo
* @property string $reg_text
* @property string $reg_password
* @property boolean $protected
* @property string $groups
* @property boolean $guests
* @property string $cssID
* @property string $hl
*
* @author Leo Feyer <https://github.com/leofeyer>
*/
abstract class Module extends Frontend
{
/**
* Template
* @var string
*/
protected $strTemplate;
/**
* Column
* @var string
*/
protected $strColumn;
/**
* Model
* @var ModuleModel
*/
protected $objModel;
/**
* Current record
* @var array
*/
protected $arrData = array();
/**
* Style array
* @var array
*/
protected $arrStyle = array();
/**
* Initialize the object
*
* @param ModuleModel $objModule
* @param string $strColumn
*/
public function __construct($objModule, $strColumn='main')
{
if ($objModule instanceof Model || $objModule instanceof Collection)
{
/** @var ModuleModel $objModel */
$objModel = $objModule;
if ($objModel instanceof Collection)
{
$objModel = $objModel->current();
}
$this->objModel = $objModel;
}
parent::__construct();
$this->arrData = $objModule->row();
$this->cssID = StringUtil::deserialize($objModule->cssID, true);
if ($this->customTpl && TL_MODE == 'FE')
{
$this->strTemplate = $this->customTpl;
}
$arrHeadline = StringUtil::deserialize($objModule->headline);
$this->headline = \is_array($arrHeadline) ? $arrHeadline['value'] : $arrHeadline;
$this->hl = \is_array($arrHeadline) ? $arrHeadline['unit'] : 'h1';
$this->strColumn = $strColumn;
}
/**
* Set an object property
*
* @param string $strKey
* @param mixed $varValue
*/
public function __set($strKey, $varValue)
{
$this->arrData[$strKey] = $varValue;
}
/**
* Return an object property
*
* @param string $strKey
*
* @return mixed
*/
public function __get($strKey)
{
return $this->arrData[$strKey] ?? parent::__get($strKey);
}
/**
* Check whether a property is set
*
* @param string $strKey
*
* @return boolean
*/
public function __isset($strKey)
{
return isset($this->arrData[$strKey]);
}
/**
* Return the model
*
* @return Model
*/
public function getModel()
{
return $this->objModel;
}
/**
* Parse the template
*
* @return string
*/
public function generate()
{
$this->Template = new FrontendTemplate($this->strTemplate);
$this->Template->setData($this->arrData);
$this->compile();
// Do not change this order (see #6191)
$this->Template->style = !empty($this->arrStyle) ? implode(' ', $this->arrStyle) : '';
$this->Template->class = trim('mod_' . $this->type . ' ' . $this->cssID[1]);
$this->Template->cssID = !empty($this->cssID[0]) ? ' id="' . $this->cssID[0] . '"' : '';
$this->Template->inColumn = $this->strColumn;
if ($this->Template->headline == '')
{
$this->Template->headline = $this->headline;
}
if ($this->Template->hl == '')
{
$this->Template->hl = $this->hl;
}
if (!empty($this->objModel->classes) && \is_array($this->objModel->classes))
{
$this->Template->class .= ' ' . implode(' ', $this->objModel->classes);
}
// Tag the response
if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
{
/** @var ResponseTagger $responseTagger */
$responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
$responseTagger->addTags(array('contao.db.tl_module.' . $this->id));
}
return $this->Template->parse();
}
/**
* Compile the current element
*/
abstract protected function compile();
/**
* Recursively compile the navigation menu and return it as HTML string
*
* @param integer $pid
* @param integer $level
* @param string $host
* @param string $language
*
* @return string
*/
protected function renderNavigation($pid, $level=1, $host=null, $language=null)
{
// Get all active subpages
$objSubpages = PageModel::findPublishedSubpagesWithoutGuestsByPid($pid, $this->showHidden, $this instanceof ModuleSitemap);
if ($objSubpages === null)
{
return '';
}
$items = array();
$groups = array();
// Get all groups of the current front end user
if (FE_USER_LOGGED_IN)
{
$this->import(FrontendUser::class, 'User');
$groups = $this->User->groups;
}
$objTemplate = new FrontendTemplate($this->navigationTpl ?: 'nav_default');
$objTemplate->pid = $pid;
$objTemplate->type = \get_class($this);
$objTemplate->cssID = $this->cssID; // see #4897
$objTemplate->level = 'level_' . $level++;
$objTemplate->module = $this; // see #155
/** @var PageModel $objPage */
global $objPage;
// Browse subpages
foreach ($objSubpages as $objSubpage)
{
// Skip hidden sitemap pages
if ($this instanceof ModuleSitemap && $objSubpage->sitemap == 'map_never')
{
continue;
}
$subitems = '';
$_groups = StringUtil::deserialize($objSubpage->groups);
// Override the domain (see #3765)
if ($host !== null)
{
$objSubpage->domain = $host;
}
// Do not show protected pages unless a front end user is logged in
if (!$objSubpage->protected || $this->showProtected || ($this instanceof ModuleSitemap && $objSubpage->sitemap == 'map_always') || (\is_array($_groups) && \is_array($groups) && \count(array_intersect($_groups, $groups))))
{
// Check whether there will be subpages
if ($objSubpage->subpages > 0 && (!$this->showLevel || $this->showLevel >= $level || (!$this->hardLimit && ($objPage->id == $objSubpage->id || \in_array($objPage->id, $this->Database->getChildRecords($objSubpage->id, 'tl_page'))))))
{
$subitems = $this->renderNavigation($objSubpage->id, $level, $host, $language);
}
$href = null;
// Get href
switch ($objSubpage->type)
{
case 'redirect':
$href = $objSubpage->url;
if (strncasecmp($href, 'mailto:', 7) === 0)
{
$href = StringUtil::encodeEmail($href);
}
break;
case 'forward':
if ($objSubpage->jumpTo)
{
$objNext = PageModel::findPublishedById($objSubpage->jumpTo);
}
else
{
$objNext = PageModel::findFirstPublishedRegularByPid($objSubpage->id);
}
// Hide the link if the target page is invisible
if (!$objNext instanceof PageModel || (!$objNext->loadDetails()->isPublic && !BE_USER_LOGGED_IN))
{
continue 2;
}
$href = $objNext->getFrontendUrl();
break;
default:
$href = $objSubpage->getFrontendUrl();
break;
}
$items[] = $this->compileNavigationRow($objPage, $objSubpage, $subitems, $href);
}
}
// Add classes first and last
if (!empty($items))
{
$last = \count($items) - 1;
$items[0]['class'] = trim($items[0]['class'] . ' first');
$items[$last]['class'] = trim($items[$last]['class'] . ' last');
}
$objTemplate->items = $items;
return !empty($items) ? $objTemplate->parse() : '';
}
/**
* Compile the navigation row and return it as array
*
* @param PageModel $objPage
* @param PageModel $objSubpage
* @param string $subitems
* @param string $href
*
* @return array
*/
protected function compileNavigationRow($objPage, $objSubpage, $subitems, $href)
{
$row = $objSubpage->row();
$trail = \in_array($objSubpage->id, $objPage->trail);
// Use the path without query string to check for active pages (see #480)
list($path) = explode('?', Environment::get('request'), 2);
// Active page
if (($objPage->id == $objSubpage->id || ($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo)) && !($this instanceof ModuleSitemap) && $href == $path)
{
// Mark active forward pages (see #4822)
$strClass = (($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo) ? 'forward' . ($trail ? ' trail' : '') : 'active') . (($subitems != '') ? ' submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
$row['isActive'] = true;
$row['isTrail'] = false;
}
// Regular page
else
{
$strClass = (($subitems != '') ? 'submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($trail ? ' trail' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
// Mark pages on the same level (see #2419)
if ($objSubpage->pid == $objPage->pid)
{
$strClass .= ' sibling';
}
$row['isActive'] = false;
$row['isTrail'] = $trail;
}
$row['subitems'] = $subitems;
$row['class'] = trim($strClass);
$row['title'] = StringUtil::specialchars($objSubpage->title, true);
$row['pageTitle'] = StringUtil::specialchars($objSubpage->pageTitle, true);
$row['link'] = $objSubpage->title;
$row['href'] = $href;
$row['rel'] = '';
$row['nofollow'] = (strncmp($objSubpage->robots, 'noindex,nofollow', 16) === 0); // backwards compatibility
$row['target'] = '';
$row['description'] = str_replace(array("\n", "\r"), array(' ', ''), $objSubpage->description);
// Override the link target
if ($objSubpage->type == 'redirect' && $objSubpage->target)
{
$row['target'] = ' target="_blank"';
}
$arrRel = array();
if (strncmp($objSubpage->robots, 'noindex,nofollow', 16) === 0)
{
$arrRel[] = 'nofollow';
}
if ($objSubpage->type == 'redirect' && $objSubpage->target)
{
$arrRel[] = 'noreferrer';
$arrRel[] = 'noopener';
}
// Override the rel attribute
if (!empty($arrRel))
{
$row['rel'] = ' rel="' . implode(' ', $arrRel) . '"';
}
return $row;
}
/**
* Find a front end module in the FE_MOD array and return the class name
*
* @param string $strName The front end module name
*
* @return string The class name
*/
public static function findClass($strName)
{
foreach ($GLOBALS['FE_MOD'] as $v)
{
foreach ($v as $kk=>$vv)
{
if ($kk == $strName)
{
return $vv;
}
}
}
return '';
}
}
class_alias(Module::class, 'Module');