marvin 0.8.0.0

data/lib/marvin/exceptions.rb

@@ -0,0 +1,11 @@
+module Marvin
+  
+  class Error < StandardError; end
+  
+  # Used to stop the flow of handler chains.
+  class HaltHandlerProcessing < Error; end
+  
+  # Used for when an expression can't be parsed
+  class UnparseableMessage < Error; end
+  
+end

data/lib/marvin/irc.rb

@@ -0,0 +1,7 @@
+module Marvin
+  module IRC
+    autoload :Client,  'marvin/irc/client'
+    autoload :Event,   'marvin/irc/event'
+    autoload :Replies, 'marvin/irc/replies'
+  end
+end

data/lib/marvin/irc/client.rb

@@ -0,0 +1,168 @@
+require 'eventmachine'
+
+module Marvin::IRC
+  class Client < Marvin::AbstractClient
+    
+    @@stopped = false
+    
+    attr_accessor :em_connection
+    
+    class EMConnection < EventMachine::Protocols::LineAndTextProtocol
+      is :loggable
+      
+      attr_accessor :client, :port, :configuration
+      
+      def initialize(*args)
+        @configuration = args.last.is_a?(Marvin::Nash) ? args.pop : Marvin::Nash.new
+        super(*args)
+        @client = Marvin::IRC::Client.new(@configuration)
+        @client.em_connection = self
+        @connected = false
+      rescue Exception => e
+        Marvin::ExceptionTracker.log(e)
+        Marvin::IRC::Client.stop
+      end
+      
+      def post_init
+        super
+        if should_use_ssl?
+          logger.info "Starting SSL for #{host_with_port}"
+          start_tls
+        else
+          connected!
+        end
+      rescue Exception => e
+        Marvin::ExceptionTracker.log(e)
+        Marvin::IRC::Client.stop
+      end
+      
+      def ssl_handshake_completed
+        logger.info "SSL handshake completed for #{host_with_port}"
+        connected! if should_use_ssl?
+      rescue Exception => e
+        Marvin::ExceptionTracker.log(e)
+        Marvin::IRC::Client.stop
+      end
+
+      def unbind
+        @client.process_disconnect
+        super
+      end
+      
+      def receive_line(line)
+        return unless @connected
+        line = line.strip
+        logger.debug "<< #{line}"
+        @client.receive_line(line)
+      rescue Exception => e
+        logger.warn "Uncaught exception raised; Likely in Marvin"
+        Marvin::ExceptionTracker.log(e)
+      end
+      
+      def send_line(*lines)
+        return unless @connected
+        lines.each do |line|
+          logger.debug ">> #{line.strip}"
+          send_data line
+        end
+      end
+      
+      def connected!
+        @connected = true
+        @client.process_connect
+      end
+      
+      def should_use_ssl?
+        @should_use_ssl ||= @configuration.ssl?
+      end
+      
+      def host_with_port
+        "#{@configuration.host}:#{@configuration.port}"
+      end
+      
+    end
+    
+    ## Client specific details
+    
+    def send_line(*args)
+      @em_connection.send_line(*args)
+    end
+    
+    class << self
+      
+      # Starts the EventMachine loop and hence starts up the actual
+      # networking portion of the IRC Client.
+      def run(opts = {}, force = false)
+        self.development = opts[:development]
+        return if @stopped && !force
+        self.setup # So we have options etc
+        connections_file = Marvin::Settings.root / "config" / "connections.yml"
+        connections = Marvin::Nash.load_file(connections_file) rescue nil
+        if connections.present?
+          # Use epoll if available
+          EventMachine.kqueue
+          EventMachine.epoll
+          EventMachine.run do
+            connections.each_pair do |server, configuration|
+              connect(configuration.merge(:server => server.to_s))
+            end
+            Marvin::Distributed::Server.start if Marvin::Distributed::Handler.registered?
+            @@stopped = false
+          end
+        else
+          logger.fatal "config/connections.yml couldn't be loaded."
+        end
+      end
+
+      def connect(c, &blk)
+        c = normalize_connection_options(c)
+        raise ArgumentError, "Your connection options must specify a server" if !c.server?
+        raise ArgumentError, "Your connection options must specify a port"   if !c.port?
+        real_block = blk.present? ? proc { |c| blk.call(connection.client) } : nil
+        logger.info "Connecting to #{c.server}:#{c.port} (using ssl: #{c.ssl?}) - Channels: #{c.channels.join(", ")}"
+        EventMachine.connect(c.server, c.port, EMConnection, c, &real_block)
+      end
+
+      def stop
+        return if @@stopped
+        logger.debug "Telling all connections to quit"
+        connections.dup.each { |connection| connection.quit }
+        logger.debug "Telling Event Machine to Stop"
+        EventMachine.stop_event_loop
+        logger.debug "Stopped."
+        @@stoped = true
+      end
+
+      def add_reconnect(c)
+        logger.warn "Adding timer to reconnect to #{c.server}:#{c.port} in 15 seconds"
+        EventMachine.add_timer(15) do
+          logger.warn "Preparing to reconnect to #{c.server}:#{c.port}"
+          connect(c)
+        end
+      end
+      
+      protected
+      
+      def normalize_connection_options(config)
+        config = Marvin::Nash.new(config) if !config.is_a?(Marvin::Nash)
+        config = config.normalized
+        channels = config.channels
+        if channels.present?
+          config.channels = [*channels].compact.reject { |c| c.blank? }
+        else
+          config.channels = []
+        end
+        config.host ||= config.server
+        return config
+      end
+      
+    end
+    
+    # Registers a callback handle that will be periodically run.
+    def periodically(timing, event_callback)
+      EventMachine.add_periodic_timer(timing) { dispatch(event_callback.to_sym) }
+    end
+    
+  end
+  
+end

data/lib/marvin/irc/event.rb

@@ -0,0 +1,39 @@
+module Marvin::IRC
+  class Event
+    attr_accessor :keys, :name, :raw_arguments, :prefix
+    
+    def initialize(name, *args)
+      @name = name.to_sym
+      @keys = args.flatten.map { |k| k.to_sym }
+    end
+    
+    def to_hash
+      return @hash_value unless @hash_value.blank?
+      results = {}
+      values = @raw_arguments.to_a
+      last_index = @keys.size - 1
+      @keys.each_with_index do |key, i|
+        results[key] = (i == last_index ? values.join(" ").strip : values.shift)
+      end
+      results.merge!(@prefix.to_hash) unless @prefix.blank?
+      @hash_value = results
+    end
+    
+    def inspect
+      "#<Marvin::IRC::Event name=#{@name} attributes=#{to_hash.inspect} >"
+    end
+    
+    def to_event_name(prefix = nil)
+      [prefix, @name].join("_").to_sym
+    end
+    
+    def to_incoming_event_name
+      to_event_name :incoming
+    end
+    
+    def to_outgoing_event_name
+      to_event_name :outgoing
+    end
+    
+  end
+end

data/lib/marvin/irc/replies.rb

@@ -0,0 +1,154 @@
+module Marvin
+  module IRC
+    module Replies
+      
+      def self.[](key)
+        key = key.to_s.upcase
+        if const_defined?(key)
+          value = const_get(key)
+          return "%03d" % value
+        else
+          return nil
+        end
+      end
+      
+      # Common response codes.
+      RPL_WELCOME           = 001
+      RPL_YOURHOST          = 002
+      RPL_CREATED           = 003
+      RPL_MYINFO            = 004
+      RPL_BOUNCE            = 005
+      RPL_TRACELINK         = 200
+      RPL_TRACECONNECTING   = 201
+      RPL_TRACEHANDSHAKE    = 202
+      RPL_TRACEUNKNOWN      = 203
+      RPL_TRACEOPERATOR     = 204
+      RPL_TRACEUSER         = 205
+      RPL_TRACESERVER       = 206
+      RPL_TRACESERVICE      = 207
+      RPL_TRACENEWTYPE      = 208
+      RPL_TRACECLASS        = 209
+      RPL_TRACERECONNECT    = 210
+      RPL_TRACELOG          = 261
+      RPL_TRACEEND          = 262
+      RPL_STATSLINKINFO     = 211
+      RPL_STATSCOMMANDS     = 212
+      RPL_ENDOFSTATS        = 219
+      RPL_STATSUPTIME       = 242
+      RPL_STATSOLINE        = 243
+      RPL_UMODEIS           = 221
+      RPL_SERVLIST          = 234
+      RPL_SERVLISTEND       = 235
+      RPL_LUSERCLIENT       = 251
+      RPL_LUSEROP           = 252
+      RPL_LUSERUNKNOWN      = 253
+      RPL_LUSERCHANNELS     = 254
+      RPL_LUSERME           = 255
+      RPL_ADMINME           = 256
+      RPL_ADMINEMAIL        = 259
+      RPL_TRYAGAIN          = 263
+      RPL_USERHOST          = 302
+      RPL_ISON              = 303
+      RPL_AWAY              = 301
+      RPL_UNAWAY            = 305
+      RPL_NOWAWAY           = 306
+      RPL_WHOISUSER         = 311
+      RPL_WHOISSERVER       = 312
+      RPL_WHOISOPERATOR     = 313
+      RPL_WHOISIDLE         = 317
+      RPL_ENDOFWHOIS        = 318
+      RPL_WHOISCHANNELS     = 319
+      RPL_WHOWASUSER        = 314
+      RPL_ENDOFWHOWAS       = 369
+      RPL_LISTSTART         = 321
+      RPL_LIST              = 322
+      RPL_LISTEND           = 323
+      RPL_UNIQOPIS          = 325
+      RPL_CHANNELMODEIS     = 324
+      RPL_NOTOPIC           = 331
+      RPL_TOPIC             = 332
+      RPL_INVITING          = 341
+      RPL_SUMMONING         = 342
+      RPL_INVITELIST        = 346
+      RPL_ENDOFINVITELIST   = 347
+      RPL_EXCEPTLIST        = 348
+      RPL_ENDOFEXCEPTLIST   = 349
+      RPL_VERSION           = 351
+      RPL_WHOREPLY          = 352
+      RPL_ENDOFWHO          = 315
+      RPL_NAMREPLY          = 353
+      RPL_ENDOFNAMES        = 366
+      RPL_LINKS             = 364
+      RPL_ENDOFLINKS        = 365
+      RPL_BANLIST           = 367
+      RPL_ENDOFBANLIST      = 368
+      RPL_INFO              = 371
+      RPL_ENDOFINFO         = 374
+      RPL_MOTDSTART         = 375
+      RPL_MOTD              = 372
+      RPL_ENDOFMOTD         = 376
+      RPL_YOUREOPER         = 381
+      RPL_REHASHING         = 382
+      RPL_YOURESERVICE      = 383
+      RPL_TIME              = 391
+      RPL_USERSSTART        = 392
+      RPL_USERS             = 393
+      RPL_ENDOFUSERS        = 394
+      RPL_NOUSERS           = 395
+      ERR_NOSUCHNICK        = 401
+      ERR_NOSUCHSERVER      = 402
+      ERR_NOSUCHCHANNEL     = 403
+      ERR_CANNOTSENDTOCHAN  = 404
+      ERR_TOOMANYCHANNELS   = 405
+      ERR_WASNOSUCHNICK     = 406
+      ERR_TOOMANYTARGETS    = 407
+      ERR_NOSUCHSERVICE     = 408
+      ERR_NOORIGIN          = 409
+      ERR_NORECIPIENT       = 411
+      ERR_NOTEXTTOSEND      = 412
+      ERR_NOTOPLEVEL        = 413
+      ERR_WILDTOPLEVEL      = 414
+      ERR_BADMASK           = 415
+      ERR_UNKNOWNCOMMAND    = 421
+      ERR_NOMOTD            = 422
+      ERR_NOADMININFO       = 423
+      ERR_FILEERROR         = 424
+      ERR_NONICKNAMEGIVEN   = 431
+      ERR_ERRONEUSNICKNAME  = 432
+      ERR_NICKNAMEINUSE     = 433
+      ERR_NICKCOLLISION     = 436
+      ERR_UNAVAILRESOURCE   = 437
+      ERR_USERNOTINCHANNEL  = 441
+      ERR_NOTONCHANNEL      = 442
+      ERR_USERONCHANNEL     = 443
+      ERR_NOLOGIN           = 444
+      ERR_SUMMONDISABLED    = 445
+      ERR_USERSDISABLED     = 446
+      ERR_NOTREGISTERED     = 451
+      ERR_NEEDMOREPARAMS    = 461
+      ERR_ALREADYREGISTRED  = 462
+      ERR_NOPERMFORHOST     = 463
+      ERR_PASSWDMISMATCH    = 464
+      ERR_YOUREBANNEDCREEP  = 465
+      ERR_YOUWILLBEBANNED   = 466
+      ERR_KEYSET            = 467
+      ERR_CHANNELISFULL     = 471
+      ERR_UNKNOWNMODE       = 472
+      ERR_INVITEONLYCHAN    = 473
+      ERR_BANNEDFROMCHAN    = 474
+      ERR_BADCHANNELKEY     = 475
+      ERR_BADCHANMASK       = 476
+      ERR_NOCHANMODES       = 477
+      ERR_BANLISTFULL       = 478
+      ERR_NOPRIVILEGES      = 481
+      ERR_CHANOPRIVSNEEDED  = 482
+      ERR_CANTKILLSERVER    = 483
+      ERR_RESTRICTED        = 484
+      ERR_UNIQOPPRIVSNEEDED = 485
+      ERR_NOOPERHOST        = 491
+      ERR_UMODEUNKNOWNFLAG  = 501
+      ERR_USERSDONTMATCH    = 502
+    end
+    
+  end
+end

data/lib/marvin/logging_handler.rb

@@ -0,0 +1,76 @@
+module Marvin
+  # A generic class to make it easy to implement loggers
+  # in marvin. Users only need to implement 1 method for simple
+  # logging but have control to do more. Please note that
+  # if you want it correctly log the order of messages, it
+  # needs to be the first registered handler, otherwise
+  # outgoing messages will be processed before incoming ones.
+  class LoggingHandler < CommandHandler
+    
+    on_event :incoming_message do
+      if should_log?
+        log_incoming(@server, options.nick, options.target, options.message)
+        log_message(@server, options.nick, options.target, options.message)
+      end
+    end
+    
+    on_event :outgoing_message do
+      if should_log?
+        log_outgoing(@server, @nick, options.target, options.message)
+        log_message(@server, @nick, options.target, options.message)
+      end
+    end
+    
+    on_event :client_connected do
+      @server = self.client.host_with_port
+      @nick   = self.client.nickname
+      setup_logging
+    end
+
+    on_event :client_disconnected do
+      teardown_logging
+    end
+    
+    on_event :outgoing_nick do
+      @nick = options.new_nick
+    end
+    
+    # Called when the client connects, over ride it to
+    # do any of your specific setup.
+    def setup_logging
+      # NOP
+    end
+    
+    # Called when the client disconnects, over ride it to
+    # do any of your specific teardown.
+    def teardown_logging
+      # NOP
+    end
+    
+    # Called before logging a message for conditional logging.
+    # Override with your implementation specific version.
+    def should_log?
+      true
+    end
+    
+    # Log an incoming message (i.e. from another user)
+    # Note that +server+ is in the port host:port, 
+    # nick is the origin nick and target is either
+    # a channel or the bots nick (if PM'ed)
+    def log_incoming(server, nick, target, message)
+    end
+    
+    # Log an outgoing message (i.e. from this user)
+    # Note that +server+ is in the port host:port, 
+    # nick is the bots nick and target is either
+    # a channel or the user the bot is replying to.
+    def log_outgoing(server, nick, target, message)
+    end
+    
+    # Logs a message - used when you want to log
+    # both incoming and outgoing messages
+    def log_message(server, nick, target, message)
+    end
+    
+  end
+end