Class

CGI::Session::PStore

In:

Parent:

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.

Methods

close delete new restore update

Public Class methods

new(session, option={})

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 initialiser. 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.

[Source]

    # File cgi/session/pstore.rb, line 56
56:       def initialize session, option={}
57:         dir = option['tmpdir'] || Dir::tmpdir
58:         prefix = option['prefix'] || ''
59:         id = session.session_id
60:         require 'digest/md5'
61:         md5 = Digest::MD5.hexdigest(id)[0,16]
62:         path = dir+"/"+prefix+md5
63:         path.untaint
64:         unless File::exist?(path)
65:           unless session.new_session
66:             raise CGI::Session::NoSession, "uninitialized session"
67:           end
68:           @hash = {}
69:         end
70:         @p = ::PStore.new(path)
71:         @p.transaction do |p|
72:           File.chmod(0600, p.path)
73:         end
74:       end

Public Instance methods

close()

Update and close the session’s PStore file.

[Source]

    # File cgi/session/pstore.rb, line 96
96:       def close
97:         update
98:       end

delete()

Close and delete the session’s PStore file.

[Source]

     # File cgi/session/pstore.rb, line 101
101:       def delete
102:         path = @p.path
103:         File::unlink path
104:       end

restore()

Restore session state from the session’s PStore file.

Returns the session state as a hash.

[Source]

    # File cgi/session/pstore.rb, line 79
79:       def restore
80:         unless @hash
81:           @p.transaction do
82:            @hash = @p['hash'] || {}
83:           end
84:         end
85:         @hash
86:       end

update()

Save session state to the session’s PStore file.

[Source]

    # File cgi/session/pstore.rb, line 89
89:       def update 
90:         @p.transaction do
91:             @p['hash'] = @hash
92:         end
93:       end

[Validate]

Ruby-Language API Docs and Resources

Methods

Public Class methods

Public Instance methods

Search

Ruby API Docs

Links