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) {
84 $path = $path ?
: CRM_Utils_System
::currentPath();
91 CRM_Utils_System
::getLinksUrl($urlVar, $includeReset, $includeForce),
97 * Get the query string and clean it up.
99 * Strips some variables that should not be propagated, specifically variables
100 * like 'reset'. Also strips any side-affect actions (e.g. export).
102 * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
104 * @param string $urlVar
105 * The URL variable being considered (e.g. crmPageID, crmSortID etc).
106 * @param bool $includeReset
107 * (optional) By default this is FALSE, meaning that the reset parameter
108 * is skipped. Set to TRUE to leave the reset parameter as-is.
109 * @param bool $includeForce
111 * @param bool $skipUFVar
116 public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
117 // Sort out query string to prevent messy urls
122 if (!empty($_SERVER['QUERY_STRING'])) {
123 $qs = explode('&', str_replace('&', '&', $_SERVER['QUERY_STRING']));
124 for ($i = 0, $cnt = count($qs); $i < $cnt; $i++
) {
125 // check first if exist a pair
126 if (strstr($qs[$i], '=') !== FALSE) {
127 list($name, $value) = explode('=', $qs[$i]);
128 if ($name != $urlVar) {
129 $name = rawurldecode($name);
130 // check for arrays in parameters: site.php?foo[]=1&foo[]=2&foo[]=3
131 if ((strpos($name, '[') !== FALSE) &&
132 (strpos($name, ']') !== FALSE)
152 // Ok this is a big assumption but usually works
153 // If we are in snippet mode, retain the 'section' param, if not, get rid
155 if (!empty($qs['snippet'])) {
156 unset($qs['snippet']);
159 unset($qs['section']);
163 $config = CRM_Core_Config
::singleton();
164 unset($qs[$config->userFrameworkURLVar
]);
167 foreach ($qs as $name => $value) {
168 if ($name != 'reset' ||
$includeReset) {
169 $querystring[] = $name . '=' . $value;
173 $querystring = array_merge($querystring, array_unique($arrays));
175 $url = implode('&', $querystring);
177 $url .= (!empty($querystring) ?
'&' : '') . $urlVar . '=';
184 * If we are using a theming system, invoke theme, else just print the content.
186 * @param string $content
187 * The content that will be themed.
189 * (optional) Are we displaying to the screen or bypassing theming?
190 * @param bool $maintenance
191 * (optional) For maintenance mode.
195 public static function theme(
200 return CRM_Core_Config
::singleton()->userSystem
->theme($content, $print, $maintenance);
204 * Generate a query string if input is an array.
206 * @param array|string $query
210 public static function makeQueryString($query) {
211 if (is_array($query)) {
213 foreach ($query as $key => $value) {
214 $buf .= ($buf ?
'&' : '') . urlencode($key) . '=' . urlencode($value);
222 * Generate an internal CiviCRM URL.
224 * @param string $path
225 * The path being linked to, such as "civicrm/add".
226 * @param array|string $query
227 * A query string to append to the link, or an array of key-value pairs.
228 * @param bool $absolute
229 * Whether to force the output to be an absolute link (beginning with a
230 * URI-scheme such as 'http:'). Useful for links that will be displayed
231 * outside the site, such as in an RSS feed.
232 * @param string $fragment
233 * A fragment identifier (named anchor) to append to the link.
234 * @param bool $htmlize
235 * Whether to encode special html characters such as &.
236 * @param bool $frontend
237 * This link should be to the CMS front end (applies to WP & Joomla).
238 * @param bool $forceBackend
239 * This link should be to the CMS back end (applies to WP & Joomla).
242 * An HTML string containing a link to the given path.
244 public static function url(
251 $forceBackend = FALSE
253 $query = self
::makeQueryString($query);
255 // Legacy handling for when the system passes around html escaped strings
256 if (strstr($query, '&')) {
257 $query = html_entity_decode($query);
260 // Extract fragment from path or query if munged together
261 if ($query && strstr($query, '#')) {
262 list($path, $fragment) = explode('#', $query);
264 if ($path && strstr($path, '#')) {
265 list($path, $fragment) = explode('#', $path);
268 // Extract query from path if munged together
269 if ($path && strstr($path, '?')) {
270 list($path, $extraQuery) = explode('?', $path);
271 $query = $extraQuery . ($query ?
"&$query" : '');
274 $config = CRM_Core_Config
::singleton();
275 $url = $config->userSystem
->url($path, $query, $absolute, $fragment, $frontend, $forceBackend, $htmlize);
278 $url = htmlentities($url);
285 * Return the Notification URL for Payments.
287 * @param string $path
288 * The path being linked to, such as "civicrm/add".
289 * @param array|string $query
290 * A query string to append to the link, or an array of key-value pairs.
291 * @param bool $absolute
292 * Whether to force the output to be an absolute link (beginning with a
293 * URI-scheme such as 'http:'). Useful for links that will be displayed
294 * outside the site, such as in an RSS feed.
295 * @param string $fragment
296 * A fragment identifier (named anchor) to append to the link.
297 * @param bool $htmlize
298 * Whether to encode special html characters such as &.
299 * @param bool $frontend
300 * This link should be to the CMS front end (applies to WP & Joomla).
301 * @param bool $forceBackend
302 * This link should be to the CMS back end (applies to WP & Joomla).
305 * The Notification URL.
307 public static function getNotifyUrl(
314 $forceBackend = FALSE
316 $config = CRM_Core_Config
::singleton();
317 $query = self
::makeQueryString($query);
318 return $config->userSystem
->getNotifyUrl($path, $query, $absolute, $fragment, $frontend, $forceBackend, $htmlize);
322 * Generates an extern url.
324 * @param string $path
325 * The extern path, such as "extern/url".
326 * @param string $query
327 * A query string to append to the link.
328 * @param string $fragment
329 * A fragment identifier (named anchor) to append to the link.
330 * @param bool $absolute
331 * Whether to force the output to be an absolute link (beginning with a
332 * URI-scheme such as 'http:').
334 * NULL to autodetect. TRUE to force to SSL.
336 * @return string rawencoded URL.
338 public static function externUrl($path = NULL, $query = NULL, $fragment = NULL, $absolute = TRUE, $isSSL = NULL) {
339 $query = self
::makeQueryString($query);
341 $url = Civi
::paths()->getUrl("[civicrm.root]/{$path}.php", $absolute ?
'absolute' : 'relative', $isSSL)
342 . ($query ?
"?$query" : "")
343 . ($fragment ?
"#$fragment" : "");
345 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
346 $event = \Civi\Core\Event\GenericHookEvent
::create([
347 'url' => &$parsedUrl,
350 'fragment' => $fragment,
351 'absolute' => $absolute,
354 Civi
::dispatcher()->dispatch('hook_civicrm_alterExternUrl', $event);
355 return urldecode(CRM_Utils_Url
::unparseUrl($event->url
));
359 * Perform any current conversions/migrations on the extern URL.
361 * @param \Civi\Core\Event\GenericHookEvent $e
362 * @see CRM_Utils_Hook::alterExternUrl
364 public static function migrateExternUrl(\Civi\Core\Event\GenericHookEvent
$e) {
367 * $mkRouteUri is a small adapter to return generated URL as a "UriInterface".
368 * @param string $path
369 * @param string $query
370 * @return \Psr\Http\Message\UriInterface
372 $mkRouteUri = function ($path, $query) use ($e) {
373 $urlTxt = CRM_Utils_System
::url($path, $query, $e->absolute
, $e->fragment
, FALSE, TRUE);
374 if ($e->isSSL ||
($e->isSSL
=== NULL && \CRM_Utils_System
::isSSL())) {
375 $urlTxt = str_replace('http://', 'https://', $urlTxt);
377 return CRM_Utils_Url
::parseUrl($urlTxt);
380 switch (Civi
::settings()->get('defaultExternUrl') . ':' . $e->path
) {
381 case 'router:extern/open':
382 $e->url
= $mkRouteUri('civicrm/mailing/open', preg_replace('/(^|&)q=/', '\1qid=', $e->query
));
385 case 'router:extern/url':
386 $e->url
= $mkRouteUri('civicrm/mailing/url', $e->query
);
389 case 'router:extern/widget':
390 $e->url
= $mkRouteUri('civicrm/contribute/widget', $e->query
);
393 // Otherwise, keep the default.
399 * @see \CRM_Utils_System::currentPath
401 * @return string|null
403 public static function getUrlPath() {
404 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Utils_System::currentPath');
405 return self
::currentPath();
411 * @param string $text
412 * @param string $path
413 * @param string|array $query
414 * @param bool $absolute
415 * @param string $fragment
416 * @param bool $htmlize
417 * @param bool $frontend
418 * @param bool $forceBackend
422 public static function href(
423 $text, $path = NULL, $query = NULL, $absolute = TRUE,
424 $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
426 $url = self
::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
427 return "<a href=\"$url\">$text</a>";
431 * Path of the current page e.g. 'civicrm/contact/view'
433 * @return string|null
434 * the current menu path
436 public static function currentPath() {
437 $config = CRM_Core_Config
::singleton();
438 return isset($_GET[$config->userFrameworkURLVar
]) ?
trim($_GET[$config->userFrameworkURLVar
], '/') : NULL;
442 * Called from a template to compose a url.
444 * @param array $params
445 * List of parameters.
450 public static function crmURL($params) {
451 $p = $params['p'] ??
NULL;
453 $p = self
::currentPath();
458 CRM_Utils_Array
::value('q', $params),
459 CRM_Utils_Array
::value('a', $params, FALSE),
460 CRM_Utils_Array
::value('f', $params),
461 CRM_Utils_Array
::value('h', $params, TRUE),
462 CRM_Utils_Array
::value('fe', $params, FALSE),
463 CRM_Utils_Array
::value('fb', $params, FALSE)
468 * Sets the title of the page.
470 * @param string $title
471 * Document title - plain text only
472 * @param string $pageTitle
473 * Page title (if different) - may include html
475 public static function setTitle($title, $pageTitle = NULL) {
476 self
::$title = $title;
477 $config = CRM_Core_Config
::singleton();
478 return $config->userSystem
->setTitle($title, $pageTitle);
482 * Figures and sets the userContext.
484 * Uses the referrer if valid else uses the default.
486 * @param array $names
487 * Referrer should match any str in this array.
488 * @param string $default
489 * (optional) The default userContext if no match found.
491 public static function setUserContext($names, $default = NULL) {
494 $session = CRM_Core_Session
::singleton();
495 $referer = $_SERVER['HTTP_REFERER'] ??
NULL;
497 if ($referer && !empty($names)) {
498 foreach ($names as $name) {
499 if (strstr($referer, $name)) {
507 $session->pushUserContext($url);
512 * Gets a class name for an object.
514 * @param object $object
515 * Object whose class name is needed.
518 * The class name of the object.
520 public static function getClassName($object) {
521 return get_class($object);
525 * Redirect to another URL.
528 * The URL to provide to the browser via the Location header.
529 * @param array $context
530 * Optional additional information for the hook.
532 public static function redirect($url = NULL, $context = []) {
534 $url = self
::url('civicrm/dashboard', 'reset=1');
536 // replace the & characters with &
537 // this is kinda hackish but not sure how to do it right
538 $url = str_replace('&', '&', $url);
540 $context['output'] = $_GET['snippet'] ??
NULL;
542 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
543 CRM_Utils_Hook
::alterRedirect($parsedUrl, $context);
544 $url = CRM_Utils_Url
::unparseUrl($parsedUrl);
546 // If we are in a json context, respond appropriately
547 if ($context['output'] === 'json') {
548 CRM_Core_Page_AJAX
::returnJsonResponse([
549 'status' => 'redirect',
550 'userContext' => $url,
554 self
::setHttpHeader('Location', $url);
555 self
::civiExit(0, ['url' => $url, 'context' => 'redirect']);
559 * Redirect to another URL using JavaScript.
561 * Use an html based file with javascript embedded to redirect to another url
562 * This prevent the too many redirect errors emitted by various browsers
565 * (optional) The destination URL.
566 * @param string $title
567 * (optional) The page title to use for the redirect page.
568 * @param string $message
569 * (optional) The message to provide in the body of the redirect page.
571 public static function jsRedirect(
577 $url = self
::url('civicrm/dashboard', 'reset=1');
581 $title = ts('CiviCRM task in progress');
585 $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
588 // replace the & characters with &
589 // this is kinda hackish but not sure how to do it right
590 $url = str_replace('&', '&', $url);
592 $template = CRM_Core_Smarty
::singleton();
593 $template->assign('redirectURL', $url);
594 $template->assign('title', $title);
595 $template->assign('message', $message);
597 $html = $template->fetch('CRM/common/redirectJS.tpl');
605 * Get the base URL of the system.
609 public static function baseURL() {
610 $config = CRM_Core_Config
::singleton();
611 return $config->userFrameworkBaseURL
;
615 * Authenticate or abort.
617 * @param string $message
622 public static function authenticateAbort($message, $abort) {
636 * (optional) Whether to exit; defaults to true.
640 public static function authenticateKey($abort = TRUE) {
641 // also make sure the key is sent and is valid
642 $key = trim(CRM_Utils_Array
::value('key', $_REQUEST));
644 $docAdd = "More info at: " . CRM_Utils_System
::docURL2('sysadmin/setup/jobs', TRUE);
647 return self
::authenticateAbort(
648 "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
653 $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: NULL;
655 if (!$siteKey ||
empty($siteKey)) {
656 return self
::authenticateAbort(
657 "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
662 if (strlen($siteKey) < 8) {
663 return self
::authenticateAbort(
664 "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
669 if (!hash_equals($siteKey, $key)) {
670 return self
::authenticateAbort(
671 "ERROR: Invalid key value sent. " . $docAdd . "\n",
680 * Authenticate script.
683 * @param string $name
684 * @param string $pass
685 * @param bool $storeInSession
686 * @param bool $loadCMSBootstrap
687 * @param bool $requireKey
691 public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
692 // auth to make sure the user has a login/password to do a shell operation
693 // later on we'll link this to acl's
695 $name = trim(CRM_Utils_Array
::value('name', $_REQUEST));
696 $pass = trim(CRM_Utils_Array
::value('pass', $_REQUEST));
699 // its ok to have an empty password
701 return self
::authenticateAbort(
702 "ERROR: You need to send a valid user name and password to execute this file\n",
707 if ($requireKey && !self
::authenticateKey($abort)) {
711 $result = CRM_Utils_System
::authenticate($name, $pass, $loadCMSBootstrap);
713 return self
::authenticateAbort(
714 "ERROR: Invalid username and/or password\n",
718 elseif ($storeInSession) {
719 // lets store contact id and user id in session
720 list($userID, $ufID, $randomNumber) = $result;
721 if ($userID && $ufID) {
722 $config = CRM_Core_Config
::singleton();
723 $config->userSystem
->setUserSession([$userID, $ufID]);
726 return self
::authenticateAbort(
727 "ERROR: Unexpected error, could not match userID and contactID",
737 * Authenticate the user against the uf db.
739 * In case of successful authentication, returns an array consisting of
740 * (contactID, ufID, unique string). Returns FALSE if authentication is
743 * @param string $name
745 * @param string $password
747 * @param bool $loadCMSBootstrap
748 * @param string $realPath
750 * @return false|array
752 public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
753 $config = CRM_Core_Config
::singleton();
755 /* Before we do any loading, let's start the session and write to it.
756 * We typically call authenticate only when we need to bootstrap the CMS
757 * directly via Civi and hence bypass the normal CMS auth and bootstrap
758 * process typically done in CLI and cron scripts. See: CRM-12648
760 * Q: Can we move this to the userSystem class so that it can be tuned
761 * per-CMS? For example, when dealing with UnitTests UF, does it need to
762 * do this session write since the original issue was for Drupal.
764 $session = CRM_Core_Session
::singleton();
765 $session->set('civicrmInitSession', TRUE);
767 return $config->userSystem
->authenticate($name, $password, $loadCMSBootstrap, $realPath);
771 * Set a message in the UF to display to a user.
773 * @param string $message
774 * The message to set.
776 public static function setUFMessage($message) {
777 $config = CRM_Core_Config
::singleton();
778 return $config->userSystem
->setMessage($message);
782 * Determine whether a value is null-ish.
784 * @param mixed $value
785 * The value to check for null.
789 public static function isNull($value) {
790 // FIXME: remove $value = 'null' string test when we upgrade our DAO code to handle passing null in a better way.
791 if (!isset($value) ||
$value === NULL ||
$value === '' ||
$value === 'null') {
794 if (is_array($value)) {
795 // @todo Reuse of the $value variable = asking for trouble.
796 foreach ($value as $key => $value) {
797 if (in_array($key, CRM_Core_DAO
::acceptedSQLOperators(), TRUE) ||
!self
::isNull($value)) {
807 * Obscure all but the last few digits of a credit card number.
809 * @param string $number
810 * The credit card number to obscure.
812 * (optional) The number of digits to preserve unmodified.
815 * The obscured credit card number.
817 public static function mungeCreditCard($number, $keep = 4) {
818 $number = trim($number);
819 if (empty($number)) {
822 $replace = str_repeat('*', strlen($number) - $keep);
823 return substr_replace($number, $replace, 0, -$keep);
827 * Determine which PHP modules are loaded.
831 private static function parsePHPModules() {
833 phpinfo(INFO_MODULES
);
834 $s = ob_get_contents();
837 $s = strip_tags($s, '<h2><th><td>');
838 $s = preg_replace('/<th[^>]*>([^<]+)<\/th>/', "<info>\\1</info>", $s);
839 $s = preg_replace('/<td[^>]*>([^<]+)<\/td>/', "<info>\\1</info>", $s);
840 $vTmp = preg_split('/(<h2>[^<]+<\/h2>)/', $s, -1, PREG_SPLIT_DELIM_CAPTURE
);
842 for ($i = 1; $i < count($vTmp); $i++
) {
843 if (preg_match('/<h2>([^<]+)<\/h2>/', $vTmp[$i], $vMat)) {
844 $vName = trim($vMat[1]);
845 $vTmp2 = explode("\n", $vTmp[$i +
1]);
846 foreach ($vTmp2 as $vOne) {
847 $vPat = '<info>([^<]+)<\/info>';
848 $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
849 $vPat2 = "/$vPat\s*$vPat/";
851 if (preg_match($vPat3, $vOne, $vMat)) {
852 $vModules[$vName][trim($vMat[1])] = [trim($vMat[2]), trim($vMat[3])];
855 elseif (preg_match($vPat2, $vOne, $vMat)) {
856 $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
865 * Get a setting from a loaded PHP module.
867 * @param string $pModuleName
868 * @param string $pSetting
872 public static function getModuleSetting($pModuleName, $pSetting) {
873 $vModules = self
::parsePHPModules();
874 return $vModules[$pModuleName][$pSetting];
878 * Do something no-one bothered to document.
880 * @param string $title
883 * @return mixed|string
885 public static function memory($title = NULL) {
888 $pid = posix_getpid();
891 $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
892 $memory .= ", " . time();
894 CRM_Core_Error
::debug_var($title, $memory);
900 * Download something or other.
902 * @param string $name
903 * @param string $mimeType
904 * @param string $buffer
906 * @param bool $output
907 * @param string $disposition
909 public static function download(
910 $name, $mimeType, &$buffer,
913 $disposition = 'attachment'
915 $now = gmdate('D, d M Y H:i:s') . ' GMT';
917 self
::setHttpHeader('Content-Type', $mimeType);
918 self
::setHttpHeader('Expires', $now);
920 // lem9 & loic1: IE needs specific headers
921 $isIE = empty($_SERVER['HTTP_USER_AGENT']) ?
FALSE : strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
923 $fileString = "filename=\"{$name}.{$ext}\"";
926 $fileString = "filename=\"{$name}\"";
929 self
::setHttpHeader("Content-Disposition", "inline; $fileString");
930 self
::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
931 self
::setHttpHeader('Pragma', 'public');
934 self
::setHttpHeader("Content-Disposition", "$disposition; $fileString");
935 self
::setHttpHeader('Pragma', 'no-cache');
945 * Gather and print (and possibly log) amount of used memory.
947 * @param string $title
949 * (optional) Whether to log the memory usage information.
951 public static function xMemory($title = NULL, $log = FALSE) {
952 $mem = (float ) xdebug_memory_usage() / (float ) (1024);
953 $mem = number_format($mem, 5) . ", " . time();
955 echo "<p>$title: $mem<p>";
957 CRM_Core_Error
::debug_var($title, $mem);
960 echo "<p>$title: $mem<p>";
966 * Take a URL (or partial URL) and make it better.
968 * Currently, URLs pass straight through unchanged unless they are "seriously
969 * malformed" (see http://us2.php.net/parse_url).
972 * The URL to operate on.
977 public static function fixURL($url) {
978 $components = parse_url($url);
984 // at some point we'll add code here to make sure the url is not
985 // something that will mess up, so we need to clean it up here
990 * Make sure a callback is valid in the current context.
992 * @param string $callback
993 * Name of the function to check.
997 public static function validCallback($callback) {
998 if (self
::$_callbacks === NULL) {
999 self
::$_callbacks = [];
1002 if (!array_key_exists($callback, self
::$_callbacks)) {
1003 if (strpos($callback, '::') !== FALSE) {
1004 list($className, $methodName) = explode('::', $callback);
1005 $fileName = str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
1006 // ignore errors if any
1007 @include_once
$fileName;
1008 if (!class_exists($className)) {
1009 self
::$_callbacks[$callback] = FALSE;
1012 // instantiate the class
1013 $object = new $className();
1014 if (!method_exists($object, $methodName)) {
1015 self
::$_callbacks[$callback] = FALSE;
1018 self
::$_callbacks[$callback] = TRUE;
1023 self
::$_callbacks[$callback] = function_exists($callback);
1026 return self
::$_callbacks[$callback];
1030 * Like PHP's built-in explode(), but always return an array of $limit items.
1032 * This serves as a wrapper to the PHP explode() function. In the event that
1033 * PHP's explode() returns an array with fewer than $limit elements, pad
1034 * the end of the array with NULLs.
1036 * @param string $separator
1037 * @param string $string
1042 public static function explode($separator, $string, $limit) {
1043 $result = explode($separator, $string, $limit);
1044 for ($i = count($result); $i < $limit; $i++
) {
1053 * @param string $url
1055 * @param bool $addCookie
1060 public static function checkURL($url, $addCookie = FALSE) {
1061 // make a GET request to $url
1062 $ch = curl_init($url);
1064 curl_setopt($ch, CURLOPT_COOKIE
, http_build_query($_COOKIE));
1066 // it's quite alright to use a self-signed cert
1067 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, 0);
1069 // lets capture the return stuff rather than echo
1070 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
1072 // CRM-13227, CRM-14744: only return the SSL error status
1073 return (curl_exec($ch) !== FALSE);
1077 * Assert that we are running on a particular PHP version.
1080 * The major version of PHP that is required.
1081 * @param bool $abort
1082 * (optional) Whether to fatally abort if the version requirement is not
1083 * met. Defaults to TRUE.
1086 * Returns TRUE if the requirement is met, FALSE if the requirement is not
1087 * met and we're not aborting due to the failed requirement. If $abort is
1088 * TRUE and the requirement fails, this function does not return.
1090 * @throws CRM_Core_Exception
1092 public static function checkPHPVersion($ver = 5, $abort = TRUE) {
1093 $phpVersion = substr(PHP_VERSION
, 0, 1);
1094 if ($phpVersion >= $ver) {
1099 throw new CRM_Core_Exception(ts('This feature requires PHP Version %1 or greater',
1109 * @param string $url
1111 * @return null|string
1113 public static function urlEncode($url) {
1114 CRM_Core_Error
::deprecatedFunctionWarning('urlEncode');
1115 $items = parse_url($url);
1116 if ($items === FALSE) {
1120 if (empty($items['query'])) {
1124 $items['query'] = urlencode($items['query']);
1126 $url = $items['scheme'] . '://';
1127 if (!empty($items['user'])) {
1128 $url .= "{$items['user']}:{$items['pass']}@";
1131 $url .= $items['host'];
1132 if (!empty($items['port'])) {
1133 $url .= ":{$items['port']}";
1136 $url .= "{$items['path']}?{$items['query']}";
1137 if (!empty($items['fragment'])) {
1138 $url .= "#{$items['fragment']}";
1145 * Return the running civicrm version.
1150 * @throws CRM_Core_Exception
1152 public static function version() {
1156 $verFile = implode(DIRECTORY_SEPARATOR
,
1157 [dirname(__FILE__
), '..', '..', 'xml', 'version.xml']
1159 if (file_exists($verFile)) {
1160 $str = file_get_contents($verFile);
1161 $xmlObj = simplexml_load_string($str);
1162 $version = (string) $xmlObj->version_no
;
1166 if (!CRM_Utils_System
::isVersionFormatValid($version)) {
1167 throw new CRM_Core_Exception('Unknown codebase version.');
1175 * Gives the first two parts of the version string E.g. 6.1.
1179 public static function majorVersion() {
1180 list($a, $b) = explode('.', self
::version());
1185 * Determines whether a string is a valid CiviCRM version string.
1187 * @param string $version
1188 * Version string to be checked.
1192 public static function isVersionFormatValid($version) {
1193 return preg_match("/^(\d{1,2}\.){2,3}(\d{1,2}|(alpha|beta)\d{1,2})(\.upgrade)?$/", $version);
1197 * Wraps or emulates PHP's getallheaders() function.
1199 public static function getAllHeaders() {
1200 if (function_exists('getallheaders')) {
1201 return getallheaders();
1204 // emulate get all headers
1205 // http://www.php.net/manual/en/function.getallheaders.php#66335
1207 foreach ($_SERVER as $name => $value) {
1208 if (substr($name, 0, 5) == 'HTTP_') {
1209 $headers[str_replace(' ',
1211 ucwords(strtolower(str_replace('_',
1223 * Get request headers.
1225 * @return array|false
1227 public static function getRequestHeaders() {
1228 if (function_exists('apache_request_headers')) {
1229 return apache_request_headers();
1237 * Determine whether this is an SSL request.
1239 * Note that we inline this function in install/civicrm.php, so if you change
1240 * this function, please go and change the code in the install script as well.
1242 public static function isSSL() {
1243 return !empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off';
1249 * @param bool|FALSE $abort
1251 * @throws \CRM_Core_Exception
1253 public static function redirectToSSL($abort = FALSE) {
1254 $config = CRM_Core_Config
::singleton();
1255 $req_headers = self
::getRequestHeaders();
1256 // FIXME: Shouldn't the X-Forwarded-Proto check be part of CRM_Utils_System::isSSL()?
1257 if (Civi
::settings()->get('enableSSL') &&
1259 strtolower(CRM_Utils_Array
::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1261 // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1262 $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1263 // @see https://lab.civicrm.org/dev/core/issues/425 if you're seeing this message.
1264 Civi
::log()->warning('CiviCRM thinks site is not SSL, redirecting to {url}', ['url' => $url]);
1265 if (!self
::checkURL($url, TRUE)) {
1267 throw new CRM_Core_Exception('HTTPS is not set up on this machine');
1270 CRM_Core_Session
::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1271 // admin should be the only one following this
1272 // since we dont want the user stuck in a bad place
1276 CRM_Utils_System
::redirect($url);
1281 * Get logged in user's IP address.
1283 * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1284 * the Drupal function as this also handles reverse proxies (based on proper
1285 * configuration in settings.php)
1287 * @param bool $strictIPV4
1288 * (optional) Whether to return only IPv4 addresses.
1291 * IP address of logged in user.
1293 public static function ipAddress($strictIPV4 = TRUE) {
1294 $address = $_SERVER['REMOTE_ADDR'] ??
NULL;
1296 $config = CRM_Core_Config
::singleton();
1297 if ($config->userSystem
->is_drupal
&& function_exists('ip_address')) {
1298 // drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1299 // that reach this point without bootstrapping hence the check that the fn exists
1300 $address = ip_address();
1304 if ($address == '::1') {
1305 $address = '127.0.0.1';
1308 // when we need to have strictly IPV4 ip address
1309 // convert ipV6 to ipV4
1311 // this converts 'IPV4 mapped IPV6 address' to IPV4
1312 if (filter_var($address, FILTER_VALIDATE_IP
, FILTER_FLAG_IPV6
) && strstr($address, '::ffff:')) {
1313 $address = ltrim($address, '::ffff:');
1321 * Get the referring / previous page URL.
1324 * The previous page URL
1326 public static function refererPath() {
1327 return $_SERVER['HTTP_REFERER'] ??
NULL;
1331 * Get the documentation base URL.
1334 * Base URL of the CRM documentation.
1336 public static function getDocBaseURL() {
1337 // FIXME: move this to configuration at some stage
1338 return 'https://docs.civicrm.org/';
1342 * Returns wiki (alternate) documentation URL base.
1347 public static function getWikiBaseURL() {
1348 // FIXME: move this to configuration at some stage
1349 return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1353 * Returns URL or link to documentation page, based on provided parameters.
1355 * For use in PHP code.
1356 * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1359 * @param string $page
1360 * Title of documentation wiki page.
1361 * @param bool $URLonly
1362 * (optional) Whether to return URL only or full HTML link (default).
1363 * @param string $text
1364 * (optional) Text of HTML link (no effect if $URLonly = false).
1365 * @param string $title
1366 * (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1367 * @param string $style
1368 * (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1370 * @param null $resource
1373 * URL or link to documentation page, based on provided parameters.
1375 public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1376 // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1377 // return just the URL, no matter what other parameters are defined
1378 if (!function_exists('ts')) {
1379 if ($resource == 'wiki') {
1380 $docBaseURL = self
::getWikiBaseURL();
1383 $docBaseURL = self
::getDocBaseURL();
1384 $page = self
::formatDocUrl($page);
1386 return $docBaseURL . str_replace(' ', '+', $page);
1391 'URLonly' => $URLonly,
1395 'resource' => $resource,
1397 return self
::docURL($params);
1402 * Returns URL or link to documentation page, based on provided parameters.
1404 * For use in templates code.
1406 * @param array $params
1407 * An array of parameters (see CRM_Utils_System::docURL2 method for names)
1409 * @return null|string
1410 * URL or link to documentation page, based on provided parameters.
1412 public static function docURL($params) {
1414 if (!isset($params['page'])) {
1418 if (CRM_Utils_Array
::value('resource', $params) == 'wiki') {
1419 $docBaseURL = self
::getWikiBaseURL();
1422 $docBaseURL = self
::getDocBaseURL();
1423 $params['page'] = self
::formatDocUrl($params['page']);
1426 if (!isset($params['title']) or $params['title'] === NULL) {
1427 $params['title'] = ts('Opens documentation in a new window.');
1430 if (!isset($params['text']) or $params['text'] === NULL) {
1431 $params['text'] = ts('(Learn more...)');
1434 if (!isset($params['style']) ||
$params['style'] === NULL) {
1438 $style = "style=\"{$params['style']}\"";
1441 $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1443 if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1447 return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1452 * Add language and version parameters to the doc url.
1454 * Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.
1459 public static function formatDocUrl($url) {
1460 return preg_replace('#^(installation|user|sysadmin|dev)/#', '\1/en/latest/', $url);
1464 * Exit with provided exit code.
1466 * @param int $status
1467 * (optional) Code with which to exit.
1469 * @param array $testParameters
1471 public static function civiExit($status = 0, $testParameters = []) {
1473 if (CIVICRM_UF
=== 'UnitTests') {
1474 throw new CRM_Core_Exception_PrematureExitException('civiExit called', $testParameters);
1477 http_response_code(500);
1479 // move things to CiviCRM cache as needed
1480 CRM_Core_Session
::storeSessionObjects();
1482 if (Civi\Core\Container
::isContainerBooted()) {
1483 Civi
::dispatcher()->dispatch('civi.core.exit');
1486 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
1487 if (is_callable([$userSystem, 'onCiviExit'])) {
1488 $userSystem->onCiviExit();
1494 * Reset the various system caches and some important static variables.
1496 public static function flushCache() {
1497 // flush out all cache entries so we can reload new data
1498 // a bit aggressive, but livable for now
1499 CRM_Utils_Cache
::singleton()->flush();
1501 // Traditionally, systems running on memory-backed caches were quite
1502 // zealous about destroying *all* memory-backed caches during a flush().
1503 // These flushes simulate that legacy behavior. However, they should probably
1504 // be removed at some point.
1505 $localDrivers = ['CRM_Utils_Cache_ArrayCache', 'CRM_Utils_Cache_NoCache'];
1506 if (Civi\Core\Container
::isContainerBooted()
1507 && !in_array(get_class(CRM_Utils_Cache
::singleton()), $localDrivers)) {
1508 Civi
::cache('long')->flush();
1509 Civi
::cache('settings')->flush();
1510 Civi
::cache('js_strings')->flush();
1511 Civi
::cache('community_messages')->flush();
1512 Civi
::cache('groups')->flush();
1513 Civi
::cache('navigation')->flush();
1514 Civi
::cache('customData')->flush();
1515 Civi
::cache('contactTypes')->clear();
1516 Civi
::cache('metadata')->clear();
1517 CRM_Extension_System
::singleton()->getCache()->flush();
1518 CRM_Cxn_CiviCxnHttp
::singleton()->getCache()->flush();
1521 // also reset the various static memory caches
1523 // reset the memory or array cache
1524 Civi
::cache('fields')->flush();
1527 CRM_ACL_BAO_Cache
::resetCache();
1529 // clear asset builder folder
1530 \Civi
::service('asset_builder')->clear(FALSE);
1532 // reset various static arrays used here
1533 CRM_Contact_BAO_Contact
::$_importableFields = CRM_Contact_BAO_Contact
::$_exportableFields
1534 = CRM_Contribute_BAO_Contribution
::$_importableFields
1535 = CRM_Contribute_BAO_Contribution
::$_exportableFields
1536 = CRM_Pledge_BAO_Pledge
::$_exportableFields
1537 = CRM_Core_BAO_CustomField
::$_importFields
1538 = CRM_Core_DAO
::$_dbColumnValueCache = NULL;
1540 CRM_Core_OptionGroup
::flushAll();
1541 CRM_Utils_PseudoConstant
::flushAll();
1545 * Load CMS bootstrap.
1547 * @param array $params
1548 * Array with uid name and pass
1549 * @param bool $loadUser
1550 * Boolean load user or not.
1551 * @param bool $throwError
1552 * @param string $realPath
1554 public static function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1555 if (!is_array($params)) {
1558 $config = CRM_Core_Config
::singleton();
1559 $result = $config->userSystem
->loadBootStrap($params, $loadUser, $throwError, $realPath);
1560 if (is_callable([$config->userSystem
, 'setMySQLTimeZone'])) {
1561 $config->userSystem
->setMySQLTimeZone();
1569 * @return mixed|string
1571 public static function baseCMSURL() {
1572 static $_baseURL = NULL;
1574 $config = CRM_Core_Config
::singleton();
1575 $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL
;
1577 if ($config->userFramework
== 'Joomla') {
1579 // we need to remove the administrator/ from the end
1580 $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1584 global $civicrm_root;
1585 if (strpos($civicrm_root,
1586 DIRECTORY_SEPARATOR
. 'sites' .
1587 DIRECTORY_SEPARATOR
. 'all' .
1588 DIRECTORY_SEPARATOR
. 'modules'
1591 $startPos = strpos($civicrm_root,
1592 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
1594 $endPos = strpos($civicrm_root,
1595 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
1597 if ($startPos && $endPos) {
1598 // if component is in sites/SITENAME/modules
1599 $siteName = substr($civicrm_root,
1601 $endPos - $startPos - 7
1604 $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1613 * Given a URL, return a relative URL if possible.
1615 * @param string $url
1619 public static function relativeURL($url) {
1620 CRM_Core_Error
::deprecatedFunctionWarning('url');
1621 // check if url is relative, if so return immediately
1622 if (substr($url, 0, 4) != 'http') {
1626 // make everything relative from the baseFilePath
1627 $baseURL = self
::baseCMSURL();
1629 // check if baseURL is a substr of $url, if so
1630 // return rest of string
1631 if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1632 return substr($url, strlen($baseURL));
1635 // return the original value
1640 * Produce an absolute URL from a possibly-relative URL.
1642 * @param string $url
1643 * @param bool $removeLanguagePart
1647 public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1648 CRM_Core_Error
::deprecatedFunctionWarning('url');
1649 // check if url is already absolute, if so return immediately
1650 if (substr($url, 0, 4) == 'http') {
1654 // make everything absolute from the baseFileURL
1655 $baseURL = self
::baseCMSURL();
1657 //CRM-7622: drop the language from the URL if requested (and it’s there)
1658 $config = CRM_Core_Config
::singleton();
1659 if ($removeLanguagePart) {
1660 $baseURL = self
::languageNegotiationURL($baseURL, FALSE, TRUE);
1663 return $baseURL . $url;
1667 * Clean url, replaces first '&' with '?'.
1669 * @param string $url
1674 public static function cleanUrl($url) {
1679 if ($pos = strpos($url, '&')) {
1680 $url = substr_replace($url, '?', $pos, 1);
1687 * Format the url as per language Negotiation.
1689 * @param string $url
1691 * @param bool $addLanguagePart
1692 * @param bool $removeLanguagePart
1697 public static function languageNegotiationURL(
1699 $addLanguagePart = TRUE,
1700 $removeLanguagePart = FALSE
1702 return CRM_Core_Config
::singleton()->userSystem
->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1706 * Append the contents of an 'extra' smarty template file.
1708 * It must be present in the custom template directory. This does not work if there are
1709 * multiple custom template directories
1711 * @param string $fileName
1712 * The name of the tpl file that we are processing.
1713 * @param string $content
1714 * The current content string. May be modified by this function.
1715 * @param string $overideFileName
1716 * (optional) Sent by contribution/event reg/profile pages which uses a id
1717 * specific extra file name if present.
1719 public static function appendTPLFile(
1722 $overideFileName = NULL
1724 $template = CRM_Core_Smarty
::singleton();
1725 if ($overideFileName) {
1726 $additionalTPLFile = $overideFileName;
1729 $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1732 if ($template->template_exists($additionalTPLFile)) {
1733 $content .= $template->fetch($additionalTPLFile);
1738 * Get a list of all files that are found within the directories.
1740 * Files must be the result of appending the provided relative path to
1741 * each component of the PHP include path.
1743 * @author Ken Zalewski
1745 * @param string $relpath
1746 * A relative path, typically pointing to a directory with multiple class
1750 * An array of files that exist in one or more of the directories that are
1751 * referenced by the relative path when appended to each element of the PHP
1754 public static function listIncludeFiles($relpath) {
1756 $inc_dirs = explode(PATH_SEPARATOR
, get_include_path());
1757 foreach ($inc_dirs as $inc_dir) {
1758 $target_dir = $inc_dir . DIRECTORY_SEPARATOR
. $relpath;
1759 if (is_dir($target_dir)) {
1760 $cur_list = scandir($target_dir);
1761 foreach ($cur_list as $fname) {
1762 if ($fname != '.' && $fname != '..') {
1763 $file_list[$fname] = $fname;
1772 * Get a list of all "plugins".
1774 * (PHP classes that implement a piece of
1775 * functionality using a well-defined interface) that are found in a
1776 * particular CiviCRM directory (both custom and core are searched).
1778 * @author Ken Zalewski
1780 * @param string $relpath
1781 * A relative path referencing a directory that contains one or more
1783 * @param string $fext
1784 * (optional) Only files with this extension will be considered to be
1786 * @param array $skipList
1787 * (optional) List of files to skip.
1790 * List of plugins, where the plugin name is both the key and the value of
1793 public static function getPluginList($relpath, $fext = '.php', $skipList = []) {
1794 $fext_len = strlen($fext);
1796 $inc_files = CRM_Utils_System
::listIncludeFiles($relpath);
1797 foreach ($inc_files as $inc_file) {
1798 if (substr($inc_file, 0 - $fext_len) == $fext) {
1799 $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1800 if (!in_array($plugin_name, $skipList)) {
1801 $plugins[$plugin_name] = $plugin_name;
1809 * Execute scheduled jobs.
1811 public static function executeScheduledJobs() {
1812 $facility = new CRM_Core_JobManager();
1813 $facility->execute(FALSE);
1815 $redirectUrl = self
::url('civicrm/admin/job', 'reset=1');
1817 CRM_Core_Session
::setStatus(
1818 ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1819 ts('Complete'), 'success');
1821 CRM_Utils_System
::redirect($redirectUrl);
1825 * Evaluate any tokens in a URL.
1827 * @param string|FALSE $url
1829 * @return string|FALSE
1831 public static function evalUrl($url) {
1832 if (!$url ||
strpos($url, '{') === FALSE) {
1836 $config = CRM_Core_Config
::singleton();
1837 $tsLocale = CRM_Core_I18n
::getLocale();
1839 '{ver}' => CRM_Utils_System
::version(),
1840 '{uf}' => $config->userFramework
,
1841 '{php}' => phpversion(),
1842 '{sid}' => self
::getSiteID(),
1843 '{baseUrl}' => $config->userFrameworkBaseURL
,
1844 '{lang}' => $tsLocale,
1845 '{co}' => $config->defaultContactCountry
,
1847 return strtr($url, array_map('urlencode', $vars));
1852 * Returns the unique identifier for this site, as used by community messages.
1854 * SiteID will be generated if it is not already stored in the settings table.
1858 public static function getSiteID() {
1859 $sid = Civi
::settings()->get('site_id');
1861 $config = CRM_Core_Config
::singleton();
1862 $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '') . '_' . $config->userFrameworkBaseURL
);
1863 civicrm_api3('Setting', 'create', ['domain_id' => 'all', 'site_id' => $sid]);
1870 * Determine whether this system is deployed using version control.
1872 * Normally sites would tune their php error settings to prevent deprecation
1873 * notices appearing on a live site. However, on some systems the user
1874 * does not have control over this setting. Sites with version-controlled
1875 * deployments are unlikely to be in a situation where they cannot alter their
1876 * php error level reporting so we can trust that the are able to set them
1877 * to suppress deprecation / php error level warnings if appropriate but
1878 * in order to phase in deprecation warnings we originally chose not to
1879 * show them on sites who might not be able to set their error_level in
1880 * a way that is appropriate to their site.
1884 public static function isDevelopment() {
1885 CRM_Core_Error
::deprecatedWarning('isDevelopment() is deprecated. Set your php error_reporting or MySQL settings appropriately instead.');
1886 static $cache = NULL;
1887 if ($cache === NULL) {
1888 global $civicrm_root;
1889 $cache = file_exists("{$civicrm_root}/.svn") ||
file_exists("{$civicrm_root}/.git");
1895 * Is in upgrade mode.
1899 * @see CRM_Core_Config::isUpgradeMode()
1901 public static function isInUpgradeMode() {
1902 return CRM_Core_Config
::isUpgradeMode();
1906 * Determine the standard URL for view/update/delete of a given entity.
1908 * @param array $crudLinkSpec
1910 * - action: sting|int, e.g. 'update' or CRM_Core_Action::UPDATE or 'view' or CRM_Core_Action::VIEW [default: 'view']
1911 * - entity|entity_table: string, eg "Contact" or "civicrm_contact"
1912 * - id|entity_id: int
1914 * @param bool $absolute whether the generated link should have an absolute (external) URL beginning with http
1916 * @return array|NULL
1917 * NULL if unavailable, or an array. array has keys:
1921 public static function createDefaultCrudLink($crudLinkSpec, $absolute = FALSE) {
1922 $action = $crudLinkSpec['action'] ??
'view';
1923 if (is_numeric($action)) {
1924 $action = CRM_Core_Action
::description($action);
1927 $action = strtolower($action);
1930 $daoClass = isset($crudLinkSpec['entity']) ? CRM_Core_DAO_AllCoreTables
::getFullName($crudLinkSpec['entity']) : CRM_Core_DAO_AllCoreTables
::getClassForTable($crudLinkSpec['entity_table']);
1931 $paths = $daoClass ?
$daoClass::getEntityPaths() : [];
1932 $path = $paths[$action] ??
NULL;
1937 if (empty($crudLinkSpec['id']) && !empty($crudLinkSpec['entity_id'])) {
1938 $crudLinkSpec['id'] = $crudLinkSpec['entity_id'];
1940 foreach ($crudLinkSpec as $key => $value) {
1941 $path = str_replace('[' . $key . ']', $value, $path);
1946 $title = ts('New %1', [1 => $daoClass::getEntityTitle()]);
1950 $title = ts('View %1', [1 => $daoClass::getEntityTitle()]);
1954 $title = ts('Edit %1', [1 => $daoClass::getEntityTitle()]);
1958 $title = ts('Delete %1', [1 => $daoClass::getEntityTitle()]);
1962 $title = ts(ucfirst($action)) . ' ' . $daoClass::getEntityTitle();
1967 'url' => self
::url($path, NULL, $absolute, NULL, FALSE),
1972 * Return an HTTP Response with appropriate content and status code set.
1973 * @param \Psr\Http\Message\ResponseInterface $response
1975 public static function sendResponse(\Psr\Http\Message\ResponseInterface
$response) {
1976 $config = CRM_Core_Config
::singleton()->userSystem
->sendResponse($response);
1980 * Perform any necessary actions prior to redirecting via POST.
1982 public static function prePostRedirect() {
1983 CRM_Core_Config
::singleton()->userSystem
->prePostRedirect();