ircbot 0.0.2

data/lib/irc/const.rb

@@ -0,0 +1,242 @@
+=begin header
+Internet Relay Chat Protocol Library -- Constants
+
+  $Author: igarashi $
+  $Date: 2000/06/12 15:52:00 $
+
+  Copyright (C) 1998-2000 Hiroshi IGARASHI
+=end
+
+module IRC
+  module Constants
+=begin
+module in which IRC constants are defined
+=end
+
+    ERR_NOSUCHNICK = "401"
+    ERR_NOSUCHSERVE = "402"
+    ERR_NOSUCHCHANNEL = "403"
+    ERR_CANNOTSENDTOCHAN = "404"
+    ERR_TOOMANYCHANNELS = "405"
+    ERR_WASNOSUCHNICK = "406"
+    ERR_TOOMANYTARGETS = "407"
+    ERR_NOORIGIN = "409"
+    ERR_NORECIPIENT = "411"
+    ERR_NOTEXTTOSEND = "412"
+    ERR_NOTOPLEVE = "413"
+    ERR_WILDTOPLEVEL = "414"
+    ERR_UNKNOWNCOMMAND = "421"
+    ERR_NOMOTD = "422"
+    ERR_NOADMININFO = "423"
+    ERR_FILEERROR = "424"
+    ERR_NONICKNAMEGIVEN = "431"
+    ERR_ERRONEUSNICKNAME = "432"
+    ERR_NICKNAMEINUSE = "433"
+    ERR_NICKCOLLISION = "436"
+    ERR_USERNOTINCHANNEL = "441"
+    ERR_NOTONCHANNE = "442"
+    ERR_USERONCHANNEL = "443"
+    ERR_NOLOGIN = "444"
+    ERR_SUMMONDISABLED = "445"
+    ERR_USERSDISABLED = "446"
+    ERR_NOTREGISTERED = "451"
+    ERR_NEEDMOREPARAM = "461"
+    ERR_ALREADYREGISTRE = "462"
+    ERR_NOPERMFORHOST = "463"
+    ERR_PASSWDMISMATCH = "464"
+    ERR_YOUREBANNEDCREEP = "465"
+    ERR_KEYSET = "467"
+    ERR_CHANNELISFULL = "471"
+    ERR_UNKNOWNMODE = "472"
+    ERR_INVITEONLYCHAN = "473"
+    ERR_BANNEDFROMCHAN = "474"
+    ERR_BADCHANNELKEY = "475"
+    ERR_NOPRIVILEGES = "481"
+    ERR_CHANOPRIVSNEEDED = "482"
+    ERR_CANTKILLSERVER = "483"
+    ERR_NOOPERHOST = "491"
+    ERR_UMODEUNKNOWNFLAG = "501"
+    ERR_USERSDONTMATCH = "502"
+=begin
+Error Replies
+=end
+
+    RPL_NONE = "300"
+    RPL_USERHOST = "302"
+    RPL_ISON = "303"
+    RPL_AWAY = "301"
+    RPL_UNAWAY = "305"
+    RPL_NOWAWAY = "306"
+    RPL_WHOISUSER = "311"
+    RPL_WHOISSERVER = "312"
+    RPL_WHOISOPERATOR = "313"
+    RPL_WHOISIDLE = "317"
+    RPL_ENDOFWHOIS = "318"
+    RPL_WHOISCHANNELS = "319"
+    RPL_WHOWASUSER = "314"
+    RPL_ENDOFWHOWAS = "369"
+    RPL_LISTSTART = "321"
+    RPL_LIST = "322"
+    RPL_LISTEND = "323"
+    RPL_CHANNELMODEIS = "324"
+    RPL_NOTOPIC = "331"
+    RPL_TOPIC = "332"
+    RPL_INVITING = "341"
+    RPL_SUMMONING = "342"
+    RPL_VERSION = "351"
+    RPL_WHOREPLY = "352"
+    RPL_ENDOFWHO = "315"
+    RPL_NAMREPLY = "353"
+    RPL_ENDOFNAME = "366"
+    RPL_LINKS = "364"
+    RPL_ENDOFLINKS = "365"
+    RPL_BANLIST = "367"
+    RPL_ENDOFBANLIST = "368"
+    RPL_INFO = "371"
+    RPL_ENDOFINFO = "374"
+    RPL_MOTDSTART = "375"
+    RPL_MOTD = "372"
+    RPL_ENDOFMOTD = "376"
+    RPL_YOUREOPER = "381"
+    RPL_REHASHING = "382"
+    RPL_TIME = "391"
+    RPL_USERSSTART = "392"
+    RPL_USERS = "393"
+    RPL_ENDOFUSERS = "394"
+    RPL_NOUSERS = "395"
+
+    RPL_TRACELINK = "200"
+    RPL_TRACECONNECTING = "201"
+    RPL_TRACEHANDSHAKE = "202"
+    RPL_TRACEUNKNOWN = "203"
+    RPL_TRACEOPERATOR = "204"
+    RPL_TRACEUSER = "205"
+    RPL_TRACESERVER = "206"
+    RPL_TRACENEWTYPE = "208"
+    RPL_TRACELOG = "261"
+    RPL_STATSLINKINF = "211"
+    RPL_STATSCOMMANDS = "212"
+    RPL_STATSCLINE = "213"
+    RPL_STATSNLINE = "214"
+    RPL_STATSILINE = "215"
+    RPL_STATSKLINE = "216"
+    RPL_STATSYLINE = "218"
+    RPL_ENDOFSTATS = "219"
+    RPL_STATSLLINE = "241"
+    RPL_STATSUPTIME = "242"
+    RPL_STATSOLINE = "243"
+    RPL_STATSHLINE = "244"
+    RPL_UMODEIS = "221"
+    RPL_LUSERCLIENT = "251"
+    RPL_LUSEROP = "252"
+    RPL_LUSERUNKNOWN = "253"
+    RPL_LUSERCHANNELS = "254"
+    RPL_LUSERME = "255"
+    RPL_ADMINME = "256"
+    RPL_ADMINLOC1 = "257"
+    RPL_ADMINLOC2 = "258"
+    RPL_ADMINEMAIL = "259"
+=begin
+Message Replies
+=end
+
+    # generating mapping "XXX" -> <error name>
+    table = {}
+    constants.each { |name|
+      table[const_get(name)] = name
+    }
+    NAME_TABLE = table
+=begin
+Mapping "XXX" -> <error name>
+=end
+
+    #
+    # Message Commands
+    #
+    CMD_PASS = "PASS"
+    CMD_NICK = "NICK"
+    CMD_USER = "USER"
+    CMD_SERVER = "SERVER"
+    CMD_OPER = "OPER"
+    CMD_QUIT = "QUIT"
+    CMD_SQUIT = "SQUIT"
+=begin
+Connection messages
+=end
+
+    CMD_JOIN = "JOIN"
+    CMD_PART = "PART"
+    CMD_MODE = "MODE"
+    CMD_TOPIC = "TOPIC"
+    CMD_NAMES = "NAMES"
+    CMD_LIST = "LIST"
+    CMD_INVITE = "INVITE"
+    CMD_KICK = "KICK"
+=begin
+Channel control messages
+=end
+
+    CMD_VERSION = "VERSION"
+    CMD_STATS = "STATS"
+    CMD_LINK = "LINK"
+    CMD_TIME = "TIME"
+    CMD_CONNECT = "CONNECT"
+    CMD_TRACE = "TRACE"
+    CMD_ADMIN = "ADMIN"
+    CMD_INFO = "INFO"
+=begin
+Query and messages for server
+=end
+
+    CMD_PRIVMSG = "PRIVMSG"
+    CMD_NOTICE = "NOTICE"
+=begin
+Message sending
+=end
+
+    CMD_WHO = "WHO"
+    CMD_WHOIS = "WHOIS"
+    CMD_WHOWAS = "WHOWAS"
+=begin
+Request for user information
+=end
+
+    CMD_KILL = "KILL"
+    CMD_PING = "PING"
+    CMD_PONG = "PONG"
+    CMD_ERROR = "ERROR"
+=begin
+Others
+=end
+
+    CMD_AWAY = "AWAY"
+    CMD_REHASH = "REHASH"
+    CMD_RESTART = "RESTART"
+    CMD_SUMMON = "SUMMON"
+    CMD_USERS = "USERS"
+    CMD_WALLOPS = "WALLOPS"
+    CMD_USERHOST = "USERHOST"
+    CMD_ISON = "ISON"
+=begin
+Optional
+=end
+
+    #
+    # Other constants
+    #
+
+    CRLF = "\r\n"
+=begin
+Message separator
+=end
+
+    DEFAULT_PORT = 6667
+=begin
+Default TCP Port
+=end
+    
+  end
+end
+
+#p IRC::Constants::NAME_TABLE
+

data/lib/irc/irc.rb

@@ -0,0 +1,324 @@
+=begin header
+Internet Relay Chat Protocol Library -- Main Part
+
+  $Author: knu $
+  $Date: 2001/01/31 10:55:28 $
+
+  Copyright (C) 1998-2000 Hiroshi IGARASHI
+=end
+
+require 'socket'
+require 'thread'
+require 'kconv'
+require 'irc/localize'
+require 'irc/const'
+
+module IRC
+  class Message
+=begin
+IRC messages in IRC protocol
+=end
+  
+    include Constants
+
+    attr_accessor(:prefix)
+    attr_accessor(:command)
+    attr_accessor(:params)
+    attr_accessor(:trailing)
+    attr_accessor(:str) # for debug
+=begin
+=end
+  
+    def initialize(command, trailing=nil, prefix=nil, *params)
+=begin
+initialize Message
+  command:String
+  trailing=nil:String
+  prefix=nil:String
+  *params:String
+=end
+      @prefix = prefix
+      @command = command
+      @params = params
+      @trailing = trailing
+      @str = to_s
+    end
+
+    def to_s 
+=begin
+String representation suitable for sending
+=end
+      buf = ''
+      buf << ":" << @prefix << ' ' unless @prefix.nil?
+      buf << @command
+      buf << ' ' << @params.join(' ') unless @params.empty?
+      buf << " :" << @trailing unless @trailing.nil?
+      buf
+    end
+
+    alias_method(:to_extern, :to_s)
+=begin
+alias of to_s
+=end
+  end
+
+  class << Message
+    def parse(str)
+=begin
+parse IRC message and create a new Message object.
+=end
+      strbuf = str.dup
+      strbuf.sub!(/^:(\S+)\s+/, '')
+      prefix = $1 if $1
+      strbuf.sub!(/^(\S+)/, '')
+      command = $1 if $1
+      params = []
+      #while strbuf.sub!(/^\s+([^\s:]+)/, '')
+      while strbuf.sub!(/^\s+([^\s:][^\s]*)/, '')
+	params << $1
+      end
+      strbuf.sub!(/^\s+:([^\r\n]+)(\r\n|\r|\n)?$/, '')
+      trailing = $1 if $1
+      msg = new(command, trailing, prefix, *params)
+      msg.str = str # for debug
+      msg
+    end
+  end
+
+  class User
+=begin
+represent IRC user
+=end
+    attr_reader(:nick)
+    attr_reader(:user)
+    attr_reader(:host)
+    def initialize(nick, user=nil, host=nil)
+      @nick, @user, @host = nick, user, host
+    end
+    def to_s
+      "#{@nick}(#{user}) at #{@host}"
+    end
+    def ==(other)
+      case other
+      when User
+	@nick == other.nick && @user == other.user && @host == other.host
+      else
+	false
+      end
+    end
+  end
+  class << User
+    def parse(str)
+      str =~ /([^\s!@]+)(?:!([^\s@]+))?(?:@(\S+))?/
+      User::new($1, $2, $3)
+    end
+  end
+
+  class LogMessage
+=begin
+class which represents log message
+=end
+    attr_reader(:timestamp)
+=begin
+:Time the time when this object was sent
+=end
+    attr_reader(:sender)
+=begin
+:Object the object which sent object
+=end
+    attr_reader(:ident)
+=begin
+:String identifier for message type
+=end
+    attr_reader(:message)
+=begin
+:String log message string
+=end
+    def initialize(sender, ident, message)
+=begin
+initialization
+  sender:Object the object which sent object
+  ident:String identifier for message type
+  message:String string as message
+  message:Message message object
+=end
+      @timestamp = Time.now
+      @sender, @ident, @message = sender, ident, message
+    end
+    def to_s 
+=begin
+string in standard output form
+=end
+      buf = @timestamp.to_s
+      case @sender
+      when Connection, Client
+	buf << " <#{@ident}> #{@message}"
+      when Agent
+	buf << " [#{@sender.nick}] #{@message}"
+      end
+      buf
+    end
+  end
+
+  class Connection
+=begin
+represent IRC connection
+=end
+
+    include Constants
+
+    def Message(command, trailing=nil, prefix=nil, *params)
+=begin
+alias of IRC::Message::new
+=end
+      Message.new(command, trailing, prefix, *params)
+    end
+
+    def initialize(log_queue=nil)
+=begin
+initialize Connection
+  log_queue:Queue -- queue object into which log message are put.
+=end
+      @log_queue = log_queue
+    end
+
+    private
+    def putlog(ident, str)
+=begin
+put a log message.
+=end
+      #@log_queue.push(Time.now.to_s+": "+str.to_s) unless @log_queue.nil?
+      @log_queue.push(LogMessage.new(self, ident, str)) unless @log_queue.nil?
+    end
+    public
+
+    def connect(server, port=DEFAULT_PORT)
+=begin
+Connect to server which has hostname given by argument server.
+If sub-class of BasicSocket is given, it will be used.
+  server:String -- server name.
+  server:BasicSocket -- socket already connected to server.
+  port=DEFAULT_PORT:Fixnum -- TCP port number. 6667 will be used when omitted.
+=end
+      if server.is_a?(BasicSocket)
+	@socket = server
+      else
+	@server = server
+	@port = port
+	@socket = TCPsocket.open(@server, @port)
+      end
+      @socket.set_codesys("JIS")
+    end
+
+    def disconnect
+=begin
+=end
+      @socket.flush
+      @socket.shutdown(2)
+      @socket.close
+    end
+
+    def send(*args)
+=begin
+send IRC message.
+send(message)
+  message:Message a IRC message to be send
+send(command, trailing, prefix, *params)
+  Send a message which consists of given arguments.
+  Refer to Message#initialize about the meaning of the arguments.
+=end
+      case args.length
+      when 1
+	case args[0]
+	when Message
+	  message = args[0]
+	  @socket.lprint(message, CRLF)
+	  putlog("send", message)
+	when String
+	  command = args[0]
+	  message = Message(command)
+	  @socket.lprint(message, CRLF)
+	  putlog("send1", message)
+	else
+	  putlog("send", "Type error(#{message.inspect}).")
+	end
+      when 0, 2
+	putlog("send", "Argument number error.")
+      else
+	message = Message(*args)
+	@socket.lprint(message, CRLF)
+	putlog("send1", message)
+      end
+    end
+#     def send(message)
+#       @socket.lprint(message, CRLF)
+#       putlog("send", message.to_s)
+#     end
+
+    def recv 
+=begin
+Receive IRC message and return as Message object.
+This method will block.
+=end
+      str = @socket.lgets
+      unless str.nil?
+	message = Message.parse(str)
+      else
+	message = nil
+      end
+      putlog("recv", message)
+      message
+    end
+
+    def sendPASS(password)
+      send(Message(CMD_PASS, nil, nil, password))
+    end
+    def sendNICK(nick)
+      send(Message(CMD_NICK, nil, nil, nick))
+    end
+    def sendUSER(nick, username, hostname, servername, realname)
+      send(Message(CMD_USER, realname, nick,
+		   username, hostname, servername))
+    end
+    def sendQUIT(nick, quit_message)
+      send(Message(CMD_QUIT, quit_message, nick))
+    end
+=begin
+send IRC messages about IRC connection.
+=end
+    
+    def sendPING(nick, servers)
+      send(Message(CMD_PING, nil, nick, servers))
+    end
+    def sendPONG(nick, daemons, phrase=nil)
+      send(Message(CMD_PONG, phrase, nick, daemons))
+    end
+=begin
+send IRC messages PING/PONG.
+=end
+
+#     # send IRC messages about channel
+#     def sendJOIN(nick, channels, keys)
+#       if channels.is_a?(Array)
+# 	channels = channels.join(",")
+#       end
+#       if keys.is_a?(Array)
+# 	keys = keys.join(",")
+#       end
+#       send(Message(CMD_JOIN, nil, nick, channels, keys))
+#     end
+#     def sendPART(nick, channels)
+#       if channels.is_a?(Array)
+# 	channels = channels.join(",")
+#       end
+#       send(Message(CMD_PART, nil, nick, channels))
+#     end
+    
+#     # send IRC messages about sending messages
+#     def sendPRIVMSG(nick, message, *channels)
+#       send(Message(CMD_PRIVMSG, message, nick, *channels))
+#     end
+    
+  end
+end
+