3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
37 * Drupal specific stuff goes here
39 abstract class CRM_Utils_System_DrupalBase
extends CRM_Utils_System_Base
{
42 * Does this CMS / UF support a CMS specific logging mechanism?
43 * @todo - we should think about offering up logging mechanisms in a way that is also extensible by extensions
46 var $supports_UF_Logging = TRUE;
50 public function __construct() {
52 * deprecated property to check if this is a drupal install. The correct method is to have functions on the UF classes for all UF specific
53 * functions and leave the codebase oblivious to the type of CMS
57 $this->is_drupal
= TRUE;
58 $this->supports_form_extensions
= TRUE;
64 public function getDefaultFileStorage() {
65 $config = CRM_Core_Config
::singleton();
66 $baseURL = CRM_Utils_System
::languageNegotiationURL($config->userFrameworkBaseURL
, FALSE, TRUE);
68 $siteName = $this->parseDrupalSiteNameFromRequest('/files/civicrm');
70 $filesURL = $baseURL . "sites/$siteName/files/civicrm/";
73 $filesURL = $baseURL . "sites/default/files/civicrm/";
78 'path' => CRM_Utils_File
::baseFilePath(),
85 public function getDefaultSiteSettings($dir) {
86 $config = CRM_Core_Config
::singleton();
87 $siteName = $siteRoot = NULL;
90 '|/sites/([\w\.\-\_]+)/|',
91 $config->templateCompileDir
,
94 $siteName = $matches[1];
96 $siteName = "/sites/$siteName/";
97 $siteNamePos = strpos($dir, $siteName);
98 if ($siteNamePos !== FALSE) {
99 $siteRoot = substr($dir, 0, $siteNamePos);
103 $url = $config->userFrameworkBaseURL
;
104 return array($url, $siteName, $siteRoot);
108 * Check if a resource url is within the drupal directory and format appropriately.
110 * @param $url (reference)
113 * TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more
114 * efficiently if it is known to be in the drupal site
116 public function formatResourceUrl(&$url) {
118 $base = CRM_Core_Config
::singleton()->resourceBase
;
120 // Handle absolute urls
121 // compares $url (which is some unknown/untrusted value from a third-party dev) to the CMS's base url (which is independent of civi's url)
122 // to see if the url is within our drupal dir, if it is we are able to treated it as an internal url
123 if (strpos($url, $base_url) === 0) {
124 $file = trim(str_replace($base_url, '', $url), '/');
125 // CRM-18130: Custom CSS URL not working if aliased or rewritten
126 if (file_exists(DRUPAL_ROOT
. $file)) {
131 // Handle relative urls that are within the CiviCRM module directory
132 elseif (strpos($url, $base) === 0) {
134 $url = $this->appendCoreDirectoryToResourceBase(dirname(drupal_get_path('module', 'civicrm')) . '/') . trim(substr($url, strlen($base)), '/');
136 // Strip query string
137 $q = strpos($url, '?');
138 if ($q && $internal) {
139 $url = substr($url, 0, $q);
145 * In instance where civicrm folder has a drupal folder & a civicrm core folder @ the same level append the
146 * civicrm folder name to the url
147 * See CRM-13737 for discussion of how this allows implementers to alter the folder structure
148 * @todo - this only provides a limited amount of flexiblity - it still expects a 'civicrm' folder with a 'drupal' folder
149 * and is only flexible as to the name of the civicrm folder.
152 * Potential resource url based on standard folder assumptions.
154 * with civicrm-core directory appended if not standard civi dir
156 public function appendCoreDirectoryToResourceBase($url) {
157 global $civicrm_root;
158 $lastDirectory = basename($civicrm_root);
159 if ($lastDirectory != 'civicrm') {
160 return $url .= $lastDirectory . '/';
166 * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
176 $forceBackend = FALSE
178 $config = CRM_Core_Config
::singleton();
179 $script = 'index.php';
181 $path = CRM_Utils_String
::stripPathChars($path);
183 if (isset($fragment)) {
184 $fragment = '#' . $fragment;
187 $base = $absolute ?
$config->userFrameworkBaseURL
: $config->useFrameworkRelativeBase
;
191 if (!$config->cleanURL
) {
194 return $base . $script . '?q=' . $path . $separator . $query . $fragment;
197 return $base . $script . '?q=' . $path . $fragment;
202 return $base . $script . '?' . $query . $fragment;
205 return $base . $fragment;
212 return $base . $path . '?' . $query . $fragment;
215 return $base . $path . $fragment;
220 return $base . $script . '?' . $query . $fragment;
223 return $base . $fragment;
232 public function getUserIDFromUserObject($user) {
233 return !empty($user->uid
) ?
$user->uid
: NULL;
239 public function setMessage($message) {
240 drupal_set_message($message);
246 public function getUniqueIdentifierFromUserObject($user) {
247 return empty($user->mail
) ?
NULL : $user->mail
;
253 public function getLoggedInUniqueIdentifier() {
255 return $this->getUniqueIdentifierFromUserObject($user);
261 public function permissionDenied() {
262 drupal_access_denied();
268 public function getUserRecordUrl($contactID) {
269 $uid = CRM_Core_BAO_UFMatch
::getUFId($contactID);
270 if (CRM_Core_Session
::singleton()
271 ->get('userID') == $contactID || CRM_Core_Permission
::checkAnyPerm(array(
272 'cms:administer users',
273 'cms:view user account',
276 return $this->url('user/' . $uid);
283 public function checkPermissionAddUser() {
284 return CRM_Core_Permission
::check('administer users');
290 public function logger($message) {
291 if (CRM_Core_Config
::singleton()->userFrameworkLogging
&& function_exists('watchdog')) {
292 watchdog('civicrm', '%message', array('%message' => $message), NULL, WATCHDOG_DEBUG
);
299 public function clearResourceCache() {
300 _drupal_flush_css_js();
304 * Append Drupal js to coreResourcesList.
308 public function appendCoreResources(&$list) {
309 $list[] = 'js/crm.drupal.js';
315 public function flush() {
316 drupal_flush_all_caches();
322 public function getModules() {
324 $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
325 foreach ($q as $row) {
326 $result[] = new CRM_Core_Module('drupal.' . $row->name
, ($row->status
== 1) ?
TRUE : FALSE);
332 * Find any users/roles/security-principals with the given permission
333 * and replace it with one or more permissions.
335 * @param string $oldPerm
336 * @param array $newPerms
341 public function replacePermission($oldPerm, $newPerms) {
342 $roles = user_roles(FALSE, $oldPerm);
343 if (!empty($roles)) {
344 foreach (array_keys($roles) as $rid) {
345 user_role_revoke_permissions($rid, array($oldPerm));
346 user_role_grant_permissions($rid, $newPerms);
354 public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
359 //CRM-7803 -from d7 onward.
360 $config = CRM_Core_Config
::singleton();
361 if (function_exists('variable_get') &&
362 module_exists('locale') &&
363 function_exists('language_negotiation_get')
367 //does user configuration allow language
368 //support from the URL (Path prefix or domain)
369 if (language_negotiation_get('language') == 'locale-url') {
370 $urlType = variable_get('locale_language_negotiation_url_part');
373 if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX
) {
374 if (isset($language->prefix
) && $language->prefix
) {
375 if ($addLanguagePart) {
376 $url .= $language->prefix
. '/';
378 if ($removeLanguagePart) {
379 $url = str_replace("/{$language->prefix}/", '/', $url);
384 if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN
) {
385 if (isset($language->domain
) && $language->domain
) {
386 if ($addLanguagePart) {
387 $url = (CRM_Utils_System
::isSSL() ?
'https' : 'http') . '://' . $language->domain
. base_path();
389 if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
390 $url = str_replace('\\', '/', $url);
391 $parseUrl = parse_url($url);
393 //kinda hackish but not sure how to do it right
394 //hope http_build_url() will help at some point.
395 if (is_array($parseUrl) && !empty($parseUrl)) {
396 $urlParts = explode('/', $url);
397 $hostKey = array_search($parseUrl['host'], $urlParts);
398 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL
);
399 $urlParts[$hostKey] = $ufUrlParts['host'];
400 $url = implode('/', $urlParts);
413 public function getVersion() {
414 return defined('VERSION') ? VERSION
: 'Unknown';
420 public function isUserRegistrationPermitted() {
421 if (!variable_get('user_register', TRUE)) {
430 public function isPasswordUserGenerated() {
431 if (variable_get('user_email_verification', TRUE)) {
440 public function updateCategories() {
441 // copied this from profile.module. Seems a bit inefficient, but i don't know a better way
449 public function getUFLocale() {
450 // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
451 // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
452 // sometimes for CLI based on order called, this might not be set and/or empty
455 if (empty($language)) {
459 if ($language->language
== 'zh-hans') {
463 if ($language->language
== 'zh-hant') {
467 if (preg_match('/^.._..$/', $language->language
)) {
468 return $language->language
;
471 return CRM_Core_I18n_PseudoConstant
::longForShort(substr($language->language
, 0, 2));
477 public function setUFLocale($civicrm_language) {
480 $langcode = substr($civicrm_language, 0, 2);
481 $languages = language_list();
483 if (isset($languages[$langcode])) {
484 $language = $languages[$langcode];
486 // Config must be re-initialized to reset the base URL
487 // otherwise links will have the wrong language prefix/domain.
488 $config = CRM_Core_Config
::singleton();
498 * Perform any post login activities required by the UF -
499 * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
500 * calls hook_user op 'login' and generates a new session.
502 * @param array $params
504 * FIXME: Document values accepted/required by $params
506 public function userLoginFinalize($params = array()) {
507 user_login_finalize($params);
513 public function getLoginDestination(&$form) {
516 $id = $form->get('id');
521 $gid = $form->get('gid');
523 $args .= "&gid=$gid";
526 // Setup Personal Campaign Page link uses pageId
527 $pageId = $form->get('pageId');
529 $component = $form->get('component');
530 $args .= "&pageId=$pageId&component=$component&action=add";
537 // append destination so user is returned to form they came from after login
538 $destination = CRM_Utils_System
::currentPath() . '?reset=1' . $args;
544 * Fixme: Why are we overriding the parent function? Seems inconsistent.
545 * This version supplies slightly different params to $this->url (not absolute and html encoded) but why?
547 * @param string $action
551 public function postURL($action) {
552 if (!empty($action)) {
555 return $this->url($_GET['q']);
559 * Get an array of user details for a contact, containing at minimum the user ID & name.
561 * @param int $contactID
564 * CMS user details including
566 * - name (ie the system user name.
568 public function getUser($contactID) {
569 $userDetails = parent
::getUser($contactID);
570 $user = $this->getUserObject($userDetails['id']);
571 $userDetails['name'] = $user->name
;
572 $userDetails['email'] = $user->mail
;
577 * Load the user object.
579 * Note this function still works in drupal 6, 7 & 8 but is deprecated in Drupal 8.
585 public function getUserObject($userID) {
586 return user_load($userID);
590 * Parse the name of the drupal site.
592 * @param string $civicrm_root
594 * @return null|string
597 public function parseDrupalSiteNameFromRoot($civicrm_root) {
599 if (strpos($civicrm_root,
600 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
. 'all' . DIRECTORY_SEPARATOR
. 'modules'
603 $startPos = strpos($civicrm_root,
604 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
606 $endPos = strpos($civicrm_root,
607 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
609 if ($startPos && $endPos) {
610 // if component is in sites/SITENAME/modules
611 $siteName = substr($civicrm_root,
613 $endPos - $startPos - 7
621 * Determine if Drupal multi-site applies to the current request -- and,
622 * specifically, determine the name of the multisite folder.
624 * @param string $flagFile
625 * Check if $flagFile exists inside the site dir.
626 * @return null|string
627 * string, e.g. `bar.example.com` if using multisite.
628 * NULL if using the default site.
630 private function parseDrupalSiteNameFromRequest($flagFile = '') {
631 $phpSelf = array_key_exists('PHP_SELF', $_SERVER) ?
$_SERVER['PHP_SELF'] : '';
632 $httpHost = array_key_exists('HTTP_HOST', $_SERVER) ?
$_SERVER['HTTP_HOST'] : '';
633 if (empty($httpHost)) {
634 $httpHost = parse_url(CIVICRM_UF_BASEURL
, PHP_URL_HOST
);
635 if (parse_url(CIVICRM_UF_BASEURL
, PHP_URL_PORT
)) {
636 $httpHost .= ':' . parse_url(CIVICRM_UF_BASEURL
, PHP_URL_PORT
);
640 $confdir = $this->cmsRootPath() . '/sites';
642 if (file_exists($confdir . "/sites.php")) {
643 include $confdir . "/sites.php";
649 $uri = explode('/', $phpSelf);
650 $server = explode('.', implode('.', array_reverse(explode(':', rtrim($httpHost, '.')))));
651 for ($i = count($uri) - 1; $i > 0; $i--) {
652 for ($j = count($server); $j > 0; $j--) {
653 $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
654 if (file_exists("$confdir/$dir" . $flagFile)) {
655 \Civi
::$statics[__CLASS__
]['drupalSiteName'] = $dir;
656 return \Civi
::$statics[__CLASS__
]['drupalSiteName'];
659 if (isset($sites[$dir]) && file_exists("$confdir/{$sites[$dir]}" . $flagFile)) {
660 \Civi
::$statics[__CLASS__
]['drupalSiteName'] = $sites[$dir];
661 return \Civi
::$statics[__CLASS__
]['drupalSiteName'];