oversip 1.1.0.beta2 → 1.1.0.beta3

data/bin/oversip

@@ -5,6 +5,8 @@ unless RUBY_VERSION >= "1.9.2"
   raise ::LoadError, "OverSIP requires Ruby version >= 1.9.2 (current version is #{RUBY_VERSION})"
 end
 
+$LOAD_PATH.insert 0, File.expand_path(File.join(File.dirname(__FILE__), "../", "lib"))
+
 # When OverSIP is executed automaticaly via the system init (i.e. after booting the host)
 # the Encoding.default_external is US_ASCII which causes fails when reading daat from
 # some files (i.e. the cacert.pem file which contains no valid US_ASCII symbols). So
@@ -23,12 +25,13 @@ require "oversip"
 module OverSIP
 
   class Executable
+    extend ::OverSIP::Logger
 
     @log_id = "executable"
 
     def self.run
+      $0 = ::File.basename(__FILE__)
       ::OverSIP::Logger.load_methods
-      extend ::OverSIP::Logger
 
       # Options by default.
       options = {
@@ -48,6 +51,8 @@ module OverSIP
 
         opts.on("-p", "--process-name NAME", "Change the running process name, also affects to syslogger process and Posix Message Queue name (default 'oversip')") do |value|
           options[:process_name] = value
+          $0 = options[:process_name]
+          ::OverSIP::Logger.load_methods
         end
 
         opts.on("--config-dir DIR", "Absolute path to the directory with user configuration files (default '/etc/oversip/')") do |value|
@@ -166,13 +171,11 @@ module OverSIP
 
       # Set the command name (as it appears in "ps" output) to given --process_name option (-p)
       # or to the script filename otherwise.
-      $0 = options[:process_name] || ::File.basename(__FILE__)
-
-      ::OverSIP.master_name = $0
+      ::OverSIP.master_name = options[:process_name] || ::File.basename(__FILE__)
+      $0 = ::OverSIP.master_name
       log_system_info "master process name: #{::OverSIP.master_name}"
 
       ::OverSIP::Config.load options[:config_dir], options[:config_file]
-      log_system_info "applied configuration:"
       ::OverSIP::Config.print options[:colorize]
 
       log_system_info "creating Posix Message Queue for communicating master and syslogger processes"

data/etc/oversip.conf

@@ -22,9 +22,9 @@ core:
   nameservers: null
 
   # Syslog facility. Can be "user", "local0"..."local7".
-  # By default "user".
+  # By default "daemon".
   #
-  syslog_facility: user
+  syslog_facility: daemon
 
   # Syslog level. Can be "debug", "info", "notice", "warn", "error", "crit".
   # By default "info".

data/etc/server.rb

@@ -31,213 +31,208 @@ end
 
 
 
-### OverSIP Events:
+### OverSIP System Events:
 
 
-module OverSIP
-
-  ### System Events:
-
-
-  # This method is called once the OverSIP reactor has been started.
-  #
-  # def SystemEvents.on_started
-  #   [...]
-  # end
+# This method is called once the OverSIP reactor has been started.
+#
+# def (OverSIP::SystemEvents).on_started
+#   [...]
+# end
 
 
-  # This method is called when a USR1 signal is received by OverSIP main
-  # process and allows the user to set custom code to be executed
-  # or reloaded.
-  #
-  # def SystemEvents.on_user_reload
-  #   [...]
-  # end
+# This method is called when a USR1 signal is received by OverSIP main
+# process and allows the user to set custom code to be executed
+# or reloaded.
+#
+# def (OverSIP::SystemEvents).on_user_reload
+#   [...]
+# end
 
 
 
 
-  ### SIP Events:
+### OverSIP SIP Events:
 
 
-  # This method is called when a SIP request is received.
-  #
-  def SipEvents.on_request request
+# This method is called when a SIP request is received.
+#
+def (OverSIP::SipEvents).on_request request
 
-    log_info "#{request.sip_method} from #{request.from.uri} (UA: #{request.header("User-Agent")}) to #{request.ruri} via #{request.transport.upcase} #{request.source_ip} : #{request.source_port}"
+  log_info "#{request.sip_method} from #{request.from.uri} (UA: #{request.header("User-Agent")}) to #{request.ruri} via #{request.transport.upcase} #{request.source_ip} : #{request.source_port}"
 
-    # Check Max-Forwards value (max 10).
-    return unless request.check_max_forwards 10
+  # Check Max-Forwards value (max 10).
+  return unless request.check_max_forwards 10
 
-    # Assume all the traffic is from clients and help them with NAT issues
-    # by forcing rport usage and Outbound mechanism.
-    request.fix_nat
+  # Assume all the traffic is from clients and help them with NAT issues
+  # by forcing rport usage and Outbound mechanism.
+  request.fix_nat
 
-    # In-dialog requests.
-    if request.in_dialog?
-      if request.loose_route
-        log_debug "proxying in-dialog #{request.sip_method}"
-        request.proxy(:proxy_in_dialog).route
-      else
-        unless request.sip_method == :ACK
-          log_notice "forbidden in-dialog request without top Route pointing to us => 403"
-          request.reply 403, "forbidden in-dialog request without top Route pointing to us"
-        else
-          log_notice "ignoring not loose routing ACK"
-        end
-      end
-      return
-    end
-
-    # Initial requests.
-
-    # Check that the request does not contain a top Route pointing to another server.
+  # In-dialog requests.
+  if request.in_dialog?
     if request.loose_route
+      log_debug "proxying in-dialog #{request.sip_method}"
+      proxy = ::OverSIP::SIP::Proxy.new :proxy_in_dialog
+      proxy.route request
+    else
       unless request.sip_method == :ACK
-        log_notice "pre-loaded Route not allowed here => 403"
-        request.reply 403, "Pre-loaded Route not allowed"
+        log_notice "forbidden in-dialog request without top Route pointing to us => 403"
+        request.reply 403, "forbidden in-dialog request without top Route pointing to us"
       else
-        log_notice "ignoring ACK initial request"
+        log_notice "ignoring not loose routing ACK"
       end
-      return
     end
+    return
+  end
 
-    if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
-      # Extract the Outbound flow token from the RURI.
-      OverSIP::SIP::Modules::RegistrarWithoutPath.extract_outbound_from_ruri request
-    end
+  # Initial requests.
 
-    # The request goes to a client using Outbound through OverSIP.
-    if request.incoming_outbound_requested?
-      log_info "routing initial request to an Outbound client"
+  # Check that the request does not contain a top Route pointing to another server.
+  if request.loose_route
+    unless request.sip_method == :ACK
+      log_notice "pre-loaded Route not allowed here => 403"
+      request.reply 403, "Pre-loaded Route not allowed"
+    else
+      log_notice "ignoring ACK initial request"
+    end
+    return
+  end
 
-      proxy = request.proxy(:proxy_to_users)
+  if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
+    # Extract the Outbound flow token from the RURI.
+    OverSIP::SIP::Modules::RegistrarWithoutPath.extract_outbound_from_ruri request
+  end
 
-      proxy.on_success_response do |response|
-        log_info "incoming Outbound on_success_response: #{response.status_code} '#{response.reason_phrase}'"
-      end
+  # The request goes to a client using Outbound through OverSIP.
+  if request.incoming_outbound_requested?
+    log_info "routing initial request to an Outbound client"
 
-      proxy.on_failure_response do |response|
-        log_info "incoming Outbound on_failure_response: #{response.status_code} '#{response.reason_phrase}'"
-      end
+    proxy = ::OverSIP::SIP::Proxy.new :proxy_to_users
 
-      # on_error() occurs when no SIP response was received fom the peer and, instead, we
-      # got some other internal error (timeout, connection error, DNS error....).
-      proxy.on_error do |status, reason|
-        log_notice "incoming Outbound on_error: #{status} '#{reason}'"
-      end
+    proxy.on_success_response do |response|
+      log_info "incoming Outbound on_success_response: #{response.status_code} '#{response.reason_phrase}'"
+    end
 
-      # Route the request and return.
-      proxy.route
-      return
+    proxy.on_failure_response do |response|
+      log_info "incoming Outbound on_failure_response: #{response.status_code} '#{response.reason_phrase}'"
     end
 
-    # An initial request with us (OverSIP) as final destination, ok, received, bye...
-    if request.destination_myself?
-      log_info "request for myself => 404"
-      request.reply 404, "Ok, I'm here"
-      return
+    # on_error() occurs when no SIP response was received fom the peer and, instead, we
+    # got some other internal error (timeout, connection error, DNS error....).
+    proxy.on_error do |status, reason|
+      log_notice "incoming Outbound on_error: #{status} '#{reason}'"
     end
 
-    # An outgoing initial request.
-    case request.sip_method
+    # Route the request and return.
+    proxy.route request
+    return
+  end
 
-    when :INVITE, :MESSAGE, :OPTIONS, :SUBSCRIBE, :PUBLISH
+  # An initial request with us (OverSIP) as final destination, ok, received, bye...
+  if request.destination_myself?
+    log_info "request for myself => 404"
+    request.reply 404, "Ok, I'm here"
+    return
+  end
 
-      if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
-        ::OverSIP::SIP::Modules::UserAssertion.add_pai request
-      end
+  # An outgoing initial request.
+  case request.sip_method
 
-      proxy = request.proxy(:proxy_out)
+  when :INVITE, :MESSAGE, :OPTIONS, :SUBSCRIBE, :PUBLISH
 
-      proxy.on_provisional_response do |response|
-        log_info "on_provisional_response: #{response.status_code} '#{response.reason_phrase}'"
-      end
+    if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
+      ::OverSIP::SIP::Modules::UserAssertion.add_pai request
+    end
 
-      proxy.on_success_response do |response|
-        log_info "on_success_response: #{response.status_code} '#{response.reason_phrase}'"
-      end
+    proxy = ::OverSIP::SIP::Proxy.new :proxy_out
 
-      proxy.on_failure_response do |response|
-        log_info "on_failure_response: #{response.status_code} '#{response.reason_phrase}'"
-      end
+    proxy.on_provisional_response do |response|
+      log_info "on_provisional_response: #{response.status_code} '#{response.reason_phrase}'"
+    end
 
-      proxy.on_error do |status, reason|
-        log_notice "on_error: #{status} '#{reason}'"
-      end
+    proxy.on_success_response do |response|
+      log_info "on_success_response: #{response.status_code} '#{response.reason_phrase}'"
+    end
 
-      proxy.route
-      return
+    proxy.on_failure_response do |response|
+      log_info "on_failure_response: #{response.status_code} '#{response.reason_phrase}'"
+    end
 
-    when :REGISTER
+    proxy.on_error do |status, reason|
+      log_notice "on_error: #{status} '#{reason}'"
+    end
 
-      if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
-        # Contact mangling for the case in which the registrar does not support Path.
-        ::OverSIP::SIP::Modules::RegistrarWithoutPath.add_outbound_to_contact request
-      end
+    proxy.route request
+    return
 
-      proxy = request.proxy(:proxy_out)
+  when :REGISTER
 
-      proxy.on_success_response do |response|
-        if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
-          # Undo changes done to the Contact header provided by the client, so it receives
-          # the same value in the 200 response from the registrar.
-          ::OverSIP::SIP::Modules::RegistrarWithoutPath.remove_outbound_from_contact response
-        end
+    if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
+      # Contact mangling for the case in which the registrar does not support Path.
+      ::OverSIP::SIP::Modules::RegistrarWithoutPath.add_outbound_to_contact request
+    end
 
-        if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
-          # The registrar replies 200 after a REGISTER with credentials so let's assert
-          # the current SIP user to this connection.
-          ::OverSIP::SIP::Modules::UserAssertion.assert_connection response
-        end
-      end
+    proxy = ::OverSIP::SIP::Proxy.new :proxy_out
 
-      proxy.on_failure_response do |response|
-        if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
-          # We don't add PAI for re-REGISTER, so 401 will be replied, and after it let's
-          # revoke the current user assertion (will be re-added upon REGISTER with credentials).
-          ::OverSIP::SIP::Modules::UserAssertion.revoke_assertion response
-        end
+    proxy.on_success_response do |response|
+      if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
+        # Undo changes done to the Contact header provided by the client, so it receives
+        # the same value in the 200 response from the registrar.
+        ::OverSIP::SIP::Modules::RegistrarWithoutPath.remove_outbound_from_contact response
       end
 
-      proxy.route
-      return
+      if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
+        # The registrar replies 200 after a REGISTER with credentials so let's assert
+        # the current SIP user to this connection.
+        ::OverSIP::SIP::Modules::UserAssertion.assert_connection response
+      end
+    end
 
-    else
+    proxy.on_failure_response do |response|
+      if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
+        # We don't add PAI for re-REGISTER, so 401 will be replied, and after it let's
+        # revoke the current user assertion (will be re-added upon REGISTER with credentials).
+        ::OverSIP::SIP::Modules::UserAssertion.revoke_assertion response
+      end
+    end
 
-      log_info "method #{request.sip_method} not implemented => 501"
-      request.reply 501, "Not Implemented"
-      return
+    proxy.route request
+    return
 
-    end
-  end
+  else
 
+    log_info "method #{request.sip_method} not implemented => 501"
+    request.reply 501, "Not Implemented"
+    return
 
+  end
+end
 
 
-  ### WebSocket Events:
 
 
-  # This method is called when a new WebSocket connection is being requested.
-  # Here you can inspect the connection and the HTTP GET request. If you
-  # decide not to accept this connection then call to:
-  #
-  #   connection.http_reject(status_code, reason_phrase=nil, extra_headers=nil)
-  #
-  # You can also set variables for this connection via the connection.cvars
-  # Hash. Later you can access to this Hash in SIP request from this connection
-  # by accessing to request.cvars attribute.
-  #
-  # def WebSocketEvents.on_connection connection, http_request
-  #   [...]
-  # end
+### OverSIP WebSocket Events:
 
 
-  # This method is called when a WebSocket connection is closed.
-  #
-  # def WebSocketEvents.on_connection_closed connection
-  #   [...]
-  # end
+# This method is called when a new WebSocket connection is being requested.
+# Here you can inspect the connection and the HTTP GET request. If you
+# decide not to accept this connection then call to:
+#
+#   connection.http_reject(status_code, reason_phrase=nil, extra_headers=nil)
+#
+# You can also set variables for this connection via the connection.cvars
+# Hash. Later you can access to this Hash in SIP requests from this connection
+# by retrieving request.cvars attribute.
+#
+# def (OverSIP::WebSocketEvents).on_connection connection, http_request
+#   [...]
+# end
 
 
-end  # module OverSIP
+# This method is called when a WebSocket connection is closed. The connection
+# is given as first argument along with a second argument "client_closed" which
+# is _true_ in case the WebSocket connection was closed by the client.
+#
+# def (OverSIP::WebSocketEvents).on_connection_closed connection, client_closed
+#   [...]
+# end

data/lib/oversip/default_server.rb

@@ -32,7 +32,7 @@ module OverSIP
       log_system_notice "on_connection() event is not defined"
     end
 
-    def self.on_connection_closed connection
+    def self.on_connection_closed connection, client_closed
       log_system_notice "on_connection_closed() event is not defined"
     end
 

data/lib/oversip/errors.rb

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

data/lib/oversip/launcher.rb

@@ -552,7 +552,7 @@ module OverSIP::Launcher
     ::OverSIP.stud_pids ||= []
     ::OverSIP.stud_pids << pid
 
-    log_system_info "spawned stud server (PID #{pid}) listening into #{listen_ip} : #{listen_port}"
+    log_system_info "spawned stud server (PID #{pid}) listening on #{listen_ip} : #{listen_port}"
   end
 
 

data/lib/oversip/logger.rb

@@ -5,17 +5,6 @@ module OverSIP
   # attribute.
   module Logger
 
-    SYSLOG_POSIXMQ_MAPPING = {
-      "debug"  => 0,
-      "info"   => 1,
-      "notice" => 2,
-      "warn"   => 3,
-      "error"  => 4,
-      "crit"   => 5,
-      "alert"  => 6,
-      "emerg"  => 7
-    }
-
     def self.init_logger_mq group=nil
       @@logger_mq = ::OverSIP::PosixMQ.create_queue({
         :name    => ::OverSIP.syslogger_mq_name,
@@ -28,8 +17,17 @@ module OverSIP
 
 
     def self.load_methods
+      # When not yet daemonized, also log to syslog.
+      if not ::OverSIP.daemonized?
+        ::Syslog.close  if ::Syslog.opened?
+
+        syslog_options = ::Syslog::LOG_PID | ::Syslog::LOG_NDELAY
+        syslog_facility = ::OverSIP::Syslog::SYSLOG_FACILITY_MAPPING[::OverSIP.configuration[:core][:syslog_facility]] rescue ::Syslog::LOG_DAEMON
+        ::Syslog.open(::OverSIP.master_name, syslog_options, syslog_facility)
+      end
+
       begin
-        @@threshold = SYSLOG_POSIXMQ_MAPPING[::OverSIP.configuration[:core][:syslog_level]]
+        @@threshold = ::OverSIP::Syslog::SYSLOG_SEVERITY_MAPPING[::OverSIP.configuration[:core][:syslog_level]]
       rescue
         @@threshold = 0  # debug.
       end
@@ -38,7 +36,7 @@ module OverSIP
 
       @@congested = false
 
-      SYSLOG_POSIXMQ_MAPPING.each do |level, level_value|
+      ::OverSIP::Syslog::SYSLOG_SEVERITY_MAPPING.each do |level, level_value|
         method_str = "
           def log_system_#{level}(msg)
         "
@@ -49,27 +47,33 @@ module OverSIP
             begin
               unless @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(#{level_value}, msg, log_id), 0
                 @@congested = true
-                EM.add_timer(1) do
+                ::EM.add_timer(1) do
                   @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"logger message queue was full, some logs have been lost\", log_id), 1
                   @@congested = false
                 end
               end
-            rescue Errno::EMSGSIZE
+            rescue ::Errno::EMSGSIZE
               @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"too long message could not be logged\", log_id), 1 rescue nil
-            rescue => e
+            rescue ::Exception => e
               @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"unexpected logging error (\#{e.class}: \#{e.message})\", log_id), 1 rescue nil
             end
           "
         end
 
-        unless ::OverSIP.daemonized?
+        if not ::OverSIP.daemonized?
           if %w{debug info notice}.include? level
             method_str << "
               puts ::OverSIP::Logger.fg_system_msg2str('#{level}', msg, log_id)
+              if not ::OverSIP.syslogger_ready?
+                ::OverSIP::Syslog.log ::OverSIP::Logger.syslog_system_msg2str(#{level_value}, msg, log_id)
+              end
             "
           else
             method_str << "
               $stderr.puts ::OverSIP::Logger.fg_system_msg2str('#{level}', msg, log_id)
+              if not ::OverSIP.syslogger_ready?
+                ::OverSIP::Syslog.log ::OverSIP::Logger.syslog_system_msg2str(#{level_value}, msg, log_id)
+              end
             "
           end
         end
@@ -80,21 +84,21 @@ module OverSIP
 
 
         if ::OverSIP.syslogger_ready?
-          # User/script logs.
+          # User logs.
           method_str = "
             def log_#{level}(msg)
               return false if @@threshold > #{level_value} || @@congested
               begin
                 unless @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(#{level_value}, msg, log_id), 0
                   @@congested = true
-                  EM.add_timer(1) do
+                  ::EM.add_timer(1) do
                     @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"logger message queue was full, some logs have been lost\", log_id), 1
                     @@congested = false
                   end
                 end
-              rescue Errno::EMSGSIZE
+              rescue ::Errno::EMSGSIZE
                 @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"too long message could not be logged\", log_id), 1 rescue nil
-              rescue => e
+              rescue ::Exception => e
                 @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"unexpected logging error (\#{e.class}: \#{e.message})\", log_id), 1 rescue nil
               end
             end
@@ -133,11 +137,11 @@ module OverSIP
     def self.syslog_user_msg2str(level_value, msg, log_id)
       case msg
       when ::String
-        level_value.to_s << "<" << log_id << "> script: " << msg
+        level_value.to_s << "<" << log_id << "> [user] " << msg
       when ::Exception
-        "#{level_value}<#{log_id}> script: #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}"
+        "#{level_value}<#{log_id}> [user] #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}"
       else
-        level_value.to_s << "<" << log_id << "> script: " << msg.inspect
+        level_value.to_s << "<" << log_id << "> [user] " << msg.inspect
       end
     end
 

data/lib/oversip/posix_mq.rb

@@ -110,7 +110,7 @@ module OverSIP
       ::Process::GID.change_privilege(orig_gid)  if mq_group
 
       if mq.attr.maxmsg == mq_attr.maxmsg and mq.attr.msgsize == mq_attr.msgsize
-        log_system_debug "maxmsg=#{mq.attr.maxmsg}, msgsize=#{mq.attr.msgsize}"  if $oversip_debug
+        log_system_info "maxmsg=#{mq.attr.maxmsg}, msgsize=#{mq.attr.msgsize}"
       else
         log_system_warn "maxmsg=#{mq.attr.maxmsg}, msgsize=#{mq.attr.msgsize}, " \
                     "but recommended values are maxmsg=#{mq_attr.maxmsg}, msgsize=#{mq_attr.msgsize}"

data/lib/oversip/sip/listeners/tcp_reactor.rb

@@ -25,7 +25,6 @@ module OverSIP::SIP
           get_body
 
         when :finished
-          # Invoke the custom logic for requests.
           if @msg.request?
             process_request
           else

data/lib/oversip/sip/listeners/tls_tunnel_reactor.rb

@@ -35,7 +35,6 @@ module OverSIP::SIP
           get_body
 
         when :finished
-          # Invoke the custom logic for requests.
           if @msg.request?
             process_request
           else

data/lib/oversip/sip/listeners/tls_tunnel_server.rb

@@ -15,7 +15,7 @@ module OverSIP::SIP
         return
       end
 
-      log_system_debug "connection from the TLS tunnel " << remote_desc
+      log_system_debug ("connection from the TLS tunnel " << remote_desc)  if $oversip_debug
 
       # Create an Outbound (RFC 5626) flow token for this connection.
       @outbound_flow_token = ::OverSIP::SIP::TransportManager.add_outbound_connection self

data/lib/oversip/sip/listeners/udp_reactor.rb

@@ -15,7 +15,6 @@ module OverSIP::SIP
           parse_message
 
         when :finished
-          # Invoke the custom logic for requests.
           if @msg.request?
             process_request
           else

data/lib/oversip/sip/message.rb

@@ -163,6 +163,14 @@ module OverSIP::SIP
       end
     end
 
+    # Close the connection from which the SIP request/response has been
+    # received.
+    def close_connection
+      return false  if @transport == :udp
+      @connection.close_connection
+      true
+    end
+
   end  # class Message
 
 end

data/lib/oversip/sip/message_processor.rb

@@ -73,8 +73,8 @@ module OverSIP::SIP
 
 
     def process_request
-      # Create a new Logic instance for this request (unless it's a retransmission of the request,
-      # a CANCEL or an ACK for a final non-2XX response).
+      # Run the user provided OverSIP::SipEvents.on_request() callback (unless the request
+      # it's a retransmission, a CANCEL or an ACK for a final non-2XX response).
       unless check_transaction
         begin
           # Create the antiloop identifier for this request.
@@ -90,7 +90,7 @@ module OverSIP::SIP
           @msg.tvars = {}
           @msg.cvars = @cvars
 
-          # Run the user provided OverSIP::SipEvents.on_request() callback.
+          # Run the callback.
           ::OverSIP::SipEvents.on_request @msg
         rescue ::Exception => e
           log_system_error "error calling OverSIP::WebSocketEvents.on_request() => 500:"

data/lib/oversip/sip/modules/core.rb

@@ -33,17 +33,6 @@ module OverSIP::SIP
       end
 
 
-      # Returns a Proxy instance. The user MUST call route() and optionally set the callbacks
-      # before calling route().
-      def proxy proxy_name=:default_proxy
-        if (proxy_conf = ::OverSIP.proxies[proxy_name.to_sym])
-          ::OverSIP::SIP::Proxy.new self, proxy_conf
-        else
-          raise ::OverSIP::LogicError, "proxy '#{proxy_name}' is not defined"
-        end
-      end
-
-
       def loose_route
         num_removes = 0
         has_preloaded_route_with_ob_param = false

data/lib/oversip/sip/modules/registrar_without_path.rb

@@ -11,7 +11,7 @@ module OverSIP::SIP
 
       def self.add_outbound_to_contact request
         unless request.sip_method == :REGISTER
-          raise ::OverSIP::LogicError, "request must be a REGISTER"
+          raise ::OverSIP::RuntimeError, "request must be a REGISTER"
         end
 
         if request.contact and request.connection_outbound_flow_token
@@ -52,7 +52,7 @@ module OverSIP::SIP
 
       def self.remove_outbound_from_contact message
         unless message.is_a? ::OverSIP::SIP::Message
-          raise ::OverSIP::LogicError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
+          raise ::OverSIP::RuntimeError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
         end
 
         if (contacts = message.headers["Contact"])

data/lib/oversip/sip/modules/user_assertion.rb

@@ -16,7 +16,7 @@ module OverSIP::SIP
         when ::OverSIP::SIP::Response
           request = message.request
         else
-          raise ::OverSIP::LogicError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
+          raise ::OverSIP::RuntimeError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
         end
 
         # Don't do this stuf for UDP or for outbound connections.
@@ -38,7 +38,7 @@ module OverSIP::SIP
         when ::OverSIP::SIP::Response
           request = message.request
         else
-          raise ::OverSIP::LogicError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
+          raise ::OverSIP::RuntimeError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
         end
 
         request.connection.asserted_user = false

data/lib/oversip/sip/proxy.rb

@@ -4,25 +4,11 @@ module OverSIP::SIP
 
     include ::OverSIP::Logger
 
-    def initialize request, proxy_conf
-      @request = request
-      @proxy_conf = proxy_conf
-      @log_id = "Proxy #{proxy_conf[:name]} #{request.via_branch_id}"
-
-      # Create the server transaction if it doesn't exist yet.
-      @server_transaction = @request.server_transaction or case @request.sip_method
-        # Here it can arrive an INVITE, ACK-for-2XX and any method but CANCEL.
-        when :INVITE
-          InviteServerTransaction.new @request
-        when :ACK
-        else
-          NonInviteServerTransaction.new @request
-        end
-      @request.server_transaction ||= @server_transaction
-
-      # Set this core layer to the server transaction.
-      @request.server_transaction.core = self  if @request.server_transaction
-    end  # initialize
+    def initialize proxy_name=:default_proxy
+      unless (@proxy_conf = ::OverSIP.proxies[proxy_name.to_sym])
+        raise ::OverSIP::RuntimeError, "proxy '#{proxy_name}' is not defined in Proxies Configuration file"
+      end
+    end
 
 
     def on_provisional_response &block
@@ -55,7 +41,27 @@ module OverSIP::SIP
     end
 
 
-    def route dst_host=nil, dst_port=nil, dst_transport=nil
+    def route request, dst_host=nil, dst_port=nil, dst_transport=nil
+      unless (@request = request).is_a? ::OverSIP::SIP::Request
+        raise ::OverSIP::RuntimeError, "request must be a OverSIP::SIP::Request instance"
+      end
+
+      @log_id = "Proxy #{@proxy_conf[:name]} #{@request.via_branch_id}"
+
+      # Create the server transaction if it doesn't exist yet.
+      @server_transaction = @request.server_transaction or case @request.sip_method
+        # Here it can arrive an INVITE, ACK-for-2XX and any method but CANCEL.
+        when :INVITE
+          InviteServerTransaction.new @request
+        when :ACK
+        else
+          NonInviteServerTransaction.new @request
+        end
+      @request.server_transaction ||= @server_transaction
+
+      # Set this core layer to the server transaction.
+      @request.server_transaction.core = self  if @request.server_transaction
+
       # NOTE: Routing can be based on incoming request for an Outbound (RFC 5626) connection
       # or based on normal RFC 3263 procedures.
 
@@ -179,7 +185,7 @@ module OverSIP::SIP
 
 
     def receive_response response
-      log_system_debug "received response #{response.status_code}"
+      log_system_debug "received response #{response.status_code}"  if $oversip_debug
 
       response.delete_header_top "Via"
 

data/lib/oversip/syslog.rb

@@ -0,0 +1,58 @@
+module OverSIP
+
+  module Syslog
+
+    SYSLOG_FACILITY_MAPPING = {
+      "kern"    => ::Syslog::LOG_KERN,
+      "user"    => ::Syslog::LOG_USER,
+      "daemon"  => ::Syslog::LOG_DAEMON,
+      "local0"  => ::Syslog::LOG_LOCAL0,
+      "local1"  => ::Syslog::LOG_LOCAL1,
+      "local2"  => ::Syslog::LOG_LOCAL2,
+      "local3"  => ::Syslog::LOG_LOCAL3,
+      "local4"  => ::Syslog::LOG_LOCAL4,
+      "local5"  => ::Syslog::LOG_LOCAL5,
+      "local6"  => ::Syslog::LOG_LOCAL6,
+      "local7"  => ::Syslog::LOG_LOCAL7
+    }
+
+    SYSLOG_SEVERITY_MAPPING = {
+      "debug"  => 0,
+      "info"   => 1,
+      "notice" => 2,
+      "warn"   => 3,
+      "error"  => 4,
+      "crit"   => 5,
+      "alert"  => 6,
+      "emerg"  => 7
+    }
+
+    def self.log string
+      level = string.getbyte 0
+      msg   = string[1..-1].gsub(/%/,"%%").gsub(/\x00/,"")
+
+      case level
+      when 48  # "0" =>DEBUG
+        ::Syslog.debug sprintf("%7s %s", "DEBUG:", msg)
+      when 49  # "1" => INFO
+        ::Syslog.info sprintf("%7s %s", "INFO:", msg)
+      when 50  # "2" => NOTICE
+        ::Syslog.notice sprintf("%7s %s", "NOTICE:", msg)
+      when 51  # "3" => WARN
+        ::Syslog.warning sprintf("%7s %s", "WARN:", msg)
+      when 52  # "4" => ERR
+        ::Syslog.err sprintf("%7s %s", "ERROR:", msg)
+      when 53  # "5" => CRIT
+        ::Syslog.crit sprintf("%7s %s", "CRIT:", msg)
+      when 54  # "6" => ALERT
+        ::Syslog.alert sprintf("%7s %s", "ALERT:", msg)
+      when 55  # "7" => EMERG
+        ::Syslog.emerg sprintf("%7s %s", "EMERG:", msg)
+      else  # Shouldn't occur.
+        ::Syslog.err sprintf("%7s %s", "UNKNOWN:", msg)
+      end
+    end
+
+  end
+
+end

data/lib/oversip/syslogger_process.rb

@@ -1,8 +1,3 @@
-# Ruby built-in libraries.
-
-require "syslog"
-
-
 # Ruby external gems.
 
 gem "eventmachine-le", ">= 1.1.2"
@@ -21,46 +16,10 @@ module OverSIP
 
   module SysLoggerProcess
 
-    SYSLOG_FACILITY_MAPPING = {
-      "kern"    => ::Syslog::LOG_KERN,
-      "user"    => ::Syslog::LOG_USER,
-      "daemon"  => ::Syslog::LOG_DAEMON,
-      "local0"  => ::Syslog::LOG_LOCAL0,
-      "local1"  => ::Syslog::LOG_LOCAL1,
-      "local2"  => ::Syslog::LOG_LOCAL2,
-      "local3"  => ::Syslog::LOG_LOCAL3,
-      "local4"  => ::Syslog::LOG_LOCAL4,
-      "local5"  => ::Syslog::LOG_LOCAL5,
-      "local6"  => ::Syslog::LOG_LOCAL6,
-      "local7"  => ::Syslog::LOG_LOCAL7
-    }
-
     class SysLoggerWatcher < ::EM::PosixMQ::Watcher
 
       def receive_message string, priority
-        level = string.getbyte 0
-        msg   = string[1..-1].gsub(/%/,"%%").gsub(/\x00/,"")
-
-        case level
-        when 48  # "0" =>DEBUG
-          ::Syslog.debug sprintf("%7s %s", "DEBUG:", msg)
-        when 49  # "1" => INFO
-          ::Syslog.info sprintf("%7s %s", "INFO:", msg)
-        when 50  # "2" => NOTICE
-          ::Syslog.notice sprintf("%7s %s", "NOTICE:", msg)
-        when 51  # "3" => WARN
-          ::Syslog.warning sprintf("%7s %s", "WARN:", msg)
-        when 52  # "4" => ERR
-          ::Syslog.err sprintf("%7s %s", "ERROR:", msg)
-        when 53  # "5" => CRIT
-          ::Syslog.crit sprintf("%7s %s", "CRIT:", msg)
-        when 54  # "6" => ALERT
-          ::Syslog.alert sprintf("%7s %s", "ALERT:", msg)
-        when 55  # "7" => EMERG
-          ::Syslog.emerg sprintf("%7s %s", "EMERG:", msg)
-        else  # Shouldn't occur.
-          ::Syslog.err sprintf("%7s %s", "UNKNOWN:", msg)
-        end
+        ::OverSIP::Syslog.log string
       end
 
     end  # class SysLoggerWatcher
@@ -68,8 +27,12 @@ module OverSIP
     def self.run options={}
       $0 = ::OverSIP.master_name + "_syslogger"
 
+      # Close Ruby Syslog open in the main process before forking.
+      ::Syslog.close
+
+      # Run a new Ruby Syslog.
       syslog_options = ::Syslog::LOG_PID | ::Syslog::LOG_NDELAY
-      syslog_facility = SYSLOG_FACILITY_MAPPING[::OverSIP.configuration[:core][:syslog_facility]]
+      syslog_facility = ::OverSIP::Syslog::SYSLOG_FACILITY_MAPPING[::OverSIP.configuration[:core][:syslog_facility]]
       ::Syslog.open(::OverSIP.master_name, syslog_options, syslog_facility)
 
       ppid = ::Process.ppid
@@ -87,7 +50,7 @@ module OverSIP
           # Change process permissions if requested.
           ::OverSIP::Launcher.set_user_group(options[:user], options[:group])
 
-        rescue => e
+        rescue ::Exception => e
           ::Syslog.crit sprintf("%7s %s", "CRIT:", "<syslogger> #{e.class}: #{e}")
           ::Syslog.crit sprintf("%7s %s", "CRIT:", "<syslogger> syslogger process terminated")
           exit! 1

data/lib/oversip/version.rb

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

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

@@ -20,6 +20,7 @@ module OverSIP::WebSocket
     attr_accessor :ws_protocol, :ws_app_klass
     attr_reader :connection_log_id, :remote_ip_type, :remote_ip, :remote_port
     attr_reader :cvars  # A Hash for storing user provided data.
+    attr_accessor :ws_locally_closed
 
 
     def initialize
@@ -72,7 +73,7 @@ module OverSIP::WebSocket
 
       if @ws_handshake_done
         begin
-          ::OverSIP::WebSocketEvents.on_connection_closed self
+          ::OverSIP::WebSocketEvents.on_connection_closed self, !@ws_locally_closed
         rescue ::Exception => e
           log_system_error "error calling OverSIP::WebSocketEvents.on_connection_closed():"
           log_system_error e

data/lib/oversip/websocket/ws_app.rb

@@ -24,6 +24,7 @@ module OverSIP::WebSocket
 
     def close_connection status=nil, reason=nil
       @ws_framing.send_close_frame status, reason
+      @connection.ws_locally_closed = true
     end
 
 

data/lib/oversip/websocket/ws_framing.rb

@@ -535,7 +535,7 @@ module OverSIP::WebSocket
       end
 
       unless in_reply_to_close
-        log_system_notice "sending close frame: status=#{status.inspect}, reason=#{reason.inspect}"
+        log_system_debug "sending close frame: status=#{status.inspect}, reason=#{reason.inspect}"  if $oversip_debug
       else
         log_system_debug "sending reply close frame: status=#{status.inspect}, reason=#{reason.inspect}"  if $oversip_debug
       end
@@ -572,15 +572,21 @@ module OverSIP::WebSocket
       @connection.ignore_incoming_data
       @connection.send_data frame
 
-      unless in_reply_to_close
+      # NOTE: Don't do it since it "seems" that the connection has been closed
+      # by the client.
+      #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
-          @connection.close_connection_after_writing
-        end
-      else
-        @connection.close_connection_after_writing
-      end
+        # NOTE: Don't do it since it "seems" that the connection has been closed
+        # by the client.
+        #::EM.add_timer(0.2) do
+          #@connection.close_connection_after_writing
+        #end
+      #else
+        #@connection.close_connection_after_writing
+      #end
+
+      @connection.close_connection_after_writing
       true
     end
 

data/lib/oversip.rb

@@ -12,11 +12,13 @@ require "tempfile"
 
 require "term/ansicolor"
 require "posix_mq"
+require "syslog"
 
 
 # OverSIP files.
 
 require "oversip/version.rb"
+require "oversip/syslog.rb"
 require "oversip/logger.rb"
 require "oversip/config.rb"
 require "oversip/config_validators.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversip
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta2
+  version: 1.1.0.beta3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-03 00:00:00.000000000 Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine-le
-  requirement: &17173880 !ruby/object:Gem::Requirement
+  requirement: &18084900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *17173880
+  version_requirements: *18084900
 - !ruby/object:Gem::Dependency
   name: iobuffer
-  requirement: &17173420 !ruby/object:Gem::Requirement
+  requirement: &18084440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *17173420
+  version_requirements: *18084440
 - !ruby/object:Gem::Dependency
   name: em-posixmq
-  requirement: &17172960 !ruby/object:Gem::Requirement
+  requirement: &18083980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *17172960
+  version_requirements: *18083980
 - !ruby/object:Gem::Dependency
   name: em-udns
-  requirement: &17172500 !ruby/object:Gem::Requirement
+  requirement: &18099900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *17172500
+  version_requirements: *18099900
 - !ruby/object:Gem::Dependency
   name: escape_utils
-  requirement: &17172040 !ruby/object:Gem::Requirement
+  requirement: &18099440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *17172040
+  version_requirements: *18099440
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &17171660 !ruby/object:Gem::Requirement
+  requirement: &18099060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17171660
+  version_requirements: *18099060
 - !ruby/object:Gem::Dependency
   name: posix-spawn
-  requirement: &17171120 !ruby/object:Gem::Requirement
+  requirement: &18098520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *17171120
+  version_requirements: *18098520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &17170620 !ruby/object:Gem::Requirement
+  requirement: &18098020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *17170620
+  version_requirements: *18098020
 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
@@ -120,6 +120,7 @@ files:
 - lib/oversip/posix_mq.rb
 - lib/oversip/proxies_config.rb
 - lib/oversip/utils.rb
+- lib/oversip/syslog.rb
 - lib/oversip/errors.rb
 - lib/oversip/master_process.rb
 - lib/oversip/default_server.rb