CRM/Utils/System/Joomla.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * Joomla specific stuff goes here.
  36  */
  37 class CRM_Utils_System_Joomla extends CRM_Utils_System_Base {
  38
  39   /**
  40    * Class constructor.
  41    */
  42   public function __construct() {
  43     /**
  44      * 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
  45      * functions and leave the codebase oblivious to the type of CMS
  46      * @deprecated
  47      * @var bool
  48      */
  49     $this->is_drupal = FALSE;
  50   }
  51
  52   /**
  53    * @inheritDoc
  54    */
  55   public function createUser(&$params, $mail) {
  56     $baseDir = JPATH_SITE;
  57     require_once $baseDir . '/components/com_users/models/registration.php';
  58
  59     $userParams = JComponentHelper::getParams('com_users');
  60     $model = new UsersModelRegistration();
  61     $ufID = NULL;
  62
  63     // get the default usertype
  64     $userType = $userParams->get('new_usertype');
  65     if (!$userType) {
  66       $userType = 2;
  67     }
  68
  69     if (isset($params['name'])) {
  70       $fullname = trim($params['name']);
  71     }
  72     elseif (isset($params['contactID'])) {
  73       $fullname = trim(CRM_Contact_BAO_Contact::displayName($params['contactID']));
  74     }
  75     else {
  76       $fullname = trim($params['cms_name']);
  77     }
  78
  79     // Prepare the values for a new Joomla user.
  80     $values = [];
  81     $values['name'] = $fullname;
  82     $values['username'] = trim($params['cms_name']);
  83     $values['password1'] = $values['password2'] = $params['cms_pass'];
  84     $values['email1'] = $values['email2'] = trim($params[$mail]);
  85
  86     $lang = JFactory::getLanguage();
  87     $lang->load('com_users', $baseDir);
  88
  89     $register = $model->register($values);
  90
  91     $ufID = JUserHelper::getUserId($values['username']);
  92     return $ufID;
  93   }
  94
  95   /**
  96    * @inheritDoc
  97    */
  98   public function updateCMSName($ufID, $ufName) {
  99     $ufID = CRM_Utils_Type::escape($ufID, 'Integer');
 100     $ufName = CRM_Utils_Type::escape($ufName, 'String');
 101
 102     $values = [];
 103     $user = JUser::getInstance($ufID);
 104
 105     $values['email'] = $ufName;
 106     $user->bind($values);
 107
 108     $user->save();
 109   }
 110
 111   /**
 112    * Check if username and email exists in the Joomla db.
 113    *
 114    * @param array $params
 115    *   Array of name and mail values.
 116    * @param array $errors
 117    *   Array of errors.
 118    * @param string $emailName
 119    *   Field label for the 'email'.
 120    */
 121   public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
 122     $config = CRM_Core_Config::singleton();
 123
 124     $dao = new CRM_Core_DAO();
 125     $name = $dao->escape(CRM_Utils_Array::value('name', $params));
 126     $email = $dao->escape(CRM_Utils_Array::value('mail', $params));
 127     //don't allow the special characters and min. username length is two
 128     //regex \\ to match a single backslash would become '/\\\\/'
 129     $isNotValid = (bool) preg_match('/[\<|\>|\"|\'|\%|\;|\(|\)|\&|\\\\|\/]/im', $name);
 130     if ($isNotValid || strlen($name) < 2) {
 131       $errors['cms_name'] = ts('Your username contains invalid characters or is too short');
 132     }
 133
 134     $JUserTable = &JTable::getInstance('User', 'JTable');
 135
 136     $db = $JUserTable->getDbo();
 137     $query = $db->getQuery(TRUE);
 138     $query->select('username, email');
 139     $query->from($JUserTable->getTableName());
 140
 141     // LOWER in query below roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
 142     $query->where('(LOWER(username) = LOWER(\'' . $name . '\')) OR (LOWER(email) = LOWER(\'' . $email . '\'))');
 143     $db->setQuery($query, 0, 10);
 144     $users = $db->loadAssocList();
 145
 146     $row = [];
 147     if (count($users)) {
 148       $row = $users[0];
 149     }
 150
 151     if (!empty($row)) {
 152       $dbName = CRM_Utils_Array::value('username', $row);
 153       $dbEmail = CRM_Utils_Array::value('email', $row);
 154       if (strtolower($dbName) == strtolower($name)) {
 155         $errors['cms_name'] = ts('The username %1 is already taken. Please select another username.',
 156           [1 => $name]
 157         );
 158       }
 159       if (strtolower($dbEmail) == strtolower($email)) {
 160         $resetUrl = str_replace('administrator/', '', $config->userFrameworkBaseURL) . 'index.php?option=com_users&view=reset';
 161         $errors[$emailName] = ts('The email address %1 already has an account associated with it. <a href="%2">Have you forgotten your password?</a>',
 162           [1 => $email, 2 => $resetUrl]
 163         );
 164       }
 165     }
 166   }
 167
 168   /**
 169    * @inheritDoc
 170    */
 171   public function setTitle($title, $pageTitle = NULL) {
 172     if (!$pageTitle) {
 173       $pageTitle = $title;
 174     }
 175
 176     $template = CRM_Core_Smarty::singleton();
 177     $template->assign('pageTitle', $pageTitle);
 178
 179     $document = JFactory::getDocument();
 180     $document->setTitle($title);
 181   }
 182
 183   /**
 184    * @inheritDoc
 185    */
 186   public function appendBreadCrumb($breadCrumbs) {
 187     $template = CRM_Core_Smarty::singleton();
 188     $bc = $template->get_template_vars('breadcrumb');
 189
 190     if (is_array($breadCrumbs)) {
 191       foreach ($breadCrumbs as $crumbs) {
 192         if (stripos($crumbs['url'], 'id%%')) {
 193           $args = ['cid', 'mid'];
 194           foreach ($args as $a) {
 195             $val = CRM_Utils_Request::retrieve($a, 'Positive', CRM_Core_DAO::$_nullObject,
 196               FALSE, NULL, $_GET
 197             );
 198             if ($val) {
 199               $crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']);
 200             }
 201           }
 202         }
 203         $bc[] = $crumbs;
 204       }
 205     }
 206     $template->assign_by_ref('breadcrumb', $bc);
 207   }
 208
 209   /**
 210    * @inheritDoc
 211    */
 212   public function resetBreadCrumb() {
 213   }
 214
 215   /**
 216    * @inheritDoc
 217    */
 218   public function addHTMLHead($string = NULL) {
 219     if ($string) {
 220       $document = JFactory::getDocument();
 221       $document->addCustomTag($string);
 222     }
 223   }
 224
 225   /**
 226    * @inheritDoc
 227    */
 228   public function addStyleUrl($url, $region) {
 229     if ($region == 'html-header') {
 230       $document = JFactory::getDocument();
 231       $document->addStyleSheet($url);
 232       return TRUE;
 233     }
 234     return FALSE;
 235   }
 236
 237   /**
 238    * @inheritDoc
 239    */
 240   public function addStyle($code, $region) {
 241     if ($region == 'html-header') {
 242       $document = JFactory::getDocument();
 243       $document->addStyleDeclaration($code);
 244       return TRUE;
 245     }
 246     return FALSE;
 247   }
 248
 249   /**
 250    * @inheritDoc
 251    */
 252   public function url(
 253     $path = NULL,
 254     $query = NULL,
 255     $absolute = FALSE,
 256     $fragment = NULL,
 257     $frontend = FALSE,
 258     $forceBackend = FALSE
 259   ) {
 260     $config = CRM_Core_Config::singleton();
 261     $separator = '&';
 262     $Itemid = '';
 263     $script = '';
 264     $path = CRM_Utils_String::stripPathChars($path);
 265
 266     if ($config->userFrameworkFrontend) {
 267       $script = 'index.php';
 268       if (JRequest::getVar("Itemid") && (strpos($path, 'civicrm/payment/ipn') === FALSE)) {
 269         $Itemid = "{$separator}Itemid=" . JRequest::getVar("Itemid");
 270       }
 271     }
 272
 273     if (isset($fragment)) {
 274       $fragment = '#' . $fragment;
 275     }
 276
 277     $base = $absolute ? $config->userFrameworkBaseURL : $config->useFrameworkRelativeBase;
 278
 279     if (!empty($query)) {
 280       $url = "{$base}{$script}?option=com_civicrm{$separator}task={$path}{$Itemid}{$separator}{$query}{$fragment}";
 281     }
 282     else {
 283       $url = "{$base}{$script}?option=com_civicrm{$separator}task={$path}{$Itemid}{$fragment}";
 284     }
 285
 286     // gross hack for joomla, we are in the backend and want to send a frontend url
 287     if ($frontend && $config->userFramework == 'Joomla') {
 288       // handle both joomla v1.5 and v1.6, CRM-7939
 289       $url = str_replace('/administrator/index2.php', '/index.php', $url);
 290       $url = str_replace('/administrator/index.php', '/index.php', $url);
 291
 292       // CRM-8215
 293       $url = str_replace('/administrator/', '/index.php', $url);
 294     }
 295     elseif ($forceBackend) {
 296       if (defined('JVERSION')) {
 297         $joomlaVersion = JVERSION;
 298       }
 299       else {
 300         $jversion = new JVersion();
 301         $joomlaVersion = $jversion->getShortVersion();
 302       }
 303
 304       if (version_compare($joomlaVersion, '1.6') >= 0) {
 305         $url = str_replace('/index.php', '/administrator/index.php', $url);
 306       }
 307     }
 308     return $url;
 309   }
 310
 311   /**
 312    * Set the email address of the user.
 313    *
 314    * @param object $user
 315    *   Handle to the user object.
 316    */
 317   public function setEmail(&$user) {
 318     global $database;
 319     $query = $db->getQuery(TRUE);
 320     $query->select($db->quoteName('email'))
 321       ->from($db->quoteName('#__users'))
 322       ->where($db->quoteName('id') . ' = ' . $user->id);
 323     $database->setQuery($query);
 324     $user->email = $database->loadResult();
 325   }
 326
 327   /**
 328    * @inheritDoc
 329    */
 330   public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
 331     require_once 'DB.php';
 332
 333     $config = CRM_Core_Config::singleton();
 334     $user = NULL;
 335
 336     if ($loadCMSBootstrap) {
 337       $bootStrapParams = [];
 338       if ($name && $password) {
 339         $bootStrapParams = [
 340           'name' => $name,
 341           'pass' => $password,
 342         ];
 343       }
 344       CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, FALSE);
 345     }
 346
 347     jimport('joomla.application.component.helper');
 348     jimport('joomla.database.table');
 349     jimport('joomla.user.helper');
 350
 351     $JUserTable = JTable::getInstance('User', 'JTable');
 352
 353     $db = $JUserTable->getDbo();
 354     $query = $db->getQuery(TRUE);
 355     $query->select('id, name, username, email, password');
 356     $query->from($JUserTable->getTableName());
 357     $query->where('(LOWER(username) = LOWER(\'' . $name . '\')) AND (block = 0)');
 358     $db->setQuery($query, 0, 0);
 359     $users = $db->loadObjectList();
 360
 361     $row = [];
 362     if (count($users)) {
 363       $row = $users[0];
 364     }
 365
 366     $joomlaBase = self::getBasePath();
 367     self::getJVersion($joomlaBase);
 368
 369     if (!empty($row)) {
 370       $dbPassword = $row->password;
 371       $dbId = $row->id;
 372       $dbEmail = $row->email;
 373
 374       if (version_compare(JVERSION, '2.5.18', 'lt') ||
 375         (version_compare(JVERSION, '3.0', 'ge') && version_compare(JVERSION, '3.2.1', 'lt'))
 376       ) {
 377         // now check password
 378         list($hash, $salt) = explode(':', $dbPassword);
 379         $cryptpass = md5($password . $salt);
 380         if ($hash != $cryptpass) {
 381           return FALSE;
 382         }
 383       }
 384       else {
 385         if (!JUserHelper::verifyPassword($password, $dbPassword, $dbId)) {
 386           return FALSE;
 387         }
 388
 389         if (version_compare(JVERSION, '3.8.0', 'ge')) {
 390           jimport('joomla.application.helper');
 391           jimport('joomla.application.cms');
 392           jimport('joomla.application.administrator');
 393         }
 394         //include additional files required by Joomla 3.2.1+
 395         elseif (version_compare(JVERSION, '3.2.1', 'ge')) {
 396           require_once $joomlaBase . '/libraries/cms/application/helper.php';
 397           require_once $joomlaBase . '/libraries/cms/application/cms.php';
 398           require_once $joomlaBase . '/libraries/cms/application/administrator.php';
 399         }
 400       }
 401
 402       CRM_Core_BAO_UFMatch::synchronizeUFMatch($row, $dbId, $dbEmail, 'Joomla');
 403       $contactID = CRM_Core_BAO_UFMatch::getContactId($dbId);
 404       if (!$contactID) {
 405         return FALSE;
 406       }
 407       return [$contactID, $dbId, mt_rand()];
 408     }
 409
 410     return FALSE;
 411   }
 412
 413   /**
 414    * Set a init session with user object.
 415    *
 416    * @param array $data
 417    *   Array with user specific data.
 418    */
 419   public function setUserSession($data) {
 420     list($userID, $ufID) = $data;
 421     $user = new JUser($ufID);
 422     $session = JFactory::getSession();
 423     $session->set('user', $user);
 424
 425     parent::setUserSession($data);
 426   }
 427
 428   /**
 429    * FIXME: Do something
 430    *
 431    * @param string $message
 432    */
 433   public function setMessage($message) {
 434   }
 435
 436   /**
 437    * @param \string $username
 438    * @param \string $password
 439    *
 440    * @return bool
 441    */
 442   public function loadUser($username, $password = NULL) {
 443     $uid = JUserHelper::getUserId($username);
 444     if (empty($uid)) {
 445       return FALSE;
 446     }
 447     $contactID = CRM_Core_BAO_UFMatch::getContactId($uid);
 448     if (!empty($password)) {
 449       $instance = JFactory::getApplication('site');
 450       $params = [
 451         'username' => $username,
 452         'password' => $password,
 453       ];
 454       //perform the login action
 455       $instance->login($params);
 456     }
 457
 458     // Save details in Joomla session
 459     $user = JFactory::getUser($uid);
 460     $jsession = JFactory::getSession();
 461     $jsession->set('user', $user);
 462
 463     // Save details in Civi session
 464     $session = CRM_Core_Session::singleton();
 465     $session->set('ufID', $uid);
 466     $session->set('userID', $contactID);
 467     return TRUE;
 468   }
 469
 470   /**
 471    * FIXME: Use CMS-native approach
 472    */
 473   public function permissionDenied() {
 474     CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
 475   }
 476
 477   /**
 478    * @inheritDoc
 479    */
 480   public function logout() {
 481     session_destroy();
 482     CRM_Utils_System::setHttpHeader("Location", "index.php");
 483   }
 484
 485   /**
 486    * @inheritDoc
 487    */
 488   public function getUFLocale() {
 489     if (defined('_JEXEC')) {
 490       $conf = JFactory::getConfig();
 491       $locale = $conf->get('language');
 492       return str_replace('-', '_', $locale);
 493     }
 494     return NULL;
 495   }
 496
 497   /**
 498    * @inheritDoc
 499    */
 500   public function setUFLocale($civicrm_language) {
 501     // TODO
 502     return TRUE;
 503   }
 504
 505   /**
 506    * @inheritDoc
 507    */
 508   public function getVersion() {
 509     if (class_exists('JVersion')) {
 510       $version = new JVersion();
 511       return $version->getShortVersion();
 512     }
 513     else {
 514       return 'Unknown';
 515     }
 516   }
 517
 518   public function getJVersion($joomlaBase) {
 519     // Files may be in different places depending on Joomla version
 520     if (!defined('JVERSION')) {
 521       // Joomla 3.8.0+
 522       $versionPhp = $joomlaBase . '/libraries/src/Version.php';
 523       if (!file_exists($versionPhp)) {
 524         // Joomla < 3.8.0
 525         $versionPhp = $joomlaBase . '/libraries/cms/version/version.php';
 526       }
 527       require $versionPhp;
 528       $jversion = new JVersion();
 529       define('JVERSION', $jversion->getShortVersion());
 530     }
 531   }
 532
 533   /**
 534    * Setup the base path related constant.
 535    * @return mixed
 536    */
 537   public function getBasePath() {
 538     global $civicrm_root;
 539     $joomlaPath = explode(DIRECTORY_SEPARATOR . 'administrator', $civicrm_root);
 540     $joomlaBase = $joomlaPath[0];
 541     return $joomlaBase;
 542   }
 543
 544   /**
 545    * Load joomla bootstrap.
 546    *
 547    * @param array $params
 548    *   with uid or name and password.
 549    * @param bool $loadUser
 550    *   load cms user?.
 551    * @param bool|\throw $throwError throw error on failure?
 552    * @param null $realPath
 553    * @param bool $loadDefines
 554    *
 555    * @return bool
 556    */
 557   public function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL, $loadDefines = TRUE) {
 558     $joomlaBase = self::getBasePath();
 559
 560     // load BootStrap here if needed
 561     // We are a valid Joomla entry point.
 562     if (!defined('_JEXEC') && $loadDefines) {
 563       define('_JEXEC', 1);
 564       define('DS', DIRECTORY_SEPARATOR);
 565       define('JPATH_BASE', $joomlaBase . '/administrator');
 566       require $joomlaBase . '/administrator/includes/defines.php';
 567     }
 568
 569     // Get the framework.
 570     if (file_exists($joomlaBase . '/libraries/import.legacy.php')) {
 571       require $joomlaBase . '/libraries/import.legacy.php';
 572     }
 573     require $joomlaBase . '/libraries/cms.php';
 574     self::getJVersion($joomlaBase);
 575
 576     if (version_compare(JVERSION, '3.8', 'lt')) {
 577       require $joomlaBase . '/libraries/import.php';
 578       require $joomlaBase . '/libraries/joomla/event/dispatcher.php';
 579     }
 580
 581     require_once $joomlaBase . '/configuration.php';
 582
 583     if (version_compare(JVERSION, '3.0', 'lt')) {
 584       require $joomlaBase . '/libraries/joomla/environment/uri.php';
 585       require $joomlaBase . '/libraries/joomla/application/component/helper.php';
 586     }
 587     elseif (version_compare(JVERSION, '3.8', 'lt')) {
 588       jimport('joomla.environment.uri');
 589     }
 590
 591     if (version_compare(JVERSION, '3.8', 'lt')) {
 592       jimport('joomla.application.cli');
 593     }
 594
 595     if (!defined('JDEBUG')) {
 596       define('JDEBUG', FALSE);
 597     }
 598
 599     // Set timezone for Joomla on Cron
 600     $config = JFactory::getConfig();
 601     $timezone = $config->get('offset');
 602     if ($timezone) {
 603       date_default_timezone_set($timezone);
 604       CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
 605     }
 606
 607     // CRM-14281 Joomla wasn't available during bootstrap, so hook_civicrm_config never executes.
 608     $config = CRM_Core_Config::singleton();
 609     CRM_Utils_Hook::config($config);
 610
 611     return TRUE;
 612   }
 613
 614   /**
 615    * @inheritDoc
 616    */
 617   public function isUserLoggedIn() {
 618     $user = JFactory::getUser();
 619     return ($user->guest) ? FALSE : TRUE;
 620   }
 621
 622   /**
 623    * @inheritDoc
 624    */
 625   public function isUserRegistrationPermitted() {
 626     $userParams = JComponentHelper::getParams('com_users');
 627     if (!$userParams->get('allowUserRegistration')) {
 628       return FALSE;
 629     }
 630     return TRUE;
 631   }
 632
 633   /**
 634    * @inheritDoc
 635    */
 636   public function isPasswordUserGenerated() {
 637     return TRUE;
 638   }
 639
 640   /**
 641    * @inheritDoc
 642    */
 643   public function getLoggedInUfID() {
 644     $user = JFactory::getUser();
 645     return ($user->guest) ? NULL : $user->id;
 646   }
 647
 648   /**
 649    * @inheritDoc
 650    */
 651   public function getLoggedInUniqueIdentifier() {
 652     $user = JFactory::getUser();
 653     return $this->getUniqueIdentifierFromUserObject($user);
 654   }
 655
 656   /**
 657    * @inheritDoc
 658    */
 659   public function getUser($contactID) {
 660     $user_details = parent::getUser($contactID);
 661     $user = JFactory::getUser($user_details['id']);
 662     $user_details['name'] = $user->name;
 663     return $user_details;
 664   }
 665
 666   /**
 667    * @inheritDoc
 668    */
 669   public function getUserIDFromUserObject($user) {
 670     return !empty($user->id) ? $user->id : NULL;
 671   }
 672
 673   /**
 674    * @inheritDoc
 675    */
 676   public function getUniqueIdentifierFromUserObject($user) {
 677     return ($user->guest) ? NULL : $user->email;
 678   }
 679
 680   /**
 681    * @inheritDoc
 682    */
 683   public function getTimeZoneString() {
 684     $timezone = JFactory::getConfig()->get('offset');
 685     return !$timezone ? date_default_timezone_get() : $timezone;
 686   }
 687
 688   /**
 689    * Get a list of all installed modules, including enabled and disabled ones
 690    *
 691    * @return array
 692    *   CRM_Core_Module
 693    */
 694   public function getModules() {
 695     $result = [];
 696
 697     $db = JFactory::getDbo();
 698     $query = $db->getQuery(TRUE);
 699     $query->select('type, folder, element, enabled')
 700       ->from('#__extensions')
 701       ->where('type =' . $db->Quote('plugin'));
 702     $plugins = $db->setQuery($query)->loadAssocList();
 703     foreach ($plugins as $plugin) {
 704       // question: is the folder really a critical part of the plugin's name?
 705       $name = implode('.', ['joomla', $plugin['type'], $plugin['folder'], $plugin['element']]);
 706       $result[] = new CRM_Core_Module($name, $plugin['enabled'] ? TRUE : FALSE);
 707     }
 708
 709     return $result;
 710   }
 711
 712   /**
 713    * @inheritDoc
 714    */
 715   public function getLoginURL($destination = '') {
 716     $config = CRM_Core_Config::singleton();
 717     $loginURL = $config->userFrameworkBaseURL;
 718     $loginURL = str_replace('administrator/', '', $loginURL);
 719     $loginURL .= 'index.php?option=com_users&view=login';
 720
 721     //CRM-14872 append destination
 722     if (!empty($destination)) {
 723       $loginURL .= '&return=' . urlencode(base64_encode($destination));
 724     }
 725     return $loginURL;
 726   }
 727
 728   /**
 729    * @inheritDoc
 730    */
 731   public function getLoginDestination(&$form) {
 732     $args = NULL;
 733
 734     $id = $form->get('id');
 735     if ($id) {
 736       $args .= "&id=$id";
 737     }
 738     else {
 739       $gid = $form->get('gid');
 740       if ($gid) {
 741         $args .= "&gid=$gid";
 742       }
 743       else {
 744         // Setup Personal Campaign Page link uses pageId
 745         $pageId = $form->get('pageId');
 746         if ($pageId) {
 747           $component = $form->get('component');
 748           $args .= "&pageId=$pageId&component=$component&action=add";
 749         }
 750       }
 751     }
 752
 753     $destination = NULL;
 754     if ($args) {
 755       // append destination so user is returned to form they came from after login
 756       $args = 'reset=1' . $args;
 757       $destination = CRM_Utils_System::url(CRM_Utils_System::currentPath(), $args, TRUE, NULL, FALSE, TRUE);
 758     }
 759
 760     return $destination;
 761   }
 762
 763   /**
 764    * Determine the location of the CMS root.
 765    *
 766    * @return string|NULL
 767    *   local file system path to CMS root, or NULL if it cannot be determined
 768    */
 769   public function cmsRootPath() {
 770     global $civicrm_paths;
 771     if (!empty($civicrm_paths['cms.root']['path'])) {
 772       return $civicrm_paths['cms.root']['path'];
 773     }
 774
 775     list($url, $siteName, $siteRoot) = $this->getDefaultSiteSettings();
 776     if (file_exists("$siteRoot/administrator/index.php")) {
 777       return $siteRoot;
 778     }
 779     return NULL;
 780   }
 781
 782   /**
 783    * @inheritDoc
 784    */
 785   public function getDefaultSiteSettings($dir = NULL) {
 786     $config = CRM_Core_Config::singleton();
 787     $url = preg_replace(
 788       '|/administrator|',
 789       '',
 790       $config->userFrameworkBaseURL
 791     );
 792     // CRM-19453 revisited. Under Windows, the pattern wasn't recognised.
 793     // This is the original pattern, but it doesn't work under Windows.
 794     // By setting the pattern to the one used before the change first and only
 795     // changing it means that the change code only affects Windows users.
 796     $pattern = '|/media/civicrm/.*$|';
 797     if (DIRECTORY_SEPARATOR == '\\') {
 798       // This regular expression will handle Windows as well as Linux
 799       // and any combination of forward and back slashes in directory
 800       // separators.  We only apply it if the directory separator is the one
 801       // used by Windows.
 802       $pattern = '|[\\\\/]media[\\\\/]civicrm[\\\\/].*$|';
 803     }
 804     $siteRoot = preg_replace(
 805       $pattern,
 806       '',
 807       $config->imageUploadDir
 808     );
 809     return [$url, NULL, $siteRoot];
 810   }
 811
 812   /**
 813    * @inheritDoc
 814    */
 815   public function getUserRecordUrl($contactID) {
 816     $uid = CRM_Core_BAO_UFMatch::getUFId($contactID);
 817     $userRecordUrl = NULL;
 818     // if logged in user has user edit access, then allow link to other users joomla profile
 819     if (JFactory::getUser()->authorise('core.edit', 'com_users')) {
 820       return CRM_Core_Config::singleton()->userFrameworkBaseURL . "index.php?option=com_users&view=user&task=user.edit&id=" . $uid;
 821     }
 822     elseif (CRM_Core_Session::singleton()->get('userID') == $contactID) {
 823       return CRM_Core_Config::singleton()->userFrameworkBaseURL . "index.php?option=com_admin&view=profile&layout=edit&id=" . $uid;
 824     }
 825   }
 826
 827   /**
 828    * @inheritDoc
 829    */
 830   public function checkPermissionAddUser() {
 831     if (JFactory::getUser()->authorise('core.create', 'com_users')) {
 832       return TRUE;
 833     }
 834   }
 835
 836   /**
 837    * Output code from error function.
 838    * @param string $content
 839    */
 840   public function outputError($content) {
 841     if (class_exists('JErrorPage')) {
 842       $error = new Exception($content);
 843       JErrorPage::render($error);
 844     }
 845     elseif (class_exists('JError')) {
 846       JError::raiseError('CiviCRM-001', $content);
 847     }
 848     else {
 849       parent::outputError($content);
 850     }
 851   }
 852
 853   /**
 854    * @inheritDoc
 855    */
 856   public function synchronizeUsers() {
 857     $config = CRM_Core_Config::singleton();
 858     if (PHP_SAPI != 'cli') {
 859       set_time_limit(300);
 860     }
 861     $id = 'id';
 862     $mail = 'email';
 863     $name = 'name';
 864
 865     $JUserTable = &JTable::getInstance('User', 'JTable');
 866
 867     $db = $JUserTable->getDbo();
 868     $query = $db->getQuery(TRUE);
 869     $query->select($id . ', ' . $mail . ', ' . $name);
 870     $query->from($JUserTable->getTableName());
 871     $query->where($mail != '');
 872
 873     $db->setQuery($query);
 874     $users = $db->loadObjectList();
 875
 876     $user = new StdClass();
 877     $uf = $config->userFramework;
 878     $contactCount = 0;
 879     $contactCreated = 0;
 880     $contactMatching = 0;
 881     for ($i = 0; $i < count($users); $i++) {
 882       $user->$id = $users[$i]->$id;
 883       $user->$mail = $users[$i]->$mail;
 884       $user->$name = $users[$i]->$name;
 885       $contactCount++;
 886       if ($match = CRM_Core_BAO_UFMatch::synchronizeUFMatch($user,
 887         $users[$i]->$id,
 888         $users[$i]->$mail,
 889         $uf,
 890         1,
 891         'Individual',
 892         TRUE
 893       )
 894       ) {
 895         $contactCreated++;
 896       }
 897       else {
 898         $contactMatching++;
 899       }
 900     }
 901
 902     return [
 903       'contactCount' => $contactCount,
 904       'contactMatching' => $contactMatching,
 905       'contactCreated' => $contactCreated,
 906     ];
 907   }
 908
 909 }