utils.php
14.2 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
<?php
/**
* @package FrameworkOnFramework
* @subpackage template
* @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// Protect from unauthorized access
defined('FOF_INCLUDED') or die;
/**
* A utility class to load view templates, media files and modules.
*
* @package FrameworkOnFramework
* @since 1.0
*/
class FOFTemplateUtils
{
/**
* Add a CSS file to the page generated by the CMS
*
* @param string $path A fancy path definition understood by parsePath
*
* @see FOFTemplateUtils::parsePath
*
* @return void
*/
public static function addCSS($path)
{
$document = FOFPlatform::getInstance()->getDocument();
if ($document instanceof JDocument)
{
if (method_exists($document, 'addStyleSheet'))
{
$url = self::parsePath($path);
$document->addStyleSheet($url);
}
}
}
/**
* Add a JS script file to the page generated by the CMS.
*
* There are three combinations of defer and async (see http://www.w3schools.com/tags/att_script_defer.asp):
* * $defer false, $async true: The script is executed asynchronously with the rest of the page
* (the script will be executed while the page continues the parsing)
* * $defer true, $async false: The script is executed when the page has finished parsing.
* * $defer false, $async false. (default) The script is loaded and executed immediately. When it finishes
* loading the browser continues parsing the rest of the page.
*
* When you are using $defer = true there is no guarantee about the load order of the scripts. Whichever
* script loads first will be executed first. The order they appear on the page is completely irrelevant.
*
* @param string $path A fancy path definition understood by parsePath
* @param boolean $defer Adds the defer attribute, meaning that your script
* will only load after the page has finished parsing.
* @param boolean $async Adds the async attribute, meaning that your script
* will be executed while the resto of the page
* continues parsing.
*
* @see FOFTemplateUtils::parsePath
*
* @return void
*/
public static function addJS($path, $defer = false, $async = false)
{
$document = FOFPlatform::getInstance()->getDocument();
if ($document instanceof JDocument)
{
if (method_exists($document, 'addScript'))
{
$url = self::parsePath($path);
$document->addScript($url, "text/javascript", $defer, $async);
}
}
}
/**
* Compile a LESS file into CSS and add it to the page generated by the CMS.
* This method has integrated cache support. The compiled LESS files will be
* written to the media/lib_fof/compiled directory of your site. If the file
* cannot be written we will use the $altPath, if specified
*
* @param string $path A fancy path definition understood by parsePath pointing to the source LESS file
* @param string $altPath A fancy path definition understood by parsePath pointing to a precompiled CSS file,
* used when we can't write the generated file to the output directory
* @param boolean $returnPath Return the URL of the generated CSS file but do not include it. If it can't be
* generated, false is returned and the alt files are not included
*
* @see FOFTemplateUtils::parsePath
*
* @since 2.0
*
* @return mixed True = successfully included generated CSS, False = the alternate CSS file was used, null = the source file does not exist
*/
public static function addLESS($path, $altPath = null, $returnPath = false)
{
// Does the cache directory exists and is writeable
static $sanityCheck = null;
// Get the local LESS file
$localFile = self::parsePath($path, true);
$filesystem = FOFPlatform::getInstance()->getIntegrationObject('filesystem');
$platformDirs = FOFPlatform::getInstance()->getPlatformBaseDirs();
if (is_null($sanityCheck))
{
// Make sure the cache directory exists
if (!is_dir($platformDirs['public'] . '/media/lib_fof/compiled/'))
{
$sanityCheck = $filesystem->folderCreate($platformDirs['public'] . '/media/lib_fof/compiled/');
}
else
{
$sanityCheck = true;
}
}
// No point continuing if the source file is not there or we can't write to the cache
if (!$sanityCheck || !is_file($localFile))
{
if (!$returnPath)
{
if (is_string($altPath))
{
self::addCSS($altPath);
}
elseif (is_array($altPath))
{
foreach ($altPath as $anAltPath)
{
self::addCSS($anAltPath);
}
}
}
return false;
}
// Get the source file's unique ID
$id = md5(filemtime($localFile) . filectime($localFile) . $localFile);
// Get the cached file path
$cachedPath = $platformDirs['public'] . '/media/lib_fof/compiled/' . $id . '.css';
// Get the LESS compiler
$lessCompiler = new FOFLess;
$lessCompiler->formatterName = 'compressed';
// Should I add an alternative import path?
$altFiles = self::getAltPaths($path);
if (isset($altFiles['alternate']))
{
$currentLocation = realpath(dirname($localFile));
$normalLocation = realpath(dirname($altFiles['normal']));
$alternateLocation = realpath(dirname($altFiles['alternate']));
if ($currentLocation == $normalLocation)
{
$lessCompiler->importDir = array($alternateLocation, $currentLocation);
}
else
{
$lessCompiler->importDir = array($currentLocation, $normalLocation);
}
}
// Compile the LESS file
$lessCompiler->checkedCompile($localFile, $cachedPath);
// Add the compiled CSS to the page
$base_url = rtrim(FOFPlatform::getInstance()->URIbase(), '/');
if (substr($base_url, -14) == '/administrator')
{
$base_url = substr($base_url, 0, -14);
}
$url = $base_url . '/media/lib_fof/compiled/' . $id . '.css';
if ($returnPath)
{
return $url;
}
else
{
$document = FOFPlatform::getInstance()->getDocument();
if ($document instanceof JDocument)
{
if (method_exists($document, 'addStyleSheet'))
{
$document->addStyleSheet($url);
}
}
return true;
}
}
/**
* Creates a SEF compatible sort header. Standard Joomla function will add a href="#" tag, so with SEF
* enabled, the browser will follow the fake link instead of processing the onSubmit event; so we
* need a fix.
*
* @param string $text Header text
* @param string $field Field used for sorting
* @param FOFUtilsObject $list Object holding the direction and the ordering field
*
* @return string HTML code for sorting
*/
public static function sefSort($text, $field, $list)
{
$sort = JHTML::_('grid.sort', JText::_(strtoupper($text)) . ' ', $field, $list->order_Dir, $list->order);
return str_replace('href="#"', 'href="javascript:void(0);"', $sort);
}
/**
* Parse a fancy path definition into a path relative to the site's root,
* respecting template overrides, suitable for inclusion of media files.
* For example, media://com_foobar/css/test.css is parsed into
* media/com_foobar/css/test.css if no override is found, or
* templates/mytemplate/media/com_foobar/css/test.css if the current
* template is called mytemplate and there's a media override for it.
*
* The valid protocols are:
* media:// The media directory or a media override
* admin:// Path relative to administrator directory (no overrides)
* site:// Path relative to site's root (no overrides)
*
* @param string $path Fancy path
* @param boolean $localFile When true, it returns the local path, not the URL
*
* @return string Parsed path
*/
public static function parsePath($path, $localFile = false)
{
$platformDirs = FOFPlatform::getInstance()->getPlatformBaseDirs();
if ($localFile)
{
$url = rtrim($platformDirs['root'], DIRECTORY_SEPARATOR) . '/';
}
else
{
$url = FOFPlatform::getInstance()->URIroot();
}
$altPaths = self::getAltPaths($path);
$filePath = $altPaths['normal'];
// If JDEBUG is enabled, prefer that path, else prefer an alternate path if present
if (defined('JDEBUG') && JDEBUG && isset($altPaths['debug']))
{
if (file_exists($platformDirs['public'] . '/' . $altPaths['debug']))
{
$filePath = $altPaths['debug'];
}
}
elseif (isset($altPaths['alternate']))
{
if (file_exists($platformDirs['public'] . '/' . $altPaths['alternate']))
{
$filePath = $altPaths['alternate'];
}
}
$url .= $filePath;
return $url;
}
/**
* Parse a fancy path definition into a path relative to the site's root.
* It returns both the normal and alternative (template media override) path.
* For example, media://com_foobar/css/test.css is parsed into
* array(
* 'normal' => 'media/com_foobar/css/test.css',
* 'alternate' => 'templates/mytemplate/media/com_foobar/css//test.css'
* );
*
* The valid protocols are:
* media:// The media directory or a media override
* admin:// Path relative to administrator directory (no alternate)
* site:// Path relative to site's root (no alternate)
*
* @param string $path Fancy path
*
* @return array Array of normal and alternate parsed path
*/
public static function getAltPaths($path)
{
$protoAndPath = explode('://', $path, 2);
if (count($protoAndPath) < 2)
{
$protocol = 'media';
}
else
{
$protocol = $protoAndPath[0];
$path = $protoAndPath[1];
}
$path = ltrim($path, '/' . DIRECTORY_SEPARATOR);
switch ($protocol)
{
case 'media':
// Do we have a media override in the template?
$pathAndParams = explode('?', $path, 2);
$ret = array(
'normal' => 'media/' . $pathAndParams[0],
'alternate' => FOFPlatform::getInstance()->getTemplateOverridePath('media:/' . $pathAndParams[0], false),
);
break;
case 'admin':
$ret = array(
'normal' => 'administrator/' . $path
);
break;
default:
case 'site':
$ret = array(
'normal' => $path
);
break;
}
// For CSS and JS files, add a debug path if the supplied file is compressed
$filesystem = FOFPlatform::getInstance()->getIntegrationObject('filesystem');
$ext = $filesystem->getExt($ret['normal']);
if (in_array($ext, array('css', 'js')))
{
$file = basename($filesystem->stripExt($ret['normal']));
/*
* Detect if we received a file in the format name.min.ext
* If so, strip the .min part out, otherwise append -uncompressed
*/
if (strlen($file) > 4 && strrpos($file, '.min', '-4'))
{
$position = strrpos($file, '.min', '-4');
$filename = str_replace('.min', '.', $file, $position) . $ext;
}
else
{
$filename = $file . '-uncompressed.' . $ext;
}
// Clone the $ret array so we can manipulate the 'normal' path a bit
$t1 = (object) $ret;
$temp = clone $t1;
unset($t1);
$temp = (array)$temp;
$normalPath = explode('/', $temp['normal']);
array_pop($normalPath);
$normalPath[] = $filename;
$ret['debug'] = implode('/', $normalPath);
}
return $ret;
}
/**
* Returns the contents of a module position
*
* @param string $position The position name, e.g. "position-1"
* @param int $style Rendering style; please refer to Joomla!'s code for more information
*
* @return string The contents of the module position
*/
public static function loadPosition($position, $style = -2)
{
$document = FOFPlatform::getInstance()->getDocument();
if (!($document instanceof JDocument))
{
return '';
}
if (!method_exists($document, 'loadRenderer'))
{
return '';
}
try
{
$renderer = $document->loadRenderer('module');
}
catch (Exception $exc)
{
return '';
}
$params = array('style' => $style);
$contents = '';
foreach (JModuleHelper::getModules($position) as $mod)
{
$contents .= $renderer->render($mod, $params);
}
return $contents;
}
/**
* Merges the current url with new or changed parameters.
*
* This method merges the route string with the url parameters defined
* in current url. The parameters defined in current url, but not given
* in route string, will automatically reused in the resulting url.
* But only these following parameters will be reused:
*
* option, view, layout, format
*
* Example:
*
* Assuming that current url is:
* http://fobar.com/index.php?option=com_foo&view=cpanel
*
* <code>
* <?php echo FOFTemplateutils::route('view=categories&layout=tree'); ?>
* </code>
*
* Result:
* http://fobar.com/index.php?option=com_foo&view=categories&layout=tree
*
* @param string $route The parameters string
*
* @return string The human readable, complete url
*/
public static function route($route = '')
{
$route = trim($route);
// Special cases
if ($route == 'index.php' || $route == 'index.php?')
{
$result = $route;
}
elseif (substr($route, 0, 1) == '&')
{
$url = JURI::getInstance();
$vars = array();
parse_str($route, $vars);
$url->setQuery(array_merge($url->getQuery(true), $vars));
$result = 'index.php?' . $url->getQuery();
}
else
{
$url = JURI::getInstance();
$props = $url->getQuery(true);
// Strip 'index.php?'
if (substr($route, 0, 10) == 'index.php?')
{
$route = substr($route, 10);
}
// Parse route
$parts = array();
parse_str($route, $parts);
$result = array();
// Check to see if there is component information in the route if not add it
if (!isset($parts['option']) && isset($props['option']))
{
$result[] = 'option=' . $props['option'];
}
// Add the layout information to the route only if it's not 'default'
if (!isset($parts['view']) && isset($props['view']))
{
$result[] = 'view=' . $props['view'];
if (!isset($parts['layout']) && isset($props['layout']))
{
$result[] = 'layout=' . $props['layout'];
}
}
// Add the format information to the URL only if it's not 'html'
if (!isset($parts['format']) && isset($props['format']) && $props['format'] != 'html')
{
$result[] = 'format=' . $props['format'];
}
// Reconstruct the route
if (!empty($route))
{
$result[] = $route;
}
$result = 'index.php?' . implode('&', $result);
}
return JRoute::_($result);
}
}