Auto 4.0.0.alpha.1-x86-mingw32

data/lib/auto/irc/object/message.rb

@@ -0,0 +1,99 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+# Namespace: IRC
+module IRC
+  
+  # Namespace: Object
+  module Object
+    
+    # A class which represents an IRC message, its associated properties, and
+    # offers methods for working with the message.
+    #
+    # @since 4.0.0
+    # @author noxgirl
+    # @api IRC
+    #
+    # @!attribute [r] irc
+    #   @return [IRC::Server] The server on which the message was received.
+    #
+    # @!attribute [r] sender
+    #   @return [IRC::Object::User] The user from whom the message was received.
+    #
+    # @!attribute [r] body
+    #   @return [Array<String>] The body of the message, divided into elements by its spaces.
+    #
+    # @!attribute [r] nature
+    #   @return [Symbol] The nature of the message, +:notice+ or +:msg+.
+    #
+    # @!attribute [r] channel
+    #   @return [nil] If this message was received privately and not through a channel, this is nil.
+    #   @return [IRC::Object::Channel] If it was received through a channel, the channel in question.
+    #   @see #in_channel?
+    class Message
+
+      attr_reader :irc, :sender, :body, :nature, :channel
+
+      # Process a new message.
+      #
+      # @param [IRC::Server] irc The server on which the message was received.
+      # @param [IRC::Object::User] sender The user from whom the message was received.
+      # @param [String] body The body of the message.
+      # @param [Symbol] nature The nature of the message: either a +:notice+ or a +:msg+.
+      # @param [IRC::Object::Channel] channel If it was received through a channel, the channel.
+      #
+      # @example
+      #   message = IRC::Object::Message.new(irc, user, body, :msg, channel)
+      def initialize(irc, sender, body, nature=:notice, channel=nil)
+
+        @irc     = irc
+        @sender  = sender
+        @body    = body
+        @nature  = nature
+        @channel = channel
+
+      end
+
+      # Reply to this message.
+      #
+      # @param [String] msg The message with which to reply.
+      # @param [true, false] in_channel If the response should be in-channel (assuming it was received in a channel), specify +true+.
+      #   If it should be private regardless of where it was received, specify +false+.
+      #
+      # @note Essentially reply() exists to simplify the API. 
+      #   Rather than necessitating that commands use endless, illegible conditional
+      #   nests to determine what to do, reply() is available so the API will just
+      #   use some common sense to do it for them.
+      #
+      # @example
+      #   msg.reply("The bar is of foo, indeed.", true)
+      #
+      # @todo Unfinished.
+      def reply(msg, in_channel)
+        
+        case [@channel.nil, in_channel, @nature]
+        
+        # Respond in-channel if this was sent to a channel *and* in_channel
+        # is specified as true.
+        when false, true, :msg
+          irc.msg(@channel, msg)
+
+        # Likewise for channel notices. 
+        when false, true, :notice
+          
+        end
+
+      end
+
+      # Checks whether the message was received through a channel.
+      #
+      # @return [true, false]
+      def in_channel?; @channel.nil?; end
+
+    end # class Message
+
+  end # module Object
+
+end # module IRC
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/irc/object/user.rb

@@ -0,0 +1,139 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+module Auto
+
+  # Namespace: IRC
+  module IRC
+
+    # Namespace: Object
+    module Object
+
+      # A class which represents an individual user on IRC, and which provides
+      # useful data regarding said user, and methods using which to interact
+      # with the user.
+      #
+      # @api IRC
+      # @since 4.0.0
+      # @author noxgirl
+      #
+      # @!attribute irc
+      #   @return [Auto::IRC::Server] The server on which the user is located.
+      #
+      # @!attribute nick
+      #   @return [String] The user's nickname.
+      #
+      # @!attribute user
+      #   @return [String] If known, the user's username or ident.
+      #   @return [nil] If unknown.
+      #   @see #user_known?
+      #
+      # @!attribute host
+      #   @return [String] If known, the user's hostname or mask.
+      #   @return [nil] If unknown.
+      #   @see #host_known?
+      #
+      # @!attribute account
+      #   @return [String] If the user is logged in, their account name.
+      #   @see #logged_in?
+      #
+      # @!attribute away
+      #   @return [true] If the user is away.
+      #   @return [false] If the user is present.
+      class User < Entity
+
+        attr_reader :nick, :user, :host, :account, :away
+
+        # Process a new user.
+        #
+        # @param [Auto::IRC::Server] irc The server the user is on.
+        # @param [String] nickname The user's nickname.
+        # @param [String] username The user's username or ident.
+        # @param [String] hostname The user's hostname or mask.
+        # @param [true, false] away Whether the user is away: +true+ or +false+.
+        #
+        # @example
+        #   user = Auto::IRC::Object::User.new(irc, 'missfoo', 'cowmilk', 'the.night.is.lovely', false)
+        def initialize(irc, nickname, username=nil, hostname=nil, away=false)
+
+          super(irc, :user, nickname) # Entity#initialize
+          @nick    = nickname
+          @user    = username
+          @host    = hostname
+          @away    = away
+          @account = nil
+
+        end
+
+        # If the user logs into an account, this is used to specify the name of
+        # the account with which ze has identified.
+        #
+        # @param [String] accountname The name of the account.
+        #
+        # @example
+        #   user.login('root')
+        def login(accountname)
+          unless accountname.nil?
+            @account = accountname
+          end
+        end
+
+        # If the user logs out of hir account, this is used to update their
+        # logged-in status.
+        def logout
+          @account = nil
+        end
+
+        # Update the user's known away status.
+        #
+        # @param [true, false] new The user's new away status, which should be +true+ or +false+.
+        def away=(new)
+          if new == true or new == false
+            @away = new
+          end
+        end
+      
+        # Update the user's known hostname or mask.
+        #
+        # @param [String] new The user's new hostname.
+        def host=(new); @host = new unless new.nil?; end
+
+        # Update the user's known nickname.
+        #
+        # @param [String] new The user's new nickname.
+        def nick=(new); @nick = new unless new.nil?; end
+      
+        # Update the user's known username or ident.
+        #
+        # @param [String] new The user's new username.
+        def user=(new); @user = new unless new.nil?; end
+
+        # This will check whether the user's username is known.
+        #
+        # @return [true] If known.
+        # @return [false] If Unknown.
+        def user_known?; @user.nil? ? false : true; end
+      
+        # This will check whether the user's hostname is known.
+        #
+        # @return [true] If known.
+        # @return [false] If Unknown.
+        def host_known?; @host.nil? ? false : true; end
+      
+        # This will check whether the user is logged in.
+        #
+        # @return [true] If known.
+        # @return [false] If Unknown.
+        def logged_in?; @account.nil? ? false : true; end
+
+        def inspect; "#<Auto::IRC::Object::User: irc=#@irc nick=#@nick account=#@account>"; end
+
+      end # class User
+
+    end # module Object
+
+  end # module IRC
+
+end # module Auto
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/irc/protocol.rb

@@ -0,0 +1,164 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+require 'auto/irc/protocol/numerics'
+
+# namespace Auto
+module Auto
+
+  # namespace IRC
+  module IRC
+    autoload :SASL, 'auto/irc/sasl/mech'
+
+    # A class for parsing of data per the specifications of the IRC protocol,
+    # v3.1.
+    #
+    # @see http://tools.ietf.org/html/rfc1459
+    # @see http://ircv3.atheme.org/
+    #
+    # @since 4.0.0
+    class Protocol
+
+      # Construct a new IRC data parser.
+      #
+      # @param [Auto::IRC::Library] lib The IRC library instance.
+      def initialize lib
+        extend Auto::IRC::Protocol::Numerics
+        lib.events.on :receive, &method(:parse)
+      end
+        
+      # Parse IRC data.
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      def parse irc, raw
+          
+        params  = raw.split(/\s+/)
+        command = (raw =~ /^:/ ? params[1] : params[0]).dc
+
+        # Check if we process this command.
+        if respond_to? "on_#{command}"
+          send("on_#{command}", irc, raw, params)
+        end
+
+      end
+
+      # AUTHENTICATE
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      # @param [Array<String>] params The data received divided by +\s+ through
+      #   regexp.
+      def on_authenticate irc, raw, params
+        username = $m.conf['irc'][irc.s]['SASL']['username']
+        password = $m.conf['irc'][irc.s]['SASL']['password']
+        
+        if irc.supp.sasl_method    == :dh_blowfish
+          crypt = Auto::IRC::SASL::Mech::DHBlowfish.encrypt(username, password, params.last)
+        elsif irc.supp.sasl_method == :plain
+          crypt = Auto::IRC::SASL::Mech::Plain.encrypt(username, password, params.last)
+        end
+
+        while crypt.length >= 400
+          irc.snd "AUTHENTICATE #{crypt.slice!(0, 400)}"
+        end
+
+        if crypt.length > 0
+          irc.snd "AUTHENTICATE #{crypt}"
+        else
+          irc.snd('AUTHENTICATE +')
+        end
+        # And we're done!
+      end
+        
+      # CAP
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      # @param [Array<String>] params The data received divided by +\s+ through
+      #   regexp.
+      def on_cap irc, raw, params
+        case params[3]
+
+        when 'LS'
+          params[4].gsub!(/^:/, '')
+          cap_ls(irc, params[4..-1])
+        when 'ACK'
+          params[4].gsub!(/^:/, '')
+          cap_ack(irc, params[4..-1])
+        end
+      end
+
+      # PING
+      #
+      # Return a PONG.
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      # @param [Array<String>] params The data received divided by +\s+ through
+      #   regexp.
+      def on_ping irc, raw, params
+        irc.snd("PONG #{params[1]}")
+      end
+
+      #######
+      private
+      #######
+
+      # CAP LS
+      #  
+      # Currently, Auto's capabilities include the multi-prefix, sasl,
+      # account-notify, away-notify, and extended-join extensions.
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      # @param [Array<String>] list List of capabilities.
+      def cap_ls irc, list
+
+        req = []
+          
+        # Every extension possible will be used except SASL, which requires
+        # special configuration.
+        %w[multi-prefix account-notify away-notify extended-join].each do |ext|
+          req.push ext if list.include? ext
+        end
+
+        if $m.conf['irc'][irc.s]['SASL'] and list.include? 'sasl'
+          req.push 'sasl'
+        end
+
+        # Send CAP REQ.
+        irc.snd("CAP REQ :#{req.join(' ')}") unless req.empty?
+
+      end
+      
+      # CAP ACK
+      #
+      # We must save all capabilities into +irc.supp.cap+, and initiate SASL
+      # if possible.
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      # @param [Array<String>] list List of capabilities.
+      def cap_ack irc, list
+
+        irc.supp.cap = list
+          
+        if list.include? 'sasl'
+          irc.supp.sasl_id << $m.clock.spawn($m.conf['irc'][irc.s]['SASL']['timeout']||10, :once, irc) do |s|
+            $m.error "SASL authentication on #{s} failed: authentication procedure timed out."
+            s.snd('AUTHENTICATE *')
+            s.cap_end
+          end
+          irc.authenticate :dh_blowfish
+        else
+          irc.snd('CAP END') # end capability negotiation and complete registration
+        end
+
+      end
+
+    end # class Protocol
+
+  end # module IRC
+
+end # module Auto
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/irc/protocol/numerics.rb

@@ -0,0 +1,60 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+require 'auto/irc/std/numerics'
+
+module Auto
+
+  module IRC
+
+    class Protocol
+
+      # An extension of {Auto::IRC::Protocol}, which parses numerics.
+      module Numerics
+        include Auto::IRC::Std::Numerics
+
+        # RPL_WELCOME
+        define_method("on_#{RPL_WELCOME}") do |irc, raw, params|
+          $m.info "Successfully connected to #{irc} IRC network!" # log
+        end
+
+        # RPL_MYINFO
+        define_method("on_#{RPL_MYINFO}") do |irc, raw, params|
+          irc.supp.server_name = params[3]
+        end
+
+        # RPL_ISUPPORT
+        define_method("on_#{RPL_ISUPPORT}") do |irc, raw, params|
+          irc.supp.isupport(irc, params[3..-5].join(' ')) # process the isupport data
+          unless irc.supp.connected
+            irc.supp.connected = true
+            $m.irc.events.call :connected, irc # emit the :connected event
+          end
+        end
+
+        # RPL_SASLSUCCESS
+        define_method("on_#{RPL_SASLSUCCESS}") do |irc, raw, params|
+          $m.info "SASL authentication on #{irc} succeeded!"
+          irc.cap_end
+        end
+
+        # ERR_SASLFAIL
+        define_method("on_#{ERR_SASLFAIL}") do |irc, raw, params|
+          if irc.supp.sasl_method == :dh_blowfish
+            irc.authenticate # try again with the PLAIN mechanism
+          else
+            # ope, failed
+            $m.error "SASL authentication on #{irc} failed: received ERR_SASLFAIL from server."
+            irc.cap_end
+          end
+        end
+
+      end # class Numerics
+
+    end # class Protocol
+
+  end # module IRC
+
+end # module Auto
+
+# vim: set ts=4 sts=2 sw=2 et: