Class: Cyberweb::CGI::Session::FileStore
- Inherits:
-
Object
- Object
- Cyberweb::CGI::Session::FileStore
- Defined in:
- lib/cyberweb/cgi/session/file_store.rb
Overview
#
File-based session storage class.
Implements session storage as a flat file of ‘key=value’ values. This storage type only works directly with String values; the user is responsible for converting other types to Strings when storing and from Strings when retrieving.
#
Instance Method Summary collapse
-
#close ⇒ Object
# === close.
-
#delete ⇒ Object
# === delete.
-
#initialize(session, option = {}) ⇒ FileStore
constructor
# Create a new FileStore instance.
-
#restore ⇒ Object
# === restore.
-
#update ⇒ Object
# === update.
Constructor Details
#initialize(session, option = {}) ⇒ FileStore
#
Create a new FileStore instance.
This constructor is used internally by CGI::Session. The user does not generally need to call it directly.
session
is the session for which this instance is being created. The session id must only contain alphanumeric characters; automatically generated session ids observe this requirement.
option
is a hash of options for the initializer. The following options are recognised:
- tmpdir
-
the directory to use for storing the FileStore file. Defaults to Dir::tmpdir (generally “/tmp” on Unix systems).
- prefix
-
the prefix to add to the session id when generating the filename for this session’s FileStore file. Defaults to “cgi_sid_”.
- suffix
-
the prefix to add to the session id when generating the filename for this session’s FileStore file. Defaults to the empty string.
This session’s FileStore file will be created if it does not exist, or opened if it does.
#
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/cyberweb/cgi/session/file_store.rb', line 47 def initialize(session, option = {}) dir = option['tmpdir'] || Dir::tmpdir prefix = option['prefix'] || 'cgi_sid_' suffix = option['suffix'] || '' id = session.session_id require 'digest/md5' md5 = Digest::MD5.hexdigest(id)[0,16] @path = dir+"/"+prefix+md5+suffix if File::exist? @path @hash = nil else unless session.new_session raise CGI::Session::NoSession, "uninitialized session" end @hash = {} end end |
Instance Method Details
#close ⇒ Object
#
close
Update and close the session’s FileStore file.
#
119 120 121 |
# File 'lib/cyberweb/cgi/session/file_store.rb', line 119 def close update end |
#delete ⇒ Object
#
delete
Close and delete the session’s FileStore file.
#
128 129 130 131 132 |
# File 'lib/cyberweb/cgi/session/file_store.rb', line 128 def delete File.unlink @path+'.lock' rescue nil File.unlink @path+'.new' rescue nil File.unlink @path rescue nil end |
#restore ⇒ Object
#
restore
Restore session state from the session’s FileStore file.
Returns the session state as a hash.
#
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/cyberweb/cgi/session/file_store.rb', line 72 def restore unless @hash @hash = {} begin lockf = File.open(@path+'.lock', 'r') lockf.flock File::LOCK_SH f = File.open(@path, 'r') for line in f line.chomp! k, v = line.split('=',2) @hash[CGI.unescape(k)] = Marshal.restore(CGI.unescape(v)) end ensure f.close unless f.nil? lockf.close if lockf end end @hash end |
#update ⇒ Object
#
update
Save session state to the session’s FileStore file.
#
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/cyberweb/cgi/session/file_store.rb', line 97 def update return unless @hash begin lockf = File.open(@path+".lock", File::CREAT|File::RDWR, 0600) lockf.flock File::LOCK_EX f = File.open(@path+".new", File::CREAT|File::TRUNC|File::WRONLY, 0600) for k,v in @hash f.printf "%s=%s\n", CGI::escape(k), CGI::escape(String(Marshal.dump(v))) end f.close File.rename @path+".new", @path ensure f.close if f and !f.closed? lockf.close if lockf end end |