butler 1.8.3 → 1.9.0

data/CHANGELOG.txt

@@ -1,5 +1,261 @@
 = Butler2
 
+=== 31st Dec, 2007
+* Butler 1.9.0 (rev #645)
+  * bin/botcontrol
+    * sync_plugins is now sync, in preparation of services syncing
+    * botcontrol without command brings up help dialog
+  * dev/logupdate.rb
+    * Added, updates logs created by log service introduced in svn after 1.8.3.
+  * data/butler/dialogs
+    * create
+      * Added question for 'invocation'.
+    * create and quickcreate
+      * Added some comments
+      * Fixed language question in create and quickcreate.
+      * Fixed language choice regexp
+      * Removed question for quicksetup.
+    * create_config
+      * Added a little diagnostic output.
+    * sync
+      * Obsoletes sync_plugins.
+      * Now syncs services too.
+      * Patch to provide more info on failure.
+    * sync_plugins
+      * Replaced by sync.
+    * username
+      * Added
+  * data/butler/plugins
+    * General
+      * Cleaned up plugins (use metadata instead of trigger method and clean up metadata)
+    * core/ping
+      * Added, temporary(?) workaround for the "cork effect" (see bugtracker).
+    * core/remote
+      * Added, provides minimal control for remote server.
+    * core/user
+      * Obsoleted by core/access.
+    * dev/eval
+      * Uses 'more...' now.
+      * Outputs the whole backtrace in case of an exception.
+      * Pass on Interrupts.
+    * dev/onhandlers
+      * Fixed on_part handler.
+      * Incremented revision so it can be synced.
+    * dev/rawlog
+      * Fixed a string.
+      * Fixed output of incomming messages.
+    * games/eightball
+      * Translated to german.
+    * games/countdown
+      * Added.
+    * operator/devoice
+      * Fixed method name typo
+      * Fixed answer string name typo
+    * public/help
+      * Fixed to correctly display help topics, updated the help text
+    * service/log
+      * Overhauled to use log service.
+    * service/calculator
+      * Added
+    * service/define
+      * Improved behaviour on empty results.
+      * Updated for new answer method with integrated 'more'.
+    * service/seen
+      * Added
+    * service/svn
+      * Updated documentation
+    * util/load
+      * Changed output format.
+      * Pass on Interrupts.
+  * data/butler/services/org.rubyforge.butler
+    * log/1/service.rb
+      * IMPORTANT: the old database format is incompatible, use dev/logupdate.rb to update your db before using the new service.
+      * Added #find_first, #find_last
+      * Added 'identified' field
+      * Added #logged_channels
+      * Logs the select statement as debug
+      * Fixed #sub_where
+      * Added initialization of $swig_runtime_data_type_pointer2 because the sqlite people failed to.
+      * Fixed #find_first and #find_last to accept the limitation parameter as single argument.
+      * QUIT messages of course don't have a channel.
+      * Fixed a few bugs regarding selects/finds.
+      * Now also logs :NICK and :TOPIC.
+      * Fixed init of $swig_runtime_data_type_pointer2 to respect its read-onliness.
+    * calculator/1/service.rb
+      * Added.
+  * lib
+    * General
+      * Added ISUPPORT support.
+      * Added PASS patch supplied by scoopr.
+      * Added support for single-char prefix command calls.
+    * access/admin
+      * Added Admin#admin?.
+    * blank.rb
+      * Added.
+    * butler.rb:
+      * Append to logfiles rather than truncate and write.
+      * Thread.abort_on_exceptions is only set to true if $DEBUG is set
+      * Only quits in the ensure if connected
+    * butler/bot.rb:
+      * Fixed ghosting (no longer tries to ghost itself)
+      * Added use of Butler::Remote::Server
+      * Added some docs
+      * Removed selftest
+      * Replaced sleep with a proper wait when waiting for ghost to take effect on login
+      * Added Message#formatted_arguments
+      * Improved Message#arguments
+      * Message#post_arguments no longer strips color information and keeps spacing as original
+      * Fixed sanitizing last argument in #arguments, #post_arguments and #formatted_arguments.
+      * Added #connected?
+      * Rescues Errno::ECONNREFUSED and retries.
+    * butler/control.rb
+      * Make use of the new username question.
+      * The struct returned by #user_config now includes service_repository.
+      * Corrected comment.
+    * lib/butler/debuglog.rb
+      * Added $stderr default for @raw_log
+      * Improved docs
+    * butler/initialvalues.rb
+      * Configuration now uses plugins instead of plugin as path.
+    * butler/irc/client.rb
+      * Added auto-capab (CAPAB will be activated automatically).
+      * #dispatch is now a separate method to allow message injection.
+      * Fixed #thread_read so reconnect can work properly.
+      * #wait_for now accepts a callback argument to run after starting to listen and before blocking.
+      * Fixed #initialize, used Socket#write instead of #write_with_eol.
+    * butler/irc/message.rb
+      * Message's hash equality is now object-identity.
+      * Added a bit documentation.
+      * Fixed #answer to work with other messages than just :PRIVMSG and :NOTICE and to raise on unsupported messages.
+      * Corrected supported messages by #answer
+      * Improved docs
+    * butler/irc/parser.rb
+      * Added #alter_expression.
+      * Added #same_nick? as it is connection/parser dependent.
+    * butler/irc/parser/commands.rb
+      * Obsoleted.
+    * butler/irc/parser/generic.rb
+      * Added command 410.
+      * Fixed erroneous CAPAB detection.
+      * Expression for nickname uses isupports nicklen value.
+    * butler/irc/parser/rfc2812.rb
+      * Added public? and private? to more commands.
+      * Fixed expression for nickname (8 chars max).
+    * butler/irc/socket.rb
+      * Updated diagnostics (informs about start of connection).
+      * Added #log_out to log outgoing messages.
+      * #read sets #connected? now.
+      * Pass on Interrupts.
+      * Renamed #write to #write_with_eol
+      * Added #connected?
+      * Added #multiple_modes
+      * Mode commands now split on too many targets
+    * butler/irc/string.rb
+      * Removed a comment.
+      * Removed #same_nick?, it's now in Butler::IRC::Parser.
+    * butler/plugin.rb
+      * Added #say
+      * Fixed #answer_with_lead.
+      * #answer* got optimizations for remote messages.
+      * Uses the full base path of the plugin as template for the config path.
+      * Aligned plugin_accessor to plugin_attribute - second arg is now default value.
+      * ::plugin_attribute now accepts a default value.
+    * butler/plugin/configproxy.rb
+      * Creates the path to the directory of the proxy.
+    * butler/plugin/more.rb
+      * Increased length of parts to 500 chars.
+      * Removed ',' before "[more...]".
+    * butler/plugins.rb
+      * Pass on Interrupts.
+      * Plugin is unloaded before calling ::on_unload now.
+    * butler/remote/*
+      * Added.
+    * butler/service.rb
+      * Fixed an attr_reader (forgot to change its name).
+      * Added an info-level output for loading a service.
+    * butler/services.rb
+      * Fixed a copy & paste error.
+    * configuration.rb
+      * Added more characters to escape
+      * Fixed loading files without keys.
+      * Moved #encode_filename to ::escape and #decode_filename to ::unescape.
+      * Removed String#config_key
+    * ruby/array/random.rb
+      * Fixed Array#random(n) with argument (would only pick from the first n elements).
+    * scriptfile.rb:
+      * No longer opens files always in r+ mode
+      * Doesn't automatically append __END__
+    * timingoutresource.rb
+      * Added.
+  * test
+    * test_scriptfile.rb
+      * Added groundwork for scriptfile tests.
+    * test_access.rb
+      * Updated for new access.
+  * Rakefile:
+    * Added warning for rake install
+    * Fixed tarball installation
+
+=== 6th Dec, 2007
+* Butler 1.8.3 (rev #485)
+  * bin/botcontrol: Fixed call of uninstall dialog.
+  * data/butler/dialogs
+    * create_config.rb
+      * Fixed a bug where setup via su for another user wouldn't work.
+    * quickcreate.rb:
+      * Fixed a 'say'.
+    * uninstall.rb:
+      * Fixed.
+  * data/butler/plugins
+    * operator/*:
+      * Translation to spanish, thanks to Rafael George.
+    * dev/bleakhouse.rb:
+      * Disables itself if $BLEAK_HOUSE is not defined or true.
+  * data/butler/services:
+    * org.rubyforge.butler/log:
+      * Added
+    * org.rubyforge.butler/strings:
+      * Added
+  * lib
+    * access:
+      * Updated, adapted access plugin and quickcreate to the changes.
+    * butler.rb:
+      * Added creation of service directory for new bots.
+    * butler/bot.rb:
+      * Added support for services
+      * Added #services
+    * butler/bot.rb:
+      * Adapted for updated access framework.
+    * butler/control.rb
+      * Added support for services.
+    * butler/initialvalues.rb
+      * Removed Strings and added Services from bot-skeleton.
+    * butler/plugin.rb: Fixed a bug (Exception::Detail instead of the correct Exception::Detailed).
+      * Added #service.
+      * Added ::plugin_attribute and ::plugin_accessor.
+    * butler/plugins.rb:
+      * Uses now ruby/string/camelcase instead of inline definition
+      * Sets its @logger
+    * butler/service.rb
+      * Added.
+    * butler/services.rb:
+      * Added.
+    * butler/irc/client.rb
+      * Added support for CAPAB IDENTIFY-MSG.
+    * butler/irc/message.rb:
+      * Added #identified? (uses CAPAB IDENTIFY-MSG).
+    * butler/irc/parser.rb:
+      * Added support for CAPAB IDENTIFY-MSG.
+    * butler/irc/parser/generic.rb:
+      * Added support for CAPAB IDENTIFY-MSG.
+    * butler/irc/parser/rfc2812.rb:
+      * Added support for CAPAB IDENTIFY-MSG.
+    * ruby/string/camelcase.rb:
+      * Added.
+    * ruby/array/random.rb
+      * Added.
+
+
 === 28th Nov, 2007
 * Butler 1.8.2 (rev #436)
   * bin/botcontrol:
@@ -170,43 +426,43 @@
 
 === 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.
+  * 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/README.txt

@@ -14,8 +14,18 @@ authorization system, a remote login server and thorough localization support.
 	gem install butler
 	sudo botcontrol setup
 
+=== From SVN
+	svn checkout svn://rubyforge.org/var/svn/butler/trunk
+	cd trunk
+	sudo rake install_gem
+	sudo botcontrol setup
+Notice, if checkout fails, try a few minutes later. Rubyforge drops anonymous svn connections on
+higher load.
+
 === From Tarball
 Download the latest release from http://rubyforge.org/frs/?group_id=1349&release_id=15267
+Note that Tarball installation is currently discouraged as there's no automatic way to remove
+the installed libs.
 	cd butler*
 	sudo rake install
 

data/Rakefile

@@ -16,10 +16,6 @@ require 'rake/packagetask'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'rake/contrib/rubyforgepublisher'
-require 'fileutils'
-require 'scriptfile'
-require 'yaml'
-require 'pp'
 
 include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', 'butler', 'version')
@@ -62,7 +58,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.3, 4th alpha release of butler2."
+DESC    = "Butler 1.9.0, 1st beta release of butler2."
 
 GemSpec = Gem::Specification.new do |s|
 	s.homepage              = HOMEPATH
@@ -116,6 +112,19 @@ desc "Default task, will install butler from tarball"
 
 desc 'Install butler from tarball'
 task :install do
+	puts "\e[41m\e[1m WARNING \e[0m"
+	puts "Tarball installation currently provides no way to uninstall the libraries."
+	puts "Since libraries installed via tarball have priority over gems,"
+	puts "you will have to delete all libraries manually before eventually installing"
+	puts "it as a gem."
+	puts "It is strongly recommended to use 'sudo rake install_gem' instead."
+	puts
+	print "Continue? [y/N]: "
+	abort("Nothing installed, terminating.") unless $stdin.gets =~ /^y(?:es?)?$/i
+	puts
+	puts "Installing..."
+	puts
+	
 	path    = OpenStruct.new(
 		:bin  => Config::CONFIG["bindir"],
 		:lib  => Config::CONFIG["sitedir"],
@@ -123,9 +132,10 @@ task :install do
 		:data => Config::CONFIG["datadir"]+'/butler',
 		:man  => Config::CONFIG["mandir"]+'/butler'
 	)
-	path.dialogs = path.data+'/dialogs'
-	path.plugins = path.data+'/plugins'
-	path.strings = path.data+'/strings'
+	path.dialogs  = path.data+'/dialogs'
+	path.services = path.data+'/services'
+	path.plugins  = path.data+'/plugins'
+	path.strings  = path.data+'/strings'
 
 	install = [
 		["src/bin/botcontrol",             path.bin,     "Installing Executable..."],
@@ -137,10 +147,11 @@ task :install do
 	]
 	replace = [
 		[path.lib+'/butler/control.rb', {
-			'%CONFIG_DIR%'  => path.etc.inspect,
-			'%DIALOGS_DIR%' => path.dialogs.inspect,
-			'%PLUGINS_DIR%' => path.plugins.inspect,
-			'%STRINGS_DIR%' => path.strings.inspect,
+			'%CONFIG_DIR%'   => path.etc.inspect,
+			'%DIALOGS_DIR%'  => path.dialogs.inspect,
+			'%PLUGINS_DIR%'  => path.plugins.inspect,
+			'%SERVICES_DIR%' => path.services.inspect,
+			'%STRINGS_DIR%'  => path.strings.inspect,
 		}]
 	]
 	config = {
@@ -280,4 +291,4 @@ task :check_version do
 		puts "Please update your version.rb to match the release version, currently #{VERS}"
 		exit
 	end
-end
+end

data/bin/botcontrol

@@ -85,7 +85,7 @@ options["start"]       = CLOptions.new("[botname]") {
 }
 options["setup"]        = CLOptions.new("[user]")
 options["stop"]         = CLOptions.new("[botname]")
-options["sync_plugins"] = CLOptions.new("[botname] [user]")
+options["sync"]         = CLOptions.new("[botname] [user]")
 options.each { |name, opt| opt.application_name "#{File.basename($0)} #{name}" }
 
 command = (ARGV.shift || "interactive").downcase
@@ -130,8 +130,9 @@ case command
 		botcontrol.discuss("info", false, :user => opt.argv.user)
 		
 	when "interactive"
-		botcontrol.discuss("create_config", false, :user => nil)
-		botcontrol.discuss("interactive")
+		botcontrol.discuss("help", false, :command => nil)
+		#botcontrol.discuss("create_config", false, :user => nil)
+		#botcontrol.discuss("interactive")
 
 	when "log"
 		botcontrol.discuss("create_config", false, :user => nil)
@@ -240,9 +241,9 @@ case command
 		botname = opt.argv.botname || botcontrol.discuss(:selectbot, false)[:botname]
 		Butler.stop(nil, botname)
 
-	when "sync_plugins"
+	when "sync"
 		botcontrol.discuss("create_config", false, :user => opt.argv.user)
-		botcontrol.discuss("sync_plugins", false,
+		botcontrol.discuss("sync", false,
 			:user    => opt.argv.user,
 			:path    => botcontrol.user_config(opt.argv.user),
 			:botname => opt.argv.botname