rcirc.el 109 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; rcirc.el --- default, simple IRC client.

3
;; Copyright (C) 2005-2012 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
;;              Deniz Dogan <deniz@dogan.se>
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 46 47 48 49
;;; Code:

(require 'ring)
(require 'time-date)
(eval-when-compile (require 'cl))

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

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

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

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

The following parameters are recognized:

`:nick'

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

`:port'

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

`:user-name'

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

87 88 89 90 91
`:password'

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

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

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

`:channels'

VALUE must be a list of strings describing which channels to join
when connecting to this server.  If absent, no channels will be
101 102 103 104 105 106
connected to automatically.

`:encryption'

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

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

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

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

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

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

146
(defcustom rcirc-fill-column nil
147
  "Column beyond which automatic line-wrapping should happen.
148 149
If nil, use value of `fill-column'.  If 'frame-width, use the
maximum frame width."
150 151 152 153
  :type '(choice (const :tag "Value of `fill-column'")
		 (const :tag "Full frame width" frame-width)
		 (integer :tag "Number of columns"))
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
154

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

163 164 165
(defvar rcirc-ignore-buffer-activity-flag nil
  "If non-nil, ignore activity in this buffer.")
(make-variable-buffer-local 'rcirc-ignore-buffer-activity-flag)
Richard M. Stallman's avatar
Richard M. Stallman committed
166

167 168 169 170
(defvar rcirc-low-priority-flag nil
  "If non-nil, activity in this buffer is considered low priority.")
(make-variable-buffer-local 'rcirc-low-priority-flag)

171 172 173 174 175
(defvar rcirc-omit-mode nil
  "Non-nil if Rcirc-Omit mode is enabled.
Use the command `rcirc-omit-mode' to change this variable.")
(make-variable-buffer-local 'rcirc-omit-mode)

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

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

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

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

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

206 207 208 209 210 211 212
(defcustom rcirc-authinfo nil
  "List of authentication passwords.
Each element of the list is a list with a SERVER-REGEXP string
and a method symbol followed by method specific arguments.

The valid METHOD symbols are `nickserv', `chanserv' and
`bitlbee'.
Richard M. Stallman's avatar
Richard M. Stallman committed
213

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

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

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

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

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

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

267 268 269 270 271 272 273
Setting this alone will not affect the prompt;
use either M-x customize or also call `rcirc-update-prompt'."
  :type 'string
  :set 'rcirc-set-changed
  :initialize 'custom-initialize-default
  :group 'rcirc)

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

279 280 281 282 283 284 285 286 287 288 289 290
(defcustom rcirc-ignore-list ()
  "List of ignored nicks.
Use /ignore to list them, use /ignore NICK to add or remove a nick."
  :type '(repeat string)
  :group 'rcirc)

(defvar rcirc-ignore-list-automatic ()
  "List of ignored nicks added to `rcirc-ignore-list' because of renaming.
When an ignored person renames, their nick is added to both lists.
Nicks will be removed from the automatic list on follow-up renamings or
parts.")

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

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

303 304 305 306 307
(defcustom rcirc-print-hooks nil
  "Hook run after text is printed.
Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT."
  :type 'hook
  :group 'rcirc)
Richard M. Stallman's avatar
Richard M. Stallman committed
308

309 310 311
(defvar rcirc-authenticated-hook nil
  "Hook run after successfully authenticated.")

312 313 314 315 316
(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)

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

354 355 356 357 358 359
(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
360
  :version "24.1"
361 362 363
  :type 'string
  :group 'rcirc)

364 365 366 367
(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."
368
  :version "24.3"
369 370 371
  :type 'boolean
  :group 'rcirc)

372 373
(defvar rcirc-nick nil)

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

(defvar rcirc-nick-table nil)

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

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

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

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

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

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

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

(defvar rcirc-urls nil
  "List of urls seen in the current buffer.")
Miles Bader's avatar
Miles Bader committed
408
(put 'rcirc-urls 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
409

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

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

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

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

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

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

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


(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
515
(defvar rcirc-last-server-message-time nil)
516 517 518
(defvar rcirc-server nil)		; server provided by server
(defvar rcirc-server-name nil)		; server name given by 001 response
(defvar rcirc-timeout-timer nil)
519
(defvar rcirc-user-authenticated nil)
520 521 522
(defvar rcirc-user-disconnect nil)
(defvar rcirc-connecting nil)
(defvar rcirc-process nil)
523 524

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

      (set (make-local-variable 'rcirc-process) process)
      (set (make-local-variable 'rcirc-server) server)
      (set (make-local-variable 'rcirc-server-name) server) ; Update when we get 001 response.
      (set (make-local-variable 'rcirc-buffer-alist) nil)
      (set (make-local-variable 'rcirc-nick-table)
           (make-hash-table :test 'equal))
      (set (make-local-variable 'rcirc-nick) nick)
      (set (make-local-variable 'rcirc-process-output) nil)
      (set (make-local-variable 'rcirc-startup-channels) startup-channels)
      (set (make-local-variable 'rcirc-last-server-message-time)
           (current-time))

      (set (make-local-variable 'rcirc-timeout-timer) nil)
      (set (make-local-variable 'rcirc-user-disconnect) nil)
      (set (make-local-variable 'rcirc-user-authenticated) nil)
      (set (make-local-variable 'rcirc-connecting) t)
Richard M. Stallman's avatar
Richard M. Stallman committed
566

567 568
      (add-hook 'auto-save-hook 'rcirc-log-write)

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

      ;; setup ping timer if necessary
577 578 579
      (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
580 581 582 583 584 585

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

      ;; return process object
      process)))

586 587 588 589 590
(defmacro with-rcirc-process-buffer (process &rest body)
  (declare (indent 1) (debug t))
  `(with-current-buffer (process-buffer ,process)
     ,@body))

591 592 593 594 595
(defmacro with-rcirc-server-buffer (&rest body)
  (declare (indent 0) (debug t))
  `(with-current-buffer rcirc-server-buffer
     ,@body))

596 597 598 599 600
(defun rcirc-float-time ()
  (if (featurep 'xemacs)
      (time-to-seconds (current-time))
    (float-time)))

601 602 603 604 605 606
(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)
607
                     'plain)))
608 609
    (intern
     (completing-read (format msg default)
610
                      choices nil t nil nil (symbol-name default)))))
611

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

629 630
(defun rcirc-handler-ctcp-KEEPALIVE (process target sender message)
  (with-rcirc-process-buffer process
631
    (setq header-line-format (format "%f" (- (rcirc-float-time)
632 633
					     (string-to-number message))))))

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

Richard M. Stallman's avatar
Richard M. Stallman committed
650 651 652 653 654 655 656
(defvar rcirc-sentinel-hooks nil
  "Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")

(defun rcirc-sentinel (process sentinel)
  "Called when PROCESS receives SENTINEL."
  (let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
657 658 659 660
    (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))
661 662 663 664
	  (rcirc-print process "rcirc.el" "ERROR" rcirc-target
		       (format "%s: %s (%S)"
			       (process-name process)
			       sentinel
665
			       (process-status process)) (not rcirc-target))
666
	  (rcirc-disconnect-buffer)))
667
      (run-hook-with-args 'rcirc-sentinel-hooks process sentinel))))
Richard M. Stallman's avatar
Richard M. Stallman committed
668

669 670 671
(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
672
    ;; doesn't happen when we reconnect
673
    (setq rcirc-target nil)
674
    (setq mode-line-process ":disconnected")))
675

Richard M. Stallman's avatar
Richard M. Stallman committed
676 677 678 679
(defun rcirc-process-list ()
  "Return a list of rcirc processes."
  (let (ps)
    (mapc (lambda (p)
680
            (when (buffer-live-p (process-buffer p))
681
              (with-rcirc-process-buffer p
Richard M. Stallman's avatar
Richard M. Stallman committed
682 683 684 685 686 687
                (when (eq major-mode 'rcirc-mode)
                  (setq ps (cons p ps))))))
          (process-list))
    ps))

(defvar rcirc-receive-message-hooks nil
688 689
  "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
690 691
(defun rcirc-filter (process output)
  "Called when PROCESS receives OUTPUT."
692
  (rcirc-debug process output)
693
  (rcirc-reschedule-timeout process)
694
  (with-rcirc-process-buffer process
695
    (setq rcirc-last-server-message-time (current-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
696 697 698 699 700
    (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))
701
            (split-string rcirc-process-output "[\n\r]" t))
Richard M. Stallman's avatar
Richard M. Stallman committed
702 703
      (setq rcirc-process-output nil))))

704 705 706 707 708 709 710 711 712 713 714 715
(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))

716
(defvar rcirc-trap-errors-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
717
(defun rcirc-process-server-response (process text)
718
  (if rcirc-trap-errors-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
719 720 721 722
      (condition-case err
          (rcirc-process-server-response-1 process text)
        (error
         (rcirc-print process "RCIRC" "ERROR" nil
723
                      (format "\"%s\" %s" text err) t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
724 725 726 727
    (rcirc-process-server-response-1 process text)))

(defun rcirc-process-server-response-1 (process text)
  (if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\) \\(.+\\)$" text)
728 729
      (let* ((user (match-string 2 text))
	     (sender (rcirc-user-nick user))
Richard M. Stallman's avatar
Richard M. Stallman committed
730 731 732 733 734 735
             (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))
736 737
               (args (delq nil (append (split-string args1 " " t)
				       (list args2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
738 739 740 741 742 743 744
        (if (not (fboundp handler))
            (rcirc-handler-generic process cmd sender args text)
          (funcall handler process sender args text))
        (run-hook-with-args 'rcirc-receive-message-hooks
                            process cmd sender args text)))
    (message "UNHANDLED: %s" text)))

745 746 747 748
(defvar rcirc-responses-no-activity '("305" "306")
  "Responses that don't trigger activity in the mode-line indicator.")

(defun rcirc-handler-generic (process response sender args text)
Richard M. Stallman's avatar
Richard M. Stallman committed
749
  "Generic server response handler."
750 751 752
  (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
753

754 755 756
(defun rcirc--connection-open-p (process)
  (memq (process-status process) '(run open)))

Richard M. Stallman's avatar
Richard M. Stallman committed
757 758
(defun rcirc-send-string (process string)
  "Send PROCESS a STRING plus a newline."
759
  (let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
760
                        "\n")))
761
    (unless (rcirc--connection-open-p process)
762
      (error "Network connection to %s is not open"
763
             (process-name process)))
764
    (rcirc-debug process string)
Richard M. Stallman's avatar
Richard M. Stallman committed
765 766
    (process-send-string process string)))

767 768 769 770 771 772
(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
773
                        (format "\C-a%s%s\C-a" request args))))
774

775 776 777
(defun rcirc-buffer-process (&optional buffer)
  "Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
778 779 780 781 782
  (or (get-buffer-process (if buffer
			      (with-current-buffer buffer
				rcirc-server-buffer)
			    rcirc-server-buffer))
      rcirc-process))
783 784 785

(defun rcirc-server-name (process)
  "Return PROCESS server name, given by the 001 response."
786
  (with-rcirc-process-buffer process
787 788
    (or rcirc-server-name
	(warn "server name for process %S unknown" process))))
Richard M. Stallman's avatar
Richard M. Stallman committed
789 790 791

(defun rcirc-nick (process)
  "Return PROCESS nick."
792
  (with-rcirc-process-buffer process
793 794 795 796 797 798 799 800
    (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
801

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

805 806
(defun rcirc-split-message (message)
  "Split MESSAGE into chunks within `rcirc-max-message-length'."
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
  ;; `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)))))
824

825
(defun rcirc-send-message (process target message &optional noticep silent)
Richard M. Stallman's avatar
Richard M. Stallman committed
826
  "Send TARGET associated with PROCESS a privmsg with text MESSAGE.
827 828
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."
829
  (let ((response (if noticep "NOTICE" "PRIVMSG")))
830
    (rcirc-get-buffer-create process target)
831 832 833 834
    (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
835 836 837

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

Richard M. Stallman's avatar
Richard M. Stallman committed
839 840 841
(defun rcirc-prev-input-string (arg)
  (ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))

842 843
(defun rcirc-insert-prev-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
844 845 846 847 848
  (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))))

849 850
(defun rcirc-insert-next-input ()
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
851 852 853 854 855
  (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))))

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
(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'."
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
  (and (rcirc-looking-at-input)
       (let* ((beg (save-excursion
		     (if (re-search-backward " " rcirc-prompt-end-marker t)
			 (1+ (point))
		       rcirc-prompt-end-marker)))
	      (table (if (and (= beg rcirc-prompt-end-marker)
			      (eq (char-after beg) ?/))
			 (delete-dups
			  (nconc (sort (copy-sequence rcirc-client-commands)
				       'string-lessp)
				 (sort (copy-sequence rcirc-server-commands)
				       'string-lessp)))
		       (rcirc-channel-nicks (rcirc-buffer-process)
					    rcirc-target))))
	 (list beg (point) table))))
890 891 892 893 894 895 896

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

(defun rcirc-complete ()
  "Cycle through completions from list of nicks in channel or IRC commands.
IRC command completion is performed only if '/' is the first input char."
Richard M. Stallman's avatar
Richard M. Stallman committed
897
  (interactive)
898 899
  (unless (rcirc-looking-at-input)
    (error "Point not located after rcirc prompt"))
Miles Bader's avatar
Miles Bader committed
900
  (if (eq last-command this-command)
901 902 903 904 905 906
      (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
907 908 909 910
	    (and rcirc-completion-start
		 (all-completions (buffer-substring rcirc-completion-start
						    (cadr table))
				  (nth 2 table))))))
911
  (let ((completion (car rcirc-completions)))
Richard M. Stallman's avatar
Richard M. Stallman committed
912
    (when completion
913 914
      (delete-region rcirc-completion-start (point))
      (insert
915 916 917 918 919
       (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
920

921 922 923
(defun set-rcirc-decode-coding-system (coding-system)
  "Set the decode coding system used in this channel."
  (interactive "zCoding system for incoming messages: ")
924
  (set (make-local-variable 'rcirc-decode-coding-system) coding-system))
925 926 927 928

(defun set-rcirc-encode-coding-system (coding-system)
  "Set the encode coding system used in this channel."
  (interactive "zCoding system for outgoing messages: ")
929
  (set (make-local-variable 'rcirc-encode-coding-system) coding-system))
Richard M. Stallman's avatar
Richard M. Stallman committed
930

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
(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
957 958
  "Keymap for rcirc mode.")

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

Richard M. Stallman's avatar
Richard M. Stallman committed
962 963 964
(defvar rcirc-mode-hook nil
  "Hook run when setting up rcirc buffer.")

965 966
(defvar rcirc-last-post-time nil)

967 968 969 970
(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).")

971 972 973 974
(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
975
(defun rcirc-mode (process target)
976
  ;; FIXME: Use define-derived-mode.
977
  "Major mode for IRC channel buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
978 979 980 981 982 983

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

986
  (set (make-local-variable 'rcirc-input-ring)
987 988 989 990 991 992 993
       ;; 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)))
994 995 996 997 998 999 1000 1001
  (set (make-local-variable 'rcirc-server-buffer) (process-buffer process))
  (set (make-local-variable 'rcirc-target) target)
  (set (make-local-variable 'rcirc-topic) nil)
  (set (make-local-variable 'rcirc-last-post-time) (current-time))
  (set (make-local-variable 'fill-paragraph-function) 'rcirc-fill-paragraph)
  (set (make-local-variable 'rcirc-recent-quit-alist) nil)
  (set (make-local-variable 'rcirc-current-line) 0)

1002
  (use-hard-newlines t)
1003
  (set (make-local-variable 'rcirc-short-buffer-name) nil)
1004
  (set (make-local-variable 'rcirc-urls) nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
1005

1006 1007 1008 1009
  ;; setup for omitting responses
  (setq buffer-invisibility-spec '())
  (setq buffer-display-table (make-display-table))
  (set-display-table-slot buffer-display-table 4
1010
			  (let ((glyph (make-glyph-code
1011 1012 1013
					?. 'font-lock-keyword-face)))
			    (make-vector 3 glyph)))

1014 1015 1016 1017 1018
  (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)))
1019 1020 1021 1022
	(set (make-local-variable 'rcirc-decode-coding-system)
             (if (consp (cdr i)) (cadr i) (cdr i)))
        (set (make-local-variable 'rcirc-encode-coding-system)
             (if (consp (cdr i)) (cddr i) (cdr i))))))
1023

Richard M. Stallman's avatar
Richard M. Stallman committed
1024
  ;; setup the prompt and markers
1025 1026
  (set (make-local-variable 'rcirc-prompt-start-marker) (point-max-marker))
  (set (make-local-variable 'rcirc-prompt-end-marker) (point-max-marker))
Richard M. Stallman's avatar
Richard M. Stallman committed
1027 1028
  (rcirc-update-prompt)
  (goto-char rcirc-prompt-end-marker)
1029 1030

  (set (make-local-variable 'overlay-arrow-position) (make-marker))
Richard M. Stallman's avatar
Richard M. Stallman committed
1031

1032 1033
  ;; if the user changes the major mode or kills the buffer, there is
  ;; cleanup work to do
1034 1035
  (add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook nil t)
  (add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook nil t)
1036

1037 1038 1039 1040 1041 1042 1043 1044
  ;; add to buffer list, and update buffer abbrevs
  (when target				; skip server buffer
    (let ((buffer (current-buffer)))
      (with-rcirc-process-buffer process
	(setq rcirc-buffer-alist (cons (cons target buffer)
				       rcirc-buffer-alist))))
    (rcirc-update-short-buffer-names))

1045 1046 1047
  (add-hook 'completion-at-point-functions
            'rcirc-completion-at-point nil 'local)

1048
  (run-mode-hooks 'rcirc-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
1049

1050 1051
(defun rcirc-update-prompt (&optional all)
  "Reset the prompt string in the current buffer.
1052

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
If ALL is non-nil, update prompts in all IRC buffers."
  (if all
      (mapc (lambda (process)
	      (mapc (lambda (buffer)
		      (with-current-buffer buffer
			(rcirc-update-prompt)))
		    (with-rcirc-process-buffer process
		      (mapcar 'cdr rcirc-buffer-alist))))
	    (rcirc-process-list))
    (let ((inhibit-read-only t)
	  (prompt (or rcirc-prompt "")))
      (mapc (lambda (rep)
	      (setq prompt
1066 1067
		    (replace-regexp-in-string (car rep) (cdr rep) prompt)))
	    (list (cons "%n" (rcirc-buffer-nick))
1068
		  (cons "%s" (with-rcirc-server-buffer rcirc-server-name))
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
		  (cons "%t" (or rcirc-target ""))))
      (save-excursion
	(delete-region rcirc-prompt-start-marker rcirc-prompt-end-marker)
	(goto-char rcirc-prompt-start-marker)
	(let ((start (point)))
	  (insert-before-markers prompt)
	  (set-marker rcirc-prompt-start-marker start)
	  (when (not (zerop (- rcirc-prompt-end-marker
			       rcirc-prompt-start-marker)))
	    (add-text-properties rcirc-prompt-start-marker
				 rcirc-prompt-end-marker
				 (list 'face 'rcirc-prompt
				       'read-only t 'field t
				       'front-sticky t 'rear-nonsticky t))))))))

(defun rcirc-set-changed (option value)
  "Set OPTION to VALUE and do updates after a customization change."
  (set-default option value)
  (cond ((eq option 'rcirc-prompt)
	 (rcirc-update-prompt 'all))
	(t
	 (error "Bad option %s" option))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1091 1092 1093 1094 1095 1096 1097 1098

(defun rcirc-channel-p (target)
  "Return t if TARGET is a channel name."
  (and target
       (not (zerop (length target)))
       (or (eq (aref target 0) ?#)
           (eq (aref target 0) ?&))))

Glenn Morris's avatar
Glenn Morris committed
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
(defcustom rcirc-log-directory "~/.emacs.d/rcirc-log"
  "Directory to keep IRC logfiles."
  :type 'directory
  :group 'rcirc)

(defcustom rcirc-log-flag nil
  "Non-nil means log IRC activity to disk.
Logfiles are kept in `rcirc-log-directory'."
  :type 'boolean
  :group 'rcirc)

Richard M. Stallman's avatar
Richard M. Stallman committed
1110
(defun rcirc-kill-buffer-hook ()
1111 1112 1113 1114 1115
  "Part the channel when killing an rcirc buffer.

If `rcirc-kill-channel-buffers' is non-nil and the killed buffer
is a server buffer, kills all of the channel buffers associated
with it."
Richard M. Stallman's avatar
Richard M. Stallman committed
1116
  (when (eq major-mode 'rcirc-mode)
1117 1118 1119
    (when (and rcirc-log-flag
               rcirc-log-directory)
      (rcirc-log-write))
1120 1121 1122 1123 1124
    (rcirc-clean-up-buffer "Killed buffer")
    (when (and rcirc-buffer-alist ;; it's a server buffer
               rcirc-kill-channel-buffers)
      (dolist (channel rcirc-buffer-alist)
	(kill-buffer (cdr channel))))))
1125 1126 1127 1128 1129 1130

(defun rcirc-change-major-mode-hook ()
  "Part the channel when changing the major-mode."
  (rcirc-clean-up-buffer "Changed major mode"))

(defun rcirc-clean-up-buffer (reason)
1131 1132
  (let ((buffer (current-buffer)))
    (rcirc-clear-activity buffer)
1133
    (when (and (rcirc-buffer-process)
1134
	       (rcirc--connection-open-p (rcirc-buffer-process)))
1135 1136 1137
      (with-rcirc-server-buffer
       (setq rcirc-buffer-alist
	     (rassq-delete-all buffer rcirc-buffer-alist)))
1138
      (rcirc-update-short-buffer-names)
Richard M. Stallman's avatar
Richard M. Stallman committed
1139
      (if (rcirc-channel-p rcirc-target)
1140 1141
	  (rcirc-send-string (rcirc-buffer-process)
			     (concat "PART " rcirc-target " :" reason))
1142
	(when rcirc-target
1143 1144
	  (rcirc-remove-nick-channel (rcirc-buffer-process)
				     (rcirc-buffer-nick)
1145 1146
				     rcirc-target))))
    (setq rcirc-target nil)))
1147 1148 1149

(defun rcirc-generate-new-buffer-name (process target)
  "Return a buffer name based on PROCESS and TARGET.
1150
This is used for the initial name given to IRC buffers."
1151 1152 1153 1154
  (substring-no-properties
   (if target
       (concat target "@" (process-name process))
     (concat "*" (process-name process) "*"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1155

1156
(defun rcirc-get-buffer (process target &optional server)
Richard M. Stallman's avatar
Richard M. Stallman committed
1157
  "Return the buffer associated with the PROCESS and TARGET.
1158 1159 1160 1161 1162 1163 1164 1165

If optional argument SERVER is non-nil, return the server buffer
if there is no existing buffer for TARGET, otherwise return nil."
  (with-rcirc-process-buffer process
    (if (null target)
	(current-buffer)
      (let ((buffer (cdr (assoc-string target rcirc-buffer-alist t))))
	(or buffer (when server (current-buffer)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1166 1167

(defun rcirc-get-buffer-create (process target)
1168 1169 1170
  "Return the buffer associated with the PROCESS and TARGET.
Create the buffer if it doesn't exist."
  (let ((buffer (rcirc-get-buffer process target)))
1171
    (if (and buffer (buffer-live-p buffer))
1172
	(with-current-buffer buffer