Add de-base64-unreadable.
[gnus] / lisp / gnus.el
1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
3 ;;        1997, 1998, 2000 Free Software Foundation, Inc.
4
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;;; Code:
29
30 (eval '(run-hooks 'gnus-load-hook))
31
32 (eval-when-compile (require 'cl))
33 (require 'mm-util)
34
35 (require 'message)
36
37 (defgroup gnus nil
38   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
39   :group 'news
40   :group 'mail)
41
42 (defgroup gnus-charset nil
43   "Group character set issues."
44   :link '(custom-manual "(gnus)Charsets")
45   :group 'gnus)
46
47 (defgroup gnus-cache nil
48   "Cache interface."
49   :group 'gnus)
50
51 (defgroup gnus-start nil
52   "Starting your favorite newsreader."
53   :group 'gnus)
54
55 (defgroup gnus-start-server nil
56   "Server options at startup."
57   :group 'gnus-start)
58
59 ;; These belong to gnus-group.el.
60 (defgroup gnus-group nil
61   "Group buffers."
62   :link '(custom-manual "(gnus)The Group Buffer")
63   :group 'gnus)
64
65 (defgroup gnus-group-foreign nil
66   "Foreign groups."
67   :link '(custom-manual "(gnus)Foreign Groups")
68   :group 'gnus-group)
69
70 (defgroup gnus-group-new nil
71   "Automatic subscription of new groups."
72   :group 'gnus-group)
73
74 (defgroup gnus-group-levels nil
75   "Group levels."
76   :link '(custom-manual "(gnus)Group Levels")
77   :group 'gnus-group)
78
79 (defgroup gnus-group-select nil
80   "Selecting a Group."
81   :link '(custom-manual "(gnus)Selecting a Group")
82   :group 'gnus-group)
83
84 (defgroup gnus-group-listing nil
85   "Showing slices of the group list."
86   :link '(custom-manual "(gnus)Listing Groups")
87   :group 'gnus-group)
88
89 (defgroup gnus-group-visual nil
90   "Sorting the group buffer."
91   :link '(custom-manual "(gnus)Group Buffer Format")
92   :group 'gnus-group
93   :group 'gnus-visual)
94
95 (defgroup gnus-group-various nil
96   "Various group options."
97   :link '(custom-manual "(gnus)Scanning New Messages")
98   :group 'gnus-group)
99
100 ;; These belong to gnus-sum.el.
101 (defgroup gnus-summary nil
102   "Summary buffers."
103   :link '(custom-manual "(gnus)The Summary Buffer")
104   :group 'gnus)
105
106 (defgroup gnus-summary-exit nil
107   "Leaving summary buffers."
108   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
109   :group 'gnus-summary)
110
111 (defgroup gnus-summary-marks nil
112   "Marks used in summary buffers."
113   :link '(custom-manual "(gnus)Marking Articles")
114   :group 'gnus-summary)
115
116 (defgroup gnus-thread nil
117   "Ordering articles according to replies."
118   :link '(custom-manual "(gnus)Threading")
119   :group 'gnus-summary)
120
121 (defgroup gnus-summary-format nil
122   "Formatting of the summary buffer."
123   :link '(custom-manual "(gnus)Summary Buffer Format")
124   :group 'gnus-summary)
125
126 (defgroup gnus-summary-choose nil
127   "Choosing Articles."
128   :link '(custom-manual "(gnus)Choosing Articles")
129   :group 'gnus-summary)
130
131 (defgroup gnus-summary-maneuvering nil
132   "Summary movement commands."
133   :link '(custom-manual "(gnus)Summary Maneuvering")
134   :group 'gnus-summary)
135
136 (defgroup gnus-summary-mail nil
137   "Mail group commands."
138   :link '(custom-manual "(gnus)Mail Group Commands")
139   :group 'gnus-summary)
140
141 (defgroup gnus-summary-sort nil
142   "Sorting the summary buffer."
143   :link '(custom-manual "(gnus)Sorting")
144   :group 'gnus-summary)
145
146 (defgroup gnus-summary-visual nil
147   "Highlighting and menus in the summary buffer."
148   :link '(custom-manual "(gnus)Summary Highlighting")
149   :group 'gnus-visual
150   :group 'gnus-summary)
151
152 (defgroup gnus-summary-various nil
153   "Various summary buffer options."
154   :link '(custom-manual "(gnus)Various Summary Stuff")
155   :group 'gnus-summary)
156
157 (defgroup gnus-summary-pick nil
158   "Pick mode in the summary buffer."
159   :link '(custom-manual "(gnus)Pick and Read")
160   :prefix "gnus-pick-"
161   :group 'gnus-summary)
162
163 (defgroup gnus-summary-tree nil
164   "Tree display of threads in the summary buffer."
165   :link '(custom-manual "(gnus)Tree Display")
166   :prefix "gnus-tree-"
167   :group 'gnus-summary)
168
169 ;; Belongs to gnus-uu.el
170 (defgroup gnus-extract-view nil
171   "Viewing extracted files."
172   :link '(custom-manual "(gnus)Viewing Files")
173   :group 'gnus-extract)
174
175 ;; Belongs to gnus-score.el
176 (defgroup gnus-score nil
177   "Score and kill file handling."
178   :group 'gnus)
179
180 (defgroup gnus-score-kill nil
181   "Kill files."
182   :group 'gnus-score)
183
184 (defgroup gnus-score-adapt nil
185   "Adaptive score files."
186   :group 'gnus-score)
187
188 (defgroup gnus-score-default nil
189   "Default values for score files."
190   :group 'gnus-score)
191
192 (defgroup gnus-score-expire nil
193   "Expiring score rules."
194   :group 'gnus-score)
195
196 (defgroup gnus-score-decay nil
197   "Decaying score rules."
198   :group 'gnus-score)
199
200 (defgroup gnus-score-files nil
201   "Score and kill file names."
202   :group 'gnus-score
203   :group 'gnus-files)
204
205 (defgroup gnus-score-various nil
206   "Various scoring and killing options."
207   :group 'gnus-score)
208
209 ;; Other
210 (defgroup gnus-visual nil
211   "Options controling the visual fluff."
212   :group 'gnus
213   :group 'faces)
214
215 (defgroup gnus-agent nil
216   "Offline support for Gnus."
217   :group 'gnus)
218
219 (defgroup gnus-files nil
220   "Files used by Gnus."
221   :group 'gnus)
222
223 (defgroup gnus-dribble-file nil
224   "Auto save file."
225   :link '(custom-manual "(gnus)Auto Save")
226   :group 'gnus-files)
227
228 (defgroup gnus-newsrc nil
229   "Storing Gnus state."
230   :group 'gnus-files)
231
232 (defgroup gnus-server nil
233   "Options related to newsservers and other servers used by Gnus."
234   :group 'gnus)
235
236 (defgroup gnus-message '((message custom-group))
237   "Composing replies and followups in Gnus."
238   :group 'gnus)
239
240 (defgroup gnus-meta nil
241   "Meta variables controling major portions of Gnus.
242 In general, modifying these variables does not take affect until Gnus
243 is restarted, and sometimes reloaded."
244   :group 'gnus)
245
246 (defgroup gnus-various nil
247   "Other Gnus options."
248   :link '(custom-manual "(gnus)Various Various")
249   :group 'gnus)
250
251 (defgroup gnus-mime nil
252   "Variables for controlling the Gnus MIME interface."
253   :group 'gnus)
254
255 (defgroup gnus-exit nil
256   "Exiting gnus."
257   :link '(custom-manual "(gnus)Exiting Gnus")
258   :group 'gnus)
259
260 (defconst gnus-version-number "5.8.7"
261   "Version number for this version of Gnus.")
262
263 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
264   "Version string for this version of Gnus.")
265
266 (defcustom gnus-inhibit-startup-message nil
267   "If non-nil, the startup message will not be displayed.
268 This variable is used before `.gnus.el' is loaded, so it should
269 be set in `.emacs' instead."
270   :group 'gnus-start
271   :type 'boolean)
272
273 (defcustom gnus-play-startup-jingle nil
274   "If non-nil, play the Gnus jingle at startup."
275   :group 'gnus-start
276   :type 'boolean)
277
278 (unless (featurep 'gnus-xmas)
279   (defalias 'gnus-make-overlay 'make-overlay)
280   (defalias 'gnus-delete-overlay 'delete-overlay)
281   (defalias 'gnus-overlay-put 'overlay-put)
282   (defalias 'gnus-move-overlay 'move-overlay)
283   (defalias 'gnus-overlay-end 'overlay-end)
284   (defalias 'gnus-extent-detached-p 'ignore)
285   (defalias 'gnus-extent-start-open 'ignore)
286   (defalias 'gnus-set-text-properties 'set-text-properties)
287   (defalias 'gnus-group-remove-excess-properties 'ignore)
288   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
289   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
290   (defalias 'gnus-character-to-event 'identity)
291   (defalias 'gnus-add-text-properties 'add-text-properties)
292   (defalias 'gnus-put-text-property 'put-text-property)
293   (defalias 'gnus-mode-line-buffer-identification 'identity)
294   (defalias 'gnus-characterp 'numberp)
295   (defalias 'gnus-deactivate-mark 'deactivate-mark)
296   (defalias 'gnus-window-edges 'window-edges)
297   (defalias 'gnus-key-press-event-p 'numberp)
298   (defalias 'gnus-decode-rfc1522 'ignore))
299
300 ;; We define these group faces here to avoid the display
301 ;; update forced when creating new faces.
302
303 (defface gnus-group-news-1-face
304   '((((class color)
305       (background dark))
306      (:foreground "PaleTurquoise" :bold t))
307     (((class color)
308       (background light))
309      (:foreground "ForestGreen" :bold t))
310     (t
311      ()))
312   "Level 1 newsgroup face.")
313
314 (defface gnus-group-news-1-empty-face
315   '((((class color)
316       (background dark))
317      (:foreground "PaleTurquoise"))
318     (((class color)
319       (background light))
320      (:foreground "ForestGreen"))
321     (t
322      ()))
323   "Level 1 empty newsgroup face.")
324
325 (defface gnus-group-news-2-face
326   '((((class color)
327       (background dark))
328      (:foreground "turquoise" :bold t))
329     (((class color)
330       (background light))
331      (:foreground "CadetBlue4" :bold t))
332     (t
333      ()))
334   "Level 2 newsgroup face.")
335
336 (defface gnus-group-news-2-empty-face
337   '((((class color)
338       (background dark))
339      (:foreground "turquoise"))
340     (((class color)
341       (background light))
342      (:foreground "CadetBlue4"))
343     (t
344      ()))
345   "Level 2 empty newsgroup face.")
346
347 (defface gnus-group-news-3-face
348   '((((class color)
349       (background dark))
350      (:bold t))
351     (((class color)
352       (background light))
353      (:bold t))
354     (t
355      ()))
356   "Level 3 newsgroup face.")
357
358 (defface gnus-group-news-3-empty-face
359   '((((class color)
360       (background dark))
361      ())
362     (((class color)
363       (background light))
364      ())
365     (t
366      ()))
367   "Level 3 empty newsgroup face.")
368
369 (defface gnus-group-news-4-face
370   '((((class color)
371       (background dark))
372      (:bold t))
373     (((class color)
374       (background light))
375      (:bold t))
376     (t
377      ()))
378   "Level 4 newsgroup face.")
379
380 (defface gnus-group-news-4-empty-face
381   '((((class color)
382       (background dark))
383      ())
384     (((class color)
385       (background light))
386      ())
387     (t
388      ()))
389   "Level 4 empty newsgroup face.")
390
391 (defface gnus-group-news-5-face
392   '((((class color)
393       (background dark))
394      (:bold t))
395     (((class color)
396       (background light))
397      (:bold t))
398     (t
399      ()))
400   "Level 5 newsgroup face.")
401
402 (defface gnus-group-news-5-empty-face
403   '((((class color)
404       (background dark))
405      ())
406     (((class color)
407       (background light))
408      ())
409     (t
410      ()))
411   "Level 5 empty newsgroup face.")
412
413 (defface gnus-group-news-6-face
414   '((((class color)
415       (background dark))
416      (:bold t))
417     (((class color)
418       (background light))
419      (:bold t))
420     (t
421      ()))
422   "Level 6 newsgroup face.")
423
424 (defface gnus-group-news-6-empty-face
425   '((((class color)
426       (background dark))
427      ())
428     (((class color)
429       (background light))
430      ())
431     (t
432      ()))
433   "Level 6 empty newsgroup face.")
434
435 (defface gnus-group-news-low-face
436   '((((class color)
437       (background dark))
438      (:foreground "DarkTurquoise" :bold t))
439     (((class color)
440       (background light))
441      (:foreground "DarkGreen" :bold t))
442     (t
443      ()))
444   "Low level newsgroup face.")
445
446 (defface gnus-group-news-low-empty-face
447   '((((class color)
448       (background dark))
449      (:foreground "DarkTurquoise"))
450     (((class color)
451       (background light))
452      (:foreground "DarkGreen"))
453     (t
454      ()))
455   "Low level empty newsgroup face.")
456
457 (defface gnus-group-mail-1-face
458   '((((class color)
459       (background dark))
460      (:foreground "aquamarine1" :bold t))
461     (((class color)
462       (background light))
463      (:foreground "DeepPink3" :bold t))
464     (t
465      (:bold t)))
466   "Level 1 mailgroup face.")
467
468 (defface gnus-group-mail-1-empty-face
469   '((((class color)
470       (background dark))
471      (:foreground "aquamarine1"))
472     (((class color)
473       (background light))
474      (:foreground "DeepPink3"))
475     (t
476      (:italic t :bold t)))
477   "Level 1 empty mailgroup face.")
478
479 (defface gnus-group-mail-2-face
480   '((((class color)
481       (background dark))
482      (:foreground "aquamarine2" :bold t))
483     (((class color)
484       (background light))
485      (:foreground "HotPink3" :bold t))
486     (t
487      (:bold t)))
488   "Level 2 mailgroup face.")
489
490 (defface gnus-group-mail-2-empty-face
491   '((((class color)
492       (background dark))
493      (:foreground "aquamarine2"))
494     (((class color)
495       (background light))
496      (:foreground "HotPink3"))
497     (t
498      (:bold t)))
499   "Level 2 empty mailgroup face.")
500
501 (defface gnus-group-mail-3-face
502   '((((class color)
503       (background dark))
504      (:foreground "aquamarine3" :bold t))
505     (((class color)
506       (background light))
507      (:foreground "magenta4" :bold t))
508     (t
509      (:bold t)))
510   "Level 3 mailgroup face.")
511
512 (defface gnus-group-mail-3-empty-face
513   '((((class color)
514       (background dark))
515      (:foreground "aquamarine3"))
516     (((class color)
517       (background light))
518      (:foreground "magenta4"))
519     (t
520      ()))
521   "Level 3 empty mailgroup face.")
522
523 (defface gnus-group-mail-low-face
524   '((((class color)
525       (background dark))
526      (:foreground "aquamarine4" :bold t))
527     (((class color)
528       (background light))
529      (:foreground "DeepPink4" :bold t))
530     (t
531      (:bold t)))
532   "Low level mailgroup face.")
533
534 (defface gnus-group-mail-low-empty-face
535   '((((class color)
536       (background dark))
537      (:foreground "aquamarine4"))
538     (((class color)
539       (background light))
540      (:foreground "DeepPink4"))
541     (t
542      (:bold t)))
543   "Low level empty mailgroup face.")
544
545 ;; Summary mode faces.
546
547 (defface gnus-summary-selected-face '((t
548                                        (:underline t)))
549   "Face used for selected articles.")
550
551 (defface gnus-summary-cancelled-face
552   '((((class color))
553      (:foreground "yellow" :background "black")))
554   "Face used for cancelled articles.")
555
556 (defface gnus-summary-high-ticked-face
557   '((((class color)
558       (background dark))
559      (:foreground "pink" :bold t))
560     (((class color)
561       (background light))
562      (:foreground "firebrick" :bold t))
563     (t
564      (:bold t)))
565   "Face used for high interest ticked articles.")
566
567 (defface gnus-summary-low-ticked-face
568   '((((class color)
569       (background dark))
570      (:foreground "pink" :italic t))
571     (((class color)
572       (background light))
573      (:foreground "firebrick" :italic t))
574     (t
575      (:italic t)))
576   "Face used for low interest ticked articles.")
577
578 (defface gnus-summary-normal-ticked-face
579   '((((class color)
580       (background dark))
581      (:foreground "pink"))
582     (((class color)
583       (background light))
584      (:foreground "firebrick"))
585     (t
586      ()))
587   "Face used for normal interest ticked articles.")
588
589 (defface gnus-summary-high-ancient-face
590   '((((class color)
591       (background dark))
592      (:foreground "SkyBlue" :bold t))
593     (((class color)
594       (background light))
595      (:foreground "RoyalBlue" :bold t))
596     (t
597      (:bold t)))
598   "Face used for high interest ancient articles.")
599
600 (defface gnus-summary-low-ancient-face
601   '((((class color)
602       (background dark))
603      (:foreground "SkyBlue" :italic t))
604     (((class color)
605       (background light))
606      (:foreground "RoyalBlue" :italic t))
607     (t
608      (:italic t)))
609   "Face used for low interest ancient articles.")
610
611 (defface gnus-summary-normal-ancient-face
612   '((((class color)
613       (background dark))
614      (:foreground "SkyBlue"))
615     (((class color)
616       (background light))
617      (:foreground "RoyalBlue"))
618     (t
619      ()))
620   "Face used for normal interest ancient articles.")
621
622 (defface gnus-summary-high-unread-face
623   '((t
624      (:bold t)))
625   "Face used for high interest unread articles.")
626
627 (defface gnus-summary-low-unread-face
628   '((t
629      (:italic t)))
630   "Face used for low interest unread articles.")
631
632 (defface gnus-summary-normal-unread-face
633   '((t
634      ()))
635   "Face used for normal interest unread articles.")
636
637 (defface gnus-summary-high-read-face
638   '((((class color)
639       (background dark))
640      (:foreground "PaleGreen"
641                   :bold t))
642     (((class color)
643       (background light))
644      (:foreground "DarkGreen"
645                   :bold t))
646     (t
647      (:bold t)))
648   "Face used for high interest read articles.")
649
650 (defface gnus-summary-low-read-face
651   '((((class color)
652       (background dark))
653      (:foreground "PaleGreen"
654                   :italic t))
655     (((class color)
656       (background light))
657      (:foreground "DarkGreen"
658                   :italic t))
659     (t
660      (:italic t)))
661   "Face used for low interest read articles.")
662
663 (defface gnus-summary-normal-read-face
664   '((((class color)
665       (background dark))
666      (:foreground "PaleGreen"))
667     (((class color)
668       (background light))
669      (:foreground "DarkGreen"))
670     (t
671      ()))
672   "Face used for normal interest read articles.")
673
674
675 ;;;
676 ;;; Gnus buffers
677 ;;;
678
679 (defvar gnus-buffers nil)
680
681 (defun gnus-get-buffer-create (name)
682   "Do the same as `get-buffer-create', but store the created buffer."
683   (or (get-buffer name)
684       (car (push (get-buffer-create name) gnus-buffers))))
685
686 (defun gnus-add-buffer ()
687   "Add the current buffer to the list of Gnus buffers."
688   (push (current-buffer) gnus-buffers))
689
690 (defun gnus-buffers ()
691   "Return a list of live Gnus buffers."
692   (while (and gnus-buffers
693               (not (buffer-name (car gnus-buffers))))
694     (pop gnus-buffers))
695   (let ((buffers gnus-buffers))
696     (while (cdr buffers)
697       (if (buffer-name (cadr buffers))
698           (pop buffers)
699         (setcdr buffers (cddr buffers)))))
700   gnus-buffers)
701
702 ;;; Splash screen.
703
704 (defvar gnus-group-buffer "*Group*")
705
706 (eval-and-compile
707   (autoload 'gnus-play-jingle "gnus-audio"))
708
709 (defface gnus-splash-face
710   '((((class color)
711       (background dark))
712      (:foreground "Brown"))
713     (((class color)
714       (background light))
715      (:foreground "Brown"))
716     (t
717      ()))
718   "Face of the splash screen.")
719
720 (defun gnus-splash ()
721   (save-excursion
722     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
723     (let ((buffer-read-only nil))
724       (erase-buffer)
725       (unless gnus-inhibit-startup-message
726         (gnus-group-startup-message)
727         (sit-for 0)
728         (when gnus-play-startup-jingle
729           (gnus-play-jingle))))))
730
731 (defun gnus-indent-rigidly (start end arg)
732   "Indent rigidly using only spaces and no tabs."
733   (save-excursion
734     (save-restriction
735       (narrow-to-region start end)
736       (let ((tab-width 8))
737         (indent-rigidly start end arg)
738         ;; We translate tabs into spaces -- not everybody uses
739         ;; an 8-character tab.
740         (goto-char (point-min))
741         (while (search-forward "\t" nil t)
742           (replace-match "        " t t))))))
743
744 (defvar gnus-simple-splash nil)
745
746 (defun gnus-group-startup-message (&optional x y)
747   "Insert startup message in current buffer."
748   ;; Insert the message.
749   (erase-buffer)
750   (cond
751    ((and (fboundp 'find-image)
752          (display-graphic-p)
753          (let ((image (find-image '((:type xpm :file "gnus.xpm")
754                                     (:type xbm :file "gnus.xbm")))))
755            (when image
756              (newline)                  ; Have somewhere for cursor to
757                                         ; go, not stretched over image.
758              (insert-image image " ")
759              (goto-char (point-min))
760              (while (not (eobp))
761                (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
762                                     ?\ ))
763                (forward-line 1))
764              (setq gnus-simple-splash nil)
765              t))))
766    (t
767     (insert
768      (format "              %s
769           _    ___ _             _
770           _ ___ __ ___  __    _ ___
771           __   _     ___    __  ___
772               _           ___     _
773              _  _ __             _
774              ___   __            _
775                    __           _
776                     _      _   _
777                    _      _    _
778                       _  _    _
779                   __  ___
780                  _   _ _     _
781                 _   _
782               _    _
783              _    _
784             _
785           __
786
787 "
788              ""))
789     ;; And then hack it.
790     (gnus-indent-rigidly (point-min) (point-max)
791                          (/ (max (- (window-width) (or x 46)) 0) 2))
792     (goto-char (point-min))
793     (forward-line 1)
794     (let* ((pheight (count-lines (point-min) (point-max)))
795            (wheight (window-height))
796            (rest (- wheight pheight)))
797       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
798     ;; Fontify some.
799     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
800     (setq gnus-simple-splash t)))
801   (goto-char (point-min))
802   (setq mode-line-buffer-identification (concat " " gnus-version))
803   (set-buffer-modified-p t))
804
805 (eval-when (load)
806   (let ((command (format "%s" this-command)))
807     (if (and (string-match "gnus" command)
808              (not (string-match "gnus-other-frame" command)))
809         (gnus-splash)
810       (gnus-get-buffer-create gnus-group-buffer))))
811
812 ;;; Do the rest.
813
814 (require 'custom)
815 (require 'gnus-util)
816 (require 'nnheader)
817
818 (defcustom gnus-home-directory "~/"
819   "Directory variable that specifies the \"home\" directory.
820 All other Gnus path variables are initialized from this variable."
821   :group 'gnus-files
822   :type 'directory)
823
824 (defcustom gnus-directory (or (getenv "SAVEDIR")
825                               (nnheader-concat gnus-home-directory "News/"))
826   "*Directory variable from which all other Gnus file variables are derived.
827
828 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
829 This means that other directory variables that are initialized from
830 this variable won't be set properly if you set this variable in `.gnus.el'.
831 Set this variable in `.emacs' instead."
832   :group 'gnus-files
833   :type 'directory)
834
835 (defcustom gnus-default-directory nil
836   "*Default directory for all Gnus buffers."
837   :group 'gnus-files
838   :type '(choice (const :tag "current" nil)
839                  directory))
840
841 ;; Site dependent variables.  These variables should be defined in
842 ;; paths.el.
843
844 (defvar gnus-default-nntp-server nil
845   "Specify a default NNTP server.
846 This variable should be defined in paths.el, and should never be set
847 by the user.
848 If you want to change servers, you should use `gnus-select-method'.
849 See the documentation to that variable.")
850
851 ;; Don't touch this variable.
852 (defvar gnus-nntp-service "nntp"
853   "NNTP service name (\"nntp\" or 119).
854 This is an obsolete variable, which is scarcely used.  If you use an
855 nntp server for your newsgroup and want to change the port number
856 used to 899, you would say something along these lines:
857
858  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
859
860 (defcustom gnus-nntpserver-file "/etc/nntpserver"
861   "A file with only the name of the nntp server in it."
862   :group 'gnus-files
863   :group 'gnus-server
864   :type 'file)
865
866 ;; This function is used to check both the environment variable
867 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
868 ;; an nntp server name default.
869 (defun gnus-getenv-nntpserver ()
870   (or (getenv "NNTPSERVER")
871       (and (file-readable-p gnus-nntpserver-file)
872            (save-excursion
873              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
874              (insert-file-contents gnus-nntpserver-file)
875              (let ((name (buffer-string)))
876                (prog1
877                    (if (string-match "\\'[ \t\n]*$" name)
878                        nil
879                      name)
880                  (kill-buffer (current-buffer))))))))
881
882 (defcustom gnus-select-method
883   (condition-case nil
884       (nconc
885        (list 'nntp (or (condition-case nil
886                            (gnus-getenv-nntpserver)
887                          (error nil))
888                        (when (and gnus-default-nntp-server
889                                   (not (string= gnus-default-nntp-server "")))
890                          gnus-default-nntp-server)
891                        "news"))
892        (if (or (null gnus-nntp-service)
893                (equal gnus-nntp-service "nntp"))
894            nil
895          (list gnus-nntp-service)))
896     (error nil))
897   "Default method for selecting a newsgroup.
898 This variable should be a list, where the first element is how the
899 news is to be fetched, the second is the address.
900
901 For instance, if you want to get your news via NNTP from
902 \"flab.flab.edu\", you could say:
903
904 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
905
906 If you want to use your local spool, say:
907
908 \(setq gnus-select-method (list 'nnspool (system-name)))
909
910 If you use this variable, you must set `gnus-nntp-server' to nil.
911
912 There is a lot more to know about select methods and virtual servers -
913 see the manual for details."
914   :group 'gnus-server
915   :type 'gnus-select-method)
916
917 (defcustom gnus-message-archive-method
918   `(nnfolder
919     "archive"
920     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
921     (nnfolder-active-file
922      ,(nnheader-concat message-directory "archive/active"))
923     (nnfolder-get-new-mail nil)
924     (nnfolder-inhibit-expiry t))
925   "*Method used for archiving messages you've sent.
926 This should be a mail method.
927
928 It's probably not very effective to change this variable once you've
929 run Gnus once.  After doing that, you must edit this server from the
930 server buffer."
931   :group 'gnus-server
932   :group 'gnus-message
933   :type 'gnus-select-method)
934
935 (defcustom gnus-message-archive-group nil
936   "*Name of the group in which to save the messages you've written.
937 This can either be a string; a list of strings; or an alist
938 of regexps/functions/forms to be evaluated to return a string (or a list
939 of strings).  The functions are called with the name of the current
940 group (or nil) as a parameter.
941
942 If you want to save your mail in one group and the news articles you
943 write in another group, you could say something like:
944
945  \(setq gnus-message-archive-group
946         '((if (message-news-p)
947               \"misc-news\"
948             \"misc-mail\")))
949
950 Normally the group names returned by this variable should be
951 unprefixed -- which implicitly means \"store on the archive server\".
952 However, you may wish to store the message on some other server.  In
953 that case, just return a fully prefixed name of the group --
954 \"nnml+private:mail.misc\", for instance."
955   :group 'gnus-message
956   :type '(choice (const :tag "none" nil)
957                  function
958                  sexp
959                  string))
960
961 (defcustom gnus-secondary-servers nil
962   "List of NNTP servers that the user can choose between interactively.
963 To make Gnus query you for a server, you have to give `gnus' a
964 non-numeric prefix - `C-u M-x gnus', in short."
965   :group 'gnus-server
966   :type '(repeat string))
967
968 (defcustom gnus-nntp-server nil
969   "*The name of the host running the NNTP server.
970 This variable is semi-obsolete.  Use the `gnus-select-method'
971 variable instead."
972   :group 'gnus-server
973   :type '(choice (const :tag "disable" nil)
974                  string))
975
976 (defcustom gnus-secondary-select-methods nil
977   "A list of secondary methods that will be used for reading news.
978 This is a list where each element is a complete select method (see
979 `gnus-select-method').
980
981 If, for instance, you want to read your mail with the nnml backend,
982 you could set this variable:
983
984 \(setq gnus-secondary-select-methods '((nnml \"\")))"
985   :group 'gnus-server
986   :type '(repeat gnus-select-method))
987
988 (defvar gnus-backup-default-subscribed-newsgroups
989   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
990   "Default default new newsgroups the first time Gnus is run.
991 Should be set in paths.el, and shouldn't be touched by the user.")
992
993 (defcustom gnus-local-domain nil
994   "Local domain name without a host name.
995 The DOMAINNAME environment variable is used instead if it is defined.
996 If the `system-name' function returns the full Internet name, there is
997 no need to set this variable."
998   :group 'gnus-message
999   :type '(choice (const :tag "default" nil)
1000                  string))
1001
1002 (defvar gnus-local-organization nil
1003   "String with a description of what organization (if any) the user belongs to.
1004 Obsolete variable; use `message-user-organization' instead.")
1005
1006 ;; Customization variables
1007
1008 (defcustom gnus-refer-article-method nil
1009   "Preferred method for fetching an article by Message-ID.
1010 If you are reading news from the local spool (with nnspool), fetching
1011 articles by Message-ID is painfully slow.  By setting this method to an
1012 nntp method, you might get acceptable results.
1013
1014 The value of this variable must be a valid select method as discussed
1015 in the documentation of `gnus-select-method'.
1016
1017 It can also be a list of select methods, as well as the special symbol
1018 `current', which means to use the current select method.  If it is a
1019 list, Gnus will try all the methods in the list until it finds a match."
1020   :group 'gnus-server
1021   :type '(choice (const :tag "default" nil)
1022                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1023                  gnus-select-method
1024                  (repeat :menu-tag "Try multiple" 
1025                          :tag "Multiple"
1026                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1027                          (choice :tag "Method"
1028                                  (const current)
1029                                  (const :tag "DejaNews" 
1030                                         (nnweb "refer" (nnweb-type dejanews)))
1031                                  gnus-select-method))))
1032
1033 (defcustom gnus-group-faq-directory
1034   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1035     "/ftp@sunsite.auc.dk:/pub/usenet/"
1036     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1037     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1038     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1039     "/ftp@rtfm.mit.edu:/pub/usenet/"
1040     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1041     "/ftp@ftp.sunet.se:/pub/usenet/"
1042     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1043     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1044     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1045   "*Directory where the group FAQs are stored.
1046 This will most commonly be on a remote machine, and the file will be
1047 fetched by ange-ftp.
1048
1049 This variable can also be a list of directories.  In that case, the
1050 first element in the list will be used by default.  The others can
1051 be used when being prompted for a site.
1052
1053 Note that Gnus uses an aol machine as the default directory.  If this
1054 feels fundamentally unclean, just think of it as a way to finally get
1055 something of value back from them.
1056
1057 If the default site is too slow, try one of these:
1058
1059    North America: mirrors.aol.com                /pub/rtfm/usenet
1060                   ftp.seas.gwu.edu               /pub/rtfm
1061                   rtfm.mit.edu                   /pub/usenet
1062    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1063                   src.doc.ic.ac.uk               /usenet/news-FAQS
1064                   ftp.sunet.se                   /pub/usenet
1065                   sunsite.auc.dk                 /pub/usenet
1066    Asia:          nctuccca.edu.tw                /USENET/FAQ
1067                   hwarang.postech.ac.kr          /pub/usenet
1068                   ftp.hk.super.net               /mirror/faqs"
1069   :group 'gnus-group-various
1070   :type '(choice directory
1071                  (repeat directory)))
1072
1073 (defcustom gnus-use-cross-reference t
1074   "*Non-nil means that cross referenced articles will be marked as read.
1075 If nil, ignore cross references.  If t, mark articles as read in
1076 subscribed newsgroups.  If neither t nor nil, mark as read in all
1077 newsgroups."
1078   :group 'gnus-server
1079   :type '(choice (const :tag "off" nil)
1080                  (const :tag "subscribed" t)
1081                  (sexp :format "all"
1082                        :value always)))
1083
1084 (defcustom gnus-process-mark ?#
1085   "*Process mark."
1086   :group 'gnus-group-visual
1087   :group 'gnus-summary-marks
1088   :type 'character)
1089
1090 (defcustom gnus-asynchronous nil
1091   "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1092   :group 'gnus-asynchronous
1093   :type 'boolean)
1094
1095 (defcustom gnus-large-newsgroup 200
1096   "*The number of articles which indicates a large newsgroup.
1097 If the number of articles in a newsgroup is greater than this value,
1098 confirmation is required for selecting the newsgroup."
1099   :group 'gnus-group-select
1100   :type 'integer)
1101
1102 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1103   "*Non-nil means that the default name of a file to save articles in is the group name.
1104 If it's nil, the directory form of the group name is used instead.
1105
1106 If this variable is a list, and the list contains the element
1107 `not-score', long file names will not be used for score files; if it
1108 contains the element `not-save', long file names will not be used for
1109 saving; and if it contains the element `not-kill', long file names
1110 will not be used for kill files.
1111
1112 Note that the default for this variable varies according to what system
1113 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1114 to nil while on all other systems it defaults to t."
1115   :group 'gnus-start
1116   :type 'boolean)
1117
1118 (defcustom gnus-kill-files-directory gnus-directory
1119   "*Name of the directory where kill files will be stored (default \"~/News\")."
1120   :group 'gnus-score-files
1121   :group 'gnus-score-kill
1122   :type 'directory)
1123
1124 (defcustom gnus-save-score nil
1125   "*If non-nil, save group scoring info."
1126   :group 'gnus-score-various
1127   :group 'gnus-start
1128   :type 'boolean)
1129
1130 (defcustom gnus-use-undo t
1131   "*If non-nil, allow undoing in Gnus group mode buffers."
1132   :group 'gnus-meta
1133   :type 'boolean)
1134
1135 (defcustom gnus-use-adaptive-scoring nil
1136   "*If non-nil, use some adaptive scoring scheme.
1137 If a list, then the values `word' and `line' are meaningful.  The
1138 former will perform adaption on individual words in the subject
1139 header while `line' will perform adaption on several headers."
1140   :group 'gnus-meta
1141   :group 'gnus-score-adapt
1142   :type '(set (const word) (const line)))
1143
1144 (defcustom gnus-use-cache 'passive
1145   "*If nil, Gnus will ignore the article cache.
1146 If `passive', it will allow entering (and reading) articles
1147 explicitly entered into the cache.  If anything else, use the
1148 cache to the full extent of the law."
1149   :group 'gnus-meta
1150   :group 'gnus-cache
1151   :type '(choice (const :tag "off" nil)
1152                  (const :tag "passive" passive)
1153                  (const :tag "active" t)))
1154
1155 (defcustom gnus-use-trees nil
1156   "*If non-nil, display a thread tree buffer."
1157   :group 'gnus-meta
1158   :type 'boolean)
1159
1160 (defcustom gnus-use-grouplens nil
1161   "*If non-nil, use GroupLens ratings."
1162   :group 'gnus-meta
1163   :type 'boolean)
1164
1165 (defcustom gnus-keep-backlog nil
1166   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1167 If it is a number N, then Gnus will only keep the last N articles
1168 read.  If it is neither nil nor a number, Gnus will keep all read
1169 articles.  This is not a good idea."
1170   :group 'gnus-meta
1171   :type '(choice (const :tag "off" nil)
1172                  integer
1173                  (sexp :format "all"
1174                        :value t)))
1175
1176 (defcustom gnus-use-nocem nil
1177   "*If non-nil, Gnus will read NoCeM cancel messages."
1178   :group 'gnus-meta
1179   :type 'boolean)
1180
1181 (defcustom gnus-suppress-duplicates nil
1182   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1183   :group 'gnus-meta
1184   :type 'boolean)
1185
1186 (defcustom gnus-use-scoring t
1187   "*If non-nil, enable scoring."
1188   :group 'gnus-meta
1189   :type 'boolean)
1190
1191 (defcustom gnus-use-picons nil
1192   "*If non-nil, display picons in a frame of their own."
1193   :group 'gnus-meta
1194   :type 'boolean)
1195
1196 (defcustom gnus-summary-prepare-exit-hook
1197   '(gnus-summary-expire-articles)
1198   "*A hook called when preparing to exit from the summary buffer.
1199 It calls `gnus-summary-expire-articles' by default."
1200   :group 'gnus-summary-exit
1201   :type 'hook)
1202
1203 (defcustom gnus-novice-user t
1204   "*Non-nil means that you are a usenet novice.
1205 If non-nil, verbose messages may be displayed and confirmations may be
1206 required."
1207   :group 'gnus-meta
1208   :type 'boolean)
1209
1210 (defcustom gnus-expert-user nil
1211   "*Non-nil means that you will never be asked for confirmation about anything.
1212 That doesn't mean *anything* anything; particularly destructive
1213 commands will still require prompting."
1214   :group 'gnus-meta
1215   :type 'boolean)
1216
1217 (defcustom gnus-interactive-catchup t
1218   "*If non-nil, require your confirmation when catching up a group."
1219   :group 'gnus-group-select
1220   :type 'boolean)
1221
1222 (defcustom gnus-interactive-exit t
1223   "*If non-nil, require your confirmation when exiting Gnus."
1224   :group 'gnus-exit
1225   :type 'boolean)
1226
1227 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1228   "*Function for extracting address components from a From header.
1229 Two pre-defined function exist: `gnus-extract-address-components',
1230 which is the default, quite fast, and too simplistic solution, and
1231 `mail-extract-address-components', which works much better, but is
1232 slower."
1233   :group 'gnus-summary-format
1234   :type '(radio (function-item gnus-extract-address-components)
1235                 (function-item mail-extract-address-components)
1236                 (function :tag "Other")))
1237
1238 (defcustom gnus-carpal nil
1239   "*If non-nil, display clickable icons."
1240   :group 'gnus-meta
1241   :type 'boolean)
1242
1243 (defcustom gnus-shell-command-separator ";"
1244   "String used to separate to shell commands."
1245   :group 'gnus-files
1246   :type 'string)
1247
1248 (defcustom gnus-valid-select-methods
1249   '(("nntp" post address prompt-address physical-address)
1250     ("nnspool" post address)
1251     ("nnvirtual" post-mail virtual prompt-address)
1252     ("nnmbox" mail respool address)
1253     ("nnml" mail respool address)
1254     ("nnmh" mail respool address)
1255     ("nndir" post-mail prompt-address physical-address)
1256     ("nneething" none address prompt-address physical-address)
1257     ("nndoc" none address prompt-address)
1258     ("nnbabyl" mail address respool)
1259     ("nnkiboze" post virtual)
1260     ("nnsoup" post-mail address)
1261     ("nndraft" post-mail)
1262     ("nnfolder" mail respool address)
1263     ("nngateway" post-mail address prompt-address physical-address)
1264     ("nnweb" none)
1265     ("nnslashdot" post)
1266     ("nnultimate" none)
1267     ("nnwarchive" none)
1268     ("nnlistserv" none)
1269     ("nnagent" post-mail)
1270     ("nnimap" post-mail address prompt-address physical-address))
1271   "*An alist of valid select methods.
1272 The first element of each list lists should be a string with the name
1273 of the select method.  The other elements may be the category of
1274 this method (i. e., `post', `mail', `none' or whatever) or other
1275 properties that this method has (like being respoolable).
1276 If you implement a new select method, all you should have to change is
1277 this variable.  I think."
1278   :group 'gnus-server
1279   :type '(repeat (group (string :tag "Name")
1280                         (radio-button-choice (const :format "%v " post)
1281                                              (const :format "%v " mail)
1282                                              (const :format "%v " none)
1283                                              (const post-mail))
1284                         (checklist :inline t
1285                                    (const :format "%v " address)
1286                                    (const :format "%v " prompt-address)
1287                                    (const :format "%v " physical-address)
1288                                    (const :format "%v " virtual)
1289                                    (const respool)))))
1290
1291 (define-widget 'gnus-select-method 'list
1292   "Widget for entering a select method."
1293   :value '(nntp "")
1294   :tag "Select Method"
1295   :args `((choice :tag "Method"
1296                   ,@(mapcar (lambda (entry)
1297                               (list 'const :format "%v\n"
1298                                     (intern (car entry))))
1299                             gnus-valid-select-methods))
1300           (string :tag "Address")
1301           (repeat :tag "Options"
1302                   :inline t
1303                   (list :format "%v"
1304                         variable
1305                         (sexp :tag "Value")))))
1306
1307 (defcustom gnus-updated-mode-lines '(group article summary tree)
1308   "List of buffers that should update their mode lines.
1309 The list may contain the symbols `group', `article', `tree' and
1310 `summary'.  If the corresponding symbol is present, Gnus will keep
1311 that mode line updated with information that may be pertinent.
1312 If this variable is nil, screen refresh may be quicker."
1313   :group 'gnus-various
1314   :type '(set (const group)
1315               (const article)
1316               (const summary)
1317               (const tree)))
1318
1319 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1320 (defcustom gnus-mode-non-string-length nil
1321   "*Max length of mode-line non-string contents.
1322 If this is nil, Gnus will take space as is needed, leaving the rest
1323 of the modeline intact.  Note that the default of nil is unlikely
1324 to be desirable; see the manual for further details."
1325   :group 'gnus-various
1326   :type '(choice (const nil)
1327                  integer))
1328
1329 (defcustom gnus-auto-expirable-newsgroups nil
1330   "*Groups in which to automatically mark read articles as expirable.
1331 If non-nil, this should be a regexp that should match all groups in
1332 which to perform auto-expiry.  This only makes sense for mail groups."
1333   :group 'nnmail-expire
1334   :type '(choice (const nil)
1335                  regexp))
1336
1337 (defcustom gnus-total-expirable-newsgroups nil
1338   "*Groups in which to perform expiry of all read articles.
1339 Use with extreme caution.  All groups that match this regexp will be
1340 expiring - which means that all read articles will be deleted after
1341 \(say) one week.         (This only goes for mail groups and the like, of
1342 course.)"
1343   :group 'nnmail-expire
1344   :type '(choice (const nil)
1345                  regexp))
1346
1347 (defcustom gnus-group-uncollapsed-levels 1
1348   "Number of group name elements to leave alone when making a short group name."
1349   :group 'gnus-group-visual
1350   :type 'integer)
1351
1352 (defcustom gnus-group-use-permanent-levels nil
1353   "*If non-nil, once you set a level, Gnus will use this level."
1354   :group 'gnus-group-levels
1355   :type 'boolean)
1356
1357 ;; Hooks.
1358
1359 (defcustom gnus-load-hook nil
1360   "A hook run while Gnus is loaded."
1361   :group 'gnus-start
1362   :type 'hook)
1363
1364 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1365   "A hook called to apply kill files to a group.
1366 This hook is intended to apply a kill file to the selected newsgroup.
1367 The function `gnus-apply-kill-file' is called by default.
1368
1369 Since a general kill file is too heavy to use only for a few
1370 newsgroups, I recommend you to use a lighter hook function.  For
1371 example, if you'd like to apply a kill file to articles which contains
1372 a string `rmgroup' in subject in newsgroup `control', you can use the
1373 following hook:
1374
1375  (setq gnus-apply-kill-hook
1376       (list
1377         (lambda ()
1378           (cond ((string-match \"control\" gnus-newsgroup-name)
1379                  (gnus-kill \"Subject\" \"rmgroup\")
1380                  (gnus-expunge \"X\"))))))"
1381   :group 'gnus-score-kill
1382   :options '(gnus-apply-kill-file)
1383   :type 'hook)
1384
1385 (defcustom gnus-group-change-level-function nil
1386   "Function run when a group level is changed.
1387 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1388   :group 'gnus-group-levels
1389   :type 'function)
1390
1391 ;;; Face thingies.
1392
1393 (defcustom gnus-visual
1394   '(summary-highlight group-highlight article-highlight
1395                       mouse-face
1396                       summary-menu group-menu article-menu
1397                       tree-highlight menu highlight
1398                       browse-menu server-menu
1399                       page-marker tree-menu binary-menu pick-menu
1400                       grouplens-menu)
1401   "*Enable visual features.
1402 If `visual' is disabled, there will be no menus and few faces.  Most of
1403 the visual customization options below will be ignored.  Gnus will use
1404 less space and be faster as a result.
1405
1406 This variable can also be a list of visual elements to switch on.  For
1407 instance, to switch off all visual things except menus, you can say:
1408
1409    (setq gnus-visual '(menu))
1410
1411 Valid elements include `summary-highlight', `group-highlight',
1412 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1413 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1414 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1415 and `grouplens-menu'."
1416   :group 'gnus-meta
1417   :group 'gnus-visual
1418   :type '(set (const summary-highlight)
1419               (const group-highlight)
1420               (const article-highlight)
1421               (const mouse-face)
1422               (const summary-menu)
1423               (const group-menu)
1424               (const article-menu)
1425               (const tree-highlight)
1426               (const menu)
1427               (const highlight)
1428               (const browse-menu)
1429               (const server-menu)
1430               (const page-marker)
1431               (const tree-menu)
1432               (const binary-menu)
1433               (const pick-menu)
1434               (const grouplens-menu)))
1435
1436 (defcustom gnus-mouse-face
1437   (condition-case ()
1438       (if (gnus-visual-p 'mouse-face 'highlight)
1439           (if (boundp 'gnus-mouse-face)
1440               (or gnus-mouse-face 'highlight)
1441             'highlight)
1442         'default)
1443     (error 'highlight))
1444   "*Face used for group or summary buffer mouse highlighting.
1445 The line beneath the mouse pointer will be highlighted with this
1446 face."
1447   :group 'gnus-visual
1448   :type 'face)
1449
1450 (defcustom gnus-article-save-directory gnus-directory
1451   "*Name of the directory articles will be saved in (default \"~/News\")."
1452   :group 'gnus-article-saving
1453   :type 'directory)
1454
1455 (defvar gnus-plugged t
1456   "Whether Gnus is plugged or not.")
1457
1458 (defcustom gnus-default-charset 'iso-8859-1
1459   "Default charset assumed to be used when viewing non-ASCII characters.
1460 This variable is overridden on a group-to-group basis by the
1461 gnus-group-charset-alist variable and is only used on groups not
1462 covered by that variable."
1463   :type 'symbol
1464   :group 'gnus-charset)
1465
1466 (defcustom gnus-default-posting-charset nil
1467   "Default charset assumed to be used when posting non-ASCII characters.
1468 This variable is overridden on a group-to-group basis by the
1469 gnus-group-posting-charset-alist variable and is only used on groups not
1470 covered by that variable.
1471 If nil, no default charset is assumed when posting."
1472   :type 'symbol
1473   :group 'gnus-charset)
1474
1475 \f
1476 ;;; Internal variables
1477
1478 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1479 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1480 (defvar gnus-original-article-buffer " *Original Article*")
1481 (defvar gnus-newsgroup-name nil)
1482 (defvar gnus-ephemeral-servers nil)
1483
1484 (defvar gnus-agent nil
1485   "Whether we want to use the Gnus agent or not.")
1486
1487 (defvar gnus-command-method nil
1488   "Dynamically bound variable that says what the current backend is.")
1489
1490 (defvar gnus-current-select-method nil
1491   "The current method for selecting a newsgroup.")
1492
1493 (defvar gnus-tree-buffer "*Tree*"
1494   "Buffer where Gnus thread trees are displayed.")
1495
1496 ;; Dummy variable.
1497 (defvar gnus-use-generic-from nil)
1498
1499 ;; Variable holding the user answers to all method prompts.
1500 (defvar gnus-method-history nil)
1501
1502 ;; Variable holding the user answers to all mail method prompts.
1503 (defvar gnus-mail-method-history nil)
1504
1505 ;; Variable holding the user answers to all group prompts.
1506 (defvar gnus-group-history nil)
1507
1508 (defvar gnus-server-alist nil
1509   "List of available servers.")
1510
1511 (defcustom gnus-cache-directory
1512   (nnheader-concat gnus-directory "cache/")
1513   "*The directory where cached articles will be stored."
1514   :group 'gnus-cache
1515   :type 'directory)
1516
1517 (defvar gnus-predefined-server-alist
1518   `(("cache"
1519      nnspool "cache"
1520      (nnspool-spool-directory ,gnus-cache-directory)
1521      (nnspool-nov-directory ,gnus-cache-directory)
1522      (nnspool-active-file
1523       ,(nnheader-concat gnus-cache-directory "active"))))
1524   "List of predefined (convenience) servers.")
1525
1526 (defvar gnus-topic-indentation "");; Obsolete variable.
1527
1528 (defconst gnus-article-mark-lists
1529   '((marked . tick) (replied . reply)
1530     (expirable . expire) (killed . killed)
1531     (bookmarks . bookmark) (dormant . dormant)
1532     (scored . score) (saved . save)
1533     (cached . cache) (downloadable . download)
1534     (unsendable . unsend)))
1535
1536 (defvar gnus-headers-retrieved-by nil)
1537 (defvar gnus-article-reply nil)
1538 (defvar gnus-override-method nil)
1539 (defvar gnus-article-check-size nil)
1540 (defvar gnus-opened-servers nil)
1541
1542 (defvar gnus-current-kill-article nil)
1543
1544 (defvar gnus-have-read-active-file nil)
1545
1546 (defconst gnus-maintainer
1547   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1548   "The mail address of the Gnus maintainers.")
1549
1550 (defvar gnus-info-nodes
1551   '((gnus-group-mode "(gnus)The Group Buffer")
1552     (gnus-summary-mode "(gnus)The Summary Buffer")
1553     (gnus-article-mode "(gnus)The Article Buffer")
1554     (gnus-server-mode "(gnus)The Server Buffer")
1555     (gnus-browse-mode "(gnus)Browse Foreign Server")
1556     (gnus-tree-mode "(gnus)Tree Display"))
1557   "Alist of major modes and related Info nodes.")
1558
1559 (defvar gnus-group-buffer "*Group*")
1560 (defvar gnus-summary-buffer "*Summary*")
1561 (defvar gnus-article-buffer "*Article*")
1562 (defvar gnus-server-buffer "*Server*")
1563
1564 (defvar gnus-slave nil
1565   "Whether this Gnus is a slave or not.")
1566
1567 (defvar gnus-batch-mode nil
1568   "Whether this Gnus is running in batch mode or not.")
1569
1570 (defvar gnus-variable-list
1571   '(gnus-newsrc-options gnus-newsrc-options-n
1572                         gnus-newsrc-last-checked-date
1573                         gnus-newsrc-alist gnus-server-alist
1574                         gnus-killed-list gnus-zombie-list
1575                         gnus-topic-topology gnus-topic-alist
1576                         gnus-format-specs)
1577   "Gnus variables saved in the quick startup file.")
1578
1579 (defvar gnus-newsrc-alist nil
1580   "Assoc list of read articles.
1581 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1582
1583 (defvar gnus-newsrc-hashtb nil
1584   "Hashtable of gnus-newsrc-alist.")
1585
1586 (defvar gnus-killed-list nil
1587   "List of killed newsgroups.")
1588
1589 (defvar gnus-killed-hashtb nil
1590   "Hash table equivalent of gnus-killed-list.")
1591
1592 (defvar gnus-zombie-list nil
1593   "List of almost dead newsgroups.")
1594
1595 (defvar gnus-description-hashtb nil
1596   "Descriptions of newsgroups.")
1597
1598 (defvar gnus-list-of-killed-groups nil
1599   "List of newsgroups that have recently been killed by the user.")
1600
1601 (defvar gnus-active-hashtb nil
1602   "Hashtable of active articles.")
1603
1604 (defvar gnus-moderated-hashtb nil
1605   "Hashtable of moderated newsgroups.")
1606
1607 ;; Save window configuration.
1608 (defvar gnus-prev-winconf nil)
1609
1610 (defvar gnus-reffed-article-number nil)
1611
1612 ;;; Let the byte-compiler know that we know about this variable.
1613 (defvar rmail-default-rmail-file)
1614
1615 (defvar gnus-dead-summary nil)
1616
1617 ;;; End of variables.
1618
1619 ;; Define some autoload functions Gnus might use.
1620 (eval-and-compile
1621
1622   ;; This little mapcar goes through the list below and marks the
1623   ;; symbols in question as autoloaded functions.
1624   (mapcar
1625    (lambda (package)
1626      (let ((interactive (nth 1 (memq ':interactive package))))
1627        (mapcar
1628         (lambda (function)
1629           (let (keymap)
1630             (when (consp function)
1631               (setq keymap (car (memq 'keymap function)))
1632               (setq function (car function)))
1633             (unless (fboundp function)
1634               (autoload function (car package) nil interactive keymap))))
1635         (if (eq (nth 1 package) ':interactive)
1636             (nthcdr 3 package)
1637           (cdr package)))))
1638    '(("info" :interactive t Info-goto-node)
1639      ("pp" pp pp-to-string pp-eval-expression)
1640      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1641      ("ps-print" ps-print-preprint)
1642      ("browse-url" :interactive t browse-url)
1643      ("message" :interactive t
1644       message-send-and-exit message-yank-original)
1645      ("babel" babel-as-string)
1646      ("nnmail" nnmail-split-fancy nnmail-article-group)
1647      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1648      ("rmailout" rmail-output rmail-output-to-rmail-file)
1649      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1650       rmail-show-message rmail-summary-exists
1651       rmail-select-summary rmail-update-summary)
1652      ("gnus-audio" :interactive t gnus-audio-play)
1653      ("gnus-xmas" gnus-xmas-splash)
1654      ("gnus-soup" :interactive t
1655       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1656       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1657      ("nnsoup" nnsoup-pack-replies)
1658      ("score-mode" :interactive t gnus-score-mode)
1659      ("gnus-mh" gnus-summary-save-article-folder
1660       gnus-Folder-save-name gnus-folder-save-name)
1661      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1662      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1663       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1664       gnus-demon-add-disconnection gnus-demon-add-handler
1665       gnus-demon-remove-handler)
1666      ("gnus-demon" :interactive t
1667       gnus-demon-init gnus-demon-cancel)
1668      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1669       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1670      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1671       gnus-nocem-unwanted-article-p)
1672      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1673       gnus-server-server-name)
1674      ("gnus-srvr" gnus-browse-foreign-server)
1675      ("gnus-cite" :interactive t
1676       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1677       gnus-article-hide-citation gnus-article-fill-cited-article
1678       gnus-article-hide-citation-in-followups)
1679      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1680       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1681       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1682      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1683       gnus-cache-possibly-remove-articles gnus-cache-request-article
1684       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1685       gnus-cache-enter-remove-article gnus-cached-article-p
1686       gnus-cache-open gnus-cache-close gnus-cache-update-article
1687       gnus-cache-articles-in-group)
1688      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1689       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1690      ("gnus-score" :interactive t
1691       gnus-summary-increase-score gnus-summary-set-score
1692       gnus-summary-raise-thread gnus-summary-raise-same-subject
1693       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1694       gnus-summary-lower-thread gnus-summary-lower-same-subject
1695       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1696       gnus-summary-current-score gnus-score-delta-default
1697       gnus-score-flush-cache gnus-score-close
1698       gnus-possibly-score-headers gnus-score-followup-article
1699       gnus-score-followup-thread)
1700      ("gnus-score"
1701       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1702       gnus-current-score-file-nondirectory gnus-score-adaptive
1703       gnus-score-find-trace gnus-score-file-name)
1704      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1705      ("gnus-topic" :interactive t gnus-topic-mode)
1706      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1707       gnus-subscribe-topics)
1708      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1709      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1710      ("gnus-uu" :interactive t
1711       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1712       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1713       gnus-uu-mark-by-regexp gnus-uu-mark-all
1714       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1715       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1716       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1717       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1718       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1719       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1720       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1721       gnus-uu-mark-over gnus-uu-post-news)
1722      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1723      ("gnus-msg" (gnus-summary-send-map keymap)
1724       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1725      ("gnus-msg" :interactive t
1726       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1727       gnus-summary-followup gnus-summary-followup-with-original
1728       gnus-summary-cancel-article gnus-summary-supersede-article
1729       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1730       gnus-summary-mail-forward gnus-summary-mail-other-window
1731       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1732       gnus-summary-wide-reply gnus-summary-followup-to-mail
1733       gnus-summary-followup-to-mail-with-original gnus-bug
1734       gnus-summary-wide-reply-with-original
1735       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1736       gnus-summary-post-forward)
1737      ("gnus-picon" :interactive t gnus-article-display-picons
1738       gnus-group-display-picons gnus-picons-article-display-x-face
1739       gnus-picons-display-x-face)
1740      ("gnus-picon" gnus-picons-buffer-name)
1741      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1742       gnus-grouplens-mode)
1743      ("smiley" :interactive t gnus-smiley-display)
1744      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1745      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1746       gnus-list-of-unread-articles gnus-list-of-read-articles
1747       gnus-offer-save-summaries gnus-make-thread-indent-array
1748       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1749       gnus-summary-skip-intangible gnus-summary-article-number
1750       gnus-data-header gnus-data-find)
1751      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1752       gnus-group-list-groups gnus-group-first-unread-group
1753       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1754       gnus-group-setup-buffer gnus-group-get-new-news
1755       gnus-group-make-help-group gnus-group-update-group
1756       gnus-group-iterate gnus-group-group-name)
1757      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1758       gnus-backlog-remove-article)
1759      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1760       gnus-article-prepare gnus-article-set-window-start
1761       gnus-article-next-page gnus-article-prev-page
1762       gnus-request-article-this-buffer gnus-article-mode
1763       gnus-article-setup-buffer gnus-narrow-to-page
1764       gnus-article-delete-invisible-text gnus-treat-article)
1765      ("gnus-art" :interactive t
1766       gnus-article-hide-headers gnus-article-hide-boring-headers
1767       gnus-article-treat-overstrike 
1768       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1769       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1770       gnus-article-de-base64-unreadable
1771       gnus-article-decode-HZ
1772       gnus-article-hide-pgp
1773       gnus-article-hide-pem gnus-article-hide-signature
1774       gnus-article-strip-leading-blank-lines gnus-article-date-local
1775       gnus-article-date-original gnus-article-date-lapsed
1776       gnus-article-show-all-headers
1777       gnus-article-edit-mode gnus-article-edit-article
1778       gnus-article-edit-done gnus-article-decode-encoded-words
1779       gnus-start-date-timer gnus-stop-date-timer
1780       gnus-mime-view-all-parts)
1781      ("gnus-int" gnus-request-type)
1782      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1783       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1784      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1785       gnus-dup-enter-articles)
1786      ("gnus-range" gnus-copy-sequence)
1787      ("gnus-eform" gnus-edit-form)
1788      ("gnus-move" :interactive t
1789       gnus-group-move-group-to-server gnus-change-server)
1790      ("gnus-logic" gnus-score-advanced)
1791      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1792      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1793       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1794       gnus-async-halt-prefetch)
1795      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1796       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1797       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1798       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1799      ("gnus-agent" :interactive t
1800       gnus-unplugged gnus-agentize gnus-agent-batch)
1801      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1802       gnus-summary-save-article-vm)
1803      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1804      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1805      ("gnus-mlspl" :interactive t gnus-group-split-setup
1806       gnus-group-split-update))))
1807
1808 ;;; gnus-sum.el thingies
1809
1810
1811 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1812   "*The format specification of the lines in the summary buffer.
1813
1814 It works along the same lines as a normal formatting string,
1815 with some simple extensions.
1816
1817 %N   Article number, left padded with spaces (string)
1818 %S   Subject (string)
1819 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1820 %n   Name of the poster (string)
1821 %a   Extracted name of the poster (string)
1822 %A   Extracted address of the poster (string)
1823 %F   Contents of the From: header (string)
1824 %f   Contents of the From: or To: headers (string)
1825 %x   Contents of the Xref: header (string)
1826 %D   Date of the article (string)
1827 %d   Date of the article (string) in DD-MMM format
1828 %M   Message-id of the article (string)
1829 %r   References of the article (string)
1830 %c   Number of characters in the article (integer)
1831 %L   Number of lines in the article (integer)
1832 %I   Indentation based on thread level (a string of spaces)
1833 %T   A string with two possible values: 80 spaces if the article
1834      is on thread level two or larger and 0 spaces on level one
1835 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1836 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1837 %[   Opening bracket (character, \"[\" or \"<\")
1838 %]   Closing bracket (character, \"]\" or \">\")
1839 %>   Spaces of length thread-level (string)
1840 %<   Spaces of length (- 20 thread-level) (string)
1841 %i   Article score (number)
1842 %z   Article zcore (character)
1843 %t   Number of articles under the current thread (number).
1844 %e   Whether the thread is empty or not (character).
1845 %l   GroupLens score (string).
1846 %V   Total thread score (number).
1847 %P   The line number (number).
1848 %O   Download mark (character).
1849 %u   User defined specifier.  The next character in the format string should
1850      be a letter.  Gnus will call the function gnus-user-format-function-X,
1851      where X is the letter following %u.  The function will be passed the
1852      current header as argument.  The function should return a string, which
1853      will be inserted into the summary just like information from any other
1854      summary specifier.
1855
1856 Text between %( and %) will be highlighted with `gnus-mouse-face'
1857 when the mouse point is placed inside the area.  There can only be one
1858 such area.
1859
1860 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1861 with care.  For reasons of efficiency, Gnus will compute what column
1862 these characters will end up in, and \"hard-code\" that.  This means that
1863 it is invalid to have these specs after a variable-length spec.  Well,
1864 you might not be arrested, but your summary buffer will look strange,
1865 which is bad enough.
1866
1867 The smart choice is to have these specs as for to the left as
1868 possible.
1869
1870 This restriction may disappear in later versions of Gnus."
1871   :type 'string
1872   :group 'gnus-summary-format)
1873
1874 ;;;
1875 ;;; Skeleton keymaps
1876 ;;;
1877
1878 (defun gnus-suppress-keymap (keymap)
1879   (suppress-keymap keymap)
1880   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1881     (while keys
1882       (define-key keymap (pop keys) 'undefined))))
1883
1884 (defvar gnus-article-mode-map
1885   (let ((keymap (make-sparse-keymap)))
1886     (gnus-suppress-keymap keymap)
1887     keymap))
1888 (defvar gnus-summary-mode-map
1889   (let ((keymap (make-keymap)))
1890     (gnus-suppress-keymap keymap)
1891     keymap))
1892 (defvar gnus-group-mode-map
1893   (let ((keymap (make-keymap)))
1894     (gnus-suppress-keymap keymap)
1895     keymap))
1896
1897 \f
1898
1899 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1900 ;; If you want the cursor to go somewhere else, set these two
1901 ;; functions in some startup hook to whatever you want.
1902 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1903 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1904
1905 ;;; Various macros and substs.
1906
1907 (defun gnus-header-from (header)
1908   (mail-header-from header))
1909
1910 (defmacro gnus-gethash (string hashtable)
1911   "Get hash value of STRING in HASHTABLE."
1912   `(symbol-value (intern-soft ,string ,hashtable)))
1913
1914 (defmacro gnus-sethash (string value hashtable)
1915   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1916   `(set (intern ,string ,hashtable) ,value))
1917 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1918
1919 (defmacro gnus-group-unread (group)
1920   "Get the currently computed number of unread articles in GROUP."
1921   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1922
1923 (defmacro gnus-group-entry (group)
1924   "Get the newsrc entry for GROUP."
1925   `(gnus-gethash ,group gnus-newsrc-hashtb))
1926
1927 (defmacro gnus-active (group)
1928   "Get active info on GROUP."
1929   `(gnus-gethash ,group gnus-active-hashtb))
1930
1931 (defmacro gnus-set-active (group active)
1932   "Set GROUP's active info."
1933   `(gnus-sethash ,group ,active gnus-active-hashtb))
1934
1935 ;; Info access macros.
1936
1937 (defmacro gnus-info-group (info)
1938   `(nth 0 ,info))
1939 (defmacro gnus-info-rank (info)
1940   `(nth 1 ,info))
1941 (defmacro gnus-info-read (info)
1942   `(nth 2 ,info))
1943 (defmacro gnus-info-marks (info)
1944   `(nth 3 ,info))
1945 (defmacro gnus-info-method (info)
1946   `(nth 4 ,info))
1947 (defmacro gnus-info-params (info)
1948   `(nth 5 ,info))
1949
1950 (defmacro gnus-info-level (info)
1951   `(let ((rank (gnus-info-rank ,info)))
1952      (if (consp rank)
1953          (car rank)
1954        rank)))
1955 (defmacro gnus-info-score (info)
1956   `(let ((rank (gnus-info-rank ,info)))
1957      (or (and (consp rank) (cdr rank)) 0)))
1958
1959 (defmacro gnus-info-set-group (info group)
1960   `(setcar ,info ,group))
1961 (defmacro gnus-info-set-rank (info rank)
1962   `(setcar (nthcdr 1 ,info) ,rank))
1963 (defmacro gnus-info-set-read (info read)
1964   `(setcar (nthcdr 2 ,info) ,read))
1965 (defmacro gnus-info-set-marks (info marks &optional extend)
1966   (if extend
1967       `(gnus-info-set-entry ,info ,marks 3)
1968     `(setcar (nthcdr 3 ,info) ,marks)))
1969 (defmacro gnus-info-set-method (info method &optional extend)
1970   (if extend
1971       `(gnus-info-set-entry ,info ,method 4)
1972     `(setcar (nthcdr 4 ,info) ,method)))
1973 (defmacro gnus-info-set-params (info params &optional extend)
1974   (if extend
1975       `(gnus-info-set-entry ,info ,params 5)
1976     `(setcar (nthcdr 5 ,info) ,params)))
1977
1978 (defun gnus-info-set-entry (info entry number)
1979   ;; Extend the info until we have enough elements.
1980   (while (<= (length info) number)
1981     (nconc info (list nil)))
1982   ;; Set the entry.
1983   (setcar (nthcdr number info) entry))
1984
1985 (defmacro gnus-info-set-level (info level)
1986   `(let ((rank (cdr ,info)))
1987      (if (consp (car rank))
1988          (setcar (car rank) ,level)
1989        (setcar rank ,level))))
1990 (defmacro gnus-info-set-score (info score)
1991   `(let ((rank (cdr ,info)))
1992      (if (consp (car rank))
1993          (setcdr (car rank) ,score)
1994        (setcar rank (cons (car rank) ,score)))))
1995
1996 (defmacro gnus-get-info (group)
1997   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1998
1999 ;; Byte-compiler warning.
2000 (defvar gnus-visual)
2001 ;; Find out whether the gnus-visual TYPE is wanted.
2002 (defun gnus-visual-p (&optional type class)
2003   (and gnus-visual                      ; Has to be non-nil, at least.
2004        (if (not type)                   ; We don't care about type.
2005            gnus-visual
2006          (if (listp gnus-visual)        ; It's a list, so we check it.
2007              (or (memq type gnus-visual)
2008                  (memq class gnus-visual))
2009            t))))
2010
2011 ;;; Load the compatability functions.
2012
2013 (require 'gnus-ems)
2014
2015 \f
2016 ;;;
2017 ;;; Shutdown
2018 ;;;
2019
2020 (defvar gnus-shutdown-alist nil)
2021
2022 (defun gnus-add-shutdown (function &rest symbols)
2023   "Run FUNCTION whenever one of SYMBOLS is shut down."
2024   (push (cons function symbols) gnus-shutdown-alist))
2025
2026 (defun gnus-shutdown (symbol)
2027   "Shut down everything that waits for SYMBOL."
2028   (let ((alist gnus-shutdown-alist)
2029         entry)
2030     (while (setq entry (pop alist))
2031       (when (memq symbol (cdr entry))
2032         (funcall (car entry))))))
2033
2034 \f
2035 ;;;
2036 ;;; Gnus Utility Functions
2037 ;;;
2038
2039
2040 (defmacro gnus-string-or (&rest strings)
2041   "Return the first element of STRINGS that is a non-blank string.
2042 STRINGS will be evaluated in normal `or' order."
2043   `(gnus-string-or-1 ',strings))
2044
2045 (defun gnus-string-or-1 (strings)
2046   (let (string)
2047     (while strings
2048       (setq string (eval (pop strings)))
2049       (if (string-match "^[ \t]*$" string)
2050           (setq string nil)
2051         (setq strings nil)))
2052     string))
2053
2054 (defun gnus-version (&optional arg)
2055   "Version number of this version of Gnus.
2056 If ARG, insert string at point."
2057   (interactive "P")
2058   (if arg
2059       (insert (message gnus-version))
2060     (message gnus-version)))
2061
2062 (defun gnus-continuum-version (version)
2063   "Return VERSION as a floating point number."
2064   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2065             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2066     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2067           (number (match-string 2 version))
2068           major minor least)
2069       (unless (string-match
2070                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2071         (error "Invalid version string: %s" version))
2072       (setq major (string-to-number (match-string 1 number))
2073             minor (string-to-number (match-string 2 number))
2074             least (if (match-beginning 3)
2075                       (string-to-number (match-string 3 number))
2076                     0))
2077       (string-to-number
2078        (if (zerop major)
2079            (format "%s00%02d%02d"
2080                    (if (member alpha '("(ding)" "d"))
2081                        "4.99"
2082                      (+ 5 (* 0.02
2083                              (abs
2084                               (- (mm-char-int (aref (downcase alpha) 0))
2085                                  (mm-char-int ?t))))
2086                         -0.01))
2087                    minor least)
2088          (format "%d.%02d%02d" major minor least))))))
2089
2090 (defun gnus-info-find-node ()
2091   "Find Info documentation of Gnus."
2092   (interactive)
2093   ;; Enlarge info window if needed.
2094   (let (gnus-info-buffer)
2095     (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2096     (setq gnus-info-buffer (current-buffer))
2097     (gnus-configure-windows 'info)))
2098
2099 ;;;
2100 ;;; gnus-interactive
2101 ;;;
2102
2103 (defvar gnus-current-prefix-symbol nil
2104   "Current prefix symbol.")
2105
2106 (defvar gnus-current-prefix-symbols nil
2107   "List of current prefix symbols.")
2108
2109 (defun gnus-interactive (string &optional params)
2110   "Return a list that can be fed to `interactive'.
2111 See `interactive' for full documentation.
2112
2113 Adds the following specs:
2114
2115 y -- The current symbolic prefix.
2116 Y -- A list of the current symbolic prefix(es).
2117 A -- Article number.
2118 H -- Article header.
2119 g -- Group name."
2120   (let ((i 0)
2121         out c prompt)
2122     (while (< i (length string))
2123       (string-match ".\\([^\n]*\\)\n?" string i)
2124       (setq c (aref string i))
2125       (when (match-end 1)
2126         (setq prompt (match-string 1 string)))
2127       (setq i (match-end 0))
2128       ;; We basically emulate just about everything that
2129       ;; `interactive' does, but add the specs listed above.
2130       (push
2131        (cond
2132         ((= c ?a)
2133          (completing-read prompt obarray 'fboundp t))
2134         ((= c ?b)
2135          (read-buffer prompt (current-buffer) t))
2136         ((= c ?B)
2137          (read-buffer prompt (other-buffer (current-buffer))))
2138         ((= c ?c)
2139          (read-char))
2140         ((= c ?C)
2141          (completing-read prompt obarray 'commandp t))
2142         ((= c ?d)
2143          (point))
2144         ((= c ?D)
2145          (read-file-name prompt nil default-directory 'lambda))
2146         ((= c ?f)
2147          (read-file-name prompt nil nil 'lambda))
2148         ((= c ?F)
2149          (read-file-name prompt))
2150         ((= c ?k)
2151          (read-key-sequence prompt))
2152         ((= c ?K)
2153          (error "Not implemented spec"))
2154         ((= c ?e)
2155          (error "Not implemented spec"))
2156         ((= c ?m)
2157          (mark))
2158         ((= c ?N)
2159          (error "Not implemented spec"))
2160         ((= c ?n)
2161          (string-to-number (read-from-minibuffer prompt)))
2162         ((= c ?p)
2163          (prefix-numeric-value current-prefix-arg))
2164         ((= c ?P)
2165          current-prefix-arg)
2166         ((= c ?r)
2167          'gnus-prefix-nil)
2168         ((= c ?s)
2169          (read-string prompt))
2170         ((= c ?S)
2171          (intern (read-string prompt)))
2172         ((= c ?v)
2173          (read-variable prompt))
2174         ((= c ?x)
2175          (read-minibuffer prompt))
2176         ((= c ?x)
2177          (eval-minibuffer prompt))
2178         ;; And here the new specs come.
2179         ((= c ?y)
2180          gnus-current-prefix-symbol)
2181         ((= c ?Y)
2182          gnus-current-prefix-symbols)
2183         ((= c ?g)
2184          (gnus-group-group-name))
2185         ((= c ?A)
2186          (gnus-summary-skip-intangible)
2187          (or (get-text-property (point) 'gnus-number)
2188              (gnus-summary-last-subject)))
2189         ((= c ?H)
2190          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2191         (t
2192          (error "Non-implemented spec")))
2193        out)
2194       (cond
2195        ((= c ?r)
2196         (push (if (< (point) (mark) (point) (mark))) out)
2197         (push (if (> (point) (mark) (point) (mark))) out))))
2198     (setq out (delq 'gnus-prefix-nil out))
2199     (nreverse out)))
2200
2201 (defun gnus-symbolic-argument (&optional arg)
2202   "Read a symbolic argument and a command, and then execute command."
2203   (interactive "P")
2204   (let* ((in-command (this-command-keys))
2205          (command in-command)
2206          gnus-current-prefix-symbols
2207          gnus-current-prefix-symbol
2208          syms)
2209     (while (equal in-command command)
2210       (message "%s-" (key-description (this-command-keys)))
2211       (push (intern (char-to-string (read-char))) syms)
2212       (setq command (read-key-sequence nil t)))
2213     (setq gnus-current-prefix-symbols (nreverse syms)
2214           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2215     (call-interactively (key-binding command t))))
2216
2217 ;;; More various functions.
2218
2219 (defsubst gnus-check-backend-function (func group)
2220   "Check whether GROUP supports function FUNC.
2221 GROUP can either be a string (a group name) or a select method."
2222   (ignore-errors
2223     (let ((method (if (stringp group)
2224                       (car (gnus-find-method-for-group group))
2225                     group)))
2226       (unless (featurep method)
2227         (require method))
2228       (fboundp (intern (format "%s-%s" method func))))))
2229
2230 (defun gnus-group-read-only-p (&optional group)
2231   "Check whether GROUP supports editing or not.
2232 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2233 that that variable is buffer-local to the summary buffers."
2234   (let ((group (or group gnus-newsgroup-name)))
2235     (not (gnus-check-backend-function 'request-replace-article group))))
2236
2237 (defun gnus-group-total-expirable-p (group)
2238   "Check whether GROUP is total-expirable or not."
2239   (let ((params (gnus-group-find-parameter group))
2240         val)
2241     (cond
2242      ((memq 'total-expire params)
2243       t)
2244      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2245       (cdr val))
2246      (gnus-total-expirable-newsgroups   ; Check var.
2247       (string-match gnus-total-expirable-newsgroups group)))))
2248
2249 (defun gnus-group-auto-expirable-p (group)
2250   "Check whether GROUP is auto-expirable or not."
2251   (let ((params (gnus-group-find-parameter group))
2252         val)
2253     (cond
2254      ((memq 'auto-expire params)
2255       t)
2256      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2257       (cdr val))
2258      (gnus-auto-expirable-newsgroups    ; Check var.
2259       (string-match gnus-auto-expirable-newsgroups group)))))
2260
2261 (defun gnus-virtual-group-p (group)
2262   "Say whether GROUP is virtual or not."
2263   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2264                         gnus-valid-select-methods)))
2265
2266 (defun gnus-news-group-p (group &optional article)
2267   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2268   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2269       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2270            (if (or (null article)
2271                    (not (< article 0)))
2272                (eq (gnus-request-type group article) 'news)
2273              (if (not (vectorp article))
2274                  nil
2275                ;; It's a real article.
2276                (eq (gnus-request-type group (mail-header-id article))
2277                    'news))))))
2278
2279 ;; Returns a list of writable groups.
2280 (defun gnus-writable-groups ()
2281   (let ((alist gnus-newsrc-alist)
2282         groups group)
2283     (while (setq group (car (pop alist)))
2284       (unless (gnus-group-read-only-p group)
2285         (push group groups)))
2286     (nreverse groups)))
2287
2288 ;; Check whether to use long file names.
2289 (defun gnus-use-long-file-name (symbol)
2290   ;; The variable has to be set...
2291   (and gnus-use-long-file-name
2292        ;; If it isn't a list, then we return t.
2293        (or (not (listp gnus-use-long-file-name))
2294            ;; If it is a list, and the list contains `symbol', we
2295            ;; return nil.
2296            (not (memq symbol gnus-use-long-file-name)))))
2297
2298 ;; Generate a unique new group name.
2299 (defun gnus-generate-new-group-name (leaf)
2300   (let ((name leaf)
2301         (num 0))
2302     (while (gnus-gethash name gnus-newsrc-hashtb)
2303       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2304     name))
2305
2306 (defun gnus-ephemeral-group-p (group)
2307   "Say whether GROUP is ephemeral or not."
2308   (gnus-group-get-parameter group 'quit-config t))
2309
2310 (defun gnus-group-quit-config (group)
2311   "Return the quit-config of GROUP."
2312   (gnus-group-get-parameter group 'quit-config t))
2313
2314 (defun gnus-kill-ephemeral-group (group)
2315   "Remove ephemeral GROUP from relevant structures."
2316   (gnus-sethash group nil gnus-newsrc-hashtb))
2317
2318 (defun gnus-simplify-mode-line ()
2319   "Make mode lines a bit simpler."
2320   (setq mode-line-modified (cdr gnus-mode-line-modified))
2321   (when (listp mode-line-format)
2322     (make-local-variable 'mode-line-format)
2323     (setq mode-line-format (copy-sequence mode-line-format))
2324     (when (equal (nth 3 mode-line-format) "   ")
2325       (setcar (nthcdr 3 mode-line-format) " "))))
2326
2327 ;;; Servers and groups.
2328
2329 (defsubst gnus-server-add-address (method)
2330   (let ((method-name (symbol-name (car method))))
2331     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2332              (not (assq (intern (concat method-name "-address")) method))
2333              (memq 'physical-address (assq (car method)
2334                                            gnus-valid-select-methods)))
2335         (append method (list (list (intern (concat method-name "-address"))
2336                                    (nth 1 method))))
2337       method)))
2338
2339 (defsubst gnus-server-get-method (group method)
2340   ;; Input either a server name, and extended server name, or a
2341   ;; select method, and return a select method.
2342   (cond ((stringp method)
2343          (gnus-server-to-method method))
2344         ((equal method gnus-select-method)
2345          gnus-select-method)
2346         ((and (stringp (car method))
2347               group)
2348          (gnus-server-extend-method group method))
2349         ((and method
2350               (not group)
2351               (equal (cadr method) ""))
2352          method)
2353         (t
2354          (gnus-server-add-address method))))
2355
2356 (defun gnus-server-to-method (server)
2357   "Map virtual server names to select methods."
2358   (or
2359    ;; Is this a method, perhaps?
2360    (and server (listp server) server)
2361    ;; Perhaps this is the native server?
2362    (and (equal server "native") gnus-select-method)
2363    ;; It should be in the server alist.
2364    (cdr (assoc server gnus-server-alist))
2365    ;; It could be in the predefined server alist.
2366    (cdr (assoc server gnus-predefined-server-alist))
2367    ;; If not, we look through all the opened server
2368    ;; to see whether we can find it there.
2369    (let ((opened gnus-opened-servers))
2370      (while (and opened
2371                  (not (equal server (format "%s:%s" (caaar opened)
2372                                             (cadaar opened)))))
2373        (pop opened))
2374      (caar opened))
2375    ;; It could be a named method, search all servers
2376    (let ((servers gnus-secondary-select-methods))
2377      (while (and servers
2378                  (not (equal server (format "%s:%s" (caar servers)
2379                                             (cadar servers)))))
2380        (pop servers))
2381      (car servers))))
2382
2383 (defmacro gnus-method-equal (ss1 ss2)
2384   "Say whether two servers are equal."
2385   `(let ((s1 ,ss1)
2386          (s2 ,ss2))
2387      (or (equal s1 s2)
2388          (and (= (length s1) (length s2))
2389               (progn
2390                 (while (and s1 (member (car s1) s2))
2391                   (setq s1 (cdr s1)))
2392                 (null s1))))))
2393
2394 (defun gnus-methods-equal-p (m1 m2)
2395   (let ((m1 (or m1 gnus-select-method))
2396         (m2 (or m2 gnus-select-method)))
2397     (or (equal m1 m2)
2398         (and (eq (car m1) (car m2))
2399              (or (not (memq 'address (assoc (symbol-name (car m1))
2400                                             gnus-valid-select-methods)))
2401                  (equal (nth 1 m1) (nth 1 m2)))))))
2402
2403 (defun gnus-server-equal (m1 m2)
2404   "Say whether two methods are equal."
2405   (let ((m1 (cond ((null m1) gnus-select-method)
2406                   ((stringp m1) (gnus-server-to-method m1))
2407                   (t m1)))
2408         (m2 (cond ((null m2) gnus-select-method)
2409                   ((stringp m2) (gnus-server-to-method m2))
2410                   (t m2))))
2411     (gnus-method-equal m1 m2)))
2412
2413 (defun gnus-servers-using-backend (backend)
2414   "Return a list of known servers using BACKEND."
2415   (let ((opened gnus-opened-servers)
2416         out)
2417     (while opened
2418       (when (eq backend (caaar opened))
2419         (push (caar opened) out))
2420       (pop opened))
2421     out))
2422
2423 (defun gnus-archive-server-wanted-p ()
2424   "Say whether the user wants to use the archive server."
2425   (cond
2426    ((or (not gnus-message-archive-method)
2427         (not gnus-message-archive-group))
2428     nil)
2429    ((and gnus-message-archive-method gnus-message-archive-group)
2430     t)
2431    (t
2432     (let ((active (cadr (assq 'nnfolder-active-file
2433                               gnus-message-archive-method))))
2434       (and active
2435            (file-exists-p active))))))
2436
2437 (defun gnus-group-prefixed-name (group method)
2438   "Return the whole name from GROUP and METHOD."
2439   (and (stringp method) (setq method (gnus-server-to-method method)))
2440   (if (or (not method)
2441           (gnus-server-equal method "native"))
2442       group
2443     (concat (format "%s" (car method))
2444             (when (and
2445                    (or (assoc (format "%s" (car method))
2446                               (gnus-methods-using 'address))
2447                        (gnus-server-equal method gnus-message-archive-method))
2448                    (nth 1 method)
2449                    (not (string= (nth 1 method) "")))
2450               (concat "+" (nth 1 method)))
2451             ":" group)))
2452
2453 (defun gnus-group-real-prefix (group)
2454   "Return the prefix of the current group name."
2455   (if (string-match "^[^:]+:" group)
2456       (substring group 0 (match-end 0))
2457     ""))
2458
2459 (defun gnus-group-method (group)
2460   "Return the server or method used for selecting GROUP.
2461 You should probably use `gnus-find-method-for-group' instead."
2462   (let ((prefix (gnus-group-real-prefix group)))
2463     (if (equal prefix "")
2464         gnus-select-method
2465       (let ((servers gnus-opened-servers)
2466             (server "")
2467             backend possible found)
2468         (if (string-match "^[^\\+]+\\+" prefix)
2469             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2470                   server (substring prefix (match-end 0) (1- (length prefix))))
2471           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2472         (while servers
2473           (when (eq (caaar servers) backend)
2474             (setq possible (caar servers))
2475             (when (equal (cadaar servers) server)
2476               (setq found (caar servers))))
2477           (pop servers))
2478         (or (car (rassoc found gnus-server-alist))
2479             found
2480             (car (rassoc possible gnus-server-alist))
2481             possible
2482             (list backend server))))))
2483
2484 (defsubst gnus-native-method-p (method)
2485   "Return whether METHOD is the native select method."
2486   (gnus-method-equal method gnus-select-method))
2487
2488 (defsubst gnus-secondary-method-p (method)
2489   "Return whether METHOD is a secondary select method."
2490   (let ((methods gnus-secondary-select-methods)
2491         (gmethod (gnus-server-get-method nil method)))
2492     (while (and methods
2493                 (not (gnus-method-equal
2494                       (gnus-server-get-method nil (car methods))
2495                       gmethod)))
2496       (setq methods (cdr methods)))
2497     methods))
2498
2499 (defun gnus-method-simplify (method)
2500   "Return the shortest uniquely identifying string or method for METHOD."
2501   (cond ((stringp method)
2502          method)
2503         ((gnus-native-method-p method)
2504          nil)
2505         ((gnus-secondary-method-p method)
2506          (format "%s:%s" (nth 0 method) (nth 1 method)))
2507         (t
2508          method)))
2509
2510 (defun gnus-groups-from-server (server)
2511   "Return a list of all groups that are fetched from SERVER."
2512   (let ((alist (cdr gnus-newsrc-alist))
2513         info groups)
2514     (while (setq info (pop alist))
2515       (when (gnus-server-equal (gnus-info-method info) server)
2516         (push (gnus-info-group info) groups)))
2517     (sort groups 'string<)))
2518
2519 (defun gnus-group-foreign-p (group)
2520   "Say whether a group is foreign or not."
2521   (and (not (gnus-group-native-p group))
2522        (not (gnus-group-secondary-p group))))
2523
2524 (defun gnus-group-native-p (group)
2525   "Say whether the group is native or not."
2526   (not (string-match ":" group)))
2527
2528 (defun gnus-group-secondary-p (group)
2529   "Say whether the group is secondary or not."
2530   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2531
2532 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2533   "Return the group parameters for GROUP.
2534 If SYMBOL, return the value of that symbol in the group parameters."
2535   (save-excursion
2536     (set-buffer gnus-group-buffer)
2537     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2538       (if symbol
2539           (gnus-group-parameter-value parameters symbol allow-list)
2540         parameters))))
2541
2542 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2543   "Return the group parameters for GROUP.
2544 If SYMBOL, return the value of that symbol in the group parameters.
2545 Most functions should use `gnus-group-find-parameter', which
2546 also examines the topic parameters."
2547   (let ((params (gnus-info-params (gnus-get-info group))))
2548     (if symbol
2549         (gnus-group-parameter-value params symbol allow-list)
2550       params)))
2551
2552 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2553   "Return the value of SYMBOL in group PARAMS."
2554   ;; We only wish to return group parameters (dotted lists) and
2555   ;; not local variables, which may have the same names.
2556   ;; But first we handle single elements...
2557   (or (car (memq symbol params))
2558       ;; Handle alist.
2559       (let (elem)
2560         (catch 'found
2561           (while (setq elem (pop params))
2562             (when (and (consp elem)
2563                        (eq (car elem) symbol)
2564                        (or allow-list
2565                            (atom (cdr elem))))
2566               (throw 'found (cdr elem))))))))
2567
2568 (defun gnus-group-add-parameter (group param)
2569   "Add parameter PARAM to GROUP."
2570   (let ((info (gnus-get-info group)))
2571     (when info
2572       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2573       ;; Cons the new param to the old one and update.
2574       (gnus-group-set-info (cons param (gnus-info-params info))
2575                            group 'params))))
2576
2577 (defun gnus-group-set-parameter (group name value)
2578   "Set parameter NAME to VALUE in GROUP."
2579   (let ((info (gnus-get-info group)))
2580     (when info
2581       (gnus-group-remove-parameter group name)
2582       (let ((old-params (gnus-info-params info))
2583             (new-params (list (cons name value))))
2584         (while old-params
2585           (when (or (not (listp (car old-params)))
2586                     (not (eq (caar old-params) name)))
2587             (setq new-params (append new-params (list (car old-params)))))
2588           (setq old-params (cdr old-params)))
2589         (gnus-group-set-info new-params group 'params)))))
2590
2591 (defun gnus-group-remove-parameter (group name)
2592   "Remove parameter NAME from GROUP."
2593   (let ((info (gnus-get-info group)))
2594     (when info
2595       (let ((params (gnus-info-params info)))
2596         (when params
2597           (setq params (delq name params))
2598           (while (assq name params)
2599             (gnus-pull name params))
2600           (gnus-info-set-params info params))))))
2601
2602 (defun gnus-group-add-score (group &optional score)
2603   "Add SCORE to the GROUP score.
2604 If SCORE is nil, add 1 to the score of GROUP."
2605   (let ((info (gnus-get-info group)))
2606     (when info
2607       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2608
2609 (defun gnus-short-group-name (group &optional levels)
2610   "Collapse GROUP name LEVELS.
2611 Select methods are stripped and any remote host name is stripped down to
2612 just the host name."
2613   (let* ((name "")
2614          (foreign "")
2615          (depth 0)
2616          (skip 1)
2617          (levels (or levels
2618                      gnus-group-uncollapsed-levels
2619                      (progn
2620                        (while (string-match "\\." group skip)
2621                          (setq skip (match-end 0)
2622                                depth (+ depth 1)))
2623                        depth))))
2624     ;; Separate foreign select method from group name and collapse.
2625     ;; If method contains a server, collapse to non-domain server name,
2626     ;; otherwise collapse to select method.
2627     (let* ((colon (string-match ":" group))
2628            (server (and colon (substring group 0 colon)))
2629            (plus (and server (string-match "+" server))))
2630       (when server
2631         (if plus
2632             (setq foreign (substring server (+ 1 plus)
2633                                      (string-match "\\." server))
2634                   group (substring group (+ 1 colon)))
2635           (setq foreign server
2636                 group (substring group (+ 1 colon))))
2637         (setq foreign (concat foreign ":")))
2638       ;; Collapse group name leaving LEVELS uncollapsed elements
2639       (let* ((glist (split-string group "\\."))
2640              (glen (length glist))
2641              res)
2642         (setq levels (- glen levels))
2643         (dolist (g glist)
2644           (push (if (>= (decf levels) 0)
2645                     (if (zerop (length g))
2646                         ""
2647                       (substring g 0 1))
2648                   g)
2649                 res))
2650         (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2651
2652 (defun gnus-narrow-to-body ()
2653   "Narrow to the body of an article."
2654   (narrow-to-region
2655    (progn
2656      (goto-char (point-min))
2657      (or (search-forward "\n\n" nil t)
2658          (point-max)))
2659    (point-max)))
2660
2661 \f
2662 ;;;
2663 ;;; Kill file handling.
2664 ;;;
2665
2666 (defun gnus-apply-kill-file ()
2667   "Apply a kill file to the current newsgroup.
2668 Returns the number of articles marked as read."
2669   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2670           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2671       (gnus-apply-kill-file-internal)
2672     0))
2673
2674 (defun gnus-kill-save-kill-buffer ()
2675   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2676     (when (get-file-buffer file)
2677       (save-excursion
2678         (set-buffer (get-file-buffer file))
2679         (when (buffer-modified-p)
2680           (save-buffer))
2681         (kill-buffer (current-buffer))))))
2682
2683 (defcustom gnus-kill-file-name "KILL"
2684   "Suffix of the kill files."
2685   :group 'gnus-score-kill
2686   :group 'gnus-score-files
2687   :type 'string)
2688
2689 (defun gnus-newsgroup-kill-file (newsgroup)
2690   "Return the name of a kill file name for NEWSGROUP.
2691 If NEWSGROUP is nil, return the global kill file name instead."
2692   (cond
2693    ;; The global KILL file is placed at top of the directory.
2694    ((or (null newsgroup)
2695         (string-equal newsgroup ""))
2696     (expand-file-name gnus-kill-file-name
2697                       gnus-kill-files-directory))
2698    ;; Append ".KILL" to newsgroup name.
2699    ((gnus-use-long-file-name 'not-kill)
2700     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2701                               "." gnus-kill-file-name)
2702                       gnus-kill-files-directory))
2703    ;; Place "KILL" under the hierarchical directory.
2704    (t
2705     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2706                               "/" gnus-kill-file-name)
2707                       gnus-kill-files-directory))))
2708
2709 ;;; Server things.
2710
2711 (defun gnus-member-of-valid (symbol group)
2712   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2713   (memq symbol (assoc
2714                 (symbol-name (car (gnus-find-method-for-group group)))
2715                 gnus-valid-select-methods)))
2716
2717 (defun gnus-method-option-p (method option)
2718   "Return non-nil if select METHOD has OPTION as a parameter."
2719   (when (stringp method)
2720     (setq method (gnus-server-to-method method)))
2721   (memq option (assoc (format "%s" (car method))
2722                       gnus-valid-select-methods)))
2723
2724 (defun gnus-similar-server-opened (method)
2725   (let ((opened gnus-opened-servers))
2726     (while (and method opened)
2727       (when (and (equal (cadr method) (cadaar opened))
2728                  (equal (car method) (caaar opened))
2729                  (not (equal method (caar opened))))
2730         (setq method nil))
2731       (pop opened))
2732     (not method)))
2733
2734 (defun gnus-server-extend-method (group method)
2735   ;; This function "extends" a virtual server.  If the server is
2736   ;; "hello", and the select method is ("hello" (my-var "something"))
2737   ;; in the group "alt.alt", this will result in a new virtual server
2738   ;; called "hello+alt.alt".
2739   (if (or (not (inline (gnus-similar-server-opened method)))
2740           (not (cddr method)))
2741       method
2742     `(,(car method) ,(concat (cadr method) "+" group)
2743       (,(intern (format "%s-address" (car method))) ,(cadr method))
2744       ,@(cddr method))))
2745
2746 (defun gnus-server-status (method)
2747   "Return the status of METHOD."
2748   (nth 1 (assoc method gnus-opened-servers)))
2749
2750 (defun gnus-group-name-to-method (group)
2751   "Guess a select method based on GROUP."
2752   (if (string-match ":" group)
2753       (let ((server (substring group 0 (match-beginning 0))))
2754         (if (string-match "\\+" server)
2755             (list (intern (substring server 0 (match-beginning 0)))
2756                   (substring server (match-end 0)))
2757           (list (intern server) "")))
2758     gnus-select-method))
2759
2760 (defun gnus-find-method-for-group (group &optional info)
2761   "Find the select method that GROUP uses."
2762   (or gnus-override-method
2763       (and (not group)
2764            gnus-select-method)
2765       (and (not (gnus-group-entry group));; a new group
2766            (gnus-group-name-to-method group))
2767       (let ((info (or info (gnus-get-info group)))
2768             method)
2769         (if (or (not info)
2770                 (not (setq method (gnus-info-method info)))
2771                 (equal method "native"))
2772             gnus-select-method
2773           (setq method
2774                 (cond ((stringp method)
2775                        (inline (gnus-server-to-method method)))
2776                       ((stringp (cadr method))
2777                        (inline (gnus-server-extend-method group method)))
2778                       (t
2779                        method)))
2780           (cond ((equal (cadr method) "")
2781                  method)
2782                 ((null (cadr method))
2783                  (list (car method) ""))
2784                 (t
2785                  (gnus-server-add-address method)))))))
2786
2787 (defun gnus-methods-using (feature)
2788   "Find all methods that have FEATURE."
2789   (let ((valids gnus-valid-select-methods)
2790         outs)
2791     (while valids
2792       (when (memq feature (car valids))
2793         (push (car valids) outs))
2794       (setq valids (cdr valids)))
2795     outs))
2796
2797 (defun gnus-read-group (prompt &optional default)
2798   "Prompt the user for a group name.
2799 Disallow invalid group names."
2800   (let ((prefix "")
2801         group)
2802     (while (not group)
2803       (when (string-match
2804              "[: `'\"/]\\|^$"
2805              (setq group (read-string (concat prefix prompt)
2806                                       (cons (or default "") 0)
2807                                       'gnus-group-history)))
2808         (setq prefix (format "Invalid group name: \"%s\".  " group)
2809               group nil)))
2810     group))
2811
2812 (defun gnus-read-method (prompt)
2813   "Prompt the user for a method.
2814 Allow completion over sensible values."
2815   (let* ((servers
2816           (append gnus-valid-select-methods
2817                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2818                                                     (cadar i))))
2819                           gnus-opened-servers)
2820                   gnus-predefined-server-alist
2821                   gnus-server-alist))
2822          (method
2823           (completing-read
2824            prompt servers
2825            nil t nil 'gnus-method-history)))
2826     (cond
2827      ((equal method "")
2828       (setq method gnus-select-method))
2829      ((assoc method gnus-valid-select-methods)
2830       (let ((address (if (memq 'prompt-address
2831                                (assoc method gnus-valid-select-methods))
2832                          (read-string "Address: ")
2833                        "")))
2834         (or (let ((opened gnus-opened-servers))
2835               (while (and opened
2836                           (not (equal (format "%s:%s" method address)
2837                                       (format "%s:%s" (caaar opened) 
2838                                               (cadaar opened)))))
2839                 (pop opened))
2840               (caar opened))
2841             (list (intern method) address))))
2842      ((assoc method servers)
2843       method)
2844      (t
2845       (list (intern method) "")))))
2846
2847 ;;; User-level commands.
2848
2849 ;;;###autoload
2850 (defun gnus-slave-no-server (&optional arg)
2851   "Read network news as a slave, without connecting to local server."
2852   (interactive "P")
2853   (gnus-no-server arg t))
2854
2855 ;;;###autoload
2856 (defun gnus-no-server (&optional arg slave)
2857   "Read network news.
2858 If ARG is a positive number, Gnus will use that as the
2859 startup level.  If ARG is nil, Gnus will be started at level 2.
2860 If ARG is non-nil and not a positive number, Gnus will
2861 prompt the user for the name of an NNTP server to use.
2862 As opposed to `gnus', this command will not connect to the local server."
2863   (interactive "P")
2864   (gnus-no-server-1 arg slave))
2865
2866 ;;;###autoload
2867 (defun gnus-slave (&optional arg)
2868   "Read news as a slave."
2869   (interactive "P")
2870   (gnus arg nil 'slave))
2871
2872 ;;;###autoload
2873 (defun gnus-other-frame (&optional arg)
2874   "Pop up a frame to read news."
2875   (interactive "P")
2876   (let ((window (get-buffer-window gnus-group-buffer)))
2877     (cond (window
2878            (select-frame (window-frame window)))
2879           (t
2880            (select-frame (make-frame)))))
2881   (gnus arg))
2882
2883 ;;(setq thing ?                         ; this is a comment
2884 ;;      more 'yes)
2885     
2886 ;;;###autoload
2887 (defun gnus (&optional arg dont-connect slave)
2888   "Read network news.
2889 If ARG is non-nil and a positive number, Gnus will use that as the
2890 startup level.  If ARG is non-nil and not a positive number, Gnus will
2891 prompt the user for the name of an NNTP server to use."
2892   (interactive "P")
2893   (gnus-1 arg dont-connect slave))
2894
2895 ;; Allow redefinition of Gnus functions.
2896
2897 (gnus-ems-redefine)
2898
2899 (provide 'gnus)
2900
2901 ;;; gnus.el ends here