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@dogan.se>
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/>.
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:
48 (eval-when-compile (require 'cl
))
54 :link
'(custom-manual "(rcirc)")
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
65 The optional PARAMETERS come in pairs PARAMETER VALUE.
67 The following parameters are recognized:
71 VALUE must be a string. If absent, `rcirc-default-nick' is used
76 VALUE must be a number or string. If absent,
77 `rcirc-default-port' is used.
81 VALUE must be a string. If absent, `rcirc-default-user-name' is
86 VALUE must be a string. If absent, no PASS command will be sent
91 VALUE must be a string. If absent, `rcirc-default-full-name' is
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
)
105 (:channels
(repeat string
)))))
108 (defcustom rcirc-default-port
6667
109 "The default port to connect to."
113 (defcustom rcirc-default-nick
(user-login-name)
118 (defcustom rcirc-default-user-name
"user"
119 "Your user name sent to the server when connecting."
120 :version
"24.1" ; changed default
124 (defcustom rcirc-default-full-name
"unknown"
125 "The full name sent to the server when connecting."
126 :version
"24.1" ; changed default
130 (defcustom rcirc-fill-flag t
131 "*Non-nil means line-wrap messages printed in channel buffers."
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"))
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"))
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'."
171 (defcustom rcirc-input-ring-size
1024
172 "*Size of input history ring."
176 (defcustom rcirc-read-only-flag t
177 "*Non-nil means make text in IRC buffers read-only."
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"))
189 (defcustom rcirc-scroll-show-maximum-output t
190 "*If non-nil, scroll buffer to keep the point at the bottom of
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
203 The ARGUMENTS for each METHOD symbol are:
204 `nickserv': NICK PASSWORD [NICKSERV-NICK]
205 `chanserv': NICK CHANNEL PASSWORD
206 `bitlbee': NICK PASSWORD
207 `quakenet': ACCOUNT PASSWORD
210 ((\"freenode\" nickserv \"bob\" \"p455w0rd\")
211 (\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
212 (\"bitlbee\" bitlbee \"robert\" \"sekrit\")
213 (\"dal.net\" nickserv \"bob\" \"sekrit\" \"NickServ@services.dal.net\")
214 (\"quakenet.org\" quakenet \"bobby\" \"sekrit\"))"
215 :type
'(alist :key-type
(string :tag
"Server")
216 :value-type
(choice (list :tag
"NickServ"
219 (string :tag
"Password"))
220 (list :tag
"ChanServ"
223 (string :tag
"Channel")
224 (string :tag
"Password"))
228 (string :tag
"Password"))
229 (list :tag
"QuakeNet"
231 (string :tag
"Account")
232 (string :tag
"Password"))))
235 (defcustom rcirc-auto-authenticate-flag t
236 "*Non-nil means automatically send authentication string to server.
237 See also `rcirc-authinfo'."
241 (defcustom rcirc-authenticate-before-join t
242 "*Non-nil means authenticate to services before joining channels.
243 Currently only works with NickServ on some networks."
248 (defcustom rcirc-prompt
"> "
249 "Prompt string to use in IRC buffers.
251 The following replacements are made:
254 %t is the buffer target, a channel or a user.
256 Setting this alone will not affect the prompt;
257 use either M-x customize or also call `rcirc-update-prompt'."
259 :set
'rcirc-set-changed
260 :initialize
'custom-initialize-default
263 (defcustom rcirc-keywords nil
264 "List of keywords to highlight in message text."
265 :type
'(repeat string
)
268 (defcustom rcirc-ignore-list
()
269 "List of ignored nicks.
270 Use /ignore to list them, use /ignore NICK to add or remove a nick."
271 :type
'(repeat string
)
274 (defvar rcirc-ignore-list-automatic
()
275 "List of ignored nicks added to `rcirc-ignore-list' because of renaming.
276 When an ignored person renames, their nick is added to both lists.
277 Nicks will be removed from the automatic list on follow-up renamings or
280 (defcustom rcirc-bright-nicks nil
281 "List of nicks to be emphasized.
282 See `rcirc-bright-nick' face."
283 :type
'(repeat string
)
286 (defcustom rcirc-dim-nicks nil
287 "List of nicks to be deemphasized.
288 See `rcirc-dim-nick' face."
289 :type
'(repeat string
)
292 (defcustom rcirc-print-hooks nil
293 "Hook run after text is printed.
294 Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT."
298 (defvar rcirc-authenticated-hook nil
299 "Hook run after successfully authenticated.")
301 (defcustom rcirc-always-use-server-buffer-flag nil
302 "Non-nil means messages without a channel target will go to the server buffer."
306 (defcustom rcirc-decode-coding-system
'utf-8
307 "Coding system used to decode incoming irc messages."
311 (defcustom rcirc-encode-coding-system
'utf-8
312 "Coding system used to encode outgoing irc messages."
316 (defcustom rcirc-coding-system-alist nil
317 "Alist to decide a coding system to use for a channel I/O operation.
318 The format is ((PATTERN . VAL) ...).
319 PATTERN is either a string or a cons of strings.
320 If PATTERN is a string, it is used to match a target.
321 If PATTERN is a cons of strings, the car part is used to match a
322 target, and the cdr part is used to match a server.
323 VAL is either a coding system or a cons of coding systems.
324 If VAL is a coding system, it is used for both decoding and encoding
326 If VAL is a cons of coding systems, the car part is used for decoding,
327 and the cdr part is used for encoding."
328 :type
'(alist :key-type
(choice (string :tag
"Channel Regexp")
329 (cons (string :tag
"Channel Regexp")
330 (string :tag
"Server Regexp")))
331 :value-type
(choice coding-system
332 (cons (coding-system :tag
"Decode")
333 (coding-system :tag
"Encode"))))
336 (defcustom rcirc-multiline-major-mode
'fundamental-mode
337 "Major-mode function to use in multiline edit buffers."
341 (defcustom rcirc-nick-completion-format
"%s: "
342 "Format string to use in nick completions.
344 The format string is only used when completing at the beginning
345 of a line. The string is passed as the first argument to
346 `format' with the nickname as the second argument."
351 (defvar rcirc-nick nil
)
353 (defvar rcirc-prompt-start-marker nil
)
354 (defvar rcirc-prompt-end-marker nil
)
356 (defvar rcirc-nick-table nil
)
358 (defvar rcirc-recent-quit-alist nil
359 "Alist of nicks that have recently quit or parted the channel.")
361 (defvar rcirc-nick-syntax-table
362 (let ((table (make-syntax-table text-mode-syntax-table
)))
363 (mapc (lambda (c) (modify-syntax-entry c
"w" table
))
365 (modify-syntax-entry ?
' "_" table
)
367 "Syntax table which includes all nick characters as word constituents.")
369 ;; each process has an alist of (target . buffer) pairs
370 (defvar rcirc-buffer-alist nil
)
372 (defvar rcirc-activity nil
373 "List of buffers with unviewed activity.")
375 (defvar rcirc-activity-string
""
376 "String displayed in modeline representing `rcirc-activity'.")
377 (put 'rcirc-activity-string
'risky-local-variable t
)
379 (defvar rcirc-server-buffer nil
380 "The server buffer associated with this channel buffer.")
382 (defvar rcirc-target nil
383 "The channel or user associated with this buffer.")
385 (defvar rcirc-urls nil
386 "List of urls seen in the current buffer.")
387 (put 'rcirc-urls
'permanent-local t
)
389 (defvar rcirc-timeout-seconds
600
390 "Kill connection after this many seconds if there is no activity.")
392 (defconst rcirc-id-string
(concat "rcirc on GNU Emacs " emacs-version
))
394 (defvar rcirc-startup-channels nil
)
396 (defvar rcirc-server-name-history nil
397 "History variable for \\[rcirc] call.")
399 (defvar rcirc-server-port-history nil
400 "History variable for \\[rcirc] call.")
402 (defvar rcirc-nick-name-history nil
403 "History variable for \\[rcirc] call.")
405 (defvar rcirc-user-name-history nil
406 "History variable for \\[rcirc] call.")
410 "Connect to all servers in `rcirc-server-alist'.
412 Do not connect to a server if it is already connected.
414 If ARG is non-nil, instead prompt for connection parameters."
417 (let* ((server (completing-read "IRC Server: "
420 (caar rcirc-server-alist
)
421 'rcirc-server-name-history
))
422 (server-plist (cdr (assoc-string server rcirc-server-alist
)))
423 (port (read-string "IRC Port: "
425 (or (plist-get server-plist
:port
)
427 'rcirc-server-port-history
))
428 (nick (read-string "IRC Nick: "
429 (or (plist-get server-plist
:nick
)
431 'rcirc-nick-name-history
))
432 (user-name (read-string "IRC Username: "
433 (or (plist-get server-plist
:user-name
)
434 rcirc-default-user-name
)
435 'rcirc-user-name-history
))
436 (password (read-passwd "IRC Password: " nil
437 (plist-get server-plist
:password
)))
438 (channels (split-string
439 (read-string "IRC Channels: "
441 (plist-get server-plist
445 (rcirc-connect server port nick user-name
446 rcirc-default-full-name
448 ;; connect to servers in `rcirc-server-alist'
449 (let (connected-servers)
450 (dolist (c rcirc-server-alist
)
451 (let ((server (car c
))
452 (nick (or (plist-get (cdr c
) :nick
) rcirc-default-nick
))
453 (port (or (plist-get (cdr c
) :port
) rcirc-default-port
))
454 (user-name (or (plist-get (cdr c
) :user-name
)
455 rcirc-default-user-name
))
456 (full-name (or (plist-get (cdr c
) :full-name
)
457 rcirc-default-full-name
))
458 (channels (plist-get (cdr c
) :channels
))
459 (password (plist-get (cdr c
) :password
)))
462 (dolist (p (rcirc-process-list))
463 (when (string= server
(process-name p
))
467 (rcirc-connect server port nick user-name
468 full-name channels password
)
469 (quit (message "Quit connecting to %s" server
)))
470 (with-current-buffer (process-buffer connected
)
471 (setq connected-servers
472 (cons (process-contact (get-buffer-process
473 (current-buffer)) :host
)
474 connected-servers
))))))))
475 (when connected-servers
476 (message "Already connected to %s"
477 (if (cdr connected-servers
)
478 (concat (mapconcat 'identity
(butlast connected-servers
) ", ")
480 (car (last connected-servers
)))
481 (car connected-servers
)))))))
484 (defalias 'irc
'rcirc
)
487 (defvar rcirc-process-output nil
)
488 (defvar rcirc-topic nil
)
489 (defvar rcirc-keepalive-timer nil
)
490 (defvar rcirc-last-server-message-time nil
)
491 (defvar rcirc-server nil
) ; server provided by server
492 (defvar rcirc-server-name nil
) ; server name given by 001 response
493 (defvar rcirc-timeout-timer nil
)
494 (defvar rcirc-user-authenticated nil
)
495 (defvar rcirc-user-disconnect nil
)
496 (defvar rcirc-connecting nil
)
497 (defvar rcirc-process nil
)
500 (defun rcirc-connect (server &optional port nick user-name
501 full-name startup-channels password
)
503 (message "Connecting to %s..." server
)
504 (let* ((inhibit-eol-conversion)
505 (port-number (if port
507 (string-to-number port
)
510 (nick (or nick rcirc-default-nick
))
511 (user-name (or user-name rcirc-default-user-name
))
512 (full-name (or full-name rcirc-default-full-name
))
513 (startup-channels startup-channels
)
514 (process (make-network-process :name server
:host server
:service port-number
)))
516 (set-process-coding-system process
'raw-text
'raw-text
)
517 (switch-to-buffer (rcirc-generate-new-buffer-name process nil
))
518 (set-process-buffer process
(current-buffer))
519 (rcirc-mode process nil
)
520 (set-process-sentinel process
'rcirc-sentinel
)
521 (set-process-filter process
'rcirc-filter
)
522 (make-local-variable 'rcirc-process
)
523 (setq rcirc-process process
)
524 (make-local-variable 'rcirc-server
)
525 (setq rcirc-server server
)
526 (make-local-variable 'rcirc-server-name
)
527 (setq rcirc-server-name server
) ; update when we get 001 response
528 (make-local-variable 'rcirc-buffer-alist
)
529 (setq rcirc-buffer-alist nil
)
530 (make-local-variable 'rcirc-nick-table
)
531 (setq rcirc-nick-table
(make-hash-table :test
'equal
))
532 (make-local-variable 'rcirc-nick
)
533 (setq rcirc-nick nick
)
534 (make-local-variable 'rcirc-process-output
)
535 (setq rcirc-process-output nil
)
536 (make-local-variable 'rcirc-startup-channels
)
537 (setq rcirc-startup-channels startup-channels
)
538 (make-local-variable 'rcirc-last-server-message-time
)
539 (setq rcirc-last-server-message-time
(current-time))
540 (make-local-variable 'rcirc-timeout-timer
)
541 (setq rcirc-timeout-timer nil
)
542 (make-local-variable 'rcirc-user-disconnect
)
543 (setq rcirc-user-disconnect nil
)
544 (make-local-variable 'rcirc-user-authenticated
)
545 (setq rcirc-user-authenticated nil
)
546 (make-local-variable 'rcirc-connecting
)
547 (setq rcirc-connecting t
)
549 (add-hook 'auto-save-hook
'rcirc-log-write
)
552 (unless (zerop (length password
))
553 (rcirc-send-string process
(concat "PASS " password
)))
554 (rcirc-send-string process
(concat "NICK " nick
))
555 (rcirc-send-string process
(concat "USER " user-name
558 ;; setup ping timer if necessary
559 (unless rcirc-keepalive-timer
560 (setq rcirc-keepalive-timer
561 (run-at-time 0 (/ rcirc-timeout-seconds
2) 'rcirc-keepalive
)))
563 (message "Connecting to %s...done" server
)
565 ;; return process object
568 (defmacro with-rcirc-process-buffer
(process &rest body
)
569 (declare (indent 1) (debug t
))
570 `(with-current-buffer (process-buffer ,process
)
573 (defmacro with-rcirc-server-buffer
(&rest body
)
574 (declare (indent 0) (debug t
))
575 `(with-current-buffer rcirc-server-buffer
578 (defun rcirc-float-time ()
579 (if (featurep 'xemacs
)
580 (time-to-seconds (current-time))
583 (defun rcirc-keepalive ()
584 "Send keep alive pings to active rcirc processes.
585 Kill processes that have not received a server message since the
587 (if (rcirc-process-list)
588 (mapc (lambda (process)
589 (with-rcirc-process-buffer process
590 (when (not rcirc-connecting
)
591 (rcirc-send-ctcp process
593 (format "KEEPALIVE %f"
594 (rcirc-float-time))))))
595 (rcirc-process-list))
596 ;; no processes, clean up timer
597 (cancel-timer rcirc-keepalive-timer
)
598 (setq rcirc-keepalive-timer nil
)))
600 (defun rcirc-handler-ctcp-KEEPALIVE (process target sender message
)
601 (with-rcirc-process-buffer process
602 (setq header-line-format
(format "%f" (- (rcirc-float-time)
603 (string-to-number message
))))))
605 (defvar rcirc-debug-buffer
" *rcirc debug*")
606 (defvar rcirc-debug-flag nil
607 "If non-nil, write information to `rcirc-debug-buffer'.")
608 (defun rcirc-debug (process text
)
609 "Add an entry to the debug log including PROCESS and TEXT.
610 Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
612 (when rcirc-debug-flag
613 (with-current-buffer (get-buffer-create rcirc-debug-buffer
)
614 (goto-char (point-max))
617 (format-time-string "%Y-%m-%dT%T ") (process-name process
)
621 (defvar rcirc-sentinel-hooks nil
622 "Hook functions called when the process sentinel is called.
623 Functions are called with PROCESS and SENTINEL arguments.")
625 (defun rcirc-sentinel (process sentinel
)
626 "Called when PROCESS receives SENTINEL."
627 (let ((sentinel (replace-regexp-in-string "\n" "" sentinel
)))
628 (rcirc-debug process
(format "SENTINEL: %S %S\n" process sentinel
))
629 (with-rcirc-process-buffer process
630 (dolist (buffer (cons nil
(mapcar 'cdr rcirc-buffer-alist
)))
631 (with-current-buffer (or buffer
(current-buffer))
632 (rcirc-print process
"rcirc.el" "ERROR" rcirc-target
633 (format "%s: %s (%S)"
634 (process-name process
)
636 (process-status process
)) (not rcirc-target
))
637 (rcirc-disconnect-buffer)))
638 (run-hook-with-args 'rcirc-sentinel-hooks process sentinel
))))
640 (defun rcirc-disconnect-buffer (&optional buffer
)
641 (with-current-buffer (or buffer
(current-buffer))
642 ;; set rcirc-target to nil for each channel so cleanup
643 ;; doesnt happen when we reconnect
644 (setq rcirc-target nil
)
645 (setq mode-line-process
":disconnected")))
647 (defun rcirc-process-list ()
648 "Return a list of rcirc processes."
651 (when (buffer-live-p (process-buffer p
))
652 (with-rcirc-process-buffer p
653 (when (eq major-mode
'rcirc-mode
)
654 (setq ps
(cons p ps
))))))
658 (defvar rcirc-receive-message-hooks nil
659 "Hook functions run when a message is received from server.
660 Function is called with PROCESS, COMMAND, SENDER, ARGS and LINE.")
661 (defun rcirc-filter (process output
)
662 "Called when PROCESS receives OUTPUT."
663 (rcirc-debug process output
)
664 (rcirc-reschedule-timeout process
)
665 (with-rcirc-process-buffer process
666 (setq rcirc-last-server-message-time
(current-time))
667 (setq rcirc-process-output
(concat rcirc-process-output output
))
668 (when (= (aref rcirc-process-output
669 (1- (length rcirc-process-output
))) ?
\n)
671 (rcirc-process-server-response process line
))
672 (split-string rcirc-process-output
"[\n\r]" t
))
673 (setq rcirc-process-output nil
))))
675 (defun rcirc-reschedule-timeout (process)
676 (with-rcirc-process-buffer process
677 (when (not rcirc-connecting
)
678 (with-rcirc-process-buffer process
679 (when rcirc-timeout-timer
(cancel-timer rcirc-timeout-timer
))
680 (setq rcirc-timeout-timer
(run-at-time rcirc-timeout-seconds nil
681 'rcirc-delete-process
684 (defun rcirc-delete-process (process)
685 (delete-process process
))
687 (defvar rcirc-trap-errors-flag t
)
688 (defun rcirc-process-server-response (process text
)
689 (if rcirc-trap-errors-flag
691 (rcirc-process-server-response-1 process text
)
693 (rcirc-print process
"RCIRC" "ERROR" nil
694 (format "\"%s\" %s" text err
) t
)))
695 (rcirc-process-server-response-1 process text
)))
697 (defun rcirc-process-server-response-1 (process text
)
698 (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text
)
699 (let* ((user (match-string 2 text
))
700 (sender (rcirc-user-nick user
))
701 (cmd (match-string 3 text
))
702 (args (match-string 4 text
))
703 (handler (intern-soft (concat "rcirc-handler-" cmd
))))
704 (string-match "^\\([^:]*\\):?\\(.+\\)?$" args
)
705 (let* ((args1 (match-string 1 args
))
706 (args2 (match-string 2 args
))
707 (args (delq nil
(append (split-string args1
" " t
)
709 (if (not (fboundp handler
))
710 (rcirc-handler-generic process cmd sender args text
)
711 (funcall handler process sender args text
))
712 (run-hook-with-args 'rcirc-receive-message-hooks
713 process cmd sender args text
)))
714 (message "UNHANDLED: %s" text
)))
716 (defvar rcirc-responses-no-activity
'("305" "306")
717 "Responses that don't trigger activity in the mode-line indicator.")
719 (defun rcirc-handler-generic (process response sender args text
)
720 "Generic server response handler."
721 (rcirc-print process sender response nil
722 (mapconcat 'identity
(cdr args
) " ")
723 (not (member response rcirc-responses-no-activity
))))
725 (defun rcirc-send-string (process string
)
726 "Send PROCESS a STRING plus a newline."
727 (let ((string (concat (encode-coding-string string rcirc-encode-coding-system
)
729 (unless (eq (process-status process
) 'open
)
730 (error "Network connection to %s is not open"
731 (process-name process
)))
732 (rcirc-debug process string
)
733 (process-send-string process string
)))
735 (defun rcirc-send-privmsg (process target string
)
736 (rcirc-send-string process
(format "PRIVMSG %s :%s" target string
)))
738 (defun rcirc-send-ctcp (process target request
&optional args
)
739 (let ((args (if args
(concat " " args
) "")))
740 (rcirc-send-privmsg process target
741 (format "\C-a%s%s\C-a" request args
))))
743 (defun rcirc-buffer-process (&optional buffer
)
744 "Return the process associated with channel BUFFER.
745 With no argument or nil as argument, use the current buffer."
746 (or (get-buffer-process (if buffer
747 (with-current-buffer buffer
749 rcirc-server-buffer
))
752 (defun rcirc-server-name (process)
753 "Return PROCESS server name, given by the 001 response."
754 (with-rcirc-process-buffer process
755 (or rcirc-server-name
756 (warn "server name for process %S unknown" process
))))
758 (defun rcirc-nick (process)
759 "Return PROCESS nick."
760 (with-rcirc-process-buffer process
761 (or rcirc-nick rcirc-default-nick
)))
763 (defun rcirc-buffer-nick (&optional buffer
)
764 "Return the nick associated with BUFFER.
765 With no argument or nil as argument, use the current buffer."
766 (with-current-buffer (or buffer
(current-buffer))
767 (with-current-buffer rcirc-server-buffer
768 (or rcirc-nick rcirc-default-nick
))))
770 (defvar rcirc-max-message-length
420
771 "Messages longer than this value will be split.")
773 (defun rcirc-send-message (process target message
&optional noticep silent
)
774 "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
775 If NOTICEP is non-nil, send a notice instead of privmsg.
776 If SILENT is non-nil, do not print the message in any irc buffer."
777 ;; max message length is 512 including CRLF
778 (let* ((response (if noticep
"NOTICE" "PRIVMSG"))
779 (oversize (> (length message
) rcirc-max-message-length
))
781 (substring message
0 rcirc-max-message-length
)
783 (text (if (string= text
"")
787 (substring message rcirc-max-message-length
))))
788 (rcirc-get-buffer-create process target
)
789 (rcirc-send-string process
(concat response
" " target
" :" text
))
791 (rcirc-print process
(rcirc-nick process
) response target text
))
792 (when more
(rcirc-send-message process target more noticep
))))
794 (defvar rcirc-input-ring nil
)
795 (defvar rcirc-input-ring-index
0)
796 (defun rcirc-prev-input-string (arg)
797 (ring-ref rcirc-input-ring
(+ rcirc-input-ring-index arg
)))
799 (defun rcirc-insert-prev-input (arg)
801 (when (<= rcirc-prompt-end-marker
(point))
802 (delete-region rcirc-prompt-end-marker
(point-max))
803 (insert (rcirc-prev-input-string 0))
804 (setq rcirc-input-ring-index
(1+ rcirc-input-ring-index
))))
806 (defun rcirc-insert-next-input (arg)
808 (when (<= rcirc-prompt-end-marker
(point))
809 (delete-region rcirc-prompt-end-marker
(point-max))
810 (setq rcirc-input-ring-index
(1- rcirc-input-ring-index
))
811 (insert (rcirc-prev-input-string -
1))))
813 (defvar rcirc-server-commands
814 '("/admin" "/away" "/connect" "/die" "/error" "/info"
815 "/invite" "/ison" "/join" "/kick" "/kill" "/links"
816 "/list" "/lusers" "/mode" "/motd" "/names" "/nick"
817 "/notice" "/oper" "/part" "/pass" "/ping" "/pong"
818 "/privmsg" "/quit" "/rehash" "/restart" "/service" "/servlist"
819 "/server" "/squery" "/squit" "/stats" "/summon" "/time"
820 "/topic" "/trace" "/user" "/userhost" "/users" "/version"
821 "/wallops" "/who" "/whois" "/whowas")
822 "A list of user commands by IRC server.
823 The value defaults to RFCs 1459 and 2812.")
825 ;; /me and /ctcp are not defined by `defun-rcirc-command'.
826 (defvar rcirc-client-commands
'("/me" "/ctcp")
827 "A list of user commands defined by IRC client rcirc.
828 The list is updated automatically by `defun-rcirc-command'.")
830 (defun rcirc-completion-at-point ()
831 "Function used for `completion-at-point-functions' in `rcirc-mode'."
832 (and (rcirc-looking-at-input)
833 (let* ((beg (save-excursion
834 (if (re-search-backward " " rcirc-prompt-end-marker t
)
836 rcirc-prompt-end-marker
)))
837 (table (if (and (= beg rcirc-prompt-end-marker
)
838 (eq (char-after beg
) ?
/))
840 (nconc (sort (copy-sequence rcirc-client-commands
)
842 (sort (copy-sequence rcirc-server-commands
)
844 (rcirc-channel-nicks (rcirc-buffer-process)
846 (list beg
(point) table
))))
848 (defvar rcirc-completions nil
)
849 (defvar rcirc-completion-start nil
)
851 (defun rcirc-complete ()
852 "Cycle through completions from list of nicks in channel or IRC commands.
853 IRC command completion is performed only if '/' is the first input char."
855 (unless (rcirc-looking-at-input)
856 (error "Point not located after rcirc prompt"))
857 (if (eq last-command this-command
)
858 (setq rcirc-completions
859 (append (cdr rcirc-completions
) (list (car rcirc-completions
))))
860 (let ((completion-ignore-case t
)
861 (table (rcirc-completion-at-point)))
862 (setq rcirc-completion-start
(car table
))
863 (setq rcirc-completions
864 (and rcirc-completion-start
865 (all-completions (buffer-substring rcirc-completion-start
868 (let ((completion (car rcirc-completions
)))
870 (delete-region rcirc-completion-start
(point))
873 ((= (aref completion
0) ?
/) (concat completion
" "))
874 ((= rcirc-completion-start rcirc-prompt-end-marker
)
875 (format rcirc-nick-completion-format completion
))
878 (defun set-rcirc-decode-coding-system (coding-system)
879 "Set the decode coding system used in this channel."
880 (interactive "zCoding system for incoming messages: ")
881 (setq rcirc-decode-coding-system coding-system
))
883 (defun set-rcirc-encode-coding-system (coding-system)
884 "Set the encode coding system used in this channel."
885 (interactive "zCoding system for outgoing messages: ")
886 (setq rcirc-encode-coding-system coding-system
))
888 (defvar rcirc-mode-map
889 (let ((map (make-sparse-keymap)))
890 (define-key map
(kbd "RET") 'rcirc-send-input
)
891 (define-key map
(kbd "M-p") 'rcirc-insert-prev-input
)
892 (define-key map
(kbd "M-n") 'rcirc-insert-next-input
)
893 (define-key map
(kbd "TAB") 'rcirc-complete
)
894 (define-key map
(kbd "C-c C-b") 'rcirc-browse-url
)
895 (define-key map
(kbd "C-c C-c") 'rcirc-edit-multiline
)
896 (define-key map
(kbd "C-c C-j") 'rcirc-cmd-join
)
897 (define-key map
(kbd "C-c C-k") 'rcirc-cmd-kick
)
898 (define-key map
(kbd "C-c C-l") 'rcirc-toggle-low-priority
)
899 (define-key map
(kbd "C-c C-d") 'rcirc-cmd-mode
)
900 (define-key map
(kbd "C-c C-m") 'rcirc-cmd-msg
)
901 (define-key map
(kbd "C-c C-r") 'rcirc-cmd-nick
) ; rename
902 (define-key map
(kbd "C-c C-o") 'rcirc-omit-mode
)
903 (define-key map
(kbd "C-c C-p") 'rcirc-cmd-part
)
904 (define-key map
(kbd "C-c C-q") 'rcirc-cmd-query
)
905 (define-key map
(kbd "C-c C-t") 'rcirc-cmd-topic
)
906 (define-key map
(kbd "C-c C-n") 'rcirc-cmd-names
)
907 (define-key map
(kbd "C-c C-w") 'rcirc-cmd-whois
)
908 (define-key map
(kbd "C-c C-x") 'rcirc-cmd-quit
)
909 (define-key map
(kbd "C-c TAB") ; C-i
910 'rcirc-toggle-ignore-buffer-activity
)
911 (define-key map
(kbd "C-c C-s") 'rcirc-switch-to-server-buffer
)
912 (define-key map
(kbd "C-c C-a") 'rcirc-jump-to-first-unread-line
)
914 "Keymap for rcirc mode.")
916 (defvar rcirc-browse-url-map
917 (let ((map (make-sparse-keymap)))
918 (define-key map
(kbd "RET") 'rcirc-browse-url-at-point
)
919 (define-key map
(kbd "<mouse-2>") 'rcirc-browse-url-at-mouse
)
920 (define-key map
[follow-link
] 'mouse-face
)
922 "Keymap used for browsing URLs in `rcirc-mode'.")
924 (defvar rcirc-short-buffer-name nil
925 "Generated abbreviation to use to indicate buffer activity.")
927 (defvar rcirc-mode-hook nil
928 "Hook run when setting up rcirc buffer.")
930 (defvar rcirc-last-post-time nil
)
932 (defvar rcirc-log-alist nil
933 "Alist of lines to log to disk when `rcirc-log-flag' is non-nil.
934 Each element looks like (FILENAME . TEXT).")
936 (defvar rcirc-current-line
0
937 "The current number of responses printed in this channel.
938 This number is independent of the number of lines in the buffer.")
940 (defun rcirc-mode (process target
)
941 ;; FIXME: Use define-derived-mode.
942 "Major mode for IRC channel buffers.
945 (kill-all-local-variables)
946 (use-local-map rcirc-mode-map
)
947 (setq mode-name
"rcirc")
948 (setq major-mode
'rcirc-mode
)
949 (setq mode-line-process nil
)
951 (make-local-variable 'rcirc-input-ring
)
952 (setq rcirc-input-ring
(make-ring rcirc-input-ring-size
))
953 (make-local-variable 'rcirc-server-buffer
)
954 (setq rcirc-server-buffer
(process-buffer process
))
955 (make-local-variable 'rcirc-target
)
956 (setq rcirc-target target
)
957 (make-local-variable 'rcirc-topic
)
958 (setq rcirc-topic nil
)
959 (make-local-variable 'rcirc-last-post-time
)
960 (setq rcirc-last-post-time
(current-time))
961 (make-local-variable 'fill-paragraph-function
)
962 (setq fill-paragraph-function
'rcirc-fill-paragraph
)
963 (make-local-variable 'rcirc-recent-quit-alist
)
964 (setq rcirc-recent-quit-alist nil
)
965 (make-local-variable 'rcirc-current-line
)
966 (setq rcirc-current-line
0)
968 (make-local-variable 'rcirc-short-buffer-name
)
969 (setq rcirc-short-buffer-name nil
)
970 (make-local-variable 'rcirc-urls
)
971 (setq use-hard-newlines t
)
973 ;; setup for omitting responses
974 (setq buffer-invisibility-spec
'())
975 (setq buffer-display-table
(make-display-table))
976 (set-display-table-slot buffer-display-table
4
977 (let ((glyph (make-glyph-code
978 ?.
'font-lock-keyword-face
)))
979 (make-vector 3 glyph
)))
981 (make-local-variable 'rcirc-decode-coding-system
)
982 (make-local-variable 'rcirc-encode-coding-system
)
983 (dolist (i rcirc-coding-system-alist
)
984 (let ((chan (if (consp (car i
)) (caar i
) (car i
)))
985 (serv (if (consp (car i
)) (cdar i
) "")))
986 (when (and (string-match chan
(or target
""))
987 (string-match serv
(rcirc-server-name process
)))
988 (setq rcirc-decode-coding-system
(if (consp (cdr i
)) (cadr i
) (cdr i
))
989 rcirc-encode-coding-system
(if (consp (cdr i
)) (cddr i
) (cdr i
))))))
991 ;; setup the prompt and markers
992 (make-local-variable 'rcirc-prompt-start-marker
)
993 (setq rcirc-prompt-start-marker
(make-marker))
994 (set-marker rcirc-prompt-start-marker
(point-max))
995 (make-local-variable 'rcirc-prompt-end-marker
)
996 (setq rcirc-prompt-end-marker
(make-marker))
997 (set-marker rcirc-prompt-end-marker
(point-max))
998 (rcirc-update-prompt)
999 (goto-char rcirc-prompt-end-marker
)
1000 (make-local-variable 'overlay-arrow-position
)
1001 (setq overlay-arrow-position
(make-marker))
1002 (set-marker overlay-arrow-position nil
)
1004 ;; if the user changes the major mode or kills the buffer, there is
1005 ;; cleanup work to do
1006 (add-hook 'change-major-mode-hook
'rcirc-change-major-mode-hook nil t
)
1007 (add-hook 'kill-buffer-hook
'rcirc-kill-buffer-hook nil t
)
1009 ;; add to buffer list, and update buffer abbrevs
1010 (when target
; skip server buffer
1011 (let ((buffer (current-buffer)))
1012 (with-rcirc-process-buffer process
1013 (setq rcirc-buffer-alist
(cons (cons target buffer
)
1014 rcirc-buffer-alist
))))
1015 (rcirc-update-short-buffer-names))
1017 (add-hook 'completion-at-point-functions
1018 'rcirc-completion-at-point nil
'local
)
1020 (run-mode-hooks 'rcirc-mode-hook
))
1022 (defun rcirc-update-prompt (&optional all
)
1023 "Reset the prompt string in the current buffer.
1025 If ALL is non-nil, update prompts in all IRC buffers."
1027 (mapc (lambda (process)
1028 (mapc (lambda (buffer)
1029 (with-current-buffer buffer
1030 (rcirc-update-prompt)))
1031 (with-rcirc-process-buffer process
1032 (mapcar 'cdr rcirc-buffer-alist
))))
1033 (rcirc-process-list))
1034 (let ((inhibit-read-only t
)
1035 (prompt (or rcirc-prompt
"")))
1038 (replace-regexp-in-string (car rep
) (cdr rep
) prompt
)))
1039 (list (cons "%n" (rcirc-buffer-nick))
1040 (cons "%s" (with-rcirc-server-buffer rcirc-server-name
))
1041 (cons "%t" (or rcirc-target
""))))
1043 (delete-region rcirc-prompt-start-marker rcirc-prompt-end-marker
)
1044 (goto-char rcirc-prompt-start-marker
)
1045 (let ((start (point)))
1046 (insert-before-markers prompt
)
1047 (set-marker rcirc-prompt-start-marker start
)
1048 (when (not (zerop (- rcirc-prompt-end-marker
1049 rcirc-prompt-start-marker
)))
1050 (add-text-properties rcirc-prompt-start-marker
1051 rcirc-prompt-end-marker
1052 (list 'face
'rcirc-prompt
1053 'read-only t
'field t
1054 'front-sticky t
'rear-nonsticky t
))))))))
1056 (defun rcirc-set-changed (option value
)
1057 "Set OPTION to VALUE and do updates after a customization change."
1058 (set-default option value
)
1059 (cond ((eq option
'rcirc-prompt
)
1060 (rcirc-update-prompt 'all
))
1062 (error "Bad option %s" option
))))
1064 (defun rcirc-channel-p (target)
1065 "Return t if TARGET is a channel name."
1067 (not (zerop (length target
)))
1068 (or (eq (aref target
0) ?
#)
1069 (eq (aref target
0) ?
&))))
1071 (defcustom rcirc-log-directory
"~/.emacs.d/rcirc-log"
1072 "Directory to keep IRC logfiles."
1076 (defcustom rcirc-log-flag nil
1077 "Non-nil means log IRC activity to disk.
1078 Logfiles are kept in `rcirc-log-directory'."
1082 (defun rcirc-kill-buffer-hook ()
1083 "Part the channel when killing an rcirc buffer."
1084 (when (eq major-mode
'rcirc-mode
)
1085 (when (and rcirc-log-flag
1086 rcirc-log-directory
)
1088 (rcirc-clean-up-buffer "Killed buffer")))
1090 (defun rcirc-change-major-mode-hook ()
1091 "Part the channel when changing the major-mode."
1092 (rcirc-clean-up-buffer "Changed major mode"))
1094 (defun rcirc-clean-up-buffer (reason)
1095 (let ((buffer (current-buffer)))
1096 (rcirc-clear-activity buffer
)
1097 (when (and (rcirc-buffer-process)
1098 (eq (process-status (rcirc-buffer-process)) 'open
))
1099 (with-rcirc-server-buffer
1100 (setq rcirc-buffer-alist
1101 (rassq-delete-all buffer rcirc-buffer-alist
)))
1102 (rcirc-update-short-buffer-names)
1103 (if (rcirc-channel-p rcirc-target
)
1104 (rcirc-send-string (rcirc-buffer-process)
1105 (concat "PART " rcirc-target
" :" reason
))
1107 (rcirc-remove-nick-channel (rcirc-buffer-process)
1110 (setq rcirc-target nil
)))
1112 (defun rcirc-generate-new-buffer-name (process target
)
1113 "Return a buffer name based on PROCESS and TARGET.
1114 This is used for the initial name given to IRC buffers."
1115 (substring-no-properties
1117 (concat target
"@" (process-name process
))
1118 (concat "*" (process-name process
) "*"))))
1120 (defun rcirc-get-buffer (process target
&optional server
)
1121 "Return the buffer associated with the PROCESS and TARGET.
1123 If optional argument SERVER is non-nil, return the server buffer
1124 if there is no existing buffer for TARGET, otherwise return nil."
1125 (with-rcirc-process-buffer process
1128 (let ((buffer (cdr (assoc-string target rcirc-buffer-alist t
))))
1129 (or buffer
(when server
(current-buffer)))))))
1131 (defun rcirc-get-buffer-create (process target
)
1132 "Return the buffer associated with the PROCESS and TARGET.
1133 Create the buffer if it doesn't exist."
1134 (let ((buffer (rcirc-get-buffer process target
)))
1135 (if (and buffer
(buffer-live-p buffer
))
1136 (with-current-buffer buffer
1137 (when (not rcirc-target
)
1138 (setq rcirc-target target
))
1140 ;; create the buffer
1141 (with-rcirc-process-buffer process
1142 (let ((new-buffer (get-buffer-create
1143 (rcirc-generate-new-buffer-name process target
))))
1144 (with-current-buffer new-buffer
1145 (rcirc-mode process target
)
1146 (rcirc-put-nick-channel process
(rcirc-nick process
) target
1147 rcirc-current-line
))
1150 (defun rcirc-send-input ()
1151 "Send input to target associated with the current buffer."
1153 (if (< (point) rcirc-prompt-end-marker
)
1154 ;; copy the line down to the input area
1157 (let ((start (if (eq (point) (point-min))
1159 (if (get-text-property (1- (point)) 'hard
)
1161 (previous-single-property-change (point) 'hard
))))
1162 (end (next-single-property-change (1+ (point)) 'hard
)))
1163 (goto-char (point-max))
1164 (insert (replace-regexp-in-string
1166 (buffer-substring-no-properties start end
)))))
1168 (goto-char (point-max))
1169 (when (not (equal 0 (- (point) rcirc-prompt-end-marker
)))
1170 ;; delete a trailing newline
1171 (when (eq (point) (point-at-bol))
1173 (let ((input (buffer-substring-no-properties
1174 rcirc-prompt-end-marker
(point))))
1175 (dolist (line (split-string input
"\n"))
1176 (rcirc-process-input-line line
))
1177 ;; add to input-ring
1179 (ring-insert rcirc-input-ring input
)
1180 (setq rcirc-input-ring-index
0))))))
1182 (defun rcirc-fill-paragraph (&optional arg
)
1184 (when (> (point) rcirc-prompt-end-marker
)
1186 (narrow-to-region rcirc-prompt-end-marker
(point-max))
1187 (let ((fill-column rcirc-max-message-length
))
1188 (fill-region (point-min) (point-max))))))
1190 (defun rcirc-process-input-line (line)
1191 (if (string-match "^/\\([^ ]+\\) ?\\(.*\\)$" line
)
1192 (rcirc-process-command (match-string 1 line
)
1193 (match-string 2 line
)
1195 (rcirc-process-message line
)))
1197 (defun rcirc-process-message (line)
1198 (if (not rcirc-target
)
1199 (message "Not joined (no target)")
1200 (delete-region rcirc-prompt-end-marker
(point))
1201 (rcirc-send-message (rcirc-buffer-process) rcirc-target line
)
1202 (setq rcirc-last-post-time
(current-time))))
1204 (defun rcirc-process-command (command args line
)
1205 (if (eq (aref command
0) ?
/)
1206 ;; "//text" will send "/text" as a message
1207 (rcirc-process-message (substring line
1))
1208 (let ((fun (intern-soft (concat "rcirc-cmd-" command
)))
1209 (process (rcirc-buffer-process)))
1211 (with-current-buffer (current-buffer)
1212 (delete-region rcirc-prompt-end-marker
(point))
1213 (if (string= command
"me")
1214 (rcirc-print process
(rcirc-buffer-nick)
1215 "ACTION" rcirc-target args
)
1216 (rcirc-print process
(rcirc-buffer-nick)
1217 "COMMAND" rcirc-target line
))
1218 (set-marker rcirc-prompt-end-marker
(point))
1220 (funcall fun args process rcirc-target
)
1221 (rcirc-send-string process
1222 (concat command
" :" args
)))))))
1224 (defvar rcirc-parent-buffer nil
)
1225 (defvar rcirc-window-configuration nil
)
1226 (defun rcirc-edit-multiline ()
1227 "Move current edit to a dedicated buffer."
1229 (let ((pos (1+ (- (point) rcirc-prompt-end-marker
))))
1230 (goto-char (point-max))
1231 (let ((text (buffer-substring-no-properties rcirc-prompt-end-marker
1233 (parent (buffer-name)))
1234 (delete-region rcirc-prompt-end-marker
(point))
1235 (setq rcirc-window-configuration
(current-window-configuration))
1236 (pop-to-buffer (concat "*multiline " parent
"*"))
1237 (funcall rcirc-multiline-major-mode
)
1238 (rcirc-multiline-minor-mode 1)
1239 (setq rcirc-parent-buffer parent
)
1241 (and (> pos
0) (goto-char pos
))
1242 (message "Type C-c C-c to return text to %s, or C-c C-k to cancel" parent
))))
1244 (defvar rcirc-multiline-minor-mode-map
1245 (let ((map (make-sparse-keymap)))
1246 (define-key map
(kbd "C-c C-c") 'rcirc-multiline-minor-submit
)
1247 (define-key map
(kbd "C-x C-s") 'rcirc-multiline-minor-submit
)
1248 (define-key map
(kbd "C-c C-k") 'rcirc-multiline-minor-cancel
)
1249 (define-key map
(kbd "ESC ESC ESC") 'rcirc-multiline-minor-cancel
)
1251 "Keymap for multiline mode in rcirc.")
1253 (define-minor-mode rcirc-multiline-minor-mode
1254 "Minor mode for editing multiple lines in rcirc."
1256 :lighter
" rcirc-mline"
1257 :keymap rcirc-multiline-minor-mode-map
1260 (make-local-variable 'rcirc-parent-buffer
)
1261 (put 'rcirc-parent-buffer
'permanent-local t
)
1262 (setq fill-column rcirc-max-message-length
))
1264 (defun rcirc-multiline-minor-submit ()
1265 "Send the text in buffer back to parent buffer."
1267 (untabify (point-min) (point-max))
1268 (let ((text (buffer-substring (point-min) (point-max)))
1269 (buffer (current-buffer))
1271 (set-buffer rcirc-parent-buffer
)
1272 (goto-char (point-max))
1274 (kill-buffer buffer
)
1275 (set-window-configuration rcirc-window-configuration
)
1276 (goto-char (+ rcirc-prompt-end-marker
(1- pos
)))))
1278 (defun rcirc-multiline-minor-cancel ()
1279 "Cancel the multiline edit."
1281 (kill-buffer (current-buffer))
1282 (set-window-configuration rcirc-window-configuration
))
1284 (defun rcirc-any-buffer (process)
1285 "Return a buffer for PROCESS, either the one selected or the process buffer."
1286 (if rcirc-always-use-server-buffer-flag
1287 (process-buffer process
)
1288 (let ((buffer (window-buffer (selected-window))))
1290 (with-current-buffer buffer
1291 (and (eq major-mode
'rcirc-mode
)
1292 (eq (rcirc-buffer-process) process
))))
1294 (process-buffer process
)))))
1296 (defcustom rcirc-response-formats
1297 '(("PRIVMSG" .
"<%N> %m")
1298 ("NOTICE" .
"-%N- %m")
1299 ("ACTION" .
"[%N %m]")
1301 ("ERROR" .
"%fw!!! %m")
1302 (t .
"%fp*** %fs%n %r %m"))
1303 "An alist of formats used for printing responses.
1304 The format is looked up using the response-type as a key;
1305 if no match is found, the default entry (with a key of `t') is used.
1307 The entry's value part should be a string, which is inserted with
1308 the of the following escape sequences replaced by the described values:
1311 %n The sender's nick
1312 %N The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
1313 %r The response-type
1315 %fw Following text uses the face `font-lock-warning-face'
1316 %fp Following text uses the face `rcirc-server-prefix'
1317 %fs Following text uses the face `rcirc-server'
1318 %f[FACE] Following text uses the face FACE
1319 %f- Following text uses the default face
1320 %% A literal `%' character"
1321 :type
'(alist :key-type
(choice (string :tag
"Type")
1322 (const :tag
"Default" t
))
1326 (defcustom rcirc-omit-responses
1327 '("JOIN" "PART" "QUIT" "NICK")
1328 "Responses which will be hidden when `rcirc-omit-mode' is enabled."
1329 :type
'(repeat string
)
1332 (defun rcirc-format-response-string (process sender response target text
)
1333 "Return a nicely-formatted response string, incorporating TEXT
1334 \(and perhaps other arguments). The specific formatting used
1335 is found by looking up RESPONSE in `rcirc-response-formats'."
1337 (insert (or (cdr (assoc response rcirc-response-formats
))
1338 (cdr (assq t rcirc-response-formats
))))
1339 (goto-char (point-min))
1340 (let ((start (point-min))
1341 (sender (if (or (not sender
)
1342 (string= (rcirc-server-name process
) sender
))
1346 (while (re-search-forward "%\\(\\(f\\(.\\)\\)\\|\\(.\\)\\)" nil t
)
1347 (rcirc-add-face start
(match-beginning 0) face
)
1348 (setq start
(match-beginning 0))
1350 (case (aref (match-string 1) 0)
1352 (case (string-to-char (match-string 3))
1353 (?w
'font-lock-warning-face
)
1354 (?p
'rcirc-server-prefix
)
1359 (?N
(let ((my-nick (rcirc-nick process
)))
1361 (with-syntax-table rcirc-nick-syntax-table
1362 (rcirc-facify sender
1363 (cond ((string= sender my-nick
)
1365 ((and rcirc-bright-nicks
1367 (regexp-opt rcirc-bright-nicks
1371 ((and rcirc-dim-nicks
1373 (regexp-opt rcirc-dim-nicks
1378 'rcirc-other-nick
)))))))
1379 (?m
(propertize text
'rcirc-text text
))
1382 (t (concat "UNKNOWN CODE:" (match-string 0))))
1384 (rcirc-add-face (match-beginning 0) (match-end 0) face
))
1385 (rcirc-add-face start
(match-beginning 0) face
))
1386 (buffer-substring (point-min) (point-max))))
1388 (defun rcirc-target-buffer (process sender response target text
)
1389 "Return a buffer to print the server response."
1390 (assert (not (bufferp target
)))
1391 (with-rcirc-process-buffer process
1393 (rcirc-any-buffer process
))
1394 ((not (rcirc-channel-p target
))
1395 ;; message from another user
1396 (if (or (string= response
"PRIVMSG")
1397 (string= response
"ACTION"))
1398 (rcirc-get-buffer-create process
(if (string= sender rcirc-nick
)
1401 (rcirc-get-buffer process target t
)))
1402 ((or (rcirc-get-buffer process target
)
1403 (rcirc-any-buffer process
))))))
1405 (defvar rcirc-activity-types nil
)
1406 (make-variable-buffer-local 'rcirc-activity-types
)
1407 (defvar rcirc-last-sender nil
)
1408 (make-variable-buffer-local 'rcirc-last-sender
)
1410 (defcustom rcirc-omit-threshold
100
1411 "Number of lines since last activity from a nick before `rcirc-omit-responses' are omitted."
1415 (defcustom rcirc-log-process-buffers nil
1416 "Non-nil if rcirc process buffers should be logged to disk."
1421 (defun rcirc-last-quit-line (process nick target
)
1422 "Return the line number where NICK left TARGET.
1423 Returns nil if the information is not recorded."
1424 (let ((chanbuf (rcirc-get-buffer process target
)))
1426 (cdr (assoc-string nick
(with-current-buffer chanbuf
1427 rcirc-recent-quit-alist
))))))
1429 (defun rcirc-last-line (process nick target
)
1430 "Return the line from the last activity from NICK in TARGET."
1431 (let* ((chanbuf (rcirc-get-buffer process target
))
1432 (line (or (cdr (assoc-string target
1433 (gethash nick
(with-rcirc-server-buffer
1434 rcirc-nick-table
)) t
))
1435 (rcirc-last-quit-line process nick target
))))
1438 ;;(message "line is nil for %s in %s" nick target)
1441 (defun rcirc-elapsed-lines (process nick target
)
1442 "Return the number of lines since activity from NICK in TARGET."
1443 (let ((last-activity-line (rcirc-last-line process nick target
)))
1444 (when (and last-activity-line
1445 (> last-activity-line
0))
1446 (- rcirc-current-line last-activity-line
))))
1448 (defvar rcirc-markup-text-functions
1449 '(rcirc-markup-attributes
1450 rcirc-markup-my-nick
1452 rcirc-markup-keywords
1453 rcirc-markup-bright-nicks
)
1455 "List of functions used to manipulate text before it is printed.
1457 Each function takes two arguments, SENDER, and RESPONSE. The
1458 buffer is narrowed with the text to be printed and the point is
1459 at the beginning of the `rcirc-text' propertized text.")
1461 (defun rcirc-print (process sender response target text
&optional activity
)
1462 "Print TEXT in the buffer associated with TARGET.
1463 Format based on SENDER and RESPONSE. If ACTIVITY is non-nil,
1465 (or text
(setq text
""))
1466 (unless (and (or (member sender rcirc-ignore-list
)
1467 (member (with-syntax-table rcirc-nick-syntax-table
1468 (when (string-match "^\\([^/]\\w*\\)[:,]" text
)
1469 (match-string 1 text
)))
1471 ;; do not ignore if we sent the message
1472 (not (string= sender
(rcirc-nick process
))))
1473 (let* ((buffer (rcirc-target-buffer process sender response target text
))
1474 (inhibit-read-only t
))
1475 (with-current-buffer buffer
1476 (let ((moving (= (point) rcirc-prompt-end-marker
))
1477 (old-point (point-marker))
1478 (fill-start (marker-position rcirc-prompt-start-marker
)))
1480 (unless (string= sender
(rcirc-nick process
))
1481 ;; only decode text from other senders, not ours
1482 (setq text
(decode-coding-string text rcirc-decode-coding-system
))
1483 ;; mark the line with overlay arrow
1484 (unless (or (marker-position overlay-arrow-position
)
1485 (get-buffer-window (current-buffer))
1486 (member response rcirc-omit-responses
))
1487 (set-marker overlay-arrow-position
1488 (marker-position rcirc-prompt-start-marker
))))
1490 ;; temporarily set the marker insertion-type because
1491 ;; insert-before-markers results in hidden text in new buffers
1492 (goto-char rcirc-prompt-start-marker
)
1493 (set-marker-insertion-type rcirc-prompt-start-marker t
)
1494 (set-marker-insertion-type rcirc-prompt-end-marker t
)
1496 (let ((start (point)))
1497 (insert (rcirc-format-response-string process sender response nil
1499 (propertize "\n" 'hard t
))
1501 ;; squeeze spaces out of text before rcirc-text
1502 (fill-region fill-start
1503 (1- (or (next-single-property-change fill-start
1505 rcirc-prompt-end-marker
)))
1507 ;; run markup functions
1510 (narrow-to-region start rcirc-prompt-start-marker
)
1511 (goto-char (or (next-single-property-change start
'rcirc-text
)
1513 (when (rcirc-buffer-process)
1514 (save-excursion (rcirc-markup-timestamp sender response
))
1515 (dolist (fn rcirc-markup-text-functions
)
1516 (save-excursion (funcall fn sender response
)))
1517 (when rcirc-fill-flag
1518 (save-excursion (rcirc-markup-fill sender response
))))
1520 (when rcirc-read-only-flag
1521 (add-text-properties (point-min) (point-max)
1522 '(read-only t front-sticky t
))))
1523 ;; make text omittable
1524 (let ((last-activity-lines (rcirc-elapsed-lines process sender target
)))
1525 (if (and (not (string= (rcirc-nick process
) sender
))
1526 (member response rcirc-omit-responses
)
1527 (or (not last-activity-lines
)
1528 (< rcirc-omit-threshold last-activity-lines
)))
1529 (put-text-property (1- start
) (1- rcirc-prompt-start-marker
)
1530 'invisible
'rcirc-omit
)
1531 ;; otherwise increment the line count
1532 (setq rcirc-current-line
(1+ rcirc-current-line
))))))
1534 (set-marker-insertion-type rcirc-prompt-start-marker nil
)
1535 (set-marker-insertion-type rcirc-prompt-end-marker nil
)
1537 ;; truncate buffer if it is very long
1539 (when (and rcirc-buffer-maximum-lines
1540 (> rcirc-buffer-maximum-lines
0)
1541 (= (forward-line (- rcirc-buffer-maximum-lines
)) 0))
1542 (delete-region (point-min) (point))))
1544 ;; set the window point for buffers show in windows
1545 (walk-windows (lambda (w)
1546 (when (and (not (eq (selected-window) w
))
1547 (eq (current-buffer)
1549 (>= (window-point w
)
1550 rcirc-prompt-end-marker
))
1551 (set-window-point w
(point-max))))
1554 ;; restore the point
1555 (goto-char (if moving rcirc-prompt-end-marker old-point
))
1557 ;; keep window on bottom line if it was already there
1558 (when rcirc-scroll-show-maximum-output
1559 (walk-windows (lambda (w)
1560 (when (eq (window-buffer w
) (current-buffer))
1561 (with-current-buffer (window-buffer w
)
1562 (when (eq major-mode
'rcirc-mode
)
1563 (with-selected-window w
1564 (when (<= (- (window-height)
1565 (count-screen-lines (window-point)
1572 ;; flush undo (can we do something smarter here?)
1573 (buffer-disable-undo)
1574 (buffer-enable-undo))
1576 ;; record modeline activity
1578 (not rcirc-ignore-buffer-activity-flag
)
1579 (not (and rcirc-dim-nicks sender
1580 (string-match (regexp-opt rcirc-dim-nicks
) sender
)
1581 (rcirc-channel-p target
))))
1582 (rcirc-record-activity (current-buffer)
1583 (when (not (rcirc-channel-p rcirc-target
))
1586 (when (and rcirc-log-flag
1588 rcirc-log-process-buffers
))
1589 (rcirc-log process sender response target text
))
1591 (sit-for 0) ; displayed text before hook
1592 (run-hook-with-args 'rcirc-print-hooks
1593 process sender response target text
)))))
1595 (defun rcirc-generate-log-filename (process target
)
1597 (rcirc-generate-new-buffer-name process target
)
1598 (process-name process
)))
1600 (defcustom rcirc-log-filename-function
'rcirc-generate-log-filename
1601 "A function to generate the filename used by rcirc's logging facility.
1603 It is called with two arguments, PROCESS and TARGET (see
1604 `rcirc-generate-new-buffer-name' for their meaning), and should
1605 return the filename, or nil if no logging is desired for this
1608 If the returned filename is absolute (`file-name-absolute-p'
1609 returns t), then it is used as-is, otherwise the resulting file
1610 is put into `rcirc-log-directory'.
1612 The filename is then cleaned using `convert-standard-filename' to
1613 guarantee valid filenames for the current OS."
1617 (defun rcirc-log (process sender response target text
)
1618 "Record line in `rcirc-log', to be later written to disk."
1619 (let ((filename (funcall rcirc-log-filename-function process target
)))
1620 (unless (null filename
)
1621 (let ((cell (assoc-string filename rcirc-log-alist
))
1622 (line (concat (format-time-string rcirc-time-format
)
1623 (substring-no-properties
1624 (rcirc-format-response-string process sender
1625 response target text
))
1628 (setcdr cell
(concat (cdr cell
) line
))
1629 (setq rcirc-log-alist
1630 (cons (cons filename line
) rcirc-log-alist
)))))))
1632 (defun rcirc-log-write ()
1633 "Flush `rcirc-log-alist' data to disk.
1635 Log data is written to `rcirc-log-directory', except for
1636 log-files with absolute names (see `rcirc-log-filename-function')."
1637 (dolist (cell rcirc-log-alist
)
1638 (let ((filename (convert-standard-filename
1639 (expand-file-name (car cell
)
1640 rcirc-log-directory
)))
1641 (coding-system-for-write 'utf-8
))
1642 (make-directory (file-name-directory filename
) t
)
1645 (write-region (point-min) (point-max) filename t
'quiet
))))
1646 (setq rcirc-log-alist nil
))
1648 (defun rcirc-view-log-file ()
1649 "View logfile corresponding to the current buffer."
1651 (find-file-other-window
1652 (expand-file-name (funcall rcirc-log-filename-function
1653 (rcirc-buffer-process) rcirc-target
)
1654 rcirc-log-directory
)))
1656 (defun rcirc-join-channels (process channels
)
1658 (save-window-excursion
1659 (dolist (channel channels
)
1660 (with-rcirc-process-buffer process
1661 (rcirc-cmd-join channel process
)))))
1664 (defvar rcirc-nick-prefix-chars
"~&@%+")
1665 (defun rcirc-user-nick (user)
1666 "Return the nick from USER. Remove any non-nick junk."
1668 (if (string-match (concat "^[" rcirc-nick-prefix-chars
1669 "]?\\([^! ]+\\)!?") (or user
""))
1670 (match-string 1 user
)
1673 (defun rcirc-nick-channels (process nick
)
1674 "Return list of channels for NICK."
1675 (with-rcirc-process-buffer process
1676 (mapcar (lambda (x) (car x
))
1677 (gethash nick rcirc-nick-table
))))
1679 (defun rcirc-put-nick-channel (process nick channel
&optional line
)
1680 "Add CHANNEL to list associated with NICK.
1681 Update the associated linestamp if LINE is non-nil.
1683 If the record doesn't exist, and LINE is nil, set the linestamp
1685 (let ((nick (rcirc-user-nick nick
)))
1686 (with-rcirc-process-buffer process
1687 (let* ((chans (gethash nick rcirc-nick-table
))
1688 (record (assoc-string channel chans t
)))
1690 (when line
(setcdr record line
))
1691 (puthash nick
(cons (cons channel
(or line
0))
1693 rcirc-nick-table
))))))
1695 (defun rcirc-nick-remove (process nick
)
1696 "Remove NICK from table."
1697 (with-rcirc-process-buffer process
1698 (remhash nick rcirc-nick-table
)))
1700 (defun rcirc-remove-nick-channel (process nick channel
)
1701 "Remove the CHANNEL from list associated with NICK."
1702 (with-rcirc-process-buffer process
1703 (let* ((chans (gethash nick rcirc-nick-table
))
1705 ;; instead of assoc-string-delete-all:
1706 (let ((record (assoc-string channel chans t
)))
1708 (setcar record
'delete
)
1709 (assq-delete-all 'delete chans
)))))
1711 (puthash nick newchans rcirc-nick-table
)
1712 (remhash nick rcirc-nick-table
)))))
1714 (defun rcirc-channel-nicks (process target
)
1715 "Return the list of nicks associated with TARGET sorted by last activity."
1717 (if (rcirc-channel-p target
)
1718 (with-rcirc-process-buffer process
1722 (let ((record (assoc-string target v t
)))
1724 (setq nicks
(cons (cons k
(cdr record
)) nicks
)))))
1726 (mapcar (lambda (x) (car x
))
1727 (sort nicks
(lambda (x y
)
1728 (let ((lx (or (cdr x
) 0))
1729 (ly (or (cdr y
) 0)))
1733 (defun rcirc-ignore-update-automatic (nick)
1734 "Remove NICK from `rcirc-ignore-list'
1735 if NICK is also on `rcirc-ignore-list-automatic'."
1736 (when (member nick rcirc-ignore-list-automatic
)
1737 (setq rcirc-ignore-list-automatic
1738 (delete nick rcirc-ignore-list-automatic
)
1740 (delete nick rcirc-ignore-list
))))
1742 (defun rcirc-nickname< (s1 s2
)
1743 "Return t if IRC nickname S1 is less than S2, and nil otherwise.
1744 Operator nicknames (@) are considered less than voiced
1745 nicknames (+). Any other nicknames are greater than voiced
1746 nicknames. The comparison is case-insensitive."
1747 (setq s1
(downcase s1
)
1749 (let* ((s1-op (eq ?
@ (string-to-char s1
)))
1750 (s2-op (eq ?
@ (string-to-char s2
))))
1753 (string< (substring s1
1) (substring s2
1))
1759 (defun rcirc-sort-nicknames-join (input sep
)
1760 "Return a string of sorted nicknames.
1761 INPUT is a string containing nicknames separated by SEP.
1762 This function does not alter the INPUT string."
1763 (let* ((parts (split-string input sep t
))
1764 (sorted (sort parts
'rcirc-nickname
<)))
1765 (mapconcat 'identity sorted sep
)))
1767 ;;; activity tracking
1768 (defvar rcirc-track-minor-mode-map
1769 (let ((map (make-sparse-keymap)))
1770 (define-key map
(kbd "C-c C-@") 'rcirc-next-active-buffer
)
1771 (define-key map
(kbd "C-c C-SPC") 'rcirc-next-active-buffer
)
1773 "Keymap for rcirc track minor mode.")
1776 (define-minor-mode rcirc-track-minor-mode
1777 "Global minor mode for tracking activity in rcirc buffers."
1780 :keymap rcirc-track-minor-mode-map
1783 (or global-mode-string
(setq global-mode-string
'("")))
1784 ;; toggle the mode-line channel indicator
1785 (if rcirc-track-minor-mode
1787 (and (not (memq 'rcirc-activity-string global-mode-string
))
1788 (setq global-mode-string
1789 (append global-mode-string
'(rcirc-activity-string))))
1790 (add-hook 'window-configuration-change-hook
1791 'rcirc-window-configuration-change
))
1792 (setq global-mode-string
1793 (delete 'rcirc-activity-string global-mode-string
))
1794 (remove-hook 'window-configuration-change-hook
1795 'rcirc-window-configuration-change
)))
1797 (or (assq 'rcirc-ignore-buffer-activity-flag minor-mode-alist
)
1798 (setq minor-mode-alist
1799 (cons '(rcirc-ignore-buffer-activity-flag " Ignore") minor-mode-alist
)))
1800 (or (assq 'rcirc-low-priority-flag minor-mode-alist
)
1801 (setq minor-mode-alist
1802 (cons '(rcirc-low-priority-flag " LowPri") minor-mode-alist
)))
1803 (or (assq 'rcirc-omit-mode minor-mode-alist
)
1804 (setq minor-mode-alist
1805 (cons '(rcirc-omit-mode " Omit") minor-mode-alist
)))
1807 (defun rcirc-toggle-ignore-buffer-activity ()
1808 "Toggle the value of `rcirc-ignore-buffer-activity-flag'."
1810 (setq rcirc-ignore-buffer-activity-flag
1811 (not rcirc-ignore-buffer-activity-flag
))
1812 (message (if rcirc-ignore-buffer-activity-flag
1813 "Ignore activity in this buffer"
1814 "Notice activity in this buffer"))
1815 (force-mode-line-update))
1817 (defun rcirc-toggle-low-priority ()
1818 "Toggle the value of `rcirc-low-priority-flag'."
1820 (setq rcirc-low-priority-flag
1821 (not rcirc-low-priority-flag
))
1822 (message (if rcirc-low-priority-flag
1823 "Activity in this buffer is low priority"
1824 "Activity in this buffer is normal priority"))
1825 (force-mode-line-update))
1827 (defun rcirc-omit-mode ()
1828 "Toggle the Rcirc-Omit mode.
1829 If enabled, \"uninteresting\" lines are not shown.
1830 Uninteresting lines are those whose responses are listed in
1831 `rcirc-omit-responses'."
1833 (setq rcirc-omit-mode
(not rcirc-omit-mode
))
1836 (add-to-invisibility-spec '(rcirc-omit . nil
))
1837 (message "Rcirc-Omit mode enabled"))
1838 (remove-from-invisibility-spec '(rcirc-omit . nil
))
1839 (message "Rcirc-Omit mode disabled"))
1840 (recenter (when (> (point) rcirc-prompt-start-marker
) -
1)))
1842 (defun rcirc-switch-to-server-buffer ()
1843 "Switch to the server buffer associated with current channel buffer."
1845 (switch-to-buffer rcirc-server-buffer
))
1847 (defun rcirc-jump-to-first-unread-line ()
1848 "Move the point to the first unread line in this buffer."
1850 (if (marker-position overlay-arrow-position
)
1851 (goto-char overlay-arrow-position
)
1852 (message "No unread messages")))
1854 (defun rcirc-non-irc-buffer ()
1855 (let ((buflist (buffer-list))
1857 (while (and buflist
(not buffer
))
1858 (with-current-buffer (car buflist
)
1859 (unless (or (eq major-mode
'rcirc-mode
)
1860 (= ?\s
(aref (buffer-name) 0)) ; internal buffers
1861 (get-buffer-window (current-buffer)))
1862 (setq buffer
(current-buffer))))
1863 (setq buflist
(cdr buflist
)))
1866 (defun rcirc-next-active-buffer (arg)
1867 "Switch to the next rcirc buffer with activity.
1868 With prefix ARG, go to the next low priority buffer with activity."
1870 (let* ((pair (rcirc-split-activity rcirc-activity
))
1873 (if (or (and (not arg
) hipri
)
1876 (switch-to-buffer (car (if arg lopri hipri
)))
1877 (when (> (point) rcirc-prompt-start-marker
)
1879 (if (eq major-mode
'rcirc-mode
)
1880 (switch-to-buffer (rcirc-non-irc-buffer))
1881 (message "%s" (concat
1886 (key-description (this-command-keys))
1887 " for low priority activity."))))))))
1889 (defvar rcirc-activity-hooks nil
1890 "Hook to be run when there is channel activity.
1892 Functions are called with a single argument, the buffer with the
1893 activity. Only run if the buffer is not visible and
1894 `rcirc-ignore-buffer-activity-flag' is non-nil.")
1896 (defun rcirc-record-activity (buffer &optional type
)
1897 "Record BUFFER activity with TYPE."
1898 (with-current-buffer buffer
1899 (let ((old-activity rcirc-activity
)
1900 (old-types rcirc-activity-types
))
1901 (when (not (get-buffer-window (current-buffer) t
))
1902 (setq rcirc-activity
1903 (sort (add-to-list 'rcirc-activity
(current-buffer))
1905 (let ((t1 (with-current-buffer b1 rcirc-last-post-time
))
1906 (t2 (with-current-buffer b2 rcirc-last-post-time
)))
1907 (time-less-p t2 t1
)))))
1908 (pushnew type rcirc-activity-types
)
1909 (unless (and (equal rcirc-activity old-activity
)
1910 (member type old-types
))
1911 (rcirc-update-activity-string)))))
1912 (run-hook-with-args 'rcirc-activity-hooks buffer
))
1914 (defun rcirc-clear-activity (buffer)
1915 "Clear the BUFFER activity."
1916 (setq rcirc-activity
(remove buffer rcirc-activity
))
1917 (with-current-buffer buffer
1918 (setq rcirc-activity-types nil
)))
1920 (defun rcirc-clear-unread (buffer)
1921 "Erase the last read message arrow from BUFFER."
1922 (when (buffer-live-p buffer
)
1923 (with-current-buffer buffer
1924 (set-marker overlay-arrow-position nil
))))
1926 (defun rcirc-split-activity (activity)
1927 "Return a cons cell with ACTIVITY split into (lopri . hipri)."
1929 (dolist (buf rcirc-activity
)
1930 (with-current-buffer buf
1931 (if (and rcirc-low-priority-flag
1932 (not (member 'nick rcirc-activity-types
)))
1933 (add-to-list 'lopri buf t
)
1934 (add-to-list 'hipri buf t
))))
1935 (cons lopri hipri
)))
1937 (defvar rcirc-update-activity-string-hook nil
1938 "Hook run whenever the activity string is updated.")
1940 ;; TODO: add mouse properties
1941 (defun rcirc-update-activity-string ()
1942 "Update mode-line string."
1943 (let* ((pair (rcirc-split-activity rcirc-activity
))
1946 (setq rcirc-activity-string
1947 (cond ((or hipri lopri
)
1948 (concat (and hipri
"[")
1949 (rcirc-activity-string hipri
)
1950 (and hipri lopri
",")
1953 (rcirc-activity-string lopri
)
1956 ((not (null (rcirc-process-list)))
1959 (run-hooks 'rcirc-update-activity-string-hook
)))
1961 (defun rcirc-activity-string (buffers)
1962 (mapconcat (lambda (b)
1963 (let ((s (substring-no-properties (rcirc-short-buffer-name b
))))
1964 (with-current-buffer b
1965 (dolist (type rcirc-activity-types
)
1966 (rcirc-add-face 0 (length s
)
1968 (nick 'rcirc-track-nick
)
1969 (keyword 'rcirc-track-keyword
))
1974 (defun rcirc-short-buffer-name (buffer)
1975 "Return a short name for BUFFER to use in the modeline indicator."
1976 (with-current-buffer buffer
1977 (or rcirc-short-buffer-name
(buffer-name))))
1979 (defun rcirc-visible-buffers ()
1980 "Return a list of the visible buffers that are in rcirc-mode."
1982 (walk-windows (lambda (w)
1983 (with-current-buffer (window-buffer w
)
1984 (when (eq major-mode
'rcirc-mode
)
1985 (push (current-buffer) acc
)))))
1988 (defvar rcirc-visible-buffers nil
)
1989 (defun rcirc-window-configuration-change ()
1990 (unless (minibuffer-window-active-p (minibuffer-window))
1991 ;; delay this until command has finished to make sure window is
1992 ;; actually visible before clearing activity
1993 (add-hook 'post-command-hook
'rcirc-window-configuration-change-1
)))
1995 (defun rcirc-window-configuration-change-1 ()
1996 ;; clear activity and overlay arrows
1997 (let* ((old-activity rcirc-activity
)
1998 (hidden-buffers rcirc-visible-buffers
))
2000 (setq rcirc-visible-buffers
(rcirc-visible-buffers))
2002 (dolist (vbuf rcirc-visible-buffers
)
2003 (setq hidden-buffers
(delq vbuf hidden-buffers
))
2004 ;; clear activity for all visible buffers
2005 (rcirc-clear-activity vbuf
))
2007 ;; clear unread arrow from recently hidden buffers
2008 (dolist (hbuf hidden-buffers
)
2009 (rcirc-clear-unread hbuf
))
2011 ;; remove any killed buffers from list
2012 (setq rcirc-activity
2013 (delq nil
(mapcar (lambda (buf) (when (buffer-live-p buf
) buf
))
2015 ;; update the mode-line string
2016 (unless (equal old-activity rcirc-activity
)
2017 (rcirc-update-activity-string)))
2019 (remove-hook 'post-command-hook
'rcirc-window-configuration-change-1
))
2022 ;;; buffer name abbreviation
2023 (defun rcirc-update-short-buffer-names ()
2025 (apply 'append
(mapcar (lambda (process)
2026 (with-rcirc-process-buffer process
2027 rcirc-buffer-alist
))
2028 (rcirc-process-list)))))
2029 (dolist (i (rcirc-abbreviate bufalist
))
2030 (when (buffer-live-p (cdr i
))
2031 (with-current-buffer (cdr i
)
2032 (setq rcirc-short-buffer-name
(car i
)))))))
2034 (defun rcirc-abbreviate (pairs)
2035 (apply 'append
(mapcar 'rcirc-rebuild-tree
(rcirc-make-trees pairs
))))
2037 (defun rcirc-rebuild-tree (tree &optional acc
)
2038 (let ((ch (char-to-string (car tree
))))
2039 (dolist (x (cdr tree
))
2041 (setq acc
(append acc
2043 (cons (concat ch
(car y
))
2045 (rcirc-rebuild-tree x
))))
2046 (setq acc
(cons (cons ch x
) acc
))))
2049 (defun rcirc-make-trees (pairs)
2051 (mapc (lambda (pair)
2053 (let* ((str (car pair
))
2055 (char (unless (zerop (length str
))
2057 (rest (unless (zerop (length str
))
2059 (part (if char
(assq char alist
))))
2061 ;; existing partition
2062 (setcdr part
(cons (cons rest data
) (cdr part
)))
2064 (setq alist
(cons (if char
2065 (list char
(cons rest data
))
2068 (setq alist
(cons pair alist
))))
2070 ;; recurse into cdrs of alist
2072 (when (and (listp x
) (listp (cadr x
)))
2073 (setcdr x
(if (> (length (cdr x
)) 1)
2074 (rcirc-make-trees (cdr x
))
2075 (setcdr x
(list (cdadr x
)))))))
2078 ;;; /commands these are called with 3 args: PROCESS, TARGET, which is
2079 ;; the current buffer/channel/user, and ARGS, which is a string
2080 ;; containing the text following the /cmd.
2082 (defmacro defun-rcirc-command
(command argument docstring interactive-form
2086 (add-to-list 'rcirc-client-commands
,(concat "/" (symbol-name command
)))
2087 (defun ,(intern (concat "rcirc-cmd-" (symbol-name command
)))
2088 (,@argument
&optional process target
)
2089 ,(concat docstring
"\n\nNote: If PROCESS or TARGET are nil, the values given"
2090 "\nby `rcirc-buffer-process' and `rcirc-target' will be used.")
2092 (let ((process (or process
(rcirc-buffer-process)))
2093 (target (or target rcirc-target
)))
2096 (defun-rcirc-command msg
(message)
2097 "Send private MESSAGE to TARGET."
2101 (setq target
(completing-read "Message nick: "
2102 (with-rcirc-server-buffer
2104 (when (> (length target
) 0)
2105 (setq message
(read-string (format "Message %s: " target
)))
2106 (when (> (length message
) 0)
2107 (rcirc-send-message process target message
))))
2108 (if (not (string-match "\\([^ ]+\\) \\(.+\\)" message
))
2109 (message "Not enough args, or something.")
2110 (setq target
(match-string 1 message
)
2111 message
(match-string 2 message
))
2112 (rcirc-send-message process target message
))))
2114 (defun-rcirc-command query
(nick)
2115 "Open a private chat buffer to NICK."
2116 (interactive (list (completing-read "Query nick: "
2117 (with-rcirc-server-buffer rcirc-nick-table
))))
2118 (let ((existing-buffer (rcirc-get-buffer process nick
)))
2119 (switch-to-buffer (or existing-buffer
2120 (rcirc-get-buffer-create process nick
)))
2121 (when (not existing-buffer
)
2122 (rcirc-cmd-whois nick
))))
2124 (defun-rcirc-command join
(channels)
2126 CHANNELS is a comma- or space-separated string of channel names."
2127 (interactive "sJoin channels: ")
2128 (let* ((split-channels (split-string channels
"[ ,]" t
))
2129 (buffers (mapcar (lambda (ch)
2130 (rcirc-get-buffer-create process ch
))
2132 (channels (mapconcat 'identity split-channels
",")))
2133 (rcirc-send-string process
(concat "JOIN " channels
))
2134 (when (not (eq (selected-window) (minibuffer-window)))
2135 (dolist (b buffers
) ;; order the new channel buffers in the buffer list
2136 (switch-to-buffer b
)))))
2138 ;; TODO: /part #channel reason, or consider removing #channel altogether
2139 (defun-rcirc-command part
(channel)
2141 (interactive "sPart channel: ")
2142 (let ((channel (if (> (length channel
) 0) channel target
)))
2143 (rcirc-send-string process
(concat "PART " channel
" :" rcirc-id-string
))))
2145 (defun-rcirc-command quit
(reason)
2146 "Send a quit message to server with REASON."
2147 (interactive "sQuit reason: ")
2148 (rcirc-send-string process
(concat "QUIT :"
2149 (if (not (zerop (length reason
)))
2153 (defun-rcirc-command nick
(nick)
2154 "Change nick to NICK."
2157 (setq nick
(read-string "New nick: " (rcirc-nick process
))))
2158 (rcirc-send-string process
(concat "NICK " nick
)))
2160 (defun-rcirc-command names
(channel)
2161 "Display list of names in CHANNEL or in current channel if CHANNEL is nil.
2162 If called interactively, prompt for a channel when prefix arg is supplied."
2164 (if (called-interactively-p 'interactive
)
2166 (setq channel
(read-string "List names in channel: " target
))))
2167 (let ((channel (if (> (length channel
) 0)
2170 (rcirc-send-string process
(concat "NAMES " channel
))))
2172 (defun-rcirc-command topic
(topic)
2173 "List TOPIC for the TARGET channel.
2174 With a prefix arg, prompt for new topic."
2176 (if (and (called-interactively-p 'interactive
) topic
)
2177 (setq topic
(read-string "New Topic: " rcirc-topic
)))
2178 (rcirc-send-string process
(concat "TOPIC " target
2179 (when (> (length topic
) 0)
2180 (concat " :" topic
)))))
2182 (defun-rcirc-command whois
(nick)
2183 "Request information from server about NICK."
2185 (completing-read "Whois: "
2186 (with-rcirc-server-buffer rcirc-nick-table
))))
2187 (rcirc-send-string process
(concat "WHOIS " nick
)))
2189 (defun-rcirc-command mode
(args)
2190 "Set mode with ARGS."
2191 (interactive (list (concat (read-string "Mode nick or channel: ")
2192 " " (read-string "Mode: "))))
2193 (rcirc-send-string process
(concat "MODE " args
)))
2195 (defun-rcirc-command list
(channels)
2196 "Request information on CHANNELS from server."
2197 (interactive "sList Channels: ")
2198 (rcirc-send-string process
(concat "LIST " channels
)))
2200 (defun-rcirc-command oper
(args)
2201 "Send operator command to server."
2202 (interactive "sOper args: ")
2203 (rcirc-send-string process
(concat "OPER " args
)))
2205 (defun-rcirc-command quote
(message)
2206 "Send MESSAGE literally to server."
2207 (interactive "sServer message: ")
2208 (rcirc-send-string process message
))
2210 (defun-rcirc-command kick
(arg)
2211 "Kick NICK from current channel."
2213 (concat (completing-read "Kick nick: "
2214 (rcirc-channel-nicks
2215 (rcirc-buffer-process)
2217 (read-from-minibuffer "Kick reason: "))))
2218 (let* ((arglist (split-string arg
))
2219 (argstring (concat (car arglist
) " :"
2220 (mapconcat 'identity
(cdr arglist
) " "))))
2221 (rcirc-send-string process
(concat "KICK " target
" " argstring
))))
2223 (defun rcirc-cmd-ctcp (args &optional process target
)
2224 (if (string-match "^\\([^ ]+\\)\\s-+\\(.+\\)$" args
)
2225 (let* ((target (match-string 1 args
))
2226 (request (upcase (match-string 2 args
)))
2227 (function (intern-soft (concat "rcirc-ctcp-sender-" request
))))
2228 (if (fboundp function
) ;; use special function if available
2229 (funcall function process target request
)
2230 (rcirc-send-ctcp process target request
)))
2231 (rcirc-print process
(rcirc-nick process
) "ERROR" nil
2232 "usage: /ctcp NICK REQUEST")))
2234 (defun rcirc-ctcp-sender-PING (process target request
)
2235 "Send a CTCP PING message to TARGET."
2236 (let ((timestamp (format "%.0f" (rcirc-float-time))))
2237 (rcirc-send-ctcp process target
"PING" timestamp
)))
2239 (defun rcirc-cmd-me (args &optional process target
)
2240 (rcirc-send-ctcp process target
"ACTION" args
))
2242 (defun rcirc-add-or-remove (set &rest elements
)
2243 (dolist (elt elements
)
2244 (if (and elt
(not (string= "" elt
)))
2245 (setq set
(if (member-ignore-case elt set
)
2250 (defun-rcirc-command ignore
(nick)
2251 "Manage the ignore list.
2252 Ignore NICK, unignore NICK if already ignored, or list ignored
2253 nicks when no NICK is given. When listing ignored nicks, the
2254 ones added to the list automatically are marked with an asterisk."
2255 (interactive "sToggle ignoring of nick: ")
2256 (setq rcirc-ignore-list
2257 (apply #'rcirc-add-or-remove rcirc-ignore-list
2258 (split-string nick nil t
)))
2259 (rcirc-print process nil
"IGNORE" target
2263 (if (member nick rcirc-ignore-list-automatic
)
2265 rcirc-ignore-list
" ")))
2267 (defun-rcirc-command bright
(nick)
2268 "Manage the bright nick list."
2269 (interactive "sToggle emphasis of nick: ")
2270 (setq rcirc-bright-nicks
2271 (apply #'rcirc-add-or-remove rcirc-bright-nicks
2272 (split-string nick nil t
)))
2273 (rcirc-print process nil
"BRIGHT" target
2274 (mapconcat 'identity rcirc-bright-nicks
" ")))
2276 (defun-rcirc-command dim
(nick)
2277 "Manage the dim nick list."
2278 (interactive "sToggle deemphasis of nick: ")
2279 (setq rcirc-dim-nicks
2280 (apply #'rcirc-add-or-remove rcirc-dim-nicks
2281 (split-string nick nil t
)))
2282 (rcirc-print process nil
"DIM" target
2283 (mapconcat 'identity rcirc-dim-nicks
" ")))
2285 (defun-rcirc-command keyword
(keyword)
2286 "Manage the keyword list.
2287 Mark KEYWORD, unmark KEYWORD if already marked, or list marked
2288 keywords when no KEYWORD is given."
2289 (interactive "sToggle highlighting of keyword: ")
2290 (setq rcirc-keywords
2291 (apply #'rcirc-add-or-remove rcirc-keywords
2292 (split-string keyword nil t
)))
2293 (rcirc-print process nil
"KEYWORD" target
2294 (mapconcat 'identity rcirc-keywords
" ")))
2297 (defun rcirc-add-face (start end name
&optional object
)
2298 "Add face NAME to the face text property of the text from START to END."
2303 (setq prop
(get-text-property pos
'face object
)
2304 next
(next-single-property-change pos
'face object end
))
2305 (unless (member name
(get-text-property pos
'face object
))
2306 (add-text-properties pos next
(list 'face
(cons name prop
)) object
))
2309 (defun rcirc-facify (string face
)
2310 "Return a copy of STRING with FACE property added."
2311 (let ((string (or string
"")))
2312 (rcirc-add-face 0 (length string
) face string
)
2315 (defvar rcirc-url-regexp
2317 "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
2318 "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
2319 "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
2320 (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
2321 (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
2325 ;; Match paired parentheses, e.g. in Wikipedia URLs:
2326 "[" chars punct
"]+" "(" "[" chars punct
"]+" "[" chars
"]*)" "[" chars
"]"
2328 "[" chars punct
"]+" "[" chars
"]"
2330 (concat ;; XEmacs 21.4 doesn't support POSIX.
2331 "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
2332 "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
2334 "Regexp matching URLs. Set to nil to disable URL features in rcirc.")
2336 (defun rcirc-browse-url (&optional arg
)
2337 "Prompt for URL to browse based on URLs in buffer."
2339 (let ((completions (mapcar (lambda (x) (cons x nil
)) rcirc-urls
))
2340 (initial-input (car rcirc-urls
))
2341 (history (cdr rcirc-urls
)))
2342 (browse-url (completing-read "rcirc browse-url: "
2343 completions nil nil initial-input
'history
)
2346 (defun rcirc-browse-url-at-point (point)
2347 "Send URL at point to `browse-url'."
2349 (let ((beg (previous-single-property-change (1+ point
) 'mouse-face
))
2350 (end (next-single-property-change point
'mouse-face
)))
2351 (browse-url (buffer-substring-no-properties beg end
))))
2353 (defun rcirc-browse-url-at-mouse (event)
2354 "Send URL at mouse click to `browse-url'."
2356 (let ((position (event-end event
)))
2357 (with-current-buffer (window-buffer (posn-window position
))
2358 (rcirc-browse-url-at-point (posn-point position
)))))
2361 (defun rcirc-markup-timestamp (sender response
)
2362 (goto-char (point-min))
2363 (insert (rcirc-facify (format-time-string rcirc-time-format
)
2366 (defun rcirc-markup-attributes (sender response
)
2367 (while (re-search-forward "\\([\C-b\C-_\C-v]\\).*?\\(\\1\\|\C-o\\)" nil t
)
2368 (rcirc-add-face (match-beginning 0) (match-end 0)
2369 (case (char-after (match-beginning 1))
2372 (?\C-_
'underline
)))
2373 ;; keep the ^O since it could terminate other attributes
2374 (when (not (eq ?\C-o
(char-before (match-end 2))))
2375 (delete-region (match-beginning 2) (match-end 2)))
2376 (delete-region (match-beginning 1) (match-end 1))
2377 (goto-char (match-beginning 1)))
2378 ;; remove the ^O characters now
2379 (while (re-search-forward "\C-o+" nil t
)
2380 (delete-region (match-beginning 0) (match-end 0))))
2382 (defun rcirc-markup-my-nick (sender response
)
2383 (with-syntax-table rcirc-nick-syntax-table
2384 (while (re-search-forward (concat "\\b"
2385 (regexp-quote (rcirc-nick
2386 (rcirc-buffer-process)))
2389 (rcirc-add-face (match-beginning 0) (match-end 0)
2390 'rcirc-nick-in-message
)
2391 (when (string= response
"PRIVMSG")
2392 (rcirc-add-face (point-min) (point-max)
2393 'rcirc-nick-in-message-full-line
)
2394 (rcirc-record-activity (current-buffer) 'nick
)))))
2396 (defun rcirc-markup-urls (sender response
)
2397 (while (re-search-forward rcirc-url-regexp nil t
)
2398 (let ((start (match-beginning 0))
2399 (end (match-end 0)))
2400 (rcirc-add-face start end
'rcirc-url
)
2401 (add-text-properties start end
(list 'mouse-face
'highlight
2402 'keymap rcirc-browse-url-map
))
2404 (push (buffer-substring-no-properties start end
) rcirc-urls
))))
2406 (defun rcirc-markup-keywords (sender response
)
2407 (when (and (string= response
"PRIVMSG")
2408 (not (string= sender
(rcirc-nick (rcirc-buffer-process)))))
2409 (let* ((target (or rcirc-target
""))
2410 (keywords (delq nil
(mapcar (lambda (keyword)
2411 (when (not (string-match keyword
2416 (while (re-search-forward (regexp-opt keywords
'words
) nil t
)
2417 (rcirc-add-face (match-beginning 0) (match-end 0) 'rcirc-keyword
)
2418 (rcirc-record-activity (current-buffer) 'keyword
))))))
2420 (defun rcirc-markup-bright-nicks (sender response
)
2421 (when (and rcirc-bright-nicks
2422 (string= response
"NAMES"))
2423 (with-syntax-table rcirc-nick-syntax-table
2424 (while (re-search-forward (regexp-opt rcirc-bright-nicks
'words
) nil t
)
2425 (rcirc-add-face (match-beginning 0) (match-end 0)
2426 'rcirc-bright-nick
)))))
2428 (defun rcirc-markup-fill (sender response
)
2429 (when (not (string= response
"372")) ; /motd
2431 (or rcirc-fill-prefix
2432 (make-string (- (point) (line-beginning-position)) ?\s
)))
2433 (fill-column (- (cond ((eq rcirc-fill-column
'frame-width
)
2438 ;; make sure ... doesn't cause line wrapping
2440 (fill-region (point) (point-max) nil t
))))
2443 ;; these are called with the server PROCESS, the SENDER, which is a
2444 ;; server or a user, depending on the command, the ARGS, which is a
2445 ;; list of strings, and the TEXT, which is the original server text,
2447 (defun rcirc-handler-001 (process sender args text
)
2448 (rcirc-handler-generic process
"001" sender args text
)
2449 (with-rcirc-process-buffer process
2450 (setq rcirc-connecting nil
)
2451 (rcirc-reschedule-timeout process
)
2452 (setq rcirc-server-name sender
)
2453 (setq rcirc-nick
(car args
))
2454 (rcirc-update-prompt)
2455 (if rcirc-auto-authenticate-flag
2456 (if (and rcirc-authenticate-before-join
2457 ;; We have to ensure that there's an authentication
2458 ;; entry for that server. Else,
2459 ;; rcirc-authenticated-hook won't be triggered, and
2460 ;; autojoin won't happen at all.
2461 (let (auth-required)
2462 (dolist (s rcirc-authinfo auth-required
)
2463 (when (string-match (car s
) rcirc-server-name
)
2464 (setq auth-required t
)))))
2466 (add-hook 'rcirc-authenticated-hook
'rcirc-join-channels-post-auth t t
)
2467 (rcirc-authenticate))
2468 (rcirc-authenticate)
2469 (rcirc-join-channels process rcirc-startup-channels
))
2470 (rcirc-join-channels process rcirc-startup-channels
))))
2472 (defun rcirc-join-channels-post-auth (process)
2473 "Join `rcirc-startup-channels' after authenticating."
2474 (with-rcirc-process-buffer process
2475 (rcirc-join-channels process rcirc-startup-channels
)))
2477 (defun rcirc-handler-PRIVMSG (process sender args text
)
2478 (rcirc-check-auth-status process sender args text
)
2479 (let ((target (if (rcirc-channel-p (car args
))
2482 (message (or (cadr args
) "")))
2483 (if (string-match "^\C-a\\(.*\\)\C-a$" message
)
2484 (rcirc-handler-CTCP process target sender
(match-string 1 message
))
2485 (rcirc-print process sender
"PRIVMSG" target message t
))
2486 ;; update nick linestamp
2487 (with-current-buffer (rcirc-get-buffer process target t
)
2488 (rcirc-put-nick-channel process sender target rcirc-current-line
))))
2490 (defun rcirc-handler-NOTICE (process sender args text
)
2491 (rcirc-check-auth-status process sender args text
)
2492 (let ((target (car args
))
2493 (message (cadr args
)))
2494 (if (string-match "^\C-a\\(.*\\)\C-a$" message
)
2495 (rcirc-handler-CTCP-response process target sender
2496 (match-string 1 message
))
2497 (rcirc-print process sender
"NOTICE"
2498 (cond ((rcirc-channel-p target
)
2500 ;;; -ChanServ- [#gnu] Welcome...
2501 ((string-match "\\[\\(#[^\] ]+\\)\\]" message
)
2502 (match-string 1 message
))
2504 (if (string= sender
(rcirc-server-name process
))
2509 (defun rcirc-check-auth-status (process sender args text
)
2510 "Check if the user just authenticated.
2511 If authenticated, runs `rcirc-authenticated-hook' with PROCESS as
2513 (with-rcirc-process-buffer process
2514 (when (and (not rcirc-user-authenticated
)
2515 rcirc-authenticate-before-join
2516 rcirc-auto-authenticate-flag
)
2517 (let ((target (car args
))
2518 (message (cadr args
)))
2521 (string= sender
"NickServ")
2522 (string= target rcirc-nick
)
2525 (format "You are now identified for \C-b%s\C-b." rcirc-nick
)
2526 "Password accepted - you are now recognized."
2529 (string= sender
"Q")
2530 (string= target rcirc-nick
)
2531 (string-match "\\`You are now logged in as .+\\.\\'" message
)))
2532 (setq rcirc-user-authenticated t
)
2533 (run-hook-with-args 'rcirc-authenticated-hook process
)
2534 (remove-hook 'rcirc-authenticated-hook
'rcirc-join-channels-post-auth t
))))))
2536 (defun rcirc-handler-WALLOPS (process sender args text
)
2537 (rcirc-print process sender
"WALLOPS" sender
(car args
) t
))
2539 (defun rcirc-handler-JOIN (process sender args text
)
2540 (let ((channel (car args
)))
2541 (with-current-buffer (rcirc-get-buffer-create process channel
)
2542 ;; when recently rejoining, restore the linestamp
2543 (rcirc-put-nick-channel process sender channel
2544 (let ((last-activity-lines
2545 (rcirc-elapsed-lines process sender channel
)))
2546 (when (and last-activity-lines
2547 (< last-activity-lines rcirc-omit-threshold
))
2548 (rcirc-last-line process sender channel
))))
2549 ;; reset mode-line-process in case joining a channel with an
2550 ;; already open buffer (after getting kicked e.g.)
2551 (setq mode-line-process nil
))
2553 (rcirc-print process sender
"JOIN" channel
"")
2555 ;; print in private chat buffer if it exists
2556 (when (rcirc-get-buffer (rcirc-buffer-process) sender
)
2557 (rcirc-print process sender
"JOIN" sender channel
))))
2559 ;; PART and KICK are handled the same way
2560 (defun rcirc-handler-PART-or-KICK (process response channel sender nick args
)
2561 (rcirc-ignore-update-automatic nick
)
2562 (if (not (string= nick
(rcirc-nick process
)))
2563 ;; this is someone else leaving
2565 (rcirc-maybe-remember-nick-quit process nick channel
)
2566 (rcirc-remove-nick-channel process nick channel
))
2567 ;; this is us leaving
2569 (rcirc-remove-nick-channel process n channel
))
2570 (rcirc-channel-nicks process channel
))
2572 ;; if the buffer is still around, make it inactive
2573 (let ((buffer (rcirc-get-buffer process channel
)))
2575 (rcirc-disconnect-buffer buffer
)))))
2577 (defun rcirc-handler-PART (process sender args text
)
2578 (let* ((channel (car args
))
2579 (reason (cadr args
))
2580 (message (concat channel
" " reason
)))
2581 (rcirc-print process sender
"PART" channel message
)
2582 ;; print in private chat buffer if it exists
2583 (when (rcirc-get-buffer (rcirc-buffer-process) sender
)
2584 (rcirc-print process sender
"PART" sender message
))
2586 (rcirc-handler-PART-or-KICK process
"PART" channel sender sender reason
)))
2588 (defun rcirc-handler-KICK (process sender args text
)
2589 (let* ((channel (car args
))
2591 (reason (caddr args
))
2592 (message (concat nick
" " channel
" " reason
)))
2593 (rcirc-print process sender
"KICK" channel message t
)
2594 ;; print in private chat buffer if it exists
2595 (when (rcirc-get-buffer (rcirc-buffer-process) nick
)
2596 (rcirc-print process sender
"KICK" nick message
))
2598 (rcirc-handler-PART-or-KICK process
"KICK" channel sender nick reason
)))
2600 (defun rcirc-maybe-remember-nick-quit (process nick channel
)
2601 "Remember NICK as leaving CHANNEL if they recently spoke."
2602 (let ((elapsed-lines (rcirc-elapsed-lines process nick channel
)))
2603 (when (and elapsed-lines
2604 (< elapsed-lines rcirc-omit-threshold
))
2605 (let ((buffer (rcirc-get-buffer process channel
)))
2607 (with-current-buffer buffer
2608 (let ((record (assoc-string nick rcirc-recent-quit-alist t
))
2609 (line (rcirc-last-line process nick channel
)))
2611 (setcdr record line
)
2612 (setq rcirc-recent-quit-alist
2613 (cons (cons nick line
)
2614 rcirc-recent-quit-alist
))))))))))
2616 (defun rcirc-handler-QUIT (process sender args text
)
2617 (rcirc-ignore-update-automatic sender
)
2618 (mapc (lambda (channel)
2619 ;; broadcast quit message each channel
2620 (rcirc-print process sender
"QUIT" channel
(apply 'concat args
))
2621 ;; record nick in quit table if they recently spoke
2622 (rcirc-maybe-remember-nick-quit process sender channel
))
2623 (rcirc-nick-channels process sender
))
2624 (rcirc-nick-remove process sender
))
2626 (defun rcirc-handler-NICK (process sender args text
)
2627 (let* ((old-nick sender
)
2628 (new-nick (car args
))
2629 (channels (rcirc-nick-channels process old-nick
)))
2630 ;; update list of ignored nicks
2631 (rcirc-ignore-update-automatic old-nick
)
2632 (when (member old-nick rcirc-ignore-list
)
2633 (add-to-list 'rcirc-ignore-list new-nick
)
2634 (add-to-list 'rcirc-ignore-list-automatic new-nick
))
2635 ;; print message to nick's channels
2636 (dolist (target channels
)
2637 (rcirc-print process sender
"NICK" target new-nick
))
2638 ;; update private chat buffer, if it exists
2639 (let ((chat-buffer (rcirc-get-buffer process old-nick
)))
2641 (with-current-buffer chat-buffer
2642 (rcirc-print process sender
"NICK" old-nick new-nick
)
2643 (setq rcirc-target new-nick
)
2644 (rename-buffer (rcirc-generate-new-buffer-name process new-nick
)))))
2645 ;; remove old nick and add new one
2646 (with-rcirc-process-buffer process
2647 (let ((v (gethash old-nick rcirc-nick-table
)))
2648 (remhash old-nick rcirc-nick-table
)
2649 (puthash new-nick v rcirc-nick-table
))
2650 ;; if this is our nick...
2651 (when (string= old-nick rcirc-nick
)
2652 (setq rcirc-nick new-nick
)
2653 (rcirc-update-prompt t
)
2655 (when rcirc-auto-authenticate-flag
(rcirc-authenticate))))))
2657 (defun rcirc-handler-PING (process sender args text
)
2658 (rcirc-send-string process
(concat "PONG :" (car args
))))
2660 (defun rcirc-handler-PONG (process sender args text
)
2664 (defun rcirc-handler-TOPIC (process sender args text
)
2665 (let ((topic (cadr args
)))
2666 (rcirc-print process sender
"TOPIC" (car args
) topic
)
2667 (with-current-buffer (rcirc-get-buffer process
(car args
))
2668 (setq rcirc-topic topic
))))
2670 (defvar rcirc-nick-away-alist nil
)
2671 (defun rcirc-handler-301 (process sender args text
)
2673 (let* ((nick (cadr args
))
2674 (rec (assoc-string nick rcirc-nick-away-alist
))
2675 (away-message (caddr args
)))
2677 (not (string= (cdr rec
) away-message
)))
2678 ;; away message has changed
2679 (rcirc-handler-generic process
"AWAY" nick
(cdr args
) text
)
2681 (setcdr rec away-message
)
2682 (setq rcirc-nick-away-alist
(cons (cons nick away-message
)
2683 rcirc-nick-away-alist
))))))
2685 (defun rcirc-handler-317 (process sender args text
)
2687 (let* ((nick (nth 1 args
))
2688 (idle-secs (string-to-number (nth 2 args
)))
2690 (if (< idle-secs most-positive-fixnum
)
2691 (format-seconds "%yy %dd %hh %mm %z%ss" idle-secs
)
2692 "a very long time"))
2693 (signon-time (seconds-to-time (string-to-number (nth 3 args
))))
2694 (signon-string (format-time-string "%c" signon-time
))
2695 (message (format "%s idle for %s, signed on %s"
2696 nick idle-string signon-string
)))
2697 (rcirc-print process sender
"317" nil message t
)))
2699 (defun rcirc-handler-332 (process sender args text
)
2701 (let ((buffer (or (rcirc-get-buffer process
(cadr args
))
2702 (rcirc-get-temp-buffer-create process
(cadr args
)))))
2703 (with-current-buffer buffer
2704 (setq rcirc-topic
(caddr args
)))))
2706 (defun rcirc-handler-333 (process sender args text
)
2707 "Not in rfc1459.txt"
2708 (let ((buffer (or (rcirc-get-buffer process
(cadr args
))
2709 (rcirc-get-temp-buffer-create process
(cadr args
)))))
2710 (with-current-buffer buffer
2711 (let ((setter (caddr args
))
2712 (time (current-time-string
2714 (string-to-number (cadddr args
))))))
2715 (rcirc-print process sender
"TOPIC" (cadr args
)
2716 (format "%s (%s on %s)" rcirc-topic setter time
))))))
2718 (defun rcirc-handler-477 (process sender args text
)
2720 (rcirc-print process sender
"477" (cadr args
) (caddr args
)))
2722 (defun rcirc-handler-MODE (process sender args text
)
2723 (let ((target (car args
))
2724 (msg (mapconcat 'identity
(cdr args
) " ")))
2725 (rcirc-print process sender
"MODE"
2726 (if (string= target
(rcirc-nick process
))
2731 ;; print in private chat buffers if they exist
2732 (mapc (lambda (nick)
2733 (when (rcirc-get-buffer process nick
)
2734 (rcirc-print process sender
"MODE" nick msg
)))
2737 (defun rcirc-get-temp-buffer-create (process channel
)
2738 "Return a buffer based on PROCESS and CHANNEL."
2739 (let ((tmpnam (concat " " (downcase channel
) "TMP" (process-name process
))))
2740 (get-buffer-create tmpnam
)))
2742 (defun rcirc-handler-353 (process sender args text
)
2744 (let ((channel (nth 2 args
))
2745 (names (or (nth 3 args
) "")))
2746 (mapc (lambda (nick)
2747 (rcirc-put-nick-channel process nick channel
))
2748 (split-string names
" " t
))
2749 ;; create a temporary buffer to insert the names into
2750 ;; rcirc-handler-366 (RPL_ENDOFNAMES) will handle it
2751 (with-current-buffer (rcirc-get-temp-buffer-create process channel
)
2752 (goto-char (point-max))
2753 (insert (car (last args
)) " "))))
2755 (defun rcirc-handler-366 (process sender args text
)
2757 (let* ((channel (cadr args
))
2758 (buffer (rcirc-get-temp-buffer-create process channel
)))
2759 (with-current-buffer buffer
2760 (rcirc-print process sender
"NAMES" channel
2761 (let ((content (buffer-substring (point-min) (point-max))))
2762 (rcirc-sort-nicknames-join content
" "))))
2763 (kill-buffer buffer
)))
2765 (defun rcirc-handler-433 (process sender args text
)
2767 (rcirc-handler-generic process
"433" sender args text
)
2768 (let* ((new-nick (concat (cadr args
) "`")))
2769 (with-rcirc-process-buffer process
2770 (rcirc-cmd-nick new-nick nil process
))))
2772 (defun rcirc-authenticate ()
2773 "Send authentication to process associated with current buffer.
2774 Passwords are stored in `rcirc-authinfo' (which see)."
2776 (with-rcirc-server-buffer
2777 (dolist (i rcirc-authinfo
)
2778 (let ((process (rcirc-buffer-process))
2783 (when (and (string-match server rcirc-server
))
2784 (if (and (memq method
'(nickserv chanserv bitlbee
))
2785 (string-match nick rcirc-nick
))
2786 ;; the following methods rely on the user's nickname.
2791 (or (cadr args
) "NickServ")
2792 (concat "IDENTIFY " (car args
))))
2797 (format "IDENTIFY %s %s" (car args
) (cadr args
))))
2802 (concat "IDENTIFY " (car args
)))))
2803 ;; quakenet authentication doesn't rely on the user's nickname.
2804 ;; the variable `nick' here represents the Q account name.
2805 (when (eq method
'quakenet
)
2808 "Q@CServe.quakenet.org"
2809 (format "AUTH %s %s" nick
(car args
))))))))))
2811 (defun rcirc-handler-INVITE (process sender args text
)
2812 (rcirc-print process sender
"INVITE" nil
(mapconcat 'identity args
" ") t
))
2814 (defun rcirc-handler-ERROR (process sender args text
)
2815 (rcirc-print process sender
"ERROR" nil
(mapconcat 'identity args
" ")))
2817 (defun rcirc-handler-CTCP (process target sender text
)
2818 (if (string-match "^\\([^ ]+\\) *\\(.*\\)$" text
)
2819 (let* ((request (upcase (match-string 1 text
)))
2820 (args (match-string 2 text
))
2821 (handler (intern-soft (concat "rcirc-handler-ctcp-" request
))))
2822 (if (not (fboundp handler
))
2823 (rcirc-print process sender
"ERROR" target
2824 (format "%s sent unsupported ctcp: %s" sender text
)
2826 (funcall handler process target sender args
)
2827 (unless (or (string= request
"ACTION")
2828 (string= request
"KEEPALIVE"))
2829 (rcirc-print process sender
"CTCP" target
2830 (format "%s" text
) t
))))))
2832 (defun rcirc-handler-ctcp-VERSION (process target sender args
)
2833 (rcirc-send-string process
2834 (concat "NOTICE " sender
2835 " :\C-aVERSION " rcirc-id-string
2838 (defun rcirc-handler-ctcp-ACTION (process target sender args
)
2839 (rcirc-print process sender
"ACTION" target args t
))
2841 (defun rcirc-handler-ctcp-TIME (process target sender args
)
2842 (rcirc-send-string process
2843 (concat "NOTICE " sender
2844 " :\C-aTIME " (current-time-string) "\C-a")))
2846 (defun rcirc-handler-CTCP-response (process target sender message
)
2847 (rcirc-print process sender
"CTCP" nil message t
))
2849 (defgroup rcirc-faces nil
2854 (defface rcirc-my-nick
; font-lock-function-name-face
2855 '((((class color
) (min-colors 88) (background light
)) (:foreground
"Blue1"))
2856 (((class color
) (min-colors 88) (background dark
)) (:foreground
"LightSkyBlue"))
2857 (((class color
) (min-colors 16) (background light
)) (:foreground
"Blue"))
2858 (((class color
) (min-colors 16) (background dark
)) (:foreground
"LightSkyBlue"))
2859 (((class color
) (min-colors 8)) (:foreground
"blue" :weight bold
))
2860 (t (:inverse-video t
:weight bold
)))
2861 "The face used to highlight my messages."
2862 :group
'rcirc-faces
)
2864 (defface rcirc-other-nick
; font-lock-variable-name-face
2865 '((((class grayscale
) (background light
))
2866 (:foreground
"Gray90" :weight bold
:slant italic
))
2867 (((class grayscale
) (background dark
))
2868 (:foreground
"DimGray" :weight bold
:slant italic
))
2869 (((class color
) (min-colors 88) (background light
)) (:foreground
"DarkGoldenrod"))
2870 (((class color
) (min-colors 88) (background dark
)) (:foreground
"LightGoldenrod"))
2871 (((class color
) (min-colors 16) (background light
)) (:foreground
"DarkGoldenrod"))
2872 (((class color
) (min-colors 16) (background dark
)) (:foreground
"LightGoldenrod"))
2873 (((class color
) (min-colors 8)) (:foreground
"yellow" :weight light
))
2874 (t (:weight bold
:slant italic
)))
2875 "The face used to highlight other messages."
2876 :group
'rcirc-faces
)
2878 (defface rcirc-bright-nick
2879 '((((class grayscale
) (background light
))
2880 (:foreground
"LightGray" :weight bold
:underline t
))
2881 (((class grayscale
) (background dark
))
2882 (:foreground
"Gray50" :weight bold
:underline t
))
2883 (((class color
) (min-colors 88) (background light
)) (:foreground
"CadetBlue"))
2884 (((class color
) (min-colors 88) (background dark
)) (:foreground
"Aquamarine"))
2885 (((class color
) (min-colors 16) (background light
)) (:foreground
"CadetBlue"))
2886 (((class color
) (min-colors 16) (background dark
)) (:foreground
"Aquamarine"))
2887 (((class color
) (min-colors 8)) (:foreground
"magenta"))
2888 (t (:weight bold
:underline t
)))
2889 "Face used for nicks matched by `rcirc-bright-nicks'."
2890 :group
'rcirc-faces
)
2892 (defface rcirc-dim-nick
2893 '((t :inherit default
))
2894 "Face used for nicks in `rcirc-dim-nicks'."
2895 :group
'rcirc-faces
)
2897 (defface rcirc-server
; font-lock-comment-face
2898 '((((class grayscale
) (background light
))
2899 (:foreground
"DimGray" :weight bold
:slant italic
))
2900 (((class grayscale
) (background dark
))
2901 (:foreground
"LightGray" :weight bold
:slant italic
))
2902 (((class color
) (min-colors 88) (background light
))
2903 (:foreground
"Firebrick"))
2904 (((class color
) (min-colors 88) (background dark
))
2905 (:foreground
"chocolate1"))
2906 (((class color
) (min-colors 16) (background light
))
2907 (:foreground
"red"))
2908 (((class color
) (min-colors 16) (background dark
))
2909 (:foreground
"red1"))
2910 (((class color
) (min-colors 8) (background light
))
2912 (((class color
) (min-colors 8) (background dark
))
2914 (t (:weight bold
:slant italic
)))
2915 "The face used to highlight server messages."
2916 :group
'rcirc-faces
)
2918 (defface rcirc-server-prefix
; font-lock-comment-delimiter-face
2919 '((default :inherit rcirc-server
)
2920 (((class grayscale
)))
2921 (((class color
) (min-colors 16)))
2922 (((class color
) (min-colors 8) (background light
))
2924 (((class color
) (min-colors 8) (background dark
))
2925 :foreground
"red1"))
2926 "The face used to highlight server prefixes."
2927 :group
'rcirc-faces
)
2929 (defface rcirc-timestamp
2930 '((t (:inherit default
)))
2931 "The face used to highlight timestamps."
2932 :group
'rcirc-faces
)
2934 (defface rcirc-nick-in-message
; font-lock-keyword-face
2935 '((((class grayscale
) (background light
)) (:foreground
"LightGray" :weight bold
))
2936 (((class grayscale
) (background dark
)) (:foreground
"DimGray" :weight bold
))
2937 (((class color
) (min-colors 88) (background light
)) (:foreground
"Purple"))
2938 (((class color
) (min-colors 88) (background dark
)) (:foreground
"Cyan1"))
2939 (((class color
) (min-colors 16) (background light
)) (:foreground
"Purple"))
2940 (((class color
) (min-colors 16) (background dark
)) (:foreground
"Cyan"))
2941 (((class color
) (min-colors 8)) (:foreground
"cyan" :weight bold
))
2943 "The face used to highlight instances of your nick within messages."
2944 :group
'rcirc-faces
)
2946 (defface rcirc-nick-in-message-full-line
2948 "The face used emphasize the entire message when your nick is mentioned."
2949 :group
'rcirc-faces
)
2951 (defface rcirc-prompt
; comint-highlight-prompt
2952 '((((min-colors 88) (background dark
)) (:foreground
"cyan1"))
2953 (((background dark
)) (:foreground
"cyan"))
2954 (t (:foreground
"dark blue")))
2955 "The face used to highlight prompts."
2956 :group
'rcirc-faces
)
2958 (defface rcirc-track-nick
2959 '((((type tty
)) (:inherit default
))
2960 (t (:inverse-video t
)))
2961 "The face used in the mode-line when your nick is mentioned."
2962 :group
'rcirc-faces
)
2964 (defface rcirc-track-keyword
2966 "The face used in the mode-line when keywords are mentioned."
2967 :group
'rcirc-faces
)
2971 "The face used to highlight urls."
2972 :group
'rcirc-faces
)
2974 (defface rcirc-keyword
2975 '((t (:inherit highlight
)))
2976 "The face used to highlight keywords."
2977 :group
'rcirc-faces
)
2980 ;; When using M-x flyspell-mode, only check words after the prompt
2981 (put 'rcirc-mode
'flyspell-mode-predicate
'rcirc-looking-at-input
)
2982 (defun rcirc-looking-at-input ()
2983 "Returns true if point is past the input marker."
2984 (>= (point) rcirc-prompt-end-marker
))
2989 ;;; rcirc.el ends here
