api/v3/Activity.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.4                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28  */
  29
  30 /**
  31  * File for the CiviCRM APIv3 activity functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Activity
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * @version $Id: Activity.php 30486 2010-11-02 16:12:09Z shot $
  37  *
  38  */
  39
  40
  41 /**
  42  * Creates or updates an Activity. See the example for usage
  43  *
  44  * @param array  $params       Associative array of property name/value
  45  *                             pairs for the activity.
  46  * {@getfields activity_create}
  47  *
  48  * @return array Array containing 'is_error' to denote success or failure and details of the created activity
  49  *
  50  * @example ActivityCreate.php Standard create example
  51  * @example Activity/ContactRefCustomField.php Create example including setting a contact reference custom field
  52  * {@example ActivityCreate.php 0}
  53  *
  54  */
  55 function civicrm_api3_activity_create($params) {
  56
  57   if (empty($params['id'])) {
  58     // an update does not require any mandatory parameters
  59     civicrm_api3_verify_one_mandatory($params,
  60       NULL,
  61       array(
  62         'activity_name', 'activity_type_id', 'activity_label',
  63       )
  64     );
  65   }
  66
  67   $errors = array();
  68
  69   // check for various error and required conditions
  70   // note that almost all the processing in there should be managed by the wrapper layer
  71   // & should be removed - needs testing
  72   $errors = _civicrm_api3_activity_check_params($params);
  73
  74   // this should not be required as should throw exception rather than return errors -
  75   //needs testing
  76   if (!empty($errors)) {
  77     return $errors;
  78   }
  79
  80
  81   // processing for custom data
  82   $values = array();
  83   _civicrm_api3_custom_format_params($params, $values, 'Activity');
  84
  85   if (!empty($values['custom'])) {
  86     $params['custom'] = $values['custom'];
  87   }
  88
  89   // this should be set as a default rather than hard coded
  90   // needs testing
  91   $params['skipRecentView'] = TRUE;
  92
  93   // If this is a case activity, see if there is an existing activity
  94   // and set it as an old revision. Also retrieve details we'll need.
  95   // this handling should all be moved to the BAO layer
  96   $case_id           = '';
  97   $createRevision    = FALSE;
  98   $oldActivityValues = array();
  99   if (!empty($params['case_id'])) {
 100     $case_id = $params['case_id'];
 101     if (!empty($params['id'])) {
 102       $oldActivityParams = array('id' => $params['id']);
 103       if (!$oldActivityValues) {
 104         CRM_Activity_BAO_Activity::retrieve($oldActivityParams, $oldActivityValues);
 105       }
 106       if (empty($oldActivityValues)) {
 107         return civicrm_api3_create_error(ts("Unable to locate existing activity."));
 108       }
 109       else {
 110         $activityDAO = new CRM_Activity_DAO_Activity();
 111         $activityDAO->id = $params['id'];
 112         $activityDAO->is_current_revision = 0;
 113         if (!$activityDAO->save()) {
 114           if (is_object($activityDAO)) {
 115             $activityDAO->free();
 116           }
 117           return civicrm_api3_create_error(ts("Unable to revision existing case activity."), NULL, $activityDAO);
 118         }
 119         $createRevision = TRUE;
 120       }
 121     }
 122   }
 123
 124   $deleteActivityAssignment = FALSE;
 125   if (isset($params['assignee_contact_id'])) {
 126     $deleteActivityAssignment = TRUE;
 127   }
 128
 129   $deleteActivityTarget = FALSE;
 130   if (isset($params['target_contact_id'])) {
 131     $deleteActivityTarget = TRUE;
 132   }
 133
 134   // this should all be handled at the BAO layer
 135   $params['deleteActivityAssignment'] = CRM_Utils_Array::value('deleteActivityAssignment', $params, $deleteActivityAssignment);
 136   $params['deleteActivityTarget'] = CRM_Utils_Array::value('deleteActivityTarget', $params, $deleteActivityTarget);
 137
 138   if ($case_id && $createRevision) {
 139     // This is very similar to the copy-to-case action.
 140     if (!CRM_Utils_Array::crmIsEmptyArray($oldActivityValues['target_contact'])) {
 141       $oldActivityValues['targetContactIds'] = implode(',', array_unique($oldActivityValues['target_contact']));
 142     }
 143     if (!CRM_Utils_Array::crmIsEmptyArray($oldActivityValues['assignee_contact'])) {
 144       $oldActivityValues['assigneeContactIds'] = implode(',', array_unique($oldActivityValues['assignee_contact']));
 145     }
 146     $oldActivityValues['mode'] = 'copy';
 147     $oldActivityValues['caseID'] = $case_id;
 148     $oldActivityValues['activityID'] = $oldActivityValues['id'];
 149     $oldActivityValues['contactID'] = $oldActivityValues['source_contact_id'];
 150
 151     $copyToCase = CRM_Activity_Page_AJAX::_convertToCaseActivity($oldActivityValues);
 152     if (empty($copyToCase['error_msg'])) {
 153       // now fix some things that are different from copy-to-case
 154       // then fall through to the create below to update with the passed in params
 155       $params['id'] = $copyToCase['newId'];
 156       $params['is_auto'] = 0;
 157       $params['original_id'] = empty($oldActivityValues['original_id']) ? $oldActivityValues['id'] : $oldActivityValues['original_id'];
 158     }
 159     else {
 160       return civicrm_api3_create_error(ts("Unable to create new revision of case activity."));
 161     }
 162   }
 163
 164   // create activity
 165   $activityBAO = CRM_Activity_BAO_Activity::create($params);
 166
 167   if (isset($activityBAO->id)) {
 168     if ($case_id && !$createRevision) {
 169       // If this is a brand new case activity we need to add this
 170       $caseActivityParams = array('activity_id' => $activityBAO->id, 'case_id' => $case_id);
 171       CRM_Case_BAO_Case::processCaseActivity($caseActivityParams);
 172     }
 173
 174     _civicrm_api3_object_to_array($activityBAO, $activityArray[$activityBAO->id]);
 175     return civicrm_api3_create_success($activityArray, $params, 'activity', 'get', $activityBAO);
 176   }
 177 }
 178
 179 /**
 180  * Specify Meta data for create. Note that this data is retrievable via the getfields function
 181  * and is used for pre-filling defaults and ensuring mandatory requirements are met.
 182  * @param array $params (reference) array of parameters determined by getfields
 183  */
 184 function _civicrm_api3_activity_create_spec(&$params) {
 185
 186   //default for source_contact_id = currently logged in user
 187   $params['source_contact_id']['api.default'] = 'user_contact_id';
 188
 189   $params['status_id']['api.aliases'] = array('activity_status');
 190
 191   $params['assignee_contact_id'] = array(
 192     'name' => 'assignee_id',
 193     'title' => 'assigned to',
 194     'type' => 1,
 195     'FKClassName' => 'CRM_Activity_DAO_ActivityContact',
 196   );
 197   $params['target_contact_id'] = array(
 198     'name' => 'target_id',
 199     'title' => 'Activity Target',
 200     'type' => 1,
 201     'FKClassName' => 'CRM_Activity_DAO_ActivityContact',
 202   );
 203
 204   $params['source_contact_id'] = array(
 205       'name' => 'source_contact_id',
 206       'title' => 'Activity Source Contact',
 207       'type' => 1,
 208       'FKClassName' => 'CRM_Activity_DAO_ActivityContact',
 209       'api.default' => 'user_contact_id',
 210   );
 211
 212 }
 213
 214 /**
 215  * Gets a CiviCRM activity according to parameters
 216  *
 217  * @param array  $params       Associative array of property name/value
 218  *                             pairs for the activity.
 219  *
 220  * @return array
 221  *
 222  * {@getfields activity_get}
 223  * @example ActivityGet.php Basic example
 224  * @example Activity/DateTimeHigh.php Example get with date filtering
 225  * {@example ActivityGet.php 0}
 226  */
 227 function civicrm_api3_activity_get($params) {
 228   if (!empty($params['contact_id'])) {
 229     $activities = CRM_Activity_BAO_Activity::getContactActivity($params['contact_id']);
 230     //BAO function doesn't actually return a contact ID - hack api for now & add to test so when api re-write happens it won't get missed
 231     foreach ($activities as $key => $activityArray) {
 232       $activities[$key]['id'] = $key;
 233     }
 234   }
 235   else {
 236     $activities = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE);
 237   }
 238
 239   $activities = _civicrm_api3_activity_get_formatResult($params, $activities);
 240   //legacy custom data get - so previous formatted response is still returned too
 241   return civicrm_api3_create_success($activities, $params, 'activity', 'get');
 242 }
 243
 244 /**
 245  * Given a list of activities, append any extra data requested about the activities
 246  *
 247  * NOTE: Called by civicrm-core and CiviHR
 248  *
 249  * @param array $params API request parameters
 250  * @param array $activities
 251  * @return array new activities list
 252  */
 253 function _civicrm_api3_activity_get_formatResult($params, $activities) {
 254   $returns = CRM_Utils_Array::value('return', $params, array());
 255   if (!is_array($returns)) {
 256     $returns = str_replace(' ', '', $returns);
 257     $returns = explode(',', $returns);
 258   }
 259   $returns = array_fill_keys($returns, 1);
 260
 261   foreach ($params as $n => $v) {
 262     if (substr($n, 0, 7) == 'return.') {
 263       $returnkey = substr($n, 7);
 264       $returns[$returnkey] = $v;
 265     }
 266   }
 267   $returns['source_contact_id'] = 1;
 268   foreach ($returns as $n => $v) {
 269     switch ($n) {
 270       case 'assignee_contact_id':
 271         foreach ($activities as $key => $activityArray) {
 272           $activities[$key]['assignee_contact_id'] = CRM_Activity_BAO_ActivityAssignment::retrieveAssigneeIdsByActivityId($activityArray['id']);
 273         }
 274         break;
 275       case 'target_contact_id':
 276         foreach ($activities as $key => $activityArray) {
 277           $activities[$key]['target_contact_id'] = CRM_Activity_BAO_ActivityTarget::retrieveTargetIdsByActivityId($activityArray['id']);
 278         }
 279         break;
 280       case 'source_contact_id':
 281         foreach ($activities as $key => $activityArray) {
 282           $activities[$key]['source_contact_id'] = CRM_Activity_BAO_Activity::getSourceContactID($activityArray['id']);
 283         }
 284         break;
 285       default:
 286         if (substr($n, 0, 6) == 'custom') {
 287           $returnProperties[$n] = $v;
 288         }
 289     }
 290   }
 291   if (!empty($activities) && (!empty($returnProperties) || !empty($params['contact_id']))) {
 292     foreach ($activities as $activityId => $values) {
 293       _civicrm_api3_custom_data_get($activities[$activityId], 'Activity', $activityId, NULL, $values['activity_type_id']);
 294     }
 295     return $activities;
 296   }
 297   return $activities;
 298 }
 299
 300
 301 /**
 302  * Delete a specified Activity.
 303  *
 304  * @param array $params array holding 'id' of activity to be deleted
 305  * {@getfields activity_delete}
 306  *
 307  * @return void|CRM_Core_Error  An error if 'activityName or ID' is invalid,
 308  *                         permissions are insufficient, etc. or CiviCRM success array
 309  *
 310  *
 311  *
 312  * @example ActivityDelete.php Standard Delete Example
 313  *
 314  *
 315  */
 316 function civicrm_api3_activity_delete($params) {
 317
 318   if (CRM_Activity_BAO_Activity::deleteActivity($params)) {
 319     return civicrm_api3_create_success(1, $params, 'activity', 'delete');
 320   }
 321   else {
 322     return civicrm_api3_create_error('Could not delete activity');
 323   }
 324 }
 325
 326 /**
 327  * Function to check for required params
 328  *
 329  * @param array   $params  associated array of fields
 330  * @param boolean $addMode true for add mode
 331  *
 332  * @return array $error array with errors
 333  */
 334 function _civicrm_api3_activity_check_params(&$params) {
 335
 336   $contactIDFields = array_intersect_key($params,
 337                      array(
 338                        'source_contact_id' => 1,
 339                        'assignee_contact_id' => 1,
 340                        'target_contact_id' => 1,
 341                      )
 342   );
 343
 344   // this should be handled by wrapper layer & probably the api would already manage it
 345   //correctly by doing post validation - ie. a failure should result in a roll-back = an error
 346   // needs testing
 347   if (!empty($contactIDFields)) {
 348     $contactIds = array();
 349     foreach ($contactIDFields as $fieldname => $contactfield) {
 350       if (empty($contactfield)) {
 351         continue;
 352       }
 353       if (is_array($contactfield)) {
 354         foreach ($contactfield as $contactkey => $contactvalue) {
 355           $contactIds[$contactvalue] = $contactvalue;
 356         }
 357       }
 358       else {
 359         $contactIds[$contactfield] = $contactfield;
 360       }
 361     }
 362
 363
 364     $sql = '
 365 SELECT  count(*)
 366   FROM  civicrm_contact
 367  WHERE  id IN (' . implode(', ', $contactIds) . ' )';
 368     if (count($contactIds) != CRM_Core_DAO::singleValueQuery($sql)) {
 369       return civicrm_api3_create_error('Invalid ' .  ' Contact Id');
 370     }
 371   }
 372
 373
 374   $activityIds = array('activity' => CRM_Utils_Array::value('id', $params),
 375                  'parent' => CRM_Utils_Array::value('parent_id', $params),
 376                  'original' => CRM_Utils_Array::value('original_id', $params),
 377   );
 378
 379   foreach ($activityIds as $id => $value) {
 380     if ($value &&
 381       !CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $value, 'id')
 382     ) {
 383       return civicrm_api3_create_error('Invalid ' . ucfirst($id) . ' Id');
 384     }
 385   }
 386   // this should be handled by wrapper layer & probably the api would already manage it
 387   //correctly by doing pseudoconstant validation
 388   // needs testing
 389   $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'validate');
 390   $activityName  = CRM_Utils_Array::value('activity_name', $params);
 391   $activityName  = ucfirst($activityName);
 392   $activityLabel = CRM_Utils_Array::value('activity_label', $params);
 393   if ($activityLabel) {
 394     $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'create');
 395   }
 396
 397   $activityTypeId = CRM_Utils_Array::value('activity_type_id', $params);
 398
 399   if ($activityName || $activityLabel) {
 400     $activityTypeIdInList = array_search(($activityName ? $activityName : $activityLabel), $activityTypes);
 401
 402     if (!$activityTypeIdInList) {
 403       $errorString = $activityName ? "Invalid Activity Name : $activityName"  : "Invalid Activity Type Label";
 404       throw new Exception($errorString);
 405     }
 406     elseif ($activityTypeId && ($activityTypeId != $activityTypeIdInList)) {
 407       return civicrm_api3_create_error('Mismatch in Activity');
 408     }
 409     $params['activity_type_id'] = $activityTypeIdInList;
 410   }
 411   elseif ($activityTypeId &&
 412     !array_key_exists($activityTypeId, $activityTypes)
 413   ) {
 414     return civicrm_api3_create_error('Invalid Activity Type ID');
 415   }
 416
 417   // check for activity duration minutes
 418   // this should be validated @ the wrapper layer not here
 419   // needs testing
 420   if (isset($params['duration_minutes']) && !is_numeric($params['duration_minutes'])) {
 421     return civicrm_api3_create_error('Invalid Activity Duration (in minutes)');
 422   }
 423
 424
 425   //if adding a new activity & date_time not set make it now
 426   // this should be managed by the wrapper layer & setting ['api.default'] in speces
 427   // needs testing
 428   if (empty($params['id']) && empty($params['activity_date_time'])) {
 429     $params['activity_date_time'] = CRM_Utils_Date::processDate(date('Y-m-d H:i:s'));
 430   }
 431
 432   return NULL;
 433 }
 434