rcirc.el 99 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 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
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.

83 84 85 86 87
`:password'

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

88 89 90 91 92 93 94 95 96 97 98
`: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
99 100 101
		:value-type (plist :options ((:nick string)
					     (:port integer)
					     (:user-name string)
102
					     (:password string)
103 104
					     (:full-name string)
					     (:channels (repeat string)))))
105
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
106

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

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

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

122 123 124
(defcustom rcirc-default-full-name (if (string= (user-full-name) "")
				       rcirc-default-user-name
				     (user-full-name))
125 126 127
  "The full name sent to the server when connecting."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
128

129 130 131 132
(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
133

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

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

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

155 156 157 158
(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)

159 160 161 162 163
(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)

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

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

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

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

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

194 195 196 197 198 199 200
(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
201

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

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

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

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

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

242 243 244 245 246 247 248
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)

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

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

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

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

278 279 280 281 282
(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
283

284 285 286 287 288
(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)

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

(defvar rcirc-nick-table nil)

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

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

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

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

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

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

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

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

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

369 370 371 372 373 374 375 376 377
(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.")

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))
402 403
             (password (read-passwd "IRC Password: "
                                    (plist-get server-plist 'password)))
404 405
	     (channels (split-string
			(read-string "IRC Channels: "
406
				     (mapconcat 'identity
407
						(plist-get server-plist
408
							   :channels)
409
						" "))
410
			"[, ]+" t)))
411 412 413 414

        (when (= 0 (length password))
          (setq password nil))

415
	(rcirc-connect server port nick rcirc-default-user-name
416
		       rcirc-default-full-name
417
		       channels password))
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))
426 427
	      (full-name (or (plist-get (cdr c) :full-name)
			     rcirc-default-full-name))
428 429
	      (channels (plist-get (cdr c) :channels))
              (password (plist-get (cdr c) :password)))
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
437
		      (rcirc-connect server port nick user-name
438
				     full-name channels password)
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
469
(defun rcirc-connect (server &optional port nick user-name full-name
470
			     startup-channels password)
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
519 520
      (when password
        (rcirc-send-string process (concat "PASS " password)))
Richard M. Stallman's avatar
Richard M. Stallman committed
521 522 523 524 525 526
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
                                      " hostname servername :"
                                      full-name))

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

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

      ;; return process object
      process)))

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

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

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

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

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

609 610 611 612 613
(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)
614
    (setq mode-line-process ":disconnected")))
615

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

864 865 866 867
(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).")

868 869 870 871
(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
872
(defun rcirc-mode (process target)
873
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
874 875 876 877 878 879

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

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

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

904 905 906 907 908 909 910 911
  ;; 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)))

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

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

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

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

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

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

(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)
1002 1003 1004