ircbot 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [maiha@wota.jp]
+
+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/README

@@ -0,0 +1,47 @@
+ircbot
+===
+
+  old fashioned irc bot 
+
+
+Config
+======
+
+  Edit "config/xxx.dat" as your environment.
+
+
+Usage
+=====
+
+  ircbot -f config/xxx.dat
+
+
+Command
+=======
+
+  * (nick|realname).COMMAND arg
+     # same as `arg > (nick|realname).COMMAND'
+  * (nick|realname).help
+  * (nick|realname).restart(CPI_NAME = nil)
+  * (nick|realname).register(CPI_NAME)
+  * (nick|realname).remove(CPI_NAME)
+
+
+CPI
+===
+
+  In ircbot's world, we define modules as cpi.
+
+
+
+Notice
+======
+
+  Main code and cpi modules should be euc-japan (KCODE=e).
+
+
+Author
+======
+
+  maiha@wota.jp
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+#require 'merb-core'
+#require 'merb-core/tasks/merb'
+
+GEM_NAME = "ircbot"
+AUTHOR = "maiha"
+EMAIL = "maiha@wota.jp"
+HOMEPAGE = "http://github.com/maiha/ircbot"
+SUMMARY = "old fashioned irc bot"
+GEM_VERSION = "0.0.2"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'asakusarb'
+  s.executables = ["ircbot"]
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "MIT-LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.add_dependency('activesupport', '>= 2.0.0')
+  s.files = %w(MIT-LICENSE README Rakefile) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+require 'spec/rake/spectask'
+#require 'merb-core/test/tasks/spectasks'
+desc 'Default: run spec examples'
+task :default => 'spec'

data/bin/ircbot

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# clear ARGV for Irb
+
+require 'ircbot'
+
+$KCODE = 'e'
+
+# Sync
+STDOUT.sync = true
+STDERR.sync = true
+
+debug  = nil
+config = nil
+cpi    = Pathname(Dir.getwd) + "cpi"
+
+while (arg = ARGV.shift)
+  case arg
+  when /^-d$/		; debug  = true
+  when /^-f$/		; config = ARGV.shift
+  when /^-c$/		; cpi    = ARGV.shift
+  else
+    puts "invalid argument: `#{arg}'"
+    exit
+  end
+end
+
+unless config
+  raise "Specify your config file\nusage: #{$0} -f config/xxx.dat"
+end
+
+# set cpi directory
+Ircbot.push_path :cpi, cpi, "**/*.cpi"
+
+
+module Ircbot
+  class Kicker < Ircbot::ReplyClient
+    rescue_from(SocketError) {
+      raise Ircbot::Recover, 30.minutes
+    }
+
+    rescue_from(Errno::EPIPE, Errno::ECONNRESET, Errno::ETIMEDOUT, IRC::AbnormalTerminated) {
+      raise Ircbot::Recover, 300.minutes
+    }
+  end
+end
+      
+
+irc = Ircbot::ReplyClient.read_config(config, debug)
+irc.start
+puts "Bye"

data/lib/irc/agent.rb

@@ -0,0 +1,177 @@
+=begin header
+Internet Relay Chat Agent Library
+
+  $Author: knu $
+  $Date: 2001/01/31 10:55:28 $
+
+  Copyright (C) 1998-2000 Hiroshi IGARASHI
+=end
+
+#require 'irc'
+#require 'ircclient'
+
+module IRC
+  class Agent
+=begin
+IRC���ư���agent�����Ȥߤ��󶡤��륯�饹��
+���������᥽�åɤ�override�������Ѥ���
+=end
+
+    include Constants
+
+    #attr_reader(:name)
+    attr_accessor(:name)
+=begin
+�����������̾(������ץ�̾��1��1�б�):String
+=end
+    attr_reader(:nick)
+=begin
+�����������̾:String
+=end
+    attr_reader(:timestamp)
+=begin
+��������:Time
+=end
+    attr_accessor(:script_name)
+=begin
+������������ץȥե�����̾:String
+=end
+
+    def initialize(nick=__id__.to_s)
+=begin
+�����Τ߹Ԥ��ʼºݤν������start�ǹԤ���
+=end
+      @nick = nick
+      @timestamp = Time.now
+    end
+    def start(client)
+=begin
+���������ư
+  client:Client ����Agent���Ȥ߹��ޤ��Client���֥�������
+=end
+      @client = client
+      putlog("start", "started.")
+      main
+    end
+    def restart(old_agent)
+=begin
+�Ƶ�ư
+  old_agent:Agent nil�ʤ�и��ߤξ��֤Τޤ�ư���
+=end
+    end
+    def stop
+=begin
+���
+=end
+      putlog("stop", "stopped.")
+      #leprintln("#{@nick} stoped.")
+    end
+
+    def putlog(ident, str)
+      @client.putlog(self, ident, str)
+    end
+    def join(channels, keys)
+      @client.join(channels, keys)
+    end
+    def part(channels)
+      @client.part(channels)
+    end
+    def privmsg(message, *channels)
+      @client.privmsg(message, *channels)
+    end
+    def action(message, *channels)
+      @client.action(message, *channels)
+    end
+=begin
+Client�ε�ǽ�θƽ�
+=end
+
+    #
+    # �����С��饤�ɤ���뤳�Ȥ����Ԥ����᥽�å�
+    #
+
+    def main 
+=begin
+�ᥤ��
+=end
+    end
+    def terminate 
+=begin
+��߽���
+=end
+    end
+  end
+
+  class ActiveAgent < Agent
+    attr_reader(:thread)
+=begin
+���Υ���������ȤΥ���å�:Thread
+=end
+    attr_reader(:message_queue)
+=begin
+��å��������塼:Queue
+nil�ΤȤ�����������ݤ��Ƥ��뤳�Ȥ򼨤�
+=end
+    attr_reader(:log_queue)
+=begin
+�������塼:Queue
+nil�ΤȤ�����������ݤ��Ƥ��뤳�Ȥ򼨤�
+=end
+
+    def start(client)
+=begin
+��ư
+=end
+      @client = client
+      @thread = Thread.current
+      putlog("start", "started.")
+      # ǽưŪ��ư��
+      begin
+	main
+      rescue Stop
+	# ��߽���
+	terminate
+      end
+    end
+    def stop 
+=begin
+���
+=end
+      @thread.raise(Stop.new)
+      super
+    end
+    # 
+    def evolve
+    end
+  end
+
+  class PassiveAgent < Agent
+    #
+#    def start(client)
+#      super
+#      # ����¾�ν��������
+#      # �֥��å�������return���ʤ��ƤϤʤ�ʤ���
+#    end
+    def notifyMessage(msg)
+=begin
+��������������
+���������ƤΥ�å����������Τ�����
+=end
+    end
+    def notifyLog(log)
+=begin
+������������
+���������ƤΥ��������Τ�����
+=end
+    end
+  end
+
+  class TemporaryAgent < Agent
+    def start(client)
+      super
+      # ���Ū�ʽ���
+      # �֥��å�������return���ʤ��ƤϤʤ�ʤ���
+    end
+  end
+end
+

data/lib/irc/client.rb

@@ -0,0 +1,476 @@
+=begin header
+Internet Relay Chat Client Library
+
+  $Author: knu $
+  $Date: 2001/01/31 10:55:28 $
+
+  Copyright (C) 1998-2000 Hiroshi IGARASHI
+=end
+
+require 'irc/irc'
+require 'irc/agent'
+
+if $DEBUG
+  class << Thread
+    alias _start start
+    def start(&iter)
+    eprintln("Thread created(#{caller}).")
+      _start(&iter)
+    end
+  end
+end
+
+module IRC
+
+  class NewAgentException < Exception
+=begin
+����������Ȥ������Ǥ��ʤ��ä����Ȥ򼨤��㳰
+=end
+  end
+
+  class Stop < Exception
+  end
+
+  class Client
+=begin
+IRC���饤����ȤȤ��Ƥε�ǽ�����Ȥߤ�������륯�饹
+=end
+  
+    include Constants
+
+    attr_reader(:nick)
+=begin
+nick:String  �˥å��͡���
+=end
+    attr_reader(:agents)
+=begin
+agents:Hash  �Ȥ߹��ޤ�Ƥ��륨���������
+=end
+    attr_reader(:join_channels)
+=begin
+join_channels:Array of String  join���Ƥ�������ͥ�
+=end
+    
+    def initialize(server, nick, username, realname=username)
+=begin
+Client�ν������Ԥ�
+  server:String    ������̾
+  nick:String      �˥å��͡���
+  username:String  �桼��̾(��������̾)
+  realname:String  ��̾
+=end
+      @server = server
+      @nick = nick
+      @username = username
+      @realname = realname
+      #@passive_agents = {} # String��PassiveAgent
+      #@active_agents = {}  # String��ActiveAgent
+      @agents = {}  # String��Agent
+      @join_channels = []
+    end
+
+    def connect 
+=begin
+�����Фؤ���³��Ԥ�
+=end
+      @connection.connect(@server, 6667)
+      @connection.sendPASS("xxx")
+      @connection.sendNICK(@nick)
+      @connection.sendUSER(nil, @username,
+                           "hostname", "servername", @realname)
+    end
+
+    def disconnect 
+=begin
+�����ФȤ���³���ڤ�
+=end
+      @connection.sendQUIT(@nick, nil)
+      @connection.disconnect
+    end
+
+    def putlog(sender, ident, str)
+=begin
+�����򥭥塼�������
+=end
+      @log_queue.push(LogMessage.new(sender, ident, str)) unless @log_queue.nil?
+    end
+
+    private
+    def _putlog(ident, str)
+=begin
+�����򥭥塼�������
+=end
+      #leprintln(ident , " ", str)
+      putlog(self, ident, str)
+    end
+    public
+
+    def newAgent(name)
+=begin
+����������Ȥ��������롣
+Ϳ����줿̾���Υ���������Ȥ�ץ饰���󥹥���ץȤ���
+��������������֤���
+=end
+      # �����������̾���ץ饰���󥹥���ץ�̾
+      script_name = "cpi/" + name + ".cpi"
+      begin
+        script = File.open(script_name).read
+      rescue Exception
+        _putlog("newAgent:#{name}",
+                "Reading agent plugin script '#{script_name}' raises exception(#{$!}).")
+        raise NewAgentException.new
+      end
+      begin
+        agent = eval(script)
+        p(agent) if $DEBUG
+        if agent.nil?
+          _putlog("newAgent:#{name}",
+                  "Agent plugin script return nil (will not be registerd).")
+        else
+          agent.name = name
+          agent.script_name = script_name
+        end
+      rescue Exception
+        _putlog("newAgent:#{name}",
+               "Agent plugin script raises exception(#{$!}).")
+        raise NewAgentException.new
+      end
+      unless agent.is_a?(Agent)
+        _putlog("newAgent:#{name}", "Agent type warning(#{agent.type}).")
+      end
+      _putlog("newAgent:#{name}", "Agent generated(#{name}).")
+      agent
+    end
+
+    def registAgent(name, agent)
+=begin
+����������Ȥ���Ͽ
+=end
+      case agent
+      when Agent
+        if @agents[name].nil?
+          @agents[name] = agent
+        else
+          p(@agents) if $DEBUG
+          _putlog("registAgent", "duplicate registration of agent(#{name}).")
+        end
+      else
+        _putlog("registAgent", "agent type error.")
+      end
+      _putlog("registAgent", "agent registered(#{name}).")
+      agent
+    end
+
+    def findAgent(name)
+      agent = @agents[name]
+#      if agent.nil?
+#       _putlog("findAgent, "No such agent registered(#{name}).")
+#      end
+      agent
+    end
+
+    def removeAgent(name)
+=begin
+����������Ȥκ��
+=end
+      unless @agents[name].nil?
+        @agents[name] = nil
+      else
+        _putlog("removeAgent", "can't remove agent(#{name}).")
+      end
+    end
+
+    def startAgent(name)
+=begin
+����������Ȥε�ư
+�ʴ��˵�ư���Ƥ����鲿�⤷�ʤ���
+=end
+      _putlog("startAgent", "called(#{name}).")
+      old_agent = findAgent(name)
+      if old_agent.nil?
+        # ��ư���Ƥ��ʤ�
+        begin
+          new_agent = newAgent(name)
+          return nil if new_agent.nil?
+        rescue NewAgentException
+          _putlog("startAgent", "can't start agent(#{name}).")
+          return nil
+        end
+        begin
+          case new_agent
+          when ActiveAgent
+            Thread.start do
+              new_agent.start(self)
+            end
+          when PassiveAgent
+            new_agent.start(self)
+          else
+          end
+          registAgent(name, new_agent)
+        rescue Exception
+          _putlog("startAgent:#{name}",
+                  "Agent#start raises exception(#{$!}).")
+        end
+      else
+        # ��ư���Ƥ���ΤǤ�����֤�
+        old_agent
+      end
+    end
+
+    def stopAgent(name)
+=begin
+����������Ȥ����
+=end
+      agent = findAgent(name)
+      agent.stop unless agent.nil?
+    end
+
+    def restartAgent(name)
+=begin
+����������ȤκƵ�ư�򤹤롣
+���ꤵ�줿̾���Υ���������Ȥ���ߡ���������塢
+�ץ饰���󥹥���ץȤ��饨��������Ȥ������������Ͽ���롣
+name:String ����������Ȥ�̾����
+=end
+      stopAgent(name)
+      removeAgent(name)
+      startAgent(name)
+    end
+
+    def evolveAgent(name)
+=begin
+����������Ȥοʲ�
+��message_thread����ƤӽФ��ʤ��ȡ���å������������ꤽ���ʤ�
+��ǽ���������
+=end
+    end
+
+    def start(init_cpi="init")
+=begin
+���饤����ȤȤ��Ƥ�ư��򳫻Ϥ��롣
+  init_cpi:String  ��ư������ץ�
+=end
+      @syslog_agent = startAgent("syslog")
+      @log_queue = Queue.new
+      _putlog("client", "started.")
+      eprintln("client started.") if $DEBUG
+      @connection = Connection::new(@log_queue)
+      connect
+      _putlog("client", "connected to server.")
+      startAgent(init_cpi)
+
+      startThreads
+
+      #Thread.join(@message_thread) # obsoleted
+      @message_thread.join
+      # syslog�����
+      @syslog_agent.stop
+      # log_thread�����
+      _putlog("client", "stopped.")
+      @log_thread.raise(Stop.new)
+      #Thread.join(@log_thread) # obsoleted
+      @log_thread.join
+      p(@log_queue) if $DEBUG
+    end
+
+    def stop
+      #Thread.start do
+        _stop
+      #end
+    end
+    private
+    def _stop
+      # Agent�����
+      @agents.each do |name, agent|
+        case agent
+        when @syslog_agent
+          leprintln("@syslog_agent skipped.") if $DEBUG
+        when ActiveAgent
+          agent.stop
+        when PassiveAgent
+          agent.stop
+        else
+        end
+      end
+      # Connection������
+      disconnect
+      # message_thread�����
+      @message_thread.raise(Stop.new)
+      #raise(Stop.new)
+    end
+    public
+
+    def startThreads 
+=begin
+����åɤ�ư����
+=end
+      @message_thread = Thread.start {
+        eprintln("message_thread started.") if $DEBUG
+        #_putlog("debug", "message_thread started.")
+        begin
+          handleMessageLoop
+        rescue Stop
+        end
+        eprintln("message_thread stopped.") if $DEBUG
+        #_putlog("debug", "message_thread stopped.")
+      }
+      eprintln("message_thread created.") if $DEBUG
+      @log_thread = Thread.start {
+        eprintln("log_thread started.") if $DEBUG
+        #_putlog("debug", "log_thread started.")
+        handleLogLoop
+        eprintln("log_thread stopped.") if $DEBUG
+        #_putlog("debug", "log_thread stopped.")
+      }
+      eprintln("log_thread created.") if $DEBUG
+      eprintln("threads created.") if $DEBUG
+      p([@message_thread, @log_thread]) if $DEBUG
+    end
+    
+    def handleMessageLoop 
+=begin
+�����ФȤΤ����򤹤롣
+=end
+      loop do
+        msg = @connection.recv
+        if msg.nil?
+          _putlog("handleMessageLoop", "Abnormal terminated.")
+          break
+        end
+        #p msg
+        handleMessageInternal(msg)
+        distributeMessage(msg)
+      end
+    end
+
+    def handleMessageInternal(msg)
+=begin
+��å�������������ϥ�ɥ�˿���ʬ���롣
+=end
+      #lprintln("IRCClient#handleMessage")
+      # msg���������
+      case msg.command
+      when CMD_PING
+        handlePING(msg)
+      else
+        # numeric reply/error���������
+        #leprintln("numeric reply/error���������")
+        name = NAME_TABLE[msg.command]
+        unless name.nil?
+          #_putlog("(#{name})", "#{msg.to_s}")
+        else
+          #raise "Unknown message#{msg.inspect}."
+          #leprintln("Unknown message #{msg.inspect}.")
+          #_putlog("(unknown msg)", "#{msg.to_s}")
+        end
+      end
+    end
+  
+    def handlePING(msg)
+=begin
+��å������ϥ�ɥ顣
+���֥��饹�ǥ����С��饤�ɤ���뤳�Ȥ����Ԥ���Ƥ��롣
+=end
+      @connection.sendPONG(nil, nil, msg.trailing)
+    end
+    
+    def distributeMessage(msg)
+=begin
+������������
+=end
+      @agents.each do |name, agent|
+        case agent
+        when ActiveAgent
+          unless agent.message_queue.nil?
+            agent.message_queue.push(msg)
+          end
+        when PassiveAgent
+          begin
+            agent.notifyMessage(msg)
+          rescue
+            _putlog("distributeMessage",
+                    "Agent(#{name}) raise exception: #{$!}.")
+          end
+        else
+          _putlog("distributeMessage", "Agent type error.")
+        end
+      end
+    end
+
+    def handleLogLoop 
+=begin
+�������
+=end
+      begin
+        loop do
+          log = @log_queue.pop
+          #lprintln(log)
+          eprintln("*********************") unless log.is_a?(LogMessage)
+          #p(log)
+          distributeLog(log)
+        end
+      rescue Stop
+        until @log_queue.empty?
+          log = @log_queue.pop
+          eprintln("*********************") unless log.is_a?(LogMessage)
+          distributeLog(log)
+        end
+      end
+    end
+
+    def distributeLog(log)
+=begin
+����������
+=end
+      @agents.each do |name, agent|
+        #p([name, agent])
+        case agent
+        when ActiveAgent
+          unless agent.log_queue.nil?
+            agent.log_queue.push(log)
+          end
+        when PassiveAgent
+          agent.notifyLog(log)
+        else
+          leprintln("distributeLog: ", "Agent(#{name}) type error.") if $DEBUG
+          #_putlog("distributeLog", "Agent type error.")
+        end
+      end
+    end
+
+    #
+    # ��å����������᥽�å�
+    #
+
+    def join(channels, keys)
+      if channels.is_a?(Array)
+        channels = channels.join(",")
+      end
+      if keys.is_a?(Array)
+        keys = keys.join(",")
+      end
+      @connection.send(CMD_JOIN, nil, @nick, channels, keys)
+    end
+    def part(channels)
+      if channels.is_a?(Array)
+        channels = channels.join(",")
+      end
+      @connection.send(CMD_PART, nil, @nick, channels)
+    end
+=begin
+�����ͥ����˴ؤ���IRC��å�����
+=end
+    
+    def privmsg(message, *channels)
+      @connection.send(CMD_PRIVMSG, message, @nick, *channels)
+    end
+
+    def action(message, *channels)
+      @connection.send(CMD_PRIVMSG, "\001ACTION #{message}\001", @nick, *channels)
+    end
+=begin
+��å����������˴ؤ���IRC��å�����
+=end
+  end
+end
+