2 namespace Civi\Angular
;
5 * Manage Angular resources.
7 * @package Civi\Angular
12 * @var \CRM_Core_Resources
14 protected $res = NULL;
20 * Each item has some combination of these keys:
22 * The Civi extension which defines the Angular module.
23 * - js: array(string $relativeFilePath)
24 * List of JS files (relative to the extension).
25 * - css: array(string $relativeFilePath)
26 * List of CSS files (relative to the extension).
27 * - partials: array(string $relativeFilePath)
28 * A list of partial-HTML folders (relative to the extension).
29 * This will be mapped to "~/moduleName" by crmResource.
30 * - settings: array(string $key => mixed $value)
31 * List of settings to preload.
33 protected $modules = NULL;
36 * @var \CRM_Utils_Cache_Interface
42 * Array(string $name => ChangeSet $change).
44 protected $changeSets = NULL;
47 * @param \CRM_Core_Resources $res
48 * The resource manager.
51 public function __construct($res, \CRM_Utils_Cache_Interface
$cache = NULL) {
53 $this->cache
= $cache ?
$cache : new \
CRM_Utils_Cache_ArrayCache([]);
57 * Get a list of AngularJS modules which should be autoloaded.
60 * Each item has some combination of these keys:
62 * The Civi extension which defines the Angular module.
63 * - js: array(string $relativeFilePath)
64 * List of JS files (relative to the extension).
65 * - css: array(string $relativeFilePath)
66 * List of CSS files (relative to the extension).
67 * - partials: array(string $relativeFilePath)
68 * A list of partial-HTML folders (relative to the extension).
69 * This will be mapped to "~/moduleName" by crmResource.
70 * - settings: array(string $key => mixed $value)
71 * List of settings to preload.
73 public function getModules() {
74 if ($this->modules
=== NULL) {
75 $config = \CRM_Core_Config
::singleton();
78 // Note: It would be nice to just glob("$civicrm_root/ang/*.ang.php"), but at time
79 // of writing CiviMail and CiviCase have special conditionals.
82 $angularModules['angularFileUpload'] = include "$civicrm_root/ang/angularFileUpload.ang.php";
83 $angularModules['checklist-model'] = include "$civicrm_root/ang/checklist-model.ang.php";
84 $angularModules['crmApp'] = include "$civicrm_root/ang/crmApp.ang.php";
85 $angularModules['crmAttachment'] = include "$civicrm_root/ang/crmAttachment.ang.php";
86 $angularModules['crmAutosave'] = include "$civicrm_root/ang/crmAutosave.ang.php";
87 $angularModules['crmCxn'] = include "$civicrm_root/ang/crmCxn.ang.php";
88 // $angularModules['crmExample'] = include "$civicrm_root/ang/crmExample.ang.php";
89 $angularModules['crmResource'] = include "$civicrm_root/ang/crmResource.ang.php";
90 $angularModules['crmRouteBinder'] = include "$civicrm_root/ang/crmRouteBinder.ang.php";
91 $angularModules['crmUi'] = include "$civicrm_root/ang/crmUi.ang.php";
92 $angularModules['crmUtil'] = include "$civicrm_root/ang/crmUtil.ang.php";
93 $angularModules['dialogService'] = include "$civicrm_root/ang/dialogService.ang.php";
94 $angularModules['ngRoute'] = include "$civicrm_root/ang/ngRoute.ang.php";
95 $angularModules['ngSanitize'] = include "$civicrm_root/ang/ngSanitize.ang.php";
96 $angularModules['ui.utils'] = include "$civicrm_root/ang/ui.utils.ang.php";
97 $angularModules['ui.bootstrap'] = include "$civicrm_root/ang/ui.bootstrap.ang.php";
98 $angularModules['ui.sortable'] = include "$civicrm_root/ang/ui.sortable.ang.php";
99 $angularModules['unsavedChanges'] = include "$civicrm_root/ang/unsavedChanges.ang.php";
100 $angularModules['statuspage'] = include "$civicrm_root/ang/crmStatusPage.ang.php";
102 foreach (\CRM_Core_Component
::getEnabledComponents() as $component) {
103 $angularModules = array_merge($angularModules, $component->getAngularModules());
105 \CRM_Utils_Hook
::angularModules($angularModules);
106 foreach (array_keys($angularModules) as $module) {
107 if (!isset($angularModules[$module]['basePages'])) {
108 $angularModules[$module]['basePages'] = ['civicrm/a'];
111 $this->modules
= $this->resolvePatterns($angularModules);
114 return $this->modules
;
118 * Get the descriptor for an Angular module.
120 * @param string $name
123 * Details about the module:
124 * - ext: string, the name of the Civi extension which defines the module
125 * - js: array(string $relativeFilePath).
126 * - css: array(string $relativeFilePath).
127 * - partials: array(string $relativeFilePath).
130 public function getModule($name) {
131 $modules = $this->getModules();
132 if (!isset($modules[$name])) {
133 throw new \
Exception("Unrecognized Angular module");
135 return $modules[$name];
139 * Resolve a full list of Angular dependencies.
141 * @param array $names
142 * List of Angular modules.
143 * Ex: array('crmMailing').
145 * List of Angular modules, include all dependencies.
146 * Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
148 public function resolveDependencies($names) {
149 $allModules = $this->getModules();
152 while (($missingModules = array_diff($result, array_keys($visited))) && !empty($missingModules)) {
153 foreach ($missingModules as $module) {
154 $visited[$module] = 1;
155 if (!isset($allModules[$module])) {
156 \Civi
::log()->warning('Unrecognized Angular module {name}. Please ensure that all Angular modules are declared.', [
158 'civi.tag' => 'deprecated',
161 elseif (isset($allModules[$module]['requires'])) {
162 $result = array_unique(array_merge($result, $allModules[$module]['requires']));
171 * Get a list of Angular modules that should be loaded on the given
174 * @param string $basePage
175 * The name of the base-page for which we want a list of moudles.
177 * List of Angular modules.
178 * Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
180 public function resolveDefaultModules($basePage) {
181 $modules = $this->getModules();
183 foreach ($modules as $moduleName => $module) {
184 if (in_array($basePage, $module['basePages']) ||
in_array('*', $module['basePages'])) {
185 $result[] = $moduleName;
192 * Convert any globs in an Angular module to file names.
194 * @param array $modules
195 * List of Angular modules.
197 * Updated list of Angular modules
199 protected function resolvePatterns($modules) {
202 foreach ($modules as $moduleKey => $module) {
203 foreach (['js', 'css', 'partials'] as $fileset) {
204 if (!isset($module[$fileset])) {
207 $module[$fileset] = $this->res
->glob($module['ext'], $module[$fileset]);
209 $newModules[$moduleKey] = $module;
216 * Get the partial HTML documents for a module (unfiltered).
218 * @param string $name
219 * Angular module name.
221 * Array(string $extFilePath => string $html)
223 * Invalid partials configuration.
225 public function getRawPartials($name) {
226 $module = $this->getModule($name);
228 if (isset($module['partials'])) {
229 foreach ($module['partials'] as $partialDir) {
230 $partialDir = $this->res
->getPath($module['ext']) . '/' . $partialDir;
231 $files = \CRM_Utils_File
::findFiles($partialDir, '*.html', TRUE);
232 foreach ($files as $file) {
233 $filename = '~/' . $name . '/' . $file;
234 $result[$filename] = file_get_contents($partialDir . '/' . $file);
243 * Get the partial HTML documents for a module.
245 * @param string $name
246 * Angular module name.
248 * Array(string $extFilePath => string $html)
250 * Invalid partials configuration.
252 public function getPartials($name) {
253 $cacheKey = "angular-partials_$name";
254 $cacheValue = $this->cache
->get($cacheKey);
255 if ($cacheValue === NULL) {
256 $cacheValue = ChangeSet
::applyResourceFilters($this->getChangeSets(), 'partials', $this->getRawPartials($name));
257 $this->cache
->set($cacheKey, $cacheValue);
263 * Get list of translated strings for a module.
265 * @param string $name
266 * Angular module name.
268 * Translated strings: array(string $orig => string $translated).
270 public function getTranslatedStrings($name) {
271 $module = $this->getModule($name);
273 $strings = $this->getStrings($name);
274 foreach ($strings as $string) {
275 // TODO: should we pass translation domain based on $module[ext] or $module[tsDomain]?
276 // It doesn't look like client side really supports the domain right now...
277 $translated = ts($string, [
278 'domain' => [$module['ext'], NULL],
280 if ($translated != $string) {
281 $result[$string] = $translated;
288 * Get list of translatable strings for a module.
290 * @param string $name
291 * Angular module name.
293 * Translatable strings.
295 public function getStrings($name) {
296 $module = $this->getModule($name);
298 if (isset($module['js'])) {
299 foreach ($module['js'] as $file) {
300 $strings = $this->res
->getStrings()->get(
302 $this->res
->getPath($module['ext'], $file),
305 $result = array_unique(array_merge($result, $strings));
308 $partials = $this->getPartials($name);
309 foreach ($partials as $partial) {
310 $result = array_unique(array_merge($result, \CRM_Utils_JS
::parseStrings($partial)));
316 * Get resources for one or more modules.
318 * @param string|array $moduleNames
319 * List of module names.
320 * @param string $resType
321 * Type of resource ('js', 'css', 'settings').
322 * @param string $refType
323 * Type of reference to the resource ('cacheUrl', 'rawUrl', 'path', 'settings').
325 * List of URLs or paths.
326 * @throws \CRM_Core_Exception
328 public function getResources($moduleNames, $resType, $refType) {
330 $moduleNames = (array) $moduleNames;
331 foreach ($moduleNames as $moduleName) {
332 $module = $this->getModule($moduleName);
333 if (isset($module[$resType])) {
334 foreach ($module[$resType] as $file) {
336 if (is_string($file) && preg_match(';^(assetBuilder|ext)://;', $file)) {
337 $refTypeSuffix = '-' . parse_url($file, PHP_URL_SCHEME
);
340 switch ($refType . $refTypeSuffix) {
342 $result[] = $this->res
->getPath($module['ext'], $file);
346 $result[] = $this->res
->getUrl($module['ext'], $file);
350 $result[] = $this->res
->getUrl($module['ext'], $file, TRUE);
353 case 'path-assetBuilder':
354 $assetName = parse_url($file, PHP_URL_HOST
) . parse_url($file, PHP_URL_PATH
);
356 parse_str('' . parse_url($file, PHP_URL_QUERY
), $assetParams);
357 $result[] = \Civi
::service('asset_builder')->getPath($assetName, $assetParams);
360 case 'rawUrl-assetBuilder':
361 case 'cacheUrl-assetBuilder':
362 $assetName = parse_url($file, PHP_URL_HOST
) . parse_url($file, PHP_URL_PATH
);
364 parse_str('' . parse_url($file, PHP_URL_QUERY
), $assetParams);
365 $result[] = \Civi
::service('asset_builder')->getUrl($assetName, $assetParams);
369 $result[] = $this->res
->getPath(parse_url($file, PHP_URL_HOST
), ltrim(parse_url($file, PHP_URL_PATH
), '/'));
373 $result[] = $this->res
->getUrl(parse_url($file, PHP_URL_HOST
), ltrim(parse_url($file, PHP_URL_PATH
), '/'));
377 $result[] = $this->res
->getUrl(parse_url($file, PHP_URL_HOST
), ltrim(parse_url($file, PHP_URL_PATH
), '/'), TRUE);
382 if (!empty($module[$resType])) {
383 $result[$moduleName] = $module[$resType];
388 throw new \
CRM_Core_Exception("Unrecognized resource format");
394 return ChangeSet
::applyResourceFilters($this->getChangeSets(), $resType, $result);
399 * Array(string $name => ChangeSet $changeSet).
401 public function getChangeSets() {
402 if ($this->changeSets
=== NULL) {
403 $this->changeSets
= [];
404 \CRM_Utils_Hook
::alterAngular($this);
406 return $this->changeSets
;
410 * @param ChangeSet $changeSet
411 * @return \Civi\Angular\Manager
413 public function add($changeSet) {
414 $this->changeSets
[$changeSet->getName()] = $changeSet;