1 # Automatically lookup nicks in @registry and identify when asked
2 # Takes over proper nick if required and nick is registered
3 # TODO allow custom IDENTIFY and GHOST names
4 # TODO instead of nickserv.wait it would be ideal if we could just
5 # set up "don't send further commands until you receive this particular message"
7 class NickServPlugin < Plugin
9 BotConfig.register BotConfigStringValue.new('nickserv.name',
10 :default => "NickServ", :requires_restart => false,
11 :desc => "Name of the nick server")
12 BotConfig.register BotConfigStringValue.new('nickserv.ident_request',
13 :default => "IDENTIFY", :requires_restart => false,
14 :on_change => Proc.new { |bot, v| bot.plugins.delegate "set_ident_request", v },
15 :desc => "String to look for to see if the nick server is asking us to identify")
16 BotConfig.register BotConfigIntegerValue.new('nickserv.wait',
17 :default => 30, :validate => Proc.new { |v| v > 0 }, :requires_restart => false,
18 :desc => "Seconds to wait after sending a message to nickserv, e.g. after ghosting")
20 def help(plugin, topic="")
23 return "nickserv plugin: handles nickserv protected IRC nicks. topics password, register, identify, listnicks"
25 return "nickserv password <nick> <passwd>: remember the password for nick <nick> and use it to identify in future"
27 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"
29 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"
31 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"
36 # generate a random password
39 passwd += (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr
44 def set_ident_request(val)
45 @ident_request = Regexp.new(val)
50 # this plugin only wants to store strings!
59 set_ident_request(@bot.config['nickserv.ident_request'])
62 def password(m, params)
63 @registry[params[:nick]] = params[:passwd]
67 def nick_register(m, params)
68 passwd = params[:passwd] ? params[:passwd] : genpasswd
69 message = "REGISTER #{passwd}"
70 message += " #{params[:email]}" if params[:email]
71 @bot.sendmsg "PRIVMSG", @bot.config['nickserv.name'], message
72 @registry[@bot.nick] = passwd
76 def listnicks(m, params)
77 if @registry.length > 0
79 @bot.say m.sourcenick, "#{k} => #{v}"
86 def do_identify(nick=@bot.nick)
87 if @registry.has_key?(nick)
88 @bot.sendmsg "PRIVMSG", @bot.config['nickserv.name'], "IDENTIFY #{nick} #{@registry[nick]}"
94 def identify(m, params)
98 m.reply "I dunno the nickserv password for the nickname #{@bot.nick} :("
107 if @registry.has_key?(nick)
108 @bot.sendmsg "PRIVMSG", @bot.config['nickserv.name'], "GHOST #{nick} #{@registry[@bot.nick]}"
110 sleep @bot.config['nickserv.wait']
112 # We need to wait after changing nick, otherwise the server
113 # might refuse to execute further commangs, e.g. subsequent JOIN
114 # commands until the nick has changed.
115 sleep @bot.config['nickserv.wait']
120 return unless(m.kind_of? NoticeMessage)
122 if (m.sourcenick == @bot.config['nickserv.name'] && m.message =~ @ident_request)
123 debug "nickserv asked us to identify for nick #{@bot.nick}"
129 plugin = NickServPlugin.new
130 plugin.map 'nickserv password :nick :passwd', :action => "password"
131 plugin.map 'nickserv register :passwd :email', :action => 'nick_register',
132 :defaults => {:passwd => false, :email => false}
133 plugin.map 'nickserv listnicks', :action => "listnicks"
134 plugin.map 'nickserv identify', :action => "identify"