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-2016 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

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

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

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16

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

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

;;; Commentary:

27 28 29 30 31
;; Internet Relay Chat (IRC) is a form of instant communication over
;; the Internet. It is mainly designed for group (many-to-many)
;; communication in discussion forums called channels, but also allows
;; one-to-one communication.

Glenn Morris's avatar
Glenn Morris committed
32
;; Rcirc has simple defaults and clear and consistent behavior.
33
;; Message arrival timestamps, activity notification on the mode line,
34 35 36 37
;; message filling, nick completion, and keepalive pings are all
;; enabled by default, but can easily be adjusted or turned off.  Each
;; discussion takes place in its own buffer and there is a single
;; server buffer per connection.
Richard M. Stallman's avatar
Richard M. Stallman committed
38 39 40 41

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

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

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

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

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

57
(defcustom rcirc-server-alist
58 59 60 61
  '(("irc.freenode.net" :channels ("#rcirc")
     ;; Don't use the TLS port by default, in case gnutls is not available.
     ;; :port 7000 :encryption tls
     ))
62 63 64 65 66 67
  "An alist of IRC connections to establish when running `rcirc'.
Each element looks like (SERVER-NAME PARAMETERS).

SERVER-NAME is a string describing the server to connect
to.

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
The optional PARAMETERS come in pairs PARAMETER VALUE.

The following parameters are recognized:

`:nick'

VALUE must be a string.  If absent, `rcirc-default-nick' is used
for this connection.

`:port'

VALUE must be a number or string.  If absent,
`rcirc-default-port' is used.

`:user-name'

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

87 88 89 90 91
`:password'

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

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

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

`:channels'

VALUE must be a list of strings describing which channels to join
when connecting to this server.  If absent, no channels will be
101 102 103 104 105
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
(defvar rcirc-omit-mode nil
  "Non-nil if Rcirc-Omit mode is enabled.
Use the command `rcirc-omit-mode' to change this variable.")
(make-variable-buffer-local 'rcirc-omit-mode)

184
(defcustom rcirc-time-format "%H:%M "
185
  "Describes how timestamps are printed.
186 187 188
Used as the first arg to `format-time-string'."
  :type 'string
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
189

190
(defcustom rcirc-input-ring-size 1024
191
  "Size of input history ring."
192 193
  :type 'integer
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
194

195
(defcustom rcirc-read-only-flag t
196
  "Non-nil means make text in IRC buffers read-only."
197 198
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
199

200
(defcustom rcirc-buffer-maximum-lines nil
201
  "The maximum size in lines for rcirc buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
202
Channel buffers are truncated from the top to be no greater than this
203
number.  If zero or nil, no truncating is done."
204 205 206
  :type '(choice (const :tag "No truncation" nil)
		 (integer :tag "Number of lines"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
207

208
(defcustom rcirc-scroll-show-maximum-output t
209
  "If non-nil, scroll buffer to keep the point at the bottom of
210
the window."
211 212
  :type 'boolean
  :group 'rcirc)
Miles Bader's avatar
Miles Bader committed
213

214 215 216 217 218 219 220
(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
221

222 223
The ARGUMENTS for each METHOD symbol are:
  `nickserv': NICK PASSWORD [NICKSERV-NICK]
224 225
  `chanserv': NICK CHANNEL PASSWORD
  `bitlbee': NICK PASSWORD
226
  `quakenet': ACCOUNT PASSWORD
Richard M. Stallman's avatar
Richard M. Stallman committed
227

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

254
(defcustom rcirc-auto-authenticate-flag t
255
  "Non-nil means automatically send authentication string to server.
256
See also `rcirc-authinfo'."
257 258
  :type 'boolean
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
259

260
(defcustom rcirc-authenticate-before-join t
261
  "Non-nil means authenticate to services before joining channels.
262 263 264 265 266
Currently only works with NickServ on some networks."
  :version "24.1"
  :type 'boolean
  :group 'rcirc)

267
(defcustom rcirc-prompt "> "
268
  "Prompt string to use in IRC buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
269 270 271 272 273 274

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

275 276 277 278 279 280 281
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)

282 283 284 285 286
(defcustom rcirc-keywords nil
  "List of keywords to highlight in message text."
  :type '(repeat string)
  :group 'rcirc)

287 288 289 290 291 292 293 294 295 296 297 298
(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.")

299 300
(defcustom rcirc-bright-nicks nil
  "List of nicks to be emphasized.
301
See `rcirc-bright-nick' face."
302
  :type '(repeat string)
303 304
  :group 'rcirc)

305 306
(defcustom rcirc-dim-nicks nil
  "List of nicks to be deemphasized.
307
See `rcirc-dim-nick' face."
308
  :type '(repeat string)
309 310
  :group 'rcirc)

Stefan Monnier's avatar
Stefan Monnier committed
311 312 313
(define-obsolete-variable-alias 'rcirc-print-hooks
  'rcirc-print-functions "24.3")
(defcustom rcirc-print-functions nil
314 315 316 317
  "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
318

319 320 321
(defvar rcirc-authenticated-hook nil
  "Hook run after successfully authenticated.")

322 323 324 325 326
(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)

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

364 365 366 367 368 369
(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
370
  :version "24.1"
371 372 373
  :type 'string
  :group 'rcirc)

374 375 376 377
(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."
378
  :version "24.3"
379 380 381
  :type 'boolean
  :group 'rcirc)

382 383
(defvar rcirc-nick nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
384 385 386 387 388
(defvar rcirc-prompt-start-marker nil)
(defvar rcirc-prompt-end-marker nil)

(defvar rcirc-nick-table nil)

389 390 391
(defvar rcirc-recent-quit-alist nil
  "Alist of nicks that have recently quit or parted the channel.")

392 393 394 395 396 397 398 399
(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.")

400 401 402
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
403
(defvar rcirc-activity nil
404
  "List of buffers with unviewed activity.")
Richard M. Stallman's avatar
Richard M. Stallman committed
405 406

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

410 411
(defvar rcirc-server-buffer nil
  "The server buffer associated with this channel buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
412 413 414 415 416

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

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

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

423
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
Richard M. Stallman's avatar
Richard M. Stallman committed
424 425

(defvar rcirc-startup-channels nil)
426

427 428 429 430 431 432 433 434 435
(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
436 437 438
(defvar rcirc-user-name-history nil
  "History variable for \\[rcirc] call.")

Richard M. Stallman's avatar
Richard M. Stallman committed
439
;;;###autoload
440
(defun rcirc (arg)
441
  "Connect to all servers in `rcirc-server-alist'.
442 443 444 445

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
522 523 524 525 526 527 528
;;;###autoload
(defalias 'irc 'rcirc)


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
529
(defvar rcirc-last-server-message-time nil)
530 531 532
(defvar rcirc-server nil)		; server provided by server
(defvar rcirc-server-name nil)		; server name given by 001 response
(defvar rcirc-timeout-timer nil)
533
(defvar rcirc-user-authenticated nil)
534 535
(defvar rcirc-user-disconnect nil)
(defvar rcirc-connecting nil)
Leo Liu's avatar
Leo Liu committed
536
(defvar rcirc-connection-info nil)
537
(defvar rcirc-process nil)
538 539

;;;###autoload
540
(defun rcirc-connect (server &optional port nick user-name
541 542
                             full-name startup-channels password encryption
                             server-alias)
Richard M. Stallman's avatar
Richard M. Stallman committed
543
  (save-excursion
544
    (message "Connecting to %s..." (or server-alias server))
Richard M. Stallman's avatar
Richard M. Stallman committed
545
    (let* ((inhibit-eol-conversion)
546 547 548 549
           (port-number (if port
			    (if (stringp port)
				(string-to-number port)
			      port)
550 551 552
			  rcirc-default-port))
	   (nick (or nick rcirc-default-nick))
	   (user-name (or user-name rcirc-default-user-name))
553
	   (full-name (or full-name rcirc-default-full-name))
554
	   (startup-channels startup-channels)
555
           (process (open-network-stream
556
                     (or server-alias server) nil server port-number
557
                     :type (or encryption 'plain))))
Richard M. Stallman's avatar
Richard M. Stallman committed
558 559
      ;; set up process
      (set-process-coding-system process 'raw-text 'raw-text)
560
      (switch-to-buffer (rcirc-generate-new-buffer-name process nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
561 562
      (set-process-buffer process (current-buffer))
      (rcirc-mode process nil)
563 564
      (set-process-sentinel process 'rcirc-sentinel)
      (set-process-filter process 'rcirc-filter)
565

Leo Liu's avatar
Leo Liu committed
566 567 568 569 570
      (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)
571 572
      (setq-local rcirc-server-name
                  (or server-alias server)) ; Update when we get 001 response.
Leo Liu's avatar
Leo Liu committed
573 574 575 576 577 578 579 580 581 582 583
      (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
584

585 586
      (add-hook 'auto-save-hook 'rcirc-log-write)

Richard M. Stallman's avatar
Richard M. Stallman committed
587
      ;; identify
588
      (unless (zerop (length password))
589
        (rcirc-send-string process (concat "PASS " password)))
Richard M. Stallman's avatar
Richard M. Stallman committed
590 591
      (rcirc-send-string process (concat "NICK " nick))
      (rcirc-send-string process (concat "USER " user-name
Ryan Yeske's avatar
Ryan Yeske committed
592
                                         " 0 * :" full-name))
Richard M. Stallman's avatar
Richard M. Stallman committed
593 594

      ;; setup ping timer if necessary
595 596 597
      (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
598

599
      (message "Connecting to %s...done" (or server-alias server))
Richard M. Stallman's avatar
Richard M. Stallman committed
600 601 602 603

      ;; return process object
      process)))

604 605 606 607 608
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

609 610 611 612 613
(defmacro with-rcirc-server-buffer (&rest body)
  (declare (indent 0) (debug t))
  `(with-current-buffer rcirc-server-buffer
     ,@body))

614
(define-obsolete-function-alias 'rcirc-float-time 'float-time "25.2")
615

616 617 618 619 620 621
(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)
622
                     'plain)))
623 624
    (intern
     (completing-read (format msg default)
625
                      choices nil t nil nil (symbol-name default)))))
626

Richard M. Stallman's avatar
Richard M. Stallman committed
627
(defun rcirc-keepalive ()
628 629 630
  "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
631 632
  (if (rcirc-process-list)
      (mapc (lambda (process)
633 634
	      (with-rcirc-process-buffer process
		(when (not rcirc-connecting)
635 636 637
                  (rcirc-send-ctcp process
                                   rcirc-nick
                                   (format "KEEPALIVE %f"
638
                                           (float-time))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
639
            (rcirc-process-list))
640
    ;; no processes, clean up timer
641 642
    (when (timerp rcirc-keepalive-timer)
      (cancel-timer rcirc-keepalive-timer))
Richard M. Stallman's avatar
Richard M. Stallman committed
643 644
    (setq rcirc-keepalive-timer nil)))

645
(defun rcirc-handler-ctcp-KEEPALIVE (process _target _sender message)
646
  (with-rcirc-process-buffer process
647
    (setq header-line-format (format "%f" (- (float-time)
648 649
					     (string-to-number message))))))

650
(defvar rcirc-debug-buffer "*rcirc debug*")
651 652 653
(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
654
  "Add an entry to the debug log including PROCESS and TEXT.
655
Debug text is written to `rcirc-debug-buffer' if `rcirc-debug-flag'
656 657
is non-nil."
  (when rcirc-debug-flag
658
    (with-current-buffer (get-buffer-create rcirc-debug-buffer)
659 660 661 662 663 664
      (goto-char (point-max))
      (insert (concat
	       "["
	       (format-time-string "%Y-%m-%dT%T ") (process-name process)
	       "] "
	       text)))))
665

Stefan Monnier's avatar
Stefan Monnier committed
666 667 668
(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
669 670 671
  "Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")

672
(defcustom rcirc-reconnect-delay 0
673
  "The minimum interval in seconds between reconnect attempts.
674
When 0, do not auto-reconnect."
Stefan Monnier's avatar
Stefan Monnier committed
675
  :version "25.1"
676 677 678 679 680 681
  :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
682 683 684
(defun rcirc-sentinel (process sentinel)
  "Called when PROCESS receives SENTINEL."
  (let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
685 686 687 688
    (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))
689 690 691 692
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
693 694
			       (process-status process))
                       (not rcirc-target))
695
	  (rcirc-disconnect-buffer)))
696 697 698 699 700 701
      (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))))
702
            (setq rcirc-last-connect-time now)
703
            (rcirc-cmd-reconnect nil))))
Stefan Monnier's avatar
Stefan Monnier committed
704
      (run-hook-with-args 'rcirc-sentinel-functions process sentinel))))
Richard M. Stallman's avatar
Richard M. Stallman committed
705

706 707 708
(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
709
    ;; doesn't happen when we reconnect
710
    (setq rcirc-target nil)
711
    (setq mode-line-process ":disconnected")))
712

Richard M. Stallman's avatar
Richard M. Stallman committed
713 714 715 716
(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
717
            (when (buffer-live-p (process-buffer p))
718
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
719 720 721 722 723
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

Stefan Monnier's avatar
Stefan Monnier committed
724 725 726
(define-obsolete-variable-alias 'rcirc-receive-message-hooks
  'rcirc-receive-message-functions "24.3")
(defvar rcirc-receive-message-functions nil
727 728
  "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
729 730
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
731
  (rcirc-debug process output)
732
  (rcirc-reschedule-timeout process)
733
  (with-rcirc-process-buffer process
734
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
735 736 737 738 739
    (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))
740
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
741 742
      (setq rcirc-process-output nil))))

743 744 745 746 747 748 749 750 751 752 753 754
(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))

755
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
756
(defun rcirc-process-server-response (process text)
757
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
758 759 760 761
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
762
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
763 764 765 766
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
767 768
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
769 770 771 772 773 774
             (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))
775 776
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
777 778 779
        (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
780
        (run-hook-with-args 'rcirc-receive-message-functions
Richard M. Stallman's avatar
Richard M. Stallman committed
781 782 783
                            process cmd sender args text)))
    (message "UNHANDLED: %s" text)))

784 785 786
(defvar rcirc-responses-no-activity '("305" "306")
  "Responses that don't trigger activity in the mode-line indicator.")

787
(defun rcirc-handler-generic (process response sender args _text)
Richard M. Stallman's avatar
Richard M. Stallman committed
788
  "Generic server response handler."
789 790 791
  (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
792

793 794 795
(defun rcirc--connection-open-p (process)
  (memq (process-status process) '(run open)))

Richard M. Stallman's avatar
Richard M. Stallman committed
796 797
(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
798
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
799
                        "\n")))
800
    (unless (rcirc--connection-open-p process)
801
      (error "Network connection to %s is not open"
802
             (process-name process)))
803
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805
    (process-send-string process string)))

806 807 808 809 810 811
(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
812
                        (format "\C-a%s%s\C-a" request args))))
813

814 815 816
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
817 818 819 820 821
  (let ((buffer (or buffer (and (buffer-live-p rcirc-server-buffer)
				rcirc-server-buffer))))
    (if buffer
        (with-current-buffer buffer rcirc-process)
      rcirc-process)))
822 823 824

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
825
  (with-rcirc-process-buffer process
826 827
    (or rcirc-server-name
	(warn "server name for process %S unknown" process))))
Richard M. Stallman's avatar
Richard M. Stallman committed
828 829 830

(defun rcirc-nick (process)
  "Return PROCESS nick."
831
  (with-rcirc-process-buffer process
832 833 834 835 836 837 838 839
    (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
840

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

844 845
(defun rcirc-split-message (message)
  "Split MESSAGE into chunks within `rcirc-max-message-length'."
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
  ;; `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)))))
863

864
(defun rcirc-send-message (process target message &optional noticep silent)
Richard M. Stallman's avatar
Richard M. Stallman committed
865
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
866 867
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."
868
  (let ((response (if noticep "NOTICE" "PRIVMSG")))
869
    (rcirc-get-buffer-create process target)
870 871 872 873
    (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
874 875 876

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

Richard M. Stallman's avatar
Richard M. Stallman committed
878 879 880
(defun rcirc-prev-input-string (arg)
  (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))

881 882
(defun rcirc-insert-prev-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
883 884 885 886 887
  (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))))

888 889
(defun rcirc-insert-next-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
890 891 892 893 894
  (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))))

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
(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'."
914 915
  (and (rcirc-looking-at-input)
       (let* ((beg (save-excursion
Tassilo Horn's avatar
Tassilo Horn committed
916 917 918 919
                     ;; 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)
920 921 922 923 924 925 926 927 928 929 930 931
			 (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))))
932 933 934 935 936 937

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

(defun rcirc-complete ()
  "Cycle through completions from list of nicks in channel or IRC commands.
938
IRC command completion is performed only if `/' is the first input char."
Richard M. Stallman's avatar
Richard M. Stallman committed
939
  (interactive)
940 941
  (unless (rcirc-looking-at-input)
    (error "Point not located after rcirc prompt"))
Miles Bader's avatar
Miles Bader committed
942
  (if (eq last-command this-command)
943 944 945 946 947 948
      (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
949 950 951 952
	    (and rcirc-completion-start
		 (all-completions (buffer-substring rcirc-completion-start
						    (cadr table))
				  (nth 2 table))))))
953
  (let ((completion (car rcirc-completions)))
Richard M. Stallman's avatar
Richard M. Stallman committed
954
    (when completion
955 956
      (delete-region rcirc-completion-start (point))
      (insert
957 958 959 960 961
       (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
962

963 964 965
(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
966
  (setq-local rcirc-decode-coding-system coding-system))