butler 1.8.2 → 1.8.3

data/Rakefile

@@ -62,7 +62,7 @@ LOCAL_PATHS['plugins'] = "#{LOCAL_PATHS['data']}/plugins"
 #LOCAL_PATHS['config']  = "#{Config::CONFIG['sysconfdir']}/butler"
 LOCAL_PATHS['pids']    = "#{Config::CONFIG['localstatedir']}/run/butler"
 CHANGES = "See CHANGELOG.txt"
-DESC    = "Butler 1.8.2, 3rd alpha release of butler2."
+DESC    = "Butler 1.8.3, 4th alpha release of butler2."
 
 GemSpec = Gem::Specification.new do |s|
 	s.homepage              = HOMEPATH

data/bin/botcontrol

@@ -249,7 +249,7 @@ case command
 		)
 
 	when "uninstall"
-		botcontrol.discuss("uninstall", false, :path => path, :config => config)
+		botcontrol.discuss("uninstall", false)
 		
 	else
 		botcontrol.discuss("unknown_command", false, :command => command)

data/data/butler/dialogs/create_config.rb

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

data/data/butler/dialogs/quickcreate.rb

@@ -35,15 +35,17 @@ user  = ask(:user, nil, String, :min => 3)
 pass  = ask(:pass, nil, String, :min => 3)
 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")
-role.privileges.add(%w[
+%w[
 	plugin/public
 	plugin/core/login
 	plugin/core/logout
 	plugin/core/help
 	plugin/core/usage
-])
-user = bot.access.user.create("default_user", nil, nil, false, :active => true)
-user.roles.add(%w[default_role])
+].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)
+}
 
 puts
 say(:how_to_start, :botname => nick, :user => user, :pass => pass)

data/data/butler/dialogs/uninstall.rb

@@ -1,7 +1,8 @@
-unless ENV["SUDO_USER"]
+# botcontrol must run as sudo in order to uninstall all stuff
+unless ENV["SUDO_USER"] || Process.uid.zero? # *NIX
 	say(:must_run_as_sudo)
 else
-	variables.config.users.sort.each { |user, conf|
+	variables.botcontrol.config[:users].sort.each { |user, conf|
 		if prompt(:uninstall_user, false, :name => user) then
 			FileUtils.rm_r(conf[:bots])
 			FileUtils.rm_r(conf[:run])
@@ -12,6 +13,6 @@ else
 	else
 		say(:uninstalling_botcontrol)
 		File.delete($0)
-		File.delete(variables.path.config)
+		File.delete(variables.botcontrol.path[:config])
 	end
 end

data/data/butler/plugins/core/access.rb

@@ -35,7 +35,7 @@ def on_create_user(params)
 			false,
 			:active => !!params.active
 		)
-		user[params.username].roles.add("default_role")
+		user[params.username].roles.add_oid("default_role")
 		answer(:user_created, :username => params.username)
 	end
 end
@@ -44,7 +44,7 @@ end
 def on_delete_user(params)
 	params.username.downcase!
 	if user.exists?(params.username) then
-		user.delete(params.username)
+		user.delete_oid(params.username)
 		answer(:user_deleted, :username => params.username)
 	else
 		answer(:user_doesnt_exist, :username => params.username)
@@ -61,7 +61,7 @@ end
 def on_delete_role(params)
 	params.rolename.downcase!
 	return answer(:role_doesnt_exist, :rolename => params.rolename) unless role.exists?(params.rolename)
-	role.delete(params.rolename)
+	role.delete_oid(params.rolename)
 	answer(:role_deleted, :rolename => params.rolename)
 end
 
@@ -69,7 +69,7 @@ end
 def on_grant_privilege_to_user(params)
 	params.username.downcase!
 	return answer(:user_doesnt_exist, :username => params.username) unless user.exists?(params.username)
-	user[params.username].privileges.add(params.privilege)
+	user[params.username].privileges.add_oid(params.privilege)
 	answer(:privilege_granted_to_user, :username => params.username, :privilege => params.privilege)
 end
 
@@ -77,7 +77,7 @@ end
 def on_revoke_privilege_from_user(params)
 	params.username.downcase!
 	return answer(:user_doesnt_exist, :username => params.username) unless user.exists?(params.username)
-	user[params.username].privileges.remove(params.privilege)
+	user[params.username].privileges.remove_oid(params.privilege)
 	answer(:privilege_revoked_from_user, :username => params.username, :privilege => params.privilege)
 end
 
@@ -85,7 +85,7 @@ end
 def on_grant_privilege_to_role(params)
 	params.rolename.downcase!
 	return answer(:role_doesnt_exist, :rolename => params.rolename) unless role.exists?(params.rolename)
-	role[params.rolename].privileges.add(role[params.privilege])
+	role[params.rolename].privileges.add_oid(params.privilege)
 	answer(:privilege_granted_to_role, :rolename => params.rolename, :privilege => params.privilege)
 end
 
@@ -93,7 +93,7 @@ end
 def on_revoke_privilege_from_role(params)
 	params.rolename.downcase!
 	return answer(:role_doesnt_exist, :rolename => params.rolename) unless role.exists?(params.rolename)
-	role[params.rolename].privileges.remove(role[params.privilege])
+	role[params.rolename].privileges.remove_oid(params.privilege)
 	answer(:privilege_revoked_from_role, :rolename => params.rolename, :privilege => params.privilege)
 end
 
@@ -103,7 +103,7 @@ def on_add_role_to_user(params)
 	params.rolename.downcase!
 	return answer(:user_doesnt_exist, :username => params.username) unless user.exists?(params.username)
 	return answer(:role_doesnt_exist, :username => params.rolename) unless role.exists?(params.rolename)
-	user[params.username].roles.add(role[params.rolename])
+	user[params.username].roles.add_oid(params.rolename)
 	answer(:role_added_to_user, :username => params.username, :rolename => params.rolename)
 end
 
@@ -113,7 +113,7 @@ def on_remove_role_from_user(params)
 	params.rolename.downcase!
 	return answer(:user_doesnt_exist, :username => params.username) unless user.exists?(params.username)
 	return answer(:role_doesnt_exist, :username => params.rolename) unless role.exists?(params.rolename)
-	user[params.username].roles.remove(role[params.rolename])
+	user[params.username].roles.remove_oid(params.rolename)
 	answer(:role_removed_from_user, :username => params.username, :rolename => params.rolename)
 end
 
@@ -139,7 +139,7 @@ __END__
   :on_create_user:
     en: "create user :username [with password :password] [:active{active}]"
   :on_delete_user:
-    en: "delete user :rolename"
+    en: "delete user :username"
   :on_create_role:
     en: "create role :rolename [with description +description]"
   :on_delete_role:

data/data/butler/plugins/dev/bleakhouse.rb

@@ -4,14 +4,19 @@
 # See LICENSE.txt for permissions.
 #++
 
-def self.logfile
-	@logfile
-end
+
+$BLEAK_HOUSE ||= false
+
+plugin_attribute :logfile
+plugin_attribute :active
 
 def self.on_load
-	@logfile   = @butler.path.log+'/bleakhouse.log'
-	@bl_logger = BleakHouse::Logger.new
-	File.delete(@logfile) if File.exist?(@logfile)
+	if $BLEAK_HOUSE then
+		@logfile   = @butler.path.log+'/bleakhouse.log'
+		@bl_logger = BleakHouse::Logger.new
+		@active    = true
+		File.delete(@logfile) if File.exist?(@logfile)
+	end
 end
 
 def self.snapshot(*args)
@@ -19,8 +24,12 @@ def self.snapshot(*args)
 end
 
 def on_trigger
-	plugin.snapshot('plugin', false)
-	answer(:done, :file => plugin.logfile)
+	if plugin.active then
+		plugin.snapshot('plugin', false)
+		answer(:done, :file => plugin.logfile)
+	else
+		answer(:inactive)
+	end
 end
 
 __END__
@@ -37,6 +46,8 @@ __END__
 :strings:
   :done:
     en: "Snapshot taken. The file is in <%= file %>."
+  :inactive:
+    en: "Bleak house is not activated for this bot."
 :summary:
   en: Inspect butlers memory usage.
 :trigger:

data/data/butler/plugins/operator/deop.rb

@@ -20,17 +20,26 @@ __END__
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
+  :translation:
+    es: "Rafael George, <george.rafael@gmail.com>"
 :help:
   en:
     "": |
-      Revoke a users op via butler.
+      Revoke a users op via butler
+  es:
+    "": |
+      Revoca a un usuario los privilegios de operador atravez de butler
 :map:
   :on_deop:
     en: "deop [*user@Nick] [in :channel@Channel]"
+    es: "deop [*user@Nick] [en :channel@Channel]"
 :revision:
   :plugin: 1
 :summary:
   en: Revoke a users op via butler.
+  es: Revoca a un usuario los privilegios de operador atravez de butler
 :usage:
   en: |
     ![b]deop![o] [![c(green)]nick![o] ...] [in ![c(green)]channel![o]]
+  es: |
+    ![b]deop![o] [![c(green)]nick![o] ...] [en ![c(green)]canal![o]]

data/data/butler/plugins/operator/devoice.rb

@@ -19,17 +19,26 @@ __END__
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
+  :translation:
+    es: "Rafael George, <george.rafael@gmail.com>"
 :help:
   en:
     "": |
       Revoke a users voice via butler.
+  es: 
+    "": |
+      Revoca la voz de un usuario atravez de butler.
 :map:
   :on_devoice:
     en: "devoice [*user@Nick] [in :channel@Channel]"
+    es: "desvoz [*user@Nick] [en :channel@Channel]"
 :revision:
   :plugin: 1
 :summary:
   en: Revoke a users voice via butler.
+  es: Revoca la voz de un usuario atravez de butler.
 :usage:
   en: |
     ![b]devoice![o] [![c(green)]nick![o] ...] [![c(green)]channel![o] ...]
+  es: |
+    ![b]desvoz![o] [![c(green)]nick![o] ...] [![c(green)]canal![o] ...]

data/data/butler/plugins/operator/limit.rb

@@ -59,24 +59,36 @@ __END__
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
+  :translation:
+    es: "Rafael George, <george.rafael@gmail.com>"
 :help:
   en:
     "": |
       A slowly shifting channel-limit to avoid join-floods.
+  es:
+    "": |
+     Maneja los excesos de ingresos al canal.
 :map:
   :on_limit:
     en: limit *channels@Channel
+    es: limita *channels@Channel
   :on_unlimit:
     en: unlimit *channels@Channel
+    es: deslimita *channels@Channel
 :revision:
   :plugin: 1
 :strings:
   :limiting:
     en: Limiting channels <%= channels.join(', ') %>.
+    es: Limita canales <%= channels.join(', ') %>.
   :unlimiting:
     en: No longer limiting channels <%= channels.join(', ') %>.
+    es: No sigue limitando canales <%= channels.join(', ') %>.
 :summary:
   en: A slowly shifting channel-limit to avoid join-floods.
+  es: Maneja los excesos de ingresos al canal.
 :usage:
   en: |
     (![b]limit![o]|![b]unlimit![o]) ![c(green)]channel![o] ...
+  es: |
+    (![b]limita![o]|![b]deslimita![o]) ![c(green)]canales![o] ...

data/data/butler/plugins/operator/op.rb

@@ -19,18 +19,27 @@ __END__
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
+  :translation:
+    es: "Rafael George, <george.rafael@gmail.com>"
 :help:
   en:
     "": |
       Grant a user op via butler.
+  es:
+    "": |
+      Otorga privilegios de operador a un usuario atravez de butler.
 :map:
   :on_op:
     en: "op [*user@Nick] [in :channel@Channel]"
+    es: "op [*user@Nick] [en :channel@Channel]"
 :revision:
   :plugin: 1
 :strings:
 :summary:
   en: Grant users op via butler.
+  es: Otorga privilegios de operador a un usuario atravez de butler.
 :usage:
   en: |
     ![b]op![o] [![c(green)]nick![o] ...] [in ![c(green)]channel![o]]
+  es: |
+    ![b]op![o] [![c(green)]nick![o] ...] [in ![c(green)]canal![o]]

data/data/butler/plugins/operator/voice.rb

@@ -19,18 +19,28 @@ __END__
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
+  :translation:
+    es: "Rafael George, <george.rafael@gmail.com>"
 :help:
   en:
     "": |
       Grant a user voice via butler.
+  es:
+    "": |
+      Otorga voz a un usuario atravez de butler.
 :map:
   :on_voice:
     en:
      "voice [*user@Nick] [in :channel@Channel]"
+    es: 
+     "voz [*user@Nick] [en :channel@Channel]"
 :revision:
   :plugin: 1
 :summary:
   en: Grant a user voice via butler.
+  es: Otorga voz a un usuario atravez de butler.
 :usage:
   en: |
     ![b]voice![o] [![c(green)]nick![o] ...] [in ![c(green)]channel![o]]
+  es: |
+    ![b]voice![o] [![c(green)]nick![o] ...] [in ![c(green)]canal![o]]

data/data/butler/plugins/util/calculator.rb

@@ -0,0 +1,11 @@
+def on_define_function(params)
+	if match = params.proto.match(/^([a-z]+)(?:\((.*?)\))?$/) then
+	end
+end
+
+__END__
+:map:
+  :on_define_function:
+    en: "define function +proto := +definition"
+  :on_calculate:
+    en: "calculate +term"

data/data/butler/services/org.rubyforge.butler/calculator/1/calculator.rb

@@ -0,0 +1,68 @@
+require 'blank'
+
+class Calculator < Blank('inspect', 'binding', 'method_missing')
+	class Functions
+		def initialize
+			@functions = {}
+		end
+		
+		def [](name)
+			@functions[name.to_s]
+		end
+
+		def []=(name, definition)
+			@functions[name.to_s] = definition
+		end
+		
+		def call(m, *args)
+			@functions[m.to_s].call(*args)
+		end
+		
+		def respond_to?(m, *a)
+			super || @functions.has_key?(m.to_s)
+		end
+
+		def method_missing(m, *args)
+			super unless @functions.has_key?(m.to_s)
+			@functions[m.to_s].call(*args)
+		end
+	end
+
+	include Math
+	
+	attr_reader :term
+
+	def initialize(term, delegate=nil)
+		@term      = term.scan(/\s+|,|[a-z]*\(|\)|-?\d(?:\.\d+)?|[a-z]+|[*\/%+-]/).join
+		@variables = {}
+		@delegate  = delegate
+		@results   = []
+	end
+	
+	def result(variables={})
+		@variables=variables
+		@results.unshift Thread.new {
+			$SAFE = 3
+			Kernel.eval(@term, binding)
+		}.value
+		@results.pop if @results.length > 10
+		@results.first
+	end
+	alias call result
+	
+	def load(result)
+		@results[result]
+	end
+	
+	def method_missing(m, *a)
+		if a.empty? && @variables.has_key?(m) then
+			@variables[m]
+		elsif @delegate.respond_to?(m) then
+			@delegate.call(m, *a)
+		else
+			super
+		end
+	end
+end
+
+register_service("org.rubyforge.butler.calculator", Calculator)

data/data/butler/services/org.rubyforge.butler/log/1/service.rb

@@ -0,0 +1,198 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'sqlite3'
+require 'thread'
+require 'ruby/file/write'
+
+
+
+MessageTypes = [:PRIVMSG, :NOTICE, :JOIN, :PART, :QUIT, :KICK, :KILL]
+Row = Struct.new(:oid, :time, :channel, :nick, :type, :text)
+def Row.from_row(row)
+	oid, time, channel, nick, type, text = *row
+	new(oid.to_i, Time.at(oid.to_i), channel, nick, MessageTypes[type.to_i], text)
+end
+
+class IRCLogger
+	def initialize(db, channels)
+		@db_file = db
+		@db      = SQLite3::Database.new(db)
+		@db.execute %q{
+			CREATE TABLE IF NOT EXISTS messages(
+				oid INTEGER PRIMARY KEY AUTOINCREMENT,
+				time INTEGER,
+				channel TEXT,
+				nick TEXT,
+				type INTEGER,
+				text TEXT
+			)
+		}
+		@insert  = @db.prepare %q{
+			INSERT INTO messages
+			(time, channel, nick, type, text)
+			VALUES (:time, :channel, :nick, :type, :text)
+		}
+		File.write(channels, {}.to_yaml) unless File.exist?(channels)
+		@channels    = YAML.load_file(channels)
+		@config_file = channels
+		@lock        = Mutex.new
+	end
+	
+	def start_logging(channel)
+		@lock.synchronize {
+			@channels[channel] = true
+			File.write(@config_file, @channels.to_yaml)
+		}
+	end
+	
+	def stop_logging(channel)
+		@lock.synchronize {
+			@channels.delete(channel)
+			File.write(@config_file, @channels.to_yaml)
+		}
+	end
+	
+	def logged?(channel)
+		@channels.has_key?(channel)
+	end
+	
+	def insert(values)
+		@insert.execute(values)
+	end
+	
+	def select(statement=nil, *values)
+		query = "SELECT * FROM messages #{statement}"
+		if block_given? then
+			@db.execute(query, *values) { |row|
+				yield(Row.from_row(row))
+			}
+		else
+			@db.execute(query, *values).map { |row|
+				Row.from_row(row)
+			}
+		end
+	end
+	
+	def find(args={}, &block)
+		where = []
+		if nick = args[:nick] then
+			where << field_equals_values('nick', nick)
+		end
+		if channel = args[:channel] then
+			where << field_equals_values('channel', channel)
+		end
+		if time = args[:time] then
+			where << "time >= #{SQLite3::Database.quote(time.begin.to_i)} AND time <= #{SQLite3::Database.quote(time.end.to_i)}"
+		end
+		if types = args[:type] then
+			where << field_equals_values('type', types)
+		end
+		if text = args[:text] then
+			field_contains_all_values('text', text)
+		end
+		select(where.empty? ? nil : 'WHERE '+where.join(' AND '), &block)
+	end
+	
+	def field_equals_values(field, values)
+		if Array === values then
+			values.map { |e| "#{field} LIKE '#{SQLite3::Database.quote(e)}'" }.join(" AND ")
+		else
+			"#{field} LIKE '#{SQLite3::Database.quote(values)}'"
+		end
+	end
+	
+	def field_equals_values(field, values)
+		if Array === values then
+			is_in(field, values)
+		else
+			"#{field} = '#{SQLite3::Database.quote(values)}'"
+		end
+	end
+	
+	def is_in(field, values)
+		"#{field} IN ('#{values.map { |e| SQLite3::Database.quote(text) }.join('\', \'') }')"
+	end
+end
+
+def self.on_load
+	logger = IRCLogger.new(@path.base+'/log.sqlite', @path.base+'/channels.yaml')
+
+	subscribe(:PRIVMSG, -10, MessageTypes.index(:PRIVMSG)) { |listener, message, type|
+		next unless logger.logged?(message.channel.to_str)
+		logger.insert(
+			:time    => Time.now.to_i,
+			:channel => message.channel.to_str,
+			:nick    => message.from.nick,
+			:type    => type,
+			:text    => message.text
+		)
+	}
+	subscribe(:NOTICE, -10, MessageTypes.index(:NOTICE)) { |listener, message, type|
+		next unless logger.logged?(message.channel.to_str)
+		logger.insert(
+			:time    => Time.now.to_i,
+			:channel => message.channel.to_str,
+			:nick    => message.from.nick,
+			:type    => type,
+			:text    => message.text
+		)
+	}
+	subscribe(:JOIN, -10, MessageTypes.index(:JOIN)) { |listener, message, type|
+		next unless logger.logged?(message.channel.to_str)
+		logger.insert(
+			:time    => Time.now.to_i,
+			:channel => message.channel.to_str,
+			:nick    => message.from.nick,
+			:type    => type,
+			:text    => nil
+		)
+	}
+	subscribe(:PART, -10, MessageTypes.index(:PART)) { |listener, message, type|
+		next unless logger.logged?(message.channel.to_str)
+		logger.insert(
+			:time    => Time.now.to_i,
+			:channel => message.channel.to_str,
+			:nick    => message.from.nick,
+			:type    => type,
+			:text    => message.text
+		)
+	}
+	subscribe(:QUIT, -10, MessageTypes.index(:QUIT)) { |listener, message, type|
+		next unless logger.logged?(message.channel.to_str)
+		logger.insert(
+			:time    => Time.now.to_i,
+			:channel => message.channel.to_str,
+			:nick    => message.from.nick,
+			:type    => type,
+			:text    => message.text
+		)
+	}
+	subscribe(:KICK, -10, MessageTypes.index(:KICK)) { |listener, message, type|
+		next unless logger.logged?(message.channel.to_str)
+		logger.insert(
+			:time    => Time.now.to_i,
+			:channel => message.channel.to_str,
+			:nick    => message.from.nick,
+			:type    => type,
+			:text    => message.text
+		)
+	}
+	subscribe(:KILL, -10, MessageTypes.index(:KILL)) { |listener, message, type|
+		next unless logger.logged?(message.channel.to_str)
+		logger.insert(
+			:time    => Time.now.to_i,
+			:channel => message.channel.to_str,
+			:nick    => message.from.nick,
+			:type    => type,
+			:text    => message.text
+		)
+	}
+
+	register(logger)
+end