CRM/Utils/System.php

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