forked from emacs-mirror/emacs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrcirc.el
3077 lines (2699 loc) · 112 KB
/
rcirc.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; rcirc.el --- default, simple IRC client -*- lexical-binding: t; -*-
;; Copyright (C) 2005-2020 Free Software Foundation, Inc.
;; Author: Ryan Yeske <[email protected]>
;; Maintainers: Ryan Yeske <[email protected]>,
;; Leo Liu <[email protected]>
;; Keywords: comm
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Internet Relay Chat (IRC) is a form of instant communication over
;; the Internet. It is mainly designed for group (many-to-many)
;; communication in discussion forums called channels, but also allows
;; one-to-one communication.
;; Rcirc has simple defaults and clear and consistent behavior.
;; Message arrival timestamps, activity notification on the mode line,
;; message filling, nick completion, and keepalive pings are all
;; enabled by default, but can easily be adjusted or turned off. Each
;; discussion takes place in its own buffer and there is a single
;; server buffer per connection.
;; Open a new irc connection with:
;; M-x irc RET
;;; Code:
(require 'cl-lib)
(require 'ring)
(require 'time-date)
(eval-when-compile (require 'subr-x))
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
(defgroup rcirc nil
"Simple IRC client."
:version "22.1"
:prefix "rcirc-"
:link '(custom-manual "(rcirc)")
:group 'applications)
(defcustom rcirc-server-alist
'(("irc.freenode.net" :channels ("#rcirc")
;; Don't use the TLS port by default, in case gnutls is not available.
;; :port 7000 :encryption tls
))
"An alist of IRC connections to establish when running `rcirc'.
Each element looks like (SERVER-NAME PARAMETERS).
SERVER-NAME is a string describing the server to connect
to.
The optional PARAMETERS come in pairs PARAMETER VALUE.
The following parameters are recognized:
`:nick'
VALUE must be a string. If absent, `rcirc-default-nick' is used
for this connection.
`:port'
VALUE must be a number or string. If absent,
`rcirc-default-port' is used.
`:user-name'
VALUE must be a string. If absent, `rcirc-default-user-name' is
used.
`:password'
VALUE must be a string. If absent, no PASS command will be sent
to the server.
`:full-name'
VALUE must be a string. If absent, `rcirc-default-full-name' is
used.
`:channels'
VALUE must be a list of strings describing which channels to join
when connecting to this server. If absent, no channels will be
connected to automatically.
`:encryption'
VALUE must be `plain' (the default) for unencrypted connections, or `tls'
for connections using SSL/TLS.
`:server-alias'
VALUE must be a string that will be used instead of the server name for
display purposes. If absent, the real server name will be displayed instead."
:type '(alist :key-type string
:value-type (plist :options
((:nick string)
(:port integer)
(:user-name string)
(:password string)
(:full-name string)
(:channels (repeat string))
(:encryption (choice (const tls)
(const plain)))
(:server-alias string)))))
(defcustom rcirc-default-port 6667
"The default port to connect to."
:type 'integer)
(defcustom rcirc-default-nick (user-login-name)
"Your nick."
:type 'string)
(defcustom rcirc-default-user-name "user"
"Your user name sent to the server when connecting."
:version "24.1" ; changed default
:type 'string)
(defcustom rcirc-default-full-name "unknown"
"The full name sent to the server when connecting."
:version "24.1" ; changed default
:type 'string)
(defcustom rcirc-default-part-reason rcirc-id-string
"The default reason to send when parting from a channel.
Used when no reason is explicitly given."
:type 'string)
(defcustom rcirc-default-quit-reason rcirc-id-string
"The default reason to send when quitting a server.
Used when no reason is explicitly given."
:type 'string)
(defcustom rcirc-fill-flag t
"Non-nil means line-wrap messages printed in channel buffers."
:type 'boolean)
(defcustom rcirc-fill-column nil
"Column beyond which automatic line-wrapping should happen.
If nil, use value of `fill-column'.
If a function (e.g., `frame-text-width' or `window-text-width'),
call it to compute the number of columns."
:risky t ; can get funcalled
:type '(choice (const :tag "Value of `fill-column'" nil)
(integer :tag "Number of columns")
(function :tag "Function returning the number of columns")))
(defcustom rcirc-fill-prefix nil
"Text to insert before filled lines.
If nil, calculate the prefix dynamically to line up text
underneath each nick."
:type '(choice (const :tag "Dynamic" nil)
(string :tag "Prefix text")))
(defcustom rcirc-url-max-length nil
"Maximum number of characters in displayed URLs.
If nil, no maximum is applied."
:version "27.1"
:type '(choice (const :tag "No maximum" nil)
(integer :tag "Number of characters")))
(defvar rcirc-ignore-buffer-activity-flag nil
"If non-nil, ignore activity in this buffer.")
(make-variable-buffer-local 'rcirc-ignore-buffer-activity-flag)
(defvar rcirc-low-priority-flag nil
"If non-nil, activity in this buffer is considered low priority.")
(make-variable-buffer-local 'rcirc-low-priority-flag)
(defcustom rcirc-omit-responses
'("JOIN" "PART" "QUIT" "NICK")
"Responses which will be hidden when `rcirc-omit-mode' is enabled."
:type '(repeat string))
(defvar rcirc-prompt-start-marker nil)
(define-minor-mode rcirc-omit-mode
"Toggle the hiding of \"uninteresting\" lines.
Uninteresting lines are those whose responses are listed in
`rcirc-omit-responses'."
nil " Omit" nil
(if rcirc-omit-mode
(progn
(add-to-invisibility-spec '(rcirc-omit . nil))
(message "Rcirc-Omit mode enabled"))
(remove-from-invisibility-spec '(rcirc-omit . nil))
(message "Rcirc-Omit mode disabled"))
(dolist (window (get-buffer-window-list (current-buffer)))
(with-selected-window window
(recenter (when (> (point) rcirc-prompt-start-marker) -1)))))
(defcustom rcirc-time-format "%H:%M "
"Describes how timestamps are printed.
Used as the first arg to `format-time-string'."
:type 'string)
(defcustom rcirc-input-ring-size 1024
"Size of input history ring."
:type 'integer)
(defcustom rcirc-read-only-flag t
"Non-nil means make text in IRC buffers read-only."
:type 'boolean)
(defcustom rcirc-buffer-maximum-lines nil
"The maximum size in lines for rcirc buffers.
Channel buffers are truncated from the top to be no greater than this
number. If zero or nil, no truncating is done."
:type '(choice (const :tag "No truncation" nil)
(integer :tag "Number of lines")))
(defcustom rcirc-scroll-show-maximum-output t
"If non-nil, scroll buffer to keep the point at the bottom of
the window."
:type 'boolean)
(defcustom rcirc-authinfo nil
"List of authentication passwords.
Each element of the list is a list with a SERVER-REGEXP string
and a method symbol followed by method specific arguments.
The valid METHOD symbols are `nickserv', `chanserv' and
`bitlbee'.
The ARGUMENTS for each METHOD symbol are:
`nickserv': NICK PASSWORD [NICKSERV-NICK]
`chanserv': NICK CHANNEL PASSWORD
`bitlbee': NICK PASSWORD
`quakenet': ACCOUNT PASSWORD
Examples:
((\"freenode\" nickserv \"bob\" \"p455w0rd\")
(\"freenode\" chanserv \"bob\" \"#bobland\" \"passwd99\")
(\"bitlbee\" bitlbee \"robert\" \"sekrit\")
(\"dal.net\" nickserv \"bob\" \"sekrit\" \"[email protected]\")
(\"quakenet.org\" quakenet \"bobby\" \"sekrit\"))"
:type '(alist :key-type (regexp :tag "Server")
:value-type (choice (list :tag "NickServ"
(const nickserv)
(string :tag "Nick")
(string :tag "Password"))
(list :tag "ChanServ"
(const chanserv)
(string :tag "Nick")
(string :tag "Channel")
(string :tag "Password"))
(list :tag "BitlBee"
(const bitlbee)
(string :tag "Nick")
(string :tag "Password"))
(list :tag "QuakeNet"
(const quakenet)
(string :tag "Account")
(string :tag "Password")))))
(defcustom rcirc-auto-authenticate-flag t
"Non-nil means automatically send authentication string to server.
See also `rcirc-authinfo'."
:type 'boolean)
(defcustom rcirc-authenticate-before-join t
"Non-nil means authenticate to services before joining channels.
Currently only works with NickServ on some networks."
:version "24.1"
:type 'boolean)
(defcustom rcirc-prompt "> "
"Prompt string to use in IRC buffers.
The following replacements are made:
%n is your nick.
%s is the server.
%t is the buffer target, a channel or a user.
Setting this alone will not affect the prompt;
use either M-x customize or also call `rcirc-update-prompt'."
:type 'string
:set 'rcirc-set-changed
:initialize 'custom-initialize-default)
(defcustom rcirc-keywords nil
"List of keywords to highlight in message text."
:type '(repeat string))
(defcustom rcirc-ignore-list ()
"List of ignored nicks.
Use /ignore to list them, use /ignore NICK to add or remove a nick."
:type '(repeat string))
(defvar rcirc-ignore-list-automatic ()
"List of ignored nicks added to `rcirc-ignore-list' because of renaming.
When an ignored person renames, their nick is added to both lists.
Nicks will be removed from the automatic list on follow-up renamings or
parts.")
(defcustom rcirc-bright-nicks nil
"List of nicks to be emphasized.
See `rcirc-bright-nick' face."
:type '(repeat string))
(defcustom rcirc-dim-nicks nil
"List of nicks to be deemphasized.
See `rcirc-dim-nick' face."
:type '(repeat string))
(define-obsolete-variable-alias 'rcirc-print-hooks
'rcirc-print-functions "24.3")
(defcustom rcirc-print-functions nil
"Hook run after text is printed.
Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT."
:type 'hook)
(defvar rcirc-authenticated-hook nil
"Hook run after successfully authenticated.")
(defcustom rcirc-always-use-server-buffer-flag nil
"Non-nil means messages without a channel target will go to the server buffer."
:type 'boolean)
(defcustom rcirc-decode-coding-system 'utf-8
"Coding system used to decode incoming irc messages.
Set to `undecided' if you want the encoding of the incoming
messages autodetected."
:type 'coding-system)
(defcustom rcirc-encode-coding-system 'utf-8
"Coding system used to encode outgoing irc messages."
:type 'coding-system)
(defcustom rcirc-coding-system-alist nil
"Alist to decide a coding system to use for a channel I/O operation.
The format is ((PATTERN . VAL) ...).
PATTERN is either a string or a cons of strings.
If PATTERN is a string, it is used to match a target.
If PATTERN is a cons of strings, the car part is used to match a
target, and the cdr part is used to match a server.
VAL is either a coding system or a cons of coding systems.
If VAL is a coding system, it is used for both decoding and encoding
messages.
If VAL is a cons of coding systems, the car part is used for decoding,
and the cdr part is used for encoding."
:type '(alist :key-type (choice (regexp :tag "Channel Regexp")
(cons (regexp :tag "Channel Regexp")
(regexp :tag "Server Regexp")))
:value-type (choice coding-system
(cons (coding-system :tag "Decode")
(coding-system :tag "Encode")))))
(defcustom rcirc-multiline-major-mode 'fundamental-mode
"Major-mode function to use in multiline edit buffers."
:type 'function)
(defcustom rcirc-nick-completion-format "%s: "
"Format string to use in nick completions.
The format string is only used when completing at the beginning
of a line. The string is passed as the first argument to
`format' with the nickname as the second argument."
:version "24.1"
:type 'string)
(defcustom rcirc-kill-channel-buffers nil
"When non-nil, kill channel buffers when the server buffer is killed.
Only the channel buffers associated with the server in question
will be killed."
:version "24.3"
:type 'boolean)
(defvar rcirc-nick nil)
(defvar rcirc-prompt-end-marker nil)
(defvar rcirc-nick-table nil)
(defvar rcirc-recent-quit-alist nil
"Alist of nicks that have recently quit or parted the channel.")
(defvar rcirc-nick-syntax-table
(let ((table (make-syntax-table text-mode-syntax-table)))
(mapc (lambda (c) (modify-syntax-entry c "w" table))
"[]\\`_^{|}-")
(modify-syntax-entry ?' "_" table)
table)
"Syntax table which includes all nick characters as word constituents.")
;; each process has an alist of (target . buffer) pairs
(defvar rcirc-buffer-alist nil)
(defvar rcirc-activity nil
"List of buffers with unviewed activity.")
(defvar rcirc-activity-string ""
"String displayed in mode line representing `rcirc-activity'.")
(put 'rcirc-activity-string 'risky-local-variable t)
(defvar rcirc-server-buffer nil
"The server buffer associated with this channel buffer.")
(defvar rcirc-target nil
"The channel or user associated with this buffer.")
(defvar rcirc-urls nil
"List of URLs seen in the current buffer and their start positions.")
(put 'rcirc-urls 'permanent-local t)
(defvar rcirc-timeout-seconds 600
"Kill connection after this many seconds if there is no activity.")
(defvar rcirc-startup-channels nil)
(defvar rcirc-server-name-history nil
"History variable for \\[rcirc] call.")
(defvar rcirc-server-port-history nil
"History variable for \\[rcirc] call.")
(defvar rcirc-nick-name-history nil
"History variable for \\[rcirc] call.")
(defvar rcirc-user-name-history nil
"History variable for \\[rcirc] call.")
;;;###autoload
(defun rcirc (arg)
"Connect to all servers in `rcirc-server-alist'.
Do not connect to a server if it is already connected.
If ARG is non-nil, instead prompt for connection parameters."
(interactive "P")
(if arg
(let* ((server (completing-read "IRC Server: "
rcirc-server-alist
nil nil
(caar rcirc-server-alist)
'rcirc-server-name-history))
(server-plist (cdr (assoc-string server rcirc-server-alist)))
(port (read-string "IRC Port: "
(number-to-string
(or (plist-get server-plist :port)
rcirc-default-port))
'rcirc-server-port-history))
(nick (read-string "IRC Nick: "
(or (plist-get server-plist :nick)
rcirc-default-nick)
'rcirc-nick-name-history))
(user-name (read-string "IRC Username: "
(or (plist-get server-plist :user-name)
rcirc-default-user-name)
'rcirc-user-name-history))
(password (read-passwd "IRC Password: " nil
(plist-get server-plist :password)))
(channels (split-string
(read-string "IRC Channels: "
(mapconcat 'identity
(plist-get server-plist
:channels)
" "))
"[, ]+" t))
(encryption (rcirc-prompt-for-encryption server-plist)))
(rcirc-connect server port nick user-name
rcirc-default-full-name
channels password encryption))
;; connect to servers in `rcirc-server-alist'
(let (connected-servers)
(dolist (c rcirc-server-alist)
(let ((server (car c))
(nick (or (plist-get (cdr c) :nick) rcirc-default-nick))
(port (or (plist-get (cdr c) :port) rcirc-default-port))
(user-name (or (plist-get (cdr c) :user-name)
rcirc-default-user-name))
(full-name (or (plist-get (cdr c) :full-name)
rcirc-default-full-name))
(channels (plist-get (cdr c) :channels))
(password (plist-get (cdr c) :password))
(encryption (plist-get (cdr c) :encryption))
(server-alias (plist-get (cdr c) :server-alias))
contact)
(when server
(let (connected)
(dolist (p (rcirc-process-list))
(when (string= (or server-alias server) (process-name p))
(setq connected p)))
(if (not connected)
(condition-case nil
(rcirc-connect server port nick user-name
full-name channels password encryption
server-alias)
(quit (message "Quit connecting to %s"
(or server-alias server))))
(with-current-buffer (process-buffer connected)
(setq contact (process-contact
(get-buffer-process (current-buffer)) :name))
(setq connected-servers
(cons (if (stringp contact)
contact (or server-alias server))
connected-servers))))))))
(when connected-servers
(message "Already connected to %s"
(if (cdr connected-servers)
(concat (mapconcat 'identity (butlast connected-servers) ", ")
", and "
(car (last connected-servers)))
(car connected-servers)))))))
;;;###autoload
(defalias 'irc 'rcirc)
(defvar rcirc-process-output nil)
(defvar rcirc-topic nil)
(defvar rcirc-keepalive-timer nil)
(defvar rcirc-last-server-message-time nil)
(defvar rcirc-server nil) ; server provided by server
(defvar rcirc-server-name nil) ; server name given by 001 response
(defvar rcirc-timeout-timer nil)
(defvar rcirc-user-authenticated nil)
(defvar rcirc-user-disconnect nil)
(defvar rcirc-connecting nil)
(defvar rcirc-connection-info nil)
(defvar rcirc-process nil)
;;;###autoload
(defun rcirc-connect (server &optional port nick user-name
full-name startup-channels password encryption
server-alias)
(save-excursion
(message "Connecting to %s..." (or server-alias server))
(let* ((inhibit-eol-conversion)
(port-number (if port
(if (stringp port)
(string-to-number port)
port)
rcirc-default-port))
(nick (or nick rcirc-default-nick))
(user-name (or user-name rcirc-default-user-name))
(full-name (or full-name rcirc-default-full-name))
(startup-channels startup-channels)
(process (open-network-stream
(or server-alias server) nil server port-number
:type (or encryption 'plain))))
;; set up process
(set-process-coding-system process 'raw-text 'raw-text)
(switch-to-buffer (rcirc-generate-new-buffer-name process nil))
(set-process-buffer process (current-buffer))
(rcirc-mode process nil)
(set-process-sentinel process 'rcirc-sentinel)
(set-process-filter process 'rcirc-filter)
(setq-local rcirc-connection-info
(list server port nick user-name full-name startup-channels
password encryption server-alias))
(setq-local rcirc-process process)
(setq-local rcirc-server server)
(setq-local rcirc-server-name
(or server-alias server)) ; Update when we get 001 response.
(setq-local rcirc-buffer-alist nil)
(setq-local rcirc-nick-table (make-hash-table :test 'equal))
(setq-local rcirc-nick nick)
(setq-local rcirc-process-output nil)
(setq-local rcirc-startup-channels startup-channels)
(setq-local rcirc-last-server-message-time (current-time))
(setq-local rcirc-timeout-timer nil)
(setq-local rcirc-user-disconnect nil)
(setq-local rcirc-user-authenticated nil)
(setq-local rcirc-connecting t)
(add-hook 'auto-save-hook 'rcirc-log-write)
;; identify
(unless (zerop (length password))
(rcirc-send-string process (concat "PASS " password)))
(rcirc-send-string process (concat "NICK " nick))
(rcirc-send-string process (concat "USER " user-name
" 0 * :" full-name))
;; setup ping timer if necessary
(unless rcirc-keepalive-timer
(setq rcirc-keepalive-timer
(run-at-time 0 (/ rcirc-timeout-seconds 2) 'rcirc-keepalive)))
(message "Connecting to %s...done" (or server-alias server))
;; return process object
process)))
(defmacro with-rcirc-process-buffer (process &rest body)
(declare (indent 1) (debug t))
`(with-current-buffer (process-buffer ,process)
,@body))
(defmacro with-rcirc-server-buffer (&rest body)
(declare (indent 0) (debug t))
`(with-current-buffer rcirc-server-buffer
,@body))
(define-obsolete-function-alias 'rcirc-float-time 'float-time "26.1")
(defun rcirc-prompt-for-encryption (server-plist)
"Prompt the user for the encryption method to use.
SERVER-PLIST is the property list for the server."
(let ((choices '("plain" "tls"))
(default (or (plist-get server-plist :encryption)
"plain")))
(intern
(completing-read (format "Encryption (default %s): " default)
choices nil t nil nil default))))
(defun rcirc-keepalive ()
"Send keep alive pings to active rcirc processes.
Kill processes that have not received a server message since the
last ping."
(if (rcirc-process-list)
(mapc (lambda (process)
(with-rcirc-process-buffer process
(when (not rcirc-connecting)
(rcirc-send-ctcp process
rcirc-nick
(format "KEEPALIVE %f"
(float-time))))))
(rcirc-process-list))
;; no processes, clean up timer
(when (timerp rcirc-keepalive-timer)
(cancel-timer rcirc-keepalive-timer))
(setq rcirc-keepalive-timer nil)))
(defun rcirc-handler-ctcp-KEEPALIVE (process _target _sender message)
(with-rcirc-process-buffer process
(setq header-line-format
(format "%f" (float-time
(time-since (string-to-number message)))))))
(defvar rcirc-debug-buffer "*rcirc debug*")
(defvar rcirc-debug-flag nil
"If non-nil, write information to `rcirc-debug-buffer'.")
(defun rcirc-debug (process text)
"Add an entry to the debug log including PROCESS and TEXT.
Debug text is appended to `rcirc-debug-buffer' if `rcirc-debug-flag'
is non-nil.
For convenience, the read-only state of the debug buffer is ignored.
When the point is at the end of the visible portion of the buffer, it
is moved to after the text inserted. Otherwise the point is not moved."
(when rcirc-debug-flag
(with-current-buffer (get-buffer-create rcirc-debug-buffer)
(let ((old (point-marker)))
(set-marker-insertion-type old t)
(goto-char (point-max))
(let ((inhibit-read-only t))
(terpri (current-buffer) t)
(insert "["
(format-time-string "%FT%T ") (process-name process)
"] "
text))
(goto-char old)))))
(define-obsolete-variable-alias 'rcirc-sentinel-hooks
'rcirc-sentinel-functions "24.3")
(defvar rcirc-sentinel-functions nil
"Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")
(defcustom rcirc-reconnect-delay 0
"The minimum interval in seconds between reconnect attempts.
When 0, do not auto-reconnect."
:version "25.1"
:type 'integer)
(defvar rcirc-last-connect-time nil
"The last time the buffer was connected.")
(defun rcirc-sentinel (process sentinel)
"Called when PROCESS receives SENTINEL."
(let ((sentinel (replace-regexp-in-string "\n" "" sentinel)))
(rcirc-debug process (format "SENTINEL: %S %S\n" process sentinel))
(with-rcirc-process-buffer process
(dolist (buffer (cons nil (mapcar 'cdr rcirc-buffer-alist)))
(with-current-buffer (or buffer (current-buffer))
(rcirc-print process "rcirc.el" "ERROR" rcirc-target
(format "%s: %s (%S)"
(process-name process)
sentinel
(process-status process))
(not rcirc-target))
(rcirc-disconnect-buffer)))
(when (and (string= sentinel "deleted")
(< 0 rcirc-reconnect-delay))
(let ((now (current-time)))
(when (or (null rcirc-last-connect-time)
(time-less-p rcirc-reconnect-delay
(time-subtract now rcirc-last-connect-time)))
(setq rcirc-last-connect-time now)
(rcirc-cmd-reconnect nil))))
(run-hook-with-args 'rcirc-sentinel-functions process sentinel))))
(defun rcirc-disconnect-buffer (&optional buffer)
(with-current-buffer (or buffer (current-buffer))
;; set rcirc-target to nil for each channel so cleanup
;; doesn't happen when we reconnect
(setq rcirc-target nil)
(setq mode-line-process ":disconnected")))
(defun rcirc-process-list ()
"Return a list of rcirc processes."
(let (ps)
(mapc (lambda (p)
(when (buffer-live-p (process-buffer p))
(with-rcirc-process-buffer p
(when (eq major-mode 'rcirc-mode)
(setq ps (cons p ps))))))
(process-list))
ps))
(define-obsolete-variable-alias 'rcirc-receive-message-hooks
'rcirc-receive-message-functions "24.3")
(defvar rcirc-receive-message-functions nil
"Hook functions run when a message is received from server.
Function is called with PROCESS, COMMAND, SENDER, ARGS and LINE.")
(defun rcirc-filter (process output)
"Called when PROCESS receives OUTPUT."
(rcirc-debug process output)
(rcirc-reschedule-timeout process)
(with-rcirc-process-buffer process
(setq rcirc-last-server-message-time (current-time))
(setq rcirc-process-output (concat rcirc-process-output output))
(when (= ?\n (aref rcirc-process-output
(1- (length rcirc-process-output))))
(let ((lines (split-string rcirc-process-output "[\n\r]" t)))
(setq rcirc-process-output nil)
(dolist (line lines)
(rcirc-process-server-response process line))))))
(defun rcirc-reschedule-timeout (process)
(with-rcirc-process-buffer process
(when (not rcirc-connecting)
(with-rcirc-process-buffer process
(when rcirc-timeout-timer (cancel-timer rcirc-timeout-timer))
(setq rcirc-timeout-timer (run-at-time rcirc-timeout-seconds nil
'rcirc-delete-process
process))))))
(defun rcirc-delete-process (process)
(delete-process process))
(defvar rcirc-trap-errors-flag t)
(defun rcirc-process-server-response (process text)
(if rcirc-trap-errors-flag
(condition-case err
(rcirc-process-server-response-1 process text)
(error
(rcirc-print process "RCIRC" "ERROR" nil
(format "\"%s\" %s" text err) t)))
(rcirc-process-server-response-1 process text)))
(defun rcirc-process-server-response-1 (process text)
;; See https://tools.ietf.org/html/rfc2812#section-2.3.1. We're a
;; bit more accepting than the RFC: We allow any non-space
;; characters in the command name, multiple spaces between
;; arguments, and allow the last argument to omit the leading ":",
;; even if there are less than 15 arguments.
(if (string-match "^\\(:\\([^ ]+\\) \\)?\\([^ ]+\\)" text)
(let* ((user (match-string 2 text))
(sender (rcirc-user-nick user))
(cmd (match-string 3 text))
(cmd-end (match-end 3))
(args nil)
(handler (intern-soft (concat "rcirc-handler-" cmd))))
(cl-loop with i = cmd-end
repeat 14
while (eql i (string-match " +\\([^: ][^ ]*\\)" text i))
do (progn (push (match-string 1 text) args)
(setq i (match-end 0)))
finally
(progn (if (eql i (string-match " +:?" text i))
(push (substring text (match-end 0)) args)
(cl-assert (= i (length text))))
(cl-callf nreverse args)))
(if (not (fboundp handler))
(rcirc-handler-generic process cmd sender args text)
(funcall handler process sender args text))
(run-hook-with-args 'rcirc-receive-message-functions
process cmd sender args text))
(message "UNHANDLED: %s" text)))
(defvar rcirc-responses-no-activity '("305" "306")
"Responses that don't trigger activity in the mode-line indicator.")
(defun rcirc-handler-generic (process response sender args _text)
"Generic server response handler."
(rcirc-print process sender response nil
(mapconcat 'identity (cdr args) " ")
(not (member response rcirc-responses-no-activity))))
(defun rcirc--connection-open-p (process)
(memq (process-status process) '(run open)))
(defun rcirc-send-string (process string)
"Send PROCESS a STRING plus a newline."
(let ((string (concat (encode-coding-string string rcirc-encode-coding-system)
"\n")))
(unless (rcirc--connection-open-p process)
(error "Network connection to %s is not open"
(process-name process)))
(rcirc-debug process string)
(process-send-string process string)))
(defun rcirc-send-privmsg (process target string)
(cl-check-type target string)
(rcirc-send-string process (format "PRIVMSG %s :%s" target string)))
(defun rcirc-send-ctcp (process target request &optional args)
(let ((args (if args (concat " " args) "")))
(rcirc-send-privmsg process target
(format "\C-a%s%s\C-a" request args))))
(defun rcirc-buffer-process (&optional buffer)
"Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
(let ((buffer (or buffer (and (buffer-live-p rcirc-server-buffer)
rcirc-server-buffer))))
(if buffer
(with-current-buffer buffer rcirc-process)
rcirc-process)))
(defun rcirc-server-name (process)
"Return PROCESS server name, given by the 001 response."
(with-rcirc-process-buffer process
(or rcirc-server-name
(warn "server name for process %S unknown" process))))
(defun rcirc-nick (process)
"Return PROCESS nick."
(with-rcirc-process-buffer process
(or rcirc-nick rcirc-default-nick)))
(defun rcirc-buffer-nick (&optional buffer)
"Return the nick associated with BUFFER.
With no argument or nil as argument, use the current buffer."
(with-current-buffer (or buffer (current-buffer))
(with-current-buffer rcirc-server-buffer
(or rcirc-nick rcirc-default-nick))))
(defvar rcirc-max-message-length 420
"Messages longer than this value will be split.")
(defun rcirc-split-message (message)
"Split MESSAGE into chunks within `rcirc-max-message-length'."
;; `rcirc-encode-coding-system' can have buffer-local value.
(let ((encoding rcirc-encode-coding-system))
(with-temp-buffer
(insert message)
(goto-char (point-min))
(let (result)
(while (not (eobp))
(goto-char (or (byte-to-position rcirc-max-message-length)
(point-max)))
;; max message length is 512 including CRLF
(while (and (not (bobp))
(> (length (encode-coding-region
(point-min) (point) encoding t))
rcirc-max-message-length))
(forward-char -1))
(push (delete-and-extract-region (point-min) (point)) result))
(nreverse result)))))
(defun rcirc-send-message (process target message &optional noticep silent)
"Send TARGET associated with PROCESS a privmsg with text MESSAGE.
If NOTICEP is non-nil, send a notice instead of privmsg.
If SILENT is non-nil, do not print the message in any irc buffer."
(let ((response (if noticep "NOTICE" "PRIVMSG")))
(rcirc-get-buffer-create process target)
(dolist (msg (rcirc-split-message message))
(rcirc-send-string process (concat response " " target " :" msg))
(unless silent
(rcirc-print process (rcirc-nick process) response target msg)))))
(defvar rcirc-input-ring nil)
(defvar rcirc-input-ring-index 0)
(defun rcirc-prev-input-string (arg)
(ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))
(defun rcirc-insert-prev-input ()
(interactive)
(when (<= rcirc-prompt-end-marker (point))
(delete-region rcirc-prompt-end-marker (point-max))
(insert (rcirc-prev-input-string 0))
(setq rcirc-input-ring-index (1+ rcirc-input-ring-index))))
(defun rcirc-insert-next-input ()
(interactive)
(when (<= rcirc-prompt-end-marker (point))
(delete-region rcirc-prompt-end-marker (point-max))
(setq rcirc-input-ring-index (1- rcirc-input-ring-index))
(insert (rcirc-prev-input-string -1))))
(defvar rcirc-server-commands
'("/admin" "/away" "/connect" "/die" "/error" "/info"
"/invite" "/ison" "/join" "/kick" "/kill" "/links"
"/list" "/lusers" "/mode" "/motd" "/names" "/nick"
"/notice" "/oper" "/part" "/pass" "/ping" "/pong"
"/privmsg" "/quit" "/rehash" "/restart" "/service" "/servlist"
"/server" "/squery" "/squit" "/stats" "/summon" "/time"
"/topic" "/trace" "/user" "/userhost" "/users" "/version"
"/wallops" "/who" "/whois" "/whowas")
"A list of user commands by IRC server.
The value defaults to RFCs 1459 and 2812.")
;; /me and /ctcp are not defined by `defun-rcirc-command'.
(defvar rcirc-client-commands '("/me" "/ctcp")
"A list of user commands defined by IRC client rcirc.
The list is updated automatically by `defun-rcirc-command'.")
(defun rcirc-completion-at-point ()
"Function used for `completion-at-point-functions' in `rcirc-mode'."
(and (rcirc-looking-at-input)
(let* ((beg (save-excursion
;; On some networks it is common to message or
;; mention someone using @nick instead of just
;; nick.
(if (re-search-backward "[[:space:]@]" rcirc-prompt-end-marker t)
(1+ (point))
rcirc-prompt-end-marker)))
(table (if (and (= beg rcirc-prompt-end-marker)
(eq (char-after beg) ?/))
(delete-dups
(nconc (sort (copy-sequence rcirc-client-commands)
'string-lessp)
(sort (copy-sequence rcirc-server-commands)
'string-lessp)))
(rcirc-channel-nicks (rcirc-buffer-process)
rcirc-target))))
(list beg (point) table))))
(defvar rcirc-completions nil)
(defvar rcirc-completion-start nil)
(defun rcirc-complete ()
"Cycle through completions from list of nicks in channel or IRC commands.
IRC command completion is performed only if `/' is the first input char."
(interactive)
(unless (rcirc-looking-at-input)
(error "Point not located after rcirc prompt"))
(if (eq last-command this-command)
(setq rcirc-completions
(append (cdr rcirc-completions) (list (car rcirc-completions))))
(let ((completion-ignore-case t)
(table (rcirc-completion-at-point)))
(setq rcirc-completion-start (car table))
(setq rcirc-completions
(and rcirc-completion-start
(all-completions (buffer-substring rcirc-completion-start
(cadr table))
(nth 2 table))))))
(let ((completion (car rcirc-completions)))
(when completion
(delete-region rcirc-completion-start (point))
(insert
(cond
((= (aref completion 0) ?/) (concat completion " "))
((= rcirc-completion-start rcirc-prompt-end-marker)
(format rcirc-nick-completion-format completion))
(t completion))))))
(defun set-rcirc-decode-coding-system (coding-system)
"Set the decode coding system used in this channel."
(interactive "zCoding system for incoming messages: ")
(setq-local rcirc-decode-coding-system coding-system))
(defun set-rcirc-encode-coding-system (coding-system)
"Set the encode coding system used in this channel."
(interactive "zCoding system for outgoing messages: ")
(setq-local rcirc-encode-coding-system coding-system))
(defvar rcirc-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "RET") 'rcirc-send-input)
(define-key map (kbd "M-p") 'rcirc-insert-prev-input)