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