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
16 def rawlog(level, message=nil, who_pos=1)
18 if call_stack.length > who_pos
19 who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
23 # Output each line. To distinguish between separate messages and multi-line
24 # messages originating at the same time, we blank #{who} after the first message
26 message.to_s.each_line { |l|
27 $logger.add(level, l.chomp, who)
33 $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
37 $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
40 def debug(message=nil, who_pos=1)
41 rawlog(Logger::Severity::DEBUG, message, who_pos)
44 def log(message=nil, who_pos=1)
45 rawlog(Logger::Severity::INFO, message, who_pos)
48 def warning(message=nil, who_pos=1)
49 rawlog(Logger::Severity::WARN, message, who_pos)
52 def error(message=nil, who_pos=1)
53 rawlog(Logger::Severity::ERROR, message, who_pos)
56 def fatal(message=nil, who_pos=1)
57 rawlog(Logger::Severity::FATAL, message, who_pos)
62 warning "warning test"
66 # The following global is used for the improved signal handling.
70 require 'rbot/rbotconfig'
72 # require 'rbot/utils'
75 require 'rbot/rfc2812'
76 require 'rbot/ircsocket'
77 require 'rbot/botuser'
79 require 'rbot/plugins'
80 # require 'rbot/channel'
81 require 'rbot/message'
82 require 'rbot/language'
84 require 'rbot/registry'
85 # require 'rbot/httputil'
89 # Main bot class, which manages the various components, receives messages,
90 # handles them or passes them to plugins, and contains core functionality.
92 # the bot's IrcAuth data
95 # the bot's BotConfig data
98 # the botclass for this bot (determines configdir among other things)
101 # used to perform actions periodically (saves configuration once per minute
105 # synchronize with this mutex while touching permanent data files:
106 # saving, flushing, cleaning up ...
107 attr_reader :save_mutex
109 # bot's Language data
116 # bot's object registry, plugins get an interface to this for persistant
117 # storage (hash interface tied to a bdb file, plugins use Accessors to store
118 # and restore objects in their own namespaces.)
119 attr_reader :registry
121 # bot's plugins. This is an instance of class Plugins
124 # bot's httputil help object, for fetching resources via http. Sets up
125 # proxies etc as defined by the bot configuration/environment
126 attr_reader :httputil
128 # server we are connected to
134 # bot User in the client/server connection
140 # bot User in the client/server connection
145 # create a new IrcBot with botclass +botclass+
146 def initialize(botclass, params = {})
147 # BotConfig for the core bot
148 # TODO should we split socket stuff into ircsocket, etc?
149 BotConfig.register BotConfigStringValue.new('server.name',
150 :default => "localhost", :requires_restart => true,
151 :desc => "What server should the bot connect to?",
153 BotConfig.register BotConfigIntegerValue.new('server.port',
154 :default => 6667, :type => :integer, :requires_restart => true,
155 :desc => "What port should the bot connect to?",
156 :validate => Proc.new {|v| v > 0}, :wizard => true)
157 BotConfig.register BotConfigBooleanValue.new('server.ssl',
158 :default => false, :requires_restart => true, :wizard => true,
159 :desc => "Use SSL to connect to this server?")
160 BotConfig.register BotConfigStringValue.new('server.password',
161 :default => false, :requires_restart => true,
162 :desc => "Password for connecting to this server (if required)",
164 BotConfig.register BotConfigStringValue.new('server.bindhost',
165 :default => false, :requires_restart => true,
166 :desc => "Specific local host or IP for the bot to bind to (if required)",
168 BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait',
169 :default => 5, :validate => Proc.new{|v| v >= 0},
170 :desc => "Seconds to wait before attempting to reconnect, on disconnect")
171 BotConfig.register BotConfigFloatValue.new('server.sendq_delay',
172 :default => 2.0, :validate => Proc.new{|v| v >= 0},
173 :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
174 :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
175 BotConfig.register BotConfigIntegerValue.new('server.sendq_burst',
176 :default => 4, :validate => Proc.new{|v| v >= 0},
177 :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines",
178 :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
179 BotConfig.register BotConfigIntegerValue.new('server.ping_timeout',
180 :default => 30, :validate => Proc.new{|v| v >= 0},
181 :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
183 BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot",
184 :desc => "IRC nickname the bot should attempt to use", :wizard => true,
185 :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
186 BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot",
187 :requires_restart => true,
188 :desc => "local user the bot should appear to be", :wizard => true)
189 BotConfig.register BotConfigArrayValue.new('irc.join_channels',
190 :default => [], :wizard => true,
191 :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'")
192 BotConfig.register BotConfigArrayValue.new('irc.ignore_users',
194 :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
196 BotConfig.register BotConfigIntegerValue.new('core.save_every',
197 :default => 60, :validate => Proc.new{|v| v >= 0},
198 :on_change => Proc.new { |bot, v|
201 @timer.reschedule(@save_timer, v)
202 @timer.unblock(@save_timer)
204 @timer.block(@save_timer)
208 @save_timer = @timer.add(v) { bot.save }
210 # Nothing to do when v == 0
213 :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
215 BotConfig.register BotConfigBooleanValue.new('core.run_as_daemon',
216 :default => false, :requires_restart => true,
217 :desc => "Should the bot run as a daemon?")
219 BotConfig.register BotConfigStringValue.new('log.file',
220 :default => false, :requires_restart => true,
221 :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
222 BotConfig.register BotConfigIntegerValue.new('log.level',
223 :default => 1, :requires_restart => false,
224 :validate => Proc.new { |v| (0..5).include?(v) },
225 :on_change => Proc.new { |bot, v|
228 :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
229 BotConfig.register BotConfigIntegerValue.new('log.keep',
230 :default => 1, :requires_restart => true,
231 :validate => Proc.new { |v| v >= 0 },
232 :desc => "How many old console messages logfiles to keep")
233 BotConfig.register BotConfigIntegerValue.new('log.max_size',
234 :default => 10, :requires_restart => true,
235 :validate => Proc.new { |v| v > 0 },
236 :desc => "Maximum console messages logfile size (in megabytes)")
238 @argv = params[:argv]
240 unless FileTest.directory? Config::coredir
241 error "core directory '#{Config::coredir}' not found, did you setup.rb?"
245 unless FileTest.directory? Config::datadir
246 error "data directory '#{Config::datadir}' not found, did you setup.rb?"
250 unless botclass and not botclass.empty?
251 # We want to find a sensible default.
252 # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
253 # * On Windows (at least the NT versions) we want to put our stuff in the
254 # Application Data folder.
255 # We don't use any particular O/S detection magic, exploiting the fact that
256 # Etc.getpwuid is nil on Windows
257 if Etc.getpwuid(Process::Sys.geteuid)
258 botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
260 if ENV.has_key?('APPDATA')
261 botclass = ENV['APPDATA'].dup
262 botclass.gsub!("\\","/")
267 botclass = File.expand_path(botclass)
268 @botclass = botclass.gsub(/\/$/, "")
270 unless FileTest.directory? botclass
271 log "no #{botclass} directory found, creating from templates.."
272 if FileTest.exist? botclass
273 error "file #{botclass} exists but isn't a directory"
276 FileUtils.cp_r Config::datadir+'/templates', botclass
279 Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
280 Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
281 Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
283 # Time at which the last PING was sent
285 # Time at which the last line was RECV'd from the server
288 @startup_time = Time.new
291 @config = BotConfig.configmanager
292 @config.bot_associate(self)
295 fatal e.backtrace.join("\n")
300 if @config['core.run_as_daemon']
304 @logfile = @config['log.file']
305 if @logfile.class!=String || @logfile.empty?
306 @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
309 # See http://blog.humlab.umu.se/samuel/archives/000107.html
310 # for the backgrounding code
316 rescue NotImplementedError
317 warning "Could not background, fork not supported"
319 warning "Could not background. #{e.inspect}"
322 # File.umask 0000 # Ensure sensible umask. Adjust as needed.
323 log "Redirecting standard input/output/error"
325 STDIN.reopen "/dev/null"
327 # On Windows, there's not such thing as /dev/null
330 def STDOUT.write(str=nil)
332 return str.to_s.length
334 def STDERR.write(str=nil)
335 if str.to_s.match(/:\d+: warning:/)
340 return str.to_s.length
344 # Set the new logfile and loglevel. This must be done after the daemonizing
345 $logger = Logger.new(@logfile, @config['log.keep'], @config['log.max_size']*1024*1024)
346 $logger.datetime_format= $dateformat
347 $logger.level = @config['log.level']
348 $logger.level = $cl_loglevel if $cl_loglevel
349 $logger.level = 0 if $debug
353 @registry = BotRegistry.new self
355 @timer = Timer::Timer.new(1.0) # only need per-second granularity
356 @save_mutex = Mutex.new
357 if @config['core.save_every'] > 0
358 @save_timer = @timer.add(@config['core.save_every']) { save }
362 @quit_mutex = Mutex.new
367 @lang = Language::Language.new(self, @config['core.language'])
370 @auth = Auth::authmanager
371 @auth.bot_associate(self)
372 # @auth.load("#{botclass}/botusers.yaml")
375 fatal e.backtrace.join("\n")
379 @auth.everyone.set_default_permission("*", true)
380 @auth.botowner.password= @config['auth.password']
382 Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
383 @plugins = Plugins::pluginmanager
384 @plugins.bot_associate(self)
385 @plugins.add_botmodule_dir(Config::coredir + "/utils")
386 @plugins.add_botmodule_dir(Config::coredir)
387 @plugins.add_botmodule_dir("#{botclass}/plugins")
388 @plugins.add_botmodule_dir(Config::datadir + "/plugins")
391 Utils.set_safe_save_dir("#{botclass}/safe_save")
392 @httputil = Utils::HttpUtil.new(self)
395 @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
396 @client = IrcClient.new
397 myself.nick = @config['irc.nick']
399 # Channels where we are quiet
400 # It's nil when we are not quiet, an empty list when we are quiet
401 # in all channels, a list of channels otherwise
404 @client[:welcome] = proc {|data|
405 irclog "joined server #{@client.server} as #{myself}", "server"
407 @plugins.delegate("connect")
409 @config['irc.join_channels'].each { |c|
410 debug "autojoining channel #{c}"
411 if(c =~ /^(\S+)\s+(\S+)$/i)
419 # TODO the next two @client should go into rfc2812.rb, probably
420 # Since capabs are two-steps processes, server.supports[:capab]
421 # should be a three-state: nil, [], [....]
422 asked_for = { :"identify-msg" => false }
423 @client[:isupport] = proc { |data|
424 if server.supports[:capab] and !asked_for[:"identify-msg"]
425 sendq "CAPAB IDENTIFY-MSG"
426 asked_for[:"identify-msg"] = true
429 @client[:datastr] = proc { |data|
430 if data[:text] == "IDENTIFY-MSG"
431 server.capabilities[:"identify-msg"] = true
433 debug "Not handling RPL_DATASTR #{data[:servermessage]}"
437 @client[:privmsg] = proc { |data|
438 m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
439 # debug "Message source is #{data[:source].inspect}"
440 # debug "Message target is #{data[:target].inspect}"
441 # debug "Bot is #{myself.inspect}"
444 @config['irc.ignore_users'].each { |mask|
445 if m.source.matches?(server.new_netmask(mask))
454 @plugins.delegate "listen", m
455 @plugins.privmsg(m) if m.address?
458 @client[:notice] = proc { |data|
459 message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
460 # pass it off to plugins that want to hear everything
461 @plugins.delegate "listen", message
463 @client[:motd] = proc { |data|
464 data[:motd].each_line { |line|
465 irclog "MOTD: #{line}", "server"
468 @client[:nicktaken] = proc { |data|
469 nickchg "#{data[:nick]}_"
470 @plugins.delegate "nicktaken", data[:nick]
472 @client[:badnick] = proc {|data|
473 warning "bad nick (#{data[:nick]})"
475 @client[:ping] = proc {|data|
476 sendq "PONG #{data[:pingid]}"
478 @client[:pong] = proc {|data|
481 @client[:nick] = proc {|data|
482 source = data[:source]
485 m = NickMessage.new(self, server, source, old, new)
487 debug "my nick is now #{new}"
489 data[:is_on].each { |ch|
490 irclog "@ #{old} is now known as #{new}", ch
492 @plugins.delegate("listen", m)
493 @plugins.delegate("nick", m)
495 @client[:quit] = proc {|data|
496 source = data[:source]
497 message = data[:message]
498 m = QuitMessage.new(self, server, source, source, message)
499 data[:was_on].each { |ch|
500 irclog "@ Quit: #{source}: #{message}", ch
502 @plugins.delegate("listen", m)
503 @plugins.delegate("quit", m)
505 @client[:mode] = proc {|data|
506 irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
508 @client[:join] = proc {|data|
509 m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
512 @plugins.delegate("listen", m)
513 @plugins.delegate("join", m)
515 @client[:part] = proc {|data|
516 m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
519 @plugins.delegate("listen", m)
520 @plugins.delegate("part", m)
522 @client[:kick] = proc {|data|
523 m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
526 @plugins.delegate("listen", m)
527 @plugins.delegate("kick", m)
529 @client[:invite] = proc {|data|
530 if data[:target] == myself
531 join data[:channel] if @auth.allow?("join", data[:source], data[:source].nick)
534 @client[:changetopic] = proc {|data|
535 m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
538 @plugins.delegate("listen", m)
539 @plugins.delegate("topic", m)
541 @client[:topic] = proc { |data|
542 irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
544 @client[:topicinfo] = proc { |data|
545 channel = data[:channel]
546 topic = channel.topic
547 irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
548 m = TopicMessage.new(self, server, data[:source], channel, topic)
550 @plugins.delegate("listen", m)
551 @plugins.delegate("topic", m)
553 @client[:names] = proc { |data|
554 @plugins.delegate "names", data[:channel], data[:users]
556 @client[:unknown] = proc { |data|
557 #debug "UNKNOWN: #{data[:serverstring]}"
558 irclog data[:serverstring], ".unknown"
561 set_default_send_options
564 def set_default_send_options
565 # Default send options for NOTICE and PRIVMSG
566 # TODO document, for plugin writers
567 # TODO some of these options, like :truncate_text and :max_lines,
568 # should be made into config variables that trigger this routine on change
569 @default_send_options = {
570 :queue_channel => nil, # use default queue channel
571 :queue_ring => nil, # use default queue ring
572 :newlines => :split, # or :join
573 :join_with => ' ', # by default, use a single space
574 :max_lines => nil, # maximum number of lines to send with a single command
575 :overlong => :split, # or :truncate
576 # TODO an array of splitpoints would be preferrable for this option:
577 :split_at => /\s+/, # by default, split overlong lines at whitespace
578 :purge_split => true, # should the split string be removed?
579 :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
583 # checks if we should be quiet on a channel
584 def quiet_on?(channel)
585 return false unless @quiet
586 return true if @quiet.empty?
587 return @quiet.include?(channel.to_s)
590 def set_quiet(channel=nil)
592 @quiet << channel.to_s unless @quiet.include?(channel.to_s)
598 def reset_quiet(channel=nil)
600 @quiet.delete_if { |x| x == channel.to_s }
606 # things to do when we receive a signal
608 debug "received #{sig}, queueing quit"
610 quit unless @quit_mutex.locked?
611 debug "interrupted #{$interrupted} times"
619 # connect the bot to IRC
622 trap("SIGINT") { got_sig("SIGINT") }
623 trap("SIGTERM") { got_sig("SIGTERM") }
624 trap("SIGHUP") { got_sig("SIGHUP") }
625 rescue ArgumentError => e
626 debug "failed to trap signals (#{e.inspect}): running on Windows?"
628 debug "failed to trap signals: #{e.inspect}"
631 quit if $interrupted > 0
634 raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e
636 quit if $interrupted > 0
637 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
638 @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert"
639 quit if $interrupted > 0
642 # begin event handling loop
646 quit if $interrupted > 0
650 while @socket.connected?
651 quit if $interrupted > 0
653 # Wait for messages and process them as they arrive. If nothing is
654 # received, we call the ping_server() method that will PING the
655 # server if appropriate, or raise a TimeoutError if no PONG has been
656 # received in the user-chosen timeout since the last PING sent.
658 break unless reply = @socket.gets
660 @client.process reply
666 # I despair of this. Some of my users get "connection reset by peer"
667 # exceptions that ARENT SocketError's. How am I supposed to handle
672 rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
673 error "network exception: #{e.class}: #{e}"
674 debug e.backtrace.join("\n")
675 rescue BDB::Fatal => e
676 fatal "fatal bdb error: #{e.class}: #{e}"
677 fatal e.backtrace.join("\n")
679 # Why restart? DB problems are serious stuff ...
680 # restart("Oops, we seem to have registry problems ...")
683 rescue Exception => e
684 error "non-net exception: #{e.class}: #{e}"
685 error e.backtrace.join("\n")
687 fatal "unexpected exception: #{e.class}: #{e}"
688 fatal e.backtrace.join("\n")
695 if @socket.connected?
702 quit if $interrupted > 0
704 log "waiting to reconnect"
705 sleep @config['server.reconnect_wait']
709 # type:: message type
710 # where:: message target
711 # message:: message text
712 # send message +message+ of type +type+ to target +where+
713 # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
714 # relevant say() or notice() methods. This one should be used for IRCd
715 # extensions you want to use in modules.
716 def sendmsg(type, where, original_message, options={})
717 opts = @default_send_options.merge(options)
719 # For starters, set up appropriate queue channels and rings
720 mchan = opts[:queue_channel]
721 mring = opts[:queue_ring]
738 message = original_message.to_s.gsub(/[\r\n]+/, "\n")
741 lines = [message.gsub("\n", opts[:join_with])]
744 message.each_line { |line|
746 next unless(line.length > 0)
750 raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
753 # The IRC protocol requires that each raw message must be not longer
754 # than 512 characters. From this length with have to subtract the EOL
755 # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
756 # that will be prepended by the server to all of our messages.
758 # The maximum raw message length we can send is therefore 512 - 2 - 2
759 # minus the length of our hostmask.
761 max_len = 508 - myself.fullform.length
763 # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
764 # will have a + or - prepended
765 if server.capabilities[:"identify-msg"]
769 # When splitting the message, we'll be prefixing the following string:
770 # (e.g. "PRIVMSG #rbot :")
771 fixed = "#{type} #{where} :"
773 # And this is what's left
774 left = max_len - fixed.length
779 split_at = opts[:split_at]
781 truncate = opts[:truncate_text]
782 truncate = @default_send_options[:truncate_text] if truncate.length > left
783 truncate = "" if truncate.length > left
785 raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
788 # Counter to check the number of lines sent by this command
790 max_lines = opts[:max_lines]
795 if max_lines and cmd_lines == max_lines - 1
796 debug "Max lines count reached for message #{original_message.inspect} while sending #{msg.inspect}, truncating"
797 truncate = opts[:truncate_text]
798 truncate = @default_send_options[:truncate_text] if truncate.length > left
799 truncate = "" if truncate.length > left
802 if(left >= msg.length) and not maxed
803 sendq "#{fixed}#{msg}", chan, ring
804 log_sent(type, where, msg)
808 line.replace msg.slice(0, left-truncate.length)
809 line.sub!(/\s+\S*$/, truncate)
810 raise "PROGRAMMER ERROR! #{line.inspect} of length #{line.length} > #{left}" if line.length > left
811 sendq "#{fixed}#{line}", chan, ring
812 log_sent(type, where, line)
815 line.replace msg.slice!(0, left)
816 lastspace = line.rindex(opts[:split_at])
818 msg.replace line.slice!(lastspace, line.length) + msg
819 msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
821 sendq "#{fixed}#{line}", chan, ring
822 log_sent(type, where, line)
823 end while(msg.length > 0)
828 # queue an arbitraty message for the server
829 def sendq(message="", chan=nil, ring=0)
831 @socket.queue(message, chan, ring)
834 # send a notice message to channel/nick +where+
835 def notice(where, message, options={})
836 unless quiet_on?(where)
837 sendmsg "NOTICE", where, message, options
841 # say something (PRIVMSG) to channel/nick +where+
842 def say(where, message, options={})
843 unless quiet_on?(where)
844 sendmsg "PRIVMSG", where, message, options
848 # perform a CTCP action with message +message+ to channel/nick +where+
849 def action(where, message, options={})
850 mchan = options.fetch(:queue_channel, nil)
851 mring = options.fetch(:queue_ring, nil)
867 # FIXME doesn't check message length. Can we make this exploit sendmsg?
868 sendq "PRIVMSG #{where} :\001ACTION #{message}\001", chan, ring
871 irclog "* #{myself} #{message}", where
873 irclog "* #{myself}[#{where}] #{message}", where
877 # quick way to say "okay" (or equivalent) to +where+
879 say where, @lang.get("okay")
882 # log IRC-related message +message+ to a file determined by +where+.
883 # +where+ can be a channel name, or a nick for private message logging
884 def irclog(message, where="server")
885 message = message.chomp
886 stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
887 where = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
888 unless(@logs.has_key?(where))
889 @logs[where] = File.new("#{@botclass}/logs/#{where}", "a")
890 @logs[where].sync = true
892 @logs[where].puts "[#{stamp}] #{message}"
893 #debug "[#{stamp}] <#{where}> #{message}"
896 # set topic of channel +where+ to +topic+
897 def topic(where, topic)
898 sendq "TOPIC #{where} :#{topic}", where, 2
901 # disconnect from the server and cleanup all plugins and modules
902 def shutdown(message = nil)
903 @quit_mutex.synchronize do
904 debug "Shutting down ..."
905 ## No we don't restore them ... let everything run through
907 # trap("SIGINT", "DEFAULT")
908 # trap("SIGTERM", "DEFAULT")
909 # trap("SIGHUP", "DEFAULT")
911 # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
913 message = @lang.get("quit") if (message.nil? || message.empty?)
914 if @socket.connected?
915 debug "Clearing socket"
917 debug "Sending quit message"
918 @socket.emergency_puts "QUIT :#{message}"
919 debug "Flushing socket"
921 debug "Shutting down socket"
924 debug "Logging quits"
925 server.channels.each { |ch|
926 irclog "@ quit (#{message})", ch
931 @save_mutex.synchronize do
934 # debug "Closing registries"
936 debug "Cleaning up the db environment"
938 log "rbot quit (#{message})"
942 # message:: optional IRC quit message
943 # quit IRC, shutdown the bot
944 def quit(message=nil)
952 # totally shutdown and respawn the bot
953 def restart(message = false)
954 msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..."
956 sleep @config['server.reconnect_wait']
958 # Note, this fails on Windows
962 # call the save method for all of the botmodules
964 @save_mutex.synchronize do
970 # call the rescan method for all of the botmodules
972 @save_mutex.synchronize do
978 # channel:: channel to join
979 # key:: optional channel key if channel is +s
981 def join(channel, key=nil)
983 sendq "JOIN #{channel} :#{key}", channel, 2
985 sendq "JOIN #{channel}", channel, 2
990 def part(channel, message="")
991 sendq "PART #{channel} :#{message}", channel, 2
994 # attempt to change bot's nick to +name+
1000 def mode(channel, mode, target)
1001 sendq "MODE #{channel} #{mode} #{target}", channel, 2
1005 def kick(channel, user, msg)
1006 sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1009 # m:: message asking for help
1010 # topic:: optional topic help is requested for
1011 # respond to online help requests
1013 topic = nil if topic == ""
1016 helpstr = "help topics: "
1017 helpstr += @plugins.helptopics
1018 helpstr += " (help <topic> for more info)"
1020 unless(helpstr = @plugins.help(topic))
1021 helpstr = "no help for topic #{topic}"
1027 # returns a string describing the current status of the bot (uptime etc)
1029 secs_up = Time.new - @startup_time
1030 uptime = Utils.secs_to_string secs_up
1031 # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1032 return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1035 # We want to respond to a hung server in a timely manner. If nothing was received
1036 # in the user-selected timeout and we haven't PINGed the server yet, we PING
1037 # the server. If the PONG is not received within the user-defined timeout, we
1038 # assume we're in ping timeout and act accordingly.
1040 act_timeout = @config['server.ping_timeout']
1041 return if act_timeout <= 0
1043 if @last_rec && now > @last_rec + act_timeout
1045 # No previous PING pending, send a new one
1047 @last_ping = Time.now
1049 diff = now - @last_ping
1050 if diff > act_timeout
1051 debug "no PONG from server in #{diff} seconds, reconnecting"
1052 # the actual reconnect is handled in the main loop:
1053 raise TimeoutError, "no PONG from server in #{diff} seconds"
1059 def stop_server_pings
1060 # cancel previous PINGs and reset time of last RECV
1067 def irclogprivmsg(m)
1070 irclog "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
1072 irclog "* #{m.sourcenick} #{m.message}", m.target
1076 irclog "<#{m.sourcenick}> #{m.message}", m.target
1078 irclog "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
1083 # log a message. Internal use only.
1084 def log_sent(type, where, message)
1089 irclog "-=#{myself}=- #{message}", where
1091 irclog "[-=#{where}=-] #{message}", where
1096 irclog "<#{myself}> #{message}", where
1098 irclog "[msg(#{where})] #{message}", where
1105 debug "joined channel #{m.channel}"
1106 irclog "@ Joined channel #{m.channel}", m.channel
1108 irclog "@ #{m.sourcenick} joined channel #{m.channel}", m.channel
1114 debug "left channel #{m.channel}"
1115 irclog "@ Left channel #{m.channel} (#{m.message})", m.channel
1117 irclog "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel
1123 debug "kicked from channel #{m.channel}"
1124 irclog "@ You have been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
1126 irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
1131 if m.source == myself
1132 irclog "@ I set topic \"#{m.topic}\"", m.channel
1134 irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel