2003-08-29 09:27:20 -04:00
|
|
|
#
|
|
|
|
# cgi/session/pstore.rb - persistent storage of marshalled session data
|
|
|
|
#
|
|
|
|
# Documentation: William Webber (william@williamwebber.com)
|
2009-03-05 22:56:38 -05:00
|
|
|
#
|
2003-08-29 09:27:20 -04:00
|
|
|
# == Overview
|
|
|
|
#
|
|
|
|
# This file provides the CGI::Session::PStore class, which builds
|
|
|
|
# persistent of session data on top of the pstore library. See
|
|
|
|
# cgi/session.rb for more details on session storage managers.
|
|
|
|
|
2003-07-15 03:35:14 -04:00
|
|
|
require 'cgi/session'
|
|
|
|
require 'pstore'
|
|
|
|
|
|
|
|
class CGI
|
|
|
|
class Session
|
2003-08-29 09:27:20 -04:00
|
|
|
# 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.
|
2003-07-15 03:35:14 -04:00
|
|
|
class PStore
|
2003-08-29 09:27:20 -04:00
|
|
|
# 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.
|
2009-03-05 22:56:38 -05:00
|
|
|
#
|
2008-06-04 05:37:38 -04:00
|
|
|
# +option+ is a hash of options for the initializer. The
|
2003-08-29 09:27:20 -04:00
|
|
|
# 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.
|
2006-07-30 10:06:50 -04:00
|
|
|
def initialize(session, option={})
|
2008-11-08 10:03:42 -05:00
|
|
|
dir = option['tmpdir'] || Dir::tmpdir
|
|
|
|
prefix = option['prefix'] || ''
|
|
|
|
id = session.session_id
|
2004-08-24 03:59:50 -04:00
|
|
|
require 'digest/md5'
|
|
|
|
md5 = Digest::MD5.hexdigest(id)[0,16]
|
2008-11-08 10:03:42 -05:00
|
|
|
path = dir+"/"+prefix+md5
|
|
|
|
path.untaint
|
|
|
|
if File::exist?(path)
|
|
|
|
@hash = nil
|
|
|
|
else
|
2004-11-19 11:59:11 -05:00
|
|
|
unless session.new_session
|
2004-12-15 01:35:55 -05:00
|
|
|
raise CGI::Session::NoSession, "uninitialized session"
|
2004-11-19 11:59:11 -05:00
|
|
|
end
|
2008-11-08 10:03:42 -05:00
|
|
|
@hash = {}
|
|
|
|
end
|
|
|
|
@p = ::PStore.new(path)
|
|
|
|
@p.transaction do |p|
|
|
|
|
File.chmod(0600, p.path)
|
|
|
|
end
|
2003-07-15 03:35:14 -04:00
|
|
|
end
|
|
|
|
|
2003-08-29 09:27:20 -04:00
|
|
|
# Restore session state from the session's PStore file.
|
|
|
|
#
|
|
|
|
# Returns the session state as a hash.
|
2003-07-15 03:35:14 -04:00
|
|
|
def restore
|
2008-11-08 10:03:42 -05:00
|
|
|
unless @hash
|
|
|
|
@p.transaction do
|
2004-10-19 06:25:23 -04:00
|
|
|
@hash = @p['hash'] || {}
|
2008-11-08 10:03:42 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
@hash
|
2003-07-15 03:35:14 -04:00
|
|
|
end
|
|
|
|
|
2003-08-29 09:27:20 -04:00
|
|
|
# Save session state to the session's PStore file.
|
2009-03-05 22:56:38 -05:00
|
|
|
def update
|
2008-11-08 10:03:42 -05:00
|
|
|
@p.transaction do
|
|
|
|
@p['hash'] = @hash
|
|
|
|
end
|
2003-07-15 03:35:14 -04:00
|
|
|
end
|
|
|
|
|
2003-08-29 09:27:20 -04:00
|
|
|
# Update and close the session's PStore file.
|
2003-07-15 03:35:14 -04:00
|
|
|
def close
|
2008-11-08 10:03:42 -05:00
|
|
|
update
|
2003-07-15 03:35:14 -04:00
|
|
|
end
|
|
|
|
|
2003-08-29 09:27:20 -04:00
|
|
|
# Close and delete the session's PStore file.
|
2003-07-15 03:35:14 -04:00
|
|
|
def delete
|
2008-11-08 10:03:42 -05:00
|
|
|
path = @p.path
|
|
|
|
File::unlink path
|
2003-07-15 03:35:14 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2014-08-09 21:34:50 -04:00
|
|
|
# :enddoc:
|