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'
141 log "rubygems unavailable"
144 require 'rbot/load-gettext'
145 require 'rbot/config'
146 require 'rbot/config-compat'
149 require 'rbot/rfc2812'
150 require 'rbot/ircsocket'
151 require 'rbot/botuser'
153 require 'rbot/plugins'
154 require 'rbot/message'
155 require 'rbot/language'
156 require 'rbot/dbhash'
157 require 'rbot/registry'
161 # Main bot class, which manages the various components, receives messages,
162 # handles them or passes them to plugins, and contains core functionality.
164 COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
165 SOURCE_URL = "http://ruby-rbot.org"
166 # the bot's Auth data
169 # the bot's Config data
172 # the botclass for this bot (determines configdir among other things)
173 attr_reader :botclass
175 # used to perform actions periodically (saves configuration once per minute
179 # synchronize with this mutex while touching permanent data files:
180 # saving, flushing, cleaning up ...
181 attr_reader :save_mutex
183 # bot's Language data
190 # bot's object registry, plugins get an interface to this for persistant
191 # storage (hash interface tied to a bdb file, plugins use Accessors to store
192 # and restore objects in their own namespaces.)
193 attr_reader :registry
195 # bot's plugins. This is an instance of class Plugins
198 # bot's httputil help object, for fetching resources via http. Sets up
199 # proxies etc as defined by the bot configuration/environment
200 attr_accessor :httputil
202 # server we are connected to
208 # bot User in the client/server connection
214 # bot nick in the client/server connection
219 # bot channels in the client/server connection
224 # nick wanted by the bot. This defaults to the irc.nick config value,
225 # but may be overridden by a manual !nick command
227 @wanted_nick || config['irc.nick']
230 # set the nick wanted by the bot
232 if wn.nil? or wn.to_s.downcase == config['irc.nick'].downcase
235 @wanted_nick = wn.to_s.dup
243 ret = self.to_s[0..-2]
244 ret << ' version=' << $version.inspect
245 ret << ' botclass=' << botclass.inspect
246 ret << ' lang="' << lang.language
251 ret << ' nick=' << nick.inspect
254 ret << (server.to_s + (socket ?
255 ' [' << socket.server_uri.to_s << ']' : '')).inspect
256 unless server.channels.empty?
258 ret << server.channels.map { |c|
259 "%s%s" % [c.modes_of(nick).map { |m|
260 server.prefix_for_mode(m)
267 ret << ' plugins=' << plugins.inspect
272 # create a new Bot with botclass +botclass+
273 def initialize(botclass, params = {})
274 # Config for the core bot
275 # TODO should we split socket stuff into ircsocket, etc?
276 Config.register Config::ArrayValue.new('server.list',
277 :default => ['irc://localhost'], :wizard => true,
278 :requires_restart => true,
279 :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.")
280 Config.register Config::BooleanValue.new('server.ssl',
281 :default => false, :requires_restart => true, :wizard => true,
282 :desc => "Use SSL to connect to this server?")
283 Config.register Config::StringValue.new('server.password',
284 :default => false, :requires_restart => true,
285 :desc => "Password for connecting to this server (if required)",
287 Config.register Config::StringValue.new('server.bindhost',
288 :default => false, :requires_restart => true,
289 :desc => "Specific local host or IP for the bot to bind to (if required)",
291 Config.register Config::IntegerValue.new('server.reconnect_wait',
292 :default => 5, :validate => Proc.new{|v| v >= 0},
293 :desc => "Seconds to wait before attempting to reconnect, on disconnect")
294 Config.register Config::IntegerValue.new('server.ping_timeout',
295 :default => 30, :validate => Proc.new{|v| v >= 0},
296 :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
297 Config.register Config::ArrayValue.new('server.nocolor_modes',
298 :default => ['c'], :wizard => false,
299 :requires_restart => false,
300 :desc => "List of channel modes that require messages to be without colors")
302 Config.register Config::StringValue.new('irc.nick', :default => "rbot",
303 :desc => "IRC nickname the bot should attempt to use", :wizard => true,
304 :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
305 Config.register Config::StringValue.new('irc.name',
306 :default => "Ruby bot", :requires_restart => true,
307 :desc => "IRC realname the bot should use")
308 Config.register Config::BooleanValue.new('irc.name_copyright',
309 :default => true, :requires_restart => true,
310 :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
311 Config.register Config::StringValue.new('irc.user', :default => "rbot",
312 :requires_restart => true,
313 :desc => "local user the bot should appear to be", :wizard => true)
314 Config.register Config::ArrayValue.new('irc.join_channels',
315 :default => [], :wizard => true,
316 :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'")
317 Config.register Config::ArrayValue.new('irc.ignore_users',
319 :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
320 Config.register Config::ArrayValue.new('irc.ignore_channels',
322 :desc => "Which channels to ignore input in. This is mainly to turn the bot into a logbot that doesn't interact with users in any way (in the specified channels)")
324 Config.register Config::IntegerValue.new('core.save_every',
325 :default => 60, :validate => Proc.new{|v| v >= 0},
326 :on_change => Proc.new { |bot, v|
329 @timer.reschedule(@save_timer, v)
330 @timer.unblock(@save_timer)
332 @timer.block(@save_timer)
336 @save_timer = @timer.add(v) { bot.save }
338 # Nothing to do when v == 0
341 :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
343 Config.register Config::BooleanValue.new('core.run_as_daemon',
344 :default => false, :requires_restart => true,
345 :desc => "Should the bot run as a daemon?")
347 Config.register Config::StringValue.new('log.file',
348 :default => false, :requires_restart => true,
349 :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
350 Config.register Config::IntegerValue.new('log.level',
351 :default => 1, :requires_restart => false,
352 :validate => Proc.new { |v| (0..5).include?(v) },
353 :on_change => Proc.new { |bot, v|
356 :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
357 Config.register Config::IntegerValue.new('log.keep',
358 :default => 1, :requires_restart => true,
359 :validate => Proc.new { |v| v >= 0 },
360 :desc => "How many old console messages logfiles to keep")
361 Config.register Config::IntegerValue.new('log.max_size',
362 :default => 10, :requires_restart => true,
363 :validate => Proc.new { |v| v > 0 },
364 :desc => "Maximum console messages logfile size (in megabytes)")
366 Config.register Config::ArrayValue.new('plugins.path',
367 :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
368 :requires_restart => false,
369 :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
370 :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")
372 Config.register Config::EnumValue.new('send.newlines',
373 :values => ['split', 'join'], :default => 'split',
374 :on_change => Proc.new { |bot, v|
375 bot.set_default_send_options :newlines => v.to_sym
377 :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")
378 Config.register Config::StringValue.new('send.join_with',
380 :on_change => Proc.new { |bot, v|
381 bot.set_default_send_options :join_with => v.dup
383 :desc => "String used to replace newlines when send.newlines is set to join")
384 Config.register Config::IntegerValue.new('send.max_lines',
386 :validate => Proc.new { |v| v >= 0 },
387 :on_change => Proc.new { |bot, v|
388 bot.set_default_send_options :max_lines => v
390 :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
391 Config.register Config::EnumValue.new('send.overlong',
392 :values => ['split', 'truncate'], :default => 'split',
393 :on_change => Proc.new { |bot, v|
394 bot.set_default_send_options :overlong => v.to_sym
396 :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")
397 Config.register Config::StringValue.new('send.split_at',
399 :on_change => Proc.new { |bot, v|
400 bot.set_default_send_options :split_at => Regexp.new(v)
402 :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
403 Config.register Config::BooleanValue.new('send.purge_split',
405 :on_change => Proc.new { |bot, v|
406 bot.set_default_send_options :purge_split => v
408 :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
409 Config.register Config::StringValue.new('send.truncate_text',
410 :default => "#{Reverse}...#{Reverse}",
411 :on_change => Proc.new { |bot, v|
412 bot.set_default_send_options :truncate_text => v.dup
414 :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")
415 Config.register Config::IntegerValue.new('send.penalty_pct',
417 :validate => Proc.new { |v| v >= 0 },
418 :on_change => Proc.new { |bot, v|
419 bot.socket.penalty_pct = v
421 :desc => "Percentage of IRC penalty to consider when sending messages to prevent being disconnected for excess flood. Set to 0 to disable penalty control.")
423 @argv = params[:argv]
424 @run_dir = params[:run_dir] || Dir.pwd
426 unless FileTest.directory? Config::coredir
427 error "core directory '#{Config::coredir}' not found, did you setup.rb?"
431 unless FileTest.directory? Config::datadir
432 error "data directory '#{Config::datadir}' not found, did you setup.rb?"
436 unless botclass and not botclass.empty?
437 # We want to find a sensible default.
438 # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
439 # * On Windows (at least the NT versions) we want to put our stuff in the
440 # Application Data folder.
441 # We don't use any particular O/S detection magic, exploiting the fact that
442 # Etc.getpwuid is nil on Windows
443 if Etc.getpwuid(Process::Sys.geteuid)
444 botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
446 if ENV.has_key?('APPDATA')
447 botclass = ENV['APPDATA'].dup
448 botclass.gsub!("\\","/")
451 botclass = File.join(botclass, ".rbot")
453 botclass = File.expand_path(botclass)
454 @botclass = botclass.gsub(/\/$/, "")
456 repopulate_botclass_directory
458 registry_dir = File.join(@botclass, 'registry')
459 Dir.mkdir(registry_dir) unless File.exist?(registry_dir)
460 unless FileTest.directory? registry_dir
461 error "registry storage location #{registry_dir} is not a directory"
464 save_dir = File.join(@botclass, 'safe_save')
465 Dir.mkdir(save_dir) unless File.exist?(save_dir)
466 unless FileTest.directory? save_dir
467 error "safe save location #{save_dir} is not a directory"
471 @startup_time = Time.new
474 @config = Config.manager
475 @config.bot_associate(self)
476 rescue Exception => e
482 if @config['core.run_as_daemon']
486 @logfile = @config['log.file']
487 if @logfile.class!=String || @logfile.empty?
488 logfname = File.basename(botclass).gsub(/^\.+/,'')
490 @logfile = File.join(botclass, logfname)
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'] || File.join(@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 @plugins = Plugins::manager
580 @plugins.bot_associate(self)
583 if @config['server.name']
584 debug "upgrading configuration (server.name => server.list)"
585 srv_uri = 'irc://' + @config['server.name']
586 srv_uri += ":#{@config['server.port']}" if @config['server.port']
587 @config.items['server.list'.to_sym].set_string(srv_uri)
588 @config.delete('server.name'.to_sym)
589 @config.delete('server.port'.to_sym)
590 debug "server.list is now #{@config['server.list'].inspect}"
593 @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], :ssl => @config['server.ssl'], :penalty_pct =>@config['send.penalty_pct'])
598 # Channels where we are quiet
599 # Array of channels names where the bot should be quiet
600 # '*' means all channels
603 # but we always speak here
606 # the nick we want, if it's different from the irc.nick config value
607 # (e.g. as set by a !nick command)
610 @client[:welcome] = proc {|data|
611 m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])
613 @plugins.delegate("welcome", m)
614 @plugins.delegate("connect")
617 # TODO the next two @client should go into rfc2812.rb, probably
618 # Since capabs are two-steps processes, server.supports[:capab]
619 # should be a three-state: nil, [], [....]
620 asked_for = { :"identify-msg" => false }
621 @client[:isupport] = proc { |data|
622 if server.supports[:capab] and !asked_for[:"identify-msg"]
623 sendq "CAPAB IDENTIFY-MSG"
624 asked_for[:"identify-msg"] = true
627 @client[:datastr] = proc { |data|
628 if data[:text] == "IDENTIFY-MSG"
629 server.capabilities[:"identify-msg"] = true
631 debug "Not handling RPL_DATASTR #{data[:servermessage]}"
635 @client[:privmsg] = proc { |data|
636 m = PrivMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
637 # debug "Message source is #{data[:source].inspect}"
638 # debug "Message target is #{data[:target].inspect}"
639 # debug "Bot is #{myself.inspect}"
641 @config['irc.ignore_channels'].each { |channel|
642 if m.target.downcase == channel.downcase
647 @config['irc.ignore_users'].each { |mask|
648 if m.source.matches?(server.new_netmask(mask))
654 @plugins.irc_delegate('privmsg', m)
656 @client[:notice] = proc { |data|
657 message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
658 # pass it off to plugins that want to hear everything
659 @plugins.irc_delegate "notice", message
661 @client[:motd] = proc { |data|
662 m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd])
663 @plugins.delegate "motd", m
665 @client[:nicktaken] = proc { |data|
666 new = "#{data[:nick]}_"
668 # If we're setting our nick at connection because our choice was taken,
669 # we have to fix our nick manually, because there will be no NICK message
670 # to inform us that our nick has been changed.
671 if data[:target] == '*'
672 debug "setting my connection nick to #{new}"
675 @plugins.delegate "nicktaken", data[:nick]
677 @client[:badnick] = proc {|data|
678 warning "bad nick (#{data[:nick]})"
680 @client[:ping] = proc {|data|
681 sendq "PONG #{data[:pingid]}"
683 @client[:pong] = proc {|data|
686 @client[:nick] = proc {|data|
687 # debug "Message source is #{data[:source].inspect}"
688 # debug "Bot is #{myself.inspect}"
689 source = data[:source]
692 m = NickMessage.new(self, server, source, old, new)
693 m.is_on = data[:is_on]
695 debug "my nick is now #{new}"
697 @plugins.irc_delegate("nick", m)
699 @client[:quit] = proc {|data|
700 source = data[:source]
701 message = data[:message]
702 m = QuitMessage.new(self, server, source, source, message)
703 m.was_on = data[:was_on]
704 @plugins.irc_delegate("quit", m)
706 @client[:mode] = proc {|data|
707 m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
708 m.modes = data[:modes]
709 @plugins.delegate "modechange", m
711 @client[:whois] = proc {|data|
712 source = data[:source]
713 target = server.get_user(data[:whois][:nick])
714 m = WhoisMessage.new(self, server, source, target, data[:whois])
715 @plugins.delegate "whois", m
717 @client[:join] = proc {|data|
718 m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
719 sendq("MODE #{data[:channel]}", nil, 0) if m.address?
720 @plugins.irc_delegate("join", m)
721 sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
723 @client[:part] = proc {|data|
724 m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
725 @plugins.irc_delegate("part", m)
727 @client[:kick] = proc {|data|
728 m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
729 @plugins.irc_delegate("kick", m)
731 @client[:invite] = proc {|data|
732 m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
733 @plugins.irc_delegate("invite", m)
735 @client[:changetopic] = proc {|data|
736 m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
738 @plugins.irc_delegate("topic", m)
740 # @client[:topic] = proc { |data|
741 # irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
743 @client[:topicinfo] = proc { |data|
744 channel = data[:channel]
745 topic = channel.topic
746 m = TopicMessage.new(self, server, data[:source], channel, topic)
747 m.info_or_set = :info
748 @plugins.irc_delegate("topic", m)
750 @client[:names] = proc { |data|
751 m = NamesMessage.new(self, server, server, data[:channel])
752 m.users = data[:users]
753 @plugins.delegate "names", m
755 @client[:error] = proc { |data|
756 raise ServerError, data[:message]
758 @client[:unknown] = proc { |data|
759 #debug "UNKNOWN: #{data[:serverstring]}"
760 m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
761 @plugins.delegate "unknown_message", m
764 set_default_send_options :newlines => @config['send.newlines'].to_sym,
765 :join_with => @config['send.join_with'].dup,
766 :max_lines => @config['send.max_lines'],
767 :overlong => @config['send.overlong'].to_sym,
768 :split_at => Regexp.new(@config['send.split_at']),
769 :purge_split => @config['send.purge_split'],
770 :truncate_text => @config['send.truncate_text'].dup
775 def repopulate_botclass_directory
776 template_dir = File.join Config::datadir, 'templates'
777 if FileTest.directory? @botclass
778 # compare the templates dir with the current botclass dir, filling up the
779 # latter with any missing file. Sadly, FileUtils.cp_r doesn't have an
780 # :update option, so we have to do it manually.
781 # Note that we use the */** pattern because we don't want to match
782 # keywords.rbot, which gets deleted on load and would therefore be missing
784 missing = Dir.chdir(template_dir) { Dir.glob('*/**') } - Dir.chdir(@botclass) { Dir.glob('*/**') }
786 dest = File.join(@botclass, f)
787 FileUtils.mkdir_p(File.dirname(dest))
788 FileUtils.cp File.join(template_dir, f), dest
791 log "no #{@botclass} directory found, creating from templates..."
792 if FileTest.exist? @botclass
793 error "file #{@botclass} exists but isn't a directory"
796 FileUtils.cp_r template_dir, @botclass
800 # Return a path under the current botclass by joining the mentioned
801 # components. The components are automatically converted to String
802 def path(*components)
803 File.join(@botclass, *(components.map {|c| c.to_s}))
806 def setup_plugins_path
807 plugdir_default = File.join(Config::datadir, 'plugins')
808 plugdir_local = File.join(@botclass, 'plugins')
809 Dir.mkdir(plugdir_local) unless File.exist?(plugdir_local)
811 @plugins.clear_botmodule_dirs
812 @plugins.add_core_module_dir(File.join(Config::coredir, 'utils'))
813 @plugins.add_core_module_dir(Config::coredir)
814 if FileTest.directory? plugdir_local
815 @plugins.add_plugin_dir(plugdir_local)
817 warning "local plugin location #{plugdir_local} is not a directory"
820 @config['plugins.path'].each do |_|
821 path = _.sub(/^\(default\)/, plugdir_default)
822 @plugins.add_plugin_dir(path)
826 def set_default_send_options(opts={})
827 # Default send options for NOTICE and PRIVMSG
828 unless defined? @default_send_options
829 @default_send_options = {
830 :queue_channel => nil, # use default queue channel
831 :queue_ring => nil, # use default queue ring
832 :newlines => :split, # or :join
833 :join_with => ' ', # by default, use a single space
834 :max_lines => 0, # maximum number of lines to send with a single command
835 :overlong => :split, # or :truncate
836 # TODO an array of splitpoints would be preferrable for this option:
837 :split_at => /\s+/, # by default, split overlong lines at whitespace
838 :purge_split => true, # should the split string be removed?
839 :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
842 @default_send_options.update opts unless opts.empty?
845 # checks if we should be quiet on a channel
846 def quiet_on?(channel)
847 ch = channel.downcase
848 return (@quiet.include?('*') && !@not_quiet.include?(ch)) || @quiet.include?(ch)
851 def set_quiet(channel = nil)
853 ch = channel.downcase.dup
854 @not_quiet.delete(ch)
863 def reset_quiet(channel = nil)
865 ch = channel.downcase.dup
874 # things to do when we receive a signal
875 def got_sig(sig, func=:quit)
876 debug "received #{sig}, queueing #{func}"
877 # this is not an interruption if we just need to reconnect
878 $interrupted += 1 unless func == :reconnect
879 self.send(func) unless @quit_mutex.locked?
880 debug "interrupted #{$interrupted} times"
891 trap("SIGINT") { got_sig("SIGINT") }
892 trap("SIGTERM") { got_sig("SIGTERM") }
893 trap("SIGHUP") { got_sig("SIGHUP", :restart) }
894 trap("SIGUSR1") { got_sig("SIGUSR1", :reconnect) }
895 rescue ArgumentError => e
896 debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
897 rescue Exception => e
898 debug "failed to trap signals: #{e.pretty_inspect}"
902 # connect the bot to IRC
904 # make sure we don't have any spurious ping checks running
905 # (and initialize the vars if this is the first time we connect)
908 quit if $interrupted > 0
912 raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
914 quit if $interrupted > 0
916 realname = @config['irc.name'].clone || 'Ruby bot'
917 realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
919 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
920 @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
921 quit if $interrupted > 0
922 myself.nick = @config['irc.nick']
923 myself.user = @config['irc.user']
926 # disconnect the bot from IRC, if connected, and then connect (again)
927 def reconnect(message=nil, too_fast=false)
928 # we will wait only if @last_rec was not nil, i.e. if we were connected or
929 # got disconnected by a network error
930 # if someone wants to manually call disconnect() _and_ reconnect(), they
931 # will have to take care of the waiting themselves
932 will_wait = !!@last_rec
934 if @socket.connected?
939 log "\n\nDisconnected\n\n"
941 quit if $interrupted > 0
943 log "\n\nWaiting to reconnect\n\n"
944 sleep @config['server.reconnect_wait']
945 sleep 10*@config['server.reconnect_wait'] if too_fast
951 # begin event handling loop
957 reconnect(quit_msg, too_fast)
958 quit if $interrupted > 0
959 while @socket.connected?
960 quit if $interrupted > 0
962 # Wait for messages and process them as they arrive. If nothing is
963 # received, we call the ping_server() method that will PING the
964 # server if appropriate, or raise a TimeoutError if no PONG has been
965 # received in the user-chosen timeout since the last PING sent.
967 break unless reply = @socket.gets
969 @client.process reply
975 # I despair of this. Some of my users get "connection reset by peer"
976 # exceptions that ARENT SocketError's. How am I supposed to handle
981 rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
982 error "network exception: #{e.pretty_inspect}"
984 rescue ServerError => e
985 # received an ERROR from the server
986 quit_msg = "server ERROR: " + e.message
987 too_fast = e.message.index("reconnect too fast")
989 rescue BDB::Fatal => e
990 fatal "fatal bdb error: #{e.pretty_inspect}"
992 # Why restart? DB problems are serious stuff ...
993 # restart("Oops, we seem to have registry problems ...")
996 rescue Exception => e
997 error "non-net exception: #{e.pretty_inspect}"
1000 fatal "unexpected exception: #{e.pretty_inspect}"
1007 # type:: message type
1008 # where:: message target
1009 # message:: message text
1010 # send message +message+ of type +type+ to target +where+
1011 # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
1012 # relevant say() or notice() methods. This one should be used for IRCd
1013 # extensions you want to use in modules.
1014 def sendmsg(original_type, original_where, original_message, options={})
1016 # filter message with sendmsg filters
1017 ds = DataStream.new original_message.to_s.dup,
1018 :type => original_type, :dest => original_where,
1019 :options => @default_send_options.merge(options)
1020 filters = filter_names(:sendmsg)
1021 filters.each do |fname|
1022 debug "filtering #{ds[:text]} with sendmsg filter #{fname}"
1023 ds.merge! filter(self.global_filter_name(fname, :sendmsg), ds)
1029 filtered = ds[:text]
1031 # For starters, set up appropriate queue channels and rings
1032 mchan = opts[:queue_channel]
1033 mring = opts[:queue_ring]
1050 multi_line = filtered.gsub(/[\r\n]+/, "\n")
1052 # if target is a channel with nocolor modes, strip colours
1053 if where.kind_of?(Channel) and where.mode.any?(*config['server.nocolor_modes'])
1054 multi_line.replace BasicUserMessage.strip_formatting(multi_line)
1057 messages = Array.new
1058 case opts[:newlines]
1060 messages << [multi_line.gsub("\n", opts[:join_with])]
1062 multi_line.each_line { |line|
1064 next unless(line.size > 0)
1068 raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
1071 # The IRC protocol requires that each raw message must be not longer
1072 # than 512 characters. From this length with have to subtract the EOL
1073 # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
1074 # that will be prepended by the server to all of our messages.
1076 # The maximum raw message length we can send is therefore 512 - 2 - 2
1077 # minus the length of our hostmask.
1079 max_len = 508 - myself.fullform.size
1081 # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
1082 # will have a + or - prepended
1083 if server.capabilities[:"identify-msg"]
1087 # When splitting the message, we'll be prefixing the following string:
1088 # (e.g. "PRIVMSG #rbot :")
1089 fixed = "#{type} #{where} :"
1091 # And this is what's left
1092 left = max_len - fixed.size
1094 truncate = opts[:truncate_text]
1095 truncate = @default_send_options[:truncate_text] if truncate.size > left
1096 truncate = "" if truncate.size > left
1098 all_lines = messages.map { |line|
1102 case opts[:overlong]
1105 sub_lines = Array.new
1107 sub_lines << msg.slice!(0, left)
1109 lastspace = sub_lines.last.rindex(opts[:split_at])
1111 msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
1112 msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
1114 end until msg.empty?
1117 line.slice(0, left - truncate.size) << truncate
1119 raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
1124 if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
1125 lines = all_lines[0...opts[:max_lines]]
1126 new_last = lines.last.slice(0, left - truncate.size) << truncate
1127 lines.last.replace(new_last)
1133 sendq "#{fixed}#{line}", chan, ring
1134 delegate_sent(type, where, line)
1138 # queue an arbitraty message for the server
1139 def sendq(message="", chan=nil, ring=0)
1141 @socket.queue(message, chan, ring)
1144 # send a notice message to channel/nick +where+
1145 def notice(where, message, options={})
1146 return if where.kind_of?(Channel) and quiet_on?(where)
1147 sendmsg "NOTICE", where, message, options
1150 # say something (PRIVMSG) to channel/nick +where+
1151 def say(where, message, options={})
1152 return if where.kind_of?(Channel) and quiet_on?(where)
1153 sendmsg "PRIVMSG", where, message, options
1156 def ctcp_notice(where, command, message, options={})
1157 return if where.kind_of?(Channel) and quiet_on?(where)
1158 sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
1161 def ctcp_say(where, command, message, options={})
1162 return if where.kind_of?(Channel) and quiet_on?(where)
1163 sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
1166 # perform a CTCP action with message +message+ to channel/nick +where+
1167 def action(where, message, options={})
1168 ctcp_say(where, 'ACTION', message, options)
1171 # quick way to say "okay" (or equivalent) to +where+
1173 say where, @lang.get("okay")
1176 # set topic of channel +where+ to +topic+
1177 # can also be used to retrieve the topic of channel +where+
1178 # by omitting the last argument
1179 def topic(where, topic=nil)
1181 sendq "TOPIC #{where}", where, 2
1183 sendq "TOPIC #{where} :#{topic}", where, 2
1187 def disconnect(message=nil)
1188 message = @lang.get("quit") if (!message || message.empty?)
1189 if @socket.connected?
1191 debug "Clearing socket"
1193 debug "Sending quit message"
1194 @socket.emergency_puts "QUIT :#{message}"
1195 debug "Logging quits"
1196 delegate_sent('QUIT', myself, message)
1197 debug "Flushing socket"
1199 rescue SocketError => e
1200 error "error while disconnecting socket: #{e.pretty_inspect}"
1202 debug "Shutting down socket"
1209 # disconnect from the server and cleanup all plugins and modules
1210 def shutdown(message=nil)
1211 @quit_mutex.synchronize do
1212 debug "Shutting down: #{message}"
1213 ## No we don't restore them ... let everything run through
1215 # trap("SIGINT", "DEFAULT")
1216 # trap("SIGTERM", "DEFAULT")
1217 # trap("SIGHUP", "DEFAULT")
1219 # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1221 debug "\tdisconnecting..."
1223 debug "\tstopping timer..."
1225 debug "\tsaving ..."
1227 debug "\tcleaning up ..."
1228 @save_mutex.synchronize do
1231 # debug "\tstopping timers ..."
1233 # debug "Closing registries"
1235 debug "\t\tcleaning up the db environment ..."
1237 log "rbot quit (#{message})"
1241 # message:: optional IRC quit message
1242 # quit IRC, shutdown the bot
1243 def quit(message=nil)
1251 # totally shutdown and respawn the bot
1252 def restart(message=nil)
1253 message = _("restarting, back in %{wait}...") % {
1254 :wait => @config['server.reconnect_wait']
1255 } if (!message || message.empty?)
1257 sleep @config['server.reconnect_wait']
1260 # Note, this fails on Windows
1261 debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1265 rescue Errno::ENOENT
1267 exec("ruby", *(@argv.unshift $0))
1268 rescue Exception => e
1274 # call the save method for all of the botmodules
1276 @save_mutex.synchronize do
1282 # call the rescan method for all of the botmodules
1284 debug "\tstopping timer..."
1286 @save_mutex.synchronize do
1293 # channel:: channel to join
1294 # key:: optional channel key if channel is +s
1296 def join(channel, key=nil)
1298 sendq "JOIN #{channel} :#{key}", channel, 2
1300 sendq "JOIN #{channel}", channel, 2
1305 def part(channel, message="")
1306 sendq "PART #{channel} :#{message}", channel, 2
1309 # attempt to change bot's nick to +name+
1311 sendq "NICK #{name}"
1315 def mode(channel, mode, target=nil)
1316 sendq "MODE #{channel} #{mode} #{target}", channel, 2
1320 def whois(nick, target=nil)
1321 sendq "WHOIS #{target} #{nick}", nil, 0
1325 def kick(channel, user, msg)
1326 sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1329 # m:: message asking for help
1330 # topic:: optional topic help is requested for
1331 # respond to online help requests
1333 topic = nil if topic == ""
1336 helpstr = _("help topics: ")
1337 helpstr += @plugins.helptopics
1338 helpstr += _(" (help <topic> for more info)")
1340 unless(helpstr = @plugins.help(topic))
1341 helpstr = _("no help for topic %{topic}") % { :topic => topic }
1347 # returns a string describing the current status of the bot (uptime etc)
1349 secs_up = Time.new - @startup_time
1350 uptime = Utils.secs_to_string secs_up
1351 # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1352 return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
1354 :up => uptime, :plug => @plugins.length,
1355 :sent => @socket.lines_sent, :recv => @socket.lines_received
1359 # We want to respond to a hung server in a timely manner. If nothing was received
1360 # in the user-selected timeout and we haven't PINGed the server yet, we PING
1361 # the server. If the PONG is not received within the user-defined timeout, we
1362 # assume we're in ping timeout and act accordingly.
1364 act_timeout = @config['server.ping_timeout']
1365 return if act_timeout <= 0
1367 if @last_rec && now > @last_rec + act_timeout
1369 # No previous PING pending, send a new one
1371 @last_ping = Time.now
1373 diff = now - @last_ping
1374 if diff > act_timeout
1375 debug "no PONG from server in #{diff} seconds, reconnecting"
1376 # the actual reconnect is handled in the main loop:
1377 raise TimeoutError, "no PONG from server in #{diff} seconds"
1383 def stop_server_pings
1384 # cancel previous PINGs and reset time of last RECV
1391 # delegate sent messages
1392 def delegate_sent(type, where, message)
1393 args = [self, server, myself, server.user_or_channel(where.to_s), message]
1396 m = NoticeMessage.new(*args)
1398 m = PrivMessage.new(*args)
1400 m = QuitMessage.new(*args)
1401 m.was_on = myself.channels
1403 @plugins.delegate('sent', m)