butler 1.8.3 → 1.9.0

data/lib/butler/irc/string.rb

@@ -46,10 +46,6 @@ class String
 		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
 		prefixes	= Butler::IRC::User::PREFIXES.dup
@@ -126,7 +122,7 @@ class String
 	
 	Note: not every font/size combination displays bold/italic text.
 =end
-	def mirc_formatted # FIXME - copied code, ugly & slow
+	def mirc_formatted
 		self.gsub( /!\[(.*?)\]/ ) do |match|
 			codes = $1.downcase
 			repl = ""

data/lib/butler/plugin.rb

@@ -42,8 +42,9 @@ class Butler
 				@name         = File.basename(base).freeze
 				@commands     = []
 				@listener     = []
+				@schedules    = []
 				@mapping_type = Hash.new { |h,k| MappingTypes[k] }
-				@config       = ConfigProxy.new(@butler.config, "plugin/#{name}")
+				@config       = ConfigProxy.new(@butler.config, "plugins/#{base}")
 	
 				if File.directory?(path) then
 					raise "Not supported yet"
@@ -84,18 +85,20 @@ class Butler
 			
 			# a class instance variable for the plugin
 			# defines attr_readers for it
-			def plugin_attribute(*names)
+			def plugin_attribute(name, initial_value=nil)
 				(class <<self; self; end).instance_eval {
-					attr_reader(*names)
+					attr_reader(name)
 				}
+				instance_variable_set(:"@#{name}", initial_value)
 			end
 
 			# a class instance variable for the plugin,
 			# defines attr_accessors for it
-			def plugin_accessor(*names)
+			def plugin_accessor(name, initial_value=nil)
 				(class <<self; self; end).instance_eval {
-					attr_accessor(*names)
+					attr_accessor(name)
 				}
+				instance_variable_set(:"@#{name}", initial_value)
 			end
 			
 			def create_templates(tmpl, name) # :nodoc:
@@ -149,15 +152,21 @@ class Butler
 			end
 			
 			def every(*args, &block)
-				@butler.scheduler.every(*args, &block)
+				scheduler = @butler.scheduler.every(*args, &block)
+				@schedules << scheduler
+				scheduler
 			end
 
 			def at(*args, &block)
-				@butler.scheduler.at(*args, &block)
+				scheduler = @butler.scheduler.at(*args, &block)
+				@schedules << scheduler
+				scheduler
 			end
 
 			def timed(*args, &block)
-				@butler.scheduler.timed(*args, &block)
+				scheduler = @butler.scheduler.timed(*args, &block)
+				@schedules << scheduler
+				scheduler
 			end
 
 			def subscribe(*args, &block)
@@ -179,6 +188,7 @@ class Butler
 				info("Unloading plugin '#{@base}' (#{self})")
 				@commands.each { |command| @butler.delete_command(command) }
 				@listener.each { |listener| listener.unsubscribe }
+				@schedules.each { |scheduler| scheduler.finished }
 			end
 			
 		end
@@ -243,24 +253,47 @@ class Butler
 		# 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}")
+			if @message.remote? then
+				@message.answer(text)
+			else
+				@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
 		end
 		
 		# Same as answer, but 'more' gets a lead prefixed (see Butler::Plugin::More for more info)
-		def answer_with_lead(lead, string, vars={})
+		def answer_with_lead(lead, text, vars={})
+			lead = localize(lead, vars) if lead.kind_of?(Symbol)
 			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}")
+			if @message.remote? then
+				@message.answer(lead+text) # FIXME, what does More use to concat lead & text?
+			else
+				@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
+		end
+
+		# Same as answer, but will not prefix the nick in public messages
+		def say(text, vars={})
+			text = localize(text, vars) if text.kind_of?(Symbol)
+			if @message.remote? then
+				@message.answer(text)
+			else
+				@message.from.session["more"] = More.new(
+					@message,
+					nil,
+					text.mirc_formatted
+				)
+				@message.answer(@message.from.session['more'].show)
+			end
 		end
 
 
@@ -300,4 +333,4 @@ class Butler
 			@butler.notice(string.mirc_formatted, *args)
 		end
 	end
-end
+end

data/lib/butler/plugin/configproxy.rb

@@ -17,6 +17,7 @@ class Butler
 				@config = config
 				@base   = base
 				@mutex  = Mutex.new
+				FileUtils.mkdir_p("#{config.base}/#{File.dirname(base)}")
 			end
 			
 			# Synchronize access to this piece of config

data/lib/butler/plugin/more.rb

@@ -9,7 +9,7 @@
 class Butler
 	class Plugin
 		class More
-			MessageLength = 300
+			MessageLength = 500
 			String        = {
 				"en" => "![c(white),(black)]more...![o]".mirc_formatted,
 				"de" => "![c(white),(black)]mehr...![o]".mirc_formatted,
@@ -54,7 +54,7 @@ class Butler
 			
 			# show adds lead and tail depending on requirement (no tail for last message, no lead if empty)
 			def show
-				"#{lead+': ' if lead}#{@pieces[@index]}#{', '+tail if succ?}"
+				"#{lead+': ' if lead}#{@pieces[@index]}#{' '+tail if succ?}"
 			end
 		
 			def tail

data/lib/butler/plugins.rb

@@ -102,6 +102,8 @@ class Butler
 			end
 			begin
 				unload(base) if loaded?(base) # a plugin may not be loaded twice
+			rescue Interrupt
+				raise
 			rescue Exception => e
 				exception(e)
 			end
@@ -114,6 +116,8 @@ class Butler
 				plugin.load_plugin(@butler, base, path)
 				plugin.class_eval(File.read(codefile), codefile)
 				plugin.on_load
+			rescue Interrupt
+				raise
 			rescue Exception => e
 				e.extend Exception::Detailed
 				e.prepend "Loading plugin #{base} failed."
@@ -126,8 +130,10 @@ class Butler
 		
 		def unload(base)
 			begin
-				@plugins[base].on_unload
 				@plugins[base].unload_plugin
+				@plugins[base].on_unload
+			rescue Interrupt
+				raise
 			rescue Exception => e
 				e.extend Exception::Detailed
 				e.prepend "Exception raised while unloading plugin #{base}."

data/lib/butler/remote/connection.rb

@@ -0,0 +1,113 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'timeout'
+
+
+
+class Butler
+	module Remote
+		class Connection
+			def self.open_thread(server, socket)
+				connection = new(server, socket)
+				Thread.new {
+					connection.start
+					connection.read_loop
+				}
+				connection
+			end
+
+			def self.open(server, socket)
+				connection = new(server, socket)
+				connection.start
+				connection
+			end
+			
+			include Log::Comfort
+			
+			attr_reader :user
+			
+			def initialize(server, socket)
+				@server = server
+				@socket = socket
+				@user   = nil
+				@logger = nil
+			end
+			
+			def start
+				puts("Please identify yourself")
+				tries    = 3
+				access   = nil
+				username = nil
+				timeout(180) {
+					tries.times { |i|
+						@socket.print("Username: ")
+						username = @socket.gets.chomp
+						@socket.print("Password: ")
+						password = @socket.gets.chomp
+						access   = @server.login(username, password)
+						break if access
+						sleep(i)
+						puts("Failed to authenticate, please try again.")
+					}
+				}
+				return quit("Failed to authenticate") unless access
+				puts "You're logged in, welcome #{username}."
+				puts "To terminate the session, enter an empty line."
+				puts ""
+				@user = User.new(username, access)
+			rescue Timeout::Error
+				quit("Login timed out.")
+			rescue Exception => e
+				exception(e)
+				quit(nil)
+			end
+	
+			def read_loop
+				while line = @socket.gets
+					line.chomp!
+					p line
+					break if line.empty?
+					begin
+						@server.dispatch(Message.new(@server, self, @user, line))
+
+					# on these errors we got to get out of the loop
+					rescue Errno::EPIPE, SocketError
+						raise
+					# all others should not put the read-thread in any danger
+					rescue Exception => e
+						exception(e)
+					end
+				end
+			rescue Exception => e
+				exception(e)
+			ensure
+				@server.disconnected(self)
+				close
+			end
+
+			def puts(*text)
+				@socket.puts(*text)
+			end
+
+			def quit(reason=nil)
+				puts reason if reason
+				close
+				@server.disconnected(self)
+			end
+
+			def closed?
+				@socket.closed?
+			end
+
+			def close
+				@socket.close unless @socket.closed?
+			end
+		end
+	end
+end

data/lib/butler/remote/message.rb

@@ -0,0 +1,157 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+class Butler
+	module IRC
+		class Message
+			def remote?
+				false
+			end
+		end
+	end
+
+	module Remote
+		# Butler::Remote::Message emulates a Butler::IRC::Message
+		class Message
+			Command = "privmsg".freeze
+
+			attr_reader :text
+			attr_reader :from
+
+			# the language of this message, as determined by butler
+			attr_accessor :language
+	
+			# the invocation-sequence (e.g. "butler, "), nil if none was used (e.g. in
+			# private messages)
+			attr_accessor :invocation
+	
+			def initialize(server, client, from, text)
+				@server         = server
+				@client         = client
+				@from           = from
+				@text           = text
+				@language       = nil
+				@invocation     = nil
+				@arguments      = nil
+				@post_arguments = nil
+			end
+	
+			# FIXME complete
+			def initialize_copy(original) #:nodoc:
+				super
+				@server  = original.instance_variable_get(:@server)
+				@client  = original.instance_variable_get(:@client)
+				@from    = original.instance_variable_get(:@from)
+				@text    = original.text.dup
+			end
+
+			# parses a given string into argument-tokens. a token is either a word or a quoted string. escapes are respected.
+			# 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
+			end
+		
+			# FIXME due to it's current working, post_arguments will strip formatting
+			# 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
+			end
+
+			alias raw text
+			alias params text
+			
+			def symbol
+				:PRIVMSG
+			end
+			
+			def prefix
+				nil
+			end
+
+			def command
+				Command
+			end
+			
+			def realm
+				:private
+			end
+			
+			def remote?
+				true
+			end
+			
+			def private?
+				true
+			end
+			
+			def public?
+				false
+			end
+			
+			def answer(text)
+				@client.puts text.mirc_stripped
+			end
+
+			def identified?
+				true
+			end
+			
+			def for
+				@server.myself
+			end
+	
+			def channel
+				nil
+			end
+	
+			def text
+				@text
+			end
+
+			# access to raw parsed data
+			def [](index)
+				nil
+			end
+
+			def []=(index, value)
+				raise NoMethodError, "Can't write to #{index}" # unless respond_to?("#{index}=")
+			end
+			
+			def has_key?(key)
+				false #@fields.has_key?(key.to_sym)
+			end
+			
+			# change charset encoding
+			def transcode!(from, to)
+			end
+
+			def ===(other)
+				case other
+					when Symbol: :PRIVMSG == other
+					when Regexp: @text =~ other
+				end
+			end
+	
+			# return a hash of the fields
+			def to_hash
+				raise NoMethodError
+			end
+		end
+	end
+end