3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * This class create activities for a case
40 class CRM_Case_Form_Activity
extends CRM_Activity_Form_Activity
{
43 * The default variable defined
50 * The default case type variable defined
57 * The default values of an activity
61 public $_defaults = array();
64 * The array of releted contact info
68 public $_relatedContacts;
71 * Function to build the form
76 function preProcess() {
77 $this->_caseId
= CRM_Utils_Request
::retrieve('caseid', 'Positive', $this);
78 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
79 if (!$this->_context
) {
80 $this->_context
= 'caseActivity';
82 $this->_crmDir
= 'Case';
83 $this->assign('context', $this->_context
);
85 $result = parent
::preProcess();
87 $scheduleStatusId = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
88 $this->assign('scheduleStatusId', $scheduleStatusId);
94 if (!$this->_caseId
&& $this->_activityId
) {
95 $this->_caseId
= CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseActivity', $this->_activityId
,
96 'case_id', 'activity_id'
100 $this->assign('caseId', $this->_caseId
);
103 if (!$this->_caseId ||
104 (!$this->_activityId
&& !$this->_activityTypeId
)
106 CRM_Core_Error
::fatal('required params missing.');
109 //check for case activity access.
110 if (!CRM_Case_BAO_Case
::accessCiviCase()) {
111 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
114 if ($this->_caseId
&&
115 !CRM_Core_Permission
::check('access all cases and activities')
117 $session = CRM_Core_Session
::singleton();
118 $allCases = CRM_Case_BAO_Case
::getCases(TRUE, $session->get('userID'), 'any');
119 if (!array_key_exists($this->_caseId
, $allCases)) {
120 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
124 //validate case activity id.
125 if ($this->_activityId
&&
126 ($this->_action
& CRM_Core_Action
::UPDATE
)
128 $valid = CRM_Case_BAO_Case
::checkPermission($this->_activityId
, 'edit',
129 $this->_activityTypeId
132 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
136 $this->_caseType
= CRM_Case_BAO_Case
::getCaseType($this->_caseId
, 'name');
137 $this->assign('caseType', $this->_caseType
);
139 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
140 $isMultiClient = $xmlProcessorProcess->getAllowMultipleCaseClients();
141 $this->assign('multiClient', $isMultiClient);
143 $clients = CRM_Case_BAO_Case
::getContactNames($this->_caseId
);
144 $this->assign('client_names', $clients);
146 // set context for pushUserContext and for statusBounce
147 if ($this->_context
== 'fulltext') {
148 if ($this->_action
== CRM_Core_Action
::UPDATE ||
$this->_action
== CRM_Core_Action
::DELETE
) {
149 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
150 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$this->_caseId}&show=1&context={$this->_context}"
154 $url = CRM_Utils_System
::url('civicrm/contact/search/custom', 'force=1');
158 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
159 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$this->_caseId}&show=1"
162 if (!$this->_activityId
) {
163 $caseTypes = CRM_Case_PseudoConstant
::caseType();
165 if (empty($caseTypes) && ($this->_activityTypeName
== 'Change Case Type') && !$this->_caseId
) {
166 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
167 "reset=1&action=view&cid={$this->_currentlyViewedContactId}&id={$this->_caseId}&show=1"
169 $session = CRM_Core_Session
::singleton();
170 $session->pushUserContext($url);
171 CRM_Core_Error
::statusBounce(ts("You do not have any active Case Types"));
174 // check if activity count is within the limit
175 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
176 $activityInst = $xmlProcessor->getMaxInstance($this->_caseType
);
178 // If not bounce back and also provide activity edit link
179 if (isset($activityInst[$this->_activityTypeName
])) {
180 $activityCount = CRM_Case_BAO_Case
::getCaseActivityCount($this->_caseId
, $this->_activityTypeId
);
181 if ($activityCount >= $activityInst[$this->_activityTypeName
]) {
182 if ($activityInst[$this->_activityTypeName
] == 1) {
183 $atArray = array('activity_type_id' => $this->_activityTypeId
);
184 $activities = CRM_Case_BAO_Case
::getCaseActivity($this->_caseId
,
186 $this->_currentUserId
188 $activities = array_keys($activities);
189 $activities = $activities[0];
190 $editUrl = CRM_Utils_System
::url('civicrm/case/activity',
191 "reset=1&cid={$this->_currentlyViewedContactId}&caseid={$this->_caseId}&action=update&id={$activities}"
194 CRM_Core_Error
::statusBounce(ts("You can not add another '%1' activity to this case. %2",
196 1 => $this->_activityTypeName
,
197 2 => "Do you want to <a href='$editUrl'>edit the existing activity</a> ?"
206 $session = CRM_Core_Session
::singleton();
207 $session->pushUserContext($url);
211 * This function sets the default values for the form. For edit/view mode
212 * the default values are retrieved from the database
218 function setDefaultValues() {
219 $this->_defaults
= parent
::setDefaultValues();
220 $targetContactValues = array();
223 $clients = CRM_Case_BAO_Case
::getContactNames($this->_caseId
);
224 if (isset($this->_activityId
) && empty($_POST)) {
225 if (!CRM_Utils_Array
::crmIsEmptyArray($this->_defaults
['target_contact'])) {
226 $targetContactValues = array_combine(array_unique($this->_defaults
['target_contact']),
227 explode(';', trim($this->_defaults
['target_contact_value']))
230 //exclude all clients.
231 foreach ($clients as $clientId => $vals) {
232 if (array_key_exists($clientId, $targetContactValues)) {
233 unset($targetContactValues[$clientId]);
238 $this->assign('targetContactValues', empty($targetContactValues) ?
FALSE : $targetContactValues);
240 //return form for ajax
241 if ($this->_cdType
) {
242 return $this->_defaults
;
245 if (isset($this->_encounterMedium
)) {
246 $this->_defaults
['medium_id'] = $this->_encounterMedium
;
248 elseif (empty($this->_defaults
['medium_id'])) {
249 // set default encounter medium CRM-4816
250 $medium = CRM_Core_OptionGroup
::values('encounter_medium', FALSE, FALSE, FALSE, 'AND is_default = 1');
251 if (count($medium) == 1) {
252 $this->_defaults
['medium_id'] = key($medium);
256 return $this->_defaults
;
259 public function buildQuickForm() {
260 $this->_fields
['source_contact_id']['label'] = ts('Reported By');
261 unset($this->_fields
['status_id']['attributes']['required']);
263 if ($this->_caseType
) {
264 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
265 $aTypes = $xmlProcessor->get($this->_caseType
, 'ActivityTypes', TRUE);
267 // remove Open Case activity type since we're inside an existing case
268 $openCaseID = CRM_Core_OptionGroup
::getValue('activity_type', 'Open Case', 'name');
269 unset($aTypes[$openCaseID]);
271 $this->_fields
['followup_activity_type_id']['attributes'] = array(
272 '' => '- select activity type -'
276 $result = parent
::buildQuickForm();
278 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::DETACH | CRM_Core_Action
::RENEW
)) {
282 if ($this->_cdType
) {
286 $this->assign('urlPath', 'civicrm/case/activity');
288 $encounterMediums = CRM_Case_PseudoConstant
::encounterMedium();
289 // Fixme: what's the justification for this? It seems like it is just re-adding an option in case it is the default and disabled.
290 // Is that really a big problem?
291 if ($this->_activityTypeFile
== 'OpenCase') {
292 $this->_encounterMedium
= CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $this->_activityId
,
295 if (!array_key_exists($this->_encounterMedium
, $encounterMediums)) {
296 $encounterMediums[$this->_encounterMedium
] = CRM_Core_OptionGroup
::getLabel('encounter_medium',
297 $this->_encounterMedium
,
303 $this->add('select', 'medium_id', ts('Medium'), $encounterMediums, TRUE);
305 $this->_relatedContacts
= CRM_Case_BAO_Case
::getRelatedAndGlobalContacts($this->_caseId
);
306 //add case client in send a copy selector.CRM-4438.
307 $relatedContacts = CRM_Case_BAO_Case
::getContactNames($this->_caseId
);
308 if (!empty($relatedContacts)) {
309 foreach ($relatedContacts as $relatedContact) {
310 $this->_relatedContacts
[] = $relatedContact;
314 if (!empty($this->_relatedContacts
)) {
315 $checkBoxes = array();
316 foreach ($this->_relatedContacts
as $id => $row) {
317 $checkBoxes[$id] = $this->addElement('checkbox', $id, NULL, '');
320 $this->addGroup($checkBoxes, 'contact_check');
321 $this->addElement('checkbox', 'toggleSelect', NULL, NULL,
322 array('class' => 'select-rows')
324 $this->assign('searchRows', $this->_relatedContacts
);
327 $this->addFormRule(array('CRM_Case_Form_Activity', 'formRule'), $this);
333 * @param array $fields the input form values
334 * @param array $files the uploaded files if any
335 * @param array $options additional user data
337 * @return true if no errors, else array of errors
341 static function formRule($fields, $files, $self) {
342 // skip form rule if deleting
343 if (CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Delete' || CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Restore') {
347 return parent
::formrule($fields, $files, $self);
351 * Function to process the form
357 public function postProcess($params = NULL) {
358 $transaction = new CRM_Core_Transaction();
360 if ($this->_action
& CRM_Core_Action
::DELETE
) {
363 //block deleting activities which affects
364 //case attributes.CRM-4543
365 $activityCondition = " AND v.name IN ('Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date')";
366 $caseAttributeActivities = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, $activityCondition);
368 if (!array_key_exists($this->_activityTypeId
, $caseAttributeActivities)) {
369 $params = array('id' => $this->_activityId
);
370 $activityDelete = CRM_Activity_BAO_Activity
::deleteActivity($params, TRUE);
371 if ($activityDelete) {
372 $statusMsg = ts('The selected activity has been moved to the Trash. You can view and / or restore deleted activities by checking "Deleted Activities" from the Case Activities search filter (under Manage Case).<br />');
376 $statusMsg = ts("Selected Activity cannot be deleted.");
380 'entity_table' => 'civicrm_activity',
381 'entity_id' => $this->_activityId
383 CRM_Core_BAO_EntityTag
::del($tagParams);
385 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
389 if ($this->_action
& CRM_Core_Action
::RENEW
) {
391 $params = array('id' => $this->_activityId
);
392 $activityRestore = CRM_Activity_BAO_Activity
::restoreActivity($params);
393 if ($activityRestore) {
394 $statusMsg = ts('The selected activity has been restored.<br />');
396 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
400 // store the submitted values in an array
401 $params = $this->controller
->exportValues($this->_name
);
403 //set parent id if its edit mode
404 if ($parentId = CRM_Utils_Array
::value('parent_id', $this->_defaults
)) {
405 $params['parent_id'] = $parentId;
408 // required for status msg
409 $recordStatus = 'created';
411 // store the dates with proper format
412 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
413 $params['activity_type_id'] = $this->_activityTypeId
;
415 // format with contact (target contact) values
416 if (isset($params['contact'][1])) {
417 $params['target_contact_id'] = explode(',', $params['contact'][1]);
420 $params['target_contact_id'] = array();
423 // format activity custom data
424 if (!empty($params['hidden_custom'])) {
425 if ($this->_activityId
) {
426 // unset custom fields-id from params since we want custom
427 // fields to be saved for new activity.
428 foreach ($params as $key => $value) {
430 if (preg_match('/^(custom_\d+_)(\d+)$/', $key, $match)) {
431 $params[$match[1] . '-1'] = $params[$key];
433 // for autocomplete transfer hidden value instead of label
434 if ($params[$key] && isset($params[$key . '_id'])) {
435 $params[$match[1] . '-1_id'] = $params[$key . '_id'];
436 unset($params[$key . '_id']);
438 unset($params[$key]);
443 // build custom data getFields array
444 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE, $this->_activityTypeId
);
445 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
446 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
450 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
457 // assigning formatted value
458 if (!empty($params['assignee_contact_id'])) {
459 $params['assignee_contact_id'] = explode(',', $params['assignee_contact_id']);
462 $params['assignee_contact_id'] = array();
466 if (isset($this->_activityId
)) {
467 // activity which hasn't been modified by a user yet
468 if ($this->_defaults
['is_auto'] == 1) {
469 $params['is_auto'] = 0;
472 // always create a revision of an case activity. CRM-4533
473 $newActParams = $params;
475 // add target contact values in update mode
476 if (empty($params['target_contact_id']) && !empty($this->_defaults
['target_contact'])) {
477 $newActParams['target_contact_id'] = $this->_defaults
['target_contact'];
480 // record status for status msg
481 $recordStatus = 'updated';
484 if (!isset($newActParams)) {
485 // add more attachments if needed for old activity
486 CRM_Core_BAO_File
::formatAttachment($params,
491 // call begin post process, before the activity is created/updated.
492 $this->beginPostProcess($params);
493 $params['case_id'] = $this->_caseId
;
494 // activity create/update
495 $activity = CRM_Activity_BAO_Activity
::create($params);
497 // call end post process, after the activity has been created/updated.
498 $this->endPostProcess($params, $activity);
501 // since the params we need to set are very few, and we don't want rest of the
502 // work done by bao create method , lets use dao object to make the changes
503 $params = array('id' => $this->_activityId
);
504 $params['is_current_revision'] = 0;
505 $activity = new CRM_Activity_DAO_Activity();
506 $activity->copyValues($params);
510 // create a new version of activity if activity was found to
511 // have been modified/created by user
512 if (isset($newActParams)) {
513 // set proper original_id
514 if (!empty($this->_defaults
['original_id'])) {
515 $newActParams['original_id'] = $this->_defaults
['original_id'];
518 $newActParams['original_id'] = $activity->id
;
520 //is_current_revision will be set to 1 by default.
522 // add attachments if any
523 CRM_Core_BAO_File
::formatAttachment($newActParams,
528 // call begin post process, before the activity is created/updated.
529 $this->beginPostProcess($newActParams);
530 $newActParams['case_id'] = $this->_caseId
;
532 $activity = CRM_Activity_BAO_Activity
::create($newActParams);
534 // call end post process, after the activity has been created/updated.
535 $this->endPostProcess($newActParams, $activity);
537 // copy files attached to old activity if any, to new one,
538 // as long as users have not selected the 'delete attachment' option.
539 if (empty($newActParams['is_delete_attachment'])) {
540 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $this->_activityId
,
541 'civicrm_activity', $activity->id
545 // copy back params to original var
546 $params = $newActParams;
550 // add tags if exists
551 $tagParams = array();
552 if (!empty($params['tag'])) {
553 foreach ($params['tag'] as $tag) {
554 $tagParams[$tag] = 1;
559 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_activity', $activity->id
);
562 if (isset($params['taglist']) && !empty($params['taglist'])) {
563 CRM_Core_Form_Tag
::postProcess($params['taglist'], $activity->id
, 'civicrm_activity', $this);
567 // update existing case record if needed
568 $caseParams = $params;
569 $caseParams['id'] = $this->_caseId
;
571 if (!empty($caseParams['case_type_id'])) {
572 $caseParams['case_type_id'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $caseParams['case_type_id'] . CRM_Core_DAO
::VALUE_SEPARATOR
;
574 if (!empty($caseParams['case_status_id'])) {
575 $caseParams['status_id'] = $caseParams['case_status_id'];
578 // unset params intended for activities only
579 unset($caseParams['subject'], $caseParams['details'],
580 $caseParams['status_id'], $caseParams['custom']
582 $case = CRM_Case_BAO_Case
::create($caseParams);
584 // create case activity record
586 'activity_id' => $activity->id
,
587 'case_id' => $this->_caseId
,
589 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
591 // Insert civicrm_log record for the activity (e.g. store the
592 // created / edited by contact id and date for the activity)
593 // Note - civicrm_log is already created by CRM_Activity_BAO_Activity::create()
595 // send copy to selected contacts.
597 $mailToContacts = array();
600 //check for notification settings for assignee contacts
601 $selectedContacts = array('contact_check');
602 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
603 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
604 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
605 'activity_assignee_notification'
608 $selectedContacts[] = 'assignee_contact_id';
611 foreach ($selectedContacts as $dnt => $val) {
612 if (array_key_exists($val, $params) && !CRM_Utils_array
::crmIsEmptyArray($params[$val])) {
613 if ($val == 'contact_check') {
614 $mailStatus = ts("A copy of the activity has also been sent to selected contacts(s).");
617 $this->_relatedContacts
= CRM_Activity_BAO_ActivityAssignment
::getAssigneeNames(array($activity->id
), TRUE, FALSE);
618 $mailStatus .= ' ' . ts("A copy of the activity has also been sent to assignee contacts(s).");
621 //build an associative array with unique email addresses.
622 foreach ($params[$val] as $key => $value) {
623 if ($val == 'contact_check') {
630 if (isset($id) && array_key_exists($id, $this->_relatedContacts
)) {
631 //if email already exists in array then append with ', ' another role only otherwise add it to array.
632 if ($contactDetails = CRM_Utils_Array
::value($this->_relatedContacts
[$id]['email'], $mailToContacts)) {
633 $caseRole = CRM_Utils_Array
::value('role', $this->_relatedContacts
[$id]);
634 $mailToContacts[$this->_relatedContacts
[$id]['email']]['role'] = $contactDetails['role'] . ', ' . $caseRole;
637 $mailToContacts[$this->_relatedContacts
[$id]['email']] = $this->_relatedContacts
[$id];
644 if (!CRM_Utils_array
::crmIsEmptyArray($mailToContacts)) {
645 //include attachments while sending a copy of activity.
646 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
650 $ics = new CRM_Activity_BAO_ICalendar($activity);
651 $ics->addAttachment($attachments, $mailToContacts);
653 $result = CRM_Case_BAO_Case
::sendActivityCopy($this->_currentlyViewedContactId
,
654 $activity->id
, $mailToContacts, $attachments, $this->_caseId
659 if (empty($result)) {
667 // create follow up activity if needed
668 $followupStatus = '';
669 if (!empty($params['followup_activity_type_id'])) {
670 $followupActivity = CRM_Activity_BAO_Activity
::createFollowupActivity($activity->id
, $params);
672 if ($followupActivity) {
674 'activity_id' => $followupActivity->id
,
675 'case_id' => $this->_caseId
,
677 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
678 $followupStatus = ts("A followup activity has been scheduled.");
682 CRM_Core_Session
::setStatus('', ts("'%1' activity has been %2. %3 %4",
684 1 => $this->_activityTypeName
,
686 3 => $followupStatus,