CRM/Activity/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33 class CRM_Activity_BAO_Query {
  34
  35   /**
  36    * Build select for Case.
  37    *
  38    * @param CRM_Contact_BAO_Query $query
  39    */
  40   public static function select(&$query) {
  41     if (!empty($query->_returnProperties['activity_id'])) {
  42       $query->_select['activity_id'] = 'civicrm_activity.id as activity_id';
  43       $query->_element['activity_id'] = 1;
  44       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  45     }
  46
  47     if (!empty($query->_returnProperties['activity_type_id'])) {
  48       $query->_select['activity_type_id'] = 'activity_type.value as activity_type_id';
  49       $query->_element['activity_type_id'] = 1;
  50       $query->_tables['civicrm_activity'] = 1;
  51       $query->_tables['activity_type'] = 1;
  52       $query->_whereTables['civicrm_activity'] = 1;
  53       $query->_whereTables['activity_type'] = 1;
  54     }
  55
  56     if (!empty($query->_returnProperties['activity_type'])) {
  57       $query->_select['activity_type'] = 'activity_type.label as activity_type';
  58       $query->_element['activity_type'] = 1;
  59       $query->_tables['civicrm_activity'] = 1;
  60       $query->_tables['activity_type'] = 1;
  61       $query->_whereTables['civicrm_activity'] = 1;
  62       $query->_whereTables['activity_type'] = 1;
  63     }
  64
  65     if (!empty($query->_returnProperties['activity_subject'])) {
  66       $query->_select['activity_subject'] = 'civicrm_activity.subject as activity_subject';
  67       $query->_element['activity_subject'] = 1;
  68       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  69     }
  70
  71     if (!empty($query->_returnProperties['activity_date_time'])) {
  72       $query->_select['activity_date_time'] = 'civicrm_activity.activity_date_time as activity_date_time';
  73       $query->_element['activity_date_time'] = 1;
  74       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  75     }
  76
  77     if (!empty($query->_returnProperties['activity_status_id'])) {
  78       $query->_select['activity_status_id'] = 'civicrm_activity.status_id as activity_status_id';
  79       $query->_element['activity_status_id'] = 1;
  80       $query->_tables['civicrm_activity'] = 1;
  81       $query->_whereTables['civicrm_activity'] = 1;
  82     }
  83
  84     if (!empty($query->_returnProperties['activity_status'])) {
  85       $query->_select['activity_status'] = 'activity_status.label as activity_status,
  86       civicrm_activity.status_id as status_id';
  87       $query->_element['activity_status'] = 1;
  88       $query->_tables['civicrm_activity'] = 1;
  89       $query->_tables['activity_status'] = 1;
  90       $query->_whereTables['civicrm_activity'] = 1;
  91       $query->_whereTables['activity_status'] = 1;
  92     }
  93
  94     if (!empty($query->_returnProperties['activity_duration'])) {
  95       $query->_select['activity_duration'] = 'civicrm_activity.duration as activity_duration';
  96       $query->_element['activity_duration'] = 1;
  97       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  98     }
  99
 100     if (!empty($query->_returnProperties['activity_location'])) {
 101       $query->_select['activity_location'] = 'civicrm_activity.location as activity_location';
 102       $query->_element['activity_location'] = 1;
 103       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 104     }
 105
 106     if (!empty($query->_returnProperties['activity_details'])) {
 107       $query->_select['activity_details'] = 'civicrm_activity.details as activity_details';
 108       $query->_element['activity_details'] = 1;
 109       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 110     }
 111
 112     if (!empty($query->_returnProperties['source_record_id'])) {
 113       $query->_select['source_record_id'] = 'civicrm_activity.source_record_id as source_record_id';
 114       $query->_element['source_record_id'] = 1;
 115       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 116     }
 117
 118     if (!empty($query->_returnProperties['activity_is_test'])) {
 119       $query->_select['activity_is_test'] = 'civicrm_activity.is_test as activity_is_test';
 120       $query->_element['activity_is_test'] = 1;
 121       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 122     }
 123
 124     if (!empty($query->_returnProperties['activity_campaign_id'])) {
 125       $query->_select['activity_campaign_id'] = 'civicrm_activity.campaign_id as activity_campaign_id';
 126       $query->_element['activity_campaign_id'] = 1;
 127       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 128     }
 129
 130     if (!empty($query->_returnProperties['activity_engagement_level'])) {
 131       $query->_select['activity_engagement_level'] = 'civicrm_activity.engagement_level as activity_engagement_level';
 132       $query->_element['activity_engagement_level'] = 1;
 133       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 134     }
 135
 136     if (!empty($query->_returnProperties['source_contact'])) {
 137       $query->_select['source_contact'] = 'source_contact.sort_name as source_contact';
 138       $query->_element['source_contact'] = 1;
 139       $query->_tables['civicrm_activity'] = $query->_tables['source_contact'] = $query->_whereTables['source_contact'] = 1;
 140     }
 141
 142     if (!empty($query->_returnProperties['source_contact_id'])) {
 143       $query->_select['source_contact_id'] = 'source_contact.id as source_contact_id';
 144       $query->_element['source_contact_id'] = 1;
 145       $query->_tables['civicrm_activity'] = $query->_tables['source_contact'] = $query->_whereTables['source_contact'] = 1;
 146     }
 147
 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;
 152     }
 153
 154     if (CRM_Utils_Array::value('parent_id', $query->_returnProperties)) {
 155       $query->_tables['parent_id'] = 1;
 156       $query->_whereTables['parent_id'] = 1;
 157       $query->_element['parent_id'] = 1;
 158     }
 159
 160     if (!empty($query->_returnProperties['activity_priority'])) {
 161       $query->_select['activity_priority'] = 'activity_priority.label as activity_priority,
 162       civicrm_activity.priority_id as priority_id';
 163       $query->_element['activity_priority'] = 1;
 164       $query->_tables['activity_priority'] = 1;
 165       $query->_whereTables['activity_priority'] = 1;
 166       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 167     }
 168   }
 169
 170   /**
 171    * Given a list of conditions in query generate the required where clause.
 172    *
 173    * @param $query
 174    */
 175   public static function where(&$query) {
 176     foreach (array_keys($query->_params) as $id) {
 177       if (substr($query->_params[$id][0], 0, 9) == 'activity_') {
 178         if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
 179           $query->_useDistinct = TRUE;
 180         }
 181         $query->_params[$id][3];
 182         self::whereClauseSingle($query->_params[$id], $query);
 183       }
 184     }
 185   }
 186
 187   /**
 188    * Where clause for a single field.
 189    *
 190    * @param array $values
 191    * @param CRM_Contact_BAO_Query $query
 192    */
 193   public static function whereClauseSingle(&$values, &$query) {
 194     list($name, $op, $value, $grouping) = $values;
 195
 196     $fields = CRM_Activity_BAO_Activity::exportableFields();
 197     $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 198     if ($query->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
 199       $query->_skipDeleteClause = TRUE;
 200     }
 201
 202     switch ($name) {
 203       case 'activity_type_id':
 204       case 'activity_status_id':
 205       case 'activity_engagement_level':
 206       case 'activity_id':
 207       case 'activity_campaign_id':
 208       case 'activity_priority_id':
 209         // We no longer expect "subject" as a specific criteria (as of CRM-19447),
 210         // but we still use activity_subject in Activity.Get API
 211       case 'activity_subject':
 212
 213         $qillName = $name;
 214         if (in_array($name, array('activity_engagement_level', 'activity_id'))) {
 215           $name = $qillName = str_replace('activity_', '', $name);
 216         }
 217         if (in_array($name, array('activity_status_id', 'activity_subject', 'activity_priority_id'))) {
 218           $name = str_replace('activity_', '', $name);
 219           $qillName = str_replace('_id', '', $qillName);
 220         }
 221         if ($name == 'activity_campaign_id') {
 222           $name  = 'campaign_id';
 223         }
 224
 225         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 226
 227         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_activity.$name", $op, $value, $dataType);
 228         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Activity_DAO_Activity', $name, $value, $op);
 229         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
 230         break;
 231
 232       case 'activity_text':
 233         self::whereClauseSingleActivityText($values, $query);
 234         break;
 235
 236       case 'activity_type':
 237       case 'activity_status':
 238       case 'activity_priority':
 239         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$name.label", $op, $value, 'String');
 240         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Activity_DAO_Activity', $name, $value, $op);
 241         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 242         $query->_tables[$name] = $query->_whereTables[$name] = 1;
 243         break;
 244
 245       case 'activity_survey_id':
 246         if (!$value) {
 247           break;
 248         }
 249         $value = CRM_Utils_Type::escape($value, 'Integer');
 250         $query->_where[$grouping][] = " civicrm_activity.source_record_id = $value";
 251         $query->_qill[$grouping][] = ts('Survey') . ' - ' . CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Survey', $value, 'title');
 252         break;
 253
 254       case 'activity_role':
 255         CRM_Contact_BAO_Query::$_activityRole = $values[2];
 256         $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
 257         $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
 258         $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
 259         $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
 260
 261         if ($values[2]) {
 262           $query->_tables['civicrm_activity_contact'] = $query->_whereTables['civicrm_activity_contact'] = 1;
 263           if ($values[2] == 1) {
 264             $query->_where[$grouping][] = " civicrm_activity_contact.record_type_id = $sourceID";
 265             $query->_qill[$grouping][] = ts('Activity created by');
 266           }
 267           elseif ($values[2] == 2) {
 268             $query->_where[$grouping][] = " civicrm_activity_contact.record_type_id = $assigneeID";
 269             $query->_qill[$grouping][] = ts('Activity assigned to');
 270           }
 271           elseif ($values[2] == 3) {
 272             $query->_where[$grouping][] = " civicrm_activity_contact.record_type_id = $targetID";
 273             $query->_qill[$grouping][] = ts('Activity targeted to');
 274           }
 275         }
 276         break;
 277
 278       case 'activity_test':
 279         // We don't want to include all tests for sql OR CRM-7827
 280         if (!$value || $query->getOperator() != 'OR') {
 281           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_activity.is_test", $op, $value, "Boolean");
 282           if ($value) {
 283             $query->_qill[$grouping][] = ts('Activity is a Test');
 284           }
 285         }
 286         break;
 287
 288       case 'activity_date':
 289       case 'activity_date_low':
 290       case 'activity_date_high':
 291         $query->dateQueryBuilder($values,
 292           'civicrm_activity', 'activity_date', 'activity_date_time', ts('Activity Date')
 293         );
 294         break;
 295
 296       case 'activity_taglist':
 297         $taglist = $value;
 298         $value = array();
 299         foreach ($taglist as $val) {
 300           if ($val) {
 301             $val = explode(',', $val);
 302             foreach ($val as $tId) {
 303               if (is_numeric($tId)) {
 304                 $value[$tId] = 1;
 305               }
 306             }
 307           }
 308         }
 309
 310       case 'activity_tags':
 311         $value = array_keys($value);
 312         $activityTags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
 313
 314         $names = array();
 315         if (is_array($value)) {
 316           foreach ($value as $k => $v) {
 317             $names[] = $activityTags[$v];
 318           }
 319         }
 320         $query->_where[$grouping][] = "civicrm_activity_tag.tag_id IN (" . implode(",", $value) . ")";
 321         $query->_qill[$grouping][] = ts('Activity Tag %1', array(1 => $op)) . ' ' . implode(' ' . ts('OR') . ' ', $names);
 322         $query->_tables['civicrm_activity_tag'] = $query->_whereTables['civicrm_activity_tag'] = 1;
 323         break;
 324
 325       case 'activity_result':
 326         if (is_array($value)) {
 327           $safe = [];
 328           foreach ($value as $id => $k) {
 329             $safe[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
 330           }
 331           $query->_where[$grouping][] = "civicrm_activity.result IN (" . implode(',', $safe) . ")";
 332           $query->_qill[$grouping][] = ts("Activity Result - %1", array(1 => implode(' or ', $safe)));
 333         }
 334         break;
 335
 336       case 'parent_id':
 337         if ($value == 1) {
 338           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NOT NULL";
 339           $query->_qill[$grouping][] = ts('Activities which have Followup Activities');
 340         }
 341         elseif ($value == 2) {
 342           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NULL";
 343           $query->_qill[$grouping][] = ts('Activities without Followup Activities');
 344         }
 345         break;
 346
 347       case 'followup_parent_id':
 348         if ($value == 1) {
 349           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NOT NULL";
 350           $query->_qill[$grouping][] = ts('Activities which are Followup Activities');
 351         }
 352         elseif ($value == 2) {
 353           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NULL";
 354           $query->_qill[$grouping][] = ts('Activities which are not Followup Activities');
 355         }
 356         break;
 357
 358       case 'source_contact':
 359       case 'source_contact_id':
 360         $columnName = strstr($name, '_id') ? 'id' : 'sort_name';
 361         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("source_contact.{$columnName}", $op, $value, CRM_Utils_Type::typeToString($fields[$name]['type']));
 362         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Contact', $columnName, $value, $op);
 363         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 364         break;
 365     }
 366   }
 367
 368   /**
 369    * @param string $name
 370    * @param $mode
 371    * @param $side
 372    *
 373    * @return null|string
 374    */
 375   public static function from($name, $mode, $side) {
 376     $from = NULL;
 377     switch ($name) {
 378       case 'civicrm_activity':
 379         //CRM-7480 we are going to civicrm_activity table either
 380         //from civicrm_activity_target or civicrm_activity_assignment.
 381         //as component specific activities does not have entry in
 382         //activity target table so lets consider civicrm_activity_assignment.
 383         $from .= " $side JOIN civicrm_activity_contact
 384                       ON ( civicrm_activity_contact.contact_id = contact_a.id ) ";
 385         $from .= " $side JOIN civicrm_activity
 386                       ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
 387                       AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )";
 388         // Do not show deleted contact's activity
 389         $from .= " INNER JOIN civicrm_contact
 390                       ON ( civicrm_activity_contact.contact_id = civicrm_contact.id and civicrm_contact.is_deleted != 1 )";
 391         break;
 392
 393       case 'activity_status':
 394         $from .= " $side JOIN civicrm_option_group option_group_activity_status ON (option_group_activity_status.name = 'activity_status')";
 395         $from .= " $side JOIN civicrm_option_value activity_status ON (civicrm_activity.status_id = activity_status.value
 396                                AND option_group_activity_status.id = activity_status.option_group_id ) ";
 397         break;
 398
 399       case 'activity_type':
 400         $from .= " $side JOIN civicrm_option_group option_group_activity_type ON (option_group_activity_type.name = 'activity_type')";
 401         $from .= " $side JOIN civicrm_option_value activity_type ON (civicrm_activity.activity_type_id = activity_type.value
 402                                AND option_group_activity_type.id = activity_type.option_group_id ) ";
 403         break;
 404
 405       case 'activity_priority':
 406         $from .= " $side JOIN civicrm_option_group option_group_activity_priority ON (option_group_activity_priority.name = 'priority')";
 407         $from .= " $side JOIN civicrm_option_value activity_priority ON (civicrm_activity.priority_id = activity_priority.value
 408                               AND option_group_activity_priority.id = activity_priority.option_group_id ) ";
 409         break;
 410
 411       case 'civicrm_activity_tag':
 412         $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 ) ";
 413         break;
 414
 415       case 'source_contact':
 416         $sourceID = CRM_Core_PseudoConstant::getKey(
 417           'CRM_Activity_BAO_ActivityContact',
 418           'record_type_id',
 419           'Activity Source'
 420         );
 421         $from = "
 422           LEFT JOIN civicrm_activity_contact source_activity
 423             ON (source_activity.activity_id = civicrm_activity_contact.activity_id
 424               AND source_activity.record_type_id = {$sourceID})
 425           LEFT JOIN civicrm_contact source_contact ON (source_activity.contact_id = source_contact.id)";
 426         break;
 427
 428       case 'parent_id':
 429         $from = "$side JOIN civicrm_activity AS parent_id ON civicrm_activity.id = parent_id.parent_id";
 430         break;
 431     }
 432
 433     return $from;
 434   }
 435
 436   /**
 437    * Get the metadata for fields to be included on the activity search form.
 438    *
 439    * @todo ideally this would be a trait included on the activity search & advanced search
 440    * rather than a static function.
 441    */
 442   public static function getSearchFieldMetadata() {
 443     $fields = ['activity_type_id'];
 444     $metadata = civicrm_api3('Activity', 'getfields', [])['values'];
 445     return array_intersect_key($metadata, array_flip($fields));
 446   }
 447
 448   /**
 449    * Add all the elements shared between case activity search and advanced search.
 450    *
 451    * @param CRM_Core_Form_Search $form
 452    */
 453   public static function buildSearchForm(&$form) {
 454     $form->addSearchFieldMetadata(['Activity' => self::getSearchFieldMetadata()]);
 455     $form->addFormFieldsFromMetadata();
 456
 457     CRM_Core_Form_Date::buildDateRange($form, 'activity_date', 1, '_low', '_high', ts('From'), FALSE, FALSE);
 458     $form->addElement('hidden', 'activity_date_range_error');
 459     $form->addFormRule(array('CRM_Activity_BAO_Query', 'formRule'), $form);
 460
 461     $followUpActivity = array(
 462       1 => ts('Yes'),
 463       2 => ts('No'),
 464     );
 465     $form->addRadio('parent_id', NULL, $followUpActivity, array('allowClear' => TRUE));
 466     $form->addRadio('followup_parent_id', NULL, $followUpActivity, array('allowClear' => TRUE));
 467     $activityRoles = array(
 468       3 => ts('With'),
 469       2 => ts('Assigned to'),
 470       1 => ts('Added by'),
 471     );
 472     $form->addRadio('activity_role', NULL, $activityRoles, array('allowClear' => TRUE));
 473     $form->setDefaults(array('activity_role' => 3));
 474     $activityStatus = CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'status_id', array('flip' => 1, 'labelColumn' => 'name'));
 475     $form->addSelect('status_id',
 476       array('entity' => 'activity', 'multiple' => 'multiple', 'option_url' => NULL, 'placeholder' => ts('- any -'))
 477     );
 478     $ssID = $form->get('ssID');
 479     $status = array($activityStatus['Completed'], $activityStatus['Scheduled']);
 480     //If status is saved in smart group.
 481     if (!empty($ssID) && !empty($form->_formValues['activity_status_id'])) {
 482       $status = $form->_formValues['activity_status_id'];
 483     }
 484     $form->setDefaults(array('status_id' => $status));
 485
 486     $form->addElement('text', 'activity_text', ts('Activity Text'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
 487
 488     $form->addRadio('activity_option', '', CRM_Core_SelectValues::activityTextOptions());
 489     $form->setDefaults(array('activity_option' => 'both'));
 490
 491     $priority = CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'priority_id');
 492     $form->addSelect('priority_id',
 493     array('entity' => 'activity', 'label' => ts('Priority'), 'multiple' => 'multiple', 'option_url' => NULL, 'placeholder' => ts('- any -'))
 494     );
 495
 496     $form->addYesNo('activity_test', ts('Activity is a Test?'));
 497     $activity_tags = CRM_Core_BAO_Tag::getTags('civicrm_activity');
 498     if ($activity_tags) {
 499       foreach ($activity_tags as $tagID => $tagName) {
 500         $form->_tagElement = &$form->addElement('checkbox', "activity_tags[$tagID]",
 501           NULL, $tagName
 502         );
 503       }
 504     }
 505
 506     $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_activity');
 507     CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_activity', NULL, TRUE, TRUE);
 508
 509     $surveys = CRM_Campaign_BAO_Survey::getSurveys(TRUE, FALSE, FALSE, TRUE);
 510     if ($surveys) {
 511       $form->add('select', 'activity_survey_id', ts('Survey / Petition'),
 512                  array('' => ts('- none -')) + $surveys, FALSE,
 513                  array('class' => 'crm-select2')
 514                  );
 515     }
 516
 517     CRM_Core_BAO_Query::addCustomFormFields($form, array('Activity'));
 518
 519     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'activity_campaign_id');
 520
 521     // Add engagement level CRM-7775.
 522     $buildEngagementLevel = FALSE;
 523     $buildSurveyResult = FALSE;
 524     if (CRM_Campaign_BAO_Campaign::isCampaignEnable() &&
 525       CRM_Campaign_BAO_Campaign::accessCampaign()
 526     ) {
 527       $buildEngagementLevel = TRUE;
 528       $form->addSelect('activity_engagement_level', array('entity' => 'activity', 'context' => 'search'));
 529
 530       // Add survey result field.
 531       $optionGroups = CRM_Campaign_BAO_Survey::getResultSets('name');
 532       $resultOptions = array();
 533       foreach ($optionGroups as $gid => $name) {
 534         if ($name) {
 535           $value = CRM_Core_OptionGroup::values($name);
 536           if (!empty($value)) {
 537             foreach ($value as $k => $v) {
 538               $resultOptions[$v] = $v;
 539             }
 540           }
 541         }
 542       }
 543       // If no survey result options have been created, don't build
 544       // the field to avoid clutter.
 545       if (count($resultOptions) > 0) {
 546         $buildSurveyResult = TRUE;
 547         asort($resultOptions);
 548         $form->add('select', 'activity_result', ts("Survey Result"),
 549           $resultOptions, FALSE,
 550           array('id' => 'activity_result', 'multiple' => 'multiple', 'class' => 'crm-select2')
 551         );
 552       }
 553     }
 554
 555     $form->assign('buildEngagementLevel', $buildEngagementLevel);
 556     $form->assign('buildSurveyResult', $buildSurveyResult);
 557     $form->setDefaults(array('activity_test' => 0));
 558   }
 559
 560   /**
 561    * @param $mode
 562    * @param bool $includeCustomFields
 563    *
 564    * @return array|null
 565    */
 566   public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
 567     $properties = NULL;
 568     if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
 569       $properties = array(
 570         'activity_id' => 1,
 571         'contact_type' => 1,
 572         'contact_sub_type' => 1,
 573         'sort_name' => 1,
 574         'display_name' => 1,
 575         'activity_type' => 1,
 576         'activity_type_id' => 1,
 577         'activity_subject' => 1,
 578         'activity_date_time' => 1,
 579         'activity_duration' => 1,
 580         'activity_location' => 1,
 581         'activity_details' => 1,
 582         'activity_status' => 1,
 583         'activity_priority' => 1,
 584         'source_contact' => 1,
 585         'source_record_id' => 1,
 586         'activity_is_test' => 1,
 587         'activity_campaign_id' => 1,
 588         'result' => 1,
 589         'activity_engagement_level' => 1,
 590         'parent_id' => 1,
 591       );
 592
 593       if ($includeCustomFields) {
 594         // also get all the custom activity properties
 595         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Activity');
 596         if (!empty($fields)) {
 597           foreach ($fields as $name => $dontCare) {
 598             $properties[$name] = 1;
 599           }
 600         }
 601       }
 602     }
 603
 604     return $properties;
 605   }
 606
 607   /**
 608    * Get the list of fields required to populate the selector.
 609    *
 610    * The default return properties array returns far too many fields for 'everyday use. Every field you add to this array
 611    * kills a small kitten so add carefully.
 612    */
 613   public static function selectorReturnProperties() {
 614     $properties = array(
 615       'activity_id' => 1,
 616       'contact_type' => 1,
 617       'contact_sub_type' => 1,
 618       'sort_name' => 1,
 619       'display_name' => 1,
 620       'activity_type_id' => 1,
 621       'activity_subject' => 1,
 622       'activity_date_time' => 1,
 623       'activity_status_id' => 1,
 624       'source_contact' => 1,
 625       'source_record_id' => 1,
 626       'activity_is_test' => 1,
 627       'activity_campaign_id' => 1,
 628       'activity_engagement_level' => 1,
 629     );
 630
 631     return $properties;
 632   }
 633
 634   /**
 635    * Custom form rules.
 636    *
 637    * @param array $fields
 638    * @param array $files
 639    * @param CRM_Core_Form $form
 640    *
 641    * @return bool|array
 642    */
 643   public static function formRule($fields, $files, $form) {
 644     $errors = array();
 645
 646     if (empty($fields['activity_date_low']) || empty($fields['activity_date_high'])) {
 647       return TRUE;
 648     }
 649
 650     CRM_Utils_Rule::validDateRange($fields, 'activity_date', $errors, ts('Activity Date'));
 651
 652     return empty($errors) ? TRUE : $errors;
 653   }
 654
 655   /**
 656    * Where/qill clause for notes
 657    *
 658    * @param array $values
 659    */
 660   public static function whereClauseSingleActivityText(&$values, &$query) {
 661     list($name, $op, $value, $grouping, $wildcard) = $values;
 662     $activityOptionValues = $query->getWhereValues('activity_option', $grouping);
 663     $activityOption = CRM_Utils_Array::value(2, $activityOptionValues, 6);
 664
 665     $query->_useDistinct = TRUE;
 666
 667     $label = ts('Activity Text (%1)', array(1 => CRM_Utils_Array::value($activityOption, CRM_Core_SelectValues::activityTextOptions())));
 668     $clauses = array();
 669     if ($activityOption % 2 == 0) {
 670       $clauses[] = $query->buildClause('civicrm_activity.details', $op, $value, 'String');
 671     }
 672     if ($activityOption % 3 == 0) {
 673       $clauses[] = $query->buildClause('civicrm_activity.subject', $op, $value, 'String');
 674     }
 675
 676     $query->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
 677     list($qillOp, $qillVal) = $query->buildQillForFieldValue(NULL, $name, $value, $op);
 678     $query->_qill[$grouping][] = ts("%1 %2 '%3'", array(1 => $label, 2 => $qillOp, 3 => $qillVal));
 679   }
 680
 681 }