3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This class facilitates the loading of resources
30 * such as JavaScript files and CSS files.
32 * Any URLs generated for resources may include a 'cache-code'. By resetting the
33 * cache-code, one may force clients to re-download resource files (regardless of
34 * any HTTP caching rules).
36 * TODO: This is currently a thin wrapper over CRM_Core_Region. We
37 * should incorporte services for aggregation, minimization, etc.
40 * @copyright CiviCRM LLC (c) 2004-2013
44 class CRM_Core_Resources
{
45 const DEFAULT_WEIGHT
= 0;
46 const DEFAULT_REGION
= 'page-footer';
49 * We don't have a container or dependency-injection, so use singleton instead
54 private static $_singleton = NULL;
57 * @var CRM_Extension_Mapper
59 private $extMapper = NULL;
62 * @var CRM_Utils_Cache_Interface
64 private $cache = NULL;
67 * @var array free-form data tree
69 protected $settings = array();
70 protected $addedSettings = FALSE;
73 * @var array of callables
75 protected $settingsFactories = array();
78 * @var array ($regionName => bool)
80 protected $addedCoreResources = array();
83 * @var array ($regionName => bool)
85 protected $addedCoreStyles = array();
88 * @var string a value to append to JS/CSS URLs to coerce cache resets
90 protected $cacheCode = NULL;
93 * @var string the name of a setting which persistently stores the cacheCode
95 protected $cacheCodeKey = NULL;
98 * Get or set the single instance of CRM_Core_Resources
100 * @param $instance CRM_Core_Resources, new copy of the manager
101 * @return CRM_Core_Resources
103 static public function singleton(CRM_Core_Resources
$instance = NULL) {
104 if ($instance !== NULL) {
105 self
::$_singleton = $instance;
107 if (self
::$_singleton === NULL) {
108 $sys = CRM_Extension_System
::singleton();
109 $cache = new CRM_Utils_Cache_SqlGroup(array(
110 'group' => 'js-strings',
113 self
::$_singleton = new CRM_Core_Resources(
119 return self
::$_singleton;
123 * Construct a resource manager
125 * @param CRM_Extension_Mapper $extMapper Map extension names to their base path or URLs.
127 public function __construct($extMapper, $cache, $cacheCodeKey = NULL) {
128 $this->extMapper
= $extMapper;
129 $this->cache
= $cache;
130 $this->cacheCodeKey
= $cacheCodeKey;
131 if ($cacheCodeKey !== NULL) {
132 $this->cacheCode
= CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, $cacheCodeKey);
134 if (! $this->cacheCode
) {
135 $this->resetCacheCode();
140 * Add a JavaScript file to the current page using <SCRIPT SRC>.
142 * @param $ext string, extension name; use 'civicrm' for core
143 * @param $file string, file path -- relative to the extension base dir
144 * @param $weight int, relative weight within a given region
145 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
146 * @param $translate, whether to parse this file for strings enclosed in ts()
148 * @return CRM_Core_Resources
150 public function addScriptFile($ext, $file, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
, $translate = TRUE) {
152 $this->translateScript($ext, $file);
154 return $this->addScriptUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
158 * Add a JavaScript file to the current page using <SCRIPT SRC>.
161 * @param $weight int, relative weight within a given region
162 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
163 * @return CRM_Core_Resources
165 public function addScriptUrl($url, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
166 CRM_Core_Region
::instance($region)->add(array(
168 'type' => 'scriptUrl',
177 * Add a JavaScript file to the current page using <SCRIPT SRC>.
179 * @param $code string, JavaScript source code
180 * @param $weight int, relative weight within a given region
181 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
182 * @return CRM_Core_Resources
184 public function addScript($code, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
185 CRM_Core_Region
::instance($region)->add(array(
186 // 'name' => automatic
196 * Add JavaScript variables to the global CRM object.
198 * @param $settings array
199 * @return CRM_Core_Resources
201 public function addSetting($settings) {
202 $this->settings
= $this->mergeSettings($this->settings
, $settings);
203 if (!$this->addedSettings
) {
205 CRM_Core_Region
::instance('settings')->add(array(
206 'callback' => function(&$snippet, &$html) use ($resources) {
207 $html .= "\n" . $resources->renderSetting();
210 $this->addedSettings
= TRUE;
216 * Add JavaScript variables to the global CRM object.
218 * @param $callable function
219 * @return CRM_Core_Resources
221 public function addSettingsFactory($callable) {
222 $this->addSetting(array()); // ensure that 'settings' region is created, even if empty
223 $this->settingsFactories
[] = $callable;
227 public function getSettings() {
228 $result = $this->settings
;
229 foreach ($this->settingsFactories
as $callable) {
230 $result = $this->mergeSettings($result, $callable());
236 * @param array $settings
237 * @param array $additions
238 * @return array combination of $settings and $additions
240 protected function mergeSettings($settings, $additions) {
241 foreach ($additions as $k => $v) {
242 if (isset($settings[$k]) && is_array($settings[$k]) && is_array($v)) {
251 * Helper fn for addSetting
252 * Render JavaScript variables for the global CRM object.
256 * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('foo' => 'bar')));
258 * CRM.myNamespace.foo // "bar"
262 public function renderSetting() {
263 return 'CRM = cj.extend(true, ' . json_encode($this->getSettings()) . ', CRM);';
267 * Add translated string to the js CRM object.
268 * It can then be retrived from the client-side ts() function
269 * Variable substitutions can happen from client-side
271 * Note: this function rarely needs to be called directly and is mostly for internal use.
272 * @see CRM_Core_Resources::addScriptFile which automatically adds translated strings from js files
276 * CRM_Core_Resources::singleton()->addString('Hello');
277 * // The string is now available to javascript code i.e.
280 * Example with client-side substitutions:
282 * CRM_Core_Resources::singleton()->addString('Your %1 has been %2');
283 * // ts() in javascript works the same as in php, for example:
284 * ts('Your %1 has been %2', {1: objectName, 2: actionTaken});
286 * NOTE: This function does not work with server-side substitutions
287 * (as this might result in collisions and unwanted variable injections)
288 * Instead, use code like:
289 * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('myString' => ts('Your %1 has been %2', array(subs)))));
290 * And from javascript access it at CRM.myNamespace.myString
292 * @param $text string|array
293 * @return CRM_Core_Resources
295 public function addString($text) {
296 foreach ((array) $text as $str) {
297 $translated = ts($str);
298 // We only need to push this string to client if the translation
299 // is actually different from the original
300 if ($translated != $str) {
301 $this->addSetting(array('strings' => array($str => $translated)));
308 * Add a CSS file to the current page using <LINK HREF>.
310 * @param $ext string, extension name; use 'civicrm' for core
311 * @param $file string, file path -- relative to the extension base dir
312 * @param $weight int, relative weight within a given region
313 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
314 * @return CRM_Core_Resources
316 public function addStyleFile($ext, $file, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
317 return $this->addStyleUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
321 * Add a CSS file to the current page using <LINK HREF>.
324 * @param $weight int, relative weight within a given region
325 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
326 * @return CRM_Core_Resources
328 public function addStyleUrl($url, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
329 CRM_Core_Region
::instance($region)->add(array(
331 'type' => 'styleUrl',
340 * Add a CSS content to the current page using <STYLE>.
342 * @param $code string, CSS source code
343 * @param $weight int, relative weight within a given region
344 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
345 * @return CRM_Core_Resources
347 public function addStyle($code, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
348 CRM_Core_Region
::instance($region)->add(array(
349 // 'name' => automatic
359 * Determine file path of a resource provided by an extension
361 * @param $ext string, extension name; use 'civicrm' for core
362 * @param $file string, file path -- relative to the extension base dir
364 * @return (string|bool), full file path or FALSE if not found
366 public function getPath($ext, $file) {
367 // TODO consider caching results
368 $path = $this->extMapper
->keyToBasePath($ext) . '/' . $file;
369 if (is_file($path)) {
376 * Determine public URL of a resource provided by an extension
378 * @param $ext string, extension name; use 'civicrm' for core
379 * @param $file string, file path -- relative to the extension base dir
380 * @return string, URL
382 public function getUrl($ext, $file = NULL, $addCacheCode = FALSE) {
383 if ($file === NULL) {
387 $file .= '?r=' . $this->getCacheCode();
389 // TODO consider caching results
390 return $this->extMapper
->keyToUrl($ext) . '/' . $file;
393 public function getCacheCode() {
394 return $this->cacheCode
;
397 public function setCacheCode($value) {
398 $this->cacheCode
= $value;
399 if ($this->cacheCodeKey
) {
400 CRM_Core_BAO_Setting
::setItem($value, CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, $this->cacheCodeKey
);
404 public function resetCacheCode() {
405 $this->setCacheCode(CRM_Utils_String
::createRandom(5, CRM_Utils_String
::ALPHANUMERIC
));
409 * This adds CiviCRM's standard css and js to the specified region of the document.
410 * It will only run once.
412 * TODO: Separate the functional code (like addStyle/addScript) from the policy code
413 * (like addCoreResources/addCoreStyles).
415 * @return CRM_Core_Resources
418 public function addCoreResources($region = 'html-header') {
419 if (!isset($this->addedCoreResources
[$region])) {
420 $this->addedCoreResources
[$region] = TRUE;
421 $config = CRM_Core_Config
::singleton();
423 // Add resources from jquery.files.tpl
424 $files = self
::parseTemplate('CRM/common/jquery.files.tpl');
426 foreach ($files as $file => $type) {
428 $this->addScriptFile('civicrm', $file, $jsWeight++
, $region, FALSE);
430 elseif ($type == 'css') {
431 $this->addStyleFile('civicrm', $file, -100, $region);
435 // Add localized calendar js
436 list($lang) = explode('_', $config->lcMessages
);
437 $localizationFile = "packages/jquery/jquery-ui-1.9.0/development-bundle/ui/i18n/jquery.ui.datepicker-{$lang}.js";
438 if ($this->getPath('civicrm', $localizationFile)) {
439 $this->addScriptFile('civicrm', $localizationFile, $jsWeight++
, $region, FALSE);
442 // Give control of jQuery back to the CMS - this loads last
443 $this->addScript('cj = jQuery.noConflict(true);', 9999, $region);
445 $this->addCoreStyles($region);
451 * This will add CiviCRM's standard CSS
453 * TODO: Separate the functional code (like addStyle/addScript) from the policy code
454 * (like addCoreResources/addCoreStyles).
456 * @param string $region
457 * @return CRM_Core_Resources
459 public function addCoreStyles($region = 'html-header') {
460 if (!isset($this->addedCoreStyles
[$region])) {
461 $this->addedCoreStyles
[$region] = TRUE;
463 // Load custom or core css
464 $config = CRM_Core_Config
::singleton();
465 if (!empty($config->customCSSURL
)) {
466 $this->addStyleUrl($config->customCSSURL
, -99, $region);
469 $this->addStyleFile('civicrm', 'css/civicrm.css', -99, $region);
470 $this->addStyleFile('civicrm', 'css/extras.css', -98, $region);
477 * Translate strings in a javascript file
479 * @param $ext string, extension name
480 * @param $file string, file path
483 private function translateScript($ext, $file) {
484 // For each extension, maintain one cache record which
485 // includes parsed (translatable) strings for all its JS files.
486 $stringsByFile = $this->cache
->get($ext); // array($file => array(...strings...))
487 if (!$stringsByFile) {
488 $stringsByFile = array();
490 if (!isset($stringsByFile[$file])) {
491 $filePath = $this->getPath($ext, $file);
492 if ($filePath && is_readable($filePath)) {
493 $stringsByFile[$file] = CRM_Utils_JS
::parseStrings(file_get_contents($filePath));
495 $stringsByFile[$file] = array();
497 $this->cache
->set($ext, $stringsByFile);
499 $this->addString($stringsByFile[$file]);
503 * Read resource files from a template
505 * @param $tpl (str) template file name
506 * @return array: filename => filetype
508 static function parseTemplate($tpl) {
510 $template = CRM_Core_Smarty
::singleton();
511 $buffer = $template->fetch($tpl);
512 $lines = preg_split('/\s+/', $buffer);
513 foreach ($lines as $line) {
516 $items[$line] = substr($line, 1 +
strrpos($line, '.'));