nitro 0.27.0 → 0.28.0

data/lib/nitro/server/drb.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+require 'drb'
+require 'optparse'
+
+require 'facet/synchash'
+
+require 'glue'
+require 'glue/cache/memory'
+
+module Nitro
+
+# A Drb server, typically used to host the application caches
+# (sessions, application scoped variables, og cache, fragment
+# cache, etc).
+#
+# === Example
+#
+# require 'nitro/server/drb
+#
+# class MyDrbServer < Nitro::DrbServer
+#   def setup_drb_objects
+#     ...
+#   end
+# end
+#
+# MyDrbServer.start
+#--
+# FIXME: should probably move to another directory (scripts?)
+# TODO: Add some debuging support (overload synchash).
+# TODO: Implement MemcacheServer.
+# TODO: Better start/stop functionality.
+#++
+
+class DrbServer
+
+  # Parse the command line arguments.
+  
+  def parse_options
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #$0 [options]"
+      opts.separator ''
+      opts.separator 'Specific options:'
+
+      opts.on('-D', '--debug', 'Run in debug mode.') do |p|
+        @debug = true
+      end
+
+      opts.on('-d', '--daemon', 'Run as daemon.') do |p|
+        @daemon = true
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message.') do
+        puts opts
+        exit
+      end
+    end
+
+    begin
+      parser.parse!(ARGV)
+    rescue OptionParser::InvalidOption
+      puts 'Invalid option, pass the --help parameter to get help!' 
+      exit
+    end
+  end
+
+  # Override in your application to setup your custom objects.
+  # The default implementation only creates a session store.
+  
+  def setup_drb_objects
+    require 'nitro/session'
+    @session_cache = SyncHash.new 
+    DRb.start_service("druby://#{Session.cache_address}:#{Session.cache_port}", @session_cache)    
+    puts "Drb session cache at druby://#{Session.cache_address}:#{Session.cache_port}."
+  end
+  
+  def setup_drb
+    setup_drb_objects()
+    DRb.thread.join    
+  end
+
+  # Start the DRb server.
+    
+  def start
+    parse_options
+    if @daemon
+      require 'daemons/daemonize'
+      Daemonize.daemonize()
+    end
+    setup_drb()
+  end
+  alias_method :start!, :start
+
+  # A helper method to start the DRb server.
+    
+  def self.start
+    self.new.start
+  end
+  
+end
+
+DrbServer.start if __FILE__ == $0
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/server/runner.rb

@@ -3,7 +3,7 @@ require 'optparse'
 require 'glue/configuration'
 require 'nitro/compiler'
 
-#require 'nano/kernel/autoreload'
+#require 'facet/kernel/autoreload'
 require 'glue/autoreload'
 
 module Nitro
@@ -128,6 +128,11 @@ class Runner
         @server = :webrick
       end
 
+      opts.on('-m', '--mongrel', 'Use the Mongrel Ruby server.') do
+        @server = :mongrel
+        # FIXME: handle logging.
+      end
+
       opts.on('-l', '--lhttpd', 'Use a lighttpd server (FastCGI).') do
         @server = :lhttpd
         Logger.set(Logger.new('log/app.log'))
@@ -147,6 +152,10 @@ class Runner
         @server = :cgi
         Logger.set(Logger.new('log/app.log'))
       end
+
+      opts.on('--scgi', 'Use the generic SCGI adapter') do
+        @server = :scgi
+      end
       
       opts.on('-C', '--console', 'Start a console attached to an instance of the application.') do
         if RUBY_PLATFORM =~ /mswin32/
@@ -307,10 +316,17 @@ class Runner
       case @server
         when :webrick
           require 'nitro/adapter/webrick'
-          puts "==> Listening at #{server.address}:#{server.port}."
+          puts "==> Listening at #{server.address}:#{server.port}. [WEBRICK]"
           puts "==> Press Ctrl-C to shutdown; Run with --help for options.\n\n"    
           Webrick.start(server)
 
+        when :mongrel
+          require 'nitro/adapter/mongrel'
+          puts "==> Listening at #{server.address}:#{server.port}. [MONGREL]"
+          puts "==> Press Ctrl-C to shutdown; Run with --help for options.\n\n"
+
+          Mongrel.start(server)
+
         when :lhttpd
           require 'nitro/adapter/fastcgi'
           puts "==> Launching lighttpd (FastCGI)."
@@ -329,6 +345,11 @@ class Runner
         when :cgi
           require 'nitro/adapter/cgi'
           puts "==> Using standard CGI. Please look into using Fast/Scgi"
+
+
+        when :scgi
+          require 'nitro/adapter/scgi'
+          SCGI.start(server)
         
         when :acgi
           require 'nitro/adapter/acgi'

data/lib/nitro/session.rb

@@ -1,9 +1,10 @@
 require 'md5'
 require 'webrick'
 
-require 'mega/synchash'
-require 'mega/time_in_english'
+require 'facet/synchash'
+require 'facet/times'
 
+require 'glue'
 require 'glue/attribute'
 require 'glue/configuration'
 require 'glue/logger'
@@ -24,7 +25,10 @@ module Nitro
 # The session should be persistable to survive server 
 # shutdowns.
 #
-# TODO rehash of the session cookie
+#--
+# TODO: rehash of the session cookie
+# TODO: store -> cache, reimplement helpers.
+#++
 
 class Session < Hash
   include Expirable
@@ -45,15 +49,23 @@ class Session < Hash
   # garbage collection after this time passes.
   
   setting :keepalive, :default => 30.minutes, :doc => 'The session keepalive time'
+
+  # The address of the Session cache / store (if distibuted).
+
+  setting :cache_address, :default => '127.0.0.1', :doc => 'The address of the Session cache'
   
-  # The sessions store. 
+  # The port of the Session DRb cache / store (if distributed).
+
+  setting :cache_port, :default => 9069, :doc => 'The port of the Session cache'
 
-  cattr_accessor :store
+  # The sessions cache (store). 
+
+  cattr_accessor :cache
   
   class << self
   
-    # Set the session store. The following options are
-    # available:
+    # Set the session cache. The generalized caching system in
+    # Glue is used. The following options are available:
     #
     # * :memory [default]
     # * :drb
@@ -61,20 +73,22 @@ class Session < Hash
     # * :file (not safe yet with multiple process as in fastcgi)
     # * :memcached (not available yet)
 
-    def store_type=(store_type)
+    def cache_type=(cache_type)
       # gmosx: RDoc friendly. 
-      require 'nitro/session/' + store_type.to_s
+      require 'nitro/session/' + cache_type.to_s
     end
-    alias_method :set_store_type, :store_type=
+    alias_method :set_cache_type, :cache_type=
+    alias_method :store_type=, :cache_type=
+    alias_method :set_store_type, :cache_type=
 
-    # Lookup the session in the store by using the session
+    # Lookup the session in the cache by using the session
     # cookie value as a key. If the session does not exist
-    # creates a new session, inserts it in the store and 
+    # creates a new session, inserts it in the cache and 
     # appends a new session cookie in the response.
     
     def lookup(context)
       if session_id = context.cookies[Session.cookie_name]
-        session = Session.store[session_id]
+        session = Session.cache[session_id]
       end
 
       unless session
@@ -85,7 +99,7 @@ class Session < Hash
           cookie.expires = Time.now + Session.keepalive 
         end
         context.add_cookie(cookie)
-        Session.store[session.session_id] = session 
+        Session.cache[session.session_id] = session 
       else
         # Access ('touch') the existing session.
         session.touch!
@@ -101,7 +115,7 @@ class Session < Hash
   # gmosx: should be placed here.
   #++
   
-  set_store_type(:memory)  
+  set_cache_type(:memory)  
 
   # The unique id of this session.
 
@@ -123,7 +137,7 @@ class Session < Hash
   # in distributed and/or multiprocess setups.
   
   def sync
-    Session.store[@session_id] = self
+    Session.cache[@session_id] = self
   end
   alias_method :restore, :sync
   
@@ -139,6 +153,9 @@ protected
   # increasing function like time is appropriate. 
   # Random may produce equal ids? add a prefix 
   # (SALT) to stop hackers from creating session_ids.
+  #--
+  # THINK: Is MD5 slow???
+  #++
   
   def create_id
     now = Time.now

data/lib/nitro/session/drb.rb

@@ -1,28 +1,14 @@
-require 'drb'
-
-require 'glue/configuration'
+require 'glue/cache/drb'
 require 'nitro/session'
 
-Logger.debug 'Using Drb sessions.'
-
 module Nitro
 
-class Session
-  
-  # The address of the Session DRb server.
-
-  setting :drb_address, :default => '127.0.0.1', :doc => 'The address of the Session DRb server'
-  
-  # The port of the Session DRb server.
-
-  setting :drb_port, :default => 9069, :doc => 'The port of the Session DRb server'
-
-end
+Logger.debug "Using DRb sessions at #{Session.cache_address}:#{Session.cache_port}."
 
-Session.store = DRbObject.new(
-  nil, 
-  "druby://#{Session.drb_address}:#{Session.drb_port}"
-) 
+Session.cache = DrbCache.new(
+  :address => Session.cache_address, 
+  :port => Session.cache_port
+)
 
 end
 

data/lib/nitro/session/file.rb

@@ -1,59 +1,14 @@
-#!/usr/bin/env ruby
-
+require 'glue/cache/file'
 require 'nitro/session'
-require 'fileutils'
-require 'tmpdir'
 
 module Nitro
   
-  # A Session manager that persists sessions on disk.
-  #
-  # TODO: safe locking of files, because Nitro can be multiprocess
-  
-  class FileSessionStore
-    setting :path, :default => "#{Dir.tmpdir}/nitro_session_#{Session.cookie_name}", :doc => 'The directory to store file session'
-
-    def initialize
-      @path = FileSessionStore.path
-      FileUtils.mkdir_p(@path)
-    end
-
-    def []=(k,v)
-      fn = File.join(@path, k.to_s)
-      encode_file(fn, v)
-    end
-
-    def [](k)
-      fn = File.join(@path, k.to_s)
-      return nil unless File.exists?(fn)
-      decode_file(fn)
-    end
-
-    def gc!
-      now = Time.now
-      all.each do |fn|
-        expire_time = File.stat(fn).atime + Session.keepalive
-        File.delete(fn) if now > expire_time
-      end
-    end
-
-    def all
-      Dir.glob( File.join(@path, '*' ) )
-    end
-
-    private
-
-    def decode_file(fn)
-      Marshal.load( File.read(fn) )
-    end
+# A Session manager that persists sessions on disk.
 
-    def encode_file(fn, value)
-      File.open(fn, "w") { |f| f.write(Marshal.dump(value)) }
-    end
+Logger.debug "Using File sessions."
 
-  end
+Session.cache = FileCache.new("session_#{Session.cookie_name}", Session.keepalive)
 
-  Session.store = FileSessionStore.new
 end
 
 # * Guillaume Pierronnet <guillaume.pierronnet@gmail.com>

data/lib/nitro/session/memory.rb

@@ -1,3 +1,18 @@
+require 'glue/cache/memory'
+require 'nitro/session'
+
+module Nitro
+
+Logger.debug "Using Memory sessions."
+
+Session.cache = MemoryCache.new
+
+end
+
+# * George Moschovitis  <gm@navel.gr>
+
+=begin
+
 module Nitro
 
   class MemorySessionStore < SyncHash
@@ -18,3 +33,4 @@ module Nitro
 end
 
 # * George Moschovitis  <gm@navel.gr>
+=end

data/lib/nitro/session/og.rb

@@ -1,56 +1,14 @@
-require 'og'
+require 'glue/cache/og'
 require 'nitro/session'
-require 'base64'
 
 module Nitro
 
-  class OgSession < Session
-    prop_accessor :sessionid, String
-    prop_accessor :expires, Time
-    prop_accessor :content
-  end
+# A Session manager that persists sessions on an Og store.
 
-  # A Session manager that persists sessions on an Og store.
-  
-  class OgSessionStore
+Logger.debug "Using Og sessions."
 
-    def []=(k,v)
-      unless s = OgSession.find_by_sessionid(k.to_s)
-        s = OgSession.new
-        s.sessionid = k.to_s
-      end
-      #s.content = v.to_yaml
-      s.content = encode(v)
-      s.save
-    end
+Session.cache = OgCache.new("session_#{Session.cookie_name}", Session.keepalive)
 
-    def [](k)
-      s = OgSession.find_by_sessionid(k.to_s) and decode(s.content)
-    end
-
-    def gc!
-      now = Og.manager.store.quote(Time.now)
-      OgSession.find(:condition => "expires < #{now}").each {|s| s.delete }
-    end
-
-    def all
-      OgSession.all
-    end
-
-    private
-
-    def encode(c)
-      Base64.encode64(Marshal.dump(c))
-    end
-
-    def decode(c)
-      Marshal::load(Base64.decode64(c)) 
-      #s.content = YAML::load(s.content)
-    end
-
-  end
-
-  Session.store = OgSessionStore.new
 end
 
 # * Guillaume Pierronnet <guillaume.pierronnet@gmail.com>