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