CGI::Session::PStore

Class

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.

Class Methods

new(session, option={})

lib/cgi/session/pstore.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/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

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.

Instance Methods

close

lib/cgi/session/pstore.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/cgi/session/pstore.rb, line 75
def close
  update
end

Update and close the session’s PStore file.

delete

lib/cgi/session/pstore.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/cgi/session/pstore.rb, line 80
def delete
  path = @p.path
  File::unlink path
end

Close and delete the session’s PStore file.

restore

lib/cgi/session/pstore.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/cgi/session/pstore.rb, line 58
def restore
  unless @hash
    @p.transaction do
      @hash = @p['hash'] || {}
    end
  end
  @hash
end

Restore session state from the session’s PStore file.

Returns the session state as a hash.

update

lib/cgi/session/pstore.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/cgi/session/pstore.rb, line 68
def update
  @p.transaction do
    @p['hash'] = @hash
  end
end

Save session state to the session’s PStore file.