palava_machine 1.0.0

data/lib/palava_machine/runner.rb

@@ -0,0 +1,66 @@
+require_relative 'version'
+require_relative 'manager'
+require_relative 'server'
+
+require 'local_port'
+
+
+module PalavaMachine::Runner
+
+  BANNER = <<BANNER
+
+  ###    #     #       #    #   #    #
+  #  #  # #    #      # #   #   #   # #
+  ###  #   #   #     #   #   # #   #   #
+  #    # # #   #     # # #   # #   # # #
+  #   #     #  ###  #     #   #   #     #
+
+BANNER
+
+  CliOptions = Struct.new(
+    :port,
+    :db,
+    :address,
+    :shutdown_timeout,
+    :redis_address,
+    :mongo_address
+  ) do
+    def initialize(*argv)
+      self.port             = (argv[0] || 4233).to_i
+      self.db               = (argv[1] ||    0).to_i
+      self.address          = argv[2]  || "0.0.0.0"
+      self.shutdown_timeout = (argv[3] || 3).to_i
+      self.redis_address    = argv[4]  || 'localhost:6379'
+      self.mongo_address    = argv[5]  || 'localhost:27017'
+    end
+  end
+
+  class << self
+    def run(cli_options = {})
+      puts BANNER
+
+      PalavaMachine::Server.new(
+        PalavaMachine::Manager.new(extract_manager_options(cli_options)),
+        extract_server_options(cli_options),
+      ).run
+    end
+
+    def parse_cli_options(argv = ARGV)
+      CliOptions.new(*argv)
+    end
+
+    def extract_server_options(cli_options)
+      {
+        host: cli_options.address,
+        port: LocalPort.next_free_one(cli_options.port),
+        shutdown_timeout: cli_options.shutdown_timeout,
+      }
+    end
+
+    def extract_manager_options(cli_options)
+      {
+        db: cli_options.db,
+      }
+    end
+  end
+end

data/lib/palava_machine/server.rb

@@ -0,0 +1,64 @@
+require_relative 'version'
+require_relative '../palava_machine'
+require_relative 'client_message'
+
+require_relative 'server/core_events'
+require_relative 'server/core_support'
+require_relative 'server/verify_handshake'
+require_relative 'server/server_info'
+
+require 'em-websocket'
+
+
+module PalavaMachine
+  class Server
+    DEFAULT_FEATURES = [
+      CoreSupport,
+      CoreEvents,
+      # VerifyHandshake,
+      ServerInfo,
+    ]
+
+    attr_reader :manager, :features, :options
+
+    def ws_open(ws, handshake)  end
+    def ws_message(ws, message) end
+    def ws_error(ws, error)     end
+    def ws_close(ws, close)     end
+    def em_init()               end
+    def em_error(e)             end
+    def em_sigterm()            end
+    def em_sigint()             end
+
+    def initialize(given_manager, given_options)
+      include_features(given_options.delete(:features))
+      @manager = given_manager
+      @options = given_options
+    end
+
+    def run
+      EM.run{
+        em_init
+        trap(:TERM){ em_sigterm }
+        trap(:INT){ em_sigint }
+
+        EM::WebSocket.run(options){ |ws|
+          ws.onopen{ |handshake|  ws_open(ws, handshake) }
+          ws.onmessage{ |message| ws_message(ws, message) }
+          ws.onclose{ |why|       ws_close(ws, why) }
+          ws.onerror{ |error|     ws_error(ws, error) }
+          EM.error_handler{ |e|   em_error(e) }
+        }
+      }
+    end
+
+
+    private
+
+
+    def include_features(given_features)
+      @features = given_features || DEFAULT_FEATURES
+      @features.each{ |f| self.singleton_class.send(:include, f) }
+    end
+  end
+end

data/lib/palava_machine/server/core_events.rb

@@ -0,0 +1,49 @@
+module PalavaMachine
+  class Server
+    module CoreEvents
+      def ws_open(ws, _)
+        ws_open_announce(ws)
+      rescue MessageError => e
+        send_error(ws, e)
+        ws.close 4242
+      end
+
+      def ws_message(ws, message)
+        ws_message_action(ws, ws_message_parse(ws, message))
+      rescue MessageParsingError, MessageError => e
+        send_error(ws, e)
+      end
+
+      def ws_close(ws, why)
+        ws_close_unannounce(ws)
+      rescue MessageError => e
+        warn "*** Error while closing connection *** #{e.class} ***\n" + e.message + "\n  " + e.backtrace*"\n  "
+      end
+
+      def ws_error(ws, e)
+        warn "*** Socket Error *** #{e.class} ***\n" + (e.message || "") + "\n  " + (e.backtrace && e.backtrace*"\n  ")
+        ws.close 4242
+      end
+
+      def em_init
+        em_init_pm
+      end
+
+      def em_error(e)
+        if e.is_a? MessageError
+          send_error(e.ws, e)
+        else
+          raise e
+        end
+      end
+
+      def em_sigterm
+        stop!
+      end
+
+      def em_sigint
+        stop! 0
+      end
+    end
+  end
+end

data/lib/palava_machine/server/core_support.rb

@@ -0,0 +1,50 @@
+module PalavaMachine
+  class Server
+    module CoreSupport
+      def ws_open_announce(ws)
+        manager.announce_connection(ws)
+      end
+
+      def ws_message_parse(ws, message)
+        connection_id = manager.connections.get_connection_id(ws) or raise MessageError.new(ws), 'unknown connection'
+        ClientMessage.new(message, connection_id)
+      end
+
+      def ws_message_action(ws, event)
+        manager.debug "#{event.connection_id} <#{event.name}>"
+        manager.public_send(event.name, event.connection_id, *event.arguments)
+      end
+
+      def ws_close_unannounce(ws)
+        manager.unannounce_connection(ws)
+      end
+
+      def em_init_pm
+        manager.info "Starting RTC Socket Server on port #{options[:port]}"
+        manager.initialize_in_em
+      end
+
+      def send_error(ws, e)
+        ws.send_text({
+          event: 'error',
+          message: e.message
+        }.to_json) # TODO deactivate message in production?
+      end
+
+      def stop!(timeout = options[:shutdown_timeout])
+        manager.warn "Stopping Machine"
+        if timeout.to_i == 0
+          manager.shutdown!
+          EM.stop
+        else
+          manager.announce_shutdown(timeout)
+          EM.next_tick do
+            manager.shutdown!(timeout)
+            EM.stop
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/palava_machine/server/server_info.rb

@@ -0,0 +1,20 @@
+module PalavaMachine
+  class Server
+    module ServerInfo
+      def ws_message_action(ws, event)
+        if event.name == :info
+          send_server_info(ws)
+        else
+          super(ws, event)
+        end
+      end
+
+      def send_server_info(ws)
+        ws.send_text({
+          event: 'info',
+          protocol_version: PalavaMachine::PROTOCOL_VERSION,
+        }.to_json)
+      end
+    end
+  end
+end

data/lib/palava_machine/server/verify_handshake.rb

@@ -0,0 +1,23 @@
+module PalavaMachine
+  class Server
+    class HandshakeError < StandardError; end
+
+    module VerifyHandshake
+      def ws_open(ws, handshake)
+        verify_handshake(handshake)
+        super(ws, handshake)
+      rescue HandshakeError => e
+        manager.error "HandshakeError for #{ws.hash}\n#{e.inspect}"
+        send_error(ws, e)
+        ws.close 4242
+      end
+
+      def verify_handshake(handshake)
+        # Other: Access properties on the EM::WebSocket::Handshake object, e.g. path, query_string, origin, headers
+        if handshake.headers['Sec-WebSocket-Protocol'] != PalavaMachine.protocol_identifier
+          raise HandshakeError, "incompatible sub-protocol: #{ handshake.headers['Sec-WebSocket-Protocol'] }"
+        end
+      end
+    end
+  end
+end

data/lib/palava_machine/socket_store.rb

@@ -0,0 +1,46 @@
+require_relative 'version'
+
+require 'securerandom'
+
+module PalavaMachine
+  class SocketStore
+    include Enumerable
+
+    def initialize(connections = {})
+      @connections = connections.dup
+    end
+
+    def register_connection(ws)
+      @connections[ws] = SecureRandom.uuid
+    end
+
+    def unregister_connection(ws)
+      @connections.delete(ws)
+    end
+
+    def get_connection_id(ws)
+      @connections[ws]
+    end
+
+    def get_connection(id)
+      @connections.key(id)
+    end
+    alias [] get_connection
+
+    def each(&block)
+      @connections.each(&block)
+    end
+
+    def sockets
+      @connections.keys
+    end
+
+    def ids
+      @connections.values
+    end
+
+    def dup
+      SocketStore.new(@connections) # TODO verify (shallow)
+    end
+  end
+end

data/lib/palava_machine/version.rb

@@ -0,0 +1,8 @@
+module PalavaMachine
+  VERSION          = "1.0.0"
+  PROTOCOL_VERSION = "1.0.0"
+
+  def self.protocol_identifier
+    'palava.%s' % PROTOCOL_VERSION.to_f
+  end
+end

data/palava_machine.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+name = 'palava_machine'
+
+require File.dirname(__FILE__) + "/lib/#{name}/version"
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 1.9.2'
+  s.name        = name
+  s.version     = PalavaMachine::VERSION
+  s.authors     = ["Jan Lelis", "Marius Melzer", "Stephan Thamm", "Kilian Ulbrich"]
+  s.email       = "contact@palava.tv"
+  s.homepage    = 'https://github.com/palavatv/palava-machine'
+  s.summary     = "The machine behind palava."
+  s.description = "A WebRTC Signaling Server implemented with WebSockets, EventMachine and Redis Pub-Sub"
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} features/**/*]) + %w{Rakefile palava_machine.gemspec Gemfile}
+  s.extra_rdoc_files = ["ReadMe.md", "ChangeLog.md", "ProtocolChangeLog.md"]
+  s.executables = ['palava-machine', 'palava-machine-daemon']
+
+  s.add_dependency 'em-websocket'
+
+  s.add_dependency 'hiredis', '~> 0.4.5'
+  s.add_dependency 'em-hiredis', '~> 0.2.1'
+
+  s.add_dependency 'redis', '>= 2.2.0'
+  s.add_dependency 'resque'
+  s.add_dependency 'resque-scheduler'
+  s.add_dependency 'mongo'
+  s.add_dependency 'bson_ext'
+
+  s.add_dependency 'bundler'
+  s.add_dependency 'daemons'
+  s.add_dependency 'logger-colors'
+  s.add_dependency 'local_port'
+  s.add_dependency 'rake'
+  s.add_dependency 'whiskey_disk'
+
+  s.add_development_dependency 'rspec'
+  # s.add_development_dependency 'debugger'
+end
+

metadata

@@ -0,0 +1,282 @@
+--- !ruby/object:Gem::Specification
+name: palava_machine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+- Marius Melzer
+- Stephan Thamm
+- Kilian Ulbrich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger-colors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: local_port
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: whiskey_disk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A WebRTC Signaling Server implemented with WebSockets, EventMachine and
+  Redis Pub-Sub
+email: contact@palava.tv
+executables:
+- palava-machine
+- palava-machine-daemon
+extensions: []
+extra_rdoc_files:
+- ReadMe.md
+- ChangeLog.md
+- ProtocolChangeLog.md
+files:
+- lib/palava_machine.rb
+- lib/palava_machine/manager.rb
+- lib/palava_machine/version.rb
+- lib/palava_machine/server/verify_handshake.rb
+- lib/palava_machine/server/server_info.rb
+- lib/palava_machine/server/core_events.rb
+- lib/palava_machine/server/core_support.rb
+- lib/palava_machine/runner.rb
+- lib/palava_machine/jobs.rb
+- lib/palava_machine/client_message.rb
+- lib/palava_machine/server.rb
+- lib/palava_machine/jobs/export_stats_job.rb
+- lib/palava_machine/socket_store.rb
+- bin/palava-machine-daemon
+- bin/palava-machine
+- Rakefile
+- palava_machine.gemspec
+- Gemfile
+- ReadMe.md
+- ChangeLog.md
+- ProtocolChangeLog.md
+homepage: https://github.com/palavatv/palava-machine
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.8
+signing_key: 
+specification_version: 4
+summary: The machine behind palava.
+test_files: []