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