3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * Drupal specific stuff goes here.
37 class CRM_Utils_System_Drupal8
extends CRM_Utils_System_DrupalBase
{
42 public function createUser(&$params, $mail) {
43 $user = \Drupal
::currentUser();
44 $user_register_conf = \Drupal
::config('user.settings')->get('register');
45 $verify_mail_conf = \Drupal
::config('user.settings')->get('verify_mail');
47 // Don't create user if we don't have permission to.
48 if (!$user->hasPermission('administer users') && $user_register_conf == 'admin_only') {
52 /** @var \Drupal\user\Entity\User $account */
53 $account = entity_create('user');
54 $account->setUsername($params['cms_name'])->setEmail($params[$mail]);
56 // Allow user to set password only if they are an admin or if
57 // the site settings don't require email verification.
58 if (!$verify_mail_conf ||
$user->hasPermission('administer users')) {
59 // @Todo: do we need to check that passwords match or assume this has already been done for us?
60 $account->setPassword($params['cms_pass']);
63 // Only activate account if we're admin or if anonymous users don't require
64 // approval to create accounts.
65 if ($user_register_conf != 'visitors' && !$user->hasPermission('administer users')) {
68 elseif (!$verify_mail_conf) {
72 // Validate the user object
73 $violations = $account->validate();
74 if (count($violations)) {
78 // Let the Drupal module know we're already in CiviCRM.
79 $config = CRM_Core_Config
::singleton();
80 $config->inCiviCRM
= TRUE;
84 $config->inCiviCRM
= FALSE;
86 catch (\Drupal\Core\Entity\EntityStorageException
$e) {
87 $config->inCiviCRM
= FALSE;
91 // Send off any emails as required.
92 // Possible values for $op:
93 // - 'register_admin_created': Welcome message for user created by the admin.
94 // - 'register_no_approval_required': Welcome message when user
96 // - 'register_pending_approval': Welcome message, user pending admin
98 // @Todo: Should we only send off emails if $params['notify'] is set?
100 case $user_register_conf == 'admin_only' ||
$user->isAuthenticated():
101 _user_mail_notify('register_admin_created', $account);
104 case $user_register_conf == 'visitors':
105 _user_mail_notify('register_no_approval_required', $account);
108 case 'visitors_admin_approval':
109 _user_mail_notify('register_pending_approval', $account);
113 // If this is a user creating their own account, login them in!
114 if ($account->isActive() && $user->isAnonymous()) {
115 \
user_login_finalize($account);
118 return $account->id();
124 public function updateCMSName($ufID, $email) {
125 $user = entity_load('user', $ufID);
126 if ($user && $user->getEmail() != $email) {
127 $user->setEmail($email);
129 if (!count($user->validate())) {
136 * Check if username and email exists in the drupal db.
138 * @param array $params
139 * Array of name and mail values.
140 * @param array $errors
142 * @param string $emailName
143 * Field label for the 'email'.
145 public static function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
146 // If we are given a name, let's check to see if it already exists.
147 if (!empty($params['name'])) {
148 $name = $params['name'];
150 $user = entity_create('user');
151 $user->setUsername($name);
153 // This checks for both username uniqueness and validity.
154 $violations = iterator_to_array($user->validate());
155 // We only care about violations on the username field; discard the rest.
156 $violations = array_filter($violations, function ($v) {
157 return $v->getPropertyPath() == 'name';
159 if (count($violations) > 0) {
160 $errors['cms_name'] = (string) $violations[0]->getMessage();
164 // And if we are given an email address, let's check to see if it already exists.
165 if (!empty($params[$emailName])) {
166 $mail = $params[$emailName];
168 $user = entity_create('user');
169 $user->setEmail($mail);
171 // This checks for both email uniqueness.
172 $violations = iterator_to_array($user->validate());
173 // We only care about violations on the email field; discard the rest.
174 $violations = array_filter($violations, function ($v) {
175 return $v->getPropertyPath() == 'mail';
177 if (count($violations) > 0) {
178 $errors[$emailName] = (string) $violations[0]->getMessage();
186 public function getLoginURL($destination = '') {
187 $query = $destination ?
array('destination' => $destination) : array();
188 return \Drupal
::url('user.page', array(), array('query' => $query));
194 public function setTitle($title, $pageTitle = NULL) {
198 \Drupal
::service('civicrm.page_state')->setTitle($pageTitle);
204 public function appendBreadCrumb($breadcrumbs) {
205 $civicrmPageState = \Drupal
::service('civicrm.page_state');
206 foreach ($breadcrumbs as $breadcrumb) {
207 $civicrmPageState->addBreadcrumb($breadcrumb['title'], $breadcrumb['url']);
214 public function resetBreadCrumb() {
215 \Drupal
::service('civicrm.page_state')->resetBreadcrumbs();
221 public function addHTMLHead($header) {
222 \Drupal
::service('civicrm.page_state')->addHtmlHeader($header);
228 public function addStyleUrl($url, $region) {
229 if ($region != 'html-header') {
234 '#attributes' => array(
236 'rel' => 'stylesheet',
239 \Drupal
::service('civicrm.page_state')->addCSS($css);
246 public function addStyle($code, $region) {
247 if ($region != 'html-header') {
254 \Drupal
::service('civicrm.page_state')->addCSS($css);
259 * Check if a resource url is within the drupal directory and format appropriately.
261 * This seems to be a legacy function. We assume all resources are within the drupal
262 * directory and always return TRUE. As well, we clean up the $url.
264 * FIXME: This is not a legacy function and the above is not a safe assumption.
265 * External urls are allowed by CRM_Core_Resources and this needs to return the correct value.
271 public function formatResourceUrl(&$url) {
272 // Remove leading slash if present.
273 $url = ltrim($url, '/');
275 // Remove query string — presumably added to stop intermediary caching.
276 if (($pos = strpos($url, '?')) !== FALSE) {
277 $url = substr($url, 0, $pos);
279 // FIXME: Should not unconditionally return true
284 * This function does nothing in Drupal 8. Changes to the base_url should be made
285 * in settings.php directly.
287 public function mapConfigToSSL() {
299 $forceBackend = FALSE
301 $query = html_entity_decode($query);
303 $url = \Drupal\civicrm\CivicrmHelper
::parseURL("{$path}?{$query}");
305 // Not all links that CiviCRM generates are Drupal routes, so we use the weaker ::fromUri method.
307 $url = \Drupal\Core\Url
::fromUri("base:{$url['path']}", array(
308 'query' => $url['query'],
309 'fragment' => $fragment,
310 'absolute' => $absolute,
313 catch (Exception
$e) {
314 // @Todo: log to watchdog
318 // Special case: CiviCRM passes us "*path*?*query*" as a skeleton, but asterisks
319 // are invalid and Drupal will attempt to escape them. We unescape them here:
320 if ($path == '*path*') {
321 // First remove trailing equals sign that has been added since the key '?*query*' has no value.
322 $url = rtrim($url, '=');
323 $url = urldecode($url);
332 public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
333 $system = new CRM_Utils_System_Drupal8();
334 $system->loadBootStrap(array(), FALSE);
336 $uid = \Drupal
::service('user.auth')->authenticate($name, $password);
338 if ($this->loadUser($name)) {
339 $contact_id = CRM_Core_BAO_UFMatch
::getContactId($uid);
340 return array($contact_id, $uid, mt_rand());
350 public function loadUser($username) {
351 $user = user_load_by_name($username);
356 // Set Drupal's current user to the loaded user.
357 \Drupal
::currentUser()->setAccount($user);
360 $contact_id = CRM_Core_BAO_UFMatch
::getContactId($uid);
362 // Store the contact id and user id in the session
363 $session = CRM_Core_Session
::singleton();
364 $session->set('ufID', $uid);
365 $session->set('userID', $contact_id);
370 * Determine the native ID of the CMS user.
372 * @param string $username
375 public function getUfId($username) {
376 if ($id = user_load_by_name($username)->id()) {
384 public function permissionDenied() {
385 \Drupal
::service('civicrm.page_state')->setAccessDenied();
389 * In previous versions, this function was the controller for logging out. In Drupal 8, we rewrite the route
390 * to hand off logout to the standard Drupal logout controller. This function should therefore never be called.
392 public function logout() {
397 * Load drupal bootstrap.
399 * @param array $params
400 * Either uid, or name & pass.
401 * @param bool $loadUser
402 * Boolean Require CMS user load.
403 * @param bool $throwError
404 * If true, print error on failure and exit.
405 * @param bool|string $realPath path to script
408 * @Todo Handle setting cleanurls configuration for CiviCRM?
410 public function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
411 static $run_once = FALSE;
419 if (!($root = $this->cmsRootPath())) {
424 // Create a mock $request object
425 $autoloader = require_once $root . '/autoload.php';
426 if ($autoloader === TRUE) {
427 $autoloader = ComposerAutoloaderInitDrupal8
::getLoader();
429 // @Todo: do we need to handle case where $_SERVER has no HTTP_HOST key, ie. when run via cli?
430 $request = new \Symfony\Component\HttpFoundation\
Request(array(), array(), array(), array(), array(), $_SERVER);
432 // Create a kernel and boot it.
433 \Drupal\Core\DrupalKernel
::createFromRequest($request, $autoloader, 'prod')->prepareLegacyRequest($request);
435 // Initialize Civicrm
436 \Drupal
::service('civicrm')->initialize();
438 // We need to call the config hook again, since we now know
439 // all the modules that are listening on it (CRM-8655).
440 CRM_Utils_Hook
::config($config);
443 if (!empty($params['uid']) && $username = \Drupal\user\Entity\User
::load($params['uid'])->getUsername()) {
444 $this->loadUser($username);
446 elseif (!empty($params['name']) && !empty($params['pass']) && \Drupal
::service('user.auth')->authenticate($params['name'], $params['pass'])) {
447 $this->loadUser($params['name']);
454 * Determine the location of the CMS root.
456 * @param string $path
458 * @return NULL|string
460 public function cmsRootPath($path = NULL) {
461 global $civicrm_paths;
462 if (!empty($civicrm_paths['cms.root']['path'])) {
463 return $civicrm_paths['cms.root']['path'];
466 if (defined('DRUPAL_ROOT')) {
470 // It looks like Drupal hasn't been bootstrapped.
471 // We're going to attempt to discover the root Drupal path
472 // by climbing out of the folder hierarchy and looking around to see
473 // if we've found the Drupal root directory.
475 $path = $_SERVER['SCRIPT_FILENAME'];
478 // Normalize and explode path into its component paths.
479 $paths = explode(DIRECTORY_SEPARATOR
, realpath($path));
481 // Remove script filename from array of directories.
484 while (count($paths)) {
485 $candidate = implode('/', $paths);
486 if (file_exists($candidate . "/core/includes/bootstrap.inc")) {
497 public function isUserLoggedIn() {
498 return \Drupal
::currentUser()->isAuthenticated();
504 public function isUserRegistrationPermitted() {
505 if (\Drupal
::config('user.settings')->get('register') == 'admin_only') {
514 public function isPasswordUserGenerated() {
515 if (\Drupal
::config('user.settings')->get('verify_mail') == TRUE) {
524 public function updateCategories() {
525 // @todo Is anything necessary?
531 public function getLoggedInUfID() {
532 if ($id = \Drupal
::currentUser()->id()) {
540 public function getDefaultBlockLocation() {
541 return 'sidebar_first';
547 public function flush() {
548 // CiviCRM and Drupal both provide (different versions of) Symfony (and possibly share other classes too).
549 // If we call drupal_flush_all_caches(), Drupal will attempt to rediscover all of its classes, use Civicrm's
550 // alternatives instead and then die. Instead, we only clear cache bins and no more.
551 foreach (Drupal\Core\Cache\Cache
::getBins() as $service_id => $cache_backend) {
552 $cache_backend->deleteAll();
559 public function getModules() {
562 $module_data = system_rebuild_module_data();
563 foreach ($module_data as $module_name => $extension) {
564 if (!isset($extension->info
['hidden']) && $extension->origin
!= 'core') {
565 $extension->schema_version
= drupal_get_installed_schema_version($module_name);
566 $modules[] = new CRM_Core_Module('drupal.' . $module_name, ($extension->status
== 1 ?
TRUE : FALSE));
575 public function getUser($contactID) {
576 $user_details = parent
::getUser($contactID);
577 $user_details['name'] = $user_details['name']->value
;
578 $user_details['email'] = $user_details['email']->value
;
579 return $user_details;
585 public function getUniqueIdentifierFromUserObject($user) {
586 return $user->get('mail')->value
;
592 public function getUserIDFromUserObject($user) {
593 return $user->get('uid')->value
;
599 public function synchronizeUsers() {
600 $config = CRM_Core_Config
::singleton();
601 if (PHP_SAPI
!= 'cli') {
606 $users = \Drupal
::entityTypeManager()->getStorage('user')->loadByProperties();
608 $uf = $config->userFramework
;
611 $contactMatching = 0;
612 foreach ($users as $user) {
613 $mail = $user->get('mail')->value
;
617 $uid = $user->get('uid')->value
;
619 if ($match = CRM_Core_BAO_UFMatch
::synchronizeUFMatch($user, $uid, $mail, $uf, 1, 'Individual', TRUE)) {
625 if (is_object($match)) {
631 'contactCount' => $contactCount,
632 'contactMatching' => $contactMatching,
633 'contactCreated' => $contactCreated,
640 public function setMessage($message) {
641 // CiviCRM sometimes includes markup in messages (ex: Event Cart)
642 // it needs to be rendered before being displayed.
643 $message = \Drupal\Core\Render\Markup
::create($message);
644 \Drupal
::messenger()->addMessage($message);
648 * Drupal 8 has a different function to get current path, hence
649 * overriding the postURL function
651 * @param string $action
655 public function postURL($action) {
656 if (!empty($action)) {
659 $current_path = \Drupal
::service('path.current')->getPath();
660 return $this->url($current_path);
664 * Function to return current language of Drupal8
668 public function getCurrentLanguage() {
669 // Drupal might not be bootstrapped if being called by the REST API.
670 if (!class_exists('Drupal')) {
674 return \Drupal
::languageManager()->getCurrentLanguage()->getId();
678 * Append Drupal8 js to coreResourcesList.
682 public function appendCoreResources(&$list) {
683 $list[] = 'js/crm.drupal8.js';