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