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       irclog "joined server #{@client.server} as #{myself}", "server"
 532
 533       @plugins.delegate("connect")
 534
 535       @config['irc.join_channels'].each { |c|
 536         debug "autojoining channel #{c}"
 537         if(c =~ /^(\S+)\s+(\S+)$/i)
 538           join $1, $2
 539         else
 540           join c if(c)
 541         end
 542       }
 543     }
 544
 545     # TODO the next two @client should go into rfc2812.rb, probably
 546     # Since capabs are two-steps processes, server.supports[:capab]
 547     # should be a three-state: nil, [], [....]
 548     asked_for = { :"identify-msg" => false }
 549     @client[:isupport] = proc { |data|
 550       if server.supports[:capab] and !asked_for[:"identify-msg"]
 551         sendq "CAPAB IDENTIFY-MSG"
 552         asked_for[:"identify-msg"] = true
 553       end
 554     }
 555     @client[:datastr] = proc { |data|
 556       if data[:text] == "IDENTIFY-MSG"
 557         server.capabilities[:"identify-msg"] = true
 558       else
 559         debug "Not handling RPL_DATASTR #{data[:servermessage]}"
 560       end
 561     }
 562
 563     @client[:privmsg] = proc { |data|
 564       m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
 565       # debug "Message source is #{data[:source].inspect}"
 566       # debug "Message target is #{data[:target].inspect}"
 567       # debug "Bot is #{myself.inspect}"
 568
 569       @config['irc.ignore_users'].each { |mask|
 570         if m.source.matches?(server.new_netmask(mask))
 571           m.ignored = true
 572         end
 573       }
 574
 575       irclogprivmsg(m)
 576
 577       @plugins.irc_delegate('privmsg', m) unless m.ignored?
 578     }
 579     @client[:notice] = proc { |data|
 580       message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
 581       # pass it off to plugins that want to hear everything
 582       @plugins.delegate "listen", message
 583     }
 584     @client[:motd] = proc { |data|
 585       data[:motd].each_line { |line|
 586         irclog "MOTD: #{line}", "server"
 587       }
 588     }
 589     @client[:nicktaken] = proc { |data|
 590       new = "#{data[:nick]}_"
 591       nickchg new
 592       # If we're setting our nick at connection because our choice was taken,
 593       # we have to fix our nick manually, because there will be no NICK message
 594       # to inform us that our nick has been changed.
 595       if data[:target] == '*'
 596         debug "setting my connection nick to #{new}"
 597         nick = new
 598       end
 599       @plugins.delegate "nicktaken", data[:nick]
 600     }
 601     @client[:badnick] = proc {|data|
 602       warning "bad nick (#{data[:nick]})"
 603     }
 604     @client[:ping] = proc {|data|
 605       sendq "PONG #{data[:pingid]}"
 606     }
 607     @client[:pong] = proc {|data|
 608       @last_ping = nil
 609     }
 610     @client[:nick] = proc {|data|
 611       # debug "Message source is #{data[:source].inspect}"
 612       # debug "Bot is #{myself.inspect}"
 613       source = data[:source]
 614       old = data[:oldnick]
 615       new = data[:newnick]
 616       m = NickMessage.new(self, server, source, old, new)
 617       if source == myself
 618         debug "my nick is now #{new}"
 619       end
 620       data[:is_on].each { |ch|
 621         irclog "@ #{old} is now known as #{new}", ch
 622       }
 623       @plugins.irc_delegate("nick", m)
 624     }
 625     @client[:quit] = proc {|data|
 626       source = data[:source]
 627       message = data[:message]
 628       m = QuitMessage.new(self, server, source, source, message)
 629       data[:was_on].each { |ch|
 630         irclog "@ Quit: #{source}: #{message}", ch
 631       }
 632       @plugins.irc_delegate("quit", m)
 633     }
 634     @client[:mode] = proc {|data|
 635       irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
 636     }
 637     @client[:join] = proc {|data|
 638       m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
 639       irclogjoin(m)
 640
 641       @plugins.irc_delegate("join", m)
 642       sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
 643     }
 644     @client[:part] = proc {|data|
 645       m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
 646       irclogpart(m)
 647
 648       @plugins.irc_delegate("part", m)
 649     }
 650     @client[:kick] = proc {|data|
 651       m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
 652       irclogkick(m)
 653
 654       @plugins.irc_delegate("kick", m)
 655     }
 656     @client[:invite] = proc {|data|
 657       m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
 658
 659       @plugins.irc_delegate("invite", m)
 660     }
 661     @client[:changetopic] = proc {|data|
 662       m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
 663       irclogtopic(m)
 664
 665       @plugins.irc_delegate("topic", m)
 666     }
 667     @client[:topic] = proc { |data|
 668       irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
 669     }
 670     @client[:topicinfo] = proc { |data|
 671       channel = data[:channel]
 672       topic = channel.topic
 673       irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
 674       m = TopicMessage.new(self, server, data[:source], channel, topic)
 675
 676       @plugins.irc_delegate("topic", m)
 677     }
 678     @client[:names] = proc { |data|
 679       @plugins.delegate "names", data[:channel], data[:users]
 680     }
 681     @client[:unknown] = proc { |data|
 682       #debug "UNKNOWN: #{data[:serverstring]}"
 683       irclog data[:serverstring], ".unknown"
 684     }
 685
 686     set_default_send_options :newlines => @config['send.newlines'].to_sym,
 687       :join_with => @config['send.join_with'].dup,
 688       :max_lines => @config['send.max_lines'],
 689       :overlong => @config['send.overlong'].to_sym,
 690       :split_at => Regexp.new(@config['send.split_at']),
 691       :purge_split => @config['send.purge_split'],
 692       :truncate_text => @config['send.truncate_text'].dup
 693   end
 694
 695   def setup_plugins_path
 696     @plugins.clear_botmodule_dirs
 697     @plugins.add_botmodule_dir(Config::coredir + "/utils")
 698     @plugins.add_botmodule_dir(Config::coredir)
 699     @plugins.add_botmodule_dir("#{botclass}/plugins")
 700
 701     @config['plugins.path'].each do |_|
 702         path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
 703         @plugins.add_botmodule_dir(path)
 704     end
 705   end
 706
 707   def set_default_send_options(opts={})
 708     # Default send options for NOTICE and PRIVMSG
 709     unless defined? @default_send_options
 710       @default_send_options = {
 711         :queue_channel => nil,      # use default queue channel
 712         :queue_ring => nil,         # use default queue ring
 713         :newlines => :split,        # or :join
 714         :join_with => ' ',          # by default, use a single space
 715         :max_lines => 0,          # maximum number of lines to send with a single command
 716         :overlong => :split,        # or :truncate
 717         # TODO an array of splitpoints would be preferrable for this option:
 718         :split_at => /\s+/,         # by default, split overlong lines at whitespace
 719         :purge_split => true,       # should the split string be removed?
 720         :truncate_text => "#{Reverse}...#{Reverse}"  # text to be appened when truncating
 721       }
 722     end
 723     @default_send_options.update opts unless opts.empty?
 724     end
 725
 726   # checks if we should be quiet on a channel
 727   def quiet_on?(channel)
 728     return @quiet.include?('*') || @quiet.include?(channel.downcase)
 729   end
 730
 731   def set_quiet(channel)
 732     if channel
 733       ch = channel.downcase.dup
 734       @quiet << ch unless @quiet.include?(ch)
 735     else
 736       @quiet.clear
 737       @quiet << '*'
 738     end
 739   end
 740
 741   def reset_quiet(channel)
 742     if channel
 743       @quiet.delete channel.downcase
 744     else
 745       @quiet.clear
 746     end
 747   end
 748
 749   # things to do when we receive a signal
 750   def got_sig(sig)
 751     debug "received #{sig}, queueing quit"
 752     $interrupted += 1
 753     quit unless @quit_mutex.locked?
 754     debug "interrupted #{$interrupted} times"
 755     if $interrupted >= 3
 756       debug "drastic!"
 757       log_session_end
 758       exit 2
 759     end
 760   end
 761
 762   # connect the bot to IRC
 763   def connect
 764     begin
 765       trap("SIGINT") { got_sig("SIGINT") }
 766       trap("SIGTERM") { got_sig("SIGTERM") }
 767       trap("SIGHUP") { got_sig("SIGHUP") }
 768     rescue ArgumentError => e
 769       debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
 770     rescue Exception => e
 771       debug "failed to trap signals: #{e.pretty_inspect}"
 772     end
 773     begin
 774       quit if $interrupted > 0
 775       @socket.connect
 776     rescue => e
 777       raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
 778     end
 779     quit if $interrupted > 0
 780
 781     realname = @config['irc.name'].clone || 'Ruby bot'
 782     realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
 783
 784     @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
 785     @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
 786     quit if $interrupted > 0
 787     myself.nick = @config['irc.nick']
 788     myself.user = @config['irc.user']
 789   end
 790
 791   # begin event handling loop
 792   def mainloop
 793     while true
 794       begin
 795         quit if $interrupted > 0
 796         connect
 797
 798         quit_msg = nil
 799         while @socket.connected?
 800           quit if $interrupted > 0
 801
 802           # Wait for messages and process them as they arrive. If nothing is
 803           # received, we call the ping_server() method that will PING the
 804           # server if appropriate, or raise a TimeoutError if no PONG has been
 805           # received in the user-chosen timeout since the last PING sent.
 806           if @socket.select(1)
 807             break unless reply = @socket.gets
 808             @last_rec = Time.now
 809             @client.process reply
 810           else
 811             ping_server
 812           end
 813         end
 814
 815       # I despair of this. Some of my users get "connection reset by peer"
 816       # exceptions that ARENT SocketError's. How am I supposed to handle
 817       # that?
 818       rescue SystemExit
 819         log_session_end
 820         exit 0
 821       rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
 822         error "network exception: #{e.pretty_inspect}"
 823         quit_msg = e.to_s
 824       rescue BDB::Fatal => e
 825         fatal "fatal bdb error: #{e.pretty_inspect}"
 826         DBTree.stats
 827         # Why restart? DB problems are serious stuff ...
 828         # restart("Oops, we seem to have registry problems ...")
 829         log_session_end
 830         exit 2
 831       rescue Exception => e
 832         error "non-net exception: #{e.pretty_inspect}"
 833         quit_msg = e.to_s
 834       rescue => e
 835         fatal "unexpected exception: #{e.pretty_inspect}"
 836         log_session_end
 837         exit 2
 838       end
 839
 840       disconnect(quit_msg)
 841
 842       log "\n\nDisconnected\n\n"
 843
 844       quit if $interrupted > 0
 845
 846       log "\n\nWaiting to reconnect\n\n"
 847       sleep @config['server.reconnect_wait']
 848     end
 849   end
 850
 851   # type:: message type
 852   # where:: message target
 853   # message:: message text
 854   # send message +message+ of type +type+ to target +where+
 855   # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
 856   # relevant say() or notice() methods. This one should be used for IRCd
 857   # extensions you want to use in modules.
 858   def sendmsg(type, where, original_message, options={})
 859     opts = @default_send_options.merge(options)
 860
 861     # For starters, set up appropriate queue channels and rings
 862     mchan = opts[:queue_channel]
 863     mring = opts[:queue_ring]
 864     if mchan
 865       chan = mchan
 866     else
 867       chan = where
 868     end
 869     if mring
 870       ring = mring
 871     else
 872       case where
 873       when User
 874         ring = 1
 875       else
 876         ring = 2
 877       end
 878     end
 879
 880     multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
 881     messages = Array.new
 882     case opts[:newlines]
 883     when :join
 884       messages << [multi_line.gsub("\n", opts[:join_with])]
 885     when :split
 886       multi_line.each_line { |line|
 887         line.chomp!
 888         next unless(line.size > 0)
 889         messages << line
 890       }
 891     else
 892       raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
 893     end
 894
 895     # The IRC protocol requires that each raw message must be not longer
 896     # than 512 characters. From this length with have to subtract the EOL
 897     # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
 898     # that will be prepended by the server to all of our messages.
 899
 900     # The maximum raw message length we can send is therefore 512 - 2 - 2
 901     # minus the length of our hostmask.
 902
 903     max_len = 508 - myself.fullform.size
 904
 905     # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
 906     # will have a + or - prepended
 907     if server.capabilities[:"identify-msg"]
 908       max_len -= 1
 909     end
 910
 911     # When splitting the message, we'll be prefixing the following string:
 912     # (e.g. "PRIVMSG #rbot :")
 913     fixed = "#{type} #{where} :"
 914
 915     # And this is what's left
 916     left = max_len - fixed.size
 917
 918     truncate = opts[:truncate_text]
 919     truncate = @default_send_options[:truncate_text] if truncate.size > left
 920     truncate = "" if truncate.size > left
 921
 922     all_lines = messages.map { |line|
 923       if line.size < left
 924         line
 925       else
 926         case opts[:overlong]
 927         when :split
 928           msg = line.dup
 929           sub_lines = Array.new
 930           begin
 931             sub_lines << msg.slice!(0, left)
 932             break if msg.empty?
 933             lastspace = sub_lines.last.rindex(opts[:split_at])
 934             if lastspace
 935               msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
 936               msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
 937             end
 938           end until msg.empty?
 939           sub_lines
 940         when :truncate
 941           line.slice(0, left - truncate.size) << truncate
 942         else
 943           raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
 944         end
 945       end
 946     }.flatten
 947
 948     if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
 949       lines = all_lines[0...opts[:max_lines]]
 950       new_last = lines.last.slice(0, left - truncate.size) << truncate
 951       lines.last.replace(new_last)
 952     else
 953       lines = all_lines
 954     end
 955
 956     lines.each { |line|
 957       sendq "#{fixed}#{line}", chan, ring
 958       log_sent(type, where, line)
 959     }
 960   end
 961
 962   # queue an arbitraty message for the server
 963   def sendq(message="", chan=nil, ring=0)
 964     # temporary
 965     @socket.queue(message, chan, ring)
 966   end
 967
 968   # send a notice message to channel/nick +where+
 969   def notice(where, message, options={})
 970     return if where.kind_of?(Channel) and quiet_on?(where)
 971     sendmsg "NOTICE", where, message, options
 972   end
 973
 974   # say something (PRIVMSG) to channel/nick +where+
 975   def say(where, message, options={})
 976     return if where.kind_of?(Channel) and quiet_on?(where)
 977     sendmsg "PRIVMSG", where, message, options
 978   end
 979
 980   def ctcp_notice(where, command, message, options={})
 981     return if where.kind_of?(Channel) and quiet_on?(where)
 982     sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
 983   end
 984
 985   def ctcp_say(where, command, message, options={})
 986     return if where.kind_of?(Channel) and quiet_on?(where)
 987     sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
 988   end
 989
 990   # perform a CTCP action with message +message+ to channel/nick +where+
 991   def action(where, message, options={})
 992     ctcp_say(where, 'ACTION', message, options)
 993   end
 994
 995   # quick way to say "okay" (or equivalent) to +where+
 996   def okay(where)
 997     say where, @lang.get("okay")
 998   end
 999
1000   # log IRC-related message +message+ to a file determined by +where+.
1001   # +where+ can be a channel name, or a nick for private message logging
1002   def irclog(message, where="server")
1003     message = message.chomp
1004     stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
1005     if where.class <= Server
1006       where_str = "server"
1007     else
1008       where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
1009     end
1010     unless(@logs.has_key?(where_str))
1011       @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a")
1012       @logs[where_str].sync = true
1013     end
1014     @logs[where_str].puts "[#{stamp}] #{message}"
1015     #debug "[#{stamp}] <#{where}> #{message}"
1016   end
1017
1018   # set topic of channel +where+ to +topic+
1019   def topic(where, topic)
1020     sendq "TOPIC #{where} :#{topic}", where, 2
1021   end
1022
1023   def disconnect(message=nil)
1024     message = @lang.get("quit") if (!message || message.empty?)
1025     if @socket.connected?
1026       begin
1027         debug "Clearing socket"
1028         @socket.clearq
1029         debug "Sending quit message"
1030         @socket.emergency_puts "QUIT :#{message}"
1031         debug "Flushing socket"
1032         @socket.flush
1033       rescue SocketError => e
1034         error "error while disconnecting socket: #{e.pretty_inspect}"
1035       end
1036       debug "Shutting down socket"
1037       @socket.shutdown
1038     end
1039     debug "Logging quits"
1040     server.channels.each { |ch|
1041       irclog "@ quit (#{message})", ch
1042     }
1043     stop_server_pings
1044     @client.reset
1045   end
1046
1047   # disconnect from the server and cleanup all plugins and modules
1048   def shutdown(message=nil)
1049     @quit_mutex.synchronize do
1050       debug "Shutting down: #{message}"
1051       ## No we don't restore them ... let everything run through
1052       # begin
1053       #   trap("SIGINT", "DEFAULT")
1054       #   trap("SIGTERM", "DEFAULT")
1055       #   trap("SIGHUP", "DEFAULT")
1056       # rescue => e
1057       #   debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1058       # end
1059       debug "\tdisconnecting..."
1060       disconnect(message)
1061       debug "\tstopping timer..."
1062       @timer.stop
1063       debug "\tsaving ..."
1064       save
1065       debug "\tcleaning up ..."
1066       @save_mutex.synchronize do
1067         @plugins.cleanup
1068       end
1069       # debug "\tstopping timers ..."
1070       # @timer.stop
1071       # debug "Closing registries"
1072       # @registry.close
1073       debug "\t\tcleaning up the db environment ..."
1074       DBTree.cleanup_env
1075       log "rbot quit (#{message})"
1076     end
1077   end
1078
1079   # message:: optional IRC quit message
1080   # quit IRC, shutdown the bot
1081   def quit(message=nil)
1082     begin
1083       shutdown(message)
1084     ensure
1085       exit 0
1086     end
1087   end
1088
1089   # totally shutdown and respawn the bot
1090   def restart(message=nil)
1091     message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
1092     shutdown(message)
1093     sleep @config['server.reconnect_wait']
1094     begin
1095       # now we re-exec
1096       # Note, this fails on Windows
1097       debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1098       Dir.chdir(@run_dir)
1099       exec($0, *@argv)
1100     rescue Errno::ENOENT
1101       exec("ruby", *(@argv.unshift $0))
1102     rescue Exception => e
1103       $interrupted += 1
1104       raise e
1105     end
1106   end
1107
1108   # call the save method for all of the botmodules
1109   def save
1110     @save_mutex.synchronize do
1111       @plugins.save
1112       DBTree.cleanup_logs
1113     end
1114   end
1115
1116   # call the rescan method for all of the botmodules
1117   def rescan
1118     debug "\tstopping timer..."
1119     @timer.stop
1120     @save_mutex.synchronize do
1121       @lang.rescan
1122       @plugins.rescan
1123     end
1124     @timer.start
1125   end
1126
1127   # channel:: channel to join
1128   # key::     optional channel key if channel is +s
1129   # join a channel
1130   def join(channel, key=nil)
1131     if(key)
1132       sendq "JOIN #{channel} :#{key}", channel, 2
1133     else
1134       sendq "JOIN #{channel}", channel, 2
1135     end
1136   end
1137
1138   # part a channel
1139   def part(channel, message="")
1140     sendq "PART #{channel} :#{message}", channel, 2
1141   end
1142
1143   # attempt to change bot's nick to +name+
1144   def nickchg(name)
1145     sendq "NICK #{name}"
1146   end
1147
1148   # changing mode
1149   def mode(channel, mode, target)
1150     sendq "MODE #{channel} #{mode} #{target}", channel, 2
1151   end
1152
1153   # kicking a user
1154   def kick(channel, user, msg)
1155     sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1156   end
1157
1158   # m::     message asking for help
1159   # topic:: optional topic help is requested for
1160   # respond to online help requests
1161   def help(topic=nil)
1162     topic = nil if topic == ""
1163     case topic
1164     when nil
1165       helpstr = _("help topics: ")
1166       helpstr += @plugins.helptopics
1167       helpstr += _(" (help <topic> for more info)")
1168     else
1169       unless(helpstr = @plugins.help(topic))
1170         helpstr = _("no help for topic %{topic}") % { :topic => topic }
1171       end
1172     end
1173     return helpstr
1174   end
1175
1176   # returns a string describing the current status of the bot (uptime etc)
1177   def status
1178     secs_up = Time.new - @startup_time
1179     uptime = Utils.secs_to_string secs_up
1180     # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1181     return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
1182              {
1183                :up => uptime, :plug => @plugins.length,
1184                :sent => @socket.lines_sent, :recv => @socket.lines_received
1185              })
1186   end
1187
1188   # We want to respond to a hung server in a timely manner. If nothing was received
1189   # in the user-selected timeout and we haven't PINGed the server yet, we PING
1190   # the server. If the PONG is not received within the user-defined timeout, we
1191   # assume we're in ping timeout and act accordingly.
1192   def ping_server
1193     act_timeout = @config['server.ping_timeout']
1194     return if act_timeout <= 0
1195     now = Time.now
1196     if @last_rec && now > @last_rec + act_timeout
1197       if @last_ping.nil?
1198         # No previous PING pending, send a new one
1199         sendq "PING :rbot"
1200         @last_ping = Time.now
1201       else
1202         diff = now - @last_ping
1203         if diff > act_timeout
1204           debug "no PONG from server in #{diff} seconds, reconnecting"
1205           # the actual reconnect is handled in the main loop:
1206           raise TimeoutError, "no PONG from server in #{diff} seconds"
1207         end
1208       end
1209     end
1210   end
1211
1212   def stop_server_pings
1213     # cancel previous PINGs and reset time of last RECV
1214     @last_ping = nil
1215     @last_rec = nil
1216   end
1217
1218   private
1219
1220   def irclogprivmsg(m)
1221     if(m.action?)
1222       if(m.private?)
1223         irclog "* [#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
1224       else
1225         irclog "* #{m.source} #{m.logmessage}", m.target
1226       end
1227     else
1228       if(m.public?)
1229         irclog "<#{m.source}> #{m.logmessage}", m.target
1230       else
1231         irclog "[#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
1232       end
1233     end
1234   end
1235
1236   # log a message. Internal use only.
1237   def log_sent(type, where, message)
1238     case type
1239       when "NOTICE"
1240         case where
1241         when Channel
1242           irclog "-=#{myself}=- #{message}", where
1243         else
1244           irclog "[-=#{where}=-] #{message}", where
1245         end
1246       when "PRIVMSG"
1247         case where
1248         when Channel
1249           irclog "<#{myself}> #{message}", where
1250         else
1251           irclog "[msg(#{where})] #{message}", where
1252         end
1253     end
1254   end
1255
1256   def irclogjoin(m)
1257     if m.address?
1258       debug "joined channel #{m.channel}"
1259       irclog "@ Joined channel #{m.channel}", m.channel
1260     else
1261       irclog "@ #{m.source} joined channel #{m.channel}", m.channel
1262     end
1263   end
1264
1265   def irclogpart(m)
1266     if(m.address?)
1267       debug "left channel #{m.channel}"
1268       irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
1269     else
1270       irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel
1271     end
1272   end
1273
1274   def irclogkick(m)
1275     if(m.address?)
1276       debug "kicked from channel #{m.channel}"
1277       irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
1278     else
1279       irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
1280     end
1281   end
1282
1283   def irclogtopic(m)
1284     if m.source == myself
1285       irclog "@ I set topic \"#{m.topic}\"", m.channel
1286     else
1287       irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
1288     end
1289   end
1290
1291 end
1292
1293 end