nakiircbot 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92edbf539aabbbac1e6b60cd752b5cb8051eac5cac7fb1a7f66d62fc3d150f89
-  data.tar.gz: 2d8b504a2f9fa52e2648aaa14bac414b1d21c62072367b4f21de8fdbfbb53754
+  metadata.gz: 0c070c5f505213c2ca011f3a87911603f2b327c2787406c5ffe2b9e8fdc60495
+  data.tar.gz: 145078acb492b0c2afb570be54145eeaca0fa749978b1dcbce59470ac7f84a74
 SHA512:
-  metadata.gz: 8601bfe95fa4066b256489cf129e7371f5f879bae8959a6ae494fd1c8cf014edc03df16df9449f434053893873ee52b7d92fffc8f8c018e6ac3c5227757ea348
-  data.tar.gz: c902841c4e88f71122ba2d0d5b32e204e337cf9d227d35fbaf2771ba450932e9ec2558ecd2f73443b8af3e7d81d6b0de9cf29272789f25872fd28a98853bd286
+  metadata.gz: 4277a56a3a649aca36bf058cb89bbf6a2ac17de4c9388ae22d341d2de234239d4252d7335c422f41bab6b5fc4e954491900660d4b851eb22040f50de604deed9
+  data.tar.gz: c62d1a88df3c5b58aa3bfce9f0f0b52a7804ec85ca32c3e9e82ebd5dd0ff8fa61412a23553213872a497df505d4c8f666736b5f4fe2332f9193a74c6e8e79852

data/lib/nakiircbot.rb

@@ -1,66 +1,104 @@
 module NakiIRCBot
-  class << self
-    attr_accessor :queue
-  end
-  self.queue = []
+  require "base64"
+
+  Reconnect = ::Class.new ::RuntimeError
+  Queue = ::Queue.new
   def self.start server, port, bot_name, master_name, welcome001, *channels, identity: nil, password: nil, masterword: nil, processors: [], tags: false
     # @@channels.replace channels.dup
 
     abort "matching bot_name and master_name may cause infinite recursion" if bot_name == master_name
-    require "base64"
     require "fileutils"
-    FileUtils.mkdir_p "logs"
+    ::FileUtils.mkdir_p "logs"
     require "logger"
-    original_formatter = Logger::Formatter.new
-    logger = Logger.new "logs/txt", "daily",
+    # TODO: check how I've implemented the logger in trovobot
+    original_formatter = ::Logger::Formatter.new
+    logger = ::Logger.new "logs/txt", "daily",
                         progname: bot_name, datetime_format: "%y%m%d %H%M%S",
                         formatter: lambda{ |severity, datetime, progname, msg|
       puts "#{datetime.strftime "%H%M%S"} #{severity.to_s[0]} #{progname} #{msg.scrub.inspect[1..-2]}"
-      original_formatter.call severity, datetime, progname, Base64.strict_encode64(msg)
+      original_formatter.call severity, datetime, progname, ::Base64.strict_encode64(msg)
       # TODO: maybe encode the whole string for a case of invalid progname?
     }
-    logger.level = ENV["LOGLEVEL_#{name}"].to_sym if ENV.include? "LOGLEVEL_#{name}"
+    logger.level = ::Logger::WARN
+    logger.level = ::ENV["LOGLEVEL_#{name}"].to_sym if ::ENV.include? "LOGLEVEL_#{name}"
     puts "#{name} logger.level = #{logger.level}"
 
-    # https://en.wikipedia.org/wiki/List_of_Internet_Relay_Chat_commands
-    loop do
-      logger.info "reconnect"
-      require "socket"
-      socket = TCPSocket.new server, port
-
-      # https://stackoverflow.com/a/49476047/322020
-      socket_send = lambda do |str|
-        logger.info "> #{str}"
-        socket.send str + "\n", 0
+    # https://stackoverflow.com/a/49476047/322020
+
+    require "socket"
+    socket = ::Module.new do
+      @logger = logger
+      @server = server
+      @port = port
+
+      @socket = nil
+      @mutex = ::Mutex.new
+      def self.socket
+        reconnect = lambda do
+          @logger.warn "socket: reconnecting"
+          begin
+            @socket = ::TCPSocket.new @server, @port
+          rescue ::SocketError, ::Errno::ENETDOWN, ::Errno::ETIMEDOUT #, Errno::ENETUNREACH
+            @logger.warn "socket: exception: #{$!}, waiting 5 sec"
+            sleep 5
+            retry
+          end
+          raise Reconnect
+        end
+        @mutex.synchronize do
+          reconnect.call if @socket.nil?
+          begin
+            yield @socket
+          rescue ::SocketError #, Errno::ENETDOWN, Errno::ENETUNREACH
+            @logger.warn "socket: exception: #{$!}, waiting 5 sec"
+            sleep 5
+            reconnect.call
+          end
+        end
       end
-      # socket.send "PASS #{password.strip}\n", 0 if twitch
-      socket_send.call "CAP REQ :sasl" if password
-      socket_send.call "NICK #{bot_name}"
-      socket_send.call "USER #{bot_name} #{bot_name} #{bot_name} #{bot_name}" #unless twitch
+      private_class_method :socket
+      def self.write str
+        socket{ |_| _.send str + "\n", 0 }
+      end
+      def self.log str
+        @logger.warn "> #{str}"
+        write str
+      end
+      @buffer = ""
+      def self.read
+        until i = @buffer.index(?\n)
+          @buffer.concat( socket do |s|
+            return unless select [s], nil, nil, 1
+            s.read(s.nread).tap{ |_| raise SocketError, "empty read" if _.empty? }
+          end )
+        end
+        @buffer.slice!(0..i).chomp
+      end
+    end
+    prev_privmsg_time = ::Time.now
+    queue_thread = ::Thread.new do
+      ::Thread.current.abort_on_exception = true
+      loop do
+        sleep [prev_privmsg_time + 5 - Time.now, 0].max
+        addr, msg = Queue.pop
+        fail "I should not PRIVMSG myself" if bot_name == addr = addr.codepoints.pack("U*").tr("\x00\x0A\x0D", "")
+        privmsg = "PRIVMSG #{addr} :#{msg.to_s.codepoints.pack("U*").chomp[/^(\x01*)(.*)/m,2].gsub("\x00", "[NUL]").gsub("\x0A", "[LF]").gsub("\x0D", "[CR]")}"
+        privmsg[-4..-1] = "..." until privmsg.bytesize <= 475
+        prev_privmsg_time = ::Time.now
+        socket.log privmsg
+      end
+    end
 
-      self.queue = []
-      prev_socket_time = prev_privmsg_time = Time.now
+    # https://en.wikipedia.org/wiki/List_of_Internet_Relay_Chat_commands
+    loop do
+      Queue.clear
+      prev_socket_time = prev_privmsg_time = ::Time.now
       loop do
-        begin
-          addr, msg = self.queue.shift
-          next unless addr && msg   # TODO: how is it possible to have only one of them?
-          addr = addr.codepoints.pack("U*").tr("\x00\x0A\x0D", "")
-          fail "I should not PRIVMSG myself" if addr == bot_name
-          msg = msg.to_s.codepoints.pack("U*").chomp[/^(\x01*)(.*)/m,2].gsub("\x00", "[NUL]").gsub("\x0A", "[LF]").gsub("\x0D", "[CR]")
-          privmsg = "PRIVMSG #{addr} :#{msg}"
-          privmsg[-4..-1] = "..." until privmsg.bytesize <= 475
-          prev_socket_time = prev_privmsg_time = Time.now
-          socket_send.call privmsg
-          break
-        end until self.queue.empty? if prev_privmsg_time + 5 < Time.now || server == "localhost"
-
-        unless _ = Kernel::select([socket], nil, nil, 1)
-          break if Time.now - prev_socket_time > 300
-          next
+        unless socket_str = socket.read
+          socket.instance_variable_set :@socket, nil if ::Time.now - prev_socket_time > 300
+          next ::Thread.pass
         end
-        prev_socket_time = Time.now
-        socket_str = _[0][0].gets chomp: true
-        break unless socket_str
+        prev_socket_time = ::Time.now
         str = socket_str.force_encoding("utf-8").scrub
         if /\A:\S+ 372 /.match? str   # MOTD
           logger.debug "< #{str}"
@@ -72,75 +110,191 @@ module NakiIRCBot
         break if /\AERROR :Closing Link: /.match? str
 
         # if str[/^:\S+ 433 * #{Regexp.escape bot_name} :Nickname is already in use\.$/]
-        #   socket_send.call "NICK #{bot_name + "_"}"
+        #   socket_log.call "NICK #{bot_name + "_"}"
         #   next
         # end
 
         # next socket.send("JOIN #{$2}"+"\n"),0 if str[/^:(.+?)!\S+ KICK (\S+) #{Regexp.escape bot_name} /i]
         case str
-          when /\A:[a-z.]+ 001 #{Regexp.escape bot_name} :Welcome to the #{Regexp.escape welcome001} #{Regexp.escape bot_name}\z/
+          when /\A:[a-z.]+ 001 #{::Regexp.escape bot_name} :Welcome to the #{::Regexp.escape welcome001} #{::Regexp.escape bot_name}\z/
             # we join only when we are sure we are on the correct server
             # TODO: maybe abort if the server is wrong?
-            next socket_send.call "JOIN #{channels.join ","}"
+            socket.log "JOIN #{channels.join ","}"
+            next
 
-          when /\A:tmi.twitch.tv 001 #{Regexp.escape bot_name} :Welcome, GLHF!\z/
-            socket_send.call "JOIN #{channels.join ","}"
-            socket_send.call "CAP REQ :twitch.tv/membership twitch.tv/tags twitch.tv/commands"
+          when /\A:tmi.twitch.tv 001 #{::Regexp.escape bot_name} :Welcome, GLHF!\z/
+            socket.log "JOIN #{channels.join ","}"
+            socket.log "CAP REQ :twitch.tv/membership twitch.tv/tags twitch.tv/commands"
+            tags = true
             next
-          when /\A:NickServ!NickServ@services\. NOTICE #{Regexp.escape bot_name} :This nickname is registered. Please choose a different nickname, or identify via \x02\/msg NickServ identify <password>\x02\.\z/,
-               /\A:NickServ!NickServ@services\.libera\.chat NOTICE #{Regexp.escape bot_name} :This nickname is registered. Please choose a different nickname, or identify via \x02\/msg NickServ IDENTIFY #{Regexp.escape bot_name} <password>\x02\z/
+          when /\A:NickServ!NickServ@services\. NOTICE #{::Regexp.escape bot_name} :This nickname is registered. Please choose a different nickname, or identify via \x02\/msg NickServ identify <password>\x02\.\z/,
+               /\A:NickServ!NickServ@services\.libera\.chat NOTICE #{::Regexp.escape bot_name} :This nickname is registered. Please choose a different nickname, or identify via \x02\/msg NickServ IDENTIFY #{Regexp.escape bot_name} <password>\x02\z/
             abort "no password" unless password
-            logger.info "password"
-            next socket.send "PRIVMSG NickServ :identify #{bot_name} #{password.strip}\n", 0
+            logger.warn "password"
+            next socket.write "PRIVMSG NickServ :identify #{bot_name} #{password.strip}"
           # when /\A:[a-z]+\.libera\.chat CAP \* LS :/
-          #   next socket_send "CAP REQ :sasl" if $'.split.include? "sasl"
+          #   next socket_log "CAP REQ :sasl" if $'.split.include? "sasl"
           when /\A:[a-z]+\.libera\.chat CAP \* ACK :sasl\z/
-            next socket_send.call "AUTHENTICATE PLAIN"
+            next socket.log "AUTHENTICATE PLAIN"
           when /\AAUTHENTICATE \+\z/
-            logger.info "password"
-            next socket.send "AUTHENTICATE #{Base64.strict_encode64 "\0#{identity || bot_name}\0#{password}"}\n", 0
+            logger.warn "password"
+            next socket.write "AUTHENTICATE #{::Base64.strict_encode64 "\0#{identity || bot_name}\0#{password}"}"
           when /\A:[a-z]+\.libera\.chat 903 #{bot_name} :SASL authentication successful\z/
-            next socket_send.call "CAP END"
+            next socket.log "CAP END"
 
           when /\APING :/
-            next socket.send "PONG :#{$'}\n", 0   # Quakenet uses timestamp, Freenode and Twitch use server name
-          when /\A:([^!]+)!\S+ PRIVMSG #{Regexp.escape bot_name} :\x01VERSION\x01\z/
-            next socket_send.call "NOTICE #{$1} :\x01VERSION name 0.0.0\x01"
+            next socket.write "PONG :#{$'}"   # Quakenet uses timestamp, Freenode and Twitch use server name
+          when /\A:([^!]+)!\S+ PRIVMSG #{::Regexp.escape bot_name} :\x01VERSION\x01\z/
+            next socket.log "NOTICE #{$1} :\x01VERSION name 0.0.0\x01"
           # when /^:([^!]+)!\S+ PRIVMSG #{Regexp.escape bot_name} :\001PING (\d+)\001$/
-          #   socket_send.call "NOTICE",$1,"\001PING #{rand 10000000000}\001"
+          #   socket_log.call "NOTICE",$1,"\001PING #{rand 10000000000}\001"
           # when /^:([^!]+)!\S+ PRIVMSG #{Regexp.escape bot_name} :\001TIME\001$/
-          #   socket_send.call "NOTICE",$1,"\001TIME 6:06:06, 6 Jun 06\001"
-          when /\A#{'\S+ ' if tags}:(?<who>[^!]+)!\S+ PRIVMSG (?<where>\S+) :(?<what>.+)/
-            next( if processors.empty?
-              self.queue.push [master_name, "nothing to reload"]
-            else
-              processors.each do |processor|
-                self.queue.push [master_name, "reloading #{processor}"]
-                load File.absolute_path processor
-              end
-            end ) if $~.named_captures == {"who"=>master_name, "where"=>bot_name, "what"=>"#{masterword.strip} reload"}
+          #   socket_log.call "NOTICE",$1,"\001TIME 6:06:06, 6 Jun 06\001"
         end
 
         begin
-          yield str, ->(where, what){ self.queue.push [where, what] }
-        rescue => e
-          puts e.full_message
-          self.queue.push [master_name, "yield error: #{e}"]
+          yield str,
+            ->(where, what){ Queue.push [where, what] },
+            ->(new_password){ password.replace new_password; socket.instance_variable_set :@socket, nil },
+            */\A#{'\S+ ' if tags}:(?<who>[^!]+)!\S+ PRIVMSG (?<where>\S+) :(?<what>.+)/.match(str).to_a.drop(1).tap{ |who, where, what|
+              logger.warn "#{where} <#{who}> #{what}" if what
+            }
+        rescue
+          puts $!.full_message
+          Queue.push ["##{bot_name}", "error: #{$!}, #{$!.backtrace.first}"]
         end
 
-      rescue => e
-        puts e.full_message
-        case e
-        when Errno::ECONNRESET, Errno::ECONNABORTED, Errno::ETIMEDOUT, Errno::EPIPE
-          sleep 5
-          break
-        else
-          self.queue.push [master_name, "unhandled error: #{e}"]
-          sleep 5
-        end
+      rescue Reconnect
+        # https://ircv3.net/specs/extensions/sasl-3.1.html
+        socket.log "CAP REQ :sasl" if password
+        socket.write "PASS #{password.strip}"   # https://dev.twitch.tv/docs/irc/authenticate-bot/
+        socket.log "NICK #{bot_name}"
+        socket.log "USER #{bot_name} #{bot_name} #{bot_name} #{bot_name}"
+
       end
 
     end
 
   end
+
+  module Common
+    def self.ping add_to_queue, what
+      return add_to_queue.call what[1..-1].tr "iI", "oO" if "\\ping" == what.downcase
+      return add_to_queue.call what[1..-1].tr "иИ", "оO" if "\\пинг" == what.downcase
+    end
+  end
+
+  def self.parse_log path, bot_name
+    require "time"
+    get_tags = lambda do |str|
+      str[1..-1].split(?;).map do |pair|
+        (a, b) = pair.split ?=
+        fail if a.empty?
+        [a, b]
+      end.to_h
+    end
+    File.new(path).each(chomp: true).drop(1).map do |line|
+      case line
+      when /\AD, /
+      when /\A[IW], \[(\S+) #\d+\]  (?:INFO|WARN) -- #{bot_name}: (.+)\z/
+        _ = Base64.decode64($2).force_encoding "utf-8"
+        [
+          DateTime.parse($1).to_time,
+          *case _
+          when /\A> /,
+               "< :tmi.twitch.tv 002 #{bot_name} :Your host is tmi.twitch.tv",
+               "< :tmi.twitch.tv 003 #{bot_name} :This server is rather new",
+               "< :tmi.twitch.tv 004 #{bot_name} :-",
+               "< :tmi.twitch.tv 375 #{bot_name} :-",
+               "< :tmi.twitch.tv 376 #{bot_name} :>",
+               /\A< :#{bot_name}!#{bot_name}@#{bot_name}\.tmi\.twitch\.tv JOIN #[a-z\d_]+\z/,
+               /\A< :#{bot_name}\.tmi\.twitch\.tv 353 #{bot_name} /,
+               /\A< :#{bot_name}\.tmi\.twitch\.tv 366 #{bot_name} /,
+               "< :tmi.twitch.tv CAP * ACK :twitch.tv/membership twitch.tv/tags twitch.tv/commands",
+               "< :tmi.twitch.tv CAP * NAK :sasl",
+               "< :tmi.twitch.tv NOTICE * :Improperly formatted auth",
+               "< :tmi.twitch.tv RECONNECT"
+          when /\A< (\S+) :tmi\.twitch\.tv USERSTATE ##{bot_name}\z/ # wtf?
+          when /\Aexception: /
+          when "reconnect",
+               "socket: reconnecting",
+               /\Asocket: exception: /,
+               "< :tmi.twitch.tv 001 #{bot_name} :Welcome, GLHF!"
+            [nil, "RECONNECT"]
+          when /\A< :([^\s!]+)!\1@\1\.tmi\.twitch\.tv (JOIN|PART) #([a-z\d_]+)\z/
+            [$3, $2, $1]
+          when /\A#([a-z\d_]+) <(\S+)> (.+)\z/
+            [$1, "PRIVMSG", $2, $3]
+          when /\A< (\S+) :tmi\.twitch\.tv CLEARMSG #([a-z\d_]+) :((?:\S.*)?\S)\z/
+            [$2, "CLEARMSG", get_tags[$1].fetch("login"), $3]
+          when /\A< (\S+) :tmi\.twitch\.tv CLEARCHAT #([a-z\d_]+) :([^\s!]+)\z/
+            [$2, "CLEARCHAT", $3, get_tags[$1].fetch("target-user-id")]
+          when /\A< @emote-only=0;room-id=\d+ :tmi\.twitch\.tv ROOMSTATE #([a-z\d_]+)\z/
+            [$1, "ROOMSTATE EMOTEONLY 0"]
+          when /\A< @emote-only=1;room-id=\d+ :tmi\.twitch\.tv ROOMSTATE #([a-z\d_]+)\z/
+            [$1, "ROOMSTATE EMOTEONLY 1"]
+          when /\A< @msg-id=emote_only_off :tmi\.twitch\.tv NOTICE #([a-z\d_]+) :This room is no longer in emote-only mode\.\z/
+            [$1, "EMOTE_ONLY_OFF"]
+          when /\A< @msg-id=emote_only_on :tmi\.twitch\.tv NOTICE #([a-z\d_]+) :This room is now in emote-only mode\.\z/
+            [$1, "EMOTE_ONLY_ON"]
+          when /\A< @followers-only=-1;room-id=\d+ :tmi\.twitch\.tv ROOMSTATE #([a-z\d_]+)\z/
+            [$1, "ROOMSTATE FOLLOWERSONLY 0"]
+          when /\A< @msg-id=followers_off :tmi\.twitch\.tv NOTICE #([a-z\d_]+) :This room is no longer in followers-only mode\.\z/
+            [$1, "FOLLOWERS_ONLY_OFF"]
+          when /\A< :tmi\.twitch\.tv HOSTTARGET #([a-z\d_]+) :(\S+) (\d+)\z/
+            next if "-" == $2 # wtf?
+            fail unless $2 == $2.downcase
+            [$1, "HOST", $2, $3.to_i]
+          when /\A< @msg-id=host_target_went_offline :tmi\.twitch\.tv NOTICE #([a-z\d_]+) :(\S+) has gone offline\. Exiting host mode\.\z/
+            fail unless $2 == $2.downcase
+            [$1, "HOST_TARGET_WENT_OFFLINE", $2]
+          when /\A< @msg-id=host_on :tmi\.twitch\.tv NOTICE #([a-z\d_]+) :Now hosting (\S+)\.\z/
+            [$1, "NOTICE HOST", $2]
+          when /\A< (\S+) :tmi\.twitch\.tv USERNOTICE #([a-z\d_]+)(?: :((?:\S.*)?\S))?\z/
+            tags = get_tags[$1]
+            fail unless tags.fetch("display-name").downcase == tags.fetch("login")
+            [
+              $2,
+              tags["msg-id"].upcase,
+              *case tags.fetch "msg-id"
+              when "raid"
+                fail if $3
+                [tags.fetch("display-name"), tags.fetch("msg-param-viewerCount").to_i.tap{ |_| fail unless _ > 0 }]
+              when "resub"
+                [tags.fetch("display-name"), *$3]
+              when "sub"
+                fail if $3
+                [tags.fetch("display-name")]
+              when "submysterygift"
+                # fail unless tags["msg-param-mass-gift-count"] == "1"
+                # fail unless tags["msg-param-sender-count"] == "1"
+                fail if $3
+                [tags.fetch("display-name"), tags.fetch("msg-param-mass-gift-count")]
+              when "subgift"
+                fail unless "1" == tags.fetch("msg-param-gift-months")
+                # fail unless tags["msg-param-months"] == "1"
+                fail if $3
+                [tags.fetch("display-name")]
+              when "bitsbadgetier"
+                fail unless $3
+                [tags.fetch("display-name")]
+              when "primepaidupgrade"
+                fail if $3
+                [tags.fetch("display-name")]
+              when "viewermilestone"
+                fail if $3
+                [tags.fetch("display-name")]
+              else
+                fail "unknown USERNOTICE: #{[tags["msg-id"], _, $3].inspect}"
+              end
+            ]
+          else
+            fail "bad log line: #{_.inspect}"
+          end
+        ]
+      else
+        fail line.inspect
+      end
+    end.compact.tap{ |_| fail unless 1 == _.map(&:first).map(&:day).uniq.size }
+  end
 end

data/nakiircbot.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name         = "nakiircbot"
-  spec.version      = "0.2.0"
+  spec.version      = "1.1.0"
   spec.summary      = "IRC bot framework"
 
   spec.author       = "Victor Maslov aka Nakilon"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: nakiircbot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Victor Maslov aka Nakilon
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies: []
-description:
+description: 
 email: nakilon@gmail.com
 executables: []
 extensions: []
@@ -19,12 +19,12 @@ files:
 - LICENSE
 - lib/nakiircbot.rb
 - nakiircbot.gemspec
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/nakilon/nakiircbot
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -39,8 +39,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.4.13
+signing_key: 
 specification_version: 4
 summary: IRC bot framework
 test_files: []