15 unless Kernel.respond_to? :pretty_inspect
19 public :pretty_inspect
24 q.group(1, "#<%s: %s" % [self.class, self.message], ">") {
25 if self.backtrace and not self.backtrace.empty?
27 q.seplist(self.backtrace, lambda { q.text "\n" } ) { |l| q.text l }
33 class ServerError < RuntimeError
36 # The following global is used for the improved signal handling.
41 require 'rbot/rbotconfig'
42 require 'rbot/load-gettext'
45 require 'rbot/rfc2812'
46 require 'rbot/ircsocket'
47 require 'rbot/botuser'
49 require 'rbot/registry'
50 require 'rbot/plugins'
51 require 'rbot/message'
52 require 'rbot/language'
53 require 'rbot/httputil'
57 # Main bot class, which manages the various components, receives messages,
58 # handles them or passes them to plugins, and contains core functionality.
60 COPYRIGHT_NOTICE = "(c) Giuseppe Bilotta and the rbot development team"
61 SOURCE_URL = "https://ruby-rbot.org"
65 # the bot's Config data
68 # the botclass for this bot (determines configdir among other things)
71 # used to perform actions periodically (saves configuration once per minute
75 # synchronize with this mutex while touching permanent data files:
76 # saving, flushing, cleaning up ...
77 attr_reader :save_mutex
86 # bot's plugins. This is an instance of class Plugins
89 # bot's httputil helper object, for fetching resources via http. Sets up
90 # proxies etc as defined by the bot configuration/environment
91 attr_accessor :httputil
93 # mechanize agent factory
96 # loads and opens new registry databases, used by the plugins
97 attr_accessor :registry_factory
100 attr_accessor :webservice
102 # server we are connected to
108 # bot User in the client/server connection
114 # bot nick in the client/server connection
119 # bot channels in the client/server connection
124 # nick wanted by the bot. This defaults to the irc.nick config value,
125 # but may be overridden by a manual !nick command
127 @wanted_nick || config['irc.nick']
130 # set the nick wanted by the bot
132 if wn.nil? or wn.to_s.downcase == config['irc.nick'].downcase
135 @wanted_nick = wn.to_s.dup
143 ret = self.to_s[0..-2]
144 ret << ' version=' << $version.inspect
145 ret << ' botclass=' << botclass.inspect
146 ret << ' lang="' << lang.language
151 ret << ' nick=' << nick.inspect
154 ret << (server.to_s + (socket ?
155 ' [' << socket.server_uri.to_s << ']' : '')).inspect
156 unless server.channels.empty?
158 ret << server.channels.map { |c|
159 "%s%s" % [c.modes_of(nick).map { |m|
160 server.prefix_for_mode(m)
167 ret << ' plugins=' << plugins.inspect
172 # create a new Bot with botclass +botclass+
173 def initialize(botclass, params = {})
174 # Config for the core bot
175 # TODO should we split socket stuff into ircsocket, etc?
176 Config.register Config::ArrayValue.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 Config.register Config::BooleanValue.new('server.ssl',
181 :default => false, :requires_restart => true, :wizard => true,
182 :desc => "Use SSL to connect to this server?")
183 Config.register Config::BooleanValue.new('server.ssl_verify',
184 :default => false, :requires_restart => true,
185 :desc => "Verify the SSL connection?",
187 Config.register Config::StringValue.new('server.ssl_ca_file',
188 :default => default_ssl_ca_file, :requires_restart => true,
189 :desc => "The CA file used to verify the SSL connection.",
191 Config.register Config::StringValue.new('server.ssl_ca_path',
192 :default => default_ssl_ca_path, :requires_restart => true,
193 :desc => "Alternativly a directory that includes CA PEM files used to verify the SSL connection.",
195 Config.register Config::StringValue.new('server.password',
196 :default => false, :requires_restart => true,
197 :desc => "Password for connecting to this server (if required)",
199 Config.register Config::StringValue.new('server.bindhost',
200 :default => false, :requires_restart => true,
201 :desc => "Specific local host or IP for the bot to bind to (if required)",
203 Config.register Config::IntegerValue.new('server.reconnect_wait',
204 :default => 5, :validate => Proc.new{|v| v >= 0},
205 :desc => "Seconds to wait before attempting to reconnect, on disconnect")
206 Config.register Config::IntegerValue.new('server.ping_timeout',
207 :default => 30, :validate => Proc.new{|v| v >= 0},
208 :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
209 Config.register Config::ArrayValue.new('server.nocolor_modes',
210 :default => ['c'], :wizard => false,
211 :requires_restart => false,
212 :desc => "List of channel modes that require messages to be without colors")
214 Config.register Config::StringValue.new('irc.nick', :default => "rbot",
215 :desc => "IRC nickname the bot should attempt to use", :wizard => true,
216 :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
217 Config.register Config::StringValue.new('irc.name',
218 :default => "Ruby bot", :requires_restart => true,
219 :desc => "IRC realname the bot should use")
220 Config.register Config::BooleanValue.new('irc.name_copyright',
221 :default => true, :requires_restart => true,
222 :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
223 Config.register Config::StringValue.new('irc.user', :default => "rbot",
224 :requires_restart => true,
225 :desc => "local user the bot should appear to be", :wizard => true)
226 Config.register Config::ArrayValue.new('irc.join_channels',
227 :default => [], :wizard => true,
228 :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'")
229 Config.register Config::ArrayValue.new('irc.ignore_users',
231 :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
232 Config.register Config::ArrayValue.new('irc.ignore_channels',
234 :desc => "Which channels to ignore input in. This is mainly to turn the bot into a logbot that doesn't interact with users in any way (in the specified channels)")
236 Config.register Config::IntegerValue.new('core.save_every',
237 :default => 60, :validate => Proc.new{|v| v >= 0},
238 :on_change => Proc.new { |bot, v|
241 @timer.reschedule(@save_timer, v)
242 @timer.unblock(@save_timer)
244 @timer.block(@save_timer)
248 @save_timer = @timer.add(v) { bot.save }
250 # Nothing to do when v == 0
253 :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
255 Config.register Config::BooleanValue.new('core.run_as_daemon',
256 :default => false, :requires_restart => true,
257 :desc => "Should the bot run as a daemon?")
259 Config.register Config::StringValue.new('log.file',
260 :default => false, :requires_restart => true,
261 :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
262 Config.register Config::IntegerValue.new('log.level',
263 :default => 1, :requires_restart => false,
264 :validate => Proc.new { |v| (0..5).include?(v) },
265 :on_change => Proc.new { |bot, v|
266 LoggerManager.instance.set_level(v)
268 :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
269 Config.register Config::IntegerValue.new('log.keep',
270 :default => 1, :requires_restart => true,
271 :validate => Proc.new { |v| v >= 0 },
272 :desc => "How many old console messages logfiles to keep")
273 Config.register Config::IntegerValue.new('log.max_size',
274 :default => 10, :requires_restart => true,
275 :validate => Proc.new { |v| v > 0 },
276 :desc => "Maximum console messages logfile size (in megabytes)")
278 Config.register Config::ArrayValue.new('plugins.path',
279 :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
280 :requires_restart => false,
281 :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
282 :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")
284 Config.register Config::EnumValue.new('send.newlines',
285 :values => ['split', 'join'], :default => 'split',
286 :on_change => Proc.new { |bot, v|
287 bot.set_default_send_options :newlines => v.to_sym
289 :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")
290 Config.register Config::StringValue.new('send.join_with',
292 :on_change => Proc.new { |bot, v|
293 bot.set_default_send_options :join_with => v.dup
295 :desc => "String used to replace newlines when send.newlines is set to join")
296 Config.register Config::IntegerValue.new('send.max_lines',
298 :validate => Proc.new { |v| v >= 0 },
299 :on_change => Proc.new { |bot, v|
300 bot.set_default_send_options :max_lines => v
302 :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
303 Config.register Config::EnumValue.new('send.overlong',
304 :values => ['split', 'truncate'], :default => 'split',
305 :on_change => Proc.new { |bot, v|
306 bot.set_default_send_options :overlong => v.to_sym
308 :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")
309 Config.register Config::StringValue.new('send.split_at',
311 :on_change => Proc.new { |bot, v|
312 bot.set_default_send_options :split_at => Regexp.new(v)
314 :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
315 Config.register Config::BooleanValue.new('send.purge_split',
317 :on_change => Proc.new { |bot, v|
318 bot.set_default_send_options :purge_split => v
320 :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
321 Config.register Config::StringValue.new('send.truncate_text',
322 :default => "#{Reverse}...#{Reverse}",
323 :on_change => Proc.new { |bot, v|
324 bot.set_default_send_options :truncate_text => v.dup
326 :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")
327 Config.register Config::IntegerValue.new('send.penalty_pct',
329 :validate => Proc.new { |v| v >= 0 },
330 :on_change => Proc.new { |bot, v|
331 bot.socket.penalty_pct = v
333 :desc => "Percentage of IRC penalty to consider when sending messages to prevent being disconnected for excess flood. Set to 0 to disable penalty control.")
334 Config.register Config::StringValue.new('core.db',
335 :default => default_db, :store_default => true,
337 :validate => Proc.new { |v| Registry::formats.include? v },
338 :requires_restart => true,
339 :desc => "DB adaptor to use for storing the plugin data/registries. Options: " + Registry::formats.join(', '))
341 @argv = params[:argv]
342 @run_dir = params[:run_dir] || Dir.pwd
344 unless FileTest.directory? Config::coredir
345 error "core directory '#{Config::coredir}' not found, did you setup.rb?"
349 unless FileTest.directory? Config::datadir
350 error "data directory '#{Config::datadir}' not found, did you setup.rb?"
354 unless botclass and not botclass.empty?
355 # We want to find a sensible default.
356 # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
357 # * On Windows (at least the NT versions) we want to put our stuff in the
358 # Application Data folder.
359 # We don't use any particular O/S detection magic, exploiting the fact that
360 # Etc.getpwuid is nil on Windows
361 if Etc.getpwuid(Process::Sys.geteuid)
362 botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
364 if ENV.has_key?('APPDATA')
365 botclass = ENV['APPDATA'].dup
366 botclass.gsub!("\\","/")
369 botclass = File.join(botclass, ".rbot")
371 botclass = File.expand_path(botclass)
372 @botclass = botclass.gsub(/\/$/, "")
374 repopulate_botclass_directory
376 # Time at which the last PING was sent
378 # Time at which the last line was RECV'd from the server
381 @startup_time = Time.new
384 @config = Config.manager
385 @config.bot_associate(self)
386 rescue Exception => e
391 if @config['core.run_as_daemon']
395 @registry_factory = Registry.new @config['core.db']
396 @registry_factory.migrate_registry_folder(path)
398 @logfile = @config['log.file']
399 if @logfile.class != String || @logfile.empty?
400 logfname = File.basename(botclass).gsub(/^\.+/,'')
402 @logfile = File.join(botclass, logfname)
403 debug "Using `#{@logfile}' as debug log"
406 LoggerManager.instance.flush
408 # See http://blog.humlab.umu.se/samuel/archives/000107.html
409 # for the backgrounding code
415 rescue NotImplementedError
416 warning "Could not background, fork not supported"
419 rescue Exception => e
420 warning "Could not background. #{e.pretty_inspect}"
423 # File.umask 0000 # Ensure sensible umask. Adjust as needed.
426 # setup logger based on bot configuration, if not set from the command line
427 loglevel_set = $opts.has_key?('debug') or $opts.has_key?('loglevel')
428 LoggerManager.instance.set_level(@config['log.level']) unless loglevel_set
431 LoggerManager.instance.set_logfile(@logfile, @config['log.keep'], @config['log.max_size'])
434 log "Redirecting standard input/output/error, console logger disabled"
435 LoggerManager.instance.flush
436 LoggerManager.instance.disable_console_logger
438 [$stdin, $stdout, $stderr].each do |fd|
440 fd.reopen "/dev/null"
442 # On Windows, there's not such thing as /dev/null
447 def $stdout.write(str=nil)
451 def $stderr.write(str=nil)
452 if str.to_s.match(/:\d+: warning:/)
460 LoggerManager.instance.log_session_start
463 File.open($opts['pidfile'] || File.join(@botclass, 'rbot.pid'), 'w') do |pf|
468 @save_mutex = Mutex.new
469 if @config['core.save_every'] > 0
470 @save_timer = @timer.add(@config['core.save_every']) { save }
474 @quit_mutex = Mutex.new
477 @lang = Language.new(self, @config['core.language'])
478 @httputil = Utils::HttpUtil.new(self)
481 @auth = Auth::manager
482 @auth.bot_associate(self)
483 # @auth.load("#{botclass}/botusers.yaml")
484 rescue Exception => e
488 @auth.everyone.set_default_permission("*", true)
489 @auth.botowner.password= @config['auth.password']
491 @plugins = Plugins::manager
492 @plugins.bot_associate(self)
495 if @config['server.name']
496 debug "upgrading configuration (server.name => server.list)"
497 srv_uri = 'irc://' + @config['server.name']
498 srv_uri += ":#{@config['server.port']}" if @config['server.port']
499 @config.items['server.list'.to_sym].set_string(srv_uri)
500 @config.delete('server.name'.to_sym)
501 @config.delete('server.port'.to_sym)
502 debug "server.list is now #{@config['server.list'].inspect}"
505 @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'],
506 :ssl => @config['server.ssl'],
507 :ssl_verify => @config['server.ssl_verify'],
508 :ssl_ca_file => @config['server.ssl_ca_file'],
509 :ssl_ca_path => @config['server.ssl_ca_path'],
510 :penalty_pct => @config['send.penalty_pct'])
515 # Channels where we are quiet
516 # Array of channels names where the bot should be quiet
517 # '*' means all channels
520 # but we always speak here
523 # the nick we want, if it's different from the irc.nick config value
524 # (e.g. as set by a !nick command)
527 @client[:welcome] = proc {|data|
528 m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])
530 @plugins.delegate("welcome", m)
531 @plugins.delegate("connect")
534 # TODO the next two @client should go into rfc2812.rb, probably
535 # Since capabs are two-steps processes, server.supports[:capab]
536 # should be a three-state: nil, [], [....]
537 asked_for = { :"identify-msg" => false }
538 @client[:isupport] = proc { |data|
539 if server.supports[:capab] and !asked_for[:"identify-msg"]
540 sendq "CAPAB IDENTIFY-MSG"
541 asked_for[:"identify-msg"] = true
544 @client[:datastr] = proc { |data|
545 if data[:text] == "IDENTIFY-MSG"
546 server.capabilities[:"identify-msg"] = true
548 debug "Not handling RPL_DATASTR #{data[:servermessage]}"
552 @client[:privmsg] = proc { |data|
553 m = PrivMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
554 # debug "Message source is #{data[:source].inspect}"
555 # debug "Message target is #{data[:target].inspect}"
556 # debug "Bot is #{myself.inspect}"
558 @config['irc.ignore_channels'].each { |channel|
559 if m.target.downcase == channel.downcase
564 @config['irc.ignore_users'].each { |mask|
565 if m.source.matches?(server.new_netmask(mask))
571 @plugins.irc_delegate('privmsg', m)
573 @client[:notice] = proc { |data|
574 message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
575 # pass it off to plugins that want to hear everything
576 @plugins.irc_delegate "notice", message
578 @client[:motd] = proc { |data|
579 m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd])
580 @plugins.delegate "motd", m
582 @client[:nicktaken] = proc { |data|
583 new = "#{data[:nick]}_"
585 # If we're setting our nick at connection because our choice was taken,
586 # we have to fix our nick manually, because there will be no NICK message
587 # to inform us that our nick has been changed.
588 if data[:target] == '*'
589 debug "setting my connection nick to #{new}"
590 @client.user.nick = new
592 @plugins.delegate "nicktaken", data[:nick]
594 @client[:badnick] = proc {|data|
595 warning "bad nick (#{data[:nick]})"
597 @client[:ping] = proc {|data|
598 sendq "PONG #{data[:pingid]}"
600 @client[:pong] = proc {|data|
603 @client[:nick] = proc {|data|
604 # debug "Message source is #{data[:source].inspect}"
605 # debug "Bot is #{myself.inspect}"
606 source = data[:source]
609 m = NickMessage.new(self, server, source, old, new)
610 m.is_on = data[:is_on]
612 debug "my nick is now #{new}"
614 @plugins.irc_delegate("nick", m)
616 @client[:quit] = proc {|data|
617 source = data[:source]
618 message = data[:message]
619 m = QuitMessage.new(self, server, source, source, message)
620 m.was_on = data[:was_on]
621 @plugins.irc_delegate("quit", m)
623 @client[:mode] = proc {|data|
624 m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
625 m.modes = data[:modes]
626 @plugins.delegate "modechange", m
628 @client[:whois] = proc {|data|
629 source = data[:source]
630 target = server.get_user(data[:whois][:nick])
631 m = WhoisMessage.new(self, server, source, target, data[:whois])
632 @plugins.delegate "whois", m
634 @client[:list] = proc {|data|
635 source = data[:source]
636 m = ListMessage.new(self, server, source, source, data[:list])
637 @plugins.delegate "irclist", m
639 @client[:join] = proc {|data|
640 m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
641 sendq("MODE #{data[:channel]}", nil, 0) if m.address?
642 @plugins.irc_delegate("join", m)
643 sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
645 @client[:part] = proc {|data|
646 m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
647 @plugins.irc_delegate("part", m)
649 @client[:kick] = proc {|data|
650 m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
651 @plugins.irc_delegate("kick", m)
653 @client[:invite] = proc {|data|
654 m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
655 @plugins.irc_delegate("invite", m)
657 @client[:changetopic] = proc {|data|
658 m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
660 @plugins.irc_delegate("topic", m)
662 # @client[:topic] = proc { |data|
663 # irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
665 @client[:topicinfo] = proc { |data|
666 channel = data[:channel]
667 topic = channel.topic
668 m = TopicMessage.new(self, server, data[:source], channel, topic)
669 m.info_or_set = :info
670 @plugins.irc_delegate("topic", m)
672 @client[:names] = proc { |data|
673 m = NamesMessage.new(self, server, server, data[:channel])
674 m.users = data[:users]
675 @plugins.delegate "names", m
677 @client[:banlist] = proc { |data|
678 m = BanlistMessage.new(self, server, server, data[:channel])
680 @plugins.delegate "banlist", m
682 @client[:nosuchtarget] = proc { |data|
683 m = NoSuchTargetMessage.new(self, server, server, data[:target], data[:message])
684 @plugins.delegate "nosuchtarget", m
686 @client[:error] = proc { |data|
687 raise ServerError, data[:message]
689 @client[:unknown] = proc { |data|
690 #debug "UNKNOWN: #{data[:serverstring]}"
691 m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
692 @plugins.delegate "unknown_message", m
695 set_default_send_options :newlines => @config['send.newlines'].to_sym,
696 :join_with => @config['send.join_with'].dup,
697 :max_lines => @config['send.max_lines'],
698 :overlong => @config['send.overlong'].to_sym,
699 :split_at => Regexp.new(@config['send.split_at']),
700 :purge_split => @config['send.purge_split'],
701 :truncate_text => @config['send.truncate_text'].dup
706 # Determine (if possible) a valid path to a CA certificate bundle.
707 def default_ssl_ca_file
708 [ '/etc/ssl/certs/ca-certificates.crt', # Ubuntu/Debian
709 '/etc/ssl/certs/ca-bundle.crt', # Amazon Linux
710 '/etc/ssl/ca-bundle.pem', # OpenSUSE
711 '/etc/pki/tls/certs/ca-bundle.crt' # Fedora/RHEL
717 def default_ssl_ca_path
718 file = default_ssl_ca_file
719 File.dirname file if file
722 # Determine if tokyocabinet is installed, if it is use it as a default.
725 require 'tokyocabinet'
732 def repopulate_botclass_directory
733 template_dir = File.join Config::datadir, 'templates'
734 if FileTest.directory? @botclass
735 # compare the templates dir with the current botclass dir, filling up the
736 # latter with any missing file. Sadly, FileUtils.cp_r doesn't have an
737 # :update option, so we have to do it manually.
738 # Note that we use the */** pattern because we don't want to match
739 # keywords.rbot, which gets deleted on load and would therefore be missing
741 missing = Dir.chdir(template_dir) { Dir.glob('*/**') } - Dir.chdir(@botclass) { Dir.glob('*/**') }
743 dest = File.join(@botclass, f)
744 FileUtils.mkdir_p(File.dirname(dest))
745 FileUtils.cp File.join(template_dir, f), dest
748 log "no #{@botclass} directory found, creating from templates..."
749 if FileTest.exist? @botclass
750 error "file #{@botclass} exists but isn't a directory"
753 FileUtils.cp_r template_dir, @botclass
757 # Return a path under the current botclass by joining the mentioned
758 # components. The components are automatically converted to String
759 def path(*components)
760 File.join(@botclass, *(components.map {|c| c.to_s}))
763 def setup_plugins_path
764 plugdir_default = File.join(Config::datadir, 'plugins')
765 plugdir_local = File.join(@botclass, 'plugins')
766 Dir.mkdir(plugdir_local) unless File.exist?(plugdir_local)
768 @plugins.clear_botmodule_dirs
769 @plugins.add_core_module_dir(File.join(Config::coredir, 'utils'))
770 @plugins.add_core_module_dir(Config::coredir)
771 if FileTest.directory? plugdir_local
772 @plugins.add_plugin_dir(plugdir_local)
774 warning "local plugin location #{plugdir_local} is not a directory"
777 @config['plugins.path'].each do |_|
778 path = _.sub(/^\(default\)/, plugdir_default)
779 @plugins.add_plugin_dir(path)
783 def set_default_send_options(opts={})
784 # Default send options for NOTICE and PRIVMSG
785 unless defined? @default_send_options
786 @default_send_options = {
787 :queue_channel => nil, # use default queue channel
788 :queue_ring => nil, # use default queue ring
789 :newlines => :split, # or :join
790 :join_with => ' ', # by default, use a single space
791 :max_lines => 0, # maximum number of lines to send with a single command
792 :overlong => :split, # or :truncate
793 # TODO an array of splitpoints would be preferrable for this option:
794 :split_at => /\s+/, # by default, split overlong lines at whitespace
795 :purge_split => true, # should the split string be removed?
796 :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
799 @default_send_options.update opts unless opts.empty?
802 # checks if we should be quiet on a channel
803 def quiet_on?(channel)
804 ch = channel.downcase
805 return (@quiet.include?('*') && !@not_quiet.include?(ch)) || @quiet.include?(ch)
808 def set_quiet(channel = nil)
810 ch = channel.downcase.dup
811 @not_quiet.delete(ch)
820 def reset_quiet(channel = nil)
822 ch = channel.downcase.dup
831 # things to do when we receive a signal
832 def handle_signal(sig)
841 debug "received #{sig}, queueing #{func}"
842 # this is not an interruption if we just need to reconnect
843 $interrupted += 1 unless func == :reconnect
844 self.send(func) unless @quit_mutex.locked?
845 debug "interrupted #{$interrupted} times"
855 %w(SIGINT SIGTERM SIGHUP SIGUSR1).each do |sig|
856 trap(sig) { Thread.new { handle_signal sig } }
858 rescue ArgumentError => e
859 debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
860 rescue Exception => e
861 debug "failed to trap signals: #{e.pretty_inspect}"
865 # connect the bot to IRC
867 # make sure we don't have any spurious ping checks running
868 # (and initialize the vars if this is the first time we connect)
871 quit if $interrupted > 0
874 rescue Exception => e
875 uri = @socket.server_uri || '<unknown>'
876 error "failed to connect to IRC server at #{uri}"
880 quit if $interrupted > 0
882 realname = @config['irc.name'].clone || 'Ruby bot'
883 realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
885 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
886 @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
887 quit if $interrupted > 0
888 myself.nick = @config['irc.nick']
889 myself.user = @config['irc.user']
892 # disconnect the bot from IRC, if connected, and then connect (again)
893 def reconnect(message=nil, too_fast=0)
894 # we will wait only if @last_rec was not nil, i.e. if we were connected or
895 # got disconnected by a network error
896 # if someone wants to manually call disconnect() _and_ reconnect(), they
897 # will have to take care of the waiting themselves
898 will_wait = !!@last_rec
900 if @socket.connected?
906 log "\n\nDisconnected\n\n"
908 quit if $interrupted > 0
910 log "\n\nWaiting to reconnect\n\n"
911 sleep @config['server.reconnect_wait']
913 tf = too_fast*@config['server.reconnect_wait']
914 tfu = Utils.secs_to_string(tf)
915 log "Will sleep for an extra #{tf}s (#{tfu})"
923 rescue Exception => e
930 # begin event handling loop
936 valid_recv = false # did we receive anything (valid) from the server yet?
938 reconnect(quit_msg, too_fast)
939 quit if $interrupted > 0
941 while @socket.connected?
942 quit if $interrupted > 0
944 # Wait for messages and process them as they arrive. If nothing is
945 # received, we call the ping_server() method that will PING the
946 # server if appropriate, or raise a TimeoutError if no PONG has been
947 # received in the user-chosen timeout since the last PING sent.
949 break unless reply = @socket.gets
951 @client.process reply
959 # I despair of this. Some of my users get "connection reset by peer"
960 # exceptions that ARENT SocketError's. How am I supposed to handle
963 @keep_looping = false
965 rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
966 error "network exception: #{e.pretty_inspect}"
968 too_fast += 10 if valid_recv
969 rescue ServerMessageParseError => e
970 # if the bot tried reconnecting too often, we can get forcefully
971 # disconnected by the server, while still receiving an empty message
972 # wait at least 10 minutes in this case
975 too_fast = [too_fast, 300].max
977 log "Empty message from server, extra delay multiplier #{oldtf} -> #{too_fast}"
979 quit_msg = "Unparseable Server Message: #{e.message.inspect}"
981 rescue ServerError => e
982 quit_msg = "server ERROR: " + e.message
984 idx = e.message.index("connect too fast")
985 debug "'connect too fast' @ #{idx}"
988 too_fast += (idx+1)*2
989 log "Reconnecting too fast, extra delay multiplier #{oldtf} -> #{too_fast}"
991 idx = e.message.index(/a(uto)kill/i)
992 debug "'autokill' @ #{idx}"
994 # we got auto-killed. since we don't have an easy way to tell
995 # if it's permanent or temporary, we just set a rather high
996 # reconnection timeout
998 too_fast += (idx+1)*5
999 log "Killed by server, extra delay multiplier #{oldtf} -> #{too_fast}"
1002 rescue Exception => e
1003 error "non-net exception: #{e.pretty_inspect}"
1006 fatal "unexpected exception: #{e.pretty_inspect}"
1012 # type:: message type
1013 # where:: message target
1014 # message:: message text
1015 # send message +message+ of type +type+ to target +where+
1016 # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
1017 # relevant say() or notice() methods. This one should be used for IRCd
1018 # extensions you want to use in modules.
1019 def sendmsg(original_type, original_where, original_message, options={})
1021 # filter message with sendmsg filters
1022 ds = DataStream.new original_message.to_s.dup,
1023 :type => original_type, :dest => original_where,
1024 :options => @default_send_options.merge(options)
1025 filters = filter_names(:sendmsg)
1026 filters.each do |fname|
1027 debug "filtering #{ds[:text]} with sendmsg filter #{fname}"
1028 ds.merge! filter(self.global_filter_name(fname, :sendmsg), ds)
1034 filtered = ds[:text]
1036 if defined? WebServiceUser and where.instance_of? WebServiceUser
1037 debug 'sendmsg to web service!'
1038 where.response << filtered
1042 # For starters, set up appropriate queue channels and rings
1043 mchan = opts[:queue_channel]
1044 mring = opts[:queue_ring]
1061 multi_line = filtered.gsub(/[\r\n]+/, "\n")
1063 # if target is a channel with nocolor modes, strip colours
1064 if where.kind_of?(Channel) and where.mode.any?(*config['server.nocolor_modes'])
1065 multi_line.replace BasicUserMessage.strip_formatting(multi_line)
1068 messages = Array.new
1069 case opts[:newlines]
1071 messages << [multi_line.gsub("\n", opts[:join_with])]
1073 multi_line.each_line { |line|
1075 next unless(line.size > 0)
1079 raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
1082 # The IRC protocol requires that each raw message must be not longer
1083 # than 512 characters. From this length with have to subtract the EOL
1084 # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
1085 # that will be prepended by the server to all of our messages.
1087 # The maximum raw message length we can send is therefore 512 - 2 - 2
1088 # minus the length of our hostmask.
1090 max_len = 508 - myself.fullform.size
1092 # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
1093 # will have a + or - prepended
1094 if server.capabilities[:"identify-msg"]
1098 # When splitting the message, we'll be prefixing the following string:
1099 # (e.g. "PRIVMSG #rbot :")
1100 fixed = "#{type} #{where} :"
1102 # And this is what's left
1103 left = max_len - fixed.size
1105 truncate = opts[:truncate_text]
1106 truncate = @default_send_options[:truncate_text] if truncate.size > left
1107 truncate = "" if truncate.size > left
1109 all_lines = messages.map { |line|
1113 case opts[:overlong]
1116 sub_lines = Array.new
1118 sub_lines << msg.slice!(0, left)
1120 lastspace = sub_lines.last.rindex(opts[:split_at])
1122 msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
1123 msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
1125 end until msg.empty?
1128 line.slice(0, left - truncate.size) << truncate
1130 raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
1135 if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
1136 lines = all_lines[0...opts[:max_lines]]
1137 new_last = lines.last.slice(0, left - truncate.size) << truncate
1138 lines.last.replace(new_last)
1144 sendq "#{fixed}#{line}", chan, ring
1145 delegate_sent(type, where, line)
1149 # queue an arbitraty message for the server
1150 def sendq(message="", chan=nil, ring=0)
1152 @socket.queue(message, chan, ring)
1155 # send a notice message to channel/nick +where+
1156 def notice(where, message, options={})
1157 return if where.kind_of?(Channel) and quiet_on?(where)
1158 sendmsg "NOTICE", where, message, options
1161 # say something (PRIVMSG) to channel/nick +where+
1162 def say(where, message, options={})
1163 return if where.kind_of?(Channel) and quiet_on?(where)
1164 sendmsg "PRIVMSG", where, message, options
1167 def ctcp_notice(where, command, message, options={})
1168 return if where.kind_of?(Channel) and quiet_on?(where)
1169 sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
1172 def ctcp_say(where, command, message, options={})
1173 return if where.kind_of?(Channel) and quiet_on?(where)
1174 sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
1177 # perform a CTCP action with message +message+ to channel/nick +where+
1178 def action(where, message, options={})
1179 ctcp_say(where, 'ACTION', message, options)
1182 # quick way to say "okay" (or equivalent) to +where+
1184 say where, @lang.get("okay")
1187 # set topic of channel +where+ to +topic+
1188 # can also be used to retrieve the topic of channel +where+
1189 # by omitting the last argument
1190 def topic(where, topic=nil)
1192 sendq "TOPIC #{where}", where, 2
1194 sendq "TOPIC #{where} :#{topic}", where, 2
1198 def disconnect(message=nil)
1199 message = @lang.get("quit") if (!message || message.empty?)
1200 if @socket.connected?
1202 debug "Clearing socket"
1204 debug "Sending quit message"
1205 @socket.emergency_puts "QUIT :#{message}"
1206 debug "Logging quits"
1207 delegate_sent('QUIT', myself, message)
1208 debug "Flushing socket"
1210 rescue SocketError => e
1211 error "error while disconnecting socket: #{e.pretty_inspect}"
1213 debug "Shutting down socket"
1220 # disconnect from the server and cleanup all plugins and modules
1221 def shutdown(message=nil)
1222 @quit_mutex.synchronize do
1223 debug "Shutting down: #{message}"
1224 ## No we don't restore them ... let everything run through
1226 # trap("SIGINT", "DEFAULT")
1227 # trap("SIGTERM", "DEFAULT")
1228 # trap("SIGHUP", "DEFAULT")
1230 # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
1232 debug "\tdisconnecting..."
1234 debug "\tstopping timer..."
1236 debug "\tsaving ..."
1238 debug "\tcleaning up ..."
1239 @save_mutex.synchronize do
1243 debug "\tignoring cleanup error: #{$!}"
1247 # debug "\tstopping timers ..."
1249 # debug "Closing registries"
1251 log "rbot quit (#{message})"
1255 # message:: optional IRC quit message
1256 # quit IRC, shutdown the bot
1257 def quit(message=nil)
1261 @keep_looping = false
1265 # totally shutdown and respawn the bot
1266 def restart(message=nil)
1267 message = _("restarting, back in %{wait}...") % {
1268 :wait => @config['server.reconnect_wait']
1269 } if (!message || message.empty?)
1272 Irc::Bot::LoggerManager.instance.flush
1273 Irc::Bot::LoggerManager.instance.log_session_end
1275 sleep @config['server.reconnect_wait']
1278 # Note, this fails on Windows
1279 debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
1282 rescue Errno::ENOENT
1283 exec("ruby", *(@argv.unshift $0))
1284 rescue Exception => e
1290 # call the save method for all or the specified botmodule
1293 # optional botmodule to save
1294 def save(botmodule=nil)
1295 @save_mutex.synchronize do
1296 @plugins.save(botmodule)
1300 # call the rescan method for all or just the specified botmodule
1303 # instance of the botmodule to rescan
1304 def rescan(botmodule=nil)
1305 debug "\tstopping timer..."
1307 @save_mutex.synchronize do
1309 @plugins.rescan(botmodule)
1314 # channel:: channel to join
1315 # key:: optional channel key if channel is +s
1317 def join(channel, key=nil)
1319 sendq "JOIN #{channel} :#{key}", channel, 2
1321 sendq "JOIN #{channel}", channel, 2
1326 def part(channel, message="")
1327 sendq "PART #{channel} :#{message}", channel, 2
1330 # attempt to change bot's nick to +name+
1332 sendq "NICK #{name}"
1336 def mode(channel, mode, target=nil)
1337 sendq "MODE #{channel} #{mode} #{target}", channel, 2
1341 def whois(nick, target=nil)
1342 sendq "WHOIS #{target} #{nick}", nil, 0
1346 def kick(channel, user, msg)
1347 sendq "KICK #{channel} #{user} :#{msg}", channel, 2
1350 # m:: message asking for help
1351 # topic:: optional topic help is requested for
1352 # respond to online help requests
1354 topic = nil if topic == ""
1357 helpstr = _("help topics: ")
1358 helpstr += @plugins.helptopics
1359 helpstr += _(" (help <topic> for more info)")
1361 unless(helpstr = @plugins.help(topic))
1362 helpstr = _("no help for topic %{topic}") % { :topic => topic }
1368 # returns a string describing the current status of the bot (uptime etc)
1370 secs_up = Time.new - @startup_time
1371 uptime = Utils.secs_to_string secs_up
1372 # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
1373 return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
1375 :up => uptime, :plug => @plugins.length,
1376 :sent => @socket.lines_sent, :recv => @socket.lines_received
1380 # We want to respond to a hung server in a timely manner. If nothing was received
1381 # in the user-selected timeout and we haven't PINGed the server yet, we PING
1382 # the server. If the PONG is not received within the user-defined timeout, we
1383 # assume we're in ping timeout and act accordingly.
1385 act_timeout = @config['server.ping_timeout']
1386 return if act_timeout <= 0
1388 if @last_rec && now > @last_rec + act_timeout
1390 # No previous PING pending, send a new one
1392 @last_ping = Time.now
1394 diff = now - @last_ping
1395 if diff > act_timeout
1396 debug "no PONG from server in #{diff} seconds, reconnecting"
1397 # the actual reconnect is handled in the main loop:
1398 raise TimeoutError, "no PONG from server in #{diff} seconds"
1404 def stop_server_pings
1405 # cancel previous PINGs and reset time of last RECV
1412 # delegate sent messages
1413 def delegate_sent(type, where, message)
1414 args = [self, server, myself, server.user_or_channel(where.to_s), message]
1417 m = NoticeMessage.new(*args)
1419 m = PrivMessage.new(*args)
1421 m = QuitMessage.new(*args)
1422 m.was_on = myself.channels
1424 @plugins.delegate('sent', m)