3 require_once 'afform.civix.php';
4 use CRM_Afform_ExtensionUtil
as E
;
5 use Civi\Api4\Action\Afform\Submit
;
8 * Filter the content of $params to only have supported afform fields.
10 * @param array $params
13 function _afform_fields_filter($params) {
15 $fields = \Civi\Api4\Afform
::getfields()->setCheckPermissions(FALSE)->setAction('create')->execute()->indexBy('name');
16 foreach ($fields as $fieldName => $field) {
17 if (isset($params[$fieldName])) {
18 $result[$fieldName] = $params[$fieldName];
20 if ($field['data_type'] === 'Boolean' && !is_bool($params[$fieldName])) {
21 $result[$fieldName] = CRM_Utils_String
::strtobool($params[$fieldName]);
29 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
31 function afform_civicrm_container($container) {
32 $container->addResource(new \Symfony\Component\Config\
Resource\
FileResource(__FILE__
));
33 $container->setDefinition('afform_scanner', new \Symfony\Component\DependencyInjection\
Definition(
34 'CRM_Afform_AfformScanner',
40 * Implements hook_civicrm_config().
42 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
44 function afform_civicrm_config(&$config) {
45 _afform_civix_civicrm_config($config);
47 if (isset(Civi
::$statics[__FUNCTION__
])) {
50 Civi
::$statics[__FUNCTION__
] = 1;
52 Civi
::dispatcher()->addListener(Submit
::EVENT_NAME
, [Submit
::class, 'processContacts'], 500);
53 Civi
::dispatcher()->addListener(Submit
::EVENT_NAME
, [Submit
::class, 'processGenericEntity'], -1000);
54 Civi
::dispatcher()->addListener('hook_civicrm_angularModules', '_afform_civicrm_angularModules_autoReq', -1000);
58 * Implements hook_civicrm_xmlMenu().
60 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
62 function afform_civicrm_xmlMenu(&$files) {
63 _afform_civix_civicrm_xmlMenu($files);
67 * Implements hook_civicrm_install().
69 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
71 function afform_civicrm_install() {
72 _afform_civix_civicrm_install();
76 * Implements hook_civicrm_postInstall().
78 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
80 function afform_civicrm_postInstall() {
81 _afform_civix_civicrm_postInstall();
85 * Implements hook_civicrm_uninstall().
87 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
89 function afform_civicrm_uninstall() {
90 _afform_civix_civicrm_uninstall();
94 * Implements hook_civicrm_enable().
96 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
98 function afform_civicrm_enable() {
99 _afform_civix_civicrm_enable();
103 * Implements hook_civicrm_disable().
105 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
107 function afform_civicrm_disable() {
108 _afform_civix_civicrm_disable();
112 * Implements hook_civicrm_upgrade().
114 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
116 function afform_civicrm_upgrade($op, CRM_Queue_Queue
$queue = NULL) {
117 return _afform_civix_civicrm_upgrade($op, $queue);
121 * Implements hook_civicrm_managed().
123 * Generate a list of entities to create/deactivate/delete when this module
124 * is installed, disabled, uninstalled.
126 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
128 function afform_civicrm_managed(&$entities) {
129 _afform_civix_civicrm_managed($entities);
133 * Implements hook_civicrm_caseTypes().
135 * Generate a list of case-types.
137 * Note: This hook only runs in CiviCRM 4.4+.
139 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
141 function afform_civicrm_caseTypes(&$caseTypes) {
142 _afform_civix_civicrm_caseTypes($caseTypes);
146 * Implements hook_civicrm_angularModules().
148 * Generate a list of Afform Angular modules.
150 function afform_civicrm_angularModules(&$angularModules) {
151 _afform_civix_civicrm_angularModules($angularModules);
153 $afforms = \Civi\Api4\Afform
::get(FALSE)
154 ->setSelect(['name', 'requires', 'module_name', 'directive_name'])
157 foreach ($afforms as $afform) {
158 $angularModules[$afform['module_name']] = [
159 'ext' => E
::LONG_NAME
,
160 'js' => ['assetBuilder://afform.js?name=' . urlencode($afform['name'])],
161 'requires' => $afform['requires'],
163 'partialsCallback' => '_afform_get_partials',
164 '_afform' => $afform['name'],
166 $afform['directive_name'] => 'AE',
173 * Callback to retrieve partials for a given afform/angular module.
175 * @see afform_civicrm_angularModules
177 * @param string $moduleName
179 * @param array $module
180 * The module definition.
182 * Array(string $filename => string $html).
183 * @throws API_Exception
185 function _afform_get_partials($moduleName, $module) {
186 $afform = civicrm_api4('Afform', 'get', [
187 'where' => [['name', '=', $module['_afform']]],
188 'select' => ['layout'],
189 'layoutFormat' => 'html',
190 'checkPermissions' => FALSE,
193 "~/$moduleName/$moduleName.aff.html" => $afform['layout'],
198 * Scan the list of Angular modules and inject automatic-requirements.
200 * TLDR: if an afform uses element "<other-el/>", and if another module defines
201 * `$angularModules['otherMod']['exports']['el'][0] === 'other-el'`, then
202 * the 'otherMod' is automatically required.
204 * @param \Civi\Core\Event\GenericHookEvent $e
205 * @see CRM_Utils_Hook::angularModules()
207 function _afform_civicrm_angularModules_autoReq($e) {
208 /** @var CRM_Afform_AfformScanner $scanner */
209 $scanner = Civi
::service('afform_scanner');
210 $moduleEnvId = md5(\CRM_Core_Config_Runtime
::getId() . implode(',', array_keys($e->angularModules
)));
211 $depCache = CRM_Utils_Cache
::create([
212 'name' => 'afdep_' . substr($moduleEnvId, 0, 32 - 6),
213 'type' => ['*memory*', 'SqlGroup', 'ArrayCache'],
214 'withArray' => 'fast',
217 $depCacheTtl = 2 * 60 * 60;
219 $revMap = _afform_reverse_deps($e->angularModules
);
221 $formNames = array_keys($scanner->findFilePaths());
222 foreach ($formNames as $formName) {
223 $angModule = _afform_angular_module_name($formName, 'camel');
224 $cacheLine = $depCache->get($formName, NULL);
226 $jFile = $scanner->findFilePath($formName, 'aff.json');
227 $hFile = $scanner->findFilePath($formName, 'aff.html');
229 $jStat = stat($jFile);
230 $hStat = stat($hFile);
232 if ($cacheLine === NULL) {
235 elseif ($jStat !== FALSE && $jStat['size'] !== $cacheLine['js']) {
238 elseif ($jStat !== FALSE && $jStat['mtime'] > $cacheLine['jm']) {
241 elseif ($hStat !== FALSE && $hStat['size'] !== $cacheLine['hs']) {
244 elseif ($hStat !== FALSE && $hStat['mtime'] > $cacheLine['hm']) {
248 $needsUpdate = FALSE;
253 'js' => $jStat['size'] ??
NULL,
254 'jm' => $jStat['mtime'] ??
NULL,
255 'hs' => $hStat['size'] ??
NULL,
256 'hm' => $hStat['mtime'] ??
NULL,
257 'r' => array_values(array_unique(array_merge(
258 [CRM_Afform_AfformScanner
::DEFAULT_REQUIRES
],
259 $e->angularModules
[$angModule]['requires'] ??
[],
260 _afform_reverse_deps_find($formName, file_get_contents($hFile), $revMap)
263 // print_r(['cache update:' . $formName => $cacheLine]);
264 $depCache->set($formName, $cacheLine, $depCacheTtl);
267 $e->angularModules
[$angModule]['requires'] = $cacheLine['r'];
272 * @param $angularModules
274 * 'attr': array(string $attrName => string $angModuleName)
275 * 'el': array(string $elementName => string $angModuleName)
277 function _afform_reverse_deps($angularModules) {
278 $revMap = ['attr' => [], 'el' => []];
279 foreach (array_keys($angularModules) as $module) {
280 if (!isset($angularModules[$module]['exports'])) {
283 foreach ($angularModules[$module]['exports'] as $symbolName => $symbolTypes) {
284 if (strpos($symbolTypes, 'A') !== FALSE) {
285 $revMap['attr'][$symbolName] = $module;
287 if (strpos($symbolTypes, 'E') !== FALSE) {
288 $revMap['el'][$symbolName] = $module;
296 * @param string $formName
297 * @param string $html
298 * @param array $revMap
299 * The reverse-dependencies map from _afform_reverse_deps().
301 * @see _afform_reverse_deps()
303 function _afform_reverse_deps_find($formName, $html, $revMap) {
304 $symbols = \Civi\Afform\Symbols
::scan($html);
305 $elems = array_intersect_key($revMap['el'], $symbols->elements
);
306 $attrs = array_intersect_key($revMap['attr'], $symbols->attributes
);
307 return array_values(array_unique(array_merge($elems, $attrs)));
311 * @param \Civi\Angular\Manager $angular
312 * @see CRM_Utils_Hook::alterAngular()
314 function afform_civicrm_alterAngular($angular) {
315 $fieldMetadata = \Civi\Angular\ChangeSet
::create('fieldMetadata')
316 ->alterHtml(';\\.aff\\.html$;', function($doc, $path) {
318 $module = \Civi
::service('angular')->getModule(basename($path, '.aff.html'));
319 $meta = \Civi\Api4\Afform
::get()->addWhere('name', '=', $module['_afform'])->setSelect(['join', 'block'])->setCheckPermissions(FALSE)->execute()->first();
321 catch (Exception
$e) {
324 $blockEntity = $meta['join'] ??
$meta['block'] ??
NULL;
326 $entities = _afform_getMetadata($doc);
329 foreach (pq('af-field', $doc) as $afField) {
330 /** @var DOMElement $afField */
331 $entityName = pq($afField)->parents('[af-fieldset]')->attr('af-fieldset');
332 $joinName = pq($afField)->parents('[af-join]')->attr('af-join');
333 if (!$blockEntity && !preg_match(';^[a-zA-Z0-9\_\-\. ]+$;', $entityName)) {
334 throw new \
CRM_Core_Exception("Cannot process $path: malformed entity name ($entityName)");
336 $entityType = $blockEntity ??
$entities[$entityName]['type'];
337 _af_fill_field_metadata($joinName ?
$joinName : $entityType, $afField);
340 $angular->add($fieldMetadata);
344 * Merge field definition metadata into an afform field's definition
347 * @param DOMElement $afField
348 * @throws API_Exception
350 function _af_fill_field_metadata($entityType, DOMElement
$afField) {
352 'action' => 'create',
353 'where' => [['name', '=', $afField->getAttribute('name')]],
354 'select' => ['title', 'input_type', 'input_attrs', 'options'],
355 'loadOptions' => TRUE,
357 if (in_array($entityType, CRM_Contact_BAO_ContactType
::basicTypes(TRUE))) {
358 $params['values'] = ['contact_type' => $entityType];
359 $entityType = 'Contact';
361 $getFields = civicrm_api4($entityType, 'getFields', $params);
362 // Merge field definition data with whatever's already in the markup
363 $deep = ['input_attrs'];
364 foreach ($getFields as $fieldInfo) {
365 $existingFieldDefn = trim(pq($afField)->attr('defn') ?
: '');
366 if ($existingFieldDefn && $existingFieldDefn[0] != '{') {
367 // If it's not an object, don't mess with it.
370 // TODO: Teach the api to return options in this format
371 if (!empty($fieldInfo['options'])) {
372 $fieldInfo['options'] = CRM_Utils_Array
::makeNonAssociative($fieldInfo['options'], 'key', 'label');
374 // Default placeholder for select inputs
375 if ($fieldInfo['input_type'] === 'Select') {
376 $fieldInfo['input_attrs'] = ($fieldInfo['input_attrs'] ??
[]) +
['placeholder' => ts('Select')];
379 $fieldDefn = $existingFieldDefn ? CRM_Utils_JS
::getRawProps($existingFieldDefn) : [];
380 foreach ($fieldInfo as $name => $prop) {
381 // Merge array props 1 level deep
382 if (in_array($name, $deep) && !empty($fieldDefn[$name])) {
383 $fieldDefn[$name] = CRM_Utils_JS
::writeObject(CRM_Utils_JS
::getRawProps($fieldDefn[$name]) +
array_map(['CRM_Utils_JS', 'encode'], $prop));
385 elseif (!isset($fieldDefn[$name])) {
386 $fieldDefn[$name] = CRM_Utils_JS
::encode($prop);
389 pq($afField)->attr('defn', htmlspecialchars(CRM_Utils_JS
::writeObject($fieldDefn)));
393 function _afform_getMetadata(phpQueryObject
$doc) {
395 foreach ($doc->find('af-entity') as $afmModelProp) {
396 $entities[$afmModelProp->getAttribute('name')] = [
397 'type' => $afmModelProp->getAttribute('type'),
404 * Implements hook_civicrm_alterSettingsFolders().
406 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
408 function afform_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
409 _afform_civix_civicrm_alterSettingsFolders($metaDataFolders);
413 * Implements hook_civicrm_entityTypes().
415 * Declare entity types provided by this module.
417 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_entityTypes
419 function afform_civicrm_entityTypes(&$entityTypes) {
420 _afform_civix_civicrm_entityTypes($entityTypes);
424 * Implements hook_civicrm_themes().
426 function afform_civicrm_themes(&$themes) {
427 _afform_civix_civicrm_themes($themes);
431 * Implements hook_civicrm_buildAsset().
433 function afform_civicrm_buildAsset($asset, $params, &$mimeType, &$content) {
434 if ($asset !== 'afform.js') {
438 if (empty($params['name'])) {
439 throw new RuntimeException("Missing required parameter: afform.js?name=NAME");
442 $moduleName = _afform_angular_module_name($params['name'], 'camel');
443 $smarty = CRM_Core_Smarty
::singleton();
444 $smarty->assign('afform', [
445 'camel' => $moduleName,
446 'meta' => ['name' => $params['name']],
447 'templateUrl' => "~/$moduleName/$moduleName.aff.html",
449 $mimeType = 'text/javascript';
450 $content = $smarty->fetch('afform/AfformAngularModule.tpl');
454 * Implements hook_civicrm_alterMenu().
456 function afform_civicrm_alterMenu(&$items) {
457 if (Civi
::container()->has('afform_scanner')) {
458 $scanner = Civi
::service('afform_scanner');
461 // During installation...
462 $scanner = new CRM_Afform_AfformScanner();
464 foreach ($scanner->getMetas() as $name => $meta) {
465 if (!empty($meta['server_route'])) {
466 $items[$meta['server_route']] = [
467 'page_callback' => 'CRM_Afform_Page_AfformBase',
468 'page_arguments' => 'afform=' . urlencode($name),
469 'title' => $meta['title'] ??
'',
470 'access_arguments' => [["@afform:$name"], 'and'],
471 'is_public' => $meta['is_public'],
478 * Implements hook_civicrm_permission_check().
480 * This extends the list of permissions available in `CRM_Core_Permission:check()`
481 * by introducing virtual-permissions named `@afform:myForm`. The evaluation
482 * of these virtual-permissions is dependent on the settings for `myForm`.
483 * `myForm` may be exposed/integrated through multiple subsystems (routing,
484 * nav-menu, API, etc), and the use of virtual-permissions makes easy to enforce
485 * consistent permissions across any relevant subsystems.
487 * @see CRM_Utils_Hook::permission_check()
489 function afform_civicrm_permission_check($permission, &$granted, $contactId) {
490 if ($permission[0] !== '@') {
491 // Micro-optimization - this function may get hit a lot.
495 if (preg_match('/^@afform:(.*)/', $permission, $m)) {
498 $afform = \Civi\Api4\Afform
::get()
499 ->setCheckPermissions(FALSE)
500 ->addWhere('name', '=', $name)
501 ->setSelect(['permission'])
505 $granted = CRM_Core_Permission
::check($afform['permission'], $contactId);
511 * Clear any local/in-memory caches based on afform data.
513 function _afform_clear() {
514 $container = \Civi
::container();
515 $container->get('afform_scanner')->clear();
516 $container->get('angular')->clear();
520 * @param string $fileBaseName
522 * @param string $format
525 * Ex: 'FooBar' or 'foo-bar'.
528 function _afform_angular_module_name($fileBaseName, $format = 'camel') {
532 foreach (preg_split('/[-_ ]/', $fileBaseName, NULL, PREG_SPLIT_NO_EMPTY
) as $shortNamePart) {
533 $camelCase .= ucfirst($shortNamePart);
535 return strtolower($camelCase[0]) . substr($camelCase, 1);
538 return strtolower(implode('-', preg_split('/[-_ ]|(?=[A-Z])/', $fileBaseName, NULL, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE
)));
541 throw new \
Exception("Unrecognized format");