rcirc.el 88.5 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
If nil, use value of `fill-column'.  If 'frame-width, use the
99 100 101 102 103
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
104

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

113 114 115
(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
116

117 118 119 120
(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)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(defvar rcirc-nick-table nil)

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

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

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

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

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

(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
313
(put 'rcirc-urls 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
314

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

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


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
358
(defvar rcirc-last-server-message-time nil)
359 360 361 362 363 364
(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)
365 366

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

      ;; 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
421 422 423
      (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
424 425 426 427 428 429

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

      ;; return process object
      process)))

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

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

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

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

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

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

522 523 524 525 526 527 528 529 530 531 532 533 534
(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))

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

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

564 565 566 567
(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
568
  "Generic server response handler."
569 570 571
  (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
572 573 574

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

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

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

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

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

(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
652

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1053
(defcustom rcirc-response-formats
1054 1055 1056
  '(("PRIVMSG" . "%T<%N> %m")
    ("NOTICE"  . "%T-%N- %m")
    ("ACTION"  . "%T[%N %m]")
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
    ("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
1068 1069
  %n        The sender's nick
  %N        The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
1070 1071 1072 1073 1074 1075 1076
  %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
1077
  %f-       Following text uses the default face
1078
  %%        A literal `%' character"
1079 1080 1081 1082 1083
  :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
1084
(defun rcirc-format-response-string (process sender response target text)
1085 1086 1087 1088 1089 1090 1091
  "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)))
		       "%"))
1092
	(sender (or sender ""))
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
	(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 ?%)
1105
		   ;; %% -- literal % character
1106
		   "%")
1107 1108
		  ((or (eq key ?n) (eq key ?N))
		   ;; %n/%N -- nick
1109
		   (let ((nick (concat (if (string= (rcirc-server-name process)
1110 1111
						    sender)
					   ""
1112
					 sender)
1113 1114 1115 1116
				       (and target (concat "," target)))))
		     (rcirc-facify nick
				   (if (eq key ?n)
				       face
1117 1118
				     (cond ((string= sender (rcirc-nick process))
					    'rcirc-my-nick)
1119
					   ((and rcirc-bright-nicks
1120
						 (string-match
1121 1122
						  (regexp-opt rcirc-bright-nicks)
						  sender))
1123
					    'rcirc-bright-nick)
1124 1125 1126 1127
					   ((and rcirc-dim-nicks
						 (string-match
						  (regexp-opt rcirc-dim-nicks)
						  sender))
1128 1129 1130
					    'rcirc-dim-nick)
					   (t
					    'rcirc-other-nick))))))
1131
		   ((eq key ?T)
1132
		   ;; %T -- timestamp
1133 1134 1135 1136
		   (rcirc-facify
		    (format-time-string rcirc-time-format (current-time))
		    'rcirc-timestamp))
		  ((eq key ?m)
1137
		   ;; %m -- message text
1138
		   (rcirc-markup-text process sender response (rcirc-facify text face)))
1139
		  ((eq key ?t)
1140
		   ;; %t -- target
1141 1142
		   (rcirc-facify (or rcirc-target "") face))
		  ((eq key ?r)
1143
		   ;; %r -- response
1144 1145
		   (rcirc-facify response face))
		  ((eq key ?f)
1146
		   ;; %f -- change face
1147
		   (setq face-key (aref chunk 0))
1148
		   (setq chunk (substring chunk 1))
1149
		   (cond ((eq face-key ?w)
1150
			  ;; %fw -- warning face
1151 1152
			  (setq face 'font-lock-warning-face))
			 ((eq face-key ?p)
1153
			  ;; %fp -- server-prefix face
1154 1155
			  (setq face 'rcirc-server-prefix))
			 ((eq face-key ?s)
1156
			  ;; %fs -- warning face
1157 1158
			  (setq face 'rcirc-server))
			 ((eq face-key ?-)
1159
			  ;; %fs -- warning face
1160 1161
			  (setq face nil))
			 ((and (eq face-key ?\[)
1162
			       (string-match "^\\([^]]*\\)[]]" chunk)
1163
			       (facep (match-string 1 chunk)))
1164
			  ;; %f[...] -- named face
1165
			  (setq face (intern (match-string 1 chunk)))
1166 1167
			  (setq chunk (substring chunk (match-end 0)))))
		   "")))
1168 1169
      (setq result (concat result repl (rcirc-facify chunk face))))
    result))
Richard M. Stallman's avatar
Richard M. Stallman committed
1170

1171 1172 1173 1174 1175
(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)
1176
	   (rcirc-any-buffer process))
1177 1178 1179 1180 1181 1182 1183 1184
	  ((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)
1185
	       (rcirc-any-buffer process))))))
1186

1187 1188
(defvar rcirc-activity-types nil)
(make-variable-buffer-local 'rcirc-activity-types)
1189 1190
(defvar rcirc-last-sender nil)
(make-variable-buffer-local 'rcirc-last-sender)
Miles Bader's avatar
Miles Bader committed
1191

Richard M. Stallman's avatar
Richard M. Stallman committed
1192 1193 1194 1195
(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."
1196
  (or text (setq text ""))
1197
  (unless (or (member sender rcirc-ignore-list)
1198
	      (member (with-syntax-table rcirc-nick-syntax-table
1199 1200 1201
			(when (string-match "^\\([^/]\\w*\\)[:,]" text)
			  (match-string 1 text)))
		      rcirc-ignore-list))
1202
    (let* ((buffer (rcirc-target-buffer process sender response target text))
1203 1204 1205 1206 1207 1208 1209 1210
	   (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
1211
	    (setq text (decode-coding-string text rcirc-decode-coding-system))
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
	    ;; 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)
1223 1224 1225 1226 1227 1228 1229 1230 1231

	  (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)

1232 1233
	    (let ((text-start (make-marker)))
	      (set-marker text-start
1234
			  (or (next-single-property-change fill-start
1235
							   'rcirc-text)
1236
			      rcirc-prompt-end-marker))
1237