Civi/API/Subscriber/ChainSubscriber.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 namespace Civi\API\Subscriber;
  29
  30 use Civi\API\Events;
  31 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  32
  33 /**
  34  * The ChainSubscriber looks for API parameters which specify a nested or
  35  * chained API call. For example:
  36  *
  37  * @code
  38  * $result = civicrm_api('Contact', 'create', array(
  39  *   'version' => 3,
  40  *   'first_name' => 'Amy',
  41  *   'api.Email.create' => array(
  42  *     'email' => 'amy@example.com',
  43  *     'location_type_id' => 123,
  44  *   ),
  45  * ));
  46  * @endcode
  47  *
  48  * The ChainSubscriber looks for any parameters of the form "api.Email.create";
  49  * if found, it issues the nested API call (and passes some extra context --
  50  * eg Amy's contact_id).
  51  */
  52 class ChainSubscriber implements EventSubscriberInterface {
  53   /**
  54    * @return array
  55    */
  56   public static function getSubscribedEvents() {
  57     return array(
  58       Events::RESPOND => array('onApiRespond', Events::W_EARLY),
  59     );
  60   }
  61
  62   /**
  63    * @param \Civi\API\Event\RespondEvent $event
  64    *   API response event.
  65    *
  66    * @throws \Exception
  67    */
  68   public function onApiRespond(\Civi\API\Event\RespondEvent $event) {
  69     $apiRequest = $event->getApiRequest();
  70     $result = $event->getResponse();
  71     if (\CRM_Utils_Array::value('is_error', $result, 0) == 0) {
  72       $this->callNestedApi($apiRequest['params'], $result, $apiRequest['action'], $apiRequest['entity'], $apiRequest['version']);
  73       $event->setResponse($result);
  74     }
  75   }
  76
  77   /**
  78    * Call any nested api calls
  79    *
  80    * TODO: We don't really need this to be a separate function.
  81    * @param $params
  82    * @param $result
  83    * @param $action
  84    * @param $entity
  85    * @param $version
  86    * @throws \Exception
  87    */
  88   protected function callNestedApi(&$params, &$result, $action, $entity, $version) {
  89     $entity = _civicrm_api_get_entity_name_from_camel($entity);
  90
  91     // We don't need to worry about nested api in the getfields/getoptions
  92     // actions, so just return immediately.
  93     if (in_array(strtolower($action), array('getfields', 'getoptions'))) {
  94       return;
  95     }
  96
  97     if (strtolower($action) == 'getsingle') {
  98       // I don't understand the protocol here, but we don't want
  99       // $result to be a recursive array
 100       // $result['values'][0] = $result;
 101       $oldResult = $result;
 102       $result = array('values' => array(0 => $oldResult));
 103     }
 104     foreach ($params as $field => $newparams) {
 105       if ((is_array($newparams) || $newparams === 1) && $field <> 'api.has_parent' && substr($field, 0, 3) == 'api') {
 106
 107         // 'api.participant.delete' => 1 is a valid options - handle 1
 108         // instead of an array
 109         if ($newparams === 1) {
 110           $newparams = array('version' => $version);
 111         }
 112         // can be api_ or api.
 113         $separator = $field[3];
 114         if (!($separator == '.' || $separator == '_')) {
 115           continue;
 116         }
 117         $subAPI = explode($separator, $field);
 118
 119         $subaction = empty($subAPI[2]) ? $action : $subAPI[2];
 120         $subParams = array(
 121           'debug' => \CRM_Utils_Array::value('debug', $params),
 122         );
 123         $subEntity = $subAPI[1];
 124
 125         foreach ($result['values'] as $idIndex => $parentAPIValues) {
 126
 127           if (strtolower($subEntity) != 'contact') {
 128             //contact spits the dummy at activity_id so what else won't it like?
 129             //set entity_id & entity table based on the parent's id & entity.
 130             //e.g for something like note if the parent call is contact
 131             //'entity_table' will be set to 'contact' & 'id' to the contact id
 132             //from the parent call. in this case 'contact_id' will also be
 133             //set to the parent's id
 134             $subParams["entity_id"] = $parentAPIValues['id'];
 135             $subParams['entity_table'] = 'civicrm_' . _civicrm_api_get_entity_name_from_camel($entity);
 136             $subParams[strtolower($entity) . "_id"] = $parentAPIValues['id'];
 137           }
 138           if (strtolower($entity) != 'contact' && \CRM_Utils_Array::value(strtolower($subEntity . "_id"), $parentAPIValues)) {
 139             //e.g. if event_id is in the values returned & subentity is event
 140             //then pass in event_id as 'id' don't do this for contact as it
 141             //does some wierd things like returning primary email &
 142             //thus limiting the ability to chain email
 143             //TODO - this might need the camel treatment
 144             $subParams['id'] = $parentAPIValues[$subEntity . "_id"];
 145           }
 146
 147           if (\CRM_Utils_Array::value('entity_table', $result['values'][$idIndex]) == $subEntity) {
 148             $subParams['id'] = $result['values'][$idIndex]['entity_id'];
 149           }
 150           // if we are dealing with the same entity pass 'id' through
 151           // (useful for get + delete for example)
 152           if (strtolower($entity) == strtolower($subEntity)) {
 153             $subParams['id'] = $result['values'][$idIndex]['id'];
 154           }
 155
 156           $subParams['version'] = $version;
 157           if (!empty($params['check_permissions'])) {
 158             $subParams['check_permissions'] = $params['check_permissions'];
 159           }
 160           $subParams['sequential'] = 1;
 161           $subParams['api.has_parent'] = 1;
 162           if (array_key_exists(0, $newparams)) {
 163             $genericParams = $subParams;
 164             // it is a numerically indexed array - ie. multiple creates
 165             foreach ($newparams as $entityparams) {
 166               $subParams = array_merge($genericParams, $entityparams);
 167               _civicrm_api_replace_variables($subParams, $result['values'][$idIndex], $separator);
 168               $result['values'][$result['id']][$field][] = civicrm_api($subEntity, $subaction, $subParams);
 169               if ($result['is_error'] === 1) {
 170                 throw new \Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 171               }
 172             }
 173           }
 174           else {
 175
 176             $subParams = array_merge($subParams, $newparams);
 177             _civicrm_api_replace_variables($subParams, $result['values'][$idIndex], $separator);
 178             $result['values'][$idIndex][$field] = civicrm_api($subEntity, $subaction, $subParams);
 179             if (!empty($result['is_error'])) {
 180               throw new \Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 181             }
 182           }
 183         }
 184       }
 185     }
 186     if (strtolower($action) == 'getsingle') {
 187       $result = $result['values'][0];
 188     }
 189   }
 190
 191 }