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