Improve mouse dragging of frame edges.
[emacs.git] / lisp / net / rcirc.el
1 ;;; rcirc.el --- default, simple IRC client          -*- lexical-binding: t; -*-
2
3 ;; Copyright (C) 2005-2014 Free Software Foundation, Inc.
4
5 ;; Author: Ryan Yeske <rcyeske@gmail.com>
6 ;; Maintainers: Ryan Yeske <rcyeske@gmail.com>,
7 ;;              Leo Liu <sdl.web@gmail.com>
8 ;; Keywords: comm
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
24
25 ;;; Commentary:
26
27 ;; Internet Relay Chat (IRC) is a form of instant communication over
28 ;; the Internet. It is mainly designed for group (many-to-many)
29 ;; communication in discussion forums called channels, but also allows
30 ;; one-to-one communication.
31
32 ;; Rcirc has simple defaults and clear and consistent behavior.
33 ;; Message arrival timestamps, activity notification on the mode line,
34 ;; message filling, nick completion, and keepalive pings are all
35 ;; enabled by default, but can easily be adjusted or turned off.  Each
36 ;; discussion takes place in its own buffer and there is a single
37 ;; server buffer per connection.
38
39 ;; Open a new irc connection with:
40 ;; M-x irc RET
41
42 ;;; Todo:
43
44 ;;; Code:
45
46 (require 'cl-lib)
47 (require 'ring)
48 (require 'time-date)
49
50 (defgroup rcirc nil
51   "Simple IRC client."
52   :version "22.1"
53   :prefix "rcirc-"
54   :link '(custom-manual "(rcirc)")
55   :group 'applications)
56
57 (defcustom rcirc-server-alist
58   '(("irc.freenode.net" :channels ("#rcirc")
59      ;; Don't use the TLS port by default, in case gnutls is not available.
60      ;; :port 7000 :encryption tls
61      ))
62   "An alist of IRC connections to establish when running `rcirc'.
63 Each element looks like (SERVER-NAME PARAMETERS).
64
65 SERVER-NAME is a string describing the server to connect
66 to.
67
68 The optional PARAMETERS come in pairs PARAMETER VALUE.
69
70 The following parameters are recognized:
71
72 `:nick'
73
74 VALUE must be a string.  If absent, `rcirc-default-nick' is used
75 for this connection.
76
77 `:port'
78
79 VALUE must be a number or string.  If absent,
80 `rcirc-default-port' is used.
81
82 `:user-name'
83
84 VALUE must be a string.  If absent, `rcirc-default-user-name' is
85 used.
86
87 `:password'
88
89 VALUE must be a string.  If absent, no PASS command will be sent
90 to the server.
91
92 `:full-name'
93
94 VALUE must be a string.  If absent, `rcirc-default-full-name' is
95 used.
96
97 `:channels'
98
99 VALUE must be a list of strings describing which channels to join
100 when connecting to this server.  If absent, no channels will be
101 connected to automatically.
102
103 `:encryption'
104
105 VALUE must be `plain' (the default) for unencrypted connections, or `tls'
106 for connections using SSL/TLS."
107   :type '(alist :key-type string
108                 :value-type (plist :options
109                                    ((:nick string)
110                                     (:port integer)
111                                     (:user-name string)
112                                     (:password string)
113                                     (:full-name string)
114                                     (:channels (repeat string))
115                                     (:encryption (choice (const tls)
116                                                          (const plain))))))
117   :group 'rcirc)
118
119 (defcustom rcirc-default-port 6667
120   "The default port to connect to."
121   :type 'integer
122   :group 'rcirc)
123
124 (defcustom rcirc-default-nick (user-login-name)
125   "Your nick."
126   :type 'string
127   :group 'rcirc)
128
129 (defcustom rcirc-default-user-name "user"
130   "Your user name sent to the server when connecting."
131   :version "24.1"                       ; changed default
132   :type 'string
133   :group 'rcirc)
134
135 (defcustom rcirc-default-full-name "unknown"
136   "The full name sent to the server when connecting."
137   :version "24.1"                       ; changed default
138   :type 'string
139   :group 'rcirc)
140
141 (defcustom rcirc-fill-flag t
142   "Non-nil means line-wrap messages printed in channel buffers."
143   :type 'boolean
144   :group 'rcirc)
145
146 (defcustom rcirc-fill-column nil
147   "Column beyond which automatic line-wrapping should happen.
148 If nil, use value of `fill-column'.  If 'frame-width, use the
149 maximum frame width."
150   :type '(choice (const :tag "Value of `fill-column'")
151                  (const :tag "Full frame width" frame-width)
152                  (integer :tag "Number of columns"))
153   :group 'rcirc)
154
155 (defcustom rcirc-fill-prefix nil
156   "Text to insert before filled lines.
157 If nil, calculate the prefix dynamically to line up text
158 underneath each nick."
159   :type '(choice (const :tag "Dynamic" nil)
160                  (string :tag "Prefix text"))
161   :group 'rcirc)
162
163 (defvar rcirc-ignore-buffer-activity-flag nil
164   "If non-nil, ignore activity in this buffer.")
165 (make-variable-buffer-local 'rcirc-ignore-buffer-activity-flag)
166
167 (defvar rcirc-low-priority-flag nil
168   "If non-nil, activity in this buffer is considered low priority.")
169 (make-variable-buffer-local 'rcirc-low-priority-flag)
170
171 (defvar rcirc-omit-mode nil
172   "Non-nil if Rcirc-Omit mode is enabled.
173 Use the command `rcirc-omit-mode' to change this variable.")
174 (make-variable-buffer-local 'rcirc-omit-mode)
175
176 (defcustom rcirc-time-format "%H:%M "
177   "Describes how timestamps are printed.
178 Used as the first arg to `format-time-string'."
179   :type 'string
180   :group 'rcirc)
181
182 (defcustom rcirc-input-ring-size 1024
183   "Size of input history ring."
184   :type 'integer
185   :group 'rcirc)
186
187 (defcustom rcirc-read-only-flag t
188   "Non-nil means make text in IRC buffers read-only."
189   :type 'boolean
190   :group 'rcirc)
191
192 (defcustom rcirc-buffer-maximum-lines nil
193   "The maximum size in lines for rcirc buffers.
194 Channel buffers are truncated from the top to be no greater than this
195 number.  If zero or nil, no truncating is done."
196   :type '(choice (const :tag "No truncation" nil)
197                  (integer :tag "Number of lines"))
198   :group 'rcirc)
199
200 (defcustom rcirc-scroll-show-maximum-output t
201   "If non-nil, scroll buffer to keep the point at the bottom of
202 the window."
203   :type 'boolean
204   :group 'rcirc)
205
206 (defcustom rcirc-authinfo nil
207   "List of authentication passwords.
208 Each element of the list is a list with a SERVER-REGEXP string
209 and a method symbol followed by method specific arguments.
210
211 The valid METHOD symbols are `nickserv', `chanserv' and
212 `bitlbee'.
213
214 The ARGUMENTS for each METHOD symbol are:
215   `nickserv': NICK PASSWORD [NICKSERV-NICK]
216   `chanserv': NICK CHANNEL PASSWORD
217   `bitlbee': NICK PASSWORD
218   `quakenet': ACCOUNT PASSWORD
219
220 Examples:
221  ((\"freenode\" nickserv \"bob\" \"p455w0rd\")
222   (\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
223   (\"bitlbee\" bitlbee \"robert\" \"sekrit\")
224   (\"dal.net\" nickserv \"bob\" \"sekrit\" \"NickServ@services.dal.net\")
225   (\"quakenet.org\" quakenet \"bobby\" \"sekrit\"))"
226   :type '(alist :key-type (string :tag "Server")
227                 :value-type (choice (list :tag "NickServ"
228                                           (const nickserv)
229                                           (string :tag "Nick")
230                                           (string :tag "Password"))
231                                     (list :tag "ChanServ"
232                                           (const chanserv)
233                                           (string :tag "Nick")
234                                           (string :tag "Channel")
235                                           (string :tag "Password"))
236                                     (list :tag "BitlBee"
237                                           (const bitlbee)
238                                           (string :tag "Nick")
239                                           (string :tag "Password"))
240                                     (list :tag "QuakeNet"
241                                           (const quakenet)
242                                           (string :tag "Account")
243                                           (string :tag "Password"))))
244   :group 'rcirc)
245
246 (defcustom rcirc-auto-authenticate-flag t
247   "Non-nil means automatically send authentication string to server.
248 See also `rcirc-authinfo'."
249   :type 'boolean
250   :group 'rcirc)
251
252 (defcustom rcirc-authenticate-before-join t
253   "Non-nil means authenticate to services before joining channels.
254 Currently only works with NickServ on some networks."
255   :version "24.1"
256   :type 'boolean
257   :group 'rcirc)
258
259 (defcustom rcirc-prompt "> "
260   "Prompt string to use in IRC buffers.
261
262 The following replacements are made:
263 %n is your nick.
264 %s is the server.
265 %t is the buffer target, a channel or a user.
266
267 Setting this alone will not affect the prompt;
268 use either M-x customize or also call `rcirc-update-prompt'."
269   :type 'string
270   :set 'rcirc-set-changed
271   :initialize 'custom-initialize-default
272   :group 'rcirc)
273
274 (defcustom rcirc-keywords nil
275   "List of keywords to highlight in message text."
276   :type '(repeat string)
277   :group 'rcirc)
278
279 (defcustom rcirc-ignore-list ()
280   "List of ignored nicks.
281 Use /ignore to list them, use /ignore NICK to add or remove a nick."
282   :type '(repeat string)
283   :group 'rcirc)
284
285 (defvar rcirc-ignore-list-automatic ()
286   "List of ignored nicks added to `rcirc-ignore-list' because of renaming.
287 When an ignored person renames, their nick is added to both lists.
288 Nicks will be removed from the automatic list on follow-up renamings or
289 parts.")
290
291 (defcustom rcirc-bright-nicks nil
292   "List of nicks to be emphasized.
293 See `rcirc-bright-nick' face."
294   :type '(repeat string)
295   :group 'rcirc)
296
297 (defcustom rcirc-dim-nicks nil
298   "List of nicks to be deemphasized.
299 See `rcirc-dim-nick' face."
300   :type '(repeat string)
301   :group 'rcirc)
302
303 (define-obsolete-variable-alias 'rcirc-print-hooks
304   'rcirc-print-functions "24.3")
305 (defcustom rcirc-print-functions nil
306   "Hook run after text is printed.
307 Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT."
308   :type 'hook
309   :group 'rcirc)
310
311 (defvar rcirc-authenticated-hook nil
312   "Hook run after successfully authenticated.")
313
314 (defcustom rcirc-always-use-server-buffer-flag nil
315   "Non-nil means messages without a channel target will go to the server buffer."
316   :type 'boolean
317   :group 'rcirc)
318
319 (defcustom rcirc-decode-coding-system 'utf-8
320   "Coding system used to decode incoming irc messages.
321 Set to 'undecided if you want the encoding of the incoming
322 messages autodetected."
323   :type 'coding-system
324   :group 'rcirc)
325
326 (defcustom rcirc-encode-coding-system 'utf-8
327   "Coding system used to encode outgoing irc messages."
328   :type 'coding-system
329   :group 'rcirc)
330
331 (defcustom rcirc-coding-system-alist nil
332   "Alist to decide a coding system to use for a channel I/O operation.
333 The format is ((PATTERN . VAL) ...).
334 PATTERN is either a string or a cons of strings.
335 If PATTERN is a string, it is used to match a target.
336 If PATTERN is a cons of strings, the car part is used to match a
337 target, and the cdr part is used to match a server.
338 VAL is either a coding system or a cons of coding systems.
339 If VAL is a coding system, it is used for both decoding and encoding
340 messages.
341 If VAL is a cons of coding systems, the car part is used for decoding,
342 and the cdr part is used for encoding."
343   :type '(alist :key-type (choice (string :tag "Channel Regexp")
344                                           (cons (string :tag "Channel Regexp")
345                                                 (string :tag "Server Regexp")))
346                 :value-type (choice coding-system
347                                     (cons (coding-system :tag "Decode")
348                                           (coding-system :tag "Encode"))))
349   :group 'rcirc)
350
351 (defcustom rcirc-multiline-major-mode 'fundamental-mode
352   "Major-mode function to use in multiline edit buffers."
353   :type 'function
354   :group 'rcirc)
355
356 (defcustom rcirc-nick-completion-format "%s: "
357   "Format string to use in nick completions.
358
359 The format string is only used when completing at the beginning
360 of a line.  The string is passed as the first argument to
361 `format' with the nickname as the second argument."
362   :version "24.1"
363   :type 'string
364   :group 'rcirc)
365
366 (defcustom rcirc-kill-channel-buffers nil
367   "When non-nil, kill channel buffers when the server buffer is killed.
368 Only the channel buffers associated with the server in question
369 will be killed."
370   :version "24.3"
371   :type 'boolean
372   :group 'rcirc)
373
374 (defvar rcirc-nick nil)
375
376 (defvar rcirc-prompt-start-marker nil)
377 (defvar rcirc-prompt-end-marker nil)
378
379 (defvar rcirc-nick-table nil)
380
381 (defvar rcirc-recent-quit-alist nil
382   "Alist of nicks that have recently quit or parted the channel.")
383
384 (defvar rcirc-nick-syntax-table
385   (let ((table (make-syntax-table text-mode-syntax-table)))
386     (mapc (lambda (c) (modify-syntax-entry c "w" table))
387           "[]\\`_^{|}-")
388     (modify-syntax-entry ?' "_" table)
389     table)
390   "Syntax table which includes all nick characters as word constituents.")
391
392 ;; each process has an alist of (target . buffer) pairs
393 (defvar rcirc-buffer-alist nil)
394
395 (defvar rcirc-activity nil
396   "List of buffers with unviewed activity.")
397
398 (defvar rcirc-activity-string ""
399   "String displayed in mode line representing `rcirc-activity'.")
400 (put 'rcirc-activity-string 'risky-local-variable t)
401
402 (defvar rcirc-server-buffer nil
403   "The server buffer associated with this channel buffer.")
404
405 (defvar rcirc-target nil
406   "The channel or user associated with this buffer.")
407
408 (defvar rcirc-urls nil
409   "List of URLs seen in the current buffer and their start positions.")
410 (put 'rcirc-urls 'permanent-local t)
411
412 (defvar rcirc-timeout-seconds 600
413   "Kill connection after this many seconds if there is no activity.")
414
415 (defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
416 \f
417 (defvar rcirc-startup-channels nil)
418
419 (defvar rcirc-server-name-history nil
420   "History variable for \\[rcirc] call.")
421
422 (defvar rcirc-server-port-history nil
423   "History variable for \\[rcirc] call.")
424
425 (defvar rcirc-nick-name-history nil
426   "History variable for \\[rcirc] call.")
427
428 (defvar rcirc-user-name-history nil
429   "History variable for \\[rcirc] call.")
430
431 ;;;###autoload
432 (defun rcirc (arg)
433   "Connect to all servers in `rcirc-server-alist'.
434
435 Do not connect to a server if it is already connected.
436
437 If ARG is non-nil, instead prompt for connection parameters."
438   (interactive "P")
439   (if arg
440       (let* ((server (completing-read "IRC Server: "
441                                       rcirc-server-alist
442                                       nil nil
443                                       (caar rcirc-server-alist)
444                                       'rcirc-server-name-history))
445              (server-plist (cdr (assoc-string server rcirc-server-alist)))
446              (port (read-string "IRC Port: "
447                                 (number-to-string
448                                  (or (plist-get server-plist :port)
449                                      rcirc-default-port))
450                                 'rcirc-server-port-history))
451              (nick (read-string "IRC Nick: "
452                                 (or (plist-get server-plist :nick)
453                                     rcirc-default-nick)
454                                 'rcirc-nick-name-history))
455              (user-name (read-string "IRC Username: "
456                                      (or (plist-get server-plist :user-name)
457                                          rcirc-default-user-name)
458                                      'rcirc-user-name-history))
459              (password (read-passwd "IRC Password: " nil
460                                     (plist-get server-plist :password)))
461              (channels (split-string
462                         (read-string "IRC Channels: "
463                                      (mapconcat 'identity
464                                                 (plist-get server-plist
465                                                            :channels)
466                                                 " "))
467                         "[, ]+" t))
468              (encryption (rcirc-prompt-for-encryption server-plist)))
469         (rcirc-connect server port nick user-name
470                        rcirc-default-full-name
471                        channels password encryption))
472     ;; connect to servers in `rcirc-server-alist'
473     (let (connected-servers)
474       (dolist (c rcirc-server-alist)
475         (let ((server (car c))
476               (nick (or (plist-get (cdr c) :nick) rcirc-default-nick))
477               (port (or (plist-get (cdr c) :port) rcirc-default-port))
478               (user-name (or (plist-get (cdr c) :user-name)
479                              rcirc-default-user-name))
480               (full-name (or (plist-get (cdr c) :full-name)
481                              rcirc-default-full-name))
482               (channels (plist-get (cdr c) :channels))
483               (password (plist-get (cdr c) :password))
484               (encryption (plist-get (cdr c) :encryption))
485               contact)
486           (when server
487             (let (connected)
488               (dolist (p (rcirc-process-list))
489                 (when (string= server (process-name p))
490                   (setq connected p)))
491               (if (not connected)
492                   (condition-case nil
493                       (rcirc-connect server port nick user-name
494                                      full-name channels password encryption)
495                     (quit (message "Quit connecting to %s" server)))
496                 (with-current-buffer (process-buffer connected)
497                   (setq contact (process-contact
498                                  (get-buffer-process (current-buffer)) :host))
499                   (setq connected-servers
500                         (cons (if (stringp contact) contact server)
501                               connected-servers))))))))
502       (when connected-servers
503         (message "Already connected to %s"
504                  (if (cdr connected-servers)
505                      (concat (mapconcat 'identity (butlast connected-servers) ", ")
506                              ", and "
507                              (car (last connected-servers)))
508                    (car connected-servers)))))))
509
510 ;;;###autoload
511 (defalias 'irc 'rcirc)
512
513 \f
514 (defvar rcirc-process-output nil)
515 (defvar rcirc-topic nil)
516 (defvar rcirc-keepalive-timer nil)
517 (defvar rcirc-last-server-message-time nil)
518 (defvar rcirc-server nil)               ; server provided by server
519 (defvar rcirc-server-name nil)          ; server name given by 001 response
520 (defvar rcirc-timeout-timer nil)
521 (defvar rcirc-user-authenticated nil)
522 (defvar rcirc-user-disconnect nil)
523 (defvar rcirc-connecting nil)
524 (defvar rcirc-connection-info nil)
525 (defvar rcirc-process nil)
526
527 ;;;###autoload
528 (defun rcirc-connect (server &optional port nick user-name
529                              full-name startup-channels password encryption)
530   (save-excursion
531     (message "Connecting to %s..." server)
532     (let* ((inhibit-eol-conversion)
533            (port-number (if port
534                             (if (stringp port)
535                                 (string-to-number port)
536                               port)
537                           rcirc-default-port))
538            (nick (or nick rcirc-default-nick))
539            (user-name (or user-name rcirc-default-user-name))
540            (full-name (or full-name rcirc-default-full-name))
541            (startup-channels startup-channels)
542            (process (open-network-stream
543                      server nil server port-number
544                      :type (or encryption 'plain))))
545       ;; set up process
546       (set-process-coding-system process 'raw-text 'raw-text)
547       (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
548       (set-process-buffer process (current-buffer))
549       (rcirc-mode process nil)
550       (set-process-sentinel process 'rcirc-sentinel)
551       (set-process-filter process 'rcirc-filter)
552
553       (setq-local rcirc-connection-info
554                   (list server port nick user-name full-name startup-channels
555                         password encryption))
556       (setq-local rcirc-process process)
557       (setq-local rcirc-server server)
558       (setq-local rcirc-server-name server) ; Update when we get 001 response.
559       (setq-local rcirc-buffer-alist nil)
560       (setq-local rcirc-nick-table (make-hash-table :test 'equal))
561       (setq-local rcirc-nick nick)
562       (setq-local rcirc-process-output nil)
563       (setq-local rcirc-startup-channels startup-channels)
564       (setq-local rcirc-last-server-message-time (current-time))
565
566       (setq-local rcirc-timeout-timer nil)
567       (setq-local rcirc-user-disconnect nil)
568       (setq-local rcirc-user-authenticated nil)
569       (setq-local rcirc-connecting t)
570
571       (add-hook 'auto-save-hook 'rcirc-log-write)
572
573       ;; identify
574       (unless (zerop (length password))
575         (rcirc-send-string process (concat "PASS " password)))
576       (rcirc-send-string process (concat "NICK " nick))
577       (rcirc-send-string process (concat "USER " user-name
578                                          " 0 * :" full-name))
579
580       ;; setup ping timer if necessary
581       (unless rcirc-keepalive-timer
582         (setq rcirc-keepalive-timer
583               (run-at-time 0 (/ rcirc-timeout-seconds 2) 'rcirc-keepalive)))
584
585       (message "Connecting to %s...done" server)
586
587       ;; return process object
588       process)))
589
590 (defmacro with-rcirc-process-buffer (process &rest body)
591   (declare (indent 1) (debug t))
592   `(with-current-buffer (process-buffer ,process)
593      ,@body))
594
595 (defmacro with-rcirc-server-buffer (&rest body)
596   (declare (indent 0) (debug t))
597   `(with-current-buffer rcirc-server-buffer
598      ,@body))
599
600 (defun rcirc-float-time ()
601   (if (featurep 'xemacs)
602       (time-to-seconds (current-time))
603     (float-time)))
604
605 (defun rcirc-prompt-for-encryption (server-plist)
606   "Prompt the user for the encryption method to use.
607 SERVER-PLIST is the property list for the server."
608   (let ((msg "Encryption (default %s): ")
609         (choices '("plain" "tls"))
610         (default (or (plist-get server-plist :encryption)
611                      'plain)))
612     (intern
613      (completing-read (format msg default)
614                       choices nil t nil nil (symbol-name default)))))
615
616 (defun rcirc-keepalive ()
617   "Send keep alive pings to active rcirc processes.
618 Kill processes that have not received a server message since the
619 last ping."
620   (if (rcirc-process-list)
621       (mapc (lambda (process)
622               (with-rcirc-process-buffer process
623                 (when (not rcirc-connecting)
624                   (rcirc-send-ctcp process
625                                    rcirc-nick
626                                    (format "KEEPALIVE %f"
627                                            (rcirc-float-time))))))
628             (rcirc-process-list))
629     ;; no processes, clean up timer
630     (when (timerp rcirc-keepalive-timer)
631       (cancel-timer rcirc-keepalive-timer))
632     (setq rcirc-keepalive-timer nil)))
633
634 (defun rcirc-handler-ctcp-KEEPALIVE (process _target _sender message)
635   (with-rcirc-process-buffer process
636     (setq header-line-format (format "%f" (- (rcirc-float-time)
637                                              (string-to-number message))))))
638
639 (defvar rcirc-debug-buffer "*rcirc debug*")
640 (defvar rcirc-debug-flag nil
641   "If non-nil, write information to `rcirc-debug-buffer'.")
642 (defun rcirc-debug (process text)
643   "Add an entry to the debug log including PROCESS and TEXT.
644 Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
645 is non-nil."
646   (when rcirc-debug-flag
647     (with-current-buffer (get-buffer-create rcirc-debug-buffer)
648       (goto-char (point-max))
649       (insert (concat
650                "["
651                (format-time-string "%Y-%m-%dT%T ") (process-name process)
652                "] "
653                text)))))
654
655 (define-obsolete-variable-alias 'rcirc-sentinel-hooks
656   'rcirc-sentinel-functions "24.3")
657 (defvar rcirc-sentinel-functions nil
658   "Hook functions called when the process sentinel is called.
659 Functions are called with PROCESS and SENTINEL arguments.")
660
661 (defcustom rcirc-reconnect-delay 0
662   "The minimum interval in seconds between reconnect attempts.
663 When 0, do not auto-reconnect."
664   :version "25.1"
665   :type 'integer
666   :group 'rcirc)
667
668 (defvar rcirc-last-connect-time nil
669   "The last time the buffer was connected.")
670
671 (defun rcirc-sentinel (process sentinel)
672   "Called when PROCESS receives SENTINEL."
673   (let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
674     (rcirc-debug process (format "SENTINEL: %S %S\n" process sentinel))
675     (with-rcirc-process-buffer process
676       (dolist (buffer (cons nil (mapcar 'cdr rcirc-buffer-alist)))
677         (with-current-buffer (or buffer (current-buffer))
678           (rcirc-print process "rcirc.el" "ERROR" rcirc-target
679                        (format "%s: %s (%S)"
680                                (process-name process)
681                                sentinel
682                                (process-status process))
683                        (not rcirc-target))
684           (rcirc-disconnect-buffer)))
685       (when (and (string= sentinel "deleted")
686                  (< 0 rcirc-reconnect-delay))
687         (let ((now (current-time)))
688           (when (or (null rcirc-last-connect-time)
689                     (< rcirc-reconnect-delay
690                        (float-time (time-subtract now rcirc-last-connect-time))))
691             (setq rcirc-last-connect-time now)
692             (rcirc-cmd-reconnect nil))))
693       (run-hook-with-args 'rcirc-sentinel-functions process sentinel))))
694
695 (defun rcirc-disconnect-buffer (&optional buffer)
696   (with-current-buffer (or buffer (current-buffer))
697     ;; set rcirc-target to nil for each channel so cleanup
698     ;; doesn't happen when we reconnect
699     (setq rcirc-target nil)
700     (setq mode-line-process ":disconnected")))
701
702 (defun rcirc-process-list ()
703   "Return a list of rcirc processes."
704   (let (ps)
705     (mapc (lambda (p)
706             (when (buffer-live-p (process-buffer p))
707               (with-rcirc-process-buffer p
708                 (when (eq major-mode 'rcirc-mode)
709                   (setq ps (cons p ps))))))
710           (process-list))
711     ps))
712
713 (define-obsolete-variable-alias 'rcirc-receive-message-hooks
714   'rcirc-receive-message-functions "24.3")
715 (defvar rcirc-receive-message-functions nil
716   "Hook functions run when a message is received from server.
717 Function is called with PROCESS, COMMAND, SENDER, ARGS and LINE.")
718 (defun rcirc-filter (process output)
719   "Called when PROCESS receives OUTPUT."
720   (rcirc-debug process output)
721   (rcirc-reschedule-timeout process)
722   (with-rcirc-process-buffer process
723     (setq rcirc-last-server-message-time (current-time))
724     (setq rcirc-process-output (concat rcirc-process-output output))
725     (when (= (aref rcirc-process-output
726                    (1- (length rcirc-process-output))) ?\n)
727       (mapc (lambda (line)
728               (rcirc-process-server-response process line))
729             (split-string rcirc-process-output "[\n\r]" t))
730       (setq rcirc-process-output nil))))
731
732 (defun rcirc-reschedule-timeout (process)
733   (with-rcirc-process-buffer process
734     (when (not rcirc-connecting)
735       (with-rcirc-process-buffer process
736         (when rcirc-timeout-timer (cancel-timer rcirc-timeout-timer))
737         (setq rcirc-timeout-timer (run-at-time rcirc-timeout-seconds nil
738                                                'rcirc-delete-process
739                                                process))))))
740
741 (defun rcirc-delete-process (process)
742   (delete-process process))
743
744 (defvar rcirc-trap-errors-flag t)
745 (defun rcirc-process-server-response (process text)
746   (if rcirc-trap-errors-flag
747       (condition-case err
748           (rcirc-process-server-response-1 process text)
749         (error
750          (rcirc-print process "RCIRC" "ERROR" nil
751                       (format "\"%s\" %s" text err) t)))
752     (rcirc-process-server-response-1 process text)))
753
754 (defun rcirc-process-server-response-1 (process text)
755   (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
756       (let* ((user (match-string 2 text))
757              (sender (rcirc-user-nick user))
758              (cmd (match-string 3 text))
759              (args (match-string 4 text))
760              (handler (intern-soft (concat "rcirc-handler-" cmd))))
761         (string-match "^\\([^:]*\\):?\\(.+\\)?$" args)
762         (let* ((args1 (match-string 1 args))
763                (args2 (match-string 2 args))
764                (args (delq nil (append (split-string args1 " " t)
765                                        (list args2)))))
766         (if (not (fboundp handler))
767             (rcirc-handler-generic process cmd sender args text)
768           (funcall handler process sender args text))
769         (run-hook-with-args 'rcirc-receive-message-functions
770                             process cmd sender args text)))
771     (message "UNHANDLED: %s" text)))
772
773 (defvar rcirc-responses-no-activity '("305" "306")
774   "Responses that don't trigger activity in the mode-line indicator.")
775
776 (defun rcirc-handler-generic (process response sender args _text)
777   "Generic server response handler."
778   (rcirc-print process sender response nil
779                (mapconcat 'identity (cdr args) " ")
780                (not (member response rcirc-responses-no-activity))))
781
782 (defun rcirc--connection-open-p (process)
783   (memq (process-status process) '(run open)))
784
785 (defun rcirc-send-string (process string)
786   "Send PROCESS a STRING plus a newline."
787   (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
788                         "\n")))
789     (unless (rcirc--connection-open-p process)
790       (error "Network connection to %s is not open"
791              (process-name process)))
792     (rcirc-debug process string)
793     (process-send-string process string)))
794
795 (defun rcirc-send-privmsg (process target string)
796   (rcirc-send-string process (format "PRIVMSG %s :%s" target string)))
797
798 (defun rcirc-send-ctcp (process target request &optional args)
799   (let ((args (if args (concat " " args) "")))
800     (rcirc-send-privmsg process target
801                         (format "\C-a%s%s\C-a" request args))))
802
803 (defun rcirc-buffer-process (&optional buffer)
804   "Return the process associated with channel BUFFER.
805 With no argument or nil as argument, use the current buffer."
806   (let ((buffer (or buffer (and (buffer-live-p rcirc-server-buffer)
807                                 rcirc-server-buffer))))
808     (if buffer
809         (with-current-buffer buffer rcirc-process)
810       rcirc-process)))
811
812 (defun rcirc-server-name (process)
813   "Return PROCESS server name, given by the 001 response."
814   (with-rcirc-process-buffer process
815     (or rcirc-server-name
816         (warn "server name for process %S unknown" process))))
817
818 (defun rcirc-nick (process)
819   "Return PROCESS nick."
820   (with-rcirc-process-buffer process
821     (or rcirc-nick rcirc-default-nick)))
822
823 (defun rcirc-buffer-nick (&optional buffer)
824   "Return the nick associated with BUFFER.
825 With no argument or nil as argument, use the current buffer."
826   (with-current-buffer (or buffer (current-buffer))
827     (with-current-buffer rcirc-server-buffer
828       (or rcirc-nick rcirc-default-nick))))
829
830 (defvar rcirc-max-message-length 420
831   "Messages longer than this value will be split.")
832
833 (defun rcirc-split-message (message)
834   "Split MESSAGE into chunks within `rcirc-max-message-length'."
835   ;; `rcirc-encode-coding-system' can have buffer-local value.
836   (let ((encoding rcirc-encode-coding-system))
837     (with-temp-buffer
838       (insert message)
839       (goto-char (point-min))
840       (let (result)
841         (while (not (eobp))
842           (goto-char (or (byte-to-position rcirc-max-message-length)
843                          (point-max)))
844           ;; max message length is 512 including CRLF
845           (while (and (not (bobp))
846                       (> (length (encode-coding-region
847                                   (point-min) (point) encoding t))
848                          rcirc-max-message-length))
849             (forward-char -1))
850           (push (delete-and-extract-region (point-min) (point)) result))
851         (nreverse result)))))
852
853 (defun rcirc-send-message (process target message &optional noticep silent)
854   "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
855 If NOTICEP is non-nil, send a notice instead of privmsg.
856 If SILENT is non-nil, do not print the message in any irc buffer."
857   (let ((response (if noticep "NOTICE" "PRIVMSG")))
858     (rcirc-get-buffer-create process target)
859     (dolist (msg (rcirc-split-message message))
860       (rcirc-send-string process (concat response " " target " :" msg))
861       (unless silent
862         (rcirc-print process (rcirc-nick process) response target msg)))))
863
864 (defvar rcirc-input-ring nil)
865 (defvar rcirc-input-ring-index 0)
866
867 (defun rcirc-prev-input-string (arg)
868   (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))
869
870 (defun rcirc-insert-prev-input ()
871   (interactive)
872   (when (<= rcirc-prompt-end-marker (point))
873     (delete-region rcirc-prompt-end-marker (point-max))
874     (insert (rcirc-prev-input-string 0))
875     (setq rcirc-input-ring-index (1+ rcirc-input-ring-index))))
876
877 (defun rcirc-insert-next-input ()
878   (interactive)
879   (when (<= rcirc-prompt-end-marker (point))
880     (delete-region rcirc-prompt-end-marker (point-max))
881     (setq rcirc-input-ring-index (1- rcirc-input-ring-index))
882     (insert (rcirc-prev-input-string -1))))
883
884 (defvar rcirc-server-commands
885   '("/admin"   "/away"   "/connect" "/die"      "/error"   "/info"
886     "/invite"  "/ison"   "/join"    "/kick"     "/kill"    "/links"
887     "/list"    "/lusers" "/mode"    "/motd"     "/names"   "/nick"
888     "/notice"  "/oper"   "/part"    "/pass"     "/ping"    "/pong"
889     "/privmsg" "/quit"   "/rehash"  "/restart"  "/service" "/servlist"
890     "/server"  "/squery" "/squit"   "/stats"    "/summon"  "/time"
891     "/topic"   "/trace"  "/user"    "/userhost" "/users"   "/version"
892     "/wallops" "/who"    "/whois"   "/whowas")
893   "A list of user commands by IRC server.
894 The value defaults to RFCs 1459 and 2812.")
895
896 ;; /me and /ctcp are not defined by `defun-rcirc-command'.
897 (defvar rcirc-client-commands '("/me" "/ctcp")
898   "A list of user commands defined by IRC client rcirc.
899 The list is updated automatically by `defun-rcirc-command'.")
900
901 (defun rcirc-completion-at-point ()
902   "Function used for `completion-at-point-functions' in `rcirc-mode'."
903   (and (rcirc-looking-at-input)
904        (let* ((beg (save-excursion
905                      (if (re-search-backward " " rcirc-prompt-end-marker t)
906                          (1+ (point))
907                        rcirc-prompt-end-marker)))
908               (table (if (and (= beg rcirc-prompt-end-marker)
909                               (eq (char-after beg) ?/))
910                          (delete-dups
911                           (nconc (sort (copy-sequence rcirc-client-commands)
912                                        'string-lessp)
913                                  (sort (copy-sequence rcirc-server-commands)
914                                        'string-lessp)))
915                        (rcirc-channel-nicks (rcirc-buffer-process)
916                                             rcirc-target))))
917          (list beg (point) table))))
918
919 (defvar rcirc-completions nil)
920 (defvar rcirc-completion-start nil)
921
922 (defun rcirc-complete ()
923   "Cycle through completions from list of nicks in channel or IRC commands.
924 IRC command completion is performed only if '/' is the first input char."
925   (interactive)
926   (unless (rcirc-looking-at-input)
927     (error "Point not located after rcirc prompt"))
928   (if (eq last-command this-command)
929       (setq rcirc-completions
930             (append (cdr rcirc-completions) (list (car rcirc-completions))))
931     (let ((completion-ignore-case t)
932           (table (rcirc-completion-at-point)))
933       (setq rcirc-completion-start (car table))
934       (setq rcirc-completions
935             (and rcirc-completion-start
936                  (all-completions (buffer-substring rcirc-completion-start
937                                                     (cadr table))
938                                   (nth 2 table))))))
939   (let ((completion (car rcirc-completions)))
940     (when completion
941       (delete-region rcirc-completion-start (point))
942       (insert
943        (cond
944         ((= (aref completion 0) ?/) (concat completion " "))
945         ((= rcirc-completion-start rcirc-prompt-end-marker)
946          (format rcirc-nick-completion-format completion))
947         (t completion))))))
948
949 (defun set-rcirc-decode-coding-system (coding-system)
950   "Set the decode coding system used in this channel."
951   (interactive "zCoding system for incoming messages: ")
952   (setq-local rcirc-decode-coding-system coding-system))
953
954 (defun set-rcirc-encode-coding-system (coding-system)
955   "Set the encode coding system used in this channel."
956   (interactive "zCoding system for outgoing messages: ")
957   (setq-local rcirc-encode-coding-system coding-system))
958
959 (defvar rcirc-mode-map
960   (let ((map (make-sparse-keymap)))
961     (define-key map (kbd "RET") 'rcirc-send-input)
962     (define-key map (kbd "M-p") 'rcirc-insert-prev-input)
963     (define-key map (kbd "M-n") 'rcirc-insert-next-input)
964     (define-key map (kbd "TAB") 'rcirc-complete)
965     (define-key map (kbd "C-c C-b") 'rcirc-browse-url)
966     (define-key map (kbd "C-c C-c") 'rcirc-edit-multiline)
967     (define-key map (kbd "C-c C-j") 'rcirc-cmd-join)
968     (define-key map (kbd "C-c C-k") 'rcirc-cmd-kick)
969     (define-key map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
970     (define-key map (kbd "C-c C-d") 'rcirc-cmd-mode)
971     (define-key map (kbd "C-c C-m") 'rcirc-cmd-msg)
972     (define-key map (kbd "C-c C-r") 'rcirc-cmd-nick) ; rename
973     (define-key map (kbd "C-c C-o") 'rcirc-omit-mode)
974     (define-key map (kbd "C-c C-p") 'rcirc-cmd-part)
975     (define-key map (kbd "C-c C-q") 'rcirc-cmd-query)
976     (define-key map (kbd "C-c C-t") 'rcirc-cmd-topic)
977     (define-key map (kbd "C-c C-n") 'rcirc-cmd-names)
978     (define-key map (kbd "C-c C-w") 'rcirc-cmd-whois)
979     (define-key map (kbd "C-c C-x") 'rcirc-cmd-quit)
980     (define-key map (kbd "C-c TAB") ; C-i
981       'rcirc-toggle-ignore-buffer-activity)
982     (define-key map (kbd "C-c C-s") 'rcirc-switch-to-server-buffer)
983     (define-key map (kbd "C-c C-a") 'rcirc-jump-to-first-unread-line)
984     map)
985   "Keymap for rcirc mode.")
986
987 (defvar rcirc-short-buffer-name nil
988   "Generated abbreviation to use to indicate buffer activity.")
989
990 (defvar rcirc-mode-hook nil
991   "Hook run when setting up rcirc buffer.")
992
993 (defvar rcirc-last-post-time nil)
994
995 (defvar rcirc-log-alist nil
996   "Alist of lines to log to disk when `rcirc-log-flag' is non-nil.
997 Each element looks like (FILENAME . TEXT).")
998
999 (defvar rcirc-current-line 0
1000   "The current number of responses printed in this channel.
1001 This number is independent of the number of lines in the buffer.")
1002
1003 (defun rcirc-mode (process target)
1004   ;; FIXME: Use define-derived-mode.
1005   "Major mode for IRC channel buffers.
1006
1007 \\{rcirc-mode-map}"
1008   (kill-all-local-variables)
1009   (use-local-map rcirc-mode-map)
1010   (setq mode-name "rcirc")
1011   (setq major-mode 'rcirc-mode)
1012   (setq mode-line-process nil)
1013
1014   (setq-local rcirc-input-ring
1015               ;; If rcirc-input-ring is already a ring with desired
1016               ;; size do not re-initialize.
1017               (if (and (ring-p rcirc-input-ring)
1018                        (= (ring-size rcirc-input-ring)
1019                           rcirc-input-ring-size))
1020                   rcirc-input-ring
1021                 (make-ring rcirc-input-ring-size)))
1022   (setq-local rcirc-server-buffer (process-buffer process))
1023   (setq-local rcirc-target target)
1024   (setq-local rcirc-topic nil)
1025   (setq-local rcirc-last-post-time (current-time))
1026   (setq-local fill-paragraph-function 'rcirc-fill-paragraph)
1027   (setq-local rcirc-recent-quit-alist nil)
1028   (setq-local rcirc-current-line 0)
1029   (setq-local rcirc-last-connect-time (current-time))
1030
1031   (use-hard-newlines t)
1032   (setq-local rcirc-short-buffer-name nil)
1033   (setq-local rcirc-urls nil)
1034
1035   ;; setup for omitting responses
1036   (setq buffer-invisibility-spec '())
1037   (setq buffer-display-table (make-display-table))
1038   (set-display-table-slot buffer-display-table 4
1039                           (let ((glyph (make-glyph-code
1040                                         ?. 'font-lock-keyword-face)))
1041                             (make-vector 3 glyph)))
1042
1043   (dolist (i rcirc-coding-system-alist)
1044     (let ((chan (if (consp (car i)) (caar i) (car i)))
1045           (serv (if (consp (car i)) (cdar i) "")))
1046       (when (and (string-match chan (or target ""))
1047                  (string-match serv (rcirc-server-name process)))
1048         (setq-local rcirc-decode-coding-system
1049                     (if (consp (cdr i)) (cadr i) (cdr i)))
1050         (setq-local rcirc-encode-coding-system
1051                     (if (consp (cdr i)) (cddr i) (cdr i))))))
1052
1053   ;; setup the prompt and markers
1054   (setq-local rcirc-prompt-start-marker (point-max-marker))
1055   (setq-local rcirc-prompt-end-marker (point-max-marker))
1056   (rcirc-update-prompt)
1057   (goto-char rcirc-prompt-end-marker)
1058
1059   (setq-local overlay-arrow-position (make-marker))
1060
1061   ;; if the user changes the major mode or kills the buffer, there is
1062   ;; cleanup work to do
1063   (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook nil t)
1064   (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook nil t)
1065
1066   ;; add to buffer list, and update buffer abbrevs
1067   (when target                          ; skip server buffer
1068     (let ((buffer (current-buffer)))
1069       (with-rcirc-process-buffer process
1070         (setq rcirc-buffer-alist (cons (cons target buffer)
1071                                        rcirc-buffer-alist))))
1072     (rcirc-update-short-buffer-names))
1073
1074   (add-hook 'completion-at-point-functions
1075             'rcirc-completion-at-point nil 'local)
1076
1077   (run-mode-hooks 'rcirc-mode-hook))
1078
1079 (defun rcirc-update-prompt (&optional all)
1080   "Reset the prompt string in the current buffer.
1081
1082 If ALL is non-nil, update prompts in all IRC buffers."
1083   (if all
1084       (mapc (lambda (process)
1085               (mapc (lambda (buffer)
1086                       (with-current-buffer buffer
1087                         (rcirc-update-prompt)))
1088                     (with-rcirc-process-buffer process
1089                       (mapcar 'cdr rcirc-buffer-alist))))
1090             (rcirc-process-list))
1091     (let ((inhibit-read-only t)
1092           (prompt (or rcirc-prompt "")))
1093       (mapc (lambda (rep)
1094               (setq prompt
1095                     (replace-regexp-in-string (car rep) (cdr rep) prompt)))
1096             (list (cons "%n" (rcirc-buffer-nick))
1097                   (cons "%s" (with-rcirc-server-buffer rcirc-server-name))
1098                   (cons "%t" (or rcirc-target ""))))
1099       (save-excursion
1100         (delete-region rcirc-prompt-start-marker rcirc-prompt-end-marker)
1101         (goto-char rcirc-prompt-start-marker)
1102         (let ((start (point)))
1103           (insert-before-markers prompt)
1104           (set-marker rcirc-prompt-start-marker start)
1105           (when (not (zerop (- rcirc-prompt-end-marker
1106                                rcirc-prompt-start-marker)))
1107             (add-text-properties rcirc-prompt-start-marker
1108                                  rcirc-prompt-end-marker
1109                                  (list 'face 'rcirc-prompt
1110                                        'read-only t 'field t
1111                                        'front-sticky t 'rear-nonsticky t))))))))
1112
1113 (defun rcirc-set-changed (option value)
1114   "Set OPTION to VALUE and do updates after a customization change."
1115   (set-default option value)
1116   (cond ((eq option 'rcirc-prompt)
1117          (rcirc-update-prompt 'all))
1118         (t
1119          (error "Bad option %s" option))))
1120
1121 (defun rcirc-channel-p (target)
1122   "Return t if TARGET is a channel name."
1123   (and target
1124        (not (zerop (length target)))
1125        (or (eq (aref target 0) ?#)
1126            (eq (aref target 0) ?&))))
1127
1128 (defcustom rcirc-log-directory "~/.emacs.d/rcirc-log"
1129   "Directory to keep IRC logfiles."
1130   :type 'directory
1131   :group 'rcirc)
1132
1133 (defcustom rcirc-log-flag nil
1134   "Non-nil means log IRC activity to disk.
1135 Logfiles are kept in `rcirc-log-directory'."
1136   :type 'boolean
1137   :group 'rcirc)
1138
1139 (defun rcirc-kill-buffer-hook ()
1140   "Part the channel when killing an rcirc buffer.
1141
1142 If `rcirc-kill-channel-buffers' is non-nil and the killed buffer
1143 is a server buffer, kills all of the channel buffers associated
1144 with it."
1145   (when (eq major-mode 'rcirc-mode)
1146     (when (and rcirc-log-flag
1147                rcirc-log-directory)
1148       (rcirc-log-write))
1149     (rcirc-clean-up-buffer "Killed buffer")
1150     (when (and rcirc-buffer-alist ;; it's a server buffer
1151                rcirc-kill-channel-buffers)
1152       (dolist (channel rcirc-buffer-alist)
1153         (kill-buffer (cdr channel))))))
1154
1155 (defun rcirc-change-major-mode-hook ()
1156   "Part the channel when changing the major-mode."
1157   (rcirc-clean-up-buffer "Changed major mode"))
1158
1159 (defun rcirc-clean-up-buffer (reason)
1160   (let ((buffer (current-buffer)))
1161     (rcirc-clear-activity buffer)
1162     (when (and (rcirc-buffer-process)
1163                (rcirc--connection-open-p (rcirc-buffer-process)))
1164       (with-rcirc-server-buffer
1165        (setq rcirc-buffer-alist
1166              (rassq-delete-all buffer rcirc-buffer-alist)))
1167       (rcirc-update-short-buffer-names)
1168       (if (rcirc-channel-p rcirc-target)
1169           (rcirc-send-string (rcirc-buffer-process)
1170                              (concat "PART " rcirc-target " :" reason))
1171         (when rcirc-target
1172           (rcirc-remove-nick-channel (rcirc-buffer-process)
1173                                      (rcirc-buffer-nick)
1174                                      rcirc-target))))
1175     (setq rcirc-target nil)))
1176
1177 (defun rcirc-generate-new-buffer-name (process target)
1178   "Return a buffer name based on PROCESS and TARGET.
1179 This is used for the initial name given to IRC buffers."
1180   (substring-no-properties
1181    (if target
1182        (concat target "@" (process-name process))
1183      (concat "*" (process-name process) "*"))))
1184
1185 (defun rcirc-get-buffer (process target &optional server)
1186   "Return the buffer associated with the PROCESS and TARGET.
1187
1188 If optional argument SERVER is non-nil, return the server buffer
1189 if there is no existing buffer for TARGET, otherwise return nil."
1190   (with-rcirc-process-buffer process
1191     (if (null target)
1192         (current-buffer)
1193       (let ((buffer (cdr (assoc-string target rcirc-buffer-alist t))))
1194         (or buffer (when server (current-buffer)))))))
1195
1196 (defun rcirc-get-buffer-create (process target)
1197   "Return the buffer associated with the PROCESS and TARGET.
1198 Create the buffer if it doesn't exist."
1199   (let ((buffer (rcirc-get-buffer process target)))
1200     (if (and buffer (buffer-live-p buffer))
1201         (with-current-buffer buffer
1202           (when (not rcirc-target)
1203             (setq rcirc-target target))
1204           buffer)
1205       ;; create the buffer
1206       (with-rcirc-process-buffer process
1207         (let ((new-buffer (get-buffer-create
1208                            (rcirc-generate-new-buffer-name process target))))
1209           (with-current-buffer new-buffer
1210             (rcirc-mode process target)
1211             (rcirc-put-nick-channel process (rcirc-nick process) target
1212                                     rcirc-current-line))
1213           new-buffer)))))
1214
1215 (defun rcirc-send-input ()
1216   "Send input to target associated with the current buffer."
1217   (interactive)
1218   (if (< (point) rcirc-prompt-end-marker)
1219       ;; copy the line down to the input area
1220       (progn
1221         (forward-line 0)
1222         (let ((start (if (eq (point) (point-min))
1223                          (point)
1224                        (if (get-text-property (1- (point)) 'hard)
1225                            (point)
1226                          (previous-single-property-change (point) 'hard))))
1227               (end (next-single-property-change (1+ (point)) 'hard)))
1228           (goto-char (point-max))
1229           (insert (replace-regexp-in-string
1230                    "\n\\s-+" " "
1231                    (buffer-substring-no-properties start end)))))
1232     ;; process input
1233     (goto-char (point-max))
1234     (when (not (equal 0 (- (point) rcirc-prompt-end-marker)))
1235       ;; delete a trailing newline
1236       (when (eq (point) (point-at-bol))
1237         (delete-char -1))
1238       (let ((input (buffer-substring-no-properties
1239                     rcirc-prompt-end-marker (point))))
1240         (dolist (line (split-string input "\n"))
1241           (rcirc-process-input-line line))
1242         ;; add to input-ring
1243         (save-excursion
1244           (ring-insert rcirc-input-ring input)
1245           (setq rcirc-input-ring-index 0))))))
1246
1247 (defun rcirc-fill-paragraph (&optional justify)
1248   (interactive "P")
1249   (when (> (point) rcirc-prompt-end-marker)
1250     (save-restriction
1251       (narrow-to-region rcirc-prompt-end-marker (point-max))
1252       (let ((fill-column rcirc-max-message-length))
1253         (fill-region (point-min) (point-max) justify)))))
1254
1255 (defun rcirc-process-input-line (line)
1256   (if (string-match "^/\\([^ ]+\\) ?\\(.*\\)$" line)
1257       (rcirc-process-command (match-string 1 line)
1258                              (match-string 2 line)
1259                              line)
1260     (rcirc-process-message line)))
1261
1262 (defun rcirc-process-message (line)
1263   (if (not rcirc-target)
1264       (message "Not joined (no target)")
1265     (delete-region rcirc-prompt-end-marker (point))
1266     (rcirc-send-message (rcirc-buffer-process) rcirc-target line)
1267     (setq rcirc-last-post-time (current-time))))
1268
1269 (defun rcirc-process-command (command args line)
1270   (if (eq (aref command 0) ?/)
1271       ;; "//text" will send "/text" as a message
1272       (rcirc-process-message (substring line 1))
1273     (let ((fun (intern-soft (concat "rcirc-cmd-" command)))
1274           (process (rcirc-buffer-process)))
1275       (newline)
1276       (with-current-buffer (current-buffer)
1277         (delete-region rcirc-prompt-end-marker (point))
1278         (if (string= command "me")
1279             (rcirc-print process (rcirc-buffer-nick)
1280                          "ACTION" rcirc-target args)
1281           (rcirc-print process (rcirc-buffer-nick)
1282                        "COMMAND" rcirc-target line))
1283         (set-marker rcirc-prompt-end-marker (point))
1284         (if (fboundp fun)
1285             (funcall fun args process rcirc-target)
1286           (rcirc-send-string process
1287                              (concat command " :" args)))))))
1288
1289 (defvar rcirc-parent-buffer nil)
1290 (make-variable-buffer-local 'rcirc-parent-buffer)
1291 (put 'rcirc-parent-buffer 'permanent-local t)
1292 (defvar rcirc-window-configuration nil)
1293 (defun rcirc-edit-multiline ()
1294   "Move current edit to a dedicated buffer."
1295   (interactive)
1296   (let ((pos (1+ (- (point) rcirc-prompt-end-marker))))
1297     (goto-char (point-max))
1298     (let ((text (buffer-substring-no-properties rcirc-prompt-end-marker
1299                                                 (point)))
1300           (parent (buffer-name)))
1301       (delete-region rcirc-prompt-end-marker (point))
1302       (setq rcirc-window-configuration (current-window-configuration))
1303       (pop-to-buffer (concat "*multiline " parent "*"))
1304       (funcall rcirc-multiline-major-mode)
1305       (rcirc-multiline-minor-mode 1)
1306       (setq rcirc-parent-buffer parent)
1307       (insert text)
1308       (and (> pos 0) (goto-char pos))
1309       (message "Type C-c C-c to return text to %s, or C-c C-k to cancel" parent))))
1310
1311 (defvar rcirc-multiline-minor-mode-map
1312   (let ((map (make-sparse-keymap)))
1313     (define-key map (kbd "C-c C-c") 'rcirc-multiline-minor-submit)
1314     (define-key map (kbd "C-x C-s") 'rcirc-multiline-minor-submit)
1315     (define-key map (kbd "C-c C-k") 'rcirc-multiline-minor-cancel)
1316     (define-key map (kbd "ESC ESC ESC") 'rcirc-multiline-minor-cancel)
1317     map)
1318   "Keymap for multiline mode in rcirc.")
1319
1320 (define-minor-mode rcirc-multiline-minor-mode
1321   "Minor mode for editing multiple lines in rcirc.
1322 With a prefix argument ARG, enable the mode if ARG is positive,
1323 and disable it otherwise.  If called from Lisp, enable the mode
1324 if ARG is omitted or nil."
1325   :init-value nil
1326   :lighter " rcirc-mline"
1327   :keymap rcirc-multiline-minor-mode-map
1328   :global nil
1329   :group 'rcirc
1330   (setq fill-column rcirc-max-message-length))
1331
1332 (defun rcirc-multiline-minor-submit ()
1333   "Send the text in buffer back to parent buffer."
1334   (interactive)
1335   (untabify (point-min) (point-max))
1336   (let ((text (buffer-substring (point-min) (point-max)))
1337         (buffer (current-buffer))
1338         (pos (point)))
1339     (set-buffer rcirc-parent-buffer)
1340     (goto-char (point-max))
1341     (insert text)
1342     (kill-buffer buffer)
1343     (set-window-configuration rcirc-window-configuration)
1344     (goto-char (+ rcirc-prompt-end-marker (1- pos)))))
1345
1346 (defun rcirc-multiline-minor-cancel ()
1347   "Cancel the multiline edit."
1348   (interactive)
1349   (kill-buffer (current-buffer))
1350   (set-window-configuration rcirc-window-configuration))
1351
1352 (defun rcirc-any-buffer (process)
1353   "Return a buffer for PROCESS, either the one selected or the process buffer."
1354   (if rcirc-always-use-server-buffer-flag
1355       (process-buffer process)
1356     (let ((buffer (window-buffer)))
1357       (if (and buffer
1358                (with-current-buffer buffer
1359                  (and (eq major-mode 'rcirc-mode)
1360                       (eq (rcirc-buffer-process) process))))
1361           buffer
1362         (process-buffer process)))))
1363
1364 (defcustom rcirc-response-formats
1365   '(("PRIVMSG" . "<%N> %m")
1366     ("NOTICE"  . "-%N- %m")
1367     ("ACTION"  . "[%N %m]")
1368     ("COMMAND" . "%m")
1369     ("ERROR"   . "%fw!!! %m")
1370     (t         . "%fp*** %fs%n %r %m"))
1371   "An alist of formats used for printing responses.
1372 The format is looked up using the response-type as a key;
1373 if no match is found, the default entry (with a key of `t') is used.
1374
1375 The entry's value part should be a string, which is inserted with
1376 the of the following escape sequences replaced by the described values:
1377
1378   %m        The message text
1379   %n        The sender's nick
1380   %N        The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
1381   %r        The response-type
1382   %t        The target
1383   %fw       Following text uses the face `font-lock-warning-face'
1384   %fp       Following text uses the face `rcirc-server-prefix'
1385   %fs       Following text uses the face `rcirc-server'
1386   %f[FACE]  Following text uses the face FACE
1387   %f-       Following text uses the default face
1388   %%        A literal `%' character"
1389   :type '(alist :key-type (choice (string :tag "Type")
1390                                   (const :tag "Default" t))
1391                 :value-type string)
1392   :group 'rcirc)
1393
1394 (defcustom rcirc-omit-responses
1395   '("JOIN" "PART" "QUIT" "NICK")
1396   "Responses which will be hidden when `rcirc-omit-mode' is enabled."
1397   :type '(repeat string)
1398   :group 'rcirc)
1399
1400 (defun rcirc-format-response-string (process sender response target text)
1401   "Return a nicely-formatted response string, incorporating TEXT
1402 \(and perhaps other arguments).  The specific formatting used
1403 is found by looking up RESPONSE in `rcirc-response-formats'."
1404   (with-temp-buffer
1405     (insert (or (cdr (assoc response rcirc-response-formats))
1406                 (cdr (assq t rcirc-response-formats))))
1407     (goto-char (point-min))
1408     (let ((start (point-min))
1409           (sender (if (or (not sender)
1410                           (string= (rcirc-server-name process) sender))
1411                       ""
1412                     sender))
1413           face)
1414       (while (re-search-forward "%\\(\\(f\\(.\\)\\)\\|\\(.\\)\\)" nil t)
1415         (rcirc-add-face start (match-beginning 0) face)
1416         (setq start (match-beginning 0))
1417         (replace-match
1418          (cl-case (aref (match-string 1) 0)
1419             (?f (setq face
1420                       (cl-case (string-to-char (match-string 3))
1421                         (?w 'font-lock-warning-face)
1422                         (?p 'rcirc-server-prefix)
1423                         (?s 'rcirc-server)
1424                         (t nil)))
1425                 "")
1426             (?n sender)
1427             (?N (let ((my-nick (rcirc-nick process)))
1428                   (save-match-data
1429                     (with-syntax-table rcirc-nick-syntax-table
1430                       (rcirc-facify sender
1431                                     (cond ((string= sender my-nick)
1432                                            'rcirc-my-nick)
1433                                           ((and rcirc-bright-nicks
1434                                                 (string-match
1435                                                  (regexp-opt rcirc-bright-nicks
1436                                                              'words)
1437                                                  sender))
1438                                            'rcirc-bright-nick)
1439                                           ((and rcirc-dim-nicks
1440                                                 (string-match
1441                                                  (regexp-opt rcirc-dim-nicks
1442                                                              'words)
1443                                                  sender))
1444                                            'rcirc-dim-nick)
1445                                           (t
1446                                            'rcirc-other-nick)))))))
1447             (?m (propertize text 'rcirc-text text))
1448             (?r response)
1449             (?t (or target ""))
1450             (t (concat "UNKNOWN CODE:" (match-string 0))))
1451          t t nil 0)
1452         (rcirc-add-face (match-beginning 0) (match-end 0) face))
1453       (rcirc-add-face start (match-beginning 0) face))
1454       (buffer-substring (point-min) (point-max))))
1455
1456 (defun rcirc-target-buffer (process sender response target _text)
1457   "Return a buffer to print the server response."
1458   (cl-assert (not (bufferp target)))
1459   (with-rcirc-process-buffer process
1460     (cond ((not target)
1461            (rcirc-any-buffer process))
1462           ((not (rcirc-channel-p target))
1463            ;; message from another user
1464            (if (or (string= response "PRIVMSG")
1465                    (string= response "ACTION"))
1466                (rcirc-get-buffer-create process (if (string= sender rcirc-nick)
1467                                                     target
1468                                                   sender))
1469              (rcirc-get-buffer process target t)))
1470           ((or (rcirc-get-buffer process target)
1471                (rcirc-any-buffer process))))))
1472
1473 (defvar rcirc-activity-types nil)
1474 (make-variable-buffer-local 'rcirc-activity-types)
1475 (defvar rcirc-last-sender nil)
1476 (make-variable-buffer-local 'rcirc-last-sender)
1477
1478 (defcustom rcirc-omit-threshold 100
1479   "Number of lines since last activity from a nick before `rcirc-omit-responses' are omitted."
1480   :type 'integer
1481   :group 'rcirc)
1482
1483 (defcustom rcirc-log-process-buffers nil
1484   "Non-nil if rcirc process buffers should be logged to disk."
1485   :group 'rcirc
1486   :type 'boolean
1487   :version "24.1")
1488
1489 (defun rcirc-last-quit-line (process nick target)
1490   "Return the line number where NICK left TARGET.
1491 Returns nil if the information is not recorded."
1492   (let ((chanbuf (rcirc-get-buffer process target)))
1493     (when chanbuf
1494       (cdr (assoc-string nick (with-current-buffer chanbuf
1495                                 rcirc-recent-quit-alist))))))
1496
1497 (defun rcirc-last-line (process nick target)
1498   "Return the line from the last activity from NICK in TARGET."
1499   (let ((line (or (cdr (assoc-string target
1500                                      (gethash nick (with-rcirc-server-buffer
1501                                                      rcirc-nick-table)) t))
1502                   (rcirc-last-quit-line process nick target))))
1503     (if line
1504         line
1505       ;;(message "line is nil for %s in %s" nick target)
1506       nil)))
1507
1508 (defun rcirc-elapsed-lines (process nick target)
1509   "Return the number of lines since activity from NICK in TARGET."
1510   (let ((last-activity-line (rcirc-last-line process nick target)))
1511     (when (and last-activity-line
1512                (> last-activity-line 0))
1513       (- rcirc-current-line last-activity-line))))
1514
1515 (defvar rcirc-markup-text-functions
1516   '(rcirc-markup-attributes
1517     rcirc-markup-my-nick
1518     rcirc-markup-urls
1519     rcirc-markup-keywords
1520     rcirc-markup-bright-nicks)
1521
1522   "List of functions used to manipulate text before it is printed.
1523
1524 Each function takes two arguments, SENDER, and RESPONSE.  The
1525 buffer is narrowed with the text to be printed and the point is
1526 at the beginning of the `rcirc-text' propertized text.")
1527
1528 (defun rcirc-print (process sender response target text &optional activity)
1529   "Print TEXT in the buffer associated with TARGET.
1530 Format based on SENDER and RESPONSE.  If ACTIVITY is non-nil,
1531 record activity."
1532   (or text (setq text ""))
1533   (unless (and (or (member sender rcirc-ignore-list)
1534                    (member (with-syntax-table rcirc-nick-syntax-table
1535                              (when (string-match "^\\([^/]\\w*\\)[:,]" text)
1536                                (match-string 1 text)))
1537                            rcirc-ignore-list))
1538                ;; do not ignore if we sent the message
1539                (not (string= sender (rcirc-nick process))))
1540     (let* ((buffer (rcirc-target-buffer process sender response target text))
1541            (inhibit-read-only t))
1542       (with-current-buffer buffer
1543         (let ((moving (= (point) rcirc-prompt-end-marker))
1544               (old-point (point-marker))
1545               (fill-start (marker-position rcirc-prompt-start-marker)))
1546
1547           (setq text (decode-coding-string text rcirc-decode-coding-system))
1548           (unless (string= sender (rcirc-nick process))
1549             ;; mark the line with overlay arrow
1550             (unless (or (marker-position overlay-arrow-position)
1551                         (get-buffer-window (current-buffer))
1552                         (member response rcirc-omit-responses))
1553               (set-marker overlay-arrow-position
1554                           (marker-position rcirc-prompt-start-marker))))
1555
1556           ;; temporarily set the marker insertion-type because
1557           ;; insert-before-markers results in hidden text in new buffers
1558           (goto-char rcirc-prompt-start-marker)
1559           (set-marker-insertion-type rcirc-prompt-start-marker t)
1560           (set-marker-insertion-type rcirc-prompt-end-marker t)
1561
1562           (let ((start (point)))
1563             (insert (rcirc-format-response-string process sender response nil
1564                                                   text)
1565                     (propertize "\n" 'hard t))
1566
1567             ;; squeeze spaces out of text before rcirc-text
1568             (fill-region fill-start
1569                          (1- (or (next-single-property-change fill-start
1570                                                               'rcirc-text)
1571                                  rcirc-prompt-end-marker)))
1572
1573             ;; run markup functions
1574             (save-excursion
1575               (save-restriction
1576                 (narrow-to-region start rcirc-prompt-start-marker)
1577                 (goto-char (or (next-single-property-change start 'rcirc-text)
1578                                (point)))
1579                 (when (rcirc-buffer-process)
1580                   (save-excursion (rcirc-markup-timestamp sender response))
1581                   (dolist (fn rcirc-markup-text-functions)
1582                     (save-excursion (funcall fn sender response)))
1583                   (when rcirc-fill-flag
1584                     (save-excursion (rcirc-markup-fill sender response))))
1585
1586                 (when rcirc-read-only-flag
1587                   (add-text-properties (point-min) (point-max)
1588                                        '(read-only t front-sticky t))))
1589               ;; make text omittable
1590               (let ((last-activity-lines (rcirc-elapsed-lines process sender target)))
1591                 (if (and (not (string= (rcirc-nick process) sender))
1592                          (member response rcirc-omit-responses)
1593                          (or (not last-activity-lines)
1594                              (< rcirc-omit-threshold last-activity-lines)))
1595                     (put-text-property (1- start) (1- rcirc-prompt-start-marker)
1596                                        'invisible 'rcirc-omit)
1597                   ;; otherwise increment the line count
1598                   (setq rcirc-current-line (1+ rcirc-current-line))))))
1599
1600           (set-marker-insertion-type rcirc-prompt-start-marker nil)
1601           (set-marker-insertion-type rcirc-prompt-end-marker nil)
1602
1603           ;; truncate buffer if it is very long
1604           (save-excursion
1605             (when (and rcirc-buffer-maximum-lines
1606                        (> rcirc-buffer-maximum-lines 0)
1607                        (= (forward-line (- rcirc-buffer-maximum-lines)) 0))
1608               (delete-region (point-min) (point))))
1609
1610           ;; set the window point for buffers show in windows
1611           (walk-windows (lambda (w)
1612                           (when (and (not (eq (selected-window) w))
1613                                      (eq (current-buffer)
1614                                          (window-buffer w))
1615                                      (>= (window-point w)
1616                                          rcirc-prompt-end-marker))
1617                               (set-window-point w (point-max))))
1618                         nil t)
1619
1620           ;; restore the point
1621           (goto-char (if moving rcirc-prompt-end-marker old-point))
1622
1623           ;; keep window on bottom line if it was already there
1624           (when rcirc-scroll-show-maximum-output
1625             (let ((window (get-buffer-window)))
1626               (when window
1627                 (with-selected-window window
1628                   (when (eq major-mode 'rcirc-mode)
1629                     (when (<= (- (window-height)
1630                                  (count-screen-lines (window-point)
1631                                                      (window-start))
1632                                  1)
1633                               0)
1634                       (recenter -1)))))))
1635
1636           ;; flush undo (can we do something smarter here?)
1637           (buffer-disable-undo)
1638           (buffer-enable-undo))
1639
1640         ;; record mode line activity
1641         (when (and activity
1642                    (not rcirc-ignore-buffer-activity-flag)
1643                    (not (and rcirc-dim-nicks sender
1644                              (string-match (regexp-opt rcirc-dim-nicks) sender)
1645                              (rcirc-channel-p target))))
1646               (rcirc-record-activity (current-buffer)
1647                                      (when (not (rcirc-channel-p rcirc-target))
1648                                        'nick)))
1649
1650         (when (and rcirc-log-flag
1651                    (or target
1652                        rcirc-log-process-buffers))
1653           (rcirc-log process sender response target text))
1654
1655         (sit-for 0)                     ; displayed text before hook
1656         (run-hook-with-args 'rcirc-print-functions
1657                             process sender response target text)))))
1658
1659 (defun rcirc-generate-log-filename (process target)
1660   (if target
1661       (rcirc-generate-new-buffer-name process target)
1662     (process-name process)))
1663
1664 (defcustom rcirc-log-filename-function 'rcirc-generate-log-filename
1665   "A function to generate the filename used by rcirc's logging facility.
1666
1667 It is called with two arguments, PROCESS and TARGET (see
1668 `rcirc-generate-new-buffer-name' for their meaning), and should
1669 return the filename, or nil if no logging is desired for this
1670 session.
1671
1672 If the returned filename is absolute (`file-name-absolute-p'
1673 returns t), then it is used as-is, otherwise the resulting file
1674 is put into `rcirc-log-directory'.
1675
1676 The filename is then cleaned using `convert-standard-filename' to
1677 guarantee valid filenames for the current OS."
1678   :group 'rcirc
1679   :type 'function)
1680
1681 (defun rcirc-log (process sender response target text)
1682   "Record line in `rcirc-log', to be later written to disk."
1683   (let ((filename (funcall rcirc-log-filename-function process target)))
1684     (unless (null filename)
1685       (let ((cell (assoc-string filename rcirc-log-alist))
1686             (line (concat (format-time-string rcirc-time-format)
1687                           (substring-no-properties
1688                            (rcirc-format-response-string process sender
1689                                                          response target text))
1690                           "\n")))
1691         (if cell
1692             (setcdr cell (concat (cdr cell) line))
1693           (setq rcirc-log-alist
1694                 (cons (cons filename line) rcirc-log-alist)))))))
1695
1696 (defun rcirc-log-write ()
1697   "Flush `rcirc-log-alist' data to disk.
1698
1699 Log data is written to `rcirc-log-directory', except for
1700 log-files with absolute names (see `rcirc-log-filename-function')."
1701   (dolist (cell rcirc-log-alist)
1702     (let ((filename (convert-standard-filename
1703                      (expand-file-name (car cell)
1704                                        rcirc-log-directory)))
1705           (coding-system-for-write 'utf-8))
1706       (make-directory (file-name-directory filename) t)
1707       (with-temp-buffer
1708         (insert (cdr cell))
1709         (write-region (point-min) (point-max) filename t 'quiet))))
1710   (setq rcirc-log-alist nil))
1711
1712 (defun rcirc-view-log-file ()
1713   "View logfile corresponding to the current buffer."
1714   (interactive)
1715   (find-file-other-window
1716    (expand-file-name (funcall rcirc-log-filename-function
1717                               (rcirc-buffer-process) rcirc-target)
1718                      rcirc-log-directory)))
1719
1720 (defun rcirc-join-channels (process channels)
1721   "Join CHANNELS."
1722   (save-window-excursion
1723     (dolist (channel channels)
1724       (with-rcirc-process-buffer process
1725         (rcirc-cmd-join channel process)))))
1726 \f
1727 ;;; nick management
1728 (defvar rcirc-nick-prefix-chars "~&@%+")
1729 (defun rcirc-user-nick (user)
1730   "Return the nick from USER.  Remove any non-nick junk."
1731   (save-match-data
1732     (if (string-match (concat "^[" rcirc-nick-prefix-chars
1733                               "]?\\([^! ]+\\)!?") (or user ""))
1734         (match-string 1 user)
1735       user)))
1736
1737 (defun rcirc-nick-channels (process nick)
1738   "Return list of channels for NICK."
1739   (with-rcirc-process-buffer process
1740     (mapcar (lambda (x) (car x))
1741             (gethash nick rcirc-nick-table))))
1742
1743 (defun rcirc-put-nick-channel (process nick channel &optional line)
1744   "Add CHANNEL to list associated with NICK.
1745 Update the associated linestamp if LINE is non-nil.
1746
1747 If the record doesn't exist, and LINE is nil, set the linestamp
1748 to zero."
1749   (let ((nick (rcirc-user-nick nick)))
1750     (with-rcirc-process-buffer process
1751       (let* ((chans (gethash nick rcirc-nick-table))
1752              (record (assoc-string channel chans t)))
1753         (if record
1754             (when line (setcdr record line))
1755           (puthash nick (cons (cons channel (or line 0))
1756                               chans)
1757                    rcirc-nick-table))))))
1758
1759 (defun rcirc-nick-remove (process nick)
1760   "Remove NICK from table."
1761   (with-rcirc-process-buffer process
1762     (remhash nick rcirc-nick-table)))
1763
1764 (defun rcirc-remove-nick-channel (process nick channel)
1765   "Remove the CHANNEL from list associated with NICK."
1766   (with-rcirc-process-buffer process
1767     (let* ((chans (gethash nick rcirc-nick-table))
1768            (newchans
1769             ;; instead of assoc-string-delete-all:
1770             (let ((record (assoc-string channel chans t)))
1771               (when record
1772                 (setcar record 'delete)
1773                 (assq-delete-all 'delete chans)))))
1774       (if newchans
1775           (puthash nick newchans rcirc-nick-table)
1776         (remhash nick rcirc-nick-table)))))
1777
1778 (defun rcirc-channel-nicks (process target)
1779   "Return the list of nicks associated with TARGET sorted by last activity."
1780   (when target
1781     (if (rcirc-channel-p target)
1782         (with-rcirc-process-buffer process
1783           (let (nicks)
1784             (maphash
1785              (lambda (k v)
1786                (let ((record (assoc-string target v t)))
1787                  (if record
1788                      (setq nicks (cons (cons k (cdr record)) nicks)))))
1789              rcirc-nick-table)
1790             (mapcar (lambda (x) (car x))
1791                     (sort nicks (lambda (x y)
1792                                   (let ((lx (or (cdr x) 0))
1793                                         (ly (or (cdr y) 0)))
1794                                     (< ly lx)))))))
1795       (list target))))
1796
1797 (defun rcirc-ignore-update-automatic (nick)
1798   "Remove NICK from `rcirc-ignore-list'
1799 if NICK is also on `rcirc-ignore-list-automatic'."
1800   (when (member nick rcirc-ignore-list-automatic)
1801       (setq rcirc-ignore-list-automatic
1802             (delete nick rcirc-ignore-list-automatic)
1803             rcirc-ignore-list
1804             (delete nick rcirc-ignore-list))))
1805 \f
1806 (defun rcirc-nickname< (s1 s2)
1807   "Return t if IRC nickname S1 is less than S2, and nil otherwise.
1808 Operator nicknames (@) are considered less than voiced
1809 nicknames (+).  Any other nicknames are greater than voiced
1810 nicknames.  The comparison is case-insensitive."
1811   (setq s1 (downcase s1)
1812         s2 (downcase s2))
1813   (let* ((s1-op (eq ?@ (string-to-char s1)))
1814          (s2-op (eq ?@ (string-to-char s2))))
1815     (if s1-op
1816         (if s2-op
1817             (string< (substring s1 1) (substring s2 1))
1818           t)
1819       (if s2-op
1820           nil
1821         (string< s1 s2)))))
1822
1823 (defun rcirc-sort-nicknames-join (input sep)
1824   "Return a string of sorted nicknames.
1825 INPUT is a string containing nicknames separated by SEP.
1826 This function does not alter the INPUT string."
1827   (let* ((parts (split-string input sep t))
1828          (sorted (sort parts 'rcirc-nickname<)))
1829     (mapconcat 'identity sorted sep)))
1830 \f
1831 ;;; activity tracking
1832 (defvar rcirc-track-minor-mode-map
1833   (let ((map (make-sparse-keymap)))
1834     (define-key map (kbd "C-c C-@") 'rcirc-next-active-buffer)
1835     (define-key map (kbd "C-c C-SPC") 'rcirc-next-active-buffer)
1836     map)
1837   "Keymap for rcirc track minor mode.")
1838
1839 ;;;###autoload
1840 (define-minor-mode rcirc-track-minor-mode
1841   "Global minor mode for tracking activity in rcirc buffers.
1842 With a prefix argument ARG, enable the mode if ARG is positive,
1843 and disable it otherwise.  If called from Lisp, enable the mode
1844 if ARG is omitted or nil."
1845   :init-value nil
1846   :lighter ""
1847   :keymap rcirc-track-minor-mode-map
1848   :global t
1849   :group 'rcirc
1850   (or global-mode-string (setq global-mode-string '("")))
1851   ;; toggle the mode-line channel indicator
1852   (if rcirc-track-minor-mode
1853       (progn
1854         (and (not (memq 'rcirc-activity-string global-mode-string))
1855              (setq global-mode-string
1856                    (append global-mode-string '(rcirc-activity-string))))
1857         (add-hook 'window-configuration-change-hook
1858                   'rcirc-window-configuration-change))
1859     (setq global-mode-string
1860           (delete 'rcirc-activity-string global-mode-string))
1861     (remove-hook 'window-configuration-change-hook
1862                  'rcirc-window-configuration-change)))
1863
1864 (or (assq 'rcirc-ignore-buffer-activity-flag minor-mode-alist)
1865     (setq minor-mode-alist
1866           (cons '(rcirc-ignore-buffer-activity-flag " Ignore") minor-mode-alist)))
1867 (or (assq 'rcirc-low-priority-flag minor-mode-alist)
1868     (setq minor-mode-alist
1869           (cons '(rcirc-low-priority-flag " LowPri") minor-mode-alist)))
1870 (or (assq 'rcirc-omit-mode minor-mode-alist)
1871     (setq minor-mode-alist
1872           (cons '(rcirc-omit-mode " Omit") minor-mode-alist)))
1873
1874 (defun rcirc-toggle-ignore-buffer-activity ()
1875   "Toggle the value of `rcirc-ignore-buffer-activity-flag'."
1876   (interactive)
1877   (setq rcirc-ignore-buffer-activity-flag
1878         (not rcirc-ignore-buffer-activity-flag))
1879   (message (if rcirc-ignore-buffer-activity-flag
1880                "Ignore activity in this buffer"
1881              "Notice activity in this buffer"))
1882   (force-mode-line-update))
1883
1884 (defun rcirc-toggle-low-priority ()
1885   "Toggle the value of `rcirc-low-priority-flag'."
1886   (interactive)
1887   (setq rcirc-low-priority-flag
1888         (not rcirc-low-priority-flag))
1889   (message (if rcirc-low-priority-flag
1890                "Activity in this buffer is low priority"
1891              "Activity in this buffer is normal priority"))
1892   (force-mode-line-update))
1893
1894 (defun rcirc-omit-mode ()
1895   "Toggle the Rcirc-Omit mode.
1896 If enabled, \"uninteresting\" lines are not shown.
1897 Uninteresting lines are those whose responses are listed in
1898 `rcirc-omit-responses'."
1899   (interactive)
1900   (setq rcirc-omit-mode (not rcirc-omit-mode))
1901   (if rcirc-omit-mode
1902       (progn
1903         (add-to-invisibility-spec '(rcirc-omit . nil))
1904         (message "Rcirc-Omit mode enabled"))
1905     (remove-from-invisibility-spec '(rcirc-omit . nil))
1906     (message "Rcirc-Omit mode disabled"))
1907   (dolist (window (get-buffer-window-list (current-buffer)))
1908     (with-selected-window window
1909       (recenter (when (> (point) rcirc-prompt-start-marker) -1)))))
1910
1911 (defun rcirc-switch-to-server-buffer ()
1912   "Switch to the server buffer associated with current channel buffer."
1913   (interactive)
1914   (unless (buffer-live-p rcirc-server-buffer)
1915     (error "No such buffer"))
1916   (switch-to-buffer rcirc-server-buffer))
1917
1918 (defun rcirc-jump-to-first-unread-line ()
1919   "Move the point to the first unread line in this buffer."
1920   (interactive)
1921   (if (marker-position overlay-arrow-position)
1922       (goto-char overlay-arrow-position)
1923     (message "No unread messages")))
1924
1925 (defun rcirc-non-irc-buffer ()
1926   (let ((buflist (buffer-list))
1927         buffer)
1928     (while (and buflist (not buffer))
1929       (with-current-buffer (car buflist)
1930         (unless (or (eq major-mode 'rcirc-mode)
1931                     (= ?\s (aref (buffer-name) 0)) ; internal buffers
1932                     (get-buffer-window (current-buffer)))
1933           (setq buffer (current-buffer))))
1934       (setq buflist (cdr buflist)))
1935     buffer))
1936
1937 (defun rcirc-next-active-buffer (arg)
1938   "Switch to the next rcirc buffer with activity.
1939 With prefix ARG, go to the next low priority buffer with activity."
1940   (interactive "P")
1941   (let* ((pair (rcirc-split-activity rcirc-activity))
1942          (lopri (car pair))
1943          (hipri (cdr pair)))
1944     (if (or (and (not arg) hipri)
1945             (and arg lopri))
1946         (progn
1947           (switch-to-buffer (car (if arg lopri hipri)))
1948           (when (> (point) rcirc-prompt-start-marker)
1949             (recenter -1)))
1950       (if (eq major-mode 'rcirc-mode)
1951           (switch-to-buffer (rcirc-non-irc-buffer))
1952         (message "%s" (concat
1953                        "No IRC activity."
1954                        (when lopri
1955                          (concat
1956                           "  Type C-u "
1957                           (key-description (this-command-keys))
1958                           " for low priority activity."))))))))
1959
1960 (define-obsolete-variable-alias 'rcirc-activity-hooks
1961   'rcirc-activity-functions "24.3")
1962 (defvar rcirc-activity-functions nil
1963   "Hook to be run when there is channel activity.
1964
1965 Functions are called with a single argument, the buffer with the
1966 activity.  Only run if the buffer is not visible and
1967 `rcirc-ignore-buffer-activity-flag' is non-nil.")
1968
1969 (defun rcirc-record-activity (buffer &optional type)
1970   "Record BUFFER activity with TYPE."
1971   (with-current-buffer buffer
1972     (let ((old-activity rcirc-activity)
1973           (old-types rcirc-activity-types))
1974       (when (not (get-buffer-window (current-buffer) t))
1975         (setq rcirc-activity
1976               (sort (if (memq (current-buffer) rcirc-activity) rcirc-activity
1977                       (cons (current-buffer) rcirc-activity))
1978                     (lambda (b1 b2)
1979                       (let ((t1 (with-current-buffer b1 rcirc-last-post-time))
1980                             (t2 (with-current-buffer b2 rcirc-last-post-time)))
1981                         (time-less-p t2 t1)))))
1982         (cl-pushnew type rcirc-activity-types)
1983         (unless (and (equal rcirc-activity old-activity)
1984                      (member type old-types))
1985           (rcirc-update-activity-string)))))
1986   (run-hook-with-args 'rcirc-activity-functions buffer))
1987
1988 (defun rcirc-clear-activity (buffer)
1989   "Clear the BUFFER activity."
1990   (setq rcirc-activity (remove buffer rcirc-activity))
1991   (with-current-buffer buffer
1992     (setq rcirc-activity-types nil)))
1993
1994 (defun rcirc-clear-unread (buffer)
1995   "Erase the last read message arrow from BUFFER."
1996   (when (buffer-live-p buffer)
1997     (with-current-buffer buffer
1998       (set-marker overlay-arrow-position nil))))
1999
2000 (defun rcirc-split-activity (activity)
2001   "Return a cons cell with ACTIVITY split into (lopri . hipri)."
2002   (let (lopri hipri)
2003     (dolist (buf activity)
2004       (with-current-buffer buf
2005         (if (and rcirc-low-priority-flag
2006                  (not (member 'nick rcirc-activity-types)))
2007             (push buf lopri)
2008           (push buf hipri))))
2009     (cons (nreverse lopri) (nreverse hipri))))
2010
2011 (defvar rcirc-update-activity-string-hook nil
2012   "Hook run whenever the activity string is updated.")
2013
2014 ;; TODO: add mouse properties
2015 (defun rcirc-update-activity-string ()
2016   "Update mode-line string."
2017   (let* ((pair (rcirc-split-activity rcirc-activity))
2018          (lopri (car pair))
2019          (hipri (cdr pair)))
2020     (setq rcirc-activity-string
2021           (cond ((or hipri lopri)
2022                  (concat (and hipri "[")
2023                          (rcirc-activity-string hipri)
2024                          (and hipri lopri ",")
2025                          (and lopri
2026                               (concat "("
2027                                       (rcirc-activity-string lopri)
2028                                       ")"))
2029                          (and hipri "]")))
2030                 ((not (null (rcirc-process-list)))
2031                  "[]")
2032                 (t "[]")))
2033     (run-hooks 'rcirc-update-activity-string-hook)))
2034
2035 (defun rcirc-activity-string (buffers)
2036   (mapconcat (lambda (b)
2037                (let ((s (substring-no-properties (rcirc-short-buffer-name b))))
2038                  (with-current-buffer b
2039                    (dolist (type rcirc-activity-types)
2040                      (rcirc-add-face 0 (length s)
2041                                      (cl-case type
2042                                        (nick 'rcirc-track-nick)
2043                                        (keyword 'rcirc-track-keyword))
2044                                      s)))
2045                  s))
2046              buffers ","))
2047
2048 (defun rcirc-short-buffer-name (buffer)
2049   "Return a short name for BUFFER to use in the mode line indicator."
2050   (with-current-buffer buffer
2051     (or rcirc-short-buffer-name (buffer-name))))
2052
2053 (defun rcirc-visible-buffers ()
2054   "Return a list of the visible buffers that are in rcirc-mode."
2055   (let (acc)
2056     (walk-windows (lambda (w)
2057                     (with-current-buffer (window-buffer w)
2058                       (when (eq major-mode 'rcirc-mode)
2059                         (push (current-buffer) acc)))))
2060     acc))
2061
2062 (defvar rcirc-visible-buffers nil)
2063 (defun rcirc-window-configuration-change ()
2064   (unless (minibuffer-window-active-p (minibuffer-window))
2065     ;; delay this until command has finished to make sure window is
2066     ;; actually visible before clearing activity
2067     (add-hook 'post-command-hook 'rcirc-window-configuration-change-1)))
2068
2069 (defun rcirc-window-configuration-change-1 ()
2070   ;; clear activity and overlay arrows
2071   (let* ((old-activity rcirc-activity)
2072          (hidden-buffers rcirc-visible-buffers))
2073
2074     (setq rcirc-visible-buffers (rcirc-visible-buffers))
2075
2076     (dolist (vbuf rcirc-visible-buffers)
2077       (setq hidden-buffers (delq vbuf hidden-buffers))
2078       ;; clear activity for all visible buffers
2079       (rcirc-clear-activity vbuf))
2080
2081     ;; clear unread arrow from recently hidden buffers
2082     (dolist (hbuf hidden-buffers)
2083       (rcirc-clear-unread hbuf))
2084
2085     ;; remove any killed buffers from list
2086     (setq rcirc-activity
2087           (delq nil (mapcar (lambda (buf) (when (buffer-live-p buf) buf))
2088                             rcirc-activity)))
2089     ;; update the mode-line string
2090     (unless (equal old-activity rcirc-activity)
2091       (rcirc-update-activity-string)))
2092
2093   (remove-hook 'post-command-hook 'rcirc-window-configuration-change-1))
2094
2095 \f
2096 ;;; buffer name abbreviation
2097 (defun rcirc-update-short-buffer-names ()
2098   (let ((bufalist
2099          (apply 'append (mapcar (lambda (process)
2100                                   (with-rcirc-process-buffer process
2101                                     rcirc-buffer-alist))
2102                                 (rcirc-process-list)))))
2103     (dolist (i (rcirc-abbreviate bufalist))
2104       (when (buffer-live-p (cdr i))
2105         (with-current-buffer (cdr i)
2106           (setq rcirc-short-buffer-name (car i)))))))
2107
2108 (defun rcirc-abbreviate (pairs)
2109   (apply 'append (mapcar 'rcirc-rebuild-tree (rcirc-make-trees pairs))))
2110
2111 (defun rcirc-rebuild-tree (tree &optional acc)
2112   (let ((ch (char-to-string (car tree))))
2113     (dolist (x (cdr tree))
2114       (if (listp x)
2115           (setq acc (append acc
2116                            (mapcar (lambda (y)
2117                                      (cons (concat ch (car y))
2118                                            (cdr y)))
2119                                    (rcirc-rebuild-tree x))))
2120         (setq acc (cons (cons ch x) acc))))
2121     acc))
2122
2123 (defun rcirc-make-trees (pairs)
2124   (let (alist)
2125     (mapc (lambda (pair)
2126             (if (consp pair)
2127                 (let* ((str (car pair))
2128                        (data (cdr pair))
2129                        (char (unless (zerop (length str))
2130                                (aref str 0)))
2131                        (rest (unless (zerop (length str))
2132                                (substring str 1)))
2133                        (part (if char (assq char alist))))
2134                   (if part
2135                       ;; existing partition
2136                       (setcdr part (cons (cons rest data) (cdr part)))
2137                     ;; new partition
2138                     (setq alist (cons (if char
2139                                           (list char (cons rest data))
2140                                         data)
2141                                       alist))))
2142               (setq alist (cons pair alist))))
2143           pairs)
2144     ;; recurse into cdrs of alist
2145     (mapc (lambda (x)
2146             (when (and (listp x) (listp (cadr x)))
2147               (setcdr x (if (> (length (cdr x)) 1)
2148                             (rcirc-make-trees (cdr x))
2149                           (setcdr x (list (cl-cdadr x)))))))
2150           alist)))
2151 \f
2152 ;;; /commands these are called with 3 args: PROCESS, TARGET, which is
2153 ;; the current buffer/channel/user, and ARGS, which is a string
2154 ;; containing the text following the /cmd.
2155
2156 (defmacro defun-rcirc-command (command argument docstring interactive-form
2157                                        &rest body)
2158   "Define a command."
2159   `(progn
2160      (add-to-list 'rcirc-client-commands ,(concat "/" (symbol-name command)))
2161      (defun ,(intern (concat "rcirc-cmd-" (symbol-name command)))
2162        (,@argument &optional process target)
2163        ,(concat docstring "\n\nNote: If PROCESS or TARGET are nil, the values given"
2164                 "\nby `rcirc-buffer-process' and `rcirc-target' will be used.")
2165        ,interactive-form
2166        (let ((process (or process (rcirc-buffer-process)))
2167              (target (or target rcirc-target)))
2168          ,@body))))
2169
2170 (defun-rcirc-command msg (message)
2171   "Send private MESSAGE to TARGET."
2172   (interactive "i")
2173   (if (null message)
2174       (progn
2175         (setq target (completing-read "Message nick: "
2176                                       (with-rcirc-server-buffer
2177                                         rcirc-nick-table)))
2178         (when (> (length target) 0)
2179           (setq message (read-string (format "Message %s: " target)))
2180           (when (> (length message) 0)
2181             (rcirc-send-message process target message))))
2182     (if (not (string-match "\\([^ ]+\\) \\(.+\\)" message))
2183         (message "Not enough args, or something.")
2184       (setq target (match-string 1 message)
2185             message (match-string 2 message))
2186       (rcirc-send-message process target message))))
2187
2188 (defun-rcirc-command query (nick)
2189   "Open a private chat buffer to NICK."
2190   (interactive (list (completing-read "Query nick: "
2191                                       (with-rcirc-server-buffer rcirc-nick-table))))
2192   (let ((existing-buffer (rcirc-get-buffer process nick)))
2193     (switch-to-buffer (or existing-buffer
2194                           (rcirc-get-buffer-create process nick)))
2195     (when (not existing-buffer)
2196       (rcirc-cmd-whois nick))))
2197
2198 (defun-rcirc-command join (channels)
2199   "Join CHANNELS.
2200 CHANNELS is a comma- or space-separated string of channel names."
2201   (interactive "sJoin channels: ")
2202   (let* ((split-channels (split-string channels "[ ,]" t))
2203          (buffers (mapcar (lambda (ch)
2204                             (rcirc-get-buffer-create process ch))
2205                           split-channels))
2206          (channels (mapconcat 'identity split-channels ",")))
2207     (rcirc-send-string process (concat "JOIN " channels))
2208     (when (not (eq (selected-window) (minibuffer-window)))
2209       (dolist (b buffers) ;; order the new channel buffers in the buffer list
2210         (switch-to-buffer b)))))
2211
2212 (defun-rcirc-command invite (nick-channel)
2213   "Invite NICK to CHANNEL."
2214   (interactive (list
2215                 (concat
2216                  (completing-read "Invite nick: "
2217                                   (with-rcirc-server-buffer rcirc-nick-table))
2218                  " "
2219                  (read-string "Channel: "))))
2220   (rcirc-send-string process (concat "INVITE " nick-channel)))
2221
2222 ;; TODO: /part #channel reason, or consider removing #channel altogether
2223 (defun-rcirc-command part (channel)
2224   "Part CHANNEL."
2225   (interactive "sPart channel: ")
2226   (let ((channel (if (> (length channel) 0) channel target)))
2227     (rcirc-send-string process (concat "PART " channel " :" rcirc-id-string))))
2228
2229 (defun-rcirc-command quit (reason)
2230   "Send a quit message to server with REASON."
2231   (interactive "sQuit reason: ")
2232   (rcirc-send-string process (concat "QUIT :"
2233                                      (if (not (zerop (length reason)))
2234                                          reason
2235                                        rcirc-id-string))))
2236
2237 (defun-rcirc-command reconnect (_)
2238   "Reconnect to current server."
2239   (interactive "i")
2240   (with-rcirc-server-buffer
2241     (cond
2242      (rcirc-connecting (message "Already connecting"))
2243      ((process-live-p process) (message "Server process is alive"))
2244      (t (let ((conn-info rcirc-connection-info))
2245           (setf (nth 5 conn-info)
2246                 (cl-remove-if-not #'rcirc-channel-p
2247                                   (mapcar #'car rcirc-buffer-alist)))
2248           (apply #'rcirc-connect conn-info))))))
2249
2250 (defun-rcirc-command nick (nick)
2251   "Change nick to NICK."
2252   (interactive "i")
2253   (when (null nick)
2254     (setq nick (read-string "New nick: " (rcirc-nick process))))
2255   (rcirc-send-string process (concat "NICK " nick)))
2256
2257 (defun-rcirc-command names (channel)
2258   "Display list of names in CHANNEL or in current channel if CHANNEL is nil.
2259 If called interactively, prompt for a channel when prefix arg is supplied."
2260   (interactive "P")
2261   (if (called-interactively-p 'interactive)
2262       (if channel
2263           (setq channel (read-string "List names in channel: " target))))
2264   (let ((channel (if (> (length channel) 0)
2265                      channel
2266                    target)))
2267     (rcirc-send-string process (concat "NAMES " channel))))
2268
2269 (defun-rcirc-command topic (topic)
2270   "List TOPIC for the TARGET channel.
2271 With a prefix arg, prompt for new topic."
2272   (interactive "P")
2273   (if (and (called-interactively-p 'interactive) topic)
2274       (setq topic (read-string "New Topic: " rcirc-topic)))
2275   (rcirc-send-string process (concat "TOPIC " target
2276                                      (when (> (length topic) 0)
2277                                        (concat " :" topic)))))
2278
2279 (defun-rcirc-command whois (nick)
2280   "Request information from server about NICK."
2281   (interactive (list
2282                 (completing-read "Whois: "
2283                                  (with-rcirc-server-buffer rcirc-nick-table))))
2284   (rcirc-send-string process (concat "WHOIS " nick)))
2285
2286 (defun-rcirc-command mode (args)
2287   "Set mode with ARGS."
2288   (interactive (list (concat (read-string "Mode nick or channel: ")
2289                              " " (read-string "Mode: "))))
2290   (rcirc-send-string process (concat "MODE " args)))
2291
2292 (defun-rcirc-command list (channels)
2293   "Request information on CHANNELS from server."
2294   (interactive "sList Channels: ")
2295   (rcirc-send-string process (concat "LIST " channels)))
2296
2297 (defun-rcirc-command oper (args)
2298   "Send operator command to server."
2299   (interactive "sOper args: ")
2300   (rcirc-send-string process (concat "OPER " args)))
2301
2302 (defun-rcirc-command quote (message)
2303   "Send MESSAGE literally to server."
2304   (interactive "sServer message: ")
2305   (rcirc-send-string process message))
2306
2307 (defun-rcirc-command kick (arg)
2308   "Kick NICK from current channel."
2309   (interactive (list
2310                 (concat (completing-read "Kick nick: "
2311                                          (rcirc-channel-nicks
2312                                           (rcirc-buffer-process)
2313                                           rcirc-target))
2314                         (read-from-minibuffer "Kick reason: "))))
2315   (let* ((arglist (split-string arg))
2316          (argstring (concat (car arglist) " :"
2317                             (mapconcat 'identity (cdr arglist) " "))))
2318     (rcirc-send-string process (concat "KICK " target " " argstring))))
2319
2320 (defun rcirc-cmd-ctcp (args &optional process _target)
2321   (if (string-match "^\\([^ ]+\\)\\s-+\\(.+\\)$" args)
2322       (let* ((target (match-string 1 args))
2323              (request (upcase (match-string 2 args)))
2324              (function (intern-soft (concat "rcirc-ctcp-sender-" request))))
2325         (if (fboundp function) ;; use special function if available
2326             (funcall function process target request)
2327           (rcirc-send-ctcp process target request)))
2328     (rcirc-print process (rcirc-nick process) "ERROR" nil
2329                  "usage: /ctcp NICK REQUEST")))
2330
2331 (defun rcirc-ctcp-sender-PING (process target _request)
2332   "Send a CTCP PING message to TARGET."
2333   (let ((timestamp (format "%.0f" (rcirc-float-time))))
2334     (rcirc-send-ctcp process target "PING" timestamp)))
2335
2336 (defun rcirc-cmd-me (args &optional process target)
2337   (rcirc-send-ctcp process target "ACTION" args))
2338
2339 (defun rcirc-add-or-remove (set &rest elements)
2340   (dolist (elt elements)
2341     (if (and elt (not (string= "" elt)))
2342         (setq set (if (member-ignore-case elt set)
2343                       (delete elt set)
2344                     (cons elt set)))))
2345   set)
2346
2347 (defun-rcirc-command ignore (nick)
2348   "Manage the ignore list.
2349 Ignore NICK, unignore NICK if already ignored, or list ignored
2350 nicks when no NICK is given.  When listing ignored nicks, the
2351 ones added to the list automatically are marked with an asterisk."
2352   (interactive "sToggle ignoring of nick: ")
2353   (setq rcirc-ignore-list
2354         (apply #'rcirc-add-or-remove rcirc-ignore-list
2355                (split-string nick nil t)))
2356   (rcirc-print process nil "IGNORE" target
2357                (mapconcat
2358                 (lambda (nick)
2359                   (concat nick
2360                           (if (member nick rcirc-ignore-list-automatic)
2361                               "*" "")))
2362                 rcirc-ignore-list " ")))
2363
2364 (defun-rcirc-command bright (nick)
2365   "Manage the bright nick list."
2366   (interactive "sToggle emphasis of nick: ")
2367   (setq rcirc-bright-nicks
2368         (apply #'rcirc-add-or-remove rcirc-bright-nicks
2369                (split-string nick nil t)))
2370   (rcirc-print process nil "BRIGHT" target
2371                (mapconcat 'identity rcirc-bright-nicks " ")))
2372
2373 (defun-rcirc-command dim (nick)
2374   "Manage the dim nick list."
2375   (interactive "sToggle deemphasis of nick: ")
2376   (setq rcirc-dim-nicks
2377         (apply #'rcirc-add-or-remove rcirc-dim-nicks
2378                (split-string nick nil t)))
2379   (rcirc-print process nil "DIM" target
2380                (mapconcat 'identity rcirc-dim-nicks " ")))
2381
2382 (defun-rcirc-command keyword (keyword)
2383   "Manage the keyword list.
2384 Mark KEYWORD, unmark KEYWORD if already marked, or list marked
2385 keywords when no KEYWORD is given."
2386   (interactive "sToggle highlighting of keyword: ")
2387   (setq rcirc-keywords
2388         (apply #'rcirc-add-or-remove rcirc-keywords
2389                (split-string keyword nil t)))
2390   (rcirc-print process nil "KEYWORD" target
2391                (mapconcat 'identity rcirc-keywords " ")))
2392
2393 \f
2394 (defun rcirc-add-face (start end name &optional object)
2395   "Add face NAME to the face text property of the text from START to END."
2396   (when name
2397     (let ((pos start)
2398           next prop)
2399       (while (< pos end)
2400         (setq prop (get-text-property pos 'font-lock-face object)
2401               next (next-single-property-change pos 'font-lock-face object end))
2402         (unless (member name (get-text-property pos 'font-lock-face object))
2403           (add-text-properties pos next
2404                                (list 'font-lock-face (cons name prop)) object))
2405         (setq pos next)))))
2406
2407 (defun rcirc-facify (string face)
2408   "Return a copy of STRING with FACE property added."
2409   (let ((string (or string "")))
2410     (rcirc-add-face 0 (length string) face string)
2411     string))
2412
2413 (defvar rcirc-url-regexp
2414   (concat
2415    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
2416    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
2417    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
2418    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
2419        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
2420              (punct "!?:;.,"))
2421          (concat
2422           "\\(?:"
2423           ;; Match paired parentheses, e.g. in Wikipedia URLs:
2424           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]"
2425           "\\|"
2426           "[" chars punct     "]+" "[" chars "]"
2427           "\\)"))
2428      (concat ;; XEmacs 21.4 doesn't support POSIX.
2429       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
2430       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
2431    "\\)")
2432   "Regexp matching URLs.  Set to nil to disable URL features in rcirc.")
2433
2434 ;; cf cl-remove-if-not
2435 (defun rcirc-condition-filter (condp lst)
2436   "Remove all items not satisfying condition CONDP in list LST.
2437 CONDP is a function that takes a list element as argument and returns
2438 non-nil if that element should be included.  Returns a new list."
2439   (delq nil (mapcar (lambda (x) (and (funcall condp x) x)) lst)))
2440
2441 (defun rcirc-browse-url (&optional arg)
2442   "Prompt for URL to browse based on URLs in buffer before point.
2443
2444 If ARG is given, opens the URL in a new browser window."
2445   (interactive "P")
2446   (let* ((point (point))
2447          (filtered (rcirc-condition-filter
2448                     (lambda (x) (>= point (cdr x)))
2449                     rcirc-urls))
2450          (completions (mapcar (lambda (x) (car x)) filtered))
2451          (defaults (mapcar (lambda (x) (car x)) filtered)))
2452     (browse-url (completing-read "Rcirc browse-url: "
2453                                  completions nil nil (car defaults) nil defaults)
2454                 arg)))
2455 \f
2456 (defun rcirc-markup-timestamp (_sender _response)
2457   (goto-char (point-min))
2458   (insert (rcirc-facify (format-time-string rcirc-time-format)
2459                         'rcirc-timestamp)))
2460
2461 (defun rcirc-markup-attributes (_sender _response)
2462   (while (re-search-forward "\\([\C-b\C-_\C-v]\\).*?\\(\\1\\|\C-o\\)" nil t)
2463     (rcirc-add-face (match-beginning 0) (match-end 0)
2464                     (cl-case (char-after (match-beginning 1))
2465                       (?\C-b 'bold)
2466                       (?\C-v 'italic)
2467                       (?\C-_ 'underline)))
2468     ;; keep the ^O since it could terminate other attributes
2469     (when (not (eq ?\C-o (char-before (match-end 2))))
2470       (delete-region (match-beginning 2) (match-end 2)))
2471     (delete-region (match-beginning 1) (match-end 1))
2472     (goto-char (match-beginning 1)))
2473   ;; remove the ^O characters now
2474   (goto-char (point-min))
2475   (while (re-search-forward "\C-o+" nil t)
2476     (delete-region (match-beginning 0) (match-end 0))))
2477
2478 (defun rcirc-markup-my-nick (_sender response)
2479   (with-syntax-table rcirc-nick-syntax-table
2480     (while (re-search-forward (concat "\\b"
2481                                       (regexp-quote (rcirc-nick
2482                                                      (rcirc-buffer-process)))
2483                                       "\\b")
2484                               nil t)
2485       (rcirc-add-face (match-beginning 0) (match-end 0)
2486                       'rcirc-nick-in-message)
2487       (when (string= response "PRIVMSG")
2488         (rcirc-add-face (point-min) (point-max)
2489                         'rcirc-nick-in-message-full-line)
2490         (rcirc-record-activity (current-buffer) 'nick)))))
2491
2492 (defun rcirc-markup-urls (_sender _response)
2493   (while (and rcirc-url-regexp ;; nil means disable URL catching
2494               (re-search-forward rcirc-url-regexp nil t))
2495     (let* ((start (match-beginning 0))
2496            (end (match-end 0))
2497            (url (match-string-no-properties 0))
2498            (link-text (buffer-substring-no-properties start end)))
2499       (make-button start end
2500                    'face 'rcirc-url
2501                    'follow-link t
2502                    'rcirc-url url
2503                    'action (lambda (button)
2504                              (browse-url (button-get button 'rcirc-url))))
2505       ;; record the url if it is not already the latest stored url
2506       (when (not (string= link-text (caar rcirc-urls)))
2507         (push (cons link-text start) rcirc-urls)))))
2508
2509 (defun rcirc-markup-keywords (sender response)
2510   (when (and (string= response "PRIVMSG")
2511              (not (string= sender (rcirc-nick (rcirc-buffer-process)))))
2512     (let* ((target (or rcirc-target ""))
2513            (keywords (delq nil (mapcar (lambda (keyword)
2514                                          (when (not (string-match keyword
2515                                                                   target))
2516                                            keyword))
2517                                        rcirc-keywords))))
2518       (when keywords
2519         (while (re-search-forward (regexp-opt keywords 'words) nil t)
2520           (rcirc-add-face (match-beginning 0) (match-end 0) 'rcirc-keyword)
2521           (rcirc-record-activity (current-buffer) 'keyword))))))
2522
2523 (defun rcirc-markup-bright-nicks (_sender response)
2524   (when (and rcirc-bright-nicks
2525              (string= response "NAMES"))
2526     (with-syntax-table rcirc-nick-syntax-table
2527       (while (re-search-forward (regexp-opt rcirc-bright-nicks 'words) nil t)
2528         (rcirc-add-face (match-beginning 0) (match-end 0)
2529                         'rcirc-bright-nick)))))
2530
2531 (defun rcirc-markup-fill (_sender response)
2532   (when (not (string= response "372"))  ; /motd
2533     (let ((fill-prefix
2534            (or rcirc-fill-prefix
2535                (make-string (- (point) (line-beginning-position)) ?\s)))
2536           (fill-column (- (cond ((eq rcirc-fill-column 'frame-width)
2537                                  (1- (frame-width)))
2538                                 (rcirc-fill-column
2539                                  rcirc-fill-column)
2540                                 (t fill-column))
2541                           ;; make sure ... doesn't cause line wrapping
2542                           3)))
2543       (fill-region (point) (point-max) nil t))))
2544 \f
2545 ;;; handlers
2546 ;; these are called with the server PROCESS, the SENDER, which is a
2547 ;; server or a user, depending on the command, the ARGS, which is a
2548 ;; list of strings, and the TEXT, which is the original server text,
2549 ;; verbatim
2550 (defun rcirc-handler-001 (process sender args text)
2551   (rcirc-handler-generic process "001" sender args text)
2552   (with-rcirc-process-buffer process
2553     (setq rcirc-connecting nil)
2554     (rcirc-reschedule-timeout process)
2555     (setq rcirc-server-name sender)
2556     (setq rcirc-nick (car args))
2557     (rcirc-update-prompt)
2558     (if rcirc-auto-authenticate-flag
2559         (if (and rcirc-authenticate-before-join
2560                  ;; We have to ensure that there's an authentication
2561                  ;; entry for that server.  Else,
2562                  ;; rcirc-authenticated-hook won't be triggered, and
2563                  ;; autojoin won't happen at all.
2564                  (let (auth-required)
2565                    (dolist (s rcirc-authinfo auth-required)
2566                      (when (string-match (car s) rcirc-server-name)
2567                        (setq auth-required t)))))
2568             (progn
2569               (add-hook 'rcirc-authenticated-hook 'rcirc-join-channels-post-auth t t)
2570               (rcirc-authenticate))
2571           (rcirc-authenticate)
2572           (rcirc-join-channels process rcirc-startup-channels))
2573       (rcirc-join-channels process rcirc-startup-channels))))
2574
2575 (defun rcirc-join-channels-post-auth (process)
2576   "Join `rcirc-startup-channels' after authenticating."
2577   (with-rcirc-process-buffer process
2578     (rcirc-join-channels process rcirc-startup-channels)))
2579
2580 (defun rcirc-handler-PRIVMSG (process sender args text)
2581   (rcirc-check-auth-status process sender args text)
2582   (let ((target (if (rcirc-channel-p (car args))
2583                     (car args)
2584                   sender))
2585         (message (or (cadr args) "")))
2586     (if (string-match "^\C-a\\(.*\\)\C-a$" message)
2587         (rcirc-handler-CTCP process target sender (match-string 1 message))
2588       (rcirc-print process sender "PRIVMSG" target message t))
2589     ;; update nick linestamp
2590     (with-current-buffer (rcirc-get-buffer process target t)
2591       (rcirc-put-nick-channel process sender target rcirc-current-line))))
2592
2593 (defun rcirc-handler-NOTICE (process sender args text)
2594   (rcirc-check-auth-status process sender args text)
2595   (let ((target (car args))
2596         (message (cadr args)))
2597     (if (string-match "^\C-a\\(.*\\)\C-a$" message)
2598         (rcirc-handler-CTCP-response process target sender
2599                                      (match-string 1 message))
2600       (rcirc-print process sender "NOTICE"
2601                    (cond ((rcirc-channel-p target)
2602                           target)
2603                          ;;; -ChanServ- [#gnu] Welcome...
2604                          ((string-match "\\[\\(#[^\] ]+\\)\\]" message)
2605                           (match-string 1 message))
2606                          (sender
2607                           (if (string= sender (rcirc-server-name process))
2608                               nil       ; server notice
2609                             sender)))
2610                  message t))))
2611
2612 (defun rcirc-check-auth-status (process sender args _text)
2613   "Check if the user just authenticated.
2614 If authenticated, runs `rcirc-authenticated-hook' with PROCESS as
2615 the only argument."
2616   (with-rcirc-process-buffer process
2617     (when (and (not rcirc-user-authenticated)
2618                rcirc-authenticate-before-join
2619                rcirc-auto-authenticate-flag)
2620       (let ((target (car args))
2621             (message (cadr args)))
2622         (when (or
2623                (and ;; nickserv
2624                 (string= sender "NickServ")
2625                 (string= target rcirc-nick)
2626                 (member message
2627                         (list
2628                          (format "You are now identified for \C-b%s\C-b." rcirc-nick)
2629                          (format "You are successfully identified as \C-b%s\C-b." rcirc-nick)
2630                          "Password accepted - you are now recognized."
2631                          )))
2632                (and ;; quakenet
2633                 (string= sender "Q")
2634                 (string= target rcirc-nick)
2635                 (string-match "\\`You are now logged in as .+\\.\\'" message)))
2636           (setq rcirc-user-authenticated t)
2637           (run-hook-with-args 'rcirc-authenticated-hook process)
2638           (remove-hook 'rcirc-authenticated-hook 'rcirc-join-channels-post-auth t))))))
2639
2640 (defun rcirc-handler-WALLOPS (process sender args _text)
2641   (rcirc-print process sender "WALLOPS" sender (car args) t))
2642
2643 (defun rcirc-handler-JOIN (process sender args _text)
2644   (let ((channel (car args)))
2645     (with-current-buffer (rcirc-get-buffer-create process channel)
2646       ;; when recently rejoining, restore the linestamp
2647       (rcirc-put-nick-channel process sender channel
2648                               (let ((last-activity-lines
2649                                      (rcirc-elapsed-lines process sender channel)))
2650                                 (when (and last-activity-lines
2651                                            (< last-activity-lines rcirc-omit-threshold))
2652                                   (rcirc-last-line process sender channel))))
2653       ;; reset mode-line-process in case joining a channel with an
2654       ;; already open buffer (after getting kicked e.g.)
2655       (setq mode-line-process nil))
2656
2657     (rcirc-print process sender "JOIN" channel "")
2658
2659     ;; print in private chat buffer if it exists
2660     (when (rcirc-get-buffer (rcirc-buffer-process) sender)
2661       (rcirc-print process sender "JOIN" sender channel))))
2662
2663 ;; PART and KICK are handled the same way
2664 (defun rcirc-handler-PART-or-KICK (process _response channel _sender nick _args)
2665   (rcirc-ignore-update-automatic nick)
2666   (if (not (string= nick (rcirc-nick process)))
2667       ;; this is someone else leaving
2668       (progn
2669         (rcirc-maybe-remember-nick-quit process nick channel)
2670         (rcirc-remove-nick-channel process nick channel))
2671     ;; this is us leaving
2672     (mapc (lambda (n)
2673             (rcirc-remove-nick-channel process n channel))
2674           (rcirc-channel-nicks process channel))
2675
2676     ;; if the buffer is still around, make it inactive
2677     (let ((buffer (rcirc-get-buffer process channel)))
2678       (when buffer
2679         (rcirc-disconnect-buffer buffer)))))
2680
2681 (defun rcirc-handler-PART (process sender args _text)
2682   (let* ((channel (car args))
2683          (reason (cadr args))
2684          (message (concat channel " " reason)))
2685     (rcirc-print process sender "PART" channel message)
2686     ;; print in private chat buffer if it exists
2687     (when (rcirc-get-buffer (rcirc-buffer-process) sender)
2688       (rcirc-print process sender "PART" sender message))
2689
2690     (rcirc-handler-PART-or-KICK process "PART" channel sender sender reason)))
2691
2692 (defun rcirc-handler-KICK (process sender args _text)
2693   (let* ((channel (car args))
2694          (nick (cadr args))
2695          (reason (cl-caddr args))
2696          (message (concat nick " " channel " " reason)))
2697     (rcirc-print process sender "KICK" channel message t)
2698     ;; print in private chat buffer if it exists
2699     (when (rcirc-get-buffer (rcirc-buffer-process) nick)
2700       (rcirc-print process sender "KICK" nick message))
2701
2702     (rcirc-handler-PART-or-KICK process "KICK" channel sender nick reason)))
2703
2704 (defun rcirc-maybe-remember-nick-quit (process nick channel)
2705   "Remember NICK as leaving CHANNEL if they recently spoke."
2706   (let ((elapsed-lines (rcirc-elapsed-lines process nick channel)))
2707     (when (and elapsed-lines
2708                (< elapsed-lines rcirc-omit-threshold))
2709       (let ((buffer (rcirc-get-buffer process channel)))
2710         (when buffer
2711           (with-current-buffer buffer
2712             (let ((record (assoc-string nick rcirc-recent-quit-alist t))
2713                   (line (rcirc-last-line process nick channel)))
2714               (if record
2715                   (setcdr record line)
2716                 (setq rcirc-recent-quit-alist
2717                       (cons (cons nick line)
2718                             rcirc-recent-quit-alist))))))))))
2719
2720 (defun rcirc-handler-QUIT (process sender args _text)
2721   (rcirc-ignore-update-automatic sender)
2722   (mapc (lambda (channel)
2723           ;; broadcast quit message each channel
2724           (rcirc-print process sender "QUIT" channel (apply 'concat args))
2725           ;; record nick in quit table if they recently spoke
2726           (rcirc-maybe-remember-nick-quit process sender channel))
2727         (rcirc-nick-channels process sender))
2728   (rcirc-nick-remove process sender))
2729
2730 (defun rcirc-handler-NICK (process sender args _text)
2731   (let* ((old-nick sender)
2732          (new-nick (car args))
2733          (channels (rcirc-nick-channels process old-nick)))
2734     ;; update list of ignored nicks
2735     (rcirc-ignore-update-automatic old-nick)
2736     (when (member old-nick rcirc-ignore-list)
2737       (add-to-list 'rcirc-ignore-list new-nick)
2738       (add-to-list 'rcirc-ignore-list-automatic new-nick))
2739     ;; print message to nick's channels
2740     (dolist (target channels)
2741       (rcirc-print process sender "NICK" target new-nick))
2742     ;; update private chat buffer, if it exists
2743     (let ((chat-buffer (rcirc-get-buffer process old-nick)))
2744       (when chat-buffer
2745         (with-current-buffer chat-buffer
2746           (rcirc-print process sender "NICK" old-nick new-nick)
2747           (setq rcirc-target new-nick)
2748           (rename-buffer (rcirc-generate-new-buffer-name process new-nick)))))
2749     ;; remove old nick and add new one
2750     (with-rcirc-process-buffer process
2751       (let ((v (gethash old-nick rcirc-nick-table)))
2752         (remhash old-nick rcirc-nick-table)
2753         (puthash new-nick v rcirc-nick-table))
2754       ;; if this is our nick...
2755       (when (string= old-nick rcirc-nick)
2756         (setq rcirc-nick new-nick)
2757         (rcirc-update-prompt t)
2758         ;; reauthenticate
2759         (when rcirc-auto-authenticate-flag (rcirc-authenticate))))))
2760
2761 (defun rcirc-handler-PING (process _sender args _text)
2762   (rcirc-send-string process (concat "PONG :" (car args))))
2763
2764 (defun rcirc-handler-PONG (_process _sender _args _text)
2765   ;; do nothing
2766   )
2767
2768 (defun rcirc-handler-TOPIC (process sender args _text)
2769   (let ((topic (cadr args)))
2770     (rcirc-print process sender "TOPIC" (car args) topic)
2771     (with-current-buffer (rcirc-get-buffer process (car args))
2772       (setq rcirc-topic topic))))
2773
2774 (defvar rcirc-nick-away-alist nil)
2775 (defun rcirc-handler-301 (process _sender args text)
2776   "RPL_AWAY"
2777   (let* ((nick (cadr args))
2778          (rec (assoc-string nick rcirc-nick-away-alist))
2779          (away-message (cl-caddr args)))
2780     (when (or (not rec)
2781               (not (string= (cdr rec) away-message)))
2782       ;; away message has changed
2783       (rcirc-handler-generic process "AWAY" nick (cdr args) text)
2784       (if rec
2785           (setcdr rec away-message)
2786         (setq rcirc-nick-away-alist (cons (cons nick away-message)
2787                                           rcirc-nick-away-alist))))))
2788
2789 (defun rcirc-handler-317 (process sender args _text)
2790   "RPL_WHOISIDLE"
2791   (let* ((nick (nth 1 args))
2792          (idle-secs (string-to-number (nth 2 args)))
2793          (idle-string
2794           (if (< idle-secs most-positive-fixnum)
2795               (format-seconds "%yy %dd %hh %mm %z%ss" idle-secs)
2796             "a very long time"))
2797          (signon-time (seconds-to-time (string-to-number (nth 3 args))))
2798          (signon-string (format-time-string "%c" signon-time))
2799          (message (format "%s idle for %s, signed on %s"
2800                           nick idle-string signon-string)))
2801     (rcirc-print process sender "317" nil message t)))
2802
2803 (defun rcirc-handler-332 (process _sender args _text)
2804   "RPL_TOPIC"
2805   (let ((buffer (or (rcirc-get-buffer process (cadr args))
2806                     (rcirc-get-temp-buffer-create process (cadr args)))))
2807     (with-current-buffer buffer
2808       (setq rcirc-topic (cl-caddr args)))))
2809
2810 (defun rcirc-handler-333 (process sender args _text)
2811   "333 says who set the topic and when.
2812 Not in rfc1459.txt"
2813   (let ((buffer (or (rcirc-get-buffer process (cadr args))
2814                     (rcirc-get-temp-buffer-create process (cadr args)))))
2815     (with-current-buffer buffer
2816       (let ((setter (cl-caddr args))
2817             (time (current-time-string
2818                    (seconds-to-time
2819                     (string-to-number (cl-cadddr args))))))
2820         (rcirc-print process sender "TOPIC" (cadr args)
2821                      (format "%s (%s on %s)" rcirc-topic setter time))))))
2822
2823 (defun rcirc-handler-477 (process sender args _text)
2824   "ERR_NOCHANMODES"
2825   (rcirc-print process sender "477" (cadr args) (cl-caddr args)))
2826
2827 (defun rcirc-handler-MODE (process sender args _text)
2828   (let ((target (car args))
2829         (msg (mapconcat 'identity (cdr args) " ")))
2830     (rcirc-print process sender "MODE"
2831                  (if (string= target (rcirc-nick process))
2832                      nil
2833                    target)
2834                  msg)
2835
2836     ;; print in private chat buffers if they exist
2837     (mapc (lambda (nick)
2838             (when (rcirc-get-buffer process nick)
2839               (rcirc-print process sender "MODE" nick msg)))
2840           (cddr args))))
2841
2842 (defun rcirc-get-temp-buffer-create (process channel)
2843   "Return a buffer based on PROCESS and CHANNEL."
2844   (let ((tmpnam (concat " " (downcase channel) "TMP" (process-name process))))
2845     (get-buffer-create tmpnam)))
2846
2847 (defun rcirc-handler-353 (process _sender args _text)
2848   "RPL_NAMREPLY"
2849   (let ((channel (nth 2 args))
2850         (names (or (nth 3 args) "")))
2851     (mapc (lambda (nick)
2852             (rcirc-put-nick-channel process nick channel))
2853           (split-string names " " t))
2854     ;; create a temporary buffer to insert the names into
2855     ;; rcirc-handler-366 (RPL_ENDOFNAMES) will handle it
2856     (with-current-buffer (rcirc-get-temp-buffer-create process channel)
2857       (goto-char (point-max))
2858       (insert (car (last args)) " "))))
2859
2860 (defun rcirc-handler-366 (process sender args _text)
2861   "RPL_ENDOFNAMES"
2862   (let* ((channel (cadr args))
2863          (buffer (rcirc-get-temp-buffer-create process channel)))
2864     (with-current-buffer buffer
2865       (rcirc-print process sender "NAMES" channel
2866                    (let ((content (buffer-substring (point-min) (point-max))))
2867                      (rcirc-sort-nicknames-join content " "))))
2868     (kill-buffer buffer)))
2869
2870 (defun rcirc-handler-433 (process sender args text)
2871   "ERR_NICKNAMEINUSE"
2872   (rcirc-handler-generic process "433" sender args text)
2873   (let* ((new-nick (concat (cadr args) "`")))
2874     (with-rcirc-process-buffer process
2875       (rcirc-cmd-nick new-nick nil process))))
2876
2877 (defun rcirc-authenticate ()
2878   "Send authentication to process associated with current buffer.
2879 Passwords are stored in `rcirc-authinfo' (which see)."
2880   (interactive)
2881   (with-rcirc-server-buffer
2882     (dolist (i rcirc-authinfo)
2883       (let ((process (rcirc-buffer-process))
2884             (server (car i))
2885             (nick (cl-caddr i))
2886             (method (cadr i))
2887             (args (cl-cdddr i)))
2888         (when (and (string-match server rcirc-server))
2889           (if (and (memq method '(nickserv chanserv bitlbee))
2890                    (string-match nick rcirc-nick))
2891               ;; the following methods rely on the user's nickname.
2892               (cl-case method
2893                 (nickserv
2894                  (rcirc-send-privmsg
2895                   process
2896                   (or (cadr args) "NickServ")
2897                   (concat "IDENTIFY " (car args))))
2898                 (chanserv
2899                  (rcirc-send-privmsg
2900                   process
2901                   "ChanServ"
2902                   (format "IDENTIFY %s %s" (car args) (cadr args))))
2903                 (bitlbee
2904                  (rcirc-send-privmsg
2905                   process
2906                   "&bitlbee"
2907                   (concat "IDENTIFY " (car args)))))
2908             ;; quakenet authentication doesn't rely on the user's nickname.
2909             ;; the variable `nick' here represents the Q account name.
2910             (when (eq method 'quakenet)
2911               (rcirc-send-privmsg
2912                process
2913                "Q@CServe.quakenet.org"
2914                (format "AUTH %s %s" nick (car args))))))))))
2915
2916 (defun rcirc-handler-INVITE (process sender args _text)
2917   (rcirc-print process sender "INVITE" nil (mapconcat 'identity args " ") t))
2918
2919 (defun rcirc-handler-ERROR (process sender args _text)
2920   (rcirc-print process sender "ERROR" nil (mapconcat 'identity args " ")))
2921
2922 (defun rcirc-handler-CTCP (process target sender text)
2923   (if (string-match "^\\([^ ]+\\) *\\(.*\\)$" text)
2924       (let* ((request (upcase (match-string 1 text)))
2925              (args (match-string 2 text))
2926              (handler (intern-soft (concat "rcirc-handler-ctcp-" request))))
2927         (if (not (fboundp handler))
2928             (rcirc-print process sender "ERROR" target
2929                          (format "%s sent unsupported ctcp: %s" sender text)
2930                          t)
2931           (funcall handler process target sender args)
2932           (unless (or (string= request "ACTION")
2933                       (string= request "KEEPALIVE"))
2934               (rcirc-print process sender "CTCP" target
2935                            (format "%s" text) t))))))
2936
2937 (defun rcirc-handler-ctcp-VERSION (process _target sender _args)
2938   (rcirc-send-string process
2939                      (concat "NOTICE " sender
2940                              " :\C-aVERSION " rcirc-id-string
2941                              "\C-a")))
2942
2943 (defun rcirc-handler-ctcp-ACTION (process target sender args)
2944   (rcirc-print process sender "ACTION" target args t))
2945
2946 (defun rcirc-handler-ctcp-TIME (process _target sender _args)
2947   (rcirc-send-string process
2948                      (concat "NOTICE " sender
2949                              " :\C-aTIME " (current-time-string) "\C-a")))
2950
2951 (defun rcirc-handler-CTCP-response (process _target sender message)
2952   (rcirc-print process sender "CTCP" nil message t))
2953 \f
2954 (defgroup rcirc-faces nil
2955   "Faces for rcirc."
2956   :group 'rcirc
2957   :group 'faces)
2958
2959 (defface rcirc-my-nick                  ; font-lock-function-name-face
2960   '((((class color) (min-colors 88) (background light)) :foreground "Blue1")
2961     (((class color) (min-colors 88) (background dark))  :foreground "LightSkyBlue")
2962     (((class color) (min-colors 16) (background light)) :foreground "Blue")
2963     (((class color) (min-colors 16) (background dark))  :foreground "LightSkyBlue")
2964     (((class color) (min-colors 8)) :foreground "blue" :weight bold)
2965     (t :inverse-video t :weight bold))
2966   "Rcirc face for my messages."
2967   :group 'rcirc-faces)
2968
2969 (defface rcirc-other-nick            ; font-lock-variable-name-face
2970   '((((class grayscale) (background light))
2971      :foreground "Gray90" :weight bold :slant italic)
2972     (((class grayscale) (background dark))
2973      :foreground "DimGray" :weight bold :slant italic)
2974     (((class color) (min-colors 88) (background light)) :foreground "DarkGoldenrod")
2975     (((class color) (min-colors 88) (background dark))  :foreground "LightGoldenrod")
2976     (((class color) (min-colors 16) (background light)) :foreground "DarkGoldenrod")
2977     (((class color) (min-colors 16) (background dark))  :foreground "LightGoldenrod")
2978     (((class color) (min-colors 8)) :foreground "yellow" :weight light)
2979     (t :weight bold :slant italic))
2980   "Rcirc face for other users' messages."
2981   :group 'rcirc-faces)
2982
2983 (defface rcirc-bright-nick
2984   '((((class grayscale) (background light))
2985      :foreground "LightGray" :weight bold :underline t)
2986     (((class grayscale) (background dark))
2987      :foreground "Gray50" :weight bold :underline t)
2988     (((class color) (min-colors 88) (background light)) :foreground "CadetBlue")
2989     (((class color) (min-colors 88) (background dark))  :foreground "Aquamarine")
2990     (((class color) (min-colors 16) (background light)) :foreground "CadetBlue")
2991     (((class color) (min-colors 16) (background dark))  :foreground "Aquamarine")
2992     (((class color) (min-colors 8)) :foreground "magenta")
2993     (t :weight bold :underline t))
2994   "Rcirc face for nicks matched by `rcirc-bright-nicks'."
2995   :group 'rcirc-faces)
2996
2997 (defface rcirc-dim-nick
2998   '((t :inherit default))
2999   "Rcirc face for nicks in `rcirc-dim-nicks'."
3000   :group 'rcirc-faces)
3001
3002 (defface rcirc-server                   ; font-lock-comment-face
3003   '((((class grayscale) (background light))
3004      :foreground "DimGray" :weight bold :slant italic)
3005     (((class grayscale) (background dark))
3006      :foreground "LightGray" :weight bold :slant italic)
3007     (((class color) (min-colors 88) (background light))
3008      :foreground "Firebrick")
3009     (((class color) (min-colors 88) (background dark))
3010      :foreground "chocolate1")
3011     (((class color) (min-colors 16) (background light))
3012      :foreground "red")
3013     (((class color) (min-colors 16) (background dark))
3014      :foreground "red1")
3015     (((class color) (min-colors 8) (background light)))
3016     (((class color) (min-colors 8) (background dark)))
3017     (t :weight bold :slant italic))
3018   "Rcirc face for server messages."
3019   :group 'rcirc-faces)
3020
3021 (defface rcirc-server-prefix     ; font-lock-comment-delimiter-face
3022   '((default :inherit rcirc-server)
3023     (((class grayscale)))
3024     (((class color) (min-colors 16)))
3025     (((class color) (min-colors 8) (background light))
3026      :foreground "red")
3027     (((class color) (min-colors 8) (background dark))
3028      :foreground "red1"))
3029   "Rcirc face for server prefixes."
3030   :group 'rcirc-faces)
3031
3032 (defface rcirc-timestamp
3033   '((t :inherit default))
3034   "Rcirc face for timestamps."
3035   :group 'rcirc-faces)
3036
3037 (defface rcirc-nick-in-message          ; font-lock-keyword-face
3038   '((((class grayscale) (background light)) :foreground "LightGray" :weight bold)
3039     (((class grayscale) (background dark)) :foreground "DimGray" :weight bold)
3040     (((class color) (min-colors 88) (background light)) :foreground "Purple")
3041     (((class color) (min-colors 88) (background dark))  :foreground "Cyan1")
3042     (((class color) (min-colors 16) (background light)) :foreground "Purple")
3043     (((class color) (min-colors 16) (background dark))  :foreground "Cyan")
3044     (((class color) (min-colors 8)) :foreground "cyan" :weight bold)
3045     (t :weight bold))
3046   "Rcirc face for instances of your nick within messages."
3047   :group 'rcirc-faces)
3048
3049 (defface rcirc-nick-in-message-full-line '((t :weight bold))
3050   "Rcirc face for emphasizing the entire message when your nick is mentioned."
3051   :group 'rcirc-faces)
3052
3053 (defface rcirc-prompt                   ; comint-highlight-prompt
3054   '((((min-colors 88) (background dark)) :foreground "cyan1")
3055     (((background dark)) :foreground "cyan")
3056     (t :foreground "dark blue"))
3057   "Rcirc face for prompts."
3058   :group 'rcirc-faces)
3059
3060 (defface rcirc-track-nick
3061   '((((type tty)) :inherit default)
3062     (t :inverse-video t))
3063   "Rcirc face used in the mode-line when your nick is mentioned."
3064   :group 'rcirc-faces)
3065
3066 (defface rcirc-track-keyword '((t :weight bold))
3067   "Rcirc face used in the mode-line when keywords are mentioned."
3068   :group 'rcirc-faces)
3069
3070 (defface rcirc-url '((t :weight bold))
3071   "Rcirc face used to highlight urls."
3072   :group 'rcirc-faces)
3073
3074 (defface rcirc-keyword '((t :inherit highlight))
3075   "Rcirc face used to highlight keywords."
3076   :group 'rcirc-faces)
3077
3078 \f
3079 ;; When using M-x flyspell-mode, only check words after the prompt
3080 (put 'rcirc-mode 'flyspell-mode-predicate 'rcirc-looking-at-input)
3081 (defun rcirc-looking-at-input ()
3082   "Returns true if point is past the input marker."
3083   (>= (point) rcirc-prompt-end-marker))
3084 \f
3085
3086 (provide 'rcirc)
3087
3088 ;;; rcirc.el ends here