CRM/Core/BAO/CMSUser.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  *  this file contains functions for synchronizing cms users with CiviCRM contacts
  38  */
  39
  40 require_once 'DB.php';
  41
  42 /**
  43  * Class CRM_Core_BAO_CMSUser
  44  */
  45 class CRM_Core_BAO_CMSUser {
  46
  47   /**
  48    * Synchronizing cms users with CiviCRM contacts.
  49    *
  50    * @param bool $is_interactive
  51    *   Whether to show statuses & perform redirects.
  52    *   This behavior is misplaced in the BAO layer, but we'll preserve it to avoid
  53    *   contract changes in the middle of the support cycle. In the next major
  54    *   release, we should remove & document it.
  55    *
  56    * @return void
  57    *
  58    */
  59   public static function synchronize($is_interactive = TRUE) {
  60     //start of schronization code
  61     $config = CRM_Core_Config::singleton();
  62
  63     // Build an array of rows from UF users table.
  64     $rows = array();
  65     if ($config->userSystem->is_drupal == '1') {
  66       $id = 'uid';
  67       $mail = 'mail';
  68       $name = 'name';
  69
  70       $result = db_query("SELECT uid, mail, name FROM {users} where mail != ''");
  71
  72       if ($config->userFramework == 'Drupal') {
  73         while ($row = $result->fetchAssoc()) {
  74           $rows[] = $row;
  75         }
  76       }
  77       elseif ($config->userFramework == 'Drupal6') {
  78         while ($row = db_fetch_array($result)) {
  79           $rows[] = $row;
  80         }
  81       }
  82     }
  83     elseif ($config->userFramework == 'Joomla') {
  84       $id = 'id';
  85       $mail = 'email';
  86       $name = 'name';
  87       // TODO: Insert code here to populate $rows for Joomla;
  88     }
  89     elseif ($config->userFramework == 'WordPress') {
  90       $id = 'ID';
  91       $mail = 'user_email';
  92     }
  93     else {
  94       CRM_Core_Error::fatal('CMS user creation not supported for this framework');
  95     }
  96
  97     set_time_limit(300);
  98
  99     if ($config->userSystem->is_drupal == '1') {
 100       $user = new StdClass();
 101       $uf = $config->userFramework;
 102       $contactCount = 0;
 103       $contactCreated = 0;
 104       $contactMatching = 0;
 105       foreach ($rows as $row) {
 106         $user->$id = $row[$id];
 107         $user->$mail = $row[$mail];
 108         $user->$name = $row[$name];
 109         $contactCount++;
 110         if ($match = CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $row[$id], $row[$mail], $uf, 1, 'Individual', TRUE)) {
 111           $contactCreated++;
 112         }
 113         else {
 114           $contactMatching++;
 115         }
 116         if (is_object($match)) {
 117           $match->free();
 118         }
 119       }
 120     }
 121     elseif ($config->userFramework == 'Joomla') {
 122
 123       $JUserTable = &JTable::getInstance('User', 'JTable');
 124
 125       $db = $JUserTable->getDbo();
 126       $query = $db->getQuery(TRUE);
 127       $query->select($id . ', ' . $mail . ', ' . $name);
 128       $query->from($JUserTable->getTableName());
 129       $query->where($mail != '');
 130
 131       $db->setQuery($query, 0, $limit);
 132       $users = $db->loadObjectList();
 133
 134       $user = new StdClass();
 135       $uf = $config->userFramework;
 136       $contactCount = 0;
 137       $contactCreated = 0;
 138       $contactMatching = 0;
 139       for ($i = 0; $i < count($users); $i++) {
 140         $user->$id = $users[$i]->$id;
 141         $user->$mail = $users[$i]->$mail;
 142         $user->$name = $users[$i]->$name;
 143         $contactCount++;
 144         if ($match = CRM_Core_BAO_UFMatch::synchronizeUFMatch($user,
 145           $users[$i]->$id,
 146           $users[$i]->$mail,
 147           $uf,
 148           1,
 149           'Individual',
 150           TRUE
 151         )
 152         ) {
 153           $contactCreated++;
 154         }
 155         else {
 156           $contactMatching++;
 157         }
 158         if (is_object($match)) {
 159           $match->free();
 160         }
 161       }
 162     }
 163     elseif ($config->userFramework == 'WordPress') {
 164       $uf = $config->userFramework;
 165       $contactCount = 0;
 166       $contactCreated = 0;
 167       $contactMatching = 0;
 168
 169       global $wpdb;
 170       $wpUserIds = $wpdb->get_col("SELECT $wpdb->users.ID FROM $wpdb->users");
 171
 172       foreach ($wpUserIds as $wpUserId) {
 173         $wpUserData = get_userdata($wpUserId);
 174         $contactCount++;
 175         if ($match = CRM_Core_BAO_UFMatch::synchronizeUFMatch($wpUserData,
 176           $wpUserData->$id,
 177           $wpUserData->$mail,
 178           $uf,
 179           1,
 180           'Individual',
 181           TRUE
 182         )
 183         ) {
 184           $contactCreated++;
 185         }
 186         else {
 187           $contactMatching++;
 188         }
 189         if (is_object($match)) {
 190           $match->free();
 191         }
 192       }
 193     }
 194     //end of synchronization code
 195
 196     if ($is_interactive) {
 197       $status = ts('Synchronize Users to Contacts completed.');
 198       $status .= ' ' . ts('Checked one user record.',
 199           array(
 200             'count' => $contactCount,
 201             'plural' => 'Checked %count user records.',
 202           )
 203         );
 204       if ($contactMatching) {
 205         $status .= ' ' . ts('Found one matching contact record.',
 206             array(
 207               'count' => $contactMatching,
 208               'plural' => 'Found %count matching contact records.',
 209             )
 210           );
 211       }
 212
 213       $status .= ' ' . ts('Created one new contact record.',
 214           array(
 215             'count' => $contactCreated,
 216             'plural' => 'Created %count new contact records.',
 217           )
 218         );
 219       CRM_Core_Session::setStatus($status, ts('Saved'), 'success');
 220       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
 221     }
 222   }
 223
 224   /**
 225    * Create CMS user using Profile.
 226    *
 227    * @param array $params
 228    * @param string $mail
 229    *   Email id for cms user.
 230    *
 231    * @return int
 232    *   contact id that has been created
 233    */
 234   public static function create(&$params, $mail) {
 235     $config = CRM_Core_Config::singleton();
 236
 237     $ufID = $config->userSystem->createUser($params, $mail);
 238
 239     //if contact doesn't already exist create UF Match
 240     if ($ufID !== FALSE &&
 241       isset($params['contactID'])
 242     ) {
 243       // create the UF Match record
 244       $ufmatch['uf_id'] = $ufID;
 245       $ufmatch['contact_id'] = $params['contactID'];
 246       $ufmatch['uf_name'] = $params[$mail];
 247       CRM_Core_BAO_UFMatch::create($ufmatch);
 248     }
 249
 250     return $ufID;
 251   }
 252
 253   /**
 254    * Create Form for CMS user using Profile.
 255    *
 256    * @param CRM_Core_Form $form
 257    * @param int $gid
 258    *   Id of group of profile.
 259    * @param bool $emailPresent
 260    *   True if the profile field has email(primary).
 261    * @param \const|int $action
 262    *
 263    * @return FALSE|void
 264    *   WTF
 265    *
 266    */
 267   public static function buildForm(&$form, $gid, $emailPresent, $action = CRM_Core_Action::NONE) {
 268     $config = CRM_Core_Config::singleton();
 269     $showCMS = FALSE;
 270
 271     $isDrupal = $config->userSystem->is_drupal;
 272     $isJoomla = ucfirst($config->userFramework) == 'Joomla' ? TRUE : FALSE;
 273     $isWordPress = $config->userFramework == 'WordPress' ? TRUE : FALSE;
 274
 275     //if CMS is configured for not to allow creating new CMS user,
 276     //don't build the form,Fixed for CRM-4036
 277     if ($isJoomla) {
 278       $userParams = JComponentHelper::getParams('com_users');
 279       if (!$userParams->get('allowUserRegistration')) {
 280         return FALSE;
 281       }
 282     }
 283     elseif ($isDrupal && !variable_get('user_register', TRUE)) {
 284       return FALSE;
 285     }
 286     elseif ($isWordPress && !get_option('users_can_register')) {
 287       return FALSE;
 288     }
 289
 290     if ($gid) {
 291       $isCMSUser = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'is_cms_user');
 292     }
 293
 294     // $cms is true when there is email(primary location) is set in the profile field.
 295     $session = CRM_Core_Session::singleton();
 296     $userID = $session->get('userID');
 297     $showUserRegistration = FALSE;
 298     if ($action) {
 299       $showUserRegistration = TRUE;
 300     }
 301     elseif (!$action && !$userID) {
 302       $showUserRegistration = TRUE;
 303     }
 304
 305     if ($isCMSUser && $emailPresent) {
 306       if ($showUserRegistration) {
 307         if ($isCMSUser != 2) {
 308           $extra = array(
 309             'onclick' => "return showHideByValue('cms_create_account','','details','block','radio',false );",
 310           );
 311           $form->addElement('checkbox', 'cms_create_account', ts('Create an account?'), NULL, $extra);
 312           $required = FALSE;
 313         }
 314         else {
 315           $form->add('hidden', 'cms_create_account', 1);
 316           $required = TRUE;
 317         }
 318
 319         $form->assign('isCMS', $required);
 320         if (!$userID || $action & CRM_Core_Action::PREVIEW || $action & CRM_Core_Action::PROFILE) {
 321           $form->add('text', 'cms_name', ts('Username'), NULL, $required);
 322           if (($isDrupal && !variable_get('user_email_verification', TRUE)) OR ($isJoomla) OR ($isWordPress)) {
 323             $form->add('password', 'cms_pass', ts('Password'));
 324             $form->add('password', 'cms_confirm_pass', ts('Confirm Password'));
 325           }
 326
 327           $form->addFormRule(array('CRM_Core_BAO_CMSUser', 'formRule'), $form);
 328         }
 329         $showCMS = TRUE;
 330       }
 331     }
 332
 333     $destination = $config->userSystem->getLoginDestination($form);
 334     $loginURL = $config->userSystem->getLoginURL($destination);
 335     $form->assign('loginURL', $loginURL);
 336     $form->assign('showCMS', $showCMS);
 337   }
 338
 339   /**
 340    * Checks that there is a valid username & email
 341    * optionally checks password is present & matches DB & gets the CMS to validate
 342    *
 343    * @param array $fields
 344    *   Posted values of form.
 345    * @param array $files
 346    *   Uploaded files if any.
 347    * @param CRM_Core_Form $form
 348    *
 349    * @return array|bool
 350    */
 351   public static function formRule($fields, $files, $form) {
 352     if (empty($fields['cms_create_account'])) {
 353       return TRUE;
 354     }
 355
 356     $config = CRM_Core_Config::singleton();
 357
 358     $isDrupal = $config->userSystem->is_drupal;
 359     $isJoomla = ucfirst($config->userFramework) == 'Joomla' ? TRUE : FALSE;
 360     $isWordPress = $config->userFramework == 'WordPress' ? TRUE : FALSE;
 361
 362     $errors = array();
 363     if ($isDrupal || $isJoomla || $isWordPress) {
 364       $emailName = NULL;
 365       if (!empty($form->_bltID) && array_key_exists("email-{$form->_bltID}", $fields)) {
 366         // this is a transaction related page
 367         $emailName = 'email-' . $form->_bltID;
 368       }
 369       else {
 370         // find the email field in a profile page
 371         foreach ($fields as $name => $dontCare) {
 372           if (substr($name, 0, 5) == 'email') {
 373             $emailName = $name;
 374             break;
 375           }
 376         }
 377       }
 378
 379       if ($emailName == NULL) {
 380         $errors['_qf_default'] == ts('Could not find an email address.');
 381         return $errors;
 382       }
 383
 384       if (empty($fields['cms_name'])) {
 385         $errors['cms_name'] = ts('Please specify a username.');
 386       }
 387
 388       if (empty($fields[$emailName])) {
 389         $errors[$emailName] = ts('Please specify a valid email address.');
 390       }
 391
 392       if (($isDrupal && !variable_get('user_email_verification', TRUE)) OR ($isJoomla) OR ($isWordPress)) {
 393         if (empty($fields['cms_pass']) ||
 394           empty($fields['cms_confirm_pass'])
 395         ) {
 396           $errors['cms_pass'] = ts('Please enter a password.');
 397         }
 398         if ($fields['cms_pass'] != $fields['cms_confirm_pass']) {
 399           $errors['cms_pass'] = ts('Password and Confirm Password values are not the same.');
 400         }
 401       }
 402
 403       if (!empty($errors)) {
 404         return $errors;
 405       }
 406
 407       // now check that the cms db does not have the user name and/or email
 408       if ($isDrupal OR $isJoomla OR $isWordPress) {
 409         $params = array(
 410           'name' => $fields['cms_name'],
 411           'mail' => $fields[$emailName],
 412         );
 413       }
 414
 415       $config->userSystem->checkUserNameEmailExists($params, $errors, $emailName);
 416     }
 417     return (!empty($errors)) ? $errors : TRUE;
 418   }
 419
 420   /**
 421    * @deprecated
 422    * This function is not used anywhere
 423    *
 424    * @param array $contact
 425    *   Array of contact-details.
 426    *
 427    * @return int|bool
 428    *   uid if user exists, false otherwise
 429    *
 430    */
 431   public static function userExists(&$contact) {
 432     $config = CRM_Core_Config::singleton();
 433
 434     $isDrupal = $config->userSystem->is_drupal;
 435     $isJoomla = ucfirst($config->userFramework) == 'Joomla' ? TRUE : FALSE;
 436     $isWordPress = $config->userFramework == 'WordPress' ? TRUE : FALSE;
 437
 438     if (!$isDrupal && !$isJoomla && !$isWordPress) {
 439       die('Unknown user framework');
 440     }
 441
 442     // Use UF native framework to fetch data from UF user table
 443     if ($isDrupal) {
 444       $uid = db_query(
 445         "SELECT uid FROM {users} where mail = :email",
 446         array(':email' => $contact['email'])
 447       )->fetchField();
 448
 449       if ($uid) {
 450         $contact['user_exists'] = TRUE;
 451         $result = $uid;
 452       }
 453     }
 454     elseif ($isJoomla) {
 455       $mail = $contact['email'];
 456
 457       $JUserTable = &JTable::getInstance('User', 'JTable');
 458
 459       $db = $JUserTable->getDbo();
 460       $query = $db->getQuery(TRUE);
 461       $query->select('username, email');
 462       $query->from($JUserTable->getTableName());
 463       $query->where('(LOWER(email) = LOWER(\'' . $email . '\'))');
 464       $db->setQuery($query, 0, $limit);
 465       $users = $db->loadAssocList();
 466
 467       $row = array();;
 468       if (count($users)) {
 469         $row = $users[0];
 470       }
 471
 472       if (!empty($row)) {
 473         $uid = CRM_Utils_Array::value('id', $row);
 474         $contact['user_exists'] = TRUE;
 475         $result = $uid;
 476       }
 477     }
 478     elseif ($isWordPress) {
 479       if (email_exists($params['mail'])) {
 480         $contact['user_exists'] = TRUE;
 481         $userObj = get_user_by('email', $params['mail']);
 482         return $userObj->ID;
 483       }
 484     }
 485
 486     return $result;
 487   }
 488
 489   /**
 490    * @param $config
 491    *
 492    * @return object
 493    */
 494   public static function &dbHandle(&$config) {
 495     $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
 496     $db_uf = DB::connect($config->userFrameworkDSN);
 497     unset($errorScope);
 498     if (!$db_uf ||
 499       DB::isError($db_uf)
 500     ) {
 501       $session = CRM_Core_Session::singleton();
 502       $session->pushUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
 503       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",
 504         array(1 => $db_uf->getMessage())
 505       ));
 506     }
 507     $db_uf->query('/*!40101 SET NAMES utf8 */');
 508     return $db_uf;
 509   }
 510
 511 }