CRM/Utils/System/Drupal6.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Drupal specific stuff goes here
  38  */
  39 class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase {
  40
  41   /**
  42    * if we are using a theming system, invoke theme, else just print the
  43    * content
  44    *
  45    * @param string  $content the content that will be themed
  46    * @param boolean $print   are we displaying to the screen or bypassing theming?
  47    * @param boolean $maintenance  for maintenance mode
  48    *
  49    * @return void           prints content on stdout
  50    * @access public
  51    */
  52   function theme(&$content, $print = FALSE, $maintenance = FALSE) {
  53     // TODO: Simplify; this was copied verbatim from CiviCRM 3.4's multi-UF theming function, but that's more complex than necessary
  54     if (function_exists('theme') && !$print) {
  55       if ($maintenance) {
  56         drupal_set_breadcrumb('');
  57         drupal_maintenance_theme();
  58       }
  59
  60       // Arg 3 for D6 theme() is "show_blocks". Previously, we passed
  61       // through a badly named variable ("$args") which was almost always
  62       // TRUE (except on fatal error screen).  However, this feature is
  63       // non-functional on D6 default themes, was purposefully removed from
  64       // D7, has no analog in other our other CMS's, and clutters the code.
  65       // Hard-wiring to TRUE should be OK.
  66       $out = theme('page', $content, TRUE);
  67     }
  68     else {
  69       $out = $content;
  70     }
  71
  72     print $out;
  73   }
  74
  75   /**
  76    * Function to create a user in Drupal.
  77    *
  78    * @param array  $params associated array
  79    * @param string $mail email id for cms user
  80    *
  81    * @return uid if user exists, false otherwise
  82    *
  83    * @access public
  84    */
  85   function createUser(&$params, $mail) {
  86     $form_state = array();
  87     $form_state['values'] = array(
  88       'name' => $params['cms_name'],
  89       'mail' => $params[$mail],
  90       'op' => 'Create new account',
  91     );
  92
  93     $admin = user_access('administer users');
  94     if (!variable_get('user_email_verification', TRUE) || $admin) {
  95       $form_state['values']['pass']['pass1'] = $params['cms_pass'];
  96       $form_state['values']['pass']['pass2'] = $params['cms_pass'];
  97     }
  98
  99     $config = CRM_Core_Config::singleton();
 100
 101     // we also need to redirect b
 102     $config->inCiviCRM = TRUE;
 103
 104     $form = drupal_retrieve_form('user_register', $form_state);
 105     $form['#post'] = $form_state['values'];
 106     drupal_prepare_form('user_register', $form, $form_state);
 107
 108     // remove the captcha element from the form prior to processing
 109     unset($form['captcha']);
 110
 111     drupal_process_form('user_register', $form, $form_state);
 112
 113     $config->inCiviCRM = FALSE;
 114
 115     if (form_get_errors() || !isset($form_state['user'])) {
 116       return FALSE;
 117     }
 118     return $form_state['user']->uid;
 119   }
 120
 121   /*
 122    *  Change user name in host CMS
 123    *
 124    *  @param integer $ufID User ID in CMS
 125    *  @param string $ufName User name
 126    */
 127   function updateCMSName($ufID, $ufName) {
 128     // CRM-5555
 129     if (function_exists('user_load')) {
 130       $user = user_load(array('uid' => $ufID));
 131       if ($user->mail != $ufName) {
 132         user_save($user, array('mail' => $ufName));
 133         $user = user_load(array('uid' => $ufID));
 134       }
 135     }
 136   }
 137
 138   /**
 139    * Check if username and email exists in the drupal db
 140    *
 141    * @params $params    array   array of name and mail values
 142    * @params $errors    array   array of errors
 143    * @params $emailName string  field label for the 'email'
 144    *
 145    * @return void
 146    */
 147   function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
 148     $config = CRM_Core_Config::singleton();
 149
 150     $dao   = new CRM_Core_DAO();
 151     $name  = $dao->escape(CRM_Utils_Array::value('name', $params));
 152     $email = $dao->escape(CRM_Utils_Array::value('mail', $params));
 153     _user_edit_validate(NULL, $params);
 154     $errors = form_get_errors();
 155     if ($errors) {
 156       if (CRM_Utils_Array::value('name', $errors)) {
 157         $errors['cms_name'] = $errors['name'];
 158       }
 159       if (CRM_Utils_Array::value('mail', $errors)) {
 160         $errors[$emailName] = $errors['mail'];
 161       }
 162       // also unset drupal messages to avoid twice display of errors
 163       unset($_SESSION['messages']);
 164     }
 165
 166     // Do the name check manually.
 167     $nameError = user_validate_name($params['name']);
 168     if ($nameError) {
 169       $errors['cms_name'] = $nameError;
 170     }
 171
 172     $sql = "
 173       SELECT name, mail
 174       FROM {users}
 175       WHERE (LOWER(name) = LOWER('$name')) OR (LOWER(mail) = LOWER('$email'))
 176     ";
 177
 178     $result = db_query($sql);
 179     $rows = db_fetch_array($result);
 180     if (!$rows) {
 181       return;
 182     }
 183     $row = $rows[0];
 184     $user = NULL;
 185
 186     if (!empty($row)) {
 187       $dbName = CRM_Utils_Array::value('name', $row);
 188       $dbEmail = CRM_Utils_Array::value('mail', $row);
 189       if (strtolower($dbName) == strtolower($name)) {
 190         $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.',
 191           array(1 => $name)
 192         );
 193       }
 194       if (strtolower($dbEmail) == strtolower($email)) {
 195         if(empty($email)) {
 196           $errors[$emailName] = ts('You cannot create an email account for a contact with no email',
 197             array(1 => $email)
 198           );
 199         }
 200         else{
 201           $errors[$emailName] = ts('This email %1 is already registered. Please select another email.',
 202             array(1 => $email)
 203           );
 204         }
 205       }
 206     }
 207   }
 208
 209   /*
 210    * Function to get the drupal destination string. When this is passed in the
 211    * URL the user will be directed to it after filling in the drupal form
 212    *
 213    * @param object $form Form object representing the 'current' form - to which the user will be returned
 214    * @return string $destination destination value for URL
 215    *
 216    */
 217   function getLoginDestination(&$form) {
 218     $args = NULL;
 219
 220     $id = $form->get('id');
 221     if ($id) {
 222       $args .= "&id=$id";
 223     }
 224     else {
 225       $gid = $form->get('gid');
 226       if ($gid) {
 227         $args .= "&gid=$gid";
 228       }
 229       else {
 230         // Setup Personal Campaign Page link uses pageId
 231         $pageId = $form->get('pageId');
 232         if ($pageId) {
 233           $component = $form->get('component');
 234           $args .= "&pageId=$pageId&component=$component&action=add";
 235         }
 236       }
 237     }
 238
 239     $destination = NULL;
 240     if ($args) {
 241       // append destination so user is returned to form they came from after login
 242       $destination = CRM_Utils_System::currentPath() . '?reset=1' . $args;
 243     }
 244     return $destination;
 245   }
 246
 247   /**
 248    * sets the title of the page
 249    *
 250    * @param string $title
 251    * @paqram string $pageTitle
 252    *
 253    * @return void
 254    * @access public
 255    */
 256   function setTitle($title, $pageTitle = NULL) {
 257     if (!$pageTitle) {
 258       $pageTitle = $title;
 259     }
 260     if (arg(0) == 'civicrm') {
 261       //set drupal title
 262       drupal_set_title($pageTitle);
 263     }
 264   }
 265
 266   /**
 267    * Append an additional breadcrumb tag to the existing breadcrumb
 268    *
 269    * @param string $title
 270    * @param string $url
 271    *
 272    * @return void
 273    * @access public
 274    */
 275   function appendBreadCrumb($breadCrumbs) {
 276     $breadCrumb = drupal_get_breadcrumb();
 277
 278     if (is_array($breadCrumbs)) {
 279       foreach ($breadCrumbs as $crumbs) {
 280         if (stripos($crumbs['url'], 'id%%')) {
 281           $args = array('cid', 'mid');
 282           foreach ($args as $a) {
 283             $val = CRM_Utils_Request::retrieve($a, 'Positive', CRM_Core_DAO::$_nullObject,
 284               FALSE, NULL, $_GET
 285             );
 286             if ($val) {
 287               $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']);
 288             }
 289           }
 290         }
 291         $breadCrumb[] = "<a href=\"{$crumbs['url']}\">{$crumbs['title']}</a>";
 292       }
 293     }
 294     drupal_set_breadcrumb($breadCrumb);
 295   }
 296
 297   /**
 298    * Reset an additional breadcrumb tag to the existing breadcrumb
 299    *
 300    * @return void
 301    * @access public
 302    */
 303   function resetBreadCrumb() {
 304     $bc = array();
 305     drupal_set_breadcrumb($bc);
 306   }
 307
 308   /**
 309    * Append a string to the head of the html file
 310    *
 311    * @param string $head the new string to be appended
 312    *
 313    * @return void
 314    * @access public
 315    */
 316   function addHTMLHead($head) {
 317     drupal_set_html_head($head);
 318   }
 319
 320   /**
 321    * Add a script file
 322    *
 323    * @param $url: string, absolute path to file
 324    * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
 325    *
 326    * Note: This function is not to be called directly
 327    * @see CRM_Core_Region::render()
 328    *
 329    * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
 330    * @access public
 331    */
 332   public function addScriptUrl($url, $region) {
 333     switch ($region) {
 334       case 'html-header':
 335       case 'page-footer':
 336         $scope = substr($region, 5);
 337         break;
 338       default:
 339         return FALSE;
 340     }
 341     // If the path is within the drupal directory we can add in the normal way
 342     if (CRM_Utils_System_Drupal::formatResourceUrl($url)) {
 343       drupal_add_js($url, 'module', $scope);
 344       return TRUE;
 345     }
 346     return FALSE;
 347   }
 348
 349   /**
 350    * Add an inline script
 351    *
 352    * @param $code: string, javascript code
 353    * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
 354    *
 355    * Note: This function is not to be called directly
 356    * @see CRM_Core_Region::render()
 357    *
 358    * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
 359    * @access public
 360    */
 361   public function addScript($code, $region) {
 362     switch ($region) {
 363       case 'html-header':
 364       case 'page-footer':
 365         $scope = substr($region, 5);
 366         break;
 367       default:
 368         return FALSE;
 369     }
 370     drupal_add_js($code, 'inline', $scope);
 371     return TRUE;
 372   }
 373
 374   /**
 375    * Add a css file
 376    *
 377    * @param $url: string, absolute path to file
 378    * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
 379    *
 380    * Note: This function is not to be called directly
 381    * @see CRM_Core_Region::render()
 382    *
 383    * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
 384    * @access public
 385    */
 386   public function addStyleUrl($url, $region) {
 387     if ($region != 'html-header' || !CRM_Utils_System_Drupal::formatResourceUrl($url)) {
 388       return FALSE;
 389     }
 390     drupal_add_css($url);
 391     return TRUE;
 392   }
 393
 394   /**
 395    * Add an inline style
 396    *
 397    * @param $code: string, css code
 398    * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
 399    *
 400    * Note: This function is not to be called directly
 401    * @see CRM_Core_Region::render()
 402    *
 403    * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
 404    * @access public
 405    */
 406   public function addStyle($code, $region) {
 407     return FALSE;
 408   }
 409
 410   /**
 411    * rewrite various system urls to https
 412    *
 413    * @param null
 414    *
 415    * @return void
 416    * @access public
 417    */
 418   function mapConfigToSSL() {
 419     global $base_url;
 420     $base_url = str_replace('http://', 'https://', $base_url);
 421   }
 422
 423   /**
 424    * figure out the post url for the form
 425    *
 426    * @param mix $action the default action if one is pre-specified
 427    *
 428    * @return string the url to post the form
 429    * @access public
 430    */
 431   function postURL($action) {
 432     if (!empty($action)) {
 433       return $action;
 434     }
 435
 436     return $this->url($_GET['q']);
 437   }
 438
 439   /**
 440    * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
 441    *
 442    * @param $path     string   The path being linked to, such as "civicrm/add"
 443    * @param $query    string   A query string to append to the link.
 444    * @param $absolute boolean  Whether to force the output to be an absolute link (beginning with http:).
 445    *                           Useful for links that will be displayed outside the site, such as in an
 446    *                           RSS feed.
 447    * @param $fragment string   A fragment identifier (named anchor) to append to the link.
 448    * @param $htmlize  boolean  whether to convert to html eqivalant
 449    * @param $frontend boolean  a gross joomla hack
 450    *
 451    * @return string            an HTML string containing a link to the given path.
 452    * @access public
 453    *
 454    */
 455   function url($path = NULL, $query = NULL, $absolute = FALSE,
 456     $fragment = NULL, $htmlize = TRUE,
 457     $frontend = FALSE
 458   ) {
 459     $config = CRM_Core_Config::singleton();
 460     $script = 'index.php';
 461
 462     $path = CRM_Utils_String::stripPathChars($path);
 463
 464     if (isset($fragment)) {
 465       $fragment = '#' . $fragment;
 466     }
 467
 468     if (!isset($config->useFrameworkRelativeBase)) {
 469       $base = parse_url($config->userFrameworkBaseURL);
 470       $config->useFrameworkRelativeBase = $base['path'];
 471     }
 472     $base = $absolute ? $config->userFrameworkBaseURL : $config->useFrameworkRelativeBase;
 473
 474     $separator = $htmlize ? '&amp;' : '&';
 475
 476     if (!$config->cleanURL) {
 477       if (isset($path)) {
 478         if (isset($query)) {
 479           return $base . $script . '?q=' . $path . $separator . $query . $fragment;
 480         }
 481         else {
 482           return $base . $script . '?q=' . $path . $fragment;
 483         }
 484       }
 485       else {
 486         if (isset($query)) {
 487           return $base . $script . '?' . $query . $fragment;
 488         }
 489         else {
 490           return $base . $fragment;
 491         }
 492       }
 493     }
 494     else {
 495       if (isset($path)) {
 496         if (isset($query)) {
 497           return $base . $path . '?' . $query . $fragment;
 498         }
 499         else {
 500           return $base . $path . $fragment;
 501         }
 502       }
 503       else {
 504         if (isset($query)) {
 505           return $base . $script . '?' . $query . $fragment;
 506         }
 507         else {
 508           return $base . $fragment;
 509         }
 510       }
 511     }
 512   }
 513
 514   /**
 515    * Authenticate the user against the drupal db
 516    *
 517    * @param string $name     the user name
 518    * @param string $password the password for the above user name
 519    * @param boolean $loadCMSBootstrap load cms bootstrap?
 520    * @param NULL|string $realPath filename of script
 521    *
 522    * @return mixed false if no auth
 523    *               array(
 524    *  contactID, ufID, unique string ) if success
 525    * @access public
 526    */
 527   function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
 528    //@todo this 'PEAR-y' stuff is only required when bookstrap is not being loaded which is rare
 529    // if ever now.
 530    // probably if bootstrap is loaded this call
 531    // CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath); would be
 532    // sufficient to do what this fn does. It does exist as opposed to return which might need some hanky-panky to make
 533    // safe in the unknown situation where authenticate might be called & it is important that
 534    // false is returned
 535     require_once 'DB.php';
 536
 537     $config = CRM_Core_Config::singleton();
 538
 539     $dbDrupal = DB::connect($config->userFrameworkDSN);
 540     if (DB::isError($dbDrupal)) {
 541       CRM_Core_Error::fatal("Cannot connect to drupal db via $config->userFrameworkDSN, " . $dbDrupal->getMessage());
 542     }
 543
 544     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
 545     $dbpassword   = md5($password);
 546     $name       = $dbDrupal->escapeSimple($strtolower($name));
 547     $sql        = 'SELECT u.* FROM ' . $config->userFrameworkUsersTableName . " u WHERE LOWER(u.name) = '$name' AND u.pass = '$dbpassword' AND u.status = 1";
 548     $query      = $dbDrupal->query($sql);
 549
 550     $user = NULL;
 551     // need to change this to make sure we matched only one row
 552     while ($row = $query->fetchRow(DB_FETCHMODE_ASSOC)) {
 553       CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $row['uid'], $row['mail'], 'Drupal');
 554       $contactID = CRM_Core_BAO_UFMatch::getContactId($row['uid']);
 555       if (!$contactID) {
 556         return FALSE;
 557       }
 558       else{//success
 559         if ($loadCMSBootstrap) {
 560           $bootStrapParams = array();
 561           if ($name && $password) {
 562             $bootStrapParams = array(
 563                 'name' => $name,
 564                 'pass' => $password,
 565             );
 566           }
 567           CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath);
 568         }
 569         return array($contactID, $row['uid'], mt_rand());
 570       }
 571     }
 572     return FALSE;
 573   }
 574
 575   /*
 576    * Load user into session
 577    */
 578   function loadUser($username) {
 579     global $user;
 580     $user = user_load(array('name' => $username));
 581     if (empty($user->uid)) {
 582       return FALSE;
 583     }
 584
 585     $uid = $user->uid;
 586     $contact_id = CRM_Core_BAO_UFMatch::getContactId($uid);
 587
 588     // lets store contact id and user id in session
 589     $session = CRM_Core_Session::singleton();
 590     $session->set('ufID', $uid);
 591     $session->set('userID', $contact_id);
 592     return TRUE;
 593   }
 594
 595   /**
 596    * Perform any post login activities required by the UF -
 597    * e.g. for drupal : records a watchdog message about the new session,
 598    * saves the login timestamp, calls hook_user op 'login' and generates a new session.
 599    *
 600    * @param array params
 601    *
 602    * FIXME: Document values accepted/required by $params
 603    */
 604   function userLoginFinalize($params = array()) {
 605     user_authenticate_finalize($params);
 606   }
 607
 608   /**
 609    * Determine the native ID of the CMS user
 610    *
 611    * @param $username
 612    * @return int|NULL
 613    */
 614   function getUfId($username) {
 615     $user = user_load(array('name' => $username));
 616     if (empty($user->uid)) {
 617       return NULL;
 618     }
 619     return $user->uid;
 620   }
 621
 622   /**
 623    * Set a message in the UF to display to a user
 624    *
 625    * @param string $message the message to set
 626    *
 627    * @access public
 628    */
 629   function setMessage($message) {
 630     drupal_set_message($message);
 631   }
 632
 633   function permissionDenied() {
 634     drupal_access_denied();
 635   }
 636
 637   function logout() {
 638     module_load_include('inc', 'user', 'user.pages');
 639     return user_logout();
 640   }
 641
 642   function updateCategories() {
 643     // copied this from profile.module. Seems a bit inefficient, but i dont know a better way
 644     // CRM-3600
 645     cache_clear_all();
 646     menu_rebuild();
 647   }
 648
 649   /**
 650    * Get the locale set in the hosting CMS
 651    *
 652    * @return string  with the locale or null for none
 653    */
 654   function getUFLocale() {
 655     // return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
 656     // (for CRM-6281), Drupal’s xx_YY or is retrieved based on Drupal’s xx
 657     // sometimes for CLI based on order called, this might not be set and/or empty
 658     global $language;
 659
 660     if (empty($language)) {
 661       return NULL;
 662     }
 663
 664     if ($language->language == 'zh-hans') {
 665       return 'zh_CN';
 666     }
 667
 668     if ($language->language == 'zh-hant') {
 669       return 'zh_TW';
 670     }
 671
 672     if (preg_match('/^.._..$/', $language->language)) {
 673       return $language->language;
 674     }
 675
 676     return CRM_Core_I18n_PseudoConstant::longForShort(substr($language->language, 0, 2));
 677   }
 678
 679   function getVersion() {
 680     return defined('VERSION') ? VERSION : 'Unknown';
 681   }
 682
 683   /**
 684    * load drupal bootstrap
 685    *
 686    * @param array $params Either uid, or name & pass.
 687    * @param boolean $loadUser boolean Require CMS user load.
 688    * @param boolean $throwError If true, print error on failure and exit.
 689    * @param boolean|string $realPath path to script
 690    */
 691   function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
 692     //take the cms root path.
 693     $cmsPath = $this->cmsRootPath($realPath);
 694
 695     if (!file_exists("$cmsPath/includes/bootstrap.inc")) {
 696       if ($throwError) {
 697         echo '<br />Sorry, could not locate bootstrap.inc\n';
 698         exit();
 699       }
 700       return FALSE;
 701     }
 702     // load drupal bootstrap
 703     chdir($cmsPath);
 704     define('DRUPAL_ROOT', $cmsPath);
 705
 706     // For drupal multi-site CRM-11313
 707     if ($realPath && strpos($realPath, 'sites/all/modules/') === FALSE) {
 708       preg_match('@sites/([^/]*)/modules@s', $realPath, $matches);
 709       if (!empty($matches[1])) {
 710         $_SERVER['HTTP_HOST'] = $matches[1];
 711       }
 712     }
 713     require_once 'includes/bootstrap.inc';
 714     // @ to suppress notices eg 'DRUPALFOO already defined'.
 715     @drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
 716
 717     // explicitly setting error reporting, since we cannot handle drupal related notices
 718     error_reporting(1);
 719     if (!function_exists('module_exists') || !module_exists('civicrm')) {
 720       if ($throwError) {
 721         echo '<br />Sorry, could not load drupal bootstrap.';
 722         exit();
 723       }
 724       return FALSE;
 725     }
 726
 727     // seems like we've bootstrapped drupal
 728     $config = CRM_Core_Config::singleton();
 729
 730     // lets also fix the clean url setting
 731     // CRM-6948
 732     $config->cleanURL = (int) variable_get('clean_url', '0');
 733
 734     // we need to call the config hook again, since we now know
 735     // all the modules that are listening on it, does not apply
 736     // to J! and WP as yet
 737     // CRM-8655
 738     CRM_Utils_Hook::config($config);
 739
 740     if (!$loadUser) {
 741       return TRUE;
 742     }
 743
 744     // If $uid is passed in, authentication has been done already.
 745     $uid = CRM_Utils_Array::value('uid', $params);
 746     if (!$uid) {
 747       //load user, we need to check drupal permissions.
 748       $name = CRM_Utils_Array::value('name', $params, FALSE) ? $params['name'] : trim(CRM_Utils_Array::value('name', $_REQUEST));
 749       $pass = CRM_Utils_Array::value('pass', $params, FALSE) ? $params['pass'] : trim(CRM_Utils_Array::value('pass', $_REQUEST));
 750
 751       if ($name) {
 752         $uid = user_authenticate(array('name' => $name, 'pass' => $pass));
 753         if (!$uid) {
 754           if ($throwError) {
 755             echo '<br />Sorry, unrecognized username or password.';
 756             exit();
 757           }
 758           return FALSE;
 759         }
 760       }
 761     }
 762
 763     if ($uid) {
 764       $account = user_load($uid);
 765       if ($account && $account->uid) {
 766         global $user;
 767         $user = $account;
 768         return TRUE;
 769       }
 770     }
 771
 772     if ($throwError) {
 773       echo '<br />Sorry, can not load CMS user account.';
 774       exit();
 775     }
 776
 777     // CRM-6948: When using loadBootStrap, it's implicit that CiviCRM has already loaded its settings
 778     // which means that define(CIVICRM_CLEANURL) was correctly set.
 779     // So we correct it
 780     $config = CRM_Core_Config::singleton();
 781     $config->cleanURL = (int)variable_get('clean_url', '0');
 782
 783     // CRM-8655: Drupal wasn't available during bootstrap, so hook_civicrm_config never executes
 784     CRM_Utils_Hook::config($config);
 785
 786     return FALSE;
 787   }
 788
 789   /**
 790    *
 791    */
 792   function cmsRootPath($scriptFilename = NULL) {
 793     $cmsRoot = $valid = NULL;
 794
 795     if (!is_null($scriptFilename)) {
 796       $path = $scriptFilename;
 797     }
 798     else {
 799       $path = $_SERVER['SCRIPT_FILENAME'];
 800     }
 801
 802     if (function_exists('drush_get_context')) {
 803       // drush anyway takes care of multisite install etc
 804       return drush_get_context('DRUSH_DRUPAL_ROOT');
 805     }
 806     // CRM-7582
 807     $pathVars = explode('/',
 808       str_replace('//', '/',
 809         str_replace('\\', '/', $path)
 810       )
 811     );
 812
 813     //lets store first var,
 814     //need to get back for windows.
 815     $firstVar = array_shift($pathVars);
 816
 817     //lets remove sript name to reduce one iteration.
 818     array_pop($pathVars);
 819
 820     //CRM-7429 --do check for upper most 'includes' dir,
 821     //which would effectually work for multisite installation.
 822     do {
 823       $cmsRoot = $firstVar . '/' . implode('/', $pathVars);
 824       $cmsIncludePath = "$cmsRoot/includes";
 825       //stop as we found bootstrap.
 826       if (@opendir($cmsIncludePath) &&
 827         file_exists("$cmsIncludePath/bootstrap.inc")
 828       ) {
 829         $valid = TRUE;
 830         break;
 831       }
 832       //remove one directory level.
 833       array_pop($pathVars);
 834     } while (count($pathVars));
 835
 836     return ($valid) ? $cmsRoot : NULL;
 837   }
 838
 839   /**
 840    * check is user logged in.
 841    *
 842    * @return boolean true/false.
 843    */
 844   public function isUserLoggedIn() {
 845     $isloggedIn = FALSE;
 846     if (function_exists('user_is_logged_in')) {
 847       $isloggedIn = user_is_logged_in();
 848     }
 849
 850     return $isloggedIn;
 851   }
 852
 853   /**
 854    * Get currently logged in user uf id.
 855    *
 856    * @return int $userID logged in user uf id.
 857    */
 858   public function getLoggedInUfID() {
 859     $ufID = NULL;
 860     if (function_exists('user_is_logged_in') &&
 861       user_is_logged_in() &&
 862       function_exists('user_uid_optional_to_arg')
 863     ) {
 864       $ufID = user_uid_optional_to_arg(array());
 865     }
 866
 867     return $ufID;
 868   }
 869
 870   /**
 871    * Format the url as per language Negotiation.
 872    *
 873    * @param string $url
 874    *
 875    * @return string $url, formatted url.
 876    * @static
 877    */
 878   function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
 879     if (empty($url)) {
 880       return $url;
 881     }
 882
 883     //upto d6 only, already we have code in place for d7
 884     $config = CRM_Core_Config::singleton();
 885     if (function_exists('variable_get') &&
 886       module_exists('locale')
 887     ) {
 888       global $language;
 889
 890       //get the mode.
 891       $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE);
 892
 893       //url prefix / path.
 894       if (isset($language->prefix) &&
 895         $language->prefix &&
 896         in_array($mode, array(
 897           LANGUAGE_NEGOTIATION_PATH,
 898             LANGUAGE_NEGOTIATION_PATH_DEFAULT,
 899           ))
 900       ) {
 901
 902         if ($addLanguagePart) {
 903           $url .= $language->prefix . '/';
 904         }
 905         if ($removeLanguagePart) {
 906           $url = str_replace("/{$language->prefix}/", '/', $url);
 907         }
 908       }
 909       if (isset($language->domain) &&
 910         $language->domain &&
 911         $mode == LANGUAGE_NEGOTIATION_DOMAIN
 912       ) {
 913
 914         if ($addLanguagePart) {
 915           $url = CRM_Utils_File::addTrailingSlash($language->domain, '/');
 916         }
 917         if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
 918           $url = str_replace('\\', '/', $url);
 919           $parseUrl = parse_url($url);
 920
 921           //kinda hackish but not sure how to do it right
 922           //hope http_build_url() will help at some point.
 923           if (is_array($parseUrl) && !empty($parseUrl)) {
 924             $urlParts           = explode('/', $url);
 925             $hostKey            = array_search($parseUrl['host'], $urlParts);
 926             $ufUrlParts         = parse_url(CIVICRM_UF_BASEURL);
 927             $urlParts[$hostKey] = $ufUrlParts['host'];
 928             $url                = implode('/', $urlParts);
 929           }
 930         }
 931       }
 932     }
 933
 934     return $url;
 935   }
 936
 937   /**
 938    * Find any users/roles/security-principals with the given permission
 939    * and replace it with one or more permissions.
 940    *
 941    * @param $oldPerm string
 942    * @param $newPerms array, strings
 943    *
 944    * @return void
 945    */
 946   function replacePermission($oldPerm, $newPerms) {
 947     $roles = user_roles(FALSE, $oldPerm);
 948     foreach ($roles as $rid => $roleName) {
 949       $permList = db_result(db_query('SELECT perm FROM {permission} WHERE rid = %d', $rid));
 950       $perms = drupal_map_assoc(explode(', ', $permList));
 951       unset($perms[$oldPerm]);
 952       $perms = $perms + drupal_map_assoc($newPerms);
 953       $permList = implode(', ', $perms);
 954       db_query('UPDATE {permission} SET perm = "%s" WHERE rid = %d', $permList, $rid);
 955       /*
 956         if ( ! empty( $roles ) ) {
 957             $rids = implode(',', array_keys($roles));
 958             db_query( 'UPDATE {permission} SET perm = CONCAT( perm, \', edit all events\') WHERE rid IN (' . implode(',', array_keys($roles)) . ')' );
 959             db_query( "UPDATE {permission} SET perm = REPLACE( perm, '%s', '%s' ) WHERE rid IN ($rids)",
 960                 $oldPerm, implode(', ', $newPerms) );*/
 961     }
 962   }
 963
 964   /**
 965    * Get a list of all installed modules, including enabled and disabled ones
 966    *
 967    * @return array CRM_Core_Module
 968    */
 969   function getModules() {
 970     $result = array();
 971     $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
 972     while ($row = db_fetch_object($q)) {
 973       $result[] = new CRM_Core_Module('drupal.' . $row->name, ($row->status == 1) ? TRUE : FALSE);
 974     }
 975     return $result;
 976   }
 977
 978   /**
 979    * Get user login URL for hosting CMS (method declared in each CMS system class)
 980    *
 981    * @param string $destination - if present, add destination to querystring (works for Drupal only)
 982    *
 983    * @return string - loginURL for the current CMS
 984    * @static
 985    */
 986   public function getLoginURL($destination = '') {
 987     $config = CRM_Core_Config::singleton();
 988     $loginURL = $config->userFrameworkBaseURL;
 989     $loginURL .= 'user';
 990     if (!empty($destination)) {
 991       // append destination so user is returned to form they came from after login
 992       $loginURL .= '?destination=' . urlencode($destination);
 993     }
 994     return $loginURL;
 995   }
 996
 997   /**
 998    * Wrapper for og_membership creation
 999    *
1000    * @param integer $ogID Organic Group ID
1001    * @param integer $drupalID drupal User ID
1002    */
1003   function og_membership_create($ogID, $drupalID){
1004     og_save_subscription( $ogID, $drupalID, array( 'is_active' => 1 ) );
1005   }
1006
1007   /**
1008    * Wrapper for og_membership deletion
1009    *
1010    * @param integer $ogID Organic Group ID
1011    * @param integer $drupalID drupal User ID
1012    */
1013   function og_membership_delete($ogID, $drupalID) {
1014       og_delete_subscription( $ogID, $drupalID );
1015   }
1016
1017   /**
1018    * Reset any system caches that may be required for proper CiviCRM
1019    * integration.
1020    */
1021   function flush() {
1022     drupal_flush_all_caches();
1023   }
1024 }