1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<?php
/**
* Session storage in object cache.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Cache
*/
/**
* Session storage in object cache.
* Used if $wgSessionsInObjectCache is true.
*
* @ingroup Cache
*/
class ObjectCacheSessionHandler {
/**
* Install a session handler for the current web request
*/
static function install() {
session_set_save_handler(
array( __CLASS__, 'open' ),
array( __CLASS__, 'close' ),
array( __CLASS__, 'read' ),
array( __CLASS__, 'write' ),
array( __CLASS__, 'destroy' ),
array( __CLASS__, 'gc' ) );
// It's necessary to register a shutdown function to call session_write_close(),
// because by the time the request shutdown function for the session module is
// called, $wgMemc has already been destroyed. Shutdown functions registered
// this way are called before object destruction.
register_shutdown_function( array( __CLASS__, 'handleShutdown' ) );
}
/**
* Get the cache storage object to use for session storage
*/
static function getCache() {
global $wgSessionCacheType;
return ObjectCache::getInstance( $wgSessionCacheType );
}
/**
* Get a cache key for the given session id.
*
* @param string $id session id
* @return String: cache key
*/
static function getKey( $id ) {
return wfMemcKey( 'session', $id );
}
/**
* Callback when opening a session.
*
* @param $save_path String: path used to store session files, unused
* @param $session_name String: session name
* @return Boolean: success
*/
static function open( $save_path, $session_name ) {
return true;
}
/**
* Callback when closing a session.
* NOP.
*
* @return Boolean: success
*/
static function close() {
return true;
}
/**
* Callback when reading session data.
*
* @param string $id session id
* @return Mixed: session data
*/
static function read( $id ) {
$data = self::getCache()->get( self::getKey( $id ) );
if ( $data === false ) {
return '';
}
return $data;
}
/**
* Callback when writing session data.
*
* @param string $id session id
* @param $data Mixed: session data
* @return Boolean: success
*/
static function write( $id, $data ) {
global $wgObjectCacheSessionExpiry;
self::getCache()->set( self::getKey( $id ), $data, $wgObjectCacheSessionExpiry );
return true;
}
/**
* Callback to destroy a session when calling session_destroy().
*
* @param string $id session id
* @return Boolean: success
*/
static function destroy( $id ) {
self::getCache()->delete( self::getKey( $id ) );
return true;
}
/**
* Callback to execute garbage collection.
* NOP: Object caches perform garbage collection implicitly
*
* @param $maxlifetime Integer: maximum session life time
* @return Boolean: success
*/
static function gc( $maxlifetime ) {
return true;
}
/**
* Shutdown function. See the comment inside ObjectCacheSessionHandler::install
* for rationale.
*/
static function handleShutdown() {
session_write_close();
}
}
|
