3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 getDefaultSiteSettings($dir) {
65 $config = CRM_Core_Config
::singleton();
66 $siteName = $siteRoot = NULL;
69 '|/sites/([\w\.\-\_]+)/|',
70 $config->templateCompileDir
,
73 $siteName = $matches[1];
75 $siteName = "/sites/$siteName/";
76 $siteNamePos = strpos($dir, $siteName);
77 if ($siteNamePos !== FALSE) {
78 $siteRoot = substr($dir, 0, $siteNamePos);
82 $url = $config->userFrameworkBaseURL
;
83 return array($url, $siteName, $siteRoot);
87 * Check if a resource url is within the drupal directory and format appropriately.
89 * @param $url (reference)
92 * TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more
93 * efficiently if it is known to be in the drupal site
95 public function formatResourceUrl(&$url) {
97 $base = CRM_Core_Config
::singleton()->resourceBase
;
99 // Handle absolute urls
100 // 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)
101 // to see if the url is within our drupal dir, if it is we are able to treated it as an internal url
102 if (strpos($url, $base_url) === 0) {
104 $url = trim(str_replace($base_url, '', $url), '/');
106 // Handle relative urls that are within the CiviCRM module directory
107 elseif (strpos($url, $base) === 0) {
109 $url = $this->appendCoreDirectoryToResourceBase(substr(drupal_get_path('module', 'civicrm'), 0, -6)) . trim(substr($url, strlen($base)), '/');
111 // Strip query string
112 $q = strpos($url, '?');
113 if ($q && $internal) {
114 $url = substr($url, 0, $q);
120 * In instance where civicrm folder has a drupal folder & a civicrm core folder @ the same level append the
121 * civicrm folder name to the url
122 * See CRM-13737 for discussion of how this allows implementers to alter the folder structure
123 * @todo - this only provides a limited amount of flexiblity - it still expects a 'civicrm' folder with a 'drupal' folder
124 * and is only flexible as to the name of the civicrm folder.
127 * Potential resource url based on standard folder assumptions.
129 * with civicrm-core directory appended if not standard civi dir
131 public function appendCoreDirectoryToResourceBase($url) {
132 global $civicrm_root;
133 $lastDirectory = basename($civicrm_root);
134 if ($lastDirectory != 'civicrm') {
135 return $url .= $lastDirectory . '/';
141 * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
151 $forceBackend = FALSE
153 $config = CRM_Core_Config
::singleton();
154 $script = 'index.php';
156 $path = CRM_Utils_String
::stripPathChars($path);
158 if (isset($fragment)) {
159 $fragment = '#' . $fragment;
162 $base = $absolute ?
$config->userFrameworkBaseURL
: $config->useFrameworkRelativeBase
;
166 if (!$config->cleanURL
) {
169 return $base . $script . '?q=' . $path . $separator . $query . $fragment;
172 return $base . $script . '?q=' . $path . $fragment;
177 return $base . $script . '?' . $query . $fragment;
180 return $base . $fragment;
187 return $base . $path . '?' . $query . $fragment;
190 return $base . $path . $fragment;
195 return $base . $script . '?' . $query . $fragment;
198 return $base . $fragment;
207 public function getUserIDFromUserObject($user) {
208 return !empty($user->uid
) ?
$user->uid
: NULL;
214 public function setMessage($message) {
215 drupal_set_message($message);
221 public function getUniqueIdentifierFromUserObject($user) {
222 return empty($user->mail
) ?
NULL : $user->mail
;
228 public function getLoggedInUniqueIdentifier() {
230 return $this->getUniqueIdentifierFromUserObject($user);
236 public function permissionDenied() {
237 drupal_access_denied();
243 public function getUserRecordUrl($contactID) {
244 $uid = CRM_Core_BAO_UFMatch
::getUFId($contactID);
245 if (CRM_Core_Session
::singleton()
246 ->get('userID') == $contactID || CRM_Core_Permission
::checkAnyPerm(array(
247 'cms:administer users',
248 'cms:view user account',
251 return CRM_Utils_System
::url('user/' . $uid);
258 public function checkPermissionAddUser() {
259 return CRM_Core_Permission
::check('administer users');
265 public function logger($message) {
266 if (CRM_Core_Config
::singleton()->userFrameworkLogging
&& function_exists('watchdog')) {
267 watchdog('civicrm', '%message', array('%message' => $message), NULL, WATCHDOG_DEBUG
);
274 public function clearResourceCache() {
275 _drupal_flush_css_js();
279 * Append Drupal js to coreResourcesList.
283 public function appendCoreResources(&$list) {
284 $list[] = 'js/crm.drupal.js';
290 public function flush() {
291 drupal_flush_all_caches();
297 public function getModules() {
299 $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
300 foreach ($q as $row) {
301 $result[] = new CRM_Core_Module('drupal.' . $row->name
, ($row->status
== 1) ?
TRUE : FALSE);
307 * Find any users/roles/security-principals with the given permission
308 * and replace it with one or more permissions.
310 * @param string $oldPerm
311 * @param array $newPerms
316 public function replacePermission($oldPerm, $newPerms) {
317 $roles = user_roles(FALSE, $oldPerm);
318 if (!empty($roles)) {
319 foreach (array_keys($roles) as $rid) {
320 user_role_revoke_permissions($rid, array($oldPerm));
321 user_role_grant_permissions($rid, $newPerms);
329 public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
334 //CRM-7803 -from d7 onward.
335 $config = CRM_Core_Config
::singleton();
336 if (function_exists('variable_get') &&
337 module_exists('locale') &&
338 function_exists('language_negotiation_get')
342 //does user configuration allow language
343 //support from the URL (Path prefix or domain)
344 if (language_negotiation_get('language') == 'locale-url') {
345 $urlType = variable_get('locale_language_negotiation_url_part');
348 if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX
) {
349 if (isset($language->prefix
) && $language->prefix
) {
350 if ($addLanguagePart) {
351 $url .= $language->prefix
. '/';
353 if ($removeLanguagePart) {
354 $url = str_replace("/{$language->prefix}/", '/', $url);
359 if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN
) {
360 if (isset($language->domain
) && $language->domain
) {
361 if ($addLanguagePart) {
362 $url = (CRM_Utils_System
::isSSL() ?
'https' : 'http') . '://' . $language->domain
. base_path();
364 if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
365 $url = str_replace('\\', '/', $url);
366 $parseUrl = parse_url($url);
368 //kinda hackish but not sure how to do it right
369 //hope http_build_url() will help at some point.
370 if (is_array($parseUrl) && !empty($parseUrl)) {
371 $urlParts = explode('/', $url);
372 $hostKey = array_search($parseUrl['host'], $urlParts);
373 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL
);
374 $urlParts[$hostKey] = $ufUrlParts['host'];
375 $url = implode('/', $urlParts);
388 public function getVersion() {
389 return defined('VERSION') ? VERSION
: 'Unknown';
395 public function updateCategories() {
396 // copied this from profile.module. Seems a bit inefficient, but i don't know a better way
404 public function getUFLocale() {
405 // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
406 // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
407 // sometimes for CLI based on order called, this might not be set and/or empty
410 if (empty($language)) {
414 if ($language->language
== 'zh-hans') {
418 if ($language->language
== 'zh-hant') {
422 if (preg_match('/^.._..$/', $language->language
)) {
423 return $language->language
;
426 return CRM_Core_I18n_PseudoConstant
::longForShort(substr($language->language
, 0, 2));
432 public function setUFLocale($civicrm_language) {
435 $langcode = substr($civicrm_language, 0, 2);
436 $languages = language_list();
438 if (isset($languages[$langcode])) {
439 $language = $languages[$langcode];
441 // Config must be re-initialized to reset the base URL
442 // otherwise links will have the wrong language prefix/domain.
443 $config = CRM_Core_Config
::singleton();
453 * Perform any post login activities required by the UF -
454 * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
455 * calls hook_user op 'login' and generates a new session.
457 * @param array $params
459 * FIXME: Document values accepted/required by $params
461 public function userLoginFinalize($params = array()) {
462 user_login_finalize($params);
468 public function getLoginDestination(&$form) {
471 $id = $form->get('id');
476 $gid = $form->get('gid');
478 $args .= "&gid=$gid";
481 // Setup Personal Campaign Page link uses pageId
482 $pageId = $form->get('pageId');
484 $component = $form->get('component');
485 $args .= "&pageId=$pageId&component=$component&action=add";
492 // append destination so user is returned to form they came from after login
493 $destination = CRM_Utils_System
::currentPath() . '?reset=1' . $args;
499 * Fixme: Why are we overriding the parent function? Seems inconsistent.
500 * This version supplies slightly different params to $this->url (not absolute and html encoded) but why?
502 * @param string $action
506 public function postURL($action) {
507 if (!empty($action)) {
510 return $this->url($_GET['q']);
514 * Get an array of user details for a contact, containing at minimum the user ID & name.
516 * @param int $contactID
519 * CMS user details including
521 * - name (ie the system user name.
523 public function getUser($contactID) {
524 $userDetails = parent
::getUser($contactID);
525 $user = $this->getUserObject($userDetails['id']);
526 $userDetails['name'] = $user->name
;
527 $userDetails['email'] = $user->mail
;
532 * Load the user object.
534 * Note this function still works in drupal 6, 7 & 8 but is deprecated in Drupal 8.
540 public function getUserObject($userID) {
541 return user_load($userID);
544 public function parseDrupalSiteName($civicrm_root) {
546 if (strpos($civicrm_root,
547 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
. 'all' . DIRECTORY_SEPARATOR
. 'modules'
550 $startPos = strpos($civicrm_root,
551 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
553 $endPos = strpos($civicrm_root,
554 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
556 if ($startPos && $endPos) {
557 // if component is in sites/SITENAME/modules
558 $siteName = substr($civicrm_root,
560 $endPos - $startPos - 7