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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2005-2019 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
Paul Eggert's avatar
Paul Eggert committed
23
;; along with GNU Emacs.  If not, see <https://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
connected to automatically.

`:encryption'

VALUE must be `plain' (the default) for unencrypted connections, or `tls'
106 107 108 109 110 111
for connections using SSL/TLS.

`:server-alias'

VALUE must be a string that will be used instead of the server name for
display purposes. If absent, the real server name will be displayed instead."
112
  :type '(alist :key-type string
113 114 115 116 117 118 119 120
		:value-type (plist :options
                                   ((:nick string)
                                    (:port integer)
                                    (:user-name string)
                                    (:password string)
                                    (:full-name string)
                                    (:channels (repeat string))
                                    (:encryption (choice (const tls)
121 122
                                                         (const plain)))
                                    (:server-alias string))))
123
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
124

125
(defcustom rcirc-default-port 6667
126 127 128
  "The default port to connect to."
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
129

130
(defcustom rcirc-default-nick (user-login-name)
131 132 133
  "Your nick."
  :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-user-name "user"
136
  "Your user 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

Ryan Yeske's avatar
Ryan Yeske committed
141
(defcustom rcirc-default-full-name "unknown"
142
  "The full name sent to the server when connecting."
143
  :version "24.1"                       ; changed default
144 145
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
146

147
(defcustom rcirc-fill-flag t
148
  "Non-nil means line-wrap messages printed in channel buffers."
149 150
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
151

152
(defcustom rcirc-fill-column nil
153
  "Column beyond which automatic line-wrapping should happen.
154
If nil, use value of `fill-column'.
155 156
If a function (e.g., `frame-text-width' or `window-text-width'),
call it to compute the number of columns."
157
  :risky t                              ; can get funcalled
158
  :type '(choice (const :tag "Value of `fill-column'" nil)
159 160
		 (integer :tag "Number of columns")
		 (function :tag "Function returning the number of columns"))
161
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
162

163
(defcustom rcirc-fill-prefix nil
164
  "Text to insert before filled lines.
Richard M. Stallman's avatar
Richard M. Stallman committed
165
If nil, calculate the prefix dynamically to line up text
166 167 168 169
underneath each nick."
  :type '(choice (const :tag "Dynamic" nil)
		 (string :tag "Prefix text"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
170

171 172 173 174 175 176 177 178
(defcustom rcirc-url-max-length nil
  "Maximum number of characters in displayed URLs.
If nil, no maximum is applied."
  :version "27.1"
  :type '(choice (const :tag "No maximum" nil)
                 (integer :tag "Number of characters"))
  :group 'rcirc)

179 180 181
(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
182

183 184 185 186
(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)

187 188 189 190 191 192
(defcustom rcirc-omit-responses
  '("JOIN" "PART" "QUIT" "NICK")
  "Responses which will be hidden when `rcirc-omit-mode' is enabled."
  :type '(repeat string)
  :group 'rcirc)

193 194
(defvar rcirc-prompt-start-marker nil)

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
(define-minor-mode rcirc-omit-mode
  "Toggle the hiding of \"uninteresting\" lines.

Uninteresting lines are those whose responses are listed in
`rcirc-omit-responses'."
  nil " Omit" nil
  (if rcirc-omit-mode
      (progn
	(add-to-invisibility-spec '(rcirc-omit . nil))
	(message "Rcirc-Omit mode enabled"))
    (remove-from-invisibility-spec '(rcirc-omit . nil))
    (message "Rcirc-Omit mode disabled"))
  (dolist (window (get-buffer-window-list (current-buffer)))
    (with-selected-window window
      (recenter (when (> (point) rcirc-prompt-start-marker) -1)))))
210

211
(defcustom rcirc-time-format "%H:%M "
212
  "Describes how timestamps are printed.
213 214 215
Used as the first arg to `format-time-string'."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
216

217
(defcustom rcirc-input-ring-size 1024
218
  "Size of input history ring."
219 220
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
221

222
(defcustom rcirc-read-only-flag t
223
  "Non-nil means make text in IRC buffers read-only."
224 225
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
226

227
(defcustom rcirc-buffer-maximum-lines nil
228
  "The maximum size in lines for rcirc buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
229
Channel buffers are truncated from the top to be no greater than this
230
number.  If zero or nil, no truncating is done."
231 232 233
  :type '(choice (const :tag "No truncation" nil)
		 (integer :tag "Number of lines"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
234

235
(defcustom rcirc-scroll-show-maximum-output t
236
  "If non-nil, scroll buffer to keep the point at the bottom of
237
the window."
238 239
  :type 'boolean
  :group 'rcirc)
Miles Bader's avatar
Miles Bader committed
240

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

249 250
The ARGUMENTS for each METHOD symbol are:
  `nickserv': NICK PASSWORD [NICKSERV-NICK]
251 252
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
253
  `quakenet': ACCOUNT PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
254

255
Examples:
256 257
 ((\"freenode\" nickserv \"bob\" \"p455w0rd\")
  (\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
258
  (\"bitlbee\" bitlbee \"robert\" \"sekrit\")
259 260
  (\"dal.net\" nickserv \"bob\" \"sekrit\" \"NickServ@services.dal.net\")
  (\"quakenet.org\" quakenet \"bobby\" \"sekrit\"))"
261 262 263 264 265 266 267 268 269 270 271 272 273
  :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")
274 275 276 277 278
					  (string :tag "Password"))
                                    (list :tag "QuakeNet"
                                          (const quakenet)
                                          (string :tag "Account")
                                          (string :tag "Password"))))
279
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
280

281
(defcustom rcirc-auto-authenticate-flag t
282
  "Non-nil means automatically send authentication string to server.
283
See also `rcirc-authinfo'."
284 285
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
286

287
(defcustom rcirc-authenticate-before-join t
288
  "Non-nil means authenticate to services before joining channels.
289 290 291 292 293
Currently only works with NickServ on some networks."
  :version "24.1"
  :type 'boolean
  :group 'rcirc)

294
(defcustom rcirc-prompt "> "
295
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
296 297 298 299 300 301

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

302 303 304 305 306 307 308
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)

309 310 311 312 313
(defcustom rcirc-keywords nil
  "List of keywords to highlight in message text."
  :type '(repeat string)
  :group 'rcirc)

314 315 316 317 318 319 320 321 322 323 324 325
(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.")

326 327
(defcustom rcirc-bright-nicks nil
  "List of nicks to be emphasized.
328
See `rcirc-bright-nick' face."
329
  :type '(repeat string)
330 331
  :group 'rcirc)

332 333
(defcustom rcirc-dim-nicks nil
  "List of nicks to be deemphasized.
334
See `rcirc-dim-nick' face."
335
  :type '(repeat string)
336 337
  :group 'rcirc)

Stefan Monnier's avatar
Stefan Monnier committed
338 339 340
(define-obsolete-variable-alias 'rcirc-print-hooks
  'rcirc-print-functions "24.3")
(defcustom rcirc-print-functions nil
341 342 343 344
  "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
345

346 347 348
(defvar rcirc-authenticated-hook nil
  "Hook run after successfully authenticated.")

349 350 351 352 353
(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)

354
(defcustom rcirc-decode-coding-system 'utf-8
355
  "Coding system used to decode incoming irc messages.
356
Set to `undecided' if you want the encoding of the incoming
357
messages autodetected."
358 359 360 361 362 363 364 365 366
  :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
367
  "Alist to decide a coding system to use for a channel I/O operation.
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
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)

391 392 393 394 395 396
(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
397
  :version "24.1"
398 399 400
  :type 'string
  :group 'rcirc)

401 402 403 404
(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."
405
  :version "24.3"
406 407 408
  :type 'boolean
  :group 'rcirc)

409 410
(defvar rcirc-nick nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
411 412 413 414
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

415 416 417
(defvar rcirc-recent-quit-alist nil
  "Alist of nicks that have recently quit or parted the channel.")

418 419 420 421 422 423 424 425
(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.")

426 427 428
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
429
(defvar rcirc-activity nil
430
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
431 432

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

436 437
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
438 439 440 441 442

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

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

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

449
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
450 451

(defvar rcirc-startup-channels nil)
452

453 454 455 456 457 458 459 460 461
(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
462 463 464
(defvar rcirc-user-name-history nil
  "History variable for \\[rcirc] call.")

Richard M. Stallman's avatar
Richard M. Stallman committed
465
;;;###autoload
466
(defun rcirc (arg)
467
  "Connect to all servers in `rcirc-server-alist'.
468 469 470 471

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

If ARG is non-nil, instead prompt for connection parameters."
472 473
  (interactive "P")
  (if arg
474 475
      (let* ((server (completing-read "IRC Server: "
				      rcirc-server-alist
476
				      nil nil
477 478
				      (caar rcirc-server-alist)
				      'rcirc-server-name-history))
479 480
	     (server-plist (cdr (assoc-string server rcirc-server-alist)))
	     (port (read-string "IRC Port: "
481
				(number-to-string
482
				 (or (plist-get server-plist :port)
483 484
				     rcirc-default-port))
				'rcirc-server-port-history))
485
	     (nick (read-string "IRC Nick: "
486
				(or (plist-get server-plist :nick)
487 488
				    rcirc-default-nick)
				'rcirc-nick-name-history))
Ryan Yeske's avatar
Ryan Yeske committed
489 490 491 492
	     (user-name (read-string "IRC Username: "
                                     (or (plist-get server-plist :user-name)
                                         rcirc-default-user-name)
                                     'rcirc-user-name-history))
493 494
	     (password (read-passwd "IRC Password: " nil
                                    (plist-get server-plist :password)))
495 496
	     (channels (split-string
			(read-string "IRC Channels: "
497
				     (mapconcat 'identity
498
						(plist-get server-plist
499
							   :channels)
500
						" "))
501
			"[, ]+" t))
502
             (encryption (rcirc-prompt-for-encryption server-plist)))
503
	(rcirc-connect server port nick user-name
504
		       rcirc-default-full-name
505
		       channels password encryption))
506
    ;; connect to servers in `rcirc-server-alist'
507
    (let (connected-servers)
508
      (dolist (c rcirc-server-alist)
509
	(let ((server (car c))
510 511 512
	      (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)
513
			     rcirc-default-user-name))
514 515
	      (full-name (or (plist-get (cdr c) :full-name)
			     rcirc-default-full-name))
516
	      (channels (plist-get (cdr c) :channels))
517
              (password (plist-get (cdr c) :password))
518
              (encryption (plist-get (cdr c) :encryption))
519
              (server-alias (plist-get (cdr c) :server-alias))
520
              contact)
521 522 523
	  (when server
	    (let (connected)
	      (dolist (p (rcirc-process-list))
524
		(when (string= (or server-alias server) (process-name p))
525 526
		  (setq connected p)))
	      (if (not connected)
527
		  (condition-case nil
528
		      (rcirc-connect server port nick user-name
529 530 531 532
                                     full-name channels password encryption
                                     server-alias)
		    (quit (message "Quit connecting to %s"
                                   (or server-alias server))))
533
		(with-current-buffer (process-buffer connected)
534
                  (setq contact (process-contact
535
                                 (get-buffer-process (current-buffer)) :name))
536
                  (setq connected-servers
537 538
                        (cons (if (stringp contact)
                                  contact (or server-alias server))
539
                              connected-servers))))))))
540 541
      (when connected-servers
	(message "Already connected to %s"
542 543 544 545 546
		 (if (cdr connected-servers)
		     (concat (mapconcat 'identity (butlast connected-servers) ", ")
			     ", and "
			     (car (last connected-servers)))
		   (car connected-servers)))))))
547

Richard M. Stallman's avatar
Richard M. Stallman committed
548 549 550 551 552 553 554
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
555
(defvar rcirc-last-server-message-time nil)
556 557 558
(defvar rcirc-server nil)		; server provided by server
(defvar rcirc-server-name nil)		; server name given by 001 response
(defvar rcirc-timeout-timer nil)
559
(defvar rcirc-user-authenticated nil)
560 561
(defvar rcirc-user-disconnect nil)
(defvar rcirc-connecting nil)
Leo Liu's avatar
Leo Liu committed
562
(defvar rcirc-connection-info nil)
563
(defvar rcirc-process nil)
564 565

;;;###autoload
566
(defun rcirc-connect (server &optional port nick user-name
567 568
                             full-name startup-channels password encryption
                             server-alias)
Richard M. Stallman's avatar
Richard M. Stallman committed
569
  (save-excursion
570
    (message "Connecting to %s..." (or server-alias server))
Richard M. Stallman's avatar
Richard M. Stallman committed
571
    (let* ((inhibit-eol-conversion)
572 573 574 575
           (port-number (if port
			    (if (stringp port)
				(string-to-number port)
			      port)
576 577 578
			  rcirc-default-port))
	   (nick (or nick rcirc-default-nick))
	   (user-name (or user-name rcirc-default-user-name))
579
	   (full-name (or full-name rcirc-default-full-name))
580
	   (startup-channels startup-channels)
581
           (process (open-network-stream
582
                     (or server-alias server) nil server port-number
583
                     :type (or encryption 'plain))))
Richard M. Stallman's avatar
Richard M. Stallman committed
584 585
      ;; set up process
      (set-process-coding-system process 'raw-text 'raw-text)
586
      (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
587 588
      (set-process-buffer process (current-buffer))
      (rcirc-mode process nil)
589 590
      (set-process-sentinel process 'rcirc-sentinel)
      (set-process-filter process 'rcirc-filter)
591

Leo Liu's avatar
Leo Liu committed
592 593
      (setq-local rcirc-connection-info
		  (list server port nick user-name full-name startup-channels
594
			password encryption server-alias))
Leo Liu's avatar
Leo Liu committed
595 596
      (setq-local rcirc-process process)
      (setq-local rcirc-server server)
597 598
      (setq-local rcirc-server-name
                  (or server-alias server)) ; Update when we get 001 response.
Leo Liu's avatar
Leo Liu committed
599 600 601 602 603 604 605 606 607 608 609
      (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
610

611 612
      (add-hook 'auto-save-hook 'rcirc-log-write)

Richard M. Stallman's avatar
Richard M. Stallman committed
613
      ;; identify
614
      (unless (zerop (length password))
615
        (rcirc-send-string process (concat "PASS " password)))
Richard M. Stallman's avatar
Richard M. Stallman committed
616 617
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
Ryan Yeske's avatar
Ryan Yeske committed
618
                                         " 0 * :" full-name))
Richard M. Stallman's avatar
Richard M. Stallman committed
619 620

      ;; setup ping timer if necessary
621 622 623
      (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
624

625
      (message "Connecting to %s...done" (or server-alias server))
Richard M. Stallman's avatar
Richard M. Stallman committed
626 627 628 629

      ;; return process object
      process)))

630 631 632 633 634
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

635 636 637 638 639
(defmacro with-rcirc-server-buffer (&rest body)
  (declare (indent 0) (debug t))
  `(with-current-buffer rcirc-server-buffer
     ,@body))

640
(define-obsolete-function-alias 'rcirc-float-time 'float-time "26.1")
641

642 643 644 645 646 647
(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)
648
                     'plain)))
649 650
    (intern
     (completing-read (format msg default)
651
                      choices nil t nil nil (symbol-name default)))))
652

Richard M. Stallman's avatar
Richard M. Stallman committed
653
(defun rcirc-keepalive ()
654 655 656
  "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
657 658
  (if (rcirc-process-list)
      (mapc (lambda (process)
659 660
	      (with-rcirc-process-buffer process
		(when (not rcirc-connecting)
661 662 663
                  (rcirc-send-ctcp process
                                   rcirc-nick
                                   (format "KEEPALIVE %f"
664
                                           (float-time))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
665
            (rcirc-process-list))
666
    ;; no processes, clean up timer
667 668
    (when (timerp rcirc-keepalive-timer)
      (cancel-timer rcirc-keepalive-timer))
Richard M. Stallman's avatar
Richard M. Stallman committed
669 670
    (setq rcirc-keepalive-timer nil)))

671
(defun rcirc-handler-ctcp-KEEPALIVE (process _target _sender message)
672
  (with-rcirc-process-buffer process
673 674 675
    (setq header-line-format
	  (format "%f" (float-time
			(time-since (string-to-number message)))))))
676

677
(defvar rcirc-debug-buffer "*rcirc debug*")
678 679 680
(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
681
  "Add an entry to the debug log including PROCESS and TEXT.
682
Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
683 684
is non-nil."
  (when rcirc-debug-flag
685
    (with-current-buffer (get-buffer-create rcirc-debug-buffer)
686 687 688 689 690 691
      (goto-char (point-max))
      (insert (concat
	       "["
	       (format-time-string "%Y-%m-%dT%T ") (process-name process)
	       "] "
	       text)))))
692

Stefan Monnier's avatar
Stefan Monnier committed
693 694 695
(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
696 697 698
  "Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")

699
(defcustom rcirc-reconnect-delay 0
700
  "The minimum interval in seconds between reconnect attempts.
701
When 0, do not auto-reconnect."
Stefan Monnier's avatar
Stefan Monnier committed
702
  :version "25.1"
703 704 705 706 707 708
  :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
709 710 711
(defun rcirc-sentinel (process sentinel)
  "Called when PROCESS receives SENTINEL."
  (let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
712 713 714 715
    (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))
716 717 718 719
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
720 721
			       (process-status process))
                       (not rcirc-target))
722
	  (rcirc-disconnect-buffer)))
723 724 725 726
      (when (and (string= sentinel "deleted")
                 (< 0 rcirc-reconnect-delay))
        (let ((now (current-time)))
          (when (or (null rcirc-last-connect-time)
727 728
		    (time-less-p rcirc-reconnect-delay
				 (time-subtract now rcirc-last-connect-time)))
729
            (setq rcirc-last-connect-time now)
730
            (rcirc-cmd-reconnect nil))))
Stefan Monnier's avatar
Stefan Monnier committed
731
      (run-hook-with-args 'rcirc-sentinel-functions process sentinel))))
Richard M. Stallman's avatar
Richard M. Stallman committed
732

733 734 735
(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
736
    ;; doesn't happen when we reconnect
737
    (setq rcirc-target nil)
738
    (setq mode-line-process ":disconnected")))
739

Richard M. Stallman's avatar
Richard M. Stallman committed
740 741 742 743
(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
744
            (when (buffer-live-p (process-buffer p))
745
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
746 747 748 749 750
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

Stefan Monnier's avatar
Stefan Monnier committed
751 752 753
(define-obsolete-variable-alias 'rcirc-receive-message-hooks
  'rcirc-receive-message-functions "24.3")
(defvar rcirc-receive-message-functions nil
754 755
  "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
756 757
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
758
  (rcirc-debug process output)
759
  (rcirc-reschedule-timeout process)
760
  (with-rcirc-process-buffer process
761
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
762
    (setq rcirc-process-output (concat rcirc-process-output output))
763 764 765 766 767 768
    (when (= ?\n (aref rcirc-process-output
                       (1- (length rcirc-process-output))))
      (let ((lines (split-string rcirc-process-output "[\n\r]" t)))
        (setq rcirc-process-output nil)
        (dolist (line lines)
          (rcirc-process-server-response process line))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
769

770 771 772 773 774 775 776 777 778 779 780 781
(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))

782
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
783
(defun rcirc-process-server-response (process text)
784
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
785 786 787 788
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
789
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
790 791 792 793
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
794 795
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
796 797 798 799 800 801
             (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))
802 803
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805 806
        (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
807
        (run-hook-with-args 'rcirc-receive-message-functions
Richard M. Stallman's avatar
Richard M. Stallman committed
808 809 810
                            process cmd sender args text)))
    (message "UNHANDLED: %s" text)))

811 812 813
(defvar rcirc-responses-no-activity '("305" "306")
  "Responses that don't trigger activity in the mode-line indicator.")

814
(defun rcirc-handler-generic (process response sender args _text)
Richard M. Stallman's avatar
Richard M. Stallman committed
815
  "Generic server response handler."
816 817 818
  (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
819

820 821 822
(defun rcirc--connection-open-p (process)
  (memq (process-status process) '(run open)))

Richard M. Stallman's avatar
Richard M. Stallman committed
823 824
(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
825
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
826
                        "\n")))
827
    (unless (rcirc--connection-open-p process)
828
      (error "Network connection to %s is not open"
829
             (process-name process)))
830
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
831 832
    (process-send-string process string)))

833 834 835 836 837 838
(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
839
                        (format "\C-a%s%s\C-a" request args))))
840

841 842 843
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
844 845 846 847 848
  (let ((buffer (or buffer (and (buffer-live-p rcirc-server-buffer)
				rcirc-server-buffer))))
    (if buffer
        (with-current-buffer buffer rcirc-process)
      rcirc-process)))
849 850 851

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
852
  (with-rcirc-process-buffer process
853 854
    (or rcirc-server-name
	(warn "server name for process %S unknown" process))))
Richard M. Stallman's avatar
Richard M. Stallman committed
855 856 857

(defun rcirc-nick (process)
  "Return PROCESS nick."
858
  (with-rcirc-process-buffer process
859 860 861 862 863 864 865 866
    (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
867

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

871 872
(defun rcirc-split-message (message)
  "Split MESSAGE into chunks within `rcirc-max-message-length'."
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
  ;; `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)))))
890

891
(defun rcirc-send-message (process target message &optional noticep silent)
Richard M. Stallman's avatar
Richard M. Stallman committed
892
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
893 894
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."
895
  (let ((response (if noticep "NOTICE" "PRIVMSG")))
896
    (rcirc-get-buffer-create process target)
897 898 899 900
    (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
901 902 903

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

Richard M. Stallman's avatar
Richard M. Stallman committed
905 906 907
(defun rcirc-prev-input-string (arg)
  (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))

908 909
(defun rcirc-insert-prev-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
910 911 912 913 914
  (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))))

915 916
(defun rcirc-insert-next-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
917 918 919 920 921
  (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))))

922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
(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'."
941 942
  (and (rcirc-looking-at-input)
       (let* ((beg (save-excursion
Tassilo Horn's avatar
Tassilo Horn committed
943 944 945 946
                     ;; On some networks it is common to message or
                     ;; mention someone using @nick instead of just
                     ;; nick.
		     (if (re-search-backward "[[:space:]@]" rcirc-prompt-end-marker t)
947 948 949 950 951 952 953 954 955 956 957 958
			 (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))))
959 960 961 962 963 964

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

(defun rcirc-complete ()
  "Cycle through completions from list of nicks in channel or IRC commands.
965
IRC command completion is performed only if `/' is the first input char."
Richard M. Stallman's avatar
Richard M. Stallman committed
966
  (interactive)
967 968
  (unless (rcirc-looking-at-input)
    (error "Point not located after rcirc prompt"))
Miles Bader's avatar
Miles Bader committed
969
  (if (eq last-command this-command)
970 971 972 973 974 975
      (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
976 977 978 979
	    (and rcirc-completion-start
		 (all-completions (buffer-substring rcirc-completion-start
						    (cadr table))
				  (nth 2 table))))))
980
  (let ((completion (car rcirc-completions)))
Richard M. Stallman's avatar
Richard M. Stallman committed
981
    (when completion
982 983
      (delete-region rcirc-completion-start (point))
      (insert
984 985 986 987 988
       (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
989

990 991 992
(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
993
  (setq-local rcirc-decode-coding-system coding-system))
994 995 996 997

(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
998
  (setq-local rcirc-encode-coding-system coding-system))
Richard M. Stallman's avatar
Richard M. Stallman committed
999

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
(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
1026 1027
  "Keymap for rcirc mode.")

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

Richard M. Stallman's avatar
Richard M. Stallman committed
1031 1032 1033
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

1034 1035
(defvar rcirc-last-post-time nil)

1036 1037 1038 1039
(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).")

1040 1041 1042 1043
(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
1044
(defun rcirc-mode (process target)
1045
  ;; FIXME: Use define-derived-mode.
1046
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
1047 1048 1049 1050 1051 1052

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

Leo Liu's avatar
Leo Liu committed
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
  (setq-local rcirc-input-ring
	      ;; If rcirc-input-ring is already a ring with desired
	      ;; size do not re-initialize.
	      (if (and (ring-p rcirc-input-ring)
		       (= (ring-size rcirc-input-ring)
			  rcirc-input-ring-size))
		  rcirc-input-ring
		(make-ring rcirc-input-ring-size)))
  (setq-local rcirc-server-buffer (process-buffer process))
  (setq-local rcirc-target target)
  (setq-local rcirc-topic nil)
  (setq-local rcirc-last-post-time (current-time))
  (setq-local fill-paragraph-function 'rcirc-fill-paragraph)
  (setq-local rcirc-recent-quit-alist nil)
  (setq-local rcirc-current-line 0)
1070
  (setq-local rcirc-last-connect-time (current-time))
1071

1072
  (use-hard-newlines t)
Leo Liu's avatar
Leo Liu committed
1073 1074
  (setq-local rcirc-short-buffer-name nil)
  (setq-local rcirc-urls nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
1075

1076 1077 1078 1079
  ;; setup for omitting responses
  (setq buffer-invisibility-spec '())
  (setq buffer-display-table (make-display-table))
  (set-display-table-slot buffer-display-table 4
1080
			  (let ((glyph (make-glyph-code
1081 1082 1083
					?. 'font-lock-keyword-face)))
			    (make-vector 3 glyph)))

1084 1085 1086 1087 1088
  (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)))
Leo Liu's avatar
Leo Liu committed
1089 1090 1091 1092
	(setq-local rcirc-decode-coding-system
		    (if (consp (cdr i)) (cadr i) (cdr i)))
        (setq-local rcirc-encode-coding-system
		    (if (consp (cdr i)) (cddr i) (cdr i))))))
1093

Richard M. Stallman's avatar
Richard M. Stallman committed
1094
  ;; setup the prompt and markers
Leo Liu's avatar
Leo Liu committed
1095 1096
  (setq-local rcirc-prompt-start-marker (point-max-marker))
  (setq-local rcirc-prompt-end-marker (point-max-marker))
Richard M. Stallman's avatar
Richard M. Stallman committed
1097 1098
  (rcirc-update-prompt)
  (goto-char rcirc-prompt-end-marker)
1099

Leo Liu's avatar
Leo Liu committed
1100
  (setq-local overlay-arrow-position (make-marker))
Richard M. Stallman's avatar
Richard M. Stallman committed
1101

1102 1103
  ;; if the user changes the major mode or kills the buffer, there is
  ;; cleanup work to do
1104 1105