CRM/Utils/System.php

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