]> code.delx.au - gnu-emacs/blob - lisp/erc/erc.el
Merge remote-tracking branch 'origin/master' into emacs-25
[gnu-emacs] / lisp / erc / erc.el
1 ;; erc.el --- An Emacs Internet Relay Chat client -*- lexical-binding:t -*-
2
3 ;; Copyright (C) 1997-2015 Free Software Foundation, Inc.
4
5 ;; Author: Alexander L. Belikoff (alexander@belikoff.net)
6 ;; Contributors: Sergey Berezin (sergey.berezin@cs.cmu.edu),
7 ;; Mario Lang (mlang@delysid.org),
8 ;; Alex Schroeder (alex@gnu.org)
9 ;; Andreas Fuchs (afs@void.at)
10 ;; Gergely Nagy (algernon@midgard.debian.net)
11 ;; David Edmondson (dme@dme.org)
12 ;; Kelvin White (kwhite@gnu.org)
13 ;; Maintainer: emacs-devel@gnu.org
14 ;; Keywords: IRC, chat, client, Internet
15
16 ;; Version: 5.3
17
18 ;; This file is part of GNU Emacs.
19
20 ;; GNU Emacs is free software: you can redistribute it and/or modify
21 ;; it under the terms of the GNU General Public License as published by
22 ;; the Free Software Foundation, either version 3 of the License, or
23 ;; (at your option) any later version.
24
25 ;; GNU Emacs is distributed in the hope that it will be useful,
26 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
27 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 ;; GNU General Public License for more details.
29
30 ;; You should have received a copy of the GNU General Public License
31 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32
33 ;;; Commentary:
34
35 ;; ERC is a powerful, modular, and extensible IRC client for Emacs.
36
37 ;; For more information, see the following URLs:
38 ;; * http://sv.gnu.org/projects/erc/
39 ;; * http://www.emacswiki.org/cgi-bin/wiki/ERC
40
41
42
43 ;; As of 2006-06-13, ERC development is now hosted on Savannah
44 ;; (http://sv.gnu.org/projects/erc). I invite everyone who wants to
45 ;; hack on it to contact me <mwolson@gnu.org> in order to get write
46 ;; access to the shared Arch archive.
47
48 ;; Configuration:
49
50 ;; Use M-x customize-group RET erc RET to get an overview
51 ;; of all the variables you can tweak.
52
53 ;; Usage:
54
55 ;; To connect to an IRC server, do
56 ;;
57 ;; M-x erc RET
58 ;;
59 ;; After you are connected to a server, you can use C-h m or have a look at
60 ;; the ERC menu.
61
62 ;;; History:
63 ;;
64
65 (defconst erc-version-string (format "\C-bERC\C-b (IRC client for Emacs %s)" emacs-version)
66 "ERC version. This is used by function `erc-version'.")
67
68 ;;; Code:
69
70 (eval-when-compile (require 'cl-lib))
71 (require 'font-lock)
72 (require 'pp)
73 (require 'thingatpt)
74 (require 'auth-source)
75 (require 'erc-compat)
76
77 (defvar erc-official-location
78 "http://emacswiki.org/cgi-bin/wiki/ERC (mailing list: erc-discuss@gnu.org)"
79 "Location of the ERC client on the Internet.")
80
81 (defgroup erc nil
82 "Emacs Internet Relay Chat client."
83 :link '(url-link "http://www.emacswiki.org/cgi-bin/wiki/ERC")
84 :link '(custom-manual "(erc) Top")
85 :prefix "erc-"
86 :group 'applications)
87
88 (defgroup erc-buffers nil
89 "Creating new ERC buffers"
90 :group 'erc)
91
92 (defgroup erc-display nil
93 "Settings for how various things are displayed"
94 :group 'erc)
95
96 (defgroup erc-mode-line-and-header nil
97 "Displaying information in the mode-line and header"
98 :group 'erc-display)
99
100 (defgroup erc-ignore nil
101 "Ignoring certain messages"
102 :group 'erc)
103
104 (defgroup erc-lurker nil
105 "Hide specified message types sent by lurkers"
106 :version "24.3"
107 :group 'erc-ignore)
108
109 (defgroup erc-query nil
110 "Using separate buffers for private discussions"
111 :group 'erc)
112
113 (defgroup erc-quit-and-part nil
114 "Quitting and parting channels"
115 :group 'erc)
116
117 (defgroup erc-paranoia nil
118 "Know what is sent and received; control the display of sensitive data."
119 :group 'erc)
120
121 (defgroup erc-scripts nil
122 "Running scripts at startup and with /LOAD"
123 :group 'erc)
124
125 (require 'erc-backend)
126
127 ;; compatibility with older ERC releases
128
129 (define-obsolete-variable-alias 'erc-announced-server-name
130 'erc-server-announced-name "ERC 5.1")
131 (define-obsolete-variable-alias 'erc-process 'erc-server-process "ERC 5.1")
132 (define-obsolete-variable-alias 'erc-default-coding-system
133 'erc-server-coding-system "ERC 5.1")
134
135 (define-obsolete-function-alias 'erc-send-command
136 'erc-server-send "ERC 5.1")
137
138 ;; tunable connection and authentication parameters
139
140 (defcustom erc-server nil
141 "IRC server to use if one is not provided.
142 See function `erc-compute-server' for more details on connection
143 parameters and authentication."
144 :group 'erc
145 :type '(choice (const :tag "None" nil)
146 (string :tag "Server")))
147
148 (defcustom erc-port nil
149 "IRC port to use if not specified.
150
151 This can be either a string or a number."
152 :group 'erc
153 :type '(choice (const :tag "None" nil)
154 (integer :tag "Port number")
155 (string :tag "Port string")))
156
157 (defcustom erc-nick nil
158 "Nickname to use if one is not provided.
159
160 This can be either a string, or a list of strings.
161 In the latter case, if the first nick in the list is already in use,
162 other nicks are tried in the list order.
163
164 See function `erc-compute-nick' for more details on connection
165 parameters and authentication."
166 :group 'erc
167 :type '(choice (const :tag "None" nil)
168 (string :tag "Nickname")
169 (repeat (string :tag "Nickname"))))
170
171 (defcustom erc-nick-uniquifier "`"
172 "The string to append to the nick if it is already in use."
173 :group 'erc
174 :type 'string)
175
176 (defcustom erc-try-new-nick-p t
177 "If the nickname you chose isn't available, and this option is non-nil,
178 ERC should automatically attempt to connect with another nickname.
179
180 You can manually set another nickname with the /NICK command."
181 :group 'erc
182 :type 'boolean)
183
184 (defcustom erc-user-full-name nil
185 "User full name.
186
187 This can be either a string or a function to call.
188
189 See function `erc-compute-full-name' for more details on connection
190 parameters and authentication."
191 :group 'erc
192 :type '(choice (const :tag "No name" nil)
193 (string :tag "Name")
194 (function :tag "Get from function"))
195 :set (lambda (sym val)
196 (set sym (if (functionp val) (funcall val) val))))
197
198 (defcustom erc-rename-buffers nil
199 "Non-nil means rename buffers with network name, if available."
200 :version "24.5"
201 :group 'erc
202 :type 'boolean)
203
204 (defvar erc-password nil
205 "Password to use when authenticating to an IRC server.
206 It is not strictly necessary to provide this, since ERC will
207 prompt you for it.")
208
209 (defcustom erc-user-mode nil
210 "Initial user modes to be set after a connection is established."
211 :group 'erc
212 :type '(choice (const nil) string function))
213
214
215 (defcustom erc-prompt-for-password t
216 "Asks before using the default password, or whether to enter a new one."
217 :group 'erc
218 :type 'boolean)
219
220 (defcustom erc-warn-about-blank-lines t
221 "Warn the user if they attempt to send a blank line."
222 :group 'erc
223 :type 'boolean)
224
225 (defcustom erc-send-whitespace-lines nil
226 "If set to non-nil, send lines consisting of only whitespace."
227 :group 'erc
228 :type 'boolean)
229
230 (defcustom erc-hide-prompt nil
231 "If non-nil, do not display the prompt for commands.
232
233 \(A command is any input starting with a `/').
234
235 See also the variables `erc-prompt' and `erc-command-indicator'."
236 :group 'erc-display
237 :type 'boolean)
238
239 ;; tunable GUI stuff
240
241 (defcustom erc-show-my-nick t
242 "If non-nil, display one's own nickname when sending a message.
243
244 If non-nil, \"<nickname>\" will be shown.
245 If nil, only \"> \" will be shown."
246 :group 'erc-display
247 :type 'boolean)
248
249 (define-widget 'erc-message-type 'set
250 "A set of standard IRC Message types."
251 :args '((const "JOIN")
252 (const "KICK")
253 (const "NICK")
254 (const "PART")
255 (const "QUIT")
256 (const "MODE")
257 (repeat :inline t :tag "Others" (string :tag "IRC Message Type"))))
258
259 (defcustom erc-hide-list nil
260 "A global list of IRC message types to hide.
261 A typical value would be \(\"JOIN\" \"PART\" \"QUIT\")."
262 :group 'erc-ignore
263 :type 'erc-message-type)
264
265 (defcustom erc-network-hide-list nil
266 "A list of IRC networks to hide message types from.
267 A typical value would be \((\"freenode\" \"MODE\")
268 (\"OFTC\" \"JOIN\" \"QUIT\"))."
269 :group 'erc-ignore
270 :type 'erc-message-type)
271
272 (defcustom erc-channel-hide-list nil
273 "A list of IRC channels to hide message types from.
274 A typical value would be \((\"#emacs\" \"QUIT\" \"JOIN\")
275 (\"#erc\" \"NICK\")."
276 :group 'erc-ignore
277 :type 'erc-message-type)
278
279 (defvar erc-session-password nil
280 "The password used for the current session.")
281 (make-variable-buffer-local 'erc-session-password)
282
283 (defcustom erc-disconnected-hook nil
284 "Run this hook with arguments (NICK IP REASON) when disconnected.
285 This happens before automatic reconnection. Note, that
286 `erc-server-QUIT-functions' might not be run when we disconnect,
287 simply because we do not necessarily receive the QUIT event."
288 :group 'erc-hooks
289 :type 'hook)
290
291 (defcustom erc-complete-functions nil
292 "These functions get called when the user hits TAB in ERC.
293 Each function in turn is called until one returns non-nil to
294 indicate it has handled the input."
295 :group 'erc-hooks
296 :type 'hook)
297
298 (defcustom erc-join-hook nil
299 "Hook run when we join a channel. Hook functions are called
300 without arguments, with the current buffer set to the buffer of
301 the new channel.
302
303 See also `erc-server-JOIN-functions', `erc-part-hook'."
304 :group 'erc-hooks
305 :type 'hook)
306
307 (defcustom erc-quit-hook nil
308 "Hook run when processing a quit command directed at our nick.
309
310 The hook receives one argument, the current PROCESS.
311 See also `erc-server-QUIT-functions' and `erc-disconnected-hook'."
312 :group 'erc-hooks
313 :type 'hook)
314
315 (defcustom erc-part-hook nil
316 "Hook run when processing a PART message directed at our nick.
317
318 The hook receives one argument, the current BUFFER.
319 See also `erc-server-QUIT-functions', `erc-quit-hook' and
320 `erc-disconnected-hook'."
321 :group 'erc-hooks
322 :type 'hook)
323
324 (defcustom erc-kick-hook nil
325 "Hook run when processing a KICK message directed at our nick.
326
327 The hook receives one argument, the current BUFFER.
328 See also `erc-server-PART-functions' and `erc-part-hook'."
329 :group 'erc-hooks
330 :type 'hook)
331
332 (defcustom erc-nick-changed-functions nil
333 "List of functions run when your nick was successfully changed.
334
335 Each function should accept two arguments, NEW-NICK and OLD-NICK."
336 :group 'erc-hooks
337 :type 'hook)
338
339 (defcustom erc-connect-pre-hook '(erc-initialize-log-marker)
340 "Hook called just before `erc' calls `erc-connect'.
341 Functions are passed a buffer as the first argument."
342 :group 'erc-hooks
343 :type 'hook)
344
345
346 (defvar erc-channel-users nil
347 "A hash table of members in the current channel, which
348 associates nicknames with cons cells of the form:
349 \(USER . MEMBER-DATA) where USER is a pointer to an
350 erc-server-user struct, and MEMBER-DATA is a pointer to an
351 erc-channel-user struct.")
352 (make-variable-buffer-local 'erc-channel-users)
353
354 (defvar erc-server-users nil
355 "A hash table of users on the current server, which associates
356 nicknames with erc-server-user struct instances.")
357 (make-variable-buffer-local 'erc-server-users)
358
359 (defun erc-downcase (string)
360 "Convert STRING to IRC standard conforming downcase."
361 (let ((s (downcase string))
362 (c '((?\[ . ?\{)
363 (?\] . ?\})
364 (?\\ . ?\|)
365 (?~ . ?^))))
366 (save-match-data
367 (while (string-match "[]\\[~]" s)
368 (aset s (match-beginning 0)
369 (cdr (assq (aref s (match-beginning 0)) c)))))
370 s))
371
372 (defmacro erc-with-server-buffer (&rest body)
373 "Execute BODY in the current ERC server buffer.
374 If no server buffer exists, return nil."
375 (declare (indent 0) (debug (body)))
376 (let ((buffer (make-symbol "buffer")))
377 `(let ((,buffer (erc-server-buffer)))
378 (when (buffer-live-p ,buffer)
379 (with-current-buffer ,buffer
380 ,@body)))))
381
382 (cl-defstruct (erc-server-user (:type vector) :named)
383 ;; User data
384 nickname host login full-name info
385 ;; Buffers
386 ;;
387 ;; This is an alist of the form (BUFFER . CHANNEL-DATA), where
388 ;; CHANNEL-DATA is either nil or an erc-channel-user struct.
389 (buffers nil)
390 )
391
392 (cl-defstruct (erc-channel-user (:type vector) :named)
393 voice halfop op admin owner
394 ;; Last message time (in the form of the return value of
395 ;; (current-time)
396 ;;
397 ;; This is useful for ordered name completion.
398 (last-message-time nil))
399
400 (defsubst erc-get-channel-user (nick)
401 "Find the (USER . CHANNEL-DATA) element corresponding to NICK
402 in the current buffer's `erc-channel-users' hash table."
403 (gethash (erc-downcase nick) erc-channel-users))
404
405 (defsubst erc-get-server-user (nick)
406 "Find the USER corresponding to NICK in the current server's
407 `erc-server-users' hash table."
408 (erc-with-server-buffer
409 (gethash (erc-downcase nick) erc-server-users)))
410
411 (defsubst erc-add-server-user (nick user)
412 "This function is for internal use only.
413
414 Adds USER with nickname NICK to the `erc-server-users' hash table."
415 (erc-with-server-buffer
416 (puthash (erc-downcase nick) user erc-server-users)))
417
418 (defsubst erc-remove-server-user (nick)
419 "This function is for internal use only.
420
421 Removes the user with nickname NICK from the `erc-server-users'
422 hash table. This user is not removed from the
423 `erc-channel-users' lists of other buffers.
424
425 See also: `erc-remove-user'."
426 (erc-with-server-buffer
427 (remhash (erc-downcase nick) erc-server-users)))
428
429 (defun erc-change-user-nickname (user new-nick)
430 "This function is for internal use only.
431
432 Changes the nickname of USER to NEW-NICK in the
433 `erc-server-users' hash table. The `erc-channel-users' lists of
434 other buffers are also changed."
435 (let ((nick (erc-server-user-nickname user)))
436 (setf (erc-server-user-nickname user) new-nick)
437 (erc-with-server-buffer
438 (remhash (erc-downcase nick) erc-server-users)
439 (puthash (erc-downcase new-nick) user erc-server-users))
440 (dolist (buf (erc-server-user-buffers user))
441 (if (buffer-live-p buf)
442 (with-current-buffer buf
443 (let ((cdata (erc-get-channel-user nick)))
444 (remhash (erc-downcase nick) erc-channel-users)
445 (puthash (erc-downcase new-nick) cdata
446 erc-channel-users)))))))
447
448 (defun erc-remove-channel-user (nick)
449 "This function is for internal use only.
450
451 Removes the user with nickname NICK from the `erc-channel-users'
452 list for this channel. If this user is not in the
453 `erc-channel-users' list of any other buffers, the user is also
454 removed from the server's `erc-server-users' list.
455
456 See also: `erc-remove-server-user' and `erc-remove-user'."
457 (let ((channel-data (erc-get-channel-user nick)))
458 (when channel-data
459 (let ((user (car channel-data)))
460 (setf (erc-server-user-buffers user)
461 (delq (current-buffer)
462 (erc-server-user-buffers user)))
463 (remhash (erc-downcase nick) erc-channel-users)
464 (if (null (erc-server-user-buffers user))
465 (erc-remove-server-user nick))))))
466
467 (defun erc-remove-user (nick)
468 "This function is for internal use only.
469
470 Removes the user with nickname NICK from the `erc-server-users'
471 list as well as from all `erc-channel-users' lists.
472
473 See also: `erc-remove-server-user' and
474 `erc-remove-channel-user'."
475 (let ((user (erc-get-server-user nick)))
476 (when user
477 (let ((buffers (erc-server-user-buffers user)))
478 (dolist (buf buffers)
479 (if (buffer-live-p buf)
480 (with-current-buffer buf
481 (remhash (erc-downcase nick) erc-channel-users)
482 (run-hooks 'erc-channel-members-changed-hook)))))
483 (erc-remove-server-user nick))))
484
485 (defun erc-remove-channel-users ()
486 "This function is for internal use only.
487
488 Removes all users in the current channel. This is called by
489 `erc-server-PART' and `erc-server-QUIT'."
490 (when (and erc-server-connected
491 (erc-server-process-alive)
492 (hash-table-p erc-channel-users))
493 (maphash (lambda (nick _cdata)
494 (erc-remove-channel-user nick))
495 erc-channel-users)
496 (clrhash erc-channel-users)))
497
498 (defsubst erc-channel-user-owner-p (nick)
499 "Return non-nil if NICK is an owner of the current channel."
500 (and nick
501 (hash-table-p erc-channel-users)
502 (let ((cdata (erc-get-channel-user nick)))
503 (and cdata (cdr cdata)
504 (erc-channel-user-owner (cdr cdata))))))
505
506 (defsubst erc-channel-user-admin-p (nick)
507 "Return non-nil if NICK is an admin in the current channel."
508 (and nick
509 (hash-table-p erc-channel-users)
510 (let ((cdata (erc-get-channel-user nick)))
511 (and cdata (cdr cdata)
512 (erc-channel-user-admin (cdr cdata))))))
513
514 (defsubst erc-channel-user-op-p (nick)
515 "Return non-nil if NICK is an operator in the current channel."
516 (and nick
517 (hash-table-p erc-channel-users)
518 (let ((cdata (erc-get-channel-user nick)))
519 (and cdata (cdr cdata)
520 (erc-channel-user-op (cdr cdata))))))
521
522 (defsubst erc-channel-user-halfop-p (nick)
523 "Return non-nil if NICK is a half-operator in the current channel."
524 (and nick
525 (hash-table-p erc-channel-users)
526 (let ((cdata (erc-get-channel-user nick)))
527 (and cdata (cdr cdata)
528 (erc-channel-user-halfop (cdr cdata))))))
529
530 (defsubst erc-channel-user-voice-p (nick)
531 "Return non-nil if NICK has voice in the current channel."
532 (and nick
533 (hash-table-p erc-channel-users)
534 (let ((cdata (erc-get-channel-user nick)))
535 (and cdata (cdr cdata)
536 (erc-channel-user-voice (cdr cdata))))))
537
538 (defun erc-get-channel-user-list ()
539 "Return a list of users in the current channel. Each element
540 of the list is of the form (USER . CHANNEL-DATA), where USER is
541 an erc-server-user struct, and CHANNEL-DATA is either nil or an
542 erc-channel-user struct.
543
544 See also: `erc-sort-channel-users-by-activity'"
545 (let (users)
546 (if (hash-table-p erc-channel-users)
547 (maphash (lambda (_nick cdata)
548 (setq users (cons cdata users)))
549 erc-channel-users))
550 users))
551
552 (defun erc-get-server-nickname-list ()
553 "Return a list of known nicknames on the current server."
554 (erc-with-server-buffer
555 (let (nicks)
556 (when (hash-table-p erc-server-users)
557 (maphash (lambda (_n user)
558 (setq nicks
559 (cons (erc-server-user-nickname user)
560 nicks)))
561 erc-server-users)
562 nicks))))
563
564 (defun erc-get-channel-nickname-list ()
565 "Return a list of known nicknames on the current channel."
566 (let (nicks)
567 (when (hash-table-p erc-channel-users)
568 (maphash (lambda (_n cdata)
569 (setq nicks
570 (cons (erc-server-user-nickname (car cdata))
571 nicks)))
572 erc-channel-users)
573 nicks)))
574
575 (defun erc-get-server-nickname-alist ()
576 "Return an alist of known nicknames on the current server."
577 (erc-with-server-buffer
578 (let (nicks)
579 (when (hash-table-p erc-server-users)
580 (maphash (lambda (_n user)
581 (setq nicks
582 (cons (cons (erc-server-user-nickname user) nil)
583 nicks)))
584 erc-server-users)
585 nicks))))
586
587 (defun erc-get-channel-nickname-alist ()
588 "Return an alist of known nicknames on the current channel."
589 (let (nicks)
590 (when (hash-table-p erc-channel-users)
591 (maphash (lambda (_n cdata)
592 (setq nicks
593 (cons (cons (erc-server-user-nickname (car cdata)) nil)
594 nicks)))
595 erc-channel-users)
596 nicks)))
597
598 (defun erc-sort-channel-users-by-activity (list)
599 "Sort LIST such that users which have spoken most recently are listed first.
600 LIST must be of the form (USER . CHANNEL-DATA).
601
602 See also: `erc-get-channel-user-list'."
603 (sort list
604 (lambda (x y)
605 (when (and (cdr x) (cdr y))
606 (let ((tx (erc-channel-user-last-message-time (cdr x)))
607 (ty (erc-channel-user-last-message-time (cdr y))))
608 (and tx
609 (or (not ty)
610 (time-less-p ty tx))))))))
611
612 (defun erc-sort-channel-users-alphabetically (list)
613 "Sort LIST so that users' nicknames are in alphabetical order.
614 LIST must be of the form (USER . CHANNEL-DATA).
615
616 See also: `erc-get-channel-user-list'."
617 (sort list
618 (lambda (x y)
619 (when (and (cdr x) (cdr y))
620 (let ((nickx (downcase (erc-server-user-nickname (car x))))
621 (nicky (downcase (erc-server-user-nickname (car y)))))
622 (and nickx
623 (or (not nicky)
624 (string-lessp nickx nicky))))))))
625
626 (defvar erc-channel-topic nil
627 "A topic string for the channel. Should only be used in channel-buffers.")
628 (make-variable-buffer-local 'erc-channel-topic)
629
630 (defvar erc-channel-modes nil
631 "List of strings representing channel modes.
632 E.g. '(\"i\" \"m\" \"s\" \"b Quake!*@*\")
633 \(not sure the ban list will be here, but why not)")
634 (make-variable-buffer-local 'erc-channel-modes)
635
636 (defvar erc-insert-marker nil
637 "The place where insertion of new text in erc buffers should happen.")
638 (make-variable-buffer-local 'erc-insert-marker)
639
640 (defvar erc-input-marker nil
641 "The marker where input should be inserted.")
642 (make-variable-buffer-local 'erc-input-marker)
643
644 (defun erc-string-no-properties (string)
645 "Return a copy of STRING will all text-properties removed."
646 (let ((newstring (copy-sequence string)))
647 (set-text-properties 0 (length newstring) nil newstring)
648 newstring))
649
650 (defcustom erc-prompt "ERC>"
651 "Prompt used by ERC. Trailing whitespace is not required."
652 :group 'erc-display
653 :type '(choice string function))
654
655 (defun erc-prompt ()
656 "Return the input prompt as a string.
657
658 See also the variable `erc-prompt'."
659 (let ((prompt (if (functionp erc-prompt)
660 (funcall erc-prompt)
661 erc-prompt)))
662 (if (> (length prompt) 0)
663 (concat prompt " ")
664 prompt)))
665
666 (defcustom erc-command-indicator nil
667 "Indicator used by ERC for showing commands.
668
669 If non-nil, this will be used in the ERC buffer to indicate
670 commands (i.e., input starting with a `/').
671
672 If nil, the prompt will be constructed from the variable `erc-prompt'."
673 :group 'erc-display
674 :type '(choice (const nil) string function))
675
676 (defun erc-command-indicator ()
677 "Return the command indicator prompt as a string.
678
679 This only has any meaning if the variable `erc-command-indicator' is non-nil."
680 (and erc-command-indicator
681 (let ((prompt (if (functionp erc-command-indicator)
682 (funcall erc-command-indicator)
683 erc-command-indicator)))
684 (if (> (length prompt) 0)
685 (concat prompt " ")
686 prompt))))
687
688 (defcustom erc-notice-prefix "*** "
689 "Prefix for all notices."
690 :group 'erc-display
691 :type 'string)
692
693 (defcustom erc-notice-highlight-type 'all
694 "Determines how to highlight notices.
695 See `erc-notice-prefix'.
696
697 The following values are allowed:
698
699 `prefix' - highlight notice prefix only
700 `all' - highlight the entire notice
701
702 Any other value disables notice's highlighting altogether."
703 :group 'erc-display
704 :type '(choice (const :tag "highlight notice prefix only" prefix)
705 (const :tag "highlight the entire notice" all)
706 (const :tag "don't highlight notices at all" nil)))
707
708 (defcustom erc-echo-notice-hook nil
709 "List of functions to call to echo a private notice.
710 Each function is called with four arguments, the string
711 to display, the parsed server message, the target buffer (or
712 nil), and the sender. The functions are called in order, until a
713 function evaluates to non-nil. These hooks are called after
714 those specified in `erc-echo-notice-always-hook'.
715
716 See also: `erc-echo-notice-always-hook',
717 `erc-echo-notice-in-default-buffer',
718 `erc-echo-notice-in-target-buffer',
719 `erc-echo-notice-in-minibuffer',
720 `erc-echo-notice-in-server-buffer',
721 `erc-echo-notice-in-active-non-server-buffer',
722 `erc-echo-notice-in-active-buffer',
723 `erc-echo-notice-in-user-buffers',
724 `erc-echo-notice-in-user-and-target-buffers',
725 `erc-echo-notice-in-first-user-buffer'"
726 :group 'erc-hooks
727 :type 'hook
728 :options '(erc-echo-notice-in-default-buffer
729 erc-echo-notice-in-target-buffer
730 erc-echo-notice-in-minibuffer
731 erc-echo-notice-in-server-buffer
732 erc-echo-notice-in-active-non-server-buffer
733 erc-echo-notice-in-active-buffer
734 erc-echo-notice-in-user-buffers
735 erc-echo-notice-in-user-and-target-buffers
736 erc-echo-notice-in-first-user-buffer))
737
738 (defcustom erc-echo-notice-always-hook
739 '(erc-echo-notice-in-default-buffer)
740 "List of functions to call to echo a private notice.
741 Each function is called with four arguments, the string
742 to display, the parsed server message, the target buffer (or
743 nil), and the sender. The functions are called in order, and all
744 functions are called. These hooks are called before those
745 specified in `erc-echo-notice-hook'.
746
747 See also: `erc-echo-notice-hook',
748 `erc-echo-notice-in-default-buffer',
749 `erc-echo-notice-in-target-buffer',
750 `erc-echo-notice-in-minibuffer',
751 `erc-echo-notice-in-server-buffer',
752 `erc-echo-notice-in-active-non-server-buffer',
753 `erc-echo-notice-in-active-buffer',
754 `erc-echo-notice-in-user-buffers',
755 `erc-echo-notice-in-user-and-target-buffers',
756 `erc-echo-notice-in-first-user-buffer'"
757 :group 'erc-hooks
758 :type 'hook
759 :options '(erc-echo-notice-in-default-buffer
760 erc-echo-notice-in-target-buffer
761 erc-echo-notice-in-minibuffer
762 erc-echo-notice-in-server-buffer
763 erc-echo-notice-in-active-non-server-buffer
764 erc-echo-notice-in-active-buffer
765 erc-echo-notice-in-user-buffers
766 erc-echo-notice-in-user-and-target-buffers
767 erc-echo-notice-in-first-user-buffer))
768
769 ;; other tunable parameters
770
771 (defcustom erc-whowas-on-nosuchnick nil
772 "If non-nil, do a whowas on a nick if no such nick."
773 :group 'erc
774 :type 'boolean)
775
776 (defcustom erc-verbose-server-ping nil
777 "If non-nil, show every time you get a PING or PONG from the server."
778 :group 'erc-paranoia
779 :type 'boolean)
780
781 (defcustom erc-public-away-p nil
782 "Let others know you are back when you are no longer marked away.
783 This happens in this form:
784 * <nick> is back (gone for <time>)
785
786 Many consider it impolite to do so automatically."
787 :group 'erc
788 :type 'boolean)
789
790 (defcustom erc-away-nickname nil
791 "The nickname to take when you are marked as being away."
792 :group 'erc
793 :type '(choice (const nil)
794 string))
795
796 (defcustom erc-paranoid nil
797 "If non-nil, then all incoming CTCP requests will be shown."
798 :group 'erc-paranoia
799 :type 'boolean)
800
801 (defcustom erc-disable-ctcp-replies nil
802 "Disable replies to CTCP requests that require a reply.
803 If non-nil, then all incoming CTCP requests that normally require
804 an automatic reply (like VERSION or PING) will be ignored. Good to
805 set if some hacker is trying to flood you away."
806 :group 'erc-paranoia
807 :type 'boolean)
808
809 (defcustom erc-anonymous-login t
810 "Be paranoid, don't give away your machine name."
811 :group 'erc-paranoia
812 :type 'boolean)
813
814 (defcustom erc-prompt-for-channel-key nil
815 "Prompt for channel key when using `erc-join-channel' interactively."
816 :group 'erc
817 :type 'boolean)
818
819 (defcustom erc-email-userid "user"
820 "Use this as your email user ID."
821 :group 'erc
822 :type 'string)
823
824 (defcustom erc-system-name nil
825 "Use this as the name of your system.
826 If nil, ERC will call `system-name' to get this information."
827 :group 'erc
828 :type '(choice (const :tag "Default system name" nil)
829 string))
830
831 (defcustom erc-ignore-list nil
832 "List of regexps matching user identifiers to ignore.
833
834 A user identifier has the form \"nick!login@host\". If an
835 identifier matches, the message from the person will not be
836 processed."
837 :group 'erc-ignore
838 :type '(repeat regexp))
839 (make-variable-buffer-local 'erc-ignore-list)
840
841 (defcustom erc-ignore-reply-list nil
842 "List of regexps matching user identifiers to ignore completely.
843
844 This differs from `erc-ignore-list' in that it also ignores any
845 messages directed at the user.
846
847 A user identifier has the form \"nick!login@host\".
848
849 If an identifier matches, or a message is addressed to a nick
850 whose identifier matches, the message will not be processed.
851
852 CAVEAT: ERC doesn't know about the user and host of anyone who
853 was already in the channel when you joined, but never said
854 anything, so it won't be able to match the user and host of those
855 people. You can update the ERC internal info using /WHO *."
856 :group 'erc-ignore
857 :type '(repeat regexp))
858
859 (defvar erc-flood-protect t
860 "If non-nil, flood protection is enabled.
861 Flooding is sending too much information to the server in too
862 short of an interval, which may cause the server to terminate the
863 connection.
864
865 See `erc-server-flood-margin' for other flood-related parameters.")
866
867 ;; Script parameters
868
869 (defcustom erc-startup-file-list
870 (list (concat erc-user-emacs-directory ".ercrc.el")
871 (concat erc-user-emacs-directory ".ercrc")
872 "~/.ercrc.el" "~/.ercrc" ".ercrc.el" ".ercrc")
873 "List of files to try for a startup script.
874 The first existent and readable one will get executed.
875
876 If the filename ends with `.el' it is presumed to be an Emacs Lisp
877 script and it gets (load)ed. Otherwise it is treated as a bunch of
878 regular IRC commands."
879 :group 'erc-scripts
880 :type '(repeat file))
881
882 (defcustom erc-script-path nil
883 "List of directories to look for a script in /load command.
884 The script is first searched in the current directory, then in each
885 directory in the list."
886 :group 'erc-scripts
887 :type '(repeat directory))
888
889 (defcustom erc-script-echo t
890 "If non-nil, echo the IRC script commands locally."
891 :group 'erc-scripts
892 :type 'boolean)
893
894 (defvar erc-last-saved-position nil
895 "A marker containing the position the current buffer was last saved at.")
896 (make-variable-buffer-local 'erc-last-saved-position)
897
898 (defcustom erc-kill-buffer-on-part nil
899 "Kill the channel buffer on PART.
900 This variable should probably stay nil, as ERC can reuse buffers if
901 you rejoin them later."
902 :group 'erc-quit-and-part
903 :type 'boolean)
904
905 (defcustom erc-kill-queries-on-quit nil
906 "Kill all query (also channel) buffers of this server on QUIT.
907 See the variable `erc-kill-buffer-on-part' for details."
908 :group 'erc-quit-and-part
909 :type 'boolean)
910
911 (defcustom erc-kill-server-buffer-on-quit nil
912 "Kill the server buffer of the process on QUIT."
913 :group 'erc-quit-and-part
914 :type 'boolean)
915
916 (defcustom erc-quit-reason-various-alist nil
917 "Alist of possible arguments to the /quit command.
918
919 Each element has the form:
920 (REGEXP RESULT)
921
922 If REGEXP matches the argument to /quit, then its relevant RESULT
923 will be used. RESULT may be either a string, or a function. If
924 a function, it should return the quit message as a string.
925
926 If no elements match, then the empty string is used.
927
928 As an example:
929 (setq erc-quit-reason-various-alist
930 \\='((\"xmms\" dme:now-playing)
931 (\"version\" erc-quit-reason-normal)
932 (\"home\" \"Gone home !\")
933 (\"^$\" \"Default Reason\")))
934 If the user types \"/quit home\", then \"Gone home !\" will be used
935 as the quit message."
936 :group 'erc-quit-and-part
937 :type '(repeat (list regexp (choice (string) (function)))))
938
939 (defcustom erc-part-reason-various-alist nil
940 "Alist of possible arguments to the /part command.
941
942 Each element has the form:
943 (REGEXP RESULT)
944
945 If REGEXP matches the argument to /part, then its relevant RESULT
946 will be used. RESULT may be either a string, or a function. If
947 a function, it should return the part message as a string.
948
949 If no elements match, then the empty string is used.
950
951 As an example:
952 (setq erc-part-reason-various-alist
953 \\='((\"xmms\" dme:now-playing)
954 (\"version\" erc-part-reason-normal)
955 (\"home\" \"Gone home !\")
956 (\"^$\" \"Default Reason\")))
957 If the user types \"/part home\", then \"Gone home !\" will be used
958 as the part message."
959 :group 'erc-quit-and-part
960 :type '(repeat (list regexp (choice (string) (function)))))
961
962 (defcustom erc-quit-reason 'erc-quit-reason-normal
963 "A function which returns the reason for quitting.
964
965 The function is passed a single argument, the string typed by the
966 user after \"/quit\"."
967 :group 'erc-quit-and-part
968 :type '(choice (const erc-quit-reason-normal)
969 (const erc-quit-reason-various)
970 (symbol)))
971
972 (defcustom erc-part-reason 'erc-part-reason-normal
973 "A function which returns the reason for parting a channel.
974
975 The function is passed a single argument, the string typed by the
976 user after \"/PART\"."
977 :group 'erc-quit-and-part
978 :type '(choice (const erc-part-reason-normal)
979 (const erc-part-reason-various)
980 (symbol)))
981
982 (defvar erc-grab-buffer-name "*erc-grab*"
983 "The name of the buffer created by `erc-grab-region'.")
984
985 ;; variables available for IRC scripts
986
987 (defvar erc-user-information "ERC User"
988 "USER_INFORMATION IRC variable.")
989
990 ;; Hooks
991
992 (defgroup erc-hooks nil
993 "Hook variables for fancy customizations of ERC."
994 :group 'erc)
995
996 (defcustom erc-mode-hook nil
997 "Hook run after `erc-mode' setup is finished."
998 :group 'erc-hooks
999 :type 'hook
1000 :options '(erc-add-scroll-to-bottom))
1001
1002 (defcustom erc-timer-hook nil
1003 "Put functions which should get called more or less periodically here.
1004 The idea is that servers always play ping pong with the client, and so there
1005 is no need for any idle-timer games with Emacs."
1006 :group 'erc-hooks
1007 :type 'hook)
1008
1009 (defcustom erc-insert-pre-hook nil
1010 "Hook called first when some text is inserted through `erc-display-line'.
1011 It gets called with one argument, STRING.
1012 To be able to modify the inserted text, use `erc-insert-modify-hook' instead.
1013 Filtering functions can set `erc-insert-this' to nil to avoid
1014 display of that particular string at all."
1015 :group 'erc-hooks
1016 :type 'hook)
1017
1018 (defcustom erc-send-pre-hook nil
1019 "Hook called first when some text is sent through `erc-send-current-line'.
1020 It gets called with one argument, STRING.
1021
1022 To change the text that will be sent, set the variable `str' which is
1023 used in `erc-send-current-line'.
1024
1025 To change the text inserted into the buffer without changing the text
1026 that will be sent, use `erc-send-modify-hook' instead.
1027
1028 Filtering functions can set `erc-send-this' to nil to avoid sending of
1029 that particular string at all and `erc-insert-this' to prevent
1030 inserting that particular string into the buffer.
1031
1032 Note that it's useless to set `erc-send-this' to nil and
1033 `erc-insert-this' to t. ERC is sane enough to not insert the text
1034 anyway."
1035 :group 'erc-hooks
1036 :type 'hook)
1037
1038 (defvar erc-insert-this t
1039 "Insert the text into the target buffer or not.
1040 Functions on `erc-insert-pre-hook' can set this variable to nil
1041 if they wish to avoid insertion of a particular string.")
1042
1043 (defvar erc-send-this t
1044 "Send the text to the target or not.
1045 Functions on `erc-send-pre-hook' can set this variable to nil
1046 if they wish to avoid sending of a particular string.")
1047
1048 (defcustom erc-insert-modify-hook ()
1049 "Insertion hook for functions that will change the text's appearance.
1050 This hook is called just after `erc-insert-pre-hook' when the value
1051 of `erc-insert-this' is t.
1052 While this hook is run, narrowing is in effect and `current-buffer' is
1053 the buffer where the text got inserted. One possible value to add here
1054 is `erc-fill'."
1055 :group 'erc-hooks
1056 :type 'hook)
1057
1058 (defcustom erc-insert-post-hook nil
1059 "This hook is called just after `erc-insert-modify-hook'.
1060 At this point, all modifications from prior hook functions are done."
1061 :group 'erc-hooks
1062 :type 'hook
1063 :options '(erc-truncate-buffer
1064 erc-make-read-only
1065 erc-save-buffer-in-logs))
1066
1067 (defcustom erc-send-modify-hook nil
1068 "Sending hook for functions that will change the text's appearance.
1069 This hook is called just after `erc-send-pre-hook' when the values
1070 of `erc-send-this' and `erc-insert-this' are both t.
1071 While this hook is run, narrowing is in effect and `current-buffer' is
1072 the buffer where the text got inserted.
1073
1074 Note that no function in this hook can change the appearance of the
1075 text that is sent. Only changing the sent text's appearance on the
1076 sending user's screen is possible. One possible value to add here
1077 is `erc-fill'."
1078 :group 'erc-hooks
1079 :type 'hook)
1080
1081 (defcustom erc-send-post-hook nil
1082 "This hook is called just after `erc-send-modify-hook'.
1083 At this point, all modifications from prior hook functions are done.
1084 NOTE: The functions on this hook are called _before_ sending a command
1085 to the server.
1086
1087 This function is called with narrowing, ala `erc-send-modify-hook'."
1088 :group 'erc-hooks
1089 :type 'hook
1090 :options '(erc-make-read-only))
1091
1092 (defcustom erc-send-completed-hook
1093 (when (fboundp 'emacspeak-auditory-icon)
1094 (list (byte-compile
1095 (lambda (_str)
1096 (emacspeak-auditory-icon 'select-object)))))
1097 "Hook called after a message has been parsed by ERC.
1098
1099 The single argument to the functions is the unmodified string
1100 which the local user typed."
1101 :group 'erc-hooks
1102 :type 'hook)
1103 ;; mode-specific tables
1104
1105 (defvar erc-mode-syntax-table
1106 (let ((syntax-table (make-syntax-table)))
1107 (modify-syntax-entry ?\" ". " syntax-table)
1108 (modify-syntax-entry ?\\ ". " syntax-table)
1109 (modify-syntax-entry ?' "w " syntax-table)
1110 ;; Make dabbrev-expand useful for nick names
1111 (modify-syntax-entry ?< "." syntax-table)
1112 (modify-syntax-entry ?> "." syntax-table)
1113 syntax-table)
1114 "Syntax table used while in ERC mode.")
1115
1116 (defvar erc-mode-abbrev-table nil
1117 "Abbrev table used while in ERC mode.")
1118 (define-abbrev-table 'erc-mode-abbrev-table ())
1119
1120 (defvar erc-mode-map
1121 (let ((map (make-sparse-keymap)))
1122 (define-key map "\C-m" 'erc-send-current-line)
1123 (define-key map "\C-a" 'erc-bol)
1124 (define-key map [home] 'erc-bol)
1125 (define-key map "\C-c\C-a" 'erc-bol)
1126 (define-key map "\C-c\C-b" 'erc-switch-to-buffer)
1127 (define-key map "\C-c\C-c" 'erc-toggle-interpret-controls)
1128 (define-key map "\C-c\C-d" 'erc-input-action)
1129 (define-key map "\C-c\C-e" 'erc-toggle-ctcp-autoresponse)
1130 (define-key map "\C-c\C-f" 'erc-toggle-flood-control)
1131 (define-key map "\C-c\C-i" 'erc-invite-only-mode)
1132 (define-key map "\C-c\C-j" 'erc-join-channel)
1133 (define-key map "\C-c\C-n" 'erc-channel-names)
1134 (define-key map "\C-c\C-o" 'erc-get-channel-mode-from-keypress)
1135 (define-key map "\C-c\C-p" 'erc-part-from-channel)
1136 (define-key map "\C-c\C-q" 'erc-quit-server)
1137 (define-key map "\C-c\C-r" 'erc-remove-text-properties-region)
1138 (define-key map "\C-c\C-t" 'erc-set-topic)
1139 (define-key map "\C-c\C-u" 'erc-kill-input)
1140 (define-key map "\C-c\C-x" 'erc-quit-server)
1141 (define-key map "\M-\t" 'ispell-complete-word)
1142 (define-key map "\t" 'completion-at-point)
1143
1144 ;; Suppress `font-lock-fontify-block' key binding since it
1145 ;; destroys face properties.
1146 (define-key map [remap font-lock-fontify-block] 'undefined)
1147
1148 map)
1149 "ERC keymap.")
1150
1151 ;; Faces
1152
1153 ; Honestly, I have a horrible sense of color and the "defaults" below
1154 ; are supposed to be really bad. But colors ARE required in IRC to
1155 ; convey different parts of conversation. If you think you know better
1156 ; defaults - send them to me.
1157
1158 ;; Now colors are a bit nicer, at least to my eyes.
1159 ;; You may still want to change them to better fit your background.-- S.B.
1160
1161 (defgroup erc-faces nil
1162 "Faces for ERC."
1163 :group 'erc)
1164
1165 ;; FIXME faces should not end in "-face".
1166 (defface erc-default-face '((t))
1167 "ERC default face."
1168 :group 'erc-faces)
1169
1170 (defface erc-nick-prefix-face '((t :inherit erc-nick-default-face :weight bold))
1171 "ERC face used for user mode prefix."
1172 :group 'erc-faces)
1173
1174 (defface erc-my-nick-prefix-face '((t :inherit erc-nick-default-face :weight bold))
1175 "ERC face used for my user mode prefix."
1176 :group 'erc-faces)
1177
1178 (defface erc-direct-msg-face '((t :foreground "IndianRed"))
1179 "ERC face used for messages you receive in the main erc buffer."
1180 :group 'erc-faces)
1181
1182 (defface erc-header-line
1183 '((t :foreground "grey20" :background "grey90"))
1184 "ERC face used for the header line.
1185
1186 This will only be used if `erc-header-line-face-method' is non-nil."
1187 :group 'erc-faces)
1188
1189 (defface erc-input-face '((t :foreground "brown"))
1190 "ERC face used for your input."
1191 :group 'erc-faces)
1192
1193 (defface erc-prompt-face
1194 '((t :weight bold :foreground "Black" :background "lightBlue2"))
1195 "ERC face for the prompt."
1196 :group 'erc-faces)
1197
1198 (defface erc-command-indicator-face
1199 '((t :weight bold))
1200 "ERC face for the command indicator.
1201 See the variable `erc-command-indicator'."
1202 :group 'erc-faces)
1203
1204 (defface erc-notice-face
1205 '((default :weight bold)
1206 (((class color) (min-colors 88)) :foreground "SlateBlue")
1207 (t :foreground "blue"))
1208 "ERC face for notices."
1209 :group 'erc-faces)
1210
1211 (defface erc-action-face '((t :weight bold))
1212 "ERC face for actions generated by /ME."
1213 :group 'erc-faces)
1214
1215 (defface erc-error-face '((t :foreground "red"))
1216 "ERC face for errors."
1217 :group 'erc-faces)
1218
1219 ;; same default color as `erc-input-face'
1220 (defface erc-my-nick-face '((t :weight bold :foreground "brown"))
1221 "ERC face for your current nickname in messages sent by you.
1222 See also `erc-show-my-nick'."
1223 :group 'erc-faces)
1224
1225 (defface erc-nick-default-face '((t :weight bold))
1226 "ERC nickname default face."
1227 :group 'erc-faces)
1228
1229 (defface erc-nick-msg-face '((t :weight bold :foreground "IndianRed"))
1230 "ERC nickname face for private messages."
1231 :group 'erc-faces)
1232
1233 ;; Debugging support
1234
1235 (defvar erc-log-p nil
1236 "When set to t, generate debug messages in a separate debug buffer.")
1237
1238 (defvar erc-debug-log-file (expand-file-name "ERC.debug")
1239 "Debug log file name.")
1240
1241 (defvar erc-dbuf nil)
1242 (make-variable-buffer-local 'erc-dbuf)
1243
1244 (defmacro define-erc-module (name alias doc enable-body disable-body
1245 &optional local-p)
1246 "Define a new minor mode using ERC conventions.
1247 Symbol NAME is the name of the module.
1248 Symbol ALIAS is the alias to use, or nil.
1249 DOC is the documentation string to use for the minor mode.
1250 ENABLE-BODY is a list of expressions used to enable the mode.
1251 DISABLE-BODY is a list of expressions used to disable the mode.
1252 If LOCAL-P is non-nil, the mode will be created as a buffer-local
1253 mode, rather than a global one.
1254
1255 This will define a minor mode called erc-NAME-mode, possibly
1256 an alias erc-ALIAS-mode, as well as the helper functions
1257 erc-NAME-enable, and erc-NAME-disable.
1258
1259 Example:
1260
1261 ;;;###autoload (autoload \\='erc-replace-mode \"erc-replace\")
1262 (define-erc-module replace nil
1263 \"This mode replaces incoming text according to `erc-replace-alist'.\"
1264 ((add-hook \\='erc-insert-modify-hook
1265 \\='erc-replace-insert))
1266 ((remove-hook \\='erc-insert-modify-hook
1267 \\='erc-replace-insert)))"
1268 (declare (doc-string 3))
1269 (let* ((sn (symbol-name name))
1270 (mode (intern (format "erc-%s-mode" (downcase sn))))
1271 (group (intern (format "erc-%s" (downcase sn))))
1272 (enable (intern (format "erc-%s-enable" (downcase sn))))
1273 (disable (intern (format "erc-%s-disable" (downcase sn)))))
1274 `(progn
1275 (erc-define-minor-mode
1276 ,mode
1277 ,(format "Toggle ERC %S mode.
1278 With a prefix argument ARG, enable %s if ARG is positive,
1279 and disable it otherwise. If called from Lisp, enable the mode
1280 if ARG is omitted or nil.
1281 %s" name name doc)
1282 nil nil nil
1283 :global ,(not local-p) :group (quote ,group)
1284 (if ,mode
1285 (,enable)
1286 (,disable)))
1287 (defun ,enable ()
1288 ,(format "Enable ERC %S mode."
1289 name)
1290 (interactive)
1291 (add-to-list 'erc-modules (quote ,name))
1292 (setq ,mode t)
1293 ,@enable-body)
1294 (defun ,disable ()
1295 ,(format "Disable ERC %S mode."
1296 name)
1297 (interactive)
1298 (setq erc-modules (delq (quote ,name) erc-modules))
1299 (setq ,mode nil)
1300 ,@disable-body)
1301 ,(when (and alias (not (eq name alias)))
1302 `(defalias
1303 (quote
1304 ,(intern
1305 (format "erc-%s-mode"
1306 (downcase (symbol-name alias)))))
1307 (quote
1308 ,mode)))
1309 ;; For find-function and find-variable.
1310 (put ',mode 'definition-name ',name)
1311 (put ',enable 'definition-name ',name)
1312 (put ',disable 'definition-name ',name))))
1313
1314 (defun erc-once-with-server-event (event f)
1315 "Run function F the next time EVENT occurs in the `current-buffer'.
1316
1317 You should make sure that `current-buffer' is a server buffer.
1318
1319 This function temporarily adds a function to EVENT's hook to call F with
1320 two arguments (`proc' and `parsed'). After F is called, the function is
1321 removed from EVENT's hook. F should return either nil
1322 or t, where nil indicates that the other functions on EVENT's hook
1323 should be run too, and t indicates that other functions should
1324 not be run.
1325
1326 Please be sure to use this function in server-buffers. In
1327 channel-buffers it may not work at all, as it uses the LOCAL
1328 argument of `add-hook' and `remove-hook' to ensure multiserver
1329 capabilities."
1330 (unless (erc-server-buffer-p)
1331 (error
1332 "You should only run `erc-once-with-server-event' in a server buffer"))
1333 (let ((fun (make-symbol "fun"))
1334 (hook (erc-get-hook event)))
1335 (put fun 'erc-original-buffer (current-buffer))
1336 (fset fun (lambda (proc parsed)
1337 (with-current-buffer (get fun 'erc-original-buffer)
1338 (remove-hook hook fun t))
1339 (fmakunbound fun)
1340 (funcall f proc parsed)))
1341 (add-hook hook fun nil t)
1342 fun))
1343
1344 (defsubst erc-log (string)
1345 "Logs STRING if logging is on (see `erc-log-p')."
1346 (when erc-log-p
1347 (erc-log-aux string)))
1348
1349 (defun erc-server-buffer ()
1350 "Return the server buffer for the current buffer's process.
1351 The buffer-local variable `erc-server-process' is used to find
1352 the process buffer."
1353 (and (erc-server-buffer-live-p)
1354 (process-buffer erc-server-process)))
1355
1356 (defun erc-server-buffer-live-p ()
1357 "Return t if the server buffer has not been killed."
1358 (and (processp erc-server-process)
1359 (buffer-live-p (process-buffer erc-server-process))))
1360
1361 (defun erc-server-buffer-p (&optional buffer)
1362 "Return non-nil if argument BUFFER is an ERC server buffer.
1363
1364 If BUFFER is nil, the current buffer is used."
1365 (with-current-buffer (or buffer (current-buffer))
1366 (and (eq major-mode 'erc-mode)
1367 (null (erc-default-target)))))
1368
1369 (defun erc-open-server-buffer-p (&optional buffer)
1370 "Return non-nil if argument BUFFER is an ERC server buffer that
1371 has an open IRC process.
1372
1373 If BUFFER is nil, the current buffer is used."
1374 (and (erc-server-buffer-p buffer)
1375 (erc-server-process-alive buffer)))
1376
1377 (defun erc-query-buffer-p (&optional buffer)
1378 "Return non-nil if BUFFER is an ERC query buffer.
1379 If BUFFER is nil, the current buffer is used."
1380 (with-current-buffer (or buffer (current-buffer))
1381 (let ((target (erc-default-target)))
1382 (and (eq major-mode 'erc-mode)
1383 target
1384 (not (memq (aref target 0) '(?# ?& ?+ ?!)))))))
1385
1386 (defun erc-ison-p (nick)
1387 "Return non-nil if NICK is online."
1388 (interactive "sNick: ")
1389 (erc-with-server-buffer
1390 (let ((erc-online-p 'unknown))
1391 (erc-once-with-server-event
1392 303
1393 (lambda (_proc parsed)
1394 (let ((ison (split-string (aref parsed 3))))
1395 (setq erc-online-p (car (erc-member-ignore-case nick ison)))
1396 t)))
1397 (erc-server-send (format "ISON %s" nick))
1398 (while (eq erc-online-p 'unknown) (accept-process-output))
1399 (if (called-interactively-p 'interactive)
1400 (message "%s is %sonline"
1401 (or erc-online-p nick)
1402 (if erc-online-p "" "not "))
1403 erc-online-p))))
1404
1405 (defun erc-log-aux (string)
1406 "Do the debug logging of STRING."
1407 (let ((cb (current-buffer))
1408 (point 1)
1409 (was-eob nil)
1410 (session-buffer (erc-server-buffer)))
1411 (if session-buffer
1412 (progn
1413 (set-buffer session-buffer)
1414 (if (not (and erc-dbuf (bufferp erc-dbuf) (buffer-live-p erc-dbuf)))
1415 (progn
1416 (setq erc-dbuf (get-buffer-create
1417 (concat "*ERC-DEBUG: "
1418 erc-session-server "*")))))
1419 (set-buffer erc-dbuf)
1420 (setq point (point))
1421 (setq was-eob (eobp))
1422 (goto-char (point-max))
1423 (insert (concat "** " string "\n"))
1424 (if was-eob (goto-char (point-max))
1425 (goto-char point))
1426 (set-buffer cb))
1427 (message "ERC: ** %s" string))))
1428
1429 ;; Last active buffer, to print server messages in the right place
1430
1431 (defvar erc-active-buffer nil
1432 "The current active buffer, the one where the user typed the last command.
1433 Defaults to the server buffer, and should only be set in the
1434 server buffer.")
1435 (make-variable-buffer-local 'erc-active-buffer)
1436
1437 (defun erc-active-buffer ()
1438 "Return the value of `erc-active-buffer' for the current server.
1439 Defaults to the server buffer."
1440 (erc-with-server-buffer
1441 (if (buffer-live-p erc-active-buffer)
1442 erc-active-buffer
1443 (setq erc-active-buffer (current-buffer)))))
1444
1445 (defun erc-set-active-buffer (buffer)
1446 "Set the value of `erc-active-buffer' to BUFFER."
1447 (cond ((erc-server-buffer)
1448 (with-current-buffer (erc-server-buffer)
1449 (setq erc-active-buffer buffer)))
1450 (t (setq erc-active-buffer buffer))))
1451
1452 ;; Mode activation routines
1453
1454 (define-derived-mode erc-mode fundamental-mode "ERC"
1455 "Major mode for Emacs IRC."
1456 (setq local-abbrev-table erc-mode-abbrev-table)
1457 (when (boundp 'next-line-add-newlines)
1458 (set (make-local-variable 'next-line-add-newlines) nil))
1459 (setq line-move-ignore-invisible t)
1460 (set (make-local-variable 'paragraph-separate)
1461 (concat "\C-l\\|\\(^" (regexp-quote (erc-prompt)) "\\)"))
1462 (set (make-local-variable 'paragraph-start)
1463 (concat "\\(" (regexp-quote (erc-prompt)) "\\)"))
1464 (add-hook 'completion-at-point-functions 'erc-complete-word-at-point nil t))
1465
1466 ;; activation
1467
1468 (defconst erc-default-server "irc.freenode.net"
1469 "IRC server to use if it cannot be detected otherwise.")
1470
1471 (defconst erc-default-port 6667
1472 "IRC port to use if it cannot be detected otherwise.")
1473
1474 (defcustom erc-join-buffer 'buffer
1475 "Determines how to display a newly created IRC buffer.
1476
1477 The available choices are:
1478
1479 `window' - in another window,
1480 `window-noselect' - in another window, but don't select that one,
1481 `frame' - in another frame,
1482 `bury' - bury it in a new buffer,
1483 `buffer' - in place of the current buffer,
1484 any other value - in place of the current buffer."
1485 :group 'erc-buffers
1486 :type '(choice (const :tag "Split window and select" window)
1487 (const :tag "Split window, don't select" window-noselect)
1488 (const :tag "New frame" frame)
1489 (const :tag "Bury in new buffer" bury)
1490 (const :tag "Use current buffer" buffer)
1491 (const :tag "Use current buffer" t)))
1492
1493 (defcustom erc-frame-alist nil
1494 "Alist of frame parameters for creating erc frames.
1495 A value of nil means to use `default-frame-alist'."
1496 :group 'erc-buffers
1497 :type '(repeat (cons :format "%v"
1498 (symbol :tag "Parameter")
1499 (sexp :tag "Value"))))
1500
1501 (defcustom erc-frame-dedicated-flag nil
1502 "Non-nil means the erc frames are dedicated to that buffer.
1503 This only has effect when `erc-join-buffer' is set to `frame'."
1504 :group 'erc-buffers
1505 :type 'boolean)
1506
1507 (defcustom erc-reuse-frames t
1508 "Determines whether new frames are always created.
1509 Non-nil means that a new frame is not created to display an ERC
1510 buffer if there is already a window displaying it. This only has
1511 effect when `erc-join-buffer' is set to `frame'."
1512 :group 'erc-buffers
1513 :type 'boolean)
1514
1515 (defun erc-channel-p (channel)
1516 "Return non-nil if CHANNEL seems to be an IRC channel name."
1517 (cond ((stringp channel)
1518 (memq (aref channel 0) '(?# ?& ?+ ?!)))
1519 ((and (bufferp channel) (buffer-live-p channel))
1520 (with-current-buffer channel
1521 (erc-channel-p (erc-default-target))))
1522 (t nil)))
1523
1524 (defcustom erc-reuse-buffers t
1525 "If nil, create new buffers on joining a channel/query.
1526 If non-nil, a new buffer will only be created when you join
1527 channels with same names on different servers, or have query buffers
1528 open with nicks of the same name on different servers. Otherwise,
1529 the existing buffers will be reused."
1530 :group 'erc-buffers
1531 :type 'boolean)
1532
1533 (defun erc-normalize-port (port)
1534 "Normalize the port specification PORT to integer form.
1535 PORT may be an integer, a string or a symbol. If it is a string or a
1536 symbol, it may have these values:
1537 * irc -> 194
1538 * ircs -> 994
1539 * ircd -> 6667
1540 * ircd-dalnet -> 7000"
1541 (cond
1542 ((symbolp port)
1543 (erc-normalize-port (symbol-name port)))
1544 ((stringp port)
1545 (let ((port-nr (string-to-number port)))
1546 (cond
1547 ((> port-nr 0)
1548 port-nr)
1549 ((string-equal port "irc")
1550 194)
1551 ((string-equal port "ircs")
1552 994)
1553 ((string-equal port "ircd")
1554 6667)
1555 ((string-equal port "ircd-dalnet")
1556 7000)
1557 (t
1558 nil))))
1559 ((numberp port)
1560 port)
1561 (t
1562 nil)))
1563
1564 (defun erc-port-equal (a b)
1565 "Check whether ports A and B are equal."
1566 (= (erc-normalize-port a) (erc-normalize-port b)))
1567
1568 (defun erc-generate-new-buffer-name (server port target)
1569 "Create a new buffer name based on the arguments."
1570 (when (numberp port) (setq port (number-to-string port)))
1571 (let ((buf-name (or target
1572 (or (let ((name (concat server ":" port)))
1573 (when (> (length name) 1)
1574 name))
1575 ;; This fallback should in fact never happen
1576 "*erc-server-buffer*")))
1577 buffer-name)
1578 ;; Reuse existing buffers, but not if the buffer is a connected server
1579 ;; buffer and not if its associated with a different server than the
1580 ;; current ERC buffer.
1581 ;; if buf-name is taken by a different connection (or by something !erc)
1582 ;; then see if "buf-name/server" meets the same criteria
1583 (dolist (candidate (list buf-name (concat buf-name "/" server)))
1584 (if (and (not buffer-name)
1585 erc-reuse-buffers
1586 (get-buffer candidate)
1587 (or target
1588 (with-current-buffer (get-buffer candidate)
1589 (and (erc-server-buffer-p)
1590 (not (erc-server-process-alive)))))
1591 (with-current-buffer (get-buffer candidate)
1592 (and (string= erc-session-server server)
1593 (erc-port-equal erc-session-port port))))
1594 (setq buffer-name candidate)))
1595 ;; if buffer-name is unset, neither candidate worked out for us,
1596 ;; fallback to the old <N> uniquification method:
1597 (or buffer-name (generate-new-buffer-name buf-name)) ))
1598
1599 (defun erc-get-buffer-create (server port target)
1600 "Create a new buffer based on the arguments."
1601 (get-buffer-create (erc-generate-new-buffer-name server port target)))
1602
1603
1604 (defun erc-member-ignore-case (string list)
1605 "Return non-nil if STRING is a member of LIST.
1606
1607 All strings are compared according to IRC protocol case rules, see
1608 `erc-downcase'."
1609 (setq string (erc-downcase string))
1610 (catch 'result
1611 (while list
1612 (if (string= string (erc-downcase (car list)))
1613 (throw 'result list)
1614 (setq list (cdr list))))))
1615
1616 (defmacro erc-with-buffer (spec &rest body)
1617 "Execute BODY in the buffer associated with SPEC.
1618
1619 SPEC should have the form
1620
1621 (TARGET [PROCESS])
1622
1623 If TARGET is a buffer, use it. Otherwise, use the buffer
1624 matching TARGET in the process specified by PROCESS.
1625
1626 If PROCESS is nil, use the current `erc-server-process'.
1627 See `erc-get-buffer' for details.
1628
1629 See also `with-current-buffer'.
1630
1631 \(fn (TARGET [PROCESS]) BODY...)"
1632 (declare (indent 1) (debug ((form &optional form) body)))
1633 (let ((buf (make-symbol "buf"))
1634 (proc (make-symbol "proc"))
1635 (target (make-symbol "target"))
1636 (process (make-symbol "process")))
1637 `(let* ((,target ,(car spec))
1638 (,process ,(cadr spec))
1639 (,buf (if (bufferp ,target)
1640 ,target
1641 (let ((,proc (or ,process
1642 (and (processp erc-server-process)
1643 erc-server-process))))
1644 (if (and ,target ,proc)
1645 (erc-get-buffer ,target ,proc))))))
1646 (when (buffer-live-p ,buf)
1647 (with-current-buffer ,buf
1648 ,@body)))))
1649
1650 (defun erc-get-buffer (target &optional proc)
1651 "Return the buffer matching TARGET in the process PROC.
1652 If PROC is not supplied, all processes are searched."
1653 (let ((downcased-target (erc-downcase target)))
1654 (catch 'buffer
1655 (erc-buffer-filter
1656 (lambda ()
1657 (let ((current (erc-default-target)))
1658 (and (stringp current)
1659 (string-equal downcased-target (erc-downcase current))
1660 (throw 'buffer (current-buffer)))))
1661 proc))))
1662
1663 (defun erc--buffer-p (buf predicate proc)
1664 (with-current-buffer buf
1665 (and (derived-mode-p 'erc-mode)
1666 (or (not proc)
1667 (eq proc erc-server-process))
1668 (funcall predicate)
1669 buf)))
1670
1671 (defun erc-buffer-filter (predicate &optional proc)
1672 "Return a list of `erc-mode' buffers matching certain criteria.
1673 PREDICATE is a function executed with each buffer, if it returns t, that buffer
1674 is considered a valid match.
1675
1676 PROC is either an `erc-server-process', identifying a certain
1677 server connection, or nil which means all open connections."
1678 (save-excursion
1679 (delq
1680 nil
1681 (mapcar (lambda (buf)
1682 (when (buffer-live-p buf)
1683 (erc--buffer-p buf predicate proc)))
1684 (buffer-list)))))
1685
1686 (defun erc-buffer-list (&optional predicate proc)
1687 "Return a list of ERC buffers.
1688 PREDICATE is a function which executes with every buffer satisfying
1689 the predicate. If PREDICATE is passed as nil, return a list of all ERC
1690 buffers. If PROC is given, the buffers local variable `erc-server-process'
1691 needs to match PROC."
1692 (unless predicate
1693 (setq predicate (lambda () t)))
1694 (erc-buffer-filter predicate proc))
1695
1696 (defmacro erc-with-all-buffers-of-server (process pred &rest forms)
1697 "Execute FORMS in all buffers which have same process as this server.
1698 FORMS will be evaluated in all buffers having the process PROCESS and
1699 where PRED matches or in all buffers of the server process if PRED is
1700 nil."
1701 (declare (indent 1) (debug (form form body)))
1702 ;; Make the evaluation have the correct order
1703 (let ((pre (make-symbol "pre"))
1704 (pro (make-symbol "pro")))
1705 `(let* ((,pro ,process)
1706 (,pre ,pred)
1707 (res (mapcar (lambda (buffer)
1708 (with-current-buffer buffer
1709 ,@forms))
1710 (erc-buffer-list ,pre
1711 ,pro))))
1712 ;; Silence the byte-compiler by binding the result of mapcar to
1713 ;; a variable.
1714 (ignore res)
1715 res)))
1716
1717 (define-obsolete-function-alias 'erc-iswitchb 'erc-switch-to-buffer "25.1")
1718 (defun erc-switch-to-buffer (&optional arg)
1719 "Prompt for a ERC buffer to switch to.
1720 When invoked with prefix argument, use all erc buffers. Without prefix
1721 ARG, allow only buffers related to same session server.
1722 If `erc-track-mode' is in enabled, put the last element of
1723 `erc-modified-channels-alist' in front of the buffer list."
1724 (interactive "P")
1725 (switch-to-buffer
1726 (read-buffer "Switch to ERC buffer: "
1727 (when (boundp 'erc-modified-channels-alist)
1728 (buffer-name (caar (last erc-modified-channels-alist))))
1729 t
1730 ;; Only allow ERC buffers in the same session.
1731 (let ((proc (unless arg erc-server-process)))
1732 (lambda (bufname)
1733 (let ((buf (if (consp bufname)
1734 (cdr bufname) (get-buffer bufname))))
1735 (when buf
1736 (erc--buffer-p buf (lambda () t) proc)
1737 (with-current-buffer buf
1738 (and (derived-mode-p 'erc-mode)
1739 (or (null proc)
1740 (eq proc erc-server-process)))))))))))
1741
1742 (defun erc-channel-list (proc)
1743 "Return a list of channel buffers.
1744 PROC is the process for the server connection. If PROC is nil, return
1745 all channel buffers on all servers."
1746 (erc-buffer-filter
1747 (lambda ()
1748 (and (erc-default-target)
1749 (erc-channel-p (erc-default-target))))
1750 proc))
1751
1752 (defun erc-buffer-list-with-nick (nick proc)
1753 "Return buffers containing NICK in the `erc-channel-users' list."
1754 (with-current-buffer (process-buffer proc)
1755 (let ((user (gethash (erc-downcase nick) erc-server-users)))
1756 (if user
1757 (erc-server-user-buffers user)
1758 nil))))
1759
1760 ;; Some local variables
1761
1762 (defvar erc-default-recipients nil
1763 "List of default recipients of the current buffer.")
1764 (make-variable-buffer-local 'erc-default-recipients)
1765
1766 (defvar erc-session-user-full-name nil
1767 "Full name of the user on the current server.")
1768 (make-variable-buffer-local 'erc-session-user-full-name)
1769
1770 (defvar erc-channel-user-limit nil
1771 "Limit of users per channel.")
1772 (make-variable-buffer-local 'erc-channel-user-limit)
1773
1774 (defvar erc-channel-key nil
1775 "Key needed to join channel.")
1776 (make-variable-buffer-local 'erc-channel-key)
1777
1778 (defvar erc-invitation nil
1779 "Last invitation channel.")
1780 (make-variable-buffer-local 'erc-invitation)
1781
1782 (defvar erc-away nil
1783 "Non-nil indicates that we are away.
1784
1785 Use `erc-away-time' to access this if you might be in a channel
1786 buffer rather than a server buffer.")
1787 (make-variable-buffer-local 'erc-away)
1788
1789 (defvar erc-channel-list nil
1790 "Server channel list.")
1791 (make-variable-buffer-local 'erc-channel-list)
1792
1793 (defvar erc-bad-nick nil
1794 "Non-nil indicates that we got a `nick in use' error while connecting.")
1795 (make-variable-buffer-local 'erc-bad-nick)
1796
1797 (defvar erc-logged-in nil
1798 "Non-nil indicates that we are logged in.")
1799 (make-variable-buffer-local 'erc-logged-in)
1800
1801 (defvar erc-default-nicks nil
1802 "The local copy of `erc-nick' - the list of nicks to choose from.")
1803 (make-variable-buffer-local 'erc-default-nicks)
1804
1805 (defvar erc-nick-change-attempt-count 0
1806 "Used to keep track of how many times an attempt at changing nick is made.")
1807 (make-variable-buffer-local 'erc-nick-change-attempt-count)
1808
1809 (defun erc-migrate-modules (mods)
1810 "Migrate old names of ERC modules to new ones."
1811 ;; modify `transforms' to specify what needs to be changed
1812 ;; each item is in the format '(old . new)
1813 (let ((transforms '((pcomplete . completion))))
1814 (erc-delete-dups
1815 (mapcar (lambda (m) (or (cdr (assoc m transforms)) m))
1816 mods))))
1817
1818 (defcustom erc-modules '(netsplit fill button match track completion readonly
1819 networks ring autojoin noncommands irccontrols
1820 move-to-prompt stamp menu list)
1821 "A list of modules which ERC should enable.
1822 If you set the value of this without using `customize' remember to call
1823 \(erc-update-modules) after you change it. When using `customize', modules
1824 removed from the list will be disabled."
1825 :get (lambda (sym)
1826 ;; replace outdated names with their newer equivalents
1827 (erc-migrate-modules (symbol-value sym)))
1828 :set (lambda (sym val)
1829 ;; disable modules which have just been removed
1830 (when (and (boundp 'erc-modules) erc-modules val)
1831 (dolist (module erc-modules)
1832 (unless (member module val)
1833 (let ((f (intern-soft (format "erc-%s-mode" module))))
1834 (when (and (fboundp f) (boundp f) (symbol-value f))
1835 (message "Disabling `erc-%s'" module)
1836 (funcall f 0))))))
1837 (set sym val)
1838 ;; this test is for the case where erc hasn't been loaded yet
1839 (when (fboundp 'erc-update-modules)
1840 (erc-update-modules)))
1841 :type
1842 '(set
1843 :greedy t
1844 (const :tag "autoaway: Set away status automatically" autoaway)
1845 (const :tag "autojoin: Join channels automatically" autojoin)
1846 (const :tag "button: Buttonize URLs, nicknames, and other text" button)
1847 (const :tag "capab: Mark unidentified users on servers supporting CAPAB"
1848 capab-identify)
1849 (const :tag "completion: Complete nicknames and commands (programmable)"
1850 completion)
1851 (const :tag "hecomplete: Complete nicknames and commands (obsolete, use \"completion\")" hecomplete)
1852 (const :tag "dcc: Provide Direct Client-to-Client support" dcc)
1853 (const :tag "fill: Wrap long lines" fill)
1854 (const :tag "identd: Launch an identd server on port 8113" identd)
1855 (const :tag "irccontrols: Highlight or remove IRC control characters"
1856 irccontrols)
1857 (const :tag "keep-place: Leave point above un-viewed text" keep-place)
1858 (const :tag "list: List channels in a separate buffer" list)
1859 (const :tag "log: Save buffers in logs" log)
1860 (const :tag "match: Highlight pals, fools, and other keywords" match)
1861 (const :tag "menu: Display a menu in ERC buffers" menu)
1862 (const :tag "move-to-prompt: Move to the prompt when typing text"
1863 move-to-prompt)
1864 (const :tag "netsplit: Detect netsplits" netsplit)
1865 (const :tag "networks: Provide data about IRC networks" networks)
1866 (const :tag "noncommands: Don't display non-IRC commands after evaluation"
1867 noncommands)
1868 (const :tag
1869 "notify: Notify when the online status of certain users changes"
1870 notify)
1871 (const :tag "notifications: Send notifications on PRIVMSG or nickname mentions"
1872 notifications)
1873 (const :tag "page: Process CTCP PAGE requests from IRC" page)
1874 (const :tag "readonly: Make displayed lines read-only" readonly)
1875 (const :tag "replace: Replace text in messages" replace)
1876 (const :tag "ring: Enable an input history" ring)
1877 (const :tag "scrolltobottom: Scroll to the bottom of the buffer"
1878 scrolltobottom)
1879 (const :tag "services: Identify to Nickserv (IRC Services) automatically"
1880 services)
1881 (const :tag "smiley: Convert smileys to pretty icons" smiley)
1882 (const :tag "sound: Play sounds when you receive CTCP SOUND requests"
1883 sound)
1884 (const :tag "stamp: Add timestamps to messages" stamp)
1885 (const :tag "spelling: Check spelling" spelling)
1886 (const :tag "track: Track channel activity in the mode-line" track)
1887 (const :tag "truncate: Truncate buffers to a certain size" truncate)
1888 (const :tag "unmorse: Translate morse code in messages" unmorse)
1889 (const :tag "xdcc: Act as an XDCC file-server" xdcc)
1890 (repeat :tag "Others" :inline t symbol))
1891 :group 'erc)
1892
1893 (defun erc-update-modules ()
1894 "Run this to enable erc-foo-mode for all modules in `erc-modules'."
1895 (let (req)
1896 (dolist (mod erc-modules)
1897 (setq req (concat "erc-" (symbol-name mod)))
1898 (cond
1899 ;; yuck. perhaps we should bring the filenames into sync?
1900 ((string= req "erc-capab-identify")
1901 (setq req "erc-capab"))
1902 ((string= req "erc-completion")
1903 (setq req "erc-pcomplete"))
1904 ((string= req "erc-pcomplete")
1905 (setq mod 'completion))
1906 ((string= req "erc-autojoin")
1907 (setq req "erc-join")))
1908 (condition-case nil
1909 (require (intern req))
1910 (error nil))
1911 (let ((sym (intern-soft (concat "erc-" (symbol-name mod) "-mode"))))
1912 (if (fboundp sym)
1913 (funcall sym 1)
1914 (error "`%s' is not a known ERC module" mod))))))
1915
1916 (defun erc-setup-buffer (buffer)
1917 "Consults `erc-join-buffer' to find out how to display `BUFFER'."
1918 (pcase erc-join-buffer
1919 (`window
1920 (if (active-minibuffer-window)
1921 (display-buffer buffer)
1922 (switch-to-buffer-other-window buffer)))
1923 (`window-noselect
1924 (display-buffer buffer))
1925 (`bury
1926 nil)
1927 (`frame
1928 (when (or (not erc-reuse-frames)
1929 (not (get-buffer-window buffer t)))
1930 (let ((frame (make-frame (or erc-frame-alist
1931 default-frame-alist))))
1932 (raise-frame frame)
1933 (select-frame frame))
1934 (switch-to-buffer buffer)
1935 (when erc-frame-dedicated-flag
1936 (set-window-dedicated-p (selected-window) t))))
1937 (_
1938 (if (active-minibuffer-window)
1939 (display-buffer buffer)
1940 (switch-to-buffer buffer)))))
1941
1942 (defun erc-open (&optional server port nick full-name
1943 connect passwd tgt-list channel process)
1944 "Connect to SERVER on PORT as NICK with FULL-NAME.
1945
1946 If CONNECT is non-nil, connect to the server. Otherwise assume
1947 already connected and just create a separate buffer for the new
1948 target CHANNEL.
1949
1950 Use PASSWD as user password on the server. If TGT-LIST is
1951 non-nil, use it to initialize `erc-default-recipients'.
1952
1953 Returns the buffer for the given server or channel."
1954 (let ((server-announced-name (when (and (boundp 'erc-session-server)
1955 (string= server erc-session-server))
1956 erc-server-announced-name))
1957 (connected-p (unless connect erc-server-connected))
1958 (buffer (erc-get-buffer-create server port channel))
1959 (old-buffer (current-buffer))
1960 old-point
1961 continued-session)
1962 (when connect (run-hook-with-args 'erc-before-connect server port nick))
1963 (erc-update-modules)
1964 (set-buffer buffer)
1965 (setq old-point (point))
1966 (let ((old-recon-count erc-server-reconnect-count))
1967 (erc-mode)
1968 (setq erc-server-reconnect-count old-recon-count))
1969 (setq erc-server-announced-name server-announced-name)
1970 (setq erc-server-connected connected-p)
1971 ;; connection parameters
1972 (setq erc-server-process process)
1973 (setq erc-insert-marker (make-marker))
1974 (setq erc-input-marker (make-marker))
1975 ;; go to the end of the buffer and open a new line
1976 ;; (the buffer may have existed)
1977 (goto-char (point-max))
1978 (forward-line 0)
1979 (when (get-text-property (point) 'erc-prompt)
1980 (setq continued-session t)
1981 (set-marker erc-input-marker
1982 (or (next-single-property-change (point) 'erc-prompt)
1983 (point-max))))
1984 (unless continued-session
1985 (goto-char (point-max))
1986 (insert "\n"))
1987 (set-marker erc-insert-marker (point))
1988 ;; stack of default recipients
1989 (setq erc-default-recipients tgt-list)
1990 (setq erc-server-current-nick nil)
1991 ;; Initialize erc-server-users and erc-channel-users
1992 (if connect
1993 (progn ;; server buffer
1994 (setq erc-server-users
1995 (make-hash-table :test 'equal))
1996 (setq erc-channel-users nil))
1997 (progn ;; target buffer
1998 (setq erc-server-users nil)
1999 (setq erc-channel-users
2000 (make-hash-table :test 'equal))))
2001 ;; clear last incomplete line read
2002 (setq erc-server-filter-data nil)
2003 (setq erc-channel-topic "")
2004 ;; limit on the number of users on the channel (mode +l)
2005 (setq erc-channel-user-limit nil)
2006 (setq erc-channel-key nil)
2007 ;; last active buffer, defaults to this one
2008 (erc-set-active-buffer buffer)
2009 ;; last invitation channel
2010 (setq erc-invitation nil)
2011 ;; Server channel list
2012 (setq erc-channel-list ())
2013 ;; login-time 'nick in use' error
2014 (setq erc-bad-nick nil)
2015 ;; whether we have logged in
2016 (setq erc-logged-in nil)
2017 ;; The local copy of `erc-nick' - the list of nicks to choose
2018 (setq erc-default-nicks (if (consp erc-nick) erc-nick (list erc-nick)))
2019 ;; password stuff
2020 (setq erc-session-password
2021 (or passwd
2022 (let ((secret
2023 (plist-get
2024 (nth 0
2025 (auth-source-search :host server
2026 :max 1
2027 :user nick
2028 :port port
2029 :require '(:secret)))
2030 :secret)))
2031 (if (functionp secret)
2032 (funcall secret)
2033 secret))))
2034 ;; debug output buffer
2035 (setq erc-dbuf
2036 (when erc-log-p
2037 (get-buffer-create (concat "*ERC-DEBUG: " server "*"))))
2038 ;; set up prompt
2039 (unless continued-session
2040 (goto-char (point-max))
2041 (insert "\n"))
2042 (if continued-session
2043 (goto-char old-point)
2044 (set-marker erc-insert-marker (point))
2045 (erc-display-prompt)
2046 (goto-char (point-max)))
2047
2048 (erc-determine-parameters server port nick full-name)
2049
2050 ;; Saving log file on exit
2051 (run-hook-with-args 'erc-connect-pre-hook buffer)
2052
2053 (when connect
2054 (erc-server-connect erc-session-server erc-session-port buffer))
2055 (erc-update-mode-line)
2056
2057 ;; Now display the buffer in a window as per user wishes.
2058 (unless (eq buffer old-buffer)
2059 (when erc-log-p
2060 ;; we can't log to debug buffer, it may not exist yet
2061 (message "erc: old buffer %s, switching to %s"
2062 old-buffer buffer))
2063 (erc-setup-buffer buffer))
2064
2065 buffer))
2066
2067 (defun erc-initialize-log-marker (buffer)
2068 "Initialize the `erc-last-saved-position' marker to a sensible position.
2069 BUFFER is the current buffer."
2070 (with-current-buffer buffer
2071 (unless (markerp erc-last-saved-position)
2072 (setq erc-last-saved-position (make-marker))
2073 (move-marker erc-last-saved-position
2074 (1- (marker-position erc-insert-marker))))))
2075
2076 ;; interactive startup
2077
2078 (defvar erc-server-history-list nil
2079 "IRC server interactive selection history list.")
2080
2081 (defvar erc-nick-history-list nil
2082 "Nickname interactive selection history list.")
2083
2084 (defun erc-already-logged-in (server port nick)
2085 "Return the buffers corresponding to a NICK on PORT of a session SERVER.
2086 This is determined by looking for the appropriate buffer and checking
2087 whether the connection is still alive.
2088 If no buffer matches, return nil."
2089 (erc-buffer-list
2090 (lambda ()
2091 (and (erc-server-process-alive)
2092 (string= erc-session-server server)
2093 (erc-port-equal erc-session-port port)
2094 (erc-current-nick-p nick)))))
2095
2096 (defcustom erc-before-connect nil
2097 "Hook called before connecting to a server.
2098 This hook gets executed before `erc' actually invokes `erc-mode'
2099 with your input data. The functions in here get called with three
2100 parameters, SERVER, PORT and NICK."
2101 :group 'erc-hooks
2102 :type 'hook)
2103
2104 (defcustom erc-after-connect nil
2105 "Hook called after connecting to a server.
2106 This hook gets executed when an end of MOTD has been received. All
2107 functions in here get called with the parameters SERVER and NICK."
2108 :group 'erc-hooks
2109 :type 'hook)
2110
2111 ;;;###autoload
2112 (defun erc-select-read-args ()
2113 "Prompt the user for values of nick, server, port, and password."
2114 (let (user-input server port nick passwd)
2115 (setq user-input (read-from-minibuffer
2116 "IRC server: "
2117 (erc-compute-server) nil nil 'erc-server-history-list))
2118
2119 (if (string-match "\\(.*\\):\\(.*\\)\\'" user-input)
2120 (setq port (erc-string-to-port (match-string 2 user-input))
2121 user-input (match-string 1 user-input))
2122 (setq port
2123 (erc-string-to-port (read-from-minibuffer
2124 "IRC port: " (erc-port-to-string
2125 (erc-compute-port))))))
2126
2127 (if (string-match "\\`\\(.*\\)@\\(.*\\)" user-input)
2128 (setq nick (match-string 1 user-input)
2129 user-input (match-string 2 user-input))
2130 (setq nick
2131 (if (erc-already-logged-in server port nick)
2132 (read-from-minibuffer
2133 (erc-format-message 'nick-in-use ?n nick)
2134 nick
2135 nil nil 'erc-nick-history-list)
2136 (read-from-minibuffer
2137 "Nickname: " (erc-compute-nick nick)
2138 nil nil 'erc-nick-history-list))))
2139
2140 (setq server user-input)
2141
2142 (setq passwd (if erc-prompt-for-password
2143 (if (and erc-password
2144 (y-or-n-p "Use the default password? "))
2145 erc-password
2146 (read-passwd "Password: "))
2147 erc-password))
2148 (when (and passwd (string= "" passwd))
2149 (setq passwd nil))
2150
2151 (while (erc-already-logged-in server port nick)
2152 ;; hmm, this is a problem when using multiple connections to a bnc
2153 ;; with the same nick. Currently this code prevents using more than one
2154 ;; bnc with the same nick. actually it would be nice to have
2155 ;; bncs transparent, so that erc-compute-buffer-name displays
2156 ;; the server one is connected to.
2157 (setq nick (read-from-minibuffer
2158 (erc-format-message 'nick-in-use ?n nick)
2159 nick
2160 nil nil 'erc-nick-history-list)))
2161 (list :server server :port port :nick nick :password passwd)))
2162
2163 ;;;###autoload
2164 (cl-defun erc (&key (server (erc-compute-server))
2165 (port (erc-compute-port))
2166 (nick (erc-compute-nick))
2167 password
2168 (full-name (erc-compute-full-name)))
2169 "ERC is a powerful, modular, and extensible IRC client.
2170 This function is the main entry point for ERC.
2171
2172 It permits you to select connection parameters, and then starts ERC.
2173
2174 Non-interactively, it takes the keyword arguments
2175 (server (erc-compute-server))
2176 (port (erc-compute-port))
2177 (nick (erc-compute-nick))
2178 password
2179 (full-name (erc-compute-full-name)))
2180
2181 That is, if called with
2182
2183 (erc :server \"irc.freenode.net\" :full-name \"Harry S Truman\")
2184
2185 then the server and full-name will be set to those values, whereas
2186 `erc-compute-port', `erc-compute-nick' and `erc-compute-full-name' will
2187 be invoked for the values of the other parameters."
2188 (interactive (erc-select-read-args))
2189 (erc-open server port nick full-name t password))
2190
2191 ;;;###autoload
2192 (defalias 'erc-select 'erc)
2193 (defalias 'erc-ssl 'erc-tls)
2194
2195 ;;;###autoload
2196 (defun erc-tls (&rest r)
2197 "Interactively select TLS connection parameters and run ERC.
2198 Arguments are the same as for `erc'."
2199 (interactive (erc-select-read-args))
2200 (let ((erc-server-connect-function 'erc-open-tls-stream))
2201 (apply #'erc r)))
2202
2203 (defun erc-open-tls-stream (name buffer host port)
2204 "Open an TLS stream to an IRC server.
2205 The process will be given the name NAME, its target buffer will be
2206 BUFFER. HOST and PORT specify the connection target."
2207 (open-network-stream name buffer host port
2208 :nowait t
2209 :type 'tls))
2210
2211 ;;; Displaying error messages
2212
2213 (defun erc-error (&rest args)
2214 "Pass ARGS to `format', and display the result as an error message.
2215 If `debug-on-error' is set to non-nil, then throw a real error with this
2216 message instead, to make debugging easier."
2217 (if debug-on-error
2218 (apply #'error args)
2219 (apply #'message args)
2220 (beep)))
2221
2222 ;;; Debugging the protocol
2223
2224 (defvar erc-debug-irc-protocol nil
2225 "If non-nil, log all IRC protocol traffic to the buffer \"*erc-protocol*\".
2226
2227 The buffer is created if it doesn't exist.
2228
2229 NOTE: If this variable is non-nil, and you kill the only
2230 visible \"*erc-protocol*\" buffer, it will be recreated shortly,
2231 but you won't see it.
2232
2233 WARNING: Do not set this variable directly! Instead, use the
2234 function `erc-toggle-debug-irc-protocol' to toggle its value.")
2235
2236 (declare-function erc-network-name "erc-networks" ())
2237
2238 (defun erc-log-irc-protocol (string &optional outbound)
2239 "Append STRING to the buffer *erc-protocol*.
2240
2241 This only has any effect if `erc-debug-irc-protocol' is non-nil.
2242
2243 The buffer is created if it doesn't exist.
2244
2245 If OUTBOUND is non-nil, STRING is being sent to the IRC server
2246 and appears in face `erc-input-face' in the buffer."
2247 (when erc-debug-irc-protocol
2248 (let ((network-name (or (ignore-errors (erc-network-name))
2249 "???")))
2250 (with-current-buffer (get-buffer-create "*erc-protocol*")
2251 (save-excursion
2252 (goto-char (point-max))
2253 (let ((inhibit-read-only t))
2254 (insert (if (not outbound)
2255 ;; Cope with the fact that string might
2256 ;; contain multiple lines of text.
2257 (let ((lines (delete "" (split-string string
2258 "\n\\|\r\n")))
2259 (result ""))
2260 (dolist (line lines)
2261 (setq result (concat result network-name
2262 " << " line "\n")))
2263 result)
2264 (erc-propertize
2265 (concat network-name " >> " string
2266 (if (/= ?\n
2267 (aref string
2268 (1- (length string))))
2269 "\n"))
2270 'face 'erc-input-face)))))
2271 (let ((orig-win (selected-window))
2272 (debug-buffer-window (get-buffer-window (current-buffer) t)))
2273 (when debug-buffer-window
2274 (select-window debug-buffer-window)
2275 (when (= 1 (count-lines (point) (point-max)))
2276 (goto-char (point-max))
2277 (recenter -1))
2278 (select-window orig-win)))))))
2279
2280 (defun erc-toggle-debug-irc-protocol (&optional arg)
2281 "Toggle the value of `erc-debug-irc-protocol'.
2282
2283 If ARG is non-nil, show the *erc-protocol* buffer."
2284 (interactive "P")
2285 (let* ((buf (get-buffer-create "*erc-protocol*")))
2286 (with-current-buffer buf
2287 (erc-view-mode-enter)
2288 (when (null (current-local-map))
2289 (let ((inhibit-read-only t))
2290 (insert (erc-make-notice "This buffer displays all IRC protocol traffic exchanged with each server.\n"))
2291 (insert (erc-make-notice "Kill this buffer to terminate protocol logging.\n\n")))
2292 (use-local-map (make-sparse-keymap))
2293 (local-set-key (kbd "t") 'erc-toggle-debug-irc-protocol))
2294 (add-hook 'kill-buffer-hook
2295 #'(lambda () (setq erc-debug-irc-protocol nil))
2296 nil 'local)
2297 (goto-char (point-max))
2298 (let ((inhibit-read-only t))
2299 (insert (erc-make-notice
2300 (format "IRC protocol logging %s at %s -- Press `t' to toggle logging.\n"
2301 (if erc-debug-irc-protocol "disabled" "enabled")
2302 (current-time-string))))))
2303 (setq erc-debug-irc-protocol (not erc-debug-irc-protocol))
2304 (if (and arg
2305 (not (get-buffer-window "*erc-protocol*" t)))
2306 (display-buffer buf t))
2307 (message "IRC protocol traffic logging %s (see buffer *erc-protocol*)."
2308 (if erc-debug-irc-protocol "enabled" "disabled"))))
2309
2310 ;;; I/O interface
2311
2312 ;; send interface
2313
2314 (defun erc-send-action (tgt str &optional force)
2315 "Send CTCP ACTION information described by STR to TGT."
2316 (erc-send-ctcp-message tgt (format "ACTION %s" str) force)
2317 (erc-display-message
2318 nil 'input (current-buffer)
2319 'ACTION ?n (erc-current-nick) ?a str ?u "" ?h ""))
2320
2321 ;; Display interface
2322
2323 (defun erc-string-invisible-p (string)
2324 "Check whether STRING is invisible or not.
2325 I.e. any char in it has the `invisible' property set."
2326 (text-property-any 0 (length string) 'invisible t string))
2327
2328 (defcustom erc-remove-parsed-property t
2329 "Whether to remove the erc-parsed text property after displaying a message.
2330
2331 The default is to remove it, since it causes ERC to take up extra
2332 memory. If you have code that relies on this property, then set
2333 this option to nil."
2334 :type 'boolean
2335 :group 'erc)
2336
2337 (defun erc-display-line-1 (string buffer)
2338 "Display STRING in `erc-mode' BUFFER.
2339 Auxiliary function used in `erc-display-line'. The line gets filtered to
2340 interpret the control characters. Then, `erc-insert-pre-hook' gets called.
2341 If `erc-insert-this' is still t, STRING gets inserted into the buffer.
2342 Afterwards, `erc-insert-modify' and `erc-insert-post-hook' get called.
2343 If STRING is nil, the function does nothing."
2344 (when string
2345 (with-current-buffer (or buffer (process-buffer erc-server-process))
2346 (let ((insert-position (or (marker-position erc-insert-marker)
2347 (point-max))))
2348 (let ((string string) ;; FIXME! Can this be removed?
2349 (buffer-undo-list t)
2350 (inhibit-read-only t))
2351 (unless (string-match "\n$" string)
2352 (setq string (concat string "\n"))
2353 (when (erc-string-invisible-p string)
2354 (erc-put-text-properties 0 (length string)
2355 '(invisible intangible) string)))
2356 (erc-log (concat "erc-display-line: " string
2357 (format "(%S)" string) " in buffer "
2358 (format "%s" buffer)))
2359 (setq erc-insert-this t)
2360 (run-hook-with-args 'erc-insert-pre-hook string)
2361 (if (null erc-insert-this)
2362 ;; Leave erc-insert-this set to t as much as possible. Fran
2363 ;; Litterio <franl> has seen erc-insert-this set to nil while
2364 ;; erc-send-pre-hook is running, which should never happen. This
2365 ;; may cure it.
2366 (setq erc-insert-this t)
2367 (save-excursion ;; to restore point in the new buffer
2368 (save-restriction
2369 (widen)
2370 (goto-char insert-position)
2371 (insert-before-markers string)
2372 ;; run insertion hook, with point at restored location
2373 (save-restriction
2374 (narrow-to-region insert-position (point))
2375 (run-hooks 'erc-insert-modify-hook)
2376 (run-hooks 'erc-insert-post-hook)
2377 (when erc-remove-parsed-property
2378 (remove-text-properties (point-min) (point-max)
2379 '(erc-parsed nil))))))))
2380 (erc-update-undo-list (- (or (marker-position erc-insert-marker)
2381 (point-max))
2382 insert-position))))))
2383
2384 (defun erc-update-undo-list (shift)
2385 ;; Translate buffer positions in buffer-undo-list by SHIFT.
2386 (unless (or (zerop shift) (atom buffer-undo-list))
2387 (let ((list buffer-undo-list) elt)
2388 (while list
2389 (setq elt (car list))
2390 (cond ((integerp elt) ; POSITION
2391 (cl-incf (car list) shift))
2392 ((or (atom elt) ; nil, EXTENT
2393 ;; (eq t (car elt)) ; (t . TIME)
2394 (markerp (car elt))) ; (MARKER . DISTANCE)
2395 nil)
2396 ((integerp (car elt)) ; (BEGIN . END)
2397 (cl-incf (car elt) shift)
2398 (cl-incf (cdr elt) shift))
2399 ((stringp (car elt)) ; (TEXT . POSITION)
2400 (cl-incf (cdr elt) (* (if (natnump (cdr elt)) 1 -1) shift)))
2401 ((null (car elt)) ; (nil PROPERTY VALUE BEG . END)
2402 (let ((cons (nthcdr 3 elt)))
2403 (cl-incf (car cons) shift)
2404 (cl-incf (cdr cons) shift)))
2405 ((and (featurep 'xemacs)
2406 (extentp (car elt))) ; (EXTENT START END)
2407 (cl-incf (nth 1 elt) shift)
2408 (cl-incf (nth 2 elt) shift)))
2409 (setq list (cdr list))))))
2410
2411 (defvar erc-valid-nick-regexp "[]a-zA-Z^[;\\`_{}|][]^[;\\`_{}|a-zA-Z0-9-]*"
2412 "Regexp which matches all valid characters in a IRC nickname.")
2413
2414 (defun erc-is-valid-nick-p (nick)
2415 "Check if NICK is a valid IRC nickname."
2416 (string-match (concat "\\`" erc-valid-nick-regexp "\\'") nick))
2417
2418 (defun erc-display-line (string &optional buffer)
2419 "Display STRING in the ERC BUFFER.
2420 All screen output must be done through this function. If BUFFER is nil
2421 or omitted, the default ERC buffer for the `erc-session-server' is used.
2422 The BUFFER can be an actual buffer, a list of buffers, 'all or 'active.
2423 If BUFFER = 'all, the string is displayed in all the ERC buffers for the
2424 current session. 'active means the current active buffer
2425 \(`erc-active-buffer'). If the buffer can't be resolved, the current
2426 buffer is used. `erc-display-line-1' is used to display STRING.
2427
2428 If STRING is nil, the function does nothing."
2429 (let ((inhibit-point-motion-hooks t)
2430 new-bufs)
2431 (dolist (buf (cond
2432 ((bufferp buffer) (list buffer))
2433 ((listp buffer) buffer)
2434 ((processp buffer) (list (process-buffer buffer)))
2435 ((eq 'all buffer)
2436 ;; Hmm, or all of the same session server?
2437 (erc-buffer-list nil erc-server-process))
2438 ((and (eq 'active buffer) (erc-active-buffer))
2439 (list (erc-active-buffer)))
2440 ((erc-server-buffer-live-p)
2441 (list (process-buffer erc-server-process)))
2442 (t (list (current-buffer)))))
2443 (when (buffer-live-p buf)
2444 (erc-display-line-1 string buf)
2445 (push buf new-bufs)))
2446 (when (null new-bufs)
2447 (erc-display-line-1 string (if (erc-server-buffer-live-p)
2448 (process-buffer erc-server-process)
2449 (current-buffer))))))
2450
2451 (defun erc-display-message-highlight (type string)
2452 "Highlight STRING according to TYPE, where erc-TYPE-face is an ERC face.
2453
2454 See also `erc-make-notice'."
2455 (cond ((eq type 'notice)
2456 (erc-make-notice string))
2457 (t
2458 (erc-put-text-property
2459 0 (length string)
2460 'face (or (intern-soft
2461 (concat "erc-" (symbol-name type) "-face"))
2462 "erc-default-face")
2463 string)
2464 string)))
2465
2466 (defvar erc-lurker-state nil
2467 "Track the time of the last PRIVMSG for each (server,nick) pair.
2468
2469 This is implemented as a hash of hashes, where the outer key is
2470 the canonicalized server name (as returned by
2471 `erc-canonicalize-server-name') and the outer value is a hash
2472 table mapping nicks (as returned by `erc-lurker-maybe-trim') to
2473 the times of their most recently received PRIVMSG on any channel
2474 on the given server.")
2475
2476 (defcustom erc-lurker-trim-nicks t
2477 "If t, trim trailing `erc-lurker-ignore-chars' from nicks.
2478
2479 This causes e.g. nick and nick\\=` to be considered as the same
2480 individual for activity tracking and lurkiness detection
2481 purposes."
2482 :group 'erc-lurker
2483 :type 'boolean)
2484
2485 (defcustom erc-lurker-ignore-chars "`_"
2486 "Characters at the end of a nick to strip for activity tracking purposes.
2487
2488 See also `erc-lurker-trim-nicks'."
2489 :group 'erc-lurker
2490 :type 'string)
2491
2492 (defun erc-lurker-maybe-trim (nick)
2493 "Maybe trim trailing `erc-lurker-ignore-chars' from NICK.
2494
2495 Returns NICK unmodified unless `erc-lurker-trim-nicks' is
2496 non-nil."
2497 (if erc-lurker-trim-nicks
2498 (replace-regexp-in-string
2499 (format "[%s]"
2500 (mapconcat (lambda (char)
2501 (regexp-quote (char-to-string char)))
2502 erc-lurker-ignore-chars ""))
2503 "" nick)
2504 nick))
2505
2506 (defcustom erc-lurker-hide-list nil
2507 "List of IRC type messages to hide when sent by lurkers.
2508
2509 A typical value would be \(\"JOIN\" \"PART\" \"QUIT\").
2510 See also `erc-lurker-p' and `erc-hide-list'."
2511 :group 'erc-lurker
2512 :type 'erc-message-type)
2513
2514 (defcustom erc-lurker-threshold-time (* 60 60 24) ; 24h by default
2515 "Nicks from which no PRIVMSGs have been received within this
2516 interval (in units of seconds) are considered lurkers by
2517 `erc-lurker-p' and as a result their messages of types in
2518 `erc-lurker-hide-list' will be hidden."
2519 :group 'erc-lurker
2520 :type 'integer)
2521
2522 (defun erc-lurker-initialize ()
2523 "Initialize ERC lurker tracking functionality.
2524
2525 This function adds `erc-lurker-update-status' to
2526 `erc-insert-pre-hook' in order to record the time of each nick's
2527 most recent PRIVMSG as well as initializing the state variable
2528 storing this information."
2529 (setq erc-lurker-state (make-hash-table :test 'equal))
2530 (add-hook 'erc-insert-pre-hook 'erc-lurker-update-status))
2531
2532 (defun erc-lurker-cleanup ()
2533 "Remove all last PRIVMSG state older than `erc-lurker-threshold-time'.
2534
2535 This should be called regularly to avoid excessive resource
2536 consumption for long-lived IRC or Emacs sessions."
2537 (maphash
2538 (lambda (server hash)
2539 (maphash
2540 (lambda (nick last-PRIVMSG-time)
2541 (when
2542 (> (float-time (time-subtract
2543 (current-time)
2544 last-PRIVMSG-time))
2545 erc-lurker-threshold-time)
2546 (remhash nick hash)))
2547 hash)
2548 (if (zerop (hash-table-count hash))
2549 (remhash server erc-lurker-state)))
2550 erc-lurker-state))
2551
2552 (defvar erc-lurker-cleanup-count 0
2553 "Internal counter variable for use with `erc-lurker-cleanup-interval'.")
2554
2555 (defvar erc-lurker-cleanup-interval 100
2556 "Frequency of cleaning up stale erc-lurker state.
2557
2558 `erc-lurker-update-status' calls `erc-lurker-cleanup' once for
2559 every `erc-lurker-cleanup-interval' updates to
2560 `erc-lurker-state'. This is designed to limit the memory
2561 consumption of lurker state during long Emacs sessions and/or ERC
2562 sessions with large numbers of incoming PRIVMSGs.")
2563
2564 (defun erc-lurker-update-status (_message)
2565 "Update `erc-lurker-state' if necessary.
2566
2567 This function is called from `erc-insert-pre-hook'. If the
2568 current message is a PRIVMSG, update `erc-lurker-state' to
2569 reflect the fact that its sender has issued a PRIVMSG at the
2570 current time. Otherwise, take no action.
2571
2572 This function depends on the fact that `erc-display-message'
2573 dynamically binds `parsed', which is used to check if the current
2574 message is a PRIVMSG and to determine its sender. See also
2575 `erc-lurker-trim-nicks' and `erc-lurker-ignore-chars'.
2576
2577 In order to limit memory consumption, this function also calls
2578 `erc-lurker-cleanup' once every `erc-lurker-cleanup-interval'
2579 updates of `erc-lurker-state'."
2580 (when (and (boundp 'parsed) (erc-response-p parsed))
2581 (let* ((command (erc-response.command parsed))
2582 (sender
2583 (erc-lurker-maybe-trim
2584 (car (erc-parse-user (erc-response.sender parsed)))))
2585 (server
2586 (erc-canonicalize-server-name erc-server-announced-name)))
2587 (when (equal command "PRIVMSG")
2588 (when (>= (cl-incf erc-lurker-cleanup-count)
2589 erc-lurker-cleanup-interval)
2590 (setq erc-lurker-cleanup-count 0)
2591 (erc-lurker-cleanup))
2592 (unless (gethash server erc-lurker-state)
2593 (puthash server (make-hash-table :test 'equal) erc-lurker-state))
2594 (puthash sender (current-time)
2595 (gethash server erc-lurker-state))))))
2596
2597 (defun erc-lurker-p (nick)
2598 "Predicate indicating NICK's lurking status on the current server.
2599
2600 Lurking is the condition where NICK has issued no PRIVMSG on this
2601 server within `erc-lurker-threshold-time'. See also
2602 `erc-lurker-trim-nicks' and `erc-lurker-ignore-chars'."
2603 (unless erc-lurker-state (erc-lurker-initialize))
2604 (let* ((server
2605 (erc-canonicalize-server-name erc-server-announced-name))
2606 (last-PRIVMSG-time
2607 (gethash (erc-lurker-maybe-trim nick)
2608 (gethash server erc-lurker-state (make-hash-table)))))
2609 (or (null last-PRIVMSG-time)
2610 (> (float-time
2611 (time-subtract (current-time) last-PRIVMSG-time))
2612 erc-lurker-threshold-time))))
2613
2614 (defcustom erc-common-server-suffixes
2615 '(("openprojects.net\\'" . "OPN")
2616 ("freenode.net\\'" . "freenode")
2617 ("oftc.net\\'" . "OFTC"))
2618 "Alist of common server name suffixes.
2619 This variable is used in mode-line display to save screen
2620 real estate. Set it to nil if you want to avoid changing
2621 displayed hostnames."
2622 :group 'erc-mode-line-and-header
2623 :type 'alist)
2624
2625 (defun erc-canonicalize-server-name (server)
2626 "Return the canonical network name for SERVER if any,
2627 otherwise `erc-server-announced-name'. SERVER is matched against
2628 `erc-common-server-suffixes'."
2629 (when server
2630 (or (cdar (erc-remove-if-not
2631 (lambda (net) (string-match (car net) server))
2632 erc-common-server-suffixes))
2633 erc-server-announced-name)))
2634
2635 (defun erc-add-targets (scope target-list)
2636 (let ((targets
2637 (mapcar (lambda (targets) (member scope targets)) target-list)))
2638 (cdr (apply 'append (delete nil targets)))))
2639
2640 (defun erc-hide-current-message-p (parsed)
2641 "Predicate indicating whether the parsed ERC response PARSED should be hidden.
2642
2643 Messages are always hidden if the message type of PARSED appears in
2644 `erc-hide-list'. Message types that appear in `erc-network-hide-list'
2645 or `erc-channel-hide-list' are are only hidden if the target matches
2646 the network or channel in the list. In addition, messages whose type
2647 is a member of `erc-lurker-hide-list' are hidden if `erc-lurker-p'
2648 returns non-nil."
2649 (let* ((command (erc-response.command parsed))
2650 (sender (car (erc-parse-user (erc-response.sender parsed))))
2651 (channel (nth 1 (erc-response.command-args parsed)))
2652 (network (or (and (fboundp 'erc-network-name) (erc-network-name))
2653 (erc-shorten-server-name
2654 (or erc-server-announced-name
2655 erc-session-server))))
2656 (current-hide-list
2657 (when erc-network-hide-list
2658 (erc-add-targets network erc-network-hide-list)))
2659 (current-hide-list
2660 (apply 'append current-hide-list
2661 (when erc-channel-hide-list
2662 (erc-add-targets channel erc-channel-hide-list)))))
2663 (or (member command erc-hide-list)
2664 (member command current-hide-list)
2665 (and (member command erc-lurker-hide-list) (erc-lurker-p sender)))))
2666
2667 (defun erc-display-message (parsed type buffer msg &rest args)
2668 "Display MSG in BUFFER.
2669
2670 ARGS, PARSED, and TYPE are used to format MSG sensibly.
2671
2672 See also `erc-format-message' and `erc-display-line'."
2673 (let ((string (if (symbolp msg)
2674 (apply #'erc-format-message msg args)
2675 msg)))
2676 (setq string
2677 (cond
2678 ((null type)
2679 string)
2680 ((listp type)
2681 (mapc (lambda (type)
2682 (setq string
2683 (erc-display-message-highlight type string)))
2684 type)
2685 string)
2686 ((symbolp type)
2687 (erc-display-message-highlight type string))))
2688
2689 (if (not (erc-response-p parsed))
2690 (erc-display-line string buffer)
2691 (unless (erc-hide-current-message-p parsed)
2692 (erc-put-text-property 0 (length string) 'erc-parsed parsed string)
2693 (erc-put-text-property 0 (length string) 'rear-sticky t string)
2694 (erc-display-line string buffer)))))
2695
2696 (defun erc-message-type-member (position list)
2697 "Return non-nil if the erc-parsed text-property at POSITION is in LIST.
2698
2699 This function relies on the erc-parsed text-property being
2700 present."
2701 (let ((prop-val (erc-get-parsed-vector position)))
2702 (and prop-val (member (erc-response.command prop-val) list))))
2703
2704 (defvar erc-send-input-line-function 'erc-send-input-line)
2705 (make-variable-buffer-local 'erc-send-input-line-function)
2706
2707 (defun erc-send-input-line (target line &optional force)
2708 "Send LINE to TARGET.
2709
2710 See also `erc-server-send'."
2711 (setq line (format "PRIVMSG %s :%s"
2712 target
2713 ;; If the line is empty, we still want to
2714 ;; send it - i.e. an empty pasted line.
2715 (if (string= line "\n")
2716 " \n"
2717 line)))
2718 (erc-server-send line force target))
2719
2720 (defun erc-get-arglist (fun)
2721 "Return the argument list of a function without the parens."
2722 (let ((arglist (format "%S" (erc-function-arglist fun))))
2723 (if (string-match "\\`(\\(.*\\))\\'" arglist)
2724 (match-string 1 arglist)
2725 arglist)))
2726
2727 (defun erc-command-no-process-p (str)
2728 "Return non-nil if STR is an ERC command that can be run when the process
2729 is not alive, nil otherwise."
2730 (let ((fun (erc-extract-command-from-line str)))
2731 (and fun
2732 (symbolp (car fun))
2733 (get (car fun) 'process-not-needed))))
2734
2735 (defun erc-command-name (cmd)
2736 "For CMD being the function name of a ERC command, something like
2737 erc-cmd-FOO, this returns a string /FOO."
2738 (let ((command-name (symbol-name cmd)))
2739 (if (string-match "\\`erc-cmd-\\(.*\\)\\'" command-name)
2740 (concat "/" (match-string 1 command-name))
2741 command-name)))
2742
2743 (defun erc-process-input-line (line &optional force no-command)
2744 "Translate LINE to an RFC1459 command and send it based.
2745 Returns non-nil if the command is actually sent to the server, and nil
2746 otherwise.
2747
2748 If the command in the LINE is not bound as a function `erc-cmd-<COMMAND>',
2749 it is passed to `erc-cmd-default'. If LINE is not a command (i.e. doesn't
2750 start with /<COMMAND>) then it is sent as a message.
2751
2752 An optional FORCE argument forces sending the line when flood
2753 protection is in effect. The optional NO-COMMAND argument prohibits
2754 this function from interpreting the line as a command."
2755 (let ((command-list (erc-extract-command-from-line line)))
2756 (if (and command-list
2757 (not no-command))
2758 (let* ((cmd (nth 0 command-list))
2759 (args (nth 1 command-list)))
2760 (condition-case nil
2761 (if (listp args)
2762 (apply cmd args)
2763 (funcall cmd args))
2764 (wrong-number-of-arguments
2765 (erc-display-message nil 'error (current-buffer) 'incorrect-args
2766 ?c (erc-command-name cmd)
2767 ?u (or (erc-get-arglist cmd)
2768 "")
2769 ?d (format "%s\n"
2770 (or (documentation cmd) "")))
2771 nil)))
2772 (let ((r (erc-default-target)))
2773 (if r
2774 (funcall erc-send-input-line-function r line force)
2775 (erc-display-message nil 'error (current-buffer) 'no-target)
2776 nil)))))
2777
2778 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2779 ;; Input commands handlers
2780 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2781
2782 (defun erc-cmd-AMSG (line)
2783 "Send LINE to all channels of the current server that you are on."
2784 (interactive "sSend to all channels you're on: ")
2785 (setq line (erc-trim-string line))
2786 (erc-with-all-buffers-of-server nil
2787 (lambda ()
2788 (erc-channel-p (erc-default-target)))
2789 (erc-send-message line)))
2790 (put 'erc-cmd-AMSG 'do-not-parse-args t)
2791
2792 (defun erc-cmd-SAY (line)
2793 "Send LINE to the current query or channel as a message, not a command.
2794
2795 Use this when you want to send a message with a leading `/'. Note
2796 that since multi-line messages are never a command, you don't
2797 need this when pasting multiple lines of text."
2798 (if (string-match "^\\s-*$" line)
2799 nil
2800 (string-match "^ ?\\(.*\\)" line)
2801 (erc-process-input-line (match-string 1 line) nil t)))
2802 (put 'erc-cmd-SAY 'do-not-parse-args t)
2803
2804 (defun erc-cmd-SET (line)
2805 "Set the variable named by the first word in LINE to some VALUE.
2806 VALUE is computed by evaluating the rest of LINE in Lisp."
2807 (cond
2808 ((string-match "^\\s-*\\(\\S-+\\)\\s-+\\(.*\\)$" line)
2809 (let ((var (read (concat "erc-" (match-string 1 line))))
2810 (val (read (match-string 2 line))))
2811 (if (boundp var)
2812 (progn
2813 (set var (eval val))
2814 (erc-display-message
2815 nil nil 'active (format "Set %S to %S" var val))
2816 t)
2817 (setq var (read (match-string 1 line)))
2818 (if (boundp var)
2819 (progn
2820 (set var (eval val))
2821 (erc-display-message
2822 nil nil 'active (format "Set %S to %S" var val))
2823 t)
2824 (erc-display-message nil 'error 'active 'variable-not-bound)
2825 nil))))
2826 ((string-match "^\\s-*$" line)
2827 (erc-display-line
2828 (concat "Available user variables:\n"
2829 (apply
2830 #'concat
2831 (mapcar
2832 (lambda (var)
2833 (let ((val (symbol-value var)))
2834 (concat (format "%S:" var)
2835 (if (consp val)
2836 (concat "\n" (pp-to-string val))
2837 (format " %S\n" val)))))
2838 (apropos-internal "^erc-" 'custom-variable-p))))
2839 (current-buffer))
2840 t)
2841 (t nil)))
2842 (defalias 'erc-cmd-VAR 'erc-cmd-SET)
2843 (defalias 'erc-cmd-VARIABLE 'erc-cmd-SET)
2844 (put 'erc-cmd-SET 'do-not-parse-args t)
2845 (put 'erc-cmd-SET 'process-not-needed t)
2846
2847 (defun erc-cmd-default (line)
2848 "Fallback command.
2849
2850 Commands for which no erc-cmd-xxx exists, are tunneled through
2851 this function. LINE is sent to the server verbatim, and
2852 therefore has to contain the command itself as well."
2853 (erc-log (format "cmd: DEFAULT: %s" line))
2854 (erc-server-send (substring line 1))
2855 t)
2856
2857 (defun erc-cmd-IGNORE (&optional user)
2858 "Ignore USER. This should be a regexp matching nick!user@host.
2859 If no USER argument is specified, list the contents of `erc-ignore-list'."
2860 (if user
2861 (let ((quoted (regexp-quote user)))
2862 (when (and (not (string= user quoted))
2863 (y-or-n-p (format "Use regexp-quoted form (%s) instead? "
2864 quoted)))
2865 (setq user quoted))
2866 (erc-display-line
2867 (erc-make-notice (format "Now ignoring %s" user))
2868 'active)
2869 (erc-with-server-buffer (add-to-list 'erc-ignore-list user)))
2870 (if (null (erc-with-server-buffer erc-ignore-list))
2871 (erc-display-line (erc-make-notice "Ignore list is empty") 'active)
2872 (erc-display-line (erc-make-notice "Ignore list:") 'active)
2873 (mapc #'(lambda (item)
2874 (erc-display-line (erc-make-notice item)
2875 'active))
2876 (erc-with-server-buffer erc-ignore-list))))
2877 t)
2878
2879 (defun erc-cmd-UNIGNORE (user)
2880 "Remove the user specified in USER from the ignore list."
2881 (let ((ignored-nick (car (erc-with-server-buffer
2882 (erc-member-ignore-case (regexp-quote user)
2883 erc-ignore-list)))))
2884 (unless ignored-nick
2885 (if (setq ignored-nick (erc-ignored-user-p user))
2886 (unless (y-or-n-p (format "Remove this regexp (%s)? "
2887 ignored-nick))
2888 (setq ignored-nick nil))
2889 (erc-display-line
2890 (erc-make-notice (format "%s is not currently ignored!" user))
2891 'active)))
2892 (when ignored-nick
2893 (erc-display-line
2894 (erc-make-notice (format "No longer ignoring %s" user))
2895 'active)
2896 (erc-with-server-buffer
2897 (setq erc-ignore-list (delete ignored-nick erc-ignore-list)))))
2898 t)
2899
2900 (defun erc-cmd-CLEAR ()
2901 "Clear the window content."
2902 (recenter 0)
2903 t)
2904 (put 'erc-cmd-CLEAR 'process-not-needed t)
2905
2906 (defun erc-cmd-OPS ()
2907 "Show the ops in the current channel."
2908 (interactive)
2909 (let ((ops nil))
2910 (if erc-channel-users
2911 (maphash (lambda (_nick user-data)
2912 (let ((cuser (cdr user-data)))
2913 (if (and cuser
2914 (erc-channel-user-op cuser))
2915 (setq ops (cons (erc-server-user-nickname
2916 (car user-data))
2917 ops)))))
2918 erc-channel-users))
2919 (setq ops (sort ops 'string-lessp))
2920 (if ops
2921 (erc-display-message
2922 nil 'notice (current-buffer) 'ops
2923 ?i (length ops) ?s (if (> (length ops) 1) "s" "")
2924 ?o (mapconcat 'identity ops " "))
2925 (erc-display-message nil 'notice (current-buffer) 'ops-none)))
2926 t)
2927
2928 (defun erc-cmd-COUNTRY (tld)
2929 "Display the country associated with the top level domain TLD."
2930 (require 'mail-extr)
2931 (let ((co (ignore-errors (what-domain tld))))
2932 (if co
2933 (erc-display-message
2934 nil 'notice 'active 'country ?c co ?d tld)
2935 (erc-display-message
2936 nil 'notice 'active 'country-unknown ?d tld))
2937 t))
2938 (put 'erc-cmd-COUNTRY 'process-not-needed t)
2939
2940 (defun erc-cmd-AWAY (line)
2941 "Mark the user as being away, the reason being indicated by LINE.
2942 If no reason is given, unset away status."
2943 (when (string-match "^\\s-*\\(.*\\)$" line)
2944 (let ((reason (match-string 1 line)))
2945 (erc-log (format "cmd: AWAY: %s" reason))
2946 (erc-server-send
2947 (if (string= reason "")
2948 "AWAY"
2949 (concat "AWAY :" reason))))
2950 t))
2951 (put 'erc-cmd-AWAY 'do-not-parse-args t)
2952
2953 (defun erc-cmd-GAWAY (line)
2954 "Mark the user as being away everywhere, the reason being indicated by LINE."
2955 ;; on all server buffers.
2956 (erc-with-all-buffers-of-server nil
2957 #'erc-open-server-buffer-p
2958 (erc-cmd-AWAY line)))
2959 (put 'erc-cmd-GAWAY 'do-not-parse-args t)
2960
2961 (defun erc-cmd-CTCP (nick cmd &rest args)
2962 "Send a Client To Client Protocol message to NICK.
2963
2964 CMD is the CTCP command, possible values being ECHO, FINGER, CLIENTINFO, TIME,
2965 VERSION and so on. It is called with ARGS."
2966 (let ((str (concat cmd
2967 (when args
2968 (concat " " (mapconcat #'identity args " "))))))
2969 (erc-log (format "cmd: CTCP [%s]: [%s]" nick str))
2970 (erc-send-ctcp-message nick str)
2971 t))
2972
2973 (defun erc-cmd-HELP (&optional func)
2974 "Popup help information.
2975
2976 If FUNC contains a valid function or variable, help about that
2977 will be displayed. If FUNC is empty, display an apropos about
2978 ERC commands. Otherwise, do `apropos' in the ERC namespace
2979 \(\"erc-.*LINE\").
2980
2981 Examples:
2982 To find out about erc and bbdb, do
2983 /help bbdb.*
2984
2985 For help about the WHOIS command, do:
2986 /help whois
2987
2988 For a list of user commands (/join /part, ...):
2989 /help."
2990 (if func
2991 (let* ((sym (or (let ((sym (intern-soft
2992 (concat "erc-cmd-" (upcase func)))))
2993 (if (and sym (or (boundp sym) (fboundp sym)))
2994 sym
2995 nil))
2996 (let ((sym (intern-soft func)))
2997 (if (and sym (or (boundp sym) (fboundp sym)))
2998 sym
2999 nil))
3000 (let ((sym (intern-soft (concat "erc-" func))))
3001 (if (and sym (or (boundp sym) (fboundp sym)))
3002 sym
3003 nil)))))
3004 (if sym
3005 (cond
3006 ((boundp sym) (describe-variable sym))
3007 ((fboundp sym) (describe-function sym))
3008 (t nil))
3009 (apropos-command (concat "erc-.*" func) nil
3010 (lambda (x)
3011 (or (commandp x)
3012 (get x 'custom-type))))
3013 t))
3014 (apropos "erc-cmd-")
3015 (message "Type C-h m to get additional information about keybindings.")
3016 t))
3017
3018 (defalias 'erc-cmd-H 'erc-cmd-HELP)
3019 (put 'erc-cmd-HELP 'process-not-needed t)
3020
3021 (defun erc-cmd-JOIN (channel &optional key)
3022 "Join the channel given in CHANNEL, optionally with KEY.
3023 If CHANNEL is specified as \"-invite\", join the channel to which you
3024 were most recently invited. See also `invitation'."
3025 (let (chnl)
3026 (if (string= (upcase channel) "-INVITE")
3027 (if erc-invitation
3028 (setq chnl erc-invitation)
3029 (erc-display-message nil 'error (current-buffer) 'no-invitation))
3030 (setq chnl (erc-ensure-channel-name channel)))
3031 (when chnl
3032 ;; Prevent double joining of same channel on same server.
3033 (let ((joined-channels
3034 (mapcar #'(lambda (chanbuf)
3035 (with-current-buffer chanbuf (erc-default-target)))
3036 (erc-channel-list erc-server-process))))
3037 (if (erc-member-ignore-case chnl joined-channels)
3038 (switch-to-buffer (car (erc-member-ignore-case chnl
3039 joined-channels)))
3040 (erc-log (format "cmd: JOIN: %s" chnl))
3041 (erc-server-send (if (and chnl key)
3042 (format "JOIN %s %s" chnl key)
3043 (format "JOIN %s" chnl)))))))
3044 t)
3045
3046 (defalias 'erc-cmd-CHANNEL 'erc-cmd-JOIN)
3047 (defalias 'erc-cmd-J 'erc-cmd-JOIN)
3048
3049 (defvar erc-channel-new-member-names nil
3050 "If non-nil, a names list is currently being received.
3051
3052 If non-nil, this variable is a hash-table that associates
3053 received nicks with t.")
3054 (make-variable-buffer-local 'erc-channel-new-member-names)
3055
3056 (defun erc-cmd-NAMES (&optional channel)
3057 "Display the users in CHANNEL.
3058 If CHANNEL is not specified, display the users in the current channel.
3059 This function clears the channel name list first, then sends the
3060 command."
3061 (let ((tgt (or (and (erc-channel-p channel) channel)
3062 (erc-default-target))))
3063 (if (and tgt (erc-channel-p tgt))
3064 (progn
3065 (erc-log (format "cmd: DEFAULT: NAMES %s" tgt))
3066 (erc-with-buffer
3067 (tgt)
3068 (erc-channel-begin-receiving-names))
3069 (erc-server-send (concat "NAMES " tgt)))
3070 (erc-display-message nil 'error (current-buffer) 'no-default-channel)))
3071 t)
3072 (defalias 'erc-cmd-N 'erc-cmd-NAMES)
3073
3074 (defun erc-cmd-KICK (target &optional reason-or-nick &rest reasonwords)
3075 "Kick the user indicated in LINE from the current channel.
3076 LINE has the format: \"#CHANNEL NICK REASON\" or \"NICK REASON\"."
3077 (let ((reasonstring (mapconcat 'identity reasonwords " ")))
3078 (if (string= "" reasonstring)
3079 (setq reasonstring (format "Kicked by %s" (erc-current-nick))))
3080 (if (erc-channel-p target)
3081 (let ((nick reason-or-nick))
3082 (erc-log (format "cmd: KICK: %s/%s: %s" nick target reasonstring))
3083 (erc-server-send (format "KICK %s %s :%s" target nick reasonstring)
3084 nil target)
3085 t)
3086 (when target
3087 (let ((ch (erc-default-target)))
3088 (setq reasonstring (concat
3089 (if reason-or-nick (concat reason-or-nick " "))
3090 reasonstring))
3091 (if ch
3092 (progn
3093 (erc-log
3094 (format "cmd: KICK: %s/%s: %s" target ch reasonstring))
3095 (erc-server-send
3096 (format "KICK %s %s :%s" ch target reasonstring) nil ch))
3097 (erc-display-message nil 'error (current-buffer)
3098 'no-default-channel))
3099 t)))))
3100
3101 (defvar erc-script-args nil)
3102
3103 (defun erc-cmd-LOAD (line)
3104 "Load the script provided in the LINE.
3105 If LINE continues beyond the file name, the rest of
3106 it is put in a (local) variable `erc-script-args',
3107 which can be used in Emacs Lisp scripts.
3108
3109 The optional FORCE argument is ignored here - you can't force loading
3110 a script after exceeding the flood threshold."
3111 (cond
3112 ((string-match "^\\s-*\\(\\S-+\\)\\(.*\\)$" line)
3113 (let* ((file-to-find (match-string 1 line))
3114 (erc-script-args (match-string 2 line))
3115 (file (erc-find-file file-to-find erc-script-path)))
3116 (erc-log (format "cmd: LOAD: %s" file-to-find))
3117 (cond
3118 ((not file)
3119 (erc-display-message nil 'error (current-buffer)
3120 'cannot-find-file ?f file-to-find))
3121 ((not (file-readable-p file))
3122 (erc-display-message nil 'error (current-buffer)
3123 'cannot-read-file ?f file))
3124 (t
3125 (message "Loading `%s'..." file)
3126 (erc-load-script file)
3127 (message "Loading `%s'...done" file))))
3128 t)
3129 (t nil)))
3130
3131 (defun erc-cmd-WHOIS (user &optional server)
3132 "Display whois information for USER.
3133
3134 If SERVER is non-nil, use that, rather than the current server."
3135 ;; FIXME: is the above docstring correct? -- Lawrence 2004-01-08
3136 (let ((send (if server
3137 (format "WHOIS %s %s" user server)
3138 (format "WHOIS %s" user))))
3139 (erc-log (format "cmd: %s" send))
3140 (erc-server-send send)
3141 t))
3142 (defalias 'erc-cmd-WI 'erc-cmd-WHOIS)
3143
3144 (defun erc-cmd-WHOAMI ()
3145 "Display whois information about yourself."
3146 (erc-cmd-WHOIS (erc-current-nick))
3147 t)
3148
3149 (defun erc-cmd-IDLE (nick)
3150 "Show the length of time NICK has been idle."
3151 (let ((origbuf (current-buffer))
3152 symlist)
3153 (erc-with-server-buffer
3154 (push (cons (erc-once-with-server-event
3155 311 (lambda (_proc parsed)
3156 (string= nick
3157 (nth 1 (erc-response.command-args
3158 parsed)))))
3159 'erc-server-311-functions)
3160 symlist)
3161 (push (cons (erc-once-with-server-event
3162 312 (lambda (_proc parsed)
3163 (string= nick
3164 (nth 1 (erc-response.command-args
3165 parsed)))))
3166 'erc-server-312-functions)
3167 symlist)
3168 (push (cons (erc-once-with-server-event
3169 318 (lambda (_proc parsed)
3170 (string= nick
3171 (nth 1 (erc-response.command-args
3172 parsed)))))
3173 'erc-server-318-functions)
3174 symlist)
3175 (push (cons (erc-once-with-server-event
3176 319 (lambda (_proc parsed)
3177 (string= nick
3178 (nth 1 (erc-response.command-args
3179 parsed)))))
3180 'erc-server-319-functions)
3181 symlist)
3182 (push (cons (erc-once-with-server-event
3183 320 (lambda (_proc parsed)
3184 (string= nick
3185 (nth 1 (erc-response.command-args
3186 parsed)))))
3187 'erc-server-320-functions)
3188 symlist)
3189 (push (cons (erc-once-with-server-event
3190 330 (lambda (_proc parsed)
3191 (string= nick
3192 (nth 1 (erc-response.command-args
3193 parsed)))))
3194 'erc-server-330-functions)
3195 symlist)
3196 (push (cons (erc-once-with-server-event
3197 317
3198 (lambda (_proc parsed)
3199 (let ((idleseconds
3200 (string-to-number
3201 (cl-third
3202 (erc-response.command-args parsed)))))
3203 (erc-display-line
3204 (erc-make-notice
3205 (format "%s has been idle for %s."
3206 (erc-string-no-properties nick)
3207 (erc-seconds-to-string idleseconds)))
3208 origbuf)
3209 t)))
3210 'erc-server-317-functions)
3211 symlist)
3212
3213 ;; Send the WHOIS command.
3214 (erc-cmd-WHOIS nick)
3215
3216 ;; Remove the uninterned symbols from the server hooks that did not run.
3217 (run-at-time 20 nil (lambda (buf symlist)
3218 (with-current-buffer buf
3219 (dolist (sym symlist)
3220 (let ((hooksym (cdr sym))
3221 (funcsym (car sym)))
3222 (remove-hook hooksym funcsym t)))))
3223 (current-buffer) symlist)))
3224 t)
3225
3226 (defun erc-cmd-DESCRIBE (line)
3227 "Pose some action to a certain user.
3228 LINE has the format \"USER ACTION\"."
3229 (cond
3230 ((string-match
3231 "^\\s-*\\(\\S-+\\)\\s-\\(.*\\)$" line)
3232 (let ((dst (match-string 1 line))
3233 (s (match-string 2 line)))
3234 (erc-log (format "cmd: DESCRIBE: [%s] %s" dst s))
3235 (erc-send-action dst s))
3236 t)
3237 (t nil)))
3238 (put 'erc-cmd-DESCRIBE 'do-not-parse-args t)
3239
3240 (defun erc-cmd-ME (line)
3241 "Send LINE as an action."
3242 (cond
3243 ((string-match "^\\s-\\(.*\\)$" line)
3244 (let ((s (match-string 1 line)))
3245 (erc-log (format "cmd: ME: %s" s))
3246 (erc-send-action (erc-default-target) s))
3247 t)
3248 (t nil)))
3249 (put 'erc-cmd-ME 'do-not-parse-args t)
3250
3251 (defun erc-cmd-ME\'S (line)
3252 "Do a /ME command, but add the string \" 's\" to the beginning."
3253 (erc-cmd-ME (concat " 's" line)))
3254 (put 'erc-cmd-ME\'S 'do-not-parse-args t)
3255
3256 (defun erc-cmd-LASTLOG (line)
3257 "Show all lines in the current buffer matching the regexp LINE.
3258
3259 If a match spreads across multiple lines, all those lines are shown.
3260
3261 The lines are shown in a buffer named `*Occur*'.
3262 It serves as a menu to find any of the occurrences in this buffer.
3263 \\[describe-mode] in that buffer will explain how.
3264
3265 If LINE contains upper case characters (excluding those preceded by `\\'),
3266 the matching is case-sensitive."
3267 (occur line)
3268 t)
3269 (put 'erc-cmd-LASTLOG 'do-not-parse-args t)
3270 (put 'erc-cmd-LASTLOG 'process-not-needed t)
3271
3272 (defun erc-send-message (line &optional force)
3273 "Send LINE to the current channel or user and display it.
3274
3275 See also `erc-message' and `erc-display-line'."
3276 (erc-message "PRIVMSG" (concat (erc-default-target) " " line) force)
3277 (erc-display-line
3278 (concat (erc-format-my-nick) line)
3279 (current-buffer))
3280 ;; FIXME - treat multiline, run hooks, or remove me?
3281 t)
3282
3283 (defun erc-cmd-MODE (line)
3284 "Change or display the mode value of a channel or user.
3285 The first word specifies the target. The rest is the mode string
3286 to send.
3287
3288 If only one word is given, display the mode of that target.
3289
3290 A list of valid mode strings for Freenode may be found at
3291 URL `http://freenode.net/using_the_network.shtml'."
3292 (cond
3293 ((string-match "^\\s-\\(.*\\)$" line)
3294 (let ((s (match-string 1 line)))
3295 (erc-log (format "cmd: MODE: %s" s))
3296 (erc-server-send (concat "MODE " line)))
3297 t)
3298 (t nil)))
3299 (put 'erc-cmd-MODE 'do-not-parse-args t)
3300
3301 (defun erc-cmd-NOTICE (channel-or-user &rest message)
3302 "Send a notice to the channel or user given as the first word.
3303 The rest is the message to send."
3304 (erc-message "NOTICE" (concat channel-or-user " "
3305 (mapconcat #'identity message " "))))
3306
3307 (defun erc-cmd-MSG (line)
3308 "Send a message to the channel or user given as the first word in LINE.
3309
3310 The rest of LINE is the message to send."
3311 (erc-message "PRIVMSG" line))
3312
3313 (defalias 'erc-cmd-M 'erc-cmd-MSG)
3314 (put 'erc-cmd-MSG 'do-not-parse-args t)
3315
3316 (defun erc-cmd-SQUERY (line)
3317 "Send a Service Query to the service given as the first word in LINE.
3318
3319 The rest of LINE is the message to send."
3320 (erc-message "SQUERY" line))
3321
3322 (defun erc-cmd-NICK (nick)
3323 "Change current nickname to NICK."
3324 (erc-log (format "cmd: NICK: %s (erc-bad-nick: %S)" nick erc-bad-nick))
3325 (let ((nicklen (cdr (assoc "NICKLEN" (erc-with-server-buffer
3326 erc-server-parameters)))))
3327 (and nicklen (> (length nick) (string-to-number nicklen))
3328 (erc-display-message
3329 nil 'notice 'active 'nick-too-long
3330 ?i (length nick) ?l nicklen)))
3331 (erc-server-send (format "NICK %s" nick))
3332 (cond (erc-bad-nick
3333 (erc-set-current-nick nick)
3334 (erc-update-mode-line)
3335 (setq erc-bad-nick nil)))
3336 t)
3337
3338 (defun erc-cmd-PART (line)
3339 "When LINE is an empty string, leave the current channel.
3340 Otherwise leave the channel indicated by LINE."
3341 (cond
3342 ((string-match "^\\s-*\\([&#+!]\\S-+\\)\\s-?\\(.*\\)$" line)
3343 (let* ((ch (match-string 1 line))
3344 (msg (match-string 2 line))
3345 (reason (funcall erc-part-reason (if (equal msg "") nil msg))))
3346 (erc-log (format "cmd: PART: %s: %s" ch reason))
3347 (erc-server-send (if (string= reason "")
3348 (format "PART %s" ch)
3349 (format "PART %s :%s" ch reason))
3350 nil ch))
3351 t)
3352 ((string-match "^\\s-*\\(.*\\)$" line)
3353 (let* ((ch (erc-default-target))
3354 (msg (match-string 1 line))
3355 (reason (funcall erc-part-reason (if (equal msg "") nil msg))))
3356 (if (and ch (erc-channel-p ch))
3357 (progn
3358 (erc-log (format "cmd: PART: %s: %s" ch reason))
3359 (erc-server-send (if (string= reason "")
3360 (format "PART %s" ch)
3361 (format "PART %s :%s" ch reason))
3362 nil ch))
3363 (erc-display-message nil 'error (current-buffer) 'no-target)))
3364 t)
3365 (t nil)))
3366 (put 'erc-cmd-PART 'do-not-parse-args t)
3367
3368 (defalias 'erc-cmd-LEAVE 'erc-cmd-PART)
3369
3370 (defun erc-cmd-PING (recipient)
3371 "Ping RECIPIENT."
3372 (let ((time (format "%f" (erc-current-time))))
3373 (erc-log (format "cmd: PING: %s" time))
3374 (erc-cmd-CTCP recipient "PING" time)))
3375
3376 (defun erc-cmd-QUOTE (line)
3377 "Send LINE directly to the server.
3378 All the text given as argument is sent to the sever as unmodified,
3379 just as you provided it. Use this command with care!"
3380 (cond
3381 ((string-match "^ ?\\(.+\\)$" line)
3382 (erc-server-send (match-string 1 line)))
3383 (t nil)))
3384 (put 'erc-cmd-QUOTE 'do-not-parse-args t)
3385
3386 (defcustom erc-query-display 'window
3387 "Indicates how to display query buffers when using the /QUERY
3388 command to talk to someone.
3389
3390 The default behavior is to display the message in a new window
3391 and bring it to the front. See the documentation for
3392 `erc-join-buffer' for a description of the available choices.
3393
3394 See also `erc-auto-query' to decide how private messages from
3395 other people should be displayed."
3396 :group 'erc-query
3397 :type '(choice (const :tag "Split window and select" window)
3398 (const :tag "Split window, don't select" window-noselect)
3399 (const :tag "New frame" frame)
3400 (const :tag "Bury in new buffer" bury)
3401 (const :tag "Use current buffer" buffer)
3402 (const :tag "Use current buffer" t)))
3403
3404 (defun erc-cmd-QUERY (&optional user)
3405 "Open a query with USER.
3406 The type of query window/frame/etc will depend on the value of
3407 `erc-query-display'.
3408
3409 If USER is omitted, close the current query buffer if one exists
3410 - except this is broken now ;-)"
3411 (interactive
3412 (list (read-from-minibuffer "Start a query with: " nil)))
3413 (let ((session-buffer (erc-server-buffer))
3414 (erc-join-buffer erc-query-display))
3415 (if user
3416 (erc-query user session-buffer)
3417 ;; currently broken, evil hack to display help anyway
3418 ;(erc-delete-query))))
3419 (signal 'wrong-number-of-arguments ""))))
3420 (defalias 'erc-cmd-Q 'erc-cmd-QUERY)
3421
3422 (defun erc-quit/part-reason-default ()
3423 "Default quit/part message."
3424 (format "\C-bERC\C-b (IRC client for Emacs %s)" emacs-version))
3425
3426
3427 (defun erc-quit-reason-normal (&optional s)
3428 "Normal quit message.
3429
3430 If S is non-nil, it will be used as the quit reason."
3431 (or s (erc-quit/part-reason-default)))
3432
3433 (defun erc-quit-reason-zippy (&optional s)
3434 "Zippy quit message.
3435
3436 If S is non-nil, it will be used as the quit reason."
3437 (or s
3438 (if (fboundp 'yow)
3439 (erc-replace-regexp-in-string "\n" "" (yow))
3440 (erc-quit/part-reason-default))))
3441
3442 (make-obsolete 'erc-quit-reason-zippy "it will be removed." "24.4")
3443
3444 (defun erc-quit-reason-various (s)
3445 "Choose a quit reason based on S (a string)."
3446 (when (featurep 'xemacs) (require 'poe))
3447 (let ((res (car (assoc-default (or s "")
3448 erc-quit-reason-various-alist 'string-match))))
3449 (cond
3450 ((functionp res) (funcall res))
3451 ((stringp res) res)
3452 (s s)
3453 (t (erc-quit/part-reason-default)))))
3454
3455 (defun erc-part-reason-normal (&optional s)
3456 "Normal part message.
3457
3458 If S is non-nil, it will be used as the part reason."
3459 (or s (erc-quit/part-reason-default)))
3460
3461 (defun erc-part-reason-zippy (&optional s)
3462 "Zippy part message.
3463
3464 If S is non-nil, it will be used as the quit reason."
3465 (or s
3466 (if (fboundp 'yow)
3467 (erc-replace-regexp-in-string "\n" "" (yow))
3468 (erc-quit/part-reason-default))))
3469
3470 (make-obsolete 'erc-part-reason-zippy "it will be removed." "24.4")
3471
3472 (defun erc-part-reason-various (s)
3473 "Choose a part reason based on S (a string)."
3474 (when (featurep 'xemacs) (require 'poe))
3475 (let ((res (car (assoc-default (or s "")
3476 erc-part-reason-various-alist 'string-match))))
3477 (cond
3478 ((functionp res) (funcall res))
3479 ((stringp res) res)
3480 (s s)
3481 (t (erc-quit/part-reason-default)))))
3482
3483 (defun erc-cmd-QUIT (reason)
3484 "Disconnect from the current server.
3485 If REASON is omitted, display a default quit message, otherwise display
3486 the message given by REASON."
3487 (unless reason
3488 (setq reason ""))
3489 (cond
3490 ((string-match "^\\s-*\\(.*\\)$" reason)
3491 (let* ((s (match-string 1 reason))
3492 (buffer (erc-server-buffer))
3493 (reason (funcall erc-quit-reason (if (equal s "") nil s)))
3494 server-proc)
3495 (with-current-buffer (if (and buffer
3496 (bufferp buffer))
3497 buffer
3498 (current-buffer))
3499 (erc-log (format "cmd: QUIT: %s" reason))
3500 (setq erc-server-quitting t)
3501 (erc-set-active-buffer (erc-server-buffer))
3502 (setq server-proc erc-server-process)
3503 (erc-server-send (format "QUIT :%s" reason)))
3504 (run-hook-with-args 'erc-quit-hook server-proc)
3505 (when erc-kill-queries-on-quit
3506 (erc-kill-query-buffers server-proc))
3507 ;; if the process has not been killed within 4 seconds, kill it
3508 (run-at-time 4 nil
3509 (lambda (proc)
3510 (when (and (processp proc)
3511 (memq (process-status proc) '(run open)))
3512 (delete-process proc)))
3513 server-proc))
3514 t)
3515 (t nil)))
3516
3517 (defalias 'erc-cmd-BYE 'erc-cmd-QUIT)
3518 (defalias 'erc-cmd-EXIT 'erc-cmd-QUIT)
3519 (defalias 'erc-cmd-SIGNOFF 'erc-cmd-QUIT)
3520 (put 'erc-cmd-QUIT 'do-not-parse-args t)
3521 (put 'erc-cmd-QUIT 'process-not-needed t)
3522
3523 (defun erc-cmd-GQUIT (reason)
3524 "Disconnect from all servers at once with the same quit REASON."
3525 (erc-with-all-buffers-of-server nil #'erc-open-server-buffer-p
3526 (erc-cmd-QUIT reason))
3527 (when erc-kill-queries-on-quit
3528 ;; if the query buffers have not been killed within 4 seconds,
3529 ;; kill them
3530 (run-at-time
3531 4 nil
3532 (lambda ()
3533 (dolist (buffer (erc-buffer-list (lambda (buf)
3534 (not (erc-server-buffer-p buf)))))
3535 (kill-buffer buffer)))))
3536 t)
3537
3538 (defalias 'erc-cmd-GQ 'erc-cmd-GQUIT)
3539 (put 'erc-cmd-GQUIT 'do-not-parse-args t)
3540 (put 'erc-cmd-GQUIT 'process-not-needed t)
3541
3542 (defun erc-cmd-RECONNECT ()
3543 "Try to reconnect to the current IRC server."
3544 (let ((buffer (erc-server-buffer))
3545 (process nil))
3546 (unless (buffer-live-p buffer)
3547 (setq buffer (current-buffer)))
3548 (with-current-buffer buffer
3549 (setq erc-server-quitting nil)
3550 (setq erc-server-reconnecting t)
3551 (setq erc-server-reconnect-count 0)
3552 (setq process (get-buffer-process (erc-server-buffer)))
3553 (if process
3554 (delete-process process)
3555 (erc-server-reconnect))
3556 (setq erc-server-reconnecting nil)))
3557 t)
3558 (put 'erc-cmd-RECONNECT 'process-not-needed t)
3559
3560 (defun erc-cmd-SERVER (server)
3561 "Connect to SERVER, leaving existing connection intact."
3562 (erc-log (format "cmd: SERVER: %s" server))
3563 (condition-case nil
3564 (erc :server server :nick (erc-current-nick))
3565 (error
3566 (erc-error "Cannot find host %s." server)))
3567 t)
3568 (put 'erc-cmd-SERVER 'process-not-needed t)
3569
3570 (defvar motif-version-string)
3571 (defvar gtk-version-string)
3572
3573 (defun erc-cmd-SV ()
3574 "Say the current ERC and Emacs version into channel."
3575 (erc-send-message (format "I'm using ERC with %s %s (%s%s) of %s."
3576 (if (featurep 'xemacs) "XEmacs" "GNU Emacs")
3577 emacs-version
3578 system-configuration
3579 (concat
3580 (cond ((featurep 'motif)
3581 (concat ", " (substring
3582 motif-version-string 4)))
3583 ((featurep 'gtk)
3584 (concat ", GTK+ Version "
3585 gtk-version-string))
3586 ((featurep 'x-toolkit) ", X toolkit")
3587 (t ""))
3588 (if (and (boundp 'x-toolkit-scroll-bars)
3589 (memq x-toolkit-scroll-bars
3590 '(xaw xaw3d)))
3591 (format ", %s scroll bars"
3592 (capitalize (symbol-name
3593 x-toolkit-scroll-bars)))
3594 "")
3595 (if (featurep 'multi-tty) ", multi-tty" ""))
3596 erc-emacs-build-time))
3597 t)
3598
3599 (defun erc-cmd-SM ()
3600 "Say the current ERC modes into channel."
3601 (erc-send-message (format "I'm using the following modules: %s!"
3602 (erc-modes)))
3603 t)
3604
3605 (defun erc-cmd-DEOP (&rest people)
3606 "Remove the operator setting from user(s) given in PEOPLE."
3607 (when (> (length people) 0)
3608 (erc-server-send (concat "MODE " (erc-default-target)
3609 " -"
3610 (make-string (length people) ?o)
3611 " "
3612 (mapconcat 'identity people " ")))
3613 t))
3614
3615 (defun erc-cmd-OP (&rest people)
3616 "Add the operator setting to users(s) given in PEOPLE."
3617 (when (> (length people) 0)
3618 (erc-server-send (concat "MODE " (erc-default-target)
3619 " +"
3620 (make-string (length people) ?o)
3621 " "
3622 (mapconcat 'identity people " ")))
3623 t))
3624
3625 (defun erc-cmd-TIME (&optional line)
3626 "Request the current time and date from the current server."
3627 (cond
3628 ((and line (string-match "^\\s-*\\(.*\\)$" line))
3629 (let ((args (match-string 1 line)))
3630 (erc-log (format "cmd: TIME: %s" args))
3631 (erc-server-send (concat "TIME " args)))
3632 t)
3633 (t (erc-server-send "TIME"))))
3634 (defalias 'erc-cmd-DATE 'erc-cmd-TIME)
3635
3636 (defun erc-cmd-TOPIC (topic)
3637 "Set or request the topic for a channel.
3638 LINE has the format: \"#CHANNEL TOPIC\", \"#CHANNEL\", \"TOPIC\"
3639 or the empty string.
3640
3641 If no #CHANNEL is given, the default channel is used. If TOPIC is
3642 given, the channel topic is modified, otherwise the current topic will
3643 be displayed."
3644 (cond
3645 ;; /topic #channel TOPIC
3646 ((string-match "^\\s-*\\([&#+!]\\S-+\\)\\s-\\(.*\\)$" topic)
3647 (let ((ch (match-string 1 topic))
3648 (topic (match-string 2 topic)))
3649 (erc-log (format "cmd: TOPIC [%s]: %s" ch topic))
3650 (erc-server-send (format "TOPIC %s :%s" ch topic) nil ch))
3651 t)
3652 ;; /topic #channel
3653 ((string-match "^\\s-*\\([&#+!]\\S-+\\)" topic)
3654 (let ((ch (match-string 1 topic)))
3655 (erc-server-send (format "TOPIC %s" ch) nil ch)
3656 t))
3657 ;; /topic
3658 ((string-match "^\\s-*$" topic)
3659 (let ((ch (erc-default-target)))
3660 (erc-server-send (format "TOPIC %s" ch) nil ch)
3661 t))
3662 ;; /topic TOPIC
3663 ((string-match "^\\s-*\\(.*\\)$" topic)
3664 (let ((ch (erc-default-target))
3665 (topic (match-string 1 topic)))
3666 (if (and ch (erc-channel-p ch))
3667 (progn
3668 (erc-log (format "cmd: TOPIC [%s]: %s" ch topic))
3669 (erc-server-send (format "TOPIC %s :%s" ch topic) nil ch))
3670 (erc-display-message nil 'error (current-buffer) 'no-target)))
3671 t)
3672 (t nil)))
3673 (defalias 'erc-cmd-T 'erc-cmd-TOPIC)
3674 (put 'erc-cmd-TOPIC 'do-not-parse-args t)
3675
3676 (defun erc-cmd-APPENDTOPIC (topic)
3677 "Append TOPIC to the current channel topic, separated by a space."
3678 (let ((oldtopic erc-channel-topic))
3679 ;; display help when given no arguments
3680 (when (string-match "^\\s-*$" topic)
3681 (signal 'wrong-number-of-arguments nil))
3682 ;; strip trailing ^O
3683 (when (string-match "\\(.*\\)\C-o" oldtopic)
3684 (erc-cmd-TOPIC (concat (match-string 1 oldtopic) topic)))))
3685 (defalias 'erc-cmd-AT 'erc-cmd-APPENDTOPIC)
3686 (put 'erc-cmd-APPENDTOPIC 'do-not-parse-args t)
3687
3688 (defun erc-cmd-CLEARTOPIC (&optional channel)
3689 "Clear the topic for a CHANNEL.
3690 If CHANNEL is not specified, clear the topic for the default channel."
3691 (interactive "sClear topic of channel (RET is current channel): ")
3692 (let ((chnl (or (and (erc-channel-p channel) channel) (erc-default-target))))
3693 (when chnl
3694 (erc-server-send (format "TOPIC %s :" chnl))
3695 t)))
3696
3697 ;;; Banlists
3698
3699 (defvar erc-channel-banlist nil
3700 "A list of bans seen for the current channel.
3701
3702 Each ban is an alist of the form:
3703 (WHOSET . MASK)
3704
3705 The property `received-from-server' indicates whether
3706 or not the ban list has been requested from the server.")
3707 (make-variable-buffer-local 'erc-channel-banlist)
3708 (put 'erc-channel-banlist 'received-from-server nil)
3709
3710 (defun erc-cmd-BANLIST ()
3711 "Pretty-print the contents of `erc-channel-banlist'.
3712
3713 The ban list is fetched from the server if necessary."
3714 (let ((chnl (erc-default-target))
3715 (chnl-name (buffer-name)))
3716
3717 (cond
3718 ((not (erc-channel-p chnl))
3719 (erc-display-line (erc-make-notice "You're not on a channel\n")
3720 'active))
3721
3722 ((not (get 'erc-channel-banlist 'received-from-server))
3723 (let ((old-367-hook erc-server-367-functions))
3724 (setq erc-server-367-functions 'erc-banlist-store
3725 erc-channel-banlist nil)
3726 ;; fetch the ban list then callback
3727 (erc-with-server-buffer
3728 (erc-once-with-server-event
3729 368
3730 (lambda (_proc _parsed)
3731 (with-current-buffer chnl-name
3732 (put 'erc-channel-banlist 'received-from-server t)
3733 (setq erc-server-367-functions old-367-hook)
3734 (erc-cmd-BANLIST)
3735 t)))
3736 (erc-server-send (format "MODE %s b" chnl)))))
3737
3738 ((null erc-channel-banlist)
3739 (erc-display-line (erc-make-notice
3740 (format "No bans for channel: %s\n" chnl))
3741 'active)
3742 (put 'erc-channel-banlist 'received-from-server nil))
3743
3744 (t
3745 (let* ((erc-fill-column (or (and (boundp 'erc-fill-column)
3746 erc-fill-column)
3747 (and (boundp 'fill-column)
3748 fill-column)
3749 (1- (window-width))))
3750 (separator (make-string erc-fill-column ?=))
3751 (fmt (concat
3752 "%-" (number-to-string (/ erc-fill-column 2)) "s"
3753 "%" (number-to-string (/ erc-fill-column 2)) "s")))
3754
3755 (erc-display-line
3756 (erc-make-notice (format "Ban list for channel: %s\n"
3757 (erc-default-target)))
3758 'active)
3759
3760 (erc-display-line separator 'active)
3761 (erc-display-line (format fmt "Ban Mask" "Banned By") 'active)
3762 (erc-display-line separator 'active)
3763
3764 (mapc
3765 (lambda (x)
3766 (erc-display-line
3767 (format fmt
3768 (truncate-string-to-width (cdr x) (/ erc-fill-column 2))
3769 (if (car x)
3770 (truncate-string-to-width (car x) (/ erc-fill-column 2))
3771 ""))
3772 'active))
3773 erc-channel-banlist)
3774
3775 (erc-display-line (erc-make-notice "End of Ban list")
3776 'active)
3777 (put 'erc-channel-banlist 'received-from-server nil)))))
3778 t)
3779
3780 (defalias 'erc-cmd-BL 'erc-cmd-BANLIST)
3781
3782 (defun erc-cmd-MASSUNBAN ()
3783 "Mass Unban.
3784
3785 Unban all currently banned users in the current channel."
3786 (let ((chnl (erc-default-target)))
3787 (cond
3788
3789 ((not (erc-channel-p chnl))
3790 (erc-display-line
3791 (erc-make-notice "You're not on a channel\n")
3792 'active))
3793
3794 ((not (get 'erc-channel-banlist 'received-from-server))
3795 (let ((old-367-hook erc-server-367-functions))
3796 (setq erc-server-367-functions 'erc-banlist-store)
3797 ;; fetch the ban list then callback
3798 (erc-with-server-buffer
3799 (erc-once-with-server-event
3800 368
3801 (lambda (_proc _parsed)
3802 (with-current-buffer chnl
3803 (put 'erc-channel-banlist 'received-from-server t)
3804 (setq erc-server-367-functions old-367-hook)
3805 (erc-cmd-MASSUNBAN)
3806 t)))
3807 (erc-server-send (format "MODE %s b" chnl)))))
3808
3809 (t (let ((bans (mapcar #'cdr erc-channel-banlist)))
3810 (when bans
3811 ;; Glob the bans into groups of three, and carry out the unban.
3812 ;; eg. /mode #foo -bbb a*!*@* b*!*@* c*!*@*
3813 (mapc
3814 (lambda (x)
3815 (erc-server-send
3816 (format "MODE %s -%s %s" (erc-default-target)
3817 (make-string (length x) ?b)
3818 (mapconcat 'identity x " "))))
3819 (erc-group-list bans 3))))
3820 t))))
3821
3822 (defalias 'erc-cmd-MUB 'erc-cmd-MASSUNBAN)
3823
3824 ;;;; End of IRC commands
3825
3826 (defun erc-ensure-channel-name (channel)
3827 "Return CHANNEL if it is a valid channel name.
3828 Eventually add a # in front of it, if that turns it into a valid channel name."
3829 (if (erc-channel-p channel)
3830 channel
3831 (concat "#" channel)))
3832
3833 (defun erc-grab-region (start end)
3834 "Copy the region between START and END in a recreatable format.
3835
3836 Converts all the IRC text properties in each line of the region
3837 into control codes and writes them to a separate buffer. The
3838 resulting text may be used directly as a script to generate this
3839 text again."
3840 (interactive "r")
3841 (erc-set-active-buffer (current-buffer))
3842 (save-excursion
3843 (let* ((cb (current-buffer))
3844 (buf (generate-new-buffer erc-grab-buffer-name))
3845 (region (buffer-substring start end))
3846 (lines (erc-split-multiline-safe region)))
3847 (set-buffer buf)
3848 (dolist (line lines)
3849 (insert (concat line "\n")))
3850 (set-buffer cb)
3851 (switch-to-buffer-other-window buf)))
3852 (message "erc-grab-region doesn't grab colors etc. anymore. If you use this, please tell the maintainers.")
3853 (ding))
3854
3855 (defun erc-display-prompt (&optional buffer pos prompt face)
3856 "Display PROMPT in BUFFER at position POS.
3857 Display an ERC prompt in BUFFER.
3858
3859 If PROMPT is nil, one is constructed with the function `erc-prompt'.
3860 If BUFFER is nil, the `current-buffer' is used.
3861 If POS is nil, PROMPT will be displayed at `point'.
3862 If FACE is non-nil, it will be used to propertize the prompt. If it is nil,
3863 `erc-prompt-face' will be used."
3864 (let* ((prompt (or prompt (erc-prompt)))
3865 (l (length prompt))
3866 (ob (current-buffer)))
3867 ;; We cannot use save-excursion because we move point, therefore
3868 ;; we resort to the ol' ob trick to restore this.
3869 (when (and buffer (bufferp buffer))
3870 (set-buffer buffer))
3871
3872 ;; now save excursion again to store where point and mark are
3873 ;; in the current buffer
3874 (save-excursion
3875 (setq pos (or pos (point)))
3876 (goto-char pos)
3877 (when (> l 0)
3878 ;; Do not extend the text properties when typing at the end
3879 ;; of the prompt, but stuff typed in front of the prompt
3880 ;; shall remain part of the prompt.
3881 (setq prompt (erc-propertize prompt
3882 'start-open t ; XEmacs
3883 'rear-nonsticky t ; Emacs
3884 'erc-prompt t
3885 'field t
3886 'front-sticky t
3887 'read-only t))
3888 (erc-put-text-property 0 (1- (length prompt))
3889 'face (or face 'erc-prompt-face)
3890 prompt)
3891 (insert prompt))
3892 ;; Set the input marker
3893 (set-marker erc-input-marker (point)))
3894
3895 ;; Now we are back at the old position. If the prompt was
3896 ;; inserted here or before us, advance point by the length of
3897 ;; the prompt.
3898 (when (or (not pos) (<= (point) pos))
3899 (forward-char l))
3900 ;; Clear the undo buffer now, so the user can undo his stuff,
3901 ;; but not the stuff we did. Sneaky!
3902 (setq buffer-undo-list nil)
3903 (set-buffer ob)))
3904
3905 ;; interactive operations
3906
3907 (defun erc-input-message ()
3908 "Read input from the minibuffer."
3909 (interactive)
3910 (let ((minibuffer-allow-text-properties t)
3911 (read-map minibuffer-local-map))
3912 (insert (read-from-minibuffer "Message: "
3913 (string (if (featurep 'xemacs)
3914 last-command-char
3915 last-command-event))
3916 read-map))
3917 (erc-send-current-line)))
3918
3919 (defvar erc-action-history-list ()
3920 "History list for interactive action input.")
3921
3922 (defun erc-input-action ()
3923 "Interactively input a user action and send it to IRC."
3924 (interactive "")
3925 (erc-set-active-buffer (current-buffer))
3926 (let ((action (read-from-minibuffer
3927 "Action: " nil nil nil 'erc-action-history-list)))
3928 (if (not (string-match "^\\s-*$" action))
3929 (erc-send-action (erc-default-target) action))))
3930
3931 (defun erc-join-channel (channel &optional key)
3932 "Join CHANNEL.
3933
3934 If `point' is at the beginning of a channel name, use that as default."
3935 (interactive
3936 (list
3937 (let ((chnl (if (looking-at "\\([&#+!][^ \n]+\\)") (match-string 1) ""))
3938 (table (when (erc-server-buffer-live-p)
3939 (set-buffer (process-buffer erc-server-process))
3940 erc-channel-list)))
3941 (completing-read "Join channel: " table nil nil nil nil chnl))
3942 (when (or current-prefix-arg erc-prompt-for-channel-key)
3943 (read-from-minibuffer "Channel key (RET for none): " nil))))
3944 (erc-cmd-JOIN channel (when (>= (length key) 1) key)))
3945
3946 (defun erc-part-from-channel (reason)
3947 "Part from the current channel and prompt for a REASON."
3948 (interactive
3949 (list
3950 (if (and (boundp 'reason) (stringp reason) (not (string= reason "")))
3951 reason
3952 (read-from-minibuffer (concat "Reason for leaving " (erc-default-target)
3953 ": ")))))
3954 (erc-cmd-PART (concat (erc-default-target)" " reason)))
3955
3956 (defun erc-set-topic (topic)
3957 "Prompt for a TOPIC for the current channel."
3958 (interactive
3959 (list
3960 (read-from-minibuffer
3961 (concat "Set topic of " (erc-default-target) ": ")
3962 (when erc-channel-topic
3963 (let ((ss (split-string erc-channel-topic "\C-o")))
3964 (cons (apply #'concat (if (cdr ss) (butlast ss) ss))
3965 0))))))
3966 (let ((topic-list (split-string topic "\C-o"))) ; strip off the topic setter
3967 (erc-cmd-TOPIC (concat (erc-default-target) " " (car topic-list)))))
3968
3969 (defun erc-set-channel-limit (&optional limit)
3970 "Set a LIMIT for the current channel. Remove limit if nil.
3971 Prompt for one if called interactively."
3972 (interactive (list (read-from-minibuffer
3973 (format "Limit for %s (RET to remove limit): "
3974 (erc-default-target)))))
3975 (let ((tgt (erc-default-target)))
3976 (erc-server-send (if (and limit (>= (length limit) 1))
3977 (format "MODE %s +l %s" tgt limit)
3978 (format "MODE %s -l" tgt)))))
3979
3980 (defun erc-set-channel-key (&optional key)
3981 "Set a KEY for the current channel. Remove key if nil.
3982 Prompt for one if called interactively."
3983 (interactive (list (read-from-minibuffer
3984 (format "Key for %s (RET to remove key): "
3985 (erc-default-target)))))
3986 (let ((tgt (erc-default-target)))
3987 (erc-server-send (if (and key (>= (length key) 1))
3988 (format "MODE %s +k %s" tgt key)
3989 (format "MODE %s -k" tgt)))))
3990
3991 (defun erc-quit-server (reason)
3992 "Disconnect from current server after prompting for REASON.
3993 `erc-quit-reason' works with this just like with `erc-cmd-QUIT'."
3994 (interactive (list (read-from-minibuffer
3995 (format "Reason for quitting %s: "
3996 (or erc-server-announced-name
3997 erc-session-server)))))
3998 (erc-cmd-QUIT reason))
3999
4000 ;; Movement of point
4001
4002 (defun erc-bol ()
4003 "Move `point' to the beginning of the current line.
4004
4005 This places `point' just after the prompt, or at the beginning of the line."
4006 (interactive)
4007 (forward-line 0)
4008 (when (get-text-property (point) 'erc-prompt)
4009 (goto-char erc-input-marker))
4010 (point))
4011
4012 (defun erc-kill-input ()
4013 "Kill current input line using `erc-bol' followed by `kill-line'."
4014 (interactive)
4015 (when (and (erc-bol)
4016 (/= (point) (point-max))) ;; Prevent a (ding) and an error when
4017 ;; there's nothing to kill
4018 (if (boundp 'erc-input-ring-index)
4019 (setq erc-input-ring-index nil))
4020 (kill-line)))
4021
4022 (defun erc-complete-word-at-point ()
4023 (run-hook-with-args-until-success 'erc-complete-functions))
4024
4025 (define-obsolete-function-alias 'erc-complete-word 'completion-at-point "24.1")
4026
4027 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4028 ;;
4029 ;; IRC SERVER INPUT HANDLING
4030 ;;
4031 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4032
4033 ;;;; New Input parsing
4034
4035 ; Stolen from ZenIRC. I just wanna test this code, so here is
4036 ; experiment area.
4037
4038 (defcustom erc-default-server-hook '(erc-debug-missing-hooks
4039 erc-default-server-handler)
4040 "Default for server messages which aren't covered by `erc-server-hooks'."
4041 :group 'erc-server-hooks
4042 :type 'hook)
4043
4044 (defun erc-default-server-handler (proc parsed)
4045 "Default server handler.
4046
4047 Displays PROC and PARSED appropriately using `erc-display-message'."
4048 (erc-display-message
4049 parsed 'notice proc
4050 (mapconcat
4051 'identity
4052 (let (res)
4053 (mapc #'(lambda (x)
4054 (if (stringp x)
4055 (setq res (append res (list x)))))
4056 parsed)
4057 res)
4058 " ")))
4059
4060 (defvar erc-server-vectors
4061 '(["msgtype" "sender" "to" "arg1" "arg2" "arg3" "..."])
4062 "List of received server messages which ERC does not specifically handle.
4063 See `erc-debug-missing-hooks'.")
4064 ;(make-variable-buffer-local 'erc-server-vectors)
4065
4066 (defun erc-debug-missing-hooks (_proc parsed)
4067 "Add PARSED server message ERC does not yet handle to `erc-server-vectors'.
4068 These vectors can be helpful when adding new server message handlers to ERC.
4069 See `erc-default-server-hook'."
4070 (nconc erc-server-vectors (list parsed))
4071 nil)
4072
4073 (defun erc-query (target server)
4074 "Open a query buffer on TARGET, using SERVER.
4075 To change how this query window is displayed, use `let' to bind
4076 `erc-join-buffer' before calling this."
4077 (unless (and server
4078 (buffer-live-p server)
4079 (set-buffer server))
4080 (error "Couldn't switch to server buffer"))
4081 (let ((buf (erc-open erc-session-server
4082 erc-session-port
4083 (erc-current-nick)
4084 erc-session-user-full-name
4085 nil
4086 nil
4087 (list target)
4088 target
4089 erc-server-process)))
4090 (unless buf
4091 (error "Couldn't open query window"))
4092 (erc-update-mode-line)
4093 buf))
4094
4095 (defcustom erc-auto-query 'window-noselect
4096 "If non-nil, create a query buffer each time you receive a private message.
4097 If the buffer doesn't already exist, it is created.
4098
4099 This can be set to a symbol, to control how the new query window
4100 should appear. The default behavior is to display the buffer in
4101 a new window, but not to select it. See the documentation for
4102 `erc-join-buffer' for a description of the available choices."
4103 :group 'erc-query
4104 :type '(choice (const :tag "Don't create query window" nil)
4105 (const :tag "Split window and select" window)
4106 (const :tag "Split window, don't select" window-noselect)
4107 (const :tag "New frame" frame)
4108 (const :tag "Bury in new buffer" bury)
4109 (const :tag "Use current buffer" buffer)
4110 (const :tag "Use current buffer" t)))
4111
4112 (defcustom erc-query-on-unjoined-chan-privmsg t
4113 "If non-nil create query buffer on receiving any PRIVMSG at all.
4114 This includes PRIVMSGs directed to channels. If you are using an IRC
4115 bouncer, such as dircproxy, to keep a log of channels when you are
4116 disconnected, you should set this option to t."
4117 :group 'erc-query
4118 :type 'boolean)
4119
4120 (defcustom erc-format-query-as-channel-p t
4121 "If non-nil, format text from others in a query buffer like in a channel,
4122 otherwise format like a private message."
4123 :group 'erc-query
4124 :type 'boolean)
4125
4126 (defcustom erc-minibuffer-notice nil
4127 "If non-nil, print ERC notices for the user in the minibuffer.
4128 Only happens when the session buffer isn't visible."
4129 :group 'erc-display
4130 :type 'boolean)
4131
4132 (defcustom erc-minibuffer-ignored nil
4133 "If non-nil, print a message in the minibuffer if we ignored something."
4134 :group 'erc-ignore
4135 :type 'boolean)
4136
4137 (defun erc-wash-quit-reason (reason nick login host)
4138 "Remove duplicate text from quit REASON.
4139 Specifically in relation to NICK (user@host) information. Returns REASON
4140 unmodified if nothing can be removed.
4141 E.g. \"Read error to Nick [user@some.host]: 110\" would be shortened to
4142 \"Read error: 110\". The same applies for \"Ping Timeout\"."
4143 (setq nick (regexp-quote nick)
4144 login (regexp-quote login)
4145 host (regexp-quote host))
4146 (or (when (string-match (concat "^\\(Read error\\) to "
4147 nick "\\[" host "\\]: "
4148 "\\(.+\\)$")
4149 reason)
4150 (concat (match-string 1 reason) ": " (match-string 2 reason)))
4151 (when (string-match (concat "^\\(Ping timeout\\) for "
4152 nick "\\[" host "\\]$")
4153 reason)
4154 (match-string 1 reason))
4155 reason))
4156
4157 (defun erc-nickname-in-use (nick reason)
4158 "If NICK is unavailable, tell the user the REASON.
4159
4160 See also `erc-display-error-notice'."
4161 (if (or (not erc-try-new-nick-p)
4162 ;; how many default-nicks are left + one more try...
4163 (eq erc-nick-change-attempt-count
4164 (if (consp erc-nick)
4165 (+ (length erc-nick) 1)
4166 1)))
4167 (erc-display-error-notice
4168 nil
4169 (format "Nickname %s is %s, try another." nick reason))
4170 (setq erc-nick-change-attempt-count (+ erc-nick-change-attempt-count 1))
4171 (let ((newnick (nth 1 erc-default-nicks))
4172 (nicklen (cdr (assoc "NICKLEN"
4173 (erc-with-server-buffer
4174 erc-server-parameters)))))
4175 (setq erc-bad-nick t)
4176 ;; try to use a different nick
4177 (if erc-default-nicks
4178 (setq erc-default-nicks (cdr erc-default-nicks)))
4179 (if (not newnick)
4180 (setq newnick (concat (truncate-string-to-width
4181 nick
4182 (if (and erc-server-connected nicklen)
4183 (- (string-to-number nicklen)
4184 (length erc-nick-uniquifier))
4185 ;; rfc2812 max nick length = 9
4186 ;; we must assume this is the
4187 ;; server's setting if we haven't
4188 ;; established a connection yet
4189 (- 9 (length erc-nick-uniquifier))))
4190 erc-nick-uniquifier)))
4191 (erc-cmd-NICK newnick)
4192 (erc-display-error-notice
4193 nil
4194 (format "Nickname %s is %s, trying %s"
4195 nick reason newnick)))))
4196
4197 ;;; Server messages
4198
4199 (defgroup erc-server-hooks nil
4200 "Server event callbacks.
4201 Every server event - like numeric replies - has its own hook.
4202 Those hooks are all called using `run-hook-with-args-until-success'.
4203 They receive as first argument the process object from where the event
4204 originated from,
4205 and as second argument the event parsed as a vector."
4206 :group 'erc-hooks)
4207
4208 (defun erc-display-server-message (_proc parsed)
4209 "Display the message sent by the server as a notice."
4210 (erc-display-message
4211 parsed 'notice 'active (erc-response.contents parsed)))
4212
4213 (defun erc-auto-query (proc parsed)
4214 ;; FIXME: This needs more documentation, unless it's not a user function --
4215 ;; Lawrence 2004-01-08
4216 "Put this on `erc-server-PRIVMSG-functions'."
4217 (when erc-auto-query
4218 (let* ((nick (car (erc-parse-user (erc-response.sender parsed))))
4219 (target (car (erc-response.command-args parsed)))
4220 (msg (erc-response.contents parsed))
4221 (query (if (not erc-query-on-unjoined-chan-privmsg)
4222 nick
4223 (if (erc-current-nick-p target)
4224 nick
4225 target))))
4226 (and (not (erc-ignored-user-p (erc-response.sender parsed)))
4227 (or erc-query-on-unjoined-chan-privmsg
4228 (string= target (erc-current-nick)))
4229 (not (erc-get-buffer query proc))
4230 (not (erc-is-message-ctcp-and-not-action-p msg))
4231 (let ((erc-query-display erc-auto-query))
4232 (erc-cmd-QUERY query))
4233 nil))))
4234
4235 (defun erc-is-message-ctcp-p (message)
4236 "Check if MESSAGE is a CTCP message or not."
4237 (string-match "^\C-a\\([^\C-a]*\\)\C-a?$" message))
4238
4239 (defun erc-is-message-ctcp-and-not-action-p (message)
4240 "Check if MESSAGE is a CTCP message or not."
4241 (and (erc-is-message-ctcp-p message)
4242 (not (string-match "^\C-a\\ACTION.*\C-a$" message))))
4243
4244 (defun erc-format-privmessage (nick msg privp msgp)
4245 "Format a PRIVMSG in an insertable fashion."
4246 (let* ((mark-s (if msgp (if privp "*" "<") "-"))
4247 (mark-e (if msgp (if privp "*" ">") "-"))
4248 (str (format "%s%s%s %s" mark-s nick mark-e msg))
4249 (nick-face (if privp 'erc-nick-msg-face 'erc-nick-default-face))
4250 (msg-face (if privp 'erc-direct-msg-face 'erc-default-face)))
4251 ;; add text properties to text before the nick, the nick and after the nick
4252 (erc-put-text-property 0 (length mark-s) 'face msg-face str)
4253 (erc-put-text-property (length mark-s) (+ (length mark-s) (length nick))
4254 'face nick-face str)
4255 (erc-put-text-property (+ (length mark-s) (length nick)) (length str)
4256 'face msg-face str)
4257 str))
4258
4259 (defcustom erc-format-nick-function 'erc-format-nick
4260 "Function to format a nickname for message display."
4261 :group 'erc-display
4262 :type 'function)
4263
4264 (defun erc-format-nick (&optional user _channel-data)
4265 "Return the nickname of USER.
4266 See also `erc-format-nick-function'."
4267 (when user (erc-server-user-nickname user)))
4268
4269 (defun erc-get-user-mode-prefix (user)
4270 (when user
4271 (cond ((erc-channel-user-owner-p user)
4272 (erc-propertize "~" 'help-echo "owner"))
4273 ((erc-channel-user-admin-p user)
4274 (erc-propertize "&" 'help-echo "admin"))
4275 ((erc-channel-user-op-p user)
4276 (erc-propertize "@" 'help-echo "operator"))
4277 ((erc-channel-user-halfop-p user)
4278 (erc-propertize "%" 'help-echo "half-op"))
4279 ((erc-channel-user-voice-p user)
4280 (erc-propertize "+" 'help-echo "voice"))
4281 (t ""))))
4282
4283 (defun erc-format-@nick (&optional user _channel-data)
4284 "Format the nickname of USER showing if USER has a voice, is an
4285 operator, half-op, admin or owner. Owners have \"~\", admins have
4286 \"&\", operators have \"@\" and users with voice have \"+\" as a
4287 prefix. Use CHANNEL-DATA to determine op and voice status. See
4288 also `erc-format-nick-function'."
4289 (when user
4290 (let ((nick (erc-server-user-nickname user)))
4291 (concat (erc-propertize
4292 (erc-get-user-mode-prefix nick)
4293 'face 'erc-nick-prefix-face)
4294 nick))))
4295
4296 (defun erc-format-my-nick ()
4297 "Return the beginning of this user's message, correctly propertized."
4298 (if erc-show-my-nick
4299 (let* ((open "<")
4300 (close "> ")
4301 (nick (erc-current-nick))
4302 (mode (erc-get-user-mode-prefix nick)))
4303 (concat
4304 (erc-propertize open 'face 'erc-default-face)
4305 (erc-propertize mode 'face 'erc-my-nick-prefix-face)
4306 (erc-propertize nick 'face 'erc-my-nick-face)
4307 (erc-propertize close 'face 'erc-default-face)))
4308 (let ((prefix "> "))
4309 (erc-propertize prefix 'face 'erc-default-face))))
4310
4311 (defun erc-echo-notice-in-default-buffer (s parsed buffer _sender)
4312 "Echos a private notice in the default buffer, namely the
4313 target buffer specified by BUFFER, or there is no target buffer,
4314 the server buffer. This function is designed to be added to
4315 either `erc-echo-notice-hook' or `erc-echo-notice-always-hook',
4316 and always returns t."
4317 (erc-display-message parsed nil buffer s)
4318 t)
4319
4320 (defun erc-echo-notice-in-target-buffer (s parsed buffer _sender)
4321 "Echos a private notice in BUFFER, if BUFFER is non-nil. This
4322 function is designed to be added to either `erc-echo-notice-hook'
4323 or `erc-echo-notice-always-hook', and returns non-nil if BUFFER
4324 is non-nil."
4325 (if buffer
4326 (progn (erc-display-message parsed nil buffer s) t)
4327 nil))
4328
4329 (defun erc-echo-notice-in-minibuffer (s _parsed _buffer _sender)
4330 "Echos a private notice in the minibuffer. This function is
4331 designed to be added to either `erc-echo-notice-hook' or
4332 `erc-echo-notice-always-hook', and always returns t."
4333 (message "%s" (concat "NOTICE: " s))
4334 t)
4335
4336 (defun erc-echo-notice-in-server-buffer (s parsed _buffer _sender)
4337 "Echos a private notice in the server buffer. This function is
4338 designed to be added to either `erc-echo-notice-hook' or
4339 `erc-echo-notice-always-hook', and always returns t."
4340 (erc-display-message parsed nil nil s)
4341 t)
4342
4343 (defun erc-echo-notice-in-active-non-server-buffer (s parsed _buffer _sender)
4344 "Echos a private notice in the active buffer if the active
4345 buffer is not the server buffer. This function is designed to be
4346 added to either `erc-echo-notice-hook' or
4347 `erc-echo-notice-always-hook', and returns non-nil if the active
4348 buffer is not the server buffer."
4349 (if (not (eq (erc-server-buffer) (erc-active-buffer)))
4350 (progn (erc-display-message parsed nil 'active s) t)
4351 nil))
4352
4353 (defun erc-echo-notice-in-active-buffer (s parsed _buffer _sender)
4354 "Echos a private notice in the active buffer. This function is
4355 designed to be added to either `erc-echo-notice-hook' or
4356 `erc-echo-notice-always-hook', and always returns t."
4357 (erc-display-message parsed nil 'active s)
4358 t)
4359
4360 (defun erc-echo-notice-in-user-buffers (s parsed _buffer sender)
4361 "Echos a private notice in all of the buffers for which SENDER
4362 is a member. This function is designed to be added to either
4363 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
4364 returns non-nil if there is at least one buffer for which the
4365 sender is a member.
4366
4367 See also: `erc-echo-notice-in-first-user-buffer',
4368 `erc-buffer-list-with-nick'."
4369 (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4370 (if buffers
4371 (progn (erc-display-message parsed nil buffers s) t)
4372 nil)))
4373
4374 (defun erc-echo-notice-in-user-and-target-buffers (s parsed buffer sender)
4375 "Echos a private notice in BUFFER and in all of the buffers for
4376 which SENDER is a member. This function is designed to be added
4377 to either `erc-echo-notice-hook' or
4378 `erc-echo-notice-always-hook', and returns non-nil if there is
4379 at least one buffer for which the sender is a member or the
4380 default target.
4381
4382 See also: `erc-echo-notice-in-user-buffers',
4383 `erc-buffer-list-with-nick'."
4384 (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4385 (unless (memq buffer buffers) (push buffer buffers))
4386 (if buffers ;FIXME: How could it be nil?
4387 (progn (erc-display-message parsed nil buffers s) t)
4388 nil)))
4389
4390 (defun erc-echo-notice-in-first-user-buffer (s parsed _buffer sender)
4391 "Echos a private notice in one of the buffers for which SENDER
4392 is a member. This function is designed to be added to either
4393 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
4394 returns non-nil if there is at least one buffer for which the
4395 sender is a member.
4396
4397 See also: `erc-echo-notice-in-user-buffers',
4398 `erc-buffer-list-with-nick'."
4399 (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4400 (if buffers
4401 (progn (erc-display-message parsed nil (car buffers) s) t)
4402 nil)))
4403
4404 ;;; Ban manipulation
4405
4406 (defun erc-banlist-store (proc parsed)
4407 "Record ban entries for a channel."
4408 (pcase-let ((`(,channel ,mask ,whoset)
4409 (cdr (erc-response.command-args parsed))))
4410 ;; Determine to which buffer the message corresponds
4411 (let ((buffer (erc-get-buffer channel proc)))
4412 (with-current-buffer buffer
4413 (unless (member (cons whoset mask) erc-channel-banlist)
4414 (setq erc-channel-banlist (cons (cons whoset mask)
4415 erc-channel-banlist))))))
4416 nil)
4417
4418 (defun erc-banlist-finished (proc parsed)
4419 "Record that we have received the banlist."
4420 (let* ((channel (nth 1 (erc-response.command-args parsed)))
4421 (buffer (erc-get-buffer channel proc)))
4422 (with-current-buffer buffer
4423 (put 'erc-channel-banlist 'received-from-server t)))
4424 t) ; suppress the 'end of banlist' message
4425
4426 (defun erc-banlist-update (proc parsed)
4427 "Check MODE commands for bans and update the banlist appropriately."
4428 ;; FIXME: Possibly incorrect. -- Lawrence 2004-05-11
4429 (let* ((tgt (car (erc-response.command-args parsed)))
4430 (mode (erc-response.contents parsed))
4431 (whoset (erc-response.sender parsed))
4432 (buffer (erc-get-buffer tgt proc)))
4433 (when buffer
4434 (with-current-buffer buffer
4435 (cond ((not (get 'erc-channel-banlist 'received-from-server)) nil)
4436 ((string-match "^\\([+-]\\)b" mode)
4437 ;; This is a ban
4438 (cond
4439 ((string-match "^-" mode)
4440 ;; Remove the unbanned masks from the ban list
4441 (setq erc-channel-banlist
4442 (erc-delete-if
4443 #'(lambda (y)
4444 (member (upcase (cdr y))
4445 (mapcar #'upcase
4446 (cdr (split-string mode)))))
4447 erc-channel-banlist)))
4448 ((string-match "^+" mode)
4449 ;; Add the banned mask(s) to the ban list
4450 (mapc
4451 (lambda (mask)
4452 (unless (member (cons whoset mask) erc-channel-banlist)
4453 (setq erc-channel-banlist
4454 (cons (cons whoset mask) erc-channel-banlist))))
4455 (cdr (split-string mode))))))))))
4456 nil)
4457
4458 ;; used for the banlist cmds
4459 (defun erc-group-list (list n)
4460 "Group LIST into sublists of length N."
4461 (cond ((null list) nil)
4462 ((null (nthcdr n list)) (list list))
4463 (t (cons (erc-subseq list 0 n) (erc-group-list (nthcdr n list) n)))))
4464
4465
4466 ;;; MOTD numreplies
4467
4468 (defun erc-handle-login ()
4469 "Handle the logging in process of connection."
4470 (unless erc-logged-in
4471 (setq erc-logged-in t)
4472 (message "Logging in as `%s'... done" (erc-current-nick))
4473 ;; execute a startup script
4474 (let ((f (erc-select-startup-file)))
4475 (when f
4476 (erc-load-script f)))))
4477
4478 (defun erc-connection-established (proc parsed)
4479 "Run just after connection.
4480
4481 Set user modes and run `erc-after-connect' hook."
4482 (with-current-buffer (process-buffer proc)
4483 (unless erc-server-connected ; only once per session
4484 (let ((server (or erc-server-announced-name
4485 (erc-response.sender parsed)))
4486 (nick (car (erc-response.command-args parsed)))
4487 (buffer (process-buffer proc)))
4488 (setq erc-server-connected t)
4489 (setq erc-server-reconnect-count 0)
4490 (erc-update-mode-line)
4491 (erc-set-initial-user-mode nick buffer)
4492 (erc-server-setup-periodical-ping buffer)
4493 (run-hook-with-args 'erc-after-connect server nick)))))
4494
4495 (defun erc-set-initial-user-mode (nick buffer)
4496 "If `erc-user-mode' is non-nil for NICK, set the user modes.
4497 The server buffer is given by BUFFER."
4498 (with-current-buffer buffer
4499 (when erc-user-mode
4500 (let ((mode (if (functionp erc-user-mode)
4501 (funcall erc-user-mode)
4502 erc-user-mode)))
4503 (when (stringp mode)
4504 (erc-log (format "changing mode for %s to %s" nick mode))
4505 (erc-server-send (format "MODE %s %s" nick mode)))))))
4506
4507 (defun erc-display-error-notice (parsed string)
4508 "Display STRING as an error notice.
4509
4510 See also `erc-display-message'."
4511 (erc-display-message
4512 parsed '(notice error) 'active string))
4513
4514 (defun erc-process-ctcp-query (proc parsed nick login host)
4515 ;; FIXME: This needs a proper docstring -- Lawrence 2004-01-08
4516 "Process a CTCP query."
4517 (let ((queries (delete "" (split-string (erc-response.contents parsed)
4518 "\C-a"))))
4519 (if (> (length queries) 4)
4520 (erc-display-message
4521 parsed (list 'notice 'error) proc 'ctcp-too-many)
4522 (if (= 0 (length queries))
4523 (erc-display-message
4524 parsed (list 'notice 'error) proc
4525 'ctcp-empty ?n nick)
4526 (while queries
4527 (let* ((type (upcase (car (split-string (car queries)))))
4528 (hook (intern-soft (concat "erc-ctcp-query-" type "-hook"))))
4529 (if (and hook (boundp hook))
4530 (if (string-equal type "ACTION")
4531 (run-hook-with-args-until-success
4532 hook proc parsed nick login host
4533 (car (erc-response.command-args parsed))
4534 (car queries))
4535 (when erc-paranoid
4536 (if (erc-current-nick-p
4537 (car (erc-response.command-args parsed)))
4538 (erc-display-message
4539 parsed 'error 'active 'ctcp-request
4540 ?n nick ?u login ?h host ?r (car queries))
4541 (erc-display-message
4542 parsed 'error 'active 'ctcp-request-to
4543 ?n nick ?u login ?h host ?r (car queries)
4544 ?t (car (erc-response.command-args parsed)))))
4545 (run-hook-with-args-until-success
4546 hook proc nick login host
4547 (car (erc-response.command-args parsed))
4548 (car queries)))
4549 (erc-display-message
4550 parsed (list 'notice 'error) proc
4551 'undefined-ctcp)))
4552 (setq queries (cdr queries)))))))
4553
4554 (defvar erc-ctcp-query-ACTION-hook '(erc-ctcp-query-ACTION))
4555
4556 (defun erc-ctcp-query-ACTION (proc parsed nick login host to msg)
4557 "Respond to a CTCP ACTION query."
4558 (when (string-match "^ACTION\\s-\\(.*\\)\\s-*$" msg)
4559 (let ((s (match-string 1 msg))
4560 (buf (or (erc-get-buffer to proc)
4561 (erc-get-buffer nick proc)
4562 (process-buffer proc))))
4563 (erc-display-message
4564 parsed 'action buf
4565 'ACTION ?n nick ?u login ?h host ?a s))))
4566
4567 (defvar erc-ctcp-query-CLIENTINFO-hook '(erc-ctcp-query-CLIENTINFO))
4568
4569 (defun erc-ctcp-query-CLIENTINFO (_proc nick _login _host _to msg)
4570 "Respond to a CTCP CLIENTINFO query."
4571 (when (string-match "^CLIENTINFO\\(\\s-*\\|\\s-+.*\\)$" msg)
4572 (let ((s (erc-client-info (erc-trim-string (match-string 1 msg)))))
4573 (unless erc-disable-ctcp-replies
4574 (erc-send-ctcp-notice nick (format "CLIENTINFO %s" s)))))
4575 nil)
4576
4577 (defvar erc-ctcp-query-ECHO-hook '(erc-ctcp-query-ECHO))
4578 (defun erc-ctcp-query-ECHO (_proc nick _login _host _to msg)
4579 "Respond to a CTCP ECHO query."
4580 (when (string-match "^ECHO\\s-+\\(.*\\)\\s-*$" msg)
4581 (let ((s (match-string 1 msg)))
4582 (unless erc-disable-ctcp-replies
4583 (erc-send-ctcp-notice nick (format "ECHO %s" s)))))
4584 nil)
4585
4586 (defvar erc-ctcp-query-FINGER-hook '(erc-ctcp-query-FINGER))
4587 (defun erc-ctcp-query-FINGER (_proc nick _login _host _to _msg)
4588 "Respond to a CTCP FINGER query."
4589 (unless erc-disable-ctcp-replies
4590 (let ((s (if erc-anonymous-login
4591 (format "FINGER I'm %s." (erc-current-nick))
4592 (format "FINGER %s (%s@%s)."
4593 (user-full-name)
4594 (user-login-name)
4595 (system-name))))
4596 (ns (erc-time-diff erc-server-last-sent-time (erc-current-time))))
4597 (when (> ns 0)
4598 (setq s (concat s " Idle for " (erc-sec-to-time ns))))
4599 (erc-send-ctcp-notice nick s)))
4600 nil)
4601
4602 (defvar erc-ctcp-query-PING-hook '(erc-ctcp-query-PING))
4603 (defun erc-ctcp-query-PING (_proc nick _login _host _to msg)
4604 "Respond to a CTCP PING query."
4605 (when (string-match "^PING\\s-+\\(.*\\)" msg)
4606 (unless erc-disable-ctcp-replies
4607 (let ((arg (match-string 1 msg)))
4608 (erc-send-ctcp-notice nick (format "PING %s" arg)))))
4609 nil)
4610
4611 (defvar erc-ctcp-query-TIME-hook '(erc-ctcp-query-TIME))
4612 (defun erc-ctcp-query-TIME (_proc nick _login _host _to _msg)
4613 "Respond to a CTCP TIME query."
4614 (unless erc-disable-ctcp-replies
4615 (erc-send-ctcp-notice nick (format "TIME %s" (current-time-string))))
4616 nil)
4617
4618 (defvar erc-ctcp-query-USERINFO-hook '(erc-ctcp-query-USERINFO))
4619 (defun erc-ctcp-query-USERINFO (_proc nick _login _host _to _msg)
4620 "Respond to a CTCP USERINFO query."
4621 (unless erc-disable-ctcp-replies
4622 (erc-send-ctcp-notice nick (format "USERINFO %s" erc-user-information)))
4623 nil)
4624
4625 (defvar erc-ctcp-query-VERSION-hook '(erc-ctcp-query-VERSION))
4626 (defun erc-ctcp-query-VERSION (_proc nick _login _host _to _msg)
4627 "Respond to a CTCP VERSION query."
4628 (unless erc-disable-ctcp-replies
4629 (erc-send-ctcp-notice
4630 nick (format
4631 "VERSION \C-bERC\C-b - an IRC client for Emacs %s (\C-b%s\C-b)"
4632 emacs-version
4633 erc-official-location)))
4634 nil)
4635
4636 (defun erc-process-ctcp-reply (proc parsed nick login host msg)
4637 "Process MSG as a CTCP reply."
4638 (let* ((type (car (split-string msg)))
4639 (hook (intern (concat "erc-ctcp-reply-" type "-hook"))))
4640 (if (boundp hook)
4641 (run-hook-with-args-until-success
4642 hook proc nick login host
4643 (car (erc-response.command-args parsed)) msg)
4644 (erc-display-message
4645 parsed 'notice 'active
4646 'CTCP-UNKNOWN ?n nick ?u login ?h host ?m msg))))
4647
4648 (defvar erc-ctcp-reply-ECHO-hook '(erc-ctcp-reply-ECHO))
4649 (defun erc-ctcp-reply-ECHO (_proc nick _login _host _to msg)
4650 "Handle a CTCP ECHO reply."
4651 (when (string-match "^ECHO\\s-+\\(.*\\)\\s-*$" msg)
4652 (let ((message (match-string 1 msg)))
4653 (erc-display-message
4654 nil '(notice action) 'active
4655 'CTCP-ECHO ?n nick ?m message)))
4656 nil)
4657
4658 (defvar erc-ctcp-reply-CLIENTINFO-hook '(erc-ctcp-reply-CLIENTINFO))
4659 (defun erc-ctcp-reply-CLIENTINFO (_proc nick _login _host _to msg)
4660 "Handle a CTCP CLIENTINFO reply."
4661 (when (string-match "^CLIENTINFO\\s-+\\(.*\\)\\s-*$" msg)
4662 (let ((message (match-string 1 msg)))
4663 (erc-display-message
4664 nil 'notice 'active
4665 'CTCP-CLIENTINFO ?n nick ?m message)))
4666 nil)
4667
4668 (defvar erc-ctcp-reply-FINGER-hook '(erc-ctcp-reply-FINGER))
4669 (defun erc-ctcp-reply-FINGER (_proc nick _login _host _to msg)
4670 "Handle a CTCP FINGER reply."
4671 (when (string-match "^FINGER\\s-+\\(.*\\)\\s-*$" msg)
4672 (let ((message (match-string 1 msg)))
4673 (erc-display-message
4674 nil 'notice 'active
4675 'CTCP-FINGER ?n nick ?m message)))
4676 nil)
4677
4678 (defvar erc-ctcp-reply-PING-hook '(erc-ctcp-reply-PING))
4679 (defun erc-ctcp-reply-PING (_proc nick _login _host _to msg)
4680 "Handle a CTCP PING reply."
4681 (if (not (string-match "^PING\\s-+\\([0-9.]+\\)" msg))
4682 nil
4683 (let ((time (match-string 1 msg)))
4684 (condition-case nil
4685 (let ((delta (erc-time-diff (string-to-number time)
4686 (erc-current-time))))
4687 (erc-display-message
4688 nil 'notice 'active
4689 'CTCP-PING ?n nick
4690 ?t (erc-sec-to-time delta)))
4691 (range-error
4692 (erc-display-message
4693 nil 'error 'active
4694 'bad-ping-response ?n nick ?t time))))))
4695
4696 (defvar erc-ctcp-reply-TIME-hook '(erc-ctcp-reply-TIME))
4697 (defun erc-ctcp-reply-TIME (_proc nick _login _host _to msg)
4698 "Handle a CTCP TIME reply."
4699 (when (string-match "^TIME\\s-+\\(.*\\)\\s-*$" msg)
4700 (let ((message (match-string 1 msg)))
4701 (erc-display-message
4702 nil 'notice 'active
4703 'CTCP-TIME ?n nick ?m message)))
4704 nil)
4705
4706 (defvar erc-ctcp-reply-VERSION-hook '(erc-ctcp-reply-VERSION))
4707 (defun erc-ctcp-reply-VERSION (_proc nick _login _host _to msg)
4708 "Handle a CTCP VERSION reply."
4709 (when (string-match "^VERSION\\s-+\\(.*\\)\\s-*$" msg)
4710 (let ((message (match-string 1 msg)))
4711 (erc-display-message
4712 nil 'notice 'active
4713 'CTCP-VERSION ?n nick ?m message)))
4714 nil)
4715
4716 (defun erc-process-away (proc away-p)
4717 "Toggle the away status of the user depending on the value of AWAY-P.
4718
4719 If nil, set the user as away.
4720 If non-nil, return from being away."
4721 (let ((sessionbuf (process-buffer proc)))
4722 (when sessionbuf
4723 (with-current-buffer sessionbuf
4724 (when erc-away-nickname
4725 (erc-log (format "erc-process-away: away-nick: %s, away-p: %s"
4726 erc-away-nickname away-p))
4727 (erc-cmd-NICK (if away-p
4728 erc-away-nickname
4729 erc-nick)))
4730 (cond
4731 (away-p
4732 (setq erc-away (current-time)))
4733 (t
4734 (let ((away-time erc-away))
4735 ;; away must be set to NIL BEFORE sending anything to prevent
4736 ;; an infinite recursion
4737 (setq erc-away nil)
4738 (with-current-buffer (erc-active-buffer)
4739 (when erc-public-away-p
4740 (erc-send-action
4741 (erc-default-target)
4742 (if away-time
4743 (format "is back (gone for %s)"
4744 (erc-sec-to-time
4745 (erc-time-diff
4746 (erc-emacs-time-to-erc-time away-time)
4747 (erc-current-time))))
4748 "is back")))))))))
4749 (erc-update-mode-line)))
4750
4751 ;;;; List of channel members handling
4752
4753 (defun erc-channel-begin-receiving-names ()
4754 "Internal function.
4755
4756 Used when a channel names list is about to be received. Should
4757 be called with the current buffer set to the channel buffer.
4758
4759 See also `erc-channel-end-receiving-names'."
4760 (setq erc-channel-new-member-names (make-hash-table :test 'equal)))
4761
4762 (defun erc-channel-end-receiving-names ()
4763 "Internal function.
4764
4765 Used to fix `erc-channel-users' after a channel names list has been
4766 received. Should be called with the current buffer set to the
4767 channel buffer.
4768
4769 See also `erc-channel-begin-receiving-names'."
4770 (maphash (lambda (nick _user)
4771 (if (null (gethash nick erc-channel-new-member-names))
4772 (erc-remove-channel-user nick)))
4773 erc-channel-users)
4774 (setq erc-channel-new-member-names nil))
4775
4776 (defun erc-parse-prefix ()
4777 "Return an alist of valid prefix character types and their representations.
4778 Example: (operator) o => @, (voiced) v => +."
4779 (let ((str (or (cdr (assoc "PREFIX" (erc-with-server-buffer
4780 erc-server-parameters)))
4781 ;; provide a sane default
4782 "(qaohv)~&@%+"))
4783 types chars)
4784 (when (string-match "^(\\([^)]+\\))\\(.+\\)$" str)
4785 (setq types (match-string 1 str)
4786 chars (match-string 2 str))
4787 (let ((len (min (length types) (length chars)))
4788 (i 0)
4789 (alist nil))
4790 (while (< i len)
4791 (setq alist (cons (cons (elt types i) (elt chars i))
4792 alist))
4793 (setq i (1+ i)))
4794 alist))))
4795
4796 (defun erc-channel-receive-names (names-string)
4797 "This function is for internal use only.
4798
4799 Update `erc-channel-users' according to NAMES-STRING.
4800 NAMES-STRING is a string listing some of the names on the
4801 channel."
4802 (let* ((prefix (erc-parse-prefix))
4803 (voice-ch (cdr (assq ?v prefix)))
4804 (op-ch (cdr (assq ?o prefix)))
4805 (hop-ch (cdr (assq ?h prefix)))
4806 (adm-ch (cdr (assq ?a prefix)))
4807 (own-ch (cdr (assq ?q prefix)))
4808 (names (delete "" (split-string names-string)))
4809 name op voice halfop admin owner)
4810 (let ((erc-channel-members-changed-hook nil))
4811 (dolist (item names)
4812 (let ((updatep t)
4813 (ch (aref item 0)))
4814 (setq name item op 'off voice 'off halfop 'off admin 'off owner 'off)
4815 (if (rassq ch prefix)
4816 (if (= (length item) 1)
4817 (setq updatep nil)
4818 (setq name (substring item 1))
4819 (setf (pcase ch
4820 ((pred (eq voice-ch)) voice)
4821 ((pred (eq hop-ch)) halfop)
4822 ((pred (eq op-ch)) op)
4823 ((pred (eq adm-ch)) admin)
4824 ((pred (eq own-ch)) owner)
4825 (_ (error "Unknown prefix char `%S'" ch) voice))
4826 'on)))
4827 (when updatep
4828 (puthash (erc-downcase name) t
4829 erc-channel-new-member-names)
4830 (erc-update-current-channel-member
4831 name name t voice halfop op admin owner)))))
4832 (run-hooks 'erc-channel-members-changed-hook)))
4833
4834
4835 (defcustom erc-channel-members-changed-hook nil
4836 "This hook is called every time the variable `channel-members' changes.
4837 The buffer where the change happened is current while this hook is called."
4838 :group 'erc-hooks
4839 :type 'hook)
4840
4841 (defun erc-update-user-nick (nick &optional new-nick
4842 host login full-name info)
4843 "Update the stored user information for the user with nickname NICK.
4844
4845 See also: `erc-update-user'."
4846 (erc-update-user (erc-get-server-user nick) new-nick
4847 host login full-name info))
4848
4849 (defun erc-update-user (user &optional new-nick
4850 host login full-name info)
4851 "Update user info for USER. USER must be an erc-server-user
4852 struct. Any of NEW-NICK, HOST, LOGIN, FULL-NAME, INFO which are
4853 non-nil and not equal to the existing values for USER are used to
4854 replace the stored values in USER.
4855
4856 If, and only if, a change is made,
4857 `erc-channel-members-changed-hook' is run for each channel for
4858 which USER is a member, and t is returned."
4859 (let (changed)
4860 (when user
4861 (when (and new-nick
4862 (not (equal (erc-server-user-nickname user)
4863 new-nick)))
4864 (setq changed t)
4865 (erc-change-user-nickname user new-nick))
4866 (when (and host
4867 (not (equal (erc-server-user-host user) host)))
4868 (setq changed t)
4869 (setf (erc-server-user-host user) host))
4870 (when (and login
4871 (not (equal (erc-server-user-login user) login)))
4872 (setq changed t)
4873 (setf (erc-server-user-login user) login))
4874 (when (and full-name
4875 (not (equal (erc-server-user-full-name user)
4876 full-name)))
4877 (setq changed t)
4878 (setf (erc-server-user-full-name user) full-name))
4879 (when (and info
4880 (not (equal (erc-server-user-info user) info)))
4881 (setq changed t)
4882 (setf (erc-server-user-info user) info))
4883 (if changed
4884 (dolist (buf (erc-server-user-buffers user))
4885 (if (buffer-live-p buf)
4886 (with-current-buffer buf
4887 (run-hooks 'erc-channel-members-changed-hook))))))
4888 changed))
4889
4890 (defun erc-update-current-channel-member
4891 (nick new-nick &optional add voice halfop op admin owner host login full-name info
4892 update-message-time)
4893 "Update the stored user information for the user with nickname NICK.
4894 `erc-update-user' is called to handle changes to nickname,
4895 HOST, LOGIN, FULL-NAME, and INFO. If VOICE HALFOP OP ADMIN or OWNER
4896 are non-nil, they must be equal to either `on' or `off', in which
4897 case the status of the user in the current channel is changed accordingly.
4898 If UPDATE-MESSAGE-TIME is non-nil, the last-message-time of the user
4899 in the current channel is set to (current-time).
4900
4901 If ADD is non-nil, the user will be added with the specified
4902 information if it is not already present in the user or channel
4903 lists.
4904
4905 If, and only if, changes are made, or the user is added,
4906 `erc-channel-members-updated-hook' is run, and t is returned.
4907
4908 See also: `erc-update-user' and `erc-update-channel-member'."
4909 (let* (changed user-changed
4910 (channel-data (erc-get-channel-user nick))
4911 (cuser (cdr channel-data))
4912 (user (if channel-data (car channel-data)
4913 (erc-get-server-user nick))))
4914 (if cuser
4915 (progn
4916 (erc-log (format "update-member: user = %S, cuser = %S" user cuser))
4917 (when (and voice
4918 (not (eq (erc-channel-user-voice cuser) voice)))
4919 (setq changed t)
4920 (setf (erc-channel-user-voice cuser)
4921 (cond ((eq voice 'on) t)
4922 ((eq voice 'off) nil)
4923 (t voice))))
4924 (when (and halfop
4925 (not (eq (erc-channel-user-halfop cuser) halfop)))
4926 (setq changed t)
4927 (setf (erc-channel-user-halfop cuser)
4928 (cond ((eq halfop 'on) t)
4929 ((eq halfop 'off) nil)
4930 (t halfop))))
4931 (when (and op
4932 (not (eq (erc-channel-user-op cuser) op)))
4933 (setq changed t)
4934 (setf (erc-channel-user-op cuser)
4935 (cond ((eq op 'on) t)
4936 ((eq op 'off) nil)
4937 (t op))))
4938 (when (and admin
4939 (not (eq (erc-channel-user-admin cuser) admin)))
4940 (setq changed t)
4941 (setf (erc-channel-user-admin cuser)
4942 (cond ((eq admin 'on) t)
4943 ((eq admin 'off) nil)
4944 (t admin))))
4945 (when (and owner
4946 (not (eq (erc-channel-user-owner cuser) owner)))
4947 (setq changed t)
4948 (setf (erc-channel-user-owner cuser)
4949 (cond ((eq owner 'on) t)
4950 ((eq owner 'off) nil)
4951 (t owner))))
4952 (when update-message-time
4953 (setf (erc-channel-user-last-message-time cuser) (current-time)))
4954 (setq user-changed
4955 (erc-update-user user new-nick
4956 host login full-name info)))
4957 (when add
4958 (if (null user)
4959 (progn
4960 (setq user (make-erc-server-user
4961 :nickname nick
4962 :host host
4963 :full-name full-name
4964 :login login
4965 :info info
4966 :buffers (list (current-buffer))))
4967 (erc-add-server-user nick user))
4968 (setf (erc-server-user-buffers user)
4969 (cons (current-buffer)
4970 (erc-server-user-buffers user))))
4971 (setq cuser (make-erc-channel-user
4972 :voice (cond ((eq voice 'on) t)
4973 ((eq voice 'off) nil)
4974 (t voice))
4975 :halfop (cond ((eq halfop 'on) t)
4976 ((eq halfop 'off) nil)
4977 (t halfop))
4978 :op (cond ((eq op 'on) t)
4979 ((eq op 'off) nil)
4980 (t op))
4981 :admin (cond ((eq admin 'on) t)
4982 ((eq admin 'off) nil)
4983 (t admin))
4984 :owner (cond ((eq owner 'on) t)
4985 ((eq owner 'off) nil)
4986 (t owner))
4987 :last-message-time
4988 (if update-message-time (current-time))))
4989 (puthash (erc-downcase nick) (cons user cuser)
4990 erc-channel-users)
4991 (setq changed t)))
4992 (when (and changed (null user-changed))
4993 (run-hooks 'erc-channel-members-changed-hook))
4994 (or changed user-changed add)))
4995
4996 (defun erc-update-channel-member (channel nick new-nick
4997 &optional add voice halfop op admin owner host login
4998 full-name info update-message-time)
4999 "Update user and channel information for the user with
5000 nickname NICK in channel CHANNEL.
5001
5002 See also: `erc-update-current-channel-member'."
5003 (erc-with-buffer
5004 (channel)
5005 (erc-update-current-channel-member nick new-nick add voice halfop op admin owner host
5006 login full-name info
5007 update-message-time)))
5008
5009 (defun erc-remove-current-channel-member (nick)
5010 "Remove NICK from current channel membership list.
5011 Runs `erc-channel-members-changed-hook'."
5012 (let ((channel-data (erc-get-channel-user nick)))
5013 (when channel-data
5014 (erc-remove-channel-user nick)
5015 (run-hooks 'erc-channel-members-changed-hook))))
5016
5017 (defun erc-remove-channel-member (channel nick)
5018 "Remove NICK from CHANNEL's membership list.
5019
5020 See also `erc-remove-current-channel-member'."
5021 (erc-with-buffer
5022 (channel)
5023 (erc-remove-current-channel-member nick)))
5024
5025 (defun erc-update-channel-topic (channel topic &optional modify)
5026 "Find a buffer for CHANNEL and set the TOPIC for it.
5027
5028 If optional MODIFY is 'append or 'prepend, then append or prepend the
5029 TOPIC string to the current topic."
5030 (erc-with-buffer (channel)
5031 (cond ((eq modify 'append)
5032 (setq erc-channel-topic (concat erc-channel-topic topic)))
5033 ((eq modify 'prepend)
5034 (setq erc-channel-topic (concat topic erc-channel-topic)))
5035 (t (setq erc-channel-topic topic)))
5036 (erc-update-mode-line-buffer (current-buffer))))
5037
5038 (defun erc-set-modes (tgt mode-string)
5039 "Set the modes for the TGT provided as MODE-STRING."
5040 (let* ((modes (erc-parse-modes mode-string))
5041 (add-modes (nth 0 modes))
5042 ;; list of triples: (mode-char 'on/'off argument)
5043 (arg-modes (nth 2 modes)))
5044 (cond ((erc-channel-p tgt); channel modes
5045 (let ((buf (and erc-server-process
5046 (erc-get-buffer tgt erc-server-process))))
5047 (when buf
5048 (with-current-buffer buf
5049 (setq erc-channel-modes add-modes)
5050 (setq erc-channel-user-limit nil)
5051 (setq erc-channel-key nil)
5052 (while arg-modes
5053 (let ((mode (nth 0 (car arg-modes)))
5054 (onoff (nth 1 (car arg-modes)))
5055 (arg (nth 2 (car arg-modes))))
5056 (cond ((string-match "^[Ll]" mode)
5057 (erc-update-channel-limit tgt onoff arg))
5058 ((string-match "^[Kk]" mode)
5059 (erc-update-channel-key tgt onoff arg))
5060 (t nil)))
5061 (setq arg-modes (cdr arg-modes)))
5062 (erc-update-mode-line-buffer buf)))))
5063 ;; we do not keep our nick's modes yet
5064 ;;(t (setq erc-user-modes add-modes))
5065 )
5066 ))
5067
5068 (defun erc-sort-strings (list-of-strings)
5069 "Sort LIST-OF-STRINGS in lexicographic order.
5070
5071 Side-effect free."
5072 (sort (copy-sequence list-of-strings) 'string<))
5073
5074 (defun erc-parse-modes (mode-string)
5075 "Parse MODE-STRING into a list.
5076
5077 Returns a list of three elements:
5078
5079 (ADD-MODES REMOVE-MODES ARG-MODES).
5080
5081 The add-modes and remove-modes are lists of single-character strings
5082 for modes without parameters to add and remove respectively. The
5083 arg-modes is a list of triples of the form:
5084
5085 (MODE-CHAR ON/OFF ARGUMENT)."
5086 (if (string-match "^\\s-*\\(\\S-+\\)\\(\\s-.*$\\|$\\)" mode-string)
5087 (let ((chars (mapcar #'char-to-string (match-string 1 mode-string)))
5088 ;; arguments in channel modes
5089 (args-str (match-string 2 mode-string))
5090 (args nil)
5091 (add-modes nil)
5092 (remove-modes nil)
5093 (arg-modes nil); list of triples: (mode-char 'on/'off argument)
5094 (add-p t))
5095 ;; make the argument list
5096 (while (string-match "^\\s-*\\(\\S-+\\)\\(\\s-+.*$\\|$\\)" args-str)
5097 (setq args (cons (match-string 1 args-str) args))
5098 (setq args-str (match-string 2 args-str)))
5099 (setq args (nreverse args))
5100 ;; collect what modes changed, and match them with arguments
5101 (while chars
5102 (cond ((string= (car chars) "+") (setq add-p t))
5103 ((string= (car chars) "-") (setq add-p nil))
5104 ((string-match "^[qaovhbQAOVHB]" (car chars))
5105 (setq arg-modes (cons (list (car chars)
5106 (if add-p 'on 'off)
5107 (if args (car args) nil))
5108 arg-modes))
5109 (if args (setq args (cdr args))))
5110 ((string-match "^[LlKk]" (car chars))
5111 (setq arg-modes (cons (list (car chars)
5112 (if add-p 'on 'off)
5113 (if (and add-p args)
5114 (car args) nil))
5115 arg-modes))
5116 (if (and add-p args) (setq args (cdr args))))
5117 (add-p (setq add-modes (cons (car chars) add-modes)))
5118 (t (setq remove-modes (cons (car chars) remove-modes))))
5119 (setq chars (cdr chars)))
5120 (setq add-modes (nreverse add-modes))
5121 (setq remove-modes (nreverse remove-modes))
5122 (setq arg-modes (nreverse arg-modes))
5123 (list add-modes remove-modes arg-modes))
5124 nil))
5125
5126 (defun erc-update-modes (tgt mode-string &optional _nick _host _login)
5127 "Update the mode information for TGT, provided as MODE-STRING.
5128 Optional arguments: NICK, HOST and LOGIN - the attributes of the
5129 person who changed the modes."
5130 ;; FIXME: neither of nick, host, and login are used!
5131 (let* ((modes (erc-parse-modes mode-string))
5132 (add-modes (nth 0 modes))
5133 (remove-modes (nth 1 modes))
5134 ;; list of triples: (mode-char 'on/'off argument)
5135 (arg-modes (nth 2 modes)))
5136 ;; now parse the modes changes and do the updates
5137 (cond ((erc-channel-p tgt); channel modes
5138 (let ((buf (and erc-server-process
5139 (erc-get-buffer tgt erc-server-process))))
5140 (when buf
5141 ;; FIXME! This used to have an original buffer
5142 ;; variable, but it never switched back to the original
5143 ;; buffer. Is this wanted behavior?
5144 (set-buffer buf)
5145 (if (not (boundp 'erc-channel-modes))
5146 (setq erc-channel-modes nil))
5147 (while remove-modes
5148 (setq erc-channel-modes (delete (car remove-modes)
5149 erc-channel-modes)
5150 remove-modes (cdr remove-modes)))
5151 (while add-modes
5152 (setq erc-channel-modes (cons (car add-modes)
5153 erc-channel-modes)
5154 add-modes (cdr add-modes)))
5155 (setq erc-channel-modes (erc-sort-strings erc-channel-modes))
5156 (while arg-modes
5157 (let ((mode (nth 0 (car arg-modes)))
5158 (onoff (nth 1 (car arg-modes)))
5159 (arg (nth 2 (car arg-modes))))
5160 (cond ((string-match "^[Vv]" mode)
5161 (erc-update-channel-member tgt arg arg nil onoff))
5162 ((string-match "^[hH]" mode)
5163 (erc-update-channel-member tgt arg arg nil nil onoff))
5164 ((string-match "^[oO]" mode)
5165 (erc-update-channel-member tgt arg arg nil nil nil onoff))
5166 ((string-match "^[aA]" mode)
5167 (erc-update-channel-member tgt arg arg nil nil nil nil onoff))
5168 ((string-match "^[qQ]" mode)
5169 (erc-update-channel-member tgt arg arg nil nil nil nil nil onoff))
5170 ((string-match "^[Ll]" mode)
5171 (erc-update-channel-limit tgt onoff arg))
5172 ((string-match "^[Kk]" mode)
5173 (erc-update-channel-key tgt onoff arg))
5174 (t nil)); only ops are tracked now
5175 (setq arg-modes (cdr arg-modes))))
5176 (erc-update-mode-line buf))))
5177 ;; nick modes - ignored at this point
5178 (t nil))))
5179
5180 (defun erc-update-channel-limit (channel onoff n)
5181 ;; FIXME: what does ONOFF actually do? -- Lawrence 2004-01-08
5182 "Update CHANNEL's user limit to N."
5183 (if (or (not (eq onoff 'on))
5184 (and (stringp n) (string-match "^[0-9]+$" n)))
5185 (erc-with-buffer
5186 (channel)
5187 (cond ((eq onoff 'on) (setq erc-channel-user-limit (string-to-number n)))
5188 (t (setq erc-channel-user-limit nil))))))
5189
5190 (defun erc-update-channel-key (channel onoff key)
5191 "Update CHANNEL's key to KEY if ONOFF is 'on or to nil if it's 'off."
5192 (erc-with-buffer
5193 (channel)
5194 (cond ((eq onoff 'on) (setq erc-channel-key key))
5195 (t (setq erc-channel-key nil)))))
5196
5197 (defun erc-handle-user-status-change (type nlh &optional l)
5198 "Handle changes in any user's status.
5199
5200 So far, only nick change is handled.
5201
5202 Generally, the TYPE argument is a symbol describing the change type, NLH is
5203 a list containing the original nickname, login name and hostname for the user,
5204 and L is a list containing additional TYPE-specific arguments.
5205
5206 So far the following TYPE/L pairs are supported:
5207
5208 Event TYPE L
5209
5210 nickname change `nick' (NEW-NICK)"
5211 (erc-log (format "user-change: type: %S nlh: %S l: %S" type nlh l))
5212 (cond
5213 ;; nickname change
5214 ((equal type 'nick)
5215 t)
5216 (t
5217 nil)))
5218
5219 (defun erc-highlight-notice (s)
5220 "Highlight notice message S and return it.
5221 See also variable `erc-notice-highlight-type'."
5222 (cond
5223 ((eq erc-notice-highlight-type 'prefix)
5224 (erc-put-text-property 0 (length erc-notice-prefix)
5225 'face 'erc-notice-face s)
5226 s)
5227 ((eq erc-notice-highlight-type 'all)
5228 (erc-put-text-property 0 (length s) 'face 'erc-notice-face s)
5229 s)
5230 (t s)))
5231
5232 (defun erc-make-notice (message)
5233 "Notify the user of MESSAGE."
5234 (when erc-minibuffer-notice
5235 (message "%s" message))
5236 (erc-highlight-notice (concat erc-notice-prefix message)))
5237
5238 (defun erc-highlight-error (s)
5239 "Highlight error message S and return it."
5240 (erc-put-text-property 0 (length s) 'face 'erc-error-face s)
5241 s)
5242
5243 (defun erc-put-text-property (start end property value &optional object)
5244 "Set text-property for an object (usually a string).
5245 START and END define the characters covered.
5246 PROPERTY is the text-property set, usually the symbol `face'.
5247 VALUE is the value for the text-property, usually a face symbol such as
5248 the face `bold' or `erc-pal-face'.
5249 OBJECT is a string which will be modified and returned.
5250 OBJECT is modified without being copied first.
5251
5252 You can redefine or `defadvice' this function in order to add
5253 EmacsSpeak support."
5254 (put-text-property start end property value object))
5255
5256 (defun erc-list (thing)
5257 "Return THING if THING is a list, or a list with THING as its element."
5258 (if (listp thing)
5259 thing
5260 (list thing)))
5261
5262 (defun erc-parse-user (string)
5263 "Parse STRING as a user specification (nick!login@host).
5264
5265 Return a list of the three separate tokens."
5266 (cond
5267 ((string-match "^\\([^!\n]*\\)!\\([^@\n]*\\)@\\(.*\\)$" string)
5268 (list (match-string 1 string)
5269 (match-string 2 string)
5270 (match-string 3 string)))
5271 ;; Some bogus bouncers send Nick!(null), try to live with that.
5272 ((string-match "^\\([^!\n]*\\)!\\(.*\\)$" string)
5273 (list (match-string 1 string)
5274 ""
5275 (match-string 2 string)))
5276 (t
5277 (list string "" ""))))
5278
5279 (defun erc-extract-nick (string)
5280 "Return the nick corresponding to a user specification STRING.
5281
5282 See also `erc-parse-user'."
5283 (car (erc-parse-user string)))
5284
5285 (defun erc-put-text-properties (start end properties
5286 &optional object value-list)
5287 "Set text-properties for OBJECT.
5288
5289 START and END describe positions in OBJECT.
5290 If VALUE-LIST is nil, set each property in PROPERTIES to t, else set
5291 each property to the corresponding value in VALUE-LIST."
5292 (unless value-list
5293 (setq value-list (mapcar (lambda (_x) t)
5294 properties)))
5295 (while (and properties value-list)
5296 (erc-put-text-property
5297 start end (pop properties) (pop value-list) object)))
5298
5299 ;;; Input area handling:
5300
5301 (defun erc-beg-of-input-line ()
5302 "Return the value of `point' at the beginning of the input line.
5303
5304 Specifically, return the position of `erc-insert-marker'."
5305 (or (and (boundp 'erc-insert-marker)
5306 (markerp erc-insert-marker))
5307 (error "erc-insert-marker has no value, please report a bug"))
5308 (marker-position erc-insert-marker))
5309
5310 (defun erc-end-of-input-line ()
5311 "Return the value of `point' at the end of the input line."
5312 (point-max))
5313
5314 (defvar erc-last-input-time 0
5315 "Time of last call to `erc-send-current-line'.
5316 If that function has never been called, the value is 0.")
5317
5318 (defcustom erc-accidental-paste-threshold-seconds nil
5319 "Minimum time, in seconds, before sending new lines via IRC.
5320 If the value is a number, `erc-send-current-line' signals an error
5321 if its previous invocation was fewer than this many seconds ago.
5322 This is useful so that if you accidentally enter large amounts of text
5323 into the ERC buffer, that text is not sent to the IRC server.
5324
5325 If the value is nil, `erc-send-current-line' always considers any
5326 submitted line to be intentional."
5327 :group 'erc
5328 :version "24.4"
5329 :type '(choice number (other :tag "disabled" nil)))
5330
5331 (defun erc-send-current-line ()
5332 "Parse current line and send it to IRC."
5333 (interactive)
5334 (let ((now (float-time)))
5335 (if (or (not erc-accidental-paste-threshold-seconds)
5336 (< erc-accidental-paste-threshold-seconds
5337 (- now erc-last-input-time)))
5338 (save-restriction
5339 (widen)
5340 (if (< (point) (erc-beg-of-input-line))
5341 (erc-error "Point is not in the input area")
5342 (let ((inhibit-read-only t)
5343 (str (erc-user-input))
5344 (old-buf (current-buffer)))
5345 (if (and (not (erc-server-buffer-live-p))
5346 (not (erc-command-no-process-p str)))
5347 (erc-error "ERC: No process running")
5348 (erc-set-active-buffer (current-buffer))
5349 ;; Kill the input and the prompt
5350 (delete-region (erc-beg-of-input-line)
5351 (erc-end-of-input-line))
5352 (unwind-protect
5353 (erc-send-input str)
5354 ;; Fix the buffer if the command didn't kill it
5355 (when (buffer-live-p old-buf)
5356 (with-current-buffer old-buf
5357 (save-restriction
5358 (widen)
5359 (goto-char (point-max))
5360 (when (processp erc-server-process)
5361 (set-marker (process-mark erc-server-process) (point)))
5362 (set-marker erc-insert-marker (point))
5363 (let ((buffer-modified (buffer-modified-p)))
5364 (erc-display-prompt)
5365 (set-buffer-modified-p buffer-modified))))))
5366
5367 ;; Only when last hook has been run...
5368 (run-hook-with-args 'erc-send-completed-hook str))))
5369 (setq erc-last-input-time now))
5370 (switch-to-buffer "*ERC Accidental Paste Overflow*")
5371 (lwarn 'erc :warning
5372 "You seem to have accidentally pasted some text!"))))
5373
5374 (defun erc-user-input ()
5375 "Return the input of the user in the current buffer."
5376 (buffer-substring-no-properties
5377 erc-input-marker
5378 (erc-end-of-input-line)))
5379
5380 (defvar erc-command-regexp "^/\\([A-Za-z']+\\)\\(\\s-+.*\\|\\s-*\\)$"
5381 "Regular expression used for matching commands in ERC.")
5382
5383 (defun erc-send-input (input)
5384 "Treat INPUT as typed in by the user. It is assumed that the input
5385 and the prompt is already deleted.
5386 This returns non-nil only if we actually send anything."
5387 ;; Handle different kinds of inputs
5388 (cond
5389 ;; Ignore empty input
5390 ((if erc-send-whitespace-lines
5391 (string= input "")
5392 (string-match "\\`[ \t\r\f\n]*\\'" input))
5393 (when erc-warn-about-blank-lines
5394 (message "Blank line - ignoring...")
5395 (beep))
5396 nil)
5397 (t
5398 (defvar str) ;; FIXME: Make it obey the "erc-" prefix convention.
5399 (let ((str input)
5400 (erc-insert-this t))
5401 (setq erc-send-this t)
5402 (run-hook-with-args 'erc-send-pre-hook input)
5403 (when erc-send-this
5404 (if (or (string-match "\n" str)
5405 (not (string-match erc-command-regexp str)))
5406 (mapc
5407 (lambda (line)
5408 (mapc
5409 (lambda (line)
5410 ;; Insert what has to be inserted for this.
5411 (erc-display-msg line)
5412 (erc-process-input-line (concat line "\n")
5413 (null erc-flood-protect) t))
5414 (or (and erc-flood-protect (erc-split-line line))
5415 (list line))))
5416 (split-string str "\n"))
5417 (erc-process-input-line (concat str "\n") t nil))
5418 t)))))
5419
5420 (defun erc-display-command (line)
5421 (when erc-insert-this
5422 (let ((insert-position (point)))
5423 (unless erc-hide-prompt
5424 (erc-display-prompt nil nil (erc-command-indicator)
5425 (and (erc-command-indicator)
5426 'erc-command-indicator-face)))
5427 (let ((beg (point)))
5428 (insert line)
5429 (erc-put-text-property beg (point)
5430 'face 'erc-command-indicator-face)
5431 (insert "\n"))
5432 (when (processp erc-server-process)
5433 (set-marker (process-mark erc-server-process) (point)))
5434 (set-marker erc-insert-marker (point))
5435 (save-excursion
5436 (save-restriction
5437 (narrow-to-region insert-position (point))
5438 (run-hooks 'erc-send-modify-hook)
5439 (run-hooks 'erc-send-post-hook))))))
5440
5441 (defun erc-display-msg (line)
5442 "Display LINE as a message of the user to the current target at the
5443 current position."
5444 (when erc-insert-this
5445 (let ((insert-position (point)))
5446 (insert (erc-format-my-nick))
5447 (let ((beg (point)))
5448 (insert line)
5449 (erc-put-text-property beg (point)
5450 'face 'erc-input-face))
5451 (insert "\n")
5452 (when (processp erc-server-process)
5453 (set-marker (process-mark erc-server-process) (point)))
5454 (set-marker erc-insert-marker (point))
5455 (save-excursion
5456 (save-restriction
5457 (narrow-to-region insert-position (point))
5458 (run-hooks 'erc-send-modify-hook)
5459 (run-hooks 'erc-send-post-hook))))))
5460
5461 (defun erc-command-symbol (command)
5462 "Return the ERC command symbol for COMMAND if it exists and is bound."
5463 (let ((cmd (intern-soft (format "erc-cmd-%s" (upcase command)))))
5464 (when (fboundp cmd) cmd)))
5465
5466 (defun erc-extract-command-from-line (line)
5467 "Extract command and args from the input LINE.
5468 If no command was given, return nil. If command matches, return a
5469 list of the form: (command args) where both elements are strings."
5470 (when (string-match erc-command-regexp line)
5471 (let* ((cmd (erc-command-symbol (match-string 1 line)))
5472 ;; note: return is nil, we apply this simply for side effects
5473 (_canon-defun (while (and cmd (symbolp (symbol-function cmd)))
5474 (setq cmd (symbol-function cmd))))
5475 (cmd-fun (or cmd #'erc-cmd-default))
5476 (arg (if cmd
5477 (if (get cmd-fun 'do-not-parse-args)
5478 (format "%s" (match-string 2 line))
5479 (delete "" (split-string (erc-trim-string
5480 (match-string 2 line)) " ")))
5481 line)))
5482 (list cmd-fun arg))))
5483
5484 (defun erc-split-multiline-safe (string)
5485 "Split STRING, containing multiple lines and return them in a list.
5486 Do it only for STRING as the complete input, do not carry unfinished
5487 strings over to the next call."
5488 (let ((l ())
5489 (i0 0)
5490 (doit t))
5491 (while doit
5492 (let ((i (string-match "\r?\n" string i0))
5493 (s (substring string i0)))
5494 (cond (i (setq l (cons (substring string i0 i) l))
5495 (setq i0 (match-end 0)))
5496 ((> (length s) 0)
5497 (setq l (cons s l))(setq doit nil))
5498 (t (setq doit nil)))))
5499 (nreverse l)))
5500
5501 ;; nick handling
5502
5503 (defun erc-set-current-nick (nick)
5504 "Set the current nickname to NICK."
5505 (with-current-buffer (if (buffer-live-p (erc-server-buffer))
5506 (erc-server-buffer)
5507 (current-buffer))
5508 (setq erc-server-current-nick nick)))
5509
5510 (defun erc-current-nick ()
5511 "Return the current nickname."
5512 (with-current-buffer (if (buffer-live-p (erc-server-buffer))
5513 (erc-server-buffer)
5514 (current-buffer))
5515 erc-server-current-nick))
5516
5517 (defun erc-current-nick-p (nick)
5518 "Return non-nil if NICK is the current nickname."
5519 (erc-nick-equal-p nick (erc-current-nick)))
5520
5521 (defun erc-nick-equal-p (nick1 nick2)
5522 "Return non-nil if NICK1 and NICK2 are the same.
5523
5524 This matches strings according to the IRC protocol's case convention.
5525
5526 See also `erc-downcase'."
5527 (string= (erc-downcase nick1)
5528 (erc-downcase nick2)))
5529
5530 ;; default target handling
5531
5532 (defun erc-default-target ()
5533 "Return the current default target (as a character string) or nil if none."
5534 (let ((tgt (car erc-default-recipients)))
5535 (cond
5536 ((not tgt) nil)
5537 ((listp tgt) (cdr tgt))
5538 (t tgt))))
5539
5540 (defun erc-add-default-channel (channel)
5541 "Add CHANNEL to the default channel list."
5542 (let ((chl (downcase channel)))
5543 (setq erc-default-recipients
5544 (cons chl erc-default-recipients))))
5545
5546 (defun erc-delete-default-channel (channel &optional buffer)
5547 "Delete CHANNEL from the default channel list."
5548 (with-current-buffer (if (and buffer
5549 (bufferp buffer))
5550 buffer
5551 (current-buffer))
5552 (setq erc-default-recipients (delete (downcase channel)
5553 erc-default-recipients))))
5554
5555 (defun erc-add-query (nickname)
5556 "Add QUERY'd NICKNAME to the default channel list.
5557
5558 The previous default target of QUERY type gets removed."
5559 (let ((d1 (car erc-default-recipients))
5560 (d2 (cdr erc-default-recipients))
5561 (qt (cons 'QUERY (downcase nickname))))
5562 (setq erc-default-recipients (cons qt (if (and (listp d1)
5563 (eq (car d1) 'QUERY))
5564 d2
5565 erc-default-recipients)))))
5566
5567 (defun erc-delete-query ()
5568 "Delete the topmost target if it is a QUERY."
5569
5570 (let ((d1 (car erc-default-recipients))
5571 (d2 (cdr erc-default-recipients)))
5572 (if (and (listp d1)
5573 (eq (car d1) 'QUERY))
5574 (setq erc-default-recipients d2)
5575 (error "Current target is not a QUERY"))))
5576
5577 (defun erc-ignored-user-p (spec)
5578 "Return non-nil if SPEC matches something in `erc-ignore-list'.
5579
5580 Takes a full SPEC of a user in the form \"nick!login@host\", and
5581 matches against all the regexp's in `erc-ignore-list'. If any
5582 match, returns that regexp."
5583 (catch 'found
5584 (dolist (ignored (erc-with-server-buffer erc-ignore-list))
5585 (if (string-match ignored spec)
5586 (throw 'found ignored)))))
5587
5588 (defun erc-ignored-reply-p (msg tgt proc)
5589 ;; FIXME: this docstring needs fixing -- Lawrence 2004-01-08
5590 "Return non-nil if MSG matches something in `erc-ignore-reply-list'.
5591
5592 Takes a message MSG to a channel and returns non-nil if the addressed
5593 user matches any regexp in `erc-ignore-reply-list'."
5594 (let ((target-nick (erc-message-target msg)))
5595 (if (not target-nick)
5596 nil
5597 (erc-with-buffer (tgt proc)
5598 (let ((user (erc-get-server-user target-nick)))
5599 (when user
5600 (erc-list-match erc-ignore-reply-list
5601 (erc-user-spec user))))))))
5602
5603 (defun erc-message-target (msg)
5604 "Return the addressed target in MSG.
5605
5606 The addressed target is the string before the first colon in MSG."
5607 (if (string-match "^\\([^: \n]*\\):" msg)
5608 (match-string 1 msg)
5609 nil))
5610
5611 (defun erc-user-spec (user)
5612 "Create a nick!user@host spec from a user struct."
5613 (let ((nick (erc-server-user-nickname user))
5614 (host (erc-server-user-host user))
5615 (login (erc-server-user-login user)))
5616 (concat (or nick "")
5617 "!"
5618 (or login "")
5619 "@"
5620 (or host ""))))
5621
5622 (defun erc-list-match (lst str)
5623 "Return non-nil if any regexp in LST matches STR."
5624 (memq nil (mapcar (lambda (regexp)
5625 (not (string-match regexp str)))
5626 lst)))
5627
5628 ;; other "toggles"
5629
5630 (defun erc-toggle-ctcp-autoresponse (&optional arg)
5631 "Toggle automatic CTCP replies (like VERSION and PING).
5632
5633 If ARG is positive, turns CTCP replies on.
5634
5635 If ARG is non-nil and not positive, turns CTCP replies off."
5636 (interactive "P")
5637 (cond ((and (numberp arg) (> arg 0))
5638 (setq erc-disable-ctcp-replies t))
5639 (arg (setq erc-disable-ctcp-replies nil))
5640 (t (setq erc-disable-ctcp-replies (not erc-disable-ctcp-replies))))
5641 (message "ERC CTCP replies are %s" (if erc-disable-ctcp-replies "OFF" "ON")))
5642
5643 (defun erc-toggle-flood-control (&optional arg)
5644 "Toggle use of flood control on sent messages.
5645
5646 If ARG is positive, use flood control.
5647 If ARG is non-nil and not positive, do not use flood control.
5648
5649 See `erc-server-flood-margin' for an explanation of the available
5650 flood control parameters."
5651 (interactive "P")
5652 (cond ((and (numberp arg) (> arg 0))
5653 (setq erc-flood-protect t))
5654 (arg (setq erc-flood-protect nil))
5655 (t (setq erc-flood-protect (not erc-flood-protect))))
5656 (message "ERC flood control is %s"
5657 (cond (erc-flood-protect "ON")
5658 (t "OFF"))))
5659
5660 ;; Some useful channel and nick commands for fast key bindings
5661
5662 (defun erc-invite-only-mode (&optional arg)
5663 "Turn on the invite only mode (+i) for the current channel.
5664
5665 If ARG is non-nil, turn this mode off (-i).
5666
5667 This command is sent even if excess flood is detected."
5668 (interactive "P")
5669 (erc-set-active-buffer (current-buffer))
5670 (let ((tgt (erc-default-target)))
5671 (if (or (not tgt) (not (erc-channel-p tgt)))
5672 (erc-display-message nil 'error (current-buffer) 'no-target)
5673 (erc-load-irc-script-lines
5674 (list (concat "/mode " tgt (if arg " -i" " +i")))
5675 t))))
5676
5677 (defun erc-get-channel-mode-from-keypress (key)
5678 "Read a key sequence and call the corresponding channel mode function.
5679 After doing C-c C-o, type in a channel mode letter.
5680
5681 C-g means quit.
5682 RET lets you type more than one mode at a time.
5683 If \"l\" is pressed, `erc-set-channel-limit' gets called.
5684 If \"k\" is pressed, `erc-set-channel-key' gets called.
5685 Anything else will be sent to `erc-toggle-channel-mode'."
5686 (interactive "kChannel mode (RET to set more than one): ")
5687 (when (featurep 'xemacs)
5688 (setq key (char-to-string (event-to-character (aref key 0)))))
5689 (cond ((equal key "\C-g")
5690 (keyboard-quit))
5691 ((equal key "\C-m")
5692 (erc-insert-mode-command))
5693 ((equal key "l")
5694 (call-interactively 'erc-set-channel-limit))
5695 ((equal key "k")
5696 (call-interactively 'erc-set-channel-key))
5697 (t (erc-toggle-channel-mode key))))
5698
5699 (defun erc-toggle-channel-mode (mode &optional channel)
5700 "Toggle channel MODE.
5701
5702 If CHANNEL is non-nil, toggle MODE for that channel, otherwise use
5703 `erc-default-target'."
5704 (interactive "P")
5705 (erc-set-active-buffer (current-buffer))
5706 (let ((tgt (or channel (erc-default-target))))
5707 (if (or (null tgt) (null (erc-channel-p tgt)))
5708 (erc-display-message nil 'error 'active 'no-target)
5709 (let* ((active (member mode erc-channel-modes))
5710 (newstate (if active "OFF" "ON")))
5711 (erc-log (format "%s: Toggle mode %s %s" tgt mode newstate))
5712 (message "Toggle channel mode %s %s" mode newstate)
5713 (erc-server-send (format "MODE %s %s%s"
5714 tgt (if active "-" "+") mode))))))
5715
5716 (defun erc-insert-mode-command ()
5717 "Insert the line \"/mode <current target> \" at `point'."
5718 (interactive)
5719 (let ((tgt (erc-default-target)))
5720 (if tgt (insert (concat "/mode " tgt " "))
5721 (erc-display-message nil 'error (current-buffer) 'no-target))))
5722
5723 (defun erc-channel-names ()
5724 "Run \"/names #channel\" in the current channel."
5725 (interactive)
5726 (erc-set-active-buffer (current-buffer))
5727 (let ((tgt (erc-default-target)))
5728 (if tgt (erc-load-irc-script-lines (list (concat "/names " tgt)))
5729 (erc-display-message nil 'error (current-buffer) 'no-target))))
5730
5731 (defun erc-remove-text-properties-region (start end &optional object)
5732 "Clears the region (START,END) in OBJECT from all colors, etc."
5733 (interactive "r")
5734 (save-excursion
5735 (let ((inhibit-read-only t))
5736 (set-text-properties start end nil object))))
5737 (put 'erc-remove-text-properties-region 'disabled t)
5738
5739 ;; script execution and startup
5740
5741 (defun erc-find-file (file &optional path)
5742 "Search for a FILE in the filesystem.
5743 First the `default-directory' is searched for FILE, then any directories
5744 specified in the list PATH.
5745
5746 If FILE is found, return the path to it."
5747 (let ((filepath file))
5748 (if (file-readable-p filepath) filepath
5749 (while (and path
5750 (progn (setq filepath (expand-file-name file (car path)))
5751 (not (file-readable-p filepath))))
5752 (setq path (cdr path)))
5753 (if path filepath nil))))
5754
5755 (defun erc-select-startup-file ()
5756 "Select an ERC startup file.
5757 See also `erc-startup-file-list'."
5758 (catch 'found
5759 (dolist (f erc-startup-file-list)
5760 (setq f (convert-standard-filename f))
5761 (when (file-readable-p f)
5762 (throw 'found f)))))
5763
5764 (defun erc-find-script-file (file)
5765 "Search for FILE in `default-directory', and any in `erc-script-path'."
5766 (erc-find-file file erc-script-path))
5767
5768 (defun erc-load-script (file)
5769 "Load a script from FILE.
5770
5771 FILE must be the full name, it is not searched in the
5772 `erc-script-path'. If the filename ends with `.el', then load it
5773 as an Emacs Lisp program. Otherwise, treat it as a regular IRC
5774 script."
5775 (erc-log (concat "erc-load-script: " file))
5776 (cond
5777 ((string-match "\\.el\\'" file)
5778 (load file))
5779 (t
5780 (erc-load-irc-script file))))
5781
5782 (defun erc-process-script-line (line &optional args)
5783 "Process an IRC script LINE.
5784
5785 Does script-specific substitutions (script arguments, current nick,
5786 server, etc.) in LINE and returns it.
5787
5788 Substitutions are: %C and %c = current target (channel or nick),
5789 %S %s = current server, %N %n = my current nick, and %x is x verbatim,
5790 where x is any other character;
5791 $* = the entire argument string, $1 = the first argument, $2 = the second,
5792 and so on."
5793 (if (not args) (setq args ""))
5794 (let* ((arg-esc-regexp "\\(\\$\\(\\*\\|[1-9][0-9]*\\)\\)\\([^0-9]\\|$\\)")
5795 (percent-regexp "\\(%.\\)")
5796 (esc-regexp (concat arg-esc-regexp "\\|" percent-regexp))
5797 (tgt (erc-default-target))
5798 (server (and (boundp 'erc-session-server) erc-session-server))
5799 (nick (erc-current-nick))
5800 (res "")
5801 (tmp nil)
5802 (arg-list nil)
5803 (arg-num 0))
5804 (if (not tgt) (setq tgt ""))
5805 (if (not server) (setq server ""))
5806 (if (not nick) (setq nick ""))
5807 ;; First, compute the argument list
5808 (setq tmp args)
5809 (while (string-match "^\\s-*\\(\\S-+\\)\\(\\s-+.*$\\|$\\)" tmp)
5810 (setq arg-list (cons (match-string 1 tmp) arg-list))
5811 (setq tmp (match-string 2 tmp)))
5812 (setq arg-list (nreverse arg-list))
5813 (setq arg-num (length arg-list))
5814 ;; now do the substitution
5815 (setq tmp (string-match esc-regexp line))
5816 (while tmp
5817 ;;(message "beginning of while: tmp=%S" tmp)
5818 (let* ((hd (substring line 0 tmp))
5819 (esc "")
5820 (subst "")
5821 (tail (substring line tmp)))
5822 (cond ((string-match (concat "^" arg-esc-regexp) tail)
5823 (setq esc (match-string 1 tail))
5824 (setq tail (substring tail (match-end 1))))
5825 ((string-match (concat "^" percent-regexp) tail)
5826 (setq esc (match-string 1 tail))
5827 (setq tail (substring tail (match-end 1)))))
5828 ;;(message "hd=%S, esc=%S, tail=%S, arg-num=%S" hd esc tail arg-num)
5829 (setq res (concat res hd))
5830 (setq subst
5831 (cond ((string= esc "") "")
5832 ((string-match "^\\$\\*$" esc) args)
5833 ((string-match "^\\$\\([0-9]+\\)$" esc)
5834 (let ((n (string-to-number (match-string 1 esc))))
5835 (message "n = %S, integerp(n)=%S" n (integerp n))
5836 (if (<= n arg-num) (nth (1- n) arg-list) "")))
5837 ((string-match "^%[Cc]$" esc) tgt)
5838 ((string-match "^%[Ss]$" esc) server)
5839 ((string-match "^%[Nn]$" esc) nick)
5840 ((string-match "^%\\(.\\)$" esc) (match-string 1 esc))
5841 (t (erc-log (format "BUG in erc-process-script-line: bad escape sequence: %S\n" esc))
5842 (message "BUG IN ERC: esc=%S" esc)
5843 "")))
5844 (setq line tail)
5845 (setq tmp (string-match esc-regexp line))
5846 (setq res (concat res subst))
5847 ;;(message "end of while: line=%S, res=%S, tmp=%S" line res tmp)
5848 ))
5849 (setq res (concat res line))
5850 res))
5851
5852 (defun erc-load-irc-script (file &optional force)
5853 "Load an IRC script from FILE."
5854 (erc-log (concat "erc-load-script: " file))
5855 (let ((str (with-temp-buffer
5856 (insert-file-contents file)
5857 (buffer-string))))
5858 (erc-load-irc-script-lines (erc-split-multiline-safe str) force)))
5859
5860 (defun erc-load-irc-script-lines (lines &optional force noexpand)
5861 "Load IRC script LINES (a list of strings).
5862
5863 If optional NOEXPAND is non-nil, do not expand script-specific
5864 sequences, process the lines verbatim. Use this for multiline
5865 user input."
5866 (let* ((cb (current-buffer))
5867 (s "")
5868 (sp (or (erc-command-indicator) (erc-prompt)))
5869 (args (and (boundp 'erc-script-args) erc-script-args)))
5870 (if (and args (string-match "^ " args))
5871 (setq args (substring args 1)))
5872 ;; prepare the prompt string for echo
5873 (erc-put-text-property 0 (length sp)
5874 'face 'erc-command-indicator-face sp)
5875 (while lines
5876 (setq s (car lines))
5877 (erc-log (concat "erc-load-script: CMD: " s))
5878 (unless (string-match "^\\s-*$" s)
5879 (let ((line (if noexpand s (erc-process-script-line s args))))
5880 (if (and (erc-process-input-line line force)
5881 erc-script-echo)
5882 (progn
5883 (erc-put-text-property 0 (length line)
5884 'face 'erc-input-face line)
5885 (erc-display-line (concat sp line) cb)))))
5886 (setq lines (cdr lines)))))
5887
5888 ;; authentication
5889
5890 (defun erc-login ()
5891 "Perform user authentication at the IRC server."
5892 (erc-log (format "login: nick: %s, user: %s %s %s :%s"
5893 (erc-current-nick)
5894 (user-login-name)
5895 (or erc-system-name (system-name))
5896 erc-session-server
5897 erc-session-user-full-name))
5898 (if erc-session-password
5899 (erc-server-send (format "PASS %s" erc-session-password))
5900 (message "Logging in without password"))
5901 (erc-server-send (format "NICK %s" (erc-current-nick)))
5902 (erc-server-send
5903 (format "USER %s %s %s :%s"
5904 ;; hacked - S.B.
5905 (if erc-anonymous-login erc-email-userid (user-login-name))
5906 "0" "*"
5907 erc-session-user-full-name))
5908 (erc-update-mode-line))
5909
5910 ;; connection properties' heuristics
5911
5912 (defun erc-determine-parameters (&optional server port nick name)
5913 "Determine the connection and authentication parameters.
5914 Sets the buffer local variables:
5915
5916 - `erc-session-connector'
5917 - `erc-session-server'
5918 - `erc-session-port'
5919 - `erc-session-full-name'
5920 - `erc-server-current-nick'"
5921 (setq erc-session-connector erc-server-connect-function
5922 erc-session-server (erc-compute-server server)
5923 erc-session-port (or port erc-default-port)
5924 erc-session-user-full-name (erc-compute-full-name name))
5925 (erc-set-current-nick (erc-compute-nick nick)))
5926
5927 (defun erc-compute-server (&optional server)
5928 "Return an IRC server name.
5929
5930 This tries a number of increasingly more default methods until a
5931 non-nil value is found.
5932
5933 - SERVER (the argument passed to this function)
5934 - The `erc-server' option
5935 - The value of the IRCSERVER environment variable
5936 - The `erc-default-server' variable"
5937 (or server
5938 erc-server
5939 (getenv "IRCSERVER")
5940 erc-default-server))
5941
5942 (defun erc-compute-nick (&optional nick)
5943 "Return user's IRC nick.
5944
5945 This tries a number of increasingly more default methods until a
5946 non-nil value is found.
5947
5948 - NICK (the argument passed to this function)
5949 - The `erc-nick' option
5950 - The value of the IRCNICK environment variable
5951 - The result from the `user-login-name' function"
5952 (or nick
5953 (if (consp erc-nick) (car erc-nick) erc-nick)
5954 (getenv "IRCNICK")
5955 (user-login-name)))
5956
5957
5958 (defun erc-compute-full-name (&optional full-name)
5959 "Return user's full name.
5960
5961 This tries a number of increasingly more default methods until a
5962 non-nil value is found.
5963
5964 - FULL-NAME (the argument passed to this function)
5965 - The `erc-user-full-name' option
5966 - The value of the IRCNAME environment variable
5967 - The result from the `user-full-name' function"
5968 (or full-name
5969 erc-user-full-name
5970 (getenv "IRCNAME")
5971 (if erc-anonymous-login "unknown" nil)
5972 (user-full-name)))
5973
5974 (defun erc-compute-port (&optional port)
5975 "Return a port for an IRC server.
5976
5977 This tries a number of increasingly more default methods until a
5978 non-nil value is found.
5979
5980 - PORT (the argument passed to this function)
5981 - The `erc-port' option
5982 - The `erc-default-port' variable"
5983 (or port erc-port erc-default-port))
5984
5985 ;; time routines
5986
5987 (defun erc-string-to-emacs-time (string)
5988 "Convert the long number represented by STRING into an Emacs format.
5989 Returns a list of the form (HIGH LOW), compatible with Emacs time format."
5990 (let* ((n (string-to-number (concat string ".0"))))
5991 (list (truncate (/ n 65536))
5992 (truncate (mod n 65536)))))
5993
5994 (defalias 'erc-emacs-time-to-erc-time
5995 (if (featurep 'xemacs) 'time-to-seconds 'float-time))
5996
5997 (defalias 'erc-current-time 'erc-emacs-time-to-erc-time)
5998
5999 (defun erc-time-diff (t1 t2)
6000 "Return the time difference in seconds between T1 and T2."
6001 (abs (- t2 t1)))
6002
6003 (defun erc-time-gt (t1 t2)
6004 "Check whether T1 > T2."
6005 (> t1 t2))
6006
6007 (defun erc-sec-to-time (ns)
6008 "Convert NS to a time string HH:MM.SS."
6009 (setq ns (truncate ns))
6010 (format "%02d:%02d.%02d"
6011 (/ ns 3600)
6012 (/ (% ns 3600) 60)
6013 (% ns 60)))
6014
6015 (defun erc-seconds-to-string (seconds)
6016 "Convert a number of SECONDS into an English phrase."
6017 (let (days hours minutes format-args output)
6018 (setq days (/ seconds 86400)
6019 seconds (% seconds 86400)
6020 hours (/ seconds 3600)
6021 seconds (% seconds 3600)
6022 minutes (/ seconds 60)
6023 seconds (% seconds 60)
6024 format-args (if (> days 0)
6025 `("%d days, %d hours, %d minutes, %d seconds"
6026 ,days ,hours ,minutes ,seconds)
6027 (if (> hours 0)
6028 `("%d hours, %d minutes, %d seconds"
6029 ,hours ,minutes ,seconds)
6030 (if (> minutes 0)
6031 `("%d minutes, %d seconds" ,minutes ,seconds)
6032 `("%d seconds" ,seconds))))
6033 output (apply #'format format-args))
6034 ;; Change all "1 units" to "1 unit".
6035 (while (string-match "\\([^0-9]\\|^\\)1 \\S-+\\(s\\)" output)
6036 (setq output (erc-replace-match-subexpression-in-string
6037 "" output (match-string 2 output) 2 (match-beginning 2))))
6038 output))
6039
6040
6041 ;; info
6042
6043 (defconst erc-clientinfo-alist
6044 '(("ACTION" . "is used to inform about one's current activity")
6045 ("CLIENTINFO" . "gives help on CTCP commands supported by client")
6046 ("ECHO" . "echoes its arguments back")
6047 ("FINGER" . "shows user's name, location, and idle time")
6048 ("PING" . "measures delay between peers")
6049 ("TIME" . "shows client-side time")
6050 ("USERINFO" . "shows information provided by a user")
6051 ("VERSION" . "shows client type and version"))
6052 "Alist of CTCP CLIENTINFO for ERC commands.")
6053
6054 (defun erc-client-info (s)
6055 "Return CTCP CLIENTINFO on command S.
6056 If S is nil or an empty string then return general CLIENTINFO."
6057 (if (or (not s) (string= s ""))
6058 (concat
6059 (apply #'concat
6060 (mapcar (lambda (e)
6061 (concat (car e) " "))
6062 erc-clientinfo-alist))
6063 ": use CLIENTINFO <COMMAND> to get more specific information")
6064 (let ((h (assoc (upcase s) erc-clientinfo-alist)))
6065 (if h
6066 (concat s " " (cdr h))
6067 (concat s ": unknown command")))))
6068
6069 ;; Hook functions
6070
6071 (defun erc-directory-writable-p (dir)
6072 "Determine whether DIR is a writable directory.
6073 If it doesn't exist, create it."
6074 (unless (file-attributes dir) (make-directory dir))
6075 (or (file-accessible-directory-p dir) (error "Cannot access %s" dir)))
6076
6077 (defun erc-kill-query-buffers (process)
6078 "Kill all buffers of PROCESS."
6079 ;; here, we only want to match the channel buffers, to avoid
6080 ;; "selecting killed buffers" b0rkage.
6081 (erc-with-all-buffers-of-server process
6082 (lambda ()
6083 (not (erc-server-buffer-p)))
6084 (kill-buffer (current-buffer))))
6085
6086 (defun erc-nick-at-point ()
6087 "Give information about the nickname at `point'.
6088
6089 If called interactively, give a human readable message in the
6090 minibuffer. If called programmatically, return the corresponding
6091 entry of `channel-members'."
6092 (interactive)
6093 (require 'thingatpt)
6094 (let* ((word (word-at-point))
6095 (channel-data (erc-get-channel-user word))
6096 (cuser (cdr channel-data))
6097 (user (if channel-data
6098 (car channel-data)
6099 (erc-get-server-user word)))
6100 host login full-name nick voice halfop op admin owner)
6101 (when user
6102 (setq nick (erc-server-user-nickname user)
6103 host (erc-server-user-host user)
6104 login (erc-server-user-login user)
6105 full-name (erc-server-user-full-name user))
6106 (if cuser
6107 (setq voice (erc-channel-user-voice cuser)
6108 halfop (erc-channel-user-halfop cuser)
6109 op (erc-channel-user-op cuser)
6110 admin (erc-channel-user-admin cuser)
6111 owner (erc-channel-user-owner cuser))))
6112 (if (called-interactively-p 'interactive)
6113 (message "%s is %s@%s%s%s"
6114 nick login host
6115 (if full-name (format " (%s)" full-name) "")
6116 (if (or voice halfop op admin owner)
6117 (format " and is +%s%s%s%s%s on %s"
6118 (if voice "v" "")
6119 (if halfop "h" "")
6120 (if op "o" "")
6121 (if admin "a" "")
6122 (if owner "q" "")
6123 (erc-default-target))
6124 ""))
6125 user)))
6126
6127 (defun erc-away-time ()
6128 "Return non-nil if the current ERC process is set away.
6129
6130 In particular, the time that we were set away is returned.
6131 See `current-time' for details on the time format."
6132 (erc-with-server-buffer erc-away))
6133
6134 ;; Mode line handling
6135
6136 (defcustom erc-mode-line-format "%S %a"
6137 "A string to be formatted and shown in the mode-line in `erc-mode'.
6138
6139 The string is formatted using `format-spec' and the result is set as the value
6140 of `mode-line-buffer-identification'.
6141
6142 The following characters are replaced:
6143 %a: String indicating away status or \"\" if you are not away
6144 %l: The estimated lag time to the server
6145 %m: The modes of the channel
6146 %n: The current nick name
6147 %N: The name of the network
6148 %o: The topic of the channel
6149 %p: The session port
6150 %t: The name of the target (channel, nickname, or servername:port)
6151 %s: In the server-buffer, this gets filled with the value of
6152 `erc-server-announced-name', in a channel, the value of
6153 (erc-default-target) also get concatenated.
6154 %S: In the server-buffer, this gets filled with the value of
6155 `erc-network', in a channel, the value of (erc-default-target)
6156 also get concatenated."
6157 :group 'erc-mode-line-and-header
6158 :type 'string)
6159
6160 (defcustom erc-header-line-format "%n on %t (%m,%l) %o"
6161 "A string to be formatted and shown in the header-line in `erc-mode'.
6162 Only used starting in Emacs 21.
6163
6164 Set this to nil if you do not want the header line to be
6165 displayed.
6166
6167 See `erc-mode-line-format' for which characters are can be used."
6168 :group 'erc-mode-line-and-header
6169 :set (lambda (sym val)
6170 (set sym val)
6171 (when (fboundp 'erc-update-mode-line)
6172 (erc-update-mode-line nil)))
6173 :type '(choice (const :tag "Disabled" nil)
6174 string))
6175
6176 (defcustom erc-header-line-uses-tabbar-p nil
6177 "Use tabbar mode instead of the header line to display the header."
6178 :group 'erc-mode-line-and-header
6179 :type 'boolean)
6180
6181 (defcustom erc-header-line-uses-help-echo-p t
6182 "Show the contents of the header line in the echo area or as a tooltip
6183 when you move point into the header line."
6184 :group 'erc-mode-line-and-header
6185 :type 'boolean)
6186
6187 (defcustom erc-header-line-face-method nil
6188 "Determine what method to use when colorizing the header line text.
6189
6190 If nil, don't colorize the header text.
6191 If given a function, call it and use the resulting face name.
6192 Otherwise, use the `erc-header-line' face."
6193 :group 'erc-mode-line-and-header
6194 :type '(choice (const :tag "Don't colorize" nil)
6195 (const :tag "Use the erc-header-line face" t)
6196 (function :tag "Call a function")))
6197
6198 (defcustom erc-show-channel-key-p t
6199 "Show the channel key in the header line."
6200 :group 'erc-paranoia
6201 :type 'boolean)
6202
6203 (defcustom erc-mode-line-away-status-format
6204 "(AWAY since %a %b %d %H:%M) "
6205 "When you're away on a server, this is shown in the mode line.
6206 This should be a string with substitution variables recognized by
6207 `format-time-string'."
6208 :group 'erc-mode-line-and-header
6209 :type 'string)
6210
6211 (defun erc-shorten-server-name (server-name)
6212 "Shorten SERVER-NAME according to `erc-common-server-suffixes'."
6213 (if (stringp server-name)
6214 (with-temp-buffer
6215 (insert server-name)
6216 (let ((alist erc-common-server-suffixes))
6217 (while alist
6218 (goto-char (point-min))
6219 (if (re-search-forward (caar alist) nil t)
6220 (replace-match (cdar alist)))
6221 (setq alist (cdr alist))))
6222 (buffer-string))))
6223
6224 (defun erc-format-target ()
6225 "Return the name of the target (channel or nickname or servername:port)."
6226 (let ((target (erc-default-target)))
6227 (or target
6228 (concat (erc-shorten-server-name
6229 (or erc-server-announced-name
6230 erc-session-server))
6231 ":" (erc-port-to-string erc-session-port)))))
6232
6233 (defun erc-format-target-and/or-server ()
6234 "Return the server name or the current target and server name combined."
6235 (let ((server-name (erc-shorten-server-name
6236 (or erc-server-announced-name
6237 erc-session-server))))
6238 (cond ((erc-default-target)
6239 (concat (erc-string-no-properties (erc-default-target))
6240 "@" server-name))
6241 (server-name server-name)
6242 (t (buffer-name (current-buffer))))))
6243
6244 (defun erc-format-network ()
6245 "Return the name of the network we are currently on."
6246 (let ((network (and (fboundp 'erc-network-name) (erc-network-name))))
6247 (if (and network (symbolp network))
6248 (symbol-name network)
6249 "")))
6250
6251 (defun erc-format-target-and/or-network ()
6252 "Return the network or the current target and network combined.
6253 If the name of the network is not available, then use the
6254 shortened server name instead."
6255 (let ((network-name (or (and (fboundp 'erc-network-name) (erc-network-name))
6256 (erc-shorten-server-name
6257 (or erc-server-announced-name
6258 erc-session-server)))))
6259 (when (and network-name (symbolp network-name))
6260 (setq network-name (symbol-name network-name)))
6261 (cond ((erc-default-target)
6262 (concat (erc-string-no-properties (erc-default-target))
6263 "@" network-name))
6264 ((and network-name
6265 (not (get-buffer network-name)))
6266 (when erc-rename-buffers
6267 (rename-buffer network-name))
6268 network-name)
6269 (t (buffer-name (current-buffer))))))
6270
6271 (defun erc-format-away-status ()
6272 "Return a formatted `erc-mode-line-away-status-format'
6273 if `erc-away' is non-nil."
6274 (let ((a (erc-away-time)))
6275 (if a
6276 (format-time-string erc-mode-line-away-status-format a)
6277 "")))
6278
6279 (defun erc-format-channel-modes ()
6280 "Return the current channel's modes."
6281 (concat (apply #'concat
6282 "+" erc-channel-modes)
6283 (cond ((and erc-channel-user-limit erc-channel-key)
6284 (if erc-show-channel-key-p
6285 (format "lk %.0f %s" erc-channel-user-limit
6286 erc-channel-key)
6287 (format "kl %.0f" erc-channel-user-limit)))
6288 (erc-channel-user-limit
6289 ;; Emacs has no bignums
6290 (format "l %.0f" erc-channel-user-limit))
6291 (erc-channel-key
6292 (if erc-show-channel-key-p
6293 (format "k %s" erc-channel-key)
6294 "k"))
6295 (t nil))))
6296
6297 (defun erc-format-lag-time ()
6298 "Return the estimated lag time to server, `erc-server-lag'."
6299 (let ((lag (erc-with-server-buffer erc-server-lag)))
6300 (cond (lag (format "lag:%.0f" lag))
6301 (t ""))))
6302
6303 ;; erc-goodies is required at end of this file.
6304 (declare-function erc-controls-strip "erc-goodies" (str))
6305
6306 (defvar tabbar--local-hlf)
6307
6308 (defun erc-update-mode-line-buffer (buffer)
6309 "Update the mode line in a single ERC buffer BUFFER."
6310 (with-current-buffer buffer
6311 (let ((spec (format-spec-make
6312 ?a (erc-format-away-status)
6313 ?l (erc-format-lag-time)
6314 ?m (erc-format-channel-modes)
6315 ?n (or (erc-current-nick) "")
6316 ?N (erc-format-network)
6317 ?o (or (erc-controls-strip erc-channel-topic) "")
6318 ?p (erc-port-to-string erc-session-port)
6319 ?s (erc-format-target-and/or-server)
6320 ?S (erc-format-target-and/or-network)
6321 ?t (erc-format-target)))
6322 (process-status (cond ((and (erc-server-process-alive)
6323 (not erc-server-connected))
6324 ":connecting")
6325 ((erc-server-process-alive)
6326 "")
6327 (t
6328 ": CLOSED")))
6329 (face (cond ((eq erc-header-line-face-method nil)
6330 nil)
6331 ((functionp erc-header-line-face-method)
6332 (funcall erc-header-line-face-method))
6333 (t
6334 'erc-header-line))))
6335 (cond ((featurep 'xemacs)
6336 (setq modeline-buffer-identification
6337 (list (format-spec erc-mode-line-format spec)))
6338 (setq modeline-process (list process-status)))
6339 (t
6340 (setq mode-line-buffer-identification
6341 (list (format-spec erc-mode-line-format spec)))
6342 (setq mode-line-process (list process-status))))
6343 (when (boundp 'header-line-format)
6344 (let ((header (if erc-header-line-format
6345 (format-spec erc-header-line-format spec)
6346 nil)))
6347 (cond (erc-header-line-uses-tabbar-p
6348 (set (make-local-variable 'tabbar--local-hlf)
6349 header-line-format)
6350 (kill-local-variable 'header-line-format))
6351 ((null header)
6352 (setq header-line-format nil))
6353 (erc-header-line-uses-help-echo-p
6354 (let ((help-echo (with-temp-buffer
6355 (insert header)
6356 (fill-region (point-min) (point-max))
6357 (buffer-string))))
6358 (setq header-line-format
6359 (erc-replace-regexp-in-string
6360 "%"
6361 "%%"
6362 (if face
6363 (erc-propertize header 'help-echo help-echo
6364 'face face)
6365 (erc-propertize header 'help-echo help-echo))))))
6366 (t (setq header-line-format
6367 (if face
6368 (erc-propertize header 'face face)
6369 header)))))))
6370 (if (featurep 'xemacs)
6371 (redraw-modeline)
6372 (force-mode-line-update))))
6373
6374 (defun erc-update-mode-line (&optional buffer)
6375 "Update the mode line in BUFFER.
6376
6377 If BUFFER is nil, update the mode line in all ERC buffers."
6378 (if (and buffer (bufferp buffer))
6379 (erc-update-mode-line-buffer buffer)
6380 (dolist (buf (erc-buffer-list))
6381 (when (buffer-live-p buf)
6382 (erc-update-mode-line-buffer buf)))))
6383
6384 ;; Miscellaneous
6385
6386 (defun erc-port-to-string (p)
6387 "Convert port P to a string.
6388 P may be an integer or a service name."
6389 (if (integerp p)
6390 (int-to-string p)
6391 p))
6392
6393 (defun erc-string-to-port (s)
6394 "Convert string S to either an integer port number or a service name."
6395 (if (numberp s)
6396 s
6397 (let ((n (string-to-number s)))
6398 (if (= n 0)
6399 s
6400 n))))
6401
6402 (defun erc-version (&optional here)
6403 "Show the version number of ERC in the minibuffer.
6404 If optional argument HERE is non-nil, insert version number at point."
6405 (interactive "P")
6406 (let ((version-string
6407 (format "ERC (IRC client for Emacs %s)" emacs-version)))
6408 (if here
6409 (insert version-string)
6410 (if (called-interactively-p 'interactive)
6411 (message "%s" version-string)
6412 version-string))))
6413
6414 (defun erc-modes (&optional here)
6415 "Show the active ERC modes in the minibuffer.
6416 If optional argument HERE is non-nil, insert version number at point."
6417 (interactive "P")
6418 (let ((string
6419 (mapconcat 'identity
6420 (let (modes (case-fold-search nil))
6421 (dolist (var (apropos-internal "^erc-.*mode$"))
6422 (when (and (boundp var)
6423 (symbol-value var))
6424 (setq modes (cons (symbol-name var)
6425 modes))))
6426 modes)
6427 ", ")))
6428 (if here
6429 (insert string)
6430 (if (called-interactively-p 'interactive)
6431 (message "%s" string)
6432 string))))
6433
6434 (defun erc-trim-string (s)
6435 "Trim leading and trailing spaces off S."
6436 (cond
6437 ((not (stringp s)) nil)
6438 ((string-match "^\\s-*$" s)
6439 "")
6440 ((string-match "^\\s-*\\(.*\\S-\\)\\s-*$" s)
6441 (match-string 1 s))
6442 (t
6443 s)))
6444
6445 (defun erc-arrange-session-in-multiple-windows ()
6446 "Open a window for every non-server buffer related to `erc-session-server'.
6447
6448 All windows are opened in the current frame."
6449 (interactive)
6450 (unless erc-server-process
6451 (error "No erc-server-process found in current buffer"))
6452 (let ((bufs (erc-buffer-list nil erc-server-process)))
6453 (when bufs
6454 (delete-other-windows)
6455 (switch-to-buffer (car bufs))
6456 (setq bufs (cdr bufs))
6457 (while bufs
6458 (split-window)
6459 (other-window 1)
6460 (switch-to-buffer (car bufs))
6461 (setq bufs (cdr bufs))
6462 (balance-windows)))))
6463
6464 (defun erc-popup-input-buffer ()
6465 "Provide an input buffer."
6466 (interactive)
6467 (let ((buffer-name (generate-new-buffer-name "*ERC input*"))
6468 (mode (intern
6469 (completing-read
6470 "Mode: "
6471 (mapcar (lambda (e)
6472 (list (symbol-name e)))
6473 (apropos-internal "-mode\\'" 'commandp))
6474 nil t))))
6475 (pop-to-buffer (make-indirect-buffer (current-buffer) buffer-name))
6476 (funcall mode)
6477 (narrow-to-region (point) (point))
6478 (shrink-window-if-larger-than-buffer)))
6479
6480 ;;; Message catalog
6481
6482 (defun erc-make-message-variable-name (catalog entry)
6483 "Create a variable name corresponding to CATALOG's ENTRY."
6484 (intern (concat "erc-message-"
6485 (symbol-name catalog) "-" (symbol-name entry))))
6486
6487 (defun erc-define-catalog-entry (catalog entry format-spec)
6488 "Set CATALOG's ENTRY to FORMAT-SPEC."
6489 (set (erc-make-message-variable-name catalog entry)
6490 format-spec))
6491
6492 (defun erc-define-catalog (catalog entries)
6493 "Define a CATALOG according to ENTRIES."
6494 (dolist (entry entries)
6495 (erc-define-catalog-entry catalog (car entry) (cdr entry))))
6496
6497 (erc-define-catalog
6498 'english
6499 '((bad-ping-response . "Unexpected PING response from %n (time %t)")
6500 (bad-syntax . "Error occurred - incorrect usage?\n%c %u\n%d")
6501 (incorrect-args . "Incorrect arguments. Usage:\n%c %u\n%d")
6502 (cannot-find-file . "Cannot find file %f")
6503 (cannot-read-file . "Cannot read file %f")
6504 (connect . "Connecting to %S:%p... ")
6505 (country . "%c")
6506 (country-unknown . "%d: No such domain")
6507 (ctcp-empty . "Illegal empty CTCP query received from %n. Ignoring.")
6508 (ctcp-request . "==> CTCP request from %n (%u@%h): %r")
6509 (ctcp-request-to . "==> CTCP request from %n (%u@%h) to %t: %r")
6510 (ctcp-too-many . "Too many CTCP queries in single message. Ignoring")
6511 (flood-ctcp-off . "FLOOD PROTECTION: Automatic CTCP responses turned off.")
6512 (flood-strict-mode
6513 . "FLOOD PROTECTION: Switched to Strict Flood Control mode.")
6514 (disconnected . "\n\nConnection failed! Re-establishing connection...\n")
6515 (disconnected-noreconnect
6516 . "\n\nConnection failed! Not re-establishing connection.\n")
6517 (finished . "\n\n*** ERC finished ***\n")
6518 (terminated . "\n\n*** ERC terminated: %e\n")
6519 (login . "Logging in as `%n'...")
6520 (nick-in-use . "%n is in use. Choose new nickname: ")
6521 (nick-too-long
6522 . "WARNING: Nick length (%i) exceeds max NICKLEN(%l) defined by server")
6523 (no-default-channel . "No default channel")
6524 (no-invitation . "You've got no invitation")
6525 (no-target . "No target")
6526 (ops . "%i operator%s: %o")
6527 (ops-none . "No operators in this channel.")
6528 (undefined-ctcp . "Undefined CTCP query received. Silently ignored")
6529 (variable-not-bound . "Variable not bound!")
6530 (ACTION . "* %n %a")
6531 (CTCP-CLIENTINFO . "Client info for %n: %m")
6532 (CTCP-ECHO . "Echo %n: %m")
6533 (CTCP-FINGER . "Finger info for %n: %m")
6534 (CTCP-PING . "Ping time to %n is %t")
6535 (CTCP-TIME . "Time by %n is %m")
6536 (CTCP-UNKNOWN . "Unknown CTCP message from %n (%u@%h): %m")
6537 (CTCP-VERSION . "Version for %n is %m")
6538 (ERROR . "==> ERROR from %s: %c\n")
6539 (INVITE . "%n (%u@%h) invites you to channel %c")
6540 (JOIN . "%n (%u@%h) has joined channel %c")
6541 (JOIN-you . "You have joined channel %c")
6542 (KICK . "%n (%u@%h) has kicked %k off channel %c: %r")
6543 (KICK-you . "You have been kicked off channel %c by %n (%u@%h): %r")
6544 (KICK-by-you . "You have kicked %k off channel %c: %r")
6545 (MODE . "%n (%u@%h) has changed mode for %t to %m")
6546 (MODE-nick . "%n has changed mode for %t to %m")
6547 (NICK . "%n (%u@%h) is now known as %N")
6548 (NICK-you . "Your new nickname is %N")
6549 (PART . erc-message-english-PART)
6550 (PING . "PING from server (last: %s sec. ago)")
6551 (PONG . "PONG from %h (%i second%s)")
6552 (QUIT . "%n (%u@%h) has quit: %r")
6553 (TOPIC . "%n (%u@%h) has set the topic for %c: \"%T\"")
6554 (WALLOPS . "Wallops from %n: %m")
6555 (s004 . "%s %v %U %C")
6556 (s221 . "User modes for %n: %m")
6557 (s252 . "%i operator(s) online")
6558 (s253 . "%i unknown connection(s)")
6559 (s254 . "%i channels formed")
6560 (s275 . "%n %m")
6561 (s301 . "%n is AWAY: %r")
6562 (s303 . "Is online: %n")
6563 (s305 . "%m")
6564 (s306 . "%m")
6565 (s307 . "%n %m")
6566 (s311 . "%n is %f (%u@%h)")
6567 (s312 . "%n is/was on server %s (%c)")
6568 (s313 . "%n is an IRC operator")
6569 (s314 . "%n was %f (%u@%h)")
6570 (s317 . "%n has been idle for %i")
6571 (s317-on-since . "%n has been idle for %i, on since %t")
6572 (s319 . "%n is on channel(s): %c")
6573 (s320 . "%n is an identified user")
6574 (s321 . "Channel Users Topic")
6575 (s322 . "%c [%u] %t")
6576 (s324 . "%c modes: %m")
6577 (s328 . "%c URL: %u")
6578 (s329 . "%c was created on %t")
6579 (s330 . "%n %a %i")
6580 (s331 . "No topic is set for %c")
6581 (s332 . "Topic for %c: %T")
6582 (s333 . "%c: topic set by %n, %t")
6583 (s341 . "Inviting %n to channel %c")
6584 (s352 . "%-11c %-10n %-4a %u@%h (%f)")
6585 (s353 . "Users on %c: %u")
6586 (s367 . "Ban for %b on %c")
6587 (s367-set-by . "Ban for %b on %c set by %s on %t")
6588 (s368 . "Banlist of %c ends.")
6589 (s379 . "%c: Forwarded to %f")
6590 (s391 . "The time at %s is %t")
6591 (s401 . "%n: No such nick/channel")
6592 (s403 . "%c: No such channel")
6593 (s404 . "%c: Cannot send to channel")
6594 (s405 . "%c: You have joined too many channels")
6595 (s406 . "%n: There was no such nickname")
6596 (s412 . "No text to send")
6597 (s421 . "%c: Unknown command")
6598 (s431 . "No nickname given")
6599 (s432 . "%n is an erroneous nickname")
6600 (s442 . "%c: You're not on that channel")
6601 (s445 . "SUMMON has been disabled")
6602 (s446 . "USERS has been disabled")
6603 (s451 . "You have not registered")
6604 (s461 . "%c: not enough parameters")
6605 (s462 . "Unauthorized command (already registered)")
6606 (s463 . "Your host isn't among the privileged")
6607 (s464 . "Password incorrect")
6608 (s465 . "You are banned from this server")
6609 (s474 . "You can't join %c because you're banned (+b)")
6610 (s475 . "You must specify the correct channel key (+k) to join %c")
6611 (s481 . "Permission Denied - You're not an IRC operator")
6612 (s482 . "You need to be a channel operator of %c to do that")
6613 (s483 . "You can't kill a server!")
6614 (s484 . "Your connection is restricted!")
6615 (s485 . "You're not the original channel operator")
6616 (s491 . "No O-lines for your host")
6617 (s501 . "Unknown MODE flag")
6618 (s502 . "You can't change modes for other users")
6619 (s671 . "%n %a")))
6620
6621 (defun erc-message-english-PART (&rest args)
6622 "Format a proper PART message.
6623
6624 This function is an example on what could be done with formatting
6625 functions."
6626 (let ((nick (cadr (memq ?n args)))
6627 (user (cadr (memq ?u args)))
6628 (host (cadr (memq ?h args)))
6629 (channel (cadr (memq ?c args)))
6630 (reason (cadr (memq ?r args))))
6631 (if (string= nick (erc-current-nick))
6632 (format "You have left channel %s" channel)
6633 (format "%s (%s@%s) has left channel %s%s"
6634 nick user host channel
6635 (if (not (string= reason ""))
6636 (format ": %s"
6637 (erc-replace-regexp-in-string "%" "%%" reason))
6638 "")))))
6639
6640
6641 (defvar erc-current-message-catalog 'english)
6642 (make-variable-buffer-local 'erc-current-message-catalog)
6643
6644 (defun erc-retrieve-catalog-entry (entry &optional catalog)
6645 "Retrieve ENTRY from CATALOG.
6646
6647 If CATALOG is nil, `erc-current-message-catalog' is used.
6648
6649 If ENTRY is nil in CATALOG, it is retrieved from the fallback,
6650 english, catalog."
6651 (unless catalog (setq catalog erc-current-message-catalog))
6652 (let ((var (erc-make-message-variable-name catalog entry)))
6653 (if (boundp var)
6654 (symbol-value var)
6655 (when (boundp (erc-make-message-variable-name 'english entry))
6656 (symbol-value (erc-make-message-variable-name 'english entry))))))
6657
6658 (defun erc-format-message (msg &rest args)
6659 "Format MSG according to ARGS.
6660
6661 See also `format-spec'."
6662 (when (eq (logand (length args) 1) 1) ; oddp
6663 (error "Obscure usage of this function appeared"))
6664 (let ((entry (erc-retrieve-catalog-entry msg)))
6665 (when (not entry)
6666 (error "No format spec for message %s" msg))
6667 (when (functionp entry)
6668 (setq entry (apply entry args)))
6669 (format-spec entry (apply #'format-spec-make args))))
6670
6671 ;;; Various hook functions
6672
6673 (add-hook 'kill-buffer-hook 'erc-kill-buffer-function)
6674
6675 (defcustom erc-kill-server-hook '(erc-kill-server)
6676 "Invoked whenever a server buffer is killed via `kill-buffer'."
6677 :group 'erc-hooks
6678 :type 'hook)
6679
6680 (defcustom erc-kill-channel-hook '(erc-kill-channel)
6681 "Invoked whenever a channel-buffer is killed via `kill-buffer'."
6682 :group 'erc-hooks
6683 :type 'hook)
6684
6685 (defcustom erc-kill-buffer-hook nil
6686 "Hook run whenever a non-server or channel buffer is killed.
6687
6688 See also `kill-buffer'."
6689 :group 'erc-hooks
6690 :type 'hook)
6691
6692 (defun erc-kill-buffer-function ()
6693 "Function to call when an ERC buffer is killed.
6694 This function should be on `kill-buffer-hook'.
6695 When the current buffer is in `erc-mode', this function will run
6696 one of the following hooks:
6697 `erc-kill-server-hook' if the server buffer was killed,
6698 `erc-kill-channel-hook' if a channel buffer was killed,
6699 or `erc-kill-buffer-hook' if any other buffer."
6700 (when (eq major-mode 'erc-mode)
6701 (erc-remove-channel-users)
6702 (cond
6703 ((eq (erc-server-buffer) (current-buffer))
6704 (run-hooks 'erc-kill-server-hook))
6705 ((erc-channel-p (erc-default-target))
6706 (run-hooks 'erc-kill-channel-hook))
6707 (t
6708 (run-hooks 'erc-kill-buffer-hook)))))
6709
6710 (defun erc-kill-server ()
6711 "Sends a QUIT command to the server when the server buffer is killed.
6712 This function should be on `erc-kill-server-hook'."
6713 (when (erc-server-process-alive)
6714 (setq erc-server-quitting t)
6715 (erc-server-send (format "QUIT :%s" (funcall erc-quit-reason nil)))))
6716
6717 (defun erc-kill-channel ()
6718 "Sends a PART command to the server when the channel buffer is killed.
6719 This function should be on `erc-kill-channel-hook'."
6720 (when (erc-server-process-alive)
6721 (let ((tgt (erc-default-target)))
6722 (erc-server-send (format "PART %s :%s" tgt
6723 (funcall erc-part-reason nil))
6724 nil tgt))))
6725
6726 ;;; Dealing with `erc-parsed'
6727
6728 (defun erc-find-parsed-property ()
6729 "Find the next occurrence of the `erc-parsed' text property."
6730 (text-property-not-all (point-min) (point-max) 'erc-parsed nil))
6731
6732 (defun erc-restore-text-properties ()
6733 "Restore the property 'erc-parsed for the region."
6734 (let ((parsed-posn (erc-find-parsed-property)))
6735 (put-text-property
6736 (point-min) (point-max)
6737 'erc-parsed (when parsed-posn (erc-get-parsed-vector parsed-posn)))))
6738
6739 (defun erc-get-parsed-vector (point)
6740 "Return the whole parsed vector on POINT."
6741 (get-text-property point 'erc-parsed))
6742
6743 (defun erc-get-parsed-vector-nick (vect)
6744 "Return nickname in the parsed vector VECT."
6745 (let* ((untreated-nick (and vect (erc-response.sender vect)))
6746 (maybe-nick (when untreated-nick
6747 (car (split-string untreated-nick "!")))))
6748 (when (and (not (null maybe-nick))
6749 (erc-is-valid-nick-p maybe-nick))
6750 untreated-nick)))
6751
6752 (defun erc-get-parsed-vector-type (vect)
6753 "Return message type in the parsed vector VECT."
6754 (and vect
6755 (erc-response.command vect)))
6756
6757 ;; Teach url.el how to open irc:// URLs with ERC.
6758 ;; To activate, customize `url-irc-function' to `url-irc-erc'.
6759
6760 ;;;###autoload
6761 (defun erc-handle-irc-url (host port channel user password)
6762 "Use ERC to IRC on HOST:PORT in CHANNEL as USER with PASSWORD.
6763 If ERC is already connected to HOST:PORT, simply /join CHANNEL.
6764 Otherwise, connect to HOST:PORT as USER and /join CHANNEL."
6765 (let ((server-buffer
6766 (car (erc-buffer-filter
6767 (lambda ()
6768 (and (string-equal erc-session-server host)
6769 (= erc-session-port port)
6770 (erc-open-server-buffer-p)))))))
6771 (with-current-buffer (or server-buffer (current-buffer))
6772 (if (and server-buffer channel)
6773 (erc-cmd-JOIN channel)
6774 (erc-open host port (or user (erc-compute-nick)) (erc-compute-full-name)
6775 (not server-buffer) password nil channel
6776 (when server-buffer
6777 (get-buffer-process server-buffer)))))))
6778
6779 (provide 'erc)
6780
6781 ;; Deprecated. We might eventually stop requiring the goodies automatically.
6782 ;; IMPORTANT: This require must appear _after_ the above (provide 'erc) to
6783 ;; avoid a recursive require error when byte-compiling the entire package.
6784 (require 'erc-goodies)
6785
6786 ;;; erc.el ends here
6787 ;;
6788 ;; Local Variables:
6789 ;; outline-regexp: ";;+"
6790 ;; indent-tabs-mode: t
6791 ;; tab-width: 8
6792 ;; End: