From: Tim Otten Date: Tue, 15 Dec 2015 23:18:19 +0000 (-0800) Subject: Copy CRM/*/Drupal.php to CRM/*/Backdrop.php X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=84fce21c72eea0af7fb867bcda82586cb5f05fbd;p=civicrm-core.git Copy CRM/*/Drupal.php to CRM/*/Backdrop.php --- diff --git a/CRM/Core/Permission/Backdrop.php b/CRM/Core/Permission/Backdrop.php new file mode 100644 index 0000000000..74846786db --- /dev/null +++ b/CRM/Core/Permission/Backdrop.php @@ -0,0 +1,172 @@ +translatePermission($str, 'Drupal', array( + 'view user account' => 'access user profiles', + 'administer users' => 'administer users', + )); + if ($str == CRM_Core_Permission::ALWAYS_DENY_PERMISSION) { + return FALSE; + } + if ($str == CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) { + return TRUE; + } + if (function_exists('user_access')) { + return user_access($str) ? TRUE : FALSE; + } + return TRUE; + } + + /** + * Given a roles array, check for access requirements + * + * @param array $array + * The roles to check. + * + * @return bool + * true if yes, else false + */ + public function checkGroupRole($array) { + if (function_exists('user_load') && isset($array)) { + $user = user_load($GLOBALS['user']->uid); + //if giver roles found in user roles - return true + foreach ($array as $key => $value) { + if (in_array($value, $user->roles)) { + return TRUE; + } + } + } + return FALSE; + } + + /** + * @inheritDoc + */ + public function isModulePermissionSupported() { + return TRUE; + } + + /** + * @inheritDoc + */ + public function upgradePermissions($permissions) { + if (empty($permissions)) { + throw new CRM_Core_Exception("Cannot upgrade permissions: permission list missing"); + } + $query = db_delete('role_permission') + ->condition('module', 'civicrm') + ->condition('permission', array_keys($permissions), 'NOT IN'); + $query->execute(); + } + + /** + * Get all the contact emails for users that have a specific permission. + * + * @param string $permissionName + * Name of the permission we are interested in. + * + * @return string + * a comma separated list of email addresses + */ + public function permissionEmails($permissionName) { + static $_cache = array(); + + if (isset($_cache[$permissionName])) { + return $_cache[$permissionName]; + } + + $uids = array(); + $sql = " + SELECT {users}.uid, {role_permission}.permission + FROM {users} + JOIN {users_roles} + ON {users}.uid = {users_roles}.uid + JOIN {role_permission} + ON {role_permission}.rid = {users_roles}.rid + WHERE {role_permission}.permission = '{$permissionName}' + AND {users}.status = 1 + "; + + $result = db_query($sql); + foreach ($result as $record) { + $uids[] = $record->uid; + } + + $_cache[$permissionName] = self::getContactEmails($uids); + return $_cache[$permissionName]; + } + +} diff --git a/CRM/Utils/Hook/Backdrop.php b/CRM/Utils/Hook/Backdrop.php new file mode 100644 index 0000000000..050cd9a364 --- /dev/null +++ b/CRM/Utils/Hook/Backdrop.php @@ -0,0 +1,35 @@ + $params['cms_name'], + 'mail' => $params[$mail], + 'op' => 'Create new account', + ); + + $admin = user_access('administer users'); + if (!variable_get('user_email_verification', TRUE) || $admin) { + $form_state['input']['pass'] = array('pass1' => $params['cms_pass'], 'pass2' => $params['cms_pass']); + } + + if (!empty($params['notify'])) { + $form_state['input']['notify'] = $params['notify']; + } + + $form_state['rebuild'] = FALSE; + $form_state['programmed'] = TRUE; + $form_state['complete form'] = FALSE; + $form_state['method'] = 'post'; + $form_state['build_info']['args'] = array(); + /* + * if we want to submit this form more than once in a process (e.g. create more than one user) + * we must force it to validate each time for this form. Otherwise it will not validate + * subsequent submissions and the manner in which the password is passed in will be invalid + */ + $form_state['must_validate'] = TRUE; + $config = CRM_Core_Config::singleton(); + + // we also need to redirect b + $config->inCiviCRM = TRUE; + + $form = drupal_retrieve_form('user_register_form', $form_state); + $form_state['process_input'] = 1; + $form_state['submitted'] = 1; + $form['#array_parents'] = array(); + $form['#tree'] = FALSE; + drupal_process_form('user_register_form', $form, $form_state); + + $config->inCiviCRM = FALSE; + + if (form_get_errors()) { + return FALSE; + } + return $form_state['user']->uid; + } + + /** + * @inheritDoc + */ + public function updateCMSName($ufID, $ufName) { + // CRM-5555 + if (function_exists('user_load')) { + $user = user_load($ufID); + if ($user->mail != $ufName) { + user_save($user, array('mail' => $ufName)); + $user = user_load($ufID); + } + } + } + + /** + * Check if username and email exists in the drupal db. + * + * @param array $params + * Array of name and mail values. + * @param array $errors + * Array of errors. + * @param string $emailName + * Field label for the 'email'. + */ + public static function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') { + $config = CRM_Core_Config::singleton(); + + $dao = new CRM_Core_DAO(); + $name = $dao->escape(CRM_Utils_Array::value('name', $params)); + $email = $dao->escape(CRM_Utils_Array::value('mail', $params)); + $errors = form_get_errors(); + if ($errors) { + // unset drupal messages to avoid twice display of errors + unset($_SESSION['messages']); + } + + if (!empty($params['name'])) { + if ($nameError = user_validate_name($params['name'])) { + $errors['cms_name'] = $nameError; + } + else { + $uid = db_query( + "SELECT uid FROM {users} WHERE name = :name", + array(':name' => $params['name']) + )->fetchField(); + if ((bool) $uid) { + $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.', array(1 => $params['name'])); + } + } + } + + if (!empty($params['mail'])) { + if ($emailError = user_validate_mail($params['mail'])) { + $errors[$emailName] = $emailError; + } + else { + $uid = db_query( + "SELECT uid FROM {users} WHERE mail = :mail", + array(':mail' => $params['mail']) + )->fetchField(); + if ((bool) $uid) { + $resetUrl = $config->userFrameworkBaseURL . 'user/password'; + $errors[$emailName] = ts('The email address %1 already has an account associated with it. Have you forgotten your password?', + array(1 => $params['mail'], 2 => $resetUrl) + ); + } + } + } + } + + /** + * @inheritDoc + */ + public function getLoginURL($destination = '') { + $query = $destination ? array('destination' => $destination) : array(); + return url('user', array('query' => $query), TRUE); + } + + /** + * @inheritDoc + */ + public function setTitle($title, $pageTitle = NULL) { + if (arg(0) == 'civicrm') { + if (!$pageTitle) { + $pageTitle = $title; + } + + drupal_set_title($pageTitle, PASS_THROUGH); + } + } + + /** + * @inheritDoc + */ + public function appendBreadCrumb($breadCrumbs) { + $breadCrumb = drupal_get_breadcrumb(); + + if (is_array($breadCrumbs)) { + foreach ($breadCrumbs as $crumbs) { + if (stripos($crumbs['url'], 'id%%')) { + $args = array('cid', 'mid'); + foreach ($args as $a) { + $val = CRM_Utils_Request::retrieve($a, 'Positive', CRM_Core_DAO::$_nullObject, + FALSE, NULL, $_GET + ); + if ($val) { + $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']); + } + } + } + $breadCrumb[] = "{$crumbs['title']}"; + } + } + drupal_set_breadcrumb($breadCrumb); + } + + /** + * @inheritDoc + */ + public function resetBreadCrumb() { + $bc = array(); + drupal_set_breadcrumb($bc); + } + + /** + * @inheritDoc + */ + public function addHTMLHead($header) { + static $count = 0; + if (!empty($header)) { + $key = 'civi_' . ++$count; + $data = array( + '#type' => 'markup', + '#markup' => $header, + ); + drupal_add_html_head($data, $key); + } + } + + /** + * @inheritDoc + */ + public function addScriptUrl($url, $region) { + $params = array('group' => JS_LIBRARY, 'weight' => 10); + switch ($region) { + case 'html-header': + case 'page-footer': + $params['scope'] = substr($region, 5); + break; + + default: + return FALSE; + } + // If the path is within the drupal directory we can use the more efficient 'file' setting + $params['type'] = $this->formatResourceUrl($url) ? 'file' : 'external'; + drupal_add_js($url, $params); + return TRUE; + } + + /** + * @inheritDoc + */ + public function addScript($code, $region) { + $params = array('type' => 'inline', 'group' => JS_LIBRARY, 'weight' => 10); + switch ($region) { + case 'html-header': + case 'page-footer': + $params['scope'] = substr($region, 5); + break; + + default: + return FALSE; + } + drupal_add_js($code, $params); + return TRUE; + } + + /** + * @inheritDoc + */ + public function addStyleUrl($url, $region) { + if ($region != 'html-header') { + return FALSE; + } + $params = array(); + // If the path is within the drupal directory we can use the more efficient 'file' setting + $params['type'] = $this->formatResourceUrl($url) ? 'file' : 'external'; + drupal_add_css($url, $params); + return TRUE; + } + + /** + * @inheritDoc + */ + public function addStyle($code, $region) { + if ($region != 'html-header') { + return FALSE; + } + $params = array('type' => 'inline'); + drupal_add_css($code, $params); + return TRUE; + } + + /** + * @inheritDoc + */ + public function mapConfigToSSL() { + global $base_url; + $base_url = str_replace('http://', 'https://', $base_url); + } + + protected function getUsersTableName() { + $userFrameworkUsersTableName = Civi::settings()->get('userFrameworkUsersTableName'); + if (empty($userFrameworkUsersTableName)) { + $userFrameworkUsersTableName = 'users'; + } + return $userFrameworkUsersTableName; + } + + /** + * @inheritDoc + */ + public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) { + require_once 'DB.php'; + + $config = CRM_Core_Config::singleton(); + + $dbDrupal = DB::connect($config->userFrameworkDSN); + if (DB::isError($dbDrupal)) { + CRM_Core_Error::fatal("Cannot connect to drupal db via $config->userFrameworkDSN, " . $dbDrupal->getMessage()); + } + + $account = $userUid = $userMail = NULL; + if ($loadCMSBootstrap) { + $bootStrapParams = array(); + if ($name && $password) { + $bootStrapParams = array( + 'name' => $name, + 'pass' => $password, + ); + } + CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath); + + global $user; + if ($user) { + $userUid = $user->uid; + $userMail = $user->mail; + } + } + else { + // CRM-8638 + // SOAP cannot load drupal bootstrap and hence we do it the old way + // Contact CiviSMTP folks if we run into issues with this :) + $cmsPath = $config->userSystem->cmsRootPath($realPath); + + require_once "$cmsPath/includes/bootstrap.inc"; + require_once "$cmsPath/includes/password.inc"; + + $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; + $name = $dbDrupal->escapeSimple($strtolower($name)); + $userFrameworkUsersTableName = $this->getUsersTableName(); + $sql = " +SELECT u.* +FROM {$userFrameworkUsersTableName} u +WHERE LOWER(u.name) = '$name' +AND u.status = 1 +"; + + $query = $dbDrupal->query($sql); + $row = $query->fetchRow(DB_FETCHMODE_ASSOC); + + if ($row) { + $fakeDrupalAccount = drupal_anonymous_user(); + $fakeDrupalAccount->name = $name; + $fakeDrupalAccount->pass = $row['pass']; + $passwordCheck = user_check_password($password, $fakeDrupalAccount); + if ($passwordCheck) { + $userUid = $row['uid']; + $userMail = $row['mail']; + } + } + } + + if ($userUid && $userMail) { + CRM_Core_BAO_UFMatch::synchronizeUFMatch($account, $userUid, $userMail, 'Drupal'); + $contactID = CRM_Core_BAO_UFMatch::getContactId($userUid); + if (!$contactID) { + return FALSE; + } + return array($contactID, $userUid, mt_rand()); + } + return FALSE; + } + + /** + * @inheritDoc + */ + public function loadUser($username) { + global $user; + + $user = user_load_by_name($username); + + if (empty($user->uid)) { + return FALSE; + } + + $uid = $user->uid; + $contact_id = CRM_Core_BAO_UFMatch::getContactId($uid); + + // lets store contact id and user id in session + $session = CRM_Core_Session::singleton(); + $session->set('ufID', $uid); + $session->set('userID', $contact_id); + return TRUE; + } + + /** + * Perform any post login activities required by the UF - + * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp, + * calls hook_user op 'login' and generates a new session. + * + * @param array $params + * + * FIXME: Document values accepted/required by $params + */ + public function userLoginFinalize($params = array()) { + user_login_finalize($params); + } + + /** + * Determine the native ID of the CMS user. + * + * @param string $username + * @return int|NULL + */ + public function getUfId($username) { + $user = user_load_by_name($username); + if (empty($user->uid)) { + return NULL; + } + return $user->uid; + } + + /** + * @inheritDoc + */ + public function logout() { + module_load_include('inc', 'user', 'user.pages'); + return user_logout(); + } + + /** + * Get the default location for CiviCRM blocks. + * + * @return string + */ + public function getDefaultBlockLocation() { + return 'sidebar_first'; + } + + /** + * Load drupal bootstrap. + * + * @param array $params + * Either uid, or name & pass. + * @param bool $loadUser + * Boolean Require CMS user load. + * @param bool $throwError + * If true, print error on failure and exit. + * @param bool|string $realPath path to script + * + * @return bool + */ + public function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) { + //take the cms root path. + $cmsPath = $this->cmsRootPath($realPath); + + if (!file_exists("$cmsPath/includes/bootstrap.inc")) { + if ($throwError) { + echo '
Sorry, could not locate bootstrap.inc\n'; + exit(); + } + return FALSE; + } + // load drupal bootstrap + chdir($cmsPath); + define('DRUPAL_ROOT', $cmsPath); + + // For drupal multi-site CRM-11313 + if ($realPath && strpos($realPath, 'sites/all/modules/') === FALSE) { + preg_match('@sites/([^/]*)/modules@s', $realPath, $matches); + if (!empty($matches[1])) { + $_SERVER['HTTP_HOST'] = $matches[1]; + } + } + require_once 'includes/bootstrap.inc'; + // @ to suppress notices eg 'DRUPALFOO already defined'. + @drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL); + + // explicitly setting error reporting, since we cannot handle drupal related notices + error_reporting(1); + if (!function_exists('module_exists') || !module_exists('civicrm')) { + if ($throwError) { + echo '
Sorry, could not load drupal bootstrap.'; + exit(); + } + return FALSE; + } + + // seems like we've bootstrapped drupal + $config = CRM_Core_Config::singleton(); + + // lets also fix the clean url setting + // CRM-6948 + $config->cleanURL = (int) variable_get('clean_url', '0'); + + // we need to call the config hook again, since we now know + // all the modules that are listening on it, does not apply + // to J! and WP as yet + // CRM-8655 + CRM_Utils_Hook::config($config); + + if (!$loadUser) { + return TRUE; + } + + $uid = CRM_Utils_Array::value('uid', $params); + if (!$uid) { + //load user, we need to check drupal permissions. + $name = CRM_Utils_Array::value('name', $params, FALSE) ? $params['name'] : trim(CRM_Utils_Array::value('name', $_REQUEST)); + $pass = CRM_Utils_Array::value('pass', $params, FALSE) ? $params['pass'] : trim(CRM_Utils_Array::value('pass', $_REQUEST)); + + if ($name) { + $uid = user_authenticate($name, $pass); + if (!$uid) { + if ($throwError) { + echo '
Sorry, unrecognized username or password.'; + exit(); + } + return FALSE; + } + } + } + + if ($uid) { + $account = user_load($uid); + if ($account && $account->uid) { + global $user; + $user = $account; + return TRUE; + } + } + + if ($throwError) { + echo '
Sorry, can not load CMS user account.'; + exit(); + } + + // CRM-6948: When using loadBootStrap, it's implicit that CiviCRM has already loaded its settings + // which means that define(CIVICRM_CLEANURL) was correctly set. + // So we correct it + $config = CRM_Core_Config::singleton(); + $config->cleanURL = (int) variable_get('clean_url', '0'); + + // CRM-8655: Drupal wasn't available during bootstrap, so hook_civicrm_config never executes + CRM_Utils_Hook::config($config); + + return FALSE; + } + + /** + * Get CMS root path. + * + * @param string $scriptFilename + * + * @return null|string + */ + public function cmsRootPath($scriptFilename = NULL) { + $cmsRoot = $valid = NULL; + + if (!is_null($scriptFilename)) { + $path = $scriptFilename; + } + else { + $path = $_SERVER['SCRIPT_FILENAME']; + } + + if (function_exists('drush_get_context')) { + // drush anyway takes care of multisite install etc + return drush_get_context('DRUSH_DRUPAL_ROOT'); + } + // CRM-7582 + $pathVars = explode('/', + str_replace('//', '/', + str_replace('\\', '/', $path) + ) + ); + + //lets store first var, + //need to get back for windows. + $firstVar = array_shift($pathVars); + + //lets remove sript name to reduce one iteration. + array_pop($pathVars); + + // CRM-7429 -- do check for uppermost 'includes' dir, which would + // work for multisite installation. + do { + $cmsRoot = $firstVar . '/' . implode('/', $pathVars); + $cmsIncludePath = "$cmsRoot/includes"; + // Stop if we find bootstrap. + if (file_exists("$cmsIncludePath/bootstrap.inc")) { + $valid = TRUE; + break; + } + //remove one directory level. + array_pop($pathVars); + } while (count($pathVars)); + + return ($valid) ? $cmsRoot : NULL; + } + + /** + * @inheritDoc + */ + public function isUserLoggedIn() { + $isloggedIn = FALSE; + if (function_exists('user_is_logged_in')) { + $isloggedIn = user_is_logged_in(); + } + + return $isloggedIn; + } + + /** + * @inheritDoc + */ + public function getLoggedInUfID() { + $ufID = NULL; + if (function_exists('user_is_logged_in') && + user_is_logged_in() && + function_exists('user_uid_optional_to_arg') + ) { + $ufID = user_uid_optional_to_arg(array()); + } + + return $ufID; + } + + /** + * @inheritDoc + */ + public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) { + if (empty($url)) { + return $url; + } + + //CRM-7803 -from d7 onward. + $config = CRM_Core_Config::singleton(); + if (function_exists('variable_get') && + module_exists('locale') && + function_exists('language_negotiation_get') + ) { + global $language; + + //does user configuration allow language + //support from the URL (Path prefix or domain) + if (language_negotiation_get('language') == 'locale-url') { + $urlType = variable_get('locale_language_negotiation_url_part'); + + //url prefix + if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) { + if (isset($language->prefix) && $language->prefix) { + if ($addLanguagePart) { + $url .= $language->prefix . '/'; + } + if ($removeLanguagePart) { + $url = str_replace("/{$language->prefix}/", '/', $url); + } + } + } + //domain + if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN) { + if (isset($language->domain) && $language->domain) { + if ($addLanguagePart) { + $cleanedUrl = preg_replace('#^https?://#', '', $language->domain); + // drupal function base_path() adds a "/" to the beginning and end of the returned path + if (substr($cleanedUrl, -1) == '/') { + $cleanedUrl = substr($cleanedUrl, 0, -1); + } + $url = (CRM_Utils_System::isSSL() ? 'https' : 'http') . '://' . $cleanedUrl . base_path(); + } + if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) { + $url = str_replace('\\', '/', $url); + $parseUrl = parse_url($url); + + //kinda hackish but not sure how to do it right + //hope http_build_url() will help at some point. + if (is_array($parseUrl) && !empty($parseUrl)) { + $urlParts = explode('/', $url); + $hostKey = array_search($parseUrl['host'], $urlParts); + $ufUrlParts = parse_url(CIVICRM_UF_BASEURL); + $urlParts[$hostKey] = $ufUrlParts['host']; + $url = implode('/', $urlParts); + } + } + } + } + } + } + + return $url; + } + + /** + * Find any users/roles/security-principals with the given permission + * and replace it with one or more permissions. + * + * @param string $oldPerm + * @param array $newPerms + * Array, strings. + */ + public function replacePermission($oldPerm, $newPerms) { + $roles = user_roles(FALSE, $oldPerm); + if (!empty($roles)) { + foreach (array_keys($roles) as $rid) { + user_role_revoke_permissions($rid, array($oldPerm)); + user_role_grant_permissions($rid, $newPerms); + } + } + } + + /** + * Wrapper for og_membership creation. + * + * @param int $ogID + * Organic Group ID. + * @param int $drupalID + * Drupal User ID. + */ + public function og_membership_create($ogID, $drupalID) { + if (function_exists('og_entity_query_alter')) { + // sort-of-randomly chose a function that only exists in the // 7.x-2.x branch + // + // @TODO Find more solid way to check - try system_get_info('module', 'og'). + // + // Also, since we don't know how to get the entity type of the // group, we'll assume it's 'node' + og_group('node', $ogID, array('entity' => user_load($drupalID))); + } + else { + // Works for the OG 7.x-1.x branch + og_group($ogID, array('entity' => user_load($drupalID))); + } + } + + /** + * Wrapper for og_membership deletion. + * + * @param int $ogID + * Organic Group ID. + * @param int $drupalID + * Drupal User ID. + */ + public function og_membership_delete($ogID, $drupalID) { + if (function_exists('og_entity_query_alter')) { + // sort-of-randomly chose a function that only exists in the 7.x-2.x branch + // TODO: Find a more solid way to make this test + // Also, since we don't know how to get the entity type of the group, we'll assume it's 'node' + og_ungroup('node', $ogID, 'user', user_load($drupalID)); + } + else { + // Works for the OG 7.x-1.x branch + og_ungroup($ogID, 'user', user_load($drupalID)); + } + } + + /** + * @inheritDoc + */ + public function getTimeZoneString() { + global $user; + // Note that 0 is a valid timezone (GMT) so we use strlen not empty to check. + if (variable_get('configurable_timezones', 1) && $user->uid && isset($user->timezone) && strlen($user->timezone)) { + $timezone = $user->timezone; + } + else { + $timezone = variable_get('date_default_timezone', NULL); + } + if (!$timezone) { + $timezone = parent::getTimeZoneString(); + } + return $timezone; + } + + /** + * @inheritDoc + */ + public function setHttpHeader($name, $value) { + drupal_add_http_header($name, $value); + } + + /** + * @inheritDoc + */ + public function synchronizeUsers() { + $config = CRM_Core_Config::singleton(); + if (PHP_SAPI != 'cli') { + set_time_limit(300); + } + $id = 'uid'; + $mail = 'mail'; + $name = 'name'; + + $result = db_query("SELECT uid, mail, name FROM {users} where mail != ''"); + + $user = new StdClass(); + $uf = $config->userFramework; + $contactCount = 0; + $contactCreated = 0; + $contactMatching = 0; + foreach ($result as $row) { + $user->$id = $row->$id; + $user->$mail = $row->$mail; + $user->$name = $row->$name; + $contactCount++; + if ($match = CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $row->$id, $row->$mail, $uf, 1, 'Individual', TRUE)) { + $contactCreated++; + } + else { + $contactMatching++; + } + if (is_object($match)) { + $match->free(); + } + } + + return array( + 'contactCount' => $contactCount, + 'contactMatching' => $contactMatching, + 'contactCreated' => $contactCreated, + ); + } + +}