blur 1.8.6 → 2.1.6

data/library/blur/handling.rb

@@ -1,21 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 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,87 +23,99 @@ 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
     module Handling
-    
       # Called when the MOTD was received, which also means it is ready.
       #
       # == Callbacks:
       # 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
+          nick.slice! 0 if network.user_prefixes.include? nick.chr
 
-          Network::User.new nick
+          nick
         end
-        
-        if channel = find_or_create_channel(name, network)
-          users.each do |user|
-            user.channel = channel
-            user.network = network
 
-            channel.users << user
-          end
+        return unless (channel = find_or_create_channel(name, network))
 
-          emit :channel_who_reply, channel
+        users = nicks.map { |nick| find_or_create_user nick, network }
+        users.each do |user|
+          user.channels << channel
+          channel.users << user unless channel.users.include? user
         end
+
+        emit :channel_who_reply, channel
       end
-      
+
       # Called when a channel topic was changed.
       #
       # == Callbacks:
       # Emits :topic_change with the parameters +channel+ and +topic+.
-      def got_channel_topic network, command
-        me, name, topic = command.params
-        
-        if channel = find_or_create_channel(name, network)
-          emit :topic_change, channel, topic
+      def got_channel_topic network, message
+        _, channel_name, topic = message.parameters
 
-          channel.topic = topic
-        end
+        return unless (channel = find_or_create_channel(channel_name, network))
+
+        emit :channel_topic, channel, topic
+
+        channel.topic = topic
       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.last_pong_time = Time.now
+        network.transmit :PONG, message.parameters[0]
+
+        emit :network_ping, network, message.parameters[0]
       end
-      
+
+      # Called when the server reponds to our periodic PINGs.
+      def got_pong network, message
+        network.last_pong_time = Time.now
+
+        emit :network_pong, network, 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
-        
-        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
+      # Emits :user_rename with the parameters +channel+, +user+ and +new_nick+
+      def got_nick network, message
+        old_nick = message.prefix.nick
+
+        # Update or own nickname if has been changed by the server
+        if network.nickname == old_nick
+          new_nick = message.parameters[0]
+
+          emit :nick, new_nick
+          network.nickname = new_nick
         end
+
+        return unless (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
-      
+
       # Called when a message was received (both channel and private messages).
       #
       # == Callbacks:
@@ -113,95 +125,82 @@ 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"
-
-              channel.encryption = nil
-            end
-            
-            emit :message, user, channel, message
-          else
-            # Odd… this shouldn't happen
+      def got_privmsg network, message
+        return unless message.prefix.nick # Ignore all server privmsgs
+
+        name, msg = message.parameters
+
+        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
-      
+
       # Called when a user joined a channel.
       #
       # == 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
-        
-        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
-          
-          emit :user_entered, channel, user
-        end
+      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
+
+        return unless (channel = find_or_create_channel(channel_name, network))
+
+        _user_join_channel user, channel
+
+        emit :user_entered, channel, user
       end
-      
+
       # Called when a user left a channel.
       #
       # == Callbacks:
       # Emits +:user_left+ with the parameters +channel+ and +user+.
-      def got_part network, command
-        name = command[0]
-        
-        if channel = network.channel_by_name(name)
-          if user = channel.user_by_nick(command.sender.nickname)
-            channel.users.delete user
-            
-            emit :user_left, channel, user
-          end
-        end
+      def got_part network, message
+        channel_name = message.parameters[0]
+
+        return unless (channel = network.channels[channel_name])
+        return unless (user = network.users[message.prefix.nick])
+
+        _user_part_channel user, channel
+
+        emit :user_left, channel, user
       end
-      
+
       # Called when a user disconnected from a network.
       #
       # == Callbacks:
       # Emits +:user_quit+ with the parameters +channel+ and +user+.
-      def got_quit network, command
-        nick = command.sender.nickname
-        
-        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
-          end
+      def got_quit network, message
+        nick = message.prefix.nick
+        reason = message.parameters[2]
+
+        return unless (user = network.users[nick])
+
+        user.channels.each do |channel|
+          channel.users.delete user
         end
+
+        emit :user_quit, user, reason
+        network.users.delete nick
       end
-      
+
       # Called when a user was kicked from a channel.
       #
       # == Callbacks:
@@ -209,34 +208,32 @@ module Blur
       # and +reason+.
       #
       # +kicker+ is the user that kicked +kickee+.
-      def got_kick network, command
-        name, target, reason = command.params
-        
-        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
-              
-              emit :user_kicked, kicker, channel, kickee, reason
-            end
-          end
-        end
+      def got_kick network, message
+        name, target, reason = message.parameters
+
+        return unless (channel = network.channels[name])
+        return unless (kicker = network.users[message.prefix.nick])
+        return unless (kickee = network.users[target])
+
+        _user_part_channel kickee, channel
+
+        emit :user_kicked, kicker, channel, kickee, reason
       end
-      
+
       # Called when a topic was changed for a channel.
       #
       # == Callbacks:
       # Emits :topic with the parameters +user+, +channel+ and +topic+.
-      def got_topic network, command
-        name, topic = command.params
-        
-        if channel = network.channel_by_name(name)          
-          if user = channel.user_by_nick(command.sender.nickname)
-            emit :topic, user, channel, topic
-          end
-          
-          channel.topic = topic
+      def got_topic network, message
+        _channel_name, topic = message.parameters
+
+        return unless (channel = network.channels[channel.name])
+
+        if (user = network.users[message.prefix.nick])
+          emit :topic, user, channel, topic
         end
+
+        channel.topic = topic
       end
 
       # Called when a channel or a users flags was altered.
@@ -246,52 +243,135 @@ 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
-
-        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
-        end
+      def got_mode network, message
+        name, _modes, _limit, _nick, _mask = message.parameters
+
+        return unless (_channel = network.channels[name])
       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
+        network.isupport.parse(*params)
       end
 
-      alias_method :got_353, :got_name_reply
-      alias_method :got_422, :got_end_of_motd
-      alias_method :got_376, :got_end_of_motd
-      alias_method :got_332, :got_channel_topic
+      # Received when the server supports capability negotiation.
+      #
+      # CAP * LS :multi-prefix sasl
+      def got_cap network, message
+        _id, command = message.parameters[0..1]
+
+        case command
+        when 'LS'
+          capabilities = message.parameters[2]&.split
+          req = []
 
-    private
+          req << 'sasl' if network.sasl? && capabilities.include?('sasl')
+          req << 'account-tag' if capabilities.include?('account-tag')
 
-      def find_or_create_channel name, network, users = []
-        channel = network.channel_by_name name
+          network.transmit :CAP, 'REQ', req.join(' ') if req.any?
 
-        if channel.nil?
-          channel = Network::Channel.new name, network, users
-          network.channels << channel
+          capabilities.each { |name| network.capabilities.push name }
 
-          if network.fish? and network.options[:fish].key? name
-            keyphrase = network.options[:fish][name]
-            channel.encryption = Encryption::FiSH.new keyphrase
+          emit :network_capabilities, network, capabilities
+
+        when 'ACK'
+          capabilities = message.parameters[2]&.split
+
+          network.transmit :AUTHENTICATE, 'PLAIN' if capabilities&.include?('sasl') && network.sasl?
+
+          network.cap_end if network.waiting_for_cap
+        when 'NAK'
+          capabilities = message.parameters[2]&.split
+
+          if capabilities&.include?('sasl') && network.sasl?
+            puts "The server does not support SASL, but you've configured it " \
+              'as such! Disconnecting!'
+
+            network.disconnect
           end
+        end
+      end
+
+      def got_001 network, message
+        network.abort_cap_neg if network.waiting_for_cap
+
+        # Get our nickname from the server
+        nickname = message.parameters[0]
+        network.nickname = nickname
+      end
+
+      def got_authenticate network, message
+        case message.parameters[0]
+        when '+'
+          return unless network.sasl?
+
+          sasl = network.options['sasl']
+
+          response = "#{sasl['username']}\x00#{sasl['username']}\x00#{sasl['password']}"
+          network.transmit :AUTHENTICATE, Base64.encode64(response).strip
+        end
+      end
+
+      # :server 900 <nick> <nick>!<ident>@<host> <account> :You are now logged in as <user>
+      # RPL_LOGGEDIN SASL
+      def got_900 network, _message
+        network.cap_end if network.waiting_for_cap
+      end
+
+      # :server 904 <nick> :SASL authentication failed
+      # ERR_SASLFAIL
+      def got_904 network, message
+        _nick, _message = message.parameters
+
+        puts 'SASL authentication failed! Disconnecting!'
+
+        network.disconnect
+      end
+
+      def got_nickname_in_use network, message
+        nickname = network.options['nickname']
+        network.transmit :NICK, "#{nickname}_"
+      end
+
+      alias got_353 got_name_reply
+      alias got_422 got_end_of_motd
+      alias got_376 got_end_of_motd
+      alias got_332 got_channel_topic
+      alias got_433 got_nickname_in_use
+
+      private
+
+      def _user_part_channel user, channel
+        user.channels.delete channel
+        channel.users.delete user
+
+        # Forget the user if we no longer share any channels.
+        return unless user.channels.empty?
+
+        user.network.users.delete user.nick
+      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