CRM/Utils/System.php

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