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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 2005, 2006, 2007 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

;; 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
18
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Richard M. Stallman's avatar
Richard M. Stallman committed
19 20 21
;; 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

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

Miles Bader's avatar
Miles Bader committed
43 44
;;; Todo:

Richard M. Stallman's avatar
Richard M. Stallman committed
45 46 47 48 49 50
;;; Code:

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

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

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

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

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

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

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

85
(defcustom rcirc-startup-channels-alist '(("^irc.freenode.net$" "#rcirc"))
Richard M. Stallman's avatar
Richard M. Stallman committed
86
  "Alist of channels to join at startup.
87 88 89
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
90

91 92 93 94
(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
95

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

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

115 116 117
(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
118

119 120 121 122
(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)

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

129 130 131 132
(defcustom rcirc-input-ring-size 1024
  "*Size of input history ring."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
133

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

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

147
(defcustom rcirc-scroll-show-maximum-output t
148
  "*If non-nil, scroll buffer to keep the point at the bottom of the window."
149 150
  :type 'boolean
  :group 'rcirc)
Miles Bader's avatar
Miles Bader committed
151

152 153 154 155 156 157 158
(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
159 160

The required ARGUMENTS for each METHOD symbol are:
161 162 163
  `nickserv': NICK PASSWORD
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
164 165

Example:
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
 ((\"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"))))
183
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
184

185
(defcustom rcirc-auto-authenticate-flag t
Richard M. Stallman's avatar
Richard M. Stallman committed
186
  "*Non-nil means automatically send authentication string to server.
187
See also `rcirc-authinfo'."
188 189
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
190

191
(defcustom rcirc-prompt "> "
192
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
193 194 195 196 197 198

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

199 200 201 202 203 204 205
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)

206 207 208 209 210
(defcustom rcirc-keywords nil
  "List of keywords to highlight in message text."
  :type '(repeat string)
  :group 'rcirc)

211 212 213 214 215 216 217 218 219 220 221 222
(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.")

223 224
(defcustom rcirc-bright-nicks nil
  "List of nicks to be emphasized.
225
See `rcirc-bright-nick' face."
226
  :type '(repeat string)
227 228
  :group 'rcirc)

229 230
(defcustom rcirc-dim-nicks nil
  "List of nicks to be deemphasized.
231
See `rcirc-dim-nick' face."
232
  :type '(repeat string)
233 234
  :group 'rcirc)

235 236 237 238 239
(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
240

241 242 243 244 245
(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)

246
(defcustom rcirc-decode-coding-system 'utf-8
247 248 249 250 251 252 253 254 255 256
  "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
257
  "Alist to decide a coding system to use for a channel I/O operation.
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
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
283 284 285 286 287
(defvar rcirc-prompt-start-marker nil)
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

288 289 290 291 292 293 294 295
(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.")

296 297 298
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
299
(defvar rcirc-activity nil
300
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
301 302 303 304 305

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

306 307
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
308 309 310 311 312 313

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

(defvar rcirc-urls nil
  "List of urls seen in the current buffer.")
Miles Bader's avatar
Miles Bader committed
314
(put 'rcirc-urls 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
315

316
(defvar rcirc-timeout-seconds 600
317
  "Kill connection after this many seconds if there is no activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
318

319
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
320 321 322

(defvar rcirc-startup-channels nil)
;;;###autoload
323
(defun rcirc (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
324
  "Connect to IRC.
325 326 327
If ARG is non-nil, prompt for a server to connect to."
  (interactive "P")
  (if arg
328 329 330
      (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))
331 332
	     (channels (split-string
			(read-string "IRC Channels: "
333
				     (mapconcat 'identity (rcirc-startup-channels server) " "))
334
			"[, ]+" t)))
335
	(rcirc-connect server port nick rcirc-default-user-name rcirc-default-user-full-name
336 337 338
		       channels))
    ;; make new connection using defaults unless already connected to
    ;; the default rcirc-server
339
    (let (connected)
340
      (dolist (p (rcirc-process-list))
341
	(when (string= rcirc-default-server (process-name p))
342 343
	  (setq connected p)))
      (if (not connected)
344
	  (rcirc-connect rcirc-default-server rcirc-default-port
345 346 347
			 rcirc-default-nick rcirc-default-user-name
			 rcirc-default-user-full-name
			 (rcirc-startup-channels rcirc-default-server))
348
	(switch-to-buffer (process-buffer connected))
349
	(message "Connected to %s"
350 351
		 (process-contact (get-buffer-process (current-buffer))
				  :host))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
352 353 354 355 356 357 358
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
359
(defvar rcirc-last-server-message-time nil)
360 361 362 363 364 365
(defvar rcirc-server nil)		; server provided by server
(defvar rcirc-server-name nil)		; server name given by 001 response
(defvar rcirc-timeout-timer nil)
(defvar rcirc-user-disconnect nil)
(defvar rcirc-connecting nil)
(defvar rcirc-process nil)
366 367

;;;###autoload
368
(defun rcirc-connect (&optional server port nick user-name full-name startup-channels)
Richard M. Stallman's avatar
Richard M. Stallman committed
369 370 371
  (save-excursion
    (message "Connecting to %s..." server)
    (let* ((inhibit-eol-conversion)
372 373 374 375
           (port-number (if port
			    (if (stringp port)
				(string-to-number port)
			      port)
376 377 378 379 380 381
			  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)
382
           (process (make-network-process :name server :host server :service port-number)))
Richard M. Stallman's avatar
Richard M. Stallman committed
383 384
      ;; set up process
      (set-process-coding-system process 'raw-text 'raw-text)
385
      (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
386 387
      (set-process-buffer process (current-buffer))
      (rcirc-mode process nil)
388 389
      (set-process-sentinel process 'rcirc-sentinel)
      (set-process-filter process 'rcirc-filter)
390 391
      (make-local-variable 'rcirc-process)
      (setq rcirc-process process)
392 393
      (make-local-variable 'rcirc-server)
      (setq rcirc-server server)
394 395
      (make-local-variable 'rcirc-server-name)
      (setq rcirc-server-name server)	; update when we get 001 response
396 397
      (make-local-variable 'rcirc-buffer-alist)
      (setq rcirc-buffer-alist nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
398 399 400 401 402 403 404 405
      (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)
406 407
      (make-local-variable 'rcirc-last-server-message-time)
      (setq rcirc-last-server-message-time (current-time))
408 409 410 411 412 413
      (make-local-variable 'rcirc-timeout-timer)
      (setq rcirc-timeout-timer nil)
      (make-local-variable 'rcirc-user-disconnect)
      (setq rcirc-user-disconnect nil)
      (make-local-variable 'rcirc-connecting)
      (setq rcirc-connecting t)
Richard M. Stallman's avatar
Richard M. Stallman committed
414 415 416 417 418 419 420 421

      ;; 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
422 423 424
      (unless rcirc-keepalive-timer
	(setq rcirc-keepalive-timer
	      (run-at-time 0 (/ rcirc-timeout-seconds 2) 'rcirc-keepalive)))
Richard M. Stallman's avatar
Richard M. Stallman committed
425 426 427 428 429 430

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

      ;; return process object
      process)))

431 432 433 434 435
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

436 437 438 439 440
(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
441
(defun rcirc-keepalive ()
442 443 444
  "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
445 446
  (if (rcirc-process-list)
      (mapc (lambda (process)
447 448 449
	      (with-rcirc-process-buffer process
		(when (not rcirc-connecting)
		  (rcirc-send-string process (concat "PING " (rcirc-server-name process))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
450
            (rcirc-process-list))
451
    ;; no processes, clean up timer
Richard M. Stallman's avatar
Richard M. Stallman committed
452 453 454
    (cancel-timer rcirc-keepalive-timer)
    (setq rcirc-keepalive-timer nil)))

455 456 457 458
(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
459
  "Add an entry to the debug log including PROCESS and TEXT.
460
Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
461 462
is non-nil."
  (when rcirc-debug-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
463 464
    (save-excursion
      (save-window-excursion
465
        (set-buffer (get-buffer-create rcirc-debug-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
466 467 468 469 470 471
        (goto-char (point-max))
        (insert (concat
                 "["
                 (format-time-string "%Y-%m-%dT%T ") (process-name process)
                 "] "
                 text))))))
472

Richard M. Stallman's avatar
Richard M. Stallman committed
473 474 475 476 477 478 479
(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)))
480 481 482 483
    (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))
484 485 486 487
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
488
			       (process-status process)) (not rcirc-target))
489
	  ;; remove the prompt from buffers
Richard M. Stallman's avatar
Richard M. Stallman committed
490 491
	  (let ((inhibit-read-only t))
	    (delete-region rcirc-prompt-start-marker
492 493
			   rcirc-prompt-end-marker))))
      (run-hook-with-args 'rcirc-sentinel-hooks process sentinel))))
Richard M. Stallman's avatar
Richard M. Stallman committed
494 495 496 497 498

(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
499
            (when (buffer-live-p (process-buffer p))
500
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
501 502 503 504 505 506
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

(defvar rcirc-receive-message-hooks nil
507 508
  "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
509 510
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
511
  (rcirc-debug process output)
512
  (rcirc-reschedule-timeout process)
513
  (with-rcirc-process-buffer process
514
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
515 516 517 518 519
    (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))
520
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
521 522
      (setq rcirc-process-output nil))))

523 524 525 526 527 528 529 530 531 532 533 534 535
(defun rcirc-reschedule-timeout (process)
  (with-rcirc-process-buffer process
    (when (not rcirc-connecting)
      (with-rcirc-process-buffer process
	(when rcirc-timeout-timer (cancel-timer rcirc-timeout-timer))
	(setq rcirc-timeout-timer (run-at-time rcirc-timeout-seconds nil
					       'rcirc-delete-process
					       process))))))

(defun rcirc-delete-process (process)
  (message "delete process %S" process)
  (delete-process process))

536
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
537
(defun rcirc-process-server-response (process text)
538
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
539 540 541 542
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
543
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545 546 547
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
548 549
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
550 551 552 553 554 555
             (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))
556 557
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
558 559 560 561 562 563 564
        (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)))

565 566 567 568
(defvar rcirc-responses-no-activity '("305" "306")
  "Responses that don't trigger activity in the mode-line indicator.")

(defun rcirc-handler-generic (process response sender args text)
Richard M. Stallman's avatar
Richard M. Stallman committed
569
  "Generic server response handler."
570 571 572
  (rcirc-print process sender response nil
               (mapconcat 'identity (cdr args) " ")
	       (not (member response rcirc-responses-no-activity))))
Richard M. Stallman's avatar
Richard M. Stallman committed
573 574 575

(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
576
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
577
                        "\n")))
578
    (unless (eq (process-status process) 'open)
579
      (error "Network connection to %s is not open"
580
             (process-name process)))
581
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
582 583
    (process-send-string process string)))

584 585 586
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
587 588 589 590 591
  (or (get-buffer-process (if buffer
			      (with-current-buffer buffer
				rcirc-server-buffer)
			    rcirc-server-buffer))
      rcirc-process))
592 593 594

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
595
  (with-rcirc-process-buffer process
596
    (or rcirc-server-name rcirc-default-server)))
Richard M. Stallman's avatar
Richard M. Stallman committed
597 598 599

(defun rcirc-nick (process)
  "Return PROCESS nick."
600
  (with-rcirc-process-buffer process
601 602 603 604 605 606 607 608
    (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
609

610
(defvar rcirc-max-message-length 420
Richard M. Stallman's avatar
Richard M. Stallman committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
  "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))))
627 628
    (rcirc-get-buffer-create process target)
    (rcirc-print process (rcirc-nick process) response target text)
Richard M. Stallman's avatar
Richard M. Stallman committed
629
    (rcirc-send-string process (concat response " " target " :" text))
630
    (when more (rcirc-send-message process target more noticep))))
Richard M. Stallman's avatar
Richard M. Stallman committed
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652

(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)
Miles Bader's avatar
Miles Bader committed
653

Richard M. Stallman's avatar
Richard M. Stallman committed
654 655 656
(defun rcirc-complete-nick ()
  "Cycle through nick completions from list of nicks in channel."
  (interactive)
Miles Bader's avatar
Miles Bader committed
657
  (if (eq last-command this-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
658 659 660 661 662 663 664 665 666 667 668
      (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))
669 670
            (all-completions
	     (buffer-substring
Richard M. Stallman's avatar
Richard M. Stallman committed
671 672 673 674
	      (+ rcirc-prompt-end-marker
		 rcirc-nick-completion-start-offset)
	      (point))
	     (mapcar (lambda (x) (cons x nil))
675 676
		     (rcirc-channel-nicks (rcirc-buffer-process)
					  rcirc-target))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
677 678
  (let ((completion (car rcirc-nick-completions)))
    (when completion
Miles Bader's avatar
Miles Bader committed
679
      (rcirc-put-nick-channel (rcirc-buffer-process) completion rcirc-target)
680
      (delete-region (+ rcirc-prompt-end-marker
Miles Bader's avatar
Miles Bader committed
681 682
			rcirc-nick-completion-start-offset)
		     (point))
Richard M. Stallman's avatar
Richard M. Stallman committed
683
      (insert (concat completion
684
                      (if (= (+ rcirc-prompt-end-marker
Richard M. Stallman's avatar
Richard M. Stallman committed
685 686 687 688
                                rcirc-nick-completion-start-offset)
                             rcirc-prompt-end-marker)
                          ": "))))))

689 690 691 692 693 694 695 696 697
(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
698 699 700 701 702 703 704 705 706 707 708 709

(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)
710
(define-key rcirc-mode-map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
Richard M. Stallman's avatar
Richard M. Stallman committed
711 712 713 714 715 716 717 718 719 720 721
(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
722
  'rcirc-toggle-ignore-buffer-activity)
Richard M. Stallman's avatar
Richard M. Stallman committed
723 724 725
(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)

726
(defvar rcirc-browse-url-map (make-sparse-keymap)
727
  "Keymap used for browsing URLs in `rcirc-mode'.")
728 729 730 731 732 733 734

(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
735 736 737
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

738 739
(defvar rcirc-last-post-time nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
740
(defun rcirc-mode (process target)
741
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
742 743 744 745 746 747 748 749 750

\\{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))
751 752
  (make-local-variable 'rcirc-server-buffer)
  (setq rcirc-server-buffer (process-buffer process))
Richard M. Stallman's avatar
Richard M. Stallman committed
753 754
  (make-local-variable 'rcirc-target)
  (setq rcirc-target target)
755 756
  (make-local-variable 'rcirc-topic)
  (setq rcirc-topic nil)
757 758
  (make-local-variable 'rcirc-last-post-time)
  (setq rcirc-last-post-time (current-time))
759 760 761

  (make-local-variable 'rcirc-short-buffer-name)
  (setq rcirc-short-buffer-name nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
762 763 764
  (make-local-variable 'rcirc-urls)
  (setq use-hard-newlines t)

765 766 767 768 769 770 771
  (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)))
772 773
	(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))))))
774

Richard M. Stallman's avatar
Richard M. Stallman committed
775 776 777 778 779 780 781 782 783 784 785 786 787
  ;; 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)

788 789
  ;; if the user changes the major mode or kills the buffer, there is
  ;; cleanup work to do
790 791
  (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook nil t)
  (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook nil t)
792

793 794 795 796 797 798 799 800
  ;; 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
801 802
  (run-hooks 'rcirc-mode-hook))

803 804
(defun rcirc-update-prompt (&optional all)
  "Reset the prompt string in the current buffer.
805

806 807 808 809 810 811 812 813 814 815 816 817 818
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
819 820
		    (replace-regexp-in-string (car rep) (cdr rep) prompt)))
	    (list (cons "%n" (rcirc-buffer-nick))
821
		  (cons "%s" (with-rcirc-server-buffer rcirc-server-name))
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
		  (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
844 845 846 847 848 849 850 851 852 853 854

(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)
855 856 857 858 859 860 861
    (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)
862 863
  (let ((buffer (current-buffer)))
    (rcirc-clear-activity buffer)
864 865 866 867 868
    (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)))
869
      (rcirc-update-short-buffer-names)
Richard M. Stallman's avatar
Richard M. Stallman committed
870
      (if (rcirc-channel-p rcirc-target)
871 872
	  (rcirc-send-string (rcirc-buffer-process)
			     (concat "PART " rcirc-target " :" reason))
873
	(when rcirc-target
874 875
	  (rcirc-remove-nick-channel (rcirc-buffer-process)
				     (rcirc-buffer-nick)
876 877 878 879
				     rcirc-target))))))

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

885
(defun rcirc-get-buffer (process target &optional server)
Richard M. Stallman's avatar
Richard M. Stallman committed
886
  "Return the buffer associated with the PROCESS and TARGET.
887 888 889 890 891 892 893 894

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
895 896

(defun rcirc-get-buffer-create (process target)
897 898 899
  "Return the buffer associated with the PROCESS and TARGET.
Create the buffer if it doesn't exist."
  (let ((buffer (rcirc-get-buffer process target)))
900
    (if (and buffer (buffer-live-p buffer))
901
	(with-current-buffer buffer
902
	  (when (not rcirc-target)
903
 	    (setq rcirc-target target))
904
	  buffer)
905 906 907 908 909 910 911 912
	;; 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
913 914 915 916

(defun rcirc-send-input ()
  "Send input to target associated with the current buffer."
  (interactive)
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
  (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))
933 934 935 936 937 938 939 940 941 942 943 944 945 946
    (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)
947 948 949 950 951 952 953 954
  (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)
955
      (message "Not joined (no target)")
956
    (delete-region rcirc-prompt-end-marker (point))
957 958
    (rcirc-send-message (rcirc-buffer-process) rcirc-target line)
    (setq rcirc-last-post-time (current-time))))
959 960 961 962 963

(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))
964 965
    (let ((fun (intern-soft (concat "rcirc-cmd-" command)))
	  (process (rcirc-buffer-process)))
966 967 968 969
      (newline)
      (with-current-buffer (current-buffer)
	(delete-region rcirc-prompt-end-marker (point))
	(if (string= command "me")
970
	    (rcirc-print process (rcirc-buffer-nick)
971
			 "ACTION" rcirc-target args)
972
	  (rcirc-print process (rcirc-buffer-nick)
973 974 975
		       "COMMAND" rcirc-target line))
	(set-marker rcirc-prompt-end-marker (point))
	(if (fboundp fun)
976 977
	    (funcall fun args process rcirc-target)
	  (rcirc-send-string process
978
			     (concat command " :" args)))))))
979

Richard M. Stallman's avatar
Richard M. Stallman committed
980 981 982 983 984 985 986 987
(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)))
988
          (parent (buffer-name)))
Richard M. Stallman's avatar
Richard M. Stallman committed
989 990 991
      (delete-region rcirc-prompt-end-marker (point))
      (setq rcirc-window-configuration (current-window-configuration))
      (pop-to-buffer (concat "*multiline " parent "*"))
992 993
      (funcall rcirc-multiline-major-mode)
      (rcirc-multiline-minor-mode 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
994 995
      (setq rcirc-parent-buffer parent)
      (insert text)
996 997
      (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
998

999 1000
(defvar rcirc-multiline-minor-mode-map (make-sparse-keymap)
  "Keymap for multiline mode in rcirc.")
1001
(define-key rcirc-multiline-minor-mode-map
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
  (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
1017
  (make-local-variable 'rcirc-parent-buffer)
1018 1019
  (put 'rcirc-parent-buffer 'permanent-local t)
  (setq fill-column rcirc-max-message-length))
1020 1021

(defun rcirc-multiline-minor-submit ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1022 1023 1024
  "Send the text in buffer back to parent buffer."
  (interactive)
  (assert rcirc-parent-buffer)
1025
  (untabify (point-min) (point-max))
Richard M. Stallman's avatar
Richard M. Stallman committed
1026 1027 1028 1029 1030 1031 1032
  (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)
1033 1034
    (set-window-configuration rcirc-window-configuration)
    (goto-char (+ rcirc-prompt-end-marker (1- pos)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1035

1036
(defun rcirc-multiline-minor-cancel ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1037 1038 1039 1040 1041
  "Cancel the multiline edit."
  (interactive)
  (kill-buffer (current-buffer))
  (set-window-configuration rcirc-window-configuration))

1042
(defun rcirc-any-buffer (process)
1043
  "Return a buffer for PROCESS, either the one selected or the process buffer."
1044 1045 1046 1047 1048 1049
  (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)
1050
		      (eq (rcirc-buffer-process) process))))
1051 1052
	  buffer
	(process-buffer process)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1053

1054
(defcustom rcirc-response-formats
1055 1056 1057
  '(("PRIVMSG" . "%T<%N> %m")
    ("NOTICE"  . "%T-%N- %m")
    ("ACTION"  . "%T[%N %m]")
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
    ("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
1069 1070
  %n        The sender's nick
  %N        The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
1071 1072 1073 1074 1075 1076 1077
  %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
1078
  %f-       Following text uses the default face
1079
  %%        A literal `%' character"
1080 1081 1082 1083 1084
  :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
1085
(defun rcirc-format-response-string (process sender response target text)
1086 1087 1088 1089 1090 1091 1092
  "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)))
		       "%"))
1093
	(sender (or sender ""))
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	(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 ?%)
1106
		   ;; %% -- literal % character
1107
		   "%")
1108 1109
		  ((or (eq key ?n) (eq key ?N))
		   ;; %n/%N -- nick
1110
		   (let ((nick (concat (if (string= (rcirc-server-name process)
1111 1112
						    sender)
					   ""
1113
					 sender)
1114 1115 1116 1117
				       (and target (concat "," target)))))
		     (rcirc-facify nick
				   (