switchboard 0.1.0

data/lib/switchboard/commands/register.rb

@@ -0,0 +1,40 @@
+module Switchboard
+  module Commands
+    class Register < Switchboard::Command
+      description "Register a JID"
+
+      class Registration < Switchboard::Client
+        def initialize(settings = Switchboard::Settings.new, spin = false)
+          super(settings, false)
+        end
+
+      protected
+
+        def auth!
+          unless settings["jid"] && settings["password"]
+            puts "A JID and password are required to register a new account."
+            shutdown(false)
+            exit
+          end
+
+          # TODO consider using client.register_info.inspect
+          begin
+            puts "Registering #{settings["jid"]}"
+            iq = client.register(settings["password"])
+          rescue Jabber::ServerError => e
+            puts "Could not register: #{e}"
+            shutdown(false)
+            exit 1
+          end
+
+          # now log in
+          super
+        end
+      end
+
+      def self.run!
+        Registration.new.run!
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster.rb

@@ -0,0 +1,5 @@
+require 'switchboard/commands/roster/roster'
+require 'switchboard/commands/roster/add'
+require 'switchboard/commands/roster/list'
+require 'switchboard/commands/roster/online'
+require 'switchboard/commands/roster/remove'

data/lib/switchboard/commands/roster/add.rb

@@ -0,0 +1,27 @@
+module Switchboard
+  module Commands
+    class Roster
+      class Add < Switchboard::Command
+        description "Add a JID to your roster"
+
+        def self.run!
+          switchboard = Switchboard::Client.new(Switchboard::Settings.new, false)
+
+          switchboard.on_roster_loaded do
+            # add the server as a contact if it wasn't already added
+            ARGV.each do |jid|
+              if roster.find(jid).empty?
+                puts "Adding #{jid} to my roster..."
+                roster.add(jid, nil, true)
+              end
+            end
+          end
+
+          switchboard.plug!(AutoAcceptJack)
+
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster/list.rb

@@ -0,0 +1,26 @@
+module Switchboard
+  module Commands
+    class Roster
+      class List < Switchboard::Command
+        description "List all roster items"
+
+        def self.run!
+          # TODO override settings with values from the command line
+          switchboard = Switchboard::Client.new(Switchboard::Settings.new, false)
+
+          switchboard.on_roster_loaded do
+            if roster.items.any?
+              puts "#{settings["jid"]}'s roster:"
+              puts roster.items.keys.map { |jid| jid.to_s } * "\n"
+            else
+              puts "#{settings["jid"]}'s roster is empty."
+            end
+          end
+
+          switchboard.plug!(AutoAcceptJack)
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster/online.rb

@@ -0,0 +1,28 @@
+module Switchboard
+  module Commands
+    class Roster
+      class Online < Switchboard::Command
+        description "List online members of your roster"
+
+        def self.run!
+          switchboard = Switchboard::Client.new do
+            puts "Collecting presences..."
+            sleep 5
+            roster.items.each do |jid, item|
+              next unless item.online?
+              puts "#{item.jid}:"
+              item.each_presence do |presence|
+                status = [presence.show, presence.status].compact * " - "
+                status = "available" if status == ""
+                puts "  /#{presence.from.resource} (#{status}) [#{presence.priority}]"
+              end
+            end
+          end
+
+          switchboard.plug!(AutoAcceptJack)
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster/remove.rb

@@ -0,0 +1,25 @@
+module Switchboard
+  module Commands
+    class Roster
+      class Remove < Switchboard::Command
+        description "Remove a JID from your roster"
+
+        def self.run!
+          switchboard = Switchboard::Client.new(Switchboard::Settings.new, false)
+
+          switchboard.on_roster_loaded do
+            ARGV.each do |jid|
+              if (items = roster.find(jid)).any?
+                item = items.values.first
+                puts "Removing #{item.jid.to_s} from my roster..."
+                item.remove
+              end
+            end
+          end
+
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster/roster.rb

@@ -0,0 +1,7 @@
+module Switchboard
+  module Commands
+    class Roster < Switchboard::Command
+      description "Roster manipulation"
+    end
+  end
+end

data/lib/switchboard/commands/unregister.rb

@@ -0,0 +1,21 @@
+module Switchboard
+  module Commands
+    class Unregister < Switchboard::Command
+      description "Unregister a JID"
+
+      def self.run!
+        switchboard = Switchboard::Client.new do
+          begin
+            client.remove_registration
+          rescue Jabber::ServerError => e
+            puts "Could not unregister #{settings["jid"]}: #{e}"
+            shutdown(false)
+            exit 1
+          end
+        end
+
+        switchboard.run!
+      end
+    end
+  end
+end

data/lib/switchboard/component.rb

@@ -0,0 +1,36 @@
+module Switchboard
+  class Component < Core
+    attr_reader :component
+
+    def initialize(settings = Switchboard::Settings.new, spin = true)
+      super(settings, spin)
+
+      @component = Jabber::Component.new(settings["component.domain"])
+    end
+
+  protected
+
+    def auth!
+      component.auth(settings["component.secret"])
+    rescue Jabber::AuthenticationFailure
+      puts "Component authentication failed. Check your secret."
+      shutdown(false)
+      exit 1
+    end
+
+    def connect!
+      component.connect(settings["component.host"], settings["component.port"])
+      auth!
+      puts "Component connected." if debug?
+    rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT
+      puts "Couldn't connect to Jabber server at #{settings["component.host"]}:#{settings["component.port"]}.
+            That may mean the Jabber server isn't running or listening on that port,
+            or there might be firewall issues. Exiting."
+      exit 1
+    end
+
+    def stream
+      component
+    end
+  end
+end

data/lib/switchboard/core.rb

@@ -0,0 +1,311 @@
+begin
+  require 'xmpp4r'
+rescue LoadError => e
+  lib = e.message.split("--").last.strip
+  puts "#{lib} is required."
+  exit 1
+end
+
+# allow local library modifications/additions to be loaded
+$: << File.join(File.dirname(__FILE__))
+
+require 'switchboard/ext/delegate'
+require 'switchboard/ext/instance_exec'
+require 'xmpp4r/roster'
+
+module Switchboard
+  OPTIONS = {}
+  DEFAULT_OPTIONS = {
+    # :detach  => false,
+    "debug"    => false,
+    "oauth"    => false,
+    "resource" => "switchboard"
+  }
+
+  class Core
+    include Timeout
+
+    attr_reader :jacks, :settings
+
+    # Register a hook
+    def self.hook(*events)
+      events.each do |event|
+        module_eval(<<-EOS, __FILE__, __LINE__)
+          def on_#{event}(method = nil, &block)
+            if block_given?
+              register_hook(:#{event}, &block)
+            elsif method
+              register_hook(:#{event}, method)
+            end
+          end
+        EOS
+      end
+    end
+
+    def initialize(settings = Switchboard::Settings.new, spin = true, &block)
+      # register a handler for SIGINTs
+      trap(:INT) do
+        # exit on a second ^C
+        trap(:INT) do
+          exit
+        end
+
+        die
+      end
+
+      at_exit do
+        die
+      end
+
+      @settings = settings
+      @loop = spin
+      @shutdown = false
+      @deferreds = {}
+      @main = block if block_given?
+    end
+
+    # Start running.
+    def run!
+      @main_thread = Thread.current
+
+      startup
+
+      @ready = true
+
+      if @main
+        instance_eval(&@main)
+      elsif loop?
+        sleep 1 while !shutdown?
+      end
+
+      shutdown
+    end
+
+    # TODO don't start threads yet; wait until all startup hooks have been run
+    def defer(callback_name, timeout = 30, &block)
+      puts "Deferring to #{callback_name}..." if debug?
+      @deferreds[callback_name.to_sym] = Thread.new(callback_name.to_sym) do |callback|
+
+        begin
+
+          timeout(timeout) do
+            begin
+              results = instance_eval(&block)
+              send(callback, results) if respond_to?(callback)
+            rescue Jabber::ServerError => e
+              puts "Server error: #{e}"
+            end
+          end
+
+          puts "Done with #{callback}." if debug?
+          # TODO make this thread-safe
+          @deferreds.delete(callback)
+
+        rescue Timeout::Error
+          puts "Deferred method timed out."
+        rescue
+          puts "An error occurred while running a deferred: #{$!}"
+          puts $!.backtrace * "\n"
+          shutdown!
+        end
+      end
+    end
+
+    def hook(*events)
+      self.class.hook(*events)
+    end
+
+    # Connect a jack to the switchboard
+    def plug!(*jacks)
+      @jacks ||= []
+      jacks.each do |jack|
+        puts "Connecting jack: #{jack}" if debug?
+        @jacks << jack
+        if jack.connect(self, settings) == false
+          puts "A jack was unable to connect. Shutting down..."
+          shutdown(false)
+          exit 1
+        end
+      end
+    end
+
+    def ready?
+      @ready
+    end
+
+    hook(:exception, :iq, :message, :presence, :stanza, :startup, :stream_connected, :shutdown)
+
+  protected
+
+    def connect!
+      raise NotImplementedError, "subclasses of Switchboard::Core must implement connect!"
+    end
+
+    def connected?
+      @connected
+    end
+
+    def debug?
+      settings["debug"]
+    end
+
+    def die
+      @deferreds.each do |name, deferred|
+        puts "Killing #{name}" if debug?
+        deferred.kill
+      end
+
+      shutdown!
+
+      if Thread.current != @main_thread
+        timeout(15) do
+          puts "Waiting for shutdown to complete."
+          sleep 0.1 until shutdown_complete?
+        end
+      end
+
+    rescue Timeout::Error
+      puts "Shutdown timed out."
+    end
+
+    def disconnect!
+      stream.close
+    end
+
+    def register_hook(name, method = nil, &block)
+      @hooks ||= {}
+      name = name.to_sym
+      @hooks[name] ||= []
+
+      puts "Registering #{name} hook" if debug?
+      if block_given?
+        @hooks[name] << block
+      else
+        @hooks[name] << lambda do |*args|
+          send(method.to_sym, *args)
+        end
+      end
+    end
+
+    def on(name, *args)
+      @hooks ||= {}
+      @hooks[name.to_sym] ||= []
+      @hooks[name.to_sym].each do |hook|
+        puts "Executing hook '#{name}'" if debug?
+        execute_hook(hook, *args)
+      end
+    end
+
+    def execute_hook(hook, *args)
+      timeout(1) do
+        instance_exec(*args, &hook)
+      end
+    rescue Timeout::Error
+      puts "Hook timed out, consider deferring it."
+    rescue
+      puts "An error occurred while running the hook; shutting down..."
+      puts $!
+      puts $!.backtrace * "\n"
+      shutdown!
+      raise
+    end
+
+    def loop?
+      @loop
+    end
+
+    def register_default_callbacks
+      stream.on_exception do |e, stream, where|
+        on(:exception, e, stream, where)
+
+        case where
+        when :disconnected
+          puts "Jabber service disconnected.  Shutting down."
+          exit 1
+        when :exit
+          puts "Shutting down."
+        else
+          puts "Caught #{e.inspect} on #{stream} at #{where}.  You might want to consider handling this."
+          raise e
+        end
+      end
+
+      stream.add_presence_callback do |presence|
+        on(:presence, presence)
+        on(:stanza, presence)
+      end
+
+      stream.add_message_callback do |message|
+        on(:message, message)
+        on(:stanza, message)
+      end
+
+      stream.add_iq_callback do |iq|
+        on(:iq, iq)
+        on(:stanza, iq)
+      end
+    end
+
+    def startup
+      begin
+        timeout(30) do
+          register_default_callbacks
+
+          connect!
+          @connected = true
+
+          on(:stream_connected)
+        end
+      rescue Timeout::Error
+        puts "Startup took too long.  Shutting down."
+        shutdown(false)
+        exit 1
+      end
+
+      puts "Core startup completed." if debug?
+
+      # run startup hooks
+      on(:startup)
+
+      puts "=> Switchboard started."
+    end
+
+    def stream
+      raise NotImplementedError, "subclasses of Switchboard::Core must implement stream"
+    end
+
+    def shutdown!
+      puts "Shutdown initiated."
+      @shutdown = true
+    end
+
+    def shutdown(run_hooks = true)
+      if Thread.current != @main_thread
+        $stderr.puts "Wrong thread! You should be using #shutdown! instead."
+        shutdown!
+        return
+      end
+
+      while (pending = @deferreds.select { |k,d| d.alive? }.length) > 0
+        puts "Waiting for #{pending} thread(s) to finish" if debug?
+        sleep 1
+      end
+
+      # run shutdown hooks
+      on(:shutdown) if run_hooks
+
+      puts "Shutting down..." if debug?
+      disconnect! if connected?
+
+      @shutdown_complete = true
+    end
+
+    def shutdown?
+      @shutdown
+    end
+
+    def shutdown_complete?
+      @shutdown_complete
+    end
+  end
+end