CGI::Session::FileStore (Class)

In: cgi/session.rb
Parent: Object

File-based session storage class.

Implements session storage as a flat file of ‘key=value’ values. This storage type only works directly with String values; the user is responsible for converting other types to Strings when storing and from Strings when retrieving.

Methods

close   delete   new   restore   update  

Public Class methods

new(session, option={})

Create a new FileStore 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 FileStore 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 FileStore file. Defaults to the empty string.

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

[Source]

# File cgi/session.rb, line 360
      def initialize(session, option={})
        dir = option['tmpdir'] || Dir::tmpdir
        prefix = option['prefix'] || ''
        id = session.session_id
        unless check_id(id)
          raise ArgumentError, "session_id `%s' is invalid" % id
        end
        path = dir+"/"+prefix+id
        path.untaint
        unless File::exist? path
          @hash = {}
        end
        begin
          @f = open(path, "r+")
        rescue Errno::ENOENT
          @f = open(path, "w+")
        end
      end

Public Instance methods

close()

Update and close the session’s FileStore file.

[Source]

# File cgi/session.rb, line 407
      def close
        return if @f.closed?
        update
        @f.close
      end
delete()

Close and delete the session’s FileStore file.

[Source]

# File cgi/session.rb, line 414
      def delete
        path = @f.path
        @f.close
        File::unlink path
      end
restore()

Restore session state from the session’s FileStore file.

Returns the session state as a hash.

[Source]

# File cgi/session.rb, line 382
      def restore
        unless @hash
          @hash = {}
          @f.flock File::LOCK_EX
          @f.rewind
          for line in @f
            line.chomp!
            k, v = line.split('=',2)
            @hash[CGI::unescape(k)] = CGI::unescape(v)
          end
        end
        @hash
      end
update()

Save session state to the session’s FileStore file.

[Source]

# File cgi/session.rb, line 397
      def update
        return unless @hash
        @f.rewind
        for k,v in @hash
          @f.printf "%s=%s\n", CGI::escape(k), CGI::escape(String(v))
        end
        @f.truncate @f.tell
      end

[Validate]