3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
33 class CRM_Case_XMLProcessor_Report
extends CRM_Case_XMLProcessor
{
36 * The default variable defined.
44 public function __construct() {
48 * @param int $clientID
50 * @param string $activitySetName
51 * @param array $params
55 public function run($clientID, $caseID, $activitySetName, $params) {
56 $contents = self
::getCaseReport($clientID,
63 return CRM_Case_Audit_Audit
::run($contents, $clientID, $caseID);
66 public function getRedactionRules() {
68 'redactionStringRules',
69 'redactionRegexRules',
71 $
$rule = CRM_Case_PseudoConstant
::redactionRule($key);
74 foreach ($
$rule as & $val) {
75 //suffixed with a randomly generated 4-digit number
76 if ($key == 'redactionStringRules') {
77 $val .= rand(10000, 100000);
81 if (!empty($this->{'_' . $rule})) {
82 $this->{'_' . $rule} = CRM_Utils_Array
::crmArrayMerge($this->{'_' . $rule}, $
$rule);
85 $this->{'_' . $rule} = $
$rule;
92 * @param int $clientID
97 public function &caseInfo(
101 $case = $this->_redactionRegexRules
= array();
103 if (empty($this->_redactionStringRules
)) {
104 $this->_redactionStringRules
= array();
107 if ($this->_isRedact
== 1) {
108 $this->getRedactionRules();
111 $client = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $clientID, 'display_name');
113 // add Client to the strings to be redacted across the case session
114 if (!array_key_exists($client, $this->_redactionStringRules
)) {
115 $this->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($this->_redactionStringRules
,
116 array($client => 'name_' . rand(10000, 100000))
118 $clientSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $clientID, 'sort_name');
119 if (!array_key_exists($clientSortName, $this->_redactionStringRules
)) {
120 $this->_redactionStringRules
[$clientSortName] = $this->_redactionStringRules
[$client];
124 $case['clientName'] = $this->redact($client);
126 $dao = new CRM_Case_DAO_Case();
128 if ($dao->find(TRUE)) {
129 $case['subject'] = $dao->subject
;
130 $case['start_date'] = $dao->start_date
;
131 $case['end_date'] = $dao->end_date
;
132 // FIXME: when we resolve if case_type_is single or multi-select
133 if (strpos($dao->case_type_id
, CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
134 $caseTypeID = substr($dao->case_type_id
, 1, -1);
137 $caseTypeID = $dao->case_type_id
;
139 $caseTypeIDs = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
143 $case['caseType'] = CRM_Case_BAO_Case
::getCaseType($caseID);
144 $case['caseTypeName'] = CRM_Case_BAO_Case
::getCaseType($caseID, 'name');
145 $case['status'] = CRM_Core_OptionGroup
::getLabel('case_status', $dao->status_id
, FALSE);
152 * @param string $activitySetName
156 public function getActivityTypes($xml, $activitySetName) {
157 foreach ($xml->ActivitySets
as $activitySetsXML) {
158 foreach ($activitySetsXML->ActivitySet
as $activitySetXML) {
159 if ((string ) $activitySetXML->name
== $activitySetName) {
160 $activityTypes = array();
161 $allActivityTypes = &$this->allActivityTypes();
162 foreach ($activitySetXML->ActivityTypes
as $activityTypesXML) {
163 foreach ($activityTypesXML as $activityTypeXML) {
164 $activityTypeName = (string ) $activityTypeXML->name
;
165 $activityTypeInfo = CRM_Utils_Array
::value($activityTypeName, $allActivityTypes);
166 if ($activityTypeInfo) {
167 $activityTypes[$activityTypeInfo['id']] = $activityTypeInfo;
171 return empty($activityTypes) ?
FALSE : $activityTypes;
180 * @param string $activitySetName
182 * @return null|string
184 public function getActivitySetLabel($xml, $activitySetName) {
185 foreach ($xml->ActivitySets
as $activitySetsXML) {
186 foreach ($activitySetsXML->ActivitySet
as $activitySetXML) {
187 if ((string ) $activitySetXML->name
== $activitySetName) {
188 return (string ) $activitySetXML->label
;
196 * @param int $clientID
198 * @param $activityTypes
201 public function getActivities($clientID, $caseID, $activityTypes, &$activities) {
202 // get all activities for this case that in this activityTypes set
203 foreach ($activityTypes as $aType) {
204 $map[$aType['id']] = $aType;
207 // get all core activities
208 $coreActivityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
210 foreach ($coreActivityTypes as $aType) {
211 $map[$aType['id']] = $aType;
214 $activityTypeIDs = implode(',', array_keys($map));
216 SELECT a.*, c.id as caseID
217 FROM civicrm_activity a,
219 civicrm_case_activity ac
220 WHERE a.is_current_revision = 1
222 AND a.activity_type_id IN ( $activityTypeIDs )
223 AND c.id = ac.case_id
224 AND a.id = ac.activity_id
228 $params = array(1 => array($caseID, 'Integer'));
229 $dao = CRM_Core_DAO
::executeQuery($query, $params);
230 while ($dao->fetch()) {
231 $activityTypeInfo = $map[$dao->activity_type_id
];
232 $activities[] = $this->getActivity($clientID,
240 * @param int $clientID
241 * @param int $activityID
242 * @param bool $anyActivity
247 public function &getActivityInfo($clientID, $activityID, $anyActivity = FALSE, $redact = 0) {
248 static $activityInfos = array();
250 $this->_isRedact
= 1;
251 $this->getRedactionRules();
254 $index = $activityID . '_' . (int) $anyActivity;
257 $index = $index . '_' . $clientID;
260 if (!array_key_exists($index, $activityInfos)) {
261 $activityInfos[$index] = array();
262 $selectCaseActivity = "";
263 $joinCaseActivity = "";
266 $selectCaseActivity = ", ca.case_id as caseID ";
267 $joinCaseActivity = " INNER JOIN civicrm_case_activity ca ON a.id = ca.activity_id ";
270 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
271 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
272 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
275 SELECT a.*, aa.contact_id as assigneeID, at.contact_id as targetID
276 {$selectCaseActivity}
277 FROM civicrm_activity a
279 LEFT JOIN civicrm_activity_contact at ON a.id = at.activity_id AND at.record_type_id = $targetID
280 LEFT JOIN civicrm_activity_contact aa ON a.id = aa.activity_id AND aa.record_type_id = $assigneeID
283 $params = array(1 => array($activityID, 'Integer'));
284 $dao = CRM_Core_DAO
::executeQuery($query, $params);
287 //if activity type is email get info of all activities.
288 if ($dao->activity_type_id
== CRM_Core_OptionGroup
::getValue('activity_type', 'Email', 'name')) {
291 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, $anyActivity);
292 $activityTypeInfo = NULL;
294 if (isset($activityTypes[$dao->activity_type_id
])) {
295 $activityTypeInfo = $activityTypes[$dao->activity_type_id
];
297 if ($activityTypeInfo) {
298 $activityInfos[$index] = $this->getActivity($clientID, $dao, $activityTypeInfo);
303 return $activityInfos[$index];
307 * @param int $clientID
308 * @param $activityDAO
309 * @param $activityTypeInfo
313 public function &getActivity($clientID, $activityDAO, &$activityTypeInfo) {
314 if (empty($this->_redactionStringRules
)) {
315 $this->_redactionStringRules
= array();
319 $activity['fields'] = array();
321 $clientID = CRM_Utils_Type
::escape($clientID, 'Integer');
322 if (!in_array($activityTypeInfo['name'], array(
327 $activity['editURL'] = CRM_Utils_System
::url('civicrm/case/activity',
328 "reset=1&cid={$clientID}&caseid={$activityDAO->caseID}&action=update&atype={$activityDAO->activity_type_id}&id={$activityDAO->id}"
332 $activity['editURL'] = '';
335 $client = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $clientID, 'display_name');
336 // add Client SortName as well as Display to the strings to be redacted across the case session
337 // suffixed with a randomly generated 4-digit number
338 if (!array_key_exists($client, $this->_redactionStringRules
)) {
339 $this->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($this->_redactionStringRules
,
340 array($client => 'name_' . rand(10000, 100000))
343 $clientSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $clientID, 'sort_name');
344 if (!array_key_exists($clientSortName, $this->_redactionStringRules
)) {
345 $this->_redactionStringRules
[$clientSortName] = $this->_redactionStringRules
[$client];
349 $activity['fields'][] = array(
351 'value' => $this->redact($client),
356 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
357 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
358 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
359 if (!empty($activityDAO->targetID
)) {
360 // Re-lookup the target ID since the DAO only has the first recipient if there are multiple.
361 // Maybe not the best solution.
362 $targetNames = CRM_Activity_BAO_ActivityContact
::getNames($activityDAO->id
, $targetID);
363 $processTarget = FALSE;
364 $label = ts('With Contact(s)');
365 if (in_array($activityTypeInfo['name'], array('Email', 'Inbound Email'))) {
366 $processTarget = TRUE;
367 $label = ts('Recipient');
369 if (!$processTarget) {
370 foreach ($targetNames as $targetID => $targetName) {
371 if ($targetID != $clientID) {
372 $processTarget = TRUE;
378 if ($processTarget) {
379 $targetRedacted = array();
380 foreach ($targetNames as $targetID => $target) {
381 // add Recipient SortName as well as Display to the strings to be redacted across the case session
382 // suffixed with a randomly generated 4-digit number
383 if (!array_key_exists($target, $this->_redactionStringRules
)) {
384 $this->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($this->_redactionStringRules
,
385 array($target => 'name_' . rand(10000, 100000))
387 $targetSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $targetID, 'sort_name');
388 if (!array_key_exists($targetSortName, $this->_redactionStringRules
)) {
389 $this->_redactionStringRules
[$targetSortName] = $this->_redactionStringRules
[$target];
392 $targetRedacted[] = $this->redact($target);
395 $activity['fields'][] = array(
397 'value' => implode('; ', $targetRedacted),
403 // Activity Type info is a special field
404 $activity['fields'][] = array(
405 'label' => ts('Activity Type'),
406 'value' => $activityTypeInfo['label'],
410 $activity['fields'][] = array(
411 'label' => ts('Subject'),
412 'value' => htmlspecialchars($this->redact($activityDAO->subject
)),
416 $creator = $this->getCreatedBy($activityDAO->id
);
417 // add Creator to the strings to be redacted across the case session
418 if (!array_key_exists($creator, $this->_redactionStringRules
)) {
419 $this->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($this->_redactionStringRules
,
420 array($creator => 'name_' . rand(10000, 100000))
423 $activity['fields'][] = array(
424 'label' => ts('Created By'),
425 'value' => $this->redact($creator),
428 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
429 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
430 $source_contact_id = CRM_Activity_BAO_Activity
::getActivityContact($activityDAO->id
, $sourceID);
431 $reporter = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
436 // add Reporter SortName as well as Display to the strings to be redacted across the case session
437 // suffixed with a randomly generated 4-digit number
438 if (!array_key_exists($reporter, $this->_redactionStringRules
)) {
439 $this->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($this->_redactionStringRules
,
440 array($reporter => 'name_' . rand(10000, 100000))
443 $reporterSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
447 if (!array_key_exists($reporterSortName, $this->_redactionStringRules
)) {
448 $this->_redactionStringRules
[$reporterSortName] = $this->_redactionStringRules
[$reporter];
452 $activity['fields'][] = array(
453 'label' => ts('Reported By'),
454 'value' => $this->redact($reporter),
458 if (!empty($activityDAO->assigneeID
)) {
459 //allow multiple assignee contacts.CRM-4503.
460 $assignee_contact_names = CRM_Activity_BAO_ActivityAssignment
::getAssigneeNames(array($activityDAO->id
), TRUE);
462 foreach ($assignee_contact_names as & $assignee) {
463 // add Assignee to the strings to be redacted across the case session
464 $this->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($this->_redactionStringRules
,
465 array($assignee => 'name_' . rand(10000, 100000))
467 $assignee = $this->redact($assignee);
469 $assigneeContacts = implode(', ', $assignee_contact_names);
470 $activity['fields'][] = array(
471 'label' => ts('Assigned to'),
472 'value' => $assigneeContacts,
477 if ($activityDAO->medium_id
) {
478 $activity['fields'][] = array(
479 'label' => ts('Medium'),
480 'value' => CRM_Core_OptionGroup
::getLabel('encounter_medium',
481 $activityDAO->medium_id
, FALSE
487 $activity['fields'][] = array(
488 'label' => ts('Location'),
489 'value' => $activityDAO->location
,
493 $activity['fields'][] = array(
494 'label' => ts('Date and Time'),
495 'value' => $activityDAO->activity_date_time
,
499 $activity['fields'][] = array(
500 'label' => ts('Details'),
501 'value' => $this->redact(CRM_Utils_String
::stripAlternatives($activityDAO->details
)),
505 // Skip Duration field if empty (to avoid " minutes" output). Might want to do this for all fields at some point. dgg
506 if ($activityDAO->duration
) {
507 $activity['fields'][] = array(
508 'label' => ts('Duration'),
509 'value' => $activityDAO->duration
. ' ' . ts('minutes'),
513 $activity['fields'][] = array(
514 'label' => ts('Status'),
515 'value' => CRM_Core_OptionGroup
::getLabel('activity_status',
516 $activityDAO->status_id
521 $activity['fields'][] = array(
522 'label' => ts('Priority'),
523 'value' => CRM_Core_OptionGroup
::getLabel('priority',
524 $activityDAO->priority_id
529 //for now empty custom groups
530 $activity['customGroups'] = $this->getCustomData($clientID,
539 * @param int $clientID
540 * @param $activityDAO
541 * @param $activityTypeInfo
545 public function getCustomData($clientID, $activityDAO, &$activityTypeInfo) {
546 list($typeValues, $options, $sql) = $this->getActivityTypeCustomSQL($activityTypeInfo['id'], '%Y-%m-%d');
548 $params = array(1 => array($activityDAO->id
, 'Integer'));
550 $customGroups = array();
551 foreach ($sql as $tableName => $sqlClause) {
552 $dao = CRM_Core_DAO
::executeQuery($sqlClause, $params);
554 $customGroup = array();
555 foreach ($typeValues[$tableName] as $columnName => $typeValue) {
557 if (CRM_Utils_Array
::value('type', $typeValue) == 'Date') {
558 $value = $dao->$columnName;
561 $value = CRM_Core_BAO_CustomField
::displayValue($dao->$columnName, $typeValue['fieldID']);
565 // Note: this is already taken care in getDisplayValue above, but sometimes
566 // strings like '^A^A' creates problem. So to fix this special case -
567 if (strstr($value, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
568 $value = trim($value, CRM_Core_DAO
::VALUE_SEPARATOR
);
570 if (CRM_Utils_Array
::value('type', $typeValue) == 'String' ||
571 CRM_Utils_Array
::value('type', $typeValue) == 'Memo'
573 $value = $this->redact($value);
575 elseif (CRM_Utils_Array
::value('type', $typeValue) == 'File') {
576 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_EntityFile', $typeValue, 'entity_table');
577 $value = CRM_Core_BAO_File
::attachmentInfo($tableName, $activityDAO->id
);
579 elseif (CRM_Utils_Array
::value('type', $typeValue) == 'Link') {
580 $value = CRM_Utils_System
::formatWikiURL($value);
584 $customGroup[] = array(
585 'label' => $typeValue['label'],
587 'type' => $typeValue['type'],
588 'fieldID' => $typeValue['fieldID'],
591 $customGroups[$dao->groupTitle
] = $customGroup;
595 return empty($customGroups) ?
NULL : $customGroups;
599 * @param int $activityTypeID
600 * @param null $dateFormat
604 public function getActivityTypeCustomSQL($activityTypeID, $dateFormat = NULL) {
605 static $cache = array();
607 if (is_null($activityTypeID)) {
611 if (!isset($cache[$activityTypeID])) {
613 SELECT cg.title as groupTitle,
614 cg.table_name as tableName ,
615 cf.column_name as columnName,
619 cf.data_type as dataType ,
620 cf.html_type as htmlType ,
621 cf.option_group_id as optionGroupID
622 FROM civicrm_custom_group cg,
623 civicrm_custom_field cf
624 WHERE cf.custom_group_id = cg.id
625 AND cg.extends = 'Activity'
626 AND " . CRM_Core_Permission
::customGroupClause(CRM_Core_Permission
::VIEW
, 'cg.');
628 if ($activityTypeID) {
629 $query .= "AND ( cg.extends_entity_column_value IS NULL OR cg.extends_entity_column_value LIKE '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. "%1" . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' )";
632 $query .= "AND cg.extends_entity_column_value IS NULL";
634 $query .= "ORDER BY cg.weight, cf.weight";
641 $dao = CRM_Core_DAO
::executeQuery($query, $params);
643 $result = $options = $sql = $groupTitle = array();
644 while ($dao->fetch()) {
645 if (!array_key_exists($dao->tableName
, $result)) {
646 $result[$dao->tableName
] = array();
647 $sql[$dao->tableName
] = array();
649 $result[$dao->tableName
][$dao->columnName
] = array(
650 'label' => $dao->label
,
651 'type' => $dao->dataType
,
652 'fieldID' => $dao->fieldID
,
655 $options[$dao->fieldID
] = array();
656 $options[$dao->fieldID
]['attributes'] = array(
657 'label' => $dao->label
,
658 'data_type' => $dao->dataType
,
659 'html_type' => $dao->htmlType
,
661 // since we want to add ISO date format.
662 if ($dateFormat && $dao->htmlType
== 'Select Date') {
663 $options[$dao->fieldID
]['attributes']['format'] = $dateFormat;
665 if ($dao->optionGroupID
) {
668 FROM civicrm_option_value
669 WHERE option_group_id = %1
672 $option = CRM_Core_DAO
::executeQuery($query, array(1 => array($dao->optionGroupID
, 'Positive')));
673 while ($option->fetch()) {
674 $dataType = $dao->dataType
;
675 if ($dataType == 'Int' ||
$dataType == 'Float') {
676 $num = round($option->value
, 2);
677 $options[$dao->fieldID
]["$num"] = $option->label
;
680 $options[$dao->fieldID
][$option->value
] = $option->label
;
685 $sql[$dao->tableName
][] = $dao->columnName
;
686 $groupTitle[$dao->tableName
] = $dao->groupTitle
;
689 foreach ($sql as $tableName => $values) {
690 $columnNames = implode(',', $values);
691 $tableName = CRM_Utils_Type
::escape($tableName, 'MysqlColumnNameOrAlias');
693 SELECT '" . CRM_Core_DAO
::escapeString($groupTitle[$tableName]) . "' as groupTitle, $columnNames
699 $cache[$activityTypeID] = array($result, $options, $sql);
701 return $cache[$activityTypeID];
705 * @param int $activityID
707 * @return null|string
709 public function getCreatedBy($activityID) {
711 SELECT c.display_name
712 FROM civicrm_contact c,
714 WHERE l.entity_table = 'civicrm_activity'
716 AND l.modified_id = c.id
720 $params = array(1 => array($activityID, 'Integer'));
721 return CRM_Core_DAO
::singleValueQuery($query, $params);
726 * @param bool $printReport
727 * @param array $replaceString
731 private function redact($string, $printReport = FALSE, $replaceString = array()) {
733 return CRM_Utils_String
::redaction($string, $replaceString);
735 elseif ($this->_isRedact
) {
736 $regexToReplaceString = CRM_Utils_String
::regex($string, $this->_redactionRegexRules
);
737 return CRM_Utils_String
::redaction($string, array_merge($this->_redactionStringRules
, $regexToReplaceString));
743 * @param int $clientID
745 * @param string $activitySetName
746 * @param array $params
747 * @param CRM_Core_Form $form
751 public static function getCaseReport($clientID, $caseID, $activitySetName, $params, $form) {
753 $template = CRM_Core_Smarty
::singleton();
755 $template->assign('caseId', $caseID);
756 $template->assign('clientID', $clientID);
757 $template->assign('activitySetName', $activitySetName);
759 if (!empty($params['is_redact'])) {
760 $form->_isRedact
= TRUE;
761 $template->assign('_isRedact', 'true');
764 $form->_isRedact
= FALSE;
765 $template->assign('_isRedact', 'false');
768 // first get all case information
769 $case = $form->caseInfo($clientID, $caseID);
770 $template->assign_by_ref('case', $case);
772 if ($params['include_activities'] == 1) {
773 $template->assign('includeActivities', 'All');
776 $template->assign('includeActivities', 'Missing activities only');
779 $xml = $form->retrieve($case['caseTypeName']);
781 $activitySetNames = CRM_Case_XMLProcessor_Process
::activitySets($xml->ActivitySets
);
782 $pageTitle = CRM_Utils_Array
::value($activitySetName, $activitySetNames);
783 $template->assign('pageTitle', $pageTitle);
785 if ($activitySetName) {
786 $activityTypes = $form->getActivityTypes($xml, $activitySetName);
789 $activityTypes = CRM_Case_XMLProcessor
::allActivityTypes();
792 if (!$activityTypes) {
796 // next get activity set Information
797 $activitySet = array(
798 'label' => $form->getActivitySetLabel($xml, $activitySetName),
799 'includeActivities' => 'All',
802 $template->assign_by_ref('activitySet', $activitySet);
804 //now collect all the information about activities
805 $activities = array();
806 $form->getActivities($clientID, $caseID, $activityTypes, $activities);
807 $template->assign_by_ref('activities', $activities);
809 // now run the template
810 $contents = $template->fetch('CRM/Case/XMLProcessor/Report.tpl');
814 public static function printCaseReport() {
815 $caseID = CRM_Utils_Request
::retrieve('caseID', 'Positive');
816 $clientID = CRM_Utils_Request
::retrieve('cid', 'Positive');
817 $activitySetName = CRM_Utils_Request
::retrieve('asn', 'String');
818 $isRedact = CRM_Utils_Request
::retrieve('redact', 'Boolean');
819 $includeActivities = CRM_Utils_Request
::retrieve('all', 'Positive');
820 $params = $otherRelationships = $globalGroupInfo = array();
821 $report = new CRM_Case_XMLProcessor_Report($isRedact);
822 if ($includeActivities) {
823 $params['include_activities'] = 1;
827 $params['is_redact'] = 1;
828 $report->_redactionStringRules
= array();
830 $template = CRM_Core_Smarty
::singleton();
832 //get case related relationships (Case Role)
833 $caseRelationships = CRM_Case_BAO_Case
::getCaseRoles($clientID, $caseID);
834 $caseType = CRM_Case_BAO_Case
::getCaseType($caseID, 'name');
836 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
837 $caseRoles = $xmlProcessor->get($caseType, 'CaseRoles');
838 foreach ($caseRelationships as $key => & $value) {
839 if (!empty($caseRoles[$value['relation_type']])) {
840 unset($caseRoles[$value['relation_type']]);
843 if (!array_key_exists($value['name'], $report->_redactionStringRules
)) {
844 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
845 array($value['name'] => 'name_' . rand(10000, 100000))
848 $value['name'] = $report->redact($value['name'], TRUE, $report->_redactionStringRules
);
849 if (!empty($value['email']) &&
850 !array_key_exists($value['email'], $report->_redactionStringRules
)
852 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
853 array($value['email'] => 'email_' . rand(10000, 100000))
857 $value['email'] = $report->redact($value['email'], TRUE, $report->_redactionStringRules
);
859 if (!empty($value['phone']) &&
860 !array_key_exists($value['phone'], $report->_redactionStringRules
)
862 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
863 array($value['phone'] => 'phone_' . rand(10000, 100000))
866 $value['phone'] = $report->redact($value['phone'], TRUE, $report->_redactionStringRules
);
870 $caseRoles['client'] = CRM_Case_BAO_Case
::getContactNames($caseID);
872 foreach ($caseRoles['client'] as &$client) {
873 if (!array_key_exists(CRM_Utils_Array
::value('sort_name', $client), $report->_redactionStringRules
)) {
875 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
876 array(CRM_Utils_Array
::value('sort_name', $client) => 'name_' . rand(10000, 100000))
879 if (!array_key_exists(CRM_Utils_Array
::value('display_name', $client), $report->_redactionStringRules
)) {
880 $report->_redactionStringRules
[CRM_Utils_Array
::value('display_name', $client)] = $report->_redactionStringRules
[CRM_Utils_Array
::value('sort_name', $client)];
882 $client['sort_name'] = $report->redact(CRM_Utils_Array
::value('sort_name', $client), TRUE, $report->_redactionStringRules
);
883 if (!empty($client['email']) &&
884 !array_key_exists($client['email'], $report->_redactionStringRules
)
886 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
887 array($client['email'] => 'email_' . rand(10000, 100000))
890 $client['email'] = $report->redact(CRM_Utils_Array
::value('email', $client), TRUE, $report->_redactionStringRules
);
892 if (!empty($client['phone']) &&
893 !array_key_exists($client['phone'], $report->_redactionStringRules
)
895 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
896 array($client['phone'] => 'phone_' . rand(10000, 100000))
899 $client['phone'] = $report->redact(CRM_Utils_Array
::value('phone', $client), TRUE, $report->_redactionStringRules
);
902 // Retrieve ALL client relationships
903 $relClient = CRM_Contact_BAO_Relationship
::getRelationship($clientID,
904 CRM_Contact_BAO_Relationship
::CURRENT
,
905 0, 0, 0, NULL, NULL, FALSE
907 foreach ($relClient as $r) {
909 if (!array_key_exists($r['name'], $report->_redactionStringRules
)) {
910 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
911 array($r['name'] => 'name_' . rand(10000, 100000))
914 if (!array_key_exists($r['display_name'], $report->_redactionStringRules
)) {
915 $report->_redactionStringRules
[$r['display_name']] = $report->_redactionStringRules
[$r['name']];
917 $r['name'] = $report->redact($r['name'], TRUE, $report->_redactionStringRules
);
919 if (!empty($r['phone']) &&
920 !array_key_exists($r['phone'], $report->_redactionStringRules
)
922 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
923 array($r['phone'] => 'phone_' . rand(10000, 100000))
926 $r['phone'] = $report->redact($r['phone'], TRUE, $report->_redactionStringRules
);
928 if (!empty($r['email']) &&
929 !array_key_exists($r['email'], $report->_redactionStringRules
)
931 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
932 array($r['email'] => 'email_' . rand(10000, 100000))
935 $r['email'] = $report->redact($r['email'], TRUE, $report->_redactionStringRules
);
937 if (!array_key_exists($r['id'], $caseRelationships)) {
938 $otherRelationships[] = $r;
942 // Now global contact list that appears on all cases.
943 $relGlobal = CRM_Case_BAO_Case
::getGlobalContacts($globalGroupInfo);
944 foreach ($relGlobal as & $r) {
946 if (!array_key_exists($r['sort_name'], $report->_redactionStringRules
)) {
947 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
948 array($r['sort_name'] => 'name_' . rand(10000, 100000))
951 if (!array_key_exists($r['display_name'], $report->_redactionStringRules
)) {
952 $report->_redactionStringRules
[$r['display_name']] = $report->_redactionStringRules
[$r['sort_name']];
955 $r['sort_name'] = $report->redact($r['sort_name'], TRUE, $report->_redactionStringRules
);
956 if (!empty($r['phone']) &&
957 !array_key_exists($r['phone'], $report->_redactionStringRules
)
959 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
960 array($r['phone'] => 'phone_' . rand(10000, 100000))
963 $r['phone'] = $report->redact($r['phone'], TRUE, $report->_redactionStringRules
);
965 if (!empty($r['email']) &&
966 !array_key_exists($r['email'], $report->_redactionStringRules
)
968 $report->_redactionStringRules
= CRM_Utils_Array
::crmArrayMerge($report->_redactionStringRules
,
969 array($r['email'] => 'email_' . rand(10000, 100000))
972 $r['email'] = $report->redact($r['email'], TRUE, $report->_redactionStringRules
);
976 // Retrieve custom values for cases.
977 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($caseID, 'Case');
978 $extends = array('case');
979 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
980 $caseCustomFields = array();
981 while (list($gid, $group_values) = each($groupTree)) {
982 while (list($id, $field_values) = each($group_values['fields'])) {
983 if (array_key_exists($id, $customValues)) {
984 $caseCustomFields[$gid]['title'] = $group_values['title'];
985 $caseCustomFields[$gid]['values'][$id] = array(
986 'label' => $field_values['label'],
987 'value' => $customValues[$id],
992 $template->assign('caseRelationships', $caseRelationships);
993 $template->assign('caseRoles', $caseRoles);
994 $template->assign('otherRelationships', $otherRelationships);
995 $template->assign('globalRelationships', $relGlobal);
996 $template->assign('globalGroupInfo', $globalGroupInfo);
997 $template->assign('caseCustomFields', $caseCustomFields);
998 $contents = self
::getCaseReport($clientID,
1004 $printReport = CRM_Case_Audit_Audit
::run($contents, $clientID, $caseID, TRUE);
1006 CRM_Utils_System
::civiExit();