Class: Irc::Bot

Inherits:
Object show all
Defined in:
/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/registry/dbm.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/registry/tc.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/registry/daybreak.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/registry/sqlite.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/plugins.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/botuser.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/botuser.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/messagemapper.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/extends.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/wordlist.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/registry.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/message.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/language.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/rbotconfig.rb,
/home/apoc/projects/ruby/rbot/lib/rbot/config.rb

Overview

Main bot class, which manages the various components, receives messages, handles them or passes them to plugins, and contains core functionality.

Defined Under Namespace

Modules: Auth, Config, Plugins Classes: DataFilter, DataStream, Language, MessageMapper, MessageParameter, MessageTemplate, Registry, WebDispatcher, WebMessage, Wordlist

Constant Summary

"(c) Tom Gilbert and the rbot development team"
SOURCE_URL = 
"http://ruby-rbot.org"

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Bot) initialize(botclass, params = {})

create a new Bot with botclass botclass



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 278

def initialize(botclass, params = {})
  # Config for the core bot
  # TODO should we split socket stuff into ircsocket, etc?
  Config.register Config::ArrayValue.new('server.list',
    :default => ['irc://localhost'], :wizard => true,
    :requires_restart => true,
    :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.")
  Config.register Config::BooleanValue.new('server.ssl',
    :default => false, :requires_restart => true, :wizard => true,
    :desc => "Use SSL to connect to this server?")
  Config.register Config::BooleanValue.new('server.ssl_verify',
    :default => false, :requires_restart => true,
    :desc => "Verify the SSL connection?",
    :wizard => true)
  Config.register Config::StringValue.new('server.ssl_ca_file',
    :default => default_ssl_ca_file, :requires_restart => true,
    :desc => "The CA file used to verify the SSL connection.",
    :wizard => true)
  Config.register Config::StringValue.new('server.ssl_ca_path',
    :default => default_ssl_ca_path, :requires_restart => true,
    :desc => "Alternativly a directory that includes CA PEM files used to verify the SSL connection.",
    :wizard => true)
  Config.register Config::StringValue.new('server.password',
    :default => false, :requires_restart => true,
    :desc => "Password for connecting to this server (if required)",
    :wizard => true)
  Config.register Config::StringValue.new('server.bindhost',
    :default => false, :requires_restart => true,
    :desc => "Specific local host or IP for the bot to bind to (if required)",
    :wizard => true)
  Config.register Config::IntegerValue.new('server.reconnect_wait',
    :default => 5, :validate => Proc.new{|v| v >= 0},
    :desc => "Seconds to wait before attempting to reconnect, on disconnect")
  Config.register Config::IntegerValue.new('server.ping_timeout',
    :default => 30, :validate => Proc.new{|v| v >= 0},
    :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
  Config.register Config::ArrayValue.new('server.nocolor_modes',
    :default => ['c'], :wizard => false,
    :requires_restart => false,
    :desc => "List of channel modes that require messages to be without colors")

  Config.register Config::StringValue.new('irc.nick', :default => "rbot",
    :desc => "IRC nickname the bot should attempt to use", :wizard => true,
    :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
  Config.register Config::StringValue.new('irc.name',
    :default => "Ruby bot", :requires_restart => true,
    :desc => "IRC realname the bot should use")
  Config.register Config::BooleanValue.new('irc.name_copyright',
    :default => true, :requires_restart => true,
    :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
  Config.register Config::StringValue.new('irc.user', :default => "rbot",
    :requires_restart => true,
    :desc => "local user the bot should appear to be", :wizard => true)
  Config.register Config::ArrayValue.new('irc.join_channels',
    :default => [], :wizard => true,
    :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'")
  Config.register Config::ArrayValue.new('irc.ignore_users',
    :default => [],
    :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
  Config.register Config::ArrayValue.new('irc.ignore_channels',
    :default => [],
    :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)")

  Config.register Config::IntegerValue.new('core.save_every',
    :default => 60, :validate => Proc.new{|v| v >= 0},
    :on_change => Proc.new { |bot, v|
      if @save_timer
        if v > 0
          @timer.reschedule(@save_timer, v)
          @timer.unblock(@save_timer)
        else
          @timer.block(@save_timer)
        end
      else
        if v > 0
          @save_timer = @timer.add(v) { bot.save }
        end
        # Nothing to do when v == 0
      end
    },
    :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")

  Config.register Config::BooleanValue.new('core.run_as_daemon',
    :default => false, :requires_restart => true,
    :desc => "Should the bot run as a daemon?")

  Config.register Config::StringValue.new('log.file',
    :default => false, :requires_restart => true,
    :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon")
  Config.register Config::IntegerValue.new('log.level',
    :default => 1, :requires_restart => false,
    :validate => Proc.new { |v| (0..5).include?(v) },
    :on_change => Proc.new { |bot, v|
      $logger.level = v
    },
    :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
  Config.register Config::IntegerValue.new('log.keep',
    :default => 1, :requires_restart => true,
    :validate => Proc.new { |v| v >= 0 },
    :desc => "How many old console messages logfiles to keep")
  Config.register Config::IntegerValue.new('log.max_size',
    :default => 10, :requires_restart => true,
    :validate => Proc.new { |v| v > 0 },
    :desc => "Maximum console messages logfile size (in megabytes)")

  Config.register Config::ArrayValue.new('plugins.path',
    :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
    :requires_restart => false,
    :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
    :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")

  Config.register Config::EnumValue.new('send.newlines',
    :values => ['split', 'join'], :default => 'split',
    :on_change => Proc.new { |bot, v|
      bot.set_default_send_options :newlines => v.to_sym
    },
    :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")
  Config.register Config::StringValue.new('send.join_with',
    :default => ' ',
    :on_change => Proc.new { |bot, v|
      bot.set_default_send_options :join_with => v.dup
    },
    :desc => "String used to replace newlines when send.newlines is set to join")
  Config.register Config::IntegerValue.new('send.max_lines',
    :default => 5,
    :validate => Proc.new { |v| v >= 0 },
    :on_change => Proc.new { |bot, v|
      bot.set_default_send_options :max_lines => v
    },
    :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
  Config.register Config::EnumValue.new('send.overlong',
    :values => ['split', 'truncate'], :default => 'split',
    :on_change => Proc.new { |bot, v|
      bot.set_default_send_options :overlong => v.to_sym
    },
    :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")
  Config.register Config::StringValue.new('send.split_at',
    :default => '\s+',
    :on_change => Proc.new { |bot, v|
      bot.set_default_send_options :split_at => Regexp.new(v)
    },
    :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
  Config.register Config::BooleanValue.new('send.purge_split',
    :default => true,
    :on_change => Proc.new { |bot, v|
      bot.set_default_send_options :purge_split => v
    },
    :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
  Config.register Config::StringValue.new('send.truncate_text',
    :default => "#{Reverse}...#{Reverse}",
    :on_change => Proc.new { |bot, v|
      bot.set_default_send_options :truncate_text => v.dup
    },
    :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")
  Config.register Config::IntegerValue.new('send.penalty_pct',
    :default => 100,
    :validate => Proc.new { |v| v >= 0 },
    :on_change => Proc.new { |bot, v|
      bot.socket.penalty_pct = v
    },
    :desc => "Percentage of IRC penalty to consider when sending messages to prevent being disconnected for excess flood. Set to 0 to disable penalty control.")
  Config.register Config::StringValue.new('core.db',
    :default => default_db, :store_default => true,
    :wizard => true,
    :validate => Proc.new { |v| Registry::formats.include? v },
    :requires_restart => true,
    :desc => "DB adaptor to use for storing the plugin data/registries. Options: " + Registry::formats.join(', '))

  @argv = params[:argv]
  @run_dir = params[:run_dir] || Dir.pwd

  unless FileTest.directory? Config::coredir
    error "core directory '#{Config::coredir}' not found, did you setup.rb?"
    exit 2
  end

  unless FileTest.directory? Config::datadir
    error "data directory '#{Config::datadir}' not found, did you setup.rb?"
    exit 2
  end

  unless botclass and not botclass.empty?
    # We want to find a sensible default.
    # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
    # * On Windows (at least the NT versions) we want to put our stuff in the
    #   Application Data folder.
    # We don't use any particular O/S detection magic, exploiting the fact that
    # Etc.getpwuid is nil on Windows
    if Etc.getpwuid(Process::Sys.geteuid)
      botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
    else
      if ENV.has_key?('APPDATA')
        botclass = ENV['APPDATA'].dup
        botclass.gsub!("\\","/")
      end
    end
    botclass = File.join(botclass, ".rbot")
  end
  botclass = File.expand_path(botclass)
  @botclass = botclass.gsub(/\/$/, "")

  repopulate_botclass_directory

  save_dir = File.join(@botclass, 'safe_save')
  Dir.mkdir(save_dir) unless File.exist?(save_dir)
  unless FileTest.directory? save_dir
    error "safe save location #{save_dir} is not a directory"
    exit 2
  end

  # Time at which the last PING was sent
  @last_ping = nil
  # Time at which the last line was RECV'd from the server
  @last_rec = nil

  @startup_time = Time.new

  begin
    @config = Config.manager
    @config.bot_associate(self)
  rescue Exception => e
    fatal e
    log_session_end
    exit 2
  end

  if @config['core.run_as_daemon']
    $daemonize = true
  end

  @registry_factory = Registry.new @config['core.db']
  @registry_factory.migrate_registry_folder(path)

  @logfile = @config['log.file']
  if @logfile.class!=String || @logfile.empty?
    logfname =  File.basename(botclass).gsub(/^\.+/,'')
    logfname << ".log"
    @logfile = File.join(botclass, logfname)
    debug "Using `#{@logfile}' as debug log"
  end

  # See http://blog.humlab.umu.se/samuel/archives/000107.html
  # for the backgrounding code
  if $daemonize
    begin
      exit if fork
      Process.setsid
      exit if fork
    rescue NotImplementedError
      warning "Could not background, fork not supported"
    rescue SystemExit
      exit 0
    rescue Exception => e
      warning "Could not background. #{e.pretty_inspect}"
    end
    Dir.chdir botclass
    # File.umask 0000                # Ensure sensible umask. Adjust as needed.
  end

  logger = Logger.new(@logfile,
                      @config['log.keep'],
                      @config['log.max_size']*1024*1024)
  logger.datetime_format= $dateformat
  logger.level = @config['log.level']
  logger.level = $cl_loglevel if defined? $cl_loglevel
  logger.level = 0 if $debug

  restart_logger(logger)

  log_session_start

  if $daemonize
    log "Redirecting standard input/output/error"
    [$stdin, $stdout, $stderr].each do |fd|
      begin
        fd.reopen "/dev/null"
      rescue Errno::ENOENT
        # On Windows, there's not such thing as /dev/null
        fd.reopen "NUL"
      end
    end

    def $stdout.write(str=nil)
      log str, 2
      return str.to_s.size
    end
    def $stdout.write(str=nil)
      if str.to_s.match(/:\d+: warning:/)
        warning str, 2
      else
        error str, 2
      end
      return str.to_s.size
    end
  end

  File.open($opts['pidfile'] || File.join(@botclass, 'rbot.pid'), 'w') do |pf|
    pf << "#{$$}\n"
  end

  @timer = Timer.new
  @save_mutex = Mutex.new
  if @config['core.save_every'] > 0
    @save_timer = @timer.add(@config['core.save_every']) { save }
  else
    @save_timer = nil
  end
  @quit_mutex = Mutex.new

  @plugins = nil
  @lang = Language.new(self, @config['core.language'])

  begin
    @auth = Auth::manager
    @auth.bot_associate(self)
    # @auth.load("#{botclass}/botusers.yaml")
  rescue Exception => e
    fatal e
    log_session_end
    exit 2
  end
  @auth.everyone.set_default_permission("*", true)
  @auth.botowner.password= @config['auth.password']

  @plugins = Plugins::manager
  @plugins.bot_associate(self)
  setup_plugins_path()

  if @config['server.name']
      debug "upgrading configuration (server.name => server.list)"
      srv_uri = 'irc://' + @config['server.name']
      srv_uri += ":#{@config['server.port']}" if @config['server.port']
      @config.items['server.list'.to_sym].set_string(srv_uri)
      @config.delete('server.name'.to_sym)
      @config.delete('server.port'.to_sym)
      debug "server.list is now #{@config['server.list'].inspect}"
  end

  @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], 
                            :ssl => @config['server.ssl'],
                            :ssl_verify => @config['server.ssl_verify'],
                            :ssl_ca_file => @config['server.ssl_ca_file'],
                            :ssl_ca_path => @config['server.ssl_ca_path'],
                            :penalty_pct => @config['send.penalty_pct'])
  @client = Client.new

  @plugins.scan

  # Channels where we are quiet
  # Array of channels names where the bot should be quiet
  # '*' means all channels
  #
  @quiet = Set.new
  # but we always speak here
  @not_quiet = Set.new

  # the nick we want, if it's different from the irc.nick config value
  # (e.g. as set by a !nick command)
  @wanted_nick = nil

  @client[:welcome] = proc {|data|
    m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])

    @plugins.delegate("welcome", m)
    @plugins.delegate("connect")
  }

  # TODO the next two @client should go into rfc2812.rb, probably
  # Since capabs are two-steps processes, server.supports[:capab]
  # should be a three-state: nil, [], [....]
  asked_for = { :identify-msg" => false }
  @client[:isupport] = proc { |data|
    if server.supports[:capab] and !asked_for[:identify-msg"]
      sendq "CAPAB IDENTIFY-MSG"
      asked_for[:identify-msg"] = true
    end
  }
  @client[:datastr] = proc { |data|
    if data[:text] == "IDENTIFY-MSG"
      server.capabilities[:identify-msg"] = true
    else
      debug "Not handling RPL_DATASTR #{data[:servermessage]}"
    end
  }

  @client[:privmsg] = proc { |data|
    m = PrivMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
    # debug "Message source is #{data[:source].inspect}"
    # debug "Message target is #{data[:target].inspect}"
    # debug "Bot is #{myself.inspect}"

    @config['irc.ignore_channels'].each { |channel|
      if m.target.downcase == channel.downcase
        m.ignored = true
        break
      end
    }
    @config['irc.ignore_users'].each { |mask|
      if m.source.matches?(server.new_netmask(mask))
        m.ignored = true
        break
      end
    } unless m.ignored

    @plugins.irc_delegate('privmsg', m)
  }
  @client[:notice] = proc { |data|
    message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true)
    # pass it off to plugins that want to hear everything
    @plugins.irc_delegate "notice", message
  }
  @client[:motd] = proc { |data|
    m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd])
    @plugins.delegate "motd", m
  }
  @client[:nicktaken] = proc { |data|
    new = "#{data[:nick]}_"
    nickchg new
    # If we're setting our nick at connection because our choice was taken,
    # we have to fix our nick manually, because there will be no NICK message
    # to inform us that our nick has been changed.
    if data[:target] == '*'
      debug "setting my connection nick to #{new}"
      nick = new
    end
    @plugins.delegate "nicktaken", data[:nick]
  }
  @client[:badnick] = proc {|data|
    warning "bad nick (#{data[:nick]})"
  }
  @client[:ping] = proc {|data|
    sendq "PONG #{data[:pingid]}"
  }
  @client[:pong] = proc {|data|
    @last_ping = nil
  }
  @client[:nick] = proc {|data|
    # debug "Message source is #{data[:source].inspect}"
    # debug "Bot is #{myself.inspect}"
    source = data[:source]
    old = data[:oldnick]
    new = data[:newnick]
    m = NickMessage.new(self, server, source, old, new)
    m.is_on = data[:is_on]
    if source == myself
      debug "my nick is now #{new}"
    end
    @plugins.irc_delegate("nick", m)
  }
  @client[:quit] = proc {|data|
    source = data[:source]
    message = data[:message]
    m = QuitMessage.new(self, server, source, source, message)
    m.was_on = data[:was_on]
    @plugins.irc_delegate("quit", m)
  }
  @client[:mode] = proc {|data|
    m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
    m.modes = data[:modes]
    @plugins.delegate "modechange", m
  }
  @client[:whois] = proc {|data|
    source = data[:source]
    target = server.get_user(data[:whois][:nick])
    m = WhoisMessage.new(self, server, source, target, data[:whois])
    @plugins.delegate "whois", m
  }
  @client[:list] = proc {|data|
    source = data[:source]
    m = ListMessage.new(self, server, source, source, data[:list])
    @plugins.delegate "irclist", m
  }
  @client[:join] = proc {|data|
    m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
    sendq("MODE #{data[:channel]}", nil, 0) if m.address?
    @plugins.irc_delegate("join", m)
    sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
  }
  @client[:part] = proc {|data|
    m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
    @plugins.irc_delegate("part", m)
  }
  @client[:kick] = proc {|data|
    m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
    @plugins.irc_delegate("kick", m)
  }
  @client[:invite] = proc {|data|
    m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
    @plugins.irc_delegate("invite", m)
  }
  @client[:changetopic] = proc {|data|
    m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
    m.info_or_set = :set
    @plugins.irc_delegate("topic", m)
  }
  # @client[:topic] = proc { |data|
  #   irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
  # }
  @client[:topicinfo] = proc { |data|
    channel = data[:channel]
    topic = channel.topic
    m = TopicMessage.new(self, server, data[:source], channel, topic)
    m.info_or_set = :info
    @plugins.irc_delegate("topic", m)
  }
  @client[:names] = proc { |data|
    m = NamesMessage.new(self, server, server, data[:channel])
    m.users = data[:users]
    @plugins.delegate "names", m
  }
  @client[:banlist] = proc { |data|
    m = BanlistMessage.new(self, server, server, data[:channel])
    m.bans = data[:bans]
    @plugins.delegate "banlist", m
  }
  @client[:nosuchtarget] = proc { |data|
    m = NoSuchTargetMessage.new(self, server, server, data[:target], data[:message])
    @plugins.delegate "nosuchtarget", m
  }
  @client[:error] = proc { |data|
    raise ServerError, data[:message]
  }
  @client[:unknown] = proc { |data|
    #debug "UNKNOWN: #{data[:serverstring]}"
    m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
    @plugins.delegate "unknown_message", m
  }

  set_default_send_options :newlines => @config['send.newlines'].to_sym,
    :join_with => @config['send.join_with'].dup,
    :max_lines => @config['send.max_lines'],
    :overlong => @config['send.overlong'].to_sym,
    :split_at => Regexp.new(@config['send.split_at']),
    :purge_split => @config['send.purge_split'],
    :truncate_text => @config['send.truncate_text'].dup

  trap_signals
end

Instance Attribute Details

- (Object) agent

mechanize agent factory



200
201
202
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 200

def agent
  @agent
end

- (Object) auth (readonly)

the bot's Auth data



169
170
171
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 169

def auth
  @auth
end

- (Object) botclass (readonly)

the botclass for this bot (determines configdir among other things)



175
176
177
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 175

def botclass
  @botclass
end

- (Object) config (readonly)

the bot's Config data



172
173
174
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 172

def config
  @config
end

- (Object) httputil

bot's httputil helper object, for fetching resources via http. Sets up proxies etc as defined by the bot configuration/environment



197
198
199
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 197

def httputil
  @httputil
end

- (Object) lang (readonly)

bot's Language data



186
187
188
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 186

def lang
  @lang
end

- (Object) plugins (readonly)

bot's plugins. This is an instance of class Plugins



193
194
195
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 193

def plugins
  @plugins
end

- (Object) registry_factory

loads and opens new registry databases, used by the plugins



203
204
205
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 203

def registry_factory
  @registry_factory
end

- (Object) save_mutex (readonly)

synchronize with this mutex while touching permanent data files: saving, flushing, cleaning up …



183
184
185
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 183

def save_mutex
  @save_mutex
end

- (Object) socket (readonly)

bot's irc socket TODO multiserver



190
191
192
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 190

def socket
  @socket
end

- (Object) timer (readonly)

used to perform actions periodically (saves configuration once per minute by default)



179
180
181
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 179

def timer
  @timer
end

- (Object) webservice

Returns the value of attribute webservice



205
206
207
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 205

def webservice
  @webservice
end

Instance Method Details

- (Object) action(where, message, options = {})

perform a CTCP action with message message to channel/nick where



1291
1292
1293
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1291

def action(where, message, options={})
  ctcp_say(where, 'ACTION', message, options)
end

- (Object) channels

bot channels in the client/server connection



225
226
227
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 225

def channels
  myself.channels
end

- (Object) clear_filters

This method clears the filter list and installs the identity filter



142
143
144
145
146
147
148
149
150
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 142

def clear_filters
  @filters ||= {}
  @filters.clear

  @filter_group ||= {}
  @filter_group.clear

  register_filter(:identity) { |stream| stream }
end

- (Object) connect

connect the bot to IRC



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 978

def connect
  # make sure we don't have any spurious ping checks running
  # (and initialize the vars if this is the first time we connect)
  stop_server_pings
  begin
    quit if $interrupted > 0
    @socket.connect
    @last_rec = Time.now
  rescue Exception => e
    uri = @socket.server_uri || '<unknown>'
    error "failed to connect to IRC server at #{uri}"
    error e
    raise
  end
  quit if $interrupted > 0

  realname = @config['irc.name'].clone || 'Ruby bot'
  realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']

  @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
  @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
  quit if $interrupted > 0
  myself.nick = @config['irc.nick']
  myself.user = @config['irc.user']
end

- (Object) ctcp_notice(where, command, message, options = {}) 



1280
1281
1282
1283
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1280

def ctcp_notice(where, command, message, options={})
  return if where.kind_of?(Channel) and quiet_on?(where)
  sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
end

- (Object) ctcp_say(where, command, message, options = {}) 



1285
1286
1287
1288
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1285

def ctcp_say(where, command, message, options={})
  return if where.kind_of?(Channel) and quiet_on?(where)
  sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
end

- (Object) default_db

Determine if tokyocabinet is installed, if it is use it as a default.



834
835
836
837
838
839
840
841
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 834

def default_db
  begin
    require 'tokyocabinet'
    return 'tc'
  rescue LoadError
    return 'dbm'
  end
end

- (Object) default_ssl_ca_file

Determine (if possible) a valid path to a CA certificate bundle.



818
819
820
821
822
823
824
825
826
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 818

def default_ssl_ca_file
  [ '/etc/ssl/certs/ca-certificates.crt', # Ubuntu/Debian
    '/etc/ssl/certs/ca-bundle.crt', # Amazon Linux
    '/etc/ssl/ca-bundle.pem', # OpenSUSE
    '/etc/pki/tls/certs/ca-bundle.crt' # Fedora/RHEL
  ].find do |file|
    File.readable? file
  end
end

- (Object) default_ssl_ca_path 



828
829
830
831
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 828

def default_ssl_ca_path
  file = default_ssl_ca_file
  File.dirname file if file
end

- (Object) disconnect(message = nil) 



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1311

def disconnect(message=nil)
  message = @lang.get("quit") if (!message || message.empty?)
  if @socket.connected?
    begin
      debug "Clearing socket"
      @socket.clearq
      debug "Sending quit message"
      @socket.emergency_puts "QUIT :#{message}"
      debug "Logging quits"
      delegate_sent('QUIT', myself, message)
      debug "Flushing socket"
      @socket.flush
    rescue SocketError => e
      error "error while disconnecting socket: #{e.pretty_inspect}"
    end
    debug "Shutting down socket"
    @socket.shutdown
  end
  stop_server_pings
  @client.reset
end

- (Object) filter(*args)

call-seq:

filter(filter1, filter2, ..., filterN, stream) -> stream
filter(filter1, filter2, ..., filterN, text, hash) -> stream
filter(filter1, filter2, ..., filterN, hash) -> stream

This method processes the DataStream stream with the filters filter1, filter2, …, filterN, in sequence (the output of each filter is used as input for the next one. stream can be provided either as a DataStream or as a String and a Hash (see DataStream.new).



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 63

def filter(*args)
  @filters ||= {}
  if Hash === args.last
    # the stream is a Hash, check if the previous element is not a Symbol
    if Symbol === args[-2]
      ds = DataStream.new(args.pop)
    else
      ds = DataStream.new(*args.slice!(-2, 2))
    end
  else
    # the stream is just whatever else
    ds = DataStream.new(args.pop)
  end
  names = args.dup
  return ds if names.empty?
  # check if filters exist
  missing = names - @filters.keys
  raise "Missing filters: #{missing.join(', ')}" unless missing.empty?
  fs = @filters.values_at(*names)
  fs.inject(ds) { |mid, f| mid = f.call(mid) }
end

- (Object) filter_groups

This method is used to retrieve the filter group names



136
137
138
139
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 136

def filter_groups
  return [] unless defined? @filter_group
  return @filter_group.keys
end

- (Object) filter_names(group = nil)

This method is used to retrieve the filter names (in a given group)



124
125
126
127
128
129
130
131
132
133
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 124

def filter_names(group=nil)
  if group
    gkey = group.to_sym
    return [] unless defined? @filter_group and @filter_group.key?(gkey)
    return @filter_group[gkey].keys
  else
    return [] unless defined? @filters
    return @filters.keys
  end
end

- (Object) global_filter_name(name, group = nil)

This method returns the global filter name for filter name in group group



87
88
89
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 87

def global_filter_name(name, group=nil)
  (group ? "#{group}.#{name}" : name.to_s).intern
end

- (Object) handle_signal(sig)

things to do when we receive a signal



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 943

def handle_signal(sig)
  func = case sig
         when 'SIGHUP'
           :restart
         when 'SIGUSR1'
           :reconnect
         else
           :quit
         end
  debug "received #{sig}, queueing #{func}"
  # this is not an interruption if we just need to reconnect
  $interrupted += 1 unless func == :reconnect
  self.send(func) unless @quit_mutex.locked?
  debug "interrupted #{$interrupted} times"
  if $interrupted >= 3
    debug "drastic!"
    log_session_end
    exit 2
  end
end

- (Boolean) has_filter?(name, group = nil)

This method checks if the bot has a filter named name (in group group)

Returns:

  • (Boolean) 


93
94
95
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 93

def has_filter?(name, group=nil)
  @filters.key?(global_filter_name(name, group))
end

- (Boolean) has_filter_group?(name)

This method checks if the bot has a filter group named name

Returns:

  • (Boolean) 


98
99
100
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 98

def has_filter_group?(name)
  @filter_group.key?(name)
end

- (Object) help(topic = nil)

m

message asking for help

topic

optional topic help is requested for

respond to online help requests



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1457

def help(topic=nil)
  topic = nil if topic == ""
  case topic
  when nil
    helpstr = _("help topics: ")
    helpstr += @plugins.helptopics
    helpstr += _(" (help <topic> for more info)")
  else
    unless(helpstr = @plugins.help(topic))
      helpstr = _("no help for topic %{topic}") % { :topic => topic }
    end
  end
  return helpstr
end

- (Object) inspect

bot inspection TODO multiserver



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 247

def inspect
  ret = self.to_s[0..-2]
  ret << ' version=' << $version.inspect
  ret << ' botclass=' << botclass.inspect
  ret << ' lang="' << lang.language
  if defined?(GetText)
    ret << '/' << locale
  end
  ret << '"'
  ret << ' nick=' << nick.inspect
  ret << ' server='
  if server
    ret << (server.to_s + (socket ?
      ' [' << socket.server_uri.to_s << ']' : '')).inspect
    unless server.channels.empty?
      ret << " channels="
      ret << server.channels.map { |c|
        "%s%s" % [c.modes_of(nick).map { |m|
          server.prefix_for_mode(m)
        }, c.name]
      }.inspect
    end
  else
    ret << '(none)'
  end
  ret << ' plugins=' << plugins.inspect
  ret << ">"
end

- (Object) join(channel, key = nil)

channel

channel to join

key

optional channel key if channel is +s

join a channel



1421
1422
1423
1424
1425
1426
1427
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1421

def join(channel, key=nil)
  if(key)
    sendq "JOIN #{channel} :#{key}", channel, 2
  else
    sendq "JOIN #{channel}", channel, 2
  end
end

- (Object) kick(channel, user, msg)

kicking a user



1450
1451
1452
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1450

def kick(channel, user, msg)
  sendq "KICK #{channel} #{user} :#{msg}", channel, 2
end

- (Object) mainloop

begin event handling loop



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1044

def mainloop
  while true
    too_fast = 0
    quit_msg = nil
    valid_recv = false # did we receive anything (valid) from the server yet?
    begin
      reconnect(quit_msg, too_fast)
      quit if $interrupted > 0
      valid_recv = false
      while @socket.connected?
        quit if $interrupted > 0

        # Wait for messages and process them as they arrive. If nothing is
        # received, we call the ping_server() method that will PING the
        # server if appropriate, or raise a TimeoutError if no PONG has been
        # received in the user-chosen timeout since the last PING sent.
        if @socket.select(1)
          break unless reply = @socket.gets
          @last_rec = Time.now
          @client.process reply
          valid_recv = true
          too_fast = 0
        else
          ping_server
        end
      end

    # I despair of this. Some of my users get "connection reset by peer"
    # exceptions that ARENT SocketError's. How am I supposed to handle
    # that?
    rescue SystemExit
      log_session_end
      exit 0
    rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
      error "network exception: #{e.pretty_inspect}"
      quit_msg = e.to_s
      too_fast += 10 if valid_recv
    rescue ServerMessageParseError => e
      # if the bot tried reconnecting too often, we can get forcefully
      # disconnected by the server, while still receiving an empty message
      # wait at least 10 minutes in this case
      if e.message.empty?
        oldtf = too_fast
        too_fast = [too_fast, 300].max
        too_fast*= 2
        log "Empty message from server, extra delay multiplier #{oldtf} -> #{too_fast}"
      end
      quit_msg = "Unparseable Server Message: #{e.message.inspect}"
      retry
    rescue ServerError => e
      quit_msg = "server ERROR: " + e.message
      debug quit_msg
      idx = e.message.index("connect too fast")
      debug "'connect too fast' @ #{idx}"
      if idx
        oldtf = too_fast
        too_fast += (idx+1)*2
        log "Reconnecting too fast, extra delay multiplier #{oldtf} -> #{too_fast}"
      end
      idx = e.message.index(/a(uto)kill/i)
      debug "'autokill' @ #{idx}"
      if idx
        # we got auto-killed. since we don't have an easy way to tell
        # if it's permanent or temporary, we just set a rather high
        # reconnection timeout
        oldtf = too_fast
        too_fast += (idx+1)*5
        log "Killed by server, extra delay multiplier #{oldtf} -> #{too_fast}"
      end
      retry
    rescue Exception => e
      error "non-net exception: #{e.pretty_inspect}"
      quit_msg = e.to_s
    rescue => e
      fatal "unexpected exception: #{e.pretty_inspect}"
      log_session_end
      exit 2
    end
  end
end

- (Object) mode(channel, mode, target = nil)

changing mode



1440
1441
1442
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1440

def mode(channel, mode, target=nil)
  sendq "MODE #{channel} #{mode} #{target}", channel, 2
end

- (Object) myself

bot User in the client/server connection TODO multiserver



215
216
217
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 215

def myself
  @client.user
end

- (Object) nick

bot nick in the client/server connection



220
221
222
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 220

def nick
  myself.nick
end

- (Object) nickchg(name)

attempt to change bot's nick to name



1435
1436
1437
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1435

def nickchg(name)
  sendq "NICK #{name}"
end

- (Object) notice(where, message, options = {})

send a notice message to channel/nick where



1269
1270
1271
1272
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1269

def notice(where, message, options={})
  return if where.kind_of?(Channel) and quiet_on?(where)
  sendmsg "NOTICE", where, message, options
end

- (Object) okay(where)

quick way to say “okay” (or equivalent) to where



1296
1297
1298
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1296

def okay(where)
  say where, @lang.get("okay")
end

- (Object) part(channel, message = "")

part a channel



1430
1431
1432
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1430

def part(channel, message="")
  sendq "PART #{channel} :#{message}", channel, 2
end

- (Object) path(*components)

Return a path under the current botclass by joining the mentioned components. The components are automatically converted to String



870
871
872
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 870

def path(*components)
  File.join(@botclass, *(components.map {|c| c.to_s}))
end

- (Object) ping_server

We want to respond to a hung server in a timely manner. If nothing was received in the user-selected timeout and we haven't PINGed the server yet, we PING the server. If the PONG is not received within the user-defined timeout, we assume we're in ping timeout and act accordingly.



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1488

def ping_server
  act_timeout = @config['server.ping_timeout']
  return if act_timeout <= 0
  now = Time.now
  if @last_rec && now > @last_rec + act_timeout
    if @last_ping.nil?
      # No previous PING pending, send a new one
      sendq "PING :rbot"
      @last_ping = Time.now
    else
      diff = now - @last_ping
      if diff > act_timeout
        debug "no PONG from server in #{diff} seconds, reconnecting"
        # the actual reconnect is handled in the main loop:
        raise TimeoutError, "no PONG from server in #{diff} seconds"
      end
    end
  end
end

- (Boolean) quiet_on?(channel)

checks if we should be quiet on a channel

Returns:

  • (Boolean) 


914
915
916
917
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 914

def quiet_on?(channel)
  ch = channel.downcase
  return (@quiet.include?('*') && !@not_quiet.include?(ch)) || @quiet.include?(ch)
end

- (Object) quit(message = nil)

message

optional IRC quit message

quit IRC, shutdown the bot



1369
1370
1371
1372
1373
1374
1375
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1369

def quit(message=nil)
  begin
    shutdown(message)
  ensure
    exit 0
  end
end

- (Object) reconnect(message = nil, too_fast = 0)

disconnect the bot from IRC, if connected, and then connect (again)



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1005

def reconnect(message=nil, too_fast=0)
  # we will wait only if @last_rec was not nil, i.e. if we were connected or
  # got disconnected by a network error
  # if someone wants to manually call disconnect() _and_ reconnect(), they
  # will have to take care of the waiting themselves
  will_wait = !!@last_rec

  if @socket.connected?
    disconnect(message)
  end

  begin
    if will_wait
      log "\n\nDisconnected\n\n"

      quit if $interrupted > 0

      log "\n\nWaiting to reconnect\n\n"
      sleep @config['server.reconnect_wait']
      if too_fast > 0
        tf = too_fast*@config['server.reconnect_wait']
        tfu = Utils.secs_to_string(tf)
        log "Will sleep for an extra #{tf}s (#{tfu})"
        sleep tf
      end
    end

    connect
  rescue SystemExit
    log_session_end
    exit 0
  rescue Exception => e
    error e
    will_wait = true
    retry
  end
end

- (Object) register_filter(name, group = nil, &block)

This method is used to register a new filter



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/utils/filters.rb', line 103

def register_filter(name, group=nil, &block)
  raise "No block provided" unless block_given?
  @filters ||= {}
  tlkey = global_filter_name(name, group)
  key = name.to_sym
  if has_filter?(tlkey)
    debug "Overwriting filter #{tlkey}"
  end
  @filters[tlkey] = DataFilter.new(&block)
  if group
    gkey = group.to_sym
    @filter_group ||= {}
    @filter_group[gkey] ||= {}
    if @filter_group[gkey].key?(key)
      debug "Overwriting filter #{key} in group #{gkey}"
    end
    @filter_group[gkey][key] = @filters[tlkey]
  end
end

- (Object) repopulate_botclass_directory 



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 843

def repopulate_botclass_directory
  template_dir = File.join Config::datadir, 'templates'
  if FileTest.directory? @botclass
    # compare the templates dir with the current botclass dir, filling up the
    # latter with any missing file. Sadly, FileUtils.cp_r doesn't have an
    # :update option, so we have to do it manually.
    # Note that we use the */** pattern because we don't want to match
    # keywords.rbot, which gets deleted on load and would therefore be missing
    # always
    missing = Dir.chdir(template_dir) { Dir.glob('*/**') } - Dir.chdir(@botclass) { Dir.glob('*/**') }
    missing.map do |f|
      dest = File.join(@botclass, f)
      FileUtils.mkdir_p(File.dirname(dest))
      FileUtils.cp File.join(template_dir, f), dest
    end
  else
    log "no #{@botclass} directory found, creating from templates..."
    if FileTest.exist? @botclass
      error "file #{@botclass} exists but isn't a directory"
      exit 2
    end
    FileUtils.cp_r template_dir, @botclass
  end
end

- (Object) rescan

call the rescan method for all of the botmodules



1408
1409
1410
1411
1412
1413
1414
1415
1416
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1408

def rescan
  debug "\tstopping timer..."
  @timer.stop
  @save_mutex.synchronize do
    @lang.rescan
    @plugins.rescan
  end
  @timer.start
end

- (Object) reset_quiet(channel = nil) 



931
932
933
934
935
936
937
938
939
940
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 931

def reset_quiet(channel = nil)
  if channel
    ch = channel.downcase.dup
    @quiet.delete(ch)
    @not_quiet << ch
  else
    @quiet.clear
    @not_quiet.clear
  end
end

- (Object) restart(message = nil)

totally shutdown and respawn the bot



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1378

def restart(message=nil)
  message = _("restarting, back in %{wait}...") % {
    :wait => @config['server.reconnect_wait']
  } if (!message || message.empty?)
  shutdown(message)
  sleep @config['server.reconnect_wait']
  begin
    # now we re-exec
    # Note, this fails on Windows
    debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
    log_session_end
    Dir.chdir(@run_dir)
    exec($0, *@argv)
  rescue Errno::ENOENT
    log_session_end
    exec("ruby", *(@argv.unshift $0))
  rescue Exception => e
    $interrupted += 1
    raise e
  end
end

- (Object) save

call the save method for all of the botmodules



1401
1402
1403
1404
1405
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1401

def save
  @save_mutex.synchronize do
    @plugins.save
  end
end

- (Object) say(where, message, options = {})

say something (PRIVMSG) to channel/nick where



1275
1276
1277
1278
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1275

def say(where, message, options={})
  return if where.kind_of?(Channel) and quiet_on?(where)
  sendmsg "PRIVMSG", where, message, options
end

- (Object) sendmsg(original_type, original_where, original_message, options = {})

type

message type

where

message target

message

message text

send message message of type type to target where Type can be PRIVMSG, NOTICE, etc, but those you should really use the relevant say() or notice() methods. This one should be used for IRCd extensions you want to use in modules.



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1132

def sendmsg(original_type, original_where, original_message, options={})

  # filter message with sendmsg filters
  ds = DataStream.new original_message.to_s.dup,
    :type => original_type, :dest => original_where,
    :options => @default_send_options.merge(options)
  filters = filter_names(:sendmsg)
  filters.each do |fname|
    debug "filtering #{ds[:text]} with sendmsg filter #{fname}"
    ds.merge! filter(self.global_filter_name(fname, :sendmsg), ds)
  end

  opts = ds[:options]
  type = ds[:type]
  where = ds[:dest]
  filtered = ds[:text]

  if defined? WebServiceUser and where.instance_of? WebServiceUser
    debug 'sendmsg to web service!'
    where.response << filtered
    return
  end

  # For starters, set up appropriate queue channels and rings
  mchan = opts[:queue_channel]
  mring = opts[:queue_ring]
  if mchan
    chan = mchan
  else
    chan = where
  end
  if mring
    ring = mring
  else
    case where
    when User
      ring = 1
    else
      ring = 2
    end
  end

  multi_line = filtered.gsub(/[\r\n]+/, "\n")

  # if target is a channel with nocolor modes, strip colours
  if where.kind_of?(Channel) and where.mode.any?(*config['server.nocolor_modes'])
    multi_line.replace BasicUserMessage.strip_formatting(multi_line)
  end

  messages = Array.new
  case opts[:newlines]
  when :join
    messages << [multi_line.gsub("\n", opts[:join_with])]
  when :split
    multi_line.each_line { |line|
      line.chomp!
      next unless(line.size > 0)
      messages << line
    }
  else
    raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
  end

  # The IRC protocol requires that each raw message must be not longer
  # than 512 characters. From this length with have to subtract the EOL
  # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
  # that will be prepended by the server to all of our messages.

  # The maximum raw message length we can send is therefore 512 - 2 - 2
  # minus the length of our hostmask.

  max_len = 508 - myself.fullform.size

  # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
  # will have a + or - prepended
  if server.capabilities[:identify-msg"]
    max_len -= 1
  end

  # When splitting the message, we'll be prefixing the following string:
  # (e.g. "PRIVMSG #rbot :")
  fixed = "#{type} #{where} :"

  # And this is what's left
  left = max_len - fixed.size

  truncate = opts[:truncate_text]
  truncate = @default_send_options[:truncate_text] if truncate.size > left
  truncate = "" if truncate.size > left

  all_lines = messages.map { |line|
    if line.size < left
      line
    else
      case opts[:overlong]
      when :split
        msg = line.dup
        sub_lines = Array.new
        begin
          sub_lines << msg.slice!(0, left)
          break if msg.empty?
          lastspace = sub_lines.last.rindex(opts[:split_at])
          if lastspace
            msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
            msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
          end
        end until msg.empty?
        sub_lines
      when :truncate
        line.slice(0, left - truncate.size) << truncate
      else
        raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
      end
    end
  }.flatten

  if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
    lines = all_lines[0...opts[:max_lines]]
    new_last = lines.last.slice(0, left - truncate.size) << truncate
    lines.last.replace(new_last)
  else
    lines = all_lines
  end

  lines.each { |line|
    sendq "#{fixed}#{line}", chan, ring
    delegate_sent(type, where, line)
  }
end

- (Object) sendq(message = "", chan = nil, ring = 0)

queue an arbitraty message for the server



1263
1264
1265
1266
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1263

def sendq(message="", chan=nil, ring=0)
  # temporary
  @socket.queue(message, chan, ring)
end

- (Object) server

server we are connected to TODO multiserver



209
210
211
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 209

def server
  @client.server
end

- (Object) set_default_send_options(opts = {}) 



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 894

def set_default_send_options(opts={})
  # Default send options for NOTICE and PRIVMSG
  unless defined? @default_send_options
    @default_send_options = {
      :queue_channel => nil,      # use default queue channel
      :queue_ring => nil,         # use default queue ring
      :newlines => :split,        # or :join
      :join_with => ' ',          # by default, use a single space
      :max_lines => 0,          # maximum number of lines to send with a single command
      :overlong => :split,        # or :truncate
      # TODO an array of splitpoints would be preferrable for this option:
      :split_at => /\s+/,         # by default, split overlong lines at whitespace
      :purge_split => true,       # should the split string be removed?
      :truncate_text => "#{Reverse}...#{Reverse}"  # text to be appened when truncating
    }
  end
  @default_send_options.update opts unless opts.empty?
end

- (Object) set_quiet(channel = nil) 



919
920
921
922
923
924
925
926
927
928
929
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 919

def set_quiet(channel = nil)
  if channel
    ch = channel.downcase.dup
    @not_quiet.delete(ch)
    @quiet << ch
  else
    @quiet.clear
    @not_quiet.clear
    @quiet << '*'
  end
end

- (Object) setup_plugins_path 



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 874

def setup_plugins_path
  plugdir_default = File.join(Config::datadir, 'plugins')
  plugdir_local = File.join(@botclass, 'plugins')
  Dir.mkdir(plugdir_local) unless File.exist?(plugdir_local)

  @plugins.clear_botmodule_dirs
  @plugins.add_core_module_dir(File.join(Config::coredir, 'utils'))
  @plugins.add_core_module_dir(Config::coredir)
  if FileTest.directory? plugdir_local
    @plugins.add_plugin_dir(plugdir_local)
  else
    warning "local plugin location #{plugdir_local} is not a directory"
  end

  @config['plugins.path'].each do |_|
      path = _.sub(/^\(default\)/, plugdir_default)
      @plugins.add_plugin_dir(path)
  end
end

- (Object) shutdown(message = nil)

disconnect from the server and cleanup all plugins and modules



1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1334

def shutdown(message=nil)
  @quit_mutex.synchronize do
    debug "Shutting down: #{message}"
    ## No we don't restore them ... let everything run through
    # begin
    #   trap("SIGINT", "DEFAULT")
    #   trap("SIGTERM", "DEFAULT")
    #   trap("SIGHUP", "DEFAULT")
    # rescue => e
    #   debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
    # end
    debug "\tdisconnecting..."
    disconnect(message)
    debug "\tstopping timer..."
    @timer.stop
    debug "\tsaving ..."
    save
    debug "\tcleaning up ..."
    @save_mutex.synchronize do
      begin
        @plugins.cleanup
      rescue
        debug "\tignoring cleanup error: #{$!}"
      end
    end
    # debug "\tstopping timers ..."
    # @timer.stop
    # debug "Closing registries"
    # @registry.close
    log "rbot quit (#{message})"
  end
end

- (Object) status

returns a string describing the current status of the bot (uptime etc)



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1473

def status
  secs_up = Time.new - @startup_time
  uptime = Utils.secs_to_string secs_up
  # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
  return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
           {
             :up => uptime, :plug => @plugins.length,
             :sent => @socket.lines_sent, :recv => @socket.lines_received
           })
end

- (Object) stop_server_pings 



1508
1509
1510
1511
1512
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1508

def stop_server_pings
  # cancel previous PINGs and reset time of last RECV
  @last_ping = nil
  @last_rec = nil
end

- (Object) topic(where, topic = nil)

set topic of channel where to topic can also be used to retrieve the topic of channel where by omitting the last argument



1303
1304
1305
1306
1307
1308
1309
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1303

def topic(where, topic=nil)
  if topic.nil?
    sendq "TOPIC #{where}", where, 2
  else
    sendq "TOPIC #{where} :#{topic}", where, 2
  end
end

- (Object) trap_signals

trap signals



965
966
967
968
969
970
971
972
973
974
975
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 965

def trap_signals
  begin
    %w(SIGINT SIGTERM SIGHUP SIGUSR1).each do |sig|
      trap(sig) { Thread.new { handle_signal sig } }
    end
  rescue ArgumentError => e
    debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
  rescue Exception => e
    debug "failed to trap signals: #{e.pretty_inspect}"
  end
end

- (Object) wanted_nick

nick wanted by the bot. This defaults to the irc.nick config value, but may be overridden by a manual !nick command



231
232
233
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 231

def wanted_nick
  @wanted_nick || config['irc.nick']
end

- (Object) wanted_nick=(wn)

set the nick wanted by the bot



236
237
238
239
240
241
242
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 236

def wanted_nick=(wn)
  if wn.nil? or wn.to_s.downcase == config['irc.nick'].downcase
    @wanted_nick = nil
  else
    @wanted_nick = wn.to_s.dup
  end
end

- (Object) web_dispatcher

Static web dispatcher instance used internally.



278
279
280
281
282
283
284
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 278

def web_dispatcher
  if defined? @web_dispatcher
    @web_dispatcher
  else
    @web_dispatcher = WebDispatcher.new(self)
  end
end

- (Object) whois(nick, target = nil)

asking whois



1445
1446
1447
 
# File '/home/apoc/projects/ruby/rbot/lib/rbot/ircbot.rb', line 1445

def whois(nick, target=nil)
  sendq "WHOIS #{target} #{nick}", nil, 0
end