[civicrm-core.git] / Civi / Angular / Manager.php

<?php
namespace Civi\Angular;

/**
 * Manage Angular resources.
 *
 * @package Civi\Angular
 */
class Manager {

  /**
   * @var \CRM_Core_Resources
   */
  protected $res = NULL;

  /**
   * Modules.
   *
   * @var array|null
   *   Each item has some combination of these keys:
   *   - ext: string
   *     The Civi extension which defines the Angular module.
   *   - js: array(string $relativeFilePath)
   *     List of JS files (relative to the extension).
   *   - css: array(string $relativeFilePath)
   *     List of CSS files (relative to the extension).
   *   - partials: array(string $relativeFilePath)
   *     A list of partial-HTML folders (relative to the extension).
   *     This will be mapped to "~/moduleName" by crmResource.
   *   - settings: array(string $key => mixed $value)
   *     List of settings to preload.
   */
  protected $modules = NULL;

  /**
   * @var \CRM_Utils_Cache_Interface
   */
  protected $cache;

  /**
   * @var array
   *   Array(string $name => ChangeSet $change).
   */
  protected $changeSets = NULL;

  /**
   * @param \CRM_Core_Resources $res
   *   The resource manager.
   * @param $cache
   */
  public function __construct($res, \CRM_Utils_Cache_Interface $cache = NULL) {
    $this->res = $res;
    $this->cache = $cache ? $cache : new \CRM_Utils_Cache_ArrayCache([]);
  }

  /**
   * Get a list of AngularJS modules which should be autoloaded.
   *
   * @return array
   *   Each item has some combination of these keys:
   *   - ext: string
   *     The Civi extension which defines the Angular module.
   *   - js: array(string $relativeFilePath)
   *     List of JS files (relative to the extension).
   *   - css: array(string $relativeFilePath)
   *     List of CSS files (relative to the extension).
   *   - partials: array(string $relativeFilePath)
   *     A list of partial-HTML folders (relative to the extension).
   *     This will be mapped to "~/moduleName" by crmResource.
   *   - settings: array(string $key => mixed $value)
   *     List of settings to preload.
   */
  public function getModules() {
    if ($this->modules === NULL) {
      $config = \CRM_Core_Config::singleton();
      global $civicrm_root;

      // Note: It would be nice to just glob("$civicrm_root/ang/*.ang.php"), but at time
      // of writing CiviMail and CiviCase have special conditionals.

      $angularModules = [];
      $angularModules['angularFileUpload'] = include "$civicrm_root/ang/angularFileUpload.ang.php";
      $angularModules['checklist-model'] = include "$civicrm_root/ang/checklist-model.ang.php";
      $angularModules['crmApp'] = include "$civicrm_root/ang/crmApp.ang.php";
      $angularModules['crmAttachment'] = include "$civicrm_root/ang/crmAttachment.ang.php";
      $angularModules['crmAutosave'] = include "$civicrm_root/ang/crmAutosave.ang.php";
      $angularModules['crmCxn'] = include "$civicrm_root/ang/crmCxn.ang.php";
      // $angularModules['crmExample'] = include "$civicrm_root/ang/crmExample.ang.php";
      $angularModules['crmResource'] = include "$civicrm_root/ang/crmResource.ang.php";
      $angularModules['crmRouteBinder'] = include "$civicrm_root/ang/crmRouteBinder.ang.php";
      $angularModules['crmUi'] = include "$civicrm_root/ang/crmUi.ang.php";
      $angularModules['crmUtil'] = include "$civicrm_root/ang/crmUtil.ang.php";
      $angularModules['dialogService'] = include "$civicrm_root/ang/dialogService.ang.php";
      $angularModules['ngRoute'] = include "$civicrm_root/ang/ngRoute.ang.php";
      $angularModules['ngSanitize'] = include "$civicrm_root/ang/ngSanitize.ang.php";
      $angularModules['ui.utils'] = include "$civicrm_root/ang/ui.utils.ang.php";
      $angularModules['ui.bootstrap'] = include "$civicrm_root/ang/ui.bootstrap.ang.php";
      $angularModules['ui.sortable'] = include "$civicrm_root/ang/ui.sortable.ang.php";
      $angularModules['unsavedChanges'] = include "$civicrm_root/ang/unsavedChanges.ang.php";
      $angularModules['statuspage'] = include "$civicrm_root/ang/crmStatusPage.ang.php";
      $angularModules['exportui'] = include "$civicrm_root/ang/exportui.ang.php";
      $angularModules['api4Explorer'] = include "$civicrm_root/ang/api4Explorer.ang.php";
      $angularModules['api4'] = include "$civicrm_root/ang/api4.ang.php";

      foreach (\CRM_Core_Component::getEnabledComponents() as $component) {
        $angularModules = array_merge($angularModules, $component->getAngularModules());
      }
      \CRM_Utils_Hook::angularModules($angularModules);
      foreach (array_keys($angularModules) as $module) {
        if (!isset($angularModules[$module]['basePages'])) {
          $angularModules[$module]['basePages'] = ['civicrm/a'];
        }
      }
      $this->modules = $this->resolvePatterns($angularModules);
    }

    return $this->modules;
  }

  /**
   * Get the descriptor for an Angular module.
   *
   * @param string $name
   *   Module name.
   * @return array
   *   Details about the module:
   *   - ext: string, the name of the Civi extension which defines the module
   *   - js: array(string $relativeFilePath).
   *   - css: array(string $relativeFilePath).
   *   - partials: array(string $relativeFilePath).
   * @throws \Exception
   */
  public function getModule($name) {
    $modules = $this->getModules();
    if (!isset($modules[$name])) {
      throw new \Exception("Unrecognized Angular module");
    }
    return $modules[$name];
  }

  /**
   * Resolve a full list of Angular dependencies.
   *
   * @param array $names
   *   List of Angular modules.
   *   Ex: array('crmMailing').
   * @return array
   *   List of Angular modules, include all dependencies.
   *   Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
   */
  public function resolveDependencies($names) {
    $allModules = $this->getModules();
    $visited = [];
    $result = $names;
    while (($missingModules = array_diff($result, array_keys($visited))) && !empty($missingModules)) {
      foreach ($missingModules as $module) {
        $visited[$module] = 1;
        if (!isset($allModules[$module])) {
          \Civi::log()->warning('Unrecognized Angular module {name}. Please ensure that all Angular modules are declared.', [
            'name' => $module,
            'civi.tag' => 'deprecated',
          ]);
        }
        elseif (isset($allModules[$module]['requires'])) {
          $result = array_unique(array_merge($result, $allModules[$module]['requires']));
        }
      }
    }
    sort($result);
    return $result;
  }

  /**
   * Get a list of Angular modules that should be loaded on the given
   * base-page.
   *
   * @param string $basePage
   *   The name of the base-page for which we want a list of moudles.
   * @return array
   *   List of Angular modules.
   *   Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
   */
  public function resolveDefaultModules($basePage) {
    $modules = $this->getModules();
    $result = [];
    foreach ($modules as $moduleName => $module) {
      if (in_array($basePage, $module['basePages']) || in_array('*', $module['basePages'])) {
        $result[] = $moduleName;
      }
    }
    return $result;
  }

  /**
   * Convert any globs in an Angular module to file names.
   *
   * @param array $modules
   *   List of Angular modules.
   * @return array
   *   Updated list of Angular modules
   */
  protected function resolvePatterns($modules) {
    $newModules = [];

    foreach ($modules as $moduleKey => $module) {
      foreach (['js', 'css', 'partials'] as $fileset) {
        if (!isset($module[$fileset])) {
          continue;
        }
        $module[$fileset] = $this->res->glob($module['ext'], $module[$fileset]);
      }
      $newModules[$moduleKey] = $module;
    }

    return $newModules;
  }

  /**
   * Get the partial HTML documents for a module (unfiltered).
   *
   * @param string $name
   *   Angular module name.
   * @return array
   *   Array(string $extFilePath => string $html)
   * @throws \Exception
   *   Invalid partials configuration.
   */
  public function getRawPartials($name) {
    $module = $this->getModule($name);
    $result = !empty($module['partialsCallback'])
      ? \Civi\Core\Resolver::singleton()->call($module['partialsCallback'], [$name, $module])
      : [];
    if (isset($module['partials'])) {
      foreach ($module['partials'] as $partialDir) {
        $partialDir = $this->res->getPath($module['ext']) . '/' . $partialDir;
        $files = \CRM_Utils_File::findFiles($partialDir, '*.html', TRUE);
        foreach ($files as $file) {
          $filename = '~/' . $name . '/' . $file;
          $result[$filename] = file_get_contents($partialDir . '/' . $file);
        }
      }
      return $result;
    }
    return $result;
  }

  /**
   * Get the partial HTML documents for a module.
   *
   * @param string $name
   *   Angular module name.
   * @return array
   *   Array(string $extFilePath => string $html)
   * @throws \Exception
   *   Invalid partials configuration.
   */
  public function getPartials($name) {
    $cacheKey = "angular-partials_$name";
    $cacheValue = $this->cache->get($cacheKey);
    if ($cacheValue === NULL) {
      $cacheValue = ChangeSet::applyResourceFilters($this->getChangeSets(), 'partials', $this->getRawPartials($name));
      $this->cache->set($cacheKey, $cacheValue);
    }
    return $cacheValue;
  }

  /**
   * Get list of translated strings for a module.
   *
   * @param string $name
   *   Angular module name.
   * @return array
   *   Translated strings: array(string $orig => string $translated).
   */
  public function getTranslatedStrings($name) {
    $module = $this->getModule($name);
    $result = [];
    $strings = $this->getStrings($name);
    foreach ($strings as $string) {
      // TODO: should we pass translation domain based on $module[ext] or $module[tsDomain]?
      // It doesn't look like client side really supports the domain right now...
      $translated = ts($string, [
        'domain' => [$module['ext'], NULL],
      ]);
      if ($translated != $string) {
        $result[$string] = $translated;
      }
    }
    return $result;
  }

  /**
   * Get list of translatable strings for a module.
   *
   * @param string $name
   *   Angular module name.
   * @return array
   *   Translatable strings.
   */
  public function getStrings($name) {
    $module = $this->getModule($name);
    $result = [];
    if (isset($module['js'])) {
      foreach ($module['js'] as $file) {
        $strings = $this->res->getStrings()->get(
          $module['ext'],
          $this->res->getPath($module['ext'], $file),
          'text/javascript'
        );
        $result = array_unique(array_merge($result, $strings));
      }
    }
    $partials = $this->getPartials($name);
    foreach ($partials as $partial) {
      $result = array_unique(array_merge($result, \CRM_Utils_JS::parseStrings($partial)));
    }
    return $result;
  }

  /**
   * Get resources for one or more modules.
   *
   * @param string|array $moduleNames
   *   List of module names.
   * @param string $resType
   *   Type of resource ('js', 'css', 'settings').
   * @param string $refType
   *   Type of reference to the resource ('cacheUrl', 'rawUrl', 'path', 'settings').
   * @return array
   *   List of URLs or paths.
   * @throws \CRM_Core_Exception
   */
  public function getResources($moduleNames, $resType, $refType) {
    $result = [];
    $moduleNames = (array) $moduleNames;
    foreach ($moduleNames as $moduleName) {
      $module = $this->getModule($moduleName);
      if (isset($module[$resType])) {
        foreach ($module[$resType] as $file) {
          $refTypeSuffix = '';
          if (is_string($file) && preg_match(';^(assetBuilder|ext)://;', $file)) {
            $refTypeSuffix = '-' . parse_url($file, PHP_URL_SCHEME);
          }

          switch ($refType . $refTypeSuffix) {
            case 'path':
              $result[] = $this->res->getPath($module['ext'], $file);
              break;

            case 'rawUrl':
              $result[] = $this->res->getUrl($module['ext'], $file);
              break;

            case 'cacheUrl':
              $result[] = $this->res->getUrl($module['ext'], $file, TRUE);
              break;

            case 'path-assetBuilder':
              $assetName = parse_url($file, PHP_URL_HOST) . parse_url($file, PHP_URL_PATH);
              $assetParams = [];
              parse_str('' . parse_url($file, PHP_URL_QUERY), $assetParams);
              $result[] = \Civi::service('asset_builder')->getPath($assetName, $assetParams);
              break;

            case 'rawUrl-assetBuilder':
            case 'cacheUrl-assetBuilder':
              $assetName = parse_url($file, PHP_URL_HOST) . parse_url($file, PHP_URL_PATH);
              $assetParams = [];
              parse_str('' . parse_url($file, PHP_URL_QUERY), $assetParams);
              $result[] = \Civi::service('asset_builder')->getUrl($assetName, $assetParams);
              break;

            case 'path-ext':
              $result[] = $this->res->getPath(parse_url($file, PHP_URL_HOST), ltrim(parse_url($file, PHP_URL_PATH), '/'));
              break;

            case 'rawUrl-ext':
              $result[] = $this->res->getUrl(parse_url($file, PHP_URL_HOST), ltrim(parse_url($file, PHP_URL_PATH), '/'));
              break;

            case 'cacheUrl-ext':
              $result[] = $this->res->getUrl(parse_url($file, PHP_URL_HOST), ltrim(parse_url($file, PHP_URL_PATH), '/'), TRUE);
              break;

            case 'settings':
            case 'requires':
              if (!empty($module[$resType])) {
                $result[$moduleName] = $module[$resType];
              }
              break;

            default:
              throw new \CRM_Core_Exception("Unrecognized resource format");
          }
        }
      }
    }

    return ChangeSet::applyResourceFilters($this->getChangeSets(), $resType, $result);
  }

  /**
   * @return array
   *   Array(string $name => ChangeSet $changeSet).
   */
  public function getChangeSets() {
    if ($this->changeSets === NULL) {
      $this->changeSets = [];
      \CRM_Utils_Hook::alterAngular($this);
    }
    return $this->changeSets;
  }

  /**
   * @param ChangeSet $changeSet
   * @return \Civi\Angular\Manager
   */
  public function add($changeSet) {
    $this->changeSets[$changeSet->getName()] = $changeSet;
    return $this;
  }

}
Commit	Line	Data
16072ce1 TO	1	<?php
	2	namespace Civi\Angular;
	3
	4	/**
	5	* Manage Angular resources.
	6	*
	7	* @package Civi\Angular
	8	*/
	9	class Manager {
	10
	11	/**
	12	* @var \CRM_Core_Resources
	13	*/
	14	protected $res = NULL;
	15
	16	/**
cc101011	17	* Modules.
	18	*
	19	* @var array\|null
16072ce1 TO	20	* Each item has some combination of these keys:
16072ce1 TO	21	* - ext: string
8671b4f2	22	* The Civi extension which defines the Angular module.
16072ce1	23	* - js: array(string $relativeFilePath)
8671b4f2	24	* List of JS files (relative to the extension).
16072ce1	25	* - css: array(string $relativeFilePath)
8671b4f2	26	* List of CSS files (relative to the extension).
16072ce1	27	* - partials: array(string $relativeFilePath)
8671b4f2 TO	28	* A list of partial-HTML folders (relative to the extension).
8671b4f2 TO	29	* This will be mapped to "~/moduleName" by crmResource.
1da632e0 TO	30	* - settings: array(string $key => mixed $value)
1da632e0 TO	31	* List of settings to preload.
16072ce1 TO	32	*/
	33	protected $modules = NULL;
	34
53d00841 TO	35	/**
	36	* @var \CRM_Utils_Cache_Interface
	37	*/
	38	protected $cache;
	39
6dc348de TO	40	/**
	41	* @var array
	42	* Array(string $name => ChangeSet $change).
	43	*/
	44	protected $changeSets = NULL;
	45
16072ce1 TO	46	/**
	47	* @param \CRM_Core_Resources $res
	48	* The resource manager.
34f3bbd9	49	* @param $cache
16072ce1	50	*/
53d00841	51	public function __construct($res, \CRM_Utils_Cache_Interface $cache = NULL) {
16072ce1	52	$this->res = $res;
c33f1df1	53	$this->cache = $cache ? $cache : new \CRM_Utils_Cache_ArrayCache([]);
16072ce1 TO	54	}
	55
	56	/**
fe482240	57	* Get a list of AngularJS modules which should be autoloaded.
16072ce1 TO	58	*
16072ce1 TO	59	* @return array
8671b4f2 TO	60	* Each item has some combination of these keys:
	61	* - ext: string
	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.
1da632e0 TO	70	* - settings: array(string $key => mixed $value)
1da632e0 TO	71	* List of settings to preload.
16072ce1 TO	72	*/
	73	public function getModules() {
	74	if ($this->modules === NULL) {
1da632e0	75	$config = \CRM_Core_Config::singleton();
8456e727	76	global $civicrm_root;
16072ce1	77
8456e727 TO	78	// Note: It would be nice to just glob("$civicrm_root/ang/*.ang.php"), but at time
8456e727 TO	79	// of writing CiviMail and CiviCase have special conditionals.
16072ce1	80
c64f69d9	81	$angularModules = [];
8456e727	82	$angularModules['angularFileUpload'] = include "$civicrm_root/ang/angularFileUpload.ang.php";
b9a4dfbd	83	$angularModules['checklist-model'] = include "$civicrm_root/ang/checklist-model.ang.php";
8456e727 TO	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";
67341f3c	90	$angularModules['crmRouteBinder'] = include "$civicrm_root/ang/crmRouteBinder.ang.php";
8456e727 TO	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";
e88c001e	97	$angularModules['ui.bootstrap'] = include "$civicrm_root/ang/ui.bootstrap.ang.php";
8456e727 TO	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";
33044927	101	$angularModules['exportui'] = include "$civicrm_root/ang/exportui.ang.php";
0b873c9a CW	102	$angularModules['api4Explorer'] = include "$civicrm_root/ang/api4Explorer.ang.php";
0b873c9a CW	103	$angularModules['api4'] = include "$civicrm_root/ang/api4.ang.php";
c0f7f681	104
16072ce1 TO	105	foreach (\CRM_Core_Component::getEnabledComponents() as $component) {
	106	$angularModules = array_merge($angularModules, $component->getAngularModules());
	107	}
	108	\CRM_Utils_Hook::angularModules($angularModules);
8da6c9b8 TO	109	foreach (array_keys($angularModules) as $module) {
8da6c9b8 TO	110	if (!isset($angularModules[$module]['basePages'])) {
c64f69d9	111	$angularModules[$module]['basePages'] = ['civicrm/a'];
8da6c9b8 TO	112	}
8da6c9b8 TO	113	}
16072ce1 TO	114	$this->modules = $this->resolvePatterns($angularModules);
	115	}
	116
	117	return $this->modules;
	118	}
	119
	120	/**
	121	* Get the descriptor for an Angular module.
	122	*
	123	* @param string $name
	124	* Module name.
	125	* @return array
	126	* Details about the module:
	127	* - ext: string, the name of the Civi extension which defines the module
	128	* - js: array(string $relativeFilePath).
	129	* - css: array(string $relativeFilePath).
	130	* - partials: array(string $relativeFilePath).
	131	* @throws \Exception
	132	*/
	133	public function getModule($name) {
	134	$modules = $this->getModules();
	135	if (!isset($modules[$name])) {
	136	throw new \Exception("Unrecognized Angular module");
	137	}
	138	return $modules[$name];
	139	}
	140
8da6c9b8 TO	141	/**
	142	* Resolve a full list of Angular dependencies.
	143	*
	144	* @param array $names
	145	* List of Angular modules.
	146	* Ex: array('crmMailing').
	147	* @return array
	148	* List of Angular modules, include all dependencies.
	149	* Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
	150	*/
	151	public function resolveDependencies($names) {
	152	$allModules = $this->getModules();
c64f69d9	153	$visited = [];
8da6c9b8 TO	154	$result = $names;
	155	while (($missingModules = array_diff($result, array_keys($visited))) && !empty($missingModules)) {
	156	foreach ($missingModules as $module) {
	157	$visited[$module] = 1;
	158	if (!isset($allModules[$module])) {
c64f69d9	159	\Civi::log()->warning('Unrecognized Angular module {name}. Please ensure that all Angular modules are declared.', [
8da6c9b8 TO	160	'name' => $module,
8da6c9b8 TO	161	'civi.tag' => 'deprecated',
c64f69d9	162	]);
8da6c9b8 TO	163	}
	164	elseif (isset($allModules[$module]['requires'])) {
	165	$result = array_unique(array_merge($result, $allModules[$module]['requires']));
	166	}
	167	}
	168	}
	169	sort($result);
	170	return $result;
	171	}
	172
	173	/**
	174	* Get a list of Angular modules that should be loaded on the given
	175	* base-page.
	176	*
	177	* @param string $basePage
	178	* The name of the base-page for which we want a list of moudles.
	179	* @return array
	180	* List of Angular modules.
	181	* Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
	182	*/
	183	public function resolveDefaultModules($basePage) {
	184	$modules = $this->getModules();
c64f69d9	185	$result = [];
8da6c9b8 TO	186	foreach ($modules as $moduleName => $module) {
	187	if (in_array($basePage, $module['basePages']) \|\| in_array('*', $module['basePages'])) {
	188	$result[] = $moduleName;
	189	}
	190	}
	191	return $result;
	192	}
	193
16072ce1 TO	194	/**
	195	* Convert any globs in an Angular module to file names.
	196	*
	197	* @param array $modules
	198	* List of Angular modules.
	199	* @return array
	200	* Updated list of Angular modules
	201	*/
	202	protected function resolvePatterns($modules) {
c64f69d9	203	$newModules = [];
16072ce1 TO	204
16072ce1 TO	205	foreach ($modules as $moduleKey => $module) {
c64f69d9	206	foreach (['js', 'css', 'partials'] as $fileset) {
16072ce1 TO	207	if (!isset($module[$fileset])) {
	208	continue;
	209	}
	210	$module[$fileset] = $this->res->glob($module['ext'], $module[$fileset]);
	211	}
	212	$newModules[$moduleKey] = $module;
	213	}
	214
	215	return $newModules;
	216	}
	217
	218	/**
6dc348de	219	* Get the partial HTML documents for a module (unfiltered).
16072ce1 TO	220	*
	221	* @param string $name
	222	* Angular module name.
	223	* @return array
	224	* Array(string $extFilePath => string $html)
a2dc0f82 TO	225	* @throws \Exception
a2dc0f82 TO	226	* Invalid partials configuration.
16072ce1	227	*/
6dc348de	228	public function getRawPartials($name) {
16072ce1	229	$module = $this->getModule($name);
90c62ad3 TO	230	$result = !empty($module['partialsCallback'])
	231	? \Civi\Core\Resolver::singleton()->call($module['partialsCallback'], [$name, $module])
	232	: [];
16072ce1	233	if (isset($module['partials'])) {
a2dc0f82 TO	234	foreach ($module['partials'] as $partialDir) {
	235	$partialDir = $this->res->getPath($module['ext']) . '/' . $partialDir;
	236	$files = \CRM_Utils_File::findFiles($partialDir, '*.html', TRUE);
	237	foreach ($files as $file) {
	238	$filename = '~/' . $name . '/' . $file;
	239	$result[$filename] = file_get_contents($partialDir . '/' . $file);
	240	}
16072ce1	241	}
6dc348de	242	return $result;
16072ce1 TO	243	}
	244	return $result;
	245	}
	246
6dc348de TO	247	/**
	248	* Get the partial HTML documents for a module.
	249	*
	250	* @param string $name
	251	* Angular module name.
	252	* @return array
	253	* Array(string $extFilePath => string $html)
	254	* @throws \Exception
	255	* Invalid partials configuration.
	256	*/
	257	public function getPartials($name) {
8b25b1fe	258	$cacheKey = "angular-partials_$name";
6dc348de TO	259	$cacheValue = $this->cache->get($cacheKey);
	260	if ($cacheValue === NULL) {
	261	$cacheValue = ChangeSet::applyResourceFilters($this->getChangeSets(), 'partials', $this->getRawPartials($name));
	262	$this->cache->set($cacheKey, $cacheValue);
	263	}
	264	return $cacheValue;
	265	}
	266
16072ce1 TO	267	/**
	268	* Get list of translated strings for a module.
	269	*
	270	* @param string $name
	271	* Angular module name.
	272	* @return array
	273	* Translated strings: array(string $orig => string $translated).
	274	*/
	275	public function getTranslatedStrings($name) {
e3d90d6c	276	$module = $this->getModule($name);
c64f69d9	277	$result = [];
16072ce1 TO	278	$strings = $this->getStrings($name);
	279	foreach ($strings as $string) {
	280	// TODO: should we pass translation domain based on $module[ext] or $module[tsDomain]?
	281	// It doesn't look like client side really supports the domain right now...
c64f69d9 CW	282	$translated = ts($string, [
	283	'domain' => [$module['ext'], NULL],
	284	]);
16072ce1 TO	285	if ($translated != $string) {
	286	$result[$string] = $translated;
	287	}
	288	}
	289	return $result;
	290	}
	291
	292	/**
	293	* Get list of translatable strings for a module.
	294	*
	295	* @param string $name
	296	* Angular module name.
	297	* @return array
	298	* Translatable strings.
	299	*/
	300	public function getStrings($name) {
	301	$module = $this->getModule($name);
c64f69d9	302	$result = [];
16072ce1 TO	303	if (isset($module['js'])) {
	304	foreach ($module['js'] as $file) {
	305	$strings = $this->res->getStrings()->get(
	306	$module['ext'],
	307	$this->res->getPath($module['ext'], $file),
	308	'text/javascript'
	309	);
	310	$result = array_unique(array_merge($result, $strings));
	311	}
	312	}
53d00841 TO	313	$partials = $this->getPartials($name);
	314	foreach ($partials as $partial) {
	315	$result = array_unique(array_merge($result, \CRM_Utils_JS::parseStrings($partial)));
16072ce1 TO	316	}
	317	return $result;
	318	}
	319
	320	/**
27a90ef6 TO	321	* Get resources for one or more modules.
	322	*
	323	* @param string\|array $moduleNames
	324	* List of module names.
	325	* @param string $resType
1da632e0	326	* Type of resource ('js', 'css', 'settings').
27a90ef6	327	* @param string $refType
1da632e0	328	* Type of reference to the resource ('cacheUrl', 'rawUrl', 'path', 'settings').
16072ce1	329	* @return array
27a90ef6 TO	330	* List of URLs or paths.
27a90ef6 TO	331	* @throws \CRM_Core_Exception
16072ce1	332	*/
27a90ef6	333	public function getResources($moduleNames, $resType, $refType) {
c64f69d9	334	$result = [];
27a90ef6 TO	335	$moduleNames = (array) $moduleNames;
	336	foreach ($moduleNames as $moduleName) {
	337	$module = $this->getModule($moduleName);
	338	if (isset($module[$resType])) {
	339	foreach ($module[$resType] as $file) {
e5c376e7 TO	340	$refTypeSuffix = '';
	341	if (is_string($file) && preg_match(';^(assetBuilder\|ext)://;', $file)) {
	342	$refTypeSuffix = '-' . parse_url($file, PHP_URL_SCHEME);
	343	}
	344
	345	switch ($refType . $refTypeSuffix) {
27a90ef6 TO	346	case 'path':
	347	$result[] = $this->res->getPath($module['ext'], $file);
	348	break;
16072ce1	349
27a90ef6 TO	350	case 'rawUrl':
	351	$result[] = $this->res->getUrl($module['ext'], $file);
	352	break;
	353
	354	case 'cacheUrl':
	355	$result[] = $this->res->getUrl($module['ext'], $file, TRUE);
	356	break;
	357
e5c376e7 TO	358	case 'path-assetBuilder':
e5c376e7 TO	359	$assetName = parse_url($file, PHP_URL_HOST) . parse_url($file, PHP_URL_PATH);
c64f69d9	360	$assetParams = [];
e5c376e7 TO	361	parse_str('' . parse_url($file, PHP_URL_QUERY), $assetParams);
	362	$result[] = \Civi::service('asset_builder')->getPath($assetName, $assetParams);
	363	break;
	364
	365	case 'rawUrl-assetBuilder':
	366	case 'cacheUrl-assetBuilder':
	367	$assetName = parse_url($file, PHP_URL_HOST) . parse_url($file, PHP_URL_PATH);
c64f69d9	368	$assetParams = [];
e5c376e7 TO	369	parse_str('' . parse_url($file, PHP_URL_QUERY), $assetParams);
	370	$result[] = \Civi::service('asset_builder')->getUrl($assetName, $assetParams);
	371	break;
	372
	373	case 'path-ext':
	374	$result[] = $this->res->getPath(parse_url($file, PHP_URL_HOST), ltrim(parse_url($file, PHP_URL_PATH), '/'));
	375	break;
	376
	377	case 'rawUrl-ext':
	378	$result[] = $this->res->getUrl(parse_url($file, PHP_URL_HOST), ltrim(parse_url($file, PHP_URL_PATH), '/'));
	379	break;
	380
	381	case 'cacheUrl-ext':
	382	$result[] = $this->res->getUrl(parse_url($file, PHP_URL_HOST), ltrim(parse_url($file, PHP_URL_PATH), '/'), TRUE);
	383	break;
	384
1da632e0	385	case 'settings':
5438399c	386	case 'requires':
1da632e0 TO	387	if (!empty($module[$resType])) {
	388	$result[$moduleName] = $module[$resType];
	389	}
	390	break;
	391
27a90ef6 TO	392	default:
	393	throw new \CRM_Core_Exception("Unrecognized resource format");
	394	}
	395	}
16072ce1 TO	396	}
16072ce1 TO	397	}
6dc348de TO	398
	399	return ChangeSet::applyResourceFilters($this->getChangeSets(), $resType, $result);
	400	}
	401
	402	/**
	403	* @return array
	404	* Array(string $name => ChangeSet $changeSet).
	405	*/
	406	public function getChangeSets() {
	407	if ($this->changeSets === NULL) {
c64f69d9	408	$this->changeSets = [];
6dc348de TO	409	\CRM_Utils_Hook::alterAngular($this);
	410	}
	411	return $this->changeSets;
	412	}
	413
	414	/**
	415	* @param ChangeSet $changeSet
	416	* @return \Civi\Angular\Manager
	417	*/
	418	public function add($changeSet) {
	419	$this->changeSets[$changeSet->getName()] = $changeSet;
	420	return $this;
16072ce1	421	}
8671b4f2	422
16072ce1	423	}