3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC https://civicrm.org/licensing
35 * System wide utilities.
37 * Provides a collection of Civi utilities + access to the CMS-dependant utilities
39 * FIXME: This is a massive and random collection that could be split into smaller services
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.
57 class CRM_Utils_System
{
59 public static $_callbacks = NULL;
65 public static $title = '';
68 * Access methods in the appropriate CMS class
74 public static function __callStatic($name, $arguments) {
75 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
76 return call_user_func_array([$userSystem, $name], $arguments);
80 * Compose a new URL string from the current URL string.
82 * Used by all the framework components, specifically,
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).
92 * (optional) The path to use for the new url.
93 * @param bool|string $absolute
94 * (optional) Whether to return an absolute URL.
99 public static function makeURL($urlVar, $includeReset = FALSE, $includeForce = TRUE, $path = NULL, $absolute = FALSE) {
101 $config = CRM_Core_Config
::singleton();
102 $path = CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET);
110 CRM_Utils_System
::getLinksUrl($urlVar, $includeReset, $includeForce),
116 * Get the query string and clean it up.
118 * Strips some variables that should not be propagated, specifically variables
119 * like 'reset'. Also strips any side-affect actions (e.g. export).
121 * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
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
130 * @param bool $skipUFVar
135 public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
136 // Sort out query string to prevent messy urls
141 if (!empty($_SERVER['QUERY_STRING'])) {
142 $qs = explode('&', str_replace('&', '&', $_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)
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
174 if (!empty($qs['snippet'])) {
175 unset($qs['snippet']);
178 unset($qs['section']);
182 $config = CRM_Core_Config
::singleton();
183 unset($qs[$config->userFrameworkURLVar
]);
186 foreach ($qs as $name => $value) {
187 if ($name != 'reset' ||
$includeReset) {
188 $querystring[] = $name . '=' . $value;
192 $querystring = array_merge($querystring, array_unique($arrays));
194 $url = implode('&', $querystring);
196 $url .= (!empty($querystring) ?
'&' : '') . $urlVar . '=';
203 * If we are using a theming system, invoke theme, else just print the content.
205 * @param string $content
206 * The content that will be themed.
208 * (optional) Are we displaying to the screen or bypassing theming?
209 * @param bool $maintenance
210 * (optional) For maintenance mode.
214 public static function theme(
219 return CRM_Core_Config
::singleton()->userSystem
->theme($content, $print, $maintenance);
223 * Generate a query string if input is an array.
225 * @param array|string $query
229 public static function makeQueryString($query) {
230 if (is_array($query)) {
232 foreach ($query as $key => $value) {
233 $buf .= ($buf ?
'&' : '') . urlencode($key) . '=' . urlencode($value);
241 * Generate an internal CiviCRM URL.
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).
261 * An HTML string containing a link to the given path.
263 public static function url(
270 $forceBackend = FALSE
272 $query = self
::makeQueryString($query);
274 // Legacy handling for when the system passes around html escaped strings
275 if (strstr($query, '&')) {
276 $query = html_entity_decode($query);
279 // Extract fragment from path or query if munged together
280 if ($query && strstr($query, '#')) {
281 list($path, $fragment) = explode('#', $query);
283 if ($path && strstr($path, '#')) {
284 list($path, $fragment) = explode('#', $path);
287 // Extract query from path if munged together
288 if ($path && strstr($path, '?')) {
289 list($path, $extraQuery) = explode('?', $path);
290 $query = $extraQuery . ($query ?
"&$query" : '');
293 $config = CRM_Core_Config
::singleton();
294 $url = $config->userSystem
->url($path, $query, $absolute, $fragment, $frontend, $forceBackend);
297 $url = htmlentities($url);
304 * Path of the current page e.g. 'civicrm/contact/view'
306 * @return string|null
308 public static function getUrlPath() {
309 if (isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
310 return $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
];
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
329 public static function href(
330 $text, $path = NULL, $query = NULL, $absolute = TRUE,
331 $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
333 $url = self
::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
334 return "<a href=\"$url\">$text</a>";
338 * What menu path are we currently on. Called for the primary tpl.
341 * the current menu path
343 public static function currentPath() {
344 $config = CRM_Core_Config
::singleton();
345 return trim(CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET), '/');
349 * Called from a template to compose a url.
351 * @param array $params
352 * List of parameters.
357 public static function crmURL($params) {
358 $p = CRM_Utils_Array
::value('p', $params);
360 $p = self
::currentPath();
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)
375 * Sets the title of the page.
377 * @param string $title
378 * Document title - plain text only
379 * @param string $pageTitle
380 * Page title (if different) - may include html
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);
389 * Figures and sets the userContext.
391 * Uses the referrer if valid else uses the default.
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.
398 public static function setUserContext($names, $default = NULL) {
401 $session = CRM_Core_Session
::singleton();
402 $referer = CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
404 if ($referer && !empty($names)) {
405 foreach ($names as $name) {
406 if (strstr($referer, $name)) {
414 $session->pushUserContext($url);
419 * Gets a class name for an object.
421 * @param object $object
422 * Object whose class name is needed.
425 * The class name of the object.
427 public static function getClassName($object) {
428 return get_class($object);
432 * Redirect to another URL.
435 * The URL to provide to the browser via the Location header.
436 * @param array $context
437 * Optional additional information for the hook.
439 public static function redirect($url = NULL, $context = []) {
441 $url = self
::url('civicrm/dashboard', 'reset=1');
443 // replace the & characters with &
444 // this is kinda hackish but not sure how to do it right
445 $url = str_replace('&', '&', $url);
447 $context['output'] = CRM_Utils_Array
::value('snippet', $_GET);
449 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
450 CRM_Utils_Hook
::alterRedirect($parsedUrl, $context);
451 $url = CRM_Utils_Url
::unparseUrl($parsedUrl);
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,
461 self
::setHttpHeader('Location', $url);
466 * Redirect to another URL using JavaScript.
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
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.
478 public static function jsRedirect(
484 $url = self
::url('civicrm/dashboard', 'reset=1');
488 $title = ts('CiviCRM task in progress');
492 $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
495 // replace the & characters with &
496 // this is kinda hackish but not sure how to do it right
497 $url = str_replace('&', '&', $url);
499 $template = CRM_Core_Smarty
::singleton();
500 $template->assign('redirectURL', $url);
501 $template->assign('title', $title);
502 $template->assign('message', $message);
504 $html = $template->fetch('CRM/common/redirectJS.tpl');
512 * Get the base URL of the system.
516 public static function baseURL() {
517 $config = CRM_Core_Config
::singleton();
518 return $config->userFrameworkBaseURL
;
522 * Authenticate or abort.
524 * @param string $message
529 public static function authenticateAbort($message, $abort) {
543 * (optional) Whether to exit; defaults to true.
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));
551 $docAdd = "More info at:" . CRM_Utils_System
::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
554 return self
::authenticateAbort(
555 "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
560 $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: NULL;
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",
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",
576 if ($key !== $siteKey) {
577 return self
::authenticateAbort(
578 "ERROR: Invalid key value sent. " . $docAdd . "\n",
587 * Authenticate script.
590 * @param string $name
591 * @param string $pass
592 * @param bool $storeInSession
593 * @param bool $loadCMSBootstrap
594 * @param bool $requireKey
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
602 $name = trim(CRM_Utils_Array
::value('name', $_REQUEST));
603 $pass = trim(CRM_Utils_Array
::value('pass', $_REQUEST));
606 // its ok to have an empty password
608 return self
::authenticateAbort(
609 "ERROR: You need to send a valid user name and password to execute this file\n",
614 if ($requireKey && !self
::authenticateKey($abort)) {
618 $result = CRM_Utils_System
::authenticate($name, $pass, $loadCMSBootstrap);
620 return self
::authenticateAbort(
621 "ERROR: Invalid username and/or password\n",
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]);
633 return self
::authenticateAbort(
634 "ERROR: Unexpected error, could not match userID and contactID",
644 * Authenticate the user against the uf db.
646 * In case of successful authentication, returns an array consisting of
647 * (contactID, ufID, unique string). Returns FALSE if authentication is
650 * @param string $name
652 * @param string $password
654 * @param bool $loadCMSBootstrap
655 * @param string $realPath
657 * @return false|array
659 public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
660 $config = CRM_Core_Config
::singleton();
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
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
671 $session = CRM_Core_Session
::singleton();
672 $session->set('civicrmInitSession', TRUE);
674 if ($config->userFrameworkDSN
) {
675 $dbDrupal = DB
::connect($config->userFrameworkDSN
);
677 return $config->userSystem
->authenticate($name, $password, $loadCMSBootstrap, $realPath);
681 * Set a message in the UF to display to a user.
683 * @param string $message
684 * The message to set.
686 public static function setUFMessage($message) {
687 $config = CRM_Core_Config
::singleton();
688 return $config->userSystem
->setMessage($message);
692 * Determine whether a value is null-ish.
694 * @param mixed $value
695 * The value to check for null.
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') {
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)) {
717 * Obscure all but the last few digits of a credit card number.
719 * @param string $number
720 * The credit card number to obscure.
722 * (optional) The number of digits to preserve unmodified.
725 * The obscured credit card number.
727 public static function mungeCreditCard($number, $keep = 4) {
728 $number = trim($number);
729 if (empty($number)) {
732 $replace = str_repeat('*', strlen($number) - $keep);
733 return substr_replace($number, $replace, 0, -$keep);
737 * Determine which PHP modules are loaded.
741 private static function parsePHPModules() {
743 phpinfo(INFO_MODULES
);
744 $s = ob_get_contents();
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
);
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/";
761 if (preg_match($vPat3, $vOne, $vMat)) {
762 $vModules[$vName][trim($vMat[1])] = [trim($vMat[2]), trim($vMat[3])];
765 elseif (preg_match($vPat2, $vOne, $vMat)) {
766 $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
775 * Get a setting from a loaded PHP module.
777 * @param string $pModuleName
778 * @param string $pSetting
782 public static function getModuleSetting($pModuleName, $pSetting) {
783 $vModules = self
::parsePHPModules();
784 return $vModules[$pModuleName][$pSetting];
788 * Do something no-one bothered to document.
790 * @param string $title
793 * @return mixed|string
795 public static function memory($title = NULL) {
798 $pid = posix_getpid();
801 $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
802 $memory .= ", " . time();
804 CRM_Core_Error
::debug_var($title, $memory);
810 * Download something or other.
812 * @param string $name
813 * @param string $mimeType
814 * @param string $buffer
816 * @param bool $output
817 * @param string $disposition
819 public static function download(
820 $name, $mimeType, &$buffer,
823 $disposition = 'attachment'
825 $now = gmdate('D, d M Y H:i:s') . ' GMT';
827 self
::setHttpHeader('Content-Type', $mimeType);
828 self
::setHttpHeader('Expires', $now);
830 // lem9 & loic1: IE needs specific headers
831 $isIE = empty($_SERVER['HTTP_USER_AGENT']) ?
FALSE : strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
833 $fileString = "filename=\"{$name}.{$ext}\"";
836 $fileString = "filename=\"{$name}\"";
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');
844 self
::setHttpHeader("Content-Disposition", "$disposition; $fileString");
845 self
::setHttpHeader('Pragma', 'no-cache');
855 * Gather and print (and possibly log) amount of used memory.
857 * @param string $title
859 * (optional) Whether to log the memory usage information.
861 public static function xMemory($title = NULL, $log = FALSE) {
862 $mem = (float ) xdebug_memory_usage() / (float ) (1024);
863 $mem = number_format($mem, 5) . ", " . time();
865 echo "<p>$title: $mem<p>";
867 CRM_Core_Error
::debug_var($title, $mem);
870 echo "<p>$title: $mem<p>";
876 * Take a URL (or partial URL) and make it better.
878 * Currently, URLs pass straight through unchanged unless they are "seriously
879 * malformed" (see http://us2.php.net/parse_url).
882 * The URL to operate on.
887 public static function fixURL($url) {
888 $components = parse_url($url);
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
900 * Make sure a callback is valid in the current context.
902 * @param string $callback
903 * Name of the function to check.
907 public static function validCallback($callback) {
908 if (self
::$_callbacks === NULL) {
909 self
::$_callbacks = [];
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;
922 // instantiate the class
923 $object = new $className();
924 if (!method_exists($object, $methodName)) {
925 self
::$_callbacks[$callback] = FALSE;
928 self
::$_callbacks[$callback] = TRUE;
933 self
::$_callbacks[$callback] = function_exists($callback);
936 return self
::$_callbacks[$callback];
940 * Like PHP's built-in explode(), but always return an array of $limit items.
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.
946 * @param string $separator
947 * @param string $string
952 public static function explode($separator, $string, $limit) {
953 $result = explode($separator, $string, $limit);
954 for ($i = count($result); $i < $limit; $i++
) {
965 * @param bool $addCookie
970 public static function checkURL($url, $addCookie = FALSE) {
971 // make a GET request to $url
972 $ch = curl_init($url);
974 curl_setopt($ch, CURLOPT_COOKIE
, http_build_query($_COOKIE));
976 // it's quite alright to use a self-signed cert
977 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, 0);
979 // lets capture the return stuff rather than echo
980 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
982 // CRM-13227, CRM-14744: only return the SSL error status
983 return (curl_exec($ch) !== FALSE);
987 * Assert that we are running on a particular PHP version.
990 * The major version of PHP that is required.
992 * (optional) Whether to fatally abort if the version requirement is not
993 * met. Defaults to TRUE.
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.
1000 public static function checkPHPVersion($ver = 5, $abort = TRUE) {
1001 $phpVersion = substr(PHP_VERSION
, 0, 1);
1002 if ($phpVersion >= $ver) {
1007 CRM_Core_Error
::fatal(ts('This feature requires PHP Version %1 or greater',
1017 * @param string $string
1018 * @param bool $encode
1022 public static function formatWikiURL($string, $encode = FALSE) {
1023 $items = explode(' ', trim($string), 2);
1024 if (count($items) == 2) {
1032 $url = $encode ? self
::urlEncode($items[0]) : $items[0];
1033 return "<a href=\"$url\">$title</a>";
1039 * @param string $url
1041 * @return null|string
1043 public static function urlEncode($url) {
1044 $items = parse_url($url);
1045 if ($items === FALSE) {
1049 if (empty($items['query'])) {
1053 $items['query'] = urlencode($items['query']);
1055 $url = $items['scheme'] . '://';
1056 if (!empty($items['user'])) {
1057 $url .= "{$items['user']}:{$items['pass']}@";
1060 $url .= $items['host'];
1061 if (!empty($items['port'])) {
1062 $url .= ":{$items['port']}";
1065 $url .= "{$items['path']}?{$items['query']}";
1066 if (!empty($items['fragment'])) {
1067 $url .= "#{$items['fragment']}";
1074 * Return the running civicrm version.
1079 public static function version() {
1083 $verFile = implode(DIRECTORY_SEPARATOR
,
1084 [dirname(__FILE__
), '..', '..', 'xml', 'version.xml']
1086 if (file_exists($verFile)) {
1087 $str = file_get_contents($verFile);
1088 $xmlObj = simplexml_load_string($str);
1089 $version = (string) $xmlObj->version_no
;
1093 if (!CRM_Utils_System
::isVersionFormatValid($version)) {
1094 CRM_Core_Error
::fatal('Unknown codebase version.');
1102 * Gives the first two parts of the version string E.g. 6.1.
1106 public static function majorVersion() {
1107 list($a, $b) = explode('.', self
::version());
1112 * Determines whether a string is a valid CiviCRM version string.
1114 * @param string $version
1115 * Version string to be checked.
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);
1124 * Wraps or emulates PHP's getallheaders() function.
1126 public static function getAllHeaders() {
1127 if (function_exists('getallheaders')) {
1128 return getallheaders();
1131 // emulate get all headers
1132 // http://www.php.net/manual/en/function.getallheaders.php#66335
1134 foreach ($_SERVER as $name => $value) {
1135 if (substr($name, 0, 5) == 'HTTP_') {
1136 $headers[str_replace(' ',
1138 ucwords(strtolower(str_replace('_',
1150 * Get request headers.
1152 * @return array|false
1154 public static function getRequestHeaders() {
1155 if (function_exists('apache_request_headers')) {
1156 return apache_request_headers();
1164 * Determine whether this is an SSL request.
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.
1169 public static function isSSL() {
1170 return (isset($_SERVER['HTTPS']) &&
1171 !empty($_SERVER['HTTPS']) &&
1172 strtolower($_SERVER['HTTPS']) != 'off') ?
TRUE : FALSE;
1178 * @param bool|FALSE $abort
1180 * @throws \Exception
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') &&
1188 strtolower(CRM_Utils_Array
::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
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)) {
1196 CRM_Core_Error
::fatal('HTTPS is not set up on this machine');
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
1205 CRM_Utils_System
::redirect($url);
1210 * Get logged in user's IP address.
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)
1216 * @param bool $strictIPV4
1217 * (optional) Whether to return only IPv4 addresses.
1220 * IP address of logged in user.
1222 public static function ipAddress($strictIPV4 = TRUE) {
1223 $address = CRM_Utils_Array
::value('REMOTE_ADDR', $_SERVER);
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();
1233 if ($address == '::1') {
1234 $address = '127.0.0.1';
1237 // when we need to have strictly IPV4 ip address
1238 // convert ipV6 to ipV4
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:');
1250 * Get the referring / previous page URL.
1253 * The previous page URL
1255 public static function refererPath() {
1256 return CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
1260 * Get the documentation base URL.
1263 * Base URL of the CRM documentation.
1265 public static function getDocBaseURL() {
1266 // FIXME: move this to configuration at some stage
1267 return 'https://docs.civicrm.org/';
1271 * Returns wiki (alternate) documentation URL base.
1276 public static function getWikiBaseURL() {
1277 // FIXME: move this to configuration at some stage
1278 return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1282 * Returns URL or link to documentation page, based on provided parameters.
1284 * For use in PHP code.
1285 * WARNING: Always returns URL, if ts function is not defined ($URLonly has
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)
1299 * @param null $resource
1302 * URL or link to documentation page, based on provided parameters.
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();
1312 $docBaseURL = self
::getDocBaseURL();
1313 $page = self
::formatDocUrl($page);
1315 return $docBaseURL . str_replace(' ', '+', $page);
1320 'URLonly' => $URLonly,
1324 'resource' => $resource,
1326 return self
::docURL($params);
1331 * Returns URL or link to documentation page, based on provided parameters.
1333 * For use in templates code.
1335 * @param array $params
1336 * An array of parameters (see CRM_Utils_System::docURL2 method for names)
1338 * @return null|string
1339 * URL or link to documentation page, based on provided parameters.
1341 public static function docURL($params) {
1343 if (!isset($params['page'])) {
1347 if (CRM_Utils_Array
::value('resource', $params) == 'wiki') {
1348 $docBaseURL = self
::getWikiBaseURL();
1351 $docBaseURL = self
::getDocBaseURL();
1352 $params['page'] = self
::formatDocUrl($params['page']);
1355 if (!isset($params['title']) or $params['title'] === NULL) {
1356 $params['title'] = ts('Opens documentation in a new window.');
1359 if (!isset($params['text']) or $params['text'] === NULL) {
1360 $params['text'] = ts('(learn more...)');
1363 if (!isset($params['style']) ||
$params['style'] === NULL) {
1367 $style = "style=\"{$params['style']}\"";
1370 $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1372 if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1376 return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1381 * Add language and version parameters to the doc url.
1383 * Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.
1388 public static function formatDocUrl($url) {
1389 return preg_replace('#^(user|sysadmin|dev)/#', '\1/en/stable/', $url);
1393 * Exit with provided exit code.
1395 * @param int $status
1396 * (optional) Code with which to exit.
1398 * @param array $testParameters
1400 public static function civiExit($status = 0, $testParameters = []) {
1402 if (CIVICRM_UF
=== 'UnitTests') {
1403 throw new CRM_Core_Exception_PrematureExitException('civiExit called', $testParameters);
1406 http_response_code(500);
1408 // move things to CiviCRM cache as needed
1409 CRM_Core_Session
::storeSessionObjects();
1411 if (Civi\Core\Container
::isContainerBooted()) {
1412 Civi
::dispatcher()->dispatch('civi.core.exit');
1415 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
1416 if (is_callable([$userSystem, 'onCiviExit'])) {
1417 $userSystem->onCiviExit();
1423 * Reset the various system caches and some important static variables.
1425 public static function flushCache() {
1426 // flush out all cache entries so we can reload new data
1427 // a bit aggressive, but livable for now
1428 CRM_Utils_Cache
::singleton()->flush();
1430 // Traditionally, systems running on memory-backed caches were quite
1431 // zealous about destroying *all* memory-backed caches during a flush().
1432 // These flushes simulate that legacy behavior. However, they should probably
1433 // be removed at some point.
1434 $localDrivers = ['CRM_Utils_Cache_ArrayCache', 'CRM_Utils_Cache_NoCache'];
1435 if (Civi\Core\Container
::isContainerBooted()
1436 && !in_array(get_class(CRM_Utils_Cache
::singleton()), $localDrivers)) {
1437 Civi
::cache('long')->flush();
1438 Civi
::cache('settings')->flush();
1439 Civi
::cache('js_strings')->flush();
1440 Civi
::cache('community_messages')->flush();
1441 Civi
::cache('groups')->flush();
1442 Civi
::cache('navigation')->flush();
1443 Civi
::cache('customData')->flush();
1444 Civi
::cache('contactTypes')->clear();
1445 Civi
::cache('metadata')->clear();
1446 CRM_Extension_System
::singleton()->getCache()->flush();
1447 CRM_Cxn_CiviCxnHttp
::singleton()->getCache()->flush();
1450 // also reset the various static memory caches
1452 // reset the memory or array cache
1453 Civi
::cache('fields')->flush();
1456 CRM_ACL_BAO_Cache
::resetCache();
1458 // reset various static arrays used here
1459 CRM_Contact_BAO_Contact
::$_importableFields = CRM_Contact_BAO_Contact
::$_exportableFields
1460 = CRM_Contribute_BAO_Contribution
::$_importableFields
1461 = CRM_Contribute_BAO_Contribution
::$_exportableFields
1462 = CRM_Pledge_BAO_Pledge
::$_exportableFields
1463 = CRM_Core_BAO_CustomField
::$_importFields
1464 = CRM_Core_BAO_Cache
::$_cache = CRM_Core_DAO
::$_dbColumnValueCache = NULL;
1466 CRM_Core_OptionGroup
::flushAll();
1467 CRM_Utils_PseudoConstant
::flushAll();
1471 * Load CMS bootstrap.
1473 * @param array $params
1474 * Array with uid name and pass
1475 * @param bool $loadUser
1476 * Boolean load user or not.
1477 * @param bool $throwError
1478 * @param string $realPath
1480 public static function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1481 if (!is_array($params)) {
1484 $config = CRM_Core_Config
::singleton();
1485 $result = $config->userSystem
->loadBootStrap($params, $loadUser, $throwError, $realPath);
1486 if (is_callable([$config->userSystem
, 'setMySQLTimeZone'])) {
1487 $config->userSystem
->setMySQLTimeZone();
1495 * @return mixed|string
1497 public static function baseCMSURL() {
1498 static $_baseURL = NULL;
1500 $config = CRM_Core_Config
::singleton();
1501 $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL
;
1503 if ($config->userFramework
== 'Joomla') {
1505 // we need to remove the administrator/ from the end
1506 $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1510 global $civicrm_root;
1511 if (strpos($civicrm_root,
1512 DIRECTORY_SEPARATOR
. 'sites' .
1513 DIRECTORY_SEPARATOR
. 'all' .
1514 DIRECTORY_SEPARATOR
. 'modules'
1517 $startPos = strpos($civicrm_root,
1518 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
1520 $endPos = strpos($civicrm_root,
1521 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
1523 if ($startPos && $endPos) {
1524 // if component is in sites/SITENAME/modules
1525 $siteName = substr($civicrm_root,
1527 $endPos - $startPos - 7
1530 $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1539 * Given a URL, return a relative URL if possible.
1541 * @param string $url
1545 public static function relativeURL($url) {
1546 // check if url is relative, if so return immediately
1547 if (substr($url, 0, 4) != 'http') {
1551 // make everything relative from the baseFilePath
1552 $baseURL = self
::baseCMSURL();
1554 // check if baseURL is a substr of $url, if so
1555 // return rest of string
1556 if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1557 return substr($url, strlen($baseURL));
1560 // return the original value
1565 * Produce an absolute URL from a possibly-relative URL.
1567 * @param string $url
1568 * @param bool $removeLanguagePart
1572 public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1573 // check if url is already absolute, if so return immediately
1574 if (substr($url, 0, 4) == 'http') {
1578 // make everything absolute from the baseFileURL
1579 $baseURL = self
::baseCMSURL();
1581 //CRM-7622: drop the language from the URL if requested (and it’s there)
1582 $config = CRM_Core_Config
::singleton();
1583 if ($removeLanguagePart) {
1584 $baseURL = self
::languageNegotiationURL($baseURL, FALSE, TRUE);
1587 return $baseURL . $url;
1591 * Clean url, replaces first '&' with '?'.
1593 * @param string $url
1598 public static function cleanUrl($url) {
1603 if ($pos = strpos($url, '&')) {
1604 $url = substr_replace($url, '?', $pos, 1);
1611 * Format the url as per language Negotiation.
1613 * @param string $url
1615 * @param bool $addLanguagePart
1616 * @param bool $removeLanguagePart
1621 public static function languageNegotiationURL(
1623 $addLanguagePart = TRUE,
1624 $removeLanguagePart = FALSE
1626 return CRM_Core_Config
::singleton()->userSystem
->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1630 * Append the contents of an 'extra' smarty template file.
1632 * It must be present in the custom template directory. This does not work if there are
1633 * multiple custom template directories
1635 * @param string $fileName
1636 * The name of the tpl file that we are processing.
1637 * @param string $content
1638 * The current content string. May be modified by this function.
1639 * @param string $overideFileName
1640 * (optional) Sent by contribution/event reg/profile pages which uses a id
1641 * specific extra file name if present.
1643 public static function appendTPLFile(
1646 $overideFileName = NULL
1648 $template = CRM_Core_Smarty
::singleton();
1649 if ($overideFileName) {
1650 $additionalTPLFile = $overideFileName;
1653 $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1656 if ($template->template_exists($additionalTPLFile)) {
1657 $content .= $template->fetch($additionalTPLFile);
1662 * Get a list of all files that are found within the directories.
1664 * Files must be the result of appending the provided relative path to
1665 * each component of the PHP include path.
1667 * @author Ken Zalewski
1669 * @param string $relpath
1670 * A relative path, typically pointing to a directory with multiple class
1674 * An array of files that exist in one or more of the directories that are
1675 * referenced by the relative path when appended to each element of the PHP
1678 public static function listIncludeFiles($relpath) {
1680 $inc_dirs = explode(PATH_SEPARATOR
, get_include_path());
1681 foreach ($inc_dirs as $inc_dir) {
1682 $target_dir = $inc_dir . DIRECTORY_SEPARATOR
. $relpath;
1683 if (is_dir($target_dir)) {
1684 $cur_list = scandir($target_dir);
1685 foreach ($cur_list as $fname) {
1686 if ($fname != '.' && $fname != '..') {
1687 $file_list[$fname] = $fname;
1696 * Get a list of all "plugins".
1698 * (PHP classes that implement a piece of
1699 * functionality using a well-defined interface) that are found in a
1700 * particular CiviCRM directory (both custom and core are searched).
1702 * @author Ken Zalewski
1704 * @param string $relpath
1705 * A relative path referencing a directory that contains one or more
1707 * @param string $fext
1708 * (optional) Only files with this extension will be considered to be
1710 * @param array $skipList
1711 * (optional) List of files to skip.
1714 * List of plugins, where the plugin name is both the key and the value of
1717 public static function getPluginList($relpath, $fext = '.php', $skipList = []) {
1718 $fext_len = strlen($fext);
1720 $inc_files = CRM_Utils_System
::listIncludeFiles($relpath);
1721 foreach ($inc_files as $inc_file) {
1722 if (substr($inc_file, 0 - $fext_len) == $fext) {
1723 $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1724 if (!in_array($plugin_name, $skipList)) {
1725 $plugins[$plugin_name] = $plugin_name;
1733 * Execute scheduled jobs.
1735 public static function executeScheduledJobs() {
1736 $facility = new CRM_Core_JobManager();
1737 $facility->execute(FALSE);
1739 $redirectUrl = self
::url('civicrm/admin/job', 'reset=1');
1741 CRM_Core_Session
::setStatus(
1742 ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1743 ts('Complete'), 'success');
1745 CRM_Utils_System
::redirect($redirectUrl);
1749 * Evaluate any tokens in a URL.
1751 * @param string|FALSE $url
1753 * @return string|FALSE
1755 public static function evalUrl($url) {
1756 if (!$url ||
strpos($url, '{') === FALSE) {
1760 $config = CRM_Core_Config
::singleton();
1762 '{ver}' => CRM_Utils_System
::version(),
1763 '{uf}' => $config->userFramework
,
1764 '{php}' => phpversion(),
1765 '{sid}' => self
::getSiteID(),
1766 '{baseUrl}' => $config->userFrameworkBaseURL
,
1767 '{lang}' => $config->lcMessages
,
1768 '{co}' => $config->defaultContactCountry
,
1770 return strtr($url, array_map('urlencode', $vars));
1775 * Returns the unique identifier for this site, as used by community messages.
1777 * SiteID will be generated if it is not already stored in the settings table.
1781 public static function getSiteID() {
1782 $sid = Civi
::settings()->get('site_id');
1784 $config = CRM_Core_Config
::singleton();
1785 $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '') . '_' . $config->userFrameworkBaseURL
);
1786 civicrm_api3('Setting', 'create', ['domain_id' => 'all', 'site_id' => $sid]);
1792 * Determine whether this is a developmental system.
1796 public static function isDevelopment() {
1797 static $cache = NULL;
1798 if ($cache === NULL) {
1799 global $civicrm_root;
1800 $cache = file_exists("{$civicrm_root}/.svn") ||
file_exists("{$civicrm_root}/.git");
1806 * Is in upgrade mode.
1810 public static function isInUpgradeMode() {
1811 $args = explode('/', CRM_Utils_Array
::value('q', $_GET));
1812 $upgradeInProcess = CRM_Core_Session
::singleton()->get('isUpgradePending');
1813 if ((isset($args[1]) && $args[1] == 'upgrade') ||
$upgradeInProcess) {
1822 * Determine the standard URL for viewing or editing the specified link.
1824 * This function delegates the decision-making to (a) the hook system and
1825 * (b) the BAO system.
1827 * @param array $crudLinkSpec
1829 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1830 * - entity_table: string, eg "civicrm_contact"
1833 * @return array|NULL
1834 * NULL if unavailable, or an array. array has keys:
1840 public static function createDefaultCrudLink($crudLinkSpec) {
1841 $crudLinkSpec['action'] = CRM_Utils_Array
::value('action', $crudLinkSpec, CRM_Core_Action
::VIEW
);
1842 $daoClass = CRM_Core_DAO_AllCoreTables
::getClassForTable($crudLinkSpec['entity_table']);
1847 $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1848 if (!class_exists($baoClass)) {
1852 $bao = new $baoClass();
1853 $bao->id
= $crudLinkSpec['entity_id'];
1854 if (!$bao->find(TRUE)) {
1859 CRM_Utils_Hook
::crudLink($crudLinkSpec, $bao, $link);
1860 if (empty($link) && is_callable([$bao, 'createDefaultCrudLink'])) {
1861 $link = $bao->createDefaultCrudLink($crudLinkSpec);
1864 if (!empty($link)) {
1865 if (!isset($link['url'])) {
1866 $link['url'] = self
::url($link['path'], $link['query'], TRUE, NULL, FALSE);
1875 * Return an HTTP Response with appropriate content and status code set.
1876 * @param \Psr\Http\Message\ResponseInterface $response
1878 public static function sendResponse(\Psr\Http\Message\ResponseInterface
$response) {
1879 $config = CRM_Core_Config
::singleton()->userSystem
->sendResponse($response);