rcirc.el 83.1 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; rcirc.el --- default, simple IRC client.

3
;; Copyright (C) 2005, 2006 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5 6 7 8

;; Author: Ryan Yeske
;; URL: http://www.nongnu.org/rcirc
;; Keywords: comm

9
;; This file is part of GNU Emacs.
Richard M. Stallman's avatar
Richard M. Stallman committed
10 11 12 13 14 15 16 17 18 19 20 21

;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25 26 27

;;; Commentary:

28 29 30 31 32 33 34 35 36 37 38
;; Internet Relay Chat (IRC) is a form of instant communication over
;; the Internet. It is mainly designed for group (many-to-many)
;; communication in discussion forums called channels, but also allows
;; one-to-one communication.

;; Rcirc has simple defaults and clear and consistent behaviour.
;; Message arrival timestamps, activity notification on the modeline,
;; message filling, nick completion, and keepalive pings are all
;; enabled by default, but can easily be adjusted or turned off.  Each
;; discussion takes place in its own buffer and there is a single
;; server buffer per connection.
Richard M. Stallman's avatar
Richard M. Stallman committed
39 40 41 42 43 44 45 46 47 48

;; Open a new irc connection with:
;; M-x irc RET

;;; Code:

(require 'ring)
(require 'time-date)
(eval-when-compile (require 'cl))

49 50 51
(defgroup rcirc nil
  "Simple IRC client."
  :version "22.1"
52
  :prefix "rcirc-"
53
  :link '(custom-manual "(rcirc)")
54 55
  :group 'applications)

56
(defcustom rcirc-default-server "irc.freenode.net"
57 58 59
  "The default server to connect to."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
60

61
(defcustom rcirc-default-port 6667
62 63 64
  "The default port to connect to."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
65

66
(defcustom rcirc-default-nick (user-login-name)
67 68 69
  "Your nick."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
70

71
(defcustom rcirc-default-user-name (user-login-name)
72 73 74
  "Your user name sent to the server when connecting."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
75

76
(defcustom rcirc-default-user-full-name (if (string= (user-full-name) "")
77 78
					    rcirc-user-name
					  (user-full-name))
79 80 81
  "The full name sent to the server when connecting."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
82

83
(defcustom rcirc-startup-channels-alist '(("^irc.freenode.net$" "#rcirc"))
Richard M. Stallman's avatar
Richard M. Stallman committed
84
  "Alist of channels to join at startup.
85 86 87
Each element looks like (SERVER-REGEXP . CHANNEL-LIST)."
  :type '(alist :key-type string :value-type (repeat string))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
88

89 90 91 92
(defcustom rcirc-fill-flag t
  "*Non-nil means line-wrap messages printed in channel buffers."
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
93

94 95
(defcustom rcirc-fill-column nil
  "*Column beyond which automatic line-wrapping should happen.
96
If nil, use value of `fill-column'.  If 'frame-width, use the
97 98 99 100 101
maximum frame width."
  :type '(choice (const :tag "Value of `fill-column'")
		 (const :tag "Full frame width" frame-width)
		 (integer :tag "Number of columns"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
102

103
(defcustom rcirc-fill-prefix nil
Richard M. Stallman's avatar
Richard M. Stallman committed
104 105
  "*Text to insert before filled lines.
If nil, calculate the prefix dynamically to line up text
106 107 108 109
underneath each nick."
  :type '(choice (const :tag "Dynamic" nil)
		 (string :tag "Prefix text"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
110

111 112 113
(defvar rcirc-ignore-buffer-activity-flag nil
  "If non-nil, ignore activity in this buffer.")
(make-variable-buffer-local 'rcirc-ignore-buffer-activity-flag)
Richard M. Stallman's avatar
Richard M. Stallman committed
114

115 116 117 118
(defvar rcirc-low-priority-flag nil
  "If non-nil, activity in this buffer is considered low priority.")
(make-variable-buffer-local 'rcirc-low-priority-flag)

119
(defcustom rcirc-time-format "%H:%M "
Richard M. Stallman's avatar
Richard M. Stallman committed
120
  "*Describes how timestamps are printed.
121 122 123
Used as the first arg to `format-time-string'."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
124

125 126 127 128
(defcustom rcirc-input-ring-size 1024
  "*Size of input history ring."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
129

130
(defcustom rcirc-read-only-flag t
131
  "*Non-nil means make text in IRC buffers read-only."
132 133
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
134

135
(defcustom rcirc-buffer-maximum-lines nil
Richard M. Stallman's avatar
Richard M. Stallman committed
136 137
  "*The maximum size in lines for rcirc buffers.
Channel buffers are truncated from the top to be no greater than this
138 139 140 141
number.	 If zero or nil, no truncating is done."
  :type '(choice (const :tag "No truncation" nil)
		 (integer :tag "Number of lines"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
142

143 144 145 146 147 148 149
(defcustom rcirc-authinfo nil
  "List of authentication passwords.
Each element of the list is a list with a SERVER-REGEXP string
and a method symbol followed by method specific arguments.

The valid METHOD symbols are `nickserv', `chanserv' and
`bitlbee'.
Richard M. Stallman's avatar
Richard M. Stallman committed
150 151

The required ARGUMENTS for each METHOD symbol are:
152 153 154
  `nickserv': NICK PASSWORD
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
155 156

Example:
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
 ((\"freenode\" nickserv \"bob\" \"p455w0rd\")
  (\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
  (\"bitlbee\" bitlbee \"robert\" \"sekrit\"))"
  :type '(alist :key-type (string :tag "Server")
		:value-type (choice (list :tag "NickServ"
					  (const nickserv)
					  (string :tag "Nick")
					  (string :tag "Password"))
				    (list :tag "ChanServ"
					  (const chanserv)
					  (string :tag "Nick")
					  (string :tag "Channel")
					  (string :tag "Password"))
				    (list :tag "BitlBee"
					  (const bitlbee)
					  (string :tag "Nick")
					  (string :tag "Password"))))
174
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
175

176
(defcustom rcirc-auto-authenticate-flag t
Richard M. Stallman's avatar
Richard M. Stallman committed
177
  "*Non-nil means automatically send authentication string to server.
178
See also `rcirc-authinfo'."
179 180
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
181

182
(defcustom rcirc-prompt "> "
183
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
184 185 186 187 188 189

The following replacements are made:
%n is your nick.
%s is the server.
%t is the buffer target, a channel or a user.

190 191 192 193 194 195 196
Setting this alone will not affect the prompt;
use either M-x customize or also call `rcirc-update-prompt'."
  :type 'string
  :set 'rcirc-set-changed
  :initialize 'custom-initialize-default
  :group 'rcirc)

197 198 199 200 201 202 203 204 205 206 207 208
(defcustom rcirc-ignore-list ()
  "List of ignored nicks.
Use /ignore to list them, use /ignore NICK to add or remove a nick."
  :type '(repeat string)
  :group 'rcirc)

(defvar rcirc-ignore-list-automatic ()
  "List of ignored nicks added to `rcirc-ignore-list' because of renaming.
When an ignored person renames, their nick is added to both lists.
Nicks will be removed from the automatic list on follow-up renamings or
parts.")

209 210 211 212 213 214 215 216 217 218 219 220
(defcustom rcirc-bright-nick-regexp nil
  "Regexp matching nicks to be emphasized.
See `rcirc-bright-nick' face."
  :type 'regexp
  :group 'rcirc)

(defcustom rcirc-dim-nick-regexp nil
  "Regexp matching nicks to be deemphasized.
See `rcirc-dim-nick' face."
  :type 'regexp
  :group 'rcirc)

221 222 223 224 225
(defcustom rcirc-print-hooks nil
  "Hook run after text is printed.
Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT."
  :type 'hook
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
226

227 228 229 230 231
(defcustom rcirc-always-use-server-buffer-flag nil
  "Non-nil means messages without a channel target will go to the server buffer."
  :type 'boolean
  :group 'rcirc)

232
(defcustom rcirc-decode-coding-system 'utf-8
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
  "Coding system used to decode incoming irc messages."
  :type 'coding-system
  :group 'rcirc)

(defcustom rcirc-encode-coding-system 'utf-8
  "Coding system used to encode outgoing irc messages."
  :type 'coding-system
  :group 'rcirc)

(defcustom rcirc-coding-system-alist nil
  "Alist to decide a coding system to use for a file I/O operation.
The format is ((PATTERN . VAL) ...).
PATTERN is either a string or a cons of strings.
If PATTERN is a string, it is used to match a target.
If PATTERN is a cons of strings, the car part is used to match a
target, and the cdr part is used to match a server.
VAL is either a coding system or a cons of coding systems.
If VAL is a coding system, it is used for both decoding and encoding
messages.
If VAL is a cons of coding systems, the car part is used for decoding,
and the cdr part is used for encoding."
  :type '(alist :key-type (choice (string :tag "Channel Regexp")
					  (cons (string :tag "Channel Regexp")
						(string :tag "Server Regexp")))
		:value-type (choice coding-system
				    (cons (coding-system :tag "Decode")
					  (coding-system :tag "Encode"))))
  :group 'rcirc)

(defcustom rcirc-multiline-major-mode 'fundamental-mode
  "Major-mode function to use in multiline edit buffers."
  :type 'function
  :group 'rcirc)

(defvar rcirc-nick nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
269 270 271 272 273
(defvar rcirc-prompt-start-marker nil)
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

274 275 276 277 278 279 280 281
(defvar rcirc-nick-syntax-table
  (let ((table (make-syntax-table text-mode-syntax-table)))
    (mapc (lambda (c) (modify-syntax-entry c "w" table))
          "[]\\`_^{|}-")
    (modify-syntax-entry ?' "_" table)
    table)
  "Syntax table which includes all nick characters as word constituents.")

282 283 284
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
285
(defvar rcirc-activity nil
286
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
287 288 289 290 291

(defvar rcirc-activity-string ""
  "String displayed in modeline representing `rcirc-activity'.")
(put 'rcirc-activity-string 'risky-local-variable t)

292 293
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
294 295 296 297 298 299 300 301

(defvar rcirc-target nil
  "The channel or user associated with this buffer.")

(defvar rcirc-urls nil
  "List of urls seen in the current buffer.")

(defvar rcirc-keepalive-seconds 60
302 303
  "Number of seconds between keepalive pings.
If nil, do not send keepalive pings.")
Richard M. Stallman's avatar
Richard M. Stallman committed
304

305
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
306 307 308

(defvar rcirc-startup-channels nil)
;;;###autoload
309
(defun rcirc (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
310
  "Connect to IRC.
311 312 313
If ARG is non-nil, prompt for a server to connect to."
  (interactive "P")
  (if arg
314 315 316
      (let* ((server (read-string "IRC Server: " rcirc-default-server))
	     (port (read-string "IRC Port: " (number-to-string rcirc-default-port)))
	     (nick (read-string "IRC Nick: " rcirc-default-nick))
317 318
	     (channels (split-string
			(read-string "IRC Channels: "
319
				     (mapconcat 'identity (rcirc-startup-channels server) " "))
320
			"[, ]+" t)))
321
	(rcirc-connect server port nick rcirc-default-user-name rcirc-default-user-full-name
322 323 324
		       channels))
    ;; make new connection using defaults unless already connected to
    ;; the default rcirc-server
325
    (let (connected)
326
      (dolist (p (rcirc-process-list))
327
	(when (string= rcirc-default-server (process-name p))
328 329
	  (setq connected p)))
      (if (not connected)
330 331 332 333
	  (rcirc-connect rcirc-default-server rcirc-default-port 
			 rcirc-default-nick rcirc-default-user-name
			 rcirc-default-user-full-name
			 (rcirc-startup-channels rcirc-default-server))
334
	(switch-to-buffer (process-buffer connected))
335 336 337
	(message "Connected to %s" 
		 (process-contact (get-buffer-process (current-buffer))
				  :host))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
338 339 340 341 342 343 344
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
345
(defvar rcirc-last-server-message-time nil)
346
(defvar rcirc-server nil)
347 348

;;;###autoload
349
(defun rcirc-connect (&optional server port nick user-name full-name startup-channels)
Richard M. Stallman's avatar
Richard M. Stallman committed
350 351 352
  (save-excursion
    (message "Connecting to %s..." server)
    (let* ((inhibit-eol-conversion)
353 354 355 356
           (port-number (if port
			    (if (stringp port)
				(string-to-number port)
			      port)
357 358 359 360 361 362
			  rcirc-default-port))
	   (server (or server rcirc-default-server))
	   (nick (or nick rcirc-default-nick))
	   (user-name (or user-name rcirc-default-user-name))
	   (full-name (or full-name rcirc-default-user-full-name))
	   (startup-channels startup-channels)
Richard M. Stallman's avatar
Richard M. Stallman committed
363 364 365
           (process (open-network-stream server nil server port-number)))
      ;; set up process
      (set-process-coding-system process 'raw-text 'raw-text)
366
      (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
367 368
      (set-process-buffer process (current-buffer))
      (rcirc-mode process nil)
369 370 371 372
      (set-process-sentinel process 'rcirc-sentinel)
      (set-process-filter process 'rcirc-filter)
      (make-local-variable 'rcirc-server)
      (setq rcirc-server server)
373 374
      (make-local-variable 'rcirc-buffer-alist)
      (setq rcirc-buffer-alist nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376 377 378 379 380 381 382
      (make-local-variable 'rcirc-nick-table)
      (setq rcirc-nick-table (make-hash-table :test 'equal))
      (make-local-variable 'rcirc-nick)
      (setq rcirc-nick nick)
      (make-local-variable 'rcirc-process-output)
      (setq rcirc-process-output nil)
      (make-local-variable 'rcirc-startup-channels)
      (setq rcirc-startup-channels startup-channels)
383 384
      (make-local-variable 'rcirc-last-server-message-time)
      (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
385 386 387 388 389 390 391 392

      ;; identify
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
                                      " hostname servername :"
                                      full-name))

      ;; setup ping timer if necessary
393 394 395 396
      (when rcirc-keepalive-seconds
	(unless rcirc-keepalive-timer
	  (setq rcirc-keepalive-timer
		(run-at-time 0 rcirc-keepalive-seconds 'rcirc-keepalive))))
Richard M. Stallman's avatar
Richard M. Stallman committed
397 398 399 400 401 402

      (message "Connecting to %s...done" server)

      ;; return process object
      process)))

403 404 405 406 407
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

408 409 410 411 412
(defmacro with-rcirc-server-buffer (&rest body)
  (declare (indent 0) (debug t))
  `(with-current-buffer rcirc-server-buffer
     ,@body))

Richard M. Stallman's avatar
Richard M. Stallman committed
413
(defun rcirc-keepalive ()
414 415 416
  "Send keep alive pings to active rcirc processes.
Kill processes that have not received a server message since the
last ping."
Richard M. Stallman's avatar
Richard M. Stallman committed
417 418
  (if (rcirc-process-list)
      (mapc (lambda (process)
419
              (with-rcirc-process-buffer process
420 421 422 423
		(if (> (cadr (time-since rcirc-last-server-message-time))
		       rcirc-keepalive-seconds)
		    (kill-process process)
		  (rcirc-send-string process (concat "PING " rcirc-server)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
424 425 426 427
            (rcirc-process-list))
    (cancel-timer rcirc-keepalive-timer)
    (setq rcirc-keepalive-timer nil)))

428 429 430 431
(defvar rcirc-debug-buffer " *rcirc debug*")
(defvar rcirc-debug-flag nil
  "If non-nil, write information to `rcirc-debug-buffer'.")
(defun rcirc-debug (process text)
Richard M. Stallman's avatar
Richard M. Stallman committed
432
  "Add an entry to the debug log including PROCESS and TEXT.
433
Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
434 435
is non-nil."
  (when rcirc-debug-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
436 437
    (save-excursion
      (save-window-excursion
438
        (set-buffer (get-buffer-create rcirc-debug-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
439 440 441 442 443 444
        (goto-char (point-max))
        (insert (concat
                 "["
                 (format-time-string "%Y-%m-%dT%T ") (process-name process)
                 "] "
                 text))))))
445

Richard M. Stallman's avatar
Richard M. Stallman committed
446 447 448 449 450 451 452
(defvar rcirc-sentinel-hooks nil
  "Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")

(defun rcirc-sentinel (process sentinel)
  "Called when PROCESS receives SENTINEL."
  (let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
453 454 455 456
    (rcirc-debug process (format "SENTINEL: %S %S\n" process sentinel))
    (with-rcirc-process-buffer process
      (dolist (buffer (cons nil (mapcar 'cdr rcirc-buffer-alist)))
	(with-current-buffer (or buffer (current-buffer))
457 458 459 460 461 462
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
			       (process-status process)) t)
	  ;; remove the prompt from buffers
Richard M. Stallman's avatar
Richard M. Stallman committed
463 464 465 466 467 468 469 470 471 472
	  (let ((inhibit-read-only t))
	    (delete-region rcirc-prompt-start-marker
			   rcirc-prompt-end-marker)))))
    (run-hook-with-args 'rcirc-sentinel-hooks process sentinel)))

(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
            (when (process-buffer p)
473
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
474 475 476 477 478 479
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

(defvar rcirc-receive-message-hooks nil
480 481
  "Hook functions run when a message is received from server.
Function is called with PROCESS, COMMAND, SENDER, ARGS and LINE.")
Richard M. Stallman's avatar
Richard M. Stallman committed
482 483
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
484 485
  (rcirc-debug process output)
  (with-rcirc-process-buffer process
486
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
487 488 489 490 491
    (setq rcirc-process-output (concat rcirc-process-output output))
    (when (= (aref rcirc-process-output
                   (1- (length rcirc-process-output))) ?\n)
      (mapc (lambda (line)
              (rcirc-process-server-response process line))
492
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
493 494
      (setq rcirc-process-output nil))))

495
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
496
(defun rcirc-process-server-response (process text)
497
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
498 499 500 501
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
502
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
503 504 505 506
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
507 508
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
509 510 511 512 513 514
             (cmd (match-string 3 text))
             (args (match-string 4 text))
             (handler (intern-soft (concat "rcirc-handler-" cmd))))
        (string-match "^\\([^:]*\\):?\\(.+\\)?$" args)
        (let* ((args1 (match-string 1 args))
               (args2 (match-string 2 args))
515 516
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
517 518 519 520 521 522 523 524 525 526
        (if (not (fboundp handler))
            (rcirc-handler-generic process cmd sender args text)
          (funcall handler process sender args text))
        (run-hook-with-args 'rcirc-receive-message-hooks
                            process cmd sender args text)))
    (message "UNHANDLED: %s" text)))

(defun rcirc-handler-generic (process command sender args text)
  "Generic server response handler."
  (rcirc-print process sender command nil
527
               (mapconcat 'identity (cdr args) " ") t))
Richard M. Stallman's avatar
Richard M. Stallman committed
528 529 530

(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
531
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
532
                        "\n")))
533
    (unless (eq (process-status process) 'open)
534
      (error "Network connection to %s is not open"
535
             (process-name process)))
536
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
537 538
    (process-send-string process string)))

539 540 541 542 543 544 545
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
  (get-buffer-process (or buffer rcirc-server-buffer)))

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
546
  (with-rcirc-process-buffer process
547
    (or rcirc-server rcirc-default-server)))
Richard M. Stallman's avatar
Richard M. Stallman committed
548 549 550

(defun rcirc-nick (process)
  "Return PROCESS nick."
551 552 553 554 555 556 557 558 559
  (with-rcirc-process-buffer process 
    (or rcirc-nick rcirc-default-nick)))

(defun rcirc-buffer-nick (&optional buffer)
  "Return the nick associated with BUFFER.
With no argument or nil as argument, use the current buffer."
  (with-current-buffer (or buffer (current-buffer))
    (with-current-buffer rcirc-server-buffer
      (or rcirc-nick rcirc-default-nick))))
Richard M. Stallman's avatar
Richard M. Stallman committed
560

561
(defvar rcirc-max-message-length 420
Richard M. Stallman's avatar
Richard M. Stallman committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
  "Messages longer than this value will be split.")

(defun rcirc-send-message (process target message &optional noticep)
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
If NOTICEP is non-nil, send a notice instead of privmsg."
  ;; max message length is 512 including CRLF
  (let* ((response (if noticep "NOTICE" "PRIVMSG"))
         (oversize (> (length message) rcirc-max-message-length))
         (text (if oversize
                   (substring message 0 rcirc-max-message-length)
                 message))
         (text (if (string= text "")
                   " "
                 text))
         (more (if oversize
                   (substring message rcirc-max-message-length))))
578 579
    (rcirc-get-buffer-create process target)
    (rcirc-print process (rcirc-nick process) response target text)
Richard M. Stallman's avatar
Richard M. Stallman committed
580
    (rcirc-send-string process (concat response " " target " :" text))
581
    (when more (rcirc-send-message process target more noticep))))
Richard M. Stallman's avatar
Richard M. Stallman committed
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618

(defvar rcirc-input-ring nil)
(defvar rcirc-input-ring-index 0)
(defun rcirc-prev-input-string (arg)
  (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))

(defun rcirc-insert-prev-input (arg)
  (interactive "p")
  (when (<= rcirc-prompt-end-marker (point))
    (delete-region rcirc-prompt-end-marker (point-max))
    (insert (rcirc-prev-input-string 0))
    (setq rcirc-input-ring-index (1+ rcirc-input-ring-index))))

(defun rcirc-insert-next-input (arg)
  (interactive "p")
  (when (<= rcirc-prompt-end-marker (point))
    (delete-region rcirc-prompt-end-marker (point-max))
    (setq rcirc-input-ring-index (1- rcirc-input-ring-index))
    (insert (rcirc-prev-input-string -1))))

(defvar rcirc-nick-completions nil)
(defvar rcirc-nick-completion-start-offset nil)
(defun rcirc-complete-nick ()
  "Cycle through nick completions from list of nicks in channel."
  (interactive)
  (if (eq last-command 'rcirc-complete-nick)
      (setq rcirc-nick-completions
            (append (cdr rcirc-nick-completions)
                    (list (car rcirc-nick-completions))))
    (setq rcirc-nick-completion-start-offset
          (- (save-excursion
               (if (re-search-backward " " rcirc-prompt-end-marker t)
                   (1+ (point))
                 rcirc-prompt-end-marker))
             rcirc-prompt-end-marker))
    (setq rcirc-nick-completions
          (let ((completion-ignore-case t))
619 620
            (all-completions
	     (buffer-substring
Richard M. Stallman's avatar
Richard M. Stallman committed
621 622 623 624
	      (+ rcirc-prompt-end-marker
		 rcirc-nick-completion-start-offset)
	      (point))
	     (mapcar (lambda (x) (cons x nil))
625 626
		     (rcirc-channel-nicks (rcirc-buffer-process)
					  rcirc-target))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
627 628
  (let ((completion (car rcirc-nick-completions)))
    (when completion
629
      (delete-region (+ rcirc-prompt-end-marker
Richard M. Stallman's avatar
Richard M. Stallman committed
630 631 632
                        rcirc-nick-completion-start-offset)
                     (point))
      (insert (concat completion
633
                      (if (= (+ rcirc-prompt-end-marker
Richard M. Stallman's avatar
Richard M. Stallman committed
634 635 636 637
                                rcirc-nick-completion-start-offset)
                             rcirc-prompt-end-marker)
                          ": "))))))

638 639 640 641 642 643 644 645 646
(defun set-rcirc-decode-coding-system (coding-system)
  "Set the decode coding system used in this channel."
  (interactive "zCoding system for incoming messages: ")
  (setq rcirc-decode-coding-system coding-system))

(defun set-rcirc-encode-coding-system (coding-system)
  "Set the encode coding system used in this channel."
  (interactive "zCoding system for outgoing messages: ")
  (setq rcirc-encode-coding-system coding-system))
Richard M. Stallman's avatar
Richard M. Stallman committed
647 648 649 650 651 652 653 654 655 656 657 658

(defvar rcirc-mode-map (make-sparse-keymap)
  "Keymap for rcirc mode.")

(define-key rcirc-mode-map (kbd "RET") 'rcirc-send-input)
(define-key rcirc-mode-map (kbd "M-p") 'rcirc-insert-prev-input)
(define-key rcirc-mode-map (kbd "M-n") 'rcirc-insert-next-input)
(define-key rcirc-mode-map (kbd "TAB") 'rcirc-complete-nick)
(define-key rcirc-mode-map (kbd "C-c C-b") 'rcirc-browse-url)
(define-key rcirc-mode-map (kbd "C-c C-c") 'rcirc-edit-multiline)
(define-key rcirc-mode-map (kbd "C-c C-j") 'rcirc-cmd-join)
(define-key rcirc-mode-map (kbd "C-c C-k") 'rcirc-cmd-kick)
659
(define-key rcirc-mode-map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
Richard M. Stallman's avatar
Richard M. Stallman committed
660 661 662 663 664 665 666 667 668 669 670
(define-key rcirc-mode-map (kbd "C-c C-d") 'rcirc-cmd-mode)
(define-key rcirc-mode-map (kbd "C-c C-m") 'rcirc-cmd-msg)
(define-key rcirc-mode-map (kbd "C-c C-r") 'rcirc-cmd-nick) ; rename
(define-key rcirc-mode-map (kbd "C-c C-o") 'rcirc-cmd-oper)
(define-key rcirc-mode-map (kbd "C-c C-p") 'rcirc-cmd-part)
(define-key rcirc-mode-map (kbd "C-c C-q") 'rcirc-cmd-query)
(define-key rcirc-mode-map (kbd "C-c C-t") 'rcirc-cmd-topic)
(define-key rcirc-mode-map (kbd "C-c C-n") 'rcirc-cmd-names)
(define-key rcirc-mode-map (kbd "C-c C-w") 'rcirc-cmd-whois)
(define-key rcirc-mode-map (kbd "C-c C-x") 'rcirc-cmd-quit)
(define-key rcirc-mode-map (kbd "C-c TAB") ; C-i
671
  'rcirc-toggle-ignore-buffer-activity)
Richard M. Stallman's avatar
Richard M. Stallman committed
672 673 674
(define-key rcirc-mode-map (kbd "C-c C-s") 'rcirc-switch-to-server-buffer)
(define-key rcirc-mode-map (kbd "C-c C-a") 'rcirc-jump-to-first-unread-line)

675
(defvar rcirc-browse-url-map (make-sparse-keymap)
676
  "Keymap used for browsing URLs in `rcirc-mode'.")
677 678 679 680 681 682 683

(define-key rcirc-browse-url-map (kbd "RET") 'rcirc-browse-url-at-point)
(define-key rcirc-browse-url-map (kbd "<mouse-2>") 'rcirc-browse-url-at-mouse)

(defvar rcirc-short-buffer-name nil
  "Generated abbreviation to use to indicate buffer activity.")

Richard M. Stallman's avatar
Richard M. Stallman committed
684 685 686
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

687 688
(defvar rcirc-last-post-time nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
689
(defun rcirc-mode (process target)
690
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
691 692 693 694 695 696 697 698 699

\\{rcirc-mode-map}"
  (kill-all-local-variables)
  (use-local-map rcirc-mode-map)
  (setq mode-name "rcirc")
  (setq major-mode 'rcirc-mode)

  (make-local-variable 'rcirc-input-ring)
  (setq rcirc-input-ring (make-ring rcirc-input-ring-size))
700 701
  (make-local-variable 'rcirc-server-buffer)
  (setq rcirc-server-buffer (process-buffer process))
Richard M. Stallman's avatar
Richard M. Stallman committed
702 703
  (make-local-variable 'rcirc-target)
  (setq rcirc-target target)
704 705
  (make-local-variable 'rcirc-topic)
  (setq rcirc-topic nil)
706 707
  (make-local-variable 'rcirc-last-post-time)
  (setq rcirc-last-post-time (current-time))
708 709 710

  (make-local-variable 'rcirc-short-buffer-name)
  (setq rcirc-short-buffer-name nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
711 712 713 714
  (make-local-variable 'rcirc-urls)
  (setq rcirc-urls nil)
  (setq use-hard-newlines t)

715 716 717 718 719 720 721
  (make-local-variable 'rcirc-decode-coding-system)
  (make-local-variable 'rcirc-encode-coding-system)
  (dolist (i rcirc-coding-system-alist)
    (let ((chan (if (consp (car i)) (caar i) (car i)))
	  (serv (if (consp (car i)) (cdar i) "")))
      (when (and (string-match chan (or target ""))
		 (string-match serv (rcirc-server-name process)))
722 723
	(setq rcirc-decode-coding-system (if (consp (cdr i)) (cadr i) (cdr i))
	      rcirc-encode-coding-system (if (consp (cdr i)) (cddr i) (cdr i))))))
724

Richard M. Stallman's avatar
Richard M. Stallman committed
725 726 727 728 729 730 731 732 733 734 735 736 737
  ;; setup the prompt and markers
  (make-local-variable 'rcirc-prompt-start-marker)
  (setq rcirc-prompt-start-marker (make-marker))
  (set-marker rcirc-prompt-start-marker (point-max))
  (make-local-variable 'rcirc-prompt-end-marker)
  (setq rcirc-prompt-end-marker (make-marker))
  (set-marker rcirc-prompt-end-marker (point-max))
  (rcirc-update-prompt)
  (goto-char rcirc-prompt-end-marker)
  (make-local-variable 'overlay-arrow-position)
  (setq overlay-arrow-position (make-marker))
  (set-marker overlay-arrow-position nil)

738 739 740 741 742 743 744
  ;; if the user changes the major mode or kills the buffer, there is
  ;; cleanup work to do
  (make-local-variable 'change-major-mode-hook)
  (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook)
  (make-local-variable 'kill-buffer-hook)
  (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook)

745 746 747 748 749 750 751 752
  ;; add to buffer list, and update buffer abbrevs
  (when target				; skip server buffer
    (let ((buffer (current-buffer)))
      (with-rcirc-process-buffer process
	(setq rcirc-buffer-alist (cons (cons target buffer)
				       rcirc-buffer-alist))))
    (rcirc-update-short-buffer-names))

Richard M. Stallman's avatar
Richard M. Stallman committed
753 754
  (run-hooks 'rcirc-mode-hook))

755 756
(defun rcirc-update-prompt (&optional all)
  "Reset the prompt string in the current buffer.
757

758 759 760 761 762 763 764 765 766 767 768 769 770
If ALL is non-nil, update prompts in all IRC buffers."
  (if all
      (mapc (lambda (process)
	      (mapc (lambda (buffer)
		      (with-current-buffer buffer
			(rcirc-update-prompt)))
		    (with-rcirc-process-buffer process
		      (mapcar 'cdr rcirc-buffer-alist))))
	    (rcirc-process-list))
    (let ((inhibit-read-only t)
	  (prompt (or rcirc-prompt "")))
      (mapc (lambda (rep)
	      (setq prompt
771 772 773
		    (replace-regexp-in-string (car rep) (cdr rep) prompt)))
	    (list (cons "%n" (rcirc-buffer-nick))
		  (cons "%s" (with-rcirc-server-buffer (or rcirc-server "")))
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
		  (cons "%t" (or rcirc-target ""))))
      (save-excursion
	(delete-region rcirc-prompt-start-marker rcirc-prompt-end-marker)
	(goto-char rcirc-prompt-start-marker)
	(let ((start (point)))
	  (insert-before-markers prompt)
	  (set-marker rcirc-prompt-start-marker start)
	  (when (not (zerop (- rcirc-prompt-end-marker
			       rcirc-prompt-start-marker)))
	    (add-text-properties rcirc-prompt-start-marker
				 rcirc-prompt-end-marker
				 (list 'face 'rcirc-prompt
				       'read-only t 'field t
				       'front-sticky t 'rear-nonsticky t))))))))

(defun rcirc-set-changed (option value)
  "Set OPTION to VALUE and do updates after a customization change."
  (set-default option value)
  (cond ((eq option 'rcirc-prompt)
	 (rcirc-update-prompt 'all))
	(t
	 (error "Bad option %s" option))))
Richard M. Stallman's avatar
Richard M. Stallman committed
796 797 798 799 800 801 802 803 804 805 806

(defun rcirc-channel-p (target)
  "Return t if TARGET is a channel name."
  (and target
       (not (zerop (length target)))
       (or (eq (aref target 0) ?#)
           (eq (aref target 0) ?&))))

(defun rcirc-kill-buffer-hook ()
  "Part the channel when killing an rcirc buffer."
  (when (eq major-mode 'rcirc-mode)
807 808 809 810 811 812 813
    (rcirc-clean-up-buffer "Killed buffer")))

(defun rcirc-change-major-mode-hook ()
  "Part the channel when changing the major-mode."
  (rcirc-clean-up-buffer "Changed major mode"))

(defun rcirc-clean-up-buffer (reason)
814 815
  (let ((buffer (current-buffer)))
    (rcirc-clear-activity buffer)
816 817 818 819 820
    (when (and (rcirc-buffer-process)
	       (eq (process-status (rcirc-buffer-process)) 'open))
      (with-rcirc-server-buffer
       (setq rcirc-buffer-alist
	     (rassq-delete-all buffer rcirc-buffer-alist)))
821
      (rcirc-update-short-buffer-names)
Richard M. Stallman's avatar
Richard M. Stallman committed
822
      (if (rcirc-channel-p rcirc-target)
823 824
	  (rcirc-send-string (rcirc-buffer-process)
			     (concat "PART " rcirc-target " :" reason))
825
	(when rcirc-target
826 827
	  (rcirc-remove-nick-channel (rcirc-buffer-process)
				     (rcirc-buffer-nick)
828 829 830 831
				     rcirc-target))))))

(defun rcirc-generate-new-buffer-name (process target)
  "Return a buffer name based on PROCESS and TARGET.
832
This is used for the initial name given to IRC buffers."
833 834 835
  (if target
      (concat target "@" (process-name process))
    (concat "*" (process-name process) "*")))
Richard M. Stallman's avatar
Richard M. Stallman committed
836

837
(defun rcirc-get-buffer (process target &optional server)
Richard M. Stallman's avatar
Richard M. Stallman committed
838
  "Return the buffer associated with the PROCESS and TARGET.
839 840 841 842 843 844 845 846

If optional argument SERVER is non-nil, return the server buffer
if there is no existing buffer for TARGET, otherwise return nil."
  (with-rcirc-process-buffer process
    (if (null target)
	(current-buffer)
      (let ((buffer (cdr (assoc-string target rcirc-buffer-alist t))))
	(or buffer (when server (current-buffer)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
847 848

(defun rcirc-get-buffer-create (process target)
849 850 851
  "Return the buffer associated with the PROCESS and TARGET.
Create the buffer if it doesn't exist."
  (let ((buffer (rcirc-get-buffer process target)))
852
    (if (and buffer (buffer-live-p buffer))
853
	(with-current-buffer buffer
854
	  (when (not rcirc-target)
855
 	    (setq rcirc-target target))
856
	  buffer)
857 858 859 860 861 862 863 864
	;; create the buffer
	(with-rcirc-process-buffer process
	  (let ((new-buffer (get-buffer-create
			     (rcirc-generate-new-buffer-name process target))))
	    (with-current-buffer new-buffer
	      (rcirc-mode process target))
	    (rcirc-put-nick-channel process (rcirc-nick process) target)
	    new-buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
865 866 867 868

(defun rcirc-send-input ()
  "Send input to target associated with the current buffer."
  (interactive)
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
  (if (< (point) rcirc-prompt-end-marker)
      ;; copy the line down to the input area
      (progn
	(forward-line 0)
	(let ((start (if (eq (point) (point-min))
			 (point)
		       (if (get-text-property (1- (point)) 'hard)
			   (point)
			 (previous-single-property-change (point) 'hard))))
	      (end (next-single-property-change (1+ (point)) 'hard)))
	  (goto-char (point-max))
	  (insert (replace-regexp-in-string
		   "\n\\s-+" " "
		   (buffer-substring-no-properties start end)))))
    ;; process input
    (goto-char (point-max))
885 886 887 888 889 890 891 892 893 894 895 896 897 898
    (when (not (equal 0 (- (point) rcirc-prompt-end-marker)))
      ;; delete a trailing newline
      (when (eq (point) (point-at-bol))
	(delete-backward-char 1))
      (let ((input (buffer-substring-no-properties
		    rcirc-prompt-end-marker (point))))
	(dolist (line (split-string input "\n"))
	  (rcirc-process-input-line line))
	;; add to input-ring
	(save-excursion
	  (ring-insert rcirc-input-ring input)
	  (setq rcirc-input-ring-index 0))))))

(defun rcirc-process-input-line (line)
899 900 901 902 903 904 905 906
  (if (string-match "^/\\([^ ]+\\) ?\\(.*\\)$" line)
      (rcirc-process-command (match-string 1 line)
			     (match-string 2 line)
			     line)
    (rcirc-process-message line)))

(defun rcirc-process-message (line)
  (if (not rcirc-target)
907
      (message "Not joined (no target)")
908
    (delete-region rcirc-prompt-end-marker (point))
909 910
    (rcirc-send-message (rcirc-buffer-process) rcirc-target line)
    (setq rcirc-last-post-time (current-time))))
911 912 913 914 915

(defun rcirc-process-command (command args line)
  (if (eq (aref command 0) ?/)
      ;; "//text" will send "/text" as a message
      (rcirc-process-message (substring line 1))
916 917
    (let ((fun (intern-soft (concat "rcirc-cmd-" command)))
	  (process (rcirc-buffer-process)))
918 919 920 921
      (newline)
      (with-current-buffer (current-buffer)
	(delete-region rcirc-prompt-end-marker (point))
	(if (string= command "me")
922
	    (rcirc-print process (rcirc-buffer-nick)
923
			 "ACTION" rcirc-target args)
924
	  (rcirc-print process (rcirc-buffer-nick)
925 926 927
		       "COMMAND" rcirc-target line))
	(set-marker rcirc-prompt-end-marker (point))
	(if (fboundp fun)
928 929
	    (funcall fun args process rcirc-target)
	  (rcirc-send-string process
930 931
			     (concat command " " args)))))))

Richard M. Stallman's avatar
Richard M. Stallman committed
932 933 934 935 936 937 938 939
(defvar rcirc-parent-buffer nil)
(defvar rcirc-window-configuration nil)
(defun rcirc-edit-multiline ()
  "Move current edit to a dedicated buffer."
  (interactive)
  (let ((pos (1+ (- (point) rcirc-prompt-end-marker))))
    (goto-char (point-max))
    (let ((text (buffer-substring rcirc-prompt-end-marker (point)))
940
          (parent (buffer-name)))
Richard M. Stallman's avatar
Richard M. Stallman committed
941 942 943
      (delete-region rcirc-prompt-end-marker (point))
      (setq rcirc-window-configuration (current-window-configuration))
      (pop-to-buffer (concat "*multiline " parent "*"))
944 945
      (funcall rcirc-multiline-major-mode)
      (rcirc-multiline-minor-mode 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
946 947
      (setq rcirc-parent-buffer parent)
      (insert text)
948 949
      (and (> pos 0) (goto-char pos))
      (message "Type C-c C-c to return text to %s, or C-c C-k to cancel" parent))))
Richard M. Stallman's avatar
Richard M. Stallman committed
950

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
(defvar rcirc-multiline-minor-mode-map (make-sparse-keymap)
  "Keymap for multiline mode in rcirc.")
(define-key rcirc-multiline-minor-mode-map 
  (kbd "C-c C-c") 'rcirc-multiline-minor-submit)
(define-key rcirc-multiline-minor-mode-map
  (kbd "C-x C-s") 'rcirc-multiline-minor-submit)
(define-key rcirc-multiline-minor-mode-map
  (kbd "C-c C-k") 'rcirc-multiline-minor-cancel)
(define-key rcirc-multiline-minor-mode-map
  (kbd "ESC ESC ESC") 'rcirc-multiline-minor-cancel)

(define-minor-mode rcirc-multiline-minor-mode
  "Minor mode for editing multiple lines in rcirc."
  :init-value nil
  :lighter " rcirc-mline"
  :keymap rcirc-multiline-minor-mode-map
  :global nil
  :group 'rcirc
Richard M. Stallman's avatar
Richard M. Stallman committed
969
  (make-local-variable 'rcirc-parent-buffer)
970 971
  (put 'rcirc-parent-buffer 'permanent-local t)
  (setq fill-column rcirc-max-message-length))
972 973

(defun rcirc-multiline-minor-submit ()
Richard M. Stallman's avatar
Richard M. Stallman committed
974 975 976
  "Send the text in buffer back to parent buffer."
  (interactive)
  (assert rcirc-parent-buffer)
977
  (untabify (point-min) (point-max))
Richard M. Stallman's avatar
Richard M. Stallman committed
978 979 980 981 982 983 984
  (let ((text (buffer-substring (point-min) (point-max)))
        (buffer (current-buffer))
        (pos (point)))
    (set-buffer rcirc-parent-buffer)
    (goto-char (point-max))
    (insert text)
    (kill-buffer buffer)
985 986
    (set-window-configuration rcirc-window-configuration)
    (goto-char (+ rcirc-prompt-end-marker (1- pos)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
987

988
(defun rcirc-multiline-minor-cancel ()
Richard M. Stallman's avatar
Richard M. Stallman committed
989 990 991 992 993
  "Cancel the multiline edit."
  (interactive)
  (kill-buffer (current-buffer))
  (set-window-configuration rcirc-window-configuration))

994
(defun rcirc-any-buffer (process)
995
  "Return a buffer for PROCESS, either the one selected or the process buffer."
996 997 998 999 1000 1001
  (if rcirc-always-use-server-buffer-flag
      (process-buffer process)
    (let ((buffer (window-buffer (selected-window))))
      (if (and buffer
	       (with-current-buffer buffer
		 (and (eq major-mode 'rcirc-mode)
1002
		      (eq (rcirc-buffer-process) process))))
1003 1004
	  buffer
	(process-buffer process)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1005

1006
(defcustom rcirc-response-formats
1007 1008 1009
  '(("PRIVMSG" . "%T<%N> %m")
    ("NOTICE"  . "%T-%N- %m")
    ("ACTION"  . "%T[%N %m]")
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
    ("COMMAND" . "%T%m")
    ("ERROR"   . "%T%fw!!! %m")
    (t         . "%T%fp*** %fs%n %r %m"))
  "An alist of formats used for printing responses.
The format is looked up using the response-type as a key;
if no match is found, the default entry (with a key of `t') is used.

The entry's value part should be a string, which is inserted with
the of the following escape sequences replaced by the described values:

  %m        The message text
1021 1022
  %n        The sender's nick
  %N        The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
1023 1024 1025 1026 1027 1028 1029
  %r        The response-type
  %T        The timestamp (with face `rcirc-timestamp')
  %t        The target
  %fw       Following text uses the face `font-lock-warning-face'
  %fp       Following text uses the face `rcirc-server-prefix'
  %fs       Following text uses the face `rcirc-server'
  %f[FACE]  Following text uses the face FACE
1030
  %f-       Following text uses the default face
1031
  %%        A literal `%' character"
1032 1033 1034 1035 1036
  :type '(alist :key-type (choice (string :tag "Type")
				  (const :tag "Default" t))
		:value-type string)
  :group 'rcirc)

Richard M. Stallman's avatar
Richard M. Stallman committed
1037
(defun rcirc-format-response-string (process sender response target text)
1038 1039 1040 1041 1042 1043 1044
  "Return a nicely-formatted response string, incorporating TEXT
\(and perhaps other arguments).  The specific formatting used
is found by looking up RESPONSE in `rcirc-response-formats'."
  (let ((chunks
	 (split-string (or (cdr (assoc response rcirc-response-formats))
			   (cdr (assq t rcirc-response-formats)))
		       "%"))
1045
	(sender (or sender ""))
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	(result "")
	(face nil)
	key face-key repl)
    (when (equal (car chunks) "")
      (pop chunks))
    (dolist (chunk chunks)
      (if (equal chunk "")
	  (setq key ?%)
	(setq key (aref chunk 0))
	(setq chunk (substring chunk 1)))
      (setq repl
	    (cond ((eq key ?%)
1058
		   ;; %% -- literal % character
1059
		   "%")
1060 1061
		  ((or (eq key ?n) (eq key ?N))
		   ;; %n/%N -- nick
1062 1063
		   (let ((nick (concat (if (string= (with-rcirc-process-buffer process
						      rcirc-server)
1064 1065
						    sender)
					   ""
1066
					 sender)
1067 1068 1069 1070
				       (and target (concat "," target)))))
		     (rcirc-facify nick
				   (if (eq key ?n)
				       face
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
				     (cond ((string= sender (rcirc-nick process))
					    'rcirc-my-nick)
					   ((and rcirc-bright-nick-regexp
						 (string-match rcirc-bright-nick-regexp sender))
					    'rcirc-bright-nick)
					   ((and rcirc-dim-nick-regexp
						 (string-match rcirc-dim-nick-regexp sender))
					    'rcirc-dim-nick)
					   (t
					    'rcirc-other-nick))))))
1081
		  ((eq key ?T)
1082
		   ;; %T -- timestamp
1083 1084 1085 1086
		   (rcirc-facify
		    (format-time-string rcirc-time-format (current-time))
		    'rcirc-timestamp))
		  ((eq key ?m)
1087 1088 1089
		   ;; %m -- message text
		   ;; We add the text property `rcirc-text' to identify this
		   ;; as the body text.
1090 1091 1092 1093
		   (propertize
		    (rcirc-mangle-text process (rcirc-facify text face))
		    'rcirc-text text))
		  ((eq key ?t)
1094
		   ;; %t -- target
1095 1096
		   (rcirc-facify (or rcirc-target "") face))
		  ((eq key ?r)
1097
		   ;; %r -- response
1098 1099
		   (rcirc-facify response face))
		  ((eq key ?f)
1100
		   ;; %f -- change face
1101
		   (setq face-key (aref chunk 0))
1102
		   (setq chunk (substring chunk 1))
1103
		   (cond ((eq face-key ?w)
1104
			  ;; %fw -- warning face
1105 1106
			  (setq face 'font-lock-warning-face))
			 ((eq face-key ?p)
1107
			  ;; %fp -- server-prefix face
1108 1109
			  (setq face 'rcirc-server-prefix))
			 ((eq face-key ?s)
1110
			  ;; %fs -- warning face
1111 1112
			  (setq face 'rcirc-server))
			 ((eq face-key ?-)
1113
			  ;; %fs -- warning face
1114 1115
			  (setq face nil))
			 ((and (eq face-key ?\[)
1116
			       (string-match "^\\([^]]*\\)[]]" chunk)
1117
			       (facep (match-string 1 chunk)))
1118
			  ;; %f[...] -- named face
1119
			  (setq face (intern (match-string 1 chunk)))
1120 1121
			  (setq chunk (substring chunk (match-end 0)))))
		   "")))
1122 1123
      (setq result (concat result repl (rcirc-facify chunk face))))
    result))
Richard M. Stallman's avatar
Richard M. Stallman committed
1124

1125 1126 1127 1128 1129
(defun rcirc-target-buffer (process sender response target text)
  "Return a buffer to print the server response."
  (assert (not (bufferp target)))
  (with-rcirc-process-buffer process
    (cond ((not target)
1130
	   (rcirc-any-buffer process))
1131 1132 1133 1134 1135 1136 1137 1138
	  ((not (rcirc-channel-p target))
	   ;; message from another user
	   (if (string= response "PRIVMSG")
	       (rcirc-get-buffer-create process (if (string= sender rcirc-nick)
						    target
						  sender))
	     (rcirc-get-buffer process target t)))
	  ((or (rcirc-get-buffer process target)
1139
	       (rcirc-any-buffer process))))))
1140

Richard M. Stallman's avatar
Richard M. Stallman committed
1141 1142
(defvar rcirc-activity-type nil)
(make-variable-buffer-local 'rcirc-activity-type)
1143 1144 1145 1146
(defvar rcirc-last-sender nil)
(make-variable-buffer-local 'rcirc-last-sender)
(defvar rcirc-gray-toggle nil)
(make-variable-buffer-local 'rcirc-gray-toggle)
Richard M. Stallman's avatar
Richard M. Stallman committed
1147 1148 1149 1150
(defun rcirc-print (process sender response target text &optional activity)
  "Print TEXT in the buffer associated with TARGET.
Format based on SENDER and RESPONSE.  If ACTIVITY is non-nil,
record activity."
1151
  (or text (setq text ""))
1152
  (unless (or (member sender rcirc-ignore-list)
1153
	      (member (with-syntax-table rcirc-nick-syntax-table
1154 1155 1156
			(when (string-match "^\\([^/]\\w*\\)[:,]" text)
			  (match-string 1 text)))
		      rcirc-ignore-list))
1157
    (let* ((buffer (rcirc-target-buffer process sender response target text))
1158 1159 1160 1161 1162 1163 1164 1165
	   (inhibit-read-only t))
      (with-current-buffer buffer
	(let ((moving (= (point) rcirc-prompt-end-marker))
	      (old-point (point-marker))
	      (fill-start (marker-position rcirc-prompt-start-marker)))

	  (unless (string= sender (rcirc-nick process))
	    ;; only decode text from other senders, not ours
1166
	    (setq text (decode-coding-string text rcirc-decode-coding-system))
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
	    ;; mark the line with overlay arrow
	    (unless (or (marker-position overlay-arrow-position)
			(get-buffer-window (current-buffer)))
	      (set-marker overlay-arrow-position
			  (marker-position rcirc-prompt-start-marker))))

	  ;; temporarily set the marker insertion-type because
	  ;; insert-before-markers results in hidden text in new buffers
	  (goto-char rcirc-prompt-start-marker)
	  (set-marker-insertion-type rcirc-prompt-start-marker t)
	  (set-marker-insertion-type rcirc-prompt-end-marker t)
1178 1179 1180 1181 1182 1183 1184 1185 1186

	  (let ((fmted-text
		 (rcirc-format-response-string process sender response nil
					       text)))

	    (insert fmted-text (propertize "\n" 'hard t))
	    (set-marker-insertion-type rcirc-prompt-start-marker nil)
	    (set-marker-insertion-type rcirc-prompt-end-marker nil)

1187 1188 1189 1190
	    (let ((text-start (make-marker)))
	      (set-marker text-start
			  (or (next-single-property-change fill-start 
							   'rcirc-text)
1191
			      rcirc-prompt-end-marker))
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
	      ;; squeeze spaces out of text before rcirc-text
	      (fill-region fill-start (1- text-start))

	      ;; fill the text we just inserted, maybe
	      (when (and rcirc-fill-flag
			 (not (string= response "372"))) ;/motd
		(let ((fill-prefix
		       (or rcirc-fill-prefix
			   (make-string (- text-start fill-start) ?\s)))
		      (fill-column (cond ((eq rcirc-fill-column 'frame-width)
					  (1- (frame-width)))
					 (rcirc-fill-column
					  rcirc-fill-column)
					 (t fill-column))))
		  (fill-region fill-start rcirc-prompt-start-marker 'left t)))))
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246

	  ;; set inserted text to be read-only
	  (when rcirc-read-only-flag
	    (put-text-property rcirc-prompt-start-marker fill-start 'read-only t)
	    (let ((inhibit-read-only t))
	      (put-text-property rcirc-prompt-start-marker fill-start
				 'front-sticky t)
	      (put-text-property (1- (point)) (point) 'rear-nonsticky t)))

	  ;; truncate buffer if it is very long
	  (save-excursion
	    (when (and rcirc-buffer-maximum-lines
		       (> rcirc-buffer-maximum-lines 0)
		       (= (forward-line (- rcirc-buffer-maximum-lines)) 0))
	      (delete-region (point-min) (point))))

	  ;; set the window point for buffers show in windows
	  (walk-windows (lambda (w)
			  (unless (eq (selected-window) w)
			    (when (and (eq (current-buffer)
					   (window-buffer w))
				       (>= (window-point w)
					   rcirc-prompt-end-marker))
			      (set-window-point w (point-max)))))
			nil t)

	  ;; restore the point
	  (goto-char (if moving rcirc-prompt-end-marker old-point))

	  ;; flush undo (can we do something smarter here?)
	  (buffer-disable-undo)
	  (buffer-enable-undo))

	;; record modeline activity
	(when activity
	  (let ((nick-match
		 (string-match (concat "\\b"
				       (regexp-quote (rcirc-nick process))
				       "\\b")
			       text)))
1247 1248 1249 1250 1251 1252
	    (when (if rcirc-ignore-buffer-activity-flag
		      ;; - Always notice when our nick is mentioned
		      nick-match
		    ;; - Never bother us if a dim-nick spoke
		    (not (and rcirc-dim-nick-regexp sender
			      (string-match rcirc-dim-nick-regexp sender))))
1253 1254
	      (rcirc-record-activity
	       (current-buffer)
1255 1256
	       (when (or nick-match (and (not (rcirc-channel-p rcirc-target))
					 (not rcirc-low-priority-flag)))
1257 1258 1259 1260 1261
		 'nick)))))

	(sit-for 0)			; displayed text before hook
	(run-hook-with-args 'rcirc-print-hooks
			    process sender response target text)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1262 1263

(defun rcirc-startup-channels (server)
1264
  "Return the list of startup channels for SERVER."
Richard M. Stallman's avatar
Richard M. Stallman committed
1265 1266 1267 1268 1269 1270 1271 1272 1273
  (let (channels)
    (dolist (i rcirc-startup-channels-alist)
      (if (string-match (car i) server)
          (setq channels (append channels (cdr i)))))
    channels))

(defun rcirc-join-channels (process channels)
  "Join CHANNELS."
  (save-window-excursion
1274 1275 1276
    (dolist (channel channels)
      (with-rcirc-process-buffer process
	(rcirc-cmd-join channel process)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1277 1278 1279 1280

;;; nick management
(defun rcirc-user-nick (user)
  "Return the nick from USER.  Remove any non-nick junk."
1281 1282 1283 1284
  (save-match-data
    (if (string-match "^[@%+]?\\([^! ]+\\)!?" (or user ""))
	(match-string 1 user)
      user)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1285 1286 1287 1288 1289 1290 1291 1292 1293

(defun rcirc-user-non-nick (user)
  "Return the non-nick portion of USER."
  (if (string-match "^[@+]?[^! ]+!?\\(.*\\)" (or user ""))
      (match-string 1 user)
    user))

(defun rcirc-nick-channels (process nick)
  "Return list of channels for NICK."
1294 1295 1296
  (with-rcirc-process-buffer process
    (mapcar (lambda (x) (car x))
	    (gethash nick rcirc-nick-table))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1297 1298 1299

(defun rcirc-put-nick-channel (process nick channel)
  "Add CHANNEL to list associated with NICK."
1300 1301 1302 1303 1304 1305 1306 1307 1308
  (let ((nick (rcirc-user-nick nick)))
    (with-rcirc-process-buffer process
      (let* ((chans (gethash nick rcirc-nick-table))
	     (record (assoc-string channel chans t)))
	(if record
	    (setcdr record (current-time))
	  (puthash nick (cons (cons channel (current-time))
			      chans)
		   rcirc-nick-table))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1309 1310 1311

(defun rcirc-nick-remove (process nick)
  "Remove NICK from table."
1312
  (with-rcirc-process-buffer process
Richard M. Stallman's avatar
Richard M. Stallman committed
1313 1314 1315 1316
    (remhash nick rcirc-nick-table)))

(defun rcirc-remove-nick-channel (process nick channel)
  "Remove the CHANNEL from list associated with NICK."
1317
  (with-rcirc-process-buffer process
1318
    (let* ((chans (gethash nick rcirc-nick-table))
1319 1320 1321 1322 1323 1324
           (newchans
	    ;; instead of assoc-string-delete-all:
	    (let ((record (assoc-string channel chans t)))
	      (when record
		(setcar record 'delete)
		(assq-delete-all 'delete chans)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1325 1326 1327 1328
      (if newchans
          (puthash nick newchans rcirc-nick-table)
        (remhash nick rcirc-nick-table)))))

1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
(defun rcirc-channel-nicks (process target)
  "Return the list of nicks associated with TARGET sorted by last activity."
  (when target
    (if (rcirc-channel-p target)
	(with-rcirc-process-buffer process
	  (let (nicks)
	    (maphash
	     (lambda (k v)
	       (let ((record (assoc-string target v t)))
		 (if record
		     (setq nicks (cons (cons k (cdr record)) nicks)))))
	     rcirc-nick-table)
	    (mapcar (lambda (x) (car x))
		    (sort nicks (lambda (x y) (time-less-p (cdr y) (cdr x)))))))
      (list target))))
1344 1345

(defun rcirc-ignore-update-automatic (nick)
1346 1347
  "Remove NICK from `rcirc-ignore-list'
if NICK is also on `rcirc-ignore-list-automatic'."
1348 1349 1350 1351 1352
  (when (member nick rcirc-ignore-list-automatic)
      (setq rcirc-ignore-list-automatic
	    (delete nick rcirc-ignore-list-automatic)
	    rcirc-ignore-list
	    (delete nick rcirc-ignore-list))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1353 1354

;;; activity tracking
1355 1356 1357 1358 1359 1360 1361
(defvar rcirc-track-minor-mode-map (make-sparse-keymap)
  "Keymap for rcirc track minor mode.")

(define-key rcirc-track-minor-mode-map (kbd "C-c `") 'rcirc-next-active-buffer)
(define-key rcirc-track-minor-mode-map (kbd "C-c C-@") 'rcirc-next-active-buffer)
(define-key rcirc-track-minor-mode-map (kbd "C-c C-SPC") 'rcirc-next-active-buffer)

1362
;;;###autoload
1363 1364 1365 1366 1367