Class: CGI::Session::PStore

Inherits:
Object
  • Object
show all
Defined in:
lib/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.



46
47
48
49
50
51
52
53
 
# File 'lib/cgi/session/pstore.rb', line 46

def initialize(session, option={})
  option = {'suffix'=>''}.update(option)
  path, @hash = session.new_store_file(option)
  @p = ::PStore.new(path)
  @p.transaction do |p|
    File.chmod(0600, p.path)
  end
end

Instance Method Details

#close ⇒ Object

Update and close the session’s PStore file.



75
76
77
 
# File 'lib/cgi/session/pstore.rb', line 75

def close
  update
end

#delete ⇒ Object

Close and delete the session’s PStore file.



80
81
82
83
 
# File 'lib/cgi/session/pstore.rb', line 80

def delete
  path = @p.path
  File::unlink path
end

#restore ⇒ Object

Restore session state from the session’s PStore file.

Returns the session state as a hash.



58
59
60
61
62
63
64
65
 
# File 'lib/cgi/session/pstore.rb', line 58

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

#update ⇒ Object

Save session state to the session’s PStore file.



68
69
70
71
72
 
# File 'lib/cgi/session/pstore.rb', line 68

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