net-irc 0.0.3 → 0.0.4

data/lib/net/irc/message/modeparser.rb

@@ -0,0 +1,44 @@
+class Net::IRC::Message::ModeParser
+
+	def initialize(require_arg, definition)
+		@require_arg = require_arg.map {|i| i.to_sym }
+		@definition  = definition
+	end
+
+	def parse(arg)
+		params = arg.kind_of?(Net::IRC::Message) ? arg.to_a : arg.split(/\s+/)
+
+		ret =  {
+			:positive => [],
+			:negative => [],
+		}
+
+		current = nil, arg_pos = 0
+		params[1].each_byte do |c|
+			sym = c.chr.to_sym
+			case sym
+			when :+
+				current = ret[:positive]
+			when :-
+				current = ret[:negative]
+			else
+				case
+				when @require_arg.include?(sym)
+					current << [sym, params[arg_pos + 2]]
+					arg_pos += 1
+				when @definition.key?(sym)
+					current << [sym, nil]
+				else
+					# fallback, should raise exception
+					# but not for convenience
+					current << [sym, nil]
+				end
+			end
+		end
+
+		ret
+	end
+
+	autoload :RFC1459,  "net/irc/message/modeparser/rfc1459"
+	autoload :Hyperion, "net/irc/message/modeparser/hyperion"
+end

data/lib/net/irc/message/modeparser/hyperion.rb

@@ -0,0 +1,88 @@
+module Net::IRC::Message::ModeParser::Hyperion
+	Channel  = Net::IRC::Message::ModeParser.new(%w|o l b v k q e|, {
+		:o => "channel ban",
+		:c => "color filter",
+		:d => "realname ban",
+		:e => "ban exemption",
+		:f => "forward on uninvited",
+		:g => "allow anybody to invite",
+		:i => "invite-only",
+		:I => "invite-only exemption",
+		:j => "jupe channel",
+		:J => "join throttling",
+		:k => "channel password",
+		:l => "join limit",
+		:L => "large ban/exempt /invex lists",
+		:m => "moderated",
+		:n => "prevent external send",
+		:p => "deprecated",
+		:P => "permanent channel",
+		:q => "quiet user",
+		:Q => "block forwarded users",
+		:r => "block unidentified",
+		:R => "quiet unidentified",
+		:s => "secret channel",
+		:t => "only ops can change topic",
+		:z => "reduced moderation",
+	})
+	User    = Net::IRC::Message::ModeParser.new(%w||, {
+		:a => "user auspex",
+		:A => "server auspex",
+		:b => "see bots",
+		:B => "edit other people",
+		:c => "see client connections",
+		:C => "block ctcp",
+		:d => "debug",
+		:D => "die command",
+		:e => "identified",
+		:E => "reject messages from unidentified users",
+		:f => "full warning",
+		:F => "immune to flood protection",
+		:G => "global kill",
+		:h => "high priority",
+		:H => "rehash",
+		:i => "invisible",
+		:I => "refuse invite",
+		:j => "autodline",
+		:k => "server kill notices",
+		:K => "local kill",
+		:l => "channel creation notices",
+		:m => "immune",
+		:M => "mass notices",
+		:n => "nick change notices",
+		:N => "use any nick",
+		:o => "operator",
+		:p => "god mode",
+		:P => "setname and setident",
+		:Q => "disable forwarding",
+		:r => "notices on name rejections",
+		:R => "server routing",
+		:s => "server notices",
+		:S => "run commands remotely",
+		:T => "appear in STATS p",
+		:u => "join more channels",
+		:U => "unkline",
+		:v => "view privileges",
+		:V => "view routing",
+		:w => "receive wallops",
+		:W => "send wallops",
+		:x => "see servers joining",
+		:X => "experimental features",
+		:y => "spy",
+		:Y => "misc server connect notices",
+		:z => "receive operwall",
+		:Z => "send operwall",
+		:0 => "see opers",
+		:1 => "see connection settings",
+		:2 => "see network bans",
+		:3 => "see nick bans",
+		:4 => "see STATS T",
+		:5 => "see STATS ?",
+		:6 => "send/receive regardless of +E/noidprivmsg",
+		:9 => "use testline",
+		:* => "grant umodes",
+	})
+end
+
+
+

data/lib/net/irc/message/modeparser/rfc1459.rb

@@ -0,0 +1,21 @@
+module Net::IRC::Message::ModeParser::RFC1459
+	Channel  = Net::IRC::Message::ModeParser.new(%w|o l b v k|, {
+		:o => "give/take channel operator privileges",
+		:p => "private channel flag",
+		:s => "select channel flag",
+		:i => "invite-only channel flag",
+		:t => "topic settable by channel operator only flag",
+		:n => "no messages to channel from clients on the outside",
+		:m => "moderated channel",
+		:l => "set the user limit to channel",
+		:b => "set a ban mask to keep users out",
+		:v => "give/take the ability to speak on a moderated channel",
+		:k => "set a channel key (password)",
+	})
+	User    = Net::IRC::Message::ModeParser.new(%w||, {
+		:i => "marks a users as invisible",
+		:s => "marks a user for receipt of server notices",
+		:w => "user receives wallops",
+		:o => "operator flag",
+	})
+end

data/lib/net/irc/pattern.rb

@@ -0,0 +1,68 @@
+
+module Net::IRC::PATTERN # :nodoc:
+	# letter     =  %x41-5A / %x61-7A       ; A-Z / a-z
+	# digit      =  %x30-39                 ; 0-9
+	# hexdigit   =  digit / "A" / "B" / "C" / "D" / "E" / "F"
+	# special    =  %x5B-60 / %x7B-7D
+	#                  ; "[", "]", "\", "`", "_", "^", "{", "|", "}"
+	LETTER   = 'A-Za-z'
+	DIGIT    = '\d'
+	HEXDIGIT = "#{DIGIT}A-Fa-f"
+	SPECIAL  = '\x5B-\x60\x7B-\x7D'
+
+	# shortname  =  ( letter / digit ) *( letter / digit / "-" )
+	#               *( letter / digit )
+	#                 ; as specified in RFC 1123 [HNAME]
+	# hostname   =  shortname *( "." shortname )
+	SHORTNAME = "[#{LETTER}#{DIGIT}](?:[-#{LETTER}#{DIGIT}]*[#{LETTER}#{DIGIT}])?"
+	HOSTNAME  = "#{SHORTNAME}(?:\\.#{SHORTNAME})*"
+
+	# servername =  hostname
+	SERVERNAME = HOSTNAME
+
+	# nickname   =  ( letter / special ) *8( letter / digit / special / "-" )
+	#NICKNAME = "[#{LETTER}#{SPECIAL}\\w][-#{LETTER}#{DIGIT}#{SPECIAL}]*"
+	NICKNAME = "\\S+" # for multibytes
+
+	# user       =  1*( %x01-09 / %x0B-0C / %x0E-1F / %x21-3F / %x41-FF )
+	#                 ; any octet except NUL, CR, LF, " " and "@"
+	USER = '[\x01-\x09\x0B-\x0C\x0E-\x1F\x21-\x3F\x41-\xFF]+'
+
+	# ip4addr    =  1*3digit "." 1*3digit "." 1*3digit "." 1*3digit
+	IP4ADDR = "[#{DIGIT}]{1,3}(?:\\.[#{DIGIT}]{1,3}){3}"
+	# ip6addr    =  1*hexdigit 7( ":" 1*hexdigit )
+	# ip6addr    =/ "0:0:0:0:0:" ( "0" / "FFFF" ) ":" ip4addr
+	IP6ADDR = "(?:[#{HEXDIGIT}]+(?::[#{HEXDIGIT}]+){7}|0:0:0:0:0:(?:0|FFFF):#{IP4ADDR})"
+	# hostaddr   =  ip4addr / ip6addr
+	HOSTADDR = "(?:#{IP4ADDR}|#{IP6ADDR})"
+
+	# host       =  hostname / hostaddr
+	HOST = "(?:#{HOSTNAME}|#{HOSTADDR})"
+
+	# prefix     =  servername / ( nickname [ [ "!" user ] "@" host ] )
+	PREFIX = "(?:#{NICKNAME}(?:(?:!#{USER})?@#{HOST})?|#{SERVERNAME})"
+
+	# nospcrlfcl =  %x01-09 / %x0B-0C / %x0E-1F / %x21-39 / %x3B-FF
+	#                 ; any octet except NUL, CR, LF, " " and ":"
+	NOSPCRLFCL = '\x01-\x09\x0B-\x0C\x0E-\x1F\x21-\x39\x3B-\xFF'
+
+	# command    =  1*letter / 3digit
+	COMMAND = "(?:[#{LETTER}]+|[#{DIGIT}]{3})"
+
+	# SPACE      =  %x20        ; space character
+	# middle     =  nospcrlfcl *( ":" / nospcrlfcl )
+	# trailing   =  *( ":" / " " / nospcrlfcl )
+	# params     =  *14( SPACE middle ) [ SPACE ":" trailing ]
+	#            =/ 14( SPACE middle ) [ SPACE [ ":" ] trailing ]
+	MIDDLE = "[#{NOSPCRLFCL}][:#{NOSPCRLFCL}]*"
+	TRAILING = "[: #{NOSPCRLFCL}]*"
+	PARAMS = "(?:((?: #{MIDDLE}){0,14})(?: :(#{TRAILING}))?|((?: #{MIDDLE}){14})(?::?)?(#{TRAILING}))"
+
+	# crlf       =  %x0D %x0A   ; "carriage return" "linefeed"
+	# message    =  [ ":" prefix SPACE ] command [ params ] crlf
+	CRLF = '\x0D\x0A'
+	MESSAGE = "(?::(#{PREFIX}) )?(#{COMMAND})#{PARAMS}\s*#{CRLF}"
+
+	CLIENT_PATTERN  = /\A#{NICKNAME}(?:(?:!#{USER})?@#{HOST})\z/on
+	MESSAGE_PATTERN = /\A#{MESSAGE}\z/on
+end # PATTERN

data/lib/net/irc/server.rb

@@ -0,0 +1,188 @@
+class Net::IRC::Server
+	# Server global state for accessing Server::Session
+	attr_accessor :state
+
+	def initialize(host, port, session_class, opts={})
+		@host          = host
+		@port          = port
+		@session_class = session_class
+		@opts          = OpenStruct.new(opts)
+		@sessions      = []
+		@state         = {}
+	end
+
+	# Start server loop.
+	def start
+		@serv = TCPServer.new(@host, @port)
+		@log  = @opts.logger || Logger.new($stdout)
+		@log.info "Host: #{@host} Port:#{@port}"
+		@accept = Thread.start do
+			loop do
+				Thread.start(@serv.accept) do |s|
+					begin
+						@log.info "Client connected, new session starting..."
+						s = @session_class.new(self, s, @log, @opts)
+						@sessions << s
+						s.start
+					rescue Exception => e
+						puts e
+						puts e.backtrace
+					ensure
+						@sessions.delete(s)
+					end
+				end
+			end
+		end
+		@accept.join
+	end
+
+	# Close all sessions.
+	def finish
+		Thread.exclusive do
+			@accept.kill
+			begin
+				@serv.close
+			rescue
+			end
+			@sessions.each do |s|
+				s.finish
+			end
+		end
+	end
+
+
+	class Session
+		include Net::IRC
+		include Constants
+
+		attr_reader :prefix, :nick, :real, :host
+
+		# Override subclass.
+		def server_name
+			"net-irc"
+		end
+
+		# Override subclass.
+		def server_version
+			"0.0.0"
+		end
+
+		# Override subclass.
+		def avaiable_user_modes
+			"eixwy"
+		end
+
+		# Override subclass.
+		def avaiable_channel_modes
+			"spknm"
+		end
+
+		def initialize(server, socket, logger, opts={})
+			@server, @socket, @log, @opts = server, socket, logger, opts
+		end
+
+		def self.start(*args)
+			new(*args).start
+		end
+
+		# Start session loop.
+		def start
+			on_connected
+			while l = @socket.gets
+				begin
+					@log.debug "RECEIVE: #{l.chomp}"
+					m = Message.parse(l)
+					next if on_message(m) === true
+
+					name = "on_#{(COMMANDS[m.command.upcase] || m.command).downcase}"
+					send(name, m) if respond_to?(name)
+
+					break if m.command == QUIT
+				rescue Message::InvalidMessage
+					@log.error "MessageParse: " + l.inspect
+				end
+			end
+		rescue IOError
+		ensure
+			finish
+		end
+
+		# Close this session.
+		def finish
+			begin
+				@socket.close
+			rescue
+			end
+			on_disconnected
+		end
+
+		# Default PASS callback.
+		# Set @pass.
+		def on_pass(m)
+			@pass = m.params[0]
+		end
+
+		# Default NICK callback.
+		# Set @nick.
+		def on_nick(m)
+			@nick = m.params[0]
+		end
+
+		# Default USER callback.
+		# Set @user, @real, @host and call initial_message.
+		def on_user(m)
+			@user, @real = m.params[0], m.params[3]
+			@host = @socket.peeraddr[2]
+			@prefix = Prefix.new("#{@nick}!#{@user}@#{@host}")
+			initial_message
+		end
+
+		# Call when socket connected.
+		def on_connected
+		end
+
+		# Call when socket closed.
+		def on_disconnected
+		end
+
+		# Catch all messages.
+		# If this method return true, aother callback will not be called.
+		def on_message(m)
+		end
+
+		# Default PING callback. Response PONG.
+		def on_ping(m)
+			post server_name, PONG, m.params[0]
+		end
+
+		# Do nothing.
+		# This is for avoiding error on calling super.
+		# So you can always call super at subclass.
+		def method_missing(name, *args)
+		end
+
+		private
+		# Post message to server.
+		#
+		#     include Net::IRC::Constans
+		#     post prefix, PRIVMSG, "#channel", "foobar"
+		def post(prefix, command, *params)
+			m = Message.new(prefix, command, params.map {|s|
+				s.gsub(/[\r\n]/, " ")
+			})
+			@log.debug "SEND: #{m.to_s.chomp}"
+			@socket << m
+		rescue IOError
+			finish
+		end
+
+		# Call when client connected.
+		# Send RPL_WELCOME sequence. If you want to customize, override this method at subclass.
+		def initial_message
+			post server_name, RPL_WELCOME,  @nick, "Welcome to the Internet Relay Network #{@prefix}"
+			post server_name, RPL_YOURHOST, @nick, "Your host is #{server_name}, running version #{server_version}"
+			post server_name, RPL_CREATED,  @nick, "This server was created #{Time.now}"
+			post server_name, RPL_MYINFO,   @nick, "#{server_name} #{server_version} #{avaiable_user_modes} #{avaiable_channel_modes}"
+		end
+	end
+end # Server

data/spec/modeparser_spec.rb

@@ -0,0 +1,43 @@
+
+$LOAD_PATH << "lib"
+$LOAD_PATH << "../lib"
+
+require "net/irc"
+include Net::IRC
+include Constants
+
+
+describe Message::ModeParser do
+	it "should parse RFC1459 correctly" do
+		Message::ModeParser::RFC1459::Channel.parse("#Finish +im")[:positive].should        == [[:i, nil], [:m, nil]]
+		Message::ModeParser::RFC1459::Channel.parse("#Finish +o Kilroy")[:positive].should  == [[:o, "Kilroy"]]
+		Message::ModeParser::RFC1459::Channel.parse("#Finish +v Kilroy")[:positive].should  == [[:v, "Kilroy"]]
+		Message::ModeParser::RFC1459::Channel.parse("#Fins -s")[:negative].should           == [[:s, nil]]
+		Message::ModeParser::RFC1459::Channel.parse("#42 +k oulu")[:positive].should        == [[:k, "oulu"]]
+		Message::ModeParser::RFC1459::Channel.parse("#eu-opers +l 10")[:positive].should    == [[:l, "10"]]
+		Message::ModeParser::RFC1459::Channel.parse("&oulu +b")[:positive].should           == [[:b, nil]]
+		Message::ModeParser::RFC1459::Channel.parse("&oulu +b *!*@*")[:positive].should     == [[:b, "*!*@*"]]
+		Message::ModeParser::RFC1459::Channel.parse("&oulu +b *!*@*.edu")[:positive].should == [[:b, "*!*@*.edu"]]
+
+		Message::ModeParser::RFC1459::Channel.parse("#foo +ooo foo bar baz").should   == {
+			:positive => [[:o, "foo"], [:o, "bar"], [:o, "baz"]],
+			:negative => [],
+		}
+		Message::ModeParser::RFC1459::Channel.parse("#foo +oo-o foo bar baz").should  == {
+			:positive => [[:o, "foo"], [:o, "bar"]],
+			:negative => [[:o, "baz"]],
+		}
+		Message::ModeParser::RFC1459::Channel.parse("#foo -oo+o foo bar baz").should  == {
+			:positive => [[:o, "baz"]],
+			:negative => [[:o, "foo"], [:o, "bar"]],
+		}
+		Message::ModeParser::RFC1459::Channel.parse("#foo +imv foo").should  == {
+			:positive => [[:i, nil], [:m, nil], [:v, "foo"]],
+			:negative => [],
+		}
+
+		Message::ModeParser::RFC1459::User.parse("WIZ -w")[:negative].should   == [[:w, nil]]
+		Message::ModeParser::RFC1459::User.parse("ANGEL +i")[:positive].should == [[:i, nil]]
+		Message::ModeParser::RFC1459::User.parse("WIZ -o")[:negative].should   == [[:o, nil]]
+	end
+end