4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2014
36 class CRM_Activity_BAO_Query
{
39 * build select for Case
44 static function select(&$query) {
45 if (!empty($query->_returnProperties
['activity_id'])) {
46 $query->_select
['activity_id'] = "civicrm_activity.id as activity_id";
47 $query->_element
['activity_id'] = 1;
48 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
51 if (!empty($query->_returnProperties
['activity_type_id'])) {
52 $query->_select
['activity_type_id'] = "activity_type.id as activity_type_id";
53 $query->_element
['activity_type_id'] = 1;
54 $query->_tables
['civicrm_activity'] = 1;
55 $query->_tables
['activity_type'] = 1;
56 $query->_whereTables
['civicrm_activity'] = 1;
57 $query->_whereTables
['activity_type'] = 1;
60 if (!empty($query->_returnProperties
['activity_type'])) {
61 $query->_select
['activity_type'] = "activity_type.label as activity_type,
62 civicrm_activity.activity_type_id as activity_type_id";
63 $query->_element
['activity_type'] = 1;
64 $query->_tables
['civicrm_activity'] = 1;
65 $query->_tables
['activity_type'] = 1;
66 $query->_whereTables
['civicrm_activity'] = 1;
67 $query->_whereTables
['activity_type'] = 1;
70 if (!empty($query->_returnProperties
['activity_subject'])) {
71 $query->_select
['activity_subject'] = "civicrm_activity.subject as activity_subject";
72 $query->_element
['activity_subject'] = 1;
73 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
76 if (!empty($query->_returnProperties
['activity_date_time'])) {
77 $query->_select
['activity_date_time'] = "civicrm_activity.activity_date_time as activity_date_time";
78 $query->_element
['activity_date_time'] = 1;
79 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
82 if (!empty($query->_returnProperties
['activity_status_id'])) {
83 $query->_select
['activity_status_id'] = "activity_status.value as activity_status_id";
84 $query->_element
['activity_status_id'] = 1;
85 $query->_tables
['civicrm_activity'] = 1;
86 $query->_tables
['activity_status'] = 1;
87 $query->_whereTables
['civicrm_activity'] = 1;
88 $query->_whereTables
['activity_status'] = 1;
91 if (!empty($query->_returnProperties
['activity_status'])) {
92 $query->_select
['activity_status'] = "activity_status.label as activity_status";
93 $query->_element
['activity_status'] = 1;
94 $query->_tables
['civicrm_activity'] = 1;
95 $query->_tables
['activity_status'] = 1;
96 $query->_whereTables
['civicrm_activity'] = 1;
97 $query->_whereTables
['activity_status'] = 1;
100 if (!empty($query->_returnProperties
['activity_duration'])) {
101 $query->_select
['activity_duration'] = "civicrm_activity.duration as activity_duration";
102 $query->_element
['activity_duration'] = 1;
103 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
106 if (!empty($query->_returnProperties
['activity_location'])) {
107 $query->_select
['activity_location'] = "civicrm_activity.location as activity_location";
108 $query->_element
['activity_location'] = 1;
109 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
112 if (!empty($query->_returnProperties
['activity_details'])) {
113 $query->_select
['activity_details'] = "civicrm_activity.details as activity_details";
114 $query->_element
['activity_details'] = 1;
115 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
118 if (!empty($query->_returnProperties
['source_record_id'])) {
119 $query->_select
['source_record_id'] = "civicrm_activity.source_record_id as source_record_id";
120 $query->_element
['source_record_id'] = 1;
121 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
124 if (!empty($query->_returnProperties
['activity_is_test'])) {
125 $query->_select
['activity_is_test'] = "civicrm_activity.is_test as activity_is_test";
126 $query->_element
['activity_is_test'] = 1;
127 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
130 if (!empty($query->_returnProperties
['activity_campaign_id'])) {
131 $query->_select
['activity_campaign_id'] = 'civicrm_activity.campaign_id as activity_campaign_id';
132 $query->_element
['activity_campaign_id'] = 1;
133 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
136 if (!empty($query->_returnProperties
['activity_engagement_level'])) {
137 $query->_select
['activity_engagement_level'] = 'civicrm_activity.engagement_level as activity_engagement_level';
138 $query->_element
['activity_engagement_level'] = 1;
139 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
142 if (!empty($query->_returnProperties
['source_contact'])) {
143 $query->_select
['source_contact'] = 'source_contact.sort_name as source_contact';
144 $query->_element
['source_contact'] = 1;
145 $query->_tables
['source_contact'] = $query->_whereTables
['source_contact'] = 1;
148 if (!empty($query->_returnProperties
['activity_result'])) {
149 $query->_select
['activity_result'] = 'civicrm_activity.result as activity_result';
150 $query->_element
['result'] = 1;
151 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
156 * Given a list of conditions in query generate the required
162 static function where(&$query) {
164 foreach (array_keys($query->_params
) as $id) {
165 if (substr($query->_params
[$id][0], 0, 9) == 'activity_') {
166 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
167 $query->_useDistinct
= TRUE;
169 $grouping = $query->_params
[$id][3];
170 self
::whereClauseSingle($query->_params
[$id], $query);
176 * where clause for a single field
181 static function whereClauseSingle(&$values, &$query) {
182 list($name, $op, $value, $grouping, $wildcard) = $values;
184 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
185 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
186 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
187 $query->_skipDeleteClause
= TRUE;
191 case 'activity_type_id':
192 case 'activity_type':
193 $types = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
194 //get the component activity types.
195 $compActTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE, TRUE);
196 $activityTypeIds = self
::buildWhereAndQill($query, $value, $types, $op, $grouping, array('Activity Type', 'civicrm_activity.activity_type_id'));
198 foreach ($activityTypeIds as $activityTypeId) {
199 if (array_key_exists($activityTypeId, $compActTypes)) {
200 CRM_Contact_BAO_Query
::$_considerCompActivities = TRUE;
206 case 'activity_survey_id':
210 $value = CRM_Utils_Type
::escape($value, 'Integer');
211 $query->_where
[$grouping][] = " source_record_id = $value";
212 $query->_qill
[$grouping][] = ts('Survey') . ' - ' . CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $value, 'title');
215 case 'activity_engagement_level':
220 $value = CRM_Utils_Type
::escape($value, 'Integer');
221 $query->_where
[$grouping][] = " engagement_level = $value";
222 $query->_qill
[$grouping][] = ts('Engagement Index') . ' - ' . CRM_Core_OptionGroup
::getLabel('engagement_index', $value);
225 case 'activity_role':
226 CRM_Contact_BAO_Query
::$_activityRole = $values[2];
227 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
228 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
229 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
230 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
233 $query->_tables
['civicrm_activity_contact'] = $query->_whereTables
['civicrm_activity_contact'] = 1;
234 if ($values[2] == 1) {
235 $query->_where
[$grouping][] = " civicrm_activity_contact.record_type_id = $sourceID";
236 $query->_qill
[$grouping][] = ts('Activity created by');
238 else if ($values[2] == 2) {
239 $query->_where
[$grouping][] = " civicrm_activity_contact.record_type_id = $assigneeID";
240 $query->_qill
[$grouping][] = ts('Activity assigned to');
242 else if ($values[2] == 3) {
243 $query->_where
[$grouping][] = " civicrm_activity_contact.record_type_id = $targetID";
244 $query->_qill
[$grouping][] = ts('Activity targeted to');
249 case 'activity_status':
250 $status = CRM_Core_PseudoConstant
::activityStatus();
252 $activityTypeIds = self
::buildWhereAndQill($query, $value, $status, $op, $grouping, array('Activity Status', 'civicrm_activity.status_id'));
255 case 'activity_subject':
257 $value = strtolower(CRM_Core_DAO
::escapeString($n));
259 if (strpos($value, '%') !== FALSE) {
260 // only add wild card if not there
264 $value = "'%$value%'";
271 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_activity.subject)" : "civicrm_activity.subject";
272 $query->_where
[$grouping][] = " $wc $op $value";
273 $query->_qill
[$grouping][] = ts('Subject') . " $op - '$n'";
276 case 'activity_test':
277 // We dont want to include all tests for sql OR CRM-7827
278 if (!$value ||
$query->getOperator() != 'OR') {
279 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_activity.is_test", $op, $value, "Boolean");
281 $query->_qill
[$grouping][] = ts('Activity is a Test');
286 case 'activity_date':
287 case 'activity_date_low':
288 case 'activity_date_high':
289 $query->dateQueryBuilder($values,
290 'civicrm_activity', 'activity_date', 'activity_date_time', ts('Activity Date')
299 if (is_array($value)) {
300 foreach ($value as $k => $v) {
301 $value[$k] = CRM_Utils_Type
::escape($v, 'Integer');
305 $value = array(CRM_Utils_Type
::escape($value, 'Integer'));
307 $query->_where
[$grouping][] = "civicrm_activity.id IN (" . implode(",", $value) . ")";
308 $query->_qill
[$grouping][] = ts('Activity Id(s) %1', array(1 => implode($value)));
311 case 'activity_taglist':
314 foreach ($taglist as $val) {
316 $val = explode(',', $val);
317 foreach ($val as $tId) {
318 if (is_numeric($tId)) {
325 case 'activity_tags':
326 $value = array_keys($value);
327 $activityTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
331 if (is_array($value)) {
332 foreach ($value as $k => $v) {
333 $names[] = $activityTags[$v];
336 $query->_where
[$grouping][] = "civicrm_activity_tag.tag_id IN (" . implode(",", $value) . ")";
337 $query->_qill
[$grouping][] = ts('Activity Tag %1', array(1 => $op)) . ' ' . implode(' ' . ts('OR') . ' ', $names);
338 $query->_tables
['civicrm_activity_tag'] = $query->_whereTables
['civicrm_activity_tag'] = 1;
341 case 'activity_campaign_id':
344 'campaign' => $value,
345 'grouping' => $grouping,
346 'tableName' => 'civicrm_activity',
348 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
350 case 'activity_result':
351 if(is_array($value)) {
353 while(list(,$k) = each($value)) {
354 $safe[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
356 $query->_where
[$grouping][] = "civicrm_activity.result IN (" . implode(',', $safe) . ")";
357 $query->_qill
[$grouping][] = ts("Activity Result - %1", array(1 => implode(' or ', $safe)));
363 static function from($name, $mode, $side) {
366 case 'civicrm_activity':
367 //CRM-7480 we are going to civicrm_activity table either
368 //from civicrm_activity_target or civicrm_activity_assignment.
369 //as component specific activities does not have entry in
370 //activity target table so lets consider civicrm_activity_assignment.
371 $from .= " INNER JOIN civicrm_activity_contact
372 ON ( civicrm_activity_contact.contact_id = contact_a.id ) ";
373 $from .= " INNER JOIN civicrm_activity
374 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
375 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )";
377 $activityRole = CRM_Contact_BAO_Query
::$_activityRole;
380 case 'activity_status':
381 $from .= " $side JOIN civicrm_option_group option_group_activity_status ON (option_group_activity_status.name = 'activity_status')";
382 $from .= " $side JOIN civicrm_option_value activity_status ON (civicrm_activity.status_id = activity_status.value
383 AND option_group_activity_status.id = activity_status.option_group_id ) ";
386 case 'activity_type':
387 $from .= " $side JOIN civicrm_option_group option_group_activity_type ON (option_group_activity_type.name = 'activity_type')";
388 $from .= " $side JOIN civicrm_option_value activity_type ON (civicrm_activity.activity_type_id = activity_type.value
389 AND option_group_activity_type.id = activity_type.option_group_id ) ";
392 case 'civicrm_activity_tag':
393 $from .= " $side JOIN civicrm_entity_tag as civicrm_activity_tag ON ( civicrm_activity_tag.entity_table = 'civicrm_activity' AND civicrm_activity_tag.entity_id = civicrm_activity.id ) ";
396 case 'source_contact':
397 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
398 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
400 LEFT JOIN civicrm_activity_contact ac
401 ON ( ac.activity_id = civicrm_activity_contact.activity_id AND ac.record_type_id = {$sourceID})
402 INNER JOIN civicrm_contact source_contact ON (ac.contact_id = source_contact.id)";
410 * getter for the qill object
416 return (isset($this->_qill
)) ?
$this->_qill
: "";
420 * add all the elements shared between case activity search and advanaced search
424 * @param $form CRM_Core_Form
428 static function buildSearchForm(&$form) {
429 $activityOptions = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
430 asort($activityOptions);
431 foreach ($activityOptions as $activityID => $activity) {
432 $form->_activityElement
=&
435 "activity_type_id[$activityID]",
438 array('onClick' => 'showCustomData( this.id );')
442 CRM_Core_Form_Date
::buildDateRange($form, 'activity_date', 1, '_low', '_high', ts('From'), FALSE, FALSE);
444 $activityRoles = array(
446 2 => ts('Assigned to'),
449 $form->addRadio('activity_role', NULL, $activityRoles, array('allowClear' => TRUE));
450 $form->setDefaults(array('activity_role' => 3));
451 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
452 foreach ($activityStatus as $activityStatusID => $activityStatusName) {
453 $activity_status[] = $form->createElement('checkbox', $activityStatusID, NULL, $activityStatusName);
455 $form->addGroup($activity_status, 'activity_status', ts('Activity Status'), TRUE);
456 $form->setDefaults(array('activity_status[1]' => 1, 'activity_status[2]' => 1));
457 $form->addElement('text', 'activity_subject', ts('Subject'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
458 $form->addYesNo('activity_test', ts('Activity is a Test?'));
459 $activity_tags = CRM_Core_BAO_Tag
::getTags('civicrm_activity');
460 if ($activity_tags) {
461 foreach ($activity_tags as $tagID => $tagName) {
462 $form->_tagElement
= &$form->addElement('checkbox', "activity_tags[$tagID]",
468 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_activity');
469 CRM_Core_Form_Tag
::buildQuickForm($form, $parentNames, 'civicrm_activity', NULL, TRUE, TRUE);
471 $surveys = CRM_Campaign_BAO_Survey
::getSurveys(TRUE, FALSE, FALSE, TRUE);
472 if ($surveys) $form->add('select', 'activity_survey_id', ts('Survey / Petition'),
473 array('' => ts('- none -')) +
$surveys, FALSE,
474 array('class' => 'crm-select2')
477 $extends = array('Activity');
478 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
480 $form->assign('activityGroupTree', $groupDetails);
481 foreach ($groupDetails as $group) {
482 foreach ($group['fields'] as $field) {
483 $fieldId = $field['id'];
484 $elementName = 'custom_' . $fieldId;
485 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $elementName, $fieldId, FALSE, FALSE, TRUE);
490 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'activity_campaign_id');
492 //add engagement level CRM-7775
493 $buildEngagementLevel = FALSE;
494 $buildSurveyResult = FALSE;
495 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable() &&
496 CRM_Campaign_BAO_Campaign
::accessCampaign()
498 $buildEngagementLevel = TRUE;
499 $form->addSelect('activity_engagement_level', array('entity' => 'activity', 'option_url' => NULL));
501 // Add survey result field.
502 $optionGroups = CRM_Campaign_BAO_Survey
::getResultSets( 'name' );
503 $resultOptions = array();
504 foreach ( $optionGroups as $gid => $name ) {
507 $value = CRM_Core_OptionGroup
::values($name);
508 if (!empty($value)) {
509 while(list($k,$v) = each($value)) {
510 $resultOptions[$v] = $v;
515 // If no survey result options have been created, don't build
516 // the field to avoid clutter.
517 if(count($resultOptions) > 0) {
518 $buildSurveyResult = TRUE;
519 asort($resultOptions);
520 $form->add('select', 'activity_result', ts("Survey Result"),
521 $resultOptions, FALSE,
522 array('id' => 'activity_result', 'multiple' => 'multiple', 'class' => 'crm-select2')
527 $form->assign('buildEngagementLevel', $buildEngagementLevel);
528 $form->assign('buildSurveyResult', $buildSurveyResult);
529 $form->setDefaults(array('activity_test' => 0));
532 static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
534 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
538 'contact_sub_type' => 1,
541 'activity_type' => 1,
542 'activity_type_id' => 1,
543 'activity_subject' => 1,
544 'activity_date_time' => 1,
545 'activity_duration' => 1,
546 'activity_location' => 1,
547 'activity_details' => 1,
548 'activity_status' => 1,
549 'source_contact' => 1,
550 'source_record_id' => 1,
551 'activity_is_test' => 1,
552 'activity_campaign_id' => 1,
554 'activity_engagement_level' => 1,
557 if ($includeCustomFields) {
558 // also get all the custom activity properties
559 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Activity');
560 if (!empty($fields)) {
561 foreach ($fields as $name => $dontCare) {
562 $properties[$name] = 1;
571 static function buildWhereAndQill(&$query, $value, $pseudoconstantType, $op, $grouping, $params) {
572 $matches = $val = $clause = array();
574 if (is_array($value)) {
575 foreach ($value as $k => $v) {
581 if (count($val) > 0) {
582 // Overwrite $op so it works with an IN where statement.
586 // If we somehow have an empty array, just return
589 $value = $matches[0] = $val;
592 preg_match_all('/\d+/', $value, $matches);
594 foreach ($matches[0] as $qill) {
595 $clause[] = CRM_Utils_Array
::value($qill, $pseudoconstantType);
598 $query->_qill
[$grouping][] = ts($params[0] . ' %1 ', array(1 => $op)) . implode(' ' . ts('or') . ' ', $clause);
599 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause($params[1],
600 $op, $value, "Integer"