CRM/Utils/System.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  * System wide utilities.
  20  *
  21  * Provides a collection of Civi utilities + access to the CMS-dependant utilities
  22  *
  23  * FIXME: This is a massive and random collection that could be split into smaller services
  24  *
  25  * @method static mixed permissionDenied() Show access denied screen.
  26  * @method static mixed logout() Log out the current user.
  27  * @method static mixed updateCategories() Clear CMS caches related to the user registration/profile forms.
  28  * @method static appendBreadCrumb(array $breadCrumbs) Append an additional breadcrumb tag to the existing breadcrumbs.
  29  * @method static resetBreadCrumb() Reset an additional breadcrumb tag to the existing breadcrumb.
  30  * @method static addHTMLHead(string $bc) Append a string to the head of the HTML file.
  31  * @method static string postURL(int $action) Determine the post URL for a form.
  32  * @method static string|null getUFLocale() Get the locale of the CMS.
  33  * @method static bool setUFLocale(string $civicrm_language) Set the locale of the CMS.
  34  * @method static bool isUserLoggedIn() Check if user is logged in.
  35  * @method static int getLoggedInUfID() Get current logged in user id.
  36  * @method static setHttpHeader(string $name, string $value) Set http header.
  37  * @method static array synchronizeUsers() Create CRM contacts for all existing CMS users.
  38  * @method static appendCoreResources(\Civi\Core\Event\GenericHookEvent $e) Callback for hook_civicrm_coreResourceList.
  39  * @method static alterAssetUrl(\Civi\Core\Event\GenericHookEvent $e) Callback for hook_civicrm_getAssetUrl.
  40  */
  41 class CRM_Utils_System {
  42
  43   public static $_callbacks = NULL;
  44
  45   /**
  46    * @var string
  47    *   Page title
  48    */
  49   public static $title = '';
  50
  51   /**
  52    * Access methods in the appropriate CMS class
  53    *
  54    * @param $name
  55    * @param $arguments
  56    * @return mixed
  57    */
  58   public static function __callStatic($name, $arguments) {
  59     $userSystem = CRM_Core_Config::singleton()->userSystem;
  60     return call_user_func_array([$userSystem, $name], $arguments);
  61   }
  62
  63   /**
  64    * Compose a new URL string from the current URL string.
  65    *
  66    * Used by all the framework components, specifically,
  67    * pager, sort and qfc
  68    *
  69    * @param string $urlVar
  70    *   The url variable being considered (i.e. crmPageID, crmSortID etc).
  71    * @param bool $includeReset
  72    *   (optional) Whether to include the reset GET string (if present).
  73    * @param bool $includeForce
  74    *   (optional) Whether to include the force GET string (if present).
  75    * @param string $path
  76    *   (optional) The path to use for the new url.
  77    * @param bool|string $absolute
  78    *   (optional) Whether to return an absolute URL.
  79    *
  80    * @return string
  81    *   The URL fragment.
  82    */
  83   public static function makeURL($urlVar, $includeReset = FALSE, $includeForce = TRUE, $path = NULL, $absolute = FALSE) {
  84     if (empty($path)) {
  85       $config = CRM_Core_Config::singleton();
  86       $path = CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET);
  87       if (empty($path)) {
  88         return '';
  89       }
  90     }
  91
  92     return self::url(
  93         $path,
  94         CRM_Utils_System::getLinksUrl($urlVar, $includeReset, $includeForce),
  95         $absolute
  96       );
  97   }
  98
  99   /**
 100    * Get the query string and clean it up.
 101    *
 102    * Strips some variables that should not be propagated, specifically variables
 103    * like 'reset'. Also strips any side-affect actions (e.g. export).
 104    *
 105    * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
 106    *
 107    * @param string $urlVar
 108    *   The URL variable being considered (e.g. crmPageID, crmSortID etc).
 109    * @param bool $includeReset
 110    *   (optional) By default this is FALSE, meaning that the reset parameter
 111    *   is skipped. Set to TRUE to leave the reset parameter as-is.
 112    * @param bool $includeForce
 113    *   (optional)
 114    * @param bool $skipUFVar
 115    *   (optional)
 116    *
 117    * @return string
 118    */
 119   public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
 120     // Sort out query string to prevent messy urls
 121     $querystring = [];
 122     $qs = [];
 123     $arrays = [];
 124
 125     if (!empty($_SERVER['QUERY_STRING'])) {
 126       $qs = explode('&', str_replace('&amp;', '&', $_SERVER['QUERY_STRING']));
 127       for ($i = 0, $cnt = count($qs); $i < $cnt; $i++) {
 128         // check first if exist a pair
 129         if (strstr($qs[$i], '=') !== FALSE) {
 130           list($name, $value) = explode('=', $qs[$i]);
 131           if ($name != $urlVar) {
 132             $name = rawurldecode($name);
 133             // check for arrays in parameters: site.php?foo[]=1&foo[]=2&foo[]=3
 134             if ((strpos($name, '[') !== FALSE) &&
 135               (strpos($name, ']') !== FALSE)
 136             ) {
 137               $arrays[] = $qs[$i];
 138             }
 139             else {
 140               $qs[$name] = $value;
 141             }
 142           }
 143         }
 144         else {
 145           $qs[$qs[$i]] = '';
 146         }
 147         unset($qs[$i]);
 148       }
 149     }
 150
 151     if ($includeForce) {
 152       $qs['force'] = 1;
 153     }
 154
 155     // Ok this is a big assumption but usually works
 156     // If we are in snippet mode, retain the 'section' param, if not, get rid
 157     // of it.
 158     if (!empty($qs['snippet'])) {
 159       unset($qs['snippet']);
 160     }
 161     else {
 162       unset($qs['section']);
 163     }
 164
 165     if ($skipUFVar) {
 166       $config = CRM_Core_Config::singleton();
 167       unset($qs[$config->userFrameworkURLVar]);
 168     }
 169
 170     foreach ($qs as $name => $value) {
 171       if ($name != 'reset' || $includeReset) {
 172         $querystring[] = $name . '=' . $value;
 173       }
 174     }
 175
 176     $querystring = array_merge($querystring, array_unique($arrays));
 177
 178     $url = implode('&', $querystring);
 179     if ($urlVar) {
 180       $url .= (!empty($querystring) ? '&' : '') . $urlVar . '=';
 181     }
 182
 183     return $url;
 184   }
 185
 186   /**
 187    * If we are using a theming system, invoke theme, else just print the content.
 188    *
 189    * @param string $content
 190    *   The content that will be themed.
 191    * @param bool $print
 192    *   (optional) Are we displaying to the screen or bypassing theming?
 193    * @param bool $maintenance
 194    *   (optional) For maintenance mode.
 195    *
 196    * @return string
 197    */
 198   public static function theme(
 199     &$content,
 200     $print = FALSE,
 201     $maintenance = FALSE
 202   ) {
 203     return CRM_Core_Config::singleton()->userSystem->theme($content, $print, $maintenance);
 204   }
 205
 206   /**
 207    * Generate a query string if input is an array.
 208    *
 209    * @param array|string $query
 210    *
 211    * @return string
 212    */
 213   public static function makeQueryString($query) {
 214     if (is_array($query)) {
 215       $buf = '';
 216       foreach ($query as $key => $value) {
 217         $buf .= ($buf ? '&' : '') . urlencode($key) . '=' . urlencode($value);
 218       }
 219       $query = $buf;
 220     }
 221     return $query;
 222   }
 223
 224   /**
 225    * Generate an internal CiviCRM URL.
 226    *
 227    * @param string $path
 228    *   The path being linked to, such as "civicrm/add".
 229    * @param array|string $query
 230    *   A query string to append to the link, or an array of key-value pairs.
 231    * @param bool $absolute
 232    *   Whether to force the output to be an absolute link (beginning with a
 233    *   URI-scheme such as 'http:'). Useful for links that will be displayed
 234    *   outside the site, such as in an RSS feed.
 235    * @param string $fragment
 236    *   A fragment identifier (named anchor) to append to the link.
 237    * @param bool $htmlize
 238    *   Whether to encode special html characters such as &.
 239    * @param bool $frontend
 240    *   This link should be to the CMS front end (applies to WP & Joomla).
 241    * @param bool $forceBackend
 242    *   This link should be to the CMS back end (applies to WP & Joomla).
 243    *
 244    * @return string
 245    *   An HTML string containing a link to the given path.
 246    */
 247   public static function url(
 248     $path = NULL,
 249     $query = NULL,
 250     $absolute = FALSE,
 251     $fragment = NULL,
 252     $htmlize = TRUE,
 253     $frontend = FALSE,
 254     $forceBackend = FALSE
 255   ) {
 256     $query = self::makeQueryString($query);
 257
 258     // Legacy handling for when the system passes around html escaped strings
 259     if (strstr($query, '&amp;')) {
 260       $query = html_entity_decode($query);
 261     }
 262
 263     // Extract fragment from path or query if munged together
 264     if ($query && strstr($query, '#')) {
 265       list($path, $fragment) = explode('#', $query);
 266     }
 267     if ($path && strstr($path, '#')) {
 268       list($path, $fragment) = explode('#', $path);
 269     }
 270
 271     // Extract query from path if munged together
 272     if ($path && strstr($path, '?')) {
 273       list($path, $extraQuery) = explode('?', $path);
 274       $query = $extraQuery . ($query ? "&$query" : '');
 275     }
 276
 277     $config = CRM_Core_Config::singleton();
 278     $url = $config->userSystem->url($path, $query, $absolute, $fragment, $frontend, $forceBackend);
 279
 280     if ($htmlize) {
 281       $url = htmlentities($url);
 282     }
 283
 284     return $url;
 285   }
 286
 287   /**
 288    * Path of the current page e.g. 'civicrm/contact/view'
 289    *
 290    * @return string|null
 291    */
 292   public static function getUrlPath() {
 293     if (isset($_GET[CRM_Core_Config::singleton()->userFrameworkURLVar])) {
 294       return $_GET[CRM_Core_Config::singleton()->userFrameworkURLVar];
 295     }
 296     return NULL;
 297   }
 298
 299   /**
 300    * Get href.
 301    *
 302    * @param string $text
 303    * @param string $path
 304    * @param string|array $query
 305    * @param bool $absolute
 306    * @param string $fragment
 307    * @param bool $htmlize
 308    * @param bool $frontend
 309    * @param bool $forceBackend
 310    *
 311    * @return string
 312    */
 313   public static function href(
 314     $text, $path = NULL, $query = NULL, $absolute = TRUE,
 315     $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
 316   ) {
 317     $url = self::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
 318     return "<a href=\"$url\">$text</a>";
 319   }
 320
 321   /**
 322    * What menu path are we currently on. Called for the primary tpl.
 323    *
 324    * @return string
 325    *   the current menu path
 326    */
 327   public static function currentPath() {
 328     $config = CRM_Core_Config::singleton();
 329     return trim(CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET), '/');
 330   }
 331
 332   /**
 333    * Called from a template to compose a url.
 334    *
 335    * @param array $params
 336    *   List of parameters.
 337    *
 338    * @return string
 339    *   url
 340    */
 341   public static function crmURL($params) {
 342     $p = CRM_Utils_Array::value('p', $params);
 343     if (!isset($p)) {
 344       $p = self::currentPath();
 345     }
 346
 347     return self::url(
 348       $p,
 349       CRM_Utils_Array::value('q', $params),
 350       CRM_Utils_Array::value('a', $params, FALSE),
 351       CRM_Utils_Array::value('f', $params),
 352       CRM_Utils_Array::value('h', $params, TRUE),
 353       CRM_Utils_Array::value('fe', $params, FALSE),
 354       CRM_Utils_Array::value('fb', $params, FALSE)
 355     );
 356   }
 357
 358   /**
 359    * Sets the title of the page.
 360    *
 361    * @param string $title
 362    *   Document title - plain text only
 363    * @param string $pageTitle
 364    *   Page title (if different) - may include html
 365    */
 366   public static function setTitle($title, $pageTitle = NULL) {
 367     self::$title = $title;
 368     $config = CRM_Core_Config::singleton();
 369     return $config->userSystem->setTitle($title, $pageTitle);
 370   }
 371
 372   /**
 373    * Figures and sets the userContext.
 374    *
 375    * Uses the referrer if valid else uses the default.
 376    *
 377    * @param array $names
 378    *   Referrer should match any str in this array.
 379    * @param string $default
 380    *   (optional) The default userContext if no match found.
 381    */
 382   public static function setUserContext($names, $default = NULL) {
 383     $url = $default;
 384
 385     $session = CRM_Core_Session::singleton();
 386     $referer = CRM_Utils_Array::value('HTTP_REFERER', $_SERVER);
 387
 388     if ($referer && !empty($names)) {
 389       foreach ($names as $name) {
 390         if (strstr($referer, $name)) {
 391           $url = $referer;
 392           break;
 393         }
 394       }
 395     }
 396
 397     if ($url) {
 398       $session->pushUserContext($url);
 399     }
 400   }
 401
 402   /**
 403    * Gets a class name for an object.
 404    *
 405    * @param object $object
 406    *   Object whose class name is needed.
 407    *
 408    * @return string
 409    *   The class name of the object.
 410    */
 411   public static function getClassName($object) {
 412     return get_class($object);
 413   }
 414
 415   /**
 416    * Redirect to another URL.
 417    *
 418    * @param string $url
 419    *   The URL to provide to the browser via the Location header.
 420    * @param array $context
 421    *   Optional additional information for the hook.
 422    */
 423   public static function redirect($url = NULL, $context = []) {
 424     if (!$url) {
 425       $url = self::url('civicrm/dashboard', 'reset=1');
 426     }
 427     // replace the &amp; characters with &
 428     // this is kinda hackish but not sure how to do it right
 429     $url = str_replace('&amp;', '&', $url);
 430
 431     $context['output'] = CRM_Utils_Array::value('snippet', $_GET);
 432
 433     $parsedUrl = CRM_Utils_Url::parseUrl($url);
 434     CRM_Utils_Hook::alterRedirect($parsedUrl, $context);
 435     $url = CRM_Utils_Url::unparseUrl($parsedUrl);
 436
 437     // If we are in a json context, respond appropriately
 438     if ($context['output'] === 'json') {
 439       CRM_Core_Page_AJAX::returnJsonResponse([
 440         'status' => 'redirect',
 441         'userContext' => $url,
 442       ]);
 443     }
 444
 445     self::setHttpHeader('Location', $url);
 446     self::civiExit();
 447   }
 448
 449   /**
 450    * Redirect to another URL using JavaScript.
 451    *
 452    * Use an html based file with javascript embedded to redirect to another url
 453    * This prevent the too many redirect errors emitted by various browsers
 454    *
 455    * @param string $url
 456    *   (optional) The destination URL.
 457    * @param string $title
 458    *   (optional) The page title to use for the redirect page.
 459    * @param string $message
 460    *   (optional) The message to provide in the body of the redirect page.
 461    */
 462   public static function jsRedirect(
 463     $url = NULL,
 464     $title = NULL,
 465     $message = NULL
 466   ) {
 467     if (!$url) {
 468       $url = self::url('civicrm/dashboard', 'reset=1');
 469     }
 470
 471     if (!$title) {
 472       $title = ts('CiviCRM task in progress');
 473     }
 474
 475     if (!$message) {
 476       $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
 477     }
 478
 479     // replace the &amp; characters with &
 480     // this is kinda hackish but not sure how to do it right
 481     $url = str_replace('&amp;', '&', $url);
 482
 483     $template = CRM_Core_Smarty::singleton();
 484     $template->assign('redirectURL', $url);
 485     $template->assign('title', $title);
 486     $template->assign('message', $message);
 487
 488     $html = $template->fetch('CRM/common/redirectJS.tpl');
 489
 490     echo $html;
 491
 492     self::civiExit();
 493   }
 494
 495   /**
 496    * Get the base URL of the system.
 497    *
 498    * @return string
 499    */
 500   public static function baseURL() {
 501     $config = CRM_Core_Config::singleton();
 502     return $config->userFrameworkBaseURL;
 503   }
 504
 505   /**
 506    * Authenticate or abort.
 507    *
 508    * @param string $message
 509    * @param bool $abort
 510    *
 511    * @return bool
 512    */
 513   public static function authenticateAbort($message, $abort) {
 514     if ($abort) {
 515       echo $message;
 516       self::civiExit(0);
 517     }
 518     else {
 519       return FALSE;
 520     }
 521   }
 522
 523   /**
 524    * Authenticate key.
 525    *
 526    * @param bool $abort
 527    *   (optional) Whether to exit; defaults to true.
 528    *
 529    * @return bool
 530    */
 531   public static function authenticateKey($abort = TRUE) {
 532     // also make sure the key is sent and is valid
 533     $key = trim(CRM_Utils_Array::value('key', $_REQUEST));
 534
 535     $docAdd = "More info at:" . CRM_Utils_System::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
 536
 537     if (!$key) {
 538       return self::authenticateAbort(
 539         "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
 540         $abort
 541       );
 542     }
 543
 544     $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : NULL;
 545
 546     if (!$siteKey || empty($siteKey)) {
 547       return self::authenticateAbort(
 548         "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
 549         $abort
 550       );
 551     }
 552
 553     if (strlen($siteKey) < 8) {
 554       return self::authenticateAbort(
 555         "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
 556         $abort
 557       );
 558     }
 559
 560     if ($key !== $siteKey) {
 561       return self::authenticateAbort(
 562         "ERROR: Invalid key value sent. " . $docAdd . "\n",
 563         $abort
 564       );
 565     }
 566
 567     return TRUE;
 568   }
 569
 570   /**
 571    * Authenticate script.
 572    *
 573    * @param bool $abort
 574    * @param string $name
 575    * @param string $pass
 576    * @param bool $storeInSession
 577    * @param bool $loadCMSBootstrap
 578    * @param bool $requireKey
 579    *
 580    * @return bool
 581    */
 582   public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
 583     // auth to make sure the user has a login/password to do a shell operation
 584     // later on we'll link this to acl's
 585     if (!$name) {
 586       $name = trim(CRM_Utils_Array::value('name', $_REQUEST));
 587       $pass = trim(CRM_Utils_Array::value('pass', $_REQUEST));
 588     }
 589
 590     // its ok to have an empty password
 591     if (!$name) {
 592       return self::authenticateAbort(
 593         "ERROR: You need to send a valid user name and password to execute this file\n",
 594         $abort
 595       );
 596     }
 597
 598     if ($requireKey && !self::authenticateKey($abort)) {
 599       return FALSE;
 600     }
 601
 602     $result = CRM_Utils_System::authenticate($name, $pass, $loadCMSBootstrap);
 603     if (!$result) {
 604       return self::authenticateAbort(
 605         "ERROR: Invalid username and/or password\n",
 606         $abort
 607       );
 608     }
 609     elseif ($storeInSession) {
 610       // lets store contact id and user id in session
 611       list($userID, $ufID, $randomNumber) = $result;
 612       if ($userID && $ufID) {
 613         $config = CRM_Core_Config::singleton();
 614         $config->userSystem->setUserSession([$userID, $ufID]);
 615       }
 616       else {
 617         return self::authenticateAbort(
 618           "ERROR: Unexpected error, could not match userID and contactID",
 619           $abort
 620         );
 621       }
 622     }
 623
 624     return $result;
 625   }
 626
 627   /**
 628    * Authenticate the user against the uf db.
 629    *
 630    * In case of successful authentication, returns an array consisting of
 631    * (contactID, ufID, unique string). Returns FALSE if authentication is
 632    * unsuccessful.
 633    *
 634    * @param string $name
 635    *   The username.
 636    * @param string $password
 637    *   The password.
 638    * @param bool $loadCMSBootstrap
 639    * @param string $realPath
 640    *
 641    * @return false|array
 642    */
 643   public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
 644     $config = CRM_Core_Config::singleton();
 645
 646     /* Before we do any loading, let's start the session and write to it.
 647      * We typically call authenticate only when we need to bootstrap the CMS
 648      * directly via Civi and hence bypass the normal CMS auth and bootstrap
 649      * process typically done in CLI and cron scripts. See: CRM-12648
 650      *
 651      * Q: Can we move this to the userSystem class so that it can be tuned
 652      * per-CMS? For example, when dealing with UnitTests UF, there's no
 653      * userFrameworkDSN.
 654      */
 655     $session = CRM_Core_Session::singleton();
 656     $session->set('civicrmInitSession', TRUE);
 657
 658     if ($config->userFrameworkDSN) {
 659       $dbDrupal = DB::connect($config->userFrameworkDSN);
 660     }
 661     return $config->userSystem->authenticate($name, $password, $loadCMSBootstrap, $realPath);
 662   }
 663
 664   /**
 665    * Set a message in the UF to display to a user.
 666    *
 667    * @param string $message
 668    *   The message to set.
 669    */
 670   public static function setUFMessage($message) {
 671     $config = CRM_Core_Config::singleton();
 672     return $config->userSystem->setMessage($message);
 673   }
 674
 675   /**
 676    * Determine whether a value is null-ish.
 677    *
 678    * @param mixed $value
 679    *   The value to check for null.
 680    *
 681    * @return bool
 682    */
 683   public static function isNull($value) {
 684     // FIXME: remove $value = 'null' string test when we upgrade our DAO code to handle passing null in a better way.
 685     if (!isset($value) || $value === NULL || $value === '' || $value === 'null') {
 686       return TRUE;
 687     }
 688     if (is_array($value)) {
 689       // @todo Reuse of the $value variable = asking for trouble.
 690       foreach ($value as $key => $value) {
 691         if (in_array($key, CRM_Core_DAO::acceptedSQLOperators(), TRUE) || !self::isNull($value)) {
 692           return FALSE;
 693         }
 694       }
 695       return TRUE;
 696     }
 697     return FALSE;
 698   }
 699
 700   /**
 701    * Obscure all but the last few digits of a credit card number.
 702    *
 703    * @param string $number
 704    *   The credit card number to obscure.
 705    * @param int $keep
 706    *   (optional) The number of digits to preserve unmodified.
 707    *
 708    * @return string
 709    *   The obscured credit card number.
 710    */
 711   public static function mungeCreditCard($number, $keep = 4) {
 712     $number = trim($number);
 713     if (empty($number)) {
 714       return NULL;
 715     }
 716     $replace = str_repeat('*', strlen($number) - $keep);
 717     return substr_replace($number, $replace, 0, -$keep);
 718   }
 719
 720   /**
 721    * Determine which PHP modules are loaded.
 722    *
 723    * @return array
 724    */
 725   private static function parsePHPModules() {
 726     ob_start();
 727     phpinfo(INFO_MODULES);
 728     $s = ob_get_contents();
 729     ob_end_clean();
 730
 731     $s = strip_tags($s, '<h2><th><td>');
 732     $s = preg_replace('/<th[^>]*>([^<]+)<\/th>/', "<info>\\1</info>", $s);
 733     $s = preg_replace('/<td[^>]*>([^<]+)<\/td>/', "<info>\\1</info>", $s);
 734     $vTmp = preg_split('/(<h2>[^<]+<\/h2>)/', $s, -1, PREG_SPLIT_DELIM_CAPTURE);
 735     $vModules = [];
 736     for ($i = 1; $i < count($vTmp); $i++) {
 737       if (preg_match('/<h2>([^<]+)<\/h2>/', $vTmp[$i], $vMat)) {
 738         $vName = trim($vMat[1]);
 739         $vTmp2 = explode("\n", $vTmp[$i + 1]);
 740         foreach ($vTmp2 as $vOne) {
 741           $vPat = '<info>([^<]+)<\/info>';
 742           $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
 743           $vPat2 = "/$vPat\s*$vPat/";
 744           // 3cols
 745           if (preg_match($vPat3, $vOne, $vMat)) {
 746             $vModules[$vName][trim($vMat[1])] = [trim($vMat[2]), trim($vMat[3])];
 747             // 2cols
 748           }
 749           elseif (preg_match($vPat2, $vOne, $vMat)) {
 750             $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
 751           }
 752         }
 753       }
 754     }
 755     return $vModules;
 756   }
 757
 758   /**
 759    * Get a setting from a loaded PHP module.
 760    *
 761    * @param string $pModuleName
 762    * @param string $pSetting
 763    *
 764    * @return mixed
 765    */
 766   public static function getModuleSetting($pModuleName, $pSetting) {
 767     $vModules = self::parsePHPModules();
 768     return $vModules[$pModuleName][$pSetting];
 769   }
 770
 771   /**
 772    * Do something no-one bothered to document.
 773    *
 774    * @param string $title
 775    *   (optional)
 776    *
 777    * @return mixed|string
 778    */
 779   public static function memory($title = NULL) {
 780     static $pid = NULL;
 781     if (!$pid) {
 782       $pid = posix_getpid();
 783     }
 784
 785     $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
 786     $memory .= ", " . time();
 787     if ($title) {
 788       CRM_Core_Error::debug_var($title, $memory);
 789     }
 790     return $memory;
 791   }
 792
 793   /**
 794    * Download something or other.
 795    *
 796    * @param string $name
 797    * @param string $mimeType
 798    * @param string $buffer
 799    * @param string $ext
 800    * @param bool $output
 801    * @param string $disposition
 802    */
 803   public static function download(
 804     $name, $mimeType, &$buffer,
 805     $ext = NULL,
 806     $output = TRUE,
 807     $disposition = 'attachment'
 808   ) {
 809     $now = gmdate('D, d M Y H:i:s') . ' GMT';
 810
 811     self::setHttpHeader('Content-Type', $mimeType);
 812     self::setHttpHeader('Expires', $now);
 813
 814     // lem9 & loic1: IE needs specific headers
 815     $isIE = empty($_SERVER['HTTP_USER_AGENT']) ? FALSE : strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
 816     if ($ext) {
 817       $fileString = "filename=\"{$name}.{$ext}\"";
 818     }
 819     else {
 820       $fileString = "filename=\"{$name}\"";
 821     }
 822     if ($isIE) {
 823       self::setHttpHeader("Content-Disposition", "inline; $fileString");
 824       self::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
 825       self::setHttpHeader('Pragma', 'public');
 826     }
 827     else {
 828       self::setHttpHeader("Content-Disposition", "$disposition; $fileString");
 829       self::setHttpHeader('Pragma', 'no-cache');
 830     }
 831
 832     if ($output) {
 833       print $buffer;
 834       self::civiExit();
 835     }
 836   }
 837
 838   /**
 839    * Gather and print (and possibly log) amount of used memory.
 840    *
 841    * @param string $title
 842    * @param bool $log
 843    *   (optional) Whether to log the memory usage information.
 844    */
 845   public static function xMemory($title = NULL, $log = FALSE) {
 846     $mem = (float ) xdebug_memory_usage() / (float ) (1024);
 847     $mem = number_format($mem, 5) . ", " . time();
 848     if ($log) {
 849       echo "<p>$title: $mem<p>";
 850       flush();
 851       CRM_Core_Error::debug_var($title, $mem);
 852     }
 853     else {
 854       echo "<p>$title: $mem<p>";
 855       flush();
 856     }
 857   }
 858
 859   /**
 860    * Take a URL (or partial URL) and make it better.
 861    *
 862    * Currently, URLs pass straight through unchanged unless they are "seriously
 863    * malformed" (see http://us2.php.net/parse_url).
 864    *
 865    * @param string $url
 866    *   The URL to operate on.
 867    *
 868    * @return string
 869    *   The fixed URL.
 870    */
 871   public static function fixURL($url) {
 872     $components = parse_url($url);
 873
 874     if (!$components) {
 875       return NULL;
 876     }
 877
 878     // at some point we'll add code here to make sure the url is not
 879     // something that will mess up, so we need to clean it up here
 880     return $url;
 881   }
 882
 883   /**
 884    * Make sure a callback is valid in the current context.
 885    *
 886    * @param string $callback
 887    *   Name of the function to check.
 888    *
 889    * @return bool
 890    */
 891   public static function validCallback($callback) {
 892     if (self::$_callbacks === NULL) {
 893       self::$_callbacks = [];
 894     }
 895
 896     if (!array_key_exists($callback, self::$_callbacks)) {
 897       if (strpos($callback, '::') !== FALSE) {
 898         list($className, $methodName) = explode('::', $callback);
 899         $fileName = str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
 900         // ignore errors if any
 901         @include_once $fileName;
 902         if (!class_exists($className)) {
 903           self::$_callbacks[$callback] = FALSE;
 904         }
 905         else {
 906           // instantiate the class
 907           $object = new $className();
 908           if (!method_exists($object, $methodName)) {
 909             self::$_callbacks[$callback] = FALSE;
 910           }
 911           else {
 912             self::$_callbacks[$callback] = TRUE;
 913           }
 914         }
 915       }
 916       else {
 917         self::$_callbacks[$callback] = function_exists($callback);
 918       }
 919     }
 920     return self::$_callbacks[$callback];
 921   }
 922
 923   /**
 924    * Like PHP's built-in explode(), but always return an array of $limit items.
 925    *
 926    * This serves as a wrapper to the PHP explode() function. In the event that
 927    * PHP's explode() returns an array with fewer than $limit elements, pad
 928    * the end of the array with NULLs.
 929    *
 930    * @param string $separator
 931    * @param string $string
 932    * @param int $limit
 933    *
 934    * @return string[]
 935    */
 936   public static function explode($separator, $string, $limit) {
 937     $result = explode($separator, $string, $limit);
 938     for ($i = count($result); $i < $limit; $i++) {
 939       $result[$i] = NULL;
 940     }
 941     return $result;
 942   }
 943
 944   /**
 945    * Check url.
 946    *
 947    * @param string $url
 948    *   The URL to check.
 949    * @param bool $addCookie
 950    *   (optional)
 951    *
 952    * @return mixed
 953    */
 954   public static function checkURL($url, $addCookie = FALSE) {
 955     // make a GET request to $url
 956     $ch = curl_init($url);
 957     if ($addCookie) {
 958       curl_setopt($ch, CURLOPT_COOKIE, http_build_query($_COOKIE));
 959     }
 960     // it's quite alright to use a self-signed cert
 961     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
 962
 963     // lets capture the return stuff rather than echo
 964     curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
 965
 966     // CRM-13227, CRM-14744: only return the SSL error status
 967     return (curl_exec($ch) !== FALSE);
 968   }
 969
 970   /**
 971    * Assert that we are running on a particular PHP version.
 972    *
 973    * @param int $ver
 974    *   The major version of PHP that is required.
 975    * @param bool $abort
 976    *   (optional) Whether to fatally abort if the version requirement is not
 977    *   met. Defaults to TRUE.
 978    *
 979    * @return bool
 980    *   Returns TRUE if the requirement is met, FALSE if the requirement is not
 981    *   met and we're not aborting due to the failed requirement. If $abort is
 982    *   TRUE and the requirement fails, this function does not return.
 983    *
 984    * @throws CRM_Core_Exception
 985    */
 986   public static function checkPHPVersion($ver = 5, $abort = TRUE) {
 987     $phpVersion = substr(PHP_VERSION, 0, 1);
 988     if ($phpVersion >= $ver) {
 989       return TRUE;
 990     }
 991
 992     if ($abort) {
 993       throw new CRM_Core_Exception(ts('This feature requires PHP Version %1 or greater',
 994         [1 => $ver]
 995       ));
 996     }
 997     return FALSE;
 998   }
 999
1000   /**
1001    * Format wiki url.
1002    *
1003    * @param string $string
1004    * @param bool $encode
1005    *
1006    * @return string
1007    */
1008   public static function formatWikiURL($string, $encode = FALSE) {
1009     $items = explode(' ', trim($string), 2);
1010     if (count($items) == 2) {
1011       $title = $items[1];
1012     }
1013     else {
1014       $title = $items[0];
1015     }
1016
1017     // fix for CRM-4044
1018     $url = $encode ? self::urlEncode($items[0]) : $items[0];
1019     return "<a href=\"$url\">$title</a>";
1020   }
1021
1022   /**
1023    * Encode url.
1024    *
1025    * @param string $url
1026    *
1027    * @return null|string
1028    */
1029   public static function urlEncode($url) {
1030     $items = parse_url($url);
1031     if ($items === FALSE) {
1032       return NULL;
1033     }
1034
1035     if (empty($items['query'])) {
1036       return $url;
1037     }
1038
1039     $items['query'] = urlencode($items['query']);
1040
1041     $url = $items['scheme'] . '://';
1042     if (!empty($items['user'])) {
1043       $url .= "{$items['user']}:{$items['pass']}@";
1044     }
1045
1046     $url .= $items['host'];
1047     if (!empty($items['port'])) {
1048       $url .= ":{$items['port']}";
1049     }
1050
1051     $url .= "{$items['path']}?{$items['query']}";
1052     if (!empty($items['fragment'])) {
1053       $url .= "#{$items['fragment']}";
1054     }
1055
1056     return $url;
1057   }
1058
1059   /**
1060    * Return the running civicrm version.
1061    *
1062    * @return string
1063    *   civicrm version
1064    *
1065    * @throws CRM_Core_Exception
1066    */
1067   public static function version() {
1068     static $version;
1069
1070     if (!$version) {
1071       $verFile = implode(DIRECTORY_SEPARATOR,
1072         [dirname(__FILE__), '..', '..', 'xml', 'version.xml']
1073       );
1074       if (file_exists($verFile)) {
1075         $str = file_get_contents($verFile);
1076         $xmlObj = simplexml_load_string($str);
1077         $version = (string) $xmlObj->version_no;
1078       }
1079
1080       // pattern check
1081       if (!CRM_Utils_System::isVersionFormatValid($version)) {
1082         throw new CRM_Core_Exception('Unknown codebase version.');
1083       }
1084     }
1085
1086     return $version;
1087   }
1088
1089   /**
1090    * Gives the first two parts of the version string E.g. 6.1.
1091    *
1092    * @return string
1093    */
1094   public static function majorVersion() {
1095     list($a, $b) = explode('.', self::version());
1096     return "$a.$b";
1097   }
1098
1099   /**
1100    * Determines whether a string is a valid CiviCRM version string.
1101    *
1102    * @param string $version
1103    *   Version string to be checked.
1104    *
1105    * @return bool
1106    */
1107   public static function isVersionFormatValid($version) {
1108     return preg_match("/^(\d{1,2}\.){2,3}(\d{1,2}|(alpha|beta)\d{1,2})(\.upgrade)?$/", $version);
1109   }
1110
1111   /**
1112    * Wraps or emulates PHP's getallheaders() function.
1113    */
1114   public static function getAllHeaders() {
1115     if (function_exists('getallheaders')) {
1116       return getallheaders();
1117     }
1118
1119     // emulate get all headers
1120     // http://www.php.net/manual/en/function.getallheaders.php#66335
1121     $headers = [];
1122     foreach ($_SERVER as $name => $value) {
1123       if (substr($name, 0, 5) == 'HTTP_') {
1124         $headers[str_replace(' ',
1125           '-',
1126           ucwords(strtolower(str_replace('_',
1127               ' ',
1128               substr($name, 5)
1129             )
1130           ))
1131         )] = $value;
1132       }
1133     }
1134     return $headers;
1135   }
1136
1137   /**
1138    * Get request headers.
1139    *
1140    * @return array|false
1141    */
1142   public static function getRequestHeaders() {
1143     if (function_exists('apache_request_headers')) {
1144       return apache_request_headers();
1145     }
1146     else {
1147       return $_SERVER;
1148     }
1149   }
1150
1151   /**
1152    * Determine whether this is an SSL request.
1153    *
1154    * Note that we inline this function in install/civicrm.php, so if you change
1155    * this function, please go and change the code in the install script as well.
1156    */
1157   public static function isSSL() {
1158     return (isset($_SERVER['HTTPS']) &&
1159         !empty($_SERVER['HTTPS']) &&
1160         strtolower($_SERVER['HTTPS']) != 'off') ? TRUE : FALSE;
1161   }
1162
1163   /**
1164    * Redirect to SSL.
1165    *
1166    * @param bool|FALSE $abort
1167    *
1168    * @throws \CRM_Core_Exception
1169    */
1170   public static function redirectToSSL($abort = FALSE) {
1171     $config = CRM_Core_Config::singleton();
1172     $req_headers = self::getRequestHeaders();
1173     // FIXME: Shouldn't the X-Forwarded-Proto check be part of CRM_Utils_System::isSSL()?
1174     if (Civi::settings()->get('enableSSL') &&
1175       !self::isSSL() &&
1176       strtolower(CRM_Utils_Array::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1177     ) {
1178       // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1179       $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1180       // @see https://lab.civicrm.org/dev/core/issues/425 if you're seeing this message.
1181       Civi::log()->warning('CiviCRM thinks site is not SSL, redirecting to {url}', ['url' => $url]);
1182       if (!self::checkURL($url, TRUE)) {
1183         if ($abort) {
1184           throw new CRM_Core_Exception('HTTPS is not set up on this machine');
1185         }
1186         else {
1187           CRM_Core_Session::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1188           // admin should be the only one following this
1189           // since we dont want the user stuck in a bad place
1190           return;
1191         }
1192       }
1193       CRM_Utils_System::redirect($url);
1194     }
1195   }
1196
1197   /**
1198    * Get logged in user's IP address.
1199    *
1200    * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1201    * the Drupal function as this also handles reverse proxies (based on proper
1202    * configuration in settings.php)
1203    *
1204    * @param bool $strictIPV4
1205    *   (optional) Whether to return only IPv4 addresses.
1206    *
1207    * @return string
1208    *   IP address of logged in user.
1209    */
1210   public static function ipAddress($strictIPV4 = TRUE) {
1211     $address = CRM_Utils_Array::value('REMOTE_ADDR', $_SERVER);
1212
1213     $config = CRM_Core_Config::singleton();
1214     if ($config->userSystem->is_drupal && function_exists('ip_address')) {
1215       // drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1216       // that reach this point without bootstrapping hence the check that the fn exists
1217       $address = ip_address();
1218     }
1219
1220     // hack for safari
1221     if ($address == '::1') {
1222       $address = '127.0.0.1';
1223     }
1224
1225     // when we need to have strictly IPV4 ip address
1226     // convert ipV6 to ipV4
1227     if ($strictIPV4) {
1228       // this converts 'IPV4 mapped IPV6 address' to IPV4
1229       if (filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) && strstr($address, '::ffff:')) {
1230         $address = ltrim($address, '::ffff:');
1231       }
1232     }
1233
1234     return $address;
1235   }
1236
1237   /**
1238    * Get the referring / previous page URL.
1239    *
1240    * @return string
1241    *   The previous page URL
1242    */
1243   public static function refererPath() {
1244     return CRM_Utils_Array::value('HTTP_REFERER', $_SERVER);
1245   }
1246
1247   /**
1248    * Get the documentation base URL.
1249    *
1250    * @return string
1251    *   Base URL of the CRM documentation.
1252    */
1253   public static function getDocBaseURL() {
1254     // FIXME: move this to configuration at some stage
1255     return 'https://docs.civicrm.org/';
1256   }
1257
1258   /**
1259    * Returns wiki (alternate) documentation URL base.
1260    *
1261    * @return string
1262    *   documentation url
1263    */
1264   public static function getWikiBaseURL() {
1265     // FIXME: move this to configuration at some stage
1266     return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1267   }
1268
1269   /**
1270    * Returns URL or link to documentation page, based on provided parameters.
1271    *
1272    * For use in PHP code.
1273    * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1274    * no effect).
1275    *
1276    * @param string $page
1277    *   Title of documentation wiki page.
1278    * @param bool $URLonly
1279    *   (optional) Whether to return URL only or full HTML link (default).
1280    * @param string $text
1281    *   (optional) Text of HTML link (no effect if $URLonly = false).
1282    * @param string $title
1283    *   (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1284    * @param string $style
1285    *   (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1286    *
1287    * @param null $resource
1288    *
1289    * @return string
1290    *   URL or link to documentation page, based on provided parameters.
1291    */
1292   public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1293     // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1294     // return just the URL, no matter what other parameters are defined
1295     if (!function_exists('ts')) {
1296       if ($resource == 'wiki') {
1297         $docBaseURL = self::getWikiBaseURL();
1298       }
1299       else {
1300         $docBaseURL = self::getDocBaseURL();
1301         $page = self::formatDocUrl($page);
1302       }
1303       return $docBaseURL . str_replace(' ', '+', $page);
1304     }
1305     else {
1306       $params = [
1307         'page' => $page,
1308         'URLonly' => $URLonly,
1309         'text' => $text,
1310         'title' => $title,
1311         'style' => $style,
1312         'resource' => $resource,
1313       ];
1314       return self::docURL($params);
1315     }
1316   }
1317
1318   /**
1319    * Returns URL or link to documentation page, based on provided parameters.
1320    *
1321    * For use in templates code.
1322    *
1323    * @param array $params
1324    *   An array of parameters (see CRM_Utils_System::docURL2 method for names)
1325    *
1326    * @return null|string
1327    *   URL or link to documentation page, based on provided parameters.
1328    */
1329   public static function docURL($params) {
1330
1331     if (!isset($params['page'])) {
1332       return NULL;
1333     }
1334
1335     if (CRM_Utils_Array::value('resource', $params) == 'wiki') {
1336       $docBaseURL = self::getWikiBaseURL();
1337     }
1338     else {
1339       $docBaseURL = self::getDocBaseURL();
1340       $params['page'] = self::formatDocUrl($params['page']);
1341     }
1342
1343     if (!isset($params['title']) or $params['title'] === NULL) {
1344       $params['title'] = ts('Opens documentation in a new window.');
1345     }
1346
1347     if (!isset($params['text']) or $params['text'] === NULL) {
1348       $params['text'] = ts('(learn more...)');
1349     }
1350
1351     if (!isset($params['style']) || $params['style'] === NULL) {
1352       $style = '';
1353     }
1354     else {
1355       $style = "style=\"{$params['style']}\"";
1356     }
1357
1358     $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1359
1360     if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1361       return $link;
1362     }
1363     else {
1364       return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1365     }
1366   }
1367
1368   /**
1369    * Add language and version parameters to the doc url.
1370    *
1371    * Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.
1372    *
1373    * @param $url
1374    * @return mixed
1375    */
1376   public static function formatDocUrl($url) {
1377     return preg_replace('#^(user|sysadmin|dev)/#', '\1/en/stable/', $url);
1378   }
1379
1380   /**
1381    * Exit with provided exit code.
1382    *
1383    * @param int $status
1384    *   (optional) Code with which to exit.
1385    *
1386    * @param array $testParameters
1387    */
1388   public static function civiExit($status = 0, $testParameters = []) {
1389
1390     if (CIVICRM_UF === 'UnitTests') {
1391       throw new CRM_Core_Exception_PrematureExitException('civiExit called', $testParameters);
1392     }
1393     if ($status > 0) {
1394       http_response_code(500);
1395     }
1396     // move things to CiviCRM cache as needed
1397     CRM_Core_Session::storeSessionObjects();
1398
1399     if (Civi\Core\Container::isContainerBooted()) {
1400       Civi::dispatcher()->dispatch('civi.core.exit');
1401     }
1402
1403     $userSystem = CRM_Core_Config::singleton()->userSystem;
1404     if (is_callable([$userSystem, 'onCiviExit'])) {
1405       $userSystem->onCiviExit();
1406     }
1407     exit($status);
1408   }
1409
1410   /**
1411    * Reset the various system caches and some important static variables.
1412    */
1413   public static function flushCache() {
1414     // flush out all cache entries so we can reload new data
1415     // a bit aggressive, but livable for now
1416     CRM_Utils_Cache::singleton()->flush();
1417
1418     // Traditionally, systems running on memory-backed caches were quite
1419     // zealous about destroying *all* memory-backed caches during a flush().
1420     // These flushes simulate that legacy behavior. However, they should probably
1421     // be removed at some point.
1422     $localDrivers = ['CRM_Utils_Cache_ArrayCache', 'CRM_Utils_Cache_NoCache'];
1423     if (Civi\Core\Container::isContainerBooted()
1424       && !in_array(get_class(CRM_Utils_Cache::singleton()), $localDrivers)) {
1425       Civi::cache('long')->flush();
1426       Civi::cache('settings')->flush();
1427       Civi::cache('js_strings')->flush();
1428       Civi::cache('community_messages')->flush();
1429       Civi::cache('groups')->flush();
1430       Civi::cache('navigation')->flush();
1431       Civi::cache('customData')->flush();
1432       Civi::cache('contactTypes')->clear();
1433       Civi::cache('metadata')->clear();
1434       CRM_Extension_System::singleton()->getCache()->flush();
1435       CRM_Cxn_CiviCxnHttp::singleton()->getCache()->flush();
1436     }
1437
1438     // also reset the various static memory caches
1439
1440     // reset the memory or array cache
1441     Civi::cache('fields')->flush();
1442
1443     // reset ACL cache
1444     CRM_ACL_BAO_Cache::resetCache();
1445
1446     // reset various static arrays used here
1447     CRM_Contact_BAO_Contact::$_importableFields = CRM_Contact_BAO_Contact::$_exportableFields
1448       = CRM_Contribute_BAO_Contribution::$_importableFields
1449         = CRM_Contribute_BAO_Contribution::$_exportableFields
1450           = CRM_Pledge_BAO_Pledge::$_exportableFields
1451             = CRM_Core_BAO_CustomField::$_importFields
1452               = CRM_Core_BAO_Cache::$_cache = CRM_Core_DAO::$_dbColumnValueCache = NULL;
1453
1454     CRM_Core_OptionGroup::flushAll();
1455     CRM_Utils_PseudoConstant::flushAll();
1456   }
1457
1458   /**
1459    * Load CMS bootstrap.
1460    *
1461    * @param array $params
1462    *   Array with uid name and pass
1463    * @param bool $loadUser
1464    *   Boolean load user or not.
1465    * @param bool $throwError
1466    * @param string $realPath
1467    */
1468   public static function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1469     if (!is_array($params)) {
1470       $params = [];
1471     }
1472     $config = CRM_Core_Config::singleton();
1473     $result = $config->userSystem->loadBootStrap($params, $loadUser, $throwError, $realPath);
1474     if (is_callable([$config->userSystem, 'setMySQLTimeZone'])) {
1475       $config->userSystem->setMySQLTimeZone();
1476     }
1477     return $result;
1478   }
1479
1480   /**
1481    * Get Base CMS url.
1482    *
1483    * @return mixed|string
1484    */
1485   public static function baseCMSURL() {
1486     static $_baseURL = NULL;
1487     if (!$_baseURL) {
1488       $config = CRM_Core_Config::singleton();
1489       $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL;
1490
1491       if ($config->userFramework == 'Joomla') {
1492         // gross hack
1493         // we need to remove the administrator/ from the end
1494         $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1495       }
1496       else {
1497         // Drupal setting
1498         global $civicrm_root;
1499         if (strpos($civicrm_root,
1500             DIRECTORY_SEPARATOR . 'sites' .
1501             DIRECTORY_SEPARATOR . 'all' .
1502             DIRECTORY_SEPARATOR . 'modules'
1503           ) === FALSE
1504         ) {
1505           $startPos = strpos($civicrm_root,
1506             DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR
1507           );
1508           $endPos = strpos($civicrm_root,
1509             DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR
1510           );
1511           if ($startPos && $endPos) {
1512             // if component is in sites/SITENAME/modules
1513             $siteName = substr($civicrm_root,
1514               $startPos + 7,
1515               $endPos - $startPos - 7
1516             );
1517
1518             $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1519           }
1520         }
1521       }
1522     }
1523     return $_baseURL;
1524   }
1525
1526   /**
1527    * Given a URL, return a relative URL if possible.
1528    *
1529    * @param string $url
1530    *
1531    * @return string
1532    */
1533   public static function relativeURL($url) {
1534     // check if url is relative, if so return immediately
1535     if (substr($url, 0, 4) != 'http') {
1536       return $url;
1537     }
1538
1539     // make everything relative from the baseFilePath
1540     $baseURL = self::baseCMSURL();
1541
1542     // check if baseURL is a substr of $url, if so
1543     // return rest of string
1544     if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1545       return substr($url, strlen($baseURL));
1546     }
1547
1548     // return the original value
1549     return $url;
1550   }
1551
1552   /**
1553    * Produce an absolute URL from a possibly-relative URL.
1554    *
1555    * @param string $url
1556    * @param bool $removeLanguagePart
1557    *
1558    * @return string
1559    */
1560   public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1561     // check if url is already absolute, if so return immediately
1562     if (substr($url, 0, 4) == 'http') {
1563       return $url;
1564     }
1565
1566     // make everything absolute from the baseFileURL
1567     $baseURL = self::baseCMSURL();
1568
1569     //CRM-7622: drop the language from the URL if requested (and it’s there)
1570     $config = CRM_Core_Config::singleton();
1571     if ($removeLanguagePart) {
1572       $baseURL = self::languageNegotiationURL($baseURL, FALSE, TRUE);
1573     }
1574
1575     return $baseURL . $url;
1576   }
1577
1578   /**
1579    * Clean url, replaces first '&' with '?'.
1580    *
1581    * @param string $url
1582    *
1583    * @return string
1584    *   , clean url
1585    */
1586   public static function cleanUrl($url) {
1587     if (!$url) {
1588       return NULL;
1589     }
1590
1591     if ($pos = strpos($url, '&')) {
1592       $url = substr_replace($url, '?', $pos, 1);
1593     }
1594
1595     return $url;
1596   }
1597
1598   /**
1599    * Format the url as per language Negotiation.
1600    *
1601    * @param string $url
1602    *
1603    * @param bool $addLanguagePart
1604    * @param bool $removeLanguagePart
1605    *
1606    * @return string
1607    *   , formatted url.
1608    */
1609   public static function languageNegotiationURL(
1610     $url,
1611     $addLanguagePart = TRUE,
1612     $removeLanguagePart = FALSE
1613   ) {
1614     return CRM_Core_Config::singleton()->userSystem->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1615   }
1616
1617   /**
1618    * Append the contents of an 'extra' smarty template file.
1619    *
1620    * It must be present in the custom template directory. This does not work if there are
1621    * multiple custom template directories
1622    *
1623    * @param string $fileName
1624    *   The name of the tpl file that we are processing.
1625    * @param string $content
1626    *   The current content string. May be modified by this function.
1627    * @param string $overideFileName
1628    *   (optional) Sent by contribution/event reg/profile pages which uses a id
1629    *   specific extra file name if present.
1630    */
1631   public static function appendTPLFile(
1632     $fileName,
1633     &$content,
1634     $overideFileName = NULL
1635   ) {
1636     $template = CRM_Core_Smarty::singleton();
1637     if ($overideFileName) {
1638       $additionalTPLFile = $overideFileName;
1639     }
1640     else {
1641       $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1642     }
1643
1644     if ($template->template_exists($additionalTPLFile)) {
1645       $content .= $template->fetch($additionalTPLFile);
1646     }
1647   }
1648
1649   /**
1650    * Get a list of all files that are found within the directories.
1651    *
1652    * Files must be the result of appending the provided relative path to
1653    * each component of the PHP include path.
1654    *
1655    * @author Ken Zalewski
1656    *
1657    * @param string $relpath
1658    *   A relative path, typically pointing to a directory with multiple class
1659    *   files.
1660    *
1661    * @return array
1662    *   An array of files that exist in one or more of the directories that are
1663    *   referenced by the relative path when appended to each element of the PHP
1664    *   include path.
1665    */
1666   public static function listIncludeFiles($relpath) {
1667     $file_list = [];
1668     $inc_dirs = explode(PATH_SEPARATOR, get_include_path());
1669     foreach ($inc_dirs as $inc_dir) {
1670       $target_dir = $inc_dir . DIRECTORY_SEPARATOR . $relpath;
1671       if (is_dir($target_dir)) {
1672         $cur_list = scandir($target_dir);
1673         foreach ($cur_list as $fname) {
1674           if ($fname != '.' && $fname != '..') {
1675             $file_list[$fname] = $fname;
1676           }
1677         }
1678       }
1679     }
1680     return $file_list;
1681   }
1682
1683   /**
1684    * Get a list of all "plugins".
1685    *
1686    * (PHP classes that implement a piece of
1687    * functionality using a well-defined interface) that are found in a
1688    * particular CiviCRM directory (both custom and core are searched).
1689    *
1690    * @author Ken Zalewski
1691    *
1692    * @param string $relpath
1693    *   A relative path referencing a directory that contains one or more
1694    *   plugins.
1695    * @param string $fext
1696    *   (optional) Only files with this extension will be considered to be
1697    *   plugins.
1698    * @param array $skipList
1699    *   (optional) List of files to skip.
1700    *
1701    * @return array
1702    *   List of plugins, where the plugin name is both the key and the value of
1703    *   each element.
1704    */
1705   public static function getPluginList($relpath, $fext = '.php', $skipList = []) {
1706     $fext_len = strlen($fext);
1707     $plugins = [];
1708     $inc_files = CRM_Utils_System::listIncludeFiles($relpath);
1709     foreach ($inc_files as $inc_file) {
1710       if (substr($inc_file, 0 - $fext_len) == $fext) {
1711         $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1712         if (!in_array($plugin_name, $skipList)) {
1713           $plugins[$plugin_name] = $plugin_name;
1714         }
1715       }
1716     }
1717     return $plugins;
1718   }
1719
1720   /**
1721    * Execute scheduled jobs.
1722    */
1723   public static function executeScheduledJobs() {
1724     $facility = new CRM_Core_JobManager();
1725     $facility->execute(FALSE);
1726
1727     $redirectUrl = self::url('civicrm/admin/job', 'reset=1');
1728
1729     CRM_Core_Session::setStatus(
1730       ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1731       ts('Complete'), 'success');
1732
1733     CRM_Utils_System::redirect($redirectUrl);
1734   }
1735
1736   /**
1737    * Evaluate any tokens in a URL.
1738    *
1739    * @param string|FALSE $url
1740    *
1741    * @return string|FALSE
1742    */
1743   public static function evalUrl($url) {
1744     if (!$url || strpos($url, '{') === FALSE) {
1745       return $url;
1746     }
1747     else {
1748       $config = CRM_Core_Config::singleton();
1749       $vars = [
1750         '{ver}' => CRM_Utils_System::version(),
1751         '{uf}' => $config->userFramework,
1752         '{php}' => phpversion(),
1753         '{sid}' => self::getSiteID(),
1754         '{baseUrl}' => $config->userFrameworkBaseURL,
1755         '{lang}' => $config->lcMessages,
1756         '{co}' => $config->defaultContactCountry,
1757       ];
1758       return strtr($url, array_map('urlencode', $vars));
1759     }
1760   }
1761
1762   /**
1763    * Returns the unique identifier for this site, as used by community messages.
1764    *
1765    * SiteID will be generated if it is not already stored in the settings table.
1766    *
1767    * @return string
1768    */
1769   public static function getSiteID() {
1770     $sid = Civi::settings()->get('site_id');
1771     if (!$sid) {
1772       $config = CRM_Core_Config::singleton();
1773       $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : '') . '_' . $config->userFrameworkBaseURL);
1774       civicrm_api3('Setting', 'create', ['domain_id' => 'all', 'site_id' => $sid]);
1775     }
1776     return $sid;
1777   }
1778
1779   /**
1780    * Determine whether this is a developmental system.
1781    *
1782    * @return bool
1783    */
1784   public static function isDevelopment() {
1785     static $cache = NULL;
1786     if ($cache === NULL) {
1787       global $civicrm_root;
1788       $cache = file_exists("{$civicrm_root}/.svn") || file_exists("{$civicrm_root}/.git");
1789     }
1790     return $cache;
1791   }
1792
1793   /**
1794    * Is in upgrade mode.
1795    *
1796    * @return bool
1797    */
1798   public static function isInUpgradeMode() {
1799     $args = explode('/', CRM_Utils_Array::value('q', $_GET));
1800     $upgradeInProcess = CRM_Core_Session::singleton()->get('isUpgradePending');
1801     if ((isset($args[1]) && $args[1] == 'upgrade') || $upgradeInProcess) {
1802       return TRUE;
1803     }
1804     else {
1805       return FALSE;
1806     }
1807   }
1808
1809   /**
1810    * Determine the standard URL for viewing or editing the specified link.
1811    *
1812    * This function delegates the decision-making to (a) the hook system and
1813    * (b) the BAO system.
1814    *
1815    * @param array $crudLinkSpec
1816    *   With keys:.
1817    *   - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1818    *   - entity_table: string, eg "civicrm_contact"
1819    *   - entity_id: int
1820    *
1821    * @return array|NULL
1822    *   NULL if unavailable, or an array. array has keys:
1823    *   - path: string
1824    *   - query: array
1825    *   - title: string
1826    *   - url: string
1827    */
1828   public static function createDefaultCrudLink($crudLinkSpec) {
1829     $crudLinkSpec['action'] = CRM_Utils_Array::value('action', $crudLinkSpec, CRM_Core_Action::VIEW);
1830     $daoClass = CRM_Core_DAO_AllCoreTables::getClassForTable($crudLinkSpec['entity_table']);
1831     if (!$daoClass) {
1832       return NULL;
1833     }
1834
1835     $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1836     if (!class_exists($baoClass)) {
1837       return NULL;
1838     }
1839
1840     $bao = new $baoClass();
1841     $bao->id = $crudLinkSpec['entity_id'];
1842     if (!$bao->find(TRUE)) {
1843       return NULL;
1844     }
1845
1846     $link = [];
1847     CRM_Utils_Hook::crudLink($crudLinkSpec, $bao, $link);
1848     if (empty($link) && is_callable([$bao, 'createDefaultCrudLink'])) {
1849       $link = $bao->createDefaultCrudLink($crudLinkSpec);
1850     }
1851
1852     if (!empty($link)) {
1853       if (!isset($link['url'])) {
1854         $link['url'] = self::url($link['path'], $link['query'], TRUE, NULL, FALSE);
1855       }
1856       return $link;
1857     }
1858
1859     return NULL;
1860   }
1861
1862   /**
1863    * Return an HTTP Response with appropriate content and status code set.
1864    * @param \Psr\Http\Message\ResponseInterface $response
1865    */
1866   public static function sendResponse(\Psr\Http\Message\ResponseInterface $response) {
1867     $config = CRM_Core_Config::singleton()->userSystem->sendResponse($response);
1868   }
1869
1870 }