Session.php 6.83 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1 2 3 4
<?php
/**
 * Table Definition for session
 *
5
 * StatusNet - the distributed open-source microblogging tool
6
 * Copyright (C) 2009, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

22
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
Evan Prodromou's avatar
Evan Prodromou committed
23 24 25

require_once INSTALLDIR.'/classes/Memcached_DataObject.php';

26
class Session extends Managed_DataObject
Evan Prodromou's avatar
Evan Prodromou committed
27 28 29 30 31 32 33 34 35 36 37 38
{
    ###START_AUTOCODE
    /* the code below is auto generated do not remove the above tag */

    public $__table = 'session';                         // table name
    public $id;                              // varchar(32)  primary_key not_null
    public $session_data;                    // text()
    public $created;                         // datetime()   not_null
    public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP

    /* the code above is auto generated do not remove the tag below */
    ###END_AUTOCODE
39

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
    public static function schemaDef()
    {
        return array(
            'fields' => array(
                'id' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'session ID'),
                'session_data' => array('type' => 'text', 'description' => 'session data'),
                'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
                'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
            ),
            'primary key' => array('id'),
            'indexes' => array(
                'session_modified_idx' => array('modified'),
            ),
        );
    }

56 57
    static function logdeb($msg)
    {
Evan Prodromou's avatar
Evan Prodromou committed
58 59 60
        if (common_config('sessions', 'debug')) {
            common_debug("Session: " . $msg);
        }
61 62
    }

63 64 65 66 67 68 69 70 71 72 73 74
    static function open($save_path, $session_name)
    {
        return true;
    }

    static function close()
    {
        return true;
    }

    static function read($id)
    {
75 76
        self::logdeb("Fetching session '$id'");

77
        $session = Session::getKV('id', $id);
78 79

        if (empty($session)) {
80
            self::logdeb("Couldn't find '$id'");
81 82
            return '';
        } else {
83 84 85
            self::logdeb("Found '$id', returning " .
                         strlen($session->session_data) .
                         " chars of data");
86 87 88 89 90 91
            return (string)$session->session_data;
        }
    }

    static function write($id, $session_data)
    {
92 93
        self::logdeb("Writing session '$id'");

94
        $session = Session::getKV('id', $id);
95 96

        if (empty($session)) {
97
            self::logdeb("'$id' doesn't yet exist; inserting.");
98 99 100 101 102 103
            $session = new Session();

            $session->id           = $id;
            $session->session_data = $session_data;
            $session->created      = common_sql_now();

104 105 106 107 108 109 110 111 112
            $result = $session->insert();

            if (!$result) {
                common_log_db_error($session, 'INSERT', __FILE__);
                self::logdeb("Failed to insert '$id'.");
            } else {
                self::logdeb("Successfully inserted '$id' (result = $result).");
            }
            return $result;
113
        } else {
114
            self::logdeb("'$id' already exists; updating.");
115 116 117 118 119 120 121 122 123
            if (strcmp($session->session_data, $session_data) == 0) {
                self::logdeb("Not writing session '$id'; unchanged");
                return true;
            } else {
                self::logdeb("Session '$id' data changed; updating");

                $orig = clone($session);

                $session->session_data = $session_data;
124

125 126 127 128 129 130 131 132 133 134
                $result = $session->update($orig);

                if (!$result) {
                    common_log_db_error($session, 'UPDATE', __FILE__);
                    self::logdeb("Failed to update '$id'.");
                } else {
                    self::logdeb("Successfully updated '$id' (result = $result).");
                }

                return $result;
135
            }
136 137 138 139 140
        }
    }

    static function destroy($id)
    {
141 142
        self::logdeb("Deleting session $id");

143
        $session = Session::getKV('id', $id);
144

145 146 147 148 149 150 151 152 153 154 155
        if (empty($session)) {
            self::logdeb("Can't find '$id' to delete.");
        } else {
            $result = $session->delete();
            if (!$result) {
                common_log_db_error($session, 'DELETE', __FILE__);
                self::logdeb("Failed to delete '$id'.");
            } else {
                self::logdeb("Successfully deleted '$id' (result = $result).");
            }
            return $result;
156 157 158 159 160
        }
    }

    static function gc($maxlifetime)
    {
161 162
        self::logdeb("garbage collection (maxlifetime = $maxlifetime)");

Evan Prodromou's avatar
Evan Prodromou committed
163
        $epoch = common_sql_date(time() - $maxlifetime);
164

165 166
        $ids = array();

167
        $session = new Session();
Evan Prodromou's avatar
Evan Prodromou committed
168
        $session->whereAdd('modified < "'.$epoch.'"');
169 170
        $session->selectAdd();
        $session->selectAdd('id');
171

172 173 174 175 176 177 178
        $limit = common_config('sessions', 'gc_limit');
        if ($limit > 0) {
            // On large sites, too many sessions to expire
            // at once will just result in failure.
            $session->limit($limit);
        }

179 180 181
        $session->find();

        while ($session->fetch()) {
182
            $ids[] = $session->id;
183 184 185
        }

        $session->free();
186

187 188
        self::logdeb("Found " . count($ids) . " ids to delete.");

189
        foreach ($ids as $id) {
190
            self::logdeb("Destroying session '$id'.");
191 192
            self::destroy($id);
        }
193 194 195 196
    }

    static function setSaveHandler()
    {
197 198 199 200
        self::logdeb("setting save handlers");
        $result = session_set_save_handler('Session::open', 'Session::close', 'Session::read',
                                           'Session::write', 'Session::destroy', 'Session::gc');
        self::logdeb("save handlers result = $result");
201 202 203 204 205 206 207

        // PHP 5.3 with APC ends up destroying a bunch of object stuff before the session
        // save handlers get called on request teardown.
        // Registering an explicit shutdown function should take care of this before
        // everything breaks on us.
        register_shutdown_function('Session::cleanup');
        
208
        return $result;
209
    }
210 211 212 213 214

    static function cleanup()
    {
        session_write_close();
    }
Evan Prodromou's avatar
Evan Prodromou committed
215
}