iirc 0.6.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 619cec1c65f965243d45c96b29f02c38d7f6fb576c180587ec468fb8292cfece
-  data.tar.gz: d3b9ca07dcdb07132b36c35a776f6ea287edf88d51f11bc7c4135eac67ed54e6
+  metadata.gz: 35506ead9be0accbdd02186045edf0ff02f5cce1872a430b7f8a73dac493ebae
+  data.tar.gz: 0b3e2e0c4bbb74340429601dea13dd13ccbca51f2dec20e8cc6063995092d9d1
 SHA512:
-  metadata.gz: e80238e5d75e018b049e2cb1ee545bced58d4745a32243d5480a433774a5dbb29247da204bde26927135411c14102b0dab92dbba460772a1d450d7c8394b283a
-  data.tar.gz: 7d7a764ee1b744ca006fc6c4fd949d73b7a14ee2765501c11ffb3dd05db13dc8a72272a4cb0bdb00f29da47375494e17ca359cee6fefdd2d22f0f1f7d44cf627
+  metadata.gz: 264f63137eb223d2143facc99ef5a8b7970597185223b1c5e64dc14a3197915b2e26059cfeb90ac3b181344e5c2e55196561815c9e1be7a4e9696bdf039451cf
+  data.tar.gz: 2c99f6934ebb734ff03882e4833596363843c6f64b43b7720040e61933529be52adaeca64609891f3b9f36953bfe96053233206a434eaf8ecd0968d469d1393e

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [0.6.3] - 2022-05-04
+
+- [Bot#<<] Strip all CR / LF characters passed to Bot#<<
+  - This will help prevent vulns such as:
+    https://matrix.org/blog/2022/05/04/0-34-0-security-release-for-matrix-appservice-irc-high-severity
+
+## [0.6.2] - 2022-04-28
+
+- [Event]  Add CTCP parsing methods
+- [Sender] Nick is the server name when sender is a server
+
+## [0.6.1] - 2022-04-01
+
+- Add SedBot example
+- [RegexHooks] Passes matches as args
+  - e.g. (evt, match_one, match_two, ..)
+- [RegexHooks] Add some tests
+
 ## [0.6.0] - 2022-03-30
 
 - Move modules from IIRC::Bot to IIRC namespace

data/examples/sed.rb

@@ -0,0 +1,83 @@
+require "iirc"
+require "timeout"
+
+SED_REGEX ||= Regexp.new(DATA.read, Regexp::EXTENDED)
+
+class SedBot < IIRC::IRCv3Bot
+  include IIRC::Batteries
+  include IIRC::AcceptInvites
+  include IIRC::PrintIO
+
+  def autojoin_channels
+    ['##iirc']
+  end
+
+  def history
+    @history ||= Hash.new { |h,k| h[k] = [] }
+  end
+
+  def on_privmsg evt
+    case evt.message
+    when SED_REGEX
+      needle, sub, flags = Regexp.new($1, $3.include?('i')), $2, $3
+
+      say Timeout.timeout(5) {
+        history[reply_target]
+          .find { |msg| msg =~ needle }
+          .then { |msg|
+            if msg and flags[/g/]
+              italic msg.gsub(needle, sub)
+            elsif msg
+              italic msg.sub(needle, sub)
+            else
+              'Sorry, no match found'
+            end
+          }
+      }
+    else
+      history[reply_target].unshift evt.message
+    end
+  end
+end
+
+if __FILE__ == $0
+  SedBot.run 'irc.libera.chat', nick: 'Sed[%x]'%rand(256)
+end
+
+__END__
+
+# Copied from https://www.azabani.com/2014/02/08/writing-irc-sedbot.html
+# This matches the s/(needle)/(replacement)/(flags) parts of a sed pattern
+
+^                       # start of the message
+(?:                     # BEGIN first sed expression
+  s/                    #   sed replacement expression delimiter
+  (                     #   BEGIN needle component
+    (?:                 #     BEGIN single needle character
+      [^\\/]            #       anything that isn't a slash or backslash...
+      |\\.              #       ...or any backslash escape
+    )*                  #     END single needle character, zero or more
+  )                     #   END needle component
+  /                     #   slash between needle and replacement
+  (                     #   BEGIN replacement component
+    (?:                 #     BEGIN single replacement character
+      [^\\/]|\\.        #       escape or non-slash-backslash, as above
+    )*                  #     END single replacement character, zero or more
+  )                     #   END replacement component
+  /                     #   slash between replacement and flags
+  (                     #   BEGIN flags component
+    (?:                 #     BEGIN single flag
+      g|i|\d+           #       "g", "i" or a sequence of digits
+    )*                  #     END single flag, zero or more
+  )                     #   END flags component
+)                       # END first sed expression
+(?:                     # BEGIN optional subsequent sed expressions
+  ;                     #   semicolon between sed expressions
+  s/                    #   sed replacement expression delimiter, as above
+  ((?:[^\\/]|\\.)*)     #   needle component, as above
+  /                     #   slash between needle and replacement, as above
+  ((?:[^\\/]|\\.)*)     #   replacement component, as above
+  /                     #   slash between replacement and flags, as above
+  ((?:g|i|\d+)*)        #   flags component, as above
+)*                      # END optional subsequent sed expressions, zero or more
+$                       # end of the message

data/lib/iirc/bot.rb

@@ -5,7 +5,7 @@ module IIRC
     alias :me :user
 
     def <<(text)
-      socket << text + "\r\n"
+      socket << text.tr("\r", "").tr("\n", "") + "\r\n"
       self
     end
 
@@ -21,6 +21,10 @@ module IIRC
       super() if defined? super
       self.socket = socket
       self.user = user.is_a?(User) ? user : User.new(**user)
+
+      if !user.key?(:nick)
+        self.user.nick ||= self.class.name&.split('::')&.last
+      end
     end
 
     def register!
@@ -35,4 +39,4 @@ module IIRC
       raise ArgumentError.new('no nick given') unless me.nick && !me.nick.empty?
     end
   end
-end
+end

data/lib/iirc/event.rb

@@ -28,5 +28,39 @@ module IIRC
     def message
       args.last
     end
+
+    CTCP_REGEX = /^\x01(\w+)(?: ([^\x01]+))?\x01?$/
+
+    def ctcp?
+      message&.match?(CTCP_REGEX)
+    end
+
+    def ctcp_verb
+      $1.downcase.to_sym if message =~ CTCP_REGEX
+    end
+
+    def ctcp_message
+      $2 if message =~ CTCP_REGEX
+    end
+
+    # Parses CTCP data in message, returning nil or an Array like [:action, "does the Macarena"], [:version], [:version, "SomeClient v0.1"]
+    # @example Pattern matching (case)
+    #   case evt.ctcp
+    #   in [:action, msg]
+    #     say "#{evt.nick} did an action: #{italic msg}"
+    #   in [:version]
+    #     say "\x01VERSION Ruby IIRC (v#{IIRC::VERSION})\x01"
+    #   in [:dcc, type, *]
+    #     say "You want to start a DCC #{type} with me? Are you crazy!?"
+    #   else
+    #   end
+    # @example Pattern matching (if)
+    #   on(:privmsg, :be_annoying) { |evt|
+    #     act "#{thing} also" if [:action, thing] in evt.ctcp
+    #   }
+    # @return [Array<Symbol, String?>, nil] CTCP verb and text content, if any (e.g. [:action, "says hello"], [:clientinfo], [:version, "SomeClient v0.1"])
+    def ctcp
+      [ctcp_verb, ctcp_message].compact if ctcp?
+    end
   end
 end

data/lib/iirc/modules/autojoin.rb

@@ -8,7 +8,7 @@ module IIRC
       on :'001', :autojoin!
     end
 
-    # Send JOIN for each {#autojoin_channel}
+    # Send JOIN for each in {#autojoin_channels}
     # @return [Array<String>] channels joined
     def autojoin!
       for channel in autojoin_channels

data/lib/iirc/modules/hooks.rb

@@ -7,8 +7,7 @@ module IIRC
     def run
       lines { |line|
         begin
-          evt = parse(line)
-          fire! evt.verb, evt
+          self >> line
         rescue Exception => ex
           puts ex.message
           puts ex.backtrace
@@ -16,6 +15,11 @@ module IIRC
       }
     end
 
+    def >>(line)
+      evt = parse(line)
+      fire! evt.verb, evt
+    end
+
     def on verb=nil, action=nil, &blk
       if action and blk
         define_singleton_method(action, blk)

data/lib/iirc/modules/isupport.rb

@@ -20,9 +20,14 @@ module IIRC
 
     private
       def configure_isupport
+        on :'001', :clear_isupport
         on :'005', :store_isupport
       end
 
+      def clear_isupport
+        @isupport = nil
+      end
+
       def store_isupport(evt)
         tokens = evt.args[1..-2]
 
@@ -66,5 +71,20 @@ module IIRC
     def channel_prefixes
       (@channel_prefixes ||= self['CHANTYPES']&.chars.freeze) || ['#'].freeze
     end
+
+    # Modes which grant privileges to a user in a channel and their respective
+    # prefix characters seen in NAMES, WHO and WHOIS replies.
+    # @see https://modern.ircdocs.horse/#channel-membership-prefixes
+    # @example qaohv
+    #   isupport.prefix_modes # => {'q'=>'~', 'a'=>'&', 'o'=>'@', 'h'=>'%', 'v'=>'+'}
+    # @return [Hash<String,String>] channel mode => prefix character
+    def prefix_modes
+      if self['PREFIX'].is_a? String
+        modes, symbols = self['PREFIX'][1..].split(')').map!(&:chars)
+        Hash[modes.zip(symbols)].freeze
+      else
+        {}.freeze
+      end
+    end
   end
 end

data/lib/iirc/modules/regex_hooks.rb

@@ -13,8 +13,8 @@ module IIRC
         regex_hooks
           .filter { |k,v| k === evt.message }
           .each_value { |actions|
-            actions.each { |action| call action, evt }
+            actions.each { |action| call action, evt, *Regexp.last_match&.values_at(1..) }
           }
       end
   end
-end
+end

data/lib/iirc/sender.rb

@@ -31,9 +31,9 @@ module IIRC
       not user.nil?
     end
 
-    def nick; user&.nick end
+    def nick; user ? user.nick : without_leading_colon end
     def username; user&.username end
-    def host; server? ? without_leading_colon : user.host end
+    def host; user ? user.host : without_leading_colon end
 
     def to_prefix
       ":#{self}"
@@ -48,8 +48,9 @@ module IIRC
   end
 
   module_function
-    # Extends and returns a source string with the IIRC::Sender mixin.
-    # Duplicates first if the string is frozen. Returns nil if source is nil.
+    # Adds the IIRC::Sender mixin to a string. 
+    # If the string is frozen, a copy is returned. 
+    # If the source is nil, nil is returned.
     #
     # @example :nick!user@host
     #   v = IIRC.Sender(":JimmyWales!jim@wikipedia.org") # => "JimmyWales!jim@wikipedia.org"
@@ -66,4 +67,4 @@ module IIRC
         (source.frozen? ? source.dup : source).extend(Sender)
       end
     end
-end
+end

data/lib/iirc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IIRC
-  VERSION = "0.6.0"
+  VERSION = "0.6.3"
 end

data/lib/iirc.rb

@@ -49,8 +49,6 @@ module IIRC
         local_host: local_host, local_port: local_port,
         ssl_context: ssl_context)
 
-      user_params[:nick] = self.name&.split('::').last if !user_params.key?(:nick)
-
       new(socket, **user_params).tap { |bot|
         bot.register!
         bot.tap(&blk) if blk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iirc
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.3
 platform: ruby
 authors:
 - mooff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ircparser
@@ -43,6 +43,7 @@ files:
 - bin/setup
 - examples/facts.rb
 - examples/greeter.rb
+- examples/sed.rb
 - examples/wolfram.rb
 - iirc.gemspec
 - lib/iirc.rb