-# automatically lookup nicks in @registry and identify when asked
-# TODO customize name of nickserv
+#-- vim:sw=2:et
+#++
+#
+# :title: Nickserv management plugin for rbot
+#
+# Author:: Tom Gilbert (giblet) <tom@linuxbrit.co.uk>
+# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
+#
+# Copyright:: (C) 2002-2005 Tom Gilbert
+# Copyright:: (C) 2006 Tom Gilbert, Giuseppe Bilotta
+# Copyright:: (C) 2006-2007 Giuseppe Bilotta
+#
+# Automatically lookup nicks in @registry and identify when asked
+#
+# Takes over proper nick if required and nick is registered
+
+# TODO:: allow custom IDENTIFY and GHOST names
+#
+# FIXME:: identified? status returns false after a rescan, even if the bot
+# previously identified successfully
class NickServPlugin < Plugin
-
- BotConfig.register BotConfigStringValue.new('nickserv.name',
- :default => "NickServ", :requires_restart => false,
- :desc => "Name of the nick server")
- BotConfig.register BotConfigStringValue.new('nickserv.ident_request',
+
+ Config.register Config::StringValue.new('nickserv.name',
+ :default => "nickserv", :requires_restart => false,
+ :desc => _("Name of the nick server (all lowercase)"))
+
+ Config.register Config::StringValue.new('nickserv.ident_request',
:default => "IDENTIFY", :requires_restart => false,
:on_change => Proc.new { |bot, v| bot.plugins.delegate "set_ident_request", v },
- :desc => "String to look for to see if the nick server is asking us to identify")
- BotConfig.register BotConfigIntegerValue.new('nickserv.wait',
+ :desc => _("String to look for to see if the nick server is asking us to identify"))
+ Config.register Config::StringValue.new('nickserv.nick_avail',
+ :default => "not (currently )?online|killed|ghosted|recovered|disconnesso|libero",
+ :requires_restart => false,
+ :on_change => Proc.new { |bot, v| bot.plugins.delegate "set_nick_avail", v },
+ :desc => _("String to look for to see if the nick server is informing us that our nick is now available"))
+ Config.register Config::StringValue.new('nickserv.identified_string',
+ :default => "((Password|Contrase|Mot de passe).+(acce[pt]t|r[ie]cog?n).+)?(you|tu|vous|now|adesso).+(identif|r[ie]cog?n)",
+ :requires_restart => false,
+ :on_change => Proc.new { |bot, v| bot.plugins.delegate "set_identified_string", v },
+ :desc => _("String to look for to see if the nick server is informing us that we have identified successfully"))
+
+ Config.register Config::BooleanValue.new('nickserv.wants_nick',
+ :default => false, :requires_restart => false,
+ :desc => _("Set to false if the nick server doesn't expect the nick as a parameter in the identify command"))
+
+ Config.register Config::IntegerValue.new('nickserv.wait',
:default => 30, :validate => Proc.new { |v| v > 0 }, :requires_restart => false,
- :desc => "Seconds to wait after sending a message to nickserv, e.g. after ghosting")
+ :desc => _("Seconds to wait after sending a message to nickserv, e.g. after ghosting"))
def help(plugin, topic="")
case topic
when ""
- return "nickserv plugin: handles nickserv protected IRC nicks. topics password, register, identify, listnicks"
+ return _("nickserv plugin: handles nickserv protected IRC nicks. topics: password, register, identify, listnicks")
when "password"
- return "nickserv password <nick> <passwd>: remember the password for nick <nick> and use it to identify in future"
+ return _("nickserv password [<nick>] <passwd>: remember the password for nick <nick> and use it to identify in future")
when "register"
- return "nickserv register [<password> [<email>]]: register the current nick, choosing a random password unless <password> is supplied - current nick must not already be registered for this to work. Also specify email if required by your services"
+ return _("nickserv register [<password> [<email>]]: register the current nick, choosing a random password unless <password> is supplied - current nick must not already be registered for this to work. Also specify email if required by your services")
when "identify"
- return "nickserv identify: identify with nickserv - shouldn't be needed - bot should identify with nickserv immediately on request - however this could be useful after splits or service disruptions, or when you just set the password for the current nick"
+ return _("nickserv identify: identify with nickserv - shouldn't be needed - bot should identify with nickserv immediately on request - however this could be useful after splits or service disruptions, or when you just set the password for the current nick")
when "listnicks"
- return "nickserv listnicks: lists nicknames and associated password the bot knows about - you will need config level auth access to do this one and it will reply by privmsg only"
+ return _("nickserv listnicks: lists nicknames and associated password the bot knows about - you will need config level auth access to do this one and it will reply by privmsg only")
end
end
-
+
def genpasswd
- # generate a random password
- passwd = ""
- 8.times do
- passwd += (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr
- end
- return passwd
+ return Irc::Bot::Auth.random_password
end
def set_ident_request(val)
- @ident_request = Regexp.new(val)
+ @ident_request = Regexp.new(val, true)
+ end
+
+ def set_nick_avail(val)
+ @nick_avail = Regexp.new(val, true)
+ end
+
+ def set_identified_string(val)
+ @identified_string = Regexp.new(val, true)
end
def initialize
end
end
set_ident_request(@bot.config['nickserv.ident_request'])
+ set_nick_avail(@bot.config['nickserv.nick_avail'])
+ set_identified_string(@bot.config['nickserv.identified_string'])
+ @identified = false
+ end
+
+ # Returns the nickserv name
+ def ns_nick
+ @bot.config['nickserv.name']
+ end
+
+ # say something to nickserv
+ def ns_say(msg)
+ @bot.say ns_nick, msg
end
def password(m, params)
- @registry[params[:nick]] = params[:passwd]
+ nick = params[:nick] || @bot.nick
+ passwd = params[:passwd]
+ if nick == @bot.nick
+ ns_say "SET PASSWORD #{passwd}"
+ else
+ m.reply(_("I'm only changing this in my database, I won't inform %{ns_nick} of the change") % {:ns_nick => ns_nick})
+ end
+ @registry[nick] = passwd
m.okay
end
passwd = params[:passwd] ? params[:passwd] : genpasswd
message = "REGISTER #{passwd}"
message += " #{params[:email]}" if params[:email]
- @bot.sendmsg "PRIVMSG", @bot.config['nickserv.name'], message
+ ns_say message
@registry[@bot.nick] = passwd
m.okay
end
@bot.say m.sourcenick, "#{k} => #{v}"
}
else
- m.reply "none known"
+ m.reply _("none known")
end
end
def do_identify(nick=@bot.nick)
if @registry.has_key?(nick)
- @bot.sendmsg "PRIVMSG", @bot.config['nickserv.name'], "IDENTIFY #{nick} #{@registry[nick]}"
+ if @bot.config['nickserv.wants_nick']
+ ns_say "IDENTIFY #{nick} #{@registry[nick]}"
+ else
+ if nick == @bot.nick
+ ns_say "IDENTIFY #{@registry[nick]}"
+ else
+ # We cannot identify for different nicks if we can't use the nickname ...
+ return false
+ end
+ end
return true
end
- return false
+ return nil
end
def identify(m, params)
- if do_identify
+ ided = do_identify
+ case ided
+ when true
m.okay
+ when false
+ m.reply _("I cannot identify for a this nick")
+ when nil
+ m.reply(_("I dunno the nickserv password for the nickname %{botnick} :(") % {:botnick => @bot.nick})
else
- m.reply "I dunno the nickserv password for the nickname #{@bot.nick} :("
+ m.reply _("uh ... something went wrong ...")
end
end
-
+
def connect
+ @identified = false
do_identify
end
-
+
def nicktaken(nick)
if @registry.has_key?(nick)
- @bot.sendmsg "PRIVMSG", @bot.config['nickserv.name'], "GHOST #{nick} #{@registry[@bot.nick]}"
- do_identify nick
- sleep @bot.config['nickserv.wait']
- @bot.nickchg nick
+ ns_say "GHOST #{nick} #{@registry[nick]}"
end
end
-
- def listen(m)
- return unless(m.kind_of? NoticeMessage)
- if (m.sourcenick == @bot.config['nickserv.name'] && m.message =~ @ident_request)
+ def notice(m)
+ return unless m.source.downcase == ns_nick.downcase
+
+ case m.message
+ when @ident_request
debug "nickserv asked us to identify for nick #{@bot.nick}"
do_identify
+ when @nick_avail
+ debug "our nick seems to be free now"
+ @bot.nickchg @bot.config['irc.nick']
+ when @identified_string
+ debug "we identified successfully to nickserv"
+ @identified = true
+ @bot.plugins.delegate('identified')
end
end
+ def identified?
+ return @identified
+ end
+
end
plugin = NickServPlugin.new
-plugin.map 'nickserv password :nick :passwd', :action => "password"
+plugin.map 'nickserv password [:nick] :passwd', :action => "password"
plugin.map 'nickserv register :passwd :email', :action => 'nick_register',
:defaults => {:passwd => false, :email => false}
plugin.map 'nickserv listnicks', :action => "listnicks"
plugin.map 'nickserv identify', :action => "identify"
+
+plugin.default_auth('*', false)
+
projects / user / henk / code / ruby / rbot.git / blobdiff