lib/rbot/ircbot.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: rbot core
   5
   6 require 'thread'
   7
   8 require 'etc'
   9 require 'fileutils'
  10 require 'logger'
  11
  12 $debug = false unless $debug
  13 $daemonize = false unless $daemonize
  14
  15 $dateformat = "%Y/%m/%d %H:%M:%S"
  16 $logger = Logger.new($stderr)
  17 $logger.datetime_format = $dateformat
  18 $logger.level = $cl_loglevel if defined? $cl_loglevel
  19 $logger.level = 0 if $debug
  20
  21 require 'pp'
  22
  23 unless Kernel.instance_methods.include?("pretty_inspect")
  24   def pretty_inspect
  25     PP.pp(self, '')
  26   end
  27   public :pretty_inspect
  28 end
  29
  30 class Exception
  31   def pretty_print(q)
  32     q.group(1, "#<%s: %s" % [self.class, self.message], ">") {
  33       if self.backtrace and not self.backtrace.empty?
  34         q.text "\n"
  35         q.seplist(self.backtrace, lambda { q.text "\n" } ) { |l| q.text l }
  36       end
  37     }
  38   end
  39 end
  40
  41 def rawlog(level, message=nil, who_pos=1)
  42   call_stack = caller
  43   if call_stack.length > who_pos
  44     who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
  45   else
  46     who = "(unknown)"
  47   end
  48   # Output each line. To distinguish between separate messages and multi-line
  49   # messages originating at the same time, we blank #{who} after the first message
  50   # is output.
  51   # Also, we output strings as-is but for other objects we use pretty_inspect
  52   case message
  53   when String
  54     str = message
  55   else
  56     str = message.pretty_inspect
  57   end
  58   str.each_line { |l|
  59     $logger.add(level, l.chomp, who)
  60     who.gsub!(/./," ")
  61   }
  62 end
  63
  64 def log_session_start
  65   $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
  66 end
  67
  68 def log_session_end
  69   $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
  70 end
  71
  72 def debug(message=nil, who_pos=1)
  73   rawlog(Logger::Severity::DEBUG, message, who_pos)
  74 end
  75
  76 def log(message=nil, who_pos=1)
  77   rawlog(Logger::Severity::INFO, message, who_pos)
  78 end
  79
  80 def warning(message=nil, who_pos=1)
  81   rawlog(Logger::Severity::WARN, message, who_pos)
  82 end
  83
  84 def error(message=nil, who_pos=1)
  85   rawlog(Logger::Severity::ERROR, message, who_pos)
  86 end
  87
  88 def fatal(message=nil, who_pos=1)
  89   rawlog(Logger::Severity::FATAL, message, who_pos)
  90 end
  91
  92 debug "debug test"
  93 log "log test"
  94 warning "warning test"
  95 error "error test"
  96 fatal "fatal test"
  97
  98 # The following global is used for the improved signal handling.
  99 $interrupted = 0
 100
 101 # these first
 102 require 'rbot/rbotconfig'
 103 require 'rbot/load-gettext'
 104 require 'rbot/config'
 105 require 'rbot/config-compat'
 106
 107 require 'rbot/irc'
 108 require 'rbot/rfc2812'
 109 require 'rbot/ircsocket'
 110 require 'rbot/botuser'
 111 require 'rbot/timer'
 112 require 'rbot/plugins'
 113 require 'rbot/message'
 114 require 'rbot/language'
 115 require 'rbot/dbhash'
 116 require 'rbot/registry'
 117
 118 module Irc
 119
 120 # Main bot class, which manages the various components, receives messages,
 121 # handles them or passes them to plugins, and contains core functionality.
 122 class Bot
 123   COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
 124   SOURCE_URL = "http://ruby-rbot.org"
 125   # the bot's Auth data
 126   attr_reader :auth
 127
 128   # the bot's Config data
 129   attr_reader :config
 130
 131   # the botclass for this bot (determines configdir among other things)
 132   attr_reader :botclass
 133
 134   # used to perform actions periodically (saves configuration once per minute
 135   # by default)
 136   attr_reader :timer
 137
 138   # synchronize with this mutex while touching permanent data files:
 139   # saving, flushing, cleaning up ...
 140   attr_reader :save_mutex
 141
 142   # bot's Language data
 143   attr_reader :lang
 144
 145   # bot's irc socket
 146   # TODO multiserver
 147   attr_reader :socket
 148
 149   # bot's object registry, plugins get an interface to this for persistant
 150   # storage (hash interface tied to a bdb file, plugins use Accessors to store
 151   # and restore objects in their own namespaces.)
 152   attr_reader :registry
 153
 154   # bot's plugins. This is an instance of class Plugins
 155   attr_reader :plugins
 156
 157   # bot's httputil help object, for fetching resources via http. Sets up
 158   # proxies etc as defined by the bot configuration/environment
 159   attr_accessor :httputil
 160
 161   # server we are connected to
 162   # TODO multiserver
 163   def server
 164     @client.server
 165   end
 166
 167   # bot User in the client/server connection
 168   # TODO multiserver
 169   def myself
 170     @client.user
 171   end
 172
 173   # bot User in the client/server connection
 174   def nick
 175     myself.nick
 176   end
 177
 178   # bot inspection
 179   # TODO multiserver
 180   def inspect
 181     ret = self.to_s[0..-2]
 182     ret << ' version=' << $version.inspect
 183     ret << ' botclass=' << botclass.inspect
 184     ret << ' lang="' << lang.language
 185     if defined?(GetText)
 186       ret << '/' << locale
 187     end
 188     ret << '"'
 189     ret << ' nick=' << nick.inspect
 190     ret << ' server='
 191     if server
 192       ret << (server.to_s + (socket ?
 193         ' [' << socket.server_uri.to_s << ']' : '')).inspect
 194       unless server.channels.empty?
 195         ret << " channels="
 196         ret << server.channels.map { |c|
 197           "%s%s" % [c.modes_of(nick).map { |m|
 198             server.prefix_for_mode(m)
 199           }, c.name]
 200         }.inspect
 201       end
 202     else
 203       ret << '(none)'
 204     end
 205     ret << ' plugins=' << plugins.inspect
 206     ret << ">"
 207   end
 208
 209
 210   # create a new Bot with botclass +botclass+
 211   def initialize(botclass, params = {})
 212     # Config for the core bot
 213     # TODO should we split socket stuff into ircsocket, etc?
 214     Config.register Config::ArrayValue.new('server.list',
 215       :default => ['irc://localhost'], :wizard => true,
 216       :requires_restart => true,
 217       :desc => "List of irc servers rbot should try to connect to. Use comma to separate values. Servers are in format 'server.doma.in:port'. If port is not specified, default value (6667) is used.")
 218     Config.register Config::BooleanValue.new('server.ssl',
 219       :default => false, :requires_restart => true, :wizard => true,
 220       :desc => "Use SSL to connect to this server?")
 221     Config.register Config::StringValue.new('server.password',
 222       :default => false, :requires_restart => true,
 223       :desc => "Password for connecting to this server (if required)",
 224       :wizard => true)
 225     Config.register Config::StringValue.new('server.bindhost',
 226       :default => false, :requires_restart => true,
 227       :desc => "Specific local host or IP for the bot to bind to (if required)",
 228       :wizard => true)
 229     Config.register Config::IntegerValue.new('server.reconnect_wait',
 230       :default => 5, :validate => Proc.new{|v| v >= 0},
 231       :desc => "Seconds to wait before attempting to reconnect, on disconnect")
 232     Config.register Config::FloatValue.new('server.sendq_delay',
 233       :default => 2.0, :validate => Proc.new{|v| v >= 0},
 234       :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
 235       :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
 236     Config.register Config::IntegerValue.new('server.sendq_burst',
 237       :default => 4, :validate => Proc.new{|v| v >= 0},
 238       :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines",
 239       :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
 240     Config.register Config::IntegerValue.new('server.ping_timeout',
 241       :default => 30, :validate => Proc.new{|v| v >= 0},
 242       :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
 243
 244     Config.register Config::StringValue.new('irc.nick', :default => "rbot",
 245       :desc => "IRC nickname the bot should attempt to use", :wizard => true,
 246       :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
 247     Config.register Config::StringValue.new('irc.name',
 248       :default => "Ruby bot", :requires_restart => true,
 249       :desc => "IRC realname the bot should use")
 250     Config.register Config::BooleanValue.new('irc.name_copyright',
 251       :default => true, :requires_restart => true,
 252       :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
 253     Config.register Config::StringValue.new('irc.user', :default => "rbot",
 254       :requires_restart => true,
 255       :desc => "local user the bot should appear to be", :wizard => true)
 256     Config.register Config::ArrayValue.new('irc.join_channels',
 257       :default => [], :wizard => true,
 258       :desc => "What channels the bot should always join at startup. List multiple channels using commas to separate. If a channel requires a password, use a space after the channel name. e.g: '#chan1, #chan2, #secretchan secritpass, #chan3'")
 259     Config.register Config::ArrayValue.new('irc.ignore_users',
 260       :default => [],
 261       :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
 262
 263     Config.register Config::IntegerValue.new('core.save_every',
 264       :default => 60, :validate => Proc.new{|v| v >= 0},
 265       :on_change => Proc.new { |bot, v|
 266         if @save_timer
 267           if v > 0
 268             @timer.reschedule(@save_timer, v)
 269             @timer.unblock(@save_timer)
 270           else
 271             @timer.block(@save_timer)
 272           end
 273         else
 274           if v > 0
 275             @save_timer = @timer.add(v) { bot.save }
 276           end
 277           # Nothing to do when v == 0
 278         end
 279       },
 280       :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
 281
 282     Config.register Config::BooleanValue.new('core.run_as_daemon',
 283       :default => false, :requires_restart => true,
 284       :desc => "Should the bot run as a daemon?")
 285
 286     Config.register Config::StringValue.new('log.file',
 287       :default => false, :requires_restart => true,
 288       :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
 289     Config.register Config::IntegerValue.new('log.level',
 290       :default => 1, :requires_restart => false,
 291       :validate => Proc.new { |v| (0..5).include?(v) },
 292       :on_change => Proc.new { |bot, v|
 293         $logger.level = v
 294       },
 295       :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
 296     Config.register Config::IntegerValue.new('log.keep',
 297       :default => 1, :requires_restart => true,
 298       :validate => Proc.new { |v| v >= 0 },
 299       :desc => "How many old console messages logfiles to keep")
 300     Config.register Config::IntegerValue.new('log.max_size',
 301       :default => 10, :requires_restart => true,
 302       :validate => Proc.new { |v| v > 0 },
 303       :desc => "Maximum console messages logfile size (in megabytes)")
 304
 305     Config.register Config::ArrayValue.new('plugins.path',
 306       :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
 307       :requires_restart => false,
 308       :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
 309       :desc => "Where the bot should look for plugins. List multiple directories using commas to separate. Use '(default)' for default prepackaged plugins collection, '(default)/contrib' for prepackaged unsupported plugins collection")
 310
 311     Config.register Config::EnumValue.new('send.newlines',
 312       :values => ['split', 'join'], :default => 'split',
 313       :on_change => Proc.new { |bot, v|
 314         bot.set_default_send_options :newlines => v.to_sym
 315       },
 316       :desc => "When set to split, messages with embedded newlines will be sent as separate lines. When set to join, newlines will be replaced by the value of join_with")
 317     Config.register Config::StringValue.new('send.join_with',
 318       :default => ' ',
 319       :on_change => Proc.new { |bot, v|
 320         bot.set_default_send_options :join_with => v.dup
 321       },
 322       :desc => "String used to replace newlines when send.newlines is set to join")
 323     Config.register Config::IntegerValue.new('send.max_lines',
 324       :default => 5,
 325       :validate => Proc.new { |v| v >= 0 },
 326       :on_change => Proc.new { |bot, v|
 327         bot.set_default_send_options :max_lines => v
 328       },
 329       :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
 330     Config.register Config::EnumValue.new('send.overlong',
 331       :values => ['split', 'truncate'], :default => 'split',
 332       :on_change => Proc.new { |bot, v|
 333         bot.set_default_send_options :overlong => v.to_sym
 334       },
 335       :desc => "When set to split, messages which are too long to fit in a single IRC line are split into multiple lines. When set to truncate, long messages are truncated to fit the IRC line length")
 336     Config.register Config::StringValue.new('send.split_at',
 337       :default => '\s+',
 338       :on_change => Proc.new { |bot, v|
 339         bot.set_default_send_options :split_at => Regexp.new(v)
 340       },
 341       :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
 342     Config.register Config::BooleanValue.new('send.purge_split',
 343       :default => true,
 344       :on_change => Proc.new { |bot, v|
 345         bot.set_default_send_options :purge_split => v
 346       },
 347       :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
 348     Config.register Config::StringValue.new('send.truncate_text',
 349       :default => "#{Reverse}...#{Reverse}",
 350       :on_change => Proc.new { |bot, v|
 351         bot.set_default_send_options :truncate_text => v.dup
 352       },
 353       :desc => "When truncating overlong messages (see send.overlong) or when sending too many lines per message (see send.max_lines) replace the end of the last line with this text")
 354
 355     @argv = params[:argv]
 356     @run_dir = params[:run_dir] || Dir.pwd
 357
 358     unless FileTest.directory? Config::coredir
 359       error "core directory '#{Config::coredir}' not found, did you setup.rb?"
 360       exit 2
 361     end
 362
 363     unless FileTest.directory? Config::datadir
 364       error "data directory '#{Config::datadir}' not found, did you setup.rb?"
 365       exit 2
 366     end
 367
 368     unless botclass and not botclass.empty?
 369       # We want to find a sensible default.
 370       # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
 371       # * On Windows (at least the NT versions) we want to put our stuff in the
 372       #   Application Data folder.
 373       # We don't use any particular O/S detection magic, exploiting the fact that
 374       # Etc.getpwuid is nil on Windows
 375       if Etc.getpwuid(Process::Sys.geteuid)
 376         botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
 377       else
 378         if ENV.has_key?('APPDATA')
 379           botclass = ENV['APPDATA'].dup
 380           botclass.gsub!("\\","/")
 381         end
 382       end
 383       botclass += "/.rbot"
 384     end
 385     botclass = File.expand_path(botclass)
 386     @botclass = botclass.gsub(/\/$/, "")
 387
 388     unless FileTest.directory? botclass
 389       log "no #{botclass} directory found, creating from templates.."
 390       if FileTest.exist? botclass
 391         error "file #{botclass} exists but isn't a directory"
 392         exit 2
 393       end
 394       FileUtils.cp_r Config::datadir+'/templates', botclass
 395     end
 396
 397     Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
 398     Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
 399     Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
 400
 401     # Time at which the last PING was sent
 402     @last_ping = nil
 403     # Time at which the last line was RECV'd from the server
 404     @last_rec = nil
 405
 406     @startup_time = Time.new
 407
 408     begin
 409       @config = Config.manager
 410       @config.bot_associate(self)
 411     rescue Exception => e
 412       fatal e
 413       log_session_end
 414       exit 2
 415     end
 416
 417     if @config['core.run_as_daemon']
 418       $daemonize = true
 419     end
 420
 421     @logfile = @config['log.file']
 422     if @logfile.class!=String || @logfile.empty?
 423       @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
 424     end
 425
 426     # See http://blog.humlab.umu.se/samuel/archives/000107.html
 427     # for the backgrounding code
 428     if $daemonize
 429       begin
 430         exit if fork
 431         Process.setsid
 432         exit if fork
 433       rescue NotImplementedError
 434         warning "Could not background, fork not supported"
 435       rescue SystemExit
 436         exit 0
 437       rescue Exception => e
 438         warning "Could not background. #{e.pretty_inspect}"
 439       end
 440       Dir.chdir botclass
 441       # File.umask 0000                # Ensure sensible umask. Adjust as needed.
 442       log "Redirecting standard input/output/error"
 443       begin
 444         STDIN.reopen "/dev/null"
 445       rescue Errno::ENOENT
 446         # On Windows, there's not such thing as /dev/null
 447         STDIN.reopen "NUL"
 448       end
 449       def STDOUT.write(str=nil)
 450         log str, 2
 451         return str.to_s.size
 452       end
 453       def STDERR.write(str=nil)
 454         if str.to_s.match(/:\d+: warning:/)
 455           warning str, 2
 456         else
 457           error str, 2
 458         end
 459         return str.to_s.size
 460       end
 461     end
 462
 463     # Set the new logfile and loglevel. This must be done after the daemonizing
 464     $logger = Logger.new(@logfile, @config['log.keep'], @config['log.max_size']*1024*1024)
 465     $logger.datetime_format= $dateformat
 466     $logger.level = @config['log.level']
 467     $logger.level = $cl_loglevel if defined? $cl_loglevel
 468     $logger.level = 0 if $debug
 469
 470     log_session_start
 471
 472     File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
 473       pf << "#{$$}\n"
 474     end
 475
 476     @registry = Registry.new self
 477
 478     @timer = Timer.new
 479     @save_mutex = Mutex.new
 480     if @config['core.save_every'] > 0
 481       @save_timer = @timer.add(@config['core.save_every']) { save }
 482     else
 483       @save_timer = nil
 484     end
 485     @quit_mutex = Mutex.new
 486
 487     @logs = Hash.new
 488
 489     @plugins = nil
 490     @lang = Language.new(self, @config['core.language'])
 491
 492     begin
 493       @auth = Auth::manager
 494       @auth.bot_associate(self)
 495       # @auth.load("#{botclass}/botusers.yaml")
 496     rescue Exception => e
 497       fatal e
 498       log_session_end
 499       exit 2
 500     end
 501     @auth.everyone.set_default_permission("*", true)
 502     @auth.botowner.password= @config['auth.password']
 503
 504     Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
 505     @plugins = Plugins::manager
 506     @plugins.bot_associate(self)
 507     setup_plugins_path()
 508
 509     if @config['server.name']
 510         debug "upgrading configuration (server.name => server.list)"
 511         srv_uri = 'irc://' + @config['server.name']
 512         srv_uri += ":#{@config['server.port']}" if @config['server.port']
 513         @config.items['server.list'.to_sym].set_string(srv_uri)
 514         @config.delete('server.name'.to_sym)
 515         @config.delete('server.port'.to_sym)
 516         debug "server.list is now #{@config['server.list'].inspect}"
 517     end
 518
 519     @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
 520     @client = Client.new
 521
 522     @plugins.scan
 523
 524     # Channels where we are quiet
 525     # Array of channels names where the bot should be quiet
 526     # '*' means all channels
 527     #
 528     @quiet = []
 529
 530     @client[:welcome] = proc {|data|
 531       m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])
 532
 533       irclog "joined server #{@client.server} as #{myself}", "server"
 534
 535       @plugins.delegate("welcome", m)
 536       @plugins.delegate("connect")
 537
 538       @config['irc.join_channels'].each { |c|
 539         debug "autojoining channel #{c}"
 540         if(c =~ /^(\S+)\s+(\S+)$/i)
 541           join $1, $2
 542         else
 543           join c if(c)
 544         end
 545       }
 546     }
 547
 548     # TODO the next two @client should go into rfc2812.rb, probably
 549     # Since capabs are two-steps processes, server.supports[:capab]
 550     # should be a three-state: nil, [], [....]
 551     asked_for = { :"identify-msg" => false }
 552     @client[:isupport] = proc { |data|
 553       if server.supports[:capab] and !asked_for[:"identify-msg"]
 554         sendq "CAPAB IDENTIFY-MSG"
 555         asked_for[:"identify-msg"] = true
 556       end
 557     }
 558     @client[:datastr] = proc { |data|
 559       if data[:text] == "IDENTIFY-MSG"
 560         server.capabilities[:"identify-msg"] = true
 561       else
 562         debug "Not handling RPL_DATASTR #{data[:servermessage]}"
 563       end
 564     }
 565
 566     @client[:privmsg] = proc { |data|
 567       m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
 568       # debug "Message source is #{data[:source].inspect}"
 569       # debug "Message target is #{data[:target].inspect}"
 570       # debug "Bot is #{myself.inspect}"
 571
 572       @config['irc.ignore_users'].each { |mask|
 573         if m.source.matches?(server.new_netmask(mask))
 574           m.ignored = true
 575         end
 576       }
 577
 578       irclogprivmsg(m)
 579
 580       @plugins.irc_delegate('privmsg', m) unless m.ignored?
 581     }
 582     @client[:notice] = proc { |data|
 583       message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
 584       # pass it off to plugins that want to hear everything
 585       @plugins.delegate "listen", message
 586       @plugins.delegate "notice", message
 587     }
 588     @client[:motd] = proc { |data|
 589       m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd])
 590       data[:motd].each_line { |line|
 591         irclog "MOTD: #{line}", "server"
 592       }
 593       @plugins.delegate "motd", m
 594     }
 595     @client[:nicktaken] = proc { |data|
 596       new = "#{data[:nick]}_"
 597       nickchg new
 598       # If we're setting our nick at connection because our choice was taken,
 599       # we have to fix our nick manually, because there will be no NICK message
 600       # to inform us that our nick has been changed.
 601       if data[:target] == '*'
 602         debug "setting my connection nick to #{new}"
 603         nick = new
 604       end
 605       @plugins.delegate "nicktaken", data[:nick]
 606     }
 607     @client[:badnick] = proc {|data|
 608       warning "bad nick (#{data[:nick]})"
 609     }
 610     @client[:ping] = proc {|data|
 611       sendq "PONG #{data[:pingid]}"
 612     }
 613     @client[:pong] = proc {|data|
 614       @last_ping = nil
 615     }
 616     @client[:nick] = proc {|data|
 617       # debug "Message source is #{data[:source].inspect}"
 618       # debug "Bot is #{myself.inspect}"
 619       source = data[:source]
 620       old = data[:oldnick]
 621       new = data[:newnick]
 622       m = NickMessage.new(self, server, source, old, new)
 623       if source == myself
 624         debug "my nick is now #{new}"
 625       end
 626       data[:is_on].each { |ch|
 627         irclog "@ #{old} is now known as #{new}", ch
 628       }
 629       @plugins.irc_delegate("nick", m)
 630     }
 631     @client[:quit] = proc {|data|
 632       source = data[:source]
 633       message = data[:message]
 634       m = QuitMessage.new(self, server, source, source, message)
 635       data[:was_on].each { |ch|
 636         irclog "@ Quit: #{source}: #{message}", ch
 637       }
 638       @plugins.irc_delegate("quit", m)
 639     }
 640     @client[:mode] = proc {|data|
 641       m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
 642       m.modes = data[:modes]
 643       irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:target]
 644       @plugins.delegate "modechange", m
 645     }
 646     @client[:join] = proc {|data|
 647       m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
 648       irclogjoin(m)
 649
 650       @plugins.irc_delegate("join", m)
 651       sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
 652     }
 653     @client[:part] = proc {|data|
 654       m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
 655       irclogpart(m)
 656
 657       @plugins.irc_delegate("part", m)
 658     }
 659     @client[:kick] = proc {|data|
 660       m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
 661       irclogkick(m)
 662
 663       @plugins.irc_delegate("kick", m)
 664     }
 665     @client[:invite] = proc {|data|
 666       m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
 667
 668       @plugins.irc_delegate("invite", m)
 669     }
 670     @client[:changetopic] = proc {|data|
 671       m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
 672       irclogtopic(m)
 673
 674       @plugins.irc_delegate("topic", m)
 675     }
 676     @client[:topic] = proc { |data|
 677       irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
 678     }
 679     @client[:topicinfo] = proc { |data|
 680       channel = data[:channel]
 681       topic = channel.topic
 682       irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
 683       m = TopicMessage.new(self, server, data[:source], channel, topic)
 684
 685       @plugins.irc_delegate("topic", m)
 686     }
 687     @client[:names] = proc { |data|
 688       @plugins.delegate "names", data[:channel], data[:users]
 689     }
 690     @client[:unknown] = proc { |data|
 691       #debug "UNKNOWN: #{data[:serverstring]}"
 692       irclog data[:serverstring], ".unknown"
 693     }
 694
 695     set_default_send_options :newlines => @config['send.newlines'].to_sym,
 696       :join_with => @config['send.join_with'].dup,
 697       :max_lines => @config['send.max_lines'],
 698       :overlong => @config['send.overlong'].to_sym,
 699       :split_at => Regexp.new(@config['send.split_at']),
 700       :purge_split => @config['send.purge_split'],
 701       :truncate_text => @config['send.truncate_text'].dup
 702   end
 703
 704   def setup_plugins_path
 705     @plugins.clear_botmodule_dirs
 706     @plugins.add_botmodule_dir(Config::coredir + "/utils")
 707     @plugins.add_botmodule_dir(Config::coredir)
 708     @plugins.add_botmodule_dir("#{botclass}/plugins")
 709
 710     @config['plugins.path'].each do |_|
 711         path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
 712         @plugins.add_botmodule_dir(path)
 713     end
 714   end
 715
 716   def set_default_send_options(opts={})
 717     # Default send options for NOTICE and PRIVMSG
 718     unless defined? @default_send_options
 719       @default_send_options = {
 720         :queue_channel => nil,      # use default queue channel
 721         :queue_ring => nil,         # use default queue ring
 722         :newlines => :split,        # or :join
 723         :join_with => ' ',          # by default, use a single space
 724         :max_lines => 0,          # maximum number of lines to send with a single command
 725         :overlong => :split,        # or :truncate
 726         # TODO an array of splitpoints would be preferrable for this option:
 727         :split_at => /\s+/,         # by default, split overlong lines at whitespace
 728         :purge_split => true,       # should the split string be removed?
 729         :truncate_text => "#{Reverse}...#{Reverse}"  # text to be appened when truncating
 730       }
 731     end
 732     @default_send_options.update opts unless opts.empty?
 733     end
 734
 735   # checks if we should be quiet on a channel
 736   def quiet_on?(channel)
 737     return @quiet.include?('*') || @quiet.include?(channel.downcase)
 738   end
 739
 740   def set_quiet(channel)
 741     if channel
 742       ch = channel.downcase.dup
 743       @quiet << ch unless @quiet.include?(ch)
 744     else
 745       @quiet.clear
 746       @quiet << '*'
 747     end
 748   end
 749
 750   def reset_quiet(channel)
 751     if channel
 752       @quiet.delete channel.downcase
 753     else
 754       @quiet.clear
 755     end
 756   end
 757
 758   # things to do when we receive a signal
 759   def got_sig(sig)
 760     debug "received #{sig}, queueing quit"
 761     $interrupted += 1
 762     quit unless @quit_mutex.locked?
 763     debug "interrupted #{$interrupted} times"
 764     if $interrupted >= 3
 765       debug "drastic!"
 766       log_session_end
 767       exit 2
 768     end
 769   end
 770
 771   # connect the bot to IRC
 772   def connect
 773     begin
 774       trap("SIGINT") { got_sig("SIGINT") }
 775       trap("SIGTERM") { got_sig("SIGTERM") }
 776       trap("SIGHUP") { got_sig("SIGHUP") }
 777     rescue ArgumentError => e
 778       debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
 779     rescue Exception => e
 780       debug "failed to trap signals: #{e.pretty_inspect}"
 781     end
 782     begin
 783       quit if $interrupted > 0
 784       @socket.connect
 785     rescue => e
 786       raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
 787     end
 788     quit if $interrupted > 0
 789
 790     realname = @config['irc.name'].clone || 'Ruby bot'
 791     realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
 792
 793     @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
 794     @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
 795     quit if $interrupted > 0
 796     myself.nick = @config['irc.nick']
 797     myself.user = @config['irc.user']
 798   end
 799
 800   # begin event handling loop
 801   def mainloop
 802     while true
 803       begin
 804         quit if $interrupted > 0
 805         connect
 806
 807         quit_msg = nil
 808         while @socket.connected?
 809           quit if $interrupted > 0
 810
 811           # Wait for messages and process them as they arrive. If nothing is
 812           # received, we call the ping_server() method that will PING the
 813           # server if appropriate, or raise a TimeoutError if no PONG has been
 814           # received in the user-chosen timeout since the last PING sent.
 815           if @socket.select(1)
 816             break unless reply = @socket.gets
 817             @last_rec = Time.now
 818             @client.process reply
 819           else
 820             ping_server
 821           end
 822         end
 823
 824       # I despair of this. Some of my users get "connection reset by peer"
 825       # exceptions that ARENT SocketError's. How am I supposed to handle
 826       # that?
 827       rescue SystemExit
 828         log_session_end
 829         exit 0
 830       rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
 831         error "network exception: #{e.pretty_inspect}"
 832         quit_msg = e.to_s
 833       rescue BDB::Fatal => e
 834         fatal "fatal bdb error: #{e.pretty_inspect}"
 835         DBTree.stats
 836         # Why restart? DB problems are serious stuff ...
 837         # restart("Oops, we seem to have registry problems ...")
 838         log_session_end
 839         exit 2
 840       rescue Exception => e
 841         error "non-net exception: #{e.pretty_inspect}"
 842         quit_msg = e.to_s
 843       rescue => e
 844         fatal "unexpected exception: #{e.pretty_inspect}"
 845         log_session_end
 846         exit 2
 847       end
 848
 849       disconnect(quit_msg)
 850
 851       log "\n\nDisconnected\n\n"
 852
 853       quit if $interrupted > 0
 854
 855       log "\n\nWaiting to reconnect\n\n"
 856       sleep @config['server.reconnect_wait']
 857     end
 858   end
 859
 860   # type:: message type
 861   # where:: message target
 862   # message:: message text
 863   # send message +message+ of type +type+ to target +where+
 864   # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
 865   # relevant say() or notice() methods. This one should be used for IRCd
 866   # extensions you want to use in modules.
 867   def sendmsg(type, where, original_message, options={})
 868     opts = @default_send_options.merge(options)
 869
 870     # For starters, set up appropriate queue channels and rings
 871     mchan = opts[:queue_channel]
 872     mring = opts[:queue_ring]
 873     if mchan
 874       chan = mchan
 875     else
 876       chan = where
 877     end
 878     if mring
 879       ring = mring
 880     else
 881       case where
 882       when User
 883         ring = 1
 884       else
 885         ring = 2
 886       end
 887     end
 888
 889     multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
 890     messages = Array.new
 891     case opts[:newlines]
 892     when :join
 893       messages << [multi_line.gsub("\n", opts[:join_with])]
 894     when :split
 895       multi_line.each_line { |line|
 896         line.chomp!
 897         next unless(line.size > 0)
 898         messages << line
 899       }
 900     else
 901       raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
 902     end
 903
 904     # The IRC protocol requires that each raw message must be not longer
 905     # than 512 characters. From this length with have to subtract the EOL
 906     # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
 907     # that will be prepended by the server to all of our messages.
 908
 909     # The maximum raw message length we can send is therefore 512 - 2 - 2
 910     # minus the length of our hostmask.
 911
 912     max_len = 508 - myself.fullform.size
 913
 914     # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
 915     # will have a + or - prepended
 916     if server.capabilities[:"identify-msg"]
 917       max_len -= 1
 918     end
 919
 920     # When splitting the message, we'll be prefixing the following string:
 921     # (e.g. "PRIVMSG #rbot :")
 922     fixed = "#{type} #{where} :"
 923
 924     # And this is what's left
 925     left = max_len - fixed.size
 926
 927     truncate = opts[:truncate_text]
 928     truncate = @default_send_options[:truncate_text] if truncate.size > left
 929     truncate = "" if truncate.size > left
 930
 931     all_lines = messages.map { |line|
 932       if line.size < left
 933         line
 934       else
 935         case opts[:overlong]
 936         when :split
 937           msg = line.dup
 938           sub_lines = Array.new
 939           begin
 940             sub_lines << msg.slice!(0, left)
 941             break if msg.empty?
 942             lastspace = sub_lines.last.rindex(opts[:split_at])
 943             if lastspace
 944               msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
 945               msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
 946             end
 947           end until msg.empty?
 948           sub_lines
 949         when :truncate
 950           line.slice(0, left - truncate.size) << truncate
 951         else
 952           raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
 953         end
 954       end
 955     }.flatten
 956
 957     if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
 958       lines = all_lines[0...opts[:max_lines]]
 959       new_last = lines.last.slice(0, left - truncate.size) << truncate
 960       lines.last.replace(new_last)
 961     else
 962       lines = all_lines
 963     end
 964
 965     lines.each { |line|
 966       sendq "#{fixed}#{line}", chan, ring
 967       log_sent(type, where, line)
 968     }
 969   end
 970
 971   # queue an arbitraty message for the server
 972   def sendq(message="", chan=nil, ring=0)
 973     # temporary
 974     @socket.queue(message, chan, ring)
 975   end
 976
 977   # send a notice message to channel/nick +where+
 978   def notice(where, message, options={})
 979     return if where.kind_of?(Channel) and quiet_on?(where)
 980     sendmsg "NOTICE", where, message, options
 981   end
 982
 983   # say something (PRIVMSG) to channel/nick +where+
 984   def say(where, message, options={})
 985     return if where.kind_of?(Channel) and quiet_on?(where)
 986     sendmsg "PRIVMSG", where, message, options
 987   end
 988
 989   def ctcp_notice(where, command, message, options={})
 990     return if where.kind_of?(Channel) and quiet_on?(where)
 991     sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
 992   end
 993
 994   def ctcp_say(where, command, message, options={})
 995     return if where.kind_of?(Channel) and quiet_on?(where)
 996     sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
 997   end
 998
 999   # perform a CTCP action with message +message+ to channel/nick +where+
1000   def action(where, message, options={})
1001     ctcp_say(where, 'ACTION', message, options)
1002   end
1003
1004   # quick way to say "okay" (or equivalent) to +where+
1005   def okay(where)
1006     say where, @lang.get("okay")
1007   end
1008
1009   # log IRC-related message +message+ to a file determined by +where+.
1010   # +where+ can be a channel name, or a nick for private message logging
1011   def irclog(message, where="server")
1012     message = message.chomp
1013     stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
1014     if where.class <= Server
1015       where_str = "server"
1016     else
1017       where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
1018     end
1019     unless(@logs.has_key?(where_str))
1020       @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a")
1021       @logs[where_str].sync = true
1022     end
1023     @logs[where_str].puts "[#{stamp}] #{message}"
1024     #debug "[#{stamp}] <#{where}> #{message}"
1025   end
1026
1027   # set topic of channel +where+ to +topic+
1028   def topic(where, topic)
1029     sendq "TOPIC #{where} :#{topic}", where, 2
1030   end
1031
1032   def disconnect(message=nil)
1033     message = @lang.get("quit") if (!message || message.empty?)
1034     if @socket.connected?
1035       begin
1036         debug "Clearing socket"
1037         @socket.clearq
1038         debug "Sending quit message"
1039         @socket.emergency_puts "QUIT :#{message}"
1040         debug "Flushing socket"
1041         @socket.flush
1042       rescue SocketError => e
1043         error "error while disconnecting socket: #{e.pretty_inspect}"
1044       end
1045       debug "Shutting down socket"
1046       @socket.shutdown
1047     end
1048     debug "Logging quits"
1049     server.channels.each { |ch|
1050       irclog "@ quit (#{message})", ch
1051     }
1052     stop_server_pings
1053     @client.reset
1054   end
1055
1056   # disconnect from the server and cleanup all plugins and modules
1057   def shutdown(message=nil)
1058     @quit_mutex.synchronize do
1059       debug "Shutting down: #{message}"
1060       ## No we don't restore them ... let everything run through
1061       # begin
1062       #   trap("SIGINT", "DEFAULT")
1063       #   trap("SIGTERM", "DEFAULT")
1064       #   trap("SIGHUP", "DEFAULT")
1065       # rescue => e
1066       #   debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1067       # end
1068       debug "\tdisconnecting..."
1069       disconnect(message)
1070       debug "\tstopping timer..."
1071       @timer.stop
1072       debug "\tsaving ..."
1073       save
1074       debug "\tcleaning up ..."
1075       @save_mutex.synchronize do
1076         @plugins.cleanup
1077       end
1078       # debug "\tstopping timers ..."
1079       # @timer.stop
1080       # debug "Closing registries"
1081       # @registry.close
1082       debug "\t\tcleaning up the db environment ..."
1083       DBTree.cleanup_env
1084       log "rbot quit (#{message})"
1085     end
1086   end
1087
1088   # message:: optional IRC quit message
1089   # quit IRC, shutdown the bot
1090   def quit(message=nil)
1091     begin
1092       shutdown(message)
1093     ensure
1094       exit 0
1095     end
1096   end
1097
1098   # totally shutdown and respawn the bot
1099   def restart(message=nil)
1100     message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
1101     shutdown(message)
1102     sleep @config['server.reconnect_wait']
1103     begin
1104       # now we re-exec
1105       # Note, this fails on Windows
1106       debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1107       Dir.chdir(@run_dir)
1108       exec($0, *@argv)
1109     rescue Errno::ENOENT
1110       exec("ruby", *(@argv.unshift $0))
1111     rescue Exception => e
1112       $interrupted += 1
1113       raise e
1114     end
1115   end
1116
1117   # call the save method for all of the botmodules
1118   def save
1119     @save_mutex.synchronize do
1120       @plugins.save
1121       DBTree.cleanup_logs
1122     end
1123   end
1124
1125   # call the rescan method for all of the botmodules
1126   def rescan
1127     debug "\tstopping timer..."
1128     @timer.stop
1129     @save_mutex.synchronize do
1130       @lang.rescan
1131       @plugins.rescan
1132     end
1133     @timer.start
1134   end
1135
1136   # channel:: channel to join
1137   # key::     optional channel key if channel is +s
1138   # join a channel
1139   def join(channel, key=nil)
1140     if(key)
1141       sendq "JOIN #{channel} :#{key}", channel, 2
1142     else
1143       sendq "JOIN #{channel}", channel, 2
1144     end
1145   end
1146
1147   # part a channel
1148   def part(channel, message="")
1149     sendq "PART #{channel} :#{message}", channel, 2
1150   end
1151
1152   # attempt to change bot's nick to +name+
1153   def nickchg(name)
1154     sendq "NICK #{name}"
1155   end
1156
1157   # changing mode
1158   def mode(channel, mode, target)
1159     sendq "MODE #{channel} #{mode} #{target}", channel, 2
1160   end
1161
1162   # kicking a user
1163   def kick(channel, user, msg)
1164     sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1165   end
1166
1167   # m::     message asking for help
1168   # topic:: optional topic help is requested for
1169   # respond to online help requests
1170   def help(topic=nil)
1171     topic = nil if topic == ""
1172     case topic
1173     when nil
1174       helpstr = _("help topics: ")
1175       helpstr += @plugins.helptopics
1176       helpstr += _(" (help <topic> for more info)")
1177     else
1178       unless(helpstr = @plugins.help(topic))
1179         helpstr = _("no help for topic %{topic}") % { :topic => topic }
1180       end
1181     end
1182     return helpstr
1183   end
1184
1185   # returns a string describing the current status of the bot (uptime etc)
1186   def status
1187     secs_up = Time.new - @startup_time
1188     uptime = Utils.secs_to_string secs_up
1189     # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1190     return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
1191              {
1192                :up => uptime, :plug => @plugins.length,
1193                :sent => @socket.lines_sent, :recv => @socket.lines_received
1194              })
1195   end
1196
1197   # We want to respond to a hung server in a timely manner. If nothing was received
1198   # in the user-selected timeout and we haven't PINGed the server yet, we PING
1199   # the server. If the PONG is not received within the user-defined timeout, we
1200   # assume we're in ping timeout and act accordingly.
1201   def ping_server
1202     act_timeout = @config['server.ping_timeout']
1203     return if act_timeout <= 0
1204     now = Time.now
1205     if @last_rec && now > @last_rec + act_timeout
1206       if @last_ping.nil?
1207         # No previous PING pending, send a new one
1208         sendq "PING :rbot"
1209         @last_ping = Time.now
1210       else
1211         diff = now - @last_ping
1212         if diff > act_timeout
1213           debug "no PONG from server in #{diff} seconds, reconnecting"
1214           # the actual reconnect is handled in the main loop:
1215           raise TimeoutError, "no PONG from server in #{diff} seconds"
1216         end
1217       end
1218     end
1219   end
1220
1221   def stop_server_pings
1222     # cancel previous PINGs and reset time of last RECV
1223     @last_ping = nil
1224     @last_rec = nil
1225   end
1226
1227   private
1228
1229   def irclogprivmsg(m)
1230     if(m.action?)
1231       if(m.private?)
1232         irclog "* [#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
1233       else
1234         irclog "* #{m.source} #{m.logmessage}", m.target
1235       end
1236     else
1237       if(m.public?)
1238         irclog "<#{m.source}> #{m.logmessage}", m.target
1239       else
1240         irclog "[#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
1241       end
1242     end
1243   end
1244
1245   # log a message. Internal use only.
1246   def log_sent(type, where, message)
1247     case type
1248       when "NOTICE"
1249         case where
1250         when Channel
1251           irclog "-=#{myself}=- #{message}", where
1252         else
1253           irclog "[-=#{where}=-] #{message}", where
1254         end
1255       when "PRIVMSG"
1256         case where
1257         when Channel
1258           irclog "<#{myself}> #{message}", where
1259         else
1260           irclog "[msg(#{where})] #{message}", where
1261         end
1262     end
1263   end
1264
1265   def irclogjoin(m)
1266     if m.address?
1267       debug "joined channel #{m.channel}"
1268       irclog "@ Joined channel #{m.channel}", m.channel
1269     else
1270       irclog "@ #{m.source} joined channel #{m.channel}", m.channel
1271     end
1272   end
1273
1274   def irclogpart(m)
1275     if(m.address?)
1276       debug "left channel #{m.channel}"
1277       irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
1278     else
1279       irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel
1280     end
1281   end
1282
1283   def irclogkick(m)
1284     if(m.address?)
1285       debug "kicked from channel #{m.channel}"
1286       irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
1287     else
1288       irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
1289     end
1290   end
1291
1292   def irclogtopic(m)
1293     if m.source == myself
1294       irclog "@ I set topic \"#{m.topic}\"", m.channel
1295     else
1296       irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
1297     end
1298   end
1299
1300 end
1301
1302 end