Licensing uniformity: dual-license rbot core under MIT+acknowledgement and GPLv2

[user/henk/code/ruby/rbot.git] / bin / rbot

diff --git a/bin/rbot b/bin/rbot
index ce5c86bd9fb82446c17897aa8ec0bdafbf376129..89c8688de2e179f3f062ec5a2c2fa5b26919faac 100755 (executable)
--- a/bin/rbot
+++ b/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
+
+[-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>.
 
-$KCODE = 'u'
+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,9 +47,58 @@ require 'etc'
 require 'getoptlong'
 require 'fileutils'
 
-$version="0.9.11-svn"
+$version="0.9.11-git"
 $opts = Hash.new
 
+if $version =~ /git/
+  if defined?(SCM_DIR) and File.exists?(File.join(SCM_DIR, '.git'))
+    begin
+      git_out = `git status`
+      git_out.match(/^# On branch (.*)\n/)
+      if $1 # git 1.5.x
+        branch = $1.dup || "unknown"
+        changed = git_out.match(/^# Change(.*)\n/)
+        rev = "revision "
+        git_out = `git log -1 --pretty=format:"%h%n%b%n%ct"`.split("\n")
+        rev << git_out.first
+        $version_timestamp = git_out.last.to_i
+        if git_out[1].match(/^git-svn-id: \S+@(\d+)/)
+          rev << "(svn #{$1})"
+        end
+        rev << ", local changes" if changed
+      else # older gits
+        git_out = `git branch`
+        git_out.match(/^\* (.*)\n/)
+        branch = $1.dup rescue "unknown"
+        rev = "revision " + `git rev-parse HEAD`[0,6]
+      end
+    rescue => e
+      puts e.inspect
+      branch = "unknown branch"
+      rev = "unknown revision"
+    end
+
+    $version << " (#{branch} branch, #{rev})"
+  else
+    up = File.dirname(__FILE__) + "/.."
+    rev = " (unknown revision)"
+    begin
+      svn_out = `svn info #{up}`
+      if svn_out =~ /Last Changed Rev: (\d+)/
+        rev = " (revision #{$1}"
+      end
+      svn_st = `svn st #{up}`
+      if svn_st =~ /^[MDA] /
+        rev << ", local changes"
+      end
+      rev << ")"
+    rescue => e
+      puts e.inspect
+    end
+    $version += rev
+  end
+end
+
 orig_opts = ARGV.dup
 
 opts = GetoptLong.new(
@@ -40,10 +107,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 +120,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 +156,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