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