3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
53 private static $_singleton = NULL;
56 * @var CRM_Extension_Mapper
58 private $extMapper = NULL;
61 * @var CRM_Utils_Cache_Interface
63 private $cache = NULL;
66 * @var array free-form data tree
68 protected $settings = array();
69 protected $addedSettings = FALSE;
72 * @var array of callables
74 protected $settingsFactories = array();
77 * @var array ($regionName => bool)
79 protected $addedCoreResources = array();
82 * @var array ($regionName => bool)
84 protected $addedCoreStyles = array();
87 * @var string a value to append to JS/CSS URLs to coerce cache resets
89 protected $cacheCode = NULL;
92 * @var string the name of a setting which persistently stores the cacheCode
94 protected $cacheCodeKey = NULL;
99 public $ajaxPopupsEnabled;
102 * Get or set the single instance of CRM_Core_Resources
104 * @param CRM_Core_Resources $instance
105 * 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
131 * Map extension names to their base path or URLs.
132 * @param CRM_Utils_Cache_Interface $cache
133 * JS-localization cache.
134 * @param string|null $cacheCodeKey Random code to append to resource URLs; changing the code forces clients to reload resources
136 public function __construct($extMapper, $cache, $cacheCodeKey = NULL) {
137 $this->extMapper
= $extMapper;
138 $this->cache
= $cache;
139 $this->cacheCodeKey
= $cacheCodeKey;
140 if ($cacheCodeKey !== NULL) {
141 $this->cacheCode
= CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, $cacheCodeKey);
143 if (!$this->cacheCode
) {
144 $this->resetCacheCode();
146 $this->ajaxPopupsEnabled
= (bool) CRM_Core_BAO_Setting
::getItem(
147 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'ajaxPopupsEnabled', NULL, TRUE
152 * Add a JavaScript file to the current page using <SCRIPT SRC>.
155 * extension name; use 'civicrm' for core.
156 * @param string $file
157 * file path -- relative to the extension base dir.
159 * relative weight within a given region.
160 * @param string $region
161 * location within the file; 'html-header', 'page-header', 'page-footer'.
162 * @param $translate , whether to parse this file for strings enclosed in ts()
164 * @return CRM_Core_Resources
166 public function addScriptFile($ext, $file, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
, $translate = TRUE) {
168 $this->translateScript($ext, $file);
170 // Look for non-minified version if we are in debug mode
171 if (CRM_Core_Config
::singleton()->debug
&& strpos($file, '.min.js') !== FALSE) {
172 $nonMiniFile = str_replace('.min.js', '.js', $file);
173 if ($this->getPath($ext, $nonMiniFile)) {
174 $file = $nonMiniFile;
177 return $this->addScriptUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
181 * Add a JavaScript file to the current page using <SCRIPT SRC>.
185 * relative weight within a given region.
186 * @param string $region
187 * location within the file; 'html-header', 'page-header', 'page-footer'.
188 * @return CRM_Core_Resources
190 public function addScriptUrl($url, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
191 CRM_Core_Region
::instance($region)->add(array(
193 'type' => 'scriptUrl',
202 * Add a JavaScript file to the current page using <SCRIPT SRC>.
204 * @param string $code
205 * JavaScript source code.
207 * relative weight within a given region.
208 * @param string $region
209 * location within the file; 'html-header', 'page-header', 'page-footer'.
210 * @return CRM_Core_Resources
212 public function addScript($code, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
213 CRM_Core_Region
::instance($region)->add(array(
214 // 'name' => automatic
224 * Add JavaScript variables to CRM.vars
228 * CRM_Core_Resources::singleton()->addVars('myNamespace', array('foo' => 'bar'));
229 * Access var from javascript:
230 * CRM.vars.myNamespace.foo // "bar"
232 * @see http://wiki.civicrm.org/confluence/display/CRMDOC/Javascript+Reference
234 * @param string $nameSpace
235 * Usually the name of your extension.
237 * @return CRM_Core_Resources
239 public function addVars($nameSpace, $vars) {
240 $existing = CRM_Utils_Array
::value($nameSpace, CRM_Utils_Array
::value('vars', $this->settings
), array());
241 $vars = $this->mergeSettings($existing, $vars);
242 $this->addSetting(array('vars' => array($nameSpace => $vars)));
247 * Add JavaScript variables to the root of the CRM object.
248 * This function is usually reserved for low-level system use.
249 * Extensions and components should generally use addVars instead.
251 * @param array $settings
252 * @return CRM_Core_Resources
254 public function addSetting($settings) {
255 $this->settings
= $this->mergeSettings($this->settings
, $settings);
256 if (!$this->addedSettings
) {
257 $region = self
::isAjaxMode() ?
'ajax-snippet' : 'html-header';
259 CRM_Core_Region
::instance($region)->add(array(
260 'callback' => function (&$snippet, &$html) use ($resources) {
261 $html .= "\n" . $resources->renderSetting();
265 $this->addedSettings
= TRUE;
271 * Add JavaScript variables to the global CRM object via a callback function.
273 * @param callable $callable
274 * @return CRM_Core_Resources
276 public function addSettingsFactory($callable) {
277 // Make sure our callback has been registered
278 $this->addSetting(array());
279 $this->settingsFactories
[] = $callable;
284 * Helper fn for addSettingsFactory
286 public function getSettings() {
287 $result = $this->settings
;
288 foreach ($this->settingsFactories
as $callable) {
289 $result = $this->mergeSettings($result, $callable());
295 * @param array $settings
296 * @param array $additions
298 * combination of $settings and $additions
300 protected function mergeSettings($settings, $additions) {
301 foreach ($additions as $k => $v) {
302 if (isset($settings[$k]) && is_array($settings[$k]) && is_array($v)) {
311 * Helper fn for addSetting
312 * Render JavaScript variables for the global CRM object.
316 public function renderSetting() {
317 // On a standard page request we construct the CRM object from scratch
318 if (!self
::isAjaxMode()) {
319 $js = 'var CRM = ' . json_encode($this->getSettings()) . ';';
321 // For an ajax request we append to it
323 $js = 'CRM.$.extend(true, CRM, ' . json_encode($this->getSettings()) . ');';
325 return sprintf("<script type=\"text/javascript\">\n%s\n</script>\n", $js);
329 * Add translated string to the js CRM object.
330 * It can then be retrived from the client-side ts() function
331 * Variable substitutions can happen from client-side
333 * Note: this function rarely needs to be called directly and is mostly for internal use.
334 * See CRM_Core_Resources::addScriptFile which automatically adds translated strings from js files
338 * CRM_Core_Resources::singleton()->addString('Hello');
339 * // The string is now available to javascript code i.e.
342 * Example with client-side substitutions:
344 * CRM_Core_Resources::singleton()->addString('Your %1 has been %2');
345 * // ts() in javascript works the same as in php, for example:
346 * ts('Your %1 has been %2', {1: objectName, 2: actionTaken});
348 * NOTE: This function does not work with server-side substitutions
349 * (as this might result in collisions and unwanted variable injections)
350 * Instead, use code like:
351 * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('myString' => ts('Your %1 has been %2', array(subs)))));
352 * And from javascript access it at CRM.myNamespace.myString
354 * @param string|array $text
355 * @return CRM_Core_Resources
357 public function addString($text) {
358 foreach ((array) $text as $str) {
359 $translated = ts($str);
360 // We only need to push this string to client if the translation
361 // is actually different from the original
362 if ($translated != $str) {
363 $this->addSetting(array('strings' => array($str => $translated)));
370 * Add a CSS file to the current page using <LINK HREF>.
373 * extension name; use 'civicrm' for core.
374 * @param string $file
375 * file path -- relative to the extension base dir.
377 * relative weight within a given region.
378 * @param string $region
379 * location within the file; 'html-header', 'page-header', 'page-footer'.
380 * @return CRM_Core_Resources
382 public function addStyleFile($ext, $file, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
383 return $this->addStyleUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
387 * Add a CSS file to the current page using <LINK HREF>.
391 * relative weight within a given region.
392 * @param string $region
393 * location within the file; 'html-header', 'page-header', 'page-footer'.
394 * @return CRM_Core_Resources
396 public function addStyleUrl($url, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
397 CRM_Core_Region
::instance($region)->add(array(
399 'type' => 'styleUrl',
408 * Add a CSS content to the current page using <STYLE>.
410 * @param string $code
413 * relative weight within a given region.
414 * @param string $region
415 * location within the file; 'html-header', 'page-header', 'page-footer'.
416 * @return CRM_Core_Resources
418 public function addStyle($code, $weight = self
::DEFAULT_WEIGHT
, $region = self
::DEFAULT_REGION
) {
419 CRM_Core_Region
::instance($region)->add(array(
420 // 'name' => automatic
430 * Determine file path of a resource provided by an extension
433 * extension name; use 'civicrm' for core.
434 * @param string $file
435 * file path -- relative to the extension base dir.
437 * @return bool|string
438 * full file path or FALSE if not found
440 public function getPath($ext, $file) {
441 // TODO consider caching results
442 $path = $this->extMapper
->keyToBasePath($ext) . '/' . $file;
443 if (is_file($path)) {
450 * Determine public URL of a resource provided by an extension
453 * extension name; use 'civicrm' for core.
454 * @param string $file
455 * file path -- relative to the extension base dir.
456 * @param bool $addCacheCode
458 * @return string, URL
460 public function getUrl($ext, $file = NULL, $addCacheCode = FALSE) {
461 if ($file === NULL) {
465 $file .= '?r=' . $this->getCacheCode();
467 // TODO consider caching results
468 return $this->extMapper
->keyToUrl($ext) . '/' . $file;
474 public function getCacheCode() {
475 return $this->cacheCode
;
480 * @return CRM_Core_Resources
482 public function setCacheCode($value) {
483 $this->cacheCode
= $value;
484 if ($this->cacheCodeKey
) {
485 CRM_Core_BAO_Setting
::setItem($value, CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, $this->cacheCodeKey
);
491 * @return CRM_Core_Resources
493 public function resetCacheCode() {
494 $this->setCacheCode(CRM_Utils_String
::createRandom(5, CRM_Utils_String
::ALPHANUMERIC
));
495 // Also flush cms resource cache if needed
496 CRM_Core_Config
::singleton()->userSystem
->clearResourceCache();
501 * This adds CiviCRM's standard css and js to the specified region of the document.
502 * It will only run once.
504 * TODO: Separate the functional code (like addStyle/addScript) from the policy code
505 * (like addCoreResources/addCoreStyles).
507 * @param string $region
508 * @return CRM_Core_Resources
510 public function addCoreResources($region = 'html-header') {
511 if (!isset($this->addedCoreResources
[$region]) && !self
::isAjaxMode()) {
512 $this->addedCoreResources
[$region] = TRUE;
513 $config = CRM_Core_Config
::singleton();
515 // Add resources from coreResourceList
517 foreach ($this->coreResourceList() as $file) {
518 if (substr($file, -2) == 'js') {
519 // Don't bother looking for ts() calls in packages, there aren't any
520 $translate = (substr($file, 0, 9) != 'packages/');
521 $this->addScriptFile('civicrm', $file, $jsWeight++
, $region, $translate);
524 $this->addStyleFile('civicrm', $file, -100, $region);
528 // Dynamic localization script
529 $this->addScriptUrl(CRM_Utils_System
::url('civicrm/ajax/l10n-js/' . $config->lcMessages
, array('r' => $this->getCacheCode())), $jsWeight++
, $region);
531 // Add global settings
534 'ajaxPopupsEnabled' => $this->ajaxPopupsEnabled
,
535 'isFrontend' => $config->userFrameworkFrontend
,
538 // Disable profile creation if user lacks permission
539 if (!CRM_Core_Permission
::check('edit all contacts') && !CRM_Core_Permission
::check('add contacts')) {
540 $settings['config']['entityRef']['contactCreate'] = FALSE;
542 $this->addSetting($settings);
544 // Give control of jQuery and _ back to the CMS - this loads last
545 $this->addScriptFile('civicrm', 'js/noconflict.js', 9999, $region, FALSE);
547 $this->addCoreStyles($region);
553 * This will add CiviCRM's standard CSS
555 * TODO: Separate the functional code (like addStyle/addScript) from the policy code
556 * (like addCoreResources/addCoreStyles).
558 * @param string $region
559 * @return CRM_Core_Resources
561 public function addCoreStyles($region = 'html-header') {
562 if (!isset($this->addedCoreStyles
[$region])) {
563 $this->addedCoreStyles
[$region] = TRUE;
565 // Load custom or core css
566 $config = CRM_Core_Config
::singleton();
567 if (!empty($config->customCSSURL
)) {
568 $this->addStyleUrl($config->customCSSURL
, 99, $region);
570 if (!CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'disable_core_css')) {
571 $this->addStyleFile('civicrm', 'css/civicrm.css', -99, $region);
578 * Flushes cached translated strings
579 * @return CRM_Core_Resources
581 public function flushStrings() {
582 $this->cache
->flush();
587 * Translate strings in a javascript file
591 * @param string $file
595 private function translateScript($ext, $file) {
596 // For each extension, maintain one cache record which
597 // includes parsed (translatable) strings for all its JS files.
598 $stringsByFile = $this->cache
->get($ext); // array($file => array(...strings...))
599 if (!$stringsByFile) {
600 $stringsByFile = array();
602 if (!isset($stringsByFile[$file])) {
603 $filePath = $this->getPath($ext, $file);
604 if ($filePath && is_readable($filePath)) {
605 $stringsByFile[$file] = CRM_Utils_JS
::parseStrings(file_get_contents($filePath));
608 $stringsByFile[$file] = array();
610 $this->cache
->set($ext, $stringsByFile);
612 $this->addString($stringsByFile[$file]);
616 * Create dynamic script for localizing js widgets.
618 public static function outputLocalizationJS() {
619 CRM_Core_Page_AJAX
::setJsHeaders();
620 $config = CRM_Core_Config
::singleton();
622 'moneyFormat' => json_encode(CRM_Utils_Money
::format(1234.56)),
623 'contactSearch' => json_encode($config->includeEmailInName ?
ts('Start typing a name or email...') : ts('Start typing a name...')),
624 'otherSearch' => json_encode(ts('Enter search term...')),
625 'entityRef' => array(
626 'contactCreate' => CRM_Core_BAO_UFGroup
::getCreateLinks(),
627 'filters' => self
::getEntityRefFilters(),
630 print CRM_Core_Smarty
::singleton()->fetchWith('CRM/common/l10n.js.tpl', $vars);
631 CRM_Utils_System
::civiExit();
635 * List of core resources we add to every CiviCRM page
639 public function coreResourceList() {
640 $config = CRM_Core_Config
::singleton();
641 // Use minified files for production, uncompressed in debug mode
642 // Note, $this->addScriptFile would automatically search for the non-minified file in debug mode but this is probably faster
643 $min = $config->debug ?
'' : '.min';
645 // Scripts needed by everyone, everywhere
646 // FIXME: This is too long; list needs finer-grained segmentation
648 "packages/jquery/jquery-1.11.1$min.js",
649 "packages/jquery/jquery-ui/jquery-ui$min.js",
650 "packages/jquery/jquery-ui/jquery-ui$min.css",
651 "packages/backbone/lodash.compat$min.js",
652 "packages/jquery/plugins/jquery.mousewheel$min.js",
653 "packages/jquery/plugins/select2/select2$min.js",
654 "packages/jquery/plugins/select2/select2.css",
655 "packages/jquery/plugins/jquery.tableHeader.js",
656 "packages/jquery/plugins/jquery.textarearesizer.js",
657 "packages/jquery/plugins/jquery.form$min.js",
658 "packages/jquery/plugins/jquery.timeentry$min.js",
659 "packages/jquery/plugins/jquery.blockUI$min.js",
660 "packages/jquery/plugins/DataTables/media/js/jquery.dataTables$min.js",
661 "packages/jquery/plugins/DataTables/media/css/jquery.dataTables$min.css",
662 "packages/jquery/plugins/jquery.validate$min.js",
663 "packages/jquery/plugins/jquery.ui.datepicker.validation.pack.js",
668 // These scripts are only needed by back-office users
669 if (CRM_Core_Permission
::check('access CiviCRM')) {
670 $items[] = "packages/jquery/plugins/jquery.menu$min.js";
671 $items[] = "packages/jquery/css/menu.css";
672 $items[] = "packages/jquery/plugins/jquery.jeditable$min.js";
673 $items[] = "packages/jquery/plugins/jquery.notify$min.js";
674 $items[] = "js/jquery/jquery.crmeditable.js";
677 // JS for multilingual installations
678 if (!empty($config->languageLimit
) && count($config->languageLimit
) > 1 && CRM_Core_Permission
::check('translate CiviCRM')) {
679 $items[] = "js/crm.multilingual.js";
682 // Enable administrators to edit option lists in a dialog
683 if (CRM_Core_Permission
::check('administer CiviCRM') && $this->ajaxPopupsEnabled
) {
684 $items[] = "js/crm.optionEdit.js";
687 // Add localized jQuery UI files
688 if ($config->lcMessages
&& $config->lcMessages
!= 'en_US') {
689 // Search for i18n file in order of specificity (try fr-CA, then fr)
690 list($lang) = explode('_', $config->lcMessages
);
691 $path = "packages/jquery/jquery-ui/i18n";
692 foreach (array(str_replace('_', '-', $config->lcMessages
), $lang) as $language) {
693 $localizationFile = "$path/datepicker-{$language}.js";
694 if ($this->getPath('civicrm', $localizationFile)) {
695 $items[] = $localizationFile;
701 // CMS-specific resources
702 $config->userSystem
->appendCoreResources($items);
709 * is this page request an ajax snippet?
711 public static function isAjaxMode() {
712 return in_array(CRM_Utils_Array
::value('snippet', $_REQUEST), array(
713 CRM_Core_Smarty
::PRINT_SNIPPET
,
714 CRM_Core_Smarty
::PRINT_NOFORM
,
715 CRM_Core_Smarty
::PRINT_JSON
,
720 * Provide a list of available entityRef filters
721 * FIXME: This function doesn't really belong in this class
722 * @TODO: Provide a sane way to extend this list for other entities - a hook or??
725 public static function getEntityRefFilters() {
728 $filters['event'] = array(
729 array('key' => 'event_type_id', 'value' => ts('Event Type')),
731 'key' => 'start_date',
732 'value' => ts('Start Date'),
734 array('key' => '{">":"now"}', 'value' => ts('Upcoming')),
735 array('key' => '{"BETWEEN":["now - 3 month","now"]}', 'value' => ts('Past 3 Months')),
736 array('key' => '{"BETWEEN":["now - 6 month","now"]}', 'value' => ts('Past 6 Months')),
737 array('key' => '{"BETWEEN":["now - 1 year","now"]}', 'value' => ts('Past Year')),
742 $filters['activity'] = array(
743 array('key' => 'activity_type_id', 'value' => ts('Activity Type')),
744 array('key' => 'status_id', 'value' => ts('Activity Status')),
747 $filters['contact'] = array(
748 array('key' => 'contact_type', 'value' => ts('Contact Type')),
749 array('key' => 'group', 'value' => ts('Group'), 'entity' => 'group_contact'),
750 array('key' => 'tag', 'value' => ts('Tag'), 'entity' => 'entity_tag'),
751 array('key' => 'state_province', 'value' => ts('State/Province'), 'entity' => 'address'),
752 array('key' => 'country', 'value' => ts('Country'), 'entity' => 'address'),
753 array('key' => 'gender_id', 'value' => ts('Gender')),
754 array('key' => 'is_deceased', 'value' => ts('Deceased')),