Current File : /home/lightco1/upgrade.lightco.com.au/media/akeeba_strapper/strapper.php
<?php
/**
* Akeeba Strapper
* A handy distribution of namespaced jQuery, jQuery UI and Twitter
* Bootstrapper for use with Akeeba components.
*
* @copyright (c) 2012-2013 Akeeba Ltd
* @license GNU General Public License version 2 or later
*/
defined('_JEXEC') or die();
if (!defined('FOF_INCLUDED'))
{
include_once JPATH_SITE . '/libraries/fof/include.php';
}
class AkeebaStrapper
{
/** @var bool True when jQuery is already included */
public static $_includedJQuery = false;
/** @var bool True when jQuery UI is already included */
public static $_includedJQueryUI = false;
/** @var bool True when Bootstrap is already included */
public static $_includedBootstrap = false;
/** @var array List of URLs to Javascript files */
public static $scriptURLs = array();
/** @var array List of script definitions to include in the head */
public static $scriptDefs = array();
/** @var array List of URLs to CSS files */
public static $cssURLs = array();
/** @var array List of URLs to LESS files */
public static $lessURLs = array();
/** @var array List of CSS definitions to include in the head */
public static $cssDefs = array();
/** @var string The jQuery UI theme to use, default is 'smoothness' */
protected static $jqUItheme = 'smoothness';
/** @var string A query tag to append to CSS and JS files for versioning purposes */
public static $tag = null;
/**
* Is this something running under the CLI mode?
* @staticvar bool|null $isCli
* @return null
*/
public static function isCli()
{
static $isCli = null;
if (is_null($isCli))
{
try
{
if (is_null(JFactory::$application))
{
$isCli = true;
}
else
{
$isCli = version_compare(JVERSION, '1.6.0', 'ge') ? (JFactory::getApplication() instanceof JException) : false;
}
}
catch (Exception $e)
{
$isCli = true;
}
}
return $isCli;
}
public static function getPreference($key, $default = null)
{
static $config = null;
if(is_null($config))
{
// Load a configuration INI file which controls which files should be skipped
$iniFile = FOFTemplateUtils::parsePath('media://akeeba_strapper/strapper.ini', true);
$config = parse_ini_file($iniFile);
}
if (!array_key_exists($key, $config))
{
$config[$key] = $default;
}
return $config[$key];
}
/**
* Loads our namespaced jQuery, accessible through akeeba.jQuery
*/
public static function jQuery()
{
if (self::isCli())
{
return;
}
$jQueryLoad = self::getPreference('jquery_load', 'auto');
if (!in_array($jQueryLoad, array('auto', 'full', 'namespace', 'none')))
{
$jQueryLoad = 'auto';
}
self::$_includedJQuery = true;
if ($jQueryLoad == 'none')
{
return;
}
elseif ($jQueryLoad == 'auto')
{
if (version_compare(JVERSION, '3.0', 'gt'))
{
$jQueryLoad = 'namespace';
JHtml::_('jquery.framework');
}
else
{
$jQueryLoad = 'full';
}
}
if ($jQueryLoad == 'full')
{
self::$scriptURLs[] = FOFTemplateUtils::parsePath('media://akeeba_strapper/js/akeebajq.js');
self::$scriptURLs[] = FOFTemplateUtils::parsePath('media://akeeba_strapper/js/akjqmigrate.js');
}
else
{
self::$scriptURLs[] = FOFTemplateUtils::parsePath('media://akeeba_strapper/js/namespace.js');
}
}
/**
* Sets the jQuery UI theme to use. It must be the name of a subdirectory of
* media/akeeba_strapper/css or templates/<yourtemplate>/media/akeeba_strapper/css
*
* @param $theme string The name of the subdirectory holding the theme
*/
public static function setjQueryUItheme($theme)
{
if (self::isCli())
{
return;
}
self::$jqUItheme = $theme;
}
/**
* Loads our namespaced jQuery UI and its stylesheet
*/
public static function jQueryUI()
{
if (self::isCli())
{
return;
}
if (!self::$_includedJQuery)
{
self::jQuery();
}
self::$_includedJQueryUI = true;
$jQueryUILoad = self::getPreference('jqueryui_load', 1);
if (!$jQueryUILoad)
{
return;
}
$theme = self::getPreference('jquery_theme', self::$jqUItheme);
$url = FOFTemplateUtils::parsePath('media://akeeba_strapper/js/akeebajqui.js');
self::$scriptURLs[] = $url;
self::$cssURLs[] = FOFTemplateUtils::parsePath("media://akeeba_strapper/css/$theme/theme.css");
}
/**
* Loads our namespaced Twitter Bootstrap. You have to wrap the output you want style
* with an element having the class akeeba-bootstrap added to it.
*/
public static function bootstrap()
{
if (self::isCli())
{
return;
}
if (version_compare(JVERSION, '3.0', 'gt'))
{
$key = 'joomla3';
$default = 'lite';
}
else
{
$key = 'joomla2';
$default = 'full';
}
$loadBootstrap = self::getPreference('bootstrap_' . $key, $default);
if (!in_array($loadBootstrap, array('full','lite','none')))
{
if ($key == 'joomla3')
{
$loadBootstrap = 'lite';
}
else
{
$loadBootstrap = 'full';
}
}
if (($key == 'joomla3') && in_array($loadBootstrap, array('lite', 'none')))
{
// Use Joomla!'s Javascript
JHtml::_('bootstrap.framework');
}
if (!self::$_includedJQuery)
{
self::jQuery();
}
if ($loadBootstrap == 'none')
{
return;
}
self::$_includedBootstrap = true;
$source = self::getPreference('bootstrap_source', 'css');
if (!in_array($source, array('css','less')))
{
$source = 'css';
}
$altCss = array('media://akeeba_strapper/css/strapper.css');
if ($loadBootstrap == 'full')
{
array_unshift($altCss, 'media://akeeba_strapper/css/bootstrap.min.css');
self::$scriptURLs[] = FOFTemplateUtils::parsePath('media://akeeba_strapper/js/bootstrap.min.js');
if ($source == 'less')
{
self::$lessURLs[] = array('media://akeeba_strapper/less/bootstrap.j25.less', $altCss);
}
}
else
{
array_unshift($altCss, 'media://akeeba_strapper/css/bootstrap.j3.css');
if ($source == 'less')
{
self::$lessURLs[] = array('media://akeeba_strapper/less/bootstrap.j3.less', $altCss);
}
}
if ($source == 'css')
{
foreach($altCss as $css)
{
self::$cssURLs[] = FOFTemplateUtils::parsePath($css);
}
}
}
/**
* Adds an arbitraty Javascript file.
*
* @param $path string The path to the file, in the format media://path/to/file
*/
public static function addJSfile($path)
{
if (self::isCli())
{
return;
}
self::$scriptURLs[] = FOFTemplateUtils::parsePath($path);
}
/**
* Add inline Javascript
*
* @param $script string Raw inline Javascript
*/
public static function addJSdef($script)
{
if (self::isCli())
{
return;
}
self::$scriptDefs[] = $script;
}
/**
* Adds an arbitraty CSS file.
*
* @param $path string The path to the file, in the format media://path/to/file
*/
public static function addCSSfile($path)
{
if (self::isCli())
{
return;
}
self::$cssURLs[] = FOFTemplateUtils::parsePath($path);
}
/**
* Adds an arbitraty LESS file.
*
* @param $path string The path to the file, in the format media://path/to/file
* @param $altPaths string|array The path to the alternate CSS files, in the format media://path/to/file
*/
public static function addLESSfile($path, $altPaths = null)
{
if (self::isCli())
{
return;
}
self::$lessURLs[] = array($path, $altPaths);
}
/**
* Add inline CSS
*
* @param $style string Raw inline CSS
*/
public static function addCSSdef($style)
{
if (self::isCli())
{
return;
}
self::$cssDefs[] = $style;
}
/**
* Do we need to preload?
*
* @return bool True if we need to preload
*/
public static function needPreload()
{
$isJ2 = version_compare(JVERSION, '3.0', 'lt');
$isJ3 = version_compare(JVERSION, '3.0', 'ge');
$preloadJ2 = (bool)self::getPreference('preload_joomla2', 1);
$preloadJ3 = (bool)self::getPreference('preload_joomla3', 0);
// Do not allow Joomla! 3+ preloading if jQueryLoad is "auto" or "namespace" (which are both
// namespace in Joomla! 3+). Else only the namespacing for the jQuery library will be loaded,
// without a jQuery library being loaded on forehand, which results in jQuery error(s).
$jQueryLoad = self::getPreference('jquery_load', 'auto');
if(in_array($jQueryLoad, array('auto', 'namespace')))
{
$preloadJ3 = false;
}
$needPreload = $isJ2 && $preloadJ2 || $isJ3 && $preloadJ3;
return $needPreload;
}
}
/**
* This is a workaround which ensures that Akeeba's namespaced JavaScript and CSS will be loaded
* without being tampered with by any system plugin. Moreover, since we are loading first, we can
* be pretty sure that namespacing *will* work and we won't cause any incompatibilities with third
* party extensions loading different versions of these GUI libraries.
*
* This code works by registering a system plugin hook :) It will grab the HTML and drop its own
* JS and CSS definitions in the head of the script, before anything else has the chance to run.
*
* Peace.
*/
function AkeebaStrapperLoader()
{
// If there are no script defs, just go to sleep
if (
empty(AkeebaStrapper::$scriptURLs) &&
empty(AkeebaStrapper::$scriptDefs) &&
empty(AkeebaStrapper::$cssDefs) &&
empty(AkeebaStrapper::$cssURLs) &&
empty(AkeebaStrapper::$lessURLs)
)
{
return;
}
// Get the query tag
$tag = AkeebaStrapper::$tag;
if (empty($tag))
{
$tag = '';
}
else
{
$tag = '?' . ltrim($tag, '?');
}
$myscripts = '';
$preloadJ2 = (bool)AkeebaStrapper::getPreference('preload_joomla2', 1);
$preload = AkeebaStrapper::needPreload();
if ($preload)
{
$buffer = JResponse::getBody();
}
else
{
$preloadJ2 = false;
$preload = false;
}
// Include Javascript files
if (!empty(AkeebaStrapper::$scriptURLs))
foreach (AkeebaStrapper::$scriptURLs as $url)
{
if ($preloadJ2 && (basename($url) == 'bootstrap.min.js'))
{
// Special case: check that nobody else is using bootstrap[.min].js on the page.
$scriptRegex = "/<script [^>]+(\/>|><\/script>)/i";
$jsRegex = "/([^\"\'=]+\.(js)(\?[^\"\']*){0,1})[\"\']/i";
preg_match_all($scriptRegex, $buffer, $matches);
$scripts = @implode('', $matches[0]);
preg_match_all($jsRegex, $scripts, $matches);
$skip = false;
foreach ($matches[1] as $scripturl)
{
$scripturl = basename($scripturl);
if (in_array($scripturl, array('bootstrap.min.js', 'bootstrap.js')))
{
$skip = true;
}
}
if ($skip)
continue;
}
if ($preload)
{
$myscripts .= '<script type="text/javascript" src="' . $url . $tag . '"></script>' . "\n";
}
else
{
JFactory::getDocument()->addScript($url . $tag);
}
}
// Include Javscript snippets
if (!empty(AkeebaStrapper::$scriptDefs))
{
if ($preload)
{
$myscripts .= '<script type="text/javascript" language="javascript">' . "\n";
}
else
{
$myscripts = '';
}
foreach (AkeebaStrapper::$scriptDefs as $def)
{
$myscripts .= $def . "\n";
}
if ($preload)
{
$myscripts .= '</script>' . "\n";
}
else
{
JFactory::getDocument()->addScriptDeclaration($myscripts);
}
}
// Include LESS files
if (!empty(AkeebaStrapper::$lessURLs))
{
foreach (AkeebaStrapper::$lessURLs as $entry)
{
list($lessFile, $altFiles) = $entry;
$url = FOFTemplateUtils::addLESS($lessFile, $altFiles, true);
if ($preload)
{
if (empty($url))
{
if (!is_array($altFiles) && empty($altFiles))
{
$altFiles = array($altFiles);
}
if (!empty($altFiles))
{
foreach ($altFiles as $altFile)
{
$url = FOFTemplateUtils::parsePath($altFile);
$myscripts .= '<link type="text/css" rel="stylesheet" href="' . $url . $tag . '" />' . "\n";
}
}
}
else
{
$myscripts .= '<link type="text/css" rel="stylesheet" href="' . $url . $tag . '" />' . "\n";
}
}
else
{
if (empty($url))
{
if (!is_array($altFiles) && empty($altFiles))
{
$altFiles = array($altFiles);
}
if (!empty($altFiles))
{
foreach ($altFiles as $altFile)
{
$url = FOFTemplateUtils::parsePath($altFile);
JFactory::getDocument()->addStyleSheet($url . $tag);
}
}
}
else
{
JFactory::getDocument()->addStyleSheet($url . $tag);
}
}
}
}
// Include CSS files
if (!empty(AkeebaStrapper::$cssURLs))
foreach (AkeebaStrapper::$cssURLs as $url)
{
if ($preload)
{
$myscripts .= '<link type="text/css" rel="stylesheet" href="' . $url . $tag . '" />' . "\n";
}
else
{
JFactory::getDocument()->addStyleSheet($url . $tag);
}
}
// Include style definitions
if (!empty(AkeebaStrapper::$cssDefs))
{
$myscripts .= '<style type="text/css">' . "\n";
foreach (AkeebaStrapper::$cssDefs as $def)
{
if ($preload)
{
$myscripts .= $def . "\n";
}
else
{
JFactory::getDocument()->addScriptDeclaration($def . "\n");
}
}
$myscripts .= '</style>' . "\n";
}
if ($preload)
{
$pos = strpos($buffer, "<head>");
if ($pos > 0)
{
$buffer = substr($buffer, 0, $pos + 6) . $myscripts . substr($buffer, $pos + 6);
JResponse::setBody($buffer);
}
}
}
// Add our pseudo-plugin to the application event queue
if (!AkeebaStrapper::isCli())
{
$app = JFactory::getApplication();
if (AkeebaStrapper::needPreload())
{
$app->registerEvent('onAfterRender', 'AkeebaStrapperLoader');
}
else
{
$app->registerEvent('onBeforeRender', 'AkeebaStrapperLoader');
}
}
Mini Shell