oversip 1.0.2 → 1.0.3

data/README.md

@@ -1,4 +1,4 @@
-<a style="color: red" href="http://www.oversip.net"><img src="https://github.com/versatica/OverSIP/wiki/oversip-banner.png"/></a>
+<a href="http://www.oversip.net"><img src="http://www-test.oversip.net/images/dev/oversip-banner.png"/></a>
 
 **WEB UNDER CONSTRUCTION:** The code is stable and working. This web page and documentation is not... please wait a bit.
 

data/bin/oversip

@@ -1,16 +1,14 @@
-#!/usr/bin/ruby1.9
+#!/usr/bin/ruby
 # -*- encoding: binary -*-
 
 unless RUBY_VERSION >= "1.9.2"
   raise LoadError, "OverSIP requires Ruby version >= 1.9.2 (current version is #{RUBY_VERSION})"
 end
 
-
 # First of all, trap some signals in order to ignore them if they arrive while
 # loading server libraries.
 [:HUP, :INT, :USR1, :USR2].each {|signal| trap(signal) {} }
 
-
 require "optparse"
 require "etc"
 require "oversip"
@@ -28,10 +26,11 @@ module OverSIP
 
       # Options by default.
       options = {
-        :colorize  => true
+        :num_instances => 1,
+        :colorize => true
       }
 
-      OptionParser.new("", 24, "  ") do |opts|
+      OptionParser.new("", 28, "  ") do |opts|
         opts.banner = "#{::OverSIP::DESCRIPTION}" \
                       "\n\nUsage: #{File.basename(__FILE__)} " \
                       "[#{::OverSIP::PROGRAM_NAME} options] [Ruby options]"
@@ -42,12 +41,16 @@ module OverSIP
           options[:pid_file] = value
         end
 
-        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|
+        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
         end
 
-        opts.on("-c", "--dir_config DIR", "Absolute path to the directory with user configuration files (default '/etc/oversip/')") do |value|
-          options[:dir_config] = value
+        opts.on("--config-dir DIR", "Absolute path to the directory with user configuration files (default '/etc/oversip/')") do |value|
+          options[:config_dir] = value
+        end
+
+        opts.on("--config-file FILE", "Name of the configuration file within the configuration directory (default 'oversip.conf')") do |value|
+          options[:config_file] = value
         end
 
         opts.on("-u", "--user USER", "System user to run with") do |value|
@@ -58,6 +61,10 @@ module OverSIP
           options[:group] = value
         end
 
+        opts.on("-n", "--num-instances NUM", "Number of OverSIP instances that will run together in this host (this parameter is just for some resources allocation, it does not run NUM instances!) (default 1)") do |value|
+          options[:num_instances] = value.to_i
+        end
+
         opts.on("--no-color", "Don't colorize text printed in stdout") do |value|
           options[:colorize] = false
         end
@@ -156,6 +163,11 @@ module OverSIP
         end
       end
 
+      # Check the --num-instances parameter.
+      if options[:num_instances] < 1
+        fatal "num_instances #{n} is not a valid value (must be greater than 0)"
+      end
+
       # 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__)
@@ -163,12 +175,12 @@ module OverSIP
       OverSIP.master_name = $0
       log_system_info "master process name: #{OverSIP.master_name}"
 
-      OverSIP::Config.load options[:dir_config]
+      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"
-      OverSIP::Logger.init_logger_mq options[:group]
+      OverSIP::Logger.init_logger_mq options[:num_instances], options[:group]
       OverSIP::Logger.load_methods
 
       OverSIP::Launcher.daemonize!(options)

data/debian/preinst

@@ -6,7 +6,7 @@ set -e
 
 #DEBHELPER#
 
-OVERSIP_GEM_VERSION="~>1.0.1"
+OVERSIP_GEM_VERSION="~>1.0.3"
 
 case "$1" in
 

data/lib/oversip/config.rb

@@ -11,7 +11,7 @@ module OverSIP
     DEFAULT_CONFIG_DIR = "/etc/oversip/"
     DEFAULT_TLS_DIR = "tls/"
     DEFAULT_TLS_CA_DIR = "tls/ca/"
-    CONF_FILE = "oversip.conf"
+    DEFAULT_CONFIG_FILE = "oversip.conf"
     PROXIES_FILE = "proxies.conf"
     LOGIC_FILE = "logic.rb"
     WEBSOCKET_POLICY_FILE = "websocket_policy.rb"
@@ -20,21 +20,6 @@ module OverSIP
       @log_id ||= "Config"
     end
 
-    def self.conf_file
-      @conf_file ||= ::File.join(@conf_dir, CONF_FILE)
-    end
-
-    def self.proxies_file
-      @proxies_file ||= ::File.join(@conf_dir, PROXIES_FILE)
-    end
-
-    def self.logic_file
-      @logic_file ||= ::File.join(@conf_dir, LOGIC_FILE)
-    end
-
-    def self.websocket_policy_file
-      @websocket_policy_file ||= ::File.join(@conf_dir, WEBSOCKET_POLICY_FILE)
-    end
 
     @configuration = {
       :core => {
@@ -104,7 +89,6 @@ module OverSIP
         :listen_port              => :port,
         :listen_port_tls          => :port,
         :use_tls_tunnel           => :boolean,
-        # TODO, si use_tls_tunnel es yes entonces listen_port_tls_tunnel debe estar puesto.
         :listen_port_tls_tunnel   => :port,
         :local_domains            => [ :domain, :multi_value ],
         :tcp_keepalive_interval        => [ :fixnum, [ :greater_equal_than, 180 ] ],
@@ -134,31 +118,35 @@ module OverSIP
     }
 
 
-    def self.load conf_dir = nil
-      @conf_dir ||= (conf_dir || DEFAULT_CONFIG_DIR)
+    def self.load config_dir=nil, config_file=nil
+      @config_dir = (config_dir || DEFAULT_CONFIG_DIR)
+      @config_file = ::File.join(@config_dir, config_file || DEFAULT_CONFIG_FILE)
+      @proxies_file = ::File.join(@config_dir, PROXIES_FILE)
+      @logic_file ||= ::File.join(@config_dir, LOGIC_FILE)
+      @websocket_policy_file ||= ::File.join(@config_dir, WEBSOCKET_POLICY_FILE)
 
       begin
-        conf_yaml = ::YAML.load_file conf_file
+        conf_yaml = ::YAML.load_file @config_file
       rescue => e
-        fatal "error loading configuration file '#{conf_file}': #{e.message} (#{e.class})"
+        fatal "error loading configuration file '#{@config_file}': #{e.message} (#{e.class})"
       end
 
       begin
-        proxies_yaml = ::YAML.load_file proxies_file
+        proxies_yaml = ::YAML.load_file @proxies_file
       rescue => e
-        fatal "error loading proxies configuration file '#{proxies_file}': #{e.message} (#{e.class})"
+        fatal "error loading proxies configuration file '#{@proxies_file}': #{e.message} (#{e.class})"
       end
 
       begin
-        Kernel.load logic_file
+        Kernel.load @logic_file
       rescue LoadError => e
-        fatal "error loading logic file '#{logic_file}': #{e.message} (#{e.class})"
+        fatal "error loading logic file '#{@logic_file}': #{e.message} (#{e.class})"
       end
 
       begin
-        Kernel.load websocket_policy_file
+        Kernel.load @websocket_policy_file
       rescue LoadError => e
-        log_system_warn "cannot load WebSocket Policy file '#{websocket_policy_file}': #{e.message} (#{e.class}), using default policy (allow all)"
+        log_system_warn "cannot load WebSocket Policy file '#{@websocket_policy_file}': #{e.message} (#{e.class}), using default policy (allow all)"
       end
 
       begin
@@ -221,7 +209,6 @@ module OverSIP
       end
 
       ::OverSIP.configuration = @configuration
-
       ::OverSIP::ProxiesConfig.load proxies_yaml
     end
 
@@ -234,15 +221,15 @@ module OverSIP
       tls_ca_dir = conf_yaml["tls"]["ca_dir"] rescue nil
 
       if tls_public_cert.is_a?(String) and tls_public_cert[0] != "/"
-        conf_yaml["tls"]["public_cert"] = ::File.join(@conf_dir, DEFAULT_TLS_DIR, tls_public_cert)
+        conf_yaml["tls"]["public_cert"] = ::File.join(@config_dir, DEFAULT_TLS_DIR, tls_public_cert)
       end
 
       if tls_private_cert.is_a?(String) and tls_private_cert[0] != "/"
-        conf_yaml["tls"]["private_cert"] = ::File.join(@conf_dir, DEFAULT_TLS_DIR, tls_private_cert)
+        conf_yaml["tls"]["private_cert"] = ::File.join(@config_dir, DEFAULT_TLS_DIR, tls_private_cert)
       end
 
       if tls_ca_dir.is_a?(String) and tls_ca_dir[0] != "/"
-        conf_yaml["tls"]["ca_dir"] = ::File.join(@conf_dir, DEFAULT_TLS_DIR, tls_ca_dir)
+        conf_yaml["tls"]["ca_dir"] = ::File.join(@config_dir, DEFAULT_TLS_DIR, tls_ca_dir)
       end
     end
 
@@ -526,7 +513,7 @@ module OverSIP
 
     def self.reload_logic
       begin
-        Kernel.load logic_file
+        Kernel.load @logic_file
         log_system_info "logic reloaded"
         true
       rescue Exception => e

data/lib/oversip/launcher.rb

@@ -106,7 +106,7 @@ module OverSIP::Launcher
         ::OverSIP::WebSocket::WsFraming.class_init
         ::OverSIP::WebSocket::WsApp.class_init
 
-      # I'm the sysloger process.
+      # I'm the syslogger process.
       else
         # Close the pipe in the syslogger process.
         ready_pipe.close rescue nil
@@ -437,18 +437,16 @@ module OverSIP::Launcher
       log_system_info "exiting, thank you for tasting #{::OverSIP::PROGRAM_NAME}"
     end
 
+    # Kill Stud processes.
+    kill_stud_processes
+
     # Wait a bit so pending log messages in the Posix MQ can be queued.
     sleep 0.05
     delete_pid_file
     ::OverSIP::Logger.close
-    kill_syslogger_process
 
-    # Kill Stud processes.
-    pid = Process.spawn "killall oversip_stud 2>/dev/null"
-    Process.wait(pid)
-    sleep 0.5
-    pid = Process.spawn "killall -9 oversip_stud 2>/dev/null"
-    Process.wait(pid)
+    # Fill the syslogger process.
+    kill_syslogger_process
 
     # Exit by preventing any exception.
     exit!( error ? false : true )
@@ -501,10 +499,53 @@ module OverSIP::Launcher
     ssl_option = ( ssl ? "--ssl" : "" )
 
     bin_dir = ::File.join(::File.absolute_path(::File.dirname(__FILE__)), "../../bin/")
-    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]}"
+    stdout_file = "/tmp/stud.#{listen_ip}:#{listen_port}.out"
+
+    ::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"
       Process.waitpid(pid)
     end
+
+    # Get the PID of the daemonized stud process.
+    stdout = ::File.read stdout_file
+    pid = nil
+    stdout.each_line do |line|
+      pid = line.split(" ")[4]
+      if pid
+        pid = pid.gsub(/\./,"").to_i
+        break  if pid > 0
+      end
+    end
+    ::File.delete stdout_file  rescue nil
+
+    unless pid
+      fatal "error spawning stud server"
+    end
+
+    ::OverSIP.stud_pids ||= []
+    ::OverSIP.stud_pids << pid
+
+    log_system_info "spawned stud server (PID #{pid}) listening into #{listen_ip} : #{listen_port}"
+  end
+
+
+  def self.kill_stud_processes
+    return false  unless ::OverSIP.master_pid
+
+    ::OverSIP.stud_pids.each do |pid|
+      begin
+        log_system_info "killing stud server with PID #{pid}..."
+        ::Process.kill(:TERM, pid)
+        10.times do |i|
+          sleep 0.05
+          ::Process.wait(pid, ::Process::WNOHANG) rescue nil
+          ::Process.kill(0, pid) rescue break
+        end
+        ::Process.kill(0, pid)
+        ::Process.kill(:KILL, pid) rescue nil
+      rescue ::Errno::ESRCH
+      end
+    end
   end
 
 end

data/lib/oversip/logger.rb

@@ -16,7 +16,7 @@ module OverSIP
       "emerg"  => 7
     }
 
-    def self.init_logger_mq(group = nil)
+    def self.init_logger_mq num_instances, group=nil
       OverSIP.syslogger_mq_name = "/#{OverSIP.master_name}_syslogger"
 
       @@logger_mq = ::OverSIP::PosixMQ.create_queue({
@@ -24,6 +24,7 @@ module OverSIP
         :mode    => :write,
         :maxmsg  => 1000,
         :msgsize => 2000,
+        :num_instances => num_instances,
         :group => group
       })
     end

data/lib/oversip/posix_mq.rb

@@ -6,7 +6,6 @@ module OverSIP
 
     def self.create_queue options={}
       @log_id = "PosixMQ #{options[:name]}"
-      @total_size ||= 0
 
       # Queue attributes.
       mq_name = options[:name]
@@ -42,7 +41,6 @@ module OverSIP
         Process::GID.change_privilege(gid)
       end
 
-      ### TODO: Este tamaño debe multiplicarse por el num de queues!
       # System limits required size (ulimit -q).
       mq_size = case 1.size
         # 32 bits OS.
@@ -50,17 +48,20 @@ module OverSIP
         # 64 bits OS.
         when 8 then mq_attr.maxmsg * 8 + mq_attr.maxmsg * mq_attr.msgsize
         end
+
+      # If --num-instances is given, then multiply it by its value.
+      mq_size *= options[:num_instances]
+
       log_system_debug "queue requires #{mq_size} bytes"  if $oversip_debug
 
       # Set RLIMIT_MSGQUEUE (ulimit) in order to create the queue with required
       # ammount of memory.
-      @total_size += mq_size
-      if ( current_rlimit = ::Process.getrlimit(12)[1] ) < @total_size
-        log_system_debug "incrementing rlimits (currently #{current_rlimit} bytes) to #{@total_size} bytes (ulimit -q)"  if $oversip_debug
+      if ( current_rlimit = ::Process.getrlimit(12)[1] ) < mq_size
+        log_system_debug "incrementing rlimits (currently #{current_rlimit} bytes) to #{mq_size} bytes (ulimit -q)"  if $oversip_debug
         begin
-          ::Process.setrlimit(12, @total_size)
+          ::Process.setrlimit(12, mq_size)
         rescue Errno::EPERM
-          fatal "current user has no permissions to increase rlimits to #{@total_size} bytes (ulimit -q)"
+          fatal "current user has no permissions to increase rlimits to #{mq_size} bytes (ulimit -q)"
         end
       end
 

data/lib/oversip/version.rb

@@ -5,7 +5,7 @@ module OverSIP
   module Version
     MAJOR = 1
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
   end
 
   PROGRAM_NAME     = "OverSIP"

data/lib/oversip.rb

@@ -37,7 +37,8 @@ module OverSIP
                   :syslogger_pid, :syslogger_mq_name,
                   :configuration,
                   :proxies,
-                  :tls, :tls_public_cert, :tls_private_cert, :tls_proxy_ipv4, :tls_proxy_ipv6
+                  :tls, :tls_public_cert, :tls_private_cert, :tls_proxy_ipv4, :tls_proxy_ipv6,
+                  :stud_pids
 
     def master?
       @master_pid == $$

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversip
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine-le
-  requirement: &8648800 !ruby/object:Gem::Requirement
+  requirement: &13970320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *8648800
+  version_requirements: *13970320
 - !ruby/object:Gem::Dependency
   name: iobuffer
-  requirement: &8648320 !ruby/object:Gem::Requirement
+  requirement: &13969800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *8648320
+  version_requirements: *13969800
 - !ruby/object:Gem::Dependency
   name: em-posixmq
-  requirement: &8647860 !ruby/object:Gem::Requirement
+  requirement: &13969120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *8647860
+  version_requirements: *13969120
 - !ruby/object:Gem::Dependency
   name: em-udns
-  requirement: &8647340 !ruby/object:Gem::Requirement
+  requirement: &13968220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *8647340
+  version_requirements: *13968220
 - !ruby/object:Gem::Dependency
   name: escape_utils
-  requirement: &8646840 !ruby/object:Gem::Requirement
+  requirement: &13967120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *8646840
+  version_requirements: *13967120
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &8646380 !ruby/object:Gem::Requirement
+  requirement: &13966420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,18 +76,29 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8646380
+  version_requirements: *13966420
 - !ruby/object:Gem::Dependency
   name: posix-spawn
-  requirement: &8645760 !ruby/object:Gem::Requirement
+  requirement: &13965860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *8645760
+  version_requirements: *13965860
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &13965060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *13965060
 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