ssc.bot 0.1.0

data/lib/ssc.bot/chat_log/messages.rb

@@ -0,0 +1,193 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'attr_bool'
+
+require 'ssc.bot/chat_log/message'
+
+
+module SSCBot
+class ChatLog
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class PlayerMessage < Message
+    attr_reader :message
+    attr_reader :name
+    
+    def initialize(line,type:,name:,message:)
+      super(line,type: type)
+      
+      @message = message
+      @name = name
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class ChatMessage < PlayerMessage
+    attr_reader :channel
+    
+    def initialize(line,channel:,name:,message:)
+      super(line,type: :chat,name: name,message: message)
+      
+      @channel = channel
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class FreqMessage < PlayerMessage
+    def initialize(line,name:,message:)
+      super(line,type: :freq,name: name,message: message)
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class KillMessage < Message
+    attr_reader :bounty
+    attr_reader :killed
+    attr_reader :killer
+    
+    def initialize(line,killed:,bounty:,killer:)
+      super(line,type: :kill)
+      
+      @bounty = bounty
+      @killed = killed
+      @killer = killer
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class PrivateMessage < PlayerMessage
+    def initialize(line,name:,message:,type: :private)
+      super(line,type: type,name: name,message: message)
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class PubMessage < PlayerMessage
+    def initialize(line,name:,message:)
+      super(line,type: :pub,name: name,message: message)
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class QFindMessage < Message
+    attr_reader :arena
+    attr_reader :days
+    attr_reader :find_type # [:arena,:days,:hours,:zone]
+    attr_reader :hours
+    attr_reader? :more
+    attr_reader :player
+    attr_reader? :private
+    attr_reader :zone
+    
+    def initialize(line,find_type:,arena: nil,days: nil,hours: nil,more: false,player: nil,private: false,zone: nil)
+      super(line,type: %s{?find})
+      
+      @arena = arena
+      @days = days
+      @find_type = find_type
+      @hours = hours
+      @more = more
+      @player = player
+      @private = private
+      @zone = zone
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class QLogMessage < Message
+    attr_reader :filename
+    attr_reader :log_type # [:open,:close]
+    
+    def initialize(line,log_type:,filename: nil)
+      super(line,type: %s{?log})
+      
+      @filename = filename
+      @log_type = log_type
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class QNamelenMessage < Message
+    attr_reader :namelen
+    
+    def initialize(line,namelen:)
+      super(line,type: %s{?namelen})
+      
+      @namelen = namelen
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class RemoteMessage < PrivateMessage
+    attr_reader? :own
+    attr_reader? :squad
+    
+    def initialize(line,own:,squad:,name:,message:)
+      super(line,type: :remote,name: name,message: message)
+      
+      @own = own
+      @squad = squad
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class TeamMessage < PlayerMessage
+    def initialize(line,name:,message:)
+      super(line,type: :team,name: name,message: message)
+    end
+  end
+end
+end

data/lib/ssc.bot/chat_log_file.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'ssc.bot/ssc_file'
+
+require 'ssc.bot/chat_log/message'
+require 'ssc.bot/chat_log/message_parsable'
+require 'ssc.bot/chat_log/message_parser'
+require 'ssc.bot/chat_log/messages'
+
+
+module SSCBot
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class ChatLogFile < SSCFile
+    include ChatLog::MessageParsable
+    
+    def initialize(filename,mode=DEFAULT_MODE,parser: ChatLog::MessageParser.new(),**file_kargs)
+      super(filename,mode,**file_kargs)
+      
+      @parser = parser
+    end
+    
+    def parse_line()
+      line = get_line()
+      
+      return line.nil?() ? nil : parse(line)
+    end
+  end
+end

data/lib/ssc.bot/error.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+module SSCBot
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class Error < ::StandardError; end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class AbstractMethodError < Error
+    def initialize(msg=nil)
+      if msg.nil?()
+        method_name = caller[1]
+        
+        if !method_name.nil?()
+          index = method_name.rindex('`')
+          
+          if !index.nil?() && (index += 1) < method_name.length
+            method_name = method_name[index..-2]
+            
+            msg = "abstract method{#{method_name}(...)} not implemented"
+          end
+        end
+      end
+      
+      super(msg)
+    end
+  end
+  
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class ParseError < Error
+  end
+end

data/lib/ssc.bot/ssc_file.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'ssc.bot/util'
+
+
+module SSCBot
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class SSCFile < ::File
+    DEFAULT_BUFFER_LEN = 520
+    DEFAULT_ENCODING = 'Windows-1252:UTF-8'
+    DEFAULT_MODE = 'rt'
+    DEFAULT_SEPARATOR = /\r?\n|\r/ # Instead, could use +/\R/+ for Ruby v2.0+
+    
+    # Clear (truncate) the contents of +filename+.
+    # 
+    # @param filename [String] the file to clear
+    # @param strip [Boolean] +true+ to strip +filename+ to help prevent fat-fingering, else +false+ to not
+    def self.clear_content(filename,strip: true,textmode: true,**opt)
+      filename = Util.u_strip(filename) if strip
+      
+      return if filename.empty?()
+      return if !File.file?(filename) # Also checks if exists
+      
+      # Clear the file.
+      # - Do NOT call truncate() as it's not available on all platforms.
+      open(filename,'w',textmode: textmode,**opt) do |file|
+      end
+    end
+    
+    # If +filename+ exists, then it does nothing (does *not* update time),
+    # else, it creates the file.
+    # 
+    # I just prefer this over +FileUtils.touch+.
+    # 
+    # @param filename [String] the file to soft touch
+    # @param strip [Boolean] +true+ to strip +filename+ to help prevent fat-fingering, else +false+ to not
+    def self.soft_touch(filename,strip: true,textmode: true,**opt)
+      filename = Util.u_strip(filename) if strip
+      
+      return if filename.empty?()
+      return if File.exist?(filename)
+      
+      # Create the file.
+      open(filename,'a',textmode: textmode,**opt) do |file|
+      end
+    end
+    
+    def initialize(filename,mode=DEFAULT_MODE,buffer_len: DEFAULT_BUFFER_LEN,encoding: DEFAULT_ENCODING,separator: DEFAULT_SEPARATOR,**opt)
+      super(filename,mode,encoding: encoding,**opt)
+      
+      @sscbot_buffer = nil
+      @sscbot_buffer_len = buffer_len
+      @sscbot_separator = separator
+    end
+    
+    def get_line()
+      if @sscbot_buffer.nil?()
+        # See comment at loop below.
+        # - Use gets() instead of eof?() because of this method's name.
+        line = gets(nil,@sscbot_buffer_len)
+        
+        return nil if line.nil?() # Still EOF?
+        
+        @sscbot_buffer = line
+      end
+      
+      lines = @sscbot_buffer.split(@sscbot_separator,2)
+      
+      # Will only have 2 if there was a separator.
+      if lines.length == 2
+        @sscbot_buffer = lines[1]
+        
+        return lines[0]
+      end
+      
+      # - Use a separator of nil to get all of the different types of newlines.
+      # - Use gets() [instead of read(), etc.] to work probably with text (e.g., UTF-8)
+      #   and to not throw an error at EOF (returns nil).
+      while !(line = gets(nil,@sscbot_buffer_len)).nil?()
+        lines = line.split(@sscbot_separator,2)
+        
+        # Will only have 2 if there was a separator.
+        if lines.length == 2
+          line = "#{@sscbot_buffer}#{lines[0]}"
+          @sscbot_buffer = lines[1]
+          
+          return line
+        else
+          @sscbot_buffer << line
+        end
+      end
+      
+      # EOF reached with text in the buffer.
+      line = @sscbot_buffer
+      @sscbot_buffer = nil
+      
+      return line
+    end
+    
+    def seek_to_end()
+      result = seek(0,:END)
+      
+      get_line() # Justin Case
+      
+      return result
+    end
+  end
+end

data/lib/ssc.bot/user/jrobot_message_sender.rb

@@ -0,0 +1,194 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+begin
+  require 'java'
+rescue LoadError => e
+  raise e.exception('Must use JRuby for JRobotMessageSender')
+end
+
+require 'attr_bool'
+
+require 'ssc.bot/util'
+
+require 'ssc.bot/user/message_sender'
+
+java_import 'java.awt.Robot'
+java_import 'java.awt.Toolkit'
+
+java_import 'java.awt.datatransfer.Clipboard'
+java_import 'java.awt.datatransfer.ClipboardOwner'
+java_import 'java.awt.datatransfer.StringSelection'
+
+java_import 'java.awt.event.KeyEvent'
+
+
+module SSCBot
+module User
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class JRobotMessageSender < MessageSender
+    attr_accessor :clipboard
+    attr_accessor :msg_key
+    attr_accessor :os
+    attr_accessor :robot
+    attr_accessor :shortcut_paste
+    attr_accessor :shortcut_paste_default
+    attr_accessor :shortcut_paste_macos
+    attr_accessor? :warn_user
+    attr_accessor :warn_user_key
+    attr_accessor :warn_user_sleep
+    
+    def initialize(auto_delay: 110,msg_key: nil,os: Util::OS,warn_user: false,warn_user_key: KeyEvent::VK_BACK_SPACE,warn_user_sleep: 0.747,**kargs)
+      super(**kargs)
+      
+      @clipboard = Toolkit.getDefaultToolkit().getSystemClipboard()
+      @msg_key = msg_key
+      @os = os
+      @robot = Robot.new()
+      @warn_user = warn_user
+      @warn_user_key = warn_user_key
+      @warn_user_sleep = warn_user_sleep
+      
+      @robot.setAutoDelay(auto_delay)
+      
+      @shortcut_paste = ->(ms) do
+        if ms.os == :macos
+          @shortcut_paste_macos.call(ms)
+        else
+          @shortcut_paste_default.call(ms)
+        end
+      end
+      @shortcut_paste_default = ->(ms) { ms.roll_keys(KeyEvent::VK_CONTROL,KeyEvent::VK_V) }
+      @shortcut_paste_macos = ->(ms) { ms.roll_keys(KeyEvent::VK_META,KeyEvent::VK_V) }
+    end
+    
+    def backspace()
+      return type_key(KeyEvent::VK_BACK_SPACE)
+    end
+    
+    def copy(str)
+      @clipboard.setContents(StringSelection.new(str),nil)
+      
+      return self
+    end
+    
+    def enter()
+      return type_key(KeyEvent::VK_ENTER)
+    end
+    
+    def paste(str=nil)
+      copy(str) unless str.nil?()
+      
+      @shortcut_paste.call(self)
+      
+      return self
+    end
+    
+    def press_key(*key_codes)
+      key_codes.each() do |key_code|
+        @robot.keyPress(key_code)
+      end
+      
+      return self
+    end
+    
+    def put(message)
+      # If do type_msg_key() and then warn_user(), then a backspace from
+      #   warn_user() will cancel out the msg key.
+      # Could do type_msg_key().warn_user().type_msg_key(), but then if the
+      #   client is in windowed mode and msg key is a tab, then a backspace
+      #   from warn_user() will do nothing.
+      return warn_user().
+             type_msg_key().
+             paste(message)
+    end
+    
+    def release_key(*key_codes)
+      key_codes.each() do |key_code|
+        @robot.keyRelease(key_code)
+      end
+      
+      return self
+    end
+    
+    def roll_keys(*key_codes)
+      key_codes.each() do |key_code|
+        @robot.keyPress(key_code)
+      end
+      
+      (key_codes.length - 1).downto(0) do |i|
+        @robot.keyRelease(key_codes[i])
+      end
+      
+      return self
+    end
+    
+    def send_message()
+      enter()
+    end
+    
+    def type(message)
+      # TODO: implement type(message)
+      super(message)
+    end
+    
+    def type_key(*key_codes)
+      key_codes.each() do |key_code|
+        @robot.keyPress(key_code)
+        @robot.keyRelease(key_code)
+      end
+      
+      return self
+    end
+    
+    def type_msg_key()
+      if @msg_key
+        if @msg_key.respond_to?(:call)
+          @msg_key.call(self)
+        else
+          type_key(@msg_key)
+        end
+      end
+      
+      return self
+    end
+    
+    def warn_user()
+      if @warn_user
+        if @warn_user_key.respond_to?(:call)
+          @warn_user_key.call(self)
+        else
+          press_key(@warn_user_key)
+          sleep(@warn_user_sleep)
+          release_key(@warn_user_key)
+        end
+      end
+      
+      return self
+    end
+  end
+end
+end