blur 1.8.6 → 2.1

data/library/blur/enhancements.rb

@@ -11,9 +11,7 @@ class Exception
   #
   # @return Fixnum the line of the script the exception was raised on.
   def line
-    if result = backtrace[0].match(Pattern)
-      result[1].to_i + 1
-    end
+    backtrace[0].match(Pattern)[1].to_i + 1
   end
 end
 

data/library/blur/handling.rb

@@ -4,18 +4,18 @@ module Blur
   class Client
     # The +Handling+ module is the very core of the IRC-part in Blur.
     #
-    # When the client receives a parsed command instance, it immediately starts
-    # looking for a got_(the command name) method inside the client, which
+    # When the client receives a parsed message instance, it immediately starts
+    # looking for a got_(the message name) method inside the client, which
     # is implemented in this module.
     #
     # == Implementing a handler
     # Implementing a handler is very, very easy.
     #
-    # All you need to do is define a method named got_(command you want to
-    # implement) that accepts 2 parameters, +network+ and +command+.
+    # All you need to do is define a method named got_(message you want to
+    # implement) that accepts 2 parameters, +network+ and +message+.
     #
-    # You can then do whatever you need to do with the command instance,
-    # you can access the parameters of it through {Network::Command#[]}.
+    # You can then do whatever you need to do with the message instance,
+    # you can access the parameters of it through {Network::message#[]}.
     #
     # Don't forget that this module is inside the clients scope, so you can
     # access all instance-variables and methods.
@@ -23,8 +23,8 @@ module Blur
     # @example
     #   # RPL_WHOISUSER
     #   # <nick> <user> <host> * :<real name>
-    #   def got_whois_user network, command
-    #     puts "nick: #{command[0]} user: #{command[1]} host: #{command[2]} …"
+    #   def got_whois_user network, message
+    #     puts "nick: #{message.parameters[0]} user: #{message.parameters[1]} host: #{message.parameters[2]} …"
     #   end
     #   
     # @see http://www.irchelp.org/irchelp/rfc/chapter6.html
@@ -36,32 +36,31 @@ module Blur
       # Emits +:connection_ready+ with the parameter +network+.
       #
       # Automatically joins the channels specified in +:channels+.
-      def got_end_of_motd network, command
+      def got_end_of_motd network, message
         emit :connection_ready, network
         
-        network.options[:channels].each do |channel|
-          network.transmit :JOIN, channel
+        network.options['channels'].each do |channel|
+          network.join channel
         end
       end
       
       # Called when the namelist of a channel was received.
-      def got_name_reply network, command
-        name  = command[2]
-        users = command[3].split.map do |nick|
+      def got_name_reply network, message
+        name  = message.parameters[2] # Channel name.
+        nicks = message.parameters[3].split.map do |nick|
           # Slice the nick if the first character is a user mode prefix.
           if network.user_prefixes.include? nick.chr
             nick.slice! 0
           end
 
-          Network::User.new nick
+          nick
         end
         
         if channel = find_or_create_channel(name, network)
+          users = nicks.map{|nick| find_or_create_user nick, network }
           users.each do |user|
-            user.channel = channel
-            user.network = network
-
-            channel.users << user
+            user.channels << channel
+            channel.users << user unless channel.users.include? user
           end
 
           emit :channel_who_reply, channel
@@ -72,35 +71,35 @@ module Blur
       #
       # == Callbacks:
       # Emits :topic_change with the parameters +channel+ and +topic+.
-      def got_channel_topic network, command
-        me, name, topic = command.params
+      def got_channel_topic network, message
+        _, channel_name, topic = message.parameters
         
-        if channel = find_or_create_channel(name, network)
-          emit :topic_change, channel, topic
+        if channel = find_or_create_channel(channel_name, network)
+          emit :channel_topic, channel, topic
 
           channel.topic = topic
         end
       end
       
       # Called when the server needs to verify that we're alive.
-      def got_ping network, command
-        network.transmit :PONG, command[0]
+      def got_ping network, message
+        network.transmit :PONG, message.parameters[0]
+
+        emit :network_ping, message.parameters[0]
       end
       
       # Called when a user changed nickname.
       #
       # == Callbacks:
-      # Emits :user_rename with the parameters +channel+, +user+, +old_nick and +new_nick+ 
-      def got_nick network, command
-        nick = command.sender.nickname
+      # Emits :user_rename with the parameters +channel+, +user+ and +new_nick+
+      def got_nick network, message
+        old_nick = message.prefix.nick
         
-        if channels = network.channels_with_user(nick)
-          channels.each do |channel|
-            if user = channel.user_by_nick(nick)
-              emit :user_rename, channel, user, user.nick, command[0]
-              user.nick = command[0]
-            end
-          end
+        if user = network.users.delete(old_nick)
+          new_nick = message.parameters[0]
+          emit :user_rename, user, new_nick
+          user.nick = new_nick
+          network.users[new_nick] = user
         end
       end
       
@@ -113,38 +112,27 @@ module Blur
       # Emits +:private_message+ with the parameters +user+ and +message+.
       #
       # @note Messages are contained as strings.
-      def got_privmsg network, command
-        return if command.sender.is_a? String # Ignore all server privmsgs
-        name, message = command.params
-        
-        if channel = network.channel_by_name(name)
-          if user = channel.user_by_nick(command.sender.nickname)
-            user.name = command.sender.username
-            user.host = command.sender.hostname
-
-            begin
-              if message[0..3] == "+OK " and channel.encrypted?
-                message = channel.encryption.decrypt message[4..-1]
-              end
-            rescue Encryption::BadInputError
-              puts "-!- FiSH: #{$!.message}"
-            rescue => exception
-              puts "-!- There was a problem with the FiSH encryption, disabling"
+      def got_privmsg network, message
+        return unless message.prefix.nick # Ignore all server privmsgs
+        name, msg = message.parameters
 
-              channel.encryption = nil
-            end
-            
-            emit :message, user, channel, message
-          else
-            # Odd… this shouldn't happen
+        if channel = network.channels[name]
+          unless user = network.users[message.prefix.nick]
+            user = User.new message.prefix.nick, network
           end
+
+          user.name = message.prefix.user
+          user.host = message.prefix.host
+
+          emit :message, user, channel, msg
         else # This is a private message
-          user = Network::User.new command.sender.nickname
-          user.name = command.sender.username
-          user.host = command.sender.hostname
-          user.network = network
+          unless user = network.users[message.prefix.nick]
+            user = User.new message.prefix.nick, network
+            user.name = message.prefix.user
+            user.host = message.prefix.host
+          end
 
-          emit :private_message, user, message
+          emit :private_message, user, msg
         end
       end
       
@@ -152,18 +140,16 @@ module Blur
       #
       # == Callbacks:
       # Emits +:user_entered+ with the parameters +channel+ and +user+.
-      def got_join network, command
-        name = command[0]
-        user = Network::User.new command.sender.nickname
+      def got_join network, message
+        channel_name = message.parameters[0]
+
+        user = find_or_create_user message.prefix.nick, network
+        user.name = message.prefix.user
+        user.host = message.prefix.host
         
-        if channel = network.channel_by_name(name)
-          user.name = command.sender.username
-          user.host = command.sender.hostname
-          user.channel = channel
-          user.network = network
-          
-          channel.users << user
-          
+        if channel = find_or_create_channel(channel_name, network)
+          _user_join_channel user, channel
+
           emit :user_entered, channel, user
         end
       end
@@ -172,12 +158,12 @@ module Blur
       #
       # == Callbacks:
       # Emits +:user_left+ with the parameters +channel+ and +user+.
-      def got_part network, command
-        name = command[0]
+      def got_part network, message
+        channel_name = message.parameters[0]
         
-        if channel = network.channel_by_name(name)
-          if user = channel.user_by_nick(command.sender.nickname)
-            channel.users.delete user
+        if channel = network.channels[channel_name]
+          if user = network.users[message.prefix.nick]
+            _user_part_channel user, channel
             
             emit :user_left, channel, user
           end
@@ -188,17 +174,17 @@ module Blur
       #
       # == Callbacks:
       # Emits +:user_quit+ with the parameters +channel+ and +user+.
-      def got_quit network, command
-        nick = command.sender.nickname
+      def got_quit network, message
+        nick = message.prefix.nick
+        reason = message.parameters[2]
         
-        if channels = network.channels_with_user(nick)
-          channels.each do |channel|
-            if user = channel.user_by_nick(nick)
-              channel.users.delete user 
-            
-              emit :user_quit, channel, user
-            end
+        if user = network.users[nick]
+          user.channels.each do |channel|
+            channel.users.delete user
           end
+
+          emit :user_quit, user, reason
+          network.users.delete nick
         end
       end
       
@@ -209,13 +195,13 @@ module Blur
       # and +reason+.
       #
       # +kicker+ is the user that kicked +kickee+.
-      def got_kick network, command
-        name, target, reason = command.params
+      def got_kick network, message
+        name, target, reason = message.parameters
         
-        if channel = network.channel_by_name(name)
-          if kicker = channel.user_by_nick(command.sender.nickname)
-            if kickee = channel.user_by_nick(target)
-              channel.users.delete kickee
+        if channel = network.channels[name]
+          if kicker = network.users[message.prefix.nick]
+            if kickee = network.users[target]
+              _user_part_channel kickee, channel
               
               emit :user_kicked, kicker, channel, kickee, reason
             end
@@ -227,11 +213,11 @@ module Blur
       #
       # == Callbacks:
       # Emits :topic with the parameters +user+, +channel+ and +topic+.
-      def got_topic network, command
-        name, topic = command.params
+      def got_topic network, message
+        channel_name, topic = message.parameters
         
-        if channel = network.channel_by_name(name)          
-          if user = channel.user_by_nick(command.sender.nickname)
+        if channel = network.channels[channel_name]
+          if user = network.users[message.prefix.nick]
             emit :topic, user, channel, topic
           end
           
@@ -246,29 +232,17 @@ module Blur
       # Emits +:channel_mode+ with the parameters +channel+ and +modes+.
       # === When it's user modes:
       # Emits +:user_mode+ with the parameters +user+ and +modes+.
-      def got_mode network, command
-        name, modes, limit, nick, mask = command.params
+      def got_mode network, message
+        name, modes, limit, nick, mask = message.parameters
 
-        if channel = network.channel_by_name(name)
-          if limit
-            unless limit.numeric?
-              nick = limit
-            end
-
-            if user = channel.user_by_nick(nick)
-              user.merge_modes modes
-              emit :user_mode, user, modes
-            end
-          else
-            channel.merge_modes modes
-            emit :channel_mode, channel, modes
-          end
+        if channel = network.channels[name]
+          # FIXME
         end
       end
 
       # Called when the network announces its ISUPPORT parameters.
-      def got_005 network, command
-        params = command.params[1..-2]
+      def got_005 network, message
+        params = message.parameters[1..-2]
 
         network.isupport.parse *params
       end
@@ -280,23 +254,41 @@ module Blur
 
     private
 
-      def find_or_create_channel name, network, users = []
-        channel = network.channel_by_name name
+      def _user_part_channel user, channel
+        user.channels.delete channel
+        channel.users.delete user
 
-        if channel.nil?
-          channel = Network::Channel.new name, network, users
-          network.channels << channel
+        # Forget the user if we no longer share any channels.
+        if user.channels.empty?
+          user.network.users.delete user.nick
+        end
+      end
 
-          if network.fish? and network.options[:fish].key? name
-            keyphrase = network.options[:fish][name]
-            channel.encryption = Encryption::FiSH.new keyphrase
-          end
+      def _user_join_channel user, channel
+        channel.users << user
+        user.channels << channel
+      end
+
+      def find_or_create_user nick, network
+        unless user = network.users[nick]
+          user = User.new nick, network
+          network.users[nick] = user
+          emit :user_created, user
+        end
+
+        user
+      end
 
+      def find_or_create_channel name, network
+        unless channel = network.channels[name]
+          channel = Channel.new name, network
+          network.channels[name] = channel
           emit :channel_created, channel
         end
 
         channel
       end
     end
+
   end
 end

data/library/blur/logging.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+# Temporary replacement for majic's color method.
+class String
+  def ^ c
+    self
+  end
+end
+
+module Blur
+  # Very crude logging module.
+  module Logging
+    Levels = [:debug, :info, :warn, :error, :fatal]
+
+    class Logger
+      Levels.each do |level|
+        define_method level do |*messages|
+          Logging.mutex.synchronize do
+            messages.each{|m| puts "%-8s %s" % [level.to_s.upcase, m] }
+          end
+        end
+      end
+    end
+
+    @mutex = Mutex.new
+    @logger = Logger.new
+
+    class << self
+      attr_reader :mutex
+      attr_reader :logger
+    end
+
+    def log *messages
+      if messages.empty?
+        Logging.logger
+      else
+        Logging.logger.debug *messages
+      end
+    end
+  end
+end

data/library/blur/network.rb

@@ -13,12 +13,13 @@ module Blur
 
     # @return [Hash] the network options.
     attr_accessor :options
-    # @return [Array] the list of channels the client is in.
+
+    # @return [Hash] the map of users that is known.
+    attr_accessor :users
+    # @return [Hash] the map of channels the client is in.
     attr_accessor :channels
-    # @return [Array] the list of private messages the client remembers.
-    attr_accessor :dialogues
-    # @return [Client] the client delegate.
-    attr_accessor :delegate
+    # @return [Client] the client reference.
+    attr_accessor :client
     # @return [Network::Connection] the connection instance.
     attr_accessor :connection
     # @return [Network::ISupport] the network isupport specs.
@@ -30,20 +31,17 @@ module Blur
     # Get the remote hostname.
     #
     # @return [String] the remote hostname.
-    def host; @options[:hostname] end
+    def host; @options['hostname'] end
 
     # Get the remote port.
     # If no port is specified, it returns 6697 if using a secure connection,
     # returns 6667 otherwise.
     #
     # @return [Fixnum] the remote port
-    def port; @options[:port] ||= secure? ? 6697 : 6667 end
+    def port; @options['port'] ||= secure? ? 6697 : 6667 end
     
     # Check to see if it's a secure connection.
-    def secure?; @options[:secure] == true end
-
-    # Check to see if FiSH encryption is enabled.
-    def fish?; not @options[:fish].nil? end
+    def secure?; @options['secure'] == true end
 
     # Instantiates the network.
     #
@@ -68,18 +66,24 @@ module Blur
     #   remote certificate matches the specified fingerprint.
     # @option options [optional, Boolean] :ssl_no_verify Disable verification
     #   alltogether.
-    def initialize options
-      @options  = options
-      @channels = []
+    def initialize options, client = nil
+      @client = client
+      @options = options
+      @users = {}
+      @channels = {}
       @isupport = ISupport.new self
       
-      unless options[:nickname]
-        raise ArgumentError, "nickname is missing from the networks option block"
+      unless options['nickname']
+        if options['hostname']
+          raise ArgumentError, "Network configuration for `#{options['hostname']}' is missing a nickname"
+        else
+          raise ArgumentError, "Network configuration is missing a nickname"
+        end
       end
       
-      @options[:username] ||= @options[:nickname]
-      @options[:realname] ||= @options[:username]
-      @options[:channels] ||= []
+      @options['username'] ||= @options['nickname']
+      @options['realname'] ||= @options['username']
+      @options['channels'] ||= []
     end
     
     # Send a message to a recipient.
@@ -87,16 +91,17 @@ module Blur
     # @param [String, #to_s] recipient the recipient.
     # @param [String] message the message.
     def say recipient, message
-      if recipient.is_a? Channel and recipient.encrypted?
-        message = "+OK #{recipient.encryption.encrypt message}"
-      end
-
       transmit :PRIVMSG, recipient.to_s, message
     end
     
     # Called when the network connection has enough data to form a command.
-    def got_command command
-      @delegate.got_command self, command
+    def got_message message
+      @client.got_message self, message
+    rescue => e
+      puts "#{e.class}: #{e.message}"
+      puts
+      puts "---"
+      puts e.backtrace
     end
     
     # Find a channel by its name.
@@ -104,7 +109,7 @@ module Blur
     # @param [String] name the channel name.
     # @return [Network::Channel] the matching channel, or nil.
     def channel_by_name name
-      @channels.find { |channel| channel.name == name }
+      @channels.find {|channel| channel.name == name }
     end
     
     # Find all instances of channels in which there is a user with the nick
@@ -113,7 +118,7 @@ module Blur
     # @param [String] nick the nickname.
     # @return [Array] a list of channels in which the user is located, or nil.
     def channels_with_user nick
-      @channels.select { |channel| channel.user_by_nick nick }
+      @channels.select {|channel| channel.user_by_nick nick }
     end
 
     # Returns a list of user prefixes that a nick might contain.
@@ -146,17 +151,18 @@ module Blur
 
     # Called when the connection was successfully established.
     def connected!
-      transmit :PASS, @options[:password] if @options[:password]
-      transmit :NICK, @options[:nickname]
-      transmit :USER, @options[:username], :void, :void, @options[:realname]
+      transmit :PASS, @options['password'] if @options['password']
+      transmit :NICK, @options['nickname']
+      transmit :USER, @options['username'], 'void', 'void', @options['realname']
     end
 
     # Called when the connection was closed.
     def disconnected!
-      @channels.each { |channel| channel.users.clear }
+      @channels.each {|name, channel| channel.users.clear }
       @channels.clear
+      @users.clear
 
-      @delegate.network_connection_closed self
+      @client.network_connection_closed self
     end
     
     # Terminate the connection and clear all channels and users.
@@ -169,13 +175,25 @@ module Blur
     # @param [Symbol, String] name the command name.
     # @param [...] arguments all the prepended parameters.
     def transmit name, *arguments
-      command = Command.new name, arguments
-      log "#{'→' ^ :red} #{command.name.to_s.ljust(8, ' ') ^ :light_gray} #{command.params.map(&:inspect).join ' '}"
+      message = IRCParser::Message.new command: name.to_s, parameters: arguments
+
+      if @client.verbose
+        log "#{'→' ^ :red} #{message.command.to_s.ljust(8, ' ') ^ :light_gray} #{message.parameters.map(&:inspect).join ' '}"
+      end
       
-      @connection.send_data "#{command}\r\n"
+      @connection.send_data "#{message}\r\n"
+    end
+
+    # Send a private message.
+    def send_privmsg recipient, message
+      transmit :PRIVMSG, recipient, message
+    end
+
+    # Join a channel.
+    def join channel
+      transmit :JOIN, channel
     end
 
-    
     # Convert it to a debug-friendly format.
     def to_s
       %{#<#{self.class.name} "#{host}":#{port}>}