CRM/Case/XMLProcessor/Report.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33 class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor {
  34
  35   /**
  36    * The default variable defined.
  37    *
  38    * @var boolean
  39    */
  40   protected $_isRedact;
  41
  42   /**
  43    */
  44   public function __construct() {
  45   }
  46
  47   /**
  48    * @param int $clientID
  49    * @param int $caseID
  50    * @param string $activitySetName
  51    * @param array $params
  52    *
  53    * @return mixed
  54    */
  55   public function run($clientID, $caseID, $activitySetName, $params) {
  56     $contents = self::getCaseReport($clientID,
  57       $caseID,
  58       $activitySetName,
  59       $params,
  60       $this
  61     );
  62
  63     return CRM_Case_Audit_Audit::run($contents, $clientID, $caseID);
  64   }
  65
  66   public function getRedactionRules() {
  67     foreach (array(
  68                'redactionStringRules',
  69                'redactionRegexRules',
  70              ) as $key => $rule) {
  71       $$rule = CRM_Case_PseudoConstant::redactionRule($key);
  72
  73       if (!empty($$rule)) {
  74         foreach ($$rule as & $val) {
  75           //suffixed with a randomly generated 4-digit number
  76           if ($key == 'redactionStringRules') {
  77             $val .= rand(10000, 100000);
  78           }
  79         }
  80
  81         if (!empty($this->{'_' . $rule})) {
  82           $this->{'_' . $rule} = CRM_Utils_Array::crmArrayMerge($this->{'_' . $rule}, $$rule);
  83         }
  84         else {
  85           $this->{'_' . $rule} = $$rule;
  86         }
  87       }
  88     }
  89   }
  90
  91   /**
  92    * @param int $clientID
  93    * @param int $caseID
  94    *
  95    * @return array
  96    */
  97   public function &caseInfo(
  98     $clientID,
  99     $caseID
 100   ) {
 101     $case = $this->_redactionRegexRules = array();
 102
 103     if (empty($this->_redactionStringRules)) {
 104       $this->_redactionStringRules = array();
 105     }
 106
 107     if ($this->_isRedact == 1) {
 108       $this->getRedactionRules();
 109     }
 110
 111     $client = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $clientID, 'display_name');
 112
 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))
 117       );
 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];
 121       }
 122     }
 123
 124     $case['clientName'] = $this->redact($client);
 125
 126     $dao = new CRM_Case_DAO_Case();
 127     $dao->id = $caseID;
 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);
 135       }
 136       else {
 137         $caseTypeID = $dao->case_type_id;
 138       }
 139       $caseTypeIDs = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 140         $dao->case_type_id
 141       );
 142
 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);
 146     }
 147     return $case;
 148   }
 149
 150   /**
 151    * @param $xml
 152    * @param string $activitySetName
 153    *
 154    * @return array|bool
 155    */
 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;
 168               }
 169             }
 170           }
 171           return empty($activityTypes) ? FALSE : $activityTypes;
 172         }
 173       }
 174     }
 175     return FALSE;
 176   }
 177
 178   /**
 179    * @param $xml
 180    * @param string $activitySetName
 181    *
 182    * @return null|string
 183    */
 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;
 189         }
 190       }
 191     }
 192     return NULL;
 193   }
 194
 195   /**
 196    * @param int $clientID
 197    * @param int $caseID
 198    * @param $activityTypes
 199    * @param $activities
 200    */
 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;
 205     }
 206
 207     // get all core activities
 208     $coreActivityTypes = CRM_Case_PseudoConstant::caseActivityType(FALSE, TRUE);
 209
 210     foreach ($coreActivityTypes as $aType) {
 211       $map[$aType['id']] = $aType;
 212     }
 213
 214     $activityTypeIDs = implode(',', array_keys($map));
 215     $query = "
 216 SELECT a.*, c.id as caseID
 217 FROM   civicrm_activity a,
 218        civicrm_case     c,
 219        civicrm_case_activity ac
 220 WHERE  a.is_current_revision = 1
 221 AND    a.is_deleted =0
 222 AND    a.activity_type_id IN ( $activityTypeIDs )
 223 AND    c.id = ac.case_id
 224 AND    a.id = ac.activity_id
 225 AND    ac.case_id = %1
 226 ";
 227
 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,
 233         $dao,
 234         $activityTypeInfo
 235       );
 236     }
 237   }
 238
 239   /**
 240    * @param int $clientID
 241    * @param int $activityID
 242    * @param bool $anyActivity
 243    * @param int $redact
 244    *
 245    * @return mixed
 246    */
 247   public function &getActivityInfo($clientID, $activityID, $anyActivity = FALSE, $redact = 0) {
 248     static $activityInfos = array();
 249     if ($redact) {
 250       $this->_isRedact = 1;
 251       $this->getRedactionRules();
 252     }
 253
 254     $index = $activityID . '_' . (int) $anyActivity;
 255
 256     if ($clientID) {
 257       $index = $index . '_' . $clientID;
 258     }
 259
 260     if (!array_key_exists($index, $activityInfos)) {
 261       $activityInfos[$index] = array();
 262       $selectCaseActivity = "";
 263       $joinCaseActivity = "";
 264
 265       if ($clientID) {
 266         $selectCaseActivity = ", ca.case_id as caseID ";
 267         $joinCaseActivity = " INNER JOIN civicrm_case_activity ca ON a.id = ca.activity_id ";
 268       }
 269
 270       $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
 271       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
 272       $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
 273
 274       $query = "
 275 SELECT     a.*, aa.contact_id as assigneeID, at.contact_id as targetID
 276 {$selectCaseActivity}
 277 FROM       civicrm_activity a
 278 {$joinCaseActivity}
 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
 281 WHERE      a.id = %1
 282     ";
 283       $params = array(1 => array($activityID, 'Integer'));
 284       $dao = CRM_Core_DAO::executeQuery($query, $params);
 285
 286       if ($dao->fetch()) {
 287         //if activity type is email get info of all activities.
 288         if ($dao->activity_type_id == CRM_Core_PseudoConstant::getKey('CRM_Activity_DAO_Activity', 'activity_type_id', 'Email')) {
 289           $anyActivity = TRUE;
 290         }
 291         $activityTypes = CRM_Case_PseudoConstant::caseActivityType(FALSE, $anyActivity);
 292         $activityTypeInfo = NULL;
 293
 294         if (isset($activityTypes[$dao->activity_type_id])) {
 295           $activityTypeInfo = $activityTypes[$dao->activity_type_id];
 296         }
 297         if ($activityTypeInfo) {
 298           $activityInfos[$index] = $this->getActivity($clientID, $dao, $activityTypeInfo);
 299         }
 300       }
 301     }
 302
 303     return $activityInfos[$index];
 304   }
 305
 306   /**
 307    * @param int $clientID
 308    * @param $activityDAO
 309    * @param $activityTypeInfo
 310    *
 311    * @return array
 312    */
 313   public function &getActivity($clientID, $activityDAO, &$activityTypeInfo) {
 314     if (empty($this->_redactionStringRules)) {
 315       $this->_redactionStringRules = array();
 316     }
 317
 318     $activity = array();
 319     $activity['fields'] = array();
 320     if ($clientID) {
 321       $clientID = CRM_Utils_Type::escape($clientID, 'Integer');
 322       if (!in_array($activityTypeInfo['name'], array(
 323         'Email',
 324         'Inbound Email',
 325       ))
 326       ) {
 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}"
 329         );
 330       }
 331       else {
 332         $activity['editURL'] = '';
 333       }
 334
 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))
 341         );
 342
 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];
 346         }
 347       }
 348
 349       $activity['fields'][] = array(
 350         'label' => 'Client',
 351         'value' => $this->redact($client),
 352         'type' => 'String',
 353       );
 354     }
 355
 356     $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
 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');
 368       }
 369       if (!$processTarget) {
 370         foreach ($targetNames as $targetID => $targetName) {
 371           if ($targetID != $clientID) {
 372             $processTarget = TRUE;
 373             break;
 374           }
 375         }
 376       }
 377
 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))
 386             );
 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];
 390             }
 391           }
 392           $targetRedacted[] = $this->redact($target);
 393         }
 394
 395         $activity['fields'][] = array(
 396           'label' => $label,
 397           'value' => implode('; ', $targetRedacted),
 398           'type' => 'String',
 399         );
 400       }
 401     }
 402
 403     // Activity Type info is a special field
 404     $activity['fields'][] = array(
 405       'label' => ts('Activity Type'),
 406       'value' => $activityTypeInfo['label'],
 407       'type' => 'String',
 408     );
 409
 410     $activity['fields'][] = array(
 411       'label' => ts('Subject'),
 412       'value' => htmlspecialchars($this->redact($activityDAO->subject)),
 413       'type' => 'Memo',
 414     );
 415
 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))
 421       );
 422     }
 423     $activity['fields'][] = array(
 424       'label' => ts('Created By'),
 425       'value' => $this->redact($creator),
 426       'type' => 'String',
 427     );
 428     $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
 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',
 432       $source_contact_id,
 433       'display_name'
 434     );
 435
 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))
 441       );
 442
 443       $reporterSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 444         $source_contact_id,
 445         'sort_name'
 446       );
 447       if (!array_key_exists($reporterSortName, $this->_redactionStringRules)) {
 448         $this->_redactionStringRules[$reporterSortName] = $this->_redactionStringRules[$reporter];
 449       }
 450     }
 451
 452     $activity['fields'][] = array(
 453       'label' => ts('Reported By'),
 454       'value' => $this->redact($reporter),
 455       'type' => 'String',
 456     );
 457
 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);
 461
 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))
 466         );
 467         $assignee = $this->redact($assignee);
 468       }
 469       $assigneeContacts = implode(', ', $assignee_contact_names);
 470       $activity['fields'][] = array(
 471         'label' => ts('Assigned to'),
 472         'value' => $assigneeContacts,
 473         'type' => 'String',
 474       );
 475     }
 476
 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
 482         ),
 483         'type' => 'String',
 484       );
 485     }
 486
 487     $activity['fields'][] = array(
 488       'label' => ts('Location'),
 489       'value' => $activityDAO->location,
 490       'type' => 'String',
 491     );
 492
 493     $activity['fields'][] = array(
 494       'label' => ts('Date and Time'),
 495       'value' => $activityDAO->activity_date_time,
 496       'type' => 'Date',
 497     );
 498
 499     $activity['fields'][] = array(
 500       'label' => ts('Details'),
 501       'value' => $this->redact(CRM_Utils_String::stripAlternatives($activityDAO->details)),
 502       'type' => 'Memo',
 503     );
 504
 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'),
 510         'type' => 'Int',
 511       );
 512     }
 513     $activity['fields'][] = array(
 514       'label' => ts('Status'),
 515       'value' => CRM_Core_PseudoConstant::getLabel('CRM_Activity_DAO_Activity', 'activity_status_id',
 516         $activityDAO->status_id
 517       ),
 518       'type' => 'String',
 519     );
 520
 521     $activity['fields'][] = array(
 522       'label' => ts('Priority'),
 523       'value' => CRM_Core_PseudoConstant::getLabel('CRM_Activity_DAO_Activity', 'priority',
 524         $activityDAO->priority_id
 525       ),
 526       'type' => 'String',
 527     );
 528
 529     //for now empty custom groups
 530     $activity['customGroups'] = $this->getCustomData($clientID,
 531       $activityDAO,
 532       $activityTypeInfo
 533     );
 534
 535     return $activity;
 536   }
 537
 538   /**
 539    * @param int $clientID
 540    * @param $activityDAO
 541    * @param $activityTypeInfo
 542    *
 543    * @return array|null
 544    */
 545   public function getCustomData($clientID, $activityDAO, &$activityTypeInfo) {
 546     list($typeValues, $options, $sql) = $this->getActivityTypeCustomSQL($activityTypeInfo['id'], '%Y-%m-%d');
 547
 548     $params = array(1 => array($activityDAO->id, 'Integer'));
 549
 550     $customGroups = array();
 551     foreach ($sql as $tableName => $sqlClause) {
 552       $dao = CRM_Core_DAO::executeQuery($sqlClause, $params);
 553       if ($dao->fetch()) {
 554         $customGroup = array();
 555         foreach ($typeValues[$tableName] as $columnName => $typeValue) {
 556
 557           if (CRM_Utils_Array::value('type', $typeValue) == 'Date') {
 558             $value = $dao->$columnName;
 559           }
 560           else {
 561             $value = CRM_Core_BAO_CustomField::displayValue($dao->$columnName, $typeValue['fieldID'], $activityDAO->id);
 562           }
 563
 564           if ($value) {
 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);
 569             }
 570             if (CRM_Utils_Array::value('type', $typeValue) == 'String' ||
 571               CRM_Utils_Array::value('type', $typeValue) == 'Memo'
 572             ) {
 573               $value = $this->redact($value);
 574             }
 575             elseif (CRM_Utils_Array::value('type', $typeValue) == 'Link') {
 576               $value = CRM_Utils_System::formatWikiURL($value);
 577             }
 578           }
 579           //$typeValue
 580           $customGroup[] = array(
 581             'label' => $typeValue['label'],
 582             'value' => $value,
 583             'type' => $typeValue['type'],
 584             'fieldID' => $typeValue['fieldID'],
 585           );
 586         }
 587         $customGroups[$dao->groupTitle] = $customGroup;
 588       }
 589     }
 590
 591     return empty($customGroups) ? NULL : $customGroups;
 592   }
 593
 594   /**
 595    * @param int $activityTypeID
 596    * @param null $dateFormat
 597    *
 598    * @return mixed
 599    */
 600   public function getActivityTypeCustomSQL($activityTypeID, $dateFormat = NULL) {
 601     static $cache = array();
 602
 603     if (is_null($activityTypeID)) {
 604       $activityTypeID = 0;
 605     }
 606
 607     if (!isset($cache[$activityTypeID])) {
 608       $query = "
 609 SELECT cg.title           as groupTitle,
 610        cg.table_name      as tableName ,
 611        cf.column_name     as columnName,
 612        cf.label           as label     ,
 613        cg.id              as groupID   ,
 614        cf.id              as fieldID   ,
 615        cf.data_type       as dataType  ,
 616        cf.html_type       as htmlType  ,
 617        cf.option_group_id as optionGroupID
 618 FROM   civicrm_custom_group cg,
 619        civicrm_custom_field cf
 620 WHERE  cf.custom_group_id = cg.id
 621 AND    cg.extends = 'Activity'
 622 AND " . CRM_Core_Permission::customGroupClause(CRM_Core_Permission::VIEW, 'cg.');
 623
 624       if ($activityTypeID) {
 625         $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 . "%' )";
 626       }
 627       else {
 628         $query .= "AND cg.extends_entity_column_value IS NULL";
 629       }
 630       $query .= "ORDER BY cg.weight, cf.weight";
 631       $params = array(
 632         1 => array(
 633           $activityTypeID,
 634           'Integer',
 635         ),
 636       );
 637       $dao = CRM_Core_DAO::executeQuery($query, $params);
 638
 639       $result = $options = $sql = $groupTitle = array();
 640       while ($dao->fetch()) {
 641         if (!array_key_exists($dao->tableName, $result)) {
 642           $result[$dao->tableName] = array();
 643           $sql[$dao->tableName] = array();
 644         }
 645         $result[$dao->tableName][$dao->columnName] = array(
 646           'label' => $dao->label,
 647           'type' => $dao->dataType,
 648           'fieldID' => $dao->fieldID,
 649         );
 650
 651         $options[$dao->fieldID] = array();
 652         $options[$dao->fieldID]['attributes'] = array(
 653           'label' => $dao->label,
 654           'data_type' => $dao->dataType,
 655           'html_type' => $dao->htmlType,
 656         );
 657         // since we want to add ISO date format.
 658         if ($dateFormat && $dao->htmlType == 'Select Date') {
 659           $options[$dao->fieldID]['attributes']['format'] = $dateFormat;
 660         }
 661         if ($dao->optionGroupID) {
 662           $query = "
 663 SELECT label, value
 664   FROM civicrm_option_value
 665  WHERE option_group_id = %1
 666 ";
 667
 668           $option = CRM_Core_DAO::executeQuery($query, array(1 => array($dao->optionGroupID, 'Positive')));
 669           while ($option->fetch()) {
 670             $dataType = $dao->dataType;
 671             if ($dataType == 'Int' || $dataType == 'Float') {
 672               $num = round($option->value, 2);
 673               $options[$dao->fieldID]["$num"] = $option->label;
 674             }
 675             else {
 676               $options[$dao->fieldID][$option->value] = $option->label;
 677             }
 678           }
 679         }
 680
 681         $sql[$dao->tableName][] = $dao->columnName;
 682         $groupTitle[$dao->tableName] = $dao->groupTitle;
 683       }
 684
 685       foreach ($sql as $tableName => $values) {
 686         $columnNames = implode(',', $values);
 687         $title = CRM_Core_DAO::escapeString($groupTitle[$tableName]);
 688         $mysqlTableName = CRM_Utils_Type::escape($tableName, 'MysqlColumnNameOrAlias');
 689         $sql[$tableName] = "
 690 SELECT '" . $title . "' as groupTitle, $columnNames
 691 FROM   $mysqlTableName
 692 WHERE  entity_id = %1
 693 ";
 694       }
 695
 696       $cache[$activityTypeID] = array($result, $options, $sql);
 697     }
 698     return $cache[$activityTypeID];
 699   }
 700
 701   /**
 702    * @param int $activityID
 703    *
 704    * @return null|string
 705    */
 706   public function getCreatedBy($activityID) {
 707     $query = "
 708 SELECT c.display_name
 709 FROM   civicrm_contact c,
 710        civicrm_log     l
 711 WHERE  l.entity_table = 'civicrm_activity'
 712 AND    l.entity_id    = %1
 713 AND    l.modified_id  = c.id
 714 LIMIT  1
 715 ";
 716
 717     $params = array(1 => array($activityID, 'Integer'));
 718     return CRM_Core_DAO::singleValueQuery($query, $params);
 719   }
 720
 721   /**
 722    * @param $string
 723    * @param bool $printReport
 724    * @param array $replaceString
 725    *
 726    * @return mixed
 727    */
 728   private function redact($string, $printReport = FALSE, $replaceString = array()) {
 729     if ($printReport) {
 730       return CRM_Utils_String::redaction($string, $replaceString);
 731     }
 732     elseif ($this->_isRedact) {
 733       $regexToReplaceString = CRM_Utils_String::regex($string, $this->_redactionRegexRules);
 734       return CRM_Utils_String::redaction($string, array_merge($this->_redactionStringRules, $regexToReplaceString));
 735     }
 736     return $string;
 737   }
 738
 739   /**
 740    * @param int $clientID
 741    * @param int $caseID
 742    * @param string $activitySetName
 743    * @param array $params
 744    * @param CRM_Core_Form $form
 745    *
 746    * @return mixed
 747    */
 748   public static function getCaseReport($clientID, $caseID, $activitySetName, $params, $form) {
 749
 750     $template = CRM_Core_Smarty::singleton();
 751
 752     $template->assign('caseId', $caseID);
 753     $template->assign('clientID', $clientID);
 754     $template->assign('activitySetName', $activitySetName);
 755
 756     if (!empty($params['is_redact'])) {
 757       $form->_isRedact = TRUE;
 758       $template->assign('_isRedact', 'true');
 759     }
 760     else {
 761       $form->_isRedact = FALSE;
 762       $template->assign('_isRedact', 'false');
 763     }
 764
 765     // first get all case information
 766     $case = $form->caseInfo($clientID, $caseID);
 767     $template->assign_by_ref('case', $case);
 768
 769     if ($params['include_activities'] == 1) {
 770       $template->assign('includeActivities', 'All');
 771     }
 772     else {
 773       $template->assign('includeActivities', 'Missing activities only');
 774     }
 775
 776     $xml = $form->retrieve($case['caseTypeName']);
 777
 778     $activitySetNames = CRM_Case_XMLProcessor_Process::activitySets($xml->ActivitySets);
 779     $pageTitle = CRM_Utils_Array::value($activitySetName, $activitySetNames);
 780     $template->assign('pageTitle', $pageTitle);
 781
 782     if ($activitySetName) {
 783       $activityTypes = $form->getActivityTypes($xml, $activitySetName);
 784     }
 785     else {
 786       $activityTypes = CRM_Case_XMLProcessor::allActivityTypes();
 787     }
 788
 789     if (!$activityTypes) {
 790       return FALSE;
 791     }
 792
 793     // next get activity set Information
 794     $activitySet = array(
 795       'label' => $form->getActivitySetLabel($xml, $activitySetName),
 796       'includeActivities' => 'All',
 797       'redact' => 'false',
 798     );
 799     $template->assign_by_ref('activitySet', $activitySet);
 800
 801     //now collect all the information about activities
 802     $activities = array();
 803     $form->getActivities($clientID, $caseID, $activityTypes, $activities);
 804     $template->assign_by_ref('activities', $activities);
 805
 806     // now run the template
 807     $contents = $template->fetch('CRM/Case/XMLProcessor/Report.tpl');
 808     return $contents;
 809   }
 810
 811   public static function printCaseReport() {
 812     $caseID = CRM_Utils_Request::retrieve('caseID', 'Positive');
 813     $clientID = CRM_Utils_Request::retrieve('cid', 'Positive');
 814     $activitySetName = CRM_Utils_Request::retrieve('asn', 'String');
 815     $isRedact = CRM_Utils_Request::retrieve('redact', 'Boolean');
 816     $includeActivities = CRM_Utils_Request::retrieve('all', 'Positive');
 817     $params = $otherRelationships = $globalGroupInfo = array();
 818     $report = new CRM_Case_XMLProcessor_Report($isRedact);
 819     if ($includeActivities) {
 820       $params['include_activities'] = 1;
 821     }
 822
 823     if ($isRedact) {
 824       $params['is_redact'] = 1;
 825       $report->_redactionStringRules = array();
 826     }
 827     $template = CRM_Core_Smarty::singleton();
 828
 829     //get case related relationships (Case Role)
 830     $caseRelationships = CRM_Case_BAO_Case::getCaseRoles($clientID, $caseID);
 831     $caseType = CRM_Case_BAO_Case::getCaseType($caseID, 'name');
 832
 833     $xmlProcessor = new CRM_Case_XMLProcessor_Process();
 834     $caseRoles = $xmlProcessor->get($caseType, 'CaseRoles');
 835     foreach ($caseRelationships as $key => & $value) {
 836       if (!empty($caseRoles[$value['relation_type']])) {
 837         unset($caseRoles[$value['relation_type']]);
 838       }
 839       if ($isRedact) {
 840         if (!array_key_exists($value['name'], $report->_redactionStringRules)) {
 841           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 842             array($value['name'] => 'name_' . rand(10000, 100000))
 843           );
 844         }
 845         $value['name'] = $report->redact($value['name'], TRUE, $report->_redactionStringRules);
 846         if (!empty($value['email']) &&
 847           !array_key_exists($value['email'], $report->_redactionStringRules)
 848         ) {
 849           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 850             array($value['email'] => 'email_' . rand(10000, 100000))
 851           );
 852         }
 853
 854         $value['email'] = $report->redact($value['email'], TRUE, $report->_redactionStringRules);
 855
 856         if (!empty($value['phone']) &&
 857           !array_key_exists($value['phone'], $report->_redactionStringRules)
 858         ) {
 859           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 860             array($value['phone'] => 'phone_' . rand(10000, 100000))
 861           );
 862         }
 863         $value['phone'] = $report->redact($value['phone'], TRUE, $report->_redactionStringRules);
 864       }
 865     }
 866
 867     $caseRoles['client'] = CRM_Case_BAO_Case::getContactNames($caseID);
 868     if ($isRedact) {
 869       foreach ($caseRoles['client'] as &$client) {
 870         if (!array_key_exists(CRM_Utils_Array::value('sort_name', $client), $report->_redactionStringRules)) {
 871
 872           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 873             array(CRM_Utils_Array::value('sort_name', $client) => 'name_' . rand(10000, 100000))
 874           );
 875         }
 876         if (!array_key_exists(CRM_Utils_Array::value('display_name', $client), $report->_redactionStringRules)) {
 877           $report->_redactionStringRules[CRM_Utils_Array::value('display_name', $client)] = $report->_redactionStringRules[CRM_Utils_Array::value('sort_name', $client)];
 878         }
 879         $client['sort_name'] = $report->redact(CRM_Utils_Array::value('sort_name', $client), TRUE, $report->_redactionStringRules);
 880         if (!empty($client['email']) &&
 881           !array_key_exists($client['email'], $report->_redactionStringRules)
 882         ) {
 883           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 884             array($client['email'] => 'email_' . rand(10000, 100000))
 885           );
 886         }
 887         $client['email'] = $report->redact(CRM_Utils_Array::value('email', $client), TRUE, $report->_redactionStringRules);
 888
 889         if (!empty($client['phone']) &&
 890           !array_key_exists($client['phone'], $report->_redactionStringRules)
 891         ) {
 892           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 893             array($client['phone'] => 'phone_' . rand(10000, 100000))
 894           );
 895         }
 896         $client['phone'] = $report->redact(CRM_Utils_Array::value('phone', $client), TRUE, $report->_redactionStringRules);
 897       }
 898     }
 899     // Retrieve ALL client relationships
 900     $relClient = CRM_Contact_BAO_Relationship::getRelationship($clientID,
 901       CRM_Contact_BAO_Relationship::CURRENT,
 902       0, 0, 0, NULL, NULL, FALSE
 903     );
 904     foreach ($relClient as $r) {
 905       if ($isRedact) {
 906         if (!array_key_exists($r['name'], $report->_redactionStringRules)) {
 907           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 908             array($r['name'] => 'name_' . rand(10000, 100000))
 909           );
 910         }
 911         if (!array_key_exists($r['display_name'], $report->_redactionStringRules)) {
 912           $report->_redactionStringRules[$r['display_name']] = $report->_redactionStringRules[$r['name']];
 913         }
 914         $r['name'] = $report->redact($r['name'], TRUE, $report->_redactionStringRules);
 915
 916         if (!empty($r['phone']) &&
 917           !array_key_exists($r['phone'], $report->_redactionStringRules)
 918         ) {
 919           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 920             array($r['phone'] => 'phone_' . rand(10000, 100000))
 921           );
 922         }
 923         $r['phone'] = $report->redact($r['phone'], TRUE, $report->_redactionStringRules);
 924
 925         if (!empty($r['email']) &&
 926           !array_key_exists($r['email'], $report->_redactionStringRules)
 927         ) {
 928           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 929             array($r['email'] => 'email_' . rand(10000, 100000))
 930           );
 931         }
 932         $r['email'] = $report->redact($r['email'], TRUE, $report->_redactionStringRules);
 933       }
 934       if (!array_key_exists($r['id'], $caseRelationships)) {
 935         $otherRelationships[] = $r;
 936       }
 937     }
 938
 939     // Now global contact list that appears on all cases.
 940     $relGlobal = CRM_Case_BAO_Case::getGlobalContacts($globalGroupInfo);
 941     foreach ($relGlobal as & $r) {
 942       if ($isRedact) {
 943         if (!array_key_exists($r['sort_name'], $report->_redactionStringRules)) {
 944           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 945             array($r['sort_name'] => 'name_' . rand(10000, 100000))
 946           );
 947         }
 948         if (!array_key_exists($r['display_name'], $report->_redactionStringRules)) {
 949           $report->_redactionStringRules[$r['display_name']] = $report->_redactionStringRules[$r['sort_name']];
 950         }
 951
 952         $r['sort_name'] = $report->redact($r['sort_name'], TRUE, $report->_redactionStringRules);
 953         if (!empty($r['phone']) &&
 954           !array_key_exists($r['phone'], $report->_redactionStringRules)
 955         ) {
 956           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 957             array($r['phone'] => 'phone_' . rand(10000, 100000))
 958           );
 959         }
 960         $r['phone'] = $report->redact($r['phone'], TRUE, $report->_redactionStringRules);
 961
 962         if (!empty($r['email']) &&
 963           !array_key_exists($r['email'], $report->_redactionStringRules)
 964         ) {
 965           $report->_redactionStringRules = CRM_Utils_Array::crmArrayMerge($report->_redactionStringRules,
 966             array($r['email'] => 'email_' . rand(10000, 100000))
 967           );
 968         }
 969         $r['email'] = $report->redact($r['email'], TRUE, $report->_redactionStringRules);
 970       }
 971     }
 972
 973     // Retrieve custom values for cases.
 974     $customValues = CRM_Core_BAO_CustomValueTable::getEntityValues($caseID, 'Case');
 975     $extends = array('case');
 976     $groupTree = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, NULL, $extends);
 977     $caseCustomFields = array();
 978     foreach ($groupTree as $gid => $group_values) {
 979       foreach ($group_values['fields'] as $id => $field_values) {
 980         if (array_key_exists($id, $customValues)) {
 981           $caseCustomFields[$gid]['title'] = $group_values['title'];
 982           $caseCustomFields[$gid]['values'][$id] = array(
 983             'label' => $field_values['label'],
 984             'value' => $customValues[$id],
 985           );
 986         }
 987       }
 988     }
 989     $template->assign('caseRelationships', $caseRelationships);
 990     $template->assign('caseRoles', $caseRoles);
 991     $template->assign('otherRelationships', $otherRelationships);
 992     $template->assign('globalRelationships', $relGlobal);
 993     $template->assign('globalGroupInfo', $globalGroupInfo);
 994     $template->assign('caseCustomFields', $caseCustomFields);
 995     $contents = self::getCaseReport($clientID,
 996       $caseID,
 997       $activitySetName,
 998       $params,
 999       $report
1000     );
1001     $printReport = CRM_Case_Audit_Audit::run($contents, $clientID, $caseID, TRUE);
1002     echo $printReport;
1003     CRM_Utils_System::civiExit();
1004   }
1005
1006 }