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