Sutto-marvin 0.1.20081120 → 0.2.0

data/lib/marvin/logger.rb

@@ -6,7 +6,7 @@ module Marvin
     class << self
       
       def setup
-        log_path = Marvin::Settings.root / "log/#{Marvin::Settings.environment}.log"
+        log_path = Marvin::Settings.root / "log/#{Marvin::Loader.type.to_s.dasherize}-#{Marvin::Settings.environment}.log"
         self.logger ||= new(log_path, Marvin::Settings.log_level, Marvin::Settings.verbose)
       end
       
@@ -17,7 +17,6 @@ module Marvin
     
     end
     
-    
     LEVELS = {
       :fatal => 7,
       :error => 6,
@@ -74,6 +73,7 @@ module Marvin
   
     def write(message, level = self.level)
       self.file.puts message
+      self.file.flush
       STDOUT.puts colourize(message, level) if self.verbose
     end
   

data/lib/marvin/options.rb

@@ -6,7 +6,8 @@ module Marvin
     def self.parse!
       options = {
         :verbose   => Marvin::Settings.verbose,
-        :log_level => Marvin::Settings.log_level.to_s
+        :log_level => Marvin::Settings.log_level.to_s,
+        :daemon    => false
       }
       
       ARGV.options do |o|
@@ -19,12 +20,20 @@ module Marvin
         o.on("-l", "--level=[level]", String, "The log level to use",
              "Default: #{options[:log_level]}") {|options[:log_level]|}
         o.on("-v", "--verbose", "Be verbose (print to stdout)") {|options[:verbose]|}
+        o.on("-d", "--daemon",  "Run as a daemon (drop the PID)") {|options[:daemon]|}
+        o.on("-k", "--kill", "Kill all of the current type / the running instances") do |kill|
+           if kill
+            Marvin::Daemon.kill_all(Marvin::Loader.type)
+            exit
+          end
+        end
+        
         o.separator   ""
         o.on_tail("-h", "--help", "Show this message.") { puts o; exit }
-        
         o.parse!
       end
       
+      Marvin::Settings.daemon    = options[:daemon]
       Marvin::Settings.log_level = options[:log_level].to_sym
       Marvin::Settings.verbose   = options[:verbose]
     end

data/lib/marvin/parsers/command.rb

@@ -51,17 +51,49 @@ module Marvin
         @@commands[command.to_sym] = Marvin::IRC::Event.new(name, *args)
       end
       
-      register_event :nick,    :NICK,    :new_nick
-      register_event :quit,    :QUIT,    :message
-      register_event :ping,    :PING,    :data
-      register_event :pong,    :PONG,    :data
-      register_event :join,    :JOIN,    :target
-      register_event :invite,  :INVITE,  :target,  :channel
-      register_event :message, :PRIVMSG, :target,  :message
-      register_event :part,    :PART,    :target,  :message
-      register_event :mode,    :MODE,    :target,  :mode               
-      register_event :kick,    :KICK,    :target,  :channel, :reason
-      register_event :topic,   :TOPIC,   :target,  :topic
+      register_event :pass,     :PASS,     :password
+      register_event :user,     :USER,     :user, :mode, :unused, :real_name
+      register_event :oper,     :OPER,     :name, :password
+      register_event :service,  :SERVICE,  :nick, :reserved, :distribution, :type, :reserved, :info
+      register_event :squit,    :SQUIT,    :server, :comment
+      register_event :nick,     :NICK,     :new_nick
+      register_event :quit,     :QUIT,     :message
+      register_event :ping,     :PING,     :data, :server
+      register_event :pong,     :PONG,     :data, :server
+      register_event :join,     :JOIN,     :target, :key
+      register_event :invite,   :INVITE,   :target, :channel
+      register_event :message,  :PRIVMSG,  :target, :message
+      register_event :part,     :PART,     :target, :message
+      register_event :mode,     :MODE,     :target, :mode, :mode_params
+      register_event :kick,     :KICK,     :target, :channel, :reason
+      register_event :notice,   :NOTICE,   :target, :message
+      register_event :topic,    :TOPIC,    :target, :topic
+      register_event :names,    :NAMES,    :channel, :target
+      register_event :list,     :LIST,     :channel, :target
+      register_event :motd,     :MOTD,     :target
+      register_event :lusers,   :LUSERS,   :mask, :target
+      register_event :version,  :VERSION,  :target
+      register_event :links,    :LINKS,    :remote, :mask
+      register_event :connect,  :CONNECT,  :target, :port, :remote
+      register_event :trace,    :TRACE,    :target
+      register_event :admin,    :ADMIN,    :target
+      register_event :info,     :INFO,     :target
+      register_event :servlist, :SERVLIST, :mask, :type
+      register_event :squery,   :SQUERY,   :service_name, :text
+      register_event :who,      :WHO,      :mask, :o
+      register_event :whois,    :WHOIS,    :target, :mask
+      register_event :whowas,   :WHOWAS,   :nick, :count, :target
+      register_event :kill,     :KILL,     :nick, :reason
+      register_event :error,    :ERROR,    :message
+      register_event :away,     :AWAY,     :reason
+      register_event :rehash,   :REHASH
+      register_event :die,      :DIE
+      register_event :restart,  :RESTART
+      register_event :summon,   :SUMMON,   :user, :target, :channel
+      register_event :users,    :USERS,    :target
+      register_event :wallops,  :WALLOPS,  :message
+      register_event :userhost, :USERHOST, :nick
+      register_event :ison,     :ISON,     :nick
       # Add the default numeric event
       register_event :numeric, :numeric, :code, :data
       # And a few others reserved for special purposed

data/lib/marvin/settings.rb

@@ -5,15 +5,20 @@ module Marvin
   class Settings
     
     cattr_accessor :environment, :configuration, :is_setup, :default_client,
-                   :handler_folder, :default_parser, :log_level, :verbose
+                   :handler_folder, :default_parser, :log_level, :verbose, :daemon
                    
     self.verbose   = false
     self.log_level = :info
+    self.daemon    = false
     
     class << self
       
+      def daemon?
+        self.daemon
+      end
+      
       def root
-        defined?(MARVIN_ROOT) ? MARVIN_ROOT : File.dirname(__FILE__) / "../.."
+        File.expand_path(defined?(MARVIN_ROOT) ? MARVIN_ROOT : File.dirname(__FILE__) / "../..")
       end
       
       def setup(options = {})
@@ -21,10 +26,6 @@ module Marvin
         self.setup!(options)
       end
       
-      def daemon?
-        defined?(IS_DAEMON) && IS_DAEMON
-      end
-      
       def setup!(options = {})
         self.environment ||= "development"
         self.configuration = {}

data/lib/marvin/status.rb

@@ -0,0 +1,72 @@
+module Marvin
+  class Status
+    CONTROLLERS = {
+      :client             => "IRC Client",
+      :server             => "IRC Server",
+      :ring_server        => "Ring Server",
+      :distributed_client => "Distributed Client",
+    }
+    
+    class << self
+      
+      def show!
+        STDOUT.puts ""
+        STDOUT.puts " Marvin Status"
+        STDOUT.puts " ============="
+        STDOUT.puts ""
+        if ARGV.include?("--help") || ARGV.include?("-h")
+          STDOUT.puts " Usage: script/status [options]\n\n"
+          STDOUT.puts " -h, --help    Show this message"
+          STDOUT.puts " -f, --full    Include distributed stats"
+          STDOUT.puts ""
+          exit
+        end
+        pids = {}
+        CONTROLLERS.each_key { |k| pids[k] = Marvin::Daemon.pids_for_type(k) }
+        CONTROLLERS.each do |k, v|
+          count = pids[k].size
+          postfix = count == 1 ? "" : "s"
+          STDOUT.puts " #{count} running instance#{postfix} of the #{CONTROLLERS[k]}"
+          STDOUT.puts " Pid#{postfix}: #{pids[k].join(", ")}" unless count == 0
+          STDOUT.puts ""
+        end
+        
+        if (ARGV.include?("-f") || ARGV.include?("--full")) && !pids[:ring_server].empty?
+          require 'rinda/ring'
+          DRb.start_service
+          STDOUT.puts " Distributed Status"
+          STDOUT.puts " ------------------"
+          begin
+            rs = Rinda::RingFinger.finger.lookup_ring(3)
+            STDOUT.puts " Ring Server:        #{rs.__drburi}"
+            items = rs.read_all([:marvin_event, nil, nil, nil])
+            STDOUT.puts " Unprocessed Items:  #{items.size}"
+            STDOUT.puts ""
+            unless items.empty?
+              start_time = items.first[2][:dispatched_at]
+              STDOUT.puts  " Earliest Item:     #{start_time ? start_time.strftime("%I:%M%p %d/%m/%y") : "Never"}"
+              end_time   = items.last[2][:dispatched_at]
+              STDOUT.puts  " Latest Item:       #{end_time ? end_time.strftime("%I:%M%p %d/%m/%y") : "Never"}"
+              mapping = {}
+              items.each do |i|
+                mapping[i[1].inspect] ||= 0
+                mapping[i[1].inspect] += 1
+              end
+              width = mapping.keys.map { |k| k.length }.max
+              STDOUT.puts ""
+              STDOUT.puts " Unprocessed Message Counts:"
+              STDOUT.puts " ---------------------------"
+              mapping.each { |k, v| STDOUT.puts " #{k.ljust width}  => #{v}" }
+              STDOUT.puts ""
+            end
+          rescue
+            STDOUT.puts " Ring server not found."
+            STDOUT.puts ""
+          end
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/marvin/test_client.rb

@@ -12,7 +12,7 @@ module Marvin
     
     DispatchedEvents = Struct.new(:name, :options)
     
-    def initialize
+    def initialize(opts = {})
       super
       self.incoming_commands = []
       self.outgoing_commands = []
@@ -56,5 +56,9 @@ module Marvin
       end
     end
     
+    def self.add_reconnect(opts = {})
+      Marvin::Logger.info "Added reconnect with options: #{opts.inspect}"
+    end
+    
   end
 end

data/lib/marvin/util.rb

@@ -1,6 +1,13 @@
 module Marvin
   module Util
       
+      GLOB_PATTERN_MAP = {
+        '*' => '.*',
+        '?' => '.',
+        '[' => '[',
+        ']' => ']'
+      }
+      
       # Return the channel-name version of a string by
       # appending "#" to the front if it doesn't already
       # start with it.
@@ -20,9 +27,19 @@ module Marvin
       # specify parameters which have spaces etc (for example,
       # the actual message part of a response).
       def last_param(section)
-        section && ":#{section.to_s.strip} "
+        section && ":#{section.to_s.strip}"
       end
       alias lp last_param
+      
+      # Converts a glob-like pattern into a regular
+      # expression for easy / fast matching. Code is
+      # from PLEAC at http://pleac.sourceforge.net/pleac_ruby/patternmatching.html
+      def glob2pattern(glob_string)
+          inner_pattern = glob_string.gsub(/(.)/) do |c|
+            GLOB_PATTERN_MAP[c] || Regexp::escape(c)
+          end
+        return Regexp.new("^#{inner_pattern}$")
+      end
      
       extend self
      

data/script/client

@@ -1,25 +1,9 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 
-if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
-  $:.unshift(File.dirname(__FILE__) + "/../lib/")
-end
-
+$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
 MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
-IS_DAEMON = ARGV.include?("--is-daemon")
 
 # And Require Marvin.
 require 'marvin'
-
-["INT", "TERM"].each do |sig|
-  
-  # Trap a given signal and run all
-  # of our callbacks etc,
-  trap sig do
-    Marvin::Loader.stop!
-    exit
-  end
-  
-end
-
-Marvin::Loader.run!
+Marvin::Loader.run! :client

data/script/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+libs = ["-r irb/completion", "-r lib/marvin", "-r lib/marvin/console"]
+
+cmd = "irb #{libs.join(" ")} --simple-prompt"
+
+puts "Loading Marvin console..."
+
+exec cmd

data/script/distributed_client

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+
+$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
+MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
+
+# And Require Marvin.
+require 'marvin'
+Marvin::Loader.run! :distributed_client

data/script/ring_server

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+#!/usr/bin/env ruby
+require 'rubygems'
+
+$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
+MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
+
+# And Require Marvin.
+require 'marvin'
+Marvin::Loader.run! :ring_server
+

data/script/server

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+#!/usr/bin/env ruby
+require 'rubygems'
+
+$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
+MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
+
+# And Require Marvin.
+require 'marvin'
+Marvin::Loader.run! :server
+

data/script/status

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+require 'rubygems'
+
+$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
+MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
+
+# And Require Marvin.
+require 'marvin'
+
+Marvin::Status.show!

data/test/parser_comparison.rb

@@ -33,4 +33,30 @@ LINES.each do |line|
   end
   puts ""
   
-end
+end
+
+puts ""
+puts ""
+puts "==============="
+puts "| SPEED TESTS |"
+puts "==============="
+puts ""
+
+width = PARSERS.map { |p| p.name.length }.max + 2
+
+ITERATIONS = 1000
+
+Benchmark.bm(width) do |b|
+  PARSERS.each do |parser|
+    b.report("#{parser.name}: ") do
+      LINES.each do |l|
+        ITERATIONS.times do
+          e = parser.new(l).to_event
+          unless e.nil?
+            e.to_hash # Get a hash
+          end
+        end
+      end
+    end
+  end
+end

data/test/parser_test.rb

@@ -1,20 +1,264 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+# In reality this tests several different classes:
+# 1) The parser itself
+# 2) The Command class
+# 3) The two different types of prefixes
+# 4) The Event class
 class ParserTest < Test::Unit::TestCase
-  @@parser = nil
-  def self.parser_is(p)
-    @@parser = p
-  end
+  @@parser = Marvin::Parsers::SimpleParser
   
-  context "When parsing a PONG" do
+  context "When parsing a LIST" do
+    setup { @parsed = @@parser.new("LIST #twilight_zone,#42") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have not a prefix" do
+      assert @parsed.command.prefix.nil?
+    end
+    
+    should "have a code of LIST" do
+      assert_equal "LIST", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["#twilight_zone,#42"], @parsed.command.params
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_list, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_list, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:channel => "#twilight_zone,#42", :target => ""}, @parsed.to_event.to_hash)
+    end
+    
   end
   
-  context "When parsing a PING" do
+  context "When parsing a JOIN" do
+    setup { @parsed = @@parser.new(":RelayBot!n=MarvinBot@static.amnet.net.au JOIN :#relayrelay") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of JOIN" do
+      assert_equal "JOIN", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["#relayrelay"], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::HostMask)
+    end
+    
+    should "have the correct nick" do
+      assert_equal "RelayBot", @parsed.command.prefix.nickname
+    end
+    
+    should "have the correct user" do
+      assert_equal "n=MarvinBot", @parsed.command.prefix.user
+    end
+    
+    should "have the correct host" do
+      assert_equal "static.amnet.net.au", @parsed.command.prefix.host
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_join, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_join, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:target => "#relayrelay", :key => ""}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
   end
   
   context "When parsing a PRIVMSG" do
+    setup { @parsed = @@parser.new(":SuttoL!n=SuttoL@sutto.net PRIVMSG #relayrelay :testing...") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of PRIVMSG" do
+      assert_equal "PRIVMSG", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["#relayrelay", "testing..."], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::HostMask)
+    end
+    
+    should "have the correct nick" do
+      assert_equal "SuttoL", @parsed.command.prefix.nickname
+    end
+    
+    should "have the correct user" do
+      assert_equal "n=SuttoL", @parsed.command.prefix.user
+    end
+    
+    should "have the correct host" do
+      assert_equal "sutto.net", @parsed.command.prefix.host
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_message, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_message, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:target => "#relayrelay", :message => "testing..."}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
+  end
+  
+  context "When parsing a numeric - 366" do
+    setup { @parsed = @@parser.new(":irc.darth.vpn.spork.in 366 testbot #testing :End of NAMES list") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of 366" do
+      assert_equal "366", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["testbot", "#testing", "End of NAMES list"], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::Server)
+    end
+    
+    should "have the correct name" do
+      assert_equal "irc.darth.vpn.spork.in", @parsed.command.prefix.name
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_numeric, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_numeric, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:code => "366", :data => "testbot #testing :End of NAMES list"}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
+  end
+  
+  context "When parsing a numeric - 004" do
+    setup { @parsed = @@parser.new(":wolfe.freenode.net 004 MarvinBot3000 wolfe.freenode.net hyperion-1.0.2b aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@ bcdefFhiIklmnoPqstv") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of 366" do
+      assert_equal "004", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["MarvinBot3000" , "wolfe.freenode.net", "hyperion-1.0.2b", "aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@", "bcdefFhiIklmnoPqstv"], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::Server)
+    end
+    
+    should "have the correct name" do
+      assert_equal "wolfe.freenode.net", @parsed.command.prefix.name
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_numeric, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_numeric, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:code => "004", :data => "MarvinBot3000 wolfe.freenode.net hyperion-1.0.2b aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@ bcdefFhiIklmnoPqstv"}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
   end
   
-end
-
-["Regexp", "Simple"].each do |parser_name|
-  eval("class #{parser_name}ParserTest < ParserTest; parser_is #{parser_is}Parser; end")
 end