nakiircbot 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c070c5f505213c2ca011f3a87911603f2b327c2787406c5ffe2b9e8fdc60495
-  data.tar.gz: 145078acb492b0c2afb570be54145eeaca0fa749978b1dcbce59470ac7f84a74
+  metadata.gz: cecb68b5866e9a3ecb2bdff832d44c97b2c28dcec112ecda32f7e5a3e95a6da0
+  data.tar.gz: c4618d0827639dbd5d18d0bc340ead4d5bb54b140b04081e91782fc51cfbbd05
 SHA512:
-  metadata.gz: 4277a56a3a649aca36bf058cb89bbf6a2ac17de4c9388ae22d341d2de234239d4252d7335c422f41bab6b5fc4e954491900660d4b851eb22040f50de604deed9
-  data.tar.gz: c62d1a88df3c5b58aa3bfce9f0f0b52a7804ec85ca32c3e9e82ebd5dd0ff8fa61412a23553213872a497df505d4c8f666736b5f4fe2332f9193a74c6e8e79852
+  metadata.gz: dca52aa83819fee1b9103fb6135175886e9b4080cacd320bb9a0b9232466de9c0cbe8e6dc76bb26c9a78d6e92fdb2fa8896ceb12bddfe985fc45585bbc551da0
+  data.tar.gz: db6cf8ad3fd8c920a1e19eb2967f4d3c43c8ee75b43a74ab79f95bdbc111f3fc4b61c323b258b02990898292a9b78b151375178070bf807746b5750ac8db4b48

data/lib/nakiircbot.rb

@@ -1,16 +1,14 @@
 module NakiIRCBot
   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
+  ReconnectError = ::Class.new ::RuntimeError
+  CHAT_QUEUE_DELAY = 5
+  def self.start server, port, bot_name, *channels, owner: nil, identity: nil, password: nil, masterword: nil, processors: [], tags: false
+    chat_queue = ::Queue.new
 
-    abort "matching bot_name and master_name may cause infinite recursion" if bot_name == master_name
     require "fileutils"
     ::FileUtils.mkdir_p "logs"
     require "logger"
-    # 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",
@@ -23,8 +21,6 @@ module NakiIRCBot
     logger.level = ::ENV["LOGLEVEL_#{name}"].to_sym if ::ENV.include? "LOGLEVEL_#{name}"
     puts "#{name} logger.level = #{logger.level}"
 
-    # https://stackoverflow.com/a/49476047/322020
-
     require "socket"
     socket = ::Module.new do
       @logger = logger
@@ -32,6 +28,9 @@ module NakiIRCBot
       @port = port
 
       @socket = nil
+      def self.update
+        @socket = nil
+      end
       @mutex = ::Mutex.new
       def self.socket
         reconnect = lambda do
@@ -43,7 +42,7 @@ module NakiIRCBot
             sleep 5
             retry
           end
-          raise Reconnect
+          raise ReconnectError
         end
         @mutex.synchronize do
           reconnect.call if @socket.nil?
@@ -57,7 +56,7 @@ module NakiIRCBot
         end
       end
       private_class_method :socket
-      def self.write str
+      def self.write str  # send to socket without logging
         socket{ |_| _.send str + "\n", 0 }
       end
       def self.log str
@@ -67,20 +66,20 @@ module NakiIRCBot
       @buffer = ""
       def self.read
         until i = @buffer.index(?\n)
-          @buffer.concat( socket do |s|
+          @buffer.concat socket{ |s|
             return unless select [s], nil, nil, 1
-            s.read(s.nread).tap{ |_| raise SocketError, "empty read" if _.empty? }
-          end )
+            s.read(s.nread).tap{ |_| raise ::SocketError, "empty read" if _.empty? }
+          }
         end
         @buffer.slice!(0..i).chomp
       end
     end
     prev_privmsg_time = ::Time.now
-    queue_thread = ::Thread.new do
-      ::Thread.current.abort_on_exception = true
+    chat_queue_thread = ::Thread.new do
+      ::Thread.current.abort_on_exception = true  # it has never happened, right? so I don't know what it would cause really
       loop do
-        sleep [prev_privmsg_time + 5 - Time.now, 0].max
-        addr, msg = Queue.pop
+        sleep [prev_privmsg_time + CHAT_QUEUE_DELAY - ::Time.now, 0].max
+        addr, msg = chat_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
@@ -89,44 +88,43 @@ module NakiIRCBot
       end
     end
 
+    # https://stackoverflow.com/a/49476047/322020 -- about PASS, NICK, USER
     # https://en.wikipedia.org/wiki/List_of_Internet_Relay_Chat_commands
     loop do
-      Queue.clear
+      chat_queue.clear
       prev_socket_time = prev_privmsg_time = ::Time.now
       loop do
         unless socket_str = socket.read
-          socket.instance_variable_set :@socket, nil if ::Time.now - prev_socket_time > 300
+          socket.update if ::Time.now - prev_socket_time > 300
           next ::Thread.pass
         end
         prev_socket_time = ::Time.now
-        str = socket_str.force_encoding("utf-8").scrub
-        if /\A:\S+ 372 /.match? str   # MOTD
-          logger.debug "< #{str}"
-        elsif /\APING :/.match? str
+        case str = socket_str.force_encoding("utf-8").scrub
+        when /\A:\S+ 372 /,   # MOTD
+             /\APING :/
           logger.debug "< #{str}"
         else
           logger.info "< #{str}"
+          next socket.update if /\AERROR :Closing Link: /.match? str
         end
-        break if /\AERROR :Closing Link: /.match? str
 
         # if str[/^:\S+ 433 * #{Regexp.escape bot_name} :Nickname is already in use\.$/]
         #   socket_log.call "NICK #{bot_name + "_"}"
         #   next
         # end
 
+        # https://www.alien.net.au/irc/irc2numerics.html
+
         # 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/
-            # we join only when we are sure we are on the correct server
-            # TODO: maybe abort if the server is wrong?
-            socket.log "JOIN #{channels.join ","}"
-            next
-
           when /\A:tmi.twitch.tv 001 #{::Regexp.escape bot_name} :Welcome, GLHF!\z/
-            socket.log "JOIN #{channels.join ","}"
+            channels.each_slice(10){ |slice| socket.log "JOIN #{slice.join ","}" }
             socket.log "CAP REQ :twitch.tv/membership twitch.tv/tags twitch.tv/commands"
             tags = true
             next
+          when /\A:[a-z.]+ 001 #{::Regexp.escape bot_name} :Welcome[ ,]/
+            socket.log "JOIN #{channels.join ","}"
+            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/
             abort "no password" unless password
@@ -139,7 +137,7 @@ module NakiIRCBot
           when /\AAUTHENTICATE \+\z/
             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/
+          when /\A:[a-z]+\.libera\.chat 903 #{::Regexp.escape bot_name} :SASL authentication successful\z/
             next socket.log "CAP END"
 
           when /\APING :/
@@ -153,20 +151,21 @@ module NakiIRCBot
         end
 
         begin
-          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
-            }
+          who, where, what = */\A#{'\S+ ' if tags}:(?<who>[^!]+)!\S+ PRIVMSG (?<where>\S+) :(?<what>.+)/.match(str).to_a.drop(1)
+          logger.warn "#{where} <#{who}> #{what}" if what
+          yield str, who, where, what,
+            add_to_chat_queue: ->(where, what){ chat_queue.push [where, what] },
+            socket_write_and_log: socket.public_method(:log),
+            restart_with_new_password: ->(new_password){ password.replace new_password; socket.update }
         rescue
           puts $!.full_message
-          Queue.push ["##{bot_name}", "error: #{$!}, #{$!.backtrace.first}"]
+          chat_queue.push ["##{bot_name}", "error"]
         end
 
-      rescue Reconnect
+      rescue ReconnectError
         # https://ircv3.net/specs/extensions/sasl-3.1.html
         socket.log "CAP REQ :sasl" if password
+        logger.warn "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}"
@@ -175,6 +174,8 @@ module NakiIRCBot
 
     end
 
+  ensure
+    chat_queue_thread.kill while chat_queue_thread.alive?
   end
 
   module Common
@@ -201,6 +202,8 @@ module NakiIRCBot
         [
           DateTime.parse($1).to_time,
           *case _
+          when /\A> PRIVMSG #([a-z\d_]+) :/
+            [$1, ">", bot_name, $']
           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",
@@ -217,6 +220,7 @@ module NakiIRCBot
           when /\A< (\S+) :tmi\.twitch\.tv USERSTATE ##{bot_name}\z/ # wtf?
           when /\Aexception: /
           when "reconnect",
+               "password",
                "socket: reconnecting",
                /\Asocket: exception: /,
                "< :tmi.twitch.tv 001 #{bot_name} :Welcome, GLHF!"
@@ -297,4 +301,25 @@ module NakiIRCBot
       end
     end.compact.tap{ |_| fail unless 1 == _.map(&:first).map(&:day).uniq.size }
   end
+
+  def self.test start
+    server = ::TCPServer.new 6667
+    ::Thread.new do
+      ::Thread.current.abort_on_exception = true
+      start.call
+    end.tap do |thread|
+      socket = server.accept
+      begin
+        yield \
+          ->{ select [socket], nil, nil, 1 },
+          ->{ ::Timeout.timeout(1.5){ socket.gets } },
+          ->_{ socket.puts _ }
+      ensure
+        # puts "shutting down test server"
+        server.close #rescue Errno::ENOTCONN
+        thread.kill while thread.alive?
+      end
+    end
+  end
+
 end

data/nakiircbot.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nakiircbot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Victor Maslov aka Nakilon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2024-06-05 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: nakilon@gmail.com
@@ -39,7 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: IRC bot framework