12 $debug = false unless $debug
13 $daemonize = false unless $daemonize
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
21 $log_queue = Queue.new
26 unless Kernel.instance_methods.include?("pretty_inspect")
30 public :pretty_inspect
35 q.group(1, "#<%s: %s" % [self.class, self.message], ">") {
36 if self.backtrace and not self.backtrace.empty?
38 q.seplist(self.backtrace, lambda { q.text "\n" } ) { |l| q.text l }
44 class ServerError < RuntimeError
47 def rawlog(level, message=nil, who_pos=1)
49 if call_stack.length > who_pos
50 who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
54 # Output each line. To distinguish between separate messages and multi-line
55 # messages originating at the same time, we blank #{who} after the first message
57 # Also, we output strings as-is but for other objects we use pretty_inspect
62 str = message.pretty_inspect
66 qmsg.push [level, l.chomp, who]
73 if $log_thread && $log_thread.alive?
82 def restart_logger(newlogger = false)
85 $logger = newlogger if newlogger
87 $log_thread = Thread.new do
89 while ls = $log_queue.pop
90 ls.each { |l| $logger.add(*l) }
98 $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
103 $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
107 def debug(message=nil, who_pos=1)
108 rawlog(Logger::Severity::DEBUG, message, who_pos)
111 def log(message=nil, who_pos=1)
112 rawlog(Logger::Severity::INFO, message, who_pos)
115 def warning(message=nil, who_pos=1)
116 rawlog(Logger::Severity::WARN, message, who_pos)
119 def error(message=nil, who_pos=1)
120 rawlog(Logger::Severity::ERROR, message, who_pos)
123 def fatal(message=nil, who_pos=1)
124 rawlog(Logger::Severity::FATAL, message, who_pos)
129 warning "warning test"
133 # The following global is used for the improved signal handling.
137 require 'rbot/rbotconfig'
138 require 'rbot/load-gettext'
139 require 'rbot/config'
140 require 'rbot/config-compat'
143 require 'rbot/rfc2812'
144 require 'rbot/ircsocket'
145 require 'rbot/botuser'
147 require 'rbot/plugins'
148 require 'rbot/message'
149 require 'rbot/language'
150 require 'rbot/dbhash'
151 require 'rbot/registry'
155 # Main bot class, which manages the various components, receives messages,
156 # handles them or passes them to plugins, and contains core functionality.
158 COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
159 SOURCE_URL = "http://ruby-rbot.org"
160 # the bot's Auth data
163 # the bot's Config data
166 # the botclass for this bot (determines configdir among other things)
167 attr_reader :botclass
169 # used to perform actions periodically (saves configuration once per minute
173 # synchronize with this mutex while touching permanent data files:
174 # saving, flushing, cleaning up ...
175 attr_reader :save_mutex
177 # bot's Language data
184 # bot's object registry, plugins get an interface to this for persistant
185 # storage (hash interface tied to a bdb file, plugins use Accessors to store
186 # and restore objects in their own namespaces.)
187 attr_reader :registry
189 # bot's plugins. This is an instance of class Plugins
192 # bot's httputil help object, for fetching resources via http. Sets up
193 # proxies etc as defined by the bot configuration/environment
194 attr_accessor :httputil
196 # server we are connected to
202 # bot User in the client/server connection
208 # bot User in the client/server connection
213 # nick wanted by the bot. This defaults to the irc.nick config value,
214 # but may be overridden by a manual !nick command
216 @wanted_nick || config['irc.nick']
219 # set the nick wanted by the bot
221 if wn.nil? or wn.to_s.downcase == config['irc.nick'].downcase
224 @wanted_nick = wn.to_s.dup
232 ret = self.to_s[0..-2]
233 ret << ' version=' << $version.inspect
234 ret << ' botclass=' << botclass.inspect
235 ret << ' lang="' << lang.language
240 ret << ' nick=' << nick.inspect
243 ret << (server.to_s + (socket ?
244 ' [' << socket.server_uri.to_s << ']' : '')).inspect
245 unless server.channels.empty?
247 ret << server.channels.map { |c|
248 "%s%s" % [c.modes_of(nick).map { |m|
249 server.prefix_for_mode(m)
256 ret << ' plugins=' << plugins.inspect
261 # create a new Bot with botclass +botclass+
262 def initialize(botclass, params = {})
263 # Config for the core bot
264 # TODO should we split socket stuff into ircsocket, etc?
265 Config.register Config::ArrayValue.new('server.list',
266 :default => ['irc://localhost'], :wizard => true,
267 :requires_restart => true,
268 :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.")
269 Config.register Config::BooleanValue.new('server.ssl',
270 :default => false, :requires_restart => true, :wizard => true,
271 :desc => "Use SSL to connect to this server?")
272 Config.register Config::StringValue.new('server.password',
273 :default => false, :requires_restart => true,
274 :desc => "Password for connecting to this server (if required)",
276 Config.register Config::StringValue.new('server.bindhost',
277 :default => false, :requires_restart => true,
278 :desc => "Specific local host or IP for the bot to bind to (if required)",
280 Config.register Config::IntegerValue.new('server.reconnect_wait',
281 :default => 5, :validate => Proc.new{|v| v >= 0},
282 :desc => "Seconds to wait before attempting to reconnect, on disconnect")
283 Config.register Config::IntegerValue.new('server.ping_timeout',
284 :default => 30, :validate => Proc.new{|v| v >= 0},
285 :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
286 Config.register Config::ArrayValue.new('server.nocolor_modes',
287 :default => ['c'], :wizard => false,
288 :requires_restart => false,
289 :desc => "List of channel modes that require messages to be without colors")
291 Config.register Config::StringValue.new('irc.nick', :default => "rbot",
292 :desc => "IRC nickname the bot should attempt to use", :wizard => true,
293 :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
294 Config.register Config::StringValue.new('irc.name',
295 :default => "Ruby bot", :requires_restart => true,
296 :desc => "IRC realname the bot should use")
297 Config.register Config::BooleanValue.new('irc.name_copyright',
298 :default => true, :requires_restart => true,
299 :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
300 Config.register Config::StringValue.new('irc.user', :default => "rbot",
301 :requires_restart => true,
302 :desc => "local user the bot should appear to be", :wizard => true)
303 Config.register Config::ArrayValue.new('irc.join_channels',
304 :default => [], :wizard => true,
305 :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'")
306 Config.register Config::ArrayValue.new('irc.ignore_users',
308 :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
310 Config.register Config::IntegerValue.new('core.save_every',
311 :default => 60, :validate => Proc.new{|v| v >= 0},
312 :on_change => Proc.new { |bot, v|
315 @timer.reschedule(@save_timer, v)
316 @timer.unblock(@save_timer)
318 @timer.block(@save_timer)
322 @save_timer = @timer.add(v) { bot.save }
324 # Nothing to do when v == 0
327 :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
329 Config.register Config::BooleanValue.new('core.run_as_daemon',
330 :default => false, :requires_restart => true,
331 :desc => "Should the bot run as a daemon?")
333 Config.register Config::StringValue.new('log.file',
334 :default => false, :requires_restart => true,
335 :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
336 Config.register Config::IntegerValue.new('log.level',
337 :default => 1, :requires_restart => false,
338 :validate => Proc.new { |v| (0..5).include?(v) },
339 :on_change => Proc.new { |bot, v|
342 :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
343 Config.register Config::IntegerValue.new('log.keep',
344 :default => 1, :requires_restart => true,
345 :validate => Proc.new { |v| v >= 0 },
346 :desc => "How many old console messages logfiles to keep")
347 Config.register Config::IntegerValue.new('log.max_size',
348 :default => 10, :requires_restart => true,
349 :validate => Proc.new { |v| v > 0 },
350 :desc => "Maximum console messages logfile size (in megabytes)")
352 Config.register Config::ArrayValue.new('plugins.path',
353 :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
354 :requires_restart => false,
355 :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
356 :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")
358 Config.register Config::EnumValue.new('send.newlines',
359 :values => ['split', 'join'], :default => 'split',
360 :on_change => Proc.new { |bot, v|
361 bot.set_default_send_options :newlines => v.to_sym
363 :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")
364 Config.register Config::StringValue.new('send.join_with',
366 :on_change => Proc.new { |bot, v|
367 bot.set_default_send_options :join_with => v.dup
369 :desc => "String used to replace newlines when send.newlines is set to join")
370 Config.register Config::IntegerValue.new('send.max_lines',
372 :validate => Proc.new { |v| v >= 0 },
373 :on_change => Proc.new { |bot, v|
374 bot.set_default_send_options :max_lines => v
376 :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
377 Config.register Config::EnumValue.new('send.overlong',
378 :values => ['split', 'truncate'], :default => 'split',
379 :on_change => Proc.new { |bot, v|
380 bot.set_default_send_options :overlong => v.to_sym
382 :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")
383 Config.register Config::StringValue.new('send.split_at',
385 :on_change => Proc.new { |bot, v|
386 bot.set_default_send_options :split_at => Regexp.new(v)
388 :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
389 Config.register Config::BooleanValue.new('send.purge_split',
391 :on_change => Proc.new { |bot, v|
392 bot.set_default_send_options :purge_split => v
394 :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
395 Config.register Config::StringValue.new('send.truncate_text',
396 :default => "#{Reverse}...#{Reverse}",
397 :on_change => Proc.new { |bot, v|
398 bot.set_default_send_options :truncate_text => v.dup
400 :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")
401 Config.register Config::IntegerValue.new('send.penalty_pct',
403 :validate => Proc.new { |v| v >= 0 },
404 :on_change => Proc.new { |bot, v|
405 bot.socket.penalty_pct = v
407 :desc => "Percentage of IRC penalty to consider when sending messages to prevent being disconnected for excess flood. Set to 0 to disable penalty control.")
409 @argv = params[:argv]
410 @run_dir = params[:run_dir] || Dir.pwd
412 unless FileTest.directory? Config::coredir
413 error "core directory '#{Config::coredir}' not found, did you setup.rb?"
417 unless FileTest.directory? Config::datadir
418 error "data directory '#{Config::datadir}' not found, did you setup.rb?"
422 unless botclass and not botclass.empty?
423 # We want to find a sensible default.
424 # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
425 # * On Windows (at least the NT versions) we want to put our stuff in the
426 # Application Data folder.
427 # We don't use any particular O/S detection magic, exploiting the fact that
428 # Etc.getpwuid is nil on Windows
429 if Etc.getpwuid(Process::Sys.geteuid)
430 botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
432 if ENV.has_key?('APPDATA')
433 botclass = ENV['APPDATA'].dup
434 botclass.gsub!("\\","/")
439 botclass = File.expand_path(botclass)
440 @botclass = botclass.gsub(/\/$/, "")
442 if FileTest.directory? botclass
443 # compare the templates dir with the current botclass, and fill it in with
445 # Sadly, FileUtils.cp_r doesn't have an :update option, so we have to do it
447 template = File.join Config::datadir, 'templates'
448 # note that we use the */** pattern because we don't want to match
449 # keywords.rbot, which gets deleted on load and would therefore be missing always
450 missing = Dir.chdir(template) { Dir.glob('*/**') } - Dir.chdir(botclass) { Dir.glob('*/**') }
452 dest = File.join(botclass, f)
453 FileUtils.mkdir_p File.dirname dest
454 FileUtils.cp File.join(template, f), dest
457 log "no #{botclass} directory found, creating from templates.."
458 if FileTest.exist? botclass
459 error "file #{botclass} exists but isn't a directory"
462 FileUtils.cp_r Config::datadir+'/templates', botclass
465 Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
466 Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
468 # Time at which the last PING was sent
470 # Time at which the last line was RECV'd from the server
473 @startup_time = Time.new
476 @config = Config.manager
477 @config.bot_associate(self)
478 rescue Exception => e
484 if @config['core.run_as_daemon']
488 @logfile = @config['log.file']
489 if @logfile.class!=String || @logfile.empty?
490 @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
491 debug "Using `#{@logfile}' as debug log"
494 # See http://blog.humlab.umu.se/samuel/archives/000107.html
495 # for the backgrounding code
501 rescue NotImplementedError
502 warning "Could not background, fork not supported"
505 rescue Exception => e
506 warning "Could not background. #{e.pretty_inspect}"
509 # File.umask 0000 # Ensure sensible umask. Adjust as needed.
512 logger = Logger.new(@logfile,
514 @config['log.max_size']*1024*1024)
515 logger.datetime_format= $dateformat
516 logger.level = @config['log.level']
517 logger.level = $cl_loglevel if defined? $cl_loglevel
518 logger.level = 0 if $debug
520 restart_logger(logger)
525 log "Redirecting standard input/output/error"
526 [$stdin, $stdout, $stderr].each do |fd|
528 fd.reopen "/dev/null"
530 # On Windows, there's not such thing as /dev/null
535 def $stdout.write(str=nil)
539 def $stdout.write(str=nil)
540 if str.to_s.match(/:\d+: warning:/)
549 File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
553 @registry = Registry.new self
556 @save_mutex = Mutex.new
557 if @config['core.save_every'] > 0
558 @save_timer = @timer.add(@config['core.save_every']) { save }
562 @quit_mutex = Mutex.new
565 @lang = Language.new(self, @config['core.language'])
568 @auth = Auth::manager
569 @auth.bot_associate(self)
570 # @auth.load("#{botclass}/botusers.yaml")
571 rescue Exception => e
576 @auth.everyone.set_default_permission("*", true)
577 @auth.botowner.password= @config['auth.password']
579 Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
580 @plugins = Plugins::manager
581 @plugins.bot_associate(self)
584 if @config['server.name']
585 debug "upgrading configuration (server.name => server.list)"
586 srv_uri = 'irc://' + @config['server.name']
587 srv_uri += ":#{@config['server.port']}" if @config['server.port']
588 @config.items['server.list'.to_sym].set_string(srv_uri)
589 @config.delete('server.name'.to_sym)
590 @config.delete('server.port'.to_sym)
591 debug "server.list is now #{@config['server.list'].inspect}"
594 @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], :ssl => @config['server.ssl'], :penalty_pct =>@config['send.penalty_pct'])
599 # Channels where we are quiet
600 # Array of channels names where the bot should be quiet
601 # '*' means all channels
604 # but we always speak here
607 # the nick we want, if it's different from the irc.nick config value
608 # (e.g. as set by a !nick command)
611 @client[:welcome] = proc {|data|
612 m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])
614 @plugins.delegate("welcome", m)
615 @plugins.delegate("connect")
618 # TODO the next two @client should go into rfc2812.rb, probably
619 # Since capabs are two-steps processes, server.supports[:capab]
620 # should be a three-state: nil, [], [....]
621 asked_for = { :"identify-msg" => false }
622 @client[:isupport] = proc { |data|
623 if server.supports[:capab] and !asked_for[:"identify-msg"]
624 sendq "CAPAB IDENTIFY-MSG"
625 asked_for[:"identify-msg"] = true
628 @client[:datastr] = proc { |data|
629 if data[:text] == "IDENTIFY-MSG"
630 server.capabilities[:"identify-msg"] = true
632 debug "Not handling RPL_DATASTR #{data[:servermessage]}"
636 @client[:privmsg] = proc { |data|
637 m = PrivMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
638 # debug "Message source is #{data[:source].inspect}"
639 # debug "Message target is #{data[:target].inspect}"
640 # debug "Bot is #{myself.inspect}"
642 @config['irc.ignore_users'].each { |mask|
643 if m.source.matches?(server.new_netmask(mask))
648 @plugins.irc_delegate('privmsg', m)
650 @client[:notice] = proc { |data|
651 message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
652 # pass it off to plugins that want to hear everything
653 @plugins.irc_delegate "notice", message
655 @client[:motd] = proc { |data|
656 m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd])
657 @plugins.delegate "motd", m
659 @client[:nicktaken] = proc { |data|
660 new = "#{data[:nick]}_"
662 # If we're setting our nick at connection because our choice was taken,
663 # we have to fix our nick manually, because there will be no NICK message
664 # to inform us that our nick has been changed.
665 if data[:target] == '*'
666 debug "setting my connection nick to #{new}"
669 @plugins.delegate "nicktaken", data[:nick]
671 @client[:badnick] = proc {|data|
672 warning "bad nick (#{data[:nick]})"
674 @client[:ping] = proc {|data|
675 sendq "PONG #{data[:pingid]}"
677 @client[:pong] = proc {|data|
680 @client[:nick] = proc {|data|
681 # debug "Message source is #{data[:source].inspect}"
682 # debug "Bot is #{myself.inspect}"
683 source = data[:source]
686 m = NickMessage.new(self, server, source, old, new)
687 m.is_on = data[:is_on]
689 debug "my nick is now #{new}"
691 @plugins.irc_delegate("nick", m)
693 @client[:quit] = proc {|data|
694 source = data[:source]
695 message = data[:message]
696 m = QuitMessage.new(self, server, source, source, message)
697 m.was_on = data[:was_on]
698 @plugins.irc_delegate("quit", m)
700 @client[:mode] = proc {|data|
701 m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
702 m.modes = data[:modes]
703 @plugins.delegate "modechange", m
705 @client[:whois] = proc {|data|
706 source = data[:source]
707 target = server.get_user(data[:whois][:nick])
708 m = WhoisMessage.new(self, server, source, target, data[:whois])
709 @plugins.delegate "whois", m
711 @client[:join] = proc {|data|
712 m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
713 sendq("MODE #{data[:channel]}", nil, 0) if m.address?
714 @plugins.irc_delegate("join", m)
715 sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
717 @client[:part] = proc {|data|
718 m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
719 @plugins.irc_delegate("part", m)
721 @client[:kick] = proc {|data|
722 m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
723 @plugins.irc_delegate("kick", m)
725 @client[:invite] = proc {|data|
726 m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
727 @plugins.irc_delegate("invite", m)
729 @client[:changetopic] = proc {|data|
730 m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
732 @plugins.irc_delegate("topic", m)
734 # @client[:topic] = proc { |data|
735 # irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
737 @client[:topicinfo] = proc { |data|
738 channel = data[:channel]
739 topic = channel.topic
740 m = TopicMessage.new(self, server, data[:source], channel, topic)
741 m.info_or_set = :info
742 @plugins.irc_delegate("topic", m)
744 @client[:names] = proc { |data|
745 m = NamesMessage.new(self, server, server, data[:channel])
746 m.users = data[:users]
747 @plugins.delegate "names", m
749 @client[:error] = proc { |data|
750 raise ServerError, data[:message]
752 @client[:unknown] = proc { |data|
753 #debug "UNKNOWN: #{data[:serverstring]}"
754 m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
755 @plugins.delegate "unknown_message", m
758 set_default_send_options :newlines => @config['send.newlines'].to_sym,
759 :join_with => @config['send.join_with'].dup,
760 :max_lines => @config['send.max_lines'],
761 :overlong => @config['send.overlong'].to_sym,
762 :split_at => Regexp.new(@config['send.split_at']),
763 :purge_split => @config['send.purge_split'],
764 :truncate_text => @config['send.truncate_text'].dup
769 def setup_plugins_path
770 @plugins.clear_botmodule_dirs
771 @plugins.add_botmodule_dir(Config::coredir + "/utils")
772 @plugins.add_botmodule_dir(Config::coredir)
773 @plugins.add_botmodule_dir("#{botclass}/plugins")
775 @config['plugins.path'].each do |_|
776 path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
777 @plugins.add_botmodule_dir(path)
781 def set_default_send_options(opts={})
782 # Default send options for NOTICE and PRIVMSG
783 unless defined? @default_send_options
784 @default_send_options = {
785 :queue_channel => nil, # use default queue channel
786 :queue_ring => nil, # use default queue ring
787 :newlines => :split, # or :join
788 :join_with => ' ', # by default, use a single space
789 :max_lines => 0, # maximum number of lines to send with a single command
790 :overlong => :split, # or :truncate
791 # TODO an array of splitpoints would be preferrable for this option:
792 :split_at => /\s+/, # by default, split overlong lines at whitespace
793 :purge_split => true, # should the split string be removed?
794 :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
797 @default_send_options.update opts unless opts.empty?
800 # checks if we should be quiet on a channel
801 def quiet_on?(channel)
802 ch = channel.downcase
803 return (@quiet.include?('*') && !@not_quiet.include?(ch)) || @quiet.include?(ch)
806 def set_quiet(channel = nil)
808 ch = channel.downcase.dup
809 @not_quiet.delete(ch)
818 def reset_quiet(channel = nil)
820 ch = channel.downcase.dup
829 # things to do when we receive a signal
830 def got_sig(sig, func=:quit)
831 debug "received #{sig}, queueing #{func}"
832 # this is not an interruption if we just need to reconnect
833 $interrupted += 1 unless func == :reconnect
834 self.send(func) unless @quit_mutex.locked?
835 debug "interrupted #{$interrupted} times"
846 trap("SIGINT") { got_sig("SIGINT") }
847 trap("SIGTERM") { got_sig("SIGTERM") }
848 trap("SIGHUP") { got_sig("SIGHUP", :restart) }
849 trap("SIGUSR1") { got_sig("SIGUSR1", :reconnect) }
850 rescue ArgumentError => e
851 debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
852 rescue Exception => e
853 debug "failed to trap signals: #{e.pretty_inspect}"
857 # connect the bot to IRC
860 quit if $interrupted > 0
864 raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
866 quit if $interrupted > 0
868 realname = @config['irc.name'].clone || 'Ruby bot'
869 realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
871 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
872 @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
873 quit if $interrupted > 0
874 myself.nick = @config['irc.nick']
875 myself.user = @config['irc.user']
878 # disconnect the bot from IRC, if connected, and then connect (again)
879 def reconnect(message=nil, too_fast=false)
880 # we will wait only if @last_rec was not nil, i.e. if we were connected or
881 # got disconnected by a network error
882 # if someone wants to manually call disconnect() _and_ reconnect(), they
883 # will have to take care of the waiting themselves
884 will_wait = !!@last_rec
886 if @socket.connected?
891 log "\n\nDisconnected\n\n"
893 quit if $interrupted > 0
895 log "\n\nWaiting to reconnect\n\n"
896 sleep @config['server.reconnect_wait']
897 sleep 10*@config['server.reconnect_wait'] if too_fast
903 # begin event handling loop
908 quit if $interrupted > 0
910 while @socket.connected?
911 quit if $interrupted > 0
913 # Wait for messages and process them as they arrive. If nothing is
914 # received, we call the ping_server() method that will PING the
915 # server if appropriate, or raise a TimeoutError if no PONG has been
916 # received in the user-chosen timeout since the last PING sent.
918 break unless reply = @socket.gets
920 @client.process reply
926 # I despair of this. Some of my users get "connection reset by peer"
927 # exceptions that ARENT SocketError's. How am I supposed to handle
932 rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
933 error "network exception: #{e.pretty_inspect}"
936 # received an ERROR from the server
937 quit_msg = "server ERROR: " + e.message
938 too_fast = e.message.index("reconnect too fast")
939 rescue BDB::Fatal => e
940 fatal "fatal bdb error: #{e.pretty_inspect}"
942 # Why restart? DB problems are serious stuff ...
943 # restart("Oops, we seem to have registry problems ...")
946 rescue Exception => e
947 error "non-net exception: #{e.pretty_inspect}"
950 fatal "unexpected exception: #{e.pretty_inspect}"
954 reconnect(quit_msg, too_fast)
958 # type:: message type
959 # where:: message target
960 # message:: message text
961 # send message +message+ of type +type+ to target +where+
962 # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
963 # relevant say() or notice() methods. This one should be used for IRCd
964 # extensions you want to use in modules.
965 def sendmsg(type, where, original_message, options={})
966 opts = @default_send_options.merge(options)
968 # For starters, set up appropriate queue channels and rings
969 mchan = opts[:queue_channel]
970 mring = opts[:queue_ring]
987 multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
989 # if target is a channel with nocolor modes, strip colours
990 if where.kind_of?(Channel) and where.mode.any?(*config['server.nocolor_modes'])
991 multi_line.replace BasicUserMessage.strip_formatting(multi_line)
997 messages << [multi_line.gsub("\n", opts[:join_with])]
999 multi_line.each_line { |line|
1001 next unless(line.size > 0)
1005 raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
1008 # The IRC protocol requires that each raw message must be not longer
1009 # than 512 characters. From this length with have to subtract the EOL
1010 # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
1011 # that will be prepended by the server to all of our messages.
1013 # The maximum raw message length we can send is therefore 512 - 2 - 2
1014 # minus the length of our hostmask.
1016 max_len = 508 - myself.fullform.size
1018 # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
1019 # will have a + or - prepended
1020 if server.capabilities[:"identify-msg"]
1024 # When splitting the message, we'll be prefixing the following string:
1025 # (e.g. "PRIVMSG #rbot :")
1026 fixed = "#{type} #{where} :"
1028 # And this is what's left
1029 left = max_len - fixed.size
1031 truncate = opts[:truncate_text]
1032 truncate = @default_send_options[:truncate_text] if truncate.size > left
1033 truncate = "" if truncate.size > left
1035 all_lines = messages.map { |line|
1039 case opts[:overlong]
1042 sub_lines = Array.new
1044 sub_lines << msg.slice!(0, left)
1046 lastspace = sub_lines.last.rindex(opts[:split_at])
1048 msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
1049 msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
1051 end until msg.empty?
1054 line.slice(0, left - truncate.size) << truncate
1056 raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
1061 if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
1062 lines = all_lines[0...opts[:max_lines]]
1063 new_last = lines.last.slice(0, left - truncate.size) << truncate
1064 lines.last.replace(new_last)
1070 sendq "#{fixed}#{line}", chan, ring
1071 delegate_sent(type, where, line)
1075 # queue an arbitraty message for the server
1076 def sendq(message="", chan=nil, ring=0)
1078 @socket.queue(message, chan, ring)
1081 # send a notice message to channel/nick +where+
1082 def notice(where, message, options={})
1083 return if where.kind_of?(Channel) and quiet_on?(where)
1084 sendmsg "NOTICE", where, message, options
1087 # say something (PRIVMSG) to channel/nick +where+
1088 def say(where, message, options={})
1089 return if where.kind_of?(Channel) and quiet_on?(where)
1090 sendmsg "PRIVMSG", where, message, options
1093 def ctcp_notice(where, command, message, options={})
1094 return if where.kind_of?(Channel) and quiet_on?(where)
1095 sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
1098 def ctcp_say(where, command, message, options={})
1099 return if where.kind_of?(Channel) and quiet_on?(where)
1100 sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
1103 # perform a CTCP action with message +message+ to channel/nick +where+
1104 def action(where, message, options={})
1105 ctcp_say(where, 'ACTION', message, options)
1108 # quick way to say "okay" (or equivalent) to +where+
1110 say where, @lang.get("okay")
1113 # set topic of channel +where+ to +topic+
1114 # can also be used to retrieve the topic of channel +where+
1115 # by omitting the last argument
1116 def topic(where, topic=nil)
1118 sendq "TOPIC #{where}", where, 2
1120 sendq "TOPIC #{where} :#{topic}", where, 2
1124 def disconnect(message=nil)
1125 message = @lang.get("quit") if (!message || message.empty?)
1126 if @socket.connected?
1128 debug "Clearing socket"
1130 debug "Sending quit message"
1131 @socket.emergency_puts "QUIT :#{message}"
1132 debug "Logging quits"
1133 delegate_sent('QUIT', myself, message)
1134 debug "Flushing socket"
1136 rescue SocketError => e
1137 error "error while disconnecting socket: #{e.pretty_inspect}"
1139 debug "Shutting down socket"
1146 # disconnect from the server and cleanup all plugins and modules
1147 def shutdown(message=nil)
1148 @quit_mutex.synchronize do
1149 debug "Shutting down: #{message}"
1150 ## No we don't restore them ... let everything run through
1152 # trap("SIGINT", "DEFAULT")
1153 # trap("SIGTERM", "DEFAULT")
1154 # trap("SIGHUP", "DEFAULT")
1156 # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1158 debug "\tdisconnecting..."
1160 debug "\tstopping timer..."
1162 debug "\tsaving ..."
1164 debug "\tcleaning up ..."
1165 @save_mutex.synchronize do
1168 # debug "\tstopping timers ..."
1170 # debug "Closing registries"
1172 debug "\t\tcleaning up the db environment ..."
1174 log "rbot quit (#{message})"
1178 # message:: optional IRC quit message
1179 # quit IRC, shutdown the bot
1180 def quit(message=nil)
1188 # totally shutdown and respawn the bot
1189 def restart(message=nil)
1190 message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
1192 sleep @config['server.reconnect_wait']
1195 # Note, this fails on Windows
1196 debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1200 rescue Errno::ENOENT
1202 exec("ruby", *(@argv.unshift $0))
1203 rescue Exception => e
1209 # call the save method for all of the botmodules
1211 @save_mutex.synchronize do
1217 # call the rescan method for all of the botmodules
1219 debug "\tstopping timer..."
1221 @save_mutex.synchronize do
1228 # channel:: channel to join
1229 # key:: optional channel key if channel is +s
1231 def join(channel, key=nil)
1233 sendq "JOIN #{channel} :#{key}", channel, 2
1235 sendq "JOIN #{channel}", channel, 2
1240 def part(channel, message="")
1241 sendq "PART #{channel} :#{message}", channel, 2
1244 # attempt to change bot's nick to +name+
1246 sendq "NICK #{name}"
1250 def mode(channel, mode, target=nil)
1251 sendq "MODE #{channel} #{mode} #{target}", channel, 2
1255 def whois(nick, target=nil)
1256 sendq "WHOIS #{target} #{nick}", nil, 0
1260 def kick(channel, user, msg)
1261 sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1264 # m:: message asking for help
1265 # topic:: optional topic help is requested for
1266 # respond to online help requests
1268 topic = nil if topic == ""
1271 helpstr = _("help topics: ")
1272 helpstr += @plugins.helptopics
1273 helpstr += _(" (help <topic> for more info)")
1275 unless(helpstr = @plugins.help(topic))
1276 helpstr = _("no help for topic %{topic}") % { :topic => topic }
1282 # returns a string describing the current status of the bot (uptime etc)
1284 secs_up = Time.new - @startup_time
1285 uptime = Utils.secs_to_string secs_up
1286 # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1287 return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
1289 :up => uptime, :plug => @plugins.length,
1290 :sent => @socket.lines_sent, :recv => @socket.lines_received
1294 # We want to respond to a hung server in a timely manner. If nothing was received
1295 # in the user-selected timeout and we haven't PINGed the server yet, we PING
1296 # the server. If the PONG is not received within the user-defined timeout, we
1297 # assume we're in ping timeout and act accordingly.
1299 act_timeout = @config['server.ping_timeout']
1300 return if act_timeout <= 0
1302 if @last_rec && now > @last_rec + act_timeout
1304 # No previous PING pending, send a new one
1306 @last_ping = Time.now
1308 diff = now - @last_ping
1309 if diff > act_timeout
1310 debug "no PONG from server in #{diff} seconds, reconnecting"
1311 # the actual reconnect is handled in the main loop:
1312 raise TimeoutError, "no PONG from server in #{diff} seconds"
1318 def stop_server_pings
1319 # cancel previous PINGs and reset time of last RECV
1326 # delegate sent messages
1327 def delegate_sent(type, where, message)
1328 args = [self, server, myself, server.user_or_channel(where.to_s), message]
1331 m = NoticeMessage.new(*args)
1333 m = PrivMessage.new(*args)
1335 m = QuitMessage.new(*args)
1336 m.was_on = myself.channels
1338 @plugins.delegate('sent', m)