rcirc.el 112 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-2017 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 <httpss://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
(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
174

175 176 177 178
(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)

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
(defcustom rcirc-omit-responses
  '("JOIN" "PART" "QUIT" "NICK")
  "Responses which will be hidden when `rcirc-omit-mode' is enabled."
  :type '(repeat string)
  :group 'rcirc)

(define-minor-mode rcirc-omit-mode
  "Toggle the hiding of \"uninteresting\" lines.
With a prefix argument ARG, enable Rcirc-Omit mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.

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

204
(defcustom rcirc-time-format "%H:%M "
205
  "Describes how timestamps are printed.
206 207 208
Used as the first arg to `format-time-string'."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
209

210
(defcustom rcirc-input-ring-size 1024
211
  "Size of input history ring."
212 213
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
214

215
(defcustom rcirc-read-only-flag t
216
  "Non-nil means make text in IRC buffers read-only."
217 218
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
219

220
(defcustom rcirc-buffer-maximum-lines nil
221
  "The maximum size in lines for rcirc buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
222
Channel buffers are truncated from the top to be no greater than this
223
number.  If zero or nil, no truncating is done."
224 225 226
  :type '(choice (const :tag "No truncation" nil)
		 (integer :tag "Number of lines"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
227

228
(defcustom rcirc-scroll-show-maximum-output t
229
  "If non-nil, scroll buffer to keep the point at the bottom of
230
the window."
231 232
  :type 'boolean
  :group 'rcirc)
Miles Bader's avatar
Miles Bader committed
233

234 235 236 237 238 239 240
(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
241

242 243
The ARGUMENTS for each METHOD symbol are:
  `nickserv': NICK PASSWORD [NICKSERV-NICK]
244 245
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
246
  `quakenet': ACCOUNT PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
247

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

274
(defcustom rcirc-auto-authenticate-flag t
275
  "Non-nil means automatically send authentication string to server.
276
See also `rcirc-authinfo'."
277 278
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
279

280
(defcustom rcirc-authenticate-before-join t
281
  "Non-nil means authenticate to services before joining channels.
282 283 284 285 286
Currently only works with NickServ on some networks."
  :version "24.1"
  :type 'boolean
  :group 'rcirc)

287
(defcustom rcirc-prompt "> "
288
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
289 290 291 292 293 294

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

295 296 297 298 299 300 301
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)

302 303 304 305 306
(defcustom rcirc-keywords nil
  "List of keywords to highlight in message text."
  :type '(repeat string)
  :group 'rcirc)

307 308 309 310 311 312 313 314 315 316 317 318
(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.")

319 320
(defcustom rcirc-bright-nicks nil
  "List of nicks to be emphasized.
321
See `rcirc-bright-nick' face."
322
  :type '(repeat string)
323 324
  :group 'rcirc)

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

Stefan Monnier's avatar
Stefan Monnier committed
331 332 333
(define-obsolete-variable-alias 'rcirc-print-hooks
  'rcirc-print-functions "24.3")
(defcustom rcirc-print-functions nil
334 335 336 337
  "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
338

339 340 341
(defvar rcirc-authenticated-hook nil
  "Hook run after successfully authenticated.")

342 343 344 345 346
(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)

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

384 385 386 387 388 389
(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
390
  :version "24.1"
391 392 393
  :type 'string
  :group 'rcirc)

394 395 396 397
(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."
398
  :version "24.3"
399 400 401
  :type 'boolean
  :group 'rcirc)

402 403
(defvar rcirc-nick nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
404 405 406 407 408
(defvar rcirc-prompt-start-marker nil)
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

409 410 411
(defvar rcirc-recent-quit-alist nil
  "Alist of nicks that have recently quit or parted the channel.")

412 413 414 415 416 417 418 419
(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.")

420 421 422
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
423
(defvar rcirc-activity nil
424
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
425 426

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

430 431
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
432 433 434 435 436

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

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

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

443
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
444 445

(defvar rcirc-startup-channels nil)
446

447 448 449 450 451 452 453 454 455
(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
456 457 458
(defvar rcirc-user-name-history nil
  "History variable for \\[rcirc] call.")

Richard M. Stallman's avatar
Richard M. Stallman committed
459
;;;###autoload
460
(defun rcirc (arg)
461
  "Connect to all servers in `rcirc-server-alist'.
462 463 464 465

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
542 543 544 545 546 547 548
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
549
(defvar rcirc-last-server-message-time nil)
550 551 552
(defvar rcirc-server nil)		; server provided by server
(defvar rcirc-server-name nil)		; server name given by 001 response
(defvar rcirc-timeout-timer nil)
553
(defvar rcirc-user-authenticated nil)
554 555
(defvar rcirc-user-disconnect nil)
(defvar rcirc-connecting nil)
Leo Liu's avatar
Leo Liu committed
556
(defvar rcirc-connection-info nil)
557
(defvar rcirc-process nil)
558 559

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

Leo Liu's avatar
Leo Liu committed
586 587 588 589 590
      (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)
591 592
      (setq-local rcirc-server-name
                  (or server-alias server)) ; Update when we get 001 response.
Leo Liu's avatar
Leo Liu committed
593 594 595 596 597 598 599 600 601 602 603
      (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
604

605 606
      (add-hook 'auto-save-hook 'rcirc-log-write)

Richard M. Stallman's avatar
Richard M. Stallman committed
607
      ;; identify
608
      (unless (zerop (length password))
609
        (rcirc-send-string process (concat "PASS " password)))
Richard M. Stallman's avatar
Richard M. Stallman committed
610 611
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
Ryan Yeske's avatar
Ryan Yeske committed
612
                                         " 0 * :" full-name))
Richard M. Stallman's avatar
Richard M. Stallman committed
613 614

      ;; setup ping timer if necessary
615 616 617
      (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
618

619
      (message "Connecting to %s...done" (or server-alias server))
Richard M. Stallman's avatar
Richard M. Stallman committed
620 621 622 623

      ;; return process object
      process)))

624 625 626 627 628
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

629 630 631 632 633
(defmacro with-rcirc-server-buffer (&rest body)
  (declare (indent 0) (debug t))
  `(with-current-buffer rcirc-server-buffer
     ,@body))

634
(define-obsolete-function-alias 'rcirc-float-time 'float-time "26.1")
635

636 637 638 639 640 641
(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)
642
                     'plain)))
643 644
    (intern
     (completing-read (format msg default)
645
                      choices nil t nil nil (symbol-name default)))))
646

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

665
(defun rcirc-handler-ctcp-KEEPALIVE (process _target _sender message)
666
  (with-rcirc-process-buffer process
667
    (setq header-line-format (format "%f" (- (float-time)
668 669
					     (string-to-number message))))))

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

Stefan Monnier's avatar
Stefan Monnier committed
686 687 688
(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
689 690 691
  "Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")

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

726 727 728
(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
729
    ;; doesn't happen when we reconnect
730
    (setq rcirc-target nil)
731
    (setq mode-line-process ":disconnected")))
732

Richard M. Stallman's avatar
Richard M. Stallman committed
733 734 735 736
(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
737
            (when (buffer-live-p (process-buffer p))
738
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
739 740 741 742 743
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

Stefan Monnier's avatar
Stefan Monnier committed
744 745 746
(define-obsolete-variable-alias 'rcirc-receive-message-hooks
  'rcirc-receive-message-functions "24.3")
(defvar rcirc-receive-message-functions nil
747 748
  "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
749 750
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
751
  (rcirc-debug process output)
752
  (rcirc-reschedule-timeout process)
753
  (with-rcirc-process-buffer process
754
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
755 756 757 758 759
    (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))
760
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
761 762
      (setq rcirc-process-output nil))))

763 764 765 766 767 768 769 770 771 772 773 774
(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))

775
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
776
(defun rcirc-process-server-response (process text)
777
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
778 779 780 781
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
782
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
783 784 785 786
    (rcirc-process-server-response-1 process text)))

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

804 805 806
(defvar rcirc-responses-no-activity '("305" "306")
  "Responses that don't trigger activity in the mode-line indicator.")

807
(defun rcirc-handler-generic (process response sender args _text)
Richard M. Stallman's avatar
Richard M. Stallman committed
808
  "Generic server response handler."
809 810 811
  (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
812

813 814 815
(defun rcirc--connection-open-p (process)
  (memq (process-status process) '(run open)))

Richard M. Stallman's avatar
Richard M. Stallman committed
816 817
(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
818
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
819
                        "\n")))
820
    (unless (rcirc--connection-open-p process)
821
      (error "Network connection to %s is not open"
822
             (process-name process)))
823
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
824 825
    (process-send-string process string)))

826 827 828 829 830 831
(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
832
                        (format "\C-a%s%s\C-a" request args))))
833

834 835 836
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
837 838 839 840 841
  (let ((buffer (or buffer (and (buffer-live-p rcirc-server-buffer)
				rcirc-server-buffer))))
    (if buffer
        (with-current-buffer buffer rcirc-process)
      rcirc-process)))
842 843 844

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
845
  (with-rcirc-process-buffer process
846 847
    (or rcirc-server-name
	(warn "server name for process %S unknown" process))))
Richard M. Stallman's avatar
Richard M. Stallman committed
848 849 850

(defun rcirc-nick (process)
  "Return PROCESS nick."
851
  (with-rcirc-process-buffer process
852 853 854 855 856 857 858 859
    (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
860

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

864 865
(defun rcirc-split-message (message)
  "Split MESSAGE into chunks within `rcirc-max-message-length'."
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
  ;; `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)))))
883

884
(defun rcirc-send-message (process target message &optional noticep silent)
Richard M. Stallman's avatar
Richard M. Stallman committed
885
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
886 887
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."
888
  (let ((response (if noticep "NOTICE" "PRIVMSG")))
889
    (rcirc-get-buffer-create process target)
890 891 892 893
    (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
894 895 896

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

Richard M. Stallman's avatar
Richard M. Stallman committed
898 899 900
(defun rcirc-prev-input-string (arg)
  (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))

901 902
(defun rcirc-insert-prev-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
903 904 905 906 907
  (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))))

908 909
(defun rcirc-insert-next-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))
    (setq rcirc-input-ring-index (1- rcirc-input-ring-index))
    (insert (rcirc-prev-input-string -1))))

915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
(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'."
934 935
  (and (rcirc-looking-at-input)
       (let* ((beg (save-excursion
Tassilo Horn's avatar
Tassilo Horn committed
936 937 938 939
                     ;; 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)
940 941 942 943 944 945 946 947 948 949 950 951
			 (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))))
952 953 954 955 956 957

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

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