butler 1.8.1 → 1.8.2

data/CHANGELOG.txt

@@ -0,0 +1,212 @@
+= Butler2
+
+=== 28th Nov, 2007
+* Butler 1.8.2 (rev #436)
+  * bin/botcontrol:
+    * Added quickcreate
+    * Added 'dir' command
+    * Added -v/--verbose flag for start
+    * Added -d/--debug flag for start, sets $DEBUG
+    * Added fixes for bleakhouse support and problems with outdated ruby versions (fastthread)
+    * Fixed a message
+    * Fixed calling botcontrol without arguments
+    * Fixed wrong CLOptions declaration
+    * Removed -/--help flags in favor of the help command
+  * data/butler/dialogs:
+    * Added quickcreate
+    * Quickcreate now creates default_role
+    * Create is now thorough
+    * Added dialogs for 'dir' command
+    * Updated help
+  * data/butler/plugins:
+    * core/access.rb:
+      * Added, management of your users and privileges
+    * core/logout.rb:
+      * Refactored
+    * core/plugins.rb:
+      * Improved
+    * dev/bleakhouse.rb:
+      * Added
+    * games/roll.rb:
+      * Fixed rolling dice (dice had 0-(n-1) eyes instead of 1-n)
+    * operator/limit.rb:
+      * Now functional
+    * operator/*:
+      * Overhauled, using maps now
+    * service/define.rb:
+      * Uses 'more' now
+      * Small fix
+      * Adapted to new html of googles result page
+    * service/more.rb:
+      * Added, to provide access to "more" data in user sessions
+    * util/cycle.rb:
+      * Fixed a bug introduced by a newly added parameter to the on_part OnHandler
+    * util/load.rb:
+      * Uses metadata instead of trigger method
+      * Fixed a bug with OS X (used , instead of . for %CPU float)
+      * Changed output
+    * util/pong.rb:
+      * Uses metadata instead of trigger method
+  * lib:
+    * access/privilege.rb:
+      * Added #inspect to Privilege and Privileges
+    * access/roles.rb:
+      * Added #inspect to Role and Roles
+      * Added #description=, #description, #privileges and #roles to Role
+    * access/savable.rb:
+      * Added Savable#delete
+    * access/yamlbase.rb:
+      * Small fixes
+    * butler/bot.rb:
+      * Added debug/raw-logging of socket ops (read/write)
+      * Added #session to Butler::IRC::User
+      * Added a timeout for the on_quit event messages to plugins
+      * Added load path <bot>/lib
+      * Sends now on_login, on_disconnect and on_quit events
+      * Refactored for change from Users/Channels to UserList/ChannelList
+    * butler/debuglog.rb:
+      * Added
+    * butler/irc/client.rb:
+      * Improved documentation
+      * Fixed on_disconnect
+      * Fixed initialize (no longer ignores on_disconnect block)
+    * butler/irc/socket.rb:
+      * Better diagnostics when trying to write to an unconnected socket
+    * butler/irc/hostmask.rb:
+      * Fixed dummy state (is now functional)
+      * Improved documentation
+    * butler/irc/hostmask.rb:
+      * Added comment
+    * butler/irc/client.rb:
+      * Added license info
+      * Refactored Listeners
+    * butler/irc/client*:
+      * Moved from client.rb to own files, added ListenerList
+    * butler/irc/message.rb:
+      * Fixed documentation
+    * butler/irc/parser/rfc2812.rb:
+      * Fixed FIXMEs
+    * butler/irc/parser.rb:
+      * Refactored for change from Users/Channels to UserList/ChannelList
+    * butler/irc/socket.rb:
+      * Added #mode
+      * Deleted obsolete FIXME comment
+    * butler/irc/string.rb:
+      * Added String#same_nick?
+    * butler/irc/whois:
+      * Moved from client.rb to own file
+    * butler/plugin.rb:
+      * Added exceptions for invalid triggers/maps
+      * Fixed comments to reflect change from Users/Channels to UserList/ChannelList
+      * Initialize @mapping_type (avoid warning)
+      * #answer now uses More
+      * #answer_with_lead added
+      * Now prefixes answers with nicknames
+    * butler/plugin.rb:
+      * Added methods to intercept on_login, on_disconnect and on_quit events
+    * butler/plugin/configproxy.rb:
+      * Added #synchronize
+      * Improved documentation
+    * butler/plugin/mapper.rb:
+      * Complete rewrite
+    * butler/plugin/mapper.rb:
+      * Forgot to remove a debug output
+    * butler/plugin/mapper.rb:
+      * Fixed several bugs in the implementation
+    * butler/plugin/mapper.rb:
+      * Refactored
+    * butler/plugin/onhandlers.rb:
+      * Improved on_part
+      * Improved on_kick
+      * Improved on_kill
+      * Improved on_kline
+    * butler/plugin/mapper.rb:
+      * Included Comparable
+      * Added a constant for the priority
+      * Refactored for new priority rule (higher priority first)
+      * Respects that @mapping_type is already initialized
+      * Another set of fixes, also removed some debug outputs
+      * Fixed #inspect
+      * Fixed #<=>
+      * Fixed a bug in the regex generation code
+      * Deleted obsolete FIXME comment
+    * butler/plugin/matcher.rb:
+      * Included Comparable
+      * Refactored for new priority rule (higher priority first)
+    * butler/plugin/more.rb:
+      * Added
+    * butler/plugin/trigger.rb:
+      * Added a constant for the priority
+      * Fixed #<=>
+    * butler/plugins.rb:
+      * Plugins#identify now tests for complete filename, so 'oad' won't identify load.rb
+    * butler/session.rb:
+      * Added
+    * cloptions.rb:
+      * Fixed exception message
+    * diagnostics.rb:
+      * Added
+    * dialogline.rb:
+      * Deleted obsolete FIXME comments
+    * durations.rb:
+      * Added Kernel#second, #minute, #hour, #day, #week
+      * Removed Numeric#second, #minute, #hour, #day, #week
+    * installer.rb:
+      * Can now determine home paths on win using win32/etc gem
+    * ostructfixed.rb:
+      * Added OpenStruct#__hash__
+    * ruby/kernel/daemonize.rb:
+      * Removed fixmes and changed umode to 0066
+  * CHANGELOG, NEWS, README and TODO now all have .txt suffix
+  * website updated
+  * Renamed Butler::IRC::Channels to Butler::IRC::ChannelList
+  * Renamed Butler::IRC::Users to Butler::IRC::UserList
+  * Deleted obsolete channels.rb and users.rb (now in channellist.rb and userlist.rb)
+  * Rakefile
+    * Adapted for the new .txt suffixes
+    * Moved some requires that have dependencies to the tasks
+  * Added tests for lib/butler/plugin/mapper.rb
+  * core/privileges.rb replaced by the superior core/access.rb plugin
+
+=== 27th Oct, 2007
+* Butler 1.8.1 (rev #328)
+	* botcontrol
+		* New flag -l (lowercased L) overrides config and connects locally.
+		* Setup now allows to set botcontrol up for another user
+		* Fixed permissions of directories created for a user
+	* Log now uses logger instead of log_device, changes due to that in:
+		* lib/butler.rb
+		* lib/butler/bot.rb
+		* lib/butler/irc/socket.rb
+		* lib/butler/plugin.rb
+		* lib/irc/client.rb
+		* lib/log/comfort.rb
+	* lib/butler/irc/client.rb:
+		* Adapted to new Commands requiring specification of command-sets
+		* Added #load_command_set
+	* lib/butler/irc/parser/rfc2812.rb: Added, moved rfc2812 commands to it.
+	* lib/butler/irc/parser/generic.rb:
+		* moved rfc2812 commands to rfc2812.rb
+		* Added 396 RPL_HIDDENHOST
+	* lib/butler/irc/parser/commands.rb:
+		* Now loads only command-sets as specified
+		* Added #load, to post-load command-sets
+		* Added logging
+		* Added a warning if matching of a message fails
+	* lib/butler/irc/user.rb: Added #force_update.
+	* lib/butler/irc/parser.rb:
+		* Fixed logging of ParseErrors (forgot to initialize_details)
+		* Adapted to new Commands requiring specification of command-sets
+	* lib/configuration.rb: Changed separator from . to / to increase consistence.
+	* lib/log.rb: More documentation.
+	* lib/log/comfort.rb: Added #log_origin
+	* lib/log/entry.rb: Supports origin now.
+	* lib/butler.rb: Fixed a bug (::start wouldn't pass on the options param)
+	* lib/irc/client.rb: Now uses options[:server] if available
+	* lib/ruby/exception/detailed.rb: Hardened against misuse.
+	* lib/butler/irc/client.rb: Fixed a bug (forgot to include Log::Comfort)
+	* Rakefile: Added :website_docs task.
+	* README: updated.
+
+=== 7th Oct, 2007
+* Initial release of Butler2. Butler 1.8.x series is the alpha series of Butler2.

data/Rakefile

@@ -1,10 +1,13 @@
-$LOAD_PATH.unshift("lib")
+$LOAD_PATH.unshift(File.expand_path("lib"))
 
 # This Rakefile makes use of some task taken from Hoe, a gem by Ryan Davis.
 
+begin
+	require 'rubygems'
+rescue LoadError
+	warn "No rubygems present"
+end
 require 'ostructfixed'
-require 'rubyforge'
-require 'rubygems'
 require 'rbconfig'
 require 'rake'
 require 'rake/clean'
@@ -24,7 +27,7 @@ require File.join(File.dirname(__FILE__), 'lib', 'butler', 'version')
 RDOC_OPTS         = [
 	'--quiet',
 	'--title', 'Butler library API',
-	'--main',  'README',
+	'--main',  'README.txt',
 	'--charset', 'utf-8',
 	'--inline-source',
 	'--tab-width', '2',
@@ -44,7 +47,7 @@ CLEAN.include [
 	'**/.DS_Store', '**/._*',
 ]
 PKG_FILES         =
-	%w[CHANGELOG LICENSE.txt GPL.txt README Rakefile] +
+	%w[CHANGELOG.txt LICENSE.txt GPL.txt README.txt Rakefile] +
 	%w[bin/botcontrol] +
   Dir.glob("{data,conf,lib,test}/**/*")
 LOCAL_PATHS = {}
@@ -58,8 +61,8 @@ LOCAL_PATHS['strings'] = "#{LOCAL_PATHS['data']}/strings"
 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"
-DESC    = "Current alpha release of Butler"
+CHANGES = "See CHANGELOG.txt"
+DESC    = "Butler 1.8.2, 3rd alpha release of butler2."
 
 GemSpec = Gem::Specification.new do |s|
 	s.homepage              = HOMEPATH
@@ -72,7 +75,7 @@ GemSpec = Gem::Specification.new do |s|
 	s.platform              = Gem::Platform::RUBY
 	s.required_ruby_version = '>= 1.8.0'
 	s.has_rdoc              = true
-	s.extra_rdoc_files      = %w[README CHANGELOG GPL.txt LICENSE.txt]
+	s.extra_rdoc_files      = %w[README.txt CHANGELOG.txt GPL.txt LICENSE.txt]
 	s.summary               = "Butler - the IRC bot with class"
 	s.description           = s.summary
 	s.files                 = PKG_FILES
@@ -87,10 +90,10 @@ end
 RDOC = Rake::RDocTask.new do |rdoc|
     rdoc.rdoc_dir  = 'doc/rdoc'
     rdoc.options  += RDOC_OPTS
-    rdoc.main      = "README"
+    rdoc.main      = "README.txt"
     rdoc.rdoc_files.add [
-    	'README',
-    	'CHANGELOG',
+    	'README.txt',
+    	'CHANGELOG.txt',
     	'GPL.txt',
 			'LICENSE.txt',
     	'lib/**/*.rb'
@@ -242,6 +245,8 @@ task :website => [:website_generate, :website_upload] # , :publish_docs
 
 desc 'Package and upload the release to rubyforge.'
 task :release => [:clean, :package] do |t|
+	require 'rubyforge'
+
 	pkg = "pkg/#{GEM_NAME}-#{VERS}"
 	
 	#if $DEBUG then

data/bin/botcontrol

@@ -9,7 +9,10 @@
 
 
 begin
-	require 'rubygems'
+	require 'rubygems' # if rubygems is installed, you most likely want it be used
+rescue LoadError => e; end
+begin
+	require 'fastthread' # fixes potential bugs
 rescue LoadError => e; end
 begin
 	require 'butler'
@@ -26,10 +29,12 @@ begin
 	require 'time'
 	require 'yaml'
 
+	require 'bleak_house' if $BLEAK_HOUSE
+
 	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 "\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
@@ -45,6 +50,7 @@ options                = {}
 options["backup"]      = CLOptions.new("[botname] [backupname] [directory]")
 options["config"]      = CLOptions.new("[botname]")
 options["create"]      = CLOptions.new("[botname]")
+options["dir"]         = CLOptions.new("dirname botname")
 options["delete"]      = CLOptions.new("[botname]")
 options["help"]        = CLOptions.new("[command]")
 options["info"]        = CLOptions.new("[user]")
@@ -54,26 +60,27 @@ options["log"]         = CLOptions.new("[botname]") {
 	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 '-h', '--head',       'COUNT',      :head,       "List the first COUNT entries"
 	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"
+	o '-t', '--tail',       'COUNT',      :tail,       "List the last COUNT entries"
 }
 options["list"]        = CLOptions.new("[user]")
+options["quickcreate"] = CLOptions.new("[botname]")
 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 '-d', '--debug',       nil,            :debug,       "Activate raw logging and log debug messages."
 	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 '-l', '--local',       nil,            :local,       "Don't connect to configured server:port but to 127.0.0.1:6667"
 	o '-s', '--server',      'SERVER',       :server,      "Connect to SERVER instead of the configured."
+	o '-v', '--verbose',     nil,            :verbose,     "Sets $VERBOSE."
 	o '-w', '--warnings',                                  "Will enable warnings on stderr."
 }
 options["setup"]        = CLOptions.new("[user]")
@@ -81,14 +88,10 @@ options["stop"]         = CLOptions.new("[botname]")
 options["sync_plugins"] = CLOptions.new("[botname] [user]")
 options.each { |name, opt| opt.application_name "#{File.basename($0)} #{name}" }
 
-command = ARGV.shift.downcase
+command = (ARGV.shift || "interactive").downcase
 opt     = options[command].parse if options[command]
 
 case command
-	when nil
-		botcontrol.discuss("create_config", false, :user => nil)
-		botcontrol.discuss("interactive")
-
 	when "backup"
 		botcontrol.discuss("create_config", false, :user => nil)
 		botcontrol.discuss("backup", false, 
@@ -109,6 +112,10 @@ case command
 		botcontrol.discuss("create_config", false, :user => nil)
 		botcontrol.discuss("create", false, :name => opt.argv.botname)
 
+	when "dir"
+		botcontrol.discuss("create_config", false, :user => nil)
+		botcontrol.discuss("dir", false, :dirname => opt.argv.dirname, :botname => opt.argv.botname)
+
 	when "delete"
 		botcontrol.discuss("create_config", false, :user => nil)
 		botcontrol.discuss("delete", false, :name => opt.argv.botname)
@@ -122,6 +129,10 @@ case command
 	when "info"
 		botcontrol.discuss("info", false, :user => opt.argv.user)
 		
+	when "interactive"
+		botcontrol.discuss("create_config", false, :user => nil)
+		botcontrol.discuss("interactive")
+
 	when "log"
 		botcontrol.discuss("create_config", false, :user => nil)
 		if opt[:help] then
@@ -194,6 +205,10 @@ case command
 	when "list"
 		botcontrol.discuss("list", false, :user => opt.argv.user)
 
+	when "quickcreate"
+		botcontrol.discuss("create_config", false, :user => nil)
+		botcontrol.discuss("quickcreate", false, :name => opt.argv.botname)
+
 	when "rename"
 		botcontrol.discuss("create_config", false, :user => nil)
 		botcontrol.discuss("rename", false,
@@ -206,12 +221,18 @@ case command
 
 	when "start"
 		botcontrol.discuss("create_config", false, :user => nil)
-		botname = botcontrol.discuss(:start, false, :botname => opt.argv.botname)[:botname]
-		options = {:daemonize => !opt["-i"]}
+		botname  = botcontrol.discuss(:start, false, :botname => opt.argv.botname)[:botname]
+		options  = {:daemonize => !opt["-i"]}
 		if opt[:local] then
 			options[:server] = "127.0.0.1"
 			options[:port]   = 6667
 		end
+		if opt[:debug] then
+			$DEBUG   = true
+			$VERBOSE = true
+		elsif opt[:verbose]
+			$VERBOSE = true
+		end
 		Butler.start(nil, botname, options)
 
 	when "stop"

data/data/butler/dialogs/create.rb

@@ -10,44 +10,33 @@ 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)
+nick = name
+bot.config["connections/main/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/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/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])
+bot.config["connections/main/real"]            = ask(:real, name+" (Butler IRC bot)", String, :between  => [1, 32])
+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|
+	say(:config_channel, :name => channel)
+	prefix = "channels/#{server.config_key}/#{channel.config_key}"
+	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])
 
-#Object#methods has an undocumented parameter
+puts
+say(:how_to_start, :botname => nick, :user => user, :pass => pass)