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 * Get user login URL for hosting CMS (method declared in each CMS system class)
420 * @param string $destination
421 * If present, add destination to querystring (works for Drupal only).
424 * loginURL for the current CMS
426 abstract public function getLoginURL($destination = '');
429 * Get the login destination string.
431 * When this is passed in the URL the user will be directed to it after filling in the CMS form.
433 * @param CRM_Core_Form $form
434 * Form object representing the 'current' form - to which the user will be returned.
436 * @return string|NULL
437 * destination value for URL
439 public function getLoginDestination(&$form) {
444 * Determine the native ID of the CMS user.
446 * @param string $username
448 * @throws CRM_Core_Exception
450 public function getUfId($username) {
451 $className = get_class($this);
452 throw new CRM_Core_Exception("Not implemented: {$className}->getUfId");
456 * Set the localisation from the user framework.
458 * @param string $civicrm_language
462 public function setUFLocale($civicrm_language) {
467 * Set a init session with user object.
470 * Array with user specific data
472 public function setUserSession($data) {
473 list($userID, $ufID) = $data;
474 $session = CRM_Core_Session
::singleton();
475 $session->set('ufID', $ufID);
476 $session->set('userID', $userID);
480 * Reset any system caches that may be required for proper CiviCRM integration.
482 public function flush() {
487 * Flush css/js caches.
489 public function clearResourceCache() {
496 * Note: This function is not to be called directly
497 * @see CRM_Core_Region::render()
499 * @param string $url absolute path to file
500 * @param string $region
501 * location within the document: 'html-header', 'page-header', 'page-footer'.
504 * TRUE if we support this operation in this CMS, FALSE otherwise
506 public function addScriptUrl($url, $region) {
511 * Add an inline script.
513 * Note: This function is not to be called directly
514 * @see CRM_Core_Region::render()
516 * @param string $code javascript code
517 * @param string $region
518 * location within the document: 'html-header', 'page-header', 'page-footer'.
521 * TRUE if we support this operation in this CMS, FALSE otherwise
523 public function addScript($code, $region) {
530 * Note: This function is not to be called directly
531 * @see CRM_Core_Region::render()
533 * @param string $url absolute path to file
534 * @param string $region
535 * location within the document: 'html-header', 'page-header', 'page-footer'.
538 * TRUE if we support this operation in this CMS, FALSE otherwise
540 public function addStyleUrl($url, $region) {
545 * Add an inline style.
547 * Note: This function is not to be called directly
548 * @see CRM_Core_Region::render()
550 * @param string $code css code
551 * @param string $region
552 * location within the document: 'html-header', 'page-header', 'page-footer'.
555 * TRUE if we support this operation in this CMS, FALSE otherwise
557 public function addStyle($code, $region) {
562 * Sets the title of the page.
564 * @param string $title
565 * Title to set in html header
566 * @param string|null $pageTitle
567 * Title to set in html body (if different)
569 public function setTitle($title, $pageTitle = NULL) {
573 * Return default Site Settings.
578 * - $url, (Joomla - non admin url)
582 public function getDefaultSiteSettings($dir) {
583 $config = CRM_Core_Config
::singleton();
584 $url = $config->userFrameworkBaseURL
;
585 return [$url, NULL, NULL];
589 * Determine the default location for file storage.
592 * 1. This was pulled out from a bigger function. It should be split
593 * into even smaller pieces and marked abstract.
594 * 2. This would be easier to compute by a calling a CMS API, but
595 * for whatever reason Civi gets it from config data.
598 * - url: string. ex: "http://example.com/sites/foo.com/files/civicrm"
599 * - path: string. ex: "/var/www/sites/foo.com/files/civicrm"
601 public function getDefaultFileStorage() {
602 global $civicrm_root;
603 $config = CRM_Core_Config
::singleton();
604 $baseURL = CRM_Utils_System
::languageNegotiationURL($config->userFrameworkBaseURL
, FALSE, TRUE);
609 if ($config->userFramework
== 'Joomla') {
611 // we need to remove the administrator/ from the end
612 $tempURL = str_replace("/administrator/", "/", $baseURL);
613 $filesURL = $tempURL . "media/civicrm/";
615 elseif ($config->userFramework
== 'UnitTests') {
616 $filesURL = $baseURL . "sites/default/files/civicrm/";
619 throw new CRM_Core_Exception("Failed to locate default file storage ($config->userFramework)");
624 'path' => CRM_Utils_File
::baseFilePath(),
629 * Determine the location of the CiviCRM source tree.
632 * 1. This was pulled out from a bigger function. It should be split
633 * into even smaller pieces and marked abstract.
634 * 2. This would be easier to compute by a calling a CMS API, but
635 * for whatever reason we take the hard way.
638 * - url: string. ex: "http://example.com/sites/all/modules/civicrm"
639 * - path: string. ex: "/var/www/sites/all/modules/civicrm"
641 public function getCiviSourceStorage() {
642 global $civicrm_root;
643 $config = CRM_Core_Config
::singleton();
645 // Don't use $config->userFrameworkBaseURL; it has garbage on it.
646 // More generally, w shouldn't be using $config here.
647 if (!defined('CIVICRM_UF_BASEURL')) {
648 throw new RuntimeException('Undefined constant: CIVICRM_UF_BASEURL');
650 $baseURL = CRM_Utils_File
::addTrailingSlash(CIVICRM_UF_BASEURL
, '/');
651 if (CRM_Utils_System
::isSSL()) {
652 $baseURL = str_replace('http://', 'https://', $baseURL);
655 if ($config->userFramework
== 'Joomla') {
656 $userFrameworkResourceURL = $baseURL . "components/com_civicrm/civicrm/";
658 elseif ($config->userFramework
== 'WordPress') {
659 $userFrameworkResourceURL = CIVICRM_PLUGIN_URL
. "civicrm/";
661 elseif ($this->is_drupal
) {
663 // check and see if we are installed in sites/all (for D5 and above)
664 // we dont use checkURL since drupal generates an error page and throws
665 // the system for a loop on lobo's macosx box
667 $cmsPath = $config->userSystem
->cmsRootPath();
668 $userFrameworkResourceURL = $baseURL . str_replace("$cmsPath/", '',
669 str_replace('\\', '/', $civicrm_root)
672 $siteName = $config->userSystem
->parseDrupalSiteNameFromRoot($civicrm_root);
674 $civicrmDirName = trim(basename($civicrm_root));
675 $userFrameworkResourceURL = $baseURL . "sites/$siteName/modules/$civicrmDirName/";
679 $userFrameworkResourceURL = NULL;
683 'url' => CRM_Utils_File
::addTrailingSlash($userFrameworkResourceURL, '/'),
684 'path' => CRM_Utils_File
::addTrailingSlash($civicrm_root),
689 * Perform any post login activities required by the CMS.
691 * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
692 * calls hook_user op 'login' and generates a new session.
694 * @param array $params
696 * FIXME: Document values accepted/required by $params
698 public function userLoginFinalize($params = []) {
702 * Set timezone in mysql so that timestamp fields show the correct time.
704 public function setMySQLTimeZone() {
705 $timeZoneOffset = $this->getTimeZoneOffset();
706 if ($timeZoneOffset) {
707 $sql = "SET time_zone = '$timeZoneOffset'";
708 CRM_Core_DAO
::executequery($sql);
713 * Get timezone from CMS.
715 * @return string|false|null
717 public function getTimeZoneOffset() {
718 $timezone = $this->getTimeZoneString();
720 if ($timezone == 'UTC' ||
$timezone == 'Etc/UTC') {
721 // CRM-17072 Let's short-circuit all the zero handling & return it here!
724 $tzObj = new DateTimeZone($timezone);
725 $dateTime = new DateTime("now", $tzObj);
726 $tz = $tzObj->getOffset($dateTime);
737 $timeZoneOffset = sprintf("%02d:%02d", $tz / 3600, abs(($tz / 60) %
60));
739 if ($timeZoneOffset > 0) {
740 $timeZoneOffset = '+' . $timeZoneOffset;
742 return $timeZoneOffset;
748 * Get timezone as a string.
750 * Timezone string e.g. 'America/Los_Angeles'
752 public function getTimeZoneString() {
753 return date_default_timezone_get();
757 * Get Unique Identifier from UserFramework system (CMS).
759 * @param object $user
760 * Object as described by the User Framework.
763 * Unique identifier from the user Framework system
765 public function getUniqueIdentifierFromUserObject($user) {
770 * Get User ID from UserFramework system (CMS).
772 * @param object $user
774 * Object as described by the User Framework.
777 public function getUserIDFromUserObject($user) {
782 * Get an array of user details for a contact, containing at minimum the user ID & name.
784 * @param int $contactID
787 * CMS user details including
789 * - name (ie the system user name.
791 public function getUser($contactID) {
792 $ufMatch = civicrm_api3('UFMatch', 'getsingle', [
793 'contact_id' => $contactID,
794 'domain_id' => CRM_Core_Config
::domainID(),
797 'id' => $ufMatch['uf_id'],
798 'name' => $ufMatch['uf_name'],
803 * Get currently logged in user uf id.
806 * logged in user uf id.
808 public function getLoggedInUfID() {
813 * Get currently logged in user unique identifier - this tends to be the email address or user name.
815 * @return string|null
816 * logged in user unique identifier
818 public function getLoggedInUniqueIdentifier() {
823 * Return a UFID (user account ID from the UserFramework / CMS system.
825 * ID is based on the user object passed, defaulting to the logged in user if not passed.
827 * Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would
828 * seem to be resolving the user id before calling the function.
830 * Note there is already a function getUFId which takes $username as a param - we could add $user
831 * as a second param to it but it seems messy - just overloading it because the name is taken.
833 * @param object $user
836 * User ID of UF System
838 public function getBestUFID($user = NULL) {
840 return $this->getUserIDFromUserObject($user);
842 return $this->getLoggedInUfID();
846 * Return a unique identifier (usually an email address or username) from the UserFramework / CMS system.
848 * This is based on the user object passed, defaulting to the logged in user if not passed.
850 * Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be
851 * resolving the unique identifier before calling the function.
853 * @param object $user
856 * unique identifier from the UF System
858 public function getBestUFUniqueIdentifier($user = NULL) {
860 return $this->getUniqueIdentifierFromUserObject($user);
862 return $this->getLoggedInUniqueIdentifier();
866 * List modules installed in the CMS, including enabled and disabled ones.
871 public function getModules() {
876 * Get Url to view user record.
878 * @param int $contactID
881 * @return string|null
883 public function getUserRecordUrl($contactID) {
888 * Is the current user permitted to add a user.
892 public function checkPermissionAddUser() {
897 * Output code from error function.
899 * @param string $content
901 public function outputError($content) {
902 echo CRM_Utils_System
::theme($content);
908 * @param string $message
910 public function logger($message) {
914 * Append to coreResourcesList.
916 * @param \Civi\Core\Event\GenericHookEvent $e
918 public function appendCoreResources(\Civi\Core\Event\GenericHookEvent
$e) {
922 * Modify dynamic assets.
924 * @param \Civi\Core\Event\GenericHookEvent $e
926 public function alterAssetUrl(\Civi\Core\Event\GenericHookEvent
$e) {
930 * @param string $name
931 * @param string $value
933 public function setHttpHeader($name, $value) {
934 header("$name: $value");
938 * Create CRM contacts for all existing CMS users
943 public function synchronizeUsers() {
944 throw new Exception('CMS user creation not supported for this framework');
949 * Set the HTTP Status Code for a request
950 * @param string $statusCode
952 public function setStatusCode($statusCode) {
953 if (function_exists('http_response_code')) {
955 http_response_code($statusCode);
958 header('X-PHP-Response-Code: ' . $statusCode, TRUE, $statusCode);