Switch to recommended form of GPLv3 permissions notice.

[bpt/emacs.git] / lisp / erc / erc-services.el

diff --git a/lisp/erc/erc-services.el b/lisp/erc/erc-services.el
index a2cc1b1..5062816 100644 (file)
--- a/lisp/erc/erc-services.el
+++ b/lisp/erc/erc-services.el
@@ -1,13 +1,13 @@
 ;;; erc-services.el --- Identify to NickServ
 
 ;;; erc-services.el --- Identify to NickServ
 

-;; Copyright (C) 2002, 2003, 2004, 2006, 2007 Free Software Foundation, Inc.
+;; Copyright (C) 2002, 2003, 2004, 2006, 2007, 2008 Free Software Foundation, Inc.

 
 ;; This file is part of GNU Emacs.
 
 
 ;; This file is part of GNU Emacs.
 

-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify

 ;; it under the terms of the GNU General Public License as published by
 ;; it under the terms of the GNU General Public License as published by

-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.

 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -15,9 +15,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License

-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

 
 ;;; Commentary:
 
 
 ;;; Commentary:
 


@@ -29,9 +27,10 @@
 ;; are made to test if NickServ is the real NickServ for a given network or
 ;; server.
 
 ;; are made to test if NickServ is the real NickServ for a given network or
 ;; server.
 

-;; As a default, ERC has the data for the official nickname services on the
-;; networks Austnet, BrasNET, Dalnet, freenode, GalaxyNet, and Slashnet.
-;; You can add more by using M-x customize-variable RET erc-nickserv-alist.
+;; As a default, ERC has the data for the official nickname services on
+;; the networks Austnet, BrasNET, Dalnet, freenode, GalaxyNet, GRnet,
+;; and Slashnet.  You can add more by using M-x customize-variable RET
+;; erc-nickserv-alist.

 
 ;; Usage:
 ;;
 
 ;; Usage:
 ;;


@@ -109,7 +108,9 @@ You can also use M-x erc-nickserv-identify-mode to change modes."
    (remove-hook 'erc-after-connect
                'erc-nickserv-identify-on-connect)
    (remove-hook 'erc-nick-changed-functions
    (remove-hook 'erc-after-connect
                'erc-nickserv-identify-on-connect)
    (remove-hook 'erc-nick-changed-functions

-               'erc-nickserv-identify-on-nick-change)))
+               'erc-nickserv-identify-on-nick-change)
+   (remove-hook 'erc-server-NOTICE-functions
+               'erc-nickserv-identification-autodetect)))

 
 ;;;###autoload
 (defun erc-nickserv-identify-mode (mode)
 
 ;;;###autoload
 (defun erc-nickserv-identify-mode (mode)


@@ -118,6 +119,12 @@ You can also use M-x erc-nickserv-identify-mode to change modes."
    (list (intern (completing-read
                  "Choose Nickserv identify mode (RET to disable): "
                  '(("autodetect") ("nick-change") ("both")) nil t))))
    (list (intern (completing-read
                  "Choose Nickserv identify mode (RET to disable): "
                  '(("autodetect") ("nick-change") ("both")) nil t))))

+  (add-hook 'erc-server-NOTICE-functions
+           'erc-nickserv-identification-autodetect)
+  (unless erc-networks-mode
+    ;; Force-enable networks module, because we need it to set
+    ;; erc-network for us.
+    (erc-networks-enable))

   (cond ((eq mode 'autodetect)
         (setq erc-nickserv-identify-mode 'autodetect)
         (add-hook 'erc-server-NOTICE-functions
   (cond ((eq mode 'autodetect)
         (setq erc-nickserv-identify-mode 'autodetect)
         (add-hook 'erc-server-NOTICE-functions


@@ -149,7 +156,9 @@ You can also use M-x erc-nickserv-identify-mode to change modes."
         (remove-hook 'erc-after-connect
                      'erc-nickserv-identify-on-connect)
         (remove-hook 'erc-nick-changed-functions
         (remove-hook 'erc-after-connect
                      'erc-nickserv-identify-on-connect)
         (remove-hook 'erc-nick-changed-functions

-                     'erc-nickserv-identify-on-nick-change))))
+                     'erc-nickserv-identify-on-nick-change)
+        (remove-hook 'erc-server-NOTICE-functions
+                     'erc-nickserv-identification-autodetect))))

 
 (defcustom erc-prompt-for-nickserv-password t
   "Ask for the password when identifying to NickServ."
 
 (defcustom erc-prompt-for-nickserv-password t
   "Ask for the password when identifying to NickServ."


@@ -176,9 +185,11 @@ Example of use:
                        (const DALnet)
                        (const freenode)
                        (const GalaxyNet)
                        (const DALnet)
                        (const freenode)
                        (const GalaxyNet)

+                       (const GRnet)

                        (const iip)
                        (const OFTC)
                        (const QuakeNet)
                        (const iip)
                        (const OFTC)
                        (const QuakeNet)

+                       (const Rizon)

                        (const SlashNET)
                        (symbol :tag "Network name"))
                (repeat :tag "Nickname and password"
                        (const SlashNET)
                        (symbol :tag "Network name"))
                (repeat :tag "Nickname and password"


@@ -192,63 +203,80 @@ Example of use:
   '((Ars
      nil nil
      "Census"
   '((Ars
      nil nil
      "Census"

-     "IDENTIFY" nil nil)
+     "IDENTIFY" nil nil nil)

     (Austnet
      "NickOP!service@austnet.org"
      "/msg\\s-NickOP@austnet.org\\s-identify\\s-<password>"
      "nickop@austnet.org"
     (Austnet
      "NickOP!service@austnet.org"
      "/msg\\s-NickOP@austnet.org\\s-identify\\s-<password>"
      "nickop@austnet.org"

-     "identify" nil nil)
+     "identify" nil nil nil)

     (Azzurra
      "NickServ!service@azzurra.org"
      "\ 2/ns\\s-IDENTIFY\\s-password\ 2"
      "NickServ"
     (Azzurra
      "NickServ!service@azzurra.org"
      "\ 2/ns\\s-IDENTIFY\\s-password\ 2"
      "NickServ"

-     "IDENTIFY" nil nil)
+     "IDENTIFY" nil nil nil)

     (BitlBee
      nil nil
      "&bitlbee"
     (BitlBee
      nil nil
      "&bitlbee"

-     "identify" nil nil)
+     "identify" nil nil nil)

     (BRASnet
      "NickServ!services@brasnet.org"
      "\ 2/NickServ\\s-IDENTIFY\\s-\1fsenha\1f\ 2"
      "NickServ"
     (BRASnet
      "NickServ!services@brasnet.org"
      "\ 2/NickServ\\s-IDENTIFY\\s-\1fsenha\1f\ 2"
      "NickServ"

-     "IDENTIFY" nil "")
+     "IDENTIFY" nil "" nil)

     (DALnet
      "NickServ!service@dal.net"
      "/msg\\s-NickServ@services.dal.net\\s-IDENTIFY\\s-<password>"
      "NickServ@services.dal.net"
     (DALnet
      "NickServ!service@dal.net"
      "/msg\\s-NickServ@services.dal.net\\s-IDENTIFY\\s-<password>"
      "NickServ@services.dal.net"

-     "IDENTIFY" nil nil)
+     "IDENTIFY" nil nil nil)

     (freenode
      "NickServ!NickServ@services."
     (freenode
      "NickServ!NickServ@services."

+     ;; freenode also accepts a password at login, see the `erc'
+     ;; :password argument.

      "/msg\\s-NickServ\\s-\ 2IDENTIFY\ 2\\s-<password>"
      "NickServ"
      "/msg\\s-NickServ\\s-\ 2IDENTIFY\ 2\\s-<password>"
      "NickServ"

-     "IDENTIFY" nil nil)
+     "IDENTIFY" nil nil
+     "Password\\s-accepted\\s--\\s-you\\s-are\\s-now\\s-recognized")

     (GalaxyNet
      "NS!nickserv@galaxynet.org"
      "Please\\s-change\\s-nicks\\s-or\\s-authenticate."
      "NS@services.galaxynet.org"
     (GalaxyNet
      "NS!nickserv@galaxynet.org"
      "Please\\s-change\\s-nicks\\s-or\\s-authenticate."
      "NS@services.galaxynet.org"

-     "AUTH" t nil)
+     "AUTH" t nil nil)
+    (GRnet
+     "NickServ!service@irc.gr"
+     "This\\s-nickname\\s-is\\s-registered\\s-and\\s-protected."
+     "NickServ"
+     "IDENTIFY" nil nil
+     "Password\\s-accepted\\s--\\s-you\\s-are\\s-now\\s-recognized.")

     (iip
      "Trent@anon.iip"
      "type\\s-/squery\\s-Trent\\s-identify\\s-<password>"
      "Trent@anon.iip"
     (iip
      "Trent@anon.iip"
      "type\\s-/squery\\s-Trent\\s-identify\\s-<password>"
      "Trent@anon.iip"

-     "IDENTIFY" nil "SQUERY")
+     "IDENTIFY" nil "SQUERY" nil)

     (OFTC
      "NickServ!services@services.oftc.net"
     (OFTC
      "NickServ!services@services.oftc.net"

-     "type\\s-\ 2/msg\\s-NickServ\\s-IDENTIFY\\s-\1fpassword\1f\ 2."
+     ;; OFTC's NickServ doesn't ask you to identify anymore.
+     nil

      "NickServ"
      "NickServ"

-     "IDENTIFY" nil nil)
+     "IDENTIFY" nil nil
+     "You\\s-are\\s-successfully\\s-identified\\s-as\\s-\ 2")
+    (Rizon
+     "NickServ!service@rizon.net"
+     "This\\s-nickname\\s-is\\s-registered\\s-and\\s-protected."
+     "NickServ"
+     "IDENTIFY" nil nil
+     "Password\\s-accepted\\s--\\s-you\\s-are\\s-now\\s-recognized.")

     (QuakeNet
      nil nil
      "Q@CServe.quakenet.org"
     (QuakeNet
      nil nil
      "Q@CServe.quakenet.org"

-     "auth" t nil)
+     "auth" t nil nil)

     (SlashNET
      "NickServ!services@services.slashnet.org"
      "/msg\\s-NickServ\\s-IDENTIFY\\s-\1fpassword"
      "NickServ@services.slashnet.org"
     (SlashNET
      "NickServ!services@services.slashnet.org"
      "/msg\\s-NickServ\\s-IDENTIFY\\s-\1fpassword"
      "NickServ@services.slashnet.org"

-     "IDENTIFY" nil nil))
+     "IDENTIFY" nil nil nil))

    "Alist of NickServer details, sorted by network.
 Every element in the list has the form
    "Alist of NickServer details, sorted by network.
 Every element in the list has the form

-  \(SYMBOL NICKSERV REGEXP NICK KEYWORD USE-CURRENT ANSWER)
+  \(SYMBOL NICKSERV REGEXP NICK KEYWORD USE-CURRENT ANSWER SUCCESS-REGEXP)

 
 SYMBOL is a network identifier, a symbol, as used in `erc-networks-alist'.
 NICKSERV is the description of the nickserv in the form nick!user@host.
 
 SYMBOL is a network identifier, a symbol, as used in `erc-networks-alist'.
 NICKSERV is the description of the nickserv in the form nick!user@host.


@@ -258,7 +286,9 @@ KEYWORD is the keyword to use in the reply message to identify yourself.
 USE-CURRENT indicates whether the current nickname must be used when
   identifying.
 ANSWER is the command to use for the answer.  The default is 'privmsg.
 USE-CURRENT indicates whether the current nickname must be used when
   identifying.
 ANSWER is the command to use for the answer.  The default is 'privmsg.

-  This last element is optional."
+SUCCESS-REGEXP is a regular expression matching the message nickserv
+  sends when you've successfully identified.
+The last two elements are optional."

    :group 'erc-services
    :type '(repeat
           (list :tag "Nickserv data"
    :group 'erc-services
    :type '(repeat
           (list :tag "Nickserv data"


@@ -292,12 +322,40 @@ ANSWER is the command to use for the answer.  The default is 'privmsg.
 (defsubst erc-nickserv-alist-ident-command (network &optional entry)
   (nth 6 (or entry (assoc network erc-nickserv-alist))))
 
 (defsubst erc-nickserv-alist-ident-command (network &optional entry)
   (nth 6 (or entry (assoc network erc-nickserv-alist))))
 

+(defsubst erc-nickserv-alist-identified-regexp (network &optional entry)
+  (nth 7 (or entry (assoc network erc-nickserv-alist))))
+

 ;; Functions:
 
 ;; Functions:
 

-(defun erc-nickserv-identify-autodetect (proc parsed)
-  "Check for a NickServ identify request everytime a notice is received.
+(defcustom erc-nickserv-identified-hook nil
+  "Run this hook when NickServ acknowledged successful identification.
+Hooks are called with arguments (NETWORK NICK)."
+  :group 'erc-services
+  :type 'hook)
+
+(defun erc-nickserv-identification-autodetect (proc parsed)
+  "Check for NickServ's successful identification notice.

 Make sure it is the real NickServ for this network and that it has
 Make sure it is the real NickServ for this network and that it has

-specifically asked the user to IDENTIFY.
+specifically confirmed a successful identification attempt.
+If this is the case, run `erc-nickserv-identified-hook'."
+  (let* ((network (erc-network))
+        (sender (erc-nickserv-alist-sender network))
+        (success-regex (erc-nickserv-alist-identified-regexp network))
+        (sspec (erc-response.sender parsed))
+        (nick (car (erc-response.command-args parsed)))
+        (msg (erc-response.contents parsed)))
+    ;; continue only if we're sure it's the real nickserv for this network
+    ;; and it's told us we've successfully identified
+    (when (and sender (equal sspec sender)
+              success-regex
+              (string-match success-regex msg))
+      (erc-log "NickServ IDENTIFY success notification detected")
+      (run-hook-with-args 'erc-nickserv-identified-hook network nick)
+      nil)))
+
+(defun erc-nickserv-identify-autodetect (proc parsed)
+  "Identify to NickServ when an identify request is received.
+Make sure it is the real NickServ for this network.

 If `erc-prompt-for-nickserv-password' is non-nil, prompt the user for the
 password for this nickname, otherwise try to send it automatically."
   (unless (and (null erc-nickserv-passwords)
 If `erc-prompt-for-nickserv-password' is non-nil, prompt the user for the
 password for this nickname, otherwise try to send it automatically."
   (unless (and (null erc-nickserv-passwords)


@@ -311,6 +369,7 @@ password for this nickname, otherwise try to send it automatically."
       ;; continue only if we're sure it's the real nickserv for this network
       ;; and it's asked us to identify
       (when (and sender (equal sspec sender)
       ;; continue only if we're sure it's the real nickserv for this network
       ;; and it's asked us to identify
       (when (and sender (equal sspec sender)

+                identify-regex

                 (string-match identify-regex msg))
        (erc-log "NickServ IDENTIFY request detected")
        (erc-nickserv-call-identify-function nick)
                 (string-match identify-regex msg))
        (erc-log "NickServ IDENTIFY request detected")
        (erc-nickserv-call-identify-function nick)