jeffrafter-marvin 0.1.20081115 → 0.1.20081120

data/lib/marvin/parsers/ragel_parser.rl

@@ -0,0 +1,144 @@
+# Ragel Parser comes from the Arrbot Guys -
+# Kudos to Halogrium and Epitron.
+
+%%{
+  machine irc;
+  
+  action prefix_servername_start {
+    server = Marvin::Parsers::Prefixes::Server.new
+  }
+  
+  action prefix_servername {
+    server.name << fc
+  }
+  
+  action prefix_servername_finish {
+    command.prefix = server
+  }
+  
+  action prefix_hostmask_start {
+    hostmask =  Marvin::Parsers::Prefixes::HostMask.new
+  }
+  
+  action hostmask_nickname {
+    hostmask.nickname << fc
+  }
+  
+  action hostmask_user {
+    hostmask.user << fc
+  }
+  
+  action hostmask_host {
+    hostmask.host << fc
+  }
+  
+  action prefix_hostmask_finish {
+    command.prefix = hostmask
+  }
+  
+  action message_code_start {
+    code = ""
+  }
+  
+  action message_code {
+    code << fc
+  }
+  
+  action message_code_finish {
+    command.code = code
+  }
+  
+  action params_start {
+    params_1 = []
+    params_2 = []
+  }
+  
+  action params {
+  }
+  
+  action params_1_start {
+    params_1 << ""
+  }
+  
+  action params_2_start {
+    params_2 << ""
+  }
+  
+  action params_1 {
+    params_1.last << fc
+  }
+
+  action params_2 {
+    params_2.last << fc
+  }
+  
+  action params_1_finish {
+    command.params = params_1
+  }
+  
+  action params_2_finish {
+    command.params = params_2
+  }
+  
+  SPACE          = " ";
+  special        = "[" | "\\" | "]" | "^" | "_" | "`" | "{" | "|" | "}" | "+";
+  nospcrlfcl     = extend - ( 0 | SPACE | '\r' | '\n' | ':' );
+  crlf           = "\r\n";
+  shortname      = ( alnum ( alnum | "-" )* alnum* ) | "*";
+  multihostname  = shortname ( ( "." | "/" ) shortname )*;
+  singlehostname = shortname ( "." | "/" );
+  hostname       = multihostname | singlehostname;
+  servername     = hostname;
+  nickname       = ( alpha | special ) ( alnum | special | "-" ){,15};
+  user           = (extend - ( 0 | "\n" | "\r" | SPACE | "@" ))+;
+  ip4addr        = digit{1,3} "." digit{1,3} "." digit{1,3} "." digit{1,3};
+  ip6addr        = ( xdigit+ ( ":" xdigit+ ){7} ) | ( "0:0:0:0:0:" ( "0" | "FFFF"i ) ":" ip4addr );
+  hostaddr       = ip4addr | ip6addr;
+  host           = hostname | hostaddr;
+  hostmask       = nickname $ hostmask_nickname ( ( "!" user $ hostmask_user )? "@" host $ hostmask_host )?;
+  prefix         = ( servername $ prefix_servername > prefix_servername_start % prefix_servername_finish ) | ( hostmask > prefix_hostmask_start % prefix_hostmask_finish );
+  code           = alpha+ | digit{3};
+  middle         = nospcrlfcl ( ":" | nospcrlfcl )*;
+  trailing       = ( ":" | " " | nospcrlfcl )*;
+  params_1       = ( SPACE middle $ params_1 > params_1_start ){,14} ( SPACE ":"  trailing $ params_1 > params_1_start )?;
+  params_2       = ( SPACE middle $ params_2 > params_2_start ){14}  ( SPACE ":"? trailing $ params_2 > params_2_start )?;
+  params         =  ( params_1 % params_1_finish | params_2 % params_2_finish ) $ params > params_start;
+  message        = ( ":" prefix SPACE )? ( code $ message_code > message_code_start % message_code_finish ) params? crlf;
+  
+  main := message;
+  
+}%%
+
+module Marvin
+  module Parsers
+    class RagelParser < Marvin::AbstractParser
+      
+      %% write data;
+      
+      private
+      
+      def self.parse!(line)
+        data = "#{line.strip}\r\n"
+
+        p = 0;
+        pe = data.length
+        cs = 0
+
+        hostmask = nil
+        server   = nil
+        code     = nil
+        command  = Marvin::Parsers::Command.new(data)
+
+        %% write init;
+        %% write exec;
+
+        if cs >= irc_first_final
+          command
+        else
+          raise UnparseableMessage, "Failed to parse the message: #{input.inspect}"
+        end
+      end
+      
+    end
+  end
+end

data/lib/marvin/parsers/regexp_parser.rb

@@ -81,9 +81,6 @@ module Marvin
       register_event :quit,    /^\:(.+)\!\~?(.+)\@(.+) QUIT :?(.+?)$/i,
                      :nick, :ident, :host, :message
                    
-      register_event :nick_taken, /^\:(\S+) 433 \* (\w+) :(.+)$/,
-                     :server, :target, :message
-                   
       register_event :ping,   /^\:(.+)\!\~?(.+)\@(.+) PING (.*)$/,
                      :nick, :ident, :host, :data
                      

data/lib/marvin/parsers/simple_parser.rb

@@ -1,101 +1,40 @@
-require File.dirname(__FILE__) / "simple_parser/prefixes"
-require File.dirname(__FILE__) / "simple_parser/event_extensions"
-require File.dirname(__FILE__) / "simple_parser/default_events"
-
 module Marvin
   module Parsers
     class SimpleParser < Marvin::AbstractParser
       
-      cattr_accessor :events
-      self.events ||= {}
-      
-      attr_accessor :arguments, :prefix, :current_line, :parts, :event
-      
-      def initialize(line)
-        self.current_line = line
-        parse!
-      end
-      
-      def to_event
-        if self.event.blank?
-          parse!
-          return nil
-        else
-          return self.event
-        end
-      end
-      
       private
-    
-      def parse!
-        # Split the message
-        line = self.current_line
+      
+      # Parses an incoming message by using string
+      # Manipulation.
+      def self.parse!(line)
         if line[0] == ?:
           prefix_text, line = line.split(" ", 2)
         else
           prefix_text = nil
         end
-        extract_prefix! prefix_text
-        
+        command = Marvin::Parsers::Command.new(line + "\r\n")
+        command.prefix = self.extract_prefix(prefix_text)
         head, tail = line.split(":", 2)
-        self.parts = head.split(" ")
-        self.parts << tail
-        command = self.parts.shift.upcase.to_sym
-        if command.to_s =~ /^[0-9]{3}$/
-          # Other Command
-          self.parts.unshift(command.to_s) # Reappend the command
-          process_event self.events[:numeric]
-        elsif self.events.has_key? command
-          # Registered Command
-          process_event self.events[command]
-        else
-          # Unknown Command
-          self.event = nil
-        end
-      end
-      
-      def process_event(prototype, skip_mutation = false)
-        self.event = prototype.dup
-        self.event.prefix = self.prefix
-        self.event.raw_arguments = self.parts
-        mutate_event! unless skip_mutation
+        parts = head.split(" ")
+        command.code = parts.shift
+        parts << tail unless tail.nil?
+        command.params = parts
+        return command
       end
       
-      def mutate_event!
-        # Do nothing by default
-        name, contents = self.event.name, self.event.raw_arguments.last
-        # mutate for ctcp and actions
-        if name == :message && contents[0..0] == "\001" && contents[-1..-1] == "\001"
-          if message.index("ACTION: ") == 1
-            message = message[9..-2]
-            new_event = :action
-          else
-            message = message[1..-2]
-            new_event = :ctcp
-          end
-          self.parts = [message]
-          process_event self.events[new_event], true
-        end
-      end
-      
-      def extract_prefix!(text)
-        return if text.blank?
-        full_prefix = text[1..-1]
-        prefix = full_prefix
-        # Ugly regexp for nick!ident@host format
-        # Officially this should be less-terse, but hey
-        # it's a simple parser.
-        if full_prefix =~ /^([^@!]+)\!\~?([^@]+)@(.*)$/
-          prefix = UserPrefix.new($1, $2, $3)
+      # From a given string, attempts to get the correct
+      # type of prefix (be it a HostMask or a Server name).
+      def self.extract_prefix(prefix_text)
+        return if prefix_text.blank?
+        prefix_text = prefix_text[1..-1] # Remove the leading :
+        # I think I just vomitted in my mouth a little...
+        if prefix_text =~ /^([A-Za-z0-9\-\[\]\\\`\^\{\}]+)(\!\~?([^@]+))?(@(.*))?$/
+          prefix = Prefixes::HostMask.new($1, $3, $5)
         else
-          # TODO: Validate the hostname here.
-          prefix = ServerNamePrefix.new(prefix.strip)
+          prefix = Prefixes::Server.new(prefix_text.strip)
         end
-        self.prefix = prefix
         return prefix
       end
-      
-      include DefaultEvents
     end 
   end
 end

data/lib/marvin/settings.rb

@@ -1,14 +1,19 @@
 require 'yaml'
+require 'eventmachine'
 
 module Marvin
   class Settings
     
-    cattr_accessor :environment, :configuration, :is_setup, :default_client, :handler_folder, :default_parser
+    cattr_accessor :environment, :configuration, :is_setup, :default_client,
+                   :handler_folder, :default_parser, :log_level, :verbose
+                   
+    self.verbose   = false
+    self.log_level = :info
     
     class << self
       
       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 = {})
@@ -23,13 +28,8 @@ module Marvin
       def setup!(options = {})
         self.environment ||= "development"
         self.configuration = {}
-        self.default_client ||= begin
-                                  require 'eventmachine'
-                                  Marvin::IRC::Client
-                                rescue LoadError
-                                  Marvin::IRC::SocketClient
-                                end
-        self.default_parser ||= Marvin::Parsers::RegexpParser
+        self.default_client ||= Marvin::IRC::Client
+        self.default_parser ||= Marvin::Parsers::SimpleParser
         loaded_yaml = YAML.load_file(root / "config/settings.yml")
         loaded_options = loaded_yaml["default"].
                            merge(loaded_yaml[self.environment]).

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.
@@ -10,9 +17,9 @@ module Marvin
       alias chan channel_name
       
       def arguments(input)
-        prefix, *ending = input.split(":")
+        prefix, ending = input.split(":", 2)
         prefix = prefix.split(" ")
-        prefix << ending.join(":").strip
+        prefix << ending unless ending.blank?
         return prefix
       end
 
@@ -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/daemon-runner

@@ -4,7 +4,7 @@ require 'daemons'
 
 DIR = File.join(File.dirname(__FILE__), "..")
 
-Daemons.run(File.join(DIR, "script/run --is-daemon"),
+Daemons.run(File.join(DIR, "script/client"),
             {:mode => :exec,
              :dir => DIR,
              :dir_mode => :normal,

data/script/install

@@ -0,0 +1,3 @@
+gem uninstall marvin --quiet
+gem build marvin.gemspec
+gem install marvin-0.1.*.gem

data/test/parser_comparison.rb

@@ -0,0 +1,62 @@
+require 'benchmark'
+require File.join(File.dirname(__FILE__),'../lib/marvin')
+
+LINES = [
+  ":irc.darth.vpn.spork.in 366 testbot #testing :End of NAMES list",
+  ":Helsinki.FI.EU.Undernet.org PONG Helsinki.FI.EU.Undernet.org :Helsinki.FI.EU.Undernet.org",
+  ":testnick USER guest tolmoon tolsun :Ronnie Reagan",
+  "LIST #twilight_zone,#42",
+  ":WiZ LINKS *.bu.edu *.edu",
+  ":Angel PRIVMSG Wiz :Hello are you receiving this message ?",
+  ":RelayBot!n=MarvinBo@203.161.81.201.static.amnet.net.au JOIN :#relayrelay",
+  ":SuttoL!n=SuttoL@li6-47.members.linode.com PRIVMSG #relayrelay :testing...",
+  ":wolfe.freenode.net 004 MarvinBot3000 wolfe.freenode.net hyperion-1.0.2b aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@ bcdefFhiIklmnoPqstv"
+]
+PARSERS = [Marvin::Parsers::RagelParser, Marvin::Parsers::SimpleParser, Marvin::Parsers::RegexpParser]
+
+LINES.each do |line|
+  
+  puts "Processing: #{line}"
+  puts ""
+  cmd = []
+  
+  PARSERS.each do |p|
+    parser = p.new(line)
+    ev    = parser.to_event
+    puts "Parser:  #{p.name}"
+    if ev.nil?
+      puts "Unknown Event"
+    else
+      puts ev.to_hash.inspect
+    end
+    puts ""
+  end
+  puts ""
+  
+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