butler 1.8.0 → 1.8.1

data/CHANGELOG

@@ -1,4 +1,44 @@
 = Butler2
 
+=== 12th Oct, 2007
+* Butler 1.8.1
+	* 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

@@ -1,9 +1,9 @@
 = README for Butler2
 
 == Indexing
-Author:  Stefan Rusterholz <apeiros@gmx.net>
-Version: 2.0.0
-Website: http://butler.rubyforge.org
+* Author:  Stefan Rusterholz <apeiros@gmx.net>
+* Version: 2.0.0
+* Website: http://butler.rubyforge.org
 
 == About
 Butler is an easy to use IRC bot, extensible via plugins, with a full
@@ -15,8 +15,8 @@ authorization system, a remote login server and thorough localization support.
 	sudo botcontrol setup
 
 === From Tarball
-Download the latest release from 
-	cd butler2
+Download the latest release from http://rubyforge.org/frs/?group_id=1349&release_id=15267
+	cd butler*
 	sudo rake install
 
 === Notes
@@ -27,10 +27,10 @@ Botcontrol setup is only required once per user.
 
 == Synopsis
 	botcontrol create butler
-  botcontrol start butler
-  botcontrol stop butler
-  botcontrol list
-  botcontrol delete butler
+	botcontrol start butler
+	botcontrol stop butler
+	botcontrol list
+	botcontrol delete butler
 
 == Links
 * Butlers home: http://butler.rubyforge.org

data/Rakefile

@@ -84,7 +84,7 @@ GemSpec = Gem::Specification.new do |s|
 	s.rdoc_options         += RDOC_OPTS
 end
 
-Rake::RDocTask.new do |rdoc|
+RDOC = Rake::RDocTask.new do |rdoc|
     rdoc.rdoc_dir  = 'doc/rdoc'
     rdoc.options  += RDOC_OPTS
     rdoc.main      = "README"
@@ -111,6 +111,7 @@ end
 task :default => :install
 desc "Default task, will install butler from tarball"
 
+desc 'Install butler from tarball'
 task :install do
 	path    = OpenStruct.new(
 		:bin  => Config::CONFIG["bindir"],
@@ -178,7 +179,6 @@ task :install do
 	
 	puts "Done."
 end
-desc 'Install butler from tarball'
 
 desc 'Release the website and new gem version'
 task :deploy => [:check_version, :website, :release] do
@@ -207,71 +207,6 @@ task :install_gem_nodoc => [:clean, :package] do
 	sh "sudo gem install --no-rdoc --no-ri pkg/*.gem"
 end
 
-desc 'Generate plugins repository'
-task :generate_plugin_repository do
-	fields       = %w[PLUGIN REVISION VERSION AUTHOR DOWNLOAD SIZE]
-	descriptions = Hash.new { |h,k| h[k] = {} }
-	plugins      = {}
-	rm_r("web/compiled/downloads/plugins") if File.exist?("web/compiled/downloads/plugins")
-	rm_r("web/compiled/repository/plugins") if File.exist?("web/compiled/repository/plugins")
-	mkdir_p("web/compiled/downloads/plugins")
-	mkdir_p("web/compiled/repository/plugins/descriptions")
-	Dir.glob("data/plugins/**/*.rb") { |plugin|
-		puts " - #{plugin}"
-		begin
-			yaml = YAML.load(ScriptFile.read(plugin))
-		rescue => e
-			puts e
-			puts "failed to read data of #{plugin}, ignoring"
-			next
-		end
-
-		unless yaml[:revision] && yaml[:revision][:plugin]
-			puts "plugin #{plugin} does not have a plugin-revision, ignoring"
-			next
-		end
-		unless yaml[:summary] && yaml[:summary]["en"]
-			puts "plugin #{plugin} does not have a summary, ignoring"
-			next
-		end
-
-		tbz = "web/compiled/downloads/plugins/#{plugin[13..-4]}.tgz"
-		mkdir_p(File.dirname(tbz))
-		begin
-			sh %{ tar -czf #{tbz} #{plugin} }
-			version = yaml[:about] && yaml[:about][:version]
-			version = version[0,16] if version
-			author  = yaml[:about] && yaml[:about][:author]
-			author  = author[0,64] if author
-			plugins[plugin] = {
-				:plugin   => plugin.sub(/\.rb$/,''),
-				:revision => Integer(yaml[:revision][:plugin]),
-				:version  => version,
-				:author   => author,
-				:download => "/downloads/plugins/#{plugin}.tgz",
-				:size     => File.size(tbz)
-			}
-			yaml[:summary].each { |k,v|
-				descriptions[k][plugin] = v[0,128]
-			}
-		rescue => e
-			puts e
-			puts "plugin #{plugin} had an error, ignoring"
-			plugins.delete(plugin)
-			descriptions.each_value { |v| v.delete(plugin) }
-		end
-	}
-	descriptions.reject! { |k,v| v.empty? }
-	File.open("web/compiled/repository/plugins/list.yaml", "w") { |fh|
-		fh.write(plugins.to_yaml)
-	}
-	descriptions.each { |k,v|
-		dir = "web/compiled/repository/plugins/"+k
-		mkdir(dir)
-		File.open(dir+"/summaries.yaml", "w") { |fh| fh.write(v.to_yaml) }
-	}
-end
-
 desc 'Generate website files'
 task :website_generate do
 	cd "web" do
@@ -279,9 +214,19 @@ task :website_generate do
   end
 end
 
-# WARNING, this task is only intended for use on the authors system
-task :update_plugins do
-	puts "This has been moved to botcontrol sync_plugins"
+desc 'Validate website'
+task :website_validate => :website_generate do
+	require 'w3validator'
+	validator = W3Validator.new("web/compiled/**/*.html")
+	unless validator.validate_changed("web/validation.cache") { |file, valid| puts "Invalid: #{file}" unless valid } then
+		raise "Website did not validate, aborting task"
+	end
+	validator.cache("web/validation.cache")
+end
+
+desc 'Create docs for the website'
+task :website_docs => :rdoc do
+	mv(RDOC.rdoc_dir, "web/compiled/docs")
 end
 
 desc 'Upload website files to rubyforge'
@@ -293,7 +238,6 @@ task :website_upload do
 end
 
 desc 'Generate and upload website files'
-#, :generate_plugin_repository
 task :website => [:website_generate, :website_upload] # , :publish_docs
 
 desc 'Package and upload the release to rubyforge.'

data/bin/botcontrol

@@ -40,14 +40,6 @@ 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]")
@@ -80,151 +72,164 @@ options["start"]       = CLOptions.new("[botname]") {
 	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 '-w', '--warnings',                                  "Will enable warnings on stderr."
 }
+options["setup"]        = CLOptions.new("[user]")
 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
-			)
+command = ARGV.shift.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, 
+			: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("create_config", false, :user => nil)
+		botcontrol.discuss("config", false,
+			:botname => opt.argv.botname
+		)
+
+	when "create"
+		botcontrol.discuss("create_config", false, :user => nil)
+		botcontrol.discuss("create", false, :name => opt.argv.botname)
+
+	when "delete"
+		botcontrol.discuss("create_config", false, :user => nil)
+		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 "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)
-			
+	when "log"
+		botcontrol.discuss("create_config", false, :user => nil)
+		if opt[:help] then
+			puts opt.options.help
+			exit
+		end
+
+		botname  = opt.argv.botname
+		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
-			botcontrol.discuss("unknown_command", false, :command => command)
-	end
-else
-	botcontrol.discuss("interactive")
+			logfile.each { |entry| puts entry }
+		end
+
+	when "list"
+		botcontrol.discuss("list", false, :user => opt.argv.user)
+
+	when "rename"
+		botcontrol.discuss("create_config", false, :user => nil)
+		botcontrol.discuss("rename", false,
+			:botname => opt.argv.botname,
+			:newname => opt.argv.newname
+		)
+	
+	when "setup"
+		botcontrol.discuss("create_config", false, :user => opt.argv.user)
+
+	when "start"
+		botcontrol.discuss("create_config", false, :user => nil)
+		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
+		Butler.start(nil, botname, options)
+
+	when "stop"
+		botcontrol.discuss("create_config", false, :user => nil)
+		botname = opt.argv.botname || botcontrol.discuss(:selectbot, false)[:botname]
+		Butler.stop(nil, botname)
+
+	when "sync_plugins"
+		botcontrol.discuss("create_config", false, :user => opt.argv.user)
+		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