3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 (c) 2004-2019
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.
56 * @method static sendResponse(\Psr\Http\Message\ResponseInterface $response) function to handle RepsoseInterface for delivering HTTP Responses.
58 class CRM_Utils_System
{
60 public static $_callbacks = NULL;
66 public static $title = '';
69 * Access methods in the appropriate CMS class
75 public static function __callStatic($name, $arguments) {
76 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
77 return call_user_func_array([$userSystem, $name], $arguments);
81 * Compose a new URL string from the current URL string.
83 * Used by all the framework components, specifically,
86 * @param string $urlVar
87 * The url variable being considered (i.e. crmPageID, crmSortID etc).
88 * @param bool $includeReset
89 * (optional) Whether to include the reset GET string (if present).
90 * @param bool $includeForce
91 * (optional) Whether to include the force GET string (if present).
93 * (optional) The path to use for the new url.
94 * @param bool|string $absolute
95 * (optional) Whether to return an absolute URL.
100 public static function makeURL($urlVar, $includeReset = FALSE, $includeForce = TRUE, $path = NULL, $absolute = FALSE) {
102 $config = CRM_Core_Config
::singleton();
103 $path = CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET);
111 CRM_Utils_System
::getLinksUrl($urlVar, $includeReset, $includeForce),
117 * Get the query string and clean it up.
119 * Strips some variables that should not be propagated, specifically variables
120 * like 'reset'. Also strips any side-affect actions (e.g. export).
122 * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
124 * @param string $urlVar
125 * The URL variable being considered (e.g. crmPageID, crmSortID etc).
126 * @param bool $includeReset
127 * (optional) By default this is FALSE, meaning that the reset parameter
128 * is skipped. Set to TRUE to leave the reset parameter as-is.
129 * @param bool $includeForce
131 * @param bool $skipUFVar
136 public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
137 // Sort out query string to prevent messy urls
142 if (!empty($_SERVER['QUERY_STRING'])) {
143 $qs = explode('&', str_replace('&', '&', $_SERVER['QUERY_STRING']));
144 for ($i = 0, $cnt = count($qs); $i < $cnt; $i++
) {
145 // check first if exist a pair
146 if (strstr($qs[$i], '=') !== FALSE) {
147 list($name, $value) = explode('=', $qs[$i]);
148 if ($name != $urlVar) {
149 $name = rawurldecode($name);
150 // check for arrays in parameters: site.php?foo[]=1&foo[]=2&foo[]=3
151 if ((strpos($name, '[') !== FALSE) &&
152 (strpos($name, ']') !== FALSE)
172 // Ok this is a big assumption but usually works
173 // If we are in snippet mode, retain the 'section' param, if not, get rid
175 if (!empty($qs['snippet'])) {
176 unset($qs['snippet']);
179 unset($qs['section']);
183 $config = CRM_Core_Config
::singleton();
184 unset($qs[$config->userFrameworkURLVar
]);
187 foreach ($qs as $name => $value) {
188 if ($name != 'reset' ||
$includeReset) {
189 $querystring[] = $name . '=' . $value;
193 $querystring = array_merge($querystring, array_unique($arrays));
195 $url = implode('&', $querystring);
197 $url .= (!empty($querystring) ?
'&' : '') . $urlVar . '=';
204 * If we are using a theming system, invoke theme, else just print the content.
206 * @param string $content
207 * The content that will be themed.
209 * (optional) Are we displaying to the screen or bypassing theming?
210 * @param bool $maintenance
211 * (optional) For maintenance mode.
215 public static function theme(
220 return CRM_Core_Config
::singleton()->userSystem
->theme($content, $print, $maintenance);
224 * Generate a query string if input is an array.
226 * @param array|string $query
230 public static function makeQueryString($query) {
231 if (is_array($query)) {
233 foreach ($query as $key => $value) {
234 $buf .= ($buf ?
'&' : '') . urlencode($key) . '=' . urlencode($value);
242 * Generate an internal CiviCRM URL.
244 * @param string $path
245 * The path being linked to, such as "civicrm/add".
246 * @param array|string $query
247 * A query string to append to the link, or an array of key-value pairs.
248 * @param bool $absolute
249 * Whether to force the output to be an absolute link (beginning with a
250 * URI-scheme such as 'http:'). Useful for links that will be displayed
251 * outside the site, such as in an RSS feed.
252 * @param string $fragment
253 * A fragment identifier (named anchor) to append to the link.
254 * @param bool $htmlize
255 * Whether to encode special html characters such as &.
256 * @param bool $frontend
257 * This link should be to the CMS front end (applies to WP & Joomla).
258 * @param bool $forceBackend
259 * This link should be to the CMS back end (applies to WP & Joomla).
262 * An HTML string containing a link to the given path.
264 public static function url(
271 $forceBackend = FALSE
273 $query = self
::makeQueryString($query);
275 // Legacy handling for when the system passes around html escaped strings
276 if (strstr($query, '&')) {
277 $query = html_entity_decode($query);
280 // Extract fragment from path or query if munged together
281 if ($query && strstr($query, '#')) {
282 list($path, $fragment) = explode('#', $query);
284 if ($path && strstr($path, '#')) {
285 list($path, $fragment) = explode('#', $path);
288 // Extract query from path if munged together
289 if ($path && strstr($path, '?')) {
290 list($path, $extraQuery) = explode('?', $path);
291 $query = $extraQuery . ($query ?
"&$query" : '');
294 $config = CRM_Core_Config
::singleton();
295 $url = $config->userSystem
->url($path, $query, $absolute, $fragment, $frontend, $forceBackend);
298 $url = htmlentities($url);
305 * Path of the current page e.g. 'civicrm/contact/view'
307 * @return string|null
309 public static function getUrlPath() {
310 if (isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
311 return $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
];
319 * @param string $text
320 * @param string $path
321 * @param string|array $query
322 * @param bool $absolute
323 * @param string $fragment
324 * @param bool $htmlize
325 * @param bool $frontend
326 * @param bool $forceBackend
330 public static function href(
331 $text, $path = NULL, $query = NULL, $absolute = TRUE,
332 $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
334 $url = self
::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
335 return "<a href=\"$url\">$text</a>";
339 * What menu path are we currently on. Called for the primary tpl.
342 * the current menu path
344 public static function currentPath() {
345 $config = CRM_Core_Config
::singleton();
346 return trim(CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET), '/');
350 * Called from a template to compose a url.
352 * @param array $params
353 * List of parameters.
358 public static function crmURL($params) {
359 $p = CRM_Utils_Array
::value('p', $params);
361 $p = self
::currentPath();
366 CRM_Utils_Array
::value('q', $params),
367 CRM_Utils_Array
::value('a', $params, FALSE),
368 CRM_Utils_Array
::value('f', $params),
369 CRM_Utils_Array
::value('h', $params, TRUE),
370 CRM_Utils_Array
::value('fe', $params, FALSE),
371 CRM_Utils_Array
::value('fb', $params, FALSE)
376 * Sets the title of the page.
378 * @param string $title
379 * Document title - plain text only
380 * @param string $pageTitle
381 * Page title (if different) - may include html
383 public static function setTitle($title, $pageTitle = NULL) {
384 self
::$title = $title;
385 $config = CRM_Core_Config
::singleton();
386 return $config->userSystem
->setTitle($title, $pageTitle);
390 * Figures and sets the userContext.
392 * Uses the referrer if valid else uses the default.
394 * @param array $names
395 * Referrer should match any str in this array.
396 * @param string $default
397 * (optional) The default userContext if no match found.
399 public static function setUserContext($names, $default = NULL) {
402 $session = CRM_Core_Session
::singleton();
403 $referer = CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
405 if ($referer && !empty($names)) {
406 foreach ($names as $name) {
407 if (strstr($referer, $name)) {
415 $session->pushUserContext($url);
420 * Gets a class name for an object.
422 * @param object $object
423 * Object whose class name is needed.
426 * The class name of the object.
428 public static function getClassName($object) {
429 return get_class($object);
433 * Redirect to another URL.
436 * The URL to provide to the browser via the Location header.
437 * @param array $context
438 * Optional additional information for the hook.
440 public static function redirect($url = NULL, $context = []) {
442 $url = self
::url('civicrm/dashboard', 'reset=1');
444 // replace the & characters with &
445 // this is kinda hackish but not sure how to do it right
446 $url = str_replace('&', '&', $url);
448 $context['output'] = CRM_Utils_Array
::value('snippet', $_GET);
450 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
451 CRM_Utils_Hook
::alterRedirect($parsedUrl, $context);
452 $url = CRM_Utils_Url
::unparseUrl($parsedUrl);
454 // If we are in a json context, respond appropriately
455 if ($context['output'] === 'json') {
456 CRM_Core_Page_AJAX
::returnJsonResponse([
457 'status' => 'redirect',
458 'userContext' => $url,
462 self
::setHttpHeader('Location', $url);
467 * Redirect to another URL using JavaScript.
469 * Use an html based file with javascript embedded to redirect to another url
470 * This prevent the too many redirect errors emitted by various browsers
473 * (optional) The destination URL.
474 * @param string $title
475 * (optional) The page title to use for the redirect page.
476 * @param string $message
477 * (optional) The message to provide in the body of the redirect page.
479 public static function jsRedirect(
485 $url = self
::url('civicrm/dashboard', 'reset=1');
489 $title = ts('CiviCRM task in progress');
493 $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
496 // replace the & characters with &
497 // this is kinda hackish but not sure how to do it right
498 $url = str_replace('&', '&', $url);
500 $template = CRM_Core_Smarty
::singleton();
501 $template->assign('redirectURL', $url);
502 $template->assign('title', $title);
503 $template->assign('message', $message);
505 $html = $template->fetch('CRM/common/redirectJS.tpl');
513 * Get the base URL of the system.
517 public static function baseURL() {
518 $config = CRM_Core_Config
::singleton();
519 return $config->userFrameworkBaseURL
;
523 * Authenticate or abort.
525 * @param string $message
530 public static function authenticateAbort($message, $abort) {
544 * (optional) Whether to exit; defaults to true.
548 public static function authenticateKey($abort = TRUE) {
549 // also make sure the key is sent and is valid
550 $key = trim(CRM_Utils_Array
::value('key', $_REQUEST));
552 $docAdd = "More info at:" . CRM_Utils_System
::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
555 return self
::authenticateAbort(
556 "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
561 $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: NULL;
563 if (!$siteKey ||
empty($siteKey)) {
564 return self
::authenticateAbort(
565 "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
570 if (strlen($siteKey) < 8) {
571 return self
::authenticateAbort(
572 "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
577 if ($key !== $siteKey) {
578 return self
::authenticateAbort(
579 "ERROR: Invalid key value sent. " . $docAdd . "\n",
588 * Authenticate script.
591 * @param string $name
592 * @param string $pass
593 * @param bool $storeInSession
594 * @param bool $loadCMSBootstrap
595 * @param bool $requireKey
599 public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
600 // auth to make sure the user has a login/password to do a shell operation
601 // later on we'll link this to acl's
603 $name = trim(CRM_Utils_Array
::value('name', $_REQUEST));
604 $pass = trim(CRM_Utils_Array
::value('pass', $_REQUEST));
607 // its ok to have an empty password
609 return self
::authenticateAbort(
610 "ERROR: You need to send a valid user name and password to execute this file\n",
615 if ($requireKey && !self
::authenticateKey($abort)) {
619 $result = CRM_Utils_System
::authenticate($name, $pass, $loadCMSBootstrap);
621 return self
::authenticateAbort(
622 "ERROR: Invalid username and/or password\n",
626 elseif ($storeInSession) {
627 // lets store contact id and user id in session
628 list($userID, $ufID, $randomNumber) = $result;
629 if ($userID && $ufID) {
630 $config = CRM_Core_Config
::singleton();
631 $config->userSystem
->setUserSession([$userID, $ufID]);
634 return self
::authenticateAbort(
635 "ERROR: Unexpected error, could not match userID and contactID",
645 * Authenticate the user against the uf db.
647 * In case of successful authentication, returns an array consisting of
648 * (contactID, ufID, unique string). Returns FALSE if authentication is
651 * @param string $name
653 * @param string $password
655 * @param bool $loadCMSBootstrap
656 * @param string $realPath
658 * @return false|array
660 public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
661 $config = CRM_Core_Config
::singleton();
663 /* Before we do any loading, let's start the session and write to it.
664 * We typically call authenticate only when we need to bootstrap the CMS
665 * directly via Civi and hence bypass the normal CMS auth and bootstrap
666 * process typically done in CLI and cron scripts. See: CRM-12648
668 * Q: Can we move this to the userSystem class so that it can be tuned
669 * per-CMS? For example, when dealing with UnitTests UF, there's no
672 $session = CRM_Core_Session
::singleton();
673 $session->set('civicrmInitSession', TRUE);
675 if ($config->userFrameworkDSN
) {
676 $dbDrupal = DB
::connect($config->userFrameworkDSN
);
678 return $config->userSystem
->authenticate($name, $password, $loadCMSBootstrap, $realPath);
682 * Set a message in the UF to display to a user.
684 * @param string $message
685 * The message to set.
687 public static function setUFMessage($message) {
688 $config = CRM_Core_Config
::singleton();
689 return $config->userSystem
->setMessage($message);
693 * Determine whether a value is null-ish.
695 * @param mixed $value
696 * The value to check for null.
700 public static function isNull($value) {
701 // FIXME: remove $value = 'null' string test when we upgrade our DAO code to handle passing null in a better way.
702 if (!isset($value) ||
$value === NULL ||
$value === '' ||
$value === 'null') {
705 if (is_array($value)) {
706 // @todo Reuse of the $value variable = asking for trouble.
707 foreach ($value as $key => $value) {
708 if (in_array($key, CRM_Core_DAO
::acceptedSQLOperators(), TRUE) ||
!self
::isNull($value)) {
718 * Obscure all but the last few digits of a credit card number.
720 * @param string $number
721 * The credit card number to obscure.
723 * (optional) The number of digits to preserve unmodified.
726 * The obscured credit card number.
728 public static function mungeCreditCard($number, $keep = 4) {
729 $number = trim($number);
730 if (empty($number)) {
733 $replace = str_repeat('*', strlen($number) - $keep);
734 return substr_replace($number, $replace, 0, -$keep);
738 * Determine which PHP modules are loaded.
742 private static function parsePHPModules() {
744 phpinfo(INFO_MODULES
);
745 $s = ob_get_contents();
748 $s = strip_tags($s, '<h2><th><td>');
749 $s = preg_replace('/<th[^>]*>([^<]+)<\/th>/', "<info>\\1</info>", $s);
750 $s = preg_replace('/<td[^>]*>([^<]+)<\/td>/', "<info>\\1</info>", $s);
751 $vTmp = preg_split('/(<h2>[^<]+<\/h2>)/', $s, -1, PREG_SPLIT_DELIM_CAPTURE
);
753 for ($i = 1; $i < count($vTmp); $i++
) {
754 if (preg_match('/<h2>([^<]+)<\/h2>/', $vTmp[$i], $vMat)) {
755 $vName = trim($vMat[1]);
756 $vTmp2 = explode("\n", $vTmp[$i +
1]);
757 foreach ($vTmp2 as $vOne) {
758 $vPat = '<info>([^<]+)<\/info>';
759 $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
760 $vPat2 = "/$vPat\s*$vPat/";
762 if (preg_match($vPat3, $vOne, $vMat)) {
763 $vModules[$vName][trim($vMat[1])] = [trim($vMat[2]), trim($vMat[3])];
766 elseif (preg_match($vPat2, $vOne, $vMat)) {
767 $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
776 * Get a setting from a loaded PHP module.
778 * @param string $pModuleName
779 * @param string $pSetting
783 public static function getModuleSetting($pModuleName, $pSetting) {
784 $vModules = self
::parsePHPModules();
785 return $vModules[$pModuleName][$pSetting];
789 * Do something no-one bothered to document.
791 * @param string $title
794 * @return mixed|string
796 public static function memory($title = NULL) {
799 $pid = posix_getpid();
802 $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
803 $memory .= ", " . time();
805 CRM_Core_Error
::debug_var($title, $memory);
811 * Download something or other.
813 * @param string $name
814 * @param string $mimeType
815 * @param string $buffer
817 * @param bool $output
818 * @param string $disposition
820 public static function download(
821 $name, $mimeType, &$buffer,
824 $disposition = 'attachment'
826 $now = gmdate('D, d M Y H:i:s') . ' GMT';
828 self
::setHttpHeader('Content-Type', $mimeType);
829 self
::setHttpHeader('Expires', $now);
831 // lem9 & loic1: IE needs specific headers
832 $isIE = strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
834 $fileString = "filename=\"{$name}.{$ext}\"";
837 $fileString = "filename=\"{$name}\"";
840 self
::setHttpHeader("Content-Disposition", "inline; $fileString");
841 self
::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
842 self
::setHttpHeader('Pragma', 'public');
845 self
::setHttpHeader("Content-Disposition", "$disposition; $fileString");
846 self
::setHttpHeader('Pragma', 'no-cache');
856 * Gather and print (and possibly log) amount of used memory.
858 * @param string $title
860 * (optional) Whether to log the memory usage information.
862 public static function xMemory($title = NULL, $log = FALSE) {
863 $mem = (float ) xdebug_memory_usage() / (float ) (1024);
864 $mem = number_format($mem, 5) . ", " . time();
866 echo "<p>$title: $mem<p>";
868 CRM_Core_Error
::debug_var($title, $mem);
871 echo "<p>$title: $mem<p>";
877 * Take a URL (or partial URL) and make it better.
879 * Currently, URLs pass straight through unchanged unless they are "seriously
880 * malformed" (see http://us2.php.net/parse_url).
883 * The URL to operate on.
888 public static function fixURL($url) {
889 $components = parse_url($url);
895 // at some point we'll add code here to make sure the url is not
896 // something that will mess up, so we need to clean it up here
901 * Make sure a callback is valid in the current context.
903 * @param string $callback
904 * Name of the function to check.
908 public static function validCallback($callback) {
909 if (self
::$_callbacks === NULL) {
910 self
::$_callbacks = [];
913 if (!array_key_exists($callback, self
::$_callbacks)) {
914 if (strpos($callback, '::') !== FALSE) {
915 list($className, $methodName) = explode('::', $callback);
916 $fileName = str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
917 // ignore errors if any
918 @include_once
$fileName;
919 if (!class_exists($className)) {
920 self
::$_callbacks[$callback] = FALSE;
923 // instantiate the class
924 $object = new $className();
925 if (!method_exists($object, $methodName)) {
926 self
::$_callbacks[$callback] = FALSE;
929 self
::$_callbacks[$callback] = TRUE;
934 self
::$_callbacks[$callback] = function_exists($callback);
937 return self
::$_callbacks[$callback];
941 * Like PHP's built-in explode(), but always return an array of $limit items.
943 * This serves as a wrapper to the PHP explode() function. In the event that
944 * PHP's explode() returns an array with fewer than $limit elements, pad
945 * the end of the array with NULLs.
947 * @param string $separator
948 * @param string $string
953 public static function explode($separator, $string, $limit) {
954 $result = explode($separator, $string, $limit);
955 for ($i = count($result); $i < $limit; $i++
) {
966 * @param bool $addCookie
971 public static function checkURL($url, $addCookie = FALSE) {
972 // make a GET request to $url
973 $ch = curl_init($url);
975 curl_setopt($ch, CURLOPT_COOKIE
, http_build_query($_COOKIE));
977 // it's quite alright to use a self-signed cert
978 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, 0);
980 // lets capture the return stuff rather than echo
981 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
983 // CRM-13227, CRM-14744: only return the SSL error status
984 return (curl_exec($ch) !== FALSE);
988 * Assert that we are running on a particular PHP version.
991 * The major version of PHP that is required.
993 * (optional) Whether to fatally abort if the version requirement is not
994 * met. Defaults to TRUE.
997 * Returns TRUE if the requirement is met, FALSE if the requirement is not
998 * met and we're not aborting due to the failed requirement. If $abort is
999 * TRUE and the requirement fails, this function does not return.
1001 public static function checkPHPVersion($ver = 5, $abort = TRUE) {
1002 $phpVersion = substr(PHP_VERSION
, 0, 1);
1003 if ($phpVersion >= $ver) {
1008 CRM_Core_Error
::fatal(ts('This feature requires PHP Version %1 or greater',
1018 * @param string $string
1019 * @param bool $encode
1023 public static function formatWikiURL($string, $encode = FALSE) {
1024 $items = explode(' ', trim($string), 2);
1025 if (count($items) == 2) {
1033 $url = $encode ? self
::urlEncode($items[0]) : $items[0];
1034 return "<a href=\"$url\">$title</a>";
1040 * @param string $url
1042 * @return null|string
1044 public static function urlEncode($url) {
1045 $items = parse_url($url);
1046 if ($items === FALSE) {
1050 if (empty($items['query'])) {
1054 $items['query'] = urlencode($items['query']);
1056 $url = $items['scheme'] . '://';
1057 if (!empty($items['user'])) {
1058 $url .= "{$items['user']}:{$items['pass']}@";
1061 $url .= $items['host'];
1062 if (!empty($items['port'])) {
1063 $url .= ":{$items['port']}";
1066 $url .= "{$items['path']}?{$items['query']}";
1067 if (!empty($items['fragment'])) {
1068 $url .= "#{$items['fragment']}";
1075 * Return the running civicrm version.
1080 public static function version() {
1084 $verFile = implode(DIRECTORY_SEPARATOR
,
1085 [dirname(__FILE__
), '..', '..', 'xml', 'version.xml']
1087 if (file_exists($verFile)) {
1088 $str = file_get_contents($verFile);
1089 $xmlObj = simplexml_load_string($str);
1090 $version = (string) $xmlObj->version_no
;
1094 if (!CRM_Utils_System
::isVersionFormatValid($version)) {
1095 CRM_Core_Error
::fatal('Unknown codebase version.');
1103 * Gives the first two parts of the version string E.g. 6.1.
1107 public static function majorVersion() {
1108 list($a, $b) = explode('.', self
::version());
1113 * Determines whether a string is a valid CiviCRM version string.
1115 * @param string $version
1116 * Version string to be checked.
1120 public static function isVersionFormatValid($version) {
1121 return preg_match("/^(\d{1,2}\.){2,3}(\d{1,2}|(alpha|beta)\d{1,2})(\.upgrade)?$/", $version);
1125 * Wraps or emulates PHP's getallheaders() function.
1127 public static function getAllHeaders() {
1128 if (function_exists('getallheaders')) {
1129 return getallheaders();
1132 // emulate get all headers
1133 // http://www.php.net/manual/en/function.getallheaders.php#66335
1135 foreach ($_SERVER as $name => $value) {
1136 if (substr($name, 0, 5) == 'HTTP_') {
1137 $headers[str_replace(' ',
1139 ucwords(strtolower(str_replace('_',
1151 * Get request headers.
1153 * @return array|false
1155 public static function getRequestHeaders() {
1156 if (function_exists('apache_request_headers')) {
1157 return apache_request_headers();
1165 * Determine whether this is an SSL request.
1167 * Note that we inline this function in install/civicrm.php, so if you change
1168 * this function, please go and change the code in the install script as well.
1170 public static function isSSL() {
1171 return (isset($_SERVER['HTTPS']) &&
1172 !empty($_SERVER['HTTPS']) &&
1173 strtolower($_SERVER['HTTPS']) != 'off') ?
TRUE : FALSE;
1179 * @param bool|FALSE $abort
1181 * @throws \Exception
1183 public static function redirectToSSL($abort = FALSE) {
1184 $config = CRM_Core_Config
::singleton();
1185 $req_headers = self
::getRequestHeaders();
1186 // FIXME: Shouldn't the X-Forwarded-Proto check be part of CRM_Utils_System::isSSL()?
1187 if (Civi
::settings()->get('enableSSL') &&
1189 strtolower(CRM_Utils_Array
::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1191 // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1192 $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1193 // @see https://lab.civicrm.org/dev/core/issues/425 if you're seeing this message.
1194 Civi
::log()->warning('CiviCRM thinks site is not SSL, redirecting to {url}', ['url' => $url]);
1195 if (!self
::checkURL($url, TRUE)) {
1197 CRM_Core_Error
::fatal('HTTPS is not set up on this machine');
1200 CRM_Core_Session
::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1201 // admin should be the only one following this
1202 // since we dont want the user stuck in a bad place
1206 CRM_Utils_System
::redirect($url);
1211 * Get logged in user's IP address.
1213 * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1214 * the Drupal function as this also handles reverse proxies (based on proper
1215 * configuration in settings.php)
1217 * @param bool $strictIPV4
1218 * (optional) Whether to return only IPv4 addresses.
1221 * IP address of logged in user.
1223 public static function ipAddress($strictIPV4 = TRUE) {
1224 $address = CRM_Utils_Array
::value('REMOTE_ADDR', $_SERVER);
1226 $config = CRM_Core_Config
::singleton();
1227 if ($config->userSystem
->is_drupal
&& function_exists('ip_address')) {
1228 // drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1229 // that reach this point without bootstrapping hence the check that the fn exists
1230 $address = ip_address();
1234 if ($address == '::1') {
1235 $address = '127.0.0.1';
1238 // when we need to have strictly IPV4 ip address
1239 // convert ipV6 to ipV4
1241 // this converts 'IPV4 mapped IPV6 address' to IPV4
1242 if (filter_var($address, FILTER_VALIDATE_IP
, FILTER_FLAG_IPV6
) && strstr($address, '::ffff:')) {
1243 $address = ltrim($address, '::ffff:');
1251 * Get the referring / previous page URL.
1254 * The previous page URL
1256 public static function refererPath() {
1257 return CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
1261 * Get the documentation base URL.
1264 * Base URL of the CRM documentation.
1266 public static function getDocBaseURL() {
1267 // FIXME: move this to configuration at some stage
1268 return 'https://docs.civicrm.org/';
1272 * Returns wiki (alternate) documentation URL base.
1277 public static function getWikiBaseURL() {
1278 // FIXME: move this to configuration at some stage
1279 return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1283 * Returns URL or link to documentation page, based on provided parameters.
1285 * For use in PHP code.
1286 * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1289 * @param string $page
1290 * Title of documentation wiki page.
1291 * @param bool $URLonly
1292 * (optional) Whether to return URL only or full HTML link (default).
1293 * @param string $text
1294 * (optional) Text of HTML link (no effect if $URLonly = false).
1295 * @param string $title
1296 * (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1297 * @param string $style
1298 * (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1300 * @param null $resource
1303 * URL or link to documentation page, based on provided parameters.
1305 public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1306 // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1307 // return just the URL, no matter what other parameters are defined
1308 if (!function_exists('ts')) {
1309 if ($resource == 'wiki') {
1310 $docBaseURL = self
::getWikiBaseURL();
1313 $docBaseURL = self
::getDocBaseURL();
1314 $page = self
::formatDocUrl($page);
1316 return $docBaseURL . str_replace(' ', '+', $page);
1321 'URLonly' => $URLonly,
1325 'resource' => $resource,
1327 return self
::docURL($params);
1332 * Returns URL or link to documentation page, based on provided parameters.
1334 * For use in templates code.
1336 * @param array $params
1337 * An array of parameters (see CRM_Utils_System::docURL2 method for names)
1339 * @return null|string
1340 * URL or link to documentation page, based on provided parameters.
1342 public static function docURL($params) {
1344 if (!isset($params['page'])) {
1348 if (CRM_Utils_Array
::value('resource', $params) == 'wiki') {
1349 $docBaseURL = self
::getWikiBaseURL();
1352 $docBaseURL = self
::getDocBaseURL();
1353 $params['page'] = self
::formatDocUrl($params['page']);
1356 if (!isset($params['title']) or $params['title'] === NULL) {
1357 $params['title'] = ts('Opens documentation in a new window.');
1360 if (!isset($params['text']) or $params['text'] === NULL) {
1361 $params['text'] = ts('(learn more...)');
1364 if (!isset($params['style']) ||
$params['style'] === NULL) {
1368 $style = "style=\"{$params['style']}\"";
1371 $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1373 if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1377 return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1382 * Add language and version parameters to the doc url.
1384 * Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.
1389 public static function formatDocUrl($url) {
1390 return preg_replace('#^(user|sysadmin|dev)/#', '\1/en/stable/', $url);
1394 * Exit with provided exit code.
1396 * @param int $status
1397 * (optional) Code with which to exit.
1399 * @param array $testParameters
1401 public static function civiExit($status = 0, $testParameters = []) {
1403 if (CIVICRM_UF
=== 'UnitTests') {
1404 throw new CRM_Core_Exception_PrematureExitException('civiExit called', $testParameters);
1407 http_response_code(500);
1409 // move things to CiviCRM cache as needed
1410 CRM_Core_Session
::storeSessionObjects();
1412 if (Civi\Core\Container
::isContainerBooted()) {
1413 Civi
::dispatcher()->dispatch('civi.core.exit');
1416 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
1417 if (is_callable([$userSystem, 'onCiviExit'])) {
1418 $userSystem->onCiviExit();
1424 * Reset the various system caches and some important static variables.
1426 public static function flushCache() {
1427 // flush out all cache entries so we can reload new data
1428 // a bit aggressive, but livable for now
1429 CRM_Utils_Cache
::singleton()->flush();
1431 // Traditionally, systems running on memory-backed caches were quite
1432 // zealous about destroying *all* memory-backed caches during a flush().
1433 // These flushes simulate that legacy behavior. However, they should probably
1434 // be removed at some point.
1435 $localDrivers = ['CRM_Utils_Cache_ArrayCache', 'CRM_Utils_Cache_NoCache'];
1436 if (Civi\Core\Container
::isContainerBooted()
1437 && !in_array(get_class(CRM_Utils_Cache
::singleton()), $localDrivers)) {
1438 Civi
::cache('long')->flush();
1439 Civi
::cache('settings')->flush();
1440 Civi
::cache('js_strings')->flush();
1441 Civi
::cache('community_messages')->flush();
1442 Civi
::cache('groups')->flush();
1443 CRM_Extension_System
::singleton()->getCache()->flush();
1444 CRM_Cxn_CiviCxnHttp
::singleton()->getCache()->flush();
1447 // also reset the various static memory caches
1449 // reset the memory or array cache
1450 CRM_Core_BAO_Cache
::deleteGroup('contact fields', NULL, FALSE);
1453 CRM_ACL_BAO_Cache
::resetCache();
1455 // reset various static arrays used here
1456 CRM_Contact_BAO_Contact
::$_importableFields = CRM_Contact_BAO_Contact
::$_exportableFields
1457 = CRM_Contribute_BAO_Contribution
::$_importableFields
1458 = CRM_Contribute_BAO_Contribution
::$_exportableFields
1459 = CRM_Pledge_BAO_Pledge
::$_exportableFields
1460 = CRM_Core_BAO_CustomField
::$_importFields
1461 = CRM_Core_BAO_Cache
::$_cache = CRM_Core_DAO
::$_dbColumnValueCache = NULL;
1463 CRM_Core_OptionGroup
::flushAll();
1464 CRM_Utils_PseudoConstant
::flushAll();
1468 * Load CMS bootstrap.
1470 * @param array $params
1471 * Array with uid name and pass
1472 * @param bool $loadUser
1473 * Boolean load user or not.
1474 * @param bool $throwError
1475 * @param string $realPath
1477 public static function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1478 if (!is_array($params)) {
1481 $config = CRM_Core_Config
::singleton();
1482 $result = $config->userSystem
->loadBootStrap($params, $loadUser, $throwError, $realPath);
1483 if (is_callable([$config->userSystem
, 'setMySQLTimeZone'])) {
1484 $config->userSystem
->setMySQLTimeZone();
1492 * @return mixed|string
1494 public static function baseCMSURL() {
1495 static $_baseURL = NULL;
1497 $config = CRM_Core_Config
::singleton();
1498 $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL
;
1500 if ($config->userFramework
== 'Joomla') {
1502 // we need to remove the administrator/ from the end
1503 $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1507 global $civicrm_root;
1508 if (strpos($civicrm_root,
1509 DIRECTORY_SEPARATOR
. 'sites' .
1510 DIRECTORY_SEPARATOR
. 'all' .
1511 DIRECTORY_SEPARATOR
. 'modules'
1514 $startPos = strpos($civicrm_root,
1515 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
1517 $endPos = strpos($civicrm_root,
1518 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
1520 if ($startPos && $endPos) {
1521 // if component is in sites/SITENAME/modules
1522 $siteName = substr($civicrm_root,
1524 $endPos - $startPos - 7
1527 $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1536 * Given a URL, return a relative URL if possible.
1538 * @param string $url
1542 public static function relativeURL($url) {
1543 // check if url is relative, if so return immediately
1544 if (substr($url, 0, 4) != 'http') {
1548 // make everything relative from the baseFilePath
1549 $baseURL = self
::baseCMSURL();
1551 // check if baseURL is a substr of $url, if so
1552 // return rest of string
1553 if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1554 return substr($url, strlen($baseURL));
1557 // return the original value
1562 * Produce an absolute URL from a possibly-relative URL.
1564 * @param string $url
1565 * @param bool $removeLanguagePart
1569 public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1570 // check if url is already absolute, if so return immediately
1571 if (substr($url, 0, 4) == 'http') {
1575 // make everything absolute from the baseFileURL
1576 $baseURL = self
::baseCMSURL();
1578 //CRM-7622: drop the language from the URL if requested (and it’s there)
1579 $config = CRM_Core_Config
::singleton();
1580 if ($removeLanguagePart) {
1581 $baseURL = self
::languageNegotiationURL($baseURL, FALSE, TRUE);
1584 return $baseURL . $url;
1588 * Clean url, replaces first '&' with '?'.
1590 * @param string $url
1595 public static function cleanUrl($url) {
1600 if ($pos = strpos($url, '&')) {
1601 $url = substr_replace($url, '?', $pos, 1);
1608 * Format the url as per language Negotiation.
1610 * @param string $url
1612 * @param bool $addLanguagePart
1613 * @param bool $removeLanguagePart
1618 public static function languageNegotiationURL(
1620 $addLanguagePart = TRUE,
1621 $removeLanguagePart = FALSE
1623 return CRM_Core_Config
::singleton()->userSystem
->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1627 * Append the contents of an 'extra' smarty template file.
1629 * It must be present in the custom template directory. This does not work if there are
1630 * multiple custom template directories
1632 * @param string $fileName
1633 * The name of the tpl file that we are processing.
1634 * @param string $content
1635 * The current content string. May be modified by this function.
1636 * @param string $overideFileName
1637 * (optional) Sent by contribution/event reg/profile pages which uses a id
1638 * specific extra file name if present.
1640 public static function appendTPLFile(
1643 $overideFileName = NULL
1645 $template = CRM_Core_Smarty
::singleton();
1646 if ($overideFileName) {
1647 $additionalTPLFile = $overideFileName;
1650 $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1653 if ($template->template_exists($additionalTPLFile)) {
1654 $content .= $template->fetch($additionalTPLFile);
1659 * Get a list of all files that are found within the directories.
1661 * Files must be the result of appending the provided relative path to
1662 * each component of the PHP include path.
1664 * @author Ken Zalewski
1666 * @param string $relpath
1667 * A relative path, typically pointing to a directory with multiple class
1671 * An array of files that exist in one or more of the directories that are
1672 * referenced by the relative path when appended to each element of the PHP
1675 public static function listIncludeFiles($relpath) {
1677 $inc_dirs = explode(PATH_SEPARATOR
, get_include_path());
1678 foreach ($inc_dirs as $inc_dir) {
1679 $target_dir = $inc_dir . DIRECTORY_SEPARATOR
. $relpath;
1680 if (is_dir($target_dir)) {
1681 $cur_list = scandir($target_dir);
1682 foreach ($cur_list as $fname) {
1683 if ($fname != '.' && $fname != '..') {
1684 $file_list[$fname] = $fname;
1693 * Get a list of all "plugins".
1695 * (PHP classes that implement a piece of
1696 * functionality using a well-defined interface) that are found in a
1697 * particular CiviCRM directory (both custom and core are searched).
1699 * @author Ken Zalewski
1701 * @param string $relpath
1702 * A relative path referencing a directory that contains one or more
1704 * @param string $fext
1705 * (optional) Only files with this extension will be considered to be
1707 * @param array $skipList
1708 * (optional) List of files to skip.
1711 * List of plugins, where the plugin name is both the key and the value of
1714 public static function getPluginList($relpath, $fext = '.php', $skipList = []) {
1715 $fext_len = strlen($fext);
1717 $inc_files = CRM_Utils_System
::listIncludeFiles($relpath);
1718 foreach ($inc_files as $inc_file) {
1719 if (substr($inc_file, 0 - $fext_len) == $fext) {
1720 $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1721 if (!in_array($plugin_name, $skipList)) {
1722 $plugins[$plugin_name] = $plugin_name;
1730 * Execute scheduled jobs.
1732 public static function executeScheduledJobs() {
1733 $facility = new CRM_Core_JobManager();
1734 $facility->execute(FALSE);
1736 $redirectUrl = self
::url('civicrm/admin/job', 'reset=1');
1738 CRM_Core_Session
::setStatus(
1739 ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1740 ts('Complete'), 'success');
1742 CRM_Utils_System
::redirect($redirectUrl);
1746 * Evaluate any tokens in a URL.
1748 * @param string|FALSE $url
1750 * @return string|FALSE
1752 public static function evalUrl($url) {
1753 if (!$url ||
strpos($url, '{') === FALSE) {
1757 $config = CRM_Core_Config
::singleton();
1759 '{ver}' => CRM_Utils_System
::version(),
1760 '{uf}' => $config->userFramework
,
1761 '{php}' => phpversion(),
1762 '{sid}' => self
::getSiteID(),
1763 '{baseUrl}' => $config->userFrameworkBaseURL
,
1764 '{lang}' => $config->lcMessages
,
1765 '{co}' => $config->defaultContactCountry
,
1767 return strtr($url, array_map('urlencode', $vars));
1772 * Returns the unique identifier for this site, as used by community messages.
1774 * SiteID will be generated if it is not already stored in the settings table.
1778 public static function getSiteID() {
1779 $sid = Civi
::settings()->get('site_id');
1781 $config = CRM_Core_Config
::singleton();
1782 $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '') . '_' . $config->userFrameworkBaseURL
);
1783 civicrm_api3('Setting', 'create', ['domain_id' => 'all', 'site_id' => $sid]);
1789 * Determine whether this is a developmental system.
1793 public static function isDevelopment() {
1794 static $cache = NULL;
1795 if ($cache === NULL) {
1796 global $civicrm_root;
1797 $cache = file_exists("{$civicrm_root}/.svn") ||
file_exists("{$civicrm_root}/.git");
1803 * Is in upgrade mode.
1807 public static function isInUpgradeMode() {
1808 $args = explode('/', CRM_Utils_Array
::value('q', $_GET));
1809 $upgradeInProcess = CRM_Core_Session
::singleton()->get('isUpgradePending');
1810 if ((isset($args[1]) && $args[1] == 'upgrade') ||
$upgradeInProcess) {
1819 * Determine the standard URL for viewing or editing the specified link.
1821 * This function delegates the decision-making to (a) the hook system and
1822 * (b) the BAO system.
1824 * @param array $crudLinkSpec
1826 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1827 * - entity_table: string, eg "civicrm_contact"
1830 * @return array|NULL
1831 * NULL if unavailable, or an array. array has keys:
1837 public static function createDefaultCrudLink($crudLinkSpec) {
1838 $crudLinkSpec['action'] = CRM_Utils_Array
::value('action', $crudLinkSpec, CRM_Core_Action
::VIEW
);
1839 $daoClass = CRM_Core_DAO_AllCoreTables
::getClassForTable($crudLinkSpec['entity_table']);
1844 $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1845 if (!class_exists($baoClass)) {
1849 $bao = new $baoClass();
1850 $bao->id
= $crudLinkSpec['entity_id'];
1851 if (!$bao->find(TRUE)) {
1856 CRM_Utils_Hook
::crudLink($crudLinkSpec, $bao, $link);
1857 if (empty($link) && is_callable([$bao, 'createDefaultCrudLink'])) {
1858 $link = $bao->createDefaultCrudLink($crudLinkSpec);
1861 if (!empty($link)) {
1862 if (!isset($link['url'])) {
1863 $link['url'] = self
::url($link['path'], $link['query'], TRUE, NULL, FALSE);
1872 * Return an HTTP Response with appropriate content and status code set.
1873 * @param \Psr\Http\Message\ResponseInterface $response
1875 public static function sendResponse(\Psr\Http\Message\ResponseInterface
$response) {
1876 $config = CRM_Core_Config
::singleton()->userSystem
->sendResponse($response);