4 +--------------------------------------------------------------------+
5 | Copyright CiviCRM LLC. All rights reserved. |
7 | This work is published under the GNU AGPLv3 license with some |
8 | permitted exceptions and without any warranty. For full license |
9 | and copyright information, see https://civicrm.org/licensing |
10 +--------------------------------------------------------------------+
12 namespace Civi\Api4\Generic
;
14 use Civi\Api4\Utils\CoreUtil
;
15 use Civi\Api4\Utils\FormattingUtil
;
16 use Civi\Api4\Utils\ReflectionUtils
;
19 * Base class for all api actions.
21 * An api Action object stores the parameters of the api call, and defines a _run function to execute the action.
23 * Every `protected` class var is considered a parameter (unless it starts with an underscore).
25 * Adding a `protected` var to your Action named e.g. `$thing` will automatically:
26 * - Provide a getter/setter (via `__call` MagicMethod) named `getThing()` and `setThing()`.
27 * - Expose the param in the Api Explorer (be sure to add a doc-block as it displays in the help panel).
28 * - Require a value for the param if you add the "@required" annotation.
30 * @method bool getCheckPermissions()
31 * @method $this setDebug(bool $value) Enable/disable debug output
32 * @method bool getDebug()
33 * @method $this setChain(array $chain)
34 * @method array getChain()
36 abstract class AbstractAction
implements \ArrayAccess
{
38 use \Civi\Schema\Traits\MagicGetterSetterTrait
;
41 * Api version number; cannot be changed.
45 protected $version = 4;
48 * Additional api requests - will be called once per result.
50 * Keys can be any string - this will be the name given to the output.
52 * You can reference other values in the api results in this call by prefixing them with `$`.
54 * For example, you could create a contact and place them in a group by chaining the
55 * `GroupContact` api to the `Contact` api:
59 * ->setValue('first_name', 'Hello')
60 * ->addChain('add_a_group', GroupContact::create()
61 * ->setValue('contact_id', '$id')
62 * ->setValue('group_id', 123)
66 * This will substitute the id of the newly created contact with `$id`.
70 protected $chain = [];
73 * Whether to enforce acl permissions based on the current user.
75 * Setting to FALSE will disable permission checks and override ACLs.
76 * In REST/javascript this cannot be disabled.
80 protected $checkPermissions = TRUE;
83 * Add debugging info to the api result.
85 * When enabled, `$result->debug` will be populated with information about the api call,
86 * including sql queries executed.
88 * **Note:** with checkPermissions enabled, debug info will only be returned if the user has "view debug output" permission.
92 protected $debug = FALSE;
97 protected $_entityName;
102 protected $_actionName;
105 * @var \ReflectionClass
107 private $_reflection;
117 private $_entityFields;
122 private $_arrayStorage = [];
126 * Used to identify api calls for transactions
127 * @see \Civi\Core\Transaction\Manager
131 public $_debugOutput = [];
134 * Action constructor.
136 * @param string $entityName
137 * @param string $actionName
138 * @throws \API_Exception
140 public function __construct($entityName, $actionName) {
141 // If a namespaced class name is passed in
142 if (strpos($entityName, '\\') !== FALSE) {
143 $entityName = substr($entityName, strrpos($entityName, '\\') +
1);
145 $this->_entityName
= $entityName;
146 $this->_actionName
= $actionName;
147 $this->_id
= \Civi\API\Request
::getNextId();
151 * Strictly enforce api parameters
156 public function __set($name, $value) {
157 throw new \
API_Exception('Unknown api parameter');
163 * @throws \API_Exception
165 public function setVersion($val) {
166 if ($val !== 4 && $val !== '4') {
167 throw new \
API_Exception('Cannot modify api version');
173 * @param bool $checkPermissions
176 public function setCheckPermissions(bool $checkPermissions) {
177 $this->checkPermissions
= $checkPermissions;
182 * @param string $name
183 * Unique name for this chained request
184 * @param \Civi\Api4\Generic\AbstractAction $apiRequest
185 * @param string|int|array $index
186 * See `civicrm_api4()` for documentation of `$index` param
189 public function addChain($name, AbstractAction
$apiRequest, $index = NULL) {
190 $this->chain
[$name] = [$apiRequest->getEntityName(), $apiRequest->getActionName(), $apiRequest->getParams(), $index];
195 * Magic function to provide automatic getter/setter for params.
199 * @return static|mixed
200 * @throws \API_Exception
202 public function __call($name, $arguments) {
203 $param = lcfirst(substr($name, 3));
204 if (!$param ||
$param[0] == '_') {
205 throw new \
API_Exception('Unknown api parameter: ' . $name);
207 $mode = substr($name, 0, 3);
208 if ($this->paramExists($param)) {
211 return $this->$param;
214 $this->$param = $arguments[0];
218 throw new \
API_Exception('Unknown api parameter: ' . $name);
224 * At this point all the params have been sent in and we initiate the api call & return the result.
225 * This is basically the outer wrapper for api v4.
227 * @return \Civi\Api4\Generic\Result
228 * @throws \API_Exception
229 * @throws \Civi\API\Exception\UnauthorizedException
231 public function execute() {
232 /** @var \Civi\API\Kernel $kernel */
233 $kernel = \Civi
::service('civi_api_kernel');
234 $result = $kernel->runRequest($this);
235 if ($this->debug
&& (!$this->checkPermissions || \CRM_Core_Permission
::check('view debug output'))) {
236 $result->debug
['actionClass'] = get_class($this);
237 $result->debug
= array_merge($result->debug
, $this->_debugOutput
);
240 $result->debug
= NULL;
246 * @param \Civi\Api4\Generic\Result $result
248 abstract public function _run(Result
$result);
251 * Serialize this object's params into an array
254 public function getParams() {
256 $magicProperties = $this->getMagicProperties();
257 foreach ($magicProperties as $name => $bool) {
258 $params[$name] = $this->$name;
264 * Get documentation for one or all params
266 * @param string $param
267 * @return array of arrays [description, type, default, (comment)]
269 public function getParamInfo($param = NULL) {
270 if (!isset($this->_paramInfo
)) {
271 $defaults = $this->getParamDefaults();
273 'entity' => $this->getEntityName(),
274 'action' => $this->getActionName(),
276 // For actions like "getFields" and "getActions" they are not getting the entity itself.
277 // So generic docs will make more sense like this:
278 if (substr($vars['action'], 0, 3) === 'get' && substr($vars['action'], -1) === 's') {
279 $vars['entity'] = lcfirst(substr($vars['action'], 3, -1));
281 foreach ($this->reflect()->getProperties(\ReflectionProperty
::IS_PROTECTED
) as $property) {
282 $name = $property->getName();
283 if ($name != 'version' && $name[0] != '_') {
284 $this->_paramInfo
[$name] = ReflectionUtils
::getCodeDocs($property, 'Property', $vars);
285 $this->_paramInfo
[$name]['default'] = $defaults[$name];
289 return $param ?
$this->_paramInfo
[$param] : $this->_paramInfo
;
295 public function getEntityName() {
296 return $this->_entityName
;
303 public function getActionName() {
304 return $this->_actionName
;
308 * @param string $param
311 public function paramExists($param) {
312 return array_key_exists($param, $this->getMagicProperties());
318 protected function getParamDefaults() {
319 return array_intersect_key($this->reflect()->getDefaultProperties(), $this->getMagicProperties());
325 public function offsetExists($offset) {
326 return in_array($offset, ['entity', 'action', 'params', 'version', 'check_permissions', 'id']) ||
isset($this->_arrayStorage
[$offset]);
332 public function &offsetGet($offset) {
334 if (in_array($offset, ['entity', 'action'])) {
337 if (in_array($offset, ['entityName', 'actionName', 'params', 'version'])) {
338 $getter = 'get' . ucfirst($offset);
339 $val = $this->$getter();
342 if ($offset == 'check_permissions') {
343 return $this->checkPermissions
;
345 if ($offset == 'id') {
348 if (isset($this->_arrayStorage
[$offset])) {
349 return $this->_arrayStorage
[$offset];
357 public function offsetSet($offset, $value) {
358 if (in_array($offset, ['entity', 'action', 'entityName', 'actionName', 'params', 'version', 'id'])) {
359 throw new \
API_Exception('Cannot modify api4 state via array access');
361 if ($offset == 'check_permissions') {
362 $this->setCheckPermissions($value);
365 $this->_arrayStorage
[$offset] = $value;
372 public function offsetUnset($offset) {
373 if (in_array($offset, ['entity', 'action', 'entityName', 'actionName', 'params', 'check_permissions', 'version', 'id'])) {
374 throw new \
API_Exception('Cannot modify api4 state via array access');
376 unset($this->_arrayStorage
[$offset]);
380 * Is this api call permitted?
382 * This function is called if checkPermissions is set to true.
385 * @internal Implement/override in civicrm-core.git only. Signature may evolve.
387 public function isAuthorized(): bool {
388 $permissions = $this->getPermissions();
389 return \CRM_Core_Permission
::check($permissions);
395 public function getPermissions() {
396 $permissions = call_user_func([CoreUtil
::getApiClass($this->_entityName
), 'permissions']);
398 // applies to getFields, getActions, etc.
399 'meta' => ['access CiviCRM'],
400 // catch-all, applies to create, get, delete, etc.
401 'default' => ['administer CiviCRM'],
403 $action = $this->getActionName();
404 // Map specific action names to more generic versions
406 'getActions' => 'meta',
407 'getFields' => 'meta',
408 'replace' => 'delete',
411 $generic = $map[$action] ??
'default';
412 return $permissions[$action] ??
$permissions[$generic] ??
$permissions['default'];
416 * Returns schema fields for this entity & action.
418 * Here we bypass the api wrapper and run the getFields action directly.
419 * This is because we DON'T want the wrapper to check permissions as this is an internal op.
420 * @see \Civi\Api4\Action\Contact\GetFields
422 * @throws \API_Exception
425 public function entityFields() {
426 if (!$this->_entityFields
) {
427 $allowedTypes = ['Field', 'Filter', 'Extra'];
428 if (method_exists($this, 'getCustomGroup')) {
429 $allowedTypes[] = 'Custom';
431 $getFields = \Civi\API\Request
::create($this->getEntityName(), 'getFields', [
433 'checkPermissions' => FALSE,
434 'action' => $this->getActionName(),
435 'where' => [['type', 'IN', $allowedTypes]],
437 $result = new Result();
438 // Pass TRUE for the private $isInternal param
439 $getFields->_run($result, TRUE);
440 $this->_entityFields
= (array) $result->indexBy('name');
442 return $this->_entityFields
;
446 * @return \ReflectionClass
448 public function reflect() {
449 if (!$this->_reflection
) {
450 $this->_reflection
= new \
ReflectionClass($this);
452 return $this->_reflection
;
456 * Validates required fields for actions which create a new object.
460 * @throws \API_Exception
462 protected function checkRequiredFields($values) {
464 foreach ($this->entityFields() as $fieldName => $fieldInfo) {
465 if (!isset($values[$fieldName]) ||
$values[$fieldName] === '') {
466 if (!empty($fieldInfo['required']) && !isset($fieldInfo['default_value'])) {
467 $unmatched[] = $fieldName;
469 elseif (!empty($fieldInfo['required_if'])) {
470 if ($this->evaluateCondition($fieldInfo['required_if'], ['values' => $values])) {
471 $unmatched[] = $fieldName;
480 * Replaces pseudoconstants in input values
482 * @param array $record
483 * @throws \API_Exception
485 protected function formatWriteValues(&$record) {
487 // Collect fieldnames with a :pseudoconstant suffix & remove them from $record array
488 foreach (array_keys($record) as $expr) {
489 $suffix = strrpos($expr, ':');
491 $fieldName = substr($expr, 0, $suffix);
492 $field = $this->entityFields()[$fieldName] ??
NULL;
494 $optionFields[$fieldName] = [
495 'val' => $record[$expr],
498 'suffix' => substr($expr, $suffix +
1),
499 'depends' => $field['input_attrs']['control_field'] ??
NULL,
501 unset($record[$expr]);
505 // Sort option lookups by dependency, so e.g. country_id is processed first, then state_province_id, then county_id
506 uasort($optionFields, function ($a, $b) {
507 return $a['field']['name'] === $b['depends'] ?
-1 : 1;
509 // Replace pseudoconstants. Note this is a reverse lookup as we are evaluating input not output.
510 foreach ($optionFields as $fieldName => $info) {
511 $options = FormattingUtil
::getPseudoconstantList($info['field'], $info['expr'], $record, 'create');
512 $record[$fieldName] = FormattingUtil
::replacePseudoconstant($options, $info['val'], TRUE);
517 * This function is used internally for evaluating field annotations.
519 * It should never be passed raw user input.
521 * @param string $expr
522 * Conditional in php format e.g. $foo > $bar
524 * Variable name => value
526 * @throws \API_Exception
529 protected function evaluateCondition($expr, $vars) {
530 if (strpos($expr, '}') !== FALSE ||
strpos($expr, '{') !== FALSE) {
531 throw new \
API_Exception('Illegal character in expression');
533 $tpl = "{if $expr}1{else}0{/if}";
534 return (bool) trim(\CRM_Core_Smarty
::singleton()->fetchWith('string:' . $tpl, $vars));
538 * When in debug mode, this logs the callback function being used by a Basic*Action class.
540 * @param callable $callable
542 protected function addCallbackToDebugOutput($callable) {
543 if ($this->debug
&& empty($this->_debugOutput
['callback'])) {
544 if (is_scalar($callable)) {
545 $this->_debugOutput
['callback'] = (string) $callable;
547 elseif (is_array($callable)) {
548 foreach ($callable as $key => $unit) {
549 $this->_debugOutput
['callback'][$key] = is_object($unit) ?
get_class($unit) : (string) $unit;
552 elseif (is_object($callable)) {
553 $this->_debugOutput
['callback'] = get_class($callable);