Class: Cyberweb::CGI::Session::PStore

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberweb/cgi/session/pstore.rb

Overview

#

PStore-based session storage class.

This builds upon the top-level PStore class provided by the library file pstore.rb. Session data is marshalled and stored in a file. File locking and transaction services are provided.

#

Instance Method Summary collapse

Constructor Details

#initialize(session, option = {}) ⇒ PStore

#

Create a new CGI::Session::PStore 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 PStore 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 PStore file. Defaults to the empty string.

This session’s PStore file will be created if it does not exist, or opened if it does.

#


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cyberweb/cgi/session/pstore.rb', line 60

def initialize(session, option = {})
  dir = option['tmpdir'] || Dir::tmpdir
  prefix = option['prefix'] || ''
  id = session.session_id
  require 'digest/md5'
  md5 = Digest::MD5.hexdigest(id)[0,16]
  path = dir+'/'+prefix+md5
  path.untaint
  if File::exist?(path)
    @hash = nil
  else
    unless session.new_session
      raise CGI::Session::NoSession, 'uninitialized session'
    end
    @hash = {}
  end
  @p = ::PStore.new(path)
  @p.transaction {|p|
    File.chmod(0600, p.path)
  }
end

Instance Method Details

#close ⇒ Object

#

close

Update and close the session’s PStore file.

#


114
115
116
 
# File 'lib/cyberweb/cgi/session/pstore.rb', line 114

def close
  update
end

#delete ⇒ Object

#

delete

Close and delete the session’s PStore file.

#


123
124
125
126
 
# File 'lib/cyberweb/cgi/session/pstore.rb', line 123

def delete
  path = @p.path
  File.unlink(path)
end

#restore ⇒ Object

#

restore

Restore session state from the session’s PStore file.

Returns the session state as a hash.

#


89
90
91
92
93
94
95
96
 
# File 'lib/cyberweb/cgi/session/pstore.rb', line 89

def restore
  unless @hash
    @p.transaction {
      @hash = @p['hash'] || {}
    }
  end
  @hash
end

#update ⇒ Object

#

update

Save session state to the session’s PStore file.

#


103
104
105
106
107
 
# File 'lib/cyberweb/cgi/session/pstore.rb', line 103

def update
  @p.transaction {
    @p['hash'] = @hash
  }
end