#-- vim:sw=2:et
#++
#
# :title: Nick recovery
#
# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
#
# Copyright:: (C) 2008 Giuseppe Bilotta
#
# This plugin tries to automatically recover the bot's wanted nick
# in case it couldn't be achieved.

class NickRecoverPlugin < Plugin

  Config.register Config::IntegerValue.new('irc.nick_retry',
    :default => 60, :valiedate => Proc.new { |v| v >= 0 },
    :on_change => Proc.new do |bot, v|
      if v > 0
        bot.plugin['nickrecover'].start_recovery(v)
      else
        bot.plugin['nickrecover'].stop_recovery
      end
    end, :requires_restart => false,
    :desc => _("Time in seconds to wait between attempts to recover the nick. set to 0 to disable nick recovery."))

  def help(plugin,topic="")
    [
      _("the nickrecover plugin takes care of recovering the bot nick by trying to change nick until it succeeds."),
      _("the plugin waits irc.nick_retry seconds between attempts."),
      _("set irc.nick_retry to 0 to disable it.")
    ].join(' ')
  end

  def enabled?
    @bot.config['irc.nick_retry'] > 0
  end

  def poll_time
    @bot.config['irc.nick_retry']
  end

  def wanted_nick
    @bot.wanted_nick
  end

  def has_nick?
    @bot.nick.downcase == wanted_nick.downcase
  end

  def recover
    @bot.nickchg wanted_nick
  end

  def stop_recovery
    begin
      @bot.timer.remove(@recovery) if @recovery
    ensure
      @recovery = nil
    end
  end

  def start_recovery(time=self.poll_time)
    if @recovery
      begin
        @bot.timer.reschedule(@recovery, poll_time)
        return
      rescue
        @recovery=nil
      end
    end
    @recovery = @bot.timer.add(time) do
      has_nick? ? stop_recovery : recover
    end
  end

  def initialize
    super
    @recovery = nil
  end

  def connect
    if enabled?
      start_recovery unless has_nick?
    end
  end

  def nick(m)
    return unless m.address?
    # if recovery is enabled and the nick is not the wanted nick,
    # launch the recovery process. Stop it otherwise
    if enabled? and m.newnick.downcase != wanted_nick.downcase
      start_recovery
    else
      stop_recovery
    end
  end

  def cleanup
    stop_recovery
  end

end

plugin = NickRecoverPlugin.new