CRM/Contact/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This is the heart of the search query building mechanism.
  38  */
  39 class CRM_Contact_BAO_Query {
  40
  41   /**
  42    * The various search modes.
  43    *
  44    * @var int
  45    */
  46   const
  47     MODE_CONTACTS = 1,
  48     MODE_CONTRIBUTE = 2,
  49     MODE_MEMBER = 8,
  50     MODE_EVENT = 16,
  51     MODE_GRANT = 128,
  52     MODE_PLEDGEBANK = 256,
  53     MODE_PLEDGE = 512,
  54     MODE_CASE = 2048,
  55     MODE_ALL = 17407,
  56     MODE_ACTIVITY = 4096,
  57     MODE_CAMPAIGN = 8192,
  58     MODE_MAILING = 16384;
  59
  60   /**
  61    * The default set of return properties.
  62    *
  63    * @var array
  64    */
  65   static $_defaultReturnProperties = NULL;
  66
  67   /**
  68    * The default set of hier return properties.
  69    *
  70    * @var array
  71    */
  72   static $_defaultHierReturnProperties;
  73
  74   /**
  75    * The set of input params.
  76    *
  77    * @var array
  78    */
  79   public $_params;
  80
  81   public $_cfIDs;
  82
  83   public $_paramLookup;
  84
  85   public $_sort;
  86   /**
  87    * The set of output params
  88    *
  89    * @var array
  90    */
  91   public $_returnProperties;
  92
  93   /**
  94    * The select clause
  95    *
  96    * @var array
  97    */
  98   public $_select;
  99
 100   /**
 101    * The name of the elements that are in the select clause
 102    * used to extract the values
 103    *
 104    * @var array
 105    */
 106   public $_element;
 107
 108   /**
 109    * The tables involved in the query
 110    *
 111    * @var array
 112    */
 113   public $_tables;
 114
 115   /**
 116    * The table involved in the where clause
 117    *
 118    * @var array
 119    */
 120   public $_whereTables;
 121
 122   /**
 123    * The where clause
 124    *
 125    * @var array
 126    */
 127   public $_where;
 128
 129   /**
 130    * The where string
 131    *
 132    * @var string
 133    */
 134   public $_whereClause;
 135
 136   /**
 137    * Additional permission Where Clause
 138    *
 139    * @var string
 140    */
 141   public $_permissionWhereClause;
 142
 143   /**
 144    * The from string
 145    *
 146    * @var string
 147    */
 148   public $_fromClause;
 149
 150   /**
 151    * Additional permission from clause
 152    *
 153    * @var string
 154    */
 155   public $_permissionFromClause;
 156
 157   /**
 158    * The from clause for the simple select and alphabetical
 159    * select
 160    *
 161    * @var string
 162    */
 163   public $_simpleFromClause;
 164
 165   /**
 166    * The having values
 167    *
 168    * @var string
 169    */
 170   public $_having;
 171
 172   /**
 173    * The english language version of the query
 174    *
 175    * @var array
 176    */
 177   public $_qill;
 178
 179   /**
 180    * All the fields that could potentially be involved in
 181    * this query
 182    *
 183    * @var array
 184    */
 185   public $_fields;
 186
 187   /**
 188    * The cache to translate the option values into labels.
 189    *
 190    * @var array
 191    */
 192   public $_options;
 193
 194   /**
 195    * Are we in search mode.
 196    *
 197    * @var boolean
 198    */
 199   public $_search = TRUE;
 200
 201   /**
 202    * Should we skip permission checking.
 203    *
 204    * @var boolean
 205    */
 206   public $_skipPermission = FALSE;
 207
 208   /**
 209    * Should we skip adding of delete clause.
 210    *
 211    * @var boolean
 212    */
 213   public $_skipDeleteClause = FALSE;
 214
 215   /**
 216    * Are we in strict mode (use equality over LIKE)
 217    *
 218    * @var boolean
 219    */
 220   public $_strict = FALSE;
 221
 222   /**
 223    * What operator to use to group the clauses.
 224    *
 225    * @var string
 226    */
 227   public $_operator = 'AND';
 228
 229   public $_mode = 1;
 230
 231   /**
 232    * Should we only search on primary location.
 233    *
 234    * @var boolean
 235    */
 236   public $_primaryLocation = TRUE;
 237
 238   /**
 239    * Are contact ids part of the query.
 240    *
 241    * @var boolean
 242    */
 243   public $_includeContactIds = FALSE;
 244
 245   /**
 246    * Should we use the smart group cache.
 247    *
 248    * @var boolean
 249    */
 250   public $_smartGroupCache = TRUE;
 251
 252   /**
 253    * Should we display contacts with a specific relationship type.
 254    *
 255    * @var string
 256    */
 257   public $_displayRelationshipType = NULL;
 258
 259   /**
 260    * Reference to the query object for custom values.
 261    *
 262    * @var Object
 263    */
 264   public $_customQuery;
 265
 266   /**
 267    * Should we enable the distinct clause, used if we are including
 268    * more than one group
 269    *
 270    * @var boolean
 271    */
 272   public $_useDistinct = FALSE;
 273
 274   /**
 275    * Should we just display one contact record
 276    */
 277   public $_useGroupBy = FALSE;
 278
 279   /**
 280    * The relationship type direction
 281    *
 282    * @var array
 283    */
 284   static $_relType;
 285
 286   /**
 287    * The activity role
 288    *
 289    * @var array
 290    */
 291   static $_activityRole;
 292
 293   /**
 294    * Consider the component activity type
 295    * during activity search.
 296    *
 297    * @var array
 298    */
 299   static $_considerCompActivities;
 300
 301   /**
 302    * Consider with contact activities only,
 303    * during activity search.
 304    *
 305    * @var array
 306    */
 307   static $_withContactActivitiesOnly;
 308
 309   /**
 310    * Use distinct component clause for component searches
 311    *
 312    * @var string
 313    */
 314   public $_distinctComponentClause;
 315
 316   public $_rowCountClause;
 317
 318   /**
 319    * Use groupBy component clause for component searches
 320    *
 321    * @var string
 322    */
 323   public $_groupByComponentClause;
 324
 325   /**
 326    * Track open panes, useful in advance search
 327    *
 328    * @var array
 329    */
 330   public static $_openedPanes = array();
 331
 332   /**
 333    * For search builder - which custom fields are location-dependent
 334    * @var array
 335    */
 336   public $_locationSpecificCustomFields = array();
 337
 338   /**
 339    * The tables which have a dependency on location and/or address
 340    *
 341    * @var array
 342    */
 343   static $_dependencies = array(
 344     'civicrm_state_province' => 1,
 345     'civicrm_country' => 1,
 346     'civicrm_county' => 1,
 347     'civicrm_address' => 1,
 348     'civicrm_location_type' => 1,
 349   );
 350
 351   /**
 352    * List of location specific fields.
 353    */
 354   static $_locationSpecificFields = array(
 355     'street_address',
 356     'street_number',
 357     'street_name',
 358     'street_unit',
 359     'supplemental_address_1',
 360     'supplemental_address_2',
 361     'city',
 362     'postal_code',
 363     'postal_code_suffix',
 364     'geo_code_1',
 365     'geo_code_2',
 366     'state_province',
 367     'country',
 368     'county',
 369     'phone',
 370     'email',
 371     'im',
 372     'address_name',
 373   );
 374
 375   /**
 376    * Remember if we handle either end of a number or date range
 377    * so we can skip the other
 378    */
 379   protected $_rangeCache = array();
 380   /**
 381    * Set to true when $this->relationship is run to avoid adding twice
 382    * @var Boolean
 383    */
 384   protected $_relationshipValuesAdded = FALSE;
 385
 386   /**
 387    * Set to the name of the temp table if one has been created
 388    * @var String
 389    */
 390   static $_relationshipTempTable = NULL;
 391
 392   public $_pseudoConstantsSelect = array();
 393
 394   /**
 395    * Class constructor which also does all the work.
 396    *
 397    * @param array $params
 398    * @param array $returnProperties
 399    * @param array $fields
 400    * @param bool $includeContactIds
 401    * @param bool $strict
 402    * @param bool|int $mode - mode the search is operating on
 403    *
 404    * @param bool $skipPermission
 405    * @param bool $searchDescendentGroups
 406    * @param bool $smartGroupCache
 407    * @param null $displayRelationshipType
 408    * @param string $operator
 409    *
 410    * @return \CRM_Contact_BAO_Query
 411    */
 412   public function __construct(
 413     $params = NULL, $returnProperties = NULL, $fields = NULL,
 414     $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
 415     $skipPermission = FALSE, $searchDescendentGroups = TRUE,
 416     $smartGroupCache = TRUE, $displayRelationshipType = NULL,
 417     $operator = 'AND'
 418   ) {
 419     $this->_params = &$params;
 420     if ($this->_params == NULL) {
 421       $this->_params = array();
 422     }
 423
 424     if (empty($returnProperties)) {
 425       $this->_returnProperties = self::defaultReturnProperties($mode);
 426     }
 427     else {
 428       $this->_returnProperties = &$returnProperties;
 429     }
 430
 431     $this->_includeContactIds = $includeContactIds;
 432     $this->_strict = $strict;
 433     $this->_mode = $mode;
 434     $this->_skipPermission = $skipPermission;
 435     $this->_smartGroupCache = $smartGroupCache;
 436     $this->_displayRelationshipType = $displayRelationshipType;
 437     $this->setOperator($operator);
 438
 439     if ($fields) {
 440       $this->_fields = &$fields;
 441       $this->_search = FALSE;
 442       $this->_skipPermission = TRUE;
 443     }
 444     else {
 445       $this->_fields = CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE, TRUE);
 446
 447       $fields = CRM_Core_Component::getQueryFields();
 448       unset($fields['note']);
 449       $this->_fields = array_merge($this->_fields, $fields);
 450
 451       // add activity fields
 452       $fields = CRM_Activity_BAO_Activity::exportableFields();
 453       $this->_fields = array_merge($this->_fields, $fields);
 454
 455       // add any fields provided by hook implementers
 456       $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields();
 457       $this->_fields = array_merge($this->_fields, $extFields);
 458     }
 459
 460     // basically do all the work once, and then reuse it
 461     $this->initialize();
 462   }
 463
 464   /**
 465    * Function which actually does all the work for the constructor.
 466    *
 467    * @return void
 468    */
 469   public function initialize() {
 470     $this->_select = array();
 471     $this->_element = array();
 472     $this->_tables = array();
 473     $this->_whereTables = array();
 474     $this->_where = array();
 475     $this->_qill = array();
 476     $this->_options = array();
 477     $this->_cfIDs = array();
 478     $this->_paramLookup = array();
 479     $this->_having = array();
 480
 481     $this->_customQuery = NULL;
 482
 483     // reset cached static variables - CRM-5803
 484     self::$_activityRole = NULL;
 485     self::$_considerCompActivities = NULL;
 486     self::$_withContactActivitiesOnly = NULL;
 487
 488     $this->_select['contact_id'] = 'contact_a.id as contact_id';
 489     $this->_element['contact_id'] = 1;
 490     $this->_tables['civicrm_contact'] = 1;
 491
 492     if (!empty($this->_params)) {
 493       $this->buildParamsLookup();
 494     }
 495
 496     $this->_whereTables = $this->_tables;
 497
 498     $this->selectClause();
 499     $this->_whereClause = $this->whereClause();
 500
 501     $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
 502     $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
 503
 504     $this->openedSearchPanes(TRUE);
 505   }
 506
 507   public function buildParamsLookup() {
 508     // first fix and handle contact deletion nicely
 509     // this code is primarily for search builder use case
 510     // where different clauses can specify if they want deleted
 511     // contacts or not
 512     // CRM-11971
 513     $trashParamExists = FALSE;
 514     $paramByGroup = array();
 515     foreach ($this->_params as $k => $param) {
 516       if (!empty($param[0]) && $param[0] == 'contact_is_deleted') {
 517         $trashParamExists = TRUE;
 518       }
 519       if (!empty($param[3])) {
 520         $paramByGroup[$param[3]][$k] = $param;
 521       }
 522     }
 523
 524     if ($trashParamExists) {
 525       $this->_skipDeleteClause = TRUE;
 526
 527       //cycle through group sets and explicitly add trash param if not set
 528       foreach ($paramByGroup as $setID => $set) {
 529         if (
 530           !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params) &&
 531           !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params)
 532         ) {
 533           $this->_params[] = array(
 534             'contact_is_deleted',
 535             '=',
 536             '0',
 537             $setID,
 538             '0',
 539           );
 540         }
 541       }
 542     }
 543
 544     foreach ($this->_params as $value) {
 545       if (empty($value[0])) {
 546         continue;
 547       }
 548       $cfID = CRM_Core_BAO_CustomField::getKeyID($value[0]);
 549       if ($cfID) {
 550         if (!array_key_exists($cfID, $this->_cfIDs)) {
 551           $this->_cfIDs[$cfID] = array();
 552         }
 553         // Set wildcard value based on "and/or" selection
 554         foreach ($this->_params as $key => $param) {
 555           if ($param[0] == $value[0] . '_operator') {
 556             $value[4] = $param[2] == 'or';
 557             break;
 558           }
 559         }
 560         $this->_cfIDs[$cfID][] = $value;
 561       }
 562
 563       if (!array_key_exists($value[0], $this->_paramLookup)) {
 564         $this->_paramLookup[$value[0]] = array();
 565       }
 566       $this->_paramLookup[$value[0]][] = $value;
 567     }
 568   }
 569
 570   /**
 571    * Some composite fields do not appear in the fields array
 572    * hack to make them part of the query
 573    *
 574    * @return void
 575    */
 576   public function addSpecialFields() {
 577     static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
 578     foreach ($special as $name) {
 579       if (!empty($this->_returnProperties[$name])) {
 580         $this->_select[$name] = "contact_a.{$name} as $name";
 581         $this->_element[$name] = 1;
 582       }
 583     }
 584   }
 585
 586   /**
 587    * Given a list of conditions in params and a list of desired
 588    * return Properties generate the required select and from
 589    * clauses. Note that since the where clause introduces new
 590    * tables, the initial attempt also retrieves all variables used
 591    * in the params list
 592    *
 593    * @return void
 594    */
 595   public function selectClause() {
 596
 597     $this->addSpecialFields();
 598
 599     foreach ($this->_fields as $name => $field) {
 600       // skip component fields
 601       // there are done by the alter query below
 602       // and need not be done on every field
 603       if (
 604         (substr($name, 0, 12) == 'participant_') ||
 605         (substr($name, 0, 7) == 'pledge_') ||
 606         (substr($name, 0, 5) == 'case_') ||
 607         (substr($name, 0, 13) == 'contribution_' &&
 608           (strpos($name, 'source') !== FALSE && strpos($name, 'recur') !== FALSE)) ||
 609         (substr($name, 0, 8) == 'payment_')
 610       ) {
 611         continue;
 612       }
 613
 614       // redirect to activity select clause
 615       if (
 616         (substr($name, 0, 9) == 'activity_') ||
 617         ($name == 'parent_id')
 618       ) {
 619         CRM_Activity_BAO_Query::select($this);
 620         continue;
 621       }
 622
 623       // if this is a hierarchical name, we ignore it
 624       $names = explode('-', $name);
 625       if (count($names) > 1 && isset($names[1]) && is_numeric($names[1])) {
 626         continue;
 627       }
 628
 629       // make an exception for special cases, to add the field in select clause
 630       $makeException = FALSE;
 631
 632       //special handling for groups/tags
 633       if (in_array($name, array('groups', 'tags', 'notes'))
 634         && isset($this->_returnProperties[substr($name, 0, -1)])
 635       ) {
 636         $makeException = TRUE;
 637       }
 638
 639       // since note has 3 different options we need special handling
 640       // note / note_subject / note_body
 641       if ($name == 'notes') {
 642         foreach (array('note', 'note_subject', 'note_body') as $noteField) {
 643           if (isset($this->_returnProperties[$noteField])) {
 644             $makeException = TRUE;
 645             break;
 646           }
 647         }
 648       }
 649
 650       if (in_array($name, array('prefix_id', 'suffix_id', 'gender_id', 'communication_style_id'))) {
 651         if (CRM_Utils_Array::value($field['pseudoconstant']['optionGroupName'], $this->_returnProperties)) {
 652           $makeException = TRUE;
 653         }
 654       }
 655
 656       $cfID = CRM_Core_BAO_CustomField::getKeyID($name);
 657       if (!empty($this->_paramLookup[$name]) || !empty($this->_returnProperties[$name]) ||
 658         $makeException
 659       ) {
 660         if ($cfID) {
 661           // add to cfIDs array if not present
 662           if (!array_key_exists($cfID, $this->_cfIDs)) {
 663             $this->_cfIDs[$cfID] = array();
 664           }
 665         }
 666         elseif (isset($field['where'])) {
 667           list($tableName, $fieldName) = explode('.', $field['where'], 2);
 668           if (isset($tableName)) {
 669             if (CRM_Utils_Array::value($tableName, self::$_dependencies)) {
 670               $this->_tables['civicrm_address'] = 1;
 671               $this->_select['address_id'] = 'civicrm_address.id as address_id';
 672               $this->_element['address_id'] = 1;
 673             }
 674
 675             if ($tableName == 'im_provider' || $tableName == 'email_greeting' ||
 676               $tableName == 'postal_greeting' || $tableName == 'addressee'
 677             ) {
 678               if ($tableName == 'im_provider') {
 679                 CRM_Core_OptionValue::select($this);
 680               }
 681
 682               if (in_array($tableName,
 683                 array('email_greeting', 'postal_greeting', 'addressee'))) {
 684                 $this->_element["{$name}_id"] = 1;
 685                 $this->_select["{$name}_id"] = "contact_a.{$name}_id as {$name}_id";
 686                 $this->_pseudoConstantsSelect[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id");
 687                 $this->_pseudoConstantsSelect[$name]['select'] = "{$name}.{$fieldName} as $name";
 688                 $this->_pseudoConstantsSelect[$name]['element'] = $name;
 689
 690                 if ($tableName == 'email_greeting') {
 691                   $this->_pseudoConstantsSelect[$name]['join']
 692                     = " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
 693                   $this->_pseudoConstantsSelect[$name]['join'] .=
 694                     " LEFT JOIN civicrm_option_value email_greeting ON (contact_a.email_greeting_id = email_greeting.value AND option_group_email_greeting.id = email_greeting.option_group_id ) ";
 695                 }
 696                 elseif ($tableName == 'postal_greeting') {
 697                   $this->_pseudoConstantsSelect[$name]['join']
 698                     = " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
 699                   $this->_pseudoConstantsSelect[$name]['join'] .=
 700                     " LEFT JOIN civicrm_option_value postal_greeting ON (contact_a.postal_greeting_id = postal_greeting.value AND option_group_postal_greeting.id = postal_greeting.option_group_id ) ";
 701                 }
 702                 elseif ($tableName == 'addressee') {
 703                   $this->_pseudoConstantsSelect[$name]['join']
 704                     = " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
 705                   $this->_pseudoConstantsSelect[$name]['join'] .=
 706                     " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
 707                 }
 708                 $this->_pseudoConstantsSelect[$name]['table'] = $tableName;
 709
 710                 //get display
 711                 $greetField = "{$name}_display";
 712                 $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}";
 713                 $this->_element[$greetField] = 1;
 714                 //get custom
 715                 $greetField = "{$name}_custom";
 716                 $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}";
 717                 $this->_element[$greetField] = 1;
 718               }
 719             }
 720             else {
 721               if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) {
 722                 $this->_tables[$tableName] = 1;
 723               }
 724
 725               // also get the id of the tableName
 726               $tName = substr($tableName, 8);
 727               if (in_array($tName, array('country', 'state_province', 'county'))) {
 728                 if ($tName == 'state_province') {
 729                   $this->_pseudoConstantsSelect['state_province_name'] = array(
 730                     'pseudoField' => "{$tName}",
 731                     'idCol' => "{$tName}_id",
 732                     'bao' => 'CRM_Core_BAO_Address',
 733                     'table' => "civicrm_{$tName}",
 734                     'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
 735                   );
 736
 737                   $this->_pseudoConstantsSelect[$tName] = array(
 738                     'pseudoField' => 'state_province_abbreviation',
 739                     'idCol' => "{$tName}_id",
 740                     'table' => "civicrm_{$tName}",
 741                     'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
 742                   );
 743                 }
 744                 else {
 745                   $this->_pseudoConstantsSelect[$name] = array(
 746                     'pseudoField' => "{$tName}_id",
 747                     'idCol' => "{$tName}_id",
 748                     'bao' => 'CRM_Core_BAO_Address',
 749                     'table' => "civicrm_{$tName}",
 750                     'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
 751                   );
 752                 }
 753
 754                 $this->_select["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id";
 755                 $this->_element["{$tName}_id"] = 1;
 756               }
 757               elseif ($tName != 'contact') {
 758                 $this->_select["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
 759                 $this->_element["{$tName}_id"] = 1;
 760               }
 761
 762               //special case for phone
 763               if ($name == 'phone') {
 764                 $this->_select['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
 765                 $this->_element['phone_type_id'] = 1;
 766               }
 767
 768               // if IM then select provider_id also
 769               // to get "IM Service Provider" in a file to be exported, CRM-3140
 770               if ($name == 'im') {
 771                 $this->_select['provider_id'] = "civicrm_im.provider_id as provider_id";
 772                 $this->_element['provider_id'] = 1;
 773               }
 774
 775               if ($tName == 'contact') {
 776                 // special case, when current employer is set for Individual contact
 777                 if ($fieldName == 'organization_name') {
 778                   $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
 779                 }
 780                 elseif ($fieldName != 'id') {
 781                   if ($fieldName == 'prefix_id') {
 782                     $this->_pseudoConstantsSelect['individual_prefix'] = array(
 783                       'pseudoField' => 'prefix_id',
 784                       'idCol' => "prefix_id",
 785                       'bao' => 'CRM_Contact_BAO_Contact',
 786                     );
 787                   }
 788                   if ($fieldName == 'suffix_id') {
 789                     $this->_pseudoConstantsSelect['individual_suffix'] = array(
 790                       'pseudoField' => 'suffix_id',
 791                       'idCol' => "suffix_id",
 792                       'bao' => 'CRM_Contact_BAO_Contact',
 793                     );
 794                   }
 795                   if ($fieldName == 'gender_id') {
 796                     $this->_pseudoConstantsSelect['gender'] = array(
 797                       'pseudoField' => 'gender_id',
 798                       'idCol' => "gender_id",
 799                       'bao' => 'CRM_Contact_BAO_Contact',
 800                     );
 801                   }
 802                   if ($name == 'communication_style_id') {
 803                     $this->_pseudoConstantsSelect['communication_style'] = array(
 804                       'pseudoField' => 'communication_style_id',
 805                       'idCol' => "communication_style_id",
 806                       'bao' => 'CRM_Contact_BAO_Contact',
 807                     );
 808                   }
 809                   $this->_select[$name] = "contact_a.{$fieldName}  as `$name`";
 810                 }
 811               }
 812               elseif (in_array($tName, array('country', 'county'))) {
 813                 $this->_pseudoConstantsSelect[$name]['select'] = "{$field['where']} as `$name`";
 814                 $this->_pseudoConstantsSelect[$name]['element'] = $name;
 815               }
 816               elseif ($tName == 'state_province') {
 817                 $this->_pseudoConstantsSelect[$tName]['select'] = "{$field['where']} as `$name`";
 818                 $this->_pseudoConstantsSelect[$tName]['element'] = $name;
 819               }
 820               else {
 821                 $this->_select[$name] = "{$field['where']} as `$name`";
 822               }
 823               if (!in_array($tName, array('state_province', 'country', 'county'))) {
 824                 $this->_element[$name] = 1;
 825               }
 826             }
 827           }
 828         }
 829         elseif ($name === 'tags') {
 830           $this->_useGroupBy = TRUE;
 831           $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
 832           $this->_element[$name] = 1;
 833           $this->_tables['civicrm_tag'] = 1;
 834           $this->_tables['civicrm_entity_tag'] = 1;
 835         }
 836         elseif ($name === 'groups') {
 837           $this->_useGroupBy = TRUE;
 838           $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups";
 839           $this->_element[$name] = 1;
 840           $this->_tables['civicrm_group'] = 1;
 841         }
 842         elseif ($name === 'notes') {
 843           // if note field is subject then return subject else body of the note
 844           $noteColumn = 'note';
 845           if (isset($noteField) && $noteField == 'note_subject') {
 846             $noteColumn = 'subject';
 847           }
 848
 849           $this->_useGroupBy = TRUE;
 850           $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes";
 851           $this->_element[$name] = 1;
 852           $this->_tables['civicrm_note'] = 1;
 853         }
 854         elseif ($name === 'current_employer') {
 855           $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
 856           $this->_element[$name] = 1;
 857         }
 858       }
 859
 860       if ($cfID && !empty($field['is_search_range'])) {
 861         // this is a custom field with range search enabled, so we better check for two/from values
 862         if (!empty($this->_paramLookup[$name . '_from'])) {
 863           if (!array_key_exists($cfID, $this->_cfIDs)) {
 864             $this->_cfIDs[$cfID] = array();
 865           }
 866           foreach ($this->_paramLookup[$name . '_from'] as $pID => $p) {
 867             // search in the cdID array for the same grouping
 868             $fnd = FALSE;
 869             foreach ($this->_cfIDs[$cfID] as $cID => $c) {
 870               if ($c[3] == $p[3]) {
 871                 $this->_cfIDs[$cfID][$cID][2]['from'] = $p[2];
 872                 $fnd = TRUE;
 873               }
 874             }
 875             if (!$fnd) {
 876               $p[2] = array('from' => $p[2]);
 877               $this->_cfIDs[$cfID][] = $p;
 878             }
 879           }
 880         }
 881         if (!empty($this->_paramLookup[$name . '_to'])) {
 882           if (!array_key_exists($cfID, $this->_cfIDs)) {
 883             $this->_cfIDs[$cfID] = array();
 884           }
 885           foreach ($this->_paramLookup[$name . '_to'] as $pID => $p) {
 886             // search in the cdID array for the same grouping
 887             $fnd = FALSE;
 888             foreach ($this->_cfIDs[$cfID] as $cID => $c) {
 889               if ($c[4] == $p[4]) {
 890                 $this->_cfIDs[$cfID][$cID][2]['to'] = $p[2];
 891                 $fnd = TRUE;
 892               }
 893             }
 894             if (!$fnd) {
 895               $p[2] = array('to' => $p[2]);
 896               $this->_cfIDs[$cfID][] = $p;
 897             }
 898           }
 899         }
 900       }
 901     }
 902
 903     // add location as hierarchical elements
 904     $this->addHierarchicalElements();
 905
 906     // add multiple field like website
 907     $this->addMultipleElements();
 908
 909     //fix for CRM-951
 910     CRM_Core_Component::alterQuery($this, 'select');
 911
 912     CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'select');
 913
 914     if (!empty($this->_cfIDs)) {
 915       $this->_customQuery = new CRM_Core_BAO_CustomQuery($this->_cfIDs, TRUE, $this->_locationSpecificCustomFields);
 916       $this->_customQuery->query();
 917       $this->_select = array_merge($this->_select, $this->_customQuery->_select);
 918       $this->_element = array_merge($this->_element, $this->_customQuery->_element);
 919       $this->_tables = array_merge($this->_tables, $this->_customQuery->_tables);
 920       $this->_whereTables = array_merge($this->_whereTables, $this->_customQuery->_whereTables);
 921       $this->_options = $this->_customQuery->_options;
 922     }
 923   }
 924
 925   /**
 926    * If the return Properties are set in a hierarchy, traverse the hierarchy to get
 927    * the return values
 928    *
 929    * @return void
 930    */
 931   public function addHierarchicalElements() {
 932     if (empty($this->_returnProperties['location'])) {
 933       return;
 934     }
 935     if (!is_array($this->_returnProperties['location'])) {
 936       return;
 937     }
 938
 939     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 940     $processed = array();
 941     $index = 0;
 942
 943     $addressCustomFields = CRM_Core_BAO_CustomField::getFieldsForImport('Address');
 944     $addressCustomFieldIds = array();
 945
 946     foreach ($this->_returnProperties['location'] as $name => $elements) {
 947       $lCond = self::getPrimaryCondition($name);
 948
 949       if (!$lCond) {
 950         $locationTypeId = array_search($name, $locationTypes);
 951         if ($locationTypeId === FALSE) {
 952           continue;
 953         }
 954         $lCond = "location_type_id = $locationTypeId";
 955         $this->_useDistinct = TRUE;
 956
 957         //commented for CRM-3256
 958         $this->_useGroupBy = TRUE;
 959       }
 960
 961       $name = str_replace(' ', '_', $name);
 962
 963       $tName = "$name-location_type";
 964       $ltName = "`$name-location_type`";
 965       $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
 966       $this->_select["{$tName}"] = "`$tName`.name as `{$tName}`";
 967       $this->_element["{$tName}_id"] = 1;
 968       $this->_element["{$tName}"] = 1;
 969
 970       $locationTypeName = $tName;
 971       $locationTypeJoin = array();
 972
 973       $addAddress = FALSE;
 974       $addWhereCount = 0;
 975       foreach ($elements as $elementFullName => $dontCare) {
 976         $index++;
 977         $elementName = $elementCmpName = $elementFullName;
 978
 979         if (substr($elementCmpName, 0, 5) == 'phone') {
 980           $elementCmpName = 'phone';
 981         }
 982
 983         if (in_array($elementCmpName, array_keys($addressCustomFields))) {
 984           if ($cfID = CRM_Core_BAO_CustomField::getKeyID($elementCmpName)) {
 985             $addressCustomFieldIds[$cfID][$name] = 1;
 986           }
 987         }
 988         //add address table only once
 989         if ((in_array($elementCmpName, self::$_locationSpecificFields) || !empty($addressCustomFieldIds))
 990           && !$addAddress
 991           && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
 992         ) {
 993           $tName = "$name-address";
 994           $aName = "`$name-address`";
 995           $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
 996           $this->_element["{$tName}_id"] = 1;
 997           $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
 998           $this->_tables[$tName] = $addressJoin;
 999           $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
1000           $processed[$aName] = 1;
1001           $addAddress = TRUE;
1002         }
1003
1004         $cond = $elementType = '';
1005         if (strpos($elementName, '-') !== FALSE) {
1006           // this is either phone, email or IM
1007           list($elementName, $elementType) = explode('-', $elementName);
1008
1009           if (($elementName != 'phone') && ($elementName != 'im')) {
1010             $cond = self::getPrimaryCondition($elementType);
1011           }
1012           // CRM-13011 : If location type is primary, do not restrict search to the phone
1013           // type id - we want the primary phone, regardless of what type it is.
1014           // Otherwise, restrict to the specified phone type for the given field.
1015           if ((!$cond) && ($elementName == 'phone')) {
1016             $cond = "phone_type_id = '$elementType'";
1017           }
1018           elseif ((!$cond) && ($elementName == 'im')) {
1019             // IM service provider id, CRM-3140
1020             $cond = "provider_id = '$elementType'";
1021           }
1022           $elementType = '-' . $elementType;
1023         }
1024
1025         $field = CRM_Utils_Array::value($elementName, $this->_fields);
1026
1027         // hack for profile, add location id
1028         if (!$field) {
1029           if ($elementType &&
1030             // fix for CRM-882( to handle phone types )
1031             !is_numeric($elementType)
1032           ) {
1033             if (is_numeric($name)) {
1034               $field = CRM_Utils_Array::value($elementName . "-Primary$elementType", $this->_fields);
1035             }
1036             else {
1037               $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields);
1038             }
1039           }
1040           elseif (is_numeric($name)) {
1041             //this for phone type to work
1042             if (in_array($elementName, array('phone', 'phone_ext'))) {
1043               $field = CRM_Utils_Array::value($elementName . "-Primary" . $elementType, $this->_fields);
1044             }
1045             else {
1046               $field = CRM_Utils_Array::value($elementName . "-Primary", $this->_fields);
1047             }
1048           }
1049           else {
1050             //this is for phone type to work for profile edit
1051             if (in_array($elementName, array('phone', 'phone_ext'))) {
1052               $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields);
1053             }
1054             else {
1055               $field = CRM_Utils_Array::value($elementName . "-$locationTypeId", $this->_fields);
1056             }
1057           }
1058         }
1059
1060         // Check if there is a value, if so also add to where Clause
1061         $addWhere = FALSE;
1062         if ($this->_params) {
1063           $nm = $elementName;
1064           if (isset($locationTypeId)) {
1065             $nm .= "-$locationTypeId";
1066           }
1067           if (!is_numeric($elementType)) {
1068             $nm .= "$elementType";
1069           }
1070
1071           foreach ($this->_params as $id => $values) {
1072             if ((is_array($values) && $values[0] == $nm) ||
1073               (in_array($elementName, array('phone', 'im'))
1074                 && (strpos($values[0], $nm) !== FALSE)
1075               )
1076             ) {
1077               $addWhere = TRUE;
1078               $addWhereCount++;
1079               break;
1080             }
1081           }
1082         }
1083
1084         if ($field && isset($field['where'])) {
1085           list($tableName, $fieldName) = explode('.', $field['where'], 2);
1086           $pf = substr($tableName, 8);
1087           $tName = $name . '-' . $pf . $elementType;
1088           if (isset($tableName)) {
1089             if ($tableName == 'civicrm_state_province' || $tableName == 'civicrm_country' || $tableName == 'civicrm_county') {
1090               $this->_select["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`";
1091             }
1092             else {
1093               $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1094             }
1095
1096             $this->_element["{$tName}_id"] = 1;
1097             if (substr($tName, -15) == '-state_province') {
1098               // FIXME: hack to fix CRM-1900
1099               $a = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
1100                 'address_format'
1101               );
1102
1103               if (substr_count($a, 'state_province_name') > 0) {
1104                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = array(
1105                   'pseudoField' => "{$pf}_id",
1106                   'idCol' => "{$tName}_id",
1107                   'bao' => 'CRM_Core_BAO_Address',
1108                 );
1109                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`";
1110               }
1111               else {
1112                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = array(
1113                   'pseudoField' => 'state_province_abbreviation',
1114                   'idCol' => "{$tName}_id",
1115                 );
1116                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
1117               }
1118             }
1119             else {
1120               if (substr($elementFullName, 0, 2) == 'im') {
1121                 $provider = "{$name}-{$elementFullName}-provider_id";
1122                 $this->_select[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
1123                 $this->_element[$provider] = 1;
1124               }
1125               if ($pf == 'country' || $pf == 'county') {
1126                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = array(
1127                   'pseudoField' => "{$pf}_id",
1128                   'idCol' => "{$tName}_id",
1129                   'bao' => 'CRM_Core_BAO_Address',
1130                 );
1131                 $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1132               }
1133               else {
1134                 $this->_select["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1135               }
1136             }
1137
1138             if (in_array($pf, array('state_province', 'country', 'county'))) {
1139               $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}";
1140             }
1141             else {
1142               $this->_element["{$name}-{$elementFullName}"] = 1;
1143             }
1144
1145             if (empty($processed["`$tName`"])) {
1146               $processed["`$tName`"] = 1;
1147               $newName = $tableName . '_' . $index;
1148               switch ($tableName) {
1149                 case 'civicrm_phone':
1150                 case 'civicrm_email':
1151                 case 'civicrm_im':
1152                 case 'civicrm_openid':
1153
1154                   $this->_tables[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id";
1155                   if ($tableName != 'civicrm_phone') {
1156                     $this->_tables[$tName] .= " AND `$tName`.$lCond";
1157                   }
1158                   elseif (is_numeric($name)) {
1159                     $this->_select[$tName] = "IF (`$tName`.is_primary = $name, `$tName`.phone, NULL) as `$tName`";
1160                   }
1161
1162                   // this special case to add phone type
1163                   if ($cond) {
1164                     $phoneTypeCondition = " AND `$tName`.$cond ";
1165                     //gross hack to pickup corrupted data also, CRM-7603
1166                     if (strpos($cond, 'phone_type_id') !== FALSE) {
1167                       $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
1168                       if (!empty($lCond)) {
1169                         $phoneTypeCondition .= " AND ( `$tName`.$lCond ) ";
1170                       }
1171                     }
1172                     $this->_tables[$tName] .= $phoneTypeCondition;
1173                   }
1174
1175                   //build locationType join
1176                   $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
1177
1178                   if ($addWhere) {
1179                     $this->_whereTables[$tName] = $this->_tables[$tName];
1180                   }
1181                   break;
1182
1183                 case 'civicrm_state_province':
1184                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $tName;
1185                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join']
1186                     = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
1187                   if ($addWhere) {
1188                     $this->_whereTables["{$name}-address"] = $addressJoin;
1189                   }
1190                   break;
1191
1192                 case 'civicrm_country':
1193                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $newName;
1194                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join']
1195                     = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1196                   if ($addWhere) {
1197                     $this->_whereTables["{$name}-address"] = $addressJoin;
1198                   }
1199                   break;
1200
1201                 case 'civicrm_county':
1202                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $newName;
1203                   $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join']
1204                     = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1205                   if ($addWhere) {
1206                     $this->_whereTables["{$name}-address"] = $addressJoin;
1207                   }
1208                   break;
1209
1210                 default:
1211                   if ($addWhere) {
1212                     $this->_whereTables["{$name}-address"] = $addressJoin;
1213                   }
1214                   break;
1215               }
1216             }
1217           }
1218         }
1219       }
1220
1221       // add location type  join
1222       $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1223       $this->_tables[$locationTypeName] = $ltypeJoin;
1224
1225       // table should be present in $this->_whereTables,
1226       // to add its condition in location type join, CRM-3939.
1227       if ($addWhereCount) {
1228         $locClause = array();
1229         foreach ($this->_whereTables as $tableName => $clause) {
1230           if (!empty($locationTypeJoin[$tableName])) {
1231             $locClause[] = $locationTypeJoin[$tableName];
1232           }
1233         }
1234
1235         if (!empty($locClause)) {
1236           $this->_whereTables[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1237         }
1238       }
1239     }
1240
1241     if (!empty($addressCustomFieldIds)) {
1242       $customQuery = new CRM_Core_BAO_CustomQuery($addressCustomFieldIds);
1243       foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1244         foreach ($locTypeName as $name => $dnc) {
1245           $this->_locationSpecificCustomFields[$cfID] = array($name, array_search($name, $locationTypes));
1246           $fieldName = "$name-custom_{$cfID}";
1247           $tName = "$name-address-custom-{$cfID}";
1248           $aName = "`$name-address-custom-{$cfID}`";
1249           $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1250           $this->_element["{$tName}_id"] = 1;
1251           $this->_select[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1252           $this->_element[$fieldName] = 1;
1253           $this->_tables[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1254         }
1255       }
1256     }
1257   }
1258
1259   /**
1260    * If the return Properties are set in a hierarchy, traverse the hierarchy to get
1261    * the return values
1262    *
1263    * @return void
1264    */
1265   public function addMultipleElements() {
1266     if (empty($this->_returnProperties['website'])) {
1267       return;
1268     }
1269     if (!is_array($this->_returnProperties['website'])) {
1270       return;
1271     }
1272
1273     foreach ($this->_returnProperties['website'] as $key => $elements) {
1274       foreach ($elements as $elementFullName => $dontCare) {
1275         $tName = "website-{$key}-{$elementFullName}";
1276         $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1277         $this->_select["{$tName}"] = "`$tName`.url as `{$tName}`";
1278         $this->_element["{$tName}_id"] = 1;
1279         $this->_element["{$tName}"] = 1;
1280
1281         $type = "website-{$key}-website_type_id";
1282         $this->_select[$type] = "`$tName`.website_type_id as `{$type}`";
1283         $this->_element[$type] = 1;
1284         $this->_tables[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id AND `$tName`.website_type_id = $key )";
1285       }
1286     }
1287   }
1288
1289   /**
1290    * Generate the query based on what type of query we need.
1291    *
1292    * @param bool $count
1293    * @param bool $sortByChar
1294    * @param bool $groupContacts
1295    * @param bool $onlyDeleted
1296    *
1297    * @return array
1298    *   sql query parts as an array
1299    */
1300   public function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE, $onlyDeleted = FALSE) {
1301     // build permission clause
1302     $this->generatePermissionClause($onlyDeleted, $count);
1303
1304     if ($count) {
1305       if (isset($this->_rowCountClause)) {
1306         $select = "SELECT {$this->_rowCountClause}";
1307       }
1308       elseif (isset($this->_distinctComponentClause)) {
1309         // we add distinct to get the right count for components
1310         // for the more complex result set, we use GROUP BY the same id
1311         // CRM-9630
1312         $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )";
1313       }
1314       else {
1315         $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1316       }
1317       $from = $this->_simpleFromClause;
1318       if ($this->_useDistinct) {
1319         $this->_useGroupBy = TRUE;
1320       }
1321     }
1322     elseif ($sortByChar) {
1323       $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1324       $from = $this->_simpleFromClause;
1325     }
1326     elseif ($groupContacts) {
1327       $select = 'SELECT contact_a.id as id';
1328       if ($this->_useDistinct) {
1329         $this->_useGroupBy = TRUE;
1330       }
1331       $from = $this->_simpleFromClause;
1332     }
1333     else {
1334       if (!empty($this->_paramLookup['group'])) {
1335         // make sure there is only one element
1336         // this is used when we are running under smog and need to know
1337         // how the contact was added (CRM-1203)
1338         if ((count($this->_paramLookup['group']) == 1) &&
1339           (count($this->_paramLookup['group'][0][2]) == 1)
1340         ) {
1341           $groups = array_keys($this->_paramLookup['group'][0][2]);
1342           $groupId = $groups[0];
1343
1344           //check if group is saved search
1345           $group = new CRM_Contact_BAO_Group();
1346           $group->id = $groupId;
1347           $group->find(TRUE);
1348
1349           if (!isset($group->saved_search_id)) {
1350             $tbName = "`civicrm_group_contact-{$groupId}`";
1351             $this->_select['group_contact_id'] = "$tbName.id as group_contact_id";
1352             $this->_element['group_contact_id'] = 1;
1353             $this->_select['status'] = "$tbName.status as status";
1354             $this->_element['status'] = 1;
1355           }
1356         }
1357         $this->_useGroupBy = TRUE;
1358       }
1359       if ($this->_useDistinct && !isset($this->_distinctComponentClause)) {
1360         if (!($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY)) {
1361           // CRM-5954
1362           $this->_select['contact_id'] = 'contact_a.id as contact_id';
1363           $this->_useDistinct = FALSE;
1364           $this->_useGroupBy = TRUE;
1365         }
1366       }
1367
1368       $select = "SELECT ";
1369       if (isset($this->_distinctComponentClause)) {
1370         $select .= "{$this->_distinctComponentClause}, ";
1371       }
1372       $select .= implode(', ', $this->_select);
1373       $from = $this->_fromClause;
1374     }
1375
1376     $where = '';
1377     if (!empty($this->_whereClause)) {
1378       $where = "WHERE {$this->_whereClause}";
1379     }
1380
1381     if (!empty($this->_permissionWhereClause) && empty($this->_displayRelationshipType)) {
1382       if (empty($where)) {
1383         $where = "WHERE $this->_permissionWhereClause";
1384       }
1385       else {
1386         $where = "$where AND $this->_permissionWhereClause";
1387       }
1388     }
1389
1390     $having = '';
1391     if (!empty($this->_having)) {
1392       foreach ($this->_having as $havingSets) {
1393         foreach ($havingSets as $havingSet) {
1394           $havingValue[] = $havingSet;
1395         }
1396       }
1397       $having = ' HAVING ' . implode(' AND ', $havingValue);
1398     }
1399
1400     // if we are doing a transform, do it here
1401     // use the $from, $where and $having to get the contact ID
1402     if ($this->_displayRelationshipType) {
1403       $this->filterRelatedContacts($from, $where, $having);
1404     }
1405
1406     return array($select, $from, $where, $having);
1407   }
1408
1409   /**
1410    * @param string $name
1411    * @param $grouping
1412    *
1413    * @return null
1414    */
1415   public function &getWhereValues($name, $grouping) {
1416     $result = NULL;
1417     foreach ($this->_params as $values) {
1418       if ($values[0] == $name && $values[3] == $grouping) {
1419         return $values;
1420       }
1421     }
1422
1423     return $result;
1424   }
1425
1426   /**
1427    * @param $relative
1428    * @param $from
1429    * @param $to
1430    */
1431   public static function fixDateValues($relative, &$from, &$to) {
1432     if ($relative) {
1433       list($from, $to) = CRM_Utils_Date::getFromTo($relative, $from, $to);
1434     }
1435   }
1436
1437   /**
1438    * @param $formValues
1439    * @param int $wildcard
1440    * @param bool $useEquals
1441    *
1442    * @param string $apiEntity
1443    *
1444    * @return array
1445    */
1446   public static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL) {
1447     $params = array();
1448     if (empty($formValues)) {
1449       return $params;
1450     }
1451
1452     foreach ($formValues as $id => $values) {
1453       if ($id == 'privacy') {
1454         if (is_array($formValues['privacy'])) {
1455           $op = !empty($formValues['privacy']['do_not_toggle']) ? '=' : '!=';
1456           foreach ($formValues['privacy'] as $key => $value) {
1457             if ($value) {
1458               $params[] = array($key, $op, $value, 0, 0);
1459             }
1460           }
1461         }
1462       }
1463       elseif ($id == 'email_on_hold') {
1464         if ($formValues['email_on_hold']['on_hold']) {
1465           $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1466         }
1467       }
1468       elseif (preg_match('/_date_relative$/', $id) ||
1469         $id == 'event_relative' ||
1470         $id == 'case_from_relative' ||
1471         $id == 'case_to_relative'
1472       ) {
1473         if ($id == 'event_relative') {
1474           $fromRange = 'event_start_date_low';
1475           $toRange = 'event_end_date_high';
1476         }
1477         elseif ($id == 'case_from_relative') {
1478           $fromRange = 'case_from_start_date_low';
1479           $toRange = 'case_from_start_date_high';
1480         }
1481         elseif ($id == 'case_to_relative') {
1482           $fromRange = 'case_to_end_date_low';
1483           $toRange = 'case_to_end_date_high';
1484         }
1485         else {
1486           $dateComponent = explode('_date_relative', $id);
1487           $fromRange = "{$dateComponent[0]}_date_low";
1488           $toRange = "{$dateComponent[0]}_date_high";
1489         }
1490
1491         if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1492           CRM_Contact_BAO_Query::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1493           continue;
1494         }
1495       }
1496       else {
1497         $values = CRM_Contact_BAO_Query::fixWhereValues($id, $values, $wildcard, $useEquals, $apiEntity);
1498
1499         if (!$values) {
1500           continue;
1501         }
1502         $params[] = $values;
1503       }
1504     }
1505     return $params;
1506   }
1507
1508   /**
1509    * @param int $id
1510    * @param $values
1511    * @param int $wildcard
1512    * @param bool $useEquals
1513    *
1514    * @param string $apiEntity
1515    *
1516    * @return array|null
1517    */
1518   public static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL) {
1519     // skip a few search variables
1520     static $skipWhere = NULL;
1521     static $likeNames = NULL;
1522     $result = NULL;
1523     // Change camelCase EntityName to lowercase with underscores
1524     $apiEntity = _civicrm_api_get_entity_name_from_camel($apiEntity);
1525
1526     if (CRM_Utils_System::isNull($values)) {
1527       return $result;
1528     }
1529
1530     if (!$skipWhere) {
1531       $skipWhere = array(
1532         'task',
1533         'radio_ts',
1534         'uf_group_id',
1535         'component_mode',
1536         'qfKey',
1537         'operator',
1538         'display_relationship_type',
1539       );
1540     }
1541
1542     if (in_array($id, $skipWhere) ||
1543       substr($id, 0, 4) == '_qf_' ||
1544       substr($id, 0, 7) == 'hidden_'
1545     ) {
1546       return $result;
1547     }
1548
1549     if ($apiEntity &&
1550       (substr($id, 0, strlen($apiEntity)) != $apiEntity) &&
1551       (substr($id, 0, 10) != 'financial_' && substr($id, 0, 8) != 'payment_')
1552     ) {
1553       $id = $apiEntity . '_' . $id;
1554     }
1555
1556     if (!$likeNames) {
1557       $likeNames = array('sort_name', 'email', 'note', 'display_name');
1558     }
1559
1560     // email comes in via advanced search
1561     // so use wildcard always
1562     if ($id == 'email') {
1563       $wildcard = 1;
1564     }
1565
1566     if (!$useEquals && in_array($id, $likeNames)) {
1567       $result = array($id, 'LIKE', $values, 0, 1);
1568     }
1569     elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1570       $result = array($id, 'LIKE', $values, 0, 0);
1571     }
1572     elseif ($id == 'group') {
1573       if (is_array($values)) {
1574         foreach ($values as $groupIds => $val) {
1575           $matches = array();
1576           if (preg_match('/-(\d+)$/', $groupIds, $matches)) {
1577             if (strlen($matches[1]) > 0) {
1578               $values[$matches[1]] = 1;
1579               unset($values[$groupIds]);
1580             }
1581           }
1582         }
1583       }
1584       else {
1585         $groupIds = explode(',', $values);
1586         unset($values);
1587         foreach ($groupIds as $groupId) {
1588           $values[$groupId] = 1;
1589         }
1590       }
1591
1592       $result = array($id, 'IN', $values, 0, 0);
1593     }
1594     elseif ($id == 'contact_tags' || $id == 'tag') {
1595       if (!is_array($values)) {
1596         $tagIds = explode(',', $values);
1597         unset($values);
1598         foreach ($tagIds as $tagId) {
1599           $values[$tagId] = 1;
1600         }
1601       }
1602       $result = array($id, 'IN', $values, 0, 0);
1603     }
1604     elseif ($id == 'contact_type' ||
1605       (!empty($values) && is_array($values) && !in_array(key($values), CRM_Core_DAO::acceptedSQLOperators(), TRUE))
1606     ) {
1607       $result = array($id, 'IN', $values, 0, $wildcard);
1608     }
1609     else {
1610       $result = array($id, '=', $values, 0, $wildcard);
1611     }
1612
1613     return $result;
1614   }
1615
1616   /**
1617    * @param $values
1618    */
1619   public function whereClauseSingle(&$values) {
1620     // do not process custom fields or prefixed contact ids or component params
1621     if (CRM_Core_BAO_CustomField::getKeyID($values[0]) ||
1622       (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) ||
1623       (substr($values[0], 0, 13) == 'contribution_') ||
1624       (substr($values[0], 0, 6) == 'event_') ||
1625       (substr($values[0], 0, 12) == 'participant_') ||
1626       (substr($values[0], 0, 7) == 'member_') ||
1627       (substr($values[0], 0, 6) == 'grant_') ||
1628       (substr($values[0], 0, 7) == 'pledge_') ||
1629       (substr($values[0], 0, 5) == 'case_') ||
1630       (substr($values[0], 0, 10) == 'financial_') ||
1631       (substr($values[0], 0, 8) == 'payment_') ||
1632       (substr($values[0], 0, 11) == 'membership_')
1633     ) {
1634       return;
1635     }
1636
1637     // skip for hook injected fields / params
1638     $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields();
1639     if (array_key_exists($values[0], $extFields)) {
1640       return;
1641     }
1642
1643     switch ($values[0]) {
1644       case 'deleted_contacts':
1645         $this->deletedContacts($values);
1646         return;
1647
1648       case 'contact_type':
1649         $this->contactType($values);
1650         return;
1651
1652       case 'contact_sub_type':
1653         $this->contactSubType($values);
1654         return;
1655
1656       case 'group':
1657         $this->group($values);
1658         return;
1659
1660       case 'group_type':
1661         // so we resolve this into a list of groups & proceed as if they had been
1662         // handed in
1663         list($name, $op, $value, $grouping, $wildcard) = $values;
1664         $values[0] = 'group';
1665         $values[1] = 'IN';
1666         $this->_paramLookup['group'][0][0] = 'group';
1667         $this->_paramLookup['group'][0][1] = 'IN';
1668         $this->_paramLookup['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1669         $this->group($values);
1670         return;
1671
1672       // case tag comes from find contacts
1673       case 'tag_search':
1674         $this->tagSearch($values);
1675         return;
1676
1677       case 'tag':
1678       case 'contact_tags':
1679         $this->tag($values);
1680         return;
1681
1682       case 'note':
1683       case 'note_body':
1684       case 'note_subject':
1685         $this->notes($values);
1686         return;
1687
1688       case 'uf_user':
1689         $this->ufUser($values);
1690         return;
1691
1692       case 'sort_name':
1693       case 'display_name':
1694         $this->sortName($values);
1695         return;
1696
1697       case 'addressee':
1698       case 'postal_greeting':
1699       case 'email_greeting':
1700         $this->greetings($values);
1701         return;
1702
1703       case 'email':
1704         $this->email($values);
1705         return;
1706
1707       case 'phone_numeric':
1708         $this->phone_numeric($values);
1709         return;
1710
1711       case 'phone_phone_type_id':
1712       case 'phone_location_type_id':
1713         $this->phone_option_group($values);
1714         return;
1715
1716       case 'street_address':
1717         $this->street_address($values);
1718         return;
1719
1720       case 'street_number':
1721         $this->street_number($values);
1722         return;
1723
1724       case 'sortByCharacter':
1725         $this->sortByCharacter($values);
1726         return;
1727
1728       case 'location_type':
1729         $this->locationType($values);
1730         return;
1731
1732       case 'county':
1733         $this->county($values);
1734         return;
1735
1736       case 'state_province':
1737         $this->stateProvince($values);
1738         return;
1739
1740       case 'country':
1741         $this->country($values, FALSE);
1742         return;
1743
1744       case 'postal_code':
1745       case 'postal_code_low':
1746       case 'postal_code_high':
1747         $this->postalCode($values);
1748         return;
1749
1750       case 'activity_date':
1751       case 'activity_date_low':
1752       case 'activity_date_high':
1753       case 'activity_role':
1754       case 'activity_status_id':
1755       case 'activity_status':
1756       case 'followup_parent_id':
1757       case 'parent_id':
1758       case 'source_contact_id':
1759       case 'activity_subject':
1760       case 'test_activities':
1761       case 'activity_type_id':
1762       case 'activity_type':
1763       case 'activity_survey_id':
1764       case 'activity_tags':
1765       case 'activity_taglist':
1766       case 'activity_test':
1767       case 'activity_campaign_id':
1768       case 'activity_engagement_level':
1769       case 'activity_id':
1770       case 'activity_result':
1771       case 'source_contact':
1772         CRM_Activity_BAO_Query::whereClauseSingle($values, $this);
1773         return;
1774
1775       case 'birth_date_low':
1776       case 'birth_date_high':
1777       case 'deceased_date_low':
1778       case 'deceased_date_high':
1779         $this->demographics($values);
1780         return;
1781
1782       case 'log_date_low':
1783       case 'log_date_high':
1784         $this->modifiedDates($values);
1785         return;
1786
1787       case 'changed_by':
1788         $this->changeLog($values);
1789         return;
1790
1791       case 'do_not_phone':
1792       case 'do_not_email':
1793       case 'do_not_mail':
1794       case 'do_not_sms':
1795       case 'do_not_trade':
1796       case 'is_opt_out':
1797         $this->privacy($values);
1798         return;
1799
1800       case 'privacy_options':
1801         $this->privacyOptions($values);
1802         return;
1803
1804       case 'privacy_operator':
1805       case 'privacy_toggle':
1806         // these are handled by privacy options
1807         return;
1808
1809       case 'preferred_communication_method':
1810         $this->preferredCommunication($values);
1811         return;
1812
1813       case 'relation_type_id':
1814       case 'relation_start_date_high':
1815       case 'relation_start_date_low':
1816       case 'relation_end_date_high':
1817       case 'relation_end_date_low':
1818       case 'relation_target_name':
1819       case 'relation_status':
1820       case 'relation_date_low':
1821       case 'relation_date_high':
1822         $this->relationship($values);
1823         $this->_relationshipValuesAdded = TRUE;
1824         return;
1825
1826       case 'task_status_id':
1827         $this->task($values);
1828         return;
1829
1830       case 'task_id':
1831         // since this case is handled with the above
1832         return;
1833
1834       case 'prox_distance':
1835         CRM_Contact_BAO_ProximityQuery::process($this, $values);
1836         return;
1837
1838       case 'prox_street_address':
1839       case 'prox_city':
1840       case 'prox_postal_code':
1841       case 'prox_state_province_id':
1842       case 'prox_country_id':
1843         // handled by the proximity_distance clause
1844         return;
1845
1846       default:
1847         $this->restWhere($values);
1848         return;
1849     }
1850   }
1851
1852   /**
1853    * Given a list of conditions in params generate the required.
1854    * where clause
1855    *
1856    * @return string
1857    */
1858   public function whereClause() {
1859     $this->_where[0] = array();
1860     $this->_qill[0] = array();
1861
1862     $this->includeContactIds();
1863     if (!empty($this->_params)) {
1864       foreach (array_keys($this->_params) as $id) {
1865         if (empty($this->_params[$id][0])) {
1866           continue;
1867         }
1868         // check for both id and contact_id
1869         if ($this->_params[$id][0] == 'id' || $this->_params[$id][0] == 'contact_id') {
1870           $this->_where[0][] = self::buildClause("contact_a.id", $this->_params[$id][1], $this->_params[$id][2]);
1871         }
1872         else {
1873           $this->whereClauseSingle($this->_params[$id]);
1874         }
1875       }
1876
1877       CRM_Core_Component::alterQuery($this, 'where');
1878
1879       CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'where');
1880     }
1881
1882     if ($this->_customQuery) {
1883       // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1884       // Hope it wont affect the other part of civicrm.. if it does please remove it.
1885       if (!empty($this->_customQuery->_where)) {
1886         $this->_where = CRM_Utils_Array::crmArrayMerge($this->_where, $this->_customQuery->_where);
1887       }
1888
1889       $this->_qill = CRM_Utils_Array::crmArrayMerge($this->_qill, $this->_customQuery->_qill);
1890     }
1891
1892     $clauses = array();
1893     $andClauses = array();
1894
1895     $validClauses = 0;
1896     if (!empty($this->_where)) {
1897       foreach ($this->_where as $grouping => $values) {
1898         if ($grouping > 0 && !empty($values)) {
1899           $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1900           $validClauses++;
1901         }
1902       }
1903
1904       if (!empty($this->_where[0])) {
1905         $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where[0]) . ' ) ';
1906       }
1907       if (!empty($clauses)) {
1908         $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1909       }
1910
1911       if ($validClauses > 1) {
1912         $this->_useDistinct = TRUE;
1913       }
1914     }
1915
1916     return implode(' AND ', $andClauses);
1917   }
1918
1919   /**
1920    * @param $values
1921    *
1922    * @throws Exception
1923    */
1924   public function restWhere(&$values) {
1925     $name = CRM_Utils_Array::value(0, $values);
1926     $op = CRM_Utils_Array::value(1, $values);
1927     $value = CRM_Utils_Array::value(2, $values);
1928     $grouping = CRM_Utils_Array::value(3, $values);
1929     $wildcard = CRM_Utils_Array::value(4, $values);
1930
1931     if (isset($grouping) && empty($this->_where[$grouping])) {
1932       $this->_where[$grouping] = array();
1933     }
1934
1935     $multipleFields = array('url');
1936
1937     //check if the location type exits for fields
1938     $lType = '';
1939     $locType = explode('-', $name);
1940
1941     if (!in_array($locType[0], $multipleFields)) {
1942       //add phone type if exists
1943       if (isset($locType[2]) && $locType[2]) {
1944         $locType[2] = CRM_Core_DAO::escapeString($locType[2]);
1945       }
1946     }
1947
1948     $field = CRM_Utils_Array::value($name, $this->_fields);
1949
1950     if (!$field) {
1951       $field = CRM_Utils_Array::value($locType[0], $this->_fields);
1952
1953       if (!$field) {
1954         return;
1955       }
1956     }
1957
1958     $setTables = TRUE;
1959
1960     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
1961     $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1962
1963     if (substr($name, 0, 14) === 'state_province') {
1964       if (isset($locType[1]) && is_numeric($locType[1])) {
1965         $setTables = FALSE;
1966         $aName = "{$locationType[$locType[1]]}-address";
1967         $where = "`$aName`.state_province_id";
1968       }
1969       else {
1970         $where = "civicrm_address.state_province_id";
1971       }
1972
1973       $states = CRM_Core_PseudoConstant::stateProvince();
1974       if (is_numeric($value)) {
1975         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
1976         $value = $states[(int ) $value];
1977       }
1978       else {
1979         $intVal = CRM_Utils_Array::key($value, $states);
1980         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
1981       }
1982       if (!$lType) {
1983         $this->_qill[$grouping][] = ts('State') . " $op '$value'";
1984       }
1985       else {
1986         $this->_qill[$grouping][] = ts('State') . " ($lType) $op '$value'";
1987       }
1988     }
1989     elseif (!empty($field['pseudoconstant'])) {
1990       $this->optionValueQuery(
1991         $name, $op, $value, $grouping,
1992         CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', $field['name']),
1993         $field,
1994         $field['title'],
1995         'String',
1996         TRUE
1997       );
1998       if ($name == 'gender_id') {
1999         self::$_openedPanes[ts('Demographics')] = TRUE;
2000       }
2001     }
2002     elseif (substr($name, 0, 7) === 'country') {
2003       if (isset($locType[1]) && is_numeric($locType[1])) {
2004         $setTables = FALSE;
2005         $aName = "{$locationType[$locType[1]]}-address";
2006         $where = "`$aName`.country_id";
2007       }
2008       else {
2009         $where = "civicrm_address.country_id";
2010       }
2011
2012       $countries = CRM_Core_PseudoConstant::country();
2013       if (is_numeric($value)) {
2014         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
2015         $value = $countries[(int ) $value];
2016       }
2017       else {
2018         $intVal = CRM_Utils_Array::key($value, $countries);
2019         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
2020       }
2021
2022       if (!$lType) {
2023         $this->_qill[$grouping][] = ts('Country') . " $op '$value'";
2024       }
2025       else {
2026         $this->_qill[$grouping][] = ts('Country') . " ($lType) $op '$value'";
2027       }
2028     }
2029     elseif (substr($name, 0, 6) === 'county') {
2030       if (isset($locType[1]) && is_numeric($locType[1])) {
2031         $setTables = FALSE;
2032         $aName = "{$locationType[$locType[1]]}-address";
2033         $where = "`$aName`.county_id";
2034       }
2035       else {
2036         $where = "civicrm_address.county_id";
2037       }
2038
2039       $counties = CRM_Core_PseudoConstant::county();
2040       if (is_numeric($value)) {
2041         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
2042         $value = $counties[(int ) $value];
2043       }
2044       else {
2045         $intVal = CRM_Utils_Array::key($value, $counties);
2046         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
2047       }
2048
2049       if (!$lType) {
2050         $this->_qill[$grouping][] = ts('County') . " $op '$value'";
2051       }
2052       else {
2053         $this->_qill[$grouping][] = ts('County') . " ($lType) $op '$value'";
2054       }
2055     }
2056     elseif ($name === 'world_region') {
2057       $field['where'] = 'civicrm_worldregion.id';
2058       $this->optionValueQuery(
2059         $name, $op, $value, $grouping,
2060         CRM_Core_PseudoConstant::worldRegion(),
2061         $field,
2062         ts('World Region'),
2063         'Positive',
2064         TRUE
2065       );
2066     }
2067     elseif ($name === 'is_deceased') {
2068       $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value);
2069       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2070       self::$_openedPanes[ts('Demographics')] = TRUE;
2071     }
2072     elseif ($name === 'created_date' || $name === 'modified_date' || $name === 'deceased_date' || $name === 'birth_date') {
2073       $appendDateTime = TRUE;
2074       if ($name === 'deceased_date' || $name === 'birth_date') {
2075         $appendDateTime = FALSE;
2076         self::$_openedPanes[ts('Demographics')] = TRUE;
2077       }
2078       $this->dateQueryBuilder($values, 'contact_a', $name, $name, $field['title'], $appendDateTime);
2079     }
2080     elseif ($name === 'contact_id') {
2081       if (is_int($value)) {
2082         $this->_where[$grouping][] = self::buildClause($field['where'], $op, $value);
2083         $this->_qill[$grouping][] = "$field[title] $op $value";
2084       }
2085     }
2086     elseif ($name === 'name') {
2087       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2088       if ($wildcard) {
2089         $value = "%$value%";
2090         $op = 'LIKE';
2091       }
2092       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
2093       $this->_where[$grouping][] = self::buildClause($wc, $op, "'$value'");
2094       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2095     }
2096     elseif ($name === 'current_employer') {
2097       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2098       if ($wildcard) {
2099         $value = "%$value%";
2100         $op = 'LIKE';
2101       }
2102       $wc = self::caseImportant($op) ? "LOWER(contact_a.organization_name)" : "contact_a.organization_name";
2103       $ceWhereClause = self::buildClause($wc, $op,
2104         $value
2105       );
2106       $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
2107       $this->_where[$grouping][] = $ceWhereClause;
2108       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2109     }
2110     elseif ($name === 'email_greeting') {
2111       $filterCondition = array('greeting_type' => 'email_greeting');
2112       $this->optionValueQuery(
2113         $name, $op, $value, $grouping,
2114         CRM_Core_PseudoConstant::greeting($filterCondition),
2115         $field,
2116         ts('Email Greeting')
2117       );
2118     }
2119     elseif ($name === 'postal_greeting') {
2120       $filterCondition = array('greeting_type' => 'postal_greeting');
2121       $this->optionValueQuery(
2122         $name, $op, $value, $grouping,
2123         CRM_Core_PseudoConstant::greeting($filterCondition),
2124         $field,
2125         ts('Postal Greeting')
2126       );
2127     }
2128     elseif ($name === 'addressee') {
2129       $filterCondition = array('greeting_type' => 'addressee');
2130       $this->optionValueQuery(
2131         $name, $op, $value, $grouping,
2132         CRM_Core_PseudoConstant::greeting($filterCondition),
2133         $field,
2134         ts('Addressee')
2135       );
2136     }
2137     elseif (substr($name, 0, 4) === 'url-') {
2138       $tName = 'civicrm_website';
2139       $this->_whereTables[$tName] = $this->_tables[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2140       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2141       if ($wildcard) {
2142         $value = "%$value%";
2143         $op = 'LIKE';
2144       }
2145
2146       $wc = 'civicrm_website.url';
2147       $this->_where[$grouping][] = $d = self::buildClause($wc, $op, $value);
2148       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2149     }
2150     elseif ($name === 'contact_is_deleted') {
2151       $this->_where[$grouping][] = self::buildClause("contact_a.is_deleted", $op, $value);
2152       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2153     }
2154     elseif (!empty($field['where'])) {
2155       $type = NULL;
2156       if (!empty($field['type'])) {
2157         $type = CRM_Utils_Type::typeToString($field['type']);
2158       }
2159
2160       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2161
2162       if (isset($locType[1]) &&
2163         is_numeric($locType[1])
2164       ) {
2165         $setTables = FALSE;
2166
2167         //get the location name
2168         list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
2169
2170         $fieldName = "LOWER(`$tName`.$fldName)";
2171
2172         // we set both _tables & whereTables because whereTables doesn't seem to do what the name implies it should
2173         $this->_tables[$tName] = $this->_whereTables[$tName] = 1;
2174
2175       }
2176       else {
2177         if ($tableName == 'civicrm_contact') {
2178           $fieldName = "LOWER(contact_a.{$fieldName})";
2179         }
2180         else {
2181           if ($op != 'IN' && !is_numeric($value)) {
2182             $fieldName = "LOWER({$field['where']})";
2183           }
2184           else {
2185             $fieldName = "{$field['where']}";
2186           }
2187         }
2188       }
2189
2190       list($qillop, $qillVal) = self::buildQillForFieldValue(NULL, $field['title'], $value, $op);
2191       $this->_qill[$grouping][] = "$field[title] $qillop '$qillVal'";
2192
2193       if (is_array($value)) {
2194         // traditionally an array being passed has been a fatal error. We can take advantage of this to add support
2195         // for api style operators for functions that hit this point without worrying about regression
2196         // (the previous comments indicated the condition for hitting this point were unknown
2197         // per CRM-14743 we are adding modified_date & created_date operator support
2198         $operations = array_keys($value);
2199         foreach ($operations as $operator) {
2200           if (!in_array($operator, CRM_Core_DAO::acceptedSQLOperators())) {
2201             //Via Contact get api value is not in array(operator => array(values)) format ONLY for IN/NOT IN operators
2202             //so this condition will satisfy the search for now
2203             if (strpos($op, 'IN') !== FALSE) {
2204               $value = array($op => $value);
2205             }
2206             // we don't know when this might happen
2207             else {
2208               CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $operator)));
2209             }
2210           }
2211         }
2212         $this->_where[$grouping][] = CRM_Core_DAO::createSQLFilter($fieldName, $value, $type);
2213       }
2214       else {
2215         if ($op != 'IN') {
2216           $value = $strtolower($value);
2217         }
2218         if ($wildcard) {
2219           $value = "%$value%";
2220           $op = 'LIKE';
2221         }
2222
2223         $this->_where[$grouping][] = self::buildClause($fieldName, $op, $value, $type);
2224       }
2225     }
2226
2227     if ($setTables && isset($field['where'])) {
2228       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2229       if (isset($tableName)) {
2230         $this->_tables[$tableName] = 1;
2231         $this->_whereTables[$tableName] = 1;
2232       }
2233     }
2234   }
2235
2236
2237   /**
2238    * @param $where
2239    * @param $locType
2240    *
2241    * @return array
2242    * @throws Exception
2243    */
2244   public static function getLocationTableName(&$where, &$locType) {
2245     if (isset($locType[1]) && is_numeric($locType[1])) {
2246       list($tbName, $fldName) = explode(".", $where);
2247
2248       //get the location name
2249       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
2250       $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2251       if (in_array($locType[0], $specialFields)) {
2252         //hack to fix / special handing for phone_ext
2253         if ($locType[0] == 'phone_ext') {
2254           $locType[0] = 'phone';
2255         }
2256         if (isset($locType[2]) && $locType[2]) {
2257           $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2258         }
2259         else {
2260           $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2261         }
2262       }
2263       elseif (in_array($locType[0],
2264         array(
2265           'address_name',
2266           'street_address',
2267           'supplemental_address_1',
2268           'supplemental_address_2',
2269           'city',
2270           'postal_code',
2271           'postal_code_suffix',
2272           'geo_code_1',
2273           'geo_code_2',
2274         )
2275       )) {
2276         //fix for search by profile with address fields.
2277         $tName = "{$locationType[$locType[1]]}-address";
2278       }
2279       elseif ($locType[0] == 'on_hold') {
2280         $tName = "{$locationType[$locType[1]]}-email";
2281       }
2282       else {
2283         $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2284       }
2285       $tName = str_replace(' ', '_', $tName);
2286       return array($tName, $fldName);
2287     }
2288     CRM_Core_Error::fatal();
2289   }
2290
2291   /**
2292    * Given a result dao, extract the values and return that array
2293    *
2294    * @param CRM_Core_DAO $dao
2295    *
2296    * @return array
2297    *   values for this query
2298    */
2299   public function store($dao) {
2300     $value = array();
2301
2302     foreach ($this->_element as $key => $dontCare) {
2303       if (property_exists($dao, $key)) {
2304         if (strpos($key, '-') !== FALSE) {
2305           $values = explode('-', $key);
2306           $lastElement = array_pop($values);
2307           $current = &$value;
2308           $cnt = count($values);
2309           $count = 1;
2310           foreach ($values as $v) {
2311             if (!array_key_exists($v, $current)) {
2312               $current[$v] = array();
2313             }
2314             //bad hack for im_provider
2315             if ($lastElement == 'provider_id') {
2316               if ($count < $cnt) {
2317                 $current = &$current[$v];
2318               }
2319               else {
2320                 $lastElement = "{$v}_{$lastElement}";
2321               }
2322             }
2323             else {
2324               $current = &$current[$v];
2325             }
2326             $count++;
2327           }
2328
2329           $current[$lastElement] = $dao->$key;
2330         }
2331         else {
2332           $value[$key] = $dao->$key;
2333         }
2334       }
2335     }
2336     return $value;
2337   }
2338
2339   /**
2340    * Getter for tables array.
2341    *
2342    * @return array
2343    */
2344   public function tables() {
2345     return $this->_tables;
2346   }
2347
2348   /**
2349    * Where tables is sometimes used to create the from clause, but, not reliably, set this AND set tables
2350    * It's unclear the intent - there is a 'simpleFrom' clause which takes whereTables into account & a fromClause which doesn't
2351    * logic may have eroded
2352    * @return array
2353    */
2354   public function whereTables() {
2355     return $this->_whereTables;
2356   }
2357
2358   /**
2359    * Generate the where clause (used in match contacts and permissions)
2360    *
2361    * @param array $params
2362    * @param array $fields
2363    * @param array $tables
2364    * @param $whereTables
2365    * @param bool $strict
2366    *
2367    * @return string
2368    */
2369   public static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2370     $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2371       FALSE, $strict
2372     );
2373
2374     $tables = array_merge($query->tables(), $tables);
2375     $whereTables = array_merge($query->whereTables(), $whereTables);
2376
2377     return $query->_whereClause;
2378   }
2379
2380   /**
2381    * Create the from clause.
2382    *
2383    * @param array $tables
2384    *   Tables that need to be included in this from clause.
2385    *                      if null, return mimimal from clause (i.e. civicrm_contact)
2386    * @param array $inner
2387    *   Tables that should be inner-joined.
2388    * @param array $right
2389    *   Tables that should be right-joined.
2390    *
2391    * @param bool $primaryLocation
2392    * @param int $mode
2393    *
2394    * @return string
2395    *   the from clause
2396    */
2397   public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2398
2399     $from = ' FROM civicrm_contact contact_a';
2400     if (empty($tables)) {
2401       return $from;
2402     }
2403
2404     if (!empty($tables['civicrm_worldregion'])) {
2405       $tables = array_merge(array('civicrm_country' => 1), $tables);
2406     }
2407
2408     if ((!empty($tables['civicrm_state_province']) || !empty($tables['civicrm_country']) ||
2409         CRM_Utils_Array::value('civicrm_county', $tables)
2410       ) && empty($tables['civicrm_address'])
2411     ) {
2412       $tables = array_merge(array('civicrm_address' => 1),
2413         $tables
2414       );
2415     }
2416
2417     // add group_contact and group_contact_cache table if group table is present
2418     if (!empty($tables['civicrm_group'])) {
2419       if (empty($tables['civicrm_group_contact'])) {
2420         $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added' ";
2421       }
2422       if (empty($tables['civicrm_group_contact_cache'])) {
2423         $tables['civicrm_group_contact_cache'] = " LEFT JOIN civicrm_group_contact_cache ON civicrm_group_contact_cache.contact_id = contact_a.id ";
2424       }
2425     }
2426
2427     // add group_contact and group table is subscription history is present
2428     if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2429       $tables = array_merge(array(
2430           'civicrm_group' => 1,
2431           'civicrm_group_contact' => 1,
2432         ),
2433         $tables
2434       );
2435     }
2436
2437     // to handle table dependencies of components
2438     CRM_Core_Component::tableNames($tables);
2439     // to handle table dependencies of hook injected tables
2440     CRM_Contact_BAO_Query_Hook::singleton()->setTableDependency($tables);
2441
2442     //format the table list according to the weight
2443     $info = CRM_Core_TableHierarchy::info();
2444
2445     foreach ($tables as $key => $value) {
2446       $k = 99;
2447       if (strpos($key, '-') !== FALSE) {
2448         $keyArray = explode('-', $key);
2449         $k = CRM_Utils_Array::value('civicrm_' . $keyArray[1], $info, 99);
2450       }
2451       elseif (strpos($key, '_') !== FALSE) {
2452         $keyArray = explode('_', $key);
2453         if (is_numeric(array_pop($keyArray))) {
2454           $k = CRM_Utils_Array::value(implode('_', $keyArray), $info, 99);
2455         }
2456         else {
2457           $k = CRM_Utils_Array::value($key, $info, 99);
2458         }
2459       }
2460       else {
2461         $k = CRM_Utils_Array::value($key, $info, 99);
2462       }
2463       $tempTable[$k . ".$key"] = $key;
2464     }
2465     ksort($tempTable);
2466     $newTables = array();
2467     foreach ($tempTable as $key) {
2468       $newTables[$key] = $tables[$key];
2469     }
2470
2471     $tables = $newTables;
2472
2473     foreach ($tables as $name => $value) {
2474       if (!$value) {
2475         continue;
2476       }
2477
2478       if (!empty($inner[$name])) {
2479         $side = 'INNER';
2480       }
2481       elseif (!empty($right[$name])) {
2482         $side = 'RIGHT';
2483       }
2484       else {
2485         $side = 'LEFT';
2486       }
2487
2488       if ($value != 1) {
2489         // if there is already a join statement in value, use value itself
2490         if (strpos($value, 'JOIN')) {
2491           $from .= " $value ";
2492         }
2493         else {
2494           $from .= " $side JOIN $name ON ( $value ) ";
2495         }
2496         continue;
2497       }
2498       switch ($name) {
2499         case 'civicrm_address':
2500           if ($primaryLocation) {
2501             $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2502           }
2503           else {
2504             //CRM-14263 further handling of address joins further down...
2505             $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2506           }
2507           continue;
2508
2509         case 'civicrm_phone':
2510           $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2511           continue;
2512
2513         case 'civicrm_email':
2514           $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2515           continue;
2516
2517         case 'civicrm_im':
2518           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2519           continue;
2520
2521         case 'im_provider':
2522           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2523           $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2524           $from .= " $side JOIN civicrm_option_value im_provider ON (civicrm_im.provider_id = im_provider.value AND option_group_imProvider.id = im_provider.option_group_id)";
2525           continue;
2526
2527         case 'civicrm_openid':
2528           $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2529           continue;
2530
2531         case 'civicrm_worldregion':
2532           $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2533           $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2534           continue;
2535
2536         case 'civicrm_location_type':
2537           $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2538           continue;
2539
2540         case 'civicrm_group':
2541           $from .= " $side JOIN civicrm_group ON (civicrm_group.id = civicrm_group_contact.group_id OR civicrm_group.id = civicrm_group_contact_cache.group_id) ";
2542           continue;
2543
2544         case 'civicrm_group_contact':
2545           $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2546           continue;
2547
2548         case 'civicrm_group_contact_cache':
2549           $from .= " $side JOIN civicrm_group_contact_cache ON contact_a.id = civicrm_group_contact_cache.contact_id ";
2550           continue;
2551
2552         case 'civicrm_activity':
2553         case 'civicrm_activity_tag':
2554         case 'activity_type':
2555         case 'activity_status':
2556         case 'parent_id':
2557         case 'civicrm_activity_contact':
2558         case 'source_contact':
2559           $from .= CRM_Activity_BAO_Query::from($name, $mode, $side);
2560           continue;
2561
2562         case 'civicrm_entity_tag':
2563           $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2564                                                               civicrm_entity_tag.entity_id = contact_a.id ) ";
2565           continue;
2566
2567         case 'civicrm_note':
2568           $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2569                                                         contact_a.id = civicrm_note.entity_id ) ";
2570           continue;
2571
2572         case 'civicrm_subscription_history':
2573           $from .= " $side JOIN civicrm_subscription_history
2574                                    ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2575                                   AND civicrm_group_contact.group_id =  civicrm_subscription_history.group_id";
2576           continue;
2577
2578         case 'civicrm_relationship':
2579           if (self::$_relType == 'reciprocal') {
2580             if (self::$_relationshipTempTable) {
2581               // we have a temptable to join on
2582               $tbl = self::$_relationshipTempTable;
2583               $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2584             }
2585             else {
2586               $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2587               $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id OR civicrm_relationship.contact_id_b = contact_b.id)";
2588             }
2589           }
2590           elseif (self::$_relType == 'b') {
2591             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2592             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2593           }
2594           else {
2595             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2596             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2597           }
2598           continue;
2599
2600         case 'civicrm_log':
2601           $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2602           $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2603           continue;
2604
2605         case 'civicrm_tag':
2606           $from .= " $side  JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2607           continue;
2608
2609         case 'civicrm_grant':
2610           $from .= CRM_Grant_BAO_Query::from($name, $mode, $side);
2611           continue;
2612
2613         case 'civicrm_website':
2614           $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2615           continue;
2616
2617         default:
2618           $locationTypeName = '';
2619           if (strpos($name, '-address') != 0) {
2620             $locationTypeName = 'address';
2621           }
2622           elseif (strpos($name, '-phone') != 0) {
2623             $locationTypeName = 'phone';
2624           }
2625           elseif (strpos($name, '-email') != 0) {
2626             $locationTypeName = 'email';
2627           }
2628           if ($locationTypeName) {
2629             //we have a join on an location table - possibly in conjunction with search builder - CRM-14263
2630             $parts = explode('-', $name);
2631             $locationID = array_search($parts[0], CRM_Core_BAO_Address::buildOptions('location_type_id', 'get', array('name' => $parts[0])));
2632             $from .= " $side JOIN civicrm_{$locationTypeName} `{$name}` ON ( contact_a.id = `{$name}`.contact_id ) and `{$name}`.location_type_id = $locationID ";
2633           }
2634           else {
2635             $from .= CRM_Core_Component::from($name, $mode, $side);
2636           }
2637           $from .= CRM_Contact_BAO_Query_Hook::singleton()->buildSearchfrom($name, $mode, $side);
2638
2639           continue;
2640       }
2641     }
2642     return $from;
2643   }
2644
2645   /**
2646    * WHERE / QILL clause for deleted_contacts
2647    *
2648    * @param $values
2649    *
2650    * @return void
2651    */
2652   public function deletedContacts($values) {
2653     list($_, $_, $value, $grouping, $_) = $values;
2654     if ($value) {
2655       // *prepend* to the relevant grouping as this is quite an important factor
2656       array_unshift($this->_qill[$grouping], ts('Search in Trash'));
2657     }
2658   }
2659
2660   /**
2661    * Where / qill clause for contact_type
2662    *
2663    * @param $values
2664    *
2665    * @return void
2666    */
2667   public function contactType(&$values) {
2668     list($name, $op, $value, $grouping, $wildcard) = $values;
2669
2670     $subTypes = array();
2671     $clause = array();
2672
2673     // account for search builder mapping multiple values
2674     if (!is_array($value)) {
2675       $values = self::parseSearchBuilderString($value, 'String');
2676       if (is_array($values)) {
2677         $value = array_flip($values);
2678       }
2679     }
2680
2681     if (is_array($value)) {
2682       foreach ($value as $k => $v) {
2683         // fix for CRM-771
2684         if ($k) {
2685           $subType = NULL;
2686           $contactType = $k;
2687           if (strpos($k, CRM_Core_DAO::VALUE_SEPARATOR)) {
2688             list($contactType, $subType) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $k, 2);
2689           }
2690
2691           if (!empty($subType)) {
2692             $subTypes[$subType] = 1;
2693           }
2694           $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2695         }
2696       }
2697     }
2698     else {
2699       $contactTypeANDSubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value, 2);
2700       $contactType = $contactTypeANDSubType[0];
2701       $subType = CRM_Utils_Array::value(1, $contactTypeANDSubType);
2702       if (!empty($subType)) {
2703         $subTypes[$subType] = 1;
2704       }
2705       $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2706     }
2707
2708     // fix for CRM-771
2709     if (!empty($clause)) {
2710       $quill = $clause;
2711       if ($op == 'IN' || $op == 'NOT IN') {
2712         $this->_where[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2713       }
2714       else {
2715         $type = array_pop($clause);
2716         $this->_where[$grouping][] = self::buildClause("contact_a.contact_type", $op, $contactType);
2717       }
2718
2719       $this->_qill[$grouping][] = ts('Contact Type') . " $op " . implode(' ' . ts('or') . ' ', $quill);
2720
2721       if (!empty($subTypes)) {
2722         $this->includeContactSubTypes($subTypes, $grouping);
2723       }
2724     }
2725   }
2726
2727   /**
2728    * Where / qill clause for contact_sub_type
2729    *
2730    * @param $values
2731    *
2732    * @return void
2733    */
2734   public function contactSubType(&$values) {
2735     list($name, $op, $value, $grouping, $wildcard) = $values;
2736     $this->includeContactSubTypes($value, $grouping, $op);
2737   }
2738
2739   /**
2740    * @param $value
2741    * @param $grouping
2742    * @param string $op
2743    */
2744   public function includeContactSubTypes($value, $grouping, $op = 'LIKE') {
2745
2746     $clause = array();
2747     $alias = "contact_a.contact_sub_type";
2748     $qillOperators = array('NOT LIKE' => ts('Not Like')) + CRM_Core_SelectValues::getSearchBuilderOperators();
2749
2750     $op = str_replace('IN', 'LIKE', $op);
2751     $op = str_replace('=', 'LIKE', $op);
2752     $op = str_replace('!', 'NOT ', $op);
2753
2754     if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
2755       $this->_where[$grouping][] = self::buildClause($alias, $op, $value, 'String');
2756     }
2757     elseif (is_array($value)) {
2758       foreach ($value as $k => $v) {
2759         if (!empty($k)) {
2760           $clause[$k] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($k, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2761         }
2762       }
2763     }
2764     else {
2765       $clause[$value] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($value, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2766     }
2767
2768     if (!empty($clause)) {
2769       $this->_where[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2770     }
2771     $this->_qill[$grouping][] = ts('Contact Subtype %1 ', array(1 => $qillOperators[$op])) . implode(' ' . ts('or') . ' ', array_keys($clause));
2772   }
2773
2774   /**
2775    * Where / qill clause for groups
2776    *
2777    * @param $values
2778    *
2779    * @return void
2780    */
2781   public function group(&$values) {
2782     list($name, $op, $value, $grouping, $wildcard) = $values;
2783
2784     // Replace pseudo operators from search builder
2785     $op = str_replace('EMPTY', 'NULL', $op);
2786
2787     if (count($value) > 1) {
2788       if (strpos($op, 'IN') === FALSE && strpos($op, 'NULL') === FALSE) {
2789         CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $op)));
2790       }
2791       $this->_useDistinct = TRUE;
2792     }
2793
2794     $groupIds = NULL;
2795     $names = array();
2796     $isSmart = FALSE;
2797     $isNotOp = ($op == 'NOT IN' || $op == '!=');
2798
2799     if ($value) {
2800       if (strpos($op, 'IN') === FALSE) {
2801         $value = key($value);
2802       }
2803       else {
2804         $value = array_keys($value);
2805       }
2806     }
2807
2808     $statii = array();
2809     $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2810     if ($gcsValues &&
2811       is_array($gcsValues[2])
2812     ) {
2813       foreach ($gcsValues[2] as $k => $v) {
2814         if ($v) {
2815           $statii[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
2816         }
2817       }
2818     }
2819     else {
2820       $statii[] = '"Added"';
2821     }
2822
2823     $skipGroup = FALSE;
2824     if (!is_array($value) &&
2825       count($statii) == 1 &&
2826       $statii[0] == '"Added"' &&
2827       !$isNotOp
2828     ) {
2829       if (!empty($value) && CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $value, 'saved_search_id')) {
2830         $isSmart = TRUE;
2831       }
2832     }
2833
2834     $ssClause = $this->addGroupContactCache($value, NULL, "contact_a", $op);
2835     $isSmart = (!$ssClause) ? FALSE : $isSmart;
2836     $groupClause = NULL;
2837
2838     if (!$isSmart) {
2839       $groupIds = implode(',', (array) $value);
2840       $gcTable = "`civicrm_group_contact-{$groupIds}`";
2841       $joinClause = array("contact_a.id = {$gcTable}.contact_id");
2842       if ($statii) {
2843         $joinClause[] = "{$gcTable}.status IN (" . implode(', ', $statii) . ")";
2844       }
2845       $this->_tables[$gcTable] = $this->_whereTables[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
2846       $groupClause = "{$gcTable}.group_id $op $groupIds";
2847       if (strpos($op, 'IN') !== FALSE) {
2848         $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2849       }
2850     }
2851
2852     if ($ssClause) {
2853       $and = ($op == 'IS NULL') ? 'AND' : 'OR';
2854       if ($groupClause) {
2855         $groupClause = "( ( $groupClause ) $and ( $ssClause ) )";
2856       }
2857       else {
2858         $groupClause = $ssClause;
2859       }
2860     }
2861
2862     list($qillop, $qillVal) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Group', 'id', $value, $op);
2863     $this->_qill[$grouping][] = ts("Group(s) %1 %2", array(1 => $qillop, 2 => $qillVal));
2864     if (strpos($op, 'NULL') === FALSE) {
2865       $this->_qill[$grouping][] = ts("Group Status %1", array(1 => implode(' ' . ts('or') . ' ', $statii)));
2866     }
2867     if ($groupClause) {
2868       $this->_where[$grouping][] = $groupClause;
2869     }
2870   }
2871
2872   /**
2873    * Function translates selection of group type into a list of groups.
2874    * @param $value
2875    *
2876    * @return array
2877    */
2878   public function getGroupsFromTypeCriteria($value) {
2879     $groupIds = array();
2880     foreach ((array) $value as $groupTypeValue) {
2881       $groupList = CRM_Core_PseudoConstant::group($groupTypeValue);
2882       $groupIds = ($groupIds + $groupList);
2883     }
2884     return $groupIds;
2885   }
2886
2887   /**
2888    * @param array $groups
2889    * @param string $tableAlias
2890    * @param string $joinTable
2891    * @param string $op
2892    *
2893    * @return null|string
2894    */
2895   public function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a", $op) {
2896     $isNullOp = (strpos($op, 'NULL') !== FALSE);
2897     $groupsIds = $groups;
2898     if (!$isNullOp && !$groups) {
2899       return NULL;
2900     }
2901     elseif (strpos($op, 'IN') !== FALSE) {
2902       $groups = array($op => $groups);
2903     }
2904     elseif (is_array($groups) && count($groups)) {
2905       $groups = array('IN' => $groups);
2906     }
2907
2908     // Find all the groups that are part of a saved search.
2909     $smartGroupClause = self::buildClause("id", $op, $groups, 'Int');
2910     $sql = "
2911 SELECT id, cache_date, saved_search_id, children
2912 FROM   civicrm_group
2913 WHERE  $smartGroupClause
2914   AND  ( saved_search_id != 0
2915    OR    saved_search_id IS NOT NULL
2916    OR    children IS NOT NULL )
2917 ";
2918
2919     $group = CRM_Core_DAO::executeQuery($sql);
2920
2921     while ($group->fetch()) {
2922       $this->_useDistinct = TRUE;
2923       if (!$this->_smartGroupCache || $group->cache_date == NULL) {
2924         CRM_Contact_BAO_GroupContactCache::load($group);
2925       }
2926     }
2927
2928     if (!$tableAlias) {
2929       $tableAlias = "`civicrm_group_contact_cache_";
2930       $tableAlias .= ($isNullOp) ? "a`" : implode(',', (array) $groupsIds) . "`";
2931     }
2932
2933     $this->_tables[$tableAlias] = $this->_whereTables[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache {$tableAlias} ON {$joinTable}.id = {$tableAlias}.contact_id ";
2934     return self::buildClause("{$tableAlias}.group_id", $op, $groups, 'Int');
2935   }
2936
2937   /**
2938    * Where / qill clause for cms users
2939    *
2940    * @param $values
2941    *
2942    * @return void
2943    */
2944   public function ufUser(&$values) {
2945     list($name, $op, $value, $grouping, $wildcard) = $values;
2946
2947     if ($value == 1) {
2948       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2949
2950       $this->_qill[$grouping][] = ts('CMS User');
2951     }
2952     elseif ($value == 0) {
2953       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2954
2955       $this->_where[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2956       $this->_qill[$grouping][] = ts('Not a CMS User');
2957     }
2958   }
2959
2960   /**
2961    * All tag search specific.
2962    *
2963    * @param $values
2964    *
2965    * @return void
2966    */
2967   public function tagSearch(&$values) {
2968     list($name, $op, $value, $grouping, $wildcard) = $values;
2969
2970     $op = "LIKE";
2971     $value = "%{$value}%";
2972
2973     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2974     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2975
2976     $etTable = "`civicrm_entity_tag-" . $value . "`";
2977     $tTable = "`civicrm_tag-" . $value . "`";
2978
2979     if ($useAllTagTypes[2]) {
2980       $this->_tables[$etTable] = $this->_whereTables[$etTable]
2981         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
2982             LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  )";
2983
2984       // search tag in cases
2985       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2986       $tCaseTable = "`civicrm_case_tag-" . $value . "`";
2987       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
2988         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2989             LEFT JOIN civicrm_case
2990             ON (civicrm_case_contact.case_id = civicrm_case.id
2991                 AND civicrm_case.is_deleted = 0 )
2992             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
2993             LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id  )";
2994       // search tag in activities
2995       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2996       $tActTable = "`civicrm_act_tag-" . $value . "`";
2997       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2998       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
2999
3000       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3001         = " LEFT JOIN civicrm_activity_contact
3002             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3003             LEFT JOIN civicrm_activity
3004             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3005             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3006             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
3007             LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id  )";
3008
3009       $this->_where[$grouping][] = "({$tTable}.name $op '" . $value . "' OR {$tCaseTable}.name $op '" . $value . "' OR {$tActTable}.name $op '" . $value . "')";
3010       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
3011     }
3012     else {
3013       $etTable = "`civicrm_entity_tag-" . $value . "`";
3014       $tTable = "`civicrm_tag-" . $value . "`";
3015       $this->_tables[$etTable] = $this->_whereTables[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND
3016       {$etTable}.entity_table = 'civicrm_contact' )
3017                 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  ) ";
3018
3019       $this->_where[$grouping][] = self::buildClause("{$tTable}.name", $op, $value, 'String');
3020       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
3021     }
3022   }
3023
3024   /**
3025    * Where / qill clause for tag
3026    *
3027    * @param $values
3028    *
3029    * @return void
3030    */
3031   public function tag(&$values) {
3032     list($name, $op, $value, $grouping, $wildcard) = $values;
3033
3034     $tagNames = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
3035     if (is_array($value)) {
3036       if (count($value) > 1) {
3037         $this->_useDistinct = TRUE;
3038       }
3039       foreach ($value as $id => $dontCare) {
3040         $names[] = CRM_Utils_Array::value($id, $tagNames);
3041       }
3042       $names = implode(' ' . ts('or') . ' ', $names);
3043       $value = implode(',', array_keys($value));
3044     }
3045     else {
3046       $names = CRM_Utils_Array::value($value, $tagNames);
3047     }
3048
3049     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3050     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3051
3052     $etTable = "`civicrm_entity_tag-" . $value . "`";
3053
3054     if ($useAllTagTypes[2]) {
3055       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3056         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3057
3058       // search tag in cases
3059       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3060       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3061       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3062
3063       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3064         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3065             LEFT JOIN civicrm_case
3066             ON (civicrm_case_contact.case_id = civicrm_case.id
3067                 AND civicrm_case.is_deleted = 0 )
3068             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
3069       // search tag in activities
3070       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3071       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3072         = " LEFT JOIN civicrm_activity_contact
3073             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3074             LEFT JOIN civicrm_activity
3075             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3076             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3077             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
3078
3079       // CRM-10338
3080       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3081         $this->_where[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
3082       }
3083       else {
3084         $this->_where[$grouping][] = "({$etTable}.tag_id $op (" . $value . ") OR {$etCaseTable}.tag_id $op (" . $value . ") OR {$etActTable}.tag_id $op (" . $value . "))";
3085       }
3086       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names;
3087     }
3088     else {
3089       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3090         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3091
3092       // CRM-10338
3093       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3094         // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3095         $op = str_replace('EMPTY', 'NULL', $op);
3096         $this->_where[$grouping][] = "{$etTable}.tag_id $op";
3097       }
3098       else {
3099         $this->_where[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
3100       }
3101       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $names;
3102     }
3103
3104   }
3105
3106   /**
3107    * Where/qill clause for notes
3108    *
3109    * @param $values
3110    *
3111    * @return void
3112    */
3113   public function notes(&$values) {
3114     list($name, $op, $value, $grouping, $wildcard) = $values;
3115
3116     $noteOptionValues = $this->getWhereValues('note_option', $grouping);
3117     $noteOption = CRM_Utils_Array::value('2', $noteOptionValues, '6');
3118     $noteOption = ($name == 'note_body') ? 2 : (($name == 'note_subject') ? 3 : $noteOption);
3119
3120     $this->_useDistinct = TRUE;
3121
3122     $this->_tables['civicrm_note'] = $this->_whereTables['civicrm_note']
3123       = " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
3124
3125     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3126     $n = trim($value);
3127     $value = $strtolower(CRM_Core_DAO::escapeString($n));
3128     if ($wildcard || $op == 'LIKE') {
3129       if (strpos($value, '%') === FALSE) {
3130         $value = "%$value%";
3131       }
3132       $op = 'LIKE';
3133     }
3134     elseif ($op == 'IS NULL' || $op == 'IS NOT NULL') {
3135       $value = NULL;
3136     }
3137
3138     $label = NULL;
3139     $clauses = array();
3140     if ($noteOption % 2 == 0) {
3141       $clauses[] = self::buildClause('civicrm_note.note', $op, $value, 'String');
3142       $label = ts('Note: Body Only');
3143     }
3144     if ($noteOption % 3 == 0) {
3145       $clauses[] = self::buildClause('civicrm_note.subject', $op, $value, 'String');
3146       $label = $label ? ts('Note: Body and Subject') : ts('Note: Subject Only');
3147     }
3148     $this->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
3149     $this->_qill[$grouping][] = $label . " $op - '$n'";
3150   }
3151
3152   /**
3153    * @param string $name
3154    * @param $op
3155    * @param $grouping
3156    *
3157    * @return bool
3158    */
3159   public function nameNullOrEmptyOp($name, $op, $grouping) {
3160     switch ($op) {
3161       case 'IS NULL':
3162       case 'IS NOT NULL':
3163         $this->_where[$grouping][] = "contact_a.$name $op";
3164         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3165         return TRUE;
3166
3167       case 'IS EMPTY':
3168         $this->_where[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
3169         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3170         return TRUE;
3171
3172       case 'IS NOT EMPTY':
3173         $this->_where[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
3174         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3175         return TRUE;
3176
3177       default:
3178         return FALSE;
3179     }
3180   }
3181
3182   /**
3183    * Where / qill clause for sort_name
3184    *
3185    * @param $values
3186    *
3187    * @return void
3188    */
3189   public function sortName(&$values) {
3190     list($fieldName, $op, $value, $grouping, $wildcard) = $values;
3191
3192     // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3193     if ($this->nameNullOrEmptyOp($fieldName, $op, $grouping)) {
3194       return;
3195     }
3196
3197     $input = $value = trim($value);
3198
3199     if (!strlen($value)) {
3200       return;
3201     }
3202
3203     $config = CRM_Core_Config::singleton();
3204
3205     $sub = array();
3206
3207     //By default, $sub elements should be joined together with OR statements (don't change this variable).
3208     $subGlue = ' OR ';
3209
3210     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3211
3212     $firstChar = substr($value, 0, 1);
3213     $lastChar = substr($value, -1, 1);
3214     $quotes = array("'", '"');
3215     // If string is quoted, strip quotes and otherwise don't alter it
3216     if ((strlen($value) > 2) && in_array($firstChar, $quotes) && in_array($lastChar, $quotes)) {
3217       $value = trim($value, implode('', $quotes));
3218     }
3219     // Replace spaces with wildcards for a LIKE operation
3220     // UNLESS string contains a comma (this exception is a tiny bit questionable)
3221     elseif ($op == 'LIKE' && strpos($value, ',') === FALSE) {
3222       $value = str_replace(' ', '%', $value);
3223     }
3224     $value = $strtolower(CRM_Core_DAO::escapeString(trim($value)));
3225     if (strlen($value)) {
3226       $fieldsub = array();
3227       if ($wildcard && $op == 'LIKE') {
3228         if ($config->includeWildCardInName) {
3229           $value = "'%$value%'";
3230         }
3231         else {
3232           $value = "'$value%'";
3233         }
3234         $op = 'LIKE';
3235       }
3236       else {
3237         $value = "'$value'";
3238       }
3239       if ($fieldName == 'sort_name') {
3240         $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3241       }
3242       else {
3243         $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name";
3244       }
3245       $fieldsub[] = " ( $wc $op $value )";
3246       if ($config->includeNickNameInName) {
3247         $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3248         $fieldsub[] = " ( $wc $op $value )";
3249       }
3250       if ($config->includeEmailInName) {
3251         $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3252       }
3253       $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3254     }
3255
3256     $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3257
3258     $this->_where[$grouping][] = $sub;
3259     if ($config->includeEmailInName) {
3260       $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3261       $this->_qill[$grouping][] = ts('Name or Email') . " $op - '$input'";
3262     }
3263     else {
3264       $this->_qill[$grouping][] = ts('Name') . " $op - '$input'";
3265     }
3266   }
3267
3268   /**
3269    * Where/qill clause for greeting fields.
3270    *
3271    * @param array $values
3272    */
3273   public function greetings(&$values) {
3274     list($name, $op, $value, $grouping, $wildcard) = $values;
3275     $name .= '_display';
3276
3277     $this->_qill[$grouping][] = ts('Greeting %1 %2', array(1 => $op, 2 => $value));
3278     $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", 'LIKE', "$value", 'String');
3279   }
3280
3281   /**
3282    * Where / qill clause for email
3283    *
3284    * @param $values
3285    *
3286    * @return void
3287    */
3288   public function email(&$values) {
3289     list($name, $op, $value, $grouping, $wildcard) = $values;
3290
3291     $n = trim($value);
3292     if ($n) {
3293       $config = CRM_Core_Config::singleton();
3294
3295       if (substr($n, 0, 1) == '"' &&
3296         substr($n, -1, 1) == '"'
3297       ) {
3298         $n = substr($n, 1, -1);
3299         $value = strtolower(CRM_Core_DAO::escapeString($n));
3300         $value = "'$value'";
3301         $op = '=';
3302       }
3303       else {
3304         $value = strtolower($n);
3305         if ($wildcard) {
3306           if (strpos($value, '%') === FALSE) {
3307             $value = "%{$value}%";
3308           }
3309           $op = 'LIKE';
3310         }
3311       }
3312       $this->_qill[$grouping][] = ts('Email') . " $op '$n'";
3313       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, $value, 'String');
3314     }
3315     else {
3316       $this->_qill[$grouping][] = ts('Email') . " $op ";
3317       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, NULL, 'String');
3318     }
3319
3320     $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3321   }
3322
3323   /**
3324    * Where / qill clause for phone number
3325    *
3326    * @param $values
3327    *
3328    * @return void
3329    */
3330   public function phone_numeric(&$values) {
3331     list($name, $op, $value, $grouping, $wildcard) = $values;
3332     // Strip non-numeric characters; allow wildcards
3333     $number = preg_replace('/[^\d%]/', '', $value);
3334     if ($number) {
3335       if (strpos($number, '%') === FALSE) {
3336         $number = "%$number%";
3337       }
3338
3339       $this->_qill[$grouping][] = ts('Phone number contains') . " $number";
3340       $this->_where[$grouping][] = self::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3341       $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3342     }
3343   }
3344
3345   /**
3346    * Where / qill clause for phone type/location
3347    *
3348    * @param $values
3349    *
3350    * @return void
3351    */
3352   public function phone_option_group($values) {
3353     list($name, $op, $value, $grouping, $wildcard) = $values;
3354     $option = ($name == 'phone_phone_type_id' ? 'phone_type_id' : 'location_type_id');
3355     $options = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', $option);
3356     $optionName = $options[$value];
3357     $this->_qill[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ? ts('type') : ('location')) . " $op $optionName";
3358     $this->_where[$grouping][] = self::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3359     $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3360   }
3361
3362   /**
3363    * Where / qill clause for street_address
3364    *
3365    * @param $values
3366    *
3367    * @return void
3368    */
3369   public function street_address(&$values) {
3370     list($name, $op, $value, $grouping, $wildcard) = $values;
3371
3372     if (!$op) {
3373       $op = 'LIKE';
3374     }
3375
3376     $n = trim($value);
3377
3378     if ($n) {
3379       $value = strtolower($n);
3380       if (strpos($value, '%') === FALSE) {
3381         // only add wild card if not there
3382         $value = "%{$value}%";
3383       }
3384       $op = 'LIKE';
3385       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3386       $this->_qill[$grouping][] = ts('Street') . " $op '$n'";
3387     }
3388     else {
3389       $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3390       $this->_qill[$grouping][] = ts('Street') . " $op ";
3391     }
3392
3393     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3394   }
3395
3396   /**
3397    * Where / qill clause for street_unit
3398    *
3399    * @param $values
3400    *
3401    * @return void
3402    */
3403   public function street_number(&$values) {
3404     list($name, $op, $value, $grouping, $wildcard) = $values;
3405
3406     if (!$op) {
3407       $op = '=';
3408     }
3409
3410     $n = trim($value);
3411
3412     if (strtolower($n) == 'odd') {
3413       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3414       $this->_qill[$grouping][] = ts('Street Number is odd');
3415     }
3416     elseif (strtolower($n) == 'even') {
3417       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3418       $this->_qill[$grouping][] = ts('Street Number is even');
3419     }
3420     else {
3421       $value = strtolower($n);
3422
3423       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3424       $this->_qill[$grouping][] = ts('Street Number') . " $op '$n'";
3425     }
3426
3427     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3428   }
3429
3430   /**
3431    * Where / qill clause for sorting by character
3432    *
3433    * @param $values
3434    *
3435    * @return void
3436    */
3437   public function sortByCharacter(&$values) {
3438     list($name, $op, $value, $grouping, $wildcard) = $values;
3439
3440     $name = trim($value);
3441     $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($name)) . "%'";
3442     $this->_where[$grouping][] = $cond;
3443     $this->_qill[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3444   }
3445
3446   /**
3447    * Where / qill clause for including contact ids
3448    *
3449    * @return void
3450    */
3451   public function includeContactIDs() {
3452     if (!$this->_includeContactIds || empty($this->_params)) {
3453       return;
3454     }
3455
3456     $contactIds = array();
3457     foreach ($this->_params as $id => $values) {
3458       if (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
3459         $contactIds[] = substr($values[0], CRM_Core_Form::CB_PREFIX_LEN);
3460       }
3461     }
3462     if (!empty($contactIds)) {
3463       $this->_where[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3464     }
3465   }
3466
3467   /**
3468    * Where / qill clause for postal code
3469    *
3470    * @param $values
3471    *
3472    * @return void
3473    */
3474   public function postalCode(&$values) {
3475     // skip if the fields dont have anything to do with postal_code
3476     if (empty($this->_fields['postal_code'])) {
3477       return;
3478     }
3479
3480     list($name, $op, $value, $grouping, $wildcard) = $values;
3481
3482     // Handle numeric postal code range searches properly by casting the column as numeric
3483     if (is_numeric($value)) {
3484       $field = 'ROUND(civicrm_address.postal_code)';
3485       $val = CRM_Utils_Type::escape($value, 'Integer');
3486     }
3487     else {
3488       $field = 'civicrm_address.postal_code';
3489       $val = CRM_Utils_Type::escape($value, 'String');
3490     }
3491
3492     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3493
3494     if ($name == 'postal_code') {
3495       $this->_where[$grouping][] = self::buildClause($field, $op, $val, 'String');
3496       $this->_qill[$grouping][] = ts('Postal code') . " {$op} {$value}";
3497     }
3498     elseif ($name == 'postal_code_low') {
3499       $this->_where[$grouping][] = " ( $field >= '$val' ) ";
3500       $this->_qill[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3501     }
3502     elseif ($name == 'postal_code_high') {
3503       $this->_where[$grouping][] = " ( $field <= '$val' ) ";
3504       $this->_qill[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3505     }
3506   }
3507
3508   /**
3509    * Where / qill clause for location type
3510    *
3511    * @param $values
3512    * @param null $status
3513    *
3514    * @return void
3515    */
3516   public function locationType(&$values, $status = NULL) {
3517     list($name, $op, $value, $grouping, $wildcard) = $values;
3518
3519     if (is_array($value)) {
3520       $this->_where[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', $value) . ')';
3521       $this->_tables['civicrm_address'] = 1;
3522       $this->_whereTables['civicrm_address'] = 1;
3523
3524       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
3525       $names = array();
3526       foreach ($value as $id) {
3527         $names[] = $locationType[$id];
3528       }
3529
3530       $this->_primaryLocation = FALSE;
3531
3532       if (!$status) {
3533         $this->_qill[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3534       }
3535       else {
3536         return implode(' ' . ts('or') . ' ', $names);
3537       }
3538     }
3539   }
3540
3541   /**
3542    * @param $values
3543    * @param bool $fromStateProvince
3544    *
3545    * @return array|NULL
3546    */
3547   public function country(&$values, $fromStateProvince = TRUE) {
3548     list($name, $op, $value, $grouping, $wildcard) = $values;
3549
3550     if (!$fromStateProvince) {
3551       $stateValues = $this->getWhereValues('state_province', $grouping);
3552       if (!empty($stateValues)) {
3553         // return back to caller if there are state province values
3554         // since that handles this case
3555         return NULL;
3556       }
3557     }
3558
3559     $countryClause = $countryQill = NULL;
3560     if (
3561       $values &&
3562       !empty($value)
3563     ) {
3564
3565       $this->_tables['civicrm_address'] = 1;
3566       $this->_whereTables['civicrm_address'] = 1;
3567
3568       $countries = CRM_Core_PseudoConstant::country();
3569       if (is_numeric($value)) {
3570         $countryClause = self::buildClause(
3571           'civicrm_address.country_id',
3572           $op,
3573           $value,
3574           'Positive'
3575         );
3576         $countryName = $countries[(int ) $value];
3577       }
3578
3579       else {
3580         $intValues = self::parseSearchBuilderString($value);
3581         if ($intValues && ($op == 'IN' || $op == 'NOT IN')) {
3582           $countryClause = self::buildClause(
3583             'civicrm_address.country_id',
3584             $op,
3585             $intValues,
3586             'Positive'
3587           );
3588           $countryNames = array();
3589           foreach ($intValues as $v) {
3590             $countryNames[] = $countries[$v];
3591           }
3592           $countryName = implode(',', $countryNames);
3593         }
3594         else {
3595           $countries = CRM_Core_PseudoConstant::country();
3596           $intVal = CRM_Utils_Array::key($value, $countries);
3597           $countryClause = self::buildClause(
3598             'civicrm_address.country_id',
3599             $op,
3600             $intVal,
3601             'Integer'
3602           );
3603           $countryName = $value;
3604         }
3605       }
3606       $countryQill = ts('Country') . " {$op} '$countryName'";
3607
3608       if (!$fromStateProvince) {
3609         $this->_where[$grouping][] = $countryClause;
3610         $this->_qill[$grouping][] = $countryQill;
3611       }
3612     }
3613
3614     if ($fromStateProvince) {
3615       if (!empty($countryClause)) {
3616         return array(
3617           $countryClause,
3618           " ...AND... " . $countryQill,
3619         );
3620       }
3621       else {
3622         return array(NULL, NULL);
3623       }
3624     }
3625   }
3626
3627   /**
3628    * Where / qill clause for county (if present)
3629    *
3630    * @param $values
3631    * @param null $status
3632    *
3633    * @return void
3634    */
3635   public function county(&$values, $status = NULL) {
3636     list($name, $op, $value, $grouping, $wildcard) = $values;
3637
3638     if (!is_array($value)) {
3639       // force the county to be an array
3640       $value = array($value);
3641     }
3642
3643     // check if the values are ids OR names of the counties
3644     $inputFormat = 'id';
3645     foreach ($value as $v) {
3646       if (!is_numeric($v)) {
3647         $inputFormat = 'name';
3648         break;
3649       }
3650     }
3651     $names = array();
3652     if ($op == '=') {
3653       $op = 'IN';
3654     }
3655     elseif ($op == '!=') {
3656       $op = 'NOT IN';
3657     }
3658     else {
3659       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3660       $op = str_replace('EMPTY', 'NULL', $op);
3661     }
3662
3663     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3664       $clause = "civicrm_address.county_id $op";
3665     }
3666     elseif ($inputFormat == 'id') {
3667       $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3668
3669       $county = CRM_Core_PseudoConstant::county();
3670       foreach ($value as $id) {
3671         $names[] = CRM_Utils_Array::value($id, $county);
3672       }
3673     }
3674     else {
3675       $inputClause = array();
3676       $county = CRM_Core_PseudoConstant::county();
3677       foreach ($value as $name) {
3678         $name = trim($name);
3679         $inputClause[] = CRM_Utils_Array::key($name, $county);
3680       }
3681       $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3682       $names = $value;
3683     }
3684     $this->_tables['civicrm_address'] = 1;
3685     $this->_whereTables['civicrm_address'] = 1;
3686
3687     $this->_where[$grouping][] = $clause;
3688     if (!$status) {
3689       $this->_qill[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3690     }
3691     else {
3692       return implode(' ' . ts('or') . ' ', $names);
3693     }
3694   }
3695
3696   /**
3697    * Where / qill clause for state/province AND country (if present)
3698    *
3699    * @param $values
3700    * @param null $status
3701    *
3702    * @return void
3703    */
3704   public function stateProvince(&$values, $status = NULL) {
3705     list($name, $op, $value, $grouping, $wildcard) = $values;
3706
3707     // quick escape for IS NULL
3708     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3709       $value = NULL;
3710     }
3711     elseif (!is_array($value)) {
3712       // force the state to be an array
3713       // check if its in the mapper format!
3714       $values = self::parseSearchBuilderString($value);
3715       if (is_array($values)) {
3716         $value = $values;
3717       }
3718       else {
3719         $value = array($value);
3720       }
3721     }
3722
3723     // check if the values are ids OR names of the states
3724     $inputFormat = 'id';
3725     if ($value) {
3726       foreach ($value as $v) {
3727         if (!is_numeric($v)) {
3728           $inputFormat = 'name';
3729           break;
3730         }
3731       }
3732     }
3733
3734     $names = array();
3735     if ($op == '=') {
3736       $op = 'IN';
3737     }
3738     elseif ($op == '!=') {
3739       $op = 'NOT IN';
3740     }
3741     else {
3742       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3743       $op = str_replace('EMPTY', 'NULL', $op);
3744     }
3745     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3746       $stateClause = "civicrm_address.state_province_id $op";
3747     }
3748     elseif ($inputFormat == 'id') {
3749       if ($op != 'NOT IN') {
3750         $op = 'IN';
3751       }
3752       $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')';
3753
3754       foreach ($value as $id) {
3755         $names[] = CRM_Core_PseudoConstant::stateProvince($id, FALSE);
3756       }
3757     }
3758     else {
3759       $inputClause = array();
3760       $stateProvince = CRM_Core_PseudoConstant::stateProvince();
3761       foreach ($value as $name) {
3762         $name = trim($name);
3763         $inputClause[] = CRM_Utils_Array::key($name, $stateProvince);
3764       }
3765       $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')';
3766       $names = $value;
3767     }
3768     $this->_tables['civicrm_address'] = 1;
3769     $this->_whereTables['civicrm_address'] = 1;
3770
3771     $countryValues = $this->getWhereValues('country', $grouping);
3772     list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3773
3774     if ($countryClause) {
3775       $clause = "( $stateClause AND $countryClause )";
3776     }
3777     else {
3778       $clause = $stateClause;
3779     }
3780
3781     $this->_where[$grouping][] = $clause;
3782     if (!$status) {
3783       $this->_qill[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3784     }
3785     else {
3786       return implode(' ' . ts('or') . ' ', $names) . $countryQill;
3787     }
3788   }
3789
3790   /**
3791    * Where / qill clause for change log
3792    *
3793    * @param $values
3794    *
3795    * @return void
3796    */
3797   public function changeLog(&$values) {
3798     list($name, $op, $value, $grouping, $wildcard) = $values;
3799
3800     $targetName = $this->getWhereValues('changed_by', $grouping);
3801     if (!$targetName) {
3802       return;
3803     }
3804
3805     $name = trim($targetName[2]);
3806     $name = strtolower(CRM_Core_DAO::escapeString($name));
3807     $name = $targetName[4] ? "%$name%" : $name;
3808     $this->_where[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3809     $this->_tables['civicrm_log'] = $this->_whereTables['civicrm_log'] = 1;
3810     $this->_qill[$grouping][] = ts('Modified By') . " $name";
3811   }
3812
3813   /**
3814    * @param $values
3815    */
3816   public function modifiedDates($values) {
3817     $this->_useDistinct = TRUE;
3818
3819     // CRM-11281, default to added date if not set
3820     $fieldTitle = ts('Added Date');
3821     $fieldName = 'created_date';
3822     foreach (array_keys($this->_params) as $id) {
3823       if ($this->_params[$id][0] == 'log_date') {
3824         if ($this->_params[$id][2] == 2) {
3825           $fieldTitle = ts('Modified Date');
3826           $fieldName = 'modified_date';
3827         }
3828       }
3829     }
3830
3831     $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3832
3833     self::$_openedPanes[ts('Change Log')] = TRUE;
3834   }
3835
3836   /**
3837    * @param $values
3838    */
3839   public function demographics(&$values) {
3840     list($name, $op, $value, $grouping, $wildcard) = $values;
3841
3842     if (($name == 'birth_date_low') || ($name == 'birth_date_high')) {
3843
3844       $this->dateQueryBuilder($values,
3845         'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3846       );
3847     }
3848     elseif (($name == 'deceased_date_low') || ($name == 'deceased_date_high')) {
3849
3850       $this->dateQueryBuilder($values,
3851         'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3852       );
3853     }
3854
3855     self::$_openedPanes[ts('Demographics')] = TRUE;
3856   }
3857
3858   /**
3859    * @param $values
3860    */
3861   public function privacy(&$values) {
3862     list($name, $op, $value, $grouping, $wildcard) = $values;
3863     //fixed for profile search listing CRM-4633
3864     if (strpbrk($value, "[")) {
3865       $value = "'{$value}'";
3866       $op = "!{$op}";
3867       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3868     }
3869     else {
3870       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3871     }
3872     $field = CRM_Utils_Array::value($name, $this->_fields);
3873     $title = $field ? $field['title'] : $name;
3874     $this->_qill[$grouping][] = "$title $op $value";
3875   }
3876
3877   /**
3878    * @param $values
3879    */
3880   public function privacyOptions($values) {
3881     list($name, $op, $value, $grouping, $wildcard) = $values;
3882
3883     if (empty($value) || !is_array($value)) {
3884       return;
3885     }
3886
3887     // get the operator and toggle values
3888     $opValues = $this->getWhereValues('privacy_operator', $grouping);
3889     $operator = 'OR';
3890     if ($opValues &&
3891       strtolower($opValues[2] == 'AND')
3892     ) {
3893       $operator = 'AND';
3894     }
3895
3896     $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3897     $compareOP = '!';
3898     if ($toggleValues &&
3899       $toggleValues[2] == 2
3900     ) {
3901       $compareOP = '';
3902     }
3903
3904     $clauses = array();
3905     $qill = array();
3906     foreach ($value as $dontCare => $pOption) {
3907       $clauses[] = " ( contact_a.{$pOption} = 1 ) ";
3908       $field = CRM_Utils_Array::value($pOption, $this->_fields);
3909       $title = $field ? $field['title'] : $pOption;
3910       $qill[] = " $title = 1 ";
3911     }
3912
3913     $this->_where[$grouping][] = $compareOP . '( ' . implode($operator, $clauses) . ' )';
3914     $this->_qill[$grouping][] = $compareOP . '( ' . implode($operator, $qill) . ' )';
3915   }
3916
3917   /**
3918    * @param $values
3919    */
3920   public function preferredCommunication(&$values) {
3921     list($name, $op, $value, $grouping, $wildcard) = $values;
3922
3923     $pref = array();
3924     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3925       $value = NULL;
3926     }
3927     elseif (!is_array($value)) {
3928       $v = array();
3929       $value = trim($value, ' ()');
3930       if (strpos($value, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
3931         $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
3932       }
3933       else {
3934         $v = explode(",", $value);
3935       }
3936
3937       foreach ($v as $item) {
3938         if ($item) {
3939           $pref[] = $item;
3940         }
3941       }
3942     }
3943     else {
3944       foreach ($value as $key => $checked) {
3945         if ($checked) {
3946           $pref[] = $key;
3947         }
3948       }
3949     }
3950
3951     $commPref = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
3952
3953     $sqlValue = array();
3954     $showValue = array();
3955     $sql = "contact_a.preferred_communication_method";
3956     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3957       $sqlValue[] = "{$sql} {$op}";
3958     }
3959     else {
3960       foreach ($pref as $val) {
3961         $sqlValue[] = "( $sql like '%" . CRM_Core_DAO::VALUE_SEPARATOR . $val . CRM_Core_DAO::VALUE_SEPARATOR . "%' ) ";
3962         $showValue[] = $commPref[$val];
3963       }
3964     }
3965     $this->_where[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
3966     $this->_qill[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
3967   }
3968
3969   /**
3970    * Where / qill clause for relationship
3971    *
3972    * @param $values
3973    *
3974    * @return void
3975    */
3976   public function relationship(&$values) {
3977     list($name, $op, $value, $grouping, $wildcard) = $values;
3978     if ($this->_relationshipValuesAdded) {
3979       return;
3980     }
3981     // also get values array for relation_target_name
3982     // for relationship search we always do wildcard
3983     $relationType = $this->getWhereValues('relation_type_id', $grouping);
3984     $targetName = $this->getWhereValues('relation_target_name', $grouping);
3985     $relStatus = $this->getWhereValues('relation_status', $grouping);
3986     $relPermission = $this->getWhereValues('relation_permission', $grouping);
3987     $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
3988
3989     $nameClause = $name = NULL;
3990     if ($targetName) {
3991       $name = trim($targetName[2]);
3992       if (substr($name, 0, 1) == '"' &&
3993         substr($name, -1, 1) == '"'
3994       ) {
3995         $name = substr($name, 1, -1);
3996         $name = strtolower(CRM_Core_DAO::escapeString($name));
3997         $nameClause = "= '$name'";
3998       }
3999       else {
4000         $name = strtolower(CRM_Core_DAO::escapeString($name));
4001         $nameClause = "LIKE '%{$name}%'";
4002       }
4003     }
4004
4005     $rTypeValues = array();
4006     if (!empty($relationType)) {
4007       $rel = explode('_', $relationType[2]);
4008       self::$_relType = $rel[1];
4009       $params = array('id' => $rel[0]);
4010       $rType = CRM_Contact_BAO_RelationshipType::retrieve($params, $rTypeValues);
4011     }
4012     if (!empty($rTypeValues) && $rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
4013       // if we don't know which end of the relationship we are dealing with we'll create a temp table
4014       //@todo unless we are dealing with a target group
4015       self::$_relType = 'reciprocal';
4016     }
4017     // if we are creating a temp table we build our own where for the relationship table
4018     $relationshipTempTable = NULL;
4019     if (self::$_relType == 'reciprocal' && empty($targetGroup)) {
4020       $where = array();
4021       self::$_relationshipTempTable = $relationshipTempTable = CRM_Core_DAO::createTempTableName('civicrm_rel');
4022       if ($nameClause) {
4023         $where[$grouping][] = " sort_name $nameClause ";
4024       }
4025     }
4026     else {
4027       $where = &$this->_where;
4028       if ($nameClause) {
4029         $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
4030       }
4031     }
4032
4033     $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
4034     $relTypeOrg = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
4035     $relTypeHou = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Household');
4036     $allRelationshipType = array();
4037     $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
4038     $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
4039
4040     if ($nameClause || !$targetGroup) {
4041       if (!empty($relationType)) {
4042         $this->_qill[$grouping][] = $allRelationshipType[$relationType[2]] . " $name";
4043       }
4044       else {
4045         $this->_qill[$grouping][] = $name;
4046       }
4047     }
4048
4049     //check to see if the target contact is in specified group
4050     if ($targetGroup) {
4051       //add contacts from static groups
4052       $this->_tables['civicrm_relationship_group_contact'] = $this->_whereTables['civicrm_relationship_group_contact']
4053         = " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = contact_b.id AND civicrm_relationship_group_contact.status = 'Added'";
4054       $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN  (" .
4055         implode(",", $targetGroup[2]) . ") ) ";
4056
4057       //add contacts from saved searches
4058       $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b", $op);
4059
4060       //set the group where clause
4061       if ($ssWhere) {
4062         $groupWhere[] = "( " . $ssWhere . " )";
4063       }
4064       $this->_where[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
4065
4066       //Get the names of the target groups for the qill
4067       $groupNames = CRM_Core_PseudoConstant::group();
4068       $qillNames = array();
4069       foreach ($targetGroup[2] as $groupId) {
4070         if (array_key_exists($groupId, $groupNames)) {
4071           $qillNames[] = $groupNames[$groupId];
4072         }
4073       }
4074       if (!empty($relationType)) {
4075         $this->_qill[$grouping][] = $allRelationshipType[$relationType[2]] . " ( " . implode(", ", $qillNames) . " )";
4076       }
4077       else {
4078         $this->_qill[$grouping][] = implode(", ", $qillNames);
4079       }
4080     }
4081
4082     // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
4083     $today = date('Ymd');
4084     //check for active, inactive and all relation status
4085     if ($relStatus[2] == 0) {
4086       $where[$grouping][] = "(
4087 civicrm_relationship.is_active = 1 AND
4088 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
4089 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
4090 )";
4091       $this->_qill[$grouping][] = ts('Relationship - Active and Current');
4092     }
4093     elseif ($relStatus[2] == 1) {
4094       $where[$grouping][] = "(
4095 civicrm_relationship.is_active = 0 OR
4096 civicrm_relationship.end_date < {$today} OR
4097 civicrm_relationship.start_date > {$today}
4098 )";
4099       $this->_qill[$grouping][] = ts('Relationship - Inactive or not Current');
4100     }
4101
4102     $onlyDeleted = 0;
4103     if (in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params)) {
4104       $onlyDeleted = 1;
4105     }
4106     $where[$grouping][] = "(contact_b.is_deleted = {$onlyDeleted})";
4107
4108     //check for permissioned, non-permissioned and all permissioned relations
4109     if ($relPermission[2] == 1) {
4110       $where[$grouping][] = "(
4111 civicrm_relationship.is_permission_a_b = 1
4112 )";
4113       $this->_qill[$grouping][] = ts('Relationship - Permissioned');
4114     }
4115     elseif ($relPermission[2] == 2) {
4116       //non-allowed permission relationship.
4117       $where[$grouping][] = "(
4118 civicrm_relationship.is_permission_a_b = 0
4119 )";
4120       $this->_qill[$grouping][] = ts('Relationship - Non-permissioned');
4121     }
4122
4123     $this->addRelationshipDateClauses($grouping, $where);
4124     if (!empty($relationType) && !empty($rType) && isset($rType->id)) {
4125       $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id;
4126     }
4127     $this->_tables['civicrm_relationship'] = $this->_whereTables['civicrm_relationship'] = 1;
4128     $this->_useDistinct = TRUE;
4129     $this->_relationshipValuesAdded = TRUE;
4130     // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
4131     // join on that,
4132     // @todo creating a temp table could be expanded to group filter
4133     // as even creating a temp table of all relationships is much much more efficient than
4134     // an OR in the join
4135     if ($relationshipTempTable) {
4136       $whereClause = '';
4137       if (!empty($where[$grouping])) {
4138         $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
4139         $whereClause = str_replace('contact_b', 'c', $whereClause);
4140       }
4141       $sql = "
4142         CREATE TEMPORARY TABLE {$relationshipTempTable}
4143           (SELECT contact_id_b as contact_id, civicrm_relationship.id
4144             FROM civicrm_relationship
4145             INNER JOIN  civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
4146             $whereClause )
4147           UNION
4148             (SELECT contact_id_a as contact_id, civicrm_relationship.id
4149             FROM civicrm_relationship
4150             INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
4151             $whereClause )
4152       ";
4153       CRM_Core_DAO::executeQuery($sql);
4154     }
4155
4156   }
4157
4158   /**
4159    * Add start & end date criteria in
4160    * @param string $grouping
4161    * @param array $where
4162    *   = array to add where clauses to, in case you are generating a temp table.
4163    * not the main query.
4164    */
4165   public function addRelationshipDateClauses($grouping, &$where) {
4166     $dateValues = array();
4167     $dateTypes = array(
4168       'start_date',
4169       'end_date',
4170     );
4171
4172     foreach ($dateTypes as $dateField) {
4173       $dateValueLow = $this->getWhereValues('relation_' . $dateField . '_low', $grouping);
4174       $dateValueHigh = $this->getWhereValues('relation_' . $dateField . '_high', $grouping);
4175       if (!empty($dateValueLow)) {
4176         $date = date('Ymd', strtotime($dateValueLow[2]));
4177         $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4178         $this->_qill[$grouping][] = ($dateField == 'end_date' ? ts('Relationship Ended on or After') : ts('Relationship Recorded Start Date On or Before')) . " " . CRM_Utils_Date::customFormat($date);
4179       }
4180       if (!empty($dateValueHigh)) {
4181         $date = date('Ymd', strtotime($dateValueHigh[2]));
4182         $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4183         $this->_qill[$grouping][] = ($dateField == 'end_date' ? ts('Relationship Ended on or Before') : ts('Relationship Recorded Start Date On or After')) . " " . CRM_Utils_Date::customFormat($date);
4184       }
4185     }
4186   }
4187
4188   /**
4189    * Default set of return properties.
4190    *
4191    * @param int $mode
4192    *
4193    * @return array
4194    *   derault return properties
4195    */
4196   public static function &defaultReturnProperties($mode = 1) {
4197     if (!isset(self::$_defaultReturnProperties)) {
4198       self::$_defaultReturnProperties = array();
4199     }
4200
4201     if (!isset(self::$_defaultReturnProperties[$mode])) {
4202       // add activity return properties
4203       if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
4204         self::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query::defaultReturnProperties($mode, FALSE);
4205       }
4206       else {
4207         self::$_defaultReturnProperties[$mode] = CRM_Core_Component::defaultReturnProperties($mode, FALSE);
4208       }
4209
4210       if (empty(self::$_defaultReturnProperties[$mode])) {
4211         self::$_defaultReturnProperties[$mode] = array(
4212           'home_URL' => 1,
4213           'image_URL' => 1,
4214           'legal_identifier' => 1,
4215           'external_identifier' => 1,
4216           'contact_type' => 1,
4217           'contact_sub_type' => 1,
4218           'sort_name' => 1,
4219           'display_name' => 1,
4220           'preferred_mail_format' => 1,
4221           'nick_name' => 1,
4222           'first_name' => 1,
4223           'middle_name' => 1,
4224           'last_name' => 1,
4225           'prefix_id' => 1,
4226           'suffix_id' => 1,
4227           'formal_title' => 1,
4228           'communication_style_id' => 1,
4229           'birth_date' => 1,
4230           'gender_id' => 1,
4231           'street_address' => 1,
4232           'supplemental_address_1' => 1,
4233           'supplemental_address_2' => 1,
4234           'city' => 1,
4235           'postal_code' => 1,
4236           'postal_code_suffix' => 1,
4237           'state_province' => 1,
4238           'country' => 1,
4239           'world_region' => 1,
4240           'geo_code_1' => 1,
4241           'geo_code_2' => 1,
4242           'email' => 1,
4243           'on_hold' => 1,
4244           'phone' => 1,
4245           'im' => 1,
4246           'household_name' => 1,
4247           'organization_name' => 1,
4248           'deceased_date' => 1,
4249           'is_deceased' => 1,
4250           'job_title' => 1,
4251           'legal_name' => 1,
4252           'sic_code' => 1,
4253           'current_employer' => 1,
4254           // FIXME: should we use defaultHierReturnProperties() for the below?
4255           'do_not_email' => 1,
4256           'do_not_mail' => 1,
4257           'do_not_sms' => 1,
4258           'do_not_phone' => 1,
4259           'do_not_trade' => 1,
4260           'is_opt_out' => 1,
4261           'contact_is_deleted' => 1,
4262           'preferred_communication_method' => 1,
4263           'preferred_language' => 1,
4264         );
4265       }
4266     }
4267     return self::$_defaultReturnProperties[$mode];
4268   }
4269
4270   /**
4271    * Get primary condition for a sql clause.
4272    *
4273    * @param int $value
4274    *
4275    * @return string|NULL
4276    */
4277   public static function getPrimaryCondition($value) {
4278     if (is_numeric($value)) {
4279       $value = (int ) $value;
4280       return ($value == 1) ? 'is_primary = 1' : 'is_primary = 0';
4281     }
4282     return NULL;
4283   }
4284
4285   /**
4286    * Wrapper for a simple search query.
4287    *
4288    * @param array $params
4289    * @param array $returnProperties
4290    * @param bool $count
4291    *
4292    * @return string
4293    */
4294   public static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4295     $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4296     list($select, $from, $where, $having) = $query->query();
4297
4298     return "$select $from $where $having";
4299   }
4300
4301   /**
4302    * These are stub comments as this function needs more explanation - particularly in terms of how it
4303    * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4304    *
4305    * This function was originally written as a wrapper for the api query but is called from multiple places
4306    * in the core code directly so the name is misleading. This function does not use the searchQuery function
4307    * but it is unclear as to whehter that is historical or there is a reason
4308    *  CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4309    *
4310    * @param array $params
4311    * @param array $returnProperties
4312    * @param null $fields
4313    * @param string $sort
4314    * @param int $offset
4315    * @param int $row_count
4316    * @param bool $smartGroupCache
4317    *   ?? update smart group cache?.
4318    * @param bool $count
4319    *   Return count obnly.
4320    * @param bool $skipPermissions
4321    *   Should permissions be ignored or should the logged in user's permissions be applied.
4322    *
4323    *
4324    * @return array
4325    */
4326   public static function apiQuery(
4327     $params = NULL,
4328     $returnProperties = NULL,
4329     $fields = NULL,
4330     $sort = NULL,
4331     $offset = 0,
4332     $row_count = 25,
4333     $smartGroupCache = TRUE,
4334     $count = FALSE,
4335     $skipPermissions = TRUE
4336   ) {
4337
4338     $query = new CRM_Contact_BAO_Query(
4339       $params, $returnProperties,
4340       NULL, TRUE, FALSE, 1,
4341       $skipPermissions,
4342       TRUE, $smartGroupCache
4343     );
4344
4345     //this should add a check for view deleted if permissions are enabled
4346     if ($skipPermissions) {
4347       $query->_skipDeleteClause = TRUE;
4348     }
4349     $query->generatePermissionClause(FALSE, $count);
4350
4351     // note : this modifies _fromClause and _simpleFromClause
4352     $query->includePseudoFieldsJoin($sort);
4353
4354     list($select, $from, $where, $having) = $query->query($count);
4355
4356     $options = $query->_options;
4357     if (!empty($query->_permissionWhereClause)) {
4358       if (empty($where)) {
4359         $where = "WHERE $query->_permissionWhereClause";
4360       }
4361       else {
4362         $where = "$where AND $query->_permissionWhereClause";
4363       }
4364     }
4365
4366     $sql = "$select $from $where $having";
4367
4368     // add group by
4369     if ($query->_useGroupBy) {
4370       $sql .= ' GROUP BY contact_a.id';
4371     }
4372     if (!empty($sort)) {
4373       $sort = CRM_Utils_Type::escape($sort, 'String');
4374       $sql .= " ORDER BY $sort ";
4375     }
4376     if ($row_count > 0 && $offset >= 0) {
4377       $offset = CRM_Utils_Type::escape($offset, 'Int');
4378       $rowCount = CRM_Utils_Type::escape($row_count, 'Int');
4379       $sql .= " LIMIT $offset, $row_count ";
4380     }
4381
4382     $dao = CRM_Core_DAO::executeQuery($sql);
4383
4384     $values = array();
4385     while ($dao->fetch()) {
4386       if ($count) {
4387         $noRows = $dao->rowCount;
4388         $dao->free();
4389         return array($noRows, NULL);
4390       }
4391       $val = $query->store($dao);
4392       $convertedVals = $query->convertToPseudoNames($dao, TRUE);
4393
4394       if (!empty($convertedVals)) {
4395         $val = array_replace_recursive($val, $convertedVals);
4396       }
4397       $values[$dao->contact_id] = $val;
4398     }
4399     $dao->free();
4400     return array($values, $options);
4401   }
4402
4403   /**
4404    * Create and query the db for an contact search.
4405    *
4406    * @param int $offset
4407    *   The offset for the query.
4408    * @param int $rowCount
4409    *   The number of rows to return.
4410    * @param string $sort
4411    *   The order by string.
4412    * @param bool $count
4413    *   Is this a count only query ?.
4414    * @param bool $includeContactIds
4415    *   Should we include contact ids?.
4416    * @param bool $sortByChar
4417    *   If true returns the distinct array of first characters for search results.
4418    * @param bool $groupContacts
4419    *   If true, return only the contact ids.
4420    * @param bool $returnQuery
4421    *   Should we return the query as a string.
4422    * @param string $additionalWhereClause
4423    *   If the caller wants to further restrict the search (used for components).
4424    * @param null $sortOrder
4425    * @param string $additionalFromClause
4426    *   Should be clause with proper joins, effective to reduce where clause load.
4427    *
4428    * @param bool $skipOrderAndLimit
4429    *
4430    * @return CRM_Core_DAO
4431    */
4432   public function searchQuery(
4433     $offset = 0, $rowCount = 0, $sort = NULL,
4434     $count = FALSE, $includeContactIds = FALSE,
4435     $sortByChar = FALSE, $groupContacts = FALSE,
4436     $returnQuery = FALSE,
4437     $additionalWhereClause = NULL, $sortOrder = NULL,
4438     $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4439   ) {
4440
4441     if ($includeContactIds) {
4442       $this->_includeContactIds = TRUE;
4443       $this->_whereClause = $this->whereClause();
4444     }
4445
4446     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4447
4448     // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4449     // and that contact happens to be deleted, set $onlyDeleted to true
4450     foreach ($this->_params as $values) {
4451       $name = CRM_Utils_Array::value(0, $values);
4452       $op = CRM_Utils_Array::value(1, $values);
4453       $value = CRM_Utils_Array::value(2, $values);
4454       if ($name == 'contact_id' and $op == '=') {
4455         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4456           $onlyDeleted = TRUE;
4457         }
4458         break;
4459       }
4460     }
4461
4462     // building the query string
4463     $groupBy = NULL;
4464     if (!$count) {
4465       if (isset($this->_groupByComponentClause)) {
4466         $groupBy = $this->_groupByComponentClause;
4467       }
4468       elseif ($this->_useGroupBy) {
4469         $groupBy = ' GROUP BY contact_a.id';
4470       }
4471     }
4472     if ($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY && (!$count)) {
4473       $groupBy = 'GROUP BY civicrm_activity.id ';
4474     }
4475
4476     $order = $orderBy = $limit = '';
4477     if (!$count) {
4478       $config = CRM_Core_Config::singleton();
4479       if ($config->includeOrderByClause ||
4480         isset($this->_distinctComponentClause)
4481       ) {
4482         if ($sort) {
4483           if (is_string($sort)) {
4484             $orderBy = $sort;
4485           }
4486           else {
4487             $orderBy = trim($sort->orderBy());
4488           }
4489           if (!empty($orderBy)) {
4490             // this is special case while searching for
4491             // change log CRM-1718
4492             if (preg_match('/sort_name/i', $orderBy)) {
4493               $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4494             }
4495
4496             $orderBy = CRM_Utils_Type::escape($orderBy, 'String');
4497             $order = " ORDER BY $orderBy";
4498
4499             if ($sortOrder) {
4500               $sortOrder = CRM_Utils_Type::escape($sortOrder, 'String');
4501               $order .= " $sortOrder";
4502             }
4503
4504             // always add contact_a.id to the ORDER clause
4505             // so the order is deterministic
4506             if (strpos('contact_a.id', $order) === FALSE) {
4507               $order .= ", contact_a.id";
4508             }
4509           }
4510         }
4511         elseif ($sortByChar) {
4512           $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4513         }
4514         else {
4515           $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4516         }
4517       }
4518
4519       // hack for order clause
4520       if ($order) {
4521         $fieldStr = trim(str_replace('ORDER BY', '', $order));
4522         $fieldOrder = explode(' ', $fieldStr);
4523         $field = $fieldOrder[0];
4524
4525         if ($field) {
4526           switch ($field) {
4527             case 'city':
4528             case 'postal_code':
4529               $this->_whereTables["civicrm_address"] = 1;
4530               $order = str_replace($field, "civicrm_address.{$field}", $order);
4531               break;
4532
4533             case 'country':
4534             case 'state_province':
4535               $this->_whereTables["civicrm_{$field}"] = 1;
4536               $order = str_replace($field, "civicrm_{$field}.name", $order);
4537               break;
4538
4539             case 'email':
4540               $this->_whereTables["civicrm_email"] = 1;
4541               $order = str_replace($field, "civicrm_email.{$field}", $order);
4542               break;
4543
4544             default:
4545               //CRM-12565 add "`" around $field if it is a pseudo constant
4546               foreach ($this->_pseudoConstantsSelect as $key => $value) {
4547                 if (!empty($value['element']) && $value['element'] == $field) {
4548                   $order = str_replace($field, "`{$field}`", $order);
4549                 }
4550               }
4551           }
4552           $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4553           $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4554         }
4555       }
4556
4557       if ($rowCount > 0 && $offset >= 0) {
4558         $offset = CRM_Utils_Type::escape($offset, 'Int');
4559         $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
4560         $limit = " LIMIT $offset, $rowCount ";
4561       }
4562     }
4563
4564     // CRM-15231
4565     $this->_sort = $sort;
4566
4567     list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts, $onlyDeleted);
4568
4569     if ($additionalWhereClause) {
4570       $where = $where . ' AND ' . $additionalWhereClause;
4571     }
4572
4573     //additional from clause should be w/ proper joins.
4574     if ($additionalFromClause) {
4575       $from .= "\n" . $additionalFromClause;
4576     }
4577
4578     // if we are doing a transform, do it here
4579     // use the $from, $where and $having to get the contact ID
4580     if ($this->_displayRelationshipType) {
4581       $this->filterRelatedContacts($from, $where, $having);
4582     }
4583
4584     if ($skipOrderAndLimit) {
4585       $query = "$select $from $where $having $groupBy";
4586     }
4587     else {
4588       $query = "$select $from $where $having $groupBy $order $limit";
4589     }
4590
4591     if ($returnQuery) {
4592       return $query;
4593     }
4594     if ($count) {
4595       return CRM_Core_DAO::singleValueQuery($query);
4596     }
4597
4598     $dao = CRM_Core_DAO::executeQuery($query);
4599     if ($groupContacts) {
4600       $ids = array();
4601       while ($dao->fetch()) {
4602         $ids[] = $dao->id;
4603       }
4604       return implode(',', $ids);
4605     }
4606
4607     return $dao;
4608   }
4609
4610   /**
4611    * Fetch a list of contacts from the prev/next cache for displaying a search results page
4612    *
4613    * @param string $cacheKey
4614    * @param int $offset
4615    * @param int $rowCount
4616    * @param bool $includeContactIds
4617    * @return CRM_Core_DAO
4618    */
4619   public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4620     $this->_includeContactIds = $includeContactIds;
4621     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4622     list($select, $from, $where) = $this->query(FALSE, FALSE, FALSE, $onlyDeleted);
4623     $from = " FROM civicrm_prevnext_cache pnc INNER JOIN civicrm_contact contact_a ON contact_a.id = pnc.entity_id1 AND pnc.cacheKey = '$cacheKey' " . substr($from, 31);
4624     $order = " ORDER BY pnc.id";
4625     $groupBy = " GROUP BY contact_a.id";
4626     $limit = " LIMIT $offset, $rowCount";
4627     $query = "$select $from $where $groupBy $order $limit";
4628
4629     return CRM_Core_DAO::executeQuery($query);
4630   }
4631
4632   /**
4633    * Populate $this->_permissionWhereClause with permission related clause and update other
4634    * query related properties.
4635    *
4636    * Function calls ACL permission class and hooks to filter the query appropriately
4637    *
4638    * Note that these 2 params were in the code when extracted from another function
4639    * and a second round extraction would be to make them properties of the class
4640    *
4641    * @param bool $onlyDeleted
4642    *   Only get deleted contacts.
4643    * @param bool $count
4644    *   Return Count only.
4645    */
4646   public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4647     if (!$this->_skipPermission) {
4648       $this->_permissionWhereClause = CRM_ACL_API::whereClause(
4649         CRM_Core_Permission::VIEW,
4650         $this->_tables,
4651         $this->_whereTables,
4652         NULL,
4653         $onlyDeleted,
4654         $this->_skipDeleteClause
4655       );
4656
4657       // regenerate fromClause since permission might have added tables
4658       if ($this->_permissionWhereClause) {
4659         //fix for row count in qill (in contribute/membership find)
4660         if (!$count) {
4661           $this->_useDistinct = TRUE;
4662         }
4663         //CRM-15231
4664         $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4665         $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4666         // note : this modifies _fromClause and _simpleFromClause
4667         $this->includePseudoFieldsJoin($this->_sort);
4668       }
4669     }
4670     else {
4671       // add delete clause if needed even if we are skipping permission
4672       // CRM-7639
4673       if (!$this->_skipDeleteClause) {
4674         if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) {
4675           $this->_permissionWhereClause = '(contact_a.is_deleted)';
4676         }
4677         else {
4678           // CRM-6181
4679           $this->_permissionWhereClause = '(contact_a.is_deleted = 0)';
4680         }
4681       }
4682     }
4683   }
4684
4685   /**
4686    * @param $val
4687    */
4688   public function setSkipPermission($val) {
4689     $this->_skipPermission = $val;
4690   }
4691
4692   /**
4693    * @param null $context
4694    *
4695    * @return array
4696    */
4697   public function &summaryContribution($context = NULL) {
4698     list($innerselect, $from, $where, $having) = $this->query(TRUE);
4699
4700     // hack $select
4701     $select = "
4702 SELECT COUNT( conts.total_amount ) as total_count,
4703        SUM(   conts.total_amount ) as total_amount,
4704        AVG(   conts.total_amount ) as total_avg,
4705        conts.currency              as currency";
4706     if ($this->_permissionWhereClause) {
4707       $where .= " AND " . $this->_permissionWhereClause;
4708     }
4709     if ($context == 'search') {
4710       $where .= " AND contact_a.is_deleted = 0 ";
4711     }
4712
4713     // make sure contribution is completed - CRM-4989
4714     $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
4715
4716     $summary = array();
4717     $summary['total'] = array();
4718     $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4719
4720     $query = "$select FROM (
4721       SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $completedWhere
4722       GROUP BY civicrm_contribution.id
4723     ) as conts
4724     GROUP BY currency";
4725
4726     $dao = CRM_Core_DAO::executeQuery($query);
4727
4728     $summary['total']['count'] = 0;
4729     $summary['total']['amount'] = $summary['total']['avg'] = array();
4730     while ($dao->fetch()) {
4731       $summary['total']['count'] += $dao->total_count;
4732       $summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
4733       $summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
4734     }
4735     if (!empty($summary['total']['amount'])) {
4736       $summary['total']['amount'] = implode(',&nbsp;', $summary['total']['amount']);
4737       $summary['total']['avg'] = implode(',&nbsp;', $summary['total']['avg']);
4738     }
4739     else {
4740       $summary['total']['amount'] = $summary['total']['avg'] = 0;
4741     }
4742
4743     // soft credit summary
4744     if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
4745       $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
4746       $query = "
4747         $select FROM (
4748           SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
4749           GROUP BY civicrm_contribution_soft.id
4750         ) as conts
4751         GROUP BY currency";
4752       $dao = CRM_Core_DAO::executeQuery($query);
4753       $summary['soft_credit']['count'] = 0;
4754       $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
4755       while ($dao->fetch()) {
4756         $summary['soft_credit']['count'] += $dao->total_count;
4757         $summary['soft_credit']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
4758         $summary['soft_credit']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
4759       }
4760       if (!empty($summary['soft_credit']['amount'])) {
4761         $summary['soft_credit']['amount'] = implode(',&nbsp;', $summary['soft_credit']['amount']);
4762         $summary['soft_credit']['avg'] = implode(',&nbsp;', $summary['soft_credit']['avg']);
4763       }
4764       else {
4765         $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
4766       }
4767     }
4768
4769     // hack $select
4770     //@todo  - this could be one query using the IF in mysql - eg
4771     //  SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
4772     //   SELECT civicrm_contribution.total_amount, civicrm_contribution.currency  ,
4773     //  IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
4774     //  IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
4775     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
4776     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
4777     // FROM civicrm_contact contact_a
4778     //  LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
4779     // WHERE  ( ... where clause....
4780     // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
4781     //  ) as conts
4782
4783     $select = "
4784 SELECT COUNT( conts.total_amount ) as cancel_count,
4785        SUM(   conts.total_amount ) as cancel_amount,
4786        AVG(   conts.total_amount ) as cancel_avg,
4787        conts.currency              as currency";
4788
4789     $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4790     if ($context == 'search') {
4791       $where .= " AND contact_a.is_deleted = 0 ";
4792     }
4793
4794     $query = "$select FROM (
4795       SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
4796       GROUP BY civicrm_contribution.id
4797     ) as conts
4798     GROUP BY currency";
4799
4800     $dao = CRM_Core_DAO::executeQuery($query);
4801
4802     if ($dao->N <= 1) {
4803       if ($dao->fetch()) {
4804         $summary['cancel']['count'] = $dao->cancel_count;
4805         $summary['cancel']['amount'] = $dao->cancel_amount;
4806         $summary['cancel']['avg'] = $dao->cancel_avg;
4807       }
4808     }
4809     else {
4810       $summary['cancel']['count'] = 0;
4811       $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4812       while ($dao->fetch()) {
4813         $summary['cancel']['count'] += $dao->cancel_count;
4814         $summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
4815         $summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
4816       }
4817       $summary['cancel']['amount'] = implode(',&nbsp;', $summary['cancel']['amount']);
4818       $summary['cancel']['avg'] = implode(',&nbsp;', $summary['cancel']['avg']);
4819     }
4820
4821     return $summary;
4822   }
4823
4824   /**
4825    * Getter for the qill object.
4826    *
4827    * @return string
4828    */
4829   public function qill() {
4830     return $this->_qill;
4831   }
4832
4833   /**
4834    * Default set of return default hier return properties.
4835    *
4836    * @return array
4837    */
4838   public static function &defaultHierReturnProperties() {
4839     if (!isset(self::$_defaultHierReturnProperties)) {
4840       self::$_defaultHierReturnProperties = array(
4841         'home_URL' => 1,
4842         'image_URL' => 1,
4843         'legal_identifier' => 1,
4844         'external_identifier' => 1,
4845         'contact_type' => 1,
4846         'contact_sub_type' => 1,
4847         'sort_name' => 1,
4848         'display_name' => 1,
4849         'nick_name' => 1,
4850         'first_name' => 1,
4851         'middle_name' => 1,
4852         'last_name' => 1,
4853         'prefix_id' => 1,
4854         'suffix_id' => 1,
4855         'formal_title' => 1,
4856         'communication_style_id' => 1,
4857         'email_greeting' => 1,
4858         'postal_greeting' => 1,
4859         'addressee' => 1,
4860         'birth_date' => 1,
4861         'gender_id' => 1,
4862         'preferred_communication_method' => 1,
4863         'do_not_phone' => 1,
4864         'do_not_email' => 1,
4865         'do_not_mail' => 1,
4866         'do_not_sms' => 1,
4867         'do_not_trade' => 1,
4868         'location' => array(
4869           '1' => array(
4870             'location_type' => 1,
4871             'street_address' => 1,
4872             'city' => 1,
4873             'state_province' => 1,
4874             'postal_code' => 1,
4875             'postal_code_suffix' => 1,
4876             'country' => 1,
4877             'phone-Phone' => 1,
4878             'phone-Mobile' => 1,
4879             'phone-Fax' => 1,
4880             'phone-1' => 1,
4881             'phone-2' => 1,
4882             'phone-3' => 1,
4883             'im-1' => 1,
4884             'im-2' => 1,
4885             'im-3' => 1,
4886             'email-1' => 1,
4887             'email-2' => 1,
4888             'email-3' => 1,
4889           ),
4890           '2' => array(
4891             'location_type' => 1,
4892             'street_address' => 1,
4893             'city' => 1,
4894             'state_province' => 1,
4895             'postal_code' => 1,
4896             'postal_code_suffix' => 1,
4897             'country' => 1,
4898             'phone-Phone' => 1,
4899             'phone-Mobile' => 1,
4900             'phone-1' => 1,
4901             'phone-2' => 1,
4902             'phone-3' => 1,
4903             'im-1' => 1,
4904             'im-2' => 1,
4905             'im-3' => 1,
4906             'email-1' => 1,
4907             'email-2' => 1,
4908             'email-3' => 1,
4909           ),
4910         ),
4911       );
4912     }
4913     return self::$_defaultHierReturnProperties;
4914   }
4915
4916   /**
4917    * @param $values
4918    * @param string $tableName
4919    * @param string $fieldName
4920    * @param string $dbFieldName
4921    * @param $fieldTitle
4922    * @param bool $appendTimeStamp
4923    */
4924   public function dateQueryBuilder(
4925     &$values, $tableName, $fieldName,
4926     $dbFieldName, $fieldTitle,
4927     $appendTimeStamp = TRUE
4928   ) {
4929     list($name, $op, $value, $grouping, $wildcard) = $values;
4930
4931     if ($name == "{$fieldName}_low" ||
4932       $name == "{$fieldName}_high"
4933     ) {
4934       if (isset($this->_rangeCache[$fieldName]) || !$value) {
4935         return;
4936       }
4937       $this->_rangeCache[$fieldName] = 1;
4938
4939       $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
4940
4941       if ($name == $fieldName . '_low') {
4942         $firstOP = '>=';
4943         $firstPhrase = ts('greater than or equal to');
4944         $firstDate = CRM_Utils_Date::processDate($value);
4945
4946         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4947         if (!empty($secondValues) && $secondValues[2]) {
4948           $secondOP = '<=';
4949           $secondPhrase = ts('less than or equal to');
4950           $secondValue = $secondValues[2];
4951
4952           if ($appendTimeStamp && strlen($secondValue) == 10) {
4953             $secondValue .= ' 23:59:59';
4954           }
4955           $secondDate = CRM_Utils_Date::processDate($secondValue);
4956         }
4957       }
4958       elseif ($name == $fieldName . '_high') {
4959         $firstOP = '<=';
4960         $firstPhrase = ts('less than or equal to');
4961
4962         if ($appendTimeStamp && strlen($value) == 10) {
4963           $value .= ' 23:59:59';
4964         }
4965         $firstDate = CRM_Utils_Date::processDate($value);
4966
4967         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4968         if (!empty($secondValues) && $secondValues[2]) {
4969           $secondOP = '>=';
4970           $secondPhrase = ts('greater than or equal to');
4971           $secondValue = $secondValues[2];
4972           $secondDate = CRM_Utils_Date::processDate($secondValue);
4973         }
4974       }
4975
4976       if (!$appendTimeStamp) {
4977         $firstDate = substr($firstDate, 0, 8);
4978       }
4979       $firstDateFormat = CRM_Utils_Date::customFormat($firstDate);
4980
4981       if ($secondDate) {
4982         if (!$appendTimeStamp) {
4983           $secondDate = substr($secondDate, 0, 8);
4984         }
4985         $secondDateFormat = CRM_Utils_Date::customFormat($secondDate);
4986       }
4987
4988       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
4989       if ($secondDate) {
4990         $this->_where[$grouping][] = "
4991 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
4992 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
4993 ";
4994         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
4995       }
4996       else {
4997         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
4998         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
4999       }
5000     }
5001
5002     if ($name == $fieldName) {
5003       //In Get API, for operators other then '=' the $value is in array(op => value) format
5004       if (is_array($value) && !empty($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5005         $op = key($value);
5006         $value = $value[$op];
5007       }
5008
5009       $date = $format = NULL;
5010       if (strstr($op, 'IN')) {
5011         $format = array();
5012         foreach ($value as &$date) {
5013           $date = CRM_Utils_Date::processDate($date);
5014           if (!$appendTimeStamp) {
5015             $date = substr($date, 0, 8);
5016           }
5017           $format[] = CRM_Utils_Date::customFormat($date);
5018         }
5019         $date = "('" . implode("','", $value) . "')";
5020         $format = implode(', ', $format);
5021       }
5022       elseif ($value && (!strstr($op, 'NULL') && !strstr($op, 'EMPTY'))) {
5023         $date = CRM_Utils_Date::processDate($value);
5024         if (!$appendTimeStamp) {
5025           $date = substr($date, 0, 8);
5026         }
5027         $format = CRM_Utils_Date::customFormat($date);
5028         $date = "'$date'";
5029       }
5030
5031       if ($date) {
5032         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op $date";
5033       }
5034       else {
5035         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op";
5036       }
5037
5038       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5039
5040       $op = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
5041       $this->_qill[$grouping][] = "$fieldTitle $op $format";
5042     }
5043   }
5044
5045   /**
5046    * @param $values
5047    * @param string $tableName
5048    * @param string $fieldName
5049    * @param string $dbFieldName
5050    * @param $fieldTitle
5051    * @param null $options
5052    */
5053   public function numberRangeBuilder(
5054     &$values,
5055     $tableName, $fieldName,
5056     $dbFieldName, $fieldTitle,
5057     $options = NULL
5058   ) {
5059     list($name, $op, $value, $grouping, $wildcard) = $values;
5060
5061     if ($name == "{$fieldName}_low" ||
5062       $name == "{$fieldName}_high"
5063     ) {
5064       if (isset($this->_rangeCache[$fieldName])) {
5065         return;
5066       }
5067       $this->_rangeCache[$fieldName] = 1;
5068
5069       $secondOP = $secondPhrase = $secondValue = NULL;
5070
5071       if ($name == "{$fieldName}_low") {
5072         $firstOP = '>=';
5073         $firstPhrase = ts('greater than');
5074
5075         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5076         if (!empty($secondValues)) {
5077           $secondOP = '<=';
5078           $secondPhrase = ts('less than');
5079           $secondValue = $secondValues[2];
5080         }
5081       }
5082       else {
5083         $firstOP = '<=';
5084         $firstPhrase = ts('less than');
5085
5086         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5087         if (!empty($secondValues)) {
5088           $secondOP = '>=';
5089           $secondPhrase = ts('greater than');
5090           $secondValue = $secondValues[2];
5091         }
5092       }
5093
5094       if ($secondOP) {
5095         $this->_where[$grouping][] = "
5096 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
5097 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
5098 ";
5099         $displayValue = $options ? $options[$value] : $value;
5100         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5101
5102         $this->_qill[$grouping][]
5103           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5104       }
5105       else {
5106         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
5107         $displayValue = $options ? $options[$value] : $value;
5108         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5109       }
5110       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5111
5112       return;
5113     }
5114
5115     if ($name == $fieldName) {
5116       $op = '=';
5117       $phrase = '=';
5118
5119       $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
5120
5121       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5122       $displayValue = $options ? $options[$value] : $value;
5123       $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
5124     }
5125   }
5126
5127   /**
5128    * Given the field name, operator, value & its data type
5129    * builds the where Clause for the query
5130    * used for handling 'IS NULL'/'IS NOT NULL' operators
5131    *
5132    * @param string $field
5133    *   Fieldname.
5134    * @param string $op
5135    *   Operator.
5136    * @param string $value
5137    *   Value.
5138    * @param string $dataType
5139    *   Data type of the field.
5140    *
5141    * @return string
5142    *   Where clause for the query.
5143    */
5144   public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
5145     $op = trim($op);
5146     $clause = "$field $op";
5147
5148     switch ($op) {
5149       case 'IS NULL':
5150       case 'IS NOT NULL':
5151         return $clause;
5152
5153       case 'IS EMPTY':
5154         $clause = " (NULLIF($field, '') IS NULL) ";
5155         return $clause;
5156
5157       case 'IS NOT EMPTY':
5158         $clause = " (NULLIF($field, '') IS NOT NULL) ";
5159         return $clause;
5160
5161       case 'IN':
5162       case 'NOT IN':
5163         if (!empty($value) && is_array($value) && !array_key_exists($op, $value)) {
5164           $value = array($op => $value);
5165         }
5166
5167       default:
5168         if (empty($dataType)) {
5169           $dataType = 'String';
5170         }
5171         if (is_array($value)) {
5172           //this could have come from the api - as in the restWhere section we potentially use the api operator syntax which is becoming more
5173           // widely used and consistent across the codebase
5174           // adding this here won't accept the search functions which don't submit an array
5175           if (($queryString = CRM_Core_DAO::createSqlFilter($field, $value, $dataType)) != FALSE) {
5176
5177             return $queryString;
5178           }
5179
5180           // This is the here-be-dragons zone. We have no other hopes left for an array so lets assume it 'should' be array('IN' => array(2,5))
5181           // but we got only array(2,5) from the form.
5182           // We could get away with keeping this in 4.6 if we make it such that it throws an enotice in 4.7 so
5183           // people have to de-slopify it.
5184           if (!empty($value[0])) {
5185             $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReport;
5186             if (($queryString = CRM_Core_DAO::createSqlFilter($field, array($op => $value), $dataType)) != FALSE) {
5187               return $queryString;
5188             }
5189           }
5190           else {
5191             $op = 'IN';
5192             $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReportUsingOldFormat;
5193             if (($queryString = CRM_Core_DAO::createSqlFilter($field, array($op => array_keys($value)), $dataType)) != FALSE) {
5194               return $queryString;
5195             }
5196           }
5197         }
5198
5199         $value = CRM_Utils_Type::escape($value, $dataType);
5200         // if we don't have a dataType we should assume
5201         if ($dataType == 'String' || $dataType == 'Text') {
5202           $value = "'" . strtolower($value) . "'";
5203         }
5204         return "$clause $value";
5205     }
5206   }
5207
5208   /**
5209    * @param bool $reset
5210    *
5211    * @return array
5212    */
5213   public function openedSearchPanes($reset = FALSE) {
5214     if (!$reset || empty($this->_whereTables)) {
5215       return self::$_openedPanes;
5216     }
5217
5218     // pane name to table mapper
5219     $panesMapper = array(
5220       ts('Contributions') => 'civicrm_contribution',
5221       ts('Memberships') => 'civicrm_membership',
5222       ts('Events') => 'civicrm_participant',
5223       ts('Relationships') => 'civicrm_relationship',
5224       ts('Activities') => 'civicrm_activity',
5225       ts('Pledges') => 'civicrm_pledge',
5226       ts('Cases') => 'civicrm_case',
5227       ts('Grants') => 'civicrm_grant',
5228       ts('Address Fields') => 'civicrm_address',
5229       ts('Notes') => 'civicrm_note',
5230       ts('Change Log') => 'civicrm_log',
5231       ts('Mailings') => 'civicrm_mailing_event_queue',
5232     );
5233     CRM_Contact_BAO_Query_Hook::singleton()->getPanesMapper($panesMapper);
5234
5235     foreach (array_keys($this->_whereTables) as $table) {
5236       if ($panName = array_search($table, $panesMapper)) {
5237         self::$_openedPanes[$panName] = TRUE;
5238       }
5239     }
5240
5241     return self::$_openedPanes;
5242   }
5243
5244   /**
5245    * @param $operator
5246    */
5247   public function setOperator($operator) {
5248     $validOperators = array('AND', 'OR');
5249     if (!in_array($operator, $validOperators)) {
5250       $operator = 'AND';
5251     }
5252     $this->_operator = $operator;
5253   }
5254
5255   /**
5256    * @return string
5257    */
5258   public function getOperator() {
5259     return $this->_operator;
5260   }
5261
5262   /**
5263    * @param $from
5264    * @param $where
5265    * @param $having
5266    */
5267   public function filterRelatedContacts(&$from, &$where, &$having) {
5268     static $_rTypeProcessed = NULL;
5269     static $_rTypeFrom = NULL;
5270     static $_rTypeWhere = NULL;
5271
5272     if (!$_rTypeProcessed) {
5273       $_rTypeProcessed = TRUE;
5274
5275       // create temp table with contact ids
5276       $tableName = CRM_Core_DAO::createTempTableName('civicrm_transform', TRUE);
5277       $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5278       CRM_Core_DAO::executeQuery($sql);
5279
5280       $sql = "
5281 REPLACE INTO $tableName ( contact_id )
5282 SELECT contact_a.id
5283        $from
5284        $where
5285        $having
5286 ";
5287       CRM_Core_DAO::executeQuery($sql);
5288
5289       $qillMessage = ts('Contacts with a Relationship Type of: ');
5290       $rTypes = CRM_Core_PseudoConstant::relationshipType();
5291
5292       if (is_numeric($this->_displayRelationshipType)) {
5293         $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType]['label_a_b'];
5294         $_rTypeFrom = "
5295 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5296 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5297 ";
5298         $_rTypeWhere = "
5299 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5300 AND   displayRelType.is_active = 1
5301 ";
5302       }
5303       else {
5304         list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType);
5305         if ($dirOne == 'a') {
5306           $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5307           $_rTypeFrom .= "
5308 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5309 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5310 ";
5311         }
5312         else {
5313           $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5314           $_rTypeFrom .= "
5315 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5316 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5317 ";
5318         }
5319         $_rTypeWhere = "
5320 WHERE displayRelType.relationship_type_id = $relType
5321 AND   displayRelType.is_active = 1
5322 ";
5323       }
5324       $this->_qill[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
5325     }
5326
5327     if (!empty($this->_permissionWhereClause)) {
5328       $_rTypeWhere .= "AND $this->_permissionWhereClause";
5329     }
5330
5331     if (strpos($from, $_rTypeFrom) === FALSE) {
5332       // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5333       // this happens when we have an event_type in the quert (CRM-7969)
5334       $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5335       $from .= $_rTypeFrom;
5336       $where = $_rTypeWhere;
5337     }
5338
5339     $having = NULL;
5340   }
5341
5342   /**
5343    * @param $op
5344    *
5345    * @return bool
5346    */
5347   public static function caseImportant($op) {
5348     return
5349       in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE;
5350   }
5351
5352   /**
5353    * @param $returnProperties
5354    * @param $prefix
5355    *
5356    * @return bool
5357    */
5358   public static function componentPresent(&$returnProperties, $prefix) {
5359     foreach ($returnProperties as $name => $dontCare) {
5360       if (substr($name, 0, strlen($prefix)) == $prefix) {
5361         return TRUE;
5362       }
5363     }
5364     return FALSE;
5365   }
5366
5367   /**
5368    * Builds the necessary structures for all fields that are similar to option value lookups.
5369    *
5370    * @param string $name
5371    *   the name of the field.
5372    * @param string $op
5373    *   the sql operator, this function should handle ALL SQL operators.
5374    * @param string $value
5375    *   depends on the operator and who's calling the query builder.
5376    * @param int $grouping
5377    *   the index where to place the where clause.
5378    * @param $selectValues
5379    *   The key value pairs for this element. This allows us to use this function for things besides option-value pairs.
5380    * @param array $field
5381    *   an array that contains various properties of the field identified by $name.
5382    * @param string $label
5383    *   The label for this field element.
5384    * @param string $dataType
5385    *   The data type for this element.
5386    * @param bool $useIDsOnly
5387    *
5388    * @return void
5389    *   adds the where clause and qill to the query object
5390    */
5391   public function optionValueQuery(
5392     $name,
5393     $op,
5394     $value,
5395     $grouping,
5396     $selectValues,
5397     $field,
5398     $label,
5399     $dataType = 'String',
5400     $useIDsOnly = FALSE
5401   ) {
5402
5403     if (!empty($selectValues) && !is_array($value) && !empty($selectValues[$value])) {
5404       $qill = $selectValues[$value];
5405     }
5406     else {
5407       $qill = $value;
5408     }
5409
5410     $pseudoFields = array(
5411       'email_greeting',
5412       'postal_greeting',
5413       'addressee',
5414       'gender_id',
5415       'prefix_id',
5416       'suffix_id',
5417       'communication_style_id',
5418     );
5419
5420     if (is_numeric($value)) {
5421       $qill = $selectValues[(int ) $value];
5422     }
5423     elseif ($op == 'IN' || $op == 'NOT IN') {
5424       if (is_array($value)) {
5425         $intVals = array();
5426         $newValues = array();
5427         foreach ($value as $k => $v) {
5428           $intVals[$k] = (int) $k;
5429           $newValues[] = $selectValues[(int) $k];
5430         }
5431
5432         $value = (in_array($name, $pseudoFields)) ? $intVals : $newValues;
5433         $qill = implode(', ', $newValues);
5434       }
5435     }
5436     elseif (!array_key_exists($value, $selectValues)) {
5437       // its a string, lets get the int value
5438       $value = array_search($value, $selectValues);
5439     }
5440     if ($useIDsOnly) {
5441       list($tableName, $fieldName) = explode('.', $field['where'], 2);
5442       if ($tableName == 'civicrm_contact') {
5443         $wc = "contact_a.$fieldName";
5444       }
5445       else {
5446         $wc = "$tableName.id";
5447       }
5448     }
5449     else {
5450       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
5451     }
5452
5453     if (in_array($name, $pseudoFields)) {
5454       if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5455         $wc = "contact_a.{$name}_id";
5456       }
5457       $dataType = 'Positive';
5458       $value = (!$value) ? 0 : $value;
5459     }
5460
5461     $this->_qill[$grouping][] = $label . " $op '$qill'";
5462     $op = (in_array($name, $pseudoFields) && ($op == 'LIKE' || $op == 'RLIKE')) ? '=' : $op;
5463     $this->_where[$grouping][] = self::buildClause($wc, $op, $value, $dataType);
5464   }
5465
5466   /**
5467    * Check and explode a user defined numeric string into an array
5468    * this was the protocol used by search builder in the old old days before we had
5469    * super nice js widgets to do the hard work
5470    *
5471    * @param string $string
5472    * @param string $dataType
5473    *   The dataType we should check for the values, default integer.
5474    *
5475    * @return bool|array
5476    *   false if string does not match the pattern
5477    *   array of numeric values if string does match the pattern
5478    */
5479   public static function parseSearchBuilderString($string, $dataType = 'Integer') {
5480     $string = trim($string);
5481     if (substr($string, 0, 1) != '(' || substr($string, -1, 1) != ')') {
5482       Return FALSE;
5483     }
5484
5485     $string = substr($string, 1, -1);
5486     $values = explode(',', $string);
5487     if (empty($values)) {
5488       return FALSE;
5489     }
5490
5491     $returnValues = array();
5492     foreach ($values as $v) {
5493       if ($dataType == 'Integer' && !is_numeric($v)) {
5494         return FALSE;
5495       }
5496       elseif ($dataType == 'String' && !is_string($v)) {
5497         return FALSE;
5498       }
5499       $returnValues[] = trim($v);
5500     }
5501
5502     if (empty($returnValues)) {
5503       return FALSE;
5504     }
5505
5506     return $returnValues;
5507   }
5508
5509   /**
5510    * Convert the pseudo constants id's to their names
5511    *
5512    * @param CRM_Core_DAO $dao
5513    * @param bool $return
5514    *
5515    * @return array|NULL
5516    */
5517   public function convertToPseudoNames(&$dao, $return = FALSE) {
5518     if (empty($this->_pseudoConstantsSelect)) {
5519       return NULL;
5520     }
5521     $values = array();
5522     foreach ($this->_pseudoConstantsSelect as $key => $value) {
5523       if (!empty($this->_pseudoConstantsSelect[$key]['sorting'])) {
5524         continue;
5525       }
5526
5527       if (property_exists($dao, $value['idCol'])) {
5528         $val = $dao->$value['idCol'];
5529
5530         if (CRM_Utils_System::isNull($val)) {
5531           $dao->$key = NULL;
5532         }
5533         elseif ($baoName = CRM_Utils_Array::value('bao', $value, NULL)) {
5534           //preserve id value
5535           $idColumn = "{$key}_id";
5536           $dao->$idColumn = $val;
5537
5538           if ($key == 'state_province_name') {
5539             $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
5540           }
5541           else {
5542             $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant::getLabel($baoName, $value['pseudoField'], $val);
5543           }
5544         }
5545         elseif ($value['pseudoField'] == 'state_province_abbreviation') {
5546           $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
5547         }
5548         // FIX ME: we should potentially move this to component Query and write a wrapper function that
5549         // handles pseudoconstant fixes for all component
5550         elseif (in_array($value['pseudoField'], array('participant_status', 'participant_role'))) {
5551           $pseudoOptions = $viewValues = array();
5552           $pseudoOptions = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', $value['pseudoField'], array('flip' => 1));
5553           foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $val) as $k => $v) {
5554             $viewValues[] = $pseudoOptions[$v];
5555           }
5556           $dao->$key = implode(', ', $viewValues);
5557         }
5558         else {
5559           $labels = CRM_Core_OptionGroup::values($value['pseudoField']);
5560           $dao->$key = $labels[$val];
5561         }
5562
5563         // return converted values in array format
5564         if ($return) {
5565           if (strpos($key, '-') !== FALSE) {
5566             $keyVal = explode('-', $key);
5567             $current = &$values;
5568             $lastElement = array_pop($keyVal);
5569             foreach ($keyVal as $v) {
5570               if (!array_key_exists($v, $current)) {
5571                 $current[$v] = array();
5572               }
5573               $current = &$current[$v];
5574             }
5575             $current[$lastElement] = $dao->$key;
5576           }
5577           else {
5578             $values[$key] = $dao->$key;
5579           }
5580         }
5581       }
5582     }
5583     return $values;
5584   }
5585
5586   /**
5587    * Include pseudo fields LEFT JOIN.
5588    * @param string|array $sort can be a object or string
5589    *
5590    * @return array|NULL
5591    */
5592   public function includePseudoFieldsJoin($sort) {
5593     if (!$sort || empty($this->_pseudoConstantsSelect)) {
5594       return NULL;
5595     }
5596     $sort = is_string($sort) ? $sort : $sort->orderBy();
5597     $present = array();
5598
5599     foreach ($this->_pseudoConstantsSelect as $name => $value) {
5600       if (!empty($value['table'])) {
5601         $regex = "/({$value['table']}\.|{$name})/";
5602         if (preg_match($regex, $sort)) {
5603           $this->_elemnt[$value['element']] = 1;
5604           $this->_select[$value['element']] = $value['select'];
5605           $this->_pseudoConstantsSelect[$name]['sorting'] = 1;
5606           $present[$value['table']] = $value['join'];
5607         }
5608       }
5609     }
5610     $presentSimpleFrom = $present;
5611
5612     if (array_key_exists('civicrm_worldregion', $this->_whereTables) &&
5613       array_key_exists('civicrm_country', $presentSimpleFrom)
5614     ) {
5615       unset($presentSimpleFrom['civicrm_country']);
5616     }
5617     if (array_key_exists('civicrm_worldregion', $this->_tables) &&
5618       array_key_exists('civicrm_country', $present)
5619     ) {
5620       unset($present['civicrm_country']);
5621     }
5622
5623     $presentClause = $presentSimpleFromClause = NULL;
5624     if (!empty($present)) {
5625       $presentClause = implode(' ', $present);
5626     }
5627     if (!empty($presentSimpleFrom)) {
5628       $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
5629     }
5630
5631     $this->_fromClause = $this->_fromClause . $presentClause;
5632     $this->_simpleFromClause = $this->_simpleFromClause . $presentSimpleFromClause;
5633
5634     return array($presentClause, $presentSimpleFromClause);
5635   }
5636
5637   /**
5638    * Build qill for field.
5639    *
5640    * Qill refers to the query detail visible on the UI.
5641    *
5642    * @param $daoName
5643    * @param $fieldName
5644    * @param $fieldValue
5645    * @param $op
5646    * @param array $pseduoExtraParam
5647    *
5648    * @return array
5649    */
5650   public static function buildQillForFieldValue($daoName = NULL, $fieldName, $fieldValue, $op, $pseduoExtraParam = array()) {
5651     $qillOperators = CRM_Core_SelectValues::getSearchBuilderOperators();
5652
5653     if ($fieldName == 'activity_type_id') {
5654       $pseduoOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
5655     }
5656     elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
5657       $pseduoOptions = CRM_Event_BAO_Event::getEvents(0, $fieldValue, TRUE, TRUE, TRUE);
5658     }
5659     elseif ($daoName == 'CRM_Contact_DAO_Group' && $fieldName == 'id') {
5660       $pseduoOptions = CRM_Core_PseudoConstant::group();
5661     }
5662     elseif ($daoName) {
5663       $pseduoOptions = CRM_Core_PseudoConstant::get($daoName, $fieldName, $pseduoExtraParam = array());
5664     }
5665
5666     //API usually have fieldValue format as array(operator => array(values)),
5667     //so we need to separate operator out of fieldValue param
5668     if (is_array($fieldValue) && in_array(key($fieldValue), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5669       $op = key($fieldValue);
5670       $fieldValue = $fieldValue[$op];
5671     }
5672
5673     if (is_array($fieldValue)) {
5674       $qillString = array();
5675       if (!empty($pseduoOptions)) {
5676         foreach ((array) $fieldValue as $val) {
5677           $qillString[] = CRM_Utils_Array::value($val, $pseduoOptions, $val);
5678         }
5679         $fieldValue = implode(', ', $qillString);
5680       }
5681       else {
5682         $fieldValue = implode(', ', $fieldValue);
5683       }
5684     }
5685     elseif (!empty($pseduoOptions) && array_key_exists($fieldValue, $pseduoOptions)) {
5686       $fieldValue = $pseduoOptions[$fieldValue];
5687     }
5688
5689     return array(CRM_Utils_Array::value($op, $qillOperators, $op), $fieldValue);
5690   }
5691
5692 }