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 if ($this->_currentlyViewedContactId
) {
207 CRM_Contact_Page_View
::setTitle($this->_currentlyViewedContactId
);
210 $session = CRM_Core_Session
::singleton();
211 $session->pushUserContext($url);
215 * This function sets the default values for the form. For edit/view mode
216 * the default values are retrieved from the database
222 function setDefaultValues() {
223 $this->_defaults
= parent
::setDefaultValues();
224 $targetContactValues = array();
227 $clients = CRM_Case_BAO_Case
::getContactNames($this->_caseId
);
228 if (isset($this->_activityId
) && empty($_POST)) {
229 if (!CRM_Utils_Array
::crmIsEmptyArray($this->_defaults
['target_contact'])) {
230 $targetContactValues = array_combine(array_unique($this->_defaults
['target_contact']),
231 explode(';', trim($this->_defaults
['target_contact_value']))
234 //exclude all clients.
235 foreach ($clients as $clientId => $vals) {
236 if (array_key_exists($clientId, $targetContactValues)) {
237 unset($targetContactValues[$clientId]);
242 $this->assign('targetContactValues', empty($targetContactValues) ?
FALSE : $targetContactValues);
244 //return form for ajax
245 if ($this->_cdType
) {
246 return $this->_defaults
;
249 if (isset($this->_encounterMedium
)) {
250 $this->_defaults
['medium_id'] = $this->_encounterMedium
;
252 elseif (empty($this->_defaults
['medium_id'])) {
253 // set default encounter medium CRM-4816
254 $medium = CRM_Core_OptionGroup
::values('encounter_medium', FALSE, FALSE, FALSE, 'AND is_default = 1');
255 if (count($medium) == 1) {
256 $this->_defaults
['medium_id'] = key($medium);
260 return $this->_defaults
;
263 public function buildQuickForm() {
264 $this->_fields
['source_contact_id']['label'] = ts('Reported By');
265 unset($this->_fields
['status_id']['attributes']['required']);
267 if ($this->_caseType
) {
268 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
269 $aTypes = $xmlProcessor->get($this->_caseType
, 'ActivityTypes', TRUE);
271 // remove Open Case activity type since we're inside an existing case
272 $openCaseID = CRM_Core_OptionGroup
::getValue('activity_type', 'Open Case', 'name');
273 unset($aTypes[$openCaseID]);
275 $this->_fields
['followup_activity_type_id']['attributes'] = array(
276 '' => '- select activity type -'
280 $result = parent
::buildQuickForm();
282 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::DETACH | CRM_Core_Action
::RENEW
)) {
286 if ($this->_cdType
) {
290 $this->assign('urlPath', 'civicrm/case/activity');
292 $encounterMediums = CRM_Case_PseudoConstant
::encounterMedium();
293 // 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.
294 // Is that really a big problem?
295 if ($this->_activityTypeFile
== 'OpenCase') {
296 $this->_encounterMedium
= CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $this->_activityId
,
299 if (!array_key_exists($this->_encounterMedium
, $encounterMediums)) {
300 $encounterMediums[$this->_encounterMedium
] = CRM_Core_OptionGroup
::getLabel('encounter_medium',
301 $this->_encounterMedium
,
307 $this->add('select', 'medium_id', ts('Medium'), $encounterMediums, TRUE);
309 $this->_relatedContacts
= CRM_Case_BAO_Case
::getRelatedAndGlobalContacts($this->_caseId
);
310 //add case client in send a copy selector.CRM-4438.
311 $relatedContacts = CRM_Case_BAO_Case
::getContactNames($this->_caseId
);
312 if (!empty($relatedContacts)) {
313 foreach ($relatedContacts as $relatedContact) {
314 $this->_relatedContacts
[] = $relatedContact;
318 if (!empty($this->_relatedContacts
)) {
319 $checkBoxes = array();
320 foreach ($this->_relatedContacts
as $id => $row) {
321 $checkBoxes[$id] = $this->addElement('checkbox', $id, NULL, '');
324 $this->addGroup($checkBoxes, 'contact_check');
325 $this->addElement('checkbox', 'toggleSelect', NULL, NULL,
326 array('class' => 'select-rows')
328 $this->assign('searchRows', $this->_relatedContacts
);
331 $this->addFormRule(array('CRM_Case_Form_Activity', 'formRule'), $this);
337 * @param array $fields the input form values
338 * @param array $files the uploaded files if any
339 * @param array $options additional user data
341 * @return true if no errors, else array of errors
345 static function formRule($fields, $files, $self) {
346 // skip form rule if deleting
347 if (CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Delete' || CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Restore') {
351 return parent
::formrule($fields, $files, $self);
355 * Function to process the form
361 public function postProcess($params = NULL) {
362 $transaction = new CRM_Core_Transaction();
364 if ($this->_action
& CRM_Core_Action
::DELETE
) {
367 //block deleting activities which affects
368 //case attributes.CRM-4543
369 $activityCondition = " AND v.name IN ('Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date')";
370 $caseAttributeActivities = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, $activityCondition);
372 if (!array_key_exists($this->_activityTypeId
, $caseAttributeActivities)) {
373 $params = array('id' => $this->_activityId
);
374 $activityDelete = CRM_Activity_BAO_Activity
::deleteActivity($params, TRUE);
375 if ($activityDelete) {
376 $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 />');
380 $statusMsg = ts("Selected Activity cannot be deleted.");
384 'entity_table' => 'civicrm_activity',
385 'entity_id' => $this->_activityId
387 CRM_Core_BAO_EntityTag
::del($tagParams);
389 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
393 if ($this->_action
& CRM_Core_Action
::RENEW
) {
395 $params = array('id' => $this->_activityId
);
396 $activityRestore = CRM_Activity_BAO_Activity
::restoreActivity($params);
397 if ($activityRestore) {
398 $statusMsg = ts('The selected activity has been restored.<br />');
400 CRM_Core_Session
::setStatus('', $statusMsg, 'info');
404 // store the submitted values in an array
405 $params = $this->controller
->exportValues($this->_name
);
407 //set parent id if its edit mode
408 if ($parentId = CRM_Utils_Array
::value('parent_id', $this->_defaults
)) {
409 $params['parent_id'] = $parentId;
412 // required for status msg
413 $recordStatus = 'created';
415 // store the dates with proper format
416 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
417 $params['activity_type_id'] = $this->_activityTypeId
;
419 // format with contact (target contact) values
420 if (isset($params['contact'][1])) {
421 $params['target_contact_id'] = explode(',', $params['contact'][1]);
424 $params['target_contact_id'] = array();
427 // format activity custom data
428 if (!empty($params['hidden_custom'])) {
429 if ($this->_activityId
) {
430 // unset custom fields-id from params since we want custom
431 // fields to be saved for new activity.
432 foreach ($params as $key => $value) {
434 if (preg_match('/^(custom_\d+_)(\d+)$/', $key, $match)) {
435 $params[$match[1] . '-1'] = $params[$key];
437 // for autocomplete transfer hidden value instead of label
438 if ($params[$key] && isset($params[$key . '_id'])) {
439 $params[$match[1] . '-1_id'] = $params[$key . '_id'];
440 unset($params[$key . '_id']);
442 unset($params[$key]);
447 // build custom data getFields array
448 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE, $this->_activityTypeId
);
449 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
450 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
454 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
461 // assigning formatted value
462 if (!empty($params['assignee_contact_id'])) {
463 $params['assignee_contact_id'] = explode(',', $params['assignee_contact_id']);
466 $params['assignee_contact_id'] = array();
470 if (isset($this->_activityId
)) {
471 // activity which hasn't been modified by a user yet
472 if ($this->_defaults
['is_auto'] == 1) {
473 $params['is_auto'] = 0;
476 // always create a revision of an case activity. CRM-4533
477 $newActParams = $params;
479 // add target contact values in update mode
480 if (empty($params['target_contact_id']) && !empty($this->_defaults
['target_contact'])) {
481 $newActParams['target_contact_id'] = $this->_defaults
['target_contact'];
484 // record status for status msg
485 $recordStatus = 'updated';
488 if (!isset($newActParams)) {
489 // add more attachments if needed for old activity
490 CRM_Core_BAO_File
::formatAttachment($params,
495 // call begin post process, before the activity is created/updated.
496 $this->beginPostProcess($params);
497 $params['case_id'] = $this->_caseId
;
498 // activity create/update
499 $activity = CRM_Activity_BAO_Activity
::create($params);
501 // call end post process, after the activity has been created/updated.
502 $this->endPostProcess($params, $activity);
505 // since the params we need to set are very few, and we don't want rest of the
506 // work done by bao create method , lets use dao object to make the changes
507 $params = array('id' => $this->_activityId
);
508 $params['is_current_revision'] = 0;
509 $activity = new CRM_Activity_DAO_Activity();
510 $activity->copyValues($params);
514 // create a new version of activity if activity was found to
515 // have been modified/created by user
516 if (isset($newActParams)) {
517 // set proper original_id
518 if (!empty($this->_defaults
['original_id'])) {
519 $newActParams['original_id'] = $this->_defaults
['original_id'];
522 $newActParams['original_id'] = $activity->id
;
524 //is_current_revision will be set to 1 by default.
526 // add attachments if any
527 CRM_Core_BAO_File
::formatAttachment($newActParams,
532 // call begin post process, before the activity is created/updated.
533 $this->beginPostProcess($newActParams);
534 $newActParams['case_id'] = $this->_caseId
;
536 $activity = CRM_Activity_BAO_Activity
::create($newActParams);
538 // call end post process, after the activity has been created/updated.
539 $this->endPostProcess($newActParams, $activity);
541 // copy files attached to old activity if any, to new one,
542 // as long as users have not selected the 'delete attachment' option.
543 if (empty($newActParams['is_delete_attachment'])) {
544 CRM_Core_BAO_File
::copyEntityFile('civicrm_activity', $this->_activityId
,
545 'civicrm_activity', $activity->id
549 // copy back params to original var
550 $params = $newActParams;
554 // add tags if exists
555 $tagParams = array();
556 if (!empty($params['tag'])) {
557 foreach ($params['tag'] as $tag) {
558 $tagParams[$tag] = 1;
563 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_activity', $activity->id
);
566 if (isset($params['taglist']) && !empty($params['taglist'])) {
567 CRM_Core_Form_Tag
::postProcess($params['taglist'], $activity->id
, 'civicrm_activity', $this);
571 // update existing case record if needed
572 $caseParams = $params;
573 $caseParams['id'] = $this->_caseId
;
575 if (!empty($caseParams['case_type_id'])) {
576 $caseParams['case_type_id'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $caseParams['case_type_id'] . CRM_Core_DAO
::VALUE_SEPARATOR
;
578 if (!empty($caseParams['case_status_id'])) {
579 $caseParams['status_id'] = $caseParams['case_status_id'];
582 // unset params intended for activities only
583 unset($caseParams['subject'], $caseParams['details'],
584 $caseParams['status_id'], $caseParams['custom']
586 $case = CRM_Case_BAO_Case
::create($caseParams);
588 // create case activity record
590 'activity_id' => $activity->id
,
591 'case_id' => $this->_caseId
,
593 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
595 // Insert civicrm_log record for the activity (e.g. store the
596 // created / edited by contact id and date for the activity)
597 // Note - civicrm_log is already created by CRM_Activity_BAO_Activity::create()
599 // send copy to selected contacts.
601 $mailToContacts = array();
604 //check for notification settings for assignee contacts
605 $selectedContacts = array('contact_check');
606 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
607 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
608 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
609 'activity_assignee_notification'
612 $selectedContacts[] = 'assignee_contact_id';
615 foreach ($selectedContacts as $dnt => $val) {
616 if (array_key_exists($val, $params) && !CRM_Utils_array
::crmIsEmptyArray($params[$val])) {
617 if ($val == 'contact_check') {
618 $mailStatus = ts("A copy of the activity has also been sent to selected contacts(s).");
621 $this->_relatedContacts
= CRM_Activity_BAO_ActivityAssignment
::getAssigneeNames(array($activity->id
), TRUE, FALSE);
622 $mailStatus .= ' ' . ts("A copy of the activity has also been sent to assignee contacts(s).");
625 //build an associative array with unique email addresses.
626 foreach ($params[$val] as $key => $value) {
627 if ($val == 'contact_check') {
634 if (isset($id) && array_key_exists($id, $this->_relatedContacts
)) {
635 //if email already exists in array then append with ', ' another role only otherwise add it to array.
636 if ($contactDetails = CRM_Utils_Array
::value($this->_relatedContacts
[$id]['email'], $mailToContacts)) {
637 $caseRole = CRM_Utils_Array
::value('role', $this->_relatedContacts
[$id]);
638 $mailToContacts[$this->_relatedContacts
[$id]['email']]['role'] = $contactDetails['role'] . ', ' . $caseRole;
641 $mailToContacts[$this->_relatedContacts
[$id]['email']] = $this->_relatedContacts
[$id];
648 if (!CRM_Utils_array
::crmIsEmptyArray($mailToContacts)) {
649 //include attachments while sending a copy of activity.
650 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity',
654 $ics = new CRM_Activity_BAO_ICalendar($activity);
655 $ics->addAttachment($attachments, $mailToContacts);
657 $result = CRM_Case_BAO_Case
::sendActivityCopy($this->_currentlyViewedContactId
,
658 $activity->id
, $mailToContacts, $attachments, $this->_caseId
663 if (empty($result)) {
671 // create follow up activity if needed
672 $followupStatus = '';
673 if (!empty($params['followup_activity_type_id'])) {
674 $followupActivity = CRM_Activity_BAO_Activity
::createFollowupActivity($activity->id
, $params);
676 if ($followupActivity) {
678 'activity_id' => $followupActivity->id
,
679 'case_id' => $this->_caseId
,
681 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
682 $followupStatus = ts("A followup activity has been scheduled.");
686 CRM_Core_Session
::setStatus('', ts("'%1' activity has been %2. %3 %4",
688 1 => $this->_activityTypeName
,
690 3 => $followupStatus,