7 $debug = false unless $debug
8 $daemonize = false unless $daemonize
10 $dateformat = "%Y/%m/%d %H:%M:%S"
11 $logger = Logger.new($stderr)
12 $logger.datetime_format = $dateformat
13 $logger.level = $cl_loglevel if $cl_loglevel
14 $logger.level = 0 if $debug
18 unless Kernel.instance_methods.include?("pretty_inspect")
22 public :pretty_inspect
27 q.group(1, "#<%s: %s" % [self.class, self.message], ">") {
28 q.seplist(self.backtrace, lambda { "\n" }) { |v| v } if self.backtrace
33 def rawlog(level, message=nil, who_pos=1)
35 if call_stack.length > who_pos
36 who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
40 # Output each line. To distinguish between separate messages and multi-line
41 # messages originating at the same time, we blank #{who} after the first message
43 # Also, we output strings as-is but for other objects we use pretty_inspect
48 str = message.pretty_inspect
51 $logger.add(level, l.chomp, who)
57 $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
61 $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
64 def debug(message=nil, who_pos=1)
65 rawlog(Logger::Severity::DEBUG, message, who_pos)
68 def log(message=nil, who_pos=1)
69 rawlog(Logger::Severity::INFO, message, who_pos)
72 def warning(message=nil, who_pos=1)
73 rawlog(Logger::Severity::WARN, message, who_pos)
76 def error(message=nil, who_pos=1)
77 rawlog(Logger::Severity::ERROR, message, who_pos)
80 def fatal(message=nil, who_pos=1)
81 rawlog(Logger::Severity::FATAL, message, who_pos)
86 warning "warning test"
90 # The following global is used for the improved signal handling.
93 require 'rbot/load-gettext'
96 require 'rbot/rbotconfig'
98 # require 'rbot/utils'
101 require 'rbot/rfc2812'
102 require 'rbot/ircsocket'
103 require 'rbot/botuser'
105 require 'rbot/plugins'
106 # require 'rbot/channel'
107 require 'rbot/message'
108 require 'rbot/language'
109 require 'rbot/dbhash'
110 require 'rbot/registry'
111 # require 'rbot/httputil'
115 # Main bot class, which manages the various components, receives messages,
116 # handles them or passes them to plugins, and contains core functionality.
118 COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
119 # the bot's Auth data
122 # the bot's BotConfig data
125 # the botclass for this bot (determines configdir among other things)
126 attr_reader :botclass
128 # used to perform actions periodically (saves configuration once per minute
132 # synchronize with this mutex while touching permanent data files:
133 # saving, flushing, cleaning up ...
134 attr_reader :save_mutex
136 # bot's Language data
143 # bot's object registry, plugins get an interface to this for persistant
144 # storage (hash interface tied to a bdb file, plugins use Accessors to store
145 # and restore objects in their own namespaces.)
146 attr_reader :registry
148 # bot's plugins. This is an instance of class Plugins
151 # bot's httputil help object, for fetching resources via http. Sets up
152 # proxies etc as defined by the bot configuration/environment
153 attr_accessor :httputil
155 # server we are connected to
161 # bot User in the client/server connection
167 # bot User in the client/server connection
172 # create a new Bot with botclass +botclass+
173 def initialize(botclass, params = {})
174 # BotConfig for the core bot
175 # TODO should we split socket stuff into ircsocket, etc?
176 BotConfig.register BotConfigArrayValue.new('server.list',
177 :default => ['irc://localhost'], :wizard => true,
178 :requires_restart => true,
179 :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.")
180 BotConfig.register BotConfigBooleanValue.new('server.ssl',
181 :default => false, :requires_restart => true, :wizard => true,
182 :desc => "Use SSL to connect to this server?")
183 BotConfig.register BotConfigStringValue.new('server.password',
184 :default => false, :requires_restart => true,
185 :desc => "Password for connecting to this server (if required)",
187 BotConfig.register BotConfigStringValue.new('server.bindhost',
188 :default => false, :requires_restart => true,
189 :desc => "Specific local host or IP for the bot to bind to (if required)",
191 BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait',
192 :default => 5, :validate => Proc.new{|v| v >= 0},
193 :desc => "Seconds to wait before attempting to reconnect, on disconnect")
194 BotConfig.register BotConfigFloatValue.new('server.sendq_delay',
195 :default => 2.0, :validate => Proc.new{|v| v >= 0},
196 :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
197 :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
198 BotConfig.register BotConfigIntegerValue.new('server.sendq_burst',
199 :default => 4, :validate => Proc.new{|v| v >= 0},
200 :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines",
201 :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
202 BotConfig.register BotConfigIntegerValue.new('server.ping_timeout',
203 :default => 30, :validate => Proc.new{|v| v >= 0},
204 :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
206 BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot",
207 :desc => "IRC nickname the bot should attempt to use", :wizard => true,
208 :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
209 BotConfig.register BotConfigStringValue.new('irc.name',
210 :default => "Ruby bot", :requires_restart => true,
211 :desc => "IRC realname the bot should use")
212 BotConfig.register BotConfigBooleanValue.new('irc.name_copyright',
213 :default => true, :requires_restart => true,
214 :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
215 BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot",
216 :requires_restart => true,
217 :desc => "local user the bot should appear to be", :wizard => true)
218 BotConfig.register BotConfigArrayValue.new('irc.join_channels',
219 :default => [], :wizard => true,
220 :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'")
221 BotConfig.register BotConfigArrayValue.new('irc.ignore_users',
223 :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
225 BotConfig.register BotConfigIntegerValue.new('core.save_every',
226 :default => 60, :validate => Proc.new{|v| v >= 0},
227 :on_change => Proc.new { |bot, v|
230 @timer.reschedule(@save_timer, v)
231 @timer.unblock(@save_timer)
233 @timer.block(@save_timer)
237 @save_timer = @timer.add(v) { bot.save }
239 # Nothing to do when v == 0
242 :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
244 BotConfig.register BotConfigBooleanValue.new('core.run_as_daemon',
245 :default => false, :requires_restart => true,
246 :desc => "Should the bot run as a daemon?")
248 BotConfig.register BotConfigStringValue.new('log.file',
249 :default => false, :requires_restart => true,
250 :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
251 BotConfig.register BotConfigIntegerValue.new('log.level',
252 :default => 1, :requires_restart => false,
253 :validate => Proc.new { |v| (0..5).include?(v) },
254 :on_change => Proc.new { |bot, v|
257 :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
258 BotConfig.register BotConfigIntegerValue.new('log.keep',
259 :default => 1, :requires_restart => true,
260 :validate => Proc.new { |v| v >= 0 },
261 :desc => "How many old console messages logfiles to keep")
262 BotConfig.register BotConfigIntegerValue.new('log.max_size',
263 :default => 10, :requires_restart => true,
264 :validate => Proc.new { |v| v > 0 },
265 :desc => "Maximum console messages logfile size (in megabytes)")
267 BotConfig.register BotConfigArrayValue.new('plugins.path',
268 :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
269 :requires_restart => false,
270 :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
271 :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")
273 BotConfig.register BotConfigEnumValue.new('send.newlines',
274 :values => ['split', 'join'], :default => 'split',
275 :on_change => Proc.new { |bot, v|
276 bot.set_default_send_options :newlines => v.to_sym
278 :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")
279 BotConfig.register BotConfigStringValue.new('send.join_with',
281 :on_change => Proc.new { |bot, v|
282 bot.set_default_send_options :join_with => v.dup
284 :desc => "String used to replace newlines when send.newlines is set to join")
285 BotConfig.register BotConfigIntegerValue.new('send.max_lines',
287 :validate => Proc.new { |v| v >= 0 },
288 :on_change => Proc.new { |bot, v|
289 bot.set_default_send_options :max_lines => v
291 :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
292 BotConfig.register BotConfigEnumValue.new('send.overlong',
293 :values => ['split', 'truncate'], :default => 'split',
294 :on_change => Proc.new { |bot, v|
295 bot.set_default_send_options :overlong => v.to_sym
297 :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")
298 BotConfig.register BotConfigStringValue.new('send.split_at',
300 :on_change => Proc.new { |bot, v|
301 bot.set_default_send_options :split_at => Regexp.new(v)
303 :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
304 BotConfig.register BotConfigBooleanValue.new('send.purge_split',
306 :on_change => Proc.new { |bot, v|
307 bot.set_default_send_options :purge_split => v
309 :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
310 BotConfig.register BotConfigStringValue.new('send.truncate_text',
311 :default => "#{Reverse}...#{Reverse}",
312 :on_change => Proc.new { |bot, v|
313 bot.set_default_send_options :truncate_text => v.dup
315 :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")
317 @argv = params[:argv]
318 @run_dir = params[:run_dir] || Dir.pwd
320 unless FileTest.directory? Config::coredir
321 error "core directory '#{Config::coredir}' not found, did you setup.rb?"
325 unless FileTest.directory? Config::datadir
326 error "data directory '#{Config::datadir}' not found, did you setup.rb?"
330 unless botclass and not botclass.empty?
331 # We want to find a sensible default.
332 # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
333 # * On Windows (at least the NT versions) we want to put our stuff in the
334 # Application Data folder.
335 # We don't use any particular O/S detection magic, exploiting the fact that
336 # Etc.getpwuid is nil on Windows
337 if Etc.getpwuid(Process::Sys.geteuid)
338 botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
340 if ENV.has_key?('APPDATA')
341 botclass = ENV['APPDATA'].dup
342 botclass.gsub!("\\","/")
347 botclass = File.expand_path(botclass)
348 @botclass = botclass.gsub(/\/$/, "")
350 unless FileTest.directory? botclass
351 log "no #{botclass} directory found, creating from templates.."
352 if FileTest.exist? botclass
353 error "file #{botclass} exists but isn't a directory"
356 FileUtils.cp_r Config::datadir+'/templates', botclass
359 Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
360 Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
361 Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
363 # Time at which the last PING was sent
365 # Time at which the last line was RECV'd from the server
368 @startup_time = Time.new
371 @config = BotConfig.configmanager
372 @config.bot_associate(self)
373 rescue Exception => e
379 if @config['core.run_as_daemon']
383 @logfile = @config['log.file']
384 if @logfile.class!=String || @logfile.empty?
385 @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
388 # See http://blog.humlab.umu.se/samuel/archives/000107.html
389 # for the backgrounding code
395 rescue NotImplementedError
396 warning "Could not background, fork not supported"
399 rescue Exception => e
400 warning "Could not background. #{e.pretty_inspect}"
403 # File.umask 0000 # Ensure sensible umask. Adjust as needed.
404 log "Redirecting standard input/output/error"
406 STDIN.reopen "/dev/null"
408 # On Windows, there's not such thing as /dev/null
411 def STDOUT.write(str=nil)
415 def STDERR.write(str=nil)
416 if str.to_s.match(/:\d+: warning:/)
425 # Set the new logfile and loglevel. This must be done after the daemonizing
426 $logger = Logger.new(@logfile, @config['log.keep'], @config['log.max_size']*1024*1024)
427 $logger.datetime_format= $dateformat
428 $logger.level = @config['log.level']
429 $logger.level = $cl_loglevel if $cl_loglevel
430 $logger.level = 0 if $debug
434 File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
438 @registry = BotRegistry.new self
440 @timer = Timer::Timer.new(1.0) # only need per-second granularity
441 @save_mutex = Mutex.new
442 if @config['core.save_every'] > 0
443 @save_timer = @timer.add(@config['core.save_every']) { save }
447 @quit_mutex = Mutex.new
452 @lang = Language::Language.new(self, @config['core.language'])
455 @auth = Auth::authmanager
456 @auth.bot_associate(self)
457 # @auth.load("#{botclass}/botusers.yaml")
458 rescue Exception => e
463 @auth.everyone.set_default_permission("*", true)
464 @auth.botowner.password= @config['auth.password']
466 Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
467 @plugins = Plugins::manager
468 @plugins.bot_associate(self)
471 if @config['server.name']
472 debug "upgrading configuration (server.name => server.list)"
473 srv_uri = 'irc://' + @config['server.name']
474 srv_uri += ":#{@config['server.port']}" if @config['server.port']
475 @config.items['server.list'.to_sym].set_string(srv_uri)
476 @config.delete('server.name'.to_sym)
477 @config.delete('server.port'.to_sym)
478 debug "server.list is now #{@config['server.list'].inspect}"
481 @socket = IrcSocket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
486 # Channels where we are quiet
487 # Array of channels names where the bot should be quiet
488 # '*' means all channels
492 @client[:welcome] = proc {|data|
493 irclog "joined server #{@client.server} as #{myself}", "server"
495 @plugins.delegate("connect")
497 @config['irc.join_channels'].each { |c|
498 debug "autojoining channel #{c}"
499 if(c =~ /^(\S+)\s+(\S+)$/i)
507 # TODO the next two @client should go into rfc2812.rb, probably
508 # Since capabs are two-steps processes, server.supports[:capab]
509 # should be a three-state: nil, [], [....]
510 asked_for = { :"identify-msg" => false }
511 @client[:isupport] = proc { |data|
512 if server.supports[:capab] and !asked_for[:"identify-msg"]
513 sendq "CAPAB IDENTIFY-MSG"
514 asked_for[:"identify-msg"] = true
517 @client[:datastr] = proc { |data|
518 if data[:text] == "IDENTIFY-MSG"
519 server.capabilities[:"identify-msg"] = true
521 debug "Not handling RPL_DATASTR #{data[:servermessage]}"
525 @client[:privmsg] = proc { |data|
526 m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
527 # debug "Message source is #{data[:source].inspect}"
528 # debug "Message target is #{data[:target].inspect}"
529 # debug "Bot is #{myself.inspect}"
532 @config['irc.ignore_users'].each { |mask|
533 if m.source.matches?(server.new_netmask(mask))
542 @plugins.delegate "listen", m
543 @plugins.privmsg(m) if m.address?
545 @plugins.delegate "unreplied", m
549 @client[:notice] = proc { |data|
550 message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
551 # pass it off to plugins that want to hear everything
552 @plugins.delegate "listen", message
554 @client[:motd] = proc { |data|
555 data[:motd].each_line { |line|
556 irclog "MOTD: #{line}", "server"
559 @client[:nicktaken] = proc { |data|
560 new = "#{data[:nick]}_"
562 # If we're setting our nick at connection because our choice was taken,
563 # we have to fix our nick manually, because there will be no NICK message
564 # to inform us that our nick has been changed.
565 if data[:target] == '*'
566 debug "setting my connection nick to #{new}"
569 @plugins.delegate "nicktaken", data[:nick]
571 @client[:badnick] = proc {|data|
572 arning "bad nick (#{data[:nick]})"
574 @client[:ping] = proc {|data|
575 sendq "PONG #{data[:pingid]}"
577 @client[:pong] = proc {|data|
580 @client[:nick] = proc {|data|
581 # debug "Message source is #{data[:source].inspect}"
582 # debug "Bot is #{myself.inspect}"
583 source = data[:source]
586 m = NickMessage.new(self, server, source, old, new)
588 debug "my nick is now #{new}"
590 data[:is_on].each { |ch|
591 irclog "@ #{old} is now known as #{new}", ch
593 @plugins.delegate("listen", m)
594 @plugins.delegate("nick", m)
596 @client[:quit] = proc {|data|
597 source = data[:source]
598 message = data[:message]
599 m = QuitMessage.new(self, server, source, source, message)
600 data[:was_on].each { |ch|
601 irclog "@ Quit: #{source}: #{message}", ch
603 @plugins.delegate("listen", m)
604 @plugins.delegate("quit", m)
606 @client[:mode] = proc {|data|
607 irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
609 @client[:join] = proc {|data|
610 m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
613 @plugins.delegate("listen", m)
614 @plugins.delegate("join", m)
616 @client[:part] = proc {|data|
617 m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
620 @plugins.delegate("listen", m)
621 @plugins.delegate("part", m)
623 @client[:kick] = proc {|data|
624 m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
627 @plugins.delegate("listen", m)
628 @plugins.delegate("kick", m)
630 @client[:invite] = proc {|data|
631 if data[:target] == myself
632 join data[:channel] if @auth.allow?("join", data[:source], data[:source].nick)
635 @client[:changetopic] = proc {|data|
636 m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
639 @plugins.delegate("listen", m)
640 @plugins.delegate("topic", m)
642 @client[:topic] = proc { |data|
643 irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
645 @client[:topicinfo] = proc { |data|
646 channel = data[:channel]
647 topic = channel.topic
648 irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
649 m = TopicMessage.new(self, server, data[:source], channel, topic)
651 @plugins.delegate("listen", m)
652 @plugins.delegate("topic", m)
654 @client[:names] = proc { |data|
655 @plugins.delegate "names", data[:channel], data[:users]
657 @client[:unknown] = proc { |data|
658 #debug "UNKNOWN: #{data[:serverstring]}"
659 irclog data[:serverstring], ".unknown"
662 set_default_send_options :newlines => @config['send.newlines'].to_sym,
663 :join_with => @config['send.join_with'].dup,
664 :max_lines => @config['send.max_lines'],
665 :overlong => @config['send.overlong'].to_sym,
666 :split_at => Regexp.new(@config['send.split_at']),
667 :purge_split => @config['send.purge_split'],
668 :truncate_text => @config['send.truncate_text'].dup
671 def setup_plugins_path
672 @plugins.clear_botmodule_dirs
673 @plugins.add_botmodule_dir(Config::coredir + "/utils")
674 @plugins.add_botmodule_dir(Config::coredir)
675 @plugins.add_botmodule_dir("#{botclass}/plugins")
677 @config['plugins.path'].each do |_|
678 path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
679 @plugins.add_botmodule_dir(path)
683 def set_default_send_options(opts={})
684 # Default send options for NOTICE and PRIVMSG
685 unless defined? @default_send_options
686 @default_send_options = {
687 :queue_channel => nil, # use default queue channel
688 :queue_ring => nil, # use default queue ring
689 :newlines => :split, # or :join
690 :join_with => ' ', # by default, use a single space
691 :max_lines => 0, # maximum number of lines to send with a single command
692 :overlong => :split, # or :truncate
693 # TODO an array of splitpoints would be preferrable for this option:
694 :split_at => /\s+/, # by default, split overlong lines at whitespace
695 :purge_split => true, # should the split string be removed?
696 :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
699 @default_send_options.update opts unless opts.empty?
702 # checks if we should be quiet on a channel
703 def quiet_on?(channel)
704 return @quiet.include?('*') || @quiet.include?(channel.downcase)
707 def set_quiet(channel)
709 ch = channel.downcase.dup
710 @quiet << ch unless @quiet.include?(ch)
717 def reset_quiet(channel)
719 @quiet.delete channel.downcase
725 # things to do when we receive a signal
727 debug "received #{sig}, queueing quit"
729 quit unless @quit_mutex.locked?
730 debug "interrupted #{$interrupted} times"
738 # connect the bot to IRC
741 trap("SIGINT") { got_sig("SIGINT") }
742 trap("SIGTERM") { got_sig("SIGTERM") }
743 trap("SIGHUP") { got_sig("SIGHUP") }
744 rescue ArgumentError => e
745 debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
746 rescue Exception => e
747 debug "failed to trap signals: #{e.pretty_inspect}"
750 quit if $interrupted > 0
753 raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
755 quit if $interrupted > 0
757 realname = @config['irc.name'].clone || 'Ruby bot'
758 realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
760 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
761 @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
762 quit if $interrupted > 0
763 myself.nick = @config['irc.nick']
764 myself.user = @config['irc.user']
767 # begin event handling loop
771 quit if $interrupted > 0
776 while @socket.connected?
777 quit if $interrupted > 0
779 # Wait for messages and process them as they arrive. If nothing is
780 # received, we call the ping_server() method that will PING the
781 # server if appropriate, or raise a TimeoutError if no PONG has been
782 # received in the user-chosen timeout since the last PING sent.
784 break unless reply = @socket.gets
786 @client.process reply
792 # I despair of this. Some of my users get "connection reset by peer"
793 # exceptions that ARENT SocketError's. How am I supposed to handle
798 rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
799 error "network exception: #{e.pretty_inspect}"
801 rescue BDB::Fatal => e
802 fatal "fatal bdb error: #{e.pretty_inspect}"
804 # Why restart? DB problems are serious stuff ...
805 # restart("Oops, we seem to have registry problems ...")
808 rescue Exception => e
809 error "non-net exception: #{e.pretty_inspect}"
812 fatal "unexpected exception: #{e.pretty_inspect}"
819 log "\n\nDisconnected\n\n"
821 quit if $interrupted > 0
823 log "\n\nWaiting to reconnect\n\n"
824 sleep @config['server.reconnect_wait']
828 # type:: message type
829 # where:: message target
830 # message:: message text
831 # send message +message+ of type +type+ to target +where+
832 # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
833 # relevant say() or notice() methods. This one should be used for IRCd
834 # extensions you want to use in modules.
835 def sendmsg(type, where, original_message, options={})
836 opts = @default_send_options.merge(options)
838 # For starters, set up appropriate queue channels and rings
839 mchan = opts[:queue_channel]
840 mring = opts[:queue_ring]
857 multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
861 messages << [multi_line.gsub("\n", opts[:join_with])]
863 multi_line.each_line { |line|
865 next unless(line.size > 0)
869 raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
872 # The IRC protocol requires that each raw message must be not longer
873 # than 512 characters. From this length with have to subtract the EOL
874 # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
875 # that will be prepended by the server to all of our messages.
877 # The maximum raw message length we can send is therefore 512 - 2 - 2
878 # minus the length of our hostmask.
880 max_len = 508 - myself.fullform.size
882 # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
883 # will have a + or - prepended
884 if server.capabilities[:"identify-msg"]
888 # When splitting the message, we'll be prefixing the following string:
889 # (e.g. "PRIVMSG #rbot :")
890 fixed = "#{type} #{where} :"
892 # And this is what's left
893 left = max_len - fixed.size
895 truncate = opts[:truncate_text]
896 truncate = @default_send_options[:truncate_text] if truncate.size > left
897 truncate = "" if truncate.size > left
899 all_lines = messages.map { |line|
906 sub_lines = Array.new
908 sub_lines << msg.slice!(0, left)
910 lastspace = sub_lines.last.rindex(opts[:split_at])
912 msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
913 msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
918 line.slice(0, left - truncate.size) << truncate
920 raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
925 if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
926 lines = all_lines[0...opts[:max_lines]]
927 new_last = lines.last.slice(0, left - truncate.size) << truncate
928 lines.last.replace(new_last)
934 sendq "#{fixed}#{line}", chan, ring
935 log_sent(type, where, line)
939 # queue an arbitraty message for the server
940 def sendq(message="", chan=nil, ring=0)
942 @socket.queue(message, chan, ring)
945 # send a notice message to channel/nick +where+
946 def notice(where, message, options={})
947 return if where.kind_of?(Channel) and quiet_on?(where)
948 sendmsg "NOTICE", where, message, options
951 # say something (PRIVMSG) to channel/nick +where+
952 def say(where, message, options={})
953 return if where.kind_of?(Channel) and quiet_on?(where)
954 sendmsg "PRIVMSG", where, message, options
957 # perform a CTCP action with message +message+ to channel/nick +where+
958 def action(where, message, options={})
959 return if where.kind_of?(Channel) and quiet_on?(where)
960 mchan = options.fetch(:queue_channel, nil)
961 mring = options.fetch(:queue_ring, nil)
977 # FIXME doesn't check message length. Can we make this exploit sendmsg?
978 sendq "PRIVMSG #{where} :\001ACTION #{message}\001", chan, ring
981 irclog "* #{myself} #{message}", where
983 irclog "* #{myself}[#{where}] #{message}", where
987 # quick way to say "okay" (or equivalent) to +where+
989 say where, @lang.get("okay")
992 # log IRC-related message +message+ to a file determined by +where+.
993 # +where+ can be a channel name, or a nick for private message logging
994 def irclog(message, where="server")
995 message = message.chomp
996 stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
997 if where.class <= Server
1000 where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
1002 unless(@logs.has_key?(where_str))
1003 @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a")
1004 @logs[where_str].sync = true
1006 @logs[where_str].puts "[#{stamp}] #{message}"
1007 #debug "[#{stamp}] <#{where}> #{message}"
1010 # set topic of channel +where+ to +topic+
1011 def topic(where, topic)
1012 sendq "TOPIC #{where} :#{topic}", where, 2
1015 def disconnect(message = nil)
1016 message = @lang.get("quit") if (message.nil? || message.empty?)
1017 if @socket.connected?
1018 debug "Clearing socket"
1020 debug "Sending quit message"
1021 @socket.emergency_puts "QUIT :#{message}"
1022 debug "Flushing socket"
1024 debug "Shutting down socket"
1027 debug "Logging quits"
1028 server.channels.each { |ch|
1029 irclog "@ quit (#{message})", ch
1035 # disconnect from the server and cleanup all plugins and modules
1036 def shutdown(message = nil)
1037 @quit_mutex.synchronize do
1038 debug "Shutting down:"
1039 ## No we don't restore them ... let everything run through
1041 # trap("SIGINT", "DEFAULT")
1042 # trap("SIGTERM", "DEFAULT")
1043 # trap("SIGHUP", "DEFAULT")
1045 # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1047 debug "\tdisconnecting..."
1049 debug "\tsaving ..."
1051 debug "\tcleaning up ..."
1052 @save_mutex.synchronize do
1055 debug "\tstopping timers ..."
1057 # debug "Closing registries"
1059 debug "\t\tcleaning up the db environment ..."
1061 log "rbot quit (#{message})"
1065 # message:: optional IRC quit message
1066 # quit IRC, shutdown the bot
1067 def quit(message=nil)
1075 # totally shutdown and respawn the bot
1076 def restart(message = false)
1077 msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..."
1079 sleep @config['server.reconnect_wait']
1082 # Note, this fails on Windows
1083 debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1086 rescue Errno::ENOENT
1087 exec("ruby", *(@argv.unshift $0))
1088 rescue Exception => e
1094 # call the save method for all of the botmodules
1096 @save_mutex.synchronize do
1102 # call the rescan method for all of the botmodules
1104 @save_mutex.synchronize do
1110 # channel:: channel to join
1111 # key:: optional channel key if channel is +s
1113 def join(channel, key=nil)
1115 sendq "JOIN #{channel} :#{key}", channel, 2
1117 sendq "JOIN #{channel}", channel, 2
1122 def part(channel, message="")
1123 sendq "PART #{channel} :#{message}", channel, 2
1126 # attempt to change bot's nick to +name+
1128 sendq "NICK #{name}"
1132 def mode(channel, mode, target)
1133 sendq "MODE #{channel} #{mode} #{target}", channel, 2
1137 def kick(channel, user, msg)
1138 sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1141 # m:: message asking for help
1142 # topic:: optional topic help is requested for
1143 # respond to online help requests
1145 topic = nil if topic == ""
1148 helpstr = "help topics: "
1149 helpstr += @plugins.helptopics
1150 helpstr += " (help <topic> for more info)"
1152 unless(helpstr = @plugins.help(topic))
1153 helpstr = "no help for topic #{topic}"
1159 # returns a string describing the current status of the bot (uptime etc)
1161 secs_up = Time.new - @startup_time
1162 uptime = Utils.secs_to_string secs_up
1163 # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1164 return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1167 # We want to respond to a hung server in a timely manner. If nothing was received
1168 # in the user-selected timeout and we haven't PINGed the server yet, we PING
1169 # the server. If the PONG is not received within the user-defined timeout, we
1170 # assume we're in ping timeout and act accordingly.
1172 act_timeout = @config['server.ping_timeout']
1173 return if act_timeout <= 0
1175 if @last_rec && now > @last_rec + act_timeout
1177 # No previous PING pending, send a new one
1179 @last_ping = Time.now
1181 diff = now - @last_ping
1182 if diff > act_timeout
1183 debug "no PONG from server in #{diff} seconds, reconnecting"
1184 # the actual reconnect is handled in the main loop:
1185 raise TimeoutError, "no PONG from server in #{diff} seconds"
1191 def stop_server_pings
1192 # cancel previous PINGs and reset time of last RECV
1199 def irclogprivmsg(m)
1202 irclog "* [#{m.source}(#{m.sourceaddress})] #{m.message}", m.source
1204 irclog "* #{m.source} #{m.message}", m.target
1208 irclog "<#{m.source}> #{m.message}", m.target
1210 irclog "[#{m.source}(#{m.sourceaddress})] #{m.message}", m.source
1215 # log a message. Internal use only.
1216 def log_sent(type, where, message)
1221 irclog "-=#{myself}=- #{message}", where
1223 irclog "[-=#{where}=-] #{message}", where
1228 irclog "<#{myself}> #{message}", where
1230 irclog "[msg(#{where})] #{message}", where
1237 debug "joined channel #{m.channel}"
1238 irclog "@ Joined channel #{m.channel}", m.channel
1240 irclog "@ #{m.source} joined channel #{m.channel}", m.channel
1246 debug "left channel #{m.channel}"
1247 irclog "@ Left channel #{m.channel} (#{m.message})", m.channel
1249 irclog "@ #{m.source} left channel #{m.channel} (#{m.message})", m.channel
1255 debug "kicked from channel #{m.channel}"
1256 irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.message})", m.channel
1258 irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.message})", m.channel
1263 if m.source == myself
1264 irclog "@ I set topic \"#{m.topic}\"", m.channel
1266 irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel