CRM/Utils/System/Drupal6.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 class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase {
  22
  23   /**
  24    * Theme output.
  25    *
  26    * If we are using a theming system, invoke theme, else just print the content.
  27    *
  28    * @param string $content
  29    *   The content that will be themed.
  30    * @param bool $print
  31    *   Are we displaying to the screen or bypassing theming?.
  32    * @param bool $maintenance
  33    *   For maintenance mode.
  34    *
  35    * @return null|string
  36    *   prints content on stdout
  37    */
  38   public function theme(&$content, $print = FALSE, $maintenance = FALSE) {
  39     // TODO: Simplify; this was copied verbatim from CiviCRM 3.4's multi-UF theming function, but that's more complex than necessary
  40     if (function_exists('theme') && !$print) {
  41       if ($maintenance) {
  42         drupal_set_breadcrumb('');
  43         drupal_maintenance_theme();
  44       }
  45
  46       // Arg 3 for D6 theme() is "show_blocks". Previously, we passed
  47       // through a badly named variable ("$args") which was almost always
  48       // TRUE (except on fatal error screen).  However, this feature is
  49       // non-functional on D6 default themes, was purposefully removed from
  50       // D7, has no analog in other our other CMS's, and clutters the code.
  51       // Hard-wiring to TRUE should be OK.
  52       $out = theme('page', $content, TRUE);
  53     }
  54     else {
  55       $out = $content;
  56     }
  57
  58     print $out;
  59     return NULL;
  60   }
  61
  62   /**
  63    * Create user.
  64    *
  65    * @inheritDoc
  66    */
  67   public function createUser(&$params, $mail) {
  68     $form_state = [];
  69     $form_state['values'] = [
  70       'name' => $params['cms_name'],
  71       'mail' => $params[$mail],
  72       'op' => 'Create new account',
  73     ];
  74
  75     $admin = user_access('administer users');
  76     if (!variable_get('user_email_verification', TRUE) || $admin) {
  77       $form_state['values']['pass']['pass1'] = $params['cms_pass'];
  78       $form_state['values']['pass']['pass2'] = $params['cms_pass'];
  79     }
  80
  81     $config = CRM_Core_Config::singleton();
  82
  83     // we also need to redirect b
  84     $config->inCiviCRM = TRUE;
  85
  86     $form = drupal_retrieve_form('user_register', $form_state);
  87     $form['#post'] = $form_state['values'];
  88     drupal_prepare_form('user_register', $form, $form_state);
  89
  90     // remove the captcha element from the form prior to processing
  91     unset($form['captcha']);
  92
  93     drupal_process_form('user_register', $form, $form_state);
  94
  95     $config->inCiviCRM = FALSE;
  96
  97     if (form_get_errors() || !isset($form_state['user'])) {
  98       return FALSE;
  99     }
 100     return $form_state['user']->uid;
 101   }
 102
 103   /**
 104    * @inheritDoc
 105    */
 106   public function updateCMSName($ufID, $ufName) {
 107     // CRM-5555
 108     if (function_exists('user_load')) {
 109       $user = user_load(['uid' => $ufID]);
 110       if ($user->mail != $ufName) {
 111         user_save($user, ['mail' => $ufName]);
 112         $user = user_load(['uid' => $ufID]);
 113       }
 114     }
 115   }
 116
 117   /**
 118    * Check if username and email exists in the drupal db.
 119    *
 120    * @param array $params
 121    *   Array of name and mail values.
 122    * @param array $errors
 123    *   Array of errors.
 124    * @param string $emailName
 125    *   Field label for the 'email'.
 126    */
 127   public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
 128     $config = CRM_Core_Config::singleton();
 129
 130     $dao = new CRM_Core_DAO();
 131     $name = $dao->escape(CRM_Utils_Array::value('name', $params));
 132     $email = $dao->escape(CRM_Utils_Array::value('mail', $params));
 133     _user_edit_validate(NULL, $params);
 134     $errors = form_get_errors();
 135     if ($errors) {
 136       if (!empty($errors['name'])) {
 137         $errors['cms_name'] = $errors['name'];
 138       }
 139       if (!empty($errors['mail'])) {
 140         $errors[$emailName] = $errors['mail'];
 141       }
 142       // also unset drupal messages to avoid twice display of errors
 143       unset($_SESSION['messages']);
 144     }
 145
 146     // Do the name check manually.
 147     $nameError = user_validate_name($params['name']);
 148     if ($nameError) {
 149       $errors['cms_name'] = $nameError;
 150     }
 151
 152     // LOWER in query below roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
 153     $sql = "
 154       SELECT name, mail
 155       FROM {users}
 156       WHERE (LOWER(name) = LOWER('$name')) OR (LOWER(mail) = LOWER('$email'))
 157     ";
 158
 159     $result = db_query($sql);
 160     $row = db_fetch_array($result);
 161     if (!$row) {
 162       return;
 163     }
 164
 165     $user = NULL;
 166
 167     if (!empty($row)) {
 168       $dbName = CRM_Utils_Array::value('name', $row);
 169       $dbEmail = CRM_Utils_Array::value('mail', $row);
 170       if (strtolower($dbName) == strtolower($name)) {
 171         $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.',
 172           [1 => $name]
 173         );
 174       }
 175       if (strtolower($dbEmail) == strtolower($email)) {
 176         if (empty($email)) {
 177           $errors[$emailName] = ts('You cannot create an email account for a contact with no email',
 178             [1 => $email]
 179           );
 180         }
 181         else {
 182           $errors[$emailName] = ts('This email %1 already has an account associated with it. Please select another email.',
 183             [1 => $email]
 184           );
 185         }
 186       }
 187     }
 188   }
 189
 190   /**
 191    * @inheritDoc
 192    */
 193   public function setTitle($title, $pageTitle = NULL) {
 194     if (!$pageTitle) {
 195       $pageTitle = $title;
 196     }
 197     if (arg(0) == 'civicrm') {
 198       //set drupal title
 199       drupal_set_title($pageTitle);
 200     }
 201   }
 202
 203   /**
 204    * @inheritDoc
 205    */
 206   public function appendBreadCrumb($breadCrumbs) {
 207     $breadCrumb = drupal_get_breadcrumb();
 208
 209     if (is_array($breadCrumbs)) {
 210       foreach ($breadCrumbs as $crumbs) {
 211         if (stripos($crumbs['url'], 'id%%')) {
 212           $args = ['cid', 'mid'];
 213           foreach ($args as $a) {
 214             $val = CRM_Utils_Request::retrieve($a, 'Positive', CRM_Core_DAO::$_nullObject,
 215               FALSE, NULL, $_GET
 216             );
 217             if ($val) {
 218               $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']);
 219             }
 220           }
 221         }
 222         $breadCrumb[] = "<a href=\"{$crumbs['url']}\">{$crumbs['title']}</a>";
 223       }
 224     }
 225     drupal_set_breadcrumb($breadCrumb);
 226   }
 227
 228   /**
 229    * @inheritDoc
 230    */
 231   public function resetBreadCrumb() {
 232     $bc = [];
 233     drupal_set_breadcrumb($bc);
 234   }
 235
 236   /**
 237    * Append a string to the head of the html file.
 238    *
 239    * @param string $head
 240    *   The new string to be appended.
 241    */
 242   public function addHTMLHead($head) {
 243     drupal_set_html_head($head);
 244   }
 245
 246   /**
 247    * Add a css file.
 248    *
 249    * @param $url : string, absolute path to file
 250    * @param string $region
 251    *   location within the document: 'html-header', 'page-header', 'page-footer'.
 252    *
 253    * Note: This function is not to be called directly
 254    * @see CRM_Core_Region::render()
 255    *
 256    * @return bool
 257    *   TRUE if we support this operation in this CMS, FALSE otherwise
 258    */
 259   public function addStyleUrl($url, $region) {
 260     if ($region != 'html-header' || !$this->formatResourceUrl($url)) {
 261       return FALSE;
 262     }
 263     drupal_add_css($url);
 264     return TRUE;
 265   }
 266
 267   /**
 268    * @inheritDoc
 269    */
 270   public function mapConfigToSSL() {
 271     global $base_url;
 272     $base_url = str_replace('http://', 'https://', $base_url);
 273   }
 274
 275   /**
 276    * Get the name of the table that stores the user details.
 277    *
 278    * @return string
 279    */
 280   protected function getUsersTableName() {
 281     $userFrameworkUsersTableName = Civi::settings()->get('userFrameworkUsersTableName');
 282     if (empty($userFrameworkUsersTableName)) {
 283       $userFrameworkUsersTableName = 'users';
 284     }
 285     return $userFrameworkUsersTableName;
 286   }
 287
 288   /**
 289    * @inheritDoc
 290    */
 291   public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
 292     //@todo this 'PEAR-y' stuff is only required when bookstrap is not being loaded which is rare
 293     // if ever now.
 294     // probably if bootstrap is loaded this call
 295     // CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath); would be
 296     // sufficient to do what this fn does. It does exist as opposed to return which might need some hanky-panky to make
 297     // safe in the unknown situation where authenticate might be called & it is important that
 298     // false is returned
 299     require_once 'DB.php';
 300
 301     $config = CRM_Core_Config::singleton();
 302
 303     $dbDrupal = DB::connect($config->userFrameworkDSN);
 304     if (DB::isError($dbDrupal)) {
 305       throw new CRM_Core_Exception("Cannot connect to drupal db via $config->userFrameworkDSN, " . $dbDrupal->getMessage());
 306     }
 307
 308     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
 309     $dbpassword = md5($password);
 310     $name = $dbDrupal->escapeSimple($strtolower($name));
 311     $userFrameworkUsersTableName = $this->getUsersTableName();
 312     $sql = 'SELECT u.* FROM ' . $userFrameworkUsersTableName . " u WHERE LOWER(u.name) = '$name' AND u.pass = '$dbpassword' AND u.status = 1";
 313     $query = $dbDrupal->query($sql);
 314
 315     $user = NULL;
 316     // need to change this to make sure we matched only one row
 317     while ($row = $query->fetchRow(DB_FETCHMODE_ASSOC)) {
 318       CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $row['uid'], $row['mail'], 'Drupal');
 319       $contactID = CRM_Core_BAO_UFMatch::getContactId($row['uid']);
 320       if (!$contactID) {
 321         return FALSE;
 322       }
 323       else {
 324         //success
 325         if ($loadCMSBootstrap) {
 326           $bootStrapParams = [];
 327           if ($name && $password) {
 328             $bootStrapParams = [
 329               'name' => $name,
 330               'pass' => $password,
 331             ];
 332           }
 333           CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath);
 334         }
 335         return [$contactID, $row['uid'], mt_rand()];
 336       }
 337     }
 338     return FALSE;
 339   }
 340
 341   /**
 342    * @inheritDoc
 343    */
 344   public function loadUser($username) {
 345     global $user;
 346     $user = user_load(['name' => $username]);
 347     if (empty($user->uid)) {
 348       return FALSE;
 349     }
 350
 351     $uid = $user->uid;
 352     $contact_id = CRM_Core_BAO_UFMatch::getContactId($uid);
 353
 354     // lets store contact id and user id in session
 355     $session = CRM_Core_Session::singleton();
 356     $session->set('ufID', $uid);
 357     $session->set('userID', $contact_id);
 358     return TRUE;
 359   }
 360
 361   /**
 362    * Perform any post login activities required by the UF -
 363    * e.g. for drupal : records a watchdog message about the new session,
 364    * saves the login timestamp, calls hook_user op 'login' and generates a new session.
 365    *
 366    * @param array $params
 367    *
 368    * FIXME: Document values accepted/required by $params
 369    */
 370   public function userLoginFinalize($params = []) {
 371     user_authenticate_finalize($params);
 372   }
 373
 374   /**
 375    * Determine the native ID of the CMS user.
 376    *
 377    * @param string $username
 378    * @return int|null
 379    */
 380   public function getUfId($username) {
 381     $user = user_load(['name' => $username]);
 382     if (empty($user->uid)) {
 383       return NULL;
 384     }
 385     return $user->uid;
 386   }
 387
 388   /**
 389    * @inheritDoc
 390    */
 391   public function logout() {
 392     module_load_include('inc', 'user', 'user.pages');
 393     return user_logout();
 394   }
 395
 396   /**
 397    * Load drupal bootstrap.
 398    *
 399    * @param array $params
 400    *   Either uid, or name & pass.
 401    * @param bool $loadUser
 402    *   Boolean Require CMS user load.
 403    * @param bool $throwError
 404    *   If true, print error on failure and exit.
 405    * @param bool|string $realPath path to script
 406    *
 407    * @return bool
 408    */
 409   public function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
 410     //take the cms root path.
 411     $cmsPath = $this->cmsRootPath($realPath);
 412
 413     if (!file_exists("$cmsPath/includes/bootstrap.inc")) {
 414       if ($throwError) {
 415         echo '<br />Sorry, could not locate bootstrap.inc\n';
 416         exit();
 417       }
 418       return FALSE;
 419     }
 420     // load drupal bootstrap
 421     chdir($cmsPath);
 422     define('DRUPAL_ROOT', $cmsPath);
 423
 424     // For drupal multi-site CRM-11313
 425     if ($realPath && strpos($realPath, 'sites/all/modules/') === FALSE) {
 426       preg_match('@sites/([^/]*)/modules@s', $realPath, $matches);
 427       if (!empty($matches[1])) {
 428         $_SERVER['HTTP_HOST'] = $matches[1];
 429       }
 430     }
 431     require_once 'includes/bootstrap.inc';
 432     // @ to suppress notices eg 'DRUPALFOO already defined'.
 433     @drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
 434
 435     // explicitly setting error reporting, since we cannot handle drupal related notices
 436     error_reporting(1);
 437     if (!function_exists('module_exists') || !module_exists('civicrm')) {
 438       if ($throwError) {
 439         echo '<br />Sorry, could not load drupal bootstrap.';
 440         exit();
 441       }
 442       return FALSE;
 443     }
 444
 445     // seems like we've bootstrapped drupal
 446     $config = CRM_Core_Config::singleton();
 447
 448     // lets also fix the clean url setting
 449     // CRM-6948
 450     $config->cleanURL = (int) variable_get('clean_url', '0');
 451
 452     // we need to call the config hook again, since we now know
 453     // all the modules that are listening on it, does not apply
 454     // to J! and WP as yet
 455     // CRM-8655
 456     CRM_Utils_Hook::config($config);
 457
 458     if (!$loadUser) {
 459       return TRUE;
 460     }
 461     global $user;
 462     // If $uid is passed in, authentication has been done already.
 463     $uid = CRM_Utils_Array::value('uid', $params);
 464     if (!$uid) {
 465       //load user, we need to check drupal permissions.
 466       $name = CRM_Utils_Array::value('name', $params, FALSE) ? $params['name'] : trim(CRM_Utils_Array::value('name', $_REQUEST));
 467       $pass = CRM_Utils_Array::value('pass', $params, FALSE) ? $params['pass'] : trim(CRM_Utils_Array::value('pass', $_REQUEST));
 468
 469       if ($name) {
 470         $user = user_authenticate(['name' => $name, 'pass' => $pass]);
 471         if (!$user->uid) {
 472           if ($throwError) {
 473             echo '<br />Sorry, unrecognized username or password.';
 474             exit();
 475           }
 476           return FALSE;
 477         }
 478         else {
 479           return TRUE;
 480         }
 481       }
 482     }
 483
 484     if ($uid) {
 485       $account = user_load($uid);
 486       if ($account && $account->uid) {
 487         $user = $account;
 488         return TRUE;
 489       }
 490     }
 491
 492     if ($throwError) {
 493       echo '<br />Sorry, can not load CMS user account.';
 494       exit();
 495     }
 496
 497     // CRM-6948: When using loadBootStrap, it's implicit that CiviCRM has already loaded its settings
 498     // which means that define(CIVICRM_CLEANURL) was correctly set.
 499     // So we correct it
 500     $config = CRM_Core_Config::singleton();
 501     $config->cleanURL = (int) variable_get('clean_url', '0');
 502
 503     // CRM-8655: Drupal wasn't available during bootstrap, so hook_civicrm_config never executes
 504     CRM_Utils_Hook::config($config);
 505
 506     return FALSE;
 507   }
 508
 509   /**
 510    * Get CMS root path.
 511    *
 512    * @param string $scriptFilename
 513    *
 514    * @return null|string
 515    */
 516   public function cmsRootPath($scriptFilename = NULL) {
 517     $cmsRoot = $valid = NULL;
 518
 519     if (!is_null($scriptFilename)) {
 520       $path = $scriptFilename;
 521     }
 522     else {
 523       $path = $_SERVER['SCRIPT_FILENAME'];
 524     }
 525
 526     if (function_exists('drush_get_context')) {
 527       // drush anyway takes care of multisite install etc
 528       return drush_get_context('DRUSH_DRUPAL_ROOT');
 529     }
 530
 531     global $civicrm_paths;
 532     if (!empty($civicrm_paths['cms.root']['path'])) {
 533       return $civicrm_paths['cms.root']['path'];
 534     }
 535
 536     // CRM-7582
 537     $pathVars = explode('/',
 538       str_replace('//', '/',
 539         str_replace('\\', '/', $path)
 540       )
 541     );
 542
 543     //lets store first var,
 544     //need to get back for windows.
 545     $firstVar = array_shift($pathVars);
 546
 547     //lets remove sript name to reduce one iteration.
 548     array_pop($pathVars);
 549
 550     //CRM-7429 --do check for upper most 'includes' dir,
 551     //which would effectually work for multisite installation.
 552     do {
 553       $cmsRoot = $firstVar . '/' . implode('/', $pathVars);
 554       $cmsIncludePath = "$cmsRoot/includes";
 555       // Stop if we found bootstrap.
 556       if (file_exists("$cmsIncludePath/bootstrap.inc")) {
 557         $valid = TRUE;
 558         break;
 559       }
 560       //remove one directory level.
 561       array_pop($pathVars);
 562     } while (count($pathVars));
 563
 564     return ($valid) ? $cmsRoot : NULL;
 565   }
 566
 567   /**
 568    * @inheritDoc
 569    */
 570   public function isUserLoggedIn() {
 571     $isloggedIn = FALSE;
 572     if (function_exists('user_is_logged_in')) {
 573       $isloggedIn = user_is_logged_in();
 574     }
 575
 576     return $isloggedIn;
 577   }
 578
 579   /**
 580    * @inheritDoc
 581    */
 582   public function getLoggedInUfID() {
 583     $ufID = NULL;
 584     if (function_exists('user_is_logged_in') &&
 585       user_is_logged_in() &&
 586       function_exists('user_uid_optional_to_arg')
 587     ) {
 588       $ufID = user_uid_optional_to_arg([]);
 589     }
 590
 591     return $ufID;
 592   }
 593
 594   /**
 595    * @inheritDoc
 596    */
 597   public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
 598     if (empty($url)) {
 599       return $url;
 600     }
 601
 602     //up to d6 only, already we have code in place for d7
 603     $config = CRM_Core_Config::singleton();
 604     if (function_exists('variable_get') &&
 605       module_exists('locale')
 606     ) {
 607       global $language;
 608
 609       //get the mode.
 610       $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE);
 611
 612       //url prefix / path.
 613       if (isset($language->prefix) &&
 614         $language->prefix &&
 615         in_array($mode, [
 616           LANGUAGE_NEGOTIATION_PATH,
 617           LANGUAGE_NEGOTIATION_PATH_DEFAULT,
 618         ])
 619       ) {
 620
 621         if ($addLanguagePart) {
 622           $url .= $language->prefix . '/';
 623         }
 624         if ($removeLanguagePart) {
 625           $url = str_replace("/{$language->prefix}/", '/', $url);
 626         }
 627       }
 628       if (isset($language->domain) &&
 629         $language->domain &&
 630         $mode == LANGUAGE_NEGOTIATION_DOMAIN
 631       ) {
 632
 633         if ($addLanguagePart) {
 634           $url = CRM_Utils_File::addTrailingSlash($language->domain, '/');
 635         }
 636         if ($removeLanguagePart && defined('CIVICRM_UF_BASEURL')) {
 637           $url = str_replace('\\', '/', $url);
 638           $parseUrl = parse_url($url);
 639
 640           //kinda hackish but not sure how to do it right
 641           //hope http_build_url() will help at some point.
 642           if (is_array($parseUrl) && !empty($parseUrl)) {
 643             $urlParts = explode('/', $url);
 644             $hostKey = array_search($parseUrl['host'], $urlParts);
 645             $ufUrlParts = parse_url(CIVICRM_UF_BASEURL);
 646             $urlParts[$hostKey] = $ufUrlParts['host'];
 647             $url = implode('/', $urlParts);
 648           }
 649         }
 650       }
 651     }
 652
 653     return $url;
 654   }
 655
 656   /**
 657    * Find any users/roles/security-principals with the given permission
 658    * and replace it with one or more permissions.
 659    *
 660    * @param string $oldPerm
 661    * @param array $newPerms
 662    *   Array, strings.
 663    */
 664   public function replacePermission($oldPerm, $newPerms) {
 665     $roles = user_roles(FALSE, $oldPerm);
 666     foreach ($roles as $rid => $roleName) {
 667       $permList = db_result(db_query('SELECT perm FROM {permission} WHERE rid = %d', $rid));
 668       $perms = drupal_map_assoc(explode(', ', $permList));
 669       unset($perms[$oldPerm]);
 670       $perms = $perms + drupal_map_assoc($newPerms);
 671       $permList = implode(', ', $perms);
 672       db_query('UPDATE {permission} SET perm = "%s" WHERE rid = %d', $permList, $rid);
 673       /* @codingStandardsIgnoreStart
 674         if ( ! empty( $roles ) ) {
 675             $rids = implode(',', array_keys($roles));
 676             db_query( 'UPDATE {permission} SET perm = CONCAT( perm, \', edit all events\') WHERE rid IN (' . implode(',', array_keys($roles)) . ')' );
 677             db_query( "UPDATE {permission} SET perm = REPLACE( perm, '%s', '%s' ) WHERE rid IN ($rids)",
 678                 $oldPerm, implode(', ', $newPerms) );
 679       @codingStandardsIgnoreEnd */
 680     }
 681   }
 682
 683   /**
 684    * @inheritDoc
 685    */
 686   public function getModules() {
 687     $result = [];
 688     $q = db_query('SELECT name, status FROM {system} WHERE type = \'module\' AND schema_version <> -1');
 689     while ($row = db_fetch_object($q)) {
 690       $result[] = new CRM_Core_Module('drupal.' . $row->name, ($row->status == 1) ? TRUE : FALSE);
 691     }
 692     return $result;
 693   }
 694
 695   /**
 696    * @inheritDoc
 697    */
 698   public function getLoginURL($destination = '') {
 699     $config = CRM_Core_Config::singleton();
 700     $loginURL = $config->userFrameworkBaseURL;
 701     $loginURL .= 'user';
 702     if (!empty($destination)) {
 703       // append destination so user is returned to form they came from after login
 704       $loginURL .= '?destination=' . urlencode($destination);
 705     }
 706     return $loginURL;
 707   }
 708
 709   /**
 710    * Wrapper for og_membership creation.
 711    *
 712    * @param int $ogID
 713    *   Organic Group ID.
 714    * @param int $drupalID
 715    *   Drupal User ID.
 716    */
 717   public function og_membership_create($ogID, $drupalID) {
 718     og_save_subscription($ogID, $drupalID, ['is_active' => 1]);
 719   }
 720
 721   /**
 722    * Wrapper for og_membership deletion.
 723    *
 724    * @param int $ogID
 725    *   Organic Group ID.
 726    * @param int $drupalID
 727    *   Drupal User ID.
 728    */
 729   public function og_membership_delete($ogID, $drupalID) {
 730     og_delete_subscription($ogID, $drupalID);
 731   }
 732
 733   /**
 734    * @inheritDoc
 735    */
 736   public function getTimeZoneString() {
 737     global $user;
 738     // Note that 0 is a valid timezone (GMT) so we use strlen not empty to check.
 739     if (variable_get('configurable_timezones', 1) && $user->uid && isset($user->timezone) && strlen($user->timezone)) {
 740       $timezone = $user->timezone;
 741     }
 742     else {
 743       $timezone = variable_get('date_default_timezone', NULL);
 744     }
 745
 746     // Retrieved timezone will be represented as GMT offset in seconds but, according
 747     // to the doc for the overridden method, ought to be returned as a region string
 748     // (e.g., America/Havana).
 749     if (strlen($timezone)) {
 750       $timezone = timezone_name_from_abbr("", (int) $timezone);
 751     }
 752
 753     if (!$timezone) {
 754       $timezone = parent::getTimeZoneString();
 755     }
 756
 757     return $timezone;
 758   }
 759
 760   /**
 761    * @inheritDoc
 762    */
 763   public function setHttpHeader($name, $value) {
 764     drupal_set_header("$name: $value");
 765   }
 766
 767   /**
 768    * @inheritDoc
 769    */
 770   public function synchronizeUsers() {
 771     $config = CRM_Core_Config::singleton();
 772     if (PHP_SAPI != 'cli') {
 773       set_time_limit(300);
 774     }
 775     $rows = [];
 776     $id = 'uid';
 777     $mail = 'mail';
 778     $name = 'name';
 779
 780     $result = db_query("SELECT uid, mail, name FROM {users} where mail != ''");
 781
 782     while ($row = db_fetch_array($result)) {
 783       $rows[] = $row;
 784     }
 785
 786     $user = new StdClass();
 787     $uf = $config->userFramework;
 788     $contactCount = 0;
 789     $contactCreated = 0;
 790     $contactMatching = 0;
 791     foreach ($rows as $row) {
 792       $user->$id = $row[$id];
 793       $user->$mail = $row[$mail];
 794       $user->$name = $row[$name];
 795       $contactCount++;
 796       if ($match = CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $row[$id], $row[$mail], $uf, 1, 'Individual', TRUE)) {
 797         $contactCreated++;
 798       }
 799       else {
 800         $contactMatching++;
 801       }
 802     }
 803
 804     return [
 805       'contactCount' => $contactCount,
 806       'contactMatching' => $contactMatching,
 807       'contactCreated' => $contactCreated,
 808     ];
 809   }
 810
 811 }