4 * Base class for UF system integrations
6 abstract class CRM_Utils_System_Base
{
9 * Deprecated property to check if this is a drupal install.
11 * The correct method is to have functions on the UF classes for all UF specific
12 * functions and leave the codebase oblivious to the type of CMS
16 * TRUE, if the CMS is Drupal.
18 public $is_drupal = FALSE;
21 * Deprecated property to check if this is a joomla install. The correct method is to have functions on the UF classes for all UF specific
22 * functions and leave the codebase oblivious to the type of CMS
26 * TRUE, if the CMS is Joomla!.
28 public $is_joomla = FALSE;
31 * deprecated property to check if this is a wordpress install. The correct method is to have functions on the UF classes for all UF specific
32 * functions and leave the codebase oblivious to the type of CMS
36 * TRUE, if the CMS is WordPress.
38 public $is_wordpress = FALSE;
41 * Does this CMS / UF support a CMS specific logging mechanism?
43 * @todo - we should think about offering up logging mechanisms in a way that is also extensible by extensions
45 public $supports_UF_Logging = FALSE;
49 * TRUE, if the CMS allows CMS forms to be extended by hooks.
51 public $supports_form_extensions = FALSE;
53 public function initialize() {
54 if (\CRM_Utils_System
::isSSL()) {
55 $this->mapConfigToSSL();
59 abstract public function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL);
62 * Append an additional breadcrumb tag to the existing breadcrumb.
64 * @param array $breadCrumbs
66 public function appendBreadCrumb($breadCrumbs) {
70 * Reset an additional breadcrumb tag to the existing breadcrumb.
72 public function resetBreadCrumb() {
76 * Append a string to the head of the html file.
79 * The new string to be appended.
81 public function addHTMLHead($head) {
85 * Rewrite various system urls to https.
87 public function mapConfigToSSL() {
88 // dont need to do anything, let CMS handle their own switch to SSL
92 * Figure out the post url for QuickForm.
94 * @param string $action
95 * The default url if one is pre-specified.
98 * The url to post the form.
100 public function postURL($action) {
101 $config = CRM_Core_Config
::singleton();
102 if (!empty($action)) {
106 return $this->url(CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET),
107 NULL, TRUE, NULL, FALSE
112 * Generate the url string to a CiviCRM path.
114 * @param string $path
115 * The path being linked to, such as "civicrm/add".
116 * @param string $query
117 * A query string to append to the link.
118 * @param bool $absolute
119 * Whether to force the output to be an absolute link (beginning with http).
120 * Useful for links that will be displayed outside the site, such as in an RSS feed.
121 * @param string $fragment
122 * A fragment identifier (named anchor) to append to the link.
123 * @param bool $frontend
124 * This link should be to the CMS front end (applies to WP & Joomla).
125 * @param bool $forceBackend
126 * This link should be to the CMS back end (applies to WP & Joomla).
136 $forceBackend = FALSE
142 * Authenticate the user against the CMS db.
144 * @param string $name
146 * @param string $password
147 * The password for the above user.
148 * @param bool $loadCMSBootstrap
149 * Load cms bootstrap?.
150 * @param string $realPath
154 * [contactID, ufID, unique string] else false if no auth
156 public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
161 * Set a message in the CMS to display to a user.
163 * @param string $message
164 * The message to set.
166 public function setMessage($message) {
170 * Load user into session.
176 public function loadUser($user) {
181 * Immediately stop script execution and display a 401 "Access Denied" page.
183 public function permissionDenied() {
184 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
188 * Immediately stop script execution, log out the user and redirect to the home page.
191 * This function should be removed in favor of linking to the CMS's logout page
193 public function logout() {
197 * Clear CMS caches related to the user registration/profile forms.
198 * Used when updating/embedding profiles on CMS user forms.
201 public function updateCategories() {
205 * Get the locale set in the CMS.
207 * @return string|null
208 * Locale or null for none
210 public function getUFLocale() {
215 * If we are using a theming system, invoke theme, else just print the content.
217 * @param string $content
218 * The content that will be themed.
220 * Are we displaying to the screen or bypassing theming?.
221 * @param bool $maintenance
222 * For maintenance mode.
225 * @return string|null
226 * NULL, If $print is FALSE, and some other criteria match up.
227 * The themed string, otherwise.
229 * @todo The return value is inconsistent.
230 * @todo Better to always return, and never print.
232 public function theme(&$content, $print = FALSE, $maintenance = FALSE) {
235 // TODO: Split up; this was copied verbatim from CiviCRM 4.0's multi-UF theming function
236 // but the parts should be copied into cleaner subclass implementations
237 $config = CRM_Core_Config
::singleton();
239 $config->userSystem
->is_drupal
&&
240 function_exists('theme') &&
244 drupal_set_breadcrumb('');
245 drupal_maintenance_theme();
246 if ($region = CRM_Core_Region
::instance('html-header', FALSE)) {
247 CRM_Utils_System
::addHTMLHead($region->render(''));
249 print theme('maintenance_page', ['content' => $content]);
252 // TODO: Figure out why D7 returns but everyone else prints
259 CRM_Core_Config
::singleton()->userFramework
== 'WordPress'
261 if (!function_exists('is_admin')) {
262 throw new \
Exception('Function "is_admin()" is missing, even though WordPress is the user framework.');
264 if (!defined('ABSPATH')) {
265 throw new \
Exception('Constant "ABSPATH" is not defined, even though WordPress is the user framework.');
268 require_once ABSPATH
. 'wp-admin/admin-header.php';
271 // FIXME: we need to figure out to replace civicrm content on the frontend pages
287 public function getDefaultBlockLocation() {
292 * Get the absolute path to the site's base url.
294 * @return bool|mixed|string
296 public function getAbsoluteBaseURL() {
297 if (!defined('CIVICRM_UF_BASEURL')) {
301 $url = CRM_Utils_File
::addTrailingSlash(CIVICRM_UF_BASEURL
, '/');
303 //format url for language negotiation, CRM-7803
304 $url = $this->languageNegotiationURL($url);
306 if (CRM_Utils_System
::isSSL()) {
307 $url = str_replace('http://', 'https://', $url);
314 * Get the relative path to the sites base url.
318 public function getRelativeBaseURL() {
319 $absoluteBaseURL = $this->getAbsoluteBaseURL();
320 if ($absoluteBaseURL === FALSE) {
323 $parts = parse_url($absoluteBaseURL);
324 return $parts['path'];
325 //$this->useFrameworkRelativeBase = empty($base['path']) ? '/' : $base['path'];
333 public function getVersion() {
338 * Format the url as per language Negotiation.
341 * @param bool $addLanguagePart
342 * @param bool $removeLanguagePart
347 public function languageNegotiationURL(
349 $addLanguagePart = TRUE,
350 $removeLanguagePart = FALSE
356 * Determine the location of the CMS root.
358 * @return string|null
359 * Local file system path to CMS root, or NULL if it cannot be determined
361 public function cmsRootPath() {
366 * Create a user in the CMS.
368 * @param array $params
369 * @param string $mail
370 * Email id for cms user.
373 * uid if user exists, false otherwise
375 public function createUser(&$params, $mail) {
380 * Update a user's email address in the CMS.
384 * @param string $email
385 * Primary contact email address.
387 public function updateCMSName($ufID, $email) {
391 * Check if user is logged in to the CMS.
395 public function isUserLoggedIn() {
400 * Check if user registration is permitted.
404 public function isUserRegistrationPermitted() {
409 * Check if user can create passwords or is initially assigned a system-generated one.
413 public function isPasswordUserGenerated() {
418 * Is a front end page being accessed.
420 * Generally this would be a contribution form or other public page as opposed to a backoffice page (like contact edit).
422 * @todo Drupal uses the is_public setting - clarify & rationalise. See https://github.com/civicrm/civicrm-drupal/pull/546/files
426 public function isFrontEndPage() {
427 return CRM_Core_Config
::singleton()->userFrameworkFrontend
;
431 * Get user login URL for hosting CMS (method declared in each CMS system class)
433 * @param string $destination
434 * If present, add destination to querystring (works for Drupal only).
437 * loginURL for the current CMS
439 abstract public function getLoginURL($destination = '');
442 * Get the login destination string.
444 * When this is passed in the URL the user will be directed to it after filling in the CMS form.
446 * @param CRM_Core_Form $form
447 * Form object representing the 'current' form - to which the user will be returned.
449 * @return string|NULL
450 * destination value for URL
452 public function getLoginDestination(&$form) {
457 * Determine the native ID of the CMS user.
459 * @param string $username
461 * @throws CRM_Core_Exception
463 public function getUfId($username) {
464 $className = get_class($this);
465 throw new CRM_Core_Exception("Not implemented: {$className}->getUfId");
469 * Set the localisation from the user framework.
471 * @param string $civicrm_language
475 public function setUFLocale($civicrm_language) {
480 * Set a init session with user object.
483 * Array with user specific data
485 public function setUserSession($data) {
486 list($userID, $ufID) = $data;
487 $session = CRM_Core_Session
::singleton();
488 $session->set('ufID', $ufID);
489 $session->set('userID', $userID);
493 * Reset any system caches that may be required for proper CiviCRM integration.
495 public function flush() {
500 * Flush css/js caches.
502 public function clearResourceCache() {
509 * Note: This function is not to be called directly
510 * @see CRM_Core_Region::render()
512 * @param string $url absolute path to file
513 * @param string $region
514 * location within the document: 'html-header', 'page-header', 'page-footer'.
517 * TRUE if we support this operation in this CMS, FALSE otherwise
519 public function addScriptUrl($url, $region) {
524 * Add an inline script.
526 * Note: This function is not to be called directly
527 * @see CRM_Core_Region::render()
529 * @param string $code javascript code
530 * @param string $region
531 * location within the document: 'html-header', 'page-header', 'page-footer'.
534 * TRUE if we support this operation in this CMS, FALSE otherwise
536 public function addScript($code, $region) {
543 * Note: This function is not to be called directly
544 * @see CRM_Core_Region::render()
546 * @param string $url absolute path to file
547 * @param string $region
548 * location within the document: 'html-header', 'page-header', 'page-footer'.
551 * TRUE if we support this operation in this CMS, FALSE otherwise
553 public function addStyleUrl($url, $region) {
558 * Add an inline style.
560 * Note: This function is not to be called directly
561 * @see CRM_Core_Region::render()
563 * @param string $code css code
564 * @param string $region
565 * location within the document: 'html-header', 'page-header', 'page-footer'.
568 * TRUE if we support this operation in this CMS, FALSE otherwise
570 public function addStyle($code, $region) {
575 * Sets the title of the page.
577 * @param string $title
578 * Title to set in html header
579 * @param string|null $pageTitle
580 * Title to set in html body (if different)
582 public function setTitle($title, $pageTitle = NULL) {
586 * Return default Site Settings.
591 * - $url, (Joomla - non admin url)
595 public function getDefaultSiteSettings($dir) {
596 $config = CRM_Core_Config
::singleton();
597 $url = $config->userFrameworkBaseURL
;
598 return [$url, NULL, NULL];
602 * Determine the default location for file storage.
605 * 1. This was pulled out from a bigger function. It should be split
606 * into even smaller pieces and marked abstract.
607 * 2. This would be easier to compute by a calling a CMS API, but
608 * for whatever reason Civi gets it from config data.
611 * - url: string. ex: "http://example.com/sites/foo.com/files/civicrm"
612 * - path: string. ex: "/var/www/sites/foo.com/files/civicrm"
614 public function getDefaultFileStorage() {
615 global $civicrm_root;
616 $config = CRM_Core_Config
::singleton();
617 $baseURL = CRM_Utils_System
::languageNegotiationURL($config->userFrameworkBaseURL
, FALSE, TRUE);
622 if ($config->userFramework
== 'Joomla') {
624 // we need to remove the administrator/ from the end
625 $tempURL = str_replace("/administrator/", "/", $baseURL);
626 $filesURL = $tempURL . "media/civicrm/";
628 elseif ($config->userFramework
== 'UnitTests') {
629 $filesURL = $baseURL . "sites/default/files/civicrm/";
632 throw new CRM_Core_Exception("Failed to locate default file storage ($config->userFramework)");
637 'path' => CRM_Utils_File
::baseFilePath(),
642 * Determine the location of the CiviCRM source tree.
645 * 1. This was pulled out from a bigger function. It should be split
646 * into even smaller pieces and marked abstract.
647 * 2. This would be easier to compute by a calling a CMS API, but
648 * for whatever reason we take the hard way.
651 * - url: string. ex: "http://example.com/sites/all/modules/civicrm"
652 * - path: string. ex: "/var/www/sites/all/modules/civicrm"
654 public function getCiviSourceStorage() {
655 global $civicrm_root;
656 $config = CRM_Core_Config
::singleton();
658 // Don't use $config->userFrameworkBaseURL; it has garbage on it.
659 // More generally, w shouldn't be using $config here.
660 if (!defined('CIVICRM_UF_BASEURL')) {
661 throw new RuntimeException('Undefined constant: CIVICRM_UF_BASEURL');
663 $baseURL = CRM_Utils_File
::addTrailingSlash(CIVICRM_UF_BASEURL
, '/');
664 if (CRM_Utils_System
::isSSL()) {
665 $baseURL = str_replace('http://', 'https://', $baseURL);
668 if ($config->userFramework
== 'Joomla') {
669 $userFrameworkResourceURL = $baseURL . "components/com_civicrm/civicrm/";
671 elseif ($config->userFramework
== 'WordPress') {
672 $userFrameworkResourceURL = CIVICRM_PLUGIN_URL
. "civicrm/";
674 elseif ($this->is_drupal
) {
676 // check and see if we are installed in sites/all (for D5 and above)
677 // we dont use checkURL since drupal generates an error page and throws
678 // the system for a loop on lobo's macosx box
680 $cmsPath = $config->userSystem
->cmsRootPath();
681 $userFrameworkResourceURL = $baseURL . str_replace("$cmsPath/", '',
682 str_replace('\\', '/', $civicrm_root)
685 $siteName = $config->userSystem
->parseDrupalSiteNameFromRoot($civicrm_root);
687 $civicrmDirName = trim(basename($civicrm_root));
688 $userFrameworkResourceURL = $baseURL . "sites/$siteName/modules/$civicrmDirName/";
692 $userFrameworkResourceURL = NULL;
696 'url' => CRM_Utils_File
::addTrailingSlash($userFrameworkResourceURL, '/'),
697 'path' => CRM_Utils_File
::addTrailingSlash($civicrm_root),
702 * Perform any post login activities required by the CMS.
704 * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
705 * calls hook_user op 'login' and generates a new session.
707 * @param array $params
709 * FIXME: Document values accepted/required by $params
711 public function userLoginFinalize($params = []) {
715 * Set timezone in mysql so that timestamp fields show the correct time.
717 public function setMySQLTimeZone() {
718 $timeZoneOffset = $this->getTimeZoneOffset();
719 if ($timeZoneOffset) {
720 $sql = "SET time_zone = '$timeZoneOffset'";
721 CRM_Core_DAO
::executequery($sql);
726 * Get timezone from CMS.
728 * @return string|false|null
730 public function getTimeZoneOffset() {
731 $timezone = $this->getTimeZoneString();
733 if ($timezone == 'UTC' ||
$timezone == 'Etc/UTC') {
734 // CRM-17072 Let's short-circuit all the zero handling & return it here!
737 $tzObj = new DateTimeZone($timezone);
738 $dateTime = new DateTime("now", $tzObj);
739 $tz = $tzObj->getOffset($dateTime);
750 $timeZoneOffset = sprintf("%02d:%02d", $tz / 3600, abs(($tz / 60) %
60));
752 if ($timeZoneOffset > 0) {
753 $timeZoneOffset = '+' . $timeZoneOffset;
755 return $timeZoneOffset;
761 * Get timezone as a string.
763 * Timezone string e.g. 'America/Los_Angeles'
765 public function getTimeZoneString() {
766 return date_default_timezone_get();
770 * Get Unique Identifier from UserFramework system (CMS).
772 * @param object $user
773 * Object as described by the User Framework.
776 * Unique identifier from the user Framework system
778 public function getUniqueIdentifierFromUserObject($user) {
783 * Get User ID from UserFramework system (CMS).
785 * @param object $user
787 * Object as described by the User Framework.
790 public function getUserIDFromUserObject($user) {
795 * Get an array of user details for a contact, containing at minimum the user ID & name.
797 * @param int $contactID
800 * CMS user details including
802 * - name (ie the system user name.
804 public function getUser($contactID) {
805 $ufMatch = civicrm_api3('UFMatch', 'getsingle', [
806 'contact_id' => $contactID,
807 'domain_id' => CRM_Core_Config
::domainID(),
810 'id' => $ufMatch['uf_id'],
811 'name' => $ufMatch['uf_name'],
816 * Get currently logged in user uf id.
819 * logged in user uf id.
821 public function getLoggedInUfID() {
826 * Get currently logged in user unique identifier - this tends to be the email address or user name.
828 * @return string|null
829 * logged in user unique identifier
831 public function getLoggedInUniqueIdentifier() {
836 * Return a UFID (user account ID from the UserFramework / CMS system.
838 * ID is based on the user object passed, defaulting to the logged in user if not passed.
840 * Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would
841 * seem to be resolving the user id before calling the function.
843 * Note there is already a function getUFId which takes $username as a param - we could add $user
844 * as a second param to it but it seems messy - just overloading it because the name is taken.
846 * @param object $user
849 * User ID of UF System
851 public function getBestUFID($user = NULL) {
853 return $this->getUserIDFromUserObject($user);
855 return $this->getLoggedInUfID();
859 * Return a unique identifier (usually an email address or username) from the UserFramework / CMS system.
861 * This is based on the user object passed, defaulting to the logged in user if not passed.
863 * Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be
864 * resolving the unique identifier before calling the function.
866 * @param object $user
869 * unique identifier from the UF System
871 public function getBestUFUniqueIdentifier($user = NULL) {
873 return $this->getUniqueIdentifierFromUserObject($user);
875 return $this->getLoggedInUniqueIdentifier();
879 * List modules installed in the CMS, including enabled and disabled ones.
884 public function getModules() {
889 * Get Url to view user record.
891 * @param int $contactID
894 * @return string|null
896 public function getUserRecordUrl($contactID) {
901 * Is the current user permitted to add a user.
905 public function checkPermissionAddUser() {
910 * Output code from error function.
912 * @param string $content
914 public function outputError($content) {
915 echo CRM_Utils_System
::theme($content);
921 * @param string $message
923 public function logger($message) {
927 * Append to coreResourcesList.
929 * @param \Civi\Core\Event\GenericHookEvent $e
931 public function appendCoreResources(\Civi\Core\Event\GenericHookEvent
$e) {
935 * Modify dynamic assets.
937 * @param \Civi\Core\Event\GenericHookEvent $e
939 public function alterAssetUrl(\Civi\Core\Event\GenericHookEvent
$e) {
943 * @param string $name
944 * @param string $value
946 public function setHttpHeader($name, $value) {
947 header("$name: $value");
951 * Create CRM contacts for all existing CMS users
956 public function synchronizeUsers() {
957 throw new Exception('CMS user creation not supported for this framework');
962 * Send an HTTP Response base on PSR HTTP RespnseInterface response.
964 * @param \Psr\Http\Message\ResponseInterface $response
966 public function sendResponse(\Psr\Http\Message\ResponseInterface
$response) {
967 http_response_code($response->getStatusCode());
968 foreach ($response->getHeaders() as $name => $values) {
969 CRM_Utils_System
::setHttpHeader($name, implode(', ', (array) $values));
971 echo $response->getBody();
972 CRM_Utils_System
::civiExit();