Too much stuff was being sent with each line, go back to 400 bytes max
[rbot] / lib / rbot / ircbot.rb
1 require 'thread'
2
3 require 'etc'
4 require 'fileutils'
5 require 'logger'
6
7 $debug = false unless $debug
8 $daemonize = false unless $daemonize
9
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
15
16 def rawlog(level, message=nil, who_pos=1)
17   call_stack = caller
18   if call_stack.length > who_pos
19     who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
20   else
21     who = "(unknown)"
22   end
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
25   # is output.
26   message.to_s.each_line { |l|
27     $logger.add(level, l.chomp, who)
28     who.gsub!(/./," ")
29   }
30 end
31
32 def log_session_start
33   $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
34 end
35
36 def log_session_end
37   $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
38 end
39
40 def debug(message=nil, who_pos=1)
41   rawlog(Logger::Severity::DEBUG, message, who_pos)
42 end
43
44 def log(message=nil, who_pos=1)
45   rawlog(Logger::Severity::INFO, message, who_pos)
46 end
47
48 def warning(message=nil, who_pos=1)
49   rawlog(Logger::Severity::WARN, message, who_pos)
50 end
51
52 def error(message=nil, who_pos=1)
53   rawlog(Logger::Severity::ERROR, message, who_pos)
54 end
55
56 def fatal(message=nil, who_pos=1)
57   rawlog(Logger::Severity::FATAL, message, who_pos)
58 end
59
60 debug "debug test"
61 log "log test"
62 warning "warning test"
63 error "error test"
64 fatal "fatal test"
65
66 # The following global is used for the improved signal handling.
67 $interrupted = 0
68
69 # these first
70 require 'rbot/rbotconfig'
71 require 'rbot/config'
72 require 'rbot/utils'
73
74 require 'rbot/irc'
75 require 'rbot/rfc2812'
76 require 'rbot/ircsocket'
77 require 'rbot/botuser'
78 require 'rbot/timer'
79 require 'rbot/plugins'
80 # require 'rbot/channel'
81 require 'rbot/message'
82 require 'rbot/language'
83 require 'rbot/dbhash'
84 require 'rbot/registry'
85 require 'rbot/httputil'
86
87 module Irc
88
89 # Main bot class, which manages the various components, receives messages,
90 # handles them or passes them to plugins, and contains core functionality.
91 class IrcBot
92   # the bot's IrcAuth data
93   attr_reader :auth
94
95   # the bot's BotConfig data
96   attr_reader :config
97
98   # the botclass for this bot (determines configdir among other things)
99   attr_reader :botclass
100
101   # used to perform actions periodically (saves configuration once per minute
102   # by default)
103   attr_reader :timer
104
105   # synchronize with this mutex while touching permanent data files:
106   # saving, flushing, cleaning up ...
107   attr_reader :save_mutex
108
109   # bot's Language data
110   attr_reader :lang
111
112   # bot's irc socket
113   # TODO multiserver
114   attr_reader :socket
115
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
120
121   # bot's plugins. This is an instance of class Plugins
122   attr_reader :plugins
123
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
127
128   # server we are connected to
129   # TODO multiserver
130   def server
131     @client.server
132   end
133
134   # bot User in the client/server connection
135   # TODO multiserver
136   def myself
137     @client.client
138   end
139
140   # bot User in the client/server connection
141   def nick
142     myself.nick
143   end
144
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?",
152       :wizard => true)
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 BotConfigStringValue.new('server.password',
158       :default => false, :requires_restart => true,
159       :desc => "Password for connecting to this server (if required)",
160       :wizard => true)
161     BotConfig.register BotConfigStringValue.new('server.bindhost',
162       :default => false, :requires_restart => true,
163       :desc => "Specific local host or IP for the bot to bind to (if required)",
164       :wizard => true)
165     BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait',
166       :default => 5, :validate => Proc.new{|v| v >= 0},
167       :desc => "Seconds to wait before attempting to reconnect, on disconnect")
168     BotConfig.register BotConfigFloatValue.new('server.sendq_delay',
169       :default => 2.0, :validate => Proc.new{|v| v >= 0},
170       :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
171       :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
172     BotConfig.register BotConfigIntegerValue.new('server.sendq_burst',
173       :default => 4, :validate => Proc.new{|v| v >= 0},
174       :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines",
175       :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
176     BotConfig.register BotConfigIntegerValue.new('server.ping_timeout',
177       :default => 30, :validate => Proc.new{|v| v >= 0},
178       :on_change => Proc.new {|bot, v| bot.start_server_pings},
179       :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
180
181     BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot",
182       :desc => "IRC nickname the bot should attempt to use", :wizard => true,
183       :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
184     BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot",
185       :requires_restart => true,
186       :desc => "local user the bot should appear to be", :wizard => true)
187     BotConfig.register BotConfigArrayValue.new('irc.join_channels',
188       :default => [], :wizard => true,
189       :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'")
190     BotConfig.register BotConfigArrayValue.new('irc.ignore_users',
191       :default => [], 
192       :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
193
194     BotConfig.register BotConfigIntegerValue.new('core.save_every',
195       :default => 60, :validate => Proc.new{|v| v >= 0},
196       # TODO change timer via on_change proc
197       :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
198
199     BotConfig.register BotConfigBooleanValue.new('core.run_as_daemon',
200       :default => false, :requires_restart => true,
201       :desc => "Should the bot run as a daemon?")
202
203     BotConfig.register BotConfigStringValue.new('log.file',
204       :default => false, :requires_restart => true,
205       :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
206     BotConfig.register BotConfigIntegerValue.new('log.level',
207       :default => 1, :requires_restart => false,
208       :validate => Proc.new { |v| (0..5).include?(v) },
209       :on_change => Proc.new { |bot, v|
210         $logger.level = v
211       },
212       :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
213     BotConfig.register BotConfigIntegerValue.new('log.keep',
214       :default => 1, :requires_restart => true,
215       :validate => Proc.new { |v| v >= 0 },
216       :desc => "How many old console messages logfiles to keep")
217     BotConfig.register BotConfigIntegerValue.new('log.max_size',
218       :default => 10, :requires_restart => true,
219       :validate => Proc.new { |v| v > 0 },
220       :desc => "Maximum console messages logfile size (in megabytes)")
221
222     @argv = params[:argv]
223
224     unless FileTest.directory? Config::coredir
225       error "core directory '#{Config::coredir}' not found, did you setup.rb?"
226       exit 2
227     end
228
229     unless FileTest.directory? Config::datadir
230       error "data directory '#{Config::datadir}' not found, did you setup.rb?"
231       exit 2
232     end
233
234     unless botclass and not botclass.empty?
235       # We want to find a sensible default.
236       #  * On POSIX systems we prefer ~/.rbot for the effective uid of the process
237       #  * On Windows (at least the NT versions) we want to put our stuff in the
238       #    Application Data folder.
239       # We don't use any particular O/S detection magic, exploiting the fact that
240       # Etc.getpwuid is nil on Windows
241       if Etc.getpwuid(Process::Sys.geteuid)
242         botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
243       else
244         if ENV.has_key?('APPDATA')
245           botclass = ENV['APPDATA'].dup
246           botclass.gsub!("\\","/")
247         end
248       end
249       botclass += "/.rbot"
250     end
251     botclass = File.expand_path(botclass)
252     @botclass = botclass.gsub(/\/$/, "")
253
254     unless FileTest.directory? botclass
255       log "no #{botclass} directory found, creating from templates.."
256       if FileTest.exist? botclass
257         error "file #{botclass} exists but isn't a directory"
258         exit 2
259       end
260       FileUtils.cp_r Config::datadir+'/templates', botclass
261     end
262
263     Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
264     Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
265     Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
266     Utils.set_safe_save_dir("#{botclass}/safe_save")
267
268     @ping_timer = nil
269     @pong_timer = nil
270     @last_ping = nil
271     @startup_time = Time.new
272
273     begin
274       @config = BotConfig.configmanager
275       @config.bot_associate(self)
276     rescue => e
277       fatal e.inspect
278       fatal e.backtrace.join("\n")
279       log_session_end
280       exit 2
281     end
282
283     if @config['core.run_as_daemon']
284       $daemonize = true
285     end
286
287     @logfile = @config['log.file']
288     if @logfile.class!=String || @logfile.empty?
289       @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
290     end
291
292     # See http://blog.humlab.umu.se/samuel/archives/000107.html
293     # for the backgrounding code 
294     if $daemonize
295       begin
296         exit if fork
297         Process.setsid
298         exit if fork
299       rescue NotImplementedError
300         warning "Could not background, fork not supported"
301       rescue => e
302         warning "Could not background. #{e.inspect}"
303       end
304       Dir.chdir botclass
305       # File.umask 0000                # Ensure sensible umask. Adjust as needed.
306       log "Redirecting standard input/output/error"
307       begin
308         STDIN.reopen "/dev/null"
309       rescue Errno::ENOENT
310         # On Windows, there's not such thing as /dev/null
311         STDIN.reopen "NUL"
312       end
313       def STDOUT.write(str=nil)
314         log str, 2
315         return str.to_s.length
316       end
317       def STDERR.write(str=nil)
318         if str.to_s.match(/:\d+: warning:/)
319           warning str, 2
320         else
321           error str, 2
322         end
323         return str.to_s.length
324       end
325     end
326
327     # Set the new logfile and loglevel. This must be done after the daemonizing
328     $logger = Logger.new(@logfile, @config['log.keep'], @config['log.max_size']*1024*1024)
329     $logger.datetime_format= $dateformat
330     $logger.level = @config['log.level']
331     $logger.level = $cl_loglevel if $cl_loglevel
332     $logger.level = 0 if $debug
333
334     log_session_start
335
336     @registry = BotRegistry.new self
337
338     @timer = Timer::Timer.new(1.0) # only need per-second granularity
339     @save_mutex = Mutex.new
340     @timer.add(@config['core.save_every']) { save } if @config['core.save_every']
341     @quit_mutex = Mutex.new
342
343     @logs = Hash.new
344
345     @httputil = Utils::HttpUtil.new(self)
346
347     @plugins = nil
348     @lang = Language::Language.new(self, @config['core.language'])
349
350     begin
351       @auth = Auth::authmanager
352       @auth.bot_associate(self)
353       # @auth.load("#{botclass}/botusers.yaml")
354     rescue => e
355       fatal e.inspect
356       fatal e.backtrace.join("\n")
357       log_session_end
358       exit 2
359     end
360     @auth.everyone.set_default_permission("*", true)
361     @auth.botowner.password= @config['auth.password']
362
363     Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
364     @plugins = Plugins::pluginmanager
365     @plugins.bot_associate(self)
366     @plugins.add_botmodule_dir(Config::coredir)
367     @plugins.add_botmodule_dir("#{botclass}/plugins")
368     @plugins.add_botmodule_dir(Config::datadir + "/plugins")
369     @plugins.scan
370
371     @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'])
372     @client = IrcClient.new
373     myself.nick = @config['irc.nick']
374
375     # Channels where we are quiet
376     # It's nil when we are not quiet, an empty list when we are quiet
377     # in all channels, a list of channels otherwise
378     @quiet = nil
379
380     @client[:welcome] = proc {|data|
381       irclog "joined server #{@client.server} as #{myself}", "server"
382
383       @plugins.delegate("connect")
384
385       @config['irc.join_channels'].each { |c|
386         debug "autojoining channel #{c}"
387         if(c =~ /^(\S+)\s+(\S+)$/i)
388           join $1, $2
389         else
390           join c if(c)
391         end
392       }
393     }
394     @client[:isupport] = proc { |data|
395       # TODO this needs to go into rfc2812.rb
396       # Since capabs are two-steps processes, server.supports[:capab]
397       # should be a three-state: nil, [], [....]
398       sendq "CAPAB IDENTIFY-MSG" if server.supports[:capab]
399     }
400     @client[:datastr] = proc { |data|
401       # TODO this needs to go into rfc2812.rb
402       if data[:text] == "IDENTIFY-MSG"
403         server.capabilities["identify-msg".to_sym] = true
404       else
405         debug "Not handling RPL_DATASTR #{data[:servermessage]}"
406       end
407     }
408     @client[:privmsg] = proc { |data|
409       m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
410       # debug "Message source is #{data[:source].inspect}"
411       # debug "Message target is #{data[:target].inspect}"
412       # debug "Bot is #{myself.inspect}"
413
414       # TODO use the new Netmask class
415       # @config['irc.ignore_users'].each { |mask| return if Irc.netmaskmatch(mask,m.source) }
416
417       irclogprivmsg(m)
418
419       @plugins.delegate "listen", m
420       @plugins.privmsg(m) if m.address?
421     }
422     @client[:notice] = proc { |data|
423       message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
424       # pass it off to plugins that want to hear everything
425       @plugins.delegate "listen", message
426     }
427     @client[:motd] = proc { |data|
428       data[:motd].each_line { |line|
429         irclog "MOTD: #{line}", "server"
430       }
431     }
432     @client[:nicktaken] = proc { |data|
433       nickchg "#{data[:nick]}_"
434       @plugins.delegate "nicktaken", data[:nick]
435     }
436     @client[:badnick] = proc {|data|
437       warning "bad nick (#{data[:nick]})"
438     }
439     @client[:ping] = proc {|data|
440       sendq "PONG #{data[:pingid]}"
441     }
442     @client[:pong] = proc {|data|
443       @last_ping = nil
444     }
445     @client[:nick] = proc {|data|
446       source = data[:source]
447       old = data[:oldnick]
448       new = data[:newnick]
449       m = NickMessage.new(self, server, source, old, new)
450       if source == myself
451         debug "my nick is now #{new}"
452       end
453       data[:is_on].each { |ch|
454           irclog "@ #{old} is now known as #{new}", ch
455       }
456       @plugins.delegate("listen", m)
457       @plugins.delegate("nick", m)
458     }
459     @client[:quit] = proc {|data|
460       source = data[:source]
461       message = data[:message]
462       m = QuitMessage.new(self, server, source, source, message)
463       data[:was_on].each { |ch|
464         irclog "@ Quit: #{source}: #{message}", ch
465       }
466       @plugins.delegate("listen", m)
467       @plugins.delegate("quit", m)
468     }
469     @client[:mode] = proc {|data|
470       irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
471     }
472     @client[:join] = proc {|data|
473       m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
474       irclogjoin(m)
475
476       @plugins.delegate("listen", m)
477       @plugins.delegate("join", m)
478     }
479     @client[:part] = proc {|data|
480       m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
481       irclogpart(m)
482
483       @plugins.delegate("listen", m)
484       @plugins.delegate("part", m)
485     }
486     @client[:kick] = proc {|data|
487       m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
488       irclogkick(m)
489
490       @plugins.delegate("listen", m)
491       @plugins.delegate("kick", m)
492     }
493     @client[:invite] = proc {|data|
494       if data[:target] == myself
495         join data[:channel] if @auth.allow?("join", data[:source], data[:source].nick)
496       end
497     }
498     @client[:changetopic] = proc {|data|
499       m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
500       irclogtopic(m)
501
502       @plugins.delegate("listen", m)
503       @plugins.delegate("topic", m)
504     }
505     @client[:topic] = proc { |data|
506       irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
507     }
508     @client[:topicinfo] = proc { |data|
509       channel = data[:channel]
510       topic = channel.topic
511       irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
512       m = TopicMessage.new(self, server, data[:source], channel, topic)
513
514       @plugins.delegate("listen", m)
515       @plugins.delegate("topic", m)
516     }
517     @client[:names] = proc { |data|
518       @plugins.delegate "names", data[:channel], data[:users]
519     }
520     @client[:unknown] = proc { |data|
521       #debug "UNKNOWN: #{data[:serverstring]}"
522       irclog data[:serverstring], ".unknown"
523     }
524   end
525
526   # checks if we should be quiet on a channel
527   def quiet_on?(channel)
528     return false unless @quiet
529     return true if @quiet.empty?
530     return @quiet.include?(channel.to_s)
531   end
532
533   def set_quiet(channel=nil)
534     if channel
535       @quiet << channel.to_s unless @quiet.include?(channel.to_s)
536     else
537       @quiet = []
538     end
539   end
540
541   def reset_quiet(channel=nil)
542     if channel
543       @quiet.delete_if { |x| x == channel.to_s }
544     else
545       @quiet = nil
546     end
547   end
548
549   # things to do when we receive a signal
550   def got_sig(sig)
551     debug "received #{sig}, queueing quit"
552     $interrupted += 1
553     quit unless @quit_mutex.locked?
554     debug "interrupted #{$interrupted} times"
555     if $interrupted >= 3
556       debug "drastic!"
557       log_session_end
558       exit 2
559     end
560   end
561
562   # connect the bot to IRC
563   def connect
564     begin
565       trap("SIGINT") { got_sig("SIGINT") }
566       trap("SIGTERM") { got_sig("SIGTERM") }
567       trap("SIGHUP") { got_sig("SIGHUP") }
568     rescue ArgumentError => e
569       debug "failed to trap signals (#{e.inspect}): running on Windows?"
570     rescue => e
571       debug "failed to trap signals: #{e.inspect}"
572     end
573     begin
574       quit if $interrupted > 0
575       @socket.connect
576     rescue => e
577       raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e
578     end
579     quit if $interrupted > 0
580     @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
581     @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert"
582     quit if $interrupted > 0
583     start_server_pings
584   end
585
586   # begin event handling loop
587   def mainloop
588     while true
589       begin
590         quit if $interrupted > 0
591         connect
592         @timer.start
593
594         while @socket.connected?
595           quit if $interrupted > 0
596           if @socket.select
597             break unless reply = @socket.gets
598             @client.process reply
599           end
600         end
601
602       # I despair of this. Some of my users get "connection reset by peer"
603       # exceptions that ARENT SocketError's. How am I supposed to handle
604       # that?
605       rescue SystemExit
606         log_session_end
607         exit 0
608       rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
609         error "network exception: #{e.class}: #{e}"
610         debug e.backtrace.join("\n")
611       rescue BDB::Fatal => e
612         fatal "fatal bdb error: #{e.class}: #{e}"
613         fatal e.backtrace.join("\n")
614         DBTree.stats
615         # Why restart? DB problems are serious stuff ...
616         # restart("Oops, we seem to have registry problems ...")
617         log_session_end
618         exit 2
619       rescue Exception => e
620         error "non-net exception: #{e.class}: #{e}"
621         error e.backtrace.join("\n")
622       rescue => e
623         fatal "unexpected exception: #{e.class}: #{e}"
624         fatal e.backtrace.join("\n")
625         log_session_end
626         exit 2
627       end
628
629       stop_server_pings
630       server.clear
631       if @socket.connected?
632         @socket.clearq
633         @socket.shutdown
634       end
635
636       log "disconnected"
637
638       quit if $interrupted > 0
639
640       log "waiting to reconnect"
641       sleep @config['server.reconnect_wait']
642     end
643   end
644
645   # type:: message type
646   # where:: message target
647   # message:: message text
648   # send message +message+ of type +type+ to target +where+
649   # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
650   # relevant say() or notice() methods. This one should be used for IRCd
651   # extensions you want to use in modules.
652   def sendmsg(type, where, message, chan=nil, ring=0)
653     # Split the message so that each line sent is not longher than 400 bytes
654     # TODO allow something to do for commands that produce too many messages
655     # TODO example: math 10**10000
656     # TODO try to use the maximum line length allowed by the server, if there is
657     #      a way to know what it is
658     left = 400 - type.length - where.to_s.length - 3
659     begin
660       if(left >= message.length)
661         sendq "#{type} #{where} :#{message}", chan, ring
662         log_sent(type, where, message)
663         return
664       end
665       line = message.slice!(0, left)
666       lastspace = line.rindex(/\s+/)
667       if(lastspace)
668         message = line.slice!(lastspace, line.length) + message
669         message.gsub!(/^\s+/, "")
670       end
671       sendq "#{type} #{where} :#{line}", chan, ring
672       log_sent(type, where, line)
673     end while(message.length > 0)
674   end
675
676   # queue an arbitraty message for the server
677   def sendq(message="", chan=nil, ring=0)
678     # temporary
679     @socket.queue(message, chan, ring)
680   end
681
682   # send a notice message to channel/nick +where+
683   def notice(where, message, mchan="", mring=-1)
684     if mchan == ""
685       chan = where
686     else
687       chan = mchan
688     end
689     if mring < 0
690       case where
691       when User
692         ring = 1
693       else
694         ring = 2
695       end
696     else
697       ring = mring
698     end
699     message.each_line { |line|
700       line.chomp!
701       next unless(line.length > 0)
702       sendmsg "NOTICE", where, line, chan, ring
703     }
704   end
705
706   # say something (PRIVMSG) to channel/nick +where+
707   def say(where, message, mchan="", mring=-1)
708     if mchan == ""
709       chan = where
710     else
711       chan = mchan
712     end
713     if mring < 0
714       case where
715       when User
716         ring = 1
717       else
718         ring = 2
719       end
720     else
721       ring = mring
722     end
723     message.to_s.gsub(/[\r\n]+/, "\n").each_line { |line|
724       line.chomp!
725       next unless(line.length > 0)
726       unless quiet_on?(where)
727         sendmsg "PRIVMSG", where, line, chan, ring 
728       end
729     }
730   end
731
732   # perform a CTCP action with message +message+ to channel/nick +where+
733   def action(where, message, mchan="", mring=-1)
734     if mchan == ""
735       chan = where
736     else
737       chan = mchan
738     end
739     if mring < 0
740       case where
741       when Channel
742         ring = 2
743       else
744         ring = 1
745       end
746     else
747       ring = mring
748     end
749     sendq "PRIVMSG #{where} :\001ACTION #{message}\001", chan, ring
750     case where
751     when Channel
752       irclog "* #{myself} #{message}", where
753     else
754       irclog "* #{myself}[#{where}] #{message}", where
755     end
756   end
757
758   # quick way to say "okay" (or equivalent) to +where+
759   def okay(where)
760     say where, @lang.get("okay")
761   end
762
763   # log IRC-related message +message+ to a file determined by +where+.
764   # +where+ can be a channel name, or a nick for private message logging
765   def irclog(message, where="server")
766     message = message.chomp
767     stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
768     where = where.to_s.gsub(/[:!?$*()\/\\<>|"']/, "_")
769     unless(@logs.has_key?(where))
770       @logs[where] = File.new("#{@botclass}/logs/#{where}", "a")
771       @logs[where].sync = true
772     end
773     @logs[where].puts "[#{stamp}] #{message}"
774     #debug "[#{stamp}] <#{where}> #{message}"
775   end
776
777   # set topic of channel +where+ to +topic+
778   def topic(where, topic)
779     sendq "TOPIC #{where} :#{topic}", where, 2
780   end
781
782   # disconnect from the server and cleanup all plugins and modules
783   def shutdown(message = nil)
784     @quit_mutex.synchronize do
785       debug "Shutting down ..."
786       ## No we don't restore them ... let everything run through
787       # begin
788       #   trap("SIGINT", "DEFAULT")
789       #   trap("SIGTERM", "DEFAULT")
790       #   trap("SIGHUP", "DEFAULT")
791       # rescue => e
792       #   debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
793       # end
794       message = @lang.get("quit") if (message.nil? || message.empty?)
795       if @socket.connected?
796         debug "Clearing socket"
797         @socket.clearq
798         debug "Sending quit message"
799         @socket.emergency_puts "QUIT :#{message}"
800         debug "Flushing socket"
801         @socket.flush
802         debug "Shutting down socket"
803         @socket.shutdown
804       end
805       debug "Logging quits"
806       server.channels.each { |ch|
807         irclog "@ quit (#{message})", ch
808       }
809       debug "Saving"
810       save
811       debug "Cleaning up"
812       @save_mutex.synchronize do
813         @plugins.cleanup
814       end
815       # debug "Closing registries"
816       # @registry.close
817       debug "Cleaning up the db environment"
818       DBTree.cleanup_env
819       log "rbot quit (#{message})"
820     end
821   end
822
823   # message:: optional IRC quit message
824   # quit IRC, shutdown the bot
825   def quit(message=nil)
826     begin
827       shutdown(message)
828     ensure
829       exit 0
830     end
831   end
832
833   # totally shutdown and respawn the bot
834   def restart(message = false)
835     msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..."
836     shutdown(msg)
837     sleep @config['server.reconnect_wait']
838     # now we re-exec
839     # Note, this fails on Windows
840     exec($0, *@argv)
841   end
842
843   # call the save method for all of the botmodules
844   def save
845     @save_mutex.synchronize do
846       @plugins.save
847       DBTree.cleanup_logs
848     end
849   end
850
851   # call the rescan method for all of the botmodules
852   def rescan
853     @save_mutex.synchronize do
854       @lang.rescan
855       @plugins.rescan
856     end
857   end
858
859   # channel:: channel to join
860   # key::     optional channel key if channel is +s
861   # join a channel
862   def join(channel, key=nil)
863     if(key)
864       sendq "JOIN #{channel} :#{key}", channel, 2
865     else
866       sendq "JOIN #{channel}", channel, 2
867     end
868   end
869
870   # part a channel
871   def part(channel, message="")
872     sendq "PART #{channel} :#{message}", channel, 2
873   end
874
875   # attempt to change bot's nick to +name+
876   def nickchg(name)
877       sendq "NICK #{name}"
878   end
879
880   # changing mode
881   def mode(channel, mode, target)
882       sendq "MODE #{channel} #{mode} #{target}", channel, 2
883   end
884
885   # kicking a user
886   def kick(channel, user, msg)
887       sendq "KICK #{channel} #{user} :#{msg}", channel, 2
888   end
889
890   # m::     message asking for help
891   # topic:: optional topic help is requested for
892   # respond to online help requests
893   def help(topic=nil)
894     topic = nil if topic == ""
895     case topic
896     when nil
897       helpstr = "help topics: "
898       helpstr += @plugins.helptopics
899       helpstr += " (help <topic> for more info)"
900     else
901       unless(helpstr = @plugins.help(topic))
902         helpstr = "no help for topic #{topic}"
903       end
904     end
905     return helpstr
906   end
907
908   # returns a string describing the current status of the bot (uptime etc)
909   def status
910     secs_up = Time.new - @startup_time
911     uptime = Utils.secs_to_string secs_up
912     # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
913     return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
914   end
915
916   # we'll ping the server every 30 seconds or so, and expect a response
917   # before the next one come around..
918   def start_server_pings
919     stop_server_pings
920     return unless @config['server.ping_timeout'] > 0
921     # we want to respond to a hung server within 30 secs or so
922     @ping_timer = @timer.add(30) {
923       @last_ping = Time.now
924       @socket.queue "PING :rbot"
925     }
926     @pong_timer = @timer.add(10) {
927       unless @last_ping.nil?
928         diff = Time.now - @last_ping
929         unless diff < @config['server.ping_timeout']
930           debug "no PONG from server for #{diff} seconds, reconnecting"
931           begin
932             @socket.shutdown
933           rescue
934             debug "couldn't shutdown connection (already shutdown?)"
935           end
936           @last_ping = nil
937           raise TimeoutError, "no PONG from server in #{diff} seconds"
938         end
939       end
940     }
941   end
942
943   def stop_server_pings
944     @last_ping = nil
945     # stop existing timers if running
946     unless @ping_timer.nil?
947       @timer.remove @ping_timer
948       @ping_timer = nil
949     end
950     unless @pong_timer.nil?
951       @timer.remove @pong_timer
952       @pong_timer = nil
953     end
954   end
955
956   private
957
958   def irclogprivmsg(m)
959     if(m.action?)
960       if(m.private?)
961         irclog "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
962       else
963         irclog "* #{m.sourcenick} #{m.message}", m.target
964       end
965     else
966       if(m.public?)
967         irclog "<#{m.sourcenick}> #{m.message}", m.target
968       else
969         irclog "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
970       end
971     end
972   end
973
974   # log a message. Internal use only.
975   def log_sent(type, where, message)
976     case type
977       when "NOTICE"
978         case where
979         when Channel
980           irclog "-=#{myself}=- #{message}", where
981         else
982              irclog "[-=#{where}=-] #{message}", where
983         end
984       when "PRIVMSG"
985         case where
986         when Channel
987           irclog "<#{myself}> #{message}", where
988         else
989           irclog "[msg(#{where})] #{message}", where
990         end
991     end
992   end
993
994   def irclogjoin(m)
995     if m.address?
996       debug "joined channel #{m.channel}"
997       irclog "@ Joined channel #{m.channel}", m.channel
998     else
999       irclog "@ #{m.sourcenick} joined channel #{m.channel}", m.channel
1000     end
1001   end
1002
1003   def irclogpart(m)
1004     if(m.address?)
1005       debug "left channel #{m.channel}"
1006       irclog "@ Left channel #{m.channel} (#{m.message})", m.channel
1007     else
1008       irclog "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel
1009     end
1010   end
1011
1012   def irclogkick(m)
1013     if(m.address?)
1014       debug "kicked from channel #{m.channel}"
1015       irclog "@ You have been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
1016     else
1017       irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
1018     end
1019   end
1020
1021   def irclogtopic(m)
1022     if m.source == myself
1023       irclog "@ I set topic \"#{m.topic}\"", m.channel
1024     else
1025       irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
1026     end
1027   end
1028
1029 end
1030
1031 end