butler 1.8.3 → 1.9.0

data/data/butler/dialogs/create.rb

@@ -11,13 +11,14 @@ Butler.create(nil, name)
 bot    = Butler.new(nil, name)
 		
 nick = name
-bot.config["connections/main/server"]          = ask(:server, "irc.freenode.org", String,  :min => 3)
+bot.config["connections/main/server"]          = server=ask(:server, "irc.freenode.org", String,  :min => 3)
 bot.config["connections/main/port"]            = ask(:port,   6667,               Integer, :between  => [0, 65535])
 bot.config["connections/main/host"]            = nil
+bot.config["connections/main/serverpass"]      = server=ask(:serverpass, nil, String)
 bot.config["connections/main/reconnect_delay"] = ask(:reconnect_delay, 60, Integer, :greater_or_equal => 0)
 bot.config["connections/main/reconnect_tries"] = ask(:reconnect_tries, -1, Integer, :greater_or_equal => -1)
 bot.config["connections/main/charset"]         = server_encoding = ask(:server_encoding, 'utf-8', String)
-bot.config["connections/main/language"]        = lang = ask(:language, "en", String, :min => 2)
+bot.config["connections/main/language"]        = lang = ask(:language, "en", String, :matching => /\A[A-Za-z0-9_.-]{2,40}\z/)
 bot.config["connections/main/nick"]            = nick = ask(:nick,     name, String, :between  => [1, 32])
 bot.config["connections/main/alternative"]     = ask(:nick2, '[1]'+nick, String, :between  => [1, 32])
 bot.config["connections/main/user"]            = ask(:user, nick, String, :between  => [1, 32])
@@ -27,16 +28,30 @@ bot.config["connections/main/identify"]        = :auto
 bot.config["connections/main/channels"]        = channels=ask(:channels, (server == "irc.freenode.org" ? ["#butler"] : nil), Array, String, :matching => /\A#[^\0\s,]+\z/)
 channels.each { |channel|
 	say(:config_channel, :name => channel)
-	prefix = "channels/#{server.config_key}/#{channel.config_key}"
+	prefix = "channels/#{Configuration.escape(server)}/#{Configuration.escape(channel)}"
 	bot.config["#{prefix}/password"] = ask(:channel_password, nil, String)
 	bot.config["#{prefix}/language"] = ask(:channel_language, lang, String)
 	bot.config["#{prefix}/charset"]  = ask(:channel_encoding, server_encoding, String)
 }
 user = ask(:admin_user, nil, String, :min => 3)
 pass = ask(:admin_pass, nil, String, :min => 3)
-bot.access.user.create(user, pass, nil, true, :active => true)
-user = bot.access.user.create("default_user", nil, nil, false, :active => true)
-user.privileges.add(%w[plugin/public])
 
+# setup basic access data
+admin = bot.access.user.create(user, pass, nil, true, :active => true)
+role  = bot.access.role.create("default_role", "This role is applied to every user")
+%w[
+	plugin/public
+	plugin/core/login
+	plugin/core/logout
+	plugin/core/help
+	plugin/core/usage
+].each { |priv| role.privileges.add_oid(priv) }
+default_user = bot.access.user.create("default_user", nil, nil, false, :active => true)
+%w[default_role].each { |role|
+	default_user.roles.add_oid(role)
+}
+bot.config["invocation"] = Regexp.escape(ask(:invocation, "!", String, :matching => /\A[!@\#$%^&*_:<>?\/\\~{}()\[\]\-"':;+=,.]\z/))
+
+# finish
 puts
 say(:how_to_start, :botname => nick, :user => user, :pass => pass)

data/data/butler/dialogs/create_config.rb

@@ -1,6 +1,9 @@
 begin
-	user = variables.user || variables.botcontrol.user # can be nil
-	variables.botcontrol.configure_user(user) unless variables.botcontrol.configured?(user)
+	user = variables.user || variables.botcontrol.user
+	unless variables.botcontrol.configured?(user)
+		say :configuring, :user => user
+		variables.botcontrol.configure_user(user)
+	end
 	Butler.path = variables.botcontrol.butler_path(user)
 rescue Errno::EACCES
 	say :cant_configure, :user => user, :app => $0

data/data/butler/dialogs/en/create.yaml

@@ -2,14 +2,15 @@
 :sudo_user:        "You are running 'create' with sudo, botcontrol will create the bot for <%= ENV['SUDO_USER'] %>, continue"
 :name:             "Please choose a name for the bot (alphanumeric characters only)"
 :delete_existing:  "A bot named <%= name %> already exists, do you wish to delete it"
-:quicksetup:       "Do you wish to do a quick configuration (you can use '<%= $0 %> config <%= name %>' any time)"
 :server:           "Servername to connect to"
 :port:             "Port to connect on"
-:connect_delay:    "Delay before trying to reconnect"
-:connect_tries:    "Number of tries to reconnect"
+:serverpass:       "The password for the server (empty if none required)"
+:reconnect_delay:  "Delay before trying to reconnect"
+:reconnect_tries:  "Number of tries to reconnect"
 :server_encoding:  "Main charset-encoding of the server"
 :language:         "The main language"
 :nick:             "Nickname of the bot"
+:nick2:            "Alternative nickname"
 :user:             "Username of the bot"
 :real:             "Realname of the bot"
 :nickpass:         "The password for the nick (empty if not registered)"
@@ -20,6 +21,8 @@
 :channel_encoding: "Charset encoding used in the channel"
 :admin_user:       "Please choose a username for the bot-admin"
 :admin_pass:       "The password for the bot-admin"
+:invocation:       "Alternative way to invoke commands (e.g. '!bot help' instead of 'bot, help', leave empty for none)"
 :how_to_start: |
   You can now start your bot using '<%= $0 %> start <%= name %>'.
   You can then authenticate as administrator of the bot in irc using '/msg <%= botname %> login <%= user %> <%= pass %>'.
+:invocation:      "Alternative method of calling commands"

data/data/butler/dialogs/en/create_config.yaml

@@ -1,2 +1,3 @@
 --- 
+:configuring:    "Configuring for '<%= user %>'."
 :cant_configure: "Can't configure for '<%= user %>', you should run <%= app %> with sudo."

data/data/butler/dialogs/en/quickcreate.yaml

@@ -2,8 +2,8 @@
 :sudo_user:       "You are running 'create' with sudo, botcontrol will create the bot for <%= ENV['SUDO_USER'] %>, continue"
 :name:            "Please choose a name for the bot (alphanumeric characters only)"
 :delete_existing: "A bot named <%= name %> already exists, do you wish to delete it"
-:quicksetup:      "Do you wish to do a quick configuration (you can use '<%= $0 %> config <%= name %>' any time)"
 :server:          "Servername to connect to"
+:serverpass:      "The password for the server (empty if none required)"
 :language:        "The main language"
 :channels:        "Comma separated list of channels to join on login"
 :user:            "Please choose a username for the bot-admin"

data/data/butler/dialogs/en/sync.yaml

@@ -0,0 +1,7 @@
+--- 
+:updating:              "Updating plugins and services for '<%= name %>'"
+:update_plugin:         "Update plugin <%= name %> from revision #<%= a %> to #<%= b %>"
+:update_service:        "Update service <%= name %> from revision #<%= a %> to #<%= b %>"
+:error_copying_plugin:  "An error occurred while copying plugin <%= name %>: <%= error %>"
+:error_copying_service: "An error occurred while copying service <%= name %>: <%= error %>"
+:ignoring_invalid_yaml: "Plugin <%= name %> has no or invalid metadata, ignoring."

data/data/butler/dialogs/en/username.yaml

@@ -0,0 +1,2 @@
+--- 
+:username: "The name of the user"

data/data/butler/dialogs/quickcreate.rb

@@ -14,10 +14,11 @@ nick = name
 bot.config["connections/main/server"]          = server=ask(:server, "irc.freenode.org", String, :min => 3)
 bot.config["connections/main/port"]            = 6667
 bot.config["connections/main/host"]            = nil
+bot.config["connections/main/serverpass"]      = server=ask(:serverpass, nil, String)
 bot.config["connections/main/reconnect_delay"] = 60
 bot.config["connections/main/reconnect_tries"] = -1
 bot.config["connections/main/charset"]         = 'utf-8'
-bot.config["connections/main/language"]        = lang=ask(:language, "en", String, :matching => /\A#[A-Za-z0-9_-]{2,40}\z/)
+bot.config["connections/main/language"]        = lang=ask(:language, "en", String, :matching => /\A[A-Za-z0-9_.-]{2,40}\z/)
 bot.config["connections/main/nick"]            = name
 bot.config["connections/main/alternative"]     = name[0,7]+"_"
 bot.config["connections/main/user"]            = name
@@ -26,13 +27,15 @@ bot.config["connections/main/password"]        = ask(:nickpass, nil, String)
 bot.config["connections/main/identify"]        = :auto
 bot.config["connections/main/channels"]        = channels=ask(:channels, (server == "irc.freenode.org" ? ["#butler"] : nil), Array, String, :matching => /\A#[^\0\s,]+\z/)
 channels.each { |channel|
-	prefix = "channels/#{server.config_key}/#{channel.config_key}"
+	prefix = "channels/#{Configuration.escape(server)}/#{Configuration.escape(channel)}"
 	bot.config["#{prefix}/password"] = nil
 	bot.config["#{prefix}/language"] = lang
 	bot.config["#{prefix}/charset"]  = 'utf-8'
 }
 user  = ask(:user, nil, String, :min => 3)
 pass  = ask(:pass, nil, String, :min => 3)
+
+# setup basic access data
 admin = bot.access.user.create(user, pass, nil, true, :active => true)
 role  = bot.access.role.create("default_role", "This role is applied to every user")
 %w[
@@ -47,5 +50,6 @@ default_user = bot.access.user.create("default_user", nil, nil, false, :active =
 	default_user.roles.add_oid(role)
 }
 
+# finish
 puts
 say(:how_to_start, :botname => nick, :user => user, :pass => pass)

data/data/butler/dialogs/sync.rb

@@ -0,0 +1,83 @@
+require 'scriptfile'
+
+def revision(plugin)
+	revision = YAML.load(ScriptFile.read(plugin))
+	(revision && revision[:revision] && revision[:revision][:plugin]) || 0
+rescue ArgumentError # invalid yaml
+	nil
+end
+
+bots                = variables.botname ? [variables.botname] : Butler.list(variables.path)
+bots_path           = variables.path.bots
+
+# scan global plugins repository, get an array with [path-to-plugin-in-global-repo, plugin-base, revision]
+dirlist             = Dir[variables.path.plugin_repository+"/**/*"]
+plugindirs, plugins = dirlist.partition { |filepath| File.directory?(filepath) }
+slice               = (variables.path.plugin_repository.length+1)..-1
+plugindirs.map! { |dir| dir[slice] }
+plugins.map! { |plugin|
+	[plugin, plugin[slice], revision(plugin)]
+}
+plugins.each { |full, base, revision|
+	say(:ignoring_invalid_yaml, :name => base) unless revision
+}
+plugins.reject! { |full, base, revision| !revision }
+
+
+# scan global services repository, get an array with data to copy
+services = [] # [rdn, name, version, ary_of_files]
+Dir.glob("#{variables.path.service_repository}/*/*/*/service.rb") { |service|
+	rdn, name, version = service.match(%r{([^/]+)/([^/]+)/([^/]+)/service\.rb$}).captures
+	slice       = (File.dirname(service).length+1)..-1
+	dirs, files = Dir[File.dirname(service)+'/**/*'].partition { |filepath| File.directory?(filepath) }
+	dirs.map!  { |file| file[slice] }
+	files.map! { |file| file[slice] }
+	services << [rdn, name, version, "#{rdn}/#{name}/#{version}", dirs, files]
+}
+
+# updating the bots
+bots.each   { |name|
+	say(:updating, :name => name)
+	bot_path = "#{bots_path}/#{name}"
+	FileUtils.mkdir_p(plugindirs.map { |dir| "#{bot_path}/plugins/#{dir}" }, :mode => 0755)
+	
+	# update plugins for this bot
+	plugins.each { |from, to, rev|
+		begin
+			full_to = "#{bot_path}/plugins/#{to}"
+			if File.exist?(full_to) then
+				to_rev = revision(full_to)
+				if rev > to_rev then
+					next unless prompt(:update_plugin, true,
+						:name => to,
+						:a    => to_rev,
+						:b    => rev
+					)
+				end
+				#puts("Deleting #{full_to}")
+				File.delete(full_to)
+			end
+			#puts("Copying #{from} to #{full_to}")
+			FileUtils.cp(from, "#{full_to}")
+		rescue Interrupt; raise # ignore interrupts
+		rescue Exception => e
+			say(:error_copying_plugin, :name => to, :error => e)
+			puts e, *e.backtrace
+		end
+	}
+	
+	# update services for this bot
+	services.each { |rdn, name, version, base, dirs, files|
+		begin
+			FileUtils.mkdir_p(dirs.map { |dir| "#{bot_path}/services/#{dir}" }, :mode => 0755)
+			files.each { |file|
+				FileUtils.cp("#{variables.path.service_repository}/#{base}/#{file}", "#{bot_path}/services/#{base}/#{file}")
+			}
+		rescue Interrupt; raise # ignore interrupts
+		rescue Exception => e
+			say(:error_copying_service, :name => name, :error => e)
+			puts e, *e.backtrace
+		end
+	}
+}
+		

data/data/butler/dialogs/username.rb

@@ -0,0 +1 @@
+response(:ask, :username, nil, String)

data/data/butler/plugins/core/ping.rb

@@ -0,0 +1,22 @@
+#--
+# Copyright 2007 by Stefan Rusterholz
+# This code is based on work by Colin Shea.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+plugin_attribute :count, 0
+
+every minute do |event|
+	begin
+		if @butler.connected? then
+			@count += 1
+			@butler.irc.write_with_eol "PING :#{@count}"
+		end
+	rescue Exception => e
+		exception(e) # log it
+		event.postpone
+	end
+end

data/data/butler/plugins/core/remote.rb

@@ -0,0 +1,38 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+configuration(
+	"active" => false,
+	"host"   => "0.0.0.0",
+	"port"   => 7776
+)
+
+
+
+def self.on_load
+	if @config["active"] then
+		@butler.remote.start(@config["host"], @config["port"])
+	end
+end
+
+__END__
+--- 
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:help:
+  en:
+    "": |
+      Control butlers remote connections server.
+:revision:
+  :plugin: 1
+:summary:
+  en: "Control butlers remote connections server."
+:usage:
+  en: "No commands available."

data/data/butler/plugins/dev/eval.rb

@@ -17,7 +17,7 @@ def previous(*n)
 	n.empty? ? plugin.state : plugin.state[*n]
 end
 
-def _0; previous(0); end
+def _;  previous(0); end
 def _1; previous(1); end
 def _2; previous(2); end
 def _3; previous(3); end
@@ -33,17 +33,19 @@ def on_trigger
 		result = eval(@message.post_arguments[1])
 		plugin.state.unshift(result)
 		plugin.state.pop
+	rescue Interrupt
+		raise
 	rescue Exception => e
 		answer(:exception, :exception => e)
 	else
-		answer(">> "+result.inspect[0,300].split(/\n/).first(3).join("\n"))
+		answer(">> "+result.inspect)
 	end
 end
 
 __END__
 --- 
 :revision:
-  :plugin: 1
+  :plugin: 2
 :summary:
   en: Let butler eval a piece of code.
 :about:
@@ -54,7 +56,7 @@ __END__
   :exception:
     en: |
       Exception <%= exception.class %> '<%= exception.message %>' in:
-      <%= exception.backtrace.first(3).join("\n") %>
+      <%= exception.backtrace.join("\n") %>
 :usage:
   en: |
     ![b]eval![o] *![c(blue)]code![o]

data/data/butler/plugins/dev/onhandlers.rb

@@ -0,0 +1,93 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+extend OnHandlers
+
+configuration(
+	"active" => false
+)
+
+trigger "onhandlers"
+
+def on_trigger
+	if @message.arguments[1] && @message.arguments[1].downcase == "on" then
+		plugin.config["active"] = true
+	else
+		plugin.config["active"] = false
+	end
+end
+
+def on_join(listener, user, channel)
+	debug("on_join triggered, #{user} joined #{channel}") if plugin.config["active"]
+end
+def on_privmsg(listener, user, text)
+	debug("on_privmsg triggered, #{user} wrote #{text}") if plugin.config["active"]
+end
+def on_notice(listener, user, text)
+	debug("on_notice triggered, #{user} wrote #{text}") if plugin.config["active"]
+end
+def on_nick(listener, user, old_nick)
+	debug("on_nick triggered, #{user} changed his nick from #{old_nick}") if plugin.config["active"]
+end
+def on_topic(listener, user, channel, topic)
+	debug("on_topic triggered, #{user} changed topic of #{channel} to #{topic}") if plugin.config["active"]
+end
+def on_part(listener, user, channel, reason)
+	debug("on_part triggered, #{user} parted #{channel}") if plugin.config["active"]
+end
+def on_quit(listener, user, reason)
+	debug("on_quit triggered, #{user} has quit with #{reason}") if plugin.config["active"]
+end
+def on_kick(listener)
+	debug("on_kick triggered with #{@message}") if plugin.config["active"]
+end
+def on_kill(listener)
+	debug("on_kill triggered with #{@message}") if plugin.config["active"]
+end
+def on_kline(listener)
+	debug("on_kline triggered with #{@message}") if plugin.config["active"]
+end
+def on_invocation(listener)
+	debug("on_invocation triggered with #{@message}") if plugin.config["active"]
+end
+def on_ban(listener, *masks)
+	debug("on_ban triggered with #{@message}") if plugin.config["active"]
+end
+def on_unban(listener, *masks)
+	debug("on_unban triggered with #{@message}") if plugin.config["active"]
+end
+def on_op(listener, *users)
+	debug("on_op triggered with #{@message}") if plugin.config["active"]
+end
+def on_deop(listener, *users)
+	debug("on_deop triggered with #{@message}") if plugin.config["active"]
+end
+def on_voice(listener, *users)
+	debug("on_voice triggered with #{@message}") if plugin.config["active"]
+end
+def on_devoice(listener, *users)
+	debug("on_devoice triggered with #{@message}") if plugin.config["active"]
+end
+
+__END__
+--- 
+:revision:
+  :plugin: 2
+:summary:
+  en: Testing all possible on_handlers
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:strings:
+:usage:
+  en: "This plugin does not offer a specific interface."
+:help:
+  en:
+    "": |
+      This plugin is meant for diagnostic purposes only.

data/data/butler/plugins/dev/rawlog.rb

@@ -7,71 +7,135 @@
 
 
 configuration(
-	"active" => true
+	"out"    => false,
+	"in"     => false,
+	"append" => true,
+	"time"   => "%F %T"
 )
 
 @logfile = nil
 
-def self.on_load(*a)
-	@logfile      = File.open(@butler.path.log+"/rawlog.txt", "a")
-	@logfile.sync = true
+class <<self
+	def on_load(*a)
+		@logfile      = File.open(@butler.path.log+"/rawlog.txt", @config["append"] ? "ab" : "wb")
+		@lock         = Mutex.new
+		@logfile.sync = true
+		@log_listener = nil
+		activate
+	end
+	
+	def activate
+		if @config["in"] then
+			@log_listener = subscribe(nil, 10) { |listener, message|
+				@lock.synchronize {
+					@logfile.puts("-> #{Time.now.strftime(@config['time'])} #{message.raw.inspect}") unless @logfile.closed?
+				}
+			}
+		else
+			@log_listener.unsubscribe if @log_listener
+		end
+		@butler.irc.log_out = @config["out"] ? self : nil
+	end
+	
+	def puts(*messages)
+		@lock.synchronize {
+			messages.each { |message|
+				@logfile.puts("<- #{Time.now.strftime(@config['time'])} #{message.inspect}")
+			} unless @logfile.closed?
+		}
+	end
+	
+	def on_unload(*a)
+		@lock.synchronize {
+			@butler.irc.log_out = nil
+			@logfile.close
+		}
+	end
 end
 
-def self.on_unload(*a)
-	@logfile.close
+def on_status(params)
+	answer(:status, :status_in => plugin.config["in"], :status_out => plugin.config["out"])
 end
 
-subscribe(nil, 10) { |listener, message|
-	if @config["active"] && @logfile then
-		@logfile.puts("#{Time.now.strftime('%F %T')}> #{message.raw}")
-	end
-}
-
-trigger "rawlog"
-
-def on_trigger
-	arg = @message.arguments[1] && @message.arguments[1].downcase
-	case arg
-		when nil
-			usage
-
-		when _(:on)
-			plugin.config["active"] = true
-			answer(:activated)
+def on_wipe(params)
+	plugin.logfile.truncate
+	answer :wiped
+end
 
-		when _(:off)
-			plugin.config["active"] = false
-			answer(:deactivated)
+def on_activate(params)
+	if params["in"] then
+		plugin.config["in"] = true
+		answer(:activated_in)
+	elsif params["out"] then
+		plugin.config["out"] = true
+		answer(:activated_out)
+	else
+		plugin.config["in"] = true
+		plugin.config["out"] = true
+		answer(:activated_both)
+	end
+	plugin.activate
+end
 
+def on_deactivate(params)
+	if params["in"] then
+		plugin.config["in"] = false
+		answer(:deactivated_in)
+	elsif params["out"] then
+		plugin.config["out"] = false
+		answer(:deactivated_out)
+	else
+		plugin.config["in"] = false
+		plugin.config["out"] = false
+		answer(:deactivated_both)
 	end
+	plugin.activate
 end
 
 __END__
 --- 
-:revision:
-  :configuration: 1
-:summary:
-  en: |
-    Writes all messages butler receives into a raw log.
 :about:
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
-:strings:
-  :on:
-    en: "on"
-  :off:
-    en: "off"
-  :activated:
-    en: |
-      Activated raw logging
-  :deactivated:
-    en: |
-      Deactivated raw logging
-:usage:
-  en: |
-    ![b]rawlog![o] ('on' | 'off')
 :help:
   en:
     "": |
       Writes all messages butler receives into a raw log.
+:map:
+  :on_status:
+    en: rawlog status
+  :on_wipe:
+    en: wipe rawlog
+  :on_activate:
+    en: activate rawlog [:direction{in,out}]
+  :on_deactivate:
+    en: deactivate rawlog [:direction{in,out}]
+:revision:
+  :configuration: 1
+:strings:
+  :status:
+    en: |
+      Incomming messages are <%= status_in ? '' : 'not ' %>logged, outgoing messages are <%= status_out ? '' : 'not ' %>logged.
+  :wiped:
+    en: Wiped raw log.
+  :activated_in:
+    en: Activated raw log for incomming messages.
+  :activated_out:
+    en: Activated raw log for outgoing messages.
+  :activated_both:
+    en: Activated raw log for incomming and outgoing messages.
+  :deactivated_in:
+    en: Deactivated raw log for incomming messages.
+  :deactivated_out:
+    en: Deactivated raw log for outgoing messages.
+  :deactivated_both:
+    en: Deactivated raw log for incomming and outgoing messages.
+:summary:
+  en: |
+    Writes all messages butler receives and/or sends into a raw log.
+:usage:
+  en: |
+    activate rawlog [in|out]
+    deactivate rawlog [in|out]
+    wipe rawlog