oversip 1.0.6.beta3 → 1.0.7.beta1

data/etc/system_events.rb

@@ -15,4 +15,11 @@ module OverSIP::SystemEvents
     # Do something.
   end
 
+  # This method is called when a USR1 signal is received by the main
+  # process and allows the user to set custom code to be executed
+  # or reloaded.
+  def self.on_user_reload
+    # Do something.
+  end
+
 end

data/etc/websocket_policy.rb

@@ -13,17 +13,17 @@ module OverSIP::WebSocket::Policy
 
   # Check the value of the Host header, by splitting it into
   # host (a String) and port (Fixnum). Both could be _nil_.
-  def check_hostport host=nil, port=nil
+  def self.check_hostport host=nil, port=nil
     return true
   end
 
   # Check the value of the Origin header (a String with original value).
-  def check_origin origin=nil
+  def self.check_origin origin=nil
     return true
   end
 
   # Check the request URI path (String) and query (String). Both can be _nil_.
-  def check_request_uri path=nil, query=nil
+  def self.check_request_uri path=nil, query=nil
     return true
   end
 

data/lib/oversip/config.rb

@@ -240,7 +240,15 @@ module OverSIP
       end
 
       ::OverSIP.configuration = @configuration
-      ::OverSIP::ProxiesConfig.load proxies_yaml
+
+      begin
+        ::OverSIP::ProxiesConfig.load proxies_yaml
+      rescue ::OverSIP::ConfigurationError => e
+        fatal "error loading Proxies Configuration file '#{@proxies_file}':  #{e.message}"
+      rescue ::Exception => e
+        log_system_crit "error loading Proxies Configuration file '#{@proxies_file}':"
+        fatal e
+      end
     end
 
 
@@ -564,15 +572,50 @@ module OverSIP
       end
     end
 
-    def self.reload
+    def self.system_reload
+      log_system_notice "reloading OverSIP..."
+
+      begin
+       ::Kernel.load @custom_lib_file
+       log_system_notice "Custom Library file '#{@custom_lib_file}' reloaded"
+      rescue ::Exception => e
+        log_system_crit "error reloading Custom Library file '#{@custom_lib_file}':"
+        log_system_crit e
+      end
+
+      begin
+       ::Kernel.load @system_events_file
+       log_system_notice "System Events file '#{@system_events_file}' reloaded"
+      rescue ::Exception => e
+        log_system_crit "error reloading System Events file '#{@system_events_file}':"
+        log_system_crit e
+      end
+
+      begin
+       ::Kernel.load @events_file
+       log_system_notice "Events file '#{@events_file}' reloaded"
+      rescue ::Exception => e
+        log_system_crit "error reloading Events file '#{@events_file}':"
+        log_system_crit e
+      end
+
+      begin
+        proxies_yaml = ::YAML.load_file @proxies_file
+        ::OverSIP::ProxiesConfig.load proxies_yaml, reload=true
+        log_system_notice "Proxies Configuration file '#{@proxies_file}' reloaded"
+      rescue ::OverSIP::ConfigurationError => e
+        log_system_crit "error reloading Proxies Configuration file '#{@proxies_file}':  #{e.message}"
+      rescue ::Exception => e
+        log_system_crit "error reloading Proxies Configuration file '#{@proxies_file}':"
+        log_system_crit e
+      end
+
       begin
         ::Kernel.load @logic_file
-        log_system_info "logic reloaded"
-        true
+        log_system_notice "Logic file '#{@logic_file}' reloaded"
       rescue ::Exception => e
-        log_system_crit "error reloading logic"
+        log_system_crit "error reloading Logic file '#{@logic_file}':"
         log_system_crit e
-        false
       end
     end
 

data/lib/oversip/errors.rb

@@ -1,6 +1,6 @@
 module OverSIP
 
-  class Error < StandardError ; end
+  class Error < ::StandardError ; end
   class ConfigurationError < Error ; end
   class LogicError < Error ; end
 

data/lib/oversip/launcher.rb

@@ -418,7 +418,7 @@ module OverSIP::Launcher
     end
 
     # Signals that must be ignored.
-    ignore_signals = [:ALRM, :INT, :PIPE, :POLL, :PROF, :USR1, :USR2, :VTALRM, :WINCH]
+    ignore_signals = [:ALRM, :INT, :PIPE, :POLL, :PROF, :USR2, :WINCH]
     ignore_signals.each do |signal|
       begin
         trap signal do
@@ -429,11 +429,26 @@ module OverSIP::Launcher
       end
     end
 
-    # Signal HUP reloads logic.
-    # TODO: Reload proxies (so purge DNS cache in all of them), reload websocket policy.
+    # Special treatment for VTALRM signal (TODO: since it occurs too much).
+    trap :VTALRM do
+    end
+
+    # Signal HUP reloads OverSIP system configuration.
     trap :HUP do
-      log_system_info "HUP signal received, reloading"
-      ::OverSIP::Config.reload
+      log_system_notice "HUP signal received, reloading configuration files..."
+      ::OverSIP::Config.system_reload
+    end
+
+    # Signal USR1 reloads custom code provided by the user.
+    trap :USR1 do
+      log_system_notice "USR1 signal received, calling user provided OverSIP::SystemEvents.on_user_reload() callback..."
+      # Run the user provided on_started callback.
+      begin
+        ::OverSIP::SystemEvents.on_user_reload
+      rescue ::Exception => e
+        log_system_crit "error calling user provided OverSIP::SystemEvents.on_user_reload() callback:"
+        log_system_crit e
+      end
     end
 
     # Signal CHLD is sent by syslogger process if it dies.

data/lib/oversip/proxies_config.rb

@@ -9,8 +9,6 @@ module OverSIP
       @log_id ||= "ProxiesConfig"
     end
 
-    @proxies = {}
-
     @proxy_configuration = {
       :do_loose_routing           => true,
       :use_dns                    => true,
@@ -45,51 +43,53 @@ module OverSIP
       :tls_validation             => :boolean
     }
 
-    def self.load proxies_yaml
-      unless proxies_yaml.is_a? Hash
-        fatal "invalid proxies configuration file, it is not a collection"
-      end
-
+    def self.load proxies_yaml, reload=false
       begin
+        unless proxies_yaml.is_a? ::Hash
+          raise "invalid proxies configuration file, it is not a collection"
+        end
+
+        proxies = {}
+
         proxies_yaml.each do |proxy, conf|
-          unless proxy.is_a? String
-            fatal "proxy name is not a string (#{proxy.inspect})"
+          unless proxy.is_a? ::String
+            raise "proxy name is not a string (#{proxy.inspect})"
           end
 
-          @proxies[proxy.to_sym] = @proxy_configuration.dup
-          @proxies[proxy.to_sym].each do |parameter, default_value|
-            @proxies[proxy.to_sym][parameter] = default_value.clone rescue default_value
+          proxies[proxy.to_sym] = @proxy_configuration.dup
+          proxies[proxy.to_sym].each do |parameter, default_value|
+            proxies[proxy.to_sym][parameter] = default_value.clone rescue default_value
           end
 
           PROXY_CONFIG_VALIDATIONS.each do |parameter, validations|
             values = proxies_yaml[proxy][parameter.to_s]
-            validations = [ validations ]  unless validations.is_a?(Array)
+            validations = [ validations ]  unless validations.is_a?(::Array)
 
             if values == nil
               if validations.include? :required
-                fatal "#{proxy}[#{parameter}] requires a value"
+                raise "#{proxy}[#{parameter}] requires a value"
               end
               next
             end
 
-            if values.is_a? Array
+            if values.is_a? ::Array
               unless validations.include? :multi_value
-                fatal "#{proxy}[#{parameter}] does not allow multiple values"
+                raise "#{proxy}[#{parameter}] does not allow multiple values"
               end
 
               if validations.include? :non_empty and values.empty?
-                fatal "#{proxy}[#{parameter}] does not allow empty values"
+                raise "#{proxy}[#{parameter}] does not allow empty values"
               end
             end
 
-            values = ( values.is_a?(Array) ? values : [ values ] )
+            values = ( values.is_a?(::Array) ? values : [ values ] )
 
             values.each do |value|
               validations.each do |validation|
 
-                if validation.is_a? Symbol
+                if validation.is_a? ::Symbol
                   args = []
-                elsif validation.is_a? Array
+                elsif validation.is_a? ::Array
                   args = validation[1..-1]
                   validation = validation[0]
                 end
@@ -97,24 +97,27 @@ module OverSIP
                 next if [:required, :multi_value, :non_empty].include? validation
 
                 unless send validation, value, *args
-                  fatal "#{proxy}[#{parameter}] has invalid value '#{::OverSIP::Config.humanize_value value}' (does not satisfy '#{validation}' validation requirement)"
+                  raise "#{proxy}[#{parameter}] has invalid value '#{::OverSIP::Config.humanize_value value}' (does not satisfy '#{validation}' validation requirement)"
                 end
               end
 
-              @proxies[proxy.to_sym][parameter] = ( validations.include?(:multi_value) ? values : values[0] )
+              proxies[proxy.to_sym][parameter] = ( validations.include?(:multi_value) ? values : values[0] )
             end
 
           end  # PROXY_CONFIG_VALIDATIONS[section].each
         end  # proxies_yaml.each
 
-        post_process
-
-      rescue OverSIP::ConfigurationError => e
-        fatal "proxies configuration error: #{e.message}"
-      rescue => e
-        fatal e
+      rescue ::Exception => e
+        unless reload
+          fatal e.message
+        else
+          raise ::OverSIP::ConfigurationError, e.message
+        end
       end
 
+      @proxies = proxies
+      post_process
+
       ::OverSIP.proxies = @proxies
     end
 

data/lib/oversip/version.rb

@@ -5,8 +5,8 @@ module OverSIP
   module Version
     MAJOR = 1
     MINOR = 0
-    TINY  = 6
-    DEVEL = "beta3"  # Set to nil for stable releases.
+    TINY  = 7
+    DEVEL = "beta1"  # Set to nil for stable releases.
   end
 
   PROGRAM_NAME     = "OverSIP"

data/lib/oversip/websocket/listeners/tcp_server.rb

@@ -3,7 +3,6 @@ module OverSIP::WebSocket
   class TcpServer < ::EM::Connection
 
     include ::OverSIP::Logger
-    include ::OverSIP::WebSocket::Policy
 
     # Max size (bytes) of the buffered data when receiving message headers
     # (avoid DoS attacks).
@@ -71,7 +70,7 @@ module OverSIP::WebSocket
 
       @ws_framing.tcp_closed  if @ws_framing
 
-      if @state == :websocket_frames
+      if @ws_handshake_done
         begin
           ::OverSIP::Events.on_websocket_connection_closed self
         rescue ::Exception => e
@@ -209,19 +208,19 @@ module OverSIP::WebSocket
 
       # Check WebSocket policy.
 
-      unless check_hostport(@http_request.host, @http_request.port)
+      unless ::OverSIP::WebSocket::Policy.check_hostport(@http_request.host, @http_request.port)
         log_system_notice "host/port policy not satisfied (host=#{@http_request.host.inspect}, port=#{@http_request.port.inspect}) => 403"
         http_reject 403, "request host/port not satisfied"
         return false
       end
 
-      unless check_origin(@http_request.hdr_origin)
+      unless ::OverSIP::WebSocket::Policy.check_origin(@http_request.hdr_origin)
         log_system_notice "'Origin' policy not satisfied (origin=#{@http_request.hdr_origin.inspect}) => 403"
         http_reject 403, "request 'Origin' not satisfied"
         return false
       end
 
-      unless check_request_uri(@http_request.uri_path, @http_request.uri_query)
+      unless ::OverSIP::WebSocket::Policy.check_request_uri(@http_request.uri_path, @http_request.uri_query)
         log_system_notice "request URI path/query not satisfied (path=#{@http_request.uri_path.inspect}, query=#{@http_request.uri_query.inspect}) => 403"
         http_reject 403, "request URI path/query not satisfied"
         return false
@@ -242,7 +241,7 @@ module OverSIP::WebSocket
         return false
       end
 
-      # The user provided callback could have reject the WS connection,, so
+      # The user provided callback could have reject the WS connection, so
       # check it not to reply a 101 after the reply sent by the user.
       if @state == :new_websocket_connection_callback
         @state = :accept_ws_handshake
@@ -276,6 +275,7 @@ module OverSIP::WebSocket
       @ws_framing = ::OverSIP::WebSocket::WsFraming.new(self, @buffer)
       @ws_framing.ws_app = @ws_app_klass.new(self, @ws_framing)
 
+      @ws_handshake_done = true
       @state = :websocket_frames
       true
     end

data/lib/oversip/websocket/ws_framing.rb

@@ -575,7 +575,7 @@ module OverSIP::WebSocket
       unless in_reply_to_close
         # Let's some time for the client to send us a close frame (it will
         # be ignored anyway) before closing the TCP connection.
-        EM.add_timer(0.2) do
+        ::EM.add_timer(0.2) do
           @connection.close_connection_after_writing
         end
       else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversip
 version: !ruby/object:Gem::Version
-  version: 1.0.6.beta3
+  version: 1.0.7.beta1
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine-le
-  requirement: &9845920 !ruby/object:Gem::Requirement
+  requirement: &19620160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *9845920
+  version_requirements: *19620160
 - !ruby/object:Gem::Dependency
   name: iobuffer
-  requirement: &9845460 !ruby/object:Gem::Requirement
+  requirement: &19619700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *9845460
+  version_requirements: *19619700
 - !ruby/object:Gem::Dependency
   name: em-posixmq
-  requirement: &9861360 !ruby/object:Gem::Requirement
+  requirement: &19619240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *9861360
+  version_requirements: *19619240
 - !ruby/object:Gem::Dependency
   name: em-udns
-  requirement: &9860900 !ruby/object:Gem::Requirement
+  requirement: &19618780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *9860900
+  version_requirements: *19618780
 - !ruby/object:Gem::Dependency
   name: escape_utils
-  requirement: &9860440 !ruby/object:Gem::Requirement
+  requirement: &19618320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *9860440
+  version_requirements: *19618320
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &9860060 !ruby/object:Gem::Requirement
+  requirement: &19617940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9860060
+  version_requirements: *19617940
 - !ruby/object:Gem::Dependency
   name: posix-spawn
-  requirement: &9859520 !ruby/object:Gem::Requirement
+  requirement: &19617400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *9859520
+  version_requirements: *19617400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &9859020 !ruby/object:Gem::Requirement
+  requirement: &19616900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *9859020
+  version_requirements: *19616900
 description: ! "OverSIP is an async SIP server. Built on top of Ruby EventMachine\n
   \   library it follows the Reactor Pattern, allowing thousands of concurrent connections
   and requests\n    handled by a single processor in a never-blocking fashion. It