3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
35 * System wide utilities.
37 * Provides a collection of Civi utilities + access to the CMS-dependant utilities
39 * FIXME: This is a massive and random collection that could be split into smaller services
41 * @method static mixed permissionDenied() Show access denied screen.
42 * @method static mixed logout() Log out the current user.
43 * @method static mixed updateCategories() Clear CMS caches related to the user registration/profile forms.
44 * @method static appendBreadCrumb(string $breadCrumbs) Append an additional breadcrumb tag to the existing breadcrumbs.
45 * @method static resetBreadCrumb() Reset an additional breadcrumb tag to the existing breadcrumb.
46 * @method static addHTMLHead(string $bc) Append a string to the head of the HTML file.
47 * @method static string postURL(int $action) Determine the post URL for a form.
48 * @method static string|null getUFLocale() Get the locale of the CMS.
49 * @method static bool setUFLocale(string $civicrm_language) Set the locale of the CMS.
50 * @method static bool isUserLoggedIn() Check if user is logged in.
51 * @method static int getLoggedInUfID() Get current logged in user id.
52 * @method static setHttpHeader(string $name, string $value) Set http header.
53 * @method static array synchronizeUsers() Create CRM contacts for all existing CMS users.
55 class CRM_Utils_System
{
57 static $_callbacks = NULL;
66 * Access methods in the appropriate CMS class
72 public static function __callStatic($name, $arguments) {
73 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
74 return call_user_func_array(array($userSystem, $name), $arguments);
78 * Compose a new URL string from the current URL string.
80 * Used by all the framework components, specifically,
83 * @param string $urlVar
84 * The url variable being considered (i.e. crmPageID, crmSortID etc).
85 * @param bool $includeReset
86 * (optional) Whether to include the reset GET string (if present).
87 * @param bool $includeForce
88 * (optional) Whether to include the force GET string (if present).
90 * (optional) The path to use for the new url.
91 * @param bool|string $absolute
92 * (optional) Whether to return an absolute URL.
97 public static function makeURL($urlVar, $includeReset = FALSE, $includeForce = TRUE, $path = NULL, $absolute = FALSE) {
99 $config = CRM_Core_Config
::singleton();
100 $path = CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET);
109 CRM_Utils_System
::getLinksUrl($urlVar, $includeReset, $includeForce),
115 * Get the query string and clean it up.
117 * Strips some variables that should not be propagated, specifically variables
118 * like 'reset'. Also strips any side-affect actions (e.g. export).
120 * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
122 * @param string $urlVar
123 * The URL variable being considered (e.g. crmPageID, crmSortID etc).
124 * @param bool $includeReset
125 * (optional) By default this is FALSE, meaning that the reset parameter
126 * is skipped. Set to TRUE to leave the reset parameter as-is.
127 * @param bool $includeForce
129 * @param bool $skipUFVar
134 public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
135 // Sort out query string to prevent messy urls
136 $querystring = array();
140 if (!empty($_SERVER['QUERY_STRING'])) {
141 $qs = explode('&', str_replace('&', '&', $_SERVER['QUERY_STRING']));
142 for ($i = 0, $cnt = count($qs); $i < $cnt; $i++
) {
143 // check first if exist a pair
144 if (strstr($qs[$i], '=') !== FALSE) {
145 list($name, $value) = explode('=', $qs[$i]);
146 if ($name != $urlVar) {
147 $name = rawurldecode($name);
148 // check for arrays in parameters: site.php?foo[]=1&foo[]=2&foo[]=3
149 if ((strpos($name, '[') !== FALSE) &&
150 (strpos($name, ']') !== FALSE)
170 // Ok this is a big assumption but usually works
171 // If we are in snippet mode, retain the 'section' param, if not, get rid
173 if (!empty($qs['snippet'])) {
174 unset($qs['snippet']);
177 unset($qs['section']);
181 $config = CRM_Core_Config
::singleton();
182 unset($qs[$config->userFrameworkURLVar
]);
185 foreach ($qs as $name => $value) {
186 if ($name != 'reset' ||
$includeReset) {
187 $querystring[] = $name . '=' . $value;
191 $querystring = array_merge($querystring, array_unique($arrays));
193 $url = implode('&', $querystring);
195 $url .= (!empty($querystring) ?
'&' : '') . $urlVar . '=';
202 * If we are using a theming system, invoke theme, else just print the content.
204 * @param string $content
205 * The content that will be themed.
207 * (optional) Are we displaying to the screen or bypassing theming?
208 * @param bool $maintenance
209 * (optional) For maintenance mode.
213 public static function theme(
218 $config = &CRM_Core_Config
::singleton();
219 return $config->userSystem
->theme($content, $print, $maintenance);
223 * Generate a query string if input is an array.
225 * @param array|string $query
229 public static function makeQueryString($query) {
230 if (is_array($query)) {
232 foreach ($query as $key => $value) {
233 $buf .= ($buf ?
'&' : '') . urlencode($key) . '=' . urlencode($value);
241 * Generate an internal CiviCRM URL.
243 * @param string $path
244 * The path being linked to, such as "civicrm/add".
245 * @param array|string $query
246 * A query string to append to the link, or an array of key-value pairs.
247 * @param bool $absolute
248 * Whether to force the output to be an absolute link (beginning with a
249 * URI-scheme such as 'http:'). Useful for links that will be displayed
250 * outside the site, such as in an RSS feed.
251 * @param string $fragment
252 * A fragment identifier (named anchor) to append to the link.
253 * @param bool $htmlize
254 * Whether to encode special html characters such as &.
255 * @param bool $frontend
256 * This link should be to the CMS front end (applies to WP & Joomla).
257 * @param bool $forceBackend
258 * This link should be to the CMS back end (applies to WP & Joomla).
261 * An HTML string containing a link to the given path.
263 public static function url(
270 $forceBackend = FALSE
272 $query = self
::makeQueryString($query);
274 // Legacy handling for when the system passes around html escaped strings
275 if (strstr($query, '&')) {
276 $query = html_entity_decode($query);
279 // Extract fragment from path or query if munged together
280 if ($query && strstr($query, '#')) {
281 list($path, $fragment) = explode('#', $query);
283 if ($path && strstr($path, '#')) {
284 list($path, $fragment) = explode('#', $path);
287 // Extract query from path if munged together
288 if ($path && strstr($path, '?')) {
289 list($path, $extraQuery) = explode('?', $path);
290 $query = $extraQuery . ($query ?
"&$query" : '');
293 $config = CRM_Core_Config
::singleton();
294 $url = $config->userSystem
->url($path, $query, $absolute, $fragment, $frontend, $forceBackend);
297 $url = htmlentities($url);
306 * @param string $text
307 * @param string $path
308 * @param string|array $query
309 * @param bool $absolute
310 * @param string $fragment
311 * @param bool $htmlize
312 * @param bool $frontend
313 * @param bool $forceBackend
317 public static function href(
318 $text, $path = NULL, $query = NULL, $absolute = TRUE,
319 $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
321 $url = self
::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
322 return "<a href=\"$url\">$text</a>";
326 * What menu path are we currently on. Called for the primary tpl.
329 * the current menu path
331 public static function currentPath() {
332 $config = CRM_Core_Config
::singleton();
333 return trim(CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET), '/');
337 * Called from a template to compose a url.
339 * @param array $params
340 * List of parameters.
345 public static function crmURL($params) {
346 $p = CRM_Utils_Array
::value('p', $params);
348 $p = self
::currentPath();
353 CRM_Utils_Array
::value('q', $params),
354 CRM_Utils_Array
::value('a', $params, FALSE),
355 CRM_Utils_Array
::value('f', $params),
356 CRM_Utils_Array
::value('h', $params, TRUE),
357 CRM_Utils_Array
::value('fe', $params, FALSE),
358 CRM_Utils_Array
::value('fb', $params, FALSE)
363 * Sets the title of the page.
365 * @param string $title
366 * Document title - plain text only
367 * @param string $pageTitle
368 * Page title (if different) - may include html
370 public static function setTitle($title, $pageTitle = NULL) {
371 self
::$title = $title;
372 $config = CRM_Core_Config
::singleton();
373 return $config->userSystem
->setTitle($title, $pageTitle);
377 * Figures and sets the userContext.
379 * Uses the referrer if valid else uses the default.
381 * @param array $names
382 * Referrer should match any str in this array.
383 * @param string $default
384 * (optional) The default userContext if no match found.
386 public static function setUserContext($names, $default = NULL) {
389 $session = CRM_Core_Session
::singleton();
390 $referer = CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
392 if ($referer && !empty($names)) {
393 foreach ($names as $name) {
394 if (strstr($referer, $name)) {
402 $session->pushUserContext($url);
407 * Gets a class name for an object.
409 * @param object $object
410 * Object whose class name is needed.
413 * The class name of the object.
415 public static function getClassName($object) {
416 return get_class($object);
420 * Redirect to another URL.
423 * The URL to provide to the browser via the Location header.
425 public static function redirect($url = NULL) {
427 $url = self
::url('civicrm/dashboard', 'reset=1');
429 // replace the & characters with &
430 // this is kinda hackish but not sure how to do it right
431 $url = str_replace('&', '&', $url);
433 // If we are in a json context, respond appropriately
434 if (CRM_Utils_Array
::value('snippet', $_GET) === 'json') {
435 CRM_Core_Page_AJAX
::returnJsonResponse(array(
436 'status' => 'redirect',
437 'userContext' => $url,
441 self
::setHttpHeader('Location', $url);
446 * Redirect to another URL using JavaScript.
448 * Use an html based file with javascript embedded to redirect to another url
449 * This prevent the too many redirect errors emitted by various browsers
452 * (optional) The destination URL.
453 * @param string $title
454 * (optional) The page title to use for the redirect page.
455 * @param string $message
456 * (optional) The message to provide in the body of the redirect page.
458 public static function jsRedirect(
464 $url = self
::url('civicrm/dashboard', 'reset=1');
468 $title = ts('CiviCRM task in progress');
472 $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
475 // replace the & characters with &
476 // this is kinda hackish but not sure how to do it right
477 $url = str_replace('&', '&', $url);
479 $template = CRM_Core_Smarty
::singleton();
480 $template->assign('redirectURL', $url);
481 $template->assign('title', $title);
482 $template->assign('message', $message);
484 $html = $template->fetch('CRM/common/redirectJS.tpl');
492 * Get the base URL of the system.
496 public static function baseURL() {
497 $config = CRM_Core_Config
::singleton();
498 return $config->userFrameworkBaseURL
;
502 * Authenticate or abort.
504 * @param string $message
509 public static function authenticateAbort($message, $abort) {
523 * (optional) Whether to exit; defaults to true.
527 public static function authenticateKey($abort = TRUE) {
528 // also make sure the key is sent and is valid
529 $key = trim(CRM_Utils_Array
::value('key', $_REQUEST));
531 $docAdd = "More info at:" . CRM_Utils_System
::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
534 return self
::authenticateAbort(
535 "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
540 $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: NULL;
542 if (!$siteKey ||
empty($siteKey)) {
543 return self
::authenticateAbort(
544 "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
549 if (strlen($siteKey) < 8) {
550 return self
::authenticateAbort(
551 "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
556 if ($key !== $siteKey) {
557 return self
::authenticateAbort(
558 "ERROR: Invalid key value sent. " . $docAdd . "\n",
567 * Authenticate script.
570 * @param string $name
571 * @param string $pass
572 * @param bool $storeInSession
573 * @param bool $loadCMSBootstrap
574 * @param bool $requireKey
578 public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
579 // auth to make sure the user has a login/password to do a shell operation
580 // later on we'll link this to acl's
582 $name = trim(CRM_Utils_Array
::value('name', $_REQUEST));
583 $pass = trim(CRM_Utils_Array
::value('pass', $_REQUEST));
586 // its ok to have an empty password
588 return self
::authenticateAbort(
589 "ERROR: You need to send a valid user name and password to execute this file\n",
594 if ($requireKey && !self
::authenticateKey($abort)) {
598 $result = CRM_Utils_System
::authenticate($name, $pass, $loadCMSBootstrap);
600 return self
::authenticateAbort(
601 "ERROR: Invalid username and/or password\n",
605 elseif ($storeInSession) {
606 // lets store contact id and user id in session
607 list($userID, $ufID, $randomNumber) = $result;
608 if ($userID && $ufID) {
609 $config = CRM_Core_Config
::singleton();
610 $config->userSystem
->setUserSession(array($userID, $ufID));
613 return self
::authenticateAbort(
614 "ERROR: Unexpected error, could not match userID and contactID",
624 * Authenticate the user against the uf db.
626 * In case of successful authentication, returns an array consisting of
627 * (contactID, ufID, unique string). Returns FALSE if authentication is
630 * @param string $name
632 * @param string $password
634 * @param bool $loadCMSBootstrap
635 * @param string $realPath
637 * @return false|array
639 public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
640 $config = CRM_Core_Config
::singleton();
642 /* Before we do any loading, let's start the session and write to it.
643 * We typically call authenticate only when we need to bootstrap the CMS
644 * directly via Civi and hence bypass the normal CMS auth and bootstrap
645 * process typically done in CLI and cron scripts. See: CRM-12648
647 * Q: Can we move this to the userSystem class so that it can be tuned
648 * per-CMS? For example, when dealing with UnitTests UF, there's no
651 $session = CRM_Core_Session
::singleton();
652 $session->set('civicrmInitSession', TRUE);
654 if ($config->userFrameworkDSN
) {
655 $dbDrupal = DB
::connect($config->userFrameworkDSN
);
657 return $config->userSystem
->authenticate($name, $password, $loadCMSBootstrap, $realPath);
661 * Set a message in the UF to display to a user.
663 * @param string $message
664 * The message to set.
666 public static function setUFMessage($message) {
667 $config = CRM_Core_Config
::singleton();
668 return $config->userSystem
->setMessage($message);
673 * Determine whether a value is null-ish.
675 * @param mixed $value
676 * The value to check for null.
680 public static function isNull($value) {
681 // FIXME: remove $value = 'null' string test when we upgrade our DAO code to handle passing null in a better way.
682 if (!isset($value) ||
$value === NULL ||
$value === '' ||
$value === 'null') {
685 if (is_array($value)) {
686 // @todo Reuse of the $value variable = asking for trouble.
687 foreach ($value as $key => $value) {
688 if (!self
::isNull($value)) {
698 * Obscure all but the last few digits of a credit card number.
700 * @param string $number
701 * The credit card number to obscure.
703 * (optional) The number of digits to preserve unmodified.
706 * The obscured credit card number.
708 public static function mungeCreditCard($number, $keep = 4) {
709 $number = trim($number);
710 if (empty($number)) {
713 $replace = str_repeat('*', strlen($number) - $keep);
714 return substr_replace($number, $replace, 0, -$keep);
718 * Determine which PHP modules are loaded.
722 private static function parsePHPModules() {
724 phpinfo(INFO_MODULES
);
725 $s = ob_get_contents();
728 $s = strip_tags($s, '<h2><th><td>');
729 $s = preg_replace('/<th[^>]*>([^<]+)<\/th>/', "<info>\\1</info>", $s);
730 $s = preg_replace('/<td[^>]*>([^<]+)<\/td>/', "<info>\\1</info>", $s);
731 $vTmp = preg_split('/(<h2>[^<]+<\/h2>)/', $s, -1, PREG_SPLIT_DELIM_CAPTURE
);
733 for ($i = 1; $i < count($vTmp); $i++
) {
734 if (preg_match('/<h2>([^<]+)<\/h2>/', $vTmp[$i], $vMat)) {
735 $vName = trim($vMat[1]);
736 $vTmp2 = explode("\n", $vTmp[$i +
1]);
737 foreach ($vTmp2 as $vOne) {
738 $vPat = '<info>([^<]+)<\/info>';
739 $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
740 $vPat2 = "/$vPat\s*$vPat/";
742 if (preg_match($vPat3, $vOne, $vMat)) {
743 $vModules[$vName][trim($vMat[1])] = array(trim($vMat[2]), trim($vMat[3]));
746 elseif (preg_match($vPat2, $vOne, $vMat)) {
747 $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
756 * Get a setting from a loaded PHP module.
758 * @param string $pModuleName
759 * @param string $pSetting
763 public static function getModuleSetting($pModuleName, $pSetting) {
764 $vModules = self
::parsePHPModules();
765 return $vModules[$pModuleName][$pSetting];
769 * Do something no-one bothered to document.
771 * @param string $title
774 * @return mixed|string
776 public static function memory($title = NULL) {
779 $pid = posix_getpid();
782 $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
783 $memory .= ", " . time();
785 CRM_Core_Error
::debug_var($title, $memory);
791 * Download something or other.
793 * @param string $name
794 * @param string $mimeType
795 * @param string $buffer
797 * @param bool $output
798 * @param string $disposition
800 public static function download(
801 $name, $mimeType, &$buffer,
804 $disposition = 'attachment'
806 $now = gmdate('D, d M Y H:i:s') . ' GMT';
808 self
::setHttpHeader('Content-Type', $mimeType);
809 self
::setHttpHeader('Expires', $now);
811 // lem9 & loic1: IE needs specific headers
812 $isIE = strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
814 $fileString = "filename=\"{$name}.{$ext}\"";
817 $fileString = "filename=\"{$name}\"";
820 self
::setHttpHeader("Content-Disposition", "inline; $fileString");
821 self
::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
822 self
::setHttpHeader('Pragma', 'public');
825 self
::setHttpHeader("Content-Disposition", "$disposition; $fileString");
826 self
::setHttpHeader('Pragma', 'no-cache');
836 * Gather and print (and possibly log) amount of used memory.
838 * @param string $title
840 * (optional) Whether to log the memory usage information.
842 public static function xMemory($title = NULL, $log = FALSE) {
843 $mem = (float ) xdebug_memory_usage() / (float ) (1024);
844 $mem = number_format($mem, 5) . ", " . time();
846 echo "<p>$title: $mem<p>";
848 CRM_Core_Error
::debug_var($title, $mem);
851 echo "<p>$title: $mem<p>";
857 * Take a URL (or partial URL) and make it better.
859 * Currently, URLs pass straight through unchanged unless they are "seriously
860 * malformed" (see http://us2.php.net/parse_url).
863 * The URL to operate on.
868 public static function fixURL($url) {
869 $components = parse_url($url);
875 // at some point we'll add code here to make sure the url is not
876 // something that will mess up, so we need to clean it up here
881 * Make sure a callback is valid in the current context.
883 * @param string $callback
884 * Name of the function to check.
888 public static function validCallback($callback) {
889 if (self
::$_callbacks === NULL) {
890 self
::$_callbacks = array();
893 if (!array_key_exists($callback, self
::$_callbacks)) {
894 if (strpos($callback, '::') !== FALSE) {
895 list($className, $methodName) = explode('::', $callback);
896 $fileName = str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
897 // ignore errors if any
898 @include_once
$fileName;
899 if (!class_exists($className)) {
900 self
::$_callbacks[$callback] = FALSE;
903 // instantiate the class
904 $object = new $className();
905 if (!method_exists($object, $methodName)) {
906 self
::$_callbacks[$callback] = FALSE;
909 self
::$_callbacks[$callback] = TRUE;
914 self
::$_callbacks[$callback] = function_exists($callback);
917 return self
::$_callbacks[$callback];
921 * Like PHP's built-in explode(), but always return an array of $limit items.
923 * This serves as a wrapper to the PHP explode() function. In the event that
924 * PHP's explode() returns an array with fewer than $limit elements, pad
925 * the end of the array with NULLs.
927 * @param string $separator
928 * @param string $string
933 public static function explode($separator, $string, $limit) {
934 $result = explode($separator, $string, $limit);
935 for ($i = count($result); $i < $limit; $i++
) {
946 * @param bool $addCookie
951 public static function checkURL($url, $addCookie = FALSE) {
952 // make a GET request to $url
953 $ch = curl_init($url);
955 curl_setopt($ch, CURLOPT_COOKIE
, http_build_query($_COOKIE));
957 // it's quite alright to use a self-signed cert
958 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, 0);
960 // lets capture the return stuff rather than echo
961 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
963 // CRM-13227, CRM-14744: only return the SSL error status
964 return (curl_exec($ch) !== FALSE);
968 * Assert that we are running on a particular PHP version.
971 * The major version of PHP that is required.
973 * (optional) Whether to fatally abort if the version requirement is not
974 * met. Defaults to TRUE.
977 * Returns TRUE if the requirement is met, FALSE if the requirement is not
978 * met and we're not aborting due to the failed requirement. If $abort is
979 * TRUE and the requirement fails, this function does not return.
981 public static function checkPHPVersion($ver = 5, $abort = TRUE) {
982 $phpVersion = substr(PHP_VERSION
, 0, 1);
983 if ($phpVersion >= $ver) {
988 CRM_Core_Error
::fatal(ts('This feature requires PHP Version %1 or greater',
998 * @param string $string
999 * @param bool $encode
1003 public static function formatWikiURL($string, $encode = FALSE) {
1004 $items = explode(' ', trim($string), 2);
1005 if (count($items) == 2) {
1013 $url = $encode ? self
::urlEncode($items[0]) : $items[0];
1014 return "<a href=\"$url\">$title</a>";
1020 * @param string $url
1022 * @return null|string
1024 public static function urlEncode($url) {
1025 $items = parse_url($url);
1026 if ($items === FALSE) {
1030 if (empty($items['query'])) {
1034 $items['query'] = urlencode($items['query']);
1036 $url = $items['scheme'] . '://';
1037 if (!empty($items['user'])) {
1038 $url .= "{$items['user']}:{$items['pass']}@";
1041 $url .= $items['host'];
1042 if (!empty($items['port'])) {
1043 $url .= ":{$items['port']}";
1046 $url .= "{$items['path']}?{$items['query']}";
1047 if (!empty($items['fragment'])) {
1048 $url .= "#{$items['fragment']}";
1055 * Return the running civicrm version.
1060 public static function version() {
1064 $verFile = implode(DIRECTORY_SEPARATOR
,
1065 array(dirname(__FILE__
), '..', '..', 'civicrm-version.php')
1067 if (file_exists($verFile)) {
1068 require_once $verFile;
1069 if (function_exists('civicrmVersion')) {
1070 $info = civicrmVersion();
1071 $version = $info['version'];
1075 // svn installs don't have version.txt by default. In that case version.xml should help -
1076 $verFile = implode(DIRECTORY_SEPARATOR
,
1077 array(dirname(__FILE__
), '..', '..', 'xml', 'version.xml')
1079 if (file_exists($verFile)) {
1080 $str = file_get_contents($verFile);
1081 $xmlObj = simplexml_load_string($str);
1082 $version = (string) $xmlObj->version_no
;
1087 if (!CRM_Utils_System
::isVersionFormatValid($version)) {
1088 CRM_Core_Error
::fatal('Unknown codebase version.');
1096 * Gives the first two parts of the version string E.g. 6.1.
1100 public static function majorVersion() {
1101 list($a, $b) = explode('.', self
::version());
1106 * Determines whether a string is a valid CiviCRM version string.
1108 * @param string $version
1109 * Version string to be checked.
1113 public static function isVersionFormatValid($version) {
1114 return preg_match("/^(\d{1,2}\.){2,3}(\d{1,2}|(alpha|beta)\d{1,2})(\.upgrade)?$/", $version);
1118 * Wraps or emulates PHP's getallheaders() function.
1120 public static function getAllHeaders() {
1121 if (function_exists('getallheaders')) {
1122 return getallheaders();
1125 // emulate get all headers
1126 // http://www.php.net/manual/en/function.getallheaders.php#66335
1128 foreach ($_SERVER as $name => $value) {
1129 if (substr($name, 0, 5) == 'HTTP_') {
1130 $headers[str_replace(' ',
1132 ucwords(strtolower(str_replace('_',
1144 * Get request headers.
1146 * @return array|false
1148 public static function getRequestHeaders() {
1149 if (function_exists('apache_request_headers')) {
1150 return apache_request_headers();
1158 * Determine whether this is an SSL request.
1160 * Note that we inline this function in install/civicrm.php, so if you change
1161 * this function, please go and change the code in the install script as well.
1163 public static function isSSL() {
1165 (isset($_SERVER['HTTPS']) &&
1166 !empty($_SERVER['HTTPS']) &&
1167 strtolower($_SERVER['HTTPS']) != 'off') ?
TRUE : FALSE;
1173 * @param bool|FALSE $abort
1175 * @throws \Exception
1177 public static function redirectToSSL($abort = FALSE) {
1178 $config = CRM_Core_Config
::singleton();
1179 $req_headers = self
::getRequestHeaders();
1180 // FIXME: Shouldn't the X-Forwarded-Proto check be part of CRM_Utils_System::isSSL()?
1181 if (Civi
::settings()->get('enableSSL') &&
1183 strtolower(CRM_Utils_Array
::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1185 // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1186 $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1187 if (!self
::checkURL($url, TRUE)) {
1189 CRM_Core_Error
::fatal('HTTPS is not set up on this machine');
1192 CRM_Core_Session
::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1193 // admin should be the only one following this
1194 // since we dont want the user stuck in a bad place
1198 CRM_Utils_System
::redirect($url);
1203 * Get logged in user's IP address.
1205 * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1206 * the Drupal function as this also handles reverse proxies (based on proper
1207 * configuration in settings.php)
1209 * @param bool $strictIPV4
1210 * (optional) Whether to return only IPv4 addresses.
1213 * IP address of logged in user.
1215 public static function ipAddress($strictIPV4 = TRUE) {
1216 $address = CRM_Utils_Array
::value('REMOTE_ADDR', $_SERVER);
1218 $config = CRM_Core_Config
::singleton();
1219 if ($config->userSystem
->is_drupal
&& function_exists('ip_address')) {
1220 // drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1221 // that reach this point without bootstrapping hence the check that the fn exists
1222 $address = ip_address();
1226 if ($address == '::1') {
1227 $address = '127.0.0.1';
1230 // when we need to have strictly IPV4 ip address
1231 // convert ipV6 to ipV4
1233 // this converts 'IPV4 mapped IPV6 address' to IPV4
1234 if (filter_var($address, FILTER_VALIDATE_IP
, FILTER_FLAG_IPV6
) && strstr($address, '::ffff:')) {
1235 $address = ltrim($address, '::ffff:');
1243 * Get the referring / previous page URL.
1246 * The previous page URL
1248 public static function refererPath() {
1249 return CRM_Utils_Array
::value('HTTP_REFERER', $_SERVER);
1253 * Get the documentation base URL.
1256 * Base URL of the CRM documentation.
1258 public static function getDocBaseURL() {
1259 // FIXME: move this to configuration at some stage
1260 return 'http://book.civicrm.org/';
1264 * Returns wiki (alternate) documentation URL base.
1269 public static function getWikiBaseURL() {
1270 // FIXME: move this to configuration at some stage
1271 return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1275 * Returns URL or link to documentation page, based on provided parameters.
1277 * For use in PHP code.
1278 * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1281 * @param string $page
1282 * Title of documentation wiki page.
1283 * @param bool $URLonly
1284 * (optional) Whether to return URL only or full HTML link (default).
1285 * @param string $text
1286 * (optional) Text of HTML link (no effect if $URLonly = false).
1287 * @param string $title
1288 * (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1289 * @param string $style
1290 * (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1292 * @param null $resource
1295 * URL or link to documentation page, based on provided parameters.
1297 public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1298 // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1299 // return just the URL, no matter what other parameters are defined
1300 if (!function_exists('ts')) {
1301 if ($resource == 'wiki') {
1302 $docBaseURL = self
::getWikiBaseURL();
1305 $docBaseURL = self
::getDocBaseURL();
1307 return $docBaseURL . str_replace(' ', '+', $page);
1312 'URLonly' => $URLonly,
1316 'resource' => $resource,
1318 return self
::docURL($params);
1323 * Returns URL or link to documentation page, based on provided parameters.
1325 * For use in templates code.
1327 * @param array $params
1328 * An array of parameters (see CRM_Utils_System::docURL2 method for names)
1330 * @return null|string
1331 * URL or link to documentation page, based on provided parameters.
1333 public static function docURL($params) {
1335 if (!isset($params['page'])) {
1339 if (CRM_Utils_Array
::value('resource', $params) == 'wiki') {
1340 $docBaseURL = self
::getWikiBaseURL();
1343 $docBaseURL = self
::getDocBaseURL();
1346 if (!isset($params['title']) or $params['title'] === NULL) {
1347 $params['title'] = ts('Opens documentation in a new window.');
1350 if (!isset($params['text']) or $params['text'] === NULL) {
1351 $params['text'] = ts('(learn more...)');
1354 if (!isset($params['style']) ||
$params['style'] === NULL) {
1358 $style = "style=\"{$params['style']}\"";
1361 $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1363 if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1367 return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1372 * Execute external or internal URLs and return server response.
1374 * @param string $url
1376 * @param bool $addCookie
1377 * Whether to provide a cookie. Should be true to access internal URLs.
1380 * Response from URL.
1382 public static function getServerResponse($url, $addCookie = TRUE) {
1383 CRM_Core_TemporaryErrorScope
::ignoreException();
1384 require_once 'HTTP/Request.php';
1385 $request = new HTTP_Request($url);
1388 foreach ($_COOKIE as $name => $value) {
1389 $request->addCookie($name, $value);
1393 if (isset($_SERVER['AUTH_TYPE'])) {
1394 $request->setBasicAuth($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
1397 $config = CRM_Core_Config
::singleton();
1398 if ($config->userFramework
== 'WordPress') {
1399 session_write_close();
1402 $request->sendRequest();
1403 $response = $request->getResponseBody();
1409 * Exit with provided exit code.
1411 * @param int $status
1412 * (optional) Code with which to exit.
1414 public static function civiExit($status = 0) {
1415 // move things to CiviCRM cache as needed
1416 CRM_Core_Session
::storeSessionObjects();
1422 * Reset the various system caches and some important static variables.
1424 public static function flushCache() {
1425 // flush out all cache entries so we can reload new data
1426 // a bit aggressive, but livable for now
1427 $cache = CRM_Utils_Cache
::singleton();
1430 // also reset the various static memory caches
1432 // reset the memory or array cache
1433 CRM_Core_BAO_Cache
::deleteGroup('contact fields', NULL, FALSE);
1436 CRM_ACL_BAO_Cache
::resetCache();
1438 // reset various static arrays used here
1439 CRM_Contact_BAO_Contact
::$_importableFields = CRM_Contact_BAO_Contact
::$_exportableFields
1440 = CRM_Contribute_BAO_Contribution
::$_importableFields
1441 = CRM_Contribute_BAO_Contribution
::$_exportableFields
1442 = CRM_Pledge_BAO_Pledge
::$_exportableFields = CRM_Contribute_BAO_Query
::$_contributionFields
1443 = CRM_Core_BAO_CustomField
::$_importFields
1444 = CRM_Core_BAO_Cache
::$_cache = CRM_Core_DAO
::$_dbColumnValueCache = NULL;
1446 CRM_Core_OptionGroup
::flushAll();
1447 CRM_Utils_PseudoConstant
::flushAll();
1451 * Load CMS bootstrap.
1453 * @param array $params
1454 * Array with uid name and pass
1455 * @param bool $loadUser
1456 * Boolean load user or not.
1457 * @param bool $throwError
1458 * @param string $realPath
1460 public static function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1461 if (!is_array($params)) {
1464 $config = CRM_Core_Config
::singleton();
1465 return $config->userSystem
->loadBootStrap($params, $loadUser, $throwError, $realPath);
1471 * @return mixed|string
1473 public static function baseCMSURL() {
1474 static $_baseURL = NULL;
1476 $config = CRM_Core_Config
::singleton();
1477 $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL
;
1479 if ($config->userFramework
== 'Joomla') {
1481 // we need to remove the administrator/ from the end
1482 $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1486 global $civicrm_root;
1487 if (strpos($civicrm_root,
1488 DIRECTORY_SEPARATOR
. 'sites' .
1489 DIRECTORY_SEPARATOR
. 'all' .
1490 DIRECTORY_SEPARATOR
. 'modules'
1493 $startPos = strpos($civicrm_root,
1494 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
1496 $endPos = strpos($civicrm_root,
1497 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
1499 if ($startPos && $endPos) {
1500 // if component is in sites/SITENAME/modules
1501 $siteName = substr($civicrm_root,
1503 $endPos - $startPos - 7
1506 $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1515 * Given a URL, return a relative URL if possible.
1517 * @param string $url
1521 public static function relativeURL($url) {
1522 // check if url is relative, if so return immediately
1523 if (substr($url, 0, 4) != 'http') {
1527 // make everything relative from the baseFilePath
1528 $baseURL = self
::baseCMSURL();
1530 // check if baseURL is a substr of $url, if so
1531 // return rest of string
1532 if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1533 return substr($url, strlen($baseURL));
1536 // return the original value
1541 * Produce an absolute URL from a possibly-relative URL.
1543 * @param string $url
1544 * @param bool $removeLanguagePart
1548 public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1549 // check if url is already absolute, if so return immediately
1550 if (substr($url, 0, 4) == 'http') {
1554 // make everything absolute from the baseFileURL
1555 $baseURL = self
::baseCMSURL();
1557 //CRM-7622: drop the language from the URL if requested (and it’s there)
1558 $config = CRM_Core_Config
::singleton();
1559 if ($removeLanguagePart) {
1560 $baseURL = self
::languageNegotiationURL($baseURL, FALSE, TRUE);
1563 return $baseURL . $url;
1567 * Clean url, replaces first '&' with '?'.
1569 * @param string $url
1574 public static function cleanUrl($url) {
1579 if ($pos = strpos($url, '&')) {
1580 $url = substr_replace($url, '?', $pos, 1);
1587 * Format the url as per language Negotiation.
1589 * @param string $url
1591 * @param bool $addLanguagePart
1592 * @param bool $removeLanguagePart
1597 public static function languageNegotiationURL(
1599 $addLanguagePart = TRUE,
1600 $removeLanguagePart = FALSE
1602 $config = &CRM_Core_Config
::singleton();
1603 return $config->userSystem
->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1607 * Append the contents of an 'extra' smarty template file.
1609 * It must be present in the custom template directory. This does not work if there are
1610 * multiple custom template directories
1612 * @param string $fileName
1613 * The name of the tpl file that we are processing.
1614 * @param string $content
1615 * The current content string. May be modified by this function.
1616 * @param string $overideFileName
1617 * (optional) Sent by contribution/event reg/profile pages which uses a id
1618 * specific extra file name if present.
1620 public static function appendTPLFile(
1623 $overideFileName = NULL
1625 $template = CRM_Core_Smarty
::singleton();
1626 if ($overideFileName) {
1627 $additionalTPLFile = $overideFileName;
1630 $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1633 if ($template->template_exists($additionalTPLFile)) {
1634 $content .= $template->fetch($additionalTPLFile);
1639 * Get a list of all files that are found within the directories.
1641 * Files must be the result of appending the provided relative path to
1642 * each component of the PHP include path.
1644 * @author Ken Zalewski
1646 * @param string $relpath
1647 * A relative path, typically pointing to a directory with multiple class
1651 * An array of files that exist in one or more of the directories that are
1652 * referenced by the relative path when appended to each element of the PHP
1655 public static function listIncludeFiles($relpath) {
1656 $file_list = array();
1657 $inc_dirs = explode(PATH_SEPARATOR
, get_include_path());
1658 foreach ($inc_dirs as $inc_dir) {
1659 $target_dir = $inc_dir . DIRECTORY_SEPARATOR
. $relpath;
1660 if (is_dir($target_dir)) {
1661 $cur_list = scandir($target_dir);
1662 foreach ($cur_list as $fname) {
1663 if ($fname != '.' && $fname != '..') {
1664 $file_list[$fname] = $fname;
1673 * Get a list of all "plugins".
1675 * (PHP classes that implement a piece of
1676 * functionality using a well-defined interface) that are found in a
1677 * particular CiviCRM directory (both custom and core are searched).
1679 * @author Ken Zalewski
1681 * @param string $relpath
1682 * A relative path referencing a directory that contains one or more
1684 * @param string $fext
1685 * (optional) Only files with this extension will be considered to be
1687 * @param array $skipList
1688 * (optional) List of files to skip.
1691 * List of plugins, where the plugin name is both the key and the value of
1694 public static function getPluginList($relpath, $fext = '.php', $skipList = array()) {
1695 $fext_len = strlen($fext);
1697 $inc_files = CRM_Utils_System
::listIncludeFiles($relpath);
1698 foreach ($inc_files as $inc_file) {
1699 if (substr($inc_file, 0 - $fext_len) == $fext) {
1700 $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1701 if (!in_array($plugin_name, $skipList)) {
1702 $plugins[$plugin_name] = $plugin_name;
1710 * Execute scheduled jobs.
1712 public static function executeScheduledJobs() {
1713 $facility = new CRM_Core_JobManager();
1714 $facility->execute(FALSE);
1716 $redirectUrl = self
::url('civicrm/admin/job', 'reset=1');
1718 CRM_Core_Session
::setStatus(
1719 ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1720 ts('Complete'), 'success');
1722 CRM_Utils_System
::redirect($redirectUrl);
1726 * Evaluate any tokens in a URL.
1728 * @param string|FALSE $url
1730 * @return string|FALSE
1732 public static function evalUrl($url) {
1733 if (!$url ||
strpos($url, '{') === FALSE) {
1737 $config = CRM_Core_Config
::singleton();
1739 '{ver}' => CRM_Utils_System
::version(),
1740 '{uf}' => $config->userFramework
,
1741 '{php}' => phpversion(),
1742 '{sid}' => self
::getSiteID(),
1743 '{baseUrl}' => $config->userFrameworkBaseURL
,
1744 '{lang}' => $config->lcMessages
,
1745 '{co}' => $config->defaultContactCountry
,
1747 return strtr($url, array_map('urlencode', $vars));
1752 * Returns the unique identifier for this site, as used by community messages.
1754 * SiteID will be generated if it is not already stored in the settings table.
1758 public static function getSiteID() {
1759 $sid = Civi
::settings()->get('site_id');
1761 $config = CRM_Core_Config
::singleton();
1762 $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '') . '_' . $config->userFrameworkBaseURL
);
1763 civicrm_api3('Setting', 'create', array('domain_id' => 'all', 'site_id' => $sid));
1769 * Determine whether this is a developmental system.
1773 public static function isDevelopment() {
1774 static $cache = NULL;
1775 if ($cache === NULL) {
1776 global $civicrm_root;
1777 $cache = file_exists("{$civicrm_root}/.svn") ||
file_exists("{$civicrm_root}/.git");
1783 * Is in upgrade mode.
1787 public static function isInUpgradeMode() {
1788 $args = explode('/', CRM_Utils_Array
::value('q', $_GET));
1789 $upgradeInProcess = CRM_Core_Session
::singleton()->get('isUpgradePending');
1790 if ((isset($args[1]) && $args[1] == 'upgrade') ||
$upgradeInProcess) {
1799 * Determine the standard URL for viewing or editing the specified link.
1801 * This function delegates the decision-making to (a) the hook system and
1802 * (b) the BAO system.
1804 * @param array $crudLinkSpec
1806 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1807 * - entity_table: string, eg "civicrm_contact"
1810 * @return array|NULL
1811 * NULL if unavailable, or an array. array has keys:
1817 public static function createDefaultCrudLink($crudLinkSpec) {
1818 $crudLinkSpec['action'] = CRM_Utils_Array
::value('action', $crudLinkSpec, CRM_Core_Action
::VIEW
);
1819 $daoClass = CRM_Core_DAO_AllCoreTables
::getClassForTable($crudLinkSpec['entity_table']);
1824 $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1825 if (!class_exists($baoClass)) {
1829 $bao = new $baoClass();
1830 $bao->id
= $crudLinkSpec['entity_id'];
1831 if (!$bao->find(TRUE)) {
1836 CRM_Utils_Hook
::crudLink($crudLinkSpec, $bao, $link);
1837 if (empty($link) && is_callable(array($bao, 'createDefaultCrudLink'))) {
1838 $link = $bao->createDefaultCrudLink($crudLinkSpec);
1841 if (!empty($link)) {
1842 if (!isset($link['url'])) {
1843 $link['url'] = self
::url($link['path'], $link['query'], TRUE, NULL, FALSE);