oversip 1.0.6.beta1 → 1.0.6.beta2

data/README.md

@@ -12,4 +12,4 @@ Some features of OverSIP are:
 * Fully programmable in Ruby language (make SIP easy).
 * Fast and efficient: OverSIP core is coded in C language.
 
-OverSIP is build on top of EventMachine async library which follows the Reactor Pattern design, allowing thousands of concurrent connections and requests in a never-blocking fashion.
+OverSIP is build on top of EventMachine async library which follows the Reactor Design Pattern, allowing thousands of concurrent connections and requests in a never-blocking fashion.

data/bin/oversip

@@ -32,7 +32,6 @@ module OverSIP
 
       # Options by default.
       options = {
-        :num_instances => 1,
         :colorize => true
       }
 
@@ -67,10 +66,6 @@ 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
@@ -169,11 +164,6 @@ 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__)
@@ -186,7 +176,8 @@ module OverSIP
       ::OverSIP::Config.print options[:colorize]
 
       log_system_info "creating Posix Message Queue for communicating master and syslogger processes"
-      ::OverSIP::Logger.init_logger_mq options[:num_instances], options[:group]
+      ::OverSIP.syslogger_mq_name = "/#{OverSIP.master_name}_syslogger"
+      ::OverSIP::Logger.init_logger_mq options[:group]
       ::OverSIP::Logger.load_methods
 
       ::OverSIP::Launcher.daemonize!(options)

data/etc/events.rb

@@ -0,0 +1,34 @@
+#
+# OverSIP - Events.
+#
+#
+# OverSIP common callbacks. Fill them according to your needs.
+
+
+module OverSIP::Events
+
+  extend ::OverSIP::Logger
+  @log_id = "Events"
+
+  # This method is called once a WebSocket connection has been accepted
+  # but before the HTTP 101 has been replied to the client.
+  # Here you can inspect the HTTP request (WebSocket handshake) and,
+  # based on your service, reject the connection by calling:
+  #
+  #   connection.http_reject(status_code, reason_phrase=nil, extra_headers=nil)
+  #
+  # You can also set variables for this connection via the connection.cvars
+  # hash. You can later inspect such a hash within the logic.rb file by
+  # accessing to @request.cvars.
+  # 
+  def self.on_new_websocket_connection connection, http_request
+    # Do something.
+  end
+
+  # This method is called once a WebSocket connection has been closed.
+  #
+  def self.on_websocket_connection_closed connection
+    # Do something.
+  end
+
+end

data/etc/proxies.conf

@@ -134,4 +134,4 @@ proxy_out:
   timer_F: 6
 
 
-# Add your own proxy configurations here.
+# Add your own proxy configurations here and/or replace the above ones.

data/lib/oversip/config.rb

@@ -16,6 +16,7 @@ module OverSIP
     LOGIC_FILE = "logic.rb"
     WEBSOCKET_POLICY_FILE = "websocket_policy.rb"
     SYSTEM_EVENTS_FILE = "system_events.rb"
+    EVENTS_FILE = "events.rb"
     CUSTOM_LIB_FILE = "custom_lib.rb"
 
     def self.log_id
@@ -127,20 +128,20 @@ module OverSIP
       @logic_file = ::File.join(@config_dir, LOGIC_FILE)
       @websocket_policy_file = ::File.join(@config_dir, WEBSOCKET_POLICY_FILE)
       @system_events_file = ::File.join(@config_dir, SYSTEM_EVENTS_FILE)
+      @events_file = ::File.join(@config_dir, EVENTS_FILE)
       @custom_lib_file = ::File.join(@config_dir, CUSTOM_LIB_FILE)
 
       begin
         conf_yaml = ::YAML.load_file @config_file
-      rescue => e
-        fatal "error loading Main Configuration file '#{@config_file}': #{e.message} (#{e.class})"
+      rescue ::Exception => e
+        log_system_crit "error loading Main Configuration file '#{@config_file}':"
+        fatal e
       end
 
       begin
        ::Kernel.load @custom_lib_file
-      rescue ::LoadError => e
-        log_system_warn "cannot load Custom Lib file '#{@custom_lib_file}': #{e.message} (#{e.class})"
       rescue ::Exception => e
-        log_system_crit "error loading Custom Lib file '#{@custom_lib_file}':"
+        log_system_crit "error loading Custom Library file '#{@custom_lib_file}':"
         fatal e
       end
 
@@ -151,22 +152,32 @@ module OverSIP
         fatal e
       end
 
+      begin
+       ::Kernel.load @events_file
+      rescue ::Exception => e
+        log_system_crit "error loading Events file '#{@events_file}':"
+        fatal e
+      end
+
       begin
         proxies_yaml = ::YAML.load_file @proxies_file
-      rescue => e
-        fatal "error loading Proxies Configuration file '#{@proxies_file}': #{e.message} (#{e.class})"
+      rescue ::Exception => e
+        log_system_crit "error loading Proxies Configuration file '#{@proxies_file}':"
+        fatal e
       end
 
       begin
         ::Kernel.load @logic_file
-      rescue ::LoadError => e
-        fatal "error loading Logic file '#{@logic_file}': #{e.message} (#{e.class})"
+      rescue ::Exception => e
+        log_system_crit "error loading Logic file '#{@logic_file}':"
+        fatal e
       end
 
       begin
        ::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)"
+      rescue ::Exception => e
+        log_system_crit "error loading WebSocket Policy file '#{@websocket_policy_file}':"
+        fatal e
       end
 
       begin
@@ -553,7 +564,7 @@ module OverSIP
       end
     end
 
-    def self.reload_logic
+    def self.reload
       begin
         ::Kernel.load @logic_file
         log_system_info "logic reloaded"

data/lib/oversip/launcher.rb

@@ -432,8 +432,8 @@ module OverSIP::Launcher
     # Signal HUP reloads logic.
     # TODO: Reload proxies (so purge DNS cache in all of them), reload websocket policy.
     trap :HUP do
-      log_system_info "HUP signal received, reloading logic..."
-      ::OverSIP::Config.reload_logic
+      log_system_info "HUP signal received, reloading"
+      ::OverSIP::Config.reload
     end
 
     # Signal CHLD is sent by syslogger process if it dies.
@@ -515,7 +515,7 @@ module OverSIP::Launcher
 
     ::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)
+      ::Process.waitpid(pid)
     end
 
     # Get the PID of the daemonized stud process.

data/lib/oversip/logger.rb

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

data/lib/oversip/posix_mq.rb

@@ -10,9 +10,9 @@ module OverSIP
       # Queue attributes.
       mq_name = options[:name]
       mq_mode = case options[:mode]
-        when :read       then IO::RDONLY
-        when :write      then IO::WRONLY
-        when :read_write then IO::RDWR
+        when :read       then ::IO::RDONLY
+        when :write      then ::IO::WRONLY
+        when :read_write then ::IO::RDWR
         end
       mq_group = options[:group]
       mq_attr = ::POSIX_MQ::Attr.new
@@ -52,9 +52,6 @@ module OverSIP
         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_info "queue requires #{mq_size} bytes"
 
       # Set RLIMIT_MSGQUEUE (ulimit) in order to create the queue with required
@@ -86,7 +83,7 @@ module OverSIP
 
       # http://linux.die.net/man/3/mq_open
       #
-      # O_CREAT was specified in oflag, and attr was not NULL, but attr->mq_maxmsg or attr->mq_msqsize was
+      # IO_CREAT was specified in oflag, and attr was not NULL, but attr->mq_maxmsg or attr->mq_msqsize was
       # invalid. Both of these fields must be greater than zero. In a process that is unprivileged (does not
       # have the CAP_SYS_RESOURCE capability), attr->mq_maxmsg must be less than or equal to the msg_max
       # limit, and attr->mq_msgsize must be less than or equal to the msgsize_max limit. In addition, even

data/lib/oversip/sip/client_transaction.rb

@@ -187,6 +187,9 @@ module OverSIP::SIP
       # Set server transaction variables to the response.
       response.tvars = @request.tvars
 
+      # Set original request's connection variables to the response.
+      response.cvars = @request.cvars
+
       # Provisional response
       if response.status_code < 200
         case @state
@@ -503,6 +506,9 @@ module OverSIP::SIP
       # Set server transaction variables to the response.
       response.tvars = @request.tvars
 
+      # Set original request's connection variables to the response.
+      response.cvars = @request.cvars
+
       # Provisional response
       if response.status_code < 200
         case @state

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

@@ -2,7 +2,6 @@ module OverSIP::SIP
 
   class TcpClient < TcpReactor
 
-    attr_accessor :server_class  ## TODO: sirve??
     attr_reader :connected
     attr_reader :pending_client_transactions
 

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

@@ -29,6 +29,9 @@ module OverSIP::SIP
         set_sock_opt Socket::SOL_TCP, Socket::TCP_KEEPIDLE, ::OverSIP::SIP.tcp_keepalive_interval  # First TCP ping.
         set_sock_opt Socket::SOL_TCP, Socket::TCP_KEEPINTVL, ::OverSIP::SIP.tcp_keepalive_interval  # Interval between TCP pings.
       end
+
+      # Initialize @cvars.
+      @cvars = {}
     end
 
     def remote_desc force=nil

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

@@ -19,6 +19,9 @@ module OverSIP::SIP
 
       # Create an Outbound (RFC 5626) flow token for this connection.
       @outbound_flow_token = ::OverSIP::SIP::TransportManager.add_outbound_connection self
+
+      # Initialize @cvars.
+      @cvars = {}
     end
 
     def remote_desc force=nil

data/lib/oversip/sip/message.rb

@@ -59,7 +59,7 @@ module OverSIP::SIP
 
     # Other attributes.
     attr_accessor :tvars  # Transaction variables (a hash).
-
+    attr_accessor :cvars  # Connection variables (a hash).
 
     def udp?               ; @transport == :udp          end
     def tcp?               ; @transport == :tcp          end

data/lib/oversip/sip/message_processor.rb

@@ -86,12 +86,12 @@ module OverSIP::SIP
             return
           end
 
-          # Initialize some attributes for the request (for received responses
-          # it's set in Proxy#receive_response).
+          # Initialize some attributes for the request.
           @msg.tvars = {}
+          @msg.cvars = @cvars
 
           # Create the Logic instance and run it!
-          OverSIP::SIP::Logic.new(@msg).run
+          ::OverSIP::SIP::Logic.new(@msg).run
         rescue => e
           log_system_error e
           @msg.reply 503, "Internal Error", ["Content-Type: text/plain"], "#{e.class }: #{e.message}"

data/lib/oversip/version.rb

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

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

@@ -3,8 +3,7 @@ module OverSIP::WebSocket
   class TcpServer < ::EM::Connection
 
     include ::OverSIP::Logger
-    include ::OverSIP::WebSocket::DefaultPolicy
-    include ::OverSIP::WebSocket::Policy  rescue nil  # As it could not exist (i.e. the user deleted the file).
+    include ::OverSIP::WebSocket::Policy
 
     # Max size (bytes) of the buffered data when receiving message headers
     # (avoid DoS attacks).
@@ -21,12 +20,14 @@ 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.
 
 
     def initialize
       @http_parser = ::OverSIP::WebSocket::HttpRequestParser.new
       @buffer = ::IO::Buffer.new
       @state = :init
+      @cvars = {}
     end
 
 
@@ -69,6 +70,15 @@ module OverSIP::WebSocket
       log_system_debug log_msg  if $oversip_debug
 
       @ws_framing.tcp_closed  if @ws_framing
+
+      if @state == :websocket_frames
+        begin
+          ::OverSIP::Events.on_websocket_connection_closed self
+        rescue ::Exception => e
+          log_system_error "error calling user provided OverSIP::Events.on_websocket_connection_closed():"
+          log_system_error e
+        end
+      end
     end
 
 
@@ -90,6 +100,9 @@ module OverSIP::WebSocket
         when :check_http_request
           check_http_request
 
+        when :new_websocket_connection_callback
+          check_new_websocket_connection_callback
+
         when :accept_ws_handshake
           accept_ws_handshake
 
@@ -214,11 +227,32 @@ module OverSIP::WebSocket
         return false
       end
 
-      @state = :accept_ws_handshake
+      @state = :new_websocket_connection_callback
       true
     end
 
 
+    def check_new_websocket_connection_callback
+      begin
+        ::OverSIP::Events.on_new_websocket_connection self, @http_request
+      rescue ::Exception => e
+        log_system_error "error calling user provided OverSIP::Events.on_new_websocket_connection() callback => 500:"
+        log_system_error e
+        http_reject 500
+        return false
+      end
+
+      # 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
+        true
+      else
+        false
+      end
+    end
+
+
     def accept_ws_handshake
       sec_websocket_accept = Digest::SHA1::base64digest @http_request.hdr_sec_websocket_key + WS_MAGIC_GUID_04
 

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

@@ -61,8 +61,8 @@ module OverSIP::WebSocket
 
 
     def unbind cause=nil
-      super
       @timer_tls_handshake.cancel  if @timer_tls_handshake
+      super
     end
 
   end

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

@@ -51,6 +51,9 @@ module OverSIP::WebSocket
         when :check_http_request
           check_http_request
 
+        when :new_websocket_connection_callback
+          check_new_websocket_connection_callback
+
         when :accept_ws_handshake
           accept_ws_handshake
 

data/lib/oversip/websocket/ws_app.rb

@@ -15,6 +15,7 @@ module OverSIP::WebSocket
       @connection = connection
       @ws_framing = ws_framing
       @ws_message = ::IO::Buffer.new
+      @cvars = connection.cvars
 
       # Mantain WebSocket keepalive.
       @ws_framing.do_keep_alive @@ws_keepalive_interval  if @@ws_keepalive_interval

data/lib/oversip/websocket/ws_apps/ws_sip_app.rb

@@ -22,7 +22,7 @@ module OverSIP::WebSocket
     attr_reader :outbound_flow_token
 
 
-    def initialize *args
+    def initialize connection, ws_framing
       super
       # WebSocket is message boundary so we just need a SIP parser instance.
       @@parser ||= ::OverSIP::SIP::MessageParser.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversip
 version: !ruby/object:Gem::Version
-  version: 1.0.6.beta1
+  version: 1.0.6.beta2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-01 00:00:00.000000000 Z
+date: 2012-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine-le
-  requirement: &19017300 !ruby/object:Gem::Requirement
+  requirement: &21320040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *19017300
+  version_requirements: *21320040
 - !ruby/object:Gem::Dependency
   name: iobuffer
-  requirement: &19016840 !ruby/object:Gem::Requirement
+  requirement: &21319580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *19016840
+  version_requirements: *21319580
 - !ruby/object:Gem::Dependency
   name: em-posixmq
-  requirement: &19016380 !ruby/object:Gem::Requirement
+  requirement: &21335480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *19016380
+  version_requirements: *21335480
 - !ruby/object:Gem::Dependency
   name: em-udns
-  requirement: &19032300 !ruby/object:Gem::Requirement
+  requirement: &21335020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *19032300
+  version_requirements: *21335020
 - !ruby/object:Gem::Dependency
   name: escape_utils
-  requirement: &19031840 !ruby/object:Gem::Requirement
+  requirement: &21334560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *19031840
+  version_requirements: *21334560
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &19031460 !ruby/object:Gem::Requirement
+  requirement: &21334180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19031460
+  version_requirements: *21334180
 - !ruby/object:Gem::Dependency
   name: posix-spawn
-  requirement: &19030920 !ruby/object:Gem::Requirement
+  requirement: &21333640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *19030920
+  version_requirements: *21333640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19030420 !ruby/object:Gem::Requirement
+  requirement: &21333140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *19030420
+  version_requirements: *21333140
 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
@@ -178,7 +178,6 @@ files:
 - lib/oversip/websocket/http_request.rb
 - lib/oversip/websocket/ws_framing.rb
 - lib/oversip/websocket/constants.rb
-- lib/oversip/websocket/default_policy.rb
 - lib/oversip/websocket/launcher.rb
 - lib/oversip/websocket/ws_apps.rb
 - lib/oversip/websocket/listeners/tls_server.rb
@@ -230,6 +229,7 @@ files:
 - thirdparty/stud/stud.tar.gz
 - etc/oversip.conf
 - etc/system_events.rb
+- etc/events.rb
 - etc/custom_lib.rb
 - etc/logic.rb
 - etc/proxies.conf

data/lib/oversip/websocket/default_policy.rb

@@ -1,19 +0,0 @@
-module OverSIP::WebSocket
-
-  module DefaultPolicy
-
-    def check_hostport host=nil, port=nil
-      true
-    end
-
-    def check_origin origin=nil
-      true
-    end
-
-    def check_request_uri path=nil, query=nil
-      true
-    end
-
-  end
-
-end