3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * Drupal specific stuff goes here.
37 class CRM_Utils_System_Drupal6
extends CRM_Utils_System_DrupalBase
{
42 * If we are using a theming system, invoke theme, else just print the content.
44 * @param string $content
45 * The content that will be themed.
47 * Are we displaying to the screen or bypassing theming?.
48 * @param bool $maintenance
49 * For maintenance mode.
52 * prints content on stdout
54 public function theme(&$content, $print = FALSE, $maintenance = FALSE) {
55 // TODO: Simplify; this was copied verbatim from CiviCRM 3.4's multi-UF theming function, but that's more complex than necessary
56 if (function_exists('theme') && !$print) {
58 drupal_set_breadcrumb('');
59 drupal_maintenance_theme();
62 // Arg 3 for D6 theme() is "show_blocks". Previously, we passed
63 // through a badly named variable ("$args") which was almost always
64 // TRUE (except on fatal error screen). However, this feature is
65 // non-functional on D6 default themes, was purposefully removed from
66 // D7, has no analog in other our other CMS's, and clutters the code.
67 // Hard-wiring to TRUE should be OK.
68 $out = theme('page', $content, TRUE);
83 public function createUser(&$params, $mail) {
84 $form_state = array();
85 $form_state['values'] = array(
86 'name' => $params['cms_name'],
87 'mail' => $params[$mail],
88 'op' => 'Create new account',
91 $admin = user_access('administer users');
92 if (!variable_get('user_email_verification', TRUE) ||
$admin) {
93 $form_state['values']['pass']['pass1'] = $params['cms_pass'];
94 $form_state['values']['pass']['pass2'] = $params['cms_pass'];
97 $config = CRM_Core_Config
::singleton();
99 // we also need to redirect b
100 $config->inCiviCRM
= TRUE;
102 $form = drupal_retrieve_form('user_register', $form_state);
103 $form['#post'] = $form_state['values'];
104 drupal_prepare_form('user_register', $form, $form_state);
106 // remove the captcha element from the form prior to processing
107 unset($form['captcha']);
109 drupal_process_form('user_register', $form, $form_state);
111 $config->inCiviCRM
= FALSE;
113 if (form_get_errors() ||
!isset($form_state['user'])) {
116 return $form_state['user']->uid
;
122 public function updateCMSName($ufID, $ufName) {
124 if (function_exists('user_load')) {
125 $user = user_load(array('uid' => $ufID));
126 if ($user->mail
!= $ufName) {
127 user_save($user, array('mail' => $ufName));
128 $user = user_load(array('uid' => $ufID));
134 * Check if username and email exists in the drupal db.
136 * @param array $params
137 * Array of name and mail values.
138 * @param array $errors
140 * @param string $emailName
141 * Field label for the 'email'.
143 public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
144 $config = CRM_Core_Config
::singleton();
146 $dao = new CRM_Core_DAO();
147 $name = $dao->escape(CRM_Utils_Array
::value('name', $params));
148 $email = $dao->escape(CRM_Utils_Array
::value('mail', $params));
149 _user_edit_validate(NULL, $params);
150 $errors = form_get_errors();
152 if (!empty($errors['name'])) {
153 $errors['cms_name'] = $errors['name'];
155 if (!empty($errors['mail'])) {
156 $errors[$emailName] = $errors['mail'];
158 // also unset drupal messages to avoid twice display of errors
159 unset($_SESSION['messages']);
162 // Do the name check manually.
163 $nameError = user_validate_name($params['name']);
165 $errors['cms_name'] = $nameError;
168 // LOWER in query below roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
172 WHERE (LOWER(name) = LOWER('$name')) OR (LOWER(mail) = LOWER('$email'))
175 $result = db_query($sql);
176 $row = db_fetch_array($result);
184 $dbName = CRM_Utils_Array
::value('name', $row);
185 $dbEmail = CRM_Utils_Array
::value('mail', $row);
186 if (strtolower($dbName) == strtolower($name)) {
187 $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.',
191 if (strtolower($dbEmail) == strtolower($email)) {
193 $errors[$emailName] = ts('You cannot create an email account for a contact with no email',
198 $errors[$emailName] = ts('This email %1 already has an account associated with it. Please select another email.',
209 public function setTitle($title, $pageTitle = NULL) {
213 if (arg(0) == 'civicrm') {
215 drupal_set_title($pageTitle);
222 public function appendBreadCrumb($breadCrumbs) {
223 $breadCrumb = drupal_get_breadcrumb();
225 if (is_array($breadCrumbs)) {
226 foreach ($breadCrumbs as $crumbs) {
227 if (stripos($crumbs['url'], 'id%%')) {
228 $args = array('cid', 'mid');
229 foreach ($args as $a) {
230 $val = CRM_Utils_Request
::retrieve($a, 'Positive', CRM_Core_DAO
::$_nullObject,
234 $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']);
238 $breadCrumb[] = "<a href=\"{$crumbs['url']}\">{$crumbs['title']}</a>";
241 drupal_set_breadcrumb($breadCrumb);
247 public function resetBreadCrumb() {
249 drupal_set_breadcrumb($bc);
253 * Append a string to the head of the html file.
255 * @param string $head
256 * The new string to be appended.
258 public function addHTMLHead($head) {
259 drupal_set_html_head($head);
265 * @param $url : string, absolute path to file
266 * @param string $region
267 * location within the document: 'html-header', 'page-header', 'page-footer'.
269 * Note: This function is not to be called directly
270 * @see CRM_Core_Region::render()
273 * TRUE if we support this operation in this CMS, FALSE otherwise
275 public function addStyleUrl($url, $region) {
276 if ($region != 'html-header' ||
!$this->formatResourceUrl($url)) {
279 drupal_add_css($url);
286 public function mapConfigToSSL() {
288 $base_url = str_replace('http://', 'https://', $base_url);
292 * Get the name of the table that stores the user details.
296 protected function getUsersTableName() {
297 $userFrameworkUsersTableName = Civi
::settings()->get('userFrameworkUsersTableName');
298 if (empty($userFrameworkUsersTableName)) {
299 $userFrameworkUsersTableName = 'users';
301 return $userFrameworkUsersTableName;
307 public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
308 //@todo this 'PEAR-y' stuff is only required when bookstrap is not being loaded which is rare
310 // probably if bootstrap is loaded this call
311 // CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath); would be
312 // sufficient to do what this fn does. It does exist as opposed to return which might need some hanky-panky to make
313 // safe in the unknown situation where authenticate might be called & it is important that
315 require_once 'DB.php';
317 $config = CRM_Core_Config
::singleton();
319 $dbDrupal = DB
::connect($config->userFrameworkDSN
);
320 if (DB
::isError($dbDrupal)) {
321 CRM_Core_Error
::fatal("Cannot connect to drupal db via $config->userFrameworkDSN, " . $dbDrupal->getMessage());
324 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
325 $dbpassword = md5($password);
326 $name = $dbDrupal->escapeSimple($strtolower($name));
327 $userFrameworkUsersTableName = $this->getUsersTableName();
328 $sql = 'SELECT u.* FROM ' . $userFrameworkUsersTableName . " u WHERE LOWER(u.name) = '$name' AND u.pass = '$dbpassword' AND u.status = 1";
329 $query = $dbDrupal->query($sql);
332 // need to change this to make sure we matched only one row
333 while ($row = $query->fetchRow(DB_FETCHMODE_ASSOC
)) {
334 CRM_Core_BAO_UFMatch
::synchronizeUFMatch($user, $row['uid'], $row['mail'], 'Drupal');
335 $contactID = CRM_Core_BAO_UFMatch
::getContactId($row['uid']);
341 if ($loadCMSBootstrap) {
342 $bootStrapParams = array();
343 if ($name && $password) {
344 $bootStrapParams = array(
349 CRM_Utils_System
::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath);
351 return array($contactID, $row['uid'], mt_rand());
360 public function loadUser($username) {
362 $user = user_load(array('name' => $username));
363 if (empty($user->uid
)) {
368 $contact_id = CRM_Core_BAO_UFMatch
::getContactId($uid);
370 // lets store contact id and user id in session
371 $session = CRM_Core_Session
::singleton();
372 $session->set('ufID', $uid);
373 $session->set('userID', $contact_id);
378 * Perform any post login activities required by the UF -
379 * e.g. for drupal : records a watchdog message about the new session,
380 * saves the login timestamp, calls hook_user op 'login' and generates a new session.
382 * @param array $params
384 * FIXME: Document values accepted/required by $params
386 public function userLoginFinalize($params = array()) {
387 user_authenticate_finalize($params);
391 * Determine the native ID of the CMS user.
393 * @param string $username
396 public function getUfId($username) {
397 $user = user_load(array('name' => $username));
398 if (empty($user->uid
)) {
407 public function logout() {
408 module_load_include('inc', 'user', 'user.pages');
409 return user_logout();
413 * Load drupal bootstrap.
415 * @param array $params
416 * Either uid, or name & pass.
417 * @param bool $loadUser
418 * Boolean Require CMS user load.
419 * @param bool $throwError
420 * If true, print error on failure and exit.
421 * @param bool|string $realPath path to script
425 public function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
426 //take the cms root path.
427 $cmsPath = $this->cmsRootPath($realPath);
429 if (!file_exists("$cmsPath/includes/bootstrap.inc")) {
431 echo '<br />Sorry, could not locate bootstrap.inc\n';
436 // load drupal bootstrap
438 define('DRUPAL_ROOT', $cmsPath);
440 // For drupal multi-site CRM-11313
441 if ($realPath && strpos($realPath, 'sites/all/modules/') === FALSE) {
442 preg_match('@sites/([^/]*)/modules@s', $realPath, $matches);
443 if (!empty($matches[1])) {
444 $_SERVER['HTTP_HOST'] = $matches[1];
447 require_once 'includes/bootstrap.inc';
448 // @ to suppress notices eg 'DRUPALFOO already defined'.
449 @drupal_bootstrap
(DRUPAL_BOOTSTRAP_FULL
);
451 // explicitly setting error reporting, since we cannot handle drupal related notices
453 if (!function_exists('module_exists') ||
!module_exists('civicrm')) {
455 echo '<br />Sorry, could not load drupal bootstrap.';
461 // seems like we've bootstrapped drupal
462 $config = CRM_Core_Config
::singleton();
464 // lets also fix the clean url setting
466 $config->cleanURL
= (int) variable_get('clean_url', '0');
468 // we need to call the config hook again, since we now know
469 // all the modules that are listening on it, does not apply
470 // to J! and WP as yet
472 CRM_Utils_Hook
::config($config);
478 // If $uid is passed in, authentication has been done already.
479 $uid = CRM_Utils_Array
::value('uid', $params);
481 //load user, we need to check drupal permissions.
482 $name = CRM_Utils_Array
::value('name', $params, FALSE) ?
$params['name'] : trim(CRM_Utils_Array
::value('name', $_REQUEST));
483 $pass = CRM_Utils_Array
::value('pass', $params, FALSE) ?
$params['pass'] : trim(CRM_Utils_Array
::value('pass', $_REQUEST));
486 $user = user_authenticate(array('name' => $name, 'pass' => $pass));
489 echo '<br />Sorry, unrecognized username or password.';
501 $account = user_load($uid);
502 if ($account && $account->uid
) {
509 echo '<br />Sorry, can not load CMS user account.';
513 // CRM-6948: When using loadBootStrap, it's implicit that CiviCRM has already loaded its settings
514 // which means that define(CIVICRM_CLEANURL) was correctly set.
516 $config = CRM_Core_Config
::singleton();
517 $config->cleanURL
= (int) variable_get('clean_url', '0');
519 // CRM-8655: Drupal wasn't available during bootstrap, so hook_civicrm_config never executes
520 CRM_Utils_Hook
::config($config);
528 * @param string $scriptFilename
530 * @return null|string
532 public function cmsRootPath($scriptFilename = NULL) {
533 $cmsRoot = $valid = NULL;
535 if (!is_null($scriptFilename)) {
536 $path = $scriptFilename;
539 $path = $_SERVER['SCRIPT_FILENAME'];
542 if (function_exists('drush_get_context')) {
543 // drush anyway takes care of multisite install etc
544 return drush_get_context('DRUSH_DRUPAL_ROOT');
547 global $civicrm_paths;
548 if (!empty($civicrm_paths['cms.root']['path'])) {
549 return $civicrm_paths['cms.root']['path'];
553 $pathVars = explode('/',
554 str_replace('//', '/',
555 str_replace('\\', '/', $path)
559 //lets store first var,
560 //need to get back for windows.
561 $firstVar = array_shift($pathVars);
563 //lets remove sript name to reduce one iteration.
564 array_pop($pathVars);
566 //CRM-7429 --do check for upper most 'includes' dir,
567 //which would effectually work for multisite installation.
569 $cmsRoot = $firstVar . '/' . implode('/', $pathVars);
570 $cmsIncludePath = "$cmsRoot/includes";
571 // Stop if we found bootstrap.
572 if (file_exists("$cmsIncludePath/bootstrap.inc")) {
576 //remove one directory level.
577 array_pop($pathVars);
578 } while (count($pathVars));
580 return ($valid) ?
$cmsRoot : NULL;
586 public function isUserLoggedIn() {
588 if (function_exists('user_is_logged_in')) {
589 $isloggedIn = user_is_logged_in();
598 public function getLoggedInUfID() {
600 if (function_exists('user_is_logged_in') &&
601 user_is_logged_in() &&
602 function_exists('user_uid_optional_to_arg')
604 $ufID = user_uid_optional_to_arg(array());
613 public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
618 //up to d6 only, already we have code in place for d7
619 $config = CRM_Core_Config
::singleton();
620 if (function_exists('variable_get') &&
621 module_exists('locale')
626 $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE
);
629 if (isset($language->prefix
) &&
631 in_array($mode, array(
632 LANGUAGE_NEGOTIATION_PATH
,
633 LANGUAGE_NEGOTIATION_PATH_DEFAULT
,
637 if ($addLanguagePart) {
638 $url .= $language->prefix
. '/';
640 if ($removeLanguagePart) {
641 $url = str_replace("/{$language->prefix}/", '/', $url);
644 if (isset($language->domain
) &&
646 $mode == LANGUAGE_NEGOTIATION_DOMAIN
649 if ($addLanguagePart) {
650 $url = CRM_Utils_File
::addTrailingSlash($language->domain
, '/');
652 if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
653 $url = str_replace('\\', '/', $url);
654 $parseUrl = parse_url($url);
656 //kinda hackish but not sure how to do it right
657 //hope http_build_url() will help at some point.
658 if (is_array($parseUrl) && !empty($parseUrl)) {
659 $urlParts = explode('/', $url);
660 $hostKey = array_search($parseUrl['host'], $urlParts);
661 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL
);
662 $urlParts[$hostKey] = $ufUrlParts['host'];
663 $url = implode('/', $urlParts);
673 * Find any users/roles/security-principals with the given permission
674 * and replace it with one or more permissions.
676 * @param string $oldPerm
677 * @param array $newPerms
680 public function replacePermission($oldPerm, $newPerms) {
681 $roles = user_roles(FALSE, $oldPerm);
682 foreach ($roles as $rid => $roleName) {
683 $permList = db_result(db_query('SELECT perm FROM {permission} WHERE rid = %d', $rid));
684 $perms = drupal_map_assoc(explode(', ', $permList));
685 unset($perms[$oldPerm]);
686 $perms = $perms +
drupal_map_assoc($newPerms);
687 $permList = implode(', ', $perms);
688 db_query('UPDATE {permission} SET perm = "%s" WHERE rid = %d', $permList, $rid);
689 /* @codingStandardsIgnoreStart
690 if ( ! empty( $roles ) ) {
691 $rids = implode(',', array_keys($roles));
692 db_query( 'UPDATE {permission} SET perm = CONCAT( perm, \', edit all events\') WHERE rid IN (' . implode(',', array_keys($roles)) . ')' );
693 db_query( "UPDATE {permission} SET perm = REPLACE( perm, '%s', '%s' ) WHERE rid IN ($rids)",
694 $oldPerm, implode(', ', $newPerms) );
695 @codingStandardsIgnoreEnd */
702 public function getModules() {
704 $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
705 while ($row = db_fetch_object($q)) {
706 $result[] = new CRM_Core_Module('drupal.' . $row->name
, ($row->status
== 1) ?
TRUE : FALSE);
714 public function getLoginURL($destination = '') {
715 $config = CRM_Core_Config
::singleton();
716 $loginURL = $config->userFrameworkBaseURL
;
718 if (!empty($destination)) {
719 // append destination so user is returned to form they came from after login
720 $loginURL .= '?destination=' . urlencode($destination);
726 * Wrapper for og_membership creation.
730 * @param int $drupalID
733 public function og_membership_create($ogID, $drupalID) {
734 og_save_subscription($ogID, $drupalID, array('is_active' => 1));
738 * Wrapper for og_membership deletion.
742 * @param int $drupalID
745 public function og_membership_delete($ogID, $drupalID) {
746 og_delete_subscription($ogID, $drupalID);
752 public function getTimeZoneString() {
754 // Note that 0 is a valid timezone (GMT) so we use strlen not empty to check.
755 if (variable_get('configurable_timezones', 1) && $user->uid
&& isset($user->timezone
) && strlen($user->timezone
)) {
756 $timezone = $user->timezone
;
759 $timezone = variable_get('date_default_timezone', NULL);
762 // Retrieved timezone will be represented as GMT offset in seconds but, according
763 // to the doc for the overridden method, ought to be returned as a region string
764 // (e.g., America/Havana).
765 if (strlen($timezone)) {
766 $timezone = timezone_name_from_abbr("", (int) $timezone);
770 $timezone = parent
::getTimeZoneString();
779 public function setHttpHeader($name, $value) {
780 drupal_set_header("$name: $value");
786 public function synchronizeUsers() {
787 $config = CRM_Core_Config
::singleton();
788 if (PHP_SAPI
!= 'cli') {
796 $result = db_query("SELECT uid, mail, name FROM {users} where mail != ''");
798 while ($row = db_fetch_array($result)) {
802 $user = new StdClass();
803 $uf = $config->userFramework
;
806 $contactMatching = 0;
807 foreach ($rows as $row) {
808 $user->$id = $row[$id];
809 $user->$mail = $row[$mail];
810 $user->$name = $row[$name];
812 if ($match = CRM_Core_BAO_UFMatch
::synchronizeUFMatch($user, $row[$id], $row[$mail], $uf, 1, 'Individual', TRUE)) {
818 if (is_object($match)) {
824 'contactCount' => $contactCount,
825 'contactMatching' => $contactMatching,
826 'contactCreated' => $contactCreated,