| blob | 8501e2cba7d21dcf8e23d09f0c332d16891697e6 |
1 ;; erc.el --- An Emacs Internet Relay Chat client -*- lexical-binding:t -*-
3 ;; Copyright (C) 1997-2016 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 <http://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 ;; * http://sv.gnu.org/projects/erc/
39 ;; * http://www.emacswiki.org/cgi-bin/wiki/ERC
43 ;; As of 2006-06-13, ERC development is now hosted on Savannah
44 ;; (http://sv.gnu.org/projects/erc). I invite everyone who wants to
45 ;; hack on it to contact me <mwolson@gnu.org> in order to get write
46 ;; access to the shared Arch archive.
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 "http://emacswiki.org/cgi-bin/wiki/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"
127 ;; 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 :set (lambda (sym val)
1836 ;; disable modules which have just been removed
1837 (when (and (boundp 'erc-modules) erc-modules val)
1838 (dolist (module erc-modules)
1839 (unless (member module val)
1840 (let ((f (intern-soft (format "erc-%s-mode" module))))
1841 (when (and (fboundp f) (boundp f) (symbol-value f))
1842 (message "Disabling `erc-%s'" module)
1843 (funcall f 0))))))
1844 (set sym val)
1845 ;; this test is for the case where erc hasn't been loaded yet
1846 (when (fboundp 'erc-update-modules)
1847 (erc-update-modules)))
1848 :type
1849 '(set
1850 :greedy t
1851 (const :tag "autoaway: Set away status automatically" autoaway)
1852 (const :tag "autojoin: Join channels automatically" autojoin)
1853 (const :tag "button: Buttonize URLs, nicknames, and other text" button)
1854 (const :tag "capab: Mark unidentified users on servers supporting CAPAB"
1855 capab-identify)
1856 (const :tag "completion: Complete nicknames and commands (programmable)"
1857 completion)
1858 (const :tag "hecomplete: Complete nicknames and commands (obsolete, use \"completion\")" hecomplete)
1859 (const :tag "dcc: Provide Direct Client-to-Client support" dcc)
1860 (const :tag "fill: Wrap long lines" fill)
1861 (const :tag "identd: Launch an identd server on port 8113" identd)
1862 (const :tag "irccontrols: Highlight or remove IRC control characters"
1863 irccontrols)
1864 (const :tag "keep-place: Leave point above un-viewed text" keep-place)
1865 (const :tag "list: List channels in a separate buffer" list)
1866 (const :tag "log: Save buffers in logs" log)
1867 (const :tag "match: Highlight pals, fools, and other keywords" match)
1868 (const :tag "menu: Display a menu in ERC buffers" menu)
1869 (const :tag "move-to-prompt: Move to the prompt when typing text"
1870 move-to-prompt)
1871 (const :tag "netsplit: Detect netsplits" netsplit)
1872 (const :tag "networks: Provide data about IRC networks" networks)
1873 (const :tag "noncommands: Don't display non-IRC commands after evaluation"
1874 noncommands)
1875 (const :tag
1876 "notify: Notify when the online status of certain users changes"
1877 notify)
1878 (const :tag "notifications: Send notifications on PRIVMSG or nickname mentions"
1879 notifications)
1880 (const :tag "page: Process CTCP PAGE requests from IRC" page)
1881 (const :tag "readonly: Make displayed lines read-only" readonly)
1882 (const :tag "replace: Replace text in messages" replace)
1883 (const :tag "ring: Enable an input history" ring)
1884 (const :tag "scrolltobottom: Scroll to the bottom of the buffer"
1885 scrolltobottom)
1886 (const :tag "services: Identify to Nickserv (IRC Services) automatically"
1887 services)
1888 (const :tag "smiley: Convert smileys to pretty icons" smiley)
1889 (const :tag "sound: Play sounds when you receive CTCP SOUND requests"
1890 sound)
1891 (const :tag "stamp: Add timestamps to messages" stamp)
1892 (const :tag "spelling: Check spelling" spelling)
1893 (const :tag "track: Track channel activity in the mode-line" track)
1894 (const :tag "truncate: Truncate buffers to a certain size" truncate)
1895 (const :tag "unmorse: Translate morse code in messages" unmorse)
1896 (const :tag "xdcc: Act as an XDCC file-server" xdcc)
1897 (repeat :tag "Others" :inline t symbol))
1898 :group 'erc)
1900 (defun erc-update-modules ()
1901 "Run this to enable erc-foo-mode for all modules in `erc-modules'."
1902 (let (req)
1903 (dolist (mod erc-modules)
1904 (setq req (concat "erc-" (symbol-name mod)))
1905 (cond
1906 ;; yuck. perhaps we should bring the filenames into sync?
1907 ((string= req "erc-capab-identify")
1908 (setq req "erc-capab"))
1909 ((string= req "erc-completion")
1910 (setq req "erc-pcomplete"))
1911 ((string= req "erc-pcomplete")
1912 (setq mod 'completion))
1913 ((string= req "erc-autojoin")
1914 (setq req "erc-join")))
1915 (condition-case nil
1916 (require (intern req))
1917 (error nil))
1918 (let ((sym (intern-soft (concat "erc-" (symbol-name mod) "-mode"))))
1919 (if (fboundp sym)
1920 (funcall sym 1)
1921 (error "`%s' is not a known ERC module" mod))))))
1923 (defun erc-setup-buffer (buffer)
1924 "Consults `erc-join-buffer' to find out how to display `BUFFER'."
1925 (pcase erc-join-buffer
1926 (`window
1927 (if (active-minibuffer-window)
1928 (display-buffer buffer)
1929 (switch-to-buffer-other-window buffer)))
1930 (`window-noselect
1931 (display-buffer buffer))
1932 (`bury
1933 nil)
1934 (`frame
1935 (when (or (not erc-reuse-frames)
1936 (not (get-buffer-window buffer t)))
1937 (let ((frame (make-frame (or erc-frame-alist
1938 default-frame-alist))))
1939 (raise-frame frame)
1940 (select-frame frame))
1941 (switch-to-buffer buffer)
1942 (when erc-frame-dedicated-flag
1943 (set-window-dedicated-p (selected-window) t))))
1944 (_
1945 (if (active-minibuffer-window)
1946 (display-buffer buffer)
1947 (switch-to-buffer buffer)))))
1949 (defun erc-open (&optional server port nick full-name
1950 connect passwd tgt-list channel process)
1951 "Connect to SERVER on PORT as NICK with FULL-NAME.
1953 If CONNECT is non-nil, connect to the server. Otherwise assume
1954 already connected and just create a separate buffer for the new
1955 target CHANNEL.
1957 Use PASSWD as user password on the server. If TGT-LIST is
1958 non-nil, use it to initialize `erc-default-recipients'.
1960 Returns the buffer for the given server or channel."
1961 (let ((server-announced-name (when (and (boundp 'erc-session-server)
1962 (string= server erc-session-server))
1963 erc-server-announced-name))
1964 (connected-p (unless connect erc-server-connected))
1965 (buffer (erc-get-buffer-create server port channel))
1966 (old-buffer (current-buffer))
1967 old-point
1968 continued-session)
1969 (when connect (run-hook-with-args 'erc-before-connect server port nick))
1970 (erc-update-modules)
1971 (set-buffer buffer)
1972 (setq old-point (point))
1973 (let ((old-recon-count erc-server-reconnect-count))
1974 (erc-mode)
1975 (setq erc-server-reconnect-count old-recon-count))
1976 (setq erc-server-announced-name server-announced-name)
1977 (setq erc-server-connected connected-p)
1978 ;; connection parameters
1979 (setq erc-server-process process)
1980 (setq erc-insert-marker (make-marker))
1981 (setq erc-input-marker (make-marker))
1982 ;; go to the end of the buffer and open a new line
1983 ;; (the buffer may have existed)
1984 (goto-char (point-max))
1985 (forward-line 0)
1986 (when (get-text-property (point) 'erc-prompt)
1987 (setq continued-session t)
1988 (set-marker erc-input-marker
1989 (or (next-single-property-change (point) 'erc-prompt)
1990 (point-max))))
1991 (unless continued-session
1992 (goto-char (point-max))
1994 (set-marker erc-insert-marker (point))
1995 ;; stack of default recipients
1996 (setq erc-default-recipients tgt-list)
1997 (setq erc-server-current-nick nil)
1998 ;; Initialize erc-server-users and erc-channel-users
1999 (if connect
2000 (progn ;; server buffer
2001 (setq erc-server-users
2002 (make-hash-table :test 'equal))
2003 (setq erc-channel-users nil))
2004 (progn ;; target buffer
2005 (setq erc-server-users nil)
2006 (setq erc-channel-users
2007 (make-hash-table :test 'equal))))
2008 ;; clear last incomplete line read
2009 (setq erc-server-filter-data nil)
2010 (setq erc-channel-topic "")
2011 ;; limit on the number of users on the channel (mode +l)
2012 (setq erc-channel-user-limit nil)
2013 (setq erc-channel-key nil)
2014 ;; last active buffer, defaults to this one
2015 (erc-set-active-buffer buffer)
2016 ;; last invitation channel
2017 (setq erc-invitation nil)
2018 ;; Server channel list
2019 (setq erc-channel-list ())
2020 ;; login-time 'nick in use' error
2021 (setq erc-bad-nick nil)
2022 ;; whether we have logged in
2023 (setq erc-logged-in nil)
2024 ;; The local copy of `erc-nick' - the list of nicks to choose
2025 (setq erc-default-nicks (if (consp erc-nick) erc-nick (list erc-nick)))
2026 ;; password stuff
2027 (setq erc-session-password
2028 (or passwd
2029 (let ((secret
2030 (plist-get
2031 (nth 0
2032 (auth-source-search :host server
2033 :max 1
2034 :user nick
2035 ;; secrets.el wouldn’t accept a number
2036 :port (if (numberp port) (number-to-string port) port)
2037 :require '(:secret)))
2038 :secret)))
2039 (if (functionp secret)
2040 (funcall secret)
2041 secret))))
2042 ;; debug output buffer
2043 (setq erc-dbuf
2044 (when erc-log-p
2045 (get-buffer-create (concat "*ERC-DEBUG: " server "*"))))
2046 ;; set up prompt
2047 (unless continued-session
2048 (goto-char (point-max))
2050 (if continued-session
2051 (goto-char old-point)
2052 (set-marker erc-insert-marker (point))
2053 (erc-display-prompt)
2054 (goto-char (point-max)))
2056 (erc-determine-parameters server port nick full-name)
2058 ;; Saving log file on exit
2059 (run-hook-with-args 'erc-connect-pre-hook buffer)
2061 (when connect
2062 (erc-server-connect erc-session-server erc-session-port buffer))
2063 (erc-update-mode-line)
2065 ;; Now display the buffer in a window as per user wishes.
2066 (unless (eq buffer old-buffer)
2067 (when erc-log-p
2068 ;; we can't log to debug buffer, it may not exist yet
2069 (message "erc: old buffer %s, switching to %s"
2070 old-buffer buffer))
2071 (erc-setup-buffer buffer))
2073 buffer))
2075 (defun erc-initialize-log-marker (buffer)
2076 "Initialize the `erc-last-saved-position' marker to a sensible position.
2077 BUFFER is the current buffer."
2078 (with-current-buffer buffer
2079 (unless (markerp erc-last-saved-position)
2080 (setq erc-last-saved-position (make-marker))
2081 (move-marker erc-last-saved-position
2082 (1- (marker-position erc-insert-marker))))))
2084 ;; interactive startup
2086 (defvar erc-server-history-list nil
2087 "IRC server interactive selection history list.")
2089 (defvar erc-nick-history-list nil
2090 "Nickname interactive selection history list.")
2092 (defun erc-already-logged-in (server port nick)
2093 "Return the buffers corresponding to a NICK on PORT of a session SERVER.
2094 This is determined by looking for the appropriate buffer and checking
2095 whether the connection is still alive.
2096 If no buffer matches, return nil."
2097 (erc-buffer-list
2098 (lambda ()
2099 (and (erc-server-process-alive)
2100 (string= erc-session-server server)
2101 (erc-port-equal erc-session-port port)
2102 (erc-current-nick-p nick)))))
2104 (defcustom erc-before-connect nil
2105 "Hook called before connecting to a server.
2106 This hook gets executed before `erc' actually invokes `erc-mode'
2107 with your input data. The functions in here get called with three
2108 parameters, SERVER, PORT and NICK."
2109 :group 'erc-hooks
2110 :type 'hook)
2112 (defcustom erc-after-connect nil
2113 "Hook called after connecting to a server.
2114 This hook gets executed when an end of MOTD has been received. All
2115 functions in here get called with the parameters SERVER and NICK."
2116 :group 'erc-hooks
2117 :type 'hook)
2119 ;;;###autoload
2120 (defun erc-select-read-args ()
2121 "Prompt the user for values of nick, server, port, and password."
2122 (let (user-input server port nick passwd)
2123 (setq user-input (read-from-minibuffer
2124 "IRC server: "
2125 (erc-compute-server) nil nil 'erc-server-history-list))
2128 (setq port (erc-string-to-port (match-string 2 user-input))
2129 user-input (match-string 1 user-input))
2130 (setq port
2131 (erc-string-to-port (read-from-minibuffer
2132 "IRC port: " (erc-port-to-string
2133 (erc-compute-port))))))
2136 (setq nick (match-string 1 user-input)
2137 user-input (match-string 2 user-input))
2138 (setq nick
2139 (if (erc-already-logged-in server port nick)
2140 (read-from-minibuffer
2141 (erc-format-message 'nick-in-use ?n nick)
2142 nick
2143 nil nil 'erc-nick-history-list)
2144 (read-from-minibuffer
2145 "Nickname: " (erc-compute-nick nick)
2146 nil nil 'erc-nick-history-list))))
2148 (setq server user-input)
2150 (setq passwd (if erc-prompt-for-password
2151 (if (and erc-password
2152 (y-or-n-p "Use the default password? "))
2153 erc-password
2154 (read-passwd "Password: "))
2155 erc-password))
2156 (when (and passwd (string= "" passwd))
2157 (setq passwd nil))
2159 (while (erc-already-logged-in server port nick)
2160 ;; hmm, this is a problem when using multiple connections to a bnc
2161 ;; with the same nick. Currently this code prevents using more than one
2162 ;; bnc with the same nick. actually it would be nice to have
2163 ;; bncs transparent, so that erc-compute-buffer-name displays
2164 ;; the server one is connected to.
2165 (setq nick (read-from-minibuffer
2166 (erc-format-message 'nick-in-use ?n nick)
2167 nick
2168 nil nil 'erc-nick-history-list)))
2169 (list :server server :port port :nick nick :password passwd)))
2171 ;;;###autoload
2172 (cl-defun erc (&key (server (erc-compute-server))
2173 (port (erc-compute-port))
2174 (nick (erc-compute-nick))
2175 password
2176 (full-name (erc-compute-full-name)))
2177 "ERC is a powerful, modular, and extensible IRC client.
2178 This function is the main entry point for ERC.
2180 It permits you to select connection parameters, and then starts ERC.
2182 Non-interactively, it takes the keyword arguments
2183 (server (erc-compute-server))
2184 (port (erc-compute-port))
2185 (nick (erc-compute-nick))
2186 password
2187 (full-name (erc-compute-full-name)))
2189 That is, if called with
2193 then the server and full-name will be set to those values, whereas
2194 `erc-compute-port', `erc-compute-nick' and `erc-compute-full-name' will
2195 be invoked for the values of the other parameters."
2196 (interactive (erc-select-read-args))
2197 (erc-open server port nick full-name t password))
2199 ;;;###autoload
2200 (defalias 'erc-select 'erc)
2201 (defalias 'erc-ssl 'erc-tls)
2203 ;;;###autoload
2204 (defun erc-tls (&rest r)
2205 "Interactively select TLS connection parameters and run ERC.
2206 Arguments are the same as for `erc'."
2207 (interactive (let ((erc-default-port erc-default-port-tls))
2208 (erc-select-read-args)))
2209 (let ((erc-server-connect-function 'erc-open-tls-stream))
2210 (apply #'erc r)))
2212 (defun erc-open-tls-stream (name buffer host port)
2213 "Open an TLS stream to an IRC server.
2214 The process will be given the name NAME, its target buffer will be
2215 BUFFER. HOST and PORT specify the connection target."
2216 (open-network-stream name buffer host port
2217 :nowait t
2218 :type 'tls))
2220 ;;; Displaying error messages
2222 (defun erc-error (&rest args)
2223 "Pass ARGS to `format', and display the result as an error message.
2224 If `debug-on-error' is set to non-nil, then throw a real error with this
2225 message instead, to make debugging easier."
2226 (if debug-on-error
2227 (apply #'error args)
2228 (apply #'message args)
2229 (beep)))
2231 ;;; Debugging the protocol
2233 (defvar erc-debug-irc-protocol nil
2236 The buffer is created if it doesn't exist.
2238 NOTE: If this variable is non-nil, and you kill the only
2240 but you won't see it.
2242 WARNING: Do not set this variable directly! Instead, use the
2243 function `erc-toggle-debug-irc-protocol' to toggle its value.")
2245 (declare-function erc-network-name "erc-networks" ())
2247 (defun erc-log-irc-protocol (string &optional outbound)
2248 "Append STRING to the buffer *erc-protocol*.
2250 This only has any effect if `erc-debug-irc-protocol' is non-nil.
2252 The buffer is created if it doesn't exist.
2254 If OUTBOUND is non-nil, STRING is being sent to the IRC server
2255 and appears in face `erc-input-face' in the buffer."
2256 (when erc-debug-irc-protocol
2257 (let ((network-name (or (ignore-errors (erc-network-name))
2258 "???")))
2259 (with-current-buffer (get-buffer-create "*erc-protocol*")
2260 (save-excursion
2261 (goto-char (point-max))
2262 (let ((inhibit-read-only t))
2263 (insert (if (not outbound)
2264 ;; Cope with the fact that string might
2265 ;; contain multiple lines of text.
2266 (let ((lines (delete "" (split-string string
2268 (result ""))
2269 (dolist (line lines)
2270 (setq result (concat result network-name
2272 result)
2273 (erc-propertize
2274 (concat network-name " >> " string
2276 (aref string
2277 (1- (length string))))
2279 'font-lock-face 'erc-input-face)))))
2280 (let ((orig-win (selected-window))
2281 (debug-buffer-window (get-buffer-window (current-buffer) t)))
2282 (when debug-buffer-window
2283 (select-window debug-buffer-window)
2284 (when (= 1 (count-lines (point) (point-max)))
2285 (goto-char (point-max))
2286 (recenter -1))
2287 (select-window orig-win)))))))
2289 (defun erc-toggle-debug-irc-protocol (&optional arg)
2290 "Toggle the value of `erc-debug-irc-protocol'.
2292 If ARG is non-nil, show the *erc-protocol* buffer."
2293 (interactive "P")
2294 (let* ((buf (get-buffer-create "*erc-protocol*")))
2295 (with-current-buffer buf
2296 (erc-view-mode-enter)
2297 (when (null (current-local-map))
2298 (let ((inhibit-read-only t))
2299 (insert (erc-make-notice "This buffer displays all IRC protocol traffic exchanged with each server.\n"))
2301 (use-local-map (make-sparse-keymap))
2302 (local-set-key (kbd "t") 'erc-toggle-debug-irc-protocol))
2303 (add-hook 'kill-buffer-hook
2304 #'(lambda () (setq erc-debug-irc-protocol nil))
2305 nil 'local)
2306 (goto-char (point-max))
2307 (let ((inhibit-read-only t))
2308 (insert (erc-make-notice
2310 (if erc-debug-irc-protocol "disabled" "enabled")
2311 (current-time-string))))))
2312 (setq erc-debug-irc-protocol (not erc-debug-irc-protocol))
2313 (if (and arg
2314 (not (get-buffer-window "*erc-protocol*" t)))
2315 (display-buffer buf t))
2316 (message "IRC protocol traffic logging %s (see buffer *erc-protocol*)."
2317 (if erc-debug-irc-protocol "enabled" "disabled"))))
2319 ;;; I/O interface
2321 ;; send interface
2323 (defun erc-send-action (tgt str &optional force)
2324 "Send CTCP ACTION information described by STR to TGT."
2325 (erc-send-ctcp-message tgt (format "ACTION %s" str) force)
2326 (erc-display-message
2327 nil 'input (current-buffer)
2328 'ACTION ?n (erc-current-nick) ?a str ?u "" ?h ""))
2330 ;; Display interface
2332 (defun erc-string-invisible-p (string)
2333 "Check whether STRING is invisible or not.
2334 I.e. any char in it has the `invisible' property set."
2335 (text-property-any 0 (length string) 'invisible t string))
2337 (defcustom erc-remove-parsed-property t
2338 "Whether to remove the erc-parsed text property after displaying a message.
2340 The default is to remove it, since it causes ERC to take up extra
2341 memory. If you have code that relies on this property, then set
2342 this option to nil."
2343 :type 'boolean
2344 :group 'erc)
2346 (defun erc-display-line-1 (string buffer)
2347 "Display STRING in `erc-mode' BUFFER.
2348 Auxiliary function used in `erc-display-line'. The line gets filtered to
2349 interpret the control characters. Then, `erc-insert-pre-hook' gets called.
2350 If `erc-insert-this' is still t, STRING gets inserted into the buffer.
2351 Afterwards, `erc-insert-modify' and `erc-insert-post-hook' get called.
2352 If STRING is nil, the function does nothing."
2353 (when string
2354 (with-current-buffer (or buffer (process-buffer erc-server-process))
2355 (let ((insert-position (or (marker-position erc-insert-marker)
2356 (point-max))))
2357 (let ((string string) ;; FIXME! Can this be removed?
2358 (buffer-undo-list t)
2359 (inhibit-read-only t))
2362 (when (erc-string-invisible-p string)
2363 (erc-put-text-properties 0 (length string)
2364 '(invisible intangible) string)))
2365 (erc-log (concat "erc-display-line: " string
2366 (format "(%S)" string) " in buffer "
2367 (format "%s" buffer)))
2368 (setq erc-insert-this t)
2369 (run-hook-with-args 'erc-insert-pre-hook string)
2370 (if (null erc-insert-this)
2371 ;; Leave erc-insert-this set to t as much as possible. Fran
2372 ;; Litterio <franl> has seen erc-insert-this set to nil while
2373 ;; erc-send-pre-hook is running, which should never happen. This
2374 ;; may cure it.
2375 (setq erc-insert-this t)
2376 (save-excursion ;; to restore point in the new buffer
2377 (save-restriction
2378 (widen)
2379 (goto-char insert-position)
2380 (insert-before-markers string)
2381 ;; run insertion hook, with point at restored location
2382 (save-restriction
2383 (narrow-to-region insert-position (point))
2384 (run-hooks 'erc-insert-modify-hook)
2385 (run-hooks 'erc-insert-post-hook)
2386 (when erc-remove-parsed-property
2387 (remove-text-properties (point-min) (point-max)
2388 '(erc-parsed nil))))))))
2389 (erc-update-undo-list (- (or (marker-position erc-insert-marker)
2390 (point-max))
2391 insert-position))))))
2393 (defun erc-update-undo-list (shift)
2394 ;; Translate buffer positions in buffer-undo-list by SHIFT.
2395 (unless (or (zerop shift) (atom buffer-undo-list))
2396 (let ((list buffer-undo-list) elt)
2397 (while list
2398 (setq elt (car list))
2399 (cond ((integerp elt) ; POSITION
2400 (cl-incf (car list) shift))
2401 ((or (atom elt) ; nil, EXTENT
2402 ;; (eq t (car elt)) ; (t . TIME)
2403 (markerp (car elt))) ; (MARKER . DISTANCE)
2404 nil)
2405 ((integerp (car elt)) ; (BEGIN . END)
2406 (cl-incf (car elt) shift)
2407 (cl-incf (cdr elt) shift))
2408 ((stringp (car elt)) ; (TEXT . POSITION)
2409 (cl-incf (cdr elt) (* (if (natnump (cdr elt)) 1 -1) shift)))
2410 ((null (car elt)) ; (nil PROPERTY VALUE BEG . END)
2411 (let ((cons (nthcdr 3 elt)))
2412 (cl-incf (car cons) shift)
2413 (cl-incf (cdr cons) shift)))
2414 ((and (featurep 'xemacs)
2415 (extentp (car elt))) ; (EXTENT START END)
2416 (cl-incf (nth 1 elt) shift)
2417 (cl-incf (nth 2 elt) shift)))
2418 (setq list (cdr list))))))
2421 "Regexp which matches all valid characters in a IRC nickname.")
2423 (defun erc-is-valid-nick-p (nick)
2424 "Check if NICK is a valid IRC nickname."
2427 (defun erc-display-line (string &optional buffer)
2428 "Display STRING in the ERC BUFFER.
2429 All screen output must be done through this function. If BUFFER is nil
2430 or omitted, the default ERC buffer for the `erc-session-server' is used.
2431 The BUFFER can be an actual buffer, a list of buffers, `all' or `active'.
2432 If BUFFER = `all', the string is displayed in all the ERC buffers for the
2433 current session. `active' means the current active buffer
2434 \(`erc-active-buffer'). If the buffer can't be resolved, the current
2435 buffer is used. `erc-display-line-1' is used to display STRING.
2437 If STRING is nil, the function does nothing."
2438 (let ((inhibit-point-motion-hooks t)
2439 new-bufs)
2440 (dolist (buf (cond
2441 ((bufferp buffer) (list buffer))
2442 ((listp buffer) buffer)
2443 ((processp buffer) (list (process-buffer buffer)))
2444 ((eq 'all buffer)
2445 ;; Hmm, or all of the same session server?
2446 (erc-buffer-list nil erc-server-process))
2447 ((and (eq 'active buffer) (erc-active-buffer))
2448 (list (erc-active-buffer)))
2449 ((erc-server-buffer-live-p)
2450 (list (process-buffer erc-server-process)))
2451 (t (list (current-buffer)))))
2452 (when (buffer-live-p buf)
2453 (erc-display-line-1 string buf)
2454 (push buf new-bufs)))
2455 (when (null new-bufs)
2456 (erc-display-line-1 string (if (erc-server-buffer-live-p)
2457 (process-buffer erc-server-process)
2458 (current-buffer))))))
2460 (defun erc-display-message-highlight (type string)
2461 "Highlight STRING according to TYPE, where erc-TYPE-face is an ERC face.
2463 See also `erc-make-notice'."
2464 (cond ((eq type 'notice)
2465 (erc-make-notice string))
2466 (t
2467 (erc-put-text-property
2468 0 (length string)
2469 'font-lock-face (or (intern-soft
2470 (concat "erc-" (symbol-name type) "-face"))
2471 "erc-default-face")
2472 string)
2473 string)))
2475 (defvar erc-lurker-state nil
2476 "Track the time of the last PRIVMSG for each (server,nick) pair.
2478 This is implemented as a hash of hashes, where the outer key is
2479 the canonicalized server name (as returned by
2480 `erc-canonicalize-server-name') and the outer value is a hash
2481 table mapping nicks (as returned by `erc-lurker-maybe-trim') to
2482 the times of their most recently received PRIVMSG on any channel
2483 on the given server.")
2485 (defcustom erc-lurker-trim-nicks t
2486 "If t, trim trailing `erc-lurker-ignore-chars' from nicks.
2489 individual for activity tracking and lurkiness detection
2490 purposes."
2491 :group 'erc-lurker
2492 :type 'boolean)
2494 (defcustom erc-lurker-ignore-chars "`_"
2495 "Characters at the end of a nick to strip for activity tracking purposes.
2497 See also `erc-lurker-trim-nicks'."
2498 :group 'erc-lurker
2499 :type 'string)
2501 (defun erc-lurker-maybe-trim (nick)
2502 "Maybe trim trailing `erc-lurker-ignore-chars' from NICK.
2504 Returns NICK unmodified unless `erc-lurker-trim-nicks' is
2505 non-nil."
2506 (if erc-lurker-trim-nicks
2507 (replace-regexp-in-string
2508 (format "[%s]"
2509 (mapconcat (lambda (char)
2510 (regexp-quote (char-to-string char)))
2511 erc-lurker-ignore-chars ""))
2512 "" nick)
2513 nick))
2515 (defcustom erc-lurker-hide-list nil
2516 "List of IRC type messages to hide when sent by lurkers.
2519 See also `erc-lurker-p' and `erc-hide-list'."
2520 :group 'erc-lurker
2521 :type 'erc-message-type)
2523 (defcustom erc-lurker-threshold-time (* 60 60 24) ; 24h by default
2524 "Nicks from which no PRIVMSGs have been received within this
2525 interval (in units of seconds) are considered lurkers by
2526 `erc-lurker-p' and as a result their messages of types in
2527 `erc-lurker-hide-list' will be hidden."
2528 :group 'erc-lurker
2529 :type 'integer)
2531 (defun erc-lurker-initialize ()
2532 "Initialize ERC lurker tracking functionality.
2534 This function adds `erc-lurker-update-status' to
2535 `erc-insert-pre-hook' in order to record the time of each nick's
2536 most recent PRIVMSG as well as initializing the state variable
2537 storing this information."
2538 (setq erc-lurker-state (make-hash-table :test 'equal))
2539 (add-hook 'erc-insert-pre-hook 'erc-lurker-update-status))
2541 (defun erc-lurker-cleanup ()
2542 "Remove all last PRIVMSG state older than `erc-lurker-threshold-time'.
2544 This should be called regularly to avoid excessive resource
2545 consumption for long-lived IRC or Emacs sessions."
2546 (maphash
2547 (lambda (server hash)
2548 (maphash
2549 (lambda (nick last-PRIVMSG-time)
2550 (when
2551 (> (float-time (time-subtract
2552 (current-time)
2553 last-PRIVMSG-time))
2554 erc-lurker-threshold-time)
2555 (remhash nick hash)))
2556 hash)
2557 (if (zerop (hash-table-count hash))
2558 (remhash server erc-lurker-state)))
2559 erc-lurker-state))
2561 (defvar erc-lurker-cleanup-count 0
2562 "Internal counter variable for use with `erc-lurker-cleanup-interval'.")
2564 (defvar erc-lurker-cleanup-interval 100
2565 "Frequency of cleaning up stale erc-lurker state.
2567 `erc-lurker-update-status' calls `erc-lurker-cleanup' once for
2568 every `erc-lurker-cleanup-interval' updates to
2569 `erc-lurker-state'. This is designed to limit the memory
2570 consumption of lurker state during long Emacs sessions and/or ERC
2571 sessions with large numbers of incoming PRIVMSGs.")
2573 (defun erc-lurker-update-status (_message)
2574 "Update `erc-lurker-state' if necessary.
2576 This function is called from `erc-insert-pre-hook'. If the
2577 current message is a PRIVMSG, update `erc-lurker-state' to
2578 reflect the fact that its sender has issued a PRIVMSG at the
2579 current time. Otherwise, take no action.
2581 This function depends on the fact that `erc-display-message'
2582 dynamically binds `parsed', which is used to check if the current
2583 message is a PRIVMSG and to determine its sender. See also
2584 `erc-lurker-trim-nicks' and `erc-lurker-ignore-chars'.
2586 In order to limit memory consumption, this function also calls
2587 `erc-lurker-cleanup' once every `erc-lurker-cleanup-interval'
2588 updates of `erc-lurker-state'."
2589 (when (and (boundp 'parsed) (erc-response-p parsed))
2590 (let* ((command (erc-response.command parsed))
2591 (sender
2592 (erc-lurker-maybe-trim
2593 (car (erc-parse-user (erc-response.sender parsed)))))
2594 (server
2595 (erc-canonicalize-server-name erc-server-announced-name)))
2596 (when (equal command "PRIVMSG")
2597 (when (>= (cl-incf erc-lurker-cleanup-count)
2598 erc-lurker-cleanup-interval)
2599 (setq erc-lurker-cleanup-count 0)
2600 (erc-lurker-cleanup))
2601 (unless (gethash server erc-lurker-state)
2602 (puthash server (make-hash-table :test 'equal) erc-lurker-state))
2603 (puthash sender (current-time)
2604 (gethash server erc-lurker-state))))))
2606 (defun erc-lurker-p (nick)
2607 "Predicate indicating NICK's lurking status on the current server.
2609 Lurking is the condition where NICK has issued no PRIVMSG on this
2610 server within `erc-lurker-threshold-time'. See also
2611 `erc-lurker-trim-nicks' and `erc-lurker-ignore-chars'."
2612 (unless erc-lurker-state (erc-lurker-initialize))
2613 (let* ((server
2614 (erc-canonicalize-server-name erc-server-announced-name))
2615 (last-PRIVMSG-time
2616 (gethash (erc-lurker-maybe-trim nick)
2617 (gethash server erc-lurker-state (make-hash-table)))))
2618 (or (null last-PRIVMSG-time)
2619 (> (float-time
2620 (time-subtract (current-time) last-PRIVMSG-time))
2621 erc-lurker-threshold-time))))
2623 (defcustom erc-common-server-suffixes
2627 "Alist of common server name suffixes.
2628 This variable is used in mode-line display to save screen
2629 real estate. Set it to nil if you want to avoid changing
2630 displayed hostnames."
2631 :group 'erc-mode-line-and-header
2632 :type 'alist)
2634 (defun erc-canonicalize-server-name (server)
2635 "Return the canonical network name for SERVER if any,
2636 otherwise `erc-server-announced-name'. SERVER is matched against
2637 `erc-common-server-suffixes'."
2638 (when server
2639 (or (cdar (erc-remove-if-not
2640 (lambda (net) (string-match (car net) server))
2641 erc-common-server-suffixes))
2642 erc-server-announced-name)))
2644 (defun erc-add-targets (scope target-list)
2645 (let ((targets
2646 (mapcar (lambda (targets) (member scope targets)) target-list)))
2647 (cdr (apply 'append (delete nil targets)))))
2649 (defun erc-hide-current-message-p (parsed)
2650 "Predicate indicating whether the parsed ERC response PARSED should be hidden.
2652 Messages are always hidden if the message type of PARSED appears in
2653 `erc-hide-list'. Message types that appear in `erc-network-hide-list'
2654 or `erc-channel-hide-list' are are only hidden if the target matches
2655 the network or channel in the list. In addition, messages whose type
2656 is a member of `erc-lurker-hide-list' are hidden if `erc-lurker-p'
2657 returns non-nil."
2658 (let* ((command (erc-response.command parsed))
2659 (sender (car (erc-parse-user (erc-response.sender parsed))))
2660 (channel (nth 1 (erc-response.command-args parsed)))
2661 (network (or (and (fboundp 'erc-network-name) (erc-network-name))
2662 (erc-shorten-server-name
2663 (or erc-server-announced-name
2664 erc-session-server))))
2665 (current-hide-list
2666 (when erc-network-hide-list
2667 (erc-add-targets network erc-network-hide-list)))
2668 (current-hide-list
2669 (apply 'append current-hide-list
2670 (when erc-channel-hide-list
2671 (erc-add-targets channel erc-channel-hide-list)))))
2672 (or (member command erc-hide-list)
2673 (member command current-hide-list)
2674 (and (member command erc-lurker-hide-list) (erc-lurker-p sender)))))
2676 (defun erc-display-message (parsed type buffer msg &rest args)
2677 "Display MSG in BUFFER.
2679 ARGS, PARSED, and TYPE are used to format MSG sensibly.
2681 See also `erc-format-message' and `erc-display-line'."
2682 (let ((string (if (symbolp msg)
2683 (apply #'erc-format-message msg args)
2684 msg)))
2685 (setq string
2686 (cond
2687 ((null type)
2688 string)
2689 ((listp type)
2690 (mapc (lambda (type)
2691 (setq string
2692 (erc-display-message-highlight type string)))
2693 type)
2694 string)
2695 ((symbolp type)
2696 (erc-display-message-highlight type string))))
2698 (if (not (erc-response-p parsed))
2699 (erc-display-line string buffer)
2700 (unless (erc-hide-current-message-p parsed)
2701 (erc-put-text-property 0 (length string) 'erc-parsed parsed string)
2702 (erc-put-text-property 0 (length string) 'rear-sticky t string)
2703 (erc-display-line string buffer)))))
2705 (defun erc-message-type-member (position list)
2706 "Return non-nil if the erc-parsed text-property at POSITION is in LIST.
2708 This function relies on the erc-parsed text-property being
2709 present."
2710 (let ((prop-val (erc-get-parsed-vector position)))
2711 (and prop-val (member (erc-response.command prop-val) list))))
2713 (defvar erc-send-input-line-function 'erc-send-input-line)
2714 (make-variable-buffer-local 'erc-send-input-line-function)
2716 (defun erc-send-input-line (target line &optional force)
2717 "Send LINE to TARGET.
2719 See also `erc-server-send'."
2720 (setq line (format "PRIVMSG %s :%s"
2721 target
2722 ;; If the line is empty, we still want to
2723 ;; send it - i.e. an empty pasted line.
2726 line)))
2727 (erc-server-send line force target))
2729 (defun erc-get-arglist (fun)
2730 "Return the argument list of a function without the parens."
2731 (let ((arglist (format "%S" (erc-function-arglist fun))))
2733 (match-string 1 arglist)
2734 arglist)))
2736 (defun erc-command-no-process-p (str)
2737 "Return non-nil if STR is an ERC command that can be run when the process
2738 is not alive, nil otherwise."
2739 (let ((fun (erc-extract-command-from-line str)))
2740 (and fun
2741 (symbolp (car fun))
2742 (get (car fun) 'process-not-needed))))
2744 (defun erc-command-name (cmd)
2745 "For CMD being the function name of a ERC command, something like
2746 erc-cmd-FOO, this returns a string /FOO."
2747 (let ((command-name (symbol-name cmd)))
2749 (concat "/" (match-string 1 command-name))
2750 command-name)))
2752 (defun erc-process-input-line (line &optional force no-command)
2753 "Translate LINE to an RFC1459 command and send it based.
2754 Returns non-nil if the command is actually sent to the server, and nil
2755 otherwise.
2757 If the command in the LINE is not bound as a function `erc-cmd-<COMMAND>',
2758 it is passed to `erc-cmd-default'. If LINE is not a command (i.e. doesn't
2759 start with /<COMMAND>) then it is sent as a message.
2761 An optional FORCE argument forces sending the line when flood
2762 protection is in effect. The optional NO-COMMAND argument prohibits
2763 this function from interpreting the line as a command."
2764 (let ((command-list (erc-extract-command-from-line line)))
2765 (if (and command-list
2766 (not no-command))
2767 (let* ((cmd (nth 0 command-list))
2768 (args (nth 1 command-list)))
2769 (condition-case nil
2770 (if (listp args)
2771 (apply cmd args)
2772 (funcall cmd args))
2773 (wrong-number-of-arguments
2774 (erc-display-message nil 'error (current-buffer) 'incorrect-args
2775 ?c (erc-command-name cmd)
2776 ?u (or (erc-get-arglist cmd)
2777 "")
2779 (or (documentation cmd) "")))
2780 nil)))
2781 (let ((r (erc-default-target)))
2782 (if r
2783 (funcall erc-send-input-line-function r line force)
2784 (erc-display-message nil 'error (current-buffer) 'no-target)
2785 nil)))))
2787 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2788 ;; Input commands handlers
2789 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2791 (defun erc-cmd-AMSG (line)
2792 "Send LINE to all channels of the current server that you are on."
2793 (interactive "sSend to all channels you're on: ")
2794 (setq line (erc-trim-string line))
2795 (erc-with-all-buffers-of-server nil
2796 (lambda ()
2797 (erc-channel-p (erc-default-target)))
2798 (erc-send-message line)))
2799 (put 'erc-cmd-AMSG 'do-not-parse-args t)
2801 (defun erc-cmd-SAY (line)
2802 "Send LINE to the current query or channel as a message, not a command.
2804 Use this when you want to send a message with a leading `/'. Note
2805 that since multi-line messages are never a command, you don't
2806 need this when pasting multiple lines of text."
2808 nil
2810 (erc-process-input-line (match-string 1 line) nil t)))
2811 (put 'erc-cmd-SAY 'do-not-parse-args t)
2813 (defun erc-cmd-SET (line)
2814 "Set the variable named by the first word in LINE to some VALUE.
2815 VALUE is computed by evaluating the rest of LINE in Lisp."
2816 (cond
2818 (let ((var (read (concat "erc-" (match-string 1 line))))
2819 (val (read (match-string 2 line))))
2820 (if (boundp var)
2821 (progn
2822 (set var (eval val))
2823 (erc-display-message
2824 nil nil 'active (format "Set %S to %S" var val))
2825 t)
2826 (setq var (read (match-string 1 line)))
2827 (if (boundp var)
2828 (progn
2829 (set var (eval val))
2830 (erc-display-message
2831 nil nil 'active (format "Set %S to %S" var val))
2832 t)
2833 (erc-display-message nil 'error 'active 'variable-not-bound)
2834 nil))))
2836 (erc-display-line
2838 (apply
2839 #'concat
2840 (mapcar
2841 (lambda (var)
2842 (let ((val (symbol-value var)))
2843 (concat (format "%S:" var)
2844 (if (consp val)
2847 (apropos-internal "^erc-" 'custom-variable-p))))
2848 (current-buffer))
2849 t)
2850 (t nil)))
2851 (defalias 'erc-cmd-VAR 'erc-cmd-SET)
2852 (defalias 'erc-cmd-VARIABLE 'erc-cmd-SET)
2853 (put 'erc-cmd-SET 'do-not-parse-args t)
2854 (put 'erc-cmd-SET 'process-not-needed t)
2856 (defun erc-cmd-default (line)
2857 "Fallback command.
2859 Commands for which no erc-cmd-xxx exists, are tunneled through
2860 this function. LINE is sent to the server verbatim, and
2861 therefore has to contain the command itself as well."
2862 (erc-log (format "cmd: DEFAULT: %s" line))
2863 (erc-server-send (substring line 1))
2864 t)
2866 (defun erc-cmd-IGNORE (&optional user)
2867 "Ignore USER. This should be a regexp matching nick!user@host.
2868 If no USER argument is specified, list the contents of `erc-ignore-list'."
2869 (if user
2870 (let ((quoted (regexp-quote user)))
2871 (when (and (not (string= user quoted))
2872 (y-or-n-p (format "Use regexp-quoted form (%s) instead? "
2873 quoted)))
2874 (setq user quoted))
2875 (erc-display-line
2876 (erc-make-notice (format "Now ignoring %s" user))
2877 'active)
2878 (erc-with-server-buffer (add-to-list 'erc-ignore-list user)))
2879 (if (null (erc-with-server-buffer erc-ignore-list))
2880 (erc-display-line (erc-make-notice "Ignore list is empty") 'active)
2881 (erc-display-line (erc-make-notice "Ignore list:") 'active)
2882 (mapc #'(lambda (item)
2883 (erc-display-line (erc-make-notice item)
2884 'active))
2885 (erc-with-server-buffer erc-ignore-list))))
2886 t)
2888 (defun erc-cmd-UNIGNORE (user)
2889 "Remove the user specified in USER from the ignore list."
2890 (let ((ignored-nick (car (erc-with-server-buffer
2891 (erc-member-ignore-case (regexp-quote user)
2892 erc-ignore-list)))))
2893 (unless ignored-nick
2894 (if (setq ignored-nick (erc-ignored-user-p user))
2895 (unless (y-or-n-p (format "Remove this regexp (%s)? "
2896 ignored-nick))
2897 (setq ignored-nick nil))
2898 (erc-display-line
2899 (erc-make-notice (format "%s is not currently ignored!" user))
2900 'active)))
2901 (when ignored-nick
2902 (erc-display-line
2903 (erc-make-notice (format "No longer ignoring %s" user))
2904 'active)
2905 (erc-with-server-buffer
2906 (setq erc-ignore-list (delete ignored-nick erc-ignore-list)))))
2907 t)
2909 (defun erc-cmd-CLEAR ()
2910 "Clear the window content."
2911 (recenter 0)
2912 t)
2913 (put 'erc-cmd-CLEAR 'process-not-needed t)
2915 (defun erc-cmd-OPS ()
2916 "Show the ops in the current channel."
2917 (interactive)
2918 (let ((ops nil))
2919 (if erc-channel-users
2920 (maphash (lambda (_nick user-data)
2921 (let ((cuser (cdr user-data)))
2922 (if (and cuser
2923 (erc-channel-user-op cuser))
2924 (setq ops (cons (erc-server-user-nickname
2925 (car user-data))
2926 ops)))))
2927 erc-channel-users))
2928 (setq ops (sort ops 'string-lessp))
2929 (if ops
2930 (erc-display-message
2931 nil 'notice (current-buffer) 'ops
2932 ?i (length ops) ?s (if (> (length ops) 1) "s" "")
2933 ?o (mapconcat 'identity ops " "))
2934 (erc-display-message nil 'notice (current-buffer) 'ops-none)))
2935 t)
2937 (defun erc-cmd-COUNTRY (tld)
2938 "Display the country associated with the top level domain TLD."
2939 (require 'mail-extr)
2940 (let ((co (ignore-errors (what-domain tld))))
2941 (if co
2942 (erc-display-message
2943 nil 'notice 'active 'country ?c co ?d tld)
2944 (erc-display-message
2945 nil 'notice 'active 'country-unknown ?d tld))
2946 t))
2947 (put 'erc-cmd-COUNTRY 'process-not-needed t)
2949 (defun erc-cmd-AWAY (line)
2950 "Mark the user as being away, the reason being indicated by LINE.
2951 If no reason is given, unset away status."
2953 (let ((reason (match-string 1 line)))
2954 (erc-log (format "cmd: AWAY: %s" reason))
2955 (erc-server-send
2956 (if (string= reason "")
2957 "AWAY"
2958 (concat "AWAY :" reason))))
2959 t))
2960 (put 'erc-cmd-AWAY 'do-not-parse-args t)
2962 (defun erc-cmd-GAWAY (line)
2963 "Mark the user as being away everywhere, the reason being indicated by LINE."
2964 ;; on all server buffers.
2965 (erc-with-all-buffers-of-server nil
2966 #'erc-open-server-buffer-p
2967 (erc-cmd-AWAY line)))
2968 (put 'erc-cmd-GAWAY 'do-not-parse-args t)
2970 (defun erc-cmd-CTCP (nick cmd &rest args)
2971 "Send a Client To Client Protocol message to NICK.
2973 CMD is the CTCP command, possible values being ECHO, FINGER, CLIENTINFO, TIME,
2974 VERSION and so on. It is called with ARGS."
2975 (let ((str (concat cmd
2976 (when args
2977 (concat " " (mapconcat #'identity args " "))))))
2978 (erc-log (format "cmd: CTCP [%s]: [%s]" nick str))
2979 (erc-send-ctcp-message nick str)
2980 t))
2982 (defun erc-cmd-HELP (&optional func)
2983 "Popup help information.
2985 If FUNC contains a valid function or variable, help about that
2986 will be displayed. If FUNC is empty, display an apropos about
2987 ERC commands. Otherwise, do `apropos' in the ERC namespace
2990 Examples:
2991 To find out about erc and bbdb, do
2992 /help bbdb.*
2994 For help about the WHOIS command, do:
2995 /help whois
2997 For a list of user commands (/join /part, ...):
2998 /help."
2999 (if func
3000 (let* ((sym (or (let ((sym (intern-soft
3001 (concat "erc-cmd-" (upcase func)))))
3002 (if (and sym (or (boundp sym) (fboundp sym)))
3003 sym
3004 nil))
3005 (let ((sym (intern-soft func)))
3006 (if (and sym (or (boundp sym) (fboundp sym)))
3007 sym
3008 nil))
3009 (let ((sym (intern-soft (concat "erc-" func))))
3010 (if (and sym (or (boundp sym) (fboundp sym)))
3011 sym
3012 nil)))))
3013 (if sym
3014 (cond
3015 ((boundp sym) (describe-variable sym))
3016 ((fboundp sym) (describe-function sym))
3017 (t nil))
3018 (apropos-command (concat "erc-.*" func) nil
3019 (lambda (x)
3020 (or (commandp x)
3021 (get x 'custom-type))))
3022 t))
3023 (apropos "erc-cmd-")
3024 (message "Type C-h m to get additional information about keybindings.")
3025 t))
3027 (defalias 'erc-cmd-H 'erc-cmd-HELP)
3028 (put 'erc-cmd-HELP 'process-not-needed t)
3030 (defun erc-cmd-JOIN (channel &optional key)
3031 "Join the channel given in CHANNEL, optionally with KEY.
3033 were most recently invited. See also `invitation'."
3034 (let (chnl)
3035 (if (string= (upcase channel) "-INVITE")
3036 (if erc-invitation
3037 (setq chnl erc-invitation)
3038 (erc-display-message nil 'error (current-buffer) 'no-invitation))
3039 (setq chnl (erc-ensure-channel-name channel)))
3040 (when chnl
3041 ;; Prevent double joining of same channel on same server.
3042 (let ((joined-channels
3043 (mapcar #'(lambda (chanbuf)
3044 (with-current-buffer chanbuf (erc-default-target)))
3045 (erc-channel-list erc-server-process))))
3046 (if (erc-member-ignore-case chnl joined-channels)
3047 (switch-to-buffer (car (erc-member-ignore-case chnl
3048 joined-channels)))
3049 (erc-log (format "cmd: JOIN: %s" chnl))
3050 (erc-server-send (if (and chnl key)
3051 (format "JOIN %s %s" chnl key)
3052 (format "JOIN %s" chnl)))))))
3053 t)
3055 (defalias 'erc-cmd-CHANNEL 'erc-cmd-JOIN)
3056 (defalias 'erc-cmd-J 'erc-cmd-JOIN)
3058 (defvar erc-channel-new-member-names nil
3059 "If non-nil, a names list is currently being received.
3061 If non-nil, this variable is a hash-table that associates
3062 received nicks with t.")
3063 (make-variable-buffer-local 'erc-channel-new-member-names)
3065 (defun erc-cmd-NAMES (&optional channel)
3066 "Display the users in CHANNEL.
3067 If CHANNEL is not specified, display the users in the current channel.
3068 This function clears the channel name list first, then sends the
3069 command."
3070 (let ((tgt (or (and (erc-channel-p channel) channel)
3071 (erc-default-target))))
3072 (if (and tgt (erc-channel-p tgt))
3073 (progn
3074 (erc-log (format "cmd: DEFAULT: NAMES %s" tgt))
3075 (erc-with-buffer
3076 (tgt)
3077 (erc-channel-begin-receiving-names))
3078 (erc-server-send (concat "NAMES " tgt)))
3079 (erc-display-message nil 'error (current-buffer) 'no-default-channel)))
3080 t)
3081 (defalias 'erc-cmd-N 'erc-cmd-NAMES)
3083 (defun erc-cmd-KICK (target &optional reason-or-nick &rest reasonwords)
3084 "Kick the user indicated in LINE from the current channel.
3086 (let ((reasonstring (mapconcat 'identity reasonwords " ")))
3087 (if (string= "" reasonstring)
3088 (setq reasonstring (format "Kicked by %s" (erc-current-nick))))
3089 (if (erc-channel-p target)
3090 (let ((nick reason-or-nick))
3091 (erc-log (format "cmd: KICK: %s/%s: %s" nick target reasonstring))
3092 (erc-server-send (format "KICK %s %s :%s" target nick reasonstring)
3093 nil target)
3094 t)
3095 (when target
3096 (let ((ch (erc-default-target)))
3097 (setq reasonstring (concat
3098 (if reason-or-nick (concat reason-or-nick " "))
3099 reasonstring))
3100 (if ch
3101 (progn
3102 (erc-log
3103 (format "cmd: KICK: %s/%s: %s" target ch reasonstring))
3104 (erc-server-send
3105 (format "KICK %s %s :%s" ch target reasonstring) nil ch))
3106 (erc-display-message nil 'error (current-buffer)
3107 'no-default-channel))
3108 t)))))
3110 (defvar erc-script-args nil)
3112 (defun erc-cmd-LOAD (line)
3113 "Load the script provided in the LINE.
3114 If LINE continues beyond the file name, the rest of
3115 it is put in a (local) variable `erc-script-args',
3116 which can be used in Emacs Lisp scripts.
3118 The optional FORCE argument is ignored here - you can't force loading
3119 a script after exceeding the flood threshold."
3120 (cond
3122 (let* ((file-to-find (match-string 1 line))
3123 (erc-script-args (match-string 2 line))
3124 (file (erc-find-file file-to-find erc-script-path)))
3125 (erc-log (format "cmd: LOAD: %s" file-to-find))
3126 (cond
3127 ((not file)
3128 (erc-display-message nil 'error (current-buffer)
3129 'cannot-find-file ?f file-to-find))
3130 ((not (file-readable-p file))
3131 (erc-display-message nil 'error (current-buffer)
3132 'cannot-read-file ?f file))
3133 (t
3134 (message "Loading `%s'..." file)
3135 (erc-load-script file)
3136 (message "Loading `%s'...done" file))))
3137 t)
3138 (t nil)))
3140 (defun erc-cmd-WHOIS (user &optional server)
3141 "Display whois information for USER.
3143 If SERVER is non-nil, use that, rather than the current server."
3144 ;; FIXME: is the above docstring correct? -- Lawrence 2004-01-08
3145 (let ((send (if server
3146 (format "WHOIS %s %s" user server)
3147 (format "WHOIS %s" user))))
3148 (erc-log (format "cmd: %s" send))
3149 (erc-server-send send)
3150 t))
3151 (defalias 'erc-cmd-WI 'erc-cmd-WHOIS)
3153 (defun erc-cmd-WHOAMI ()
3154 "Display whois information about yourself."
3155 (erc-cmd-WHOIS (erc-current-nick))
3156 t)
3158 (defun erc-cmd-IDLE (nick)
3159 "Show the length of time NICK has been idle."
3160 (let ((origbuf (current-buffer))
3161 symlist)
3162 (erc-with-server-buffer
3163 (push (cons (erc-once-with-server-event
3164 311 (lambda (_proc parsed)
3165 (string= nick
3166 (nth 1 (erc-response.command-args
3167 parsed)))))
3168 'erc-server-311-functions)
3169 symlist)
3170 (push (cons (erc-once-with-server-event
3171 312 (lambda (_proc parsed)
3172 (string= nick
3173 (nth 1 (erc-response.command-args
3174 parsed)))))
3175 'erc-server-312-functions)
3176 symlist)
3177 (push (cons (erc-once-with-server-event
3178 318 (lambda (_proc parsed)
3179 (string= nick
3180 (nth 1 (erc-response.command-args
3181 parsed)))))
3182 'erc-server-318-functions)
3183 symlist)
3184 (push (cons (erc-once-with-server-event
3185 319 (lambda (_proc parsed)
3186 (string= nick
3187 (nth 1 (erc-response.command-args
3188 parsed)))))
3189 'erc-server-319-functions)
3190 symlist)
3191 (push (cons (erc-once-with-server-event
3192 320 (lambda (_proc parsed)
3193 (string= nick
3194 (nth 1 (erc-response.command-args
3195 parsed)))))
3196 'erc-server-320-functions)
3197 symlist)
3198 (push (cons (erc-once-with-server-event
3199 330 (lambda (_proc parsed)
3200 (string= nick
3201 (nth 1 (erc-response.command-args
3202 parsed)))))
3203 'erc-server-330-functions)
3204 symlist)
3205 (push (cons (erc-once-with-server-event
3206 317
3207 (lambda (_proc parsed)
3208 (let ((idleseconds
3209 (string-to-number
3210 (cl-third
3211 (erc-response.command-args parsed)))))
3212 (erc-display-line
3213 (erc-make-notice
3214 (format "%s has been idle for %s."
3215 (erc-string-no-properties nick)
3216 (erc-seconds-to-string idleseconds)))
3217 origbuf)
3218 t)))
3219 'erc-server-317-functions)
3220 symlist)
3222 ;; Send the WHOIS command.
3223 (erc-cmd-WHOIS nick)
3225 ;; Remove the uninterned symbols from the server hooks that did not run.
3226 (run-at-time 20 nil (lambda (buf symlist)
3227 (with-current-buffer buf
3228 (dolist (sym symlist)
3229 (let ((hooksym (cdr sym))
3230 (funcsym (car sym)))
3231 (remove-hook hooksym funcsym t)))))
3232 (current-buffer) symlist)))
3233 t)
3235 (defun erc-cmd-DESCRIBE (line)
3236 "Pose some action to a certain user.
3238 (cond
3239 ((string-match
3241 (let ((dst (match-string 1 line))
3242 (s (match-string 2 line)))
3243 (erc-log (format "cmd: DESCRIBE: [%s] %s" dst s))
3244 (erc-send-action dst s))
3245 t)
3246 (t nil)))
3247 (put 'erc-cmd-DESCRIBE 'do-not-parse-args t)
3249 (defun erc-cmd-ME (line)
3250 "Send LINE as an action."
3251 (cond
3253 (let ((s (match-string 1 line)))
3254 (erc-log (format "cmd: ME: %s" s))
3255 (erc-send-action (erc-default-target) s))
3256 t)
3257 (t nil)))
3258 (put 'erc-cmd-ME 'do-not-parse-args t)
3262 (erc-cmd-ME (concat " 's" line)))
3265 (defun erc-cmd-LASTLOG (line)
3266 "Show all lines in the current buffer matching the regexp LINE.
3268 If a match spreads across multiple lines, all those lines are shown.
3270 The lines are shown in a buffer named `*Occur*'.
3271 It serves as a menu to find any of the occurrences in this buffer.
3275 the matching is case-sensitive."
3276 (occur line)
3277 t)
3278 (put 'erc-cmd-LASTLOG 'do-not-parse-args t)
3279 (put 'erc-cmd-LASTLOG 'process-not-needed t)
3281 (defun erc-send-message (line &optional force)
3282 "Send LINE to the current channel or user and display it.
3284 See also `erc-message' and `erc-display-line'."
3285 (erc-message "PRIVMSG" (concat (erc-default-target) " " line) force)
3286 (erc-display-line
3287 (concat (erc-format-my-nick) line)
3288 (current-buffer))
3289 ;; FIXME - treat multiline, run hooks, or remove me?
3290 t)
3292 (defun erc-cmd-MODE (line)
3293 "Change or display the mode value of a channel or user.
3294 The first word specifies the target. The rest is the mode string
3295 to send.
3297 If only one word is given, display the mode of that target.
3299 A list of valid mode strings for Freenode may be found at
3300 URL `http://freenode.net/using_the_network.shtml'."
3301 (cond
3303 (let ((s (match-string 1 line)))
3304 (erc-log (format "cmd: MODE: %s" s))
3305 (erc-server-send (concat "MODE " line)))
3306 t)
3307 (t nil)))
3308 (put 'erc-cmd-MODE 'do-not-parse-args t)
3310 (defun erc-cmd-NOTICE (channel-or-user &rest message)
3311 "Send a notice to the channel or user given as the first word.
3312 The rest is the message to send."
3313 (erc-message "NOTICE" (concat channel-or-user " "
3314 (mapconcat #'identity message " "))))
3316 (defun erc-cmd-MSG (line)
3317 "Send a message to the channel or user given as the first word in LINE.
3319 The rest of LINE is the message to send."
3320 (erc-message "PRIVMSG" line))
3322 (defalias 'erc-cmd-M 'erc-cmd-MSG)
3323 (put 'erc-cmd-MSG 'do-not-parse-args t)
3325 (defun erc-cmd-SQUERY (line)
3326 "Send a Service Query to the service given as the first word in LINE.
3328 The rest of LINE is the message to send."
3329 (erc-message "SQUERY" line))
3331 (defun erc-cmd-NICK (nick)
3332 "Change current nickname to NICK."
3333 (erc-log (format "cmd: NICK: %s (erc-bad-nick: %S)" nick erc-bad-nick))
3334 (let ((nicklen (cdr (assoc "NICKLEN" (erc-with-server-buffer
3335 erc-server-parameters)))))
3336 (and nicklen (> (length nick) (string-to-number nicklen))
3337 (erc-display-message
3338 nil 'notice 'active 'nick-too-long
3339 ?i (length nick) ?l nicklen)))
3340 (erc-server-send (format "NICK %s" nick))
3341 (cond (erc-bad-nick
3342 (erc-set-current-nick nick)
3343 (erc-update-mode-line)
3344 (setq erc-bad-nick nil)))
3345 t)
3347 (defun erc-cmd-PART (line)
3348 "When LINE is an empty string, leave the current channel.
3349 Otherwise leave the channel indicated by LINE."
3350 (cond
3352 (let* ((ch (match-string 1 line))
3353 (msg (match-string 2 line))
3354 (reason (funcall erc-part-reason (if (equal msg "") nil msg))))
3355 (erc-log (format "cmd: PART: %s: %s" ch reason))
3356 (erc-server-send (if (string= reason "")
3357 (format "PART %s" ch)
3358 (format "PART %s :%s" ch reason))
3359 nil ch))
3360 t)
3362 (let* ((ch (erc-default-target))
3363 (msg (match-string 1 line))
3364 (reason (funcall erc-part-reason (if (equal msg "") nil msg))))
3365 (if (and ch (erc-channel-p ch))
3366 (progn
3367 (erc-log (format "cmd: PART: %s: %s" ch reason))
3368 (erc-server-send (if (string= reason "")
3369 (format "PART %s" ch)
3370 (format "PART %s :%s" ch reason))
3371 nil ch))
3372 (erc-display-message nil 'error (current-buffer) 'no-target)))
3373 t)
3374 (t nil)))
3375 (put 'erc-cmd-PART 'do-not-parse-args t)
3377 (defalias 'erc-cmd-LEAVE 'erc-cmd-PART)
3379 (defun erc-cmd-PING (recipient)
3380 "Ping RECIPIENT."
3381 (let ((time (format "%f" (erc-current-time))))
3382 (erc-log (format "cmd: PING: %s" time))
3383 (erc-cmd-CTCP recipient "PING" time)))
3385 (defun erc-cmd-QUOTE (line)
3386 "Send LINE directly to the server.
3387 All the text given as argument is sent to the sever as unmodified,
3388 just as you provided it. Use this command with care!"
3389 (cond
3391 (erc-server-send (match-string 1 line)))
3392 (t nil)))
3393 (put 'erc-cmd-QUOTE 'do-not-parse-args t)
3395 (defcustom erc-query-display 'window
3396 "Indicates how to display query buffers when using the /QUERY
3397 command to talk to someone.
3399 The default behavior is to display the message in a new window
3400 and bring it to the front. See the documentation for
3401 `erc-join-buffer' for a description of the available choices.
3403 See also `erc-auto-query' to decide how private messages from
3404 other people should be displayed."
3405 :group 'erc-query
3406 :type '(choice (const :tag "Split window and select" window)
3407 (const :tag "Split window, don't select" window-noselect)
3408 (const :tag "New frame" frame)
3409 (const :tag "Bury in new buffer" bury)
3410 (const :tag "Use current buffer" buffer)
3411 (const :tag "Use current buffer" t)))
3413 (defun erc-cmd-QUERY (&optional user)
3414 "Open a query with USER.
3415 The type of query window/frame/etc will depend on the value of
3416 `erc-query-display'.
3418 If USER is omitted, close the current query buffer if one exists
3419 - except this is broken now ;-)"
3420 (interactive
3421 (list (read-from-minibuffer "Start a query with: " nil)))
3422 (let ((session-buffer (erc-server-buffer))
3423 (erc-join-buffer erc-query-display))
3424 (if user
3425 (erc-query user session-buffer)
3426 ;; currently broken, evil hack to display help anyway
3427 ;(erc-delete-query))))
3428 (signal 'wrong-number-of-arguments ""))))
3429 (defalias 'erc-cmd-Q 'erc-cmd-QUERY)
3431 (defun erc-quit/part-reason-default ()
3432 "Default quit/part message."
3433 (format "\C-bERC\C-b (IRC client for Emacs %s)" emacs-version))
3436 (defun erc-quit-reason-normal (&optional s)
3437 "Normal quit message.
3439 If S is non-nil, it will be used as the quit reason."
3440 (or s (erc-quit/part-reason-default)))
3442 (defun erc-quit-reason-zippy (&optional s)
3443 "Zippy quit message.
3445 If S is non-nil, it will be used as the quit reason."
3446 (or s
3447 (if (fboundp 'yow)
3449 (erc-quit/part-reason-default))))
3451 (make-obsolete 'erc-quit-reason-zippy "it will be removed." "24.4")
3453 (defun erc-quit-reason-various (s)
3454 "Choose a quit reason based on S (a string)."
3455 (when (featurep 'xemacs) (require 'poe))
3456 (let ((res (car (assoc-default (or s "")
3457 erc-quit-reason-various-alist 'string-match))))
3458 (cond
3459 ((functionp res) (funcall res))
3460 ((stringp res) res)
3461 (s s)
3462 (t (erc-quit/part-reason-default)))))
3464 (defun erc-part-reason-normal (&optional s)
3465 "Normal part message.
3467 If S is non-nil, it will be used as the part reason."
3468 (or s (erc-quit/part-reason-default)))
3470 (defun erc-part-reason-zippy (&optional s)
3471 "Zippy part message.
3473 If S is non-nil, it will be used as the quit reason."
3474 (or s
3475 (if (fboundp 'yow)
3477 (erc-quit/part-reason-default))))
3479 (make-obsolete 'erc-part-reason-zippy "it will be removed." "24.4")
3481 (defun erc-part-reason-various (s)
3482 "Choose a part reason based on S (a string)."
3483 (when (featurep 'xemacs) (require 'poe))
3484 (let ((res (car (assoc-default (or s "")
3485 erc-part-reason-various-alist 'string-match))))
3486 (cond
3487 ((functionp res) (funcall res))
3488 ((stringp res) res)
3489 (s s)
3490 (t (erc-quit/part-reason-default)))))
3492 (defun erc-cmd-QUIT (reason)
3493 "Disconnect from the current server.
3494 If REASON is omitted, display a default quit message, otherwise display
3495 the message given by REASON."
3496 (unless reason
3497 (setq reason ""))
3498 (cond
3500 (let* ((s (match-string 1 reason))
3501 (buffer (erc-server-buffer))
3502 (reason (funcall erc-quit-reason (if (equal s "") nil s)))
3503 server-proc)
3504 (with-current-buffer (if (and buffer
3505 (bufferp buffer))
3506 buffer
3507 (current-buffer))
3508 (erc-log (format "cmd: QUIT: %s" reason))
3509 (setq erc-server-quitting t)
3510 (erc-set-active-buffer (erc-server-buffer))
3511 (setq server-proc erc-server-process)
3512 (erc-server-send (format "QUIT :%s" reason)))
3513 (run-hook-with-args 'erc-quit-hook server-proc)
3514 (when erc-kill-queries-on-quit
3515 (erc-kill-query-buffers server-proc))
3516 ;; if the process has not been killed within 4 seconds, kill it
3517 (run-at-time 4 nil
3518 (lambda (proc)
3519 (when (and (processp proc)
3520 (memq (process-status proc) '(run open)))
3521 (delete-process proc)))
3522 server-proc))
3523 t)
3524 (t nil)))
3526 (defalias 'erc-cmd-BYE 'erc-cmd-QUIT)
3527 (defalias 'erc-cmd-EXIT 'erc-cmd-QUIT)
3528 (defalias 'erc-cmd-SIGNOFF 'erc-cmd-QUIT)
3529 (put 'erc-cmd-QUIT 'do-not-parse-args t)
3530 (put 'erc-cmd-QUIT 'process-not-needed t)
3532 (defun erc-cmd-GQUIT (reason)
3533 "Disconnect from all servers at once with the same quit REASON."
3534 (erc-with-all-buffers-of-server nil #'erc-open-server-buffer-p
3535 (erc-cmd-QUIT reason))
3536 (when erc-kill-queries-on-quit
3537 ;; if the query buffers have not been killed within 4 seconds,
3538 ;; kill them
3539 (run-at-time
3540 4 nil
3541 (lambda ()
3542 (dolist (buffer (erc-buffer-list (lambda (buf)
3543 (not (erc-server-buffer-p buf)))))
3544 (kill-buffer buffer)))))
3545 t)
3547 (defalias 'erc-cmd-GQ 'erc-cmd-GQUIT)
3548 (put 'erc-cmd-GQUIT 'do-not-parse-args t)
3549 (put 'erc-cmd-GQUIT 'process-not-needed t)
3551 (defun erc-cmd-RECONNECT ()
3552 "Try to reconnect to the current IRC server."
3553 (let ((buffer (erc-server-buffer))
3554 (process nil))
3555 (unless (buffer-live-p buffer)
3556 (setq buffer (current-buffer)))
3557 (with-current-buffer buffer
3558 (setq erc-server-quitting nil)
3559 (setq erc-server-reconnecting t)
3560 (setq erc-server-reconnect-count 0)
3561 (setq process (get-buffer-process (erc-server-buffer)))
3562 (if process
3563 (delete-process process)
3564 (erc-server-reconnect))
3565 (setq erc-server-reconnecting nil)))
3566 t)
3567 (put 'erc-cmd-RECONNECT 'process-not-needed t)
3569 (defun erc-cmd-SERVER (server)
3570 "Connect to SERVER, leaving existing connection intact."
3571 (erc-log (format "cmd: SERVER: %s" server))
3572 (condition-case nil
3573 (erc :server server :nick (erc-current-nick))
3574 (error
3575 (erc-error "Cannot find host %s." server)))
3576 t)
3577 (put 'erc-cmd-SERVER 'process-not-needed t)
3579 (defvar motif-version-string)
3580 (defvar gtk-version-string)
3582 (defun erc-cmd-SV ()
3583 "Say the current ERC and Emacs version into channel."
3584 (erc-send-message (format "I'm using ERC with %s %s (%s%s)%s."
3585 (if (featurep 'xemacs) "XEmacs" "GNU Emacs")
3586 emacs-version
3587 system-configuration
3588 (concat
3589 (cond ((featurep 'motif)
3590 (concat ", " (substring
3591 motif-version-string 4)))
3592 ((featurep 'gtk)
3593 (concat ", GTK+ Version "
3594 gtk-version-string))
3595 ((featurep 'x-toolkit) ", X toolkit")
3596 (t ""))
3597 (if (and (boundp 'x-toolkit-scroll-bars)
3598 (memq x-toolkit-scroll-bars
3599 '(xaw xaw3d)))
3600 (format ", %s scroll bars"
3601 (capitalize (symbol-name
3602 x-toolkit-scroll-bars)))
3603 "")
3604 (if (featurep 'multi-tty) ", multi-tty" ""))
3605 (if erc-emacs-build-time
3606 (concat " of " erc-emacs-build-time)
3607 "")))
3608 t)
3610 (defun erc-cmd-SM ()
3611 "Say the current ERC modes into channel."
3612 (erc-send-message (format "I'm using the following modules: %s!"
3613 (erc-modes)))
3614 t)
3616 (defun erc-cmd-DEOP (&rest people)
3617 "Remove the operator setting from user(s) given in PEOPLE."
3618 (when (> (length people) 0)
3619 (erc-server-send (concat "MODE " (erc-default-target)
3620 " -"
3621 (make-string (length people) ?o)
3622 " "
3623 (mapconcat 'identity people " ")))
3624 t))
3626 (defun erc-cmd-OP (&rest people)
3627 "Add the operator setting to users(s) given in PEOPLE."
3628 (when (> (length people) 0)
3629 (erc-server-send (concat "MODE " (erc-default-target)
3630 " +"
3631 (make-string (length people) ?o)
3632 " "
3633 (mapconcat 'identity people " ")))
3634 t))
3636 (defun erc-cmd-TIME (&optional line)
3637 "Request the current time and date from the current server."
3638 (cond
3640 (let ((args (match-string 1 line)))
3641 (erc-log (format "cmd: TIME: %s" args))
3642 (erc-server-send (concat "TIME " args)))
3643 t)
3644 (t (erc-server-send "TIME"))))
3645 (defalias 'erc-cmd-DATE 'erc-cmd-TIME)
3647 (defun erc-cmd-TOPIC (topic)
3648 "Set or request the topic for a channel.
3650 or the empty string.
3652 If no #CHANNEL is given, the default channel is used. If TOPIC is
3653 given, the channel topic is modified, otherwise the current topic will
3654 be displayed."
3655 (cond
3656 ;; /topic #channel TOPIC
3658 (let ((ch (match-string 1 topic))
3659 (topic (match-string 2 topic)))
3660 (erc-log (format "cmd: TOPIC [%s]: %s" ch topic))
3661 (erc-server-send (format "TOPIC %s :%s" ch topic) nil ch))
3662 t)
3663 ;; /topic #channel
3665 (let ((ch (match-string 1 topic)))
3666 (erc-server-send (format "TOPIC %s" ch) nil ch)
3667 t))
3668 ;; /topic
3670 (let ((ch (erc-default-target)))
3671 (erc-server-send (format "TOPIC %s" ch) nil ch)
3672 t))
3673 ;; /topic TOPIC
3675 (let ((ch (erc-default-target))
3676 (topic (match-string 1 topic)))
3677 (if (and ch (erc-channel-p ch))
3678 (progn
3679 (erc-log (format "cmd: TOPIC [%s]: %s" ch topic))
3680 (erc-server-send (format "TOPIC %s :%s" ch topic) nil ch))
3681 (erc-display-message nil 'error (current-buffer) 'no-target)))
3682 t)
3683 (t nil)))
3684 (defalias 'erc-cmd-T 'erc-cmd-TOPIC)
3685 (put 'erc-cmd-TOPIC 'do-not-parse-args t)
3687 (defun erc-cmd-APPENDTOPIC (topic)
3688 "Append TOPIC to the current channel topic, separated by a space."
3689 (let ((oldtopic erc-channel-topic))
3690 ;; display help when given no arguments
3692 (signal 'wrong-number-of-arguments nil))
3693 ;; strip trailing ^O
3695 (erc-cmd-TOPIC (concat (match-string 1 oldtopic) topic)))))
3696 (defalias 'erc-cmd-AT 'erc-cmd-APPENDTOPIC)
3697 (put 'erc-cmd-APPENDTOPIC 'do-not-parse-args t)
3699 (defun erc-cmd-CLEARTOPIC (&optional channel)
3700 "Clear the topic for a CHANNEL.
3701 If CHANNEL is not specified, clear the topic for the default channel."
3702 (interactive "sClear topic of channel (RET is current channel): ")
3703 (let ((chnl (or (and (erc-channel-p channel) channel) (erc-default-target))))
3704 (when chnl
3705 (erc-server-send (format "TOPIC %s :" chnl))
3706 t)))
3708 ;;; Banlists
3710 (defvar erc-channel-banlist nil
3711 "A list of bans seen for the current channel.
3713 Each ban is an alist of the form:
3714 (WHOSET . MASK)
3716 The property `received-from-server' indicates whether
3717 or not the ban list has been requested from the server.")
3718 (make-variable-buffer-local 'erc-channel-banlist)
3719 (put 'erc-channel-banlist 'received-from-server nil)
3721 (defun erc-cmd-BANLIST ()
3722 "Pretty-print the contents of `erc-channel-banlist'.
3724 The ban list is fetched from the server if necessary."
3725 (let ((chnl (erc-default-target))
3726 (chnl-name (buffer-name)))
3728 (cond
3729 ((not (erc-channel-p chnl))
3731 'active))
3733 ((not (get 'erc-channel-banlist 'received-from-server))
3734 (let ((old-367-hook erc-server-367-functions))
3735 (setq erc-server-367-functions 'erc-banlist-store
3736 erc-channel-banlist nil)
3737 ;; fetch the ban list then callback
3738 (erc-with-server-buffer
3739 (erc-once-with-server-event
3740 368
3741 (lambda (_proc _parsed)
3742 (with-current-buffer chnl-name
3743 (put 'erc-channel-banlist 'received-from-server t)
3744 (setq erc-server-367-functions old-367-hook)
3745 (erc-cmd-BANLIST)
3746 t)))
3747 (erc-server-send (format "MODE %s b" chnl)))))
3749 ((null erc-channel-banlist)
3750 (erc-display-line (erc-make-notice
3752 'active)
3753 (put 'erc-channel-banlist 'received-from-server nil))
3755 (t
3756 (let* ((erc-fill-column (or (and (boundp 'erc-fill-column)
3757 erc-fill-column)
3758 (and (boundp 'fill-column)
3759 fill-column)
3760 (1- (window-width))))
3761 (separator (make-string erc-fill-column ?=))
3762 (fmt (concat
3763 "%-" (number-to-string (/ erc-fill-column 2)) "s"
3764 "%" (number-to-string (/ erc-fill-column 2)) "s")))
3766 (erc-display-line
3768 (erc-default-target)))
3769 'active)
3771 (erc-display-line separator 'active)
3772 (erc-display-line (format fmt "Ban Mask" "Banned By") 'active)
3773 (erc-display-line separator 'active)
3775 (mapc
3776 (lambda (x)
3777 (erc-display-line
3778 (format fmt
3779 (truncate-string-to-width (cdr x) (/ erc-fill-column 2))
3780 (if (car x)
3781 (truncate-string-to-width (car x) (/ erc-fill-column 2))
3782 ""))
3783 'active))
3784 erc-channel-banlist)
3786 (erc-display-line (erc-make-notice "End of Ban list")
3787 'active)
3788 (put 'erc-channel-banlist 'received-from-server nil)))))
3789 t)
3791 (defalias 'erc-cmd-BL 'erc-cmd-BANLIST)
3793 (defun erc-cmd-MASSUNBAN ()
3794 "Mass Unban.
3796 Unban all currently banned users in the current channel."
3797 (let ((chnl (erc-default-target)))
3798 (cond
3800 ((not (erc-channel-p chnl))
3801 (erc-display-line
3803 'active))
3805 ((not (get 'erc-channel-banlist 'received-from-server))
3806 (let ((old-367-hook erc-server-367-functions))
3807 (setq erc-server-367-functions 'erc-banlist-store)
3808 ;; fetch the ban list then callback
3809 (erc-with-server-buffer
3810 (erc-once-with-server-event
3811 368
3812 (lambda (_proc _parsed)
3813 (with-current-buffer chnl
3814 (put 'erc-channel-banlist 'received-from-server t)
3815 (setq erc-server-367-functions old-367-hook)
3816 (erc-cmd-MASSUNBAN)
3817 t)))
3818 (erc-server-send (format "MODE %s b" chnl)))))
3820 (t (let ((bans (mapcar #'cdr erc-channel-banlist)))
3821 (when bans
3822 ;; Glob the bans into groups of three, and carry out the unban.
3823 ;; eg. /mode #foo -bbb a*!*@* b*!*@* c*!*@*
3824 (mapc
3825 (lambda (x)
3826 (erc-server-send
3827 (format "MODE %s -%s %s" (erc-default-target)
3828 (make-string (length x) ?b)
3829 (mapconcat 'identity x " "))))
3830 (erc-group-list bans 3))))
3831 t))))
3833 (defalias 'erc-cmd-MUB 'erc-cmd-MASSUNBAN)
3835 ;;;; End of IRC commands
3837 (defun erc-ensure-channel-name (channel)
3838 "Return CHANNEL if it is a valid channel name.
3839 Eventually add a # in front of it, if that turns it into a valid channel name."
3840 (if (erc-channel-p channel)
3841 channel
3842 (concat "#" channel)))
3844 (defun erc-grab-region (start end)
3845 "Copy the region between START and END in a recreatable format.
3847 Converts all the IRC text properties in each line of the region
3848 into control codes and writes them to a separate buffer. The
3849 resulting text may be used directly as a script to generate this
3850 text again."
3851 (interactive "r")
3852 (erc-set-active-buffer (current-buffer))
3853 (save-excursion
3854 (let* ((cb (current-buffer))
3855 (buf (generate-new-buffer erc-grab-buffer-name))
3856 (region (buffer-substring start end))
3857 (lines (erc-split-multiline-safe region)))
3858 (set-buffer buf)
3859 (dolist (line lines)
3861 (set-buffer cb)
3862 (switch-to-buffer-other-window buf)))
3863 (message "erc-grab-region doesn't grab colors etc. anymore. If you use this, please tell the maintainers.")
3864 (ding))
3866 (defun erc-display-prompt (&optional buffer pos prompt face)
3867 "Display PROMPT in BUFFER at position POS.
3868 Display an ERC prompt in BUFFER.
3870 If PROMPT is nil, one is constructed with the function `erc-prompt'.
3871 If BUFFER is nil, the `current-buffer' is used.
3872 If POS is nil, PROMPT will be displayed at `point'.
3873 If FACE is non-nil, it will be used to propertize the prompt. If it is nil,
3874 `erc-prompt-face' will be used."
3875 (let* ((prompt (or prompt (erc-prompt)))
3876 (l (length prompt))
3877 (ob (current-buffer)))
3878 ;; We cannot use save-excursion because we move point, therefore
3879 ;; we resort to the ol' ob trick to restore this.
3880 (when (and buffer (bufferp buffer))
3881 (set-buffer buffer))
3883 ;; now save excursion again to store where point and mark are
3884 ;; in the current buffer
3885 (save-excursion
3886 (setq pos (or pos (point)))
3887 (goto-char pos)
3888 (when (> l 0)
3889 ;; Do not extend the text properties when typing at the end
3890 ;; of the prompt, but stuff typed in front of the prompt
3891 ;; shall remain part of the prompt.
3892 (setq prompt (erc-propertize prompt
3893 'start-open t ; XEmacs
3894 'rear-nonsticky t ; Emacs
3895 'erc-prompt t
3896 'field t
3897 'front-sticky t
3898 'read-only t))
3899 (erc-put-text-property 0 (1- (length prompt))
3900 'font-lock-face (or face 'erc-prompt-face)
3901 prompt)
3902 (insert prompt))
3903 ;; Set the input marker
3904 (set-marker erc-input-marker (point)))
3906 ;; Now we are back at the old position. If the prompt was
3907 ;; inserted here or before us, advance point by the length of
3908 ;; the prompt.
3909 (when (or (not pos) (<= (point) pos))
3910 (forward-char l))
3911 ;; Clear the undo buffer now, so the user can undo his stuff,
3912 ;; but not the stuff we did. Sneaky!
3913 (setq buffer-undo-list nil)
3914 (set-buffer ob)))
3916 ;; interactive operations
3918 (defun erc-input-message ()
3919 "Read input from the minibuffer."
3920 (interactive)
3921 (let ((minibuffer-allow-text-properties t)
3922 (read-map minibuffer-local-map))
3923 (insert (read-from-minibuffer "Message: "
3924 (string (if (featurep 'xemacs)
3925 last-command-char
3926 last-command-event))
3927 read-map))
3928 (erc-send-current-line)))
3930 (defvar erc-action-history-list ()
3931 "History list for interactive action input.")
3933 (defun erc-input-action ()
3934 "Interactively input a user action and send it to IRC."
3935 (interactive "")
3936 (erc-set-active-buffer (current-buffer))
3937 (let ((action (read-from-minibuffer
3938 "Action: " nil nil nil 'erc-action-history-list)))
3940 (erc-send-action (erc-default-target) action))))
3942 (defun erc-join-channel (channel &optional key)
3943 "Join CHANNEL.
3945 If `point' is at the beginning of a channel name, use that as default."
3946 (interactive
3947 (list
3949 (table (when (erc-server-buffer-live-p)
3950 (set-buffer (process-buffer erc-server-process))
3951 erc-channel-list)))
3952 (completing-read "Join channel: " table nil nil nil nil chnl))
3953 (when (or current-prefix-arg erc-prompt-for-channel-key)
3954 (read-from-minibuffer "Channel key (RET for none): " nil))))
3955 (erc-cmd-JOIN channel (when (>= (length key) 1) key)))
3957 (defun erc-part-from-channel (reason)
3958 "Part from the current channel and prompt for a REASON."
3959 (interactive
3960 (list
3961 (if (and (boundp 'reason) (stringp reason) (not (string= reason "")))
3962 reason
3963 (read-from-minibuffer (concat "Reason for leaving " (erc-default-target)
3964 ": ")))))
3965 (erc-cmd-PART (concat (erc-default-target)" " reason)))
3967 (defun erc-set-topic (topic)
3968 "Prompt for a TOPIC for the current channel."
3969 (interactive
3970 (list
3971 (read-from-minibuffer
3972 (concat "Set topic of " (erc-default-target) ": ")
3973 (when erc-channel-topic
3974 (let ((ss (split-string erc-channel-topic "\C-o")))
3975 (cons (apply #'concat (if (cdr ss) (butlast ss) ss))
3976 0))))))
3977 (let ((topic-list (split-string topic "\C-o"))) ; strip off the topic setter
3978 (erc-cmd-TOPIC (concat (erc-default-target) " " (car topic-list)))))
3980 (defun erc-set-channel-limit (&optional limit)
3981 "Set a LIMIT for the current channel. Remove limit if nil.
3982 Prompt for one if called interactively."
3983 (interactive (list (read-from-minibuffer
3984 (format "Limit for %s (RET to remove limit): "
3985 (erc-default-target)))))
3986 (let ((tgt (erc-default-target)))
3987 (erc-server-send (if (and limit (>= (length limit) 1))
3988 (format "MODE %s +l %s" tgt limit)
3989 (format "MODE %s -l" tgt)))))
3991 (defun erc-set-channel-key (&optional key)
3992 "Set a KEY for the current channel. Remove key if nil.
3993 Prompt for one if called interactively."
3994 (interactive (list (read-from-minibuffer
3995 (format "Key for %s (RET to remove key): "
3996 (erc-default-target)))))
3997 (let ((tgt (erc-default-target)))
3998 (erc-server-send (if (and key (>= (length key) 1))
3999 (format "MODE %s +k %s" tgt key)
4000 (format "MODE %s -k" tgt)))))
4002 (defun erc-quit-server (reason)
4003 "Disconnect from current server after prompting for REASON.
4004 `erc-quit-reason' works with this just like with `erc-cmd-QUIT'."
4005 (interactive (list (read-from-minibuffer
4006 (format "Reason for quitting %s: "
4007 (or erc-server-announced-name
4008 erc-session-server)))))
4009 (erc-cmd-QUIT reason))
4011 ;; Movement of point
4013 (defun erc-bol ()
4014 "Move `point' to the beginning of the current line.
4016 This places `point' just after the prompt, or at the beginning of the line."
4017 (interactive)
4018 (forward-line 0)
4019 (when (get-text-property (point) 'erc-prompt)
4020 (goto-char erc-input-marker))
4021 (point))
4023 (defun erc-kill-input ()
4024 "Kill current input line using `erc-bol' followed by `kill-line'."
4025 (interactive)
4026 (when (and (erc-bol)
4027 (/= (point) (point-max))) ;; Prevent a (ding) and an error when
4028 ;; there's nothing to kill
4029 (if (boundp 'erc-input-ring-index)
4030 (setq erc-input-ring-index nil))
4031 (kill-line)))
4033 (defun erc-complete-word-at-point ()
4034 (run-hook-with-args-until-success 'erc-complete-functions))
4036 (define-obsolete-function-alias 'erc-complete-word 'completion-at-point "24.1")
4038 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4039 ;;
4040 ;; IRC SERVER INPUT HANDLING
4041 ;;
4042 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4044 ;;;; New Input parsing
4046 ; Stolen from ZenIRC. I just wanna test this code, so here is
4047 ; experiment area.
4049 (defcustom erc-default-server-hook '(erc-debug-missing-hooks
4050 erc-default-server-handler)
4051 "Default for server messages which aren't covered by `erc-server-hooks'."
4052 :group 'erc-server-hooks
4053 :type 'hook)
4055 (defun erc-default-server-handler (proc parsed)
4056 "Default server handler.
4058 Displays PROC and PARSED appropriately using `erc-display-message'."
4059 (erc-display-message
4060 parsed 'notice proc
4061 (mapconcat
4062 'identity
4063 (let (res)
4064 (mapc #'(lambda (x)
4065 (if (stringp x)
4066 (setq res (append res (list x)))))
4067 parsed)
4068 res)
4069 " ")))
4071 (defvar erc-server-vectors
4072 '(["msgtype" "sender" "to" "arg1" "arg2" "arg3" "..."])
4073 "List of received server messages which ERC does not specifically handle.
4074 See `erc-debug-missing-hooks'.")
4075 ;(make-variable-buffer-local 'erc-server-vectors)
4077 (defun erc-debug-missing-hooks (_proc parsed)
4078 "Add PARSED server message ERC does not yet handle to `erc-server-vectors'.
4079 These vectors can be helpful when adding new server message handlers to ERC.
4080 See `erc-default-server-hook'."
4081 (nconc erc-server-vectors (list parsed))
4082 nil)
4084 (defun erc-query (target server)
4085 "Open a query buffer on TARGET, using SERVER.
4086 To change how this query window is displayed, use `let' to bind
4087 `erc-join-buffer' before calling this."
4088 (unless (and server
4089 (buffer-live-p server)
4090 (set-buffer server))
4091 (error "Couldn't switch to server buffer"))
4092 (let ((buf (erc-open erc-session-server
4093 erc-session-port
4094 (erc-current-nick)
4095 erc-session-user-full-name
4096 nil
4097 nil
4098 (list target)
4099 target
4100 erc-server-process)))
4101 (unless buf
4102 (error "Couldn't open query window"))
4103 (erc-update-mode-line)
4104 buf))
4106 (defcustom erc-auto-query 'window-noselect
4107 "If non-nil, create a query buffer each time you receive a private message.
4108 If the buffer doesn't already exist, it is created.
4110 This can be set to a symbol, to control how the new query window
4111 should appear. The default behavior is to display the buffer in
4112 a new window, but not to select it. See the documentation for
4113 `erc-join-buffer' for a description of the available choices."
4114 :group 'erc-query
4115 :type '(choice (const :tag "Don't create query window" nil)
4116 (const :tag "Split window and select" window)
4117 (const :tag "Split window, don't select" window-noselect)
4118 (const :tag "New frame" frame)
4119 (const :tag "Bury in new buffer" bury)
4120 (const :tag "Use current buffer" buffer)
4121 (const :tag "Use current buffer" t)))
4123 (defcustom erc-query-on-unjoined-chan-privmsg t
4124 "If non-nil create query buffer on receiving any PRIVMSG at all.
4125 This includes PRIVMSGs directed to channels. If you are using an IRC
4126 bouncer, such as dircproxy, to keep a log of channels when you are
4127 disconnected, you should set this option to t."
4128 :group 'erc-query
4129 :type 'boolean)
4131 (defcustom erc-format-query-as-channel-p t
4132 "If non-nil, format text from others in a query buffer like in a channel,
4133 otherwise format like a private message."
4134 :group 'erc-query
4135 :type 'boolean)
4137 (defcustom erc-minibuffer-notice nil
4138 "If non-nil, print ERC notices for the user in the minibuffer.
4139 Only happens when the session buffer isn't visible."
4140 :group 'erc-display
4141 :type 'boolean)
4143 (defcustom erc-minibuffer-ignored nil
4144 "If non-nil, print a message in the minibuffer if we ignored something."
4145 :group 'erc-ignore
4146 :type 'boolean)
4148 (defun erc-wash-quit-reason (reason nick login host)
4149 "Remove duplicate text from quit REASON.
4150 Specifically in relation to NICK (user@host) information. Returns REASON
4151 unmodified if nothing can be removed.
4154 (setq nick (regexp-quote nick)
4155 login (regexp-quote login)
4156 host (regexp-quote host))
4160 reason)
4161 (concat (match-string 1 reason) ": " (match-string 2 reason)))
4164 reason)
4165 (match-string 1 reason))
4166 reason))
4168 (defun erc-nickname-in-use (nick reason)
4169 "If NICK is unavailable, tell the user the REASON.
4171 See also `erc-display-error-notice'."
4172 (if (or (not erc-try-new-nick-p)
4173 ;; how many default-nicks are left + one more try...
4174 (eq erc-nick-change-attempt-count
4175 (if (consp erc-nick)
4176 (+ (length erc-nick) 1)
4177 1)))
4178 (erc-display-error-notice
4179 nil
4180 (format "Nickname %s is %s, try another." nick reason))
4181 (setq erc-nick-change-attempt-count (+ erc-nick-change-attempt-count 1))
4182 (let ((newnick (nth 1 erc-default-nicks))
4183 (nicklen (cdr (assoc "NICKLEN"
4184 (erc-with-server-buffer
4185 erc-server-parameters)))))
4186 (setq erc-bad-nick t)
4187 ;; try to use a different nick
4188 (if erc-default-nicks
4189 (setq erc-default-nicks (cdr erc-default-nicks)))
4190 (if (not newnick)
4191 (setq newnick (concat (truncate-string-to-width
4192 nick
4193 (if (and erc-server-connected nicklen)
4194 (- (string-to-number nicklen)
4195 (length erc-nick-uniquifier))
4196 ;; rfc2812 max nick length = 9
4197 ;; we must assume this is the
4198 ;; server's setting if we haven't
4199 ;; established a connection yet
4200 (- 9 (length erc-nick-uniquifier))))
4201 erc-nick-uniquifier)))
4202 (erc-cmd-NICK newnick)
4203 (erc-display-error-notice
4204 nil
4205 (format "Nickname %s is %s, trying %s"
4206 nick reason newnick)))))
4208 ;;; Server messages
4210 (defgroup erc-server-hooks nil
4211 "Server event callbacks.
4212 Every server event - like numeric replies - has its own hook.
4213 Those hooks are all called using `run-hook-with-args-until-success'.
4214 They receive as first argument the process object from where the event
4215 originated from,
4216 and as second argument the event parsed as a vector."
4217 :group 'erc-hooks)
4219 (defun erc-display-server-message (_proc parsed)
4220 "Display the message sent by the server as a notice."
4221 (erc-display-message
4222 parsed 'notice 'active (erc-response.contents parsed)))
4224 (defun erc-auto-query (proc parsed)
4225 ;; FIXME: This needs more documentation, unless it's not a user function --
4226 ;; Lawrence 2004-01-08
4227 "Put this on `erc-server-PRIVMSG-functions'."
4228 (when erc-auto-query
4229 (let* ((nick (car (erc-parse-user (erc-response.sender parsed))))
4230 (target (car (erc-response.command-args parsed)))
4231 (msg (erc-response.contents parsed))
4232 (query (if (not erc-query-on-unjoined-chan-privmsg)
4233 nick
4234 (if (erc-current-nick-p target)
4235 nick
4236 target))))
4237 (and (not (erc-ignored-user-p (erc-response.sender parsed)))
4238 (or erc-query-on-unjoined-chan-privmsg
4239 (string= target (erc-current-nick)))
4240 (not (erc-get-buffer query proc))
4241 (not (erc-is-message-ctcp-and-not-action-p msg))
4242 (let ((erc-query-display erc-auto-query))
4243 (erc-cmd-QUERY query))
4244 nil))))
4246 (defun erc-is-message-ctcp-p (message)
4247 "Check if MESSAGE is a CTCP message or not."
4250 (defun erc-is-message-ctcp-and-not-action-p (message)
4251 "Check if MESSAGE is a CTCP message or not."
4252 (and (erc-is-message-ctcp-p message)
4255 (defun erc-format-privmessage (nick msg privp msgp)
4256 "Format a PRIVMSG in an insertable fashion."
4257 (let* ((mark-s (if msgp (if privp "*" "<") "-"))
4258 (mark-e (if msgp (if privp "*" ">") "-"))
4259 (str (format "%s%s%s %s" mark-s nick mark-e msg))
4260 (nick-face (if privp 'erc-nick-msg-face 'erc-nick-default-face))
4261 (msg-face (if privp 'erc-direct-msg-face 'erc-default-face)))
4262 ;; add text properties to text before the nick, the nick and after the nick
4263 (erc-put-text-property 0 (length mark-s) 'font-lock-face msg-face str)
4264 (erc-put-text-property (length mark-s) (+ (length mark-s) (length nick))
4265 'font-lock-face nick-face str)
4266 (erc-put-text-property (+ (length mark-s) (length nick)) (length str)
4267 'font-lock-face msg-face str)
4268 str))
4270 (defcustom erc-format-nick-function 'erc-format-nick
4271 "Function to format a nickname for message display."
4272 :group 'erc-display
4273 :type 'function)
4275 (defun erc-format-nick (&optional user _channel-data)
4276 "Return the nickname of USER.
4277 See also `erc-format-nick-function'."
4278 (when user (erc-server-user-nickname user)))
4280 (defun erc-get-user-mode-prefix (user)
4281 (when user
4282 (cond ((erc-channel-user-owner-p user)
4283 (erc-propertize "~" 'help-echo "owner"))
4284 ((erc-channel-user-admin-p user)
4285 (erc-propertize "&" 'help-echo "admin"))
4286 ((erc-channel-user-op-p user)
4287 (erc-propertize "@" 'help-echo "operator"))
4288 ((erc-channel-user-halfop-p user)
4289 (erc-propertize "%" 'help-echo "half-op"))
4290 ((erc-channel-user-voice-p user)
4291 (erc-propertize "+" 'help-echo "voice"))
4292 (t ""))))
4294 (defun erc-format-@nick (&optional user _channel-data)
4295 "Format the nickname of USER showing if USER has a voice, is an
4298 prefix. Use CHANNEL-DATA to determine op and voice status. See
4299 also `erc-format-nick-function'."
4300 (when user
4301 (let ((nick (erc-server-user-nickname user)))
4302 (concat (erc-propertize
4303 (erc-get-user-mode-prefix nick)
4304 'font-lock-face 'erc-nick-prefix-face)
4305 nick))))
4307 (defun erc-format-my-nick ()
4308 "Return the beginning of this user's message, correctly propertized."
4309 (if erc-show-my-nick
4310 (let* ((open "<")
4311 (close "> ")
4312 (nick (erc-current-nick))
4313 (mode (erc-get-user-mode-prefix nick)))
4314 (concat
4315 (erc-propertize open 'font-lock-face 'erc-default-face)
4316 (erc-propertize mode 'font-lock-face 'erc-my-nick-prefix-face)
4317 (erc-propertize nick 'font-lock-face 'erc-my-nick-face)
4318 (erc-propertize close 'font-lock-face 'erc-default-face)))
4319 (let ((prefix "> "))
4320 (erc-propertize prefix 'font-lock-face 'erc-default-face))))
4322 (defun erc-echo-notice-in-default-buffer (s parsed buffer _sender)
4323 "Echos a private notice in the default buffer, namely the
4324 target buffer specified by BUFFER, or there is no target buffer,
4325 the server buffer. This function is designed to be added to
4326 either `erc-echo-notice-hook' or `erc-echo-notice-always-hook',
4327 and always returns t."
4328 (erc-display-message parsed nil buffer s)
4329 t)
4331 (defun erc-echo-notice-in-target-buffer (s parsed buffer _sender)
4332 "Echos a private notice in BUFFER, if BUFFER is non-nil. This
4333 function is designed to be added to either `erc-echo-notice-hook'
4334 or `erc-echo-notice-always-hook', and returns non-nil if BUFFER
4335 is non-nil."
4336 (if buffer
4337 (progn (erc-display-message parsed nil buffer s) t)
4338 nil))
4340 (defun erc-echo-notice-in-minibuffer (s _parsed _buffer _sender)
4341 "Echos a private notice in the minibuffer. This function is
4342 designed to be added to either `erc-echo-notice-hook' or
4343 `erc-echo-notice-always-hook', and always returns t."
4344 (message "%s" (concat "NOTICE: " s))
4345 t)
4347 (defun erc-echo-notice-in-server-buffer (s parsed _buffer _sender)
4348 "Echos a private notice in the server buffer. This function is
4349 designed to be added to either `erc-echo-notice-hook' or
4350 `erc-echo-notice-always-hook', and always returns t."
4351 (erc-display-message parsed nil nil s)
4352 t)
4354 (defun erc-echo-notice-in-active-non-server-buffer (s parsed _buffer _sender)
4355 "Echos a private notice in the active buffer if the active
4356 buffer is not the server buffer. This function is designed to be
4357 added to either `erc-echo-notice-hook' or
4358 `erc-echo-notice-always-hook', and returns non-nil if the active
4359 buffer is not the server buffer."
4360 (if (not (eq (erc-server-buffer) (erc-active-buffer)))
4361 (progn (erc-display-message parsed nil 'active s) t)
4362 nil))
4364 (defun erc-echo-notice-in-active-buffer (s parsed _buffer _sender)
4365 "Echos a private notice in the active buffer. This function is
4366 designed to be added to either `erc-echo-notice-hook' or
4367 `erc-echo-notice-always-hook', and always returns t."
4368 (erc-display-message parsed nil 'active s)
4369 t)
4371 (defun erc-echo-notice-in-user-buffers (s parsed _buffer sender)
4372 "Echos a private notice in all of the buffers for which SENDER
4373 is a member. This function is designed to be added to either
4374 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
4375 returns non-nil if there is at least one buffer for which the
4376 sender is a member.
4378 See also: `erc-echo-notice-in-first-user-buffer',
4379 `erc-buffer-list-with-nick'."
4380 (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4381 (if buffers
4382 (progn (erc-display-message parsed nil buffers s) t)
4383 nil)))
4385 (defun erc-echo-notice-in-user-and-target-buffers (s parsed buffer sender)
4386 "Echos a private notice in BUFFER and in all of the buffers for
4387 which SENDER is a member. This function is designed to be added
4388 to either `erc-echo-notice-hook' or
4389 `erc-echo-notice-always-hook', and returns non-nil if there is
4390 at least one buffer for which the sender is a member or the
4391 default target.
4393 See also: `erc-echo-notice-in-user-buffers',
4394 `erc-buffer-list-with-nick'."
4395 (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4396 (unless (memq buffer buffers) (push buffer buffers))
4397 (if buffers ;FIXME: How could it be nil?
4398 (progn (erc-display-message parsed nil buffers s) t)
4399 nil)))
4401 (defun erc-echo-notice-in-first-user-buffer (s parsed _buffer sender)
4402 "Echos a private notice in one of the buffers for which SENDER
4403 is a member. This function is designed to be added to either
4404 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
4405 returns non-nil if there is at least one buffer for which the
4406 sender is a member.
4408 See also: `erc-echo-notice-in-user-buffers',
4409 `erc-buffer-list-with-nick'."
4410 (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4411 (if buffers
4412 (progn (erc-display-message parsed nil (car buffers) s) t)
4413 nil)))
4415 ;;; Ban manipulation
4417 (defun erc-banlist-store (proc parsed)
4418 "Record ban entries for a channel."
4419 (pcase-let ((`(,channel ,mask ,whoset)
4420 (cdr (erc-response.command-args parsed))))
4421 ;; Determine to which buffer the message corresponds
4422 (let ((buffer (erc-get-buffer channel proc)))
4423 (with-current-buffer buffer
4424 (unless (member (cons whoset mask) erc-channel-banlist)
4425 (setq erc-channel-banlist (cons (cons whoset mask)
4426 erc-channel-banlist))))))
4427 nil)
4429 (defun erc-banlist-finished (proc parsed)
4430 "Record that we have received the banlist."
4431 (let* ((channel (nth 1 (erc-response.command-args parsed)))
4432 (buffer (erc-get-buffer channel proc)))
4433 (with-current-buffer buffer
4434 (put 'erc-channel-banlist 'received-from-server t)))
4435 t) ; suppress the 'end of banlist' message
4437 (defun erc-banlist-update (proc parsed)
4438 "Check MODE commands for bans and update the banlist appropriately."
4439 ;; FIXME: Possibly incorrect. -- Lawrence 2004-05-11
4440 (let* ((tgt (car (erc-response.command-args parsed)))
4441 (mode (erc-response.contents parsed))
4442 (whoset (erc-response.sender parsed))
4443 (buffer (erc-get-buffer tgt proc)))
4444 (when buffer
4445 (with-current-buffer buffer
4446 (cond ((not (get 'erc-channel-banlist 'received-from-server)) nil)
4448 ;; This is a ban
4449 (cond
4450 ((string-match "^-" mode)
4451 ;; Remove the unbanned masks from the ban list
4452 (setq erc-channel-banlist
4453 (erc-delete-if
4454 #'(lambda (y)
4455 (member (upcase (cdr y))
4456 (mapcar #'upcase
4457 (cdr (split-string mode)))))
4458 erc-channel-banlist)))
4459 ((string-match "^+" mode)
4460 ;; Add the banned mask(s) to the ban list
4461 (mapc
4462 (lambda (mask)
4463 (unless (member (cons whoset mask) erc-channel-banlist)
4464 (setq erc-channel-banlist
4465 (cons (cons whoset mask) erc-channel-banlist))))
4466 (cdr (split-string mode))))))))))
4467 nil)
4469 ;; used for the banlist cmds
4470 (defun erc-group-list (list n)
4471 "Group LIST into sublists of length N."
4472 (cond ((null list) nil)
4473 ((null (nthcdr n list)) (list list))
4474 (t (cons (erc-subseq list 0 n) (erc-group-list (nthcdr n list) n)))))
4477 ;;; MOTD numreplies
4479 (defun erc-handle-login ()
4480 "Handle the logging in process of connection."
4481 (unless erc-logged-in
4482 (setq erc-logged-in t)
4483 (message "Logging in as `%s'... done" (erc-current-nick))
4484 ;; execute a startup script
4485 (let ((f (erc-select-startup-file)))
4486 (when f
4487 (erc-load-script f)))))
4489 (defun erc-connection-established (proc parsed)
4490 "Run just after connection.
4492 Set user modes and run `erc-after-connect' hook."
4493 (with-current-buffer (process-buffer proc)
4494 (unless erc-server-connected ; only once per session
4495 (let ((server (or erc-server-announced-name
4496 (erc-response.sender parsed)))
4497 (nick (car (erc-response.command-args parsed)))
4498 (buffer (process-buffer proc)))
4499 (setq erc-server-connected t)
4500 (setq erc-server-reconnect-count 0)
4501 (erc-update-mode-line)
4502 (erc-set-initial-user-mode nick buffer)
4503 (erc-server-setup-periodical-ping buffer)
4504 (run-hook-with-args 'erc-after-connect server nick)))))
4506 (defun erc-set-initial-user-mode (nick buffer)
4507 "If `erc-user-mode' is non-nil for NICK, set the user modes.
4508 The server buffer is given by BUFFER."
4509 (with-current-buffer buffer
4510 (when erc-user-mode
4511 (let ((mode (if (functionp erc-user-mode)
4512 (funcall erc-user-mode)
4513 erc-user-mode)))
4514 (when (stringp mode)
4515 (erc-log (format "changing mode for %s to %s" nick mode))
4516 (erc-server-send (format "MODE %s %s" nick mode)))))))
4518 (defun erc-display-error-notice (parsed string)
4519 "Display STRING as an error notice.
4521 See also `erc-display-message'."
4522 (erc-display-message
4523 parsed '(notice error) 'active string))
4525 (defun erc-process-ctcp-query (proc parsed nick login host)
4526 ;; FIXME: This needs a proper docstring -- Lawrence 2004-01-08
4527 "Process a CTCP query."
4528 (let ((queries (delete "" (split-string (erc-response.contents parsed)
4529 "\C-a"))))
4530 (if (> (length queries) 4)
4531 (erc-display-message
4532 parsed (list 'notice 'error) proc 'ctcp-too-many)
4533 (if (= 0 (length queries))
4534 (erc-display-message
4535 parsed (list 'notice 'error) proc
4536 'ctcp-empty ?n nick)
4537 (while queries
4538 (let* ((type (upcase (car (split-string (car queries)))))
4539 (hook (intern-soft (concat "erc-ctcp-query-" type "-hook"))))
4540 (if (and hook (boundp hook))
4541 (if (string-equal type "ACTION")
4542 (run-hook-with-args-until-success
4543 hook proc parsed nick login host
4544 (car (erc-response.command-args parsed))
4545 (car queries))
4546 (when erc-paranoid
4547 (if (erc-current-nick-p
4548 (car (erc-response.command-args parsed)))
4549 (erc-display-message
4550 parsed 'error 'active 'ctcp-request
4551 ?n nick ?u login ?h host ?r (car queries))
4552 (erc-display-message
4553 parsed 'error 'active 'ctcp-request-to
4554 ?n nick ?u login ?h host ?r (car queries)
4555 ?t (car (erc-response.command-args parsed)))))
4556 (run-hook-with-args-until-success
4557 hook proc nick login host
4558 (car (erc-response.command-args parsed))
4559 (car queries)))
4560 (erc-display-message
4561 parsed (list 'notice 'error) proc
4562 'undefined-ctcp)))
4563 (setq queries (cdr queries)))))))
4565 (defvar erc-ctcp-query-ACTION-hook '(erc-ctcp-query-ACTION))
4567 (defun erc-ctcp-query-ACTION (proc parsed nick login host to msg)
4568 "Respond to a CTCP ACTION query."
4570 (let ((s (match-string 1 msg))
4571 (buf (or (erc-get-buffer to proc)
4572 (erc-get-buffer nick proc)
4573 (process-buffer proc))))
4574 (erc-display-message
4575 parsed 'action buf
4576 'ACTION ?n nick ?u login ?h host ?a s))))
4578 (defvar erc-ctcp-query-CLIENTINFO-hook '(erc-ctcp-query-CLIENTINFO))
4580 (defun erc-ctcp-query-CLIENTINFO (_proc nick _login _host _to msg)
4581 "Respond to a CTCP CLIENTINFO query."
4583 (let ((s (erc-client-info (erc-trim-string (match-string 1 msg)))))
4584 (unless erc-disable-ctcp-replies
4585 (erc-send-ctcp-notice nick (format "CLIENTINFO %s" s)))))
4586 nil)
4588 (defvar erc-ctcp-query-ECHO-hook '(erc-ctcp-query-ECHO))
4589 (defun erc-ctcp-query-ECHO (_proc nick _login _host _to msg)
4590 "Respond to a CTCP ECHO query."
4592 (let ((s (match-string 1 msg)))
4593 (unless erc-disable-ctcp-replies
4594 (erc-send-ctcp-notice nick (format "ECHO %s" s)))))
4595 nil)
4597 (defvar erc-ctcp-query-FINGER-hook '(erc-ctcp-query-FINGER))
4598 (defun erc-ctcp-query-FINGER (_proc nick _login _host _to _msg)
4599 "Respond to a CTCP FINGER query."
4600 (unless erc-disable-ctcp-replies
4601 (let ((s (if erc-anonymous-login
4602 (format "FINGER I'm %s." (erc-current-nick))
4603 (format "FINGER %s (%s@%s)."
4604 (user-full-name)
4605 (user-login-name)
4606 (system-name))))
4607 (ns (erc-time-diff erc-server-last-sent-time (erc-current-time))))
4608 (when (> ns 0)
4609 (setq s (concat s " Idle for " (erc-sec-to-time ns))))
4610 (erc-send-ctcp-notice nick s)))
4611 nil)
4613 (defvar erc-ctcp-query-PING-hook '(erc-ctcp-query-PING))
4614 (defun erc-ctcp-query-PING (_proc nick _login _host _to msg)
4615 "Respond to a CTCP PING query."
4617 (unless erc-disable-ctcp-replies
4618 (let ((arg (match-string 1 msg)))
4619 (erc-send-ctcp-notice nick (format "PING %s" arg)))))
4620 nil)
4622 (defvar erc-ctcp-query-TIME-hook '(erc-ctcp-query-TIME))
4623 (defun erc-ctcp-query-TIME (_proc nick _login _host _to _msg)
4624 "Respond to a CTCP TIME query."
4625 (unless erc-disable-ctcp-replies
4626 (erc-send-ctcp-notice nick (format "TIME %s" (current-time-string))))
4627 nil)
4629 (defvar erc-ctcp-query-USERINFO-hook '(erc-ctcp-query-USERINFO))
4630 (defun erc-ctcp-query-USERINFO (_proc nick _login _host _to _msg)
4631 "Respond to a CTCP USERINFO query."
4632 (unless erc-disable-ctcp-replies
4633 (erc-send-ctcp-notice nick (format "USERINFO %s" erc-user-information)))
4634 nil)
4636 (defvar erc-ctcp-query-VERSION-hook '(erc-ctcp-query-VERSION))
4637 (defun erc-ctcp-query-VERSION (_proc nick _login _host _to _msg)
4638 "Respond to a CTCP VERSION query."
4639 (unless erc-disable-ctcp-replies
4640 (erc-send-ctcp-notice
4641 nick (format
4642 "VERSION \C-bERC\C-b - an IRC client for Emacs %s (\C-b%s\C-b)"
4643 emacs-version
4644 erc-official-location)))
4645 nil)
4647 (defun erc-process-ctcp-reply (proc parsed nick login host msg)
4648 "Process MSG as a CTCP reply."
4649 (let* ((type (car (split-string msg)))
4650 (hook (intern (concat "erc-ctcp-reply-" type "-hook"))))
4651 (if (boundp hook)
4652 (run-hook-with-args-until-success
4653 hook proc nick login host
4654 (car (erc-response.command-args parsed)) msg)
4655 (erc-display-message
4656 parsed 'notice 'active
4657 'CTCP-UNKNOWN ?n nick ?u login ?h host ?m msg))))
4659 (defvar erc-ctcp-reply-ECHO-hook '(erc-ctcp-reply-ECHO))
4660 (defun erc-ctcp-reply-ECHO (_proc nick _login _host _to msg)
4661 "Handle a CTCP ECHO reply."
4663 (let ((message (match-string 1 msg)))
4664 (erc-display-message
4665 nil '(notice action) 'active
4666 'CTCP-ECHO ?n nick ?m message)))
4667 nil)
4669 (defvar erc-ctcp-reply-CLIENTINFO-hook '(erc-ctcp-reply-CLIENTINFO))
4670 (defun erc-ctcp-reply-CLIENTINFO (_proc nick _login _host _to msg)
4671 "Handle a CTCP CLIENTINFO reply."
4673 (let ((message (match-string 1 msg)))
4674 (erc-display-message
4675 nil 'notice 'active
4676 'CTCP-CLIENTINFO ?n nick ?m message)))
4677 nil)
4679 (defvar erc-ctcp-reply-FINGER-hook '(erc-ctcp-reply-FINGER))
4680 (defun erc-ctcp-reply-FINGER (_proc nick _login _host _to msg)
4681 "Handle a CTCP FINGER reply."
4683 (let ((message (match-string 1 msg)))
4684 (erc-display-message
4685 nil 'notice 'active
4686 'CTCP-FINGER ?n nick ?m message)))
4687 nil)
4689 (defvar erc-ctcp-reply-PING-hook '(erc-ctcp-reply-PING))
4690 (defun erc-ctcp-reply-PING (_proc nick _login _host _to msg)
4691 "Handle a CTCP PING reply."
4693 nil
4694 (let ((time (match-string 1 msg)))
4695 (condition-case nil
4696 (let ((delta (erc-time-diff (string-to-number time)
4697 (erc-current-time))))
4698 (erc-display-message
4699 nil 'notice 'active
4700 'CTCP-PING ?n nick
4701 ?t (erc-sec-to-time delta)))
4702 (range-error
4703 (erc-display-message
4704 nil 'error 'active
4705 'bad-ping-response ?n nick ?t time))))))
4707 (defvar erc-ctcp-reply-TIME-hook '(erc-ctcp-reply-TIME))
4708 (defun erc-ctcp-reply-TIME (_proc nick _login _host _to msg)
4709 "Handle a CTCP TIME reply."
4711 (let ((message (match-string 1 msg)))
4712 (erc-display-message
4713 nil 'notice 'active
4714 'CTCP-TIME ?n nick ?m message)))
4715 nil)
4717 (defvar erc-ctcp-reply-VERSION-hook '(erc-ctcp-reply-VERSION))
4718 (defun erc-ctcp-reply-VERSION (_proc nick _login _host _to msg)
4719 "Handle a CTCP VERSION reply."
4721 (let ((message (match-string 1 msg)))
4722 (erc-display-message
4723 nil 'notice 'active
4724 'CTCP-VERSION ?n nick ?m message)))
4725 nil)
4727 (defun erc-process-away (proc away-p)
4728 "Toggle the away status of the user depending on the value of AWAY-P.
4730 If nil, set the user as away.
4731 If non-nil, return from being away."
4732 (let ((sessionbuf (process-buffer proc)))
4733 (when sessionbuf
4734 (with-current-buffer sessionbuf
4735 (when erc-away-nickname
4736 (erc-log (format "erc-process-away: away-nick: %s, away-p: %s"
4737 erc-away-nickname away-p))
4738 (erc-cmd-NICK (if away-p
4739 erc-away-nickname
4740 erc-nick)))
4741 (cond
4742 (away-p
4743 (setq erc-away (current-time)))
4744 (t
4745 (let ((away-time erc-away))
4746 ;; away must be set to NIL BEFORE sending anything to prevent
4747 ;; an infinite recursion
4748 (setq erc-away nil)
4749 (with-current-buffer (erc-active-buffer)
4750 (when erc-public-away-p
4751 (erc-send-action
4752 (erc-default-target)
4753 (if away-time
4754 (format "is back (gone for %s)"
4755 (erc-sec-to-time
4756 (erc-time-diff
4757 (erc-emacs-time-to-erc-time away-time)
4758 (erc-current-time))))
4759 "is back")))))))))
4760 (erc-update-mode-line)))
4762 ;;;; List of channel members handling
4764 (defun erc-channel-begin-receiving-names ()
4765 "Internal function.
4767 Used when a channel names list is about to be received. Should
4768 be called with the current buffer set to the channel buffer.
4770 See also `erc-channel-end-receiving-names'."
4771 (setq erc-channel-new-member-names (make-hash-table :test 'equal)))
4773 (defun erc-channel-end-receiving-names ()
4774 "Internal function.
4776 Used to fix `erc-channel-users' after a channel names list has been
4777 received. Should be called with the current buffer set to the
4778 channel buffer.
4780 See also `erc-channel-begin-receiving-names'."
4781 (maphash (lambda (nick _user)
4782 (if (null (gethash nick erc-channel-new-member-names))
4783 (erc-remove-channel-user nick)))
4784 erc-channel-users)
4785 (setq erc-channel-new-member-names nil))
4787 (defun erc-parse-prefix ()
4788 "Return an alist of valid prefix character types and their representations.
4789 Example: (operator) o => @, (voiced) v => +."
4790 (let ((str (or (cdr (assoc "PREFIX" (erc-with-server-buffer
4791 erc-server-parameters)))
4792 ;; provide a sane default
4793 "(qaohv)~&@%+"))
4794 types chars)
4796 (setq types (match-string 1 str)
4797 chars (match-string 2 str))
4798 (let ((len (min (length types) (length chars)))
4799 (i 0)
4800 (alist nil))
4801 (while (< i len)
4802 (setq alist (cons (cons (elt types i) (elt chars i))
4803 alist))
4804 (setq i (1+ i)))
4805 alist))))
4807 (defun erc-channel-receive-names (names-string)
4808 "This function is for internal use only.
4810 Update `erc-channel-users' according to NAMES-STRING.
4811 NAMES-STRING is a string listing some of the names on the
4812 channel."
4813 (let* ((prefix (erc-parse-prefix))
4814 (voice-ch (cdr (assq ?v prefix)))
4815 (op-ch (cdr (assq ?o prefix)))
4816 (hop-ch (cdr (assq ?h prefix)))
4817 (adm-ch (cdr (assq ?a prefix)))
4818 (own-ch (cdr (assq ?q prefix)))
4819 (names (delete "" (split-string names-string)))
4820 name op voice halfop admin owner)
4821 (let ((erc-channel-members-changed-hook nil))
4822 (dolist (item names)
4823 (let ((updatep t)
4824 (ch (aref item 0)))
4825 (setq name item op 'off voice 'off halfop 'off admin 'off owner 'off)
4826 (if (rassq ch prefix)
4827 (if (= (length item) 1)
4828 (setq updatep nil)
4829 (setq name (substring item 1))
4830 (setf (pcase ch
4831 ((pred (eq voice-ch)) voice)
4832 ((pred (eq hop-ch)) halfop)
4833 ((pred (eq op-ch)) op)
4834 ((pred (eq adm-ch)) admin)
4835 ((pred (eq own-ch)) owner)
4836 (_ (message "Unknown prefix char `%S'" ch) voice))
4837 'on)))
4838 (when updatep
4839 ;; If we didn't issue the NAMES request (consider two clients
4840 ;; talking to an IRC proxy), `erc-channel-begin-receiving-names'
4841 ;; will not have been called, so we have to do it here.
4842 (unless erc-channel-new-member-names
4843 (erc-channel-begin-receiving-names))
4844 (puthash (erc-downcase name) t
4845 erc-channel-new-member-names)
4846 (erc-update-current-channel-member
4847 name name t voice halfop op admin owner)))))
4848 (run-hooks 'erc-channel-members-changed-hook)))
4851 (defcustom erc-channel-members-changed-hook nil
4852 "This hook is called every time the variable `channel-members' changes.
4853 The buffer where the change happened is current while this hook is called."
4854 :group 'erc-hooks
4855 :type 'hook)
4857 (defun erc-update-user-nick (nick &optional new-nick
4858 host login full-name info)
4859 "Update the stored user information for the user with nickname NICK.
4861 See also: `erc-update-user'."
4862 (erc-update-user (erc-get-server-user nick) new-nick
4863 host login full-name info))
4865 (defun erc-update-user (user &optional new-nick
4866 host login full-name info)
4867 "Update user info for USER. USER must be an erc-server-user
4868 struct. Any of NEW-NICK, HOST, LOGIN, FULL-NAME, INFO which are
4869 non-nil and not equal to the existing values for USER are used to
4870 replace the stored values in USER.
4872 If, and only if, a change is made,
4873 `erc-channel-members-changed-hook' is run for each channel for
4874 which USER is a member, and t is returned."
4875 (let (changed)
4876 (when user
4877 (when (and new-nick
4878 (not (equal (erc-server-user-nickname user)
4879 new-nick)))
4880 (setq changed t)
4881 (erc-change-user-nickname user new-nick))
4882 (when (and host
4883 (not (equal (erc-server-user-host user) host)))
4884 (setq changed t)
4885 (setf (erc-server-user-host user) host))
4886 (when (and login
4887 (not (equal (erc-server-user-login user) login)))
4888 (setq changed t)
4889 (setf (erc-server-user-login user) login))
4890 (when (and full-name
4891 (not (equal (erc-server-user-full-name user)
4892 full-name)))
4893 (setq changed t)
4894 (setf (erc-server-user-full-name user) full-name))
4895 (when (and info
4896 (not (equal (erc-server-user-info user) info)))
4897 (setq changed t)
4898 (setf (erc-server-user-info user) info))
4899 (if changed
4900 (dolist (buf (erc-server-user-buffers user))
4901 (if (buffer-live-p buf)
4902 (with-current-buffer buf
4903 (run-hooks 'erc-channel-members-changed-hook))))))
4904 changed))
4906 (defun erc-update-current-channel-member
4907 (nick new-nick &optional add voice halfop op admin owner host login full-name info
4908 update-message-time)
4909 "Update the stored user information for the user with nickname NICK.
4910 `erc-update-user' is called to handle changes to nickname,
4911 HOST, LOGIN, FULL-NAME, and INFO. If VOICE HALFOP OP ADMIN or OWNER
4912 are non-nil, they must be equal to either `on' or `off', in which
4913 case the status of the user in the current channel is changed accordingly.
4914 If UPDATE-MESSAGE-TIME is non-nil, the last-message-time of the user
4915 in the current channel is set to (current-time).
4917 If ADD is non-nil, the user will be added with the specified
4918 information if it is not already present in the user or channel
4919 lists.
4921 If, and only if, changes are made, or the user is added,
4922 `erc-channel-members-updated-hook' is run, and t is returned.
4924 See also: `erc-update-user' and `erc-update-channel-member'."
4925 (let* (changed user-changed
4926 (channel-data (erc-get-channel-user nick))
4927 (cuser (cdr channel-data))
4928 (user (if channel-data (car channel-data)
4929 (erc-get-server-user nick))))
4930 (if cuser
4931 (progn
4932 (erc-log (format "update-member: user = %S, cuser = %S" user cuser))
4933 (when (and voice
4934 (not (eq (erc-channel-user-voice cuser) voice)))
4935 (setq changed t)
4936 (setf (erc-channel-user-voice cuser)
4937 (cond ((eq voice 'on) t)
4938 ((eq voice 'off) nil)
4939 (t voice))))
4940 (when (and halfop
4941 (not (eq (erc-channel-user-halfop cuser) halfop)))
4942 (setq changed t)
4943 (setf (erc-channel-user-halfop cuser)
4944 (cond ((eq halfop 'on) t)
4945 ((eq halfop 'off) nil)
4946 (t halfop))))
4947 (when (and op
4948 (not (eq (erc-channel-user-op cuser) op)))
4949 (setq changed t)
4950 (setf (erc-channel-user-op cuser)
4951 (cond ((eq op 'on) t)
4952 ((eq op 'off) nil)
4953 (t op))))
4954 (when (and admin
4955 (not (eq (erc-channel-user-admin cuser) admin)))
4956 (setq changed t)
4957 (setf (erc-channel-user-admin cuser)
4958 (cond ((eq admin 'on) t)
4959 ((eq admin 'off) nil)
4960 (t admin))))
4961 (when (and owner
4962 (not (eq (erc-channel-user-owner cuser) owner)))
4963 (setq changed t)
4964 (setf (erc-channel-user-owner cuser)
4965 (cond ((eq owner 'on) t)
4966 ((eq owner 'off) nil)
4967 (t owner))))
4968 (when update-message-time
4969 (setf (erc-channel-user-last-message-time cuser) (current-time)))
4970 (setq user-changed
4971 (erc-update-user user new-nick
4972 host login full-name info)))
4973 (when add
4974 (if (null user)
4975 (progn
4976 (setq user (make-erc-server-user
4977 :nickname nick
4978 :host host
4979 :full-name full-name
4980 :login login
4981 :info info
4982 :buffers (list (current-buffer))))
4983 (erc-add-server-user nick user))
4984 (setf (erc-server-user-buffers user)
4985 (cons (current-buffer)
4986 (erc-server-user-buffers user))))
4987 (setq cuser (make-erc-channel-user
4988 :voice (cond ((eq voice 'on) t)
4989 ((eq voice 'off) nil)
4990 (t voice))
4991 :halfop (cond ((eq halfop 'on) t)
4992 ((eq halfop 'off) nil)
4993 (t halfop))
4994 :op (cond ((eq op 'on) t)
4995 ((eq op 'off) nil)
4996 (t op))
4997 :admin (cond ((eq admin 'on) t)
4998 ((eq admin 'off) nil)
4999 (t admin))
5000 :owner (cond ((eq owner 'on) t)
5001 ((eq owner 'off) nil)
5002 (t owner))
5003 :last-message-time
5004 (if update-message-time (current-time))))
5005 (puthash (erc-downcase nick) (cons user cuser)
5006 erc-channel-users)
5007 (setq changed t)))
5008 (when (and changed (null user-changed))
5009 (run-hooks 'erc-channel-members-changed-hook))
5010 (or changed user-changed add)))
5012 (defun erc-update-channel-member (channel nick new-nick
5013 &optional add voice halfop op admin owner host login
5014 full-name info update-message-time)
5015 "Update user and channel information for the user with
5016 nickname NICK in channel CHANNEL.
5018 See also: `erc-update-current-channel-member'."
5019 (erc-with-buffer
5020 (channel)
5021 (erc-update-current-channel-member nick new-nick add voice halfop op admin owner host
5022 login full-name info
5023 update-message-time)))
5025 (defun erc-remove-current-channel-member (nick)
5026 "Remove NICK from current channel membership list.
5027 Runs `erc-channel-members-changed-hook'."
5028 (let ((channel-data (erc-get-channel-user nick)))
5029 (when channel-data
5030 (erc-remove-channel-user nick)
5031 (run-hooks 'erc-channel-members-changed-hook))))
5033 (defun erc-remove-channel-member (channel nick)
5034 "Remove NICK from CHANNEL's membership list.
5036 See also `erc-remove-current-channel-member'."
5037 (erc-with-buffer
5038 (channel)
5039 (erc-remove-current-channel-member nick)))
5041 (defun erc-update-channel-topic (channel topic &optional modify)
5042 "Find a buffer for CHANNEL and set the TOPIC for it.
5044 If optional MODIFY is `append' or `prepend', then append or prepend the
5045 TOPIC string to the current topic."
5046 (erc-with-buffer (channel)
5047 (cond ((eq modify 'append)
5048 (setq erc-channel-topic (concat erc-channel-topic topic)))
5049 ((eq modify 'prepend)
5050 (setq erc-channel-topic (concat topic erc-channel-topic)))
5051 (t (setq erc-channel-topic topic)))
5052 (erc-update-mode-line-buffer (current-buffer))))
5054 (defun erc-set-modes (tgt mode-string)
5055 "Set the modes for the TGT provided as MODE-STRING."
5056 (let* ((modes (erc-parse-modes mode-string))
5057 (add-modes (nth 0 modes))
5058 ;; list of triples: (mode-char 'on/'off argument)
5059 (arg-modes (nth 2 modes)))
5060 (cond ((erc-channel-p tgt); channel modes
5061 (let ((buf (and erc-server-process
5062 (erc-get-buffer tgt erc-server-process))))
5063 (when buf
5064 (with-current-buffer buf
5065 (setq erc-channel-modes add-modes)
5066 (setq erc-channel-user-limit nil)
5067 (setq erc-channel-key nil)
5068 (while arg-modes
5069 (let ((mode (nth 0 (car arg-modes)))
5070 (onoff (nth 1 (car arg-modes)))
5071 (arg (nth 2 (car arg-modes))))
5072 (cond ((string-match "^[Ll]" mode)
5073 (erc-update-channel-limit tgt onoff arg))
5074 ((string-match "^[Kk]" mode)
5075 (erc-update-channel-key tgt onoff arg))
5076 (t nil)))
5077 (setq arg-modes (cdr arg-modes)))
5078 (erc-update-mode-line-buffer buf)))))
5079 ;; we do not keep our nick's modes yet
5080 ;;(t (setq erc-user-modes add-modes))
5081 )
5082 ))
5084 (defun erc-sort-strings (list-of-strings)
5085 "Sort LIST-OF-STRINGS in lexicographic order.
5087 Side-effect free."
5088 (sort (copy-sequence list-of-strings) 'string<))
5090 (defun erc-parse-modes (mode-string)
5091 "Parse MODE-STRING into a list.
5093 Returns a list of three elements:
5095 (ADD-MODES REMOVE-MODES ARG-MODES).
5097 The add-modes and remove-modes are lists of single-character strings
5098 for modes without parameters to add and remove respectively. The
5099 arg-modes is a list of triples of the form:
5101 (MODE-CHAR ON/OFF ARGUMENT)."
5103 (let ((chars (mapcar #'char-to-string (match-string 1 mode-string)))
5104 ;; arguments in channel modes
5105 (args-str (match-string 2 mode-string))
5106 (args nil)
5107 (add-modes nil)
5108 (remove-modes nil)
5109 (arg-modes nil); list of triples: (mode-char 'on/'off argument)
5110 (add-p t))
5111 ;; make the argument list
5113 (setq args (cons (match-string 1 args-str) args))
5114 (setq args-str (match-string 2 args-str)))
5115 (setq args (nreverse args))
5116 ;; collect what modes changed, and match them with arguments
5117 (while chars
5118 (cond ((string= (car chars) "+") (setq add-p t))
5119 ((string= (car chars) "-") (setq add-p nil))
5120 ((string-match "^[qaovhbQAOVHB]" (car chars))
5121 (setq arg-modes (cons (list (car chars)
5122 (if add-p 'on 'off)
5123 (if args (car args) nil))
5124 arg-modes))
5125 (if args (setq args (cdr args))))
5126 ((string-match "^[LlKk]" (car chars))
5127 (setq arg-modes (cons (list (car chars)
5128 (if add-p 'on 'off)
5129 (if (and add-p args)
5130 (car args) nil))
5131 arg-modes))
5132 (if (and add-p args) (setq args (cdr args))))
5133 (add-p (setq add-modes (cons (car chars) add-modes)))
5134 (t (setq remove-modes (cons (car chars) remove-modes))))
5135 (setq chars (cdr chars)))
5136 (setq add-modes (nreverse add-modes))
5137 (setq remove-modes (nreverse remove-modes))
5138 (setq arg-modes (nreverse arg-modes))
5139 (list add-modes remove-modes arg-modes))
5140 nil))
5142 (defun erc-update-modes (tgt mode-string &optional _nick _host _login)
5143 "Update the mode information for TGT, provided as MODE-STRING.
5144 Optional arguments: NICK, HOST and LOGIN - the attributes of the
5145 person who changed the modes."
5146 ;; FIXME: neither of nick, host, and login are used!
5147 (let* ((modes (erc-parse-modes mode-string))
5148 (add-modes (nth 0 modes))
5149 (remove-modes (nth 1 modes))
5150 ;; list of triples: (mode-char 'on/'off argument)
5151 (arg-modes (nth 2 modes)))
5152 ;; now parse the modes changes and do the updates
5153 (cond ((erc-channel-p tgt); channel modes
5154 (let ((buf (and erc-server-process
5155 (erc-get-buffer tgt erc-server-process))))
5156 (when buf
5157 ;; FIXME! This used to have an original buffer
5158 ;; variable, but it never switched back to the original
5159 ;; buffer. Is this wanted behavior?
5160 (set-buffer buf)
5161 (if (not (boundp 'erc-channel-modes))
5162 (setq erc-channel-modes nil))
5163 (while remove-modes
5164 (setq erc-channel-modes (delete (car remove-modes)
5165 erc-channel-modes)
5166 remove-modes (cdr remove-modes)))
5167 (while add-modes
5168 (setq erc-channel-modes (cons (car add-modes)
5169 erc-channel-modes)
5170 add-modes (cdr add-modes)))
5171 (setq erc-channel-modes (erc-sort-strings erc-channel-modes))
5172 (while arg-modes
5173 (let ((mode (nth 0 (car arg-modes)))
5174 (onoff (nth 1 (car arg-modes)))
5175 (arg (nth 2 (car arg-modes))))
5176 (cond ((string-match "^[Vv]" mode)
5177 (erc-update-channel-member tgt arg arg nil onoff))
5178 ((string-match "^[hH]" mode)
5179 (erc-update-channel-member tgt arg arg nil nil onoff))
5180 ((string-match "^[oO]" mode)
5181 (erc-update-channel-member tgt arg arg nil nil nil onoff))
5182 ((string-match "^[aA]" mode)
5183 (erc-update-channel-member tgt arg arg nil nil nil nil onoff))
5184 ((string-match "^[qQ]" mode)
5185 (erc-update-channel-member tgt arg arg nil nil nil nil nil onoff))
5186 ((string-match "^[Ll]" mode)
5187 (erc-update-channel-limit tgt onoff arg))
5188 ((string-match "^[Kk]" mode)
5189 (erc-update-channel-key tgt onoff arg))
5190 (t nil)); only ops are tracked now
5191 (setq arg-modes (cdr arg-modes))))
5192 (erc-update-mode-line buf))))
5193 ;; nick modes - ignored at this point
5194 (t nil))))
5196 (defun erc-update-channel-limit (channel onoff n)
5197 ;; FIXME: what does ONOFF actually do? -- Lawrence 2004-01-08
5198 "Update CHANNEL's user limit to N."
5199 (if (or (not (eq onoff 'on))
5200 (and (stringp n) (string-match "^[0-9]+$" n)))
5201 (erc-with-buffer
5202 (channel)
5203 (cond ((eq onoff 'on) (setq erc-channel-user-limit (string-to-number n)))
5204 (t (setq erc-channel-user-limit nil))))))
5206 (defun erc-update-channel-key (channel onoff key)
5207 "Update CHANNEL's key to KEY if ONOFF is `on' or to nil if it's `off'."
5208 (erc-with-buffer
5209 (channel)
5210 (cond ((eq onoff 'on) (setq erc-channel-key key))
5211 (t (setq erc-channel-key nil)))))
5213 (defun erc-handle-user-status-change (type nlh &optional l)
5214 "Handle changes in any user's status.
5216 So far, only nick change is handled.
5218 Generally, the TYPE argument is a symbol describing the change type, NLH is
5219 a list containing the original nickname, login name and hostname for the user,
5220 and L is a list containing additional TYPE-specific arguments.
5222 So far the following TYPE/L pairs are supported:
5224 Event TYPE L
5226 nickname change `nick' (NEW-NICK)"
5227 (erc-log (format "user-change: type: %S nlh: %S l: %S" type nlh l))
5228 (cond
5229 ;; nickname change
5230 ((equal type 'nick)
5231 t)
5232 (t
5233 nil)))
5235 (defun erc-highlight-notice (s)
5236 "Highlight notice message S and return it.
5237 See also variable `erc-notice-highlight-type'."
5238 (cond
5239 ((eq erc-notice-highlight-type 'prefix)
5240 (erc-put-text-property 0 (length erc-notice-prefix)
5241 'font-lock-face 'erc-notice-face s)
5242 s)
5243 ((eq erc-notice-highlight-type 'all)
5244 (erc-put-text-property 0 (length s) 'font-lock-face 'erc-notice-face s)
5245 s)
5246 (t s)))
5248 (defun erc-make-notice (message)
5249 "Notify the user of MESSAGE."
5250 (when erc-minibuffer-notice
5251 (message "%s" message))
5252 (erc-highlight-notice (concat erc-notice-prefix message)))
5254 (defun erc-highlight-error (s)
5255 "Highlight error message S and return it."
5256 (erc-put-text-property 0 (length s) 'font-lock-face 'erc-error-face s)
5257 s)
5259 (defun erc-put-text-property (start end property value &optional object)
5260 "Set text-property for an object (usually a string).
5261 START and END define the characters covered.
5262 PROPERTY is the text-property set, usually the symbol `face'.
5263 VALUE is the value for the text-property, usually a face symbol such as
5264 the face `bold' or `erc-pal-face'.
5265 OBJECT is a string which will be modified and returned.
5266 OBJECT is modified without being copied first.
5268 You can redefine or `defadvice' this function in order to add
5269 EmacsSpeak support."
5270 (put-text-property start end property value object))
5272 (defun erc-list (thing)
5273 "Return THING if THING is a list, or a list with THING as its element."
5274 (if (listp thing)
5275 thing
5276 (list thing)))
5278 (defun erc-parse-user (string)
5279 "Parse STRING as a user specification (nick!login@host).
5281 Return a list of the three separate tokens."
5282 (cond
5284 (list (match-string 1 string)
5285 (match-string 2 string)
5286 (match-string 3 string)))
5287 ;; Some bogus bouncers send Nick!(null), try to live with that.
5289 (list (match-string 1 string)
5290 ""
5291 (match-string 2 string)))
5292 (t
5293 (list string "" ""))))
5295 (defun erc-extract-nick (string)
5296 "Return the nick corresponding to a user specification STRING.
5298 See also `erc-parse-user'."
5299 (car (erc-parse-user string)))
5301 (defun erc-put-text-properties (start end properties
5302 &optional object value-list)
5303 "Set text-properties for OBJECT.
5305 START and END describe positions in OBJECT.
5306 If VALUE-LIST is nil, set each property in PROPERTIES to t, else set
5307 each property to the corresponding value in VALUE-LIST."
5308 (unless value-list
5309 (setq value-list (mapcar (lambda (_x) t)
5310 properties)))
5311 (while (and properties value-list)
5312 (erc-put-text-property
5313 start end (pop properties) (pop value-list) object)))
5315 ;;; Input area handling:
5317 (defun erc-beg-of-input-line ()
5318 "Return the value of `point' at the beginning of the input line.
5320 Specifically, return the position of `erc-insert-marker'."
5321 (or (and (boundp 'erc-insert-marker)
5322 (markerp erc-insert-marker))
5323 (error "erc-insert-marker has no value, please report a bug"))
5324 (marker-position erc-insert-marker))
5326 (defun erc-end-of-input-line ()
5327 "Return the value of `point' at the end of the input line."
5328 (point-max))
5330 (defvar erc-last-input-time 0
5331 "Time of last call to `erc-send-current-line'.
5332 If that function has never been called, the value is 0.")
5334 (defcustom erc-accidental-paste-threshold-seconds nil
5335 "Minimum time, in seconds, before sending new lines via IRC.
5336 If the value is a number, `erc-send-current-line' signals an error
5337 if its previous invocation was fewer than this many seconds ago.
5338 This is useful so that if you accidentally enter large amounts of text
5339 into the ERC buffer, that text is not sent to the IRC server.
5341 If the value is nil, `erc-send-current-line' always considers any
5342 submitted line to be intentional."
5343 :group 'erc
5344 :version "24.4"
5345 :type '(choice number (other :tag "disabled" nil)))
5347 (defun erc-send-current-line ()
5348 "Parse current line and send it to IRC."
5349 (interactive)
5350 (let ((now (float-time)))
5351 (if (or (not erc-accidental-paste-threshold-seconds)
5352 (< erc-accidental-paste-threshold-seconds
5353 (- now erc-last-input-time)))
5354 (save-restriction
5355 (widen)
5356 (if (< (point) (erc-beg-of-input-line))
5357 (erc-error "Point is not in the input area")
5358 (let ((inhibit-read-only t)
5359 (str (erc-user-input))
5360 (old-buf (current-buffer)))
5361 (if (and (not (erc-server-buffer-live-p))
5362 (not (erc-command-no-process-p str)))
5363 (erc-error "ERC: No process running")
5364 (erc-set-active-buffer (current-buffer))
5365 ;; Kill the input and the prompt
5366 (delete-region (erc-beg-of-input-line)
5367 (erc-end-of-input-line))
5368 (unwind-protect
5369 (erc-send-input str)
5370 ;; Fix the buffer if the command didn't kill it
5371 (when (buffer-live-p old-buf)
5372 (with-current-buffer old-buf
5373 (save-restriction
5374 (widen)
5375 (goto-char (point-max))
5376 (when (processp erc-server-process)
5377 (set-marker (process-mark erc-server-process) (point)))
5378 (set-marker erc-insert-marker (point))
5379 (let ((buffer-modified (buffer-modified-p)))
5380 (erc-display-prompt)
5381 (set-buffer-modified-p buffer-modified))))))
5383 ;; Only when last hook has been run...
5384 (run-hook-with-args 'erc-send-completed-hook str))))
5385 (setq erc-last-input-time now))
5386 (switch-to-buffer "*ERC Accidental Paste Overflow*")
5387 (lwarn 'erc :warning
5388 "You seem to have accidentally pasted some text!"))))
5390 (defun erc-user-input ()
5391 "Return the input of the user in the current buffer."
5392 (buffer-substring-no-properties
5393 erc-input-marker
5394 (erc-end-of-input-line)))
5397 "Regular expression used for matching commands in ERC.")
5399 (defun erc-send-input (input)
5400 "Treat INPUT as typed in by the user. It is assumed that the input
5401 and the prompt is already deleted.
5402 This returns non-nil only if we actually send anything."
5403 ;; Handle different kinds of inputs
5404 (cond
5405 ;; Ignore empty input
5406 ((if erc-send-whitespace-lines
5407 (string= input "")
5409 (when erc-warn-about-blank-lines
5410 (message "Blank line - ignoring...")
5411 (beep))
5412 nil)
5413 (t
5414 (defvar str) ;; FIXME: Make it obey the "erc-" prefix convention.
5415 (let ((str input)
5416 (erc-insert-this t))
5417 (setq erc-send-this t)
5418 (run-hook-with-args 'erc-send-pre-hook input)
5419 (when erc-send-this
5421 (not (string-match erc-command-regexp str)))
5422 (mapc
5423 (lambda (line)
5424 (mapc
5425 (lambda (line)
5426 ;; Insert what has to be inserted for this.
5427 (erc-display-msg line)
5429 (null erc-flood-protect) t))
5430 (or (and erc-flood-protect (erc-split-line line))
5431 (list line))))
5434 t)))))
5436 (defun erc-display-command (line)
5437 (when erc-insert-this
5438 (let ((insert-position (point)))
5439 (unless erc-hide-prompt
5440 (erc-display-prompt nil nil (erc-command-indicator)
5441 (and (erc-command-indicator)
5442 'erc-command-indicator-face)))
5443 (let ((beg (point)))
5444 (insert line)
5445 (erc-put-text-property beg (point)
5446 'font-lock-face 'erc-command-indicator-face)
5448 (when (processp erc-server-process)
5449 (set-marker (process-mark erc-server-process) (point)))
5450 (set-marker erc-insert-marker (point))
5451 (save-excursion
5452 (save-restriction
5453 (narrow-to-region insert-position (point))
5454 (run-hooks 'erc-send-modify-hook)
5455 (run-hooks 'erc-send-post-hook))))))
5457 (defun erc-display-msg (line)
5458 "Display LINE as a message of the user to the current target at the
5459 current position."
5460 (when erc-insert-this
5461 (let ((insert-position (point)))
5462 (insert (erc-format-my-nick))
5463 (let ((beg (point)))
5464 (insert line)
5465 (erc-put-text-property beg (point)
5466 'font-lock-face 'erc-input-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-command-symbol (command)
5478 "Return the ERC command symbol for COMMAND if it exists and is bound."
5479 (let ((cmd (intern-soft (format "erc-cmd-%s" (upcase command)))))
5480 (when (fboundp cmd) cmd)))
5482 (defun erc-extract-command-from-line (line)
5483 "Extract command and args from the input LINE.
5484 If no command was given, return nil. If command matches, return a
5485 list of the form: (command args) where both elements are strings."
5486 (when (string-match erc-command-regexp line)
5487 (let* ((cmd (erc-command-symbol (match-string 1 line)))
5488 ;; note: return is nil, we apply this simply for side effects
5489 (_canon-defun (while (and cmd (symbolp (symbol-function cmd)))
5490 (setq cmd (symbol-function cmd))))
5491 (cmd-fun (or cmd #'erc-cmd-default))
5492 (arg (if cmd
5493 (if (get cmd-fun 'do-not-parse-args)
5494 (format "%s" (match-string 2 line))
5495 (delete "" (split-string (erc-trim-string
5496 (match-string 2 line)) " ")))
5497 line)))
5498 (list cmd-fun arg))))
5500 (defun erc-split-multiline-safe (string)
5501 "Split STRING, containing multiple lines and return them in a list.
5502 Do it only for STRING as the complete input, do not carry unfinished
5503 strings over to the next call."
5504 (let ((l ())
5505 (i0 0)
5506 (doit t))
5507 (while doit
5509 (s (substring string i0)))
5510 (cond (i (setq l (cons (substring string i0 i) l))
5511 (setq i0 (match-end 0)))
5512 ((> (length s) 0)
5513 (setq l (cons s l))(setq doit nil))
5514 (t (setq doit nil)))))
5515 (nreverse l)))
5517 ;; nick handling
5519 (defun erc-set-current-nick (nick)
5520 "Set the current nickname to NICK."
5521 (with-current-buffer (if (buffer-live-p (erc-server-buffer))
5522 (erc-server-buffer)
5523 (current-buffer))
5524 (setq erc-server-current-nick nick)))
5526 (defun erc-current-nick ()
5527 "Return the current nickname."
5528 (with-current-buffer (if (buffer-live-p (erc-server-buffer))
5529 (erc-server-buffer)
5530 (current-buffer))
5531 erc-server-current-nick))
5533 (defun erc-current-nick-p (nick)
5534 "Return non-nil if NICK is the current nickname."
5535 (erc-nick-equal-p nick (erc-current-nick)))
5537 (defun erc-nick-equal-p (nick1 nick2)
5538 "Return non-nil if NICK1 and NICK2 are the same.
5540 This matches strings according to the IRC protocol's case convention.
5542 See also `erc-downcase'."
5543 (string= (erc-downcase nick1)
5544 (erc-downcase nick2)))
5546 ;; default target handling
5548 (defun erc-default-target ()
5549 "Return the current default target (as a character string) or nil if none."
5550 (let ((tgt (car erc-default-recipients)))
5551 (cond
5552 ((not tgt) nil)
5553 ((listp tgt) (cdr tgt))
5554 (t tgt))))
5556 (defun erc-add-default-channel (channel)
5557 "Add CHANNEL to the default channel list."
5558 (let ((chl (downcase channel)))
5559 (setq erc-default-recipients
5560 (cons chl erc-default-recipients))))
5562 (defun erc-delete-default-channel (channel &optional buffer)
5563 "Delete CHANNEL from the default channel list."
5564 (with-current-buffer (if (and buffer
5565 (bufferp buffer))
5566 buffer
5567 (current-buffer))
5568 (setq erc-default-recipients (delete (downcase channel)
5569 erc-default-recipients))))
5571 (defun erc-add-query (nickname)
5572 "Add QUERY'd NICKNAME to the default channel list.
5574 The previous default target of QUERY type gets removed."
5575 (let ((d1 (car erc-default-recipients))
5576 (d2 (cdr erc-default-recipients))
5577 (qt (cons 'QUERY (downcase nickname))))
5578 (setq erc-default-recipients (cons qt (if (and (listp d1)
5579 (eq (car d1) 'QUERY))
5580 d2
5581 erc-default-recipients)))))
5583 (defun erc-delete-query ()
5584 "Delete the topmost target if it is a QUERY."
5586 (let ((d1 (car erc-default-recipients))
5587 (d2 (cdr erc-default-recipients)))
5588 (if (and (listp d1)
5589 (eq (car d1) 'QUERY))
5590 (setq erc-default-recipients d2)
5591 (error "Current target is not a QUERY"))))
5593 (defun erc-ignored-user-p (spec)
5594 "Return non-nil if SPEC matches something in `erc-ignore-list'.
5597 matches against all the regexp's in `erc-ignore-list'. If any
5598 match, returns that regexp."
5599 (catch 'found
5600 (dolist (ignored (erc-with-server-buffer erc-ignore-list))
5601 (if (string-match ignored spec)
5602 (throw 'found ignored)))))
5604 (defun erc-ignored-reply-p (msg tgt proc)
5605 ;; FIXME: this docstring needs fixing -- Lawrence 2004-01-08
5606 "Return non-nil if MSG matches something in `erc-ignore-reply-list'.
5608 Takes a message MSG to a channel and returns non-nil if the addressed
5609 user matches any regexp in `erc-ignore-reply-list'."
5610 (let ((target-nick (erc-message-target msg)))
5611 (if (not target-nick)
5612 nil
5613 (erc-with-buffer (tgt proc)
5614 (let ((user (erc-get-server-user target-nick)))
5615 (when user
5616 (erc-list-match erc-ignore-reply-list
5617 (erc-user-spec user))))))))
5619 (defun erc-message-target (msg)
5620 "Return the addressed target in MSG.
5622 The addressed target is the string before the first colon in MSG."
5624 (match-string 1 msg)
5625 nil))
5627 (defun erc-user-spec (user)
5628 "Create a nick!user@host spec from a user struct."
5629 (let ((nick (erc-server-user-nickname user))
5630 (host (erc-server-user-host user))
5631 (login (erc-server-user-login user)))
5632 (concat (or nick "")
5633 "!"
5634 (or login "")
5635 "@"
5636 (or host ""))))
5638 (defun erc-list-match (lst str)
5639 "Return non-nil if any regexp in LST matches STR."
5640 (memq nil (mapcar (lambda (regexp)
5641 (not (string-match regexp str)))
5642 lst)))
5644 ;; other "toggles"
5646 (defun erc-toggle-ctcp-autoresponse (&optional arg)
5647 "Toggle automatic CTCP replies (like VERSION and PING).
5649 If ARG is positive, turns CTCP replies on.
5651 If ARG is non-nil and not positive, turns CTCP replies off."
5652 (interactive "P")
5653 (cond ((and (numberp arg) (> arg 0))
5654 (setq erc-disable-ctcp-replies t))
5655 (arg (setq erc-disable-ctcp-replies nil))
5656 (t (setq erc-disable-ctcp-replies (not erc-disable-ctcp-replies))))
5657 (message "ERC CTCP replies are %s" (if erc-disable-ctcp-replies "OFF" "ON")))
5659 (defun erc-toggle-flood-control (&optional arg)
5660 "Toggle use of flood control on sent messages.
5662 If ARG is positive, use flood control.
5663 If ARG is non-nil and not positive, do not use flood control.
5665 See `erc-server-flood-margin' for an explanation of the available
5666 flood control parameters."
5667 (interactive "P")
5668 (cond ((and (numberp arg) (> arg 0))
5669 (setq erc-flood-protect t))
5670 (arg (setq erc-flood-protect nil))
5671 (t (setq erc-flood-protect (not erc-flood-protect))))
5672 (message "ERC flood control is %s"
5673 (cond (erc-flood-protect "ON")
5674 (t "OFF"))))
5676 ;; Some useful channel and nick commands for fast key bindings
5678 (defun erc-invite-only-mode (&optional arg)
5679 "Turn on the invite only mode (+i) for the current channel.
5681 If ARG is non-nil, turn this mode off (-i).
5683 This command is sent even if excess flood is detected."
5684 (interactive "P")
5685 (erc-set-active-buffer (current-buffer))
5686 (let ((tgt (erc-default-target)))
5687 (if (or (not tgt) (not (erc-channel-p tgt)))
5688 (erc-display-message nil 'error (current-buffer) 'no-target)
5689 (erc-load-irc-script-lines
5690 (list (concat "/mode " tgt (if arg " -i" " +i")))
5691 t))))
5693 (defun erc-get-channel-mode-from-keypress (key)
5694 "Read a key sequence and call the corresponding channel mode function.
5695 After doing C-c C-o, type in a channel mode letter.
5697 C-g means quit.
5698 RET lets you type more than one mode at a time.
5701 Anything else will be sent to `erc-toggle-channel-mode'."
5702 (interactive "kChannel mode (RET to set more than one): ")
5703 (when (featurep 'xemacs)
5704 (setq key (char-to-string (event-to-character (aref key 0)))))
5705 (cond ((equal key "\C-g")
5706 (keyboard-quit))
5707 ((equal key "\C-m")
5708 (erc-insert-mode-command))
5709 ((equal key "l")
5710 (call-interactively 'erc-set-channel-limit))
5711 ((equal key "k")
5712 (call-interactively 'erc-set-channel-key))
5713 (t (erc-toggle-channel-mode key))))
5715 (defun erc-toggle-channel-mode (mode &optional channel)
5716 "Toggle channel MODE.
5718 If CHANNEL is non-nil, toggle MODE for that channel, otherwise use
5719 `erc-default-target'."
5720 (interactive "P")
5721 (erc-set-active-buffer (current-buffer))
5722 (let ((tgt (or channel (erc-default-target))))
5723 (if (or (null tgt) (null (erc-channel-p tgt)))
5724 (erc-display-message nil 'error 'active 'no-target)
5725 (let* ((active (member mode erc-channel-modes))
5726 (newstate (if active "OFF" "ON")))
5727 (erc-log (format "%s: Toggle mode %s %s" tgt mode newstate))
5728 (message "Toggle channel mode %s %s" mode newstate)
5729 (erc-server-send (format "MODE %s %s%s"
5730 tgt (if active "-" "+") mode))))))
5732 (defun erc-insert-mode-command ()
5734 (interactive)
5735 (let ((tgt (erc-default-target)))
5736 (if tgt (insert (concat "/mode " tgt " "))
5737 (erc-display-message nil 'error (current-buffer) 'no-target))))
5739 (defun erc-channel-names ()
5741 (interactive)
5742 (erc-set-active-buffer (current-buffer))
5743 (let ((tgt (erc-default-target)))
5744 (if tgt (erc-load-irc-script-lines (list (concat "/names " tgt)))
5745 (erc-display-message nil 'error (current-buffer) 'no-target))))
5747 (defun erc-remove-text-properties-region (start end &optional object)
5748 "Clears the region (START,END) in OBJECT from all colors, etc."
5749 (interactive "r")
5750 (save-excursion
5751 (let ((inhibit-read-only t))
5752 (set-text-properties start end nil object))))
5753 (put 'erc-remove-text-properties-region 'disabled t)
5755 ;; script execution and startup
5757 (defun erc-find-file (file &optional path)
5758 "Search for a FILE in the filesystem.
5759 First the `default-directory' is searched for FILE, then any directories
5760 specified in the list PATH.
5762 If FILE is found, return the path to it."
5763 (let ((filepath file))
5764 (if (file-readable-p filepath) filepath
5765 (while (and path
5766 (progn (setq filepath (expand-file-name file (car path)))
5767 (not (file-readable-p filepath))))
5768 (setq path (cdr path)))
5769 (if path filepath nil))))
5771 (defun erc-select-startup-file ()
5772 "Select an ERC startup file.
5773 See also `erc-startup-file-list'."
5774 (catch 'found
5775 (dolist (f erc-startup-file-list)
5776 (setq f (convert-standard-filename f))
5777 (when (file-readable-p f)
5778 (throw 'found f)))))
5780 (defun erc-find-script-file (file)
5781 "Search for FILE in `default-directory', and any in `erc-script-path'."
5782 (erc-find-file file erc-script-path))
5784 (defun erc-load-script (file)
5785 "Load a script from FILE.
5787 FILE must be the full name, it is not searched in the
5788 `erc-script-path'. If the filename ends with `.el', then load it
5789 as an Emacs Lisp program. Otherwise, treat it as a regular IRC
5790 script."
5791 (erc-log (concat "erc-load-script: " file))
5792 (cond
5794 (load file))
5795 (t
5796 (erc-load-irc-script file))))
5798 (defun erc-process-script-line (line &optional args)
5799 "Process an IRC script LINE.
5801 Does script-specific substitutions (script arguments, current nick,
5802 server, etc.) in LINE and returns it.
5804 Substitutions are: %C and %c = current target (channel or nick),
5805 %S %s = current server, %N %n = my current nick, and %x is x verbatim,
5806 where x is any other character;
5807 $* = the entire argument string, $1 = the first argument, $2 = the second,
5808 and so on."
5809 (if (not args) (setq args ""))
5813 (tgt (erc-default-target))
5814 (server (and (boundp 'erc-session-server) erc-session-server))
5815 (nick (erc-current-nick))
5816 (res "")
5817 (tmp nil)
5818 (arg-list nil)
5819 (arg-num 0))
5820 (if (not tgt) (setq tgt ""))
5821 (if (not server) (setq server ""))
5822 (if (not nick) (setq nick ""))
5823 ;; First, compute the argument list
5824 (setq tmp args)
5826 (setq arg-list (cons (match-string 1 tmp) arg-list))
5827 (setq tmp (match-string 2 tmp)))
5828 (setq arg-list (nreverse arg-list))
5829 (setq arg-num (length arg-list))
5830 ;; now do the substitution
5831 (setq tmp (string-match esc-regexp line))
5832 (while tmp
5833 ;;(message "beginning of while: tmp=%S" tmp)
5834 (let* ((hd (substring line 0 tmp))
5835 (esc "")
5836 (subst "")
5837 (tail (substring line tmp)))
5838 (cond ((string-match (concat "^" arg-esc-regexp) tail)
5839 (setq esc (match-string 1 tail))
5840 (setq tail (substring tail (match-end 1))))
5841 ((string-match (concat "^" percent-regexp) tail)
5842 (setq esc (match-string 1 tail))
5843 (setq tail (substring tail (match-end 1)))))
5844 ;;(message "hd=%S, esc=%S, tail=%S, arg-num=%S" hd esc tail arg-num)
5845 (setq res (concat res hd))
5846 (setq subst
5847 (cond ((string= esc "") "")
5850 (let ((n (string-to-number (match-string 1 esc))))
5851 (message "n = %S, integerp(n)=%S" n (integerp n))
5852 (if (<= n arg-num) (nth (1- n) arg-list) "")))
5853 ((string-match "^%[Cc]$" esc) tgt)
5854 ((string-match "^%[Ss]$" esc) server)
5855 ((string-match "^%[Nn]$" esc) nick)
5858 (message "BUG IN ERC: esc=%S" esc)
5859 "")))
5860 (setq line tail)
5861 (setq tmp (string-match esc-regexp line))
5862 (setq res (concat res subst))
5863 ;;(message "end of while: line=%S, res=%S, tmp=%S" line res tmp)
5864 ))
5865 (setq res (concat res line))
5866 res))
5868 (defun erc-load-irc-script (file &optional force)
5869 "Load an IRC script from FILE."
5870 (erc-log (concat "erc-load-script: " file))
5871 (let ((str (with-temp-buffer
5872 (insert-file-contents file)
5873 (buffer-string))))
5874 (erc-load-irc-script-lines (erc-split-multiline-safe str) force)))
5876 (defun erc-load-irc-script-lines (lines &optional force noexpand)
5877 "Load IRC script LINES (a list of strings).
5879 If optional NOEXPAND is non-nil, do not expand script-specific
5880 sequences, process the lines verbatim. Use this for multiline
5881 user input."
5882 (let* ((cb (current-buffer))
5883 (s "")
5884 (sp (or (erc-command-indicator) (erc-prompt)))
5885 (args (and (boundp 'erc-script-args) erc-script-args)))
5886 (if (and args (string-match "^ " args))
5887 (setq args (substring args 1)))
5888 ;; prepare the prompt string for echo
5889 (erc-put-text-property 0 (length sp)
5890 'font-lock-face 'erc-command-indicator-face sp)
5891 (while lines
5892 (setq s (car lines))
5893 (erc-log (concat "erc-load-script: CMD: " s))
5895 (let ((line (if noexpand s (erc-process-script-line s args))))
5896 (if (and (erc-process-input-line line force)
5897 erc-script-echo)
5898 (progn
5899 (erc-put-text-property 0 (length line)
5900 'font-lock-face 'erc-input-face line)
5901 (erc-display-line (concat sp line) cb)))))
5902 (setq lines (cdr lines)))))
5904 ;; authentication
5906 (defun erc-login ()
5907 "Perform user authentication at the IRC server."
5908 (erc-log (format "login: nick: %s, user: %s %s %s :%s"
5909 (erc-current-nick)
5910 (user-login-name)
5911 (or erc-system-name (system-name))
5912 erc-session-server
5913 erc-session-user-full-name))
5914 (if erc-session-password
5915 (erc-server-send (format "PASS %s" erc-session-password))
5916 (message "Logging in without password"))
5917 (erc-server-send (format "NICK %s" (erc-current-nick)))
5918 (erc-server-send
5919 (format "USER %s %s %s :%s"
5920 ;; hacked - S.B.
5921 (if erc-anonymous-login erc-email-userid (user-login-name))
5922 "0" "*"
5923 erc-session-user-full-name))
5924 (erc-update-mode-line))
5926 ;; connection properties' heuristics
5928 (defun erc-determine-parameters (&optional server port nick name)
5929 "Determine the connection and authentication parameters.
5930 Sets the buffer local variables:
5932 - `erc-session-connector'
5933 - `erc-session-server'
5934 - `erc-session-port'
5935 - `erc-session-full-name'
5936 - `erc-server-current-nick'"
5937 (setq erc-session-connector erc-server-connect-function
5938 erc-session-server (erc-compute-server server)
5939 erc-session-port (or port erc-default-port)
5940 erc-session-user-full-name (erc-compute-full-name name))
5941 (erc-set-current-nick (erc-compute-nick nick)))
5943 (defun erc-compute-server (&optional server)
5944 "Return an IRC server name.
5946 This tries a number of increasingly more default methods until a
5947 non-nil value is found.
5949 - SERVER (the argument passed to this function)
5950 - The `erc-server' option
5951 - The value of the IRCSERVER environment variable
5952 - The `erc-default-server' variable"
5953 (or server
5954 erc-server
5955 (getenv "IRCSERVER")
5956 erc-default-server))
5958 (defun erc-compute-nick (&optional nick)
5959 "Return user's IRC nick.
5961 This tries a number of increasingly more default methods until a
5962 non-nil value is found.
5964 - NICK (the argument passed to this function)
5965 - The `erc-nick' option
5966 - The value of the IRCNICK environment variable
5967 - The result from the `user-login-name' function"
5968 (or nick
5969 (if (consp erc-nick) (car erc-nick) erc-nick)
5970 (getenv "IRCNICK")
5971 (user-login-name)))
5974 (defun erc-compute-full-name (&optional full-name)
5975 "Return user's full name.
5977 This tries a number of increasingly more default methods until a
5978 non-nil value is found.
5980 - FULL-NAME (the argument passed to this function)
5981 - The `erc-user-full-name' option
5982 - The value of the IRCNAME environment variable
5983 - The result from the `user-full-name' function"
5984 (or full-name
5985 erc-user-full-name
5986 (getenv "IRCNAME")
5987 (if erc-anonymous-login "unknown" nil)
5988 (user-full-name)))
5990 (defun erc-compute-port (&optional port)
5991 "Return a port for an IRC server.
5993 This tries a number of increasingly more default methods until a
5994 non-nil value is found.
5996 - PORT (the argument passed to this function)
5997 - The `erc-port' option
5998 - The `erc-default-port' variable"
5999 (or port erc-port erc-default-port))
6001 ;; time routines
6003 (defun erc-string-to-emacs-time (string)
6004 "Convert the long number represented by STRING into an Emacs format.
6005 Returns a list of the form (HIGH LOW), compatible with Emacs time format."
6006 (let* ((n (string-to-number (concat string ".0"))))
6007 (list (truncate (/ n 65536))
6008 (truncate (mod n 65536)))))
6010 (defalias 'erc-emacs-time-to-erc-time 'float-time)
6011 (defalias 'erc-current-time 'float-time)
6013 (defun erc-time-diff (t1 t2)
6014 "Return the time difference in seconds between T1 and T2."
6015 (abs (- t2 t1)))
6017 (defun erc-time-gt (t1 t2)
6018 "Check whether T1 > T2."
6019 (> t1 t2))
6021 (defun erc-sec-to-time (ns)
6022 "Convert NS to a time string HH:MM.SS."
6023 (setq ns (truncate ns))
6024 (format "%02d:%02d.%02d"
6025 (/ ns 3600)
6026 (/ (% ns 3600) 60)
6027 (% ns 60)))
6029 (defun erc-seconds-to-string (seconds)
6030 "Convert a number of SECONDS into an English phrase."
6031 (let (days hours minutes format-args output)
6032 (setq days (/ seconds 86400)
6033 seconds (% seconds 86400)
6034 hours (/ seconds 3600)
6035 seconds (% seconds 3600)
6036 minutes (/ seconds 60)
6037 seconds (% seconds 60)
6038 format-args (if (> days 0)
6039 `("%d days, %d hours, %d minutes, %d seconds"
6040 ,days ,hours ,minutes ,seconds)
6041 (if (> hours 0)
6042 `("%d hours, %d minutes, %d seconds"
6043 ,hours ,minutes ,seconds)
6044 (if (> minutes 0)
6045 `("%d minutes, %d seconds" ,minutes ,seconds)
6046 `("%d seconds" ,seconds))))
6047 output (apply #'format format-args))
6048 ;; Change all "1 units" to "1 unit".
6050 (setq output (erc-replace-match-subexpression-in-string
6051 "" output (match-string 2 output) 2 (match-beginning 2))))
6052 output))
6055 ;; info
6057 (defconst erc-clientinfo-alist
6058 '(("ACTION" . "is used to inform about one's current activity")
6059 ("CLIENTINFO" . "gives help on CTCP commands supported by client")
6060 ("ECHO" . "echoes its arguments back")
6061 ("FINGER" . "shows user's name, location, and idle time")
6062 ("PING" . "measures delay between peers")
6063 ("TIME" . "shows client-side time")
6064 ("USERINFO" . "shows information provided by a user")
6065 ("VERSION" . "shows client type and version"))
6066 "Alist of CTCP CLIENTINFO for ERC commands.")
6068 (defun erc-client-info (s)
6069 "Return CTCP CLIENTINFO on command S.
6070 If S is nil or an empty string then return general CLIENTINFO."
6071 (if (or (not s) (string= s ""))
6072 (concat
6073 (apply #'concat
6074 (mapcar (lambda (e)
6075 (concat (car e) " "))
6076 erc-clientinfo-alist))
6077 ": use CLIENTINFO <COMMAND> to get more specific information")
6078 (let ((h (assoc (upcase s) erc-clientinfo-alist)))
6079 (if h
6080 (concat s " " (cdr h))
6081 (concat s ": unknown command")))))
6083 ;; Hook functions
6085 (defun erc-directory-writable-p (dir)
6086 "Determine whether DIR is a writable directory.
6087 If it doesn't exist, create it."
6088 (unless (file-attributes dir) (make-directory dir))
6089 (or (file-accessible-directory-p dir) (error "Cannot access %s" dir)))
6091 (defun erc-kill-query-buffers (process)
6092 "Kill all buffers of PROCESS.
6093 Does nothing if PROCESS is not a process object."
6094 ;; here, we only want to match the channel buffers, to avoid
6095 ;; "selecting killed buffers" b0rkage.
6096 (when (processp process)
6097 (erc-with-all-buffers-of-server process
6098 (lambda ()
6099 (not (erc-server-buffer-p)))
6100 (kill-buffer (current-buffer)))))
6102 (defun erc-nick-at-point ()
6103 "Give information about the nickname at `point'.
6105 If called interactively, give a human readable message in the
6106 minibuffer. If called programmatically, return the corresponding
6107 entry of `channel-members'."
6108 (interactive)
6109 (require 'thingatpt)
6110 (let* ((word (word-at-point))
6111 (channel-data (erc-get-channel-user word))
6112 (cuser (cdr channel-data))
6113 (user (if channel-data
6114 (car channel-data)
6115 (erc-get-server-user word)))
6116 host login full-name nick voice halfop op admin owner)
6117 (when user
6118 (setq nick (erc-server-user-nickname user)
6119 host (erc-server-user-host user)
6120 login (erc-server-user-login user)
6121 full-name (erc-server-user-full-name user))
6122 (if cuser
6123 (setq voice (erc-channel-user-voice cuser)
6124 halfop (erc-channel-user-halfop cuser)
6125 op (erc-channel-user-op cuser)
6126 admin (erc-channel-user-admin cuser)
6127 owner (erc-channel-user-owner cuser))))
6128 (if (called-interactively-p 'interactive)
6129 (message "%s is %s@%s%s%s"
6130 nick login host
6131 (if full-name (format " (%s)" full-name) "")
6132 (if (or voice halfop op admin owner)
6133 (format " and is +%s%s%s%s%s on %s"
6134 (if voice "v" "")
6135 (if halfop "h" "")
6136 (if op "o" "")
6137 (if admin "a" "")
6138 (if owner "q" "")
6139 (erc-default-target))
6140 ""))
6141 user)))
6143 (defun erc-away-time ()
6144 "Return non-nil if the current ERC process is set away.
6146 In particular, the time that we were set away is returned.
6147 See `current-time' for details on the time format."
6148 (erc-with-server-buffer erc-away))
6150 ;; Mode line handling
6152 (defcustom erc-mode-line-format "%S %a"
6153 "A string to be formatted and shown in the mode-line in `erc-mode'.
6155 The string is formatted using `format-spec' and the result is set as the value
6156 of `mode-line-buffer-identification'.
6158 The following characters are replaced:
6160 %l: The estimated lag time to the server
6161 %m: The modes of the channel
6162 %n: The current nick name
6163 %N: The name of the network
6164 %o: The topic of the channel
6165 %p: The session port
6166 %t: The name of the target (channel, nickname, or servername:port)
6167 %s: In the server-buffer, this gets filled with the value of
6168 `erc-server-announced-name', in a channel, the value of
6169 (erc-default-target) also get concatenated.
6170 %S: In the server-buffer, this gets filled with the value of
6171 `erc-network', in a channel, the value of (erc-default-target)
6172 also get concatenated."
6173 :group 'erc-mode-line-and-header
6174 :type 'string)
6176 (defcustom erc-header-line-format "%n on %t (%m,%l) %o"
6177 "A string to be formatted and shown in the header-line in `erc-mode'.
6178 Only used starting in Emacs 21.
6180 Set this to nil if you do not want the header line to be
6181 displayed.
6183 See `erc-mode-line-format' for which characters are can be used."
6184 :group 'erc-mode-line-and-header
6185 :set (lambda (sym val)
6186 (set sym val)
6187 (when (fboundp 'erc-update-mode-line)
6188 (erc-update-mode-line nil)))
6189 :type '(choice (const :tag "Disabled" nil)
6190 string))
6192 (defcustom erc-header-line-uses-tabbar-p nil
6193 "Use tabbar mode instead of the header line to display the header."
6194 :group 'erc-mode-line-and-header
6195 :type 'boolean)
6197 (defcustom erc-header-line-uses-help-echo-p t
6198 "Show the contents of the header line in the echo area or as a tooltip
6199 when you move point into the header line."
6200 :group 'erc-mode-line-and-header
6201 :type 'boolean)
6203 (defcustom erc-header-line-face-method nil
6204 "Determine what method to use when colorizing the header line text.
6206 If nil, don't colorize the header text.
6207 If given a function, call it and use the resulting face name.
6208 Otherwise, use the `erc-header-line' face."
6209 :group 'erc-mode-line-and-header
6210 :type '(choice (const :tag "Don't colorize" nil)
6211 (const :tag "Use the erc-header-line face" t)
6212 (function :tag "Call a function")))
6214 (defcustom erc-show-channel-key-p t
6215 "Show the channel key in the header line."
6216 :group 'erc-paranoia
6217 :type 'boolean)
6219 (defcustom erc-mode-line-away-status-format
6220 "(AWAY since %a %b %d %H:%M) "
6221 "When you're away on a server, this is shown in the mode line.
6222 This should be a string with substitution variables recognized by
6223 `format-time-string'."
6224 :group 'erc-mode-line-and-header
6225 :type 'string)
6227 (defun erc-shorten-server-name (server-name)
6228 "Shorten SERVER-NAME according to `erc-common-server-suffixes'."
6229 (if (stringp server-name)
6230 (with-temp-buffer
6231 (insert server-name)
6232 (let ((alist erc-common-server-suffixes))
6233 (while alist
6234 (goto-char (point-min))
6235 (if (re-search-forward (caar alist) nil t)
6236 (replace-match (cdar alist)))
6237 (setq alist (cdr alist))))
6238 (buffer-string))))
6240 (defun erc-format-target ()
6241 "Return the name of the target (channel or nickname or servername:port)."
6242 (let ((target (erc-default-target)))
6243 (or target
6244 (concat (erc-shorten-server-name
6245 (or erc-server-announced-name
6246 erc-session-server))
6247 ":" (erc-port-to-string erc-session-port)))))
6249 (defun erc-format-target-and/or-server ()
6250 "Return the server name or the current target and server name combined."
6251 (let ((server-name (erc-shorten-server-name
6252 (or erc-server-announced-name
6253 erc-session-server))))
6254 (cond ((erc-default-target)
6255 (concat (erc-string-no-properties (erc-default-target))
6256 "@" server-name))
6257 (server-name server-name)
6258 (t (buffer-name (current-buffer))))))
6260 (defun erc-format-network ()
6261 "Return the name of the network we are currently on."
6262 (let ((network (and (fboundp 'erc-network-name) (erc-network-name))))
6263 (if (and network (symbolp network))
6264 (symbol-name network)
6265 "")))
6267 (defun erc-format-target-and/or-network ()
6268 "Return the network or the current target and network combined.
6269 If the name of the network is not available, then use the
6270 shortened server name instead."
6271 (let ((network-name (or (and (fboundp 'erc-network-name) (erc-network-name))
6272 (erc-shorten-server-name
6273 (or erc-server-announced-name
6274 erc-session-server)))))
6275 (when (and network-name (symbolp network-name))
6276 (setq network-name (symbol-name network-name)))
6277 (cond ((erc-default-target)
6278 (concat (erc-string-no-properties (erc-default-target))
6279 "@" network-name))
6280 ((and network-name
6281 (not (get-buffer network-name)))
6282 (when erc-rename-buffers
6283 (rename-buffer network-name))
6284 network-name)
6285 (t (buffer-name (current-buffer))))))
6287 (defun erc-format-away-status ()
6288 "Return a formatted `erc-mode-line-away-status-format'
6289 if `erc-away' is non-nil."
6290 (let ((a (erc-away-time)))
6291 (if a
6292 (format-time-string erc-mode-line-away-status-format a)
6293 "")))
6295 (defun erc-format-channel-modes ()
6296 "Return the current channel's modes."
6297 (concat (apply #'concat
6298 "+" erc-channel-modes)
6299 (cond ((and erc-channel-user-limit erc-channel-key)
6300 (if erc-show-channel-key-p
6301 (format "lk %.0f %s" erc-channel-user-limit
6302 erc-channel-key)
6303 (format "kl %.0f" erc-channel-user-limit)))
6304 (erc-channel-user-limit
6305 ;; Emacs has no bignums
6306 (format "l %.0f" erc-channel-user-limit))
6307 (erc-channel-key
6308 (if erc-show-channel-key-p
6309 (format "k %s" erc-channel-key)
6310 "k"))
6311 (t nil))))
6313 (defun erc-format-lag-time ()
6314 "Return the estimated lag time to server, `erc-server-lag'."
6315 (let ((lag (erc-with-server-buffer erc-server-lag)))
6316 (cond (lag (format "lag:%.0f" lag))
6317 (t ""))))
6319 ;; erc-goodies is required at end of this file.
6320 (declare-function erc-controls-strip "erc-goodies" (str))
6322 (defvar tabbar--local-hlf)
6324 (defun erc-update-mode-line-buffer (buffer)
6325 "Update the mode line in a single ERC buffer BUFFER."
6326 (with-current-buffer buffer
6327 (let ((spec (format-spec-make
6328 ?a (erc-format-away-status)
6329 ?l (erc-format-lag-time)
6330 ?m (erc-format-channel-modes)
6331 ?n (or (erc-current-nick) "")
6332 ?N (erc-format-network)
6333 ?o (or (erc-controls-strip erc-channel-topic) "")
6334 ?p (erc-port-to-string erc-session-port)
6335 ?s (erc-format-target-and/or-server)
6336 ?S (erc-format-target-and/or-network)
6337 ?t (erc-format-target)))
6338 (process-status (cond ((and (erc-server-process-alive)
6339 (not erc-server-connected))
6340 ":connecting")
6341 ((erc-server-process-alive)
6342 "")
6343 (t
6344 ": CLOSED")))
6345 (face (cond ((eq erc-header-line-face-method nil)
6346 nil)
6347 ((functionp erc-header-line-face-method)
6348 (funcall erc-header-line-face-method))
6349 (t
6350 'erc-header-line))))
6351 (cond ((featurep 'xemacs)
6352 (setq modeline-buffer-identification
6353 (list (format-spec erc-mode-line-format spec)))
6354 (setq modeline-process (list process-status)))
6355 (t
6356 (setq mode-line-buffer-identification
6357 (list (format-spec erc-mode-line-format spec)))
6358 (setq mode-line-process (list process-status))))
6359 (when (boundp 'header-line-format)
6360 (let ((header (if erc-header-line-format
6361 (format-spec erc-header-line-format spec)
6362 nil)))
6363 (cond (erc-header-line-uses-tabbar-p
6364 (set (make-local-variable 'tabbar--local-hlf)
6365 header-line-format)
6366 (kill-local-variable 'header-line-format))
6367 ((null header)
6368 (setq header-line-format nil))
6369 (erc-header-line-uses-help-echo-p
6370 (let ((help-echo (with-temp-buffer
6371 (insert header)
6372 (fill-region (point-min) (point-max))
6373 (buffer-string))))
6374 (setq header-line-format
6375 (erc-replace-regexp-in-string
6376 "%"
6377 "%%"
6378 (if face
6379 (erc-propertize header 'help-echo help-echo
6380 'face face)
6381 (erc-propertize header 'help-echo help-echo))))))
6382 (t (setq header-line-format
6383 (if face
6384 (erc-propertize header 'face face)
6385 header)))))))
6386 (if (featurep 'xemacs)
6387 (redraw-modeline)
6388 (force-mode-line-update))))
6390 (defun erc-update-mode-line (&optional buffer)
6391 "Update the mode line in BUFFER.
6393 If BUFFER is nil, update the mode line in all ERC buffers."
6394 (if (and buffer (bufferp buffer))
6395 (erc-update-mode-line-buffer buffer)
6396 (dolist (buf (erc-buffer-list))
6397 (when (buffer-live-p buf)
6398 (erc-update-mode-line-buffer buf)))))
6400 ;; Miscellaneous
6402 (defun erc-port-to-string (p)
6403 "Convert port P to a string.
6404 P may be an integer or a service name."
6405 (if (integerp p)
6406 (int-to-string p)
6407 p))
6409 (defun erc-string-to-port (s)
6410 "Convert string S to either an integer port number or a service name."
6411 (if (numberp s)
6412 s
6413 (let ((n (string-to-number s)))
6414 (if (= n 0)
6415 s
6416 n))))
6418 (defun erc-version (&optional here)
6419 "Show the version number of ERC in the minibuffer.
6420 If optional argument HERE is non-nil, insert version number at point."
6421 (interactive "P")
6422 (let ((version-string
6423 (format "ERC (IRC client for Emacs %s)" emacs-version)))
6424 (if here
6425 (insert version-string)
6426 (if (called-interactively-p 'interactive)
6427 (message "%s" version-string)
6428 version-string))))
6430 (defun erc-modes (&optional here)
6431 "Show the active ERC modes in the minibuffer.
6432 If optional argument HERE is non-nil, insert version number at point."
6433 (interactive "P")
6434 (let ((string
6435 (mapconcat 'identity
6436 (let (modes (case-fold-search nil))
6437 (dolist (var (apropos-internal "^erc-.*mode$"))
6438 (when (and (boundp var)
6439 (symbol-value var))
6440 (setq modes (cons (symbol-name var)
6441 modes))))
6442 modes)
6443 ", ")))
6444 (if here
6445 (insert string)
6446 (if (called-interactively-p 'interactive)
6447 (message "%s" string)
6448 string))))
6450 (defun erc-trim-string (s)
6451 "Trim leading and trailing spaces off S."
6452 (cond
6453 ((not (stringp s)) nil)
6455 "")
6457 (match-string 1 s))
6458 (t
6459 s)))
6461 (defun erc-arrange-session-in-multiple-windows ()
6462 "Open a window for every non-server buffer related to `erc-session-server'.
6464 All windows are opened in the current frame."
6465 (interactive)
6466 (unless erc-server-process
6467 (error "No erc-server-process found in current buffer"))
6468 (let ((bufs (erc-buffer-list nil erc-server-process)))
6469 (when bufs
6470 (delete-other-windows)
6471 (switch-to-buffer (car bufs))
6472 (setq bufs (cdr bufs))
6473 (while bufs
6474 (split-window)
6475 (other-window 1)
6476 (switch-to-buffer (car bufs))
6477 (setq bufs (cdr bufs))
6478 (balance-windows)))))
6480 (defun erc-popup-input-buffer ()
6481 "Provide an input buffer."
6482 (interactive)
6483 (let ((buffer-name (generate-new-buffer-name "*ERC input*"))
6484 (mode (intern
6485 (completing-read
6486 "Mode: "
6487 (mapcar (lambda (e)
6488 (list (symbol-name e)))
6490 nil t))))
6491 (pop-to-buffer (make-indirect-buffer (current-buffer) buffer-name))
6492 (funcall mode)
6493 (narrow-to-region (point) (point))
6494 (shrink-window-if-larger-than-buffer)))
6496 ;;; Message catalog
6498 (defun erc-make-message-variable-name (catalog entry)
6499 "Create a variable name corresponding to CATALOG's ENTRY."
6500 (intern (concat "erc-message-"
6501 (symbol-name catalog) "-" (symbol-name entry))))
6503 (defun erc-define-catalog-entry (catalog entry format-spec)
6504 "Set CATALOG's ENTRY to FORMAT-SPEC."
6505 (set (erc-make-message-variable-name catalog entry)
6506 format-spec))
6508 (defun erc-define-catalog (catalog entries)
6509 "Define a CATALOG according to ENTRIES."
6510 (dolist (entry entries)
6511 (erc-define-catalog-entry catalog (car entry) (cdr entry))))
6513 (erc-define-catalog
6514 'english
6515 '((bad-ping-response . "Unexpected PING response from %n (time %t)")
6518 (cannot-find-file . "Cannot find file %f")
6519 (cannot-read-file . "Cannot read file %f")
6520 (connect . "Connecting to %S:%p... ")
6521 (country . "%c")
6522 (country-unknown . "%d: No such domain")
6523 (ctcp-empty . "Illegal empty CTCP query received from %n. Ignoring.")
6524 (ctcp-request . "==> CTCP request from %n (%u@%h): %r")
6525 (ctcp-request-to . "==> CTCP request from %n (%u@%h) to %t: %r")
6526 (ctcp-too-many . "Too many CTCP queries in single message. Ignoring")
6527 (flood-ctcp-off . "FLOOD PROTECTION: Automatic CTCP responses turned off.")
6528 (flood-strict-mode
6529 . "FLOOD PROTECTION: Switched to Strict Flood Control mode.")
6531 (disconnected-noreconnect
6535 (login . "Logging in as `%n'...")
6536 (nick-in-use . "%n is in use. Choose new nickname: ")
6537 (nick-too-long
6538 . "WARNING: Nick length (%i) exceeds max NICKLEN(%l) defined by server")
6539 (no-default-channel . "No default channel")
6540 (no-invitation . "You've got no invitation")
6541 (no-target . "No target")
6542 (ops . "%i operator%s: %o")
6543 (ops-none . "No operators in this channel.")
6544 (undefined-ctcp . "Undefined CTCP query received. Silently ignored")
6545 (variable-not-bound . "Variable not bound!")
6546 (ACTION . "* %n %a")
6547 (CTCP-CLIENTINFO . "Client info for %n: %m")
6548 (CTCP-ECHO . "Echo %n: %m")
6549 (CTCP-FINGER . "Finger info for %n: %m")
6550 (CTCP-PING . "Ping time to %n is %t")
6551 (CTCP-TIME . "Time by %n is %m")
6552 (CTCP-UNKNOWN . "Unknown CTCP message from %n (%u@%h): %m")
6553 (CTCP-VERSION . "Version for %n is %m")
6555 (INVITE . "%n (%u@%h) invites you to channel %c")
6556 (JOIN . "%n (%u@%h) has joined channel %c")
6557 (JOIN-you . "You have joined channel %c")
6558 (KICK . "%n (%u@%h) has kicked %k off channel %c: %r")
6559 (KICK-you . "You have been kicked off channel %c by %n (%u@%h): %r")
6560 (KICK-by-you . "You have kicked %k off channel %c: %r")
6561 (MODE . "%n (%u@%h) has changed mode for %t to %m")
6562 (MODE-nick . "%n has changed mode for %t to %m")
6563 (NICK . "%n (%u@%h) is now known as %N")
6564 (NICK-you . "Your new nickname is %N")
6565 (PART . erc-message-english-PART)
6566 (PING . "PING from server (last: %s sec. ago)")
6567 (PONG . "PONG from %h (%i second%s)")
6568 (QUIT . "%n (%u@%h) has quit: %r")
6570 (WALLOPS . "Wallops from %n: %m")
6571 (s004 . "%s %v %U %C")
6572 (s221 . "User modes for %n: %m")
6573 (s252 . "%i operator(s) online")
6574 (s253 . "%i unknown connection(s)")
6575 (s254 . "%i channels formed")
6576 (s275 . "%n %m")
6577 (s301 . "%n is AWAY: %r")
6578 (s303 . "Is online: %n")
6579 (s305 . "%m")
6580 (s306 . "%m")
6581 (s307 . "%n %m")
6582 (s311 . "%n is %f (%u@%h)")
6583 (s312 . "%n is/was on server %s (%c)")
6584 (s313 . "%n is an IRC operator")
6585 (s314 . "%n was %f (%u@%h)")
6586 (s317 . "%n has been idle for %i")
6587 (s317-on-since . "%n has been idle for %i, on since %t")
6588 (s319 . "%n is on channel(s): %c")
6589 (s320 . "%n is an identified user")
6590 (s321 . "Channel Users Topic")
6591 (s322 . "%c [%u] %t")
6592 (s324 . "%c modes: %m")
6593 (s328 . "%c URL: %u")
6594 (s329 . "%c was created on %t")
6595 (s330 . "%n %a %i")
6596 (s331 . "No topic is set for %c")
6597 (s332 . "Topic for %c: %T")
6598 (s333 . "%c: topic set by %n, %t")
6599 (s341 . "Inviting %n to channel %c")
6600 (s352 . "%-11c %-10n %-4a %u@%h (%f)")
6601 (s353 . "Users on %c: %u")
6602 (s367 . "Ban for %b on %c")
6603 (s367-set-by . "Ban for %b on %c set by %s on %t")
6604 (s368 . "Banlist of %c ends.")
6605 (s379 . "%c: Forwarded to %f")
6606 (s391 . "The time at %s is %t")
6607 (s401 . "%n: No such nick/channel")
6608 (s403 . "%c: No such channel")
6609 (s404 . "%c: Cannot send to channel")
6610 (s405 . "%c: You have joined too many channels")
6611 (s406 . "%n: There was no such nickname")
6612 (s412 . "No text to send")
6613 (s421 . "%c: Unknown command")
6614 (s431 . "No nickname given")
6615 (s432 . "%n is an erroneous nickname")
6616 (s442 . "%c: You're not on that channel")
6617 (s445 . "SUMMON has been disabled")
6618 (s446 . "USERS has been disabled")
6619 (s451 . "You have not registered")
6620 (s461 . "%c: not enough parameters")
6621 (s462 . "Unauthorized command (already registered)")
6622 (s463 . "Your host isn't among the privileged")
6623 (s464 . "Password incorrect")
6624 (s465 . "You are banned from this server")
6625 (s474 . "You can't join %c because you're banned (+b)")
6626 (s475 . "You must specify the correct channel key (+k) to join %c")
6627 (s481 . "Permission Denied - You're not an IRC operator")
6628 (s482 . "You need to be a channel operator of %c to do that")
6629 (s483 . "You can't kill a server!")
6630 (s484 . "Your connection is restricted!")
6631 (s485 . "You're not the original channel operator")
6632 (s491 . "No O-lines for your host")
6633 (s501 . "Unknown MODE flag")
6634 (s502 . "You can't change modes for other users")
6635 (s671 . "%n %a")))
6637 (defun erc-message-english-PART (&rest args)
6638 "Format a proper PART message.
6640 This function is an example on what could be done with formatting
6641 functions."
6642 (let ((nick (cadr (memq ?n args)))
6643 (user (cadr (memq ?u args)))
6644 (host (cadr (memq ?h args)))
6645 (channel (cadr (memq ?c args)))
6646 (reason (cadr (memq ?r args))))
6647 (if (string= nick (erc-current-nick))
6648 (format "You have left channel %s" channel)
6649 (format "%s (%s@%s) has left channel %s%s"
6650 nick user host channel
6651 (if (not (string= reason ""))
6652 (format ": %s"
6653 (erc-replace-regexp-in-string "%" "%%" reason))
6654 "")))))
6657 (defvar erc-current-message-catalog 'english)
6658 (make-variable-buffer-local 'erc-current-message-catalog)
6660 (defun erc-retrieve-catalog-entry (entry &optional catalog)
6661 "Retrieve ENTRY from CATALOG.
6663 If CATALOG is nil, `erc-current-message-catalog' is used.
6665 If ENTRY is nil in CATALOG, it is retrieved from the fallback,
6666 english, catalog."
6667 (unless catalog (setq catalog erc-current-message-catalog))
6668 (let ((var (erc-make-message-variable-name catalog entry)))
6669 (if (boundp var)
6670 (symbol-value var)
6671 (when (boundp (erc-make-message-variable-name 'english entry))
6672 (symbol-value (erc-make-message-variable-name 'english entry))))))
6674 (defun erc-format-message (msg &rest args)
6675 "Format MSG according to ARGS.
6677 See also `format-spec'."
6678 (when (eq (logand (length args) 1) 1) ; oddp
6679 (error "Obscure usage of this function appeared"))
6680 (let ((entry (erc-retrieve-catalog-entry msg)))
6681 (when (not entry)
6682 (error "No format spec for message %s" msg))
6683 (when (functionp entry)
6684 (setq entry (apply entry args)))
6685 (format-spec entry (apply #'format-spec-make args))))
6687 ;;; Various hook functions
6689 (add-hook 'kill-buffer-hook 'erc-kill-buffer-function)
6691 (defcustom erc-kill-server-hook '(erc-kill-server)
6692 "Invoked whenever a server buffer is killed via `kill-buffer'."
6693 :group 'erc-hooks
6694 :type 'hook)
6696 (defcustom erc-kill-channel-hook '(erc-kill-channel)
6697 "Invoked whenever a channel-buffer is killed via `kill-buffer'."
6698 :group 'erc-hooks
6699 :type 'hook)
6701 (defcustom erc-kill-buffer-hook nil
6702 "Hook run whenever a non-server or channel buffer is killed.
6704 See also `kill-buffer'."
6705 :group 'erc-hooks
6706 :type 'hook)
6708 (defun erc-kill-buffer-function ()
6709 "Function to call when an ERC buffer is killed.
6710 This function should be on `kill-buffer-hook'.
6711 When the current buffer is in `erc-mode', this function will run
6712 one of the following hooks:
6713 `erc-kill-server-hook' if the server buffer was killed,
6714 `erc-kill-channel-hook' if a channel buffer was killed,
6715 or `erc-kill-buffer-hook' if any other buffer."
6716 (when (eq major-mode 'erc-mode)
6717 (erc-remove-channel-users)
6718 (cond
6719 ((eq (erc-server-buffer) (current-buffer))
6720 (run-hooks 'erc-kill-server-hook))
6721 ((erc-channel-p (or (erc-default-target) (buffer-name)))
6722 (run-hooks 'erc-kill-channel-hook))
6723 (t
6724 (run-hooks 'erc-kill-buffer-hook)))))
6726 (defun erc-kill-server ()
6727 "Sends a QUIT command to the server when the server buffer is killed.
6728 This function should be on `erc-kill-server-hook'."
6729 (when (erc-server-process-alive)
6730 (setq erc-server-quitting t)
6731 (erc-server-send (format "QUIT :%s" (funcall erc-quit-reason nil)))))
6733 (defun erc-kill-channel ()
6734 "Sends a PART command to the server when the channel buffer is killed.
6735 This function should be on `erc-kill-channel-hook'."
6736 (when (erc-server-process-alive)
6737 (let ((tgt (erc-default-target)))
6738 (erc-server-send (format "PART %s :%s" tgt
6739 (funcall erc-part-reason nil))
6740 nil tgt))))
6742 ;;; Dealing with `erc-parsed'
6744 (defun erc-find-parsed-property ()
6745 "Find the next occurrence of the `erc-parsed' text property."
6746 (text-property-not-all (point-min) (point-max) 'erc-parsed nil))
6748 (defun erc-restore-text-properties ()
6749 "Restore the property `erc-parsed' for the region."
6750 (let ((parsed-posn (erc-find-parsed-property)))
6751 (put-text-property
6752 (point-min) (point-max)
6753 'erc-parsed (when parsed-posn (erc-get-parsed-vector parsed-posn)))))
6755 (defun erc-get-parsed-vector (point)
6756 "Return the whole parsed vector on POINT."
6757 (get-text-property point 'erc-parsed))
6759 (defun erc-get-parsed-vector-nick (vect)
6760 "Return nickname in the parsed vector VECT."
6761 (let* ((untreated-nick (and vect (erc-response.sender vect)))
6762 (maybe-nick (when untreated-nick
6763 (car (split-string untreated-nick "!")))))
6764 (when (and (not (null maybe-nick))
6765 (erc-is-valid-nick-p maybe-nick))
6766 untreated-nick)))
6768 (defun erc-get-parsed-vector-type (vect)
6769 "Return message type in the parsed vector VECT."
6770 (and vect
6771 (erc-response.command vect)))
6773 ;; Teach url.el how to open irc:// URLs with ERC.
6774 ;; To activate, customize `url-irc-function' to `url-irc-erc'.
6776 ;;;###autoload
6777 (defun erc-handle-irc-url (host port channel user password)
6778 "Use ERC to IRC on HOST:PORT in CHANNEL as USER with PASSWORD.
6779 If ERC is already connected to HOST:PORT, simply /join CHANNEL.
6780 Otherwise, connect to HOST:PORT as USER and /join CHANNEL."
6781 (let ((server-buffer
6782 (car (erc-buffer-filter
6783 (lambda ()
6784 (and (string-equal erc-session-server host)
6785 (= erc-session-port port)
6786 (erc-open-server-buffer-p)))))))
6787 (with-current-buffer (or server-buffer (current-buffer))
6788 (if (and server-buffer channel)
6789 (erc-cmd-JOIN channel)
6790 (erc-open host port (or user (erc-compute-nick)) (erc-compute-full-name)
6791 (not server-buffer) password nil channel
6792 (when server-buffer
6793 (get-buffer-process server-buffer)))))))
6795 (provide 'erc)
6797 ;; Deprecated. We might eventually stop requiring the goodies automatically.
6798 ;; IMPORTANT: This require must appear _after_ the above (provide 'erc) to
6799 ;; avoid a recursive require error when byte-compiling the entire package.
6800 (require 'erc-goodies)
6802 ;;; erc.el ends here
6803 ;;
6804 ;; Local Variables:
6805 ;; outline-regexp: ";;+"
6806 ;; indent-tabs-mode: t
6807 ;; tab-width: 8
6808 ;; End: