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    * Deprecated property to check if this is a drupal install. The correct method is to have functions on the UF classes for all UF specific
   9    * functions and leave the codebase oblivious to the type of CMS
  10    *
  11    * @deprecated
  12    * @var bool
  13    *   TRUE, if the CMS is Drupal.
  14    */
  15   var $is_drupal = FALSE;
  16
  17   /**
  18    * 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
  19    * functions and leave the codebase oblivious to the type of CMS
  20    *
  21    * @deprecated
  22    * @var bool
  23    *   TRUE, if the CMS is Joomla!.
  24    */
  25   var $is_joomla = FALSE;
  26
  27   /**
  28    * 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
  29    * functions and leave the codebase oblivious to the type of CMS
  30    *
  31    * @deprecated
  32    * @var bool
  33    *   TRUE, if the CMS is WordPress.
  34    */
  35   var $is_wordpress = FALSE;
  36
  37   /**
  38    * Does this CMS / UF support a CMS specific logging mechanism?
  39    * @todo - we should think about offering up logging mechanisms in a way that is also extensible by extensions
  40    * @var bool
  41    */
  42   var $supports_UF_Logging = FALSE;
  43
  44   /**
  45    * @var bool
  46    *   TRUE, if the CMS allows CMS forms to be extended by hooks.
  47    */
  48   var $supports_form_extensions = FALSE;
  49
  50   /**
  51    * If we are using a theming system, invoke theme, else just print the
  52    * content
  53    *
  54    * @param string $content
  55    *   The content that will be themed.
  56    * @param bool $print
  57    *   Are we displaying to the screen or bypassing theming?.
  58    * @param bool $maintenance
  59    *   For maintenance mode.
  60    *
  61    * @throws Exception
  62    * @return string|null
  63    *   NULL, If $print is FALSE, and some other criteria match up.
  64    *   The themed string, otherwise.
  65    *
  66    * @todo The return value is inconsistent.
  67    * @todo Better to always return, and never print.
  68    */
  69   public function theme(&$content, $print = FALSE, $maintenance = FALSE) {
  70     $ret = FALSE;
  71
  72     // TODO: Split up; this was copied verbatim from CiviCRM 4.0's multi-UF theming function
  73     // but the parts should be copied into cleaner subclass implementations
  74     $config = CRM_Core_Config::singleton();
  75     if (
  76       $config->userSystem->is_drupal &&
  77       function_exists('theme') &&
  78       !$print
  79     ) {
  80       if ($maintenance) {
  81         drupal_set_breadcrumb('');
  82         drupal_maintenance_theme();
  83         if ($region = CRM_Core_Region::instance('html-header', FALSE)) {
  84           CRM_Utils_System::addHTMLHead($region->render(''));
  85         }
  86         print theme('maintenance_page', array('content' => $content));
  87         exit();
  88       }
  89       $ret = TRUE; // TODO: Figure out why D7 returns but everyone else prints
  90     }
  91     $out = $content;
  92
  93     $config = &CRM_Core_Config::singleton();
  94     if (
  95       !$print &&
  96       $config->userFramework == 'WordPress'
  97     ) {
  98       if (!function_exists('is_admin')) {
  99         throw new \Exception('Function "is_admin()" is missing, even though WordPress is the user framework.');
 100       }
 101       if (!defined('ABSPATH')) {
 102         throw new \Exception('Constant "ABSPATH" is not defined, even though WordPress is the user framework.');
 103       }
 104       if (is_admin()) {
 105         require_once ABSPATH . 'wp-admin/admin-header.php';
 106       }
 107       else {
 108         // FIXME: we need to figure out to replace civicrm content on the frontend pages
 109       }
 110     }
 111
 112     if ($ret) {
 113       return $out;
 114     }
 115     else {
 116       print $out;
 117       return NULL;
 118     }
 119   }
 120
 121   /**
 122    * @return string
 123    */
 124   public function getDefaultBlockLocation() {
 125     return 'left';
 126   }
 127
 128   /**
 129    * @return string
 130    */
 131   public function getVersion() {
 132     return 'Unknown';
 133   }
 134
 135   /**
 136    * Format the url as per language Negotiation.
 137    *
 138    * @param string $url
 139    * @param bool $addLanguagePart
 140    * @param bool $removeLanguagePart
 141    *
 142    * @return string
 143    *   Formatted url.
 144    */
 145   public function languageNegotiationURL(
 146     $url,
 147     $addLanguagePart = TRUE,
 148     $removeLanguagePart = FALSE
 149   ) {
 150     return $url;
 151   }
 152
 153   /**
 154    * Determine the location of the CMS root.
 155    *
 156    * @return string|null
 157    *   Local file system path to CMS root, or NULL if it cannot be determined
 158    */
 159   public function cmsRootPath() {
 160     return NULL;
 161   }
 162
 163   /**
 164    * Get user login URL for hosting CMS (method declared in each CMS system class)
 165    *
 166    * @param string $destination
 167    *   If present, add destination to querystring (works for Drupal only).
 168    *
 169    * @return string
 170    *   loginURL for the current CMS
 171    */
 172   public abstract function getLoginURL($destination = '');
 173
 174   /**
 175    * Determine the native ID of the CMS user
 176    *
 177    * @param string $username
 178    *
 179    * @throws CRM_Core_Exception
 180    * @return;
 181    */
 182   public function getUfId($username) {
 183     $className = get_class($this);
 184     throw new CRM_Core_Exception("Not implemented: {$className}->getUfId");
 185   }
 186
 187   /**
 188    * Set a init session with user object
 189    *
 190    * @param array $data
 191    *   Array with user specific data
 192    */
 193   public function setUserSession($data) {
 194     list($userID, $ufID) = $data;
 195     $session = CRM_Core_Session::singleton();
 196     $session->set('ufID', $ufID);
 197     $session->set('userID', $userID);
 198   }
 199
 200   /**
 201    * Reset any system caches that may be required for proper CiviCRM
 202    * integration.
 203    */
 204   public function flush() {
 205     // nullop by default
 206   }
 207
 208   /**
 209    * Flush css/js caches
 210    */
 211   public function clearResourceCache() {
 212     // nullop by default
 213   }
 214
 215   /**
 216    * Return default Site Settings
 217    *
 218    * @param string $dir
 219    *
 220    * @return array
 221    *   - $url, (Joomla - non admin url)
 222    *   - $siteName,
 223    *   - $siteRoot
 224    */
 225   public function getDefaultSiteSettings($dir) {
 226     $config = CRM_Core_Config::singleton();
 227     $url = $config->userFrameworkBaseURL;
 228     return array($url, NULL, NULL);
 229   }
 230
 231   /**
 232    * Perform any post login activities required by the CMS -
 233    * e.g. for drupal: records a watchdog message about the new session, saves the login timestamp,
 234    * calls hook_user op 'login' and generates a new session.
 235    *
 236    * @param array $params
 237    *
 238    * FIXME: Document values accepted/required by $params
 239    */
 240   public function userLoginFinalize($params = array()) {
 241   }
 242
 243   /**
 244    * Set timezone in mysql so that timestamp fields show the correct time
 245    */
 246   public function setMySQLTimeZone() {
 247     $timeZoneOffset = $this->getTimeZoneOffset();
 248     if ($timeZoneOffset) {
 249       $sql = "SET time_zone = '$timeZoneOffset'";
 250       CRM_Core_DAO::executequery($sql);
 251     }
 252   }
 253
 254
 255   /**
 256    * Get timezone from CMS
 257    *
 258    * @return string|false|null
 259    */
 260   public function getTimeZoneOffset() {
 261     $timezone = $this->getTimeZoneString();
 262     if ($timezone) {
 263       $tzObj = new DateTimeZone($timezone);
 264       $dateTime = new DateTime("now", $tzObj);
 265       $tz = $tzObj->getOffset($dateTime);
 266
 267       if (empty($tz)) {
 268         return FALSE;
 269       }
 270
 271       $timeZoneOffset = sprintf("%02d:%02d", $tz / 3600, abs(($tz / 60) % 60));
 272
 273       if ($timeZoneOffset > 0) {
 274         $timeZoneOffset = '+' . $timeZoneOffset;
 275       }
 276       return $timeZoneOffset;
 277     }
 278     return NULL;
 279   }
 280
 281   /**
 282    * Over-ridable function to get timezone as a string eg.
 283    *
 284    * @return string
 285    *   Time zone, e.g. 'America/Los_Angeles'
 286    */
 287   public function getTimeZoneString() {
 288     return date_default_timezone_get();
 289   }
 290
 291   /**
 292    * Get Unique Identifier from UserFramework system (CMS)
 293    * @param object $user
 294    *   Object as described by the User Framework.
 295    * @return mixed
 296    *   $uniqueIdentifer Unique identifier from the user Framework system
 297    */
 298   public function getUniqueIdentifierFromUserObject($user) {
 299   }
 300
 301   /**
 302    * Get User ID from UserFramework system (CMS)
 303    * @param object $user
 304    *   Object as described by the User Framework.
 305    * @return mixed
 306    *   <NULL, number>
 307    */
 308   public function getUserIDFromUserObject($user) {
 309   }
 310
 311   /**
 312    * Get currently logged in user uf id.
 313    *
 314    * @return;
 315    *   $userID logged in user uf id.
 316    */
 317   public function getLoggedInUfID() {
 318   }
 319
 320   /**
 321    * Get currently logged in user unique identifier - this tends to be the email address or user name.
 322    *
 323    * @return;
 324    *   logged in user unique identifier
 325    */
 326   public function getLoggedInUniqueIdentifier() {
 327   }
 328
 329   /**
 330    * Return a UFID (user account ID from the UserFramework / CMS system being based on the user object
 331    * passed, defaulting to the logged in user if not passed. Note that ambiguous situation occurs
 332    * in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the user id before calling
 333    * the function
 334    *
 335    * Note there is already a function getUFId which takes $username as a param - we could add $user
 336    * as a second param to it but it seems messy - just overloading it because the name is taken
 337    * @param object $user
 338    * @return int
 339    *   $ufid - user ID of UF System
 340    */
 341   public function getBestUFID($user = NULL) {
 342     if ($user) {
 343       return $this->getUserIDFromUserObject($user);
 344     }
 345     return $this->getLoggedInUfID();
 346   }
 347
 348   /**
 349    * Return a unique identifier (usually an email address or username) from the UserFramework / CMS system being based on the user object
 350    * passed, defaulting to the logged in user if not passed. Note that ambiguous situation occurs
 351    * in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the unique identifier before calling
 352    * the function
 353    *
 354    * @param object $user
 355    * @return string
 356    *   unique identifier from the UF System
 357    */
 358   public function getBestUFUniqueIdentifier($user = NULL) {
 359     if ($user) {
 360       return $this->getUniqueIdentifierFromUserObject($user);
 361     }
 362     return $this->getLoggedInUniqueIdentifier();
 363   }
 364
 365   /**
 366    * Get Url to view user record
 367    * @param int $contactID
 368    *   Contact ID.
 369    *
 370    * @return string
 371    */
 372   public function getUserRecordUrl($contactID) {
 373     return NULL;
 374   }
 375
 376   /**
 377    * Is the current user permitted to add a user
 378    * @return bool
 379    */
 380   public function checkPermissionAddUser() {
 381     return FALSE;
 382   }
 383
 384   /**
 385    * Output code from error function
 386    * @param string $content
 387    */
 388   public function outputError($content) {
 389     echo CRM_Utils_System::theme($content);
 390   }
 391
 392   /**
 393    * Log error to CMS
 394    */
 395   public function logger($message) {
 396
 397   }
 398
 399   /**
 400    * Append to coreResourcesList
 401    */
 402   public function appendCoreResources(&$list) {
 403   }
 404 }