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       $result = array($id, 'IN', $values, 0, $wildcard);
1606     }
1607     else {
1608       $result = array($id, '=', $values, 0, $wildcard);
1609     }
1610
1611     return $result;
1612   }
1613
1614   /**
1615    * @param $values
1616    */
1617   public function whereClauseSingle(&$values) {
1618     // do not process custom fields or prefixed contact ids or component params
1619     if (CRM_Core_BAO_CustomField::getKeyID($values[0]) ||
1620       (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) ||
1621       (substr($values[0], 0, 13) == 'contribution_') ||
1622       (substr($values[0], 0, 6) == 'event_') ||
1623       (substr($values[0], 0, 12) == 'participant_') ||
1624       (substr($values[0], 0, 7) == 'member_') ||
1625       (substr($values[0], 0, 6) == 'grant_') ||
1626       (substr($values[0], 0, 7) == 'pledge_') ||
1627       (substr($values[0], 0, 5) == 'case_') ||
1628       (substr($values[0], 0, 10) == 'financial_') ||
1629       (substr($values[0], 0, 8) == 'payment_') ||
1630       (substr($values[0], 0, 11) == 'membership_')
1631     ) {
1632       return;
1633     }
1634
1635     // skip for hook injected fields / params
1636     $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields();
1637     if (array_key_exists($values[0], $extFields)) {
1638       return;
1639     }
1640
1641     switch ($values[0]) {
1642       case 'deleted_contacts':
1643         $this->deletedContacts($values);
1644         return;
1645
1646       case 'contact_type':
1647         $this->contactType($values);
1648         return;
1649
1650       case 'contact_sub_type':
1651         $this->contactSubType($values);
1652         return;
1653
1654       case 'group':
1655         $this->group($values);
1656         return;
1657
1658       case 'group_type':
1659         // so we resolve this into a list of groups & proceed as if they had been
1660         // handed in
1661         list($name, $op, $value, $grouping, $wildcard) = $values;
1662         $values[0] = 'group';
1663         $values[1] = 'IN';
1664         $this->_paramLookup['group'][0][0] = 'group';
1665         $this->_paramLookup['group'][0][1] = 'IN';
1666         $this->_paramLookup['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1667         $this->group($values);
1668         return;
1669
1670       // case tag comes from find contacts
1671       case 'tag_search':
1672         $this->tagSearch($values);
1673         return;
1674
1675       case 'tag':
1676       case 'contact_tags':
1677         $this->tag($values);
1678         return;
1679
1680       case 'note':
1681       case 'note_body':
1682       case 'note_subject':
1683         $this->notes($values);
1684         return;
1685
1686       case 'uf_user':
1687         $this->ufUser($values);
1688         return;
1689
1690       case 'sort_name':
1691       case 'display_name':
1692         $this->sortName($values);
1693         return;
1694
1695       case 'addressee':
1696       case 'postal_greeting':
1697       case 'email_greeting':
1698         $this->greetings($values);
1699         return;
1700
1701       case 'email':
1702         $this->email($values);
1703         return;
1704
1705       case 'phone_numeric':
1706         $this->phone_numeric($values);
1707         return;
1708
1709       case 'phone_phone_type_id':
1710       case 'phone_location_type_id':
1711         $this->phone_option_group($values);
1712         return;
1713
1714       case 'street_address':
1715         $this->street_address($values);
1716         return;
1717
1718       case 'street_number':
1719         $this->street_number($values);
1720         return;
1721
1722       case 'sortByCharacter':
1723         $this->sortByCharacter($values);
1724         return;
1725
1726       case 'location_type':
1727         $this->locationType($values);
1728         return;
1729
1730       case 'county':
1731         $this->county($values);
1732         return;
1733
1734       case 'state_province':
1735         $this->stateProvince($values);
1736         return;
1737
1738       case 'country':
1739         $this->country($values, FALSE);
1740         return;
1741
1742       case 'postal_code':
1743       case 'postal_code_low':
1744       case 'postal_code_high':
1745         $this->postalCode($values);
1746         return;
1747
1748       case 'activity_date':
1749       case 'activity_date_low':
1750       case 'activity_date_high':
1751       case 'activity_role':
1752       case 'activity_status_id':
1753       case 'activity_status':
1754       case 'followup_parent_id':
1755       case 'parent_id':
1756       case 'source_contact_id':
1757       case 'activity_subject':
1758       case 'test_activities':
1759       case 'activity_type_id':
1760       case 'activity_type':
1761       case 'activity_survey_id':
1762       case 'activity_tags':
1763       case 'activity_taglist':
1764       case 'activity_test':
1765       case 'activity_campaign_id':
1766       case 'activity_engagement_level':
1767       case 'activity_id':
1768       case 'activity_result':
1769       case 'source_contact':
1770         CRM_Activity_BAO_Query::whereClauseSingle($values, $this);
1771         return;
1772
1773       case 'birth_date_low':
1774       case 'birth_date_high':
1775       case 'deceased_date_low':
1776       case 'deceased_date_high':
1777         $this->demographics($values);
1778         return;
1779
1780       case 'log_date_low':
1781       case 'log_date_high':
1782         $this->modifiedDates($values);
1783         return;
1784
1785       case 'changed_by':
1786         $this->changeLog($values);
1787         return;
1788
1789       case 'do_not_phone':
1790       case 'do_not_email':
1791       case 'do_not_mail':
1792       case 'do_not_sms':
1793       case 'do_not_trade':
1794       case 'is_opt_out':
1795         $this->privacy($values);
1796         return;
1797
1798       case 'privacy_options':
1799         $this->privacyOptions($values);
1800         return;
1801
1802       case 'privacy_operator':
1803       case 'privacy_toggle':
1804         // these are handled by privacy options
1805         return;
1806
1807       case 'preferred_communication_method':
1808         $this->preferredCommunication($values);
1809         return;
1810
1811       case 'relation_type_id':
1812       case 'relation_start_date_high':
1813       case 'relation_start_date_low':
1814       case 'relation_end_date_high':
1815       case 'relation_end_date_low':
1816       case 'relation_target_name':
1817       case 'relation_status':
1818       case 'relation_date_low':
1819       case 'relation_date_high':
1820         $this->relationship($values);
1821         $this->_relationshipValuesAdded = TRUE;
1822         return;
1823
1824       case 'task_status_id':
1825         $this->task($values);
1826         return;
1827
1828       case 'task_id':
1829         // since this case is handled with the above
1830         return;
1831
1832       case 'prox_distance':
1833         CRM_Contact_BAO_ProximityQuery::process($this, $values);
1834         return;
1835
1836       case 'prox_street_address':
1837       case 'prox_city':
1838       case 'prox_postal_code':
1839       case 'prox_state_province_id':
1840       case 'prox_country_id':
1841         // handled by the proximity_distance clause
1842         return;
1843
1844       default:
1845         $this->restWhere($values);
1846         return;
1847     }
1848   }
1849
1850   /**
1851    * Given a list of conditions in params generate the required.
1852    * where clause
1853    *
1854    * @return string
1855    */
1856   public function whereClause() {
1857     $this->_where[0] = array();
1858     $this->_qill[0] = array();
1859
1860     $this->includeContactIds();
1861     if (!empty($this->_params)) {
1862       foreach (array_keys($this->_params) as $id) {
1863         if (empty($this->_params[$id][0])) {
1864           continue;
1865         }
1866         // check for both id and contact_id
1867         if ($this->_params[$id][0] == 'id' || $this->_params[$id][0] == 'contact_id') {
1868           if (
1869             $this->_params[$id][1] == 'IS NULL' ||
1870             $this->_params[$id][1] == 'IS NOT NULL'
1871           ) {
1872             $this->_where[0][] = "contact_a.id {$this->_params[$id][1]}";
1873           }
1874           elseif (is_array($this->_params[$id][2])) {
1875             $idList = implode("','", $this->_params[$id][2]);
1876             //why on earth do they put ' in the middle & not on the outside? We have to assume it's
1877             //to support 'something' so lets add them conditionally to support the api (which is a tested flow
1878             // so if you are looking to alter this check api test results
1879             if (strpos(trim($idList), "'") > 0) {
1880               $idList = "'" . $idList . "'";
1881             }
1882
1883             $this->_where[0][] = "contact_a.id IN ({$idList})";
1884           }
1885           else {
1886             $this->_where[0][] = self::buildClause("contact_a.id", "{$this->_params[$id][1]}", "{$this->_params[$id][2]}");
1887           }
1888         }
1889         else {
1890           $this->whereClauseSingle($this->_params[$id]);
1891         }
1892       }
1893
1894       CRM_Core_Component::alterQuery($this, 'where');
1895
1896       CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'where');
1897     }
1898
1899     if ($this->_customQuery) {
1900       // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1901       // Hope it wont affect the other part of civicrm.. if it does please remove it.
1902       if (!empty($this->_customQuery->_where)) {
1903         $this->_where = CRM_Utils_Array::crmArrayMerge($this->_where, $this->_customQuery->_where);
1904       }
1905
1906       $this->_qill = CRM_Utils_Array::crmArrayMerge($this->_qill, $this->_customQuery->_qill);
1907     }
1908
1909     $clauses = array();
1910     $andClauses = array();
1911
1912     $validClauses = 0;
1913     if (!empty($this->_where)) {
1914       foreach ($this->_where as $grouping => $values) {
1915         if ($grouping > 0 && !empty($values)) {
1916           $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1917           $validClauses++;
1918         }
1919       }
1920
1921       if (!empty($this->_where[0])) {
1922         $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where[0]) . ' ) ';
1923       }
1924       if (!empty($clauses)) {
1925         $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1926       }
1927
1928       if ($validClauses > 1) {
1929         $this->_useDistinct = TRUE;
1930       }
1931     }
1932
1933     return implode(' AND ', $andClauses);
1934   }
1935
1936   /**
1937    * @param $values
1938    *
1939    * @throws Exception
1940    */
1941   public function restWhere(&$values) {
1942     $name = CRM_Utils_Array::value(0, $values);
1943     $op = CRM_Utils_Array::value(1, $values);
1944     $value = CRM_Utils_Array::value(2, $values);
1945     $grouping = CRM_Utils_Array::value(3, $values);
1946     $wildcard = CRM_Utils_Array::value(4, $values);
1947
1948     if (isset($grouping) && empty($this->_where[$grouping])) {
1949       $this->_where[$grouping] = array();
1950     }
1951
1952     $multipleFields = array('url');
1953
1954     //check if the location type exits for fields
1955     $lType = '';
1956     $locType = explode('-', $name);
1957
1958     if (!in_array($locType[0], $multipleFields)) {
1959       //add phone type if exists
1960       if (isset($locType[2]) && $locType[2]) {
1961         $locType[2] = CRM_Core_DAO::escapeString($locType[2]);
1962       }
1963     }
1964
1965     $field = CRM_Utils_Array::value($name, $this->_fields);
1966
1967     if (!$field) {
1968       $field = CRM_Utils_Array::value($locType[0], $this->_fields);
1969
1970       if (!$field) {
1971         return;
1972       }
1973     }
1974
1975     $setTables = TRUE;
1976
1977     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
1978     $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1979
1980     if (substr($name, 0, 14) === 'state_province') {
1981       if (isset($locType[1]) && is_numeric($locType[1])) {
1982         $setTables = FALSE;
1983         $aName = "{$locationType[$locType[1]]}-address";
1984         $where = "`$aName`.state_province_id";
1985       }
1986       else {
1987         $where = "civicrm_address.state_province_id";
1988       }
1989
1990       $states = CRM_Core_PseudoConstant::stateProvince();
1991       if (is_numeric($value)) {
1992         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
1993         $value = $states[(int ) $value];
1994       }
1995       else {
1996         $intVal = CRM_Utils_Array::key($value, $states);
1997         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
1998       }
1999       if (!$lType) {
2000         $this->_qill[$grouping][] = ts('State') . " $op '$value'";
2001       }
2002       else {
2003         $this->_qill[$grouping][] = ts('State') . " ($lType) $op '$value'";
2004       }
2005     }
2006     elseif (!empty($field['pseudoconstant'])) {
2007       $this->optionValueQuery(
2008         $name, $op, $value, $grouping,
2009         CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', $field['name']),
2010         $field,
2011         $field['title'],
2012         'String',
2013         TRUE
2014       );
2015       if ($name == 'gender_id') {
2016         self::$_openedPanes[ts('Demographics')] = TRUE;
2017       }
2018     }
2019     elseif (substr($name, 0, 7) === 'country') {
2020       if (isset($locType[1]) && is_numeric($locType[1])) {
2021         $setTables = FALSE;
2022         $aName = "{$locationType[$locType[1]]}-address";
2023         $where = "`$aName`.country_id";
2024       }
2025       else {
2026         $where = "civicrm_address.country_id";
2027       }
2028
2029       $countries = CRM_Core_PseudoConstant::country();
2030       if (is_numeric($value)) {
2031         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
2032         $value = $countries[(int ) $value];
2033       }
2034       else {
2035         $intVal = CRM_Utils_Array::key($value, $countries);
2036         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
2037       }
2038
2039       if (!$lType) {
2040         $this->_qill[$grouping][] = ts('Country') . " $op '$value'";
2041       }
2042       else {
2043         $this->_qill[$grouping][] = ts('Country') . " ($lType) $op '$value'";
2044       }
2045     }
2046     elseif (substr($name, 0, 6) === 'county') {
2047       if (isset($locType[1]) && is_numeric($locType[1])) {
2048         $setTables = FALSE;
2049         $aName = "{$locationType[$locType[1]]}-address";
2050         $where = "`$aName`.county_id";
2051       }
2052       else {
2053         $where = "civicrm_address.county_id";
2054       }
2055
2056       $counties = CRM_Core_PseudoConstant::county();
2057       if (is_numeric($value)) {
2058         $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive');
2059         $value = $counties[(int ) $value];
2060       }
2061       else {
2062         $intVal = CRM_Utils_Array::key($value, $counties);
2063         $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive');
2064       }
2065
2066       if (!$lType) {
2067         $this->_qill[$grouping][] = ts('County') . " $op '$value'";
2068       }
2069       else {
2070         $this->_qill[$grouping][] = ts('County') . " ($lType) $op '$value'";
2071       }
2072     }
2073     elseif ($name === 'world_region') {
2074       $field['where'] = 'civicrm_worldregion.id';
2075       $this->optionValueQuery(
2076         $name, $op, $value, $grouping,
2077         CRM_Core_PseudoConstant::worldRegion(),
2078         $field,
2079         ts('World Region'),
2080         'Positive',
2081         TRUE
2082       );
2083     }
2084     elseif ($name === 'is_deceased') {
2085       $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value);
2086       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2087       self::$_openedPanes[ts('Demographics')] = TRUE;
2088     }
2089     elseif ($name === 'created_date' || $name === 'modified_date' || $name === 'deceased_date' || $name === 'birth_date') {
2090       $appendDateTime = TRUE;
2091       if ($name === 'deceased_date' || $name === 'birth_date') {
2092         $appendDateTime = FALSE;
2093         self::$_openedPanes[ts('Demographics')] = TRUE;
2094       }
2095       $this->dateQueryBuilder($values, 'contact_a', $name, $name, $field['title'], $appendDateTime);
2096     }
2097     elseif ($name === 'contact_id') {
2098       if (is_int($value)) {
2099         $this->_where[$grouping][] = self::buildClause($field['where'], $op, $value);
2100         $this->_qill[$grouping][] = "$field[title] $op $value";
2101       }
2102     }
2103     elseif ($name === 'name') {
2104       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2105       if ($wildcard) {
2106         $value = "%$value%";
2107         $op = 'LIKE';
2108       }
2109       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
2110       $this->_where[$grouping][] = self::buildClause($wc, $op, "'$value'");
2111       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2112     }
2113     elseif ($name === 'current_employer') {
2114       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2115       if ($wildcard) {
2116         $value = "%$value%";
2117         $op = 'LIKE';
2118       }
2119       $wc = self::caseImportant($op) ? "LOWER(contact_a.organization_name)" : "contact_a.organization_name";
2120       $ceWhereClause = self::buildClause($wc, $op,
2121         $value
2122       );
2123       $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
2124       $this->_where[$grouping][] = $ceWhereClause;
2125       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2126     }
2127     elseif ($name === 'email_greeting') {
2128       $filterCondition = array('greeting_type' => 'email_greeting');
2129       $this->optionValueQuery(
2130         $name, $op, $value, $grouping,
2131         CRM_Core_PseudoConstant::greeting($filterCondition),
2132         $field,
2133         ts('Email Greeting')
2134       );
2135     }
2136     elseif ($name === 'postal_greeting') {
2137       $filterCondition = array('greeting_type' => 'postal_greeting');
2138       $this->optionValueQuery(
2139         $name, $op, $value, $grouping,
2140         CRM_Core_PseudoConstant::greeting($filterCondition),
2141         $field,
2142         ts('Postal Greeting')
2143       );
2144     }
2145     elseif ($name === 'addressee') {
2146       $filterCondition = array('greeting_type' => 'addressee');
2147       $this->optionValueQuery(
2148         $name, $op, $value, $grouping,
2149         CRM_Core_PseudoConstant::greeting($filterCondition),
2150         $field,
2151         ts('Addressee')
2152       );
2153     }
2154     elseif (substr($name, 0, 4) === 'url-') {
2155       $tName = 'civicrm_website';
2156       $this->_whereTables[$tName] = $this->_tables[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2157       $value = $strtolower(CRM_Core_DAO::escapeString($value));
2158       if ($wildcard) {
2159         $value = "%$value%";
2160         $op = 'LIKE';
2161       }
2162
2163       $wc = 'civicrm_website.url';
2164       $this->_where[$grouping][] = $d = self::buildClause($wc, $op, $value);
2165       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2166     }
2167     elseif ($name === 'contact_is_deleted') {
2168       $this->_where[$grouping][] = self::buildClause("contact_a.is_deleted", $op, $value);
2169       $this->_qill[$grouping][] = "$field[title] $op \"$value\"";
2170     }
2171     elseif (!empty($field['where'])) {
2172       $type = NULL;
2173       if (!empty($field['type'])) {
2174         $type = CRM_Utils_Type::typeToString($field['type']);
2175       }
2176
2177       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2178
2179       if (isset($locType[1]) &&
2180         is_numeric($locType[1])
2181       ) {
2182         $setTables = FALSE;
2183
2184         //get the location name
2185         list($tName, $fldName) = self::getLocationTableName($field['where'], $locType);
2186
2187         $fieldName = "LOWER(`$tName`.$fldName)";
2188
2189         // we set both _tables & whereTables because whereTables doesn't seem to do what the name implies it should
2190         $this->_tables[$tName] = $this->_whereTables[$tName] = 1;
2191
2192       }
2193       else {
2194         if ($tableName == 'civicrm_contact') {
2195           $fieldName = "LOWER(contact_a.{$fieldName})";
2196         }
2197         else {
2198           if ($op != 'IN' && !is_numeric($value)) {
2199             $fieldName = "LOWER({$field['where']})";
2200           }
2201           else {
2202             $fieldName = "{$field['where']}";
2203           }
2204         }
2205       }
2206
2207       list($qillop, $qillVal) = self::buildQillForFieldValue(NULL, $field['title'], $value, $op);
2208       $this->_qill[$grouping][] = "$field[title] $qillop '$qillVal'";
2209
2210       if (is_array($value)) {
2211         // traditionally an array being passed has been a fatal error. We can take advantage of this to add support
2212         // for api style operators for functions that hit this point without worrying about regression
2213         // (the previous comments indicated the condition for hitting this point were unknown
2214         // per CRM-14743 we are adding modified_date & created_date operator support
2215         $operations = array_keys($value);
2216         foreach ($operations as $operator) {
2217           if (!in_array($operator, CRM_Core_DAO::acceptedSQLOperators())) {
2218             //Via Contact get api value is not in array(operator => array(values)) format ONLY for IN/NOT IN operators
2219             //so this condition will satisfy the search for now
2220             if (strpos($op, 'IN') !== FALSE) {
2221               $value = array($op => $value);
2222             }
2223             // we don't know when this might happen
2224             else {
2225               CRM_Core_Error::fatal(ts("%1 is not a valid operator", array(1 => $operator)));
2226             }
2227           }
2228         }
2229         $this->_where[$grouping][] = CRM_Core_DAO::createSQLFilter($fieldName, $value, $type);
2230       }
2231       else {
2232         if ($op != 'IN') {
2233           $value = $strtolower($value);
2234         }
2235         if ($wildcard) {
2236           $value = "%$value%";
2237           $op = 'LIKE';
2238         }
2239
2240         $this->_where[$grouping][] = self::buildClause($fieldName, $op, $value, $type);
2241       }
2242     }
2243
2244     if ($setTables && isset($field['where'])) {
2245       list($tableName, $fieldName) = explode('.', $field['where'], 2);
2246       if (isset($tableName)) {
2247         $this->_tables[$tableName] = 1;
2248         $this->_whereTables[$tableName] = 1;
2249       }
2250     }
2251   }
2252
2253
2254   /**
2255    * @param $where
2256    * @param $locType
2257    *
2258    * @return array
2259    * @throws Exception
2260    */
2261   public static function getLocationTableName(&$where, &$locType) {
2262     if (isset($locType[1]) && is_numeric($locType[1])) {
2263       list($tbName, $fldName) = explode(".", $where);
2264
2265       //get the location name
2266       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
2267       $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2268       if (in_array($locType[0], $specialFields)) {
2269         //hack to fix / special handing for phone_ext
2270         if ($locType[0] == 'phone_ext') {
2271           $locType[0] = 'phone';
2272         }
2273         if (isset($locType[2]) && $locType[2]) {
2274           $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2275         }
2276         else {
2277           $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2278         }
2279       }
2280       elseif (in_array($locType[0],
2281         array(
2282           'address_name',
2283           'street_address',
2284           'supplemental_address_1',
2285           'supplemental_address_2',
2286           'city',
2287           'postal_code',
2288           'postal_code_suffix',
2289           'geo_code_1',
2290           'geo_code_2',
2291         )
2292       )) {
2293         //fix for search by profile with address fields.
2294         $tName = "{$locationType[$locType[1]]}-address";
2295       }
2296       elseif ($locType[0] == 'on_hold') {
2297         $tName = "{$locationType[$locType[1]]}-email";
2298       }
2299       else {
2300         $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2301       }
2302       $tName = str_replace(' ', '_', $tName);
2303       return array($tName, $fldName);
2304     }
2305     CRM_Core_Error::fatal();
2306   }
2307
2308   /**
2309    * Given a result dao, extract the values and return that array
2310    *
2311    * @param CRM_Core_DAO $dao
2312    *
2313    * @return array
2314    *   values for this query
2315    */
2316   public function store($dao) {
2317     $value = array();
2318
2319     foreach ($this->_element as $key => $dontCare) {
2320       if (property_exists($dao, $key)) {
2321         if (strpos($key, '-') !== FALSE) {
2322           $values = explode('-', $key);
2323           $lastElement = array_pop($values);
2324           $current = &$value;
2325           $cnt = count($values);
2326           $count = 1;
2327           foreach ($values as $v) {
2328             if (!array_key_exists($v, $current)) {
2329               $current[$v] = array();
2330             }
2331             //bad hack for im_provider
2332             if ($lastElement == 'provider_id') {
2333               if ($count < $cnt) {
2334                 $current = &$current[$v];
2335               }
2336               else {
2337                 $lastElement = "{$v}_{$lastElement}";
2338               }
2339             }
2340             else {
2341               $current = &$current[$v];
2342             }
2343             $count++;
2344           }
2345
2346           $current[$lastElement] = $dao->$key;
2347         }
2348         else {
2349           $value[$key] = $dao->$key;
2350         }
2351       }
2352     }
2353     return $value;
2354   }
2355
2356   /**
2357    * Getter for tables array.
2358    *
2359    * @return array
2360    */
2361   public function tables() {
2362     return $this->_tables;
2363   }
2364
2365   /**
2366    * Where tables is sometimes used to create the from clause, but, not reliably, set this AND set tables
2367    * It's unclear the intent - there is a 'simpleFrom' clause which takes whereTables into account & a fromClause which doesn't
2368    * logic may have eroded
2369    * @return array
2370    */
2371   public function whereTables() {
2372     return $this->_whereTables;
2373   }
2374
2375   /**
2376    * Generate the where clause (used in match contacts and permissions)
2377    *
2378    * @param array $params
2379    * @param array $fields
2380    * @param array $tables
2381    * @param $whereTables
2382    * @param bool $strict
2383    *
2384    * @return string
2385    */
2386   public static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2387     $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2388       FALSE, $strict
2389     );
2390
2391     $tables = array_merge($query->tables(), $tables);
2392     $whereTables = array_merge($query->whereTables(), $whereTables);
2393
2394     return $query->_whereClause;
2395   }
2396
2397   /**
2398    * Create the from clause.
2399    *
2400    * @param array $tables
2401    *   Tables that need to be included in this from clause.
2402    *                      if null, return mimimal from clause (i.e. civicrm_contact)
2403    * @param array $inner
2404    *   Tables that should be inner-joined.
2405    * @param array $right
2406    *   Tables that should be right-joined.
2407    *
2408    * @param bool $primaryLocation
2409    * @param int $mode
2410    *
2411    * @return string
2412    *   the from clause
2413    */
2414   public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2415
2416     $from = ' FROM civicrm_contact contact_a';
2417     if (empty($tables)) {
2418       return $from;
2419     }
2420
2421     if (!empty($tables['civicrm_worldregion'])) {
2422       $tables = array_merge(array('civicrm_country' => 1), $tables);
2423     }
2424
2425     if ((!empty($tables['civicrm_state_province']) || !empty($tables['civicrm_country']) ||
2426         CRM_Utils_Array::value('civicrm_county', $tables)
2427       ) && empty($tables['civicrm_address'])
2428     ) {
2429       $tables = array_merge(array('civicrm_address' => 1),
2430         $tables
2431       );
2432     }
2433
2434     // add group_contact table if group table is present
2435     if (!empty($tables['civicrm_group']) && empty($tables['civicrm_group_contact'])) {
2436       $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added'";
2437     }
2438
2439     // add group_contact and group table is subscription history is present
2440     if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2441       $tables = array_merge(array(
2442           'civicrm_group' => 1,
2443           'civicrm_group_contact' => 1,
2444         ),
2445         $tables
2446       );
2447     }
2448
2449     // to handle table dependencies of components
2450     CRM_Core_Component::tableNames($tables);
2451     // to handle table dependencies of hook injected tables
2452     CRM_Contact_BAO_Query_Hook::singleton()->setTableDependency($tables);
2453
2454     //format the table list according to the weight
2455     $info = CRM_Core_TableHierarchy::info();
2456
2457     foreach ($tables as $key => $value) {
2458       $k = 99;
2459       if (strpos($key, '-') !== FALSE) {
2460         $keyArray = explode('-', $key);
2461         $k = CRM_Utils_Array::value('civicrm_' . $keyArray[1], $info, 99);
2462       }
2463       elseif (strpos($key, '_') !== FALSE) {
2464         $keyArray = explode('_', $key);
2465         if (is_numeric(array_pop($keyArray))) {
2466           $k = CRM_Utils_Array::value(implode('_', $keyArray), $info, 99);
2467         }
2468         else {
2469           $k = CRM_Utils_Array::value($key, $info, 99);
2470         }
2471       }
2472       else {
2473         $k = CRM_Utils_Array::value($key, $info, 99);
2474       }
2475       $tempTable[$k . ".$key"] = $key;
2476     }
2477     ksort($tempTable);
2478     $newTables = array();
2479     foreach ($tempTable as $key) {
2480       $newTables[$key] = $tables[$key];
2481     }
2482
2483     $tables = $newTables;
2484
2485     foreach ($tables as $name => $value) {
2486       if (!$value) {
2487         continue;
2488       }
2489
2490       if (!empty($inner[$name])) {
2491         $side = 'INNER';
2492       }
2493       elseif (!empty($right[$name])) {
2494         $side = 'RIGHT';
2495       }
2496       else {
2497         $side = 'LEFT';
2498       }
2499
2500       if ($value != 1) {
2501         // if there is already a join statement in value, use value itself
2502         if (strpos($value, 'JOIN')) {
2503           $from .= " $value ";
2504         }
2505         else {
2506           $from .= " $side JOIN $name ON ( $value ) ";
2507         }
2508         continue;
2509       }
2510       switch ($name) {
2511         case 'civicrm_address':
2512           if ($primaryLocation) {
2513             $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2514           }
2515           else {
2516             //CRM-14263 further handling of address joins further down...
2517             $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2518           }
2519           continue;
2520
2521         case 'civicrm_phone':
2522           $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2523           continue;
2524
2525         case 'civicrm_email':
2526           $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2527           continue;
2528
2529         case 'civicrm_im':
2530           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2531           continue;
2532
2533         case 'im_provider':
2534           $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2535           $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2536           $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)";
2537           continue;
2538
2539         case 'civicrm_openid':
2540           $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2541           continue;
2542
2543         case 'civicrm_worldregion':
2544           $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2545           $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2546           continue;
2547
2548         case 'civicrm_location_type':
2549           $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2550           continue;
2551
2552         case 'civicrm_group':
2553           $from .= " $side JOIN civicrm_group ON civicrm_group.id =  civicrm_group_contact.group_id ";
2554           continue;
2555
2556         case 'civicrm_group_contact':
2557           $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2558           continue;
2559
2560         case 'civicrm_activity':
2561         case 'civicrm_activity_tag':
2562         case 'activity_type':
2563         case 'activity_status':
2564         case 'parent_id':
2565         case 'civicrm_activity_contact':
2566         case 'source_contact':
2567           $from .= CRM_Activity_BAO_Query::from($name, $mode, $side);
2568           continue;
2569
2570         case 'civicrm_entity_tag':
2571           $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2572                                                               civicrm_entity_tag.entity_id = contact_a.id ) ";
2573           continue;
2574
2575         case 'civicrm_note':
2576           $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2577                                                         contact_a.id = civicrm_note.entity_id ) ";
2578           continue;
2579
2580         case 'civicrm_subscription_history':
2581           $from .= " $side JOIN civicrm_subscription_history
2582                                    ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2583                                   AND civicrm_group_contact.group_id =  civicrm_subscription_history.group_id";
2584           continue;
2585
2586         case 'civicrm_relationship':
2587           if (self::$_relType == 'reciprocal') {
2588             if (self::$_relationshipTempTable) {
2589               // we have a temptable to join on
2590               $tbl = self::$_relationshipTempTable;
2591               $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2592             }
2593             else {
2594               $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2595               $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)";
2596             }
2597           }
2598           elseif (self::$_relType == 'b') {
2599             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2600             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2601           }
2602           else {
2603             $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2604             $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2605           }
2606           continue;
2607
2608         case 'civicrm_log':
2609           $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2610           $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2611           continue;
2612
2613         case 'civicrm_tag':
2614           $from .= " $side  JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2615           continue;
2616
2617         case 'civicrm_grant':
2618           $from .= CRM_Grant_BAO_Query::from($name, $mode, $side);
2619           continue;
2620
2621         case 'civicrm_website':
2622           $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2623           continue;
2624
2625         default:
2626           $locationTypeName = '';
2627           if (strpos($name, '-address') != 0) {
2628             $locationTypeName = 'address';
2629           }
2630           elseif (strpos($name, '-phone') != 0) {
2631             $locationTypeName = 'phone';
2632           }
2633           elseif (strpos($name, '-email') != 0) {
2634             $locationTypeName = 'email';
2635           }
2636           if ($locationTypeName) {
2637             //we have a join on an location table - possibly in conjunction with search builder - CRM-14263
2638             $parts = explode('-', $name);
2639             $locationID = array_search($parts[0], CRM_Core_BAO_Address::buildOptions('location_type_id', 'get', array('name' => $parts[0])));
2640             $from .= " $side JOIN civicrm_{$locationTypeName} `{$name}` ON ( contact_a.id = `{$name}`.contact_id ) and `{$name}`.location_type_id = $locationID ";
2641           }
2642           else {
2643             $from .= CRM_Core_Component::from($name, $mode, $side);
2644           }
2645           $from .= CRM_Contact_BAO_Query_Hook::singleton()->buildSearchfrom($name, $mode, $side);
2646
2647           continue;
2648       }
2649     }
2650     return $from;
2651   }
2652
2653   /**
2654    * WHERE / QILL clause for deleted_contacts
2655    *
2656    * @param $values
2657    *
2658    * @return void
2659    */
2660   public function deletedContacts($values) {
2661     list($_, $_, $value, $grouping, $_) = $values;
2662     if ($value) {
2663       // *prepend* to the relevant grouping as this is quite an important factor
2664       array_unshift($this->_qill[$grouping], ts('Search in Trash'));
2665     }
2666   }
2667
2668   /**
2669    * Where / qill clause for contact_type
2670    *
2671    * @param $values
2672    *
2673    * @return void
2674    */
2675   public function contactType(&$values) {
2676     list($name, $op, $value, $grouping, $wildcard) = $values;
2677
2678     $subTypes = array();
2679     $clause = array();
2680
2681     // account for search builder mapping multiple values
2682     if (!is_array($value)) {
2683       $values = self::parseSearchBuilderString($value, 'String');
2684       if (is_array($values)) {
2685         $value = array_flip($values);
2686       }
2687     }
2688
2689     if (is_array($value)) {
2690       foreach ($value as $k => $v) {
2691         // fix for CRM-771
2692         if ($k) {
2693           $subType = NULL;
2694           $contactType = $k;
2695           if (strpos($k, CRM_Core_DAO::VALUE_SEPARATOR)) {
2696             list($contactType, $subType) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $k, 2);
2697           }
2698
2699           if (!empty($subType)) {
2700             $subTypes[$subType] = 1;
2701           }
2702           $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2703         }
2704       }
2705     }
2706     else {
2707       $contactTypeANDSubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value, 2);
2708       $contactType = $contactTypeANDSubType[0];
2709       $subType = CRM_Utils_Array::value(1, $contactTypeANDSubType);
2710       if (!empty($subType)) {
2711         $subTypes[$subType] = 1;
2712       }
2713       $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'";
2714     }
2715
2716     // fix for CRM-771
2717     if (!empty($clause)) {
2718       $quill = $clause;
2719       if ($op == 'IN' || $op == 'NOT IN') {
2720         $this->_where[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2721       }
2722       else {
2723         $type = array_pop($clause);
2724         $this->_where[$grouping][] = self::buildClause("contact_a.contact_type", $op, $contactType);
2725       }
2726
2727       $this->_qill[$grouping][] = ts('Contact Type') . " $op " . implode(' ' . ts('or') . ' ', $quill);
2728
2729       if (!empty($subTypes)) {
2730         $this->includeContactSubTypes($subTypes, $grouping);
2731       }
2732     }
2733   }
2734
2735   /**
2736    * Where / qill clause for contact_sub_type
2737    *
2738    * @param $values
2739    *
2740    * @return void
2741    */
2742   public function contactSubType(&$values) {
2743     list($name, $op, $value, $grouping, $wildcard) = $values;
2744     $this->includeContactSubTypes($value, $grouping, $op);
2745   }
2746
2747   /**
2748    * @param $value
2749    * @param $grouping
2750    * @param string $op
2751    */
2752   public function includeContactSubTypes($value, $grouping, $op = 'LIKE') {
2753
2754     $clause = array();
2755     $alias = "contact_a.contact_sub_type";
2756     $qillOperators = array('NOT LIKE' => ts('Not Like')) + CRM_Core_SelectValues::getSearchBuilderOperators();
2757
2758     $op = str_replace('IN', 'LIKE', $op);
2759     $op = str_replace('=', 'LIKE', $op);
2760     $op = str_replace('!', 'NOT ', $op);
2761
2762     if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
2763       $this->_where[$grouping][] = self::buildClause($alias, $op, $value, 'String');
2764     }
2765     elseif (is_array($value)) {
2766       foreach ($value as $k => $v) {
2767         if (!empty($k)) {
2768           $clause[$k] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($k, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2769         }
2770       }
2771     }
2772     else {
2773       $clause[$value] = "($alias $op '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($value, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')";
2774     }
2775
2776     if (!empty($clause)) {
2777       $this->_where[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2778     }
2779     $this->_qill[$grouping][] = ts('Contact Subtype %1 ', array(1 => $qillOperators[$op])) . implode(' ' . ts('or') . ' ', array_keys($clause));
2780   }
2781
2782   /**
2783    * Where / qill clause for groups
2784    *
2785    * @param $values
2786    *
2787    * @return void
2788    */
2789   public function group(&$values) {
2790     list($name, $op, $value, $grouping, $wildcard) = $values;
2791
2792     if (count($value) > 1) {
2793       $this->_useDistinct = TRUE;
2794     }
2795
2796     // Replace pseudo operators from search builder
2797     $op = str_replace('EMPTY', 'NULL', $op);
2798
2799     $groupNames = CRM_Core_PseudoConstant::group();
2800     $groupIds = '';
2801     $names = array();
2802
2803     if ($value) {
2804       $groupIds = implode(',', array_keys($value));
2805       foreach ($value as $id => $dontCare) {
2806         if (array_key_exists($id, $groupNames) && $dontCare) {
2807           $names[] = $groupNames[$id];
2808         }
2809       }
2810     }
2811
2812     $statii = array();
2813     $in = FALSE;
2814     $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2815     if ($gcsValues &&
2816       is_array($gcsValues[2])
2817     ) {
2818       foreach ($gcsValues[2] as $k => $v) {
2819         if ($v) {
2820           if ($k == 'Added') {
2821             $in = TRUE;
2822           }
2823           $statii[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
2824         }
2825       }
2826     }
2827     else {
2828       $statii[] = '"Added"';
2829       $in = TRUE;
2830     }
2831
2832     $skipGroup = FALSE;
2833     if (count($value) == 1 &&
2834       count($statii) == 1 &&
2835       $statii[0] == '"Added"'
2836     ) {
2837       // check if smart group, if so we can get rid of that one additional
2838       // left join
2839       $groupIDs = array_keys($value);
2840
2841       if (!empty($groupIDs[0]) &&
2842         CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group',
2843           $groupIDs[0],
2844           'saved_search_id'
2845         )
2846       ) {
2847         $skipGroup = TRUE;
2848       }
2849     }
2850
2851     if (!$skipGroup) {
2852       $gcTable = "`civicrm_group_contact-{$groupIds}`";
2853       $joinClause = array("contact_a.id = {$gcTable}.contact_id");
2854       if ($groupIds && ($op == 'IN' || $op == 'NOT IN')) {
2855         $joinClause[] = "{$gcTable}.group_id IN ( $groupIds )";
2856       }
2857       // For NOT IN we join on groups the contact IS in, then exclude them in the where clause
2858       if ($statii && $op == 'NOT IN') {
2859         $joinClause[] = "{$gcTable}.status IN (" . implode(', ', $statii) . ")";
2860       }
2861       $this->_tables[$gcTable] = $this->_whereTables[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
2862     }
2863
2864     if ($op == 'IN') {
2865       $qill = ts('In group');
2866     }
2867     else {
2868       $qill = ts('Groups %1', array(1 => $op));
2869     }
2870     $qill .= ' ' . implode(' ' . ts('or') . ' ', $names);
2871
2872     $groupClause = NULL;
2873
2874     if (!$skipGroup) {
2875       $groupClause = "{$gcTable}.group_id $op" . ($groupIds ? " ( $groupIds ) " : '');
2876       if (!empty($statii) && $groupIds) {
2877         $groupClause .= " AND {$gcTable}.status IN (" . implode(', ', $statii) . ")";
2878         $qill .= " " . ($op == 'NOT IN' ? ts('WHERE') : ts('AND')) . " " . ts('Group Status') . ' - ' . implode(' ' . ts('or') . ' ', $statii);
2879       }
2880       // For NOT IN op, params were set in the join
2881       if ($op == 'NOT IN') {
2882         $groupClause = "{$gcTable}.group_id IS NULL";
2883       }
2884     }
2885
2886     if ($in) {
2887       $ssClause = $this->savedSearch($values);
2888       if ($ssClause) {
2889         if ($groupClause) {
2890           $groupClause = "( ( $groupClause ) OR ( $ssClause ) )";
2891         }
2892         else {
2893           $groupClause = $ssClause;
2894         }
2895       }
2896     }
2897
2898     $this->_where[$grouping][] = $groupClause;
2899     $this->_qill[$grouping][] = $qill;
2900   }
2901
2902   /**
2903    * Function translates selection of group type into a list of groups.
2904    * @param $value
2905    *
2906    * @return array
2907    */
2908   public function getGroupsFromTypeCriteria($value) {
2909     $groupIds = array();
2910     foreach ((array) $value as $groupTypeValue) {
2911       $groupList = CRM_Core_PseudoConstant::group($groupTypeValue);
2912       $groupIds = ($groupIds + $groupList);
2913     }
2914     return $groupIds;
2915   }
2916
2917   /**
2918    * Where / qill clause for smart groups
2919    *
2920    * @param $values
2921    *
2922    * @return string|NULL
2923    */
2924   public function savedSearch(&$values) {
2925     list($name, $op, $value, $grouping, $wildcard) = $values;
2926     return $this->addGroupContactCache(array_keys((array) $value));
2927   }
2928
2929   /**
2930    * @param array $groups
2931    * @param string $tableAlias
2932    * @param string $joinTable
2933    *
2934    * @return null|string
2935    */
2936   public function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a") {
2937     $config = CRM_Core_Config::singleton();
2938
2939     // Find all the groups that are part of a saved search.
2940     $groupIDs = implode(',', $groups);
2941     if (empty($groupIDs)) {
2942       return NULL;
2943     }
2944
2945     $sql = "
2946 SELECT id, cache_date, saved_search_id, children
2947 FROM   civicrm_group
2948 WHERE  id IN ( $groupIDs )
2949   AND  ( saved_search_id != 0
2950    OR    saved_search_id IS NOT NULL
2951    OR    children IS NOT NULL )
2952 ";
2953
2954     $group = CRM_Core_DAO::executeQuery($sql);
2955     $groupsFiltered = array();
2956
2957     while ($group->fetch()) {
2958       $groupsFiltered[] = $group->id;
2959
2960       $this->_useDistinct = TRUE;
2961
2962       if (!$this->_smartGroupCache || $group->cache_date == NULL) {
2963         CRM_Contact_BAO_GroupContactCache::load($group);
2964       }
2965     }
2966
2967     if (count($groupsFiltered)) {
2968       $groupIDsFiltered = implode(',', $groupsFiltered);
2969
2970       if ($tableAlias == NULL) {
2971         $tableAlias = "`civicrm_group_contact_cache_{$groupIDsFiltered}`";
2972       }
2973
2974       $this->_tables[$tableAlias] = $this->_whereTables[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache {$tableAlias} ON {$joinTable}.id = {$tableAlias}.contact_id ";
2975
2976       return "{$tableAlias}.group_id IN (" . $groupIDsFiltered . ")";
2977     }
2978
2979     return NULL;
2980   }
2981
2982   /**
2983    * Where / qill clause for cms users
2984    *
2985    * @param $values
2986    *
2987    * @return void
2988    */
2989   public function ufUser(&$values) {
2990     list($name, $op, $value, $grouping, $wildcard) = $values;
2991
2992     if ($value == 1) {
2993       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2994
2995       $this->_qill[$grouping][] = ts('CMS User');
2996     }
2997     elseif ($value == 0) {
2998       $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2999
3000       $this->_where[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
3001       $this->_qill[$grouping][] = ts('Not a CMS User');
3002     }
3003   }
3004
3005   /**
3006    * All tag search specific.
3007    *
3008    * @param $values
3009    *
3010    * @return void
3011    */
3012   public function tagSearch(&$values) {
3013     list($name, $op, $value, $grouping, $wildcard) = $values;
3014
3015     $op = "LIKE";
3016     $value = "%{$value}%";
3017
3018     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3019     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3020
3021     $etTable = "`civicrm_entity_tag-" . $value . "`";
3022     $tTable = "`civicrm_tag-" . $value . "`";
3023
3024     if ($useAllTagTypes[2]) {
3025       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3026         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
3027             LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  )";
3028
3029       // search tag in cases
3030       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3031       $tCaseTable = "`civicrm_case_tag-" . $value . "`";
3032       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3033         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3034             LEFT JOIN civicrm_case
3035             ON (civicrm_case_contact.case_id = civicrm_case.id
3036                 AND civicrm_case.is_deleted = 0 )
3037             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
3038             LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id  )";
3039       // search tag in activities
3040       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3041       $tActTable = "`civicrm_act_tag-" . $value . "`";
3042       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3043       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3044
3045       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3046         = " LEFT JOIN civicrm_activity_contact
3047             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3048             LEFT JOIN civicrm_activity
3049             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3050             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3051             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
3052             LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id  )";
3053
3054       $this->_where[$grouping][] = "({$tTable}.name $op '" . $value . "' OR {$tCaseTable}.name $op '" . $value . "' OR {$tActTable}.name $op '" . $value . "')";
3055       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
3056     }
3057     else {
3058       $etTable = "`civicrm_entity_tag-" . $value . "`";
3059       $tTable = "`civicrm_tag-" . $value . "`";
3060       $this->_tables[$etTable] = $this->_whereTables[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND
3061       {$etTable}.entity_table = 'civicrm_contact' )
3062                 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id  ) ";
3063
3064       $this->_where[$grouping][] = self::buildClause("{$tTable}.name", $op, $value, 'String');
3065       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
3066     }
3067   }
3068
3069   /**
3070    * Where / qill clause for tag
3071    *
3072    * @param $values
3073    *
3074    * @return void
3075    */
3076   public function tag(&$values) {
3077     list($name, $op, $value, $grouping, $wildcard) = $values;
3078
3079     $tagNames = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
3080     if (is_array($value)) {
3081       if (count($value) > 1) {
3082         $this->_useDistinct = TRUE;
3083       }
3084       foreach ($value as $id => $dontCare) {
3085         $names[] = CRM_Utils_Array::value($id, $tagNames);
3086       }
3087       $names = implode(' ' . ts('or') . ' ', $names);
3088       $value = implode(',', array_keys($value));
3089     }
3090     else {
3091       $names = CRM_Utils_Array::value($value, $tagNames);
3092     }
3093
3094     $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3095     $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3096
3097     $etTable = "`civicrm_entity_tag-" . $value . "`";
3098
3099     if ($useAllTagTypes[2]) {
3100       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3101         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3102
3103       // search tag in cases
3104       $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3105       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3106       $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
3107
3108       $this->_tables[$etCaseTable] = $this->_whereTables[$etCaseTable]
3109         = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3110             LEFT JOIN civicrm_case
3111             ON (civicrm_case_contact.case_id = civicrm_case.id
3112                 AND civicrm_case.is_deleted = 0 )
3113             LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
3114       // search tag in activities
3115       $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3116       $this->_tables[$etActTable] = $this->_whereTables[$etActTable]
3117         = " LEFT JOIN civicrm_activity_contact
3118             ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3119             LEFT JOIN civicrm_activity
3120             ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3121             AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3122             LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
3123
3124       // CRM-10338
3125       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3126         $this->_where[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
3127       }
3128       else {
3129         $this->_where[$grouping][] = "({$etTable}.tag_id $op (" . $value . ") OR {$etCaseTable}.tag_id $op (" . $value . ") OR {$etActTable}.tag_id $op (" . $value . "))";
3130       }
3131       $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names;
3132     }
3133     else {
3134       $this->_tables[$etTable] = $this->_whereTables[$etTable]
3135         = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id  AND {$etTable}.entity_table = 'civicrm_contact') ";
3136
3137       // CRM-10338
3138       if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3139         // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3140         $op = str_replace('EMPTY', 'NULL', $op);
3141         $this->_where[$grouping][] = "{$etTable}.tag_id $op";
3142       }
3143       else {
3144         $this->_where[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
3145       }
3146       $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $names;
3147     }
3148
3149   }
3150
3151   /**
3152    * Where/qill clause for notes
3153    *
3154    * @param $values
3155    *
3156    * @return void
3157    */
3158   public function notes(&$values) {
3159     list($name, $op, $value, $grouping, $wildcard) = $values;
3160
3161     $noteOptionValues = $this->getWhereValues('note_option', $grouping);
3162     $noteOption = CRM_Utils_Array::value('2', $noteOptionValues, '6');
3163     $noteOption = ($name == 'note_body') ? 2 : (($name == 'note_subject') ? 3 : $noteOption);
3164
3165     $this->_useDistinct = TRUE;
3166
3167     $this->_tables['civicrm_note'] = $this->_whereTables['civicrm_note']
3168       = " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
3169
3170     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3171     $n = trim($value);
3172     $value = $strtolower(CRM_Core_DAO::escapeString($n));
3173     if ($wildcard || $op == 'LIKE') {
3174       if (strpos($value, '%') === FALSE) {
3175         $value = "%$value%";
3176       }
3177       $op = 'LIKE';
3178     }
3179     elseif ($op == 'IS NULL' || $op == 'IS NOT NULL') {
3180       $value = NULL;
3181     }
3182
3183     $label = NULL;
3184     $clauses = array();
3185     if ($noteOption % 2 == 0) {
3186       $clauses[] = self::buildClause('civicrm_note.note', $op, $value, 'String');
3187       $label = ts('Note: Body Only');
3188     }
3189     if ($noteOption % 3 == 0) {
3190       $clauses[] = self::buildClause('civicrm_note.subject', $op, $value, 'String');
3191       $label = $label ? ts('Note: Body and Subject') : ts('Note: Subject Only');
3192     }
3193     $this->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
3194     $this->_qill[$grouping][] = $label . " $op - '$n'";
3195   }
3196
3197   /**
3198    * @param string $name
3199    * @param $op
3200    * @param $grouping
3201    *
3202    * @return bool
3203    */
3204   public function nameNullOrEmptyOp($name, $op, $grouping) {
3205     switch ($op) {
3206       case 'IS NULL':
3207       case 'IS NOT NULL':
3208         $this->_where[$grouping][] = "contact_a.$name $op";
3209         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3210         return TRUE;
3211
3212       case 'IS EMPTY':
3213         $this->_where[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
3214         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3215         return TRUE;
3216
3217       case 'IS NOT EMPTY':
3218         $this->_where[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
3219         $this->_qill[$grouping][] = ts('Name') . ' ' . $op;
3220         return TRUE;
3221
3222       default:
3223         return FALSE;
3224     }
3225   }
3226
3227   /**
3228    * Where / qill clause for sort_name
3229    *
3230    * @param $values
3231    *
3232    * @return void
3233    */
3234   public function sortName(&$values) {
3235     list($fieldName, $op, $value, $grouping, $wildcard) = $values;
3236
3237     // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3238     if ($this->nameNullOrEmptyOp($fieldName, $op, $grouping)) {
3239       return;
3240     }
3241
3242     $input = $value = trim($value);
3243
3244     if (!strlen($value)) {
3245       return;
3246     }
3247
3248     $config = CRM_Core_Config::singleton();
3249
3250     $sub = array();
3251
3252     //By default, $sub elements should be joined together with OR statements (don't change this variable).
3253     $subGlue = ' OR ';
3254
3255     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
3256
3257     $firstChar = substr($value, 0, 1);
3258     $lastChar = substr($value, -1, 1);
3259     $quotes = array("'", '"');
3260     // If string is quoted, strip quotes and otherwise don't alter it
3261     if ((strlen($value) > 2) && in_array($firstChar, $quotes) && in_array($lastChar, $quotes)) {
3262       $value = trim($value, implode('', $quotes));
3263     }
3264     // Replace spaces with wildcards for a LIKE operation
3265     // UNLESS string contains a comma (this exception is a tiny bit questionable)
3266     elseif ($op == 'LIKE' && strpos($value, ',') === FALSE) {
3267       $value = str_replace(' ', '%', $value);
3268     }
3269     $value = $strtolower(CRM_Core_DAO::escapeString(trim($value)));
3270     if (strlen($value)) {
3271       $fieldsub = array();
3272       if ($wildcard && $op == 'LIKE') {
3273         if ($config->includeWildCardInName) {
3274           $value = "'%$value%'";
3275         }
3276         else {
3277           $value = "'$value%'";
3278         }
3279         $op = 'LIKE';
3280       }
3281       else {
3282         $value = "'$value'";
3283       }
3284       if ($fieldName == 'sort_name') {
3285         $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3286       }
3287       else {
3288         $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name";
3289       }
3290       $fieldsub[] = " ( $wc $op $value )";
3291       if ($config->includeNickNameInName) {
3292         $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3293         $fieldsub[] = " ( $wc $op $value )";
3294       }
3295       if ($config->includeEmailInName) {
3296         $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3297       }
3298       $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3299     }
3300
3301     $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3302
3303     $this->_where[$grouping][] = $sub;
3304     if ($config->includeEmailInName) {
3305       $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3306       $this->_qill[$grouping][] = ts('Name or Email') . " $op - '$input'";
3307     }
3308     else {
3309       $this->_qill[$grouping][] = ts('Name') . " $op - '$input'";
3310     }
3311   }
3312
3313   /**
3314    * Where/qill clause for greeting fields.
3315    *
3316    * @param array $values
3317    */
3318   public function greetings(&$values) {
3319     list($name, $op, $value, $grouping, $wildcard) = $values;
3320     $name .= '_display';
3321
3322     $this->_qill[$grouping][] = ts('Greeting %1 %2', array(1 => $op, 2 => $value));
3323     $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", 'LIKE', "$value", 'String');
3324   }
3325
3326   /**
3327    * Where / qill clause for email
3328    *
3329    * @param $values
3330    *
3331    * @return void
3332    */
3333   public function email(&$values) {
3334     list($name, $op, $value, $grouping, $wildcard) = $values;
3335
3336     $n = trim($value);
3337     if ($n) {
3338       $config = CRM_Core_Config::singleton();
3339
3340       if (substr($n, 0, 1) == '"' &&
3341         substr($n, -1, 1) == '"'
3342       ) {
3343         $n = substr($n, 1, -1);
3344         $value = strtolower(CRM_Core_DAO::escapeString($n));
3345         $value = "'$value'";
3346         $op = '=';
3347       }
3348       else {
3349         $value = strtolower($n);
3350         if ($wildcard) {
3351           if (strpos($value, '%') === FALSE) {
3352             $value = "%{$value}%";
3353           }
3354           $op = 'LIKE';
3355         }
3356       }
3357       $this->_qill[$grouping][] = ts('Email') . " $op '$n'";
3358       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, $value, 'String');
3359     }
3360     else {
3361       $this->_qill[$grouping][] = ts('Email') . " $op ";
3362       $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, NULL, 'String');
3363     }
3364
3365     $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1;
3366   }
3367
3368   /**
3369    * Where / qill clause for phone number
3370    *
3371    * @param $values
3372    *
3373    * @return void
3374    */
3375   public function phone_numeric(&$values) {
3376     list($name, $op, $value, $grouping, $wildcard) = $values;
3377     // Strip non-numeric characters; allow wildcards
3378     $number = preg_replace('/[^\d%]/', '', $value);
3379     if ($number) {
3380       if (strpos($number, '%') === FALSE) {
3381         $number = "%$number%";
3382       }
3383
3384       $this->_qill[$grouping][] = ts('Phone number contains') . " $number";
3385       $this->_where[$grouping][] = self::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3386       $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3387     }
3388   }
3389
3390   /**
3391    * Where / qill clause for phone type/location
3392    *
3393    * @param $values
3394    *
3395    * @return void
3396    */
3397   public function phone_option_group($values) {
3398     list($name, $op, $value, $grouping, $wildcard) = $values;
3399     $option = ($name == 'phone_phone_type_id' ? 'phone_type_id' : 'location_type_id');
3400     $options = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', $option);
3401     $optionName = $options[$value];
3402     $this->_qill[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ? ts('type') : ('location')) . " $op $optionName";
3403     $this->_where[$grouping][] = self::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3404     $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1;
3405   }
3406
3407   /**
3408    * Where / qill clause for street_address
3409    *
3410    * @param $values
3411    *
3412    * @return void
3413    */
3414   public function street_address(&$values) {
3415     list($name, $op, $value, $grouping, $wildcard) = $values;
3416
3417     if (!$op) {
3418       $op = 'LIKE';
3419     }
3420
3421     $n = trim($value);
3422
3423     if ($n) {
3424       $value = strtolower($n);
3425       if (strpos($value, '%') === FALSE) {
3426         // only add wild card if not there
3427         $value = "%{$value}%";
3428       }
3429       $op = 'LIKE';
3430       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3431       $this->_qill[$grouping][] = ts('Street') . " $op '$n'";
3432     }
3433     else {
3434       $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3435       $this->_qill[$grouping][] = ts('Street') . " $op ";
3436     }
3437
3438     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3439   }
3440
3441   /**
3442    * Where / qill clause for street_unit
3443    *
3444    * @param $values
3445    *
3446    * @return void
3447    */
3448   public function street_number(&$values) {
3449     list($name, $op, $value, $grouping, $wildcard) = $values;
3450
3451     if (!$op) {
3452       $op = '=';
3453     }
3454
3455     $n = trim($value);
3456
3457     if (strtolower($n) == 'odd') {
3458       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3459       $this->_qill[$grouping][] = ts('Street Number is odd');
3460     }
3461     elseif (strtolower($n) == 'even') {
3462       $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3463       $this->_qill[$grouping][] = ts('Street Number is even');
3464     }
3465     else {
3466       $value = strtolower($n);
3467
3468       $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3469       $this->_qill[$grouping][] = ts('Street Number') . " $op '$n'";
3470     }
3471
3472     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3473   }
3474
3475   /**
3476    * Where / qill clause for sorting by character
3477    *
3478    * @param $values
3479    *
3480    * @return void
3481    */
3482   public function sortByCharacter(&$values) {
3483     list($name, $op, $value, $grouping, $wildcard) = $values;
3484
3485     $name = trim($value);
3486     $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($name)) . "%'";
3487     $this->_where[$grouping][] = $cond;
3488     $this->_qill[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3489   }
3490
3491   /**
3492    * Where / qill clause for including contact ids
3493    *
3494    * @return void
3495    */
3496   public function includeContactIDs() {
3497     if (!$this->_includeContactIds || empty($this->_params)) {
3498       return;
3499     }
3500
3501     $contactIds = array();
3502     foreach ($this->_params as $id => $values) {
3503       if (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
3504         $contactIds[] = substr($values[0], CRM_Core_Form::CB_PREFIX_LEN);
3505       }
3506     }
3507     if (!empty($contactIds)) {
3508       $this->_where[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3509     }
3510   }
3511
3512   /**
3513    * Where / qill clause for postal code
3514    *
3515    * @param $values
3516    *
3517    * @return void
3518    */
3519   public function postalCode(&$values) {
3520     // skip if the fields dont have anything to do with postal_code
3521     if (empty($this->_fields['postal_code'])) {
3522       return;
3523     }
3524
3525     list($name, $op, $value, $grouping, $wildcard) = $values;
3526
3527     // Handle numeric postal code range searches properly by casting the column as numeric
3528     if (is_numeric($value)) {
3529       $field = 'ROUND(civicrm_address.postal_code)';
3530       $val = CRM_Utils_Type::escape($value, 'Integer');
3531     }
3532     else {
3533       $field = 'civicrm_address.postal_code';
3534       $val = CRM_Utils_Type::escape($value, 'String');
3535     }
3536
3537     $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1;
3538
3539     if ($name == 'postal_code') {
3540       $this->_where[$grouping][] = self::buildClause($field, $op, $val, 'String');
3541       $this->_qill[$grouping][] = ts('Postal code') . " {$op} {$value}";
3542     }
3543     elseif ($name == 'postal_code_low') {
3544       $this->_where[$grouping][] = " ( $field >= '$val' ) ";
3545       $this->_qill[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3546     }
3547     elseif ($name == 'postal_code_high') {
3548       $this->_where[$grouping][] = " ( $field <= '$val' ) ";
3549       $this->_qill[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3550     }
3551   }
3552
3553   /**
3554    * Where / qill clause for location type
3555    *
3556    * @param $values
3557    * @param null $status
3558    *
3559    * @return void
3560    */
3561   public function locationType(&$values, $status = NULL) {
3562     list($name, $op, $value, $grouping, $wildcard) = $values;
3563
3564     if (is_array($value)) {
3565       $this->_where[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', $value) . ')';
3566       $this->_tables['civicrm_address'] = 1;
3567       $this->_whereTables['civicrm_address'] = 1;
3568
3569       $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
3570       $names = array();
3571       foreach ($value as $id) {
3572         $names[] = $locationType[$id];
3573       }
3574
3575       $this->_primaryLocation = FALSE;
3576
3577       if (!$status) {
3578         $this->_qill[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3579       }
3580       else {
3581         return implode(' ' . ts('or') . ' ', $names);
3582       }
3583     }
3584   }
3585
3586   /**
3587    * @param $values
3588    * @param bool $fromStateProvince
3589    *
3590    * @return array|NULL
3591    */
3592   public function country(&$values, $fromStateProvince = TRUE) {
3593     list($name, $op, $value, $grouping, $wildcard) = $values;
3594
3595     if (!$fromStateProvince) {
3596       $stateValues = $this->getWhereValues('state_province', $grouping);
3597       if (!empty($stateValues)) {
3598         // return back to caller if there are state province values
3599         // since that handles this case
3600         return NULL;
3601       }
3602     }
3603
3604     $countryClause = $countryQill = NULL;
3605     if (
3606       $values &&
3607       !empty($value)
3608     ) {
3609
3610       $this->_tables['civicrm_address'] = 1;
3611       $this->_whereTables['civicrm_address'] = 1;
3612
3613       $countries = CRM_Core_PseudoConstant::country();
3614       if (is_numeric($value)) {
3615         $countryClause = self::buildClause(
3616           'civicrm_address.country_id',
3617           $op,
3618           $value,
3619           'Positive'
3620         );
3621         $countryName = $countries[(int ) $value];
3622       }
3623
3624       else {
3625         $intValues = self::parseSearchBuilderString($value);
3626         if ($intValues && ($op == 'IN' || $op == 'NOT IN')) {
3627           $countryClause = self::buildClause(
3628             'civicrm_address.country_id',
3629             $op,
3630             $intValues,
3631             'Positive'
3632           );
3633           $countryNames = array();
3634           foreach ($intValues as $v) {
3635             $countryNames[] = $countries[$v];
3636           }
3637           $countryName = implode(',', $countryNames);
3638         }
3639         else {
3640           $countries = CRM_Core_PseudoConstant::country();
3641           $intVal = CRM_Utils_Array::key($value, $countries);
3642           $countryClause = self::buildClause(
3643             'civicrm_address.country_id',
3644             $op,
3645             $intVal,
3646             'Integer'
3647           );
3648           $countryName = $value;
3649         }
3650       }
3651       $countryQill = ts('Country') . " {$op} '$countryName'";
3652
3653       if (!$fromStateProvince) {
3654         $this->_where[$grouping][] = $countryClause;
3655         $this->_qill[$grouping][] = $countryQill;
3656       }
3657     }
3658
3659     if ($fromStateProvince) {
3660       if (!empty($countryClause)) {
3661         return array(
3662           $countryClause,
3663           " ...AND... " . $countryQill,
3664         );
3665       }
3666       else {
3667         return array(NULL, NULL);
3668       }
3669     }
3670   }
3671
3672   /**
3673    * Where / qill clause for county (if present)
3674    *
3675    * @param $values
3676    * @param null $status
3677    *
3678    * @return void
3679    */
3680   public function county(&$values, $status = NULL) {
3681     list($name, $op, $value, $grouping, $wildcard) = $values;
3682
3683     if (!is_array($value)) {
3684       // force the county to be an array
3685       $value = array($value);
3686     }
3687
3688     // check if the values are ids OR names of the counties
3689     $inputFormat = 'id';
3690     foreach ($value as $v) {
3691       if (!is_numeric($v)) {
3692         $inputFormat = 'name';
3693         break;
3694       }
3695     }
3696     $names = array();
3697     if ($op == '=') {
3698       $op = 'IN';
3699     }
3700     elseif ($op == '!=') {
3701       $op = 'NOT IN';
3702     }
3703     else {
3704       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3705       $op = str_replace('EMPTY', 'NULL', $op);
3706     }
3707
3708     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3709       $clause = "civicrm_address.county_id $op";
3710     }
3711     elseif ($inputFormat == 'id') {
3712       $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3713
3714       $county = CRM_Core_PseudoConstant::county();
3715       foreach ($value as $id) {
3716         $names[] = CRM_Utils_Array::value($id, $county);
3717       }
3718     }
3719     else {
3720       $inputClause = array();
3721       $county = CRM_Core_PseudoConstant::county();
3722       foreach ($value as $name) {
3723         $name = trim($name);
3724         $inputClause[] = CRM_Utils_Array::key($name, $county);
3725       }
3726       $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3727       $names = $value;
3728     }
3729     $this->_tables['civicrm_address'] = 1;
3730     $this->_whereTables['civicrm_address'] = 1;
3731
3732     $this->_where[$grouping][] = $clause;
3733     if (!$status) {
3734       $this->_qill[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3735     }
3736     else {
3737       return implode(' ' . ts('or') . ' ', $names);
3738     }
3739   }
3740
3741   /**
3742    * Where / qill clause for state/province AND country (if present)
3743    *
3744    * @param $values
3745    * @param null $status
3746    *
3747    * @return void
3748    */
3749   public function stateProvince(&$values, $status = NULL) {
3750     list($name, $op, $value, $grouping, $wildcard) = $values;
3751
3752     // quick escape for IS NULL
3753     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3754       $value = NULL;
3755     }
3756     elseif (!is_array($value)) {
3757       // force the state to be an array
3758       // check if its in the mapper format!
3759       $values = self::parseSearchBuilderString($value);
3760       if (is_array($values)) {
3761         $value = $values;
3762       }
3763       else {
3764         $value = array($value);
3765       }
3766     }
3767
3768     // check if the values are ids OR names of the states
3769     $inputFormat = 'id';
3770     if ($value) {
3771       foreach ($value as $v) {
3772         if (!is_numeric($v)) {
3773           $inputFormat = 'name';
3774           break;
3775         }
3776       }
3777     }
3778
3779     $names = array();
3780     if ($op == '=') {
3781       $op = 'IN';
3782     }
3783     elseif ($op == '!=') {
3784       $op = 'NOT IN';
3785     }
3786     else {
3787       // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3788       $op = str_replace('EMPTY', 'NULL', $op);
3789     }
3790     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3791       $stateClause = "civicrm_address.state_province_id $op";
3792     }
3793     elseif ($inputFormat == 'id') {
3794       if ($op != 'NOT IN') {
3795         $op = 'IN';
3796       }
3797       $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')';
3798
3799       foreach ($value as $id) {
3800         $names[] = CRM_Core_PseudoConstant::stateProvince($id, FALSE);
3801       }
3802     }
3803     else {
3804       $inputClause = array();
3805       $stateProvince = CRM_Core_PseudoConstant::stateProvince();
3806       foreach ($value as $name) {
3807         $name = trim($name);
3808         $inputClause[] = CRM_Utils_Array::key($name, $stateProvince);
3809       }
3810       $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')';
3811       $names = $value;
3812     }
3813     $this->_tables['civicrm_address'] = 1;
3814     $this->_whereTables['civicrm_address'] = 1;
3815
3816     $countryValues = $this->getWhereValues('country', $grouping);
3817     list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3818
3819     if ($countryClause) {
3820       $clause = "( $stateClause AND $countryClause )";
3821     }
3822     else {
3823       $clause = $stateClause;
3824     }
3825
3826     $this->_where[$grouping][] = $clause;
3827     if (!$status) {
3828       $this->_qill[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3829     }
3830     else {
3831       return implode(' ' . ts('or') . ' ', $names) . $countryQill;
3832     }
3833   }
3834
3835   /**
3836    * Where / qill clause for change log
3837    *
3838    * @param $values
3839    *
3840    * @return void
3841    */
3842   public function changeLog(&$values) {
3843     list($name, $op, $value, $grouping, $wildcard) = $values;
3844
3845     $targetName = $this->getWhereValues('changed_by', $grouping);
3846     if (!$targetName) {
3847       return;
3848     }
3849
3850     $name = trim($targetName[2]);
3851     $name = strtolower(CRM_Core_DAO::escapeString($name));
3852     $name = $targetName[4] ? "%$name%" : $name;
3853     $this->_where[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3854     $this->_tables['civicrm_log'] = $this->_whereTables['civicrm_log'] = 1;
3855     $this->_qill[$grouping][] = ts('Modified By') . " $name";
3856   }
3857
3858   /**
3859    * @param $values
3860    */
3861   public function modifiedDates($values) {
3862     $this->_useDistinct = TRUE;
3863
3864     // CRM-11281, default to added date if not set
3865     $fieldTitle = ts('Added Date');
3866     $fieldName = 'created_date';
3867     foreach (array_keys($this->_params) as $id) {
3868       if ($this->_params[$id][0] == 'log_date') {
3869         if ($this->_params[$id][2] == 2) {
3870           $fieldTitle = ts('Modified Date');
3871           $fieldName = 'modified_date';
3872         }
3873       }
3874     }
3875
3876     $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3877
3878     self::$_openedPanes[ts('Change Log')] = TRUE;
3879   }
3880
3881   /**
3882    * @param $values
3883    */
3884   public function demographics(&$values) {
3885     list($name, $op, $value, $grouping, $wildcard) = $values;
3886
3887     if (($name == 'birth_date_low') || ($name == 'birth_date_high')) {
3888
3889       $this->dateQueryBuilder($values,
3890         'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3891       );
3892     }
3893     elseif (($name == 'deceased_date_low') || ($name == 'deceased_date_high')) {
3894
3895       $this->dateQueryBuilder($values,
3896         'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3897       );
3898     }
3899
3900     self::$_openedPanes[ts('Demographics')] = TRUE;
3901   }
3902
3903   /**
3904    * @param $values
3905    */
3906   public function privacy(&$values) {
3907     list($name, $op, $value, $grouping, $wildcard) = $values;
3908     //fixed for profile search listing CRM-4633
3909     if (strpbrk($value, "[")) {
3910       $value = "'{$value}'";
3911       $op = "!{$op}";
3912       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3913     }
3914     else {
3915       $this->_where[$grouping][] = "contact_a.{$name} $op $value";
3916     }
3917     $field = CRM_Utils_Array::value($name, $this->_fields);
3918     $title = $field ? $field['title'] : $name;
3919     $this->_qill[$grouping][] = "$title $op $value";
3920   }
3921
3922   /**
3923    * @param $values
3924    */
3925   public function privacyOptions($values) {
3926     list($name, $op, $value, $grouping, $wildcard) = $values;
3927
3928     if (empty($value) || !is_array($value)) {
3929       return;
3930     }
3931
3932     // get the operator and toggle values
3933     $opValues = $this->getWhereValues('privacy_operator', $grouping);
3934     $operator = 'OR';
3935     if ($opValues &&
3936       strtolower($opValues[2] == 'AND')
3937     ) {
3938       $operator = 'AND';
3939     }
3940
3941     $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3942     $compareOP = '!';
3943     if ($toggleValues &&
3944       $toggleValues[2] == 2
3945     ) {
3946       $compareOP = '';
3947     }
3948
3949     $clauses = array();
3950     $qill = array();
3951     foreach ($value as $dontCare => $pOption) {
3952       $clauses[] = " ( contact_a.{$pOption} = 1 ) ";
3953       $field = CRM_Utils_Array::value($pOption, $this->_fields);
3954       $title = $field ? $field['title'] : $pOption;
3955       $qill[] = " $title = 1 ";
3956     }
3957
3958     $this->_where[$grouping][] = $compareOP . '( ' . implode($operator, $clauses) . ' )';
3959     $this->_qill[$grouping][] = $compareOP . '( ' . implode($operator, $qill) . ' )';
3960   }
3961
3962   /**
3963    * @param $values
3964    */
3965   public function preferredCommunication(&$values) {
3966     list($name, $op, $value, $grouping, $wildcard) = $values;
3967
3968     $pref = array();
3969     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3970       $value = NULL;
3971     }
3972     elseif (!is_array($value)) {
3973       $v = array();
3974       $value = trim($value, ' ()');
3975       if (strpos($value, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
3976         $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
3977       }
3978       else {
3979         $v = explode(",", $value);
3980       }
3981
3982       foreach ($v as $item) {
3983         if ($item) {
3984           $pref[] = $item;
3985         }
3986       }
3987     }
3988     else {
3989       foreach ($value as $key => $checked) {
3990         if ($checked) {
3991           $pref[] = $key;
3992         }
3993       }
3994     }
3995
3996     $commPref = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
3997
3998     $sqlValue = array();
3999     $showValue = array();
4000     $sql = "contact_a.preferred_communication_method";
4001     if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
4002       $sqlValue[] = "{$sql} {$op}";
4003     }
4004     else {
4005       foreach ($pref as $val) {
4006         $sqlValue[] = "( $sql like '%" . CRM_Core_DAO::VALUE_SEPARATOR . $val . CRM_Core_DAO::VALUE_SEPARATOR . "%' ) ";
4007         $showValue[] = $commPref[$val];
4008       }
4009     }
4010     $this->_where[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
4011     $this->_qill[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
4012   }
4013
4014   /**
4015    * Where / qill clause for relationship
4016    *
4017    * @param $values
4018    *
4019    * @return void
4020    */
4021   public function relationship(&$values) {
4022     list($name, $op, $value, $grouping, $wildcard) = $values;
4023     if ($this->_relationshipValuesAdded) {
4024       return;
4025     }
4026     // also get values array for relation_target_name
4027     // for relationship search we always do wildcard
4028     $relationType = $this->getWhereValues('relation_type_id', $grouping);
4029     $targetName = $this->getWhereValues('relation_target_name', $grouping);
4030     $relStatus = $this->getWhereValues('relation_status', $grouping);
4031     $relPermission = $this->getWhereValues('relation_permission', $grouping);
4032     $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
4033
4034     $nameClause = $name = NULL;
4035     if ($targetName) {
4036       $name = trim($targetName[2]);
4037       if (substr($name, 0, 1) == '"' &&
4038         substr($name, -1, 1) == '"'
4039       ) {
4040         $name = substr($name, 1, -1);
4041         $name = strtolower(CRM_Core_DAO::escapeString($name));
4042         $nameClause = "= '$name'";
4043       }
4044       else {
4045         $name = strtolower(CRM_Core_DAO::escapeString($name));
4046         $nameClause = "LIKE '%{$name}%'";
4047       }
4048     }
4049
4050     $rTypeValues = array();
4051     if (!empty($relationType)) {
4052       $rel = explode('_', $relationType[2]);
4053       self::$_relType = $rel[1];
4054       $params = array('id' => $rel[0]);
4055       $rType = CRM_Contact_BAO_RelationshipType::retrieve($params, $rTypeValues);
4056     }
4057     if (!empty($rTypeValues) && $rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
4058       // if we don't know which end of the relationship we are dealing with we'll create a temp table
4059       //@todo unless we are dealing with a target group
4060       self::$_relType = 'reciprocal';
4061     }
4062     // if we are creating a temp table we build our own where for the relationship table
4063     $relationshipTempTable = NULL;
4064     if (self::$_relType == 'reciprocal' && empty($targetGroup)) {
4065       $where = array();
4066       self::$_relationshipTempTable = $relationshipTempTable = CRM_Core_DAO::createTempTableName('civicrm_rel');
4067       if ($nameClause) {
4068         $where[$grouping][] = " sort_name $nameClause ";
4069       }
4070     }
4071     else {
4072       $where = &$this->_where;
4073       if ($nameClause) {
4074         $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
4075       }
4076     }
4077
4078     $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
4079     $relTypeOrg = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
4080     $relTypeHou = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Household');
4081     $allRelationshipType = array();
4082     $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
4083     $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
4084
4085     if ($nameClause || !$targetGroup) {
4086       if (!empty($relationType)) {
4087         $this->_qill[$grouping][] = $allRelationshipType[$relationType[2]] . " $name";
4088       }
4089       else {
4090         $this->_qill[$grouping][] = $name;
4091       }
4092     }
4093
4094     //check to see if the target contact is in specified group
4095     if ($targetGroup) {
4096       //add contacts from static groups
4097       $this->_tables['civicrm_relationship_group_contact'] = $this->_whereTables['civicrm_relationship_group_contact']
4098         = " 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'";
4099       $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN  (" .
4100         implode(",", $targetGroup[2]) . ") ) ";
4101
4102       //add contacts from saved searches
4103       $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b");
4104
4105       //set the group where clause
4106       if ($ssWhere) {
4107         $groupWhere[] = "( " . $ssWhere . " )";
4108       }
4109       $this->_where[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
4110
4111       //Get the names of the target groups for the qill
4112       $groupNames = CRM_Core_PseudoConstant::group();
4113       $qillNames = array();
4114       foreach ($targetGroup[2] as $groupId) {
4115         if (array_key_exists($groupId, $groupNames)) {
4116           $qillNames[] = $groupNames[$groupId];
4117         }
4118       }
4119       if (!empty($relationType)) {
4120         $this->_qill[$grouping][] = $allRelationshipType[$relationType[2]] . " ( " . implode(", ", $qillNames) . " )";
4121       }
4122       else {
4123         $this->_qill[$grouping][] = implode(", ", $qillNames);
4124       }
4125     }
4126
4127     // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
4128     $today = date('Ymd');
4129     //check for active, inactive and all relation status
4130     if ($relStatus[2] == 0) {
4131       $where[$grouping][] = "(
4132 civicrm_relationship.is_active = 1 AND
4133 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
4134 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
4135 )";
4136       $this->_qill[$grouping][] = ts('Relationship - Active and Current');
4137     }
4138     elseif ($relStatus[2] == 1) {
4139       $where[$grouping][] = "(
4140 civicrm_relationship.is_active = 0 OR
4141 civicrm_relationship.end_date < {$today} OR
4142 civicrm_relationship.start_date > {$today}
4143 )";
4144       $this->_qill[$grouping][] = ts('Relationship - Inactive or not Current');
4145     }
4146
4147     $onlyDeleted = 0;
4148     if (in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params)) {
4149       $onlyDeleted = 1;
4150     }
4151     $where[$grouping][] = "(contact_b.is_deleted = {$onlyDeleted})";
4152
4153     //check for permissioned, non-permissioned and all permissioned relations
4154     if ($relPermission[2] == 1) {
4155       $where[$grouping][] = "(
4156 civicrm_relationship.is_permission_a_b = 1
4157 )";
4158       $this->_qill[$grouping][] = ts('Relationship - Permissioned');
4159     }
4160     elseif ($relPermission[2] == 2) {
4161       //non-allowed permission relationship.
4162       $where[$grouping][] = "(
4163 civicrm_relationship.is_permission_a_b = 0
4164 )";
4165       $this->_qill[$grouping][] = ts('Relationship - Non-permissioned');
4166     }
4167
4168     $this->addRelationshipDateClauses($grouping, $where);
4169     if (!empty($relationType) && !empty($rType) && isset($rType->id)) {
4170       $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id;
4171     }
4172     $this->_tables['civicrm_relationship'] = $this->_whereTables['civicrm_relationship'] = 1;
4173     $this->_useDistinct = TRUE;
4174     $this->_relationshipValuesAdded = TRUE;
4175     // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
4176     // join on that,
4177     // @todo creating a temp table could be expanded to group filter
4178     // as even creating a temp table of all relationships is much much more efficient than
4179     // an OR in the join
4180     if ($relationshipTempTable) {
4181       $whereClause = '';
4182       if (!empty($where[$grouping])) {
4183         $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
4184         $whereClause = str_replace('contact_b', 'c', $whereClause);
4185       }
4186       $sql = "
4187         CREATE TEMPORARY TABLE {$relationshipTempTable}
4188           (SELECT contact_id_b as contact_id, civicrm_relationship.id
4189             FROM civicrm_relationship
4190             INNER JOIN  civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
4191             $whereClause )
4192           UNION
4193             (SELECT contact_id_a as contact_id, civicrm_relationship.id
4194             FROM civicrm_relationship
4195             INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
4196             $whereClause )
4197       ";
4198       CRM_Core_DAO::executeQuery($sql);
4199     }
4200
4201   }
4202
4203   /**
4204    * Add start & end date criteria in
4205    * @param string $grouping
4206    * @param array $where
4207    *   = array to add where clauses to, in case you are generating a temp table.
4208    * not the main query.
4209    */
4210   public function addRelationshipDateClauses($grouping, &$where) {
4211     $dateValues = array();
4212     $dateTypes = array(
4213       'start_date',
4214       'end_date',
4215     );
4216
4217     foreach ($dateTypes as $dateField) {
4218       $dateValueLow = $this->getWhereValues('relation_' . $dateField . '_low', $grouping);
4219       $dateValueHigh = $this->getWhereValues('relation_' . $dateField . '_high', $grouping);
4220       if (!empty($dateValueLow)) {
4221         $date = date('Ymd', strtotime($dateValueLow[2]));
4222         $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4223         $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);
4224       }
4225       if (!empty($dateValueHigh)) {
4226         $date = date('Ymd', strtotime($dateValueHigh[2]));
4227         $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4228         $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);
4229       }
4230     }
4231   }
4232
4233   /**
4234    * Default set of return properties.
4235    *
4236    * @param int $mode
4237    *
4238    * @return array
4239    *   derault return properties
4240    */
4241   public static function &defaultReturnProperties($mode = 1) {
4242     if (!isset(self::$_defaultReturnProperties)) {
4243       self::$_defaultReturnProperties = array();
4244     }
4245
4246     if (!isset(self::$_defaultReturnProperties[$mode])) {
4247       // add activity return properties
4248       if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
4249         self::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query::defaultReturnProperties($mode, FALSE);
4250       }
4251       else {
4252         self::$_defaultReturnProperties[$mode] = CRM_Core_Component::defaultReturnProperties($mode, FALSE);
4253       }
4254
4255       if (empty(self::$_defaultReturnProperties[$mode])) {
4256         self::$_defaultReturnProperties[$mode] = array(
4257           'home_URL' => 1,
4258           'image_URL' => 1,
4259           'legal_identifier' => 1,
4260           'external_identifier' => 1,
4261           'contact_type' => 1,
4262           'contact_sub_type' => 1,
4263           'sort_name' => 1,
4264           'display_name' => 1,
4265           'preferred_mail_format' => 1,
4266           'nick_name' => 1,
4267           'first_name' => 1,
4268           'middle_name' => 1,
4269           'last_name' => 1,
4270           'prefix_id' => 1,
4271           'suffix_id' => 1,
4272           'formal_title' => 1,
4273           'communication_style_id' => 1,
4274           'birth_date' => 1,
4275           'gender_id' => 1,
4276           'street_address' => 1,
4277           'supplemental_address_1' => 1,
4278           'supplemental_address_2' => 1,
4279           'city' => 1,
4280           'postal_code' => 1,
4281           'postal_code_suffix' => 1,
4282           'state_province' => 1,
4283           'country' => 1,
4284           'world_region' => 1,
4285           'geo_code_1' => 1,
4286           'geo_code_2' => 1,
4287           'email' => 1,
4288           'on_hold' => 1,
4289           'phone' => 1,
4290           'im' => 1,
4291           'household_name' => 1,
4292           'organization_name' => 1,
4293           'deceased_date' => 1,
4294           'is_deceased' => 1,
4295           'job_title' => 1,
4296           'legal_name' => 1,
4297           'sic_code' => 1,
4298           'current_employer' => 1,
4299           // FIXME: should we use defaultHierReturnProperties() for the below?
4300           'do_not_email' => 1,
4301           'do_not_mail' => 1,
4302           'do_not_sms' => 1,
4303           'do_not_phone' => 1,
4304           'do_not_trade' => 1,
4305           'is_opt_out' => 1,
4306           'contact_is_deleted' => 1,
4307           'preferred_communication_method' => 1,
4308           'preferred_language' => 1,
4309         );
4310       }
4311     }
4312     return self::$_defaultReturnProperties[$mode];
4313   }
4314
4315   /**
4316    * Get primary condition for a sql clause.
4317    *
4318    * @param int $value
4319    *
4320    * @return string|NULL
4321    */
4322   public static function getPrimaryCondition($value) {
4323     if (is_numeric($value)) {
4324       $value = (int ) $value;
4325       return ($value == 1) ? 'is_primary = 1' : 'is_primary = 0';
4326     }
4327     return NULL;
4328   }
4329
4330   /**
4331    * Wrapper for a simple search query.
4332    *
4333    * @param array $params
4334    * @param array $returnProperties
4335    * @param bool $count
4336    *
4337    * @return string
4338    */
4339   public static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4340     $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4341     list($select, $from, $where, $having) = $query->query();
4342
4343     return "$select $from $where $having";
4344   }
4345
4346   /**
4347    * These are stub comments as this function needs more explanation - particularly in terms of how it
4348    * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4349    *
4350    * This function was originally written as a wrapper for the api query but is called from multiple places
4351    * in the core code directly so the name is misleading. This function does not use the searchQuery function
4352    * but it is unclear as to whehter that is historical or there is a reason
4353    *  CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4354    *
4355    * @param array $params
4356    * @param array $returnProperties
4357    * @param null $fields
4358    * @param string $sort
4359    * @param int $offset
4360    * @param int $row_count
4361    * @param bool $smartGroupCache
4362    *   ?? update smart group cache?.
4363    * @param bool $count
4364    *   Return count obnly.
4365    * @param bool $skipPermissions
4366    *   Should permissions be ignored or should the logged in user's permissions be applied.
4367    *
4368    *
4369    * @return array
4370    */
4371   public static function apiQuery(
4372     $params = NULL,
4373     $returnProperties = NULL,
4374     $fields = NULL,
4375     $sort = NULL,
4376     $offset = 0,
4377     $row_count = 25,
4378     $smartGroupCache = TRUE,
4379     $count = FALSE,
4380     $skipPermissions = TRUE
4381   ) {
4382
4383     $query = new CRM_Contact_BAO_Query(
4384       $params, $returnProperties,
4385       NULL, TRUE, FALSE, 1,
4386       $skipPermissions,
4387       TRUE, $smartGroupCache
4388     );
4389
4390     //this should add a check for view deleted if permissions are enabled
4391     if ($skipPermissions) {
4392       $query->_skipDeleteClause = TRUE;
4393     }
4394     $query->generatePermissionClause(FALSE, $count);
4395
4396     // note : this modifies _fromClause and _simpleFromClause
4397     $query->includePseudoFieldsJoin($sort);
4398
4399     list($select, $from, $where, $having) = $query->query($count);
4400
4401     $options = $query->_options;
4402     if (!empty($query->_permissionWhereClause)) {
4403       if (empty($where)) {
4404         $where = "WHERE $query->_permissionWhereClause";
4405       }
4406       else {
4407         $where = "$where AND $query->_permissionWhereClause";
4408       }
4409     }
4410
4411     $sql = "$select $from $where $having";
4412
4413     // add group by
4414     if ($query->_useGroupBy) {
4415       $sql .= ' GROUP BY contact_a.id';
4416     }
4417     if (!empty($sort)) {
4418       $sort = CRM_Utils_Type::escape($sort, 'String');
4419       $sql .= " ORDER BY $sort ";
4420     }
4421     if ($row_count > 0 && $offset >= 0) {
4422       $offset = CRM_Utils_Type::escape($offset, 'Int');
4423       $rowCount = CRM_Utils_Type::escape($row_count, 'Int');
4424       $sql .= " LIMIT $offset, $row_count ";
4425     }
4426
4427     $dao = CRM_Core_DAO::executeQuery($sql);
4428
4429     $values = array();
4430     while ($dao->fetch()) {
4431       if ($count) {
4432         $noRows = $dao->rowCount;
4433         $dao->free();
4434         return array($noRows, NULL);
4435       }
4436       $val = $query->store($dao);
4437       $convertedVals = $query->convertToPseudoNames($dao, TRUE);
4438
4439       if (!empty($convertedVals)) {
4440         $val = array_replace_recursive($val, $convertedVals);
4441       }
4442       $values[$dao->contact_id] = $val;
4443     }
4444     $dao->free();
4445     return array($values, $options);
4446   }
4447
4448   /**
4449    * Create and query the db for an contact search.
4450    *
4451    * @param int $offset
4452    *   The offset for the query.
4453    * @param int $rowCount
4454    *   The number of rows to return.
4455    * @param string $sort
4456    *   The order by string.
4457    * @param bool $count
4458    *   Is this a count only query ?.
4459    * @param bool $includeContactIds
4460    *   Should we include contact ids?.
4461    * @param bool $sortByChar
4462    *   If true returns the distinct array of first characters for search results.
4463    * @param bool $groupContacts
4464    *   If true, return only the contact ids.
4465    * @param bool $returnQuery
4466    *   Should we return the query as a string.
4467    * @param string $additionalWhereClause
4468    *   If the caller wants to further restrict the search (used for components).
4469    * @param null $sortOrder
4470    * @param string $additionalFromClause
4471    *   Should be clause with proper joins, effective to reduce where clause load.
4472    *
4473    * @param bool $skipOrderAndLimit
4474    *
4475    * @return CRM_Core_DAO
4476    */
4477   public function searchQuery(
4478     $offset = 0, $rowCount = 0, $sort = NULL,
4479     $count = FALSE, $includeContactIds = FALSE,
4480     $sortByChar = FALSE, $groupContacts = FALSE,
4481     $returnQuery = FALSE,
4482     $additionalWhereClause = NULL, $sortOrder = NULL,
4483     $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4484   ) {
4485
4486     if ($includeContactIds) {
4487       $this->_includeContactIds = TRUE;
4488       $this->_whereClause = $this->whereClause();
4489     }
4490
4491     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4492
4493     // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4494     // and that contact happens to be deleted, set $onlyDeleted to true
4495     foreach ($this->_params as $values) {
4496       $name = CRM_Utils_Array::value(0, $values);
4497       $op = CRM_Utils_Array::value(1, $values);
4498       $value = CRM_Utils_Array::value(2, $values);
4499       if ($name == 'contact_id' and $op == '=') {
4500         if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4501           $onlyDeleted = TRUE;
4502         }
4503         break;
4504       }
4505     }
4506
4507     // building the query string
4508     $groupBy = NULL;
4509     if (!$count) {
4510       if (isset($this->_groupByComponentClause)) {
4511         $groupBy = $this->_groupByComponentClause;
4512       }
4513       elseif ($this->_useGroupBy) {
4514         $groupBy = ' GROUP BY contact_a.id';
4515       }
4516     }
4517     if ($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY && (!$count)) {
4518       $groupBy = 'GROUP BY civicrm_activity.id ';
4519     }
4520
4521     $order = $orderBy = $limit = '';
4522     if (!$count) {
4523       $config = CRM_Core_Config::singleton();
4524       if ($config->includeOrderByClause ||
4525         isset($this->_distinctComponentClause)
4526       ) {
4527         if ($sort) {
4528           if (is_string($sort)) {
4529             $orderBy = $sort;
4530           }
4531           else {
4532             $orderBy = trim($sort->orderBy());
4533           }
4534           if (!empty($orderBy)) {
4535             // this is special case while searching for
4536             // change log CRM-1718
4537             if (preg_match('/sort_name/i', $orderBy)) {
4538               $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4539             }
4540
4541             $orderBy = CRM_Utils_Type::escape($orderBy, 'String');
4542             $order = " ORDER BY $orderBy";
4543
4544             if ($sortOrder) {
4545               $sortOrder = CRM_Utils_Type::escape($sortOrder, 'String');
4546               $order .= " $sortOrder";
4547             }
4548
4549             // always add contact_a.id to the ORDER clause
4550             // so the order is deterministic
4551             if (strpos('contact_a.id', $order) === FALSE) {
4552               $order .= ", contact_a.id";
4553             }
4554           }
4555         }
4556         elseif ($sortByChar) {
4557           $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4558         }
4559         else {
4560           $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4561         }
4562       }
4563
4564       // hack for order clause
4565       if ($order) {
4566         $fieldStr = trim(str_replace('ORDER BY', '', $order));
4567         $fieldOrder = explode(' ', $fieldStr);
4568         $field = $fieldOrder[0];
4569
4570         if ($field) {
4571           switch ($field) {
4572             case 'city':
4573             case 'postal_code':
4574               $this->_whereTables["civicrm_address"] = 1;
4575               $order = str_replace($field, "civicrm_address.{$field}", $order);
4576               break;
4577
4578             case 'country':
4579             case 'state_province':
4580               $this->_whereTables["civicrm_{$field}"] = 1;
4581               $order = str_replace($field, "civicrm_{$field}.name", $order);
4582               break;
4583
4584             case 'email':
4585               $this->_whereTables["civicrm_email"] = 1;
4586               $order = str_replace($field, "civicrm_email.{$field}", $order);
4587               break;
4588
4589             default:
4590               //CRM-12565 add "`" around $field if it is a pseudo constant
4591               foreach ($this->_pseudoConstantsSelect as $key => $value) {
4592                 if (!empty($value['element']) && $value['element'] == $field) {
4593                   $order = str_replace($field, "`{$field}`", $order);
4594                 }
4595               }
4596           }
4597           $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4598           $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4599         }
4600       }
4601
4602       if ($rowCount > 0 && $offset >= 0) {
4603         $offset = CRM_Utils_Type::escape($offset, 'Int');
4604         $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
4605         $limit = " LIMIT $offset, $rowCount ";
4606       }
4607     }
4608
4609     // CRM-15231
4610     $this->_sort = $sort;
4611
4612     list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts, $onlyDeleted);
4613
4614     if ($additionalWhereClause) {
4615       $where = $where . ' AND ' . $additionalWhereClause;
4616     }
4617
4618     //additional from clause should be w/ proper joins.
4619     if ($additionalFromClause) {
4620       $from .= "\n" . $additionalFromClause;
4621     }
4622
4623     // if we are doing a transform, do it here
4624     // use the $from, $where and $having to get the contact ID
4625     if ($this->_displayRelationshipType) {
4626       $this->filterRelatedContacts($from, $where, $having);
4627     }
4628
4629     if ($skipOrderAndLimit) {
4630       $query = "$select $from $where $having $groupBy";
4631     }
4632     else {
4633       $query = "$select $from $where $having $groupBy $order $limit";
4634     }
4635
4636     if ($returnQuery) {
4637       return $query;
4638     }
4639     if ($count) {
4640       return CRM_Core_DAO::singleValueQuery($query);
4641     }
4642
4643     $dao = CRM_Core_DAO::executeQuery($query);
4644     if ($groupContacts) {
4645       $ids = array();
4646       while ($dao->fetch()) {
4647         $ids[] = $dao->id;
4648       }
4649       return implode(',', $ids);
4650     }
4651
4652     return $dao;
4653   }
4654
4655   /**
4656    * Fetch a list of contacts from the prev/next cache for displaying a search results page
4657    *
4658    * @param string $cacheKey
4659    * @param int $offset
4660    * @param int $rowCount
4661    * @param bool $includeContactIds
4662    * @return CRM_Core_DAO
4663    */
4664   public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4665     $this->_includeContactIds = $includeContactIds;
4666     $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params);
4667     list($select, $from, $where) = $this->query(FALSE, FALSE, FALSE, $onlyDeleted);
4668     $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);
4669     $order = " ORDER BY pnc.id";
4670     $groupBy = " GROUP BY contact_a.id";
4671     $limit = " LIMIT $offset, $rowCount";
4672     $query = "$select $from $where $groupBy $order $limit";
4673
4674     return CRM_Core_DAO::executeQuery($query);
4675   }
4676
4677   /**
4678    * Populate $this->_permissionWhereClause with permission related clause and update other
4679    * query related properties.
4680    *
4681    * Function calls ACL permission class and hooks to filter the query appropriately
4682    *
4683    * Note that these 2 params were in the code when extracted from another function
4684    * and a second round extraction would be to make them properties of the class
4685    *
4686    * @param bool $onlyDeleted
4687    *   Only get deleted contacts.
4688    * @param bool $count
4689    *   Return Count only.
4690    */
4691   public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4692     if (!$this->_skipPermission) {
4693       $this->_permissionWhereClause = CRM_ACL_API::whereClause(
4694         CRM_Core_Permission::VIEW,
4695         $this->_tables,
4696         $this->_whereTables,
4697         NULL,
4698         $onlyDeleted,
4699         $this->_skipDeleteClause
4700       );
4701
4702       // regenerate fromClause since permission might have added tables
4703       if ($this->_permissionWhereClause) {
4704         //fix for row count in qill (in contribute/membership find)
4705         if (!$count) {
4706           $this->_useDistinct = TRUE;
4707         }
4708         //CRM-15231
4709         $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4710         $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode);
4711         // note : this modifies _fromClause and _simpleFromClause
4712         $this->includePseudoFieldsJoin($this->_sort);
4713       }
4714     }
4715     else {
4716       // add delete clause if needed even if we are skipping permission
4717       // CRM-7639
4718       if (!$this->_skipDeleteClause) {
4719         if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) {
4720           $this->_permissionWhereClause = '(contact_a.is_deleted)';
4721         }
4722         else {
4723           // CRM-6181
4724           $this->_permissionWhereClause = '(contact_a.is_deleted = 0)';
4725         }
4726       }
4727     }
4728   }
4729
4730   /**
4731    * @param $val
4732    */
4733   public function setSkipPermission($val) {
4734     $this->_skipPermission = $val;
4735   }
4736
4737   /**
4738    * @param null $context
4739    *
4740    * @return array
4741    */
4742   public function &summaryContribution($context = NULL) {
4743     list($innerselect, $from, $where, $having) = $this->query(TRUE);
4744
4745     // hack $select
4746     $select = "
4747 SELECT COUNT( conts.total_amount ) as total_count,
4748        SUM(   conts.total_amount ) as total_amount,
4749        AVG(   conts.total_amount ) as total_avg,
4750        conts.total_amount          as amount,
4751        conts.currency              as currency";
4752     if ($this->_permissionWhereClause) {
4753       $where .= " AND " . $this->_permissionWhereClause;
4754     }
4755     if ($context == 'search') {
4756       $where .= " AND contact_a.is_deleted = 0 ";
4757     }
4758
4759     // make sure contribution is completed - CRM-4989
4760     $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
4761
4762     $summary = array();
4763     $summary['total'] = array();
4764     $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4765     $innerQuery = "SELECT civicrm_contribution.total_amount, COUNT(civicrm_contribution.total_amount) as civicrm_contribution_total_amount_count,
4766       civicrm_contribution.currency $from $completedWhere";
4767
4768     $query = "$select FROM (
4769       $innerQuery GROUP BY civicrm_contribution.id
4770     ) as conts
4771     GROUP BY currency";
4772
4773     $dao = CRM_Core_DAO::executeQuery($query);
4774
4775     $summary['total']['count'] = 0;
4776     $summary['total']['amount'] = $summary['total']['avg'] = array();
4777     while ($dao->fetch()) {
4778       $summary['total']['count'] += $dao->total_count;
4779       $summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
4780       $summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
4781     }
4782
4783     $orderBy = 'ORDER BY civicrm_contribution_total_amount_count DESC';
4784     $groupBy = 'GROUP BY currency, civicrm_contribution.total_amount';
4785     $modeSQL = "$select, conts.civicrm_contribution_total_amount_count as civicrm_contribution_total_amount_count FROM ($innerQuery
4786     $groupBy $orderBy) as conts
4787     GROUP BY currency";
4788
4789     $summary['total']['mode'] = CRM_Contribute_BAO_Contribution::computeStats('mode', $modeSQL);
4790
4791     $medianSQL = "{$from} {$completedWhere}";
4792     $summary['total']['median'] = CRM_Contribute_BAO_Contribution::computeStats('median', $medianSQL, 'civicrm_contribution');
4793     $summary['total']['currencyCount'] = count($summary['total']['median']);
4794
4795     if (!empty($summary['total']['amount'])) {
4796       $summary['total']['amount'] = implode(',&nbsp;', $summary['total']['amount']);
4797       $summary['total']['avg'] = implode(',&nbsp;', $summary['total']['avg']);
4798       $summary['total']['mode'] = implode(',&nbsp;', $summary['total']['mode']);
4799       $summary['total']['median'] = implode(',&nbsp;', $summary['total']['median']);
4800     }
4801     else {
4802       $summary['total']['amount'] = $summary['total']['avg'] = $summary['total']['median'] = 0;
4803     }
4804
4805     // soft credit summary
4806     if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
4807       $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
4808       $query = "
4809         $select FROM (
4810           SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
4811           GROUP BY civicrm_contribution_soft.id
4812         ) as conts
4813         GROUP BY currency";
4814       $dao = CRM_Core_DAO::executeQuery($query);
4815       $summary['soft_credit']['count'] = 0;
4816       $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
4817       while ($dao->fetch()) {
4818         $summary['soft_credit']['count'] += $dao->total_count;
4819         $summary['soft_credit']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
4820         $summary['soft_credit']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
4821       }
4822       if (!empty($summary['soft_credit']['amount'])) {
4823         $summary['soft_credit']['amount'] = implode(',&nbsp;', $summary['soft_credit']['amount']);
4824         $summary['soft_credit']['avg'] = implode(',&nbsp;', $summary['soft_credit']['avg']);
4825       }
4826       else {
4827         $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
4828       }
4829     }
4830
4831     // hack $select
4832     //@todo  - this could be one query using the IF in mysql - eg
4833     //  SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
4834     //   SELECT civicrm_contribution.total_amount, civicrm_contribution.currency  ,
4835     //  IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
4836     //  IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
4837     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
4838     //  IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
4839     // FROM civicrm_contact contact_a
4840     //  LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
4841     // WHERE  ( ... where clause....
4842     // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
4843     //  ) as conts
4844
4845     $select = "
4846 SELECT COUNT( conts.total_amount ) as cancel_count,
4847        SUM(   conts.total_amount ) as cancel_amount,
4848        AVG(   conts.total_amount ) as cancel_avg,
4849        conts.currency              as currency";
4850
4851     $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4852     if ($context == 'search') {
4853       $where .= " AND contact_a.is_deleted = 0 ";
4854     }
4855
4856     $query = "$select FROM (
4857       SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
4858       GROUP BY civicrm_contribution.id
4859     ) as conts
4860     GROUP BY currency";
4861
4862     $dao = CRM_Core_DAO::executeQuery($query);
4863
4864     if ($dao->N <= 1) {
4865       if ($dao->fetch()) {
4866         $summary['cancel']['count'] = $dao->cancel_count;
4867         $summary['cancel']['amount'] = $dao->cancel_amount;
4868         $summary['cancel']['avg'] = $dao->cancel_avg;
4869       }
4870     }
4871     else {
4872       $summary['cancel']['count'] = 0;
4873       $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4874       while ($dao->fetch()) {
4875         $summary['cancel']['count'] += $dao->cancel_count;
4876         $summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
4877         $summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
4878       }
4879       $summary['cancel']['amount'] = implode(',&nbsp;', $summary['cancel']['amount']);
4880       $summary['cancel']['avg'] = implode(',&nbsp;', $summary['cancel']['avg']);
4881     }
4882
4883     return $summary;
4884   }
4885
4886   /**
4887    * Getter for the qill object.
4888    *
4889    * @return string
4890    */
4891   public function qill() {
4892     return $this->_qill;
4893   }
4894
4895   /**
4896    * Default set of return default hier return properties.
4897    *
4898    * @return array
4899    */
4900   public static function &defaultHierReturnProperties() {
4901     if (!isset(self::$_defaultHierReturnProperties)) {
4902       self::$_defaultHierReturnProperties = array(
4903         'home_URL' => 1,
4904         'image_URL' => 1,
4905         'legal_identifier' => 1,
4906         'external_identifier' => 1,
4907         'contact_type' => 1,
4908         'contact_sub_type' => 1,
4909         'sort_name' => 1,
4910         'display_name' => 1,
4911         'nick_name' => 1,
4912         'first_name' => 1,
4913         'middle_name' => 1,
4914         'last_name' => 1,
4915         'prefix_id' => 1,
4916         'suffix_id' => 1,
4917         'formal_title' => 1,
4918         'communication_style_id' => 1,
4919         'email_greeting' => 1,
4920         'postal_greeting' => 1,
4921         'addressee' => 1,
4922         'birth_date' => 1,
4923         'gender_id' => 1,
4924         'preferred_communication_method' => 1,
4925         'do_not_phone' => 1,
4926         'do_not_email' => 1,
4927         'do_not_mail' => 1,
4928         'do_not_sms' => 1,
4929         'do_not_trade' => 1,
4930         'location' => array(
4931           '1' => array(
4932             'location_type' => 1,
4933             'street_address' => 1,
4934             'city' => 1,
4935             'state_province' => 1,
4936             'postal_code' => 1,
4937             'postal_code_suffix' => 1,
4938             'country' => 1,
4939             'phone-Phone' => 1,
4940             'phone-Mobile' => 1,
4941             'phone-Fax' => 1,
4942             'phone-1' => 1,
4943             'phone-2' => 1,
4944             'phone-3' => 1,
4945             'im-1' => 1,
4946             'im-2' => 1,
4947             'im-3' => 1,
4948             'email-1' => 1,
4949             'email-2' => 1,
4950             'email-3' => 1,
4951           ),
4952           '2' => array(
4953             'location_type' => 1,
4954             'street_address' => 1,
4955             'city' => 1,
4956             'state_province' => 1,
4957             'postal_code' => 1,
4958             'postal_code_suffix' => 1,
4959             'country' => 1,
4960             'phone-Phone' => 1,
4961             'phone-Mobile' => 1,
4962             'phone-1' => 1,
4963             'phone-2' => 1,
4964             'phone-3' => 1,
4965             'im-1' => 1,
4966             'im-2' => 1,
4967             'im-3' => 1,
4968             'email-1' => 1,
4969             'email-2' => 1,
4970             'email-3' => 1,
4971           ),
4972         ),
4973       );
4974     }
4975     return self::$_defaultHierReturnProperties;
4976   }
4977
4978   /**
4979    * @param $values
4980    * @param string $tableName
4981    * @param string $fieldName
4982    * @param string $dbFieldName
4983    * @param $fieldTitle
4984    * @param bool $appendTimeStamp
4985    */
4986   public function dateQueryBuilder(
4987     &$values, $tableName, $fieldName,
4988     $dbFieldName, $fieldTitle,
4989     $appendTimeStamp = TRUE
4990   ) {
4991     list($name, $op, $value, $grouping, $wildcard) = $values;
4992
4993     if ($name == "{$fieldName}_low" ||
4994       $name == "{$fieldName}_high"
4995     ) {
4996       if (isset($this->_rangeCache[$fieldName]) || !$value) {
4997         return;
4998       }
4999       $this->_rangeCache[$fieldName] = 1;
5000
5001       $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
5002
5003       if ($name == $fieldName . '_low') {
5004         $firstOP = '>=';
5005         $firstPhrase = ts('greater than or equal to');
5006         $firstDate = CRM_Utils_Date::processDate($value);
5007
5008         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5009         if (!empty($secondValues) && $secondValues[2]) {
5010           $secondOP = '<=';
5011           $secondPhrase = ts('less than or equal to');
5012           $secondValue = $secondValues[2];
5013
5014           if ($appendTimeStamp && strlen($secondValue) == 10) {
5015             $secondValue .= ' 23:59:59';
5016           }
5017           $secondDate = CRM_Utils_Date::processDate($secondValue);
5018         }
5019       }
5020       elseif ($name == $fieldName . '_high') {
5021         $firstOP = '<=';
5022         $firstPhrase = ts('less than or equal to');
5023
5024         if ($appendTimeStamp && strlen($value) == 10) {
5025           $value .= ' 23:59:59';
5026         }
5027         $firstDate = CRM_Utils_Date::processDate($value);
5028
5029         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5030         if (!empty($secondValues) && $secondValues[2]) {
5031           $secondOP = '>=';
5032           $secondPhrase = ts('greater than or equal to');
5033           $secondValue = $secondValues[2];
5034           $secondDate = CRM_Utils_Date::processDate($secondValue);
5035         }
5036       }
5037
5038       if (!$appendTimeStamp) {
5039         $firstDate = substr($firstDate, 0, 8);
5040       }
5041       $firstDateFormat = CRM_Utils_Date::customFormat($firstDate);
5042
5043       if ($secondDate) {
5044         if (!$appendTimeStamp) {
5045           $secondDate = substr($secondDate, 0, 8);
5046         }
5047         $secondDateFormat = CRM_Utils_Date::customFormat($secondDate);
5048       }
5049
5050       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5051       if ($secondDate) {
5052         $this->_where[$grouping][] = "
5053 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5054 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5055 ";
5056         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
5057       }
5058       else {
5059         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5060         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
5061       }
5062     }
5063
5064     if ($name == $fieldName) {
5065       //In Get API, for operators other then '=' the $value is in array(op => value) format
5066       if (is_array($value) && !empty($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5067         $op = key($value);
5068         $value = $value[$op];
5069       }
5070
5071       $date = $format = NULL;
5072       if (strstr($op, 'IN')) {
5073         $format = array();
5074         foreach ($value as &$date) {
5075           $date = CRM_Utils_Date::processDate($date);
5076           if (!$appendTimeStamp) {
5077             $date = substr($date, 0, 8);
5078           }
5079           $format[] = CRM_Utils_Date::customFormat($date);
5080         }
5081         $date = "('" . implode("','", $value) . "')";
5082         $format = implode(', ', $format);
5083       }
5084       elseif ($value && (!strstr($op, 'NULL') && !strstr($op, 'EMPTY'))) {
5085         $date = CRM_Utils_Date::processDate($value);
5086         if (!$appendTimeStamp) {
5087           $date = substr($date, 0, 8);
5088         }
5089         $format = CRM_Utils_Date::customFormat($date);
5090         $date = "'$date'";
5091       }
5092
5093       if ($date) {
5094         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op $date";
5095       }
5096       else {
5097         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op";
5098       }
5099
5100       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5101
5102       $op = CRM_Utils_Array::value($op, CRM_Core_SelectValues::getSearchBuilderOperators(), $op);
5103       $this->_qill[$grouping][] = "$fieldTitle $op $format";
5104     }
5105   }
5106
5107   /**
5108    * @param $values
5109    * @param string $tableName
5110    * @param string $fieldName
5111    * @param string $dbFieldName
5112    * @param $fieldTitle
5113    * @param null $options
5114    */
5115   public function numberRangeBuilder(
5116     &$values,
5117     $tableName, $fieldName,
5118     $dbFieldName, $fieldTitle,
5119     $options = NULL
5120   ) {
5121     list($name, $op, $value, $grouping, $wildcard) = $values;
5122
5123     if ($name == "{$fieldName}_low" ||
5124       $name == "{$fieldName}_high"
5125     ) {
5126       if (isset($this->_rangeCache[$fieldName])) {
5127         return;
5128       }
5129       $this->_rangeCache[$fieldName] = 1;
5130
5131       $secondOP = $secondPhrase = $secondValue = NULL;
5132
5133       if ($name == "{$fieldName}_low") {
5134         $firstOP = '>=';
5135         $firstPhrase = ts('greater than');
5136
5137         $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5138         if (!empty($secondValues)) {
5139           $secondOP = '<=';
5140           $secondPhrase = ts('less than');
5141           $secondValue = $secondValues[2];
5142         }
5143       }
5144       else {
5145         $firstOP = '<=';
5146         $firstPhrase = ts('less than');
5147
5148         $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5149         if (!empty($secondValues)) {
5150           $secondOP = '>=';
5151           $secondPhrase = ts('greater than');
5152           $secondValue = $secondValues[2];
5153         }
5154       }
5155
5156       if ($secondOP) {
5157         $this->_where[$grouping][] = "
5158 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
5159 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
5160 ";
5161         $displayValue = $options ? $options[$value] : $value;
5162         $secondDisplayValue = $options ? $options[$secondValue] : $secondValue;
5163
5164         $this->_qill[$grouping][]
5165           = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5166       }
5167       else {
5168         $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
5169         $displayValue = $options ? $options[$value] : $value;
5170         $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5171       }
5172       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5173
5174       return;
5175     }
5176
5177     if ($name == $fieldName) {
5178       $op = '=';
5179       $phrase = '=';
5180
5181       $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
5182
5183       $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1;
5184       $displayValue = $options ? $options[$value] : $value;
5185       $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
5186     }
5187   }
5188
5189   /**
5190    * Given the field name, operator, value & its data type
5191    * builds the where Clause for the query
5192    * used for handling 'IS NULL'/'IS NOT NULL' operators
5193    *
5194    * @param string $field
5195    *   Fieldname.
5196    * @param string $op
5197    *   Operator.
5198    * @param string $value
5199    *   Value.
5200    * @param string $dataType
5201    *   Data type of the field.
5202    *
5203    * @return string
5204    *   Where clause for the query.
5205    */
5206   public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
5207     $op = trim($op);
5208     $clause = "$field $op";
5209
5210     switch ($op) {
5211       case 'IS NULL':
5212       case 'IS NOT NULL':
5213         return $clause;
5214
5215       case 'IS EMPTY':
5216         $clause = " (NULLIF($field, '') IS NULL) ";
5217         return $clause;
5218
5219       case 'IS NOT EMPTY':
5220         $clause = " (NULLIF($field, '') IS NOT NULL) ";
5221         return $clause;
5222
5223       default:
5224         if (empty($dataType)) {
5225           $dataType = 'String';
5226         }
5227         if (is_array($value)) {
5228           //this could have come from the api - as in the restWhere section we potentially use the api operator syntax which is becoming more
5229           // widely used and consistent across the codebase
5230           // adding this here won't accept the search functions which don't submit an array
5231           if (($queryString = CRM_Core_DAO::createSqlFilter($field, $value, $dataType)) != FALSE) {
5232             return $queryString;
5233           }
5234         }
5235         $value = CRM_Utils_Type::escape($value, $dataType);
5236         // if we don't have a dataType we should assume
5237         if ($dataType == 'String' || $dataType == 'Text') {
5238           $value = "'" . strtolower($value) . "'";
5239         }
5240         return "$clause $value";
5241     }
5242   }
5243
5244   /**
5245    * @param bool $reset
5246    *
5247    * @return array
5248    */
5249   public function openedSearchPanes($reset = FALSE) {
5250     if (!$reset || empty($this->_whereTables)) {
5251       return self::$_openedPanes;
5252     }
5253
5254     // pane name to table mapper
5255     $panesMapper = array(
5256       ts('Contributions') => 'civicrm_contribution',
5257       ts('Memberships') => 'civicrm_membership',
5258       ts('Events') => 'civicrm_participant',
5259       ts('Relationships') => 'civicrm_relationship',
5260       ts('Activities') => 'civicrm_activity',
5261       ts('Pledges') => 'civicrm_pledge',
5262       ts('Cases') => 'civicrm_case',
5263       ts('Grants') => 'civicrm_grant',
5264       ts('Address Fields') => 'civicrm_address',
5265       ts('Notes') => 'civicrm_note',
5266       ts('Change Log') => 'civicrm_log',
5267       ts('Mailings') => 'civicrm_mailing_event_queue',
5268     );
5269     CRM_Contact_BAO_Query_Hook::singleton()->getPanesMapper($panesMapper);
5270
5271     foreach (array_keys($this->_whereTables) as $table) {
5272       if ($panName = array_search($table, $panesMapper)) {
5273         self::$_openedPanes[$panName] = TRUE;
5274       }
5275     }
5276
5277     return self::$_openedPanes;
5278   }
5279
5280   /**
5281    * @param $operator
5282    */
5283   public function setOperator($operator) {
5284     $validOperators = array('AND', 'OR');
5285     if (!in_array($operator, $validOperators)) {
5286       $operator = 'AND';
5287     }
5288     $this->_operator = $operator;
5289   }
5290
5291   /**
5292    * @return string
5293    */
5294   public function getOperator() {
5295     return $this->_operator;
5296   }
5297
5298   /**
5299    * @param $from
5300    * @param $where
5301    * @param $having
5302    */
5303   public function filterRelatedContacts(&$from, &$where, &$having) {
5304     static $_rTypeProcessed = NULL;
5305     static $_rTypeFrom = NULL;
5306     static $_rTypeWhere = NULL;
5307
5308     if (!$_rTypeProcessed) {
5309       $_rTypeProcessed = TRUE;
5310
5311       // create temp table with contact ids
5312       $tableName = CRM_Core_DAO::createTempTableName('civicrm_transform', TRUE);
5313       $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5314       CRM_Core_DAO::executeQuery($sql);
5315
5316       $sql = "
5317 REPLACE INTO $tableName ( contact_id )
5318 SELECT contact_a.id
5319        $from
5320        $where
5321        $having
5322 ";
5323       CRM_Core_DAO::executeQuery($sql);
5324
5325       $qillMessage = ts('Contacts with a Relationship Type of: ');
5326       $rTypes = CRM_Core_PseudoConstant::relationshipType();
5327
5328       if (is_numeric($this->_displayRelationshipType)) {
5329         $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType]['label_a_b'];
5330         $_rTypeFrom = "
5331 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5332 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5333 ";
5334         $_rTypeWhere = "
5335 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5336 AND   displayRelType.is_active = 1
5337 ";
5338       }
5339       else {
5340         list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType);
5341         if ($dirOne == 'a') {
5342           $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5343           $_rTypeFrom .= "
5344 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5345 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5346 ";
5347         }
5348         else {
5349           $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5350           $_rTypeFrom .= "
5351 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5352 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5353 ";
5354         }
5355         $_rTypeWhere = "
5356 WHERE displayRelType.relationship_type_id = $relType
5357 AND   displayRelType.is_active = 1
5358 ";
5359       }
5360       $this->_qill[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
5361     }
5362
5363     if (!empty($this->_permissionWhereClause)) {
5364       $_rTypeWhere .= "AND $this->_permissionWhereClause";
5365     }
5366
5367     if (strpos($from, $_rTypeFrom) === FALSE) {
5368       // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5369       // this happens when we have an event_type in the quert (CRM-7969)
5370       $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5371       $from .= $_rTypeFrom;
5372       $where = $_rTypeWhere;
5373     }
5374
5375     $having = NULL;
5376   }
5377
5378   /**
5379    * @param $op
5380    *
5381    * @return bool
5382    */
5383   public static function caseImportant($op) {
5384     return
5385       in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE;
5386   }
5387
5388   /**
5389    * @param $returnProperties
5390    * @param $prefix
5391    *
5392    * @return bool
5393    */
5394   public static function componentPresent(&$returnProperties, $prefix) {
5395     foreach ($returnProperties as $name => $dontCare) {
5396       if (substr($name, 0, strlen($prefix)) == $prefix) {
5397         return TRUE;
5398       }
5399     }
5400     return FALSE;
5401   }
5402
5403   /**
5404    * Builds the necessary structures for all fields that are similar to option value lookups.
5405    *
5406    * @param string $name
5407    *   the name of the field.
5408    * @param string $op
5409    *   the sql operator, this function should handle ALL SQL operators.
5410    * @param string $value
5411    *   depends on the operator and who's calling the query builder.
5412    * @param int $grouping
5413    *   the index where to place the where clause.
5414    * @param $selectValues
5415    *   The key value pairs for this element. This allows us to use this function for things besides option-value pairs.
5416    * @param array $field
5417    *   an array that contains various properties of the field identified by $name.
5418    * @param string $label
5419    *   The label for this field element.
5420    * @param string $dataType
5421    *   The data type for this element.
5422    * @param bool $useIDsOnly
5423    *
5424    * @return void
5425    *   adds the where clause and qill to the query object
5426    */
5427   public function optionValueQuery(
5428     $name,
5429     $op,
5430     $value,
5431     $grouping,
5432     $selectValues,
5433     $field,
5434     $label,
5435     $dataType = 'String',
5436     $useIDsOnly = FALSE
5437   ) {
5438
5439     if (!empty($selectValues) && !is_array($value) && !empty($selectValues[$value])) {
5440       $qill = $selectValues[$value];
5441     }
5442     else {
5443       $qill = $value;
5444     }
5445
5446     $pseudoFields = array(
5447       'email_greeting',
5448       'postal_greeting',
5449       'addressee',
5450       'gender_id',
5451       'prefix_id',
5452       'suffix_id',
5453       'communication_style_id',
5454     );
5455
5456     if (is_numeric($value)) {
5457       $qill = $selectValues[(int ) $value];
5458     }
5459     elseif ($op == 'IN' || $op == 'NOT IN') {
5460       if (is_array($value)) {
5461         $intVals = array();
5462         $newValues = array();
5463         foreach ($value as $k => $v) {
5464           $intVals[$k] = (int) $k;
5465           $newValues[] = $selectValues[(int) $k];
5466         }
5467
5468         $value = (in_array($name, $pseudoFields)) ? $intVals : $newValues;
5469         $qill = implode(', ', $newValues);
5470       }
5471     }
5472     elseif (!array_key_exists($value, $selectValues)) {
5473       // its a string, lets get the int value
5474       $value = array_search($value, $selectValues);
5475     }
5476     if ($useIDsOnly) {
5477       list($tableName, $fieldName) = explode('.', $field['where'], 2);
5478       if ($tableName == 'civicrm_contact') {
5479         $wc = "contact_a.$fieldName";
5480       }
5481       else {
5482         $wc = "$tableName.id";
5483       }
5484     }
5485     else {
5486       $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}";
5487     }
5488
5489     if (in_array($name, $pseudoFields)) {
5490       if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5491         $wc = "contact_a.{$name}_id";
5492       }
5493       $dataType = 'Positive';
5494       $value = (!$value) ? 0 : $value;
5495     }
5496
5497     $this->_qill[$grouping][] = $label . " $op '$qill'";
5498     $op = (in_array($name, $pseudoFields) && ($op == 'LIKE' || $op == 'RLIKE')) ? '=' : $op;
5499     $this->_where[$grouping][] = self::buildClause($wc, $op, $value, $dataType);
5500   }
5501
5502   /**
5503    * Check and explode a user defined numeric string into an array
5504    * this was the protocol used by search builder in the old old days before we had
5505    * super nice js widgets to do the hard work
5506    *
5507    * @param string $string
5508    * @param string $dataType
5509    *   The dataType we should check for the values, default integer.
5510    *
5511    * @return bool|array
5512    *   false if string does not match the pattern
5513    *   array of numeric values if string does match the pattern
5514    */
5515   public static function parseSearchBuilderString($string, $dataType = 'Integer') {
5516     $string = trim($string);
5517     if (substr($string, 0, 1) != '(' || substr($string, -1, 1) != ')') {
5518       Return FALSE;
5519     }
5520
5521     $string = substr($string, 1, -1);
5522     $values = explode(',', $string);
5523     if (empty($values)) {
5524       return FALSE;
5525     }
5526
5527     $returnValues = array();
5528     foreach ($values as $v) {
5529       if ($dataType == 'Integer' && !is_numeric($v)) {
5530         return FALSE;
5531       }
5532       elseif ($dataType == 'String' && !is_string($v)) {
5533         return FALSE;
5534       }
5535       $returnValues[] = trim($v);
5536     }
5537
5538     if (empty($returnValues)) {
5539       return FALSE;
5540     }
5541
5542     return $returnValues;
5543   }
5544
5545   /**
5546    * Convert the pseudo constants id's to their names
5547    *
5548    * @param CRM_Core_DAO $dao
5549    * @param bool $return
5550    *
5551    * @return array|NULL
5552    */
5553   public function convertToPseudoNames(&$dao, $return = FALSE) {
5554     if (empty($this->_pseudoConstantsSelect)) {
5555       return NULL;
5556     }
5557     $values = array();
5558     foreach ($this->_pseudoConstantsSelect as $key => $value) {
5559       if (!empty($this->_pseudoConstantsSelect[$key]['sorting'])) {
5560         continue;
5561       }
5562
5563       if (property_exists($dao, $value['idCol'])) {
5564         $val = $dao->$value['idCol'];
5565
5566         if (CRM_Utils_System::isNull($val)) {
5567           $dao->$key = NULL;
5568         }
5569         elseif ($baoName = CRM_Utils_Array::value('bao', $value, NULL)) {
5570           //preserve id value
5571           $idColumn = "{$key}_id";
5572           $dao->$idColumn = $val;
5573
5574           if ($key == 'state_province_name') {
5575             $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
5576           }
5577           else {
5578             $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant::getLabel($baoName, $value['pseudoField'], $val);
5579           }
5580         }
5581         elseif ($value['pseudoField'] == 'state_province_abbreviation') {
5582           $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val);
5583         }
5584         // FIX ME: we should potentially move this to component Query and write a wrapper function that
5585         // handles pseudoconstant fixes for all component
5586         elseif (in_array($value['pseudoField'], array('participant_status', 'participant_role'))) {
5587           $pseudoOptions = $viewValues = array();
5588           $pseudoOptions = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', $value['idCol']);
5589           foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $val) as $k => $v) {
5590             $viewValues[] = $pseudoOptions[$v];
5591           }
5592           $dao->$key = implode(', ', $viewValues);
5593         }
5594         else {
5595           $labels = CRM_Core_OptionGroup::values($value['pseudoField']);
5596           $dao->$key = $labels[$val];
5597         }
5598
5599         // return converted values in array format
5600         if ($return) {
5601           if (strpos($key, '-') !== FALSE) {
5602             $keyVal = explode('-', $key);
5603             $current = &$values;
5604             $lastElement = array_pop($keyVal);
5605             foreach ($keyVal as $v) {
5606               if (!array_key_exists($v, $current)) {
5607                 $current[$v] = array();
5608               }
5609               $current = &$current[$v];
5610             }
5611             $current[$lastElement] = $dao->$key;
5612           }
5613           else {
5614             $values[$key] = $dao->$key;
5615           }
5616         }
5617       }
5618     }
5619     return $values;
5620   }
5621
5622   /**
5623    * Include pseudo fields LEFT JOIN.
5624    * @param string|array $sort can be a object or string
5625    *
5626    * @return array|NULL
5627    */
5628   public function includePseudoFieldsJoin($sort) {
5629     if (!$sort || empty($this->_pseudoConstantsSelect)) {
5630       return NULL;
5631     }
5632     $sort = is_string($sort) ? $sort : $sort->orderBy();
5633     $present = array();
5634
5635     foreach ($this->_pseudoConstantsSelect as $name => $value) {
5636       if (!empty($value['table'])) {
5637         $regex = "/({$value['table']}\.|{$name})/";
5638         if (preg_match($regex, $sort)) {
5639           $this->_elemnt[$value['element']] = 1;
5640           $this->_select[$value['element']] = $value['select'];
5641           $this->_pseudoConstantsSelect[$name]['sorting'] = 1;
5642           $present[$value['table']] = $value['join'];
5643         }
5644       }
5645     }
5646     $presentSimpleFrom = $present;
5647
5648     if (array_key_exists('civicrm_worldregion', $this->_whereTables) &&
5649       array_key_exists('civicrm_country', $presentSimpleFrom)
5650     ) {
5651       unset($presentSimpleFrom['civicrm_country']);
5652     }
5653     if (array_key_exists('civicrm_worldregion', $this->_tables) &&
5654       array_key_exists('civicrm_country', $present)
5655     ) {
5656       unset($present['civicrm_country']);
5657     }
5658
5659     $presentClause = $presentSimpleFromClause = NULL;
5660     if (!empty($present)) {
5661       $presentClause = implode(' ', $present);
5662     }
5663     if (!empty($presentSimpleFrom)) {
5664       $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
5665     }
5666
5667     $this->_fromClause = $this->_fromClause . $presentClause;
5668     $this->_simpleFromClause = $this->_simpleFromClause . $presentSimpleFromClause;
5669
5670     return array($presentClause, $presentSimpleFromClause);
5671   }
5672
5673   /**
5674    * Build qill for field.
5675    *
5676    * Qill refers to the query detail visible on the UI.
5677    *
5678    * @param $daoName
5679    * @param $fieldName
5680    * @param $fieldValue
5681    * @param $op
5682    * @param array $pseduoExtraParam
5683    *
5684    * @return array
5685    */
5686   public static function buildQillForFieldValue($daoName = NULL, $fieldName, $fieldValue, $op, $pseduoExtraParam = array()) {
5687     $qillOperators = CRM_Core_SelectValues::getSearchBuilderOperators();
5688
5689     if ($fieldName == 'activity_type_id') {
5690       $pseduoOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
5691     }
5692     elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
5693       $pseduoOptions = CRM_Event_BAO_Event::getEvents(0, $fieldValue, TRUE, TRUE, TRUE);
5694     }
5695     elseif ($fieldName == 'contribution_product_id') {
5696       $pseduoOptions = CRM_Contribute_PseudoConstant::products();
5697     }
5698     elseif ($daoName) {
5699       $pseduoOptions = CRM_Core_PseudoConstant::get($daoName, $fieldName, $pseduoExtraParam = array());
5700     }
5701
5702     //API usually have fieldValue format as array(operator => array(values)),
5703     //so we need to separate operator out of fieldValue param
5704     if (is_array($fieldValue) && in_array(key($fieldValue), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
5705       $op = key($fieldValue);
5706       $fieldValue = $fieldValue[$op];
5707     }
5708
5709     if (is_array($fieldValue)) {
5710       $qillString = array();
5711       if (!empty($pseduoOptions)) {
5712         foreach ((array) $fieldValue as $val) {
5713           $qillString[] = $pseduoOptions[$val];
5714         }
5715         $fieldValue = implode(', ', $qillString);
5716       }
5717       else {
5718         $fieldValue = implode(', ', $fieldValue);
5719       }
5720     }
5721     elseif (!empty($pseduoOptions) && array_key_exists($fieldValue, $pseduoOptions)) {
5722       $fieldValue = $pseduoOptions[$fieldValue];
5723     }
5724
5725     return array(CRM_Utils_Array::value($op, $qillOperators, $op), $fieldValue);
5726   }
5727
5728 }