butler 1.8.2 → 1.8.3

data/lib/butler.rb

@@ -164,6 +164,7 @@ class Butler
 				conf[k] = v
 			}
 			FileUtils.cp_r(path.plugin_repository, bot_path)
+			FileUtils.cp_r(path.service_repository, bot_path)
 		end
 
 		# deletes a bot

data/lib/butler/bot.rb

@@ -12,6 +12,7 @@ require 'butler/debuglog'
 require 'configuration'
 require 'log'
 require 'butler/plugins'
+require 'butler/services'
 require 'butler/session'
 require 'ruby/string/arguments'
 require 'ruby/string/post_arguments'
@@ -33,6 +34,7 @@ class Butler
 		attr_reader :path
 		attr_reader :plugins
 		attr_reader :scheduler
+		attr_reader :services
 
 		# FIXME, raise if selftest fails
 		def initialize(path, name, opts={})
@@ -47,6 +49,7 @@ class Butler
 				:lib        => @base+'/lib',
 				:log        => @base+'/log',
 				:plugins    => @base+'/plugins',
+				:services   => @base+'/services',
 				:strings    => @base+'/strings'
 			)
 			$LOAD_PATH.unshift(@path.lib)
@@ -74,7 +77,9 @@ class Butler
 
 			# { lang => { trigger => SortedSet[ *commands ] } }
 			@commands  = {}
-			@plugins   = Plugins.new(self, @base+'/plugins')
+			@services  = Services.new(self, @path.services)
+			@services.load_all
+			@plugins   = Plugins.new(self, @path.plugins)
 			
 			if $DEBUG then
 				@irc.extend DebugLog
@@ -117,7 +122,7 @@ class Butler
 						}
 						break if command.abort_invocations?
 					else
-						info("#{message.from} (#{message.from.access.id}) had no authorization for 'plugin/#{command.plugin.base}'")
+						info("#{message.from} (#{message.from.access.oid}) had no authorization for 'plugin/#{command.plugin.base}'")
 					end
 				end
 			}
@@ -150,6 +155,7 @@ class Butler
 		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"]

data/lib/butler/control.rb

@@ -27,6 +27,7 @@ class Butler
 				:config   => Gem.datadir("butler")+'/config.yaml',          # REPLACE: :config   => %CONFIG_DIR%+'/config.yaml',
 				:dialogs  => Gem.datadir("butler")+'/dialogs',              # REPLACE: :dialogs  => %DIALOGS_DIR%,
 				:plugins  => Gem.datadir("butler")+'/plugins',              # REPLACE: :plugins  => %PLUGINS_DIR%,
+				:services => Gem.datadir("butler")+'/services',             # REPLACE: :services => %SERVICES_DIR%,
 				:strings  => Gem.datadir("butler")+'/strings',              # REPLACE: :strings  => %STRINGS_DIR%,
 				:man      => Gem.datadir("butler")+'/man1',                 # DELETE
 			})
@@ -78,7 +79,8 @@ class Butler
 		def butler_path(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/initialvalues.rb

@@ -15,7 +15,7 @@ class Butler
 		BOTPATH/access/user
 		BOTPATH/log
 		BOTPATH/plugins
-		BOTPATH/strings
+		BOTPATH/services
 	].map { |e| [e, 0755] }
 	# first one is the base-directory
 	ConfigurationStructure = %w[

data/lib/butler/irc/client.rb

@@ -120,6 +120,12 @@ class Butler
 				@myself              = @users.myself
 	
 				subscribe(:PING, 100) { |listener, message| @irc.pong(message.pong) }
+				subscribe(:ISUPPORT) { |listener, message|
+					# @parser. ...
+				}
+				subscribe(:RPL_IDENTIFY_MSG) { |listener, message|
+					@parser.msg_identify = true
+				}
 			end
 			
 			# Load an additional command-set for @parser

data/lib/butler/irc/message.rb

@@ -46,15 +46,16 @@ class Butler
 	
 				#specific data
 				@fields = Hash.new { |h,k| raise IndexError, "No member '#{k}' available." }.merge({
-					:raw     => @raw,
-					:prefix  => @prefix,
-					:command => @command,
-					:params  => @params,
-					:symbol  => @symbol,
-					:from    => nil,
-					:for     => nil,
-					:channel => nil,
-					:text    => nil,
+					:raw        => @raw,
+					:prefix     => @prefix,
+					:command    => @command,
+					:params     => @params,
+					:symbol     => @symbol,
+					:from       => nil,
+					:for        => nil,
+					:channel    => nil,
+					:text       => nil,
+					:identified => nil,
 				})
 			end
 	
@@ -77,6 +78,10 @@ class Butler
 				end
 			end
 			
+			def identified?
+				@fields[:identified]
+			end
+			
 			def from
 				@fields[:from]
 			end

data/lib/butler/irc/parser.rb

@@ -63,14 +63,17 @@ class Butler
 			attr_reader :users
 			attr_reader :channels
 			attr_reader :commands
+
+			attr_accessor :msg_identify
 	
 			def initialize(client, users, channels, *command_sets)
-				@client      = client
-				@users       = users
-				@channels    = channels
-				@commands    = Commands.new(*command_sets)
+				@client       = client
+				@users        = users
+				@channels     = channels
+				@commands     = Commands.new(*command_sets)
+				@msg_identify = false
 			end
-	
+			
 			# parses an incomming message and returns a Message object from which you
 			# can easily access parsed data.
 			# Expects the newlines to be already chomped off.

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

@@ -9,6 +9,33 @@
 # A list with all common, but non-rfc2812 IRC-Commands and their parsing
 # instructions.
 
+#
+alter("005", :ISUPPORT) { |message, parser|
+	hash = {
+		"CHANNELLEN" => 50,
+		"NICKLEN"    => 8,
+	}
+	message.params.sub(/\s+:.*?$/, '').split(/ /).each { |support|
+		name, value = support.split(/=/,2)
+		hash[name]  = case value
+			when nil
+				true
+			when "NICKLEN"
+				value.to_i
+			when "PREFIX"
+				modes, prefixes = value[1..-1].split(/\)/, 2)
+				value = {}
+				modes.split(//).zip(prefixes.split(//)) { |k,v| value[k] = v }
+				value
+			when "MAXCHANNELS"
+				value.to_i
+			else value
+		end
+	}
+	message.create_member(:support, hash)
+	p hash
+}
+
 # Seen:
 #   - ConferenceRoom (irc.bluewin.ch)
 add("007", :UNK_007)
@@ -26,7 +53,12 @@ add("266", :RPL_GLOBALUSERS)
 
 # Seen:
 #   - hyperion-1.0.2b (irc.freenode.net)
-add("290", :RPL_IDENTIFY_MSG)
+#   States what kind of messages will be identified
+add("290", :RPL_IDENTIFY_MSG) { |message, parser|
+	types = {}
+	message.params.scan(/\S+/).each { |k| types[k] = true }
+	message.create_member(:types, types)
+}
 
 # Seen:
 #  - ConferenceRoom (irc.bluewin.ch), sent if a nick is registered

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

@@ -79,6 +79,9 @@ add("part",    :PART,    /^([^\x00\x07\x10\x0D\x20,:]+)(?: :(.*))?/, [:channel,
 add("ping",    :PING,    /:(.*)/, [:pong])
 add("pong",    :PONG)
 add("privmsg", :PRIVMSG, /(\S+) :(.*)/, [:for, :text]) { |message, parser|
+	if parser.msg_identify && message.text.slice!(/^[+-]/) == '+' then
+		message.alter_member(:identified, true)
+	end
 	if message.channel then
 		message.create_member(:realm, :public)
 		message.create_method(:private?) { false }
@@ -104,8 +107,8 @@ add("topic",   :TOPIC, /(\S+) :(.*)/, [:channel, :text])
 add("001", :RPL_WELCOME)
 add("002", :RPL_YOURHOST)
 add("003", :RPL_CREATED)
-add("004", :RPL_MYINFO)
-add("005", :RPL_ISUPPORT)
+add("004", :RPL_MYINFO, /(\S+) (\S+) (\S+) (\S+)/, [:servername, :version, :user_modes, :channel_modes])
+add("005", :RPL_BOUNCE)
 
 
 

data/lib/butler/plugin.rb

@@ -82,12 +82,28 @@ class Butler
 				info("Loaded plugin '#{@base}' (#{self})")
 			end
 			
-			def create_templates(tmpl, name)
+			# a class instance variable for the plugin
+			# defines attr_readers for it
+			def plugin_attribute(*names)
+				(class <<self; self; end).instance_eval {
+					attr_reader(*names)
+				}
+			end
+
+			# a class instance variable for the plugin,
+			# defines attr_accessors for it
+			def plugin_accessor(*names)
+				(class <<self; self; end).instance_eval {
+					attr_accessor(*names)
+				}
+			end
+			
+			def create_templates(tmpl, name) # :nodoc:
 				tmpl.each { |key,value|
 					begin
 						tmpl[key] = Templater.new(value)
 					rescue Exception => e
-						e.extend Exception::Detail
+						e.extend Exception::Detailed
 						e.prepend "Could not map #{key} in #{@base} (#{name})."
 						exception(e)
 					end
@@ -209,6 +225,10 @@ class Butler
 			end
 		end
 		
+		def service(name)
+			@butler.services[name]
+		end
+		
 		def unknown(n=-1)
 			"Unknown argument #{@message.arguments[n]} for #{@message.arguments[0...n].join(' ')}"
 		end

data/lib/butler/plugins.rb

@@ -12,16 +12,10 @@ require 'butler/dialog'
 require 'iterator'
 require 'log/comfort'
 require 'ruby/exception/detailed'
+require 'ruby/string/camelcase'
 
 
 
-class String
-	# CamelCase a string, e.g. "foo_bar" becomes "FooBar"
-	def camelcase
-		scan(/[^_]+/).map { |s| s.capitalize }.join("")
-	end
-end
-
 class Butler
 	# Plugins manages the plugins in Butler
 	# It uses 
@@ -38,6 +32,7 @@ class Butler
 			@plugins   = {}
 			@constants = {}
 			@butler    = butler
+			@logger    = butler.logger
 		end
 		
 		# returns a list with first-level groups

data/lib/butler/service.rb

@@ -0,0 +1,73 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'log/comfort'
+require 'ostructfixed'
+
+
+
+class Butler
+	module Service
+		include Log::Comfort
+
+		attr_reader :butler
+		attr_reader :message
+		attr_reader :name
+		attr_reader :rdn
+		attr_reader :version
+		
+		# this method is called to initialize the plugin-class,
+		# do not override
+		def load_service(butler, path, rdn, name, version) # :nodoc:
+			@butler   = butler
+			@path     = OpenStruct.new(
+				:base     => path,
+				:fixtures => path+'/fixtures.rb'
+			)
+			@name     = name
+			@rdn      = rdn
+			@version  = version
+			@listener = []
+			load(@path.fixtures) if File.exist?(@path.fixtures)
+		end
+		
+		def register(object)
+			@butler.services.register(self, object)
+		end
+
+		def every(*args, &block)
+			@butler.scheduler.every(*args, &block)
+		end
+
+		def at(*args, &block)
+			@butler.scheduler.at(*args, &block)
+		end
+
+		def timed(*args, &block)
+			@butler.scheduler.timed(*args, &block)
+		end
+
+		def subscribe(*args, &block)
+			listener = @butler.subscribe(*args, &block)
+			@listener << listener
+			listener
+		end
+		
+		def unload_plugin
+			info("Unloading plugin '#{@base}' (#{self})")
+			@commands.each { |command| @butler.delete_command(command) }
+			@listener.each { |listener| listener.unsubscribe }
+		end
+		
+		def on_load(*args); end
+		def on_login(*args); end
+		def on_disconnect(*args); end
+		def on_quit(*args); end
+		def on_unload(*args); end
+	end
+end

data/lib/butler/services.rb

@@ -0,0 +1,65 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'butler/service'
+require 'log/comfort'
+require 'ruby/exception/detailed'
+require 'ruby/string/camelcase'
+
+
+
+class Butler
+	# Plugins manages the plugins in Butler
+	# It uses 
+	class Services
+		include Log::Comfort
+
+		def initialize(butler, services_dir)
+			@butler    = butler
+			@logger    = butler.logger
+			@dir       = File.expand_path(services_dir).freeze
+			raise ArgumentError, "#{@dir} is not a directory" unless File.directory?(@dir)
+			@services  = {}
+		end
+		
+		def load_all
+			Dir.glob("#{@dir}/*/*/*/service.rb") { |file|
+				load(file)
+			}
+		end
+		
+		def load(file)
+			rdn, name, version = file.match(%r{([^/]+)/([^/]+)/([^/]+)/service\.rb$}).captures
+			path     = File.dirname(file)
+
+			begin
+				constant = "%s_%08X" %  [name.camelcase, rand(0xffffffff)]
+			end while Butler::Plugins.const_defined?(constant)
+			service = Butler::Services.const_set(constant, Module.new)
+			service.extend(Butler::Service)
+			service.logger = @butler.logger
+			begin
+				service.load_service(@butler, path, rdn, name, version)
+				service.class_eval(File.read(file), file)
+				service.on_load
+			rescue Exception => e
+				e.extend Exception::Detailed
+				e.prepend "Loading service #{rdn}.#{name} #{version} failed."
+				exception(e)
+			end
+		end
+		
+		def register(service, obj)
+			@services[service.name] = obj
+		end
+		
+		def [](name)
+			@services[name]
+		end
+	end
+end

data/lib/butler/version.rb

@@ -10,7 +10,7 @@ class Butler #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 8
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end