rbot 0.9.9

data/INSTALL

@@ -0,0 +1,8 @@
+Just run rbot, it'll ask you for any core information it needs before it can
+start, after that you can configure everything else online using the config
+module.
+
+You can maintain multiple configurations at once. Start rbot with the
+location you want it to store runtime data in. By default, running rbot
+uses the ~/.rbot config directory. If you run 'rbot /path/to/foo', then the
+configuration will be stored to and read from there instead.

data/README

@@ -0,0 +1,44 @@
+rbot README
+===========
+
+rbot is a ruby IRC bot. Think of him as a ruby bot framework with a highly
+modular design based around plugins.
+
+rbot features
+=============
+
+* Runtime configuration via irc chat
+* User authentication and access levels for using different bot features
+* Built in infobot-style keywords. See example session below.
+* Support for underlying fact database (infobot fact files), which can
+  be overridden or supplemented by runtime keyword controls
+* Multi-language support - comes with english, dutch and german definitions
+  so far - more translations welcome
+* Powerful plugin architecture, comes with plugins for:
+  o DNS queries
+  o Babelfish translation
+  o Google searching
+  o Excuse generation
+  o Insult generation
+  o Karma
+  o Checking the weather
+  o Querying slashdot
+  o Doing Math
+  o Per-channel quote storage, searching and retrieval
+  o Reminders
+  o rot13 translation
+  o Check the spelling of a word
+  o Webserver Server: header examination
+  o RPG dice rolling
+  o larting people
+  o conversation stats
+  o more... 
+
+Thanks are owed to the infobot developers - several of rbot's features are
+inspired by infobot and so are some of the default plugins. Thanks are also
+owed to RADKade1, as rbot's quote plugin is a direct reimplementation of his
+"quotesaq" - simply because it's a great quote interface.
+
+Mainly, rbot's fun to play with, although the plugin architecture can be used
+to write very useful modules
+

data/REQUIREMENTS

@@ -0,0 +1,34 @@
+Ruby modules needed for rbot
+============================
+
+Core requirements
+      bdb (berkley db) http://www.ruby-lang.org/en/raa-list.rhtml?name=bdb
+                       (which requires libdb2 or better, from
+                       www.sleepycat.com)
+      net/http 1.1+
+      socket
+      uri
+
+Plugin requirements
+(these are all optional, if you don't have them, the plugins just won't
+function)
+
+babelfish, wserver:
+      net/http 1.2+
+
+slashdot, freshmeat, rss:
+      REXML
+
+External programs needed for rbot
+=================================
+
+Plugin requirements
+(These are all optional)
+
+host plugin:
+      host(1)
+
+spell plugin:
+      ispell(1)
+
+

data/TODO

@@ -0,0 +1,5 @@
+o freeze/thaw factoids (make them readonly) at higher auth
+o respond to insults
+o feed back errors from plugins (optional)
+o Allow users to leave messages to named users.
+o wtf plugin (bsdgames)

data/Usage_en.txt

@@ -0,0 +1,129 @@
+Installing Programs with setup.rb
+=================================
+    
+Quick Start
+-----------
+    
+  Type this (You might needs super user previledge):
+
+      ($ su)
+       # ruby setup.rb
+
+  If you want to install a program in to your home directory
+  ($HOME), use following instead:
+
+      $ ruby setup.rb all --prefix=$HOME
+
+    
+Detailed Installtion Process
+----------------------------
+    
+  setup.rb invokes installation by three steps.  There are
+  "config", "setup" and "install".  You can invoke each steps
+  separately as following:
+
+      $ ruby setup.rb config
+      $ ruby setup.rb setup
+      # ruby setup.rb install
+
+  You can controll installation process by giving detailed
+  options for each tasks.  For example, --bin-dir=$HOME/bin
+  let setup.rb install commands in $HOME/bin.
+    
+  For details, see "Task Options".
+    
+  Global Options
+  --------------
+    
+  "Global Option" is a command line option which you can use
+  for all tasks.  You must give a global option before any task
+  name.
+    
+    -q,--quiet
+        suppress message outputs
+    --verbose
+        output messages verbosely (default)
+    -h,--help
+        prints help and quit
+    -v,--version
+        prints version and quit
+    --copyright
+        prints copyright and quit
+    
+Tasks
+-----
+  These are acceptable tasks:
+    all
+        Invokes `config', `setup', then `install'.
+        Task options for all is same with config.
+    config
+        Checks and saves configurations.
+    show
+        Prints current configurations.
+    setup
+        Compiles ruby extentions.
+    install
+        Installs files.
+    clean
+        Removes created files.
+    distclean
+        Removes all created files.
+    
+  Task Options for CONFIG/ALL
+  ---------------------------
+    
+    --prefix=PATH
+        a prefix of the installing directory path
+    --stdruby=PATH
+        the directory for standard ruby libraries
+    --siterubycommon=PATH
+        the directory for version-independent non-standard
+        ruby libraries
+    --siteruby=PATH
+        the directory for non-standard ruby libraries
+    --bindir=PATH
+        the directory for commands
+    --rbdir=PATH
+        the directory for ruby scripts
+    --sodir=PATH
+        the directory for ruby extentions
+    --datadir=PATH
+        the directory for shared data
+    --rubypath=PATH
+        path to set to #! line
+    --rubyprog=PATH
+        the ruby program using for installation
+    --makeprog=NAME
+        the make program to compile ruby extentions
+    --without-ext
+        forces to setup.rb never to compile/install
+        ruby extentions.
+    --rbconfig=PATH
+        your rbconfig.rb to load
+    
+  You can view default values of these options by typing
+
+      $ ruby setup.rb --help
+
+    
+  If there's the directory named "packages",
+  You can also use these options:
+    --with=NAME,NAME,NAME...
+        Package names which you want to install.
+    --without=NAME,NAME,NAME...
+        Package names which you do not want to install.
+    
+  [NOTE] You can pass options for extconf.rb like this:
+
+      ruby setup.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0
+
+    
+  Task Options for INSTALL
+  ------------------------
+    
+    --no-harm
+        prints what to do and done nothing really.
+    --prefix=PATH
+        The prefix of the installing directory path.
+        This option may help binary package maintainers.
+        A default value is an empty string.

data/bin/rbot

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+# Copyright (C) 2002 Tom Gilbert.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies of the Software and its documentation and acknowledgment shall be
+# given in the documentation and software packages that this Software was
+# used.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+$VERBOSE=true
+
+require 'etc'
+require 'getoptlong'
+require 'fileutils'
+
+$version="0.9.9"
+$opts = Hash.new
+
+orig_opts = ARGV.dup
+
+opts = GetoptLong.new(
+  ["--debug", "-d", GetoptLong::NO_ARGUMENT],
+  ["--help",  "-h", GetoptLong::NO_ARGUMENT],
+  ["--trace",  "-t", GetoptLong::REQUIRED_ARGUMENT],
+  ["--version", "-v", GetoptLong::NO_ARGUMENT]
+)
+
+$debug = false
+opts.each {|opt, arg|
+  $debug = true if(opt == "--debug")
+  $opts[opt.sub(/^-+/, "")] = arg
+}
+
+if ($opts["trace"])
+  set_trace_func proc { |event, file, line, id, binding, classname|
+    if classname.to_s == $opts["trace"]
+      printf "TRACE: %8s %s:%-2d %10s %8s\n", event, File.basename(file), line, id, classname
+    end
+  }
+end
+
+begin
+  require 'rbot/ircbot'
+rescue LoadError => e
+  puts "Error: couldn't find the rbot/ircbot module for loading\n - did you install rbot using install.rb?"
+  exit 2
+end
+
+if ($opts["version"])
+  puts "rbot #{$version}"
+  exit 0
+end
+
+if ($opts["help"])
+  puts "usage: rbot [options] [config directory]"
+  puts "  -h, --help         this message"
+  puts "  -v, --version      version information"
+  puts "  -d, --debug        enable debug messages"
+  puts "config directory defaults to ~/.rbot"
+  exit 0
+end
+
+if(bot = Irc::IrcBot.new(ARGV.shift, :argv => orig_opts))
+  # just run the bot
+  bot.mainloop
+end
+

data/data/rbot/contrib/plugins/figlet.rb

@@ -0,0 +1,20 @@
+class FigletPlugin < Plugin
+  def help(plugin, topic="")
+    "figlet [<message>] => print using figlet"
+  end
+  def privmsg(m)
+	  case m.params
+	  when nil
+		  m.reply "incorrect usage: " + help(m.plugin)
+		  return
+	  when (/^-/)
+		  m.reply "incorrect usage: " + help(m.plugin)
+		  return
+	  else
+		  m.reply Utils.safe_exec("/usr/bin/figlet", "-k", "-f", "mini", m.params)
+		  return
+	  end
+  end
+end
+plugin = FigletPlugin.new
+plugin.register("figlet")

data/data/rbot/contrib/plugins/ri.rb

@@ -0,0 +1,83 @@
+#  Author:  Michael Brailsford  <brailsmt@yahoo.com>
+#           aka  brailsmt
+#  Purpose: To respond to requests for information from the ri command line
+#  utility.
+
+class RiPlugin < Plugin
+
+	@@handlers = {
+		"ri" => "ri_handler",
+		"msgri" => "msgri_handler"
+	}
+
+	#{{{
+	def initialize
+		super
+		@cache = Hash.new
+	end
+	#}}}
+	#{{{
+	def privmsg(m)
+		if not m.params
+			m.reply "uhmm... whatever"
+			return
+		end
+
+		meth = self.method(@@handlers[m.plugin])
+		meth.call(m)
+	end
+	#}}}
+	#{{{
+	def cleanup
+		@cache = nil
+	end
+	#}}}
+	#{{{
+	def ri_handler(m)
+		response = ""
+		if @cache[m.params]
+			response = @cache[m.params]
+		else
+			IO.popen("-") {|p|
+				if(p)
+					response = p.readlines.join "\n"
+					@cache[m.params] = response
+				else
+					$stderr = $stdout
+					exec("ri", m.params)
+				end
+			}
+			@cache[m.params] = response
+		end
+
+		@bot.say m.sourcenick, response
+		m.reply "Finished \"ri #{m.params}\"" 
+	end
+	#}}}
+	#{{{
+	def msgri_handler(m)
+		response = ""
+		tell_nick, query = m.params.split()
+		if @cache[query]
+			response = @cache[query]
+		else
+			IO.popen("-") {|p|
+				if(p)
+					response = p.readlines.join "\n"
+					@cache[m.params] = response
+				else
+					$stderr = $stdout
+					exec("ri", query)
+				end
+			}
+			@cache[query] = response
+		end
+
+		@bot.say tell_nick, response
+		m.reply "Finished telling #{tell_nick} about \"ri #{query}\"" 
+	end
+	#}}}
+end
+plugin = RiPlugin.new
+plugin.register("ri")
+plugin.register("msgri")

data/data/rbot/contrib/plugins/stats.rb

@@ -0,0 +1,232 @@
+#  Author:    Michael Brailsford  <brailsmt@yahoo.com>
+#             aka brailsmt
+#  Purpose:   Provides the ability to track various tokens that are spoken in a
+#             channel.
+#  Copyright: 2002 Michael Brailsford.  All rights reserved.
+#  License:   This plugin is licensed under the BSD license.  The terms of
+#             which follow.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions
+#  are met:
+#
+#  1. Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#
+#  2. Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+
+class StatsPlugin < Plugin
+
+	@@commands = { 
+		"stats" => "handle_stats",
+		"track" => "handle_track",
+		"untrack" => "handle_untrack", 
+		"listtokens" => "handle_listtokens",
+		"rmabuser" => "handle_rmabuser"
+	}
+
+	#{{{
+	def initialize
+		super
+		@listen = true
+		@channels = Hash.new
+		#check to see if a stats token file already exists for this channel...
+		Dir["#{@bot.botclass}/stats/*"].each { |fname|
+			channel = File.basename fname
+			tokens = Hash.new
+			IO.foreach(fname) { |line|
+				if line =~ /^(\S+)\s*<=>(.*)/
+					tokens[$1] = parse_token_stats $2
+				end
+			}
+			@channels[channel] = tokens
+		}
+	end
+	#}}}
+	#{{{
+	def cleanup
+		@channels = nil
+	end
+	#}}}
+	#{{{
+	def help(plugin, topic="")
+		"Stats:  The stats plugin tracks various tokens from users in the channel.  The tokens are only tracked if it is the only thing on a line.\nUsage:  stats <token>  --  lists the stats for <token>\n        [un]track <token>  --  Adds or deletes <token> from the list of tokens\n        listtokens  --  lists the tokens that are currently being tracked"
+	end
+	#}}}
+	#{{{
+	def privmsg(m)
+		if not m.params and not m.plugin =~ /listtokens/
+			m.reply "What a crazy fool!  Did you mean |help stats?"
+			return
+		end
+		
+		meth = self.method(@@commands[m.plugin])
+		meth.call(m)
+	end
+	#}}}
+	#{{{
+	def save
+		Dir.mkdir("#{@bot.botclass}/stats") if not FileTest.directory?("#{@bot.botclass}/stats")
+		#save the tokens to a file...
+		@channels.each_pair { |channel, tokens|
+			if not tokens.empty?
+				File.open("#{@bot.botclass}/stats/#{channel}", "w") { |f|
+					tokens.each { |token, datahash|
+						f.puts "#{token} <=> #{datahash_to_s(datahash)}"
+					}
+				}
+			else
+				File.delete "#{@bot.botclass}/stats/#{channel}"
+			end
+		}
+	end
+	#}}}
+	#{{{
+	def listen(m)
+		if not m.private?
+			tokens = @channels[m.target]
+			if not @@commands[m.plugin]
+				tokens.each_pair { |key, hsh|
+					if not m.message.scan(/#{Regexp.escape(key)}/).empty?
+						if hsh[m.sourcenick]
+							hsh[m.sourcenick] += 1
+						else
+							hsh[m.sourcenick] = 1
+						end
+					end
+				}
+			end
+		end
+#This is the old code	{{{
+#		if not m.private?
+#			tokens = @channels[m.target]
+#			hsh = tokens[m.message]
+#			if hsh
+#				if hsh[m.sourcenick]
+#					hsh[m.sourcenick] += 1
+#				else
+#					hsh[m.sourcenick] = 1
+#				end
+#			end
+#		end	}}}
+	end
+	#}}}
+	#The following are helper functions for the plugin	{{{
+		def datahash_to_s(dhash)
+			rv = ""
+			dhash.each { |key, val|
+				rv << "#{key}:#{val} "
+			}
+			rv.chomp
+		end
+
+		def parse_token_stats(stats)
+			rv = Hash.new
+			stats.split(" ").each { |nickstat|
+				nick, stat = nickstat.split ":"
+				rv[nick] = stat.to_i
+			}
+			rv
+		end
+		#}}}
+	#The following are handler methods for dealing with each command from IRC	{{{
+	#{{{
+	def handle_stats(m)
+		if not m.private?
+			total = 0
+			tokens = @channels[m.target]
+			hsh = tokens[m.params]
+			msg1 = ""
+			if not hsh.empty?
+				sorted = hsh.sort { |i, j| j[1] <=> i[1] }
+				sorted.each { |a|
+					total += a[1]
+				}
+
+				msg = "Stats for #{m.params}.  Said #{total} times.  The top sayers are "
+				if sorted[0..2]
+					msg << "#{sorted[0].join ':'}" if sorted[0]
+					msg << ", #{sorted[1].join ':'}" if sorted[1]
+					msg << ", and #{sorted[2].join ':'}" if sorted[2]
+					msg << "."
+
+					msg1 << "#{m.sourcenick} has said it "
+					if hsh[m.sourcenick]
+						msg1 << "#{hsh[m.sourcenick]} times."
+					else
+						msg1 << "0 times."
+					end
+				else
+					msg << "#{m.params} has not been said yet!"
+				end
+				@bot.action m.replyto, msg
+				@bot.action m.replyto, msg1 if msg1
+			else
+				m.reply "#{m.params} is not currently being tracked."
+			end
+		end
+	end
+	#}}}
+	#{{{
+	def handle_track(m)
+		if not m.private?
+			if @channels[m.target]
+				tokens = @channels[m.target]
+			else
+				tokens = Hash.new
+				@channels[m.target] = tokens
+			end
+			tokens[m.params] = Hash.new
+			m.reply "now tracking #{m.params}"
+		end
+	end
+	#}}}
+	#{{{
+	def handle_untrack(m)
+		if not m.private?
+			toks = @channels[m.target]
+			if toks.has_key? m.params
+				toks.delete m.params
+				m.reply "no longer tracking #{m.params}"
+			else
+				m.reply "Are your signals crossed?  Since when have I tracked that?"
+			end
+		end
+
+		toks = nil
+	end
+	#}}}
+	#{{{
+	def handle_listtokens(m)
+		if not m.private? and not @channels.empty?
+			tokens = @channels[m.target]
+			unless tokens.empty?
+				toks = ""
+				tokens.each_key { |k|
+					toks << "#{k} "
+				}
+				@bot.action m.replyto, "is currently keeping stats for:  #{toks}"
+			else
+				@bot.action m.replyto, "is not currently keeping stats for anything"
+			end
+		elsif not m.private?
+			@bot.action m.replyto, "is not currently keeping stats for anything"
+		end
+	end
+	#}}}
+	#{{{
+	def handle_rmabuser(m)
+		m.reply "This feature has not yet been implemented"
+	end
+	#}}}
+	#}}}
+
+end
+plugin = StatsPlugin.new
+plugin.register("stats")
+plugin.register("track")
+plugin.register("untrack")
+plugin.register("listtokens")
+#plugin.register("rmabuser")