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

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

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

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

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

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

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

;;; Commentary:

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

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

;; 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 141 142 143
number.	 If zero or nil, no truncating is done."
  :type '(choice (const :tag "No truncation" nil)
		 (integer :tag "Number of lines"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
144

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

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

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

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

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

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

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

196 197 198 199 200 201 202
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)

203 204 205 206 207 208 209 210 211 212 213 214
(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.")

215 216 217 218 219 220 221 222 223 224 225 226
(defcustom rcirc-bright-nick-regexp nil
  "Regexp matching nicks to be emphasized.
See `rcirc-bright-nick' face."
  :type 'regexp
  :group 'rcirc)

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

227 228 229 230 231
(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
232

233 234 235 236 237
(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)

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

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

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

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

(defvar rcirc-nick nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
275 276 277 278 279
(defvar rcirc-prompt-start-marker nil)
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

280 281 282 283 284 285 286 287
(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.")

288 289 290
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
291
(defvar rcirc-activity nil
292
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
293 294 295 296 297

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

298 299
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
300 301 302 303 304 305

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

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

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


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
352
(defvar rcirc-last-server-message-time nil)
353
(defvar rcirc-server nil)
354 355

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

      ;; 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
400 401 402 403
      (when rcirc-keepalive-seconds
	(unless rcirc-keepalive-timer
	  (setq rcirc-keepalive-timer
		(run-at-time 0 rcirc-keepalive-seconds 'rcirc-keepalive))))
Richard M. Stallman's avatar
Richard M. Stallman committed
404 405 406 407 408 409

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

      ;; return process object
      process)))

410 411 412 413 414
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

415 416 417 418 419
(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
420
(defun rcirc-keepalive ()
421 422 423
  "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
424 425
  (if (rcirc-process-list)
      (mapc (lambda (process)
426
              (with-rcirc-process-buffer process
427 428 429 430
		(if (> (cadr (time-since rcirc-last-server-message-time))
		       rcirc-keepalive-seconds)
		    (kill-process process)
		  (rcirc-send-string process (concat "PING " rcirc-server)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
431 432 433 434
            (rcirc-process-list))
    (cancel-timer rcirc-keepalive-timer)
    (setq rcirc-keepalive-timer nil)))

435 436 437 438
(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
439
  "Add an entry to the debug log including PROCESS and TEXT.
440
Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
441 442
is non-nil."
  (when rcirc-debug-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
443 444
    (save-excursion
      (save-window-excursion
445
        (set-buffer (get-buffer-create rcirc-debug-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
446 447 448 449 450 451
        (goto-char (point-max))
        (insert (concat
                 "["
                 (format-time-string "%Y-%m-%dT%T ") (process-name process)
                 "] "
                 text))))))
452

Richard M. Stallman's avatar
Richard M. Stallman committed
453 454 455 456 457 458 459
(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)))
460 461 462 463
    (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))
464 465 466 467 468 469
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
			       (process-status process)) t)
	  ;; remove the prompt from buffers
Richard M. Stallman's avatar
Richard M. Stallman committed
470 471 472 473 474 475 476 477 478
	  (let ((inhibit-read-only t))
	    (delete-region rcirc-prompt-start-marker
			   rcirc-prompt-end-marker)))))
    (run-hook-with-args 'rcirc-sentinel-hooks process sentinel)))

(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
479
            (when (buffer-live-p (process-buffer p))
480
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
481 482 483 484 485 486
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

(defvar rcirc-receive-message-hooks nil
487 488
  "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
489 490
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
491 492
  (rcirc-debug process output)
  (with-rcirc-process-buffer process
493
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
494 495 496 497 498
    (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))
499
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
500 501
      (setq rcirc-process-output nil))))

502
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
503
(defun rcirc-process-server-response (process text)
504
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
505 506 507 508
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
509
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
510 511 512 513
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
514 515
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
516 517 518 519 520 521
             (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))
522 523
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
524 525 526 527 528 529 530 531 532 533
        (if (not (fboundp handler))
            (rcirc-handler-generic process cmd sender args text)
          (funcall handler process sender args text))
        (run-hook-with-args 'rcirc-receive-message-hooks
                            process cmd sender args text)))
    (message "UNHANDLED: %s" text)))

(defun rcirc-handler-generic (process command sender args text)
  "Generic server response handler."
  (rcirc-print process sender command nil
534
               (mapconcat 'identity (cdr args) " ") t))
Richard M. Stallman's avatar
Richard M. Stallman committed
535 536 537

(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
538
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
539
                        "\n")))
540
    (unless (eq (process-status process) 'open)
541
      (error "Network connection to %s is not open"
542
             (process-name process)))
543
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545
    (process-send-string process string)))

546 547 548
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
Miles Bader's avatar
Miles Bader committed
549 550 551 552
  (get-buffer-process (if buffer
			  (with-current-buffer buffer
			    rcirc-server-buffer)
			rcirc-server-buffer)))
553 554 555

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
556
  (with-rcirc-process-buffer process
557
    (or rcirc-server rcirc-default-server)))
Richard M. Stallman's avatar
Richard M. Stallman committed
558 559 560

(defun rcirc-nick (process)
  "Return PROCESS nick."
561 562 563 564 565 566 567 568 569
  (with-rcirc-process-buffer process 
    (or rcirc-nick rcirc-default-nick)))

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

571
(defvar rcirc-max-message-length 420
Richard M. Stallman's avatar
Richard M. Stallman committed
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
  "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))))
588 589
    (rcirc-get-buffer-create process target)
    (rcirc-print process (rcirc-nick process) response target text)
Richard M. Stallman's avatar
Richard M. Stallman committed
590
    (rcirc-send-string process (concat response " " target " :" text))
591
    (when more (rcirc-send-message process target more noticep))))
Richard M. Stallman's avatar
Richard M. Stallman committed
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

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

Richard M. Stallman's avatar
Richard M. Stallman committed
615 616 617
(defun rcirc-complete-nick ()
  "Cycle through nick completions from list of nicks in channel."
  (interactive)
Miles Bader's avatar
Miles Bader committed
618
  (if (eq last-command this-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
619 620 621 622 623 624 625 626 627 628 629
      (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))
630 631
            (all-completions
	     (buffer-substring
Richard M. Stallman's avatar
Richard M. Stallman committed
632 633 634 635
	      (+ rcirc-prompt-end-marker
		 rcirc-nick-completion-start-offset)
	      (point))
	     (mapcar (lambda (x) (cons x nil))
636 637
		     (rcirc-channel-nicks (rcirc-buffer-process)
					  rcirc-target))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
638 639
  (let ((completion (car rcirc-nick-completions)))
    (when completion
Miles Bader's avatar
Miles Bader committed
640
      (rcirc-put-nick-channel (rcirc-buffer-process) completion rcirc-target)
641
      (delete-region (+ rcirc-prompt-end-marker
Miles Bader's avatar
Miles Bader committed
642 643
			rcirc-nick-completion-start-offset)
		     (point))
Richard M. Stallman's avatar
Richard M. Stallman committed
644
      (insert (concat completion
645
                      (if (= (+ rcirc-prompt-end-marker
Richard M. Stallman's avatar
Richard M. Stallman committed
646 647 648 649
                                rcirc-nick-completion-start-offset)
                             rcirc-prompt-end-marker)
                          ": "))))))

650 651 652 653 654 655 656 657 658
(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
659 660 661 662 663 664 665 666 667 668 669 670

(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)
671
(define-key rcirc-mode-map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
Richard M. Stallman's avatar
Richard M. Stallman committed
672 673 674 675 676 677 678 679 680 681 682
(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
683
  'rcirc-toggle-ignore-buffer-activity)
Richard M. Stallman's avatar
Richard M. Stallman committed
684 685 686
(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)

687
(defvar rcirc-browse-url-map (make-sparse-keymap)
688
  "Keymap used for browsing URLs in `rcirc-mode'.")
689 690 691 692 693 694 695

(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
696 697 698
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

699 700
(defvar rcirc-last-post-time nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
701
(defun rcirc-mode (process target)
702
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
703 704 705 706 707 708 709 710 711

\\{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))
712 713
  (make-local-variable 'rcirc-server-buffer)
  (setq rcirc-server-buffer (process-buffer process))
Richard M. Stallman's avatar
Richard M. Stallman committed
714 715
  (make-local-variable 'rcirc-target)
  (setq rcirc-target target)
716 717
  (make-local-variable 'rcirc-topic)
  (setq rcirc-topic nil)
718 719
  (make-local-variable 'rcirc-last-post-time)
  (setq rcirc-last-post-time (current-time))
720 721 722

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

726 727 728 729 730 731 732
  (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)))
733 734
	(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))))))
735

Richard M. Stallman's avatar
Richard M. Stallman committed
736 737 738 739 740 741 742 743 744 745 746 747 748
  ;; 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)

749 750 751 752 753 754 755
  ;; if the user changes the major mode or kills the buffer, there is
  ;; cleanup work to do
  (make-local-variable 'change-major-mode-hook)
  (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook)
  (make-local-variable 'kill-buffer-hook)
  (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook)

Miles Bader's avatar
Miles Bader committed
756 757 758
  (make-local-variable 'window-scroll-functions)
  (add-hook 'window-scroll-functions 'rcirc-scroll-to-bottom)

759 760 761 762 763 764 765 766
  ;; 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
767 768
  (run-hooks 'rcirc-mode-hook))

769 770
(defun rcirc-update-prompt (&optional all)
  "Reset the prompt string in the current buffer.
771

772 773 774 775 776 777 778 779 780 781 782 783 784
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
785 786 787
		    (replace-regexp-in-string (car rep) (cdr rep) prompt)))
	    (list (cons "%n" (rcirc-buffer-nick))
		  (cons "%s" (with-rcirc-server-buffer (or rcirc-server "")))
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
		  (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
810 811 812 813 814 815 816 817 818 819 820

(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)
821 822 823 824 825 826 827
    (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)
828 829
  (let ((buffer (current-buffer)))
    (rcirc-clear-activity buffer)
830 831 832 833 834
    (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)))
835
      (rcirc-update-short-buffer-names)
Richard M. Stallman's avatar
Richard M. Stallman committed
836
      (if (rcirc-channel-p rcirc-target)
837 838
	  (rcirc-send-string (rcirc-buffer-process)
			     (concat "PART " rcirc-target " :" reason))
839
	(when rcirc-target
840 841
	  (rcirc-remove-nick-channel (rcirc-buffer-process)
				     (rcirc-buffer-nick)
842 843 844 845
				     rcirc-target))))))

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

851
(defun rcirc-get-buffer (process target &optional server)
Richard M. Stallman's avatar
Richard M. Stallman committed
852
  "Return the buffer associated with the PROCESS and TARGET.
853 854 855 856 857 858 859 860

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
861 862

(defun rcirc-get-buffer-create (process target)
863 864 865
  "Return the buffer associated with the PROCESS and TARGET.
Create the buffer if it doesn't exist."
  (let ((buffer (rcirc-get-buffer process target)))
866
    (if (and buffer (buffer-live-p buffer))
867
	(with-current-buffer buffer
868
	  (when (not rcirc-target)
869
 	    (setq rcirc-target target))
870
	  buffer)
871 872 873 874 875 876 877 878
	;; 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
879 880 881 882

(defun rcirc-send-input ()
  "Send input to target associated with the current buffer."
  (interactive)
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
  (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))
899 900 901 902 903 904 905 906 907 908 909 910 911 912
    (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)
913 914 915 916 917 918 919 920
  (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)
921
      (message "Not joined (no target)")
922
    (delete-region rcirc-prompt-end-marker (point))
923 924
    (rcirc-send-message (rcirc-buffer-process) rcirc-target line)
    (setq rcirc-last-post-time (current-time))))
925 926 927 928 929

(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))
930 931
    (let ((fun (intern-soft (concat "rcirc-cmd-" command)))
	  (process (rcirc-buffer-process)))
932 933 934 935
      (newline)
      (with-current-buffer (current-buffer)
	(delete-region rcirc-prompt-end-marker (point))
	(if (string= command "me")
936
	    (rcirc-print process (rcirc-buffer-nick)
937
			 "ACTION" rcirc-target args)
938
	  (rcirc-print process (rcirc-buffer-nick)
939 940 941
		       "COMMAND" rcirc-target line))
	(set-marker rcirc-prompt-end-marker (point))
	(if (fboundp fun)
942 943
	    (funcall fun args process rcirc-target)
	  (rcirc-send-string process
944 945
			     (concat command " " args)))))))

Richard M. Stallman's avatar
Richard M. Stallman committed
946 947 948 949 950 951 952 953
(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)))
954
          (parent (buffer-name)))
Richard M. Stallman's avatar
Richard M. Stallman committed
955 956 957
      (delete-region rcirc-prompt-end-marker (point))
      (setq rcirc-window-configuration (current-window-configuration))
      (pop-to-buffer (concat "*multiline " parent "*"))
958 959
      (funcall rcirc-multiline-major-mode)
      (rcirc-multiline-minor-mode 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
960 961
      (setq rcirc-parent-buffer parent)
      (insert text)
962 963
      (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
964

965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
(defvar rcirc-multiline-minor-mode-map (make-sparse-keymap)
  "Keymap for multiline mode in rcirc.")
(define-key rcirc-multiline-minor-mode-map 
  (kbd "C-c C-c") 'rcirc-multiline-minor-submit)
(define-key rcirc-multiline-minor-mode-map
  (kbd "C-x C-s") 'rcirc-multiline-minor-submit)
(define-key rcirc-multiline-minor-mode-map
  (kbd "C-c C-k") 'rcirc-multiline-minor-cancel)
(define-key rcirc-multiline-minor-mode-map
  (kbd "ESC ESC ESC") 'rcirc-multiline-minor-cancel)

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

(defun rcirc-multiline-minor-submit ()
Richard M. Stallman's avatar
Richard M. Stallman committed
988 989 990
  "Send the text in buffer back to parent buffer."
  (interactive)
  (assert rcirc-parent-buffer)
991
  (untabify (point-min) (point-max))
Richard M. Stallman's avatar
Richard M. Stallman committed
992 993 994 995 996 997 998
  (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)
999 1000
    (set-window-configuration rcirc-window-configuration)
    (goto-char (+ rcirc-prompt-end-marker (1- pos)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1001

1002
(defun rcirc-multiline-minor-cancel ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1003 1004 1005 1006 1007
  "Cancel the multiline edit."
  (interactive)
  (kill-buffer (current-buffer))
  (set-window-configuration rcirc-window-configuration))

1008
(defun rcirc-any-buffer (process)
1009
  "Return a buffer for PROCESS, either the one selected or the process buffer."
1010 1011 1012 1013 1014 1015
  (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)
1016
		      (eq (rcirc-buffer-process) process))))
1017 1018
	  buffer
	(process-buffer process)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1019

1020
(defcustom rcirc-response-formats
1021 1022 1023
  '(("PRIVMSG" . "%T<%N> %m")
    ("NOTICE"  . "%T-%N- %m")
    ("ACTION"  . "%T[%N %m]")
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
    ("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
1035 1036
  %n        The sender's nick
  %N        The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
1037 1038 1039 1040 1041 1042 1043
  %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
1044
  %f-       Following text uses the default face
1045
  %%        A literal `%' character"
1046 1047 1048 1049 1050
  :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
1051
(defun rcirc-format-response-string (process sender response target text)
1052 1053 1054 1055 1056 1057 1058
  "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)))
		       "%"))
1059
	(sender (or sender ""))
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
	(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 ?%)
1072
		   ;; %% -- literal % character
1073
		   "%")
1074 1075
		  ((or (eq key ?n) (eq key ?N))
		   ;; %n/%N -- nick
1076 1077
		   (let ((nick (concat (if (string= (with-rcirc-process-buffer process
						      rcirc-server)
1078 1079
						    sender)
					   ""
1080
					 sender)
1081 1082 1083 1084
				       (and target (concat "," target)))))
		     (rcirc-facify nick
				   (if (eq key ?n)
				       face
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
				     (cond ((string= sender (rcirc-nick process))
					    'rcirc-my-nick)
					   ((and rcirc-bright-nick-regexp
						 (string-match rcirc-bright-nick-regexp sender))
					    'rcirc-bright-nick)
					   ((and rcirc-dim-nick-regexp
						 (string-match rcirc-dim-nick-regexp sender))
					    'rcirc-dim-nick)
					   (t
					    'rcirc-other-nick))))))
1095
		  ((eq key ?T)
1096
		   ;; %T -- timestamp
1097 1098 1099 1100
		   (rcirc-facify
		    (format-time-string rcirc-time-format (current-time))
		    'rcirc-timestamp))
		  ((eq key ?m)
1101 1102 1103
		   ;; %m -- message text
		   ;; We add the text property `rcirc-text' to identify this
		   ;; as the body text.
1104 1105 1106 1107
		   (propertize
		    (rcirc-mangle-text process (rcirc-facify text face))
		    'rcirc-text text))
		  ((eq key ?t)
1108
		   ;; %t -- target
1109 1110
		   (rcirc-facify (or rcirc-target "") face))
		  ((eq key ?r)
1111
		   ;; %r -- response
1112 1113
		   (rcirc-facify response face))
		  ((eq key ?f)
1114
		   ;; %f -- change face
1115
		   (setq face-key (aref chunk 0))
1116
		   (setq chunk (substring chunk 1))
1117
		   (cond ((eq face-key ?w)
1118
			  ;; %fw -- warning face
1119 1120
			  (setq face 'font-lock-warning-face))
			 ((eq face-key ?p)
1121
			  ;; %fp -- server-prefix face
1122 1123
			  (setq face 'rcirc-server-prefix))
			 ((eq face-key ?s)
1124
			  ;; %fs -- warning face
1125 1126
			  (setq face 'rcirc-server))
			 ((eq face-key ?-)
1127
			  ;; %fs -- warning face
1128 1129
			  (setq face nil))
			 ((and (eq face-key ?\[)
1130
			       (string-match "^\\([^]]*\\)[]]" chunk)
1131
			       (facep (match-string 1 chunk)))
1132
			  ;; %f[...] -- named face
1133
			  (setq face (intern (match-string 1 chunk)))
1134 1135
			  (setq chunk (substring chunk (match-end 0)))))
		   "")))
1136 1137
      (setq result (concat result repl (rcirc-facify chunk face))))
    result))
Richard M. Stallman's avatar
Richard M. Stallman committed
1138

1139 1140 1141 1142 1143
(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)
1144
	   (rcirc-any-buffer process))
1145 1146 1147 1148 1149 1150 1151 1152
	  ((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)
1153
	       (rcirc-any-buffer process))))))
1154

Richard M. Stallman's avatar
Richard M. Stallman committed
1155 1156
(defvar rcirc-activity-type nil)
(make-variable-buffer-local 'rcirc-activity-type)
1157 1158 1159 1160
(defvar rcirc-last-sender nil)
(make-variable-buffer-local 'rcirc-last-sender)
(defvar rcirc-gray-toggle nil)
(make-variable-buffer-local 'rcirc-gray-toggle)
Miles Bader's avatar
Miles Bader committed
1161 1162 1163 1164 1165 1166 1167 1168 1169

(defun rcirc-scroll-to-bottom (window display-start)
  "Scroll window to show maximum output if `rcirc-show-maximum-output' is
non-nil."
  (when rcirc-show-maximum-output
    (with-selected-window window
      (when (>= (window-point) rcirc-prompt-end-marker)
	(recenter -1)))))

Richard M. Stallman's avatar
Richard M. Stallman committed
1170 1171 1172 1173
(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."
1174
  (or text (setq text ""))
1175
  (unless (or (member sender rcirc-ignore-list)
1176
	      (member (with-syntax-table rcirc-nick-syntax-table
1177 1178 1179
			(when (string-match "^\\([^/]\\w*\\)[:,]" text)
			  (match-string 1 text)))
		      rcirc-ignore-list))
1180
    (let* ((buffer (rcirc-target-buffer process sender response target text))
1181 1182 1183 1184 1185 1186 1187 1188
	   (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
1189
	    (setq text (decode-coding-string text rcirc-decode-coding-system))
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
	    ;; 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)
1201 1202 1203 1204 1205 1206 1207 1208 1209

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

1210 1211 1212 1213
	    (let ((text-start (make-marker)))
	      (set-marker text-start
			  (or (next-single-property-change fill-start 
							   'rcirc-text)
1214
			      rcirc-prompt-end-marker))
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
	      ;; squeeze spaces out of text before rcirc-text
	      (fill-region fill-start (1- text-start))

	      ;; fill the text we just inserted, maybe
	      (when (and rcirc-fill-flag
			 (not (string= response "372"))) ;/motd
		(let ((fill-prefix
		       (or rcirc-fill-prefix
			   (make-string (- text-start fill-start) ?\s)))
		      (fill-column (cond ((eq rcirc-fill-column 'frame-width)
					  (1- (frame-width)))
					 (rcirc-fill-column
					  rcirc-fill-column)
					 (t fill-column))))
		  (fill-region fill-start rcirc-prompt-start-marker 'left t)))))
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265

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

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

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

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

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

	;; record modeline activity
	(when activity
	  (let ((nick-match
Miles Bader's avatar
Miles Bader committed
1266 1267 1268 1269 1270
		 (with-syntax-table rcirc-nick-syntax-table		 
		   (string-match (concat "\\b"
					 (regexp-quote (rcirc-nick process))
					 "\\b")
				 text))))
1271 1272 1273
	    (when (if rcirc-ignore-buffer-activity-flag
		      ;; - Always notice when our nick is mentioned
		      nick-match
Miles Bader's avatar
Miles Bader committed
1274 1275 1276 1277 1278
		    ;; - unless our nick is mentioned, don't bother us
		    ;; - with dim-nicks
		    (or nick-match
			(not (and rcirc-dim-nick-regexp sender
				  (string-match rcirc-dim-nick-regexp sender)))))
1279 1280
	      (rcirc-record-activity
	       (current-buffer)
1281 1282
	       (when (or nick-match (and (not (rcirc-channel-p rcirc-target))
					 (not rcirc-low-priority-flag)))
1283 1284 1285 1286 1287
		 'nick)))))

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

(defun rcirc-startup-channels (server)
1290
  "Return the list of startup channels for SERVER."
Richard M. Stallman's avatar
Richard M. Stallman committed
1291 1292 1293 1294 1295 1296 1297 1298 1299
  (let (channels)
    (dolist (i rcirc-startup-channels-alist)
      (if (string-match (car i) server)
          (setq channels (append channels (cdr i)))))
    channels))

(defun rcirc-join-channels (process channels)
  "Join CHANNELS."
  (save-window-excursion
1300 1301 1302
    (dolist (channel channels)
      (with-rcirc-process-buffer process
	(rcirc-cmd-join channel process)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1303 1304 1305 1306

;;; nick management
(defun rcirc-user-nick (user)
  "Return the nick from USER.  Remove any non-nick junk."
1307 1308 1309 1310
  (save-match-data
    (if (string-match "^[@%+]?\\([^! ]+\\)!?" (or user ""))
	(match-string 1 user)
      user)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1311 1312 1313 1314 1315 1316 1317 1318 1319

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

(defun rcirc-nick-channels (process nick)
  "Return list of channels for NICK."
1320 1321 1322
  (with-rcirc-process-buffer process
    (mapcar (lambda (x) (car x))
	    (gethash nick rcirc-nick-table))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1323 1324 1325

(defun rcirc-put-nick-channel (process nick channel)
  "Add CHANNEL to list associated with NICK."
1326 1327 1328 1329 1330 1331 1332 1333 1334
  (let ((nick (rcirc-user-nick nick)))
    (with-rcirc-process-buffer process
      (let* ((chans (gethash nick rcirc-nick-table))
	     (record (assoc-string channel chans t)))
	(if record
	    (setcdr record (current-time))
	  (puthash nick (cons (cons channel (current-time))
			      chans)
		   rcirc-nick-table))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1335 1336 1337

(defun rcirc-nick-remove (process nick)
  "Remove NICK from table."
1338
  (with-rcirc-process-buffer process
Richard M. Stallman's avatar
Richard M. Stallman committed
1339 1340 1341 1342
    (remhash nick rcirc-nick-table)))

(defun rcirc-remove-nick-channel (process nick channel)
  "Remove the CHANNEL from list associated with NICK."
1343
  (with-rcirc-process-buffer process
1344
    (let* ((chans (gethash nick rcirc-nick-table))
1345 1346 1347