HtmlDocument.php
19.5 KB
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
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Document;
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Cache\Cache;
use Joomla\CMS\Helper\ModuleHelper;
use Joomla\CMS\Log\Log;
use Joomla\CMS\Uri\Uri;
use Joomla\Registry\Registry;
jimport('joomla.utilities.utility');
/**
* HtmlDocument class, provides an easy interface to parse and display a HTML document
*
* @since 1.7.0
*/
class HtmlDocument extends Document
{
/**
* Array of Header `<link>` tags
*
* @var array
* @since 1.7.0
*/
public $_links = array();
/**
* Array of custom tags
*
* @var array
* @since 1.7.0
*/
public $_custom = array();
/**
* Name of the template
*
* @var string
* @since 1.7.0
*/
public $template = null;
/**
* Base url
*
* @var string
* @since 1.7.0
*/
public $baseurl = null;
/**
* Array of template parameters
*
* @var array
* @since 1.7.0
*/
public $params = null;
/**
* File name
*
* @var array
* @since 1.7.0
*/
public $_file = null;
/**
* String holding parsed template
*
* @var string
* @since 1.7.0
*/
protected $_template = '';
/**
* Array of parsed template JDoc tags
*
* @var array
* @since 1.7.0
*/
protected $_template_tags = array();
/**
* Integer with caching setting
*
* @var integer
* @since 1.7.0
*/
protected $_caching = null;
/**
* Set to true when the document should be output as HTML5
*
* @var boolean
* @since 3.0.0
*
* @note 4.0 Will be replaced by $html5 and the default value will be true.
*/
private $_html5 = null;
/**
* Class constructor
*
* @param array $options Associative array of options
*
* @since 1.7.0
*/
public function __construct($options = array())
{
parent::__construct($options);
// Set document type
$this->_type = 'html';
// Set default mime type and document metadata (metadata syncs with mime type by default)
$this->setMimeEncoding('text/html');
}
/**
* Get the HTML document head data
*
* @return array The document head data in array form
*
* @since 1.7.0
*/
public function getHeadData()
{
$data = array();
$data['title'] = $this->title;
$data['description'] = $this->description;
$data['link'] = $this->link;
$data['metaTags'] = $this->_metaTags;
$data['links'] = $this->_links;
$data['styleSheets'] = $this->_styleSheets;
$data['style'] = $this->_style;
$data['scripts'] = $this->_scripts;
$data['script'] = $this->_script;
$data['custom'] = $this->_custom;
// This is for b.c. and can be safely removed in future
$data['scriptText'] = \JText::getScriptStrings();
$data['scriptOptions'] = $this->scriptOptions;
return $data;
}
/**
* Reset the HTML document head data
*
* @param mixed $types type or types of the heads elements to reset
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 3.7.0
*/
public function resetHeadData($types = null)
{
if (is_null($types))
{
$this->title = '';
$this->description = '';
$this->link = '';
$this->_metaTags = array();
$this->_links = array();
$this->_styleSheets = array();
$this->_style = array();
$this->_scripts = array();
$this->_script = array();
$this->_custom = array();
$this->scriptOptions = array();
}
if (is_array($types))
{
foreach ($types as $type)
{
$this->resetHeadDatum($type);
}
}
if (is_string($types))
{
$this->resetHeadDatum($types);
}
return $this;
}
/**
* Reset a part the HTML document head data
*
* @param string $type type of the heads elements to reset
*
* @return void
*
* @since 3.7.0
*/
private function resetHeadDatum($type)
{
switch ($type)
{
case 'title':
case 'description':
case 'link':
$this->{$type} = '';
break;
case 'metaTags':
case 'links':
case 'styleSheets':
case 'style':
case 'scripts':
case 'script':
case 'custom':
$realType = '_' . $type;
$this->{$realType} = array();
break;
case 'scriptOptions':
$this->{$type} = array();
break;
}
}
/**
* Set the HTML document head data
*
* @param array $data The document head data in array form
*
* @return HtmlDocument|null instance of $this to allow chaining or null for empty input data
*
* @since 1.7.0
*/
public function setHeadData($data)
{
if (empty($data) || !is_array($data))
{
return null;
}
$this->title = (isset($data['title']) && !empty($data['title'])) ? $data['title'] : $this->title;
$this->description = (isset($data['description']) && !empty($data['description'])) ? $data['description'] : $this->description;
$this->link = (isset($data['link']) && !empty($data['link'])) ? $data['link'] : $this->link;
$this->_metaTags = (isset($data['metaTags']) && !empty($data['metaTags'])) ? $data['metaTags'] : $this->_metaTags;
$this->_links = (isset($data['links']) && !empty($data['links'])) ? $data['links'] : $this->_links;
$this->_styleSheets = (isset($data['styleSheets']) && !empty($data['styleSheets'])) ? $data['styleSheets'] : $this->_styleSheets;
$this->_style = (isset($data['style']) && !empty($data['style'])) ? $data['style'] : $this->_style;
$this->_scripts = (isset($data['scripts']) && !empty($data['scripts'])) ? $data['scripts'] : $this->_scripts;
$this->_script = (isset($data['script']) && !empty($data['script'])) ? $data['script'] : $this->_script;
$this->_custom = (isset($data['custom']) && !empty($data['custom'])) ? $data['custom'] : $this->_custom;
$this->scriptOptions = (isset($data['scriptOptions']) && !empty($data['scriptOptions'])) ? $data['scriptOptions'] : $this->scriptOptions;
return $this;
}
/**
* Merge the HTML document head data
*
* @param array $data The document head data in array form
*
* @return HtmlDocument|null instance of $this to allow chaining or null for empty input data
*
* @since 1.7.0
*/
public function mergeHeadData($data)
{
if (empty($data) || !is_array($data))
{
return;
}
$this->title = (isset($data['title']) && !empty($data['title']) && !stristr($this->title, $data['title']))
? $this->title . $data['title']
: $this->title;
$this->description = (isset($data['description']) && !empty($data['description']) && !stristr($this->description, $data['description']))
? $this->description . $data['description']
: $this->description;
$this->link = (isset($data['link'])) ? $data['link'] : $this->link;
if (isset($data['metaTags']))
{
foreach ($data['metaTags'] as $type1 => $data1)
{
$booldog = $type1 == 'http-equiv' ? true : false;
foreach ($data1 as $name2 => $data2)
{
$this->setMetaData($name2, $data2, $booldog);
}
}
}
$this->_links = (isset($data['links']) && !empty($data['links']) && is_array($data['links']))
? array_unique(array_merge($this->_links, $data['links']), SORT_REGULAR)
: $this->_links;
$this->_styleSheets = (isset($data['styleSheets']) && !empty($data['styleSheets']) && is_array($data['styleSheets']))
? array_merge($this->_styleSheets, $data['styleSheets'])
: $this->_styleSheets;
if (isset($data['style']))
{
foreach ($data['style'] as $type => $stdata)
{
if (!isset($this->_style[strtolower($type)]) || !stristr($stdata, $this->_style[strtolower($type)]))
{
$this->addStyleDeclaration($stdata, $type);
}
}
}
$this->_scripts = (isset($data['scripts']) && !empty($data['scripts']) && is_array($data['scripts']))
? array_merge($this->_scripts, $data['scripts'])
: $this->_scripts;
if (isset($data['script']))
{
foreach ($data['script'] as $type => $sdata)
{
if (!isset($this->_script[strtolower($type)]) || !stristr($sdata, $this->_script[strtolower($type)]))
{
$this->addScriptDeclaration($sdata, $type);
}
}
}
$this->_custom = (isset($data['custom']) && !empty($data['custom']) && is_array($data['custom']))
? array_unique(array_merge($this->_custom, $data['custom']))
: $this->_custom;
if (!empty($data['scriptOptions']))
{
foreach ($data['scriptOptions'] as $key => $scriptOptions)
{
$this->addScriptOptions($key, $scriptOptions, true);
}
}
return $this;
}
/**
* Adds `<link>` tags to the head of the document
*
* $relType defaults to 'rel' as it is the most common relation type used.
* ('rev' refers to reverse relation, 'rel' indicates normal, forward relation.)
* Typical tag: `<link href="index.php" rel="Start">`
*
* @param string $href The link that is being related.
* @param string $relation Relation of link.
* @param string $relType Relation type attribute. Either rel or rev (default: 'rel').
* @param array $attribs Associative array of remaining attributes.
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
public function addHeadLink($href, $relation, $relType = 'rel', $attribs = array())
{
$this->_links[$href]['relation'] = $relation;
$this->_links[$href]['relType'] = $relType;
$this->_links[$href]['attribs'] = $attribs;
return $this;
}
/**
* Adds a shortcut icon (favicon)
*
* This adds a link to the icon shown in the favorites list or on
* the left of the url in the address bar. Some browsers display
* it on the tab, as well.
*
* @param string $href The link that is being related.
* @param string $type File type
* @param string $relation Relation of link
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
public function addFavicon($href, $type = 'image/vnd.microsoft.icon', $relation = 'shortcut icon')
{
$href = str_replace('\\', '/', $href);
$this->addHeadLink($href, $relation, 'rel', array('type' => $type));
return $this;
}
/**
* Adds a custom HTML string to the head block
*
* @param string $html The HTML to add to the head
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
public function addCustomTag($html)
{
$this->_custom[] = trim($html);
return $this;
}
/**
* Returns whether the document is set up to be output as HTML5
*
* @return boolean true when HTML5 is used
*
* @since 3.0.0
*/
public function isHtml5()
{
return $this->_html5;
}
/**
* Sets whether the document should be output as HTML5
*
* @param bool $state True when HTML5 should be output
*
* @return void
*
* @since 3.0.0
*/
public function setHtml5($state)
{
if (is_bool($state))
{
$this->_html5 = $state;
}
}
/**
* Get the contents of a document include
*
* @param string $type The type of renderer
* @param string $name The name of the element to render
* @param array $attribs Associative array of remaining attributes.
*
* @return mixed|string The output of the renderer
*
* @since 1.7.0
*/
public function getBuffer($type = null, $name = null, $attribs = array())
{
// If no type is specified, return the whole buffer
if ($type === null)
{
return parent::$_buffer;
}
$title = (isset($attribs['title'])) ? $attribs['title'] : null;
if (isset(parent::$_buffer[$type][$name][$title]))
{
return parent::$_buffer[$type][$name][$title];
}
$renderer = $this->loadRenderer($type);
if ($this->_caching == true && $type == 'modules')
{
$cache = \JFactory::getCache('com_modules', '');
$hash = md5(serialize(array($name, $attribs, null, $renderer)));
$cbuffer = $cache->get('cbuffer_' . $type);
if (isset($cbuffer[$hash]))
{
return Cache::getWorkarounds($cbuffer[$hash], array('mergehead' => 1));
}
else
{
$options = array();
$options['nopathway'] = 1;
$options['nomodules'] = 1;
$options['modulemode'] = 1;
$this->setBuffer($renderer->render($name, $attribs, null), $type, $name);
$data = parent::$_buffer[$type][$name][$title];
$tmpdata = Cache::setWorkarounds($data, $options);
$cbuffer[$hash] = $tmpdata;
$cache->store($cbuffer, 'cbuffer_' . $type);
}
}
else
{
$this->setBuffer($renderer->render($name, $attribs, null), $type, $name, $title);
}
return parent::$_buffer[$type][$name][$title];
}
/**
* Set the contents a document includes
*
* @param string $content The content to be set in the buffer.
* @param array $options Array of optional elements.
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
public function setBuffer($content, $options = array())
{
// The following code is just for backward compatibility.
if (func_num_args() > 1 && !is_array($options))
{
$args = func_get_args();
$options = array();
$options['type'] = $args[1];
$options['name'] = (isset($args[2])) ? $args[2] : null;
$options['title'] = (isset($args[3])) ? $args[3] : null;
}
parent::$_buffer[$options['type']][$options['name']][$options['title']] = $content;
return $this;
}
/**
* Parses the template and populates the buffer
*
* @param array $params Parameters for fetching the template
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
public function parse($params = array())
{
return $this->_fetchTemplate($params)->_parseTemplate();
}
/**
* Outputs the template to the browser.
*
* @param boolean $caching If true, cache the output
* @param array $params Associative array of attributes
*
* @return string The rendered data
*
* @since 1.7.0
*/
public function render($caching = false, $params = array())
{
$this->_caching = $caching;
if (empty($this->_template))
{
$this->parse($params);
}
$data = $this->_renderTemplate();
parent::render($caching, $params);
return $data;
}
/**
* Count the modules based on the given condition
*
* @param string $condition The condition to use
*
* @return integer Number of modules found
*
* @since 1.7.0
*/
public function countModules($condition)
{
$operators = '(\+|\-|\*|\/|==|\!=|\<\>|\<|\>|\<=|\>=|and|or|xor)';
$words = preg_split('# ' . $operators . ' #', $condition, null, PREG_SPLIT_DELIM_CAPTURE);
if (count($words) === 1)
{
$name = strtolower($words[0]);
$result = ((isset(parent::$_buffer['modules'][$name])) && (parent::$_buffer['modules'][$name] === false))
? 0 : count(ModuleHelper::getModules($name));
return $result;
}
Log::add('Using an expression in HtmlDocument::countModules() is deprecated.', Log::WARNING, 'deprecated');
for ($i = 0, $n = count($words); $i < $n; $i += 2)
{
// Odd parts (modules)
$name = strtolower($words[$i]);
$words[$i] = ((isset(parent::$_buffer['modules'][$name])) && (parent::$_buffer['modules'][$name] === false))
? 0
: count(ModuleHelper::getModules($name));
}
$str = 'return ' . implode(' ', $words) . ';';
return eval($str);
}
/**
* Count the number of child menu items of the current active menu item
*
* @return integer Number of child menu items
*
* @since 1.7.0
*/
public function countMenuChildren()
{
static $children;
if (!isset($children))
{
$db = \JFactory::getDbo();
$app = \JFactory::getApplication();
$menu = $app->getMenu();
$active = $menu->getActive();
$children = 0;
if ($active)
{
$query = $db->getQuery(true)
->select('COUNT(*)')
->from('#__menu')
->where('parent_id = ' . $active->id)
->where('published = 1');
$db->setQuery($query);
$children = $db->loadResult();
}
}
return $children;
}
/**
* Load a template file
*
* @param string $directory The name of the template
* @param string $filename The actual filename
*
* @return string The contents of the template
*
* @since 1.7.0
*/
protected function _loadTemplate($directory, $filename)
{
$contents = '';
// Check to see if we have a valid template file
if (file_exists($directory . '/' . $filename))
{
// Store the file path
$this->_file = $directory . '/' . $filename;
// Get the file content
ob_start();
require $directory . '/' . $filename;
$contents = ob_get_contents();
ob_end_clean();
}
// Try to find a favicon by checking the template and root folder
$icon = '/favicon.ico';
foreach (array($directory, JPATH_BASE) as $dir)
{
if (file_exists($dir . $icon))
{
$path = str_replace(JPATH_BASE, '', $dir);
$path = str_replace('\\', '/', $path);
$this->addFavicon(Uri::base(true) . $path . $icon);
break;
}
}
return $contents;
}
/**
* Fetch the template, and initialise the params
*
* @param array $params Parameters to determine the template
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
protected function _fetchTemplate($params = array())
{
// Check
$directory = isset($params['directory']) ? $params['directory'] : 'templates';
$filter = \JFilterInput::getInstance();
$template = $filter->clean($params['template'], 'cmd');
$file = $filter->clean($params['file'], 'cmd');
if (!file_exists($directory . '/' . $template . '/' . $file))
{
$template = 'system';
}
if (!file_exists($directory . '/' . $template . '/' . $file))
{
$file = 'index.php';
}
// Load the language file for the template
$lang = \JFactory::getLanguage();
// 1.5 or core then 1.6
$lang->load('tpl_' . $template, JPATH_BASE, null, false, true)
|| $lang->load('tpl_' . $template, $directory . '/' . $template, null, false, true);
// Assign the variables
$this->template = $template;
$this->baseurl = Uri::base(true);
$this->params = isset($params['params']) ? $params['params'] : new Registry;
// Load
$this->_template = $this->_loadTemplate($directory . '/' . $template, $file);
return $this;
}
/**
* Parse a document template
*
* @return HtmlDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
protected function _parseTemplate()
{
$matches = array();
if (preg_match_all('#<jdoc:include\ type="([^"]+)"(.*)\/>#iU', $this->_template, $matches))
{
$template_tags_first = array();
$template_tags_last = array();
// Step through the jdocs in reverse order.
for ($i = count($matches[0]) - 1; $i >= 0; $i--)
{
$type = $matches[1][$i];
$attribs = empty($matches[2][$i]) ? array() : \JUtility::parseAttributes($matches[2][$i]);
$name = isset($attribs['name']) ? $attribs['name'] : null;
// Separate buffers to be executed first and last
if ($type == 'module' || $type == 'modules')
{
$template_tags_first[$matches[0][$i]] = array('type' => $type, 'name' => $name, 'attribs' => $attribs);
}
else
{
$template_tags_last[$matches[0][$i]] = array('type' => $type, 'name' => $name, 'attribs' => $attribs);
}
}
// Reverse the last array so the jdocs are in forward order.
$template_tags_last = array_reverse($template_tags_last);
$this->_template_tags = $template_tags_first + $template_tags_last;
}
return $this;
}
/**
* Render pre-parsed template
*
* @return string rendered template
*
* @since 1.7.0
*/
protected function _renderTemplate()
{
$replace = array();
$with = array();
foreach ($this->_template_tags as $jdoc => $args)
{
$replace[] = $jdoc;
$with[] = $this->getBuffer($args['type'], $args['name'], $args['attribs']);
}
return str_replace($replace, $with, $this->_template);
}
}