1 ;;; gnus-group.el --- group mode commands for Gnus
2 ;; Copyright (C) 1996 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
37 (defgroup gnus-group nil
41 (defcustom gnus-group-archive-directory
42 "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
43 "*The address of the (ding) archives."
47 (defcustom gnus-group-recent-archive-directory
48 "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list-recent/"
49 "*The address of the most recent (ding) articles."
53 ;; Suggested by Andrew Eskilsson <pi92ae@lelle.pt.hk-r.se>.
54 (defcustom gnus-no-groups-message "No news is horrible news"
55 "*Message displayed by Gnus when no groups are available."
59 (defcustom gnus-keep-same-level nil
60 "*Non-nil means that the next newsgroup after the current will be on the same level.
61 When you type, for instance, `n' after reading the last article in the
62 current newsgroup, you will go to the next newsgroup. If this variable
63 is nil, the next newsgroup will be the next from the group
65 If this variable is non-nil, Gnus will either put you in the
66 next newsgroup with the same level, or, if no such newsgroup is
67 available, the next newsgroup with the lowest possible level higher
68 than the current level.
69 If this variable is `best', Gnus will make the next newsgroup the one
72 :type '(choice (const nil)
74 (sexp :tag "other" t)))
76 (defcustom gnus-group-goto-unread t
77 "*If non-nil, movement commands will go to the next unread and subscribed group."
81 (defcustom gnus-goto-next-group-when-activating t
82 "*If non-nil, the \\<gnus-group-mode-map>\\[gnus-group-get-new-news-this-group] command will advance point to the next group."
86 (defcustom gnus-permanently-visible-groups nil
87 "*Regexp to match groups that should always be listed in the group buffer.
88 This means that they will still be listed when there are no unread
89 articles in the groups."
93 (defcustom gnus-list-groups-with-ticked-articles t
94 "*If non-nil, list groups that have only ticked articles.
95 If nil, only list groups that have unread articles."
99 (defcustom gnus-group-default-list-level gnus-level-subscribed
100 "*Default listing level.
101 Ignored if `gnus-group-use-permanent-levels' is non-nil."
105 (defcustom gnus-group-list-inactive-groups t
106 "*If non-nil, inactive groups will be listed."
110 (defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
111 "*Function used for sorting the group buffer.
112 This function will be called with group info entries as the arguments
113 for the groups to be sorted. Pre-made functions include
114 `gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
115 `gnus-group-sort-by-unread', `gnus-group-sort-by-level',
116 `gnus-group-sort-by-score', `gnus-group-sort-by-method', and
117 `gnus-group-sort-by-rank'.
119 This variable can also be a list of sorting functions. In that case,
120 the most significant sort function should be the last function in the
123 :type '(radio (function-item gnus-group-sort-by-alphabet)
124 (function-item gnus-group-sort-by-real-name)
125 (function-item gnus-group-sort-by-unread)
126 (function-item gnus-group-sort-by-level)
127 (function-item gnus-group-sort-by-score)
128 (function-item gnus-group-sort-by-method)
129 (function-item gnus-group-sort-by-rank)
130 (function :tag "other" nil)))
132 (defcustom gnus-group-line-format "%M\%S\%p\%P\%5y: %(%g%)%l\n"
133 "*Format of group lines.
134 It works along the same lines as a normal formatting string,
135 with some simple extensions.
137 %M Only marked articles (character, \"*\" or \" \")
138 %S Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
139 %L Level of subscribedness (integer)
140 %N Number of unread articles (integer)
141 %I Number of dormant articles (integer)
142 %i Number of ticked and dormant (integer)
143 %T Number of ticked articles (integer)
144 %R Number of read articles (integer)
145 %t Estimated total number of articles (integer)
146 %y Number of unread, unticked articles (integer)
147 %G Group name (string)
148 %g Qualified group name (string)
149 %D Group description (string)
150 %s Select method (string)
151 %o Moderated group (char, \"m\")
152 %p Process mark (char)
153 %O Moderated group (string, \"(m)\" or \"\")
154 %P Topic indentation (string)
155 %m Whether there is new(ish) mail in the group (char, \"%\")
156 %l Whether there are GroupLens predictions for this group (string)
157 %n Select from where (string)
158 %z A string that look like `<%s:%n>' if a foreign select method is used
159 ?d The date the group was last entered.
160 %u User defined specifier. The next character in the format string should
161 be a letter. Gnus will call the function gnus-user-format-function-X,
162 where X is the letter following %u. The function will be passed the
163 current header as argument. The function should return a string, which
164 will be inserted into the buffer just like information from any other
167 Text between %( and %) will be highlighted with `gnus-mouse-face' when
168 the mouse point move inside the area. There can only be one such area.
170 Note that this format specification is not always respected. For
171 reasons of efficiency, when listing killed groups, this specification
172 is ignored altogether. If the spec is changed considerably, your
173 output may end up looking strange when listing both alive and killed
176 If you use %o or %O, reading the active file will be slower and quite
177 a bit of extra memory will be used. %D will also worsen performance.
178 Also note that if you change the format specification to include any
179 of these specs, you must probably re-start Gnus to see them go into
184 (defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
185 "*The format specification for the group mode line.
186 It works along the same lines as a normal formatting string,
187 with some simple extensions:
189 %S The native news server.
190 %M The native select method.
191 %: \":\" if %S isn't \"\"."
195 (defcustom gnus-group-mode-hook nil
196 "Hook for Gnus group mode."
198 :options '(gnus-topic-mode)
201 (defcustom gnus-group-menu-hook nil
202 "Hook run after the creation of the group mode menu."
206 (defcustom gnus-group-catchup-group-hook nil
207 "Hook run when catching up a group from the group buffer."
211 (defcustom gnus-group-update-group-hook nil
212 "Hook called when updating group lines."
216 (defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
217 "*A function that is called to generate the group buffer.
218 The function is called with three arguments: The first is a number;
219 all group with a level less or equal to that number should be listed,
220 if the second is non-nil, empty groups should also be displayed. If
221 the third is non-nil, it is a number. No groups with a level lower
222 than this number should be displayed.
224 The only current function implemented is `gnus-group-prepare-flat'."
228 (defcustom gnus-group-prepare-hook nil
229 "Hook called after the group buffer has been generated.
230 If you want to modify the group buffer, you can use this hook."
234 (defcustom gnus-suspend-gnus-hook nil
235 "Hook called when suspending (not exiting) Gnus."
239 (defcustom gnus-exit-gnus-hook nil
240 "Hook called when exiting Gnus."
244 (defcustom gnus-after-exiting-gnus-hook nil
245 "Hook called after exiting Gnus."
249 (defcustom gnus-group-update-hook '(gnus-group-highlight-line)
250 "Hook called when a group line is changed.
251 The hook will not be called if `gnus-visual' is nil.
253 The default function `gnus-group-highlight-line' will
254 highlight the line according to the `gnus-group-highlight'
259 (defcustom gnus-useful-groups
260 `(("(ding) mailing list mirrored at sunsite.auc.dk"
262 (nntp "sunsite.auc.dk"
263 (nntp-address "sunsite.auc.dk")))
267 (nndoc-article-type mbox)
268 (eval `(nndoc-address
269 ,(let ((file (nnheader-find-etc-directory
272 (error "Couldn't find doc group"))
274 "Alist of useful group-server pairs."
276 :type '(repeat (list (string :tag "Description")
278 (sexp :tag "Method"))))
280 (defface gnus-group-news-1-face
283 (:foreground "PaleTurquoise" :bold t))
286 (:foreground "ForestGreen" :bold t))
289 "Level 1 newsgroup face.")
291 (defface gnus-group-news-1-empty-face
294 (:foreground "PaleTurquoise"))
297 (:foreground "ForestGreen"))
300 "Level 1 empty newsgroup face.")
302 (defface gnus-group-news-2-face
305 (:foreground "turquoise" :bold t))
308 (:foreground "CadetBlue4" :bold t))
311 "Level 2 newsgroup face.")
313 (defface gnus-group-news-2-empty-face
316 (:foreground "turquoise"))
319 (:foreground "CadetBlue4"))
322 "Level 2 empty newsgroup face.")
324 (defface gnus-group-news-3-face
333 "Level 3 newsgroup face.")
335 (defface gnus-group-news-3-empty-face
344 "Level 3 empty newsgroup face.")
346 (defface gnus-group-news-low-face
349 (:foreground "DarkTurquoise" :bold t))
352 (:foreground "DarkGreen" :bold t))
355 "Low level newsgroup face.")
357 (defface gnus-group-news-low-empty-face
360 (:foreground "DarkTurquoise"))
363 (:foreground "DarkGreen"))
366 "Low level empty newsgroup face.")
368 (defface gnus-group-mail-1-face
371 (:foreground "aquamarine1" :bold t))
374 (:foreground "DeepPink3" :bold t))
377 "Level 1 mailgroup face.")
379 (defface gnus-group-mail-1-empty-face
382 (:foreground "aquamarine1"))
385 (:foreground "DeepPink3"))
387 (:italic t :bold t)))
388 "Level 1 empty mailgroup face.")
390 (defface gnus-group-mail-2-face
393 (:foreground "aquamarine2" :bold t))
396 (:foreground "HotPink3" :bold t))
399 "Level 2 mailgroup face.")
401 (defface gnus-group-mail-2-empty-face
404 (:foreground "aquamarine2"))
407 (:foreground "HotPink3"))
410 "Level 2 empty mailgroup face.")
412 (defface gnus-group-mail-3-face
415 (:foreground "aquamarine3" :bold t))
418 (:foreground "magenta4" :bold t))
421 "Level 3 mailgroup face.")
423 (defface gnus-group-mail-3-empty-face
426 (:foreground "aquamarine3"))
429 (:foreground "magenta4"))
432 "Level 3 empty mailgroup face.")
434 (defface gnus-group-mail-low-face
437 (:foreground "aquamarine4" :bold t))
440 (:foreground "DeepPink4" :bold t))
443 "Low level mailgroup face.")
445 (defface gnus-group-mail-low-empty-face
448 (:foreground "aquamarine4"))
451 (:foreground "DeepPink4"))
454 "Low level empty mailgroup face.")
456 (defcustom gnus-group-highlight
458 ((and (= unread 0) (not mailp) (eq level 1)) .
459 gnus-group-news-1-empty-face)
460 ((and (not mailp) (eq level 1)) .
461 gnus-group-news-1-face)
462 ((and (= unread 0) (not mailp) (eq level 2)) .
463 gnus-group-news-2-empty-face)
464 ((and (not mailp) (eq level 2)) .
465 gnus-group-news-2-face)
466 ((and (= unread 0) (not mailp) (eq level 3)) .
467 gnus-group-news-3-empty-face)
468 ((and (not mailp) (eq level 3)) .
469 gnus-group-news-3-face)
470 ((and (= unread 0) (not mailp)) .
471 gnus-group-news-low-empty-face)
473 gnus-group-news-low-face)
475 ((and (= unread 0) (eq level 1)) .
476 gnus-group-mail-1-empty-face)
478 gnus-group-mail-1-face)
479 ((and (= unread 0) (eq level 2)) .
480 gnus-group-mail-2-empty-face)
482 gnus-group-mail-2-face)
483 ((and (= unread 0) (eq level 3)) .
484 gnus-group-mail-3-empty-face)
486 gnus-group-mail-3-face)
488 gnus-group-mail-low-empty-face)
490 gnus-group-mail-low-face))
491 "Controls the highlighting of group buffer lines.
493 Below is a list of `Form'/`Face' pairs. When deciding how a a
494 particular group line should be displayed, each form is
495 evaluated. The content of the face field after the first true form is
496 used. You can change how those group lines are displayed by
497 editing the face field.
499 It is also possible to change and add form fields, but currently that
500 requires an understanding of Lisp expressions. Hopefully this will
501 change in a future release. For now, you can use the following
502 variables in the Lisp expression:
504 group: The name of the group.
505 unread: The number of unread articles in the group.
506 method: The select method used.
507 mailp: Whether it's a mail group or not.
508 level: The level of the group.
509 score: The score of the group.
510 ticked: The number of ticked articles."
512 :type '(repeat (cons (sexp :tag "Form") face)))
514 (defcustom gnus-new-mail-mark ?%
515 "Mark used for groups with new mail."
519 ;;; Internal variables
521 (defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
522 "Function for sorting the group buffer.")
524 (defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
525 "Function for sorting the selected groups in the group buffer.")
527 (defvar gnus-group-indentation-function nil)
528 (defvar gnus-goto-missing-group-function nil)
529 (defvar gnus-group-update-group-function nil)
530 (defvar gnus-group-goto-next-group-function nil
531 "Function to override finding the next group after listing groups.")
533 (defvar gnus-group-edit-buffer nil)
535 (defvar gnus-group-line-format-alist
536 `((?M gnus-tmp-marked-mark ?c)
537 (?S gnus-tmp-subscribed ?c)
538 (?L gnus-tmp-level ?d)
539 (?N (cond ((eq number t) "*" )
543 (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
544 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
546 (?R gnus-tmp-number-of-read ?s)
547 (?t gnus-tmp-number-total ?d)
548 (?y gnus-tmp-number-of-unread ?s)
549 (?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
550 (?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
551 (?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
552 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
553 (?g gnus-tmp-group ?s)
554 (?G gnus-tmp-qualified-group ?s)
555 (?c (gnus-short-group-name gnus-tmp-group) ?s)
556 (?D gnus-tmp-newsgroup-description ?s)
557 (?o gnus-tmp-moderated ?c)
558 (?O gnus-tmp-moderated-string ?s)
559 (?p gnus-tmp-process-marked ?c)
560 (?s gnus-tmp-news-server ?s)
561 (?n gnus-tmp-news-method ?s)
562 (?P gnus-group-indentation ?s)
563 (?l gnus-tmp-grouplens ?s)
564 (?z gnus-tmp-news-method-string ?s)
565 (?m (gnus-group-new-mail gnus-tmp-group) ?c)
566 (?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
567 (?u gnus-tmp-user-defined ?s)))
569 (defvar gnus-group-mode-line-format-alist
570 `((?S gnus-tmp-news-server ?s)
571 (?M gnus-tmp-news-method ?s)
572 (?u gnus-tmp-user-defined ?s)
573 (?: gnus-tmp-colon ?s)))
575 (defvar gnus-topic-topology nil
576 "The complete topic hierarchy.")
578 (defvar gnus-topic-alist nil
579 "The complete topic-group alist.")
581 (defvar gnus-group-marked nil)
583 (defvar gnus-group-list-mode nil)
589 (put 'gnus-group-mode 'mode-class 'special)
592 (gnus-define-keys gnus-group-mode-map
593 " " gnus-group-read-group
594 "=" gnus-group-select-group
595 "\r" gnus-group-select-group
596 "\M-\r" gnus-group-quick-select-group
597 "j" gnus-group-jump-to-group
598 "n" gnus-group-next-unread-group
599 "p" gnus-group-prev-unread-group
600 "\177" gnus-group-prev-unread-group
601 [delete] gnus-group-prev-unread-group
602 "N" gnus-group-next-group
603 "P" gnus-group-prev-group
604 "\M-n" gnus-group-next-unread-group-same-level
605 "\M-p" gnus-group-prev-unread-group-same-level
606 "," gnus-group-best-unread-group
607 "." gnus-group-first-unread-group
608 "u" gnus-group-unsubscribe-current-group
609 "U" gnus-group-unsubscribe-group
610 "c" gnus-group-catchup-current
611 "C" gnus-group-catchup-current-all
612 "\M-c" gnus-group-clear-data
613 "l" gnus-group-list-groups
614 "L" gnus-group-list-all-groups
616 "g" gnus-group-get-new-news
617 "\M-g" gnus-group-get-new-news-this-group
618 "R" gnus-group-restart
619 "r" gnus-group-read-init-file
620 "B" gnus-group-browse-foreign-server
621 "b" gnus-group-check-bogus-groups
622 "F" gnus-find-new-newsgroups
623 "\C-c\C-d" gnus-group-describe-group
624 "\M-d" gnus-group-describe-all-groups
625 "\C-c\C-a" gnus-group-apropos
626 "\C-c\M-\C-a" gnus-group-description-apropos
627 "a" gnus-group-post-news
628 "\ek" gnus-group-edit-local-kill
629 "\eK" gnus-group-edit-global-kill
630 "\C-k" gnus-group-kill-group
631 "\C-y" gnus-group-yank-group
632 "\C-w" gnus-group-kill-region
633 "\C-x\C-t" gnus-group-transpose-groups
634 "\C-c\C-l" gnus-group-list-killed
635 "\C-c\C-x" gnus-group-expire-articles
636 "\C-c\M-\C-x" gnus-group-expire-all-groups
638 "s" gnus-group-save-newsrc
639 "z" gnus-group-suspend
642 "?" gnus-group-describe-briefly
643 "\C-c\C-i" gnus-info-find-node
644 "\M-e" gnus-group-edit-group-method
645 "^" gnus-group-enter-server-mode
646 gnus-mouse-2 gnus-mouse-pick-group
647 "<" beginning-of-buffer
650 "\C-c\C-s" gnus-group-sort-groups
652 "\C-c\M-g" gnus-activate-all-groups
653 "\M-&" gnus-group-universal-argument
654 "#" gnus-group-mark-group
655 "\M-#" gnus-group-unmark-group)
657 (gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
658 "m" gnus-group-mark-group
659 "u" gnus-group-unmark-group
660 "w" gnus-group-mark-region
661 "m" gnus-group-mark-buffer
662 "r" gnus-group-mark-regexp
663 "U" gnus-group-unmark-all-groups)
665 (gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
666 "d" gnus-group-make-directory-group
667 "h" gnus-group-make-help-group
668 "u" gnus-group-make-useful-group
669 "a" gnus-group-make-archive-group
670 "k" gnus-group-make-kiboze-group
671 "m" gnus-group-make-group
672 "E" gnus-group-edit-group
673 "e" gnus-group-edit-group-method
674 "p" gnus-group-edit-group-parameters
675 "v" gnus-group-add-to-virtual
676 "V" gnus-group-make-empty-virtual
677 "D" gnus-group-enter-directory
678 "f" gnus-group-make-doc-group
679 "w" gnus-group-make-web-group
680 "r" gnus-group-rename-group
681 "c" gnus-group-customize
682 "\177" gnus-group-delete-group
683 [delete] gnus-group-delete-group)
685 (gnus-define-keys (gnus-group-soup-map "s" gnus-group-group-map)
686 "b" gnus-group-brew-soup
687 "w" gnus-soup-save-areas
688 "s" gnus-soup-send-replies
689 "p" gnus-soup-pack-packet
690 "r" nnsoup-pack-replies)
692 (gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
693 "s" gnus-group-sort-groups
694 "a" gnus-group-sort-groups-by-alphabet
695 "u" gnus-group-sort-groups-by-unread
696 "l" gnus-group-sort-groups-by-level
697 "v" gnus-group-sort-groups-by-score
698 "r" gnus-group-sort-groups-by-rank
699 "m" gnus-group-sort-groups-by-method)
701 (gnus-define-keys (gnus-group-sort-map "P" gnus-group-group-map)
702 "s" gnus-group-sort-selected-groups
703 "a" gnus-group-sort-selected-groups-by-alphabet
704 "u" gnus-group-sort-selected-groups-by-unread
705 "l" gnus-group-sort-selected-groups-by-level
706 "v" gnus-group-sort-selected-groups-by-score
707 "r" gnus-group-sort-selected-groups-by-rank
708 "m" gnus-group-sort-selected-groups-by-method)
710 (gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
711 "k" gnus-group-list-killed
712 "z" gnus-group-list-zombies
713 "s" gnus-group-list-groups
714 "u" gnus-group-list-all-groups
715 "A" gnus-group-list-active
716 "a" gnus-group-apropos
717 "d" gnus-group-description-apropos
718 "m" gnus-group-list-matching
719 "M" gnus-group-list-all-matching
720 "l" gnus-group-list-level)
722 (gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
723 "f" gnus-score-flush-cache)
725 (gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
726 "d" gnus-group-describe-group
727 "f" gnus-group-fetch-faq)
729 (gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
730 "l" gnus-group-set-current-level
731 "t" gnus-group-unsubscribe-current-group
732 "s" gnus-group-unsubscribe-group
733 "k" gnus-group-kill-group
734 "y" gnus-group-yank-group
735 "w" gnus-group-kill-region
736 "\C-k" gnus-group-kill-level
737 "z" gnus-group-kill-all-zombies))
739 (defun gnus-group-make-menu-bar ()
740 (gnus-turn-off-edit-menu 'group)
741 (unless (boundp 'gnus-group-reading-menu)
744 gnus-group-reading-menu gnus-group-mode-map ""
746 ["Read" gnus-group-read-group (gnus-group-group-name)]
747 ["Select" gnus-group-select-group (gnus-group-group-name)]
748 ["See old articles" (gnus-group-select-group 'all)
749 :keys "C-u SPC" :active (gnus-group-group-name)]
750 ["Catch up" gnus-group-catchup-current (gnus-group-group-name)]
751 ["Catch up all articles" gnus-group-catchup-current-all
752 (gnus-group-group-name)]
753 ["Check for new articles" gnus-group-get-new-news-this-group
754 (gnus-group-group-name)]
755 ["Toggle subscription" gnus-group-unsubscribe-current-group
756 (gnus-group-group-name)]
757 ["Kill" gnus-group-kill-group (gnus-group-group-name)]
758 ["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
759 ["Describe" gnus-group-describe-group (gnus-group-group-name)]
760 ["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
761 ["Edit kill file" gnus-group-edit-local-kill
762 (gnus-group-group-name)]
763 ;; Actually one should check, if any of the marked groups gives t for
764 ;; (gnus-check-backend-function 'request-expire-articles ...)
765 ["Expire articles" gnus-group-expire-articles
766 (or (and (gnus-group-group-name)
767 (gnus-check-backend-function
768 'request-expire-articles
769 (gnus-group-group-name))) gnus-group-marked)]
770 ["Set group level" gnus-group-set-current-level
771 (gnus-group-group-name)]
772 ["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
776 gnus-group-group-menu gnus-group-mode-map ""
779 ["List unread subscribed groups" gnus-group-list-groups t]
780 ["List (un)subscribed groups" gnus-group-list-all-groups t]
781 ["List killed groups" gnus-group-list-killed gnus-killed-list]
782 ["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
783 ["List level..." gnus-group-list-level t]
784 ["Describe all groups" gnus-group-describe-all-groups t]
785 ["Group apropos..." gnus-group-apropos t]
786 ["Group and description apropos..." gnus-group-description-apropos t]
787 ["List groups matching..." gnus-group-list-matching t]
788 ["List all groups matching..." gnus-group-list-all-matching t]
789 ["List active file" gnus-group-list-active t])
791 ["Default sort" gnus-group-sort-groups t]
792 ["Sort by method" gnus-group-sort-groups-by-method t]
793 ["Sort by rank" gnus-group-sort-groups-by-rank t]
794 ["Sort by score" gnus-group-sort-groups-by-score t]
795 ["Sort by level" gnus-group-sort-groups-by-level t]
796 ["Sort by unread" gnus-group-sort-groups-by-unread t]
797 ["Sort by name" gnus-group-sort-groups-by-alphabet t])
798 ("Sort process/prefixed"
799 ["Default sort" gnus-group-sort-selected-groups
800 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
801 ["Sort by method" gnus-group-sort-selected-groups-by-method
802 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
803 ["Sort by rank" gnus-group-sort-selected-groups-by-rank
804 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
805 ["Sort by score" gnus-group-sort-selected-groups-by-score
806 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
807 ["Sort by level" gnus-group-sort-selected-groups-by-level
808 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
809 ["Sort by unread" gnus-group-sort-selected-groups-by-unread
810 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
811 ["Sort by name" gnus-group-sort-selected-groups-by-alphabet
812 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))])
814 ["Mark group" gnus-group-mark-group
815 (and (gnus-group-group-name)
816 (not (memq (gnus-group-group-name) gnus-group-marked)))]
817 ["Unmark group" gnus-group-unmark-group
818 (and (gnus-group-group-name)
819 (memq (gnus-group-group-name) gnus-group-marked))]
820 ["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
821 ["Mark regexp..." gnus-group-mark-regexp t]
822 ["Mark region" gnus-group-mark-region t]
823 ["Mark buffer" gnus-group-mark-buffer t]
824 ["Execute command" gnus-group-universal-argument
825 (or gnus-group-marked (gnus-group-group-name))])
827 ["Subscribe to a group" gnus-group-unsubscribe-group t]
828 ["Kill all newsgroups in region" gnus-group-kill-region t]
829 ["Kill all zombie groups" gnus-group-kill-all-zombies
831 ["Kill all groups on level..." gnus-group-kill-level t])
833 ["Make a foreign group" gnus-group-make-group t]
834 ["Add a directory group" gnus-group-make-directory-group t]
835 ["Add the help group" gnus-group-make-help-group t]
836 ["Add the archive group" gnus-group-make-archive-group t]
837 ["Make a doc group" gnus-group-make-doc-group t]
838 ["Make a web group" gnus-group-make-web-group t]
839 ["Make a kiboze group" gnus-group-make-kiboze-group t]
840 ["Make a virtual group" gnus-group-make-empty-virtual t]
841 ["Add a group to a virtual" gnus-group-add-to-virtual t]
842 ["Rename group" gnus-group-rename-group
843 (gnus-check-backend-function
844 'request-rename-group (gnus-group-group-name))]
845 ["Delete group" gnus-group-delete-group
846 (gnus-check-backend-function
847 'request-delete-group (gnus-group-group-name))])
849 ["Parameters" gnus-group-edit-group-parameters
850 (gnus-group-group-name)]
851 ["Select method" gnus-group-edit-group-method
852 (gnus-group-group-name)]
853 ["Info" gnus-group-edit-group (gnus-group-group-name)])
855 ["Flush cache" gnus-score-flush-cache t])
857 ["Next" gnus-group-next-group t]
858 ["Previous" gnus-group-prev-group t]
859 ["Next unread" gnus-group-next-unread-group t]
860 ["Previous unread" gnus-group-prev-unread-group t]
861 ["Next unread same level" gnus-group-next-unread-group-same-level t]
862 ["Previous unread same level"
863 gnus-group-prev-unread-group-same-level t]
864 ["Jump to group" gnus-group-jump-to-group t]
865 ["First unread group" gnus-group-first-unread-group t]
866 ["Best unread group" gnus-group-best-unread-group t])
867 ["Transpose" gnus-group-transpose-groups
868 (gnus-group-group-name)]
869 ["Read a directory as a group..." gnus-group-enter-directory t]
873 gnus-group-misc-menu gnus-group-mode-map ""
875 ["Send a bug report" gnus-bug t]
876 ["Customize" gnus-group-customize t]
877 ["Send a mail" gnus-group-mail t]
878 ["Post an article..." gnus-group-post-news t]
879 ["Check for new news" gnus-group-get-new-news t]
880 ["Activate all groups" gnus-activate-all-groups t]
881 ["Delete bogus groups" gnus-group-check-bogus-groups t]
882 ["Find new newsgroups" gnus-find-new-newsgroups t]
883 ["Restart Gnus" gnus-group-restart t]
884 ["Read init file" gnus-group-read-init-file t]
885 ["Browse foreign server" gnus-group-browse-foreign-server t]
886 ["Enter server buffer" gnus-group-enter-server-mode t]
887 ["Expire all expirable articles" gnus-group-expire-all-groups t]
888 ["Generate any kiboze groups" nnkiboze-generate-groups t]
889 ["Gnus version" gnus-version t]
890 ["Save .newsrc files" gnus-group-save-newsrc t]
891 ["Suspend Gnus" gnus-group-suspend t]
892 ["Clear dribble buffer" gnus-group-clear-dribble t]
893 ["Edit global kill file" gnus-group-edit-global-kill t]
894 ["Read manual" gnus-info-find-node t]
895 ["Toggle topics" gnus-topic-mode t]
897 ["Pack replies" nnsoup-pack-replies (fboundp 'nnsoup-request-group)]
898 ["Send replies" gnus-soup-send-replies
899 (fboundp 'gnus-soup-pack-packet)]
900 ["Pack packet" gnus-soup-pack-packet (fboundp 'gnus-soup-pack-packet)]
901 ["Save areas" gnus-soup-save-areas (fboundp 'gnus-soup-pack-packet)]
902 ["Brew SOUP" gnus-soup-brew-soup (fboundp 'gnus-soup-pack-packet)])
903 ["Exit from Gnus" gnus-group-exit t]
904 ["Exit without saving" gnus-group-quit t]
907 (run-hooks 'gnus-group-menu-hook)
910 (defun gnus-group-mode ()
911 "Major mode for reading news.
913 All normal editing commands are switched off.
914 \\<gnus-group-mode-map>
915 The group buffer lists (some of) the groups available. For instance,
916 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
917 lists all zombie groups.
919 Groups that are displayed can be entered with `\\[gnus-group-read-group]'. To subscribe
920 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
922 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
924 The following commands are available:
926 \\{gnus-group-mode-map}"
928 (when (and menu-bar-mode
929 (gnus-visual-p 'group-menu 'menu))
930 (gnus-group-make-menu-bar))
931 (kill-all-local-variables)
932 (gnus-simplify-mode-line)
933 (setq major-mode 'gnus-group-mode)
934 (setq mode-name "Group")
935 (gnus-group-set-mode-line)
936 (setq mode-line-process nil)
937 (use-local-map gnus-group-mode-map)
938 (buffer-disable-undo (current-buffer))
939 (setq truncate-lines t)
940 (setq buffer-read-only t)
941 (gnus-set-default-directory)
942 (gnus-update-format-specifications nil 'group 'group-mode)
943 (gnus-update-group-mark-positions)
944 (gnus-make-local-hook 'post-command-hook)
945 (gnus-add-hook 'post-command-hook 'gnus-clear-inboxes-moved nil t)
948 (run-hooks 'gnus-group-mode-hook))
950 (defun gnus-update-group-mark-positions ()
952 (let ((gnus-process-mark 128)
953 (gnus-group-marked '("dummy.group"))
954 (gnus-active-hashtb (make-vector 10 0)))
955 (gnus-set-active "dummy.group" '(0 . 0))
956 (gnus-set-work-buffer)
957 (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
958 (goto-char (point-min))
959 (setq gnus-group-mark-positions
960 (list (cons 'process (and (search-forward "\200" nil t)
963 (defun gnus-clear-inboxes-moved ()
964 (setq nnmail-moved-inboxes nil))
966 (defun gnus-mouse-pick-group (e)
967 "Enter the group under the mouse pointer."
970 (gnus-group-read-group nil))
972 ;; Look at LEVEL and find out what the level is really supposed to be.
973 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
974 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
975 (defun gnus-group-default-level (&optional level number-or-nil)
977 (gnus-group-use-permanent-levels
978 (or (setq gnus-group-use-permanent-levels
979 (or level (if (numberp gnus-group-use-permanent-levels)
980 gnus-group-use-permanent-levels
981 (or gnus-group-default-list-level
982 gnus-level-subscribed))))
983 gnus-group-default-list-level gnus-level-subscribed))
987 (or level gnus-group-default-list-level gnus-level-subscribed))))
989 (defun gnus-group-setup-buffer ()
990 (switch-to-buffer gnus-group-buffer)
991 (unless (eq major-mode 'gnus-group-mode)
992 (gnus-add-current-to-buffer-list)
995 (gnus-carpal-setup-buffer 'group))))
997 (defun gnus-group-list-groups (&optional level unread lowest)
998 "List newsgroups with level LEVEL or lower that have unread articles.
999 Default is all subscribed groups.
1000 If argument UNREAD is non-nil, groups with no unread articles are also
1003 (list (if current-prefix-arg
1004 (prefix-numeric-value current-prefix-arg)
1006 (gnus-group-default-level nil t)
1007 gnus-group-default-list-level
1008 gnus-level-subscribed))))
1009 ;; Just do this here, for no particular good reason.
1010 (gnus-clear-inboxes-moved)
1012 (setq level (car gnus-group-list-mode)
1013 unread (cdr gnus-group-list-mode)))
1014 (setq level (gnus-group-default-level level))
1015 (gnus-group-setup-buffer) ;May call from out of group buffer
1016 (gnus-update-format-specifications nil 'group 'group-mode)
1017 (let ((case-fold-search nil)
1018 (props (text-properties-at (gnus-point-at-bol)))
1019 (group (gnus-group-group-name)))
1020 (set-buffer gnus-group-buffer)
1021 (funcall gnus-group-prepare-function level unread lowest)
1022 (if (zerop (buffer-size))
1023 (gnus-message 5 gnus-no-groups-message)
1024 (goto-char (point-max))
1025 (when (or (not gnus-group-goto-next-group-function)
1026 (not (funcall gnus-group-goto-next-group-function
1029 ;; Go to the first group with unread articles.
1030 (gnus-group-search-forward t)
1031 ;; Find the right group to put point on. If the current group
1032 ;; has disappeared in the new listing, try to find the next
1033 ;; one. If no next one can be found, just leave point at the
1034 ;; first newsgroup in the buffer.
1035 (when (not (gnus-goto-char
1037 (point-min) (point-max)
1038 'gnus-group (gnus-intern-safe
1039 group gnus-active-hashtb))))
1040 (let ((newsrc (cdddr (gnus-gethash group gnus-newsrc-hashtb))))
1042 (not (gnus-goto-char
1044 (point-min) (point-max) 'gnus-group
1046 (caar newsrc) gnus-active-hashtb)))))
1047 (setq newsrc (cdr newsrc)))
1049 (goto-char (point-max))
1050 (forward-line -1))))))
1051 ;; Adjust cursor point.
1052 (gnus-group-position-point))))
1054 (defun gnus-group-list-level (level &optional all)
1055 "List groups on LEVEL.
1056 If ALL (the prefix), also list groups that have no unread articles."
1057 (interactive "nList groups on level: \nP")
1058 (gnus-group-list-groups level all level))
1060 (defun gnus-group-prepare-flat (level &optional all lowest regexp)
1061 "List all newsgroups with unread articles of level LEVEL or lower.
1062 If ALL is non-nil, list groups that have no unread articles.
1063 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1064 If REGEXP, only list groups matching REGEXP."
1065 (set-buffer gnus-group-buffer)
1066 (let ((buffer-read-only nil)
1067 (newsrc (cdr gnus-newsrc-alist))
1068 (lowest (or lowest 1))
1069 info clevel unread group params)
1071 (when (< lowest gnus-level-zombie)
1072 ;; List living groups.
1074 (setq info (car newsrc)
1075 group (gnus-info-group info)
1076 params (gnus-info-params info)
1078 unread (car (gnus-gethash group gnus-newsrc-hashtb)))
1079 (and unread ; This group might be bogus
1081 (string-match regexp group))
1082 (<= (setq clevel (gnus-info-level info)) level)
1084 (or all ; We list all groups?
1085 (if (eq unread t) ; Unactivated?
1086 gnus-group-list-inactive-groups ; We list unactivated
1087 (> unread 0)) ; We list groups with unread articles
1088 (and gnus-list-groups-with-ticked-articles
1089 (cdr (assq 'tick (gnus-info-marks info))))
1090 ; And groups with tickeds
1091 ;; Check for permanent visibility.
1092 (and gnus-permanently-visible-groups
1093 (string-match gnus-permanently-visible-groups
1095 (memq 'visible params)
1096 (cdr (assq 'visible params)))
1097 (gnus-group-insert-group-line
1098 group (gnus-info-level info)
1099 (gnus-info-marks info) unread (gnus-info-method info)))))
1101 ;; List dead groups.
1102 (and (>= level gnus-level-zombie) (<= lowest gnus-level-zombie)
1103 (gnus-group-prepare-flat-list-dead
1104 (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1105 gnus-level-zombie ?Z
1107 (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)
1108 (gnus-group-prepare-flat-list-dead
1109 (setq gnus-killed-list (sort gnus-killed-list 'string<))
1110 gnus-level-killed ?K regexp))
1112 (gnus-group-set-mode-line)
1113 (setq gnus-group-list-mode (cons level all))
1114 (run-hooks 'gnus-group-prepare-hook)))
1116 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1117 ;; List zombies and killed lists somewhat faster, which was
1118 ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>. It does
1119 ;; this by ignoring the group format specification altogether.
1122 ;; This loop is used when listing groups that match some
1125 (setq group (pop groups))
1126 (when (string-match regexp group)
1127 (gnus-add-text-properties
1128 (point) (prog1 (1+ (point))
1129 (insert " " mark " *: " group "\n"))
1130 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1132 'gnus-level level))))
1133 ;; This loop is used when listing all groups.
1135 (gnus-add-text-properties
1136 (point) (prog1 (1+ (point))
1137 (insert " " mark " *: "
1138 (setq group (pop groups)) "\n"))
1139 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1141 'gnus-level level))))))
1143 (defun gnus-group-update-group-line ()
1144 "Update the current line in the group buffer."
1145 (let* ((buffer-read-only nil)
1146 (group (gnus-group-group-name))
1147 (entry (and group (gnus-gethash group gnus-newsrc-hashtb)))
1148 gnus-group-indentation)
1151 (not (gnus-ephemeral-group-p group))
1153 (concat "(gnus-group-set-info '"
1154 (gnus-prin1-to-string (nth 2 entry))
1156 (setq gnus-group-indentation (gnus-group-group-indentation))
1158 (gnus-group-insert-group-line-info group)
1160 (gnus-group-position-point))))
1162 (defun gnus-group-insert-group-line-info (group)
1163 "Insert GROUP on the current line."
1164 (let ((entry (gnus-gethash group gnus-newsrc-hashtb))
1165 (gnus-group-indentation (gnus-group-group-indentation))
1169 ;; (Un)subscribed group.
1170 (setq info (nth 2 entry))
1171 (gnus-group-insert-group-line
1172 group (gnus-info-level info) (gnus-info-marks info)
1173 (or (car entry) t) (gnus-info-method info)))
1174 ;; This group is dead.
1175 (gnus-group-insert-group-line
1177 (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1179 (if (setq active (gnus-active group))
1180 (if (zerop (cdr active))
1182 (- (1+ (cdr active)) (car active)))
1186 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1187 gnus-tmp-marked number
1189 "Insert a group line in the group buffer."
1190 (let* ((gnus-tmp-active (gnus-active gnus-tmp-group))
1191 (gnus-tmp-number-total
1193 (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1195 (gnus-tmp-number-of-unread
1196 (if (numberp number) (int-to-string (max 0 number))
1198 (gnus-tmp-number-of-read
1199 (if (numberp number)
1200 (int-to-string (max 0 (- gnus-tmp-number-total number)))
1202 (gnus-tmp-subscribed
1203 (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1204 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1205 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1207 (gnus-tmp-qualified-group (gnus-group-real-name gnus-tmp-group))
1208 (gnus-tmp-newsgroup-description
1209 (if gnus-description-hashtb
1210 (or (gnus-gethash gnus-tmp-group gnus-description-hashtb) "")
1213 (if (and gnus-moderated-hashtb
1214 (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1216 (gnus-tmp-moderated-string
1217 (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1219 (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1220 (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1221 (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1222 (gnus-tmp-news-method-string
1224 (format "(%s:%s)" (car gnus-tmp-method)
1225 (cadr gnus-tmp-method)) ""))
1226 (gnus-tmp-marked-mark
1227 (if (and (numberp number)
1229 (cdr (assq 'tick gnus-tmp-marked)))
1231 (gnus-tmp-process-marked
1232 (if (member gnus-tmp-group gnus-group-marked)
1233 gnus-process-mark ? ))
1235 (or (and gnus-use-grouplens
1236 (bbb-grouplens-group-p gnus-tmp-group))
1238 (buffer-read-only nil)
1239 header gnus-tmp-header) ; passed as parameter to user-funcs.
1241 (gnus-add-text-properties
1245 (eval gnus-group-line-format-spec))
1246 `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1247 gnus-unread ,(if (numberp number)
1248 (string-to-int gnus-tmp-number-of-unread)
1250 gnus-marked ,gnus-tmp-marked-mark
1251 gnus-indentation ,gnus-group-indentation
1252 gnus-level ,gnus-tmp-level))
1253 (when (inline (gnus-visual-p 'group-highlight 'highlight))
1255 (run-hooks 'gnus-group-update-hook)
1257 ;; Allow XEmacs to remove front-sticky text properties.
1258 (gnus-group-remove-excess-properties)))
1260 (defun gnus-group-highlight-line ()
1261 "Highlight the current line according to `gnus-group-highlight'."
1262 (let* ((list gnus-group-highlight)
1264 (end (progn (end-of-line) (point)))
1265 ;; now find out where the line starts and leave point there.
1266 (beg (progn (beginning-of-line) (point)))
1267 (group (gnus-group-group-name))
1268 (entry (gnus-group-entry group))
1269 (unread (if (numberp (car entry)) (car entry) 0))
1270 (active (gnus-active group))
1271 (total (if active (1+ (- (cdr active) (car active))) 0))
1272 (info (nth 2 entry))
1273 (method (gnus-server-get-method group (gnus-info-method info)))
1274 (marked (gnus-info-marks info))
1275 (mailp (memq 'mail (assoc (symbol-name
1276 (car (or method gnus-select-method)))
1277 gnus-valid-select-methods)))
1278 (level (or (gnus-info-level info) 9))
1279 (score (or (gnus-info-score info) 0))
1280 (ticked (gnus-range-length (cdr (assq 'tick marked))))
1281 (group-age (gnus-group-timestamp-delta group))
1282 (inhibit-read-only t))
1283 ;; Eval the cars of the lists until we find a match.
1285 (not (eval (caar list))))
1286 (setq list (cdr list)))
1287 (let ((face (cdar list)))
1288 (unless (eq face (get-text-property beg 'face))
1289 (gnus-put-text-property
1291 (setq face (if (boundp face) (symbol-value face) face)))
1292 (gnus-extent-start-open beg)))
1295 (defun gnus-group-update-group (group &optional visible-only)
1296 "Update all lines where GROUP appear.
1297 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1300 (set-buffer gnus-group-buffer)
1301 ;; The buffer may be narrowed.
1304 (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1306 found buffer-read-only)
1307 ;; Enter the current status into the dribble buffer.
1308 (let ((entry (gnus-gethash group gnus-newsrc-hashtb)))
1309 (when (and entry (not (gnus-ephemeral-group-p group)))
1311 (concat "(gnus-group-set-info '"
1312 (gnus-prin1-to-string (nth 2 entry))
1314 ;; Find all group instances. If topics are in use, each group
1315 ;; may be listed in more than once.
1316 (while (setq loc (text-property-any
1317 loc (point-max) 'gnus-group ident))
1320 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1322 (gnus-group-insert-group-line-info group)
1325 (run-hooks 'gnus-group-update-group-hook)))
1326 (setq loc (1+ loc)))
1327 (unless (or found visible-only)
1328 ;; No such line in the buffer, find out where it's supposed to
1329 ;; go, and insert it there (or at the end of the buffer).
1330 (if gnus-goto-missing-group-function
1331 (funcall gnus-goto-missing-group-function group)
1332 (let ((entry (cddr (gnus-gethash group gnus-newsrc-hashtb))))
1333 (while (and entry (car entry)
1337 (point-min) (point-max)
1338 'gnus-group (gnus-intern-safe
1339 (caar entry) gnus-active-hashtb)))))
1340 (setq entry (cdr entry)))
1341 (or entry (goto-char (point-max)))))
1342 ;; Finally insert the line.
1343 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1344 (gnus-group-insert-group-line-info group)
1347 (run-hooks 'gnus-group-update-group-hook))))
1348 (when gnus-group-update-group-function
1349 (funcall gnus-group-update-group-function group))
1350 (gnus-group-set-mode-line)))))
1352 (defun gnus-group-set-mode-line ()
1353 "Update the mode line in the group buffer."
1354 (when (memq 'group gnus-updated-mode-lines)
1355 ;; Yes, we want to keep this mode line updated.
1357 (set-buffer gnus-group-buffer)
1358 (let* ((gformat (or gnus-group-mode-line-format-spec
1359 (setq gnus-group-mode-line-format-spec
1361 gnus-group-mode-line-format
1362 gnus-group-mode-line-format-alist))))
1363 (gnus-tmp-news-server (cadr gnus-select-method))
1364 (gnus-tmp-news-method (car gnus-select-method))
1365 (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1367 gnus-tmp-header ;Dummy binding for user-defined formats
1368 ;; Get the resulting string.
1370 (and gnus-dribble-buffer
1371 (buffer-name gnus-dribble-buffer)
1372 (buffer-modified-p gnus-dribble-buffer)
1374 (set-buffer gnus-dribble-buffer)
1375 (not (zerop (buffer-size))))))
1376 (mode-string (eval gformat)))
1377 ;; Say whether the dribble buffer has been modified.
1378 (setq mode-line-modified
1379 (if modified "---*- " "----- "))
1380 ;; If the line is too long, we chop it off.
1381 (when (> (length mode-string) max-len)
1382 (setq mode-string (substring mode-string 0 (- max-len 4))))
1384 (setq mode-line-buffer-identification
1385 (gnus-mode-line-buffer-identification
1386 (list mode-string)))
1387 (set-buffer-modified-p modified))))))
1389 (defun gnus-group-group-name ()
1390 "Get the name of the newsgroup on the current line."
1391 (let ((group (get-text-property (gnus-point-at-bol) 'gnus-group)))
1392 (and group (symbol-name group))))
1394 (defun gnus-group-group-level ()
1395 "Get the level of the newsgroup on the current line."
1396 (get-text-property (gnus-point-at-bol) 'gnus-level))
1398 (defun gnus-group-group-indentation ()
1399 "Get the indentation of the newsgroup on the current line."
1400 (or (get-text-property (gnus-point-at-bol) 'gnus-indentation)
1401 (and gnus-group-indentation-function
1402 (funcall gnus-group-indentation-function))
1405 (defun gnus-group-group-unread ()
1406 "Get the number of unread articles of the newsgroup on the current line."
1407 (get-text-property (gnus-point-at-bol) 'gnus-unread))
1409 (defun gnus-group-new-mail (group)
1410 (if (nnmail-new-mail-p (gnus-group-real-name group))
1414 (defun gnus-group-search-forward (&optional backward all level first-too)
1415 "Find the next newsgroup with unread articles.
1416 If BACKWARD is non-nil, find the previous newsgroup instead.
1417 If ALL is non-nil, just find any newsgroup.
1418 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1420 If FIRST-TOO, the current line is also eligible as a target."
1421 (let ((way (if backward -1 1))
1422 (low gnus-level-killed)
1425 (if (and backward (progn (beginning-of-line)) (bobp))
1436 (get-text-property (point) 'gnus-unread)))
1437 (and (numberp unread) (> unread 0)))
1438 (setq lev (get-text-property (point)
1440 (<= lev gnus-level-subscribed)))
1442 (and (setq lev (get-text-property (point)
1451 (zerop (forward-line way)))))
1453 (progn (gnus-group-position-point) t)
1454 (goto-char (or pos beg))
1457 ;;; Gnus group mode commands
1461 (defun gnus-group-mark-group (n &optional unmark no-advance)
1462 "Mark the current group."
1464 (let ((buffer-read-only nil)
1468 (when (setq group (gnus-group-group-name))
1469 ;; Go to the mark position.
1471 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1472 (subst-char-in-region
1473 (point) (1+ (point)) (following-char)
1476 (setq gnus-group-marked (delete group gnus-group-marked))
1478 (setq gnus-group-marked
1479 (cons group (delete group gnus-group-marked)))
1480 gnus-process-mark)))
1482 (gnus-group-next-group 1))
1484 (gnus-summary-position-point)
1487 (defun gnus-group-unmark-group (n)
1488 "Remove the mark from the current group."
1490 (gnus-group-mark-group n 'unmark)
1491 (gnus-group-position-point))
1493 (defun gnus-group-unmark-all-groups ()
1494 "Unmark all groups."
1496 (let ((groups gnus-group-marked))
1499 (gnus-group-remove-mark (pop groups)))))
1500 (gnus-group-position-point))
1502 (defun gnus-group-mark-region (unmark beg end)
1503 "Mark all groups between point and mark.
1504 If UNMARK, remove the mark instead."
1505 (interactive "P\nr")
1506 (let ((num (count-lines beg end)))
1509 (- num (gnus-group-mark-group num unmark)))))
1511 (defun gnus-group-mark-buffer (&optional unmark)
1512 "Mark all groups in the buffer.
1513 If UNMARK, remove the mark instead."
1515 (gnus-group-mark-region unmark (point-min) (point-max)))
1517 (defun gnus-group-mark-regexp (regexp)
1518 "Mark all groups that match some regexp."
1519 (interactive "sMark (regexp): ")
1520 (let ((alist (cdr gnus-newsrc-alist))
1523 (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1524 (gnus-group-set-mark group))))
1525 (gnus-group-position-point))
1527 (defun gnus-group-remove-mark (group)
1528 "Remove the process mark from GROUP and move point there.
1529 Return nil if the group isn't displayed."
1530 (if (gnus-group-goto-group group)
1532 (gnus-group-mark-group 1 'unmark t)
1534 (setq gnus-group-marked
1535 (delete group gnus-group-marked))
1538 (defun gnus-group-set-mark (group)
1539 "Set the process mark on GROUP."
1540 (if (gnus-group-goto-group group)
1542 (gnus-group-mark-group 1 nil t))
1543 (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1545 (defun gnus-group-universal-argument (arg &optional groups func)
1546 "Perform any command on all groups according to the process/prefix convention."
1548 (if (eq (setq func (or func
1551 (substitute-command-keys
1552 "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1554 (gnus-error 1 "Undefined key")
1555 (gnus-group-iterate arg
1557 (command-execute func))))
1558 (gnus-group-position-point))
1560 (defun gnus-group-process-prefix (n)
1561 "Return a list of groups to work on.
1562 Take into consideration N (the prefix) and the list of marked groups."
1565 (setq n (prefix-numeric-value n))
1566 ;; There is a prefix, so we return a list of the N next
1568 (let ((way (if (< n 0) -1 1))
1573 (setq group (gnus-group-group-name)))
1576 (gnus-group-next-group way)))
1578 ((and (boundp 'transient-mark-mode)
1580 (boundp 'mark-active)
1582 ;; Work on the region between point and mark.
1583 (let ((max (max (point) (mark)))
1586 (goto-char (min (point) (mark)))
1589 (push (gnus-group-group-name) groups)
1590 (zerop (gnus-group-next-group 1))
1592 (nreverse groups))))
1594 ;; No prefix, but a list of marked articles.
1595 (reverse gnus-group-marked))
1597 ;; Neither marked articles or a prefix, so we return the
1599 (let ((group (gnus-group-group-name)))
1600 (and group (list group))))))
1602 (defun gnus-group-iterate (arg function)
1603 "Iterate FUNCTION over all process/prefixed groups.
1604 FUNCTION will be called with the group name as the paremeter
1605 and with point over the group in question."
1606 (let ((groups (gnus-group-process-prefix arg))
1608 (while (setq group (pop groups))
1609 (gnus-group-remove-mark group)
1610 (funcall function group))))
1612 (put 'gnus-group-iterate 'lisp-indent-function 1)
1614 ;; Selecting groups.
1616 (defun gnus-group-read-group (&optional all no-article group)
1617 "Read news in this newsgroup.
1618 If the prefix argument ALL is non-nil, already read articles become
1619 readable. IF ALL is a number, fetch this number of articles. If the
1620 optional argument NO-ARTICLE is non-nil, no article will be
1621 auto-selected upon group entry. If GROUP is non-nil, fetch that
1624 (let ((no-display (eq all 0))
1625 (group (or group (gnus-group-group-name)))
1626 number active marked entry)
1630 (error "No group on current line"))
1631 (setq marked (gnus-info-marks
1632 (nth 2 (setq entry (gnus-gethash
1633 group gnus-newsrc-hashtb)))))
1634 ;; This group might be a dead group. In that case we have to get
1635 ;; the number of unread articles from `gnus-active-hashtb'.
1637 (cond ((numberp all) all)
1639 ((setq active (gnus-active group))
1640 (- (1+ (cdr active)) (car active)))))
1641 (gnus-summary-read-group
1642 group (or all (and (numberp number)
1643 (zerop (+ number (gnus-range-length
1644 (cdr (assq 'tick marked)))
1646 (cdr (assq 'dormant marked)))))))
1647 no-article nil no-display)))
1649 (defun gnus-group-select-group (&optional all)
1650 "Select this newsgroup.
1651 No article is selected automatically.
1652 If ALL is non-nil, already read articles become readable.
1653 If ALL is a number, fetch this number of articles."
1655 (gnus-group-read-group all t))
1657 (defun gnus-group-quick-select-group (&optional all)
1658 "Select the current group \"quickly\".
1659 This means that no highlighting or scoring will be performed.
1660 If ALL (the prefix argument) is 0, don't even generate the summary
1663 (require 'gnus-score)
1665 gnus-score-find-score-files-function
1666 gnus-apply-kill-hook
1667 gnus-summary-expunge-below)
1668 (gnus-group-read-group all t)))
1670 (defun gnus-group-visible-select-group (&optional all)
1671 "Select the current group without hiding any articles."
1673 (let ((gnus-inhibit-limiting t))
1674 (gnus-group-read-group all t)))
1677 (defun gnus-fetch-group (group)
1678 "Start Gnus if necessary and enter GROUP.
1679 Returns whether the fetching was successful or not."
1680 (interactive "sGroup name: ")
1681 (unless (get-buffer gnus-group-buffer)
1683 (gnus-group-read-group nil nil group))
1685 ;; Enter a group that is not in the group buffer. Non-nil is returned
1686 ;; if selection was successful.
1687 (defun gnus-group-read-ephemeral-group (group method &optional activate
1688 quit-config request-only)
1689 "Read GROUP from METHOD as an ephemeral group.
1690 If ACTIVATE, request the group first.
1691 If QUIT-CONFIG, use that window configuration when exiting from the
1693 If REQUEST-ONLY, don't actually read the group; just request it.
1695 Return the name of the group is selection was successful."
1696 (let ((group (if (gnus-group-foreign-p group) group
1697 (gnus-group-prefixed-name group method))))
1701 ,gnus-level-default-subscribed nil nil ,method
1703 ,(if quit-config quit-config
1704 (cons gnus-summary-buffer
1705 gnus-current-window-configuration))))))
1707 (set-buffer gnus-group-buffer)
1708 (unless (gnus-check-server method)
1709 (error "Unable to contact server: %s" (gnus-status-message method)))
1711 (gnus-activate-group group 'scan)
1712 (unless (gnus-request-group group)
1713 (error "Couldn't request group: %s"
1714 (nnheader-get-report (car method)))))
1718 (when (gnus-group-read-group t t group)
1723 (defun gnus-group-jump-to-group (group)
1724 "Jump to newsgroup GROUP."
1726 (list (completing-read
1727 "Group: " gnus-active-hashtb nil
1728 (gnus-read-active-file-p)
1730 'gnus-group-history)))
1732 (when (equal group "")
1733 (error "Empty group name"))
1735 (unless (gnus-ephemeral-group-p group)
1736 ;; Either go to the line in the group buffer...
1737 (unless (gnus-group-goto-group group)
1738 ;; ... or insert the line.
1739 (gnus-group-update-group group)
1740 (gnus-group-goto-group group)))
1741 ;; Adjust cursor point.
1742 (gnus-group-position-point))
1744 (defun gnus-group-goto-group (group &optional far)
1745 "Goto to newsgroup GROUP.
1746 If FAR, it is likely that the group is not on the current line."
1751 (point-min) (point-max)
1752 'gnus-group (gnus-intern-safe group gnus-active-hashtb)))
1755 ;; It's quite likely that we are on the right line, so
1756 ;; we check the current line first.
1757 ((eq (get-text-property (point) 'gnus-group)
1758 (gnus-intern-safe group gnus-active-hashtb))
1760 ;; Previous and next line are also likely, so we check them as well.
1763 (eq (get-text-property (point) 'gnus-group)
1764 (gnus-intern-safe group gnus-active-hashtb)))
1769 (eq (get-text-property (point) 'gnus-group)
1770 (gnus-intern-safe group gnus-active-hashtb)))
1774 ;; Search through the entire buffer.
1777 (point-min) (point-max)
1778 'gnus-group (gnus-intern-safe group gnus-active-hashtb))))))))
1780 (defun gnus-group-next-group (n &optional silent)
1781 "Go to next N'th newsgroup.
1782 If N is negative, search backward instead.
1783 Returns the difference between N and the number of skips actually
1786 (gnus-group-next-unread-group n t nil silent))
1788 (defun gnus-group-next-unread-group (n &optional all level silent)
1789 "Go to next N'th unread newsgroup.
1790 If N is negative, search backward instead.
1791 If ALL is non-nil, choose any newsgroup, unread or not.
1792 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
1793 such group can be found, the next group with a level higher than
1795 Returns the difference between N and the number of skips actually
1798 (let ((backward (< n 0))
1801 (gnus-group-search-forward
1802 backward (or (not gnus-group-goto-unread) all) level))
1806 (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
1807 (if level " on this level or higher" "")))
1810 (defun gnus-group-prev-group (n)
1811 "Go to previous N'th newsgroup.
1812 Returns the difference between N and the number of skips actually
1815 (gnus-group-next-unread-group (- n) t))
1817 (defun gnus-group-prev-unread-group (n)
1818 "Go to previous N'th unread newsgroup.
1819 Returns the difference between N and the number of skips actually
1822 (gnus-group-next-unread-group (- n)))
1824 (defun gnus-group-next-unread-group-same-level (n)
1825 "Go to next N'th unread newsgroup on the same level.
1826 If N is negative, search backward instead.
1827 Returns the difference between N and the number of skips actually
1830 (gnus-group-next-unread-group n t (gnus-group-group-level))
1831 (gnus-group-position-point))
1833 (defun gnus-group-prev-unread-group-same-level (n)
1834 "Go to next N'th unread newsgroup on the same level.
1835 Returns the difference between N and the number of skips actually
1838 (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
1839 (gnus-group-position-point))
1841 (defun gnus-group-best-unread-group (&optional exclude-group)
1842 "Go to the group with the highest level.
1843 If EXCLUDE-GROUP, do not go to that group."
1845 (goto-char (point-min))
1849 (setq unread (get-text-property (point) 'gnus-unread))
1850 (when (and (numberp unread) (> unread 0))
1851 (when (and (get-text-property (point) 'gnus-level)
1852 (< (get-text-property (point) 'gnus-level) best)
1853 (or (not exclude-group)
1854 (not (equal exclude-group (gnus-group-group-name)))))
1855 (setq best (get-text-property (point) 'gnus-level))
1856 (setq best-point (point))))
1859 (goto-char best-point))
1860 (gnus-summary-position-point)
1861 (and best-point (gnus-group-group-name))))
1863 (defun gnus-group-first-unread-group ()
1864 "Go to the first group with unread articles."
1867 (let ((opoint (point))
1869 (goto-char (point-min))
1870 (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
1871 (and (numberp unread) ; Not a topic.
1872 (not (zerop unread))) ; Has unread articles.
1873 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
1876 nil)) ; Not success.
1877 (gnus-group-position-point)))
1879 (defun gnus-group-enter-server-mode ()
1880 "Jump to the server buffer."
1882 (gnus-enter-server-buffer))
1884 (defun gnus-group-make-group (name &optional method address args)
1885 "Add a new newsgroup.
1886 The user will be prompted for a NAME, for a select METHOD, and an
1890 (gnus-read-group "Group name: ")
1891 (gnus-read-method "From method: ")))
1893 (let* ((meth (when (and method
1894 (not (gnus-server-equal method gnus-select-method)))
1895 (if address (list (intern method) address)
1897 (nname (if method (gnus-group-prefixed-name name meth) name))
1899 (when (gnus-gethash nname gnus-newsrc-hashtb)
1900 (error "Group %s already exists" nname))
1901 ;; Subscribe to the new group.
1902 (gnus-group-change-level
1903 (setq info (list t nname gnus-level-default-subscribed nil nil meth))
1904 gnus-level-default-subscribed gnus-level-killed
1905 (and (gnus-group-group-name)
1906 (gnus-gethash (gnus-group-group-name)
1907 gnus-newsrc-hashtb))
1910 (gnus-set-active nname (cons 1 0))
1911 (unless (gnus-ephemeral-group-p name)
1913 (concat "(gnus-group-set-info '"
1914 (gnus-prin1-to-string (cdr info)) ")")))
1916 (gnus-group-insert-group-line-info nname)
1918 (gnus-group-position-point)
1920 ;; Load the backend and try to make the backend create
1921 ;; the group as well.
1922 (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
1924 gnus-valid-select-methods)
1926 (gnus-check-server meth)
1927 (when (gnus-check-backend-function 'request-create-group nname)
1928 (gnus-request-create-group nname nil args))
1931 (defun gnus-group-delete-group (group &optional force)
1932 "Delete the current group. Only meaningful with mail groups.
1933 If FORCE (the prefix) is non-nil, all the articles in the group will
1934 be deleted. This is \"deleted\" as in \"removed forever from the face
1935 of the Earth\". There is no undo. The user will be prompted before
1936 doing the deletion."
1938 (list (gnus-group-group-name)
1939 current-prefix-arg))
1941 (error "No group to rename"))
1942 (unless (gnus-check-backend-function 'request-delete-group group)
1943 (error "This backend does not support group deletion"))
1945 (if (not (gnus-yes-or-no-p
1947 "Do you really want to delete %s%s? "
1948 group (if force " and all its contents" ""))))
1950 (gnus-message 6 "Deleting group %s..." group)
1951 (if (not (gnus-request-delete-group group force))
1952 (gnus-error 3 "Couldn't delete group %s" group)
1953 (gnus-message 6 "Deleting group %s...done" group)
1954 (gnus-group-goto-group group)
1955 (gnus-group-kill-group 1 t)
1956 (gnus-sethash group nil gnus-active-hashtb)
1958 (gnus-group-position-point)))
1960 (defun gnus-group-rename-group (group new-name)
1961 "Rename group from GROUP to NEW-NAME.
1962 When used interactively, GROUP is the group under point
1963 and NEW-NAME will be prompted for."
1966 (gnus-group-group-name)
1968 (unless (gnus-check-backend-function
1969 'request-rename-group (gnus-group-group-name))
1970 (error "This backend does not support renaming groups"))
1971 (read-string "New group name: " (gnus-group-group-name)))))
1973 (unless (gnus-check-backend-function 'request-rename-group group)
1974 (error "This backend does not support renaming groups"))
1976 (error "No group to rename"))
1977 (when (string-match "^[ \t]*$" new-name)
1978 (error "Not a valid group name"))
1979 (when (equal group new-name)
1980 (error "Can't rename to the same name"))
1982 ;; We find the proper prefixed name.
1984 (if (equal (gnus-group-real-name new-name) new-name)
1988 (gnus-group-prefixed-name
1989 (gnus-group-real-name new-name)
1990 (gnus-info-method (gnus-get-info group)))))
1992 (gnus-message 6 "Renaming group %s to %s..." group new-name)
1994 (if (not (gnus-request-rename-group group new-name))
1995 (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
1996 ;; We rename the group internally by killing it...
1997 (gnus-group-goto-group group)
1998 (gnus-group-kill-group)
1999 ;; ... changing its name ...
2000 (setcar (cdar gnus-list-of-killed-groups) new-name)
2001 ;; ... and then yanking it. Magic!
2002 (gnus-group-yank-group)
2003 (gnus-set-active new-name (gnus-active group))
2004 (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2006 (gnus-group-position-point)))
2008 (defun gnus-group-edit-group (group &optional part)
2009 "Edit the group on the current line."
2010 (interactive (list (gnus-group-group-name)))
2011 (let ((part (or part 'info))
2014 (error "No group on current line"))
2015 (unless (setq info (gnus-get-info group))
2016 (error "Killed group; can't be edited"))
2018 ;; Find the proper form to edit.
2019 (cond ((eq part 'method)
2020 (or (gnus-info-method info) "native"))
2022 (gnus-info-params info))
2024 ;; The proper documentation.
2028 ((eq part 'method) "select method")
2029 ((eq part 'params) "group parameters")
2032 (gnus-group-edit-group-done ',part ,group form)))))
2034 (defun gnus-group-edit-group-method (group)
2035 "Edit the select method of GROUP."
2036 (interactive (list (gnus-group-group-name)))
2037 (gnus-group-edit-group group 'method))
2039 (defun gnus-group-edit-group-parameters (group)
2040 "Edit the group parameters of GROUP."
2041 (interactive (list (gnus-group-group-name)))
2042 (gnus-group-edit-group group 'params))
2044 (defun gnus-group-edit-group-done (part group form)
2046 (let* ((method (cond ((eq part 'info) (nth 4 form))
2047 ((eq part 'method) form)
2049 (info (cond ((eq part 'info) form)
2050 ((eq part 'method) (gnus-get-info group))
2053 (if (or (not method)
2055 gnus-select-method method))
2056 (gnus-group-real-name (car info))
2057 (gnus-group-prefixed-name
2058 (gnus-group-real-name (car info)) method))
2060 (when (and new-group
2061 (not (equal new-group group)))
2062 (when (gnus-group-goto-group group)
2063 (gnus-group-kill-group 1))
2064 (gnus-activate-group new-group))
2066 (if (not (and info new-group))
2067 (gnus-group-set-info form (or new-group group) part)
2068 (setq info (gnus-copy-sequence info))
2069 (setcar info new-group)
2070 (unless (gnus-server-equal method "native")
2071 (unless (nthcdr 3 info)
2072 (nconc info (list nil nil)))
2073 (unless (nthcdr 4 info)
2074 (nconc info (list nil)))
2075 (gnus-info-set-method info method))
2076 (gnus-group-set-info info))
2077 (gnus-group-update-group (or new-group group))
2078 (gnus-group-position-point)))
2080 (defun gnus-group-make-useful-group (group method)
2082 (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2084 gnus-useful-groups)))
2085 (list (cadr entry) (caddr entry))))
2086 (setq method (gnus-copy-sequence method))
2088 (while (setq entry (memq (assq 'eval method) method))
2089 (setcar entry (eval (cadar entry)))))
2090 (gnus-group-make-group group method))
2092 (defun gnus-group-make-help-group ()
2093 "Create the Gnus documentation group."
2095 (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2096 (file (nnheader-find-etc-directory "gnus-tut.txt" t))
2098 (when (gnus-gethash name gnus-newsrc-hashtb)
2099 (error "Documentation group already exists"))
2101 (gnus-message 1 "Couldn't find doc group")
2102 (gnus-group-make-group
2103 (gnus-group-real-name name)
2104 (list 'nndoc "gnus-help"
2105 (list 'nndoc-address file)
2106 (list 'nndoc-article-type 'mbox)))))
2107 (gnus-group-position-point))
2109 (defun gnus-group-make-doc-group (file type)
2110 "Create a group that uses a single file as the source."
2112 (list (read-file-name "File name: ")
2113 (and current-prefix-arg 'ask)))
2114 (when (eq type 'ask)
2119 "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [mbdfag]: "
2121 (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2122 ((= char ?b) 'babyl)
2123 ((= char ?d) 'digest)
2124 ((= char ?f) 'forward)
2126 (t (setq err (format "%c unknown. " char))
2129 (let* ((file (expand-file-name file))
2130 (name (gnus-generate-new-group-name
2131 (gnus-group-prefixed-name
2132 (file-name-nondirectory file) '(nndoc "")))))
2133 (gnus-group-make-group
2134 (gnus-group-real-name name)
2136 (list 'nndoc-address file)
2137 (list 'nndoc-article-type (or type 'guess))))))
2139 (defvar nnweb-type-definition)
2140 (defvar gnus-group-web-type-history nil)
2141 (defvar gnus-group-web-search-history nil)
2142 (defun gnus-group-make-web-group (&optional solid)
2143 "Create an ephemeral nnweb group.
2144 If SOLID (the prefix), create a solid group."
2148 (if solid (gnus-read-group "Group name: ")
2149 (message-unique-id)))
2152 "Search engine type: "
2153 (mapcar (lambda (elem) (list (symbol-name (car elem))))
2154 nnweb-type-definition)
2155 nil t (cons (or (car gnus-group-web-type-history)
2156 (symbol-name (caar nnweb-type-definition)))
2158 'gnus-group-web-type-history))
2162 (cons (or (car gnus-group-web-search-history) "") 0)
2163 'gnus-group-web-search-history))
2165 `(nnweb ,group (nnweb-search ,search)
2166 (nnweb-type ,(intern type))
2167 (nnweb-ephemeral-p t))))
2169 (gnus-group-make-group group "nnweb" "" `(,(intern type) ,search))
2170 (gnus-group-read-ephemeral-group
2172 (cons (current-buffer)
2173 (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2175 (defun gnus-group-make-archive-group (&optional all)
2176 "Create the (ding) Gnus archive group of the most recent articles.
2177 Given a prefix, create a full group."
2179 (let ((group (gnus-group-prefixed-name
2180 (if all "ding.archives" "ding.recent") '(nndir ""))))
2181 (when (gnus-gethash group gnus-newsrc-hashtb)
2182 (error "Archive group already exists"))
2183 (gnus-group-make-group
2184 (gnus-group-real-name group)
2185 (list 'nndir (if all "hpc" "edu")
2186 (list 'nndir-directory
2187 (if all gnus-group-archive-directory
2188 gnus-group-recent-archive-directory))))
2189 (gnus-group-add-parameter group (cons 'to-address "ding@ifi.uio.no"))))
2191 (defun gnus-group-make-directory-group (dir)
2192 "Create an nndir group.
2193 The user will be prompted for a directory. The contents of this
2194 directory will be used as a newsgroup. The directory should contain
2195 mail messages or news articles in files that have numeric names."
2197 (list (read-file-name "Create group from directory: ")))
2198 (unless (file-exists-p dir)
2199 (error "No such directory"))
2200 (unless (file-directory-p dir)
2201 (error "Not a directory"))
2205 (while (or (not group) (gnus-gethash group gnus-newsrc-hashtb))
2207 (gnus-group-prefixed-name
2208 (concat (file-name-as-directory (directory-file-name dir))
2211 (setq ext (format "<%d>" (setq i (1+ i)))))
2212 (gnus-group-make-group
2213 (gnus-group-real-name group)
2214 (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2216 (defun gnus-group-make-kiboze-group (group address scores)
2217 "Create an nnkiboze group.
2218 The user will be prompted for a name, a regexp to match groups, and
2219 score file entries for articles to include in the group."
2222 (read-string "nnkiboze group name: ")
2223 (read-string "Source groups (regexp): ")
2224 (let ((headers (mapcar (lambda (group) (list group))
2225 '("subject" "from" "number" "date" "message-id"
2226 "references" "chars" "lines" "xref"
2227 "followup" "all" "body" "head")))
2228 scores header regexp regexps)
2229 (while (not (equal "" (setq header (completing-read
2230 "Match on header: " headers nil t))))
2232 (while (not (equal "" (setq regexp (read-string
2233 (format "Match on %s (string): "
2235 (push (list regexp nil nil 'r) regexps))
2236 (push (cons header regexps) scores))
2238 (gnus-group-make-group group "nnkiboze" address)
2239 (nnheader-temp-write (gnus-score-file-name (concat "nnkiboze:" group))
2240 (let (emacs-lisp-mode-hook)
2241 (pp scores (current-buffer)))))
2243 (defun gnus-group-add-to-virtual (n vgroup)
2244 "Add the current group to a virtual group."
2246 (list current-prefix-arg
2247 (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2249 (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2250 (error "%s is not an nnvirtual group" vgroup))
2251 (let* ((groups (gnus-group-process-prefix n))
2252 (method (gnus-info-method (gnus-get-info vgroup))))
2253 (setcar (cdr method)
2255 (nth 1 method) "\\|"
2258 (gnus-group-remove-mark s)
2259 (concat "\\(^" (regexp-quote s) "$\\)"))
2261 (gnus-group-position-point))
2263 (defun gnus-group-make-empty-virtual (group)
2264 "Create a new, fresh, empty virtual group."
2265 (interactive "sCreate new, empty virtual group: ")
2266 (let* ((method (list 'nnvirtual "^$"))
2267 (pgroup (gnus-group-prefixed-name group method)))
2268 ;; Check whether it exists already.
2269 (when (gnus-gethash pgroup gnus-newsrc-hashtb)
2270 (error "Group %s already exists." pgroup))
2271 ;; Subscribe the new group after the group on the current line.
2272 (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2273 (gnus-group-update-group pgroup)
2275 (gnus-group-position-point)))
2277 (defun gnus-group-enter-directory (dir)
2278 "Enter an ephemeral nneething group."
2279 (interactive "DDirectory to read: ")
2280 (let* ((method (list 'nneething dir '(nneething-read-only t)))
2281 (leaf (gnus-group-prefixed-name
2282 (file-name-nondirectory (directory-file-name dir))
2284 (name (gnus-generate-new-group-name leaf)))
2285 (unless (gnus-group-read-ephemeral-group
2287 (cons (current-buffer)
2288 (if (eq major-mode 'gnus-summary-mode)
2290 (error "Couldn't enter %s" dir))))
2292 ;; Group sorting commands
2293 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
2295 (defun gnus-group-sort-groups (func &optional reverse)
2296 "Sort the group buffer according to FUNC.
2297 If REVERSE, reverse the sorting order."
2298 (interactive (list gnus-group-sort-function current-prefix-arg))
2299 (funcall gnus-group-sort-alist-function
2300 (gnus-make-sort-function func) reverse)
2301 (gnus-group-list-groups))
2303 (defun gnus-group-sort-flat (func reverse)
2304 ;; We peel off the dummy group from the alist.
2306 (when (equal (car (gnus-info-group gnus-newsrc-alist)) "dummy.group")
2307 (pop gnus-newsrc-alist))
2309 (setq gnus-newsrc-alist
2310 (sort gnus-newsrc-alist func))
2312 (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
2313 ;; Regenerate the hash table.
2314 (gnus-make-hashtable-from-newsrc-alist)))
2316 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
2317 "Sort the group buffer alphabetically by group name.
2318 If REVERSE, sort in reverse order."
2320 (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
2322 (defun gnus-group-sort-groups-by-unread (&optional reverse)
2323 "Sort the group buffer by number of unread articles.
2324 If REVERSE, sort in reverse order."
2326 (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
2328 (defun gnus-group-sort-groups-by-level (&optional reverse)
2329 "Sort the group buffer by group level.
2330 If REVERSE, sort in reverse order."
2332 (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
2334 (defun gnus-group-sort-groups-by-score (&optional reverse)
2335 "Sort the group buffer by group score.
2336 If REVERSE, sort in reverse order."
2338 (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
2340 (defun gnus-group-sort-groups-by-rank (&optional reverse)
2341 "Sort the group buffer by group rank.
2342 If REVERSE, sort in reverse order."
2344 (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
2346 (defun gnus-group-sort-groups-by-method (&optional reverse)
2347 "Sort the group buffer alphabetically by backend name.
2348 If REVERSE, sort in reverse order."
2350 (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
2352 ;;; Selected group sorting.
2354 (defun gnus-group-sort-selected-groups (n func &optional reverse)
2355 "Sort the process/prefixed groups."
2356 (interactive (list current-prefix-arg gnus-group-sort-function))
2357 (let ((groups (gnus-group-process-prefix n)))
2358 (funcall gnus-group-sort-selected-function
2359 groups (gnus-make-sort-function func) reverse)
2360 (gnus-group-list-groups)))
2362 (defun gnus-group-sort-selected-flat (groups func reverse)
2363 (let (entries infos)
2364 ;; First find all the group entries for these groups.
2366 (push (nthcdr 2 (gnus-gethash (pop groups) gnus-newsrc-hashtb))
2368 ;; Then sort the infos.
2372 (lambda (entry) (car entry))
2373 (setq entries (nreverse entries)))
2376 (setq infos (nreverse infos)))
2377 ;; Go through all the infos and replace the old entries
2378 ;; with the new infos.
2380 (setcar entries (pop infos))
2382 ;; Update the hashtable.
2383 (gnus-make-hashtable-from-newsrc-alist)))
2385 (defun gnus-group-sort-selected-groups-by-alphabet (&optional reverse)
2386 "Sort the group buffer alphabetically by group name.
2387 If REVERSE, sort in reverse order."
2389 (gnus-group-sort-selected-groups 'gnus-group-sort-by-alphabet reverse))
2391 (defun gnus-group-sort-selected-groups-by-unread (&optional reverse)
2392 "Sort the group buffer by number of unread articles.
2393 If REVERSE, sort in reverse order."
2395 (gnus-group-sort-selected-groups 'gnus-group-sort-by-unread reverse))
2397 (defun gnus-group-sort-selected-groups-by-level (&optional reverse)
2398 "Sort the group buffer by group level.
2399 If REVERSE, sort in reverse order."
2401 (gnus-group-sort-selected-groups 'gnus-group-sort-by-level reverse))
2403 (defun gnus-group-sort-selected-groups-by-score (&optional reverse)
2404 "Sort the group buffer by group score.
2405 If REVERSE, sort in reverse order."
2407 (gnus-group-sort-selected-groups 'gnus-group-sort-by-score reverse))
2409 (defun gnus-group-sort-selected-groups-by-rank (&optional reverse)
2410 "Sort the group buffer by group rank.
2411 If REVERSE, sort in reverse order."
2413 (gnus-group-sort-selected-groups 'gnus-group-sort-by-rank reverse))
2415 (defun gnus-group-sort-selected-groups-by-method (&optional reverse)
2416 "Sort the group buffer alphabetically by backend name.
2417 If REVERSE, sort in reverse order."
2419 (gnus-group-sort-selected-groups 'gnus-group-sort-by-method reverse))
2421 ;;; Sorting predicates.
2423 (defun gnus-group-sort-by-alphabet (info1 info2)
2424 "Sort alphabetically."
2425 (string< (gnus-info-group info1) (gnus-info-group info2)))
2427 (defun gnus-group-sort-by-real-name (info1 info2)
2428 "Sort alphabetically on real (unprefixed) names."
2429 (string< (gnus-group-real-name (gnus-info-group info1))
2430 (gnus-group-real-name (gnus-info-group info2))))
2432 (defun gnus-group-sort-by-unread (info1 info2)
2433 "Sort by number of unread articles."
2434 (let ((n1 (car (gnus-gethash (gnus-info-group info1) gnus-newsrc-hashtb)))
2435 (n2 (car (gnus-gethash (gnus-info-group info2) gnus-newsrc-hashtb))))
2436 (< (or (and (numberp n1) n1) 0)
2437 (or (and (numberp n2) n2) 0))))
2439 (defun gnus-group-sort-by-level (info1 info2)
2441 (< (gnus-info-level info1) (gnus-info-level info2)))
2443 (defun gnus-group-sort-by-method (info1 info2)
2444 "Sort alphabetically by backend name."
2445 (string< (symbol-name (car (gnus-find-method-for-group
2446 (gnus-info-group info1) info1)))
2447 (symbol-name (car (gnus-find-method-for-group
2448 (gnus-info-group info2) info2)))))
2450 (defun gnus-group-sort-by-score (info1 info2)
2451 "Sort by group score."
2452 (< (gnus-info-score info1) (gnus-info-score info2)))
2454 (defun gnus-group-sort-by-rank (info1 info2)
2455 "Sort by level and score."
2456 (let ((level1 (gnus-info-level info1))
2457 (level2 (gnus-info-level info2)))
2458 (or (< level1 level2)
2459 (and (= level1 level2)
2460 (> (gnus-info-score info1) (gnus-info-score info2))))))
2464 (defun gnus-group-clear-data (&optional arg)
2465 "Clear all marks and read ranges from the current group."
2467 (gnus-group-iterate arg
2470 (gnus-info-clear-data (setq info (gnus-get-info group)))
2471 (gnus-get-unread-articles-in-group info (gnus-active group) t)
2472 (when (gnus-group-goto-group group)
2473 (gnus-group-update-group-line))))))
2475 (defun gnus-group-clear-data-on-native-groups ()
2476 "Clear all marks and read ranges from all native groups."
2478 (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
2479 (let ((alist (cdr gnus-newsrc-alist))
2481 (while (setq info (pop alist))
2482 (when (gnus-group-native-p (gnus-info-group info))
2483 (gnus-info-clear-data info)))
2484 (gnus-get-unread-articles)
2485 (gnus-dribble-enter "")
2486 (when (gnus-y-or-n-p
2487 "Move the cache away to avoid problems in the future? ")
2488 (call-interactively 'gnus-cache-move-cache)))))
2490 (defun gnus-info-clear-data (info)
2491 "Clear all marks and read ranges from INFO."
2492 (let ((group (gnus-info-group info)))
2495 (gnus-info-set-marks ',info ',(gnus-info-marks info))
2496 (gnus-info-set-read ',info ',(gnus-info-read info))
2497 (when (gnus-group-goto-group ,group)
2498 (gnus-group-update-group-line))))
2499 (gnus-info-set-read info nil)
2500 (when (gnus-info-marks info)
2501 (gnus-info-set-marks info nil))))
2503 ;; Group catching up.
2505 (defun gnus-group-catchup-current (&optional n all)
2506 "Mark all articles not marked as unread in current newsgroup as read.
2507 If prefix argument N is numeric, the ARG next newsgroups will be
2508 caught up. If ALL is non-nil, marked articles will also be marked as
2509 read. Cross references (Xref: header) of articles are ignored.
2510 The difference between N and actual number of newsgroups that were
2511 caught up is returned."
2513 (unless (gnus-group-group-name)
2514 (error "No group on the current line"))
2515 (if (not (or (not gnus-interactive-catchup) ;Without confirmation?
2519 "Do you really want to mark all articles as read? "
2520 "Mark all unread articles as read? "))))
2522 (let ((groups (gnus-group-process-prefix n))
2525 ;; Virtual groups have to be given special treatment.
2526 (let ((method (gnus-find-method-for-group (car groups))))
2527 (when (eq 'nnvirtual (car method))
2528 (nnvirtual-catchup-group
2529 (gnus-group-real-name (car groups)) (nth 1 method) all)))
2530 (gnus-group-remove-mark (car groups))
2531 (if (>= (gnus-group-group-level) gnus-level-zombie)
2532 (gnus-message 2 "Dead groups can't be caught up")
2534 (gnus-group-goto-group (car groups))
2535 (gnus-group-catchup (car groups) all))
2536 (gnus-group-update-group-line)
2537 (setq ret (1+ ret))))
2538 (setq groups (cdr groups)))
2539 (gnus-group-next-unread-group 1)
2542 (defun gnus-group-catchup-current-all (&optional n)
2543 "Mark all articles in current newsgroup as read.
2544 Cross references (Xref: header) of articles are ignored."
2546 (gnus-group-catchup-current n 'all))
2548 (defun gnus-group-catchup (group &optional all)
2549 "Mark all articles in GROUP as read.
2550 If ALL is non-nil, all articles are marked as read.
2551 The return value is the number of articles that were marked as read,
2552 or nil if no action could be taken."
2553 (let* ((entry (gnus-gethash group gnus-newsrc-hashtb))
2555 ;; Do the updating only if the newsgroup isn't killed.
2556 (if (not (numberp (car entry)))
2557 (gnus-message 1 "Can't catch up %s; non-active group" group)
2558 ;; Do auto-expirable marks if that's required.
2559 (when (gnus-group-auto-expirable-p group)
2560 (gnus-add-marked-articles
2561 group 'expire (gnus-list-of-unread-articles group))
2563 (let ((marks (nth 3 (nth 2 entry))))
2564 (gnus-add-marked-articles
2565 group 'expire (gnus-uncompress-range (cdr (assq 'tick marks))))
2566 (gnus-add-marked-articles
2567 group 'expire (gnus-uncompress-range (cdr (assq 'tick marks)))))))
2569 (gnus-update-read-articles group nil)
2570 ;; Also nix out the lists of marks and dormants.
2572 (gnus-add-marked-articles group 'tick nil nil 'force)
2573 (gnus-add-marked-articles group 'dormant nil nil 'force))
2574 (let ((gnus-newsgroup-name group))
2575 (run-hooks 'gnus-group-catchup-group-hook))
2578 (defun gnus-group-expire-articles (&optional n)
2579 "Expire all expirable articles in the current newsgroup."
2581 (let ((groups (gnus-group-process-prefix n))
2584 (error "No groups to expire"))
2585 (while (setq group (pop groups))
2586 (gnus-group-remove-mark group)
2587 (when (gnus-check-backend-function 'request-expire-articles group)
2588 (gnus-message 6 "Expiring articles in %s..." group)
2589 (let* ((info (gnus-get-info group))
2590 (expirable (if (gnus-group-total-expirable-p group)
2591 (cons nil (gnus-list-of-read-articles group))
2592 (assq 'expire (gnus-info-marks info))))
2593 (expiry-wait (gnus-group-find-parameter group 'expiry-wait)))
2597 (gnus-compress-sequence
2599 ;; We set the expiry variables to the group
2601 (let ((nnmail-expiry-wait-function nil)
2602 (nnmail-expiry-wait expiry-wait))
2603 (gnus-request-expire-articles
2604 (gnus-uncompress-sequence (cdr expirable)) group))
2605 ;; Just expire using the normal expiry values.
2606 (gnus-request-expire-articles
2607 (gnus-uncompress-sequence (cdr expirable)) group))))
2608 (gnus-close-group group))
2609 (gnus-message 6 "Expiring articles in %s...done" group)))
2610 (gnus-group-position-point))))
2612 (defun gnus-group-expire-all-groups ()
2613 "Expire all expirable articles in all newsgroups."
2616 (gnus-message 5 "Expiring...")
2617 (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
2618 (cdr gnus-newsrc-alist))))
2619 (gnus-group-expire-articles nil)))
2620 (gnus-group-position-point)
2621 (gnus-message 5 "Expiring...done"))
2623 (defun gnus-group-set-current-level (n level)
2624 "Set the level of the next N groups to LEVEL."
2629 (let ((s (read-string
2630 (format "Level (default %s): "
2631 (or (gnus-group-group-level)
2632 gnus-level-default-subscribed)))))
2633 (if (string-match "^\\s-*$" s)
2634 (int-to-string (or (gnus-group-group-level)
2635 gnus-level-default-subscribed))
2637 (unless (and (>= level 1) (<= level gnus-level-killed))
2638 (error "Illegal level: %d" level))
2639 (let ((groups (gnus-group-process-prefix n))
2641 (while (setq group (pop groups))
2642 (gnus-group-remove-mark group)
2643 (gnus-message 6 "Changed level of %s from %d to %d"
2644 group (or (gnus-group-group-level) gnus-level-killed)
2646 (gnus-group-change-level
2647 group level (or (gnus-group-group-level) gnus-level-killed))
2648 (gnus-group-update-group-line)))
2649 (gnus-group-position-point))
2651 (defun gnus-group-unsubscribe (&optional n)
2652 "Unsubscribe the current group."
2654 (gnus-group-unsubscribe-current-group n 'unsubscribe))
2656 (defun gnus-group-subscribe (&optional n)
2657 "Unsubscribe the current group."
2659 (gnus-group-unsubscribe-current-group n 'subscribe))
2661 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
2662 "Toggle subscription of the current group.
2663 If given numerical prefix, toggle the N next groups."
2665 (let ((groups (gnus-group-process-prefix n))
2668 (setq group (car groups)
2669 groups (cdr groups))
2670 (gnus-group-remove-mark group)
2671 (gnus-group-unsubscribe-group
2674 ((eq do-sub 'unsubscribe)
2675 gnus-level-default-unsubscribed)
2676 ((eq do-sub 'subscribe)
2677 gnus-level-default-subscribed)
2678 ((<= (gnus-group-group-level) gnus-level-subscribed)
2679 gnus-level-default-unsubscribed)
2681 gnus-level-default-subscribed))
2683 (gnus-group-update-group-line))
2684 (gnus-group-next-group 1)))
2686 (defun gnus-group-unsubscribe-group (group &optional level silent)
2687 "Toggle subscription to GROUP.
2688 Killed newsgroups are subscribed. If SILENT, don't try to update the
2691 (list (completing-read
2692 "Group: " gnus-active-hashtb nil
2693 (gnus-read-active-file-p)
2695 'gnus-group-history)))
2696 (let ((newsrc (gnus-gethash group gnus-newsrc-hashtb)))
2698 ((string-match "^[ \t]$" group)
2699 (error "Empty group name"))
2701 ;; Toggle subscription flag.
2702 (gnus-group-change-level
2703 newsrc (if level level (if (<= (nth 1 (nth 2 newsrc))
2704 gnus-level-subscribed)
2705 (1+ gnus-level-subscribed)
2706 gnus-level-default-subscribed)))
2708 (gnus-group-update-group group)))
2709 ((and (stringp group)
2710 (or (not (gnus-read-active-file-p))
2711 (gnus-active group)))
2712 ;; Add new newsgroup.
2713 (gnus-group-change-level
2715 (if level level gnus-level-default-subscribed)
2716 (or (and (member group gnus-zombie-list)
2719 (when (gnus-group-group-name)
2720 (gnus-gethash (gnus-group-group-name) gnus-newsrc-hashtb)))
2722 (gnus-group-update-group group)))
2723 (t (error "No such newsgroup: %s" group)))
2724 (gnus-group-position-point)))
2726 (defun gnus-group-transpose-groups (n)
2727 "Move the current newsgroup up N places.
2728 If given a negative prefix, move down instead. The difference between
2729 N and the number of steps taken is returned."
2731 (unless (gnus-group-group-name)
2732 (error "No group on current line"))
2733 (gnus-group-kill-group 1)
2735 (forward-line (- n))
2736 (gnus-group-yank-group)
2737 (gnus-group-position-point)))
2739 (defun gnus-group-kill-all-zombies ()
2740 "Kill all zombie newsgroups."
2742 (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
2743 (setq gnus-zombie-list nil)
2744 (gnus-group-list-groups))
2746 (defun gnus-group-kill-region (begin end)
2747 "Kill newsgroups in current region (excluding current point).
2748 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
2763 (beginning-of-line) ;Important when LINES < 1
2764 (gnus-group-kill-group lines)))
2766 (defun gnus-group-kill-group (&optional n discard)
2767 "Kill the next N groups.
2768 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
2769 However, only groups that were alive can be yanked; already killed
2770 groups or zombie groups can't be yanked.
2771 The return value is the name of the group that was killed, or a list
2774 (let ((buffer-read-only nil)
2775 (groups (gnus-group-process-prefix n))
2776 group entry level out)
2777 (if (< (length groups) 10)
2778 ;; This is faster when there are few groups.
2780 (push (setq group (pop groups)) out)
2781 (gnus-group-remove-mark group)
2782 (setq level (gnus-group-group-level))
2784 (when (and (not discard)
2785 (setq entry (gnus-gethash group gnus-newsrc-hashtb)))
2788 (gnus-group-goto-group ,(gnus-group-group-name))
2789 (gnus-group-yank-group)))
2790 (push (cons (car entry) (nth 2 entry))
2791 gnus-list-of-killed-groups))
2792 (gnus-group-change-level
2793 (if entry entry group) gnus-level-killed (if entry nil level)))
2794 ;; If there are lots and lots of groups to be killed, we use
2795 ;; this thing instead.
2797 (setq groups (nreverse groups))
2799 (gnus-group-remove-mark (setq group (pop groups)))
2801 (push group gnus-killed-list)
2802 (setq gnus-newsrc-alist
2803 (delq (assoc group gnus-newsrc-alist)
2805 (when gnus-group-change-level-function
2806 (funcall gnus-group-change-level-function group 9 3))
2808 ((setq entry (gnus-gethash group gnus-newsrc-hashtb))
2809 (push (cons (car entry) (nth 2 entry))
2810 gnus-list-of-killed-groups)
2811 (setcdr (cdr entry) (cdddr entry)))
2812 ((member group gnus-zombie-list)
2813 (setq gnus-zombie-list (delete group gnus-zombie-list)))))
2814 (gnus-make-hashtable-from-newsrc-alist)))
2816 (gnus-group-position-point)
2817 (if (< (length out) 2) (car out) (nreverse out))))
2819 (defun gnus-group-yank-group (&optional arg)
2820 "Yank the last newsgroups killed with \\[gnus-group-kill-group],
2821 inserting it before the current newsgroup. The numeric ARG specifies
2822 how many newsgroups are to be yanked. The name of the newsgroup yanked
2823 is returned, or (if several groups are yanked) a list of yanked groups
2826 (setq arg (or arg 1))
2827 (let (info group prev out)
2828 (while (>= (decf arg) 0)
2829 (when (not (setq info (pop gnus-list-of-killed-groups)))
2830 (error "No more newsgroups to yank"))
2831 (push (setq group (nth 1 info)) out)
2832 ;; Find which newsgroup to insert this one before - search
2833 ;; backward until something suitable is found. If there are no
2834 ;; other newsgroups in this buffer, just make this newsgroup the
2836 (setq prev (gnus-group-group-name))
2837 (gnus-group-change-level
2838 info (gnus-info-level (cdr info)) gnus-level-killed
2839 (and prev (gnus-gethash prev gnus-newsrc-hashtb))
2841 (gnus-group-insert-group-line-info group)
2843 `(when (gnus-group-goto-group ,group)
2844 (gnus-group-kill-group 1))))
2846 (gnus-group-position-point)
2847 (if (< (length out) 2) (car out) (nreverse out))))
2849 (defun gnus-group-kill-level (level)
2850 "Kill all groups that is on a certain LEVEL."
2851 (interactive "nKill all groups on level: ")
2853 ((= level gnus-level-zombie)
2854 (setq gnus-killed-list
2855 (nconc gnus-zombie-list gnus-killed-list))
2856 (setq gnus-zombie-list nil))
2857 ((and (< level gnus-level-zombie)
2859 (or gnus-expert-user
2862 "Do you really want to kill all groups on level %d? "
2864 (let* ((prev gnus-newsrc-alist)
2867 (if (= (gnus-info-level (car alist)) level)
2869 (push (gnus-info-group (car alist)) gnus-killed-list)
2870 (setcdr prev (cdr alist)))
2872 (setq alist (cdr alist)))
2873 (gnus-make-hashtable-from-newsrc-alist)
2874 (gnus-group-list-groups)))
2876 (error "Can't kill; illegal level: %d" level))))
2878 (defun gnus-group-list-all-groups (&optional arg)
2879 "List all newsgroups with level ARG or lower.
2880 Default is gnus-level-unsubscribed, which lists all subscribed and most
2881 unsubscribed groups."
2883 (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
2885 ;; Redefine this to list ALL killed groups if prefix arg used.
2886 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
2887 (defun gnus-group-list-killed (&optional arg)
2888 "List all killed newsgroups in the group buffer.
2889 If ARG is non-nil, list ALL killed groups known to Gnus. This may
2890 entail asking the server for the groups."
2892 ;; Find all possible killed newsgroups if arg.
2894 (gnus-get-killed-groups))
2895 (if (not gnus-killed-list)
2896 (gnus-message 6 "No killed groups")
2897 (let (gnus-group-list-mode)
2898 (funcall gnus-group-prepare-function
2899 gnus-level-killed t gnus-level-killed))
2900 (goto-char (point-min)))
2901 (gnus-group-position-point))
2903 (defun gnus-group-list-zombies ()
2904 "List all zombie newsgroups in the group buffer."
2906 (if (not gnus-zombie-list)
2907 (gnus-message 6 "No zombie groups")
2908 (let (gnus-group-list-mode)
2909 (funcall gnus-group-prepare-function
2910 gnus-level-zombie t gnus-level-zombie))
2911 (goto-char (point-min)))
2912 (gnus-group-position-point))
2914 (defun gnus-group-list-active ()
2915 "List all groups that are available from the server(s)."
2917 ;; First we make sure that we have really read the active file.
2918 (unless (gnus-read-active-file-p)
2919 (let ((gnus-read-active-file t))
2920 (gnus-read-active-file)))
2921 ;; Find all groups and sort them.
2929 (push (symbol-name sym) list)))
2933 (buffer-read-only nil))
2936 (gnus-group-insert-group-line-info (pop groups)))
2937 (goto-char (point-min))))
2939 (defun gnus-activate-all-groups (level)
2940 "Activate absolutely all groups."
2941 (interactive (list 7))
2942 (let ((gnus-activate-level level)
2943 (gnus-activate-foreign-newsgroups level))
2944 (gnus-group-get-new-news)))
2946 (defun gnus-group-get-new-news (&optional arg)
2947 "Get newly arrived articles.
2948 If ARG is a number, it specifies which levels you are interested in
2949 re-scanning. If ARG is non-nil and not a number, this will force
2950 \"hard\" re-reading of the active files from all servers."
2952 (run-hooks 'gnus-get-new-news-hook)
2954 ;; Read any slave files.
2956 (gnus-master-read-slave-newsrc))
2958 ;; We might read in new NoCeM messages here.
2959 (when (and gnus-use-nocem
2961 (gnus-nocem-scan-groups))
2962 ;; If ARG is not a number, then we read the active file.
2963 (when (and arg (not (numberp arg)))
2964 (let ((gnus-read-active-file t))
2965 (gnus-read-active-file))
2968 (setq arg (gnus-group-default-level arg t))
2969 (if (and gnus-read-active-file (not arg))
2971 (gnus-read-active-file)
2972 (gnus-get-unread-articles arg))
2973 (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
2974 (gnus-get-unread-articles arg)))
2975 (run-hooks 'gnus-after-getting-new-news-hook)
2976 (gnus-group-list-groups))
2978 (defun gnus-group-get-new-news-this-group (&optional n)
2979 "Check for newly arrived news in the current group (and the N-1 next groups).
2980 The difference between N and the number of newsgroup checked is returned.
2981 If N is negative, this group and the N-1 previous groups will be checked."
2983 (let* ((groups (gnus-group-process-prefix n))
2984 (ret (if (numberp n) (- n (length groups)) 0))
2988 (while (setq group (pop groups))
2989 (gnus-group-remove-mark group)
2990 ;; Bypass any previous denials from the server.
2991 (gnus-remove-denial (gnus-find-method-for-group group))
2992 (if (gnus-activate-group group 'scan)
2994 (gnus-get-unread-articles-in-group
2995 (gnus-get-info group) (gnus-active group) t)
2996 (unless (gnus-virtual-group-p group)
2997 (gnus-close-group group))
2998 (gnus-group-update-group group))
2999 (if (eq (gnus-server-status (gnus-find-method-for-group group))
3001 (gnus-error 3 "Server denied access")
3002 (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3005 (when gnus-goto-next-group-when-activating
3006 (gnus-group-next-unread-group 1 t))
3007 (gnus-summary-position-point)
3010 (defun gnus-group-fetch-faq (group &optional faq-dir)
3011 "Fetch the FAQ for the current group.
3012 If given a prefix argument, prompt for the FAQ dir
3016 (gnus-group-group-name)
3017 (cond (current-prefix-arg
3019 "Faq dir: " (and (listp gnus-group-faq-directory)
3020 (mapcar (lambda (file) (list file))
3021 gnus-group-faq-directory)))))))
3023 (error "No group name given"))
3024 (let ((dirs (or faq-dir gnus-group-faq-directory))
3026 (unless (listp dirs)
3027 (setq dirs (list dirs)))
3028 (while (and (not found)
3029 (setq dir (pop dirs)))
3030 (setq file (concat (file-name-as-directory dir)
3031 (gnus-group-real-name group)))
3032 (if (not (file-exists-p file))
3033 (gnus-message 1 "No such file: %s" file)
3037 (defun gnus-group-describe-group (force &optional group)
3038 "Display a description of the current newsgroup."
3039 (interactive (list current-prefix-arg (gnus-group-group-name)))
3040 (let* ((method (gnus-find-method-for-group group))
3041 (mname (gnus-group-prefixed-name "" method))
3044 gnus-description-hashtb)
3045 (gnus-sethash mname nil gnus-description-hashtb))
3047 (error "No group name given"))
3048 (when (or (and gnus-description-hashtb
3049 ;; We check whether this group's method has been
3050 ;; queried for a description file.
3051 (gnus-gethash mname gnus-description-hashtb))
3052 (setq desc (gnus-group-get-description group))
3053 (gnus-read-descriptions-file method))
3055 (or desc (gnus-gethash group gnus-description-hashtb)
3056 "No description available")))))
3058 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3059 (defun gnus-group-describe-all-groups (&optional force)
3060 "Pop up a buffer with descriptions of all newsgroups."
3063 (setq gnus-description-hashtb nil))
3064 (when (not (or gnus-description-hashtb
3065 (gnus-read-all-descriptions-files)))
3066 (error "Couldn't request descriptions file"))
3067 (let ((buffer-read-only nil)
3073 (insert (format " *: %-20s %s\n" (symbol-name group)
3074 (symbol-value group)))
3075 (gnus-add-text-properties
3076 b (1+ b) (list 'gnus-group group
3077 'gnus-unread t 'gnus-marked nil
3078 'gnus-level (1+ gnus-level-subscribed))))
3079 gnus-description-hashtb)
3080 (goto-char (point-min))
3081 (gnus-group-position-point)))
3083 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
3084 (defun gnus-group-apropos (regexp &optional search-description)
3085 "List all newsgroups that have names that match a regexp."
3086 (interactive "sGnus apropos (regexp): ")
3088 (obuf (current-buffer))
3090 ;; Go through all newsgroups that are known to Gnus.
3093 (and (symbol-name group)
3094 (string-match regexp (symbol-name group))
3095 (push (symbol-name group) groups)))
3097 ;; Also go through all descriptions that are known to Gnus.
3098 (when search-description
3101 (and (string-match regexp (symbol-value group))
3102 (gnus-active (symbol-name group))
3103 (push (symbol-name group) groups)))
3104 gnus-description-hashtb))
3106 (gnus-message 3 "No groups matched \"%s\"." regexp)
3107 ;; Print out all the groups.
3109 (pop-to-buffer "*Gnus Help*")
3110 (buffer-disable-undo (current-buffer))
3112 (setq groups (sort groups 'string<))
3114 ;; Groups may be entered twice into the list of groups.
3115 (when (not (string= (car groups) prev))
3116 (insert (setq prev (car groups)) "\n")
3117 (when (and gnus-description-hashtb
3118 (setq des (gnus-gethash (car groups)
3119 gnus-description-hashtb)))
3120 (insert " " des "\n")))
3121 (setq groups (cdr groups)))
3122 (goto-char (point-min))))
3123 (pop-to-buffer obuf)))
3125 (defun gnus-group-description-apropos (regexp)
3126 "List all newsgroups that have names or descriptions that match a regexp."
3127 (interactive "sGnus description apropos (regexp): ")
3128 (when (not (or gnus-description-hashtb
3129 (gnus-read-all-descriptions-files)))
3130 (error "Couldn't request descriptions file"))
3131 (gnus-group-apropos regexp t))
3133 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3134 (defun gnus-group-list-matching (level regexp &optional all lowest)
3135 "List all groups with unread articles that match REGEXP.
3136 If the prefix LEVEL is non-nil, it should be a number that says which
3137 level to cut off listing groups.
3138 If ALL, also list groups with no unread articles.
3139 If LOWEST, don't list groups with level lower than LOWEST.
3141 This command may read the active file."
3142 (interactive "P\nsList newsgroups matching: ")
3143 ;; First make sure active file has been read.
3145 (> (prefix-numeric-value level) gnus-level-killed))
3146 (gnus-get-killed-groups))
3147 (gnus-group-prepare-flat
3148 (or level gnus-level-subscribed) all (or lowest 1) regexp)
3149 (goto-char (point-min))
3150 (gnus-group-position-point))
3152 (defun gnus-group-list-all-matching (level regexp &optional lowest)
3153 "List all groups that match REGEXP.
3154 If the prefix LEVEL is non-nil, it should be a number that says which
3155 level to cut off listing groups.
3156 If LOWEST, don't list groups with level lower than LOWEST."
3157 (interactive "P\nsList newsgroups matching: ")
3158 (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
3160 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
3161 (defun gnus-group-save-newsrc (&optional force)
3162 "Save the Gnus startup files.
3163 If FORCE, force saving whether it is necessary or not."
3165 (gnus-save-newsrc-file force))
3167 (defun gnus-group-restart (&optional arg)
3168 "Force Gnus to read the .newsrc file."
3170 (when (gnus-yes-or-no-p
3171 (format "Are you sure you want to restart Gnus? "))
3172 (gnus-save-newsrc-file)
3173 (gnus-setup-news 'force)
3174 (gnus-group-list-groups arg)))
3176 (defun gnus-group-read-init-file ()
3177 "Read the Gnus elisp init file."
3179 (gnus-read-init-file))
3181 (defun gnus-group-check-bogus-groups (&optional silent)
3182 "Check bogus newsgroups.
3183 If given a prefix, don't ask for confirmation before removing a bogus
3186 (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
3187 (gnus-group-list-groups))
3189 (defun gnus-group-edit-global-kill (&optional article group)
3190 "Edit the global kill file.
3191 If GROUP, edit that local kill file instead."
3193 (setq gnus-current-kill-article article)
3194 (gnus-kill-file-edit-file group)
3197 (substitute-command-keys
3198 (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
3199 (if group "local" "global")))))
3201 (defun gnus-group-edit-local-kill (article group)
3202 "Edit a local kill file."
3203 (interactive (list nil (gnus-group-group-name)))
3204 (gnus-group-edit-global-kill article group))
3206 (defun gnus-group-force-update ()
3207 "Update `.newsrc' file."
3209 (gnus-save-newsrc-file))
3211 (defun gnus-group-suspend ()
3212 "Suspend the current Gnus session.
3213 In fact, cleanup buffers except for group mode buffer.
3214 The hook gnus-suspend-gnus-hook is called before actually suspending."
3216 (run-hooks 'gnus-suspend-gnus-hook)
3217 ;; Kill Gnus buffers except for group mode buffer.
3218 (let* ((group-buf (get-buffer gnus-group-buffer))
3219 ;; Do this on a separate list in case the user does a ^G before we finish
3221 (delete group-buf (delete gnus-dribble-buffer
3222 (append gnus-buffer-list nil)))))
3223 (while gnus-buffer-list
3224 (gnus-kill-buffer (pop gnus-buffer-list)))
3225 (gnus-kill-gnus-frames)
3227 (setq gnus-buffer-list (list group-buf))
3228 (bury-buffer group-buf)
3229 (delete-windows-on group-buf t))))
3231 (defun gnus-group-clear-dribble ()
3232 "Clear all information from the dribble buffer."
3234 (gnus-dribble-clear)
3235 (gnus-message 7 "Cleared dribble buffer"))
3237 (defun gnus-group-exit ()
3238 "Quit reading news after updating .newsrc.eld and .newsrc.
3239 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3242 (or noninteractive ;For gnus-batch-kill
3243 (not gnus-interactive-exit) ;Without confirmation
3245 (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
3246 (run-hooks 'gnus-exit-gnus-hook)
3247 ;; Offer to save data from non-quitted summary buffers.
3248 (gnus-offer-save-summaries)
3249 ;; Save the newsrc file(s).
3250 (gnus-save-newsrc-file)
3252 (gnus-close-backends)
3253 ;; Reset everything.
3255 ;; Allow the user to do things after cleaning up.
3256 (run-hooks 'gnus-after-exiting-gnus-hook)))
3258 (defun gnus-group-quit ()
3259 "Quit reading news without updating .newsrc.eld or .newsrc.
3260 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3262 (when (or noninteractive ;For gnus-batch-kill
3263 (zerop (buffer-size))
3264 (not (gnus-server-opened gnus-select-method))
3266 (not gnus-current-startup-file)
3268 (format "Quit reading news without saving %s? "
3269 (file-name-nondirectory gnus-current-startup-file))))
3270 (run-hooks 'gnus-exit-gnus-hook)
3271 (gnus-configure-windows 'group t)
3273 (gnus-close-backends)
3275 (gnus-kill-buffer gnus-group-buffer)
3276 ;; Allow the user to do things after cleaning up.
3277 (run-hooks 'gnus-after-exiting-gnus-hook)))
3279 (defun gnus-group-describe-briefly ()
3280 "Give a one line description of the group mode commands."
3282 (gnus-message 7 (substitute-command-keys "\\<gnus-group-mode-map>\\[gnus-group-read-group]:Select \\[gnus-group-next-unread-group]:Forward \\[gnus-group-prev-unread-group]:Backward \\[gnus-group-exit]:Exit \\[gnus-info-find-node]:Run Info \\[gnus-group-describe-briefly]:This help")))
3284 (defun gnus-group-browse-foreign-server (method)
3285 "Browse a foreign news server.
3286 If called interactively, this function will ask for a select method
3287 (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
3288 If not, METHOD should be a list where the first element is the method
3289 and the second element is the address."
3291 (list (let ((how (completing-read
3293 (append gnus-valid-select-methods gnus-server-alist)
3294 nil t (cons "nntp" 0) 'gnus-method-history)))
3295 ;; We either got a backend name or a virtual server name.
3296 ;; If the first, we also need an address.
3297 (if (assoc how gnus-valid-select-methods)
3299 ;; Suggested by mapjph@bath.ac.uk.
3302 (mapcar (lambda (server) (list server))
3303 gnus-secondary-servers)))
3304 ;; We got a server name, so we find the method.
3305 (gnus-server-to-method how)))))
3306 (gnus-browse-foreign-server method))
3308 (defun gnus-group-set-info (info &optional method-only-group part)
3309 (let* ((entry (gnus-gethash
3310 (or method-only-group (gnus-info-group info))
3311 gnus-newsrc-hashtb))
3313 (info (if method-only-group (nth 2 entry) info))
3315 (when method-only-group
3317 (error "Trying to change non-existent group %s" method-only-group))
3318 ;; We have received parts of the actual group info - either the
3319 ;; select method or the group parameters. We first check
3320 ;; whether we have to extend the info, and if so, do that.
3321 (let ((len (length info))
3322 (total (if (eq part 'method) 5 6)))
3324 (setcdr (nthcdr (1- len) info)
3325 (make-list (- total len) nil)))
3326 ;; Then we enter the new info.
3327 (setcar (nthcdr (1- total) info) part-info)))
3329 ;; This is a new group, so we just create it.
3331 (set-buffer gnus-group-buffer)
3332 (setq method (gnus-info-method info))
3333 (when (gnus-server-equal method "native")
3336 (set-buffer gnus-group-buffer)
3338 ;; It's a foreign group...
3339 (gnus-group-make-group
3340 (gnus-group-real-name (gnus-info-group info))
3341 (if (stringp method) method
3342 (prin1-to-string (car method)))
3344 (nth 1 (gnus-info-method info))))
3345 ;; It's a native group.
3346 (gnus-group-make-group (gnus-info-group info))))
3347 (gnus-message 6 "Note: New group created")
3349 (gnus-gethash (gnus-group-prefixed-name
3350 (gnus-group-real-name (gnus-info-group info))
3351 (or (gnus-info-method info) gnus-select-method))
3352 gnus-newsrc-hashtb))))
3353 ;; Whether it was a new group or not, we now have the entry, so we
3354 ;; can do the update.
3357 (setcar (nthcdr 2 entry) info)
3358 (when (and (not (eq (car entry) t))
3359 (gnus-active (gnus-info-group info)))
3360 (setcar entry (length (gnus-list-of-unread-articles (car info))))))
3361 (error "No such group: %s" (gnus-info-group info)))))
3363 (defun gnus-group-set-method-info (group select-method)
3364 (gnus-group-set-info select-method group 'method))
3366 (defun gnus-group-set-params-info (group params)
3367 (gnus-group-set-info params group 'params))
3369 (defun gnus-add-marked-articles (group type articles &optional info force)
3370 ;; Add ARTICLES of TYPE to the info of GROUP.
3371 ;; If INFO is non-nil, use that info. If FORCE is non-nil, don't
3372 ;; add, but replace marked articles of TYPE with ARTICLES.
3373 (let ((info (or info (gnus-get-info group)))
3374 (uncompressed '(score bookmark killed))
3377 (and (not (setq marked (nthcdr 3 info)))
3379 (setcdr (nthcdr 2 info)
3380 (list (list (cons type (gnus-compress-sequence
3382 (and (not (setq m (assq type (car marked))))
3385 (cons (cons type (gnus-compress-sequence articles t) )
3389 (setcar (nthcdr 3 info)
3390 (delq (assq type (car marked)) (car marked)))
3391 (setcdr m (gnus-compress-sequence articles t)))
3392 (setcdr m (gnus-compress-sequence
3393 (sort (nconc (gnus-uncompress-range (cdr m))
3394 (copy-sequence articles)) '<) t))))))
3397 ;;; Group timestamps
3400 (defun gnus-group-set-timestamp ()
3401 "Change the timestamp of the current group to the current time.
3402 This function can be used in hooks like `gnus-select-group-hook'
3403 or `gnus-group-catchup-group-hook'."
3404 (when gnus-newsgroup-name
3405 (let ((time (current-time)))
3406 (setcdr (cdr time) nil)
3407 (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
3409 (defsubst gnus-group-timestamp (group)
3410 "Return the timestamp for GROUP."
3411 (gnus-group-get-parameter group 'timestamp))
3413 (defun gnus-group-timestamp-delta (group)
3414 "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
3415 (let* ((time (or (gnus-group-timestamp group)
3417 (delta (gnus-time-minus (current-time) time)))
3418 (+ (* (nth 0 delta) 65536.0)
3421 (defun gnus-group-timestamp-string (group)
3422 "Return a string of the timestamp for GROUP."
3423 (let ((time (gnus-group-timestamp group)))
3426 (gnus-time-iso8601 time))))
3428 (provide 'gnus-group)
3430 ;;; gnus-group.el ends here