jsn-rbot 0.9.14

data/Rakefile

@@ -0,0 +1,193 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+
+task :default => [:buildext]
+
+SPECFILE = 'rbot.gemspec'
+# The Rakefile is also used after installing the gem, to build
+# the .mo files. Since in this case the SPECFILE is not available,
+# we must (and can) skip defining the gem packaging tasks.
+if File.exist? SPECFILE
+  spec = eval(File.read(SPECFILE), nil, SPECFILE)
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+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

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+
+=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>.
+
+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
+
+require 'etc'
+require 'getoptlong'
+require 'fileutils'
+
+$version ||= '0.9.15-git'
+$version_timestamp ||= 0
+$opts = Hash.new
+
+orig_opts = ARGV.dup
+
+opts = GetoptLong.new(
+  ["--background", "-b", GetoptLong::NO_ARGUMENT],
+  ["--debug", "-d", GetoptLong::NO_ARGUMENT],
+  ["--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 = $DEBUG
+$daemonize = false
+
+opts.each {|opt, arg|
+  $debug = true if(opt == "--debug")
+  $daemonize = true if(opt == "--background")
+  $opts[opt.sub(/^-+/, "")] = arg
+}
+
+$cl_loglevel = $opts["loglevel"].to_i if $opts["loglevel"]
+
+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
+
+defaultlib = File.expand_path(File.dirname($0) + '/../lib')
+
+if File.directory? "#{defaultlib}/rbot"
+  unless $:.include? defaultlib
+    $:.unshift defaultlib
+  end
+end
+  
+begin
+  require 'rbot/ircbot'
+rescue LoadError => e
+  puts "Error: couldn't find the rbot/ircbot module (or one of its dependencies)\n"
+  puts e
+  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 "  -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::Bot.new(ARGV.shift, :argv => orig_opts))
+  # just run the bot
+  bot.mainloop
+end
+

data/bin/rbot-remote

@@ -0,0 +1,76 @@
+#! /usr/bin/ruby
+require 'drb'
+require 'optparse'
+
+#++
+#
+# :title: RemoteCtl example script
+#
+# Author:: jsn (dmitry kim) <dmitry dot kim at gmail dot org>
+# Copyright:: (C) 2007 dmitry kim
+# License:: in public domain
+
+user = nil
+pw = nil
+dst = nil
+uri = 'druby://localhost:7268'
+
+opts = OptionParser.new
+opts.on('-u', '--user <user>', "remote user (mandatory)") { |v| user = v }
+opts.on('-p', '--password <pw>', "remote user password (mandatory)") { |v| pw = v }
+opts.on('-d', '--destination <user or #channel>') { |v| dst = v }
+opts.on('-r', '--uri <drb uri>', "rbot url (#{uri})") { |v| uri = v }
+opts.on('-h', '--help', "this message") { |v| pw = nil } # sorry!
+opts.on('-a', '--about', "what it's all about.") { |v|
+    puts <<EOF
+This is just a proof-of-concept example for rbot druby-based api. This program
+reads lines of text from the standard input and sends them to a specified irc
+channel or user via rbot. Make sure you have remotectl.rb plugin loaded before
+use.
+
+The necessary setup is:
+    1) # create a new rbot user ("rmuser", in this example) with a password
+       # ("rmpw", in this example). in an open query to rbot:
+
+       <you> user create rmuser rmpw
+       <rbot> created botuser remote
+
+    2) # add a remotectl permission to your newly created remote user:
+
+       <you> permissions set +remotectl for rmuser
+       <rbot> okies!
+
+    3) # add specific permissions for the commands you want to allow via
+       # remote interface. for example, in this script we want 'say',
+       # 'action' and other basic commands to work:
+
+       <you> permissions set +basics::talk::do for rmuser
+       <rbot> alright
+
+    4) # run the #{$0} and type something. the message should
+       # show up on your channel / arrive as an irc private message.
+       
+       [you@yourhost ~]$ ./bin/rbot-remote -u rmuser -p rmpw -d '#your-channel'
+       hello, world!
+       <Ctrl-D>
+       [you@yourhost ~]$
+EOF
+    exit 0
+}
+opts.parse!
+
+if !pw || !user || !dst
+    puts opts.to_s
+    exit 0
+end
+
+rbot = DRbObject.new_with_uri(uri)
+id = rbot.delegate(nil, "remote login #{user} #{pw}")[:return]
+puts "id is #{id.inspect}"
+loop {
+    s = gets or break
+    s.chomp!
+    rv = rbot.delegate(id, "dispatch say #{dst} #{s}") or break
+    puts "rv is #{rv.inspect}"
+}
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: jsn-rbot
+version: !ruby/object:Gem::Version 
+  version: 0.9.14
+platform: ruby
+authors: 
+- Tom Gilbert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-21 00:00:00 -07:00
+default_executable: rbot
+dependencies: []
+
+description: A modular ruby IRC bot specifically designed for ease of extension via plugins.
+email: tom@linuxbrit.co.uk
+executables: 
+- rbot
+- rbot-remote
+extensions: 
+- Rakefile
+extra_rdoc_files: []
+
+files: []
+
+has_rdoc: true
+homepage: http://ruby-rbot.org
+post_install_message: 
+rdoc_options: 
+- --exclude
+- post-install.rb
+- --title
+- rbot API Documentation
+- --main
+- README
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- Ruby, version 1.8.0 (or newer)
+rubyforge_project: rbot
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A modular ruby IRC bot.
+test_files: []
+