butler 1.8.1 → 1.8.2

data/lib/butler/irc/client/filter.rb

@@ -0,0 +1,12 @@
+class Butler
+	module IRC
+		class Client
+			module Filter # :nodoc:
+				attr_accessor :listener
+				def unsubscribe
+					listener.unsubscribe
+				end
+			end
+		end
+	end
+end

data/lib/butler/irc/client/listener.rb

@@ -0,0 +1,55 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+class Butler
+	module IRC
+		class Client
+
+			# Created by Butler::IRC::Client#subscribe() and similar methods
+			class Listener
+				AllSymbols = [nil].freeze
+				include Comparable
+
+				attr_reader   :priority
+				attr_reader   :symbols
+				attr_accessor :container
+
+				def initialize(symbols=nil, priority=0, *args, &callback)
+					@priority  = priority
+					@symbols   = (symbols ? Array(symbols) : AllSymbols).freeze
+					@args      = args
+					@callback  = callback
+					@container = nil
+				end
+
+				# will remove this listener from the clients dispatcher forever
+				def unsubscribe
+					@container.unsubscribe(self)
+				end
+
+				# Comparison is done by priority, higher priority comes first, so
+				# Listener.new(nil, -100) > Listener.new(nil, 100)
+				def <=>(other)
+					other.priority <=> @priority
+				end
+
+				# set the priority of this listener
+				# see Butler::IRC::Client#subscribe() for infos about priority
+				def priority=(value)
+					@priority = Integer(value)
+					@container.mutated(self)
+				end
+				
+				# Invoke the listener, always passes self as first argument
+				def call(*args)
+					@callback.call(self, *(args+@args))
+				end
+			end
+		end
+	end
+end

data/lib/butler/irc/client/listenerlist.rb

@@ -0,0 +1,69 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'thread'
+
+
+
+class Butler
+	module IRC
+		class Client
+			class ListenerList
+				include Enumerable
+
+				attr_reader :mutex
+
+				def initialize
+					@mutex = Mutex.new
+					@all = {}
+					@per_symbol = Hash.new { |h,k| h[k] = [] }
+				end
+				
+				def each(&block)
+					@all.each_key(&block)
+				end
+				
+				def synchronized_each_for(symbol, &block)
+					@mutex.synchronize {
+						@per_symbol[symbol]+@per_symbol[nil]
+					}.each(&block)
+				end
+				
+				def subscribe(listener)
+					@mutex.synchronize {
+						raise "#{listener} already subscribed" if @all[listener]
+						listener.container = self
+						@all[listener] = true
+						listener.symbols.each { |s|
+							@per_symbol[s] << listener
+							@per_symbol[s] = @per_symbol[s].sort_by { |l| -l.priority }
+						}
+					}
+				end
+				
+				def unsubscribe(listener)
+					@mutex.synchronize {
+						@all.delete(listener)
+						listener.symbols.each { |s|
+							@per_symbol[s].delete(listener)
+							@per_symbol.delete(s) if @per_symbol[s].empty?
+						}
+					}
+				end
+				
+				def mutated(listener)
+					@mutex.synchronize {
+						listener.symbols.each { |symbol|
+							@per_symbol[s] = @per_symbol[s].sort_by { |l| -l.priority }
+						}
+					}
+				end
+			end
+		end
+	end
+end

data/lib/butler/irc/hostmask.rb

@@ -6,48 +6,63 @@
 
 
 
-require 'butler/irc/users'
-
-
-
 class Butler
 	module IRC
 		# Provides methods to see if hostmasks match
 		class Hostmask
+
+			# List of characters to escape in hostmasks and with what to replace
 			Filter	= [
 				[/([\\\[\]{}^`.-])/, '\\\\\1'],
 				[/\?/,  "."],
 				[/\*/, ".*?"],
 			]
 	
-			# FIXME, not yet correct, escaped * and ?
+			# Create a hostmask from a hostmask-string, e.g. "nick!user@host.tld"
+			# Also see Butler::IRC::User#hostmask
 			def initialize(mask)
-				@mask    = mask.dup.freeze
-				filtered = Filter.inject('[]{}^`.-') { |s,(a,b)| s.gsub(a,b) }
-				#string.gsub(/[\\\x00-\x1f]/) { |match| ("\\%02x" % match[0]) } #implement later
-				@regex	= Regexp.new("\A#{filtered}\z")
+				@mask    = mask.freeze
+
+				# FIXME, not yet correct, escaped * and ?
+				filtered = Filter.inject(@mask) { |s,(a,b)| s.gsub(a,b) }
+				# FIXME implement later
+				#string.gsub(/[\\\x00-\x1f]/) { |match| ("\\%02x" % match[0]) }
+				n,u,h    = filtered.split(/[!@]/)
+				@regex	= Regexp.new("\A(#{n})!(#{u})@(#{h})\z")
 			end
 	
-			def matches?(mask)
-				mask	= mask.hostmask if mask.kind_of?(User)
-				return !@regex.match(mask.to_str).nil?
+			# Match a hostmask or anything that responds to #hostmask or #to_str
+			# Sets $1-$3 to nick, user and host if matched.
+			def =~(mask)
+				mask	= mask.hostmask if mask.respond_to?(:hostmask)
+				!!(@regex =~ mask.to_str)
 			end
-	
+			
+			# Match a hostmask or anything that responds to #hostmask or #to_str
+			# Returns a MatchData instance with 3 captures (nick, user, host)
 			def match(mask)
 				mask	= mask.hostmask if mask.kind_of?(User)
 				@regex.match(mask.to_str)
 			end
-	
+			alias === match
+
+			# return the mask-string
 			def to_str
 				@mask
 			end
 			alias to_s to_str
-		end
+			
+			def inspect # :nodoc:
+				"#<Hostmask #{@mask}>"
+			end
+		end # Hostmask
 	
 		class User
+			# Return the users hostmask, uses wildcards for unknown parts
+			# FIXME enable wildcard enforcement
 			def hostmask
 				return Hostmask.new("#{@nick||'*'}!#{@user||'*'}@#{@host||'*'}")
 			end
 		end
 	end
-end
+end

data/lib/butler/irc/message.rb

@@ -8,16 +8,16 @@
 
 #require 'ruby/string' # we need the transcode! method
 
+
+
 class Butler
 	module IRC
 	
 		# Butler::IRC::Message represents messages received by the server.
 		# It provides convenience methods that allow to access information about
 		# those messages easier, e.g. who (as Butler::IRC::User object) sent the
-		# message in which channel (IRC::Channel object) with what text.
+		# message in which channel (Butler::IRC::Channel object) with what text.
 		# Raw message and raw parsed data are still available though.
-		#
-		# =FIXME
 		class Message
 			# the command-symbol, see COMMANDS (e.g. :PRIVMSG, :JOIN, ...)
 			attr_reader :symbol

data/lib/butler/irc/parser.rb

@@ -6,12 +6,12 @@
 
 
 
-require 'butler/irc/channels'
+require 'butler/irc/channellist'
 require 'butler/irc/hostmask'
 require 'butler/irc/message'
 require 'butler/irc/parser/commands'
 require 'butler/irc/string'
-require 'butler/irc/users'
+require 'butler/irc/userlist'
 require 'ruby/exception/detailed'
 require 'ruby/hash/zip'
 

data/lib/butler/irc/parser/rfc2812.rb

@@ -29,8 +29,7 @@ add("kill",    :KILL,   /^(\S*) (\S*) (.*)/, [:channel, :for, :text]) { |message
 		parser.channels.delete_user(message.for, :kill)
 	end
 }
-# FIXME, really ':?' or just plain ':'?
-add("mode",    :MODE,   /^(\S*) :?(.*)/, [:for, :arguments]) { |message, parser|
+add("mode",    :MODE,   /^(\S*) (.*)/, [:for, :arguments]) { |message, parser|
 	modifiers				= message[:arguments].split(" ")
 	modes					= modifiers.shift.split("")
 	flags					= {"o" => User::Flags::OP, "v" => User::Flags::VOICE, "u" => User::Flags::UOP}
@@ -190,10 +189,7 @@ add("317", :RPL_WHOISIDLE, /^(\S+) (\S+) ([^:]+) :(.*)/, [:for, :nick, :values,
 	}
 }
 add("318", :RPL_ENDOFWHOIS)
-add("319", :RPL_WHOISCHANNELS, /^(\S+) (\S+) :(.*)/, [:for, :nick, :channels]) { |message, parser|
-	# FIXME
-	message.alter_member(:channels, message.channels.split(" ").map { |channel| parser.channels.create(channel) })
-}
+add("319", :RPL_WHOISCHANNELS, /^(\S+) (\S+) :(.*)/, [:for, :nick, :channels]) # only add channels shared with butler to a user - that happens elsewhere already
 add("321", :RPL_LISTSTART)
 add("322", :RPL_LIST, /^(\S+) (\S+) (\d+) :(.*)/, [:for, :channelname, :usercount, :topic])
 add("323", :RPL_LISTEND)

data/lib/butler/irc/socket.rb

@@ -6,11 +6,12 @@
 
 
 
-require 'thread'
-require 'socket'
-require 'ostructfixed'
+require 'diagnostics'
 require 'log/comfort'
+require 'ostructfixed'
 require 'ruby/string/chunks'
+require 'socket'
+require 'thread'
 
 
 
@@ -56,7 +57,7 @@ class Butler
 			VERSION	= "1.0.0"
 
 			include Log::Comfort
-	
+			
 			# server the instance is linked with
 			attr_reader :server
 			# port used for connection
@@ -107,7 +108,7 @@ class Butler
 					@limit[key] = options.delete(key) if options.has_key?(key)
 				}
 				@mutex        = Mutex.new
-				@socket       = nil
+				@socket       = Diagnostics.new(self, :write => [NoMethodError, "Must connect first to write to the socket"])
 				@connected    = false
 				raise ArgumentError, "Unknown arguments: #{options.keys.inspect}" unless options.empty?
 			end
@@ -205,6 +206,7 @@ class Butler
 			end
 			
 			# FIXME, figure out what the server supports, possibly requires it
+			# to be moved to Butler::IRC::Client (to allow ghosting, nickchange, identify)
 			def ghost(nickname, password)
 				write("NS :GHOST #{nickname} #{password}")
 			end
@@ -273,7 +275,6 @@ class Butler
 			end
 	
 			# part specified channels
-			# FIXME, better way to implement the reason? use a block (yay)?
 			# returns the channels parted from.
 			def part(reason=nil, *channels)
 				if channels.empty?
@@ -310,6 +311,11 @@ class Butler
 				write("KICK #{channel} #{user} :#{reason}")
 			end
 			
+			# send a mode command to a channel
+			def mode(channel, mode)
+				write("MODE #{channel} #{mode}")
+			end
+			
 			# Give Op to user in channel
 			# User can be a nick or IRC::User, either one or an array.
 			def op(channel, *users)

data/lib/butler/irc/string.rb

@@ -45,6 +45,10 @@ class String
 	def valid_user?
 		strip_user_prefixes.valid_nickname?
 	end
+	
+	def same_nick?(other)
+		strip_user_prefixes.downcase == other.to_str.strip_user_prefixes.downcase
+	end
 
 	# removes indicators from nicknames and channelnames
 	def strip_user_prefixes

data/lib/butler/irc/user.rb

@@ -166,7 +166,6 @@ class Butler
 				!common_channels(with_other_user).empty?
 			end
 	
-			# FIXME
 			# add a channel to the user (should only be used by Butler::IRC::Parser)
 			def add_channel(channel, reason)
 				@channels[channel.to_str.downcase] ||= 0
@@ -176,7 +175,6 @@ class Butler
 				self
 			end
 	
-			# FIXME
 			# remove a channel from the user (should only be used by Butler::IRC::Parser)
 			def delete_channel(channel, reason)
 				@channels.delete(channel.to_str.downcase)
@@ -185,28 +183,24 @@ class Butler
 				end
 			end
 	
-			# FIXME
 			def add_flags(channel, flags)
 				channel = channel.to_str.downcase
 				raise ArgumentError, "User #{self} is not listed in #{channel}" unless @channels.include?(channel)
 				@channels[channel] |= flags
 			end
 	
-			# FIXME
 			def delete_flags(channel, flags)
 				channel = channel.to_str.downcase
 				raise ArgumentError, "User #{self} is not listed in #{channel}" unless @channels.include?(channel)
 				@channels[channel] &= ~flags
 			end
 			
-			# FIXME
 			def quit
 				@channels.each { |channel, _| delete_channel(channel, :quit) }
 				self.status	= :offline
 				@users.delete(self, :quit)
 			end
 	
-			# FIXME
 			def kill
 				@channels.each { |channel, _| delete_channel(channel, :kill) }
 				self.status	= :offline

data/lib/butler/irc/{users.rb → userlist.rb}

@@ -6,7 +6,7 @@
 
 
 
-require 'butler/irc/channels'
+require 'butler/irc/channellist'
 require 'butler/irc/string'
 require 'butler/irc/user'
 require 'thread'
@@ -16,7 +16,7 @@ require 'thread'
 class Butler
 	module IRC
 		# Enumerable: all known & visible users
-		class Users
+		class UserList
 			include Enumerable
 	
 			# the user that represents the clients user

data/lib/butler/irc/whois.rb

@@ -0,0 +1,6 @@
+class Butler
+	module IRC
+		# Reply for Butler::IRC::Client#whois
+		Whois	= Struct.new(:exists, :nick, :user, :host, :real, :registered, :channels, :server, :idle, :signon)
+	end
+end

data/lib/butler/plugin.rb

@@ -10,6 +10,7 @@ require 'butler/plugin/configproxy'
 require 'butler/plugin/onhandlers'
 require 'butler/plugin/mapper'
 require 'butler/plugin/matcher'
+require 'butler/plugin/more'
 require 'butler/plugin/trigger'
 require 'log/comfort'
 require 'ostructfixed'
@@ -36,15 +37,16 @@ class Butler
 			# this method is called to initialize the plugin-class,
 			# do not override
 			def load_plugin(butler, base, path) # :nodoc:
-				@butler    = butler
-				@base      = base.dup.freeze
-				@name      = File.basename(base).freeze
-				@commands  = []
-				@listener  = []
-				@config    = ConfigProxy.new(@butler.config, "plugin/#{name}")
+				@butler       = butler
+				@base         = base.dup.freeze
+				@name         = File.basename(base).freeze
+				@commands     = []
+				@listener     = []
+				@mapping_type = Hash.new { |h,k| MappingTypes[k] }
+				@config       = ConfigProxy.new(@butler.config, "plugin/#{name}")
 	
 				if File.directory?(path) then
-					raise "Not supported yet" # FIXME
+					raise "Not supported yet"
 					@path      = OpenStruct.new(
 						:data      => (@path+"/data").freeze,
 						:strings   => (@path+"/strings").freeze,
@@ -104,12 +106,16 @@ class Butler
 				new(message).usage(data)
 			end
 
-			def on_load
+			def on_load(*args)
+			end
+
+			def on_login(*args)
 			end
 		
 			def trigger(commands)
 				commands = { "en" => commands } unless commands.kind_of?(Hash)
 				commands.each { |lang, command|
+					raise "Invalid trigger, language must be a string" unless String === lang
 					trigger = Trigger.new(self, lang, command)
 					@butler.add_command(trigger)
 					@commands << trigger
@@ -119,6 +125,7 @@ class Butler
 			def map(meth, expressions)
 				expressions = { "en" => expressions } unless expressions.kind_of?(Hash)
 				expressions.each { |lang, expression|
+					raise "Invalid map, language must be a string, method a symbol and expression a string" unless String === lang and String === expression and Symbol === meth
 					mapper = Mapper.new(self, meth, lang, expression)
 					@butler.add_command(mapper)
 					@commands << mapper
@@ -142,8 +149,14 @@ class Butler
 				@listener << listener
 				listener
 			end
+			
+			def on_disconnect(*args)
+			end
+			
+			def on_quit(*args)
+			end
 
-			def on_unload
+			def on_unload(*args)
 			end
 
 			def unload_plugin
@@ -205,14 +218,35 @@ class Butler
 		# and translates it using vars as variables for the string interpolation.
 		# The string is subsequently mirc_formatted (see String#mirc_formatted).
 		# Besides that it works like Message#answer.
-		def answer(string, vars={})
-			string = localize(string, vars) if string.kind_of?(Symbol)
-			@message.answer(string.mirc_formatted)
+		# Another feature of answer is, that it is 'moreified', that means if your answer-text is longer
+		# than 300 chars, butler will display 'more...' at the end and using the plugin 'more' the user
+		# can see the rest of the text.
+		def answer(text, vars={})
+			text = localize(text, vars) if text.kind_of?(Symbol)
+			@message.from.session["more"] = More.new(
+				@message,
+				nil,
+				text.mirc_formatted
+			)
+			@message.answer("#{@message.from.to_s+': ' if @message.public?}#{@message.from.session['more'].show}")
 		end
+		
+		# Same as answer, but 'more' gets a lead prefixed (see Butler::Plugin::More for more info)
+		def answer_with_lead(lead, string, vars={})
+			text = localize(text, vars) if text.kind_of?(Symbol)
+			lead = localize(lead, vars) if text.kind_of?(Symbol)
+			@message.from.session["more"] = More.new(
+				@message,
+				lead.mirc_formatted,
+				text.mirc_formatted
+			)
+			@message.answer("#{@message.from.to_s+': ' if @message.public?}#{@message.from.session['more'].show}")
+		end
+
 
 		# == About
 		# Sends a privmsg (localized and formatted) to any number of recipients
-		# (Users or Channels)
+		# (UserList or ChannelList)
 		#
 		# == Synopsis
 		#   privmsg(:greet, "#some_channel", :from => @butler.myself.nick)
@@ -230,7 +264,7 @@ class Butler
 
 		# == About
 		# Sends a notice (localized and formatted) to any number of recipients
-		# (Users or Channels)
+		# (UserList or ChannelList)
 		#
 		# == Synopsis
 		#   notice(:greet, "#some_channel", :from => @butler.myself.nick)