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