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 }
 205
 206 /**
 207  * We are supporting 'showAll' = 'all', 'trash' or 'active' for contact get
 208  * and for getcount
 209  * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of
 210  * 0, 1 or not set
 211  *
 212  * We also support 'filter_group_id' & 'filter.group_id'
 213  *
 214  * @param array $params as passed into api get or getcount function
 215  * @param array $options array of options (so we can modify the filter)
 216  */
 217 function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) {
 218   if (isset($params['showAll'])) {
 219     if (strtolower($params['showAll']) == "active") {
 220       $params['contact_is_deleted'] = 0;
 221     }
 222     if (strtolower($params['showAll']) == "trash") {
 223       $params['contact_is_deleted'] = 1;
 224     }
 225     if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) {
 226       unset($params['contact_is_deleted']);
 227     }
 228   }
 229   // support for group filters
 230   if (array_key_exists('filter_group_id', $params)) {
 231     $params['filter.group_id'] = $params['filter_group_id'];
 232     unset($params['filter_group_id']);
 233   }
 234   // filter.group_id works both for 1,2,3 and array (1,2,3)
 235   if (array_key_exists('filter.group_id', $params)) {
 236     if (is_array($params['filter.group_id'])) {
 237       $groups = $params['filter.group_id'];
 238     }
 239     else $groups = explode(',', $params['filter.group_id']);
 240     unset($params['filter.group_id']);
 241     $groups = array_flip($groups);
 242     $groups[key($groups)] = 1;
 243     $options['input_params']['group'] = $groups;
 244   }
 245 }
 246
 247 /**
 248  * Delete a contact with given contact id
 249  *
 250  * @param  array       $params (reference ) input parameters, contact_id element required
 251  *
 252  * @return array API Result Array
 253  * @access public
 254  *
 255  * @example ContactDelete.php
 256  * {@getfields contact_delete}
 257  */
 258 function civicrm_api3_contact_delete($params) {
 259
 260   $contactID = CRM_Utils_Array::value('id', $params);
 261
 262   $session = CRM_Core_Session::singleton();
 263   if ($contactID == $session->get('userID')) {
 264     return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.');
 265   }
 266   $restore = !empty($params['restore']) ? $params['restore'] : FALSE;
 267   $skipUndelete = !empty($params['skip_undelete']) ? $params['skip_undelete'] : FALSE;
 268
 269   // CRM-12929
 270   // restrict permanent delete if a contact has financial trxn associated with it
 271   $error = NULL;
 272   if ($skipUndelete && CRM_Financial_BAO_FinancialItem::checkContactPresent(array($contactID), $error)) {
 273     return civicrm_api3_create_error($error['_qf_default']);
 274   }
 275   if (CRM_Contact_BAO_Contact::deleteContact($contactID, $restore, $skipUndelete)) {
 276     return civicrm_api3_create_success();
 277   }
 278   else {
 279     return civicrm_api3_create_error('Could not delete contact');
 280   }
 281 }
 282
 283
 284 function _civicrm_api3_contact_check_params( &$params, $dupeCheck = true, $dupeErrorArray = false, $obsoletevalue = true, $dedupeRuleGroupID = null )
 285 {
 286
 287   switch (strtolower(CRM_Utils_Array::value('contact_type', $params))) {
 288     case 'household':
 289       civicrm_api3_verify_mandatory($params, null, array('household_name'));
 290       break;
 291     case 'organization':
 292       civicrm_api3_verify_mandatory($params, null, array('organization_name'));
 293       break;
 294     case 'individual':
 295       civicrm_api3_verify_one_mandatory($params, null, array(
 296         'first_name',
 297         'last_name',
 298         'email',
 299         'display_name',
 300       )
 301     );
 302     break;
 303   }
 304
 305   // Fixme: This really needs to be handled at a lower level. @See CRM-13123
 306   if (isset($params['preferred_communication_method'])) {
 307     $params['preferred_communication_method'] = CRM_Utils_Array::implodePadded($params['preferred_communication_method']);
 308   }
 309
 310   if (!empty($params['contact_sub_type']) && !empty($params['contact_type'])) {
 311       if (!(CRM_Contact_BAO_ContactType::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) {
 312         throw new API_Exception("Invalid or Mismatched Contact SubType: " . implode(', ', (array)$params['contact_sub_type']));
 313       }
 314     }
 315
 316   if ($dupeCheck) {
 317     // check for record already existing
 318     $dedupeParams = CRM_Dedupe_Finder::formatParams($params, $params['contact_type']);
 319
 320     // CRM-6431
 321     // setting 'check_permission' here means that the dedupe checking will be carried out even if the
 322     // person does not have permission to carry out de-dupes
 323     // this is similar to the front end form
 324     if (isset($params['check_permission'])) {
 325       $dedupeParams['check_permission'] = $params['check_permission'];
 326     }
 327
 328     $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $params['contact_type'], 'Strict', array());
 329
 330     if (count($ids) >0) {
 331       throw new API_Exception("Found matching contacts: ". implode(',',$ids),"duplicate",array("ids"=>$ids));
 332     }
 333   }
 334
 335   // The BAO no longer supports the legacy param "current_employer" so here is a shim for api backward-compatability
 336   if (!empty($params['current_employer'])) {
 337     $organizationParams = array(
 338       'organization_name' => $params['current_employer'],
 339     );
 340
 341     $dedupParams = CRM_Dedupe_Finder::formatParams($organizationParams, 'Organization');
 342
 343     $dedupParams['check_permission'] = FALSE;
 344     $dupeIds = CRM_Dedupe_Finder::dupesByParams($dedupParams, 'Organization', 'Supervised');
 345
 346     // check for mismatch employer name and id
 347     if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) {
 348       throw new API_Exception('Employer name and Employer id Mismatch');
 349     }
 350
 351     // show error if multiple organisation with same name exist
 352     if (empty($params['employer_id']) && (count($dupeIds) > 1)) {
 353       throw new API_Exception('Found more than one Organisation with same Name.');
 354     }
 355
 356     if ($dupeIds) {
 357       $params['employer_id'] = $dupeIds[0];
 358     }
 359     else {
 360       $result = civicrm_api3('contact', 'create', array(
 361         'organization_name' => $params['current_employer'],
 362         'contact_type' => 'Organization'
 363       ));
 364       $params['employer_id'] = $result['id'];
 365     }
 366   }
 367
 368   return NULL;
 369 }
 370
 371 /**
 372  * Takes an associative array and creates a contact object and all the associated
 373  * derived objects (i.e. individual, location, email, phone etc)
 374  *
 375  * @param array $params (reference ) an assoc array of name/value pairs
 376  * @param  int     $contactID        if present the contact with that ID is updated
 377  *
 378  * @return object CRM_Contact_BAO_Contact object
 379  * @access public
 380  * @static
 381  */
 382 function _civicrm_api3_contact_update($params, $contactID = NULL) {
 383   //@todo - doesn't contact create support 'id' which is already set- check & remove
 384   if ($contactID) {
 385     $params['contact_id'] = $contactID;
 386   }
 387
 388   return CRM_Contact_BAO_Contact::create($params);
 389 }
 390
 391 /**
 392  * Validate the addressee or email or postal greetings
 393  *
 394  * @param  $params                   Associative array of property name/value
 395  *                                   pairs to insert in new contact.
 396  *
 397  * @return array (reference )        null on success, error message otherwise
 398  *
 399  * @access public
 400  */
 401 function _civicrm_api3_greeting_format_params($params) {
 402   $greetingParams = array('', '_id', '_custom');
 403   foreach (array('email', 'postal', 'addressee') as $key) {
 404     $greeting = '_greeting';
 405     if ($key == 'addressee') {
 406       $greeting = '';
 407     }
 408
 409     $formatParams = FALSE;
 410     // unset display value from params.
 411     if (isset($params["{$key}{$greeting}_display"])) {
 412       unset($params["{$key}{$greeting}_display"]);
 413     }
 414
 415     // check if greetings are present in present
 416     foreach ($greetingParams as $greetingValues) {
 417       if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) {
 418         $formatParams = TRUE;
 419         break;
 420       }
 421     }
 422
 423     if (!$formatParams) {
 424       continue;
 425     }
 426
 427     $nullValue = FALSE;
 428     $filter = array(
 429       'contact_type' => $params['contact_type'],
 430       'greeting_type' => "{$key}{$greeting}",
 431     );
 432
 433     $greetings      = CRM_Core_PseudoConstant::greeting($filter);
 434     $greetingId     = CRM_Utils_Array::value("{$key}{$greeting}_id", $params);
 435     $greetingVal    = CRM_Utils_Array::value("{$key}{$greeting}", $params);
 436     $customGreeting = CRM_Utils_Array::value("{$key}{$greeting}_custom", $params);
 437
 438     if (!$greetingId && $greetingVal) {
 439       $params["{$key}{$greeting}_id"] = CRM_Utils_Array::key($params["{$key}{$greeting}"], $greetings);
 440     }
 441
 442     if ($customGreeting && $greetingId &&
 443       ($greetingId != array_search('Customized', $greetings))
 444     ) {
 445       throw new API_Exception(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting',
 446           array(1 => $key)
 447         ));
 448     }
 449
 450     if ($greetingVal && $greetingId &&
 451       ($greetingId != CRM_Utils_Array::key($greetingVal, $greetings))
 452     ) {
 453       throw new API_Exception(ts('Mismatch in %1 greeting id and %1 greeting',
 454           array(1 => $key)
 455         ));
 456     }
 457
 458     if ($greetingId) {
 459
 460       if (!array_key_exists($greetingId, $greetings)) {
 461         throw new API_Exception(ts('Invalid %1 greeting Id', array(1 => $key)));
 462       }
 463
 464       if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) {
 465         throw new API_Exception(ts('Please provide a custom value for %1 greeting',
 466             array(1 => $key)
 467           ));
 468       }
 469     }
 470     elseif ($greetingVal) {
 471
 472       if (!in_array($greetingVal, $greetings)) {
 473         throw new API_Exception(ts('Invalid %1 greeting', array(1 => $key)));
 474       }
 475
 476       $greetingId = CRM_Utils_Array::key($greetingVal, $greetings);
 477     }
 478
 479     if ($customGreeting) {
 480       $greetingId = CRM_Utils_Array::key('Customized', $greetings);
 481     }
 482
 483     $customValue = isset($params['contact_id']) ?
 484       CRM_Core_DAO::getFieldValue(
 485         'CRM_Contact_DAO_Contact',
 486         $params['contact_id'],
 487         "{$key}{$greeting}_custom"
 488       ) :
 489       FALSE;
 490
 491     if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) {
 492       $nullValue = TRUE;
 493     }
 494     elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) {
 495       $nullValue = TRUE;
 496     }
 497     elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params)
 498       && empty($params["{$key}{$greeting}_custom"])
 499     ) {
 500       $nullValue = TRUE;
 501     }
 502
 503     $params["{$key}{$greeting}_id"] = $greetingId;
 504
 505     if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) {
 506       unset($params["{$key}{$greeting}_custom"]);
 507     }
 508
 509     if ($nullValue) {
 510       $params["{$key}{$greeting}_id"] = '';
 511       $params["{$key}{$greeting}_custom"] = '';
 512     }
 513
 514     if (isset($params["{$key}{$greeting}"])) {
 515       unset($params["{$key}{$greeting}"]);
 516     }
 517   }
 518 }
 519
 520 /**
 521  * Old contact quick search api
 522  *
 523  * @deprecated
 524  *
 525  * {@example ContactGetquick.php 0}
 526  *
 527  */
 528 function civicrm_api3_contact_getquick($params) {
 529   civicrm_api3_verify_mandatory($params, NULL, array('name'));
 530   $name = CRM_Utils_Type::escape(CRM_Utils_Array::value('name', $params), 'String');
 531
 532   // get the autocomplete options from settings
 533   $acpref = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 534     CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 535       'contact_autocomplete_options'
 536     )
 537   );
 538
 539   // get the option values for contact autocomplete
 540   $acOptions = CRM_Core_OptionGroup::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
 541
 542   $list = array();
 543   foreach ($acpref as $value) {
 544     if ($value && !empty($acOptions[$value])) {
 545       $list[$value] = $acOptions[$value];
 546     }
 547   }
 548   // If we are doing quicksearch by a field other than name, make sure that field is added to results
 549   if (!empty($params['field_name'])) {
 550     $field_name = CRM_Utils_String::munge($params['field_name']);
 551     // Unique name contact_id = id
 552     if ($field_name == 'contact_id') {
 553       $field_name = 'id';
 554     }
 555     // phone_numeric should be phone
 556     $searchField = str_replace('_numeric', '', $field_name);
 557     if(!in_array($searchField, $list)) {
 558       $list[] = $searchField;
 559     }
 560   }
 561
 562   $select = $actualSelectElements = array('sort_name');
 563   $where  = '';
 564   $from   = array();
 565   foreach ($list as $value) {
 566     $suffix = substr($value, 0, 2) . substr($value, -1);
 567     switch ($value) {
 568       case 'street_address':
 569       case 'city':
 570       case 'postal_code':
 571         $selectText = $value;
 572         $value      = "address";
 573         $suffix     = 'sts';
 574       case 'phone':
 575       case 'email':
 576         $actualSelectElements[] = $select[] = ($value == 'address') ? $selectText : $value;
 577         if ($value == 'phone') {
 578           $actualSelectElements[] = $select[] = 'phone_ext';
 579         }
 580         $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) ";
 581         break;
 582
 583       case 'country':
 584       case 'state_province':
 585         $select[] = "{$suffix}.name as {$value}";
 586         $actualSelectElements[] = "{$suffix}.name";
 587         if (!in_array('address', $from)) {
 588           $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) ';
 589         }
 590         $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id  ) ";
 591         break;
 592
 593       default:
 594         if ($value != 'id') {
 595           $suffix = 'cc';
 596           if (!empty($params['field_name']) && $params['field_name'] == 'value') {
 597             $suffix = CRM_Utils_String::munge(CRM_Utils_Array::value('table_name', $params, 'cc'));
 598           }
 599           $actualSelectElements[] = $select[] = $suffix . '.' . $value;
 600         }
 601         break;
 602     }
 603   }
 604
 605   $config = CRM_Core_Config::singleton();
 606   $as  = $select;
 607   $select = implode(', ', $select);
 608   if (!empty($select)) {
 609     $select = ", $select";
 610   }
 611   $actualSelectElements = implode(', ', $actualSelectElements);
 612   $selectAliases = $from;
 613   unset($selectAliases['address']);
 614   $selectAliases = implode(', ', array_keys($selectAliases));
 615   if (!empty($selectAliases)) {
 616     $selectAliases = ", $selectAliases";
 617   }
 618   $from = implode(' ', $from);
 619   $limit = (int) CRM_Utils_Array::value('limit', $params);
 620   $limit = $limit > 0 ? $limit : 10;
 621
 622   // add acl clause here
 623   list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause('cc');
 624
 625   if ($aclWhere) {
 626     $where .= " AND $aclWhere ";
 627   }
 628
 629   if (!empty($params['org'])) {
 630     $where .= " AND contact_type = \"Organization\"";
 631
 632     // CRM-7157, hack: get current employer details when
 633     // employee_id is present.
 634     $currEmpDetails = array();
 635     if (!empty($params['employee_id'])) {
 636       if ($currentEmployer = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 637           (int) $params['employee_id'],
 638           'employer_id'
 639         )) {
 640         if ($config->includeWildCardInName) {
 641           $strSearch = "%$name%";
 642         }
 643         else {
 644           $strSearch = "$name%";
 645         }
 646
 647         // get current employer details
 648         $dao = CRM_Core_DAO::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name
 649                     FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'");
 650         if ($dao->fetch()) {
 651           $currEmpDetails = array(
 652             'id' => $dao->id,
 653             'data' => $dao->data,
 654           );
 655         }
 656       }
 657     }
 658   }
 659
 660   if (!empty($params['contact_sub_type'])) {
 661     $contactSubType = CRM_Utils_Type::escape($params['contact_sub_type'], 'String');
 662     $where .= " AND cc.contact_sub_type = '{$contactSubType}'";
 663   }
 664
 665   if (!empty($params['contact_type'])) {
 666     $contactType = CRM_Utils_Type::escape($params['contact_type'], 'String');
 667     $where .= " AND cc.contact_type LIKE '{$contactType}'";
 668   }
 669
 670   //set default for current_employer or return contact with particular id
 671   if (!empty($params['id'])) {
 672     $where .= " AND cc.id = " . (int) $params['id'];
 673   }
 674
 675   if (!empty($params['cid'])) {
 676     $where .= " AND cc.id <> " . (int) $params['cid'];
 677   }
 678
 679   //contact's based of relationhip type
 680   $relType = NULL;
 681   if (!empty($params['rel'])) {
 682     $relation = explode('_', CRM_Utils_Array::value('rel', $params));
 683     $relType  = CRM_Utils_Type::escape($relation[0], 'Integer');
 684     $rel      = CRM_Utils_Type::escape($relation[2], 'String');
 685   }
 686
 687   if ($config->includeWildCardInName) {
 688     $strSearch = "%$name%";
 689   }
 690   else {
 691     $strSearch = "$name%";
 692   }
 693   $includeEmailFrom = $includeNickName = $exactIncludeNickName = '';
 694   if ($config->includeNickNameInName) {
 695     $includeNickName = " OR nick_name LIKE '$strSearch'";
 696     $exactIncludeNickName = " OR nick_name LIKE '$name'";
 697   }
 698
 699   //CRM-10687
 700   if (!empty($params['field_name']) && !empty($params['table_name'])) {
 701     $table_name = CRM_Utils_String::munge($params['table_name']);
 702     $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch')";
 703     $exactWhereClause = " WHERE ( $table_name.$field_name = '$name')";
 704     // Search by id should be exact
 705     if ($field_name == 'id' || $field_name == 'external_identifier') {
 706       $whereClause = $exactWhereClause;
 707     }
 708   }
 709   else {
 710     if ($config->includeEmailInName) {
 711       if (!in_array('email', $list)) {
 712         $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
 713       }
 714       $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
 715       $exactWhereClause = " WHERE ( email LIKE '$name' OR sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
 716     }
 717     else {
 718       $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
 719       $exactWhereClause = " WHERE ( sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
 720     }
 721   }
 722
 723   $additionalFrom = '';
 724   if ($relType) {
 725     $additionalFrom = "
 726             INNER JOIN civicrm_relationship_type r ON (
 727                 r.id = {$relType}
 728                 AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL )
 729                 AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL )
 730             )";
 731   }
 732
 733   // check if only CMS users are requested
 734   if (!empty($params['cmsuser'])) {
 735     $additionalFrom = "
 736       INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id)
 737       ";
 738   }
 739
 740   $orderByInner = "";
 741   $orderByOuter = "ORDER BY exactFirst";
 742   if ($config->includeOrderByClause) {
 743     $orderByInner = "ORDER BY sort_name";
 744     $orderByOuter .= ", sort_name";
 745   }
 746
 747   //CRM-5954
 748   $query = "
 749         SELECT DISTINCT(id), data, sort_name {$selectAliases}
 750         FROM   (
 751             ( SELECT 0 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
 752             FROM   civicrm_contact cc {$from}
 753     {$aclFrom}
 754     {$additionalFrom} {$includeEmailFrom}
 755     {$exactWhereClause}
 756     LIMIT 0, {$limit} )
 757     UNION
 758     ( SELECT 1 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
 759     FROM   civicrm_contact cc {$from}
 760     {$aclFrom}
 761     {$additionalFrom} {$includeEmailFrom}
 762     {$whereClause}
 763     {$orderByInner}
 764     LIMIT 0, {$limit} )
 765 ) t
 766 {$orderByOuter}
 767 LIMIT    0, {$limit}
 768     ";
 769   // send query to hook to be modified if needed
 770   CRM_Utils_Hook::contactListQuery($query,
 771     $name,
 772     empty($params['context']) ? NULL : CRM_Utils_Type::escape($params['context'], 'String'),
 773     empty($params['id']) ? NULL : $params['id']
 774   );
 775
 776   $dao = CRM_Core_DAO::executeQuery($query);
 777
 778   $contactList = array();
 779   $listCurrentEmployer = TRUE;
 780   while ($dao->fetch()) {
 781     $t = array('id' => $dao->id);
 782     foreach ($as as $k) {
 783       $t[$k] = isset($dao->$k)? $dao->$k: '';
 784     }
 785     $t['data'] = $dao->data;
 786     $contactList[] = $t;
 787     if (!empty($params['org']) &&
 788       !empty($currEmpDetails) &&
 789       $dao->id == $currEmpDetails['id']
 790     ) {
 791       $listCurrentEmployer = FALSE;
 792     }
 793   }
 794
 795   //return organization name if doesn't exist in db
 796   if (empty($contactList)) {
 797     if (!empty($params['org'])) {
 798       if ($listCurrentEmployer && !empty($currEmpDetails)) {
 799         $contactList = array(
 800           array(
 801           'data' => $currEmpDetails['data'],
 802             'id'   => $currEmpDetails['id']
 803           )
 804         );
 805       }
 806       else {
 807         $contactList = array(
 808           array(
 809             'data' => $name,
 810             'id'   => $name
 811           )
 812         );
 813       }
 814     }
 815   }
 816
 817   return civicrm_api3_create_success($contactList, $params);
 818 }
 819
 820 /**
 821  * Merges given pair of duplicate contacts.
 822  *
 823  * @param  array   $params   input parameters
 824  *
 825  * Allowed @params array keys are:
 826  * {int     main_id     main contact id with whom merge has to happen}
 827  * {int     other_id    duplicate contact which would be deleted after merge operation}
 828  * {string  mode        helps decide how to behave when there are conflicts.
 829  *                      A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
 830  * {boolean auto_flip   wether to let api decide which contact to retain and which to delete.}
 831  *
 832  * @return array  API Result Array
 833  *
 834  * @static void
 835  * @access public
 836  */
 837 function civicrm_api3_contact_merge($params) {
 838   $mode = CRM_Utils_Array::value('mode', $params, 'safe');
 839   $autoFlip = CRM_Utils_Array::value('auto_flip', $params, TRUE);
 840
 841   $dupePairs = array(array('srcID' => CRM_Utils_Array::value('main_id', $params),
 842       'dstID' => CRM_Utils_Array::value('other_id', $params),
 843     ));
 844   $result = CRM_Dedupe_Merger::merge($dupePairs, array(), $mode, $autoFlip);
 845
 846   if ($result['is_error'] == 0) {
 847     return civicrm_api3_create_success();
 848   }
 849   else {
 850     return civicrm_api3_create_error($result['messages']);
 851   }
 852 }
 853
 854 function _civicrm_api3_contact_proximity_spec(&$params) {
 855   $params['latitude']['api.required'] = 1;
 856   $params['longitude']['api.required'] = 1;
 857   $params['unit']['api.default'] = 'meter';
 858 }
 859
 860 function civicrm_api3_contact_proximity($params) {
 861   $latitude  = CRM_Utils_Array::value('latitude', $params);
 862   $longitude = CRM_Utils_Array::value('longitude', $params);
 863   $distance  = CRM_Utils_Array::value('distance', $params);
 864
 865   $unit = CRM_Utils_Array::value('unit', $params);
 866
 867   // check and ensure that lat/long and distance are floats
 868   if (
 869     !CRM_Utils_Rule::numeric($latitude) ||
 870     !CRM_Utils_Rule::numeric($longitude) ||
 871     !CRM_Utils_Rule::numeric($distance)
 872   ) {
 873     throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric'));
 874   }
 875
 876   if ($unit == "mile") {
 877     $conversionFactor = 1609.344;
 878   }
 879   else {
 880     $conversionFactor = 1000;
 881   }
 882   //Distance in meters
 883   $distance = $distance * $conversionFactor;
 884
 885   $whereClause = CRM_Contact_BAO_ProximityQuery::where($latitude, $longitude, $distance);
 886
 887   $query = "
 888 SELECT    civicrm_contact.id as contact_id,
 889           civicrm_contact.display_name as display_name
 890 FROM      civicrm_contact
 891 LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id
 892 WHERE     $whereClause
 893 ";
 894
 895   $dao = CRM_Core_DAO::executeQuery($query);
 896   $contacts = array();
 897   while ($dao->fetch()) {
 898     $contacts[] = $dao->toArray();
 899   }
 900
 901   return civicrm_api3_create_success($contacts, $params, 'contact', 'get_by_location', $dao);
 902 }
 903
 904
 905 /**
 906  * @see _civicrm_api3_generic_getlist_params
 907  *
 908  * @param $request array
 909  */
 910 function _civicrm_api3_contact_getlist_params(&$request) {
 911   // get the autocomplete options from settings
 912   $acpref = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 913     CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 914       'contact_autocomplete_options'
 915     )
 916   );
 917
 918   // get the option values for contact autocomplete
 919   $acOptions = CRM_Core_OptionGroup::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
 920
 921   $list = array();
 922   foreach ($acpref as $value) {
 923     if ($value && !empty($acOptions[$value])) {
 924       $list[] = $acOptions[$value];
 925     }
 926   }
 927   // If we are doing quicksearch by a field other than name, make sure that field is added to results
 928   $field_name = CRM_Utils_String::munge($request['search_field']);
 929   // Unique name contact_id = id
 930   if ($field_name == 'contact_id') {
 931     $field_name = 'id';
 932   }
 933   // phone_numeric should be phone
 934   $searchField = str_replace('_numeric', '', $field_name);
 935   if(!in_array($searchField, $list)) {
 936     $list[] = $searchField;
 937   }
 938   $request['description_field'] = $list;
 939   $list[] = 'contact_type';
 940   $request['params']['return'] = array_unique(array_merge($list, $request['extra']));
 941   $request['params']['options']['sort'] = 'sort_name';
 942   // Contact api doesn't support array(LIKE => 'foo') syntax
 943   if (!empty($request['input'])) {
 944     $request['params'][$request['search_field']] = $request['input'];
 945   }
 946 }
 947
 948 /**
 949  * @see _civicrm_api3_generic_getlist_output
 950  *
 951  * @param $result array
 952  * @param $request array
 953  *
 954  * @return array
 955  */
 956 function _civicrm_api3_contact_getlist_output($result, $request) {
 957   $output = array();
 958   if (!empty($result['values'])) {
 959     $addressFields = array_intersect(array('street_address', 'city', 'state_province', 'country'), $request['params']['return']);
 960     foreach ($result['values'] as $row) {
 961       $data = array(
 962         'id' => $row[$request['id_field']],
 963         'label' => $row[$request['label_field']],
 964         'description' => array(),
 965       );
 966       foreach ($request['description_field'] as $item) {
 967         if (!strpos($item, '_name') && !in_array($item, $addressFields) && !empty($row[$item])) {
 968           $data['description'][] = $row[$item];
 969         }
 970       }
 971       $address = array();
 972       foreach($addressFields as $item) {
 973         if (!empty($row[$item])) {
 974           $address[] = $row[$item];
 975         }
 976       }
 977       if ($address) {
 978         $data['description'][] = implode(' ', $address);
 979       }
 980       if (!empty($request['image_field'])) {
 981         $data['image'] = isset($row[$request['image_field']]) ? $row[$request['image_field']] : '';
 982       }
 983       else {
 984         $data['icon_class'] = $row['contact_type'];
 985       }
 986       foreach ($request['extra'] as $field) {
 987         $data['extra'][$field] = isset($row[$field]) ? $row[$field] : NULL;
 988       }
 989       $output[] = $data;
 990     }
 991   }
 992   return $output;
 993 }