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 def rawlog(level, message=nil, who_pos=1)
46 if call_stack.length > who_pos
47 who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
51 # Output each line. To distinguish between separate messages and multi-line
52 # messages originating at the same time, we blank #{who} after the first message
54 # Also, we output strings as-is but for other objects we use pretty_inspect
59 str = message.pretty_inspect
63 qmsg.push [level, l.chomp, who]
70 if $log_thread && $log_thread.alive?
79 def restart_logger(newlogger = false)
82 $logger = newlogger if newlogger
84 $log_thread = Thread.new do
86 while ls = $log_queue.pop
87 ls.each { |l| $logger.add(*l) }
95 $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
100 $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
104 def debug(message=nil, who_pos=1)
105 rawlog(Logger::Severity::DEBUG, message, who_pos)
108 def log(message=nil, who_pos=1)
109 rawlog(Logger::Severity::INFO, message, who_pos)
112 def warning(message=nil, who_pos=1)
113 rawlog(Logger::Severity::WARN, message, who_pos)
116 def error(message=nil, who_pos=1)
117 rawlog(Logger::Severity::ERROR, message, who_pos)
120 def fatal(message=nil, who_pos=1)
121 rawlog(Logger::Severity::FATAL, message, who_pos)
126 warning "warning test"
130 # The following global is used for the improved signal handling.
134 require 'rbot/rbotconfig'
135 require 'rbot/load-gettext'
136 require 'rbot/config'
137 require 'rbot/config-compat'
140 require 'rbot/rfc2812'
141 require 'rbot/ircsocket'
142 require 'rbot/botuser'
144 require 'rbot/plugins'
145 require 'rbot/message'
146 require 'rbot/language'
147 require 'rbot/dbhash'
148 require 'rbot/registry'
152 # Main bot class, which manages the various components, receives messages,
153 # handles them or passes them to plugins, and contains core functionality.
155 COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
156 SOURCE_URL = "http://ruby-rbot.org"
157 # the bot's Auth data
160 # the bot's Config data
163 # the botclass for this bot (determines configdir among other things)
164 attr_reader :botclass
166 # used to perform actions periodically (saves configuration once per minute
170 # synchronize with this mutex while touching permanent data files:
171 # saving, flushing, cleaning up ...
172 attr_reader :save_mutex
174 # bot's Language data
181 # bot's object registry, plugins get an interface to this for persistant
182 # storage (hash interface tied to a bdb file, plugins use Accessors to store
183 # and restore objects in their own namespaces.)
184 attr_reader :registry
186 # bot's plugins. This is an instance of class Plugins
189 # bot's httputil help object, for fetching resources via http. Sets up
190 # proxies etc as defined by the bot configuration/environment
191 attr_accessor :httputil
193 # server we are connected to
199 # bot User in the client/server connection
205 # bot User in the client/server connection
213 ret = self.to_s[0..-2]
214 ret << ' version=' << $version.inspect
215 ret << ' botclass=' << botclass.inspect
216 ret << ' lang="' << lang.language
221 ret << ' nick=' << nick.inspect
224 ret << (server.to_s + (socket ?
225 ' [' << socket.server_uri.to_s << ']' : '')).inspect
226 unless server.channels.empty?
228 ret << server.channels.map { |c|
229 "%s%s" % [c.modes_of(nick).map { |m|
230 server.prefix_for_mode(m)
237 ret << ' plugins=' << plugins.inspect
242 # create a new Bot with botclass +botclass+
243 def initialize(botclass, params = {})
244 # Config for the core bot
245 # TODO should we split socket stuff into ircsocket, etc?
246 Config.register Config::ArrayValue.new('server.list',
247 :default => ['irc://localhost'], :wizard => true,
248 :requires_restart => true,
249 :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.")
250 Config.register Config::BooleanValue.new('server.ssl',
251 :default => false, :requires_restart => true, :wizard => true,
252 :desc => "Use SSL to connect to this server?")
253 Config.register Config::StringValue.new('server.password',
254 :default => false, :requires_restart => true,
255 :desc => "Password for connecting to this server (if required)",
257 Config.register Config::StringValue.new('server.bindhost',
258 :default => false, :requires_restart => true,
259 :desc => "Specific local host or IP for the bot to bind to (if required)",
261 Config.register Config::IntegerValue.new('server.reconnect_wait',
262 :default => 5, :validate => Proc.new{|v| v >= 0},
263 :desc => "Seconds to wait before attempting to reconnect, on disconnect")
264 Config.register Config::FloatValue.new('server.sendq_delay',
265 :default => 2.0, :validate => Proc.new{|v| v >= 0},
266 :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
267 :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
268 Config.register Config::IntegerValue.new('server.sendq_burst',
269 :default => 4, :validate => Proc.new{|v| v >= 0},
270 :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines",
271 :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
272 Config.register Config::IntegerValue.new('server.ping_timeout',
273 :default => 30, :validate => Proc.new{|v| v >= 0},
274 :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
276 Config.register Config::StringValue.new('irc.nick', :default => "rbot",
277 :desc => "IRC nickname the bot should attempt to use", :wizard => true,
278 :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
279 Config.register Config::StringValue.new('irc.name',
280 :default => "Ruby bot", :requires_restart => true,
281 :desc => "IRC realname the bot should use")
282 Config.register Config::BooleanValue.new('irc.name_copyright',
283 :default => true, :requires_restart => true,
284 :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
285 Config.register Config::StringValue.new('irc.user', :default => "rbot",
286 :requires_restart => true,
287 :desc => "local user the bot should appear to be", :wizard => true)
288 Config.register Config::ArrayValue.new('irc.join_channels',
289 :default => [], :wizard => true,
290 :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'")
291 Config.register Config::ArrayValue.new('irc.ignore_users',
293 :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
295 Config.register Config::IntegerValue.new('core.save_every',
296 :default => 60, :validate => Proc.new{|v| v >= 0},
297 :on_change => Proc.new { |bot, v|
300 @timer.reschedule(@save_timer, v)
301 @timer.unblock(@save_timer)
303 @timer.block(@save_timer)
307 @save_timer = @timer.add(v) { bot.save }
309 # Nothing to do when v == 0
312 :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
314 Config.register Config::BooleanValue.new('core.run_as_daemon',
315 :default => false, :requires_restart => true,
316 :desc => "Should the bot run as a daemon?")
318 Config.register Config::StringValue.new('log.file',
319 :default => false, :requires_restart => true,
320 :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
321 Config.register Config::IntegerValue.new('log.level',
322 :default => 1, :requires_restart => false,
323 :validate => Proc.new { |v| (0..5).include?(v) },
324 :on_change => Proc.new { |bot, v|
327 :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
328 Config.register Config::IntegerValue.new('log.keep',
329 :default => 1, :requires_restart => true,
330 :validate => Proc.new { |v| v >= 0 },
331 :desc => "How many old console messages logfiles to keep")
332 Config.register Config::IntegerValue.new('log.max_size',
333 :default => 10, :requires_restart => true,
334 :validate => Proc.new { |v| v > 0 },
335 :desc => "Maximum console messages logfile size (in megabytes)")
337 Config.register Config::ArrayValue.new('plugins.path',
338 :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
339 :requires_restart => false,
340 :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
341 :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")
343 Config.register Config::EnumValue.new('send.newlines',
344 :values => ['split', 'join'], :default => 'split',
345 :on_change => Proc.new { |bot, v|
346 bot.set_default_send_options :newlines => v.to_sym
348 :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")
349 Config.register Config::StringValue.new('send.join_with',
351 :on_change => Proc.new { |bot, v|
352 bot.set_default_send_options :join_with => v.dup
354 :desc => "String used to replace newlines when send.newlines is set to join")
355 Config.register Config::IntegerValue.new('send.max_lines',
357 :validate => Proc.new { |v| v >= 0 },
358 :on_change => Proc.new { |bot, v|
359 bot.set_default_send_options :max_lines => v
361 :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
362 Config.register Config::EnumValue.new('send.overlong',
363 :values => ['split', 'truncate'], :default => 'split',
364 :on_change => Proc.new { |bot, v|
365 bot.set_default_send_options :overlong => v.to_sym
367 :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")
368 Config.register Config::StringValue.new('send.split_at',
370 :on_change => Proc.new { |bot, v|
371 bot.set_default_send_options :split_at => Regexp.new(v)
373 :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
374 Config.register Config::BooleanValue.new('send.purge_split',
376 :on_change => Proc.new { |bot, v|
377 bot.set_default_send_options :purge_split => v
379 :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
380 Config.register Config::StringValue.new('send.truncate_text',
381 :default => "#{Reverse}...#{Reverse}",
382 :on_change => Proc.new { |bot, v|
383 bot.set_default_send_options :truncate_text => v.dup
385 :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")
387 @argv = params[:argv]
388 @run_dir = params[:run_dir] || Dir.pwd
390 unless FileTest.directory? Config::coredir
391 error "core directory '#{Config::coredir}' not found, did you setup.rb?"
395 unless FileTest.directory? Config::datadir
396 error "data directory '#{Config::datadir}' not found, did you setup.rb?"
400 unless botclass and not botclass.empty?
401 # We want to find a sensible default.
402 # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
403 # * On Windows (at least the NT versions) we want to put our stuff in the
404 # Application Data folder.
405 # We don't use any particular O/S detection magic, exploiting the fact that
406 # Etc.getpwuid is nil on Windows
407 if Etc.getpwuid(Process::Sys.geteuid)
408 botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
410 if ENV.has_key?('APPDATA')
411 botclass = ENV['APPDATA'].dup
412 botclass.gsub!("\\","/")
417 botclass = File.expand_path(botclass)
418 @botclass = botclass.gsub(/\/$/, "")
420 if FileTest.directory? botclass
421 # compare the templates dir with the current botclass, and fill it in with
423 # Sadly, FileUtils.cp_r doesn't have an :update option, so we have to do it
425 template = File.join Config::datadir, 'templates'
426 # note that we use the */** pattern because we don't want to match
427 # keywords.rbot, which gets deleted on load and would therefore be missing always
428 missing = Dir.chdir(template) { Dir.glob('*/**') } - Dir.chdir(botclass) { Dir.glob('*/**') }
430 FileUtils.cp File.join(template, f), File.join(botclass, f)
433 log "no #{botclass} directory found, creating from templates.."
434 if FileTest.exist? botclass
435 error "file #{botclass} exists but isn't a directory"
438 FileUtils.cp_r Config::datadir+'/templates', botclass
441 Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
442 Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
444 # Time at which the last PING was sent
446 # Time at which the last line was RECV'd from the server
449 @startup_time = Time.new
452 @config = Config.manager
453 @config.bot_associate(self)
454 rescue Exception => e
460 if @config['core.run_as_daemon']
464 @logfile = @config['log.file']
465 if @logfile.class!=String || @logfile.empty?
466 @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
467 debug "Using `#{@logfile}' as debug log"
470 # See http://blog.humlab.umu.se/samuel/archives/000107.html
471 # for the backgrounding code
477 rescue NotImplementedError
478 warning "Could not background, fork not supported"
481 rescue Exception => e
482 warning "Could not background. #{e.pretty_inspect}"
485 # File.umask 0000 # Ensure sensible umask. Adjust as needed.
488 logger = Logger.new(@logfile,
490 @config['log.max_size']*1024*1024)
491 logger.datetime_format= $dateformat
492 logger.level = @config['log.level']
493 logger.level = $cl_loglevel if defined? $cl_loglevel
494 logger.level = 0 if $debug
496 restart_logger(logger)
501 log "Redirecting standard input/output/error"
502 [$stdin, $stdout, $stderr].each do |fd|
504 fd.reopen "/dev/null"
506 # On Windows, there's not such thing as /dev/null
511 def $stdout.write(str=nil)
515 def $stdout.write(str=nil)
516 if str.to_s.match(/:\d+: warning:/)
525 File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
529 @registry = Registry.new self
532 @save_mutex = Mutex.new
533 if @config['core.save_every'] > 0
534 @save_timer = @timer.add(@config['core.save_every']) { save }
538 @quit_mutex = Mutex.new
541 @lang = Language.new(self, @config['core.language'])
544 @auth = Auth::manager
545 @auth.bot_associate(self)
546 # @auth.load("#{botclass}/botusers.yaml")
547 rescue Exception => e
552 @auth.everyone.set_default_permission("*", true)
553 @auth.botowner.password= @config['auth.password']
555 Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
556 @plugins = Plugins::manager
557 @plugins.bot_associate(self)
560 if @config['server.name']
561 debug "upgrading configuration (server.name => server.list)"
562 srv_uri = 'irc://' + @config['server.name']
563 srv_uri += ":#{@config['server.port']}" if @config['server.port']
564 @config.items['server.list'.to_sym].set_string(srv_uri)
565 @config.delete('server.name'.to_sym)
566 @config.delete('server.port'.to_sym)
567 debug "server.list is now #{@config['server.list'].inspect}"
570 @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
575 # Channels where we are quiet
576 # Array of channels names where the bot should be quiet
577 # '*' means all channels
581 @client[:welcome] = proc {|data|
582 m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])
584 @plugins.delegate("welcome", m)
585 @plugins.delegate("connect")
587 @config['irc.join_channels'].each { |c|
588 debug "autojoining channel #{c}"
589 if(c =~ /^(\S+)\s+(\S+)$/i)
597 # TODO the next two @client should go into rfc2812.rb, probably
598 # Since capabs are two-steps processes, server.supports[:capab]
599 # should be a three-state: nil, [], [....]
600 asked_for = { :"identify-msg" => false }
601 @client[:isupport] = proc { |data|
602 if server.supports[:capab] and !asked_for[:"identify-msg"]
603 sendq "CAPAB IDENTIFY-MSG"
604 asked_for[:"identify-msg"] = true
607 @client[:datastr] = proc { |data|
608 if data[:text] == "IDENTIFY-MSG"
609 server.capabilities[:"identify-msg"] = true
611 debug "Not handling RPL_DATASTR #{data[:servermessage]}"
615 @client[:privmsg] = proc { |data|
616 m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
617 # debug "Message source is #{data[:source].inspect}"
618 # debug "Message target is #{data[:target].inspect}"
619 # debug "Bot is #{myself.inspect}"
621 @config['irc.ignore_users'].each { |mask|
622 if m.source.matches?(server.new_netmask(mask))
627 @plugins.irc_delegate('privmsg', m)
629 @client[:notice] = proc { |data|
630 message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
631 # pass it off to plugins that want to hear everything
632 @plugins.irc_delegate "notice", message
634 @client[:motd] = proc { |data|
635 m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd])
636 @plugins.delegate "motd", m
638 @client[:nicktaken] = proc { |data|
639 new = "#{data[:nick]}_"
641 # If we're setting our nick at connection because our choice was taken,
642 # we have to fix our nick manually, because there will be no NICK message
643 # to inform us that our nick has been changed.
644 if data[:target] == '*'
645 debug "setting my connection nick to #{new}"
648 @plugins.delegate "nicktaken", data[:nick]
650 @client[:badnick] = proc {|data|
651 warning "bad nick (#{data[:nick]})"
653 @client[:ping] = proc {|data|
654 sendq "PONG #{data[:pingid]}"
656 @client[:pong] = proc {|data|
659 @client[:nick] = proc {|data|
660 # debug "Message source is #{data[:source].inspect}"
661 # debug "Bot is #{myself.inspect}"
662 source = data[:source]
665 m = NickMessage.new(self, server, source, old, new)
666 m.is_on = data[:is_on]
668 debug "my nick is now #{new}"
670 @plugins.irc_delegate("nick", m)
672 @client[:quit] = proc {|data|
673 source = data[:source]
674 message = data[:message]
675 m = QuitMessage.new(self, server, source, source, message)
676 m.was_on = data[:was_on]
677 @plugins.irc_delegate("quit", m)
679 @client[:mode] = proc {|data|
680 m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
681 m.modes = data[:modes]
682 @plugins.delegate "modechange", m
684 @client[:join] = proc {|data|
685 m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
686 sendq("MODE #{data[:channel]}", nil, 0) if m.address?
687 @plugins.irc_delegate("join", m)
688 sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
690 @client[:part] = proc {|data|
691 m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
692 @plugins.irc_delegate("part", m)
694 @client[:kick] = proc {|data|
695 m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
696 @plugins.irc_delegate("kick", m)
698 @client[:invite] = proc {|data|
699 m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
700 @plugins.irc_delegate("invite", m)
702 @client[:changetopic] = proc {|data|
703 m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
705 @plugins.irc_delegate("topic", m)
707 # @client[:topic] = proc { |data|
708 # irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
710 @client[:topicinfo] = proc { |data|
711 channel = data[:channel]
712 topic = channel.topic
713 m = TopicMessage.new(self, server, data[:source], channel, topic)
714 m.info_or_set = :info
715 @plugins.irc_delegate("topic", m)
717 @client[:names] = proc { |data|
718 m = NamesMessage.new(self, server, server, data[:channel])
719 m.users = data[:users]
720 @plugins.delegate "names", m
722 @client[:unknown] = proc { |data|
723 #debug "UNKNOWN: #{data[:serverstring]}"
724 m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
725 @plugins.delegate "unknown_message", m
728 set_default_send_options :newlines => @config['send.newlines'].to_sym,
729 :join_with => @config['send.join_with'].dup,
730 :max_lines => @config['send.max_lines'],
731 :overlong => @config['send.overlong'].to_sym,
732 :split_at => Regexp.new(@config['send.split_at']),
733 :purge_split => @config['send.purge_split'],
734 :truncate_text => @config['send.truncate_text'].dup
739 def setup_plugins_path
740 @plugins.clear_botmodule_dirs
741 @plugins.add_botmodule_dir(Config::coredir + "/utils")
742 @plugins.add_botmodule_dir(Config::coredir)
743 @plugins.add_botmodule_dir("#{botclass}/plugins")
745 @config['plugins.path'].each do |_|
746 path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
747 @plugins.add_botmodule_dir(path)
751 def set_default_send_options(opts={})
752 # Default send options for NOTICE and PRIVMSG
753 unless defined? @default_send_options
754 @default_send_options = {
755 :queue_channel => nil, # use default queue channel
756 :queue_ring => nil, # use default queue ring
757 :newlines => :split, # or :join
758 :join_with => ' ', # by default, use a single space
759 :max_lines => 0, # maximum number of lines to send with a single command
760 :overlong => :split, # or :truncate
761 # TODO an array of splitpoints would be preferrable for this option:
762 :split_at => /\s+/, # by default, split overlong lines at whitespace
763 :purge_split => true, # should the split string be removed?
764 :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
767 @default_send_options.update opts unless opts.empty?
770 # checks if we should be quiet on a channel
771 def quiet_on?(channel)
772 return @quiet.include?('*') || @quiet.include?(channel.downcase)
775 def set_quiet(channel = nil)
777 ch = channel.downcase.dup
785 def reset_quiet(channel = nil)
787 @quiet.delete channel.downcase
793 # things to do when we receive a signal
794 def got_sig(sig, func=:quit)
795 debug "received #{sig}, queueing #{func}"
797 self.send(func) unless @quit_mutex.locked?
798 debug "interrupted #{$interrupted} times"
809 trap("SIGINT") { got_sig("SIGINT") }
810 trap("SIGTERM") { got_sig("SIGTERM") }
811 trap("SIGHUP") { got_sig("SIGHUP", :restart) }
812 rescue ArgumentError => e
813 debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
814 rescue Exception => e
815 debug "failed to trap signals: #{e.pretty_inspect}"
819 # connect the bot to IRC
822 quit if $interrupted > 0
825 raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
827 quit if $interrupted > 0
829 realname = @config['irc.name'].clone || 'Ruby bot'
830 realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
832 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
833 @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
834 quit if $interrupted > 0
835 myself.nick = @config['irc.nick']
836 myself.user = @config['irc.user']
839 # begin event handling loop
843 quit if $interrupted > 0
847 while @socket.connected?
848 quit if $interrupted > 0
850 # Wait for messages and process them as they arrive. If nothing is
851 # received, we call the ping_server() method that will PING the
852 # server if appropriate, or raise a TimeoutError if no PONG has been
853 # received in the user-chosen timeout since the last PING sent.
855 break unless reply = @socket.gets
857 @client.process reply
863 # I despair of this. Some of my users get "connection reset by peer"
864 # exceptions that ARENT SocketError's. How am I supposed to handle
869 rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
870 error "network exception: #{e.pretty_inspect}"
872 rescue BDB::Fatal => e
873 fatal "fatal bdb error: #{e.pretty_inspect}"
875 # Why restart? DB problems are serious stuff ...
876 # restart("Oops, we seem to have registry problems ...")
879 rescue Exception => e
880 error "non-net exception: #{e.pretty_inspect}"
883 fatal "unexpected exception: #{e.pretty_inspect}"
890 log "\n\nDisconnected\n\n"
892 quit if $interrupted > 0
894 log "\n\nWaiting to reconnect\n\n"
895 sleep @config['server.reconnect_wait']
899 # type:: message type
900 # where:: message target
901 # message:: message text
902 # send message +message+ of type +type+ to target +where+
903 # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
904 # relevant say() or notice() methods. This one should be used for IRCd
905 # extensions you want to use in modules.
906 def sendmsg(type, where, original_message, options={})
907 opts = @default_send_options.merge(options)
909 # For starters, set up appropriate queue channels and rings
910 mchan = opts[:queue_channel]
911 mring = opts[:queue_ring]
928 multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
930 # if target is a channel with +c or +C modes, strip colours
931 if where.kind_of?(Channel) and where.mode.any?('c', 'C')
932 multi_line.replace BasicUserMessage.strip_formatting(multi_line)
938 messages << [multi_line.gsub("\n", opts[:join_with])]
940 multi_line.each_line { |line|
942 next unless(line.size > 0)
946 raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
949 # The IRC protocol requires that each raw message must be not longer
950 # than 512 characters. From this length with have to subtract the EOL
951 # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
952 # that will be prepended by the server to all of our messages.
954 # The maximum raw message length we can send is therefore 512 - 2 - 2
955 # minus the length of our hostmask.
957 max_len = 508 - myself.fullform.size
959 # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
960 # will have a + or - prepended
961 if server.capabilities[:"identify-msg"]
965 # When splitting the message, we'll be prefixing the following string:
966 # (e.g. "PRIVMSG #rbot :")
967 fixed = "#{type} #{where} :"
969 # And this is what's left
970 left = max_len - fixed.size
972 truncate = opts[:truncate_text]
973 truncate = @default_send_options[:truncate_text] if truncate.size > left
974 truncate = "" if truncate.size > left
976 all_lines = messages.map { |line|
983 sub_lines = Array.new
985 sub_lines << msg.slice!(0, left)
987 lastspace = sub_lines.last.rindex(opts[:split_at])
989 msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
990 msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
995 line.slice(0, left - truncate.size) << truncate
997 raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
1002 if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
1003 lines = all_lines[0...opts[:max_lines]]
1004 new_last = lines.last.slice(0, left - truncate.size) << truncate
1005 lines.last.replace(new_last)
1011 sendq "#{fixed}#{line}", chan, ring
1012 delegate_sent(type, where, line)
1016 # queue an arbitraty message for the server
1017 def sendq(message="", chan=nil, ring=0)
1019 @socket.queue(message, chan, ring)
1022 # send a notice message to channel/nick +where+
1023 def notice(where, message, options={})
1024 return if where.kind_of?(Channel) and quiet_on?(where)
1025 sendmsg "NOTICE", where, message, options
1028 # say something (PRIVMSG) to channel/nick +where+
1029 def say(where, message, options={})
1030 return if where.kind_of?(Channel) and quiet_on?(where)
1031 sendmsg "PRIVMSG", where, message, options
1034 def ctcp_notice(where, command, message, options={})
1035 return if where.kind_of?(Channel) and quiet_on?(where)
1036 sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
1039 def ctcp_say(where, command, message, options={})
1040 return if where.kind_of?(Channel) and quiet_on?(where)
1041 sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
1044 # perform a CTCP action with message +message+ to channel/nick +where+
1045 def action(where, message, options={})
1046 ctcp_say(where, 'ACTION', message, options)
1049 # quick way to say "okay" (or equivalent) to +where+
1051 say where, @lang.get("okay")
1054 # set topic of channel +where+ to +topic+
1055 def topic(where, topic)
1056 sendq "TOPIC #{where} :#{topic}", where, 2
1059 def disconnect(message=nil)
1060 message = @lang.get("quit") if (!message || message.empty?)
1061 if @socket.connected?
1063 debug "Clearing socket"
1065 debug "Sending quit message"
1066 @socket.emergency_puts "QUIT :#{message}"
1067 debug "Logging quits"
1068 delegate_sent('QUIT', myself, message)
1069 debug "Flushing socket"
1071 rescue SocketError => e
1072 error "error while disconnecting socket: #{e.pretty_inspect}"
1074 debug "Shutting down socket"
1081 # disconnect from the server and cleanup all plugins and modules
1082 def shutdown(message=nil)
1083 @quit_mutex.synchronize do
1084 debug "Shutting down: #{message}"
1085 ## No we don't restore them ... let everything run through
1087 # trap("SIGINT", "DEFAULT")
1088 # trap("SIGTERM", "DEFAULT")
1089 # trap("SIGHUP", "DEFAULT")
1091 # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1093 debug "\tdisconnecting..."
1095 debug "\tstopping timer..."
1097 debug "\tsaving ..."
1099 debug "\tcleaning up ..."
1100 @save_mutex.synchronize do
1103 # debug "\tstopping timers ..."
1105 # debug "Closing registries"
1107 debug "\t\tcleaning up the db environment ..."
1109 log "rbot quit (#{message})"
1113 # message:: optional IRC quit message
1114 # quit IRC, shutdown the bot
1115 def quit(message=nil)
1123 # totally shutdown and respawn the bot
1124 def restart(message=nil)
1125 message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
1127 sleep @config['server.reconnect_wait']
1130 # Note, this fails on Windows
1131 debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1135 rescue Errno::ENOENT
1137 exec("ruby", *(@argv.unshift $0))
1138 rescue Exception => e
1144 # call the save method for all of the botmodules
1146 @save_mutex.synchronize do
1152 # call the rescan method for all of the botmodules
1154 debug "\tstopping timer..."
1156 @save_mutex.synchronize do
1163 # channel:: channel to join
1164 # key:: optional channel key if channel is +s
1166 def join(channel, key=nil)
1168 sendq "JOIN #{channel} :#{key}", channel, 2
1170 sendq "JOIN #{channel}", channel, 2
1175 def part(channel, message="")
1176 sendq "PART #{channel} :#{message}", channel, 2
1179 # attempt to change bot's nick to +name+
1181 sendq "NICK #{name}"
1185 def mode(channel, mode, target)
1186 sendq "MODE #{channel} #{mode} #{target}", channel, 2
1190 def kick(channel, user, msg)
1191 sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1194 # m:: message asking for help
1195 # topic:: optional topic help is requested for
1196 # respond to online help requests
1198 topic = nil if topic == ""
1201 helpstr = _("help topics: ")
1202 helpstr += @plugins.helptopics
1203 helpstr += _(" (help <topic> for more info)")
1205 unless(helpstr = @plugins.help(topic))
1206 helpstr = _("no help for topic %{topic}") % { :topic => topic }
1212 # returns a string describing the current status of the bot (uptime etc)
1214 secs_up = Time.new - @startup_time
1215 uptime = Utils.secs_to_string secs_up
1216 # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1217 return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
1219 :up => uptime, :plug => @plugins.length,
1220 :sent => @socket.lines_sent, :recv => @socket.lines_received
1224 # We want to respond to a hung server in a timely manner. If nothing was received
1225 # in the user-selected timeout and we haven't PINGed the server yet, we PING
1226 # the server. If the PONG is not received within the user-defined timeout, we
1227 # assume we're in ping timeout and act accordingly.
1229 act_timeout = @config['server.ping_timeout']
1230 return if act_timeout <= 0
1232 if @last_rec && now > @last_rec + act_timeout
1234 # No previous PING pending, send a new one
1236 @last_ping = Time.now
1238 diff = now - @last_ping
1239 if diff > act_timeout
1240 debug "no PONG from server in #{diff} seconds, reconnecting"
1241 # the actual reconnect is handled in the main loop:
1242 raise TimeoutError, "no PONG from server in #{diff} seconds"
1248 def stop_server_pings
1249 # cancel previous PINGs and reset time of last RECV
1256 # delegate sent messages
1257 def delegate_sent(type, where, message)
1258 args = [self, server, myself, server.user_or_channel(where.to_s), message]
1261 m = NoticeMessage.new(*args)
1263 m = PrivMessage.new(*args)
1265 m = QuitMessage.new(*args)
1267 @plugins.delegate('sent', m)