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

;;; erc-services.el --- Identify to NickServ

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

;; This file is part of GNU Emacs.

;; 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
;; the Free Software Foundation; either version 2, 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
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; 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.

;;; Commentary:

;; There are two ways to go about identifying yourself automatically to
;; NickServ with this module.  The more secure way is to listen for identify
;; requests from the user NickServ.  Another way is to identify yourself to
;; NickServ directly after a successful connection and every time you change
;; your nickname.  This method is rather insecure, though, because no checks
;; 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.

;; Usage:
;;
;; Put into your .emacs:
;;
;; (require 'erc-services)
;; (erc-services-mode 1)
;;
;; Add your nickname and NickServ password to `erc-nickserv-passwords'.
;; Using the freenode network as an example:
;;
;; (setq erc-nickserv-passwords '((freenode (("nickname" "password")))))
;;
;; The default automatic identification mode is autodetection of NickServ
;; identify requests.  Set the variable `erc-nickserv-identify-mode' if
;; you'd like to change this behavior.  You can also change the way
;; automatic identification is handled by using:
;;
;; M-x erc-nickserv-identify-mode
;;
;; If you'd rather not identify yourself automatically but would like access
;; to the functions contained in this file, just load this file without
;; enabling `erc-services-mode'.
;;

;;; Code:

(require 'erc)
(require 'erc-networks)
(eval-when-compile (require 'cl))

;; Customization:

(defgroup erc-services nil
  "Configuration for IRC services.

On some networks, there exists a special type of automated irc bot,
called Services.  Those usually allow you to register your nickname,
post/read memos to other registered users who are currently offline,
and do various other things.

This group allows you to set variables to somewhat automate
communication with those Services."
  :group 'erc)

(defcustom erc-nickserv-identify-mode 'both
  "The mode which is used when identifying to Nickserv.

Possible settings are:.

'autodetect  - Identify when the real Nickserv sends an identify request.
'nick-change - Identify when you log in or change your nickname.
'both        - Do the former if the network supports it, otherwise do the
               latter.
nil          - Disables automatic Nickserv identification.

You can also use M-x erc-nickserv-identify-mode to change modes."
  :group 'erc-services
  :type '(choice (const autodetect)
		 (const nick-change)
		 (const both)
		 (const nil))
  :set (lambda (sym val)
	 (set sym val)
	 ;; avoid recursive load at startup
	 (when (featurep 'erc-services)
	   (erc-nickserv-identify-mode val))))

;;;###autoload (autoload 'erc-services-mode "erc-services" nil t)
(define-erc-module services nickserv
  "This mode automates communication with services."
  ((erc-nickserv-identify-mode erc-nickserv-identify-mode))
  ((remove-hook 'erc-server-NOTICE-functions
		'erc-nickserv-identify-autodetect)
   (remove-hook 'erc-after-connect
		'erc-nickserv-identify-on-connect)
   (remove-hook 'erc-nick-changed-functions
		'erc-nickserv-identify-on-nick-change)))

;;;###autoload
(defun erc-nickserv-identify-mode (mode)
  "Set up hooks according to which MODE the user has chosen."
  (interactive
   (list (intern (completing-read
		  "Choose Nickserv identify mode (RET to disable): "
		  '(("autodetect") ("nick-change") ("both")) nil t))))
  (cond ((eq mode 'autodetect)
	 (setq erc-nickserv-identify-mode 'autodetect)
	 (add-hook 'erc-server-NOTICE-functions
		   'erc-nickserv-identify-autodetect)
	 (remove-hook 'erc-nick-changed-functions
		      'erc-nickserv-identify-on-nick-change)
	 (remove-hook 'erc-after-connect
		      'erc-nickserv-identify-on-connect))
	((eq mode 'nick-change)
	 (setq erc-nickserv-identify-mode 'nick-change)
	 (add-hook 'erc-after-connect
		   'erc-nickserv-identify-on-connect)
	 (add-hook 'erc-nick-changed-functions
		   'erc-nickserv-identify-on-nick-change)
	 (remove-hook 'erc-server-NOTICE-functions
		      'erc-nickserv-identify-autodetect))
	((eq mode 'both)
	 (setq erc-nickserv-identify-mode 'both)
	 (add-hook 'erc-server-NOTICE-functions
		   'erc-nickserv-identify-autodetect)
	 (add-hook 'erc-after-connect
		   'erc-nickserv-identify-on-connect)
	 (add-hook 'erc-nick-changed-functions
		   'erc-nickserv-identify-on-nick-change))
	(t
	 (setq erc-nickserv-identify-mode nil)
	 (remove-hook 'erc-server-NOTICE-functions
		      'erc-nickserv-identify-autodetect)
	 (remove-hook 'erc-after-connect
		      'erc-nickserv-identify-on-connect)
	 (remove-hook 'erc-nick-changed-functions
		      'erc-nickserv-identify-on-nick-change))))

(defcustom erc-prompt-for-nickserv-password t
  "Ask for the password when identifying to NickServ."
  :group 'erc-services
  :type 'boolean)

(defcustom erc-nickserv-passwords nil
  "Passwords used when identifying to NickServ automatically.

Example of use:
  (setq erc-nickserv-passwords
        '((freenode ((\"nick-one\" . \"password\")
                     (\"nick-two\" . \"password\")))
          (DALnet ((\"nick\" . \"password\")))))"
  :group 'erc-services
  :type '(repeat
	  (list :tag "Network"
		(choice :tag "Network name"
			(const Ars)
			(const Austnet)
			(const Azzurra)
			(const BitlBee)
			(const BRASnet)
			(const DALnet)
			(const freenode)
			(const GalaxyNet)
			(const iip)
			(const OFTC)
			(const QuakeNet)
			(const SlashNET)
			(symbol :tag "Network name"))
		(repeat :tag "Nickname and password"
			(cons :tag "Identity"
			      (string :tag "Nick")
			      (string :tag "Password"))))))

;; Variables:

(defcustom erc-nickserv-alist
  '((Ars
     nil nil
     "Census"
     "IDENTIFY" nil nil)
    (Austnet
     "NickOP!service@austnet.org"
     "/msg\\s-NickOP@austnet.org\\s-identify\\s-<password>"
     "nickop@austnet.org"
     "identify" nil nil)
    (Azzurra
     "NickServ!service@azzurra.org"
     "\ 2/ns\\s-IDENTIFY\\s-password\ 2"
     "NickServ"
     "IDENTIFY" nil nil)
    (BitlBee
     nil nil
     "&bitlbee"
     "identify" nil nil)
    (BRASnet
     "NickServ!services@brasnet.org"
     "\ 2/NickServ\\s-IDENTIFY\\s-\1fsenha\1f\ 2"
     "NickServ"
     "IDENTIFY" nil "")
    (DALnet
     "NickServ!service@dal.net"
     "/msg\\s-NickServ@services.dal.net\\s-IDENTIFY\\s-<password>"
     "NickServ@services.dal.net"
     "IDENTIFY" nil nil)
    (freenode
     "NickServ!NickServ@services."
     "/msg\\s-NickServ\\s-\ 2IDENTIFY\ 2\\s-<password>"
     "NickServ"
     "IDENTIFY" nil nil)
    (GalaxyNet
     "NS!nickserv@galaxynet.org"
     "Please\\s-change\\s-nicks\\s-or\\s-authenticate."
     "NS@services.galaxynet.org"
     "AUTH" t nil)
    (iip
     "Trent@anon.iip"
     "type\\s-/squery\\s-Trent\\s-identify\\s-<password>"
     "Trent@anon.iip"
     "IDENTIFY" nil "SQUERY")
    (OFTC
     "NickServ!services@services.oftc.net"
     "type\\s-\ 2/msg\\s-NickServ\\s-IDENTIFY\\s-\1fpassword\1f\ 2."
     "NickServ"
     "IDENTIFY" nil nil)
    (QuakeNet
     nil nil
     "Q@CServe.quakenet.org"
     "auth" t nil)
    (SlashNET
     "NickServ!services@services.slashnet.org"
     "/msg\\s-NickServ\\s-IDENTIFY\\s-\1fpassword"
     "NickServ@services.slashnet.org"
     "IDENTIFY" nil nil))
   "Alist of NickServer details, sorted by network.
Every element in the list has the form
  \(SYMBOL NICKSERV REGEXP NICK KEYWORD USE-CURRENT ANSWER)

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.
REGEXP is a regular expression matching the message from nickserv.
NICK is nickserv's nickname.  Use nick@server where necessary/possible.
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.
  This last element is optional."
   :group 'erc-services
   :type '(repeat
	   (list :tag "Nickserv data"
		 (symbol :tag "Network name")
		 (choice (string :tag "Nickserv's nick!user@host")
			 (const :tag "No message sent by Nickserv" nil))
		 (choice (regexp :tag "Identify request sent by Nickserv")
			 (const :tag "No message sent by Nickserv" nil))
		 (string :tag "Identify to")
		 (string :tag "Identify keyword")
		 (boolean :tag "Use current nick in identify message?")
		 (choice :tag "Command to use (optional)"
		  (string :tag "Command")
		  (const :tag "No special command necessary" nil)))))

(defsubst erc-nickserv-alist-sender (network &optional entry)
  (nth 1 (or entry (assoc network erc-nickserv-alist))))

(defsubst erc-nickserv-alist-regexp (network &optional entry)
  (nth 2 (or entry (assoc network erc-nickserv-alist))))

(defsubst erc-nickserv-alist-nickserv (network &optional entry)
  (nth 3 (or entry (assoc network erc-nickserv-alist))))

(defsubst erc-nickserv-alist-ident-keyword (network &optional entry)
  (nth 4 (or entry (assoc network erc-nickserv-alist))))

(defsubst erc-nickserv-alist-use-nick-p (network &optional entry)
  (nth 5 (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))))

;; Functions:

(defun erc-nickserv-identify-autodetect (proc parsed)
  "Check for a NickServ identify request everytime a notice is received.
Make sure it is the real NickServ for this network and that it has
specifically asked the user to IDENTIFY.
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)
	       (null erc-prompt-for-nickserv-password))
    (let* ((network (erc-network))
	   (sender (erc-nickserv-alist-sender network))
	   (identify-regex (erc-nickserv-alist-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 asked us to identify
      (when (and sender (equal sspec sender)
		 (string-match identify-regex msg))
	(erc-log "NickServ IDENTIFY request detected")
	(erc-nickserv-call-identify-function nick)
	nil))))

(defun erc-nickserv-identify-on-connect (server nick)
  "Identify to Nickserv after the connection to the server is established."
  (unless (or (and (null erc-nickserv-passwords)
		   (null erc-prompt-for-nickserv-password))
	      (and (eq erc-nickserv-identify-mode 'both)
		   (erc-nickserv-alist-regexp (erc-network))))
    (erc-nickserv-call-identify-function nick)))

(defun erc-nickserv-identify-on-nick-change (nick old-nick)
  "Identify to Nickserv whenever your nick changes."
  (unless (or (and (null erc-nickserv-passwords)
		   (null erc-prompt-for-nickserv-password))
	      (and (eq erc-nickserv-identify-mode 'both)
		   (erc-nickserv-alist-regexp (erc-network))))
    (erc-nickserv-call-identify-function nick)))

(defun erc-nickserv-call-identify-function (nickname)
  "Call `erc-nickserv-identify' interactively or run it with NICKNAME's
password.
The action is determined by the value of `erc-prompt-for-nickserv-password'."
  (if erc-prompt-for-nickserv-password
      (call-interactively 'erc-nickserv-identify)
    (when erc-nickserv-passwords
      (erc-nickserv-identify
       (cdr (assoc nickname
		   (nth 1 (assoc (erc-network)
				 erc-nickserv-passwords))))))))

;;;###autoload
(defun erc-nickserv-identify (password)
  "Send an \"identify <PASSWORD>\" message to NickServ.
When called interactively, read the password using `read-passwd'."
  (interactive
   (list (read-passwd
	  (format "NickServ password for %s on %s (RET to cancel): "
		  (erc-current-nick)
		  (or (and (erc-network)
			   (symbol-name (erc-network)))
		      "Unknown network")))))
  (when (and password (not (string= "" password)))
    (let* ((erc-auto-discard-away nil)
	   (network (erc-network))
	   (nickserv-info (assoc network erc-nickserv-alist))
	   (nickserv (or (erc-nickserv-alist-nickserv nil nickserv-info)
			 "NickServ"))
	   (identify-word (or (erc-nickserv-alist-ident-keyword
			       nil nickserv-info)
			      "IDENTIFY"))
	   (nick (if (erc-nickserv-alist-use-nick-p nil nickserv-info)
		     (concat (erc-current-nick) " ")
		   ""))
	   (msgtype (or (erc-nickserv-alist-ident-command nil nickserv-info)
			"PRIVMSG")))
      (erc-message msgtype
		   (concat nickserv " " identify-word " " nick password)))))

(provide 'erc-services)

;;; erc-services.el ends here
;;
;; Local Variables:
;; indent-tabs-mode: t
;; tab-width: 8
;; End:

;; arch-tag: d401c8aa-d938-4255-96a9-3efb64c47e58
Commit	Line	Data
c6b99621	1	;;; erc-services.el --- Identify to NickServ
597993cf	2
f0fa15c5	3	;; Copyright (C) 2002, 2003, 2004, 2006, 2007 Free Software Foundation, Inc.
597993cf MB	4
	5	;; This file is part of GNU Emacs.
	6
	7	;; GNU Emacs is free software; you can redistribute it and/or modify
	8	;; it under the terms of the GNU General Public License as published by
	9	;; the Free Software Foundation; either version 2, or (at your option)
	10	;; any later version.
	11
	12	;; GNU Emacs is distributed in the hope that it will be useful,
	13	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	;; GNU General Public License for more details.
	16
	17	;; You should have received a copy of the GNU General Public License
	18	;; along with GNU Emacs; see the file COPYING. If not, write to the
	19	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	20	;; Boston, MA 02110-1301, USA.
	21
	22	;;; Commentary:
	23
	24	;; There are two ways to go about identifying yourself automatically to
	25	;; NickServ with this module. The more secure way is to listen for identify
	26	;; requests from the user NickServ. Another way is to identify yourself to
	27	;; NickServ directly after a successful connection and every time you change
	28	;; your nickname. This method is rather insecure, though, because no checks
	29	;; are made to test if NickServ is the real NickServ for a given network or
	30	;; server.
	31
	32	;; As a default, ERC has the data for the official nickname services on the
	33	;; networks Austnet, BrasNET, Dalnet, freenode, GalaxyNet, and Slashnet.
	34	;; You can add more by using M-x customize-variable RET erc-nickserv-alist.
	35
	36	;; Usage:
	37	;;
	38	;; Put into your .emacs:
	39	;;
c6b99621	40	;; (require 'erc-services)
597993cf MB	41	;; (erc-services-mode 1)
	42	;;
	43	;; Add your nickname and NickServ password to `erc-nickserv-passwords'.
	44	;; Using the freenode network as an example:
	45	;;
	46	;; (setq erc-nickserv-passwords '((freenode (("nickname" "password")))))
	47	;;
	48	;; The default automatic identification mode is autodetection of NickServ
	49	;; identify requests. Set the variable `erc-nickserv-identify-mode' if
	50	;; you'd like to change this behavior. You can also change the way
	51	;; automatic identification is handled by using:
	52	;;
	53	;; M-x erc-nickserv-identify-mode
	54	;;
	55	;; If you'd rather not identify yourself automatically but would like access
	56	;; to the functions contained in this file, just load this file without
	57	;; enabling `erc-services-mode'.
	58	;;
	59
	60	;;; Code:
	61
	62	(require 'erc)
c6b99621	63	(require 'erc-networks)
597993cf MB	64	(eval-when-compile (require 'cl))
	65
	66	;; Customization:
	67
	68	(defgroup erc-services nil
	69	"Configuration for IRC services.
	70
	71	On some networks, there exists a special type of automated irc bot,
	72	called Services. Those usually allow you to register your nickname,
	73	post/read memos to other registered users who are currently offline,
	74	and do various other things.
	75
	76	This group allows you to set variables to somewhat automate
	77	communication with those Services."
	78	:group 'erc)
	79
6904f7fe MB	80	(defcustom erc-nickserv-identify-mode 'both
	81	"The mode which is used when identifying to Nickserv.
	82
	83	Possible settings are:.
	84
	85	'autodetect - Identify when the real Nickserv sends an identify request.
	86	'nick-change - Identify when you log in or change your nickname.
	87	'both - Do the former if the network supports it, otherwise do the
	88	latter.
	89	nil - Disables automatic Nickserv identification.
	90
	91	You can also use M-x erc-nickserv-identify-mode to change modes."
	92	:group 'erc-services
	93	:type '(choice (const autodetect)
	94	(const nick-change)
	95	(const both)
	96	(const nil))
	97	:set (lambda (sym val)
	98	(set sym val)
	99	;; avoid recursive load at startup
	100	(when (featurep 'erc-services)
	101	(erc-nickserv-identify-mode val))))
	102
c6b99621	103	;;;###autoload (autoload 'erc-services-mode "erc-services" nil t)
597993cf MB	104	(define-erc-module services nickserv
	105	"This mode automates communication with services."
	106	((erc-nickserv-identify-mode erc-nickserv-identify-mode))
	107	((remove-hook 'erc-server-NOTICE-functions
	108	'erc-nickserv-identify-autodetect)
	109	(remove-hook 'erc-after-connect
	110	'erc-nickserv-identify-on-connect)
	111	(remove-hook 'erc-nick-changed-functions
	112	'erc-nickserv-identify-on-nick-change)))
	113
	114	;;;###autoload
	115	(defun erc-nickserv-identify-mode (mode)
	116	"Set up hooks according to which MODE the user has chosen."
	117	(interactive
	118	(list (intern (completing-read
	119	"Choose Nickserv identify mode (RET to disable): "
10dc9f9e	120	'(("autodetect") ("nick-change") ("both")) nil t))))
597993cf MB	121	(cond ((eq mode 'autodetect)
	122	(setq erc-nickserv-identify-mode 'autodetect)
	123	(add-hook 'erc-server-NOTICE-functions
	124	'erc-nickserv-identify-autodetect)
	125	(remove-hook 'erc-nick-changed-functions
	126	'erc-nickserv-identify-on-nick-change)
	127	(remove-hook 'erc-after-connect
	128	'erc-nickserv-identify-on-connect))
	129	((eq mode 'nick-change)
	130	(setq erc-nickserv-identify-mode 'nick-change)
	131	(add-hook 'erc-after-connect
	132	'erc-nickserv-identify-on-connect)
	133	(add-hook 'erc-nick-changed-functions
	134	'erc-nickserv-identify-on-nick-change)
	135	(remove-hook 'erc-server-NOTICE-functions
	136	'erc-nickserv-identify-autodetect))
10dc9f9e MB	137	((eq mode 'both)
	138	(setq erc-nickserv-identify-mode 'both)
	139	(add-hook 'erc-server-NOTICE-functions
	140	'erc-nickserv-identify-autodetect)
	141	(add-hook 'erc-after-connect
	142	'erc-nickserv-identify-on-connect)
	143	(add-hook 'erc-nick-changed-functions
	144	'erc-nickserv-identify-on-nick-change))
597993cf MB	145	(t
	146	(setq erc-nickserv-identify-mode nil)
	147	(remove-hook 'erc-server-NOTICE-functions
	148	'erc-nickserv-identify-autodetect)
	149	(remove-hook 'erc-after-connect
	150	'erc-nickserv-identify-on-connect)
	151	(remove-hook 'erc-nick-changed-functions
	152	'erc-nickserv-identify-on-nick-change))))
	153
597993cf MB	154	(defcustom erc-prompt-for-nickserv-password t
	155	"Ask for the password when identifying to NickServ."
	156	:group 'erc-services
	157	:type 'boolean)
	158
	159	(defcustom erc-nickserv-passwords nil
	160	"Passwords used when identifying to NickServ automatically.
	161
	162	Example of use:
	163	(setq erc-nickserv-passwords
	164	'((freenode ((\"nick-one\" . \"password\")
	165	(\"nick-two\" . \"password\")))
	166	(DALnet ((\"nick\" . \"password\")))))"
	167	:group 'erc-services
	168	:type '(repeat
	169	(list :tag "Network"
	170	(choice :tag "Network name"
ff59d266 MB	171	(const Ars)
	172	(const Austnet)
	173	(const Azzurra)
	174	(const BitlBee)
	175	(const BRASnet)
597993cf	176	(const DALnet)
ff59d266	177	(const freenode)
597993cf	178	(const GalaxyNet)
597993cf	179	(const iip)
ff59d266 MB	180	(const OFTC)
	181	(const QuakeNet)
	182	(const SlashNET)
597993cf MB	183	(symbol :tag "Network name"))
	184	(repeat :tag "Nickname and password"
	185	(cons :tag "Identity"
	186	(string :tag "Nick")
	187	(string :tag "Password"))))))
	188
	189	;; Variables:
	190
	191	(defcustom erc-nickserv-alist
ff59d266 MB	192	'((Ars
	193	nil nil
	194	"Census"
	195	"IDENTIFY" nil nil)
	196	(Austnet
	197	"NickOP!service@austnet.org"
	198	"/msg\\s-NickOP@austnet.org\\s-identify\\s-<password>"
	199	"nickop@austnet.org"
	200	"identify" nil nil)
	201	(Azzurra
	202	"NickServ!service@azzurra.org"
	203	"\ 2/ns\\s-IDENTIFY\\s-password\ 2"
	204	"NickServ"
	205	"IDENTIFY" nil nil)
	206	(BitlBee
	207	nil nil
6904f7fe	208	"&bitlbee"
ff59d266 MB	209	"identify" nil nil)
	210	(BRASnet
	211	"NickServ!services@brasnet.org"
	212	"\ 2/NickServ\\s-IDENTIFY\\s-\1fsenha\1f\ 2"
	213	"NickServ"
	214	"IDENTIFY" nil "")
6904f7fe	215	(DALnet
597993cf MB	216	"NickServ!service@dal.net"
	217	"/msg\\s-NickServ@services.dal.net\\s-IDENTIFY\\s-<password>"
	218	"NickServ@services.dal.net"
ff59d266	219	"IDENTIFY" nil nil)
597993cf MB	220	(freenode
	221	"NickServ!NickServ@services."
	222	"/msg\\s-NickServ\\s-\ 2IDENTIFY\ 2\\s-<password>"
	223	"NickServ"
ff59d266	224	"IDENTIFY" nil nil)
597993cf MB	225	(GalaxyNet
	226	"NS!nickserv@galaxynet.org"
	227	"Please\\s-change\\s-nicks\\s-or\\s-authenticate."
	228	"NS@services.galaxynet.org"
ff59d266	229	"AUTH" t nil)
597993cf MB	230	(iip
	231	"Trent@anon.iip"
	232	"type\\s-/squery\\s-Trent\\s-identify\\s-<password>"
	233	"Trent@anon.iip"
ff59d266	234	"IDENTIFY" nil "SQUERY")
10dc9f9e MB	235	(OFTC
10dc9f9e MB	236	"NickServ!services@services.oftc.net"
ff59d266	237	"type\\s-\ 2/msg\\s-NickServ\\s-IDENTIFY\\s-\1fpassword\1f\ 2."
10dc9f9e	238	"NickServ"
ff59d266 MB	239	"IDENTIFY" nil nil)
	240	(QuakeNet
	241	nil nil
	242	"Q@CServe.quakenet.org"
	243	"auth" t nil)
	244	(SlashNET
	245	"NickServ!services@services.slashnet.org"
	246	"/msg\\s-NickServ\\s-IDENTIFY\\s-\1fpassword"
	247	"NickServ@services.slashnet.org"
	248	"IDENTIFY" nil nil))
597993cf MB	249	"Alist of NickServer details, sorted by network.
	250	Every element in the list has the form
	251	\(SYMBOL NICKSERV REGEXP NICK KEYWORD USE-CURRENT ANSWER)
	252
	253	SYMBOL is a network identifier, a symbol, as used in `erc-networks-alist'.
	254	NICKSERV is the description of the nickserv in the form nick!user@host.
	255	REGEXP is a regular expression matching the message from nickserv.
	256	NICK is nickserv's nickname. Use nick@server where necessary/possible.
	257	KEYWORD is the keyword to use in the reply message to identify yourself.
	258	USE-CURRENT indicates whether the current nickname must be used when
	259	identifying.
	260	ANSWER is the command to use for the answer. The default is 'privmsg.
	261	This last element is optional."
	262	:group 'erc-services
	263	:type '(repeat
	264	(list :tag "Nickserv data"
	265	(symbol :tag "Network name")
ff59d266 MB	266	(choice (string :tag "Nickserv's nick!user@host")
	267	(const :tag "No message sent by Nickserv" nil))
	268	(choice (regexp :tag "Identify request sent by Nickserv")
	269	(const :tag "No message sent by Nickserv" nil))
597993cf MB	270	(string :tag "Identify to")
	271	(string :tag "Identify keyword")
	272	(boolean :tag "Use current nick in identify message?")
	273	(choice :tag "Command to use (optional)"
	274	(string :tag "Command")
	275	(const :tag "No special command necessary" nil)))))
	276
6904f7fe MB	277	(defsubst erc-nickserv-alist-sender (network &optional entry)
	278	(nth 1 (or entry (assoc network erc-nickserv-alist))))
	279
	280	(defsubst erc-nickserv-alist-regexp (network &optional entry)
	281	(nth 2 (or entry (assoc network erc-nickserv-alist))))
	282
	283	(defsubst erc-nickserv-alist-nickserv (network &optional entry)
	284	(nth 3 (or entry (assoc network erc-nickserv-alist))))
	285
	286	(defsubst erc-nickserv-alist-ident-keyword (network &optional entry)
	287	(nth 4 (or entry (assoc network erc-nickserv-alist))))
	288
	289	(defsubst erc-nickserv-alist-use-nick-p (network &optional entry)
	290	(nth 5 (or entry (assoc network erc-nickserv-alist))))
	291
	292	(defsubst erc-nickserv-alist-ident-command (network &optional entry)
	293	(nth 6 (or entry (assoc network erc-nickserv-alist))))
	294
597993cf MB	295	;; Functions:
	296
	297	(defun erc-nickserv-identify-autodetect (proc parsed)
	298	"Check for a NickServ identify request everytime a notice is received.
	299	Make sure it is the real NickServ for this network and that it has
	300	specifically asked the user to IDENTIFY.
	301	If `erc-prompt-for-nickserv-password' is non-nil, prompt the user for the
	302	password for this nickname, otherwise try to send it automatically."
	303	(unless (and (null erc-nickserv-passwords)
	304	(null erc-prompt-for-nickserv-password))
	305	(let* ((network (erc-network))
6904f7fe MB	306	(sender (erc-nickserv-alist-sender network))
6904f7fe MB	307	(identify-regex (erc-nickserv-alist-regexp network))
597993cf MB	308	(sspec (erc-response.sender parsed))
	309	(nick (car (erc-response.command-args parsed)))
	310	(msg (erc-response.contents parsed)))
	311	;; continue only if we're sure it's the real nickserv for this network
	312	;; and it's asked us to identify
6904f7fe	313	(when (and sender (equal sspec sender)
597993cf MB	314	(string-match identify-regex msg))
	315	(erc-log "NickServ IDENTIFY request detected")
	316	(erc-nickserv-call-identify-function nick)
	317	nil))))
	318
	319	(defun erc-nickserv-identify-on-connect (server nick)
	320	"Identify to Nickserv after the connection to the server is established."
10dc9f9e MB	321	(unless (or (and (null erc-nickserv-passwords)
	322	(null erc-prompt-for-nickserv-password))
	323	(and (eq erc-nickserv-identify-mode 'both)
6904f7fe	324	(erc-nickserv-alist-regexp (erc-network))))
597993cf MB	325	(erc-nickserv-call-identify-function nick)))
	326
	327	(defun erc-nickserv-identify-on-nick-change (nick old-nick)
	328	"Identify to Nickserv whenever your nick changes."
10dc9f9e MB	329	(unless (or (and (null erc-nickserv-passwords)
	330	(null erc-prompt-for-nickserv-password))
	331	(and (eq erc-nickserv-identify-mode 'both)
6904f7fe	332	(erc-nickserv-alist-regexp (erc-network))))
597993cf MB	333	(erc-nickserv-call-identify-function nick)))
	334
	335	(defun erc-nickserv-call-identify-function (nickname)
	336	"Call `erc-nickserv-identify' interactively or run it with NICKNAME's
	337	password.
	338	The action is determined by the value of `erc-prompt-for-nickserv-password'."
	339	(if erc-prompt-for-nickserv-password
	340	(call-interactively 'erc-nickserv-identify)
	341	(when erc-nickserv-passwords
	342	(erc-nickserv-identify
	343	(cdr (assoc nickname
	344	(nth 1 (assoc (erc-network)
	345	erc-nickserv-passwords))))))))
	346
	347	;;;###autoload
	348	(defun erc-nickserv-identify (password)
	349	"Send an \"identify <PASSWORD>\" message to NickServ.
	350	When called interactively, read the password using `read-passwd'."
	351	(interactive
	352	(list (read-passwd
	353	(format "NickServ password for %s on %s (RET to cancel): "
	354	(erc-current-nick)
	355	(or (and (erc-network)
	356	(symbol-name (erc-network)))
	357	"Unknown network")))))
	358	(when (and password (not (string= "" password)))
	359	(let* ((erc-auto-discard-away nil)
	360	(network (erc-network))
	361	(nickserv-info (assoc network erc-nickserv-alist))
6904f7fe MB	362	(nickserv (or (erc-nickserv-alist-nickserv nil nickserv-info)
	363	"NickServ"))
	364	(identify-word (or (erc-nickserv-alist-ident-keyword
	365	nil nickserv-info)
	366	"IDENTIFY"))
	367	(nick (if (erc-nickserv-alist-use-nick-p nil nickserv-info)
597993cf MB	368	(concat (erc-current-nick) " ")
597993cf MB	369	""))
6904f7fe MB	370	(msgtype (or (erc-nickserv-alist-ident-command nil nickserv-info)
6904f7fe MB	371	"PRIVMSG")))
597993cf MB	372	(erc-message msgtype
	373	(concat nickserv " " identify-word " " nick password)))))
	374
c6b99621	375	(provide 'erc-services)
597993cf	376
c6b99621	377	;;; erc-services.el ends here
597993cf MB	378	;;
	379	;; Local Variables:
	380	;; indent-tabs-mode: t
	381	;; tab-width: 8
	382	;; End:
	383
	384	;; arch-tag: d401c8aa-d938-4255-96a9-3efb64c47e58