vendor/plugins/sql_session_store/lib/postgresql_session.rb

   1 require 'postgres'
   2
   3 # allow access to the real Mysql connection
   4 class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
   5   attr_reader :connection
   6 end
   7
   8 # PostgresqlSession is a down to the bare metal session store
   9 # implementation to be used with +SQLSessionStore+. It is much faster
  10 # than the default ActiveRecord implementation.
  11 #
  12 # The implementation assumes that the table column names are 'id',
  13 # 'session_id', 'data', 'created_at' and 'updated_at'. If you want use
  14 # other names, you will need to change the SQL statments in the code.
  15 #
  16 # This table layout is compatible with ActiveRecordStore.
  17
  18 class PostgresqlSession
  19
  20   # if you need Rails components, and you have a pages which create
  21   # new sessions, and embed components insides these pages that need
  22   # session access, then you *must* set +eager_session_creation+ to
  23   # true (as of Rails 1.0). Not needed for Rails 1.1 and up.
  24   cattr_accessor :eager_session_creation
  25   @@eager_session_creation = false
  26
  27   attr_accessor :id, :session_id, :data
  28
  29   def initialize(session_id, data)
  30     @session_id = session_id
  31     @data = data
  32     @id = nil
  33   end
  34
  35   class << self
  36
  37     # retrieve the session table connection and get the 'raw' Postgresql connection from it
  38     def session_connection
  39       SqlSession.connection.connection
  40     end
  41
  42     # try to find a session with a given +session_id+. returns nil if
  43     # no such session exists. note that we don't retrieve
  44     # +created_at+ and +updated_at+ as they are not accessed anywhyere
  45     # outside this class.
  46     def find_session(session_id)
  47       connection = session_connection
  48       # postgres adds string delimiters when quoting, so strip them off
  49       session_id = PGconn::quote(session_id)[1..-2]
  50       result = connection.query("SELECT id, data FROM sessions WHERE session_id='#{session_id}' LIMIT 1")
  51       my_session = nil
  52       # each is used below, as other methods barf on my 64bit linux machine
  53       # I suspect this to be a bug in mysql-ruby
  54       result.each do |row|
  55         my_session = new(session_id, row[1])
  56         my_session.id = row[0]
  57       end
  58       result.clear
  59       my_session
  60     end
  61
  62     # create a new session with given +session_id+ and +data+
  63     # and save it immediately to the database
  64     def create_session(session_id, data)
  65       # postgres adds string delimiters when quoting, so strip them off
  66       session_id = PGconn::quote(session_id)[1..-2]
  67       new_session = new(session_id, data)
  68       if @@eager_session_creation
  69         connection = session_connection
  70         connection.query("INSERT INTO sessions (\"created_at\", \"updated_at\", \"session_id\", \"data\") VALUES (NOW(), NOW(), '#{session_id}', #{PGconn::quote(data)})")
  71         new_session.id = connection.lastval
  72       end
  73       new_session
  74     end
  75
  76     # delete all sessions meeting a given +condition+. it is the
  77     # caller's responsibility to pass a valid sql condition
  78     def delete_all(condition=nil)
  79       if condition
  80         session_connection.query("DELETE FROM sessions WHERE #{condition}")
  81       else
  82         session_connection.query("DELETE FROM sessions")
  83       end
  84     end
  85
  86   end # class methods
  87
  88   # update session with given +data+.
  89   # unlike the default implementation using ActiveRecord, updating of
  90   # column `updated_at` will be done by the database itself
  91   def update_session(data)
  92     connection = self.class.session_connection
  93     if @id
  94       # if @id is not nil, this is a session already stored in the database
  95       # update the relevant field using @id as key
  96       connection.query("UPDATE sessions SET \"updated_at\"=NOW(), \"data\"=#{PGconn::quote(data)} WHERE id=#{@id}")
  97     else
  98       # if @id is nil, we need to create a new session in the database
  99       # and set @id to the primary key of the inserted record
 100       connection.query("INSERT INTO sessions (\"created_at\",  \"updated_at\", \"session_id\", \"data\") VALUES (NOW(), NOW(), '#{@session_id}', #{PGconn::quote(data)})")
 101       @id = connection.lastval rescue connection.query("select lastval()").first[0]
 102     end
 103   end
 104
 105   # destroy the current session
 106   def destroy
 107     self.class.delete_all("session_id=#{PGconn.quote(session_id)}")
 108   end
 109
 110 end
 111
 112 __END__
 113
 114 # This software is released under the MIT license
 115 #
 116 # Copyright (c) 2006-2008 Stefan Kaes
 117
 118 # Permission is hereby granted, free of charge, to any person obtaining
 119 # a copy of this software and associated documentation files (the
 120 # "Software"), to deal in the Software without restriction, including
 121 # without limitation the rights to use, copy, modify, merge, publish,
 122 # distribute, sublicense, and/or sell copies of the Software, and to
 123 # permit persons to whom the Software is furnished to do so, subject to
 124 # the following conditions:
 125
 126 # The above copyright notice and this permission notice shall be
 127 # included in all copies or substantial portions of the Software.
 128
 129 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 130 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 131 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 132 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 133 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 134 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 135 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 136