3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * System wide utilities.
21 * Provides a collection of Civi utilities + access to the CMS-dependant utilities
23 * FIXME: This is a massive and random collection that could be split into smaller services
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.
41 class CRM_Utils_System
{
43 public static $_callbacks = NULL;
49 public static $title = '';
52 * Access methods in the appropriate CMS class
58 public static function __callStatic($name, $arguments) {
59 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
60 return call_user_func_array([$userSystem, $name], $arguments);
64 * Compose a new URL string from the current URL string.
66 * Used by all the framework components, specifically,
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).
76 * (optional) The path to use for the new url.
77 * @param bool|string $absolute
78 * (optional) Whether to return an absolute URL.
83 public static function makeURL($urlVar, $includeReset = FALSE, $includeForce = TRUE, $path = NULL, $absolute = FALSE) {
85 $config = CRM_Core_Config
::singleton();
86 $path = CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET);
94 CRM_Utils_System
::getLinksUrl($urlVar, $includeReset, $includeForce),
100 * Get the query string and clean it up.
102 * Strips some variables that should not be propagated, specifically variables
103 * like 'reset'. Also strips any side-affect actions (e.g. export).
105 * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
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
114 * @param bool $skipUFVar
119 public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
120 // Sort out query string to prevent messy urls
125 if (!empty($_SERVER['QUERY_STRING'])) {
126 $qs = explode('&', str_replace('&', '&', $_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)
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
158 if (!empty($qs['snippet'])) {
159 unset($qs['snippet']);
162 unset($qs['section']);
166 $config = CRM_Core_Config
::singleton();
167 unset($qs[$config->userFrameworkURLVar
]);
170 foreach ($qs as $name => $value) {
171 if ($name != 'reset' ||
$includeReset) {
172 $querystring[] = $name . '=' . $value;
176 $querystring = array_merge($querystring, array_unique($arrays));
178 $url = implode('&', $querystring);
180 $url .= (!empty($querystring) ?
'&' : '') . $urlVar . '=';
187 * If we are using a theming system, invoke theme, else just print the content.
189 * @param string $content
190 * The content that will be themed.
192 * (optional) Are we displaying to the screen or bypassing theming?
193 * @param bool $maintenance
194 * (optional) For maintenance mode.
198 public static function theme(
203 return CRM_Core_Config
::singleton()->userSystem
->theme($content, $print, $maintenance);
207 * Generate a query string if input is an array.
209 * @param array|string $query
213 public static function makeQueryString($query) {
214 if (is_array($query)) {
216 foreach ($query as $key => $value) {
217 $buf .= ($buf ?
'&' : '') . urlencode($key) . '=' . urlencode($value);
225 * Generate an internal CiviCRM URL.
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).
245 * An HTML string containing a link to the given path.
247 public static function url(
254 $forceBackend = FALSE
256 $query = self
::makeQueryString($query);
258 // Legacy handling for when the system passes around html escaped strings
259 if (strstr($query, '&')) {
260 $query = html_entity_decode($query);
263 // Extract fragment from path or query if munged together
264 if ($query && strstr($query, '#')) {
265 list($path, $fragment) = explode('#', $query);
267 if ($path && strstr($path, '#')) {
268 list($path, $fragment) = explode('#', $path);
271 // Extract query from path if munged together
272 if ($path && strstr($path, '?')) {
273 list($path, $extraQuery) = explode('?', $path);
274 $query = $extraQuery . ($query ?
"&$query" : '');
277 $config = CRM_Core_Config
::singleton();
278 $url = $config->userSystem
->url($path, $query, $absolute, $fragment, $frontend, $forceBackend);
281 $url = htmlentities($url);
288 * Generates an extern url.
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:').
300 * NULL to autodetect. TRUE to force to SSL.
302 public static function externUrl($path = NULL, $query = NULL, $fragment = NULL, $absolute = TRUE, $isSSL = NULL) {
303 $query = self
::makeQueryString($query);
305 $url = Civi
::paths()->getUrl("[civicrm.root]/{$path}.php", $absolute ?
'absolute' : 'relative', $isSSL)
306 . ($query ?
"?$query" : "")
307 . ($fragment ?
"#$fragment" : "");
309 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
310 $event = \Civi\Core\Event\GenericHookEvent
::create([
311 'url' => &$parsedUrl,
314 'fragment' => $fragment,
315 'absolute' => $absolute,
318 Civi
::service('dispatcher')->dispatch('hook_civicrm_alterExternUrl', $event);
319 return CRM_Utils_Url
::unparseUrl($event->url
);
323 * Path of the current page e.g. 'civicrm/contact/view'
325 * @return string|null
327 public static function getUrlPath() {
328 if (isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
329 return $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
];
337 * @param string $text
338 * @param string $path
339 * @param string|array $query
340 * @param bool $absolute
341 * @param string $fragment
342 * @param bool $htmlize
343 * @param bool $frontend
344 * @param bool $forceBackend
348 public static function href(
349 $text, $path = NULL, $query = NULL, $absolute = TRUE,
350 $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
352 $url = self
::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
353 return "<a href=\"$url\">$text</a>";
357 * What menu path are we currently on. Called for the primary tpl.
360 * the current menu path
362 public static function currentPath() {
363 $config = CRM_Core_Config
::singleton();
364 return trim(CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET), '/');
368 * Called from a template to compose a url.
370 * @param array $params
371 * List of parameters.
376 public static function crmURL($params) {
377 $p = CRM_Utils_Array
::value('p', $params);
379 $p = self
::currentPath();
384 CRM_Utils_Array
::value('q', $params),
385 CRM_Utils_Array
::value('a', $params, FALSE),
386 CRM_Utils_Array
::value('f', $params),
387 CRM_Utils_Array
::value('h', $params, TRUE),
388 CRM_Utils_Array
::value('fe', $params, FALSE),
389 CRM_Utils_Array
::value('fb', $params, FALSE)
394 * Sets the title of the page.
396 * @param string $title
397 * Document title - plain text only
398 * @param string $pageTitle
399 * Page title (if different) - may include html
401 public static function setTitle($title, $pageTitle = NULL) {
402 self
::$title = $title;
403 $config = CRM_Core_Config
::singleton();
404 return $config->userSystem
->setTitle($title, $pageTitle);
408 * Figures and sets the userContext.
410 * Uses the referrer if valid else uses the default.
412 * @param array $names
413 * Referrer should match any str in this array.
414 * @param string $default
415 * (optional) The default userContext if no match found.
417 public static function setUserContext($names, $default = NULL) {
420 $session = CRM_Core_Session
::singleton();
421 $referer = CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
423 if ($referer && !empty($names)) {
424 foreach ($names as $name) {
425 if (strstr($referer, $name)) {
433 $session->pushUserContext($url);
438 * Gets a class name for an object.
440 * @param object $object
441 * Object whose class name is needed.
444 * The class name of the object.
446 public static function getClassName($object) {
447 return get_class($object);
451 * Redirect to another URL.
454 * The URL to provide to the browser via the Location header.
455 * @param array $context
456 * Optional additional information for the hook.
458 public static function redirect($url = NULL, $context = []) {
460 $url = self
::url('civicrm/dashboard', 'reset=1');
462 // replace the & characters with &
463 // this is kinda hackish but not sure how to do it right
464 $url = str_replace('&', '&', $url);
466 $context['output'] = CRM_Utils_Array
::value('snippet', $_GET);
468 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
469 CRM_Utils_Hook
::alterRedirect($parsedUrl, $context);
470 $url = CRM_Utils_Url
::unparseUrl($parsedUrl);
472 // If we are in a json context, respond appropriately
473 if ($context['output'] === 'json') {
474 CRM_Core_Page_AJAX
::returnJsonResponse([
475 'status' => 'redirect',
476 'userContext' => $url,
480 self
::setHttpHeader('Location', $url);
485 * Redirect to another URL using JavaScript.
487 * Use an html based file with javascript embedded to redirect to another url
488 * This prevent the too many redirect errors emitted by various browsers
491 * (optional) The destination URL.
492 * @param string $title
493 * (optional) The page title to use for the redirect page.
494 * @param string $message
495 * (optional) The message to provide in the body of the redirect page.
497 public static function jsRedirect(
503 $url = self
::url('civicrm/dashboard', 'reset=1');
507 $title = ts('CiviCRM task in progress');
511 $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
514 // replace the & characters with &
515 // this is kinda hackish but not sure how to do it right
516 $url = str_replace('&', '&', $url);
518 $template = CRM_Core_Smarty
::singleton();
519 $template->assign('redirectURL', $url);
520 $template->assign('title', $title);
521 $template->assign('message', $message);
523 $html = $template->fetch('CRM/common/redirectJS.tpl');
531 * Get the base URL of the system.
535 public static function baseURL() {
536 $config = CRM_Core_Config
::singleton();
537 return $config->userFrameworkBaseURL
;
541 * Authenticate or abort.
543 * @param string $message
548 public static function authenticateAbort($message, $abort) {
562 * (optional) Whether to exit; defaults to true.
566 public static function authenticateKey($abort = TRUE) {
567 // also make sure the key is sent and is valid
568 $key = trim(CRM_Utils_Array
::value('key', $_REQUEST));
570 $docAdd = "More info at:" . CRM_Utils_System
::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
573 return self
::authenticateAbort(
574 "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
579 $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: NULL;
581 if (!$siteKey ||
empty($siteKey)) {
582 return self
::authenticateAbort(
583 "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
588 if (strlen($siteKey) < 8) {
589 return self
::authenticateAbort(
590 "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
595 if ($key !== $siteKey) {
596 return self
::authenticateAbort(
597 "ERROR: Invalid key value sent. " . $docAdd . "\n",
606 * Authenticate script.
609 * @param string $name
610 * @param string $pass
611 * @param bool $storeInSession
612 * @param bool $loadCMSBootstrap
613 * @param bool $requireKey
617 public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
618 // auth to make sure the user has a login/password to do a shell operation
619 // later on we'll link this to acl's
621 $name = trim(CRM_Utils_Array
::value('name', $_REQUEST));
622 $pass = trim(CRM_Utils_Array
::value('pass', $_REQUEST));
625 // its ok to have an empty password
627 return self
::authenticateAbort(
628 "ERROR: You need to send a valid user name and password to execute this file\n",
633 if ($requireKey && !self
::authenticateKey($abort)) {
637 $result = CRM_Utils_System
::authenticate($name, $pass, $loadCMSBootstrap);
639 return self
::authenticateAbort(
640 "ERROR: Invalid username and/or password\n",
644 elseif ($storeInSession) {
645 // lets store contact id and user id in session
646 list($userID, $ufID, $randomNumber) = $result;
647 if ($userID && $ufID) {
648 $config = CRM_Core_Config
::singleton();
649 $config->userSystem
->setUserSession([$userID, $ufID]);
652 return self
::authenticateAbort(
653 "ERROR: Unexpected error, could not match userID and contactID",
663 * Authenticate the user against the uf db.
665 * In case of successful authentication, returns an array consisting of
666 * (contactID, ufID, unique string). Returns FALSE if authentication is
669 * @param string $name
671 * @param string $password
673 * @param bool $loadCMSBootstrap
674 * @param string $realPath
676 * @return false|array
678 public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
679 $config = CRM_Core_Config
::singleton();
681 /* Before we do any loading, let's start the session and write to it.
682 * We typically call authenticate only when we need to bootstrap the CMS
683 * directly via Civi and hence bypass the normal CMS auth and bootstrap
684 * process typically done in CLI and cron scripts. See: CRM-12648
686 * Q: Can we move this to the userSystem class so that it can be tuned
687 * per-CMS? For example, when dealing with UnitTests UF, there's no
690 $session = CRM_Core_Session
::singleton();
691 $session->set('civicrmInitSession', TRUE);
693 if ($config->userFrameworkDSN
) {
694 $dbDrupal = DB
::connect($config->userFrameworkDSN
);
696 return $config->userSystem
->authenticate($name, $password, $loadCMSBootstrap, $realPath);
700 * Set a message in the UF to display to a user.
702 * @param string $message
703 * The message to set.
705 public static function setUFMessage($message) {
706 $config = CRM_Core_Config
::singleton();
707 return $config->userSystem
->setMessage($message);
711 * Determine whether a value is null-ish.
713 * @param mixed $value
714 * The value to check for null.
718 public static function isNull($value) {
719 // FIXME: remove $value = 'null' string test when we upgrade our DAO code to handle passing null in a better way.
720 if (!isset($value) ||
$value === NULL ||
$value === '' ||
$value === 'null') {
723 if (is_array($value)) {
724 // @todo Reuse of the $value variable = asking for trouble.
725 foreach ($value as $key => $value) {
726 if (in_array($key, CRM_Core_DAO
::acceptedSQLOperators(), TRUE) ||
!self
::isNull($value)) {
736 * Obscure all but the last few digits of a credit card number.
738 * @param string $number
739 * The credit card number to obscure.
741 * (optional) The number of digits to preserve unmodified.
744 * The obscured credit card number.
746 public static function mungeCreditCard($number, $keep = 4) {
747 $number = trim($number);
748 if (empty($number)) {
751 $replace = str_repeat('*', strlen($number) - $keep);
752 return substr_replace($number, $replace, 0, -$keep);
756 * Determine which PHP modules are loaded.
760 private static function parsePHPModules() {
762 phpinfo(INFO_MODULES
);
763 $s = ob_get_contents();
766 $s = strip_tags($s, '<h2><th><td>');
767 $s = preg_replace('/<th[^>]*>([^<]+)<\/th>/', "<info>\\1</info>", $s);
768 $s = preg_replace('/<td[^>]*>([^<]+)<\/td>/', "<info>\\1</info>", $s);
769 $vTmp = preg_split('/(<h2>[^<]+<\/h2>)/', $s, -1, PREG_SPLIT_DELIM_CAPTURE
);
771 for ($i = 1; $i < count($vTmp); $i++
) {
772 if (preg_match('/<h2>([^<]+)<\/h2>/', $vTmp[$i], $vMat)) {
773 $vName = trim($vMat[1]);
774 $vTmp2 = explode("\n", $vTmp[$i +
1]);
775 foreach ($vTmp2 as $vOne) {
776 $vPat = '<info>([^<]+)<\/info>';
777 $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
778 $vPat2 = "/$vPat\s*$vPat/";
780 if (preg_match($vPat3, $vOne, $vMat)) {
781 $vModules[$vName][trim($vMat[1])] = [trim($vMat[2]), trim($vMat[3])];
784 elseif (preg_match($vPat2, $vOne, $vMat)) {
785 $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
794 * Get a setting from a loaded PHP module.
796 * @param string $pModuleName
797 * @param string $pSetting
801 public static function getModuleSetting($pModuleName, $pSetting) {
802 $vModules = self
::parsePHPModules();
803 return $vModules[$pModuleName][$pSetting];
807 * Do something no-one bothered to document.
809 * @param string $title
812 * @return mixed|string
814 public static function memory($title = NULL) {
817 $pid = posix_getpid();
820 $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
821 $memory .= ", " . time();
823 CRM_Core_Error
::debug_var($title, $memory);
829 * Download something or other.
831 * @param string $name
832 * @param string $mimeType
833 * @param string $buffer
835 * @param bool $output
836 * @param string $disposition
838 public static function download(
839 $name, $mimeType, &$buffer,
842 $disposition = 'attachment'
844 $now = gmdate('D, d M Y H:i:s') . ' GMT';
846 self
::setHttpHeader('Content-Type', $mimeType);
847 self
::setHttpHeader('Expires', $now);
849 // lem9 & loic1: IE needs specific headers
850 $isIE = empty($_SERVER['HTTP_USER_AGENT']) ?
FALSE : strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
852 $fileString = "filename=\"{$name}.{$ext}\"";
855 $fileString = "filename=\"{$name}\"";
858 self
::setHttpHeader("Content-Disposition", "inline; $fileString");
859 self
::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
860 self
::setHttpHeader('Pragma', 'public');
863 self
::setHttpHeader("Content-Disposition", "$disposition; $fileString");
864 self
::setHttpHeader('Pragma', 'no-cache');
874 * Gather and print (and possibly log) amount of used memory.
876 * @param string $title
878 * (optional) Whether to log the memory usage information.
880 public static function xMemory($title = NULL, $log = FALSE) {
881 $mem = (float ) xdebug_memory_usage() / (float ) (1024);
882 $mem = number_format($mem, 5) . ", " . time();
884 echo "<p>$title: $mem<p>";
886 CRM_Core_Error
::debug_var($title, $mem);
889 echo "<p>$title: $mem<p>";
895 * Take a URL (or partial URL) and make it better.
897 * Currently, URLs pass straight through unchanged unless they are "seriously
898 * malformed" (see http://us2.php.net/parse_url).
901 * The URL to operate on.
906 public static function fixURL($url) {
907 $components = parse_url($url);
913 // at some point we'll add code here to make sure the url is not
914 // something that will mess up, so we need to clean it up here
919 * Make sure a callback is valid in the current context.
921 * @param string $callback
922 * Name of the function to check.
926 public static function validCallback($callback) {
927 if (self
::$_callbacks === NULL) {
928 self
::$_callbacks = [];
931 if (!array_key_exists($callback, self
::$_callbacks)) {
932 if (strpos($callback, '::') !== FALSE) {
933 list($className, $methodName) = explode('::', $callback);
934 $fileName = str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
935 // ignore errors if any
936 @include_once
$fileName;
937 if (!class_exists($className)) {
938 self
::$_callbacks[$callback] = FALSE;
941 // instantiate the class
942 $object = new $className();
943 if (!method_exists($object, $methodName)) {
944 self
::$_callbacks[$callback] = FALSE;
947 self
::$_callbacks[$callback] = TRUE;
952 self
::$_callbacks[$callback] = function_exists($callback);
955 return self
::$_callbacks[$callback];
959 * Like PHP's built-in explode(), but always return an array of $limit items.
961 * This serves as a wrapper to the PHP explode() function. In the event that
962 * PHP's explode() returns an array with fewer than $limit elements, pad
963 * the end of the array with NULLs.
965 * @param string $separator
966 * @param string $string
971 public static function explode($separator, $string, $limit) {
972 $result = explode($separator, $string, $limit);
973 for ($i = count($result); $i < $limit; $i++
) {
984 * @param bool $addCookie
989 public static function checkURL($url, $addCookie = FALSE) {
990 // make a GET request to $url
991 $ch = curl_init($url);
993 curl_setopt($ch, CURLOPT_COOKIE
, http_build_query($_COOKIE));
995 // it's quite alright to use a self-signed cert
996 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, 0);
998 // lets capture the return stuff rather than echo
999 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
1001 // CRM-13227, CRM-14744: only return the SSL error status
1002 return (curl_exec($ch) !== FALSE);
1006 * Assert that we are running on a particular PHP version.
1009 * The major version of PHP that is required.
1010 * @param bool $abort
1011 * (optional) Whether to fatally abort if the version requirement is not
1012 * met. Defaults to TRUE.
1015 * Returns TRUE if the requirement is met, FALSE if the requirement is not
1016 * met and we're not aborting due to the failed requirement. If $abort is
1017 * TRUE and the requirement fails, this function does not return.
1019 * @throws CRM_Core_Exception
1021 public static function checkPHPVersion($ver = 5, $abort = TRUE) {
1022 $phpVersion = substr(PHP_VERSION
, 0, 1);
1023 if ($phpVersion >= $ver) {
1028 throw new CRM_Core_Exception(ts('This feature requires PHP Version %1 or greater',
1038 * @param string $string
1039 * @param bool $encode
1043 public static function formatWikiURL($string, $encode = FALSE) {
1044 $items = explode(' ', trim($string), 2);
1045 if (count($items) == 2) {
1053 $url = $encode ? self
::urlEncode($items[0]) : $items[0];
1054 return "<a href=\"$url\">$title</a>";
1060 * @param string $url
1062 * @return null|string
1064 public static function urlEncode($url) {
1065 $items = parse_url($url);
1066 if ($items === FALSE) {
1070 if (empty($items['query'])) {
1074 $items['query'] = urlencode($items['query']);
1076 $url = $items['scheme'] . '://';
1077 if (!empty($items['user'])) {
1078 $url .= "{$items['user']}:{$items['pass']}@";
1081 $url .= $items['host'];
1082 if (!empty($items['port'])) {
1083 $url .= ":{$items['port']}";
1086 $url .= "{$items['path']}?{$items['query']}";
1087 if (!empty($items['fragment'])) {
1088 $url .= "#{$items['fragment']}";
1095 * Return the running civicrm version.
1100 * @throws CRM_Core_Exception
1102 public static function version() {
1106 $verFile = implode(DIRECTORY_SEPARATOR
,
1107 [dirname(__FILE__
), '..', '..', 'xml', 'version.xml']
1109 if (file_exists($verFile)) {
1110 $str = file_get_contents($verFile);
1111 $xmlObj = simplexml_load_string($str);
1112 $version = (string) $xmlObj->version_no
;
1116 if (!CRM_Utils_System
::isVersionFormatValid($version)) {
1117 throw new CRM_Core_Exception('Unknown codebase version.');
1125 * Gives the first two parts of the version string E.g. 6.1.
1129 public static function majorVersion() {
1130 list($a, $b) = explode('.', self
::version());
1135 * Determines whether a string is a valid CiviCRM version string.
1137 * @param string $version
1138 * Version string to be checked.
1142 public static function isVersionFormatValid($version) {
1143 return preg_match("/^(\d{1,2}\.){2,3}(\d{1,2}|(alpha|beta)\d{1,2})(\.upgrade)?$/", $version);
1147 * Wraps or emulates PHP's getallheaders() function.
1149 public static function getAllHeaders() {
1150 if (function_exists('getallheaders')) {
1151 return getallheaders();
1154 // emulate get all headers
1155 // http://www.php.net/manual/en/function.getallheaders.php#66335
1157 foreach ($_SERVER as $name => $value) {
1158 if (substr($name, 0, 5) == 'HTTP_') {
1159 $headers[str_replace(' ',
1161 ucwords(strtolower(str_replace('_',
1173 * Get request headers.
1175 * @return array|false
1177 public static function getRequestHeaders() {
1178 if (function_exists('apache_request_headers')) {
1179 return apache_request_headers();
1187 * Determine whether this is an SSL request.
1189 * Note that we inline this function in install/civicrm.php, so if you change
1190 * this function, please go and change the code in the install script as well.
1192 public static function isSSL() {
1193 return (isset($_SERVER['HTTPS']) &&
1194 !empty($_SERVER['HTTPS']) &&
1195 strtolower($_SERVER['HTTPS']) != 'off') ?
TRUE : FALSE;
1201 * @param bool|FALSE $abort
1203 * @throws \CRM_Core_Exception
1205 public static function redirectToSSL($abort = FALSE) {
1206 $config = CRM_Core_Config
::singleton();
1207 $req_headers = self
::getRequestHeaders();
1208 // FIXME: Shouldn't the X-Forwarded-Proto check be part of CRM_Utils_System::isSSL()?
1209 if (Civi
::settings()->get('enableSSL') &&
1211 strtolower(CRM_Utils_Array
::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1213 // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1214 $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1215 // @see https://lab.civicrm.org/dev/core/issues/425 if you're seeing this message.
1216 Civi
::log()->warning('CiviCRM thinks site is not SSL, redirecting to {url}', ['url' => $url]);
1217 if (!self
::checkURL($url, TRUE)) {
1219 throw new CRM_Core_Exception('HTTPS is not set up on this machine');
1222 CRM_Core_Session
::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1223 // admin should be the only one following this
1224 // since we dont want the user stuck in a bad place
1228 CRM_Utils_System
::redirect($url);
1233 * Get logged in user's IP address.
1235 * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1236 * the Drupal function as this also handles reverse proxies (based on proper
1237 * configuration in settings.php)
1239 * @param bool $strictIPV4
1240 * (optional) Whether to return only IPv4 addresses.
1243 * IP address of logged in user.
1245 public static function ipAddress($strictIPV4 = TRUE) {
1246 $address = CRM_Utils_Array
::value('REMOTE_ADDR', $_SERVER);
1248 $config = CRM_Core_Config
::singleton();
1249 if ($config->userSystem
->is_drupal
&& function_exists('ip_address')) {
1250 // drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1251 // that reach this point without bootstrapping hence the check that the fn exists
1252 $address = ip_address();
1256 if ($address == '::1') {
1257 $address = '127.0.0.1';
1260 // when we need to have strictly IPV4 ip address
1261 // convert ipV6 to ipV4
1263 // this converts 'IPV4 mapped IPV6 address' to IPV4
1264 if (filter_var($address, FILTER_VALIDATE_IP
, FILTER_FLAG_IPV6
) && strstr($address, '::ffff:')) {
1265 $address = ltrim($address, '::ffff:');
1273 * Get the referring / previous page URL.
1276 * The previous page URL
1278 public static function refererPath() {
1279 return CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
1283 * Get the documentation base URL.
1286 * Base URL of the CRM documentation.
1288 public static function getDocBaseURL() {
1289 // FIXME: move this to configuration at some stage
1290 return 'https://docs.civicrm.org/';
1294 * Returns wiki (alternate) documentation URL base.
1299 public static function getWikiBaseURL() {
1300 // FIXME: move this to configuration at some stage
1301 return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1305 * Returns URL or link to documentation page, based on provided parameters.
1307 * For use in PHP code.
1308 * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1311 * @param string $page
1312 * Title of documentation wiki page.
1313 * @param bool $URLonly
1314 * (optional) Whether to return URL only or full HTML link (default).
1315 * @param string $text
1316 * (optional) Text of HTML link (no effect if $URLonly = false).
1317 * @param string $title
1318 * (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1319 * @param string $style
1320 * (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1322 * @param null $resource
1325 * URL or link to documentation page, based on provided parameters.
1327 public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1328 // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1329 // return just the URL, no matter what other parameters are defined
1330 if (!function_exists('ts')) {
1331 if ($resource == 'wiki') {
1332 $docBaseURL = self
::getWikiBaseURL();
1335 $docBaseURL = self
::getDocBaseURL();
1336 $page = self
::formatDocUrl($page);
1338 return $docBaseURL . str_replace(' ', '+', $page);
1343 'URLonly' => $URLonly,
1347 'resource' => $resource,
1349 return self
::docURL($params);
1354 * Returns URL or link to documentation page, based on provided parameters.
1356 * For use in templates code.
1358 * @param array $params
1359 * An array of parameters (see CRM_Utils_System::docURL2 method for names)
1361 * @return null|string
1362 * URL or link to documentation page, based on provided parameters.
1364 public static function docURL($params) {
1366 if (!isset($params['page'])) {
1370 if (CRM_Utils_Array
::value('resource', $params) == 'wiki') {
1371 $docBaseURL = self
::getWikiBaseURL();
1374 $docBaseURL = self
::getDocBaseURL();
1375 $params['page'] = self
::formatDocUrl($params['page']);
1378 if (!isset($params['title']) or $params['title'] === NULL) {
1379 $params['title'] = ts('Opens documentation in a new window.');
1382 if (!isset($params['text']) or $params['text'] === NULL) {
1383 $params['text'] = ts('(learn more...)');
1386 if (!isset($params['style']) ||
$params['style'] === NULL) {
1390 $style = "style=\"{$params['style']}\"";
1393 $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1395 if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1399 return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1404 * Add language and version parameters to the doc url.
1406 * Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.
1411 public static function formatDocUrl($url) {
1412 return preg_replace('#^(user|sysadmin|dev)/#', '\1/en/stable/', $url);
1416 * Exit with provided exit code.
1418 * @param int $status
1419 * (optional) Code with which to exit.
1421 * @param array $testParameters
1423 public static function civiExit($status = 0, $testParameters = []) {
1425 if (CIVICRM_UF
=== 'UnitTests') {
1426 throw new CRM_Core_Exception_PrematureExitException('civiExit called', $testParameters);
1429 http_response_code(500);
1431 // move things to CiviCRM cache as needed
1432 CRM_Core_Session
::storeSessionObjects();
1434 if (Civi\Core\Container
::isContainerBooted()) {
1435 Civi
::dispatcher()->dispatch('civi.core.exit');
1438 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
1439 if (is_callable([$userSystem, 'onCiviExit'])) {
1440 $userSystem->onCiviExit();
1446 * Reset the various system caches and some important static variables.
1448 public static function flushCache() {
1449 // flush out all cache entries so we can reload new data
1450 // a bit aggressive, but livable for now
1451 CRM_Utils_Cache
::singleton()->flush();
1453 // Traditionally, systems running on memory-backed caches were quite
1454 // zealous about destroying *all* memory-backed caches during a flush().
1455 // These flushes simulate that legacy behavior. However, they should probably
1456 // be removed at some point.
1457 $localDrivers = ['CRM_Utils_Cache_ArrayCache', 'CRM_Utils_Cache_NoCache'];
1458 if (Civi\Core\Container
::isContainerBooted()
1459 && !in_array(get_class(CRM_Utils_Cache
::singleton()), $localDrivers)) {
1460 Civi
::cache('long')->flush();
1461 Civi
::cache('settings')->flush();
1462 Civi
::cache('js_strings')->flush();
1463 Civi
::cache('community_messages')->flush();
1464 Civi
::cache('groups')->flush();
1465 Civi
::cache('navigation')->flush();
1466 Civi
::cache('customData')->flush();
1467 Civi
::cache('contactTypes')->clear();
1468 Civi
::cache('metadata')->clear();
1469 CRM_Extension_System
::singleton()->getCache()->flush();
1470 CRM_Cxn_CiviCxnHttp
::singleton()->getCache()->flush();
1473 // also reset the various static memory caches
1475 // reset the memory or array cache
1476 Civi
::cache('fields')->flush();
1479 CRM_ACL_BAO_Cache
::resetCache();
1481 // reset various static arrays used here
1482 CRM_Contact_BAO_Contact
::$_importableFields = CRM_Contact_BAO_Contact
::$_exportableFields
1483 = CRM_Contribute_BAO_Contribution
::$_importableFields
1484 = CRM_Contribute_BAO_Contribution
::$_exportableFields
1485 = CRM_Pledge_BAO_Pledge
::$_exportableFields
1486 = CRM_Core_BAO_CustomField
::$_importFields
1487 = CRM_Core_BAO_Cache
::$_cache = CRM_Core_DAO
::$_dbColumnValueCache = NULL;
1489 CRM_Core_OptionGroup
::flushAll();
1490 CRM_Utils_PseudoConstant
::flushAll();
1494 * Load CMS bootstrap.
1496 * @param array $params
1497 * Array with uid name and pass
1498 * @param bool $loadUser
1499 * Boolean load user or not.
1500 * @param bool $throwError
1501 * @param string $realPath
1503 public static function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1504 if (!is_array($params)) {
1507 $config = CRM_Core_Config
::singleton();
1508 $result = $config->userSystem
->loadBootStrap($params, $loadUser, $throwError, $realPath);
1509 if (is_callable([$config->userSystem
, 'setMySQLTimeZone'])) {
1510 $config->userSystem
->setMySQLTimeZone();
1518 * @return mixed|string
1520 public static function baseCMSURL() {
1521 static $_baseURL = NULL;
1523 $config = CRM_Core_Config
::singleton();
1524 $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL
;
1526 if ($config->userFramework
== 'Joomla') {
1528 // we need to remove the administrator/ from the end
1529 $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1533 global $civicrm_root;
1534 if (strpos($civicrm_root,
1535 DIRECTORY_SEPARATOR
. 'sites' .
1536 DIRECTORY_SEPARATOR
. 'all' .
1537 DIRECTORY_SEPARATOR
. 'modules'
1540 $startPos = strpos($civicrm_root,
1541 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
1543 $endPos = strpos($civicrm_root,
1544 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
1546 if ($startPos && $endPos) {
1547 // if component is in sites/SITENAME/modules
1548 $siteName = substr($civicrm_root,
1550 $endPos - $startPos - 7
1553 $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1562 * Given a URL, return a relative URL if possible.
1564 * @param string $url
1568 public static function relativeURL($url) {
1569 // check if url is relative, if so return immediately
1570 if (substr($url, 0, 4) != 'http') {
1574 // make everything relative from the baseFilePath
1575 $baseURL = self
::baseCMSURL();
1577 // check if baseURL is a substr of $url, if so
1578 // return rest of string
1579 if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1580 return substr($url, strlen($baseURL));
1583 // return the original value
1588 * Produce an absolute URL from a possibly-relative URL.
1590 * @param string $url
1591 * @param bool $removeLanguagePart
1595 public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1596 // check if url is already absolute, if so return immediately
1597 if (substr($url, 0, 4) == 'http') {
1601 // make everything absolute from the baseFileURL
1602 $baseURL = self
::baseCMSURL();
1604 //CRM-7622: drop the language from the URL if requested (and it’s there)
1605 $config = CRM_Core_Config
::singleton();
1606 if ($removeLanguagePart) {
1607 $baseURL = self
::languageNegotiationURL($baseURL, FALSE, TRUE);
1610 return $baseURL . $url;
1614 * Clean url, replaces first '&' with '?'.
1616 * @param string $url
1621 public static function cleanUrl($url) {
1626 if ($pos = strpos($url, '&')) {
1627 $url = substr_replace($url, '?', $pos, 1);
1634 * Format the url as per language Negotiation.
1636 * @param string $url
1638 * @param bool $addLanguagePart
1639 * @param bool $removeLanguagePart
1644 public static function languageNegotiationURL(
1646 $addLanguagePart = TRUE,
1647 $removeLanguagePart = FALSE
1649 return CRM_Core_Config
::singleton()->userSystem
->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1653 * Append the contents of an 'extra' smarty template file.
1655 * It must be present in the custom template directory. This does not work if there are
1656 * multiple custom template directories
1658 * @param string $fileName
1659 * The name of the tpl file that we are processing.
1660 * @param string $content
1661 * The current content string. May be modified by this function.
1662 * @param string $overideFileName
1663 * (optional) Sent by contribution/event reg/profile pages which uses a id
1664 * specific extra file name if present.
1666 public static function appendTPLFile(
1669 $overideFileName = NULL
1671 $template = CRM_Core_Smarty
::singleton();
1672 if ($overideFileName) {
1673 $additionalTPLFile = $overideFileName;
1676 $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1679 if ($template->template_exists($additionalTPLFile)) {
1680 $content .= $template->fetch($additionalTPLFile);
1685 * Get a list of all files that are found within the directories.
1687 * Files must be the result of appending the provided relative path to
1688 * each component of the PHP include path.
1690 * @author Ken Zalewski
1692 * @param string $relpath
1693 * A relative path, typically pointing to a directory with multiple class
1697 * An array of files that exist in one or more of the directories that are
1698 * referenced by the relative path when appended to each element of the PHP
1701 public static function listIncludeFiles($relpath) {
1703 $inc_dirs = explode(PATH_SEPARATOR
, get_include_path());
1704 foreach ($inc_dirs as $inc_dir) {
1705 $target_dir = $inc_dir . DIRECTORY_SEPARATOR
. $relpath;
1706 if (is_dir($target_dir)) {
1707 $cur_list = scandir($target_dir);
1708 foreach ($cur_list as $fname) {
1709 if ($fname != '.' && $fname != '..') {
1710 $file_list[$fname] = $fname;
1719 * Get a list of all "plugins".
1721 * (PHP classes that implement a piece of
1722 * functionality using a well-defined interface) that are found in a
1723 * particular CiviCRM directory (both custom and core are searched).
1725 * @author Ken Zalewski
1727 * @param string $relpath
1728 * A relative path referencing a directory that contains one or more
1730 * @param string $fext
1731 * (optional) Only files with this extension will be considered to be
1733 * @param array $skipList
1734 * (optional) List of files to skip.
1737 * List of plugins, where the plugin name is both the key and the value of
1740 public static function getPluginList($relpath, $fext = '.php', $skipList = []) {
1741 $fext_len = strlen($fext);
1743 $inc_files = CRM_Utils_System
::listIncludeFiles($relpath);
1744 foreach ($inc_files as $inc_file) {
1745 if (substr($inc_file, 0 - $fext_len) == $fext) {
1746 $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1747 if (!in_array($plugin_name, $skipList)) {
1748 $plugins[$plugin_name] = $plugin_name;
1756 * Execute scheduled jobs.
1758 public static function executeScheduledJobs() {
1759 $facility = new CRM_Core_JobManager();
1760 $facility->execute(FALSE);
1762 $redirectUrl = self
::url('civicrm/admin/job', 'reset=1');
1764 CRM_Core_Session
::setStatus(
1765 ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1766 ts('Complete'), 'success');
1768 CRM_Utils_System
::redirect($redirectUrl);
1772 * Evaluate any tokens in a URL.
1774 * @param string|FALSE $url
1776 * @return string|FALSE
1778 public static function evalUrl($url) {
1779 if (!$url ||
strpos($url, '{') === FALSE) {
1783 $config = CRM_Core_Config
::singleton();
1785 '{ver}' => CRM_Utils_System
::version(),
1786 '{uf}' => $config->userFramework
,
1787 '{php}' => phpversion(),
1788 '{sid}' => self
::getSiteID(),
1789 '{baseUrl}' => $config->userFrameworkBaseURL
,
1790 '{lang}' => $config->lcMessages
,
1791 '{co}' => $config->defaultContactCountry
,
1793 return strtr($url, array_map('urlencode', $vars));
1798 * Returns the unique identifier for this site, as used by community messages.
1800 * SiteID will be generated if it is not already stored in the settings table.
1804 public static function getSiteID() {
1805 $sid = Civi
::settings()->get('site_id');
1807 $config = CRM_Core_Config
::singleton();
1808 $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '') . '_' . $config->userFrameworkBaseURL
);
1809 civicrm_api3('Setting', 'create', ['domain_id' => 'all', 'site_id' => $sid]);
1815 * Determine whether this is a developmental system.
1819 public static function isDevelopment() {
1820 static $cache = NULL;
1821 if ($cache === NULL) {
1822 global $civicrm_root;
1823 $cache = file_exists("{$civicrm_root}/.svn") ||
file_exists("{$civicrm_root}/.git");
1829 * Is in upgrade mode.
1833 public static function isInUpgradeMode() {
1834 $args = explode('/', CRM_Utils_Array
::value('q', $_GET));
1835 $upgradeInProcess = CRM_Core_Session
::singleton()->get('isUpgradePending');
1836 if ((isset($args[1]) && $args[1] == 'upgrade') ||
$upgradeInProcess) {
1845 * Determine the standard URL for viewing or editing the specified link.
1847 * This function delegates the decision-making to (a) the hook system and
1848 * (b) the BAO system.
1850 * @param array $crudLinkSpec
1852 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1853 * - entity_table: string, eg "civicrm_contact"
1856 * @return array|NULL
1857 * NULL if unavailable, or an array. array has keys:
1863 public static function createDefaultCrudLink($crudLinkSpec) {
1864 $crudLinkSpec['action'] = CRM_Utils_Array
::value('action', $crudLinkSpec, CRM_Core_Action
::VIEW
);
1865 $daoClass = CRM_Core_DAO_AllCoreTables
::getClassForTable($crudLinkSpec['entity_table']);
1870 $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1871 if (!class_exists($baoClass)) {
1875 $bao = new $baoClass();
1876 $bao->id
= $crudLinkSpec['entity_id'];
1877 if (!$bao->find(TRUE)) {
1882 CRM_Utils_Hook
::crudLink($crudLinkSpec, $bao, $link);
1883 if (empty($link) && is_callable([$bao, 'createDefaultCrudLink'])) {
1884 $link = $bao->createDefaultCrudLink($crudLinkSpec);
1887 if (!empty($link)) {
1888 if (!isset($link['url'])) {
1889 $link['url'] = self
::url($link['path'], $link['query'], TRUE, NULL, FALSE);
1898 * Return an HTTP Response with appropriate content and status code set.
1899 * @param \Psr\Http\Message\ResponseInterface $response
1901 public static function sendResponse(\Psr\Http\Message\ResponseInterface
$response) {
1902 $config = CRM_Core_Config
::singleton()->userSystem
->sendResponse($response);