CRM/Core/Resources.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.7                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2017                                |
   7   +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  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.   |
  13   |                                                                    |
  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.        |
  18   |                                                                    |
  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   +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This class facilitates the loading of resources
  30  * such as JavaScript files and CSS files.
  31  *
  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).
  35  *
  36  * TODO: This is currently a thin wrapper over CRM_Core_Region. We
  37  * should incorporte services for aggregation, minimization, etc.
  38  *
  39  * @package CRM
  40  * @copyright CiviCRM LLC (c) 2004-2017
  41  * $Id$
  42  *
  43  */
  44 class CRM_Core_Resources {
  45   const DEFAULT_WEIGHT = 0;
  46   const DEFAULT_REGION = 'page-footer';
  47
  48   /**
  49    * We don't have a container or dependency-injection, so use singleton instead
  50    *
  51    * @var object
  52    */
  53   private static $_singleton = NULL;
  54
  55   /**
  56    * @var CRM_Extension_Mapper
  57    */
  58   private $extMapper = NULL;
  59
  60   /**
  61    * @var CRM_Core_Resources_Strings
  62    */
  63   private $strings = NULL;
  64
  65   /**
  66    * @var array free-form data tree
  67    */
  68   protected $settings = array();
  69   protected $addedSettings = FALSE;
  70
  71   /**
  72    * @var array of callables
  73    */
  74   protected $settingsFactories = array();
  75
  76   /**
  77    * @var array ($regionName => bool)
  78    */
  79   protected $addedCoreResources = array();
  80
  81   /**
  82    * @var array ($regionName => bool)
  83    */
  84   protected $addedCoreStyles = array();
  85
  86   /**
  87    * @var string a value to append to JS/CSS URLs to coerce cache resets
  88    */
  89   protected $cacheCode = NULL;
  90
  91   /**
  92    * @var string the name of a setting which persistently stores the cacheCode
  93    */
  94   protected $cacheCodeKey = NULL;
  95
  96   /**
  97    * @var bool
  98    */
  99   public $ajaxPopupsEnabled;
 100
 101   /**
 102    * @var \Civi\Core\Paths
 103    */
 104   protected $paths;
 105
 106   /**
 107    * Get or set the single instance of CRM_Core_Resources.
 108    *
 109    * @param CRM_Core_Resources $instance
 110    *   New copy of the manager.
 111    * @return CRM_Core_Resources
 112    */
 113   static public function singleton(CRM_Core_Resources $instance = NULL) {
 114     if ($instance !== NULL) {
 115       self::$_singleton = $instance;
 116     }
 117     if (self::$_singleton === NULL) {
 118       $sys = CRM_Extension_System::singleton();
 119       $cache = Civi::cache('js_strings');
 120       self::$_singleton = new CRM_Core_Resources(
 121         $sys->getMapper(),
 122         $cache,
 123         CRM_Core_Config::isUpgradeMode() ? NULL : 'resCacheCode'
 124       );
 125     }
 126     return self::$_singleton;
 127   }
 128
 129   /**
 130    * Construct a resource manager.
 131    *
 132    * @param CRM_Extension_Mapper $extMapper
 133    *   Map extension names to their base path or URLs.
 134    * @param CRM_Utils_Cache_Interface $cache
 135    *   JS-localization cache.
 136    * @param string|null $cacheCodeKey Random code to append to resource URLs; changing the code forces clients to reload resources
 137    */
 138   public function __construct($extMapper, $cache, $cacheCodeKey = NULL) {
 139     $this->extMapper = $extMapper;
 140     $this->strings = new CRM_Core_Resources_Strings($cache);
 141     $this->cacheCodeKey = $cacheCodeKey;
 142     if ($cacheCodeKey !== NULL) {
 143       $this->cacheCode = Civi::settings()->get($cacheCodeKey);
 144     }
 145     if (!$this->cacheCode) {
 146       $this->resetCacheCode();
 147     }
 148     $this->ajaxPopupsEnabled = (bool) Civi::settings()->get('ajaxPopupsEnabled');
 149     $this->paths = Civi::paths();
 150   }
 151
 152   /**
 153    * Export permission data to the client to enable smarter GUIs.
 154    *
 155    * Note: Application security stems from the server's enforcement
 156    * of the security logic (e.g. in the API permissions). There's no way
 157    * the client can use this info to make the app more secure; however,
 158    * it can produce a better-tuned (non-broken) UI.
 159    *
 160    * @param array $permNames
 161    *   List of permission names to check/export.
 162    * @return CRM_Core_Resources
 163    */
 164   public function addPermissions($permNames) {
 165     $permNames = (array) $permNames;
 166     $perms = array();
 167     foreach ($permNames as $permName) {
 168       $perms[$permName] = CRM_Core_Permission::check($permName);
 169     }
 170     return $this->addSetting(array(
 171       'permissions' => $perms,
 172     ));
 173   }
 174
 175   /**
 176    * Add a JavaScript file to the current page using <SCRIPT SRC>.
 177    *
 178    * @param string $ext
 179    *   extension name; use 'civicrm' for core.
 180    * @param string $file
 181    *   file path -- relative to the extension base dir.
 182    * @param int $weight
 183    *   relative weight within a given region.
 184    * @param string $region
 185    *   location within the file; 'html-header', 'page-header', 'page-footer'.
 186    * @param bool|string $translate
 187    *   Whether to load translated strings for this file. Use one of:
 188    *   - FALSE: Do not load translated strings.
 189    *   - TRUE: Load translated strings. Use the $ext's default domain.
 190    *   - string: Load translated strings. Use a specific domain.
 191    *
 192    * @return CRM_Core_Resources
 193    */
 194   public function addScriptFile($ext, $file, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION, $translate = TRUE) {
 195     if ($translate) {
 196       $domain = ($translate === TRUE) ? $ext : $translate;
 197       $this->addString($this->strings->get($domain, $this->getPath($ext, $file), 'text/javascript'), $domain);
 198     }
 199     $this->resolveFileName($file, $ext);
 200     return $this->addScriptUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
 201   }
 202
 203   /**
 204    * Add a JavaScript file to the current page using <SCRIPT SRC>.
 205    *
 206    * @param string $url
 207    * @param int $weight
 208    *   relative weight within a given region.
 209    * @param string $region
 210    *   location within the file; 'html-header', 'page-header', 'page-footer'.
 211    * @return CRM_Core_Resources
 212    */
 213   public function addScriptUrl($url, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
 214     CRM_Core_Region::instance($region)->add(array(
 215         'name' => $url,
 216         'type' => 'scriptUrl',
 217         'scriptUrl' => $url,
 218         'weight' => $weight,
 219         'region' => $region,
 220       ));
 221     return $this;
 222   }
 223
 224   /**
 225    * Add a JavaScript file to the current page using <SCRIPT SRC>.
 226    *
 227    * @param string $code
 228    *   JavaScript source code.
 229    * @param int $weight
 230    *   relative weight within a given region.
 231    * @param string $region
 232    *   location within the file; 'html-header', 'page-header', 'page-footer'.
 233    * @return CRM_Core_Resources
 234    */
 235   public function addScript($code, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
 236     CRM_Core_Region::instance($region)->add(array(
 237         // 'name' => automatic
 238         'type' => 'script',
 239         'script' => $code,
 240         'weight' => $weight,
 241         'region' => $region,
 242       ));
 243     return $this;
 244   }
 245
 246   /**
 247    * Add JavaScript variables to CRM.vars
 248    *
 249    * Example:
 250    * From the server:
 251    * CRM_Core_Resources::singleton()->addVars('myNamespace', array('foo' => 'bar'));
 252    * Access var from javascript:
 253    * CRM.vars.myNamespace.foo // "bar"
 254    *
 255    * @see http://wiki.civicrm.org/confluence/display/CRMDOC/Javascript+Reference
 256    *
 257    * @param string $nameSpace
 258    *   Usually the name of your extension.
 259    * @param array $vars
 260    * @return CRM_Core_Resources
 261    */
 262   public function addVars($nameSpace, $vars) {
 263     $existing = CRM_Utils_Array::value($nameSpace, CRM_Utils_Array::value('vars', $this->settings), array());
 264     $vars = $this->mergeSettings($existing, $vars);
 265     $this->addSetting(array('vars' => array($nameSpace => $vars)));
 266     return $this;
 267   }
 268
 269   /**
 270    * Add JavaScript variables to the root of the CRM object.
 271    * This function is usually reserved for low-level system use.
 272    * Extensions and components should generally use addVars instead.
 273    *
 274    * @param array $settings
 275    * @return CRM_Core_Resources
 276    */
 277   public function addSetting($settings) {
 278     $this->settings = $this->mergeSettings($this->settings, $settings);
 279     if (!$this->addedSettings) {
 280       $region = self::isAjaxMode() ? 'ajax-snippet' : 'html-header';
 281       $resources = $this;
 282       CRM_Core_Region::instance($region)->add(array(
 283         'callback' => function (&$snippet, &$html) use ($resources) {
 284           $html .= "\n" . $resources->renderSetting();
 285         },
 286         'weight' => -100000,
 287       ));
 288       $this->addedSettings = TRUE;
 289     }
 290     return $this;
 291   }
 292
 293   /**
 294    * Add JavaScript variables to the global CRM object via a callback function.
 295    *
 296    * @param callable $callable
 297    * @return CRM_Core_Resources
 298    */
 299   public function addSettingsFactory($callable) {
 300     // Make sure our callback has been registered
 301     $this->addSetting(array());
 302     $this->settingsFactories[] = $callable;
 303     return $this;
 304   }
 305
 306   /**
 307    * Helper fn for addSettingsFactory.
 308    */
 309   public function getSettings() {
 310     $result = $this->settings;
 311     foreach ($this->settingsFactories as $callable) {
 312       $result = $this->mergeSettings($result, $callable());
 313     }
 314     return $result;
 315   }
 316
 317   /**
 318    * @param array $settings
 319    * @param array $additions
 320    * @return array
 321    *   combination of $settings and $additions
 322    */
 323   protected function mergeSettings($settings, $additions) {
 324     foreach ($additions as $k => $v) {
 325       if (isset($settings[$k]) && is_array($settings[$k]) && is_array($v)) {
 326         $v += $settings[$k];
 327       }
 328       $settings[$k] = $v;
 329     }
 330     return $settings;
 331   }
 332
 333   /**
 334    * Helper fn for addSetting.
 335    * Render JavaScript variables for the global CRM object.
 336    *
 337    * @return string
 338    */
 339   public function renderSetting() {
 340     // On a standard page request we construct the CRM object from scratch
 341     if (!self::isAjaxMode()) {
 342       $js = 'var CRM = ' . json_encode($this->getSettings()) . ';';
 343     }
 344     // For an ajax request we append to it
 345     else {
 346       $js = 'CRM.$.extend(true, CRM, ' . json_encode($this->getSettings()) . ');';
 347     }
 348     return sprintf("<script type=\"text/javascript\">\n%s\n</script>\n", $js);
 349   }
 350
 351   /**
 352    * Add translated string to the js CRM object.
 353    * It can then be retrived from the client-side ts() function
 354    * Variable substitutions can happen from client-side
 355    *
 356    * Note: this function rarely needs to be called directly and is mostly for internal use.
 357    * See CRM_Core_Resources::addScriptFile which automatically adds translated strings from js files
 358    *
 359    * Simple example:
 360    * // From php:
 361    * CRM_Core_Resources::singleton()->addString('Hello');
 362    * // The string is now available to javascript code i.e.
 363    * ts('Hello');
 364    *
 365    * Example with client-side substitutions:
 366    * // From php:
 367    * CRM_Core_Resources::singleton()->addString('Your %1 has been %2');
 368    * // ts() in javascript works the same as in php, for example:
 369    * ts('Your %1 has been %2', {1: objectName, 2: actionTaken});
 370    *
 371    * NOTE: This function does not work with server-side substitutions
 372    * (as this might result in collisions and unwanted variable injections)
 373    * Instead, use code like:
 374    * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('myString' => ts('Your %1 has been %2', array(subs)))));
 375    * And from javascript access it at CRM.myNamespace.myString
 376    *
 377    * @param string|array $text
 378    * @param string|NULL $domain
 379    * @return CRM_Core_Resources
 380    */
 381   public function addString($text, $domain = 'civicrm') {
 382     foreach ((array) $text as $str) {
 383       $translated = ts($str, array(
 384         'domain' => ($domain == 'civicrm') ? NULL : array($domain, NULL),
 385         'raw' => TRUE,
 386       ));
 387
 388       // We only need to push this string to client if the translation
 389       // is actually different from the original
 390       if ($translated != $str) {
 391         $bucket = $domain == 'civicrm' ? 'strings' : 'strings::' . $domain;
 392         $this->addSetting(array(
 393           $bucket => array($str => $translated),
 394         ));
 395       }
 396     }
 397     return $this;
 398   }
 399
 400   /**
 401    * Add a CSS file to the current page using <LINK HREF>.
 402    *
 403    * @param string $ext
 404    *   extension name; use 'civicrm' for core.
 405    * @param string $file
 406    *   file path -- relative to the extension base dir.
 407    * @param int $weight
 408    *   relative weight within a given region.
 409    * @param string $region
 410    *   location within the file; 'html-header', 'page-header', 'page-footer'.
 411    * @return CRM_Core_Resources
 412    */
 413   public function addStyleFile($ext, $file, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
 414     $this->resolveFileName($file, $ext);
 415     return $this->addStyleUrl($this->getUrl($ext, $file, TRUE), $weight, $region);
 416   }
 417
 418   /**
 419    * Add a CSS file to the current page using <LINK HREF>.
 420    *
 421    * @param string $url
 422    * @param int $weight
 423    *   relative weight within a given region.
 424    * @param string $region
 425    *   location within the file; 'html-header', 'page-header', 'page-footer'.
 426    * @return CRM_Core_Resources
 427    */
 428   public function addStyleUrl($url, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
 429     CRM_Core_Region::instance($region)->add(array(
 430         'name' => $url,
 431         'type' => 'styleUrl',
 432         'styleUrl' => $url,
 433         'weight' => $weight,
 434         'region' => $region,
 435       ));
 436     return $this;
 437   }
 438
 439   /**
 440    * Add a CSS content to the current page using <STYLE>.
 441    *
 442    * @param string $code
 443    *   CSS source code.
 444    * @param int $weight
 445    *   relative weight within a given region.
 446    * @param string $region
 447    *   location within the file; 'html-header', 'page-header', 'page-footer'.
 448    * @return CRM_Core_Resources
 449    */
 450   public function addStyle($code, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
 451     CRM_Core_Region::instance($region)->add(array(
 452         // 'name' => automatic
 453         'type' => 'style',
 454         'style' => $code,
 455         'weight' => $weight,
 456         'region' => $region,
 457       ));
 458     return $this;
 459   }
 460
 461   /**
 462    * Determine file path of a resource provided by an extension.
 463    *
 464    * @param string $ext
 465    *   extension name; use 'civicrm' for core.
 466    * @param string|NULL $file
 467    *   file path -- relative to the extension base dir.
 468    *
 469    * @return bool|string
 470    *   full file path or FALSE if not found
 471    */
 472   public function getPath($ext, $file = NULL) {
 473     // TODO consider caching results
 474     $base = $this->paths->hasVariable($ext)
 475       ? rtrim($this->paths->getVariable($ext, 'path'), '/')
 476       : $this->extMapper->keyToBasePath($ext);
 477     if ($file === NULL) {
 478       return $base;
 479     }
 480     $path = $base . '/' . $file;
 481     if (is_file($path)) {
 482       return $path;
 483     }
 484     return FALSE;
 485   }
 486
 487   /**
 488    * Determine public URL of a resource provided by an extension.
 489    *
 490    * @param string $ext
 491    *   extension name; use 'civicrm' for core.
 492    * @param string $file
 493    *   file path -- relative to the extension base dir.
 494    * @param bool $addCacheCode
 495    *
 496    * @return string, URL
 497    */
 498   public function getUrl($ext, $file = NULL, $addCacheCode = FALSE) {
 499     if ($file === NULL) {
 500       $file = '';
 501     }
 502     if ($addCacheCode) {
 503       $file = $this->addCacheCode($file);
 504     }
 505     // TODO consider caching results
 506     $base = $this->paths->hasVariable($ext)
 507       ? $this->paths->getVariable($ext, 'url')
 508       : ($this->extMapper->keyToUrl($ext) . '/');
 509     return $base . $file;
 510   }
 511
 512   /**
 513    * Evaluate a glob pattern in the context of a particular extension.
 514    *
 515    * @param string $ext
 516    *   Extension name; use 'civicrm' for core.
 517    * @param string|array $patterns
 518    *   Glob pattern; e.g. "*.html".
 519    * @param null|int $flags
 520    *   See glob().
 521    * @return array
 522    *   List of matching files, relative to the extension base dir.
 523    * @see glob()
 524    */
 525   public function glob($ext, $patterns, $flags = NULL) {
 526     $path = $this->getPath($ext);
 527     $patterns = (array) $patterns;
 528     $files = array();
 529     foreach ($patterns as $pattern) {
 530       if (CRM_Utils_File::isAbsolute($pattern)) {
 531         // Absolute path.
 532         $files = array_merge($files, (array) glob($pattern, $flags));
 533       }
 534       else {
 535         // Relative path.
 536         $files = array_merge($files, (array) glob("$path/$pattern", $flags));
 537       }
 538     }
 539     sort($files); // Deterministic order.
 540     $files = array_unique($files);
 541     return array_map(function ($file) use ($path) {
 542       return CRM_Utils_File::relativize($file, "$path/");
 543     }, $files);
 544   }
 545
 546   /**
 547    * @return string
 548    */
 549   public function getCacheCode() {
 550     return $this->cacheCode;
 551   }
 552
 553   /**
 554    * @param $value
 555    * @return CRM_Core_Resources
 556    */
 557   public function setCacheCode($value) {
 558     $this->cacheCode = $value;
 559     if ($this->cacheCodeKey) {
 560       Civi::settings()->set($this->cacheCodeKey, $value);
 561     }
 562     return $this;
 563   }
 564
 565   /**
 566    * @return CRM_Core_Resources
 567    */
 568   public function resetCacheCode() {
 569     $this->setCacheCode(CRM_Utils_String::createRandom(5, CRM_Utils_String::ALPHANUMERIC));
 570     // Also flush cms resource cache if needed
 571     CRM_Core_Config::singleton()->userSystem->clearResourceCache();
 572     return $this;
 573   }
 574
 575   /**
 576    * This adds CiviCRM's standard css and js to the specified region of the document.
 577    * It will only run once.
 578    *
 579    * TODO: Separate the functional code (like addStyle/addScript) from the policy code
 580    * (like addCoreResources/addCoreStyles).
 581    *
 582    * @param string $region
 583    * @return CRM_Core_Resources
 584    */
 585   public function addCoreResources($region = 'html-header') {
 586     if (!isset($this->addedCoreResources[$region]) && !self::isAjaxMode()) {
 587       $this->addedCoreResources[$region] = TRUE;
 588       $config = CRM_Core_Config::singleton();
 589
 590       // Add resources from coreResourceList
 591       $jsWeight = -9999;
 592       foreach ($this->coreResourceList($region) as $item) {
 593         if (is_array($item)) {
 594           $this->addSetting($item);
 595         }
 596         elseif (substr($item, -2) == 'js') {
 597           // Don't bother  looking for ts() calls in packages, there aren't any
 598           $translate = (substr($item, 0, 3) == 'js/');
 599           $this->addScriptFile('civicrm', $item, $jsWeight++, $region, $translate);
 600         }
 601         else {
 602           $this->addStyleFile('civicrm', $item, -100, $region);
 603         }
 604       }
 605
 606       $tsLocale = CRM_Core_I18n::getLocale();
 607       // Dynamic localization script
 608       $this->addScriptUrl(CRM_Utils_System::url('civicrm/ajax/l10n-js/' . $tsLocale, array('r' => $this->getCacheCode())), $jsWeight++, $region);
 609
 610       // Add global settings
 611       $settings = array(
 612         'config' => array(
 613           'isFrontend' => $config->userFrameworkFrontend,
 614         ),
 615       );
 616       // Disable profile creation if user lacks permission
 617       if (!CRM_Core_Permission::check('edit all contacts') && !CRM_Core_Permission::check('add contacts')) {
 618         $settings['config']['entityRef']['contactCreate'] = FALSE;
 619       }
 620       $this->addSetting($settings);
 621
 622       // Give control of jQuery and _ back to the CMS - this loads last
 623       $this->addScriptFile('civicrm', 'js/noconflict.js', 9999, $region, FALSE);
 624
 625       $this->addCoreStyles($region);
 626     }
 627     return $this;
 628   }
 629
 630   /**
 631    * This will add CiviCRM's standard CSS
 632    *
 633    * TODO: Separate the functional code (like addStyle/addScript) from the policy code
 634    * (like addCoreResources/addCoreStyles).
 635    *
 636    * @param string $region
 637    * @return CRM_Core_Resources
 638    */
 639   public function addCoreStyles($region = 'html-header') {
 640     if (!isset($this->addedCoreStyles[$region])) {
 641       $this->addedCoreStyles[$region] = TRUE;
 642
 643       // Load custom or core css
 644       $config = CRM_Core_Config::singleton();
 645       if (!empty($config->customCSSURL)) {
 646         $customCSSURL = $this->addCacheCode($config->customCSSURL);
 647         $this->addStyleUrl($customCSSURL, 99, $region);
 648       }
 649       if (!Civi::settings()->get('disable_core_css')) {
 650         $this->addStyleFile('civicrm', 'css/civicrm.css', -99, $region);
 651       }
 652       // crm-i.css added ahead of other styles so it can be overridden by FA.
 653       $this->addStyleFile('civicrm', 'css/crm-i.css', -101, $region);
 654     }
 655     return $this;
 656   }
 657
 658   /**
 659    * Flushes cached translated strings.
 660    * @return CRM_Core_Resources
 661    */
 662   public function flushStrings() {
 663     $this->strings->flush();
 664     return $this;
 665   }
 666
 667   /**
 668    * @return CRM_Core_Resources_Strings
 669    */
 670   public function getStrings() {
 671     return $this->strings;
 672   }
 673
 674   /**
 675    * Create dynamic script for localizing js widgets.
 676    */
 677   public static function outputLocalizationJS() {
 678     CRM_Core_Page_AJAX::setJsHeaders();
 679     $config = CRM_Core_Config::singleton();
 680     $vars = array(
 681       'moneyFormat' => json_encode(CRM_Utils_Money::format(1234.56)),
 682       'contactSearch' => json_encode($config->includeEmailInName ? ts('Start typing a name or email...') : ts('Start typing a name...')),
 683       'otherSearch' => json_encode(ts('Enter search term...')),
 684       'entityRef' => array(
 685         'contactCreate' => CRM_Core_BAO_UFGroup::getCreateLinks(),
 686         'filters' => self::getEntityRefFilters(),
 687       ),
 688       'ajaxPopupsEnabled' => self::singleton()->ajaxPopupsEnabled,
 689     );
 690     print CRM_Core_Smarty::singleton()->fetchWith('CRM/common/l10n.js.tpl', $vars);
 691     CRM_Utils_System::civiExit();
 692   }
 693
 694   /**
 695    * List of core resources we add to every CiviCRM page.
 696    *
 697    * Note: non-compressed versions of .min files will be used in debug mode
 698    *
 699    * @param string $region
 700    * @return array
 701    */
 702   public function coreResourceList($region) {
 703     $config = CRM_Core_Config::singleton();
 704
 705     // Scripts needed by everyone, everywhere
 706     // FIXME: This is too long; list needs finer-grained segmentation
 707     $items = array(
 708       "bower_components/jquery/dist/jquery.min.js",
 709       "bower_components/jquery-ui/jquery-ui.min.js",
 710       "bower_components/jquery-ui/themes/smoothness/jquery-ui.min.css",
 711       "bower_components/lodash-compat/lodash.min.js",
 712       "packages/jquery/plugins/jquery.mousewheel.min.js",
 713       "bower_components/select2/select2.min.js",
 714       "bower_components/select2/select2.min.css",
 715       "bower_components/font-awesome/css/font-awesome.min.css",
 716       "packages/jquery/plugins/jquery.form.min.js",
 717       "packages/jquery/plugins/jquery.timeentry.min.js",
 718       "packages/jquery/plugins/jquery.blockUI.min.js",
 719       "bower_components/datatables/media/js/jquery.dataTables.min.js",
 720       "bower_components/datatables/media/css/jquery.dataTables.min.css",
 721       "bower_components/jquery-validation/dist/jquery.validate.min.js",
 722       "packages/jquery/plugins/jquery.ui.datepicker.validation.min.js",
 723       "js/Common.js",
 724       "js/crm.ajax.js",
 725       "js/wysiwyg/crm.wysiwyg.js",
 726     );
 727     // add wysiwyg editor
 728     $editor = Civi::settings()->get('editor_id');
 729     if ($editor == "CKEditor") {
 730       CRM_Admin_Page_CKEditorConfig::setConfigDefault();
 731       $items[] = array(
 732         'config' => array(
 733           'wysisygScriptLocation' => Civi::paths()->getUrl("[civicrm.root]/js/wysiwyg/crm.ckeditor.js"),
 734           'CKEditorCustomConfig' => CRM_Admin_Page_CKEditorConfig::getConfigUrl(),
 735         ),
 736       );
 737     }
 738
 739     // These scripts are only needed by back-office users
 740     if (CRM_Core_Permission::check('access CiviCRM')) {
 741       $items[] = "packages/jquery/plugins/jquery.tableHeader.js";
 742       $items[] = "packages/jquery/plugins/jquery.menu.min.js";
 743       $items[] = "css/civicrmNavigation.css";
 744       $items[] = "packages/jquery/plugins/jquery.notify.min.js";
 745     }
 746
 747     // JS for multilingual installations
 748     if (!empty($config->languageLimit) && count($config->languageLimit) > 1 && CRM_Core_Permission::check('translate CiviCRM')) {
 749       $items[] = "js/crm.multilingual.js";
 750     }
 751
 752     // Enable administrators to edit option lists in a dialog
 753     if (CRM_Core_Permission::check('administer CiviCRM') && $this->ajaxPopupsEnabled) {
 754       $items[] = "js/crm.optionEdit.js";
 755     }
 756
 757     $tsLocale = CRM_Core_I18n::getLocale();
 758     // Add localized jQuery UI files
 759     if ($tsLocale && $tsLocale != 'en_US') {
 760       // Search for i18n file in order of specificity (try fr-CA, then fr)
 761       list($lang) = explode('_', $tsLocale);
 762       $path = "bower_components/jquery-ui/ui/i18n";
 763       foreach (array(str_replace('_', '-', $tsLocale), $lang) as $language) {
 764         $localizationFile = "$path/datepicker-{$language}.js";
 765         if ($this->getPath('civicrm', $localizationFile)) {
 766           $items[] = $localizationFile;
 767           break;
 768         }
 769       }
 770     }
 771
 772     // Allow hooks to modify this list
 773     CRM_Utils_Hook::coreResourceList($items, $region);
 774
 775     return $items;
 776   }
 777
 778   /**
 779    * @return bool
 780    *   is this page request an ajax snippet?
 781    */
 782   public static function isAjaxMode() {
 783     if (in_array(CRM_Utils_Array::value('snippet', $_REQUEST), array(
 784         CRM_Core_Smarty::PRINT_SNIPPET,
 785         CRM_Core_Smarty::PRINT_NOFORM,
 786         CRM_Core_Smarty::PRINT_JSON,
 787       ))
 788     ) {
 789       return TRUE;
 790     }
 791     return strpos(CRM_Utils_System::getUrlPath(), 'civicrm/ajax') === 0;
 792   }
 793
 794   /**
 795    * Provide a list of available entityRef filters.
 796    * @todo: move component filters into their respective components (e.g. CiviEvent)
 797    *
 798    * @return array
 799    */
 800   public static function getEntityRefFilters() {
 801     $filters = array();
 802     $config = CRM_Core_Config::singleton();
 803
 804     if (in_array('CiviEvent', $config->enableComponents)) {
 805       $filters['event'] = array(
 806         array('key' => 'event_type_id', 'value' => ts('Event Type')),
 807         array(
 808           'key' => 'start_date',
 809           'value' => ts('Start Date'),
 810           'options' => array(
 811             array('key' => '{">":"now"}', 'value' => ts('Upcoming')),
 812             array(
 813               'key' => '{"BETWEEN":["now - 3 month","now"]}',
 814               'value' => ts('Past 3 Months'),
 815             ),
 816             array(
 817               'key' => '{"BETWEEN":["now - 6 month","now"]}',
 818               'value' => ts('Past 6 Months'),
 819             ),
 820             array(
 821               'key' => '{"BETWEEN":["now - 1 year","now"]}',
 822               'value' => ts('Past Year'),
 823             ),
 824           ),
 825         ),
 826       );
 827     }
 828
 829     $filters['activity'] = array(
 830       array('key' => 'activity_type_id', 'value' => ts('Activity Type')),
 831       array('key' => 'status_id', 'value' => ts('Activity Status')),
 832     );
 833
 834     $filters['contact'] = array(
 835       array('key' => 'contact_type', 'value' => ts('Contact Type')),
 836       array('key' => 'group', 'value' => ts('Group'), 'entity' => 'group_contact'),
 837       array('key' => 'tag', 'value' => ts('Tag'), 'entity' => 'entity_tag'),
 838       array('key' => 'state_province', 'value' => ts('State/Province'), 'entity' => 'address'),
 839       array('key' => 'country', 'value' => ts('Country'), 'entity' => 'address'),
 840       array('key' => 'gender_id', 'value' => ts('Gender')),
 841       array('key' => 'is_deceased', 'value' => ts('Deceased')),
 842       array('key' => 'source', 'value' => ts('Contact Source'), 'type' => 'text'),
 843     );
 844
 845     if (in_array('CiviCase', $config->enableComponents)) {
 846       $filters['case'] = array(
 847         array(
 848           'key' => 'case_id.case_type_id',
 849           'value' => ts('Case Type'),
 850           'entity' => 'Case',
 851         ),
 852         array(
 853           'key' => 'case_id.status_id',
 854           'value' => ts('Case Status'),
 855           'entity' => 'Case',
 856         ),
 857       );
 858       foreach ($filters['contact'] as $filter) {
 859         $filter += array('entity' => 'contact');
 860         $filter['key'] = 'contact_id.' . $filter['key'];
 861         $filters['case'][] = $filter;
 862       }
 863     }
 864
 865     CRM_Utils_Hook::entityRefFilters($filters);
 866
 867     return $filters;
 868   }
 869
 870   /**
 871    * In debug mode, look for a non-minified version of this file
 872    *
 873    * @param string $fileName
 874    * @param string $extName
 875    */
 876   private function resolveFileName(&$fileName, $extName) {
 877     if (CRM_Core_Config::singleton()->debug && strpos($fileName, '.min.') !== FALSE) {
 878       $nonMiniFile = str_replace('.min.', '.', $fileName);
 879       if ($this->getPath($extName, $nonMiniFile)) {
 880         $fileName = $nonMiniFile;
 881       }
 882     }
 883   }
 884
 885   /**
 886    * @param string $url
 887    * @return string
 888    */
 889   public function addCacheCode($url) {
 890     $hasQuery = strpos($url, '?') !== FALSE;
 891     $operator = $hasQuery ? '&' : '?';
 892
 893     return $url . $operator . 'r=' . $this->cacheCode;
 894   }
 895
 896 }