3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
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 * Drupal specific stuff goes here
39 class CRM_Utils_System_Drupal6
extends CRM_Utils_System_DrupalBase
{
42 * if we are using a theming system, invoke theme, else just print the
45 * @param string $content the content that will be themed
46 * @param boolean $print are we displaying to the screen or bypassing theming?
47 * @param boolean $maintenance for maintenance mode
49 * @return void prints content on stdout
52 function theme(&$content, $print = FALSE, $maintenance = FALSE) {
53 // TODO: Simplify; this was copied verbatim from CiviCRM 3.4's multi-UF theming function, but that's more complex than necessary
54 if (function_exists('theme') && !$print) {
56 drupal_set_breadcrumb('');
57 drupal_maintenance_theme();
60 // Arg 3 for D6 theme() is "show_blocks". Previously, we passed
61 // through a badly named variable ("$args") which was almost always
62 // TRUE (except on fatal error screen). However, this feature is
63 // non-functional on D6 default themes, was purposefully removed from
64 // D7, has no analog in other our other CMS's, and clutters the code.
65 // Hard-wiring to TRUE should be OK.
66 $out = theme('page', $content, TRUE);
76 * Function to create a user in Drupal.
78 * @param array $params associated array
79 * @param string $mail email id for cms user
81 * @return uid if user exists, false otherwise
85 function createUser(&$params, $mail) {
86 $form_state = array();
87 $form_state['values'] = array(
88 'name' => $params['cms_name'],
89 'mail' => $params[$mail],
90 'op' => 'Create new account',
93 $admin = user_access('administer users');
94 if (!variable_get('user_email_verification', TRUE) ||
$admin) {
95 $form_state['values']['pass']['pass1'] = $params['cms_pass'];
96 $form_state['values']['pass']['pass2'] = $params['cms_pass'];
99 $config = CRM_Core_Config
::singleton();
101 // we also need to redirect b
102 $config->inCiviCRM
= TRUE;
104 $form = drupal_retrieve_form('user_register', $form_state);
105 $form['#post'] = $form_state['values'];
106 drupal_prepare_form('user_register', $form, $form_state);
108 // remove the captcha element from the form prior to processing
109 unset($form['captcha']);
111 drupal_process_form('user_register', $form, $form_state);
113 $config->inCiviCRM
= FALSE;
115 if (form_get_errors() ||
!isset($form_state['user'])) {
119 return $form_state['user']->uid
;
124 * Change user name in host CMS
126 * @param integer $ufID User ID in CMS
127 * @param string $ufName User name
129 function updateCMSName($ufID, $ufName) {
131 if (function_exists('user_load')) {
132 $user = user_load(array('uid' => $ufID));
133 if ($user->mail
!= $ufName) {
134 user_save($user, array('mail' => $ufName));
135 $user = user_load(array('uid' => $ufID));
141 * Check if username and email exists in the drupal db
143 * @params $params array array of name and mail values
144 * @params $errors array array of errors
145 * @params $emailName string field label for the 'email'
149 function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
150 $config = CRM_Core_Config
::singleton();
152 $dao = new CRM_Core_DAO();
153 $name = $dao->escape(CRM_Utils_Array
::value('name', $params));
154 $email = $dao->escape(CRM_Utils_Array
::value('mail', $params));
155 _user_edit_validate(NULL, $params);
156 $errors = form_get_errors();
159 if (CRM_Utils_Array
::value('name', $errors)) {
160 $errors['cms_name'] = $errors['name'];
162 if (CRM_Utils_Array
::value('mail', $errors)) {
163 $errors[$emailName] = $errors['mail'];
165 // also unset drupal messages to avoid twice display of errors
166 unset($_SESSION['messages']);
169 // drupal api sucks do the name check manually
170 $nameError = user_validate_name($params['name']);
172 $errors['cms_name'] = $nameError;
177 FROM {$config->userFrameworkUsersTableName}
178 WHERE (LOWER(name) = LOWER('$name')) OR (LOWER(mail) = LOWER('$email'))";
181 $db_cms = DB
::connect($config->userFrameworkDSN
);
182 if (DB
::isError($db_cms)) {
183 die("Cannot connect to UF db via $dsn, " . $db_cms->getMessage());
185 $query = $db_cms->query($sql);
186 $row = $query->fetchRow();
188 $dbName = CRM_Utils_Array
::value(0, $row);
189 $dbEmail = CRM_Utils_Array
::value(1, $row);
190 if (strtolower($dbName) == strtolower($name)) {
191 $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.',
195 if (strtolower($dbEmail) == strtolower($email)) {
196 $resetUrl = $config->userFrameworkBaseURL
. 'user/password';
197 $errors[$emailName] = ts('The email address %1 is already registered. <a href="%2">Have you forgotten your password?</a>',
198 array(1 => $email, 2 => $resetUrl)
205 * Function to get the drupal destination string. When this is passed in the
206 * URL the user will be directed to it after filling in the drupal form
208 * @param object $form Form object representing the 'current' form - to which the user will be returned
209 * @return string $destination destination value for URL
212 function getLoginDestination(&$form) {
215 $id = $form->get('id');
220 $gid = $form->get('gid');
222 $args .= "&gid=$gid";
225 // Setup Personal Campaign Page link uses pageId
226 $pageId = $form->get('pageId');
228 $component = $form->get('component');
229 $args .= "&pageId=$pageId&component=$component&action=add";
236 // append destination so user is returned to form they came from after login
237 $destination = CRM_Utils_System
::currentPath() . '?reset=1' . $args;
243 * sets the title of the page
245 * @param string $title
246 * @paqram string $pageTitle
251 function setTitle($title, $pageTitle = NULL) {
255 if (arg(0) == 'civicrm') {
257 drupal_set_title($pageTitle);
262 * Append an additional breadcrumb tag to the existing breadcrumb
264 * @param string $title
270 function appendBreadCrumb($breadCrumbs) {
271 $breadCrumb = drupal_get_breadcrumb();
273 if (is_array($breadCrumbs)) {
274 foreach ($breadCrumbs as $crumbs) {
275 if (stripos($crumbs['url'], 'id%%')) {
276 $args = array('cid', 'mid');
277 foreach ($args as $a) {
278 $val = CRM_Utils_Request
::retrieve($a, 'Positive', CRM_Core_DAO
::$_nullObject,
282 $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']);
286 $breadCrumb[] = "<a href=\"{$crumbs['url']}\">{$crumbs['title']}</a>";
289 drupal_set_breadcrumb($breadCrumb);
293 * Reset an additional breadcrumb tag to the existing breadcrumb
298 function resetBreadCrumb() {
300 drupal_set_breadcrumb($bc);
304 * Append a string to the head of the html file
306 * @param string $head the new string to be appended
311 function addHTMLHead($head) {
312 drupal_set_html_head($head);
318 * @param $url: string, absolute path to file
319 * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
321 * Note: This function is not to be called directly
322 * @see CRM_Core_Region::render()
324 * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
327 public function addScriptUrl($url, $region) {
331 $scope = substr($region, 5);
336 // If the path is within the drupal directory we can add in the normal way
337 if (CRM_Utils_System_Drupal
::formatResourceUrl($url)) {
338 drupal_add_js($url, 'module', $scope);
345 * Add an inline script
347 * @param $code: string, javascript code
348 * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
350 * Note: This function is not to be called directly
351 * @see CRM_Core_Region::render()
353 * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
356 public function addScript($code, $region) {
360 $scope = substr($region, 5);
365 drupal_add_js($code, 'inline', $scope);
372 * @param $url: string, absolute path to file
373 * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
375 * Note: This function is not to be called directly
376 * @see CRM_Core_Region::render()
378 * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
381 public function addStyleUrl($url, $region) {
382 if ($region != 'html-header' ||
!CRM_Utils_System_Drupal
::formatResourceUrl($url)) {
385 drupal_add_css($url);
390 * Add an inline style
392 * @param $code: string, css code
393 * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
395 * Note: This function is not to be called directly
396 * @see CRM_Core_Region::render()
398 * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
401 public function addStyle($code, $region) {
406 * rewrite various system urls to https
413 function mapConfigToSSL() {
415 $base_url = str_replace('http://', 'https://', $base_url);
419 * figure out the post url for the form
421 * @param mix $action the default action if one is pre-specified
423 * @return string the url to post the form
427 function postURL($action) {
428 if (!empty($action)) {
432 return $this->url($_GET['q']);
436 * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
438 * @param $path string The path being linked to, such as "civicrm/add"
439 * @param $query string A query string to append to the link.
440 * @param $absolute boolean Whether to force the output to be an absolute link (beginning with http:).
441 * Useful for links that will be displayed outside the site, such as in an
443 * @param $fragment string A fragment identifier (named anchor) to append to the link.
444 * @param $htmlize boolean whether to convert to html eqivalant
445 * @param $frontend boolean a gross joomla hack
447 * @return string an HTML string containing a link to the given path.
451 function url($path = NULL, $query = NULL, $absolute = FALSE,
452 $fragment = NULL, $htmlize = TRUE,
455 $config = CRM_Core_Config
::singleton();
456 $script = 'index.php';
458 $path = CRM_Utils_String
::stripPathChars($path);
460 if (isset($fragment)) {
461 $fragment = '#' . $fragment;
464 if (!isset($config->useFrameworkRelativeBase
)) {
465 $base = parse_url($config->userFrameworkBaseURL
);
466 $config->useFrameworkRelativeBase
= $base['path'];
468 $base = $absolute ?
$config->userFrameworkBaseURL
: $config->useFrameworkRelativeBase
;
470 $separator = $htmlize ?
'&' : '&';
472 if (!$config->cleanURL
) {
475 return $base . $script . '?q=' . $path . $separator . $query . $fragment;
478 return $base . $script . '?q=' . $path . $fragment;
483 return $base . $script . '?' . $query . $fragment;
486 return $base . $fragment;
493 return $base . $path . '?' . $query . $fragment;
496 return $base . $path . $fragment;
501 return $base . $script . '?' . $query . $fragment;
504 return $base . $fragment;
511 * Authenticate the user against the drupal db
513 * @param string $name the user name
514 * @param string $password the password for the above user name
516 * @return mixed false if no auth
518 * contactID, ufID, unique string ) if success
521 function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
522 require_once 'DB.php';
524 $config = CRM_Core_Config
::singleton();
526 $dbDrupal = DB
::connect($config->userFrameworkDSN
);
527 if (DB
::isError($dbDrupal)) {
528 CRM_Core_Error
::fatal("Cannot connect to drupal db via $config->userFrameworkDSN, " . $dbDrupal->getMessage());
531 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
532 $dbpassword = md5($password);
533 $name = $dbDrupal->escapeSimple($strtolower($name));
534 $sql = 'SELECT u.* FROM ' . $config->userFrameworkUsersTableName
. " u WHERE LOWER(u.name) = '$name' AND u.pass = '$dbpassword' AND u.status = 1";
535 $query = $dbDrupal->query($sql);
538 // need to change this to make sure we matched only one row
539 while ($row = $query->fetchRow(DB_FETCHMODE_ASSOC
)) {
540 CRM_Core_BAO_UFMatch
::synchronizeUFMatch($user, $row['uid'], $row['mail'], 'Drupal');
541 $contactID = CRM_Core_BAO_UFMatch
::getContactId($row['uid']);
546 if ($loadCMSBootstrap) {
547 $bootStrapParams = array();
548 if ($name && $password) {
549 $bootStrapParams = array(
554 CRM_Utils_System
::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath);
556 return array($contactID, $row['uid'], mt_rand());
563 * Load user into session
565 function loadUser($username) {
567 $user = user_load(array('name' => $username));
568 if (empty($user->uid
)) {
573 $contact_id = CRM_Core_BAO_UFMatch
::getContactId($uid);
575 // lets store contact id and user id in session
576 $session = CRM_Core_Session
::singleton();
577 $session->set('ufID', $uid);
578 $session->set('userID', $contact_id);
583 * Perform any post login activities required by the UF -
584 * e.g. for drupal : records a watchdog message about the new session,
585 * saves the login timestamp, calls hook_user op 'login' and generates a new session.
587 * @param array params
589 * FIXME: Document values accepted/required by $params
591 function userLoginFinalize($params = array()) {
592 user_authenticate_finalize($params);
596 * Determine the native ID of the CMS user
601 function getUfId($username) {
602 $user = user_load(array('name' => $username));
603 if (empty($user->uid
)) {
610 * Set a message in the UF to display to a user
612 * @param string $message the message to set
616 function setMessage($message) {
617 drupal_set_message($message);
620 function permissionDenied() {
621 drupal_access_denied();
625 module_load_include('inc', 'user', 'user.pages');
626 return user_logout();
629 function updateCategories() {
630 // copied this from profile.module. Seems a bit inefficient, but i dont know a better way
637 * Get the locale set in the hosting CMS
639 * @return string with the locale or null for none
641 function getUFLocale() {
642 // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
643 // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
646 case $language->language
== 'zh-hans':
649 case $language->language
== 'zh-hant':
652 case preg_match('/^.._..$/', $language->language
):
653 return $language->language
;
656 return CRM_Core_I18n_PseudoConstant
::longForShort(substr($language->language
, 0, 2));
660 function getVersion() {
661 return defined('VERSION') ? VERSION
: 'Unknown';
665 * load drupal bootstrap
667 * @param $name string optional username for login
668 * @param $pass string optional password for login
670 function loadBootStrap($params = array(
671 ), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
672 $uid = CRM_Utils_Array
::value('uid', $params);
673 $name = CRM_Utils_Array
::value('name', $params, FALSE) ?
$params['name'] : trim(CRM_Utils_Array
::value('name', $_REQUEST));
674 $pass = CRM_Utils_Array
::value('pass', $params, FALSE) ?
$params['pass'] : trim(CRM_Utils_Array
::value('pass', $_REQUEST));
676 //take the cms root path.
677 $cmsPath = $this->cmsRootPath($realPath);
678 if (!file_exists("$cmsPath/includes/bootstrap.inc")) {
679 echo '<br />Sorry, unable to locate bootstrap.inc.';
684 require_once 'includes/bootstrap.inc';
685 @drupal_bootstrap
(DRUPAL_BOOTSTRAP_FULL
);
687 if (!function_exists('module_exists') ||
688 !module_exists('civicrm')
690 echo '<br />Sorry, could not able to load drupal bootstrap.';
693 // lets also fix the clean url setting
695 $config->cleanURL
= (int) variable_get('clean_url', '0');
697 // we need to call the config hook again, since we now know
698 // all the modules that are listening on it, does not apply
699 // to J! and WP as yet
701 CRM_Utils_Hook
::config($config);
706 //load user, we need to check drupal permissions.
708 $user = user_authenticate(array('name' => $name, 'pass' => $pass));
709 if (empty($user->uid
)) {
710 echo '<br />Sorry, unrecognized username or password.';
715 $account = user_load(array('uid' => $uid));
716 if (empty($account->uid
)) {
717 echo '<br />Sorry, unrecognized user id.';
727 function cmsRootPath($scriptFilename = NULL) {
728 $cmsRoot = $valid = NULL;
730 if (!is_null($scriptFilename)) {
731 $path = $scriptFilename;
734 $path = $_SERVER['SCRIPT_FILENAME'];
736 if (function_exists('drush_get_context')) {
737 // drush anyway takes care of multisite install etc
738 return drush_get_context('DRUSH_DRUPAL_ROOT');
741 $pathVars = explode('/',
742 str_replace('//', '/',
743 str_replace('\\', '/', $path)
747 //lets store first var,
748 //need to get back for windows.
749 $firstVar = array_shift($pathVars);
751 //lets remove sript name to reduce one iteration.
752 array_pop($pathVars);
754 //CRM-7429 --do check for upper most 'includes' dir,
755 //which would effectually work for multisite installation.
757 $cmsRoot = $firstVar . '/' . implode('/', $pathVars);
758 $cmsIncludePath = "$cmsRoot/includes";
759 //stop as we found bootstrap.
760 if (@opendir
($cmsIncludePath) &&
761 file_exists("$cmsIncludePath/bootstrap.inc")
766 //remove one directory level.
767 array_pop($pathVars);
768 } while (count($pathVars));
770 return ($valid) ?
$cmsRoot : NULL;
774 * check is user logged in.
776 * @return boolean true/false.
778 public function isUserLoggedIn() {
780 if (function_exists('user_is_logged_in')) {
781 $isloggedIn = user_is_logged_in();
788 * Get currently logged in user uf id.
790 * @return int $userID logged in user uf id.
792 public function getLoggedInUfID() {
794 if (function_exists('user_is_logged_in') &&
795 user_is_logged_in() &&
796 function_exists('user_uid_optional_to_arg')
798 $ufID = user_uid_optional_to_arg(array());
805 * Format the url as per language Negotiation.
809 * @return string $url, formatted url.
812 function languageNegotiationURL($url,
813 $addLanguagePart = TRUE,
814 $removeLanguagePart = FALSE
820 //upto d6 only, already we have code in place for d7
821 $config = CRM_Core_Config
::singleton();
822 if (function_exists('variable_get') &&
823 module_exists('locale')
828 $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE
);
831 if (isset($language->prefix
) &&
833 in_array($mode, array(
834 LANGUAGE_NEGOTIATION_PATH
,
835 LANGUAGE_NEGOTIATION_PATH_DEFAULT
,
839 if ($addLanguagePart) {
840 $url .= $language->prefix
. '/';
842 if ($removeLanguagePart) {
843 $url = str_replace("/{$language->prefix}/", '/', $url);
846 if (isset($language->domain
) &&
848 $mode == LANGUAGE_NEGOTIATION_DOMAIN
851 if ($addLanguagePart) {
852 $url = CRM_Utils_File
::addTrailingSlash($language->domain
, '/');
854 if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
855 $url = str_replace('\\', '/', $url);
856 $parseUrl = parse_url($url);
858 //kinda hackish but not sure how to do it right
859 //hope http_build_url() will help at some point.
860 if (is_array($parseUrl) && !empty($parseUrl)) {
861 $urlParts = explode('/', $url);
862 $hostKey = array_search($parseUrl['host'], $urlParts);
863 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL
);
864 $urlParts[$hostKey] = $ufUrlParts['host'];
865 $url = implode('/', $urlParts);
875 * Find any users/roles/security-principals with the given permission
876 * and replace it with one or more permissions.
878 * @param $oldPerm string
879 * @param $newPerms array, strings
883 function replacePermission($oldPerm, $newPerms) {
884 $roles = user_roles(FALSE, $oldPerm);
885 foreach ($roles as $rid => $roleName) {
886 $permList = db_result(db_query('SELECT perm FROM {permission} WHERE rid = %d', $rid));
887 $perms = drupal_map_assoc(explode(', ', $permList));
888 unset($perms[$oldPerm]);
889 $perms = $perms +
drupal_map_assoc($newPerms);
890 $permList = implode(', ', $perms);
891 db_query('UPDATE {permission} SET perm = "%s" WHERE rid = %d', $permList, $rid);
893 if ( ! empty( $roles ) ) {
894 $rids = implode(',', array_keys($roles));
895 db_query( 'UPDATE {permission} SET perm = CONCAT( perm, \', edit all events\') WHERE rid IN (' . implode(',', array_keys($roles)) . ')' );
896 db_query( "UPDATE {permission} SET perm = REPLACE( perm, '%s', '%s' ) WHERE rid IN ($rids)",
897 $oldPerm, implode(', ', $newPerms) );*/
902 * Get a list of all installed modules, including enabled and disabled ones
904 * @return array CRM_Core_Module
906 function getModules() {
908 $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
909 while ($row = db_fetch_object($q)) {
910 $result[] = new CRM_Core_Module('drupal.' . $row->name
, ($row->status
== 1) ?
TRUE : FALSE);
916 * Get user login URL for hosting CMS (method declared in each CMS system class)
918 * @param string $destination - if present, add destination to querystring (works for Drupal only)
920 * @return string - loginURL for the current CMS
923 public function getLoginURL($destination = '') {
924 $config = CRM_Core_Config
::singleton();
925 $loginURL = $config->userFrameworkBaseURL
;
927 if (!empty($destination)) {
928 // append destination so user is returned to form they came from after login
929 $loginURL .= '?destination=' . urlencode($destination);
935 * Wrapper for og_membership creation
937 * @param integer $ogID Organic Group ID
938 * @param integer $drupalID drupal User ID
940 function og_membership_create($ogID, $drupalID){
941 og_save_subscription( $ogID, $drupalID, array( 'is_active' => 1 ) );
945 * Wrapper for og_membership deletion
947 * @param integer $ogID Organic Group ID
948 * @param integer $drupalID drupal User ID
950 function og_membership_delete($ogID, $drupalID) {
951 og_delete_subscription( $ogID, $drupalID );
955 * Reset any system caches that may be required for proper CiviCRM
959 drupal_flush_all_caches();