CRM/Contact/BAO/Contact.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33 class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact {
  34
  35   /**
  36    * SQL function used to format the phone_numeric field via trigger.
  37    * @see self::triggerInfo()
  38    *
  39    * Note that this is also used by the 4.3 upgrade script.
  40    * @see CRM_Upgrade_Incremental_php_FourThree
  41    */
  42   const DROP_STRIP_FUNCTION_43 = "DROP FUNCTION IF EXISTS civicrm_strip_non_numeric";
  43   const CREATE_STRIP_FUNCTION_43 = "
  44     CREATE FUNCTION civicrm_strip_non_numeric(input VARCHAR(255) CHARACTER SET utf8)
  45       RETURNS VARCHAR(255) CHARACTER SET utf8
  46       DETERMINISTIC
  47       NO SQL
  48     BEGIN
  49       DECLARE output   VARCHAR(255) CHARACTER SET utf8 DEFAULT '';
  50       DECLARE iterator INT          DEFAULT 1;
  51       WHILE iterator < (LENGTH(input) + 1) DO
  52         IF SUBSTRING(input, iterator, 1) IN ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9') THEN
  53           SET output = CONCAT(output, SUBSTRING(input, iterator, 1));
  54         END IF;
  55         SET iterator = iterator + 1;
  56       END WHILE;
  57       RETURN output;
  58     END";
  59
  60   /**
  61    * The types of communication preferences.
  62    *
  63    * @var array
  64    */
  65   static $_commPrefs = array(
  66     'do_not_phone',
  67     'do_not_email',
  68     'do_not_mail',
  69     'do_not_sms',
  70     'do_not_trade',
  71   );
  72
  73   /**
  74    * Types of greetings.
  75    *
  76    * @var array
  77    */
  78   static $_greetingTypes = array(
  79     'addressee',
  80     'email_greeting',
  81     'postal_greeting',
  82   );
  83
  84   /**
  85    * Static field for all the contact information that we can potentially import.
  86    *
  87    * @var array
  88    */
  89   static $_importableFields = array();
  90
  91   /**
  92    * Static field for all the contact information that we can potentially export.
  93    *
  94    * @var array
  95    */
  96   static $_exportableFields = NULL;
  97
  98   /**
  99    * Class constructor.
 100    */
 101   public function __construct() {
 102     parent::__construct();
 103   }
 104
 105   /**
 106    * Takes an associative array and creates a contact object.
 107    *
 108    * The function extracts all the params it needs to initialize the create a
 109    * contact object. the params array could contain additional unused name/value
 110    * pairs
 111    *
 112    * @param array $params
 113    *   (reference) an assoc array of name/value pairs.
 114    *
 115    * @return CRM_Contact_BAO_Contact|CRM_Core_Error|NULL
 116    *   Created or updated contact object or error object.
 117    *   (error objects are being phased out in favour of exceptions)
 118    */
 119   public static function add(&$params) {
 120     $contact = new CRM_Contact_DAO_Contact();
 121
 122     if (empty($params)) {
 123       return NULL;
 124     }
 125
 126     // Fix for validate contact sub type CRM-5143.
 127     if (isset($params['contact_sub_type'])) {
 128       if (empty($params['contact_sub_type'])) {
 129         $params['contact_sub_type'] = 'null';
 130       }
 131       else {
 132         if (!CRM_Contact_BAO_ContactType::isExtendsContactType($params['contact_sub_type'],
 133           $params['contact_type'], TRUE
 134         )
 135         ) {
 136           // we'll need to fix tests to handle this
 137           // CRM-7925
 138           CRM_Core_Error::fatal(ts('The Contact Sub Type does not match the Contact type for this record'));
 139         }
 140         $params['contact_sub_type'] = CRM_Utils_Array::implodePadded($params['contact_sub_type']);
 141       }
 142     }
 143     else {
 144       // Reset the value.
 145       // CRM-101XX.
 146       $params['contact_sub_type'] = 'null';
 147     }
 148
 149     // Fixed contact source.
 150     if (isset($params['contact_source'])) {
 151       $params['source'] = $params['contact_source'];
 152     }
 153
 154     if (isset($params['preferred_communication_method']) && is_array($params['preferred_communication_method'])) {
 155       CRM_Utils_Array::formatArrayKeys($params['preferred_communication_method']);
 156       $contact->preferred_communication_method = CRM_Utils_Array::implodePadded($params['preferred_communication_method']);
 157       unset($params['preferred_communication_method']);
 158     }
 159
 160     $allNull = $contact->copyValues($params);
 161
 162     $contact->id = CRM_Utils_Array::value('contact_id', $params);
 163
 164     if ($contact->contact_type == 'Individual') {
 165       $allNull = FALSE;
 166
 167       // Format individual fields.
 168       CRM_Contact_BAO_Individual::format($params, $contact);
 169     }
 170     elseif ($contact->contact_type == 'Household') {
 171       if (isset($params['household_name'])) {
 172         $allNull = FALSE;
 173         $contact->display_name = $contact->sort_name = CRM_Utils_Array::value('household_name', $params, '');
 174       }
 175     }
 176     elseif ($contact->contact_type == 'Organization') {
 177       if (isset($params['organization_name'])) {
 178         $allNull = FALSE;
 179         $contact->display_name = $contact->sort_name = CRM_Utils_Array::value('organization_name', $params, '');
 180       }
 181     }
 182     if (strlen($contact->display_name) > 128) {
 183       $contact->display_name = substr($contact->display_name, 0, 128);
 184     }
 185     if (strlen($contact->sort_name) > 128) {
 186       $contact->sort_name = substr($contact->sort_name, 0, 128);
 187     }
 188
 189     $privacy = CRM_Utils_Array::value('privacy', $params);
 190     if ($privacy &&
 191       is_array($privacy) &&
 192       !empty($privacy)
 193     ) {
 194       $allNull = FALSE;
 195       foreach (self::$_commPrefs as $name) {
 196         $contact->$name = CRM_Utils_Array::value($name, $privacy, FALSE);
 197       }
 198     }
 199
 200     // Since hash was required, make sure we have a 0 value for it (CRM-1063).
 201     // @todo - does this mean we can remove this block?
 202     // Fixed in 1.5 by making hash optional, only do this in create mode, not update.
 203     if ((!array_key_exists('hash', $contact) || !$contact->hash) && !$contact->id) {
 204       $allNull = FALSE;
 205       $contact->hash = md5(uniqid(rand(), TRUE));
 206     }
 207
 208     // Even if we don't need $employerId, it's important to call getFieldValue() before
 209     // the contact is saved because we want the existing value to be cached.
 210     // createCurrentEmployerRelationship() needs the old value not the updated one. CRM-10788
 211     $employerId = empty($contact->id) ? NULL : CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contact->id, 'employer_id');
 212
 213     if (!$allNull) {
 214       $contact->save();
 215
 216       CRM_Core_BAO_Log::register($contact->id,
 217         'civicrm_contact',
 218         $contact->id
 219       );
 220     }
 221
 222     if ($contact->contact_type == 'Individual' && (isset($params['current_employer']) || isset($params['employer_id']))) {
 223       // Create current employer.
 224       $newEmployer = !empty($params['employer_id']) ? $params['employer_id'] : CRM_Utils_Array::value('current_employer', $params);
 225
 226       $newContact = FALSE;
 227       if (empty($params['contact_id'])) {
 228         $newContact = TRUE;
 229       }
 230       if ($newEmployer) {
 231         CRM_Contact_BAO_Contact_Utils::createCurrentEmployerRelationship($contact->id, $newEmployer, $employerId, $newContact);
 232       }
 233       else {
 234         if ($employerId) {
 235           CRM_Contact_BAO_Contact_Utils::clearCurrentEmployer($contact->id, $employerId);
 236         }
 237       }
 238     }
 239
 240     // Update cached employer name.
 241     if ($contact->contact_type == 'Organization') {
 242       CRM_Contact_BAO_Contact_Utils::updateCurrentEmployer($contact->id);
 243     }
 244
 245     return $contact;
 246   }
 247
 248   /**
 249    * Create contact.
 250    *
 251    * takes an associative array and creates a contact object and all the associated
 252    * derived objects (i.e. individual, location, email, phone etc)
 253    *
 254    * This function is invoked from within the web form layer and also from the api layer
 255    *
 256    * @param array $params
 257    *   (reference ) an assoc array of name/value pairs.
 258    * @param bool $fixAddress
 259    *   If we need to fix address.
 260    * @param bool $invokeHooks
 261    *   If we need to invoke hooks.
 262    *
 263    * @param bool $skipDelete
 264    *   Unclear parameter, passed to website create
 265    *
 266    * @todo explain this parameter
 267    *
 268    * @throws Exception
 269    * @return CRM_Contact_BAO_Contact|CRM_Core_Error
 270    *   Created or updated contribution object. We are deprecating returning an error in
 271    *   favour of exceptions
 272    */
 273   public static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) {
 274     $contact = NULL;
 275     if (empty($params['contact_type']) && empty($params['contact_id'])) {
 276       return $contact;
 277     }
 278
 279     $isEdit = TRUE;
 280     if ($invokeHooks) {
 281       if (!empty($params['contact_id'])) {
 282         CRM_Utils_Hook::pre('edit', $params['contact_type'], $params['contact_id'], $params);
 283       }
 284       else {
 285         CRM_Utils_Hook::pre('create', $params['contact_type'], NULL, $params);
 286         $isEdit = FALSE;
 287       }
 288     }
 289
 290     self::ensureGreetingParamsAreSet($params);
 291
 292     // CRM-6942: set preferred language to the current language if it’s unset (and we’re creating a contact).
 293     if (empty($params['contact_id'])) {
 294       // A case could be made for checking isset rather than empty but this is more consistent with previous behaviour.
 295       if (empty($params['preferred_language']) && ($language = CRM_Core_I18n::getContactDefaultLanguage()) != FALSE) {
 296         $params['preferred_language'] = $language;
 297       }
 298
 299       // CRM-21041: set default 'Communication Style' if unset when creating a contact.
 300       if (empty($params['communication_style_id'])) {
 301         $defaultCommunicationStyleId = CRM_Core_OptionGroup::values('communication_style', TRUE, NULL, NULL, 'AND is_default = 1');
 302         $params['communication_style_id'] = array_pop($defaultCommunicationStyleId);
 303       }
 304     }
 305
 306     $transaction = new CRM_Core_Transaction();
 307
 308     $contact = self::add($params);
 309     if (!$contact) {
 310       // Not dying here is stupid, since we get into weird situation and into a bug that
 311       // is impossible to figure out for the user or for us
 312       // CRM-7925
 313       CRM_Core_Error::fatal();
 314     }
 315
 316     $params['contact_id'] = $contact->id;
 317
 318     if (Civi::settings()->get('is_enabled')) {
 319       // Enabling multisite causes the contact to be added to the domain group.
 320       $domainGroupID = CRM_Core_BAO_Domain::getGroupId();
 321       if (!empty($domainGroupID)) {
 322         if (!empty($params['group']) && is_array($params['group'])) {
 323           $params['group'][$domainGroupID] = 1;
 324         }
 325         else {
 326           $params['group'] = array($domainGroupID => 1);
 327         }
 328       }
 329     }
 330
 331     if (array_key_exists('group', $params)) {
 332       $contactIds = array($params['contact_id']);
 333       foreach ($params['group'] as $groupId => $flag) {
 334         if ($flag == 1) {
 335           CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId);
 336         }
 337         elseif ($flag == -1) {
 338           CRM_Contact_BAO_GroupContact::removeContactsFromGroup($contactIds, $groupId);
 339         }
 340       }
 341     }
 342
 343     // Add location Block data.
 344     $blocks = CRM_Core_BAO_Location::create($params, $fixAddress);
 345     foreach ($blocks as $name => $value) {
 346       $contact->$name = $value;
 347     }
 348     if (!empty($params['updateBlankLocInfo'])) {
 349       $skipDelete = TRUE;
 350     }
 351
 352     if (isset($params['website'])) {
 353       CRM_Core_BAO_Website::process($params['website'], $contact->id, $skipDelete);
 354     }
 355
 356     $userID = CRM_Core_Session::singleton()->get('userID');
 357     // add notes
 358     if (!empty($params['note'])) {
 359       if (is_array($params['note'])) {
 360         foreach ($params['note'] as $note) {
 361           $contactId = $contact->id;
 362           if (isset($note['contact_id'])) {
 363             $contactId = $note['contact_id'];
 364           }
 365           //if logged in user, overwrite contactId
 366           if ($userID) {
 367             $contactId = $userID;
 368           }
 369
 370           $noteParams = array(
 371             'entity_id' => $contact->id,
 372             'entity_table' => 'civicrm_contact',
 373             'note' => $note['note'],
 374             'subject' => CRM_Utils_Array::value('subject', $note),
 375             'contact_id' => $contactId,
 376           );
 377           CRM_Core_BAO_Note::add($noteParams, CRM_Core_DAO::$_nullArray);
 378         }
 379       }
 380       else {
 381         $contactId = $contact->id;
 382         //if logged in user, overwrite contactId
 383         if ($userID) {
 384           $contactId = $userID;
 385         }
 386
 387         $noteParams = array(
 388           'entity_id' => $contact->id,
 389           'entity_table' => 'civicrm_contact',
 390           'note' => $params['note'],
 391           'subject' => CRM_Utils_Array::value('subject', $params),
 392           'contact_id' => $contactId,
 393         );
 394         CRM_Core_BAO_Note::add($noteParams, CRM_Core_DAO::$_nullArray);
 395       }
 396     }
 397
 398     // update the UF user_unique_id if that has changed
 399     CRM_Core_BAO_UFMatch::updateUFName($contact->id);
 400
 401     if (!empty($params['custom']) &&
 402       is_array($params['custom'])
 403     ) {
 404       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contact', $contact->id);
 405     }
 406
 407     // make a civicrm_subscription_history entry only on contact create (CRM-777)
 408     if (empty($params['contact_id'])) {
 409       $subscriptionParams = array(
 410         'contact_id' => $contact->id,
 411         'status' => 'Added',
 412         'method' => 'Admin',
 413       );
 414       CRM_Contact_BAO_SubscriptionHistory::create($subscriptionParams);
 415     }
 416
 417     $transaction->commit();
 418
 419     // CRM-6367: fetch the right label for contact type’s display
 420     $contact->contact_type_display = CRM_Core_DAO::getFieldValue(
 421       'CRM_Contact_DAO_ContactType',
 422       $contact->contact_type,
 423       'label',
 424       'name'
 425     );
 426
 427     CRM_Contact_BAO_Contact_Utils::clearContactCaches();
 428
 429     if ($invokeHooks) {
 430       if ($isEdit) {
 431         CRM_Utils_Hook::post('edit', $params['contact_type'], $contact->id, $contact);
 432       }
 433       else {
 434         CRM_Utils_Hook::post('create', $params['contact_type'], $contact->id, $contact);
 435       }
 436     }
 437
 438     // In order to prevent a series of expensive queries in intensive batch processing
 439     // api calls may pass in skip_greeting_processing, probably doing it later via the
 440     // scheduled job. CRM-21551
 441     if (empty($params['skip_greeting_processing'])) {
 442       self::processGreetings($contact);
 443     }
 444
 445     return $contact;
 446   }
 447
 448   /**
 449    * Ensure greeting parameters are set.
 450    *
 451    * By always populating greetings here we can be sure they are set if required & avoid a call later.
 452    * (ie. knowing we have definitely tried disambiguates between NULL & not loaded.)
 453    *
 454    * @param array $params
 455    */
 456   public static function ensureGreetingParamsAreSet(&$params) {
 457     $allGreetingParams = array('addressee' => 'addressee_id', 'postal_greeting' => 'postal_greeting_id', 'email_greeting' => 'email_greeting_id');
 458     $missingGreetingParams = array();
 459
 460     foreach ($allGreetingParams as $greetingIndex => $greetingParam) {
 461       if (empty($params[$greetingParam])) {
 462         $missingGreetingParams[$greetingIndex] = $greetingParam;
 463       }
 464     }
 465
 466     if (!empty($params['contact_id']) && !empty($missingGreetingParams)) {
 467       $savedGreetings = civicrm_api3('Contact', 'getsingle', array(
 468         'id' => $params['contact_id'],
 469         'return' => array_keys($missingGreetingParams))
 470       );
 471
 472       foreach (array_keys($missingGreetingParams) as $missingGreetingParam) {
 473         if (!empty($savedGreetings[$missingGreetingParam . '_custom'])) {
 474           $missingGreetingParams[$missingGreetingParam . '_custom'] = $missingGreetingParam . '_custom';
 475         }
 476       }
 477       // Filter out other fields.
 478       $savedGreetings = array_intersect_key($savedGreetings, array_flip($missingGreetingParams));
 479       $params = array_merge($params, $savedGreetings);
 480     }
 481     else {
 482       foreach ($missingGreetingParams as $greetingName => $greeting) {
 483         $params[$greeting] = CRM_Contact_BAO_Contact_Utils::defaultGreeting($params['contact_type'], $greetingName);
 484       }
 485     }
 486
 487     foreach ($allGreetingParams as $greetingIndex => $greetingParam) {
 488       if ($params[$greetingParam] === 'null') {
 489         //  If we are setting it to null then null out the display field.
 490         $params[$greetingIndex . '_display'] = 'null';
 491       }
 492     }
 493   }
 494
 495   /**
 496    * Get the display name and image of a contact.
 497    *
 498    * @param int $id
 499    *   The contactId.
 500    *
 501    * @param bool $includeTypeInReturnParameters
 502    *   Should type be part of the returned array?
 503    *
 504    * @return array
 505    *   the displayName and contactImage for this contact
 506    */
 507   public static function getDisplayAndImage($id, $includeTypeInReturnParameters = FALSE) {
 508     //CRM-14276 added the * on the civicrm_contact table so that we have all the contact info available
 509     $sql = "
 510 SELECT    civicrm_contact.*,
 511           civicrm_email.email          as email
 512 FROM      civicrm_contact
 513 LEFT JOIN civicrm_email ON civicrm_email.contact_id = civicrm_contact.id
 514      AND  civicrm_email.is_primary = 1
 515 WHERE     civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer');
 516     $dao = new CRM_Core_DAO();
 517     $dao->query($sql);
 518     if ($dao->fetch()) {
 519       $image = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ?
 520           $dao->contact_sub_type : $dao->contact_type, FALSE, $id
 521       );
 522       $imageUrl = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ?
 523           $dao->contact_sub_type : $dao->contact_type, TRUE, $id
 524       );
 525
 526       // use email if display_name is empty
 527       if (empty($dao->display_name)) {
 528         $displayName = $dao->email;
 529       }
 530       else {
 531         $displayName = $dao->display_name;
 532       }
 533
 534       CRM_Utils_Hook::alterDisplayName($displayName, $id, $dao);
 535
 536       return $includeTypeInReturnParameters ? array(
 537         $displayName,
 538         $image,
 539         $dao->contact_type,
 540         $dao->contact_sub_type,
 541         $imageUrl,
 542       ) : array($displayName, $image, $imageUrl);
 543     }
 544     return NULL;
 545   }
 546
 547   /**
 548    * Add billing fields to the params if appropriate.
 549    *
 550    * If we have ANY name fields then we want to ignore all the billing name fields. However, if we
 551    * don't then we should set the name fields to the filling fields AND add the preserveDBName
 552    * parameter (which will tell the BAO only to set those fields if none already exist.
 553    *
 554    * We specifically don't want to set first name from billing and last name form an on-page field. Mixing &
 555    * matching is best done by hipsters.
 556    *
 557    * @param array $params
 558    */
 559   public static function addBillingNameFieldsIfOtherwiseNotSet(&$params) {
 560     $nameFields = array('first_name', 'middle_name', 'last_name', 'nick_name', 'prefix_id', 'suffix_id');
 561     foreach ($nameFields as $field) {
 562       if (!empty($params[$field])) {
 563         return;
 564       }
 565     }
 566     // There are only 3 - we can iterate through them twice :-)
 567     foreach ($nameFields as $field) {
 568       if (!empty($params['billing_' . $field])) {
 569         $params[$field] = $params['billing_' . $field];
 570       }
 571       $params['preserveDBName'] = TRUE;
 572     }
 573
 574   }
 575
 576   /**
 577    * Resolve a state province string (UT or Utah) to an ID.
 578    *
 579    * If country has been passed in we should select a state belonging to that country.
 580    *
 581    * Alternatively we should choose from enabled countries, prioritising the default country.
 582    *
 583    * @param array $values
 584    * @param int|NULL $countryID
 585    *
 586    * @return int|null
 587    */
 588   protected static function resolveStateProvinceID($values, $countryID) {
 589
 590     if ($countryID) {
 591       $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceForCountry($countryID);
 592       if (CRM_Utils_Array::lookupValue($values,
 593         'state_province',
 594         $stateProvinceList,
 595         TRUE
 596       )) {
 597         return $values['state_province_id'];
 598       }
 599       $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceForCountry($countryID, 'abbreviation');
 600       if (CRM_Utils_Array::lookupValue($values,
 601         'state_province',
 602         $stateProvinceList,
 603         TRUE
 604       )) {
 605         return $values['state_province_id'];
 606       }
 607       return NULL;
 608     }
 609     else {
 610       // The underlying lookupValue function needs some de-fanging. Until that has been unravelled we
 611       // continue to resolve stateprovince lists in descending order of preference & just 'keep trying'.
 612       // prefer matching country..
 613       $stateProvinceList = CRM_Core_BAO_Address::buildOptions('state_province_id', NULL, array('country_id' => Civi::settings()->get('defaultContactCountry')));
 614       if (CRM_Utils_Array::lookupValue($values,
 615         'state_province',
 616         $stateProvinceList,
 617         TRUE
 618       )) {
 619         return $values['state_province_id'];
 620       }
 621
 622       $stateProvinceList = CRM_Core_PseudoConstant::stateProvince();
 623       if (CRM_Utils_Array::lookupValue($values,
 624         'state_province',
 625         $stateProvinceList,
 626         TRUE
 627       )) {
 628         return $values['state_province_id'];
 629       }
 630
 631       $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceAbbreviationForDefaultCountry();
 632       if (CRM_Utils_Array::lookupValue($values,
 633         'state_province',
 634         $stateProvinceList,
 635         TRUE
 636       )) {
 637         return $values['state_province_id'];
 638       }
 639       $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceAbbreviation();
 640       if (CRM_Utils_Array::lookupValue($values,
 641         'state_province',
 642         $stateProvinceList,
 643         TRUE
 644       )) {
 645         return $values['state_province_id'];
 646       }
 647     }
 648
 649     return NULL;
 650   }
 651
 652   /**
 653    * Get the relevant location entity for the array key.
 654    *
 655    * Based on the field name we determine which location entity
 656    * we are dealing with. Apart from a few specific ones they
 657    * are mostly 'address' (the default).
 658    *
 659    * @param string $fieldName
 660    *
 661    * @return string
 662    */
 663   protected static function getLocationEntityForKey($fieldName) {
 664     if (in_array($fieldName, ['email', 'phone', 'im', 'openid'])) {
 665       return $fieldName;
 666     }
 667     if ($fieldName === 'phone_ext') {
 668       return 'phone';
 669     }
 670     return 'address';
 671   }
 672
 673   /**
 674    * Create last viewed link to recently updated contact.
 675    *
 676    * @param array $crudLinkSpec
 677    *  - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
 678    *  - entity_table: string, eg "civicrm_contact"
 679    *  - entity_id: int
 680    *
 681    * @return array|NULL
 682    *   NULL if unavailable, or
 683    *   [path: string, query: string, title: string]
 684    * @see CRM_Utils_System::createDefaultCrudLink
 685    */
 686   public function createDefaultCrudLink($crudLinkSpec) {
 687     switch ($crudLinkSpec['action']) {
 688       case CRM_Core_Action::VIEW:
 689         $result = array(
 690           'title' => $this->display_name,
 691           'path' => 'civicrm/contact/view',
 692           'query' => array(
 693             'reset' => 1,
 694             'cid' => $this->id,
 695           ),
 696         );
 697         return $result;
 698
 699       case CRM_Core_Action::UPDATE:
 700         $result = array(
 701           'title' => $this->display_name,
 702           'path' => 'civicrm/contact/add',
 703           'query' => array(
 704             'reset' => 1,
 705             'action' => 'update',
 706             'cid' => $this->id,
 707           ),
 708         );
 709         return $result;
 710     }
 711     return NULL;
 712   }
 713
 714   /**
 715    * Get the values for pseudoconstants for name->value and reverse.
 716    *
 717    * @deprecated
 718    *
 719    * This is called specifically from the contact import parser & should be moved there
 720    * as it is not truly a generic function.
 721    *
 722    * @param array $defaults
 723    *   (reference) the default values, some of which need to be resolved.
 724    * @param bool $reverse
 725    *   Always true as this function is only called from one place..
 726    */
 727   public static function resolveDefaults(&$defaults, $reverse = FALSE) {
 728     // Hack for birth_date.
 729     if (!empty($defaults['birth_date'])) {
 730       if (is_array($defaults['birth_date'])) {
 731         $defaults['birth_date'] = CRM_Utils_Date::format($defaults['birth_date'], '-');
 732       }
 733     }
 734
 735     CRM_Utils_Array::lookupValue($defaults, 'prefix', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id'), $reverse);
 736     CRM_Utils_Array::lookupValue($defaults, 'suffix', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id'), $reverse);
 737     CRM_Utils_Array::lookupValue($defaults, 'gender', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'), $reverse);
 738     CRM_Utils_Array::lookupValue($defaults, 'communication_style', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'communication_style_id'), $reverse);
 739
 740     //lookup value of email/postal greeting, addressee, CRM-4575
 741     foreach (self::$_greetingTypes as $greeting) {
 742       $filterCondition = array(
 743         'contact_type' => CRM_Utils_Array::value('contact_type', $defaults),
 744         'greeting_type' => $greeting,
 745       );
 746       CRM_Utils_Array::lookupValue($defaults, $greeting,
 747         CRM_Core_PseudoConstant::greeting($filterCondition), $reverse
 748       );
 749     }
 750
 751     $blocks = array('address', 'im', 'phone');
 752     foreach ($blocks as $name) {
 753       if (!array_key_exists($name, $defaults) || !is_array($defaults[$name])) {
 754         continue;
 755       }
 756       foreach ($defaults[$name] as $count => & $values) {
 757
 758         //get location type id.
 759         CRM_Utils_Array::lookupValue($values, 'location_type', CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'), $reverse);
 760
 761         if ($name == 'address') {
 762           // FIXME: lookupValue doesn't work for vcard_name
 763           if (!empty($values['location_type_id'])) {
 764             $vcardNames = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'vcard_name'));
 765             $values['vcard_name'] = $vcardNames[$values['location_type_id']];
 766           }
 767
 768           if (!CRM_Utils_Array::lookupValue($values,
 769               'country',
 770               CRM_Core_PseudoConstant::country(),
 771               $reverse
 772             ) &&
 773             $reverse
 774           ) {
 775             CRM_Utils_Array::lookupValue($values,
 776               'country',
 777               CRM_Core_PseudoConstant::countryIsoCode(),
 778               $reverse
 779             );
 780           }
 781           $stateProvinceID = self::resolveStateProvinceID($values, CRM_Utils_Array::value('country_id', $values));
 782           if ($stateProvinceID) {
 783             $values['state_province_id'] = $stateProvinceID;
 784           }
 785
 786           if (!empty($values['state_province_id'])) {
 787             $countyList = CRM_Core_PseudoConstant::countyForState($values['state_province_id']);
 788           }
 789           else {
 790             $countyList = CRM_Core_PseudoConstant::county();
 791           }
 792           CRM_Utils_Array::lookupValue($values,
 793             'county',
 794             $countyList,
 795             $reverse
 796           );
 797         }
 798
 799         if ($name == 'im') {
 800           CRM_Utils_Array::lookupValue($values,
 801             'provider',
 802             CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'),
 803             $reverse
 804           );
 805         }
 806
 807         if ($name == 'phone') {
 808           CRM_Utils_Array::lookupValue($values,
 809             'phone_type',
 810             CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'),
 811             $reverse
 812           );
 813         }
 814
 815         // Kill the reference.
 816         unset($values);
 817       }
 818     }
 819   }
 820
 821   /**
 822    * Fetch object based on array of properties.
 823    *
 824    * @param array $params
 825    *   (reference ) an assoc array of name/value pairs.
 826    * @param array $defaults
 827    *   (reference ) an assoc array to hold the name / value pairs.
 828    *                        in a hierarchical manner
 829    * @param bool $microformat
 830    *   For location in microformat.
 831    *
 832    * @return CRM_Contact_BAO_Contact
 833    */
 834   public static function &retrieve(&$params, &$defaults, $microformat = FALSE) {
 835     if (array_key_exists('contact_id', $params)) {
 836       $params['id'] = $params['contact_id'];
 837     }
 838     elseif (array_key_exists('id', $params)) {
 839       $params['contact_id'] = $params['id'];
 840     }
 841
 842     $contact = self::getValues($params, $defaults);
 843
 844     unset($params['id']);
 845
 846     //get the block information for this contact
 847     $entityBlock = array('contact_id' => $params['contact_id']);
 848     $blocks = CRM_Core_BAO_Location::getValues($entityBlock, $microformat);
 849     $defaults = array_merge($defaults, $blocks);
 850     foreach ($blocks as $block => $value) {
 851       $contact->$block = $value;
 852     }
 853
 854     if (!isset($params['noNotes'])) {
 855       $contact->notes = CRM_Core_BAO_Note::getValues($params, $defaults);
 856     }
 857
 858     if (!isset($params['noRelationships'])) {
 859       $contact->relationship = CRM_Contact_BAO_Relationship::getValues($params, $defaults);
 860     }
 861
 862     if (!isset($params['noGroups'])) {
 863       $contact->groupContact = CRM_Contact_BAO_GroupContact::getValues($params, $defaults);
 864     }
 865
 866     if (!isset($params['noWebsite'])) {
 867       $contact->website = CRM_Core_BAO_Website::getValues($params, $defaults);
 868     }
 869
 870     return $contact;
 871   }
 872
 873   /**
 874    * Get the display name of a contact.
 875    *
 876    * @param int $id
 877    *   Id of the contact.
 878    *
 879    * @return null|string
 880    *   display name of the contact if found
 881    */
 882   public static function displayName($id) {
 883     $displayName = NULL;
 884     if ($id) {
 885       $displayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'display_name');
 886     }
 887
 888     return $displayName;
 889   }
 890
 891   /**
 892    * Delete a contact and all its associated records.
 893    *
 894    * @param int $id
 895    *   Id of the contact to delete.
 896    * @param bool $restore
 897    *   Whether to actually restore, not delete.
 898    * @param bool $skipUndelete
 899    *   Whether to force contact delete or not.
 900    * @param bool $checkPermissions
 901    *
 902    * @return bool
 903    *   Was contact deleted?
 904    */
 905   public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE, $checkPermissions = TRUE) {
 906
 907     if (!$id) {
 908       return FALSE;
 909     }
 910     // If trash is disabled in system settings then we always skip
 911     if (!Civi::settings()->get('contact_undelete')) {
 912       $skipUndelete = TRUE;
 913     }
 914
 915     // make sure we have edit permission for this contact
 916     // before we delete
 917     if ($checkPermissions && (($skipUndelete && !CRM_Core_Permission::check('delete contacts')) ||
 918       ($restore && !CRM_Core_Permission::check('access deleted contacts')))
 919     ) {
 920       return FALSE;
 921     }
 922
 923     // CRM-12929
 924     // Restrict contact to be delete if contact has financial trxns
 925     $error = NULL;
 926     if ($skipUndelete && CRM_Financial_BAO_FinancialItem::checkContactPresent(array($id), $error)) {
 927       return FALSE;
 928     }
 929
 930     // make sure this contact_id does not have any membership types
 931     $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 932       $id,
 933       'id',
 934       'member_of_contact_id'
 935     );
 936     if ($membershipTypeID) {
 937       return FALSE;
 938     }
 939
 940     $contact = new CRM_Contact_DAO_Contact();
 941     $contact->id = $id;
 942     if (!$contact->find(TRUE)) {
 943       return FALSE;
 944     }
 945
 946     $contactType = $contact->contact_type;
 947     // currently we only clear employer cache.
 948     // we are now deleting inherited membership if any.
 949     if ($contact->contact_type == 'Organization') {
 950       $action = $restore ? CRM_Core_Action::ENABLE : CRM_Core_Action::DISABLE;
 951       $relationshipDtls = CRM_Contact_BAO_Relationship::getRelationship($id);
 952       if (!empty($relationshipDtls)) {
 953         foreach ($relationshipDtls as $rId => $details) {
 954           CRM_Contact_BAO_Relationship::disableEnableRelationship($rId, $action);
 955         }
 956       }
 957       CRM_Contact_BAO_Contact_Utils::clearAllEmployee($id);
 958     }
 959
 960     if ($restore) {
 961       return self::contactTrashRestore($contact, TRUE);
 962     }
 963
 964     // start a new transaction
 965     $transaction = new CRM_Core_Transaction();
 966
 967     if ($skipUndelete) {
 968       CRM_Utils_Hook::pre('delete', $contactType, $id, CRM_Core_DAO::$_nullArray);
 969
 970       //delete billing address if exists.
 971       CRM_Contribute_BAO_Contribution::deleteAddress(NULL, $id);
 972
 973       // delete the log entries since we dont have triggers enabled as yet
 974       $logDAO = new CRM_Core_DAO_Log();
 975       $logDAO->entity_table = 'civicrm_contact';
 976       $logDAO->entity_id = $id;
 977       $logDAO->delete();
 978
 979       // delete contact participants CRM-12155
 980       CRM_Event_BAO_Participant::deleteContactParticipant($id);
 981
 982       // delete contact contributions CRM-12155
 983       CRM_Contribute_BAO_Contribution::deleteContactContribution($id);
 984
 985       // do activity cleanup, CRM-5604
 986       CRM_Activity_BAO_Activity::cleanupActivity($id);
 987
 988       // delete all notes related to contact
 989       CRM_Core_BAO_Note::cleanContactNotes($id);
 990
 991       // delete cases related to contact
 992       $contactCases = CRM_Case_BAO_Case::retrieveCaseIdsByContactId($id);
 993       if (!empty($contactCases)) {
 994         foreach ($contactCases as $caseId) {
 995           //check if case is associate with other contact or not.
 996           $caseContactId = CRM_Case_BAO_Case::getCaseClients($caseId);
 997           if (count($caseContactId) <= 1) {
 998             CRM_Case_BAO_Case::deleteCase($caseId);
 999           }
1000         }
1001       }
1002
1003       $contact->delete();
1004     }
1005     else {
1006       self::contactTrashRestore($contact);
1007     }
1008
1009     //delete the contact id from recently view
1010     CRM_Utils_Recent::delContact($id);
1011     self::updateContactCache($id, empty($restore));
1012
1013     // delete any prevnext/dupe cache entry
1014     // These two calls are redundant in default deployments, but they're
1015     // meaningful if "prevnext" is memory-backed.
1016     Civi::service('prevnext')->deleteItem($id);
1017     CRM_Core_BAO_PrevNextCache::deleteItem($id);
1018
1019     $transaction->commit();
1020
1021     if ($skipUndelete) {
1022       CRM_Utils_Hook::post('delete', $contactType, $contact->id, $contact);
1023     }
1024
1025     return TRUE;
1026   }
1027
1028   /**
1029    * Action to update any caches relating to a recently update contact.
1030    *
1031    * I was going to call this from delete as well as from create to ensure the delete is being
1032    * done whenever a contact is set to is_deleted=1 BUT I found create is already over-aggressive in
1033    * that regard so adding it to delete seems to be enough to remove it from CRM_Contact_BAO_Contact_Permission
1034    * where the call involved a subquery that was locking the table.
1035    *
1036    * @param int $contactID
1037    * @param bool $isTrashed
1038    */
1039   public static function updateContactCache($contactID, $isTrashed = FALSE) {
1040
1041     if ($isTrashed) {
1042       CRM_Contact_BAO_GroupContactCache::removeContact($contactID);
1043       // This has been moved to here from CRM_Contact_BAO_Contact_Permission as that was causing
1044       // a table-locking query. It still seems a bit inadequate as it assumes the acl users can't see deleted
1045       // but this should not cause any change as long as contacts are not being trashed outside the
1046       // main functions for that.
1047       CRM_Core_DAO::executeQuery('DELETE FROM civicrm_acl_contact_cache WHERE contact_id = %1', array(1 => array($contactID, 'Integer')));
1048     }
1049     else {
1050       CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
1051     }
1052   }
1053
1054   /**
1055    * Delete the image of a contact.
1056    *
1057    * @param int $id
1058    *   Id of the contact.
1059    *
1060    * @return bool
1061    *   Was contact image deleted?
1062    */
1063   public static function deleteContactImage($id) {
1064     if (!$id) {
1065       return FALSE;
1066     }
1067
1068     $contact = new self();
1069     $contact->id = $id;
1070     $contact->image_URL = 'null';
1071     $contact->save();
1072
1073     return TRUE;
1074   }
1075
1076   /**
1077    * Return proportional height and width of the image.
1078    *
1079    * @param int $imageWidth
1080    *   Width of image.
1081    *
1082    * @param int $imageHeight
1083    *   Height of image.
1084    *
1085    * @return array
1086    *   Thumb dimension of image
1087    */
1088   public static function getThumbSize($imageWidth, $imageHeight) {
1089     $thumbWidth = 100;
1090     if ($imageWidth && $imageHeight) {
1091       $imageRatio = $imageWidth / $imageHeight;
1092     }
1093     else {
1094       $imageRatio = 1;
1095     }
1096     if ($imageRatio > 1) {
1097       $imageThumbWidth = $thumbWidth;
1098       $imageThumbHeight = round($thumbWidth / $imageRatio);
1099     }
1100     else {
1101       $imageThumbHeight = $thumbWidth;
1102       $imageThumbWidth = round($thumbWidth * $imageRatio);
1103     }
1104
1105     return array($imageThumbWidth, $imageThumbHeight);
1106   }
1107
1108   /**
1109    * Validate type of contact image.
1110    *
1111    * @param array $params
1112    * @param string $imageIndex
1113    *   Index of image field.
1114    * @param string $statusMsg
1115    *   Status message to be set after operation.
1116    * @param string $opType
1117    *   Type of operation like fatal, bounce etc.
1118    *
1119    * @return bool
1120    *   true if valid image extension
1121    */
1122   public static function processImageParams(
1123     &$params,
1124     $imageIndex = 'image_URL',
1125     $statusMsg = NULL,
1126     $opType = 'status'
1127   ) {
1128     $mimeType = array(
1129       'image/jpeg',
1130       'image/jpg',
1131       'image/png',
1132       'image/bmp',
1133       'image/p-jpeg',
1134       'image/gif',
1135       'image/x-png',
1136     );
1137
1138     if (in_array($params[$imageIndex]['type'], $mimeType)) {
1139       $photo = basename($params[$imageIndex]['name']);
1140       $params[$imageIndex] = CRM_Utils_System::url('civicrm/contact/imagefile', 'photo=' . $photo, TRUE, NULL, TRUE, TRUE);
1141       return TRUE;
1142     }
1143     else {
1144       unset($params[$imageIndex]);
1145       if (!$statusMsg) {
1146         $statusMsg = ts('Image could not be uploaded due to invalid type extension.');
1147       }
1148       if ($opType == 'status') {
1149         CRM_Core_Session::setStatus($statusMsg, ts('Error'), 'error');
1150       }
1151       // FIXME: additional support for fatal, bounce etc could be added.
1152       return FALSE;
1153     }
1154   }
1155
1156   /**
1157    * Extract contact id from url for deleting contact image.
1158    */
1159   public static function processImage() {
1160
1161     $action = CRM_Utils_Request::retrieve('action', 'String');
1162     $cid = CRM_Utils_Request::retrieve('cid', 'Positive');
1163     // retrieve contact id in case of Profile context
1164     $id = CRM_Utils_Request::retrieve('id', 'Positive');
1165     $cid = $cid ? $cid : $id;
1166     if ($action & CRM_Core_Action::DELETE) {
1167       if (CRM_Utils_Request::retrieve('confirmed', 'Boolean')) {
1168         CRM_Contact_BAO_Contact::deleteContactImage($cid);
1169         CRM_Core_Session::setStatus(ts('Contact image deleted successfully'), ts('Image Deleted'), 'success');
1170         $session = CRM_Core_Session::singleton();
1171         $toUrl = $session->popUserContext();
1172         CRM_Utils_System::redirect($toUrl);
1173       }
1174     }
1175   }
1176
1177   /**
1178    * Function to set is_delete true or restore deleted contact.
1179    *
1180    * @param CRM_Contact_DAO_Contact $contact
1181    *   Contact DAO object.
1182    * @param bool $restore
1183    *   True to set the is_delete = 1 else false to restore deleted contact,
1184    *   i.e. is_delete = 0
1185    *
1186    * @return bool
1187    */
1188   public static function contactTrashRestore($contact, $restore = FALSE) {
1189     $updateParams = array(
1190       'id' => $contact->id,
1191       'is_deleted' => $restore ? 0 : 1,
1192     );
1193
1194     CRM_Utils_Hook::pre('update', $contact->contact_type, $contact->id, $updateParams);
1195
1196     $params = array(1 => array($contact->id, 'Integer'));
1197     if (!$restore) {
1198       $query = "DELETE FROM civicrm_uf_match WHERE contact_id = %1";
1199       CRM_Core_DAO::executeQuery($query, $params);
1200     }
1201
1202     $contact->copyValues($updateParams);
1203     $contact->save();
1204
1205     CRM_Utils_Hook::post('update', $contact->contact_type, $contact->id, $contact);
1206
1207     return TRUE;
1208   }
1209
1210   /**
1211    * Get contact type for a contact.
1212    *
1213    * @param int $id
1214    *   Id of the contact whose contact type is needed.
1215    *
1216    * @return string
1217    *   contact_type if $id found else null ""
1218    */
1219   public static function getContactType($id) {
1220     return CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_type');
1221   }
1222
1223   /**
1224    * Get contact sub type for a contact.
1225    *
1226    * @param int $id
1227    *   Id of the contact whose contact sub type is needed.
1228    *
1229    * @param string $implodeDelimiter
1230    *
1231    * @return string
1232    *   contact_sub_type if $id found else null ""
1233    */
1234   public static function getContactSubType($id, $implodeDelimiter = NULL) {
1235     $subtype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
1236     if (!$subtype) {
1237       return $implodeDelimiter ? NULL : array();
1238     }
1239
1240     $subtype = CRM_Utils_Array::explodePadded($subtype);
1241
1242     if ($implodeDelimiter) {
1243       $subtype = implode($implodeDelimiter, $subtype);
1244     }
1245     return $subtype;
1246   }
1247
1248   /**
1249    * Get pair of contact-type and sub-type for a contact.
1250    *
1251    * @param int $id
1252    *   Id of the contact whose contact sub/contact type is needed.
1253    *
1254    * @return array
1255    */
1256   public static function getContactTypes($id) {
1257     $params = array('id' => $id);
1258     $details = array();
1259     $contact = CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_Contact',
1260       $params,
1261       $details,
1262       array('contact_type', 'contact_sub_type')
1263     );
1264
1265     if ($contact) {
1266       $contactTypes = array();
1267       if ($contact->contact_sub_type) {
1268         $contactTypes = CRM_Utils_Array::explodePadded($contact->contact_sub_type);
1269       }
1270       array_unshift($contactTypes, $contact->contact_type);
1271
1272       return $contactTypes;
1273     }
1274     else {
1275       CRM_Core_Error::fatal();
1276     }
1277   }
1278
1279   /**
1280    * Combine all the importable fields from the lower levels object.
1281    *
1282    * The ordering is important, since currently we do not have a weight
1283    * scheme. Adding weight is super important
1284    *
1285    * @param int|string $contactType contact Type
1286    * @param bool $status
1287    *   Status is used to manipulate first title.
1288    * @param bool $showAll
1289    *   If true returns all fields (includes disabled fields).
1290    * @param bool $isProfile
1291    *   If its profile mode.
1292    * @param bool $checkPermission
1293    *   If false, do not include permissioning clause (for custom data).
1294    *
1295    * @param bool $withMultiCustomFields
1296    *
1297    * @return array
1298    *   array of importable Fields
1299    */
1300   public static function importableFields(
1301     $contactType = 'Individual',
1302     $status = FALSE,
1303     $showAll = FALSE,
1304     $isProfile = FALSE,
1305     $checkPermission = TRUE,
1306     $withMultiCustomFields = FALSE
1307   ) {
1308     if (empty($contactType)) {
1309       $contactType = 'All';
1310     }
1311
1312     $cacheKeyString = "importableFields $contactType";
1313     $cacheKeyString .= $status ? '_1' : '_0';
1314     $cacheKeyString .= $showAll ? '_1' : '_0';
1315     $cacheKeyString .= $isProfile ? '_1' : '_0';
1316     $cacheKeyString .= $checkPermission ? '_1' : '_0';
1317
1318     $fields = CRM_Utils_Array::value($cacheKeyString, self::$_importableFields);
1319
1320     if (!$fields) {
1321       // check if we can retrieve from database cache
1322       $fields = CRM_Core_BAO_Cache::getItem('contact fields', $cacheKeyString);
1323     }
1324
1325     if (!$fields) {
1326       $fields = CRM_Contact_DAO_Contact::import();
1327
1328       // get the fields thar are meant for contact types
1329       if (in_array($contactType, array(
1330         'Individual',
1331         'Household',
1332         'Organization',
1333         'All',
1334       ))) {
1335         $fields = array_merge($fields, CRM_Core_OptionValue::getFields('', $contactType));
1336       }
1337
1338       $locationFields = array_merge(CRM_Core_DAO_Address::import(),
1339         CRM_Core_DAO_Phone::import(),
1340         CRM_Core_DAO_Email::import(),
1341         CRM_Core_DAO_IM::import(TRUE),
1342         CRM_Core_DAO_OpenID::import()
1343       );
1344
1345       $locationFields = array_merge($locationFields,
1346         CRM_Core_BAO_CustomField::getFieldsForImport('Address',
1347           FALSE,
1348           FALSE,
1349           FALSE,
1350           FALSE
1351         )
1352       );
1353
1354       foreach ($locationFields as $key => $field) {
1355         $locationFields[$key]['hasLocationType'] = TRUE;
1356       }
1357
1358       $fields = array_merge($fields, $locationFields);
1359
1360       $fields = array_merge($fields, CRM_Contact_DAO_Contact::import());
1361       $fields = array_merge($fields, CRM_Core_DAO_Note::import());
1362
1363       //website fields
1364       $fields = array_merge($fields, CRM_Core_DAO_Website::import());
1365       $fields['url']['hasWebsiteType'] = TRUE;
1366
1367       if ($contactType != 'All') {
1368         $fields = array_merge($fields,
1369           CRM_Core_BAO_CustomField::getFieldsForImport($contactType,
1370             $showAll,
1371             TRUE,
1372             FALSE,
1373             FALSE,
1374             $withMultiCustomFields
1375           )
1376         );
1377         //unset the fields, which are not related to their
1378         //contact type.
1379         $commonValues = array(
1380           'Individual' => array(
1381             'household_name',
1382             'legal_name',
1383             'sic_code',
1384             'organization_name',
1385           ),
1386           'Household' => array(
1387             'first_name',
1388             'middle_name',
1389             'last_name',
1390             'formal_title',
1391             'job_title',
1392             'gender_id',
1393             'prefix_id',
1394             'suffix_id',
1395             'birth_date',
1396             'organization_name',
1397             'legal_name',
1398             'legal_identifier',
1399             'sic_code',
1400             'home_URL',
1401             'is_deceased',
1402             'deceased_date',
1403           ),
1404           'Organization' => array(
1405             'first_name',
1406             'middle_name',
1407             'last_name',
1408             'formal_title',
1409             'job_title',
1410             'gender_id',
1411             'prefix_id',
1412             'suffix_id',
1413             'birth_date',
1414             'household_name',
1415             'is_deceased',
1416             'deceased_date',
1417           ),
1418         );
1419         foreach ($commonValues[$contactType] as $value) {
1420           unset($fields[$value]);
1421         }
1422       }
1423       else {
1424         foreach (array('Individual', 'Household', 'Organization') as $type) {
1425           $fields = array_merge($fields,
1426             CRM_Core_BAO_CustomField::getFieldsForImport($type,
1427               $showAll,
1428               FALSE,
1429               FALSE,
1430               FALSE,
1431               $withMultiCustomFields
1432             )
1433           );
1434         }
1435       }
1436
1437       if ($isProfile) {
1438         $fields = array_merge($fields, array(
1439           'group' => array(
1440             'title' => ts('Group(s)'),
1441             'name' => 'group',
1442           ),
1443           'tag' => array(
1444             'title' => ts('Tag(s)'),
1445             'name' => 'tag',
1446           ),
1447           'note' => array(
1448             'title' => ts('Note'),
1449             'name' => 'note',
1450           ),
1451           'communication_style_id' => array(
1452             'title' => ts('Communication Style'),
1453             'name' => 'communication_style_id',
1454           ),
1455         ));
1456       }
1457
1458       //Sorting fields in alphabetical order(CRM-1507)
1459       $fields = CRM_Utils_Array::crmArraySortByField($fields, 'title');
1460
1461       CRM_Core_BAO_Cache::setItem($fields, 'contact fields', $cacheKeyString);
1462     }
1463
1464     self::$_importableFields[$cacheKeyString] = $fields;
1465
1466     if (!$isProfile) {
1467       if (!$status) {
1468         $fields = array_merge(array('do_not_import' => array('title' => ts('- do not import -'))),
1469           self::$_importableFields[$cacheKeyString]
1470         );
1471       }
1472       else {
1473         $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1474           self::$_importableFields[$cacheKeyString]
1475         );
1476       }
1477     }
1478     return $fields;
1479   }
1480
1481   /**
1482    * Combine all the exportable fields from the lower levels object.
1483    *
1484    * Currently we are using importable fields as exportable fields
1485    *
1486    * @param int|string $contactType contact Type
1487    * @param bool $status
1488    *   True while exporting primary contacts.
1489    * @param bool $export
1490    *   True when used during export.
1491    * @param bool $search
1492    *   True when used during search, might conflict with export param?.
1493    *
1494    * @param bool $withMultiRecord
1495    *
1496    * @return array
1497    *   array of exportable Fields
1498    */
1499   public static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE, $checkPermissions = TRUE) {
1500     if (empty($contactType)) {
1501       $contactType = 'All';
1502     }
1503
1504     $cacheKeyString = "exportableFields $contactType";
1505     $cacheKeyString .= $export ? '_1' : '_0';
1506     $cacheKeyString .= $status ? '_1' : '_0';
1507     $cacheKeyString .= $search ? '_1' : '_0';
1508     //CRM-14501 it turns out that the impact of permissioning here is sometimes inconsistent. The field that
1509     //calculates custom fields takes into account the logged in user & caches that for all users
1510     //as an interim fix we will cache the fields by contact
1511     $cacheKeyString .= '_' . CRM_Core_Session::getLoggedInContactID();
1512
1513     if (!self::$_exportableFields || !CRM_Utils_Array::value($cacheKeyString, self::$_exportableFields)) {
1514       if (!self::$_exportableFields) {
1515         self::$_exportableFields = array();
1516       }
1517
1518       // check if we can retrieve from database cache
1519       $fields = CRM_Core_BAO_Cache::getItem('contact fields', $cacheKeyString);
1520
1521       if (!$fields) {
1522         $fields = CRM_Contact_DAO_Contact::export();
1523
1524         // The fields are meant for contact types.
1525         if (in_array($contactType, array(
1526           'Individual',
1527           'Household',
1528           'Organization',
1529           'All',
1530           )
1531         )) {
1532           $fields = array_merge($fields, CRM_Core_OptionValue::getFields('', $contactType));
1533         }
1534         // add current employer for individuals
1535         $fields = array_merge($fields, array(
1536           'current_employer' =>
1537             array(
1538               'name' => 'organization_name',
1539               'title' => ts('Current Employer'),
1540             ),
1541         ));
1542
1543         $locationType = array(
1544           'location_type' => array(
1545             'name' => 'location_type',
1546             'where' => 'civicrm_location_type.name',
1547             'title' => ts('Location Type'),
1548           ),
1549         );
1550
1551         $IMProvider = array(
1552           'im_provider' => array(
1553             'name' => 'im_provider',
1554             'where' => 'civicrm_im.provider_id',
1555             'title' => ts('IM Provider'),
1556           ),
1557         );
1558
1559         $locationFields = array_merge($locationType,
1560           CRM_Core_DAO_Address::export(),
1561           CRM_Core_DAO_Phone::export(),
1562           CRM_Core_DAO_Email::export(),
1563           $IMProvider,
1564           CRM_Core_DAO_IM::export(TRUE),
1565           CRM_Core_DAO_OpenID::export()
1566         );
1567
1568         $locationFields = array_merge($locationFields,
1569           CRM_Core_BAO_CustomField::getFieldsForImport('Address')
1570         );
1571
1572         foreach ($locationFields as $key => $field) {
1573           $locationFields[$key]['hasLocationType'] = TRUE;
1574         }
1575
1576         $fields = array_merge($fields, $locationFields);
1577
1578         //add world region
1579         $fields = array_merge($fields,
1580           CRM_Core_DAO_Worldregion::export()
1581         );
1582
1583         $fields = array_merge($fields,
1584           CRM_Contact_DAO_Contact::export()
1585         );
1586
1587         //website fields
1588         $fields = array_merge($fields, CRM_Core_DAO_Website::export());
1589
1590         if ($contactType != 'All') {
1591           $fields = array_merge($fields,
1592             CRM_Core_BAO_CustomField::getFieldsForImport($contactType, $status, FALSE, $search, $checkPermissions, $withMultiRecord)
1593           );
1594         }
1595         else {
1596           foreach (array(
1597                      'Individual',
1598                      'Household',
1599                      'Organization',
1600                    ) as $type) {
1601             $fields = array_merge($fields,
1602               CRM_Core_BAO_CustomField::getFieldsForImport($type, FALSE, FALSE, $search, $checkPermissions, $withMultiRecord)
1603             );
1604           }
1605         }
1606         $fields['current_employer_id']['title'] = ts('Current Employer ID');
1607         //fix for CRM-791
1608         if ($export) {
1609           $fields = array_merge($fields, array(
1610             'groups' => array(
1611               'title' => ts('Group(s)'),
1612               'name' => 'groups',
1613             ),
1614             'tags' => array(
1615               'title' => ts('Tag(s)'),
1616               'name' => 'tags',
1617             ),
1618             'notes' => array(
1619               'title' => ts('Note(s)'),
1620               'name' => 'notes',
1621             ),
1622           ));
1623         }
1624         else {
1625           $fields = array_merge($fields, array(
1626             'group' => array(
1627               'title' => ts('Group(s)'),
1628               'name' => 'group',
1629             ),
1630             'tag' => array(
1631               'title' => ts('Tag(s)'),
1632               'name' => 'tag',
1633             ),
1634             'note' => array(
1635               'title' => ts('Note(s)'),
1636               'name' => 'note',
1637             ),
1638           ));
1639         }
1640
1641         //Sorting fields in alphabetical order(CRM-1507)
1642         foreach ($fields as $k => $v) {
1643           $sortArray[$k] = CRM_Utils_Array::value('title', $v);
1644         }
1645
1646         $fields = array_merge($sortArray, $fields);
1647         //unset the field which are not related to their contact type.
1648         if ($contactType != 'All') {
1649           $commonValues = array(
1650             'Individual' => array(
1651               'household_name',
1652               'legal_name',
1653               'sic_code',
1654               'organization_name',
1655               'email_greeting_custom',
1656               'postal_greeting_custom',
1657               'addressee_custom',
1658             ),
1659             'Household' => array(
1660               'first_name',
1661               'middle_name',
1662               'last_name',
1663               'formal_title',
1664               'job_title',
1665               'gender_id',
1666               'prefix_id',
1667               'suffix_id',
1668               'birth_date',
1669               'organization_name',
1670               'legal_name',
1671               'legal_identifier',
1672               'sic_code',
1673               'home_URL',
1674               'is_deceased',
1675               'deceased_date',
1676               'current_employer',
1677               'email_greeting_custom',
1678               'postal_greeting_custom',
1679               'addressee_custom',
1680               'prefix_id',
1681               'suffix_id',
1682             ),
1683             'Organization' => array(
1684               'first_name',
1685               'middle_name',
1686               'last_name',
1687               'formal_title',
1688               'job_title',
1689               'gender_id',
1690               'prefix_id',
1691               'suffix_id',
1692               'birth_date',
1693               'household_name',
1694               'email_greeting_custom',
1695               'postal_greeting_custom',
1696               'prefix_id',
1697               'suffix_id',
1698               'gender_id',
1699               'addressee_custom',
1700               'is_deceased',
1701               'deceased_date',
1702               'current_employer',
1703             ),
1704           );
1705           foreach ($commonValues[$contactType] as $value) {
1706             unset($fields[$value]);
1707           }
1708         }
1709
1710         CRM_Core_BAO_Cache::setItem($fields, 'contact fields', $cacheKeyString);
1711       }
1712       self::$_exportableFields[$cacheKeyString] = $fields;
1713     }
1714
1715     if (!$status) {
1716       $fields = self::$_exportableFields[$cacheKeyString];
1717     }
1718     else {
1719       $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1720         self::$_exportableFields[$cacheKeyString]
1721       );
1722     }
1723
1724     return $fields;
1725   }
1726
1727   /**
1728    * Get the all contact details (Hierarchical).
1729    *
1730    * @param int $contactId
1731    *   Contact id.
1732    * @param array $fields
1733    *   Fields array.
1734    *
1735    * @return array
1736    *   Contact details
1737    */
1738   public static function getHierContactDetails($contactId, &$fields) {
1739     $params = array(array('contact_id', '=', $contactId, 0, 0));
1740     $options = array();
1741
1742     $returnProperties = self::makeHierReturnProperties($fields, $contactId);
1743
1744     // We don't know the contents of return properties, but we need the lower
1745     // level ids of the contact so add a few fields.
1746     $returnProperties['first_name'] = 1;
1747     $returnProperties['organization_name'] = 1;
1748     $returnProperties['household_name'] = 1;
1749     $returnProperties['contact_type'] = 1;
1750     $returnProperties['contact_sub_type'] = 1;
1751     return list($query, $options) = CRM_Contact_BAO_Query::apiQuery($params, $returnProperties, $options);
1752   }
1753
1754   /**
1755    * Given a set of flat profile style field names, create a hierarchy.
1756    *
1757    * This is for the query to use, create the right sql.
1758    *
1759    * @param $fields
1760    * @param int $contactId
1761    *   Contact id.
1762    *
1763    * @return array
1764    *   A hierarchical property tree if appropriate
1765    */
1766   public static function &makeHierReturnProperties($fields, $contactId = NULL) {
1767     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1768
1769     $returnProperties = array();
1770
1771     $multipleFields = array('website' => 'url');
1772     foreach ($fields as $name => $dontCare) {
1773       if (strpos($name, '-') !== FALSE) {
1774         list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $name, 3);
1775
1776         if (!in_array($fieldName, $multipleFields)) {
1777           if ($id == 'Primary') {
1778             $locationTypeName = 1;
1779           }
1780           else {
1781             $locationTypeName = CRM_Utils_Array::value($id, $locationTypes);
1782             if (!$locationTypeName) {
1783               continue;
1784             }
1785           }
1786
1787           if (empty($returnProperties['location'])) {
1788             $returnProperties['location'] = array();
1789           }
1790           if (empty($returnProperties['location'][$locationTypeName])) {
1791             $returnProperties['location'][$locationTypeName] = array();
1792             $returnProperties['location'][$locationTypeName]['location_type'] = $id;
1793           }
1794           if (in_array($fieldName, array(
1795             'phone',
1796             'im',
1797             'email',
1798             'openid',
1799             'phone_ext',
1800           ))) {
1801             if ($type) {
1802               $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1;
1803             }
1804             else {
1805               $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1806             }
1807           }
1808           elseif (substr($fieldName, 0, 14) === 'address_custom') {
1809             $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1;
1810           }
1811           else {
1812             $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1813           }
1814         }
1815         else {
1816           $returnProperties['website'][$id][$fieldName] = 1;
1817         }
1818       }
1819       else {
1820         $returnProperties[$name] = 1;
1821       }
1822     }
1823
1824     return $returnProperties;
1825   }
1826
1827   /**
1828    * Return the primary location type of a contact.
1829    *
1830    * $params int     $contactId contact_id
1831    * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
1832    * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
1833    *
1834    * @param int $contactId
1835    * @param bool $skipDefaultPriamry
1836    * @param null $block
1837    *
1838    * @return int
1839    *   $locationType location_type_id
1840    */
1841   public static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
1842     if ($block) {
1843       $entityBlock = array('contact_id' => $contactId);
1844       $blocks = CRM_Core_BAO_Location::getValues($entityBlock);
1845       foreach ($blocks[$block] as $key => $value) {
1846         if (!empty($value['is_primary'])) {
1847           $locationType = CRM_Utils_Array::value('location_type_id', $value);
1848         }
1849       }
1850     }
1851     else {
1852       $query = "
1853 SELECT
1854  IF ( civicrm_email.location_type_id IS NULL,
1855     IF ( civicrm_address.location_type_id IS NULL,
1856         IF ( civicrm_phone.location_type_id IS NULL,
1857            IF ( civicrm_im.location_type_id IS NULL,
1858                IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id)
1859            ,civicrm_im.location_type_id)
1860         ,civicrm_phone.location_type_id)
1861      ,civicrm_address.location_type_id)
1862   ,civicrm_email.location_type_id)  as locationType
1863 FROM civicrm_contact
1864      LEFT JOIN civicrm_email   ON ( civicrm_email.is_primary   = 1 AND civicrm_email.contact_id = civicrm_contact.id )
1865      LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id)
1866      LEFT JOIN civicrm_phone   ON ( civicrm_phone.is_primary   = 1 AND civicrm_phone.contact_id = civicrm_contact.id)
1867      LEFT JOIN civicrm_im      ON ( civicrm_im.is_primary      = 1 AND civicrm_im.contact_id = civicrm_contact.id)
1868      LEFT JOIN civicrm_openid  ON ( civicrm_openid.is_primary  = 1 AND civicrm_openid.contact_id = civicrm_contact.id)
1869 WHERE  civicrm_contact.id = %1 ";
1870
1871       $params = array(1 => array($contactId, 'Integer'));
1872
1873       $dao = CRM_Core_DAO::executeQuery($query, $params);
1874
1875       $locationType = NULL;
1876       if ($dao->fetch()) {
1877         $locationType = $dao->locationType;
1878       }
1879     }
1880     if (isset($locationType)) {
1881       return $locationType;
1882     }
1883     elseif ($skipDefaultPriamry) {
1884       // if there is no primary contact location then return null
1885       return NULL;
1886     }
1887     else {
1888       // if there is no primart contact location, then return default
1889       // location type of the system
1890       $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
1891       return $defaultLocationType->id;
1892     }
1893   }
1894
1895   /**
1896    * Get the display name, primary email and location type of a contact.
1897    *
1898    * @param int $id
1899    *   Id of the contact.
1900    *
1901    * @return array
1902    *   Array of display_name, email if found, do_not_email or (null,null,null)
1903    */
1904   public static function getContactDetails($id) {
1905     // check if the contact type
1906     $contactType = self::getContactType($id);
1907
1908     $nameFields = ($contactType == 'Individual') ? "civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name";
1909
1910     $sql = "
1911 SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased
1912 FROM   civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id)
1913 WHERE  civicrm_contact.id = %1
1914 ORDER BY civicrm_email.is_primary DESC";
1915     $params = array(1 => array($id, 'Integer'));
1916     $dao = CRM_Core_DAO::executeQuery($sql, $params);
1917
1918     if ($dao->fetch()) {
1919       if ($contactType == 'Individual') {
1920         if ($dao->first_name || $dao->last_name) {
1921           $name = "{$dao->first_name} {$dao->last_name}";
1922         }
1923         else {
1924           $name = $dao->display_name;
1925         }
1926       }
1927       else {
1928         $name = $dao->display_name;
1929       }
1930       $email = $dao->email;
1931       $doNotEmail = $dao->do_not_email ? TRUE : FALSE;
1932       $onHold = $dao->on_hold ? TRUE : FALSE;
1933       $isDeceased = $dao->is_deceased ? TRUE : FALSE;
1934       return array($name, $email, $doNotEmail, $onHold, $isDeceased);
1935     }
1936     return array(NULL, NULL, NULL, NULL, NULL);
1937   }
1938
1939   /**
1940    * Add/edit/register contacts through profile.
1941    *
1942    * @param array $params
1943    *   Array of profile fields to be edited/added.
1944    * @param array $fields
1945    *   Array of fields from UFGroup.
1946    * @param int $contactID
1947    *   Id of the contact to be edited/added.
1948    * @param int $addToGroupID
1949    *   Specifies the default group to which contact is added.
1950    * @param int $ufGroupId
1951    *   Uf group id (profile id).
1952    * @param string $ctype
1953    * @param bool $visibility
1954    *   Basically lets us know where this request is coming from.
1955    *                                if via a profile from web, we restrict what groups are changed
1956    *
1957    * @return int
1958    *   contact id created/edited
1959    */
1960   public static function createProfileContact(
1961     &$params,
1962     &$fields,
1963     $contactID = NULL,
1964     $addToGroupID = NULL,
1965     $ufGroupId = NULL,
1966     $ctype = NULL,
1967     $visibility = FALSE
1968   ) {
1969     // add ufGroupID to params array ( CRM-2012 )
1970     if ($ufGroupId) {
1971       $params['uf_group_id'] = $ufGroupId;
1972     }
1973     self::addBillingNameFieldsIfOtherwiseNotSet($params);
1974
1975     // If a user has logged in, or accessed via a checksum
1976     // Then deliberately 'blanking' a value in the profile should remove it from their record
1977     $session = CRM_Core_Session::singleton();
1978     $params['updateBlankLocInfo'] = TRUE;
1979     if (($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0) {
1980       $params['updateBlankLocInfo'] = FALSE;
1981     }
1982
1983     if ($contactID) {
1984       $editHook = TRUE;
1985       CRM_Utils_Hook::pre('edit', 'Profile', $contactID, $params);
1986     }
1987     else {
1988       $editHook = FALSE;
1989       CRM_Utils_Hook::pre('create', 'Profile', NULL, $params);
1990     }
1991
1992     list($data, $contactDetails) = self::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype);
1993
1994     // manage is_opt_out
1995     if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) {
1996       $wasOptOut = CRM_Utils_Array::value('is_opt_out', $contactDetails, FALSE);
1997       $isOptOut = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
1998       $data['is_opt_out'] = $isOptOut;
1999       // on change, create new civicrm_subscription_history entry
2000       if (($wasOptOut != $isOptOut) && !empty($contactDetails['contact_id'])) {
2001         $shParams = array(
2002           'contact_id' => $contactDetails['contact_id'],
2003           'status' => $isOptOut ? 'Removed' : 'Added',
2004           'method' => 'Web',
2005         );
2006         CRM_Contact_BAO_SubscriptionHistory::create($shParams);
2007       }
2008     }
2009
2010     $contact = self::create($data);
2011
2012     // contact is null if the profile does not have any contact fields
2013     if ($contact) {
2014       $contactID = $contact->id;
2015     }
2016
2017     if (empty($contactID)) {
2018       CRM_Core_Error::fatal('Cannot proceed without a valid contact id');
2019     }
2020
2021     // Process group and tag
2022     if (!empty($fields['group'])) {
2023       $method = 'Admin';
2024       // this for sure means we are coming in via profile since i added it to fix
2025       // removing contacts from user groups -- lobo
2026       if ($visibility) {
2027         $method = 'Web';
2028       }
2029       CRM_Contact_BAO_GroupContact::create($params['group'], $contactID, $visibility, $method);
2030     }
2031
2032     if (!empty($fields['tag']) && array_key_exists('tag', $params)) {
2033       // Convert comma separated form values from select2 v3
2034       $tags = is_array($params['tag']) ? $params['tag'] : array_fill_keys(array_filter(explode(',', $params['tag'])), 1);
2035       CRM_Core_BAO_EntityTag::create($tags, 'civicrm_contact', $contactID);
2036     }
2037
2038     //to add profile in default group
2039     if (is_array($addToGroupID)) {
2040       $contactIds = array($contactID);
2041       foreach ($addToGroupID as $groupId) {
2042         CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId);
2043       }
2044     }
2045     elseif ($addToGroupID) {
2046       $contactIds = array($contactID);
2047       CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $addToGroupID);
2048     }
2049
2050     CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
2051
2052     if ($editHook) {
2053       CRM_Utils_Hook::post('edit', 'Profile', $contactID, $params);
2054     }
2055     else {
2056       CRM_Utils_Hook::post('create', 'Profile', $contactID, $params);
2057     }
2058     return $contactID;
2059   }
2060
2061   /**
2062    * Format profile contact parameters.
2063    *
2064    * @param array $params
2065    * @param $fields
2066    * @param int $contactID
2067    * @param int $ufGroupId
2068    * @param null $ctype
2069    * @param bool $skipCustom
2070    *
2071    * @return array
2072    */
2073   public static function formatProfileContactParams(
2074     &$params,
2075     &$fields,
2076     $contactID = NULL,
2077     $ufGroupId = NULL,
2078     $ctype = NULL,
2079     $skipCustom = FALSE
2080   ) {
2081
2082     $data = $contactDetails = array();
2083
2084     // get the contact details (hier)
2085     if ($contactID) {
2086       list($details, $options) = self::getHierContactDetails($contactID, $fields);
2087
2088       $contactDetails = $details[$contactID];
2089       $data['contact_type'] = CRM_Utils_Array::value('contact_type', $contactDetails);
2090       $data['contact_sub_type'] = CRM_Utils_Array::value('contact_sub_type', $contactDetails);
2091     }
2092     else {
2093       //we should get contact type only if contact
2094       if ($ufGroupId) {
2095         $data['contact_type'] = CRM_Core_BAO_UFField::getProfileType($ufGroupId);
2096
2097         //special case to handle profile with only contact fields
2098         if ($data['contact_type'] == 'Contact') {
2099           $data['contact_type'] = 'Individual';
2100         }
2101         elseif (CRM_Contact_BAO_ContactType::isaSubType($data['contact_type'])) {
2102           $data['contact_type'] = CRM_Contact_BAO_ContactType::getBasicType($data['contact_type']);
2103         }
2104       }
2105       elseif ($ctype) {
2106         $data['contact_type'] = $ctype;
2107       }
2108       else {
2109         $data['contact_type'] = 'Individual';
2110       }
2111     }
2112
2113     //fix contact sub type CRM-5125
2114     if (array_key_exists('contact_sub_type', $params) &&
2115       !empty($params['contact_sub_type'])
2116     ) {
2117       $data['contact_sub_type'] = CRM_Utils_Array::implodePadded($params['contact_sub_type']);
2118     }
2119     elseif (array_key_exists('contact_sub_type_hidden', $params) &&
2120       !empty($params['contact_sub_type_hidden'])
2121     ) {
2122       // if profile was used, and had any subtype, we obtain it from there
2123       //CRM-13596 - add to existing contact types, rather than overwriting
2124       if (empty($data['contact_sub_type'])) {
2125         // If we don't have a contact ID the $data['contact_sub_type'] will not be defined...
2126         $data['contact_sub_type'] = CRM_Utils_Array::implodePadded($params['contact_sub_type_hidden']);
2127       }
2128       else {
2129         $data_contact_sub_type_arr = CRM_Utils_Array::explodePadded($data['contact_sub_type']);
2130         if (!in_array($params['contact_sub_type_hidden'], $data_contact_sub_type_arr)) {
2131           //CRM-20517 - make sure contact_sub_type gets the correct delimiters
2132           $data['contact_sub_type'] = trim($data['contact_sub_type'], CRM_Core_DAO::VALUE_SEPARATOR);
2133           $data['contact_sub_type'] = CRM_Core_DAO::VALUE_SEPARATOR . $data['contact_sub_type'] . CRM_Utils_Array::implodePadded($params['contact_sub_type_hidden']);
2134         }
2135       }
2136     }
2137
2138     if ($ctype == 'Organization') {
2139       $data['organization_name'] = CRM_Utils_Array::value('organization_name', $contactDetails);
2140     }
2141     elseif ($ctype == 'Household') {
2142       $data['household_name'] = CRM_Utils_Array::value('household_name', $contactDetails);
2143     }
2144
2145     $locationType = array();
2146     $count = 1;
2147
2148     if ($contactID) {
2149       //add contact id
2150       $data['contact_id'] = $contactID;
2151       $primaryLocationType = self::getPrimaryLocationType($contactID);
2152     }
2153     else {
2154       $defaultLocation = CRM_Core_BAO_LocationType::getDefault();
2155       $defaultLocationId = $defaultLocation->id;
2156     }
2157
2158     $billingLocationTypeId = CRM_Core_BAO_LocationType::getBilling();
2159
2160     $blocks = array('email', 'phone', 'im', 'openid');
2161
2162     $multiplFields = array('url');
2163     // prevent overwritten of formatted array, reset all block from
2164     // params if it is not in valid format (since import pass valid format)
2165     foreach ($blocks as $blk) {
2166       if (array_key_exists($blk, $params) &&
2167         !is_array($params[$blk])
2168       ) {
2169         unset($params[$blk]);
2170       }
2171     }
2172
2173     $primaryPhoneLoc = NULL;
2174     $session = CRM_Core_Session::singleton();
2175     foreach ($params as $key => $value) {
2176       list($fieldName, $locTypeId, $typeId) = CRM_Utils_System::explode('-', $key, 3);
2177
2178       if ($locTypeId == 'Primary') {
2179         if ($contactID) {
2180           if (in_array($fieldName, $blocks)) {
2181             $locTypeId = self::getPrimaryLocationType($contactID, FALSE, $fieldName);
2182           }
2183           else {
2184             $locTypeId = self::getPrimaryLocationType($contactID, FALSE, 'address');
2185           }
2186           $primaryLocationType = $locTypeId;
2187         }
2188         else {
2189           $locTypeId = $defaultLocationId;
2190         }
2191       }
2192
2193       if (is_numeric($locTypeId) &&
2194         !in_array($fieldName, $multiplFields) &&
2195         substr($fieldName, 0, 7) != 'custom_'
2196       ) {
2197         $index = $locTypeId;
2198
2199         if (is_numeric($typeId)) {
2200           $index .= '-' . $typeId;
2201         }
2202         if (!in_array($index, $locationType)) {
2203           $locationType[$count] = $index;
2204           $count++;
2205         }
2206
2207         $loc = CRM_Utils_Array::key($index, $locationType);
2208
2209         $blockName = self::getLocationEntityForKey($fieldName);
2210
2211         $data[$blockName][$loc]['location_type_id'] = $locTypeId;
2212
2213         //set is_billing true, for location type "Billing"
2214         if ($locTypeId == $billingLocationTypeId) {
2215           $data[$blockName][$loc]['is_billing'] = 1;
2216         }
2217
2218         if ($contactID) {
2219           //get the primary location type
2220           if ($locTypeId == $primaryLocationType) {
2221             $data[$blockName][$loc]['is_primary'] = 1;
2222           }
2223         }
2224         elseif ($locTypeId == $defaultLocationId) {
2225           $data[$blockName][$loc]['is_primary'] = 1;
2226         }
2227
2228         if (in_array($fieldName, array('phone'))) {
2229           if ($typeId) {
2230             $data['phone'][$loc]['phone_type_id'] = $typeId;
2231           }
2232           else {
2233             $data['phone'][$loc]['phone_type_id'] = '';
2234           }
2235           $data['phone'][$loc]['phone'] = $value;
2236
2237           //special case to handle primary phone with different phone types
2238           // in this case we make first phone type as primary
2239           if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
2240             $primaryPhoneLoc = $loc;
2241           }
2242
2243           if ($loc != $primaryPhoneLoc) {
2244             unset($data['phone'][$loc]['is_primary']);
2245           }
2246         }
2247         elseif ($fieldName == 'email') {
2248           $data['email'][$loc]['email'] = $value;
2249           if (empty($contactID)) {
2250             $data['email'][$loc]['is_primary'] = 1;
2251           }
2252         }
2253         elseif ($fieldName == 'im') {
2254           if (isset($params[$key . '-provider_id'])) {
2255             $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
2256           }
2257           if (strpos($key, '-provider_id') !== FALSE) {
2258             $data['im'][$loc]['provider_id'] = $params[$key];
2259           }
2260           else {
2261             $data['im'][$loc]['name'] = $value;
2262           }
2263         }
2264         elseif ($fieldName == 'openid') {
2265           $data['openid'][$loc]['openid'] = $value;
2266         }
2267         else {
2268           if ($fieldName === 'state_province') {
2269             // CRM-3393
2270             if (is_numeric($value) && ((int ) $value) >= 1000) {
2271               $data['address'][$loc]['state_province_id'] = $value;
2272             }
2273             elseif (empty($value)) {
2274               $data['address'][$loc]['state_province_id'] = '';
2275             }
2276             else {
2277               $data['address'][$loc]['state_province'] = $value;
2278             }
2279           }
2280           elseif ($fieldName === 'country') {
2281             // CRM-3393
2282             if (is_numeric($value) && ((int ) $value) >= 1000
2283             ) {
2284               $data['address'][$loc]['country_id'] = $value;
2285             }
2286             elseif (empty($value)) {
2287               $data['address'][$loc]['country_id'] = '';
2288             }
2289             else {
2290               $data['address'][$loc]['country'] = $value;
2291             }
2292           }
2293           elseif ($fieldName === 'county') {
2294             $data['address'][$loc]['county_id'] = $value;
2295           }
2296           elseif ($fieldName == 'address_name') {
2297             $data['address'][$loc]['name'] = $value;
2298           }
2299           elseif (substr($fieldName, 0, 14) === 'address_custom') {
2300             $data['address'][$loc][substr($fieldName, 8)] = $value;
2301           }
2302           else {
2303             $data[$blockName][$loc][$fieldName] = $value;
2304           }
2305         }
2306       }
2307       else {
2308         if (substr($key, 0, 4) === 'url-') {
2309           $websiteField = explode('-', $key);
2310           $data['website'][$websiteField[1]]['website_type_id'] = $websiteField[1];
2311           $data['website'][$websiteField[1]]['url'] = $value;
2312         }
2313         elseif (in_array($key, self::$_greetingTypes, TRUE)) {
2314           //save email/postal greeting and addressee values if any, CRM-4575
2315           $data[$key . '_id'] = $value;
2316         }
2317         elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($key))) {
2318           // for autocomplete transfer hidden value instead of label
2319           if ($params[$key] && isset($params[$key . '_id'])) {
2320             $value = $params[$key . '_id'];
2321           }
2322
2323           // we need to append time with date
2324           if ($params[$key] && isset($params[$key . '_time'])) {
2325             $value .= ' ' . $params[$key . '_time'];
2326           }
2327
2328           // if auth source is not checksum / login && $value is blank, do not proceed - CRM-10128
2329           if (($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0 &&
2330             ($value == '' || !isset($value))
2331           ) {
2332             continue;
2333           }
2334
2335           $valueId = NULL;
2336           if (!empty($params['customRecordValues'])) {
2337             if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
2338               foreach ($params['customRecordValues'] as $recId => $customFields) {
2339                 if (is_array($customFields) && !empty($customFields)) {
2340                   foreach ($customFields as $customFieldName) {
2341                     if ($customFieldName == $key) {
2342                       $valueId = $recId;
2343                       break;
2344                     }
2345                   }
2346                 }
2347               }
2348             }
2349           }
2350
2351           //CRM-13596 - check for contact_sub_type_hidden first
2352           if (array_key_exists('contact_sub_type_hidden', $params)) {
2353             $type = $params['contact_sub_type_hidden'];
2354           }
2355           else {
2356             $type = $data['contact_type'];
2357             if (!empty($data['contact_sub_type'])) {
2358               $type = CRM_Utils_Array::explodePadded($data['contact_sub_type']);
2359             }
2360           }
2361
2362           CRM_Core_BAO_CustomField::formatCustomField($customFieldId,
2363             $data['custom'],
2364             $value,
2365             $type,
2366             $valueId,
2367             $contactID,
2368             FALSE,
2369             FALSE
2370           );
2371         }
2372         elseif ($key == 'edit') {
2373           continue;
2374         }
2375         else {
2376           if ($key == 'location') {
2377             foreach ($value as $locationTypeId => $field) {
2378               foreach ($field as $block => $val) {
2379                 if ($block == 'address' && array_key_exists('address_name', $val)) {
2380                   $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
2381                 }
2382               }
2383             }
2384           }
2385           if ($key == 'phone' && isset($params['phone_ext'])) {
2386             $data[$key] = $value;
2387             foreach ($value as $cnt => $phoneBlock) {
2388               if ($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']) {
2389                 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
2390               }
2391             }
2392           }
2393           elseif (in_array($key,
2394               array(
2395                 'nick_name',
2396                 'job_title',
2397                 'middle_name',
2398                 'birth_date',
2399                 'gender_id',
2400                 'current_employer',
2401                 'prefix_id',
2402                 'suffix_id',
2403               )) &&
2404             ($value == '' || !isset($value)) &&
2405             ($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0 ||
2406             ($key == 'current_employer' && empty($params['current_employer']))) {
2407             // CRM-10128: if auth source is not checksum / login && $value is blank, do not fill $data with empty value
2408             // to avoid update with empty values
2409             continue;
2410           }
2411           else {
2412             $data[$key] = $value;
2413           }
2414         }
2415       }
2416     }
2417
2418     if (!isset($data['contact_type'])) {
2419       $data['contact_type'] = 'Individual';
2420     }
2421
2422     //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone)
2423     $privacy = CRM_Core_SelectValues::privacy();
2424     foreach ($privacy as $key => $value) {
2425       if (array_key_exists($key, $fields)) {
2426         // do not reset values for existing contacts, if fields are added to a profile
2427         if (array_key_exists($key, $params)) {
2428           $data[$key] = $params[$key];
2429           if (empty($params[$key])) {
2430             $data[$key] = 0;
2431           }
2432         }
2433         elseif (!$contactID) {
2434           $data[$key] = 0;
2435         }
2436       }
2437     }
2438
2439     return array($data, $contactDetails);
2440   }
2441
2442   /**
2443    * Find the get contact details.
2444    *
2445    * This function does not respect ACLs for now, which might need to be rectified at some
2446    * stage based on how its used.
2447    *
2448    * @param string $mail
2449    *   Primary email address of the contact.
2450    * @param string $ctype
2451    *   Contact type.
2452    *
2453    * @return object|null
2454    *   $dao contact details
2455    */
2456   public static function matchContactOnEmail($mail, $ctype = NULL) {
2457     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2458     $mail = $strtolower(trim($mail));
2459     $query = "
2460 SELECT     civicrm_contact.id as contact_id,
2461            civicrm_contact.hash as hash,
2462            civicrm_contact.contact_type as contact_type,
2463            civicrm_contact.contact_sub_type as contact_sub_type
2464 FROM       civicrm_contact
2465 INNER JOIN civicrm_email    ON ( civicrm_contact.id = civicrm_email.contact_id )";
2466
2467     if (Civi::settings()->get('uniq_email_per_site')) {
2468       // try to find a match within a site (multisite).
2469       $groups = CRM_Core_BAO_Domain::getChildGroupIds();
2470       if (!empty($groups)) {
2471         $query .= "
2472 INNER JOIN civicrm_group_contact gc ON
2473 (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))";
2474       }
2475     }
2476
2477     $query .= "
2478 WHERE      civicrm_email.email = %1 AND civicrm_contact.is_deleted=0";
2479     $p = array(1 => array($mail, 'String'));
2480
2481     if ($ctype) {
2482       $query .= " AND civicrm_contact.contact_type = %3";
2483       $p[3] = array($ctype, 'String');
2484     }
2485
2486     $query .= " ORDER BY civicrm_email.is_primary DESC";
2487
2488     $dao = CRM_Core_DAO::executeQuery($query, $p);
2489
2490     if ($dao->fetch()) {
2491       return $dao;
2492     }
2493     return NULL;
2494   }
2495
2496   /**
2497    * Find the contact details associated with an OpenID.
2498    *
2499    * @param string $openId
2500    *   OpenId of the contact.
2501    * @param string $ctype
2502    *   Contact type.
2503    *
2504    * @return object|null
2505    *   $dao contact details
2506    */
2507   public static function matchContactOnOpenId($openId, $ctype = NULL) {
2508     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2509     $openId = $strtolower(trim($openId));
2510     $query = "
2511 SELECT     civicrm_contact.id as contact_id,
2512            civicrm_contact.hash as hash,
2513            civicrm_contact.contact_type as contact_type,
2514            civicrm_contact.contact_sub_type as contact_sub_type
2515 FROM       civicrm_contact
2516 INNER JOIN civicrm_openid    ON ( civicrm_contact.id = civicrm_openid.contact_id )
2517 WHERE      civicrm_openid.openid = %1";
2518     $p = array(1 => array($openId, 'String'));
2519
2520     if ($ctype) {
2521       $query .= " AND civicrm_contact.contact_type = %3";
2522       $p[3] = array($ctype, 'String');
2523     }
2524
2525     $query .= " ORDER BY civicrm_openid.is_primary DESC";
2526
2527     $dao = CRM_Core_DAO::executeQuery($query, $p);
2528
2529     if ($dao->fetch()) {
2530       return $dao;
2531     }
2532     return NULL;
2533   }
2534
2535   /**
2536    * Get primary email of the contact.
2537    *
2538    * @param int $contactID
2539    *   Contact id.
2540    *
2541    * @return string
2542    *   Email address if present else null
2543    */
2544   public static function getPrimaryEmail($contactID) {
2545     // fetch the primary email
2546     $query = "
2547    SELECT civicrm_email.email as email
2548      FROM civicrm_contact
2549 LEFT JOIN civicrm_email    ON ( civicrm_contact.id = civicrm_email.contact_id )
2550     WHERE civicrm_email.is_primary = 1
2551       AND civicrm_contact.id = %1";
2552     $p = array(1 => array($contactID, 'Integer'));
2553     $dao = CRM_Core_DAO::executeQuery($query, $p);
2554
2555     $email = NULL;
2556     if ($dao->fetch()) {
2557       $email = $dao->email;
2558     }
2559     return $email;
2560   }
2561
2562   /**
2563    * Function to get primary OpenID of the contact.
2564    *
2565    * @param int $contactID
2566    *   Contact id.
2567    *
2568    * @return string
2569    *   >openid   OpenID if present else null
2570    */
2571   public static function getPrimaryOpenId($contactID) {
2572     // fetch the primary OpenID
2573     $query = "
2574 SELECT    civicrm_openid.openid as openid
2575 FROM      civicrm_contact
2576 LEFT JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2577 WHERE     civicrm_contact.id = %1
2578 AND       civicrm_openid.is_primary = 1";
2579     $p = array(1 => array($contactID, 'Integer'));
2580     $dao = CRM_Core_DAO::executeQuery($query, $p);
2581
2582     $openId = NULL;
2583     if ($dao->fetch()) {
2584       $openId = $dao->openid;
2585     }
2586     return $openId;
2587   }
2588
2589   /**
2590    * Fetch the object and store the values in the values array.
2591    *
2592    * @param array $params
2593    *   Input parameters to find object.
2594    * @param array $values
2595    *   Output values of the object.
2596    *
2597    * @return CRM_Contact_BAO_Contact|null
2598    *   The found object or null
2599    */
2600   public static function getValues(&$params, &$values) {
2601     $contact = new CRM_Contact_BAO_Contact();
2602
2603     $contact->copyValues($params);
2604
2605     if ($contact->find(TRUE)) {
2606
2607       CRM_Core_DAO::storeValues($contact, $values);
2608
2609       $privacy = array();
2610       foreach (self::$_commPrefs as $name) {
2611         if (isset($contact->$name)) {
2612           $privacy[$name] = $contact->$name;
2613         }
2614       }
2615
2616       if (!empty($privacy)) {
2617         $values['privacy'] = $privacy;
2618       }
2619
2620       // communication Prefferance
2621       $preffComm = $comm = array();
2622       $comm = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2623         $contact->preferred_communication_method
2624       );
2625       foreach ($comm as $value) {
2626         $preffComm[$value] = 1;
2627       }
2628       $temp = array('preferred_communication_method' => $contact->preferred_communication_method);
2629
2630       $names = array(
2631         'preferred_communication_method' => array(
2632           'newName' => 'preferred_communication_method_display',
2633           'groupName' => 'preferred_communication_method',
2634         ),
2635       );
2636
2637       // @todo This can be figured out from metadata & we can avoid the uncached query.
2638       CRM_Core_OptionGroup::lookupValues($temp, $names, FALSE);
2639
2640       $values['preferred_communication_method'] = $preffComm;
2641       $values['preferred_communication_method_display'] = CRM_Utils_Array::value('preferred_communication_method_display', $temp);
2642
2643       if ($contact->preferred_mail_format) {
2644         $preferredMailingFormat = CRM_Core_SelectValues::pmf();
2645         $values['preferred_mail_format'] = $preferredMailingFormat[$contact->preferred_mail_format];
2646       }
2647
2648       // get preferred languages
2649       if (!empty($contact->preferred_language)) {
2650         $values['preferred_language'] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language);
2651       }
2652
2653       // Calculating Year difference
2654       if ($contact->birth_date) {
2655         $birthDate = CRM_Utils_Date::customFormat($contact->birth_date, '%Y%m%d');
2656         if ($birthDate < date('Ymd')) {
2657           $age = CRM_Utils_Date::calculateAge($birthDate);
2658           $values['age']['y'] = CRM_Utils_Array::value('years', $age);
2659           $values['age']['m'] = CRM_Utils_Array::value('months', $age);
2660         }
2661       }
2662
2663       $contact->contact_id = $contact->id;
2664
2665       return $contact;
2666     }
2667     return NULL;
2668   }
2669
2670   /**
2671    * Given the component name and returns the count of participation of contact.
2672    *
2673    * @param string $component
2674    *   Input component name.
2675    * @param int $contactId
2676    *   Input contact id.
2677    * @param string $tableName
2678    *   Optional tableName if component is custom group.
2679    *
2680    * @return int
2681    *   total number in database
2682    */
2683   public static function getCountComponent($component, $contactId, $tableName = NULL) {
2684     $object = NULL;
2685     switch ($component) {
2686       case 'tag':
2687         return CRM_Core_BAO_EntityTag::getContactTags($contactId, TRUE);
2688
2689       case 'rel':
2690         $result = CRM_Contact_BAO_Relationship::getRelationship($contactId,
2691           CRM_Contact_BAO_Relationship::CURRENT,
2692           0, 1, 0,
2693           NULL, NULL,
2694           TRUE
2695         );
2696         return $result;
2697
2698       case 'group':
2699
2700         return CRM_Contact_BAO_GroupContact::getContactGroup($contactId, "Added", NULL, TRUE);
2701
2702       case 'log':
2703         if (CRM_Core_BAO_Log::useLoggingReport()) {
2704           return FALSE;
2705         }
2706         return CRM_Core_BAO_Log::getContactLogCount($contactId);
2707
2708       case 'note':
2709         return CRM_Core_BAO_Note::getContactNoteCount($contactId);
2710
2711       case 'contribution':
2712         return CRM_Contribute_BAO_Contribution::contributionCount($contactId);
2713
2714       case 'membership':
2715         return CRM_Member_BAO_Membership::getContactMembershipCount($contactId, TRUE);
2716
2717       case 'participant':
2718         return CRM_Event_BAO_Participant::getContactParticipantCount($contactId);
2719
2720       case 'pledge':
2721         return CRM_Pledge_BAO_Pledge::getContactPledgeCount($contactId);
2722
2723       case 'case':
2724         return CRM_Case_BAO_Case::caseCount($contactId);
2725
2726       case 'grant':
2727         return CRM_Grant_BAO_Grant::getContactGrantCount($contactId);
2728
2729       case 'activity':
2730         $input = array(
2731           'contact_id' => $contactId,
2732           'admin' => FALSE,
2733           'caseId' => NULL,
2734           'context' => 'activity',
2735         );
2736         return CRM_Activity_BAO_Activity::deprecatedGetActivitiesCount($input);
2737
2738       case 'mailing':
2739         $params = array('contact_id' => $contactId);
2740         return CRM_Mailing_BAO_Mailing::getContactMailingsCount($params);
2741
2742       default:
2743         $custom = explode('_', $component);
2744         if ($custom['0'] = 'custom') {
2745           if (!$tableName) {
2746             $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name');
2747           }
2748           $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}";
2749           return CRM_Core_DAO::singleValueQuery($queryString);
2750         }
2751     }
2752   }
2753
2754   /**
2755    * Update contact greetings if an update has resulted in a custom field change.
2756    *
2757    * @param array $updatedFields
2758    *   Array of fields that have been updated e.g array('first_name', 'prefix_id', 'custom_2');
2759    * @param array $contactParams
2760    *   Parameters known about the contact. At minimum array('contact_id' => x).
2761    *   Fields in this array will take precedence over DB fields (so far only
2762    *   in the case of greeting id fields).
2763    */
2764   public static function updateGreetingsOnTokenFieldChange($updatedFields, $contactParams) {
2765     $contactID = $contactParams['contact_id'];
2766     CRM_Contact_BAO_Contact::ensureGreetingParamsAreSet($contactParams);
2767     $tokens = CRM_Contact_BAO_Contact_Utils::getTokensRequiredForContactGreetings($contactParams);
2768     if (!empty($tokens['all']['contact'])) {
2769       $affectedTokens = array_intersect_key($updatedFields[$contactID], array_flip($tokens['all']['contact']));
2770       if (!empty($affectedTokens)) {
2771         // @todo this is still reloading the whole contact -fix to be more selective & use pre-loaded.
2772         $contact = new CRM_Contact_BAO_Contact();
2773         $contact->id = $contactID;
2774         CRM_Contact_BAO_Contact::processGreetings($contact);
2775       }
2776     }
2777   }
2778
2779   /**
2780    * Process greetings and cache.
2781    *
2782    * @param object $contact
2783    *   Contact object after save.
2784    */
2785   public static function processGreetings(&$contact) {
2786
2787     //@todo this function does a lot of unnecessary loading.
2788     // ensureGreetingParamsAreSet now makes sure that the contact is
2789     // loaded and using updateGreetingsOnTokenFieldChange
2790     // allows us the possibility of only doing an update if required.
2791
2792     // The contact object has not always required the
2793     // fields that are required to calculate greetings
2794     // so we need to retrieve it again.
2795     if ($contact->_query !== FALSE) {
2796       $contact->find(TRUE);
2797     }
2798
2799     // store object values to an array
2800     $contactDetails = array();
2801     CRM_Core_DAO::storeValues($contact, $contactDetails);
2802     $contactDetails = array(array($contact->id => $contactDetails));
2803
2804     $emailGreetingString = $postalGreetingString = $addresseeString = NULL;
2805     $updateQueryString = array();
2806
2807     //cache email and postal greeting to greeting display
2808     if ($contact->email_greeting_custom != 'null' && $contact->email_greeting_custom) {
2809       $emailGreetingString = $contact->email_greeting_custom;
2810     }
2811     elseif ($contact->email_greeting_id != 'null' && $contact->email_greeting_id) {
2812       // the filter value for Individual contact type is set to 1
2813       $filter = array(
2814         'contact_type' => $contact->contact_type,
2815         'greeting_type' => 'email_greeting',
2816       );
2817
2818       $emailGreeting = CRM_Core_PseudoConstant::greeting($filter);
2819       $emailGreetingString = $emailGreeting[$contact->email_greeting_id];
2820       $updateQueryString[] = " email_greeting_custom = NULL ";
2821     }
2822     else {
2823       if ($contact->email_greeting_custom) {
2824         $updateQueryString[] = " email_greeting_display = NULL ";
2825       }
2826     }
2827
2828     if ($emailGreetingString) {
2829       CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($emailGreetingString,
2830         $contactDetails,
2831         $contact->id,
2832         'CRM_Contact_BAO_Contact'
2833       );
2834       $emailGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($emailGreetingString));
2835       $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'";
2836     }
2837
2838     //postal greetings
2839     if ($contact->postal_greeting_custom != 'null' && $contact->postal_greeting_custom) {
2840       $postalGreetingString = $contact->postal_greeting_custom;
2841     }
2842     elseif ($contact->postal_greeting_id != 'null' && $contact->postal_greeting_id) {
2843       $filter = array(
2844         'contact_type' => $contact->contact_type,
2845         'greeting_type' => 'postal_greeting',
2846       );
2847       $postalGreeting = CRM_Core_PseudoConstant::greeting($filter);
2848       $postalGreetingString = $postalGreeting[$contact->postal_greeting_id];
2849       $updateQueryString[] = " postal_greeting_custom = NULL ";
2850     }
2851     else {
2852       if ($contact->postal_greeting_custom) {
2853         $updateQueryString[] = " postal_greeting_display = NULL ";
2854       }
2855     }
2856
2857     if ($postalGreetingString) {
2858       CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($postalGreetingString,
2859         $contactDetails,
2860         $contact->id,
2861         'CRM_Contact_BAO_Contact'
2862       );
2863       $postalGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($postalGreetingString));
2864       $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'";
2865     }
2866
2867     // addressee
2868     if ($contact->addressee_custom != 'null' && $contact->addressee_custom) {
2869       $addresseeString = $contact->addressee_custom;
2870     }
2871     elseif ($contact->addressee_id != 'null' && $contact->addressee_id) {
2872       $filter = array(
2873         'contact_type' => $contact->contact_type,
2874         'greeting_type' => 'addressee',
2875       );
2876
2877       $addressee = CRM_Core_PseudoConstant::greeting($filter);
2878       $addresseeString = $addressee[$contact->addressee_id];
2879       $updateQueryString[] = " addressee_custom = NULL ";
2880     }
2881     else {
2882       if ($contact->addressee_custom) {
2883         $updateQueryString[] = " addressee_display = NULL ";
2884       }
2885     }
2886
2887     if ($addresseeString) {
2888       CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($addresseeString,
2889         $contactDetails,
2890         $contact->id,
2891         'CRM_Contact_BAO_Contact'
2892       );
2893       $addresseeString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($addresseeString));
2894       $updateQueryString[] = " addressee_display = '{$addresseeString}'";
2895     }
2896
2897     if (!empty($updateQueryString)) {
2898       $updateQueryString = implode(',', $updateQueryString);
2899       $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}";
2900       CRM_Core_DAO::executeQuery($queryString);
2901     }
2902   }
2903
2904   /**
2905    * Retrieve loc block ids w/ given condition.
2906    *
2907    * @param int $contactId
2908    *   Contact id.
2909    * @param array $criteria
2910    *   Key => value pair which should be.
2911    *                              fulfill by return record ids.
2912    * @param string $condOperator
2913    *   Operator use for grouping multiple conditions.
2914    *
2915    * @return array
2916    *   loc block ids which fulfill condition.
2917    */
2918   public static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') {
2919     $locBlockIds = array();
2920     if (!$contactId) {
2921       return $locBlockIds;
2922     }
2923
2924     foreach (array('Email', 'OpenID', 'Phone', 'Address', 'IM') as $block) {
2925       $name = strtolower($block);
2926       $className = "CRM_Core_DAO_$block";
2927       $blockDAO = new $className();
2928
2929       // build the condition.
2930       if (is_array($criteria)) {
2931         $fields = $blockDAO->fields();
2932         $conditions = array();
2933         foreach ($criteria as $field => $value) {
2934           if (array_key_exists($field, $fields)) {
2935             $cond = "( $field = $value )";
2936             // value might be zero or null.
2937             if (!$value || strtolower($value) == 'null') {
2938               $cond = "( $field = 0 OR $field IS NULL )";
2939             }
2940             $conditions[] = $cond;
2941           }
2942         }
2943         if (!empty($conditions)) {
2944           $blockDAO->whereAdd(implode(" $condOperator ", $conditions));
2945         }
2946       }
2947
2948       $blockDAO->contact_id = $contactId;
2949       $blockDAO->find();
2950       while ($blockDAO->fetch()) {
2951         $locBlockIds[$name][] = $blockDAO->id;
2952       }
2953       $blockDAO->free();
2954     }
2955
2956     return $locBlockIds;
2957   }
2958
2959   /**
2960    * Build context menu items.
2961    *
2962    * @param int $contactId
2963    *
2964    * @return array
2965    *   Array of context menu for logged in user.
2966    */
2967   public static function contextMenu($contactId = NULL) {
2968     $menu = array(
2969       'view' => array(
2970         'title' => ts('View Contact'),
2971         'weight' => 0,
2972         'ref' => 'view-contact',
2973         'class' => 'no-popup',
2974         'key' => 'view',
2975         'permissions' => array('view all contacts'),
2976       ),
2977       'add' => array(
2978         'title' => ts('Edit Contact'),
2979         'weight' => 0,
2980         'ref' => 'edit-contact',
2981         'class' => 'no-popup',
2982         'key' => 'add',
2983         'permissions' => array('edit all contacts'),
2984       ),
2985       'delete' => array(
2986         'title' => ts('Delete Contact'),
2987         'weight' => 0,
2988         'ref' => 'delete-contact',
2989         'key' => 'delete',
2990         'permissions' => array('access deleted contacts', 'delete contacts'),
2991       ),
2992       'contribution' => array(
2993         'title' => ts('Add Contribution'),
2994         'weight' => 5,
2995         'ref' => 'new-contribution',
2996         'key' => 'contribution',
2997         'tab' => 'contribute',
2998         'component' => 'CiviContribute',
2999         'href' => CRM_Utils_System::url('civicrm/contact/view/contribution',
3000           'reset=1&action=add&context=contribution'
3001         ),
3002         'permissions' => array(
3003           'access CiviContribute',
3004           'edit contributions',
3005         ),
3006       ),
3007       'participant' => array(
3008         'title' => ts('Register for Event'),
3009         'weight' => 10,
3010         'ref' => 'new-participant',
3011         'key' => 'participant',
3012         'tab' => 'participant',
3013         'component' => 'CiviEvent',
3014         'href' => CRM_Utils_System::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'),
3015         'permissions' => array(
3016           'access CiviEvent',
3017           'edit event participants',
3018         ),
3019       ),
3020       'activity' => array(
3021         'title' => ts('Record Activity'),
3022         'weight' => 35,
3023         'ref' => 'new-activity',
3024         'key' => 'activity',
3025         'permissions' => array('edit all contacts'),
3026       ),
3027       'pledge' => array(
3028         'title' => ts('Add Pledge'),
3029         'weight' => 15,
3030         'ref' => 'new-pledge',
3031         'key' => 'pledge',
3032         'tab' => 'pledge',
3033         'href' => CRM_Utils_System::url('civicrm/contact/view/pledge',
3034           'reset=1&action=add&context=pledge'
3035         ),
3036         'component' => 'CiviPledge',
3037         'permissions' => array(
3038           'access CiviPledge',
3039           'edit pledges',
3040         ),
3041       ),
3042       'membership' => array(
3043         'title' => ts('Add Membership'),
3044         'weight' => 20,
3045         'ref' => 'new-membership',
3046         'key' => 'membership',
3047         'tab' => 'member',
3048         'component' => 'CiviMember',
3049         'href' => CRM_Utils_System::url('civicrm/contact/view/membership',
3050           'reset=1&action=add&context=membership'
3051         ),
3052         'permissions' => array(
3053           'access CiviMember',
3054           'edit memberships',
3055         ),
3056       ),
3057       'case' => array(
3058         'title' => ts('Add Case'),
3059         'weight' => 25,
3060         'ref' => 'new-case',
3061         'key' => 'case',
3062         'tab' => 'case',
3063         'component' => 'CiviCase',
3064         'href' => CRM_Utils_System::url('civicrm/case/add', 'reset=1&action=add&context=case'),
3065         'permissions' => array('add cases'),
3066       ),
3067       'grant' => array(
3068         'title' => ts('Add Grant'),
3069         'weight' => 26,
3070         'ref' => 'new-grant',
3071         'key' => 'grant',
3072         'tab' => 'grant',
3073         'component' => 'CiviGrant',
3074         'href' => CRM_Utils_System::url('civicrm/contact/view/grant',
3075           'reset=1&action=add&context=grant'
3076         ),
3077         'permissions' => array('edit grants'),
3078       ),
3079       'rel' => array(
3080         'title' => ts('Add Relationship'),
3081         'weight' => 30,
3082         'ref' => 'new-relationship',
3083         'key' => 'rel',
3084         'tab' => 'rel',
3085         'href' => CRM_Utils_System::url('civicrm/contact/view/rel',
3086           'reset=1&action=add'
3087         ),
3088         'permissions' => array('edit all contacts'),
3089       ),
3090       'note' => array(
3091         'title' => ts('Add Note'),
3092         'weight' => 40,
3093         'ref' => 'new-note',
3094         'key' => 'note',
3095         'tab' => 'note',
3096         'class' => 'medium-popup',
3097         'href' => CRM_Utils_System::url('civicrm/contact/view/note',
3098           'reset=1&action=add'
3099         ),
3100         'permissions' => array('edit all contacts'),
3101       ),
3102       'email' => array(
3103         'title' => ts('Send an Email'),
3104         'weight' => 45,
3105         'ref' => 'new-email',
3106         'key' => 'email',
3107         'permissions' => array('view all contacts'),
3108       ),
3109       'group' => array(
3110         'title' => ts('Add to Group'),
3111         'weight' => 50,
3112         'ref' => 'group-add-contact',
3113         'key' => 'group',
3114         'tab' => 'group',
3115         'permissions' => array('edit groups'),
3116       ),
3117       'tag' => array(
3118         'title' => ts('Tag Contact'),
3119         'weight' => 55,
3120         'ref' => 'tag-contact',
3121         'key' => 'tag',
3122         'tab' => 'tag',
3123         'permissions' => array('edit all contacts'),
3124       ),
3125     );
3126
3127     $menu['otherActions'] = array(
3128       'print' => array(
3129         'title' => ts('Print Summary'),
3130         'description' => ts('Printer-friendly view of this page.'),
3131         'weight' => 5,
3132         'ref' => 'crm-contact-print',
3133         'key' => 'print',
3134         'tab' => 'print',
3135         'href' => CRM_Utils_System::url('civicrm/contact/view/print',
3136           "reset=1&print=1"
3137         ),
3138         'class' => 'print',
3139         'icon' => 'crm-i fa-print',
3140       ),
3141       'vcard' => array(
3142         'title' => ts('vCard'),
3143         'description' => ts('vCard record for this contact.'),
3144         'weight' => 10,
3145         'ref' => 'crm-contact-vcard',
3146         'key' => 'vcard',
3147         'tab' => 'vcard',
3148         'href' => CRM_Utils_System::url('civicrm/contact/view/vcard',
3149           "reset=1"
3150         ),
3151         'class' => 'vcard',
3152         'icon' => 'crm-i fa-list-alt',
3153       ),
3154     );
3155
3156     if (CRM_Core_Permission::check('access Contact Dashboard')) {
3157       $menu['otherActions']['dashboard'] = array(
3158         'title' => ts('Contact Dashboard'),
3159         'description' => ts('Contact Dashboard'),
3160         'weight' => 15,
3161         'ref' => 'crm-contact-dashboard',
3162         'key' => 'dashboard',
3163         'tab' => 'dashboard',
3164         'class' => 'dashboard',
3165         // NOTE: As an alternative you can also build url on CMS specific way
3166         //  as CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($contactId)
3167         'href' => CRM_Utils_System::url('civicrm/user', "reset=1&id={$contactId}"),
3168         'icon' => 'crm-i fa-tachometer',
3169       );
3170     }
3171
3172     $uid = CRM_Core_BAO_UFMatch::getUFId($contactId);
3173     if ($uid) {
3174       $menu['otherActions']['user-record'] = array(
3175         'title' => ts('User Record'),
3176         'description' => ts('User Record'),
3177         'weight' => 20,
3178         'ref' => 'crm-contact-user-record',
3179         'key' => 'user-record',
3180         'tab' => 'user-record',
3181         'class' => 'user-record',
3182         'href' => CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($contactId),
3183         'icon' => 'crm-i fa-user',
3184       );
3185     }
3186     elseif (CRM_Core_Config::singleton()->userSystem->checkPermissionAddUser()) {
3187       $menu['otherActions']['user-add'] = array(
3188         'title' => ts('Create User Record'),
3189         'description' => ts('Create User Record'),
3190         'weight' => 25,
3191         'ref' => 'crm-contact-user-add',
3192         'key' => 'user-add',
3193         'tab' => 'user-add',
3194         'class' => 'user-add',
3195         'href' => CRM_Utils_System::url('civicrm/contact/view/useradd', 'reset=1&action=add&cid=' . $contactId),
3196         'icon' => 'crm-i fa-user-plus',
3197       );
3198     }
3199
3200     CRM_Utils_Hook::summaryActions($menu, $contactId);
3201     //1. check for component is active.
3202     //2. check for user permissions.
3203     //3. check for acls.
3204     //3. edit and view contact are directly accessible to user.
3205
3206     $aclPermissionedTasks = array(
3207       'view-contact',
3208       'edit-contact',
3209       'new-activity',
3210       'new-email',
3211       'group-add-contact',
3212       'tag-contact',
3213       'delete-contact',
3214     );
3215     $corePermission = CRM_Core_Permission::getPermission();
3216
3217     $contextMenu = array();
3218     foreach ($menu as $key => $values) {
3219       if ($key != 'otherActions') {
3220
3221         // user does not have necessary permissions.
3222         if (!self::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $values)) {
3223           continue;
3224         }
3225         // build directly accessible action menu.
3226         if (in_array($values['ref'], array(
3227           'view-contact',
3228           'edit-contact',
3229         ))) {
3230           $contextMenu['primaryActions'][$key] = array(
3231             'title' => $values['title'],
3232             'ref' => $values['ref'],
3233             'class' => CRM_Utils_Array::value('class', $values),
3234             'key' => $values['key'],
3235           );
3236           continue;
3237         }
3238
3239         // finally get menu item for -more- action widget.
3240         $contextMenu['moreActions'][$values['weight']] = array(
3241           'title' => $values['title'],
3242           'ref' => $values['ref'],
3243           'href' => CRM_Utils_Array::value('href', $values),
3244           'tab' => CRM_Utils_Array::value('tab', $values),
3245           'class' => CRM_Utils_Array::value('class', $values),
3246           'key' => $values['key'],
3247         );
3248       }
3249       else {
3250         foreach ($values as $value) {
3251           // user does not have necessary permissions.
3252           if (!self::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $value)) {
3253             continue;
3254           }
3255
3256           // finally get menu item for -more- action widget.
3257           $contextMenu['otherActions'][$value['weight']] = array(
3258             'title' => $value['title'],
3259             'ref' => $value['ref'],
3260             'href' => CRM_Utils_Array::value('href', $value),
3261             'tab' => CRM_Utils_Array::value('tab', $value),
3262             'class' => CRM_Utils_Array::value('class', $value),
3263             'icon' => CRM_Utils_Array::value('icon', $value),
3264             'key' => $value['key'],
3265           );
3266         }
3267       }
3268     }
3269
3270     ksort($contextMenu['moreActions']);
3271     ksort($contextMenu['otherActions']);
3272
3273     return $contextMenu;
3274   }
3275
3276   /**
3277    * Check if user has permissions to access items in action menu.
3278    *
3279    * @param array $aclPermissionedTasks
3280    *   Array containing ACL related tasks.
3281    * @param string $corePermission
3282    *   The permission of the user (edit or view or null).
3283    * @param array $menuOptions
3284    *   Array containing params of the menu (title, href, etc).
3285    *
3286    * @return bool
3287    *   TRUE if user has all permissions, FALSE if otherwise.
3288    */
3289   public static function checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $menuOptions) {
3290     $componentName = CRM_Utils_Array::value('component', $menuOptions);
3291
3292     // if component action - make sure component is enable.
3293     if ($componentName && !in_array($componentName, CRM_Core_Config::singleton()->enableComponents)) {
3294       return FALSE;
3295     }
3296
3297     // make sure user has all required permissions.
3298     $hasAllPermissions = FALSE;
3299
3300     $permissions = CRM_Utils_Array::value('permissions', $menuOptions);
3301     if (!is_array($permissions) || empty($permissions)) {
3302       $hasAllPermissions = TRUE;
3303     }
3304
3305     // iterate for required permissions in given permissions array.
3306     if (!$hasAllPermissions) {
3307       $hasPermissions = 0;
3308       foreach ($permissions as $permission) {
3309         if (CRM_Core_Permission::check($permission)) {
3310           $hasPermissions++;
3311         }
3312       }
3313
3314       if (count($permissions) == $hasPermissions) {
3315         $hasAllPermissions = TRUE;
3316       }
3317
3318       // if still user does not have required permissions, check acl.
3319       if (!$hasAllPermissions && $menuOptions['ref'] != 'delete-contact') {
3320         if (in_array($menuOptions['ref'], $aclPermissionedTasks) &&
3321             $corePermission == CRM_Core_Permission::EDIT
3322             ) {
3323           $hasAllPermissions = TRUE;
3324         }
3325         elseif (in_array($menuOptions['ref'], array(
3326           'new-email',
3327         ))) {
3328           // grant permissions for these tasks.
3329           $hasAllPermissions = TRUE;
3330         }
3331       }
3332     }
3333
3334     return $hasAllPermissions;
3335   }
3336
3337   /**
3338    * Retrieve display name of contact that address is shared.
3339    *
3340    * This is based on $masterAddressId or $contactId .
3341    *
3342    * @param int $masterAddressId
3343    *   Master id.
3344    * @param int $contactId
3345    *   Contact id. (deprecated - do not use)
3346    *
3347    * @return string|null
3348    *   the found display name or null.
3349    */
3350   public static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) {
3351     $masterDisplayName = NULL;
3352     if (!$masterAddressId) {
3353       return $masterDisplayName;
3354     }
3355
3356     $sql = "
3357    SELECT display_name from civicrm_contact
3358 LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id )
3359     WHERE civicrm_address.id = " . $masterAddressId;
3360
3361     $masterDisplayName = CRM_Core_DAO::singleValueQuery($sql);
3362     return $masterDisplayName;
3363   }
3364
3365   /**
3366    * Get the creation/modification times for a contact.
3367    *
3368    * @param int $contactId
3369    *
3370    * @return array
3371    *   Dates - ('created_date' => $, 'modified_date' => $)
3372    */
3373   public static function getTimestamps($contactId) {
3374     $timestamps = CRM_Core_DAO::executeQuery(
3375       'SELECT created_date, modified_date
3376       FROM civicrm_contact
3377       WHERE id = %1',
3378       array(
3379         1 => array($contactId, 'Integer'),
3380       )
3381     );
3382     if ($timestamps->fetch()) {
3383       return array(
3384         'created_date' => $timestamps->created_date,
3385         'modified_date' => $timestamps->modified_date,
3386       );
3387     }
3388     else {
3389       return NULL;
3390     }
3391   }
3392
3393   /**
3394    * Get a list of triggers for the contact table.
3395    *
3396    * @see hook_civicrm_triggerInfo
3397    * @see CRM_Core_DAO::triggerRebuild
3398    * @see http://issues.civicrm.org/jira/browse/CRM-10554
3399    *
3400    * @param $info
3401    * @param null $tableName
3402    */
3403   public static function triggerInfo(&$info, $tableName = NULL) {
3404     //during upgrade, first check for valid version and then create triggers
3405     //i.e the columns created_date and modified_date are introduced in 4.3.alpha1 so dont create triggers for older version
3406     if (CRM_Core_Config::isUpgradeMode()) {
3407       $currentVer = CRM_Core_BAO_Domain::version(TRUE);
3408       //if current version is less than 4.3.alpha1 dont create below triggers
3409       if (version_compare($currentVer, '4.3.alpha1') < 0) {
3410         return;
3411       }
3412     }
3413
3414     // Modifications to these records should update the contact timestamps.
3415     \Civi\Core\SqlTrigger\TimestampTriggers::create('civicrm_contact', 'Contact')
3416       ->setRelations(array(
3417           array('table' => 'civicrm_address', 'column' => 'contact_id'),
3418           array('table' => 'civicrm_email', 'column' => 'contact_id'),
3419           array('table' => 'civicrm_im', 'column' => 'contact_id'),
3420           array('table' => 'civicrm_phone', 'column' => 'contact_id'),
3421           array('table' => 'civicrm_website', 'column' => 'contact_id'),
3422         )
3423       )
3424       ->alterTriggerInfo($info, $tableName);
3425
3426     // Update phone table to populate phone_numeric field
3427     if (!$tableName || $tableName == 'civicrm_phone') {
3428       // Define stored sql function needed for phones
3429       $sqlTriggers = Civi::service('sql_triggers');
3430       $sqlTriggers->enqueueQuery(self::DROP_STRIP_FUNCTION_43);
3431       $sqlTriggers->enqueueQuery(self::CREATE_STRIP_FUNCTION_43);
3432       $info[] = array(
3433         'table' => array('civicrm_phone'),
3434         'when' => 'BEFORE',
3435         'event' => array('INSERT', 'UPDATE'),
3436         'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n",
3437       );
3438     }
3439   }
3440
3441   /**
3442    * Check if contact is being used in civicrm_domain based on $contactId.
3443    *
3444    * @param int $contactId
3445    *   Contact id.
3446    *
3447    * @return bool
3448    *   true if present else false.
3449    */
3450   public static function checkDomainContact($contactId) {
3451     if (!$contactId) {
3452       return FALSE;
3453     }
3454     $domainId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id');
3455
3456     if ($domainId) {
3457       return TRUE;
3458     }
3459     else {
3460       return FALSE;
3461     }
3462   }
3463
3464   /**
3465    * Get options for a given contact field.
3466    *
3467    * @see CRM_Core_DAO::buildOptions
3468    *
3469    * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
3470    * TODO: In context of chainselect, what to return if e.g. a country has no states?
3471    *
3472    * @param string $fieldName
3473    * @param string $context
3474    * @see CRM_Core_DAO::buildOptionsContext
3475    * @param array $props
3476    *   whatever is known about this dao object.
3477    *
3478    * @return array|bool
3479    */
3480   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3481     $params = array();
3482     // Special logic for fields whose options depend on context or properties
3483     switch ($fieldName) {
3484       case 'contact_sub_type':
3485         if (!empty($props['contact_type'])) {
3486           $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')";
3487         }
3488         break;
3489
3490       case 'contact_type':
3491         if ($context == 'search') {
3492           // CRM-15495 - EntityRef filters and basic search forms expect this format
3493           // FIXME: Search builder does not
3494           return CRM_Contact_BAO_ContactType::getSelectElements();
3495         }
3496         break;
3497
3498       // The contact api supports some related entities so we'll honor that by fetching their options
3499       case 'group_id':
3500       case 'group':
3501         return CRM_Contact_BAO_GroupContact::buildOptions('group_id', $context, $props);
3502
3503       case 'tag_id':
3504       case 'tag':
3505         $props['entity_table'] = 'civicrm_contact';
3506         return CRM_Core_BAO_EntityTag::buildOptions('tag_id', $context, $props);
3507
3508       case 'state_province_id':
3509       case 'state_province':
3510       case 'state_province_name':
3511       case 'country_id':
3512       case 'country':
3513       case 'county_id':
3514       case 'worldregion':
3515       case 'worldregion_id':
3516         return CRM_Core_BAO_Address::buildOptions($fieldName, 'get', $props);
3517
3518     }
3519     return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context);
3520   }
3521
3522   /**
3523    * Delete a contact-related object that has an 'is_primary' field.
3524    *
3525    * Ensures that is_primary gets assigned to another object if available
3526    * Also calls pre/post hooks
3527    *
3528    * @param string $type
3529    * @param int $id
3530    * @return bool
3531    */
3532   public static function deleteObjectWithPrimary($type, $id) {
3533     if (!$id || !is_numeric($id)) {
3534       return FALSE;
3535     }
3536     $daoName = "CRM_Core_DAO_$type";
3537     $obj = new $daoName();
3538     $obj->id = $id;
3539     $obj->find();
3540     $hookParams = [];
3541     if ($obj->fetch()) {
3542       CRM_Utils_Hook::pre('delete', $type, $id, $hookParams);
3543       $contactId = $obj->contact_id;
3544       $obj->delete();
3545     }
3546     else {
3547       return FALSE;
3548     }
3549     // is_primary is only relavent if this field belongs to a contact
3550     if ($contactId) {
3551       $dao = new $daoName();
3552       $dao->contact_id = $contactId;
3553       $dao->is_primary = 1;
3554       // Pick another record to be primary (if one isn't already)
3555       if (!$dao->find(TRUE)) {
3556         $dao->is_primary = 0;
3557         $dao->find();
3558         if ($dao->fetch()) {
3559           $dao->is_primary = 1;
3560           $dao->save();
3561         }
3562       }
3563     }
3564     CRM_Utils_Hook::post('delete', $type, $id, $obj);
3565     $obj->free();
3566     return TRUE;
3567   }
3568
3569   /**
3570    * @inheritDoc
3571    */
3572   public function addSelectWhereClause() {
3573     // We always return an array with these keys, even if they are empty,
3574     // because this tells the query builder that we have considered these fields for acls
3575     $clauses = array(
3576       'id' => (array) CRM_Contact_BAO_Contact_Permission::cacheSubquery(),
3577       'is_deleted' => CRM_Core_Permission::check('access deleted contacts') ? array() : array('!= 1'),
3578     );
3579     CRM_Utils_Hook::selectWhereClause($this, $clauses);
3580     return $clauses;
3581   }
3582
3583   /**
3584    * Get any existing duplicate contacts based on the input parameters.
3585    *
3586    * @param array $input
3587    *   Input parameters to be matched.
3588    * @param string $contactType
3589    * @param string $rule
3590    *  - Supervised
3591    *  - Unsupervised
3592    * @param $excludedContactIDs
3593    *   An array of ids not to be included in the results.
3594    * @param bool $checkPermissions
3595    * @param int $ruleGroupID
3596    *   ID of the rule group to be used if an override is desirable.
3597    *
3598    * @return array
3599    */
3600   public static function getDuplicateContacts($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = array(), $checkPermissions = TRUE, $ruleGroupID = NULL) {
3601     $dedupeParams = CRM_Dedupe_Finder::formatParams($input, $contactType);
3602     $dedupeParams['check_permission'] = $checkPermissions;
3603     $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $contactType, $rule, $excludedContactIDs, $ruleGroupID);
3604     return $ids;
3605   }
3606
3607   /**
3608    * Get the first duplicate contacts based on the input parameters.
3609    *
3610    * @param array $input
3611    *   Input parameters to be matched.
3612    * @param string $contactType
3613    * @param string $rule
3614    *  - Supervised
3615    *  - Unsupervised
3616    * @param $excludedContactIDs
3617    *   An array of ids not to be included in the results.
3618    * @param bool $checkPermissions
3619    * @param int $ruleGroupID
3620    *   ID of the rule group to be used if an override is desirable.
3621    *
3622    * @return int|NULL
3623    */
3624   public static function getFirstDuplicateContact($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = array(), $checkPermissions = TRUE, $ruleGroupID = NULL) {
3625     $ids = self::getDuplicateContacts($input, $contactType, $rule, $excludedContactIDs, $checkPermissions, $ruleGroupID);
3626     if (empty($ids)) {
3627       return NULL;
3628     }
3629     return $ids[0];
3630   }
3631
3632   /**
3633    * Check if a field is associated with an entity that has a location type.
3634    *
3635    * (ie. is an address, phone, email etc field).
3636    *
3637    * @param string $fieldTitle
3638    *   Title of the field (not the name - create a new function for that if required).
3639    *
3640    * @return bool
3641    */
3642   public static function isFieldHasLocationType($fieldTitle) {
3643     foreach (CRM_Contact_BAO_Contact::importableFields() as $key => $field) {
3644       if ($field['title'] === $fieldTitle) {
3645         return CRM_Utils_Array::value('hasLocationType', $field);
3646       }
3647     }
3648     return FALSE;
3649   }
3650
3651   /**
3652    * @param array $appendProfiles
3653    *   Name of profile(s) to append to each link.
3654    *
3655    * @return array
3656    */
3657   public static function getEntityRefCreateLinks($appendProfiles = []) {
3658     // You'd think that "create contacts" would be the permission to check,
3659     // But new contact popups are profile forms and those use their own permissions.
3660     if (!CRM_Core_Permission::check([['profile create', 'profile listings and forms']])) {
3661       return FALSE;
3662     }
3663     $profiles = [];
3664     foreach (CRM_Contact_BAO_ContactType::basicTypes() as $contactType) {
3665       $profiles[] = 'new_' . strtolower($contactType);
3666     }
3667     $retrieved = civicrm_api3('uf_group', 'get', [
3668       'name' => ['IN' => array_merge($profiles, (array) $appendProfiles)],
3669       'is_active' => 1,
3670     ]);
3671     $links = $append = [];
3672     if (!empty($retrieved['values'])) {
3673       $icons = [
3674         'individual' => 'fa-user',
3675         'organization' => 'fa-building',
3676         'household' => 'fa-home',
3677       ];
3678       foreach ($retrieved['values'] as $id => $profile) {
3679         if (in_array($profile['name'], $profiles)) {
3680           $links[] = array(
3681             'label' => $profile['title'],
3682             'url' => CRM_Utils_System::url('civicrm/profile/create', "reset=1&context=dialog&gid=$id",
3683               NULL, NULL, FALSE, FALSE, TRUE),
3684             'type' => ucfirst(str_replace('new_', '', $profile['name'])),
3685             'icon' => CRM_Utils_Array::value(str_replace('new_', '', $profile['name']), $icons),
3686           );
3687         }
3688         else {
3689           $append[] = $id;
3690         }
3691       }
3692       foreach ($append as $id) {
3693         foreach ($links as &$link) {
3694           $link['url'] .= ",$id";
3695         }
3696       }
3697     }
3698     return $links;
3699   }
3700
3701   /**
3702    * @return array
3703    */
3704   public static function getEntityRefFilters() {
3705     return [
3706       ['key' => 'contact_type', 'value' => ts('Contact Type')],
3707       ['key' => 'group', 'value' => ts('Group'), 'entity' => 'GroupContact'],
3708       ['key' => 'tag', 'value' => ts('Tag'), 'entity' => 'EntityTag'],
3709       ['key' => 'state_province', 'value' => ts('State/Province'), 'entity' => 'Address'],
3710       ['key' => 'country', 'value' => ts('Country'), 'entity' => 'Address'],
3711       ['key' => 'gender_id', 'value' => ts('Gender'), 'condition' => ['contact_type' => 'Individual']],
3712       ['key' => 'is_deceased', 'value' => ts('Deceased'), 'condition' => ['contact_type' => 'Individual']],
3713       ['key' => 'contact_id', 'value' => ts('Contact ID'), 'type' => 'text'],
3714       ['key' => 'external_identifier', 'value' => ts('External ID'), 'type' => 'text'],
3715       ['key' => 'source', 'value' => ts('Contact Source'), 'type' => 'text'],
3716     ];
3717   }
3718
3719 }