CRM/Utils/System/DrupalBase.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   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     $base = $absolute ? $config->userFrameworkBaseURL : $config->useFrameworkRelativeBase;
 164
 165     $separator = $htmlize ? '&amp;' : '&';
 166
 167     if (!$config->cleanURL) {
 168       if (isset($path)) {
 169         if (isset($query)) {
 170           return $base . $script . '?q=' . $path . $separator . $query . $fragment;
 171         }
 172         else {
 173           return $base . $script . '?q=' . $path . $fragment;
 174         }
 175       }
 176       else {
 177         if (isset($query)) {
 178           return $base . $script . '?' . $query . $fragment;
 179         }
 180         else {
 181           return $base . $fragment;
 182         }
 183       }
 184     }
 185     else {
 186       if (isset($path)) {
 187         if (isset($query)) {
 188           return $base . $path . '?' . $query . $fragment;
 189         }
 190         else {
 191           return $base . $path . $fragment;
 192         }
 193       }
 194       else {
 195         if (isset($query)) {
 196           return $base . $script . '?' . $query . $fragment;
 197         }
 198         else {
 199           return $base . $fragment;
 200         }
 201       }
 202     }
 203   }
 204
 205   /**
 206    * @inheritDoc
 207    */
 208   public function getUserIDFromUserObject($user) {
 209     return !empty($user->uid) ? $user->uid : NULL;
 210   }
 211
 212   /**
 213    * @inheritDoc
 214    */
 215   public function setMessage($message) {
 216     drupal_set_message($message);
 217   }
 218
 219   /**
 220    * @inheritDoc
 221    */
 222   public function getUniqueIdentifierFromUserObject($user) {
 223     return empty($user->mail) ? NULL : $user->mail;
 224   }
 225
 226   /**
 227    * @inheritDoc
 228    */
 229   public function getLoggedInUniqueIdentifier() {
 230     global $user;
 231     return $this->getUniqueIdentifierFromUserObject($user);
 232   }
 233
 234   /**
 235    * @inheritDoc
 236    */
 237   public function permissionDenied() {
 238     drupal_access_denied();
 239   }
 240
 241   /**
 242    * @inheritDoc
 243    */
 244   public function getUserRecordUrl($contactID) {
 245     $uid = CRM_Core_BAO_UFMatch::getUFId($contactID);
 246     if (CRM_Core_Session::singleton()
 247         ->get('userID') == $contactID || CRM_Core_Permission::checkAnyPerm(array(
 248           'cms:administer users',
 249           'cms:view user account',
 250         ))
 251     ) {
 252       return CRM_Utils_System::url('user/' . $uid);
 253     };
 254   }
 255
 256   /**
 257    * @inheritDoc
 258    */
 259   public function checkPermissionAddUser() {
 260     return CRM_Core_Permission::check('administer users');
 261   }
 262
 263   /**
 264    * @inheritDoc
 265    */
 266   public function logger($message) {
 267     if (CRM_Core_Config::singleton()->userFrameworkLogging && function_exists('watchdog')) {
 268       watchdog('civicrm', '%message', array('%message' => $message), NULL, WATCHDOG_DEBUG);
 269     }
 270   }
 271
 272   /**
 273    * @inheritDoc
 274    */
 275   public function clearResourceCache() {
 276     _drupal_flush_css_js();
 277   }
 278
 279   /**
 280    * Append Drupal js to coreResourcesList.
 281    */
 282   public function appendCoreResources(&$list) {
 283     $list[] = 'js/crm.drupal.js';
 284   }
 285
 286   /**
 287    * @inheritDoc
 288    */
 289   public function flush() {
 290     drupal_flush_all_caches();
 291   }
 292
 293   /**
 294    * @inheritDoc
 295    */
 296   public function getModules() {
 297     $result = array();
 298     $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
 299     foreach ($q as $row) {
 300       $result[] = new CRM_Core_Module('drupal.' . $row->name, ($row->status == 1) ? TRUE : FALSE);
 301     }
 302     return $result;
 303   }
 304
 305   /**
 306    * Find any users/roles/security-principals with the given permission
 307    * and replace it with one or more permissions.
 308    *
 309    * @param string $oldPerm
 310    * @param array $newPerms
 311    *   Array, strings.
 312    *
 313    * @return void
 314    */
 315   public function replacePermission($oldPerm, $newPerms) {
 316     $roles = user_roles(FALSE, $oldPerm);
 317     if (!empty($roles)) {
 318       foreach (array_keys($roles) as $rid) {
 319         user_role_revoke_permissions($rid, array($oldPerm));
 320         user_role_grant_permissions($rid, $newPerms);
 321       }
 322     }
 323   }
 324
 325   /**
 326    * @inheritDoc
 327    */
 328   public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
 329     if (empty($url)) {
 330       return $url;
 331     }
 332
 333     //CRM-7803 -from d7 onward.
 334     $config = CRM_Core_Config::singleton();
 335     if (function_exists('variable_get') &&
 336       module_exists('locale') &&
 337       function_exists('language_negotiation_get')
 338     ) {
 339       global $language;
 340
 341       //does user configuration allow language
 342       //support from the URL (Path prefix or domain)
 343       if (language_negotiation_get('language') == 'locale-url') {
 344         $urlType = variable_get('locale_language_negotiation_url_part');
 345
 346         //url prefix
 347         if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) {
 348           if (isset($language->prefix) && $language->prefix) {
 349             if ($addLanguagePart) {
 350               $url .= $language->prefix . '/';
 351             }
 352             if ($removeLanguagePart) {
 353               $url = str_replace("/{$language->prefix}/", '/', $url);
 354             }
 355           }
 356         }
 357         //domain
 358         if ($urlType == LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN) {
 359           if (isset($language->domain) && $language->domain) {
 360             if ($addLanguagePart) {
 361               $url = (CRM_Utils_System::isSSL() ? 'https' : 'http') . '://' . $language->domain . base_path();
 362             }
 363             if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
 364               $url = str_replace('\\', '/', $url);
 365               $parseUrl = parse_url($url);
 366
 367               //kinda hackish but not sure how to do it right
 368               //hope http_build_url() will help at some point.
 369               if (is_array($parseUrl) && !empty($parseUrl)) {
 370                 $urlParts = explode('/', $url);
 371                 $hostKey = array_search($parseUrl['host'], $urlParts);
 372                 $ufUrlParts = parse_url(CIVICRM_UF_BASEURL);
 373                 $urlParts[$hostKey] = $ufUrlParts['host'];
 374                 $url = implode('/', $urlParts);
 375               }
 376             }
 377           }
 378         }
 379       }
 380     }
 381     return $url;
 382   }
 383
 384   /**
 385    * @inheritDoc
 386    */
 387   public function getVersion() {
 388     return defined('VERSION') ? VERSION : 'Unknown';
 389   }
 390
 391   /**
 392    * @inheritDoc
 393    */
 394   public function updateCategories() {
 395     // copied this from profile.module. Seems a bit inefficient, but i don't know a better way
 396     cache_clear_all();
 397     menu_rebuild();
 398   }
 399
 400   /**
 401    * @inheritDoc
 402    */
 403   public function getUFLocale() {
 404     // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
 405     // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
 406     // sometimes for CLI based on order called, this might not be set and/or empty
 407     global $language;
 408
 409     if (empty($language)) {
 410       return NULL;
 411     }
 412
 413     if ($language->language == 'zh-hans') {
 414       return 'zh_CN';
 415     }
 416
 417     if ($language->language == 'zh-hant') {
 418       return 'zh_TW';
 419     }
 420
 421     if (preg_match('/^.._..$/', $language->language)) {
 422       return $language->language;
 423     }
 424
 425     return CRM_Core_I18n_PseudoConstant::longForShort(substr($language->language, 0, 2));
 426   }
 427
 428   /**
 429    * @inheritDoc
 430    */
 431   public function setUFLocale($civicrm_language) {
 432     global $language;
 433
 434     $langcode = substr($civicrm_language, 0, 2);
 435     $languages = language_list();
 436
 437     if (isset($languages[$langcode])) {
 438       $language = $languages[$langcode];
 439
 440       // Config must be re-initialized to reset the base URL
 441       // otherwise links will have the wrong language prefix/domain.
 442       $config = CRM_Core_Config::singleton();
 443       $config->free();
 444
 445       return TRUE;
 446     }
 447
 448     return FALSE;
 449   }
 450
 451   /**
 452    * Perform any post login activities required by the UF -
 453    * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
 454    * calls hook_user op 'login' and generates a new session.
 455    *
 456    * @param array $params
 457    *
 458    * FIXME: Document values accepted/required by $params
 459    */
 460   public function userLoginFinalize($params = array()) {
 461     user_login_finalize($params);
 462   }
 463
 464   /**
 465    * @inheritDoc
 466    */
 467   public function getLoginDestination(&$form) {
 468     $args = NULL;
 469
 470     $id = $form->get('id');
 471     if ($id) {
 472       $args .= "&id=$id";
 473     }
 474     else {
 475       $gid = $form->get('gid');
 476       if ($gid) {
 477         $args .= "&gid=$gid";
 478       }
 479       else {
 480         // Setup Personal Campaign Page link uses pageId
 481         $pageId = $form->get('pageId');
 482         if ($pageId) {
 483           $component = $form->get('component');
 484           $args .= "&pageId=$pageId&component=$component&action=add";
 485         }
 486       }
 487     }
 488
 489     $destination = NULL;
 490     if ($args) {
 491       // append destination so user is returned to form they came from after login
 492       $destination = CRM_Utils_System::currentPath() . '?reset=1' . $args;
 493     }
 494     return $destination;
 495   }
 496
 497   /**
 498    * Fixme: Why are we overriding the parent function? Seems inconsistent.
 499    * This version supplies slightly different params to $this->url (not absolute and html encoded) but why?
 500    */
 501   public function postURL($action) {
 502     if (!empty($action)) {
 503       return $action;
 504     }
 505     return $this->url($_GET['q']);
 506   }
 507
 508   /**
 509    * Get an array of user details for a contact, containing at minimum the user ID & name.
 510    *
 511    * @param int $contactID
 512    *
 513    * @return array
 514    *   CMS user details including
 515    *   - id
 516    *   - name (ie the system user name.
 517    */
 518   public function getUser($contactID) {
 519     $userDetails = parent::getUser($contactID);
 520     $user = $this->getUserObject($userDetails['id']);
 521     $userDetails['name'] = $user->name;
 522     $userDetails['email'] = $user->mail;
 523     return $userDetails;
 524   }
 525
 526   /**
 527    * Load the user object.
 528    *
 529    * Note this function still works in drupal 6, 7 & 8 but is deprecated in Drupal 8.
 530    *
 531    * @param $userID
 532    *
 533    * @return object
 534    */
 535   public function getUserObject($userID) {
 536     return user_load($userID);
 537   }
 538
 539   public function parseDrupalSiteName($civicrm_root) {
 540     $siteName = NULL;
 541     if (strpos($civicrm_root,
 542         DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR . 'all' . DIRECTORY_SEPARATOR . 'modules'
 543       ) === FALSE
 544     ) {
 545       $startPos = strpos($civicrm_root,
 546         DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR
 547       );
 548       $endPos = strpos($civicrm_root,
 549         DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR
 550       );
 551       if ($startPos && $endPos) {
 552         // if component is in sites/SITENAME/modules
 553         $siteName = substr($civicrm_root,
 554           $startPos + 7,
 555           $endPos - $startPos - 7
 556         );
 557       }
 558     }
 559     return $siteName;
 560   }
 561
 562 }