CRM/Utils/System/DrupalBase.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Drupal specific stuff goes here
  20  */
  21 abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base {
  22
  23   /**
  24    * Does this CMS / UF support a CMS specific logging mechanism?
  25    * @var bool
  26    * @todo - we should think about offering up logging mechanisms in a way that is also extensible by extensions
  27    */
  28   public $supports_UF_Logging = TRUE;
  29
  30   /**
  31    */
  32   public function __construct() {
  33     /**
  34      * 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
  35      * functions and leave the codebase oblivious to the type of CMS
  36      * @deprecated
  37      * @var bool
  38      */
  39     $this->is_drupal = TRUE;
  40     $this->supports_form_extensions = TRUE;
  41   }
  42
  43   /**
  44    * @inheritdoc
  45    */
  46   public function getDefaultFileStorage() {
  47     $config = CRM_Core_Config::singleton();
  48     $baseURL = CRM_Utils_System::languageNegotiationURL($config->userFrameworkBaseURL, FALSE, TRUE);
  49
  50     $siteName = $this->parseDrupalSiteNameFromRequest('/files/civicrm');
  51     if ($siteName) {
  52       $filesURL = $baseURL . "sites/$siteName/files/civicrm/";
  53     }
  54     else {
  55       $filesURL = $baseURL . "sites/default/files/civicrm/";
  56     }
  57
  58     return [
  59       'url' => $filesURL,
  60       'path' => CRM_Utils_File::baseFilePath(),
  61     ];
  62   }
  63
  64   /**
  65    * @inheritDoc
  66    */
  67   public function getDefaultSiteSettings($dir) {
  68     $config = CRM_Core_Config::singleton();
  69     $siteName = $siteRoot = NULL;
  70     $matches = [];
  71     if (preg_match(
  72       '|/sites/([\w\.\-\_]+)/|',
  73       $config->templateCompileDir,
  74       $matches
  75     )) {
  76       $siteName = $matches[1];
  77       if ($siteName) {
  78         $siteName = "/sites/$siteName/";
  79         $siteNamePos = strpos($dir, $siteName);
  80         if ($siteNamePos !== FALSE) {
  81           $siteRoot = substr($dir, 0, $siteNamePos);
  82         }
  83       }
  84     }
  85     $url = $config->userFrameworkBaseURL;
  86     return [$url, $siteName, $siteRoot];
  87   }
  88
  89   /**
  90    * Check if a resource url is within the drupal directory and format appropriately.
  91    *
  92    * @param $url (reference)
  93    *
  94    * @return bool
  95    *   TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more
  96    *   efficiently if it is known to be in the drupal site
  97    */
  98   public function formatResourceUrl(&$url) {
  99     $internal = FALSE;
 100     $base = CRM_Core_Config::singleton()->resourceBase;
 101     global $base_url;
 102     // Strip query string
 103     $q = strpos($url, '?');
 104     $url_path = $q ? substr($url, 0, $q) : $url;
 105     // Handle absolute urls
 106     // 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)
 107     // to see if the url is within our drupal dir, if it is we are able to treated it as an internal url
 108     if (strpos($url_path, $base_url) === 0) {
 109       $file = trim(str_replace($base_url, '', $url_path), '/');
 110       // CRM-18130: Custom CSS URL not working if aliased or rewritten
 111       if (file_exists(DRUPAL_ROOT . '/' . $file)) {
 112         $url = $file;
 113         $internal = TRUE;
 114       }
 115     }
 116     // Handle relative urls that are within the CiviCRM module directory
 117     elseif (strpos($url_path, $base) === 0) {
 118       $internal = TRUE;
 119       $url = $this->appendCoreDirectoryToResourceBase(dirname(drupal_get_path('module', 'civicrm')) . '/') . trim(substr($url_path, strlen($base)), '/');
 120     }
 121     return $internal;
 122   }
 123
 124   /**
 125    * In instance where civicrm folder has a drupal folder & a civicrm core folder @ the same level append the
 126    * civicrm folder name to the url
 127    * See CRM-13737 for discussion of how this allows implementers to alter the folder structure
 128    * @todo - this only provides a limited amount of flexiblity - it still expects a 'civicrm' folder with a 'drupal' folder
 129    * and is only flexible as to the name of the civicrm folder.
 130    *
 131    * @param string $url
 132    *   Potential resource url based on standard folder assumptions.
 133    * @return string
 134    *   with civicrm-core directory appended if not standard civi dir
 135    */
 136   public function appendCoreDirectoryToResourceBase($url) {
 137     global $civicrm_root;
 138     $lastDirectory = basename($civicrm_root);
 139     if ($lastDirectory != 'civicrm') {
 140       return $url .= $lastDirectory . '/';
 141     }
 142     return $url;
 143   }
 144
 145   /**
 146    * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
 147    *
 148    * @inheritDoc
 149    */
 150   public function url(
 151     $path = NULL,
 152     $query = NULL,
 153     $absolute = FALSE,
 154     $fragment = NULL,
 155     $frontend = FALSE,
 156     $forceBackend = FALSE
 157   ) {
 158     $config = CRM_Core_Config::singleton();
 159     $script = 'index.php';
 160
 161     $path = CRM_Utils_String::stripPathChars($path);
 162
 163     if (isset($fragment)) {
 164       $fragment = '#' . $fragment;
 165     }
 166
 167     $base = $absolute ? $config->userFrameworkBaseURL : $config->useFrameworkRelativeBase;
 168
 169     $separator = '&';
 170
 171     if (!$config->cleanURL) {
 172       if (isset($path)) {
 173         if (isset($query)) {
 174           return $base . $script . '?q=' . $path . $separator . $query . $fragment;
 175         }
 176         else {
 177           return $base . $script . '?q=' . $path . $fragment;
 178         }
 179       }
 180       else {
 181         if (isset($query)) {
 182           return $base . $script . '?' . $query . $fragment;
 183         }
 184         else {
 185           return $base . $fragment;
 186         }
 187       }
 188     }
 189     else {
 190       if (isset($path)) {
 191         if (isset($query)) {
 192           return $base . $path . '?' . $query . $fragment;
 193         }
 194         else {
 195           return $base . $path . $fragment;
 196         }
 197       }
 198       else {
 199         if (isset($query)) {
 200           return $base . $script . '?' . $query . $fragment;
 201         }
 202         else {
 203           return $base . $fragment;
 204         }
 205       }
 206     }
 207   }
 208
 209   /**
 210    * @inheritDoc
 211    */
 212   public function getUserIDFromUserObject($user) {
 213     return !empty($user->uid) ? $user->uid : NULL;
 214   }
 215
 216   /**
 217    * @inheritDoc
 218    */
 219   public function setMessage($message) {
 220     drupal_set_message($message);
 221   }
 222
 223   /**
 224    * @inheritDoc
 225    */
 226   public function getUniqueIdentifierFromUserObject($user) {
 227     return empty($user->mail) ? NULL : $user->mail;
 228   }
 229
 230   /**
 231    * @inheritDoc
 232    */
 233   public function getLoggedInUniqueIdentifier() {
 234     global $user;
 235     return $this->getUniqueIdentifierFromUserObject($user);
 236   }
 237
 238   /**
 239    * @inheritDoc
 240    */
 241   public function permissionDenied() {
 242     drupal_access_denied();
 243   }
 244
 245   /**
 246    * @inheritDoc
 247    */
 248   public function getUserRecordUrl($contactID) {
 249     $uid = CRM_Core_BAO_UFMatch::getUFId($contactID);
 250     if (CRM_Core_Session::singleton()
 251       ->get('userID') == $contactID || CRM_Core_Permission::checkAnyPerm([
 252         'cms:administer users',
 253         'cms:view user account',
 254       ])
 255     ) {
 256       return $this->url('user/' . $uid);
 257     };
 258   }
 259
 260   /**
 261    * @inheritDoc
 262    */
 263   public function checkPermissionAddUser() {
 264     return CRM_Core_Permission::check('administer users');
 265   }
 266
 267   /**
 268    * @inheritDoc
 269    */
 270   public function logger($message) {
 271     if (CRM_Core_Config::singleton()->userFrameworkLogging && function_exists('watchdog')) {
 272       watchdog('civicrm', '%message', ['%message' => $message], NULL, WATCHDOG_DEBUG);
 273     }
 274   }
 275
 276   /**
 277    * @inheritDoc
 278    */
 279   public function clearResourceCache() {
 280     _drupal_flush_css_js();
 281   }
 282
 283   /**
 284    * @inheritDoc
 285    */
 286   public function flush() {
 287     drupal_flush_all_caches();
 288   }
 289
 290   /**
 291    * @inheritDoc
 292    */
 293   public function getModules() {
 294     $result = [];
 295     $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
 296     foreach ($q as $row) {
 297       $result[] = new CRM_Core_Module('drupal.' . $row->name, $row->status == 1);
 298     }
 299     return $result;
 300   }
 301
 302   /**
 303    * Find any users/roles/security-principals with the given permission
 304    * and replace it with one or more permissions.
 305    *
 306    * @param string $oldPerm
 307    * @param array $newPerms
 308    *   Array, strings.
 309    *
 310    * @return void
 311    */
 312   public function replacePermission($oldPerm, $newPerms) {
 313     $roles = user_roles(FALSE, $oldPerm);
 314     if (!empty($roles)) {
 315       foreach (array_keys($roles) as $rid) {
 316         user_role_revoke_permissions($rid, [$oldPerm]);
 317         user_role_grant_permissions($rid, $newPerms);
 318       }
 319     }
 320   }
 321
 322   /**
 323    * @inheritDoc
 324    */
 325   public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
 326     if (empty($url)) {
 327       return $url;
 328     }
 329
 330     //CRM-7803 -from d7 onward.
 331     $config = CRM_Core_Config::singleton();
 332     if (function_exists('variable_get') &&
 333       module_exists('locale') &&
 334       function_exists('language_negotiation_get')
 335     ) {
 336       global $language;
 337
 338       //does user configuration allow language
 339       //support from the URL (Path prefix or domain)
 340       if (language_negotiation_get('language') == 'locale-url') {
 341         $urlType = variable_get('locale_language_negotiation_url_part');
 342
 343         //url prefix
 344         if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) {
 345           if (isset($language->prefix) && $language->prefix) {
 346             if ($addLanguagePart) {
 347               $url .= $language->prefix . '/';
 348             }
 349             if ($removeLanguagePart) {
 350               $url = str_replace("/{$language->prefix}/", '/', $url);
 351             }
 352           }
 353         }
 354         //domain
 355         if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN) {
 356           if (isset($language->domain) && $language->domain) {
 357             if ($addLanguagePart) {
 358               $url = (CRM_Utils_System::isSSL() ? 'https' : 'http') . '://' . $language->domain . base_path();
 359             }
 360             if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
 361               $url = str_replace('\\', '/', $url);
 362               $parseUrl = parse_url($url);
 363
 364               //kinda hackish but not sure how to do it right
 365               //hope http_build_url() will help at some point.
 366               if (is_array($parseUrl) && !empty($parseUrl)) {
 367                 $urlParts = explode('/', $url);
 368                 $hostKey = array_search($parseUrl['host'], $urlParts);
 369                 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL);
 370                 $urlParts[$hostKey] = $ufUrlParts['host'];
 371                 $url = implode('/', $urlParts);
 372               }
 373             }
 374           }
 375         }
 376       }
 377     }
 378     return $url;
 379   }
 380
 381   /**
 382    * @inheritDoc
 383    */
 384   public function getVersion() {
 385     return defined('VERSION') ? VERSION : 'Unknown';
 386   }
 387
 388   /**
 389    * @inheritDoc
 390    */
 391   public function isUserRegistrationPermitted() {
 392     if (!variable_get('user_register', TRUE)) {
 393       return FALSE;
 394     }
 395     return TRUE;
 396   }
 397
 398   /**
 399    * @inheritDoc
 400    */
 401   public function isPasswordUserGenerated() {
 402     if (variable_get('user_email_verification', TRUE)) {
 403       return FALSE;
 404     }
 405     return TRUE;
 406   }
 407
 408   /**
 409    * @inheritDoc
 410    */
 411   public function updateCategories() {
 412     // copied this from profile.module. Seems a bit inefficient, but i don't know a better way
 413     cache_clear_all();
 414     menu_rebuild();
 415   }
 416
 417   /**
 418    * @inheritDoc
 419    */
 420   public function getUFLocale() {
 421     // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
 422     // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
 423     // sometimes for CLI based on order called, this might not be set and/or empty
 424     $language = $this->getCurrentLanguage();
 425
 426     if (empty($language)) {
 427       return NULL;
 428     }
 429
 430     if ($language == 'zh-hans') {
 431       return 'zh_CN';
 432     }
 433
 434     if ($language == 'zh-hant') {
 435       return 'zh_TW';
 436     }
 437
 438     if (preg_match('/^.._..$/', $language)) {
 439       return $language;
 440     }
 441
 442     return CRM_Core_I18n_PseudoConstant::longForShort(substr($language, 0, 2));
 443   }
 444
 445   /**
 446    * @inheritDoc
 447    */
 448   public function setUFLocale($civicrm_language) {
 449     global $language;
 450
 451     $langcode = substr($civicrm_language, 0, 2);
 452     $languages = language_list();
 453
 454     if (isset($languages[$langcode])) {
 455       $language = $languages[$langcode];
 456
 457       // Config must be re-initialized to reset the base URL
 458       // otherwise links will have the wrong language prefix/domain.
 459       $config = CRM_Core_Config::singleton();
 460       $config->free();
 461
 462       return TRUE;
 463     }
 464
 465     return FALSE;
 466   }
 467
 468   /**
 469    * Perform any post login activities required by the UF -
 470    * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
 471    * calls hook_user op 'login' and generates a new session.
 472    *
 473    * @param array $params
 474    *
 475    * FIXME: Document values accepted/required by $params
 476    */
 477   public function userLoginFinalize($params = []) {
 478     user_login_finalize($params);
 479   }
 480
 481   /**
 482    * @inheritDoc
 483    */
 484   public function getLoginDestination(&$form) {
 485     $args = NULL;
 486
 487     $id = $form->get('id');
 488     if ($id) {
 489       $args .= "&id=$id";
 490     }
 491     else {
 492       $gid = $form->get('gid');
 493       if ($gid) {
 494         $args .= "&gid=$gid";
 495       }
 496       else {
 497         // Setup Personal Campaign Page link uses pageId
 498         $pageId = $form->get('pageId');
 499         if ($pageId) {
 500           $component = $form->get('component');
 501           $args .= "&pageId=$pageId&component=$component&action=add";
 502         }
 503       }
 504     }
 505
 506     $destination = NULL;
 507     if ($args) {
 508       // append destination so user is returned to form they came from after login
 509       $destination = CRM_Utils_System::currentPath() . '?reset=1' . $args;
 510     }
 511     return $destination;
 512   }
 513
 514   /**
 515    * Fixme: Why are we overriding the parent function? Seems inconsistent.
 516    * This version supplies slightly different params to $this->url (not absolute and html encoded) but why?
 517    *
 518    * @param string $action
 519    *
 520    * @return string
 521    */
 522   public function postURL($action) {
 523     if (!empty($action)) {
 524       return $action;
 525     }
 526     return $this->url($_GET['q']);
 527   }
 528
 529   /**
 530    * Get an array of user details for a contact, containing at minimum the user ID & name.
 531    *
 532    * @param int $contactID
 533    *
 534    * @return array
 535    *   CMS user details including
 536    *   - id
 537    *   - name (ie the system user name.
 538    */
 539   public function getUser($contactID) {
 540     $userDetails = parent::getUser($contactID);
 541     $user = $this->getUserObject($userDetails['id']);
 542     $userDetails['name'] = $user->name;
 543     $userDetails['email'] = $user->mail;
 544     return $userDetails;
 545   }
 546
 547   /**
 548    * Load the user object.
 549    *
 550    * Note this function still works in drupal 6, 7 & 8 but is deprecated in Drupal 8.
 551    *
 552    * @param $userID
 553    *
 554    * @return object
 555    */
 556   public function getUserObject($userID) {
 557     return user_load($userID);
 558   }
 559
 560   /**
 561    * Parse the name of the drupal site.
 562    *
 563    * @param string $civicrm_root
 564    *
 565    * @return null|string
 566    * @deprecated
 567    */
 568   public function parseDrupalSiteNameFromRoot($civicrm_root) {
 569     $siteName = NULL;
 570     if (strpos($civicrm_root,
 571         DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR . 'all' . DIRECTORY_SEPARATOR . 'modules'
 572       ) === FALSE
 573     ) {
 574       $startPos = strpos($civicrm_root,
 575         DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR
 576       );
 577       $endPos = strpos($civicrm_root,
 578         DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR
 579       );
 580       if ($startPos && $endPos) {
 581         // if component is in sites/SITENAME/modules
 582         $siteName = substr($civicrm_root,
 583           $startPos + 7,
 584           $endPos - $startPos - 7
 585         );
 586       }
 587     }
 588     return $siteName;
 589   }
 590
 591   /**
 592    * Determine if Drupal multi-site applies to the current request -- and,
 593    * specifically, determine the name of the multisite folder.
 594    *
 595    * @param string $flagFile
 596    *   Check if $flagFile exists inside the site dir.
 597    * @return null|string
 598    *   string, e.g. `bar.example.com` if using multisite.
 599    *   NULL if using the default site.
 600    */
 601   private function parseDrupalSiteNameFromRequest($flagFile = '') {
 602     $phpSelf = array_key_exists('PHP_SELF', $_SERVER) ? $_SERVER['PHP_SELF'] : '';
 603     $httpHost = array_key_exists('HTTP_HOST', $_SERVER) ? $_SERVER['HTTP_HOST'] : '';
 604     if (empty($httpHost)) {
 605       $httpHost = parse_url(CIVICRM_UF_BASEURL, PHP_URL_HOST);
 606       if (parse_url(CIVICRM_UF_BASEURL, PHP_URL_PORT)) {
 607         $httpHost .= ':' . parse_url(CIVICRM_UF_BASEURL, PHP_URL_PORT);
 608       }
 609     }
 610
 611     $confdir = $this->cmsRootPath() . '/sites';
 612
 613     if (file_exists($confdir . "/sites.php")) {
 614       include $confdir . "/sites.php";
 615     }
 616     else {
 617       $sites = [];
 618     }
 619
 620     $uri = explode('/', $phpSelf);
 621     $server = explode('.', implode('.', array_reverse(explode(':', rtrim($httpHost, '.')))));
 622     for ($i = count($uri) - 1; $i > 0; $i--) {
 623       for ($j = count($server); $j > 0; $j--) {
 624         $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
 625         if (file_exists("$confdir/$dir" . $flagFile)) {
 626           \Civi::$statics[__CLASS__]['drupalSiteName'] = $dir;
 627           return \Civi::$statics[__CLASS__]['drupalSiteName'];
 628         }
 629         // check for alias
 630         if (isset($sites[$dir]) && file_exists("$confdir/{$sites[$dir]}" . $flagFile)) {
 631           \Civi::$statics[__CLASS__]['drupalSiteName'] = $sites[$dir];
 632           return \Civi::$statics[__CLASS__]['drupalSiteName'];
 633         }
 634       }
 635     }
 636   }
 637
 638   /**
 639    * Function to return current language of Drupal
 640    *
 641    * @return string
 642    */
 643   public function getCurrentLanguage() {
 644     global $language;
 645     return (!empty($language->language)) ? $language->language : $language;
 646   }
 647
 648   /**
 649    * Is a front end page being accessed.
 650    *
 651    * Generally this would be a contribution form or other public page as opposed to a backoffice page (like contact edit).
 652    *
 653    * See https://github.com/civicrm/civicrm-drupal/pull/546/files
 654    *
 655    * @return bool
 656    */
 657   public function isFrontEndPage() {
 658     $path = CRM_Utils_System::currentPath();
 659
 660     // Get the menu for above URL.
 661     $item = CRM_Core_Menu::get($path);
 662     return !empty($item['is_public']);
 663   }
 664
 665   /**
 666    * Start a new session.
 667    */
 668   public function sessionStart() {
 669     if (function_exists('drupal_session_start')) {
 670       // https://issues.civicrm.org/jira/browse/CRM-14356
 671       if (!(isset($GLOBALS['lazy_session']) && $GLOBALS['lazy_session'] == TRUE)) {
 672         drupal_session_start();
 673       }
 674       $_SESSION = [];
 675     }
 676     else {
 677       session_start();
 678     }
 679   }
 680
 681   /**
 682    * Get role names
 683    *
 684    * @return array|null
 685    */
 686   public function getRoleNames() {
 687     return array_combine(user_roles(), user_roles());
 688   }
 689
 690   /**
 691    * Determine if the Views module exists.
 692    *
 693    * @return bool
 694    */
 695   public function viewsExists() {
 696     if (function_exists('module_exists') && module_exists('views')) {
 697       return TRUE;
 698     }
 699     return FALSE;
 700   }
 701
 702 }