rbot 0.9.10 → 0.9.12

data/README

@@ -1,38 +1,36 @@
-rbot README
-===========
+= rbot - The Ruby IRC bot
 
 rbot is a ruby IRC bot. Think of him as a ruby bot framework with a highly
 modular design based around plugins.
 
-rbot features
-=============
+== 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.
+* Built in infobot-style keywords.
 * 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
+* Multi-language support - comes with english, dutch, german, french, italian
+  japanese, chinese and russian 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... 
+  - DNS queries
+  - Babelfish translation
+  - Google searching
+  - Excuse generation
+  - Insult generation
+  - Karma
+  - Checking the weather
+  - Querying slashdot
+  - Doing Math
+  - Per-channel quote storage, searching and retrieval
+  - Reminders
+  - rot13 translation
+  - Check the spelling of a word
+  - Webserver Server: header examination
+  - RPG dice rolling
+  - larting people
+  - conversation stats
+  - 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

data/REQUIREMENTS

@@ -2,24 +2,47 @@ 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+
+      bdb (berkley db)      http://raa.ruby-lang.org/project/bdb/
+                            (which requires libdb4.x or better, formerly from
+                            www.sleepycat.com, now at
+                            http://www.oracle.com/technology/products/berkeley-db/index.html)
+                            Most of the time you don't need to compile anything.
+                            If you're running Linux, your distribution should
+                            have a libdb-ruby packaged (or similar).
+                            For Windows instructions, check at the bottom
+                            of this file.
+      net/http 1.2+
+      net/https             (for debian, this will also need libopenssl-ruby)
       socket
       uri
 
-      (for debian, you'll also need libopenssl-ruby)
+Useful but fallback provided
+      ruby-gettext 1.8.0+   http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext
+                            optional; if installed rbot can use localized messages
+      htmlentities          http://htmlentities.rubyforge.org/
+                            optional; if installed rbot will use it to decode
+                            HTML entities; if missing, an internal table with
+                            the most common HTML entities will be used instead
+      hpricot               http://code.whytheluckystiff.net/hpricot/
+                            optional, if installed rbot will used it to find
+                            the first paragraph in HTML files; if missing,
+                            regular expressions will be used instead
+
 
 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:
+bash, digg, slashdot, freshmeat, forecast:
       REXML
+rss:
+      rss
+shortenurls:
+      shorturl
+time:
+      tzinfo
+translator:
+      mechanize
 
 External programs needed for rbot
 =================================
@@ -27,6 +50,15 @@ External programs needed for rbot
 Plugin requirements
 (These are all optional)
 
+cal plugin:
+      cal(1)
+
+figlet plugin:
+      figlet(6)
+
+fortune plugin:
+      fortune(6)
+
 host plugin:
       host(1)
 
@@ -37,9 +69,23 @@ spell plugin:
 Running rbot on win32
 =====================
 
-here is bdb:
+You can install Ruby using the One-Click Ruby installer, available from
+http://rubyinstaller.rubyforge.org/
+
+You can find a precompiled version of the bdb package for ruby here
 http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz
 
-and you need the Win32 MinGW version of Ruby:
-http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ruby-1.8.4-i386-mingw32.tar.gz
+When you unpack the archive (e.g. using WinZip or 7-Zip or any other tool
+of your choice) you'll notice that it contains the following directory structure:
+  usr
+   +---local
+         +---doc
+         +---lib
+and you have to move the doc and lib folders (and all their contents) in the folder
+where you installed Ruby (typically C:\Ruby\)
+
+
+Further instructions
+====================
 
+For further instructions, check http://ruby-rbot.org/rbot-trac/wiki/InstallGuide

data/Rakefile

@@ -0,0 +1,215 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+
+task :default => [:buildext]
+
+spec = Gem::Specification.new do |s|
+  s.name = 'rbot'
+  s.version = '0.9.12'
+  s.summary = <<-EOF
+    A modular ruby IRC bot.
+  EOF
+  s.description = <<-EOF
+    A modular ruby IRC bot specifically designed for ease of extension via plugins.
+  EOF
+  s.requirements << 'Ruby, version 1.8.0 (or newer)'
+
+  #  s.files = Dir.glob("**/*").delete_if { |item| item.include?(".svn") }
+  s.files = FileList['lib/**/*.rb', 'bin/*', 'data/rbot/**/*', 'AUTHORS', 'COPYING', 'README', 'REQUIREMENTS', 'TODO', 'ChangeLog', 'INSTALL',  'Usage_en.txt', 'setup.rb', 'po/*.pot', 'po/**/*.po'].to_a.delete_if {|item| item == ".svn"}
+  s.bindir = 'bin'
+  s.executables = ['rbot', 'rbot-remote']
+  s.default_executable = 'rbot'
+  s.extensions = 'Rakefile'
+
+#  s.autorequire = 'rbot/ircbot'
+  s.has_rdoc = true
+  s.rdoc_options = ['--exclude', 'post-install.rb',
+  '--title', 'rbot API Documentation', '--main', 'README', 'README']
+
+  s.author = 'Tom Gilbert'
+  s.email = 'tom@linuxbrit.co.uk'
+  s.homepage = 'http://ruby-rbot.org'
+  s.rubyforge_project = 'rbot'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+# normalize a po/pot file
+def normalize_po(fn)
+  content = File.read(fn)
+
+  # sort the messages by file location
+  if MSGCAT
+    sorted = `#{MSGCAT} --width=79 --sort-by-file #{fn}`
+    if sorted != content
+      content = sorted
+      modified = true
+    end
+  end
+
+  # replace project-id-version placholder
+  modified |= content.sub!(/^("Project-Id-Version: )PACKAGE VERSION(\\n")$/) {
+    "#{$1}rbot#{$2}"
+  }
+
+  if modified
+    File.open(fn, 'w') {|f| f.write content}
+  end
+end
+
+PLUGIN_FILES = FileList['data/rbot/plugins/**/*.rb']
+NON_PLUGIN_FILES = FileList["{lib,bin,data}/**/*.{rb,rhtml}"] - PLUGIN_FILES
+
+# this task defines how po files and pot files are made. those rules are not defined
+# normally because po and pot files should be only updated in the updatepo task,
+# but po files are also prereqs for makemo
+task :define_po_rules do
+  # generate pot file from rb files
+  rgettext_proc = proc do |t|
+    require 'gettext/utils'
+    source_files, pot_file = t.prerequisites, t.name
+    new_pot_file = "#{pot_file}.new"
+    puts "#{source_files.join(', ')} => #{pot_file}"
+    GetText.rgettext(source_files, new_pot_file)
+
+    # only use the new pot file if it contains unique messages
+    if File.exists?(pot_file) && MSGCOMM && `#{MSGCOMM} --unique #{pot_file} #{new_pot_file}`.empty?
+      rm new_pot_file
+    else
+      mv new_pot_file, pot_file
+    end
+
+    normalize_po(pot_file)
+    
+    # save all this work until rb files are updated again
+    touch pot_file
+  end
+
+  # generate pot file for non-plugin files
+  file('po/rbot.pot' => NON_PLUGIN_FILES, &rgettext_proc)
+
+  # generate pot files for plugin files
+  rule(%r'^po/.+\.pot$' => proc {|fn|
+    PLUGIN_FILES.select {|f| f.pathmap('rbot-%n') == fn.pathmap('%n')}
+  }, &rgettext_proc)
+
+  # map the po file to its source pot file
+  pot_for_po = proc {|fn| fn.pathmap '%{^po/.+/,po/}X.pot'}
+
+  # update po file from pot file
+  msgmerge_proc = proc do |t|
+    require 'gettext/utils'
+    po_file, pot_file = t.name, t.source
+    puts "#{pot_file} => #{po_file}"
+    if File.exists? po_file
+      sh "#{MSGMERGE} --backup=off --update #{po_file} #{pot_file}"
+    elsif MSGINIT
+      locale = po_file[%r'^po/(.+)/.+\.po$', 1]
+      sh "#{MSGINIT} --locale=#{locale} --no-translator --input=#{pot_file} --output-file=#{po_file}"
+    else
+      warn "#{po_file} is missing and cannot be generated without msginit"
+      next
+    end
+    normalize_po(po_file)
+    touch po_file
+  end
+
+  # generate English po files
+  file(%r'^po/en_US/.+\.po$' => pot_for_po) do |t|
+    po_file, pot_file = t.name, t.source
+    if MSGEN
+      sh "#{MSGEN} --output-file=#{po_file} #{pot_file}"
+      normalize_po(po_file)
+      touch po_file
+    else
+      msgmerge_proc.call t
+    end
+  end
+
+  # update po files
+  rule(%r'^po/.+/.+\.po$' => pot_for_po, &msgmerge_proc)
+end
+
+# generate mo files
+rule(%r'^data/locale/.+/LC_MESSAGES/.+\.mo$' => proc {|fn|
+  [ fn.pathmap('%{^data/locale,po;LC_MESSAGES/,}X.po'), 
+    # the directory is created if not existing
+    fn.pathmap('%d') ]
+}) do |t|
+  po_file, mo_file = t.source, t.name
+  puts "#{po_file} => #{mo_file}"
+  require 'gettext/utils'
+  GetText.rmsgfmt po_file, mo_file
+end
+
+task :check_po_tools do
+  have = {}
+
+  po_tools = {
+    'msgmerge' => {
+      :options => %w[--backup= --update],
+      :message => 'Cannot update po files' },
+    'msginit' => {
+      :options => %w[--locale= --no-translator --input= --output-file=],
+      :message => 'Cannot generate missing po files' },
+    'msgcomm' => {
+      :options => %w[--unique],
+      :message => 'Pot files may be modified even without message change' },
+    'msgen' => {
+      :options => %w[--output-file],
+      :message => 'English po files will not be generated' },
+    'msgcat' => {
+      :options => %w[--width= --sort-by-file],
+      :message => 'Pot files will not be normalized' }
+  }
+
+  po_tools.each_pair do |command, value|
+    path = ENV["#{command.upcase}_PATH"] || command
+    have_it = have[command] = value[:options].all? do |option|
+      `#{path} --help`.include? option
+    end
+    Object.const_set(command.upcase, have_it ? path : false)
+    warn "#{command} not found. #{value[:message]}" unless have_it
+  end
+  abort unless MSGMERGE
+end
+
+PLUGIN_BASENAMES = PLUGIN_FILES.map {|f| f.pathmap('%n')}
+LOCALES = FileList['po/*/'].map {|d| d.pathmap('%n')}
+
+LOCALES.each do |l|
+  directory "data/locale/#{l}/LC_MESSAGES"
+end
+
+desc 'Update po files'
+task :updatepo => [:define_po_rules, :check_po_tools] + LOCALES.map {|l|
+  ["po/#{l}/rbot.po"] +
+  PLUGIN_BASENAMES.map {|n| "po/#{l}/rbot-#{n}.po"}
+}.flatten
+
+desc 'Normalize po files'
+task :normalizepo => :check_po_tools do
+  FileList['po/*/*.po'].each {|fn| normalize_po(fn)}
+end
+
+# this task invokes makemo if ruby-gettext is available, but otherwise succeeds
+# with a warning instead of failing. it is to be used by Gem's extension builder
+# to make installation not fail because of lack of ruby-gettext
+task :buildext do
+  begin
+    require 'gettext/utils'
+    Rake::Task[:makemo].invoke
+  rescue LoadError
+    warn 'Ruby-gettext cannot be located, so mo files cannot be built and installed' 
+  end
+end
+
+desc 'Generate mo files'
+task :makemo =>
+  FileList['po/*/*.po'].pathmap('%{^po,data/locale}d/LC_MESSAGES/%n.mo')
+
+

data/bin/rbot

@@ -1,27 +1,45 @@
 #!/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.
+=begin rdoc
+
+= rbot main executable
+
+Usage:
+
+  % rbot [options] [config directory]
+
+== Options
 
-$KCODE = 'u'
+[-h, --help]
+    display a help message and exit
+[-v, --version]
+    display version information and exit
+[-d, --debug]
+    enable debug messages
+[-l, --loglevel _level_]
+    sets the minimum log level verbosity
+[-b, --background]
+    background (daemonize) the bot
+[-p, --pidfile _filename_]
+    write the bot pid to _filename_
+
+The default config directory is <tt>~/.rbot</tt>.
+
+The default pidfile is <tt><i>botdir</i>/rbot.pid</tt>.
+
+The logfile is located at <tt><i>botdir</i>/<i>botname</i>.log</tt>, and
+the default loglevel is 1 (INFO messages). Possible values for the loglevel
+are 0 (DEBUG), 1 (INFO), 2 (WARN), 3 (ERROR), 4 (FATAL).
+
+Please note that the logfile doesn't contain IRC logs (which are located at
+<tt><i>botdir</i>/logs/*</tt>, but only rbot diagnostic messages.
+
+=end
+
+# Copyright (C) 2002-2006 Tom Gilbert.
+# Copyright (C) 2007-2008 Giuseppe Bilotta and the rbot development team
+#
+# This is free software, see COPYING for licensing details
 
 $VERBOSE=true
 
@@ -29,7 +47,8 @@ require 'etc'
 require 'getoptlong'
 require 'fileutils'
 
-$version="0.9.10"
+$version ||= '0.9.12'
+$version_timestamp ||= 0
 $opts = Hash.new
 
 orig_opts = ARGV.dup
@@ -40,10 +59,11 @@ opts = GetoptLong.new(
   ["--help",  "-h", GetoptLong::NO_ARGUMENT],
   ["--loglevel",  "-l", GetoptLong::REQUIRED_ARGUMENT],
   ["--trace",  "-t", GetoptLong::REQUIRED_ARGUMENT],
+  ["--pidfile", "-p", GetoptLong::REQUIRED_ARGUMENT],
   ["--version", "-v", GetoptLong::NO_ARGUMENT]
 )
 
-$debug = false
+$debug = $DEBUG
 $daemonize = false
 
 opts.each {|opt, arg|
@@ -52,7 +72,7 @@ opts.each {|opt, arg|
   $opts[opt.sub(/^-+/, "")] = arg
 }
 
-$cl_loglevel = $opts["loglevel"].to_i
+$cl_loglevel = $opts["loglevel"].to_i if $opts["loglevel"]
 
 if ($opts["trace"])
   set_trace_func proc { |event, file, line, id, binding, classname|
@@ -88,12 +108,14 @@ if ($opts["help"])
   puts "  -h, --help         this message"
   puts "  -v, --version      version information"
   puts "  -d, --debug        enable debug messages"
+  puts "  -l, --loglevel     sets the log level verbosity"
   puts "  -b, --background   background (daemonize) the bot"
+  puts "  -p, --pidfile      write the bot pid to file"
   puts "config directory defaults to ~/.rbot"
   exit 0
 end
 
-if(bot = Irc::IrcBot.new(ARGV.shift, :argv => orig_opts))
+if(bot = Irc::Bot.new(ARGV.shift, :argv => orig_opts))
   # just run the bot
   bot.mainloop
 end