Class: CGI::Session::ActiveRecordStore::SqlBypass

Inherits:
Object
  • Object
show all
Defined in:
lib/action_controller/session/active_record_store.rb

Overview

A barebones session store which duck-types with the default session store but bypasses Active Record and issues SQL directly. This is an example session model class meant as a basis for your own classes.

The database connection, table name, and session id and data columns are configurable class attributes. Marshaling and unmarshaling are implemented as class methods that you may override. By default, marshaling data is Base64.encode64(Marshal.dump(data)) and unmarshaling data is Marshal.load(Base64.decode64(data)).

This marshaling behavior is intended to store the widest range of binary session data in a text column. For higher performance, store in a blob column instead and forgo the Base64 encoding.

Constant Summary collapse

@@table_name =
'sessions'
@@session_id_column =
'session_id'
@@data_column =
'data'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes) ⇒ SqlBypass

Look for normal and marshaled data, self.find_by_session_id's way of telling us to postpone unmarshaling until the data is requested. We need to handle a normal data attribute in case of a new record.


214
215
216
217
# File 'lib/action_controller/session/active_record_store.rb', line 214

def initialize(attributes)
  @session_id, @data, @marshaled_data = attributes[:session_id], attributes[:data], attributes[:marshaled_data]
  @new_record = @marshaled_data.nil?
end

Instance Attribute Details

#dataObject

Lazy-unmarshal session state.


224
225
226
227
228
229
230
231
232
233
# File 'lib/action_controller/session/active_record_store.rb', line 224

def data
  unless @data
    if @marshaled_data
      @data, @marshaled_data = self.class.unmarshal(@marshaled_data) || {}, nil
    else
      @data = {}
    end
  end
  @data
end

#session_idObject (readonly)

Returns the value of attribute session_id


208
209
210
# File 'lib/action_controller/session/active_record_store.rb', line 208

def session_id
  @session_id
end

Class Method Details

.connectionObject


179
180
181
# File 'lib/action_controller/session/active_record_store.rb', line 179

def connection
  @@connection ||= ActiveRecord::Base.connection
end

.create_table!Object


193
194
195
196
197
198
199
200
201
# File 'lib/action_controller/session/active_record_store.rb', line 193

def create_table!
  @@connection.execute <<-end_sql
    CREATE TABLE #{table_name} (
      id INTEGER PRIMARY KEY,
      #{@@connection.quote_column_name(session_id_column)} TEXT UNIQUE,
      #{@@connection.quote_column_name(data_column)} TEXT
    )
  end_sql
end

.drop_table!Object


203
204
205
# File 'lib/action_controller/session/active_record_store.rb', line 203

def drop_table!
  @@connection.execute "DROP TABLE #{table_name}"
end

.find_by_session_id(session_id) ⇒ Object

Look up a session by id and unmarshal its data if found.


184
185
186
187
188
# File 'lib/action_controller/session/active_record_store.rb', line 184

def find_by_session_id(session_id)
  if record = @@connection.select_one("SELECT * FROM #{@@table_name} WHERE #{@@session_id_column}=#{@@connection.quote(session_id)}")
    new(:session_id => session_id, :marshaled_data => record['data'])
  end
end

.marshal(data) ⇒ Object


190
# File 'lib/action_controller/session/active_record_store.rb', line 190

def marshal(data)   Base64.encode64(Marshal.dump(data)) if data end

.unmarshal(data) ⇒ Object


191
# File 'lib/action_controller/session/active_record_store.rb', line 191

def unmarshal(data) Marshal.load(Base64.decode64(data)) if data end

Instance Method Details

#destroyObject


262
263
264
265
266
267
268
269
# File 'lib/action_controller/session/active_record_store.rb', line 262

def destroy
  unless @new_record
    @@connection.delete <<-end_sql, 'Destroy session'
      DELETE FROM #{@@table_name}
      WHERE #{@@connection.quote_column_name(@@session_id_column)}=#{@@connection.quote(session_id)}
    end_sql
  end
end

#loaded?Boolean

Returns:

  • (Boolean)

235
236
237
# File 'lib/action_controller/session/active_record_store.rb', line 235

def loaded?
  !! @data
end

#new_record?Boolean

Returns:

  • (Boolean)

219
220
221
# File 'lib/action_controller/session/active_record_store.rb', line 219

def new_record?
  @new_record
end

#saveObject


239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/action_controller/session/active_record_store.rb', line 239

def save
  return false if !loaded?
  marshaled_data = self.class.marshal(data)

  if @new_record
    @new_record = false
    @@connection.update <<-end_sql, 'Create session'
      INSERT INTO #{@@table_name} (
        #{@@connection.quote_column_name(@@session_id_column)},
        #{@@connection.quote_column_name(@@data_column)} )
      VALUES (
        #{@@connection.quote(session_id)},
        #{@@connection.quote(marshaled_data)} )
    end_sql
  else
    @@connection.update <<-end_sql, 'Update session'
      UPDATE #{@@table_name}
      SET #{@@connection.quote_column_name(@@data_column)}=#{@@connection.quote(marshaled_data)}
      WHERE #{@@connection.quote_column_name(@@session_id_column)}=#{@@connection.quote(session_id)}
    end_sql
  end
end