3 namespace Civi\Angular\Page
;
6 * This page aggregates data from Angular modules.
8 * Example: Aggregate metadata about all modules in JSON format.
9 * civicrm/ajax/angular-modules?format=json
11 * Example: Aggregate metadata for crmUi and crmUtil modules.
12 * civicrm/ajax/angular-modules?format=json&modules=crmUi,crmUtil
14 * Example: Aggregate *.js files for all modules.
15 * civicrm/ajax/angular-modules?format=js
17 * Example: Aggregate *.css files for all modules.
18 * civicrm/ajax/angular-modules?format=css
20 class Modules
extends \CRM_Core_Page
{
23 * Generate asset content (when accessed via older, custom
24 * "civicrm/ajax/anulgar-modules" route).
28 public function run() {
30 * @var \Civi\Angular\Manager $angular
32 $angular = \Civi
::service('angular');
33 $moduleNames = $this->parseModuleNames(\CRM_Utils_Request
::retrieve('modules', 'String'), $angular);
35 switch (\CRM_Utils_Request
::retrieve('format', 'String')) {
39 'application/javascript',
40 json_encode($this->getMetadata($moduleNames, $angular))
46 'application/javascript',
47 $this->digestJs($angular->getResources($moduleNames, 'js', 'path'))
54 \CRM_Utils_File
::concat($angular->getResources($moduleNames, 'css', 'path'), "\n")
59 \CRM_Core_Error
::fatal("Unrecognized format");
62 \CRM_Utils_System
::civiExit();
66 * Generate asset content (when accessed via AssetBuilder).
68 * @param \Civi\Core\Event\GenericHookEvent $event
69 * @see CRM_Utils_hook::buildAsset()
70 * @see \Civi\Core\AssetBuilder
72 public static function buildAngularModules($event) {
73 $page = new Modules();
74 $angular = \Civi
::service('angular');
76 switch ($event->asset
) {
77 case 'angular-modules.json':
78 $moduleNames = $page->parseModuleNames(\CRM_Utils_Array
::value('modules', $event->params
), $angular);
79 $event->mimeType
= 'application/json';
80 $event->content
= json_encode($page->getMetadata($moduleNames, $angular));
83 case 'angular-modules.js':
84 $moduleNames = $page->parseModuleNames(\CRM_Utils_Array
::value('modules', $event->params
), $angular);
85 $event->mimeType
= 'application/javascript';
86 $event->content
= $page->digestJs($angular->getResources($moduleNames, 'js', 'path'));
89 case 'angular-modules.css':
90 $moduleNames = $page->parseModuleNames(\CRM_Utils_Array
::value('modules', $event->params
), $angular);
91 $event->mimeType
= 'text/css';
92 $event->content
= \CRM_Utils_File
::concat($angular->getResources($moduleNames, 'css', 'path'), "\n");
100 * @param array $files
104 public function digestJs($files) {
106 foreach ($files as $file) {
107 $scripts[] = file_get_contents($file);
109 $scripts = \CRM_Utils_JS
::dedupeClosures(
111 array('angular', '$', '_'),
112 array('angular', 'CRM.$', 'CRM._')
114 // This impl of stripComments currently adds 10-20ms and cuts ~7%
115 return \CRM_Utils_JS
::stripComments(implode("\n", $scripts));
119 * @param string $modulesExpr
120 * Comma-separated list of module names.
121 * @param \Civi\Angular\Manager $angular
123 * Any well-formed module names. All if moduleExpr is blank.
125 public function parseModuleNames($modulesExpr, $angular) {
127 $moduleNames = preg_grep(
128 '/^[a-zA-Z0-9\-_\.]+$/',
129 explode(',', $modulesExpr)
134 $moduleNames = array_keys($angular->getModules());
140 * @param array $moduleNames
141 * List of module names.
142 * @param \Civi\Angular\Manager $angular
145 public function getMetadata($moduleNames, $angular) {
146 $modules = $angular->getModules();
148 foreach ($moduleNames as $moduleName) {
149 if (isset($modules[$moduleName])) {
150 $result[$moduleName] = array();
151 $result[$moduleName]['domain'] = $modules[$moduleName]['ext'];
152 $result[$moduleName]['js'] = $angular->getResources($moduleName, 'js', 'rawUrl');
153 $result[$moduleName]['css'] = $angular->getResources($moduleName, 'css', 'rawUrl');
154 $result[$moduleName]['partials'] = $angular->getPartials($moduleName);
155 $result[$moduleName]['strings'] = $angular->getTranslatedStrings($moduleName);
164 * @param string $type
166 * @param string $data
169 public function send($type, $data) {
170 // Encourage browsers to cache for a long time - 1 year
171 $ttl = 60 * 60 * 24 * 364;
172 \CRM_Utils_System
::setHttpHeader('Expires', gmdate('D, d M Y H:i:s \G\M\T', time() +
$ttl));
173 \CRM_Utils_System
::setHttpHeader("Content-Type", $type);
174 \CRM_Utils_System
::setHttpHeader("Cache-Control", "max-age=$ttl, public");