Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | ||
18 | /** | |
19 | * Drupal specific stuff goes here | |
20 | */ | |
9977c6f5 | 21 | class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { |
6a488035 TO |
22 | |
23 | /** | |
17f443df | 24 | * @inheritDoc |
6a488035 | 25 | */ |
00be9182 | 26 | public function createUser(&$params, $mail) { |
88b91745 | 27 | $form_state = form_state_defaults(); |
d0ffa3e4 | 28 | |
be2fb01f | 29 | $form_state['input'] = [ |
6a488035 TO |
30 | 'name' => $params['cms_name'], |
31 | 'mail' => $params[$mail], | |
32 | 'op' => 'Create new account', | |
be2fb01f | 33 | ]; |
6a488035 TO |
34 | |
35 | $admin = user_access('administer users'); | |
36 | if (!variable_get('user_email_verification', TRUE) || $admin) { | |
be2fb01f | 37 | $form_state['input']['pass'] = ['pass1' => $params['cms_pass'], 'pass2' => $params['cms_pass']]; |
6a488035 TO |
38 | } |
39 | ||
9b873358 | 40 | if (!empty($params['notify'])) { |
6a488035 TO |
41 | $form_state['input']['notify'] = $params['notify']; |
42 | } | |
43 | ||
44 | $form_state['rebuild'] = FALSE; | |
45 | $form_state['programmed'] = TRUE; | |
805b0f6e | 46 | $form_state['complete form'] = FALSE; |
6a488035 | 47 | $form_state['method'] = 'post'; |
be2fb01f | 48 | $form_state['build_info']['args'] = []; |
41d551ad | 49 | /* |
e70a7fc0 TO |
50 | * if we want to submit this form more than once in a process (e.g. create more than one user) |
51 | * we must force it to validate each time for this form. Otherwise it will not validate | |
52 | * subsequent submissions and the manner in which the password is passed in will be invalid | |
53 | */ | |
41d551ad | 54 | $form_state['must_validate'] = TRUE; |
6a488035 TO |
55 | $config = CRM_Core_Config::singleton(); |
56 | ||
57 | // we also need to redirect b | |
58 | $config->inCiviCRM = TRUE; | |
59 | ||
60 | $form = drupal_retrieve_form('user_register_form', $form_state); | |
61 | $form_state['process_input'] = 1; | |
62 | $form_state['submitted'] = 1; | |
be2fb01f | 63 | $form['#array_parents'] = []; |
805b0f6e | 64 | $form['#tree'] = FALSE; |
6a488035 TO |
65 | drupal_process_form('user_register_form', $form, $form_state); |
66 | ||
67 | $config->inCiviCRM = FALSE; | |
68 | ||
69 | if (form_get_errors()) { | |
70 | return FALSE; | |
71 | } | |
a5ecff8d | 72 | return $form_state['user']->uid; |
6a488035 TO |
73 | } |
74 | ||
8f939417 RO |
75 | /** |
76 | * Appends a Drupal 7 Javascript file when the CRM Menubar Javascript file has | |
77 | * been included. The file is added before the menu bar so we can properly listen | |
78 | * for the menu bar ready event. | |
79 | */ | |
80 | public function appendCoreResources(\Civi\Core\Event\GenericHookEvent $event) { | |
ab77d9df | 81 | $menuBarFileIndex = array_search('js/crm.menubar.js', $event->list); |
8f939417 | 82 | |
ab77d9df CW |
83 | if ($menuBarFileIndex !== FALSE) { |
84 | array_splice($event->list, $menuBarFileIndex, 0, ['js/crm.drupal7.js']); | |
8f939417 | 85 | } |
8f939417 RO |
86 | } |
87 | ||
bb3a214a | 88 | /** |
17f443df | 89 | * @inheritDoc |
bb3a214a | 90 | */ |
00be9182 | 91 | public function updateCMSName($ufID, $ufName) { |
6a488035 TO |
92 | // CRM-5555 |
93 | if (function_exists('user_load')) { | |
94 | $user = user_load($ufID); | |
95 | if ($user->mail != $ufName) { | |
be2fb01f | 96 | user_save($user, ['mail' => $ufName]); |
6a488035 TO |
97 | $user = user_load($ufID); |
98 | } | |
99 | } | |
100 | } | |
101 | ||
102 | /** | |
fe482240 | 103 | * Check if username and email exists in the drupal db. |
6a488035 | 104 | * |
77855840 TO |
105 | * @param array $params |
106 | * Array of name and mail values. | |
107 | * @param array $errors | |
108 | * Array of errors. | |
109 | * @param string $emailName | |
110 | * Field label for the 'email'. | |
6a488035 | 111 | */ |
00be9182 | 112 | public static function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') { |
6a488035 TO |
113 | $config = CRM_Core_Config::singleton(); |
114 | ||
353ffa53 TO |
115 | $dao = new CRM_Core_DAO(); |
116 | $name = $dao->escape(CRM_Utils_Array::value('name', $params)); | |
117 | $email = $dao->escape(CRM_Utils_Array::value('mail', $params)); | |
6a488035 TO |
118 | $errors = form_get_errors(); |
119 | if ($errors) { | |
120 | // unset drupal messages to avoid twice display of errors | |
121 | unset($_SESSION['messages']); | |
122 | } | |
123 | ||
a7488080 | 124 | if (!empty($params['name'])) { |
6a488035 TO |
125 | if ($nameError = user_validate_name($params['name'])) { |
126 | $errors['cms_name'] = $nameError; | |
127 | } | |
128 | else { | |
129 | $uid = db_query( | |
130 | "SELECT uid FROM {users} WHERE name = :name", | |
be2fb01f | 131 | [':name' => $params['name']] |
6a488035 TO |
132 | )->fetchField(); |
133 | if ((bool) $uid) { | |
be2fb01f | 134 | $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.', [1 => $params['name']]); |
6a488035 TO |
135 | } |
136 | } | |
137 | } | |
138 | ||
a7488080 | 139 | if (!empty($params['mail'])) { |
6a488035 TO |
140 | if ($emailError = user_validate_mail($params['mail'])) { |
141 | $errors[$emailName] = $emailError; | |
142 | } | |
143 | else { | |
144 | $uid = db_query( | |
145 | "SELECT uid FROM {users} WHERE mail = :mail", | |
be2fb01f | 146 | [':mail' => $params['mail']] |
6a488035 TO |
147 | )->fetchField(); |
148 | if ((bool) $uid) { | |
aaba8ae5 | 149 | $resetUrl = url('user/password'); |
db18d815 | 150 | $errors[$emailName] = ts('The email address %1 already has an account associated with it. <a href="%2">Have you forgotten your password?</a>', |
be2fb01f | 151 | [1 => $params['mail'], 2 => $resetUrl] |
6a488035 TO |
152 | ); |
153 | } | |
154 | } | |
155 | } | |
156 | } | |
157 | ||
d424ffde | 158 | /** |
17f443df | 159 | * @inheritDoc |
6a488035 TO |
160 | */ |
161 | public function getLoginURL($destination = '') { | |
be2fb01f | 162 | $query = $destination ? ['destination' => $destination] : NULL; |
cd2e7151 | 163 | return CRM_Utils_System::url('user', $query, TRUE); |
6a488035 TO |
164 | } |
165 | ||
6a488035 | 166 | /** |
17f443df | 167 | * @inheritDoc |
6a488035 | 168 | */ |
00be9182 | 169 | public function setTitle($title, $pageTitle = NULL) { |
6a488035 TO |
170 | if (arg(0) == 'civicrm') { |
171 | if (!$pageTitle) { | |
172 | $pageTitle = $title; | |
173 | } | |
174 | ||
175 | drupal_set_title($pageTitle, PASS_THROUGH); | |
176 | } | |
177 | } | |
178 | ||
179 | /** | |
17f443df | 180 | * @inheritDoc |
6a488035 | 181 | */ |
00be9182 | 182 | public function appendBreadCrumb($breadCrumbs) { |
6a488035 TO |
183 | $breadCrumb = drupal_get_breadcrumb(); |
184 | ||
185 | if (is_array($breadCrumbs)) { | |
186 | foreach ($breadCrumbs as $crumbs) { | |
187 | if (stripos($crumbs['url'], 'id%%')) { | |
be2fb01f | 188 | $args = ['cid', 'mid']; |
6a488035 TO |
189 | foreach ($args as $a) { |
190 | $val = CRM_Utils_Request::retrieve($a, 'Positive', CRM_Core_DAO::$_nullObject, | |
191 | FALSE, NULL, $_GET | |
192 | ); | |
193 | if ($val) { | |
194 | $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']); | |
195 | } | |
196 | } | |
197 | } | |
198 | $breadCrumb[] = "<a href=\"{$crumbs['url']}\">{$crumbs['title']}</a>"; | |
199 | } | |
200 | } | |
201 | drupal_set_breadcrumb($breadCrumb); | |
202 | } | |
203 | ||
204 | /** | |
17f443df | 205 | * @inheritDoc |
6a488035 | 206 | */ |
00be9182 | 207 | public function resetBreadCrumb() { |
be2fb01f | 208 | $bc = []; |
6a488035 TO |
209 | drupal_set_breadcrumb($bc); |
210 | } | |
211 | ||
212 | /** | |
17f443df | 213 | * @inheritDoc |
6a488035 | 214 | */ |
00be9182 | 215 | public function addHTMLHead($header) { |
6a488035 TO |
216 | static $count = 0; |
217 | if (!empty($header)) { | |
218 | $key = 'civi_' . ++$count; | |
be2fb01f | 219 | $data = [ |
6a488035 TO |
220 | '#type' => 'markup', |
221 | '#markup' => $header, | |
be2fb01f | 222 | ]; |
6a488035 TO |
223 | drupal_add_html_head($data, $key); |
224 | } | |
225 | } | |
226 | ||
227 | /** | |
17f443df | 228 | * @inheritDoc |
6a488035 TO |
229 | */ |
230 | public function addScriptUrl($url, $region) { | |
be2fb01f | 231 | $params = ['group' => JS_LIBRARY, 'weight' => 10]; |
6a488035 TO |
232 | switch ($region) { |
233 | case 'html-header': | |
234 | case 'page-footer': | |
235 | $params['scope'] = substr($region, 5); | |
236 | break; | |
e7292422 | 237 | |
6a488035 TO |
238 | default: |
239 | return FALSE; | |
240 | } | |
241 | // If the path is within the drupal directory we can use the more efficient 'file' setting | |
42e1a97c | 242 | $params['type'] = $this->formatResourceUrl($url) ? 'file' : 'external'; |
6a488035 TO |
243 | drupal_add_js($url, $params); |
244 | return TRUE; | |
245 | } | |
246 | ||
247 | /** | |
17f443df | 248 | * @inheritDoc |
6a488035 TO |
249 | */ |
250 | public function addScript($code, $region) { | |
be2fb01f | 251 | $params = ['type' => 'inline', 'group' => JS_LIBRARY, 'weight' => 10]; |
6a488035 TO |
252 | switch ($region) { |
253 | case 'html-header': | |
254 | case 'page-footer': | |
255 | $params['scope'] = substr($region, 5); | |
256 | break; | |
e7292422 | 257 | |
6a488035 TO |
258 | default: |
259 | return FALSE; | |
260 | } | |
261 | drupal_add_js($code, $params); | |
262 | return TRUE; | |
263 | } | |
264 | ||
265 | /** | |
17f443df | 266 | * @inheritDoc |
6a488035 TO |
267 | */ |
268 | public function addStyleUrl($url, $region) { | |
269 | if ($region != 'html-header') { | |
270 | return FALSE; | |
271 | } | |
be2fb01f | 272 | $params = []; |
6a488035 | 273 | // If the path is within the drupal directory we can use the more efficient 'file' setting |
42e1a97c | 274 | $params['type'] = $this->formatResourceUrl($url) ? 'file' : 'external'; |
6a488035 TO |
275 | drupal_add_css($url, $params); |
276 | return TRUE; | |
277 | } | |
278 | ||
279 | /** | |
17f443df | 280 | * @inheritDoc |
6a488035 TO |
281 | */ |
282 | public function addStyle($code, $region) { | |
283 | if ($region != 'html-header') { | |
284 | return FALSE; | |
285 | } | |
be2fb01f | 286 | $params = ['type' => 'inline']; |
6a488035 TO |
287 | drupal_add_css($code, $params); |
288 | return TRUE; | |
289 | } | |
290 | ||
6a488035 | 291 | /** |
17f443df | 292 | * @inheritDoc |
6a488035 | 293 | */ |
00be9182 | 294 | public function mapConfigToSSL() { |
6a488035 TO |
295 | global $base_url; |
296 | $base_url = str_replace('http://', 'https://', $base_url); | |
297 | } | |
298 | ||
f2ac86d1 | 299 | /** |
300 | * Get the name of the users table. | |
301 | * | |
302 | * @return string | |
303 | */ | |
348754d5 TO |
304 | protected function getUsersTableName() { |
305 | $userFrameworkUsersTableName = Civi::settings()->get('userFrameworkUsersTableName'); | |
306 | if (empty($userFrameworkUsersTableName)) { | |
307 | $userFrameworkUsersTableName = 'users'; | |
308 | } | |
309 | return $userFrameworkUsersTableName; | |
310 | } | |
311 | ||
6a488035 | 312 | /** |
17f443df | 313 | * @inheritDoc |
6a488035 | 314 | */ |
17f443df | 315 | public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) { |
6a488035 TO |
316 | require_once 'DB.php'; |
317 | ||
318 | $config = CRM_Core_Config::singleton(); | |
319 | ||
58d1e21e SL |
320 | $ufDSN = CRM_Utils_SQL::autoSwitchDSN($config->userFrameworkDSN); |
321 | $dbDrupal = DB::connect($ufDSN); | |
6a488035 | 322 | if (DB::isError($dbDrupal)) { |
58d1e21e | 323 | throw new CRM_Core_Exception("Cannot connect to drupal db via $ufDSN, " . $dbDrupal->getMessage()); |
6a488035 TO |
324 | } |
325 | ||
326 | $account = $userUid = $userMail = NULL; | |
327 | if ($loadCMSBootstrap) { | |
be2fb01f | 328 | $bootStrapParams = []; |
6a488035 | 329 | if ($name && $password) { |
be2fb01f | 330 | $bootStrapParams = [ |
6a488035 TO |
331 | 'name' => $name, |
332 | 'pass' => $password, | |
be2fb01f | 333 | ]; |
6a488035 TO |
334 | } |
335 | CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath); | |
336 | ||
337 | global $user; | |
338 | if ($user) { | |
339 | $userUid = $user->uid; | |
340 | $userMail = $user->mail; | |
341 | } | |
342 | } | |
343 | else { | |
344 | // CRM-8638 | |
345 | // SOAP cannot load drupal bootstrap and hence we do it the old way | |
346 | // Contact CiviSMTP folks if we run into issues with this :) | |
347 | $cmsPath = $config->userSystem->cmsRootPath($realPath); | |
348 | ||
e7292422 TO |
349 | require_once "$cmsPath/includes/bootstrap.inc"; |
350 | require_once "$cmsPath/includes/password.inc"; | |
6a488035 TO |
351 | |
352 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; | |
353ffa53 | 353 | $name = $dbDrupal->escapeSimple($strtolower($name)); |
348754d5 | 354 | $userFrameworkUsersTableName = $this->getUsersTableName(); |
b27d1855 | 355 | |
356 | // LOWER in query below roughly translates to 'hurt my database without deriving any benefit' See CRM-19811. | |
353ffa53 | 357 | $sql = " |
6a488035 | 358 | SELECT u.* |
348754d5 | 359 | FROM {$userFrameworkUsersTableName} u |
6a488035 TO |
360 | WHERE LOWER(u.name) = '$name' |
361 | AND u.status = 1 | |
362 | "; | |
363 | ||
364 | $query = $dbDrupal->query($sql); | |
365 | $row = $query->fetchRow(DB_FETCHMODE_ASSOC); | |
366 | ||
367 | if ($row) { | |
368 | $fakeDrupalAccount = drupal_anonymous_user(); | |
369 | $fakeDrupalAccount->name = $name; | |
370 | $fakeDrupalAccount->pass = $row['pass']; | |
371 | $passwordCheck = user_check_password($password, $fakeDrupalAccount); | |
372 | if ($passwordCheck) { | |
373 | $userUid = $row['uid']; | |
374 | $userMail = $row['mail']; | |
375 | } | |
376 | } | |
377 | } | |
378 | ||
379 | if ($userUid && $userMail) { | |
380 | CRM_Core_BAO_UFMatch::synchronizeUFMatch($account, $userUid, $userMail, 'Drupal'); | |
381 | $contactID = CRM_Core_BAO_UFMatch::getContactId($userUid); | |
382 | if (!$contactID) { | |
383 | return FALSE; | |
384 | } | |
be2fb01f | 385 | return [$contactID, $userUid, mt_rand()]; |
6a488035 TO |
386 | } |
387 | return FALSE; | |
388 | } | |
389 | ||
bb3a214a | 390 | /** |
17f443df | 391 | * @inheritDoc |
bb3a214a | 392 | */ |
00be9182 | 393 | public function loadUser($username) { |
6a488035 TO |
394 | global $user; |
395 | ||
396 | $user = user_load_by_name($username); | |
397 | ||
398 | if (empty($user->uid)) { | |
399 | return FALSE; | |
400 | } | |
401 | ||
402 | $uid = $user->uid; | |
403 | $contact_id = CRM_Core_BAO_UFMatch::getContactId($uid); | |
404 | ||
405 | // lets store contact id and user id in session | |
406 | $session = CRM_Core_Session::singleton(); | |
407 | $session->set('ufID', $uid); | |
408 | $session->set('userID', $contact_id); | |
409 | return TRUE; | |
410 | } | |
411 | ||
82d9c21e | 412 | /** |
53980972 | 413 | * Perform any post login activities required by the UF - |
414 | * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp, | |
415 | * calls hook_user op 'login' and generates a new session. | |
e43cc689 | 416 | * |
c301f76e | 417 | * @param array $params |
95d68223 TO |
418 | * |
419 | * FIXME: Document values accepted/required by $params | |
53980972 | 420 | */ |
be2fb01f | 421 | public function userLoginFinalize($params = []) { |
53980972 | 422 | user_login_finalize($params); |
82d9c21e | 423 | } |
424 | ||
46b6363c | 425 | /** |
fe482240 | 426 | * Determine the native ID of the CMS user. |
46b6363c | 427 | * |
100fef9d | 428 | * @param string $username |
e97c66ff | 429 | * @return int|null |
46b6363c | 430 | */ |
00be9182 | 431 | public function getUfId($username) { |
46b6363c TO |
432 | $user = user_load_by_name($username); |
433 | if (empty($user->uid)) { | |
434 | return NULL; | |
435 | } | |
436 | return $user->uid; | |
437 | } | |
438 | ||
6a488035 | 439 | /** |
17f443df | 440 | * @inheritDoc |
bb3a214a | 441 | */ |
00be9182 | 442 | public function logout() { |
6a488035 TO |
443 | module_load_include('inc', 'user', 'user.pages'); |
444 | return user_logout(); | |
445 | } | |
446 | ||
6a488035 | 447 | /** |
fe482240 | 448 | * Get the default location for CiviCRM blocks. |
6a488035 TO |
449 | * |
450 | * @return string | |
451 | */ | |
00be9182 | 452 | public function getDefaultBlockLocation() { |
6a488035 TO |
453 | return 'sidebar_first'; |
454 | } | |
455 | ||
6a488035 | 456 | /** |
fe482240 | 457 | * Load drupal bootstrap. |
6a488035 | 458 | * |
77855840 TO |
459 | * @param array $params |
460 | * Either uid, or name & pass. | |
461 | * @param bool $loadUser | |
462 | * Boolean Require CMS user load. | |
463 | * @param bool $throwError | |
464 | * If true, print error on failure and exit. | |
465 | * @param bool|string $realPath path to script | |
f4aaa82a EM |
466 | * |
467 | * @return bool | |
6a488035 | 468 | */ |
be2fb01f | 469 | public function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) { |
6a488035 TO |
470 | //take the cms root path. |
471 | $cmsPath = $this->cmsRootPath($realPath); | |
472 | ||
473 | if (!file_exists("$cmsPath/includes/bootstrap.inc")) { | |
474 | if ($throwError) { | |
de1a27d0 | 475 | throw new Exception('Sorry, could not locate bootstrap.inc'); |
6a488035 TO |
476 | } |
477 | return FALSE; | |
478 | } | |
479 | // load drupal bootstrap | |
480 | chdir($cmsPath); | |
481 | define('DRUPAL_ROOT', $cmsPath); | |
482 | ||
483 | // For drupal multi-site CRM-11313 | |
484 | if ($realPath && strpos($realPath, 'sites/all/modules/') === FALSE) { | |
485 | preg_match('@sites/([^/]*)/modules@s', $realPath, $matches); | |
486 | if (!empty($matches[1])) { | |
487 | $_SERVER['HTTP_HOST'] = $matches[1]; | |
488 | } | |
489 | } | |
490 | require_once 'includes/bootstrap.inc'; | |
38507482 CB |
491 | // @ to suppress notices eg 'DRUPALFOO already defined'. |
492 | @drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL); | |
6a488035 TO |
493 | |
494 | // explicitly setting error reporting, since we cannot handle drupal related notices | |
3ccadca3 ES |
495 | // @todo 1 = E_ERROR, but more to the point setting error reporting deep in code |
496 | // causes grief with debugging scripts | |
6a488035 | 497 | error_reporting(1); |
de1a27d0 | 498 | if (!function_exists('module_exists')) { |
6a488035 | 499 | if ($throwError) { |
de1a27d0 ES |
500 | throw new Exception('Sorry, could not load drupal bootstrap.'); |
501 | } | |
502 | return FALSE; | |
503 | } | |
504 | if (!module_exists('civicrm')) { | |
505 | if ($throwError) { | |
506 | throw new Exception('Sorry, drupal cannot find CiviCRM'); | |
6a488035 TO |
507 | } |
508 | return FALSE; | |
509 | } | |
510 | ||
511 | // seems like we've bootstrapped drupal | |
512 | $config = CRM_Core_Config::singleton(); | |
513 | ||
6a488035 TO |
514 | // lets also fix the clean url setting |
515 | // CRM-6948 | |
516 | $config->cleanURL = (int) variable_get('clean_url', '0'); | |
517 | ||
518 | // we need to call the config hook again, since we now know | |
519 | // all the modules that are listening on it, does not apply | |
520 | // to J! and WP as yet | |
521 | // CRM-8655 | |
522 | CRM_Utils_Hook::config($config); | |
523 | ||
524 | if (!$loadUser) { | |
525 | return TRUE; | |
526 | } | |
527 | ||
9c1bc317 | 528 | $uid = $params['uid'] ?? NULL; |
6a488035 TO |
529 | if (!$uid) { |
530 | //load user, we need to check drupal permissions. | |
531 | $name = CRM_Utils_Array::value('name', $params, FALSE) ? $params['name'] : trim(CRM_Utils_Array::value('name', $_REQUEST)); | |
532 | $pass = CRM_Utils_Array::value('pass', $params, FALSE) ? $params['pass'] : trim(CRM_Utils_Array::value('pass', $_REQUEST)); | |
533 | ||
534 | if ($name) { | |
535 | $uid = user_authenticate($name, $pass); | |
536 | if (!$uid) { | |
537 | if ($throwError) { | |
de1a27d0 | 538 | throw new Exception('Sorry, unrecognized username or password.'); |
6a488035 TO |
539 | } |
540 | return FALSE; | |
541 | } | |
542 | } | |
543 | } | |
544 | ||
545 | if ($uid) { | |
546 | $account = user_load($uid); | |
547 | if ($account && $account->uid) { | |
548 | global $user; | |
549 | $user = $account; | |
550 | return TRUE; | |
551 | } | |
552 | } | |
553 | ||
554 | if ($throwError) { | |
de1a27d0 | 555 | throw new Exception('Sorry, can not load CMS user account.'); |
6a488035 TO |
556 | } |
557 | ||
0af0e4c9 DL |
558 | // CRM-6948: When using loadBootStrap, it's implicit that CiviCRM has already loaded its settings |
559 | // which means that define(CIVICRM_CLEANURL) was correctly set. | |
6a488035 TO |
560 | // So we correct it |
561 | $config = CRM_Core_Config::singleton(); | |
e7292422 | 562 | $config->cleanURL = (int) variable_get('clean_url', '0'); |
6a488035 TO |
563 | |
564 | // CRM-8655: Drupal wasn't available during bootstrap, so hook_civicrm_config never executes | |
565 | CRM_Utils_Hook::config($config); | |
566 | ||
567 | return FALSE; | |
568 | } | |
569 | ||
a5ecff8d | 570 | /** |
ea3ddccf | 571 | * Get CMS root path. |
572 | * | |
573 | * @param string $scriptFilename | |
574 | * | |
575 | * @return null|string | |
a5ecff8d | 576 | */ |
00be9182 | 577 | public function cmsRootPath($scriptFilename = NULL) { |
6a488035 TO |
578 | $cmsRoot = $valid = NULL; |
579 | ||
580 | if (!is_null($scriptFilename)) { | |
581 | $path = $scriptFilename; | |
582 | } | |
583 | else { | |
584 | $path = $_SERVER['SCRIPT_FILENAME']; | |
585 | } | |
586 | ||
587 | if (function_exists('drush_get_context')) { | |
588 | // drush anyway takes care of multisite install etc | |
589 | return drush_get_context('DRUSH_DRUPAL_ROOT'); | |
590 | } | |
d33e2f7d | 591 | |
592 | global $civicrm_paths; | |
593 | if (!empty($civicrm_paths['cms.root']['path'])) { | |
594 | return $civicrm_paths['cms.root']['path']; | |
595 | } | |
596 | ||
6a488035 TO |
597 | // CRM-7582 |
598 | $pathVars = explode('/', | |
599 | str_replace('//', '/', | |
600 | str_replace('\\', '/', $path) | |
601 | ) | |
602 | ); | |
603 | ||
604 | //lets store first var, | |
605 | //need to get back for windows. | |
606 | $firstVar = array_shift($pathVars); | |
607 | ||
e0e68bf4 | 608 | // Remove the script name to remove an necessary iteration of the loop. |
6a488035 TO |
609 | array_pop($pathVars); |
610 | ||
948d11bf CB |
611 | // CRM-7429 -- do check for uppermost 'includes' dir, which would |
612 | // work for multisite installation. | |
6a488035 TO |
613 | do { |
614 | $cmsRoot = $firstVar . '/' . implode('/', $pathVars); | |
615 | $cmsIncludePath = "$cmsRoot/includes"; | |
948d11bf | 616 | // Stop if we find bootstrap. |
f81c7606 | 617 | if (file_exists("$cmsIncludePath/bootstrap.inc")) { |
6a488035 TO |
618 | $valid = TRUE; |
619 | break; | |
620 | } | |
621 | //remove one directory level. | |
622 | array_pop($pathVars); | |
623 | } while (count($pathVars)); | |
624 | ||
625 | return ($valid) ? $cmsRoot : NULL; | |
626 | } | |
627 | ||
628 | /** | |
17f443df | 629 | * @inheritDoc |
6a488035 TO |
630 | */ |
631 | public function isUserLoggedIn() { | |
632 | $isloggedIn = FALSE; | |
633 | if (function_exists('user_is_logged_in')) { | |
634 | $isloggedIn = user_is_logged_in(); | |
635 | } | |
636 | ||
637 | return $isloggedIn; | |
638 | } | |
639 | ||
640 | /** | |
17f443df | 641 | * @inheritDoc |
6a488035 TO |
642 | */ |
643 | public function getLoggedInUfID() { | |
644 | $ufID = NULL; | |
645 | if (function_exists('user_is_logged_in') && | |
646 | user_is_logged_in() && | |
647 | function_exists('user_uid_optional_to_arg') | |
648 | ) { | |
be2fb01f | 649 | $ufID = user_uid_optional_to_arg([]); |
6a488035 TO |
650 | } |
651 | ||
652 | return $ufID; | |
653 | } | |
654 | ||
655 | /** | |
17f443df | 656 | * @inheritDoc |
6a488035 | 657 | */ |
00be9182 | 658 | public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) { |
6a488035 TO |
659 | if (empty($url)) { |
660 | return $url; | |
661 | } | |
662 | ||
663 | //CRM-7803 -from d7 onward. | |
664 | $config = CRM_Core_Config::singleton(); | |
665 | if (function_exists('variable_get') && | |
666 | module_exists('locale') && | |
667 | function_exists('language_negotiation_get') | |
668 | ) { | |
669 | global $language; | |
670 | ||
671 | //does user configuration allow language | |
672 | //support from the URL (Path prefix or domain) | |
673 | if (language_negotiation_get('language') == 'locale-url') { | |
674 | $urlType = variable_get('locale_language_negotiation_url_part'); | |
675 | ||
676 | //url prefix | |
677 | if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) { | |
678 | if (isset($language->prefix) && $language->prefix) { | |
679 | if ($addLanguagePart) { | |
3fe61451 | 680 | $url .= $language->prefix . '/'; |
6a488035 TO |
681 | } |
682 | if ($removeLanguagePart) { | |
683 | $url = str_replace("/{$language->prefix}/", '/', $url); | |
684 | } | |
685 | } | |
686 | } | |
687 | //domain | |
688 | if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN) { | |
689 | if (isset($language->domain) && $language->domain) { | |
690 | if ($addLanguagePart) { | |
b276048c | 691 | $cleanedUrl = preg_replace('#^https?://#', '', $language->domain); |
ea54c1ae | 692 | // drupal function base_path() adds a "/" to the beginning and end of the returned path |
34020e33 | 693 | if (substr($cleanedUrl, -1) == '/') { |
ea54c1ae LS |
694 | $cleanedUrl = substr($cleanedUrl, 0, -1); |
695 | } | |
b276048c | 696 | $url = (CRM_Utils_System::isSSL() ? 'https' : 'http') . '://' . $cleanedUrl . base_path(); |
6a488035 TO |
697 | } |
698 | if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) { | |
699 | $url = str_replace('\\', '/', $url); | |
700 | $parseUrl = parse_url($url); | |
701 | ||
702 | //kinda hackish but not sure how to do it right | |
703 | //hope http_build_url() will help at some point. | |
704 | if (is_array($parseUrl) && !empty($parseUrl)) { | |
353ffa53 TO |
705 | $urlParts = explode('/', $url); |
706 | $hostKey = array_search($parseUrl['host'], $urlParts); | |
707 | $ufUrlParts = parse_url(CIVICRM_UF_BASEURL); | |
6a488035 | 708 | $urlParts[$hostKey] = $ufUrlParts['host']; |
353ffa53 | 709 | $url = implode('/', $urlParts); |
6a488035 TO |
710 | } |
711 | } | |
712 | } | |
713 | } | |
714 | } | |
715 | } | |
716 | ||
717 | return $url; | |
718 | } | |
719 | ||
720 | /** | |
721 | * Find any users/roles/security-principals with the given permission | |
722 | * and replace it with one or more permissions. | |
723 | * | |
5a4f6742 CW |
724 | * @param string $oldPerm |
725 | * @param array $newPerms | |
77855840 | 726 | * Array, strings. |
6a488035 | 727 | */ |
00be9182 | 728 | public function replacePermission($oldPerm, $newPerms) { |
6a488035 TO |
729 | $roles = user_roles(FALSE, $oldPerm); |
730 | if (!empty($roles)) { | |
731 | foreach (array_keys($roles) as $rid) { | |
be2fb01f | 732 | user_role_revoke_permissions($rid, [$oldPerm]); |
6a488035 TO |
733 | user_role_grant_permissions($rid, $newPerms); |
734 | } | |
735 | } | |
736 | } | |
737 | ||
6a488035 | 738 | /** |
fe482240 | 739 | * Wrapper for og_membership creation. |
a5ecff8d | 740 | * |
77855840 TO |
741 | * @param int $ogID |
742 | * Organic Group ID. | |
743 | * @param int $drupalID | |
744 | * Drupal User ID. | |
6a488035 | 745 | */ |
9b873358 | 746 | public function og_membership_create($ogID, $drupalID) { |
6a488035 | 747 | if (function_exists('og_entity_query_alter')) { |
a5ecff8d CB |
748 | // sort-of-randomly chose a function that only exists in the // 7.x-2.x branch |
749 | // | |
750 | // @TODO Find more solid way to check - try system_get_info('module', 'og'). | |
751 | // | |
752 | // Also, since we don't know how to get the entity type of the // group, we'll assume it's 'node' | |
be2fb01f | 753 | og_group('node', $ogID, ['entity' => user_load($drupalID)]); |
6a488035 TO |
754 | } |
755 | else { | |
756 | // Works for the OG 7.x-1.x branch | |
be2fb01f | 757 | og_group($ogID, ['entity' => user_load($drupalID)]); |
6a488035 TO |
758 | } |
759 | } | |
760 | ||
761 | /** | |
fe482240 | 762 | * Wrapper for og_membership deletion. |
a5ecff8d | 763 | * |
77855840 TO |
764 | * @param int $ogID |
765 | * Organic Group ID. | |
766 | * @param int $drupalID | |
767 | * Drupal User ID. | |
6a488035 | 768 | */ |
00be9182 | 769 | public function og_membership_delete($ogID, $drupalID) { |
6a488035 TO |
770 | if (function_exists('og_entity_query_alter')) { |
771 | // sort-of-randomly chose a function that only exists in the 7.x-2.x branch | |
772 | // TODO: Find a more solid way to make this test | |
773 | // Also, since we don't know how to get the entity type of the group, we'll assume it's 'node' | |
774 | og_ungroup('node', $ogID, 'user', user_load($drupalID)); | |
0db6c3e1 TO |
775 | } |
776 | else { | |
6a488035 TO |
777 | // Works for the OG 7.x-1.x branch |
778 | og_ungroup($ogID, 'user', user_load($drupalID)); | |
779 | } | |
780 | } | |
d8a4acc0 | 781 | |
5a604d61 | 782 | /** |
17f443df | 783 | * @inheritDoc |
5a604d61 | 784 | */ |
00be9182 | 785 | public function getTimeZoneString() { |
5a604d61 | 786 | global $user; |
e41775f6 | 787 | // Note that 0 is a valid timezone (GMT) so we use strlen not empty to check. |
788 | if (variable_get('configurable_timezones', 1) && $user->uid && isset($user->timezone) && strlen($user->timezone)) { | |
5a604d61 | 789 | $timezone = $user->timezone; |
0db6c3e1 TO |
790 | } |
791 | else { | |
e7292422 | 792 | $timezone = variable_get('date_default_timezone', NULL); |
5a604d61 | 793 | } |
48ec57ab TO |
794 | if (!$timezone) { |
795 | $timezone = parent::getTimeZoneString(); | |
5a604d61 | 796 | } |
48ec57ab | 797 | return $timezone; |
5a604d61 | 798 | } |
353ffa53 | 799 | |
d42a224c CW |
800 | /** |
801 | * @inheritDoc | |
802 | */ | |
803 | public function setHttpHeader($name, $value) { | |
804 | drupal_add_http_header($name, $value); | |
805 | } | |
806 | ||
03d5592a CW |
807 | /** |
808 | * @inheritDoc | |
809 | */ | |
810 | public function synchronizeUsers() { | |
811 | $config = CRM_Core_Config::singleton(); | |
812 | if (PHP_SAPI != 'cli') { | |
813 | set_time_limit(300); | |
814 | } | |
03d5592a CW |
815 | $id = 'uid'; |
816 | $mail = 'mail'; | |
817 | $name = 'name'; | |
818 | ||
819 | $result = db_query("SELECT uid, mail, name FROM {users} where mail != ''"); | |
820 | ||
03d5592a CW |
821 | $user = new StdClass(); |
822 | $uf = $config->userFramework; | |
823 | $contactCount = 0; | |
824 | $contactCreated = 0; | |
825 | $contactMatching = 0; | |
2eb3dae2 CW |
826 | foreach ($result as $row) { |
827 | $user->$id = $row->$id; | |
828 | $user->$mail = $row->$mail; | |
829 | $user->$name = $row->$name; | |
03d5592a | 830 | $contactCount++; |
2eb3dae2 | 831 | if ($match = CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $row->$id, $row->$mail, $uf, 1, 'Individual', TRUE)) { |
03d5592a CW |
832 | $contactCreated++; |
833 | } | |
834 | else { | |
835 | $contactMatching++; | |
836 | } | |
03d5592a CW |
837 | } |
838 | ||
be2fb01f | 839 | return [ |
03d5592a CW |
840 | 'contactCount' => $contactCount, |
841 | 'contactMatching' => $contactMatching, | |
842 | 'contactCreated' => $contactCreated, | |
be2fb01f | 843 | ]; |
03d5592a CW |
844 | } |
845 | ||
f2e906d7 JP |
846 | /** |
847 | * Commit the session before exiting. | |
848 | * Similar to drupal_exit(). | |
849 | */ | |
850 | public function onCiviExit() { | |
eb3277f9 JP |
851 | if (function_exists('module_invoke_all')) { |
852 | if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') { | |
853 | module_invoke_all('exit'); | |
854 | } | |
855 | drupal_session_commit(); | |
f2e906d7 | 856 | } |
f2e906d7 JP |
857 | } |
858 | ||
6a488035 | 859 | } |