(Help Summary, Apropos, Misc Help): Fix typos.
[emacs.git] / lisp / net / rcirc.el
blobef24de44e507c34bd57f53f25355465f78c0c39c
1 ;;; rcirc.el --- default, simple IRC client.
3 ;; Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc.
5 ;; Author: Ryan Yeske
6 ;; URL: http://www.nongnu.org/rcirc
7 ;; Keywords: comm
9 ;; This file is part of GNU Emacs.
11 ;; This file is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
14 ;; any later version.
16 ;; This file is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Internet Relay Chat (IRC) is a form of instant communication over
29 ;; the Internet. It is mainly designed for group (many-to-many)
30 ;; communication in discussion forums called channels, but also allows
31 ;; one-to-one communication.
33 ;; Rcirc has simple defaults and clear and consistent behaviour.
34 ;; Message arrival timestamps, activity notification on the modeline,
35 ;; message filling, nick completion, and keepalive pings are all
36 ;; enabled by default, but can easily be adjusted or turned off. Each
37 ;; discussion takes place in its own buffer and there is a single
38 ;; server buffer per connection.
40 ;; Open a new irc connection with:
41 ;; M-x irc RET
43 ;;; Todo:
45 ;;; Code:
47 (require 'ring)
48 (require 'time-date)
49 (eval-when-compile (require 'cl))
51 (defgroup rcirc nil
52 "Simple IRC client."
53 :version "22.1"
54 :prefix "rcirc-"
55 :link '(custom-manual "(rcirc)")
56 :group 'applications)
58 (defcustom rcirc-server-alist
59 '(("irc.freenode.net" :channels ("#rcirc")))
60 "An alist of IRC connections to establish when running `rcirc'.
61 Each element looks like (SERVER-NAME PARAMETERS).
63 SERVER-NAME is a string describing the server to connect
64 to.
66 The optional PARAMETERS come in pairs PARAMETER VALUE.
68 The following parameters are recognized:
70 `:nick'
72 VALUE must be a string. If absent, `rcirc-default-nick' is used
73 for this connection.
75 `:port'
77 VALUE must be a number or string. If absent,
78 `rcirc-default-port' is used.
80 `:user-name'
82 VALUE must be a string. If absent, `rcirc-default-user-name' is
83 used.
85 `:full-name'
87 VALUE must be a string. If absent, `rcirc-default-full-name' is
88 used.
90 `:channels'
92 VALUE must be a list of strings describing which channels to join
93 when connecting to this server. If absent, no channels will be
94 connected to automatically."
95 :type '(alist :key-type string
96 :value-type (plist :options ((:nick string)
97 (:port integer)
98 (:user-name string)
99 (:full-name string)
100 (:channels (repeat string)))))
101 :group 'rcirc)
103 (defcustom rcirc-default-port 6667
104 "The default port to connect to."
105 :type 'integer
106 :group 'rcirc)
108 (defcustom rcirc-default-nick (user-login-name)
109 "Your nick."
110 :type 'string
111 :group 'rcirc)
113 (defcustom rcirc-default-user-name (user-login-name)
114 "Your user name sent to the server when connecting."
115 :type 'string
116 :group 'rcirc)
118 (defcustom rcirc-default-full-name (if (string= (user-full-name) "")
119 rcirc-default-user-name
120 (user-full-name))
121 "The full name sent to the server when connecting."
122 :type 'string
123 :group 'rcirc)
125 (defcustom rcirc-fill-flag t
126 "*Non-nil means line-wrap messages printed in channel buffers."
127 :type 'boolean
128 :group 'rcirc)
130 (defcustom rcirc-fill-column nil
131 "*Column beyond which automatic line-wrapping should happen.
132 If nil, use value of `fill-column'. If 'frame-width, use the
133 maximum frame width."
134 :type '(choice (const :tag "Value of `fill-column'")
135 (const :tag "Full frame width" frame-width)
136 (integer :tag "Number of columns"))
137 :group 'rcirc)
139 (defcustom rcirc-fill-prefix nil
140 "*Text to insert before filled lines.
141 If nil, calculate the prefix dynamically to line up text
142 underneath each nick."
143 :type '(choice (const :tag "Dynamic" nil)
144 (string :tag "Prefix text"))
145 :group 'rcirc)
147 (defvar rcirc-ignore-buffer-activity-flag nil
148 "If non-nil, ignore activity in this buffer.")
149 (make-variable-buffer-local 'rcirc-ignore-buffer-activity-flag)
151 (defvar rcirc-low-priority-flag nil
152 "If non-nil, activity in this buffer is considered low priority.")
153 (make-variable-buffer-local 'rcirc-low-priority-flag)
155 (defvar rcirc-omit-mode nil
156 "Non-nil if Rcirc-Omit mode is enabled.
157 Use the command `rcirc-omit-mode' to change this variable.")
158 (make-variable-buffer-local 'rcirc-omit-mode)
160 (defcustom rcirc-time-format "%H:%M "
161 "*Describes how timestamps are printed.
162 Used as the first arg to `format-time-string'."
163 :type 'string
164 :group 'rcirc)
166 (defcustom rcirc-input-ring-size 1024
167 "*Size of input history ring."
168 :type 'integer
169 :group 'rcirc)
171 (defcustom rcirc-read-only-flag t
172 "*Non-nil means make text in IRC buffers read-only."
173 :type 'boolean
174 :group 'rcirc)
176 (defcustom rcirc-buffer-maximum-lines nil
177 "*The maximum size in lines for rcirc buffers.
178 Channel buffers are truncated from the top to be no greater than this
179 number. If zero or nil, no truncating is done."
180 :type '(choice (const :tag "No truncation" nil)
181 (integer :tag "Number of lines"))
182 :group 'rcirc)
184 (defcustom rcirc-scroll-show-maximum-output t
185 "*If non-nil, scroll buffer to keep the point at the bottom of
186 the window."
187 :type 'boolean
188 :group 'rcirc)
190 (defcustom rcirc-authinfo nil
191 "List of authentication passwords.
192 Each element of the list is a list with a SERVER-REGEXP string
193 and a method symbol followed by method specific arguments.
195 The valid METHOD symbols are `nickserv', `chanserv' and
196 `bitlbee'.
198 The required ARGUMENTS for each METHOD symbol are:
199 `nickserv': NICK PASSWORD
200 `chanserv': NICK CHANNEL PASSWORD
201 `bitlbee': NICK PASSWORD
203 Example:
204 ((\"freenode\" nickserv \"bob\" \"p455w0rd\")
205 (\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
206 (\"bitlbee\" bitlbee \"robert\" \"sekrit\"))"
207 :type '(alist :key-type (string :tag "Server")
208 :value-type (choice (list :tag "NickServ"
209 (const nickserv)
210 (string :tag "Nick")
211 (string :tag "Password"))
212 (list :tag "ChanServ"
213 (const chanserv)
214 (string :tag "Nick")
215 (string :tag "Channel")
216 (string :tag "Password"))
217 (list :tag "BitlBee"
218 (const bitlbee)
219 (string :tag "Nick")
220 (string :tag "Password"))))
221 :group 'rcirc)
223 (defcustom rcirc-auto-authenticate-flag t
224 "*Non-nil means automatically send authentication string to server.
225 See also `rcirc-authinfo'."
226 :type 'boolean
227 :group 'rcirc)
229 (defcustom rcirc-prompt "> "
230 "Prompt string to use in IRC buffers.
232 The following replacements are made:
233 %n is your nick.
234 %s is the server.
235 %t is the buffer target, a channel or a user.
237 Setting this alone will not affect the prompt;
238 use either M-x customize or also call `rcirc-update-prompt'."
239 :type 'string
240 :set 'rcirc-set-changed
241 :initialize 'custom-initialize-default
242 :group 'rcirc)
244 (defcustom rcirc-keywords nil
245 "List of keywords to highlight in message text."
246 :type '(repeat string)
247 :group 'rcirc)
249 (defcustom rcirc-ignore-list ()
250 "List of ignored nicks.
251 Use /ignore to list them, use /ignore NICK to add or remove a nick."
252 :type '(repeat string)
253 :group 'rcirc)
255 (defvar rcirc-ignore-list-automatic ()
256 "List of ignored nicks added to `rcirc-ignore-list' because of renaming.
257 When an ignored person renames, their nick is added to both lists.
258 Nicks will be removed from the automatic list on follow-up renamings or
259 parts.")
261 (defcustom rcirc-bright-nicks nil
262 "List of nicks to be emphasized.
263 See `rcirc-bright-nick' face."
264 :type '(repeat string)
265 :group 'rcirc)
267 (defcustom rcirc-dim-nicks nil
268 "List of nicks to be deemphasized.
269 See `rcirc-dim-nick' face."
270 :type '(repeat string)
271 :group 'rcirc)
273 (defcustom rcirc-print-hooks nil
274 "Hook run after text is printed.
275 Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT."
276 :type 'hook
277 :group 'rcirc)
279 (defcustom rcirc-always-use-server-buffer-flag nil
280 "Non-nil means messages without a channel target will go to the server buffer."
281 :type 'boolean
282 :group 'rcirc)
284 (defcustom rcirc-decode-coding-system 'utf-8
285 "Coding system used to decode incoming irc messages."
286 :type 'coding-system
287 :group 'rcirc)
289 (defcustom rcirc-encode-coding-system 'utf-8
290 "Coding system used to encode outgoing irc messages."
291 :type 'coding-system
292 :group 'rcirc)
294 (defcustom rcirc-coding-system-alist nil
295 "Alist to decide a coding system to use for a channel I/O operation.
296 The format is ((PATTERN . VAL) ...).
297 PATTERN is either a string or a cons of strings.
298 If PATTERN is a string, it is used to match a target.
299 If PATTERN is a cons of strings, the car part is used to match a
300 target, and the cdr part is used to match a server.
301 VAL is either a coding system or a cons of coding systems.
302 If VAL is a coding system, it is used for both decoding and encoding
303 messages.
304 If VAL is a cons of coding systems, the car part is used for decoding,
305 and the cdr part is used for encoding."
306 :type '(alist :key-type (choice (string :tag "Channel Regexp")
307 (cons (string :tag "Channel Regexp")
308 (string :tag "Server Regexp")))
309 :value-type (choice coding-system
310 (cons (coding-system :tag "Decode")
311 (coding-system :tag "Encode"))))
312 :group 'rcirc)
314 (defcustom rcirc-multiline-major-mode 'fundamental-mode
315 "Major-mode function to use in multiline edit buffers."
316 :type 'function
317 :group 'rcirc)
319 (defvar rcirc-nick nil)
321 (defvar rcirc-prompt-start-marker nil)
322 (defvar rcirc-prompt-end-marker nil)
324 (defvar rcirc-nick-table nil)
326 (defvar rcirc-recent-quit-alist nil
327 "Alist of nicks that have recently quit or parted the channel.")
329 (defvar rcirc-nick-syntax-table
330 (let ((table (make-syntax-table text-mode-syntax-table)))
331 (mapc (lambda (c) (modify-syntax-entry c "w" table))
332 "[]\\`_^{|}-")
333 (modify-syntax-entry ?' "_" table)
334 table)
335 "Syntax table which includes all nick characters as word constituents.")
337 ;; each process has an alist of (target . buffer) pairs
338 (defvar rcirc-buffer-alist nil)
340 (defvar rcirc-activity nil
341 "List of buffers with unviewed activity.")
343 (defvar rcirc-activity-string ""
344 "String displayed in modeline representing `rcirc-activity'.")
345 (put 'rcirc-activity-string 'risky-local-variable t)
347 (defvar rcirc-server-buffer nil
348 "The server buffer associated with this channel buffer.")
350 (defvar rcirc-target nil
351 "The channel or user associated with this buffer.")
353 (defvar rcirc-urls nil
354 "List of urls seen in the current buffer.")
355 (put 'rcirc-urls 'permanent-local t)
357 (defvar rcirc-timeout-seconds 600
358 "Kill connection after this many seconds if there is no activity.")
360 (defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
362 (defvar rcirc-startup-channels nil)
364 ;;;###autoload
365 (defun rcirc (arg)
366 "Connect to all servers in `rcirc-server-alist'.
368 Do not connect to a server if it is already connected.
370 If ARG is non-nil, instead prompt for connection parameters."
371 (interactive "P")
372 (if arg
373 (let* ((server (completing-read "IRC Server: "
374 rcirc-server-alist
375 nil nil
376 (caar rcirc-server-alist)))
377 (server-plist (cdr (assoc-string server rcirc-server-alist)))
378 (port (read-string "IRC Port: "
379 (number-to-string
380 (or (plist-get server-plist 'port)
381 rcirc-default-port))))
382 (nick (read-string "IRC Nick: "
383 (or (plist-get server-plist 'nick)
384 rcirc-default-nick)))
385 (channels (split-string
386 (read-string "IRC Channels: "
387 (mapconcat 'identity
388 (plist-get server-plist
389 'channels)
390 " "))
391 "[, ]+" t)))
392 (rcirc-connect server port nick rcirc-default-user-name
393 rcirc-default-full-name
394 channels))
395 ;; connect to servers in `rcirc-server-alist'
396 (let (connected-servers)
397 (dolist (c rcirc-server-alist)
398 (let ((server (car c))
399 (nick (or (plist-get (cdr c) :nick) rcirc-default-nick))
400 (port (or (plist-get (cdr c) :port) rcirc-default-port))
401 (user-name (or (plist-get (cdr c) :user-name)
402 rcirc-default-user-name))
403 (full-name (or (plist-get (cdr c) :full-name)
404 rcirc-default-full-name))
405 (channels (plist-get (cdr c) :channels)))
406 (when server
407 (let (connected)
408 (dolist (p (rcirc-process-list))
409 (when (string= server (process-name p))
410 (setq connected p)))
411 (if (not connected)
412 (condition-case e
413 (rcirc-connect server port nick user-name
414 full-name channels)
415 (quit (message "Quit connecting to %s" server)))
416 (with-current-buffer (process-buffer connected)
417 (setq connected-servers
418 (cons (process-contact (get-buffer-process
419 (current-buffer)) :host)
420 connected-servers))))))))
421 (when connected-servers
422 (message "Already connected to %s"
423 (if (cdr connected-servers)
424 (concat (mapconcat 'identity (butlast connected-servers) ", ")
425 ", and "
426 (car (last connected-servers)))
427 (car connected-servers)))))))
429 ;;;###autoload
430 (defalias 'irc 'rcirc)
433 (defvar rcirc-process-output nil)
434 (defvar rcirc-topic nil)
435 (defvar rcirc-keepalive-timer nil)
436 (defvar rcirc-last-server-message-time nil)
437 (defvar rcirc-server nil) ; server provided by server
438 (defvar rcirc-server-name nil) ; server name given by 001 response
439 (defvar rcirc-timeout-timer nil)
440 (defvar rcirc-user-disconnect nil)
441 (defvar rcirc-connecting nil)
442 (defvar rcirc-process nil)
444 ;;;###autoload
445 (defun rcirc-connect (server &optional port nick user-name full-name
446 startup-channels)
447 (save-excursion
448 (message "Connecting to %s..." server)
449 (let* ((inhibit-eol-conversion)
450 (port-number (if port
451 (if (stringp port)
452 (string-to-number port)
453 port)
454 rcirc-default-port))
455 (nick (or nick rcirc-default-nick))
456 (user-name (or user-name rcirc-default-user-name))
457 (full-name (or full-name rcirc-default-full-name))
458 (startup-channels startup-channels)
459 (process (make-network-process :name server :host server :service port-number)))
460 ;; set up process
461 (set-process-coding-system process 'raw-text 'raw-text)
462 (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
463 (set-process-buffer process (current-buffer))
464 (rcirc-mode process nil)
465 (set-process-sentinel process 'rcirc-sentinel)
466 (set-process-filter process 'rcirc-filter)
467 (make-local-variable 'rcirc-process)
468 (setq rcirc-process process)
469 (make-local-variable 'rcirc-server)
470 (setq rcirc-server server)
471 (make-local-variable 'rcirc-server-name)
472 (setq rcirc-server-name server) ; update when we get 001 response
473 (make-local-variable 'rcirc-buffer-alist)
474 (setq rcirc-buffer-alist nil)
475 (make-local-variable 'rcirc-nick-table)
476 (setq rcirc-nick-table (make-hash-table :test 'equal))
477 (make-local-variable 'rcirc-nick)
478 (setq rcirc-nick nick)
479 (make-local-variable 'rcirc-process-output)
480 (setq rcirc-process-output nil)
481 (make-local-variable 'rcirc-startup-channels)
482 (setq rcirc-startup-channels startup-channels)
483 (make-local-variable 'rcirc-last-server-message-time)
484 (setq rcirc-last-server-message-time (current-time))
485 (make-local-variable 'rcirc-timeout-timer)
486 (setq rcirc-timeout-timer nil)
487 (make-local-variable 'rcirc-user-disconnect)
488 (setq rcirc-user-disconnect nil)
489 (make-local-variable 'rcirc-connecting)
490 (setq rcirc-connecting t)
492 (add-hook 'auto-save-hook 'rcirc-log-write)
494 ;; identify
495 (rcirc-send-string process (concat "NICK " nick))
496 (rcirc-send-string process (concat "USER " user-name
497 " hostname servername :"
498 full-name))
500 ;; setup ping timer if necessary
501 (unless rcirc-keepalive-timer
502 (setq rcirc-keepalive-timer
503 (run-at-time 0 (/ rcirc-timeout-seconds 2) 'rcirc-keepalive)))
505 (message "Connecting to %s...done" server)
507 ;; return process object
508 process)))
510 (defmacro with-rcirc-process-buffer (process &rest body)
511 (declare (indent 1) (debug t))
512 `(with-current-buffer (process-buffer ,process)
513 ,@body))
515 (defmacro with-rcirc-server-buffer (&rest body)
516 (declare (indent 0) (debug t))
517 `(with-current-buffer rcirc-server-buffer
518 ,@body))
520 (defun rcirc-keepalive ()
521 "Send keep alive pings to active rcirc processes.
522 Kill processes that have not received a server message since the
523 last ping."
524 (if (rcirc-process-list)
525 (mapc (lambda (process)
526 (with-rcirc-process-buffer process
527 (when (not rcirc-connecting)
528 (rcirc-send-string process
529 (format "PRIVMSG %s :\C-aKEEPALIVE %f\C-a"
530 rcirc-nick
531 (time-to-seconds
532 (current-time)))))))
533 (rcirc-process-list))
534 ;; no processes, clean up timer
535 (cancel-timer rcirc-keepalive-timer)
536 (setq rcirc-keepalive-timer nil)))
538 (defun rcirc-handler-ctcp-KEEPALIVE (process target sender message)
539 (with-rcirc-process-buffer process
540 (setq header-line-format (format "%f" (- (time-to-seconds (current-time))
541 (string-to-number message))))))
543 (defvar rcirc-debug-buffer " *rcirc debug*")
544 (defvar rcirc-debug-flag nil
545 "If non-nil, write information to `rcirc-debug-buffer'.")
546 (defun rcirc-debug (process text)
547 "Add an entry to the debug log including PROCESS and TEXT.
548 Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
549 is non-nil."
550 (when rcirc-debug-flag
551 (save-excursion
552 (set-buffer (get-buffer-create rcirc-debug-buffer))
553 (goto-char (point-max))
554 (insert (concat
556 (format-time-string "%Y-%m-%dT%T ") (process-name process)
557 "] "
558 text)))))
560 (defvar rcirc-sentinel-hooks nil
561 "Hook functions called when the process sentinel is called.
562 Functions are called with PROCESS and SENTINEL arguments.")
564 (defun rcirc-sentinel (process sentinel)
565 "Called when PROCESS receives SENTINEL."
566 (let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
567 (rcirc-debug process (format "SENTINEL: %S %S\n" process sentinel))
568 (with-rcirc-process-buffer process
569 (dolist (buffer (cons nil (mapcar 'cdr rcirc-buffer-alist)))
570 (with-current-buffer (or buffer (current-buffer))
571 (rcirc-print process "rcirc.el" "ERROR" rcirc-target
572 (format "%s: %s (%S)"
573 (process-name process)
574 sentinel
575 (process-status process)) (not rcirc-target))
576 (rcirc-disconnect-buffer)))
577 (run-hook-with-args 'rcirc-sentinel-hooks process sentinel))))
579 (defun rcirc-disconnect-buffer (&optional buffer)
580 (with-current-buffer (or buffer (current-buffer))
581 ;; set rcirc-target to nil for each channel so cleanup
582 ;; doesnt happen when we reconnect
583 (setq rcirc-target nil)
584 (setq mode-line-process ":disconnected")))
586 (defun rcirc-process-list ()
587 "Return a list of rcirc processes."
588 (let (ps)
589 (mapc (lambda (p)
590 (when (buffer-live-p (process-buffer p))
591 (with-rcirc-process-buffer p
592 (when (eq major-mode 'rcirc-mode)
593 (setq ps (cons p ps))))))
594 (process-list))
595 ps))
597 (defvar rcirc-receive-message-hooks nil
598 "Hook functions run when a message is received from server.
599 Function is called with PROCESS, COMMAND, SENDER, ARGS and LINE.")
600 (defun rcirc-filter (process output)
601 "Called when PROCESS receives OUTPUT."
602 (rcirc-debug process output)
603 (rcirc-reschedule-timeout process)
604 (with-rcirc-process-buffer process
605 (setq rcirc-last-server-message-time (current-time))
606 (setq rcirc-process-output (concat rcirc-process-output output))
607 (when (= (aref rcirc-process-output
608 (1- (length rcirc-process-output))) ?\n)
609 (mapc (lambda (line)
610 (rcirc-process-server-response process line))
611 (split-string rcirc-process-output "[\n\r]" t))
612 (setq rcirc-process-output nil))))
614 (defun rcirc-reschedule-timeout (process)
615 (with-rcirc-process-buffer process
616 (when (not rcirc-connecting)
617 (with-rcirc-process-buffer process
618 (when rcirc-timeout-timer (cancel-timer rcirc-timeout-timer))
619 (setq rcirc-timeout-timer (run-at-time rcirc-timeout-seconds nil
620 'rcirc-delete-process
621 process))))))
623 (defun rcirc-delete-process (process)
624 (delete-process process))
626 (defvar rcirc-trap-errors-flag t)
627 (defun rcirc-process-server-response (process text)
628 (if rcirc-trap-errors-flag
629 (condition-case err
630 (rcirc-process-server-response-1 process text)
631 (error
632 (rcirc-print process "RCIRC" "ERROR" nil
633 (format "\"%s\" %s" text err) t)))
634 (rcirc-process-server-response-1 process text)))
636 (defun rcirc-process-server-response-1 (process text)
637 (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
638 (let* ((user (match-string 2 text))
639 (sender (rcirc-user-nick user))
640 (cmd (match-string 3 text))
641 (args (match-string 4 text))
642 (handler (intern-soft (concat "rcirc-handler-" cmd))))
643 (string-match "^\\([^:]*\\):?\\(.+\\)?$" args)
644 (let* ((args1 (match-string 1 args))
645 (args2 (match-string 2 args))
646 (args (delq nil (append (split-string args1 " " t)
647 (list args2)))))
648 (if (not (fboundp handler))
649 (rcirc-handler-generic process cmd sender args text)
650 (funcall handler process sender args text))
651 (run-hook-with-args 'rcirc-receive-message-hooks
652 process cmd sender args text)))
653 (message "UNHANDLED: %s" text)))
655 (defvar rcirc-responses-no-activity '("305" "306")
656 "Responses that don't trigger activity in the mode-line indicator.")
658 (defun rcirc-handler-generic (process response sender args text)
659 "Generic server response handler."
660 (rcirc-print process sender response nil
661 (mapconcat 'identity (cdr args) " ")
662 (not (member response rcirc-responses-no-activity))))
664 (defun rcirc-send-string (process string)
665 "Send PROCESS a STRING plus a newline."
666 (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
667 "\n")))
668 (unless (eq (process-status process) 'open)
669 (error "Network connection to %s is not open"
670 (process-name process)))
671 (rcirc-debug process string)
672 (process-send-string process string)))
674 (defun rcirc-buffer-process (&optional buffer)
675 "Return the process associated with channel BUFFER.
676 With no argument or nil as argument, use the current buffer."
677 (or (get-buffer-process (if buffer
678 (with-current-buffer buffer
679 rcirc-server-buffer)
680 rcirc-server-buffer))
681 rcirc-process))
683 (defun rcirc-server-name (process)
684 "Return PROCESS server name, given by the 001 response."
685 (with-rcirc-process-buffer process
686 (or rcirc-server-name
687 (warn "server name for process %S unknown" process))))
689 (defun rcirc-nick (process)
690 "Return PROCESS nick."
691 (with-rcirc-process-buffer process
692 (or rcirc-nick rcirc-default-nick)))
694 (defun rcirc-buffer-nick (&optional buffer)
695 "Return the nick associated with BUFFER.
696 With no argument or nil as argument, use the current buffer."
697 (with-current-buffer (or buffer (current-buffer))
698 (with-current-buffer rcirc-server-buffer
699 (or rcirc-nick rcirc-default-nick))))
701 (defvar rcirc-max-message-length 420
702 "Messages longer than this value will be split.")
704 (defun rcirc-send-message (process target message &optional noticep silent)
705 "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
706 If NOTICEP is non-nil, send a notice instead of privmsg.
707 If SILENT is non-nil, do not print the message in any irc buffer."
708 ;; max message length is 512 including CRLF
709 (let* ((response (if noticep "NOTICE" "PRIVMSG"))
710 (oversize (> (length message) rcirc-max-message-length))
711 (text (if oversize
712 (substring message 0 rcirc-max-message-length)
713 message))
714 (text (if (string= text "")
716 text))
717 (more (if oversize
718 (substring message rcirc-max-message-length))))
719 (rcirc-get-buffer-create process target)
720 (rcirc-send-string process (concat response " " target " :" text))
721 (unless silent
722 (rcirc-print process (rcirc-nick process) response target text))
723 (when more (rcirc-send-message process target more noticep))))
725 (defvar rcirc-input-ring nil)
726 (defvar rcirc-input-ring-index 0)
727 (defun rcirc-prev-input-string (arg)
728 (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))
730 (defun rcirc-insert-prev-input (arg)
731 (interactive "p")
732 (when (<= rcirc-prompt-end-marker (point))
733 (delete-region rcirc-prompt-end-marker (point-max))
734 (insert (rcirc-prev-input-string 0))
735 (setq rcirc-input-ring-index (1+ rcirc-input-ring-index))))
737 (defun rcirc-insert-next-input (arg)
738 (interactive "p")
739 (when (<= rcirc-prompt-end-marker (point))
740 (delete-region rcirc-prompt-end-marker (point-max))
741 (setq rcirc-input-ring-index (1- rcirc-input-ring-index))
742 (insert (rcirc-prev-input-string -1))))
744 (defvar rcirc-nick-completions nil)
745 (defvar rcirc-nick-completion-start-offset nil)
747 (defun rcirc-complete-nick ()
748 "Cycle through nick completions from list of nicks in channel."
749 (interactive)
750 (if (eq last-command this-command)
751 (setq rcirc-nick-completions
752 (append (cdr rcirc-nick-completions)
753 (list (car rcirc-nick-completions))))
754 (setq rcirc-nick-completion-start-offset
755 (- (save-excursion
756 (if (re-search-backward " " rcirc-prompt-end-marker t)
757 (1+ (point))
758 rcirc-prompt-end-marker))
759 rcirc-prompt-end-marker))
760 (setq rcirc-nick-completions
761 (let ((completion-ignore-case t))
762 (all-completions
763 (buffer-substring
764 (+ rcirc-prompt-end-marker
765 rcirc-nick-completion-start-offset)
766 (point))
767 (mapcar (lambda (x) (cons x nil))
768 (rcirc-channel-nicks (rcirc-buffer-process)
769 rcirc-target))))))
770 (let ((completion (car rcirc-nick-completions)))
771 (when completion
772 (delete-region (+ rcirc-prompt-end-marker
773 rcirc-nick-completion-start-offset)
774 (point))
775 (insert (concat completion
776 (if (= (+ rcirc-prompt-end-marker
777 rcirc-nick-completion-start-offset)
778 rcirc-prompt-end-marker)
779 ": "))))))
781 (defun set-rcirc-decode-coding-system (coding-system)
782 "Set the decode coding system used in this channel."
783 (interactive "zCoding system for incoming messages: ")
784 (setq rcirc-decode-coding-system coding-system))
786 (defun set-rcirc-encode-coding-system (coding-system)
787 "Set the encode coding system used in this channel."
788 (interactive "zCoding system for outgoing messages: ")
789 (setq rcirc-encode-coding-system coding-system))
791 (defvar rcirc-mode-map (make-sparse-keymap)
792 "Keymap for rcirc mode.")
794 (define-key rcirc-mode-map (kbd "RET") 'rcirc-send-input)
795 (define-key rcirc-mode-map (kbd "M-p") 'rcirc-insert-prev-input)
796 (define-key rcirc-mode-map (kbd "M-n") 'rcirc-insert-next-input)
797 (define-key rcirc-mode-map (kbd "TAB") 'rcirc-complete-nick)
798 (define-key rcirc-mode-map (kbd "C-c C-b") 'rcirc-browse-url)
799 (define-key rcirc-mode-map (kbd "C-c C-c") 'rcirc-edit-multiline)
800 (define-key rcirc-mode-map (kbd "C-c C-j") 'rcirc-cmd-join)
801 (define-key rcirc-mode-map (kbd "C-c C-k") 'rcirc-cmd-kick)
802 (define-key rcirc-mode-map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
803 (define-key rcirc-mode-map (kbd "C-c C-d") 'rcirc-cmd-mode)
804 (define-key rcirc-mode-map (kbd "C-c C-m") 'rcirc-cmd-msg)
805 (define-key rcirc-mode-map (kbd "C-c C-r") 'rcirc-cmd-nick) ; rename
806 (define-key rcirc-mode-map (kbd "C-c C-o") 'rcirc-omit-mode)
807 (define-key rcirc-mode-map (kbd "M-o") 'rcirc-omit-mode)
808 (define-key rcirc-mode-map (kbd "C-c C-p") 'rcirc-cmd-part)
809 (define-key rcirc-mode-map (kbd "C-c C-q") 'rcirc-cmd-query)
810 (define-key rcirc-mode-map (kbd "C-c C-t") 'rcirc-cmd-topic)
811 (define-key rcirc-mode-map (kbd "C-c C-n") 'rcirc-cmd-names)
812 (define-key rcirc-mode-map (kbd "C-c C-w") 'rcirc-cmd-whois)
813 (define-key rcirc-mode-map (kbd "C-c C-x") 'rcirc-cmd-quit)
814 (define-key rcirc-mode-map (kbd "C-c TAB") ; C-i
815 'rcirc-toggle-ignore-buffer-activity)
816 (define-key rcirc-mode-map (kbd "C-c C-s") 'rcirc-switch-to-server-buffer)
817 (define-key rcirc-mode-map (kbd "C-c C-a") 'rcirc-jump-to-first-unread-line)
819 (defvar rcirc-browse-url-map (make-sparse-keymap)
820 "Keymap used for browsing URLs in `rcirc-mode'.")
822 (define-key rcirc-browse-url-map (kbd "RET") 'rcirc-browse-url-at-point)
823 (define-key rcirc-browse-url-map (kbd "<mouse-2>") 'rcirc-browse-url-at-mouse)
825 (defvar rcirc-short-buffer-name nil
826 "Generated abbreviation to use to indicate buffer activity.")
828 (defvar rcirc-mode-hook nil
829 "Hook run when setting up rcirc buffer.")
831 (defvar rcirc-last-post-time nil)
833 (defvar rcirc-log-alist nil
834 "Alist of lines to log to disk when `rcirc-log-flag' is non-nil.
835 Each element looks like (FILENAME . TEXT).")
837 (defvar rcirc-current-line 0
838 "The current number of responses printed in this channel.
839 This number is independent of the number of lines in the buffer.")
841 (defun rcirc-mode (process target)
842 "Major mode for IRC channel buffers.
844 \\{rcirc-mode-map}"
845 (kill-all-local-variables)
846 (use-local-map rcirc-mode-map)
847 (setq mode-name "rcirc")
848 (setq major-mode 'rcirc-mode)
849 (setq mode-line-process nil)
851 (make-local-variable 'rcirc-input-ring)
852 (setq rcirc-input-ring (make-ring rcirc-input-ring-size))
853 (make-local-variable 'rcirc-server-buffer)
854 (setq rcirc-server-buffer (process-buffer process))
855 (make-local-variable 'rcirc-target)
856 (setq rcirc-target target)
857 (make-local-variable 'rcirc-topic)
858 (setq rcirc-topic nil)
859 (make-local-variable 'rcirc-last-post-time)
860 (setq rcirc-last-post-time (current-time))
861 (make-local-variable 'fill-paragraph-function)
862 (setq fill-paragraph-function 'rcirc-fill-paragraph)
863 (make-local-variable 'rcirc-recent-quit-alist)
864 (setq rcirc-recent-quit-alist nil)
865 (make-local-variable 'rcirc-current-line)
866 (setq rcirc-current-line 0)
868 (make-local-variable 'rcirc-short-buffer-name)
869 (setq rcirc-short-buffer-name nil)
870 (make-local-variable 'rcirc-urls)
871 (setq use-hard-newlines t)
873 ;; setup for omitting responses
874 (setq buffer-invisibility-spec '())
875 (setq buffer-display-table (make-display-table))
876 (set-display-table-slot buffer-display-table 4
877 (let ((glyph (make-glyph-code
878 ?. 'font-lock-keyword-face)))
879 (make-vector 3 glyph)))
881 (make-local-variable 'rcirc-decode-coding-system)
882 (make-local-variable 'rcirc-encode-coding-system)
883 (dolist (i rcirc-coding-system-alist)
884 (let ((chan (if (consp (car i)) (caar i) (car i)))
885 (serv (if (consp (car i)) (cdar i) "")))
886 (when (and (string-match chan (or target ""))
887 (string-match serv (rcirc-server-name process)))
888 (setq rcirc-decode-coding-system (if (consp (cdr i)) (cadr i) (cdr i))
889 rcirc-encode-coding-system (if (consp (cdr i)) (cddr i) (cdr i))))))
891 ;; setup the prompt and markers
892 (make-local-variable 'rcirc-prompt-start-marker)
893 (setq rcirc-prompt-start-marker (make-marker))
894 (set-marker rcirc-prompt-start-marker (point-max))
895 (make-local-variable 'rcirc-prompt-end-marker)
896 (setq rcirc-prompt-end-marker (make-marker))
897 (set-marker rcirc-prompt-end-marker (point-max))
898 (rcirc-update-prompt)
899 (goto-char rcirc-prompt-end-marker)
900 (make-local-variable 'overlay-arrow-position)
901 (setq overlay-arrow-position (make-marker))
902 (set-marker overlay-arrow-position nil)
904 ;; if the user changes the major mode or kills the buffer, there is
905 ;; cleanup work to do
906 (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook nil t)
907 (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook nil t)
909 ;; add to buffer list, and update buffer abbrevs
910 (when target ; skip server buffer
911 (let ((buffer (current-buffer)))
912 (with-rcirc-process-buffer process
913 (setq rcirc-buffer-alist (cons (cons target buffer)
914 rcirc-buffer-alist))))
915 (rcirc-update-short-buffer-names))
917 (run-hooks 'rcirc-mode-hook))
919 (defun rcirc-update-prompt (&optional all)
920 "Reset the prompt string in the current buffer.
922 If ALL is non-nil, update prompts in all IRC buffers."
923 (if all
924 (mapc (lambda (process)
925 (mapc (lambda (buffer)
926 (with-current-buffer buffer
927 (rcirc-update-prompt)))
928 (with-rcirc-process-buffer process
929 (mapcar 'cdr rcirc-buffer-alist))))
930 (rcirc-process-list))
931 (let ((inhibit-read-only t)
932 (prompt (or rcirc-prompt "")))
933 (mapc (lambda (rep)
934 (setq prompt
935 (replace-regexp-in-string (car rep) (cdr rep) prompt)))
936 (list (cons "%n" (rcirc-buffer-nick))
937 (cons "%s" (with-rcirc-server-buffer rcirc-server-name))
938 (cons "%t" (or rcirc-target ""))))
939 (save-excursion
940 (delete-region rcirc-prompt-start-marker rcirc-prompt-end-marker)
941 (goto-char rcirc-prompt-start-marker)
942 (let ((start (point)))
943 (insert-before-markers prompt)
944 (set-marker rcirc-prompt-start-marker start)
945 (when (not (zerop (- rcirc-prompt-end-marker
946 rcirc-prompt-start-marker)))
947 (add-text-properties rcirc-prompt-start-marker
948 rcirc-prompt-end-marker
949 (list 'face 'rcirc-prompt
950 'read-only t 'field t
951 'front-sticky t 'rear-nonsticky t))))))))
953 (defun rcirc-set-changed (option value)
954 "Set OPTION to VALUE and do updates after a customization change."
955 (set-default option value)
956 (cond ((eq option 'rcirc-prompt)
957 (rcirc-update-prompt 'all))
959 (error "Bad option %s" option))))
961 (defun rcirc-channel-p (target)
962 "Return t if TARGET is a channel name."
963 (and target
964 (not (zerop (length target)))
965 (or (eq (aref target 0) ?#)
966 (eq (aref target 0) ?&))))
968 (defun rcirc-kill-buffer-hook ()
969 "Part the channel when killing an rcirc buffer."
970 (when (eq major-mode 'rcirc-mode)
971 (rcirc-clean-up-buffer "Killed buffer")))
973 (defun rcirc-change-major-mode-hook ()
974 "Part the channel when changing the major-mode."
975 (rcirc-clean-up-buffer "Changed major mode"))
977 (defun rcirc-clean-up-buffer (reason)
978 (let ((buffer (current-buffer)))
979 (rcirc-clear-activity buffer)
980 (when (and (rcirc-buffer-process)
981 (eq (process-status (rcirc-buffer-process)) 'open))
982 (with-rcirc-server-buffer
983 (setq rcirc-buffer-alist
984 (rassq-delete-all buffer rcirc-buffer-alist)))
985 (rcirc-update-short-buffer-names)
986 (if (rcirc-channel-p rcirc-target)
987 (rcirc-send-string (rcirc-buffer-process)
988 (concat "PART " rcirc-target " :" reason))
989 (when rcirc-target
990 (rcirc-remove-nick-channel (rcirc-buffer-process)
991 (rcirc-buffer-nick)
992 rcirc-target))))
993 (setq rcirc-target nil)))
995 (defun rcirc-generate-new-buffer-name (process target)
996 "Return a buffer name based on PROCESS and TARGET.
997 This is used for the initial name given to IRC buffers."
998 (substring-no-properties
999 (if target
1000 (concat target "@" (process-name process))
1001 (concat "*" (process-name process) "*"))))
1003 (defun rcirc-get-buffer (process target &optional server)
1004 "Return the buffer associated with the PROCESS and TARGET.
1006 If optional argument SERVER is non-nil, return the server buffer
1007 if there is no existing buffer for TARGET, otherwise return nil."
1008 (with-rcirc-process-buffer process
1009 (if (null target)
1010 (current-buffer)
1011 (let ((buffer (cdr (assoc-string target rcirc-buffer-alist t))))
1012 (or buffer (when server (current-buffer)))))))
1014 (defun rcirc-get-buffer-create (process target)
1015 "Return the buffer associated with the PROCESS and TARGET.
1016 Create the buffer if it doesn't exist."
1017 (let ((buffer (rcirc-get-buffer process target)))
1018 (if (and buffer (buffer-live-p buffer))
1019 (with-current-buffer buffer
1020 (when (not rcirc-target)
1021 (setq rcirc-target target))
1022 buffer)
1023 ;; create the buffer
1024 (with-rcirc-process-buffer process
1025 (let ((new-buffer (get-buffer-create
1026 (rcirc-generate-new-buffer-name process target))))
1027 (with-current-buffer new-buffer
1028 (rcirc-mode process target)
1029 (rcirc-put-nick-channel process (rcirc-nick process) target
1030 rcirc-current-line))
1031 new-buffer)))))
1033 (defun rcirc-send-input ()
1034 "Send input to target associated with the current buffer."
1035 (interactive)
1036 (if (< (point) rcirc-prompt-end-marker)
1037 ;; copy the line down to the input area
1038 (progn
1039 (forward-line 0)
1040 (let ((start (if (eq (point) (point-min))
1041 (point)
1042 (if (get-text-property (1- (point)) 'hard)
1043 (point)
1044 (previous-single-property-change (point) 'hard))))
1045 (end (next-single-property-change (1+ (point)) 'hard)))
1046 (goto-char (point-max))
1047 (insert (replace-regexp-in-string
1048 "\n\\s-+" " "
1049 (buffer-substring-no-properties start end)))))
1050 ;; process input
1051 (goto-char (point-max))
1052 (when (not (equal 0 (- (point) rcirc-prompt-end-marker)))
1053 ;; delete a trailing newline
1054 (when (eq (point) (point-at-bol))
1055 (delete-backward-char 1))
1056 (let ((input (buffer-substring-no-properties
1057 rcirc-prompt-end-marker (point))))
1058 (dolist (line (split-string input "\n"))
1059 (rcirc-process-input-line line))
1060 ;; add to input-ring
1061 (save-excursion
1062 (ring-insert rcirc-input-ring input)
1063 (setq rcirc-input-ring-index 0))))))
1065 (defun rcirc-fill-paragraph (&optional arg)
1066 (interactive "p")
1067 (when (> (point) rcirc-prompt-end-marker)
1068 (save-restriction
1069 (narrow-to-region rcirc-prompt-end-marker (point-max))
1070 (let ((fill-column rcirc-max-message-length))
1071 (fill-region (point-min) (point-max))))))
1073 (defun rcirc-process-input-line (line)
1074 (if (string-match "^/\\([^ ]+\\) ?\\(.*\\)$" line)
1075 (rcirc-process-command (match-string 1 line)
1076 (match-string 2 line)
1077 line)
1078 (rcirc-process-message line)))
1080 (defun rcirc-process-message (line)
1081 (if (not rcirc-target)
1082 (message "Not joined (no target)")
1083 (delete-region rcirc-prompt-end-marker (point))
1084 (rcirc-send-message (rcirc-buffer-process) rcirc-target line)
1085 (setq rcirc-last-post-time (current-time))))
1087 (defun rcirc-process-command (command args line)
1088 (if (eq (aref command 0) ?/)
1089 ;; "//text" will send "/text" as a message
1090 (rcirc-process-message (substring line 1))
1091 (let ((fun (intern-soft (concat "rcirc-cmd-" command)))
1092 (process (rcirc-buffer-process)))
1093 (newline)
1094 (with-current-buffer (current-buffer)
1095 (delete-region rcirc-prompt-end-marker (point))
1096 (if (string= command "me")
1097 (rcirc-print process (rcirc-buffer-nick)
1098 "ACTION" rcirc-target args)
1099 (rcirc-print process (rcirc-buffer-nick)
1100 "COMMAND" rcirc-target line))
1101 (set-marker rcirc-prompt-end-marker (point))
1102 (if (fboundp fun)
1103 (funcall fun args process rcirc-target)
1104 (rcirc-send-string process
1105 (concat command " :" args)))))))
1107 (defvar rcirc-parent-buffer nil)
1108 (defvar rcirc-window-configuration nil)
1109 (defun rcirc-edit-multiline ()
1110 "Move current edit to a dedicated buffer."
1111 (interactive)
1112 (let ((pos (1+ (- (point) rcirc-prompt-end-marker))))
1113 (goto-char (point-max))
1114 (let ((text (buffer-substring-no-properties rcirc-prompt-end-marker
1115 (point)))
1116 (parent (buffer-name)))
1117 (delete-region rcirc-prompt-end-marker (point))
1118 (setq rcirc-window-configuration (current-window-configuration))
1119 (pop-to-buffer (concat "*multiline " parent "*"))
1120 (funcall rcirc-multiline-major-mode)
1121 (rcirc-multiline-minor-mode 1)
1122 (setq rcirc-parent-buffer parent)
1123 (insert text)
1124 (and (> pos 0) (goto-char pos))
1125 (message "Type C-c C-c to return text to %s, or C-c C-k to cancel" parent))))
1127 (defvar rcirc-multiline-minor-mode-map (make-sparse-keymap)
1128 "Keymap for multiline mode in rcirc.")
1129 (define-key rcirc-multiline-minor-mode-map
1130 (kbd "C-c C-c") 'rcirc-multiline-minor-submit)
1131 (define-key rcirc-multiline-minor-mode-map
1132 (kbd "C-x C-s") 'rcirc-multiline-minor-submit)
1133 (define-key rcirc-multiline-minor-mode-map
1134 (kbd "C-c C-k") 'rcirc-multiline-minor-cancel)
1135 (define-key rcirc-multiline-minor-mode-map
1136 (kbd "ESC ESC ESC") 'rcirc-multiline-minor-cancel)
1138 (define-minor-mode rcirc-multiline-minor-mode
1139 "Minor mode for editing multiple lines in rcirc."
1140 :init-value nil
1141 :lighter " rcirc-mline"
1142 :keymap rcirc-multiline-minor-mode-map
1143 :global nil
1144 :group 'rcirc
1145 (make-local-variable 'rcirc-parent-buffer)
1146 (put 'rcirc-parent-buffer 'permanent-local t)
1147 (setq fill-column rcirc-max-message-length))
1149 (defun rcirc-multiline-minor-submit ()
1150 "Send the text in buffer back to parent buffer."
1151 (interactive)
1152 (untabify (point-min) (point-max))
1153 (let ((text (buffer-substring (point-min) (point-max)))
1154 (buffer (current-buffer))
1155 (pos (point)))
1156 (set-buffer rcirc-parent-buffer)
1157 (goto-char (point-max))
1158 (insert text)
1159 (kill-buffer buffer)
1160 (set-window-configuration rcirc-window-configuration)
1161 (goto-char (+ rcirc-prompt-end-marker (1- pos)))))
1163 (defun rcirc-multiline-minor-cancel ()
1164 "Cancel the multiline edit."
1165 (interactive)
1166 (kill-buffer (current-buffer))
1167 (set-window-configuration rcirc-window-configuration))
1169 (defun rcirc-any-buffer (process)
1170 "Return a buffer for PROCESS, either the one selected or the process buffer."
1171 (if rcirc-always-use-server-buffer-flag
1172 (process-buffer process)
1173 (let ((buffer (window-buffer (selected-window))))
1174 (if (and buffer
1175 (with-current-buffer buffer
1176 (and (eq major-mode 'rcirc-mode)
1177 (eq (rcirc-buffer-process) process))))
1178 buffer
1179 (process-buffer process)))))
1181 (defcustom rcirc-response-formats
1182 '(("PRIVMSG" . "<%N> %m")
1183 ("NOTICE" . "-%N- %m")
1184 ("ACTION" . "[%N %m]")
1185 ("COMMAND" . "%m")
1186 ("ERROR" . "%fw!!! %m")
1187 (t . "%fp*** %fs%n %r %m"))
1188 "An alist of formats used for printing responses.
1189 The format is looked up using the response-type as a key;
1190 if no match is found, the default entry (with a key of `t') is used.
1192 The entry's value part should be a string, which is inserted with
1193 the of the following escape sequences replaced by the described values:
1195 %m The message text
1196 %n The sender's nick
1197 %N The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
1198 %r The response-type
1199 %t The target
1200 %fw Following text uses the face `font-lock-warning-face'
1201 %fp Following text uses the face `rcirc-server-prefix'
1202 %fs Following text uses the face `rcirc-server'
1203 %f[FACE] Following text uses the face FACE
1204 %f- Following text uses the default face
1205 %% A literal `%' character"
1206 :type '(alist :key-type (choice (string :tag "Type")
1207 (const :tag "Default" t))
1208 :value-type string)
1209 :group 'rcirc)
1211 (defcustom rcirc-omit-responses
1212 '("JOIN" "PART" "QUIT" "NICK")
1213 "Responses which will be hidden when `rcirc-omit-mode' is enabled."
1214 :type '(repeat string)
1215 :group 'rcirc)
1217 (defun rcirc-format-response-string (process sender response target text)
1218 "Return a nicely-formatted response string, incorporating TEXT
1219 \(and perhaps other arguments). The specific formatting used
1220 is found by looking up RESPONSE in `rcirc-response-formats'."
1221 (with-temp-buffer
1222 (insert (or (cdr (assoc response rcirc-response-formats))
1223 (cdr (assq t rcirc-response-formats))))
1224 (goto-char (point-min))
1225 (let ((start (point-min))
1226 (sender (if (or (not sender)
1227 (string= (rcirc-server-name process) sender))
1229 sender))
1230 face)
1231 (while (re-search-forward "%\\(\\(f\\(.\\)\\)\\|\\(.\\)\\)" nil t)
1232 (rcirc-add-face start (match-beginning 0) face)
1233 (setq start (match-beginning 0))
1234 (replace-match
1235 (case (aref (match-string 1) 0)
1236 (?f (setq face
1237 (case (string-to-char (match-string 3))
1238 (?w 'font-lock-warning-face)
1239 (?p 'rcirc-server-prefix)
1240 (?s 'rcirc-server)
1241 (t nil)))
1243 (?n sender)
1244 (?N (let ((my-nick (rcirc-nick process)))
1245 (save-match-data
1246 (with-syntax-table rcirc-nick-syntax-table
1247 (rcirc-facify sender
1248 (cond ((string= sender my-nick)
1249 'rcirc-my-nick)
1250 ((and rcirc-bright-nicks
1251 (string-match
1252 (regexp-opt rcirc-bright-nicks
1253 'words)
1254 sender))
1255 'rcirc-bright-nick)
1256 ((and rcirc-dim-nicks
1257 (string-match
1258 (regexp-opt rcirc-dim-nicks
1259 'words)
1260 sender))
1261 'rcirc-dim-nick)
1263 'rcirc-other-nick)))))))
1264 (?m (propertize text 'rcirc-text text))
1265 (?r response)
1266 (?t (or target ""))
1267 (t (concat "UNKNOWN CODE:" (match-string 0))))
1268 t t nil 0)
1269 (rcirc-add-face (match-beginning 0) (match-end 0) face))
1270 (rcirc-add-face start (match-beginning 0) face))
1271 (buffer-substring (point-min) (point-max))))
1273 (defun rcirc-target-buffer (process sender response target text)
1274 "Return a buffer to print the server response."
1275 (assert (not (bufferp target)))
1276 (with-rcirc-process-buffer process
1277 (cond ((not target)
1278 (rcirc-any-buffer process))
1279 ((not (rcirc-channel-p target))
1280 ;; message from another user
1281 (if (or (string= response "PRIVMSG")
1282 (string= response "ACTION"))
1283 (rcirc-get-buffer-create process (if (string= sender rcirc-nick)
1284 target
1285 sender))
1286 (rcirc-get-buffer process target t)))
1287 ((or (rcirc-get-buffer process target)
1288 (rcirc-any-buffer process))))))
1290 (defvar rcirc-activity-types nil)
1291 (make-variable-buffer-local 'rcirc-activity-types)
1292 (defvar rcirc-last-sender nil)
1293 (make-variable-buffer-local 'rcirc-last-sender)
1295 (defcustom rcirc-log-directory "~/.emacs.d/rcirc-log"
1296 "Directory to keep IRC logfiles."
1297 :type 'directory
1298 :group 'rcirc)
1300 (defcustom rcirc-log-flag nil
1301 "Non-nil means log IRC activity to disk.
1302 Logfiles are kept in `rcirc-log-directory'."
1303 :type 'boolean
1304 :group 'rcirc)
1306 (defcustom rcirc-omit-threshold 100
1307 "Number of lines since last activity from a nick before `rcirc-omit-responses' are omitted."
1308 :type 'integer
1309 :group 'rcirc)
1311 (defun rcirc-last-quit-line (process nick target)
1312 "Return the line number where NICK left TARGET.
1313 Returns nil if the information is not recorded."
1314 (let ((chanbuf (rcirc-get-buffer process target)))
1315 (when chanbuf
1316 (cdr (assoc-string nick (with-current-buffer chanbuf
1317 rcirc-recent-quit-alist))))))
1319 (defun rcirc-last-line (process nick target)
1320 "Return the line from the last activity from NICK in TARGET."
1321 (let* ((chanbuf (rcirc-get-buffer process target))
1322 (line (or (cdr (assoc-string target
1323 (gethash nick (with-rcirc-server-buffer
1324 rcirc-nick-table)) t))
1325 (rcirc-last-quit-line process nick target))))
1326 (if line
1327 line
1328 ;;(message "line is nil for %s in %s" nick target)
1329 nil)))
1331 (defun rcirc-elapsed-lines (process nick target)
1332 "Return the number of lines since activity from NICK in TARGET."
1333 (let ((last-activity-line (rcirc-last-line process nick target)))
1334 (when (and last-activity-line
1335 (> last-activity-line 0))
1336 (- rcirc-current-line last-activity-line))))
1338 (defvar rcirc-markup-text-functions
1339 '(rcirc-markup-attributes
1340 rcirc-markup-my-nick
1341 rcirc-markup-urls
1342 rcirc-markup-keywords
1343 rcirc-markup-bright-nicks)
1345 "List of functions used to manipulate text before it is printed.
1347 Each function takes two arguments, SENDER, and RESPONSE. The
1348 buffer is narrowed with the text to be printed and the point is
1349 at the beginning of the `rcirc-text' propertized text.")
1351 (defun rcirc-print (process sender response target text &optional activity)
1352 "Print TEXT in the buffer associated with TARGET.
1353 Format based on SENDER and RESPONSE. If ACTIVITY is non-nil,
1354 record activity."
1355 (or text (setq text ""))
1356 (unless (and (or (member sender rcirc-ignore-list)
1357 (member (with-syntax-table rcirc-nick-syntax-table
1358 (when (string-match "^\\([^/]\\w*\\)[:,]" text)
1359 (match-string 1 text)))
1360 rcirc-ignore-list))
1361 ;; do not ignore if we sent the message
1362 (not (string= sender (rcirc-nick process))))
1363 (let* ((buffer (rcirc-target-buffer process sender response target text))
1364 (inhibit-read-only t))
1365 (with-current-buffer buffer
1366 (let ((moving (= (point) rcirc-prompt-end-marker))
1367 (old-point (point-marker))
1368 (fill-start (marker-position rcirc-prompt-start-marker)))
1370 (unless (string= sender (rcirc-nick process))
1371 ;; only decode text from other senders, not ours
1372 (setq text (decode-coding-string text rcirc-decode-coding-system))
1373 ;; mark the line with overlay arrow
1374 (unless (or (marker-position overlay-arrow-position)
1375 (get-buffer-window (current-buffer))
1376 (member response rcirc-omit-responses))
1377 (set-marker overlay-arrow-position
1378 (marker-position rcirc-prompt-start-marker))))
1380 ;; temporarily set the marker insertion-type because
1381 ;; insert-before-markers results in hidden text in new buffers
1382 (goto-char rcirc-prompt-start-marker)
1383 (set-marker-insertion-type rcirc-prompt-start-marker t)
1384 (set-marker-insertion-type rcirc-prompt-end-marker t)
1386 (let ((start (point)))
1387 (insert (rcirc-format-response-string process sender response nil
1388 text)
1389 (propertize "\n" 'hard t))
1391 ;; squeeze spaces out of text before rcirc-text
1392 (fill-region fill-start
1393 (1- (or (next-single-property-change fill-start
1394 'rcirc-text)
1395 rcirc-prompt-end-marker)))
1397 ;; run markup functions
1398 (save-excursion
1399 (save-restriction
1400 (narrow-to-region start rcirc-prompt-start-marker)
1401 (goto-char (or (next-single-property-change start 'rcirc-text)
1402 (point)))
1403 (when (rcirc-buffer-process)
1404 (save-excursion (rcirc-markup-timestamp sender response))
1405 (dolist (fn rcirc-markup-text-functions)
1406 (save-excursion (funcall fn sender response)))
1407 (when rcirc-fill-flag
1408 (save-excursion (rcirc-markup-fill sender response))))
1410 (when rcirc-read-only-flag
1411 (add-text-properties (point-min) (point-max)
1412 '(read-only t front-sticky t))))
1413 ;; make text omittable
1414 (let ((last-activity-lines (rcirc-elapsed-lines process sender target)))
1415 (if (and (not (string= (rcirc-nick process) sender))
1416 (member response rcirc-omit-responses)
1417 (or (not last-activity-lines)
1418 (< rcirc-omit-threshold last-activity-lines)))
1419 (put-text-property (1- start) (1- rcirc-prompt-start-marker)
1420 'invisible 'rcirc-omit)
1421 ;; otherwise increment the line count
1422 (setq rcirc-current-line (1+ rcirc-current-line))))))
1424 (set-marker-insertion-type rcirc-prompt-start-marker nil)
1425 (set-marker-insertion-type rcirc-prompt-end-marker nil)
1427 ;; truncate buffer if it is very long
1428 (save-excursion
1429 (when (and rcirc-buffer-maximum-lines
1430 (> rcirc-buffer-maximum-lines 0)
1431 (= (forward-line (- rcirc-buffer-maximum-lines)) 0))
1432 (delete-region (point-min) (point))))
1434 ;; set the window point for buffers show in windows
1435 (walk-windows (lambda (w)
1436 (when (and (not (eq (selected-window) w))
1437 (eq (current-buffer)
1438 (window-buffer w))
1439 (>= (window-point w)
1440 rcirc-prompt-end-marker))
1441 (set-window-point w (point-max))))
1442 nil t)
1444 ;; restore the point
1445 (goto-char (if moving rcirc-prompt-end-marker old-point))
1447 ;; keep window on bottom line if it was already there
1448 (when rcirc-scroll-show-maximum-output
1449 (walk-windows (lambda (w)
1450 (when (eq (window-buffer w) (current-buffer))
1451 (with-current-buffer (window-buffer w)
1452 (when (eq major-mode 'rcirc-mode)
1453 (with-selected-window w
1454 (when (<= (- (window-height)
1455 (count-screen-lines (window-point)
1456 (window-start))
1459 (recenter -1)))))))
1460 nil t))
1462 ;; flush undo (can we do something smarter here?)
1463 (buffer-disable-undo)
1464 (buffer-enable-undo))
1466 ;; record modeline activity
1467 (when (and activity
1468 (not rcirc-ignore-buffer-activity-flag)
1469 (not (and rcirc-dim-nicks sender
1470 (string-match (regexp-opt rcirc-dim-nicks) sender)
1471 (rcirc-channel-p target))))
1472 (rcirc-record-activity (current-buffer)
1473 (when (not (rcirc-channel-p rcirc-target))
1474 'nick)))
1476 (when rcirc-log-flag
1477 (rcirc-log process sender response target text))
1479 (sit-for 0) ; displayed text before hook
1480 (run-hook-with-args 'rcirc-print-hooks
1481 process sender response target text)))))
1483 (defun rcirc-log (process sender response target text)
1484 "Record line in `rcirc-log', to be later written to disk."
1485 (let* ((filename (rcirc-generate-new-buffer-name process target))
1486 (cell (assoc-string filename rcirc-log-alist))
1487 (line (concat (format-time-string rcirc-time-format)
1488 (substring-no-properties
1489 (rcirc-format-response-string process sender
1490 response target text))
1491 "\n")))
1492 (if cell
1493 (setcdr cell (concat (cdr cell) line))
1494 (setq rcirc-log-alist
1495 (cons (cons filename line) rcirc-log-alist)))))
1497 (defun rcirc-log-write ()
1498 "Flush `rcirc-log-alist' data to disk.
1500 Log data is written to `rcirc-log-directory'."
1501 (make-directory rcirc-log-directory t)
1502 (dolist (cell rcirc-log-alist)
1503 (with-temp-buffer
1504 (insert (cdr cell))
1505 (let ((coding-system-for-write 'utf-8))
1506 (write-region (point-min) (point-max)
1507 (concat rcirc-log-directory "/" (car cell))
1508 t 'quiet))))
1509 (setq rcirc-log-alist nil))
1511 (defun rcirc-join-channels (process channels)
1512 "Join CHANNELS."
1513 (save-window-excursion
1514 (dolist (channel channels)
1515 (with-rcirc-process-buffer process
1516 (rcirc-cmd-join channel process)))))
1518 ;;; nick management
1519 (defvar rcirc-nick-prefix-chars "~&@%+")
1520 (defun rcirc-user-nick (user)
1521 "Return the nick from USER. Remove any non-nick junk."
1522 (save-match-data
1523 (if (string-match (concat "^[" rcirc-nick-prefix-chars
1524 "]?\\([^! ]+\\)!?") (or user ""))
1525 (match-string 1 user)
1526 user)))
1528 (defun rcirc-nick-channels (process nick)
1529 "Return list of channels for NICK."
1530 (with-rcirc-process-buffer process
1531 (mapcar (lambda (x) (car x))
1532 (gethash nick rcirc-nick-table))))
1534 (defun rcirc-put-nick-channel (process nick channel &optional line)
1535 "Add CHANNEL to list associated with NICK.
1536 Update the associated linestamp if LINE is non-nil.
1538 If the record doesn't exist, and LINE is nil, set the linestamp
1539 to zero."
1540 (let ((nick (rcirc-user-nick nick)))
1541 (with-rcirc-process-buffer process
1542 (let* ((chans (gethash nick rcirc-nick-table))
1543 (record (assoc-string channel chans t)))
1544 (if record
1545 (when line (setcdr record line))
1546 (puthash nick (cons (cons channel (or line 0))
1547 chans)
1548 rcirc-nick-table))))))
1550 (defun rcirc-nick-remove (process nick)
1551 "Remove NICK from table."
1552 (with-rcirc-process-buffer process
1553 (remhash nick rcirc-nick-table)))
1555 (defun rcirc-remove-nick-channel (process nick channel)
1556 "Remove the CHANNEL from list associated with NICK."
1557 (with-rcirc-process-buffer process
1558 (let* ((chans (gethash nick rcirc-nick-table))
1559 (newchans
1560 ;; instead of assoc-string-delete-all:
1561 (let ((record (assoc-string channel chans t)))
1562 (when record
1563 (setcar record 'delete)
1564 (assq-delete-all 'delete chans)))))
1565 (if newchans
1566 (puthash nick newchans rcirc-nick-table)
1567 (remhash nick rcirc-nick-table)))))
1569 (defun rcirc-channel-nicks (process target)
1570 "Return the list of nicks associated with TARGET sorted by last activity."
1571 (when target
1572 (if (rcirc-channel-p target)
1573 (with-rcirc-process-buffer process
1574 (let (nicks)
1575 (maphash
1576 (lambda (k v)
1577 (let ((record (assoc-string target v t)))
1578 (if record
1579 (setq nicks (cons (cons k (cdr record)) nicks)))))
1580 rcirc-nick-table)
1581 (mapcar (lambda (x) (car x))
1582 (sort nicks (lambda (x y)
1583 (let ((lx (or (cdr x) 0))
1584 (ly (or (cdr y) 0)))
1585 (< ly lx)))))))
1586 (list target))))
1588 (defun rcirc-ignore-update-automatic (nick)
1589 "Remove NICK from `rcirc-ignore-list'
1590 if NICK is also on `rcirc-ignore-list-automatic'."
1591 (when (member nick rcirc-ignore-list-automatic)
1592 (setq rcirc-ignore-list-automatic
1593 (delete nick rcirc-ignore-list-automatic)
1594 rcirc-ignore-list
1595 (delete nick rcirc-ignore-list))))
1597 ;;; activity tracking
1598 (defvar rcirc-track-minor-mode-map (make-sparse-keymap)
1599 "Keymap for rcirc track minor mode.")
1601 (define-key rcirc-track-minor-mode-map (kbd "C-c `") 'rcirc-next-active-buffer)
1602 (define-key rcirc-track-minor-mode-map (kbd "C-c C-@") 'rcirc-next-active-buffer)
1603 (define-key rcirc-track-minor-mode-map (kbd "C-c C-SPC") 'rcirc-next-active-buffer)
1605 ;;;###autoload
1606 (define-minor-mode rcirc-track-minor-mode
1607 "Global minor mode for tracking activity in rcirc buffers."
1608 :init-value nil
1609 :lighter ""
1610 :keymap rcirc-track-minor-mode-map
1611 :global t
1612 :group 'rcirc
1613 (or global-mode-string (setq global-mode-string '("")))
1614 ;; toggle the mode-line channel indicator
1615 (if rcirc-track-minor-mode
1616 (progn
1617 (and (not (memq 'rcirc-activity-string global-mode-string))
1618 (setq global-mode-string
1619 (append global-mode-string '(rcirc-activity-string))))
1620 (add-hook 'window-configuration-change-hook
1621 'rcirc-window-configuration-change))
1622 (setq global-mode-string
1623 (delete 'rcirc-activity-string global-mode-string))
1624 (remove-hook 'window-configuration-change-hook
1625 'rcirc-window-configuration-change)))
1627 (or (assq 'rcirc-ignore-buffer-activity-flag minor-mode-alist)
1628 (setq minor-mode-alist
1629 (cons '(rcirc-ignore-buffer-activity-flag " Ignore") minor-mode-alist)))
1630 (or (assq 'rcirc-low-priority-flag minor-mode-alist)
1631 (setq minor-mode-alist
1632 (cons '(rcirc-low-priority-flag " LowPri") minor-mode-alist)))
1633 (or (assq 'rcirc-omit-mode minor-mode-alist)
1634 (setq minor-mode-alist
1635 (cons '(rcirc-omit-mode " Omit") minor-mode-alist)))
1637 (defun rcirc-toggle-ignore-buffer-activity ()
1638 "Toggle the value of `rcirc-ignore-buffer-activity-flag'."
1639 (interactive)
1640 (setq rcirc-ignore-buffer-activity-flag
1641 (not rcirc-ignore-buffer-activity-flag))
1642 (message (if rcirc-ignore-buffer-activity-flag
1643 "Ignore activity in this buffer"
1644 "Notice activity in this buffer"))
1645 (force-mode-line-update))
1647 (defun rcirc-toggle-low-priority ()
1648 "Toggle the value of `rcirc-low-priority-flag'."
1649 (interactive)
1650 (setq rcirc-low-priority-flag
1651 (not rcirc-low-priority-flag))
1652 (message (if rcirc-low-priority-flag
1653 "Activity in this buffer is low priority"
1654 "Activity in this buffer is normal priority"))
1655 (force-mode-line-update))
1657 (defun rcirc-omit-mode ()
1658 "Toggle the Rcirc-Omit mode.
1659 If enabled, \"uninteresting\" lines are not shown.
1660 Uninteresting lines are those whose responses are listed in
1661 `rcirc-omit-responses'."
1662 (interactive)
1663 (setq rcirc-omit-mode (not rcirc-omit-mode))
1664 (if rcirc-omit-mode
1665 (progn
1666 (add-to-invisibility-spec '(rcirc-omit . t))
1667 (message "Rcirc-Omit mode enabled"))
1668 (remove-from-invisibility-spec '(rcirc-omit . t))
1669 (message "Rcirc-Omit mode disabled"))
1670 (recenter (when (> (point) rcirc-prompt-start-marker) -1)))
1672 (defun rcirc-switch-to-server-buffer ()
1673 "Switch to the server buffer associated with current channel buffer."
1674 (interactive)
1675 (switch-to-buffer rcirc-server-buffer))
1677 (defun rcirc-jump-to-first-unread-line ()
1678 "Move the point to the first unread line in this buffer."
1679 (interactive)
1680 (if (marker-position overlay-arrow-position)
1681 (goto-char overlay-arrow-position)
1682 (message "No unread messages")))
1684 (defun rcirc-non-irc-buffer ()
1685 (let ((buflist (buffer-list))
1686 buffer)
1687 (while (and buflist (not buffer))
1688 (with-current-buffer (car buflist)
1689 (unless (or (eq major-mode 'rcirc-mode)
1690 (= ?\s (aref (buffer-name) 0)) ; internal buffers
1691 (get-buffer-window (current-buffer)))
1692 (setq buffer (current-buffer))))
1693 (setq buflist (cdr buflist)))
1694 buffer))
1696 (defun rcirc-next-active-buffer (arg)
1697 "Switch to the next rcirc buffer with activity.
1698 With prefix ARG, go to the next low priority buffer with activity."
1699 (interactive "P")
1700 (let* ((pair (rcirc-split-activity rcirc-activity))
1701 (lopri (car pair))
1702 (hipri (cdr pair)))
1703 (if (or (and (not arg) hipri)
1704 (and arg lopri))
1705 (progn
1706 (switch-to-buffer (car (if arg lopri hipri)))
1707 (when (> (point) rcirc-prompt-start-marker)
1708 (recenter -1)))
1709 (if (eq major-mode 'rcirc-mode)
1710 (switch-to-buffer (rcirc-non-irc-buffer))
1711 (message (concat
1712 "No IRC activity."
1713 (when lopri
1714 (concat
1715 " Type C-u "
1716 (key-description (this-command-keys))
1717 " for low priority activity."))))))))
1719 (defvar rcirc-activity-hooks nil
1720 "Hook to be run when there is channel activity.
1722 Functions are called with a single argument, the buffer with the
1723 activity. Only run if the buffer is not visible and
1724 `rcirc-ignore-buffer-activity-flag' is non-nil.")
1726 (defun rcirc-record-activity (buffer &optional type)
1727 "Record BUFFER activity with TYPE."
1728 (with-current-buffer buffer
1729 (let ((old-activity rcirc-activity)
1730 (old-types rcirc-activity-types))
1731 (when (not (get-buffer-window (current-buffer) t))
1732 (setq rcirc-activity
1733 (sort (add-to-list 'rcirc-activity (current-buffer))
1734 (lambda (b1 b2)
1735 (let ((t1 (with-current-buffer b1 rcirc-last-post-time))
1736 (t2 (with-current-buffer b2 rcirc-last-post-time)))
1737 (time-less-p t2 t1)))))
1738 (pushnew type rcirc-activity-types)
1739 (unless (and (equal rcirc-activity old-activity)
1740 (member type old-types))
1741 (rcirc-update-activity-string)))))
1742 (run-hook-with-args 'rcirc-activity-hooks buffer))
1744 (defun rcirc-clear-activity (buffer)
1745 "Clear the BUFFER activity."
1746 (setq rcirc-activity (remove buffer rcirc-activity))
1747 (with-current-buffer buffer
1748 (setq rcirc-activity-types nil)))
1750 (defun rcirc-clear-unread (buffer)
1751 "Erase the last read message arrow from BUFFER."
1752 (when (buffer-live-p buffer)
1753 (with-current-buffer buffer
1754 (set-marker overlay-arrow-position nil))))
1756 (defun rcirc-split-activity (activity)
1757 "Return a cons cell with ACTIVITY split into (lopri . hipri)."
1758 (let (lopri hipri)
1759 (dolist (buf rcirc-activity)
1760 (with-current-buffer buf
1761 (if (and rcirc-low-priority-flag
1762 (not (member 'nick rcirc-activity-types)))
1763 (add-to-list 'lopri buf t)
1764 (add-to-list 'hipri buf t))))
1765 (cons lopri hipri)))
1767 (defvar rcirc-update-activity-string-hook nil
1768 "Hook run whenever the activity string is updated.")
1770 ;; TODO: add mouse properties
1771 (defun rcirc-update-activity-string ()
1772 "Update mode-line string."
1773 (let* ((pair (rcirc-split-activity rcirc-activity))
1774 (lopri (car pair))
1775 (hipri (cdr pair)))
1776 (setq rcirc-activity-string
1777 (cond ((or hipri lopri)
1778 (concat (and hipri "[")
1779 (rcirc-activity-string hipri)
1780 (and hipri lopri ",")
1781 (and lopri
1782 (concat "("
1783 (rcirc-activity-string lopri)
1784 ")"))
1785 (and hipri "]")))
1786 ((not (null (rcirc-process-list)))
1787 "[]")
1788 (t "[]")))
1789 (run-hooks 'rcirc-update-activity-string-hook)))
1791 (defun rcirc-activity-string (buffers)
1792 (mapconcat (lambda (b)
1793 (let ((s (substring-no-properties (rcirc-short-buffer-name b))))
1794 (with-current-buffer b
1795 (dolist (type rcirc-activity-types)
1796 (rcirc-add-face 0 (length s)
1797 (case type
1798 (nick 'rcirc-track-nick)
1799 (keyword 'rcirc-track-keyword))
1800 s)))
1802 buffers ","))
1804 (defun rcirc-short-buffer-name (buffer)
1805 "Return a short name for BUFFER to use in the modeline indicator."
1806 (with-current-buffer buffer
1807 (or rcirc-short-buffer-name (buffer-name))))
1809 (defun rcirc-visible-buffers ()
1810 "Return a list of the visible buffers that are in rcirc-mode."
1811 (let (acc)
1812 (walk-windows (lambda (w)
1813 (with-current-buffer (window-buffer w)
1814 (when (eq major-mode 'rcirc-mode)
1815 (push (current-buffer) acc)))))
1816 acc))
1818 (defvar rcirc-visible-buffers nil)
1819 (defun rcirc-window-configuration-change ()
1820 (unless (minibuffer-window-active-p (minibuffer-window))
1821 ;; delay this until command has finished to make sure window is
1822 ;; actually visible before clearing activity
1823 (add-hook 'post-command-hook 'rcirc-window-configuration-change-1)))
1825 (defun rcirc-window-configuration-change-1 ()
1826 ;; clear activity and overlay arrows
1827 (let* ((old-activity rcirc-activity)
1828 (hidden-buffers rcirc-visible-buffers))
1830 (setq rcirc-visible-buffers (rcirc-visible-buffers))
1832 (dolist (vbuf rcirc-visible-buffers)
1833 (setq hidden-buffers (delq vbuf hidden-buffers))
1834 ;; clear activity for all visible buffers
1835 (rcirc-clear-activity vbuf))
1837 ;; clear unread arrow from recently hidden buffers
1838 (dolist (hbuf hidden-buffers)
1839 (rcirc-clear-unread hbuf))
1841 ;; remove any killed buffers from list
1842 (setq rcirc-activity
1843 (delq nil (mapcar (lambda (buf) (when (buffer-live-p buf) buf))
1844 rcirc-activity)))
1845 ;; update the mode-line string
1846 (unless (equal old-activity rcirc-activity)
1847 (rcirc-update-activity-string)))
1849 (remove-hook 'post-command-hook 'rcirc-window-configuration-change-1))
1852 ;;; buffer name abbreviation
1853 (defun rcirc-update-short-buffer-names ()
1854 (let ((bufalist
1855 (apply 'append (mapcar (lambda (process)
1856 (with-rcirc-process-buffer process
1857 rcirc-buffer-alist))
1858 (rcirc-process-list)))))
1859 (dolist (i (rcirc-abbreviate bufalist))
1860 (when (buffer-live-p (cdr i))
1861 (with-current-buffer (cdr i)
1862 (setq rcirc-short-buffer-name (car i)))))))
1864 (defun rcirc-abbreviate (pairs)
1865 (apply 'append (mapcar 'rcirc-rebuild-tree (rcirc-make-trees pairs))))
1867 (defun rcirc-rebuild-tree (tree &optional acc)
1868 (let ((ch (char-to-string (car tree))))
1869 (dolist (x (cdr tree))
1870 (if (listp x)
1871 (setq acc (append acc
1872 (mapcar (lambda (y)
1873 (cons (concat ch (car y))
1874 (cdr y)))
1875 (rcirc-rebuild-tree x))))
1876 (setq acc (cons (cons ch x) acc))))
1877 acc))
1879 (defun rcirc-make-trees (pairs)
1880 (let (alist)
1881 (mapc (lambda (pair)
1882 (if (consp pair)
1883 (let* ((str (car pair))
1884 (data (cdr pair))
1885 (char (unless (zerop (length str))
1886 (aref str 0)))
1887 (rest (unless (zerop (length str))
1888 (substring str 1)))
1889 (part (if char (assq char alist))))
1890 (if part
1891 ;; existing partition
1892 (setcdr part (cons (cons rest data) (cdr part)))
1893 ;; new partition
1894 (setq alist (cons (if char
1895 (list char (cons rest data))
1896 data)
1897 alist))))
1898 (setq alist (cons pair alist))))
1899 pairs)
1900 ;; recurse into cdrs of alist
1901 (mapc (lambda (x)
1902 (when (and (listp x) (listp (cadr x)))
1903 (setcdr x (if (> (length (cdr x)) 1)
1904 (rcirc-make-trees (cdr x))
1905 (setcdr x (list (cdadr x)))))))
1906 alist)))
1908 ;;; /commands these are called with 3 args: PROCESS, TARGET, which is
1909 ;; the current buffer/channel/user, and ARGS, which is a string
1910 ;; containing the text following the /cmd.
1912 (defmacro defun-rcirc-command (command argument docstring interactive-form
1913 &rest body)
1914 "Define a command."
1915 `(defun ,(intern (concat "rcirc-cmd-" (symbol-name command)))
1916 (,@argument &optional process target)
1917 ,(concat docstring "\n\nNote: If PROCESS or TARGET are nil, the values given"
1918 "\nby `rcirc-buffer-process' and `rcirc-target' will be used.")
1919 ,interactive-form
1920 (let ((process (or process (rcirc-buffer-process)))
1921 (target (or target rcirc-target)))
1922 ,@body)))
1924 (defun-rcirc-command msg (message)
1925 "Send private MESSAGE to TARGET."
1926 (interactive "i")
1927 (if (null message)
1928 (progn
1929 (setq target (completing-read "Message nick: "
1930 (with-rcirc-server-buffer
1931 rcirc-nick-table)))
1932 (when (> (length target) 0)
1933 (setq message (read-string (format "Message %s: " target)))
1934 (when (> (length message) 0)
1935 (rcirc-send-message process target message))))
1936 (if (not (string-match "\\([^ ]+\\) \\(.+\\)" message))
1937 (message "Not enough args, or something.")
1938 (setq target (match-string 1 message)
1939 message (match-string 2 message))
1940 (rcirc-send-message process target message))))
1942 (defun-rcirc-command query (nick)
1943 "Open a private chat buffer to NICK."
1944 (interactive (list (completing-read "Query nick: "
1945 (with-rcirc-server-buffer rcirc-nick-table))))
1946 (let ((existing-buffer (rcirc-get-buffer process nick)))
1947 (switch-to-buffer (or existing-buffer
1948 (rcirc-get-buffer-create process nick)))
1949 (when (not existing-buffer)
1950 (rcirc-cmd-whois nick))))
1952 (defun-rcirc-command join (channel)
1953 "Join CHANNEL."
1954 (interactive "sJoin channel: ")
1955 (let ((buffer (rcirc-get-buffer-create process
1956 (car (split-string channel)))))
1957 (rcirc-send-string process (concat "JOIN " channel))
1958 (when (not (eq (selected-window) (minibuffer-window)))
1959 (switch-to-buffer buffer))))
1961 ;; TODO: /part #channel reason, or consider removing #channel altogether
1962 (defun-rcirc-command part (channel)
1963 "Part CHANNEL."
1964 (interactive "sPart channel: ")
1965 (let ((channel (if (> (length channel) 0) channel target)))
1966 (rcirc-send-string process (concat "PART " channel " :" rcirc-id-string))))
1968 (defun-rcirc-command quit (reason)
1969 "Send a quit message to server with REASON."
1970 (interactive "sQuit reason: ")
1971 (rcirc-send-string process (concat "QUIT :"
1972 (if (not (zerop (length reason)))
1973 reason
1974 rcirc-id-string))))
1976 (defun-rcirc-command nick (nick)
1977 "Change nick to NICK."
1978 (interactive "i")
1979 (when (null nick)
1980 (setq nick (read-string "New nick: " (rcirc-nick process))))
1981 (rcirc-send-string process (concat "NICK " nick)))
1983 (defun-rcirc-command names (channel)
1984 "Display list of names in CHANNEL or in current channel if CHANNEL is nil.
1985 If called interactively, prompt for a channel when prefix arg is supplied."
1986 (interactive "P")
1987 (if (interactive-p)
1988 (if channel
1989 (setq channel (read-string "List names in channel: " target))))
1990 (let ((channel (if (> (length channel) 0)
1991 channel
1992 target)))
1993 (rcirc-send-string process (concat "NAMES " channel))))
1995 (defun-rcirc-command topic (topic)
1996 "List TOPIC for the TARGET channel.
1997 With a prefix arg, prompt for new topic."
1998 (interactive "P")
1999 (if (and (interactive-p) topic)
2000 (setq topic (read-string "New Topic: " rcirc-topic)))
2001 (rcirc-send-string process (concat "TOPIC " target
2002 (when (> (length topic) 0)
2003 (concat " :" topic)))))
2005 (defun-rcirc-command whois (nick)
2006 "Request information from server about NICK."
2007 (interactive (list
2008 (completing-read "Whois: "
2009 (with-rcirc-server-buffer rcirc-nick-table))))
2010 (rcirc-send-string process (concat "WHOIS " nick)))
2012 (defun-rcirc-command mode (args)
2013 "Set mode with ARGS."
2014 (interactive (list (concat (read-string "Mode nick or channel: ")
2015 " " (read-string "Mode: "))))
2016 (rcirc-send-string process (concat "MODE " args)))
2018 (defun-rcirc-command list (channels)
2019 "Request information on CHANNELS from server."
2020 (interactive "sList Channels: ")
2021 (rcirc-send-string process (concat "LIST " channels)))
2023 (defun-rcirc-command oper (args)
2024 "Send operator command to server."
2025 (interactive "sOper args: ")
2026 (rcirc-send-string process (concat "OPER " args)))
2028 (defun-rcirc-command quote (message)
2029 "Send MESSAGE literally to server."
2030 (interactive "sServer message: ")
2031 (rcirc-send-string process message))
2033 (defun-rcirc-command kick (arg)
2034 "Kick NICK from current channel."
2035 (interactive (list
2036 (concat (completing-read "Kick nick: "
2037 (rcirc-channel-nicks
2038 (rcirc-buffer-process)
2039 rcirc-target))
2040 (read-from-minibuffer "Kick reason: "))))
2041 (let* ((arglist (split-string arg))
2042 (argstring (concat (car arglist) " :"
2043 (mapconcat 'identity (cdr arglist) " "))))
2044 (rcirc-send-string process (concat "KICK " target " " argstring))))
2046 (defun rcirc-cmd-ctcp (args &optional process target)
2047 (if (string-match "^\\([^ ]+\\)\\s-+\\(.+\\)$" args)
2048 (let ((target (match-string 1 args))
2049 (request (match-string 2 args)))
2050 (rcirc-send-string process
2051 (format "PRIVMSG %s \C-a%s\C-a"
2052 target (upcase request))))
2053 (rcirc-print process (rcirc-nick process) "ERROR" nil
2054 "usage: /ctcp NICK REQUEST")))
2056 (defun rcirc-cmd-me (args &optional process target)
2057 (rcirc-send-string process (format "PRIVMSG %s :\C-aACTION %s\C-a"
2058 target args)))
2060 (defun rcirc-add-or-remove (set &optional elt)
2061 (if (and elt (not (string= "" elt)))
2062 (if (member-ignore-case elt set)
2063 (delete elt set)
2064 (cons elt set))
2065 set))
2067 (defun-rcirc-command ignore (nick)
2068 "Manage the ignore list.
2069 Ignore NICK, unignore NICK if already ignored, or list ignored
2070 nicks when no NICK is given. When listing ignored nicks, the
2071 ones added to the list automatically are marked with an asterisk."
2072 (interactive "sToggle ignoring of nick: ")
2073 (setq rcirc-ignore-list (rcirc-add-or-remove rcirc-ignore-list nick))
2074 (rcirc-print process nil "IGNORE" target
2075 (mapconcat
2076 (lambda (nick)
2077 (concat nick
2078 (if (member nick rcirc-ignore-list-automatic)
2079 "*" "")))
2080 rcirc-ignore-list " ")))
2082 (defun-rcirc-command bright (nick)
2083 "Manage the bright nick list."
2084 (interactive "sToggle emphasis of nick: ")
2085 (setq rcirc-bright-nicks (rcirc-add-or-remove rcirc-bright-nicks nick))
2086 (rcirc-print process nil "BRIGHT" target
2087 (mapconcat 'identity rcirc-bright-nicks " ")))
2089 (defun-rcirc-command dim (nick)
2090 "Manage the dim nick list."
2091 (interactive "sToggle deemphasis of nick: ")
2092 (setq rcirc-dim-nicks (rcirc-add-or-remove rcirc-dim-nicks nick))
2093 (rcirc-print process nil "DIM" target
2094 (mapconcat 'identity rcirc-dim-nicks " ")))
2096 (defun-rcirc-command keyword (keyword)
2097 "Manage the keyword list.
2098 Mark KEYWORD, unmark KEYWORD if already marked, or list marked
2099 keywords when no KEYWORD is given."
2100 (interactive "sToggle highlighting of keyword: ")
2101 (setq rcirc-keywords (rcirc-add-or-remove rcirc-keywords keyword))
2102 (rcirc-print process nil "KEYWORD" target
2103 (mapconcat 'identity rcirc-keywords " ")))
2106 (defun rcirc-add-face (start end name &optional object)
2107 "Add face NAME to the face text property of the text from START to END."
2108 (when name
2109 (let ((pos start)
2110 next prop)
2111 (while (< pos end)
2112 (setq prop (get-text-property pos 'face object)
2113 next (next-single-property-change pos 'face object end))
2114 (unless (member name (get-text-property pos 'face object))
2115 (add-text-properties pos next (list 'face (cons name prop)) object))
2116 (setq pos next)))))
2118 (defun rcirc-facify (string face)
2119 "Return a copy of STRING with FACE property added."
2120 (let ((string (or string "")))
2121 (rcirc-add-face 0 (length string) face string)
2122 string))
2124 (defvar rcirc-url-regexp
2125 (rx-to-string
2126 `(and word-boundary
2127 (or (and
2128 (or (and (or "http" "https" "ftp" "file" "gopher" "news"
2129 "telnet" "wais" "mailto")
2130 "://")
2131 "www.")
2132 (1+ (char "-a-zA-Z0-9_."))
2133 (1+ (char "-a-zA-Z0-9_"))
2134 (optional ":" (1+ (char "0-9"))))
2135 (and (1+ (char "-a-zA-Z0-9_."))
2136 (or ".com" ".net" ".org")
2137 word-boundary))
2138 (optional
2139 (and "/"
2140 (1+ (char "-a-zA-Z0-9_='!?#$\@~`%&*+|\\/:;.,{}[]()"))
2141 (char "-a-zA-Z0-9_=#$\@~`%&*+|\\/:;{}[]()")))))
2142 "Regexp matching URLs. Set to nil to disable URL features in rcirc.")
2144 (defun rcirc-browse-url (&optional arg)
2145 "Prompt for URL to browse based on URLs in buffer."
2146 (interactive "P")
2147 (let ((completions (mapcar (lambda (x) (cons x nil)) rcirc-urls))
2148 (initial-input (car rcirc-urls))
2149 (history (cdr rcirc-urls)))
2150 (browse-url (completing-read "rcirc browse-url: "
2151 completions nil nil initial-input 'history)
2152 arg)))
2154 (defun rcirc-browse-url-at-point (point)
2155 "Send URL at point to `browse-url'."
2156 (interactive "d")
2157 (let ((beg (previous-single-property-change (1+ point) 'mouse-face))
2158 (end (next-single-property-change point 'mouse-face)))
2159 (browse-url (buffer-substring-no-properties beg end))))
2161 (defun rcirc-browse-url-at-mouse (event)
2162 "Send URL at mouse click to `browse-url'."
2163 (interactive "e")
2164 (let ((position (event-end event)))
2165 (with-current-buffer (window-buffer (posn-window position))
2166 (rcirc-browse-url-at-point (posn-point position)))))
2169 (defun rcirc-markup-timestamp (sender response)
2170 (goto-char (point-min))
2171 (insert (rcirc-facify (format-time-string rcirc-time-format)
2172 'rcirc-timestamp)))
2174 (defun rcirc-markup-attributes (sender response)
2175 (while (re-search-forward "\\([\C-b\C-_\C-v]\\).*?\\(\\1\\|\C-o\\)" nil t)
2176 (rcirc-add-face (match-beginning 0) (match-end 0)
2177 (case (char-after (match-beginning 1))
2178 (?\C-b 'bold)
2179 (?\C-v 'italic)
2180 (?\C-_ 'underline)))
2181 ;; keep the ^O since it could terminate other attributes
2182 (when (not (eq ?\C-o (char-before (match-end 2))))
2183 (delete-region (match-beginning 2) (match-end 2)))
2184 (delete-region (match-beginning 1) (match-end 1))
2185 (goto-char (1+ (match-beginning 1))))
2186 ;; remove the ^O characters now
2187 (while (re-search-forward "\C-o+" nil t)
2188 (delete-region (match-beginning 0) (match-end 0))))
2190 (defun rcirc-markup-my-nick (sender response)
2191 (with-syntax-table rcirc-nick-syntax-table
2192 (while (re-search-forward (concat "\\b"
2193 (regexp-quote (rcirc-nick
2194 (rcirc-buffer-process)))
2195 "\\b")
2196 nil t)
2197 (rcirc-add-face (match-beginning 0) (match-end 0)
2198 'rcirc-nick-in-message)
2199 (when (string= response "PRIVMSG")
2200 (rcirc-add-face (point-min) (point-max)
2201 'rcirc-nick-in-message-full-line)
2202 (rcirc-record-activity (current-buffer) 'nick)))))
2204 (defun rcirc-markup-urls (sender response)
2205 (while (re-search-forward rcirc-url-regexp nil t)
2206 (let ((start (match-beginning 0))
2207 (end (match-end 0)))
2208 (rcirc-add-face start end 'rcirc-url)
2209 (add-text-properties start end (list 'mouse-face 'highlight
2210 'keymap rcirc-browse-url-map))
2211 ;; record the url
2212 (push (buffer-substring-no-properties start end) rcirc-urls))))
2214 (defun rcirc-markup-keywords (sender response)
2215 (when (and (string= response "PRIVMSG")
2216 (not (string= sender (rcirc-nick (rcirc-buffer-process)))))
2217 (let* ((target (or rcirc-target ""))
2218 (keywords (delq nil (mapcar (lambda (keyword)
2219 (when (not (string-match keyword
2220 target))
2221 keyword))
2222 rcirc-keywords))))
2223 (when keywords
2224 (while (re-search-forward (regexp-opt keywords 'words) nil t)
2225 (rcirc-add-face (match-beginning 0) (match-end 0) 'rcirc-keyword)
2226 (rcirc-record-activity (current-buffer) 'keyword))))))
2228 (defun rcirc-markup-bright-nicks (sender response)
2229 (when (and rcirc-bright-nicks
2230 (string= response "NAMES"))
2231 (with-syntax-table rcirc-nick-syntax-table
2232 (while (re-search-forward (regexp-opt rcirc-bright-nicks 'words) nil t)
2233 (rcirc-add-face (match-beginning 0) (match-end 0)
2234 'rcirc-bright-nick)))))
2236 (defun rcirc-markup-fill (sender response)
2237 (when (not (string= response "372")) ; /motd
2238 (let ((fill-prefix
2239 (or rcirc-fill-prefix
2240 (make-string (- (point) (line-beginning-position)) ?\s)))
2241 (fill-column (- (cond ((eq rcirc-fill-column 'frame-width)
2242 (1- (frame-width)))
2243 (rcirc-fill-column
2244 rcirc-fill-column)
2245 (t fill-column))
2246 ;; make sure ... doesn't cause line wrapping
2247 3)))
2248 (fill-region (point) (point-max) nil t))))
2250 ;;; handlers
2251 ;; these are called with the server PROCESS, the SENDER, which is a
2252 ;; server or a user, depending on the command, the ARGS, which is a
2253 ;; list of strings, and the TEXT, which is the original server text,
2254 ;; verbatim
2255 (defun rcirc-handler-001 (process sender args text)
2256 (rcirc-handler-generic process "001" sender args text)
2257 (with-rcirc-process-buffer process
2258 (setq rcirc-connecting nil)
2259 (rcirc-reschedule-timeout process)
2260 (setq rcirc-server-name sender)
2261 (setq rcirc-nick (car args))
2262 (rcirc-update-prompt)
2263 (when rcirc-auto-authenticate-flag (rcirc-authenticate))
2264 (rcirc-join-channels process rcirc-startup-channels)))
2266 (defun rcirc-handler-PRIVMSG (process sender args text)
2267 (let ((target (if (rcirc-channel-p (car args))
2268 (car args)
2269 sender))
2270 (message (or (cadr args) "")))
2271 (if (string-match "^\C-a\\(.*\\)\C-a$" message)
2272 (rcirc-handler-CTCP process target sender (match-string 1 message))
2273 (rcirc-print process sender "PRIVMSG" target message t))
2274 ;; update nick linestamp
2275 (with-current-buffer (rcirc-get-buffer process target t)
2276 (rcirc-put-nick-channel process sender target rcirc-current-line))))
2278 (defun rcirc-handler-NOTICE (process sender args text)
2279 (let ((target (car args))
2280 (message (cadr args)))
2281 (if (string-match "^\C-a\\(.*\\)\C-a$" message)
2282 (rcirc-handler-CTCP-response process target sender
2283 (match-string 1 message))
2284 (rcirc-print process sender "NOTICE"
2285 (cond ((rcirc-channel-p target)
2286 target)
2287 ;;; -ChanServ- [#gnu] Welcome...
2288 ((string-match "\\[\\(#[^\] ]+\\)\\]" message)
2289 (match-string 1 message))
2290 (sender
2291 (if (string= sender (rcirc-server-name process))
2292 nil ; server notice
2293 sender)))
2294 message t))))
2296 (defun rcirc-handler-WALLOPS (process sender args text)
2297 (rcirc-print process sender "WALLOPS" sender (car args) t))
2299 (defun rcirc-handler-JOIN (process sender args text)
2300 (let ((channel (car args)))
2301 (with-current-buffer (rcirc-get-buffer-create process channel)
2302 ;; when recently rejoining, restore the linestamp
2303 (rcirc-put-nick-channel process sender channel
2304 (let ((last-activity-lines
2305 (rcirc-elapsed-lines process sender channel)))
2306 (when (and last-activity-lines
2307 (< last-activity-lines rcirc-omit-threshold))
2308 (rcirc-last-line process sender channel)))))
2310 (rcirc-print process sender "JOIN" channel "")
2312 ;; print in private chat buffer if it exists
2313 (when (rcirc-get-buffer (rcirc-buffer-process) sender)
2314 (rcirc-print process sender "JOIN" sender channel))))
2316 ;; PART and KICK are handled the same way
2317 (defun rcirc-handler-PART-or-KICK (process response channel sender nick args)
2318 (rcirc-ignore-update-automatic nick)
2319 (if (not (string= nick (rcirc-nick process)))
2320 ;; this is someone else leaving
2321 (progn
2322 (rcirc-maybe-remember-nick-quit process nick channel)
2323 (rcirc-remove-nick-channel process nick channel))
2324 ;; this is us leaving
2325 (mapc (lambda (n)
2326 (rcirc-remove-nick-channel process n channel))
2327 (rcirc-channel-nicks process channel))
2329 ;; if the buffer is still around, make it inactive
2330 (let ((buffer (rcirc-get-buffer process channel)))
2331 (when buffer
2332 (rcirc-disconnect-buffer buffer)))))
2334 (defun rcirc-handler-PART (process sender args text)
2335 (let* ((channel (car args))
2336 (reason (cadr args))
2337 (message (concat channel " " reason)))
2338 (rcirc-print process sender "PART" channel message)
2339 ;; print in private chat buffer if it exists
2340 (when (rcirc-get-buffer (rcirc-buffer-process) sender)
2341 (rcirc-print process sender "PART" sender message))
2343 (rcirc-handler-PART-or-KICK process "PART" channel sender sender reason)))
2345 (defun rcirc-handler-KICK (process sender args text)
2346 (let* ((channel (car args))
2347 (nick (cadr args))
2348 (reason (caddr args))
2349 (message (concat nick " " channel " " reason)))
2350 (rcirc-print process sender "KICK" channel message t)
2351 ;; print in private chat buffer if it exists
2352 (when (rcirc-get-buffer (rcirc-buffer-process) nick)
2353 (rcirc-print process sender "KICK" nick message))
2355 (rcirc-handler-PART-or-KICK process "KICK" channel sender nick reason)))
2357 (defun rcirc-maybe-remember-nick-quit (process nick channel)
2358 "Remember NICK as leaving CHANNEL if they recently spoke."
2359 (let ((elapsed-lines (rcirc-elapsed-lines process nick channel)))
2360 (when (and elapsed-lines
2361 (< elapsed-lines rcirc-omit-threshold))
2362 (let ((buffer (rcirc-get-buffer process channel)))
2363 (when buffer
2364 (with-current-buffer buffer
2365 (let ((record (assoc-string nick rcirc-recent-quit-alist t))
2366 (line (rcirc-last-line process nick channel)))
2367 (if record
2368 (setcdr record line)
2369 (setq rcirc-recent-quit-alist
2370 (cons (cons nick line)
2371 rcirc-recent-quit-alist))))))))))
2373 (defun rcirc-handler-QUIT (process sender args text)
2374 (rcirc-ignore-update-automatic sender)
2375 (mapc (lambda (channel)
2376 ;; broadcast quit message each channel
2377 (rcirc-print process sender "QUIT" channel (apply 'concat args))
2378 ;; record nick in quit table if they recently spoke
2379 (rcirc-maybe-remember-nick-quit process sender channel))
2380 (rcirc-nick-channels process sender))
2381 (rcirc-nick-remove process sender))
2383 (defun rcirc-handler-NICK (process sender args text)
2384 (let* ((old-nick sender)
2385 (new-nick (car args))
2386 (channels (rcirc-nick-channels process old-nick)))
2387 ;; update list of ignored nicks
2388 (rcirc-ignore-update-automatic old-nick)
2389 (when (member old-nick rcirc-ignore-list)
2390 (add-to-list 'rcirc-ignore-list new-nick)
2391 (add-to-list 'rcirc-ignore-list-automatic new-nick))
2392 ;; print message to nick's channels
2393 (dolist (target channels)
2394 (rcirc-print process sender "NICK" target new-nick))
2395 ;; update private chat buffer, if it exists
2396 (let ((chat-buffer (rcirc-get-buffer process old-nick)))
2397 (when chat-buffer
2398 (with-current-buffer chat-buffer
2399 (rcirc-print process sender "NICK" old-nick new-nick)
2400 (setq rcirc-target new-nick)
2401 (rename-buffer (rcirc-generate-new-buffer-name process new-nick)))))
2402 ;; remove old nick and add new one
2403 (with-rcirc-process-buffer process
2404 (let ((v (gethash old-nick rcirc-nick-table)))
2405 (remhash old-nick rcirc-nick-table)
2406 (puthash new-nick v rcirc-nick-table))
2407 ;; if this is our nick...
2408 (when (string= old-nick rcirc-nick)
2409 (setq rcirc-nick new-nick)
2410 (rcirc-update-prompt t)
2411 ;; reauthenticate
2412 (when rcirc-auto-authenticate-flag (rcirc-authenticate))))))
2414 (defun rcirc-handler-PING (process sender args text)
2415 (rcirc-send-string process (concat "PONG :" (car args))))
2417 (defun rcirc-handler-PONG (process sender args text)
2418 ;; do nothing
2421 (defun rcirc-handler-TOPIC (process sender args text)
2422 (let ((topic (cadr args)))
2423 (rcirc-print process sender "TOPIC" (car args) topic)
2424 (with-current-buffer (rcirc-get-buffer process (car args))
2425 (setq rcirc-topic topic))))
2427 (defvar rcirc-nick-away-alist nil)
2428 (defun rcirc-handler-301 (process sender args text)
2429 "RPL_AWAY"
2430 (let* ((nick (cadr args))
2431 (rec (assoc-string nick rcirc-nick-away-alist))
2432 (away-message (caddr args)))
2433 (when (or (not rec)
2434 (not (string= (cdr rec) away-message)))
2435 ;; away message has changed
2436 (rcirc-handler-generic process "AWAY" nick (cdr args) text)
2437 (if rec
2438 (setcdr rec away-message)
2439 (setq rcirc-nick-away-alist (cons (cons nick away-message)
2440 rcirc-nick-away-alist))))))
2442 (defun rcirc-handler-332 (process sender args text)
2443 "RPL_TOPIC"
2444 (let ((buffer (or (rcirc-get-buffer process (cadr args))
2445 (rcirc-get-temp-buffer-create process (cadr args)))))
2446 (with-current-buffer buffer
2447 (setq rcirc-topic (caddr args)))))
2449 (defun rcirc-handler-333 (process sender args text)
2450 "Not in rfc1459.txt"
2451 (let ((buffer (or (rcirc-get-buffer process (cadr args))
2452 (rcirc-get-temp-buffer-create process (cadr args)))))
2453 (with-current-buffer buffer
2454 (let ((setter (caddr args))
2455 (time (current-time-string
2456 (seconds-to-time
2457 (string-to-number (cadddr args))))))
2458 (rcirc-print process sender "TOPIC" (cadr args)
2459 (format "%s (%s on %s)" rcirc-topic setter time))))))
2461 (defun rcirc-handler-477 (process sender args text)
2462 "ERR_NOCHANMODES"
2463 (rcirc-print process sender "477" (cadr args) (caddr args)))
2465 (defun rcirc-handler-MODE (process sender args text)
2466 (let ((target (car args))
2467 (msg (mapconcat 'identity (cdr args) " ")))
2468 (rcirc-print process sender "MODE"
2469 (if (string= target (rcirc-nick process))
2471 target)
2472 msg)
2474 ;; print in private chat buffers if they exist
2475 (mapc (lambda (nick)
2476 (when (rcirc-get-buffer process nick)
2477 (rcirc-print process sender "MODE" nick msg)))
2478 (cddr args))))
2480 (defun rcirc-get-temp-buffer-create (process channel)
2481 "Return a buffer based on PROCESS and CHANNEL."
2482 (let ((tmpnam (concat " " (downcase channel) "TMP" (process-name process))))
2483 (get-buffer-create tmpnam)))
2485 (defun rcirc-handler-353 (process sender args text)
2486 "RPL_NAMREPLY"
2487 (let ((channel (caddr args)))
2488 (mapc (lambda (nick)
2489 (rcirc-put-nick-channel process nick channel))
2490 (split-string (cadddr args) " " t))
2491 (with-current-buffer (rcirc-get-temp-buffer-create process channel)
2492 (goto-char (point-max))
2493 (insert (car (last args)) " "))))
2495 (defun rcirc-handler-366 (process sender args text)
2496 "RPL_ENDOFNAMES"
2497 (let* ((channel (cadr args))
2498 (buffer (rcirc-get-temp-buffer-create process channel)))
2499 (with-current-buffer buffer
2500 (rcirc-print process sender "NAMES" channel
2501 (buffer-substring (point-min) (point-max))))
2502 (kill-buffer buffer)))
2504 (defun rcirc-handler-433 (process sender args text)
2505 "ERR_NICKNAMEINUSE"
2506 (rcirc-handler-generic process "433" sender args text)
2507 (let* ((new-nick (concat (cadr args) "`")))
2508 (with-rcirc-process-buffer process
2509 (rcirc-cmd-nick new-nick nil process))))
2511 (defun rcirc-authenticate ()
2512 "Send authentication to process associated with current buffer.
2513 Passwords are stored in `rcirc-authinfo' (which see)."
2514 (interactive)
2515 (with-rcirc-server-buffer
2516 (dolist (i rcirc-authinfo)
2517 (let ((process (rcirc-buffer-process))
2518 (server (car i))
2519 (nick (caddr i))
2520 (method (cadr i))
2521 (args (cdddr i)))
2522 (when (and (string-match server rcirc-server)
2523 (string-match nick rcirc-nick))
2524 (cond ((equal method 'nickserv)
2525 (rcirc-send-string
2526 process
2527 (concat
2528 "PRIVMSG nickserv :identify "
2529 (car args))))
2530 ((equal method 'chanserv)
2531 (rcirc-send-string
2532 process
2533 (concat
2534 "PRIVMSG chanserv :identify "
2535 (car args) " " (cadr args))))
2536 ((equal method 'bitlbee)
2537 (rcirc-send-string
2538 process
2539 (concat "PRIVMSG &bitlbee :identify " (car args))))
2541 (message "No %S authentication method defined"
2542 method))))))))
2544 (defun rcirc-handler-INVITE (process sender args text)
2545 (rcirc-print process sender "INVITE" nil (mapconcat 'identity args " ") t))
2547 (defun rcirc-handler-ERROR (process sender args text)
2548 (rcirc-print process sender "ERROR" nil (mapconcat 'identity args " ")))
2550 (defun rcirc-handler-CTCP (process target sender text)
2551 (if (string-match "^\\([^ ]+\\) *\\(.*\\)$" text)
2552 (let* ((request (upcase (match-string 1 text)))
2553 (args (match-string 2 text))
2554 (handler (intern-soft (concat "rcirc-handler-ctcp-" request))))
2555 (if (not (fboundp handler))
2556 (rcirc-print process sender "ERROR" target
2557 (format "%s sent unsupported ctcp: %s" sender text)
2559 (funcall handler process target sender args)
2560 (unless (or (string= request "ACTION")
2561 (string= request "KEEPALIVE"))
2562 (rcirc-print process sender "CTCP" target
2563 (format "%s" text) t))))))
2565 (defun rcirc-handler-ctcp-VERSION (process target sender args)
2566 (rcirc-send-string process
2567 (concat "NOTICE " sender
2568 " :\C-aVERSION " rcirc-id-string
2569 "\C-a")))
2571 (defun rcirc-handler-ctcp-ACTION (process target sender args)
2572 (rcirc-print process sender "ACTION" target args t))
2574 (defun rcirc-handler-ctcp-TIME (process target sender args)
2575 (rcirc-send-string process
2576 (concat "NOTICE " sender
2577 " :\C-aTIME " (current-time-string) "\C-a")))
2579 (defun rcirc-handler-CTCP-response (process target sender message)
2580 (rcirc-print process sender "CTCP" nil message t))
2582 (defgroup rcirc-faces nil
2583 "Faces for rcirc."
2584 :group 'rcirc
2585 :group 'faces)
2587 (defface rcirc-my-nick ; font-lock-function-name-face
2588 '((((class color) (min-colors 88) (background light)) (:foreground "Blue1"))
2589 (((class color) (min-colors 88) (background dark)) (:foreground "LightSkyBlue"))
2590 (((class color) (min-colors 16) (background light)) (:foreground "Blue"))
2591 (((class color) (min-colors 16) (background dark)) (:foreground "LightSkyBlue"))
2592 (((class color) (min-colors 8)) (:foreground "blue" :weight bold))
2593 (t (:inverse-video t :weight bold)))
2594 "The face used to highlight my messages."
2595 :group 'rcirc-faces)
2597 (defface rcirc-other-nick ; font-lock-variable-name-face
2598 '((((class grayscale) (background light))
2599 (:foreground "Gray90" :weight bold :slant italic))
2600 (((class grayscale) (background dark))
2601 (:foreground "DimGray" :weight bold :slant italic))
2602 (((class color) (min-colors 88) (background light)) (:foreground "DarkGoldenrod"))
2603 (((class color) (min-colors 88) (background dark)) (:foreground "LightGoldenrod"))
2604 (((class color) (min-colors 16) (background light)) (:foreground "DarkGoldenrod"))
2605 (((class color) (min-colors 16) (background dark)) (:foreground "LightGoldenrod"))
2606 (((class color) (min-colors 8)) (:foreground "yellow" :weight light))
2607 (t (:weight bold :slant italic)))
2608 "The face used to highlight other messages."
2609 :group 'rcirc-faces)
2611 (defface rcirc-bright-nick
2612 '((((class grayscale) (background light))
2613 (:foreground "LightGray" :weight bold :underline t))
2614 (((class grayscale) (background dark))
2615 (:foreground "Gray50" :weight bold :underline t))
2616 (((class color) (min-colors 88) (background light)) (:foreground "CadetBlue"))
2617 (((class color) (min-colors 88) (background dark)) (:foreground "Aquamarine"))
2618 (((class color) (min-colors 16) (background light)) (:foreground "CadetBlue"))
2619 (((class color) (min-colors 16) (background dark)) (:foreground "Aquamarine"))
2620 (((class color) (min-colors 8)) (:foreground "magenta"))
2621 (t (:weight bold :underline t)))
2622 "Face used for nicks matched by `rcirc-bright-nicks'."
2623 :group 'rcirc-faces)
2625 (defface rcirc-dim-nick
2626 '((t :inherit default))
2627 "Face used for nicks in `rcirc-dim-nicks'."
2628 :group 'rcirc-faces)
2630 (defface rcirc-server ; font-lock-comment-face
2631 '((((class grayscale) (background light))
2632 (:foreground "DimGray" :weight bold :slant italic))
2633 (((class grayscale) (background dark))
2634 (:foreground "LightGray" :weight bold :slant italic))
2635 (((class color) (min-colors 88) (background light))
2636 (:foreground "Firebrick"))
2637 (((class color) (min-colors 88) (background dark))
2638 (:foreground "chocolate1"))
2639 (((class color) (min-colors 16) (background light))
2640 (:foreground "red"))
2641 (((class color) (min-colors 16) (background dark))
2642 (:foreground "red1"))
2643 (((class color) (min-colors 8) (background light))
2645 (((class color) (min-colors 8) (background dark))
2647 (t (:weight bold :slant italic)))
2648 "The face used to highlight server messages."
2649 :group 'rcirc-faces)
2651 (defface rcirc-server-prefix ; font-lock-comment-delimiter-face
2652 '((default :inherit rcirc-server)
2653 (((class grayscale)))
2654 (((class color) (min-colors 16)))
2655 (((class color) (min-colors 8) (background light))
2656 :foreground "red")
2657 (((class color) (min-colors 8) (background dark))
2658 :foreground "red1"))
2659 "The face used to highlight server prefixes."
2660 :group 'rcirc-faces)
2662 (defface rcirc-timestamp
2663 '((t (:inherit default)))
2664 "The face used to highlight timestamps."
2665 :group 'rcirc-faces)
2667 (defface rcirc-nick-in-message ; font-lock-keyword-face
2668 '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold))
2669 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
2670 (((class color) (min-colors 88) (background light)) (:foreground "Purple"))
2671 (((class color) (min-colors 88) (background dark)) (:foreground "Cyan1"))
2672 (((class color) (min-colors 16) (background light)) (:foreground "Purple"))
2673 (((class color) (min-colors 16) (background dark)) (:foreground "Cyan"))
2674 (((class color) (min-colors 8)) (:foreground "cyan" :weight bold))
2675 (t (:weight bold)))
2676 "The face used to highlight instances of your nick within messages."
2677 :group 'rcirc-faces)
2679 (defface rcirc-nick-in-message-full-line
2680 '((t (:bold t)))
2681 "The face used emphasize the entire message when your nick is mentioned."
2682 :group 'rcirc-faces)
2684 (defface rcirc-prompt ; comint-highlight-prompt
2685 '((((min-colors 88) (background dark)) (:foreground "cyan1"))
2686 (((background dark)) (:foreground "cyan"))
2687 (t (:foreground "dark blue")))
2688 "The face used to highlight prompts."
2689 :group 'rcirc-faces)
2691 (defface rcirc-track-nick
2692 '((((type tty)) (:inherit default))
2693 (t (:inverse-video t)))
2694 "The face used in the mode-line when your nick is mentioned."
2695 :group 'rcirc-faces)
2697 (defface rcirc-track-keyword
2698 '((t (:bold t )))
2699 "The face used in the mode-line when keywords are mentioned."
2700 :group 'rcirc-faces)
2702 (defface rcirc-url
2703 '((t (:bold t)))
2704 "The face used to highlight urls."
2705 :group 'rcirc-faces)
2707 (defface rcirc-keyword
2708 '((t (:inherit highlight)))
2709 "The face used to highlight keywords."
2710 :group 'rcirc-faces)
2713 ;; When using M-x flyspell-mode, only check words after the prompt
2714 (put 'rcirc-mode 'flyspell-mode-predicate 'rcirc-looking-at-input)
2715 (defun rcirc-looking-at-input ()
2716 "Returns true if point is past the input marker."
2717 (>= (point) rcirc-prompt-end-marker))
2720 (provide 'rcirc)
2722 ;; arch-tag: b471b7e8-6b5a-4399-b2c6-a3c78dfc8ffb
2723 ;;; rcirc.el ends here