api/v3/Activity.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 /**
  29  * This api exposes CiviCRM Activity records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34
  35 /**
  36  * Creates or updates an Activity.
  37  *
  38  * @param array $params
  39  *   Array per getfields documentation.
  40  *
  41  * @throws API_Exception
  42  * @return array
  43  *   Array containing 'is_error' to denote success or failure and details of the created activity.
  44  */
  45 function civicrm_api3_activity_create($params) {
  46
  47   if (empty($params['id'])) {
  48     // an update does not require any mandatory parameters
  49     civicrm_api3_verify_one_mandatory($params,
  50       NULL,
  51       array(
  52         'activity_name',
  53         'activity_type_id',
  54         'activity_label',
  55       )
  56     );
  57   }
  58
  59   // check for various error and required conditions
  60   // note that almost all the processing in there should be managed by the wrapper layer
  61   // & should be removed - needs testing
  62   $errors = _civicrm_api3_activity_check_params($params);
  63
  64   // this should not be required as should throw exception rather than return errors -
  65   //needs testing
  66   if (!empty($errors)) {
  67     return $errors;
  68   }
  69
  70   // processing for custom data
  71   $values = $activityArray = array();
  72   _civicrm_api3_custom_format_params($params, $values, 'Activity');
  73
  74   if (!empty($values['custom'])) {
  75     $params['custom'] = $values['custom'];
  76   }
  77
  78   // this should be set as a default rather than hard coded
  79   // needs testing
  80   $params['skipRecentView'] = TRUE;
  81
  82   // If this is a case activity, see if there is an existing activity
  83   // and set it as an old revision. Also retrieve details we'll need.
  84   // this handling should all be moved to the BAO layer
  85   $case_id = '';
  86   $createRevision = FALSE;
  87   $oldActivityValues = array();
  88   // Lookup case id if not supplied
  89   if (!isset($params['case_id']) && !empty($params['id'])) {
  90     $params['case_id'] = CRM_Core_DAO::singleValueQuery("SELECT case_id FROM civicrm_case_activity WHERE activity_id = " . (int) $params['id']);
  91   }
  92   if (!empty($params['case_id'])) {
  93     $case_id = $params['case_id'];
  94     if (!empty($params['id'])) {
  95       $oldActivityParams = array('id' => $params['id']);
  96       if (!$oldActivityValues) {
  97         CRM_Activity_BAO_Activity::retrieve($oldActivityParams, $oldActivityValues);
  98       }
  99       if (empty($oldActivityValues)) {
 100         throw new API_Exception(ts("Unable to locate existing activity."));
 101       }
 102       else {
 103         $activityDAO = new CRM_Activity_DAO_Activity();
 104         $activityDAO->id = $params['id'];
 105         $activityDAO->is_current_revision = 0;
 106         if (!$activityDAO->save()) {
 107           if (is_object($activityDAO)) {
 108             $activityDAO->free();
 109           }
 110           throw new API_Exception(ts("Unable to revision existing case activity."));
 111         }
 112         $createRevision = TRUE;
 113       }
 114     }
 115   }
 116
 117   $deleteActivityAssignment = FALSE;
 118   if (isset($params['assignee_contact_id'])) {
 119     $deleteActivityAssignment = TRUE;
 120   }
 121
 122   $deleteActivityTarget = FALSE;
 123   if (isset($params['target_contact_id'])) {
 124     $deleteActivityTarget = TRUE;
 125   }
 126
 127   // this should all be handled at the BAO layer
 128   $params['deleteActivityAssignment'] = CRM_Utils_Array::value('deleteActivityAssignment', $params, $deleteActivityAssignment);
 129   $params['deleteActivityTarget'] = CRM_Utils_Array::value('deleteActivityTarget', $params, $deleteActivityTarget);
 130
 131   if ($case_id && $createRevision) {
 132     // This is very similar to the copy-to-case action.
 133     if (!CRM_Utils_Array::crmIsEmptyArray($oldActivityValues['target_contact'])) {
 134       $oldActivityValues['targetContactIds'] = implode(',', array_unique($oldActivityValues['target_contact']));
 135     }
 136     if (!CRM_Utils_Array::crmIsEmptyArray($oldActivityValues['assignee_contact'])) {
 137       $oldActivityValues['assigneeContactIds'] = implode(',', array_unique($oldActivityValues['assignee_contact']));
 138     }
 139     $oldActivityValues['mode'] = 'copy';
 140     $oldActivityValues['caseID'] = $case_id;
 141     $oldActivityValues['activityID'] = $oldActivityValues['id'];
 142     $oldActivityValues['contactID'] = $oldActivityValues['source_contact_id'];
 143
 144     $copyToCase = CRM_Activity_Page_AJAX::_convertToCaseActivity($oldActivityValues);
 145     if (empty($copyToCase['error_msg'])) {
 146       // now fix some things that are different from copy-to-case
 147       // then fall through to the create below to update with the passed in params
 148       $params['id'] = $copyToCase['newId'];
 149       $params['is_auto'] = 0;
 150       $params['original_id'] = empty($oldActivityValues['original_id']) ? $oldActivityValues['id'] : $oldActivityValues['original_id'];
 151     }
 152     else {
 153       throw new API_Exception(ts("Unable to create new revision of case activity."));
 154     }
 155   }
 156
 157   // create activity
 158   $activityBAO = CRM_Activity_BAO_Activity::create($params);
 159
 160   if (isset($activityBAO->id)) {
 161     if ($case_id && !$createRevision) {
 162       // If this is a brand new case activity we need to add this
 163       $caseActivityParams = array('activity_id' => $activityBAO->id, 'case_id' => $case_id);
 164       CRM_Case_BAO_Case::processCaseActivity($caseActivityParams);
 165     }
 166
 167     _civicrm_api3_object_to_array($activityBAO, $activityArray[$activityBAO->id]);
 168     return civicrm_api3_create_success($activityArray, $params, 'Activity', 'get', $activityBAO);
 169   }
 170 }
 171
 172 /**
 173  * Specify Meta data for create.
 174  *
 175  * Note that this data is retrievable via the getfields function and is used for pre-filling defaults and
 176  * ensuring mandatory requirements are met.
 177  *
 178  * @param array $params
 179  *   Array of parameters determined by getfields.
 180  */
 181 function _civicrm_api3_activity_create_spec(&$params) {
 182
 183   // Default for source_contact_id = currently logged in user.
 184   $params['source_contact_id']['api.default'] = 'user_contact_id';
 185
 186   $params['status_id']['api.aliases'] = array('activity_status');
 187
 188   $params['assignee_contact_id'] = array(
 189     'name' => 'assignee_id',
 190     'title' => 'Activity Assignee',
 191     'description' => 'Contact(s) assigned to this activity.',
 192     'type' => 1,
 193     'FKClassName' => 'CRM_Contact_DAO_Contact',
 194     'FKApiName' => 'Contact',
 195   );
 196   $params['target_contact_id'] = array(
 197     'name' => 'target_id',
 198     'title' => 'Activity Target',
 199     'description' => 'Contact(s) participating in this activity.',
 200     'type' => 1,
 201     'FKClassName' => 'CRM_Contact_DAO_Contact',
 202     'FKApiName' => 'Contact',
 203   );
 204
 205   $params['source_contact_id'] = array(
 206     'name' => 'source_contact_id',
 207     'title' => 'Activity Source Contact',
 208     'description' => 'Person who created this activity. Defaults to current user.',
 209     'type' => 1,
 210     'FKClassName' => 'CRM_Contact_DAO_Contact',
 211     'api.default' => 'user_contact_id',
 212     'FKApiName' => 'Contact',
 213   );
 214
 215   $params['case_id'] = array(
 216     'name' => 'case_id',
 217     'title' => 'Case ID',
 218     'description' => 'For creating an activity as part of a case.',
 219     'type' => 1,
 220     'FKClassName' => 'CRM_Case_DAO_Case',
 221     'FKApiName' => 'Case',
 222   );
 223
 224 }
 225
 226 /**
 227  * Gets a CiviCRM activity according to parameters.
 228  *
 229  * @param array $params
 230  *   Array per getfields documentation.
 231  *
 232  * @return array
 233  */
 234 function civicrm_api3_activity_get($params) {
 235   if (!empty($params['contact_id'])) {
 236     $activities = CRM_Activity_BAO_Activity::getContactActivity($params['contact_id']);
 237     // BAO function doesn't actually return a contact ID - hack api for now & add to test so when api re-write
 238     // happens it won't get missed.
 239     foreach ($activities as $key => $activityArray) {
 240       $activities[$key]['id'] = $key;
 241     }
 242   }
 243   else {
 244     $activities = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Activity');
 245   }
 246   $options = _civicrm_api3_get_options_from_params($params, FALSE, 'Activity', 'get');
 247   if ($options['is_count']) {
 248     return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
 249   }
 250
 251   $activities = _civicrm_api3_activity_get_formatResult($params, $activities);
 252   //legacy custom data get - so previous formatted response is still returned too
 253   return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
 254 }
 255
 256 /**
 257  * Given a list of activities, append any extra data requested about the activities.
 258  *
 259  * @note Called by civicrm-core and CiviHR
 260  *
 261  * @param array $params
 262  *   API request parameters.
 263  * @param array $activities
 264  *
 265  * @return array
 266  *   new activities list
 267  */
 268 function _civicrm_api3_activity_get_formatResult($params, $activities) {
 269   $returns = CRM_Utils_Array::value('return', $params, array());
 270   if (!is_array($returns)) {
 271     $returns = str_replace(' ', '', $returns);
 272     $returns = explode(',', $returns);
 273   }
 274   $returns = array_fill_keys($returns, 1);
 275
 276   foreach ($params as $n => $v) {
 277     if (substr($n, 0, 7) == 'return.') {
 278       $returnkey = substr($n, 7);
 279       $returns[$returnkey] = $v;
 280     }
 281   }
 282   $returns['source_contact_id'] = 1;
 283   foreach ($returns as $n => $v) {
 284     switch ($n) {
 285       case 'assignee_contact_id':
 286         foreach ($activities as $key => $activityArray) {
 287           $activities[$key]['assignee_contact_id'] = CRM_Activity_BAO_ActivityAssignment::retrieveAssigneeIdsByActivityId($activityArray['id']);
 288         }
 289         break;
 290
 291       case 'target_contact_id':
 292         foreach ($activities as $key => $activityArray) {
 293           $activities[$key]['target_contact_id'] = CRM_Activity_BAO_ActivityTarget::retrieveTargetIdsByActivityId($activityArray['id']);
 294         }
 295         break;
 296
 297       case 'source_contact_id':
 298         foreach ($activities as $key => $activityArray) {
 299           $activities[$key]['source_contact_id'] = CRM_Activity_BAO_Activity::getSourceContactID($activityArray['id']);
 300         }
 301         break;
 302
 303       default:
 304         if (substr($n, 0, 6) == 'custom') {
 305           $returnProperties[$n] = $v;
 306         }
 307     }
 308   }
 309   if (!empty($activities) && (!empty($returnProperties) || !empty($params['contact_id']))) {
 310     foreach ($activities as $activityId => $values) {
 311       //@todo - should possibly load activity type id if not loaded (update with id)
 312       _civicrm_api3_custom_data_get($activities[$activityId], 'Activity', $activityId, NULL, CRM_Utils_Array::value('activity_type_id', $values));
 313     }
 314   }
 315   return $activities;
 316 }
 317
 318
 319 /**
 320  * Delete a specified Activity.
 321  *
 322  * @param array $params
 323  *   Array holding 'id' of activity to be deleted.
 324  *
 325  * @throws API_Exception
 326  *
 327  * @return array
 328  */
 329 function civicrm_api3_activity_delete($params) {
 330
 331   if (CRM_Activity_BAO_Activity::deleteActivity($params)) {
 332     return civicrm_api3_create_success(1, $params, 'Activity', 'delete');
 333   }
 334   else {
 335     throw new API_Exception('Could not delete Activity');
 336   }
 337 }
 338
 339 /**
 340  * Check for required params.
 341  *
 342  * @param array $params
 343  *   Associated array of fields.
 344  *
 345  * @throws API_Exception
 346  * @throws Exception
 347  * @return array
 348  *   array with errors
 349  */
 350 function _civicrm_api3_activity_check_params(&$params) {
 351
 352   $contactIDFields = array_intersect_key($params,
 353     array(
 354       'source_contact_id' => 1,
 355       'assignee_contact_id' => 1,
 356       'target_contact_id' => 1,
 357     )
 358   );
 359
 360   // this should be handled by wrapper layer & probably the api would already manage it
 361   //correctly by doing post validation - ie. a failure should result in a roll-back = an error
 362   // needs testing
 363   if (!empty($contactIDFields)) {
 364     $contactIds = array();
 365     foreach ($contactIDFields as $fieldname => $contactfield) {
 366       if (empty($contactfield)) {
 367         continue;
 368       }
 369       if (is_array($contactfield)) {
 370         foreach ($contactfield as $contactkey => $contactvalue) {
 371           $contactIds[$contactvalue] = $contactvalue;
 372         }
 373       }
 374       else {
 375         $contactIds[$contactfield] = $contactfield;
 376       }
 377     }
 378
 379     $sql = '
 380 SELECT  count(*)
 381   FROM  civicrm_contact
 382  WHERE  id IN (' . implode(', ', $contactIds) . ' )';
 383     if (count($contactIds) != CRM_Core_DAO::singleValueQuery($sql)) {
 384       throw new API_Exception('Invalid Contact Id');
 385     }
 386   }
 387
 388   $activityIds = array(
 389     'activity' => CRM_Utils_Array::value('id', $params),
 390     'parent' => CRM_Utils_Array::value('parent_id', $params),
 391     'original' => CRM_Utils_Array::value('original_id', $params),
 392   );
 393
 394   foreach ($activityIds as $id => $value) {
 395     if ($value &&
 396       !CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $value, 'id')
 397     ) {
 398       throw new API_Exception('Invalid ' . ucfirst($id) . ' Id');
 399     }
 400   }
 401   // this should be handled by wrapper layer & probably the api would already manage it
 402   //correctly by doing pseudoconstant validation
 403   // needs testing
 404   $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'validate');
 405   $activityName = CRM_Utils_Array::value('activity_name', $params);
 406   $activityName = ucfirst($activityName);
 407   $activityLabel = CRM_Utils_Array::value('activity_label', $params);
 408   if ($activityLabel) {
 409     $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'create');
 410   }
 411
 412   $activityTypeId = CRM_Utils_Array::value('activity_type_id', $params);
 413
 414   if ($activityName || $activityLabel) {
 415     $activityTypeIdInList = array_search(($activityName ? $activityName : $activityLabel), $activityTypes);
 416
 417     if (!$activityTypeIdInList) {
 418       $errorString = $activityName ? "Invalid Activity Name : $activityName" : "Invalid Activity Type Label";
 419       throw new Exception($errorString);
 420     }
 421     elseif ($activityTypeId && ($activityTypeId != $activityTypeIdInList)) {
 422       throw new API_Exception('Mismatch in Activity');
 423     }
 424     $params['activity_type_id'] = $activityTypeIdInList;
 425   }
 426   elseif ($activityTypeId &&
 427     !array_key_exists($activityTypeId, $activityTypes)
 428   ) {
 429     throw new API_Exception('Invalid Activity Type ID');
 430   }
 431
 432   // check for activity duration minutes
 433   // this should be validated @ the wrapper layer not here
 434   // needs testing
 435   if (isset($params['duration_minutes']) && !is_numeric($params['duration_minutes'])) {
 436     throw new API_Exception('Invalid Activity Duration (in minutes)');
 437   }
 438
 439   //if adding a new activity & date_time not set make it now
 440   // this should be managed by the wrapper layer & setting ['api.default'] in speces
 441   // needs testing
 442   if (empty($params['id']) && empty($params['activity_date_time'])) {
 443     $params['activity_date_time'] = CRM_Utils_Date::processDate(date('Y-m-d H:i:s'));
 444   }
 445
 446   return NULL;
 447 }
 448
 449 /**
 450  * Get parameters for activity list.
 451  *
 452  * @see _civicrm_api3_generic_getlist_params
 453  *
 454  * @param array $request
 455  *   API request.
 456  */
 457 function _civicrm_api3_activity_getlist_params(&$request) {
 458   $fieldsToReturn = array(
 459     'activity_date_time',
 460     'activity_type_id',
 461     'subject',
 462     'source_contact_id',
 463   );
 464   $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra']));
 465   $request['params']['options']['sort'] = 'activity_date_time DESC';
 466   $request['params'] += array(
 467     'is_current_revision' => 1,
 468     'is_deleted' => 0,
 469   );
 470 }
 471
 472 /**
 473  * Get output for activity list.
 474  *
 475  * @see _civicrm_api3_generic_getlist_output
 476  *
 477  * @param array $result
 478  * @param array $request
 479  *
 480  * @return array
 481  */
 482 function _civicrm_api3_activity_getlist_output($result, $request) {
 483   $output = array();
 484   if (!empty($result['values'])) {
 485     foreach ($result['values'] as $row) {
 486       $data = array(
 487         'id' => $row[$request['id_field']],
 488         'label' => $row[$request['label_field']] ? $row[$request['label_field']] : ts('(no subject)'),
 489         'description' => array(
 490           CRM_Core_Pseudoconstant::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $row['activity_type_id']),
 491         ),
 492       );
 493       if (!empty($row['activity_date_time'])) {
 494         $data['description'][0] .= ': ' . CRM_Utils_Date::customFormat($row['activity_date_time']);
 495       }
 496       if (!empty($row['source_contact_id'])) {
 497         $data['description'][] = ts('By %1', array(
 498           1 => CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $row['source_contact_id'], 'display_name'),
 499         ));
 500       }
 501       // Add repeating info
 502       $repeat = CRM_Core_BAO_RecurringEntity::getPositionAndCount($row['id'], 'civicrm_activity');
 503       $data['extra']['is_recur'] = FALSE;
 504       if ($repeat) {
 505         $data['suffix'] = ts('(%1 of %2)', array(1 => $repeat[0], 2 => $repeat[1]));
 506         $data['extra']['is_recur'] = TRUE;
 507       }
 508       $output[] = $data;
 509     }
 510   }
 511   return $output;
 512 }