3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * Drupal specific stuff goes here
39 class CRM_Utils_System_Drupal
extends CRM_Utils_System_DrupalBase
{
42 * Create a user in Drupal.
44 * @param array $params
46 * Email id for cms user.
49 * uid if user exists, false otherwise
51 public function createUser(&$params, $mail) {
52 $form_state = form_state_defaults();
54 $form_state['input'] = array(
55 'name' => $params['cms_name'],
56 'mail' => $params[$mail],
57 'op' => 'Create new account',
60 $admin = user_access('administer users');
61 if (!variable_get('user_email_verification', TRUE) ||
$admin) {
62 $form_state['input']['pass'] = array('pass1' => $params['cms_pass'], 'pass2' => $params['cms_pass']);
65 if (!empty($params['notify'])) {
66 $form_state['input']['notify'] = $params['notify'];
69 $form_state['rebuild'] = FALSE;
70 $form_state['programmed'] = TRUE;
71 $form_state['complete form'] = FALSE;
72 $form_state['method'] = 'post';
73 $form_state['build_info']['args'] = array();
75 * if we want to submit this form more than once in a process (e.g. create more than one user)
76 * we must force it to validate each time for this form. Otherwise it will not validate
77 * subsequent submissions and the manner in which the password is passed in will be invalid
79 $form_state['must_validate'] = TRUE;
80 $config = CRM_Core_Config
::singleton();
82 // we also need to redirect b
83 $config->inCiviCRM
= TRUE;
85 $form = drupal_retrieve_form('user_register_form', $form_state);
86 $form_state['process_input'] = 1;
87 $form_state['submitted'] = 1;
88 $form['#array_parents'] = array();
89 $form['#tree'] = FALSE;
90 drupal_process_form('user_register_form', $form, $form_state);
92 $config->inCiviCRM
= FALSE;
94 if (form_get_errors()) {
97 return $form_state['user']->uid
;
101 * Change user name in host CMS
105 * @param string $ufName
108 public function updateCMSName($ufID, $ufName) {
110 if (function_exists('user_load')) {
111 $user = user_load($ufID);
112 if ($user->mail
!= $ufName) {
113 user_save($user, array('mail' => $ufName));
114 $user = user_load($ufID);
120 * Check if username and email exists in the drupal db
122 * @param array $params
123 * Array of name and mail values.
124 * @param array $errors
126 * @param string $emailName
127 * Field label for the 'email'.
131 public static function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
132 $config = CRM_Core_Config
::singleton();
134 $dao = new CRM_Core_DAO();
135 $name = $dao->escape(CRM_Utils_Array
::value('name', $params));
136 $email = $dao->escape(CRM_Utils_Array
::value('mail', $params));
137 $errors = form_get_errors();
139 // unset drupal messages to avoid twice display of errors
140 unset($_SESSION['messages']);
143 if (!empty($params['name'])) {
144 if ($nameError = user_validate_name($params['name'])) {
145 $errors['cms_name'] = $nameError;
149 "SELECT uid FROM {users} WHERE name = :name",
150 array(':name' => $params['name'])
153 $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.', array(1 => $params['name']));
158 if (!empty($params['mail'])) {
159 if ($emailError = user_validate_mail($params['mail'])) {
160 $errors[$emailName] = $emailError;
164 "SELECT uid FROM {users} WHERE mail = :mail",
165 array(':mail' => $params['mail'])
168 $resetUrl = $config->userFrameworkBaseURL
. 'user/password';
169 $errors[$emailName] = ts('The email address %1 is already registered. <a href="%2">Have you forgotten your password?</a>',
170 array(1 => $params['mail'], 2 => $resetUrl)
178 * Get the drupal destination string. When this is passed in the
179 * URL the user will be directed to it after filling in the drupal form
181 * @param CRM_Core_Form $form
182 * Form object representing the 'current' form - to which the user will be returned.
183 * @return null|string
184 * destination value for URL
186 public function getLoginDestination(&$form) {
189 $id = $form->get('id');
194 $gid = $form->get('gid');
196 $args .= "&gid=$gid";
199 // Setup Personal Campaign Page link uses pageId
200 $pageId = $form->get('pageId');
202 $component = $form->get('component');
203 $args .= "&pageId=$pageId&component=$component&action=add";
210 // append destination so user is returned to form they came from after login
211 $destination = CRM_Utils_System
::currentPath() . '?reset=1' . $args;
217 * Get user login URL for hosting CMS (method declared in each CMS system class)
219 * @param string $destination
220 * If present, add destination to querystring (works for Drupal only).
223 * loginURL for the current CMS
225 public function getLoginURL($destination = '') {
226 $query = $destination ?
array('destination' => $destination) : array();
227 return url('user', array('query' => $query));
232 * Sets the title of the page
234 * @param string $title
235 * @param null $pageTitle
237 * @paqram string $pageTitle
241 public function setTitle($title, $pageTitle = NULL) {
242 if (arg(0) == 'civicrm') {
247 drupal_set_title($pageTitle, PASS_THROUGH
);
252 * Append an additional breadcrumb tag to the existing breadcrumb
254 * @param array $breadCrumbs
255 * @internal param string $title
256 * @internal param string $url
260 public function appendBreadCrumb($breadCrumbs) {
261 $breadCrumb = drupal_get_breadcrumb();
263 if (is_array($breadCrumbs)) {
264 foreach ($breadCrumbs as $crumbs) {
265 if (stripos($crumbs['url'], 'id%%')) {
266 $args = array('cid', 'mid');
267 foreach ($args as $a) {
268 $val = CRM_Utils_Request
::retrieve($a, 'Positive', CRM_Core_DAO
::$_nullObject,
272 $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']);
276 $breadCrumb[] = "<a href=\"{$crumbs['url']}\">{$crumbs['title']}</a>";
279 drupal_set_breadcrumb($breadCrumb);
283 * Reset an additional breadcrumb tag to the existing breadcrumb
287 public function resetBreadCrumb() {
289 drupal_set_breadcrumb($bc);
293 * Append a string to the head of the html file
295 * @param string $header
296 * The new string to be appended.
300 public function addHTMLHead($header) {
302 if (!empty($header)) {
303 $key = 'civi_' . ++
$count;
306 '#markup' => $header,
308 drupal_add_html_head($data, $key);
315 * @param $url : string, absolute path to file
316 * @param string $region
317 * location within the document: 'html-header', 'page-header', 'page-footer'.
319 * Note: This function is not to be called directly
320 * @see CRM_Core_Region::render()
323 * TRUE if we support this operation in this CMS, FALSE otherwise
325 public function addScriptUrl($url, $region) {
326 $params = array('group' => JS_LIBRARY
, 'weight' => 10);
330 $params['scope'] = substr($region, 5);
336 // If the path is within the drupal directory we can use the more efficient 'file' setting
337 $params['type'] = $this->formatResourceUrl($url) ?
'file' : 'external';
338 drupal_add_js($url, $params);
343 * Add an inline script
345 * @param $code : string, javascript code
346 * @param string $region
347 * location within the document: 'html-header', 'page-header', 'page-footer'.
349 * Note: This function is not to be called directly
350 * @see CRM_Core_Region::render()
353 * TRUE if we support this operation in this CMS, FALSE otherwise
355 public function addScript($code, $region) {
356 $params = array('type' => 'inline', 'group' => JS_LIBRARY
, 'weight' => 10);
360 $params['scope'] = substr($region, 5);
366 drupal_add_js($code, $params);
373 * @param $url : string, absolute path to file
374 * @param string $region
375 * location within the document: 'html-header', 'page-header', 'page-footer'.
377 * Note: This function is not to be called directly
378 * @see CRM_Core_Region::render()
381 * TRUE if we support this operation in this CMS, FALSE otherwise
383 public function addStyleUrl($url, $region) {
384 if ($region != 'html-header') {
388 // If the path is within the drupal directory we can use the more efficient 'file' setting
389 $params['type'] = $this->formatResourceUrl($url) ?
'file' : 'external';
390 drupal_add_css($url, $params);
395 * Add an inline style
397 * @param $code : string, css code
398 * @param string $region
399 * location within the document: 'html-header', 'page-header', 'page-footer'.
401 * Note: This function is not to be called directly
402 * @see CRM_Core_Region::render()
405 * TRUE if we support this operation in this CMS, FALSE otherwise
407 public function addStyle($code, $region) {
408 if ($region != 'html-header') {
411 $params = array('type' => 'inline');
412 drupal_add_css($code, $params);
417 * Rewrite various system urls to https
421 public function mapConfigToSSL() {
423 $base_url = str_replace('http://', 'https://', $base_url);
427 * Figure out the post url for the form
430 * The default action if one is pre-specified.
433 * the url to post the form
435 public function postURL($action) {
436 if (!empty($action)) {
440 return $this->url($_GET['q']);
445 * Authenticate the user against the drupal db
447 * @param string $name
449 * @param string $password
450 * The password for the above user name.
451 * @param bool $loadCMSBootstrap
452 * Load cms bootstrap?.
453 * @param NULL|string $realPath filename of script
455 * @return mixed false if no auth array(contactID, ufID, unique string ) if success
457 public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
458 require_once 'DB.php';
460 $config = CRM_Core_Config
::singleton();
462 $dbDrupal = DB
::connect($config->userFrameworkDSN
);
463 if (DB
::isError($dbDrupal)) {
464 CRM_Core_Error
::fatal("Cannot connect to drupal db via $config->userFrameworkDSN, " . $dbDrupal->getMessage());
467 $account = $userUid = $userMail = NULL;
468 if ($loadCMSBootstrap) {
469 $bootStrapParams = array();
470 if ($name && $password) {
471 $bootStrapParams = array(
476 CRM_Utils_System
::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath);
480 $userUid = $user->uid
;
481 $userMail = $user->mail
;
486 // SOAP cannot load drupal bootstrap and hence we do it the old way
487 // Contact CiviSMTP folks if we run into issues with this :)
488 $cmsPath = $config->userSystem
->cmsRootPath($realPath);
490 require_once "$cmsPath/includes/bootstrap.inc";
491 require_once "$cmsPath/includes/password.inc";
493 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
494 $name = $dbDrupal->escapeSimple($strtolower($name));
497 FROM {$config->userFrameworkUsersTableName} u
498 WHERE LOWER(u.name) = '$name'
502 $query = $dbDrupal->query($sql);
503 $row = $query->fetchRow(DB_FETCHMODE_ASSOC
);
506 $fakeDrupalAccount = drupal_anonymous_user();
507 $fakeDrupalAccount->name
= $name;
508 $fakeDrupalAccount->pass
= $row['pass'];
509 $passwordCheck = user_check_password($password, $fakeDrupalAccount);
510 if ($passwordCheck) {
511 $userUid = $row['uid'];
512 $userMail = $row['mail'];
517 if ($userUid && $userMail) {
518 CRM_Core_BAO_UFMatch
::synchronizeUFMatch($account, $userUid, $userMail, 'Drupal');
519 $contactID = CRM_Core_BAO_UFMatch
::getContactId($userUid);
523 return array($contactID, $userUid, mt_rand());
529 * Load user into session
531 * @param string $username
535 public function loadUser($username) {
538 $user = user_load_by_name($username);
540 if (empty($user->uid
)) {
545 $contact_id = CRM_Core_BAO_UFMatch
::getContactId($uid);
547 // lets store contact id and user id in session
548 $session = CRM_Core_Session
::singleton();
549 $session->set('ufID', $uid);
550 $session->set('userID', $contact_id);
555 * Perform any post login activities required by the UF -
556 * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
557 * calls hook_user op 'login' and generates a new session.
559 * @param array $params
561 * FIXME: Document values accepted/required by $params
563 public function userLoginFinalize($params = array()) {
564 user_login_finalize($params);
568 * Determine the native ID of the CMS user
570 * @param string $username
573 public function getUfId($username) {
574 $user = user_load_by_name($username);
575 if (empty($user->uid
)) {
582 * Set a message in the UF to display to a user
584 * @param string $message
585 * The message to set.
587 public function setMessage($message) {
588 drupal_set_message($message);
594 public function logout() {
595 module_load_include('inc', 'user', 'user.pages');
596 return user_logout();
599 public function updateCategories() {
600 // copied this from profile.module. Seems a bit inefficient, but i dont know a better way
607 * Get the default location for CiviCRM blocks
611 public function getDefaultBlockLocation() {
612 return 'sidebar_first';
616 * Get the locale set in the hosting CMS
619 * with the locale or null for none
621 public function getUFLocale() {
622 // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
623 // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
624 // sometimes for CLI based on order called, this might not be set and/or empty
627 if (empty($language)) {
631 if ($language->language
== 'zh-hans') {
635 if ($language->language
== 'zh-hant') {
639 if (preg_match('/^.._..$/', $language->language
)) {
640 return $language->language
;
643 return CRM_Core_I18n_PseudoConstant
::longForShort(substr($language->language
, 0, 2));
649 public function getVersion() {
650 return defined('VERSION') ? VERSION
: 'Unknown';
654 * Load drupal bootstrap
656 * @param array $params
657 * Either uid, or name & pass.
658 * @param bool $loadUser
659 * Boolean Require CMS user load.
660 * @param bool $throwError
661 * If true, print error on failure and exit.
662 * @param bool|string $realPath path to script
666 public function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
667 //take the cms root path.
668 $cmsPath = $this->cmsRootPath($realPath);
670 if (!file_exists("$cmsPath/includes/bootstrap.inc")) {
672 echo '<br />Sorry, could not locate bootstrap.inc\n';
677 // load drupal bootstrap
679 define('DRUPAL_ROOT', $cmsPath);
681 // For drupal multi-site CRM-11313
682 if ($realPath && strpos($realPath, 'sites/all/modules/') === FALSE) {
683 preg_match('@sites/([^/]*)/modules@s', $realPath, $matches);
684 if (!empty($matches[1])) {
685 $_SERVER['HTTP_HOST'] = $matches[1];
688 require_once 'includes/bootstrap.inc';
689 // @ to suppress notices eg 'DRUPALFOO already defined'.
690 @drupal_bootstrap
(DRUPAL_BOOTSTRAP_FULL
);
692 // explicitly setting error reporting, since we cannot handle drupal related notices
694 if (!function_exists('module_exists') ||
!module_exists('civicrm')) {
696 echo '<br />Sorry, could not load drupal bootstrap.';
702 // seems like we've bootstrapped drupal
703 $config = CRM_Core_Config
::singleton();
705 // lets also fix the clean url setting
707 $config->cleanURL
= (int) variable_get('clean_url', '0');
709 // we need to call the config hook again, since we now know
710 // all the modules that are listening on it, does not apply
711 // to J! and WP as yet
713 CRM_Utils_Hook
::config($config);
719 $uid = CRM_Utils_Array
::value('uid', $params);
721 //load user, we need to check drupal permissions.
722 $name = CRM_Utils_Array
::value('name', $params, FALSE) ?
$params['name'] : trim(CRM_Utils_Array
::value('name', $_REQUEST));
723 $pass = CRM_Utils_Array
::value('pass', $params, FALSE) ?
$params['pass'] : trim(CRM_Utils_Array
::value('pass', $_REQUEST));
726 $uid = user_authenticate($name, $pass);
729 echo '<br />Sorry, unrecognized username or password.';
738 $account = user_load($uid);
739 if ($account && $account->uid
) {
747 echo '<br />Sorry, can not load CMS user account.';
751 // CRM-6948: When using loadBootStrap, it's implicit that CiviCRM has already loaded its settings
752 // which means that define(CIVICRM_CLEANURL) was correctly set.
754 $config = CRM_Core_Config
::singleton();
755 $config->cleanURL
= (int) variable_get('clean_url', '0');
757 // CRM-8655: Drupal wasn't available during bootstrap, so hook_civicrm_config never executes
758 CRM_Utils_Hook
::config($config);
765 public function cmsRootPath($scriptFilename = NULL) {
766 $cmsRoot = $valid = NULL;
768 if (!is_null($scriptFilename)) {
769 $path = $scriptFilename;
772 $path = $_SERVER['SCRIPT_FILENAME'];
775 if (function_exists('drush_get_context')) {
776 // drush anyway takes care of multisite install etc
777 return drush_get_context('DRUSH_DRUPAL_ROOT');
780 $pathVars = explode('/',
781 str_replace('//', '/',
782 str_replace('\\', '/', $path)
786 //lets store first var,
787 //need to get back for windows.
788 $firstVar = array_shift($pathVars);
790 //lets remove sript name to reduce one iteration.
791 array_pop($pathVars);
793 // CRM-7429 -- do check for uppermost 'includes' dir, which would
794 // work for multisite installation.
796 $cmsRoot = $firstVar . '/' . implode('/', $pathVars);
797 $cmsIncludePath = "$cmsRoot/includes";
798 // Stop if we find bootstrap.
799 if (file_exists("$cmsIncludePath/bootstrap.inc")) {
803 //remove one directory level.
804 array_pop($pathVars);
805 } while (count($pathVars));
807 return ($valid) ?
$cmsRoot : NULL;
811 * Check is user logged in.
815 public function isUserLoggedIn() {
817 if (function_exists('user_is_logged_in')) {
818 $isloggedIn = user_is_logged_in();
825 * Get currently logged in user uf id.
828 * $userID logged in user uf id.
830 public function getLoggedInUfID() {
832 if (function_exists('user_is_logged_in') &&
833 user_is_logged_in() &&
834 function_exists('user_uid_optional_to_arg')
836 $ufID = user_uid_optional_to_arg(array());
843 * Format the url as per language Negotiation.
847 * @param bool $addLanguagePart
848 * @param bool $removeLanguagePart
853 public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
858 //CRM-7803 -from d7 onward.
859 $config = CRM_Core_Config
::singleton();
860 if (function_exists('variable_get') &&
861 module_exists('locale') &&
862 function_exists('language_negotiation_get')
866 //does user configuration allow language
867 //support from the URL (Path prefix or domain)
868 if (language_negotiation_get('language') == 'locale-url') {
869 $urlType = variable_get('locale_language_negotiation_url_part');
872 if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX
) {
873 if (isset($language->prefix
) && $language->prefix
) {
874 if ($addLanguagePart) {
875 $url .= $language->prefix
. '/';
877 if ($removeLanguagePart) {
878 $url = str_replace("/{$language->prefix}/", '/', $url);
883 if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN
) {
884 if (isset($language->domain
) && $language->domain
) {
885 if ($addLanguagePart) {
886 $cleanedUrl = preg_replace('#^https?://#', '', $language->domain
);
887 // drupal function base_path() adds a "/" to the beginning and end of the returned path
888 if (substr($cleanedUrl, -1) == '/') {
889 $cleanedUrl = substr($cleanedUrl, 0, -1);
891 $url = (CRM_Utils_System
::isSSL() ?
'https' : 'http') . '://' . $cleanedUrl . base_path();
893 if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
894 $url = str_replace('\\', '/', $url);
895 $parseUrl = parse_url($url);
897 //kinda hackish but not sure how to do it right
898 //hope http_build_url() will help at some point.
899 if (is_array($parseUrl) && !empty($parseUrl)) {
900 $urlParts = explode('/', $url);
901 $hostKey = array_search($parseUrl['host'], $urlParts);
902 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL
);
903 $urlParts[$hostKey] = $ufUrlParts['host'];
904 $url = implode('/', $urlParts);
916 * Find any users/roles/security-principals with the given permission
917 * and replace it with one or more permissions.
919 * @param string $oldPerm
920 * @param array $newPerms
925 public function replacePermission($oldPerm, $newPerms) {
926 $roles = user_roles(FALSE, $oldPerm);
927 if (!empty($roles)) {
928 foreach (array_keys($roles) as $rid) {
929 user_role_revoke_permissions($rid, array($oldPerm));
930 user_role_grant_permissions($rid, $newPerms);
936 * Get a list of all installed modules, including enabled and disabled ones
941 public function getModules() {
943 $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
944 foreach ($q as $row) {
945 $result[] = new CRM_Core_Module('drupal.' . $row->name
, ($row->status
== 1) ?
TRUE : FALSE);
951 * Wrapper for og_membership creation
955 * @param int $drupalID
958 public function og_membership_create($ogID, $drupalID) {
959 if (function_exists('og_entity_query_alter')) {
960 // sort-of-randomly chose a function that only exists in the // 7.x-2.x branch
962 // @TODO Find more solid way to check - try system_get_info('module', 'og').
964 // Also, since we don't know how to get the entity type of the // group, we'll assume it's 'node'
965 og_group('node', $ogID, array('entity' => user_load($drupalID)));
968 // Works for the OG 7.x-1.x branch
969 og_group($ogID, array('entity' => user_load($drupalID)));
974 * Wrapper for og_membership deletion
978 * @param int $drupalID
981 public function og_membership_delete($ogID, $drupalID) {
982 if (function_exists('og_entity_query_alter')) {
983 // sort-of-randomly chose a function that only exists in the 7.x-2.x branch
984 // TODO: Find a more solid way to make this test
985 // Also, since we don't know how to get the entity type of the group, we'll assume it's 'node'
986 og_ungroup('node', $ogID, 'user', user_load($drupalID));
989 // Works for the OG 7.x-1.x branch
990 og_ungroup($ogID, 'user', user_load($drupalID));
995 * Over-ridable function to get timezone as a string eg.
997 * Timezone e.g. 'America/Los_Angeles'
999 public function getTimeZoneString() {
1001 if (variable_get('configurable_timezones', 1) && $user->uid
&& strlen($user->timezone
)) {
1002 $timezone = $user->timezone
;
1005 $timezone = variable_get('date_default_timezone', NULL);
1008 $timezone = parent
::getTimeZoneString();
1014 * Reset any system caches that may be required for proper CiviCRM
1017 public function flush() {
1018 drupal_flush_all_caches();