CRM/Utils/System/Base.php

   1 <?php
   2
   3 /**
   4  * Base class for UF system integrations
   5  */
   6 abstract class CRM_Utils_System_Base {
   7
   8   /**
   9    * Deprecated property to check if this is a drupal install.
  10    *
  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
  13    *
  14    * @deprecated
  15    * @var bool
  16    *   TRUE, if the CMS is Drupal.
  17    */
  18   var $is_drupal = FALSE;
  19
  20   /**
  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
  23    *
  24    * @deprecated
  25    * @var bool
  26    *   TRUE, if the CMS is Joomla!.
  27    */
  28   var $is_joomla = FALSE;
  29
  30   /**
  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
  33    *
  34    * @deprecated
  35    * @var bool
  36    *   TRUE, if the CMS is WordPress.
  37    */
  38   var $is_wordpress = FALSE;
  39
  40   /**
  41    * Does this CMS / UF support a CMS specific logging mechanism?
  42    * @todo - we should think about offering up logging mechanisms in a way that is also extensible by extensions
  43    * @var bool
  44    */
  45   var $supports_UF_Logging = FALSE;
  46
  47   /**
  48    * @var bool
  49    *   TRUE, if the CMS allows CMS forms to be extended by hooks.
  50    */
  51   var $supports_form_extensions = FALSE;
  52
  53   public function initialize() {
  54     if (\CRM_Utils_System::isSSL()) {
  55       $this->mapConfigToSSL();
  56     }
  57   }
  58
  59   /**
  60    * Append an additional breadcrumb tag to the existing breadcrumb.
  61    *
  62    * @param array $breadCrumbs
  63    */
  64   public function appendBreadCrumb($breadCrumbs) {
  65   }
  66
  67   /**
  68    * Reset an additional breadcrumb tag to the existing breadcrumb.
  69    */
  70   public function resetBreadCrumb() {
  71   }
  72
  73   /**
  74    * Append a string to the head of the html file.
  75    *
  76    * @param string $head
  77    *   The new string to be appended.
  78    */
  79   public function addHTMLHead($head) {
  80   }
  81
  82   /**
  83    * Rewrite various system urls to https.
  84    */
  85   public function mapConfigToSSL() {
  86     // dont need to do anything, let CMS handle their own switch to SSL
  87   }
  88
  89   /**
  90    * Figure out the post url for QuickForm.
  91    *
  92    * @param string $action
  93    *   The default url if one is pre-specified.
  94    *
  95    * @return string
  96    *   The url to post the form.
  97    */
  98   public function postURL($action) {
  99     $config = CRM_Core_Config::singleton();
 100     if (!empty($action)) {
 101       return $action;
 102     }
 103
 104     return $this->url(CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET),
 105       NULL, TRUE, NULL, FALSE
 106     );
 107   }
 108
 109   /**
 110    * Generate the url string to a CiviCRM path.
 111    *
 112    * @param string $path
 113    *   The path being linked to, such as "civicrm/add".
 114    * @param string $query
 115    *   A query string to append to the link.
 116    * @param bool $absolute
 117    *   Whether to force the output to be an absolute link (beginning with http).
 118    *   Useful for links that will be displayed outside the site, such as in an RSS feed.
 119    * @param string $fragment
 120    *   A fragment identifier (named anchor) to append to the link.
 121    * @param bool $frontend
 122    *   This link should be to the CMS front end (applies to WP & Joomla).
 123    * @param bool $forceBackend
 124    *   This link should be to the CMS back end (applies to WP & Joomla).
 125    *
 126    * @return string
 127    */
 128   public function url(
 129     $path = NULL,
 130     $query = NULL,
 131     $absolute = FALSE,
 132     $fragment = NULL,
 133     $frontend = FALSE,
 134     $forceBackend = FALSE
 135   ) {
 136     return NULL;
 137   }
 138
 139   /**
 140    * Authenticate the user against the CMS db.
 141    *
 142    * @param string $name
 143    *   The user name.
 144    * @param string $password
 145    *   The password for the above user.
 146    * @param bool $loadCMSBootstrap
 147    *   Load cms bootstrap?.
 148    * @param string $realPath
 149    *   Filename of script
 150    *
 151    * @return array|bool
 152    *   [contactID, ufID, unique string] else false if no auth
 153    */
 154   public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
 155     return FALSE;
 156   }
 157
 158   /**
 159    * Set a message in the CMS to display to a user.
 160    *
 161    * @param string $message
 162    *   The message to set.
 163    */
 164   public function setMessage($message) {
 165   }
 166
 167   /**
 168    * Load user into session.
 169    *
 170    * @param obj $user
 171    *
 172    * @return bool
 173    */
 174   public function loadUser($user) {
 175     return TRUE;
 176   }
 177
 178   /**
 179    * Immediately stop script execution and display a 401 "Access Denied" page.
 180    */
 181   public function permissionDenied() {
 182     CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
 183   }
 184
 185   /**
 186    * Immediately stop script execution, log out the user and redirect to the home page.
 187    *
 188    * @deprecated
 189    *   This function should be removed in favor of linking to the CMS's logout page
 190    */
 191   public function logout() {
 192   }
 193
 194   /**
 195    * Clear CMS caches related to the user registration/profile forms.
 196    * Used when updating/embedding profiles on CMS user forms.
 197    * @see CRM-3600
 198    */
 199   public function updateCategories() {
 200   }
 201
 202   /**
 203    * Get the locale set in the CMS.
 204    *
 205    * @return string|null
 206    *   Locale or null for none
 207    */
 208   public function getUFLocale() {
 209     return NULL;
 210   }
 211
 212   /**
 213    * If we are using a theming system, invoke theme, else just print the content.
 214    *
 215    * @param string $content
 216    *   The content that will be themed.
 217    * @param bool $print
 218    *   Are we displaying to the screen or bypassing theming?.
 219    * @param bool $maintenance
 220    *   For maintenance mode.
 221    *
 222    * @throws Exception
 223    * @return string|null
 224    *   NULL, If $print is FALSE, and some other criteria match up.
 225    *   The themed string, otherwise.
 226    *
 227    * @todo The return value is inconsistent.
 228    * @todo Better to always return, and never print.
 229    */
 230   public function theme(&$content, $print = FALSE, $maintenance = FALSE) {
 231     $ret = FALSE;
 232
 233     // TODO: Split up; this was copied verbatim from CiviCRM 4.0's multi-UF theming function
 234     // but the parts should be copied into cleaner subclass implementations
 235     $config = CRM_Core_Config::singleton();
 236     if (
 237       $config->userSystem->is_drupal &&
 238       function_exists('theme') &&
 239       !$print
 240     ) {
 241       if ($maintenance) {
 242         drupal_set_breadcrumb('');
 243         drupal_maintenance_theme();
 244         if ($region = CRM_Core_Region::instance('html-header', FALSE)) {
 245           CRM_Utils_System::addHTMLHead($region->render(''));
 246         }
 247         print theme('maintenance_page', array('content' => $content));
 248         exit();
 249       }
 250       // TODO: Figure out why D7 returns but everyone else prints
 251       $ret = TRUE;
 252     }
 253     $out = $content;
 254
 255     $config = &CRM_Core_Config::singleton();
 256     if (
 257       !$print &&
 258       $config->userFramework == 'WordPress'
 259     ) {
 260       if (!function_exists('is_admin')) {
 261         throw new \Exception('Function "is_admin()" is missing, even though WordPress is the user framework.');
 262       }
 263       if (!defined('ABSPATH')) {
 264         throw new \Exception('Constant "ABSPATH" is not defined, even though WordPress is the user framework.');
 265       }
 266       if (is_admin()) {
 267         require_once ABSPATH . 'wp-admin/admin-header.php';
 268       }
 269       else {
 270         // FIXME: we need to figure out to replace civicrm content on the frontend pages
 271       }
 272     }
 273
 274     if ($ret) {
 275       return $out;
 276     }
 277     else {
 278       print $out;
 279       return NULL;
 280     }
 281   }
 282
 283   /**
 284    * @return string
 285    */
 286   public function getDefaultBlockLocation() {
 287     return 'left';
 288   }
 289
 290   public function getAbsoluteBaseURL() {
 291     if (!defined('CIVICRM_UF_BASEURL')) {
 292       return FALSE;
 293     }
 294
 295     $url = CRM_Utils_File::addTrailingSlash(CIVICRM_UF_BASEURL, '/');
 296
 297     //format url for language negotiation, CRM-7803
 298     $url = $this->languageNegotiationURL($url);
 299
 300     if (CRM_Utils_System::isSSL()) {
 301       $url = str_replace('http://', 'https://', $url);
 302     }
 303
 304     return $url;
 305   }
 306
 307   public function getRelativeBaseURL() {
 308     $absoluteBaseURL = $this->getAbsoluteBaseURL();
 309     if ($absoluteBaseURL === FALSE) {
 310       return FALSE;
 311     }
 312     $parts = parse_url($absoluteBaseURL);
 313     return $parts['path'];
 314     //$this->useFrameworkRelativeBase = empty($base['path']) ? '/' : $base['path'];
 315   }
 316
 317   /**
 318    * Get CMS Version.
 319    *
 320    * @return string
 321    */
 322   public function getVersion() {
 323     return 'Unknown';
 324   }
 325
 326   /**
 327    * Format the url as per language Negotiation.
 328    *
 329    * @param string $url
 330    * @param bool $addLanguagePart
 331    * @param bool $removeLanguagePart
 332    *
 333    * @return string
 334    *   Formatted url.
 335    */
 336   public function languageNegotiationURL(
 337     $url,
 338     $addLanguagePart = TRUE,
 339     $removeLanguagePart = FALSE
 340   ) {
 341     return $url;
 342   }
 343
 344   /**
 345    * Determine the location of the CMS root.
 346    *
 347    * @return string|null
 348    *   Local file system path to CMS root, or NULL if it cannot be determined
 349    */
 350   public function cmsRootPath() {
 351     return NULL;
 352   }
 353
 354   /**
 355    * Create a user in the CMS.
 356    *
 357    * @param array $params
 358    * @param string $mail
 359    *   Email id for cms user.
 360    *
 361    * @return int|bool
 362    *   uid if user exists, false otherwise
 363    */
 364   public function createUser(&$params, $mail) {
 365     return FALSE;
 366   }
 367
 368   /**
 369    * Update a user's email address in the CMS.
 370    *
 371    * @param int $ufID
 372    *   User ID in CMS.
 373    * @param string $email
 374    *   Primary contact email address.
 375    */
 376   public function updateCMSName($ufID, $email) {
 377   }
 378
 379   /**
 380    * Check if user is logged in to the CMS.
 381    *
 382    * @return bool
 383    */
 384   public function isUserLoggedIn() {
 385     return FALSE;
 386   }
 387
 388   /**
 389    * Get user login URL for hosting CMS (method declared in each CMS system class)
 390    *
 391    * @param string $destination
 392    *   If present, add destination to querystring (works for Drupal only).
 393    *
 394    * @return string
 395    *   loginURL for the current CMS
 396    */
 397   public abstract function getLoginURL($destination = '');
 398
 399   /**
 400    * Get the login destination string.
 401    *
 402    * When this is passed in the URL the user will be directed to it after filling in the CMS form.
 403    *
 404    * @param CRM_Core_Form $form
 405    *   Form object representing the 'current' form - to which the user will be returned.
 406    *
 407    * @return string|NULL
 408    *   destination value for URL
 409    */
 410   public function getLoginDestination(&$form) {
 411     return NULL;
 412   }
 413
 414   /**
 415    * Determine the native ID of the CMS user.
 416    *
 417    * @param string $username
 418    *
 419    * @throws CRM_Core_Exception
 420    */
 421   public function getUfId($username) {
 422     $className = get_class($this);
 423     throw new CRM_Core_Exception("Not implemented: {$className}->getUfId");
 424   }
 425
 426   public function setUFLocale($civicrm_language) {
 427     return TRUE;
 428   }
 429
 430   /**
 431    * Set a init session with user object.
 432    *
 433    * @param array $data
 434    *   Array with user specific data
 435    */
 436   public function setUserSession($data) {
 437     list($userID, $ufID) = $data;
 438     $session = CRM_Core_Session::singleton();
 439     $session->set('ufID', $ufID);
 440     $session->set('userID', $userID);
 441   }
 442
 443   /**
 444    * Reset any system caches that may be required for proper CiviCRM integration.
 445    */
 446   public function flush() {
 447     // nullop by default
 448   }
 449
 450   /**
 451    * Flush css/js caches.
 452    */
 453   public function clearResourceCache() {
 454     // nullop by default
 455   }
 456
 457   /**
 458    * Add a script file.
 459    *
 460    * Note: This function is not to be called directly
 461    * @see CRM_Core_Region::render()
 462    *
 463    * @param string $url absolute path to file
 464    * @param string $region
 465    *   location within the document: 'html-header', 'page-header', 'page-footer'.
 466    *
 467    * @return bool
 468    *   TRUE if we support this operation in this CMS, FALSE otherwise
 469    */
 470   public function addScriptUrl($url, $region) {
 471     return FALSE;
 472   }
 473
 474   /**
 475    * Add an inline script.
 476    *
 477    * Note: This function is not to be called directly
 478    * @see CRM_Core_Region::render()
 479    *
 480    * @param string $code javascript code
 481    * @param string $region
 482    *   location within the document: 'html-header', 'page-header', 'page-footer'.
 483    *
 484    * @return bool
 485    *   TRUE if we support this operation in this CMS, FALSE otherwise
 486    */
 487   public function addScript($code, $region) {
 488     return FALSE;
 489   }
 490
 491   /**
 492    * Add a css file.
 493    *
 494    * Note: This function is not to be called directly
 495    * @see CRM_Core_Region::render()
 496    *
 497    * @param string $url absolute path to file
 498    * @param string $region
 499    *   location within the document: 'html-header', 'page-header', 'page-footer'.
 500    *
 501    * @return bool
 502    *   TRUE if we support this operation in this CMS, FALSE otherwise
 503    */
 504   public function addStyleUrl($url, $region) {
 505     return FALSE;
 506   }
 507
 508   /**
 509    * Add an inline style.
 510    *
 511    * Note: This function is not to be called directly
 512    * @see CRM_Core_Region::render()
 513    *
 514    * @param string $code css code
 515    * @param string $region
 516    *   location within the document: 'html-header', 'page-header', 'page-footer'.
 517    *
 518    * @return bool
 519    *   TRUE if we support this operation in this CMS, FALSE otherwise
 520    */
 521   public function addStyle($code, $region) {
 522     return FALSE;
 523   }
 524
 525   /**
 526    * Sets the title of the page.
 527    *
 528    * @param string $title
 529    *   Title to set in html header
 530    * @param string|null $pageTitle
 531    *   Title to set in html body (if different)
 532    */
 533   public function setTitle($title, $pageTitle = NULL) {
 534   }
 535
 536   /**
 537    * Return default Site Settings.
 538    *
 539    * @param string $dir
 540    *
 541    * @return array
 542    *   - $url, (Joomla - non admin url)
 543    *   - $siteName,
 544    *   - $siteRoot
 545    */
 546   public function getDefaultSiteSettings($dir) {
 547     $config = CRM_Core_Config::singleton();
 548     $url = $config->userFrameworkBaseURL;
 549     return array($url, NULL, NULL);
 550   }
 551
 552   /**
 553    * Determine the default location for file storage.
 554    *
 555    * FIXME:
 556    *  1. This was pulled out from a bigger function. It should be split
 557    *     into even smaller pieces and marked abstract.
 558    *  2. This would be easier to compute by a calling a CMS API, but
 559    *     for whatever reason Civi gets it from config data.
 560    *
 561    * @return array
 562    *   - url: string. ex: "http://example.com/sites/foo.com/files/civicrm"
 563    *   - path: string. ex: "/var/www/sites/foo.com/files/civicrm"
 564    */
 565   public function getDefaultFileStorage() {
 566     global $civicrm_root;
 567     $config = CRM_Core_Config::singleton();
 568     $baseURL = CRM_Utils_System::languageNegotiationURL($config->userFrameworkBaseURL, FALSE, TRUE);
 569
 570     $filesURL = NULL;
 571     $filesPath = NULL;
 572
 573     if ($config->userFramework == 'Joomla') {
 574       // gross hack
 575       // we need to remove the administrator/ from the end
 576       $tempURL = str_replace("/administrator/", "/", $baseURL);
 577       $filesURL = $tempURL . "media/civicrm/";
 578     }
 579     elseif ($this->is_drupal) {
 580       $siteName = $config->userSystem->parseDrupalSiteName($civicrm_root);
 581       if ($siteName) {
 582         $filesURL = $baseURL . "sites/$siteName/files/civicrm/";
 583       }
 584       else {
 585         $filesURL = $baseURL . "sites/default/files/civicrm/";
 586       }
 587     }
 588     elseif ($config->userFramework == 'UnitTests') {
 589       $filesURL = $baseURL . "sites/default/files/civicrm/";
 590     }
 591     else {
 592       throw new CRM_Core_Exception("Failed to locate default file storage ($config->userFramework)");
 593     }
 594
 595     return array(
 596       'url' => $filesURL,
 597       'path' => CRM_Utils_File::baseFilePath(),
 598     );
 599   }
 600
 601   /**
 602    * Determine the location of the CiviCRM source tree.
 603    *
 604    * FIXME:
 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 we take the hard way.
 609    *
 610    * @return array
 611    *   - url: string. ex: "http://example.com/sites/all/modules/civicrm"
 612    *   - path: string. ex: "/var/www/sites/all/modules/civicrm"
 613    */
 614   public function getCiviSourceStorage() {
 615     global $civicrm_root;
 616     $config = CRM_Core_Config::singleton();
 617
 618     // Don't use $config->userFrameworkBaseURL; it has garbage on it.
 619     // More generally, w shouldn't be using $config here.
 620     if (!defined('CIVICRM_UF_BASEURL')) {
 621       throw new RuntimeException('Undefined constant: CIVICRM_UF_BASEURL');
 622     }
 623     $baseURL = CRM_Utils_File::addTrailingSlash(CIVICRM_UF_BASEURL, '/');
 624     if (CRM_Utils_System::isSSL()) {
 625       $baseURL = str_replace('http://', 'https://', $baseURL);
 626     }
 627
 628     if ($config->userFramework == 'Joomla') {
 629       $userFrameworkResourceURL = $baseURL . "components/com_civicrm/civicrm/";
 630     }
 631     elseif ($config->userFramework == 'WordPress') {
 632       $userFrameworkResourceURL = CIVICRM_PLUGIN_URL . "civicrm/";
 633     }
 634     elseif ($this->is_drupal) {
 635       // Drupal setting
 636       // check and see if we are installed in sites/all (for D5 and above)
 637       // we dont use checkURL since drupal generates an error page and throws
 638       // the system for a loop on lobo's macosx box
 639       // or in modules
 640       $cmsPath = $config->userSystem->cmsRootPath();
 641       $userFrameworkResourceURL = $baseURL . str_replace("$cmsPath/", '',
 642           str_replace('\\', '/', $civicrm_root)
 643         );
 644
 645       $siteName = $config->userSystem->parseDrupalSiteName($civicrm_root);
 646       if ($siteName) {
 647         $civicrmDirName = trim(basename($civicrm_root));
 648         $userFrameworkResourceURL = $baseURL . "sites/$siteName/modules/$civicrmDirName/";
 649       }
 650     }
 651     else {
 652       $userFrameworkResourceURL = NULL;
 653     }
 654
 655     return array(
 656       'url' => CRM_Utils_File::addTrailingSlash($userFrameworkResourceURL),
 657       'path' => CRM_Utils_File::addTrailingSlash($civicrm_root),
 658     );
 659   }
 660
 661   /**
 662    * Perform any post login activities required by the CMS.
 663    *
 664    * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
 665    * calls hook_user op 'login' and generates a new session.
 666    *
 667    * @param array $params
 668    *
 669    * FIXME: Document values accepted/required by $params
 670    */
 671   public function userLoginFinalize($params = array()) {
 672   }
 673
 674   /**
 675    * Set timezone in mysql so that timestamp fields show the correct time.
 676    */
 677   public function setMySQLTimeZone() {
 678     $timeZoneOffset = $this->getTimeZoneOffset();
 679     if ($timeZoneOffset) {
 680       $sql = "SET time_zone = '$timeZoneOffset'";
 681       CRM_Core_DAO::executequery($sql);
 682     }
 683   }
 684
 685
 686   /**
 687    * Get timezone from CMS.
 688    *
 689    * @return string|false|null
 690    */
 691   public function getTimeZoneOffset() {
 692     $timezone = $this->getTimeZoneString();
 693     if ($timezone) {
 694       if ($timezone == 'UTC' || $timezone == 'Etc/UTC') {
 695         // CRM-17072 Let's short-circuit all the zero handling & return it here!
 696         return '+00:00';
 697       }
 698       $tzObj = new DateTimeZone($timezone);
 699       $dateTime = new DateTime("now", $tzObj);
 700       $tz = $tzObj->getOffset($dateTime);
 701
 702       if (empty($tz)) {
 703         return FALSE;
 704       }
 705
 706       $timeZoneOffset = sprintf("%02d:%02d", $tz / 3600, abs(($tz / 60) % 60));
 707
 708       if ($timeZoneOffset > 0) {
 709         $timeZoneOffset = '+' . $timeZoneOffset;
 710       }
 711       return $timeZoneOffset;
 712     }
 713     return NULL;
 714   }
 715
 716   /**
 717    * Get timezone as a string.
 718    * @return string
 719    *   Timezone string e.g. 'America/Los_Angeles'
 720    */
 721   public function getTimeZoneString() {
 722     return date_default_timezone_get();
 723   }
 724
 725   /**
 726    * Get Unique Identifier from UserFramework system (CMS).
 727    *
 728    * @param object $user
 729    *   Object as described by the User Framework.
 730    *
 731    * @return mixed
 732    *   Unique identifier from the user Framework system
 733    */
 734   public function getUniqueIdentifierFromUserObject($user) {
 735     return NULL;
 736   }
 737
 738   /**
 739    * Get User ID from UserFramework system (CMS).
 740    *
 741    * @param object $user
 742    *
 743    *   Object as described by the User Framework.
 744    * @return null|int
 745    */
 746   public function getUserIDFromUserObject($user) {
 747     return NULL;
 748   }
 749
 750   /**
 751    * Get an array of user details for a contact, containing at minimum the user ID & name.
 752    *
 753    * @param int $contactID
 754    *
 755    * @return array
 756    *   CMS user details including
 757    *   - id
 758    *   - name (ie the system user name.
 759    */
 760   public function getUser($contactID) {
 761     $ufMatch = civicrm_api3('UFMatch', 'getsingle', array(
 762       'contact_id' => $contactID,
 763       'domain_id' => CRM_Core_Config::domainID(),
 764     ));
 765     return array(
 766       'id' => $ufMatch['uf_id'],
 767       'name' => $ufMatch['uf_name'],
 768     );
 769   }
 770
 771   /**
 772    * Get currently logged in user uf id.
 773    *
 774    * @return int|null
 775    *   logged in user uf id.
 776    */
 777   public function getLoggedInUfID() {
 778     return NULL;
 779   }
 780
 781   /**
 782    * Get currently logged in user unique identifier - this tends to be the email address or user name.
 783    *
 784    * @return string|null
 785    *   logged in user unique identifier
 786    */
 787   public function getLoggedInUniqueIdentifier() {
 788     return NULL;
 789   }
 790
 791   /**
 792    * Return a UFID (user account ID from the UserFramework / CMS system.
 793    *
 794    * ID is based on the user object passed, defaulting to the logged in user if not passed.
 795    *
 796    * Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would
 797    * seem to be resolving the user id before calling the function.
 798    *
 799    * Note there is already a function getUFId which takes $username as a param - we could add $user
 800    * as a second param to it but it seems messy - just overloading it because the name is taken.
 801    *
 802    * @param object $user
 803    *
 804    * @return int
 805    *   User ID of UF System
 806    */
 807   public function getBestUFID($user = NULL) {
 808     if ($user) {
 809       return $this->getUserIDFromUserObject($user);
 810     }
 811     return $this->getLoggedInUfID();
 812   }
 813
 814   /**
 815    * Return a unique identifier (usually an email address or username) from the UserFramework / CMS system.
 816    *
 817    * This is based on the user object passed, defaulting to the logged in user if not passed.
 818    *
 819    * Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be
 820    * resolving the unique identifier before calling the function.
 821    *
 822    * @param object $user
 823    *
 824    * @return string
 825    *   unique identifier from the UF System
 826    */
 827   public function getBestUFUniqueIdentifier($user = NULL) {
 828     if ($user) {
 829       return $this->getUniqueIdentifierFromUserObject($user);
 830     }
 831     return $this->getLoggedInUniqueIdentifier();
 832   }
 833
 834   /**
 835    * List modules installed in the CMS, including enabled and disabled ones.
 836    *
 837    * @return array
 838    *   [CRM_Core_Module]
 839    */
 840   public function getModules() {
 841     return array();
 842   }
 843
 844   /**
 845    * Get Url to view user record.
 846    *
 847    * @param int $contactID
 848    *   Contact ID.
 849    *
 850    * @return string|null
 851    */
 852   public function getUserRecordUrl($contactID) {
 853     return NULL;
 854   }
 855
 856   /**
 857    * Is the current user permitted to add a user.
 858    *
 859    * @return bool
 860    */
 861   public function checkPermissionAddUser() {
 862     return FALSE;
 863   }
 864
 865   /**
 866    * Output code from error function.
 867    *
 868    * @param string $content
 869    */
 870   public function outputError($content) {
 871     echo CRM_Utils_System::theme($content);
 872   }
 873
 874   /**
 875    * Log error to CMS.
 876    *
 877    * @param string $message
 878    */
 879   public function logger($message) {
 880   }
 881
 882   /**
 883    * Append to coreResourcesList.
 884    *
 885    * @param array $list
 886    */
 887   public function appendCoreResources(&$list) {
 888   }
 889
 890   /**
 891    * @param string $name
 892    * @param string $value
 893    */
 894   public function setHttpHeader($name, $value) {
 895     header("$name: $value");
 896   }
 897
 898   /**
 899    * Create CRM contacts for all existing CMS users
 900    *
 901    * @return array
 902    * @throws \Exception
 903    */
 904   public function synchronizeUsers() {
 905     throw new Exception('CMS user creation not supported for this framework');
 906     return array();
 907   }
 908
 909 }