crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/Civi/API/Subscriber/ChainSubscriber.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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($event->getApiKernel(), $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 \Civi\API\Kernel $apiKernel
  82    * @param $params
  83    * @param $result
  84    * @param $action
  85    * @param $entity
  86    * @param $version
  87    * @throws \Exception
  88    */
  89   protected function callNestedApi($apiKernel, &$params, &$result, $action, $entity, $version) {
  90     $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
  91
  92     // We don't need to worry about nested api in the getfields/getoptions
  93     // actions, so just return immediately.
  94     if (in_array($action, array('getfields', 'getoptions'))) {
  95       return;
  96     }
  97
  98     if ($action == 'getsingle') {
  99       // I don't understand the protocol here, but we don't want
 100       // $result to be a recursive array
 101       // $result['values'][0] = $result;
 102       $oldResult = $result;
 103       $result = array('values' => array(0 => $oldResult));
 104     }
 105     foreach ($params as $field => $newparams) {
 106       if ((is_array($newparams) || $newparams === 1) && $field <> 'api.has_parent' && substr($field, 0, 3) == 'api') {
 107
 108         // 'api.participant.delete' => 1 is a valid options - handle 1
 109         // instead of an array
 110         if ($newparams === 1) {
 111           $newparams = array('version' => $version);
 112         }
 113         // can be api_ or api.
 114         $separator = $field[3];
 115         if (!($separator == '.' || $separator == '_')) {
 116           continue;
 117         }
 118         $subAPI = explode($separator, $field);
 119
 120         $subaction = empty($subAPI[2]) ? $action : $subAPI[2];
 121         $subParams = array(
 122           'debug' => \CRM_Utils_Array::value('debug', $params),
 123         );
 124         $subEntity = _civicrm_api_get_entity_name_from_camel($subAPI[1]);
 125
 126         foreach ($result['values'] as $idIndex => $parentAPIValues) {
 127
 128           if ($subEntity != 'contact') {
 129             //contact spits the dummy at activity_id so what else won't it like?
 130             //set entity_id & entity table based on the parent's id & entity.
 131             //e.g for something like note if the parent call is contact
 132             //'entity_table' will be set to 'contact' & 'id' to the contact id
 133             //from the parent call. in this case 'contact_id' will also be
 134             //set to the parent's id
 135             $subParams["entity_id"] = $parentAPIValues['id'];
 136             $subParams['entity_table'] = 'civicrm_' . $lowercase_entity;
 137
 138             $crm16084 = FALSE;
 139             if ($subEntity == 'relationship' && $lowercase_entity == 'contact') {
 140               // if a relationship call is chained to a contact call, we need
 141               // to check whether contact_id_a or contact_id_b for the
 142               // relationship is given. If so, don't add an extra subParam
 143               // "contact_id" => parent_id.
 144               // See CRM-16084.
 145               foreach (array_keys($newparams) as $key) {
 146                 if (substr($key, 0, 11) == 'contact_id_') {
 147                   $crm16084 = TRUE;
 148                   break;
 149                 }
 150               }
 151             }
 152             if (!$crm16084) {
 153               $subParams[$lowercase_entity . "_id"] = $parentAPIValues['id'];
 154             }
 155           }
 156           if ($entity != 'Contact' && \CRM_Utils_Array::value(strtolower($subEntity . "_id"), $parentAPIValues)) {
 157             //e.g. if event_id is in the values returned & subentity is event
 158             //then pass in event_id as 'id' don't do this for contact as it
 159             //does some wierd things like returning primary email &
 160             //thus limiting the ability to chain email
 161             //TODO - this might need the camel treatment
 162             $subParams['id'] = $parentAPIValues[$subEntity . "_id"];
 163           }
 164
 165           if (\CRM_Utils_Array::value('entity_table', $result['values'][$idIndex]) == $subEntity) {
 166             $subParams['id'] = $result['values'][$idIndex]['entity_id'];
 167           }
 168           // if we are dealing with the same entity pass 'id' through
 169           // (useful for get + delete for example)
 170           if ($lowercase_entity == $subEntity) {
 171             $subParams['id'] = $result['values'][$idIndex]['id'];
 172           }
 173
 174           $subParams['version'] = $version;
 175           if (!empty($params['check_permissions'])) {
 176             $subParams['check_permissions'] = $params['check_permissions'];
 177           }
 178           $subParams['sequential'] = 1;
 179           $subParams['api.has_parent'] = 1;
 180           if (array_key_exists(0, $newparams)) {
 181             $genericParams = $subParams;
 182             // it is a numerically indexed array - ie. multiple creates
 183             foreach ($newparams as $entityparams) {
 184               $subParams = array_merge($genericParams, $entityparams);
 185               _civicrm_api_replace_variables($subParams, $result['values'][$idIndex], $separator);
 186               $result['values'][$idIndex][$field][] = $apiKernel->run($subEntity, $subaction, $subParams);
 187               if ($result['is_error'] === 1) {
 188                 throw new \Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 189               }
 190             }
 191           }
 192           else {
 193
 194             $subParams = array_merge($subParams, $newparams);
 195             _civicrm_api_replace_variables($subParams, $result['values'][$idIndex], $separator);
 196             $result['values'][$idIndex][$field] = $apiKernel->run($subEntity, $subaction, $subParams);
 197             if (!empty($result['is_error'])) {
 198               throw new \Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 199             }
 200           }
 201         }
 202       }
 203     }
 204     if ($action == 'getsingle') {
 205       $result = $result['values'][0];
 206     }
 207   }
 208
 209 }