nakiircbot 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fd605975fa07fb8ad61f317912b32c6d9525a46
+  data.tar.gz: a6a9a41301909099d2e71d57101232b22c1bbbf1
+SHA512:
+  metadata.gz: 46f06a8b677e230df7543238d94cf9321bae53e7dcf9144e74bea95aa030e947e90cc6361672fa7bab9672118f7643b1488c923b39a3ff0425b640ace7e81b06
+  data.tar.gz: 0fdd39f22e6bb874c380a368638a463a0a013019888883b65e5d059829234653e49c15e2481c24036a3344563c72e01012f9825cc23d08ff52b220bd5099e0eb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Victor Maslov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/nakiircbot.rb

@@ -0,0 +1,135 @@
+module NakiIRCBot
+  # @@channels = []
+  # class << self
+  #   attr_accessor :channels
+  # end
+  def self.start server, port, bot_name, master_name, welcome001, *channels, password: nil, masterword: nil, processors: [], twitch: 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"
+    require "logger"
+    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)
+      # TODO: maybe encode the whole string for a case of invalid progname?
+    }
+    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
+      end
+      socket_send.call "PASS #{password.strip}" if twitch
+      socket_send.call "NICK #{bot_name}"
+      socket_send.call "USER #{bot_name} #{bot_name} #{bot_name} #{bot_name}" unless twitch
+
+      queue = []
+      prev_socket_time = prev_privmsg_time = Time.now
+      loop do
+        begin
+          addr, msg = queue.shift
+          next unless addr && msg
+          fail "I should not PRIVMSG myself" if addr == bot_name
+          msg.scrub!
+          msg.gsub! "\n", "  "
+          msg.gsub! "\r", "  "
+          privmsg = "PRIVMSG #{addr} :#{msg}"
+          privmsg = "PRIVMSG #{addr} :*flood*" if privmsg.bytes.size > 500 && addr.start_with?("#")
+          prev_socket_time = prev_privmsg_time = Time.now
+          socket_send.call privmsg
+          break
+        end until queue.empty? if prev_privmsg_time + 5 < Time.now
+
+        unless _ = Kernel::select([socket], nil, nil, 1)
+          break if Time.now - prev_socket_time > 300
+          next
+        end
+        prev_socket_time = Time.now
+        socket_str = _[0][0].gets(chomp: true)
+        break unless socket_str
+        str = socket_str.force_encoding("utf-8").scrub
+        if /\A:\S+ 372 /.match? str   # MOTD
+          logger.debug "< #{str}"
+        elsif /\APING :/.match? str
+          logger.debug "< #{str}"
+        else
+          logger.info "< #{str}"
+        end
+        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 + "_"}"
+        #   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/
+            # 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 ","}"
+          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"
+            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/
+            abort "no password" unless password
+            logger.info "password"
+            # next socket.send "PASS #{password.strip}\n", 0
+            next socket.send "PRIVMSG NickServ :identify #{bot_name} #{password.strip}\n", 0
+          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"
+          # when /^:([^!]+)!\S+ PRIVMSG #{Regexp.escape bot_name} :\001PING (\d+)\001$/
+          #   socket_send.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 twitch}:(?<who>[^!]+)!\S+ PRIVMSG (?<where>\S+) :(?<what>.+)/
+            next( if processors.empty?
+              queue.push [master_name, "nothing to reload"]
+            else
+              processors.each do |processor|
+                queue.push [master_name, "reloading #{processor}"]
+                load File.absolute_path processor
+              end
+            end ) if $~.named_captures == {"who"=>master_name, "where"=>bot_name, "what"=>"#{twitch ? "@#{bot_name} " : "#{masterword.strip} "}reload"}
+        end
+
+        begin
+          yield str, ->(where, what){ queue.push [where, what] }
+        rescue => e
+          puts e.full_message
+          queue.push [master_name, "yield error: #{e}"]
+        end
+
+      rescue => e
+        puts e.full_message
+        case e
+        when Errno::ECONNRESET, Errno::ECONNABORTED, Errno::ETIMEDOUT, Errno::EPIPE
+          sleep 5
+          break
+        else
+          queue.push [master_name, "unhandled error: #{e}"]
+          sleep 5
+        end
+      end
+
+    end
+
+  end
+end

data/nakiircbot.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |spec|
+  spec.name         = "nakiircbot"
+  spec.version      = "0.0.0"
+  spec.summary      = "IRC bot framework"
+
+  spec.author       = "Victor Maslov aka Nakilon"
+  spec.email        = "nakilon@gmail.com"
+  spec.license      = "MIT"
+  spec.metadata     = {"source_code_uri" => "https://github.com/nakilon/nakiircbot"}
+
+  spec.required_ruby_version = ">=2.5"  # for Exception#full_message and block rescue
+
+  spec.files        = %w{ LICENSE nakiircbot.gemspec lib/nakiircbot.rb }
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: nakiircbot
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Victor Maslov aka Nakilon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: nakilon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/nakiircbot.rb
+- nakiircbot.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/nakilon/nakiircbot
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: IRC bot framework
+test_files: []