3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * this file contains functions for synchronizing cms users with CiviCRM contacts
40 require_once 'DB.php';
41 class CRM_Core_BAO_CMSUser
{
44 * Function for synchronizing cms users with CiviCRM contacts
53 static function synchronize() {
54 //start of schronization code
55 $config = CRM_Core_Config
::singleton();
57 // Build an array of rows from UF users table.
59 if ($config->userSystem
->is_drupal
== '1') {
64 $result = db_query("SELECT uid, mail, name FROM {users} where mail != ''");
66 if ($config->userFramework
== 'Drupal') {
67 while ($row = $result->fetchAssoc()) {
71 elseif ($config->userFramework
== 'Drupal6') {
72 while ($row = db_fetch_array($result)) {
77 elseif ($config->userFramework
== 'Joomla') {
81 // TODO: Insert code here to populate $rows for Joomla;
83 elseif ($config->userFramework
== 'WordPress') {
88 CRM_Core_Error
::fatal('CMS user creation not supported for this framework');
93 if ($config->userSystem
->is_drupal
== '1') {
94 $user = new StdClass();
95 $uf = $config->userFramework
;
99 foreach ($rows as $row) {
100 $user->$id = $row[$id];
101 $user->$mail = $row[$mail];
102 $user->$name = $row[$name];
104 if ($match = CRM_Core_BAO_UFMatch
::synchronizeUFMatch($user, $row[$id], $row[$mail], $uf, 1, 'Individual', TRUE)) {
110 if (is_object($match)) {
115 elseif ($config->userFramework
== 'Joomla') {
117 $JUserTable = &JTable
::getInstance('User', 'JTable');
119 $db = $JUserTable->getDbo();
120 $query = $db->getQuery(TRUE);
121 $query->select($id . ', ' . $mail . ', ' . $name);
122 $query->from($JUserTable->getTableName());
123 $query->where($mail != '');
125 $db->setQuery($query, 0, $limit);
126 $users = $db->loadObjectList();
128 $user = new StdClass();
129 $uf = $config->userFramework
;
132 $contactMatching = 0;
133 for ($i = 0; $i < count($users); $i++
) {
134 $user->$id = $users[$i]->$id;
135 $user->$mail = $users[$i]->$mail;
136 $user->$name = $users[$i]->$name;
138 if ($match = CRM_Core_BAO_UFMatch
::synchronizeUFMatch($user,
151 if (is_object($match)) {
156 elseif ($config->userFramework
== 'WordPress') {
157 $uf = $config->userFramework
;
160 $contactMatching = 0;
163 $wpUserIds = $wpdb->get_col("SELECT $wpdb->users.ID FROM $wpdb->users");
165 foreach ($wpUserIds as $wpUserId) {
166 $wpUserData = get_userdata($wpUserId);
168 if ($match = CRM_Core_BAO_UFMatch
::synchronizeUFMatch($wpUserData,
181 if (is_object($match)) {
186 //end of schronization code
187 $status = ts('Synchronize Users to Contacts completed.');
188 $status .= ' ' . ts('Checked one user record.',
190 'count' => $contactCount,
191 'plural' => 'Checked %count user records.'
194 if ($contactMatching) {
195 $status .= ' ' . ts('Found one matching contact record.',
197 'count' => $contactMatching,
198 'plural' => 'Found %count matching contact records.'
203 $status .= ' ' . ts('Created one new contact record.',
205 'count' => $contactCreated,
206 'plural' => 'Created %count new contact records.'
209 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');
210 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));
214 * Function to create CMS user using Profile
216 * @param array $params associated array
217 * @param string $mail email id for cms user
219 * @return int contact id that has been created
223 static function create(&$params, $mail) {
224 $config = CRM_Core_Config
::singleton();
226 $ufID = $config->userSystem
->createUser($params, $mail);
228 //if contact doesn't already exist create UF Match
229 if ($ufID !== FALSE &&
230 isset($params['contactID'])
232 // create the UF Match record
233 $ufmatch = new CRM_Core_DAO_UFMatch();
234 $ufmatch->domain_id
= CRM_Core_Config
::domainID();
235 $ufmatch->uf_id
= $ufID;
236 $ufmatch->contact_id
= $params['contactID'];
237 $ufmatch->uf_name
= $params[$mail];
239 if (!$ufmatch->find(TRUE)) {
248 * Function to create Form for CMS user using Profile
250 * @param object $form
251 * @param integer $gid id of group of profile
252 * @param bool $emailPresent true if the profile field has email(primary)
253 * @return FALSE|void WTF
258 static function buildForm(&$form, $gid, $emailPresent, $action = CRM_Core_Action
::NONE
) {
259 $config = CRM_Core_Config
::singleton();
262 $isDrupal = $config->userSystem
->is_drupal
;
263 $isJoomla = ucfirst($config->userFramework
) == 'Joomla' ?
TRUE : FALSE;
264 $isWordPress = $config->userFramework
== 'WordPress' ?
TRUE : FALSE;
266 //if CMS is configured for not to allow creating new CMS user,
267 //don't build the form,Fixed for CRM-4036
269 $userParams = JComponentHelper
::getParams('com_users');
270 if (!$userParams->get('allowUserRegistration')) {
274 elseif ($isDrupal && !variable_get('user_register', TRUE)) {
277 elseif ($isWordPress && !get_option('users_can_register')) {
282 $isCMSUser = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'is_cms_user');
285 // $cms is true when there is email(primary location) is set in the profile field.
286 $session = CRM_Core_Session
::singleton();
287 $userID = $session->get('userID');
288 $showUserRegistration = FALSE;
290 $showUserRegistration = TRUE;
292 elseif (!$action && !$userID) {
293 $showUserRegistration = TRUE;
296 if ($isCMSUser && $emailPresent) {
297 if ($showUserRegistration) {
298 if ($isCMSUser != 2) {
300 'onclick' => "return showHideByValue('cms_create_account','','details','block','radio',false );",
302 $form->addElement('checkbox', 'cms_create_account', ts('Create an account?'), NULL, $extra);
306 $form->add('hidden', 'cms_create_account', 1);
310 $form->assign('isCMS', $required);
311 if (!$userID ||
$action & CRM_Core_Action
::PREVIEW ||
$action & CRM_Core_Action
::PROFILE
) {
312 $form->add('text', 'cms_name', ts('Username'), NULL, $required);
313 if (($isDrupal && !variable_get('user_email_verification', TRUE)) OR ($isJoomla) OR ($isWordPress)) {
314 $form->add('password', 'cms_pass', ts('Password'));
315 $form->add('password', 'cms_confirm_pass', ts('Confirm Password'));
318 $form->addFormRule(array('CRM_Core_BAO_CMSUser', 'formRule'), $form);
324 $destination = $config->userSystem
->getLoginDestination($form);
325 $loginURL = $config->userSystem
->getLoginURL($destination);
326 $form->assign('loginURL', $loginURL);
327 $form->assign('showCMS', $showCMS);
331 * Checks that there is a valid username & email
332 * optionally checks password is present & matches DB & gets the CMS to validate
334 * @params array $fields Posted values of form
335 * @param array $files uploaded files if any
336 * @param array $self reference to form object
339 static function formRule($fields, $files, $self) {
340 if (!CRM_Utils_Array
::value('cms_create_account', $fields)) {
344 $config = CRM_Core_Config
::singleton();
346 $isDrupal = $config->userSystem
->is_drupal
;
347 $isJoomla = ucfirst($config->userFramework
) == 'Joomla' ?
TRUE : FALSE;
348 $isWordPress = $config->userFramework
== 'WordPress' ?
TRUE : FALSE;
351 if ($isDrupal ||
$isJoomla ||
$isWordPress) {
353 if (!empty($self->_bltID
) && array_key_exists("email-{$self->_bltID}", $fields)) {
354 // this is a transaction related page
355 $emailName = 'email-' . $self->_bltID
;
357 // find the email field in a profile page
358 foreach ($fields as $name => $dontCare) {
359 if (substr($name, 0, 5) == 'email') {
366 if ($emailName == NULL) {
367 $errors['_qf_default'] == ts('Could not find an email address.');
371 if (empty($fields['cms_name'])) {
372 $errors['cms_name'] = ts('Please specify a username.');
375 if (empty($fields[$emailName])) {
376 $errors[$emailName] = ts('Please specify a valid email address.');
379 if (($isDrupal && !variable_get('user_email_verification', TRUE)) OR ($isJoomla) OR ($isWordPress)) {
380 if (empty($fields['cms_pass']) ||
381 empty($fields['cms_confirm_pass'])
383 $errors['cms_pass'] = ts('Please enter a password.');
385 if ($fields['cms_pass'] != $fields['cms_confirm_pass']) {
386 $errors['cms_pass'] = ts('Password and Confirm Password values are not the same.');
390 if (!empty($errors)) {
394 // now check that the cms db does not have the user name and/or email
395 if ($isDrupal OR $isJoomla OR $isWordPress) {
397 'name' => $fields['cms_name'],
398 'mail' => $fields[$emailName],
402 $config->userSystem
->checkUserNameEmailExists($params, $errors, $emailName);
404 return (!empty($errors)) ?
$errors : TRUE;
408 * Function to check if a cms user already exists.
410 * @param Array $contact array of contact-details
412 * @return uid if user exists, false otherwise
417 static function userExists(&$contact) {
418 $config = CRM_Core_Config
::singleton();
420 $isDrupal = $config->userSystem
->is_drupal
;
421 $isJoomla = ucfirst($config->userFramework
) == 'Joomla' ?
TRUE : FALSE;
422 $isWordPress = $config->userFramework
== 'WordPress' ?
TRUE : FALSE;
424 if (!$isDrupal && !$isJoomla && !$isWordPress) {
425 die('Unknown user framework');
428 // Use UF native framework to fetch data from UF user table
431 "SELECT uid FROM {users} where mail = :email",
432 array(':email' => $contact['email'])
436 $contact['user_exists'] = TRUE;
441 $mail = $contact['email'];
443 $JUserTable = &JTable
::getInstance('User', 'JTable');
445 $db = $JUserTable->getDbo();
446 $query = $db->getQuery(TRUE);
447 $query->select('username, email');
448 $query->from($JUserTable->getTableName());
449 $query->where('(LOWER(email) = LOWER(\'' . $email . '\'))');
450 $db->setQuery($query, 0, $limit);
451 $users = $db->loadAssocList();
459 $uid = CRM_Utils_Array
::value('id', $row);
460 $contact['user_exists'] = TRUE;
464 elseif ($isWordPress) {
465 if (email_exists($params['mail'])) {
466 $contact['user_exists'] = TRUE;
467 $userObj = get_user_by('email', $params['mail']);
475 static function &dbHandle(&$config) {
476 CRM_Core_Error
::ignoreException();
477 $db_uf = DB
::connect($config->userFrameworkDSN
);
478 CRM_Core_Error
::setCallback();
482 $session = CRM_Core_Session
::singleton();
483 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));
484 CRM_Core_Error
::statusBounce(ts("Cannot connect to UF db via %1. Please check the CIVICRM_UF_DSN value in your civicrm.settings.php file",
485 array(1 => $db_uf->getMessage())
488 $db_uf->query('/*!40101 SET NAMES utf8 */');