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     $config = &CRM_Core_Config::singleton();
 220     return $config->userSystem->theme($content, $print, $maintenance);
 221   }
 222
 223   /**
 224    * Generate a query string if input is an array.
 225    *
 226    * @param array|string $query
 227    *
 228    * @return string
 229    */
 230   public static function makeQueryString($query) {
 231     if (is_array($query)) {
 232       $buf = '';
 233       foreach ($query as $key => $value) {
 234         $buf .= ($buf ? '&' : '') . urlencode($key) . '=' . urlencode($value);
 235       }
 236       $query = $buf;
 237     }
 238     return $query;
 239   }
 240
 241   /**
 242    * Generate an internal CiviCRM URL.
 243    *
 244    * @param string $path
 245    *   The path being linked to, such as "civicrm/add".
 246    * @param array|string $query
 247    *   A query string to append to the link, or an array of key-value pairs.
 248    * @param bool $absolute
 249    *   Whether to force the output to be an absolute link (beginning with a
 250    *   URI-scheme such as 'http:'). Useful for links that will be displayed
 251    *   outside the site, such as in an RSS feed.
 252    * @param string $fragment
 253    *   A fragment identifier (named anchor) to append to the link.
 254    * @param bool $htmlize
 255    *   Whether to encode special html characters such as &.
 256    * @param bool $frontend
 257    *   This link should be to the CMS front end (applies to WP & Joomla).
 258    * @param bool $forceBackend
 259    *   This link should be to the CMS back end (applies to WP & Joomla).
 260    *
 261    * @return string
 262    *   An HTML string containing a link to the given path.
 263    */
 264   public static function url(
 265     $path = NULL,
 266     $query = NULL,
 267     $absolute = FALSE,
 268     $fragment = NULL,
 269     $htmlize = TRUE,
 270     $frontend = FALSE,
 271     $forceBackend = FALSE
 272   ) {
 273     $query = self::makeQueryString($query);
 274
 275     // Legacy handling for when the system passes around html escaped strings
 276     if (strstr($query, '&amp;')) {
 277       $query = html_entity_decode($query);
 278     }
 279
 280     // Extract fragment from path or query if munged together
 281     if ($query && strstr($query, '#')) {
 282       list($path, $fragment) = explode('#', $query);
 283     }
 284     if ($path && strstr($path, '#')) {
 285       list($path, $fragment) = explode('#', $path);
 286     }
 287
 288     // Extract query from path if munged together
 289     if ($path && strstr($path, '?')) {
 290       list($path, $extraQuery) = explode('?', $path);
 291       $query = $extraQuery . ($query ? "&$query" : '');
 292     }
 293
 294     $config = CRM_Core_Config::singleton();
 295     $url = $config->userSystem->url($path, $query, $absolute, $fragment, $frontend, $forceBackend);
 296
 297     if ($htmlize) {
 298       $url = htmlentities($url);
 299     }
 300
 301     return $url;
 302   }
 303
 304   /**
 305    * Path of the current page e.g. 'civicrm/contact/view'
 306    *
 307    * @return string|null
 308    */
 309   public static function getUrlPath() {
 310     if (isset($_GET[CRM_Core_Config::singleton()->userFrameworkURLVar])) {
 311       return $_GET[CRM_Core_Config::singleton()->userFrameworkURLVar];
 312     }
 313     return NULL;
 314   }
 315
 316   /**
 317    * Get href.
 318    *
 319    * @param string $text
 320    * @param string $path
 321    * @param string|array $query
 322    * @param bool $absolute
 323    * @param string $fragment
 324    * @param bool $htmlize
 325    * @param bool $frontend
 326    * @param bool $forceBackend
 327    *
 328    * @return string
 329    */
 330   public static function href(
 331     $text, $path = NULL, $query = NULL, $absolute = TRUE,
 332     $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
 333   ) {
 334     $url = self::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
 335     return "<a href=\"$url\">$text</a>";
 336   }
 337
 338   /**
 339    * What menu path are we currently on. Called for the primary tpl.
 340    *
 341    * @return string
 342    *   the current menu path
 343    */
 344   public static function currentPath() {
 345     $config = CRM_Core_Config::singleton();
 346     return trim(CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET), '/');
 347   }
 348
 349   /**
 350    * Called from a template to compose a url.
 351    *
 352    * @param array $params
 353    *   List of parameters.
 354    *
 355    * @return string
 356    *   url
 357    */
 358   public static function crmURL($params) {
 359     $p = CRM_Utils_Array::value('p', $params);
 360     if (!isset($p)) {
 361       $p = self::currentPath();
 362     }
 363
 364     return self::url(
 365       $p,
 366       CRM_Utils_Array::value('q', $params),
 367       CRM_Utils_Array::value('a', $params, FALSE),
 368       CRM_Utils_Array::value('f', $params),
 369       CRM_Utils_Array::value('h', $params, TRUE),
 370       CRM_Utils_Array::value('fe', $params, FALSE),
 371       CRM_Utils_Array::value('fb', $params, FALSE)
 372     );
 373   }
 374
 375   /**
 376    * Sets the title of the page.
 377    *
 378    * @param string $title
 379    *   Document title - plain text only
 380    * @param string $pageTitle
 381    *   Page title (if different) - may include html
 382    */
 383   public static function setTitle($title, $pageTitle = NULL) {
 384     self::$title = $title;
 385     $config = CRM_Core_Config::singleton();
 386     return $config->userSystem->setTitle($title, $pageTitle);
 387   }
 388
 389   /**
 390    * Figures and sets the userContext.
 391    *
 392    * Uses the referrer if valid else uses the default.
 393    *
 394    * @param array $names
 395    *   Referrer should match any str in this array.
 396    * @param string $default
 397    *   (optional) The default userContext if no match found.
 398    */
 399   public static function setUserContext($names, $default = NULL) {
 400     $url = $default;
 401
 402     $session = CRM_Core_Session::singleton();
 403     $referer = CRM_Utils_Array::value('HTTP_REFERER', $_SERVER);
 404
 405     if ($referer && !empty($names)) {
 406       foreach ($names as $name) {
 407         if (strstr($referer, $name)) {
 408           $url = $referer;
 409           break;
 410         }
 411       }
 412     }
 413
 414     if ($url) {
 415       $session->pushUserContext($url);
 416     }
 417   }
 418
 419   /**
 420    * Gets a class name for an object.
 421    *
 422    * @param object $object
 423    *   Object whose class name is needed.
 424    *
 425    * @return string
 426    *   The class name of the object.
 427    */
 428   public static function getClassName($object) {
 429     return get_class($object);
 430   }
 431
 432   /**
 433    * Redirect to another URL.
 434    *
 435    * @param string $url
 436    *   The URL to provide to the browser via the Location header.
 437    * @param array $context
 438    *   Optional additional information for the hook.
 439    */
 440   public static function redirect($url = NULL, $context = []) {
 441     if (!$url) {
 442       $url = self::url('civicrm/dashboard', 'reset=1');
 443     }
 444     // replace the &amp; characters with &
 445     // this is kinda hackish but not sure how to do it right
 446     $url = str_replace('&amp;', '&', $url);
 447
 448     $context['output'] = CRM_Utils_Array::value('snippet', $_GET);
 449
 450     $parsedUrl = CRM_Utils_Url::parseUrl($url);
 451     CRM_Utils_Hook::alterRedirect($parsedUrl, $context);
 452     $url = CRM_Utils_Url::unparseUrl($parsedUrl);
 453
 454     // If we are in a json context, respond appropriately
 455     if ($context['output'] === 'json') {
 456       CRM_Core_Page_AJAX::returnJsonResponse([
 457         'status' => 'redirect',
 458         'userContext' => $url,
 459       ]);
 460     }
 461
 462     self::setHttpHeader('Location', $url);
 463     self::civiExit();
 464   }
 465
 466   /**
 467    * Redirect to another URL using JavaScript.
 468    *
 469    * Use an html based file with javascript embedded to redirect to another url
 470    * This prevent the too many redirect errors emitted by various browsers
 471    *
 472    * @param string $url
 473    *   (optional) The destination URL.
 474    * @param string $title
 475    *   (optional) The page title to use for the redirect page.
 476    * @param string $message
 477    *   (optional) The message to provide in the body of the redirect page.
 478    */
 479   public static function jsRedirect(
 480     $url = NULL,
 481     $title = NULL,
 482     $message = NULL
 483   ) {
 484     if (!$url) {
 485       $url = self::url('civicrm/dashboard', 'reset=1');
 486     }
 487
 488     if (!$title) {
 489       $title = ts('CiviCRM task in progress');
 490     }
 491
 492     if (!$message) {
 493       $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
 494     }
 495
 496     // replace the &amp; characters with &
 497     // this is kinda hackish but not sure how to do it right
 498     $url = str_replace('&amp;', '&', $url);
 499
 500     $template = CRM_Core_Smarty::singleton();
 501     $template->assign('redirectURL', $url);
 502     $template->assign('title', $title);
 503     $template->assign('message', $message);
 504
 505     $html = $template->fetch('CRM/common/redirectJS.tpl');
 506
 507     echo $html;
 508
 509     self::civiExit();
 510   }
 511
 512   /**
 513    * Get the base URL of the system.
 514    *
 515    * @return string
 516    */
 517   public static function baseURL() {
 518     $config = CRM_Core_Config::singleton();
 519     return $config->userFrameworkBaseURL;
 520   }
 521
 522   /**
 523    * Authenticate or abort.
 524    *
 525    * @param string $message
 526    * @param bool $abort
 527    *
 528    * @return bool
 529    */
 530   public static function authenticateAbort($message, $abort) {
 531     if ($abort) {
 532       echo $message;
 533       self::civiExit(0);
 534     }
 535     else {
 536       return FALSE;
 537     }
 538   }
 539
 540   /**
 541    * Authenticate key.
 542    *
 543    * @param bool $abort
 544    *   (optional) Whether to exit; defaults to true.
 545    *
 546    * @return bool
 547    */
 548   public static function authenticateKey($abort = TRUE) {
 549     // also make sure the key is sent and is valid
 550     $key = trim(CRM_Utils_Array::value('key', $_REQUEST));
 551
 552     $docAdd = "More info at:" . CRM_Utils_System::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
 553
 554     if (!$key) {
 555       return self::authenticateAbort(
 556         "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
 557         $abort
 558       );
 559     }
 560
 561     $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : NULL;
 562
 563     if (!$siteKey || empty($siteKey)) {
 564       return self::authenticateAbort(
 565         "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
 566         $abort
 567       );
 568     }
 569
 570     if (strlen($siteKey) < 8) {
 571       return self::authenticateAbort(
 572         "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
 573         $abort
 574       );
 575     }
 576
 577     if ($key !== $siteKey) {
 578       return self::authenticateAbort(
 579         "ERROR: Invalid key value sent. " . $docAdd . "\n",
 580         $abort
 581       );
 582     }
 583
 584     return TRUE;
 585   }
 586
 587   /**
 588    * Authenticate script.
 589    *
 590    * @param bool $abort
 591    * @param string $name
 592    * @param string $pass
 593    * @param bool $storeInSession
 594    * @param bool $loadCMSBootstrap
 595    * @param bool $requireKey
 596    *
 597    * @return bool
 598    */
 599   public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
 600     // auth to make sure the user has a login/password to do a shell operation
 601     // later on we'll link this to acl's
 602     if (!$name) {
 603       $name = trim(CRM_Utils_Array::value('name', $_REQUEST));
 604       $pass = trim(CRM_Utils_Array::value('pass', $_REQUEST));
 605     }
 606
 607     // its ok to have an empty password
 608     if (!$name) {
 609       return self::authenticateAbort(
 610         "ERROR: You need to send a valid user name and password to execute this file\n",
 611         $abort
 612       );
 613     }
 614
 615     if ($requireKey && !self::authenticateKey($abort)) {
 616       return FALSE;
 617     }
 618
 619     $result = CRM_Utils_System::authenticate($name, $pass, $loadCMSBootstrap);
 620     if (!$result) {
 621       return self::authenticateAbort(
 622         "ERROR: Invalid username and/or password\n",
 623         $abort
 624       );
 625     }
 626     elseif ($storeInSession) {
 627       // lets store contact id and user id in session
 628       list($userID, $ufID, $randomNumber) = $result;
 629       if ($userID && $ufID) {
 630         $config = CRM_Core_Config::singleton();
 631         $config->userSystem->setUserSession([$userID, $ufID]);
 632       }
 633       else {
 634         return self::authenticateAbort(
 635           "ERROR: Unexpected error, could not match userID and contactID",
 636           $abort
 637         );
 638       }
 639     }
 640
 641     return $result;
 642   }
 643
 644   /**
 645    * Authenticate the user against the uf db.
 646    *
 647    * In case of successful authentication, returns an array consisting of
 648    * (contactID, ufID, unique string). Returns FALSE if authentication is
 649    * unsuccessful.
 650    *
 651    * @param string $name
 652    *   The username.
 653    * @param string $password
 654    *   The password.
 655    * @param bool $loadCMSBootstrap
 656    * @param string $realPath
 657    *
 658    * @return false|array
 659    */
 660   public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
 661     $config = CRM_Core_Config::singleton();
 662
 663     /* Before we do any loading, let's start the session and write to it.
 664      * We typically call authenticate only when we need to bootstrap the CMS
 665      * directly via Civi and hence bypass the normal CMS auth and bootstrap
 666      * process typically done in CLI and cron scripts. See: CRM-12648
 667      *
 668      * Q: Can we move this to the userSystem class so that it can be tuned
 669      * per-CMS? For example, when dealing with UnitTests UF, there's no
 670      * userFrameworkDSN.
 671      */
 672     $session = CRM_Core_Session::singleton();
 673     $session->set('civicrmInitSession', TRUE);
 674
 675     if ($config->userFrameworkDSN) {
 676       $dbDrupal = DB::connect($config->userFrameworkDSN);
 677     }
 678     return $config->userSystem->authenticate($name, $password, $loadCMSBootstrap, $realPath);
 679   }
 680
 681   /**
 682    * Set a message in the UF to display to a user.
 683    *
 684    * @param string $message
 685    *   The message to set.
 686    */
 687   public static function setUFMessage($message) {
 688     $config = CRM_Core_Config::singleton();
 689     return $config->userSystem->setMessage($message);
 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 = [];
 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])] = [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 = [];
 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         [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         [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 = [];
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 (isset($_SERVER['HTTPS']) &&
1172         !empty($_SERVER['HTTPS']) &&
1173         strtolower($_SERVER['HTTPS']) != 'off') ? TRUE : FALSE;
1174   }
1175
1176   /**
1177    * Redirect to SSL.
1178    *
1179    * @param bool|FALSE $abort
1180    *
1181    * @throws \Exception
1182    */
1183   public static function redirectToSSL($abort = FALSE) {
1184     $config = CRM_Core_Config::singleton();
1185     $req_headers = self::getRequestHeaders();
1186     // FIXME: Shouldn't the X-Forwarded-Proto check be part of CRM_Utils_System::isSSL()?
1187     if (Civi::settings()->get('enableSSL') &&
1188       !self::isSSL() &&
1189       strtolower(CRM_Utils_Array::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1190     ) {
1191       // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1192       $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1193       // @see https://lab.civicrm.org/dev/core/issues/425 if you're seeing this message.
1194       Civi::log()->warning('CiviCRM thinks site is not SSL, redirecting to {url}', ['url' => $url]);
1195       if (!self::checkURL($url, TRUE)) {
1196         if ($abort) {
1197           CRM_Core_Error::fatal('HTTPS is not set up on this machine');
1198         }
1199         else {
1200           CRM_Core_Session::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1201           // admin should be the only one following this
1202           // since we dont want the user stuck in a bad place
1203           return;
1204         }
1205       }
1206       CRM_Utils_System::redirect($url);
1207     }
1208   }
1209
1210   /**
1211    * Get logged in user's IP address.
1212    *
1213    * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1214    * the Drupal function as this also handles reverse proxies (based on proper
1215    * configuration in settings.php)
1216    *
1217    * @param bool $strictIPV4
1218    *   (optional) Whether to return only IPv4 addresses.
1219    *
1220    * @return string
1221    *   IP address of logged in user.
1222    */
1223   public static function ipAddress($strictIPV4 = TRUE) {
1224     $address = CRM_Utils_Array::value('REMOTE_ADDR', $_SERVER);
1225
1226     $config = CRM_Core_Config::singleton();
1227     if ($config->userSystem->is_drupal && function_exists('ip_address')) {
1228       // drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1229       // that reach this point without bootstrapping hence the check that the fn exists
1230       $address = ip_address();
1231     }
1232
1233     // hack for safari
1234     if ($address == '::1') {
1235       $address = '127.0.0.1';
1236     }
1237
1238     // when we need to have strictly IPV4 ip address
1239     // convert ipV6 to ipV4
1240     if ($strictIPV4) {
1241       // this converts 'IPV4 mapped IPV6 address' to IPV4
1242       if (filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) && strstr($address, '::ffff:')) {
1243         $address = ltrim($address, '::ffff:');
1244       }
1245     }
1246
1247     return $address;
1248   }
1249
1250   /**
1251    * Get the referring / previous page URL.
1252    *
1253    * @return string
1254    *   The previous page URL
1255    */
1256   public static function refererPath() {
1257     return CRM_Utils_Array::value('HTTP_REFERER', $_SERVER);
1258   }
1259
1260   /**
1261    * Get the documentation base URL.
1262    *
1263    * @return string
1264    *   Base URL of the CRM documentation.
1265    */
1266   public static function getDocBaseURL() {
1267     // FIXME: move this to configuration at some stage
1268     return 'https://docs.civicrm.org/';
1269   }
1270
1271   /**
1272    * Returns wiki (alternate) documentation URL base.
1273    *
1274    * @return string
1275    *   documentation url
1276    */
1277   public static function getWikiBaseURL() {
1278     // FIXME: move this to configuration at some stage
1279     return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1280   }
1281
1282   /**
1283    * Returns URL or link to documentation page, based on provided parameters.
1284    *
1285    * For use in PHP code.
1286    * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1287    * no effect).
1288    *
1289    * @param string $page
1290    *   Title of documentation wiki page.
1291    * @param bool $URLonly
1292    *   (optional) Whether to return URL only or full HTML link (default).
1293    * @param string $text
1294    *   (optional) Text of HTML link (no effect if $URLonly = false).
1295    * @param string $title
1296    *   (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1297    * @param string $style
1298    *   (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1299    *
1300    * @param null $resource
1301    *
1302    * @return string
1303    *   URL or link to documentation page, based on provided parameters.
1304    */
1305   public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1306     // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1307     // return just the URL, no matter what other parameters are defined
1308     if (!function_exists('ts')) {
1309       if ($resource == 'wiki') {
1310         $docBaseURL = self::getWikiBaseURL();
1311       }
1312       else {
1313         $docBaseURL = self::getDocBaseURL();
1314         $page = self::formatDocUrl($page);
1315       }
1316       return $docBaseURL . str_replace(' ', '+', $page);
1317     }
1318     else {
1319       $params = [
1320         'page' => $page,
1321         'URLonly' => $URLonly,
1322         'text' => $text,
1323         'title' => $title,
1324         'style' => $style,
1325         'resource' => $resource,
1326       ];
1327       return self::docURL($params);
1328     }
1329   }
1330
1331   /**
1332    * Returns URL or link to documentation page, based on provided parameters.
1333    *
1334    * For use in templates code.
1335    *
1336    * @param array $params
1337    *   An array of parameters (see CRM_Utils_System::docURL2 method for names)
1338    *
1339    * @return null|string
1340    *   URL or link to documentation page, based on provided parameters.
1341    */
1342   public static function docURL($params) {
1343
1344     if (!isset($params['page'])) {
1345       return NULL;
1346     }
1347
1348     if (CRM_Utils_Array::value('resource', $params) == 'wiki') {
1349       $docBaseURL = self::getWikiBaseURL();
1350     }
1351     else {
1352       $docBaseURL = self::getDocBaseURL();
1353       $params['page'] = self::formatDocUrl($params['page']);
1354     }
1355
1356     if (!isset($params['title']) or $params['title'] === NULL) {
1357       $params['title'] = ts('Opens documentation in a new window.');
1358     }
1359
1360     if (!isset($params['text']) or $params['text'] === NULL) {
1361       $params['text'] = ts('(learn more...)');
1362     }
1363
1364     if (!isset($params['style']) || $params['style'] === NULL) {
1365       $style = '';
1366     }
1367     else {
1368       $style = "style=\"{$params['style']}\"";
1369     }
1370
1371     $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1372
1373     if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1374       return $link;
1375     }
1376     else {
1377       return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1378     }
1379   }
1380
1381   /**
1382    * Add language and version parameters to the doc url.
1383    *
1384    * Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.
1385    *
1386    * @param $url
1387    * @return mixed
1388    */
1389   public static function formatDocUrl($url) {
1390     return preg_replace('#^(user|sysadmin|dev)/#', '\1/en/stable/', $url);
1391   }
1392
1393   /**
1394    * Exit with provided exit code.
1395    *
1396    * @param int $status
1397    *   (optional) Code with which to exit.
1398    */
1399   public static function civiExit($status = 0) {
1400
1401     if ($status > 0) {
1402       http_response_code(500);
1403     }
1404     // move things to CiviCRM cache as needed
1405     CRM_Core_Session::storeSessionObjects();
1406
1407     if (Civi\Core\Container::isContainerBooted()) {
1408       Civi::dispatcher()->dispatch('civi.core.exit');
1409     }
1410
1411     $userSystem = CRM_Core_Config::singleton()->userSystem;
1412     if (is_callable([$userSystem, 'onCiviExit'])) {
1413       $userSystem->onCiviExit();
1414     }
1415     exit($status);
1416   }
1417
1418   /**
1419    * Reset the various system caches and some important static variables.
1420    */
1421   public static function flushCache() {
1422     // flush out all cache entries so we can reload new data
1423     // a bit aggressive, but livable for now
1424     CRM_Utils_Cache::singleton()->flush();
1425
1426     // Traditionally, systems running on memory-backed caches were quite
1427     // zealous about destroying *all* memory-backed caches during a flush().
1428     // These flushes simulate that legacy behavior. However, they should probably
1429     // be removed at some point.
1430     $localDrivers = ['CRM_Utils_Cache_Arraycache', 'CRM_Utils_Cache_NoCache'];
1431     if (Civi\Core\Container::isContainerBooted()
1432       && !in_array(get_class(CRM_Utils_Cache::singleton()), $localDrivers)) {
1433       Civi::cache('long')->flush();
1434       Civi::cache('settings')->flush();
1435       Civi::cache('js_strings')->flush();
1436       Civi::cache('community_messages')->flush();
1437       CRM_Extension_System::singleton()->getCache()->flush();
1438       CRM_Cxn_CiviCxnHttp::singleton()->getCache()->flush();
1439     }
1440
1441     // also reset the various static memory caches
1442
1443     // reset the memory or array cache
1444     CRM_Core_BAO_Cache::deleteGroup('contact fields', NULL, FALSE);
1445
1446     // reset ACL cache
1447     CRM_ACL_BAO_Cache::resetCache();
1448
1449     // reset various static arrays used here
1450     CRM_Contact_BAO_Contact::$_importableFields = CRM_Contact_BAO_Contact::$_exportableFields
1451       = CRM_Contribute_BAO_Contribution::$_importableFields
1452         = CRM_Contribute_BAO_Contribution::$_exportableFields
1453           = CRM_Pledge_BAO_Pledge::$_exportableFields
1454             = CRM_Core_BAO_CustomField::$_importFields
1455               = CRM_Core_BAO_Cache::$_cache = CRM_Core_DAO::$_dbColumnValueCache = NULL;
1456
1457     CRM_Core_OptionGroup::flushAll();
1458     CRM_Utils_PseudoConstant::flushAll();
1459   }
1460
1461   /**
1462    * Load CMS bootstrap.
1463    *
1464    * @param array $params
1465    *   Array with uid name and pass
1466    * @param bool $loadUser
1467    *   Boolean load user or not.
1468    * @param bool $throwError
1469    * @param string $realPath
1470    */
1471   public static function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1472     if (!is_array($params)) {
1473       $params = [];
1474     }
1475     $config = CRM_Core_Config::singleton();
1476     $result = $config->userSystem->loadBootStrap($params, $loadUser, $throwError, $realPath);
1477     if (is_callable([$config->userSystem, 'setMySQLTimeZone'])) {
1478       $config->userSystem->setMySQLTimeZone();
1479     }
1480     return $result;
1481   }
1482
1483   /**
1484    * Get Base CMS url.
1485    *
1486    * @return mixed|string
1487    */
1488   public static function baseCMSURL() {
1489     static $_baseURL = NULL;
1490     if (!$_baseURL) {
1491       $config = CRM_Core_Config::singleton();
1492       $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL;
1493
1494       if ($config->userFramework == 'Joomla') {
1495         // gross hack
1496         // we need to remove the administrator/ from the end
1497         $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1498       }
1499       else {
1500         // Drupal setting
1501         global $civicrm_root;
1502         if (strpos($civicrm_root,
1503             DIRECTORY_SEPARATOR . 'sites' .
1504             DIRECTORY_SEPARATOR . 'all' .
1505             DIRECTORY_SEPARATOR . 'modules'
1506           ) === FALSE
1507         ) {
1508           $startPos = strpos($civicrm_root,
1509             DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR
1510           );
1511           $endPos = strpos($civicrm_root,
1512             DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR
1513           );
1514           if ($startPos && $endPos) {
1515             // if component is in sites/SITENAME/modules
1516             $siteName = substr($civicrm_root,
1517               $startPos + 7,
1518               $endPos - $startPos - 7
1519             );
1520
1521             $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1522           }
1523         }
1524       }
1525     }
1526     return $_baseURL;
1527   }
1528
1529   /**
1530    * Given a URL, return a relative URL if possible.
1531    *
1532    * @param string $url
1533    *
1534    * @return string
1535    */
1536   public static function relativeURL($url) {
1537     // check if url is relative, if so return immediately
1538     if (substr($url, 0, 4) != 'http') {
1539       return $url;
1540     }
1541
1542     // make everything relative from the baseFilePath
1543     $baseURL = self::baseCMSURL();
1544
1545     // check if baseURL is a substr of $url, if so
1546     // return rest of string
1547     if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1548       return substr($url, strlen($baseURL));
1549     }
1550
1551     // return the original value
1552     return $url;
1553   }
1554
1555   /**
1556    * Produce an absolute URL from a possibly-relative URL.
1557    *
1558    * @param string $url
1559    * @param bool $removeLanguagePart
1560    *
1561    * @return string
1562    */
1563   public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1564     // check if url is already absolute, if so return immediately
1565     if (substr($url, 0, 4) == 'http') {
1566       return $url;
1567     }
1568
1569     // make everything absolute from the baseFileURL
1570     $baseURL = self::baseCMSURL();
1571
1572     //CRM-7622: drop the language from the URL if requested (and it’s there)
1573     $config = CRM_Core_Config::singleton();
1574     if ($removeLanguagePart) {
1575       $baseURL = self::languageNegotiationURL($baseURL, FALSE, TRUE);
1576     }
1577
1578     return $baseURL . $url;
1579   }
1580
1581   /**
1582    * Clean url, replaces first '&' with '?'.
1583    *
1584    * @param string $url
1585    *
1586    * @return string
1587    *   , clean url
1588    */
1589   public static function cleanUrl($url) {
1590     if (!$url) {
1591       return NULL;
1592     }
1593
1594     if ($pos = strpos($url, '&')) {
1595       $url = substr_replace($url, '?', $pos, 1);
1596     }
1597
1598     return $url;
1599   }
1600
1601   /**
1602    * Format the url as per language Negotiation.
1603    *
1604    * @param string $url
1605    *
1606    * @param bool $addLanguagePart
1607    * @param bool $removeLanguagePart
1608    *
1609    * @return string
1610    *   , formatted url.
1611    */
1612   public static function languageNegotiationURL(
1613     $url,
1614     $addLanguagePart = TRUE,
1615     $removeLanguagePart = FALSE
1616   ) {
1617     $config = &CRM_Core_Config::singleton();
1618     return $config->userSystem->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1619   }
1620
1621   /**
1622    * Append the contents of an 'extra' smarty template file.
1623    *
1624    * It must be present in the custom template directory. This does not work if there are
1625    * multiple custom template directories
1626    *
1627    * @param string $fileName
1628    *   The name of the tpl file that we are processing.
1629    * @param string $content
1630    *   The current content string. May be modified by this function.
1631    * @param string $overideFileName
1632    *   (optional) Sent by contribution/event reg/profile pages which uses a id
1633    *   specific extra file name if present.
1634    */
1635   public static function appendTPLFile(
1636     $fileName,
1637     &$content,
1638     $overideFileName = NULL
1639   ) {
1640     $template = CRM_Core_Smarty::singleton();
1641     if ($overideFileName) {
1642       $additionalTPLFile = $overideFileName;
1643     }
1644     else {
1645       $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1646     }
1647
1648     if ($template->template_exists($additionalTPLFile)) {
1649       $content .= $template->fetch($additionalTPLFile);
1650     }
1651   }
1652
1653   /**
1654    * Get a list of all files that are found within the directories.
1655    *
1656    * Files must be the result of appending the provided relative path to
1657    * each component of the PHP include path.
1658    *
1659    * @author Ken Zalewski
1660    *
1661    * @param string $relpath
1662    *   A relative path, typically pointing to a directory with multiple class
1663    *   files.
1664    *
1665    * @return array
1666    *   An array of files that exist in one or more of the directories that are
1667    *   referenced by the relative path when appended to each element of the PHP
1668    *   include path.
1669    */
1670   public static function listIncludeFiles($relpath) {
1671     $file_list = [];
1672     $inc_dirs = explode(PATH_SEPARATOR, get_include_path());
1673     foreach ($inc_dirs as $inc_dir) {
1674       $target_dir = $inc_dir . DIRECTORY_SEPARATOR . $relpath;
1675       if (is_dir($target_dir)) {
1676         $cur_list = scandir($target_dir);
1677         foreach ($cur_list as $fname) {
1678           if ($fname != '.' && $fname != '..') {
1679             $file_list[$fname] = $fname;
1680           }
1681         }
1682       }
1683     }
1684     return $file_list;
1685   }
1686
1687   /**
1688    * Get a list of all "plugins".
1689    *
1690    * (PHP classes that implement a piece of
1691    * functionality using a well-defined interface) that are found in a
1692    * particular CiviCRM directory (both custom and core are searched).
1693    *
1694    * @author Ken Zalewski
1695    *
1696    * @param string $relpath
1697    *   A relative path referencing a directory that contains one or more
1698    *   plugins.
1699    * @param string $fext
1700    *   (optional) Only files with this extension will be considered to be
1701    *   plugins.
1702    * @param array $skipList
1703    *   (optional) List of files to skip.
1704    *
1705    * @return array
1706    *   List of plugins, where the plugin name is both the key and the value of
1707    *   each element.
1708    */
1709   public static function getPluginList($relpath, $fext = '.php', $skipList = []) {
1710     $fext_len = strlen($fext);
1711     $plugins = [];
1712     $inc_files = CRM_Utils_System::listIncludeFiles($relpath);
1713     foreach ($inc_files as $inc_file) {
1714       if (substr($inc_file, 0 - $fext_len) == $fext) {
1715         $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1716         if (!in_array($plugin_name, $skipList)) {
1717           $plugins[$plugin_name] = $plugin_name;
1718         }
1719       }
1720     }
1721     return $plugins;
1722   }
1723
1724   /**
1725    * Execute scheduled jobs.
1726    */
1727   public static function executeScheduledJobs() {
1728     $facility = new CRM_Core_JobManager();
1729     $facility->execute(FALSE);
1730
1731     $redirectUrl = self::url('civicrm/admin/job', 'reset=1');
1732
1733     CRM_Core_Session::setStatus(
1734       ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1735       ts('Complete'), 'success');
1736
1737     CRM_Utils_System::redirect($redirectUrl);
1738   }
1739
1740   /**
1741    * Evaluate any tokens in a URL.
1742    *
1743    * @param string|FALSE $url
1744    *
1745    * @return string|FALSE
1746    */
1747   public static function evalUrl($url) {
1748     if (!$url || strpos($url, '{') === FALSE) {
1749       return $url;
1750     }
1751     else {
1752       $config = CRM_Core_Config::singleton();
1753       $vars = [
1754         '{ver}' => CRM_Utils_System::version(),
1755         '{uf}' => $config->userFramework,
1756         '{php}' => phpversion(),
1757         '{sid}' => self::getSiteID(),
1758         '{baseUrl}' => $config->userFrameworkBaseURL,
1759         '{lang}' => $config->lcMessages,
1760         '{co}' => $config->defaultContactCountry,
1761       ];
1762       return strtr($url, array_map('urlencode', $vars));
1763     }
1764   }
1765
1766   /**
1767    * Returns the unique identifier for this site, as used by community messages.
1768    *
1769    * SiteID will be generated if it is not already stored in the settings table.
1770    *
1771    * @return string
1772    */
1773   public static function getSiteID() {
1774     $sid = Civi::settings()->get('site_id');
1775     if (!$sid) {
1776       $config = CRM_Core_Config::singleton();
1777       $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : '') . '_' . $config->userFrameworkBaseURL);
1778       civicrm_api3('Setting', 'create', ['domain_id' => 'all', 'site_id' => $sid]);
1779     }
1780     return $sid;
1781   }
1782
1783   /**
1784    * Determine whether this is a developmental system.
1785    *
1786    * @return bool
1787    */
1788   public static function isDevelopment() {
1789     static $cache = NULL;
1790     if ($cache === NULL) {
1791       global $civicrm_root;
1792       $cache = file_exists("{$civicrm_root}/.svn") || file_exists("{$civicrm_root}/.git");
1793     }
1794     return $cache;
1795   }
1796
1797   /**
1798    * Is in upgrade mode.
1799    *
1800    * @return bool
1801    */
1802   public static function isInUpgradeMode() {
1803     $args = explode('/', CRM_Utils_Array::value('q', $_GET));
1804     $upgradeInProcess = CRM_Core_Session::singleton()->get('isUpgradePending');
1805     if ((isset($args[1]) && $args[1] == 'upgrade') || $upgradeInProcess) {
1806       return TRUE;
1807     }
1808     else {
1809       return FALSE;
1810     }
1811   }
1812
1813   /**
1814    * Determine the standard URL for viewing or editing the specified link.
1815    *
1816    * This function delegates the decision-making to (a) the hook system and
1817    * (b) the BAO system.
1818    *
1819    * @param array $crudLinkSpec
1820    *   With keys:.
1821    *   - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1822    *   - entity_table: string, eg "civicrm_contact"
1823    *   - entity_id: int
1824    *
1825    * @return array|NULL
1826    *   NULL if unavailable, or an array. array has keys:
1827    *   - path: string
1828    *   - query: array
1829    *   - title: string
1830    *   - url: string
1831    */
1832   public static function createDefaultCrudLink($crudLinkSpec) {
1833     $crudLinkSpec['action'] = CRM_Utils_Array::value('action', $crudLinkSpec, CRM_Core_Action::VIEW);
1834     $daoClass = CRM_Core_DAO_AllCoreTables::getClassForTable($crudLinkSpec['entity_table']);
1835     if (!$daoClass) {
1836       return NULL;
1837     }
1838
1839     $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1840     if (!class_exists($baoClass)) {
1841       return NULL;
1842     }
1843
1844     $bao = new $baoClass();
1845     $bao->id = $crudLinkSpec['entity_id'];
1846     if (!$bao->find(TRUE)) {
1847       return NULL;
1848     }
1849
1850     $link = [];
1851     CRM_Utils_Hook::crudLink($crudLinkSpec, $bao, $link);
1852     if (empty($link) && is_callable([$bao, 'createDefaultCrudLink'])) {
1853       $link = $bao->createDefaultCrudLink($crudLinkSpec);
1854     }
1855
1856     if (!empty($link)) {
1857       if (!isset($link['url'])) {
1858         $link['url'] = self::url($link['path'], $link['query'], TRUE, NULL, FALSE);
1859       }
1860       return $link;
1861     }
1862
1863     return NULL;
1864   }
1865
1866 }