api/v3/Contact.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.7                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * This api exposes CiviCRM contacts.
  30  *
  31  * Contacts are the main entity in CiviCRM and this api is more robust than most.
  32  *   - Get action allows all params supported by advanced search.
  33  *   - Create action allows creating several related entities at once (e.g. email).
  34  *   - Create allows checking for duplicate contacts.
  35  * Use getfields to list the full range of parameters and options supported by each action.
  36  *
  37  * @package CiviCRM_APIv3
  38  */
  39
  40 /**
  41  * Create or update a Contact.
  42  *
  43  * @param array $params
  44  *   Input parameters.
  45  *
  46  * @throws API_Exception
  47  *
  48  * @return array
  49  *   API Result Array
  50  */
  51 function civicrm_api3_contact_create($params) {
  52   $contactID = CRM_Utils_Array::value('contact_id', $params, CRM_Utils_Array::value('id', $params));
  53
  54   if ($contactID && !empty($params['check_permissions']) && !CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::EDIT)) {
  55     throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify contact record');
  56   }
  57
  58   if (!empty($params['dupe_check'])) {
  59     $ids = CRM_Contact_BAO_Contact::getDuplicateContacts($params, $params['contact_type'], 'Unsupervised', array(), $params['check_permission']);
  60     if (count($ids) > 0) {
  61       throw new API_Exception("Found matching contacts: " . implode(',', $ids), "duplicate", array("ids" => $ids));
  62     }
  63   }
  64
  65   $values = _civicrm_api3_contact_check_params($params);
  66   if ($values) {
  67     return $values;
  68   }
  69
  70   if (array_key_exists('api_key', $params) && !empty($params['check_permissions'])) {
  71     if (CRM_Core_Permission::check('edit api keys') || CRM_Core_Permission::check('administer CiviCRM')) {
  72       // OK
  73     }
  74     elseif ($contactID && CRM_Core_Permission::check('edit own api keys') && CRM_Core_Session::singleton()->get('userID') == $contactID) {
  75       // OK
  76     }
  77     else {
  78       throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify api key');
  79     }
  80   }
  81
  82   if (!$contactID) {
  83     // If we get here, we're ready to create a new contact
  84     if (($email = CRM_Utils_Array::value('email', $params)) && !is_array($params['email'])) {
  85       $defLocType = CRM_Core_BAO_LocationType::getDefault();
  86       $params['email'] = array(
  87         1 => array(
  88           'email' => $email,
  89           'is_primary' => 1,
  90           'location_type_id' => ($defLocType->id) ? $defLocType->id : 1,
  91         ),
  92       );
  93     }
  94   }
  95
  96   if (!empty($params['home_url'])) {
  97     $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id');
  98     $params['website'] = array(
  99       1 => array(
 100         'website_type_id' => key($websiteTypes),
 101         'url' => $params['home_url'],
 102       ),
 103     );
 104   }
 105
 106   _civicrm_api3_greeting_format_params($params);
 107
 108   $values = array();
 109
 110   if (empty($params['contact_type']) && $contactID) {
 111     $params['contact_type'] = CRM_Contact_BAO_Contact::getContactType($contactID);
 112   }
 113
 114   if (!isset($params['contact_sub_type']) && $contactID) {
 115     $params['contact_sub_type'] = CRM_Contact_BAO_Contact::getContactSubType($contactID);
 116   }
 117
 118   _civicrm_api3_custom_format_params($params, $values, $params['contact_type'], $contactID);
 119
 120   $params = array_merge($params, $values);
 121   //@todo we should just call basic_create here - but need to make contact:create accept 'id' on the bao
 122   $contact = _civicrm_api3_contact_update($params, $contactID);
 123
 124   if (is_a($contact, 'CRM_Core_Error')) {
 125     throw new API_Exception($contact->_errors[0]['message']);
 126   }
 127   else {
 128     $values = array();
 129     _civicrm_api3_object_to_array_unique_fields($contact, $values[$contact->id]);
 130   }
 131
 132   $values = _civicrm_api3_contact_formatResult($params, $values);
 133
 134   return civicrm_api3_create_success($values, $params, 'Contact', 'create');
 135 }
 136
 137 /**
 138  * Adjust Metadata for Create action.
 139  *
 140  * @param array $params
 141  *   Array of parameters determined by getfields.
 142  */
 143 function _civicrm_api3_contact_create_spec(&$params) {
 144   $params['contact_type']['api.required'] = 1;
 145   $params['id']['api.aliases'] = array('contact_id');
 146   $params['current_employer'] = array(
 147     'title' => 'Current Employer',
 148     'description' => 'Name of Current Employer',
 149     'type' => CRM_Utils_Type::T_STRING,
 150   );
 151   $params['dupe_check'] = array(
 152     'title' => 'Check for Duplicates',
 153     'description' => 'Throw error if contact create matches dedupe rule',
 154     'type' => CRM_Utils_Type::T_BOOLEAN,
 155   );
 156   $params['prefix_id']['api.aliases'] = array('individual_prefix', 'individual_prefix_id');
 157   $params['suffix_id']['api.aliases'] = array('individual_suffix', 'individual_suffix_id');
 158   $params['gender_id']['api.aliases'] = array('gender');
 159 }
 160
 161 /**
 162  * Retrieve one or more contacts, given a set of search params.
 163  *
 164  * @param array $params
 165  *
 166  * @return array
 167  *   API Result Array
 168  */
 169 function civicrm_api3_contact_get($params) {
 170   $options = array();
 171   _civicrm_api3_contact_get_supportanomalies($params, $options);
 172   $contacts = _civicrm_api3_get_using_query_object('Contact', $params, $options);
 173   $contacts = _civicrm_api3_contact_formatResult($params, $contacts);
 174   return civicrm_api3_create_success($contacts, $params, 'Contact');
 175 }
 176
 177 /**
 178  * Filter the result.
 179  *
 180  * @param array $result
 181  *
 182  * @return array
 183  * @throws \CRM_Core_Exception
 184  */
 185 function _civicrm_api3_contact_formatResult($params, $result) {
 186   $apiKeyPerms = array('edit api keys', 'administer CiviCRM');
 187   $allowApiKey = empty($params['check_permissions']) || CRM_Core_Permission::check(array($apiKeyPerms));
 188   if (!$allowApiKey) {
 189     if (is_array($result)) {
 190       // Single-value $result
 191       if (isset($result['api_key'])) {
 192         unset($result['api_key']);
 193       }
 194
 195       // Multi-value $result
 196       foreach ($result as $key => $row) {
 197         if (is_array($row)) {
 198           unset($result[$key]['api_key']);
 199         }
 200       }
 201     }
 202   }
 203   return $result;
 204 }
 205
 206 /**
 207  * Get number of contacts matching the supplied criteria.
 208  *
 209  * @param array $params
 210  *
 211  * @return int
 212  */
 213 function civicrm_api3_contact_getcount($params) {
 214   $options = array();
 215   _civicrm_api3_contact_get_supportanomalies($params, $options);
 216   $count = _civicrm_api3_get_using_query_object('Contact', $params, $options, 1);
 217   return (int) $count;
 218 }
 219
 220 /**
 221  * Adjust Metadata for Get action.
 222  *
 223  * @param array $params
 224  *   Array of parameters determined by getfields.
 225  */
 226 function _civicrm_api3_contact_get_spec(&$params) {
 227   $params['contact_is_deleted']['api.default'] = 0;
 228
 229   // We declare all these pseudoFields as there are other undocumented fields accessible
 230   // via the api - but if check permissions is set we only allow declared fields
 231   $params['address_id'] = array(
 232     'title' => 'Primary Address ID',
 233     'type' => CRM_Utils_Type::T_INT,
 234   );
 235   $params['street_address'] = array(
 236     'title' => 'Primary Address Street Address',
 237     'type' => CRM_Utils_Type::T_STRING,
 238   );
 239   $params['supplemental_address_1'] = array(
 240     'title' => 'Primary Address Supplemental Address 1',
 241     'type' => CRM_Utils_Type::T_STRING,
 242   );
 243   $params['supplemental_address_2'] = array(
 244     'title' => 'Primary Address Supplemental Address 2',
 245     'type' => CRM_Utils_Type::T_STRING,
 246   );
 247   $params['supplemental_address_3'] = array(
 248     'title' => 'Primary Address Supplemental Address 3',
 249     'type' => CRM_Utils_Type::T_STRING,
 250   );
 251   $params['current_employer'] = array(
 252     'title' => 'Current Employer',
 253     'type' => CRM_Utils_Type::T_STRING,
 254   );
 255   $params['city'] = array(
 256     'title' => 'Primary Address City',
 257     'type' => CRM_Utils_Type::T_STRING,
 258   );
 259   $params['postal_code_suffix'] = array(
 260     'title' => 'Primary Address Post Code Suffix',
 261     'type' => CRM_Utils_Type::T_STRING,
 262   );
 263   $params['postal_code'] = array(
 264     'title' => 'Primary Address Post Code',
 265     'type' => CRM_Utils_Type::T_STRING,
 266   );
 267   $params['geo_code_1'] = array(
 268     'title' => 'Primary Address Latitude',
 269     'type' => CRM_Utils_Type::T_STRING,
 270   );
 271   $params['geo_code_2'] = array(
 272     'title' => 'Primary Address Longitude',
 273     'type' => CRM_Utils_Type::T_STRING,
 274   );
 275   $params['state_province_id'] = array(
 276     'title' => 'Primary Address State Province ID',
 277     'type' => CRM_Utils_Type::T_INT,
 278     'pseudoconstant' => array(
 279       'table' => 'civicrm_state_province',
 280     ),
 281   );
 282   $params['state_province_name'] = array(
 283     'title' => 'Primary Address State Province Name',
 284     'type' => CRM_Utils_Type::T_STRING,
 285     'pseudoconstant' => array(
 286       'table' => 'civicrm_state_province',
 287     ),
 288   );
 289   $params['state_province'] = array(
 290     'title' => 'Primary Address State Province',
 291     'type' => CRM_Utils_Type::T_STRING,
 292     'pseudoconstant' => array(
 293       'table' => 'civicrm_state_province',
 294     ),
 295   );
 296   $params['country_id'] = array(
 297     'title' => 'Primary Address Country ID',
 298     'type' => CRM_Utils_Type::T_INT,
 299     'pseudoconstant' => array(
 300       'table' => 'civicrm_country',
 301     ),
 302   );
 303   $params['country'] = array(
 304     'title' => 'Primary Address country',
 305     'type' => CRM_Utils_Type::T_STRING,
 306     'pseudoconstant' => array(
 307       'table' => 'civicrm_country',
 308     ),
 309   );
 310   $params['worldregion_id'] = array(
 311     'title' => 'Primary Address World Region ID',
 312     'type' => CRM_Utils_Type::T_INT,
 313     'pseudoconstant' => array(
 314       'table' => 'civicrm_world_region',
 315     ),
 316   );
 317   $params['worldregion'] = array(
 318     'title' => 'Primary Address World Region',
 319     'type' => CRM_Utils_Type::T_STRING,
 320     'pseudoconstant' => array(
 321       'table' => 'civicrm_world_region',
 322     ),
 323   );
 324   $params['phone_id'] = array(
 325     'title' => 'Primary Phone ID',
 326     'type' => CRM_Utils_Type::T_INT,
 327   );
 328   $params['phone'] = array(
 329     'title' => 'Primary Phone',
 330     'type' => CRM_Utils_Type::T_STRING,
 331   );
 332   $params['phone_type_id'] = array(
 333     'title' => 'Primary Phone Type ID',
 334     'type' => CRM_Utils_Type::T_INT,
 335   );
 336   $params['provider_id'] = array(
 337     'title' => 'Primary Phone Provider ID',
 338     'type' => CRM_Utils_Type::T_INT,
 339   );
 340   $params['email_id'] = array(
 341     'title' => 'Primary Email ID',
 342     'type' => CRM_Utils_Type::T_INT,
 343   );
 344   $params['email'] = array(
 345     'title' => 'Primary Email',
 346     'type' => CRM_Utils_Type::T_STRING,
 347   );
 348   $params['on_hold'] = array(
 349     'title' => 'Primary Email On Hold',
 350     'type' => CRM_Utils_Type::T_BOOLEAN,
 351   );
 352   $params['im'] = array(
 353     'title' => 'Primary Instant Messenger',
 354     'type' => CRM_Utils_Type::T_STRING,
 355   );
 356   $params['im_id'] = array(
 357     'title' => 'Primary Instant Messenger ID',
 358     'type' => CRM_Utils_Type::T_INT,
 359   );
 360   $params['group'] = array(
 361     'title' => 'Group',
 362     'pseudoconstant' => array(
 363       'table' => 'civicrm_group',
 364     ),
 365   );
 366   $params['tag'] = array(
 367     'title' => 'Tags',
 368     'pseudoconstant' => array(
 369       'table' => 'civicrm_tag',
 370     ),
 371   );
 372   $params['birth_date_low'] = array('name' => 'birth_date_low', 'type' => CRM_Utils_Type::T_DATE, 'title' => ts('Birth Date is equal to or greater than'));
 373   $params['birth_date_high'] = array('name' => 'birth_date_high', 'type' => CRM_Utils_Type::T_DATE, 'title' => ts('Birth Date is equal to or less than'));
 374   $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'));
 375   $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'));
 376 }
 377
 378 /**
 379  * Support for historical oddities.
 380  *
 381  * We are supporting 'showAll' = 'all', 'trash' or 'active' for Contact get
 382  * and for getcount
 383  * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of
 384  * 0, 1 or not set
 385  *
 386  * We also support 'filter_group_id' & 'filter.group_id'
 387  *
 388  * @param array $params
 389  *   As passed into api get or getcount function.
 390  * @param array $options
 391  *   Array of options (so we can modify the filter).
 392  */
 393 function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) {
 394   if (isset($params['showAll'])) {
 395     if (strtolower($params['showAll']) == "active") {
 396       $params['contact_is_deleted'] = 0;
 397     }
 398     if (strtolower($params['showAll']) == "trash") {
 399       $params['contact_is_deleted'] = 1;
 400     }
 401     if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) {
 402       unset($params['contact_is_deleted']);
 403     }
 404   }
 405   // support for group filters
 406   if (array_key_exists('filter_group_id', $params)) {
 407     $params['filter.group_id'] = $params['filter_group_id'];
 408     unset($params['filter_group_id']);
 409   }
 410   // filter.group_id works both for 1,2,3 and array (1,2,3)
 411   if (array_key_exists('filter.group_id', $params)) {
 412     if (is_array($params['filter.group_id'])) {
 413       $groups = $params['filter.group_id'];
 414     }
 415     else {
 416       $groups = explode(',', $params['filter.group_id']);
 417     }
 418     unset($params['filter.group_id']);
 419     $options['input_params']['group'] = $groups;
 420   }
 421   if (isset($params['group'])) {
 422     $groups = $params['group'];
 423     $allGroups = CRM_Core_PseudoConstant::group();
 424     if (is_array($groups) && in_array(key($groups), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 425       // Get the groups array.
 426       $groupsArray = $groups[key($groups)];
 427       foreach ($groupsArray as &$group) {
 428         if (!is_numeric($group) && array_search($group, $allGroups)) {
 429           $group = array_search($group, $allGroups);
 430         }
 431       }
 432       // Now reset the $groups array with the ids not the titles.
 433       $groups[key($groups)] = $groupsArray;
 434     }
 435     // handle format like 'group' => array('title1', 'title2').
 436     elseif (is_array($groups)) {
 437       foreach ($groups as $k => &$group) {
 438         if (!is_numeric($group) && array_search($group, $allGroups)) {
 439           $group = array_search($group, $allGroups);
 440         }
 441         if (!is_numeric($k) && array_search($k, $allGroups)) {
 442           unset($groups[$k]);
 443           $groups[array_search($k, $allGroups)] = $group;
 444         }
 445       }
 446     }
 447     elseif (!is_numeric($groups) &&  array_search($groups, $allGroups)) {
 448       $groups = array_search($groups, $allGroups);
 449     }
 450     $params['group'] = $groups;
 451   }
 452 }
 453
 454 /**
 455  * Delete a Contact with given contact_id.
 456  *
 457  * @param array $params
 458  *   input parameters per getfields
 459  *
 460  * @throws \Civi\API\Exception\UnauthorizedException
 461  * @return array
 462  *   API Result Array
 463  */
 464 function civicrm_api3_contact_delete($params) {
 465   $contactID = CRM_Utils_Array::value('id', $params);
 466
 467   if (!empty($params['check_permissions']) && !CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::DELETE)) {
 468     throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify contact record');
 469   }
 470
 471   $session = CRM_Core_Session::singleton();
 472   if ($contactID == $session->get('userID')) {
 473     return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.');
 474   }
 475   $restore = !empty($params['restore']) ? $params['restore'] : FALSE;
 476   $skipUndelete = !empty($params['skip_undelete']) ? $params['skip_undelete'] : FALSE;
 477
 478   // CRM-12929
 479   // restrict permanent delete if a contact has financial trxn associated with it
 480   $error = NULL;
 481   if ($skipUndelete && CRM_Financial_BAO_FinancialItem::checkContactPresent(array($contactID), $error)) {
 482     return civicrm_api3_create_error($error['_qf_default']);
 483   }
 484   if (CRM_Contact_BAO_Contact::deleteContact($contactID, $restore, $skipUndelete,
 485     CRM_Utils_Array::value('check_permissions', $params))) {
 486     return civicrm_api3_create_success();
 487   }
 488   else {
 489     return civicrm_api3_create_error('Could not delete contact');
 490   }
 491 }
 492
 493
 494 /**
 495  * Check parameters passed in.
 496  *
 497  * This function is on it's way out.
 498  *
 499  * @param array $params
 500  *
 501  * @return null
 502  * @throws API_Exception
 503  * @throws CiviCRM_API3_Exception
 504  */
 505 function _civicrm_api3_contact_check_params(&$params) {
 506
 507   switch (strtolower(CRM_Utils_Array::value('contact_type', $params))) {
 508     case 'household':
 509       civicrm_api3_verify_mandatory($params, NULL, array('household_name'));
 510       break;
 511
 512     case 'organization':
 513       civicrm_api3_verify_mandatory($params, NULL, array('organization_name'));
 514       break;
 515
 516     case 'individual':
 517       civicrm_api3_verify_one_mandatory($params, NULL, array(
 518         'first_name',
 519         'last_name',
 520         'email',
 521         'display_name',
 522       )
 523       );
 524       break;
 525   }
 526
 527   if (!empty($params['contact_sub_type']) && !empty($params['contact_type'])) {
 528     if (!(CRM_Contact_BAO_ContactType::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) {
 529       throw new API_Exception("Invalid or Mismatched Contact Subtype: " . implode(', ', (array) $params['contact_sub_type']));
 530     }
 531   }
 532
 533   // The BAO no longer supports the legacy param "current_employer" so here is a shim for api backward-compatability
 534   if (!empty($params['current_employer'])) {
 535     $organizationParams = array(
 536       'organization_name' => $params['current_employer'],
 537     );
 538
 539     $dupeIds = CRM_Contact_BAO_Contact::getDuplicateContacts($organizationParams, 'Organization', 'Supervised', array(), FALSE);
 540
 541     // check for mismatch employer name and id
 542     if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) {
 543       throw new API_Exception('Employer name and Employer id Mismatch');
 544     }
 545
 546     // show error if multiple organisation with same name exist
 547     if (empty($params['employer_id']) && (count($dupeIds) > 1)) {
 548       throw new API_Exception('Found more than one Organisation with same Name.');
 549     }
 550
 551     if ($dupeIds) {
 552       $params['employer_id'] = $dupeIds[0];
 553     }
 554     else {
 555       $result = civicrm_api3('Contact', 'create', array(
 556         'organization_name' => $params['current_employer'],
 557         'contact_type' => 'Organization',
 558       ));
 559       $params['employer_id'] = $result['id'];
 560     }
 561   }
 562
 563   return NULL;
 564 }
 565
 566 /**
 567  * Helper function for Contact create.
 568  *
 569  * @param array $params
 570  *   (reference ) an assoc array of name/value pairs.
 571  * @param int $contactID
 572  *   If present the contact with that ID is updated.
 573  *
 574  * @return CRM_Contact_BAO_Contact|CRM_Core_Error
 575  */
 576 function _civicrm_api3_contact_update($params, $contactID = NULL) {
 577   //@todo - doesn't contact create support 'id' which is already set- check & remove
 578   if ($contactID) {
 579     $params['contact_id'] = $contactID;
 580   }
 581
 582   return CRM_Contact_BAO_Contact::create($params);
 583 }
 584
 585 /**
 586  * Validate the addressee or email or postal greetings.
 587  *
 588  * @param array $params
 589  *   Array per getfields metadata.
 590  *
 591  * @throws API_Exception
 592  */
 593 function _civicrm_api3_greeting_format_params($params) {
 594   $greetingParams = array('', '_id', '_custom');
 595   foreach (array('email', 'postal', 'addressee') as $key) {
 596     $greeting = '_greeting';
 597     if ($key == 'addressee') {
 598       $greeting = '';
 599     }
 600
 601     $formatParams = FALSE;
 602     // Unset display value from params.
 603     if (isset($params["{$key}{$greeting}_display"])) {
 604       unset($params["{$key}{$greeting}_display"]);
 605     }
 606
 607     // check if greetings are present in present
 608     foreach ($greetingParams as $greetingValues) {
 609       if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) {
 610         $formatParams = TRUE;
 611         break;
 612       }
 613     }
 614
 615     if (!$formatParams) {
 616       continue;
 617     }
 618
 619     $nullValue = FALSE;
 620     $filter = array(
 621       'contact_type' => $params['contact_type'],
 622       'greeting_type' => "{$key}{$greeting}",
 623     );
 624
 625     $greetings      = CRM_Core_PseudoConstant::greeting($filter);
 626     $greetingId     = CRM_Utils_Array::value("{$key}{$greeting}_id", $params);
 627     $greetingVal    = CRM_Utils_Array::value("{$key}{$greeting}", $params);
 628     $customGreeting = CRM_Utils_Array::value("{$key}{$greeting}_custom", $params);
 629
 630     if (!$greetingId && $greetingVal) {
 631       $params["{$key}{$greeting}_id"] = CRM_Utils_Array::key($params["{$key}{$greeting}"], $greetings);
 632     }
 633
 634     if ($customGreeting && $greetingId &&
 635       ($greetingId != array_search('Customized', $greetings))
 636     ) {
 637       throw new API_Exception(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting',
 638           array(1 => $key)
 639         ));
 640     }
 641
 642     if ($greetingVal && $greetingId &&
 643       ($greetingId != CRM_Utils_Array::key($greetingVal, $greetings))
 644     ) {
 645       throw new API_Exception(ts('Mismatch in %1 greeting id and %1 greeting',
 646           array(1 => $key)
 647         ));
 648     }
 649
 650     if ($greetingId) {
 651
 652       if (!array_key_exists($greetingId, $greetings)) {
 653         throw new API_Exception(ts('Invalid %1 greeting Id', array(1 => $key)));
 654       }
 655
 656       if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) {
 657         throw new API_Exception(ts('Please provide a custom value for %1 greeting',
 658             array(1 => $key)
 659           ));
 660       }
 661     }
 662     elseif ($greetingVal) {
 663
 664       if (!in_array($greetingVal, $greetings)) {
 665         throw new API_Exception(ts('Invalid %1 greeting', array(1 => $key)));
 666       }
 667
 668       $greetingId = CRM_Utils_Array::key($greetingVal, $greetings);
 669     }
 670
 671     if ($customGreeting) {
 672       $greetingId = CRM_Utils_Array::key('Customized', $greetings);
 673     }
 674
 675     $customValue = isset($params['contact_id']) ? CRM_Core_DAO::getFieldValue(
 676         'CRM_Contact_DAO_Contact',
 677         $params['contact_id'],
 678         "{$key}{$greeting}_custom"
 679       ) : FALSE;
 680
 681     if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) {
 682       $nullValue = TRUE;
 683     }
 684     elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) {
 685       $nullValue = TRUE;
 686     }
 687     elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params)
 688       && empty($params["{$key}{$greeting}_custom"])
 689     ) {
 690       $nullValue = TRUE;
 691     }
 692
 693     $params["{$key}{$greeting}_id"] = $greetingId;
 694
 695     if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) {
 696       unset($params["{$key}{$greeting}_custom"]);
 697     }
 698
 699     if ($nullValue) {
 700       $params["{$key}{$greeting}_id"] = '';
 701       $params["{$key}{$greeting}_custom"] = '';
 702     }
 703
 704     if (isset($params["{$key}{$greeting}"])) {
 705       unset($params["{$key}{$greeting}"]);
 706     }
 707   }
 708 }
 709
 710 /**
 711  * Adjust Metadata for Get action.
 712  *
 713  * @param array $params
 714  *   Array of parameters determined by getfields.
 715  */
 716 function _civicrm_api3_contact_getquick_spec(&$params) {
 717   $params['name']['api.required'] = TRUE;
 718   $params['name']['title'] = ts('String to search on');
 719   $params['name']['type'] = CRM_Utils_Type::T_STRING;
 720   $params['field']['type'] = CRM_Utils_Type::T_STRING;
 721   $params['field']['title'] = ts('Field to search on');
 722   $params['field']['options'] = array(
 723     '',
 724     'id',
 725     'contact_id',
 726     'external_identifier',
 727     'first_name',
 728     'last_name',
 729     'job_title',
 730     'postal_code',
 731     'street_address',
 732     'email',
 733     'city',
 734     'phone_numeric',
 735   );
 736   $params['table_name']['type'] = CRM_Utils_Type::T_STRING;
 737   $params['table_name']['title'] = ts('Table alias to search on');
 738   $params['table_name']['api.default'] = 'cc';
 739 }
 740
 741 /**
 742  * Old Contact quick search api.
 743  *
 744  * @deprecated
 745  *
 746  * @param array $params
 747  *
 748  * @return array
 749  * @throws \API_Exception
 750  */
 751 function civicrm_api3_contact_getquick($params) {
 752   $name = CRM_Utils_Type::escape(CRM_Utils_Array::value('name', $params), 'String');
 753   $table_name = CRM_Utils_String::munge($params['table_name']);
 754   // get the autocomplete options from settings
 755   $acpref = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 756     CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 757       'contact_autocomplete_options'
 758     )
 759   );
 760
 761   // get the option values for contact autocomplete
 762   $acOptions = CRM_Core_OptionGroup::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
 763
 764   $list = array();
 765   foreach ($acpref as $value) {
 766     if ($value && !empty($acOptions[$value])) {
 767       $list[$value] = $acOptions[$value];
 768     }
 769   }
 770   // If we are doing quicksearch by a field other than name, make sure that field is added to results
 771   if (!empty($params['field_name'])) {
 772     $field_name = CRM_Utils_String::munge($params['field_name']);
 773     // Unique name contact_id = id
 774     if ($field_name == 'contact_id') {
 775       $field_name = 'id';
 776     }
 777     // phone_numeric should be phone
 778     $searchField = str_replace('_numeric', '', $field_name);
 779     if (!in_array($searchField, $list)) {
 780       $list[] = $searchField;
 781     }
 782   }
 783   else {
 784     // Set field name to first name for exact match checking.
 785     $field_name = 'sort_name';
 786   }
 787
 788   $select = $actualSelectElements = array('sort_name');
 789   $where  = '';
 790   $from   = array();
 791   foreach ($list as $value) {
 792     $suffix = substr($value, 0, 2) . substr($value, -1);
 793     switch ($value) {
 794       case 'street_address':
 795       case 'city':
 796       case 'postal_code':
 797         $selectText = $value;
 798         $value      = "address";
 799         $suffix     = 'sts';
 800       case 'phone':
 801       case 'email':
 802         $actualSelectElements[] = $select[] = ($value == 'address') ? $selectText : $value;
 803         if ($value == 'phone') {
 804           $actualSelectElements[] = $select[] = 'phone_ext';
 805         }
 806         $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) ";
 807         break;
 808
 809       case 'country':
 810       case 'state_province':
 811         $select[] = "{$suffix}.name as {$value}";
 812         $actualSelectElements[] = "{$suffix}.name";
 813         if (!in_array('address', $from)) {
 814           $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) ';
 815         }
 816         $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id  ) ";
 817         break;
 818
 819       default:
 820         if ($value != 'id') {
 821           $suffix = 'cc';
 822           if (!empty($params['field_name']) && $params['field_name'] == 'value') {
 823             $suffix = CRM_Utils_String::munge(CRM_Utils_Array::value('table_name', $params, 'cc'));
 824           }
 825           $actualSelectElements[] = $select[] = $suffix . '.' . $value;
 826         }
 827         break;
 828     }
 829   }
 830
 831   $config = CRM_Core_Config::singleton();
 832   $as  = $select;
 833   $select = implode(', ', $select);
 834   if (!empty($select)) {
 835     $select = ", $select";
 836   }
 837   $actualSelectElements = implode(', ', $actualSelectElements);
 838   $selectAliases = $from;
 839   unset($selectAliases['address']);
 840   $selectAliases = implode(', ', array_keys($selectAliases));
 841   if (!empty($selectAliases)) {
 842     $selectAliases = ", $selectAliases";
 843   }
 844   $from = implode(' ', $from);
 845   $limit = (int) CRM_Utils_Array::value('limit', $params);
 846   $limit = $limit > 0 ? $limit : Civi::settings()->get('search_autocomplete_count');
 847
 848   // add acl clause here
 849   list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause('cc');
 850
 851   if ($aclWhere) {
 852     $where .= " AND $aclWhere ";
 853   }
 854   $isPrependWildcard = \Civi::settings()->get('includeWildCardInName');
 855
 856   if (!empty($params['org'])) {
 857     $where .= " AND contact_type = \"Organization\"";
 858
 859     // CRM-7157, hack: get current employer details when
 860     // employee_id is present.
 861     $currEmpDetails = array();
 862     if (!empty($params['employee_id'])) {
 863       if ($currentEmployer = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 864           (int) $params['employee_id'],
 865           'employer_id'
 866         )) {
 867         if ($isPrependWildcard) {
 868           $strSearch = "%$name%";
 869         }
 870         else {
 871           $strSearch = "$name%";
 872         }
 873
 874         // get current employer details
 875         $dao = CRM_Core_DAO::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name
 876                     FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'");
 877         if ($dao->fetch()) {
 878           $currEmpDetails = array(
 879             'id' => $dao->id,
 880             'data' => $dao->data,
 881           );
 882         }
 883       }
 884     }
 885   }
 886
 887   if (!empty($params['contact_sub_type'])) {
 888     $contactSubType = CRM_Utils_Type::escape($params['contact_sub_type'], 'String');
 889     $where .= " AND cc.contact_sub_type = '{$contactSubType}'";
 890   }
 891
 892   if (!empty($params['contact_type'])) {
 893     $contactType = CRM_Utils_Type::escape($params['contact_type'], 'String');
 894     $where .= " AND cc.contact_type LIKE '{$contactType}'";
 895   }
 896
 897   // Set default for current_employer or return contact with particular id
 898   if (!empty($params['id'])) {
 899     $where .= " AND cc.id = " . (int) $params['id'];
 900   }
 901
 902   if (!empty($params['cid'])) {
 903     $where .= " AND cc.id <> " . (int) $params['cid'];
 904   }
 905
 906   // Contact's based of relationhip type
 907   $relType = NULL;
 908   if (!empty($params['rel'])) {
 909     $relation = explode('_', CRM_Utils_Array::value('rel', $params));
 910     $relType  = CRM_Utils_Type::escape($relation[0], 'Integer');
 911     $rel      = CRM_Utils_Type::escape($relation[2], 'String');
 912   }
 913
 914   if ($isPrependWildcard) {
 915     $strSearch = "%$name%";
 916   }
 917   else {
 918     $strSearch = "$name%";
 919   }
 920   $includeEmailFrom = $includeNickName = $exactIncludeNickName = '';
 921   if ($config->includeNickNameInName) {
 922     $includeNickName = " OR nick_name LIKE '$strSearch'";
 923     $exactIncludeNickName = " OR nick_name LIKE '$name'";
 924   }
 925
 926   //CRM-10687
 927   if (!empty($params['field_name']) && !empty($params['table_name'])) {
 928     $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch') {$where}";
 929     // Search by id should be exact
 930     if ($field_name == 'id' || $field_name == 'external_identifier') {
 931       $whereClause = " WHERE ( $table_name.$field_name = '$name') {$where}";
 932     }
 933   }
 934   else {
 935     $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
 936     if ($config->includeEmailInName) {
 937       if (!in_array('email', $list)) {
 938         $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
 939       }
 940       $emailWhere = " WHERE email LIKE '$strSearch'";
 941     }
 942   }
 943
 944   $additionalFrom = '';
 945   if ($relType) {
 946     $additionalFrom = "
 947             INNER JOIN civicrm_relationship_type r ON (
 948                 r.id = {$relType}
 949                 AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL )
 950                 AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL )
 951             )";
 952   }
 953
 954   // check if only CMS users are requested
 955   if (!empty($params['cmsuser'])) {
 956     $additionalFrom = "
 957       INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id)
 958       ";
 959   }
 960   $orderBy = _civicrm_api3_quicksearch_get_order_by($name, $isPrependWildcard, $field_name);
 961
 962   //CRM-5954
 963   $query = "
 964         SELECT DISTINCT(id), data, sort_name {$selectAliases}, exactFirst
 965         FROM   (
 966             ( SELECT IF($table_name.$field_name = '{$name}', 0, 1) as exactFirst, cc.id as id, CONCAT_WS( ' :: ',
 967             {$actualSelectElements} )
 968              as data
 969             {$select}
 970             FROM   civicrm_contact cc {$from}
 971     {$aclFrom}
 972     {$additionalFrom}
 973     {$whereClause}
 974     {$orderBy}
 975     LIMIT 0, {$limit} )
 976     ";
 977
 978   if (!empty($emailWhere)) {
 979     $query .= "
 980       UNION (
 981         SELECT IF($table_name.$field_name = '{$name}', 0, 1) as exactFirst, cc.id as id, CONCAT_WS( ' :: ',
 982           {$actualSelectElements} )
 983           as data
 984           {$select}
 985           FROM   civicrm_contact cc {$from}
 986         {$aclFrom}
 987         {$additionalFrom} {$includeEmailFrom}
 988         {$emailWhere} AND cc.is_deleted = 0 " . ($aclWhere ? " AND $aclWhere " : '') . "
 989         {$orderBy}
 990       LIMIT 0, {$limit}
 991       )
 992     ";
 993   }
 994   $query .= ") t
 995     {$orderBy}
 996     LIMIT    0, {$limit}
 997   ";
 998
 999   // send query to hook to be modified if needed
1000   CRM_Utils_Hook::contactListQuery($query,
1001     $name,
1002     empty($params['context']) ? NULL : CRM_Utils_Type::escape($params['context'], 'String'),
1003     empty($params['id']) ? NULL : $params['id']
1004   );
1005
1006   $dao = CRM_Core_DAO::executeQuery($query);
1007
1008   $contactList = array();
1009   $listCurrentEmployer = TRUE;
1010   while ($dao->fetch()) {
1011     $t = array('id' => $dao->id);
1012     foreach ($as as $k) {
1013       $t[$k] = isset($dao->$k) ? $dao->$k : '';
1014     }
1015     $t['data'] = $dao->data;
1016     $contactList[] = $t;
1017     if (!empty($params['org']) &&
1018       !empty($currEmpDetails) &&
1019       $dao->id == $currEmpDetails['id']
1020     ) {
1021       $listCurrentEmployer = FALSE;
1022     }
1023   }
1024
1025   //return organization name if doesn't exist in db
1026   if (empty($contactList)) {
1027     if (!empty($params['org'])) {
1028       if ($listCurrentEmployer && !empty($currEmpDetails)) {
1029         $contactList = array(
1030           array(
1031             'data' => $currEmpDetails['data'],
1032             'id'   => $currEmpDetails['id'],
1033           ),
1034         );
1035       }
1036       else {
1037         $contactList = array(
1038           array(
1039             'data' => $name,
1040             'id'   => $name,
1041           ),
1042         );
1043       }
1044     }
1045   }
1046
1047   return civicrm_api3_create_success($contactList, $params, 'Contact', 'getquick');
1048 }
1049
1050 /**
1051  * Get the order by string for the quicksearch query.
1052  *
1053  * Get the order by string. The string might be
1054  *  - sort name if there is no search value provided and the site is configured
1055  *    to search by sort name
1056  *  - empty if there is no search value provided and the site is not configured
1057  *    to search by sort name
1058  *  - exactFirst and then sort name if a search value is provided and the site is configured
1059  *    to search by sort name
1060  *  - exactFirst if a search value is provided and the site is not configured
1061  *    to search by sort name
1062  *
1063  * exactFirst means 'yes if the search value exactly matches the searched field. else no'.
1064  * It is intended to prioritise exact matches for the entered string so on a first name search
1065  * for 'kath' contacts with a first name of exactly Kath rise to the top.
1066  *
1067  * On short strings it is expensive. Per CRM-19547 there is still an open question
1068  * as to whether we should only do exactMatch on a minimum length or on certain fields.
1069  *
1070  * However, we have mitigated this somewhat by not doing an exact match search on
1071  * empty strings, non-wildcard sort-name searches and email searches where there is
1072  * no @ after the first character.
1073  *
1074  * For the user it is further mitigated by the fact they just don't know the
1075  * slower queries are firing. If they type 'smit' slowly enough 4 queries will trigger
1076  * but if the first 3 are slow the first result they see may be off the 4th query.
1077  *
1078  * @param string $name
1079  * @param bool $isPrependWildcard
1080  * @param string $field_name
1081  *
1082  * @return string
1083  */
1084 function _civicrm_api3_quicksearch_get_order_by($name, $isPrependWildcard, $field_name) {
1085   $skipExactMatch = ($name === '%');
1086   if ($field_name === 'email' && !strpos('@', $name)) {
1087     $skipExactMatch = TRUE;
1088   }
1089
1090   if (!\Civi::settings()->get('includeOrderByClause')) {
1091     return $skipExactMatch ? '' : "ORDER BY exactFirst";
1092   }
1093   if ($skipExactMatch || (!$isPrependWildcard && $field_name === 'sort_name')) {
1094     // If there is no wildcard then sorting by exactFirst would have the same
1095     // effect as just a sort_name search, but slower.
1096     return "ORDER BY sort_name";
1097   }
1098
1099   return "ORDER BY exactFirst, sort_name";
1100 }
1101
1102 /**
1103  * Declare deprecated api functions.
1104  *
1105  * @deprecated api notice
1106  * @return array
1107  *   Array of deprecated actions
1108  */
1109 function _civicrm_api3_contact_deprecation() {
1110   return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".');
1111 }
1112
1113 /**
1114  * Merges given pair of duplicate contacts.
1115  *
1116  * @param array $params
1117  *   Allowed array keys are:
1118  *   -int main_id: main contact id with whom merge has to happen
1119  *   -int other_id: duplicate contact which would be deleted after merge operation
1120  *   -string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise.
1121  *
1122  * @return array
1123  *   API Result Array
1124  * @throws API_Exception
1125  */
1126 function civicrm_api3_contact_merge($params) {
1127   if (($result = CRM_Dedupe_Merger::merge(array(
1128       array(
1129         'srcID' => $params['to_remove_id'],
1130         'dstID' => $params['to_keep_id'],
1131       ),
1132     ), array(), $params['mode'])) != FALSE) {
1133     return civicrm_api3_create_success($result, $params);
1134   }
1135   throw new API_Exception('Merge failed');
1136 }
1137
1138 /**
1139  * Adjust metadata for contact_merge api function.
1140  *
1141  * @param array $params
1142  */
1143 function _civicrm_api3_contact_merge_spec(&$params) {
1144   $params['to_remove_id'] = array(
1145     'title' => 'ID of the contact to merge & remove',
1146     'description' => ts('Wow - these 2 params are the logical reverse of what I expect - but what to do?'),
1147     'api.required' => 1,
1148     'type' => CRM_Utils_Type::T_INT,
1149     'api.aliases' => array('main_id'),
1150   );
1151   $params['to_keep_id'] = array(
1152     'title' => 'ID of the contact to keep',
1153     'description' => ts('Wow - these 2 params are the logical reverse of what I expect - but what to do?'),
1154     'api.required' => 1,
1155     'type' => CRM_Utils_Type::T_INT,
1156     'api.aliases' => array('other_id'),
1157   );
1158   $params['mode'] = array(
1159     // @todo need more detail on what this means.
1160     'title' => 'Dedupe mode',
1161     'api.default' => 'safe',
1162   );
1163 }
1164
1165 /**
1166  * Adjust metadata for contact_proximity api function.
1167  *
1168  * @param array $params
1169  */
1170 function _civicrm_api3_contact_proximity_spec(&$params) {
1171   $params['latitude'] = array(
1172     'title' => 'Latitude',
1173     'api.required' => 1,
1174     'type' => CRM_Utils_Type::T_STRING,
1175   );
1176   $params['longitude'] = array(
1177     'title' => 'Longitude',
1178     'api.required' => 1,
1179     'type' => CRM_Utils_Type::T_STRING,
1180   );
1181
1182   $params['unit'] = array(
1183     'title' => 'Unit of Measurement',
1184     'api.default' => 'meter',
1185     'type' => CRM_Utils_Type::T_STRING,
1186   );
1187 }
1188
1189 /**
1190  * Get contacts by proximity.
1191  *
1192  * @param array $params
1193  *
1194  * @return array
1195  * @throws Exception
1196  */
1197 function civicrm_api3_contact_proximity($params) {
1198   $latitude  = CRM_Utils_Array::value('latitude', $params);
1199   $longitude = CRM_Utils_Array::value('longitude', $params);
1200   $distance  = CRM_Utils_Array::value('distance', $params);
1201
1202   $unit = CRM_Utils_Array::value('unit', $params);
1203
1204   // check and ensure that lat/long and distance are floats
1205   if (
1206     !CRM_Utils_Rule::numeric($latitude) ||
1207     !CRM_Utils_Rule::numeric($longitude) ||
1208     !CRM_Utils_Rule::numeric($distance)
1209   ) {
1210     throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric'));
1211   }
1212
1213   if ($unit == "mile") {
1214     $conversionFactor = 1609.344;
1215   }
1216   else {
1217     $conversionFactor = 1000;
1218   }
1219   //Distance in meters
1220   $distance = $distance * $conversionFactor;
1221
1222   $whereClause = CRM_Contact_BAO_ProximityQuery::where($latitude, $longitude, $distance);
1223
1224   $query = "
1225 SELECT    civicrm_contact.id as contact_id,
1226           civicrm_contact.display_name as display_name
1227 FROM      civicrm_contact
1228 LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id
1229 WHERE     $whereClause
1230 ";
1231
1232   $dao = CRM_Core_DAO::executeQuery($query);
1233   $contacts = array();
1234   while ($dao->fetch()) {
1235     $contacts[] = $dao->toArray();
1236   }
1237
1238   return civicrm_api3_create_success($contacts, $params, 'Contact', 'get_by_location', $dao);
1239 }
1240
1241
1242 /**
1243  * Get parameters for getlist function.
1244  *
1245  * @see _civicrm_api3_generic_getlist_params
1246  *
1247  * @param array $request
1248  */
1249 function _civicrm_api3_contact_getlist_params(&$request) {
1250   // get the autocomplete options from settings
1251   $acpref = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1252     CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
1253       'contact_autocomplete_options'
1254     )
1255   );
1256
1257   // get the option values for contact autocomplete
1258   $acOptions = CRM_Core_OptionGroup::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
1259
1260   $list = array();
1261   foreach ($acpref as $value) {
1262     if ($value && !empty($acOptions[$value])) {
1263       $list[] = $acOptions[$value];
1264     }
1265   }
1266   // If we are doing quicksearch by a field other than name, make sure that field is added to results
1267   $field_name = CRM_Utils_String::munge($request['search_field']);
1268   // Unique name contact_id = id
1269   if ($field_name == 'contact_id') {
1270     $field_name = 'id';
1271   }
1272   // phone_numeric should be phone
1273   $searchField = str_replace('_numeric', '', $field_name);
1274   if (!in_array($searchField, $list)) {
1275     $list[] = $searchField;
1276   }
1277   $request['description_field'] = $list;
1278   $list[] = 'contact_type';
1279   $request['params']['return'] = array_unique(array_merge($list, $request['extra']));
1280   $request['params']['options']['sort'] = 'sort_name';
1281   // Contact api doesn't support array(LIKE => 'foo') syntax
1282   if (!empty($request['input'])) {
1283     $request['params'][$request['search_field']] = $request['input'];
1284     // Temporarily override wildcard setting
1285     if (Civi::settings()->get('includeWildCardInName') != $request['add_wildcard']) {
1286       Civi::$statics['civicrm_api3_contact_getlist']['override_wildcard'] = !$request['add_wildcard'];
1287       Civi::settings()->set('includeWildCardInName', $request['add_wildcard']);
1288     }
1289   }
1290 }
1291
1292 /**
1293  * Get output for getlist function.
1294  *
1295  * @see _civicrm_api3_generic_getlist_output
1296  *
1297  * @param array $result
1298  * @param array $request
1299  *
1300  * @return array
1301  */
1302 function _civicrm_api3_contact_getlist_output($result, $request) {
1303   $output = array();
1304   if (!empty($result['values'])) {
1305     $addressFields = array_intersect(array(
1306         'street_address',
1307         'city',
1308         'state_province',
1309         'country',
1310       ),
1311       $request['params']['return']);
1312     foreach ($result['values'] as $row) {
1313       $data = array(
1314         'id' => $row[$request['id_field']],
1315         'label' => $row[$request['label_field']],
1316         'description' => array(),
1317       );
1318       foreach ($request['description_field'] as $item) {
1319         if (!strpos($item, '_name') && !in_array($item, $addressFields) && !empty($row[$item])) {
1320           $data['description'][] = $row[$item];
1321         }
1322       }
1323       $address = array();
1324       foreach ($addressFields as $item) {
1325         if (!empty($row[$item])) {
1326           $address[] = $row[$item];
1327         }
1328       }
1329       if ($address) {
1330         $data['description'][] = implode(' ', $address);
1331       }
1332       if (!empty($request['image_field'])) {
1333         $data['image'] = isset($row[$request['image_field']]) ? $row[$request['image_field']] : '';
1334       }
1335       else {
1336         $data['icon_class'] = $row['contact_type'];
1337       }
1338       $output[] = $data;
1339     }
1340   }
1341   // Restore wildcard override by _civicrm_api3_contact_getlist_params
1342   if (isset(Civi::$statics['civicrm_api3_contact_getlist']['override_wildcard'])) {
1343     Civi::settings()->set('includeWildCardInName', Civi::$statics['civicrm_api3_contact_getlist']['override_wildcard']);
1344     unset(Civi::$statics['civicrm_api3_contact_getlist']['override_wildcard']);
1345   }
1346   return $output;
1347 }
1348
1349 /**
1350  * Check for duplicate contacts.
1351  *
1352  * @param array $params
1353  *   Params per getfields metadata.
1354  *
1355  * @return array
1356  *   API formatted array
1357  */
1358 function civicrm_api3_contact_duplicatecheck($params) {
1359   $dupes = CRM_Contact_BAO_Contact::getDuplicateContacts(
1360     $params['match'],
1361     $params['match']['contact_type'],
1362     'Unsupervised',
1363     array(),
1364     CRM_Utils_Array::value('check_permissions', $params),
1365     CRM_Utils_Array::value('dedupe_rule_id', $params)
1366   );
1367   $values = empty($dupes) ? array() : array_fill_keys($dupes, array());
1368   return civicrm_api3_create_success($values, $params, 'Contact', 'duplicatecheck');
1369 }
1370
1371 /**
1372  * Declare metadata for contact dedupe function.
1373  *
1374  * @param $params
1375  */
1376 function _civicrm_api3_contact_duplicatecheck_spec(&$params) {
1377   $params['dedupe_rule_id'] = array(
1378     'title' => 'Dedupe Rule ID (optional)',
1379     'description' => 'This will default to the built in unsupervised rule',
1380     'type' => CRM_Utils_Type::T_INT,
1381   );
1382   // @todo declare 'match' parameter. We don't have a standard for type = array yet.
1383 }