CRM/Contact/BAO/Query.php

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