butler 1.8.0

data/data/butler/plugins/public/login.rb

@@ -0,0 +1,72 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+#extend OnHandlers
+trigger "login"
+
+# FIXME, requires working OnHandlers
+# FIXME, requires Butler::IRC::Message#answer to work with :JOIN
+def on_join
+	if @message.from.user[0,1] == "i" then
+		# check nick->user mappings
+		if user = plugin.config["nickmap"][@message.from.nick] then
+			@message.from.
+			answer(:success)
+		end
+	end
+end
+
+# FIXME, log events
+# FIXME, accept plain login, using IDENT_CAPAB
+def on_trigger
+	return answer(usage) unless [3].include?(@message.arguments.length)
+
+	if access = @butler.access.login(*@message.arguments[1,2]) then
+		@message.from.access = access
+		answer(:success)
+		if @message.public? then
+			@message.from.access.credentials = nil
+			answer(:public_success)
+		end
+	else
+		answer(:failure)
+		answer(:public_failure) if @message.public?
+	end
+end
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+:summary:
+  en: Authenticate to the bot
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:strings:
+  :success:
+    en: You are now authenticated.
+  :failure:
+    en: Could not authenticate you.
+  :public_success:
+    en: |
+      You authenticated yourself in public. Your password has been deleted.
+      Please set a new one immediatly using 'access password ![c(blue)]password![o]'
+  :public_failure:
+    en: |
+      You tried to authenticate yourself in public. Be aware that a public login will result in a reset password.
+      If this was similar to your real password, then please login and set a new one immediatly using 'access password ![(blue)]password![r]'
+:usage:
+  en: |
+    ![b]login![o] ![c(blue)]username password![o]
+:help:
+  en:
+    "": |
+      Using 'login ![c(blue)]username password![o]' you can Authenticate to the bot.
+      Be aware that the bot will delete your password if you authenticate in public as a protection measure.

data/data/butler/plugins/public/usage.rb

@@ -0,0 +1,49 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+trigger "usage"
+
+def on_trigger
+	if @message.arguments.length != 2 then
+		answer(usage)
+	elsif plugin = @butler.plugins.identify(@message.arguments[1]) then
+		answer(@butler.plugins[plugin].plugin_usage(@message))
+	else
+		answer(:no_plugin, :name => @message.arguments[1])
+	end
+end
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+:summary:
+  en: Give information about elementary usage of a plugin
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:strings:
+  :no_plugin:
+    en: |
+      No plugin named <%= name %> loaded.
+:usage:
+  en: |
+    ![b]usage![o] <![c(green)]plugin![o]>
+:help:
+  en:
+    "": |
+      Usage provides you with elementary information on how to use a plugin-command.
+      If you need more information, use the help command.
+    "keyword": |
+      Arguments in green and embraced by <angle brackets> are keyword arguments.
+      Keyword arguments require a specific format.
+    "keyword nick": |
+      A <nick> argument must be a valid (not necessary online) IRC nickname.
+    "keyword channel": |
+      A <channel> argument must be a valid (not necessary existing) IRC channelname.

data/data/butler/plugins/service/clones.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+trigger "clones"
+
+def on_trigger
+	strong = @message.arguments.last != "weak"
+	if (@message.arguments.length == 2 && @message.arguments[1].valid_channelname?) then
+		all_clones = @butler.channels[message.arguments[1]].clones(strong)
+		answer(:clones_in_channel, :channel => message.arguments[1], :count => all_clones.length)
+		answer_clones(all_clones)
+	else
+		all_clones	= @butler.users.clones(strong)
+		answer(:all_clones, :count => all_clones.length)
+		answer_clones(all_clones)
+	end
+end
+
+def answer_clones(all_clones)
+	all_clones.each { |common, clones|
+		answer(:clonelist, :common => common, :clones => clones)
+	}
+end
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+:summary:
+  en: Let butler send a notice to a user or channel
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:strings:
+  :clones_in_channel:
+    en: |
+      Clones in channel <%= channel %> (<%= count %>):
+  :all_clones:
+    en: |
+      All clones (<%= count %>):
+  :clonelist:
+    en: |
+      <%= common %>: <%= clones.map { |u| "#{u.nick}" }.join(", ") %>
+:usage:
+  en: |
+    ![b]notice![o] (![c(green)]nick![o] | ![c(green)]channel![o])
+:help:
+  en:
+    "": |
+      Let butler send a notice to a user or channel.

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

@@ -0,0 +1,47 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'open-uri'
+require 'hpricot'
+require 'cgi'
+
+Query = "http://www.google.com/search?client=butler&rls=%s&q=define:+%s&ie=UTF-8&oe=UTF-8"
+
+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") }
+	if found then
+		answer(found.inner_text.sub(%r{\w+\.wikipedia\.org/wiki/.*?$}, ''))
+	else
+		answer(:not_found, :search_string => word)
+	end
+end
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+  :configuration: 1
+:summary:
+  en: "Use googles define: to find the definition of words."
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:usage:
+  en: "![b]define![o] *search_string"
+:help:
+  en:
+    "": "Use googles define: to find the definition of words."
+:strings:
+  :not_found:
+    en: No search result for '<%= search_string %>'.

data/data/butler/plugins/service/log.rb

@@ -0,0 +1,183 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'sequel/sqlite'
+
+class <<self
+	attr_reader :log_db
+	attr_reader :log_table
+end
+
+@log_db = Sequel.sqlite @butler.path.log+'/log.sqlite'
+
+configuration(
+	"channels" => []
+)
+@log_db.create_table(:log) {
+primary_key :oid, :integer
+int  :time
+str  :channel, :size => 255
+str  :nick,    :size => 48
+int  :type
+text :text
+} unless @log_db.table_exists?(:log)
+@log_table = @log_db[:log]
+
+MessageTypes = [:PRIVMSG, :NOTICE, :JOIN, :PART, :QUIT, :KICK, :KILL]
+
+trigger "log"
+
+def on_trigger
+	case @message.arguments[1]
+		when "list"
+			answer(:list, :channels => plugin.config["channels"])
+		when "on"
+			plugin.config["channels"] |= message.arguments[2..-1]
+			answer(:activated, :channels => message.arguments[2..-1])
+		when "off"
+			plugin.config["channels"] -= message.arguments[2..-1]
+			answer(:deactivated, :channels => message.arguments[2..-1])
+		when "search"
+			text, channel, from = @message.text.match(/search (.*)(?: in channel (#\w+))?(?: from (\w+))?$/).captures
+			text = "%#{text}%" if text
+			filtered = plugin.log_table #.filter { :type == 0 || :type == 1 }
+			filtered = filtered.filter { :nick == from } if from
+			filtered = filtered.filter { :nick == channel } if channel
+			filtered = filtered.filter { :text =~ text } if text
+			count = filtered.count
+			if count.zero? then
+				answer(:no_match)
+			else
+				upper = [5,count].min
+				answer("Found (1-#{upper} of #{count}):")
+				filtered.order(:time.DESC).first(5).each_with_index { |row, index|
+					answer(
+						"#{index+1}: " \
+						"[#{Time.at(row[:time]).strftime('%Y-%m-%d %H:%M')}, " \
+						"#{row[:from]} in #{row[:channel]}] " \
+						"#{row[:text]}"
+					)
+				}
+			end
+		when "dump"
+			n = @message.arguments[2].to_i
+			n = 5 if n.zero?
+			data = plugin.log_table.order(:time.DESC).first(n)
+			answer("Dump(#{data.length}):")
+			data.each_with_index { |row, index|
+				answer(
+					"#{index+1}: " \
+					"[#{Time.at(row[:time]).strftime('%Y-%m-%d %H:%M')}, " \
+					"#{row[:from]} in #{row[:channel]}] " \
+					"#{row[:text]}"
+				)
+			}
+		else
+			answer(usage)
+	end
+end
+
+subscribe(:PRIVMSG, -10, nil, MessageTypes.index(:PRIVMSG)) { |listener, message, type|
+	next unless @config["channels"].include?(message.channel.to_str)
+	@log_table << {
+		:time    => Time.now.to_i,
+		:channel => message.channel.to_str,
+		:nick    => message.from.nick,
+		:type    => type,
+		:text    => message.text
+	}
+}
+subscribe(:NOTICE, -10, nil, MessageTypes.index(:NOTICE)) { |listener, message, type|
+	next unless @config["channels"].include?(message.channel.to_str)
+	@log_table << {
+		:time    => Time.now.to_i,
+		:channel => message.channel.to_str,
+		:nick    => message.from.nick,
+		:type    => type,
+		:text    => message.text
+	}
+}
+subscribe(:JOIN, -10, nil, MessageTypes.index(:JOIN)) { |listener, message, type|
+	next unless @config["channels"].include?(message.channel.to_str)
+	@log_table << {
+		:time    => Time.now.to_i,
+		:channel => message.channel.to_str,
+		:nick    => message.from.nick,
+		:type    => type,
+		:text    => nil
+	}
+}
+subscribe(:PART, -10, nil, MessageTypes.index(:PART)) { |listener, message, type|
+	next unless @config["channels"].include?(message.channel.to_str)
+	@log_table << {
+		:time    => Time.now.to_i,
+		:channel => message.channel.to_str,
+		:nick    => message.from.nick,
+		:type    => type,
+		:text    => message.text
+	}
+}
+subscribe(:QUIT, -10, nil, MessageTypes.index(:QUIT)) { |listener, message, type|
+	next unless @config["channels"].include?(message.channel.to_str)
+	@log_table << {
+		:time    => Time.now.to_i,
+		:channel => message.channel.to_str,
+		:nick    => message.from.nick,
+		:type    => type,
+		:text    => message.text
+	}
+}
+subscribe(:KICK, -10, nil, MessageTypes.index(:KICK)) { |listener, message, type|
+	next unless @config["channels"].include?(message.channel.to_str)
+	@log_table << {
+		:time    => Time.now.to_i,
+		:channel => message.channel.to_str,
+		:nick    => message.from.nick,
+		:type    => type,
+		:text    => message.text
+	}
+}
+subscribe(:KILL, -10, nil, MessageTypes.index(:KILL)) { |listener, message, type|
+	next unless @config["channels"].include?(message.channel.to_str)
+	@log_table << {
+		:time    => Time.now.to_i,
+		:channel => message.channel.to_str,
+		:nick    => message.from.nick,
+		:type    => type,
+		:text    => message.text
+	}
+}
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+  :configuration: 1
+:summary:
+  en: Log channel messages
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:usage:
+  en: "![b]log![o] 'list'"
+:help:
+  en:
+    "": Log channel messages.
+:strings:
+  :no_match:
+    en: "No match found."
+  :list:
+    en: |
+      Logging is active for: <%= channels.join(', ') %>.
+  :activated:
+    en: |
+      Logging activated in: <%= channels.join(', ') %>.
+  :deactivated:
+    en: |
+      Logging deactivated in: <%= channels.join(', ') %>.

data/data/butler/plugins/service/svn.rb

@@ -0,0 +1,91 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'open-uri'
+require 'hpricot'
+require 'cgi'
+
+configuration(
+	"frequency"    => 900,
+	"repositories" => {}
+)
+
+def self.current_revision(repo)
+	(Hpricot.XML(`svn info --xml #{repo}`)/"info/entry").first.attributes["revision"].to_i
+end
+
+def self.changes(repo, from, to=nil)
+	range = to ? "#{from}:#{to}" : from.to_s
+	doc   = Hpricot.XML(`svn log -r #{range} --xml #{repo}`)
+	(doc/"log/logentry").map { |entry|
+		"#{(entry/'author').inner_text}, " \
+		"r#{entry.attributes['revision']}: " \
+		"#{(entry/'msg').inner_text.gsub("\n", ' ')}"
+	}
+end
+
+every(@config["frequency"]) do
+	repositories = @config["repositories"]
+	repositories.each { |repo, data|
+		cr, lr = current_revision(repo), data[:revision]
+		if cr > lr then
+			data[:revision] = cr
+			@config["repositories"] = repositories
+			changed = changes(repo, lr+1, cr).join("\n")
+			@butler.irc.privmsg(changed, *data[:channels])
+		end
+	}
+end
+
+trigger "svn"
+
+def on_trigger
+	repos = plugin.config["repositories"]
+	case arguments(1)
+		when "add"
+			repo = @message.arguments[2]
+			repos[repo] = {
+				:revision => plugin.current_revision(repo),
+				:channels => @message.arguments[3..-1]
+			}
+			plugin.config["repositories"] = repos
+			answer(:added, :repository => repo)
+
+		when "remove"
+			repo = @message.arguments[2]
+			repos.delete(repo)
+			plugin.config["repositories"] = repos
+			answer(:removed, :repository => repo)
+
+		else
+			answer(usage)
+	end
+	# 
+end
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+  :configuration: 1
+:summary:
+  en: "Poll repositories for changes and publicate them."
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:usage:
+  en: "![b]svn![o] 'add' repository channel ..."
+:help:
+  en:
+    "": "Poll repositories for changes and publicate them."
+:strings:
+  :added:
+    en: Added repository <%= repository %>.
+  :removed:
+    en: Added repository <%= repository %>.