blur 2.1.3 → 2.1.6

data/library/blur/handling.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
   class Client
@@ -24,85 +24,98 @@ module Blur
     #   # RPL_WHOISUSER
     #   # <nick> <user> <host> * :<real name>
     #   def got_whois_user network, message
-    #     puts "nick: #{message.parameters[0]} user: #{message.parameters[1]} host: #{message.parameters[2]} …"
+    #     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, message
+      def got_end_of_motd network, _message
         emit :connection_ready, network
-        
+
         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, 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
 
           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.channels << channel
-            channel.users << user unless channel.users.include? user
-          end
 
-          emit :channel_who_reply, channel
+        return unless (channel = find_or_create_channel(name, network))
+
+        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, message
         _, channel_name, topic = message.parameters
-        
-        if channel = find_or_create_channel(channel_name, network)
-          emit :channel_topic, channel, topic
 
-          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, message
+        network.last_pong_time = Time.now
         network.transmit :PONG, message.parameters[0]
 
-        emit :network_ping, 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+ and +new_nick+
       def got_nick network, message
         old_nick = message.prefix.nick
-        
-        if user = network.users.delete(old_nick)
+
+        # Update or own nickname if has been changed by the server
+        if network.nickname == old_nick
           new_nick = message.parameters[0]
-          emit :user_rename, user, new_nick
-          user.nick = new_nick
-          network.users[new_nick] = user
+
+          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:
@@ -114,10 +127,11 @@ module Blur
       # @note Messages are contained as strings.
       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]
+        if (channel = network.channels[name])
+          unless (user = network.users[message.prefix.nick])
             user = User.new message.prefix.nick, network
           end
 
@@ -126,7 +140,7 @@ module Blur
 
           emit :message, user, channel, msg
         else # This is a private message
-          unless user = network.users[message.prefix.nick]
+          unless (user = network.users[message.prefix.nick])
             user = User.new message.prefix.nick, network
             user.name = message.prefix.user
             user.host = message.prefix.host
@@ -135,7 +149,7 @@ module Blur
           emit :private_message, user, msg
         end
       end
-      
+
       # Called when a user joined a channel.
       #
       # == Callbacks:
@@ -146,30 +160,29 @@ module Blur
         user = find_or_create_user message.prefix.nick, network
         user.name = message.prefix.user
         user.host = message.prefix.host
-        
-        if channel = find_or_create_channel(channel_name, network)
-          _user_join_channel user, channel
 
-          emit :user_entered, channel, user
-        end
+        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, message
         channel_name = message.parameters[0]
-        
-        if channel = network.channels[channel_name]
-          if user = network.users[message.prefix.nick]
-            _user_part_channel user, channel
-            
-            emit :user_left, channel, user
-          end
-        end
+
+        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:
@@ -177,17 +190,17 @@ module Blur
       def got_quit network, message
         nick = message.prefix.nick
         reason = message.parameters[2]
-        
-        if user = network.users[nick]
-          user.channels.each do |channel|
-            channel.users.delete user
-          end
 
-          emit :user_quit, user, reason
-          network.users.delete nick
+        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:
@@ -197,32 +210,30 @@ module Blur
       # +kicker+ is the user that kicked +kickee+.
       def got_kick network, message
         name, target, reason = message.parameters
-        
-        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
-          end
-        end
+
+        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, message
-        channel_name, topic = message.parameters
-        
-        if channel = network.channels[channel_name]
-          if user = network.users[message.prefix.nick]
-            emit :topic, user, channel, topic
-          end
-          
-          channel.topic = topic
+        _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.
@@ -233,56 +244,69 @@ module Blur
       # === When it's user modes:
       # Emits +:user_mode+ with the parameters +user+ and +modes+.
       def got_mode network, message
-        name, modes, limit, nick, mask = message.parameters
+        name, _modes, _limit, _nick, _mask = message.parameters
 
-        if channel = network.channels[name]
-          # FIXME
-        end
+        return unless (_channel = network.channels[name])
       end
 
       # Called when the network announces its ISUPPORT parameters.
       def got_005 network, message
         params = message.parameters[1..-2]
 
-        network.isupport.parse *params
+        network.isupport.parse(*params)
       end
 
       # Received when the server supports capability negotiation.
+      #
+      # CAP * LS :multi-prefix sasl
       def got_cap network, message
-        id, command = message.parameters[0..1]
+        _id, command = message.parameters[0..1]
 
         case command
+        when 'LS'
+          capabilities = message.parameters[2]&.split
+          req = []
+
+          req << 'sasl' if network.sasl? && capabilities.include?('sasl')
+          req << 'account-tag' if capabilities.include?('account-tag')
+
+          network.transmit :CAP, 'REQ', req.join(' ') if req.any?
+
+          capabilities.each { |name| network.capabilities.push name }
+
+          emit :network_capabilities, network, capabilities
+
         when 'ACK'
           capabilities = message.parameters[2]&.split
 
-          if capabilities&.include? 'sasl' and network.sasl?
-            network.transmit :AUTHENTICATE, 'PLAIN'
-          else
-            network.cap_end
-          end
+          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' and network.sasl?
+          if capabilities&.include?('sasl') && network.sasl?
             puts "The server does not support SASL, but you've configured it " \
-              "as such! Disconnecting!"
+              'as such! Disconnecting!'
 
             network.disconnect
           end
-
         end
       end
 
       def got_001 network, message
-        if network.waiting_for_cap
-          network.abort_cap_neg
-        end
+        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']}"
@@ -292,37 +316,41 @@ module Blur
 
       # :server 900 <nick> <nick>!<ident>@<host> <account> :You are now logged in as <user>
       # RPL_LOGGEDIN SASL
-      def got_900 network, message
-        if network.waiting_for_cap
-          network.cap_end
-        end
+      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
+        _nick, _message = message.parameters
 
-        puts "SASL authentication failed! Disconnecting!"
+        puts 'SASL authentication failed! Disconnecting!'
 
         network.disconnect
       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
+      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
+      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.
-        if user.channels.empty?
-          user.network.users.delete user.nick
-        end
+        return unless user.channels.empty?
+
+        user.network.users.delete user.nick
       end
 
       def _user_join_channel user, channel
@@ -331,7 +359,7 @@ module Blur
       end
 
       def find_or_create_user nick, network
-        unless user = network.users[nick]
+        unless (user = network.users[nick])
           user = User.new nick, network
           network.users[nick] = user
           emit :user_created, user
@@ -341,7 +369,7 @@ module Blur
       end
 
       def find_or_create_channel name, network
-        unless channel = network.channels[name]
+        unless (channel = network.channels[name])
           channel = Channel.new name, network
           network.channels[name] = channel
           emit :channel_created, channel
@@ -350,6 +378,5 @@ module Blur
         channel
       end
     end
-
   end
 end

data/library/blur/network/connection.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
   class Network
@@ -13,14 +13,23 @@ module Blur
     class Connection < EM::Protocols::LineAndTextProtocol
       SSLValidationError = Class.new StandardError
 
+      # @return [Float] the default connection timeout interval in seconds.
+      DEFAULT_CONNECT_TIMEOUT_INTERVAL = 30
+
       # Check whether or not connection is established.
-      def established?; @connected == true end
+      def established?
+        @connected == true
+      end
 
       # EventMachine instantiates this class, and then sends event messages to
       # that instance.
       def initialize network
         @network = network
         @connected = false
+        connect_timeout = network.options.fetch 'connect_timeout',
+                                                DEFAULT_CONNECT_TIMEOUT_INTERVAL
+
+        self.pending_connect_timeout = connect_timeout
 
         super
       end
@@ -28,11 +37,10 @@ module Blur
       # Called when a new connection is being set up, all we're going to use
       # it for is to enable SSL/TLS on our connection.
       def post_init
-        if @network.secure?
-          verify_peer = (@network.options[:ssl_no_verify] ? false : true)
+        return unless @network.secure?
 
-          start_tls verify_peer: verify_peer
-        end
+        verify_peer = (@network.options[:ssl_no_verify] ? false : true)
+        start_tls verify_peer: verify_peer
       end
 
       # Called when a line was received, the connection sends it to the network
@@ -61,12 +69,8 @@ module Blur
         ssl_cert_file    = @network.options[:ssl_cert_file]
         peer_certificate = OpenSSL::X509::Certificate.new peer_cert
 
-        if ssl_cert_file
-          unless File.readable? ssl_cert_file
-            raise SSLValidationError, "Could not read the CA certificate file."
-
-            return false
-          end
+        if ssl_cert_file && !File.readable?(ssl_cert_file)
+          raise SSLValidationError, 'Could not read the CA certificate file.'
         end
 
         if fingerprint_verification?
@@ -75,9 +79,7 @@ module Blur
 
           if fingerprint != peer_fingerprint
             raise SSLValidationError,
-              "Expected fingerprint '#{fingerprint}', but got '#{peer_fingerprint}'"
-
-            return false
+                  "Expected fingerprint '#{fingerprint}', but got '#{peer_fingerprint}'"
           end
         end
 
@@ -85,11 +87,7 @@ module Blur
           ca_certificate = OpenSSL::X509::Certificate.new File.read ssl_cert_file
           valid_signature = peer_certificate.verify ca_certificate.public_key
 
-          if not valid_signature
-            raise SSLValidationError, "Certificate verify failed"
-
-            return false
-          end
+          raise SSLValidationError, 'Certificate verify failed' unless valid_signature
         end
 
         true
@@ -98,9 +96,7 @@ module Blur
       # Called once the connection is finally established.
       def connection_completed
         # We aren't completely connected yet if the connection is encrypted.
-        unless @network.secure?
-          connected!
-        end
+        connected! unless @network.secure?
       end
 
       # Called just as the connection is being terminated, either by remote or
@@ -112,7 +108,8 @@ module Blur
         super
       end
 
-    private
+      private
+
       # Called when connection has been established.
       def connected!
         @connected = true
@@ -122,12 +119,12 @@ module Blur
 
       # Returns true if we're expected to verify the certificate fingerprint.
       def fingerprint_verification?
-        not @network.options[:ssl_fingerprint].nil?
+        !@network.options[:ssl_fingerprint].nil?
       end
 
       # Returns true if we should verify the peer certificate.
       def certificate_verification?
-        not @network.options[:ssl_cert_file].nil?
+        !@network.options[:ssl_cert_file].nil?
       end
 
       # Get the hexadecimal representation of the certificates public key.
@@ -143,9 +140,8 @@ module Blur
         fingerprint = @network.options[:ssl_fingerprint]
 
         raise SSLValidationError,
-          "Expected fingerprint '#{fingerprint}' but got '#{peer_fingerprint}'"
+              "Expected fingerprint '#{fingerprint}' but got '#{peer_fingerprint}'"
       end
-
     end
   end
 end