3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
29 require_once "PEAR.php";
32 * Class CRM_Core_Session
34 class CRM_Core_Session
{
37 * Cache of all the session names that we manage
39 static $_managedNames = NULL;
42 * key is used to allow the application to have multiple top
43 * level scopes rather than a single scope. (avoids naming
44 * conflicts). We also extend this idea further and have local
45 * scopes within a global scope. Allows us to do cool things
46 * like resetting a specific area of the session code while
47 * keeping the rest intact
51 protected $_key = 'CiviCRM';
52 CONST USER_CONTEXT
= 'userContext';
55 * This is just a reference to the real session. Allows us to
56 * debug this class a wee bit easier
60 protected $_session = NULL;
63 * We only need one instance of this object. So we use the singleton
64 * pattern and cache the instance in this variable
69 static private $_singleton = NULL;
74 * Since we are now a client / module of drupal, drupal takes care
75 * of initiating the php session handler session_start ().
77 * When using CiviCRM standalone (i.e. w/o Drupal), we start the session
78 * in index.php and then pass it off to here.
80 * All crm code should always use the session using
81 * CRM_Core_Session. we prefix stuff to avoid collisions with drupal and also
82 * collisions with other crm modules!!
83 * This constructor is invoked whenever any module requests an instance of
84 * the session and one is not available.
86 * @return \CRM_Core_Session
88 function __construct() {
89 $this->_session
= null;
93 * singleton function used to manage this object
95 * @return CRM_Core_Session
98 static function &singleton() {
99 if (self
::$_singleton === NULL) {
100 self
::$_singleton = new CRM_Core_Session
;
102 return self
::$_singleton;
106 * Creates an array in the session. All variables now will be stored
109 * @param boolean isRead is this a read operation, in this case, the session will not be touched
115 function initialize($isRead = FALSE) {
116 // lets initialize the _session variable just before we need it
117 // hopefully any bootstrapping code will actually load the session from the CMS
118 if (!isset($this->_session
)) {
120 if (!isset($_SESSION) && PHP_SAPI
!== 'cli') {
124 $config =& CRM_Core_Config
::singleton();
125 if ($config->userSystem
->is_drupal
&& function_exists('drupal_session_start')) {
126 // https://issues.civicrm.org/jira/browse/CRM-14356
127 if (! (isset($GLOBALS['lazy_session']) && $GLOBALS['lazy_session'] == true)) {
128 drupal_session_start();
136 $this->_session
=& $_SESSION;
143 if (!isset($this->_session
[$this->_key
]) ||
144 !is_array($this->_session
[$this->_key
])
146 $this->_session
[$this->_key
] = array();
152 * Resets the session store
160 function reset($all = 1) {
164 // to make certain we clear it, first initialize it to empty
165 $this->_session
[$this->_key
] = array();
166 unset($this->_session
[$this->_key
]);
169 $this->_session
= array();
176 * creates a session local scope
178 * @param string prefix local scope name
179 * @param boolean isRead is this a read operation, in this case, the session will not be touched
185 function createScope($prefix, $isRead = FALSE) {
186 $this->initialize($isRead);
188 if ($isRead ||
empty($prefix)) {
192 if (empty($this->_session
[$this->_key
][$prefix])) {
193 $this->_session
[$this->_key
][$prefix] = array();
198 * resets the session local scope
200 * @param string local scope name
205 function resetScope($prefix) {
208 if (empty($prefix)) {
212 if (array_key_exists($prefix, $this->_session
[$this->_key
])) {
213 unset($this->_session
[$this->_key
][$prefix]);
218 * Store the variable with the value in the session scope
220 * This function takes a name, value pair and stores this
221 * in the session scope. Not sure what happens if we try
222 * to store complex objects in the session. I suspect it
223 * is supported but we need to verify this
227 * @param string $name name of the variable
228 * @param mixed $value value of the variable
229 * @param string $prefix a string to prefix the keys in the session with
234 function set($name, $value = NULL, $prefix = NULL) {
235 // create session scope
236 $this->createScope($prefix);
238 if (empty($prefix)) {
239 $session = &$this->_session
[$this->_key
];
242 $session = &$this->_session
[$this->_key
][$prefix];
245 if (is_array($name)) {
246 foreach ($name as $n => $v) {
251 $session[$name] = $value;
256 * Gets the value of the named variable in the session scope
258 * This function takes a name and retrieves the value of this
259 * variable from the session scope.
263 * @param string name : name of the variable
264 * @param string prefix : adds another level of scope to the session
269 function get($name, $prefix = NULL) {
270 // create session scope
271 $this->createScope($prefix, TRUE);
273 if (empty($this->_session
) ||
empty($this->_session
[$this->_key
])) {
277 if (empty($prefix)) {
278 $session =& $this->_session
[$this->_key
];
281 if (empty($this->_session
[$this->_key
][$prefix])) {
284 $session =& $this->_session
[$this->_key
][$prefix];
287 return CRM_Utils_Array
::value($name, $session);
291 * Gets all the variables in the current session scope
292 * and stuffs them in an associate array
296 * @param array vars : associative array to store name/value pairs
297 * @param string Strip prefix from the key before putting it in the return
302 function getVars(&$vars, $prefix = '') {
303 // create session scope
304 $this->createScope($prefix, TRUE);
306 if (empty($prefix)) {
307 $values = &$this->_session
[$this->_key
];
310 $values = CRM_Core_BAO_Cache
::getItem('CiviCRM Session', "CiviCRM_{$prefix}");
314 foreach ($values as $name => $value) {
315 $vars[$name] = $value;
321 * Set and check a timer. If it's expired, it will be set again.
322 * Good for showing a message to the user every hour or day (so not bugging them on every page)
323 * Returns true-ish values if the timer is not set or expired, and false if the timer is still running
324 * If you want to get more nuanced, you can check the type of the return to see if it's 'not set' or actually expired at a certain time
328 * @param string name : name of the timer
329 * @param int expire : expiry time (in seconds)
334 function timer($name, $expire) {
335 $ts = $this->get($name, 'timer');
336 if (!$ts ||
$ts < time() - $expire) {
337 $this->set($name, time(), 'timer');
338 return $ts ?
$ts : 'not set';
344 * adds a userContext to the stack
346 * @param string $userContext the url to return to when done
347 * @param boolean $check should we do a dupe checking with the top element
354 function pushUserContext($userContext, $check = TRUE) {
355 if (empty($userContext)) {
359 $this->createScope(self
::USER_CONTEXT
);
361 // hack, reset if too big
362 if (count($this->_session
[$this->_key
][self
::USER_CONTEXT
]) > 10) {
363 $this->resetScope(self
::USER_CONTEXT
);
364 $this->createScope(self
::USER_CONTEXT
);
367 $topUC = array_pop($this->_session
[$this->_key
][self
::USER_CONTEXT
]);
369 // see if there is a match between the new UC and the top one. the match needs to be
370 // fuzzy since we use the referer at times
371 // if close enough, lets just replace the top with the new one
372 if ($check && $topUC && CRM_Utils_String
::match($topUC, $userContext)) {
373 array_push($this->_session
[$this->_key
][self
::USER_CONTEXT
], $userContext);
377 array_push($this->_session
[$this->_key
][self
::USER_CONTEXT
], $topUC);
379 array_push($this->_session
[$this->_key
][self
::USER_CONTEXT
], $userContext);
384 * replace the userContext of the stack with the passed one
386 * @param string the url to return to when done
393 function replaceUserContext($userContext) {
394 if (empty($userContext)) {
398 $this->createScope(self
::USER_CONTEXT
);
400 array_pop($this->_session
[$this->_key
][self
::USER_CONTEXT
]);
401 array_push($this->_session
[$this->_key
][self
::USER_CONTEXT
], $userContext);
405 * pops the top userContext stack
409 * @return the top of the userContext stack (also pops the top element)
412 function popUserContext() {
413 $this->createScope(self
::USER_CONTEXT
);
415 return array_pop($this->_session
[$this->_key
][self
::USER_CONTEXT
]);
419 * reads the top userContext stack
423 * @return the top of the userContext stack
426 function readUserContext() {
427 $this->createScope(self
::USER_CONTEXT
);
429 $config = CRM_Core_Config
::singleton();
430 $lastElement = count($this->_session
[$this->_key
][self
::USER_CONTEXT
]) - 1;
431 return $lastElement >= 0 ?
$this->_session
[$this->_key
][self
::USER_CONTEXT
][$lastElement] : $config->userFrameworkBaseURL
;
435 * dumps the session to the log
437 function debug($all = 1) {
440 CRM_Core_Error
::debug('CRM Session', $this->_session
);
443 CRM_Core_Error
::debug('CRM Session', $this->_session
[$this->_key
]);
448 * Fetches status messages
450 * @param $reset boolean should we reset the status variable?
452 * @return string the status message if any
454 function getStatus($reset = FALSE) {
458 if (array_key_exists('status', $this->_session
[$this->_key
])) {
459 $status = $this->_session
[$this->_key
]['status'];
462 $this->_session
[$this->_key
]['status'] = NULL;
463 unset($this->_session
[$this->_key
]['status']);
469 * Stores an alert to be displayed to the user via crm-messages
471 * @param $text string
474 * @param $title string
475 * The optional title of this message
477 * @param $type string
478 * The type of this message (printed as a css class). Possible options:
479 * - 'alert' (default)
482 * - 'error' (this message type by default will remain on the screen
483 * until the user dismisses it)
484 * - 'no-popup' (will display in the document like old-school)
486 * @param $options array
487 * Additional options. Possible values:
488 * - 'unique' (default: true) Check if this message was already set before adding
489 * - 'expires' how long to display this message before fadeout (in ms)
490 * set to 0 for no expiration
491 * defaults to 10 seconds for most messages, 5 if it has a title but no body,
492 * or 0 for errors or messages containing links
498 static function setStatus($text, $title = '', $type = 'alert', $options = array()) {
499 // make sure session is initialized, CRM-8120
500 $session = self
::singleton();
501 $session->initialize();
504 $options +
= array('unique' => TRUE);
506 if (!isset(self
::$_singleton->_session
[self
::$_singleton->_key
]['status'])) {
507 self
::$_singleton->_session
[self
::$_singleton->_key
]['status'] = array();
509 if ($text ||
$title) {
510 if ($options['unique']) {
511 foreach (self
::$_singleton->_session
[self
::$_singleton->_key
]['status'] as $msg) {
512 if ($msg['text'] == $text && $msg['title'] == $title) {
517 unset($options['unique']);
518 self
::$_singleton->_session
[self
::$_singleton->_key
]['status'][] = array(
522 'options' => $options ?
$options : NULL,
530 static function registerAndRetrieveSessionObjects($names) {
531 if (!is_array($names)) {
532 $names = array($names);
535 if (!self
::$_managedNames) {
536 self
::$_managedNames = $names;
539 self
::$_managedNames = array_merge(self
::$_managedNames, $names);
542 CRM_Core_BAO_Cache
::restoreSessionFromCache($names);
548 static function storeSessionObjects($reset = TRUE) {
549 if (empty(self
::$_managedNames)) {
553 self
::$_managedNames = CRM_Utils_Array
::crmArrayUnique(self
::$_managedNames);
555 CRM_Core_BAO_Cache
::storeSessionToCache(self
::$_managedNames, $reset);
557 self
::$_managedNames = NULL;
561 * Retrieve contact id of the logged in user
562 * @return integer | NULL contact ID of logged in user
564 static function getLoggedInContactID() {
565 $session = CRM_Core_Session
::singleton();
566 if (!is_numeric($session->get('userID'))) {
569 return $session->get('userID');
576 // check if session is empty, if so we dont cache
577 // stuff that we can get away with
578 // helps proxies like varnish
579 return empty($_SESSION) ?
TRUE : FALSE;