oversip 1.1.0.beta3 → 1.1.0.beta4

data/README.md

@@ -1,5 +1,7 @@
 <a href="http://www.oversip.net"><img src="http://www-test.oversip.net/images/dev/oversip-banner.png"/></a>
 
+[![Build Status](https://secure.travis-ci.org/versatica/OverSIP.png?branch=master)](http://travis-ci.org/versatica/OverSIP)
+
 **WEB UNDER CONSTRUCTION:** The code is stable and working. This web page and documentation is not... please wait a bit.
 
 OverSIP is an async SIP proxy/server programmable in Ruby language.

data/etc/server.rb

@@ -50,6 +50,15 @@ end
 # end
 
 
+# This method is called after OverSIP has been terminated. It's called
+# with argument "error" which is _true_ in case OverSIP has died in an
+# unexpected way.
+#
+# def (OverSIP::SystemEvents).on_terminated error
+#   [...]
+# end
+
+
 
 
 ### OverSIP SIP Events:

data/ext/sip_parser/sip_parser_ruby.c

@@ -642,7 +642,7 @@ static void header_param(VALUE parsed, enum header_field header_field, const cha
   TRACE();
   VALUE v;
   VALUE header_params;
-  
+
   switch(header_field) {
     case header_field_via:
       if ((header_params = rb_ivar_get(parsed, id_via_params)) == Qnil) {

data/lib/oversip/default_server.rb

@@ -12,6 +12,11 @@ module OverSIP
       log_system_notice "on_user_reload() event is not defined"
     end
 
+    def self.on_terminated error
+      log_system_notice "on_terminated() event is not defined"
+    end
+
+
   end
 
   module SipEvents

data/lib/oversip/launcher.rb

@@ -8,6 +8,8 @@ module OverSIP::Launcher
 
 
   def self.daemonize!(options)
+    @log_id = "launcher (daemonize)"
+
     $stdin.reopen("/dev/null")
 
     # grandparent (launcher)  : Reads pipe, exits when master is ready.
@@ -30,7 +32,7 @@ module OverSIP::Launcher
       # its PID.
       master_pid = nil
       begin
-        ::Timeout::timeout(READY_PIPE_TIMEOUT/2) do
+        ::Timeout.timeout(READY_PIPE_TIMEOUT/2) do
           master_pid = rd.gets("\n").to_i rescue nil
         end
       rescue ::Timeout::Error
@@ -80,6 +82,8 @@ module OverSIP::Launcher
 
 
   def self.run(options)
+    @log_id = "launcher (run)"
+
     configuration = ::OverSIP.configuration
 
     # Store the master process PID.
@@ -94,7 +98,6 @@ module OverSIP::Launcher
       # I'm master process.
       if (syslogger_pid = fork) != nil
         ::OverSIP.syslogger_pid = syslogger_pid
-        log_system_info "starting syslogger process (PID #{syslogger_pid})..."
         ::OverSIP::Logger.load_methods
 
         # Load all the libraries for the master process.
@@ -117,6 +120,8 @@ module OverSIP::Launcher
         exit
       end
 
+      @log_id = "launcher (master)"
+
       ::EM.run do
 
         log_system_info "using Ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE} revision #{RUBY_REVISION}) [#{RUBY_PLATFORM}]"
@@ -402,10 +407,17 @@ module OverSIP::Launcher
 
 
   def self.trap_signals
-    # This should never occur, but maybe if I've missed trapping a signal.
+    # This should never occur (unless some not trapped signal is received
+    # and causes Ruby to exit, or maybe the user called "exit()" within its
+    # custom code).
     at_exit do
-      log_system_crit "exiting due to an unknown cause ($! = #{$!.inspect})..."
-      terminate
+      if $!.is_a? ::SystemExit
+        log_system_notice "exiting due to SystemExit..."
+        terminate error=false
+      else
+        log_system_crit "exiting due to an unknown cause ($! = #{$!.inspect})..."
+        terminate error=true
+      end
     end
 
     # Signals that cause OverSIP to terminate.
@@ -413,7 +425,7 @@ module OverSIP::Launcher
     exit_signals.each do |signal|
       trap signal do
         log_system_notice "#{signal} signal received, exiting..."
-        terminate
+        terminate error=false
       end
     end
 
@@ -459,22 +471,35 @@ module OverSIP::Launcher
   end
 
 
-  def self.terminate error=false
+  def self.terminate error=false, fatal=false
+    unless fatal
+      # Run the user provided on_terminated callback.
+      log_system_info "calling OverSIP::SystemEvents.on_terminated()..."
+      begin
+        ::OverSIP::SystemEvents.on_terminated error
+      rescue ::Exception => e
+        log_system_crit "error calling OverSIP::SystemEvents.on_terminated():"
+        log_system_crit e
+      end
+    end
+
     unless error
       log_system_info "exiting, thank you for tasting #{::OverSIP::PROGRAM_NAME}"
     end
 
-    # Kill Stud processes.
+    # Kill Stud processes and delete its temporal file with the full certificate.
     kill_stud_processes
+    ::File.delete ::OverSIP.configuration[:tls][:full_cert]  rescue nil
 
     # Wait a bit so pending log messages in the Posix MQ can be queued.
     sleep 0.1
-    delete_pid_file
     ::OverSIP::Logger.close
 
     # Fill the syslogger process.
     kill_syslogger_process
 
+    delete_pid_file
+
     # Exit by preventing any exception.
     exit!( error ? false : true )
   end
@@ -508,7 +533,7 @@ module OverSIP::Launcher
     uid = ::Etc.getpwnam(user).uid  if user
     gid = ::Etc.getgrnam(group).gid  if group
     if uid or gid
-      if gid && ::Process.egid != gid
+      if gid and ::Process.egid != gid
         ::Process.initgroups(user, gid)  if user
         ::Process::GID.change_privilege(gid)
       end
@@ -527,9 +552,10 @@ module OverSIP::Launcher
 
     bin_dir = ::File.join(::File.absolute_path(::File.dirname(__FILE__)), "../../bin/")
     stdout_file = "/tmp/stud.#{listen_ip}:#{listen_port}.out"
+    stderr_file = "/tmp/stud.#{listen_ip}:#{listen_port}.err"
 
     ::Dir.chdir(bin_dir) do
-      pid = ::POSIX::Spawn.spawn "./oversip_stud #{stud_user_group} #{ssl_option} -f '#{listen_ip},#{listen_port}' -b '#{bg_ip},#{bg_port}' -n 2 -s --daemon --write-proxy #{::OverSIP.configuration[:tls][:full_cert]}", :out => stdout_file, :err => "/dev/null"
+      pid = ::POSIX::Spawn.spawn "./oversip_stud #{stud_user_group} #{ssl_option} -f '#{listen_ip},#{listen_port}' -b '#{bg_ip},#{bg_port}' -n 2 -s --daemon --write-proxy #{::OverSIP.configuration[:tls][:full_cert]}", :out => stdout_file, :err => stderr_file
       ::Process.waitpid(pid)
     end
 
@@ -546,8 +572,12 @@ module OverSIP::Launcher
     ::File.delete stdout_file  rescue nil
 
     unless pid
-      fatal "error spawning stud server"
+      stderr = ::File.read stderr_file
+      ::File.delete stderr_file  rescue nil
+      log_system_crit "error spawning stud server for listening on #{listen_ip} : #{listen_port}:"
+      fatal stderr
     end
+    ::File.delete stderr_file  rescue nil
 
     ::OverSIP.stud_pids ||= []
     ::OverSIP.stud_pids << pid

data/lib/oversip/logger.rb

@@ -115,7 +115,7 @@ module OverSIP
         log_system_crit msg
         log_system_crit "exiting with error status"
 
-        ::OverSIP::Launcher.terminate error=true
+        ::OverSIP::Launcher.terminate error=true, fatal=true
       end
     end
 

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

@@ -62,7 +62,7 @@ module OverSIP::SIP
           client_transaction.connection_failed
         end
         @pending_client_transactions.clear
-      end
+      end unless $!
 
       @connected = false
     end

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

@@ -65,7 +65,7 @@ module OverSIP::SIP
         log_msg << ( @local_closed ? "locally closed" : "remotely closed" )
         log_msg << " (cause: #{cause.inspect})"  if cause
         log_system_debug log_msg
-      end
+      end unless $!
     end
 
   end

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

@@ -55,7 +55,7 @@ module OverSIP::SIP
         log_msg << ( @local_closed ? "locally closed" : "remotely closed" )
         log_msg << " (cause: #{cause.inspect})"  if cause
         log_system_debug log_msg
-      end
+      end unless $!
     end
 
   end

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

@@ -203,7 +203,9 @@ module OverSIP::SIP
 
 
     def unbind cause=nil
-      log_system_crit "UDP socket closed!!! cause: #{cause.inspect}"
+      unless $!
+        log_system_crit "UDP socket closed!!! cause: #{cause.inspect}"
+      end
     end
 
   end  # class UdpReactor

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

@@ -19,11 +19,11 @@ module OverSIP::SIP
 
           # Add the ;ov-ob param to the Contact URI.
           request.contact.set_param "ov-ob", request.connection_outbound_flow_token
+          # NOTE: request.contact_params is a String with the original Contact URI params
+          # so they are added at the end of the new URI with the added ;ov-ob param.
           # TODO: This should be done automatically, right?
           request.set_header "Contact", "#{request.contact.to_s}#{request.contact_params}"
-
           return true
-
         else
           return false
         end
@@ -31,9 +31,9 @@ module OverSIP::SIP
 
       def self.extract_outbound_from_ruri request
         # Do nothing if the request already contains a Route header with the Outbound flow token (so
-        # the registrar *does* support Path.
+        # the registrar *does* support Path).
         unless request.incoming_outbound_requested?
-          if ov_ob = request.ruri.del_param("ov-ob")
+          if (ov_ob = request.ruri.del_param("ov-ob"))
             log_system_debug "incoming Outbound flow token extracted from ;ov-ob param in RURI for #{request.log_id}"  if $oversip_debug
             request.route_outbound_flow_token = ov_ob
             request.incoming_outbound_requested = true
@@ -42,7 +42,7 @@ module OverSIP::SIP
             return false
           end
 
-          else
+        else
           # If the request already contains a proper Outbound Route header, then at least try to remove
           # the ;ov-ob param from the RURI.
           request.ruri.del_param("ov-ob")
@@ -57,13 +57,10 @@ module OverSIP::SIP
 
         if (contacts = message.headers["Contact"])
           log_system_debug "reverting original Contact value (removing ;ov-ob Outbound param) for response"  if $oversip_debug
-
           contacts.each do |contact|
             contact.gsub! /;ov-ob=[_\-0-9A-Za-z]+/, ""
           end
-
           return true
-
         else
           return false
         end

data/lib/oversip/sip/sip.rb

@@ -1,9 +1,5 @@
 module OverSIP::SIP
 
-  # This hash contains the proxies defined by the user. It will be filled after loading the
-  # configuration (proxies.conf file).
-  PROXIES = {}
-
   def self.module_init
     conf = ::OverSIP.configuration
 

data/lib/oversip/version.rb

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

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

@@ -64,10 +64,12 @@ module OverSIP::WebSocket
     def unbind cause=nil
       @local_closed = true  if cause == ::Errno::ETIMEDOUT
 
-      log_msg = "connection from #{remote_desc} "
-      log_msg << ( @local_closed ? "locally closed" : "remotely closed" )
-      log_msg << " (cause: #{cause.inspect})"  if cause
-      log_system_debug log_msg  if $oversip_debug
+      if $oversip_debug
+        log_msg = "connection from #{remote_desc} "
+        log_msg << ( @local_closed ? "locally closed" : "remotely closed" )
+        log_msg << " (cause: #{cause.inspect})"  if cause
+        log_system_debug log_msg
+      end unless $!
 
       @ws_framing.tcp_closed  if @ws_framing
 
@@ -78,7 +80,7 @@ module OverSIP::WebSocket
           log_system_error "error calling OverSIP::WebSocketEvents.on_connection_closed():"
           log_system_error e
         end
-      end
+      end unless $!
     end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversip
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta3
+  version: 1.1.0.beta4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine-le
-  requirement: &18084900 !ruby/object:Gem::Requirement
+  requirement: &18475300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *18084900
+  version_requirements: *18475300
 - !ruby/object:Gem::Dependency
   name: iobuffer
-  requirement: &18084440 !ruby/object:Gem::Requirement
+  requirement: &18474840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *18084440
+  version_requirements: *18474840
 - !ruby/object:Gem::Dependency
   name: em-posixmq
-  requirement: &18083980 !ruby/object:Gem::Requirement
+  requirement: &18474380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *18083980
+  version_requirements: *18474380
 - !ruby/object:Gem::Dependency
   name: em-udns
-  requirement: &18099900 !ruby/object:Gem::Requirement
+  requirement: &18473920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *18099900
+  version_requirements: *18473920
 - !ruby/object:Gem::Dependency
   name: escape_utils
-  requirement: &18099440 !ruby/object:Gem::Requirement
+  requirement: &18473460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *18099440
+  version_requirements: *18473460
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &18099060 !ruby/object:Gem::Requirement
+  requirement: &18473080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18099060
+  version_requirements: *18473080
 - !ruby/object:Gem::Dependency
   name: posix-spawn
-  requirement: &18098520 !ruby/object:Gem::Requirement
+  requirement: &18472540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *18098520
+  version_requirements: *18472540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18098020 !ruby/object:Gem::Requirement
+  requirement: &18472040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *18098020
+  version_requirements: *18472040
 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