bin/rbot

   1 #!/usr/bin/env ruby
   2
   3 =begin rdoc
   4
   5 = rbot main executable
   6
   7 Usage:
   8
   9   % rbot [options] [config directory]
  10
  11 == Options
  12
  13 [-h, --help]
  14     display a help message and exit
  15 [-v, --version]
  16     display version information and exit
  17 [-d, --debug]
  18     enable debug messages
  19 [-l, --loglevel _level_]
  20     sets the minimum log level verbosity
  21 [-b, --background]
  22     background (daemonize) the bot
  23 [-p, --pidfile _filename_]
  24     write the bot pid to _filename_
  25
  26 The default config directory is <tt>~/.rbot</tt>.
  27
  28 The default pidfile is <tt><i>botdir</i>/rbot.pid</tt>.
  29
  30 The logfile is located at <tt><i>botdir</i>/<i>botname</i>.log</tt>, and
  31 the default loglevel is 1 (INFO messages). Possible values for the loglevel
  32 are 0 (DEBUG), 1 (INFO), 2 (WARN), 3 (ERROR), 4 (FATAL).
  33
  34 Please note that the logfile doesn't contain IRC logs (which are located at
  35 <tt><i>botdir</i>/logs/*</tt>, but only rbot diagnostic messages.
  36
  37 =end
  38
  39 # Copyright (C) 2002 Tom Gilbert.
  40 #
  41 # Permission is hereby granted, free of charge, to any person obtaining a copy
  42 # of this software and associated documentation files (the "Software"), to
  43 # deal in the Software without restriction, including without limitation the
  44 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  45 # sell copies of the Software, and to permit persons to whom the Software is
  46 # furnished to do so, subject to the following conditions:
  47 #
  48 # The above copyright notice and this permission notice shall be included in
  49 # all copies of the Software and its documentation and acknowledgment shall be
  50 # given in the documentation and software packages that this Software was
  51 # used.
  52 #
  53 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  54 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  55 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  56 # THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  57 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  58 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  59
  60 # Most of the string processing across rbot is done against IRC messages, which
  61 # do not have a well-defined encoding. Although many clients are now using
  62 # UTF-8, there is no guarantee that an arbitrary string received from IRC will
  63 # be UTF-8 encoded. We have to force ASCII (byte-wise/charset agnostic)
  64 # matching because otherwise some strings can give problems: in particular, for
  65 # example, the bytesequence "\340\350\354\362\371" (that is the aeiou vowels,
  66 # each with a grave accent) will cause the string to be considered up to the
  67 # "\354" (i with grave accent) only: so either the rest of the message is
  68 # ignored, or the matching fails.
  69 $KCODE = 'a'
  70
  71 $VERBOSE=true
  72
  73 require 'etc'
  74 require 'getoptlong'
  75 require 'fileutils'
  76
  77 $version="0.9.11-svn"
  78 $opts = Hash.new
  79
  80 if $version =~ /svn/
  81   if defined?(SVN_DIR) and File.exists?(File.join(SVN_DIR, '.git'))
  82     $version.sub!('svn', 'git')
  83
  84     git_out = `git status`
  85
  86     git_out.match(/^# On branch (.*)\n/)
  87     if $1 # git 1.5.x
  88       branch = $1.dup || "unknown"
  89       changed = git_out.match(/^# Change(.*)\n/)
  90       rev = "revision "
  91       git_out = `git log -1 --pretty=format:"%h%n%b"`.split("\n")
  92       rev << git_out.first
  93       if git_out.last.match(/^git-svn-id: \S+@(\d+)/)
  94         rev << "(svn #{$1})"
  95       end
  96       rev << ", local changes" if changed
  97     else # older gits
  98       git_out = `git branch`
  99       git_out.match(/^\* (.*)\n/)
 100       branch = $1.dup rescue "unknown"
 101       rev = "revision " + `git rev-parse HEAD`[0,6]
 102     end
 103
 104     $version << " (#{branch} branch, #{rev})"
 105   else
 106     up = File.dirname(__FILE__) + "/.."
 107     rev = " (unknown revision)"
 108     begin
 109       svn_out = `svn info #{up}`
 110       if svn_out =~ /Last Changed Rev: (\d+)/
 111         rev = " (revision #{$1}"
 112       end
 113       svn_st = `svn st #{up}`
 114       if svn_st =~ /^[MDA] /
 115         rev << ", local changes"
 116       end
 117       rev << ")"
 118     rescue => e
 119       puts e.inspect
 120     end
 121     $version += rev
 122   end
 123 end
 124
 125 orig_opts = ARGV.dup
 126
 127 opts = GetoptLong.new(
 128   ["--background", "-b", GetoptLong::NO_ARGUMENT],
 129   ["--debug", "-d", GetoptLong::NO_ARGUMENT],
 130   ["--help",  "-h", GetoptLong::NO_ARGUMENT],
 131   ["--loglevel",  "-l", GetoptLong::REQUIRED_ARGUMENT],
 132   ["--trace",  "-t", GetoptLong::REQUIRED_ARGUMENT],
 133   ["--pidfile", "-p", GetoptLong::REQUIRED_ARGUMENT],
 134   ["--version", "-v", GetoptLong::NO_ARGUMENT]
 135 )
 136
 137 $debug = $DEBUG
 138 $daemonize = false
 139
 140 opts.each {|opt, arg|
 141   $debug = true if(opt == "--debug")
 142   $daemonize = true if(opt == "--background")
 143   $opts[opt.sub(/^-+/, "")] = arg
 144 }
 145
 146 $cl_loglevel = $opts["loglevel"].to_i if $opts["loglevel"]
 147
 148 if ($opts["trace"])
 149   set_trace_func proc { |event, file, line, id, binding, classname|
 150     if classname.to_s == $opts["trace"]
 151       printf "TRACE: %8s %s:%-2d %10s %8s\n", event, File.basename(file), line, id, classname
 152     end
 153   }
 154 end
 155
 156 defaultlib = File.expand_path(File.dirname($0) + '/../lib')
 157
 158 if File.directory? "#{defaultlib}/rbot"
 159   unless $:.include? defaultlib
 160     $:.unshift defaultlib
 161   end
 162 end
 163
 164 begin
 165   require 'rbot/ircbot'
 166 rescue LoadError => e
 167   puts "Error: couldn't find the rbot/ircbot module (or one of its dependencies)\n"
 168   puts e
 169   exit 2
 170 end
 171
 172 if ($opts["version"])
 173   puts "rbot #{$version}"
 174   exit 0
 175 end
 176
 177 if ($opts["help"])
 178   puts "usage: rbot [options] [config directory]"
 179   puts "  -h, --help         this message"
 180   puts "  -v, --version      version information"
 181   puts "  -d, --debug        enable debug messages"
 182   puts "  -l, --loglevel     sets the log level verbosity"
 183   puts "  -b, --background   background (daemonize) the bot"
 184   puts "  -p, --pidfile      write the bot pid to file"
 185   puts "config directory defaults to ~/.rbot"
 186   exit 0
 187 end
 188
 189 if(bot = Irc::Bot.new(ARGV.shift, :argv => orig_opts))
 190   # just run the bot
 191   bot.mainloop
 192 end
 193