3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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;
100 public $ajaxPopupsEnabled;
103 * Get or set the single instance of CRM_Core_Resources
105 * @param $instance CRM_Core_Resources, new copy of the manager
106 * @return CRM_Core_Resources
108 static public function singleton(CRM_Core_Resources
$instance = NULL) {
109 if ($instance !== NULL) {
110 self
::$_singleton = $instance;
112 if (self
::$_singleton === NULL) {
113 $sys = CRM_Extension_System
::singleton();
114 $cache = new CRM_Utils_Cache_SqlGroup(array(
115 'group' => 'js-strings',
118 self
::$_singleton = new CRM_Core_Resources(
121 CRM_Core_Config
::isUpgradeMode() ?
NULL : 'resCacheCode'
124 return self
::$_singleton;
128 * Construct a resource manager
130 * @param CRM_Extension_Mapper $extMapper Map extension names to their base path or URLs.
131 * @param CRM_Utils_Cache_Interface $cache JS-localization cache
132 * @param string|null $cacheCodeKey Random code to append to resource URLs; changing the code forces clients to reload resources
134 public function __construct($extMapper, $cache, $cacheCodeKey = NULL) {
135 $this->extMapper
= $extMapper;
136 $this->cache
= $cache;
137 $this->cacheCodeKey
= $cacheCodeKey;
138 if ($cacheCodeKey !== NULL) {
139 $this->cacheCode
= CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, $cacheCodeKey);
141 if (!$this->cacheCode
) {
142 $this->resetCacheCode();
144 $this->ajaxPopupsEnabled
= (bool) CRM_Core_BAO_Setting
::getItem(
145 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'ajaxPopupsEnabled', NULL, TRUE
150 * Add a JavaScript file to the current page using <SCRIPT SRC>.
152 * @param $ext string, extension name; use 'civicrm' for core
153 * @param $file string, file path -- relative to the extension base dir
154 * @param $weight int, relative weight within a given region
155 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
156 * @param $translate, whether to parse this file for strings enclosed in ts()
158 * @return CRM_Core_Resources
160 public function addScriptFile($ext, $file, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
, $translate = TRUE) {
162 $this->translateScript($ext, $file);
164 // Look for non-minified version if we are in debug mode
165 if (CRM_Core_Config
::singleton()->debug
&& strpos($file, '.min.js') !== FALSE) {
166 $nonMiniFile = str_replace('.min.js', '.js', $file);
167 if ($this->getPath($ext, $nonMiniFile)) {
168 $file = $nonMiniFile;
171 return $this->addScriptUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
175 * Add a JavaScript file to the current page using <SCRIPT SRC>.
178 * @param $weight int, relative weight within a given region
179 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
180 * @return CRM_Core_Resources
182 public function addScriptUrl($url, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
183 CRM_Core_Region
::instance($region)->add(array(
185 'type' => 'scriptUrl',
194 * Add a JavaScript file to the current page using <SCRIPT SRC>.
196 * @param $code string, JavaScript source code
197 * @param $weight int, relative weight within a given region
198 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
199 * @return CRM_Core_Resources
201 public function addScript($code, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
202 CRM_Core_Region
::instance($region)->add(array(
203 // 'name' => automatic
213 * Add JavaScript variables to the global CRM object.
217 * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('foo' => 'bar')));
219 * CRM.myNamespace.foo // "bar"
221 * @see http://wiki.civicrm.org/confluence/display/CRMDOC/Javascript+Reference
223 * @param $settings array
224 * @return CRM_Core_Resources
226 public function addSetting($settings) {
227 $this->settings
= $this->mergeSettings($this->settings
, $settings);
228 if (!$this->addedSettings
) {
230 CRM_Core_Region
::instance('html-header')->add(array(
231 'callback' => function(&$snippet, &$html) use ($resources) {
232 $html .= "\n" . $resources->renderSetting();
236 $this->addedSettings
= TRUE;
242 * Add JavaScript variables to the global CRM object via a callback function.
244 * @param callable $callable
245 * @return CRM_Core_Resources
247 public function addSettingsFactory($callable) {
248 // Make sure our callback has been registered
249 $this->addSetting(array());
250 $this->settingsFactories
[] = $callable;
255 * Helper fn for addSettingsFactory
257 public function getSettings() {
258 $result = $this->settings
;
259 foreach ($this->settingsFactories
as $callable) {
260 $result = $this->mergeSettings($result, $callable());
266 * @param array $settings
267 * @param array $additions
268 * @return array combination of $settings and $additions
270 protected function mergeSettings($settings, $additions) {
271 foreach ($additions as $k => $v) {
272 if (isset($settings[$k]) && is_array($settings[$k]) && is_array($v)) {
281 * Helper fn for addSetting
282 * Render JavaScript variables for the global CRM object.
286 public function renderSetting() {
287 $js = 'var CRM = ' . json_encode($this->getSettings()) . ';';
288 return sprintf("<script type=\"text/javascript\">\n%s\n</script>\n", $js);
292 * Add translated string to the js CRM object.
293 * It can then be retrived from the client-side ts() function
294 * Variable substitutions can happen from client-side
296 * Note: this function rarely needs to be called directly and is mostly for internal use.
297 * @see CRM_Core_Resources::addScriptFile which automatically adds translated strings from js files
301 * CRM_Core_Resources::singleton()->addString('Hello');
302 * // The string is now available to javascript code i.e.
305 * Example with client-side substitutions:
307 * CRM_Core_Resources::singleton()->addString('Your %1 has been %2');
308 * // ts() in javascript works the same as in php, for example:
309 * ts('Your %1 has been %2', {1: objectName, 2: actionTaken});
311 * NOTE: This function does not work with server-side substitutions
312 * (as this might result in collisions and unwanted variable injections)
313 * Instead, use code like:
314 * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('myString' => ts('Your %1 has been %2', array(subs)))));
315 * And from javascript access it at CRM.myNamespace.myString
317 * @param $text string|array
318 * @return CRM_Core_Resources
320 public function addString($text) {
321 foreach ((array) $text as $str) {
322 $translated = ts($str);
323 // We only need to push this string to client if the translation
324 // is actually different from the original
325 if ($translated != $str) {
326 $this->addSetting(array('strings' => array($str => $translated)));
333 * Add a CSS file to the current page using <LINK HREF>.
335 * @param $ext string, extension name; use 'civicrm' for core
336 * @param $file string, file path -- relative to the extension base dir
337 * @param $weight int, relative weight within a given region
338 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
339 * @return CRM_Core_Resources
341 public function addStyleFile($ext, $file, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
342 return $this->addStyleUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
346 * Add a CSS file to the current page using <LINK HREF>.
349 * @param $weight int, relative weight within a given region
350 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
351 * @return CRM_Core_Resources
353 public function addStyleUrl($url, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
354 CRM_Core_Region
::instance($region)->add(array(
356 'type' => 'styleUrl',
365 * Add a CSS content to the current page using <STYLE>.
367 * @param $code string, CSS source code
368 * @param $weight int, relative weight within a given region
369 * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
370 * @return CRM_Core_Resources
372 public function addStyle($code, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
373 CRM_Core_Region
::instance($region)->add(array(
374 // 'name' => automatic
384 * Determine file path of a resource provided by an extension
386 * @param $ext string, extension name; use 'civicrm' for core
387 * @param $file string, file path -- relative to the extension base dir
389 * @return bool|string (string|bool), full file path or FALSE if not found
391 public function getPath($ext, $file) {
392 // TODO consider caching results
393 $path = $this->extMapper
->keyToBasePath($ext) . '/' . $file;
394 if (is_file($path)) {
401 * Determine public URL of a resource provided by an extension
403 * @param $ext string, extension name; use 'civicrm' for core
404 * @param $file string, file path -- relative to the extension base dir
405 * @param bool $addCacheCode
407 * @return string, URL
409 public function getUrl($ext, $file = NULL, $addCacheCode = FALSE) {
410 if ($file === NULL) {
414 $file .= '?r=' . $this->getCacheCode();
416 // TODO consider caching results
417 return $this->extMapper
->keyToUrl($ext) . '/' . $file;
423 public function getCacheCode() {
424 return $this->cacheCode
;
430 public function setCacheCode($value) {
431 $this->cacheCode
= $value;
432 if ($this->cacheCodeKey
) {
433 CRM_Core_BAO_Setting
::setItem($value, CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, $this->cacheCodeKey
);
437 public function resetCacheCode() {
438 $this->setCacheCode(CRM_Utils_String
::createRandom(5, CRM_Utils_String
::ALPHANUMERIC
));
439 // Also flush cms resource cache if needed
440 CRM_Core_Config
::singleton()->userSystem
->clearResourceCache();
444 * This adds CiviCRM's standard css and js to the specified region of the document.
445 * It will only run once.
447 * TODO: Separate the functional code (like addStyle/addScript) from the policy code
448 * (like addCoreResources/addCoreStyles).
450 * @param string $region
451 * @return CRM_Core_Resources
454 public function addCoreResources($region = 'html-header') {
455 if (!isset($this->addedCoreResources
[$region])) {
456 $this->addedCoreResources
[$region] = TRUE;
457 $config = CRM_Core_Config
::singleton();
459 // Add resources from coreResourceList
461 foreach ($this->coreResourceList() as $file) {
462 if (substr($file, -2) == 'js') {
463 // Don't bother looking for ts() calls in packages, there aren't any
464 $translate = (substr($file, 0, 9) != 'packages/');
465 $this->addScriptFile('civicrm', $file, $jsWeight++
, $region, $translate);
468 $this->addStyleFile('civicrm', $file, -100, $region);
472 // Dynamic localization script
473 $this->addScriptUrl($this->addLocalizationJs(), $jsWeight++
, $region);
475 // Add global settings
476 $settings = array('config' => array(
477 'ajaxPopupsEnabled' => $this->ajaxPopupsEnabled
,
479 // Disable profile creation if user lacks permission
480 if (!CRM_Core_Permission
::check('edit all contacts') && !CRM_Core_Permission
::check('add contacts')) {
481 $settings['profileCreate'] = FALSE;
483 $this->addSetting($settings);
485 // Give control of jQuery and _ back to the CMS - this loads last
486 $this->addScriptFile('civicrm', 'js/noconflict.js', 9999, $region, FALSE);
488 $this->addCoreStyles($region);
494 * This will add CiviCRM's standard CSS
496 * TODO: Separate the functional code (like addStyle/addScript) from the policy code
497 * (like addCoreResources/addCoreStyles).
499 * @param string $region
500 * @return CRM_Core_Resources
502 public function addCoreStyles($region = 'html-header') {
503 if (!isset($this->addedCoreStyles
[$region])) {
504 $this->addedCoreStyles
[$region] = TRUE;
506 // Load custom or core css
507 $config = CRM_Core_Config
::singleton();
508 if (!empty($config->customCSSURL
)) {
509 $this->addStyleUrl($config->customCSSURL
, 99, $region);
511 if (!CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'disable_core_css')) {
512 $this->addStyleFile('civicrm', 'css/civicrm.css', -99, $region);
519 * Flushes cached translated strings
521 public function flushStrings() {
522 $this->cache
->flush();
526 * Translate strings in a javascript file
528 * @param $ext string, extension name
529 * @param $file string, file path
532 private function translateScript($ext, $file) {
533 // For each extension, maintain one cache record which
534 // includes parsed (translatable) strings for all its JS files.
535 $stringsByFile = $this->cache
->get($ext); // array($file => array(...strings...))
536 if (!$stringsByFile) {
537 $stringsByFile = array();
539 if (!isset($stringsByFile[$file])) {
540 $filePath = $this->getPath($ext, $file);
541 if ($filePath && is_readable($filePath)) {
542 $stringsByFile[$file] = CRM_Utils_JS
::parseStrings(file_get_contents($filePath));
544 $stringsByFile[$file] = array();
546 $this->cache
->set($ext, $stringsByFile);
548 $this->addString($stringsByFile[$file]);
552 * Add dynamic l10n js
554 * @return string URL of JS file
556 private function addLocalizationJs() {
557 $config = CRM_Core_Config
::singleton();
558 $fileName = 'l10n-' . $config->lcMessages
. '.js';
559 if (!is_file(CRM_Utils_File
::dynamicResourcePath($fileName))) {
560 CRM_Utils_File
::addDynamicResource($fileName, $this->createLocalizationJs());
562 // Dynamic localization script
563 return CRM_Utils_File
::dynamicResourceUrl($fileName);
567 * Create dynamic script for localizing js widgets
569 * @return string javascript content
571 private function createLocalizationJs() {
572 $config = CRM_Core_Config
::singleton();
574 'moneyFormat' => json_encode(CRM_Utils_Money
::format(1234.56)),
575 'contactSearch' => json_encode($config->includeEmailInName ?
ts('Start typing a name or email...') : ts('Start typing a name...')),
576 'otherSearch' => json_encode(ts('Enter search term...')),
577 'contactCreate' => CRM_Core_BAO_UFGroup
::getCreateLinks(),
579 return CRM_Core_Smarty
::singleton()->fetchWith('CRM/common/localization.js.tpl', $vars);
583 * List of core resources we add to every CiviCRM page
587 public function coreResourceList() {
588 $config = CRM_Core_Config
::singleton();
589 // Use minified files for production, uncompressed in debug mode
590 // Note, $this->addScriptFile would automatically search for the non-minified file in debug mode but this is probably faster
591 $min = $config->debug ?
'' : '.min';
593 // Scripts needed by everyone, everywhere
594 // FIXME: This is too long; list needs finer-grained segmentation
596 "packages/jquery/jquery-1.11.1$min.js",
597 "packages/jquery/jquery-ui/jquery-ui$min.js",
598 "packages/jquery/jquery-ui/jquery-ui$min.css",
600 "packages/backbone/lodash.compat$min.js",
602 "packages/jquery/plugins/jquery.mousewheel$min.js",
604 "packages/jquery/plugins/select2/select2$min.js",
605 "packages/jquery/plugins/select2/select2.css",
607 "packages/jquery/plugins/jquery.tableHeader.js",
609 "packages/jquery/plugins/jquery.textarearesizer.js",
611 "packages/jquery/plugins/jquery.form$min.js",
613 "packages/jquery/plugins/jquery.timeentry$min.js",
615 "packages/jquery/plugins/jquery.blockUI$min.js",
617 "packages/jquery/plugins/DataTables/media/js/jquery.dataTables$min.js",
618 "packages/jquery/plugins/DataTables/media/css/jquery.dataTables$min.css",
620 "packages/jquery/plugins/jquery.validate$min.js",
621 "packages/jquery/plugins/jquery.ui.datepicker.validation.pack.js",
627 // These scripts are only needed by back-office users
628 if (CRM_Core_Permission
::check('access CiviCRM')) {
629 $items[] = "packages/jquery/plugins/jquery.menu$min.js";
630 $items[] = "packages/jquery/css/menu.css";
631 $items[] = "packages/jquery/plugins/jquery.jeditable$min.js";
632 $items[] = "packages/jquery/plugins/jquery.notify$min.js";
633 $items[] = "js/jquery/jquery.crmeditable.js";
636 // Enable administrators to edit option lists in a dialog
637 if (CRM_Core_Permission
::check('administer CiviCRM') && $this->ajaxPopupsEnabled
) {
638 $items[] = "js/crm.optionEdit.js";
641 // Add localized jQuery UI files
642 if ($config->lcMessages
&& $config->lcMessages
!= 'en_US') {
643 // Search for i18n file in order of specificity (try fr-CA, then fr)
644 list($lang) = explode('_', $config->lcMessages
);
645 $path = "packages/jquery/jquery-ui/i18n";
646 foreach (array(str_replace('_', '-', $config->lcMessages
), $lang) as $language) {
647 $localizationFile = "$path/datepicker-{$language}.js";
648 if ($this->getPath('civicrm', $localizationFile)) {
649 $items[] = $localizationFile;