Civi/Api4/Generic/AbstractAction.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC. All rights reserved.                        |
   6  |                                                                    |
   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  +--------------------------------------------------------------------+
  11  */
  12 namespace Civi\Api4\Generic;
  13
  14 use Civi\Api4\Utils\CoreUtil;
  15 use Civi\Api4\Utils\FormattingUtil;
  16 use Civi\Api4\Utils\ReflectionUtils;
  17
  18 /**
  19  * Base class for all api actions.
  20  *
  21  * An api Action object stores the parameters of the api call, and defines a _run function to execute the action.
  22  *
  23  * Every `protected` class var is considered a parameter (unless it starts with an underscore).
  24  *
  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.
  29  *
  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()
  35  */
  36 abstract class AbstractAction implements \ArrayAccess {
  37
  38   use \Civi\Schema\Traits\MagicGetterSetterTrait;
  39
  40   /**
  41    * Api version number; cannot be changed.
  42    *
  43    * @var int
  44    */
  45   protected $version = 4;
  46
  47   /**
  48    * Additional api requests - will be called once per result.
  49    *
  50    * Keys can be any string - this will be the name given to the output.
  51    *
  52    * You can reference other values in the api results in this call by prefixing them with `$`.
  53    *
  54    * For example, you could create a contact and place them in a group by chaining the
  55    * `GroupContact` api to the `Contact` api:
  56    *
  57    * ```php
  58    * Contact::create()
  59    *   ->setValue('first_name', 'Hello')
  60    *   ->addChain('add_a_group', GroupContact::create()
  61    *     ->setValue('contact_id', '$id')
  62    *     ->setValue('group_id', 123)
  63    *   )
  64    * ```
  65    *
  66    * This will substitute the id of the newly created contact with `$id`.
  67    *
  68    * @var array
  69    */
  70   protected $chain = [];
  71
  72   /**
  73    * Whether to enforce acl permissions based on the current user.
  74    *
  75    * Setting to FALSE will disable permission checks and override ACLs.
  76    * In REST/javascript this cannot be disabled.
  77    *
  78    * @var bool
  79    */
  80   protected $checkPermissions = TRUE;
  81
  82   /**
  83    * Add debugging info to the api result.
  84    *
  85    * When enabled, `$result->debug` will be populated with information about the api call,
  86    * including sql queries executed.
  87    *
  88    * **Note:** with checkPermissions enabled, debug info will only be returned if the user has "view debug output" permission.
  89    *
  90    * @var bool
  91    */
  92   protected $debug = FALSE;
  93
  94   /**
  95    * @var string
  96    */
  97   protected $_entityName;
  98
  99   /**
 100    * @var string
 101    */
 102   protected $_actionName;
 103
 104   /**
 105    * @var \ReflectionClass
 106    */
 107   private $_reflection;
 108
 109   /**
 110    * @var array
 111    */
 112   private $_paramInfo;
 113
 114   /**
 115    * @var array
 116    */
 117   private $_entityFields;
 118
 119   /**
 120    * @var array
 121    */
 122   private $_arrayStorage = [];
 123
 124   /**
 125    * @var int
 126    * Used to identify api calls for transactions
 127    * @see \Civi\Core\Transaction\Manager
 128    */
 129   private $_id;
 130
 131   public $_debugOutput = [];
 132
 133   /**
 134    * Action constructor.
 135    *
 136    * @param string $entityName
 137    * @param string $actionName
 138    * @throws \API_Exception
 139    */
 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);
 144     }
 145     $this->_entityName = $entityName;
 146     $this->_actionName = $actionName;
 147     $this->_id = \Civi\API\Request::getNextId();
 148   }
 149
 150   /**
 151    * Strictly enforce api parameters
 152    * @param $name
 153    * @param $value
 154    * @throws \Exception
 155    */
 156   public function __set($name, $value) {
 157     throw new \API_Exception('Unknown api parameter');
 158   }
 159
 160   /**
 161    * @param int $val
 162    * @return $this
 163    * @throws \API_Exception
 164    */
 165   public function setVersion($val) {
 166     if ($val !== 4 && $val !== '4') {
 167       throw new \API_Exception('Cannot modify api version');
 168     }
 169     return $this;
 170   }
 171
 172   /**
 173    * @param bool $checkPermissions
 174    * @return $this
 175    */
 176   public function setCheckPermissions(bool $checkPermissions) {
 177     $this->checkPermissions = $checkPermissions;
 178     return $this;
 179   }
 180
 181   /**
 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
 187    * @return $this
 188    */
 189   public function addChain($name, AbstractAction $apiRequest, $index = NULL) {
 190     $this->chain[$name] = [$apiRequest->getEntityName(), $apiRequest->getActionName(), $apiRequest->getParams(), $index];
 191     return $this;
 192   }
 193
 194   /**
 195    * Invoke api call.
 196    *
 197    * At this point all the params have been sent in and we initiate the api call & return the result.
 198    * This is basically the outer wrapper for api v4.
 199    *
 200    * @return \Civi\Api4\Generic\Result
 201    * @throws \API_Exception
 202    * @throws \Civi\API\Exception\UnauthorizedException
 203    */
 204   public function execute() {
 205     /** @var \Civi\API\Kernel $kernel */
 206     $kernel = \Civi::service('civi_api_kernel');
 207     $result = $kernel->runRequest($this);
 208     if ($this->debug && (!$this->checkPermissions || \CRM_Core_Permission::check('view debug output'))) {
 209       $result->debug['actionClass'] = get_class($this);
 210       $result->debug = array_merge($result->debug, $this->_debugOutput);
 211     }
 212     else {
 213       $result->debug = NULL;
 214     }
 215     return $result;
 216   }
 217
 218   /**
 219    * @param \Civi\Api4\Generic\Result $result
 220    */
 221   abstract public function _run(Result $result);
 222
 223   /**
 224    * Serialize this object's params into an array
 225    * @return array
 226    */
 227   public function getParams() {
 228     $params = [];
 229     $magicProperties = $this->getMagicProperties();
 230     foreach ($magicProperties as $name => $bool) {
 231       $params[$name] = $this->$name;
 232     }
 233     return $params;
 234   }
 235
 236   /**
 237    * Get documentation for one or all params
 238    *
 239    * @param string $param
 240    * @return array of arrays [description, type, default, (comment)]
 241    */
 242   public function getParamInfo($param = NULL) {
 243     if (!isset($this->_paramInfo)) {
 244       $defaults = $this->getParamDefaults();
 245       $vars = [
 246         'entity' => $this->getEntityName(),
 247         'action' => $this->getActionName(),
 248       ];
 249       // For actions like "getFields" and "getActions" they are not getting the entity itself.
 250       // So generic docs will make more sense like this:
 251       if (substr($vars['action'], 0, 3) === 'get' && substr($vars['action'], -1) === 's') {
 252         $vars['entity'] = lcfirst(substr($vars['action'], 3, -1));
 253       }
 254       foreach ($this->reflect()->getProperties(\ReflectionProperty::IS_PROTECTED) as $property) {
 255         $name = $property->getName();
 256         if ($name != 'version' && $name[0] != '_') {
 257           $this->_paramInfo[$name] = ReflectionUtils::getCodeDocs($property, 'Property', $vars);
 258           $this->_paramInfo[$name]['default'] = $defaults[$name];
 259         }
 260       }
 261     }
 262     return $param ? $this->_paramInfo[$param] : $this->_paramInfo;
 263   }
 264
 265   /**
 266    * @return string
 267    */
 268   public function getEntityName() {
 269     return $this->_entityName;
 270   }
 271
 272   /**
 273    *
 274    * @return string
 275    */
 276   public function getActionName() {
 277     return $this->_actionName;
 278   }
 279
 280   /**
 281    * @param string $param
 282    * @return bool
 283    */
 284   public function paramExists($param) {
 285     return array_key_exists($param, $this->getMagicProperties());
 286   }
 287
 288   /**
 289    * @return array
 290    */
 291   protected function getParamDefaults() {
 292     return array_intersect_key($this->reflect()->getDefaultProperties(), $this->getMagicProperties());
 293   }
 294
 295   /**
 296    * @inheritDoc
 297    */
 298   public function offsetExists($offset) {
 299     return in_array($offset, ['entity', 'action', 'params', 'version', 'check_permissions', 'id']) || isset($this->_arrayStorage[$offset]);
 300   }
 301
 302   /**
 303    * @inheritDoc
 304    */
 305   public function &offsetGet($offset) {
 306     $val = NULL;
 307     if (in_array($offset, ['entity', 'action'])) {
 308       $offset .= 'Name';
 309     }
 310     if (in_array($offset, ['entityName', 'actionName', 'params', 'version'])) {
 311       $getter = 'get' . ucfirst($offset);
 312       $val = $this->$getter();
 313       return $val;
 314     }
 315     if ($offset == 'check_permissions') {
 316       return $this->checkPermissions;
 317     }
 318     if ($offset == 'id') {
 319       return $this->_id;
 320     }
 321     if (isset($this->_arrayStorage[$offset])) {
 322       return $this->_arrayStorage[$offset];
 323     }
 324     return $val;
 325   }
 326
 327   /**
 328    * @inheritDoc
 329    */
 330   public function offsetSet($offset, $value) {
 331     if (in_array($offset, ['entity', 'action', 'entityName', 'actionName', 'params', 'version', 'id'])) {
 332       throw new \API_Exception('Cannot modify api4 state via array access');
 333     }
 334     if ($offset == 'check_permissions') {
 335       $this->setCheckPermissions($value);
 336     }
 337     else {
 338       $this->_arrayStorage[$offset] = $value;
 339     }
 340   }
 341
 342   /**
 343    * @inheritDoc
 344    */
 345   public function offsetUnset($offset) {
 346     if (in_array($offset, ['entity', 'action', 'entityName', 'actionName', 'params', 'check_permissions', 'version', 'id'])) {
 347       throw new \API_Exception('Cannot modify api4 state via array access');
 348     }
 349     unset($this->_arrayStorage[$offset]);
 350   }
 351
 352   /**
 353    * Is this api call permitted?
 354    *
 355    * This function is called if checkPermissions is set to true.
 356    *
 357    * @return bool
 358    * @internal Implement/override in civicrm-core.git only. Signature may evolve.
 359    */
 360   public function isAuthorized(): bool {
 361     $permissions = $this->getPermissions();
 362     return \CRM_Core_Permission::check($permissions);
 363   }
 364
 365   /**
 366    * @return array
 367    */
 368   public function getPermissions() {
 369     $permissions = call_user_func([CoreUtil::getApiClass($this->_entityName), 'permissions']);
 370     $permissions += [
 371       // applies to getFields, getActions, etc.
 372       'meta' => ['access CiviCRM'],
 373       // catch-all, applies to create, get, delete, etc.
 374       'default' => ['administer CiviCRM'],
 375     ];
 376     $action = $this->getActionName();
 377     // Map specific action names to more generic versions
 378     $map = [
 379       'getActions' => 'meta',
 380       'getFields' => 'meta',
 381       'replace' => 'delete',
 382       'save' => 'create',
 383     ];
 384     $generic = $map[$action] ?? 'default';
 385     return $permissions[$action] ?? $permissions[$generic] ?? $permissions['default'];
 386   }
 387
 388   /**
 389    * Returns schema fields for this entity & action.
 390    *
 391    * Here we bypass the api wrapper and run the getFields action directly.
 392    * This is because we DON'T want the wrapper to check permissions as this is an internal op.
 393    * @see \Civi\Api4\Action\Contact\GetFields
 394    *
 395    * @throws \API_Exception
 396    * @return array
 397    */
 398   public function entityFields() {
 399     if (!$this->_entityFields) {
 400       $allowedTypes = ['Field', 'Filter', 'Extra'];
 401       if (method_exists($this, 'getCustomGroup')) {
 402         $allowedTypes[] = 'Custom';
 403       }
 404       $getFields = \Civi\API\Request::create($this->getEntityName(), 'getFields', [
 405         'version' => 4,
 406         'checkPermissions' => FALSE,
 407         'action' => $this->getActionName(),
 408         'where' => [['type', 'IN', $allowedTypes]],
 409       ]);
 410       $result = new Result();
 411       // Pass TRUE for the private $isInternal param
 412       $getFields->_run($result, TRUE);
 413       $this->_entityFields = (array) $result->indexBy('name');
 414     }
 415     return $this->_entityFields;
 416   }
 417
 418   /**
 419    * @return \ReflectionClass
 420    */
 421   public function reflect() {
 422     if (!$this->_reflection) {
 423       $this->_reflection = new \ReflectionClass($this);
 424     }
 425     return $this->_reflection;
 426   }
 427
 428   /**
 429    * Validates required fields for actions which create a new object.
 430    *
 431    * @param $values
 432    * @return array
 433    * @throws \API_Exception
 434    */
 435   protected function checkRequiredFields($values) {
 436     $unmatched = [];
 437     foreach ($this->entityFields() as $fieldName => $fieldInfo) {
 438       if (!isset($values[$fieldName]) || $values[$fieldName] === '') {
 439         if (!empty($fieldInfo['required']) && !isset($fieldInfo['default_value'])) {
 440           $unmatched[] = $fieldName;
 441         }
 442         elseif (!empty($fieldInfo['required_if'])) {
 443           if ($this->evaluateCondition($fieldInfo['required_if'], ['values' => $values])) {
 444             $unmatched[] = $fieldName;
 445           }
 446         }
 447       }
 448     }
 449     return $unmatched;
 450   }
 451
 452   /**
 453    * Replaces pseudoconstants in input values
 454    *
 455    * @param array $record
 456    * @throws \API_Exception
 457    */
 458   protected function formatWriteValues(&$record) {
 459     $optionFields = [];
 460     // Collect fieldnames with a :pseudoconstant suffix & remove them from $record array
 461     foreach (array_keys($record) as $expr) {
 462       $suffix = strrpos($expr, ':');
 463       if ($suffix) {
 464         $fieldName = substr($expr, 0, $suffix);
 465         $field = $this->entityFields()[$fieldName] ?? NULL;
 466         if ($field) {
 467           $optionFields[$fieldName] = [
 468             'val' => $record[$expr],
 469             'expr' => $expr,
 470             'field' => $field,
 471             'suffix' => substr($expr, $suffix + 1),
 472             'depends' => $field['input_attrs']['control_field'] ?? NULL,
 473           ];
 474           unset($record[$expr]);
 475         }
 476       }
 477     }
 478     // Sort option lookups by dependency, so e.g. country_id is processed first, then state_province_id, then county_id
 479     uasort($optionFields, function ($a, $b) {
 480       return $a['field']['name'] === $b['depends'] ? -1 : 1;
 481     });
 482     // Replace pseudoconstants. Note this is a reverse lookup as we are evaluating input not output.
 483     foreach ($optionFields as $fieldName => $info) {
 484       $options = FormattingUtil::getPseudoconstantList($info['field'], $info['expr'], $record, 'create');
 485       $record[$fieldName] = FormattingUtil::replacePseudoconstant($options, $info['val'], TRUE);
 486     }
 487   }
 488
 489   /**
 490    * This function is used internally for evaluating field annotations.
 491    *
 492    * It should never be passed raw user input.
 493    *
 494    * @param string $expr
 495    *   Conditional in php format e.g. $foo > $bar
 496    * @param array $vars
 497    *   Variable name => value
 498    * @return bool
 499    * @throws \API_Exception
 500    * @throws \Exception
 501    */
 502   protected function evaluateCondition($expr, $vars) {
 503     if (strpos($expr, '}') !== FALSE || strpos($expr, '{') !== FALSE) {
 504       throw new \API_Exception('Illegal character in expression');
 505     }
 506     $tpl = "{if $expr}1{else}0{/if}";
 507     return (bool) trim(\CRM_Core_Smarty::singleton()->fetchWith('string:' . $tpl, $vars));
 508   }
 509
 510   /**
 511    * When in debug mode, this logs the callback function being used by a Basic*Action class.
 512    *
 513    * @param callable $callable
 514    */
 515   protected function addCallbackToDebugOutput($callable) {
 516     if ($this->debug && empty($this->_debugOutput['callback'])) {
 517       if (is_scalar($callable)) {
 518         $this->_debugOutput['callback'] = (string) $callable;
 519       }
 520       elseif (is_array($callable)) {
 521         foreach ($callable as $key => $unit) {
 522           $this->_debugOutput['callback'][$key] = is_object($unit) ? get_class($unit) : (string) $unit;
 523         }
 524       }
 525       elseif (is_object($callable)) {
 526         $this->_debugOutput['callback'] = get_class($callable);
 527       }
 528     }
 529   }
 530
 531 }