session.php 9.5 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
5
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
6
 *
Francois Marier's avatar
Francois Marier committed
7
8
9
10
 * 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 3 of the License, or
 * (at your option) any later version.
11
 *
Francois Marier's avatar
Francois Marier committed
12
13
14
15
 * 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.
16
 *
Francois Marier's avatar
Francois Marier committed
17
18
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20
 *
 * @package    mahara
Nigel McNie's avatar
Nigel McNie committed
21
 * @subpackage core
22
 * @author     Catalyst IT Ltd
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
25
26
27
28
29
 *
 */

defined('INTERNAL') || die();

30
31
32
//
// Set session settings
//
33
session_name(get_config('cookieprefix') . 'mahara');
34
35
36
37
38
39
40
ini_set('session.save_path', '3;' . get_config('dataroot') . 'sessions');
ini_set('session.gc_divisor', 1000);
// Session timeout is stored in minutes in the database
ini_set('session.gc_maxlifetime', get_config('session_timeout') * 60);
ini_set('session.use_only_cookies', true);
ini_set('session.cookie_path', get_mahara_install_subdirectory());
ini_set('session.cookie_httponly', 1);
41
ini_set('session.hash_bits_per_character', 4);
42
ini_set('session.hash_function', 0);
43
44
45
if (is_https()) {
    ini_set('session.cookie_secure', true);
}
46

47
/**
48
 * The session class handles session data and messages.
49
 *
50
51
52
53
 * This class stores information across page loads, using only a cookie to
 * remember the info. User information is stored in the session so it does
 * not have to be requested each time the page is loaded, however any other
 * information can also be stored using this class.
54
55
56
57
 *
 * This class also is smart about giving out sessions - if a visitor
 * has not logged in (e.g. they are a guest, searchbot or a simple
 * 'curl' request), a session will not be created for them.
58
 *
59
60
 * Messages are stored in the session and are displayed the next time
 * a page is displayed to a user, even over multiple requests.
61
62
63
 */
class Session {

64
    /**
65
     * Resumes an existing session, only if there is one
66
     */
67
    private function __construct() {
68
        // Resume an existing session if required
69
        if (isset($_COOKIE[session_name()])) {
70
            @session_start();
71
72
73
        }
    }

74
75
76
77
78
79
80
81
82
83
84
85
    /**
     * Singelton function keeps us from generating multiple instances of this
     * class
     *
     * @return object   The class instance
     * @access public
     */
    public static function singleton() {
        //single instance
        static $instance;

        //if we don't have the single instance, create one
86
        if (!isset($instance)) {
87
88
89
90
91
            $instance = new Session();
        }
        return($instance);
    }

92
93
94
95
96
97
98
99
100
101
    /**
     * Gets the session property keyed by $key.
     *
     * @param string $key The key to get the value of
     * @return mixed
     */
    public function get($key) {
        if (isset($_SESSION[$key])) {
            return $_SESSION[$key];
        }
Penny Leach's avatar
Penny Leach committed
102
103
104
        return null;
    }

105
106
107
108
109
110
111
    /**
     * Sets the session property keyed by $key.
     *
     * @param string $key   The key to set.
     * @param string $value The value to set for the key
     */
    public function set($key, $value) {
112
        $this->ensure_session();
113
        $_SESSION[$key] = $value;
114
115
    }

Martyn Smith's avatar
Martyn Smith committed
116
117
118
119
120
    /**
     * Clears the session property keyed by $key (by setting it to null).
     *
     * @param string $key   The key to set.
     */
Martyn Smith's avatar
Martyn Smith committed
121
    public function clear($key) {
Martyn Smith's avatar
Martyn Smith committed
122
123
124
125
        $this->ensure_session();
        $_SESSION[$key] = null;
    }

126
127
128
129
130
131
132
    /**
     * Adds a message that indicates something was successful
     *
     * @param string $message The message to add
     * @param boolean $escape Whether to HTML escape the message
     */
    public function add_ok_msg($message, $escape=true) {
133
        $this->ensure_session();
134
        if ($escape) {
135
            $message = self::escape_message($message);
136
137
138
139
140
141
142
143
144
145
146
        }
        $_SESSION['messages'][] = array('type' => 'ok', 'msg' => $message);
    }

    /**
     * Adds a message that indicates an informational message
     *
     * @param string $message The message to add
     * @param boolean $escape Whether to HTML escape the message
     */
    public function add_info_msg($message, $escape=true) {
147
        $this->ensure_session();
148
        if ($escape) {
149
            $message = self::escape_message($message);
150
151
152
153
154
155
156
157
158
159
        }
        $_SESSION['messages'][] = array('type' => 'info', 'msg' => $message);
    }

    /**
     * Adds a message that indicates a failure to do something
     *
     * @param string $message The message to add
     * @param boolean $escape Whether to HTML escape the message
     */
160
    public function add_error_msg($message, $escape=true) {
161
        $this->ensure_session();
162
        if ($escape) {
163
            $message = self::escape_message($message);
164
        }
165
        $_SESSION['messages'][] = array('type' => 'error', 'msg' => $message);
166
167
168
169
170
171
172
173
174
175
176
177
178
    }

    /**
     * Builds HTML that represents all of the messages and returns it.
     *
     * This is designed to let smarty templates hook in any session messages.
     *
     * Calling this function will destroy the session messages that were
     * rendered, so they do not inadvertently get displayed again.
     *
     * @return string The HTML representing all of the session messages.
     */
    public function render_messages() {
179
        global $THEME;
180
        $result = '<div id="messages">';
181
182
        if (isset($_SESSION['messages'])) {
            foreach ($_SESSION['messages'] as $data) {
183
184
                $result .= '<div class="' . $data['type'] . '"><div>';
                $result .= $data['msg'] . '</div></div>';
185
            }
186
            $_SESSION['messages'] = array();
187
        }
188
        $result .= '</div>';
189
190
191
        return $result;
    }

192
    /**
193
     * Create a session, by initialising the $_SESSION array.
194
     */
195
196
197
    private function ensure_session() {
        if (empty($_SESSION)) {
            if (!session_id()) {
198
                @session_start();
199
200
201
202
            }
            $_SESSION = array(
                'messages' => array()
            );
203
        }
204
205
    }

206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    /**
     * Destroy a session
     */
    public function destroy_session() {
        if ($this->is_live()) {
            $_SESSION = array();
            if (isset($_COOKIE[session_name()])) {
                setcookie(session_name(), '', time() - 65536,
                    ini_get('session.cookie_path'),
                    ini_get('session.cookie_domain'),
                    ini_get('session.cookie_secure'),
                    ini_get('session.cookie_httponly')
                );
            }
            session_destroy();
        }
    }

224
225
226
227
228
229
230
231
232
233
    /**
     * Find out if the session has been started yet
     */
    public function is_live() {
        if ("" == session_id()) {
            return false;
        }
        return true;
    }

234
235
236
237
238
239
240
241
242
243
    /**
     * Escape a message for HTML output
     * 
     * @param string $message The message to escape
     * @return string         The message, escaped for output as HTML
     */
    private static function escape_message($message) {
        $message = hsc($message);
        $message = str_replace('  ', '&nbsp; ', $message);
        return $message;
244
    }
245

246
247
248
249
250
251
252
253
254
255
256
257
}

/**
 * A smarty callback to insert page messages
 *
 * @return string The HTML represening all of the session messages.
 */
function insert_messages() {
    global $SESSION;
    return $SESSION->render_messages();
}

258

259
260
261
262
/**
 * Delete all sessions belonging to a given user except for the current one
 */
function remove_user_sessions($userid) {
263
264
    global $sessionpath, $USER;

265
    $sessionids = get_column('usr_session', 'session', 'usr', (int) $userid);
266
267

    if (empty($sessionids)) {
268
269
270
271
272
        return;
    }

    $alive = array();
    $dead = array();
273
    $sid = $USER->get('sessionid');
274
    foreach ($sessionids as $sessionid) {
275
276
277
        if ($sessionid == $sid) {
            continue;
        }
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
        $file = $sessionpath;
        for ($i = 0; $i < 3; $i++) {
            $file .= '/' . substr($sessionid, $i, 1);
        }
        $file .= '/sess_' . $sessionid;
        if (file_exists($file)) {
            $alive[] = $sessionid;
        }
        else {
            $dead[] = $sessionid;
        }
    }

    if (!empty($dead)) {
        delete_records_select('usr_session', 'session IN (' . join(',', array_map('db_quote', $dead)) . ')');
    }

    if (empty($alive)) {
        return;
    }

    session_commit();

    foreach ($alive as $sessionid) {
        session_id($sessionid);
        if (session_start()) {
            session_destroy();
            session_commit();
        }
    }

    session_id($sid);
    session_start();

    delete_records_select('usr_session', 'session IN (' . join(',', array_map('db_quote', $alive)) . ')');
}

315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
/**
 * Delete all session files except for the current one
 */
function remove_all_sessions() {
    global $sessionpath, $USER;

    $sid = $USER->get('sessionid');

    $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($sessionpath));
    foreach ($iterator as $path) {
        if ($path->isFile() && $path->getFilename() !== ('sess_' . $sid)) {
            @unlink($path->getPathname());
        }
    }
    clearstatcache();

    delete_records_select('usr_session', 'session != ?', array($sid));
}