butler 1.8.0

data/bin/botcontrol

@@ -0,0 +1,230 @@
+#!/usr/bin/env ruby
+
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+begin
+	require 'rubygems'
+rescue LoadError => e; end
+begin
+	require 'butler'
+	require 'butler/bot'
+	require 'butler/control'
+	require 'cloptions'
+	require 'dialogline'
+	require 'fileutils'
+	require 'installer'
+	require 'log/entry'
+	require 'log/filereader'
+	require 'ostructfixed'
+	require 'rbconfig'
+	require 'time'
+	require 'yaml'
+
+	require 'pp' # FIXME
+rescue LoadError => e
+	puts "\e[31m\e[43mWarning, can't run botcontrol\e[0m\nYour installation is incomplete. Your ruby"+
+			 "installation is missing the file #{e.message.sub(/.*? -- /, '')}."
+	puts "Backtrace:", *e.backtrace
+	exit
+end
+
+begin
+	botcontrol        = Butler::Control.new
+rescue Errno::EACCES
+	puts "Can't create initial configuration, you should run #{$0} with sudo."
+	exit
+end
+begin
+	botcontrol.configure_user unless botcontrol.configured?
+rescue Errno::EACCES
+	puts "Can't configure for '#{botcontrol.user}', you should run #{$0} with sudo."
+	exit
+end
+Butler.path       = botcontrol.butler_path
+	
+
+options                = {}
+options["backup"]      = CLOptions.new("[botname] [backupname] [directory]")
+options["config"]      = CLOptions.new("[botname]")
+options["create"]      = CLOptions.new("[botname]")
+options["delete"]      = CLOptions.new("[botname]")
+options["help"]        = CLOptions.new("[command]")
+options["info"]        = CLOptions.new("[user]")
+options["log"]         = CLOptions.new("[botname]") {
+	o '-e', '--end-date',   'END_DATE',   :end_date,   "List only entries before END_DATE"
+	o '-f', '--find',       'TEXT',       :find,       "List only entries that contain TEXT"
+	o '-F', '--no-find',    'TEXT',       :no_find,    "List only entries that don't contain TEXT"
+	o '-g', '--grep',       'PATTERN',    :grep,       "List only entries that match PATTERN"
+	o '-G', '--no-grep',    'PATTERN',    :no_grep,    "List only entries that don't match PATTERN"
+	o '-H', '--head',       'COUNT',      :head,       "List the first COUNT entries"
+	o '-h', '--help',       nil,          :help,       "Display this help"
+	o '-l', '--level',      'LEVEL, ...', :level,      "List only entries of LEVEL"
+	o '-L', '--not-level',  'LEVEL, ...', :no_level,   "List only entries not of LEVEL"
+#	o '-o', '--out',        'FORMAT',     :format,     "Print entries using FORMAT"
+#	o '-p', '--page',       'NUMBER',     :page,       "Show NUMBER entries per page"
+	o '-s', '--start-date', 'START_DATE', :start_date, "List only entries after START_DATE"
+	o '-T', '--tail',       'COUNT',      :tail,       "List the last COUNT entries"
+}
+options["list"]        = CLOptions.new("[user]")
+options["rename"]      = CLOptions.new("[botname] [newname]")
+options["start"]       = CLOptions.new("[botname]") {
+	o '-c', '--channels',    'CHANNEL, ...', :channels,    "Join CHANNELS instead of configured"
+	o '-h', '--help',                                      "Display this help"
+	o '-i', '--interactive',                               "Don't deamonize, lets the bot run interactively in shell."
+	o '-n', '--nick',        'NICK',         :nick,        "Use NICK instead of configured"
+	o '-p', '--port',        'PORT',         :port,        "Connect at PORT instead of configured"
+	o '-r', '--remote',      'PORT',         :remote_port, "Start remote control server and bind to PORT"
+	o '-s', '--server',      'SERVER',       :server,      "Connect to SERVER instead of the configured."
+	o '-w', '--warnings',                                  "Will enable warnings on stderr."
+}
+options["stop"]         = CLOptions.new("[botname]")
+options["sync_plugins"] = CLOptions.new("[botname] [user]")
+options.each { |name, opt| opt.application_name "#{File.basename($0)} #{name}" }
+
+
+if %w(-v --version).include?(ARGV[0]) then
+	puts Butler::VERSION::STRING
+elsif ARGV[0] then
+	command = ARGV.shift.downcase
+	opt     = options[command].parse if options[command]
+	case command
+		when "backup"
+			botcontrol.discuss("backup", false, 
+				:bot          => opt.argv.botname,
+				:name         => opt.argv.backupname,
+				:dir          => opt.argv.directory,
+				:default_name => opt.argv.botname ? "#{opt.argv.botname}.bak" : nil,
+				:default_dir  => user_config.backups
+			)
+
+		when "config"
+			botcontrol.discuss("config", false,
+				:botname => opt.argv.botname
+			)
+
+		when "create"
+			botcontrol.discuss("create", false, :name => opt.argv.botname)
+
+		when "delete"
+			botcontrol.discuss("delete", false, :name => opt.argv.botname)
+
+		when "help"
+			botcontrol.discuss("help", false,
+				:command => opt.argv.command,
+				:options => options
+			)
+
+		when "info"
+			botcontrol.discuss("info", false, :user => opt.argv.user)
+			
+		when "log"
+			if opt[:help] then
+				puts opt.options.help
+				exit
+			end
+
+			botname  = opt.argv.botname
+			p filename = Butler::Bot.new(nil, botname).path.log+'/error.log'
+			logfile  = Log::FileReader.new(filename)
+			filters  = []
+			
+			if opt[:grep] then
+				regexp = Regexp.new(opt[:grep])
+				filters << "matching #{regexp.inspect}"
+				logfile.add_filter(:grep, regexp)
+			end
+			if opt[:no_grep] then
+				regexp = Regexp.new(opt[:no_grep])
+				filters << "not matching #{regexp.inspect}"
+				logfile.add_filter(:no_grep, regexp)
+			end
+			if opt[:find] then
+				filters << "containing #{opt[:find].inspect}"
+				logfile.add_filter(:find, opt[:find])
+			end
+			if opt[:no_find] then
+				filters << "not containing #{opt[:no_find].inspect}"
+				logfile.add_filter(:no_find, opt[:no_find])
+			end
+			if opt[:start_date] then
+				start_date = Time.parse(opt[:start_date])
+				filters << "after #{start_date.strftime('%F %T')}"
+				logfile.add_filter(:start_date, start_date)
+			end
+			if opt[:end_date] then
+				end_date = Time.parse(opt[:end_date])
+				filters << "before #{end_date.strftime('%F %T')}"
+				logfile.add_filter(:end_date, end_date)
+			end
+			if opt[:level] then
+				level = opt[:level]
+				filters << "of level #{level[0..-2].join(', ')}#{' or ' if level.size > 1}#{level.last}"
+				logfile.add_filter(:one_of_levels, level.map { |l| l.to_sym })
+			end
+			if opt[:no_level] then
+				level = opt[:no_level]
+				filters << "not of level #{level[0..-2].join(', ')}#{' or ' if level.size > 1}#{level.last}"
+				logfile.add_filter(:none_of_levels, level.map { |l| l.to_sym })
+			end
+			
+			abbrname = filename.count('/') > 3 ? '...'+filename[%r{(?:/[^/]+){3}$}] : filename
+			if opt[:head] then
+				print "First #{opt[:head]} entries in #{abbrname} "
+			elsif opt[:tail] then
+				print "Last #{opt[:tail]} entries in #{abbrname} "
+			else
+				print "Entries in #{filename} "
+			end
+			
+			puts("#{filters[0..-2].join(', ')}#{' and ' if filters.size > 1}#{filters.last}")
+			if opt[:head] then
+				logfile.head(Integer(opt[:head])) { |entry| puts entry }
+			elsif opt[:tail] then
+				logfile.tail(Integer(opt[:tail])) { |entry| puts entry }
+			else
+				logfile.each { |entry| puts entry }
+			end
+
+		when "list"
+			botcontrol.discuss("list", false, :user => opt.argv.user)
+
+		when "rename"
+			botcontrol.discuss("rename", false,
+				:botname => opt.argv.botname,
+				:newname => opt.argv.newname
+			)
+		
+		when "setup"
+			 # prompt to delete old config and create a new one
+
+		when "start"
+			botname = botcontrol.discuss(:start, false, :botname => opt.argv.botname)[:botname]
+			options = {:daemonize => !opt["-i"]}
+			Butler.start(nil, botname, options)
+
+		when "stop"
+			botname = opt.argv.botname || botcontrol.discuss(:selectbot, false)[:botname]
+			Butler.stop(nil, botname)
+
+		when "sync_plugins"
+			botcontrol.discuss("sync_plugins", false,
+				:user    => opt.argv.user,
+				:path    => botcontrol.user_config(opt.argv.user),
+				:botname => opt.argv.botname
+			)
+
+		when "uninstall"
+			botcontrol.discuss("uninstall", false, :path => path, :config => config)
+			
+		else
+			botcontrol.discuss("unknown_command", false, :command => command)
+	end
+else
+	botcontrol.discuss("interactive")
+end

data/data/butler/config_template.yaml

@@ -0,0 +1,4 @@
+--- 
+:language: en
+:users: {}
+:revision: 1

data/data/butler/dialogs/backup.rb

@@ -0,0 +1,19 @@
+store(:bot,  variables.bot)
+store(:name, variables.name)
+store(:dir,  variables.dir)
+success = false
+until success
+	response(:option, :bot,  Butler.list) unless variables.bot
+	response(:ask,    :name, variables.default_name || "#{result[:bot]}.bak") unless variables.name
+	response(:ask,    :dir,  variables.default_dir) unless variables.dir
+
+	begin
+		Butler.backup(result[:bot], result[:name], result[:dir])
+	rescue => e
+		p e
+		success = !prompt(:failure)
+	else
+		say(:success)
+		success = true
+	end
+end

data/data/butler/dialogs/botcontrol.rb

@@ -0,0 +1,4 @@
+say(:configuring, :name => variables.user)
+response(:option, :config, variables.installer.user_config_suggestions)
+response(:option, :bots, variables.installer.user_data_suggestions.map { |sug| sug+"/bots" })
+response(:option, :run,  variables.installer.user_pid_suggestions)

data/data/butler/dialogs/config.rb

@@ -0,0 +1 @@
+response(:context, "notyetimplemented", :feature => "Configure")

data/data/butler/dialogs/create.rb

@@ -0,0 +1,53 @@
+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)
+		
+#if prompt(:quicksetup, true) then
+	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)
+	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])
+	
+	
+#else
+#	"irc.server",     ask(:server,  "irc.freenode.org", String,  :min      => 3))
+#	"irc.port",       ask(:port,     6667,              Integer, :between  => [0, 65535]))
+#	"login.nick",     ask(:nick,    name,               String,  :matching => /\A#[A-Za-z0-9_-]{2,40}\z/))
+#	"login.user",     ask(:user,    name,               String,  :matching => /\A#[A-Za-z0-9_-]{2,40}\z/))
+#	"login.real",     ask(:real,    "#{name} (Butler IRC bot)", String,  :matching => /\A#[A-Za-z0-9_-]{2,40}\z/))
+#	"language",       ask(:language,    "en",   String,  :matching => /\A#[A-Za-z0-9_-]{2,40}\z/))
+#	Butler.configure(name, "login.channels", ask(:channels,    nil,    Array,   String, :matching => /\A#[^\0\s,]+\z/))
+#end
+puts
+say(:how_to_start)
+
+#Object#methods has an undocumented parameter

data/data/butler/dialogs/delete.rb

@@ -0,0 +1,3 @@
+name = variables.name || ask(:name, "butler", String,  :matching => /\A[A-Za-z0-9_]+\z/)
+Butler.delete(nil, name)
+say(:deleted, :name => name)

data/data/butler/dialogs/en/backup.yaml

@@ -0,0 +1,6 @@
+--- 
+:bot:     "Please select the bot to backup"
+:name:    "Name of the backup"
+:dir:     "Write the backup to directory"
+:success: "Backup created."
+:failure: "Failed to create a backup."

data/data/butler/dialogs/en/botcontrol.yaml

@@ -0,0 +1,5 @@
+--- 
+:configuring: "Setting up configuration for <%= name %>."
+:config:      "Please choose where config is stored"
+:bots:        "Please choose where bots are stored"
+:run:         "Please choose where to put pid-files"

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

@@ -0,0 +1,11 @@
+--- 
+: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 %>'"

data/data/butler/dialogs/en/delete.yaml

@@ -0,0 +1,2 @@
+--- 
+:deleted: "Deleted '<%= name %>'."

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

@@ -0,0 +1,17 @@
+--- 
+: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"
+: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/

data/data/butler/dialogs/en/info.yaml

@@ -0,0 +1,13 @@
+--- 
+:no_such_user: "There is no user named <%= name %> registered."
+:paths: |
+  Version:       <%= Butler::VERSION::STRING %>
+  Botcontrol:    <%= botcontrol %>
+  Configuration: <%= config_path  %>
+:users_heading: "Users:"
+:user: |
+    <%= name %>:
+      bots:     <%= bots %>
+      pidfiles: <%= run %>
+      config:   <%= config %>
+      language: <%= language %>

data/data/butler/dialogs/en/list.yaml

@@ -0,0 +1,4 @@
+--- 
+:nobots: "No bots available."
+:bots:   "Available bots (<%= bot_count %>):"
+:abot:   " -<%= bot %>"

data/data/butler/dialogs/en/notyetimplemented.yaml

@@ -0,0 +1,2 @@
+--- 
+:notyetimplemented: "<%= feature %> is not yet implemented."

data/data/butler/dialogs/en/rename.yaml

@@ -0,0 +1,3 @@
+--- 
+:new_name: "The new name of the bot"
+:renamed:  "Renamed '<%= old_name %>' to '<%= new_name %>'."

data/data/butler/dialogs/en/start.yaml

@@ -0,0 +1,3 @@
+--- 
+:discourage: "Running butler as root is STRONGLY discouraged.\nButler will start in 10s."
+:starting:   "Starting <%= name %>"

data/data/butler/dialogs/en/sync_plugins.yaml

@@ -0,0 +1,3 @@
+--- 
+:updating:       "Updating plugins for '<%= name %>'"
+:override_newer: "Override newer plugin <%= name %> (Yours <%= a.strftime('%F %T') %>, Copying <%= b.strftime('%F %T') %>"

data/data/butler/dialogs/en/uninstall.yaml

@@ -0,0 +1,5 @@
+--- 
+:uninstalling_botcontrol: "Uninstalling botcontrol..."
+:uninstall_user: "Do you want to delete <%= name %>'s bots and settings?"
+:must_run_as_sudo: "You must run this with sudo."
+:run_gem_uninstall: "Run now 'sudo gem uninstall butler' to uninstall all remaining bits."

data/data/butler/dialogs/en/unknown_command.yaml

@@ -0,0 +1,2 @@
+--- 
+:unknown: "Unknown command '<%= command %>'."

data/data/butler/dialogs/help.rb

@@ -0,0 +1,11 @@
+if variables.command then
+	case variables.command
+		when "tutorial":      say(:tutorial)
+		when "documentation": say(:documentation)
+		when "plugins":       say(:plugins)
+		else
+			variables.options[variables.command].help
+	end
+else
+	say(:help)
+end

data/data/butler/dialogs/info.rb

@@ -0,0 +1,27 @@
+if variables.user && botcontrol.configured?(variables.user) then
+	user_config = botcontrol.user_config(variables.user)
+	say(:user,
+		:name     => variables.user,
+		:bots     => user_config[:bots],
+		:run      => user_config[:run],
+		:language => user_config[:language]
+	)
+elsif variables.user
+	say(:no_such_user, :name => variables.user)
+else
+	say(:paths,
+		:botcontrol  => File.expand_path($0),
+		:config_path => variables.botcontrol.path[:config]
+	)
+	say(:users_heading)
+	variables.botcontrol.config[:users].sort.each { |user, conf|
+		user_config = variables.botcontrol.user_config(user)
+		say(:user,
+			:name     => user,
+			:bots     => user_config[:bots],
+			:run      => user_config[:run],
+			:config   => conf,
+			:language => user_config[:language]
+		)
+	}
+end