rcirc.el 98.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, 2008, 2009, 2010 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
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
15

16
;; GNU Emacs is distributed in the hope that it will be useful,
Richard M. Stallman's avatar
Richard M. Stallman committed
17
;; 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
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
23 24 25

;;; Commentary:

26 27 28 29 30
;; 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.

Glenn Morris's avatar
Glenn Morris committed
31
;; Rcirc has simple defaults and clear and consistent behavior.
32 33 34 35 36
;; 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
37 38 39 40

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

Miles Bader's avatar
Miles Bader committed
41 42
;;; Todo:

Richard M. Stallman's avatar
Richard M. Stallman committed
43 44 45 46 47 48
;;; Code:

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

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

56
(defcustom rcirc-server-alist
57 58 59 60 61 62 63
  '(("irc.freenode.net" :channels ("#rcirc")))
  "An alist of IRC connections to establish when running `rcirc'.
Each element looks like (SERVER-NAME PARAMETERS).

SERVER-NAME is a string describing the server to connect
to.

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
The optional PARAMETERS come in pairs PARAMETER VALUE.

The following parameters are recognized:

`:nick'

VALUE must be a string.  If absent, `rcirc-default-nick' is used
for this connection.

`:port'

VALUE must be a number or string.  If absent,
`rcirc-default-port' is used.

`:user-name'

VALUE must be a string.  If absent, `rcirc-default-user-name' is
used.

`:full-name'

VALUE must be a string.  If absent, `rcirc-default-full-name' is
used.

Ryan Yeske's avatar
Ryan Yeske committed
88 89 90 91
`:pass'

VALUE must be a string.

92 93 94 95 96 97
`:channels'

VALUE must be a list of strings describing which channels to join
when connecting to this server.  If absent, no channels will be
connected to automatically."
  :type '(alist :key-type string
98 99 100 101
		:value-type (plist :options ((:nick string)
					     (:port integer)
					     (:user-name string)
					     (:full-name string)
Ryan Yeske's avatar
Ryan Yeske committed
102
					     (:pass string)
103
					     (:channels (repeat string)))))
104
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
105

106
(defcustom rcirc-default-port 6667
107 108 109
  "The default port to connect to."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
110

111
(defcustom rcirc-default-nick (user-login-name)
112 113 114
  "Your nick."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
115

Ryan Yeske's avatar
Ryan Yeske committed
116
(defcustom rcirc-default-user-name "user"
117 118 119
  "Your user name sent to the server when connecting."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
120

Ryan Yeske's avatar
Ryan Yeske committed
121
(defcustom rcirc-default-full-name "unknown"
122 123 124
  "The full name sent to the server when connecting."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
125

126 127 128 129
(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
130

131 132
(defcustom rcirc-fill-column nil
  "*Column beyond which automatic line-wrapping should happen.
133 134
If nil, use value of `fill-column'.  If 'frame-width, use the
maximum frame width."
135 136 137 138
  :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
139

140
(defcustom rcirc-fill-prefix nil
Richard M. Stallman's avatar
Richard M. Stallman committed
141 142
  "*Text to insert before filled lines.
If nil, calculate the prefix dynamically to line up text
143 144 145 146
underneath each nick."
  :type '(choice (const :tag "Dynamic" nil)
		 (string :tag "Prefix text"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
147

148 149 150
(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
151

152 153 154 155
(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)

156 157 158 159 160
(defvar rcirc-omit-mode nil
  "Non-nil if Rcirc-Omit mode is enabled.
Use the command `rcirc-omit-mode' to change this variable.")
(make-variable-buffer-local 'rcirc-omit-mode)

161
(defcustom rcirc-time-format "%H:%M "
Richard M. Stallman's avatar
Richard M. Stallman committed
162
  "*Describes how timestamps are printed.
163 164 165
Used as the first arg to `format-time-string'."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
166

167 168 169 170
(defcustom rcirc-input-ring-size 1024
  "*Size of input history ring."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
171

172
(defcustom rcirc-read-only-flag t
173
  "*Non-nil means make text in IRC buffers read-only."
174 175
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
176

177
(defcustom rcirc-buffer-maximum-lines nil
Richard M. Stallman's avatar
Richard M. Stallman committed
178 179
  "*The maximum size in lines for rcirc buffers.
Channel buffers are truncated from the top to be no greater than this
180
number.  If zero or nil, no truncating is done."
181 182 183
  :type '(choice (const :tag "No truncation" nil)
		 (integer :tag "Number of lines"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
184

185
(defcustom rcirc-scroll-show-maximum-output t
186 187
  "*If non-nil, scroll buffer to keep the point at the bottom of
the window."
188 189
  :type 'boolean
  :group 'rcirc)
Miles Bader's avatar
Miles Bader committed
190

191 192 193 194 195 196 197
(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
198

199 200
The ARGUMENTS for each METHOD symbol are:
  `nickserv': NICK PASSWORD [NICKSERV-NICK]
201 202
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
203

204
Examples:
205 206
 ((\"freenode\" nickserv \"bob\" \"p455w0rd\")
  (\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
207 208
  (\"bitlbee\" bitlbee \"robert\" \"sekrit\")
  (\"dal.net\" nickserv \"bob\" \"sekrit\" \"NickServ@services.dal.net\"))"
209 210 211 212 213 214 215 216 217 218 219 220 221 222
  :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"))))
223
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
224

225
(defcustom rcirc-auto-authenticate-flag t
Richard M. Stallman's avatar
Richard M. Stallman committed
226
  "*Non-nil means automatically send authentication string to server.
227
See also `rcirc-authinfo'."
228 229
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
230

231
(defcustom rcirc-prompt "> "
232
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
233 234 235 236 237 238

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

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

246 247 248 249 250
(defcustom rcirc-keywords nil
  "List of keywords to highlight in message text."
  :type '(repeat string)
  :group 'rcirc)

251 252 253 254 255 256 257 258 259 260 261 262
(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.")

263 264
(defcustom rcirc-bright-nicks nil
  "List of nicks to be emphasized.
265
See `rcirc-bright-nick' face."
266
  :type '(repeat string)
267 268
  :group 'rcirc)

269 270
(defcustom rcirc-dim-nicks nil
  "List of nicks to be deemphasized.
271
See `rcirc-dim-nick' face."
272
  :type '(repeat string)
273 274
  :group 'rcirc)

275 276 277 278 279
(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
280

281 282 283 284 285
(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)

286
(defcustom rcirc-decode-coding-system 'utf-8
287 288 289 290 291 292 293 294 295 296
  "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
297
  "Alist to decide a coding system to use for a channel I/O operation.
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
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
323 324 325 326 327
(defvar rcirc-prompt-start-marker nil)
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

328 329 330
(defvar rcirc-recent-quit-alist nil
  "Alist of nicks that have recently quit or parted the channel.")

331 332 333 334 335 336 337 338
(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.")

339 340 341
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
342
(defvar rcirc-activity nil
343
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
344 345 346 347 348

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

349 350
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
351 352 353 354 355 356

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

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

362
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
363 364

(defvar rcirc-startup-channels nil)
365

366 367 368 369 370 371 372 373 374
(defvar rcirc-server-name-history nil
  "History variable for \\[rcirc] call.")

(defvar rcirc-server-port-history nil
  "History variable for \\[rcirc] call.")

(defvar rcirc-nick-name-history nil
  "History variable for \\[rcirc] call.")

Ryan Yeske's avatar
Ryan Yeske committed
375 376 377
(defvar rcirc-user-name-history nil
  "History variable for \\[rcirc] call.")

Richard M. Stallman's avatar
Richard M. Stallman committed
378
;;;###autoload
379
(defun rcirc (arg)
380
  "Connect to all servers in `rcirc-server-alist'.
381 382 383 384

Do not connect to a server if it is already connected.

If ARG is non-nil, instead prompt for connection parameters."
385 386
  (interactive "P")
  (if arg
387 388
      (let* ((server (completing-read "IRC Server: "
				      rcirc-server-alist
389
				      nil nil
390 391
				      (caar rcirc-server-alist)
				      'rcirc-server-name-history))
392 393
	     (server-plist (cdr (assoc-string server rcirc-server-alist)))
	     (port (read-string "IRC Port: "
394
				(number-to-string
395
				 (or (plist-get server-plist :port)
396 397
				     rcirc-default-port))
				'rcirc-server-port-history))
398
	     (nick (read-string "IRC Nick: "
399
				(or (plist-get server-plist :nick)
400 401
				    rcirc-default-nick)
				'rcirc-nick-name-history))
Ryan Yeske's avatar
Ryan Yeske committed
402 403 404 405 406 407
	     (user-name (read-string "IRC Username: "
                                     (or (plist-get server-plist :user-name)
                                         rcirc-default-user-name)
                                     'rcirc-user-name-history))
	     (pass (read-passwd "IRC Password: " nil
				(plist-get server-plist :pass)))
408 409
	     (channels (split-string
			(read-string "IRC Channels: "
410
				     (mapconcat 'identity
411
						(plist-get server-plist
412
							   :channels)
413
						" "))
414
			"[, ]+" t)))
Ryan Yeske's avatar
Ryan Yeske committed
415
	(rcirc-connect server port nick user-name pass
416
		       rcirc-default-full-name
417
		       channels))
418
    ;; connect to servers in `rcirc-server-alist'
419
    (let (connected-servers)
420
      (dolist (c rcirc-server-alist)
421
	(let ((server (car c))
422 423 424
	      (nick (or (plist-get (cdr c) :nick) rcirc-default-nick))
	      (port (or (plist-get (cdr c) :port) rcirc-default-port))
	      (user-name (or (plist-get (cdr c) :user-name)
425
			     rcirc-default-user-name))
Ryan Yeske's avatar
Ryan Yeske committed
426
              (pass (plist-get (cdr c) :pass))
427 428 429
	      (full-name (or (plist-get (cdr c) :full-name)
			     rcirc-default-full-name))
	      (channels (plist-get (cdr c) :channels)))
430 431 432 433 434 435 436
	  (when server
	    (let (connected)
	      (dolist (p (rcirc-process-list))
		(when (string= server (process-name p))
		  (setq connected p)))
	      (if (not connected)
		  (condition-case e
Ryan Yeske's avatar
Ryan Yeske committed
437
		      (rcirc-connect server port nick user-name pass
438
				     full-name channels)
439
		    (quit (message "Quit connecting to %s" server)))
440 441 442 443 444 445 446
		(with-current-buffer (process-buffer connected)
		  (setq connected-servers
			(cons (process-contact (get-buffer-process
						(current-buffer)) :host)
			      connected-servers))))))))
      (when connected-servers
	(message "Already connected to %s"
447 448 449 450 451
		 (if (cdr connected-servers)
		     (concat (mapconcat 'identity (butlast connected-servers) ", ")
			     ", and "
			     (car (last connected-servers)))
		   (car connected-servers)))))))
452

Richard M. Stallman's avatar
Richard M. Stallman committed
453 454 455 456 457 458 459
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
460
(defvar rcirc-last-server-message-time nil)
461 462 463 464 465 466
(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)
467 468

;;;###autoload
Ryan Yeske's avatar
Ryan Yeske committed
469 470
(defun rcirc-connect (server &optional port nick user-name pass
                             full-name startup-channels)
Richard M. Stallman's avatar
Richard M. Stallman committed
471 472 473
  (save-excursion
    (message "Connecting to %s..." server)
    (let* ((inhibit-eol-conversion)
474 475 476 477
           (port-number (if port
			    (if (stringp port)
				(string-to-number port)
			      port)
478 479 480
			  rcirc-default-port))
	   (nick (or nick rcirc-default-nick))
	   (user-name (or user-name rcirc-default-user-name))
481
	   (full-name (or full-name rcirc-default-full-name))
482
	   (startup-channels startup-channels)
483
           (process (make-network-process :name server :host server :service port-number)))
Richard M. Stallman's avatar
Richard M. Stallman committed
484 485
      ;; set up process
      (set-process-coding-system process 'raw-text 'raw-text)
486
      (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
487 488
      (set-process-buffer process (current-buffer))
      (rcirc-mode process nil)
489 490
      (set-process-sentinel process 'rcirc-sentinel)
      (set-process-filter process 'rcirc-filter)
491 492
      (make-local-variable 'rcirc-process)
      (setq rcirc-process process)
493 494
      (make-local-variable 'rcirc-server)
      (setq rcirc-server server)
495 496
      (make-local-variable 'rcirc-server-name)
      (setq rcirc-server-name server)	; update when we get 001 response
497 498
      (make-local-variable 'rcirc-buffer-alist)
      (setq rcirc-buffer-alist nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
499 500 501 502 503 504 505 506
      (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)
507 508
      (make-local-variable 'rcirc-last-server-message-time)
      (setq rcirc-last-server-message-time (current-time))
509 510 511 512 513 514
      (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
515

516 517
      (add-hook 'auto-save-hook 'rcirc-log-write)

Richard M. Stallman's avatar
Richard M. Stallman committed
518
      ;; identify
Ryan Yeske's avatar
Ryan Yeske committed
519 520
      (when pass
        (rcirc-send-string process (concat "PASS " pass)))
Richard M. Stallman's avatar
Richard M. Stallman committed
521 522
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
Ryan Yeske's avatar
Ryan Yeske committed
523
                                         " 0 * :" full-name))
Richard M. Stallman's avatar
Richard M. Stallman committed
524 525

      ;; setup ping timer if necessary
526 527 528
      (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
529 530 531 532 533 534

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

      ;; return process object
      process)))

535 536 537 538 539
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

540 541 542 543 544
(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
545
(defun rcirc-keepalive ()
546 547 548
  "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
549 550
  (if (rcirc-process-list)
      (mapc (lambda (process)
551 552
	      (with-rcirc-process-buffer process
		(when (not rcirc-connecting)
553
		  (rcirc-send-string process
554 555
				     (format "PRIVMSG %s :\C-aKEEPALIVE %f\C-a"
					     rcirc-nick
556 557 558 559
                                             (if (featurep 'xemacs)
                                                 (time-to-seconds
                                                  (current-time))
                                               (float-time)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
560
            (rcirc-process-list))
561
    ;; no processes, clean up timer
Richard M. Stallman's avatar
Richard M. Stallman committed
562 563 564
    (cancel-timer rcirc-keepalive-timer)
    (setq rcirc-keepalive-timer nil)))

565 566
(defun rcirc-handler-ctcp-KEEPALIVE (process target sender message)
  (with-rcirc-process-buffer process
567 568 569 570
    (setq header-line-format (format "%f" (- (if (featurep 'xemacs)
                                                 (time-to-seconds
                                                  (current-time))
                                               (float-time))
571 572
					     (string-to-number message))))))

573 574 575 576
(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
577
  "Add an entry to the debug log including PROCESS and TEXT.
578
Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
579 580
is non-nil."
  (when rcirc-debug-flag
581
    (with-current-buffer (get-buffer-create rcirc-debug-buffer)
582 583 584 585 586 587
      (goto-char (point-max))
      (insert (concat
	       "["
	       (format-time-string "%Y-%m-%dT%T ") (process-name process)
	       "] "
	       text)))))
588

Richard M. Stallman's avatar
Richard M. Stallman committed
589 590 591 592 593 594 595
(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)))
596 597 598 599
    (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))
600 601 602 603
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
604
			       (process-status process)) (not rcirc-target))
605
	  (rcirc-disconnect-buffer)))
606
      (run-hook-with-args 'rcirc-sentinel-hooks process sentinel))))
Richard M. Stallman's avatar
Richard M. Stallman committed
607

608 609 610 611 612
(defun rcirc-disconnect-buffer (&optional buffer)
  (with-current-buffer (or buffer (current-buffer))
    ;; set rcirc-target to nil for each channel so cleanup
    ;; doesnt happen when we reconnect
    (setq rcirc-target nil)
613
    (setq mode-line-process ":disconnected")))
614

Richard M. Stallman's avatar
Richard M. Stallman committed
615 616 617 618
(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
619
            (when (buffer-live-p (process-buffer p))
620
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
621 622 623 624 625 626
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

(defvar rcirc-receive-message-hooks nil
627 628
  "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
629 630
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
631
  (rcirc-debug process output)
632
  (rcirc-reschedule-timeout process)
633
  (with-rcirc-process-buffer process
634
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
635 636 637 638 639
    (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))
640
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
641 642
      (setq rcirc-process-output nil))))

643 644 645 646 647 648 649 650 651 652 653 654
(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)
  (delete-process process))

655
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
656
(defun rcirc-process-server-response (process text)
657
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
658 659 660 661
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
662
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
663 664 665 666
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
667 668
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
669 670 671 672 673 674
             (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))
675 676
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
677 678 679 680 681 682 683
        (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)))

684 685 686 687
(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
688
  "Generic server response handler."
689 690 691
  (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
692 693 694

(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
695
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
696
                        "\n")))
697
    (unless (eq (process-status process) 'open)
698
      (error "Network connection to %s is not open"
699
             (process-name process)))
700
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
701 702
    (process-send-string process string)))

703 704 705
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
706 707 708 709 710
  (or (get-buffer-process (if buffer
			      (with-current-buffer buffer
				rcirc-server-buffer)
			    rcirc-server-buffer))
      rcirc-process))
711 712 713

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
714
  (with-rcirc-process-buffer process
715 716
    (or rcirc-server-name
	(warn "server name for process %S unknown" process))))
Richard M. Stallman's avatar
Richard M. Stallman committed
717 718 719

(defun rcirc-nick (process)
  "Return PROCESS nick."
720
  (with-rcirc-process-buffer process
721 722 723 724 725 726 727 728
    (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
729

730
(defvar rcirc-max-message-length 420
Richard M. Stallman's avatar
Richard M. Stallman committed
731 732
  "Messages longer than this value will be split.")

733
(defun rcirc-send-message (process target message &optional noticep silent)
Richard M. Stallman's avatar
Richard M. Stallman committed
734
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
735 736
If NOTICEP is non-nil, send a notice instead of privmsg.
If SILENT is non-nil, do not print the message in any irc buffer."
Richard M. Stallman's avatar
Richard M. Stallman committed
737 738 739 740 741 742 743 744 745 746 747
  ;; 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))))
748
    (rcirc-get-buffer-create process target)
Richard M. Stallman's avatar
Richard M. Stallman committed
749
    (rcirc-send-string process (concat response " " target " :" text))
750 751
    (unless silent
      (rcirc-print process (rcirc-nick process) response target text))
752
    (when more (rcirc-send-message process target more noticep))))
Richard M. Stallman's avatar
Richard M. Stallman committed
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

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

Richard M. Stallman's avatar
Richard M. Stallman committed
776 777 778
(defun rcirc-complete-nick ()
  "Cycle through nick completions from list of nicks in channel."
  (interactive)
Miles Bader's avatar
Miles Bader committed
779
  (if (eq last-command this-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
780 781 782 783 784 785 786 787 788 789 790
      (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))
791 792
            (all-completions
	     (buffer-substring
Richard M. Stallman's avatar
Richard M. Stallman committed
793 794 795 796
	      (+ rcirc-prompt-end-marker
		 rcirc-nick-completion-start-offset)
	      (point))
	     (mapcar (lambda (x) (cons x nil))
797 798
		     (rcirc-channel-nicks (rcirc-buffer-process)
					  rcirc-target))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
799 800
  (let ((completion (car rcirc-nick-completions)))
    (when completion
801
      (delete-region (+ rcirc-prompt-end-marker
Miles Bader's avatar
Miles Bader committed
802 803
			rcirc-nick-completion-start-offset)
		     (point))
Richard M. Stallman's avatar
Richard M. Stallman committed
804
      (insert (concat completion
805
                      (if (= (+ rcirc-prompt-end-marker
Richard M. Stallman's avatar
Richard M. Stallman committed
806 807 808 809
                                rcirc-nick-completion-start-offset)
                             rcirc-prompt-end-marker)
                          ": "))))))

810 811 812 813 814 815 816 817 818
(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
819 820 821 822 823 824 825 826 827 828 829 830

(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)
831
(define-key rcirc-mode-map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
Richard M. Stallman's avatar
Richard M. Stallman committed
832 833 834
(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
835
(define-key rcirc-mode-map (kbd "C-c C-o") 'rcirc-omit-mode)
836
(define-key rcirc-mode-map (kbd "M-o") 'rcirc-omit-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
837 838 839 840 841 842 843
(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
844
  'rcirc-toggle-ignore-buffer-activity)
Richard M. Stallman's avatar
Richard M. Stallman committed
845 846 847
(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)

848
(defvar rcirc-browse-url-map (make-sparse-keymap)
849
  "Keymap used for browsing URLs in `rcirc-mode'.")
850 851 852

(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)
853
(define-key rcirc-browse-url-map [follow-link] 'mouse-face)
854 855 856 857

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

Richard M. Stallman's avatar
Richard M. Stallman committed
858 859 860
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

861 862
(defvar rcirc-last-post-time nil)

863 864 865 866
(defvar rcirc-log-alist nil
  "Alist of lines to log to disk when `rcirc-log-flag' is non-nil.
Each element looks like (FILENAME . TEXT).")

867 868 869 870
(defvar rcirc-current-line 0
  "The current number of responses printed in this channel.
This number is independent of the number of lines in the buffer.")

Richard M. Stallman's avatar
Richard M. Stallman committed
871
(defun rcirc-mode (process target)
872
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
873 874 875 876 877 878

\\{rcirc-mode-map}"
  (kill-all-local-variables)
  (use-local-map rcirc-mode-map)
  (setq mode-name "rcirc")
  (setq major-mode 'rcirc-mode)
879
  (setq mode-line-process nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
880 881 882

  (make-local-variable 'rcirc-input-ring)
  (setq rcirc-input-ring (make-ring rcirc-input-ring-size))
883 884
  (make-local-variable 'rcirc-server-buffer)
  (setq rcirc-server-buffer (process-buffer process))
Richard M. Stallman's avatar
Richard M. Stallman committed
885 886
  (make-local-variable 'rcirc-target)
  (setq rcirc-target target)
887 888
  (make-local-variable 'rcirc-topic)
  (setq rcirc-topic nil)
889 890
  (make-local-variable 'rcirc-last-post-time)
  (setq rcirc-last-post-time (current-time))
891 892
  (make-local-variable 'fill-paragraph-function)
  (setq fill-paragraph-function 'rcirc-fill-paragraph)
893 894 895 896
  (make-local-variable 'rcirc-recent-quit-alist)
  (setq rcirc-recent-quit-alist nil)
  (make-local-variable 'rcirc-current-line)
  (setq rcirc-current-line 0)
897 898 899

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

903 904 905 906 907 908 909 910
  ;; setup for omitting responses
  (setq buffer-invisibility-spec '())
  (setq buffer-display-table (make-display-table))
  (set-display-table-slot buffer-display-table 4
			  (let ((glyph (make-glyph-code 
					?. 'font-lock-keyword-face)))
			    (make-vector 3 glyph)))

911 912 913 914 915 916 917
  (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)))
918 919
	(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))))))
920

Richard M. Stallman's avatar
Richard M. Stallman committed
921 922 923 924 925 926 927 928 929 930 931 932 933
  ;; 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)

934 935
  ;; if the user changes the major mode or kills the buffer, there is
  ;; cleanup work to do
936 937
  (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook nil t)
  (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook nil t)
938

939 940 941 942 943 944 945 946
  ;; 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
947 948
  (run-hooks 'rcirc-mode-hook))

949 950
(defun rcirc-update-prompt (&optional all)
  "Reset the prompt string in the current buffer.
951

952 953 954 955 956 957 958 959 960 961 962 963 964
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
965 966
		    (replace-regexp-in-string (car rep) (cdr rep) prompt)))
	    (list (cons "%n" (rcirc-buffer-nick))
967
		  (cons "%s" (with-rcirc-server-buffer rcirc-server-name))
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
		  (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
990 991 992 993 994 995 996 997 998 999 1000

(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)
1001 1002 1003 1004 1005 1006 1007
    (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)
1008 1009
  (let ((buffer (current-buffer)))
    (rcirc-clear-activity buffer)
1010 1011 1012 1013 1014
    (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)))
1015
      (rcirc-update-short-buffer-names)
Richard M. Stallman's avatar
Richard M. Stallman committed
1016
      (if (rcirc-channel-p rcirc-target)
1017 1018
	  (rcirc-send-string (rcirc-buffer-process)
			     (concat "PART " rcirc-target " :" reason))
1019
	(when rcirc-target
1020 1021
	  (rcirc-remove-nick-channel (rcirc-buffer-process)
				     (rcirc-buffer-nick)
1022 1023
				     rcirc-target))))
    (setq rcirc-target nil)))
1024 1025 1026

(defun rcirc-generate-new-buffer-name (process target)
  "Return a buffer name based on PROCESS and TARGET.
1027
This is used for the initial name given to IRC buffers."
1028 1029 1030 1031
  (substring-no-properties
   (if target
       (concat target "@" (process-name process))
     (concat "*" (process-name process) "*"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1032

1033
(defun rcirc-get-buffer (process target &optional server)
Richard M. Stallman's avatar
Richard M. Stallman committed
1034
  "Return the buffer associated with the PROCESS and TARGET.
1035 1036 1037 1038 1039 1040 1041 1042

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
1043 1044

(defun rcirc-get-buffer-create (process target)
1045 1046 1047
  "Return the buffer associated with the PROCESS and TARGET.
Create the buffer if it doesn't exist."
  (let ((buffer (rcirc-get-buffer process target)))
1048
    (if (and buffer (buffer-live-p buffer))
1049
	(with-current-buffer buffer
1050
	  (when (not rcirc-target)
1051
 	    (setq rcirc-target target))
1052
	  buffer)
1053 1054 1055 1056 1057
      ;; 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
1058 1059 1060
	    (rcirc-mode process target)
	    (rcirc-put-nick-channel process (rcirc-nick process) target 
				    rcirc-current-line))
1061
	  new-buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1062 1063 1064 1065

(defun rcirc-send-input ()
  "Send input to target associated with the current buffer."
  (interactive)
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
  (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))
1082 1083
    (when (not (equal 0 (- (point) rcirc-prompt-end-marker)))
      ;; delete a trailing newline
1084 1085
      (when (bolp)
	(delete-char -1))
1086 1087 1088 1089 1090 1091 1092 1093 1094
      (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))))))

1095 1096 1097 1098 1099 1100 1101 1102
(defun rcirc-fill-paragraph (&optional arg)
  (interactive "p")
  (when (> (point) rcirc-prompt-end-marker)
    (save-restriction
      (narrow-to-region rcirc-prompt-end-marker (point-max))
      (let ((fill-column rcirc-max-message-length))
	(fill-region (point-min) (point-max))))))

1103
(defun rcirc-process-input-line (line)
1104 1105 1106 1107 1108 1109 1110 1111
  (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)
1112
      (message "Not joined (no target)")
1113
    (delete-region rcirc-prompt-end-marker (point))
1114 1115
    (rcirc-send-message (rcirc-buffer-process) rcirc-target line)
    (setq rcirc-last-post-time (current-time))))
1116 1117 1118 1119 1120

(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))
1121 1122
    (let ((fun (intern-soft (concat "rcirc-cmd-" command)))
	  (process (rcirc-buffer-process)))
1123 1124 1125 1126
      (newline)
      (with-current-buffer (current-buffer)
	(delete-region rcirc-prompt-end-marker (point))
	(if (string= command "me")
1127
	    (rcirc-print process (rcirc-buffer-nick)
1128
			 "ACTION" rcirc-target args)
1129
	  (rcirc-print process (rcirc-buffer-nick)
1130 1131 1132
		       "COMMAND" rcirc-target line))
	(set-marker rcirc-prompt-end-marker (point))
	(if (fboundp fun)
1133 1134
	    (funcall fun args process rcirc-target)
	  (rcirc-send-string process
1135
			     (concat command " :" args)))))))
1136

Richard M. Stallman's avatar
Richard M. Stallman committed
1137 1138 1139 1140 1141 1142 1143
(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))
1144 1145
    (let ((text (buffer-substring-no-properties rcirc-prompt-end-marker 
						(point)))
1146
          (parent (buffer-name)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1147 1148 1149
      (delete-region rcirc-prompt-end-marker (point))
      (setq rcirc-window-configuration (current-window-configuration))
      (pop-to-buffer (concat "*multiline " parent "*"))
1150 1151
      (funcall rcirc-multiline-major-mode)
      (rcirc-multiline-minor-mode 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
1152 1153
      (setq rcirc-parent-buffer parent)
      (insert text)
1154 1155
      (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
1156

1157 1158
(defvar rcirc-multiline-minor-mode-map (make-sparse-keymap)
  "Keymap for multiline mode in rcirc.")
1159
(define-key rcirc-multiline-minor-mode-map
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
  (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
1175
  (make-local-variable 'rcirc-parent-buffer)
1176 1177
  (put 'rcirc-parent-buffer 'permanent-local t)
  (setq fill-column rcirc-max-message-length))
1178 1179

(defun rcirc-multiline-minor-submit ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1180 1181
  "Send the text in buffer back to parent buffer."
  (interactive)
1182
  (untabify (point-min) (point-max))
Richard M. Stallman's avatar
Richard M. Stallman committed
1183 1184 1185 1186 1187 1188 1189
  (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)
1190 1191
    (set-window-configuration rcirc-window-configuration)
    (goto-char (+ rcirc-prompt-end-marker (1- pos)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1192

1193
(defun rcirc-multiline-minor-cancel ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1194 1195 1196 1197 1198
  "Cancel the multiline edit."
  (interactive)
  (kill-buffer (current-buffer))
  (set-window-configuration rcirc-window-configuration))

1199
(defun rcirc-any-buffer (process)
1200
  "Return a buffer for PROCESS, either the one selected or the process buffer."
1201 1202 1203 1204 1205 1206
  (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)
1207
		      (eq (rcirc-buffer-process) process))))
1208 1209
	  buffer
	(process-buffer process)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1210

1211
(defcustom rcirc-response-formats
1212 1213 1214 1215 1216 1217
  '(("PRIVMSG" . "<%N> %m")
    ("NOTICE"  . "-%N- %m")
    ("ACTION"  . "[%N %m]")
    ("COMMAND" . "%m")
    ("ERROR"   . "%fw!!! %m")
    (t         . "%fp*** %fs%n %r %m"))
1218 1219 1220 1221 1222 1223 1224 1225
  "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