butler 1.8.3 → 1.9.0

data/lib/access/admin.rb

@@ -7,9 +7,14 @@
 
 
 class Access
+
 	# Extend Admin users with this plugin, speeds up privileged?
 	# by statically returning true and not performing any lookup.
 	module Admin
+		# Admin is admin, of course
+		def admin?
+			true
+		end
 
 		# admins have all privileges
 		def privileged?(*args)

data/lib/blank.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Kernel
+	# returns a blank class with only __* methods and those mentioned in
+	# leave_methods argument
+	# be aware that e.g. all Kernel methods are gone too, such as raise
+	# you can still use it via e.g. Kernel.raise or use leave_methods
+	# v0.1.1
+	def Blank(*leave_methods)
+		@_blank_classes ||= {}
+		leave_methods.push("__send__", "__id__", "initialize")
+		leave_methods.flatten!
+		leave_methods.uniq!
+		leave_methods.sort!
+		unless @_blank_classes[leave_methods] then
+			slate = Class.new
+			(slate.instance_methods+slate.private_instance_methods+slate.protected_instance_methods).each { |m|
+				slate.send(:undef_method, m) unless leave_methods.include?(m)
+			}
+			@_blank_classes[leave_methods] = slate
+		end
+		@_blank_classes[leave_methods]
+	end
+end
+
+Blank = Blank() unless defined? Blank

data/lib/butler.rb

@@ -35,7 +35,7 @@ class Butler
 		# -:daemonize => whether this script should become a deamon or not [true]
 		# -...
 		def start(path, botname, opts={}, &block)
-			Thread.abort_on_exception = true # if $DEBUG # FIXME
+			Thread.abort_on_exception = true if $DEBUG
 			path    ||= @path
 			butler    = nil
 			
@@ -55,8 +55,8 @@ class Butler
 				File.write(pidfile, $$)
 				butler  = Bot.new(path, botname, opts)
 				path    = butler.path
-				$stderr = File.open(path.log+"/error.log", "w")
-				$stdout = File.open(path.log+"/out.log", "w")
+				$stderr = File.open(path.log+"/error.log", "a")
+				$stdout = File.open(path.log+"/out.log", "a")
 				trap("SIGHUP") { butler.quit }
 				butler.output_to_logfiles
 				butler.plugins.load_all
@@ -93,7 +93,7 @@ class Butler
 			exception(e)
 		ensure
 			File.delete(pidfile) if pidfile and File.exist?(pidfile)
-			butler.quit if butler #and butler.logged_in? # FIXME, make the commented code happen
+			butler.quit if butler and butler.connected?
 			info("Terminated")
 		end
 		

data/lib/butler/bot.rb

@@ -12,6 +12,10 @@ require 'butler/debuglog'
 require 'configuration'
 require 'log'
 require 'butler/plugins'
+require 'butler/remote/connection'
+require 'butler/remote/message'
+require 'butler/remote/server'
+require 'butler/remote/user'
 require 'butler/services'
 require 'butler/session'
 require 'ruby/string/arguments'
@@ -27,16 +31,32 @@ class Butler
 	class Bot < IRC::Client
 		include Log::Comfort
 
+		# The access framework for this bot. An instance of Access.
 		attr_reader :access
-		attr_reader :base
+		
+		# This bot instances configuration. An instance of Configuration.
 		attr_reader :config
+		
+		# The logging device, per default nil
 		attr_reader :logger
+
+		# An OpenStruct with all important paths of this bot instance.
 		attr_reader :path
+
+		# Services butler offers, instance of Butler::Plugins
 		attr_reader :plugins
+		
+		# Remote connections server, instance of Butler::Remote::Server
+		attr_reader :remote
+		
+		# Scheduler to hook up timed events, instance of Scheduler
+		# For plugins and services, please look up the class methods for
+		# Butler::Plugin and Butler::Service, they are to be prefered.
 		attr_reader :scheduler
+		
+		# Services butler offers, instance of Butler::Services
 		attr_reader :services
 
-		# FIXME, raise if selftest fails
 		def initialize(path, name, opts={})
 			path      ||= Butler.path
 			@irc        = nil # early inspects
@@ -55,6 +75,7 @@ class Butler
 			$LOAD_PATH.unshift(@path.lib)
 			require 'butlerinit' if File.exist?(@path.lib+"/butlerinit.rb")
 			@logger     = $stderr
+			@remote     = Remote::Server.new(self)
 			@config     = Configuration.new(@base+'/config')
 			@scheduler  = Scheduler.new
 			@access     = Access.new(
@@ -89,8 +110,10 @@ class Butler
 			
 			subscribe(:PRIVMSG, -10, &method(:invoke_commands))
 			subscribe(:NOTICE,  -10, &method(:invoke_commands))
-
-			selftest
+		end
+		
+		def connected?
+			@irc.connected?
 		end
 		
 		def invoke_commands(listener, message)
@@ -144,38 +167,51 @@ class Butler
 		
 		# returns the rest of the sequence if it was an invocation, nil else
 		def invocation(sequence)
-			@myself && sequence[/^(?:!?#{@myself.nick}[:;,])\s+/i]
-		end
-		
-		# runs a diagnose, will collect all wrongs and raise if it finds any
-		def selftest
-			
+			(@myself && sequence[/^(?:!?#{@myself.nick}[:;,])\s+/i]) || sequence[/^#{@config['invocation']}/i]
 		end
 		
 		def login
 			@access.default_user = @access["default_user"]
 			@access.default_user.login
-			p @access.default_user
 
 			nick = @config["connections/main/nick"]
 			pass = @config["connections/main/password"]
-			super(
-				nick,
-				@config["connections/main/user"],
-				@config["connections/main/real"]
-			)
+			begin
+				super(
+					nick,
+					@config["connections/main/user"],
+					@config["connections/main/real"],
+					@config["connections/main/serverpass"]
+				)
+			rescue Errno::ECONNREFUSED
+				if @reconnect[1].zero? then
+					warn("Connection was refused")
+					return false
+				else
+					warn("Connection was refused, trying again in #{@reconnect.first} seconds")
+					@reconnect[1] -= 1
+					sleep(@reconnect[0])
+					retry
+				end
+			end
 			info("Logged in")
-			if pass && @myself.nick.same_nick?(nick) then
-				@irc.ghost(nick, pass)
-				sleep(1) # FIXME, do a wait_for or similar
-				@irc.nick(nick)
+			if pass && !@parser.same_nick?(@myself.nick, nick) then
+				if wait_for(:NOTICE, 60, :prepare => proc { @irc.ghost(nick, pass) } ) { |m|
+					m.from && m.from.nick =~ /nickserv/i && m.text =~ /has been killed/
+				} then
+					@irc.nick(nick)
+				else
+					warn("Could not ghost the user already occupying my nick '#{nick}'")
+				end
 			end
 			@irc.identify(pass) if pass
 			join(*@config["connections/main/channels"])
 			plugins_dispatch(:on_login, "main")
+			true
 		end
 		
 		def on_disconnect(reason)
+			info("Disconnected due to #{reason}")
 			return if reason == :quit
 			plugins_dispatch(:on_disconnect, reason)
 			unless @reconnect[1].zero? then
@@ -254,9 +290,10 @@ class Butler
 		alias butler_initialize initialize unless method_defined? :butler_initialize
 		def initialize(*args, &block)
 			butler_initialize(*args, &block)
-			@language       = nil
-			@invocation     = nil
-			@arguments      = nil
+			@language            = nil
+			@invocation          = nil
+			@arguments           = nil
+			@formatted_arguments = nil
 			@post_arguments = nil
 		end
 	
@@ -264,23 +301,71 @@ class Butler
 		# e.g. 'Hallo "this is token2" "and this \"token\" is token3"'
 		# would be parsed into: ["hallo", "this is token2", "and this \"token\" is token3"]
 		def arguments
-			return [] unless text # only messages with text can be tokenized to parameters
-			@arguments ||= begin # don't do double-work
-				text[@invocation.length..-1].arguments
-			rescue String::SingleQuoteException => ex
-				ex.pre+[ex.post.join(" ")]
-			end
+			# only messages with text can be tokenized to parameters
+			raise NoMethodError, "Message has no text, can't generate arguments" unless text
+			# cached
+			return @arguments if @arguments
+			# split the args into double-, single- and unquoted arguments, a lonely quote starts the last arg
+			args       = text[@invocation.length..-1].mirc_stripped.scan(/"(?:\\.|[^\\"])*"|'(?:\\.|[^\\'])*'|(?:\\.|[^\\'"\s])+|["'].*/)
+			# sanitize the last argument in case it's not correctly quoted
+			args[-1] = args[-1]+args[-1][0,1] if args[-1][0,1] =~ /'|"/ and args[-1][0,1] != args[-1][-1,1]
+			# unescape data and remove quotes
+			@arguments = args.map { |arg|
+				case arg[0,1]
+					when "'": arg[1..-2].gsub(/\\(['\\])/, '\1')
+					when '"': arg[1..-2].gsub(/\\(["\\])/, '\1')
+					else      arg.gsub(/\\(["'\\ ])/, '\1')
+				end
+			}
 		end
-	
-		# FIXME due to it's current working, post_arguments will strip formatting
+
+		# like #arguments, but doesn't strip color information
+		def formatted_arguments
+			# only messages with text can be tokenized to parameters
+			raise NoMethodError, "Message has no text, can't generate arguments" unless text
+			# cached
+			return @arguments if @arguments
+			# split the args into double-, single- and unquoted arguments, a lonely quote starts the last arg
+			args     = text[@invocation.length..-1].scan(/"(?:\\.|[^\\"])*"|'(?:\\.|[^\\'])*'|(?:\\.|[^\\'"\s])+|["'].*/)
+			# sanitize the last argument in case it's not correctly quoted
+			args[-1] = args[-1]+args[-1][0,1] if args[-1][0,1] =~ /'|"/ and args[-1][0,1] != args[-1][-1,1]
+			# unescape data and remove quotes
+			@formatted_arguments = args.map { |arg|
+				case arg[0,1]
+					when "'": arg[1..-2].gsub(/\\(['\\])/, '\1')
+					when '"': arg[1..-2].gsub(/\\(["\\])/, '\1')
+					else      arg.gsub(/\\(["'\\ ])/, '\1')
+				end
+			}
+		end	
+
 		# Returns the rest of message text after argument
 		# == Synopsis
 		#   "foo bar baz".post_arguments[0] # => "foo bar baz"
 		#   "foo bar baz".post_arguments[1] # => "bar baz"
 		#   "foo bar baz".post_arguments[2] # => "baz"
 		def post_arguments
-			return [] unless text # only messages with text can be tokenized to parameters
-			@post_arguments ||= text[@invocation.length..-1].post_arguments # don't do double-work
+			# only messages with text can be tokenized to parameters
+			raise NoMethodError, "Message has no text, can't generate arguments" unless text
+			# cached
+			return @post_arguments if @post_arguments
+			# split the args into double-, single- and unquoted arguments, a lonely quote starts the last arg
+			args     = text[@invocation.length..-1].scan(/\s+|"(?:\\.|[^\\"])*"|'(?:\\.|[^\\'])*'|(?:\\.|[^\\'"\s])+|["'].*/)
+			# sanitize arguments
+			args.shift if args.first =~ /^\s+$/
+			args.pop   if args.last =~ /^\s+$/
+			args[-1] = args[-1]+args[-1][0,1] if args[-1][0,1] =~ /'|"/ and args[-1][0,1] != args[-1][-1,1]
+			# unescape data and remove quotes
+			args.map! { |arg|
+				case arg[0,1]
+					when "'": arg.gsub(/\\(['\\])/, '\1')
+					when '"': arg.gsub(/\\(["\\])/, '\1')
+					else      arg.gsub(/\\(["'\\ ])/, '\1')
+				end
+			}
+			@post_arguments = []
+			(0...args.length).step(2) { |i| @post_arguments << args[i..-1].join('') }
+			@post_arguments
 		end
 	end # IRC::Message
 end # Butler

data/lib/butler/control.rb

@@ -13,8 +13,8 @@ require 'ruby/file/write'
 class Butler
 	IsGem = true # REPLACE: IsGem = false
 
-	# this module provides services to botcontrol
-	# for gems, this module uses the Gem module to get information on the where-
+	# This Class provides services to botcontrol
+	# For gems, this class uses the Gem module to get information on the where-
 	# abouts of data. If installed using rake from tarball, it is hard-coded.
 	class Control
 		attr_reader :dialog
@@ -38,7 +38,7 @@ class Butler
 		
 		def user(name=nil)
 			# use Etc.getlogin?
-			name || ENV['SUDO_USER'] || ENV['USER'] || @dialog.discuss("username", false)[:name]
+			name || ENV['SUDO_USER'] || ENV['USER'] || @dialog.discuss("username", false)[:username]
 		end
 
 		def configured?(user=nil)
@@ -72,7 +72,8 @@ class Butler
 		def user_config(user=nil)
 			path        = @config.users[user(user)]
 			user_config = OpenStruct.new(YAML.load_file(path))
-			user_config.plugin_repository = @path.plugins
+			user_config.plugin_repository  = @path.plugins
+			user_config.service_repository = @path.services
 			user_config
 		end
 

data/lib/butler/debuglog.rb

@@ -1,16 +1,24 @@
 class Butler
+
+	# Extend an object with debug-log and it will print all read/write actions to @raw_log (defaulting
+	# to $stderr)
 	module DebugLog
+		def self.extended(obj) # :nodoc:
+			obj.raw_log = $stderr
+		end
+
+		# The object to call printf on to log read/writes.
 		attr_accessor :raw_log
 	
-		def read
+		def read # :nodoc:
 			data = super
-			@raw_log.printf("%s < %p\n", Time.now, data)
+			@raw_log.printf("<- %s %p\n", Time.now, data)
 			data
 		end
 		
-		def write(data)
+		def write(data) # :nodoc:
 			rv = super
-			@raw_log.printf("%s > %p\n", Time.now, data)
+			@raw_log.printf("-> %s %p\n", Time.now, data)
 			rv
 		end
 	end

data/lib/butler/dialog.rb

@@ -29,7 +29,7 @@ class Butler
 
 		def initialize(plugin)
 			@plugin = plugin
-			@plugin.butler.subscribe(:PRIVMSG, 20) { |listener, message|
+			@plugin.butler.subscribe(:PRIVMSG, 0, true) { |listener, message|
 				if message.private? then
 					postpone
 					dialog(listener, message)

data/lib/butler/initialvalues.rb

@@ -22,7 +22,7 @@ class Butler
 		BOTPATH/config
 		connections
 		channels
-		plugin
+		plugins
 	]
 	EmptyConfig = {
 		'remote' => {

data/lib/butler/irc/client.rb

@@ -121,7 +121,18 @@ class Butler
 	
 				subscribe(:PING, 100) { |listener, message| @irc.pong(message.pong) }
 				subscribe(:ISUPPORT) { |listener, message|
-					# @parser. ...
+					isupport = {}
+					@parser.isupport.to_hash.each { |key, value|
+						isupport[key.to_s] = value
+					}
+					message.support.each { |key,value|
+						isupport[key.downcase] = value
+					}
+					if message.support.has_key?("PREFIX") then
+						isupport["prefixes"] = message.support["PREFIX"].values.join('')
+					end
+					@parser.reset(isupport)
+					@irc.write_with_eol("CAPAB IDENTIFY-MSG") if @parser.isupport.capab and !@parser.msg_identify
 				}
 				subscribe(:RPL_IDENTIFY_MSG) { |listener, message|
 					@parser.msg_identify = true
@@ -158,10 +169,12 @@ class Butler
 			# (optionally passing a test given as block) is received,
 			# returns the message received that matches.
 			# returns nil if it times out before a match
-			def wait_for(symbol, timeout=nil, &test)
+			def wait_for(symbol, timeout=nil, opt={}, &test)
+				listener = nil
 				timeout(timeout) {
 					queue    = Queue.new
 					listener = subscribe(symbol) { |l, m| queue.push(m) }
+					opt[:prepare].call if opt.has_key?(:prepare)
 					begin
 						message = queue.shift
 					end until block_given? ? yield(message) : true
@@ -190,7 +203,7 @@ class Butler
 			end
 	
 			# login under nick, user, real
-			def login(nick, user, real)
+			def login(nick, user, real, serverpass=nil)
 				queue, nick_change = nil, nil
 				number = 0
 				timeout(@timeout[:login]) {
@@ -205,7 +218,7 @@ class Butler
 						@myself.nick = change
 					}
 					@thread_read = Thread.new(&method(:thread_read))
-					@irc.login(nick, user, real)
+					@irc.login(nick, user, real, serverpass)
 					queue.shift
 				}
 				true
@@ -287,18 +300,20 @@ class Butler
 			# normally this thread is alive as long as the client is connected to the server
 			def thread_read
 				while message = @irc.read; process(message); end
+				@irc.close
 				on_disconnect(:disconnect)
 			rescue Terminate => e		# got the termination signal
 				info("Terminating read thread")
+				@irc.close
 				on_disconnect(:quit)
 			rescue Errno::EPIPE => error	# irc server closed connection
 				exception(error)
+				@irc.close
 				on_disconnect(:disconnect)
 			rescue Exception => error
 				exception(error)
-				on_disconnect(:error)
-			ensure
 				@irc.close
+				on_disconnect(:error)
 			end
 			
 			# Called on disconnects, see disconnect_callback attribute documentation
@@ -323,17 +338,21 @@ class Butler
 			
 			# process a Butler::IRC::Message, normally fed from thread_read.
 			def process(message)
-				message = @parser.server_message(message)
-				message.transcode!(@channel_charset[message.channel], @client_charset)
-				@listener.synchronized_each_for(message.symbol) { |listener|
-					listener.call(message)
-				}
+				dispatch(@parser.server_message(message))
 			rescue Terminate, Errno::EPIPE => error
 				raise error # on these errors we got to get out of the loop
 			rescue Exception => error
 				exception(error) # those errors are logged, reading goes on
 			end
 			
+			# dispatch a message
+			def dispatch(message)
+				message.transcode!(@channel_charset[message.channel], @client_charset)
+				@listener.synchronized_each_for(message.symbol) { |listener|
+					listener.call(message)
+				}
+			end
+			
 			def inspect # :nodoc:
 				"#<%s:0x%08x irc=%s>" %  [
 					self.class,
@@ -343,4 +362,4 @@ class Butler
 			end
 		end # Client
 	end # IRC
-end # Butler
+end # Butler