Skip to content
Snippets Groups Projects
Unverified Commit 50162152 authored by DaveD's avatar DaveD Committed by GitHub
Browse files

Merge pull request #25585 from herbdool/core-4127-4 

#4127 move cms user parameters to userSystem
parents 08ac1230 758a3617
Branches
Tags
No related merge requests found
Hide whitespace changes
Inline Side-by-side
CRM/Core/BAO/UFMatch.php
+ 54
− 80
View file @ 50162152
......@@ -47,10 +47,10 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
/**
* Given a UF user object, make sure there is a contact
* object for this user. If the user has new values, we need
* to update the CRM DB with the new values
* to update the CRM DB with the new values.
*
* @param Object $user
* The drupal user object.
* The user object.
* @param bool $update
* Has the user object been edited.
* @param $uf
......@@ -71,9 +71,8 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
$userSystemID = $userSystem->getBestUFID($user);
$uniqId = $userSystem->getBestUFUniqueIdentifier($user);
// if the id of the object is zero (true for anon users in drupal)
// have we already processed this user, if so early
// return.
// If the id of the object is zero (true for anon users in Drupal),
// have we already processed this user? If so return early.
$userID = $session->get('userID');
$ufID = $session->get('ufID');
......@@ -81,14 +80,14 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
return;
}
//check do we have logged in user.
// Check do we have logged in user.
$isUserLoggedIn = CRM_Utils_System::isUserLoggedIn();
// reset the session if we are a different user
// Reset the session if we are a different user.
if ($ufID && $ufID != $userSystemID) {
$session->reset();
//get logged in user ids, and set to session.
// Get logged in user ids, and set to session.
if ($isUserLoggedIn) {
$userIds = self::getUFValues();
$session->set('ufID', CRM_Utils_Array::value('uf_id', $userIds, ''));
......@@ -96,7 +95,7 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
}
}
// return early
// Return early.
if ($userSystemID == 0) {
return;
}
......@@ -106,12 +105,12 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
return;
}
//make sure we have session w/ consistent ids.
// Make sure we have session w/ consistent ids.
$ufID = $ufmatch->uf_id;
$userID = $ufmatch->contact_id;
if ($isUserLoggedIn) {
$loggedInUserUfID = CRM_Utils_System::getLoggedInUfID();
//are we processing logged in user.
// Are we processing logged in user.
if ($loggedInUserUfID && $loggedInUserUfID != $ufID) {
$userIds = self::getUFValues($loggedInUserUfID);
$ufID = CRM_Utils_Array::value('uf_id', $userIds, '');
......@@ -119,11 +118,11 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
}
}
//set user ids to session.
// Set user ids to session.
$session->set('ufID', $ufID);
$session->set('userID', $userID);
// add current contact to recently viewed
// Add current contact to recently viewed.
if ($ufmatch->contact_id) {
[$displayName, $contactImage, $contactType, $contactSubtype, $contactImageUrl]
= CRM_Contact_BAO_Contact::getDisplayAndImage($ufmatch->contact_id, TRUE, TRUE);
......@@ -146,11 +145,10 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
}
/**
* Synchronize the object with the UF Match entry. Can be called stand-alone from
* the drupalUsers script
* Synchronize the object with the UF Match entry.
*
* @param Object $user
* The drupal user object.
* The user object.
* @param string $userKey
* The id of the user from the uf object.
* @param string $uniqId
......@@ -169,7 +167,7 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
$config = CRM_Core_Config::singleton();
$newContact = FALSE;
// make sure that a contact id exists for this user id
// Make sure that a contact id exists for this user id.
$ufmatch = new CRM_Core_DAO_UFMatch();
$ufmatch->domain_id = CRM_Core_Config::domainID();
$ufmatch->uf_id = $userKey;
......@@ -181,9 +179,12 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
if (!empty($_POST) && !$isLogin) {
$dedupeParameters = $_POST;
$dedupeParameters['email'] = $uniqId;
// dev/core#1858 Ensure that if we have a contactID parameter which is set in the Create user Record contact task form
// That this contactID value is passed through as the contact_id to the get duplicate contacts function. This is necessary because for Drupal 8 this function gets invoked
// Before the civicrm_uf_match record is added where as in D7 it isn't called until the user tries to actually login.
// dev/core#1858 Ensure that if we have a contactID parameter which is
// set in the Create user Record contact task form. That this contactID
// value is passed through as the contact_id to the get duplicate
// contacts function. This is necessary because for Drupal 8 this
// function gets invoked. Before the civicrm_uf_match record is added
// where as in D7 it isn't called until the user tries to actually login.
if (!empty($dedupeParameters['contactID'])) {
$dedupeParameters['contact_id'] = $dedupeParameters['contactID'];
}
......@@ -191,14 +192,14 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
$ids = CRM_Contact_BAO_Contact::getDuplicateContacts($dedupeParameters, 'Individual', 'Unsupervised', [], FALSE);
if (!empty($ids) && Civi::settings()->get('uniq_email_per_site')) {
// restrict dupeIds to ones that belong to current domain/site.
// Restrict dupeIds to ones that belong to current domain/site.
$siteContacts = CRM_Core_BAO_Domain::getContactList();
foreach ($ids as $index => $dupeId) {
if (!in_array($dupeId, $siteContacts)) {
unset($ids[$index]);
}
}
// re-index the array
// Re-index the array.
$ids = array_values($ids);
}
if (!empty($ids)) {
......@@ -212,9 +213,8 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
$found = FALSE;
if ($dao) {
// ensure there does not exists a contact_id / uf_id pair
// in the DB. This might be due to multiple emails per contact
// CRM-9091
// Ensure there does not exists a contact_id / uf_id pair in the DB.
// This might be due to multiple emails per contact CRM-9091.
$sql = '
SELECT id
FROM civicrm_uf_match
......@@ -235,24 +235,10 @@ AND domain_id = %2
}
if (!$found) {
$contactParameters = [];
// Not sure why we're testing for this. Is there ever a case
// in which $user is not an object?
if (is_object($user)) {
if ($config->userSystem->is_drupal) {
$primary_email = $uniqId;
}
elseif ($uf === 'WordPress') {
$primary_email = $user->user_email;
}
else {
$primary_email = $user->email;
}
$contactParameters['email'] = $primary_email;
}
else {
CRM_Core_Error::deprecatedWarning('please log how you hit this...');
}
$contactParameters = $config->userSystem->getContactDetailsFromUser([
'user' => $user,
'uniqId' => $uniqId,
]);
if ($ctype === 'Organization') {
$contactParameters['organization_name'] = $uniqId;
......@@ -263,30 +249,15 @@ AND domain_id = %2
$contactParameters['contact_type'] = $ctype ?? 'Individual';
// extract first / middle / last name
// for joomla
if ($uf === 'Joomla' && $user->name) {
CRM_Utils_String::extractName($user->name, $contactParameters);
}
if ($uf === 'WordPress') {
if ($user->first_name) {
$contactParameters['first_name'] = $user->first_name;
}
if ($user->last_name) {
$contactParameters['last_name'] = $user->last_name;
}
}
$contactID = civicrm_api3('Contact', 'create', $contactParameters)['id'];
$ufmatch->contact_id = $contactID;
$ufmatch->uf_name = $uniqId;
}
// check that there are not two CMS IDs matching the same CiviCRM contact - this happens when a civicrm
// user has two e-mails and there is a cms match for each of them
// the gets rid of the nasty fata error but still reports the error
// Check that there are not two CMS IDs matching the same CiviCRM contact.
// This happens when a CiviCRM user has two e-mails and there is a cms
// match for each of them the gets rid of the nasty fata error but still
// reports the error.
$sql = "
SELECT uf_id
FROM civicrm_uf_match
......@@ -340,7 +311,7 @@ AND domain_id = %4
return;
}
// 1.do check for contact Id.
// 1. Do check for contact Id.
$ufmatch = new CRM_Core_DAO_UFMatch();
$ufmatch->contact_id = $contactId;
$ufmatch->domain_id = CRM_Core_Config::domainID();
......@@ -362,7 +333,7 @@ AND domain_id = %4
}
// CRM-6928
// 2.do check for duplicate ufName.
// 2. Do check for duplicate ufName.
$ufDupeName = new CRM_Core_DAO_UFMatch();
$ufDupeName->uf_name = $ufName;
$ufDupeName->domain_id = CRM_Core_Config::domainID();
......@@ -376,7 +347,7 @@ AND domain_id = %4
return;
}
// save the updated ufmatch object
// Save the updated ufmatch object.
$ufmatch->uf_name = $ufName;
$ufmatch->save();
$config->userSystem->updateCMSName($ufmatch->uf_id, $ufName);
......@@ -398,22 +369,23 @@ AND domain_id = %4
$ufmatch->contact_id = $contactId;
$ufmatch->domain_id = CRM_Core_Config::domainID();
if ($ufmatch->find(TRUE)) {
// Save the email in UF Match table
// Save the email in UF Match table.
$ufmatch->uf_name = $emailAddress;
CRM_Core_BAO_UFMatch::create((array) $ufmatch);
// If CMS integration is disabled skip Civi email update if CMS user email is changed
// If CMS integration is disabled skip Civi email update if CMS user email
// is changed.
if (Civi::settings()->get('syncCMSEmail') == FALSE) {
return;
}
//check if the primary email for the contact exists
//$contactDetails[1] - email
//$contactDetails[3] - email id
// Check if the primary email for the contact exists.
// $contactDetails[1] - email
// $contactDetails[3] - email id
$contactDetails = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactId);
if (trim($contactDetails[1])) {
//update if record is found but different
// Update if record is found but different.
$emailID = $contactDetails[3];
if (trim($contactDetails[1]) != $emailAddress) {
civicrm_api3('Email', 'create', [
......@@ -423,7 +395,7 @@ AND domain_id = %4
}
}
else {
//else insert a new email record
// Else insert a new email record.
$result = civicrm_api3('Email', 'create', [
'contact_id' => $contactId,
'email' => $emailAddress,
......@@ -452,7 +424,7 @@ AND domain_id = %4
$ufmatch->domain_id = $domainId = CRM_Core_Config::domainID();
$ufmatch->delete();
// Flush cache
// Flush cache.
Civi::$statics[__CLASS__][$domainId] = [];
}
......@@ -463,7 +435,7 @@ AND domain_id = %4
* Id of UF for which related contact_id is required.
*
* @return int|null
* contact_id on success, null otherwise
* contact_id on success, null otherwise.
*/
public static function getContactId($ufID) {
if (!$ufID) {
......@@ -496,7 +468,7 @@ AND domain_id = %4
* ID of the contact for which related uf_id is required.
*
* @return int|null
* uf_id of the given contact_id on success, null otherwise
* uf_id of the given contact_id on success, null otherwise.
*/
public static function getUFId($contactID) {
if (!$contactID) {
......@@ -532,7 +504,7 @@ AND domain_id = %4
*
* @deprecated
* @return int
* contact_id on success, null otherwise
* contact_id on success, null otherwise.
*/
public static function getContactIDs() {
CRM_Core_Error::deprecatedFunctionWarning('unused function to be removed');
......@@ -567,11 +539,11 @@ AND domain_id = %4
/**
* Get the next unused uf_id value, since the standalone UF doesn't
* have id's (it uses OpenIDs, which go in a different field)
* have id's (it uses OpenIDs, which go in a different field).
*
* @deprecated
* @return int
* next highest unused value for uf_id
* Next highest unused value for uf_id.
*/
public static function getNextUfIdValue() {
CRM_Core_Error::deprecatedFunctionWarning('unused function to be removed');
......@@ -588,7 +560,9 @@ AND domain_id = %4
}
/**
* @param $email
* Is duplicate user
*
* @param string $email
* @deprecated
* @return bool
*/
......@@ -644,7 +618,7 @@ AND domain_id = %4
* @inheritDoc
*/
public function addSelectWhereClause() {
// Prevent default behavior of joining ACLs onto the contact_id field
// Prevent default behavior of joining ACLs onto the contact_id field.
$clauses = [];
CRM_Utils_Hook::selectWhereClause($this, $clauses);
return $clauses;
......
CRM/Utils/System/Base.php
+ 17
− 0
View file @ 50162152
......@@ -1115,4 +1115,21 @@ abstract class CRM_Utils_System_Base {
return FALSE;
}
/**
* Get Contact details from User
* The contact parameters here will be used to create a Contact
* record to match the user record.
*
* @param array $uf_match
* Array of user object, unique ID.
* @return array
* Array of contact parameters.
*/
public function getContactDetailsFromUser($uf_match):array {
$contactParameters = [];
$contactParameters['email'] = $uf_match['user']->email;
return $contactParameters;
}
}
CRM/Utils/System/DrupalBase.php
+ 10
− 0
View file @ 50162152
......@@ -814,4 +814,14 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base {
return (bool) $enableWorkflow;
}
/**
* @inheritdoc
*/
public function getContactDetailsFromUser($uf_match):array {
$contactParameters = [];
$contactParameters['email'] = $uf_match['uniqId'];
return $contactParameters;
}
}
CRM/Utils/System/Joomla.php
+ 14
− 0
View file @ 50162152
......@@ -1017,4 +1017,18 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base {
];
}
/**
* @inheritdoc
*/
public function getContactDetailsFromUser($uf_match):array {
$contactParameters = [];
$user = $uf_match['user'];
$contactParameters['email'] = $user->email;
if ($user->name) {
CRM_Utils_String::extractName($user->name, $contactParameters);
}
return $contactParameters;
}
}
CRM/Utils/System/WordPress.php
+ 18
− 0
View file @ 50162152
......@@ -1654,4 +1654,22 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base {
return NULL;
}
/**
* @inheritdoc
*/
public function getContactDetailsFromUser($uf_match):array {
$contactParameters = [];
$user = $uf_match['user'];
$contactParameters['email'] = $user->user_email;
if ($user->first_name) {
$contactParameters['first_name'] = $user->first_name;
}
if ($user->last_name) {
$contactParameters['last_name'] = $user->last_name;
}
return $contactParameters;
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment