rsence 2.1.11 → 2.2.0

data/lib/rsence/argv/status_argv.rb

@@ -0,0 +1,132 @@
+module RSence
+module ArgvUtil
+  # Main argument parser for the status command, sends the INFO (or PWR on linux) POSIX signal to
+  # the process, if running.
+  # Checks if the process responds on the port and address it's configured for.
+  def parse_status_argv
+    init_args
+    expect_option  = false
+    option_name = false
+    if @argv.length >= 2
+      @argv[1..-1].each_with_index do |arg,i|
+        if expect_option
+          if [:port].include?(option_name) and arg.to_i.to_s != arg
+            puts ERB.new( @strs[:messages][:invalid_option_expected_number] ).result( binding )
+            exit
+          elsif option_name == :conf_files
+            if not File.exists?( arg ) or not File.file?( arg )
+              puts ERB.new( @strs[:messages][:no_such_configuration_file] ).result( binding )
+              exit
+            else
+              @args[:conf_files].push( arg )
+            end
+          else
+            @args[option_name] = arg
+          end
+          expect_option = false
+        else
+          if arg.start_with?('--')
+            if arg == '--debug'
+              set_debug
+            elsif arg == '--verbose'
+              set_verbose
+            elsif arg == '--port'
+              expect_option = true
+              option_name = :port
+            elsif arg == '--addr'
+              expect_option = true
+              option_name = :addr
+            elsif arg == '--conf' or arg == '--config'
+              expect_option = true
+              option_name = :conf_files
+            else
+              invalid_option(arg)
+            end
+          elsif arg.start_with?('-')
+            arg.split('')[1..-1].each do |chr|
+              if chr == 'd'
+                set_debug
+              elsif chr == 'v'
+                set_verbose
+              else
+                invalid_option(arg,chr)
+              end
+            end
+          elsif valid_env?(arg)
+            @args[:env_path] = File.expand_path(arg)
+            @args[:conf_files].unshift( File.expand_path( File.join( arg, 'conf', 'config.yaml' ) ) )
+          else
+            invalid_env( arg )
+          end
+        end
+      end
+      if expect_option
+        puts ERB.new( @strs[:messages][:no_value_for_option] ).result( binding )
+        exit
+      end
+    end
+    if valid_env?(@args[:env_path])
+      conf_file = File.expand_path( File.join( @args[:env_path], 'conf', 'config.yaml' ) )
+      @args[:conf_files].unshift( conf_file ) unless @args[:conf_files].include?( conf_file )
+    else
+      invalid_env
+    end
+    require 'rsence/default_config'
+    require 'socket'
+    config = Configuration.new(@args).config
+    port = config[:http_server][:port]
+    addr = config[:http_server][:bind_address]
+    port_status = []
+    if addr == '0.0.0.0' and Socket.respond_to?(:ip_address_list)
+      Socket.ip_address_list.each do |if_addr|
+        if test_port( port, if_addr.ip_address )
+          port_status.push( if_addr.ip_address )
+        end
+      end
+    else
+      port_status.push( addr )
+    end
+    addr_descr = port_status.join(":#{port}, ")+":#{port}"
+    if RSence.pid_support?
+      pid_fn = config[:daemon][:pid_fn]
+      if File.exists?( pid_fn )
+        pid = File.read( pid_fn ).to_i
+        sig_name = RSence.info_signal_name
+        pid_status = RSence::SIGComm.wait_signal_response(
+          pid, pid_fn, sig_name, 3
+        )
+      else
+        warn @strs[:messages][:no_pid_file] if @args[:verbose]
+        pid_status = nil
+      end
+    else
+      warn @strs[:messages][:no_pid_support] if @args[:verbose]
+      pid_status = nil
+    end
+    addr_descr = port_status.join(":#{port} and ")+":#{port}" unless port_status.empty?
+    if not RSence.pid_support? or pid_status == nil
+      if RSence.pid_support?
+        puts @strs[:messages][:no_pid]
+      else
+        puts @strs[:messages][:no_pid_support]
+      end
+      unless port_status.empty?
+        puts ERB.new( @strs[:messages][:something_responds] ).result( binding )
+      end
+    elsif pid_status == false
+      if port_status.empty?
+        puts ERB.new( @strs[:messages][:no_process_running_and_nothing_responds] ).result( binding )
+      else
+        puts ERB.new( @strs[:messages][:no_process_running_but_something_responds] ).result( binding )
+      end
+    else
+      if port_status.empty?
+        puts ERB.new( @strs[:messages][:process_running_but_nothing_responds] ).result( binding )
+      else
+        addr_descr = port_status.join(":#{port} and ")+":#{port}"
+        puts ERB.new( @strs[:messages][:process_running_and_responds] ).result( binding )
+      end
+    end
+  end
+end
+end  

data/lib/rsence/argv/test_port.rb

@@ -0,0 +1,32 @@
+
+module RSence
+module ArgvUtil
+
+  # Tests, if the port on addr responds or refuses the connection.
+  # Automatically replaces '0.0.0.0' with '127.0.0.1'
+  def test_port( port, addr='127.0.0.1' )
+    require 'socket'
+    begin
+      addr = '127.0.0.1' if addr == '0.0.0.0'
+      if RUBY_VERSION.to_f >= 1.9
+        sock = TCPSocket.open( addr, port )
+      else
+        begin
+          sock = TCPsocket.open( addr, port )
+        rescue NameError => e
+          warn "TCPsocket not available, trying TCPSocket.."
+          sock = TCPSocket.open( addr, port )
+        end
+      end
+      sock.close
+      return true
+    rescue Errno::ECONNREFUSED
+      return false
+    rescue => e
+      warn e.inspect
+      return false
+    end
+  end
+
+end
+end

data/lib/{daemon → rsence}/daemon.rb

@@ -11,10 +11,10 @@
 require 'rubygems'
 
 # Transporter is the top-level handler for calls coming from the javascript COMM.Transporter.
-require 'transporter/transporter'
+require 'rsence/transporter'
 
 # Broker routes requests to the correct handler
-require 'http/broker'
+require 'rsence/http'
 
 
 module RSence
@@ -276,9 +276,44 @@ module RSence
       "RSence-#{RSence.version} on #{url} in #{env_path}"
     end
     
+    def start_broker( conf )
+      http_delayed_seconds = RSence.config[:daemon][:http_delayed_start].to_i
+      if http_delayed_seconds == -1
+        puts "The HTTP Broker is disabled. RSence won't bind a http listener to any address."
+      else
+        if http_delayed_seconds > 0
+          puts "Delaying the start of the HTTP Broker by #{http_delayed_seconds} seconds."
+          if http_delayed_seconds > 10
+            # report when starting in 10 second intervals
+            sleep_remainder = http_delayed_seconds % 10
+            sleep_count = http_delayed_seconds / 10
+            sleep_time_left = http_delayed_seconds
+            sleep_count.times do |sleep_count_num|
+              puts "Waiting #{sleep_time_left} seconds..."
+              sleep 10
+              sleep_time_left -= 10
+            end
+            if sleep_remainder != 0
+              puts "Waiting #{sleep_remainder} seconds..."
+              sleep sleep_remainder
+            end
+          else
+            sleep http_delayed_seconds
+          end
+          puts "Starting the HTTP Broker now."
+        end
+        # This is the main http handler instance:
+        @broker = Broker.start(
+          @transporter,
+          conf
+        )
+      end
+    end
+    
     # RSence top-level run handler. Almost identical to start.
     def run
       
+      # Sets the process name
       $0 = ps_name
       
       puts "Starting as a foreground process." if RSence.args[:verbose]
@@ -291,13 +326,10 @@ module RSence
       unless RSence.args[:log_fg]
         Daemon.start_logging( self )
       end
-    
-      # This is the main http handler instance:
-      @broker = Broker.start(
-        @transporter,
-        conf
-      )
-    
+      
+      autosave_loop if RSence.config[:daemon][:autosave_interval] > 0
+      start_broker( conf )
+      
     end
     
     # Returns the pid file path.
@@ -319,28 +351,40 @@ module RSence
     def port
       RSence.config[:http_server][:port]
     end
+
+    # Saves plugin and session state periodically
+    def autosave_loop
+      Thread.new do
+        Thread.pass
+        sleep RSence.config[:daemon][:autosave_interval]
+        while true
+          if @transporter.online?
+            save
+          end
+          sleep RSence.config[:daemon][:autosave_interval]
+        end
+      end
+    end
     
     # Called by Controller#start, contains RSence-specific operations
     def start
       
+      # Sets the process name
       $0 = ps_name
       
       @transporter = Transporter.new
-    
+      
       conf = RSence.config[:http_server]
-    
+      
       unless RSence.args[:log_fg]
         Daemon.start_logging( self )
         STDIN.reopen( "/dev/null" )
       end
-    
+      
       Process.setsid
-    
-      # This is the main http handler instance:
-      @broker = Broker.start(
-        @transporter,
-        conf
-      )
+      
+      autosave_loop if RSence.config[:daemon][:autosave_interval] > 0
+      start_broker( conf )
       yield @broker
     
     end
@@ -357,7 +401,7 @@ module RSence
     
     # Called on INFO (PWR) signals ("Alive?")
     def info
-      puts "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} -- RSence version #{RSence.version} is running."
+      puts "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} -- RSence version #{RSence.version} is running the project: #{RSence.args[:env_path]}"
     end
     
     # Called on ALRM signals (save data, reload all plugins manually)
@@ -381,11 +425,11 @@ module RSence
     # Save state
     def save
       puts "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} -- Saving state..."
-      transporter_state = @transporter.online?
-      @transporter.online = false
-      @transporter.plugins.delegate(:flush)
+      # transporter_state = @transporter.online?
+      # @transporter.online = false
       @transporter.sessions.store_sessions
-      @transporter.online = transporter_state
+      @transporter.plugins.delegate(:flush)
+      # @transporter.online = transporter_state
       puts "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} -- State saved."
     end
     

data/lib/{conf/default.rb → rsence/default_config.rb}

@@ -12,7 +12,6 @@ require 'rack'
 require 'yaml'
 
 
-
 module RSence
   
   
@@ -45,7 +44,7 @@ module RSence
     # @param [Hash] source Has its items merged to `target` unless a key with an identical value already exists in `target`. If an item class is Array, then uses {#array_merge} to combine them.
     def hash_merge( target, source )
       source.each do |key,item|
-        if not target.has_key?key or target[key] != item
+        if not target.has_key?( key ) or target[key] != item
           if item.class == Array
             target[key] = [] unless target.has_key?(key)
             array_merge( target[key], item )
@@ -143,14 +142,23 @@ module RSence
       config[:http_server][:bind_address] = args[:addr] if args[:addr]
       config[:http_server][:rack_require] = args[:server] if args[:server]
       config[:session_conf][:reset_sessions] = true if args[:reset_ses]
+      config[:daemon][:http_delayed_start] = args[:http_delayed_start] if args[:http_delayed_start] != nil
     
       config[:client_pkg][:no_obfuscation] = true if args[:client_pkg_no_obfuscation]
       config[:client_pkg][:no_whitespace_removal] = true if args[:client_pkg_no_whitespace_removal]
     
       # Sets the default pid and log paths used by the HTTPDaemon
-      config[:daemon][:pid_fn] = File.join(pidpath, "rsence.pid") unless config[:daemon].has_key?(:pid_fn)
-      config[:daemon][:log_fn] = File.join(logpath, "rsence") unless config[:daemon].has_key?(:log_fn)
-    
+      if config[:daemon].has_key?(:pid_fn)
+        config[:daemon][:pid_fn] = File.join(pidpath, config[:daemon][:pid_fn] )
+      else
+        config[:daemon][:pid_fn] = File.join(pidpath, "rsence.pid")
+      end
+      if config[:daemon].has_key?(:log_fn)
+        config[:daemon][:log_fn] = File.join(logpath, config[:daemon][:log_fn] )
+      else
+        config[:daemon][:log_fn] = File.join(logpath, "rsence")
+      end
+
       # Check database path for sqlite databases.
       if config[:database][:ses_db].start_with?('sqlite://') and not dont_expand_path
         db_url = File.expand_path( config[:database][:ses_db].split('sqlite://')[1], args[:env_path] )
@@ -189,11 +197,11 @@ module RSence
         end
       end
     
-      if RUBY_VERSION.to_f >= 1.9
-        # The encodings mess up compression when using ruby1.9
-        warn "Disabling gzip support for ruby 1.9" if args[:debug]
-        config[:no_gzip] = true
-      end
+      # if RUBY_VERSION.to_f >= 1.9
+      #   # The encodings mess up compression when using ruby1.9
+      #   warn "Disabling gzip support for ruby 1.9" if args[:debug]
+      #   config[:no_gzip] = true
+      # end
     
       # The default address of the index_html plugin
       unless config[:index_html].has_key?(:respond_address)

data/lib/rsence/http.rb

@@ -0,0 +1,3 @@
+
+require 'rsence/http/broker'
+

data/lib/{http → rsence/http}/broker.rb

@@ -10,11 +10,10 @@ require 'rubygems'
 require 'rack'
 
 ## Minimally WEBrick -compatible response object
-require 'http/response'
+require 'rsence/http/response'
 
 ## Minimally WEBrick -compatible request object
-require 'http/request'
-
+require 'rsence/http/request'
 
 module RSence
 
@@ -41,8 +40,15 @@ class Broker
     response = Response.new
     request_method = request.request_method.downcase
     dispatcher = dispatcher_class.new( request, response )
-    dispatcher.send( request_method )
-    content_type = dispatcher.content_type
+    if dispatcher.respond_to?( request_method )
+      begin
+        dispatcher.send( request_method )
+      rescue => e
+        dispatcher.server_error( e )
+      end
+    else
+      dispatcher.not_implemented( request.request_method )
+    end
     response_body = response.body
     response.header['Content-Length'] = response.body_bytes unless response.header.has_key?('Content-Length')
     return [response.status, response.header, response_body]
@@ -55,7 +61,6 @@ class Broker
   # @return [Broker] An instance of Broker with a {Request} instance as +@request+ and a {Response} instance as +@response+
   def dispatcher_class
     @dispatcher ||= Class.new(self.class) do
-      attr_accessor :content_type
       def initialize(request,response)
         @request  = request
         @response = response
@@ -90,7 +95,16 @@ class Broker
         sleep 0.2
       end
       puts "..#{host}:#{port} responds!" if ::RSence.args[:debug]
-      puts "RSence is online on the address http://#{host}:#{port}#{::RSence.config[:base_url]}"
+      if host == '0.0.0.0' and Socket.respond_to?(:ip_address_list)
+        puts "RSence is online and responds on the addresses:"
+        Socket.ip_address_list.each do |if_addr|
+          if RSence.argv.test_port( port, if_addr.ip_address )
+            puts "  http://#{if_addr.ip_address}:#{port}#{::RSence.config[:base_url]}"
+          end
+        end
+      else
+        puts "RSence is online on the address http://#{host}:#{port}#{::RSence.config[:base_url]}"
+      end
       @@transporter.online = true
     end
     
@@ -99,11 +113,12 @@ class Broker
     # Loads the selected web-server (default is 'mongrel')
     rack_require = conf[:rack_require]
     puts conf.inspect if RSence.args[:debug]
-    
+
     require rack_require
     
     # Selects the handler for Rack
     handler = {
+      'mongrel2' => lambda { Rack::Handler::Mongrel2 },
       'webrick'  => lambda { Rack::Handler::WEBrick  },
       'ebb'      => lambda { Rack::Handler::Ebb      },
       'thin'     => lambda { Rack::Handler::Thin     },
@@ -111,41 +126,113 @@ class Broker
       'unicorn'  => lambda { Rack::Handler::Unicorn  },
       'rainbows' => lambda { Rack::Handler::Rainbows }
     }[rack_require].call
-    
     handler.run( Rack::Lint.new(self.new), :Host => host, :Port => port )
-    
   end
   
   # Generic 404 error handler. Just sets up response status, headers, body as a small "Page Not Found" html page
   def not_found
     puts "/404: #{@request.fullpath.inspect}" if RSence.args[:verbose]
     @response.status = 404
-    err404 = '<html><head><title>404 - Page Not Found</title></head><body>404 - Page Not Found</body></html>'
+    err404 = "<html><head><title>404 - Page Not Found</title></head><body>404 - Page &quot;#{@request.fullpath}&quot; Not Found</body></html>"
     @response['Content-Type'] = 'text/html; charset=UTF-8'
-    @response['Content-Length'] = err404.bytesize.to_s
     @response.body = err404
   end
   
   # Routes POST requests to {Transporter#servlet}
   def post
-    
     puts "post: #{@request.fullpath}" if RSence.args[:verbose]
-    
     not_found unless @@transporter.servlet( :post, @request, @response )
-    
   end
   
   # Routes GET requests to {Transporter#servlet}
   def get
-    
     puts "get: #{@request.fullpath}" if RSence.args[:verbose]
-    
     not_found unless @@transporter.servlet( :get, @request, @response )
-    
   end
   
-  ### -- Add more http methods here when we have some apps to test with CalDAV implementation maybe? ++
+  # Routes HEAD requests to {Transporter#servlet}
+  # Uses GET and removes the response body, if nothing matches HEAD directly.
+  def head
+    puts "head: #{@request.fullpath}" if RSence.args[:verbose]
+    return if @@transporter.servlet( :head, @request, @response )
+    if @@transporter.servlet( :get, @request, @response )
+      @response.body = ''
+    else
+      not_found
+    end
+  end
+
+  # Generic 405 (method not allowed) handler.
+  def not_allowed( method_name )
+    @response.status = 405
+    body_txt = "Error 405: The method #{method_name} is not allowed on #{@request.fullpath}.\r\n"
+    @response['Content-Type'] = 'text/plain; charset=UTF-8'
+    @response.body = body_txt
+  end
+  
+  # Generic 501 (method not implemented) handler.
+  def not_implemented( method_name )
+    @response.status = 501
+    body_txt = "Error 501: The method #{method_name} is not implemented on #{@request.fullpath}.\r\n"
+    @response['Content-Type'] = 'text/plain; charset=UTF-8'
+    @response.body = body_txt
+  end
   
+  # Generic 500 (server error) handler.
+  def server_error( e, custom_name='Broker Exception' )
+    @response.status = 500
+    exception_detail = [
+      custom_name,
+      "Time: #{Time.now.to_s}",
+      "#{'-='*39}-",
+      "#{e.class}: #{e.to_s}",
+      "\t#{e.backtrace.join("\r\n\t")}",
+      "#{'-='*39}-",
+      "Request method: #{@request.request_method}",
+      "Request path: #{@request.fullpath}",
+      "Request headers: #{@request.header.inspect}",
+      "#{'-='*39}-\r\n\r\n"
+    ].join("\r\n")
+    $stderr.puts exception_detail
+    if RSence.args[:debug]
+      body_txt = "Error 500: "+ exception_detail
+    else
+      body_txt = "Error 500: General server error.\r\n"
+    end
+    @response['Content-Type'] = 'text/plain; charset=UTF-8'
+    @response.body = body_txt
+  end
+  
+  # Routes OPTIONS requests to {Transporter#servlet}
+  def options
+    puts "options: #{@request.fullpath}" if RSence.args[:verbose]
+    not_allowed('OPTIONS') unless @@transporter.servlet( :options, @request, @response )
+  end
+
+  # Routes PUT requests to {Transporter#servlet}
+  def put
+    puts "put: #{@request.fullpath}" if RSence.args[:verbose]
+    not_allowed('PUT') unless @@transporter.servlet( :put, @request, @response )
+  end
+
+  # Routes DELETE requests to {Transporter#servlet}
+  def delete
+    puts "delete: #{@request.fullpath}" if RSence.args[:verbose]
+    not_allowed('DELETE') unless @@transporter.servlet( :delete, @request, @response )
+  end
+
+  # Routes TRACE requests to {Transporter#servlet}
+  def trace
+    puts "trace: #{@request.fullpath}" if RSence.args[:verbose]
+    not_allowed('TRACE') unless @@transporter.servlet( :trace, @request, @response )
+  end
+
+  # Routes CONNECT requests to {Transporter#servlet}
+  def connect
+    puts "connect: #{@request.fullpath}" if RSence.args[:verbose]
+    not_allowed('CONNECT') unless @@transporter.servlet( :connect, @request, @response )
+  end
+
 end
 
 end