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
35 class CRM_Report_Form_Activity
extends CRM_Report_Form
{
37 protected $_customGroupExtends = array(
41 function __construct() {
42 $config = CRM_Core_Config
::singleton();
43 $campaignEnabled = in_array("CiviCampaign", $config->enableComponents
);
44 if ($campaignEnabled) {
45 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
46 $this->activeCampaigns
= $getCampaigns['campaigns'];
47 asort($this->activeCampaigns
);
48 $this->engagementLevels
= CRM_Campaign_PseudoConstant
::engagementLevel();
50 $this->activityTypes
= CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'label', TRUE);
51 asort($this->activityTypes
);
53 $this->_columns
= array(
56 'dao' => 'CRM_Contact_DAO_Contact',
61 'name' => 'sort_name',
62 'title' => ts('Source Contact Name'),
63 'alias' => 'civicrm_contact_source',
68 'name' => 'sort_name',
69 'title' => ts('Assignee Contact Name'),
70 'alias' => 'civicrm_contact_assignee',
75 'name' => 'sort_name',
76 'title' => ts('Target Contact Name'),
77 'alias' => 'contact_civireport',
85 'name' => 'sort_name',
86 'alias' => 'civicrm_contact_source',
87 'title' => ts('Source Contact Name'),
89 'type' => CRM_Report_Form
::OP_STRING
,
93 'name' => 'sort_name',
94 'alias' => 'civicrm_contact_assignee',
95 'title' => ts('Assignee Contact Name'),
97 'type' => CRM_Report_Form
::OP_STRING
,
101 'name' => 'sort_name',
102 'alias' => 'contact_civireport',
103 'title' => ts('Target Contact Name'),
104 'operator' => 'like',
105 'type' => CRM_Report_Form
::OP_STRING
,
109 'name' => 'current_user',
110 'title' => ts('Limit To Current User'),
111 'type' => CRM_Utils_Type
::T_INT
,
112 'operatorType' => CRM_Report_Form
::OP_SELECT
,
113 'options' => array('0' => ts('No'), '1' => ts('Yes')),
116 'grouping' => 'contact-fields',
120 'dao' => 'CRM_Core_DAO_Email',
123 'contact_source_email' =>
126 'title' => ts('Source Contact Email'),
127 'alias' => 'civicrm_email_source',
129 'contact_assignee_email' =>
132 'title' => ts('Assignee Contact Email'),
133 'alias' => 'civicrm_email_assignee',
135 'contact_target_email' =>
138 'title' => ts('Target Contact Email'),
139 'alias' => 'civicrm_email_target',
144 'source_contact_email' =>
147 'title' => ts('Source Contact Email'),
148 'alias' => 'civicrm_email_source',
152 'civicrm_activity' =>
154 'dao' => 'CRM_Activity_DAO_Activity',
159 'no_display' => TRUE,
162 'source_record_id' =>
164 'no_display' => TRUE,
167 'activity_type_id' =>
168 array('title' => ts('Activity Type'),
170 'type' => CRM_Utils_Type
::T_STRING
,
172 'activity_subject' =>
173 array('title' => ts('Subject'),
176 'activity_date_time' =>
177 array('title' => ts('Activity Date'),
181 array('title' => ts('Activity Status'),
183 'type' => CRM_Utils_Type
::T_STRING
,
186 array('title' => ts('Duration'),
187 'type' => CRM_Utils_Type
::T_INT
,
192 'activity_date_time' =>
194 'default' => 'this.month',
195 'operatorType' => CRM_Report_Form
::OP_DATE
,
197 'activity_subject' =>
198 array('title' => ts('Activity Subject')),
199 'activity_type_id' =>
200 array('title' => ts('Activity Type'),
201 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
202 'options' => $this->activityTypes
,
205 array('title' => ts('Activity Status'),
206 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
207 'options' => CRM_Core_PseudoConstant
::activityStatus(),
212 'source_contact_id' =>
213 array('title' => ts('Source Contact'), 'default_weight' => '0'),
214 'activity_date_time' =>
215 array('title' => ts('Activity Date'), 'default_weight' => '1'),
216 'activity_type_id' =>
217 array('title' => ts('Activity Type'), 'default_weight' => '2'),
219 'grouping' => 'activity-fields',
220 'alias' => 'activity',
222 'civicrm_activity_assignment' =>
224 'dao' => 'CRM_Activity_DAO_ActivityContact',
229 'no_display' => TRUE,
233 'alias' => 'activity_assignment',
235 'civicrm_activity_target' =>
237 'dao' => 'CRM_Activity_DAO_ActivityContact',
242 'no_display' => TRUE,
246 'alias' => 'activity_target',
248 'civicrm_activity_source' =>
250 'dao' => 'CRM_Activity_DAO_ActivityContact',
255 'no_display' => TRUE,
259 'alias' => 'activity_source',
262 'civicrm_case_activity' =>
264 'dao' => 'CRM_Case_DAO_CaseActivity',
270 'no_display' => TRUE,
274 'alias' => 'case_activity',
276 ) +
$this->addAddressFields(FALSE, TRUE);
278 if ($campaignEnabled) {
279 // Add display column and filter for Survey Results, Campaign and Engagement Index if CiviCampaign is enabled
281 $this->_columns
['civicrm_activity']['fields']['result'] = array(
282 'title' => 'Survey Result',
283 'default' => 'false',
285 $this->_columns
['civicrm_activity']['filters']['result'] = array('title' => ts('Survey Result'),
286 'operator' => 'like',
287 'type' => CRM_Utils_Type
::T_STRING
,
289 if (!empty($this->activeCampaigns
)) {
290 $this->_columns
['civicrm_activity']['fields']['campaign_id'] = array(
291 'title' => 'Campaign',
292 'default' => 'false',
294 $this->_columns
['civicrm_activity']['filters']['campaign_id'] = array('title' => ts('Campaign'),
295 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
296 'options' => $this->activeCampaigns
,
299 if (!empty($this->engagementLevels
)) {
300 $this->_columns
['civicrm_activity']['fields']['engagement_level'] = array(
301 'title' => 'Engagement Index',
302 'default' => 'false',
304 $this->_columns
['civicrm_activity']['filters']['engagement_level'] = array('title' => ts('Engagement Index'),
305 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
306 'options' => $this->engagementLevels
,
310 $this->_groupFilter
= TRUE;
311 $this->_tagFilter
= TRUE;
312 parent
::__construct();
317 $seperator = CRM_CORE_DAO
::VALUE_SEPARATOR
;
318 $this->_columnHeaders
= array();
319 foreach ($this->_columns
as $tableName => $table) {
320 if (array_key_exists('fields', $table)) {
321 foreach ($table['fields'] as $fieldName => $field) {
322 if (CRM_Utils_Array
::value('required', $field) ||
323 CRM_Utils_Array
::value($fieldName, $this->_params
['fields'])
326 if (isset($this->_params
['group_bys']) &&
327 !CRM_Utils_Array
::value('activity_type_id', $this->_params
['group_bys']) &&
328 (in_array($fieldName, array(
329 'contact_assignee', 'assignee_contact_id')) ||
330 in_array($fieldName, array('contact_target', 'target_contact_id'))
333 $orderByRef = "activity_assignment_civireport.contact_id";
334 if (in_array($fieldName, array(
335 'contact_target', 'target_contact_id'))) {
336 $orderByRef = "activity_target_civireport.contact_id";
338 $select[] = "GROUP_CONCAT(DISTINCT {$field['dbAlias']} ORDER BY {$orderByRef} SEPARATOR '{$seperator}') as {$tableName}_{$fieldName}";
341 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
343 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
344 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
345 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['no_display'] = CRM_Utils_Array
::value('no_display', $field);
351 $this->_select
= "SELECT " . implode(', ', $select) . " ";
355 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
356 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
357 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
358 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
360 FROM civicrm_activity {$this->_aliases['civicrm_activity']}
362 LEFT JOIN civicrm_activity_contact {$this->_aliases['civicrm_activity_target']}
363 ON {$this->_aliases['civicrm_activity']}.id = {$this->_aliases['civicrm_activity_target']}.activity_id AND
364 {$this->_aliases['civicrm_activity_target']}.record_type_id = {$targetID}
365 LEFT JOIN civicrm_activity_contact {$this->_aliases['civicrm_activity_assignment']}
366 ON {$this->_aliases['civicrm_activity']}.id = {$this->_aliases['civicrm_activity_assignment']}.activity_id AND
367 {$this->_aliases['civicrm_activity_assignment']}.record_type_id = {$assigneeID}
368 LEFT JOIN civicrm_activity_contact {$this->_aliases['civicrm_activity_source']}
369 ON {$this->_aliases['civicrm_activity']}.id = {$this->_aliases['civicrm_activity_source']}.activity_id AND
370 {$this->_aliases['civicrm_activity_source']}.record_type_id = {$sourceID}
371 LEFT JOIN civicrm_contact contact_civireport
372 ON {$this->_aliases['civicrm_activity_target']}.contact_id = contact_civireport.id
373 LEFT JOIN civicrm_contact civicrm_contact_assignee
374 ON {$this->_aliases['civicrm_activity_assignment']}.contact_id = civicrm_contact_assignee.id
375 LEFT JOIN civicrm_contact civicrm_contact_source
376 ON {$this->_aliases['civicrm_activity_source']}.contact_id = civicrm_contact_source.id
378 LEFT JOIN civicrm_option_value
379 ON ( {$this->_aliases['civicrm_activity']}.activity_type_id = civicrm_option_value.value )
380 LEFT JOIN civicrm_option_group
381 ON civicrm_option_group.id = civicrm_option_value.option_group_id
382 LEFT JOIN civicrm_case_activity case_activity_civireport
383 ON case_activity_civireport.activity_id = {$this->_aliases['civicrm_activity']}.id
384 LEFT JOIN civicrm_case
385 ON case_activity_civireport.case_id = civicrm_case.id
386 LEFT JOIN civicrm_case_contact
387 ON civicrm_case_contact.case_id = civicrm_case.id ";
389 if ($this->isTableSelected('civicrm_email')) {
391 LEFT JOIN civicrm_email civicrm_email_source
392 ON {$this->_aliases['civicrm_activity_source']}.contact_id = civicrm_email_source.contact_id AND
393 civicrm_email_source.is_primary = 1
395 LEFT JOIN civicrm_email civicrm_email_target
396 ON {$this->_aliases['civicrm_activity_target']}.contact_id = civicrm_email_target.contact_id AND
397 civicrm_email_target.is_primary = 1
399 LEFT JOIN civicrm_email civicrm_email_assignee
400 ON {$this->_aliases['civicrm_activity_assignment']}.contact_id = civicrm_email_assignee.contact_id AND
401 civicrm_email_assignee.is_primary = 1 ";
403 $this->addAddressFromClause();
407 $this->_where
= " WHERE civicrm_option_group.name = 'activity_type' AND
408 {$this->_aliases['civicrm_activity']}.is_test = 0 AND
409 {$this->_aliases['civicrm_activity']}.is_deleted = 0 AND
410 {$this->_aliases['civicrm_activity']}.is_current_revision = 1";
413 foreach ($this->_columns
as $tableName => $table) {
414 if (array_key_exists('filters', $table)) {
416 foreach ($table['filters'] as $fieldName => $field) {
418 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
419 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
420 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
421 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
423 $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
426 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
428 $clause = $this->whereClause($field,
430 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
431 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
432 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
437 if ($field['name'] == 'current_user') {
438 if (CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
) == 1) {
440 $session = CRM_Core_Session
::singleton();
441 if ($contactID = $session->get('userID')) {
442 $clause = "( civicrm_contact_source.id = " . $contactID . " OR civicrm_contact_assignee.id = " . $contactID . " OR contact_civireport.id = " . $contactID . " )";
452 if (!empty($clause)) {
453 $clauses[] = $clause;
459 if (empty($clauses)) {
460 $this->_where
.= " ";
463 $this->_where
.= " AND " . implode(' AND ', $clauses);
466 if ($this->_aclWhere
) {
467 $this->_where
.= " AND {$this->_aclWhere} ";
472 $this->_groupBy
= "GROUP BY {$this->_aliases['civicrm_activity']}.id";
475 function buildACLClause($tableAlias = 'contact_a') {
476 //override for ACL( Since Contact may be source
477 //contact/assignee or target also it may be null )
479 if (CRM_Core_Permission
::check('view all contacts')) {
480 $this->_aclFrom
= $this->_aclWhere
= NULL;
484 $session = CRM_Core_Session
::singleton();
485 $contactID = $session->get('userID');
489 $contactID = CRM_Utils_Type
::escape($contactID, 'Integer');
491 CRM_Contact_BAO_Contact_Permission
::cache($contactID);
493 foreach ($tableAlias as $k => $alias) {
494 $clauses[] = " INNER JOIN civicrm_acl_contact_cache aclContactCache_{$k} ON ( {$alias}.id = aclContactCache_{$k}.contact_id OR {$alias}.id IS NULL ) AND aclContactCache_{$k}.user_id = $contactID ";
497 $this->_aclFrom
= implode(" ", $clauses);
498 $this->_aclWhere
= NULL;
501 function postProcess() {
503 $this->buildACLClause(array('civicrm_contact_source', 'contact_civireport', 'civicrm_contact_assignee'));
504 parent
::postProcess();
507 function alterDisplay(&$rows) {
508 // custom code to alter rows
511 $activityType = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
512 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
514 $seperator = CRM_CORE_DAO
::VALUE_SEPARATOR
;
515 $context = CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'report');
517 if (CRM_Core_Permission
::check('access CiviCRM')) {
519 $onHover = ts('View Contact Summary for this Contact');
520 $onHoverAct = ts('View Activity Record');
523 foreach ($rows as $rowNum => $row) {
524 if (array_key_exists('civicrm_contact_contact_source', $row)) {
525 if ($value = $row['civicrm_activity_assignment_contact_id']) {
527 $url = CRM_Utils_System
::url("civicrm/contact/view",
528 'reset=1&cid=' . $value,
531 $rows[$rowNum]['civicrm_contact_contact_source_link'] = $url;
532 $rows[$rowNum]['civicrm_contact_contact_source_hover'] = $onHover;
538 if (array_key_exists('civicrm_contact_contact_assignee', $row)) {
539 $assigneeNames = explode($seperator, $row['civicrm_contact_contact_assignee']);
540 if ($value = $row['civicrm_activity_assignment_contact_id']) {
541 $assigneeContactIds = explode($seperator, $value);
544 foreach ($assigneeContactIds as $id => $value) {
545 $url = CRM_Utils_System
::url("civicrm/contact/view",
546 'reset=1&cid=' . $value,
549 $link[] = "<a title='" . $onHover . "' href='" . $url . "'>{$assigneeNames[$id]}</a>";
551 $rows[$rowNum]['civicrm_contact_contact_assignee'] = implode('; ', $link);
557 if (array_key_exists('civicrm_contact_contact_target', $row)) {
558 $targetNames = explode($seperator, $row['civicrm_contact_contact_target']);
559 if ($value = $row['civicrm_activity_target_contact_id']) {
560 $targetContactIds = explode($seperator, $value);
563 foreach ($targetContactIds as $id => $value) {
564 $url = CRM_Utils_System
::url("civicrm/contact/view",
565 'reset=1&cid=' . $value,
568 $link[] = "<a title='" . $onHover . "' href='" . $url . "'>{$targetNames[$id]}</a>";
570 $rows[$rowNum]['civicrm_contact_contact_target'] = implode('; ', $link);
576 if (array_key_exists('civicrm_activity_activity_type_id', $row)) {
577 if ($value = $row['civicrm_activity_activity_type_id']) {
578 $rows[$rowNum]['civicrm_activity_activity_type_id'] = $activityType[$value];
580 // Check for target contact id(s) and use the first contact id in that list for view activity link if found,
581 // else use source contact id
582 if (!empty($rows[$rowNum]['civicrm_activity_target_target_contact_id'])) {
583 $targets = explode($seperator, $rows[$rowNum]['civicrm_activity_target_target_contact_id']);
587 $cid = $rows[$rowNum]['civicrm_activity_source_contact_id'];
590 $actionLinks = CRM_Activity_Selector_Activity
::actionLinks($row['civicrm_activity_activity_type_id'],
591 CRM_Utils_Array
::value('civicrm_activity_source_record_id', $rows[$rowNum]),
593 $rows[$rowNum]['civicrm_activity_id']
597 'id' => $rows[$rowNum]['civicrm_activity_id'],
601 $url = CRM_Utils_System
::url($actionLinks[CRM_Core_Action
::VIEW
]['url'],
602 CRM_Core_Action
::replace($actionLinks[CRM_Core_Action
::VIEW
]['qs'], $linkValues), TRUE
604 $rows[$rowNum]['civicrm_activity_activity_type_id_link'] = $url;
605 $rows[$rowNum]['civicrm_activity_activity_type_id_hover'] = $onHoverAct;
611 if (array_key_exists('civicrm_activity_status_id', $row)) {
612 if ($value = $row['civicrm_activity_status_id']) {
613 $rows[$rowNum]['civicrm_activity_status_id'] = $activityStatus[$value];
618 if (array_key_exists('civicrm_activity_campaign_id', $row)) {
619 if ($value = $row['civicrm_activity_campaign_id']) {
620 $rows[$rowNum]['civicrm_activity_campaign_id'] = $this->activeCampaigns
[$value];
625 if (array_key_exists('civicrm_activity_engagement_level', $row)) {
626 if ($value = $row['civicrm_activity_engagement_level']) {
627 $rows[$rowNum]['civicrm_activity_engagement_level'] = $this->engagementLevels
[$value];
632 if (array_key_exists('civicrm_activity_activity_date_time', $row) && array_key_exists('civicrm_activity_status_id', $row)) {
633 if (CRM_Utils_Date
::overdue($rows[$rowNum]['civicrm_activity_activity_date_time']) &&
634 $activityStatus[$row['civicrm_activity_status_id']] != 'Completed'
636 $rows[$rowNum]['class'] = "status-overdue";
641 $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'activity', 'List all activities for this ') ?
TRUE : $entryFound;
651 * Add Target Contact Address into From Table if required
653 function addAddressFromClause() {
654 // include address field if address column is to be included
655 if ((isset($this->_addressField
) &&
658 $this->isTableSelected('civicrm_address')
661 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
662 ON ({$this->_aliases['civicrm_activity_target']}.contact_id =
663 {$this->_aliases['civicrm_address']}.contact_id) AND
664 {$this->_aliases['civicrm_address']}.is_primary = 1\n";