rcirc.el 111 KB
Newer Older
1
;;; rcirc.el --- default, simple IRC client          -*- lexical-binding: t; -*-
Richard M. Stallman's avatar
Richard M. Stallman committed
2

3
;; Copyright (C) 2005-2014 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

5 6
;; Author: Ryan Yeske <rcyeske@gmail.com>
;; Maintainers: Ryan Yeske <rcyeske@gmail.com>,
7
;;		Leo Liu <sdl.web@gmail.com>
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9
;; Keywords: comm

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

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

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

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

;;; Commentary:

27 28 29 30 31
;; 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
32
;; Rcirc has simple defaults and clear and consistent behavior.
33
;; Message arrival timestamps, activity notification on the mode line,
34 35 36 37
;; 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
38 39 40 41

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
44 45
;;; Code:

46
(require 'cl-lib)
Richard M. Stallman's avatar
Richard M. Stallman committed
47 48 49
(require 'ring)
(require 'time-date)

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

57
(defcustom rcirc-server-alist
58 59 60 61
  '(("irc.freenode.net" :channels ("#rcirc")
     ;; Don't use the TLS port by default, in case gnutls is not available.
     ;; :port 7000 :encryption tls
     ))
62 63 64 65 66 67
  "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.

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

87 88 89 90 91
`:password'

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

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
101 102 103 104 105 106
connected to automatically.

`:encryption'

VALUE must be `plain' (the default) for unencrypted connections, or `tls'
for connections using SSL/TLS."
107
  :type '(alist :key-type string
108 109 110 111 112 113 114 115 116
		:value-type (plist :options
                                   ((:nick string)
                                    (:port integer)
                                    (:user-name string)
                                    (:password string)
                                    (:full-name string)
                                    (:channels (repeat string))
                                    (:encryption (choice (const tls)
                                                         (const plain))))))
117
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
118

119
(defcustom rcirc-default-port 6667
120 121 122
  "The default port to connect to."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
123

124
(defcustom rcirc-default-nick (user-login-name)
125 126 127
  "Your nick."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
128

Ryan Yeske's avatar
Ryan Yeske committed
129
(defcustom rcirc-default-user-name "user"
130
  "Your user name sent to the server when connecting."
131
  :version "24.1"                       ; changed default
132 133
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
134

Ryan Yeske's avatar
Ryan Yeske committed
135
(defcustom rcirc-default-full-name "unknown"
136
  "The full name sent to the server when connecting."
137
  :version "24.1"                       ; changed default
138 139
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
140

141
(defcustom rcirc-fill-flag t
142
  "Non-nil means line-wrap messages printed in channel buffers."
143 144
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
145

146
(defcustom rcirc-fill-column nil
147
  "Column beyond which automatic line-wrapping should happen.
148 149
If nil, use value of `fill-column'.  If 'frame-width, use the
maximum frame width."
150 151 152 153
  :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
154

155
(defcustom rcirc-fill-prefix nil
156
  "Text to insert before filled lines.
Richard M. Stallman's avatar
Richard M. Stallman committed
157
If nil, calculate the prefix dynamically to line up text
158 159 160 161
underneath each nick."
  :type '(choice (const :tag "Dynamic" nil)
		 (string :tag "Prefix text"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
162

163 164 165
(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
166

167 168 169 170
(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)

171 172 173 174 175
(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)

176
(defcustom rcirc-time-format "%H:%M "
177
  "Describes how timestamps are printed.
178 179 180
Used as the first arg to `format-time-string'."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
181

182
(defcustom rcirc-input-ring-size 1024
183
  "Size of input history ring."
184 185
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
186

187
(defcustom rcirc-read-only-flag t
188
  "Non-nil means make text in IRC buffers read-only."
189 190
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
191

192
(defcustom rcirc-buffer-maximum-lines nil
193
  "The maximum size in lines for rcirc buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
194
Channel buffers are truncated from the top to be no greater than this
195
number.  If zero or nil, no truncating is done."
196 197 198
  :type '(choice (const :tag "No truncation" nil)
		 (integer :tag "Number of lines"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
199

200
(defcustom rcirc-scroll-show-maximum-output t
201
  "If non-nil, scroll buffer to keep the point at the bottom of
202
the window."
203 204
  :type 'boolean
  :group 'rcirc)
Miles Bader's avatar
Miles Bader committed
205

206 207 208 209 210 211 212
(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
213

214 215
The ARGUMENTS for each METHOD symbol are:
  `nickserv': NICK PASSWORD [NICKSERV-NICK]
216 217
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
218
  `quakenet': ACCOUNT PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
219

220
Examples:
221 222
 ((\"freenode\" nickserv \"bob\" \"p455w0rd\")
  (\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
223
  (\"bitlbee\" bitlbee \"robert\" \"sekrit\")
224 225
  (\"dal.net\" nickserv \"bob\" \"sekrit\" \"NickServ@services.dal.net\")
  (\"quakenet.org\" quakenet \"bobby\" \"sekrit\"))"
226 227 228 229 230 231 232 233 234 235 236 237 238
  :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")
239 240 241 242 243
					  (string :tag "Password"))
                                    (list :tag "QuakeNet"
                                          (const quakenet)
                                          (string :tag "Account")
                                          (string :tag "Password"))))
244
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
245

246
(defcustom rcirc-auto-authenticate-flag t
247
  "Non-nil means automatically send authentication string to server.
248
See also `rcirc-authinfo'."
249 250
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
251

252
(defcustom rcirc-authenticate-before-join t
253
  "Non-nil means authenticate to services before joining channels.
254 255 256 257 258
Currently only works with NickServ on some networks."
  :version "24.1"
  :type 'boolean
  :group 'rcirc)

259
(defcustom rcirc-prompt "> "
260
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
261 262 263 264 265 266

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

267 268 269 270 271 272 273
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)

274 275 276 277 278
(defcustom rcirc-keywords nil
  "List of keywords to highlight in message text."
  :type '(repeat string)
  :group 'rcirc)

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

291 292
(defcustom rcirc-bright-nicks nil
  "List of nicks to be emphasized.
293
See `rcirc-bright-nick' face."
294
  :type '(repeat string)
295 296
  :group 'rcirc)

297 298
(defcustom rcirc-dim-nicks nil
  "List of nicks to be deemphasized.
299
See `rcirc-dim-nick' face."
300
  :type '(repeat string)
301 302
  :group 'rcirc)

Stefan Monnier's avatar
Stefan Monnier committed
303 304 305
(define-obsolete-variable-alias 'rcirc-print-hooks
  'rcirc-print-functions "24.3")
(defcustom rcirc-print-functions nil
306 307 308 309
  "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
310

311 312 313
(defvar rcirc-authenticated-hook nil
  "Hook run after successfully authenticated.")

314 315 316 317 318
(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)

319
(defcustom rcirc-decode-coding-system 'utf-8
320
  "Coding system used to decode incoming irc messages.
321 322
Set to 'undecided if you want the encoding of the incoming
messages autodetected."
323 324 325 326 327 328 329 330 331
  :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
332
  "Alist to decide a coding system to use for a channel I/O operation.
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
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)

356 357 358 359 360 361
(defcustom rcirc-nick-completion-format "%s: "
  "Format string to use in nick completions.

The format string is only used when completing at the beginning
of a line.  The string is passed as the first argument to
`format' with the nickname as the second argument."
Glenn Morris's avatar
Glenn Morris committed
362
  :version "24.1"
363 364 365
  :type 'string
  :group 'rcirc)

366 367 368 369
(defcustom rcirc-kill-channel-buffers nil
  "When non-nil, kill channel buffers when the server buffer is killed.
Only the channel buffers associated with the server in question
will be killed."
370
  :version "24.3"
371 372 373
  :type 'boolean
  :group 'rcirc)

374 375
(defvar rcirc-nick nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
376 377 378 379 380
(defvar rcirc-prompt-start-marker nil)
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

381 382 383
(defvar rcirc-recent-quit-alist nil
  "Alist of nicks that have recently quit or parted the channel.")

384 385 386 387 388 389 390 391
(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.")

392 393 394
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
395
(defvar rcirc-activity nil
396
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
397 398

(defvar rcirc-activity-string ""
399
  "String displayed in mode line representing `rcirc-activity'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
400 401
(put 'rcirc-activity-string 'risky-local-variable t)

402 403
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
404 405 406 407 408

(defvar rcirc-target nil
  "The channel or user associated with this buffer.")

(defvar rcirc-urls nil
409
  "List of URLs seen in the current buffer and their start positions.")
Miles Bader's avatar
Miles Bader committed
410
(put 'rcirc-urls 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
411

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

415
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
416 417

(defvar rcirc-startup-channels nil)
418

419 420 421 422 423 424 425 426 427
(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
428 429 430
(defvar rcirc-user-name-history nil
  "History variable for \\[rcirc] call.")

Richard M. Stallman's avatar
Richard M. Stallman committed
431
;;;###autoload
432
(defun rcirc (arg)
433
  "Connect to all servers in `rcirc-server-alist'.
434 435 436 437

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

If ARG is non-nil, instead prompt for connection parameters."
438 439
  (interactive "P")
  (if arg
440 441
      (let* ((server (completing-read "IRC Server: "
				      rcirc-server-alist
442
				      nil nil
443 444
				      (caar rcirc-server-alist)
				      'rcirc-server-name-history))
445 446
	     (server-plist (cdr (assoc-string server rcirc-server-alist)))
	     (port (read-string "IRC Port: "
447
				(number-to-string
448
				 (or (plist-get server-plist :port)
449 450
				     rcirc-default-port))
				'rcirc-server-port-history))
451
	     (nick (read-string "IRC Nick: "
452
				(or (plist-get server-plist :nick)
453 454
				    rcirc-default-nick)
				'rcirc-nick-name-history))
Ryan Yeske's avatar
Ryan Yeske committed
455 456 457 458
	     (user-name (read-string "IRC Username: "
                                     (or (plist-get server-plist :user-name)
                                         rcirc-default-user-name)
                                     'rcirc-user-name-history))
459 460
	     (password (read-passwd "IRC Password: " nil
                                    (plist-get server-plist :password)))
461 462
	     (channels (split-string
			(read-string "IRC Channels: "
463
				     (mapconcat 'identity
464
						(plist-get server-plist
465
							   :channels)
466
						" "))
467
			"[, ]+" t))
468
             (encryption (rcirc-prompt-for-encryption server-plist)))
469
	(rcirc-connect server port nick user-name
470
		       rcirc-default-full-name
471
		       channels password encryption))
472
    ;; connect to servers in `rcirc-server-alist'
473
    (let (connected-servers)
474
      (dolist (c rcirc-server-alist)
475
	(let ((server (car c))
476 477 478
	      (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)
479
			     rcirc-default-user-name))
480 481
	      (full-name (or (plist-get (cdr c) :full-name)
			     rcirc-default-full-name))
482
	      (channels (plist-get (cdr c) :channels))
483
              (password (plist-get (cdr c) :password))
484 485
              (encryption (plist-get (cdr c) :encryption))
              contact)
486 487 488 489 490 491
	  (when server
	    (let (connected)
	      (dolist (p (rcirc-process-list))
		(when (string= server (process-name p))
		  (setq connected p)))
	      (if (not connected)
492
		  (condition-case nil
493
		      (rcirc-connect server port nick user-name
494
				     full-name channels password encryption)
495
		    (quit (message "Quit connecting to %s" server)))
496
		(with-current-buffer (process-buffer connected)
497 498 499 500 501
                  (setq contact (process-contact
                                 (get-buffer-process (current-buffer)) :host))
                  (setq connected-servers
                        (cons (if (stringp contact) contact server)
                              connected-servers))))))))
502 503
      (when connected-servers
	(message "Already connected to %s"
504 505 506 507 508
		 (if (cdr connected-servers)
		     (concat (mapconcat 'identity (butlast connected-servers) ", ")
			     ", and "
			     (car (last connected-servers)))
		   (car connected-servers)))))))
509

Richard M. Stallman's avatar
Richard M. Stallman committed
510 511 512 513 514 515 516
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
517
(defvar rcirc-last-server-message-time nil)
518 519 520
(defvar rcirc-server nil)		; server provided by server
(defvar rcirc-server-name nil)		; server name given by 001 response
(defvar rcirc-timeout-timer nil)
521
(defvar rcirc-user-authenticated nil)
522 523
(defvar rcirc-user-disconnect nil)
(defvar rcirc-connecting nil)
Leo Liu's avatar
Leo Liu committed
524
(defvar rcirc-connection-info nil)
525
(defvar rcirc-process nil)
526 527

;;;###autoload
528
(defun rcirc-connect (server &optional port nick user-name
529
                             full-name startup-channels password encryption)
Richard M. Stallman's avatar
Richard M. Stallman committed
530 531 532
  (save-excursion
    (message "Connecting to %s..." server)
    (let* ((inhibit-eol-conversion)
533 534 535 536
           (port-number (if port
			    (if (stringp port)
				(string-to-number port)
			      port)
537 538 539
			  rcirc-default-port))
	   (nick (or nick rcirc-default-nick))
	   (user-name (or user-name rcirc-default-user-name))
540
	   (full-name (or full-name rcirc-default-full-name))
541
	   (startup-channels startup-channels)
542 543 544
           (process (open-network-stream
                     server nil server port-number
                     :type (or encryption 'plain))))
Richard M. Stallman's avatar
Richard M. Stallman committed
545 546
      ;; set up process
      (set-process-coding-system process 'raw-text 'raw-text)
547
      (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
548 549
      (set-process-buffer process (current-buffer))
      (rcirc-mode process nil)
550 551
      (set-process-sentinel process 'rcirc-sentinel)
      (set-process-filter process 'rcirc-filter)
552

Leo Liu's avatar
Leo Liu committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
      (setq-local rcirc-connection-info
		  (list server port nick user-name full-name startup-channels
			password encryption))
      (setq-local rcirc-process process)
      (setq-local rcirc-server server)
      (setq-local rcirc-server-name server) ; Update when we get 001 response.
      (setq-local rcirc-buffer-alist nil)
      (setq-local rcirc-nick-table (make-hash-table :test 'equal))
      (setq-local rcirc-nick nick)
      (setq-local rcirc-process-output nil)
      (setq-local rcirc-startup-channels startup-channels)
      (setq-local rcirc-last-server-message-time (current-time))

      (setq-local rcirc-timeout-timer nil)
      (setq-local rcirc-user-disconnect nil)
      (setq-local rcirc-user-authenticated nil)
      (setq-local rcirc-connecting t)
Richard M. Stallman's avatar
Richard M. Stallman committed
570

571 572
      (add-hook 'auto-save-hook 'rcirc-log-write)

Richard M. Stallman's avatar
Richard M. Stallman committed
573
      ;; identify
574
      (unless (zerop (length password))
575
        (rcirc-send-string process (concat "PASS " password)))
Richard M. Stallman's avatar
Richard M. Stallman committed
576 577
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
Ryan Yeske's avatar
Ryan Yeske committed
578
                                         " 0 * :" full-name))
Richard M. Stallman's avatar
Richard M. Stallman committed
579 580

      ;; setup ping timer if necessary
581 582 583
      (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
584 585 586 587 588 589

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

      ;; return process object
      process)))

590 591 592 593 594
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

595 596 597 598 599
(defmacro with-rcirc-server-buffer (&rest body)
  (declare (indent 0) (debug t))
  `(with-current-buffer rcirc-server-buffer
     ,@body))

600 601 602 603 604
(defun rcirc-float-time ()
  (if (featurep 'xemacs)
      (time-to-seconds (current-time))
    (float-time)))

605 606 607 608 609 610
(defun rcirc-prompt-for-encryption (server-plist)
  "Prompt the user for the encryption method to use.
SERVER-PLIST is the property list for the server."
  (let ((msg "Encryption (default %s): ")
        (choices '("plain" "tls"))
        (default (or (plist-get server-plist :encryption)
611
                     'plain)))
612 613
    (intern
     (completing-read (format msg default)
614
                      choices nil t nil nil (symbol-name default)))))
615

Richard M. Stallman's avatar
Richard M. Stallman committed
616
(defun rcirc-keepalive ()
617 618 619
  "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
620 621
  (if (rcirc-process-list)
      (mapc (lambda (process)
622 623
	      (with-rcirc-process-buffer process
		(when (not rcirc-connecting)
624 625 626
                  (rcirc-send-ctcp process
                                   rcirc-nick
                                   (format "KEEPALIVE %f"
627
                                           (rcirc-float-time))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
628
            (rcirc-process-list))
629
    ;; no processes, clean up timer
630 631
    (when (timerp rcirc-keepalive-timer)
      (cancel-timer rcirc-keepalive-timer))
Richard M. Stallman's avatar
Richard M. Stallman committed
632 633
    (setq rcirc-keepalive-timer nil)))

634
(defun rcirc-handler-ctcp-KEEPALIVE (process _target _sender message)
635
  (with-rcirc-process-buffer process
636
    (setq header-line-format (format "%f" (- (rcirc-float-time)
637 638
					     (string-to-number message))))))

639
(defvar rcirc-debug-buffer "*rcirc debug*")
640 641 642
(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
643
  "Add an entry to the debug log including PROCESS and TEXT.
644
Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
645 646
is non-nil."
  (when rcirc-debug-flag
647
    (with-current-buffer (get-buffer-create rcirc-debug-buffer)
648 649 650 651 652 653
      (goto-char (point-max))
      (insert (concat
	       "["
	       (format-time-string "%Y-%m-%dT%T ") (process-name process)
	       "] "
	       text)))))
654

Stefan Monnier's avatar
Stefan Monnier committed
655 656 657
(define-obsolete-variable-alias 'rcirc-sentinel-hooks
  'rcirc-sentinel-functions "24.3")
(defvar rcirc-sentinel-functions nil
Richard M. Stallman's avatar
Richard M. Stallman committed
658 659 660
  "Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")

661 662 663 664 665 666 667 668 669
(defcustom rcirc-reconnect-delay 0
  "*The minimum interval in seconds between reconnect attempts.
When 0, do not auto-reconnect."
  :type 'integer
  :group 'rcirc)

(defvar rcirc-last-connect-time nil
  "The last time the buffer was connected.")

Richard M. Stallman's avatar
Richard M. Stallman committed
670 671 672
(defun rcirc-sentinel (process sentinel)
  "Called when PROCESS receives SENTINEL."
  (let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
673 674 675 676
    (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))
677 678 679 680
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
681
			       (process-status process)) (not rcirc-target))
682
	  (rcirc-disconnect-buffer)))
683 684 685 686 687 688
      (when (and (string= sentinel "deleted")
                 (< 0 rcirc-reconnect-delay))
        (let ((now (current-time)))
          (when (or (null rcirc-last-connect-time)
                    (< rcirc-reconnect-delay
                       (float-time (time-subtract now rcirc-last-connect-time))))
689
            (setq rcirc-last-connect-time now)
690
            (rcirc-cmd-reconnect nil))))
Stefan Monnier's avatar
Stefan Monnier committed
691
      (run-hook-with-args 'rcirc-sentinel-functions process sentinel))))
Richard M. Stallman's avatar
Richard M. Stallman committed
692

693 694 695
(defun rcirc-disconnect-buffer (&optional buffer)
  (with-current-buffer (or buffer (current-buffer))
    ;; set rcirc-target to nil for each channel so cleanup
Juanma Barranquero's avatar
Juanma Barranquero committed
696
    ;; doesn't happen when we reconnect
697
    (setq rcirc-target nil)
698
    (setq mode-line-process ":disconnected")))
699

Richard M. Stallman's avatar
Richard M. Stallman committed
700 701 702 703
(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
704
            (when (buffer-live-p (process-buffer p))
705
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
706 707 708 709 710
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

Stefan Monnier's avatar
Stefan Monnier committed
711 712 713
(define-obsolete-variable-alias 'rcirc-receive-message-hooks
  'rcirc-receive-message-functions "24.3")
(defvar rcirc-receive-message-functions nil
714 715
  "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
716 717
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
718
  (rcirc-debug process output)
719
  (rcirc-reschedule-timeout process)
720
  (with-rcirc-process-buffer process
721
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
722 723 724 725 726
    (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))
727
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
728 729
      (setq rcirc-process-output nil))))

730 731 732 733 734 735 736 737 738 739 740 741
(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))

742
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
743
(defun rcirc-process-server-response (process text)
744
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
745 746 747 748
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
749
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752 753
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
754 755
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
756 757 758 759 760 761
             (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))
762 763
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
764 765 766
        (if (not (fboundp handler))
            (rcirc-handler-generic process cmd sender args text)
          (funcall handler process sender args text))
Stefan Monnier's avatar
Stefan Monnier committed
767
        (run-hook-with-args 'rcirc-receive-message-functions
Richard M. Stallman's avatar
Richard M. Stallman committed
768 769 770
                            process cmd sender args text)))
    (message "UNHANDLED: %s" text)))

771 772 773
(defvar rcirc-responses-no-activity '("305" "306")
  "Responses that don't trigger activity in the mode-line indicator.")

774
(defun rcirc-handler-generic (process response sender args _text)
Richard M. Stallman's avatar
Richard M. Stallman committed
775
  "Generic server response handler."
776 777 778
  (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
779

780 781 782
(defun rcirc--connection-open-p (process)
  (memq (process-status process) '(run open)))

Richard M. Stallman's avatar
Richard M. Stallman committed
783 784
(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
785
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
786
                        "\n")))
787
    (unless (rcirc--connection-open-p process)
788
      (error "Network connection to %s is not open"
789
             (process-name process)))
790
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
791 792
    (process-send-string process string)))

793 794 795 796 797 798
(defun rcirc-send-privmsg (process target string)
  (rcirc-send-string process (format "PRIVMSG %s :%s" target string)))

(defun rcirc-send-ctcp (process target request &optional args)
  (let ((args (if args (concat " " args) "")))
    (rcirc-send-privmsg process target
799
                        (format "\C-a%s%s\C-a" request args))))
800

801 802 803
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
Leo Liu's avatar
Leo Liu committed
804 805 806 807 808
  (let ((buffer (or buffer (if (buffer-live-p rcirc-server-buffer)
			       rcirc-server-buffer
			     (error "Server buffer deleted")))))
    (or (with-current-buffer buffer rcirc-process)
	rcirc-process)))
809 810 811

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
812
  (with-rcirc-process-buffer process
813 814
    (or rcirc-server-name
	(warn "server name for process %S unknown" process))))
Richard M. Stallman's avatar
Richard M. Stallman committed
815 816 817

(defun rcirc-nick (process)
  "Return PROCESS nick."
818
  (with-rcirc-process-buffer process
819 820 821 822 823 824 825 826
    (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
827

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

831 832
(defun rcirc-split-message (message)
  "Split MESSAGE into chunks within `rcirc-max-message-length'."
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
  ;; `rcirc-encode-coding-system' can have buffer-local value.
  (let ((encoding rcirc-encode-coding-system))
    (with-temp-buffer
      (insert message)
      (goto-char (point-min))
      (let (result)
	(while (not (eobp))
	  (goto-char (or (byte-to-position rcirc-max-message-length)
			 (point-max)))
	  ;; max message length is 512 including CRLF
	  (while (and (not (bobp))
		      (> (length (encode-coding-region
				  (point-min) (point) encoding t))
			 rcirc-max-message-length))
	    (forward-char -1))
	  (push (delete-and-extract-region (point-min) (point)) result))
	(nreverse result)))))
850

851
(defun rcirc-send-message (process target message &optional noticep silent)
Richard M. Stallman's avatar
Richard M. Stallman committed
852
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
853 854
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."
855
  (let ((response (if noticep "NOTICE" "PRIVMSG")))
856
    (rcirc-get-buffer-create process target)
857 858 859 860
    (dolist (msg (rcirc-split-message message))
      (rcirc-send-string process (concat response " " target " :" msg))
      (unless silent
	(rcirc-print process (rcirc-nick process) response target msg)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
861 862 863

(defvar rcirc-input-ring nil)
(defvar rcirc-input-ring-index 0)
864

Richard M. Stallman's avatar
Richard M. Stallman committed
865 866 867
(defun rcirc-prev-input-string (arg)
  (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))

868 869
(defun rcirc-insert-prev-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
870 871 872 873 874
  (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))))

875 876
(defun rcirc-insert-next-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
877 878 879 880 881
  (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))))

882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
(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'."
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  (and (rcirc-looking-at-input)
       (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))))
916 917 918 919 920 921 922

(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
923
  (interactive)
924 925
  (unless (rcirc-looking-at-input)
    (error "Point not located after rcirc prompt"))
Miles Bader's avatar
Miles Bader committed
926
  (if (eq last-command this-command)
927 928 929 930 931 932
      (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
933 934 935 936
	    (and rcirc-completion-start
		 (all-completions (buffer-substring rcirc-completion-start
						    (cadr table))
				  (nth 2 table))))))
937
  (let ((completion (car rcirc-completions)))
Richard M. Stallman's avatar
Richard M. Stallman committed
938
    (when completion
939 940
      (delete-region rcirc-completion-start (point))
      (insert
941 942 943 944 945
       (cond
        ((= (aref completion 0) ?/) (concat completion " "))
        ((= rcirc-completion-start rcirc-prompt-end-marker)
         (format rcirc-nick-completion-format completion))
        (t completion))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
946

947 948 949
(defun set-rcirc-decode-coding-system (coding-system)
  "Set the decode coding system used in this channel."
  (interactive "zCoding system for incoming messages: ")
Leo Liu's avatar
Leo Liu committed
950
  (setq-local rcirc-decode-coding-system coding-system))
951 952 953 954

(defun set-rcirc-encode-coding-system (coding-system)
  "Set the encode coding system used in this channel."
  (interactive "zCoding system for outgoing messages: ")
Leo Liu's avatar
Leo Liu committed
955
  (setq-local rcirc-encode-coding-system coding-system))
Richard M. Stallman's avatar
Richard M. Stallman committed
956

957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
(defvar rcirc-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map (kbd "RET") 'rcirc-send-input)
    (define-key map (kbd "M-p") 'rcirc-insert-prev-input)
    (define-key map (kbd "M-n") 'rcirc-insert-next-input)
    (define-key map (kbd "TAB") 'rcirc-complete)
    (define-key map (kbd "C-c C-b") 'rcirc-browse-url)
    (define-key map (kbd "C-c C-c") 'rcirc-edit-multiline)
    (define-key map (kbd "C-c C-j") 'rcirc-cmd-join)
    (define-key map (kbd "C-c C-k") 'rcirc-cmd-kick)
    (define-key map (kbd "C-c C-l") 'rcirc-toggle-low-priority)
    (define-key map (kbd "C-c C-d") 'rcirc-cmd-mode)
    (define-key map (kbd "C-c C-m") 'rcirc-cmd-msg)
    (define-key map (kbd "C-c C-r") 'rcirc-cmd-nick) ; rename
    (define-key map (kbd "C-c C-o") 'rcirc-omit-mode)
    (define-key map (kbd "C-c C-p") 'rcirc-cmd-part)
    (define-key map (kbd "C-c C-q") 'rcirc-cmd-query)
    (define-key map (kbd "C-c C-t") 'rcirc-cmd-topic)
    (define-key map (kbd "C-c C-n") 'rcirc-cmd-names)
    (define-key map (kbd "C-c C-w") 'rcirc-cmd-whois)
    (define-key map (kbd "C-c C-x") 'rcirc-cmd-quit)
    (define-key map (kbd "C-c TAB") ; C-i
      'rcirc-toggle-ignore-buffer-activity)
    (define-key map (kbd "C-c C-s") 'rcirc-switch-to-server-buffer)
    (define-key map (kbd "C-c C-a") 'rcirc-jump-to-first-unread-line)
    map)
Richard M. Stallman's avatar
Richard M. Stallman committed
983 984
  "Keymap for rcirc mode.")

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

Richard M. Stallman's avatar
Richard M. Stallman committed
988 989 990
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

991 992
(defvar rcirc-last-post-time nil)

993 994 995 996
(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).")

997 998 999 1000
(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
1001
(defun rcirc-mode (process target)
1002
  ;; FIXME: Use define-derived-mode.
1003
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
1004 1005 1006 1007 1008 1009

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