rcirc.el 102 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, 2007, 2008, 2009, 2010, 2011
4
;;   Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

6 7 8
;; Author: Ryan Yeske <rcyeske@gmail.com>
;; Maintainers: Ryan Yeske <rcyeske@gmail.com>,
;;              Deniz Dogan <deniz.a.m.dogan@gmail.com>
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10
;; Keywords: comm

11
;; This file is part of GNU Emacs.
Richard M. Stallman's avatar
Richard M. Stallman committed
12

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; 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
17

18
;; GNU Emacs is distributed in the hope that it will be useful,
Richard M. Stallman's avatar
Richard M. Stallman committed
19
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Richard M. Stallman's avatar
Richard M. Stallman committed
21 22 23
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
25 26 27

;;; Commentary:

28 29 30 31 32
;; 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
33
;; Rcirc has simple defaults and clear and consistent behavior.
34 35 36 37 38
;; 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-server-alist
59 60 61 62 63 64 65
  '(("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.

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
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.

85 86 87 88 89
`:password'

VALUE must be a string.  If absent, no PASS command will be sent
to the server.

90 91 92 93 94 95 96 97 98 99 100
`:full-name'

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

`: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
101 102 103
		:value-type (plist :options ((:nick string)
					     (:port integer)
					     (:user-name string)
104
					     (:password string)
105 106
					     (:full-name string)
					     (:channels (repeat string)))))
107
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
108

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

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

Ryan Yeske's avatar
Ryan Yeske committed
119
(defcustom rcirc-default-user-name "user"
120
  "Your user name sent to the server when connecting."
121
  :version "24.1"                       ; changed default
122 123
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
124

Ryan Yeske's avatar
Ryan Yeske committed
125
(defcustom rcirc-default-full-name "unknown"
126
  "The full name sent to the server when connecting."
127
  :version "24.1"                       ; changed default
128 129
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
130

131 132 133 134
(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
135

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

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

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

157 158 159 160
(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)

161 162 163 164 165
(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)

166
(defcustom rcirc-time-format "%H:%M "
Richard M. Stallman's avatar
Richard M. Stallman committed
167
  "*Describes how timestamps are printed.
168 169 170
Used as the first arg to `format-time-string'."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
171

172 173 174 175
(defcustom rcirc-input-ring-size 1024
  "*Size of input history ring."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
176

177
(defcustom rcirc-read-only-flag t
178
  "*Non-nil means make text in IRC buffers read-only."
179 180
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
181

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

190
(defcustom rcirc-scroll-show-maximum-output t
191 192
  "*If non-nil, scroll buffer to keep the point at the bottom of
the window."
193 194
  :type 'boolean
  :group 'rcirc)
Miles Bader's avatar
Miles Bader committed
195

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

204 205
The ARGUMENTS for each METHOD symbol are:
  `nickserv': NICK PASSWORD [NICKSERV-NICK]
206 207
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
208

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

230
(defcustom rcirc-auto-authenticate-flag t
Richard M. Stallman's avatar
Richard M. Stallman committed
231
  "*Non-nil means automatically send authentication string to server.
232
See also `rcirc-authinfo'."
233 234
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
235

236
(defcustom rcirc-prompt "> "
237
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
238 239 240 241 242 243

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

244 245 246 247 248 249 250
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)

251 252 253 254 255
(defcustom rcirc-keywords nil
  "List of keywords to highlight in message text."
  :type '(repeat string)
  :group 'rcirc)

256 257 258 259 260 261 262 263 264 265 266 267
(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.")

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

274 275
(defcustom rcirc-dim-nicks nil
  "List of nicks to be deemphasized.
276
See `rcirc-dim-nick' face."
277
  :type '(repeat string)
278 279
  :group 'rcirc)

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

286 287 288 289 290
(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)

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

(defvar rcirc-nick-table nil)

333 334 335
(defvar rcirc-recent-quit-alist nil
  "Alist of nicks that have recently quit or parted the channel.")

336 337 338 339 340 341 342 343
(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.")

344 345 346
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
347
(defvar rcirc-activity nil
348
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
349 350 351 352 353

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

354 355
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
356 357 358 359 360 361

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

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

367
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
368 369

(defvar rcirc-startup-channels nil)
370

371 372 373 374 375 376 377 378 379
(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
380 381 382
(defvar rcirc-user-name-history nil
  "History variable for \\[rcirc] call.")

Richard M. Stallman's avatar
Richard M. Stallman committed
383
;;;###autoload
384
(defun rcirc (arg)
385
  "Connect to all servers in `rcirc-server-alist'.
386 387 388 389

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
458 459 460 461 462 463 464
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
465
(defvar rcirc-last-server-message-time nil)
466 467 468 469 470 471
(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)
472 473

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

521 522
      (add-hook 'auto-save-hook 'rcirc-log-write)

Richard M. Stallman's avatar
Richard M. Stallman committed
523
      ;; identify
524 525
      (when password
        (rcirc-send-string process (concat "PASS " password)))
Richard M. Stallman's avatar
Richard M. Stallman committed
526 527
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
Ryan Yeske's avatar
Ryan Yeske committed
528
                                         " 0 * :" full-name))
Richard M. Stallman's avatar
Richard M. Stallman committed
529 530

      ;; setup ping timer if necessary
531 532 533
      (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
534 535 536 537 538 539

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

      ;; return process object
      process)))

540 541 542 543 544
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

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

570 571
(defun rcirc-handler-ctcp-KEEPALIVE (process target sender message)
  (with-rcirc-process-buffer process
572 573 574 575
    (setq header-line-format (format "%f" (- (if (featurep 'xemacs)
                                                 (time-to-seconds
                                                  (current-time))
                                               (float-time))
576 577
					     (string-to-number message))))))

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

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

613 614 615 616 617
(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)
618
    (setq mode-line-process ":disconnected")))
619

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

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

648 649 650 651 652 653 654 655 656 657 658 659
(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))

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

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

689 690 691 692
(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
693
  "Generic server response handler."
694 695 696
  (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
697 698 699

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

708 709 710
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
711 712 713 714 715
  (or (get-buffer-process (if buffer
			      (with-current-buffer buffer
				rcirc-server-buffer)
			    rcirc-server-buffer))
      rcirc-process))
716 717 718

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
719
  (with-rcirc-process-buffer process
720 721
    (or rcirc-server-name
	(warn "server name for process %S unknown" process))))
Richard M. Stallman's avatar
Richard M. Stallman committed
722 723 724

(defun rcirc-nick (process)
  "Return PROCESS nick."
725
  (with-rcirc-process-buffer process
726 727 728 729 730 731 732 733
    (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
734

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

738
(defun rcirc-send-message (process target message &optional noticep silent)
Richard M. Stallman's avatar
Richard M. Stallman committed
739
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
740 741
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
742 743 744 745 746 747 748 749 750 751 752
  ;; 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))))
753
    (rcirc-get-buffer-create process target)
Richard M. Stallman's avatar
Richard M. Stallman committed
754
    (rcirc-send-string process (concat response " " target " :" text))
755 756
    (unless silent
      (rcirc-print process (rcirc-nick process) response target text))
757
    (when more (rcirc-send-message process target more noticep))))
Richard M. Stallman's avatar
Richard M. Stallman committed
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777

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

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
(defvar rcirc-server-commands
  '("/admin"   "/away"   "/connect" "/die"      "/error"   "/info"
    "/invite"  "/ison"   "/join"    "/kick"     "/kill"    "/links"
    "/list"    "/lusers" "/mode"    "/motd"     "/names"   "/nick"
    "/notice"  "/oper"   "/part"    "/pass"     "/ping"    "/pong"
    "/privmsg" "/quit"   "/rehash"  "/restart"  "/service" "/servlist"
    "/server"  "/squery" "/squit"   "/stats"    "/summon"  "/time"
    "/topic"   "/trace"  "/user"    "/userhost" "/users"   "/version"
    "/wallops" "/who"    "/whois"   "/whowas")
  "A list of user commands by IRC server.
The value defaults to RFCs 1459 and 2812.")

;; /me and /ctcp are not defined by `defun-rcirc-command'.
(defvar rcirc-client-commands '("/me" "/ctcp")
  "A list of user commands defined by IRC client rcirc.
The list is updated automatically by `defun-rcirc-command'.")

(defun rcirc-completion-at-point ()
  "Function used for `completion-at-point-functions' in `rcirc-mode'."
  (let* ((beg (save-excursion
		(if (re-search-backward " " rcirc-prompt-end-marker t)
		    (1+ (point))
		  rcirc-prompt-end-marker)))
	 (table (if (and (= beg rcirc-prompt-end-marker)
			 (eq (char-after beg) ?/))
		    (delete-dups
		     (nconc
		      (sort (copy-sequence rcirc-client-commands) 'string-lessp)
		      (sort (copy-sequence rcirc-server-commands) 'string-lessp)))
		  (rcirc-channel-nicks (rcirc-buffer-process) rcirc-target))))
    (list beg (point) table)))

(defvar rcirc-completions nil)
(defvar rcirc-completion-start nil)

(defun rcirc-complete ()
  "Cycle through completions from list of nicks in channel or IRC commands.
IRC command completion is performed only if '/' is the first input char."
Richard M. Stallman's avatar
Richard M. Stallman committed
816
  (interactive)
Miles Bader's avatar
Miles Bader committed
817
  (if (eq last-command this-command)
818 819 820 821 822 823 824 825 826 827
      (setq rcirc-completions
	    (append (cdr rcirc-completions) (list (car rcirc-completions))))
    (let ((completion-ignore-case t)
	  (table (rcirc-completion-at-point)))
      (setq rcirc-completion-start (car table))
      (setq rcirc-completions
	    (all-completions (buffer-substring rcirc-completion-start
					       (cadr table))
			     (nth 2 table)))))
  (let ((completion (car rcirc-completions)))
Richard M. Stallman's avatar
Richard M. Stallman committed
828
    (when completion
829 830 831 832 833 834 835
      (delete-region rcirc-completion-start (point))
      (insert
       (concat completion
	       (cond
		((= (aref completion 0) ?/) " ")
		((= rcirc-completion-start rcirc-prompt-end-marker) ": ")
		(t "")))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
836

837 838 839 840 841 842 843 844 845
(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
846 847 848 849 850 851 852

(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)
853
(define-key rcirc-mode-map (kbd "TAB") 'rcirc-complete)
Richard M. Stallman's avatar
Richard M. Stallman committed
854 855 856 857
(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)
858
(define-key rcirc-mode-map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
Richard M. Stallman's avatar
Richard M. Stallman committed
859 860 861
(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
862
(define-key rcirc-mode-map (kbd "C-c C-o") 'rcirc-omit-mode)
863
(define-key rcirc-mode-map (kbd "M-o") 'rcirc-omit-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
864 865 866 867 868 869 870
(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
871
  'rcirc-toggle-ignore-buffer-activity)
Richard M. Stallman's avatar
Richard M. Stallman committed
872 873 874
(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)

875
(defvar rcirc-browse-url-map (make-sparse-keymap)
876
  "Keymap used for browsing URLs in `rcirc-mode'.")
877 878 879

(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)
880
(define-key rcirc-browse-url-map [follow-link] 'mouse-face)
881 882 883 884

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

Richard M. Stallman's avatar
Richard M. Stallman committed
885 886 887
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

888 889
(defvar rcirc-last-post-time nil)

890 891 892 893
(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).")

894 895 896 897
(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
898
(defun rcirc-mode (process target)
899
  ;; FIXME: Use define-derived-mode.
900
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
901 902 903 904 905 906

\\{rcirc-mode-map}"
  (kill-all-local-variables)
  (use-local-map rcirc-mode-map)
  (setq mode-name "rcirc")
  (setq major-mode 'rcirc-mode)
907
  (setq mode-line-process nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
908 909 910

  (make-local-variable 'rcirc-input-ring)
  (setq rcirc-input-ring (make-ring rcirc-input-ring-size))
911 912
  (make-local-variable 'rcirc-server-buffer)
  (setq rcirc-server-buffer (process-buffer process))
Richard M. Stallman's avatar
Richard M. Stallman committed
913 914
  (make-local-variable 'rcirc-target)
  (setq rcirc-target target)
915 916
  (make-local-variable 'rcirc-topic)
  (setq rcirc-topic nil)
917 918
  (make-local-variable 'rcirc-last-post-time)
  (setq rcirc-last-post-time (current-time))
919 920
  (make-local-variable 'fill-paragraph-function)
  (setq fill-paragraph-function 'rcirc-fill-paragraph)
921 922 923 924
  (make-local-variable 'rcirc-recent-quit-alist)
  (setq rcirc-recent-quit-alist nil)
  (make-local-variable 'rcirc-current-line)
  (setq rcirc-current-line 0)
925 926 927

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

931 932 933 934 935 936 937 938
  ;; 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)))

939 940 941 942 943 944 945
  (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)))
946 947
	(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))))))
948

Richard M. Stallman's avatar
Richard M. Stallman committed
949 950 951 952 953 954 955 956 957 958 959 960 961
  ;; 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)

962 963
  ;; if the user changes the major mode or kills the buffer, there is
  ;; cleanup work to do
964 965
  (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook nil t)
  (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook nil t)
966

967 968 969 970 971 972 973 974
  ;; 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))

975 976 977
  (add-hook 'completion-at-point-functions
            'rcirc-completion-at-point nil 'local)

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

980 981
(defun rcirc-update-prompt (&optional all)
  "Reset the prompt string in the current buffer.
982

983 984 985 986 987 988 989 990 991 992 993 994 995
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