butler 1.8.1 → 1.8.2

data/data/butler/plugins/service/define.rb

@@ -17,10 +17,10 @@ trigger "define"
 def on_trigger
 	word     = @message.post_arguments[1]
 	doc      = Hpricot(open(Query%[@message.language, CGI.escape(word)]))
-	see_also = (doc/"//div[@id='res']/font[1]/p/a")[5..-1].map { |e| e.inner_text }
-	found    = (doc/"//div[@id='res']/ul/font/li").find { |e| (e/"//a").inner_text.include?("wikipedia.org") }
+	see_also = (doc/"//font[1]/p/a")[5..-1].map { |e| e.inner_text }
+	found    = (doc/"//ul/font/li").find { |e| (e/"//a").inner_text.include?("wikipedia.org") }
 	if found then
-		answer(found.inner_text.sub(%r{\w+\.wikipedia\.org/wiki/.*?$}, ''))
+		more('![b]word![o]', found.inner_text.sub(%r{\w+\.wikipedia\.org/wiki/.*?$}, ''))
 	else
 		answer(:not_found, :search_string => word)
 	end

data/data/butler/plugins/service/more.rb

@@ -0,0 +1,40 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+def on_trigger(*arguments)
+	more = @message.from.session["more"]
+	if more && more.succ? then
+		more.succ
+		answer(more.show)
+	else
+		answer(:no_more)
+	end
+	@message.from.session.delete("more") unless more and more.succ?
+end
+
+__END__
+--- 
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:help:
+  en:
+    "": "Continue output."
+:revision:
+  :plugin: 1
+:strings:
+  :no_more:
+    en: Nothing more to display.
+:summary:
+  en: "Continue output."
+:trigger:
+  en: more
+  de: mehr
+:usage:
+  en: "![b]more![o]"

data/data/butler/plugins/util/cycle.rb

@@ -14,7 +14,7 @@ configuration(
 
 trigger "cycle"
 
-def on_part(listener, user, channel)
+def on_part(listener, user, channel, reason)
 	if (
 		user != butler.myself &&                      # don't trigger if butler itself parts
 		channel.length == 1 &&                        # trigger only if butler is the last remaining

data/data/butler/plugins/util/load.rb

@@ -6,11 +6,9 @@
 
 
 
-trigger "load"
-
 def on_trigger
-	ps_out = `ps -o vsz,rss,%cpu,%mem -p #{Process.pid}`
-	vsz, rss, cpu, pmem = ps_out.scan(/\d+(?:\.\d+)?/).map { |e| e.to_f }
+	ps_out = `ps -o vsz,rss,%cpu,%mem -p #{Process.pid.to_i}`
+	vsz, rss, cpu, pmem = ps_out.scan(/\d+(?:[.,]\d+)?/).map { |e| e.gsub(/,/,'.').to_f } # ps on 10.5.1 outputs ',' instead of '.' for MEM%
 	virtual, real = (vsz-rss).div(1024), rss.div(1024)
 	answer(:memusage, :real => real, :virtual => virtual, :cpu => cpu, :pmem => pmem)
 rescue Exception => e
@@ -29,10 +27,12 @@ __END__
   :author: "Stefan Rusterholz"
 :usage:
   en: "![b]load![o]"
+:trigger:
+  en: load
 :strings:
   :memusage:
     en: |
-      Usage: <%= real %>MB, <%= virtual %>MB (real/virtual), <%= cpu %>% CPU, <%= pmem %>% Memory.
+      Memory: <%= real %>MB real, <%= virtual %>MB virtual (<%= pmem %>%), CPU: <%= cpu %>%.
   :failure:
     en: |
       Failed with exception <%= exception %>.

data/data/butler/plugins/util/pong.rb

@@ -6,8 +6,6 @@
 
 
 
-trigger "ping"
-
 def on_trigger
 	message.answer("pong")
 end
@@ -22,6 +20,9 @@ __END__
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
+:trigger:
+  en:
+    ping
 :usage:
   en: "![b]ping![o]"
 :help:

data/lib/access/privilege.rb

@@ -58,6 +58,15 @@ class Access
 		def hash
 			@id.hash
 		end
+
+		def inspect # :nodoc:
+			"#<%s:0x%08x id=%s description=%s>" %  [
+				self.class,
+				object_id << 1,
+				@id,
+				@description
+			]
+		end
 	end
 	
 	class Privileges
@@ -118,5 +127,13 @@ class Access
 			return true if yield("")
 			false
 		end
+		
+		def inspect # :nodoc:
+			"#<%s:0x%08x %s>" %  [
+				self.class,
+				object_id << 1,
+				@privileges.keys.join(', ')
+			]
+		end
 	end
 end

data/lib/access/role.rb

@@ -12,6 +12,7 @@ class Access
 	# an additional restriction (which is applied globally).
 	#
 	class Role
+		include Savable
 
 		# The module to extend the Database manager
 		module Base
@@ -36,7 +37,7 @@ class Access
 				data[:roles] = data[:roles].map { |role| roles[role] }
 				array        = data.values_at(:id, :description)
 				array       << data
-				role         = new(*array)
+				role         = Role.new(*array)
 				role.access  = access
 				role.base    = self
 				role
@@ -48,6 +49,12 @@ class Access
 		
 		# The description of the role
 		attr_reader :description
+		
+		# The roles this role belongs to
+		attr_reader :roles
+		
+		# Privileges this role has granted
+		attr_reader :privileges
 
 		# Create a new Role
 		# role is a role-id, should be \w+
@@ -57,7 +64,13 @@ class Access
 			@id          = role
 			@privileges  = Privileges.new(self, other[:privileges])
 			@roles       = Roles.new(self, other[:roles])
-			@description = description || "No description"
+			@description = (description || "No description").freeze
+		end
+		
+		# Change the description of this role
+		def description=(value)
+			@description = value.freeze
+			save
 		end
 		
 		# :nodoc:
@@ -87,6 +100,16 @@ class Access
 		def hash
 			@id.hash
 		end
+
+		def inspect # :nodoc:
+			"#<%s:0x%08x description=%s privileges=%s roles=%s>" %  [
+				self.class,
+				object_id << 1,
+				@description,
+				@privileges.inspect,
+				@roles.inspect,
+			]
+		end
 	end
 	
 	# A list of roles
@@ -133,5 +156,13 @@ class Access
 		def storable
 			@roles.map { |role| role.id }
 		end
+
+		def inspect # :nodoc:
+			"#<%s:0x%08x roles=%s>" %  [
+				self.class,
+				object_id << 1,
+				@roles.map { |r| r.id }.join(', '),
+			]
+		end
 	end
 end

data/lib/access/savable.rb

@@ -16,8 +16,14 @@ class Access
 		# The "Base" instance that manages this record 
 		attr_accessor :base
 
+		# save changes to this record
 		def save
 			base.save(id())
 		end
+		
+		# delete this record from the database
+		def delete
+			base.delete(id())
+		end
 	end
 end

data/lib/access/yamlbase.rb

@@ -81,8 +81,7 @@ class Access
 		alias add <<
 
 		#	Delete a record from the storage
-		def delete(record)
-			id	= record.kind_of?(@type) ? record.id : record
+		def delete(id)
 			@data.delete(id)
 			File.delete(filename(id))
 		end

data/lib/butler/bot.rb

@@ -8,18 +8,20 @@
 
 require 'butler'
 require 'butler/irc/client'
+require 'butler/debuglog'
 require 'configuration'
 require 'log'
 require 'butler/plugins'
+require 'butler/session'
 require 'ruby/string/arguments'
 require 'ruby/string/post_arguments'
 require 'scheduler'
 require 'set'
 require 'thread'
+require 'timeout'
 
 
 
-# FIXME: credits @ daemonize lib
 class Butler
 	class Bot < IRC::Client
 		include Log::Comfort
@@ -42,10 +44,13 @@ class Butler
 				:access     => @base+'/access',
 				:base       => @base,
 				:config     => @base+'/config',
+				:lib        => @base+'/lib',
 				:log        => @base+'/log',
 				:plugins    => @base+'/plugins',
 				:strings    => @base+'/strings'
 			)
+			$LOAD_PATH.unshift(@path.lib)
+			require 'butlerinit' if File.exist?(@path.lib+"/butlerinit.rb")
 			@logger     = $stderr
 			@config     = Configuration.new(@base+'/config')
 			@scheduler  = Scheduler.new
@@ -71,6 +76,12 @@ class Butler
 			@commands  = {}
 			@plugins   = Plugins.new(self, @base+'/plugins')
 			
+			if $DEBUG then
+				@irc.extend DebugLog
+				@irc.raw_log = File.open(@path.log+'/debug.log', 'wb')
+				@irc.raw_log.sync = true
+			end
+			
 			subscribe(:PRIVMSG, -10, &method(:invoke_commands))
 			subscribe(:NOTICE,  -10, &method(:invoke_commands))
 
@@ -111,7 +122,7 @@ class Butler
 				end
 			}
 		end
-		
+
 		def add_command(command)
 			@commands[command.language] ||= {}
 			@commands[command.language][command.trigger] ||= SortedSet.new
@@ -148,26 +159,46 @@ class Butler
 				@config["connections/main/real"]
 			)
 			info("Logged in")
-			# FIXME, use #same_nick?
-			if pass && @myself.nick.downcase != nick.downcase then
+			if pass && @myself.nick.same_nick?(nick) then
 				@irc.ghost(nick, pass)
 				sleep(1) # FIXME, do a wait_for or similar
 				@irc.nick(nick)
 			end
 			@irc.identify(pass) if pass
 			join(*@config["connections/main/channels"])
+			plugins_dispatch(:on_login, "main")
 		end
 		
 		def on_disconnect(reason)
 			return if reason == :quit
+			plugins_dispatch(:on_disconnect, reason)
 			unless @reconnect[1].zero? then
 				@reconnect[1] -= 1
 				sleep(@reconnect[0])
 				login
 			end
 		end
-					
 		
+		def quit(reason=nil, *args)
+			timeout(3) {
+				plugins_dispatch(:on_quit, reason, *args).join
+			}
+		ensure
+			super(reason)
+		end
+		
+		def plugins_dispatch(event, *args)
+			Thread.new { # avoid total lockup due to an improperly written on_disconnect
+				begin
+					@plugins.instances.each { |plugin|
+						plugin.send(event, *args)
+					}
+				rescue Exception => e
+					exception(e)
+				end
+			}
+		end
+
 		def output_to_logfiles
 			# Errors still go to $stderr, $stdin handles puts as "info" level $stderr prints
 			@logger = Log.file(@path.log+'/error.log')
@@ -186,12 +217,13 @@ class Butler
 		end
 	end # Bot
 	
-	class IRC::Users
+	class IRC::UserList
 		attr_reader :client
 	end
 
 	class IRC::User
 		attr_accessor :access
+		attr_reader   :session
 
 		def authorized?(*args)
 			@access.authorized?(*args)
@@ -200,7 +232,8 @@ class Butler
 		alias butler_initialize initialize unless method_defined? :butler_initialize
 		def initialize(users, *args, &block)
 			butler_initialize(users, *args, &block)
-			@access = users.client.access.default_user
+			@access  = users.client.access.default_user
+			@session = Session.new
 		end
 	end # IRC::User
 

data/lib/butler/debuglog.rb

@@ -0,0 +1,17 @@
+class Butler
+	module DebugLog
+		attr_accessor :raw_log
+	
+		def read
+			data = super
+			@raw_log.printf("%s < %p\n", Time.now, data)
+			data
+		end
+		
+		def write(data)
+			rv = super
+			@raw_log.printf("%s > %p\n", Time.now, data)
+			rv
+		end
+	end
+end

data/lib/butler/dialog.rb

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

data/lib/butler/irc/{channels.rb → channellist.rb}

@@ -8,7 +8,7 @@
 
 require 'butler/irc/string'
 require 'butler/irc/channel'
-require 'butler/irc/users'
+require 'butler/irc/userlist'
 require 'thread'
 
 
@@ -31,7 +31,7 @@ class Butler
 		]
 	
 		# Butler::IRC::Channel represents a channel in IRC.
-		class Channels
+		class ChannelList
 			include Enumerable
 	
 			def initialize(client)

data/lib/butler/irc/client.rb

@@ -1,15 +1,27 @@
-require 'butler/irc/channels'
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'butler/irc/channellist'
+require 'butler/irc/client/filter'
+require 'butler/irc/client/listener'
+require 'butler/irc/client/listenerlist'
 require 'butler/irc/parser'
 require 'butler/irc/socket'
-require 'butler/irc/users'
+require 'butler/irc/userlist'
+require 'butler/irc/whois'
 require 'log/comfort'
 require 'timeout'
 require 'thread'
 
+
+
 class Butler
 	module IRC
-		# Reply for Butler::IRC::Client#whois
-		Whois	= Struct.new(:exists, :nick, :user, :host, :real, :registered, :channels, :server, :idle, :signon)
 	
 		# == Description
 		# Wraps Butler::IRC::Socket, providing methods to be aware of the environment.
@@ -28,7 +40,7 @@ class Butler
 		#       when /#{irc_client.myself.nick}[,:]/
 		#         message.answer("#{message.from.nick}, you spoke to me?")
 		#       when :JOIN
-		#         message.from.notice("Welcome to #{message.channel}!")
+		#         irc_client.irc.notice("Welcome to #{message.channel}!", message.from)
 		#     end
 		#     puts "received: #{message}"
 		#   }
@@ -38,36 +50,7 @@ class Butler
 			include Log::Comfort
 
 			class Terminate < RuntimeError; end
-			# Created by Butler::IRC::Client#subscribe() and similar methods
-			Listener = Struct.new(:priority, :callback, :args, :unsubscriber) unless defined? Listener
-			class Listener
-				alias set_priority priority=
-				private :set_priority
-				private :unsubscriber
-
-				def initialize(priority, callback, args=[], &unsubscriber)
-					super(priority, callback, args, unsubscriber)
-				end
-
-				# will remove this listener from the clients dispatcher forever
-				def unsubscribe
-					unsubscriber.call(self)
-				end
 
-				# set the priority of this listener
-				# see Butler::IRC::Client#subscribe() for infos about priority
-				def priority=(value)
-					set_priority(value)
-					container.sort_by { |l| -l.priority }
-				end
-			end
-			module Filter # :nodoc:
-				attr_accessor :listener
-				def unsubscribe
-					listener.unsubscribe
-				end
-			end
-			
 			# The timeout defaults
 			DefaultTimeout = {
 				:login   => 150,
@@ -92,7 +75,10 @@ class Butler
 			# server_charset
 			attr_reader   :channel_charset
 			
+			# The channels the client participates
 			attr_reader   :channels
+			
+			# The users visible to the client
 			attr_reader   :users
 			
 			# The Butler::IRC::Socket, most send commands have to be used on this
@@ -101,30 +87,37 @@ class Butler
 			# The user representing the bot
 			attr_reader   :myself
 	
+			# A callback invoked on disconnects, accepts one argument: reason, which can be
+			#  * :quit:       you told the client to quit
+			#  * :disconnect: the server disconnected your client
+			#  * :error:      an error occurred in the read-thread (shouldn't happen)
+			attr_accessor :disconnect_callback
+			
+			# Arguments:
+			#  * server: the server to connect to
 			def initialize(server, options={}, &on_disconnect)
-				options          = DefaultOptions.merge(options)
-				@logger          = nil
-				@users           = Users.new(self)
-				@channels        = Channels.new(self)
-				@users.channels  = @channels
-				@channels.users  = @users
-				@parser          = Parser.new(self, @users, @channels, "rfc2812", "generic")
+				options              = DefaultOptions.merge(options)
+				@disconnect_callback = 
+				@logger              = nil
+				@users               = UserList.new(self)
+				@channels            = ChannelList.new(self)
+				@users.channels      = @channels
+				@channels.users      = @users
+				@parser              = Parser.new(self, @users, @channels, "rfc2812", "generic")
 	
-				@client_charset  = options.delete(:client_charset)
-				@server_charset  = options.delete(:server_charset)
+				@client_charset      = options.delete(:client_charset)
+				@server_charset      = options.delete(:server_charset)
 				# proc needed because @server_charset might change
-				@channel_charset = Hash.new { |h,k| @server_charset }.merge(options.delete(:channel_charset))
+				@channel_charset     = Hash.new { |h,k| @server_charset }.merge(options.delete(:channel_charset))
 	
-				@timeout         = DefaultTimeout.merge(options.delete(:timeout))
+				@timeout             = DefaultTimeout.merge(options.delete(:timeout))
 
-				@irc             = Socket.new(options.delete(:server) || server, options) # the socket, all methods to the socket are wrapped
+				@irc                 = Socket.new(options.delete(:server) || server, options) # the socket, all methods to the socket are wrapped
 	
-				@listen          = Hash.new { |h,k| h[k] = [] }
-				@listener        = {}
-				@event_loop      = Queue.new
-				@dispatch_lock   = Mutex.new
-				@thread_read     = nil
-				@myself          = @users.myself
+				@listener            = ListenerList.new
+				@event_loop          = Queue.new
+				@thread_read         = nil
+				@myself              = @users.myself
 	
 				subscribe(:PING, 100) { |listener, message| @irc.pong(message.pong) }
 			end
@@ -139,31 +132,20 @@ class Butler
 			# priority may be any numeric, higher priority is dispatched to first,
 			# lower priority later
 			# returns an Butler::IRC::Client::Listener
-			def subscribe(symbol=nil, priority=0, id=nil, *args, &callback)
-				id              ||= callback
-				raise "#{id} already subscribed" if @listener.has_key?(id)
-				listener          = Listener.new(priority, callback, args) { |item|
-					@dispatch_lock.synchronize {
-						@listener.delete(id)
-						@listen[symbol].delete(item)
-						@listen.delete(symbol) if @listen[symbol].empty?
-					}
-				}
-				@dispatch_lock.synchronize {
-					@listener[id]     = listener
-					@listen[symbol]  << listener
-					@listen[symbol].sort_by { |l| -l.priority }
-				}
+			def subscribe(symbols=nil, priority=0, *args, &callback)
+				listener = Listener.new(symbols, priority, *args, &callback)
+				@listener.subscribe(listener)
 				listener
 			end
+			
+			# subscribe a Listener instance (or anything that emulates its interface)
+			def subscribe_listener(listener)
+				@listener.subscribe(listener)
+			end
 
-			# unsubscribe a listener by id
-			def unsubscribe(id)
-				@dispatch_lock.synchronize {
-					@listener.delete(id)
-					@listen[symbol].delete(item)
-					@listen.delete(symbol) if @listen[symbol].empty?
-				}
+			# unsubscribe a listener
+			def unsubscribe(listener)
+				@listener.unsubscribe(listener)
 			end
 			
 			# blocks current thread until a Message with symbol
@@ -313,7 +295,9 @@ class Butler
 				@irc.close
 			end
 			
+			# Called on disconnects, see disconnect_callback attribute documentation
 			def on_disconnect(reason)
+				@disconnect_callback.call(reasons) if @disconnect_callback
 			end
 			
 			def event_loop(priority=-1)
@@ -335,11 +319,8 @@ class Butler
 			def process(message)
 				message = @parser.server_message(message)
 				message.transcode!(@channel_charset[message.channel], @client_charset)
-				@dispatch_lock.synchronize {
-					@listen[nil].each { |listener| listener.callback.call(listener, message) }
-					if @listen.has_key?(message.symbol)
-						@listen[message.symbol].each { |listener| listener.callback.call(listener, message, *listener.args) }
-					end
+				@listener.synchronized_each_for(message.symbol) { |listener|
+					listener.call(message)
 				}
 			rescue Terminate, Errno::EPIPE => error
 				raise error # on these errors we got to get out of the loop