butler 1.8.1 → 1.8.2

data/data/butler/dialogs/create_config.rb

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

data/data/butler/dialogs/dir.rb

@@ -0,0 +1,13 @@
+if !variables.botcontrol.configured? then
+	say(:not_configured)
+elsif !Butler.exists?(nil, variables.botname)
+	say(:no_such_bot, :botname => variables.botname)
+else
+	bot = Butler.new(nil, variables.botname)
+	path = variables.dirname.to_sym
+	if path = bot.path[path]
+		say(:path, :dirname => variables.dirname, :path => path)
+	else
+		say(:no_such_dir, :dirname => variables.dirname)
+	end
+end

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

@@ -1,11 +1,25 @@
 --- 
-: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"
-:language:        "The main language"
-:channels:        "Comma separated list of channels to join on login"
-:user:            "Please choose a username for the bot-admin"
-:pass:            "The password for the bot-admin"
-:nickpass:        "The password for the nick (empty if not registered)"
-:how_to_start:    "You can now start your bot using '<%= $0 %> start <%= name %>'"
+: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"
+:server_encoding:  "Main charset-encoding of the server"
+:language:         "The main language"
+:nick:             "Nickname of the bot"
+:user:             "Username of the bot"
+:real:             "Realname of the bot"
+:nickpass:         "The password for the nick (empty if not registered)"
+:channels:         "Comma separated list of channels to join on login"
+:config_channel:   "Configuration for channel <%= name %>"
+:channel_password: "Password to join the channel"
+:channel_language: "Language in the channel"
+: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"
+: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 %>'.

data/data/butler/dialogs/en/dir.yaml

@@ -0,0 +1,5 @@
+--- 
+:not_configured: "Your user is not configured yet."
+:no_such_bot: "No bot named <%= name %> found."
+:no_such_dir: "No path info for path <%= dirname %>."
+:path: "Path to <%= dirname %>: <%= path %>"

data/data/butler/dialogs/en/help.yaml

@@ -2,16 +2,33 @@
 :help: |-
   This is the tool to administrate your irc-bots.
   The the following commands are available:
-   -create: create a new bot
-   -start:  start an existing bot
-   -stop:   stop a running bot
-   -rename: rename an existing bot
-   -config: configure an existing bot
-   -delete: delete an existing bot
-   -list:   list all existing bots
-   -backup: make a backup of an existing bot
-   -help:   you're looking at it"
+    backup:       make a backup of an existing bot
+    config:       configure an existing bot
+    create:       create a new bot
+    delete:       delete an existing bot
+    dir:          shows directories to specific parts of a specific bot
+    help:         get help about a command or a topic
+    info:         displays information about user, bots and paths
+    interactive:  run botcontrol interactively
+    log:          browse the logs of a bot
+    list:         list all existing bots
+    rename:       rename an existing bot
+    setup:        setup botcontrol for usage
+    start:        start one of your bots
+    stop:         stop a running bot
+    sync_plugins: sync the plugins of a bot with your local repository
+    uninstall:    uninstall butler
 :tutorial: The tutorial is on http://butler.rubyforge.org/tutorial
 :plugins: You can download plugins from http://rubyforge.org/frs/?group_id=1349
-:manual: The manual is on http://butler.rubyforge.org/manual
-:home: Butlers home is on http://butler.rubyforge.org/
+:manual: The manual is on http://butler.rubyforge.org/manual.html
+:home: Butlers home is on http://butler.rubyforge.org/
+:topics: |-
+  Available help topics are:
+  backup  info         setup
+  config  interactive  start
+  create  log          stop
+  delete  list         sync_plugins
+  dir     manual       tutorial
+  help    plugins      uninstall
+  home    rename       
+:unknown: The command <%= name %> is not known, use 'help topics' to get a list of help topics.

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

@@ -0,0 +1,14 @@
+--- 
+: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"
+:language:        "The main language"
+:channels:        "Comma separated list of channels to join on login"
+:user:            "Please choose a username for the bot-admin"
+:pass:            "The password for the bot-admin"
+:nickpass:        "The password for the nick (empty if not registered)"
+: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 %>'.

data/data/butler/dialogs/help.rb

@@ -1,10 +1,22 @@
 if variables.command then
 	case variables.command
-		when "tutorial":      say(:tutorial)
-		when "documentation": say(:documentation)
-		when "plugins":       say(:plugins)
+		when "manual":   say(:manual)
+		when "plugins":  say(:plugins)
+		when "topics":   say(:topics)
+		when "tutorial": say(:tutorial)
 		else
-			variables.options[variables.command].help
+			if found = variables.options[variables.command] then
+				options = found.help.sub(/.*?\n.*?\n/,'').gsub(/^/, '  ')
+				puts found.usage
+				if options.strip.empty? then
+					puts "Command doesn't have options"
+				else
+					puts "Options:\n"
+					puts options 
+				end
+			else
+				say(:unknown, :name => variables.command)
+			end
 	end
 else
 	say(:help)

data/data/butler/dialogs/quickcreate.rb

@@ -0,0 +1,49 @@
+exit if ENV["SUDO_USER"] && !prompt(:sudo_user, false)
+name   = variables.name
+while Butler.exists?(nil, name)
+	if prompt(:delete_existing, false)
+		Butler.delete(nil, name)
+	else
+		name = ask(:name, "butler", String,  :matching => /\A[A-Za-z0-9_]+\z/)
+	end
+end
+Butler.create(nil, name)
+bot    = Butler.new(nil, name)
+		
+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/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/nick"]            = name
+bot.config["connections/main/alternative"]     = name[0,7]+"_"
+bot.config["connections/main/user"]            = name
+bot.config["connections/main/real"]            = name+" (Butler IRC bot)"
+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}"
+	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)
+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[
+	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])
+
+puts
+say(:how_to_start, :botname => nick, :user => user, :pass => pass)

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

@@ -0,0 +1,211 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+# add/remove privileges to/from roles
+
+def user
+	@butler.access.user
+end
+
+def role
+	@butler.access.role
+end
+
+def on_users(params)
+	users = params.grep ? user.keys : user.keys.grep(/#{params.grep}/)
+	answer(:userlist, :list => users)
+end
+
+# "create user :username"
+def on_create_user(params)
+	name, pass, active = @message.arguments[2,3]
+	params.username.downcase!
+	if user.exists?(params.username) then
+		answer(:user_already_exists, :username => params.username)
+	else
+		user.create(
+			params.username,
+			params.password,
+			nil,
+			false,
+			:active => !!params.active
+		)
+		user[params.username].roles.add("default_role")
+		answer(:user_created, :username => params.username)
+	end
+end
+
+# "delete user :username"
+def on_delete_user(params)
+	params.username.downcase!
+	if user.exists?(params.username) then
+		user.delete(params.username)
+		answer(:user_deleted, :username => params.username)
+	else
+		answer(:user_doesnt_exist, :username => params.username)
+	end
+end
+
+def on_create_role(params)
+	params.rolename.downcase!
+	return answer(:role_already_exists, :rolename => params.rolename) if role.exists?(params.rolename)
+	role.create(params.rolename, params.description)
+	answer(:role_created, :rolename => params.rolename)
+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)
+	answer(:role_deleted, :rolename => params.rolename)
+end
+
+# "grant privilege :privilege to user :username"
+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)
+	answer(:privilege_granted_to_user, :username => params.username, :privilege => params.privilege)
+end
+
+# "revoke privilege :privilege from user :username"
+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)
+	answer(:privilege_revoked_from_user, :username => params.username, :privilege => params.privilege)
+end
+
+# "grant privilege :privilege to role :username"
+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])
+	answer(:privilege_granted_to_role, :rolename => params.rolename, :privilege => params.privilege)
+end
+
+# "revoke privilege :privilege from role :username"
+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])
+	answer(:privilege_revoked_from_role, :rolename => params.rolename, :privilege => params.privilege)
+end
+
+# "add role :role to user :username"
+def on_add_role_to_user(params)
+	params.username.downcase!
+	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])
+	answer(:role_added_to_user, :username => params.username, :rolename => params.rolename)
+end
+
+# "remove role :role from user :username"
+def on_remove_role_from_user(params)
+	params.username.downcase!
+	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])
+	answer(:role_removed_from_user, :username => params.username, :rolename => params.rolename)
+end
+
+def on_set_my_password(params)
+	
+end
+
+__END__
+--- 
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:help:
+  en:
+    "": |
+      Manage your users, roles and privileges.
+:map:
+  :on_users:
+    en: "show all users [matching :grep]"
+  :on_set_my_password:
+    en: "set my password to :newpassword"
+  :on_create_user:
+    en: "create user :username [with password :password] [:active{active}]"
+  :on_delete_user:
+    en: "delete user :rolename"
+  :on_create_role:
+    en: "create role :rolename [with description +description]"
+  :on_delete_role:
+    en: "delete role :rolename"
+  :on_activate_user:
+    en: "activate user :username"
+  :on_deactivate_user:
+    en: "deactivate user :username"
+  :on_grant_privilege_to_user:
+    en: "grant privilege :privilege to user :username"
+  :on_revoke_privilege_from_user:
+    en: "revoke privilege :privilege from user :username"
+  :on_grant_privilege_to_role:
+    en: "grant privilege :privilege to role :rolename"
+  :on_revoke_privilege_from_role:
+    en: "revoke privilege :privilege from role :rolename"
+  :on_add_role_to_user:
+    en: "add role :rolename to user :username"
+  :on_remove_role_from_user:
+    en: "remove role :rolename from user :username"
+  :on_add_role_to_role:
+    en: "add role :rolename to role :rolename2"
+  :on_remove_role_from_role:
+    en: "remove role :rolename from role :rolename2"
+:revision:
+  :plugin: 1
+:strings:
+  :userlist:
+    en: "<%= list.columnize(5) %>"
+  :activated:
+    en: "Activated user <%= username %>."
+  :deactivated:
+    en: "Deactivated user <%= username %>."
+  :user_already_exists:
+    en: "User <%= username %> exists already."
+  :user_doesnt_exist:
+    en: "User <%= username %> does not exist."
+  :user_created:
+    en: "Created user <%= username %>."
+  :user_deleted:
+    en: "Deleted user <%= username %>."
+  :role_already_exists:
+    en: "Role <%= rolename %> exists already."
+  :role_doesnt_exist:
+    en: "Role <%= rolename %> does not exist."
+  :role_created:
+    en: "Created role <%= rolename %>."
+  :role_deleted:
+    en: "Deleted role <%= rolename %>."
+  :privilege_granted_to_user:
+    en: "Granted privilege <%= privilege %> to user <%= username %>."
+  :privilege_revoked_from_user:
+    en: "Revoked privilege <%= privilege %> from user <%= username %>."
+  :privilege_granted_to_role:
+    en: "Granted privilege <%= privilege %> to role <%= rolename %>."
+  :privilege_revoked_from_role:
+    en: "Revoked privilege <%= privilege %> from role <%= rolename %>."
+  :role_added_to_user:
+    en: "Added role <%= rolename %> to user <%= username %>."
+  :role_removed_from_user:
+    en: "Removed role <%= rolename %> from user <%= username %>."
+  :role_added_to_role:
+    en: "Added role <%= rolename %> to role <%= rolename2 %>."
+  :role_removed_from_role:
+    en: "Removed role <%= rolename %> from role <%= rolename2 %>."
+:summary:
+  en: "Manage your users."
+:usage:
+  en: "see help access commands for all commands access provides."

data/data/butler/plugins/core/logout.rb

@@ -6,8 +6,6 @@
 
 
 
-trigger "logout"
-
 def on_trigger
 	if @butler.access.default_user == @message.from.access then
 		answer(:not_logged_in)
@@ -19,23 +17,25 @@ end
 
 __END__
 --- 
-:revision:
-  :plugin: 1
-:summary:
-  en: "Log out from the bot"
 :about:
   :mail: "apeiros@gmx.net"
   :version: "1.0.0"
   :author: "Stefan Rusterholz"
+:help:
+  en:
+    "": |
+      Using 'logout' you can log out from the bot.
+      Use it in order to prevent other people from abusing your account while you are not on your computer.
+:revision:
+  :plugin: 2
+:summary:
+  en: "Log out from the bot"
 :strings:
   :success:
     en: "You are now logged out."
   :not_logged_in:
     en: "You are not logged in, can't log you out."
+:trigger:
+  en: logout
 :usage:
   en: "![b]logout![o]"
-:help:
-  en:
-    "": |
-      Using 'logout' you can log out from the bot.
-      Use it in order to prevent other people from abusing your account while you are not on your computer.