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