api/v3/Contact.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.4                                                |
   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  * new version of civicrm apis. See blog post at
  30  * http://civicrm.org/node/131
  31  * @todo Write sth
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Contact
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * $Id: Contact.php 30879 2010-11-22 15:45:55Z shot $
  37  *
  38  */
  39
  40 /**
  41  * Create or update a contact (note you should always call this via civicrm_api() & never directly)
  42  *
  43  * @param  array   $params   input parameters
  44  *
  45  * Allowed @params array keys are:
  46  * {@getfields contact_create}
  47  *
  48  *
  49  * @example ContactCreate.php Example of Create Call
  50  *
  51  * @return array  API Result Array
  52  *
  53  * @static void
  54  * @access public
  55  */
  56 function civicrm_api3_contact_create($params) {
  57
  58   $contactID = CRM_Utils_Array::value('contact_id', $params, CRM_Utils_Array::value('id', $params));
  59   $dupeCheck = CRM_Utils_Array::value('dupe_check', $params, FALSE);
  60   $values = _civicrm_api3_contact_check_params($params, $dupeCheck);
  61   if ($values) {
  62     return $values;
  63   }
  64
  65   if (!$contactID) {
  66     // If we get here, we're ready to create a new contact
  67     if (($email = CRM_Utils_Array::value('email', $params)) && !is_array($params['email'])) {
  68       $defLocType = CRM_Core_BAO_LocationType::getDefault();
  69       $params['email'] = array(
  70         1 => array('email' => $email,
  71           'is_primary' => 1,
  72           'location_type_id' => ($defLocType->id) ? $defLocType->id : 1,
  73         ),
  74       );
  75     }
  76   }
  77
  78   if (!empty($params['home_url'])) {
  79     $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id');
  80     $params['website'] = array(1 => array('website_type_id' => key($websiteTypes),
  81         'url' => $params['home_url'],
  82       ),
  83     );
  84   }
  85
  86   _civicrm_api3_greeting_format_params($params);
  87
  88   $values = array();
  89
  90   if (empty($params['contact_type']) && $contactID) {
  91     $params['contact_type'] = CRM_Contact_BAO_Contact::getContactType($contactID);
  92   }
  93
  94   if (!isset($params['contact_sub_type']) && $contactID) {
  95     $params['contact_sub_type'] = CRM_Contact_BAO_Contact::getContactSubType($contactID);
  96   }
  97
  98   _civicrm_api3_custom_format_params($params, $values, $params['contact_type'], $contactID);
  99
 100   $params = array_merge($params, $values);
 101   //@todo we should just call basic_create here - but need to make contact:create accept 'id' on the bao
 102   $contact = _civicrm_api3_contact_update($params, $contactID);
 103
 104   if (is_a($contact, 'CRM_Core_Error')) {
 105     throw new API_Exception($contact->_errors[0]['message']);
 106   }
 107   else {
 108     $values = array();
 109     _civicrm_api3_object_to_array_unique_fields($contact, $values[$contact->id]);
 110   }
 111
 112   return civicrm_api3_create_success($values, $params, 'Contact', 'create');
 113 }
 114
 115 /**
 116  * Adjust Metadata for Create action
 117  *
 118  * @param array $params array or parameters determined by getfields
 119  */
 120 function _civicrm_api3_contact_create_spec(&$params) {
 121   $params['contact_type']['api.required'] = 1;
 122   $params['id']['api.aliases'] = array('contact_id');
 123   $params['current_employer'] = array(
 124     'title' => 'Current Employer',
 125     'description' => 'Name of Current Employer',
 126     'type' => CRM_Utils_Type::T_STRING,
 127   );
 128   $params['dupe_check'] = array(
 129     'title' => 'Check for Duplicates',
 130     'description' => 'Throw error if contact create matches dedupe rule',
 131   );
 132   $params['prefix_id']['api.aliases'] = array('individual_prefix', 'individual_prefix_id');
 133   $params['suffix_id']['api.aliases'] = array('individual_suffix', 'individual_suffix_id');
 134 }
 135
 136 /**
 137  * Retrieve one or more contacts, given a set of search params
 138  *
 139  * @param  array  input parameters
 140  *
 141  * @return array API Result Array
 142  * (@getfields contact_get}
 143  * @static void
 144  * @access public
 145  *
 146  * @example ContactGet.php Standard GET example
 147  *
 148  */
 149 function civicrm_api3_contact_get($params) {
 150   $options = array();
 151   _civicrm_api3_contact_get_supportanomalies($params, $options);
 152   $contacts = _civicrm_api3_get_using_query_object('contact', $params, $options);
 153   return civicrm_api3_create_success($contacts, $params, 'contact');
 154 }
 155
 156 function civicrm_api3_contact_getcount($params) {
 157   $options = array();
 158   _civicrm_api3_contact_get_supportanomalies($params, $options);
 159   $count = _civicrm_api3_get_using_query_object('contact', $params, $options,1);
 160   return (int) $count;
 161 }
 162
 163 /**
 164  * Adjust Metadata for Get action
 165  *
 166  * @param array $params array or parameters determined by getfields
 167  */
 168 function _civicrm_api3_contact_get_spec(&$params) {
 169   $params['contact_is_deleted']['api.default'] = 0;
 170
 171   //we declare all these pseudofields as there are other undocumented fields accessible
 172   // via the api - but if check permissions is set we only allow declared fields
 173   $params['address_id']['title'] = 'Primary Address ID';
 174   $params['street_address']['title'] = 'Primary Address Street Address';
 175   $params['supplemental_address_1']['title'] = 'Primary Address Supplemental Address 1';
 176   $params['supplemental_address_2']['title'] = 'Primary Address Supplemental Address 2';
 177   $params['current_employer']['title'] = 'Current Employer';
 178   $params['city']['title'] = 'Primary Address City';
 179   $params['postal_code_suffix']['title'] = 'Primary Address Post Code Suffix';
 180   $params['postal_code']['title'] = 'Primary Address Post Code';
 181   $params['geo_code_1']['title'] = 'Primary Address Latitude';
 182   $params['geo_code_2']['title'] = 'Primary Address Longitude';
 183   $params['state_province_id']['title'] = 'Primary Address State Province ID';
 184   $params['state_province_name']['title'] = 'Primary Address State Province Name';
 185   $params['state_province']['title'] = 'Primary Address State Province';
 186   $params['country_id']['title'] = 'Primary Address Country ID';
 187   $params['country']['title'] = 'Primary Address country';
 188   $params['worldregion_id']['title'] = 'Primary Address World Region ID';
 189   $params['worldregion']['title'] = 'Primary Address World Region';
 190   $params['phone_id']['title'] = 'Primary Phone ID';
 191   $params['phone']['title'] = 'Primary Phone';
 192   $params['phone_type_id']['title'] = 'Primary Phone Type ID';
 193   $params['provider_id']['title'] = 'Primary Phone Provider ID';
 194   $params['email_id']['title'] = 'Primary Email ID';
 195   $params['email']['title'] = 'Primary Email';
 196   $params['gender_id']['title'] = 'Gender ID';
 197   $params['gender']['title'] = 'Gender';
 198   $params['on_hold']['title'] = 'Primary Email On Hold';
 199   $params['im']['title'] = 'Primary Instant Messanger';
 200   $params['im_id']['title'] = 'Primary Instant Messanger ID';
 201   $params['group_id']['title'] = 'Group Memberships (filter)';
 202   $params['group']['title'] = 'Group Memberships (filter, array)';
 203   $params['tag']['title'] = 'Assigned tags (filter, array)';
 204   $params['birth_date_low'] = array('name' => 'birth_date_low', 'type' => CRM_Utils_Type::T_DATE, 'title' => ts('Birthdate is equal to or greater than'));
 205   $params['birth_date_high'] = array('name' => 'birth_date_high', 'type' => CRM_Utils_Type::T_DATE, 'title' => ts('Birthdate is equal to or less than'));
 206   $params['deceased_date_low'] = array('name' => 'deceased_date_low','type' => CRM_Utils_Type::T_DATE, 'title' => ts('Deceased Date is equal to or greater than'));
 207   $params['deceased_date_high'] = array('name' => 'deceased_date_high', 'type' => CRM_Utils_Type::T_DATE, 'title' => ts('Deceased Date is equal to or less than'));
 208 }
 209
 210 /**
 211  * We are supporting 'showAll' = 'all', 'trash' or 'active' for contact get
 212  * and for getcount
 213  * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of
 214  * 0, 1 or not set
 215  *
 216  * We also support 'filter_group_id' & 'filter.group_id'
 217  *
 218  * @param array $params as passed into api get or getcount function
 219  * @param array $options array of options (so we can modify the filter)
 220  */
 221 function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) {
 222   if (isset($params['showAll'])) {
 223     if (strtolower($params['showAll']) == "active") {
 224       $params['contact_is_deleted'] = 0;
 225     }
 226     if (strtolower($params['showAll']) == "trash") {
 227       $params['contact_is_deleted'] = 1;
 228     }
 229     if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) {
 230       unset($params['contact_is_deleted']);
 231     }
 232   }
 233   // support for group filters
 234   if (array_key_exists('filter_group_id', $params)) {
 235     $params['filter.group_id'] = $params['filter_group_id'];
 236     unset($params['filter_group_id']);
 237   }
 238   // filter.group_id works both for 1,2,3 and array (1,2,3)
 239   if (array_key_exists('filter.group_id', $params)) {
 240     if (is_array($params['filter.group_id'])) {
 241       $groups = $params['filter.group_id'];
 242     }
 243     else $groups = explode(',', $params['filter.group_id']);
 244     unset($params['filter.group_id']);
 245     $groups = array_flip($groups);
 246     $groups[key($groups)] = 1;
 247     $options['input_params']['group'] = $groups;
 248   }
 249 }
 250
 251 /**
 252  * Delete a contact with given contact id
 253  *
 254  * @param  array       $params (reference ) input parameters, contact_id element required
 255  *
 256  * @return array API Result Array
 257  * @access public
 258  *
 259  * @example ContactDelete.php
 260  * {@getfields contact_delete}
 261  */
 262 function civicrm_api3_contact_delete($params) {
 263
 264   $contactID = CRM_Utils_Array::value('id', $params);
 265
 266   $session = CRM_Core_Session::singleton();
 267   if ($contactID == $session->get('userID')) {
 268     return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.');
 269   }
 270   $restore = CRM_Utils_Array::value('restore', $params) ? $params['restore'] : FALSE;
 271   $skipUndelete = CRM_Utils_Array::value('skip_undelete', $params) ? $params['skip_undelete'] : FALSE;
 272
 273   // CRM-12929
 274   // restrict permanent delete if a contact has financial trxn associated with it
 275   $error = NULL;
 276   if ($skipUndelete && CRM_Financial_BAO_FinancialItem::checkContactPresent(array($contactID), $error)) {
 277     return civicrm_api3_create_error($error['_qf_default']);
 278   }
 279   if (CRM_Contact_BAO_Contact::deleteContact($contactID, $restore, $skipUndelete)) {
 280     return civicrm_api3_create_success();
 281   }
 282   else {
 283     return civicrm_api3_create_error('Could not delete contact');
 284   }
 285 }
 286
 287
 288 function _civicrm_api3_contact_check_params( &$params, $dupeCheck = true, $dupeErrorArray = false, $obsoletevalue = true, $dedupeRuleGroupID = null )
 289 {
 290
 291   switch (strtolower(CRM_Utils_Array::value('contact_type', $params))) {
 292     case 'household':
 293       civicrm_api3_verify_mandatory($params, null, array('household_name'));
 294       break;
 295     case 'organization':
 296       civicrm_api3_verify_mandatory($params, null, array('organization_name'));
 297       break;
 298     case 'individual':
 299       civicrm_api3_verify_one_mandatory($params, null, array(
 300         'first_name',
 301         'last_name',
 302         'email',
 303         'display_name',
 304       )
 305     );
 306     break;
 307   }
 308
 309   // Fixme: This really needs to be handled at a lower level. @See CRM-13123
 310   if (isset($params['preferred_communication_method'])) {
 311     $params['preferred_communication_method'] = CRM_Utils_Array::implodePadded($params['preferred_communication_method']);
 312   }
 313
 314   if (CRM_Utils_Array::value('contact_sub_type', $params) && CRM_Utils_Array::value('contact_type', $params)) {
 315       if (!(CRM_Contact_BAO_ContactType::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) {
 316         throw new API_Exception("Invalid or Mismatched Contact SubType: " . implode(', ', (array)$params['contact_sub_type']));
 317       }
 318     }
 319
 320   if ($dupeCheck) {
 321     // check for record already existing
 322     $dedupeParams = CRM_Dedupe_Finder::formatParams($params, $params['contact_type']);
 323
 324     // CRM-6431
 325     // setting 'check_permission' here means that the dedupe checking will be carried out even if the
 326     // person does not have permission to carry out de-dupes
 327     // this is similar to the front end form
 328     if (isset($params['check_permission'])) {
 329       $dedupeParams['check_permission'] = $params['check_permission'];
 330     }
 331
 332     $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $params['contact_type'], 'Strict', array());
 333
 334     if (count($ids) >0) {
 335       throw new API_Exception("Found matching contacts: ". implode(',',$ids),"duplicate",array("ids"=>$ids));
 336     }
 337   }
 338
 339   //check for organisations with same name
 340   if (!empty($params['current_employer'])) {
 341     $organizationParams = array();
 342     $organizationParams['organization_name'] = $params['current_employer'];
 343
 344     $dedupParams = CRM_Dedupe_Finder::formatParams($organizationParams, 'Organization');
 345
 346     $dedupParams['check_permission'] = FALSE;
 347     $dupeIds = CRM_Dedupe_Finder::dupesByParams($dedupParams, 'Organization', 'Supervised');
 348
 349     // check for mismatch employer name and id
 350     if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) {
 351       throw new API_Exception('Employer name and Employer id Mismatch');
 352     }
 353
 354     // show error if multiple organisation with same name exist
 355     if (empty($params['employer_id']) && (count($dupeIds) > 1)) {
 356       throw new API_Exception('Found more than one Organisation with same Name.');
 357     }
 358   }
 359
 360   return NULL;
 361 }
 362
 363 /**
 364  * Takes an associative array and creates a contact object and all the associated
 365  * derived objects (i.e. individual, location, email, phone etc)
 366  *
 367  * @param array $params (reference ) an assoc array of name/value pairs
 368  * @param  int     $contactID        if present the contact with that ID is updated
 369  *
 370  * @return object CRM_Contact_BAO_Contact object
 371  * @access public
 372  * @static
 373  */
 374 function _civicrm_api3_contact_update($params, $contactID = NULL) {
 375   //@todo - doesn't contact create support 'id' which is already set- check & remove
 376   if ($contactID) {
 377     $params['contact_id'] = $contactID;
 378   }
 379
 380   return CRM_Contact_BAO_Contact::create($params);
 381 }
 382
 383 /**
 384  * Validate the addressee or email or postal greetings
 385  *
 386  * @param  $params                   Associative array of property name/value
 387  *                                   pairs to insert in new contact.
 388  *
 389  * @return array (reference )        null on success, error message otherwise
 390  *
 391  * @access public
 392  */
 393 function _civicrm_api3_greeting_format_params($params) {
 394   $greetingParams = array('', '_id', '_custom');
 395   foreach (array('email', 'postal', 'addressee') as $key) {
 396     $greeting = '_greeting';
 397     if ($key == 'addressee') {
 398       $greeting = '';
 399     }
 400
 401     $formatParams = FALSE;
 402     // unset display value from params.
 403     if (isset($params["{$key}{$greeting}_display"])) {
 404       unset($params["{$key}{$greeting}_display"]);
 405     }
 406
 407     // check if greetings are present in present
 408     foreach ($greetingParams as $greetingValues) {
 409       if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) {
 410         $formatParams = TRUE;
 411         break;
 412       }
 413     }
 414
 415     if (!$formatParams) {
 416       continue;
 417     }
 418
 419     $nullValue = FALSE;
 420     $filter = array(
 421       'contact_type' => $params['contact_type'],
 422       'greeting_type' => "{$key}{$greeting}",
 423     );
 424
 425     $greetings      = CRM_Core_PseudoConstant::greeting($filter);
 426     $greetingId     = CRM_Utils_Array::value("{$key}{$greeting}_id", $params);
 427     $greetingVal    = CRM_Utils_Array::value("{$key}{$greeting}", $params);
 428     $customGreeting = CRM_Utils_Array::value("{$key}{$greeting}_custom", $params);
 429
 430     if (!$greetingId && $greetingVal) {
 431       $params["{$key}{$greeting}_id"] = CRM_Utils_Array::key($params["{$key}{$greeting}"], $greetings);
 432     }
 433
 434     if ($customGreeting && $greetingId &&
 435       ($greetingId != array_search('Customized', $greetings))
 436     ) {
 437       throw new API_Exception(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting',
 438           array(1 => $key)
 439         ));
 440     }
 441
 442     if ($greetingVal && $greetingId &&
 443       ($greetingId != CRM_Utils_Array::key($greetingVal, $greetings))
 444     ) {
 445       throw new API_Exception(ts('Mismatch in %1 greeting id and %1 greeting',
 446           array(1 => $key)
 447         ));
 448     }
 449
 450     if ($greetingId) {
 451
 452       if (!array_key_exists($greetingId, $greetings)) {
 453         throw new API_Exception(ts('Invalid %1 greeting Id', array(1 => $key)));
 454       }
 455
 456       if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) {
 457         throw new API_Exception(ts('Please provide a custom value for %1 greeting',
 458             array(1 => $key)
 459           ));
 460       }
 461     }
 462     elseif ($greetingVal) {
 463
 464       if (!in_array($greetingVal, $greetings)) {
 465         throw new API_Exception(ts('Invalid %1 greeting', array(1 => $key)));
 466       }
 467
 468       $greetingId = CRM_Utils_Array::key($greetingVal, $greetings);
 469     }
 470
 471     if ($customGreeting) {
 472       $greetingId = CRM_Utils_Array::key('Customized', $greetings);
 473     }
 474
 475     $customValue = isset($params['contact_id']) ?
 476       CRM_Core_DAO::getFieldValue(
 477         'CRM_Contact_DAO_Contact',
 478         $params['contact_id'],
 479         "{$key}{$greeting}_custom"
 480       ) :
 481       FALSE;
 482
 483     if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) {
 484       $nullValue = TRUE;
 485     }
 486     elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) {
 487       $nullValue = TRUE;
 488     }
 489     elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params)
 490       && empty($params["{$key}{$greeting}_custom"])
 491     ) {
 492       $nullValue = TRUE;
 493     }
 494
 495     $params["{$key}{$greeting}_id"] = $greetingId;
 496
 497     if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) {
 498       unset($params["{$key}{$greeting}_custom"]);
 499     }
 500
 501     if ($nullValue) {
 502       $params["{$key}{$greeting}_id"] = '';
 503       $params["{$key}{$greeting}_custom"] = '';
 504     }
 505
 506     if (isset($params["{$key}{$greeting}"])) {
 507       unset($params["{$key}{$greeting}"]);
 508     }
 509   }
 510 }
 511
 512 /**
 513  * Contact quick search api
 514  *
 515  * @access public
 516  *
 517  * {@example ContactGetquick.php 0}
 518  *
 519  */
 520 function civicrm_api3_contact_quicksearch($params) {
 521   // kept as an alias for compatibility reasons.  CRM-11136
 522   return civicrm_api3_contact_getquick($params);
 523 }
 524
 525 function civicrm_api3_contact_getquick($params) {
 526   civicrm_api3_verify_mandatory($params, NULL, array('name'));
 527   $name = CRM_Utils_Type::escape(CRM_Utils_Array::value('name', $params), 'String');
 528
 529   // get the autocomplete options from settings
 530   $acpref = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 531     CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 532       'contact_autocomplete_options'
 533     )
 534   );
 535
 536   // get the option values for contact autocomplete
 537   $acOptions = CRM_Core_OptionGroup::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
 538
 539   $list = array();
 540   foreach ($acpref as $value) {
 541     if ($value && CRM_Utils_Array::value($value, $acOptions)) {
 542       $list[$value] = $acOptions[$value];
 543     }
 544   }
 545   // If we are doing quicksearch by a field other than name, make sure that field is added to results
 546   if (!empty($params['field_name'])) {
 547     $field_name = CRM_Utils_String::munge($params['field_name']);
 548     // Unique name contact_id = id
 549     if ($field_name == 'contact_id') {
 550       $field_name = 'id';
 551     }
 552     // phone_numeric should be phone
 553     $searchField = str_replace('_numeric', '', $field_name);
 554     if(!in_array($searchField, $list)) {
 555       $list[] = $searchField;
 556     }
 557   }
 558
 559   $select = $actualSelectElements = array('sort_name');
 560   $where  = '';
 561   $from   = array();
 562   foreach ($list as $value) {
 563     $suffix = substr($value, 0, 2) . substr($value, -1);
 564     switch ($value) {
 565       case 'street_address':
 566       case 'city':
 567       case 'postal_code':
 568         $selectText = $value;
 569         $value      = "address";
 570         $suffix     = 'sts';
 571       case 'phone':
 572       case 'email':
 573         $actualSelectElements[] = $select[] = ($value == 'address') ? $selectText : $value;
 574         if ($value == 'phone') {
 575           $actualSelectElements[] = $select[] = 'phone_ext';
 576         }
 577         $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) ";
 578         break;
 579
 580       case 'country':
 581       case 'state_province':
 582         $select[] = "{$suffix}.name as {$value}";
 583         $actualSelectElements[] = "{$suffix}.name";
 584         if (!in_array('address', $from)) {
 585           $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) ';
 586         }
 587         $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id  ) ";
 588         break;
 589
 590       default:
 591         if ($value != 'id') {
 592           $suffix = 'cc';
 593           if (!empty($params['field_name']) && $params['field_name'] == 'value') {
 594             $suffix = CRM_Utils_String::munge(CRM_Utils_Array::value('table_name', $params, 'cc'));
 595           }
 596           $actualSelectElements[] = $select[] = $suffix . '.' . $value;
 597         }
 598         break;
 599     }
 600   }
 601
 602   $config = CRM_Core_Config::singleton();
 603   $as  = $select;
 604   $select = implode(', ', $select);
 605   if (!empty($select)) {
 606     $select = ", $select";
 607   }
 608   $actualSelectElements = implode(', ', $actualSelectElements);
 609   $selectAliases = $from;
 610   unset($selectAliases['address']);
 611   $selectAliases = implode(', ', array_keys($selectAliases));
 612   if (!empty($selectAliases)) {
 613     $selectAliases = ", $selectAliases";
 614   }
 615   $from = implode(' ', $from);
 616   $limit = (int) CRM_Utils_Array::value('limit', $params);
 617   $limit = $limit > 0 ? $limit : 10;
 618
 619   // add acl clause here
 620   list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause('cc');
 621
 622   if ($aclWhere) {
 623     $where .= " AND $aclWhere ";
 624   }
 625
 626   if (CRM_Utils_Array::value('org', $params)) {
 627     $where .= " AND contact_type = \"Organization\"";
 628
 629     // CRM-7157, hack: get current employer details when
 630     // employee_id is present.
 631     $currEmpDetails = array();
 632     if (CRM_Utils_Array::value('employee_id', $params)) {
 633       if ($currentEmployer = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 634           (int) $params['employee_id'],
 635           'employer_id'
 636         )) {
 637         if ($config->includeWildCardInName) {
 638           $strSearch = "%$name%";
 639         }
 640         else {
 641           $strSearch = "$name%";
 642         }
 643
 644         // get current employer details
 645         $dao = CRM_Core_DAO::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name
 646                     FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'");
 647         if ($dao->fetch()) {
 648           $currEmpDetails = array(
 649             'id' => $dao->id,
 650             'data' => $dao->data,
 651           );
 652         }
 653       }
 654     }
 655   }
 656
 657   if (CRM_Utils_Array::value('contact_sub_type', $params)) {
 658     $contactSubType = CRM_Utils_Type::escape($params['contact_sub_type'], 'String');
 659     $where .= " AND cc.contact_sub_type = '{$contactSubType}'";
 660   }
 661
 662   //set default for current_employer or return contact with particular id
 663   if (CRM_Utils_Array::value('id', $params)) {
 664     $where .= " AND cc.id = " . (int) $params['id'];
 665   }
 666
 667   if (CRM_Utils_Array::value('cid', $params)) {
 668     $where .= " AND cc.id <> " . (int) $params['cid'];
 669   }
 670
 671   //contact's based of relationhip type
 672   $relType = NULL;
 673   if (CRM_Utils_Array::value('rel', $params)) {
 674     $relation = explode('_', CRM_Utils_Array::value('rel', $params));
 675     $relType  = CRM_Utils_Type::escape($relation[0], 'Integer');
 676     $rel      = CRM_Utils_Type::escape($relation[2], 'String');
 677   }
 678
 679   if ($config->includeWildCardInName) {
 680     $strSearch = "%$name%";
 681   }
 682   else {
 683     $strSearch = "$name%";
 684   }
 685   $includeEmailFrom = $includeNickName = $exactIncludeNickName = '';
 686   if ($config->includeNickNameInName) {
 687     $includeNickName = " OR nick_name LIKE '$strSearch'";
 688     $exactIncludeNickName = " OR nick_name LIKE '$name'";
 689   }
 690
 691   //CRM-10687
 692   if (!empty($params['field_name']) && !empty($params['table_name'])) {
 693     $table_name = CRM_Utils_String::munge($params['table_name']);
 694     $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch')";
 695     $exactWhereClause = " WHERE ( $table_name.$field_name = '$name')";
 696     // Search by id should be exact
 697     if ($field_name == 'id' || $field_name == 'external_identifier') {
 698       $whereClause = $exactWhereClause;
 699     }
 700   }
 701   else {
 702     if ($config->includeEmailInName) {
 703       if (!in_array('email', $list)) {
 704         $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
 705       }
 706       $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
 707       $exactWhereClause = " WHERE ( email LIKE '$name' OR sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
 708     }
 709     else {
 710       $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
 711       $exactWhereClause = " WHERE ( sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
 712     }
 713   }
 714
 715   $additionalFrom = '';
 716   if ($relType) {
 717     $additionalFrom = "
 718             INNER JOIN civicrm_relationship_type r ON (
 719                 r.id = {$relType}
 720                 AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL )
 721                 AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL )
 722             )";
 723   }
 724
 725   // check if only CMS users are requested
 726   if (CRM_Utils_Array::value('cmsuser', $params)) {
 727     $additionalFrom = "
 728       INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id)
 729       ";
 730   }
 731
 732   $orderByInner = "";
 733   $orderByOuter = "ORDER BY exactFirst";
 734   if ($config->includeOrderByClause) {
 735     $orderByInner = "ORDER BY sort_name";
 736     $orderByOuter .= ", sort_name";
 737   }
 738
 739   //CRM-5954
 740   $query = "
 741         SELECT DISTINCT(id), data, sort_name {$selectAliases}
 742         FROM   (
 743             ( SELECT 0 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
 744             FROM   civicrm_contact cc {$from}
 745     {$aclFrom}
 746     {$additionalFrom} {$includeEmailFrom}
 747     {$exactWhereClause}
 748     LIMIT 0, {$limit} )
 749     UNION
 750     ( SELECT 1 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
 751     FROM   civicrm_contact cc {$from}
 752     {$aclFrom}
 753     {$additionalFrom} {$includeEmailFrom}
 754     {$whereClause}
 755     {$orderByInner}
 756     LIMIT 0, {$limit} )
 757 ) t
 758 {$orderByOuter}
 759 LIMIT    0, {$limit}
 760     ";
 761   // send query to hook to be modified if needed
 762   CRM_Utils_Hook::contactListQuery($query,
 763     $name,
 764     empty($params['context']) ? NULL : CRM_Utils_Type::escape($params['context'], 'String'),
 765     empty($params['id']) ? NULL : $params['id']
 766   );
 767
 768   $dao = CRM_Core_DAO::executeQuery($query);
 769
 770   $contactList = array();
 771   $listCurrentEmployer = TRUE;
 772   while ($dao->fetch()) {
 773     $t = array('id' => $dao->id);
 774     foreach ($as as $k) {
 775       $t[$k] = isset($dao->$k)? $dao->$k: '';
 776     }
 777     $t['data'] = $dao->data;
 778     $contactList[] = $t;
 779     if (CRM_Utils_Array::value('org', $params) &&
 780       !empty($currEmpDetails) &&
 781       $dao->id == $currEmpDetails['id']
 782     ) {
 783       $listCurrentEmployer = FALSE;
 784     }
 785   }
 786
 787   //return organization name if doesn't exist in db
 788   if (empty($contactList)) {
 789     if (CRM_Utils_Array::value('org', $params)) {
 790       if ($listCurrentEmployer && !empty($currEmpDetails)) {
 791         $contactList = array(
 792           array(
 793           'data' => $currEmpDetails['data'],
 794             'id'   => $currEmpDetails['id']
 795           )
 796         );
 797       }
 798       else {
 799         $contactList = array(
 800           array(
 801             'data' => $name,
 802             'id'   => $name
 803           )
 804         );
 805       }
 806     }
 807   }
 808
 809   return civicrm_api3_create_success($contactList, $params);
 810 }
 811
 812 /**
 813  * Merges given pair of duplicate contacts.
 814  *
 815  * @param  array   $params   input parameters
 816  *
 817  * Allowed @params array keys are:
 818  * {int     main_id     main contact id with whom merge has to happen}
 819  * {int     other_id    duplicate contact which would be deleted after merge operation}
 820  * {string  mode        helps decide how to behave when there are conflicts.
 821  *                      A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
 822  * {boolean auto_flip   wether to let api decide which contact to retain and which to delete.}
 823  *
 824  * @return array  API Result Array
 825  *
 826  * @static void
 827  * @access public
 828  */
 829 function civicrm_api3_contact_merge($params) {
 830   $mode = CRM_Utils_Array::value('mode', $params, 'safe');
 831   $autoFlip = CRM_Utils_Array::value('auto_flip', $params, TRUE);
 832
 833   $dupePairs = array(array('srcID' => CRM_Utils_Array::value('main_id', $params),
 834       'dstID' => CRM_Utils_Array::value('other_id', $params),
 835     ));
 836   $result = CRM_Dedupe_Merger::merge($dupePairs, array(), $mode, $autoFlip);
 837
 838   if ($result['is_error'] == 0) {
 839     return civicrm_api3_create_success();
 840   }
 841   else {
 842     return civicrm_api3_create_error($result['messages']);
 843   }
 844 }
 845
 846 function _civicrm_api3_contact_proximity_spec(&$params) {
 847   $params['latitude']['api.required'] = 1;
 848   $params['longitude']['api.required'] = 1;
 849   $params['unit']['api.default'] = 'meter';
 850 }
 851
 852 function civicrm_api3_contact_proximity($params) {
 853   $latitude  = CRM_Utils_Array::value('latitude', $params);
 854   $longitude = CRM_Utils_Array::value('longitude', $params);
 855   $distance  = CRM_Utils_Array::value('distance', $params);
 856
 857   $unit = CRM_Utils_Array::value('unit', $params);
 858
 859   // check and ensure that lat/long and distance are floats
 860   if (
 861     !CRM_Utils_Rule::numeric($latitude) ||
 862     !CRM_Utils_Rule::numeric($longitude) ||
 863     !CRM_Utils_Rule::numeric($distance)
 864   ) {
 865     throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric'));
 866   }
 867
 868   if ($unit == "mile") {
 869     $conversionFactor = 1609.344;
 870   }
 871   else {
 872     $conversionFactor = 1000;
 873   }
 874   //Distance in meters
 875   $distance = $distance * $conversionFactor;
 876
 877   $whereClause = CRM_Contact_BAO_ProximityQuery::where($latitude, $longitude, $distance);
 878
 879   $query = "
 880 SELECT    civicrm_contact.id as contact_id,
 881           civicrm_contact.display_name as display_name
 882 FROM      civicrm_contact
 883 LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id
 884 WHERE     $whereClause
 885 ";
 886
 887   $dao = CRM_Core_DAO::executeQuery($query);
 888   $contacts = array();
 889   while ($dao->fetch()) {
 890     $contacts[] = $dao->toArray();
 891   }
 892
 893   return civicrm_api3_create_success($contacts, $params, 'contact', 'get_by_location', $dao);
 894 }
 895