CRM/Utils/System/DrupalBase.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Drupal specific stuff goes here
  38  */
  39 abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base {
  40
  41   /**
  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
  44    * @var bool
  45    */
  46   var $supports_UF_Logging = TRUE;
  47
  48   /**
  49    */
  50   public function __construct() {
  51     /**
  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
  54      * @deprecated
  55      * @var bool
  56      */
  57     $this->is_drupal = TRUE;
  58     $this->supports_form_extensions = TRUE;
  59   }
  60
  61   /**
  62    * @inheritDoc
  63    */
  64   public function getDefaultSiteSettings($dir) {
  65     $config = CRM_Core_Config::singleton();
  66     $siteName = $siteRoot = NULL;
  67     $matches = array();
  68     if (preg_match(
  69       '|/sites/([\w\.\-\_]+)/|',
  70       $config->templateCompileDir,
  71       $matches
  72     )) {
  73       $siteName = $matches[1];
  74       if ($siteName) {
  75         $siteName = "/sites/$siteName/";
  76         $siteNamePos = strpos($dir, $siteName);
  77         if ($siteNamePos !== FALSE) {
  78           $siteRoot = substr($dir, 0, $siteNamePos);
  79         }
  80       }
  81     }
  82     $url = $config->userFrameworkBaseURL;
  83     return array($url, $siteName, $siteRoot);
  84   }
  85
  86   /**
  87    * Check if a resource url is within the drupal directory and format appropriately.
  88    *
  89    * @param $url (reference)
  90    *
  91    * @return bool
  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
  94    */
  95   public function formatResourceUrl(&$url) {
  96     $internal = FALSE;
  97     $base = CRM_Core_Config::singleton()->resourceBase;
  98     global $base_url;
  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) {
 103       $internal = TRUE;
 104       $url = trim(str_replace($base_url, '', $url), '/');
 105     }
 106     // Handle relative urls that are within the CiviCRM module directory
 107     elseif (strpos($url, $base) === 0) {
 108       $internal = TRUE;
 109       $url = $this->appendCoreDirectoryToResourceBase(substr(drupal_get_path('module', 'civicrm'), 0, -6)) . trim(substr($url, strlen($base)), '/');
 110     }
 111     // Strip query string
 112     $q = strpos($url, '?');
 113     if ($q && $internal) {
 114       $url = substr($url, 0, $q);
 115     }
 116     return $internal;
 117   }
 118
 119   /**
 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.
 125    *
 126    * @param string $url
 127    *   Potential resource url based on standard folder assumptions.
 128    * @return string
 129    *   with civicrm-core directory appended if not standard civi dir
 130    */
 131   public function appendCoreDirectoryToResourceBase($url) {
 132     global $civicrm_root;
 133     $lastDirectory = basename($civicrm_root);
 134     if ($lastDirectory != 'civicrm') {
 135       return $url .= $lastDirectory . '/';
 136     }
 137     return $url;
 138   }
 139
 140   /**
 141    * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
 142    *
 143    * @inheritDoc
 144    */
 145   public function url(
 146     $path = NULL,
 147     $query = NULL,
 148     $absolute = FALSE,
 149     $fragment = NULL,
 150     $htmlize = TRUE,
 151     $frontend = FALSE,
 152     $forceBackend = FALSE
 153   ) {
 154     $config = CRM_Core_Config::singleton();
 155     $script = 'index.php';
 156
 157     $path = CRM_Utils_String::stripPathChars($path);
 158
 159     if (isset($fragment)) {
 160       $fragment = '#' . $fragment;
 161     }
 162
 163     if (!isset($config->useFrameworkRelativeBase)) {
 164       $base = parse_url($config->userFrameworkBaseURL);
 165       $config->useFrameworkRelativeBase = $base['path'];
 166     }
 167     $base = $absolute ? $config->userFrameworkBaseURL : $config->useFrameworkRelativeBase;
 168
 169     $separator = $htmlize ? '&amp;' : '&';
 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(array(
 252           'cms:administer users',
 253           'cms:view user account',
 254         ))
 255     ) {
 256       return CRM_Utils_System::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', array('%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    * Append Drupal js to coreResourcesList.
 285    */
 286   public function appendCoreResources(&$list) {
 287     $list[] = 'js/crm.drupal.js';
 288   }
 289
 290   /**
 291    * @inheritDoc
 292    */
 293   public function flush() {
 294     drupal_flush_all_caches();
 295   }
 296
 297   /**
 298    * @inheritDoc
 299    */
 300   public function getModules() {
 301     $result = array();
 302     $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
 303     foreach ($q as $row) {
 304       $result[] = new CRM_Core_Module('drupal.' . $row->name, ($row->status == 1) ? TRUE : FALSE);
 305     }
 306     return $result;
 307   }
 308
 309   /**
 310    * Find any users/roles/security-principals with the given permission
 311    * and replace it with one or more permissions.
 312    *
 313    * @param string $oldPerm
 314    * @param array $newPerms
 315    *   Array, strings.
 316    *
 317    * @return void
 318    */
 319   public function replacePermission($oldPerm, $newPerms) {
 320     $roles = user_roles(FALSE, $oldPerm);
 321     if (!empty($roles)) {
 322       foreach (array_keys($roles) as $rid) {
 323         user_role_revoke_permissions($rid, array($oldPerm));
 324         user_role_grant_permissions($rid, $newPerms);
 325       }
 326     }
 327   }
 328
 329   /**
 330    * @inheritDoc
 331    */
 332   public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
 333     if (empty($url)) {
 334       return $url;
 335     }
 336
 337     //CRM-7803 -from d7 onward.
 338     $config = CRM_Core_Config::singleton();
 339     if (function_exists('variable_get') &&
 340       module_exists('locale') &&
 341       function_exists('language_negotiation_get')
 342     ) {
 343       global $language;
 344
 345       //does user configuration allow language
 346       //support from the URL (Path prefix or domain)
 347       if (language_negotiation_get('language') == 'locale-url') {
 348         $urlType = variable_get('locale_language_negotiation_url_part');
 349
 350         //url prefix
 351         if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) {
 352           if (isset($language->prefix) && $language->prefix) {
 353             if ($addLanguagePart) {
 354               $url .= $language->prefix . '/';
 355             }
 356             if ($removeLanguagePart) {
 357               $url = str_replace("/{$language->prefix}/", '/', $url);
 358             }
 359           }
 360         }
 361         //domain
 362         if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN) {
 363           if (isset($language->domain) && $language->domain) {
 364             if ($addLanguagePart) {
 365               $url = (CRM_Utils_System::isSSL() ? 'https' : 'http') . '://' . $language->domain . base_path();
 366             }
 367             if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
 368               $url = str_replace('\\', '/', $url);
 369               $parseUrl = parse_url($url);
 370
 371               //kinda hackish but not sure how to do it right
 372               //hope http_build_url() will help at some point.
 373               if (is_array($parseUrl) && !empty($parseUrl)) {
 374                 $urlParts = explode('/', $url);
 375                 $hostKey = array_search($parseUrl['host'], $urlParts);
 376                 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL);
 377                 $urlParts[$hostKey] = $ufUrlParts['host'];
 378                 $url = implode('/', $urlParts);
 379               }
 380             }
 381           }
 382         }
 383       }
 384     }
 385     return $url;
 386   }
 387
 388   /**
 389    * @inheritDoc
 390    */
 391   public function getVersion() {
 392     return defined('VERSION') ? VERSION : 'Unknown';
 393   }
 394
 395   /**
 396    * @inheritDoc
 397    */
 398   public function updateCategories() {
 399     // copied this from profile.module. Seems a bit inefficient, but i don't know a better way
 400     cache_clear_all();
 401     menu_rebuild();
 402   }
 403
 404   /**
 405    * @inheritDoc
 406    */
 407   public function getUFLocale() {
 408     // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
 409     // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
 410     // sometimes for CLI based on order called, this might not be set and/or empty
 411     global $language;
 412
 413     if (empty($language)) {
 414       return NULL;
 415     }
 416
 417     if ($language->language == 'zh-hans') {
 418       return 'zh_CN';
 419     }
 420
 421     if ($language->language == 'zh-hant') {
 422       return 'zh_TW';
 423     }
 424
 425     if (preg_match('/^.._..$/', $language->language)) {
 426       return $language->language;
 427     }
 428
 429     return CRM_Core_I18n_PseudoConstant::longForShort(substr($language->language, 0, 2));
 430   }
 431
 432   /**
 433    * Perform any post login activities required by the UF -
 434    * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
 435    * calls hook_user op 'login' and generates a new session.
 436    *
 437    * @param array $params
 438    *
 439    * FIXME: Document values accepted/required by $params
 440    */
 441   public function userLoginFinalize($params = array()) {
 442     user_login_finalize($params);
 443   }
 444
 445   /**
 446    * @inheritDoc
 447    */
 448   public function getLoginDestination(&$form) {
 449     $args = NULL;
 450
 451     $id = $form->get('id');
 452     if ($id) {
 453       $args .= "&id=$id";
 454     }
 455     else {
 456       $gid = $form->get('gid');
 457       if ($gid) {
 458         $args .= "&gid=$gid";
 459       }
 460       else {
 461         // Setup Personal Campaign Page link uses pageId
 462         $pageId = $form->get('pageId');
 463         if ($pageId) {
 464           $component = $form->get('component');
 465           $args .= "&pageId=$pageId&component=$component&action=add";
 466         }
 467       }
 468     }
 469
 470     $destination = NULL;
 471     if ($args) {
 472       // append destination so user is returned to form they came from after login
 473       $destination = CRM_Utils_System::currentPath() . '?reset=1' . $args;
 474     }
 475     return $destination;
 476   }
 477
 478   /**
 479    * Fixme: Why are we overriding the parent function? Seems inconsistent.
 480    * This version supplies slightly different params to $this->url (not absolute and html encoded) but why?
 481    */
 482   public function postURL($action) {
 483     if (!empty($action)) {
 484       return $action;
 485     }
 486     return $this->url($_GET['q']);
 487   }
 488
 489   /**
 490    * Get an array of user details for a contact, containing at minimum the user ID & name.
 491    *
 492    * @param int $contactID
 493    *
 494    * @return array
 495    *   CMS user details including
 496    *   - id
 497    *   - name (ie the system user name.
 498    */
 499   public function getUser($contactID) {
 500     $userDetails = parent::getUser($contactID);
 501     $user = $this->getUserObject($userDetails['id']);
 502     $userDetails['name'] = $user->name;
 503     $userDetails['email'] = $user->mail;
 504     return $userDetails;
 505   }
 506
 507   /**
 508    * Load the user object.
 509    *
 510    * Note this function still works in drupal 6, 7 & 8 but is deprecated in Drupal 8.
 511    *
 512    * @param $userID
 513    *
 514    * @return object
 515    */
 516   public function getUserObject($userID) {
 517     return user_load($userID);
 518   }
 519
 520 }