code.delx.au - gnu-emacs/blob - lisp/erc/erc.el

   1 ;; erc.el --- An Emacs Internet Relay Chat client  -*- lexical-binding:t -*-
   2
   3 ;; Copyright (C) 1997-2016 Free Software Foundation, Inc.
   4
   5 ;; Author: Alexander L. Belikoff (alexander@belikoff.net)
   6 ;; Contributors: Sergey Berezin (sergey.berezin@cs.cmu.edu),
   7 ;;               Mario Lang (mlang@delysid.org),
   8 ;;               Alex Schroeder (alex@gnu.org)
   9 ;;               Andreas Fuchs (afs@void.at)
  10 ;;               Gergely Nagy (algernon@midgard.debian.net)
  11 ;;               David Edmondson (dme@dme.org)
  12 ;;               Kelvin White (kwhite@gnu.org)
  13 ;; Maintainer: emacs-devel@gnu.org
  14 ;; Keywords: IRC, chat, client, Internet
  15
  16 ;; Version: 5.3
  17
  18 ;; This file is part of GNU Emacs.
  19
  20 ;; GNU Emacs is free software: you can redistribute it and/or modify
  21 ;; it under the terms of the GNU General Public License as published by
  22 ;; the Free Software Foundation, either version 3 of the License, or
  23 ;; (at your option) any later version.
  24
  25 ;; GNU Emacs is distributed in the hope that it will be useful,
  26 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 ;; GNU General Public License for more details.
  29
  30 ;; You should have received a copy of the GNU General Public License
  31 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  32
  33 ;;; Commentary:
  34
  35 ;; ERC is a powerful, modular, and extensible IRC client for Emacs.
  36
  37 ;; For more information, see the following URLs:
  38 ;; * http://sv.gnu.org/projects/erc/
  39 ;; * http://www.emacswiki.org/cgi-bin/wiki/ERC
  40
  41
  42
  43 ;; As of 2006-06-13, ERC development is now hosted on Savannah
  44 ;; (http://sv.gnu.org/projects/erc).  I invite everyone who wants to
  45 ;; hack on it to contact me <mwolson@gnu.org> in order to get write
  46 ;; access to the shared Arch archive.
  47
  48 ;; Configuration:
  49
  50 ;; Use M-x customize-group RET erc RET to get an overview
  51 ;; of all the variables you can tweak.
  52
  53 ;; Usage:
  54
  55 ;; To connect to an IRC server, do
  56 ;;
  57 ;; M-x erc RET
  58 ;;
  59 ;; After you are connected to a server, you can use C-h m or have a look at
  60 ;; the ERC menu.
  61
  62 ;;; History:
  63 ;;
  64
  65 (defconst erc-version-string (format "\C-bERC\C-b (IRC client for Emacs %s)" emacs-version)
  66   "ERC version.  This is used by function `erc-version'.")
  67
  68 ;;; Code:
  69
  70 (eval-when-compile (require 'cl-lib))
  71 (require 'font-lock)
  72 (require 'pp)
  73 (require 'thingatpt)
  74 (require 'auth-source)
  75 (require 'erc-compat)
  76
  77 (defvar erc-official-location
  78   "http://emacswiki.org/cgi-bin/wiki/ERC (mailing list: erc-discuss@gnu.org)"
  79   "Location of the ERC client on the Internet.")
  80
  81 (defgroup erc nil
  82   "Emacs Internet Relay Chat client."
  83   :link '(url-link "http://www.emacswiki.org/cgi-bin/wiki/ERC")
  84   :link '(custom-manual "(erc) Top")
  85   :prefix "erc-"
  86   :group 'applications)
  87
  88 (defgroup erc-buffers nil
  89   "Creating new ERC buffers"
  90   :group 'erc)
  91
  92 (defgroup erc-display nil
  93   "Settings for how various things are displayed"
  94   :group 'erc)
  95
  96 (defgroup erc-mode-line-and-header nil
  97   "Displaying information in the mode-line and header"
  98   :group 'erc-display)
  99
 100 (defgroup erc-ignore nil
 101   "Ignoring certain messages"
 102   :group 'erc)
 103
 104 (defgroup erc-lurker nil
 105   "Hide specified message types sent by lurkers"
 106   :version "24.3"
 107   :group 'erc-ignore)
 108
 109 (defgroup erc-query nil
 110   "Using separate buffers for private discussions"
 111   :group 'erc)
 112
 113 (defgroup erc-quit-and-part nil
 114   "Quitting and parting channels"
 115   :group 'erc)
 116
 117 (defgroup erc-paranoia nil
 118   "Know what is sent and received; control the display of sensitive data."
 119   :group 'erc)
 120
 121 (defgroup erc-scripts nil
 122   "Running scripts at startup and with /LOAD"
 123   :group 'erc)
 124
 125 (require 'erc-backend)
 126
 127 ;; compatibility with older ERC releases
 128
 129 (define-obsolete-variable-alias 'erc-announced-server-name
 130   'erc-server-announced-name "ERC 5.1")
 131 (define-obsolete-variable-alias 'erc-process 'erc-server-process "ERC 5.1")
 132 (define-obsolete-variable-alias 'erc-default-coding-system
 133   'erc-server-coding-system "ERC 5.1")
 134
 135 (define-obsolete-function-alias 'erc-send-command
 136   'erc-server-send "ERC 5.1")
 137
 138 ;; tunable connection and authentication parameters
 139
 140 (defcustom erc-server nil
 141   "IRC server to use if one is not provided.
 142 See function `erc-compute-server' for more details on connection
 143 parameters and authentication."
 144   :group 'erc
 145   :type '(choice (const :tag "None" nil)
 146                  (string :tag "Server")))
 147
 148 (defcustom erc-port nil
 149   "IRC port to use if not specified.
 150
 151 This can be either a string or a number."
 152   :group 'erc
 153   :type '(choice (const :tag "None" nil)
 154                  (integer :tag "Port number")
 155                  (string :tag "Port string")))
 156
 157 (defcustom erc-nick nil
 158   "Nickname to use if one is not provided.
 159
 160 This can be either a string, or a list of strings.
 161 In the latter case, if the first nick in the list is already in use,
 162 other nicks are tried in the list order.
 163
 164 See function `erc-compute-nick' for more details on connection
 165 parameters and authentication."
 166   :group 'erc
 167   :type '(choice (const :tag "None" nil)
 168                  (string :tag "Nickname")
 169                  (repeat (string :tag "Nickname"))))
 170
 171 (defcustom erc-nick-uniquifier "`"
 172   "The string to append to the nick if it is already in use."
 173   :group 'erc
 174   :type 'string)
 175
 176 (defcustom erc-try-new-nick-p t
 177   "If the nickname you chose isn't available, and this option is non-nil,
 178 ERC should automatically attempt to connect with another nickname.
 179
 180 You can manually set another nickname with the /NICK command."
 181   :group 'erc
 182   :type 'boolean)
 183
 184 (defcustom erc-user-full-name nil
 185   "User full name.
 186
 187 This can be either a string or a function to call.
 188
 189 See function `erc-compute-full-name' for more details on connection
 190 parameters and authentication."
 191   :group 'erc
 192   :type '(choice (const :tag "No name" nil)
 193                  (string :tag "Name")
 194                  (function :tag "Get from function"))
 195   :set (lambda (sym val)
 196          (set sym (if (functionp val) (funcall val) val))))
 197
 198 (defcustom erc-rename-buffers nil
 199   "Non-nil means rename buffers with network name, if available."
 200   :version "24.5"
 201   :group 'erc
 202   :type 'boolean)
 203
 204 (defvar erc-password nil
 205   "Password to use when authenticating to an IRC server.
 206 It is not strictly necessary to provide this, since ERC will
 207 prompt you for it.")
 208
 209 (defcustom erc-user-mode nil
 210   "Initial user modes to be set after a connection is established."
 211   :group 'erc
 212   :type '(choice (const nil) string function))
 213
 214
 215 (defcustom erc-prompt-for-password t
 216   "Asks before using the default password, or whether to enter a new one."
 217   :group 'erc
 218   :type 'boolean)
 219
 220 (defcustom erc-warn-about-blank-lines t
 221   "Warn the user if they attempt to send a blank line."
 222   :group 'erc
 223   :type 'boolean)
 224
 225 (defcustom erc-send-whitespace-lines nil
 226   "If set to non-nil, send lines consisting of only whitespace."
 227   :group 'erc
 228   :type 'boolean)
 229
 230 (defcustom erc-hide-prompt nil
 231   "If non-nil, do not display the prompt for commands.
 232
 233 \(A command is any input starting with a `/').
 234
 235 See also the variables `erc-prompt' and `erc-command-indicator'."
 236   :group 'erc-display
 237   :type 'boolean)
 238
 239 ;; tunable GUI stuff
 240
 241 (defcustom erc-show-my-nick t
 242   "If non-nil, display one's own nickname when sending a message.
 243
 244 If non-nil, \"<nickname>\" will be shown.
 245 If nil, only \"> \" will be shown."
 246   :group 'erc-display
 247   :type 'boolean)
 248
 249 (define-widget 'erc-message-type 'set
 250   "A set of standard IRC Message types."
 251   :args '((const "JOIN")
 252           (const "KICK")
 253           (const "NICK")
 254           (const "PART")
 255           (const "QUIT")
 256           (const "MODE")
 257           (repeat :inline t :tag "Others" (string :tag "IRC Message Type"))))
 258
 259 (defcustom erc-hide-list nil
 260   "A global list of IRC message types to hide.
 261 A typical value would be \(\"JOIN\" \"PART\" \"QUIT\")."
 262   :group 'erc-ignore
 263   :type 'erc-message-type)
 264
 265 (defcustom erc-network-hide-list nil
 266   "A list of IRC networks to hide message types from.
 267 A typical value would be \((\"freenode\" \"MODE\")
 268   \(\"OFTC\" \"JOIN\" \"QUIT\"))."
 269   :version "25.1"
 270   :group 'erc-ignore
 271   :type 'erc-message-type)
 272
 273 (defcustom erc-channel-hide-list nil
 274   "A list of IRC channels to hide message types from.
 275 A typical value would be \((\"#emacs\" \"QUIT\" \"JOIN\")
 276   \(\"#erc\" \"NICK\")."
 277   :version "25.1"
 278   :group 'erc-ignore
 279   :type 'erc-message-type)
 280
 281 (defvar erc-session-password nil
 282   "The password used for the current session.")
 283 (make-variable-buffer-local 'erc-session-password)
 284
 285 (defcustom erc-disconnected-hook nil
 286   "Run this hook with arguments (NICK IP REASON) when disconnected.
 287 This happens before automatic reconnection.  Note, that
 288 `erc-server-QUIT-functions' might not be run when we disconnect,
 289 simply because we do not necessarily receive the QUIT event."
 290   :group 'erc-hooks
 291   :type 'hook)
 292
 293 (defcustom erc-complete-functions nil
 294   "These functions get called when the user hits TAB in ERC.
 295 Each function in turn is called until one returns non-nil to
 296 indicate it has handled the input."
 297   :group 'erc-hooks
 298   :type 'hook)
 299
 300 (defcustom erc-join-hook nil
 301   "Hook run when we join a channel.  Hook functions are called
 302 without arguments, with the current buffer set to the buffer of
 303 the new channel.
 304
 305 See also `erc-server-JOIN-functions', `erc-part-hook'."
 306   :group 'erc-hooks
 307   :type 'hook)
 308
 309 (defcustom erc-quit-hook nil
 310   "Hook run when processing a quit command directed at our nick.
 311
 312 The hook receives one argument, the current PROCESS.
 313 See also `erc-server-QUIT-functions' and `erc-disconnected-hook'."
 314   :group 'erc-hooks
 315   :type 'hook)
 316
 317 (defcustom erc-part-hook nil
 318   "Hook run when processing a PART message directed at our nick.
 319
 320 The hook receives one argument, the current BUFFER.
 321 See also `erc-server-QUIT-functions', `erc-quit-hook' and
 322 `erc-disconnected-hook'."
 323   :group 'erc-hooks
 324   :type 'hook)
 325
 326 (defcustom erc-kick-hook nil
 327   "Hook run when processing a KICK message directed at our nick.
 328
 329 The hook receives one argument, the current BUFFER.
 330 See also `erc-server-PART-functions' and `erc-part-hook'."
 331   :group 'erc-hooks
 332   :type 'hook)
 333
 334 (defcustom erc-nick-changed-functions nil
 335   "List of functions run when your nick was successfully changed.
 336
 337 Each function should accept two arguments, NEW-NICK and OLD-NICK."
 338   :group 'erc-hooks
 339   :type 'hook)
 340
 341 (defcustom erc-connect-pre-hook '(erc-initialize-log-marker)
 342   "Hook called just before `erc' calls `erc-connect'.
 343 Functions are passed a buffer as the first argument."
 344   :group 'erc-hooks
 345   :type 'hook)
 346
 347
 348 (defvar erc-channel-users nil
 349   "A hash table of members in the current channel, which
 350 associates nicknames with cons cells of the form:
 351 \(USER . MEMBER-DATA) where USER is a pointer to an
 352 erc-server-user struct, and MEMBER-DATA is a pointer to an
 353 erc-channel-user struct.")
 354 (make-variable-buffer-local 'erc-channel-users)
 355
 356 (defvar erc-server-users nil
 357   "A hash table of users on the current server, which associates
 358 nicknames with erc-server-user struct instances.")
 359 (make-variable-buffer-local 'erc-server-users)
 360
 361 (defun erc-downcase (string)
 362   "Convert STRING to IRC standard conforming downcase."
 363   (let ((s (downcase string))
 364         (c '((?\[ . ?\{)
 365              (?\] . ?\})
 366              (?\\ . ?\|)
 367              (?~  . ?^))))
 368     (save-match-data
 369       (while (string-match "[]\\[~]" s)
 370         (aset s (match-beginning 0)
 371               (cdr (assq (aref s (match-beginning 0)) c)))))
 372     s))
 373
 374 (defmacro erc-with-server-buffer (&rest body)
 375   "Execute BODY in the current ERC server buffer.
 376 If no server buffer exists, return nil."
 377   (declare (indent 0) (debug (body)))
 378   (let ((buffer (make-symbol "buffer")))
 379     `(let ((,buffer (erc-server-buffer)))
 380        (when (buffer-live-p ,buffer)
 381          (with-current-buffer ,buffer
 382            ,@body)))))
 383
 384 (cl-defstruct (erc-server-user (:type vector) :named)
 385   ;; User data
 386   nickname host login full-name info
 387   ;; Buffers
 388   ;;
 389   ;; This is an alist of the form (BUFFER . CHANNEL-DATA), where
 390   ;; CHANNEL-DATA is either nil or an erc-channel-user struct.
 391   (buffers nil)
 392   )
 393
 394 (cl-defstruct (erc-channel-user (:type vector) :named)
 395   voice halfop op admin owner
 396   ;; Last message time (in the form of the return value of
 397   ;; (current-time)
 398   ;;
 399   ;; This is useful for ordered name completion.
 400   (last-message-time nil))
 401
 402 (defsubst erc-get-channel-user (nick)
 403   "Find the (USER . CHANNEL-DATA) element corresponding to NICK
 404 in the current buffer's `erc-channel-users' hash table."
 405   (gethash (erc-downcase nick) erc-channel-users))
 406
 407 (defsubst erc-get-server-user (nick)
 408   "Find the USER corresponding to NICK in the current server's
 409 `erc-server-users' hash table."
 410   (erc-with-server-buffer
 411     (gethash (erc-downcase nick) erc-server-users)))
 412
 413 (defsubst erc-add-server-user (nick user)
 414   "This function is for internal use only.
 415
 416 Adds USER with nickname NICK to the `erc-server-users' hash table."
 417   (erc-with-server-buffer
 418     (puthash (erc-downcase nick) user erc-server-users)))
 419
 420 (defsubst erc-remove-server-user (nick)
 421   "This function is for internal use only.
 422
 423 Removes the user with nickname NICK from the `erc-server-users'
 424 hash table.  This user is not removed from the
 425 `erc-channel-users' lists of other buffers.
 426
 427 See also: `erc-remove-user'."
 428   (erc-with-server-buffer
 429     (remhash (erc-downcase nick) erc-server-users)))
 430
 431 (defun erc-change-user-nickname (user new-nick)
 432   "This function is for internal use only.
 433
 434 Changes the nickname of USER to NEW-NICK in the
 435 `erc-server-users' hash table.  The `erc-channel-users' lists of
 436 other buffers are also changed."
 437   (let ((nick (erc-server-user-nickname user)))
 438     (setf (erc-server-user-nickname user) new-nick)
 439     (erc-with-server-buffer
 440       (remhash (erc-downcase nick) erc-server-users)
 441       (puthash (erc-downcase new-nick) user erc-server-users))
 442     (dolist (buf (erc-server-user-buffers user))
 443       (if (buffer-live-p buf)
 444           (with-current-buffer buf
 445             (let ((cdata (erc-get-channel-user nick)))
 446               (remhash (erc-downcase nick) erc-channel-users)
 447               (puthash (erc-downcase new-nick) cdata
 448                        erc-channel-users)))))))
 449
 450 (defun erc-remove-channel-user (nick)
 451   "This function is for internal use only.
 452
 453 Removes the user with nickname NICK from the `erc-channel-users'
 454 list for this channel.  If this user is not in the
 455 `erc-channel-users' list of any other buffers, the user is also
 456 removed from the server's `erc-server-users' list.
 457
 458 See also: `erc-remove-server-user' and `erc-remove-user'."
 459   (let ((channel-data (erc-get-channel-user nick)))
 460     (when channel-data
 461       (let ((user (car channel-data)))
 462         (setf (erc-server-user-buffers user)
 463               (delq (current-buffer)
 464                     (erc-server-user-buffers user)))
 465         (remhash (erc-downcase nick) erc-channel-users)
 466         (if (null (erc-server-user-buffers user))
 467             (erc-remove-server-user nick))))))
 468
 469 (defun erc-remove-user (nick)
 470   "This function is for internal use only.
 471
 472 Removes the user with nickname NICK from the `erc-server-users'
 473 list as well as from all `erc-channel-users' lists.
 474
 475 See also: `erc-remove-server-user' and
 476 `erc-remove-channel-user'."
 477   (let ((user (erc-get-server-user nick)))
 478     (when user
 479       (let ((buffers (erc-server-user-buffers user)))
 480         (dolist (buf buffers)
 481           (if (buffer-live-p buf)
 482               (with-current-buffer buf
 483                 (remhash (erc-downcase nick) erc-channel-users)
 484                 (run-hooks 'erc-channel-members-changed-hook)))))
 485       (erc-remove-server-user nick))))
 486
 487 (defun erc-remove-channel-users ()
 488   "This function is for internal use only.
 489
 490 Removes all users in the current channel.  This is called by
 491 `erc-server-PART' and `erc-server-QUIT'."
 492   (when (and erc-server-connected
 493              (erc-server-process-alive)
 494              (hash-table-p erc-channel-users))
 495     (maphash (lambda (nick _cdata)
 496                (erc-remove-channel-user nick))
 497              erc-channel-users)
 498     (clrhash erc-channel-users)))
 499
 500 (defsubst erc-channel-user-owner-p (nick)
 501   "Return non-nil if NICK is an owner of the current channel."
 502   (and nick
 503        (hash-table-p erc-channel-users)
 504        (let ((cdata (erc-get-channel-user nick)))
 505          (and cdata (cdr cdata)
 506               (erc-channel-user-owner (cdr cdata))))))
 507
 508 (defsubst erc-channel-user-admin-p (nick)
 509   "Return non-nil if NICK is an admin in the current channel."
 510   (and nick
 511        (hash-table-p erc-channel-users)
 512        (let ((cdata (erc-get-channel-user nick)))
 513          (and cdata (cdr cdata)
 514               (erc-channel-user-admin (cdr cdata))))))
 515
 516 (defsubst erc-channel-user-op-p (nick)
 517   "Return non-nil if NICK is an operator in the current channel."
 518   (and nick
 519        (hash-table-p erc-channel-users)
 520        (let ((cdata (erc-get-channel-user nick)))
 521          (and cdata (cdr cdata)
 522               (erc-channel-user-op (cdr cdata))))))
 523
 524 (defsubst erc-channel-user-halfop-p (nick)
 525   "Return non-nil if NICK is a half-operator in the current channel."
 526   (and nick
 527        (hash-table-p erc-channel-users)
 528        (let ((cdata (erc-get-channel-user nick)))
 529          (and cdata (cdr cdata)
 530               (erc-channel-user-halfop (cdr cdata))))))
 531
 532 (defsubst erc-channel-user-voice-p (nick)
 533   "Return non-nil if NICK has voice in the current channel."
 534   (and nick
 535        (hash-table-p erc-channel-users)
 536        (let ((cdata (erc-get-channel-user nick)))
 537          (and cdata (cdr cdata)
 538               (erc-channel-user-voice (cdr cdata))))))
 539
 540 (defun erc-get-channel-user-list ()
 541   "Return a list of users in the current channel.  Each element
 542 of the list is of the form (USER . CHANNEL-DATA), where USER is
 543 an erc-server-user struct, and CHANNEL-DATA is either nil or an
 544 erc-channel-user struct.
 545
 546 See also: `erc-sort-channel-users-by-activity'"
 547   (let (users)
 548     (if (hash-table-p erc-channel-users)
 549         (maphash (lambda (_nick cdata)
 550                    (setq users (cons cdata users)))
 551                  erc-channel-users))
 552     users))
 553
 554 (defun erc-get-server-nickname-list ()
 555   "Return a list of known nicknames on the current server."
 556   (erc-with-server-buffer
 557     (let (nicks)
 558       (when (hash-table-p erc-server-users)
 559         (maphash (lambda (_n user)
 560                    (setq nicks
 561                          (cons (erc-server-user-nickname user)
 562                                nicks)))
 563                  erc-server-users)
 564         nicks))))
 565
 566 (defun erc-get-channel-nickname-list ()
 567   "Return a list of known nicknames on the current channel."
 568   (let (nicks)
 569     (when (hash-table-p erc-channel-users)
 570       (maphash (lambda (_n cdata)
 571                  (setq nicks
 572                        (cons (erc-server-user-nickname (car cdata))
 573                              nicks)))
 574                erc-channel-users)
 575       nicks)))
 576
 577 (defun erc-get-server-nickname-alist ()
 578   "Return an alist of known nicknames on the current server."
 579   (erc-with-server-buffer
 580     (let (nicks)
 581       (when (hash-table-p erc-server-users)
 582         (maphash (lambda (_n user)
 583                    (setq nicks
 584                          (cons (cons (erc-server-user-nickname user) nil)
 585                                nicks)))
 586                  erc-server-users)
 587         nicks))))
 588
 589 (defun erc-get-channel-nickname-alist ()
 590   "Return an alist of known nicknames on the current channel."
 591   (let (nicks)
 592     (when (hash-table-p erc-channel-users)
 593       (maphash (lambda (_n cdata)
 594                  (setq nicks
 595                        (cons (cons (erc-server-user-nickname (car cdata)) nil)
 596                              nicks)))
 597                erc-channel-users)
 598       nicks)))
 599
 600 (defun erc-sort-channel-users-by-activity (list)
 601   "Sort LIST such that users which have spoken most recently are listed first.
 602 LIST must be of the form (USER . CHANNEL-DATA).
 603
 604 See also: `erc-get-channel-user-list'."
 605   (sort list
 606         (lambda (x y)
 607           (when (and (cdr x) (cdr y))
 608             (let ((tx (erc-channel-user-last-message-time (cdr x)))
 609                   (ty (erc-channel-user-last-message-time (cdr y))))
 610               (and tx
 611                    (or (not ty)
 612                        (time-less-p ty tx))))))))
 613
 614 (defun erc-sort-channel-users-alphabetically (list)
 615   "Sort LIST so that users' nicknames are in alphabetical order.
 616 LIST must be of the form (USER . CHANNEL-DATA).
 617
 618 See also: `erc-get-channel-user-list'."
 619   (sort list
 620         (lambda (x y)
 621           (when (and (cdr x) (cdr y))
 622             (let ((nickx (downcase (erc-server-user-nickname (car x))))
 623                   (nicky (downcase (erc-server-user-nickname (car y)))))
 624               (and nickx
 625                    (or (not nicky)
 626                        (string-lessp nickx nicky))))))))
 627
 628 (defvar erc-channel-topic nil
 629   "A topic string for the channel.  Should only be used in channel-buffers.")
 630 (make-variable-buffer-local 'erc-channel-topic)
 631
 632 (defvar erc-channel-modes nil
 633   "List of strings representing channel modes.
 634 E.g. (\"i\" \"m\" \"s\" \"b Quake!*@*\")
 635 \(not sure the ban list will be here, but why not)")
 636 (make-variable-buffer-local 'erc-channel-modes)
 637
 638 (defvar erc-insert-marker nil
 639   "The place where insertion of new text in erc buffers should happen.")
 640 (make-variable-buffer-local 'erc-insert-marker)
 641
 642 (defvar erc-input-marker nil
 643   "The marker where input should be inserted.")
 644 (make-variable-buffer-local 'erc-input-marker)
 645
 646 (defun erc-string-no-properties (string)
 647   "Return a copy of STRING will all text-properties removed."
 648   (let ((newstring (copy-sequence string)))
 649     (set-text-properties 0 (length newstring) nil newstring)
 650     newstring))
 651
 652 (defcustom erc-prompt "ERC>"
 653   "Prompt used by ERC.  Trailing whitespace is not required."
 654   :group 'erc-display
 655   :type '(choice string function))
 656
 657 (defun erc-prompt ()
 658   "Return the input prompt as a string.
 659
 660 See also the variable `erc-prompt'."
 661   (let ((prompt (if (functionp erc-prompt)
 662                     (funcall erc-prompt)
 663                   erc-prompt)))
 664     (if (> (length prompt) 0)
 665         (concat prompt " ")
 666       prompt)))
 667
 668 (defcustom erc-command-indicator nil
 669   "Indicator used by ERC for showing commands.
 670
 671 If non-nil, this will be used in the ERC buffer to indicate
 672 commands (i.e., input starting with a `/').
 673
 674 If nil, the prompt will be constructed from the variable `erc-prompt'."
 675   :group 'erc-display
 676   :type '(choice (const nil) string function))
 677
 678 (defun erc-command-indicator ()
 679   "Return the command indicator prompt as a string.
 680
 681 This only has any meaning if the variable `erc-command-indicator' is non-nil."
 682   (and erc-command-indicator
 683        (let ((prompt (if (functionp erc-command-indicator)
 684                          (funcall erc-command-indicator)
 685                        erc-command-indicator)))
 686          (if (> (length prompt) 0)
 687              (concat prompt " ")
 688            prompt))))
 689
 690 (defcustom erc-notice-prefix "*** "
 691   "Prefix for all notices."
 692   :group 'erc-display
 693   :type 'string)
 694
 695 (defcustom erc-notice-highlight-type 'all
 696   "Determines how to highlight notices.
 697 See `erc-notice-prefix'.
 698
 699 The following values are allowed:
 700
 701     `prefix' - highlight notice prefix only
 702     `all'    - highlight the entire notice
 703
 704 Any other value disables notice's highlighting altogether."
 705   :group 'erc-display
 706   :type '(choice (const :tag "highlight notice prefix only" prefix)
 707                  (const :tag "highlight the entire notice" all)
 708                  (const :tag "don't highlight notices at all" nil)))
 709
 710 (defcustom erc-echo-notice-hook nil
 711   "List of functions to call to echo a private notice.
 712 Each function is called with four arguments, the string
 713 to display, the parsed server message, the target buffer (or
 714 nil), and the sender.  The functions are called in order, until a
 715 function evaluates to non-nil.  These hooks are called after
 716 those specified in `erc-echo-notice-always-hook'.
 717
 718 See also: `erc-echo-notice-always-hook',
 719 `erc-echo-notice-in-default-buffer',
 720 `erc-echo-notice-in-target-buffer',
 721 `erc-echo-notice-in-minibuffer',
 722 `erc-echo-notice-in-server-buffer',
 723 `erc-echo-notice-in-active-non-server-buffer',
 724 `erc-echo-notice-in-active-buffer',
 725 `erc-echo-notice-in-user-buffers',
 726 `erc-echo-notice-in-user-and-target-buffers',
 727 `erc-echo-notice-in-first-user-buffer'"
 728   :group 'erc-hooks
 729   :type 'hook
 730   :options '(erc-echo-notice-in-default-buffer
 731              erc-echo-notice-in-target-buffer
 732              erc-echo-notice-in-minibuffer
 733              erc-echo-notice-in-server-buffer
 734              erc-echo-notice-in-active-non-server-buffer
 735              erc-echo-notice-in-active-buffer
 736              erc-echo-notice-in-user-buffers
 737              erc-echo-notice-in-user-and-target-buffers
 738              erc-echo-notice-in-first-user-buffer))
 739
 740 (defcustom erc-echo-notice-always-hook
 741   '(erc-echo-notice-in-default-buffer)
 742   "List of functions to call to echo a private notice.
 743 Each function is called with four arguments, the string
 744 to display, the parsed server message, the target buffer (or
 745 nil), and the sender.  The functions are called in order, and all
 746 functions are called.  These hooks are called before those
 747 specified in `erc-echo-notice-hook'.
 748
 749 See also: `erc-echo-notice-hook',
 750 `erc-echo-notice-in-default-buffer',
 751 `erc-echo-notice-in-target-buffer',
 752 `erc-echo-notice-in-minibuffer',
 753 `erc-echo-notice-in-server-buffer',
 754 `erc-echo-notice-in-active-non-server-buffer',
 755 `erc-echo-notice-in-active-buffer',
 756 `erc-echo-notice-in-user-buffers',
 757 `erc-echo-notice-in-user-and-target-buffers',
 758 `erc-echo-notice-in-first-user-buffer'"
 759   :group 'erc-hooks
 760   :type 'hook
 761   :options '(erc-echo-notice-in-default-buffer
 762              erc-echo-notice-in-target-buffer
 763              erc-echo-notice-in-minibuffer
 764              erc-echo-notice-in-server-buffer
 765              erc-echo-notice-in-active-non-server-buffer
 766              erc-echo-notice-in-active-buffer
 767              erc-echo-notice-in-user-buffers
 768              erc-echo-notice-in-user-and-target-buffers
 769              erc-echo-notice-in-first-user-buffer))
 770
 771 ;; other tunable parameters
 772
 773 (defcustom erc-whowas-on-nosuchnick nil
 774   "If non-nil, do a whowas on a nick if no such nick."
 775   :group 'erc
 776   :type 'boolean)
 777
 778 (defcustom erc-verbose-server-ping nil
 779   "If non-nil, show every time you get a PING or PONG from the server."
 780   :group 'erc-paranoia
 781   :type 'boolean)
 782
 783 (defcustom erc-public-away-p nil
 784   "Let others know you are back when you are no longer marked away.
 785 This happens in this form:
 786 * <nick> is back (gone for <time>)
 787
 788 Many consider it impolite to do so automatically."
 789   :group 'erc
 790   :type 'boolean)
 791
 792 (defcustom erc-away-nickname nil
 793   "The nickname to take when you are marked as being away."
 794   :group 'erc
 795   :type '(choice (const nil)
 796                  string))
 797
 798 (defcustom erc-paranoid nil
 799   "If non-nil, then all incoming CTCP requests will be shown."
 800   :group 'erc-paranoia
 801   :type 'boolean)
 802
 803 (defcustom erc-disable-ctcp-replies nil
 804   "Disable replies to CTCP requests that require a reply.
 805 If non-nil, then all incoming CTCP requests that normally require
 806 an automatic reply (like VERSION or PING) will be ignored.  Good to
 807 set if some hacker is trying to flood you away."
 808   :group 'erc-paranoia
 809   :type 'boolean)
 810
 811 (defcustom erc-anonymous-login t
 812   "Be paranoid, don't give away your machine name."
 813   :group 'erc-paranoia
 814   :type 'boolean)
 815
 816 (defcustom erc-prompt-for-channel-key nil
 817   "Prompt for channel key when using `erc-join-channel' interactively."
 818   :group 'erc
 819   :type 'boolean)
 820
 821 (defcustom erc-email-userid "user"
 822   "Use this as your email user ID."
 823   :group 'erc
 824   :type 'string)
 825
 826 (defcustom erc-system-name nil
 827   "Use this as the name of your system.
 828 If nil, ERC will call `system-name' to get this information."
 829   :group 'erc
 830   :type '(choice (const :tag "Default system name" nil)
 831                  string))
 832
 833 (defcustom erc-ignore-list nil
 834   "List of regexps matching user identifiers to ignore.
 835
 836 A user identifier has the form \"nick!login@host\".  If an
 837 identifier matches, the message from the person will not be
 838 processed."
 839   :group 'erc-ignore
 840   :type '(repeat regexp))
 841 (make-variable-buffer-local 'erc-ignore-list)
 842
 843 (defcustom erc-ignore-reply-list nil
 844   "List of regexps matching user identifiers to ignore completely.
 845
 846 This differs from `erc-ignore-list' in that it also ignores any
 847 messages directed at the user.
 848
 849 A user identifier has the form \"nick!login@host\".
 850
 851 If an identifier matches, or a message is addressed to a nick
 852 whose identifier matches, the message will not be processed.
 853
 854 CAVEAT: ERC doesn't know about the user and host of anyone who
 855 was already in the channel when you joined, but never said
 856 anything, so it won't be able to match the user and host of those
 857 people.  You can update the ERC internal info using /WHO *."
 858   :group 'erc-ignore
 859   :type '(repeat regexp))
 860
 861 (defvar erc-flood-protect t
 862   "If non-nil, flood protection is enabled.
 863 Flooding is sending too much information to the server in too
 864 short of an interval, which may cause the server to terminate the
 865 connection.
 866
 867 See `erc-server-flood-margin' for other flood-related parameters.")
 868
 869 ;; Script parameters
 870
 871 (defcustom erc-startup-file-list
 872   (list (concat erc-user-emacs-directory ".ercrc.el")
 873         (concat erc-user-emacs-directory ".ercrc")
 874         "~/.ercrc.el" "~/.ercrc" ".ercrc.el" ".ercrc")
 875   "List of files to try for a startup script.
 876 The first existent and readable one will get executed.
 877
 878 If the filename ends with `.el' it is presumed to be an Emacs Lisp
 879 script and it gets (load)ed.  Otherwise it is treated as a bunch of
 880 regular IRC commands."
 881   :group 'erc-scripts
 882   :type '(repeat file))
 883
 884 (defcustom erc-script-path nil
 885   "List of directories to look for a script in /load command.
 886 The script is first searched in the current directory, then in each
 887 directory in the list."
 888   :group 'erc-scripts
 889   :type '(repeat directory))
 890
 891 (defcustom erc-script-echo t
 892   "If non-nil, echo the IRC script commands locally."
 893   :group 'erc-scripts
 894   :type 'boolean)
 895
 896 (defvar erc-last-saved-position nil
 897   "A marker containing the position the current buffer was last saved at.")
 898 (make-variable-buffer-local 'erc-last-saved-position)
 899
 900 (defcustom erc-kill-buffer-on-part nil
 901   "Kill the channel buffer on PART.
 902 This variable should probably stay nil, as ERC can reuse buffers if
 903 you rejoin them later."
 904   :group 'erc-quit-and-part
 905   :type 'boolean)
 906
 907 (defcustom erc-kill-queries-on-quit nil
 908   "Kill all query (also channel) buffers of this server on QUIT.
 909 See the variable `erc-kill-buffer-on-part' for details."
 910   :group 'erc-quit-and-part
 911   :type 'boolean)
 912
 913 (defcustom erc-kill-server-buffer-on-quit nil
 914   "Kill the server buffer of the process on QUIT."
 915   :group 'erc-quit-and-part
 916   :type 'boolean)
 917
 918 (defcustom erc-quit-reason-various-alist nil
 919   "Alist of possible arguments to the /quit command.
 920
 921 Each element has the form:
 922   (REGEXP RESULT)
 923
 924 If REGEXP matches the argument to /quit, then its relevant RESULT
 925 will be used.  RESULT may be either a string, or a function.  If
 926 a function, it should return the quit message as a string.
 927
 928 If no elements match, then the empty string is used.
 929
 930 As an example:
 931   (setq erc-quit-reason-various-alist
 932       \\='((\"xmms\" dme:now-playing)
 933         (\"version\" erc-quit-reason-normal)
 934         (\"home\" \"Gone home !\")
 935         (\"^$\" \"Default Reason\")))
 936 If the user types \"/quit home\", then \"Gone home !\" will be used
 937 as the quit message."
 938   :group 'erc-quit-and-part
 939   :type '(repeat (list regexp (choice (string) (function)))))
 940
 941 (defcustom erc-part-reason-various-alist nil
 942   "Alist of possible arguments to the /part command.
 943
 944 Each element has the form:
 945   (REGEXP RESULT)
 946
 947 If REGEXP matches the argument to /part, then its relevant RESULT
 948 will be used.  RESULT may be either a string, or a function.  If
 949 a function, it should return the part message as a string.
 950
 951 If no elements match, then the empty string is used.
 952
 953 As an example:
 954   (setq erc-part-reason-various-alist
 955       \\='((\"xmms\" dme:now-playing)
 956         (\"version\" erc-part-reason-normal)
 957         (\"home\" \"Gone home !\")
 958         (\"^$\" \"Default Reason\")))
 959 If the user types \"/part home\", then \"Gone home !\" will be used
 960 as the part message."
 961   :group 'erc-quit-and-part
 962   :type '(repeat (list regexp (choice (string) (function)))))
 963
 964 (defcustom erc-quit-reason 'erc-quit-reason-normal
 965   "A function which returns the reason for quitting.
 966
 967 The function is passed a single argument, the string typed by the
 968 user after \"/quit\"."
 969   :group 'erc-quit-and-part
 970   :type '(choice (const erc-quit-reason-normal)
 971                  (const erc-quit-reason-various)
 972                  (symbol)))
 973
 974 (defcustom erc-part-reason 'erc-part-reason-normal
 975   "A function which returns the reason for parting a channel.
 976
 977 The function is passed a single argument, the string typed by the
 978 user after \"/PART\"."
 979   :group 'erc-quit-and-part
 980   :type '(choice (const erc-part-reason-normal)
 981                  (const erc-part-reason-various)
 982                  (symbol)))
 983
 984 (defvar erc-grab-buffer-name "*erc-grab*"
 985   "The name of the buffer created by `erc-grab-region'.")
 986
 987 ;; variables available for IRC scripts
 988
 989 (defvar erc-user-information "ERC User"
 990   "USER_INFORMATION IRC variable.")
 991
 992 ;; Hooks
 993
 994 (defgroup erc-hooks nil
 995   "Hook variables for fancy customizations of ERC."
 996   :group 'erc)
 997
 998 (defcustom erc-mode-hook nil
 999   "Hook run after `erc-mode' setup is finished."
1000   :group 'erc-hooks
1001   :type 'hook
1002   :options '(erc-add-scroll-to-bottom))
1003
1004 (defcustom erc-timer-hook nil
1005   "Put functions which should get called more or less periodically here.
1006 The idea is that servers always play ping pong with the client, and so there
1007 is no need for any idle-timer games with Emacs."
1008   :group 'erc-hooks
1009   :type 'hook)
1010
1011 (defcustom erc-insert-pre-hook nil
1012   "Hook called first when some text is inserted through `erc-display-line'.
1013 It gets called with one argument, STRING.
1014 To be able to modify the inserted text, use `erc-insert-modify-hook' instead.
1015 Filtering functions can set `erc-insert-this' to nil to avoid
1016 display of that particular string at all."
1017   :group 'erc-hooks
1018   :type 'hook)
1019
1020 (defcustom erc-send-pre-hook nil
1021   "Hook called first when some text is sent through `erc-send-current-line'.
1022 It gets called with one argument, STRING.
1023
1024 To change the text that will be sent, set the variable `str' which is
1025 used in `erc-send-current-line'.
1026
1027 To change the text inserted into the buffer without changing the text
1028 that will be sent, use `erc-send-modify-hook' instead.
1029
1030 Filtering functions can set `erc-send-this' to nil to avoid sending of
1031 that particular string at all and `erc-insert-this' to prevent
1032 inserting that particular string into the buffer.
1033
1034 Note that it's useless to set `erc-send-this' to nil and
1035 `erc-insert-this' to t.  ERC is sane enough to not insert the text
1036 anyway."
1037   :group 'erc-hooks
1038   :type 'hook)
1039
1040 (defvar erc-insert-this t
1041   "Insert the text into the target buffer or not.
1042 Functions on `erc-insert-pre-hook' can set this variable to nil
1043 if they wish to avoid insertion of a particular string.")
1044
1045 (defvar erc-send-this t
1046   "Send the text to the target or not.
1047 Functions on `erc-send-pre-hook' can set this variable to nil
1048 if they wish to avoid sending of a particular string.")
1049
1050 (defcustom erc-insert-modify-hook ()
1051   "Insertion hook for functions that will change the text's appearance.
1052 This hook is called just after `erc-insert-pre-hook' when the value
1053 of `erc-insert-this' is t.
1054 While this hook is run, narrowing is in effect and `current-buffer' is
1055 the buffer where the text got inserted.  One possible value to add here
1056 is `erc-fill'."
1057   :group 'erc-hooks
1058   :type 'hook)
1059
1060 (defcustom erc-insert-post-hook nil
1061   "This hook is called just after `erc-insert-modify-hook'.
1062 At this point, all modifications from prior hook functions are done."
1063   :group 'erc-hooks
1064   :type 'hook
1065   :options '(erc-truncate-buffer
1066              erc-make-read-only
1067              erc-save-buffer-in-logs))
1068
1069 (defcustom erc-send-modify-hook nil
1070   "Sending hook for functions that will change the text's appearance.
1071 This hook is called just after `erc-send-pre-hook' when the values
1072 of `erc-send-this' and `erc-insert-this' are both t.
1073 While this hook is run, narrowing is in effect and `current-buffer' is
1074 the buffer where the text got inserted.
1075
1076 Note that no function in this hook can change the appearance of the
1077 text that is sent.  Only changing the sent text's appearance on the
1078 sending user's screen is possible.  One possible value to add here
1079 is `erc-fill'."
1080   :group 'erc-hooks
1081   :type 'hook)
1082
1083 (defcustom erc-send-post-hook nil
1084   "This hook is called just after `erc-send-modify-hook'.
1085 At this point, all modifications from prior hook functions are done.
1086 NOTE: The functions on this hook are called _before_ sending a command
1087 to the server.
1088
1089 This function is called with narrowing, ala `erc-send-modify-hook'."
1090   :group 'erc-hooks
1091   :type 'hook
1092   :options '(erc-make-read-only))
1093
1094 (defcustom erc-send-completed-hook
1095   (when (fboundp 'emacspeak-auditory-icon)
1096     (list (byte-compile
1097            (lambda (_str)
1098              (emacspeak-auditory-icon 'select-object)))))
1099   "Hook called after a message has been parsed by ERC.
1100
1101 The single argument to the functions is the unmodified string
1102 which the local user typed."
1103   :group 'erc-hooks
1104   :type 'hook)
1105 ;; mode-specific tables
1106
1107 (defvar erc-mode-syntax-table
1108   (let ((syntax-table (make-syntax-table)))
1109     (modify-syntax-entry ?\" ".   " syntax-table)
1110     (modify-syntax-entry ?\\ ".   " syntax-table)
1111     (modify-syntax-entry ?' "w   " syntax-table)
1112     ;; Make dabbrev-expand useful for nick names
1113     (modify-syntax-entry ?< "." syntax-table)
1114     (modify-syntax-entry ?> "." syntax-table)
1115     syntax-table)
1116   "Syntax table used while in ERC mode.")
1117
1118 (defvar erc-mode-abbrev-table nil
1119   "Abbrev table used while in ERC mode.")
1120 (define-abbrev-table 'erc-mode-abbrev-table ())
1121
1122 (defvar erc-mode-map
1123   (let ((map (make-sparse-keymap)))
1124     (define-key map "\C-m" 'erc-send-current-line)
1125     (define-key map "\C-a" 'erc-bol)
1126     (define-key map [home] 'erc-bol)
1127     (define-key map "\C-c\C-a" 'erc-bol)
1128     (define-key map "\C-c\C-b" 'erc-switch-to-buffer)
1129     (define-key map "\C-c\C-c" 'erc-toggle-interpret-controls)
1130     (define-key map "\C-c\C-d" 'erc-input-action)
1131     (define-key map "\C-c\C-e" 'erc-toggle-ctcp-autoresponse)
1132     (define-key map "\C-c\C-f" 'erc-toggle-flood-control)
1133     (define-key map "\C-c\C-i" 'erc-invite-only-mode)
1134     (define-key map "\C-c\C-j" 'erc-join-channel)
1135     (define-key map "\C-c\C-n" 'erc-channel-names)
1136     (define-key map "\C-c\C-o" 'erc-get-channel-mode-from-keypress)
1137     (define-key map "\C-c\C-p" 'erc-part-from-channel)
1138     (define-key map "\C-c\C-q" 'erc-quit-server)
1139     (define-key map "\C-c\C-r" 'erc-remove-text-properties-region)
1140     (define-key map "\C-c\C-t" 'erc-set-topic)
1141     (define-key map "\C-c\C-u" 'erc-kill-input)
1142     (define-key map "\C-c\C-x" 'erc-quit-server)
1143     (define-key map "\M-\t" 'ispell-complete-word)
1144     (define-key map "\t" 'erc-completion-at-point)
1145
1146     ;; Suppress `font-lock-fontify-block' key binding since it
1147     ;; destroys face properties.
1148     (define-key map [remap font-lock-fontify-block] 'undefined)
1149
1150     map)
1151   "ERC keymap.")
1152
1153 ;; Faces
1154
1155 ; Honestly, I have a horrible sense of color and the "defaults" below
1156 ; are supposed to be really bad. But colors ARE required in IRC to
1157 ; convey different parts of conversation. If you think you know better
1158 ; defaults - send them to me.
1159
1160 ;; Now colors are a bit nicer, at least to my eyes.
1161 ;; You may still want to change them to better fit your background.-- S.B.
1162
1163 (defgroup erc-faces nil
1164   "Faces for ERC."
1165   :group 'erc)
1166
1167 ;; FIXME faces should not end in "-face".
1168 (defface erc-default-face '((t))
1169   "ERC default face."
1170   :group 'erc-faces)
1171
1172 (defface erc-nick-prefix-face '((t :inherit erc-nick-default-face :weight bold))
1173   "ERC face used for user mode prefix."
1174   :group 'erc-faces)
1175
1176 (defface erc-my-nick-prefix-face '((t :inherit erc-nick-default-face :weight bold))
1177   "ERC face used for my user mode prefix."
1178   :group 'erc-faces)
1179
1180 (defface erc-direct-msg-face '((t :foreground "IndianRed"))
1181   "ERC face used for messages you receive in the main erc buffer."
1182   :group 'erc-faces)
1183
1184 (defface erc-header-line
1185   '((t :foreground "grey20" :background "grey90"))
1186   "ERC face used for the header line.
1187
1188 This will only be used if `erc-header-line-face-method' is non-nil."
1189   :group 'erc-faces)
1190
1191 (defface erc-input-face '((t :foreground "brown"))
1192   "ERC face used for your input."
1193   :group 'erc-faces)
1194
1195 (defface erc-prompt-face
1196   '((t :weight bold :foreground "Black" :background "lightBlue2"))
1197   "ERC face for the prompt."
1198   :group 'erc-faces)
1199
1200 (defface erc-command-indicator-face
1201   '((t :weight bold))
1202   "ERC face for the command indicator.
1203 See the variable `erc-command-indicator'."
1204   :group 'erc-faces)
1205
1206 (defface erc-notice-face
1207   '((default :weight bold)
1208     (((class color) (min-colors 88)) :foreground "SlateBlue")
1209     (t :foreground "blue"))
1210   "ERC face for notices."
1211   :group 'erc-faces)
1212
1213 (defface erc-action-face '((t :weight bold))
1214   "ERC face for actions generated by /ME."
1215   :group 'erc-faces)
1216
1217 (defface erc-error-face '((t :foreground "red"))
1218   "ERC face for errors."
1219   :group 'erc-faces)
1220
1221 ;; same default color as `erc-input-face'
1222 (defface erc-my-nick-face '((t :weight bold :foreground "brown"))
1223   "ERC face for your current nickname in messages sent by you.
1224 See also `erc-show-my-nick'."
1225   :group 'erc-faces)
1226
1227 (defface erc-nick-default-face '((t :weight bold))
1228   "ERC nickname default face."
1229   :group 'erc-faces)
1230
1231 (defface erc-nick-msg-face '((t :weight bold :foreground "IndianRed"))
1232   "ERC nickname face for private messages."
1233   :group 'erc-faces)
1234
1235 ;; Debugging support
1236
1237 (defvar erc-log-p nil
1238   "When set to t, generate debug messages in a separate debug buffer.")
1239
1240 (defvar erc-debug-log-file (expand-file-name "ERC.debug")
1241   "Debug log file name.")
1242
1243 (defvar erc-dbuf nil)
1244 (make-variable-buffer-local 'erc-dbuf)
1245
1246 (defmacro define-erc-module (name alias doc enable-body disable-body
1247                                   &optional local-p)
1248   "Define a new minor mode using ERC conventions.
1249 Symbol NAME is the name of the module.
1250 Symbol ALIAS is the alias to use, or nil.
1251 DOC is the documentation string to use for the minor mode.
1252 ENABLE-BODY is a list of expressions used to enable the mode.
1253 DISABLE-BODY is a list of expressions used to disable the mode.
1254 If LOCAL-P is non-nil, the mode will be created as a buffer-local
1255 mode, rather than a global one.
1256
1257 This will define a minor mode called erc-NAME-mode, possibly
1258 an alias erc-ALIAS-mode, as well as the helper functions
1259 erc-NAME-enable, and erc-NAME-disable.
1260
1261 Example:
1262
1263   ;;;###autoload (autoload \\='erc-replace-mode \"erc-replace\")
1264   (define-erc-module replace nil
1265     \"This mode replaces incoming text according to `erc-replace-alist'.\"
1266     ((add-hook \\='erc-insert-modify-hook
1267                \\='erc-replace-insert))
1268     ((remove-hook \\='erc-insert-modify-hook
1269                   \\='erc-replace-insert)))"
1270   (declare (doc-string 3))
1271   (let* ((sn (symbol-name name))
1272          (mode (intern (format "erc-%s-mode" (downcase sn))))
1273          (group (intern (format "erc-%s" (downcase sn))))
1274          (enable (intern (format "erc-%s-enable" (downcase sn))))
1275          (disable (intern (format "erc-%s-disable" (downcase sn)))))
1276     `(progn
1277        (erc-define-minor-mode
1278         ,mode
1279         ,(format "Toggle ERC %S mode.
1280 With a prefix argument ARG, enable %s if ARG is positive,
1281 and disable it otherwise.  If called from Lisp, enable the mode
1282 if ARG is omitted or nil.
1283 %s" name name doc)
1284         nil nil nil
1285         :global ,(not local-p) :group (quote ,group)
1286         (if ,mode
1287             (,enable)
1288           (,disable)))
1289        (defun ,enable ()
1290          ,(format "Enable ERC %S mode."
1291                   name)
1292          (interactive)
1293          (add-to-list 'erc-modules (quote ,name))
1294          (setq ,mode t)
1295          ,@enable-body)
1296        (defun ,disable ()
1297          ,(format "Disable ERC %S mode."
1298                   name)
1299          (interactive)
1300          (setq erc-modules (delq (quote ,name) erc-modules))
1301          (setq ,mode nil)
1302          ,@disable-body)
1303        ,(when (and alias (not (eq name alias)))
1304           `(defalias
1305              (quote
1306               ,(intern
1307                 (format "erc-%s-mode"
1308                         (downcase (symbol-name alias)))))
1309              (quote
1310               ,mode)))
1311        ;; For find-function and find-variable.
1312        (put ',mode    'definition-name ',name)
1313        (put ',enable  'definition-name ',name)
1314        (put ',disable 'definition-name ',name))))
1315
1316 (defun erc-once-with-server-event (event f)
1317   "Run function F the next time EVENT occurs in the `current-buffer'.
1318
1319 You should make sure that `current-buffer' is a server buffer.
1320
1321 This function temporarily adds a function to EVENT's hook to call F with
1322 two arguments (`proc' and `parsed').  After F is called, the function is
1323 removed from EVENT's hook.  F should return either nil
1324 or t, where nil indicates that the other functions on EVENT's hook
1325 should be run too, and t indicates that other functions should
1326 not be run.
1327
1328 Please be sure to use this function in server-buffers.  In
1329 channel-buffers it may not work at all, as it uses the LOCAL
1330 argument of `add-hook' and `remove-hook' to ensure multiserver
1331 capabilities."
1332   (unless (erc-server-buffer-p)
1333     (error
1334      "You should only run `erc-once-with-server-event' in a server buffer"))
1335   (let ((fun (make-symbol "fun"))
1336         (hook (erc-get-hook event)))
1337     (put fun 'erc-original-buffer (current-buffer))
1338     (fset fun (lambda (proc parsed)
1339                 (with-current-buffer (get fun 'erc-original-buffer)
1340                   (remove-hook hook fun t))
1341                 (fmakunbound fun)
1342                 (funcall f proc parsed)))
1343     (add-hook hook fun nil t)
1344     fun))
1345
1346 (defsubst erc-log (string)
1347   "Logs STRING if logging is on (see `erc-log-p')."
1348   (when erc-log-p
1349     (erc-log-aux string)))
1350
1351 (defun erc-server-buffer ()
1352   "Return the server buffer for the current buffer's process.
1353 The buffer-local variable `erc-server-process' is used to find
1354 the process buffer."
1355   (and (erc-server-buffer-live-p)
1356        (process-buffer erc-server-process)))
1357
1358 (defun erc-server-buffer-live-p ()
1359   "Return t if the server buffer has not been killed."
1360   (and (processp erc-server-process)
1361        (buffer-live-p (process-buffer erc-server-process))))
1362
1363 (defun erc-server-buffer-p (&optional buffer)
1364   "Return non-nil if argument BUFFER is an ERC server buffer.
1365
1366 If BUFFER is nil, the current buffer is used."
1367   (with-current-buffer (or buffer (current-buffer))
1368     (and (eq major-mode 'erc-mode)
1369          (null (erc-default-target)))))
1370
1371 (defun erc-open-server-buffer-p (&optional buffer)
1372   "Return non-nil if argument BUFFER is an ERC server buffer that
1373 has an open IRC process.
1374
1375 If BUFFER is nil, the current buffer is used."
1376   (and (erc-server-buffer-p buffer)
1377        (erc-server-process-alive buffer)))
1378
1379 (defun erc-query-buffer-p (&optional buffer)
1380   "Return non-nil if BUFFER is an ERC query buffer.
1381 If BUFFER is nil, the current buffer is used."
1382   (with-current-buffer (or buffer (current-buffer))
1383     (let ((target (erc-default-target)))
1384       (and (eq major-mode 'erc-mode)
1385            target
1386            (not (memq (aref target 0) '(?# ?& ?+ ?!)))))))
1387
1388 (defun erc-ison-p (nick)
1389   "Return non-nil if NICK is online."
1390   (interactive "sNick: ")
1391   (erc-with-server-buffer
1392     (let ((erc-online-p 'unknown))
1393       (erc-once-with-server-event
1394        303
1395        (lambda (_proc parsed)
1396          (let ((ison (split-string (aref parsed 3))))
1397            (setq erc-online-p (car (erc-member-ignore-case nick ison)))
1398            t)))
1399       (erc-server-send (format "ISON %s" nick))
1400       (while (eq erc-online-p 'unknown) (accept-process-output))
1401       (if (called-interactively-p 'interactive)
1402           (message "%s is %sonline"
1403                    (or erc-online-p nick)
1404                    (if erc-online-p "" "not "))
1405         erc-online-p))))
1406
1407 (defun erc-log-aux (string)
1408   "Do the debug logging of STRING."
1409   (let ((cb (current-buffer))
1410         (point 1)
1411         (was-eob nil)
1412         (session-buffer (erc-server-buffer)))
1413     (if session-buffer
1414         (progn
1415           (set-buffer session-buffer)
1416           (if (not (and erc-dbuf (bufferp erc-dbuf) (buffer-live-p erc-dbuf)))
1417               (progn
1418                 (setq erc-dbuf (get-buffer-create
1419                                 (concat "*ERC-DEBUG: "
1420                                         erc-session-server "*")))))
1421           (set-buffer erc-dbuf)
1422           (setq point (point))
1423           (setq was-eob (eobp))
1424           (goto-char (point-max))
1425           (insert (concat "** " string "\n"))
1426           (if was-eob (goto-char (point-max))
1427             (goto-char point))
1428           (set-buffer cb))
1429       (message "ERC: ** %s" string))))
1430
1431 ;; Last active buffer, to print server messages in the right place
1432
1433 (defvar erc-active-buffer nil
1434   "The current active buffer, the one where the user typed the last command.
1435 Defaults to the server buffer, and should only be set in the
1436 server buffer.")
1437 (make-variable-buffer-local 'erc-active-buffer)
1438
1439 (defun erc-active-buffer ()
1440   "Return the value of `erc-active-buffer' for the current server.
1441 Defaults to the server buffer."
1442   (erc-with-server-buffer
1443     (if (buffer-live-p erc-active-buffer)
1444         erc-active-buffer
1445       (setq erc-active-buffer (current-buffer)))))
1446
1447 (defun erc-set-active-buffer (buffer)
1448   "Set the value of `erc-active-buffer' to BUFFER."
1449   (cond ((erc-server-buffer)
1450          (with-current-buffer (erc-server-buffer)
1451            (setq erc-active-buffer buffer)))
1452         (t (setq erc-active-buffer buffer))))
1453
1454 ;; Mode activation routines
1455
1456 (define-derived-mode erc-mode fundamental-mode "ERC"
1457   "Major mode for Emacs IRC."
1458   (setq local-abbrev-table erc-mode-abbrev-table)
1459   (when (boundp 'next-line-add-newlines)
1460     (set (make-local-variable 'next-line-add-newlines) nil))
1461   (setq line-move-ignore-invisible t)
1462   (set (make-local-variable 'paragraph-separate)
1463        (concat "\C-l\\|\\(^" (regexp-quote (erc-prompt)) "\\)"))
1464   (set (make-local-variable 'paragraph-start)
1465        (concat "\\(" (regexp-quote (erc-prompt)) "\\)"))
1466   (add-hook 'completion-at-point-functions 'erc-complete-word-at-point nil t))
1467
1468 ;; activation
1469
1470 (defconst erc-default-server "irc.freenode.net"
1471   "IRC server to use if it cannot be detected otherwise.")
1472
1473 (defconst erc-default-port 6667
1474   "IRC port to use if it cannot be detected otherwise.")
1475
1476 (defconst erc-default-port-tls 6697
1477   "IRC port to use for encrypted connections if it cannot be
1478   detected otherwise.")
1479
1480 (defcustom erc-join-buffer 'buffer
1481   "Determines how to display a newly created IRC buffer.
1482
1483 The available choices are:
1484
1485   `window'          - in another window,
1486   `window-noselect' - in another window, but don't select that one,
1487   `frame'           - in another frame,
1488   `bury'            - bury it in a new buffer,
1489   `buffer'          - in place of the current buffer,
1490   any other value  - in place of the current buffer."
1491   :group 'erc-buffers
1492   :type '(choice (const :tag "Split window and select" window)
1493                  (const :tag "Split window, don't select" window-noselect)
1494                  (const :tag "New frame" frame)
1495                  (const :tag "Bury in new buffer" bury)
1496                  (const :tag "Use current buffer" buffer)
1497                  (const :tag "Use current buffer" t)))
1498
1499 (defcustom erc-frame-alist nil
1500   "Alist of frame parameters for creating erc frames.
1501 A value of nil means to use `default-frame-alist'."
1502   :group 'erc-buffers
1503   :type '(repeat (cons :format "%v"
1504                        (symbol :tag "Parameter")
1505                        (sexp :tag "Value"))))
1506
1507 (defcustom erc-frame-dedicated-flag nil
1508   "Non-nil means the erc frames are dedicated to that buffer.
1509 This only has effect when `erc-join-buffer' is set to `frame'."
1510   :group 'erc-buffers
1511   :type 'boolean)
1512
1513 (defcustom erc-reuse-frames t
1514   "Determines whether new frames are always created.
1515 Non-nil means that a new frame is not created to display an ERC
1516 buffer if there is already a window displaying it.  This only has
1517 effect when `erc-join-buffer' is set to `frame'."
1518   :group 'erc-buffers
1519   :type 'boolean)
1520
1521 (defun erc-channel-p (channel)
1522   "Return non-nil if CHANNEL seems to be an IRC channel name."
1523   (cond ((stringp channel)
1524          (memq (aref channel 0) '(?# ?& ?+ ?!)))
1525         ((and (bufferp channel) (buffer-live-p channel))
1526          (with-current-buffer channel
1527            (erc-channel-p (erc-default-target))))
1528         (t nil)))
1529
1530 (defcustom erc-reuse-buffers t
1531   "If nil, create new buffers on joining a channel/query.
1532 If non-nil, a new buffer will only be created when you join
1533 channels with same names on different servers, or have query buffers
1534 open with nicks of the same name on different servers.  Otherwise,
1535 the existing buffers will be reused."
1536   :group 'erc-buffers
1537   :type 'boolean)
1538
1539 (defun erc-normalize-port (port)
1540   "Normalize the port specification PORT to integer form.
1541 PORT may be an integer, a string or a symbol.  If it is a string or a
1542 symbol, it may have these values:
1543 * irc         -> 194
1544 * ircs        -> 994
1545 * ircd        -> 6667
1546 * ircd-dalnet -> 7000"
1547   (cond
1548    ((symbolp port)
1549     (erc-normalize-port (symbol-name port)))
1550    ((stringp port)
1551     (let ((port-nr (string-to-number port)))
1552       (cond
1553        ((> port-nr 0)
1554         port-nr)
1555        ((string-equal port "irc")
1556         194)
1557        ((string-equal port "ircs")
1558         994)
1559        ((string-equal port "ircd")
1560         6667)
1561        ((string-equal port "ircd-dalnet")
1562         7000)
1563        (t
1564         nil))))
1565    ((numberp port)
1566     port)
1567    (t
1568     nil)))
1569
1570 (defun erc-port-equal (a b)
1571   "Check whether ports A and B are equal."
1572   (= (erc-normalize-port a) (erc-normalize-port b)))
1573
1574 (defun erc-generate-new-buffer-name (server port target)
1575   "Create a new buffer name based on the arguments."
1576   (when (numberp port) (setq port (number-to-string port)))
1577   (let ((buf-name (or target
1578                       (or (let ((name (concat server ":" port)))
1579                             (when (> (length name) 1)
1580                               name))
1581                           ;; This fallback should in fact never happen
1582                           "*erc-server-buffer*")))
1583         buffer-name)
1584     ;; Reuse existing buffers, but not if the buffer is a connected server
1585     ;; buffer and not if its associated with a different server than the
1586     ;; current ERC buffer.
1587     ;; if buf-name is taken by a different connection (or by something !erc)
1588     ;; then see if "buf-name/server" meets the same criteria
1589     (dolist (candidate (list buf-name (concat buf-name "/" server)))
1590       (if (and (not buffer-name)
1591                erc-reuse-buffers
1592                (get-buffer candidate)
1593                (or target
1594                    (with-current-buffer (get-buffer candidate)
1595                      (and (erc-server-buffer-p)
1596                           (not (erc-server-process-alive)))))
1597                (with-current-buffer (get-buffer candidate)
1598                  (and (string= erc-session-server server)
1599                       (erc-port-equal erc-session-port port))))
1600           (setq buffer-name candidate)))
1601     ;; if buffer-name is unset, neither candidate worked out for us,
1602     ;; fallback to the old <N> uniquification method:
1603     (or buffer-name (generate-new-buffer-name buf-name)) ))
1604
1605 (defun erc-get-buffer-create (server port target)
1606   "Create a new buffer based on the arguments."
1607   (get-buffer-create (erc-generate-new-buffer-name server port target)))
1608
1609
1610 (defun erc-member-ignore-case (string list)
1611   "Return non-nil if STRING is a member of LIST.
1612
1613 All strings are compared according to IRC protocol case rules, see
1614 `erc-downcase'."
1615   (setq string (erc-downcase string))
1616   (catch 'result
1617     (while list
1618       (if (string= string (erc-downcase (car list)))
1619           (throw 'result list)
1620         (setq list (cdr list))))))
1621
1622 (defmacro erc-with-buffer (spec &rest body)
1623   "Execute BODY in the buffer associated with SPEC.
1624
1625 SPEC should have the form
1626
1627  (TARGET [PROCESS])
1628
1629 If TARGET is a buffer, use it.  Otherwise, use the buffer
1630 matching TARGET in the process specified by PROCESS.
1631
1632 If PROCESS is nil, use the current `erc-server-process'.
1633 See `erc-get-buffer' for details.
1634
1635 See also `with-current-buffer'.
1636
1637 \(fn (TARGET [PROCESS]) BODY...)"
1638   (declare (indent 1) (debug ((form &optional form) body)))
1639   (let ((buf (make-symbol "buf"))
1640         (proc (make-symbol "proc"))
1641         (target (make-symbol "target"))
1642         (process (make-symbol "process")))
1643     `(let* ((,target ,(car spec))
1644             (,process ,(cadr spec))
1645             (,buf (if (bufferp ,target)
1646                       ,target
1647                     (let ((,proc (or ,process
1648                                      (and (processp erc-server-process)
1649                                           erc-server-process))))
1650                       (if (and ,target ,proc)
1651                           (erc-get-buffer ,target ,proc))))))
1652        (when (buffer-live-p ,buf)
1653          (with-current-buffer ,buf
1654            ,@body)))))
1655
1656 (defun erc-get-buffer (target &optional proc)
1657   "Return the buffer matching TARGET in the process PROC.
1658 If PROC is not supplied, all processes are searched."
1659   (let ((downcased-target (erc-downcase target)))
1660     (catch 'buffer
1661       (erc-buffer-filter
1662        (lambda ()
1663          (let ((current (erc-default-target)))
1664            (and (stringp current)
1665                 (string-equal downcased-target (erc-downcase current))
1666                 (throw 'buffer (current-buffer)))))
1667        proc))))
1668
1669 (defun erc--buffer-p (buf predicate proc)
1670   (with-current-buffer buf
1671     (and (derived-mode-p 'erc-mode)
1672          (or (not proc)
1673              (eq proc erc-server-process))
1674          (funcall predicate)
1675          buf)))
1676
1677 (defun erc-buffer-filter (predicate &optional proc)
1678   "Return a list of `erc-mode' buffers matching certain criteria.
1679 PREDICATE is a function executed with each buffer, if it returns t, that buffer
1680 is considered a valid match.
1681
1682 PROC is either an `erc-server-process', identifying a certain
1683 server connection, or nil which means all open connections."
1684   (save-excursion
1685     (delq
1686      nil
1687      (mapcar (lambda (buf)
1688                (when (buffer-live-p buf)
1689                  (erc--buffer-p buf predicate proc)))
1690              (buffer-list)))))
1691
1692 (defun erc-buffer-list (&optional predicate proc)
1693   "Return a list of ERC buffers.
1694 PREDICATE is a function which executes with every buffer satisfying
1695 the predicate.  If PREDICATE is passed as nil, return a list of all ERC
1696 buffers.  If PROC is given, the buffers local variable `erc-server-process'
1697 needs to match PROC."
1698   (unless predicate
1699     (setq predicate (lambda () t)))
1700   (erc-buffer-filter predicate proc))
1701
1702 (defmacro erc-with-all-buffers-of-server (process pred &rest forms)
1703   "Execute FORMS in all buffers which have same process as this server.
1704 FORMS will be evaluated in all buffers having the process PROCESS and
1705 where PRED matches or in all buffers of the server process if PRED is
1706 nil."
1707   (declare (indent 1) (debug (form form body)))
1708   ;; Make the evaluation have the correct order
1709   (let ((pre (make-symbol "pre"))
1710         (pro (make-symbol "pro")))
1711     `(let* ((,pro ,process)
1712             (,pre ,pred)
1713             (res (mapcar (lambda (buffer)
1714                            (with-current-buffer buffer
1715                              ,@forms))
1716                          (erc-buffer-list ,pre
1717                                           ,pro))))
1718        ;; Silence the byte-compiler by binding the result of mapcar to
1719        ;; a variable.
1720        (ignore res)
1721        res)))
1722
1723 (define-obsolete-function-alias 'erc-iswitchb 'erc-switch-to-buffer "25.1")
1724 (defun erc-switch-to-buffer (&optional arg)
1725   "Prompt for a ERC buffer to switch to.
1726 When invoked with prefix argument, use all erc buffers.  Without prefix
1727 ARG, allow only buffers related to same session server.
1728 If `erc-track-mode' is in enabled, put the last element of
1729 `erc-modified-channels-alist' in front of the buffer list."
1730   (interactive "P")
1731   (switch-to-buffer
1732    (read-buffer "Switch to ERC buffer: "
1733                 (when (boundp 'erc-modified-channels-alist)
1734                   (buffer-name (caar (last erc-modified-channels-alist))))
1735                 t
1736                 ;; Only allow ERC buffers in the same session.
1737                 (let ((proc (unless arg erc-server-process)))
1738                   (lambda (bufname)
1739                     (let ((buf (if (consp bufname)
1740                                    (cdr bufname) (get-buffer bufname))))
1741                       (when buf
1742                         (erc--buffer-p buf (lambda () t) proc)
1743                         (with-current-buffer buf
1744                           (and (derived-mode-p 'erc-mode)
1745                                (or (null proc)
1746                                    (eq proc erc-server-process)))))))))))
1747
1748 (defun erc-channel-list (proc)
1749   "Return a list of channel buffers.
1750 PROC is the process for the server connection.  If PROC is nil, return
1751 all channel buffers on all servers."
1752   (erc-buffer-filter
1753    (lambda ()
1754      (and (erc-default-target)
1755           (erc-channel-p (erc-default-target))))
1756    proc))
1757
1758 (defun erc-buffer-list-with-nick (nick proc)
1759   "Return buffers containing NICK in the `erc-channel-users' list."
1760   (with-current-buffer (process-buffer proc)
1761     (let ((user (gethash (erc-downcase nick) erc-server-users)))
1762       (if user
1763           (erc-server-user-buffers user)
1764         nil))))
1765
1766 ;; Some local variables
1767
1768 (defvar erc-default-recipients nil
1769   "List of default recipients of the current buffer.")
1770 (make-variable-buffer-local 'erc-default-recipients)
1771
1772 (defvar erc-session-user-full-name nil
1773   "Full name of the user on the current server.")
1774 (make-variable-buffer-local 'erc-session-user-full-name)
1775
1776 (defvar erc-channel-user-limit nil
1777   "Limit of users per channel.")
1778 (make-variable-buffer-local 'erc-channel-user-limit)
1779
1780 (defvar erc-channel-key nil
1781   "Key needed to join channel.")
1782 (make-variable-buffer-local 'erc-channel-key)
1783
1784 (defvar erc-invitation nil
1785   "Last invitation channel.")
1786 (make-variable-buffer-local 'erc-invitation)
1787
1788 (defvar erc-away nil
1789   "Non-nil indicates that we are away.
1790
1791 Use `erc-away-time' to access this if you might be in a channel
1792 buffer rather than a server buffer.")
1793 (make-variable-buffer-local 'erc-away)
1794
1795 (defvar erc-channel-list nil
1796   "Server channel list.")
1797 (make-variable-buffer-local 'erc-channel-list)
1798
1799 (defvar erc-bad-nick nil
1800   "Non-nil indicates that we got a `nick in use' error while connecting.")
1801 (make-variable-buffer-local 'erc-bad-nick)
1802
1803 (defvar erc-logged-in nil
1804   "Non-nil indicates that we are logged in.")
1805 (make-variable-buffer-local 'erc-logged-in)
1806
1807 (defvar erc-default-nicks nil
1808   "The local copy of `erc-nick' - the list of nicks to choose from.")
1809 (make-variable-buffer-local 'erc-default-nicks)
1810
1811 (defvar erc-nick-change-attempt-count 0
1812   "Used to keep track of how many times an attempt at changing nick is made.")
1813 (make-variable-buffer-local 'erc-nick-change-attempt-count)
1814
1815 (defun erc-migrate-modules (mods)
1816   "Migrate old names of ERC modules to new ones."
1817   ;; modify `transforms' to specify what needs to be changed
1818   ;; each item is in the format '(old . new)
1819   (let ((transforms '((pcomplete . completion))))
1820     (erc-delete-dups
1821      (mapcar (lambda (m) (or (cdr (assoc m transforms)) m))
1822              mods))))
1823
1824 (defcustom erc-modules '(netsplit fill button match track completion readonly
1825                                   networks ring autojoin noncommands irccontrols
1826                                   move-to-prompt stamp menu list)
1827   "A list of modules which ERC should enable.
1828 If you set the value of this without using `customize' remember to call
1829 \(erc-update-modules) after you change it.  When using `customize', modules
1830 removed from the list will be disabled."
1831   :get (lambda (sym)
1832          ;; replace outdated names with their newer equivalents
1833          (erc-migrate-modules (symbol-value sym)))
1834   :set (lambda (sym val)
1835          ;; disable modules which have just been removed
1836          (when (and (boundp 'erc-modules) erc-modules val)
1837            (dolist (module erc-modules)
1838              (unless (member module val)
1839                (let ((f (intern-soft (format "erc-%s-mode" module))))
1840                  (when (and (fboundp f) (boundp f) (symbol-value f))
1841                    (message "Disabling `erc-%s'" module)
1842                    (funcall f 0))))))
1843          (set sym val)
1844          ;; this test is for the case where erc hasn't been loaded yet
1845          (when (fboundp 'erc-update-modules)
1846            (erc-update-modules)))
1847   :type
1848   '(set
1849     :greedy t
1850     (const :tag "autoaway: Set away status automatically" autoaway)
1851     (const :tag "autojoin: Join channels automatically" autojoin)
1852     (const :tag "button: Buttonize URLs, nicknames, and other text" button)
1853     (const :tag "capab: Mark unidentified users on servers supporting CAPAB"
1854            capab-identify)
1855     (const :tag "completion: Complete nicknames and commands (programmable)"
1856            completion)
1857     (const :tag "hecomplete: Complete nicknames and commands (obsolete, use \"completion\")" hecomplete)
1858     (const :tag "dcc: Provide Direct Client-to-Client support" dcc)
1859     (const :tag "fill: Wrap long lines" fill)
1860     (const :tag "identd: Launch an identd server on port 8113" identd)
1861     (const :tag "irccontrols: Highlight or remove IRC control characters"
1862            irccontrols)
1863     (const :tag "keep-place: Leave point above un-viewed text" keep-place)
1864     (const :tag "list: List channels in a separate buffer" list)
1865     (const :tag "log: Save buffers in logs" log)
1866     (const :tag "match: Highlight pals, fools, and other keywords" match)
1867     (const :tag "menu: Display a menu in ERC buffers" menu)
1868     (const :tag "move-to-prompt: Move to the prompt when typing text"
1869            move-to-prompt)
1870     (const :tag "netsplit: Detect netsplits" netsplit)
1871     (const :tag "networks: Provide data about IRC networks" networks)
1872     (const :tag "noncommands: Don't display non-IRC commands after evaluation"
1873            noncommands)
1874     (const :tag
1875            "notify: Notify when the online status of certain users changes"
1876            notify)
1877     (const :tag "notifications: Send notifications on PRIVMSG or nickname mentions"
1878            notifications)
1879     (const :tag "page: Process CTCP PAGE requests from IRC" page)
1880     (const :tag "readonly: Make displayed lines read-only" readonly)
1881     (const :tag "replace: Replace text in messages" replace)
1882     (const :tag "ring: Enable an input history" ring)
1883     (const :tag "scrolltobottom: Scroll to the bottom of the buffer"
1884            scrolltobottom)
1885     (const :tag "services: Identify to Nickserv (IRC Services) automatically"
1886            services)
1887     (const :tag "smiley: Convert smileys to pretty icons" smiley)
1888     (const :tag "sound: Play sounds when you receive CTCP SOUND requests"
1889            sound)
1890     (const :tag "stamp: Add timestamps to messages" stamp)
1891     (const :tag "spelling: Check spelling" spelling)
1892     (const :tag "track: Track channel activity in the mode-line" track)
1893     (const :tag "truncate: Truncate buffers to a certain size" truncate)
1894     (const :tag "unmorse: Translate morse code in messages" unmorse)
1895     (const :tag "xdcc: Act as an XDCC file-server" xdcc)
1896     (repeat :tag "Others" :inline t symbol))
1897   :group 'erc)
1898
1899 (defun erc-update-modules ()
1900   "Run this to enable erc-foo-mode for all modules in `erc-modules'."
1901   (let (req)
1902     (dolist (mod erc-modules)
1903       (setq req (concat "erc-" (symbol-name mod)))
1904       (cond
1905        ;; yuck. perhaps we should bring the filenames into sync?
1906        ((string= req "erc-capab-identify")
1907         (setq req "erc-capab"))
1908        ((string= req "erc-completion")
1909         (setq req "erc-pcomplete"))
1910        ((string= req "erc-pcomplete")
1911         (setq mod 'completion))
1912        ((string= req "erc-autojoin")
1913         (setq req "erc-join")))
1914       (condition-case nil
1915           (require (intern req))
1916         (error nil))
1917       (let ((sym (intern-soft (concat "erc-" (symbol-name mod) "-mode"))))
1918         (if (fboundp sym)
1919             (funcall sym 1)
1920           (error "`%s' is not a known ERC module" mod))))))
1921
1922 (defun erc-setup-buffer (buffer)
1923   "Consults `erc-join-buffer' to find out how to display `BUFFER'."
1924   (pcase erc-join-buffer
1925     (`window
1926      (if (active-minibuffer-window)
1927          (display-buffer buffer)
1928        (switch-to-buffer-other-window buffer)))
1929     (`window-noselect
1930      (display-buffer buffer))
1931     (`bury
1932      nil)
1933     (`frame
1934      (when (or (not erc-reuse-frames)
1935                (not (get-buffer-window buffer t)))
1936        (let ((frame (make-frame (or erc-frame-alist
1937                                     default-frame-alist))))
1938          (raise-frame frame)
1939          (select-frame frame))
1940        (switch-to-buffer buffer)
1941        (when erc-frame-dedicated-flag
1942          (set-window-dedicated-p (selected-window) t))))
1943     (_
1944      (if (active-minibuffer-window)
1945          (display-buffer buffer)
1946        (switch-to-buffer buffer)))))
1947
1948 (defun erc-open (&optional server port nick full-name
1949                            connect passwd tgt-list channel process)
1950   "Connect to SERVER on PORT as NICK with FULL-NAME.
1951
1952 If CONNECT is non-nil, connect to the server.  Otherwise assume
1953 already connected and just create a separate buffer for the new
1954 target CHANNEL.
1955
1956 Use PASSWD as user password on the server.  If TGT-LIST is
1957 non-nil, use it to initialize `erc-default-recipients'.
1958
1959 Returns the buffer for the given server or channel."
1960   (let ((server-announced-name (when (and (boundp 'erc-session-server)
1961                                           (string= server erc-session-server))
1962                                  erc-server-announced-name))
1963         (connected-p (unless connect erc-server-connected))
1964         (buffer (erc-get-buffer-create server port channel))
1965         (old-buffer (current-buffer))
1966         old-point
1967         continued-session)
1968     (when connect (run-hook-with-args 'erc-before-connect server port nick))
1969     (erc-update-modules)
1970     (set-buffer buffer)
1971     (setq old-point (point))
1972     (let ((old-recon-count erc-server-reconnect-count))
1973       (erc-mode)
1974       (setq erc-server-reconnect-count old-recon-count))
1975     (setq erc-server-announced-name server-announced-name)
1976     (setq erc-server-connected connected-p)
1977     ;; connection parameters
1978     (setq erc-server-process process)
1979     (setq erc-insert-marker (make-marker))
1980     (setq erc-input-marker (make-marker))
1981     ;; go to the end of the buffer and open a new line
1982     ;; (the buffer may have existed)
1983     (goto-char (point-max))
1984     (forward-line 0)
1985     (when (get-text-property (point) 'erc-prompt)
1986       (setq continued-session t)
1987       (set-marker erc-input-marker
1988                   (or (next-single-property-change (point) 'erc-prompt)
1989                       (point-max))))
1990     (unless continued-session
1991       (goto-char (point-max))
1992       (insert "\n"))
1993     (set-marker erc-insert-marker (point))
1994     ;; stack of default recipients
1995     (setq erc-default-recipients tgt-list)
1996     (setq erc-server-current-nick nil)
1997     ;; Initialize erc-server-users and erc-channel-users
1998     (if connect
1999         (progn ;; server buffer
2000           (setq erc-server-users
2001                 (make-hash-table :test 'equal))
2002           (setq erc-channel-users nil))
2003       (progn ;; target buffer
2004         (setq erc-server-users nil)
2005         (setq erc-channel-users
2006               (make-hash-table :test 'equal))))
2007     ;; clear last incomplete line read
2008     (setq erc-server-filter-data nil)
2009     (setq erc-channel-topic "")
2010     ;; limit on the number of users on the channel (mode +l)
2011     (setq erc-channel-user-limit nil)
2012     (setq erc-channel-key nil)
2013     ;; last active buffer, defaults to this one
2014     (erc-set-active-buffer buffer)
2015     ;; last invitation channel
2016     (setq erc-invitation nil)
2017     ;; Server channel list
2018     (setq erc-channel-list ())
2019     ;; login-time 'nick in use' error
2020     (setq erc-bad-nick nil)
2021     ;; whether we have logged in
2022     (setq erc-logged-in nil)
2023     ;; The local copy of `erc-nick' - the list of nicks to choose
2024     (setq erc-default-nicks (if (consp erc-nick) erc-nick (list erc-nick)))
2025     ;; password stuff
2026     (setq erc-session-password
2027           (or passwd
2028               (let ((secret
2029                      (plist-get
2030                       (nth 0
2031                            (auth-source-search :host server
2032                                                :max 1
2033                                                :user nick
2034                                                ;; secrets.el wouldn’t accept a number
2035                                                :port (if (numberp port) (number-to-string port) port)
2036                                                :require '(:secret)))
2037                       :secret)))
2038                 (if (functionp secret)
2039                     (funcall secret)
2040                   secret))))
2041     ;; debug output buffer
2042     (setq erc-dbuf
2043           (when erc-log-p
2044             (get-buffer-create (concat "*ERC-DEBUG: " server "*"))))
2045     ;; set up prompt
2046     (unless continued-session
2047       (goto-char (point-max))
2048       (insert "\n"))
2049     (if continued-session
2050         (goto-char old-point)
2051       (set-marker erc-insert-marker (point))
2052       (erc-display-prompt)
2053       (goto-char (point-max)))
2054
2055     (erc-determine-parameters server port nick full-name)
2056
2057     ;; Saving log file on exit
2058     (run-hook-with-args 'erc-connect-pre-hook buffer)
2059
2060     (when connect
2061       (erc-server-connect erc-session-server erc-session-port buffer))
2062     (erc-update-mode-line)
2063
2064     ;; Now display the buffer in a window as per user wishes.
2065     (unless (eq buffer old-buffer)
2066       (when erc-log-p
2067         ;; we can't log to debug buffer, it may not exist yet
2068         (message "erc: old buffer %s, switching to %s"
2069                  old-buffer buffer))
2070       (erc-setup-buffer buffer))
2071
2072     buffer))
2073
2074 (defun erc-initialize-log-marker (buffer)
2075   "Initialize the `erc-last-saved-position' marker to a sensible position.
2076 BUFFER is the current buffer."
2077   (with-current-buffer buffer
2078     (unless (markerp erc-last-saved-position)
2079       (setq erc-last-saved-position (make-marker))
2080       (move-marker erc-last-saved-position
2081                    (1- (marker-position erc-insert-marker))))))
2082
2083 ;; interactive startup
2084
2085 (defvar erc-server-history-list nil
2086   "IRC server interactive selection history list.")
2087
2088 (defvar erc-nick-history-list nil
2089   "Nickname interactive selection history list.")
2090
2091 (defun erc-already-logged-in (server port nick)
2092   "Return the buffers corresponding to a NICK on PORT of a session SERVER.
2093 This is determined by looking for the appropriate buffer and checking
2094 whether the connection is still alive.
2095 If no buffer matches, return nil."
2096   (erc-buffer-list
2097    (lambda ()
2098      (and (erc-server-process-alive)
2099           (string= erc-session-server server)
2100           (erc-port-equal erc-session-port port)
2101           (erc-current-nick-p nick)))))
2102
2103 (defcustom erc-before-connect nil
2104   "Hook called before connecting to a server.
2105 This hook gets executed before `erc' actually invokes `erc-mode'
2106 with your input data.  The functions in here get called with three
2107 parameters, SERVER, PORT and NICK."
2108   :group 'erc-hooks
2109   :type 'hook)
2110
2111 (defcustom erc-after-connect nil
2112   "Hook called after connecting to a server.
2113 This hook gets executed when an end of MOTD has been received.  All
2114 functions in here get called with the parameters SERVER and NICK."
2115   :group 'erc-hooks
2116   :type 'hook)
2117
2118 ;;;###autoload
2119 (defun erc-select-read-args ()
2120   "Prompt the user for values of nick, server, port, and password."
2121   (let (user-input server port nick passwd)
2122     (setq user-input (read-from-minibuffer
2123                       "IRC server: "
2124                       (erc-compute-server) nil nil 'erc-server-history-list))
2125
2126     (if (string-match "\\(.*\\):\\(.*\\)\\'" user-input)
2127         (setq port (erc-string-to-port (match-string 2 user-input))
2128               user-input (match-string 1 user-input))
2129       (setq port
2130             (erc-string-to-port (read-from-minibuffer
2131                                  "IRC port: " (erc-port-to-string
2132                                                (erc-compute-port))))))
2133
2134     (if (string-match "\\`\\(.*\\)@\\(.*\\)" user-input)
2135         (setq nick (match-string 1 user-input)
2136               user-input (match-string 2 user-input))
2137       (setq nick
2138             (if (erc-already-logged-in server port nick)
2139                 (read-from-minibuffer
2140                  (erc-format-message 'nick-in-use ?n nick)
2141                  nick
2142                  nil nil 'erc-nick-history-list)
2143               (read-from-minibuffer
2144                "Nickname: " (erc-compute-nick nick)
2145                nil nil 'erc-nick-history-list))))
2146
2147     (setq server user-input)
2148
2149     (setq passwd (if erc-prompt-for-password
2150                      (if (and erc-password
2151                               (y-or-n-p "Use the default password? "))
2152                          erc-password
2153                        (read-passwd "Password: "))
2154                    erc-password))
2155     (when (and passwd (string= "" passwd))
2156       (setq passwd nil))
2157
2158     (while (erc-already-logged-in server port nick)
2159       ;; hmm, this is a problem when using multiple connections to a bnc
2160       ;; with the same nick. Currently this code prevents using more than one
2161       ;; bnc with the same nick. actually it would be nice to have
2162       ;; bncs transparent, so that erc-compute-buffer-name displays
2163       ;; the server one is connected to.
2164       (setq nick (read-from-minibuffer
2165                   (erc-format-message 'nick-in-use ?n nick)
2166                   nick
2167                   nil nil 'erc-nick-history-list)))
2168     (list :server server :port port :nick nick :password passwd)))
2169
2170 ;;;###autoload
2171 (cl-defun erc (&key (server (erc-compute-server))
2172                     (port   (erc-compute-port))
2173                     (nick   (erc-compute-nick))
2174                     password
2175                     (full-name (erc-compute-full-name)))
2176   "ERC is a powerful, modular, and extensible IRC client.
2177 This function is the main entry point for ERC.
2178
2179 It permits you to select connection parameters, and then starts ERC.
2180
2181 Non-interactively, it takes the keyword arguments
2182    (server (erc-compute-server))
2183    (port   (erc-compute-port))
2184    (nick   (erc-compute-nick))
2185    password
2186    (full-name (erc-compute-full-name)))
2187
2188 That is, if called with
2189
2190    (erc :server \"irc.freenode.net\" :full-name \"Harry S Truman\")
2191
2192 then the server and full-name will be set to those values, whereas
2193 `erc-compute-port', `erc-compute-nick' and `erc-compute-full-name' will
2194 be invoked for the values of the other parameters."
2195   (interactive (erc-select-read-args))
2196   (erc-open server port nick full-name t password))
2197
2198 ;;;###autoload
2199 (defalias 'erc-select 'erc)
2200 (defalias 'erc-ssl 'erc-tls)
2201
2202 ;;;###autoload
2203 (defun erc-tls (&rest r)
2204   "Interactively select TLS connection parameters and run ERC.
2205 Arguments are the same as for `erc'."
2206   (interactive (let ((erc-default-port erc-default-port-tls))
2207                  (erc-select-read-args)))
2208   (let ((erc-server-connect-function 'erc-open-tls-stream))
2209     (apply #'erc r)))
2210
2211 (defun erc-open-tls-stream (name buffer host port)
2212   "Open an TLS stream to an IRC server.
2213 The process will be given the name NAME, its target buffer will be
2214 BUFFER.  HOST and PORT specify the connection target."
2215   (open-network-stream name buffer host port
2216                        :nowait t
2217                        :type 'tls))
2218
2219 ;;; Displaying error messages
2220
2221 (defun erc-error (&rest args)
2222   "Pass ARGS to `format', and display the result as an error message.
2223 If `debug-on-error' is set to non-nil, then throw a real error with this
2224 message instead, to make debugging easier."
2225   (if debug-on-error
2226       (apply #'error args)
2227     (apply #'message args)
2228     (beep)))
2229
2230 ;;; Debugging the protocol
2231
2232 (defvar erc-debug-irc-protocol nil
2233   "If non-nil, log all IRC protocol traffic to the buffer \"*erc-protocol*\".
2234
2235 The buffer is created if it doesn't exist.
2236
2237 NOTE: If this variable is non-nil, and you kill the only
2238 visible \"*erc-protocol*\" buffer, it will be recreated shortly,
2239 but you won't see it.
2240
2241 WARNING: Do not set this variable directly!  Instead, use the
2242 function `erc-toggle-debug-irc-protocol' to toggle its value.")
2243
2244 (declare-function erc-network-name "erc-networks" ())
2245
2246 (defun erc-log-irc-protocol (string &optional outbound)
2247   "Append STRING to the buffer *erc-protocol*.
2248
2249 This only has any effect if `erc-debug-irc-protocol' is non-nil.
2250
2251 The buffer is created if it doesn't exist.
2252
2253 If OUTBOUND is non-nil, STRING is being sent to the IRC server
2254 and appears in face `erc-input-face' in the buffer."
2255   (when erc-debug-irc-protocol
2256     (let ((network-name (or (ignore-errors (erc-network-name))
2257                             "???")))
2258       (with-current-buffer (get-buffer-create "*erc-protocol*")
2259         (save-excursion
2260           (goto-char (point-max))
2261           (let ((inhibit-read-only t))
2262             (insert (if (not outbound)
2263                         ;; Cope with the fact that string might
2264                         ;; contain multiple lines of text.
2265                         (let ((lines (delete "" (split-string string
2266                                                               "\n\\|\r\n")))
2267                               (result ""))
2268                           (dolist (line lines)
2269                             (setq result (concat result network-name
2270                                                  " << " line "\n")))
2271                           result)
2272                       (erc-propertize
2273                        (concat network-name " >> " string
2274                                (if (/= ?\n
2275                                        (aref string
2276                                              (1- (length string))))
2277                                    "\n"))
2278                        'face 'erc-input-face)))))
2279         (let ((orig-win (selected-window))
2280               (debug-buffer-window (get-buffer-window (current-buffer) t)))
2281           (when debug-buffer-window
2282             (select-window debug-buffer-window)
2283             (when (= 1 (count-lines (point) (point-max)))
2284               (goto-char (point-max))
2285               (recenter -1))
2286             (select-window orig-win)))))))
2287
2288 (defun erc-toggle-debug-irc-protocol (&optional arg)
2289   "Toggle the value of `erc-debug-irc-protocol'.
2290
2291 If ARG is non-nil, show the *erc-protocol* buffer."
2292   (interactive "P")
2293   (let* ((buf (get-buffer-create "*erc-protocol*")))
2294     (with-current-buffer buf
2295       (erc-view-mode-enter)
2296       (when (null (current-local-map))
2297         (let ((inhibit-read-only t))
2298           (insert (erc-make-notice "This buffer displays all IRC protocol traffic exchanged with each server.\n"))
2299           (insert (erc-make-notice "Kill this buffer to terminate protocol logging.\n\n")))
2300         (use-local-map (make-sparse-keymap))
2301         (local-set-key (kbd "t") 'erc-toggle-debug-irc-protocol))
2302       (add-hook 'kill-buffer-hook
2303                 #'(lambda () (setq erc-debug-irc-protocol nil))
2304                 nil 'local)
2305       (goto-char (point-max))
2306       (let ((inhibit-read-only t))
2307         (insert (erc-make-notice
2308                  (format "IRC protocol logging %s at %s -- Press `t' to toggle logging.\n"
2309                          (if erc-debug-irc-protocol "disabled" "enabled")
2310                          (current-time-string))))))
2311     (setq erc-debug-irc-protocol (not erc-debug-irc-protocol))
2312     (if (and arg
2313              (not (get-buffer-window "*erc-protocol*" t)))
2314         (display-buffer buf t))
2315     (message "IRC protocol traffic logging %s (see buffer *erc-protocol*)."
2316              (if erc-debug-irc-protocol "enabled" "disabled"))))
2317
2318 ;;; I/O interface
2319
2320 ;; send interface
2321
2322 (defun erc-send-action (tgt str &optional force)
2323   "Send CTCP ACTION information described by STR to TGT."
2324   (erc-send-ctcp-message tgt (format "ACTION %s" str) force)
2325   (erc-display-message
2326    nil 'input (current-buffer)
2327    'ACTION ?n (erc-current-nick) ?a str ?u "" ?h ""))
2328
2329 ;; Display interface
2330
2331 (defun erc-string-invisible-p (string)
2332   "Check whether STRING is invisible or not.
2333 I.e. any char in it has the `invisible' property set."
2334   (text-property-any 0 (length string) 'invisible t string))
2335
2336 (defcustom erc-remove-parsed-property t
2337   "Whether to remove the erc-parsed text property after displaying a message.
2338
2339 The default is to remove it, since it causes ERC to take up extra
2340 memory.  If you have code that relies on this property, then set
2341 this option to nil."
2342   :type 'boolean
2343   :group 'erc)
2344
2345 (defun erc-display-line-1 (string buffer)
2346   "Display STRING in `erc-mode' BUFFER.
2347 Auxiliary function used in `erc-display-line'.  The line gets filtered to
2348 interpret the control characters.  Then, `erc-insert-pre-hook' gets called.
2349 If `erc-insert-this' is still t, STRING gets inserted into the buffer.
2350 Afterwards, `erc-insert-modify' and `erc-insert-post-hook' get called.
2351 If STRING is nil, the function does nothing."
2352   (when string
2353     (with-current-buffer (or buffer (process-buffer erc-server-process))
2354       (let ((insert-position (or (marker-position erc-insert-marker)
2355                                  (point-max))))
2356         (let ((string string) ;; FIXME! Can this be removed?
2357               (buffer-undo-list t)
2358               (inhibit-read-only t))
2359           (unless (string-match "\n$" string)
2360             (setq string (concat string "\n"))
2361             (when (erc-string-invisible-p string)
2362               (erc-put-text-properties 0 (length string)
2363                                        '(invisible intangible) string)))
2364           (erc-log (concat "erc-display-line: " string
2365                            (format "(%S)" string) " in buffer "
2366                            (format "%s" buffer)))
2367           (setq erc-insert-this t)
2368           (run-hook-with-args 'erc-insert-pre-hook string)
2369           (if (null erc-insert-this)
2370               ;; Leave erc-insert-this set to t as much as possible.  Fran
2371               ;; Litterio <franl> has seen erc-insert-this set to nil while
2372               ;; erc-send-pre-hook is running, which should never happen.  This
2373               ;; may cure it.
2374               (setq erc-insert-this t)
2375             (save-excursion ;; to restore point in the new buffer
2376               (save-restriction
2377                 (widen)
2378                 (goto-char insert-position)
2379                 (insert-before-markers string)
2380                 ;; run insertion hook, with point at restored location
2381                 (save-restriction
2382                   (narrow-to-region insert-position (point))
2383                   (run-hooks 'erc-insert-modify-hook)
2384                   (run-hooks 'erc-insert-post-hook)
2385                   (when erc-remove-parsed-property
2386                     (remove-text-properties (point-min) (point-max)
2387                                             '(erc-parsed nil))))))))
2388         (erc-update-undo-list (- (or (marker-position erc-insert-marker)
2389                                      (point-max))
2390                                  insert-position))))))
2391
2392 (defun erc-update-undo-list (shift)
2393   ;; Translate buffer positions in buffer-undo-list by SHIFT.
2394   (unless (or (zerop shift) (atom buffer-undo-list))
2395     (let ((list buffer-undo-list) elt)
2396       (while list
2397         (setq elt (car list))
2398         (cond ((integerp elt)           ; POSITION
2399                (cl-incf (car list) shift))
2400               ((or (atom elt)           ; nil, EXTENT
2401                    ;; (eq t (car elt))  ; (t . TIME)
2402                    (markerp (car elt))) ; (MARKER . DISTANCE)
2403                nil)
2404               ((integerp (car elt))     ; (BEGIN . END)
2405                (cl-incf (car elt) shift)
2406                (cl-incf (cdr elt) shift))
2407               ((stringp (car elt))      ; (TEXT . POSITION)
2408                (cl-incf (cdr elt) (* (if (natnump (cdr elt)) 1 -1) shift)))
2409               ((null (car elt))         ; (nil PROPERTY VALUE BEG . END)
2410                (let ((cons (nthcdr 3 elt)))
2411                  (cl-incf (car cons) shift)
2412                  (cl-incf (cdr cons) shift)))
2413               ((and (featurep 'xemacs)
2414                     (extentp (car elt))) ; (EXTENT START END)
2415                (cl-incf (nth 1 elt) shift)
2416                (cl-incf (nth 2 elt) shift)))
2417         (setq list (cdr list))))))
2418
2419 (defvar erc-valid-nick-regexp "[]a-zA-Z^[;\\`_{}|][]^[;\\`_{}|a-zA-Z0-9-]*"
2420   "Regexp which matches all valid characters in a IRC nickname.")
2421
2422 (defun erc-is-valid-nick-p (nick)
2423   "Check if NICK is a valid IRC nickname."
2424   (string-match (concat "\\`" erc-valid-nick-regexp "\\'") nick))
2425
2426 (defun erc-display-line (string &optional buffer)
2427   "Display STRING in the ERC BUFFER.
2428 All screen output must be done through this function.  If BUFFER is nil
2429 or omitted, the default ERC buffer for the `erc-session-server' is used.
2430 The BUFFER can be an actual buffer, a list of buffers, `all' or `active'.
2431 If BUFFER = `all', the string is displayed in all the ERC buffers for the
2432 current session.  `active' means the current active buffer
2433 \(`erc-active-buffer').  If the buffer can't be resolved, the current
2434 buffer is used.  `erc-display-line-1' is used to display STRING.
2435
2436 If STRING is nil, the function does nothing."
2437   (let ((inhibit-point-motion-hooks t)
2438         new-bufs)
2439     (dolist (buf (cond
2440                   ((bufferp buffer) (list buffer))
2441                   ((listp buffer) buffer)
2442                   ((processp buffer) (list (process-buffer buffer)))
2443                   ((eq 'all buffer)
2444                    ;; Hmm, or all of the same session server?
2445                    (erc-buffer-list nil erc-server-process))
2446                   ((and (eq 'active buffer) (erc-active-buffer))
2447                    (list (erc-active-buffer)))
2448                   ((erc-server-buffer-live-p)
2449                    (list (process-buffer erc-server-process)))
2450                   (t (list (current-buffer)))))
2451       (when (buffer-live-p buf)
2452         (erc-display-line-1 string buf)
2453         (push buf new-bufs)))
2454     (when (null new-bufs)
2455       (erc-display-line-1 string (if (erc-server-buffer-live-p)
2456                                      (process-buffer erc-server-process)
2457                                    (current-buffer))))))
2458
2459 (defun erc-display-message-highlight (type string)
2460   "Highlight STRING according to TYPE, where erc-TYPE-face is an ERC face.
2461
2462 See also `erc-make-notice'."
2463   (cond ((eq type 'notice)
2464          (erc-make-notice string))
2465         (t
2466          (erc-put-text-property
2467           0 (length string)
2468           'face (or (intern-soft
2469                      (concat "erc-" (symbol-name type) "-face"))
2470                     "erc-default-face")
2471           string)
2472          string)))
2473
2474 (defvar erc-lurker-state nil
2475   "Track the time of the last PRIVMSG for each (server,nick) pair.
2476
2477 This is implemented as a hash of hashes, where the outer key is
2478 the canonicalized server name (as returned by
2479 `erc-canonicalize-server-name') and the outer value is a hash
2480 table mapping nicks (as returned by `erc-lurker-maybe-trim') to
2481 the times of their most recently received PRIVMSG on any channel
2482 on the given server.")
2483
2484 (defcustom erc-lurker-trim-nicks t
2485   "If t, trim trailing `erc-lurker-ignore-chars' from nicks.
2486
2487 This causes e.g. nick and nick\\=` to be considered as the same
2488 individual for activity tracking and lurkiness detection
2489 purposes."
2490   :group 'erc-lurker
2491   :type 'boolean)
2492
2493 (defcustom erc-lurker-ignore-chars "`_"
2494   "Characters at the end of a nick to strip for activity tracking purposes.
2495
2496 See also `erc-lurker-trim-nicks'."
2497   :group 'erc-lurker
2498   :type 'string)
2499
2500 (defun erc-lurker-maybe-trim (nick)
2501   "Maybe trim trailing `erc-lurker-ignore-chars' from NICK.
2502
2503 Returns NICK unmodified unless `erc-lurker-trim-nicks' is
2504 non-nil."
2505   (if erc-lurker-trim-nicks
2506       (replace-regexp-in-string
2507        (format "[%s]"
2508                (mapconcat (lambda (char)
2509                             (regexp-quote (char-to-string char)))
2510                           erc-lurker-ignore-chars ""))
2511        "" nick)
2512     nick))
2513
2514 (defcustom erc-lurker-hide-list nil
2515   "List of IRC type messages to hide when sent by lurkers.
2516
2517 A typical value would be \(\"JOIN\" \"PART\" \"QUIT\").
2518 See also `erc-lurker-p' and `erc-hide-list'."
2519   :group 'erc-lurker
2520   :type 'erc-message-type)
2521
2522 (defcustom erc-lurker-threshold-time (* 60 60 24) ; 24h by default
2523   "Nicks from which no PRIVMSGs have been received within this
2524 interval (in units of seconds) are considered lurkers by
2525 `erc-lurker-p' and as a result their messages of types in
2526 `erc-lurker-hide-list' will be hidden."
2527   :group 'erc-lurker
2528   :type 'integer)
2529
2530 (defun erc-lurker-initialize ()
2531   "Initialize ERC lurker tracking functionality.
2532
2533 This function adds `erc-lurker-update-status' to
2534 `erc-insert-pre-hook' in order to record the time of each nick's
2535 most recent PRIVMSG as well as initializing the state variable
2536 storing this information."
2537   (setq erc-lurker-state (make-hash-table :test 'equal))
2538   (add-hook 'erc-insert-pre-hook 'erc-lurker-update-status))
2539
2540 (defun erc-lurker-cleanup ()
2541   "Remove all last PRIVMSG state older than `erc-lurker-threshold-time'.
2542
2543 This should be called regularly to avoid excessive resource
2544 consumption for long-lived IRC or Emacs sessions."
2545   (maphash
2546    (lambda (server hash)
2547      (maphash
2548       (lambda (nick last-PRIVMSG-time)
2549         (when
2550             (> (float-time (time-subtract
2551                             (current-time)
2552                             last-PRIVMSG-time))
2553                erc-lurker-threshold-time)
2554           (remhash nick hash)))
2555       hash)
2556      (if (zerop (hash-table-count hash))
2557          (remhash server erc-lurker-state)))
2558    erc-lurker-state))
2559
2560 (defvar erc-lurker-cleanup-count 0
2561   "Internal counter variable for use with `erc-lurker-cleanup-interval'.")
2562
2563 (defvar erc-lurker-cleanup-interval 100
2564   "Frequency of cleaning up stale erc-lurker state.
2565
2566 `erc-lurker-update-status' calls `erc-lurker-cleanup' once for
2567 every `erc-lurker-cleanup-interval' updates to
2568 `erc-lurker-state'.  This is designed to limit the memory
2569 consumption of lurker state during long Emacs sessions and/or ERC
2570 sessions with large numbers of incoming PRIVMSGs.")
2571
2572 (defun erc-lurker-update-status (_message)
2573   "Update `erc-lurker-state' if necessary.
2574
2575 This function is called from `erc-insert-pre-hook'.  If the
2576 current message is a PRIVMSG, update `erc-lurker-state' to
2577 reflect the fact that its sender has issued a PRIVMSG at the
2578 current time.  Otherwise, take no action.
2579
2580 This function depends on the fact that `erc-display-message'
2581 dynamically binds `parsed', which is used to check if the current
2582 message is a PRIVMSG and to determine its sender.  See also
2583 `erc-lurker-trim-nicks' and `erc-lurker-ignore-chars'.
2584
2585 In order to limit memory consumption, this function also calls
2586 `erc-lurker-cleanup' once every `erc-lurker-cleanup-interval'
2587 updates of `erc-lurker-state'."
2588   (when (and (boundp 'parsed) (erc-response-p parsed))
2589     (let* ((command (erc-response.command parsed))
2590            (sender
2591             (erc-lurker-maybe-trim
2592              (car (erc-parse-user (erc-response.sender parsed)))))
2593            (server
2594             (erc-canonicalize-server-name erc-server-announced-name)))
2595       (when (equal command "PRIVMSG")
2596         (when (>= (cl-incf erc-lurker-cleanup-count)
2597                   erc-lurker-cleanup-interval)
2598           (setq erc-lurker-cleanup-count 0)
2599           (erc-lurker-cleanup))
2600         (unless (gethash server erc-lurker-state)
2601           (puthash server (make-hash-table :test 'equal) erc-lurker-state))
2602         (puthash sender (current-time)
2603                  (gethash server erc-lurker-state))))))
2604
2605 (defun erc-lurker-p (nick)
2606   "Predicate indicating NICK's lurking status on the current server.
2607
2608 Lurking is the condition where NICK has issued no PRIVMSG on this
2609 server within `erc-lurker-threshold-time'.  See also
2610 `erc-lurker-trim-nicks' and `erc-lurker-ignore-chars'."
2611   (unless erc-lurker-state (erc-lurker-initialize))
2612   (let* ((server
2613           (erc-canonicalize-server-name erc-server-announced-name))
2614          (last-PRIVMSG-time
2615           (gethash (erc-lurker-maybe-trim nick)
2616                    (gethash server erc-lurker-state (make-hash-table)))))
2617     (or (null last-PRIVMSG-time)
2618         (> (float-time
2619             (time-subtract (current-time) last-PRIVMSG-time))
2620            erc-lurker-threshold-time))))
2621
2622 (defcustom erc-common-server-suffixes
2623   '(("openprojects.net\\'" . "OPN")
2624     ("freenode.net\\'" . "freenode")
2625     ("oftc.net\\'" . "OFTC"))
2626   "Alist of common server name suffixes.
2627 This variable is used in mode-line display to save screen
2628 real estate.  Set it to nil if you want to avoid changing
2629 displayed hostnames."
2630   :group 'erc-mode-line-and-header
2631   :type 'alist)
2632
2633 (defun erc-canonicalize-server-name (server)
2634   "Return the canonical network name for SERVER if any,
2635 otherwise `erc-server-announced-name'.  SERVER is matched against
2636 `erc-common-server-suffixes'."
2637   (when server
2638     (or (cdar (erc-remove-if-not
2639                (lambda (net) (string-match (car net) server))
2640                erc-common-server-suffixes))
2641         erc-server-announced-name)))
2642
2643 (defun erc-add-targets (scope target-list)
2644   (let ((targets
2645          (mapcar (lambda (targets) (member scope targets)) target-list)))
2646     (cdr (apply 'append (delete nil targets)))))
2647
2648 (defun erc-hide-current-message-p (parsed)
2649   "Predicate indicating whether the parsed ERC response PARSED should be hidden.
2650
2651 Messages are always hidden if the message type of PARSED appears in
2652 `erc-hide-list'. Message types that appear in `erc-network-hide-list'
2653 or `erc-channel-hide-list' are are only hidden if the target matches
2654 the network or channel in the list. In addition, messages whose type
2655 is a member of `erc-lurker-hide-list' are hidden if `erc-lurker-p'
2656 returns non-nil."
2657   (let* ((command (erc-response.command parsed))
2658          (sender (car (erc-parse-user (erc-response.sender parsed))))
2659          (channel (nth 1 (erc-response.command-args parsed)))
2660          (network (or (and (fboundp 'erc-network-name) (erc-network-name))
2661                       (erc-shorten-server-name
2662                        (or erc-server-announced-name
2663                            erc-session-server))))
2664          (current-hide-list
2665           (when erc-network-hide-list
2666             (erc-add-targets network erc-network-hide-list)))
2667          (current-hide-list
2668           (apply 'append current-hide-list
2669                  (when erc-channel-hide-list
2670                    (erc-add-targets channel erc-channel-hide-list)))))
2671     (or (member command erc-hide-list)
2672         (member command current-hide-list)
2673         (and (member command erc-lurker-hide-list) (erc-lurker-p sender)))))
2674
2675 (defun erc-display-message (parsed type buffer msg &rest args)
2676   "Display MSG in BUFFER.
2677
2678 ARGS, PARSED, and TYPE are used to format MSG sensibly.
2679
2680 See also `erc-format-message' and `erc-display-line'."
2681   (let ((string (if (symbolp msg)
2682                     (apply #'erc-format-message msg args)
2683                   msg)))
2684     (setq string
2685           (cond
2686            ((null type)
2687             string)
2688            ((listp type)
2689             (mapc (lambda (type)
2690                     (setq string
2691                           (erc-display-message-highlight type string)))
2692                   type)
2693             string)
2694            ((symbolp type)
2695             (erc-display-message-highlight type string))))
2696
2697     (if (not (erc-response-p parsed))
2698         (erc-display-line string buffer)
2699       (unless (erc-hide-current-message-p parsed)
2700         (erc-put-text-property 0 (length string) 'erc-parsed parsed string)
2701         (erc-put-text-property 0 (length string) 'rear-sticky t string)
2702         (erc-display-line string buffer)))))
2703
2704 (defun erc-message-type-member (position list)
2705   "Return non-nil if the erc-parsed text-property at POSITION is in LIST.
2706
2707 This function relies on the erc-parsed text-property being
2708 present."
2709   (let ((prop-val (erc-get-parsed-vector position)))
2710     (and prop-val (member (erc-response.command prop-val) list))))
2711
2712 (defvar erc-send-input-line-function 'erc-send-input-line)
2713 (make-variable-buffer-local 'erc-send-input-line-function)
2714
2715 (defun erc-send-input-line (target line &optional force)
2716   "Send LINE to TARGET.
2717
2718 See also `erc-server-send'."
2719   (setq line (format "PRIVMSG %s :%s"
2720                      target
2721                      ;; If the line is empty, we still want to
2722                      ;; send it - i.e. an empty pasted line.
2723                      (if (string= line "\n")
2724                          " \n"
2725                        line)))
2726   (erc-server-send line force target))
2727
2728 (defun erc-get-arglist (fun)
2729   "Return the argument list of a function without the parens."
2730   (let ((arglist (format "%S" (erc-function-arglist fun))))
2731     (if (string-match "\\`(\\(.*\\))\\'" arglist)
2732         (match-string 1 arglist)
2733       arglist)))
2734
2735 (defun erc-command-no-process-p (str)
2736   "Return non-nil if STR is an ERC command that can be run when the process
2737 is not alive, nil otherwise."
2738   (let ((fun (erc-extract-command-from-line str)))
2739     (and fun
2740          (symbolp (car fun))
2741          (get (car fun) 'process-not-needed))))
2742
2743 (defun erc-command-name (cmd)
2744   "For CMD being the function name of a ERC command, something like
2745 erc-cmd-FOO, this returns a string /FOO."
2746   (let ((command-name (symbol-name cmd)))
2747     (if (string-match "\\`erc-cmd-\\(.*\\)\\'" command-name)
2748         (concat "/" (match-string 1 command-name))
2749       command-name)))
2750
2751 (defun erc-process-input-line (line &optional force no-command)
2752   "Translate LINE to an RFC1459 command and send it based.
2753 Returns non-nil if the command is actually sent to the server, and nil
2754 otherwise.
2755
2756 If the command in the LINE is not bound as a function `erc-cmd-<COMMAND>',
2757 it is passed to `erc-cmd-default'.  If LINE is not a command (i.e. doesn't
2758 start with /<COMMAND>) then it is sent as a message.
2759
2760 An optional FORCE argument forces sending the line when flood
2761 protection is in effect.  The optional NO-COMMAND argument prohibits
2762 this function from interpreting the line as a command."
2763   (let ((command-list (erc-extract-command-from-line line)))
2764     (if (and command-list
2765              (not no-command))
2766         (let* ((cmd  (nth 0 command-list))
2767                (args (nth 1 command-list)))
2768           (condition-case nil
2769               (if (listp args)
2770                   (apply cmd args)
2771                 (funcall cmd args))
2772             (wrong-number-of-arguments
2773              (erc-display-message nil 'error (current-buffer) 'incorrect-args
2774                                   ?c (erc-command-name cmd)
2775                                   ?u (or (erc-get-arglist cmd)
2776                                          "")
2777                                   ?d (format "%s\n"
2778                                              (or (documentation cmd) "")))
2779              nil)))
2780       (let ((r (erc-default-target)))
2781         (if r
2782             (funcall erc-send-input-line-function r line force)
2783           (erc-display-message nil 'error (current-buffer) 'no-target)
2784           nil)))))
2785
2786 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2787 ;;                    Input commands handlers
2788 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2789
2790 (defun erc-cmd-AMSG (line)
2791   "Send LINE to all channels of the current server that you are on."
2792   (interactive "sSend to all channels you're on: ")
2793   (setq line (erc-trim-string line))
2794   (erc-with-all-buffers-of-server nil
2795     (lambda ()
2796       (erc-channel-p (erc-default-target)))
2797     (erc-send-message line)))
2798 (put 'erc-cmd-AMSG 'do-not-parse-args t)
2799
2800 (defun erc-cmd-SAY (line)
2801   "Send LINE to the current query or channel as a message, not a command.
2802
2803 Use this when you want to send a message with a leading `/'.  Note
2804 that since multi-line messages are never a command, you don't
2805 need this when pasting multiple lines of text."
2806   (if (string-match "^\\s-*$" line)
2807       nil
2808     (string-match "^ ?\\(.*\\)" line)
2809     (erc-process-input-line (match-string 1 line) nil t)))
2810 (put 'erc-cmd-SAY 'do-not-parse-args t)
2811
2812 (defun erc-cmd-SET (line)
2813   "Set the variable named by the first word in LINE to some VALUE.
2814 VALUE is computed by evaluating the rest of LINE in Lisp."
2815   (cond
2816    ((string-match "^\\s-*\\(\\S-+\\)\\s-+\\(.*\\)$" line)
2817     (let ((var (read (concat "erc-" (match-string 1 line))))
2818           (val (read (match-string 2 line))))
2819       (if (boundp var)
2820           (progn
2821             (set var (eval val))
2822             (erc-display-message
2823              nil nil 'active (format "Set %S to %S" var val))
2824             t)
2825         (setq var (read (match-string 1 line)))
2826         (if (boundp var)
2827             (progn
2828               (set var (eval val))
2829               (erc-display-message
2830                nil nil 'active (format "Set %S to %S" var val))
2831               t)
2832           (erc-display-message nil 'error 'active 'variable-not-bound)
2833           nil))))
2834    ((string-match "^\\s-*$" line)
2835     (erc-display-line
2836      (concat "Available user variables:\n"
2837              (apply
2838               #'concat
2839               (mapcar
2840                (lambda (var)
2841                  (let ((val (symbol-value var)))
2842                    (concat (format "%S:" var)
2843                            (if (consp val)
2844                                (concat "\n" (pp-to-string val))
2845                              (format " %S\n" val)))))
2846                (apropos-internal "^erc-" 'custom-variable-p))))
2847      (current-buffer))
2848     t)
2849    (t nil)))
2850 (defalias 'erc-cmd-VAR 'erc-cmd-SET)
2851 (defalias 'erc-cmd-VARIABLE 'erc-cmd-SET)
2852 (put 'erc-cmd-SET 'do-not-parse-args t)
2853 (put 'erc-cmd-SET 'process-not-needed t)
2854
2855 (defun erc-cmd-default (line)
2856   "Fallback command.
2857
2858 Commands for which no erc-cmd-xxx exists, are tunneled through
2859 this function.  LINE is sent to the server verbatim, and
2860 therefore has to contain the command itself as well."
2861   (erc-log (format "cmd: DEFAULT: %s" line))
2862   (erc-server-send (substring line 1))
2863   t)
2864
2865 (defun erc-cmd-IGNORE (&optional user)
2866   "Ignore USER.  This should be a regexp matching nick!user@host.
2867 If no USER argument is specified, list the contents of `erc-ignore-list'."
2868   (if user
2869       (let ((quoted (regexp-quote user)))
2870         (when (and (not (string= user quoted))
2871                    (y-or-n-p (format "Use regexp-quoted form (%s) instead? "
2872                                      quoted)))
2873           (setq user quoted))
2874         (erc-display-line
2875          (erc-make-notice (format "Now ignoring %s" user))
2876          'active)
2877         (erc-with-server-buffer (add-to-list 'erc-ignore-list user)))
2878     (if (null (erc-with-server-buffer erc-ignore-list))
2879         (erc-display-line (erc-make-notice "Ignore list is empty") 'active)
2880       (erc-display-line (erc-make-notice "Ignore list:") 'active)
2881       (mapc #'(lambda (item)
2882                 (erc-display-line (erc-make-notice item)
2883                                   'active))
2884             (erc-with-server-buffer erc-ignore-list))))
2885   t)
2886
2887 (defun erc-cmd-UNIGNORE (user)
2888   "Remove the user specified in USER from the ignore list."
2889   (let ((ignored-nick (car (erc-with-server-buffer
2890                              (erc-member-ignore-case (regexp-quote user)
2891                                                      erc-ignore-list)))))
2892     (unless ignored-nick
2893       (if (setq ignored-nick (erc-ignored-user-p user))
2894           (unless (y-or-n-p (format "Remove this regexp (%s)? "
2895                                     ignored-nick))
2896             (setq ignored-nick nil))
2897         (erc-display-line
2898          (erc-make-notice (format "%s is not currently ignored!" user))
2899          'active)))
2900     (when ignored-nick
2901       (erc-display-line
2902        (erc-make-notice (format "No longer ignoring %s" user))
2903        'active)
2904       (erc-with-server-buffer
2905         (setq erc-ignore-list (delete ignored-nick erc-ignore-list)))))
2906   t)
2907
2908 (defun erc-cmd-CLEAR ()
2909   "Clear the window content."
2910   (recenter 0)
2911   t)
2912 (put 'erc-cmd-CLEAR 'process-not-needed t)
2913
2914 (defun erc-cmd-OPS ()
2915   "Show the ops in the current channel."
2916   (interactive)
2917   (let ((ops nil))
2918     (if erc-channel-users
2919         (maphash (lambda (_nick user-data)
2920                    (let ((cuser (cdr user-data)))
2921                      (if (and cuser
2922                               (erc-channel-user-op cuser))
2923                          (setq ops (cons (erc-server-user-nickname
2924                                           (car user-data))
2925                                          ops)))))
2926                  erc-channel-users))
2927     (setq ops (sort ops 'string-lessp))
2928     (if ops
2929         (erc-display-message
2930          nil 'notice (current-buffer) 'ops
2931          ?i (length ops) ?s (if (> (length ops) 1) "s" "")
2932          ?o (mapconcat 'identity ops " "))
2933       (erc-display-message nil 'notice (current-buffer) 'ops-none)))
2934   t)
2935
2936 (defun erc-cmd-COUNTRY (tld)
2937   "Display the country associated with the top level domain TLD."
2938   (require 'mail-extr)
2939   (let ((co (ignore-errors (what-domain tld))))
2940     (if co
2941         (erc-display-message
2942          nil 'notice 'active 'country ?c co ?d tld)
2943       (erc-display-message
2944        nil 'notice 'active 'country-unknown ?d tld))
2945     t))
2946 (put 'erc-cmd-COUNTRY 'process-not-needed t)
2947
2948 (defun erc-cmd-AWAY (line)
2949   "Mark the user as being away, the reason being indicated by LINE.
2950 If no reason is given, unset away status."
2951   (when (string-match "^\\s-*\\(.*\\)$" line)
2952     (let ((reason (match-string 1 line)))
2953       (erc-log (format "cmd: AWAY: %s" reason))
2954       (erc-server-send
2955        (if (string= reason "")
2956            "AWAY"
2957          (concat "AWAY :" reason))))
2958     t))
2959 (put 'erc-cmd-AWAY 'do-not-parse-args t)
2960
2961 (defun erc-cmd-GAWAY (line)
2962   "Mark the user as being away everywhere, the reason being indicated by LINE."
2963   ;; on all server buffers.
2964   (erc-with-all-buffers-of-server nil
2965     #'erc-open-server-buffer-p
2966     (erc-cmd-AWAY line)))
2967 (put 'erc-cmd-GAWAY 'do-not-parse-args t)
2968
2969 (defun erc-cmd-CTCP (nick cmd &rest args)
2970   "Send a Client To Client Protocol message to NICK.
2971
2972 CMD is the CTCP command, possible values being ECHO, FINGER, CLIENTINFO, TIME,
2973 VERSION and so on.  It is called with ARGS."
2974   (let ((str (concat cmd
2975                      (when args
2976                        (concat " " (mapconcat #'identity args " "))))))
2977     (erc-log (format "cmd: CTCP [%s]: [%s]" nick str))
2978     (erc-send-ctcp-message nick str)
2979     t))
2980
2981 (defun erc-cmd-HELP (&optional func)
2982   "Popup help information.
2983
2984 If FUNC contains a valid function or variable, help about that
2985 will be displayed.  If FUNC is empty, display an apropos about
2986 ERC commands.  Otherwise, do `apropos' in the ERC namespace
2987 \(\"erc-.*LINE\").
2988
2989 Examples:
2990 To find out about erc and bbdb, do
2991   /help bbdb.*
2992
2993 For help about the WHOIS command, do:
2994   /help whois
2995
2996 For a list of user commands (/join /part, ...):
2997   /help."
2998   (if func
2999       (let* ((sym (or (let ((sym (intern-soft
3000                                   (concat "erc-cmd-" (upcase func)))))
3001                         (if (and sym (or (boundp sym) (fboundp sym)))
3002                             sym
3003                           nil))
3004                       (let ((sym (intern-soft func)))
3005                         (if (and sym (or (boundp sym) (fboundp sym)))
3006                             sym
3007                           nil))
3008                       (let ((sym (intern-soft (concat "erc-" func))))
3009                         (if (and sym (or (boundp sym) (fboundp sym)))
3010                             sym
3011                           nil)))))
3012         (if sym
3013             (cond
3014              ((boundp sym) (describe-variable sym))
3015              ((fboundp sym) (describe-function sym))
3016              (t nil))
3017           (apropos-command (concat "erc-.*" func) nil
3018                            (lambda (x)
3019                              (or (commandp x)
3020                                  (get x 'custom-type))))
3021           t))
3022     (apropos "erc-cmd-")
3023     (message "Type C-h m to get additional information about keybindings.")
3024     t))
3025
3026 (defalias 'erc-cmd-H 'erc-cmd-HELP)
3027 (put 'erc-cmd-HELP 'process-not-needed t)
3028
3029 (defun erc-cmd-JOIN (channel &optional key)
3030   "Join the channel given in CHANNEL, optionally with KEY.
3031 If CHANNEL is specified as \"-invite\", join the channel to which you
3032 were most recently invited.  See also `invitation'."
3033   (let (chnl)
3034     (if (string= (upcase channel) "-INVITE")
3035         (if erc-invitation
3036             (setq chnl erc-invitation)
3037           (erc-display-message nil 'error (current-buffer) 'no-invitation))
3038       (setq chnl (erc-ensure-channel-name channel)))
3039     (when chnl
3040       ;; Prevent double joining of same channel on same server.
3041       (let ((joined-channels
3042              (mapcar #'(lambda (chanbuf)
3043                          (with-current-buffer chanbuf (erc-default-target)))
3044                      (erc-channel-list erc-server-process))))
3045         (if (erc-member-ignore-case chnl joined-channels)
3046             (switch-to-buffer (car (erc-member-ignore-case chnl
3047                                                            joined-channels)))
3048           (erc-log (format "cmd: JOIN: %s" chnl))
3049           (erc-server-send (if (and chnl key)
3050                                (format "JOIN %s %s" chnl key)
3051                              (format "JOIN %s" chnl)))))))
3052   t)
3053
3054 (defalias 'erc-cmd-CHANNEL 'erc-cmd-JOIN)
3055 (defalias 'erc-cmd-J 'erc-cmd-JOIN)
3056
3057 (defvar erc-channel-new-member-names nil
3058   "If non-nil, a names list is currently being received.
3059
3060 If non-nil, this variable is a hash-table that associates
3061 received nicks with t.")
3062 (make-variable-buffer-local 'erc-channel-new-member-names)
3063
3064 (defun erc-cmd-NAMES (&optional channel)
3065   "Display the users in CHANNEL.
3066 If CHANNEL is not specified, display the users in the current channel.
3067 This function clears the channel name list first, then sends the
3068 command."
3069   (let ((tgt (or (and (erc-channel-p channel) channel)
3070                  (erc-default-target))))
3071     (if (and tgt (erc-channel-p tgt))
3072         (progn
3073           (erc-log (format "cmd: DEFAULT: NAMES %s" tgt))
3074           (erc-with-buffer
3075               (tgt)
3076             (erc-channel-begin-receiving-names))
3077           (erc-server-send (concat "NAMES " tgt)))
3078       (erc-display-message nil 'error (current-buffer) 'no-default-channel)))
3079   t)
3080 (defalias 'erc-cmd-N 'erc-cmd-NAMES)
3081
3082 (defun erc-cmd-KICK (target &optional reason-or-nick &rest reasonwords)
3083   "Kick the user indicated in LINE from the current channel.
3084 LINE has the format: \"#CHANNEL NICK REASON\" or \"NICK REASON\"."
3085   (let ((reasonstring (mapconcat 'identity reasonwords " ")))
3086     (if (string= "" reasonstring)
3087         (setq reasonstring (format "Kicked by %s" (erc-current-nick))))
3088     (if (erc-channel-p target)
3089         (let ((nick reason-or-nick))
3090           (erc-log (format "cmd: KICK: %s/%s: %s" nick target reasonstring))
3091           (erc-server-send (format "KICK %s %s :%s" target nick reasonstring)
3092                            nil target)
3093           t)
3094       (when target
3095         (let ((ch (erc-default-target)))
3096           (setq reasonstring (concat
3097                               (if reason-or-nick (concat reason-or-nick " "))
3098                               reasonstring))
3099           (if ch
3100               (progn
3101                 (erc-log
3102                  (format "cmd: KICK: %s/%s: %s" target ch reasonstring))
3103                 (erc-server-send
3104                  (format "KICK %s %s :%s" ch target reasonstring) nil ch))
3105             (erc-display-message nil 'error (current-buffer)
3106                                  'no-default-channel))
3107           t)))))
3108
3109 (defvar erc-script-args nil)
3110
3111 (defun erc-cmd-LOAD (line)
3112   "Load the script provided in the LINE.
3113 If LINE continues beyond the file name, the rest of
3114 it is put in a (local) variable `erc-script-args',
3115 which can be used in Emacs Lisp scripts.
3116
3117 The optional FORCE argument is ignored here - you can't force loading
3118 a script after exceeding the flood threshold."
3119   (cond
3120    ((string-match "^\\s-*\\(\\S-+\\)\\(.*\\)$" line)
3121     (let* ((file-to-find (match-string 1 line))
3122            (erc-script-args (match-string 2 line))
3123            (file (erc-find-file file-to-find erc-script-path)))
3124       (erc-log (format "cmd: LOAD: %s" file-to-find))
3125       (cond
3126        ((not file)
3127         (erc-display-message nil 'error (current-buffer)
3128                              'cannot-find-file ?f file-to-find))
3129        ((not (file-readable-p file))
3130         (erc-display-message nil 'error (current-buffer)
3131                              'cannot-read-file ?f file))
3132        (t
3133         (message "Loading `%s'..." file)
3134         (erc-load-script file)
3135         (message "Loading `%s'...done" file))))
3136     t)
3137    (t nil)))
3138
3139 (defun erc-cmd-WHOIS (user &optional server)
3140   "Display whois information for USER.
3141
3142 If SERVER is non-nil, use that, rather than the current server."
3143   ;; FIXME: is the above docstring correct?  -- Lawrence 2004-01-08
3144   (let ((send (if server
3145                   (format "WHOIS %s %s" user server)
3146                 (format "WHOIS %s" user))))
3147     (erc-log (format "cmd: %s" send))
3148     (erc-server-send send)
3149     t))
3150 (defalias 'erc-cmd-WI 'erc-cmd-WHOIS)
3151
3152 (defun erc-cmd-WHOAMI ()
3153   "Display whois information about yourself."
3154   (erc-cmd-WHOIS (erc-current-nick))
3155   t)
3156
3157 (defun erc-cmd-IDLE (nick)
3158   "Show the length of time NICK has been idle."
3159   (let ((origbuf (current-buffer))
3160         symlist)
3161     (erc-with-server-buffer
3162       (push (cons (erc-once-with-server-event
3163                    311 (lambda (_proc parsed)
3164                          (string= nick
3165                                   (nth 1 (erc-response.command-args
3166                                           parsed)))))
3167                   'erc-server-311-functions)
3168             symlist)
3169       (push (cons (erc-once-with-server-event
3170                    312 (lambda (_proc parsed)
3171                          (string= nick
3172                                   (nth 1 (erc-response.command-args
3173                                           parsed)))))
3174                   'erc-server-312-functions)
3175             symlist)
3176       (push (cons (erc-once-with-server-event
3177                    318 (lambda (_proc parsed)
3178                          (string= nick
3179                                   (nth 1 (erc-response.command-args
3180                                           parsed)))))
3181                   'erc-server-318-functions)
3182             symlist)
3183       (push (cons (erc-once-with-server-event
3184                    319 (lambda (_proc parsed)
3185                          (string= nick
3186                                   (nth 1 (erc-response.command-args
3187                                           parsed)))))
3188                   'erc-server-319-functions)
3189             symlist)
3190       (push (cons (erc-once-with-server-event
3191                    320 (lambda (_proc parsed)
3192                          (string= nick
3193                                   (nth 1 (erc-response.command-args
3194                                           parsed)))))
3195                   'erc-server-320-functions)
3196             symlist)
3197       (push (cons (erc-once-with-server-event
3198                    330 (lambda (_proc parsed)
3199                          (string= nick
3200                                   (nth 1 (erc-response.command-args
3201                                           parsed)))))
3202                   'erc-server-330-functions)
3203             symlist)
3204       (push (cons (erc-once-with-server-event
3205                    317
3206                    (lambda (_proc parsed)
3207                      (let ((idleseconds
3208                             (string-to-number
3209                              (cl-third
3210                               (erc-response.command-args parsed)))))
3211                        (erc-display-line
3212                         (erc-make-notice
3213                          (format "%s has been idle for %s."
3214                                  (erc-string-no-properties nick)
3215                                  (erc-seconds-to-string idleseconds)))
3216                         origbuf)
3217                        t)))
3218                   'erc-server-317-functions)
3219             symlist)
3220
3221       ;; Send the WHOIS command.
3222       (erc-cmd-WHOIS nick)
3223
3224       ;; Remove the uninterned symbols from the server hooks that did not run.
3225       (run-at-time 20 nil (lambda (buf symlist)
3226                             (with-current-buffer buf
3227                               (dolist (sym symlist)
3228                                 (let ((hooksym (cdr sym))
3229                                       (funcsym (car sym)))
3230                                   (remove-hook hooksym funcsym t)))))
3231                    (current-buffer) symlist)))
3232   t)
3233
3234 (defun erc-cmd-DESCRIBE (line)
3235   "Pose some action to a certain user.
3236 LINE has the format \"USER ACTION\"."
3237   (cond
3238    ((string-match
3239      "^\\s-*\\(\\S-+\\)\\s-\\(.*\\)$" line)
3240     (let ((dst (match-string 1 line))
3241           (s (match-string 2 line)))
3242       (erc-log (format "cmd: DESCRIBE: [%s] %s" dst s))
3243       (erc-send-action dst s))
3244     t)
3245    (t nil)))
3246 (put 'erc-cmd-DESCRIBE 'do-not-parse-args t)
3247
3248 (defun erc-cmd-ME (line)
3249   "Send LINE as an action."
3250   (cond
3251    ((string-match "^\\s-\\(.*\\)$" line)
3252     (let ((s (match-string 1 line)))
3253       (erc-log (format "cmd: ME: %s" s))
3254       (erc-send-action (erc-default-target) s))
3255     t)
3256    (t nil)))
3257 (put 'erc-cmd-ME 'do-not-parse-args t)
3258
3259 (defun erc-cmd-ME\'S (line)
3260   "Do a /ME command, but add the string \" \\='s\" to the beginning."
3261   (erc-cmd-ME (concat " 's" line)))
3262 (put 'erc-cmd-ME\'S 'do-not-parse-args t)
3263
3264 (defun erc-cmd-LASTLOG (line)
3265   "Show all lines in the current buffer matching the regexp LINE.
3266
3267 If a match spreads across multiple lines, all those lines are shown.
3268
3269 The lines are shown in a buffer named `*Occur*'.
3270 It serves as a menu to find any of the occurrences in this buffer.
3271 \\[describe-mode] in that buffer will explain how.
3272
3273 If LINE contains upper case characters (excluding those preceded by `\\'),
3274 the matching is case-sensitive."
3275   (occur line)
3276   t)
3277 (put 'erc-cmd-LASTLOG 'do-not-parse-args t)
3278 (put 'erc-cmd-LASTLOG 'process-not-needed t)
3279
3280 (defun erc-send-message (line &optional force)
3281   "Send LINE to the current channel or user and display it.
3282
3283 See also `erc-message' and `erc-display-line'."
3284   (erc-message "PRIVMSG" (concat (erc-default-target) " " line) force)
3285   (erc-display-line
3286    (concat (erc-format-my-nick) line)
3287    (current-buffer))
3288   ;; FIXME - treat multiline, run hooks, or remove me?
3289   t)
3290
3291 (defun erc-cmd-MODE (line)
3292   "Change or display the mode value of a channel or user.
3293 The first word specifies the target.  The rest is the mode string
3294 to send.
3295
3296 If only one word is given, display the mode of that target.
3297
3298 A list of valid mode strings for Freenode may be found at
3299 URL `http://freenode.net/using_the_network.shtml'."
3300   (cond
3301    ((string-match "^\\s-\\(.*\\)$" line)
3302     (let ((s (match-string 1 line)))
3303       (erc-log (format "cmd: MODE: %s" s))
3304       (erc-server-send (concat "MODE " line)))
3305     t)
3306    (t nil)))
3307 (put 'erc-cmd-MODE 'do-not-parse-args t)
3308
3309 (defun erc-cmd-NOTICE (channel-or-user &rest message)
3310   "Send a notice to the channel or user given as the first word.
3311 The rest is the message to send."
3312   (erc-message "NOTICE" (concat channel-or-user " "
3313                                 (mapconcat #'identity message " "))))
3314
3315 (defun erc-cmd-MSG (line)
3316   "Send a message to the channel or user given as the first word in LINE.
3317
3318 The rest of LINE is the message to send."
3319   (erc-message "PRIVMSG" line))
3320
3321 (defalias 'erc-cmd-M 'erc-cmd-MSG)
3322 (put 'erc-cmd-MSG 'do-not-parse-args t)
3323
3324 (defun erc-cmd-SQUERY (line)
3325   "Send a Service Query to the service given as the first word in LINE.
3326
3327 The rest of LINE is the message to send."
3328   (erc-message "SQUERY" line))
3329
3330 (defun erc-cmd-NICK (nick)
3331   "Change current nickname to NICK."
3332   (erc-log (format "cmd: NICK: %s (erc-bad-nick: %S)" nick erc-bad-nick))
3333   (let ((nicklen (cdr (assoc "NICKLEN" (erc-with-server-buffer
3334                                          erc-server-parameters)))))
3335     (and nicklen (> (length nick) (string-to-number nicklen))
3336          (erc-display-message
3337           nil 'notice 'active 'nick-too-long
3338           ?i (length nick) ?l nicklen)))
3339   (erc-server-send (format "NICK %s" nick))
3340   (cond (erc-bad-nick
3341          (erc-set-current-nick nick)
3342          (erc-update-mode-line)
3343          (setq erc-bad-nick nil)))
3344   t)
3345
3346 (defun erc-cmd-PART (line)
3347   "When LINE is an empty string, leave the current channel.
3348 Otherwise leave the channel indicated by LINE."
3349   (cond
3350    ((string-match "^\\s-*\\([&#+!]\\S-+\\)\\s-?\\(.*\\)$" line)
3351     (let* ((ch (match-string 1 line))
3352            (msg (match-string 2 line))
3353            (reason (funcall erc-part-reason (if (equal msg "") nil msg))))
3354       (erc-log (format "cmd: PART: %s: %s" ch reason))
3355       (erc-server-send (if (string= reason "")
3356                            (format "PART %s" ch)
3357                          (format "PART %s :%s" ch reason))
3358                        nil ch))
3359     t)
3360    ((string-match "^\\s-*\\(.*\\)$" line)
3361     (let* ((ch (erc-default-target))
3362            (msg (match-string 1 line))
3363            (reason (funcall erc-part-reason (if (equal msg "") nil msg))))
3364       (if (and ch (erc-channel-p ch))
3365           (progn
3366             (erc-log (format "cmd: PART: %s: %s" ch reason))
3367             (erc-server-send (if (string= reason "")
3368                                  (format "PART %s" ch)
3369                                (format "PART %s :%s" ch reason))
3370                              nil ch))
3371         (erc-display-message nil 'error (current-buffer) 'no-target)))
3372     t)
3373    (t nil)))
3374 (put 'erc-cmd-PART 'do-not-parse-args t)
3375
3376 (defalias 'erc-cmd-LEAVE 'erc-cmd-PART)
3377
3378 (defun erc-cmd-PING (recipient)
3379   "Ping RECIPIENT."
3380   (let ((time (format "%f" (erc-current-time))))
3381     (erc-log (format "cmd: PING: %s" time))
3382     (erc-cmd-CTCP recipient "PING" time)))
3383
3384 (defun erc-cmd-QUOTE (line)
3385   "Send LINE directly to the server.
3386 All the text given as argument is sent to the sever as unmodified,
3387 just as you provided it.  Use this command with care!"
3388   (cond
3389    ((string-match "^ ?\\(.+\\)$" line)
3390     (erc-server-send (match-string 1 line)))
3391    (t nil)))
3392 (put 'erc-cmd-QUOTE 'do-not-parse-args t)
3393
3394 (defcustom erc-query-display 'window
3395   "Indicates how to display query buffers when using the /QUERY
3396 command to talk to someone.
3397
3398 The default behavior is to display the message in a new window
3399 and bring it to the front.  See the documentation for
3400 `erc-join-buffer' for a description of the available choices.
3401
3402 See also `erc-auto-query' to decide how private messages from
3403 other people should be displayed."
3404   :group 'erc-query
3405   :type '(choice (const :tag "Split window and select" window)
3406                  (const :tag "Split window, don't select" window-noselect)
3407                  (const :tag "New frame" frame)
3408                  (const :tag "Bury in new buffer" bury)
3409                  (const :tag "Use current buffer" buffer)
3410                  (const :tag "Use current buffer" t)))
3411
3412 (defun erc-cmd-QUERY (&optional user)
3413   "Open a query with USER.
3414 The type of query window/frame/etc will depend on the value of
3415 `erc-query-display'.
3416
3417 If USER is omitted, close the current query buffer if one exists
3418 - except this is broken now ;-)"
3419   (interactive
3420    (list (read-from-minibuffer "Start a query with: " nil)))
3421   (let ((session-buffer (erc-server-buffer))
3422         (erc-join-buffer erc-query-display))
3423     (if user
3424         (erc-query user session-buffer)
3425       ;; currently broken, evil hack to display help anyway
3426                                         ;(erc-delete-query))))
3427       (signal 'wrong-number-of-arguments ""))))
3428 (defalias 'erc-cmd-Q 'erc-cmd-QUERY)
3429
3430 (defun erc-quit/part-reason-default ()
3431   "Default quit/part message."
3432   (format "\C-bERC\C-b (IRC client for Emacs %s)" emacs-version))
3433
3434
3435 (defun erc-quit-reason-normal (&optional s)
3436   "Normal quit message.
3437
3438 If S is non-nil, it will be used as the quit reason."
3439   (or s (erc-quit/part-reason-default)))
3440
3441 (defun erc-quit-reason-zippy (&optional s)
3442   "Zippy quit message.
3443
3444 If S is non-nil, it will be used as the quit reason."
3445   (or s
3446       (if (fboundp 'yow)
3447           (erc-replace-regexp-in-string "\n" "" (yow))
3448         (erc-quit/part-reason-default))))
3449
3450 (make-obsolete 'erc-quit-reason-zippy "it will be removed." "24.4")
3451
3452 (defun erc-quit-reason-various (s)
3453   "Choose a quit reason based on S (a string)."
3454   (when (featurep 'xemacs) (require 'poe))
3455   (let ((res (car (assoc-default (or s "")
3456                                  erc-quit-reason-various-alist 'string-match))))
3457     (cond
3458      ((functionp res) (funcall res))
3459      ((stringp res) res)
3460      (s s)
3461      (t (erc-quit/part-reason-default)))))
3462
3463 (defun erc-part-reason-normal (&optional s)
3464   "Normal part message.
3465
3466 If S is non-nil, it will be used as the part reason."
3467   (or s (erc-quit/part-reason-default)))
3468
3469 (defun erc-part-reason-zippy (&optional s)
3470   "Zippy part message.
3471
3472 If S is non-nil, it will be used as the quit reason."
3473   (or s
3474       (if (fboundp 'yow)
3475           (erc-replace-regexp-in-string "\n" "" (yow))
3476         (erc-quit/part-reason-default))))
3477
3478 (make-obsolete 'erc-part-reason-zippy "it will be removed." "24.4")
3479
3480 (defun erc-part-reason-various (s)
3481   "Choose a part reason based on S (a string)."
3482   (when (featurep 'xemacs) (require 'poe))
3483   (let ((res (car (assoc-default (or s "")
3484                                  erc-part-reason-various-alist 'string-match))))
3485     (cond
3486      ((functionp res) (funcall res))
3487      ((stringp res) res)
3488      (s s)
3489      (t (erc-quit/part-reason-default)))))
3490
3491 (defun erc-cmd-QUIT (reason)
3492   "Disconnect from the current server.
3493 If REASON is omitted, display a default quit message, otherwise display
3494 the message given by REASON."
3495   (unless reason
3496     (setq reason ""))
3497   (cond
3498    ((string-match "^\\s-*\\(.*\\)$" reason)
3499     (let* ((s (match-string 1 reason))
3500            (buffer (erc-server-buffer))
3501            (reason (funcall erc-quit-reason (if (equal s "") nil s)))
3502            server-proc)
3503       (with-current-buffer (if (and buffer
3504                                     (bufferp buffer))
3505                                buffer
3506                              (current-buffer))
3507         (erc-log (format "cmd: QUIT: %s" reason))
3508         (setq erc-server-quitting t)
3509         (erc-set-active-buffer (erc-server-buffer))
3510         (setq server-proc erc-server-process)
3511         (erc-server-send (format "QUIT :%s" reason)))
3512       (run-hook-with-args 'erc-quit-hook server-proc)
3513       (when erc-kill-queries-on-quit
3514         (erc-kill-query-buffers server-proc))
3515       ;; if the process has not been killed within 4 seconds, kill it
3516       (run-at-time 4 nil
3517                    (lambda (proc)
3518                      (when (and (processp proc)
3519                                 (memq (process-status proc) '(run open)))
3520                        (delete-process proc)))
3521                    server-proc))
3522     t)
3523    (t nil)))
3524
3525 (defalias 'erc-cmd-BYE 'erc-cmd-QUIT)
3526 (defalias 'erc-cmd-EXIT 'erc-cmd-QUIT)
3527 (defalias 'erc-cmd-SIGNOFF 'erc-cmd-QUIT)
3528 (put 'erc-cmd-QUIT 'do-not-parse-args t)
3529 (put 'erc-cmd-QUIT 'process-not-needed t)
3530
3531 (defun erc-cmd-GQUIT (reason)
3532   "Disconnect from all servers at once with the same quit REASON."
3533   (erc-with-all-buffers-of-server nil #'erc-open-server-buffer-p
3534                                   (erc-cmd-QUIT reason))
3535   (when erc-kill-queries-on-quit
3536     ;; if the query buffers have not been killed within 4 seconds,
3537     ;; kill them
3538     (run-at-time
3539      4 nil
3540      (lambda ()
3541        (dolist (buffer (erc-buffer-list (lambda (buf)
3542                                           (not (erc-server-buffer-p buf)))))
3543          (kill-buffer buffer)))))
3544   t)
3545
3546 (defalias 'erc-cmd-GQ 'erc-cmd-GQUIT)
3547 (put 'erc-cmd-GQUIT 'do-not-parse-args t)
3548 (put 'erc-cmd-GQUIT 'process-not-needed t)
3549
3550 (defun erc-cmd-RECONNECT ()
3551   "Try to reconnect to the current IRC server."
3552   (let ((buffer (erc-server-buffer))
3553         (process nil))
3554     (unless (buffer-live-p buffer)
3555       (setq buffer (current-buffer)))
3556     (with-current-buffer buffer
3557       (setq erc-server-quitting nil)
3558       (setq erc-server-reconnecting t)
3559       (setq erc-server-reconnect-count 0)
3560       (setq process (get-buffer-process (erc-server-buffer)))
3561       (if process
3562           (delete-process process)
3563         (erc-server-reconnect))
3564       (setq erc-server-reconnecting nil)))
3565   t)
3566 (put 'erc-cmd-RECONNECT 'process-not-needed t)
3567
3568 (defun erc-cmd-SERVER (server)
3569   "Connect to SERVER, leaving existing connection intact."
3570   (erc-log (format "cmd: SERVER: %s" server))
3571   (condition-case nil
3572       (erc :server server :nick (erc-current-nick))
3573     (error
3574      (erc-error "Cannot find host %s." server)))
3575   t)
3576 (put 'erc-cmd-SERVER 'process-not-needed t)
3577
3578 (defvar motif-version-string)
3579 (defvar gtk-version-string)
3580
3581 (defun erc-cmd-SV ()
3582   "Say the current ERC and Emacs version into channel."
3583   (erc-send-message (format "I'm using ERC with %s %s (%s%s) of %s."
3584                             (if (featurep 'xemacs) "XEmacs" "GNU Emacs")
3585                             emacs-version
3586                             system-configuration
3587                             (concat
3588                              (cond ((featurep 'motif)
3589                                     (concat ", " (substring
3590                                                   motif-version-string 4)))
3591                                    ((featurep 'gtk)
3592                                     (concat ", GTK+ Version "
3593                                             gtk-version-string))
3594                                    ((featurep 'x-toolkit) ", X toolkit")
3595                                    (t ""))
3596                              (if (and (boundp 'x-toolkit-scroll-bars)
3597                                       (memq x-toolkit-scroll-bars
3598                                             '(xaw xaw3d)))
3599                                  (format ", %s scroll bars"
3600                                          (capitalize (symbol-name
3601                                                       x-toolkit-scroll-bars)))
3602                                "")
3603                              (if (featurep 'multi-tty) ", multi-tty" ""))
3604                             erc-emacs-build-time))
3605   t)
3606
3607 (defun erc-cmd-SM ()
3608   "Say the current ERC modes into channel."
3609   (erc-send-message (format "I'm using the following modules: %s!"
3610                             (erc-modes)))
3611   t)
3612
3613 (defun erc-cmd-DEOP (&rest people)
3614   "Remove the operator setting from user(s) given in PEOPLE."
3615   (when (> (length people) 0)
3616     (erc-server-send (concat "MODE " (erc-default-target)
3617                              " -"
3618                              (make-string (length people) ?o)
3619                              " "
3620                              (mapconcat 'identity people " ")))
3621     t))
3622
3623 (defun erc-cmd-OP (&rest people)
3624   "Add the operator setting to users(s) given in PEOPLE."
3625   (when (> (length people) 0)
3626     (erc-server-send (concat "MODE " (erc-default-target)
3627                              " +"
3628                              (make-string (length people) ?o)
3629                              " "
3630                              (mapconcat 'identity people " ")))
3631     t))
3632
3633 (defun erc-cmd-TIME (&optional line)
3634   "Request the current time and date from the current server."
3635   (cond
3636    ((and line (string-match "^\\s-*\\(.*\\)$" line))
3637     (let ((args (match-string 1 line)))
3638       (erc-log (format "cmd: TIME: %s" args))
3639       (erc-server-send (concat "TIME " args)))
3640     t)
3641    (t (erc-server-send "TIME"))))
3642 (defalias 'erc-cmd-DATE 'erc-cmd-TIME)
3643
3644 (defun erc-cmd-TOPIC (topic)
3645   "Set or request the topic for a channel.
3646 LINE has the format: \"#CHANNEL TOPIC\", \"#CHANNEL\", \"TOPIC\"
3647 or the empty string.
3648
3649 If no #CHANNEL is given, the default channel is used.  If TOPIC is
3650 given, the channel topic is modified, otherwise the current topic will
3651 be displayed."
3652   (cond
3653    ;; /topic #channel TOPIC
3654    ((string-match "^\\s-*\\([&#+!]\\S-+\\)\\s-\\(.*\\)$" topic)
3655     (let ((ch (match-string 1 topic))
3656           (topic (match-string 2 topic)))
3657       (erc-log (format "cmd: TOPIC [%s]: %s" ch topic))
3658       (erc-server-send (format "TOPIC %s :%s" ch topic) nil ch))
3659     t)
3660    ;; /topic #channel
3661    ((string-match "^\\s-*\\([&#+!]\\S-+\\)" topic)
3662     (let ((ch (match-string 1 topic)))
3663       (erc-server-send (format "TOPIC %s" ch) nil ch)
3664       t))
3665    ;; /topic
3666    ((string-match "^\\s-*$" topic)
3667     (let ((ch (erc-default-target)))
3668       (erc-server-send (format "TOPIC %s" ch) nil ch)
3669       t))
3670    ;; /topic TOPIC
3671    ((string-match "^\\s-*\\(.*\\)$" topic)
3672     (let ((ch (erc-default-target))
3673           (topic (match-string 1 topic)))
3674       (if (and ch (erc-channel-p ch))
3675           (progn
3676             (erc-log (format "cmd: TOPIC [%s]: %s" ch topic))
3677             (erc-server-send (format "TOPIC %s :%s" ch topic) nil ch))
3678         (erc-display-message nil 'error (current-buffer) 'no-target)))
3679     t)
3680    (t nil)))
3681 (defalias 'erc-cmd-T 'erc-cmd-TOPIC)
3682 (put 'erc-cmd-TOPIC 'do-not-parse-args t)
3683
3684 (defun erc-cmd-APPENDTOPIC (topic)
3685   "Append TOPIC to the current channel topic, separated by a space."
3686   (let ((oldtopic erc-channel-topic))
3687     ;; display help when given no arguments
3688     (when (string-match "^\\s-*$" topic)
3689       (signal 'wrong-number-of-arguments nil))
3690     ;; strip trailing ^O
3691     (when (string-match "\\(.*\\)\C-o" oldtopic)
3692       (erc-cmd-TOPIC (concat (match-string 1 oldtopic) topic)))))
3693 (defalias 'erc-cmd-AT 'erc-cmd-APPENDTOPIC)
3694 (put 'erc-cmd-APPENDTOPIC 'do-not-parse-args t)
3695
3696 (defun erc-cmd-CLEARTOPIC (&optional channel)
3697   "Clear the topic for a CHANNEL.
3698 If CHANNEL is not specified, clear the topic for the default channel."
3699   (interactive "sClear topic of channel (RET is current channel): ")
3700   (let ((chnl (or (and (erc-channel-p channel) channel) (erc-default-target))))
3701     (when chnl
3702       (erc-server-send (format "TOPIC %s :" chnl))
3703       t)))
3704
3705 ;;; Banlists
3706
3707 (defvar erc-channel-banlist nil
3708   "A list of bans seen for the current channel.
3709
3710 Each ban is an alist of the form:
3711   (WHOSET . MASK)
3712
3713 The property `received-from-server' indicates whether
3714 or not the ban list has been requested from the server.")
3715 (make-variable-buffer-local 'erc-channel-banlist)
3716 (put 'erc-channel-banlist 'received-from-server nil)
3717
3718 (defun erc-cmd-BANLIST ()
3719   "Pretty-print the contents of `erc-channel-banlist'.
3720
3721 The ban list is fetched from the server if necessary."
3722   (let ((chnl (erc-default-target))
3723         (chnl-name (buffer-name)))
3724
3725     (cond
3726      ((not (erc-channel-p chnl))
3727       (erc-display-line (erc-make-notice "You're not on a channel\n")
3728                         'active))
3729
3730      ((not (get 'erc-channel-banlist 'received-from-server))
3731       (let ((old-367-hook erc-server-367-functions))
3732         (setq erc-server-367-functions 'erc-banlist-store
3733               erc-channel-banlist nil)
3734         ;; fetch the ban list then callback
3735         (erc-with-server-buffer
3736           (erc-once-with-server-event
3737            368
3738            (lambda (_proc _parsed)
3739              (with-current-buffer chnl-name
3740                (put 'erc-channel-banlist 'received-from-server t)
3741                (setq erc-server-367-functions old-367-hook)
3742                (erc-cmd-BANLIST)
3743                t)))
3744           (erc-server-send (format "MODE %s b" chnl)))))
3745
3746      ((null erc-channel-banlist)
3747       (erc-display-line (erc-make-notice
3748                          (format "No bans for channel: %s\n" chnl))
3749                         'active)
3750       (put 'erc-channel-banlist 'received-from-server nil))
3751
3752      (t
3753       (let* ((erc-fill-column (or (and (boundp 'erc-fill-column)
3754                                        erc-fill-column)
3755                                   (and (boundp 'fill-column)
3756                                        fill-column)
3757                                   (1- (window-width))))
3758              (separator (make-string erc-fill-column ?=))
3759              (fmt (concat
3760                    "%-" (number-to-string (/ erc-fill-column 2)) "s"
3761                    "%" (number-to-string (/ erc-fill-column 2)) "s")))
3762
3763         (erc-display-line
3764          (erc-make-notice (format "Ban list for channel: %s\n"
3765                                   (erc-default-target)))
3766          'active)
3767
3768         (erc-display-line separator 'active)
3769         (erc-display-line (format fmt "Ban Mask" "Banned By") 'active)
3770         (erc-display-line separator 'active)
3771
3772         (mapc
3773          (lambda (x)
3774            (erc-display-line
3775             (format fmt
3776                     (truncate-string-to-width (cdr x) (/ erc-fill-column 2))
3777                     (if (car x)
3778                         (truncate-string-to-width (car x) (/ erc-fill-column 2))
3779                       ""))
3780             'active))
3781          erc-channel-banlist)
3782
3783         (erc-display-line (erc-make-notice "End of Ban list")
3784                           'active)
3785         (put 'erc-channel-banlist 'received-from-server nil)))))
3786   t)
3787
3788 (defalias 'erc-cmd-BL 'erc-cmd-BANLIST)
3789
3790 (defun erc-cmd-MASSUNBAN ()
3791   "Mass Unban.
3792
3793 Unban all currently banned users in the current channel."
3794   (let ((chnl (erc-default-target)))
3795     (cond
3796
3797      ((not (erc-channel-p chnl))
3798       (erc-display-line
3799        (erc-make-notice "You're not on a channel\n")
3800        'active))
3801
3802      ((not (get 'erc-channel-banlist 'received-from-server))
3803       (let ((old-367-hook erc-server-367-functions))
3804         (setq erc-server-367-functions 'erc-banlist-store)
3805         ;; fetch the ban list then callback
3806         (erc-with-server-buffer
3807           (erc-once-with-server-event
3808            368
3809            (lambda (_proc _parsed)
3810              (with-current-buffer chnl
3811                (put 'erc-channel-banlist 'received-from-server t)
3812                (setq erc-server-367-functions old-367-hook)
3813                (erc-cmd-MASSUNBAN)
3814                t)))
3815           (erc-server-send (format "MODE %s b" chnl)))))
3816
3817      (t (let ((bans (mapcar #'cdr erc-channel-banlist)))
3818           (when bans
3819             ;; Glob the bans into groups of three, and carry out the unban.
3820             ;; eg. /mode #foo -bbb a*!*@* b*!*@* c*!*@*
3821             (mapc
3822              (lambda (x)
3823                (erc-server-send
3824                 (format "MODE %s -%s %s" (erc-default-target)
3825                         (make-string (length x) ?b)
3826                         (mapconcat 'identity x " "))))
3827              (erc-group-list bans 3))))
3828         t))))
3829
3830 (defalias 'erc-cmd-MUB 'erc-cmd-MASSUNBAN)
3831
3832 ;;;; End of IRC commands
3833
3834 (defun erc-ensure-channel-name (channel)
3835   "Return CHANNEL if it is a valid channel name.
3836 Eventually add a # in front of it, if that turns it into a valid channel name."
3837   (if (erc-channel-p channel)
3838       channel
3839     (concat "#" channel)))
3840
3841 (defun erc-grab-region (start end)
3842   "Copy the region between START and END in a recreatable format.
3843
3844 Converts all the IRC text properties in each line of the region
3845 into control codes and writes them to a separate buffer.  The
3846 resulting text may be used directly as a script to generate this
3847 text again."
3848   (interactive "r")
3849   (erc-set-active-buffer (current-buffer))
3850   (save-excursion
3851     (let* ((cb (current-buffer))
3852            (buf (generate-new-buffer erc-grab-buffer-name))
3853            (region (buffer-substring start end))
3854            (lines (erc-split-multiline-safe region)))
3855       (set-buffer buf)
3856       (dolist (line lines)
3857         (insert (concat line "\n")))
3858       (set-buffer cb)
3859       (switch-to-buffer-other-window buf)))
3860   (message "erc-grab-region doesn't grab colors etc. anymore. If you use this, please tell the maintainers.")
3861   (ding))
3862
3863 (defun erc-display-prompt (&optional buffer pos prompt face)
3864   "Display PROMPT in BUFFER at position POS.
3865 Display an ERC prompt in BUFFER.
3866
3867 If PROMPT is nil, one is constructed with the function `erc-prompt'.
3868 If BUFFER is nil, the `current-buffer' is used.
3869 If POS is nil, PROMPT will be displayed at `point'.
3870 If FACE is non-nil, it will be used to propertize the prompt.  If it is nil,
3871 `erc-prompt-face' will be used."
3872   (let* ((prompt (or prompt (erc-prompt)))
3873          (l (length prompt))
3874          (ob (current-buffer)))
3875     ;; We cannot use save-excursion because we move point, therefore
3876     ;; we resort to the ol' ob trick to restore this.
3877     (when (and buffer (bufferp buffer))
3878       (set-buffer buffer))
3879
3880     ;; now save excursion again to store where point and mark are
3881     ;; in the current buffer
3882     (save-excursion
3883       (setq pos (or pos (point)))
3884       (goto-char pos)
3885       (when (> l 0)
3886         ;; Do not extend the text properties when typing at the end
3887         ;; of the prompt, but stuff typed in front of the prompt
3888         ;; shall remain part of the prompt.
3889         (setq prompt (erc-propertize prompt
3890                                      'start-open t ; XEmacs
3891                                      'rear-nonsticky t ; Emacs
3892                                      'erc-prompt t
3893                                      'field t
3894                                      'front-sticky t
3895                                      'read-only t))
3896         (erc-put-text-property 0 (1- (length prompt))
3897                                'face (or face 'erc-prompt-face)
3898                                prompt)
3899         (insert prompt))
3900       ;; Set the input marker
3901       (set-marker erc-input-marker (point)))
3902
3903     ;; Now we are back at the old position.  If the prompt was
3904     ;; inserted here or before us, advance point by the length of
3905     ;; the prompt.
3906     (when (or (not pos) (<= (point) pos))
3907       (forward-char l))
3908     ;; Clear the undo buffer now, so the user can undo his stuff,
3909     ;; but not the stuff we did. Sneaky!
3910     (setq buffer-undo-list nil)
3911     (set-buffer ob)))
3912
3913 ;; interactive operations
3914
3915 (defun erc-input-message ()
3916   "Read input from the minibuffer."
3917   (interactive)
3918   (let ((minibuffer-allow-text-properties t)
3919         (read-map minibuffer-local-map))
3920     (insert (read-from-minibuffer "Message: "
3921                                   (string (if (featurep 'xemacs)
3922                                               last-command-char
3923                                             last-command-event))
3924                                   read-map))
3925     (erc-send-current-line)))
3926
3927 (defvar erc-action-history-list ()
3928   "History list for interactive action input.")
3929
3930 (defun erc-input-action ()
3931   "Interactively input a user action and send it to IRC."
3932   (interactive "")
3933   (erc-set-active-buffer (current-buffer))
3934   (let ((action (read-from-minibuffer
3935                  "Action: " nil nil nil 'erc-action-history-list)))
3936     (if (not (string-match "^\\s-*$" action))
3937         (erc-send-action (erc-default-target) action))))
3938
3939 (defun erc-join-channel (channel &optional key)
3940   "Join CHANNEL.
3941
3942 If `point' is at the beginning of a channel name, use that as default."
3943   (interactive
3944    (list
3945     (let ((chnl (if (looking-at "\\([&#+!][^ \n]+\\)") (match-string 1) ""))
3946           (table (when (erc-server-buffer-live-p)
3947                    (set-buffer (process-buffer erc-server-process))
3948                    erc-channel-list)))
3949       (completing-read "Join channel: " table nil nil nil nil chnl))
3950     (when (or current-prefix-arg erc-prompt-for-channel-key)
3951       (read-from-minibuffer "Channel key (RET for none): " nil))))
3952   (erc-cmd-JOIN channel (when (>= (length key) 1) key)))
3953
3954 (defun erc-part-from-channel (reason)
3955   "Part from the current channel and prompt for a REASON."
3956   (interactive
3957    (list
3958     (if (and (boundp 'reason) (stringp reason) (not (string= reason "")))
3959         reason
3960       (read-from-minibuffer (concat "Reason for leaving " (erc-default-target)
3961                                     ": ")))))
3962   (erc-cmd-PART (concat (erc-default-target)" " reason)))
3963
3964 (defun erc-set-topic (topic)
3965   "Prompt for a TOPIC for the current channel."
3966   (interactive
3967    (list
3968     (read-from-minibuffer
3969      (concat "Set topic of " (erc-default-target) ": ")
3970      (when erc-channel-topic
3971        (let ((ss (split-string erc-channel-topic "\C-o")))
3972          (cons (apply #'concat (if (cdr ss) (butlast ss) ss))
3973                0))))))
3974   (let ((topic-list (split-string topic "\C-o"))) ; strip off the topic setter
3975     (erc-cmd-TOPIC (concat (erc-default-target) " " (car topic-list)))))
3976
3977 (defun erc-set-channel-limit (&optional limit)
3978   "Set a LIMIT for the current channel.  Remove limit if nil.
3979 Prompt for one if called interactively."
3980   (interactive (list (read-from-minibuffer
3981                       (format "Limit for %s (RET to remove limit): "
3982                               (erc-default-target)))))
3983   (let ((tgt (erc-default-target)))
3984     (erc-server-send (if (and limit (>= (length limit) 1))
3985                          (format "MODE %s +l %s" tgt limit)
3986                        (format "MODE %s -l" tgt)))))
3987
3988 (defun erc-set-channel-key (&optional key)
3989   "Set a KEY for the current channel.  Remove key if nil.
3990 Prompt for one if called interactively."
3991   (interactive (list (read-from-minibuffer
3992                       (format "Key for %s (RET to remove key): "
3993                               (erc-default-target)))))
3994   (let ((tgt (erc-default-target)))
3995     (erc-server-send (if (and key (>= (length key) 1))
3996                          (format "MODE %s +k %s" tgt key)
3997                        (format "MODE %s -k" tgt)))))
3998
3999 (defun erc-completion-at-point ()
4000   "Perform complection on the text around point case-insentitively.
4001 See `completion-at-point'."
4002   (interactive)
4003   (let ((completion-ignore-case t))
4004     (completion-at-point)))
4005
4006 (defun erc-quit-server (reason)
4007   "Disconnect from current server after prompting for REASON.
4008 `erc-quit-reason' works with this just like with `erc-cmd-QUIT'."
4009   (interactive (list (read-from-minibuffer
4010                       (format "Reason for quitting %s: "
4011                               (or erc-server-announced-name
4012                                   erc-session-server)))))
4013   (erc-cmd-QUIT reason))
4014
4015 ;; Movement of point
4016
4017 (defun erc-bol ()
4018   "Move `point' to the beginning of the current line.
4019
4020 This places `point' just after the prompt, or at the beginning of the line."
4021   (interactive)
4022   (forward-line 0)
4023   (when (get-text-property (point) 'erc-prompt)
4024     (goto-char erc-input-marker))
4025   (point))
4026
4027 (defun erc-kill-input ()
4028   "Kill current input line using `erc-bol' followed by `kill-line'."
4029   (interactive)
4030   (when (and (erc-bol)
4031              (/= (point) (point-max))) ;; Prevent a (ding) and an error when
4032     ;; there's nothing to kill
4033     (if (boundp 'erc-input-ring-index)
4034         (setq erc-input-ring-index nil))
4035     (kill-line)))
4036
4037 (defun erc-complete-word-at-point ()
4038   (run-hook-with-args-until-success 'erc-complete-functions))
4039
4040 (define-obsolete-function-alias 'erc-complete-word 'completion-at-point "24.1")
4041
4042 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4043 ;;
4044 ;;                        IRC SERVER INPUT HANDLING
4045 ;;
4046 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4047
4048 ;;;; New Input parsing
4049
4050 ; Stolen from ZenIRC. I just wanna test this code, so here is
4051 ; experiment area.
4052
4053 (defcustom erc-default-server-hook '(erc-debug-missing-hooks
4054                                      erc-default-server-handler)
4055   "Default for server messages which aren't covered by `erc-server-hooks'."
4056   :group 'erc-server-hooks
4057   :type 'hook)
4058
4059 (defun erc-default-server-handler (proc parsed)
4060   "Default server handler.
4061
4062 Displays PROC and PARSED appropriately using `erc-display-message'."
4063   (erc-display-message
4064    parsed 'notice proc
4065    (mapconcat
4066     'identity
4067     (let (res)
4068       (mapc #'(lambda (x)
4069                 (if (stringp x)
4070                     (setq res (append res (list x)))))
4071             parsed)
4072       res)
4073     " ")))
4074
4075 (defvar erc-server-vectors
4076   '(["msgtype" "sender" "to" "arg1" "arg2" "arg3" "..."])
4077   "List of received server messages which ERC does not specifically handle.
4078 See `erc-debug-missing-hooks'.")
4079 ;(make-variable-buffer-local 'erc-server-vectors)
4080
4081 (defun erc-debug-missing-hooks (_proc parsed)
4082   "Add PARSED server message ERC does not yet handle to `erc-server-vectors'.
4083 These vectors can be helpful when adding new server message handlers to ERC.
4084 See `erc-default-server-hook'."
4085   (nconc erc-server-vectors (list parsed))
4086   nil)
4087
4088 (defun erc-query (target server)
4089   "Open a query buffer on TARGET, using SERVER.
4090 To change how this query window is displayed, use `let' to bind
4091 `erc-join-buffer' before calling this."
4092   (unless (and server
4093                (buffer-live-p server)
4094                (set-buffer server))
4095     (error "Couldn't switch to server buffer"))
4096   (let ((buf (erc-open erc-session-server
4097                        erc-session-port
4098                        (erc-current-nick)
4099                        erc-session-user-full-name
4100                        nil
4101                        nil
4102                        (list target)
4103                        target
4104                        erc-server-process)))
4105     (unless buf
4106       (error "Couldn't open query window"))
4107     (erc-update-mode-line)
4108     buf))
4109
4110 (defcustom erc-auto-query 'window-noselect
4111   "If non-nil, create a query buffer each time you receive a private message.
4112 If the buffer doesn't already exist, it is created.
4113
4114 This can be set to a symbol, to control how the new query window
4115 should appear.  The default behavior is to display the buffer in
4116 a new window, but not to select it.  See the documentation for
4117 `erc-join-buffer' for a description of the available choices."
4118   :group 'erc-query
4119   :type '(choice (const :tag "Don't create query window" nil)
4120                  (const :tag "Split window and select" window)
4121                  (const :tag "Split window, don't select" window-noselect)
4122                  (const :tag "New frame" frame)
4123                  (const :tag "Bury in new buffer" bury)
4124                  (const :tag "Use current buffer" buffer)
4125                  (const :tag "Use current buffer" t)))
4126
4127 (defcustom erc-query-on-unjoined-chan-privmsg t
4128   "If non-nil create query buffer on receiving any PRIVMSG at all.
4129 This includes PRIVMSGs directed to channels.  If you are using an IRC
4130 bouncer, such as dircproxy, to keep a log of channels when you are
4131 disconnected, you should set this option to t."
4132   :group 'erc-query
4133   :type 'boolean)
4134
4135 (defcustom erc-format-query-as-channel-p t
4136   "If non-nil, format text from others in a query buffer like in a channel,
4137 otherwise format like a private message."
4138   :group 'erc-query
4139   :type 'boolean)
4140
4141 (defcustom erc-minibuffer-notice nil
4142   "If non-nil, print ERC notices for the user in the minibuffer.
4143 Only happens when the session buffer isn't visible."
4144   :group 'erc-display
4145   :type 'boolean)
4146
4147 (defcustom erc-minibuffer-ignored nil
4148   "If non-nil, print a message in the minibuffer if we ignored something."
4149   :group 'erc-ignore
4150   :type 'boolean)
4151
4152 (defun erc-wash-quit-reason (reason nick login host)
4153   "Remove duplicate text from quit REASON.
4154 Specifically in relation to NICK (user@host) information.  Returns REASON
4155 unmodified if nothing can be removed.
4156 E.g. \"Read error to Nick [user@some.host]: 110\" would be shortened to
4157 \"Read error: 110\". The same applies for \"Ping Timeout\"."
4158   (setq nick (regexp-quote nick)
4159         login (regexp-quote login)
4160         host (regexp-quote host))
4161   (or (when (string-match (concat "^\\(Read error\\) to "
4162                                   nick "\\[" host "\\]: "
4163                                   "\\(.+\\)$")
4164                           reason)
4165         (concat (match-string 1 reason) ": " (match-string 2 reason)))
4166       (when (string-match (concat "^\\(Ping timeout\\) for "
4167                                   nick "\\[" host "\\]$")
4168                           reason)
4169         (match-string 1 reason))
4170       reason))
4171
4172 (defun erc-nickname-in-use (nick reason)
4173   "If NICK is unavailable, tell the user the REASON.
4174
4175 See also `erc-display-error-notice'."
4176   (if (or (not erc-try-new-nick-p)
4177           ;; how many default-nicks are left + one more try...
4178           (eq erc-nick-change-attempt-count
4179               (if (consp erc-nick)
4180                   (+ (length erc-nick) 1)
4181                 1)))
4182       (erc-display-error-notice
4183        nil
4184        (format "Nickname %s is %s, try another." nick reason))
4185     (setq erc-nick-change-attempt-count (+ erc-nick-change-attempt-count 1))
4186     (let ((newnick (nth 1 erc-default-nicks))
4187           (nicklen (cdr (assoc "NICKLEN"
4188                                (erc-with-server-buffer
4189                                  erc-server-parameters)))))
4190       (setq erc-bad-nick t)
4191       ;; try to use a different nick
4192       (if erc-default-nicks
4193           (setq erc-default-nicks (cdr erc-default-nicks)))
4194       (if (not newnick)
4195           (setq newnick (concat (truncate-string-to-width
4196                                  nick
4197                                  (if (and erc-server-connected nicklen)
4198                                      (- (string-to-number nicklen)
4199                                         (length erc-nick-uniquifier))
4200                                    ;; rfc2812 max nick length = 9
4201                                    ;; we must assume this is the
4202                                    ;; server's setting if we haven't
4203                                    ;; established a connection yet
4204                                    (- 9 (length erc-nick-uniquifier))))
4205                                 erc-nick-uniquifier)))
4206       (erc-cmd-NICK newnick)
4207       (erc-display-error-notice
4208        nil
4209        (format "Nickname %s is %s, trying %s"
4210                nick reason newnick)))))
4211
4212 ;;; Server messages
4213
4214 (defgroup erc-server-hooks nil
4215   "Server event callbacks.
4216 Every server event - like numeric replies - has its own hook.
4217 Those hooks are all called using `run-hook-with-args-until-success'.
4218 They receive as first argument the process object from where the event
4219 originated from,
4220 and as second argument the event parsed as a vector."
4221   :group 'erc-hooks)
4222
4223 (defun erc-display-server-message (_proc parsed)
4224   "Display the message sent by the server as a notice."
4225   (erc-display-message
4226    parsed 'notice 'active (erc-response.contents parsed)))
4227
4228 (defun erc-auto-query (proc parsed)
4229   ;; FIXME: This needs more documentation, unless it's not a user function --
4230   ;; Lawrence 2004-01-08
4231   "Put this on `erc-server-PRIVMSG-functions'."
4232   (when erc-auto-query
4233     (let* ((nick (car (erc-parse-user (erc-response.sender parsed))))
4234            (target (car (erc-response.command-args parsed)))
4235            (msg (erc-response.contents parsed))
4236            (query  (if (not erc-query-on-unjoined-chan-privmsg)
4237                        nick
4238                      (if (erc-current-nick-p target)
4239                          nick
4240                        target))))
4241       (and (not (erc-ignored-user-p (erc-response.sender parsed)))
4242            (or erc-query-on-unjoined-chan-privmsg
4243                (string= target (erc-current-nick)))
4244            (not (erc-get-buffer query proc))
4245            (not (erc-is-message-ctcp-and-not-action-p msg))
4246            (let ((erc-query-display erc-auto-query))
4247              (erc-cmd-QUERY query))
4248            nil))))
4249
4250 (defun erc-is-message-ctcp-p (message)
4251   "Check if MESSAGE is a CTCP message or not."
4252   (string-match "^\C-a\\([^\C-a]*\\)\C-a?$" message))
4253
4254 (defun erc-is-message-ctcp-and-not-action-p (message)
4255   "Check if MESSAGE is a CTCP message or not."
4256   (and (erc-is-message-ctcp-p message)
4257        (not (string-match "^\C-a\\ACTION.*\C-a$" message))))
4258
4259 (defun erc-format-privmessage (nick msg privp msgp)
4260   "Format a PRIVMSG in an insertable fashion."
4261   (let* ((mark-s (if msgp (if privp "*" "<") "-"))
4262          (mark-e (if msgp (if privp "*" ">") "-"))
4263          (str    (format "%s%s%s %s" mark-s nick mark-e msg))
4264          (nick-face (if privp 'erc-nick-msg-face 'erc-nick-default-face))
4265          (msg-face (if privp 'erc-direct-msg-face 'erc-default-face)))
4266     ;; add text properties to text before the nick, the nick and after the nick
4267     (erc-put-text-property 0 (length mark-s) 'face msg-face str)
4268     (erc-put-text-property (length mark-s) (+ (length mark-s) (length nick))
4269                            'face nick-face str)
4270     (erc-put-text-property (+ (length mark-s) (length nick)) (length str)
4271                            'face msg-face str)
4272     str))
4273
4274 (defcustom erc-format-nick-function 'erc-format-nick
4275   "Function to format a nickname for message display."
4276   :group 'erc-display
4277   :type 'function)
4278
4279 (defun erc-format-nick (&optional user _channel-data)
4280   "Return the nickname of USER.
4281 See also `erc-format-nick-function'."
4282   (when user (erc-server-user-nickname user)))
4283
4284 (defun erc-get-user-mode-prefix (user)
4285   (when user
4286     (cond ((erc-channel-user-owner-p user)
4287            (erc-propertize "~" 'help-echo "owner"))
4288           ((erc-channel-user-admin-p user)
4289            (erc-propertize "&" 'help-echo "admin"))
4290           ((erc-channel-user-op-p user)
4291            (erc-propertize "@" 'help-echo "operator"))
4292           ((erc-channel-user-halfop-p user)
4293            (erc-propertize "%" 'help-echo "half-op"))
4294           ((erc-channel-user-voice-p user)
4295            (erc-propertize "+" 'help-echo "voice"))
4296           (t ""))))
4297
4298 (defun erc-format-@nick (&optional user _channel-data)
4299   "Format the nickname of USER showing if USER has a voice, is an
4300 operator, half-op, admin or owner. Owners have \"~\", admins have
4301 \"&\", operators have \"@\" and users with voice have \"+\" as a
4302 prefix.  Use CHANNEL-DATA to determine op and voice status.  See
4303 also `erc-format-nick-function'."
4304   (when user
4305     (let ((nick (erc-server-user-nickname user)))
4306       (concat (erc-propertize
4307                (erc-get-user-mode-prefix nick)
4308                'face 'erc-nick-prefix-face)
4309               nick))))
4310
4311 (defun erc-format-my-nick ()
4312   "Return the beginning of this user's message, correctly propertized."
4313   (if erc-show-my-nick
4314       (let* ((open "<")
4315              (close "> ")
4316              (nick (erc-current-nick))
4317              (mode (erc-get-user-mode-prefix nick)))
4318         (concat
4319          (erc-propertize open 'face 'erc-default-face)
4320          (erc-propertize mode 'face 'erc-my-nick-prefix-face)
4321          (erc-propertize nick 'face 'erc-my-nick-face)
4322          (erc-propertize close 'face 'erc-default-face)))
4323     (let ((prefix "> "))
4324       (erc-propertize prefix 'face 'erc-default-face))))
4325
4326 (defun erc-echo-notice-in-default-buffer (s parsed buffer _sender)
4327   "Echos a private notice in the default buffer, namely the
4328 target buffer specified by BUFFER, or there is no target buffer,
4329 the server buffer.  This function is designed to be added to
4330 either `erc-echo-notice-hook' or `erc-echo-notice-always-hook',
4331 and always returns t."
4332   (erc-display-message parsed nil buffer s)
4333   t)
4334
4335 (defun erc-echo-notice-in-target-buffer (s parsed buffer _sender)
4336   "Echos a private notice in BUFFER, if BUFFER is non-nil.  This
4337 function is designed to be added to either `erc-echo-notice-hook'
4338 or `erc-echo-notice-always-hook', and returns non-nil if BUFFER
4339 is non-nil."
4340   (if buffer
4341       (progn (erc-display-message parsed nil buffer s) t)
4342     nil))
4343
4344 (defun erc-echo-notice-in-minibuffer (s _parsed _buffer _sender)
4345   "Echos a private notice in the minibuffer.  This function is
4346 designed to be added to either `erc-echo-notice-hook' or
4347 `erc-echo-notice-always-hook', and always returns t."
4348   (message "%s" (concat "NOTICE: " s))
4349   t)
4350
4351 (defun erc-echo-notice-in-server-buffer (s parsed _buffer _sender)
4352   "Echos a private notice in the server buffer.  This function is
4353 designed to be added to either `erc-echo-notice-hook' or
4354 `erc-echo-notice-always-hook', and always returns t."
4355   (erc-display-message parsed nil nil s)
4356   t)
4357
4358 (defun erc-echo-notice-in-active-non-server-buffer (s parsed _buffer _sender)
4359   "Echos a private notice in the active buffer if the active
4360 buffer is not the server buffer.  This function is designed to be
4361 added to either `erc-echo-notice-hook' or
4362 `erc-echo-notice-always-hook', and returns non-nil if the active
4363 buffer is not the server buffer."
4364   (if (not (eq (erc-server-buffer) (erc-active-buffer)))
4365       (progn (erc-display-message parsed nil 'active s) t)
4366     nil))
4367
4368 (defun erc-echo-notice-in-active-buffer (s parsed _buffer _sender)
4369   "Echos a private notice in the active buffer.  This function is
4370 designed to be added to either `erc-echo-notice-hook' or
4371 `erc-echo-notice-always-hook', and always returns t."
4372   (erc-display-message parsed nil 'active s)
4373   t)
4374
4375 (defun erc-echo-notice-in-user-buffers (s parsed _buffer sender)
4376   "Echos a private notice in all of the buffers for which SENDER
4377 is a member.  This function is designed to be added to either
4378 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
4379 returns non-nil if there is at least one buffer for which the
4380 sender is a member.
4381
4382 See also: `erc-echo-notice-in-first-user-buffer',
4383 `erc-buffer-list-with-nick'."
4384   (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4385     (if buffers
4386         (progn (erc-display-message parsed nil buffers s) t)
4387       nil)))
4388
4389 (defun erc-echo-notice-in-user-and-target-buffers (s parsed buffer sender)
4390   "Echos a private notice in BUFFER and in all of the buffers for
4391 which SENDER is a member.  This function is designed to be added
4392 to either `erc-echo-notice-hook' or
4393 `erc-echo-notice-always-hook', and returns non-nil if there is
4394 at least one buffer for which the sender is a member or the
4395 default target.
4396
4397 See also: `erc-echo-notice-in-user-buffers',
4398 `erc-buffer-list-with-nick'."
4399   (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4400     (unless (memq buffer buffers) (push buffer buffers))
4401     (if buffers                         ;FIXME: How could it be nil?
4402         (progn (erc-display-message parsed nil buffers s) t)
4403       nil)))
4404
4405 (defun erc-echo-notice-in-first-user-buffer (s parsed _buffer sender)
4406   "Echos a private notice in one of the buffers for which SENDER
4407 is a member.  This function is designed to be added to either
4408 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
4409 returns non-nil if there is at least one buffer for which the
4410 sender is a member.
4411
4412 See also: `erc-echo-notice-in-user-buffers',
4413 `erc-buffer-list-with-nick'."
4414   (let ((buffers (erc-buffer-list-with-nick sender erc-server-process)))
4415     (if buffers
4416         (progn (erc-display-message parsed nil (car buffers) s) t)
4417       nil)))
4418
4419 ;;; Ban manipulation
4420
4421 (defun erc-banlist-store (proc parsed)
4422   "Record ban entries for a channel."
4423   (pcase-let ((`(,channel ,mask ,whoset)
4424                (cdr (erc-response.command-args parsed))))
4425     ;; Determine to which buffer the message corresponds
4426     (let ((buffer (erc-get-buffer channel proc)))
4427       (with-current-buffer buffer
4428         (unless (member (cons whoset mask) erc-channel-banlist)
4429           (setq erc-channel-banlist (cons (cons whoset mask)
4430                                           erc-channel-banlist))))))
4431   nil)
4432
4433 (defun erc-banlist-finished (proc parsed)
4434   "Record that we have received the banlist."
4435   (let* ((channel (nth 1 (erc-response.command-args parsed)))
4436          (buffer (erc-get-buffer channel proc)))
4437     (with-current-buffer buffer
4438       (put 'erc-channel-banlist 'received-from-server t)))
4439   t)                                    ; suppress the 'end of banlist' message
4440
4441 (defun erc-banlist-update (proc parsed)
4442   "Check MODE commands for bans and update the banlist appropriately."
4443   ;; FIXME: Possibly incorrect. -- Lawrence 2004-05-11
4444   (let* ((tgt (car (erc-response.command-args parsed)))
4445          (mode (erc-response.contents parsed))
4446          (whoset (erc-response.sender parsed))
4447          (buffer (erc-get-buffer tgt proc)))
4448     (when buffer
4449       (with-current-buffer buffer
4450         (cond ((not (get 'erc-channel-banlist 'received-from-server)) nil)
4451               ((string-match "^\\([+-]\\)b" mode)
4452                ;; This is a ban
4453                (cond
4454                 ((string-match "^-" mode)
4455                  ;; Remove the unbanned masks from the ban list
4456                  (setq erc-channel-banlist
4457                        (erc-delete-if
4458                         #'(lambda (y)
4459                             (member (upcase (cdr y))
4460                                     (mapcar #'upcase
4461                                             (cdr (split-string mode)))))
4462                         erc-channel-banlist)))
4463                 ((string-match "^+" mode)
4464                  ;; Add the banned mask(s) to the ban list
4465                  (mapc
4466                   (lambda (mask)
4467                     (unless (member (cons whoset mask) erc-channel-banlist)
4468                       (setq erc-channel-banlist
4469                             (cons (cons whoset mask) erc-channel-banlist))))
4470                   (cdr (split-string mode))))))))))
4471   nil)
4472
4473 ;; used for the banlist cmds
4474 (defun erc-group-list (list n)
4475   "Group LIST into sublists of length N."
4476   (cond ((null list) nil)
4477         ((null (nthcdr n list)) (list list))
4478         (t (cons (erc-subseq list 0 n) (erc-group-list (nthcdr n list) n)))))
4479
4480
4481 ;;; MOTD numreplies
4482
4483 (defun erc-handle-login ()
4484   "Handle the logging in process of connection."
4485   (unless erc-logged-in
4486     (setq erc-logged-in t)
4487     (message "Logging in as `%s'... done" (erc-current-nick))
4488     ;; execute a startup script
4489     (let ((f (erc-select-startup-file)))
4490       (when f
4491         (erc-load-script f)))))
4492
4493 (defun erc-connection-established (proc parsed)
4494   "Run just after connection.
4495
4496 Set user modes and run `erc-after-connect' hook."
4497   (with-current-buffer (process-buffer proc)
4498     (unless erc-server-connected ; only once per session
4499       (let ((server (or erc-server-announced-name
4500                         (erc-response.sender parsed)))
4501             (nick (car (erc-response.command-args parsed)))
4502             (buffer (process-buffer proc)))
4503         (setq erc-server-connected t)
4504         (setq erc-server-reconnect-count 0)
4505         (erc-update-mode-line)
4506         (erc-set-initial-user-mode nick buffer)
4507         (erc-server-setup-periodical-ping buffer)
4508         (run-hook-with-args 'erc-after-connect server nick)))))
4509
4510 (defun erc-set-initial-user-mode (nick buffer)
4511   "If `erc-user-mode' is non-nil for NICK, set the user modes.
4512 The server buffer is given by BUFFER."
4513   (with-current-buffer buffer
4514     (when erc-user-mode
4515       (let ((mode (if (functionp erc-user-mode)
4516                       (funcall erc-user-mode)
4517                     erc-user-mode)))
4518         (when (stringp mode)
4519           (erc-log (format "changing mode for %s to %s" nick mode))
4520           (erc-server-send (format "MODE %s %s" nick mode)))))))
4521
4522 (defun erc-display-error-notice (parsed string)
4523   "Display STRING as an error notice.
4524
4525 See also `erc-display-message'."
4526   (erc-display-message
4527    parsed '(notice error) 'active string))
4528
4529 (defun erc-process-ctcp-query (proc parsed nick login host)
4530   ;; FIXME: This needs a proper docstring -- Lawrence 2004-01-08
4531   "Process a CTCP query."
4532   (let ((queries (delete "" (split-string (erc-response.contents parsed)
4533                                           "\C-a"))))
4534     (if (> (length queries) 4)
4535         (erc-display-message
4536          parsed (list 'notice 'error) proc 'ctcp-too-many)
4537       (if (= 0 (length queries))
4538           (erc-display-message
4539            parsed (list 'notice 'error) proc
4540            'ctcp-empty ?n nick)
4541         (while queries
4542           (let* ((type (upcase (car (split-string (car queries)))))
4543                  (hook (intern-soft (concat "erc-ctcp-query-" type "-hook"))))
4544             (if (and hook (boundp hook))
4545                 (if (string-equal type "ACTION")
4546                     (run-hook-with-args-until-success
4547                      hook proc parsed nick login host
4548                      (car (erc-response.command-args parsed))
4549                      (car queries))
4550                   (when erc-paranoid
4551                     (if (erc-current-nick-p
4552                          (car (erc-response.command-args parsed)))
4553                         (erc-display-message
4554                          parsed 'error 'active 'ctcp-request
4555                          ?n nick ?u login ?h host ?r (car queries))
4556                       (erc-display-message
4557                        parsed 'error 'active 'ctcp-request-to
4558                        ?n nick ?u login ?h host ?r (car queries)
4559                        ?t (car (erc-response.command-args parsed)))))
4560                   (run-hook-with-args-until-success
4561                    hook proc nick login host
4562                    (car (erc-response.command-args parsed))
4563                    (car queries)))
4564               (erc-display-message
4565                parsed (list 'notice 'error) proc
4566                'undefined-ctcp)))
4567           (setq queries (cdr queries)))))))
4568
4569 (defvar erc-ctcp-query-ACTION-hook '(erc-ctcp-query-ACTION))
4570
4571 (defun erc-ctcp-query-ACTION (proc parsed nick login host to msg)
4572   "Respond to a CTCP ACTION query."
4573   (when (string-match "^ACTION\\s-\\(.*\\)\\s-*$" msg)
4574     (let ((s (match-string 1 msg))
4575           (buf (or (erc-get-buffer to proc)
4576                    (erc-get-buffer nick proc)
4577                    (process-buffer proc))))
4578       (erc-display-message
4579        parsed 'action buf
4580        'ACTION ?n nick ?u login ?h host ?a s))))
4581
4582 (defvar erc-ctcp-query-CLIENTINFO-hook '(erc-ctcp-query-CLIENTINFO))
4583
4584 (defun erc-ctcp-query-CLIENTINFO (_proc nick _login _host _to msg)
4585   "Respond to a CTCP CLIENTINFO query."
4586   (when (string-match "^CLIENTINFO\\(\\s-*\\|\\s-+.*\\)$" msg)
4587     (let ((s (erc-client-info (erc-trim-string (match-string 1 msg)))))
4588       (unless erc-disable-ctcp-replies
4589         (erc-send-ctcp-notice nick (format "CLIENTINFO %s" s)))))
4590   nil)
4591
4592 (defvar erc-ctcp-query-ECHO-hook '(erc-ctcp-query-ECHO))
4593 (defun erc-ctcp-query-ECHO (_proc nick _login _host _to msg)
4594   "Respond to a CTCP ECHO query."
4595   (when (string-match "^ECHO\\s-+\\(.*\\)\\s-*$" msg)
4596     (let ((s (match-string 1 msg)))
4597       (unless erc-disable-ctcp-replies
4598         (erc-send-ctcp-notice nick (format "ECHO %s" s)))))
4599   nil)
4600
4601 (defvar erc-ctcp-query-FINGER-hook '(erc-ctcp-query-FINGER))
4602 (defun erc-ctcp-query-FINGER (_proc nick _login _host _to _msg)
4603   "Respond to a CTCP FINGER query."
4604   (unless erc-disable-ctcp-replies
4605     (let ((s (if erc-anonymous-login
4606                  (format "FINGER I'm %s." (erc-current-nick))
4607                (format "FINGER %s (%s@%s)."
4608                        (user-full-name)
4609                        (user-login-name)
4610                        (system-name))))
4611           (ns (erc-time-diff erc-server-last-sent-time (erc-current-time))))
4612       (when (> ns 0)
4613         (setq s (concat s " Idle for " (erc-sec-to-time ns))))
4614       (erc-send-ctcp-notice nick s)))
4615   nil)
4616
4617 (defvar erc-ctcp-query-PING-hook '(erc-ctcp-query-PING))
4618 (defun erc-ctcp-query-PING (_proc nick _login _host _to msg)
4619   "Respond to a CTCP PING query."
4620   (when (string-match "^PING\\s-+\\(.*\\)" msg)
4621     (unless erc-disable-ctcp-replies
4622       (let ((arg (match-string 1 msg)))
4623         (erc-send-ctcp-notice nick (format "PING %s" arg)))))
4624   nil)
4625
4626 (defvar erc-ctcp-query-TIME-hook '(erc-ctcp-query-TIME))
4627 (defun erc-ctcp-query-TIME (_proc nick _login _host _to _msg)
4628   "Respond to a CTCP TIME query."
4629   (unless erc-disable-ctcp-replies
4630     (erc-send-ctcp-notice nick (format "TIME %s" (current-time-string))))
4631   nil)
4632
4633 (defvar erc-ctcp-query-USERINFO-hook '(erc-ctcp-query-USERINFO))
4634 (defun erc-ctcp-query-USERINFO (_proc nick _login _host _to _msg)
4635   "Respond to a CTCP USERINFO query."
4636   (unless erc-disable-ctcp-replies
4637     (erc-send-ctcp-notice nick (format "USERINFO %s" erc-user-information)))
4638   nil)
4639
4640 (defvar erc-ctcp-query-VERSION-hook '(erc-ctcp-query-VERSION))
4641 (defun erc-ctcp-query-VERSION (_proc nick _login _host _to _msg)
4642   "Respond to a CTCP VERSION query."
4643   (unless erc-disable-ctcp-replies
4644     (erc-send-ctcp-notice
4645      nick (format
4646            "VERSION \C-bERC\C-b - an IRC client for Emacs %s (\C-b%s\C-b)"
4647            emacs-version
4648            erc-official-location)))
4649   nil)
4650
4651 (defun erc-process-ctcp-reply (proc parsed nick login host msg)
4652   "Process MSG as a CTCP reply."
4653   (let* ((type (car (split-string msg)))
4654          (hook (intern (concat "erc-ctcp-reply-" type "-hook"))))
4655     (if (boundp hook)
4656         (run-hook-with-args-until-success
4657          hook proc nick login host
4658          (car (erc-response.command-args parsed)) msg)
4659       (erc-display-message
4660        parsed 'notice 'active
4661        'CTCP-UNKNOWN ?n nick ?u login ?h host ?m msg))))
4662
4663 (defvar erc-ctcp-reply-ECHO-hook '(erc-ctcp-reply-ECHO))
4664 (defun erc-ctcp-reply-ECHO (_proc nick _login _host _to msg)
4665   "Handle a CTCP ECHO reply."
4666   (when (string-match "^ECHO\\s-+\\(.*\\)\\s-*$" msg)
4667     (let ((message (match-string 1 msg)))
4668       (erc-display-message
4669        nil '(notice action) 'active
4670        'CTCP-ECHO ?n nick ?m message)))
4671   nil)
4672
4673 (defvar erc-ctcp-reply-CLIENTINFO-hook '(erc-ctcp-reply-CLIENTINFO))
4674 (defun erc-ctcp-reply-CLIENTINFO (_proc nick _login _host _to msg)
4675   "Handle a CTCP CLIENTINFO reply."
4676   (when (string-match "^CLIENTINFO\\s-+\\(.*\\)\\s-*$" msg)
4677     (let ((message (match-string 1 msg)))
4678       (erc-display-message
4679        nil 'notice 'active
4680        'CTCP-CLIENTINFO ?n nick ?m message)))
4681   nil)
4682
4683 (defvar erc-ctcp-reply-FINGER-hook '(erc-ctcp-reply-FINGER))
4684 (defun erc-ctcp-reply-FINGER (_proc nick _login _host _to msg)
4685   "Handle a CTCP FINGER reply."
4686   (when (string-match "^FINGER\\s-+\\(.*\\)\\s-*$" msg)
4687     (let ((message (match-string 1 msg)))
4688       (erc-display-message
4689        nil 'notice 'active
4690        'CTCP-FINGER ?n nick ?m message)))
4691   nil)
4692
4693 (defvar erc-ctcp-reply-PING-hook '(erc-ctcp-reply-PING))
4694 (defun erc-ctcp-reply-PING (_proc nick _login _host _to msg)
4695   "Handle a CTCP PING reply."
4696   (if (not (string-match "^PING\\s-+\\([0-9.]+\\)" msg))
4697       nil
4698     (let ((time (match-string 1 msg)))
4699       (condition-case nil
4700           (let ((delta (erc-time-diff (string-to-number time)
4701                                       (erc-current-time))))
4702             (erc-display-message
4703              nil 'notice 'active
4704              'CTCP-PING ?n nick
4705              ?t (erc-sec-to-time delta)))
4706         (range-error
4707          (erc-display-message
4708           nil 'error 'active
4709           'bad-ping-response ?n nick ?t time))))))
4710
4711 (defvar erc-ctcp-reply-TIME-hook '(erc-ctcp-reply-TIME))
4712 (defun erc-ctcp-reply-TIME (_proc nick _login _host _to msg)
4713   "Handle a CTCP TIME reply."
4714   (when (string-match "^TIME\\s-+\\(.*\\)\\s-*$" msg)
4715     (let ((message (match-string 1 msg)))
4716       (erc-display-message
4717        nil 'notice 'active
4718        'CTCP-TIME ?n nick ?m message)))
4719   nil)
4720
4721 (defvar erc-ctcp-reply-VERSION-hook '(erc-ctcp-reply-VERSION))
4722 (defun erc-ctcp-reply-VERSION (_proc nick _login _host _to msg)
4723   "Handle a CTCP VERSION reply."
4724   (when (string-match "^VERSION\\s-+\\(.*\\)\\s-*$" msg)
4725     (let ((message (match-string 1 msg)))
4726       (erc-display-message
4727        nil 'notice 'active
4728        'CTCP-VERSION ?n nick ?m message)))
4729   nil)
4730
4731 (defun erc-process-away (proc away-p)
4732   "Toggle the away status of the user depending on the value of AWAY-P.
4733
4734 If nil, set the user as away.
4735 If non-nil, return from being away."
4736   (let ((sessionbuf (process-buffer proc)))
4737     (when sessionbuf
4738       (with-current-buffer sessionbuf
4739         (when erc-away-nickname
4740           (erc-log (format "erc-process-away: away-nick: %s, away-p: %s"
4741                            erc-away-nickname away-p))
4742           (erc-cmd-NICK (if away-p
4743                             erc-away-nickname
4744                           erc-nick)))
4745         (cond
4746          (away-p
4747           (setq erc-away (current-time)))
4748          (t
4749           (let ((away-time erc-away))
4750             ;; away must be set to NIL BEFORE sending anything to prevent
4751             ;; an infinite recursion
4752             (setq erc-away nil)
4753             (with-current-buffer (erc-active-buffer)
4754               (when erc-public-away-p
4755                 (erc-send-action
4756                  (erc-default-target)
4757                  (if away-time
4758                      (format "is back (gone for %s)"
4759                              (erc-sec-to-time
4760                               (erc-time-diff
4761                                (erc-emacs-time-to-erc-time away-time)
4762                                (erc-current-time))))
4763                    "is back")))))))))
4764     (erc-update-mode-line)))
4765
4766 ;;;; List of channel members handling
4767
4768 (defun erc-channel-begin-receiving-names ()
4769   "Internal function.
4770
4771 Used when a channel names list is about to be received.  Should
4772 be called with the current buffer set to the channel buffer.
4773
4774 See also `erc-channel-end-receiving-names'."
4775   (setq erc-channel-new-member-names (make-hash-table :test 'equal)))
4776
4777 (defun erc-channel-end-receiving-names ()
4778   "Internal function.
4779
4780 Used to fix `erc-channel-users' after a channel names list has been
4781 received.  Should be called with the current buffer set to the
4782 channel buffer.
4783
4784 See also `erc-channel-begin-receiving-names'."
4785   (maphash (lambda (nick _user)
4786              (if (null (gethash nick erc-channel-new-member-names))
4787                  (erc-remove-channel-user nick)))
4788            erc-channel-users)
4789   (setq erc-channel-new-member-names nil))
4790
4791 (defun erc-parse-prefix ()
4792   "Return an alist of valid prefix character types and their representations.
4793 Example: (operator) o => @, (voiced) v => +."
4794   (let ((str (or (cdr (assoc "PREFIX" (erc-with-server-buffer
4795                                         erc-server-parameters)))
4796                  ;; provide a sane default
4797                  "(qaohv)~&@%+"))
4798         types chars)
4799     (when (string-match "^(\\([^)]+\\))\\(.+\\)$" str)
4800       (setq types (match-string 1 str)
4801             chars (match-string 2 str))
4802       (let ((len (min (length types) (length chars)))
4803             (i 0)
4804             (alist nil))
4805         (while (< i len)
4806           (setq alist (cons (cons (elt types i) (elt chars i))
4807                             alist))
4808           (setq i (1+ i)))
4809         alist))))
4810
4811 (defun erc-channel-receive-names (names-string)
4812   "This function is for internal use only.
4813
4814 Update `erc-channel-users' according to NAMES-STRING.
4815 NAMES-STRING is a string listing some of the names on the
4816 channel."
4817   (let* ((prefix (erc-parse-prefix))
4818          (voice-ch (cdr (assq ?v prefix)))
4819          (op-ch (cdr (assq ?o prefix)))
4820          (hop-ch (cdr (assq ?h prefix)))
4821          (adm-ch (cdr (assq ?a prefix)))
4822          (own-ch (cdr (assq ?q prefix)))
4823          (names (delete "" (split-string names-string)))
4824          name op voice halfop admin owner)
4825     (let ((erc-channel-members-changed-hook nil))
4826       (dolist (item names)
4827         (let ((updatep t)
4828               (ch (aref item 0)))
4829           (setq name item op 'off voice 'off halfop 'off admin 'off owner 'off)
4830           (if (rassq ch prefix)
4831               (if (= (length item) 1)
4832                   (setq updatep nil)
4833                 (setq name (substring item 1))
4834                 (setf (pcase ch
4835                         ((pred (eq voice-ch)) voice)
4836                         ((pred (eq hop-ch))   halfop)
4837                         ((pred (eq op-ch))    op)
4838                         ((pred (eq adm-ch))   admin)
4839                         ((pred (eq own-ch))   owner)
4840                         (_ (message "Unknown prefix char `%S'" ch) voice))
4841                       'on)))
4842           (when updatep
4843             ;; If we didn't issue the NAMES request (consider two clients
4844             ;; talking to an IRC proxy), `erc-channel-begin-receiving-names'
4845             ;; will not have been called, so we have to do it here.
4846             (unless erc-channel-new-member-names
4847               (erc-channel-begin-receiving-names))
4848             (puthash (erc-downcase name) t
4849                      erc-channel-new-member-names)
4850             (erc-update-current-channel-member
4851              name name t voice halfop op admin owner)))))
4852     (run-hooks 'erc-channel-members-changed-hook)))
4853
4854
4855 (defcustom erc-channel-members-changed-hook nil
4856   "This hook is called every time the variable `channel-members' changes.
4857 The buffer where the change happened is current while this hook is called."
4858   :group 'erc-hooks
4859   :type 'hook)
4860
4861 (defun erc-update-user-nick (nick &optional new-nick
4862                                   host login full-name info)
4863   "Update the stored user information for the user with nickname NICK.
4864
4865 See also: `erc-update-user'."
4866   (erc-update-user (erc-get-server-user nick) new-nick
4867                    host login full-name info))
4868
4869 (defun erc-update-user (user &optional new-nick
4870                              host login full-name info)
4871   "Update user info for USER.  USER must be an erc-server-user
4872 struct.  Any of NEW-NICK, HOST, LOGIN, FULL-NAME, INFO which are
4873 non-nil and not equal to the existing values for USER are used to
4874 replace the stored values in USER.
4875
4876 If, and only if, a change is made,
4877 `erc-channel-members-changed-hook' is run for each channel for
4878 which USER is a member, and t is returned."
4879   (let (changed)
4880     (when user
4881       (when (and new-nick
4882                  (not (equal (erc-server-user-nickname user)
4883                              new-nick)))
4884         (setq changed t)
4885         (erc-change-user-nickname user new-nick))
4886       (when (and host
4887                  (not (equal (erc-server-user-host user) host)))
4888         (setq changed t)
4889         (setf (erc-server-user-host user) host))
4890       (when (and login
4891                  (not (equal (erc-server-user-login user) login)))
4892         (setq changed t)
4893         (setf (erc-server-user-login user) login))
4894       (when (and full-name
4895                  (not (equal (erc-server-user-full-name user)
4896                              full-name)))
4897         (setq changed t)
4898         (setf (erc-server-user-full-name user) full-name))
4899       (when (and info
4900                  (not (equal (erc-server-user-info user) info)))
4901         (setq changed t)
4902         (setf (erc-server-user-info user) info))
4903       (if changed
4904           (dolist (buf (erc-server-user-buffers user))
4905             (if (buffer-live-p buf)
4906                 (with-current-buffer buf
4907                   (run-hooks 'erc-channel-members-changed-hook))))))
4908     changed))
4909
4910 (defun erc-update-current-channel-member
4911   (nick new-nick &optional add voice halfop op admin owner host login full-name info
4912         update-message-time)
4913   "Update the stored user information for the user with nickname NICK.
4914 `erc-update-user' is called to handle changes to nickname,
4915 HOST, LOGIN, FULL-NAME, and INFO.  If VOICE HALFOP OP ADMIN or OWNER
4916 are non-nil, they must be equal to either `on' or `off', in which
4917 case the status of the user in the current channel is changed accordingly.
4918 If UPDATE-MESSAGE-TIME is non-nil, the last-message-time of the user
4919  in the current channel is set to (current-time).
4920
4921 If ADD is non-nil, the user will be added with the specified
4922 information if it is not already present in the user or channel
4923 lists.
4924
4925 If, and only if, changes are made, or the user is added,
4926 `erc-channel-members-updated-hook' is run, and t is returned.
4927
4928 See also: `erc-update-user' and `erc-update-channel-member'."
4929   (let* (changed user-changed
4930                  (channel-data (erc-get-channel-user nick))
4931                  (cuser (cdr channel-data))
4932                  (user (if channel-data (car channel-data)
4933                          (erc-get-server-user nick))))
4934     (if cuser
4935         (progn
4936           (erc-log (format "update-member: user = %S, cuser = %S" user cuser))
4937           (when (and voice
4938                      (not (eq (erc-channel-user-voice cuser) voice)))
4939             (setq changed t)
4940             (setf (erc-channel-user-voice cuser)
4941                   (cond ((eq voice 'on) t)
4942                         ((eq voice 'off) nil)
4943                         (t voice))))
4944           (when (and halfop
4945                      (not (eq (erc-channel-user-halfop cuser) halfop)))
4946             (setq changed t)
4947             (setf (erc-channel-user-halfop cuser)
4948                   (cond ((eq halfop 'on) t)
4949                         ((eq halfop 'off) nil)
4950                         (t halfop))))
4951           (when (and op
4952                      (not (eq (erc-channel-user-op cuser) op)))
4953             (setq changed t)
4954             (setf (erc-channel-user-op cuser)
4955                   (cond ((eq op 'on) t)
4956                         ((eq op 'off) nil)
4957                         (t op))))
4958           (when (and admin
4959                      (not (eq (erc-channel-user-admin cuser) admin)))
4960             (setq changed t)
4961             (setf (erc-channel-user-admin cuser)
4962                   (cond ((eq admin 'on) t)
4963                         ((eq admin 'off) nil)
4964                         (t admin))))
4965           (when (and owner
4966                      (not (eq (erc-channel-user-owner cuser) owner)))
4967             (setq changed t)
4968             (setf (erc-channel-user-owner cuser)
4969                   (cond ((eq owner 'on) t)
4970                         ((eq owner 'off) nil)
4971                         (t owner))))
4972           (when update-message-time
4973             (setf (erc-channel-user-last-message-time cuser) (current-time)))
4974           (setq user-changed
4975                 (erc-update-user user new-nick
4976                                  host login full-name info)))
4977       (when add
4978         (if (null user)
4979             (progn
4980               (setq user (make-erc-server-user
4981                           :nickname nick
4982                           :host host
4983                           :full-name full-name
4984                           :login login
4985                           :info info
4986                           :buffers (list (current-buffer))))
4987               (erc-add-server-user nick user))
4988           (setf (erc-server-user-buffers user)
4989                 (cons (current-buffer)
4990                       (erc-server-user-buffers user))))
4991         (setq cuser (make-erc-channel-user
4992                      :voice (cond ((eq voice 'on) t)
4993                                   ((eq voice 'off) nil)
4994                                   (t voice))
4995                      :halfop (cond ((eq halfop 'on) t)
4996                                 ((eq halfop 'off) nil)
4997                                 (t halfop))
4998                      :op (cond ((eq op 'on) t)
4999                                ((eq op 'off) nil)
5000                                (t op))
5001                      :admin (cond ((eq admin 'on) t)
5002                                   ((eq admin 'off) nil)
5003                                   (t admin))
5004                      :owner (cond ((eq owner 'on) t)
5005                                   ((eq owner 'off) nil)
5006                                   (t owner))
5007                      :last-message-time
5008                      (if update-message-time (current-time))))
5009         (puthash (erc-downcase nick) (cons user cuser)
5010                  erc-channel-users)
5011         (setq changed t)))
5012     (when (and changed (null user-changed))
5013       (run-hooks 'erc-channel-members-changed-hook))
5014     (or changed user-changed add)))
5015
5016 (defun erc-update-channel-member (channel nick new-nick
5017                                           &optional add voice halfop op admin owner host login
5018                                           full-name info update-message-time)
5019   "Update user and channel information for the user with
5020 nickname NICK in channel CHANNEL.
5021
5022 See also: `erc-update-current-channel-member'."
5023   (erc-with-buffer
5024       (channel)
5025     (erc-update-current-channel-member nick new-nick add voice halfop op admin owner host
5026                                        login full-name info
5027                                        update-message-time)))
5028
5029 (defun erc-remove-current-channel-member (nick)
5030   "Remove NICK from current channel membership list.
5031 Runs `erc-channel-members-changed-hook'."
5032   (let ((channel-data (erc-get-channel-user nick)))
5033     (when channel-data
5034       (erc-remove-channel-user nick)
5035       (run-hooks 'erc-channel-members-changed-hook))))
5036
5037 (defun erc-remove-channel-member (channel nick)
5038   "Remove NICK from CHANNEL's membership list.
5039
5040 See also `erc-remove-current-channel-member'."
5041   (erc-with-buffer
5042       (channel)
5043     (erc-remove-current-channel-member nick)))
5044
5045 (defun erc-update-channel-topic (channel topic &optional modify)
5046   "Find a buffer for CHANNEL and set the TOPIC for it.
5047
5048 If optional MODIFY is `append' or `prepend', then append or prepend the
5049 TOPIC string to the current topic."
5050   (erc-with-buffer (channel)
5051     (cond ((eq modify 'append)
5052            (setq erc-channel-topic (concat erc-channel-topic topic)))
5053           ((eq modify 'prepend)
5054            (setq erc-channel-topic (concat topic erc-channel-topic)))
5055           (t (setq erc-channel-topic topic)))
5056     (erc-update-mode-line-buffer (current-buffer))))
5057
5058 (defun erc-set-modes (tgt mode-string)
5059   "Set the modes for the TGT provided as MODE-STRING."
5060   (let* ((modes (erc-parse-modes mode-string))
5061          (add-modes (nth 0 modes))
5062          ;; list of triples: (mode-char 'on/'off argument)
5063          (arg-modes (nth 2 modes)))
5064     (cond ((erc-channel-p tgt); channel modes
5065            (let ((buf (and erc-server-process
5066                            (erc-get-buffer tgt erc-server-process))))
5067              (when buf
5068                (with-current-buffer buf
5069                  (setq erc-channel-modes add-modes)
5070                  (setq erc-channel-user-limit nil)
5071                  (setq erc-channel-key nil)
5072                  (while arg-modes
5073                    (let ((mode (nth 0 (car arg-modes)))
5074                          (onoff (nth 1 (car arg-modes)))
5075                          (arg (nth 2 (car arg-modes))))
5076                      (cond ((string-match "^[Ll]" mode)
5077                             (erc-update-channel-limit tgt onoff arg))
5078                            ((string-match "^[Kk]" mode)
5079                             (erc-update-channel-key tgt onoff arg))
5080                            (t nil)))
5081                    (setq arg-modes (cdr arg-modes)))
5082                  (erc-update-mode-line-buffer buf)))))
5083           ;; we do not keep our nick's modes yet
5084           ;;(t (setq erc-user-modes add-modes))
5085           )
5086     ))
5087
5088 (defun erc-sort-strings (list-of-strings)
5089   "Sort LIST-OF-STRINGS in lexicographic order.
5090
5091 Side-effect free."
5092   (sort (copy-sequence list-of-strings) 'string<))
5093
5094 (defun erc-parse-modes (mode-string)
5095   "Parse MODE-STRING into a list.
5096
5097 Returns a list of three elements:
5098
5099   (ADD-MODES REMOVE-MODES ARG-MODES).
5100
5101 The add-modes and remove-modes are lists of single-character strings
5102 for modes without parameters to add and remove respectively.  The
5103 arg-modes is a list of triples of the form:
5104
5105   (MODE-CHAR ON/OFF ARGUMENT)."
5106   (if (string-match "^\\s-*\\(\\S-+\\)\\(\\s-.*$\\|$\\)" mode-string)
5107       (let ((chars (mapcar #'char-to-string (match-string 1 mode-string)))
5108             ;; arguments in channel modes
5109             (args-str (match-string 2 mode-string))
5110             (args nil)
5111             (add-modes nil)
5112             (remove-modes nil)
5113             (arg-modes nil); list of triples: (mode-char 'on/'off argument)
5114             (add-p t))
5115         ;; make the argument list
5116         (while (string-match "^\\s-*\\(\\S-+\\)\\(\\s-+.*$\\|$\\)" args-str)
5117           (setq args (cons (match-string 1 args-str) args))
5118           (setq args-str (match-string 2 args-str)))
5119         (setq args (nreverse args))
5120         ;; collect what modes changed, and match them with arguments
5121         (while chars
5122           (cond ((string= (car chars) "+") (setq add-p t))
5123                 ((string= (car chars) "-") (setq add-p nil))
5124                 ((string-match "^[qaovhbQAOVHB]" (car chars))
5125                  (setq arg-modes (cons (list (car chars)
5126                                              (if add-p 'on 'off)
5127                                              (if args (car args) nil))
5128                                        arg-modes))
5129                  (if args (setq args (cdr args))))
5130                 ((string-match "^[LlKk]" (car chars))
5131                  (setq arg-modes (cons (list (car chars)
5132                                              (if add-p 'on 'off)
5133                                              (if (and add-p args)
5134                                                  (car args) nil))
5135                                        arg-modes))
5136                  (if (and add-p args) (setq args (cdr args))))
5137                 (add-p (setq add-modes (cons (car chars) add-modes)))
5138                 (t (setq remove-modes (cons (car chars) remove-modes))))
5139           (setq chars (cdr chars)))
5140         (setq add-modes (nreverse add-modes))
5141         (setq remove-modes (nreverse remove-modes))
5142         (setq arg-modes (nreverse arg-modes))
5143         (list add-modes remove-modes arg-modes))
5144     nil))
5145
5146 (defun erc-update-modes (tgt mode-string &optional _nick _host _login)
5147   "Update the mode information for TGT, provided as MODE-STRING.
5148 Optional arguments: NICK, HOST and LOGIN - the attributes of the
5149 person who changed the modes."
5150   ;; FIXME: neither of nick, host, and login are used!
5151   (let* ((modes (erc-parse-modes mode-string))
5152          (add-modes (nth 0 modes))
5153          (remove-modes (nth 1 modes))
5154          ;; list of triples: (mode-char 'on/'off argument)
5155          (arg-modes (nth 2 modes)))
5156     ;; now parse the modes changes and do the updates
5157     (cond ((erc-channel-p tgt); channel modes
5158            (let ((buf (and erc-server-process
5159                            (erc-get-buffer tgt erc-server-process))))
5160              (when buf
5161                ;; FIXME! This used to have an original buffer
5162                ;; variable, but it never switched back to the original
5163                ;; buffer. Is this wanted behavior?
5164                (set-buffer buf)
5165                (if (not (boundp 'erc-channel-modes))
5166                    (setq erc-channel-modes nil))
5167                (while remove-modes
5168                  (setq erc-channel-modes (delete (car remove-modes)
5169                                                  erc-channel-modes)
5170                        remove-modes (cdr remove-modes)))
5171                (while add-modes
5172                  (setq erc-channel-modes (cons (car add-modes)
5173                                                erc-channel-modes)
5174                        add-modes (cdr add-modes)))
5175                (setq erc-channel-modes (erc-sort-strings erc-channel-modes))
5176                (while arg-modes
5177                  (let ((mode (nth 0 (car arg-modes)))
5178                        (onoff (nth 1 (car arg-modes)))
5179                        (arg (nth 2 (car arg-modes))))
5180                    (cond ((string-match "^[Vv]" mode)
5181                           (erc-update-channel-member tgt arg arg nil onoff))
5182                          ((string-match "^[hH]" mode)
5183                           (erc-update-channel-member tgt arg arg nil nil onoff))
5184                          ((string-match "^[oO]" mode)
5185                           (erc-update-channel-member tgt arg arg nil nil nil onoff))
5186                          ((string-match "^[aA]" mode)
5187                           (erc-update-channel-member tgt arg arg nil nil nil nil onoff))
5188                          ((string-match "^[qQ]" mode)
5189                           (erc-update-channel-member tgt arg arg nil nil nil nil nil onoff))
5190                          ((string-match "^[Ll]" mode)
5191                           (erc-update-channel-limit tgt onoff arg))
5192                          ((string-match "^[Kk]" mode)
5193                           (erc-update-channel-key tgt onoff arg))
5194                          (t nil)); only ops are tracked now
5195                    (setq arg-modes (cdr arg-modes))))
5196                (erc-update-mode-line buf))))
5197           ;; nick modes - ignored at this point
5198           (t nil))))
5199
5200 (defun erc-update-channel-limit (channel onoff n)
5201   ;; FIXME: what does ONOFF actually do?  -- Lawrence 2004-01-08
5202   "Update CHANNEL's user limit to N."
5203   (if (or (not (eq onoff 'on))
5204           (and (stringp n) (string-match "^[0-9]+$" n)))
5205       (erc-with-buffer
5206           (channel)
5207         (cond ((eq onoff 'on) (setq erc-channel-user-limit (string-to-number n)))
5208               (t (setq erc-channel-user-limit nil))))))
5209
5210 (defun erc-update-channel-key (channel onoff key)
5211   "Update CHANNEL's key to KEY if ONOFF is `on' or to nil if it's `off'."
5212   (erc-with-buffer
5213       (channel)
5214     (cond ((eq onoff 'on) (setq erc-channel-key key))
5215           (t (setq erc-channel-key nil)))))
5216
5217 (defun erc-handle-user-status-change (type nlh &optional l)
5218   "Handle changes in any user's status.
5219
5220 So far, only nick change is handled.
5221
5222 Generally, the TYPE argument is a symbol describing the change type, NLH is
5223 a list containing the original nickname, login name and hostname for the user,
5224 and L is a list containing additional TYPE-specific arguments.
5225
5226 So far the following TYPE/L pairs are supported:
5227
5228        Event                    TYPE                   L
5229
5230     nickname change            `nick'                (NEW-NICK)"
5231   (erc-log (format "user-change: type: %S  nlh: %S  l: %S" type nlh l))
5232   (cond
5233    ;; nickname change
5234    ((equal type 'nick)
5235     t)
5236    (t
5237     nil)))
5238
5239 (defun erc-highlight-notice (s)
5240   "Highlight notice message S and return it.
5241 See also variable `erc-notice-highlight-type'."
5242   (cond
5243    ((eq erc-notice-highlight-type 'prefix)
5244     (erc-put-text-property 0 (length erc-notice-prefix)
5245                            'face 'erc-notice-face s)
5246     s)
5247    ((eq erc-notice-highlight-type 'all)
5248     (erc-put-text-property 0 (length s) 'face 'erc-notice-face s)
5249     s)
5250    (t s)))
5251
5252 (defun erc-make-notice (message)
5253   "Notify the user of MESSAGE."
5254   (when erc-minibuffer-notice
5255     (message "%s" message))
5256   (erc-highlight-notice (concat erc-notice-prefix message)))
5257
5258 (defun erc-highlight-error (s)
5259   "Highlight error message S and return it."
5260   (erc-put-text-property 0 (length s) 'face 'erc-error-face s)
5261   s)
5262
5263 (defun erc-put-text-property (start end property value &optional object)
5264   "Set text-property for an object (usually a string).
5265 START and END define the characters covered.
5266 PROPERTY is the text-property set, usually the symbol `face'.
5267 VALUE is the value for the text-property, usually a face symbol such as
5268 the face `bold' or `erc-pal-face'.
5269 OBJECT is a string which will be modified and returned.
5270 OBJECT is modified without being copied first.
5271
5272 You can redefine or `defadvice' this function in order to add
5273 EmacsSpeak support."
5274   (put-text-property start end property value object))
5275
5276 (defun erc-list (thing)
5277   "Return THING if THING is a list, or a list with THING as its element."
5278   (if (listp thing)
5279       thing
5280     (list thing)))
5281
5282 (defun erc-parse-user (string)
5283   "Parse STRING as a user specification (nick!login@host).
5284
5285 Return a list of the three separate tokens."
5286   (cond
5287    ((string-match "^\\([^!\n]*\\)!\\([^@\n]*\\)@\\(.*\\)$" string)
5288     (list (match-string 1 string)
5289           (match-string 2 string)
5290           (match-string 3 string)))
5291    ;; Some bogus bouncers send Nick!(null), try to live with that.
5292    ((string-match "^\\([^!\n]*\\)!\\(.*\\)$" string)
5293     (list (match-string 1 string)
5294           ""
5295           (match-string 2 string)))
5296    (t
5297     (list string "" ""))))
5298
5299 (defun erc-extract-nick (string)
5300   "Return the nick corresponding to a user specification STRING.
5301
5302 See also `erc-parse-user'."
5303   (car (erc-parse-user string)))
5304
5305 (defun erc-put-text-properties (start end properties
5306                                       &optional object value-list)
5307   "Set text-properties for OBJECT.
5308
5309 START and END describe positions in OBJECT.
5310 If VALUE-LIST is nil, set each property in PROPERTIES to t, else set
5311 each property to the corresponding value in VALUE-LIST."
5312   (unless value-list
5313     (setq value-list (mapcar (lambda (_x) t)
5314                              properties)))
5315   (while (and properties value-list)
5316     (erc-put-text-property
5317      start end (pop properties) (pop value-list) object)))
5318
5319 ;;; Input area handling:
5320
5321 (defun erc-beg-of-input-line ()
5322   "Return the value of `point' at the beginning of the input line.
5323
5324 Specifically, return the position of `erc-insert-marker'."
5325   (or (and (boundp 'erc-insert-marker)
5326            (markerp erc-insert-marker))
5327       (error "erc-insert-marker has no value, please report a bug"))
5328   (marker-position erc-insert-marker))
5329
5330 (defun erc-end-of-input-line ()
5331   "Return the value of `point' at the end of the input line."
5332   (point-max))
5333
5334 (defvar erc-last-input-time 0
5335   "Time of last call to `erc-send-current-line'.
5336 If that function has never been called, the value is 0.")
5337
5338 (defcustom erc-accidental-paste-threshold-seconds nil
5339   "Minimum time, in seconds, before sending new lines via IRC.
5340 If the value is a number, `erc-send-current-line' signals an error
5341 if its previous invocation was fewer than this many seconds ago.
5342 This is useful so that if you accidentally enter large amounts of text
5343 into the ERC buffer, that text is not sent to the IRC server.
5344
5345 If the value is nil, `erc-send-current-line' always considers any
5346 submitted line to be intentional."
5347   :group 'erc
5348   :version "24.4"
5349   :type '(choice number (other :tag "disabled" nil)))
5350
5351 (defun erc-send-current-line ()
5352   "Parse current line and send it to IRC."
5353   (interactive)
5354   (let ((now (float-time)))
5355     (if (or (not erc-accidental-paste-threshold-seconds)
5356             (< erc-accidental-paste-threshold-seconds
5357                (- now erc-last-input-time)))
5358         (save-restriction
5359           (widen)
5360           (if (< (point) (erc-beg-of-input-line))
5361               (erc-error "Point is not in the input area")
5362             (let ((inhibit-read-only t)
5363                   (str (erc-user-input))
5364                   (old-buf (current-buffer)))
5365               (if (and (not (erc-server-buffer-live-p))
5366                        (not (erc-command-no-process-p str)))
5367                   (erc-error "ERC: No process running")
5368                 (erc-set-active-buffer (current-buffer))
5369                 ;; Kill the input and the prompt
5370                 (delete-region (erc-beg-of-input-line)
5371                                (erc-end-of-input-line))
5372                 (unwind-protect
5373                     (erc-send-input str)
5374                   ;; Fix the buffer if the command didn't kill it
5375                   (when (buffer-live-p old-buf)
5376                     (with-current-buffer old-buf
5377                       (save-restriction
5378                         (widen)
5379                         (goto-char (point-max))
5380                         (when (processp erc-server-process)
5381                           (set-marker (process-mark erc-server-process) (point)))
5382                         (set-marker erc-insert-marker (point))
5383                         (let ((buffer-modified (buffer-modified-p)))
5384                           (erc-display-prompt)
5385                           (set-buffer-modified-p buffer-modified))))))
5386
5387                 ;; Only when last hook has been run...
5388                 (run-hook-with-args 'erc-send-completed-hook str))))
5389           (setq erc-last-input-time now))
5390       (switch-to-buffer "*ERC Accidental Paste Overflow*")
5391       (lwarn 'erc :warning
5392              "You seem to have accidentally pasted some text!"))))
5393
5394 (defun erc-user-input ()
5395   "Return the input of the user in the current buffer."
5396   (buffer-substring-no-properties
5397    erc-input-marker
5398    (erc-end-of-input-line)))
5399
5400 (defvar erc-command-regexp "^/\\([A-Za-z']+\\)\\(\\s-+.*\\|\\s-*\\)$"
5401   "Regular expression used for matching commands in ERC.")
5402
5403 (defun erc-send-input (input)
5404   "Treat INPUT as typed in by the user.  It is assumed that the input
5405 and the prompt is already deleted.
5406 This returns non-nil only if we actually send anything."
5407   ;; Handle different kinds of inputs
5408   (cond
5409    ;; Ignore empty input
5410    ((if erc-send-whitespace-lines
5411         (string= input "")
5412       (string-match "\\`[ \t\r\f\n]*\\'" input))
5413     (when erc-warn-about-blank-lines
5414       (message "Blank line - ignoring...")
5415       (beep))
5416     nil)
5417    (t
5418     (defvar str) ;; FIXME: Make it obey the "erc-" prefix convention.
5419     (let ((str input)
5420           (erc-insert-this t))
5421       (setq erc-send-this t)
5422       (run-hook-with-args 'erc-send-pre-hook input)
5423       (when erc-send-this
5424         (if (or (string-match "\n" str)
5425                 (not (string-match erc-command-regexp str)))
5426             (mapc
5427              (lambda (line)
5428                (mapc
5429                 (lambda (line)
5430                   ;; Insert what has to be inserted for this.
5431                   (erc-display-msg line)
5432                   (erc-process-input-line (concat line "\n")
5433                                           (null erc-flood-protect) t))
5434                 (or (and erc-flood-protect (erc-split-line line))
5435                     (list line))))
5436              (split-string str "\n"))
5437           (erc-process-input-line (concat str "\n") t nil))
5438         t)))))
5439
5440 (defun erc-display-command (line)
5441   (when erc-insert-this
5442     (let ((insert-position (point)))
5443       (unless erc-hide-prompt
5444         (erc-display-prompt nil nil (erc-command-indicator)
5445                             (and (erc-command-indicator)
5446                                  'erc-command-indicator-face)))
5447       (let ((beg (point)))
5448         (insert line)
5449         (erc-put-text-property beg (point)
5450                                'face 'erc-command-indicator-face)
5451         (insert "\n"))
5452       (when (processp erc-server-process)
5453         (set-marker (process-mark erc-server-process) (point)))
5454       (set-marker erc-insert-marker (point))
5455       (save-excursion
5456         (save-restriction
5457           (narrow-to-region insert-position (point))
5458           (run-hooks 'erc-send-modify-hook)
5459           (run-hooks 'erc-send-post-hook))))))
5460
5461 (defun erc-display-msg (line)
5462   "Display LINE as a message of the user to the current target at the
5463 current position."
5464   (when erc-insert-this
5465     (let ((insert-position (point)))
5466       (insert (erc-format-my-nick))
5467       (let ((beg (point)))
5468         (insert line)
5469         (erc-put-text-property beg (point)
5470                                'face 'erc-input-face))
5471       (insert "\n")
5472       (when (processp erc-server-process)
5473         (set-marker (process-mark erc-server-process) (point)))
5474       (set-marker erc-insert-marker (point))
5475       (save-excursion
5476         (save-restriction
5477           (narrow-to-region insert-position (point))
5478           (run-hooks 'erc-send-modify-hook)
5479           (run-hooks 'erc-send-post-hook))))))
5480
5481 (defun erc-command-symbol (command)
5482   "Return the ERC command symbol for COMMAND if it exists and is bound."
5483   (let ((cmd (intern-soft (format "erc-cmd-%s" (upcase command)))))
5484     (when (fboundp cmd) cmd)))
5485
5486 (defun erc-extract-command-from-line (line)
5487   "Extract command and args from the input LINE.
5488 If no command was given, return nil.  If command matches, return a
5489 list of the form: (command args) where both elements are strings."
5490   (when (string-match erc-command-regexp line)
5491     (let* ((cmd (erc-command-symbol (match-string 1 line)))
5492            ;; note: return is nil, we apply this simply for side effects
5493            (_canon-defun (while (and cmd (symbolp (symbol-function cmd)))
5494                            (setq cmd (symbol-function cmd))))
5495            (cmd-fun (or cmd #'erc-cmd-default))
5496            (arg (if cmd
5497                     (if (get cmd-fun 'do-not-parse-args)
5498                         (format "%s" (match-string 2 line))
5499                       (delete "" (split-string (erc-trim-string
5500                                                 (match-string 2 line)) " ")))
5501                   line)))
5502       (list cmd-fun arg))))
5503
5504 (defun erc-split-multiline-safe (string)
5505   "Split STRING, containing multiple lines and return them in a list.
5506 Do it only for STRING as the complete input, do not carry unfinished
5507 strings over to the next call."
5508   (let ((l ())
5509         (i0 0)
5510         (doit t))
5511     (while doit
5512       (let ((i (string-match "\r?\n" string i0))
5513             (s (substring string i0)))
5514         (cond (i (setq l (cons (substring string i0 i) l))
5515                  (setq i0 (match-end 0)))
5516               ((> (length s) 0)
5517                (setq l (cons s l))(setq doit nil))
5518               (t (setq doit nil)))))
5519     (nreverse l)))
5520
5521 ;; nick handling
5522
5523 (defun erc-set-current-nick (nick)
5524   "Set the current nickname to NICK."
5525   (with-current-buffer (if (buffer-live-p (erc-server-buffer))
5526                            (erc-server-buffer)
5527                          (current-buffer))
5528     (setq erc-server-current-nick nick)))
5529
5530 (defun erc-current-nick ()
5531   "Return the current nickname."
5532   (with-current-buffer (if (buffer-live-p (erc-server-buffer))
5533                            (erc-server-buffer)
5534                          (current-buffer))
5535     erc-server-current-nick))
5536
5537 (defun erc-current-nick-p (nick)
5538   "Return non-nil if NICK is the current nickname."
5539   (erc-nick-equal-p nick (erc-current-nick)))
5540
5541 (defun erc-nick-equal-p (nick1 nick2)
5542   "Return non-nil if NICK1 and NICK2 are the same.
5543
5544 This matches strings according to the IRC protocol's case convention.
5545
5546 See also `erc-downcase'."
5547   (string= (erc-downcase nick1)
5548            (erc-downcase nick2)))
5549
5550 ;; default target handling
5551
5552 (defun erc-default-target ()
5553   "Return the current default target (as a character string) or nil if none."
5554   (let ((tgt (car erc-default-recipients)))
5555     (cond
5556      ((not tgt) nil)
5557      ((listp tgt) (cdr tgt))
5558      (t tgt))))
5559
5560 (defun erc-add-default-channel (channel)
5561   "Add CHANNEL to the default channel list."
5562   (let ((chl (downcase channel)))
5563     (setq erc-default-recipients
5564           (cons chl erc-default-recipients))))
5565
5566 (defun erc-delete-default-channel (channel &optional buffer)
5567   "Delete CHANNEL from the default channel list."
5568   (with-current-buffer (if (and buffer
5569                                 (bufferp buffer))
5570                            buffer
5571                          (current-buffer))
5572     (setq erc-default-recipients (delete (downcase channel)
5573                                          erc-default-recipients))))
5574
5575 (defun erc-add-query (nickname)
5576   "Add QUERY'd NICKNAME to the default channel list.
5577
5578 The previous default target of QUERY type gets removed."
5579   (let ((d1 (car erc-default-recipients))
5580         (d2 (cdr erc-default-recipients))
5581         (qt (cons 'QUERY (downcase nickname))))
5582     (setq erc-default-recipients (cons qt (if (and (listp d1)
5583                                                    (eq (car d1) 'QUERY))
5584                                               d2
5585                                             erc-default-recipients)))))
5586
5587 (defun erc-delete-query ()
5588   "Delete the topmost target if it is a QUERY."
5589
5590   (let ((d1 (car erc-default-recipients))
5591         (d2 (cdr erc-default-recipients)))
5592     (if (and (listp d1)
5593              (eq (car d1) 'QUERY))
5594         (setq erc-default-recipients d2)
5595       (error "Current target is not a QUERY"))))
5596
5597 (defun erc-ignored-user-p (spec)
5598   "Return non-nil if SPEC matches something in `erc-ignore-list'.
5599
5600 Takes a full SPEC of a user in the form \"nick!login@host\", and
5601 matches against all the regexp's in `erc-ignore-list'.  If any
5602 match, returns that regexp."
5603   (catch 'found
5604     (dolist (ignored (erc-with-server-buffer erc-ignore-list))
5605       (if (string-match ignored spec)
5606           (throw 'found ignored)))))
5607
5608 (defun erc-ignored-reply-p (msg tgt proc)
5609   ;; FIXME: this docstring needs fixing -- Lawrence 2004-01-08
5610   "Return non-nil if MSG matches something in `erc-ignore-reply-list'.
5611
5612 Takes a message MSG to a channel and returns non-nil if the addressed
5613 user matches any regexp in `erc-ignore-reply-list'."
5614   (let ((target-nick (erc-message-target msg)))
5615     (if (not target-nick)
5616         nil
5617       (erc-with-buffer (tgt proc)
5618         (let ((user (erc-get-server-user target-nick)))
5619           (when user
5620             (erc-list-match erc-ignore-reply-list
5621                             (erc-user-spec user))))))))
5622
5623 (defun erc-message-target (msg)
5624   "Return the addressed target in MSG.
5625
5626 The addressed target is the string before the first colon in MSG."
5627   (if (string-match "^\\([^: \n]*\\):" msg)
5628       (match-string 1 msg)
5629     nil))
5630
5631 (defun erc-user-spec (user)
5632   "Create a nick!user@host spec from a user struct."
5633   (let ((nick (erc-server-user-nickname user))
5634         (host (erc-server-user-host user))
5635         (login (erc-server-user-login user)))
5636     (concat (or nick "")
5637             "!"
5638             (or login "")
5639             "@"
5640             (or host ""))))
5641
5642 (defun erc-list-match (lst str)
5643   "Return non-nil if any regexp in LST matches STR."
5644   (memq nil (mapcar (lambda (regexp)
5645                       (not (string-match regexp str)))
5646                     lst)))
5647
5648 ;; other "toggles"
5649
5650 (defun erc-toggle-ctcp-autoresponse (&optional arg)
5651   "Toggle automatic CTCP replies (like VERSION and PING).
5652
5653 If ARG is positive, turns CTCP replies on.
5654
5655 If ARG is non-nil and not positive, turns CTCP replies off."
5656   (interactive "P")
5657   (cond ((and (numberp arg) (> arg 0))
5658          (setq erc-disable-ctcp-replies t))
5659         (arg (setq erc-disable-ctcp-replies nil))
5660         (t (setq erc-disable-ctcp-replies (not erc-disable-ctcp-replies))))
5661   (message "ERC CTCP replies are %s" (if erc-disable-ctcp-replies "OFF" "ON")))
5662
5663 (defun erc-toggle-flood-control (&optional arg)
5664   "Toggle use of flood control on sent messages.
5665
5666 If ARG is positive, use flood control.
5667 If ARG is non-nil and not positive, do not use flood control.
5668
5669 See `erc-server-flood-margin' for an explanation of the available
5670 flood control parameters."
5671   (interactive "P")
5672   (cond ((and (numberp arg) (> arg 0))
5673          (setq erc-flood-protect t))
5674         (arg (setq erc-flood-protect nil))
5675         (t (setq erc-flood-protect (not erc-flood-protect))))
5676   (message "ERC flood control is %s"
5677            (cond (erc-flood-protect "ON")
5678                  (t "OFF"))))
5679
5680 ;; Some useful channel and nick commands for fast key bindings
5681
5682 (defun erc-invite-only-mode (&optional arg)
5683   "Turn on the invite only mode (+i) for the current channel.
5684
5685 If ARG is non-nil, turn this mode off (-i).
5686
5687 This command is sent even if excess flood is detected."
5688   (interactive "P")
5689   (erc-set-active-buffer (current-buffer))
5690   (let ((tgt (erc-default-target)))
5691     (if (or (not tgt) (not (erc-channel-p tgt)))
5692         (erc-display-message nil 'error (current-buffer) 'no-target)
5693       (erc-load-irc-script-lines
5694        (list (concat "/mode " tgt (if arg " -i" " +i")))
5695        t))))
5696
5697 (defun erc-get-channel-mode-from-keypress (key)
5698   "Read a key sequence and call the corresponding channel mode function.
5699 After doing C-c C-o, type in a channel mode letter.
5700
5701 C-g means quit.
5702 RET lets you type more than one mode at a time.
5703 If \"l\" is pressed, `erc-set-channel-limit' gets called.
5704 If \"k\" is pressed, `erc-set-channel-key' gets called.
5705 Anything else will be sent to `erc-toggle-channel-mode'."
5706   (interactive "kChannel mode (RET to set more than one): ")
5707   (when (featurep 'xemacs)
5708     (setq key (char-to-string (event-to-character (aref key 0)))))
5709   (cond ((equal key "\C-g")
5710          (keyboard-quit))
5711         ((equal key "\C-m")
5712          (erc-insert-mode-command))
5713         ((equal key "l")
5714          (call-interactively 'erc-set-channel-limit))
5715         ((equal key "k")
5716          (call-interactively 'erc-set-channel-key))
5717         (t (erc-toggle-channel-mode key))))
5718
5719 (defun erc-toggle-channel-mode (mode &optional channel)
5720   "Toggle channel MODE.
5721
5722 If CHANNEL is non-nil, toggle MODE for that channel, otherwise use
5723 `erc-default-target'."
5724   (interactive "P")
5725   (erc-set-active-buffer (current-buffer))
5726   (let ((tgt (or channel (erc-default-target))))
5727     (if (or (null tgt) (null (erc-channel-p tgt)))
5728         (erc-display-message nil 'error 'active 'no-target)
5729       (let* ((active (member mode erc-channel-modes))
5730              (newstate (if active "OFF" "ON")))
5731         (erc-log (format "%s: Toggle mode %s %s" tgt mode newstate))
5732         (message "Toggle channel mode %s %s" mode newstate)
5733         (erc-server-send (format "MODE %s %s%s"
5734                                  tgt (if active "-" "+") mode))))))
5735
5736 (defun erc-insert-mode-command ()
5737   "Insert the line \"/mode <current target> \" at `point'."
5738   (interactive)
5739   (let ((tgt (erc-default-target)))
5740     (if tgt (insert (concat "/mode " tgt " "))
5741       (erc-display-message nil 'error (current-buffer) 'no-target))))
5742
5743 (defun erc-channel-names ()
5744   "Run \"/names #channel\" in the current channel."
5745   (interactive)
5746   (erc-set-active-buffer (current-buffer))
5747   (let ((tgt (erc-default-target)))
5748     (if tgt (erc-load-irc-script-lines (list (concat "/names " tgt)))
5749       (erc-display-message nil 'error (current-buffer) 'no-target))))
5750
5751 (defun erc-remove-text-properties-region (start end &optional object)
5752   "Clears the region (START,END) in OBJECT from all colors, etc."
5753   (interactive "r")
5754   (save-excursion
5755     (let ((inhibit-read-only t))
5756       (set-text-properties start end nil object))))
5757 (put 'erc-remove-text-properties-region 'disabled t)
5758
5759 ;; script execution and startup
5760
5761 (defun erc-find-file (file &optional path)
5762   "Search for a FILE in the filesystem.
5763 First the `default-directory' is searched for FILE, then any directories
5764 specified in the list PATH.
5765
5766 If FILE is found, return the path to it."
5767   (let ((filepath file))
5768     (if (file-readable-p filepath) filepath
5769       (while (and path
5770                   (progn (setq filepath (expand-file-name file (car path)))
5771                          (not (file-readable-p filepath))))
5772         (setq path (cdr path)))
5773       (if path filepath nil))))
5774
5775 (defun erc-select-startup-file ()
5776   "Select an ERC startup file.
5777 See also `erc-startup-file-list'."
5778   (catch 'found
5779     (dolist (f erc-startup-file-list)
5780       (setq f (convert-standard-filename f))
5781       (when (file-readable-p f)
5782         (throw 'found f)))))
5783
5784 (defun erc-find-script-file (file)
5785   "Search for FILE in `default-directory', and any in `erc-script-path'."
5786   (erc-find-file file erc-script-path))
5787
5788 (defun erc-load-script (file)
5789   "Load a script from FILE.
5790
5791 FILE must be the full name, it is not searched in the
5792 `erc-script-path'.  If the filename ends with `.el', then load it
5793 as an Emacs Lisp program.  Otherwise, treat it as a regular IRC
5794 script."
5795   (erc-log (concat "erc-load-script: " file))
5796   (cond
5797    ((string-match "\\.el\\'" file)
5798     (load file))
5799    (t
5800     (erc-load-irc-script file))))
5801
5802 (defun erc-process-script-line (line &optional args)
5803   "Process an IRC script LINE.
5804
5805 Does script-specific substitutions (script arguments, current nick,
5806 server, etc.) in LINE and returns it.
5807
5808 Substitutions are: %C and %c = current target (channel or nick),
5809 %S %s = current server, %N %n = my current nick, and %x is x verbatim,
5810 where x is any other character;
5811 $* = the entire argument string, $1 = the first argument, $2 = the second,
5812 and so on."
5813   (if (not args) (setq args ""))
5814   (let* ((arg-esc-regexp "\\(\\$\\(\\*\\|[1-9][0-9]*\\)\\)\\([^0-9]\\|$\\)")
5815          (percent-regexp "\\(%.\\)")
5816          (esc-regexp (concat arg-esc-regexp "\\|" percent-regexp))
5817          (tgt (erc-default-target))
5818          (server (and (boundp 'erc-session-server) erc-session-server))
5819          (nick (erc-current-nick))
5820          (res "")
5821          (tmp nil)
5822          (arg-list nil)
5823          (arg-num 0))
5824     (if (not tgt) (setq tgt ""))
5825     (if (not server) (setq server ""))
5826     (if (not nick) (setq nick ""))
5827     ;; First, compute the argument list
5828     (setq tmp args)
5829     (while (string-match "^\\s-*\\(\\S-+\\)\\(\\s-+.*$\\|$\\)" tmp)
5830       (setq arg-list (cons (match-string 1 tmp) arg-list))
5831       (setq tmp (match-string 2 tmp)))
5832     (setq arg-list (nreverse arg-list))
5833     (setq arg-num (length arg-list))
5834     ;; now do the substitution
5835     (setq tmp (string-match esc-regexp line))
5836     (while tmp
5837       ;;(message "beginning of while: tmp=%S" tmp)
5838       (let* ((hd (substring line 0 tmp))
5839              (esc "")
5840              (subst "")
5841              (tail (substring line tmp)))
5842         (cond ((string-match (concat "^" arg-esc-regexp) tail)
5843                (setq esc (match-string 1 tail))
5844                (setq tail (substring tail (match-end 1))))
5845               ((string-match (concat "^" percent-regexp) tail)
5846                (setq esc (match-string 1 tail))
5847                (setq tail (substring tail (match-end 1)))))
5848         ;;(message "hd=%S, esc=%S, tail=%S, arg-num=%S" hd esc tail arg-num)
5849         (setq res (concat res hd))
5850         (setq subst
5851               (cond ((string= esc "") "")
5852                     ((string-match "^\\$\\*$" esc) args)
5853                     ((string-match "^\\$\\([0-9]+\\)$" esc)
5854                      (let ((n (string-to-number (match-string 1 esc))))
5855                        (message "n = %S, integerp(n)=%S" n (integerp n))
5856                        (if (<= n arg-num) (nth (1- n) arg-list) "")))
5857                     ((string-match "^%[Cc]$" esc) tgt)
5858                     ((string-match "^%[Ss]$" esc) server)
5859                     ((string-match "^%[Nn]$" esc) nick)
5860                     ((string-match "^%\\(.\\)$" esc) (match-string 1 esc))
5861                     (t (erc-log (format "BUG in erc-process-script-line: bad escape sequence: %S\n" esc))
5862                        (message "BUG IN ERC: esc=%S" esc)
5863                        "")))
5864         (setq line tail)
5865         (setq tmp (string-match esc-regexp line))
5866         (setq res (concat res subst))
5867         ;;(message "end of while: line=%S, res=%S, tmp=%S" line res tmp)
5868         ))
5869     (setq res (concat res line))
5870     res))
5871
5872 (defun erc-load-irc-script (file &optional force)
5873   "Load an IRC script from FILE."
5874   (erc-log (concat "erc-load-script: " file))
5875   (let ((str (with-temp-buffer
5876                (insert-file-contents file)
5877                (buffer-string))))
5878     (erc-load-irc-script-lines (erc-split-multiline-safe str) force)))
5879
5880 (defun erc-load-irc-script-lines (lines &optional force noexpand)
5881   "Load IRC script LINES (a list of strings).
5882
5883 If optional NOEXPAND is non-nil, do not expand script-specific
5884 sequences, process the lines verbatim.  Use this for multiline
5885 user input."
5886   (let* ((cb (current-buffer))
5887          (s "")
5888          (sp (or (erc-command-indicator) (erc-prompt)))
5889          (args (and (boundp 'erc-script-args) erc-script-args)))
5890     (if (and args (string-match "^ " args))
5891         (setq args (substring args 1)))
5892     ;; prepare the prompt string for echo
5893     (erc-put-text-property 0 (length sp)
5894                            'face 'erc-command-indicator-face sp)
5895     (while lines
5896       (setq s (car lines))
5897       (erc-log (concat "erc-load-script: CMD: " s))
5898       (unless (string-match "^\\s-*$" s)
5899         (let ((line (if noexpand s (erc-process-script-line s args))))
5900           (if (and (erc-process-input-line line force)
5901                    erc-script-echo)
5902               (progn
5903                 (erc-put-text-property 0 (length line)
5904                                        'face 'erc-input-face line)
5905                 (erc-display-line (concat sp line) cb)))))
5906       (setq lines (cdr lines)))))
5907
5908 ;; authentication
5909
5910 (defun erc-login ()
5911   "Perform user authentication at the IRC server."
5912   (erc-log (format "login: nick: %s, user: %s %s %s :%s"
5913                    (erc-current-nick)
5914                    (user-login-name)
5915                    (or erc-system-name (system-name))
5916                    erc-session-server
5917                    erc-session-user-full-name))
5918   (if erc-session-password
5919       (erc-server-send (format "PASS %s" erc-session-password))
5920     (message "Logging in without password"))
5921   (erc-server-send (format "NICK %s" (erc-current-nick)))
5922   (erc-server-send
5923    (format "USER %s %s %s :%s"
5924            ;; hacked - S.B.
5925            (if erc-anonymous-login erc-email-userid (user-login-name))
5926            "0" "*"
5927            erc-session-user-full-name))
5928   (erc-update-mode-line))
5929
5930 ;; connection properties' heuristics
5931
5932 (defun erc-determine-parameters (&optional server port nick name)
5933   "Determine the connection and authentication parameters.
5934 Sets the buffer local variables:
5935
5936 - `erc-session-connector'
5937 - `erc-session-server'
5938 - `erc-session-port'
5939 - `erc-session-full-name'
5940 - `erc-server-current-nick'"
5941   (setq erc-session-connector erc-server-connect-function
5942         erc-session-server (erc-compute-server server)
5943         erc-session-port (or port erc-default-port)
5944         erc-session-user-full-name (erc-compute-full-name name))
5945   (erc-set-current-nick (erc-compute-nick nick)))
5946
5947 (defun erc-compute-server (&optional server)
5948   "Return an IRC server name.
5949
5950 This tries a number of increasingly more default methods until a
5951 non-nil value is found.
5952
5953 - SERVER (the argument passed to this function)
5954 - The `erc-server' option
5955 - The value of the IRCSERVER environment variable
5956 - The `erc-default-server' variable"
5957   (or server
5958       erc-server
5959       (getenv "IRCSERVER")
5960       erc-default-server))
5961
5962 (defun erc-compute-nick (&optional nick)
5963   "Return user's IRC nick.
5964
5965 This tries a number of increasingly more default methods until a
5966 non-nil value is found.
5967
5968 - NICK (the argument passed to this function)
5969 - The `erc-nick' option
5970 - The value of the IRCNICK environment variable
5971 - The result from the `user-login-name' function"
5972   (or nick
5973       (if (consp erc-nick) (car erc-nick) erc-nick)
5974       (getenv "IRCNICK")
5975       (user-login-name)))
5976
5977
5978 (defun erc-compute-full-name (&optional full-name)
5979   "Return user's full name.
5980
5981 This tries a number of increasingly more default methods until a
5982 non-nil value is found.
5983
5984 - FULL-NAME (the argument passed to this function)
5985 - The `erc-user-full-name' option
5986 - The value of the IRCNAME environment variable
5987 - The result from the `user-full-name' function"
5988   (or full-name
5989       erc-user-full-name
5990       (getenv "IRCNAME")
5991       (if erc-anonymous-login "unknown" nil)
5992       (user-full-name)))
5993
5994 (defun erc-compute-port (&optional port)
5995   "Return a port for an IRC server.
5996
5997 This tries a number of increasingly more default methods until a
5998 non-nil value is found.
5999
6000 - PORT (the argument passed to this function)
6001 - The `erc-port' option
6002 - The `erc-default-port' variable"
6003   (or port erc-port erc-default-port))
6004
6005 ;; time routines
6006
6007 (defun erc-string-to-emacs-time (string)
6008   "Convert the long number represented by STRING into an Emacs format.
6009 Returns a list of the form (HIGH LOW), compatible with Emacs time format."
6010   (let* ((n (string-to-number (concat string ".0"))))
6011     (list (truncate (/ n 65536))
6012           (truncate (mod n 65536)))))
6013
6014 (defalias 'erc-emacs-time-to-erc-time
6015   (if (featurep 'xemacs) 'time-to-seconds 'float-time))
6016
6017 (defalias 'erc-current-time 'erc-emacs-time-to-erc-time)
6018
6019 (defun erc-time-diff (t1 t2)
6020   "Return the time difference in seconds between T1 and T2."
6021   (abs (- t2 t1)))
6022
6023 (defun erc-time-gt (t1 t2)
6024   "Check whether T1 > T2."
6025   (> t1 t2))
6026
6027 (defun erc-sec-to-time (ns)
6028   "Convert NS to a time string HH:MM.SS."
6029   (setq ns (truncate ns))
6030   (format "%02d:%02d.%02d"
6031           (/ ns 3600)
6032           (/ (% ns 3600) 60)
6033           (% ns 60)))
6034
6035 (defun erc-seconds-to-string (seconds)
6036   "Convert a number of SECONDS into an English phrase."
6037   (let (days hours minutes format-args output)
6038     (setq days          (/ seconds 86400)
6039           seconds       (% seconds 86400)
6040           hours         (/ seconds 3600)
6041           seconds       (% seconds 3600)
6042           minutes       (/ seconds 60)
6043           seconds       (% seconds 60)
6044           format-args   (if (> days 0)
6045                             `("%d days, %d hours, %d minutes, %d seconds"
6046                               ,days ,hours ,minutes ,seconds)
6047                           (if (> hours 0)
6048                               `("%d hours, %d minutes, %d seconds"
6049                                 ,hours ,minutes ,seconds)
6050                             (if (> minutes 0)
6051                                 `("%d minutes, %d seconds" ,minutes ,seconds)
6052                               `("%d seconds" ,seconds))))
6053           output        (apply #'format format-args))
6054     ;; Change all "1 units" to "1 unit".
6055     (while (string-match "\\([^0-9]\\|^\\)1 \\S-+\\(s\\)" output)
6056       (setq output (erc-replace-match-subexpression-in-string
6057                     "" output (match-string 2 output) 2 (match-beginning 2))))
6058     output))
6059
6060
6061 ;; info
6062
6063 (defconst erc-clientinfo-alist
6064   '(("ACTION" . "is used to inform about one's current activity")
6065     ("CLIENTINFO" . "gives help on CTCP commands supported by client")
6066     ("ECHO" . "echoes its arguments back")
6067     ("FINGER" . "shows user's name, location, and idle time")
6068     ("PING" . "measures delay between peers")
6069     ("TIME" . "shows client-side time")
6070     ("USERINFO" . "shows information provided by a user")
6071     ("VERSION" . "shows client type and version"))
6072   "Alist of CTCP CLIENTINFO for ERC commands.")
6073
6074 (defun erc-client-info (s)
6075   "Return CTCP CLIENTINFO on command S.
6076 If S is nil or an empty string then return general CLIENTINFO."
6077   (if (or (not s) (string= s ""))
6078       (concat
6079        (apply #'concat
6080               (mapcar (lambda (e)
6081                         (concat (car e) " "))
6082                       erc-clientinfo-alist))
6083        ": use CLIENTINFO <COMMAND> to get more specific information")
6084     (let ((h (assoc (upcase s) erc-clientinfo-alist)))
6085       (if h
6086           (concat s " " (cdr h))
6087         (concat s ": unknown command")))))
6088
6089 ;; Hook functions
6090
6091 (defun erc-directory-writable-p (dir)
6092   "Determine whether DIR is a writable directory.
6093 If it doesn't exist, create it."
6094   (unless (file-attributes dir) (make-directory dir))
6095   (or (file-accessible-directory-p dir) (error "Cannot access %s" dir)))
6096
6097 (defun erc-kill-query-buffers (process)
6098   "Kill all buffers of PROCESS.
6099 Does nothing if PROCESS is not a process object."
6100   ;; here, we only want to match the channel buffers, to avoid
6101   ;; "selecting killed buffers" b0rkage.
6102   (when (processp process)
6103     (erc-with-all-buffers-of-server process
6104       (lambda ()
6105         (not (erc-server-buffer-p)))
6106       (kill-buffer (current-buffer)))))
6107
6108 (defun erc-nick-at-point ()
6109   "Give information about the nickname at `point'.
6110
6111 If called interactively, give a human readable message in the
6112 minibuffer.  If called programmatically, return the corresponding
6113 entry of `channel-members'."
6114   (interactive)
6115   (require 'thingatpt)
6116   (let* ((word (word-at-point))
6117          (channel-data (erc-get-channel-user word))
6118          (cuser (cdr channel-data))
6119          (user (if channel-data
6120                    (car channel-data)
6121                  (erc-get-server-user word)))
6122          host login full-name nick voice halfop op admin owner)
6123     (when user
6124       (setq nick (erc-server-user-nickname user)
6125             host (erc-server-user-host user)
6126             login (erc-server-user-login user)
6127             full-name (erc-server-user-full-name user))
6128       (if cuser
6129           (setq voice (erc-channel-user-voice cuser)
6130                 halfop (erc-channel-user-halfop cuser)
6131                 op (erc-channel-user-op cuser)
6132                 admin (erc-channel-user-admin cuser)
6133                 owner (erc-channel-user-owner cuser))))
6134     (if (called-interactively-p 'interactive)
6135         (message "%s is %s@%s%s%s"
6136                  nick login host
6137                  (if full-name (format " (%s)" full-name) "")
6138                  (if (or voice halfop op admin owner)
6139                      (format " and is +%s%s%s%s%s on %s"
6140                              (if voice "v" "")
6141                              (if halfop "h" "")
6142                              (if op "o" "")
6143                              (if admin "a" "")
6144                              (if owner "q" "")
6145                              (erc-default-target))
6146                    ""))
6147       user)))
6148
6149 (defun erc-away-time ()
6150   "Return non-nil if the current ERC process is set away.
6151
6152 In particular, the time that we were set away is returned.
6153 See `current-time' for details on the time format."
6154   (erc-with-server-buffer erc-away))
6155
6156 ;; Mode line handling
6157
6158 (defcustom erc-mode-line-format "%S %a"
6159   "A string to be formatted and shown in the mode-line in `erc-mode'.
6160
6161 The string is formatted using `format-spec' and the result is set as the value
6162 of `mode-line-buffer-identification'.
6163
6164 The following characters are replaced:
6165 %a: String indicating away status or \"\" if you are not away
6166 %l: The estimated lag time to the server
6167 %m: The modes of the channel
6168 %n: The current nick name
6169 %N: The name of the network
6170 %o: The topic of the channel
6171 %p: The session port
6172 %t: The name of the target (channel, nickname, or servername:port)
6173 %s: In the server-buffer, this gets filled with the value of
6174     `erc-server-announced-name', in a channel, the value of
6175     (erc-default-target) also get concatenated.
6176 %S: In the server-buffer, this gets filled with the value of
6177     `erc-network', in a channel, the value of (erc-default-target)
6178     also get concatenated."
6179   :group 'erc-mode-line-and-header
6180   :type 'string)
6181
6182 (defcustom erc-header-line-format "%n on %t (%m,%l) %o"
6183   "A string to be formatted and shown in the header-line in `erc-mode'.
6184 Only used starting in Emacs 21.
6185
6186 Set this to nil if you do not want the header line to be
6187 displayed.
6188
6189 See `erc-mode-line-format' for which characters are can be used."
6190   :group 'erc-mode-line-and-header
6191   :set (lambda (sym val)
6192          (set sym val)
6193          (when (fboundp 'erc-update-mode-line)
6194            (erc-update-mode-line nil)))
6195   :type '(choice (const :tag "Disabled" nil)
6196                  string))
6197
6198 (defcustom erc-header-line-uses-tabbar-p nil
6199   "Use tabbar mode instead of the header line to display the header."
6200   :group 'erc-mode-line-and-header
6201   :type 'boolean)
6202
6203 (defcustom erc-header-line-uses-help-echo-p t
6204   "Show the contents of the header line in the echo area or as a tooltip
6205 when you move point into the header line."
6206   :group 'erc-mode-line-and-header
6207   :type 'boolean)
6208
6209 (defcustom erc-header-line-face-method nil
6210   "Determine what method to use when colorizing the header line text.
6211
6212 If nil, don't colorize the header text.
6213 If given a function, call it and use the resulting face name.
6214 Otherwise, use the `erc-header-line' face."
6215   :group 'erc-mode-line-and-header
6216   :type '(choice (const :tag "Don't colorize" nil)
6217                  (const :tag "Use the erc-header-line face" t)
6218                  (function :tag "Call a function")))
6219
6220 (defcustom erc-show-channel-key-p t
6221   "Show the channel key in the header line."
6222   :group 'erc-paranoia
6223   :type 'boolean)
6224
6225 (defcustom erc-mode-line-away-status-format
6226   "(AWAY since %a %b %d %H:%M) "
6227   "When you're away on a server, this is shown in the mode line.
6228 This should be a string with substitution variables recognized by
6229 `format-time-string'."
6230   :group 'erc-mode-line-and-header
6231   :type 'string)
6232
6233 (defun erc-shorten-server-name (server-name)
6234   "Shorten SERVER-NAME according to `erc-common-server-suffixes'."
6235   (if (stringp server-name)
6236       (with-temp-buffer
6237         (insert server-name)
6238         (let ((alist erc-common-server-suffixes))
6239           (while alist
6240             (goto-char (point-min))
6241             (if (re-search-forward (caar alist) nil t)
6242                 (replace-match (cdar alist)))
6243             (setq alist (cdr alist))))
6244         (buffer-string))))
6245
6246 (defun erc-format-target ()
6247   "Return the name of the target (channel or nickname or servername:port)."
6248   (let ((target (erc-default-target)))
6249     (or target
6250         (concat (erc-shorten-server-name
6251                  (or erc-server-announced-name
6252                      erc-session-server))
6253                 ":" (erc-port-to-string erc-session-port)))))
6254
6255 (defun erc-format-target-and/or-server ()
6256   "Return the server name or the current target and server name combined."
6257   (let ((server-name (erc-shorten-server-name
6258                       (or erc-server-announced-name
6259                           erc-session-server))))
6260     (cond ((erc-default-target)
6261            (concat (erc-string-no-properties (erc-default-target))
6262                    "@" server-name))
6263           (server-name server-name)
6264           (t (buffer-name (current-buffer))))))
6265
6266 (defun erc-format-network ()
6267   "Return the name of the network we are currently on."
6268   (let ((network (and (fboundp 'erc-network-name) (erc-network-name))))
6269     (if (and network (symbolp network))
6270         (symbol-name network)
6271       "")))
6272
6273 (defun erc-format-target-and/or-network ()
6274   "Return the network or the current target and network combined.
6275 If the name of the network is not available, then use the
6276 shortened server name instead."
6277   (let ((network-name (or (and (fboundp 'erc-network-name) (erc-network-name))
6278                           (erc-shorten-server-name
6279                            (or erc-server-announced-name
6280                                erc-session-server)))))
6281     (when (and network-name (symbolp network-name))
6282       (setq network-name (symbol-name network-name)))
6283     (cond ((erc-default-target)
6284            (concat (erc-string-no-properties (erc-default-target))
6285                    "@" network-name))
6286           ((and network-name
6287                 (not (get-buffer network-name)))
6288            (when erc-rename-buffers
6289              (rename-buffer network-name))
6290            network-name)
6291           (t (buffer-name (current-buffer))))))
6292
6293 (defun erc-format-away-status ()
6294   "Return a formatted `erc-mode-line-away-status-format'
6295 if `erc-away' is non-nil."
6296   (let ((a (erc-away-time)))
6297     (if a
6298         (format-time-string erc-mode-line-away-status-format a)
6299       "")))
6300
6301 (defun erc-format-channel-modes ()
6302   "Return the current channel's modes."
6303   (concat (apply #'concat
6304                  "+" erc-channel-modes)
6305           (cond ((and erc-channel-user-limit erc-channel-key)
6306                  (if erc-show-channel-key-p
6307                      (format "lk %.0f %s" erc-channel-user-limit
6308                              erc-channel-key)
6309                    (format "kl %.0f" erc-channel-user-limit)))
6310                 (erc-channel-user-limit
6311                  ;; Emacs has no bignums
6312                  (format "l %.0f" erc-channel-user-limit))
6313                 (erc-channel-key
6314                  (if erc-show-channel-key-p
6315                      (format "k %s" erc-channel-key)
6316                    "k"))
6317                 (t nil))))
6318
6319 (defun erc-format-lag-time ()
6320   "Return the estimated lag time to server, `erc-server-lag'."
6321   (let ((lag (erc-with-server-buffer erc-server-lag)))
6322     (cond (lag (format "lag:%.0f" lag))
6323           (t ""))))
6324
6325 ;; erc-goodies is required at end of this file.
6326 (declare-function erc-controls-strip "erc-goodies" (str))
6327
6328 (defvar tabbar--local-hlf)
6329
6330 (defun erc-update-mode-line-buffer (buffer)
6331   "Update the mode line in a single ERC buffer BUFFER."
6332   (with-current-buffer buffer
6333     (let ((spec (format-spec-make
6334                  ?a (erc-format-away-status)
6335                  ?l (erc-format-lag-time)
6336                  ?m (erc-format-channel-modes)
6337                  ?n (or (erc-current-nick) "")
6338                  ?N (erc-format-network)
6339                  ?o (or (erc-controls-strip erc-channel-topic) "")
6340                  ?p (erc-port-to-string erc-session-port)
6341                  ?s (erc-format-target-and/or-server)
6342                  ?S (erc-format-target-and/or-network)
6343                  ?t (erc-format-target)))
6344           (process-status (cond ((and (erc-server-process-alive)
6345                                       (not erc-server-connected))
6346                                  ":connecting")
6347                                 ((erc-server-process-alive)
6348                                  "")
6349                                 (t
6350                                  ": CLOSED")))
6351           (face (cond ((eq erc-header-line-face-method nil)
6352                        nil)
6353                       ((functionp erc-header-line-face-method)
6354                        (funcall erc-header-line-face-method))
6355                       (t
6356                        'erc-header-line))))
6357       (cond ((featurep 'xemacs)
6358              (setq modeline-buffer-identification
6359                    (list (format-spec erc-mode-line-format spec)))
6360              (setq modeline-process (list process-status)))
6361             (t
6362              (setq mode-line-buffer-identification
6363                    (list (format-spec erc-mode-line-format spec)))
6364              (setq mode-line-process (list process-status))))
6365       (when (boundp 'header-line-format)
6366         (let ((header (if erc-header-line-format
6367                           (format-spec erc-header-line-format spec)
6368                         nil)))
6369           (cond (erc-header-line-uses-tabbar-p
6370                  (set (make-local-variable 'tabbar--local-hlf)
6371                       header-line-format)
6372                  (kill-local-variable 'header-line-format))
6373                 ((null header)
6374                  (setq header-line-format nil))
6375                 (erc-header-line-uses-help-echo-p
6376                  (let ((help-echo (with-temp-buffer
6377                                     (insert header)
6378                                     (fill-region (point-min) (point-max))
6379                                     (buffer-string))))
6380                    (setq header-line-format
6381                          (erc-replace-regexp-in-string
6382                           "%"
6383                           "%%"
6384                           (if face
6385                               (erc-propertize header 'help-echo help-echo
6386                                               'face face)
6387                             (erc-propertize header 'help-echo help-echo))))))
6388                 (t (setq header-line-format
6389                          (if face
6390                              (erc-propertize header 'face face)
6391                            header)))))))
6392     (if (featurep 'xemacs)
6393         (redraw-modeline)
6394       (force-mode-line-update))))
6395
6396 (defun erc-update-mode-line (&optional buffer)
6397   "Update the mode line in BUFFER.
6398
6399 If BUFFER is nil, update the mode line in all ERC buffers."
6400   (if (and buffer (bufferp buffer))
6401       (erc-update-mode-line-buffer buffer)
6402     (dolist (buf (erc-buffer-list))
6403       (when (buffer-live-p buf)
6404         (erc-update-mode-line-buffer buf)))))
6405
6406 ;; Miscellaneous
6407
6408 (defun erc-port-to-string (p)
6409   "Convert port P to a string.
6410 P may be an integer or a service name."
6411   (if (integerp p)
6412       (int-to-string p)
6413     p))
6414
6415 (defun erc-string-to-port (s)
6416   "Convert string S to either an integer port number or a service name."
6417   (if (numberp s)
6418       s
6419     (let ((n (string-to-number s)))
6420       (if (= n 0)
6421           s
6422         n))))
6423
6424 (defun erc-version (&optional here)
6425   "Show the version number of ERC in the minibuffer.
6426 If optional argument HERE is non-nil, insert version number at point."
6427   (interactive "P")
6428   (let ((version-string
6429          (format "ERC (IRC client for Emacs %s)" emacs-version)))
6430     (if here
6431         (insert version-string)
6432       (if (called-interactively-p 'interactive)
6433           (message "%s" version-string)
6434         version-string))))
6435
6436 (defun erc-modes (&optional here)
6437   "Show the active ERC modes in the minibuffer.
6438 If optional argument HERE is non-nil, insert version number at point."
6439   (interactive "P")
6440   (let ((string
6441          (mapconcat 'identity
6442                     (let (modes (case-fold-search nil))
6443                       (dolist (var (apropos-internal "^erc-.*mode$"))
6444                         (when (and (boundp var)
6445                                    (symbol-value var))
6446                           (setq modes (cons (symbol-name var)
6447                                             modes))))
6448                       modes)
6449                     ", ")))
6450     (if here
6451         (insert string)
6452       (if (called-interactively-p 'interactive)
6453           (message "%s" string)
6454         string))))
6455
6456 (defun erc-trim-string (s)
6457   "Trim leading and trailing spaces off S."
6458   (cond
6459    ((not (stringp s)) nil)
6460    ((string-match "^\\s-*$" s)
6461     "")
6462    ((string-match "^\\s-*\\(.*\\S-\\)\\s-*$" s)
6463     (match-string 1 s))
6464    (t
6465     s)))
6466
6467 (defun erc-arrange-session-in-multiple-windows ()
6468   "Open a window for every non-server buffer related to `erc-session-server'.
6469
6470 All windows are opened in the current frame."
6471   (interactive)
6472   (unless erc-server-process
6473     (error "No erc-server-process found in current buffer"))
6474   (let ((bufs (erc-buffer-list nil erc-server-process)))
6475     (when bufs
6476       (delete-other-windows)
6477       (switch-to-buffer (car bufs))
6478       (setq bufs (cdr bufs))
6479       (while bufs
6480         (split-window)
6481         (other-window 1)
6482         (switch-to-buffer (car bufs))
6483         (setq bufs (cdr bufs))
6484         (balance-windows)))))
6485
6486 (defun erc-popup-input-buffer ()
6487   "Provide an input buffer."
6488   (interactive)
6489   (let ((buffer-name (generate-new-buffer-name "*ERC input*"))
6490         (mode (intern
6491                (completing-read
6492                 "Mode: "
6493                 (mapcar (lambda (e)
6494                           (list (symbol-name e)))
6495                         (apropos-internal "-mode\\'" 'commandp))
6496                 nil t))))
6497     (pop-to-buffer (make-indirect-buffer (current-buffer) buffer-name))
6498     (funcall mode)
6499     (narrow-to-region (point) (point))
6500     (shrink-window-if-larger-than-buffer)))
6501
6502 ;;; Message catalog
6503
6504 (defun erc-make-message-variable-name (catalog entry)
6505   "Create a variable name corresponding to CATALOG's ENTRY."
6506   (intern (concat "erc-message-"
6507                   (symbol-name catalog) "-" (symbol-name entry))))
6508
6509 (defun erc-define-catalog-entry (catalog entry format-spec)
6510   "Set CATALOG's ENTRY to FORMAT-SPEC."
6511   (set (erc-make-message-variable-name catalog entry)
6512        format-spec))
6513
6514 (defun erc-define-catalog (catalog entries)
6515   "Define a CATALOG according to ENTRIES."
6516   (dolist (entry entries)
6517     (erc-define-catalog-entry catalog (car entry) (cdr entry))))
6518
6519 (erc-define-catalog
6520  'english
6521  '((bad-ping-response . "Unexpected PING response from %n (time %t)")
6522    (bad-syntax . "Error occurred - incorrect usage?\n%c %u\n%d")
6523    (incorrect-args . "Incorrect arguments. Usage:\n%c %u\n%d")
6524    (cannot-find-file . "Cannot find file %f")
6525    (cannot-read-file . "Cannot read file %f")
6526    (connect . "Connecting to %S:%p... ")
6527    (country . "%c")
6528    (country-unknown . "%d: No such domain")
6529    (ctcp-empty . "Illegal empty CTCP query received from %n. Ignoring.")
6530    (ctcp-request . "==> CTCP request from %n (%u@%h): %r")
6531    (ctcp-request-to . "==> CTCP request from %n (%u@%h) to %t: %r")
6532    (ctcp-too-many . "Too many CTCP queries in single message. Ignoring")
6533    (flood-ctcp-off . "FLOOD PROTECTION: Automatic CTCP responses turned off.")
6534    (flood-strict-mode
6535     . "FLOOD PROTECTION: Switched to Strict Flood Control mode.")
6536    (disconnected . "\n\nConnection failed!  Re-establishing connection...\n")
6537    (disconnected-noreconnect
6538     . "\n\nConnection failed!  Not re-establishing connection.\n")
6539    (finished . "\n\n*** ERC finished ***\n")
6540    (terminated . "\n\n*** ERC terminated: %e\n")
6541    (login . "Logging in as `%n'...")
6542    (nick-in-use . "%n is in use. Choose new nickname: ")
6543    (nick-too-long
6544     . "WARNING: Nick length (%i) exceeds max NICKLEN(%l) defined by server")
6545    (no-default-channel . "No default channel")
6546    (no-invitation . "You've got no invitation")
6547    (no-target . "No target")
6548    (ops . "%i operator%s: %o")
6549    (ops-none . "No operators in this channel.")
6550    (undefined-ctcp . "Undefined CTCP query received. Silently ignored")
6551    (variable-not-bound . "Variable not bound!")
6552    (ACTION . "* %n %a")
6553    (CTCP-CLIENTINFO . "Client info for %n: %m")
6554    (CTCP-ECHO . "Echo %n: %m")
6555    (CTCP-FINGER . "Finger info for %n: %m")
6556    (CTCP-PING . "Ping time to %n is %t")
6557    (CTCP-TIME . "Time by %n is %m")
6558    (CTCP-UNKNOWN . "Unknown CTCP message from %n (%u@%h): %m")
6559    (CTCP-VERSION . "Version for %n is %m")
6560    (ERROR  . "==> ERROR from %s: %c\n")
6561    (INVITE . "%n (%u@%h) invites you to channel %c")
6562    (JOIN   . "%n (%u@%h) has joined channel %c")
6563    (JOIN-you . "You have joined channel %c")
6564    (KICK . "%n (%u@%h) has kicked %k off channel %c: %r")
6565    (KICK-you . "You have been kicked off channel %c by %n (%u@%h): %r")
6566    (KICK-by-you . "You have kicked %k off channel %c: %r")
6567    (MODE   . "%n (%u@%h) has changed mode for %t to %m")
6568    (MODE-nick . "%n has changed mode for %t to %m")
6569    (NICK   . "%n (%u@%h) is now known as %N")
6570    (NICK-you . "Your new nickname is %N")
6571    (PART   . erc-message-english-PART)
6572    (PING   . "PING from server (last: %s sec. ago)")
6573    (PONG   . "PONG from %h (%i second%s)")
6574    (QUIT   . "%n (%u@%h) has quit: %r")
6575    (TOPIC  . "%n (%u@%h) has set the topic for %c: \"%T\"")
6576    (WALLOPS . "Wallops from %n: %m")
6577    (s004   . "%s %v %U %C")
6578    (s221   . "User modes for %n: %m")
6579    (s252   . "%i operator(s) online")
6580    (s253   . "%i unknown connection(s)")
6581    (s254   . "%i channels formed")
6582    (s275   . "%n %m")
6583    (s301   . "%n is AWAY: %r")
6584    (s303   . "Is online: %n")
6585    (s305   . "%m")
6586    (s306   . "%m")
6587    (s307   . "%n %m")
6588    (s311   . "%n is %f (%u@%h)")
6589    (s312   . "%n is/was on server %s (%c)")
6590    (s313   . "%n is an IRC operator")
6591    (s314   . "%n was %f (%u@%h)")
6592    (s317   . "%n has been idle for %i")
6593    (s317-on-since . "%n has been idle for %i, on since %t")
6594    (s319   . "%n is on channel(s): %c")
6595    (s320   . "%n is an identified user")
6596    (s321   . "Channel  Users  Topic")
6597    (s322   . "%c [%u] %t")
6598    (s324   . "%c modes: %m")
6599    (s328   . "%c URL: %u")
6600    (s329   . "%c was created on %t")
6601    (s330   . "%n %a %i")
6602    (s331   . "No topic is set for %c")
6603    (s332   . "Topic for %c: %T")
6604    (s333   . "%c: topic set by %n, %t")
6605    (s341   . "Inviting %n to channel %c")
6606    (s352   . "%-11c %-10n %-4a %u@%h (%f)")
6607    (s353   . "Users on %c: %u")
6608    (s367   . "Ban for %b on %c")
6609    (s367-set-by . "Ban for %b on %c set by %s on %t")
6610    (s368   . "Banlist of %c ends.")
6611    (s379   . "%c: Forwarded to %f")
6612    (s391   . "The time at %s is %t")
6613    (s401   . "%n: No such nick/channel")
6614    (s403   . "%c: No such channel")
6615    (s404   . "%c: Cannot send to channel")
6616    (s405   . "%c: You have joined too many channels")
6617    (s406   . "%n: There was no such nickname")
6618    (s412   . "No text to send")
6619    (s421   . "%c: Unknown command")
6620    (s431   . "No nickname given")
6621    (s432   . "%n is an erroneous nickname")
6622    (s442   . "%c: You're not on that channel")
6623    (s445   . "SUMMON has been disabled")
6624    (s446   . "USERS has been disabled")
6625    (s451   . "You have not registered")
6626    (s461   . "%c: not enough parameters")
6627    (s462   . "Unauthorized command (already registered)")
6628    (s463   . "Your host isn't among the privileged")
6629    (s464   . "Password incorrect")
6630    (s465   . "You are banned from this server")
6631    (s474   . "You can't join %c because you're banned (+b)")
6632    (s475   . "You must specify the correct channel key (+k) to join %c")
6633    (s481   . "Permission Denied - You're not an IRC operator")
6634    (s482   . "You need to be a channel operator of %c to do that")
6635    (s483   . "You can't kill a server!")
6636    (s484   . "Your connection is restricted!")
6637    (s485   . "You're not the original channel operator")
6638    (s491   . "No O-lines for your host")
6639    (s501   . "Unknown MODE flag")
6640    (s502   . "You can't change modes for other users")
6641    (s671   . "%n %a")))
6642
6643 (defun erc-message-english-PART (&rest args)
6644   "Format a proper PART message.
6645
6646 This function is an example on what could be done with formatting
6647 functions."
6648   (let ((nick (cadr (memq ?n args)))
6649         (user (cadr (memq ?u args)))
6650         (host (cadr (memq ?h args)))
6651         (channel (cadr (memq ?c args)))
6652         (reason (cadr (memq ?r args))))
6653     (if (string= nick (erc-current-nick))
6654         (format "You have left channel %s" channel)
6655       (format "%s (%s@%s) has left channel %s%s"
6656               nick user host channel
6657               (if (not (string= reason ""))
6658                   (format ": %s"
6659                           (erc-replace-regexp-in-string "%" "%%" reason))
6660                 "")))))
6661
6662
6663 (defvar erc-current-message-catalog 'english)
6664 (make-variable-buffer-local 'erc-current-message-catalog)
6665
6666 (defun erc-retrieve-catalog-entry (entry &optional catalog)
6667   "Retrieve ENTRY from CATALOG.
6668
6669 If CATALOG is nil, `erc-current-message-catalog' is used.
6670
6671 If ENTRY is nil in CATALOG, it is retrieved from the fallback,
6672 english, catalog."
6673   (unless catalog (setq catalog erc-current-message-catalog))
6674   (let ((var (erc-make-message-variable-name catalog entry)))
6675     (if (boundp var)
6676         (symbol-value var)
6677       (when (boundp (erc-make-message-variable-name 'english entry))
6678         (symbol-value (erc-make-message-variable-name 'english entry))))))
6679
6680 (defun erc-format-message (msg &rest args)
6681   "Format MSG according to ARGS.
6682
6683 See also `format-spec'."
6684   (when (eq (logand (length args) 1) 1) ; oddp
6685     (error "Obscure usage of this function appeared"))
6686   (let ((entry (erc-retrieve-catalog-entry msg)))
6687     (when (not entry)
6688       (error "No format spec for message %s" msg))
6689     (when (functionp entry)
6690       (setq entry (apply entry args)))
6691     (format-spec entry (apply #'format-spec-make args))))
6692
6693 ;;; Various hook functions
6694
6695 (add-hook 'kill-buffer-hook 'erc-kill-buffer-function)
6696
6697 (defcustom erc-kill-server-hook '(erc-kill-server)
6698   "Invoked whenever a server buffer is killed via `kill-buffer'."
6699   :group 'erc-hooks
6700   :type 'hook)
6701
6702 (defcustom erc-kill-channel-hook '(erc-kill-channel)
6703   "Invoked whenever a channel-buffer is killed via `kill-buffer'."
6704   :group 'erc-hooks
6705   :type 'hook)
6706
6707 (defcustom erc-kill-buffer-hook nil
6708   "Hook run whenever a non-server or channel buffer is killed.
6709
6710 See also `kill-buffer'."
6711   :group 'erc-hooks
6712   :type 'hook)
6713
6714 (defun erc-kill-buffer-function ()
6715   "Function to call when an ERC buffer is killed.
6716 This function should be on `kill-buffer-hook'.
6717 When the current buffer is in `erc-mode', this function will run
6718 one of the following hooks:
6719 `erc-kill-server-hook' if the server buffer was killed,
6720 `erc-kill-channel-hook' if a channel buffer was killed,
6721 or `erc-kill-buffer-hook' if any other buffer."
6722   (when (eq major-mode 'erc-mode)
6723     (erc-remove-channel-users)
6724     (cond
6725      ((eq (erc-server-buffer) (current-buffer))
6726       (run-hooks 'erc-kill-server-hook))
6727      ((erc-channel-p (or (erc-default-target) (buffer-name)))
6728       (run-hooks 'erc-kill-channel-hook))
6729      (t
6730       (run-hooks 'erc-kill-buffer-hook)))))
6731
6732 (defun erc-kill-server ()
6733   "Sends a QUIT command to the server when the server buffer is killed.
6734 This function should be on `erc-kill-server-hook'."
6735   (when (erc-server-process-alive)
6736     (setq erc-server-quitting t)
6737     (erc-server-send (format "QUIT :%s" (funcall erc-quit-reason nil)))))
6738
6739 (defun erc-kill-channel ()
6740   "Sends a PART command to the server when the channel buffer is killed.
6741 This function should be on `erc-kill-channel-hook'."
6742   (when (erc-server-process-alive)
6743     (let ((tgt (erc-default-target)))
6744       (erc-server-send (format "PART %s :%s" tgt
6745                                (funcall erc-part-reason nil))
6746                        nil tgt))))
6747
6748 ;;; Dealing with `erc-parsed'
6749
6750 (defun erc-find-parsed-property ()
6751   "Find the next occurrence of the `erc-parsed' text property."
6752   (text-property-not-all (point-min) (point-max) 'erc-parsed nil))
6753
6754 (defun erc-restore-text-properties ()
6755   "Restore the property `erc-parsed' for the region."
6756   (let ((parsed-posn (erc-find-parsed-property)))
6757     (put-text-property
6758      (point-min) (point-max)
6759      'erc-parsed (when parsed-posn (erc-get-parsed-vector parsed-posn)))))
6760
6761 (defun erc-get-parsed-vector (point)
6762   "Return the whole parsed vector on POINT."
6763   (get-text-property point 'erc-parsed))
6764
6765 (defun erc-get-parsed-vector-nick (vect)
6766   "Return nickname in the parsed vector VECT."
6767   (let* ((untreated-nick (and vect (erc-response.sender vect)))
6768          (maybe-nick (when untreated-nick
6769                        (car (split-string untreated-nick "!")))))
6770     (when (and (not (null maybe-nick))
6771                (erc-is-valid-nick-p maybe-nick))
6772       untreated-nick)))
6773
6774 (defun erc-get-parsed-vector-type (vect)
6775   "Return message type in the parsed vector VECT."
6776   (and vect
6777        (erc-response.command vect)))
6778
6779 ;; Teach url.el how to open irc:// URLs with ERC.
6780 ;; To activate, customize `url-irc-function' to `url-irc-erc'.
6781
6782 ;;;###autoload
6783 (defun erc-handle-irc-url (host port channel user password)
6784   "Use ERC to IRC on HOST:PORT in CHANNEL as USER with PASSWORD.
6785 If ERC is already connected to HOST:PORT, simply /join CHANNEL.
6786 Otherwise, connect to HOST:PORT as USER and /join CHANNEL."
6787   (let ((server-buffer
6788          (car (erc-buffer-filter
6789                (lambda ()
6790                  (and (string-equal erc-session-server host)
6791                       (= erc-session-port port)
6792                       (erc-open-server-buffer-p)))))))
6793     (with-current-buffer (or server-buffer (current-buffer))
6794       (if (and server-buffer channel)
6795           (erc-cmd-JOIN channel)
6796         (erc-open host port (or user (erc-compute-nick)) (erc-compute-full-name)
6797                   (not server-buffer) password nil channel
6798                   (when server-buffer
6799                     (get-buffer-process server-buffer)))))))
6800
6801 (provide 'erc)
6802
6803 ;; Deprecated. We might eventually stop requiring the goodies automatically.
6804 ;; IMPORTANT: This require must appear _after_ the above (provide 'erc) to
6805 ;; avoid a recursive require error when byte-compiling the entire package.
6806 (require 'erc-goodies)
6807
6808 ;;; erc.el ends here
6809 ;;
6810 ;; Local Variables:
6811 ;; outline-regexp: ";;+"
6812 ;; indent-tabs-mode: t
6813 ;; tab-width: 8
6814 ;; End: