-# automatically lookup nicks in @registry and identify when asked
-# TODO customize name of nickserv
+# 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
+# TODO instead of nickserv.wait it would be ideal if we could just
+# set up "don't send further commands until you receive this particular message"
class NickServPlugin < Plugin
BotConfig.register BotConfigStringValue.new('nickserv.name',
- :default => "NickServ", :requires_restart => false,
- :desc => "Name of the nick server")
+ :default => "nickserv", :requires_restart => false,
+ :desc => "Name of the nick server (all lowercase)")
BotConfig.register BotConfigStringValue.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 BotConfigBooleanValue.new('nickserv.wants_nick',
+ :default => true, :requires_restart => false,
+ :desc => "Set to false if the nick server doesn't expect the nick as a parameter in the identify command")
BotConfig.register BotConfigIntegerValue.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")
when ""
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"
when "identify"
set_ident_request(@bot.config['nickserv.ident_request'])
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"
+ 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
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
- else
+ when false
+ m.reply "I cannot identify for a this nick"
+ when nil
m.reply "I dunno the nickserv password for the nickname #{@bot.nick} :("
+ else
+ m.reply "uh ... something went wrong ..."
end
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]}"
+ if do_identify nick
+ sleep @bot.config['nickserv.wait']
+ @bot.nickchg nick
+ # We need to wait after changing nick, otherwise the server
+ # might refuse to execute further commangs, e.g. subsequent JOIN
+ # commands until the nick has changed.
+ sleep @bot.config['nickserv.wait']
+ else
+ debug "Failed to identify for nick #{nick}, cannot take over"
+ end
end
end
-
+
def listen(m)
return unless(m.kind_of? NoticeMessage)
- if (m.sourcenick == @bot.config['nickserv.name'] && m.message =~ @ident_request)
+ if (m.sourcenick == ns_nick && m.message =~ @ident_request)
debug "nickserv asked us to identify for nick #{@bot.nick}"
do_identify
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)
+