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
23 unless Kernel.instance_methods.include?("pretty_inspect")
27 public :pretty_inspect
32 q.group(1, "#<%s: %s" % [self.class, self.message], ">") {
33 if self.backtrace and not self.backtrace.empty?
35 q.seplist(self.backtrace, lambda { q.text "\n" } ) { |l| q.text l }
41 def rawlog(level, message=nil, who_pos=1)
43 if call_stack.length > who_pos
44 who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
48 # Output each line. To distinguish between separate messages and multi-line
49 # messages originating at the same time, we blank #{who} after the first message
51 # Also, we output strings as-is but for other objects we use pretty_inspect
56 str = message.pretty_inspect
59 $logger.add(level, l.chomp, who)
65 $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
69 $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
72 def debug(message=nil, who_pos=1)
73 rawlog(Logger::Severity::DEBUG, message, who_pos)
76 def log(message=nil, who_pos=1)
77 rawlog(Logger::Severity::INFO, message, who_pos)
80 def warning(message=nil, who_pos=1)
81 rawlog(Logger::Severity::WARN, message, who_pos)
84 def error(message=nil, who_pos=1)
85 rawlog(Logger::Severity::ERROR, message, who_pos)
88 def fatal(message=nil, who_pos=1)
89 rawlog(Logger::Severity::FATAL, message, who_pos)
94 warning "warning test"
98 # The following global is used for the improved signal handling.
102 require 'rbot/rbotconfig'
103 require 'rbot/load-gettext'
104 require 'rbot/config'
105 require 'rbot/config-compat'
108 require 'rbot/rfc2812'
109 require 'rbot/ircsocket'
110 require 'rbot/botuser'
112 require 'rbot/plugins'
113 require 'rbot/message'
114 require 'rbot/language'
115 require 'rbot/dbhash'
116 require 'rbot/registry'
120 # Main bot class, which manages the various components, receives messages,
121 # handles them or passes them to plugins, and contains core functionality.
123 COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
124 SOURCE_URL = "http://ruby-rbot.org"
125 # the bot's Auth data
128 # the bot's Config data
131 # the botclass for this bot (determines configdir among other things)
132 attr_reader :botclass
134 # used to perform actions periodically (saves configuration once per minute
138 # synchronize with this mutex while touching permanent data files:
139 # saving, flushing, cleaning up ...
140 attr_reader :save_mutex
142 # bot's Language data
149 # bot's object registry, plugins get an interface to this for persistant
150 # storage (hash interface tied to a bdb file, plugins use Accessors to store
151 # and restore objects in their own namespaces.)
152 attr_reader :registry
154 # bot's plugins. This is an instance of class Plugins
157 # bot's httputil help object, for fetching resources via http. Sets up
158 # proxies etc as defined by the bot configuration/environment
159 attr_accessor :httputil
161 # server we are connected to
167 # bot User in the client/server connection
173 # bot User in the client/server connection
181 ret = self.to_s[0..-2]
182 ret << ' version=' << $version.inspect
183 ret << ' botclass=' << botclass.inspect
184 ret << ' lang="' << lang.language
189 ret << ' nick=' << nick.inspect
192 ret << (server.to_s + (socket ?
193 ' [' << socket.server_uri.to_s << ']' : '')).inspect
194 unless server.channels.empty?
196 ret << server.channels.map { |c|
197 "%s%s" % [c.modes_of(nick).map { |m|
198 server.prefix_for_mode(m)
205 ret << ' plugins=' << plugins.inspect
210 # create a new Bot with botclass +botclass+
211 def initialize(botclass, params = {})
212 # Config for the core bot
213 # TODO should we split socket stuff into ircsocket, etc?
214 Config.register Config::ArrayValue.new('server.list',
215 :default => ['irc://localhost'], :wizard => true,
216 :requires_restart => true,
217 :desc => "List of irc servers rbot should try to connect to. Use comma to separate values. Servers are in format 'server.doma.in:port'. If port is not specified, default value (6667) is used.")
218 Config.register Config::BooleanValue.new('server.ssl',
219 :default => false, :requires_restart => true, :wizard => true,
220 :desc => "Use SSL to connect to this server?")
221 Config.register Config::StringValue.new('server.password',
222 :default => false, :requires_restart => true,
223 :desc => "Password for connecting to this server (if required)",
225 Config.register Config::StringValue.new('server.bindhost',
226 :default => false, :requires_restart => true,
227 :desc => "Specific local host or IP for the bot to bind to (if required)",
229 Config.register Config::IntegerValue.new('server.reconnect_wait',
230 :default => 5, :validate => Proc.new{|v| v >= 0},
231 :desc => "Seconds to wait before attempting to reconnect, on disconnect")
232 Config.register Config::FloatValue.new('server.sendq_delay',
233 :default => 2.0, :validate => Proc.new{|v| v >= 0},
234 :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
235 :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
236 Config.register Config::IntegerValue.new('server.sendq_burst',
237 :default => 4, :validate => Proc.new{|v| v >= 0},
238 :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines",
239 :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
240 Config.register Config::IntegerValue.new('server.ping_timeout',
241 :default => 30, :validate => Proc.new{|v| v >= 0},
242 :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
244 Config.register Config::StringValue.new('irc.nick', :default => "rbot",
245 :desc => "IRC nickname the bot should attempt to use", :wizard => true,
246 :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
247 Config.register Config::StringValue.new('irc.name',
248 :default => "Ruby bot", :requires_restart => true,
249 :desc => "IRC realname the bot should use")
250 Config.register Config::BooleanValue.new('irc.name_copyright',
251 :default => true, :requires_restart => true,
252 :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
253 Config.register Config::StringValue.new('irc.user', :default => "rbot",
254 :requires_restart => true,
255 :desc => "local user the bot should appear to be", :wizard => true)
256 Config.register Config::ArrayValue.new('irc.join_channels',
257 :default => [], :wizard => true,
258 :desc => "What channels the bot should always join at startup. List multiple channels using commas to separate. If a channel requires a password, use a space after the channel name. e.g: '#chan1, #chan2, #secretchan secritpass, #chan3'")
259 Config.register Config::ArrayValue.new('irc.ignore_users',
261 :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
263 Config.register Config::IntegerValue.new('core.save_every',
264 :default => 60, :validate => Proc.new{|v| v >= 0},
265 :on_change => Proc.new { |bot, v|
268 @timer.reschedule(@save_timer, v)
269 @timer.unblock(@save_timer)
271 @timer.block(@save_timer)
275 @save_timer = @timer.add(v) { bot.save }
277 # Nothing to do when v == 0
280 :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
282 Config.register Config::BooleanValue.new('core.run_as_daemon',
283 :default => false, :requires_restart => true,
284 :desc => "Should the bot run as a daemon?")
286 Config.register Config::StringValue.new('log.file',
287 :default => false, :requires_restart => true,
288 :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
289 Config.register Config::IntegerValue.new('log.level',
290 :default => 1, :requires_restart => false,
291 :validate => Proc.new { |v| (0..5).include?(v) },
292 :on_change => Proc.new { |bot, v|
295 :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
296 Config.register Config::IntegerValue.new('log.keep',
297 :default => 1, :requires_restart => true,
298 :validate => Proc.new { |v| v >= 0 },
299 :desc => "How many old console messages logfiles to keep")
300 Config.register Config::IntegerValue.new('log.max_size',
301 :default => 10, :requires_restart => true,
302 :validate => Proc.new { |v| v > 0 },
303 :desc => "Maximum console messages logfile size (in megabytes)")
305 Config.register Config::ArrayValue.new('plugins.path',
306 :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
307 :requires_restart => false,
308 :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
309 :desc => "Where the bot should look for plugins. List multiple directories using commas to separate. Use '(default)' for default prepackaged plugins collection, '(default)/contrib' for prepackaged unsupported plugins collection")
311 Config.register Config::EnumValue.new('send.newlines',
312 :values => ['split', 'join'], :default => 'split',
313 :on_change => Proc.new { |bot, v|
314 bot.set_default_send_options :newlines => v.to_sym
316 :desc => "When set to split, messages with embedded newlines will be sent as separate lines. When set to join, newlines will be replaced by the value of join_with")
317 Config.register Config::StringValue.new('send.join_with',
319 :on_change => Proc.new { |bot, v|
320 bot.set_default_send_options :join_with => v.dup
322 :desc => "String used to replace newlines when send.newlines is set to join")
323 Config.register Config::IntegerValue.new('send.max_lines',
325 :validate => Proc.new { |v| v >= 0 },
326 :on_change => Proc.new { |bot, v|
327 bot.set_default_send_options :max_lines => v
329 :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
330 Config.register Config::EnumValue.new('send.overlong',
331 :values => ['split', 'truncate'], :default => 'split',
332 :on_change => Proc.new { |bot, v|
333 bot.set_default_send_options :overlong => v.to_sym
335 :desc => "When set to split, messages which are too long to fit in a single IRC line are split into multiple lines. When set to truncate, long messages are truncated to fit the IRC line length")
336 Config.register Config::StringValue.new('send.split_at',
338 :on_change => Proc.new { |bot, v|
339 bot.set_default_send_options :split_at => Regexp.new(v)
341 :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
342 Config.register Config::BooleanValue.new('send.purge_split',
344 :on_change => Proc.new { |bot, v|
345 bot.set_default_send_options :purge_split => v
347 :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
348 Config.register Config::StringValue.new('send.truncate_text',
349 :default => "#{Reverse}...#{Reverse}",
350 :on_change => Proc.new { |bot, v|
351 bot.set_default_send_options :truncate_text => v.dup
353 :desc => "When truncating overlong messages (see send.overlong) or when sending too many lines per message (see send.max_lines) replace the end of the last line with this text")
355 @argv = params[:argv]
356 @run_dir = params[:run_dir] || Dir.pwd
358 unless FileTest.directory? Config::coredir
359 error "core directory '#{Config::coredir}' not found, did you setup.rb?"
363 unless FileTest.directory? Config::datadir
364 error "data directory '#{Config::datadir}' not found, did you setup.rb?"
368 unless botclass and not botclass.empty?
369 # We want to find a sensible default.
370 # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
371 # * On Windows (at least the NT versions) we want to put our stuff in the
372 # Application Data folder.
373 # We don't use any particular O/S detection magic, exploiting the fact that
374 # Etc.getpwuid is nil on Windows
375 if Etc.getpwuid(Process::Sys.geteuid)
376 botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
378 if ENV.has_key?('APPDATA')
379 botclass = ENV['APPDATA'].dup
380 botclass.gsub!("\\","/")
385 botclass = File.expand_path(botclass)
386 @botclass = botclass.gsub(/\/$/, "")
388 unless FileTest.directory? botclass
389 log "no #{botclass} directory found, creating from templates.."
390 if FileTest.exist? botclass
391 error "file #{botclass} exists but isn't a directory"
394 FileUtils.cp_r Config::datadir+'/templates', botclass
397 Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
398 Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
399 Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
401 # Time at which the last PING was sent
403 # Time at which the last line was RECV'd from the server
406 @startup_time = Time.new
409 @config = Config.manager
410 @config.bot_associate(self)
411 rescue Exception => e
417 if @config['core.run_as_daemon']
421 @logfile = @config['log.file']
422 if @logfile.class!=String || @logfile.empty?
423 @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
426 # See http://blog.humlab.umu.se/samuel/archives/000107.html
427 # for the backgrounding code
433 rescue NotImplementedError
434 warning "Could not background, fork not supported"
437 rescue Exception => e
438 warning "Could not background. #{e.pretty_inspect}"
441 # File.umask 0000 # Ensure sensible umask. Adjust as needed.
442 log "Redirecting standard input/output/error"
444 STDIN.reopen "/dev/null"
446 # On Windows, there's not such thing as /dev/null
449 def STDOUT.write(str=nil)
453 def STDERR.write(str=nil)
454 if str.to_s.match(/:\d+: warning:/)
463 # Set the new logfile and loglevel. This must be done after the daemonizing
464 $logger = Logger.new(@logfile, @config['log.keep'], @config['log.max_size']*1024*1024)
465 $logger.datetime_format= $dateformat
466 $logger.level = @config['log.level']
467 $logger.level = $cl_loglevel if defined? $cl_loglevel
468 $logger.level = 0 if $debug
472 File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
476 @registry = Registry.new self
479 @save_mutex = Mutex.new
480 if @config['core.save_every'] > 0
481 @save_timer = @timer.add(@config['core.save_every']) { save }
485 @quit_mutex = Mutex.new
490 @lang = Language.new(self, @config['core.language'])
493 @auth = Auth::manager
494 @auth.bot_associate(self)
495 # @auth.load("#{botclass}/botusers.yaml")
496 rescue Exception => e
501 @auth.everyone.set_default_permission("*", true)
502 @auth.botowner.password= @config['auth.password']
504 Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
505 @plugins = Plugins::manager
506 @plugins.bot_associate(self)
509 if @config['server.name']
510 debug "upgrading configuration (server.name => server.list)"
511 srv_uri = 'irc://' + @config['server.name']
512 srv_uri += ":#{@config['server.port']}" if @config['server.port']
513 @config.items['server.list'.to_sym].set_string(srv_uri)
514 @config.delete('server.name'.to_sym)
515 @config.delete('server.port'.to_sym)
516 debug "server.list is now #{@config['server.list'].inspect}"
519 @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
524 # Channels where we are quiet
525 # Array of channels names where the bot should be quiet
526 # '*' means all channels
530 @client[:welcome] = proc {|data|
531 irclog "joined server #{@client.server} as #{myself}", "server"
533 @plugins.delegate("connect")
535 @config['irc.join_channels'].each { |c|
536 debug "autojoining channel #{c}"
537 if(c =~ /^(\S+)\s+(\S+)$/i)
545 # TODO the next two @client should go into rfc2812.rb, probably
546 # Since capabs are two-steps processes, server.supports[:capab]
547 # should be a three-state: nil, [], [....]
548 asked_for = { :"identify-msg" => false }
549 @client[:isupport] = proc { |data|
550 if server.supports[:capab] and !asked_for[:"identify-msg"]
551 sendq "CAPAB IDENTIFY-MSG"
552 asked_for[:"identify-msg"] = true
555 @client[:datastr] = proc { |data|
556 if data[:text] == "IDENTIFY-MSG"
557 server.capabilities[:"identify-msg"] = true
559 debug "Not handling RPL_DATASTR #{data[:servermessage]}"
563 @client[:privmsg] = proc { |data|
564 m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
565 # debug "Message source is #{data[:source].inspect}"
566 # debug "Message target is #{data[:target].inspect}"
567 # debug "Bot is #{myself.inspect}"
570 @config['irc.ignore_users'].each { |mask|
571 if m.source.matches?(server.new_netmask(mask))
580 @plugins.delegate "listen", m
581 @plugins.delegate("ctcp_listen", m) if m.ctcp
582 @plugins.privmsg(m) if m.address?
584 @plugins.delegate "unreplied", m
588 @client[:notice] = proc { |data|
589 message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
590 # pass it off to plugins that want to hear everything
591 @plugins.delegate "listen", message
593 @client[:motd] = proc { |data|
594 data[:motd].each_line { |line|
595 irclog "MOTD: #{line}", "server"
598 @client[:nicktaken] = proc { |data|
599 new = "#{data[:nick]}_"
601 # If we're setting our nick at connection because our choice was taken,
602 # we have to fix our nick manually, because there will be no NICK message
603 # to inform us that our nick has been changed.
604 if data[:target] == '*'
605 debug "setting my connection nick to #{new}"
608 @plugins.delegate "nicktaken", data[:nick]
610 @client[:badnick] = proc {|data|
611 warning "bad nick (#{data[:nick]})"
613 @client[:ping] = proc {|data|
614 sendq "PONG #{data[:pingid]}"
616 @client[:pong] = proc {|data|
619 @client[:nick] = proc {|data|
620 # debug "Message source is #{data[:source].inspect}"
621 # debug "Bot is #{myself.inspect}"
622 source = data[:source]
625 m = NickMessage.new(self, server, source, old, new)
627 debug "my nick is now #{new}"
629 data[:is_on].each { |ch|
630 irclog "@ #{old} is now known as #{new}", ch
632 @plugins.delegate("listen", m)
633 @plugins.delegate("nick", m)
635 @client[:quit] = proc {|data|
636 source = data[:source]
637 message = data[:message]
638 m = QuitMessage.new(self, server, source, source, message)
639 data[:was_on].each { |ch|
640 irclog "@ Quit: #{source}: #{message}", ch
642 @plugins.delegate("listen", m)
643 @plugins.delegate("quit", m)
645 @client[:mode] = proc {|data|
646 irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
648 @client[:join] = proc {|data|
649 m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
652 @plugins.delegate("listen", m)
653 @plugins.delegate("join", m)
654 sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
656 @client[:part] = proc {|data|
657 m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
660 @plugins.delegate("listen", m)
661 @plugins.delegate("part", m)
663 @client[:kick] = proc {|data|
664 m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
667 @plugins.delegate("listen", m)
668 @plugins.delegate("kick", m)
670 @client[:invite] = proc {|data|
671 if data[:target] == myself
672 join data[:channel] if @auth.allow?("join", data[:source], data[:source].nick)
675 @client[:changetopic] = proc {|data|
676 m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
679 @plugins.delegate("listen", m)
680 @plugins.delegate("topic", m)
682 @client[:topic] = proc { |data|
683 irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
685 @client[:topicinfo] = proc { |data|
686 channel = data[:channel]
687 topic = channel.topic
688 irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
689 m = TopicMessage.new(self, server, data[:source], channel, topic)
691 @plugins.delegate("listen", m)
692 @plugins.delegate("topic", m)
694 @client[:names] = proc { |data|
695 @plugins.delegate "names", data[:channel], data[:users]
697 @client[:unknown] = proc { |data|
698 #debug "UNKNOWN: #{data[:serverstring]}"
699 irclog data[:serverstring], ".unknown"
702 set_default_send_options :newlines => @config['send.newlines'].to_sym,
703 :join_with => @config['send.join_with'].dup,
704 :max_lines => @config['send.max_lines'],
705 :overlong => @config['send.overlong'].to_sym,
706 :split_at => Regexp.new(@config['send.split_at']),
707 :purge_split => @config['send.purge_split'],
708 :truncate_text => @config['send.truncate_text'].dup
711 def setup_plugins_path
712 @plugins.clear_botmodule_dirs
713 @plugins.add_botmodule_dir(Config::coredir + "/utils")
714 @plugins.add_botmodule_dir(Config::coredir)
715 @plugins.add_botmodule_dir("#{botclass}/plugins")
717 @config['plugins.path'].each do |_|
718 path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
719 @plugins.add_botmodule_dir(path)
723 def set_default_send_options(opts={})
724 # Default send options for NOTICE and PRIVMSG
725 unless defined? @default_send_options
726 @default_send_options = {
727 :queue_channel => nil, # use default queue channel
728 :queue_ring => nil, # use default queue ring
729 :newlines => :split, # or :join
730 :join_with => ' ', # by default, use a single space
731 :max_lines => 0, # maximum number of lines to send with a single command
732 :overlong => :split, # or :truncate
733 # TODO an array of splitpoints would be preferrable for this option:
734 :split_at => /\s+/, # by default, split overlong lines at whitespace
735 :purge_split => true, # should the split string be removed?
736 :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
739 @default_send_options.update opts unless opts.empty?
742 # checks if we should be quiet on a channel
743 def quiet_on?(channel)
744 return @quiet.include?('*') || @quiet.include?(channel.downcase)
747 def set_quiet(channel)
749 ch = channel.downcase.dup
750 @quiet << ch unless @quiet.include?(ch)
757 def reset_quiet(channel)
759 @quiet.delete channel.downcase
765 # things to do when we receive a signal
767 debug "received #{sig}, queueing quit"
769 quit unless @quit_mutex.locked?
770 debug "interrupted #{$interrupted} times"
778 # connect the bot to IRC
781 trap("SIGINT") { got_sig("SIGINT") }
782 trap("SIGTERM") { got_sig("SIGTERM") }
783 trap("SIGHUP") { got_sig("SIGHUP") }
784 rescue ArgumentError => e
785 debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
786 rescue Exception => e
787 debug "failed to trap signals: #{e.pretty_inspect}"
790 quit if $interrupted > 0
793 raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
795 quit if $interrupted > 0
797 realname = @config['irc.name'].clone || 'Ruby bot'
798 realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
800 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
801 @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
802 quit if $interrupted > 0
803 myself.nick = @config['irc.nick']
804 myself.user = @config['irc.user']
807 # begin event handling loop
811 quit if $interrupted > 0
815 while @socket.connected?
816 quit if $interrupted > 0
818 # Wait for messages and process them as they arrive. If nothing is
819 # received, we call the ping_server() method that will PING the
820 # server if appropriate, or raise a TimeoutError if no PONG has been
821 # received in the user-chosen timeout since the last PING sent.
823 break unless reply = @socket.gets
825 @client.process reply
831 # I despair of this. Some of my users get "connection reset by peer"
832 # exceptions that ARENT SocketError's. How am I supposed to handle
837 rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
838 error "network exception: #{e.pretty_inspect}"
840 rescue BDB::Fatal => e
841 fatal "fatal bdb error: #{e.pretty_inspect}"
843 # Why restart? DB problems are serious stuff ...
844 # restart("Oops, we seem to have registry problems ...")
847 rescue Exception => e
848 error "non-net exception: #{e.pretty_inspect}"
851 fatal "unexpected exception: #{e.pretty_inspect}"
858 log "\n\nDisconnected\n\n"
860 quit if $interrupted > 0
862 log "\n\nWaiting to reconnect\n\n"
863 sleep @config['server.reconnect_wait']
867 # type:: message type
868 # where:: message target
869 # message:: message text
870 # send message +message+ of type +type+ to target +where+
871 # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
872 # relevant say() or notice() methods. This one should be used for IRCd
873 # extensions you want to use in modules.
874 def sendmsg(type, where, original_message, options={})
875 opts = @default_send_options.merge(options)
877 # For starters, set up appropriate queue channels and rings
878 mchan = opts[:queue_channel]
879 mring = opts[:queue_ring]
896 multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
900 messages << [multi_line.gsub("\n", opts[:join_with])]
902 multi_line.each_line { |line|
904 next unless(line.size > 0)
908 raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
911 # The IRC protocol requires that each raw message must be not longer
912 # than 512 characters. From this length with have to subtract the EOL
913 # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
914 # that will be prepended by the server to all of our messages.
916 # The maximum raw message length we can send is therefore 512 - 2 - 2
917 # minus the length of our hostmask.
919 max_len = 508 - myself.fullform.size
921 # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
922 # will have a + or - prepended
923 if server.capabilities[:"identify-msg"]
927 # When splitting the message, we'll be prefixing the following string:
928 # (e.g. "PRIVMSG #rbot :")
929 fixed = "#{type} #{where} :"
931 # And this is what's left
932 left = max_len - fixed.size
934 truncate = opts[:truncate_text]
935 truncate = @default_send_options[:truncate_text] if truncate.size > left
936 truncate = "" if truncate.size > left
938 all_lines = messages.map { |line|
945 sub_lines = Array.new
947 sub_lines << msg.slice!(0, left)
949 lastspace = sub_lines.last.rindex(opts[:split_at])
951 msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
952 msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
957 line.slice(0, left - truncate.size) << truncate
959 raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
964 if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
965 lines = all_lines[0...opts[:max_lines]]
966 new_last = lines.last.slice(0, left - truncate.size) << truncate
967 lines.last.replace(new_last)
973 sendq "#{fixed}#{line}", chan, ring
974 log_sent(type, where, line)
978 # queue an arbitraty message for the server
979 def sendq(message="", chan=nil, ring=0)
981 @socket.queue(message, chan, ring)
984 # send a notice message to channel/nick +where+
985 def notice(where, message, options={})
986 return if where.kind_of?(Channel) and quiet_on?(where)
987 sendmsg "NOTICE", where, message, options
990 # say something (PRIVMSG) to channel/nick +where+
991 def say(where, message, options={})
992 return if where.kind_of?(Channel) and quiet_on?(where)
993 sendmsg "PRIVMSG", where, message, options
996 def ctcp_notice(where, command, message, options={})
997 return if where.kind_of?(Channel) and quiet_on?(where)
998 sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
1001 def ctcp_say(where, command, message, options={})
1002 return if where.kind_of?(Channel) and quiet_on?(where)
1003 sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
1006 # perform a CTCP action with message +message+ to channel/nick +where+
1007 def action(where, message, options={})
1008 ctcp_say(where, 'ACTION', message, options)
1011 # quick way to say "okay" (or equivalent) to +where+
1013 say where, @lang.get("okay")
1016 # log IRC-related message +message+ to a file determined by +where+.
1017 # +where+ can be a channel name, or a nick for private message logging
1018 def irclog(message, where="server")
1019 message = message.chomp
1020 stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
1021 if where.class <= Server
1022 where_str = "server"
1024 where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
1026 unless(@logs.has_key?(where_str))
1027 @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a")
1028 @logs[where_str].sync = true
1030 @logs[where_str].puts "[#{stamp}] #{message}"
1031 #debug "[#{stamp}] <#{where}> #{message}"
1034 # set topic of channel +where+ to +topic+
1035 def topic(where, topic)
1036 sendq "TOPIC #{where} :#{topic}", where, 2
1039 def disconnect(message=nil)
1040 message = @lang.get("quit") if (!message || message.empty?)
1041 if @socket.connected?
1043 debug "Clearing socket"
1045 debug "Sending quit message"
1046 @socket.emergency_puts "QUIT :#{message}"
1047 debug "Flushing socket"
1049 rescue SocketError => e
1050 error "error while disconnecting socket: #{e.pretty_inspect}"
1052 debug "Shutting down socket"
1055 debug "Logging quits"
1056 server.channels.each { |ch|
1057 irclog "@ quit (#{message})", ch
1063 # disconnect from the server and cleanup all plugins and modules
1064 def shutdown(message=nil)
1065 @quit_mutex.synchronize do
1066 debug "Shutting down: #{message}"
1067 ## No we don't restore them ... let everything run through
1069 # trap("SIGINT", "DEFAULT")
1070 # trap("SIGTERM", "DEFAULT")
1071 # trap("SIGHUP", "DEFAULT")
1073 # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1075 debug "\tdisconnecting..."
1077 debug "\tstopping timer..."
1079 debug "\tsaving ..."
1081 debug "\tcleaning up ..."
1082 @save_mutex.synchronize do
1085 # debug "\tstopping timers ..."
1087 # debug "Closing registries"
1089 debug "\t\tcleaning up the db environment ..."
1091 log "rbot quit (#{message})"
1095 # message:: optional IRC quit message
1096 # quit IRC, shutdown the bot
1097 def quit(message=nil)
1105 # totally shutdown and respawn the bot
1106 def restart(message=nil)
1107 message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
1109 sleep @config['server.reconnect_wait']
1112 # Note, this fails on Windows
1113 debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1116 rescue Errno::ENOENT
1117 exec("ruby", *(@argv.unshift $0))
1118 rescue Exception => e
1124 # call the save method for all of the botmodules
1126 @save_mutex.synchronize do
1132 # call the rescan method for all of the botmodules
1134 debug "\tstopping timer..."
1136 @save_mutex.synchronize do
1143 # channel:: channel to join
1144 # key:: optional channel key if channel is +s
1146 def join(channel, key=nil)
1148 sendq "JOIN #{channel} :#{key}", channel, 2
1150 sendq "JOIN #{channel}", channel, 2
1155 def part(channel, message="")
1156 sendq "PART #{channel} :#{message}", channel, 2
1159 # attempt to change bot's nick to +name+
1161 sendq "NICK #{name}"
1165 def mode(channel, mode, target)
1166 sendq "MODE #{channel} #{mode} #{target}", channel, 2
1170 def kick(channel, user, msg)
1171 sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1174 # m:: message asking for help
1175 # topic:: optional topic help is requested for
1176 # respond to online help requests
1178 topic = nil if topic == ""
1181 helpstr = _("help topics: ")
1182 helpstr += @plugins.helptopics
1183 helpstr += _(" (help <topic> for more info)")
1185 unless(helpstr = @plugins.help(topic))
1186 helpstr = _("no help for topic %{topic}") % { :topic => topic }
1192 # returns a string describing the current status of the bot (uptime etc)
1194 secs_up = Time.new - @startup_time
1195 uptime = Utils.secs_to_string secs_up
1196 # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1197 return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
1199 :up => uptime, :plug => @plugins.length,
1200 :sent => @socket.lines_sent, :recv => @socket.lines_received
1204 # We want to respond to a hung server in a timely manner. If nothing was received
1205 # in the user-selected timeout and we haven't PINGed the server yet, we PING
1206 # the server. If the PONG is not received within the user-defined timeout, we
1207 # assume we're in ping timeout and act accordingly.
1209 act_timeout = @config['server.ping_timeout']
1210 return if act_timeout <= 0
1212 if @last_rec && now > @last_rec + act_timeout
1214 # No previous PING pending, send a new one
1216 @last_ping = Time.now
1218 diff = now - @last_ping
1219 if diff > act_timeout
1220 debug "no PONG from server in #{diff} seconds, reconnecting"
1221 # the actual reconnect is handled in the main loop:
1222 raise TimeoutError, "no PONG from server in #{diff} seconds"
1228 def stop_server_pings
1229 # cancel previous PINGs and reset time of last RECV
1236 def irclogprivmsg(m)
1239 irclog "* [#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
1241 irclog "* #{m.source} #{m.logmessage}", m.target
1245 irclog "<#{m.source}> #{m.logmessage}", m.target
1247 irclog "[#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
1252 # log a message. Internal use only.
1253 def log_sent(type, where, message)
1258 irclog "-=#{myself}=- #{message}", where
1260 irclog "[-=#{where}=-] #{message}", where
1265 irclog "<#{myself}> #{message}", where
1267 irclog "[msg(#{where})] #{message}", where
1274 debug "joined channel #{m.channel}"
1275 irclog "@ Joined channel #{m.channel}", m.channel
1277 irclog "@ #{m.source} joined channel #{m.channel}", m.channel
1283 debug "left channel #{m.channel}"
1284 irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
1286 irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel
1292 debug "kicked from channel #{m.channel}"
1293 irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
1295 irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
1300 if m.source == myself
1301 irclog "@ I set topic \"#{m.topic}\"", m.channel
1303 irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel