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