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