1 ;;; gnus-group.el --- group mode commands for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval-when-compile (require 'cl))
41 (defcustom gnus-group-archive-directory
42 "*ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
43 "*The address of the (ding) archives."
44 :group 'gnus-group-foreign
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."
50 :group 'gnus-group-foreign
53 (defcustom gnus-no-groups-message "No gnus is bad news"
54 "*Message displayed by Gnus when no groups are available."
58 (defcustom gnus-keep-same-level nil
59 "*Non-nil means that the next newsgroup after the current will be on the same level.
60 When you type, for instance, `n' after reading the last article in the
61 current newsgroup, you will go to the next newsgroup. If this variable
62 is nil, the next newsgroup will be the next from the group
64 If this variable is non-nil, Gnus will either put you in the
65 next newsgroup with the same level, or, if no such newsgroup is
66 available, the next newsgroup with the lowest possible level higher
67 than the current level.
68 If this variable is `best', Gnus will make the next newsgroup the one
70 :group 'gnus-group-levels
71 :type '(choice (const nil)
73 (sexp :tag "other" t)))
75 (defcustom gnus-group-goto-unread t
76 "*If non-nil, movement commands will go to the next unread and subscribed group."
77 :link '(custom-manual "(gnus)Group Maneuvering")
78 :group 'gnus-group-various
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."
83 :link '(custom-manual "(gnus)Scanning New Messages")
84 :group 'gnus-group-various
87 (defcustom gnus-permanently-visible-groups nil
88 "*Regexp to match groups that should always be listed in the group buffer.
89 This means that they will still be listed even when there are no
90 unread articles in the groups.
92 If nil, no groups are permanently visible."
93 :group 'gnus-group-listing
94 :type '(choice regexp (const nil)))
96 (defcustom gnus-list-groups-with-ticked-articles t
97 "*If non-nil, list groups that have only ticked articles.
98 If nil, only list groups that have unread articles."
99 :group 'gnus-group-listing
102 (defcustom gnus-group-default-list-level gnus-level-subscribed
103 "*Default listing level.
104 Ignored if `gnus-group-use-permanent-levels' is non-nil."
105 :group 'gnus-group-listing
108 (defcustom gnus-group-list-inactive-groups t
109 "*If non-nil, inactive groups will be listed."
110 :group 'gnus-group-listing
111 :group 'gnus-group-levels
114 (defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
115 "*Function used for sorting the group buffer.
116 This function will be called with group info entries as the arguments
117 for the groups to be sorted. Pre-made functions include
118 `gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
119 `gnus-group-sort-by-unread', `gnus-group-sort-by-level',
120 `gnus-group-sort-by-score', `gnus-group-sort-by-method', and
121 `gnus-group-sort-by-rank'.
123 This variable can also be a list of sorting functions. In that case,
124 the most significant sort function should be the last function in the
126 :group 'gnus-group-listing
127 :link '(custom-manual "(gnus)Sorting Groups")
128 :type '(radio (function-item gnus-group-sort-by-alphabet)
129 (function-item gnus-group-sort-by-real-name)
130 (function-item gnus-group-sort-by-unread)
131 (function-item gnus-group-sort-by-level)
132 (function-item gnus-group-sort-by-score)
133 (function-item gnus-group-sort-by-method)
134 (function-item gnus-group-sort-by-rank)
135 (function :tag "other" nil)))
137 (defcustom gnus-group-line-format "%M\%S\%p\%P\%5y: %(%g%)%l\n"
138 "*Format of group lines.
139 It works along the same lines as a normal formatting string,
140 with some simple extensions.
142 %M Only marked articles (character, \"*\" or \" \")
143 %S Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
144 %L Level of subscribedness (integer)
145 %N Number of unread articles (integer)
146 %I Number of dormant articles (integer)
147 %i Number of ticked and dormant (integer)
148 %T Number of ticked articles (integer)
149 %R Number of read articles (integer)
150 %t Estimated total number of articles (integer)
151 %y Number of unread, unticked articles (integer)
152 %G Group name (string)
153 %g Qualified group name (string)
154 %D Group description (string)
155 %s Select method (string)
156 %o Moderated group (char, \"m\")
157 %p Process mark (char)
158 %O Moderated group (string, \"(m)\" or \"\")
159 %P Topic indentation (string)
160 %m Whether there is new(ish) mail in the group (char, \"%\")
161 %l Whether there are GroupLens predictions for this group (string)
162 %n Select from where (string)
163 %z A string that look like `<%s:%n>' if a foreign select method is used
164 %d The date the group was last entered.
165 %E Icon as defined by `gnus-group-icon-list'.
166 %u User defined specifier. The next character in the format string should
167 be a letter. Gnus will call the function gnus-user-format-function-X,
168 where X is the letter following %u. The function will be passed the
169 current header as argument. The function should return a string, which
170 will be inserted into the buffer just like information from any other
173 Text between %( and %) will be highlighted with `gnus-mouse-face' when
174 the mouse point move inside the area. There can only be one such area.
176 Note that this format specification is not always respected. For
177 reasons of efficiency, when listing killed groups, this specification
178 is ignored altogether. If the spec is changed considerably, your
179 output may end up looking strange when listing both alive and killed
182 If you use %o or %O, reading the active file will be slower and quite
183 a bit of extra memory will be used. %D will also worsen performance.
184 Also note that if you change the format specification to include any
185 of these specs, you must probably re-start Gnus to see them go into
187 :group 'gnus-group-visual
190 (defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
191 "*The format specification for the group mode line.
192 It works along the same lines as a normal formatting string,
193 with some simple extensions:
195 %S The native news server.
196 %M The native select method.
197 %: \":\" if %S isn't \"\"."
198 :group 'gnus-group-visual
201 (defcustom gnus-group-mode-hook nil
202 "Hook for Gnus group mode."
203 :group 'gnus-group-various
204 :options '(gnus-topic-mode)
207 (defcustom gnus-group-menu-hook nil
208 "Hook run after the creation of the group mode menu."
209 :group 'gnus-group-various
212 (defcustom gnus-group-catchup-group-hook nil
213 "Hook run when catching up a group from the group buffer."
214 :group 'gnus-group-various
215 :link '(custom-manual "(gnus)Group Data")
218 (defcustom gnus-group-update-group-hook nil
219 "Hook called when updating group lines."
220 :group 'gnus-group-visual
223 (defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
224 "*A function that is called to generate the group buffer.
225 The function is called with three arguments: The first is a number;
226 all group with a level less or equal to that number should be listed,
227 if the second is non-nil, empty groups should also be displayed. If
228 the third is non-nil, it is a number. No groups with a level lower
229 than this number should be displayed.
231 The only current function implemented is `gnus-group-prepare-flat'."
232 :group 'gnus-group-listing
235 (defcustom gnus-group-prepare-hook nil
236 "Hook called after the group buffer has been generated.
237 If you want to modify the group buffer, you can use this hook."
238 :group 'gnus-group-listing
241 (defcustom gnus-suspend-gnus-hook nil
242 "Hook called when suspending (not exiting) Gnus."
246 (defcustom gnus-exit-gnus-hook nil
247 "Hook called when exiting Gnus."
251 (defcustom gnus-after-exiting-gnus-hook nil
252 "Hook called after exiting Gnus."
256 (defcustom gnus-group-update-hook '(gnus-group-highlight-line)
257 "Hook called when a group line is changed.
258 The hook will not be called if `gnus-visual' is nil.
260 The default function `gnus-group-highlight-line' will
261 highlight the line according to the `gnus-group-highlight'
263 :group 'gnus-group-visual
266 (defcustom gnus-useful-groups
267 '(("(ding) mailing list mirrored at sunsite.auc.dk"
269 (nntp "sunsite.auc.dk"
270 (nntp-address "sunsite.auc.dk")))
273 (nndir "/ftp@ftp.ifi.uio.no:/pub/emacs/gnus/gnus-bug/"))
277 (nndoc-article-type mbox)
278 (eval `(nndoc-address
279 ,(let ((file (nnheader-find-etc-directory
282 (error "Couldn't find doc group"))
284 "*Alist of useful group-server pairs."
285 :group 'gnus-group-listing
286 :type '(repeat (list (string :tag "Description")
288 (sexp :tag "Method"))))
290 (defcustom gnus-group-highlight
292 ((and (= unread 0) (not mailp) (eq level 1)) .
293 gnus-group-news-1-empty-face)
294 ((and (not mailp) (eq level 1)) .
295 gnus-group-news-1-face)
296 ((and (= unread 0) (not mailp) (eq level 2)) .
297 gnus-group-news-2-empty-face)
298 ((and (not mailp) (eq level 2)) .
299 gnus-group-news-2-face)
300 ((and (= unread 0) (not mailp) (eq level 3)) .
301 gnus-group-news-3-empty-face)
302 ((and (not mailp) (eq level 3)) .
303 gnus-group-news-3-face)
304 ((and (= unread 0) (not mailp) (eq level 4)) .
305 gnus-group-news-4-empty-face)
306 ((and (not mailp) (eq level 4)) .
307 gnus-group-news-4-face)
308 ((and (= unread 0) (not mailp) (eq level 5)) .
309 gnus-group-news-5-empty-face)
310 ((and (not mailp) (eq level 5)) .
311 gnus-group-news-5-face)
312 ((and (= unread 0) (not mailp) (eq level 6)) .
313 gnus-group-news-6-empty-face)
314 ((and (not mailp) (eq level 6)) .
315 gnus-group-news-6-face)
316 ((and (= unread 0) (not mailp)) .
317 gnus-group-news-low-empty-face)
319 gnus-group-news-low-face)
321 ((and (= unread 0) (eq level 1)) .
322 gnus-group-mail-1-empty-face)
324 gnus-group-mail-1-face)
325 ((and (= unread 0) (eq level 2)) .
326 gnus-group-mail-2-empty-face)
328 gnus-group-mail-2-face)
329 ((and (= unread 0) (eq level 3)) .
330 gnus-group-mail-3-empty-face)
332 gnus-group-mail-3-face)
334 gnus-group-mail-low-empty-face)
336 gnus-group-mail-low-face))
337 "*Controls the highlighting of group buffer lines.
339 Below is a list of `Form'/`Face' pairs. When deciding how a a
340 particular group line should be displayed, each form is
341 evaluated. The content of the face field after the first true form is
342 used. You can change how those group lines are displayed by
343 editing the face field.
345 It is also possible to change and add form fields, but currently that
346 requires an understanding of Lisp expressions. Hopefully this will
347 change in a future release. For now, you can use the following
348 variables in the Lisp expression:
350 group: The name of the group.
351 unread: The number of unread articles in the group.
352 method: The select method used.
353 mailp: Whether it's a mail group or not.
354 level: The level of the group.
355 score: The score of the group.
356 ticked: The number of ticked articles."
357 :group 'gnus-group-visual
358 :type '(repeat (cons (sexp :tag "Form") face)))
360 (defcustom gnus-new-mail-mark ?%
361 "Mark used for groups with new mail."
362 :group 'gnus-group-visual
365 (defgroup gnus-group-icons nil
366 "Add Icons to your group buffer. "
367 :group 'gnus-group-visual)
369 (defcustom gnus-group-icon-list
371 "*Controls the insertion of icons into group buffer lines.
373 Below is a list of `Form'/`File' pairs. When deciding how a
374 particular group line should be displayed, each form is evaluated.
375 The icon from the file field after the first true form is used. You
376 can change how those group lines are displayed by editing the file
377 field. The File will either be found in the
378 `gnus-group-glyph-directory' or by designating absolute path to the
381 It is also possible to change and add form fields, but currently that
382 requires an understanding of Lisp expressions. Hopefully this will
383 change in a future release. For now, you can use the following
384 variables in the Lisp expression:
386 group: The name of the group.
387 unread: The number of unread articles in the group.
388 method: The select method used.
389 mailp: Whether it's a mail group or not.
390 newsp: Whether it's a news group or not
391 level: The level of the group.
392 score: The score of the group.
393 ticked: The number of ticked articles."
394 :group 'gnus-group-icons
395 :type '(repeat (cons (sexp :tag "Form") file)))
397 (defcustom gnus-group-name-charset-method-alist nil
398 "*Alist of method and the charset for group names.
401 (((nntp \"news.com.cn\") . cn-gb-2312))
404 :type '(repeat (cons (sexp :tag "Method") (symbol :tag "Charset"))))
406 (defcustom gnus-group-name-charset-group-alist nil
407 "*Alist of group regexp and the charset for group names.
410 ((\"\\.com\\.cn:\" . cn-gb-2312))
413 :type '(repeat (cons (regexp :tag "Group") (symbol :tag "Charset"))))
415 ;;; Internal variables
417 (defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
418 "Function for sorting the group buffer.")
420 (defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
421 "Function for sorting the selected groups in the group buffer.")
423 (defvar gnus-group-indentation-function nil)
424 (defvar gnus-goto-missing-group-function nil)
425 (defvar gnus-group-update-group-function nil)
426 (defvar gnus-group-goto-next-group-function nil
427 "Function to override finding the next group after listing groups.")
429 (defvar gnus-group-edit-buffer nil)
431 (defvar gnus-group-line-format-alist
432 `((?M gnus-tmp-marked-mark ?c)
433 (?S gnus-tmp-subscribed ?c)
434 (?L gnus-tmp-level ?d)
435 (?N (cond ((eq number t) "*" )
439 (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
440 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
442 (?R gnus-tmp-number-of-read ?s)
443 (?t gnus-tmp-number-total ?d)
444 (?y gnus-tmp-number-of-unread ?s)
445 (?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
446 (?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
447 (?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
448 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
449 (?g gnus-tmp-group ?s)
450 (?G gnus-tmp-qualified-group ?s)
451 (?c (gnus-short-group-name gnus-tmp-group) ?s)
452 (?D gnus-tmp-newsgroup-description ?s)
453 (?o gnus-tmp-moderated ?c)
454 (?O gnus-tmp-moderated-string ?s)
455 (?p gnus-tmp-process-marked ?c)
456 (?s gnus-tmp-news-server ?s)
457 (?n gnus-tmp-news-method ?s)
458 (?P gnus-group-indentation ?s)
459 (?E gnus-tmp-group-icon ?s)
460 (?l gnus-tmp-grouplens ?s)
461 (?z gnus-tmp-news-method-string ?s)
462 (?m (gnus-group-new-mail gnus-tmp-group) ?c)
463 (?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
464 (?u gnus-tmp-user-defined ?s)))
466 (defvar gnus-group-mode-line-format-alist
467 `((?S gnus-tmp-news-server ?s)
468 (?M gnus-tmp-news-method ?s)
469 (?u gnus-tmp-user-defined ?s)
470 (?: gnus-tmp-colon ?s)))
472 (defvar gnus-topic-topology nil
473 "The complete topic hierarchy.")
475 (defvar gnus-topic-alist nil
476 "The complete topic-group alist.")
478 (defvar gnus-group-marked nil)
480 (defvar gnus-group-list-mode nil)
483 (defvar gnus-group-icon-cache nil)
489 (put 'gnus-group-mode 'mode-class 'special)
492 (gnus-define-keys gnus-group-mode-map
493 " " gnus-group-read-group
494 "=" gnus-group-select-group
495 "\r" gnus-group-select-group
496 "\M-\r" gnus-group-quick-select-group
497 "\M- " gnus-group-visible-select-group
498 [(meta control return)] gnus-group-select-group-ephemerally
499 "j" gnus-group-jump-to-group
500 "n" gnus-group-next-unread-group
501 "p" gnus-group-prev-unread-group
502 "\177" gnus-group-prev-unread-group
503 [delete] gnus-group-prev-unread-group
504 [backspace] gnus-group-prev-unread-group
505 "N" gnus-group-next-group
506 "P" gnus-group-prev-group
507 "\M-n" gnus-group-next-unread-group-same-level
508 "\M-p" gnus-group-prev-unread-group-same-level
509 "," gnus-group-best-unread-group
510 "." gnus-group-first-unread-group
511 "u" gnus-group-unsubscribe-current-group
512 "U" gnus-group-unsubscribe-group
513 "c" gnus-group-catchup-current
514 "C" gnus-group-catchup-current-all
515 "\M-c" gnus-group-clear-data
516 "l" gnus-group-list-groups
517 "L" gnus-group-list-all-groups
519 "g" gnus-group-get-new-news
520 "\M-g" gnus-group-get-new-news-this-group
521 "R" gnus-group-restart
522 "r" gnus-group-read-init-file
523 "B" gnus-group-browse-foreign-server
524 "b" gnus-group-check-bogus-groups
525 "F" gnus-group-find-new-groups
526 "\C-c\C-d" gnus-group-describe-group
527 "\M-d" gnus-group-describe-all-groups
528 "\C-c\C-a" gnus-group-apropos
529 "\C-c\M-\C-a" gnus-group-description-apropos
530 "a" gnus-group-post-news
531 "\ek" gnus-group-edit-local-kill
532 "\eK" gnus-group-edit-global-kill
533 "\C-k" gnus-group-kill-group
534 "\C-y" gnus-group-yank-group
535 "\C-w" gnus-group-kill-region
536 "\C-x\C-t" gnus-group-transpose-groups
537 "\C-c\C-l" gnus-group-list-killed
538 "\C-c\C-x" gnus-group-expire-articles
539 "\C-c\M-\C-x" gnus-group-expire-all-groups
541 "s" gnus-group-save-newsrc
542 "z" gnus-group-suspend
545 "?" gnus-group-describe-briefly
546 "\C-c\C-i" gnus-info-find-node
547 "\M-e" gnus-group-edit-group-method
548 "^" gnus-group-enter-server-mode
549 gnus-mouse-2 gnus-mouse-pick-group
550 "<" beginning-of-buffer
553 "\C-c\C-s" gnus-group-sort-groups
555 "\C-c\M-g" gnus-activate-all-groups
556 "\M-&" gnus-group-universal-argument
557 "#" gnus-group-mark-group
558 "\M-#" gnus-group-unmark-group)
560 (gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
561 "m" gnus-group-mark-group
562 "u" gnus-group-unmark-group
563 "w" gnus-group-mark-region
564 "b" gnus-group-mark-buffer
565 "r" gnus-group-mark-regexp
566 "U" gnus-group-unmark-all-groups)
568 (gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
569 "d" gnus-group-make-directory-group
570 "h" gnus-group-make-help-group
571 "u" gnus-group-make-useful-group
572 "a" gnus-group-make-archive-group
573 "k" gnus-group-make-kiboze-group
574 "l" gnus-group-nnimap-edit-acl
575 "m" gnus-group-make-group
576 "E" gnus-group-edit-group
577 "e" gnus-group-edit-group-method
578 "p" gnus-group-edit-group-parameters
579 "v" gnus-group-add-to-virtual
580 "V" gnus-group-make-empty-virtual
581 "D" gnus-group-enter-directory
582 "f" gnus-group-make-doc-group
583 "w" gnus-group-make-web-group
584 "r" gnus-group-rename-group
585 "c" gnus-group-customize
586 "x" gnus-group-nnimap-expunge
587 "\177" gnus-group-delete-group
588 [delete] gnus-group-delete-group)
590 (gnus-define-keys (gnus-group-soup-map "s" gnus-group-group-map)
591 "b" gnus-group-brew-soup
592 "w" gnus-soup-save-areas
593 "s" gnus-soup-send-replies
594 "p" gnus-soup-pack-packet
595 "r" nnsoup-pack-replies)
597 (gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
598 "s" gnus-group-sort-groups
599 "a" gnus-group-sort-groups-by-alphabet
600 "u" gnus-group-sort-groups-by-unread
601 "l" gnus-group-sort-groups-by-level
602 "v" gnus-group-sort-groups-by-score
603 "r" gnus-group-sort-groups-by-rank
604 "m" gnus-group-sort-groups-by-method)
606 (gnus-define-keys (gnus-group-sort-selected-map "P" gnus-group-group-map)
607 "s" gnus-group-sort-selected-groups
608 "a" gnus-group-sort-selected-groups-by-alphabet
609 "u" gnus-group-sort-selected-groups-by-unread
610 "l" gnus-group-sort-selected-groups-by-level
611 "v" gnus-group-sort-selected-groups-by-score
612 "r" gnus-group-sort-selected-groups-by-rank
613 "m" gnus-group-sort-selected-groups-by-method)
615 (gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
616 "k" gnus-group-list-killed
617 "z" gnus-group-list-zombies
618 "s" gnus-group-list-groups
619 "u" gnus-group-list-all-groups
620 "A" gnus-group-list-active
621 "a" gnus-group-apropos
622 "d" gnus-group-description-apropos
623 "m" gnus-group-list-matching
624 "M" gnus-group-list-all-matching
625 "l" gnus-group-list-level
626 "c" gnus-group-list-cached
627 "?" gnus-group-list-dormant)
629 (gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
630 "f" gnus-score-flush-cache)
632 (gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
633 "d" gnus-group-describe-group
634 "f" gnus-group-fetch-faq
637 (gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
638 "l" gnus-group-set-current-level
639 "t" gnus-group-unsubscribe-current-group
640 "s" gnus-group-unsubscribe-group
641 "k" gnus-group-kill-group
642 "y" gnus-group-yank-group
643 "w" gnus-group-kill-region
644 "\C-k" gnus-group-kill-level
645 "z" gnus-group-kill-all-zombies))
647 (defun gnus-group-make-menu-bar ()
648 (gnus-turn-off-edit-menu 'group)
649 (unless (boundp 'gnus-group-reading-menu)
652 gnus-group-reading-menu gnus-group-mode-map ""
654 ["Read" gnus-group-read-group (gnus-group-group-name)]
655 ["Select" gnus-group-select-group (gnus-group-group-name)]
656 ["See old articles" (gnus-group-select-group 'all)
657 :keys "C-u SPC" :active (gnus-group-group-name)]
658 ["Catch up" gnus-group-catchup-current (gnus-group-group-name)]
659 ["Catch up all articles" gnus-group-catchup-current-all
660 (gnus-group-group-name)]
661 ["Check for new articles" gnus-group-get-new-news-this-group
662 (gnus-group-group-name)]
663 ["Toggle subscription" gnus-group-unsubscribe-current-group
664 (gnus-group-group-name)]
665 ["Kill" gnus-group-kill-group (gnus-group-group-name)]
666 ["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
667 ["Describe" gnus-group-describe-group (gnus-group-group-name)]
668 ["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
669 ;; Actually one should check, if any of the marked groups gives t for
670 ;; (gnus-check-backend-function 'request-expire-articles ...)
671 ["Expire articles" gnus-group-expire-articles
672 (or (and (gnus-group-group-name)
673 (gnus-check-backend-function
674 'request-expire-articles
675 (gnus-group-group-name))) gnus-group-marked)]
676 ["Set group level" gnus-group-set-current-level
677 (gnus-group-group-name)]
678 ["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
679 ["Customize" gnus-group-customize (gnus-group-group-name)]
681 ["Parameters" gnus-group-edit-group-parameters
682 (gnus-group-group-name)]
683 ["Select method" gnus-group-edit-group-method
684 (gnus-group-group-name)]
685 ["Info" gnus-group-edit-group (gnus-group-group-name)]
686 ["Local kill file" gnus-group-edit-local-kill (gnus-group-group-name)]
687 ["Global kill file" gnus-group-edit-global-kill t])))
690 gnus-group-group-menu gnus-group-mode-map ""
693 ["List unread subscribed groups" gnus-group-list-groups t]
694 ["List (un)subscribed groups" gnus-group-list-all-groups t]
695 ["List killed groups" gnus-group-list-killed gnus-killed-list]
696 ["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
697 ["List level..." gnus-group-list-level t]
698 ["Describe all groups" gnus-group-describe-all-groups t]
699 ["Group apropos..." gnus-group-apropos t]
700 ["Group and description apropos..." gnus-group-description-apropos t]
701 ["List groups matching..." gnus-group-list-matching t]
702 ["List all groups matching..." gnus-group-list-all-matching t]
703 ["List active file" gnus-group-list-active t]
704 ["List groups with cached" gnus-group-list-cached t]
705 ["List groups with dormant" gnus-group-list-dormant t])
707 ["Default sort" gnus-group-sort-groups t]
708 ["Sort by method" gnus-group-sort-groups-by-method t]
709 ["Sort by rank" gnus-group-sort-groups-by-rank t]
710 ["Sort by score" gnus-group-sort-groups-by-score t]
711 ["Sort by level" gnus-group-sort-groups-by-level t]
712 ["Sort by unread" gnus-group-sort-groups-by-unread t]
713 ["Sort by name" gnus-group-sort-groups-by-alphabet t])
714 ("Sort process/prefixed"
715 ["Default sort" gnus-group-sort-selected-groups
716 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
717 ["Sort by method" gnus-group-sort-selected-groups-by-method
718 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
719 ["Sort by rank" gnus-group-sort-selected-groups-by-rank
720 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
721 ["Sort by score" gnus-group-sort-selected-groups-by-score
722 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
723 ["Sort by level" gnus-group-sort-selected-groups-by-level
724 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
725 ["Sort by unread" gnus-group-sort-selected-groups-by-unread
726 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
727 ["Sort by name" gnus-group-sort-selected-groups-by-alphabet
728 (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))])
730 ["Mark group" gnus-group-mark-group
731 (and (gnus-group-group-name)
732 (not (memq (gnus-group-group-name) gnus-group-marked)))]
733 ["Unmark group" gnus-group-unmark-group
734 (and (gnus-group-group-name)
735 (memq (gnus-group-group-name) gnus-group-marked))]
736 ["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
737 ["Mark regexp..." gnus-group-mark-regexp t]
738 ["Mark region" gnus-group-mark-region t]
739 ["Mark buffer" gnus-group-mark-buffer t]
740 ["Execute command" gnus-group-universal-argument
741 (or gnus-group-marked (gnus-group-group-name))])
743 ["Subscribe to a group" gnus-group-unsubscribe-group t]
744 ["Kill all newsgroups in region" gnus-group-kill-region t]
745 ["Kill all zombie groups" gnus-group-kill-all-zombies
747 ["Kill all groups on level..." gnus-group-kill-level t])
749 ["Make a foreign group" gnus-group-make-group t]
750 ["Add a directory group" gnus-group-make-directory-group t]
751 ["Add the help group" gnus-group-make-help-group t]
752 ["Add the archive group" gnus-group-make-archive-group t]
753 ["Make a doc group" gnus-group-make-doc-group t]
754 ["Make a web group" gnus-group-make-web-group t]
755 ["Make a kiboze group" gnus-group-make-kiboze-group t]
756 ["Make a virtual group" gnus-group-make-empty-virtual t]
757 ["Add a group to a virtual" gnus-group-add-to-virtual t]
758 ["Rename group" gnus-group-rename-group
759 (gnus-check-backend-function
760 'request-rename-group (gnus-group-group-name))]
761 ["Delete group" gnus-group-delete-group
762 (gnus-check-backend-function
763 'request-delete-group (gnus-group-group-name))])
765 ["Next" gnus-group-next-group t]
766 ["Previous" gnus-group-prev-group t]
767 ["Next unread" gnus-group-next-unread-group t]
768 ["Previous unread" gnus-group-prev-unread-group t]
769 ["Next unread same level" gnus-group-next-unread-group-same-level t]
770 ["Previous unread same level"
771 gnus-group-prev-unread-group-same-level t]
772 ["Jump to group" gnus-group-jump-to-group t]
773 ["First unread group" gnus-group-first-unread-group t]
774 ["Best unread group" gnus-group-best-unread-group t])
775 ["Delete bogus groups" gnus-group-check-bogus-groups t]
776 ["Find new newsgroups" gnus-group-find-new-groups t]
777 ["Transpose" gnus-group-transpose-groups
778 (gnus-group-group-name)]
779 ["Read a directory as a group..." gnus-group-enter-directory t]))
782 gnus-group-misc-menu gnus-group-mode-map ""
785 ["Pack replies" nnsoup-pack-replies (fboundp 'nnsoup-request-group)]
786 ["Send replies" gnus-soup-send-replies
787 (fboundp 'gnus-soup-pack-packet)]
788 ["Pack packet" gnus-soup-pack-packet (fboundp 'gnus-soup-pack-packet)]
789 ["Save areas" gnus-soup-save-areas (fboundp 'gnus-soup-pack-packet)]
790 ["Brew SOUP" gnus-group-brew-soup (fboundp 'gnus-soup-pack-packet)])
791 ["Send a mail" gnus-group-mail t]
792 ["Post an article..." gnus-group-post-news t]
793 ["Check for new news" gnus-group-get-new-news t]
794 ["Activate all groups" gnus-activate-all-groups t]
795 ["Restart Gnus" gnus-group-restart t]
796 ["Read init file" gnus-group-read-init-file t]
797 ["Browse foreign server" gnus-group-browse-foreign-server t]
798 ["Enter server buffer" gnus-group-enter-server-mode t]
799 ["Expire all expirable articles" gnus-group-expire-all-groups t]
800 ["Generate any kiboze groups" nnkiboze-generate-groups t]
801 ["Gnus version" gnus-version t]
802 ["Save .newsrc files" gnus-group-save-newsrc t]
803 ["Suspend Gnus" gnus-group-suspend t]
804 ["Clear dribble buffer" gnus-group-clear-dribble t]
805 ["Read manual" gnus-info-find-node t]
806 ["Flush score cache" gnus-score-flush-cache t]
807 ["Toggle topics" gnus-topic-mode t]
808 ["Send a bug report" gnus-bug t]
809 ["Exit from Gnus" gnus-group-exit t]
810 ["Exit without saving" gnus-group-quit t]))
812 (gnus-run-hooks 'gnus-group-menu-hook)))
814 (defun gnus-group-mode ()
815 "Major mode for reading news.
817 All normal editing commands are switched off.
818 \\<gnus-group-mode-map>
819 The group buffer lists (some of) the groups available. For instance,
820 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
821 lists all zombie groups.
823 Groups that are displayed can be entered with `\\[gnus-group-read-group]'. To subscribe
824 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
826 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
828 The following commands are available:
830 \\{gnus-group-mode-map}"
832 (when (gnus-visual-p 'group-menu 'menu)
833 (gnus-group-make-menu-bar))
834 (kill-all-local-variables)
835 (gnus-simplify-mode-line)
836 (setq major-mode 'gnus-group-mode)
837 (setq mode-name "Group")
838 (gnus-group-set-mode-line)
839 (setq mode-line-process nil)
840 (use-local-map gnus-group-mode-map)
841 (buffer-disable-undo)
842 (setq truncate-lines t)
843 (setq buffer-read-only t)
844 (gnus-set-default-directory)
845 (gnus-update-format-specifications nil 'group 'group-mode)
846 (gnus-update-group-mark-positions)
851 (gnus-run-hooks 'gnus-group-mode-hook))
853 (defun gnus-update-group-mark-positions ()
855 (let ((gnus-process-mark ?\200)
856 (gnus-group-marked '("dummy.group"))
857 (gnus-active-hashtb (make-vector 10 0))
859 (gnus-set-active "dummy.group" '(0 . 0))
860 (gnus-set-work-buffer)
861 (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
862 (goto-char (point-min))
863 (setq gnus-group-mark-positions
864 (list (cons 'process (and (search-forward "\200" nil t)
867 (defun gnus-mouse-pick-group (e)
868 "Enter the group under the mouse pointer."
871 (gnus-group-read-group nil))
873 ;; Look at LEVEL and find out what the level is really supposed to be.
874 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
875 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
876 (defun gnus-group-default-level (&optional level number-or-nil)
878 (gnus-group-use-permanent-levels
879 (or (setq gnus-group-use-permanent-levels
880 (or level (if (numberp gnus-group-use-permanent-levels)
881 gnus-group-use-permanent-levels
882 (or gnus-group-default-list-level
883 gnus-level-subscribed))))
884 gnus-group-default-list-level gnus-level-subscribed))
888 (or level gnus-group-default-list-level gnus-level-subscribed))))
890 (defun gnus-group-setup-buffer ()
891 (set-buffer (gnus-get-buffer-create gnus-group-buffer))
892 (unless (eq major-mode 'gnus-group-mode)
895 (gnus-carpal-setup-buffer 'group))))
897 (defsubst gnus-group-name-charset (method group)
899 (setq method (gnus-find-method-for-group group)))
900 (let ((item (assoc method gnus-group-name-charset-method-alist))
901 (alist gnus-group-name-charset-group-alist)
905 (while (setq item (pop alist))
906 (if (string-match (car item) group)
911 (defsubst gnus-group-name-decode (string charset)
912 (if (and string charset (featurep 'mule))
913 (mm-decode-coding-string string charset)
916 (defun gnus-group-decoded-name (string)
917 (let ((charset (gnus-group-name-charset nil string)))
918 (gnus-group-name-decode string charset)))
920 (defun gnus-group-list-groups (&optional level unread lowest)
921 "List newsgroups with level LEVEL or lower that have unread articles.
922 Default is all subscribed groups.
923 If argument UNREAD is non-nil, groups with no unread articles are also
926 Also see the `gnus-group-use-permanent-levels' variable."
928 (list (if current-prefix-arg
929 (prefix-numeric-value current-prefix-arg)
931 (gnus-group-default-level nil t)
932 gnus-group-default-list-level
933 gnus-level-subscribed))))
935 (setq level (car gnus-group-list-mode)
936 unread (cdr gnus-group-list-mode)))
937 (setq level (gnus-group-default-level level))
938 (gnus-group-setup-buffer)
939 (gnus-update-format-specifications nil 'group 'group-mode)
940 (let ((case-fold-search nil)
941 (props (text-properties-at (gnus-point-at-bol)))
942 (empty (= (point-min) (point-max)))
943 (group (gnus-group-group-name))
945 (set-buffer gnus-group-buffer)
946 (setq number (funcall gnus-group-prepare-function level unread lowest))
947 (when (or (and (numberp number)
949 (zerop (buffer-size)))
950 ;; No groups in the buffer.
951 (gnus-message 5 gnus-no-groups-message))
952 ;; We have some groups displayed.
953 (goto-char (point-max))
954 (when (or (not gnus-group-goto-next-group-function)
955 (not (funcall gnus-group-goto-next-group-function
959 (goto-char (point-min)))
961 ;; Go to the first group with unread articles.
962 (gnus-group-search-forward t))
964 ;; Find the right group to put point on. If the current group
965 ;; has disappeared in the new listing, try to find the next
966 ;; one. If no next one can be found, just leave point at the
967 ;; first newsgroup in the buffer.
968 (when (not (gnus-goto-char
970 (point-min) (point-max)
971 'gnus-group (gnus-intern-safe
972 group gnus-active-hashtb))))
973 (let ((newsrc (cdddr (gnus-gethash group gnus-newsrc-hashtb))))
977 (point-min) (point-max) 'gnus-group
979 (caar newsrc) gnus-active-hashtb)))))
980 (setq newsrc (cdr newsrc)))
982 (goto-char (point-max))
983 (forward-line -1)))))))
984 ;; Adjust cursor point.
985 (gnus-group-position-point)))
987 (defun gnus-group-list-level (level &optional all)
988 "List groups on LEVEL.
989 If ALL (the prefix), also list groups that have no unread articles."
990 (interactive "nList groups on level: \nP")
991 (gnus-group-list-groups level all level))
993 (defun gnus-group-prepare-flat (level &optional all lowest regexp)
994 "List all newsgroups with unread articles of level LEVEL or lower.
995 If ALL is non-nil, list groups that have no unread articles.
996 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
997 If REGEXP, only list groups matching REGEXP."
998 (set-buffer gnus-group-buffer)
999 (let ((buffer-read-only nil)
1000 (newsrc (cdr gnus-newsrc-alist))
1001 (lowest (or lowest 1))
1002 info clevel unread group params)
1004 (when (< lowest gnus-level-zombie)
1005 ;; List living groups.
1007 (setq info (car newsrc)
1008 group (gnus-info-group info)
1009 params (gnus-info-params info)
1011 unread (car (gnus-gethash group gnus-newsrc-hashtb)))
1012 (and unread ; This group might be unchecked
1014 (string-match regexp group))
1015 (<= (setq clevel (gnus-info-level info)) level)
1017 (or all ; We list all groups?
1018 (if (eq unread t) ; Unactivated?
1019 gnus-group-list-inactive-groups ; We list unactivated
1020 (> unread 0)) ; We list groups with unread articles
1021 (and gnus-list-groups-with-ticked-articles
1022 (cdr (assq 'tick (gnus-info-marks info))))
1023 ; And groups with tickeds
1024 ;; Check for permanent visibility.
1025 (and gnus-permanently-visible-groups
1026 (string-match gnus-permanently-visible-groups
1028 (memq 'visible params)
1029 (cdr (assq 'visible params)))
1030 (gnus-group-insert-group-line
1031 group (gnus-info-level info)
1032 (gnus-info-marks info) unread (gnus-info-method info)))))
1034 ;; List dead groups.
1035 (and (>= level gnus-level-zombie) (<= lowest gnus-level-zombie)
1036 (gnus-group-prepare-flat-list-dead
1037 (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1038 gnus-level-zombie ?Z
1040 (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)
1041 (gnus-group-prepare-flat-list-dead
1042 (setq gnus-killed-list (sort gnus-killed-list 'string<))
1043 gnus-level-killed ?K regexp))
1045 (gnus-group-set-mode-line)
1046 (setq gnus-group-list-mode (cons level all))
1047 (gnus-run-hooks 'gnus-group-prepare-hook)
1050 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1051 ;; List zombies and killed lists somewhat faster, which was
1052 ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>. It does
1053 ;; this by ignoring the group format specification altogether.
1056 ;; This loop is used when listing groups that match some
1059 (setq group (pop groups))
1060 (when (string-match regexp group)
1061 (gnus-add-text-properties
1062 (point) (prog1 (1+ (point))
1063 (insert " " mark " *: "
1064 (gnus-group-name-decode group
1065 (gnus-group-name-charset
1068 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1070 'gnus-level level))))
1071 ;; This loop is used when listing all groups.
1073 (setq group (pop groups))
1074 (gnus-add-text-properties
1075 (point) (prog1 (1+ (point))
1076 (insert " " mark " *: "
1077 (gnus-group-name-decode group
1078 (gnus-group-name-charset
1081 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1083 'gnus-level level))))))
1085 (defun gnus-group-update-group-line ()
1086 "Update the current line in the group buffer."
1087 (let* ((buffer-read-only nil)
1088 (group (gnus-group-group-name))
1089 (entry (and group (gnus-gethash group gnus-newsrc-hashtb)))
1090 gnus-group-indentation)
1093 (not (gnus-ephemeral-group-p group))
1095 (concat "(gnus-group-set-info '"
1096 (gnus-prin1-to-string (nth 2 entry))
1098 (setq gnus-group-indentation (gnus-group-group-indentation))
1100 (gnus-group-insert-group-line-info group)
1102 (gnus-group-position-point))))
1104 (defun gnus-group-insert-group-line-info (group)
1105 "Insert GROUP on the current line."
1106 (let ((entry (gnus-gethash group gnus-newsrc-hashtb))
1107 (gnus-group-indentation (gnus-group-group-indentation))
1111 ;; (Un)subscribed group.
1112 (setq info (nth 2 entry))
1113 (gnus-group-insert-group-line
1114 group (gnus-info-level info) (gnus-info-marks info)
1115 (or (car entry) t) (gnus-info-method info)))
1116 ;; This group is dead.
1117 (gnus-group-insert-group-line
1119 (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1121 (if (setq active (gnus-active group))
1122 (if (zerop (cdr active))
1124 (- (1+ (cdr active)) (car active)))
1128 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1129 gnus-tmp-marked number
1131 "Insert a group line in the group buffer."
1132 (let* ((gnus-tmp-method
1133 (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1134 (group-name-charset (gnus-group-name-charset gnus-tmp-method
1136 (gnus-tmp-active (gnus-active gnus-tmp-group))
1137 (gnus-tmp-number-total
1139 (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1141 (gnus-tmp-number-of-unread
1142 (if (numberp number) (int-to-string (max 0 number))
1144 (gnus-tmp-number-of-read
1145 (if (numberp number)
1146 (int-to-string (max 0 (- gnus-tmp-number-total number)))
1148 (gnus-tmp-subscribed
1149 (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1150 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1151 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1153 (gnus-tmp-qualified-group
1154 (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1155 group-name-charset))
1156 (gnus-tmp-newsgroup-description
1157 (if gnus-description-hashtb
1158 (or (gnus-group-name-decode
1159 (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1160 group-name-charset) "")
1163 (if (and gnus-moderated-hashtb
1164 (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1166 (gnus-tmp-moderated-string
1167 (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1168 (gnus-tmp-group-icon "==&&==")
1169 (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1170 (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1171 (gnus-tmp-news-method-string
1173 (format "(%s:%s)" (car gnus-tmp-method)
1174 (cadr gnus-tmp-method)) ""))
1175 (gnus-tmp-marked-mark
1176 (if (and (numberp number)
1178 (cdr (assq 'tick gnus-tmp-marked)))
1180 (gnus-tmp-process-marked
1181 (if (member gnus-tmp-group gnus-group-marked)
1182 gnus-process-mark ? ))
1184 (or (and gnus-use-grouplens
1185 (bbb-grouplens-group-p gnus-tmp-group))
1187 (buffer-read-only nil)
1188 header gnus-tmp-header) ; passed as parameter to user-funcs.
1190 (gnus-add-text-properties
1194 (eval gnus-group-line-format-spec))
1195 `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1196 gnus-unread ,(if (numberp number)
1197 (string-to-int gnus-tmp-number-of-unread)
1199 gnus-marked ,gnus-tmp-marked-mark
1200 gnus-indentation ,gnus-group-indentation
1201 gnus-level ,gnus-tmp-level))
1203 (when (inline (gnus-visual-p 'group-highlight 'highlight))
1204 (gnus-run-hooks 'gnus-group-update-hook))
1206 ;; Allow XEmacs to remove front-sticky text properties.
1207 (gnus-group-remove-excess-properties)))
1209 (defun gnus-group-highlight-line ()
1210 "Highlight the current line according to `gnus-group-highlight'."
1211 (let* ((list gnus-group-highlight)
1213 (end (progn (end-of-line) (point)))
1214 ;; now find out where the line starts and leave point there.
1215 (beg (progn (beginning-of-line) (point)))
1216 (group (gnus-group-group-name))
1217 (entry (gnus-group-entry group))
1218 (unread (if (numberp (car entry)) (car entry) 0))
1219 (active (gnus-active group))
1220 (total (if active (1+ (- (cdr active) (car active))) 0))
1221 (info (nth 2 entry))
1222 (method (gnus-server-get-method group (gnus-info-method info)))
1223 (marked (gnus-info-marks info))
1224 (mailp (memq 'mail (assoc (symbol-name
1225 (car (or method gnus-select-method)))
1226 gnus-valid-select-methods)))
1227 (level (or (gnus-info-level info) gnus-level-killed))
1228 (score (or (gnus-info-score info) 0))
1229 (ticked (gnus-range-length (cdr (assq 'tick marked))))
1230 (group-age (gnus-group-timestamp-delta group))
1231 (inhibit-read-only t))
1232 ;; Eval the cars of the lists until we find a match.
1234 (not (eval (caar list))))
1235 (setq list (cdr list)))
1236 (let ((face (cdar list)))
1237 (unless (eq face (get-text-property beg 'face))
1238 (gnus-put-text-property-excluding-characters-with-faces
1240 (setq face (if (boundp face) (symbol-value face) face)))
1241 (gnus-extent-start-open beg)))
1244 (defun gnus-group-update-group (group &optional visible-only)
1245 "Update all lines where GROUP appear.
1246 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1248 ;; Can't use `save-excursion' here, so we do it manually.
1249 (let ((buf (current-buffer))
1251 (set-buffer gnus-group-buffer)
1252 (setq mark (point-marker))
1253 ;; The buffer may be narrowed.
1256 (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1258 found buffer-read-only)
1259 ;; Enter the current status into the dribble buffer.
1260 (let ((entry (gnus-gethash group gnus-newsrc-hashtb)))
1262 (not (gnus-ephemeral-group-p group)))
1264 (concat "(gnus-group-set-info '"
1265 (gnus-prin1-to-string (nth 2 entry))
1267 ;; Find all group instances. If topics are in use, each group
1268 ;; may be listed in more than once.
1269 (while (setq loc (text-property-any
1270 loc (point-max) 'gnus-group ident))
1273 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1275 (gnus-group-insert-group-line-info group)
1278 (gnus-run-hooks 'gnus-group-update-group-hook)))
1279 (setq loc (1+ loc)))
1280 (unless (or found visible-only)
1281 ;; No such line in the buffer, find out where it's supposed to
1282 ;; go, and insert it there (or at the end of the buffer).
1283 (if gnus-goto-missing-group-function
1284 (funcall gnus-goto-missing-group-function group)
1285 (let ((entry (cddr (gnus-gethash group gnus-newsrc-hashtb))))
1286 (while (and entry (car entry)
1290 (point-min) (point-max)
1291 'gnus-group (gnus-intern-safe
1292 (caar entry) gnus-active-hashtb)))))
1293 (setq entry (cdr entry)))
1294 (or entry (goto-char (point-max)))))
1295 ;; Finally insert the line.
1296 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1297 (gnus-group-insert-group-line-info group)
1300 (gnus-run-hooks 'gnus-group-update-group-hook))))
1301 (when gnus-group-update-group-function
1302 (funcall gnus-group-update-group-function group))
1303 (gnus-group-set-mode-line)))
1305 (set-marker mark nil)
1308 (defun gnus-group-set-mode-line ()
1309 "Update the mode line in the group buffer."
1310 (when (memq 'group gnus-updated-mode-lines)
1311 ;; Yes, we want to keep this mode line updated.
1313 (set-buffer gnus-group-buffer)
1314 (let* ((gformat (or gnus-group-mode-line-format-spec
1315 (gnus-set-format 'group-mode)))
1316 (gnus-tmp-news-server (cadr gnus-select-method))
1317 (gnus-tmp-news-method (car gnus-select-method))
1318 (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1320 gnus-tmp-header ;Dummy binding for user-defined formats
1321 ;; Get the resulting string.
1323 (and gnus-dribble-buffer
1324 (buffer-name gnus-dribble-buffer)
1325 (buffer-modified-p gnus-dribble-buffer)
1327 (set-buffer gnus-dribble-buffer)
1328 (not (zerop (buffer-size))))))
1329 (mode-string (eval gformat)))
1330 ;; Say whether the dribble buffer has been modified.
1331 (setq mode-line-modified
1332 (if modified (car gnus-mode-line-modified)
1333 (cdr gnus-mode-line-modified)))
1334 ;; If the line is too long, we chop it off.
1335 (when (> (length mode-string) max-len)
1336 (setq mode-string (substring mode-string 0 (- max-len 4))))
1338 (setq mode-line-buffer-identification
1339 (gnus-mode-line-buffer-identification
1340 (list mode-string)))
1341 (set-buffer-modified-p modified))))))
1343 (defun gnus-group-group-name ()
1344 "Get the name of the newsgroup on the current line."
1345 (let ((group (get-text-property (gnus-point-at-bol) 'gnus-group)))
1347 (symbol-name group))))
1349 (defun gnus-group-group-level ()
1350 "Get the level of the newsgroup on the current line."
1351 (get-text-property (gnus-point-at-bol) 'gnus-level))
1353 (defun gnus-group-group-indentation ()
1354 "Get the indentation of the newsgroup on the current line."
1355 (or (get-text-property (gnus-point-at-bol) 'gnus-indentation)
1356 (and gnus-group-indentation-function
1357 (funcall gnus-group-indentation-function))
1360 (defun gnus-group-group-unread ()
1361 "Get the number of unread articles of the newsgroup on the current line."
1362 (get-text-property (gnus-point-at-bol) 'gnus-unread))
1364 (defun gnus-group-new-mail (group)
1365 (if (nnmail-new-mail-p (gnus-group-real-name group))
1369 (defun gnus-group-level (group)
1370 "Return the estimated level of GROUP."
1371 (or (gnus-info-level (gnus-get-info group))
1372 (and (member group gnus-zombie-list) gnus-level-zombie)
1375 (defun gnus-group-search-forward (&optional backward all level first-too)
1376 "Find the next newsgroup with unread articles.
1377 If BACKWARD is non-nil, find the previous newsgroup instead.
1378 If ALL is non-nil, just find any newsgroup.
1379 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1381 If FIRST-TOO, the current line is also eligible as a target."
1382 (let ((way (if backward -1 1))
1383 (low gnus-level-killed)
1386 (if (and backward (progn (beginning-of-line)) (bobp))
1395 (get-text-property (point) 'gnus-group)
1399 (get-text-property (point) 'gnus-unread)))
1400 (and (numberp unread) (> unread 0)))
1401 (setq lev (get-text-property (point)
1403 (<= lev gnus-level-subscribed)))
1405 (and (setq lev (get-text-property (point)
1414 (zerop (forward-line way)))))
1416 (progn (gnus-group-position-point) t)
1417 (goto-char (or pos beg))
1420 ;;; Gnus group mode commands
1424 (defun gnus-group-mark-line-p ()
1427 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1428 (eq (char-after) gnus-process-mark)))
1430 (defun gnus-group-mark-group (n &optional unmark no-advance)
1431 "Mark the current group."
1433 (let ((buffer-read-only nil)
1437 (when (setq group (gnus-group-group-name))
1438 ;; Go to the mark position.
1440 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1441 (subst-char-in-region
1442 (point) (1+ (point)) (char-after)
1445 (setq gnus-group-marked (delete group gnus-group-marked))
1447 (setq gnus-group-marked
1448 (cons group (delete group gnus-group-marked)))
1449 gnus-process-mark)))
1451 (gnus-group-next-group 1))
1453 (gnus-summary-position-point)
1456 (defun gnus-group-unmark-group (n)
1457 "Remove the mark from the current group."
1459 (gnus-group-mark-group n 'unmark)
1460 (gnus-group-position-point))
1462 (defun gnus-group-unmark-all-groups ()
1463 "Unmark all groups."
1465 (let ((groups gnus-group-marked))
1468 (gnus-group-remove-mark (pop groups)))))
1469 (gnus-group-position-point))
1471 (defun gnus-group-mark-region (unmark beg end)
1472 "Mark all groups between point and mark.
1473 If UNMARK, remove the mark instead."
1474 (interactive "P\nr")
1475 (let ((num (count-lines beg end)))
1478 (- num (gnus-group-mark-group num unmark)))))
1480 (defun gnus-group-mark-buffer (&optional unmark)
1481 "Mark all groups in the buffer.
1482 If UNMARK, remove the mark instead."
1484 (gnus-group-mark-region unmark (point-min) (point-max)))
1486 (defun gnus-group-mark-regexp (regexp)
1487 "Mark all groups that match some regexp."
1488 (interactive "sMark (regexp): ")
1489 (let ((alist (cdr gnus-newsrc-alist))
1492 (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1493 (gnus-group-set-mark group))))
1494 (gnus-group-position-point))
1496 (defun gnus-group-remove-mark (group &optional test-marked)
1497 "Remove the process mark from GROUP and move point there.
1498 Return nil if the group isn't displayed."
1499 (if (gnus-group-goto-group group nil test-marked)
1501 (gnus-group-mark-group 1 'unmark t)
1503 (setq gnus-group-marked
1504 (delete group gnus-group-marked))
1507 (defun gnus-group-set-mark (group)
1508 "Set the process mark on GROUP."
1509 (if (gnus-group-goto-group group)
1511 (gnus-group-mark-group 1 nil t))
1512 (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1514 (defun gnus-group-universal-argument (arg &optional groups func)
1515 "Perform any command on all groups according to the process/prefix convention."
1517 (if (eq (setq func (or func
1520 (substitute-command-keys
1521 "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1523 (gnus-error 1 "Undefined key")
1524 (gnus-group-iterate arg
1526 (command-execute func))))
1527 (gnus-group-position-point))
1529 (defun gnus-group-process-prefix (n)
1530 "Return a list of groups to work on.
1531 Take into consideration N (the prefix) and the list of marked groups."
1534 (setq n (prefix-numeric-value n))
1535 ;; There is a prefix, so we return a list of the N next
1537 (let ((way (if (< n 0) -1 1))
1542 (if (setq group (gnus-group-group-name))
1543 (push group groups))
1545 (gnus-group-next-group way)))
1547 ((gnus-region-active-p)
1548 ;; Work on the region between point and mark.
1549 (let ((max (max (point) (mark)))
1552 (goto-char (min (point) (mark)))
1555 (push (gnus-group-group-name) groups)
1556 (zerop (gnus-group-next-group 1))
1558 (nreverse groups))))
1560 ;; No prefix, but a list of marked articles.
1561 (reverse gnus-group-marked))
1563 ;; Neither marked articles or a prefix, so we return the
1565 (let ((group (gnus-group-group-name)))
1566 (and group (list group))))))
1568 ;;; !!!Surely gnus-group-iterate should be a macro instead? I can't
1569 ;;; imagine why I went through these contortions...
1571 (let ((function (make-symbol "gnus-group-iterate-function"))
1572 (window (make-symbol "gnus-group-iterate-window"))
1573 (groups (make-symbol "gnus-group-iterate-groups"))
1574 (group (make-symbol "gnus-group-iterate-group")))
1576 `(defun gnus-group-iterate (arg ,function)
1577 "Iterate FUNCTION over all process/prefixed groups.
1578 FUNCTION will be called with the group name as the parameter
1579 and with point over the group in question."
1580 (let ((,groups (gnus-group-process-prefix arg))
1581 (,window (selected-window))
1584 (setq ,group (car ,groups)
1585 ,groups (cdr ,groups))
1586 (select-window ,window)
1587 (gnus-group-remove-mark ,group)
1588 (save-selected-window
1590 (funcall ,function ,group)))))))))
1592 (put 'gnus-group-iterate 'lisp-indent-function 1)
1594 ;; Selecting groups.
1596 (defun gnus-group-read-group (&optional all no-article group select-articles)
1597 "Read news in this newsgroup.
1598 If the prefix argument ALL is non-nil, already read articles become
1599 readable. IF ALL is a number, fetch this number of articles. If the
1600 optional argument NO-ARTICLE is non-nil, no article will be
1601 auto-selected upon group entry. If GROUP is non-nil, fetch that
1604 (let ((no-display (eq all 0))
1605 (group (or group (gnus-group-group-name)))
1606 number active marked entry)
1610 (error "No group on current line"))
1611 (setq marked (gnus-info-marks
1612 (nth 2 (setq entry (gnus-gethash
1613 group gnus-newsrc-hashtb)))))
1614 ;; This group might be a dead group. In that case we have to get
1615 ;; the number of unread articles from `gnus-active-hashtb'.
1617 (cond ((numberp all) all)
1619 ((setq active (gnus-active group))
1620 (- (1+ (cdr active)) (car active)))))
1621 (gnus-summary-read-group
1622 group (or all (and (numberp number)
1623 (zerop (+ number (gnus-range-length
1624 (cdr (assq 'tick marked)))
1626 (cdr (assq 'dormant marked)))))))
1627 no-article nil no-display nil select-articles)))
1629 (defun gnus-group-select-group (&optional all)
1630 "Select this newsgroup.
1631 No article is selected automatically.
1632 If ALL is non-nil, already read articles become readable.
1633 If ALL is a number, fetch this number of articles."
1635 (gnus-group-read-group all t))
1637 (defun gnus-group-quick-select-group (&optional all)
1638 "Select the current group \"quickly\".
1639 This means that no highlighting or scoring will be performed.
1640 If ALL (the prefix argument) is 0, don't even generate the summary
1643 This might be useful if you want to toggle threading
1644 before entering the group."
1646 (require 'gnus-score)
1648 gnus-score-find-score-files-function
1649 gnus-home-score-file
1650 gnus-apply-kill-hook
1651 gnus-summary-expunge-below)
1652 (gnus-group-read-group all t)))
1654 (defun gnus-group-visible-select-group (&optional all)
1655 "Select the current group without hiding any articles."
1657 (let ((gnus-inhibit-limiting t))
1658 (gnus-group-read-group all t)))
1660 (defun gnus-group-select-group-ephemerally ()
1661 "Select the current group without doing any processing whatsoever.
1662 You will actually be entered into a group that's a copy of
1663 the current group; no changes you make while in this group will
1666 (require 'gnus-score)
1668 gnus-score-find-score-files-function gnus-apply-kill-hook
1669 gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
1670 gnus-summary-mode-hook gnus-select-group-hook
1671 (group (gnus-group-group-name))
1672 (method (gnus-find-method-for-group group)))
1673 (gnus-group-read-ephemeral-group
1674 (gnus-group-prefixed-name group method) method)))
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 (list (completing-read "Group name: " gnus-active-hashtb)))
1681 (unless (get-buffer gnus-group-buffer)
1683 (gnus-group-read-group nil nil group))
1686 (defun gnus-fetch-group-other-frame (group)
1687 "Pop up a frame and enter GROUP."
1689 (let ((window (get-buffer-window gnus-group-buffer)))
1691 (select-frame (window-frame window)))
1692 ((= (length (frame-list)) 1)
1693 (select-frame (make-frame)))
1696 (gnus-fetch-group group))
1698 (defvar gnus-ephemeral-group-server 0)
1700 ;; Enter a group that is not in the group buffer. Non-nil is returned
1701 ;; if selection was successful.
1702 (defun gnus-group-read-ephemeral-group (group method &optional activate
1703 quit-config request-only
1705 "Read GROUP from METHOD as an ephemeral group.
1706 If ACTIVATE, request the group first.
1707 If QUIT-CONFIG, use that window configuration when exiting from the
1709 If REQUEST-ONLY, don't actually read the group; just request it.
1710 If SELECT-ARTICLES, only select those articles.
1712 Return the name of the group if selection was successful."
1713 ;; Transform the select method into a unique server.
1714 (when (stringp method)
1715 (setq method (gnus-server-to-method method)))
1717 `(,(car method) ,(concat (cadr method) "-ephemeral")
1718 (,(intern (format "%s-address" (car method))) ,(cadr method))
1720 (let ((group (if (gnus-group-foreign-p group) group
1721 (gnus-group-prefixed-name group method))))
1725 ,gnus-level-default-subscribed nil nil ,method
1727 ,(if quit-config quit-config
1728 (cons gnus-summary-buffer
1729 gnus-current-window-configuration))))))
1731 (push method gnus-ephemeral-servers)
1732 (set-buffer gnus-group-buffer)
1733 (unless (gnus-check-server method)
1734 (error "Unable to contact server: %s" (gnus-status-message method)))
1736 (gnus-activate-group group 'scan)
1737 (unless (gnus-request-group group)
1738 (error "Couldn't request group: %s"
1739 (nnheader-get-report (car method)))))
1743 (when (gnus-group-read-group t t group select-articles)
1748 (defun gnus-group-jump-to-group (group)
1749 "Jump to newsgroup GROUP."
1751 (list (completing-read
1752 "Group: " gnus-active-hashtb nil
1753 (gnus-read-active-file-p)
1755 'gnus-group-history)))
1757 (when (equal group "")
1758 (error "Empty group name"))
1760 (unless (gnus-ephemeral-group-p group)
1761 ;; Either go to the line in the group buffer...
1762 (unless (gnus-group-goto-group group)
1763 ;; ... or insert the line.
1764 (gnus-group-update-group group)
1765 (gnus-group-goto-group group)))
1766 ;; Adjust cursor point.
1767 (gnus-group-position-point))
1769 (defun gnus-group-goto-group (group &optional far test-marked)
1770 "Goto to newsgroup GROUP.
1771 If FAR, it is likely that the group is not on the current line.
1772 If TEST-MARKED, the line must be marked."
1776 ;; It's quite likely that we are on the right line, so
1777 ;; we check the current line first.
1779 (eq (get-text-property (point) 'gnus-group)
1780 (gnus-intern-safe group gnus-active-hashtb))
1781 (or (not test-marked) (gnus-group-mark-line-p)))
1783 ;; Previous and next line are also likely, so we check them as well.
1787 (and (eq (get-text-property (point) 'gnus-group)
1788 (gnus-intern-safe group gnus-active-hashtb))
1789 (or (not test-marked) (gnus-group-mark-line-p)))))
1795 (and (eq (get-text-property (point) 'gnus-group)
1796 (gnus-intern-safe group gnus-active-hashtb))
1797 (or (not test-marked) (gnus-group-mark-line-p)))))
1801 (goto-char (point-min))
1803 (while (and (not found)
1808 (gnus-intern-safe group gnus-active-hashtb))))
1809 (if (gnus-group-mark-line-p)
1814 ;; Search through the entire buffer.
1817 (point-min) (point-max)
1818 'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
1820 (defun gnus-group-next-group (n &optional silent)
1821 "Go to next N'th newsgroup.
1822 If N is negative, search backward instead.
1823 Returns the difference between N and the number of skips actually
1826 (gnus-group-next-unread-group n t nil silent))
1828 (defun gnus-group-next-unread-group (n &optional all level silent)
1829 "Go to next N'th unread newsgroup.
1830 If N is negative, search backward instead.
1831 If ALL is non-nil, choose any newsgroup, unread or not.
1832 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
1833 such group can be found, the next group with a level higher than
1835 Returns the difference between N and the number of skips actually
1838 (let ((backward (< n 0))
1841 (gnus-group-search-forward
1842 backward (or (not gnus-group-goto-unread) all) level))
1846 (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
1847 (if level " on this level or higher" "")))
1850 (defun gnus-group-prev-group (n)
1851 "Go to previous N'th newsgroup.
1852 Returns the difference between N and the number of skips actually
1855 (gnus-group-next-unread-group (- n) t))
1857 (defun gnus-group-prev-unread-group (n)
1858 "Go to previous N'th unread newsgroup.
1859 Returns the difference between N and the number of skips actually
1862 (gnus-group-next-unread-group (- n)))
1864 (defun gnus-group-next-unread-group-same-level (n)
1865 "Go to next N'th unread newsgroup on the same level.
1866 If N is negative, search backward instead.
1867 Returns the difference between N and the number of skips actually
1870 (gnus-group-next-unread-group n t (gnus-group-group-level))
1871 (gnus-group-position-point))
1873 (defun gnus-group-prev-unread-group-same-level (n)
1874 "Go to next N'th unread newsgroup on the same level.
1875 Returns the difference between N and the number of skips actually
1878 (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
1879 (gnus-group-position-point))
1881 (defun gnus-group-best-unread-group (&optional exclude-group)
1882 "Go to the group with the highest level.
1883 If EXCLUDE-GROUP, do not go to that group."
1885 (goto-char (point-min))
1889 (setq unread (get-text-property (point) 'gnus-unread))
1890 (when (and (numberp unread) (> unread 0))
1891 (when (and (get-text-property (point) 'gnus-level)
1892 (< (get-text-property (point) 'gnus-level) best)
1893 (or (not exclude-group)
1894 (not (equal exclude-group (gnus-group-group-name)))))
1895 (setq best (get-text-property (point) 'gnus-level))
1896 (setq best-point (point))))
1899 (goto-char best-point))
1900 (gnus-summary-position-point)
1901 (and best-point (gnus-group-group-name))))
1903 (defun gnus-group-first-unread-group ()
1904 "Go to the first group with unread articles."
1907 (let ((opoint (point))
1909 (goto-char (point-min))
1910 (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
1911 (and (numberp unread) ; Not a topic.
1912 (not (zerop unread))) ; Has unread articles.
1913 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
1916 nil)) ; Not success.
1917 (gnus-group-position-point)))
1919 (defun gnus-group-enter-server-mode ()
1920 "Jump to the server buffer."
1922 (gnus-enter-server-buffer))
1924 (defun gnus-group-make-group (name &optional method address args)
1925 "Add a new newsgroup.
1926 The user will be prompted for a NAME, for a select METHOD, and an
1930 (gnus-read-group "Group name: ")
1931 (gnus-read-method "From method: ")))
1933 (when (stringp method)
1934 (setq method (or (gnus-server-to-method method) method)))
1935 (let* ((meth (gnus-method-simplify
1937 (not (gnus-server-equal method gnus-select-method)))
1938 (if address (list (intern method) address)
1940 (nname (if method (gnus-group-prefixed-name name meth) name))
1942 (when (gnus-gethash nname gnus-newsrc-hashtb)
1943 (error "Group %s already exists" nname))
1944 ;; Subscribe to the new group.
1945 (gnus-group-change-level
1946 (setq info (list t nname gnus-level-default-subscribed nil nil meth))
1947 gnus-level-default-subscribed gnus-level-killed
1948 (and (gnus-group-group-name)
1949 (gnus-gethash (gnus-group-group-name)
1950 gnus-newsrc-hashtb))
1953 (gnus-set-active nname (cons 1 0))
1954 (unless (gnus-ephemeral-group-p name)
1956 (concat "(gnus-group-set-info '"
1957 (gnus-prin1-to-string (cdr info)) ")")))
1959 (gnus-group-insert-group-line-info nname)
1961 (gnus-group-position-point)
1963 ;; Load the backend and try to make the backend create
1964 ;; the group as well.
1965 (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
1967 gnus-valid-select-methods)
1969 (gnus-check-server meth)
1970 (when (gnus-check-backend-function 'request-create-group nname)
1971 (gnus-request-create-group nname nil args))
1974 (defun gnus-group-delete-groups (&optional arg)
1975 "Delete the current group. Only meaningful with editable groups."
1977 (let ((n (length (gnus-group-process-prefix arg))))
1978 (when (gnus-yes-or-no-p
1980 "Delete this 1 group? "
1981 (format "Delete these %d groups? " n)))
1982 (gnus-group-iterate arg
1984 (gnus-group-delete-group group nil t))))))
1986 (defun gnus-group-delete-group (group &optional force no-prompt)
1987 "Delete the current group. Only meaningful with editable groups.
1988 If FORCE (the prefix) is non-nil, all the articles in the group will
1989 be deleted. This is \"deleted\" as in \"removed forever from the face
1990 of the Earth\". There is no undo. The user will be prompted before
1991 doing the deletion."
1993 (list (gnus-group-group-name)
1994 current-prefix-arg))
1996 (error "No group to rename"))
1997 (unless (gnus-check-backend-function 'request-delete-group group)
1998 (error "This backend does not support group deletion"))
2000 (if (and (not no-prompt)
2001 (not (gnus-yes-or-no-p
2003 "Do you really want to delete %s%s? "
2004 group (if force " and all its contents" "")))))
2006 (gnus-message 6 "Deleting group %s..." group)
2007 (if (not (gnus-request-delete-group group force))
2008 (gnus-error 3 "Couldn't delete group %s" group)
2009 (gnus-message 6 "Deleting group %s...done" group)
2010 (gnus-group-goto-group group)
2011 (gnus-group-kill-group 1 t)
2012 (gnus-sethash group nil gnus-active-hashtb)
2014 (gnus-group-position-point)))
2016 (defun gnus-group-rename-group (group new-name)
2017 "Rename group from GROUP to NEW-NAME.
2018 When used interactively, GROUP is the group under point
2019 and NEW-NAME will be prompted for."
2022 (gnus-group-group-name)
2024 (unless (gnus-check-backend-function
2025 'request-rename-group (gnus-group-group-name))
2026 (error "This backend does not support renaming groups"))
2027 (gnus-read-group "Rename group to: "
2028 (gnus-group-real-name (gnus-group-group-name))))))
2030 (unless (gnus-check-backend-function 'request-rename-group group)
2031 (error "This backend does not support renaming groups"))
2033 (error "No group to rename"))
2034 (when (equal (gnus-group-real-name group) new-name)
2035 (error "Can't rename to the same name"))
2037 ;; We find the proper prefixed name.
2039 (if (gnus-group-native-p group)
2043 (gnus-group-prefixed-name
2044 (gnus-group-real-name new-name)
2045 (gnus-info-method (gnus-get-info group)))))
2047 (gnus-message 6 "Renaming group %s to %s..." group new-name)
2050 (gnus-group-goto-group group)
2051 (not (when (< (gnus-group-group-level) gnus-level-zombie)
2052 (gnus-request-rename-group group new-name))))
2053 (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
2054 ;; We rename the group internally by killing it...
2055 (gnus-group-kill-group)
2056 ;; ... changing its name ...
2057 (setcar (cdar gnus-list-of-killed-groups) new-name)
2058 ;; ... and then yanking it. Magic!
2059 (gnus-group-yank-group)
2060 (gnus-set-active new-name (gnus-active group))
2061 (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2063 (setq gnus-killed-list (delete group gnus-killed-list))
2064 (gnus-set-active group nil)
2065 (gnus-dribble-touch)
2066 (gnus-group-position-point)))
2068 (defun gnus-group-edit-group (group &optional part)
2069 "Edit the group on the current line."
2070 (interactive (list (gnus-group-group-name)))
2071 (let ((part (or part 'info))
2074 (error "No group on current line"))
2075 (unless (setq info (gnus-get-info group))
2076 (error "Killed group; can't be edited"))
2078 (gnus-close-group group))
2080 ;; Find the proper form to edit.
2081 (cond ((eq part 'method)
2082 (or (gnus-info-method info) "native"))
2084 (gnus-info-params info))
2086 ;; The proper documentation.
2088 "Editing the %s for `%s'."
2090 ((eq part 'method) "select method")
2091 ((eq part 'params) "group parameters")
2093 (gnus-group-decoded-name group))
2095 (gnus-group-edit-group-done ',part ,group form)))))
2097 (defun gnus-group-edit-group-method (group)
2098 "Edit the select method of GROUP."
2099 (interactive (list (gnus-group-group-name)))
2100 (gnus-group-edit-group group 'method))
2102 (defun gnus-group-edit-group-parameters (group)
2103 "Edit the group parameters of GROUP."
2104 (interactive (list (gnus-group-group-name)))
2105 (gnus-group-edit-group group 'params))
2107 (defun gnus-group-edit-group-done (part group form)
2109 (let* ((method (cond ((eq part 'info) (nth 4 form))
2110 ((eq part 'method) form)
2112 (info (cond ((eq part 'info) form)
2113 ((eq part 'method) (gnus-get-info group))
2116 (if (or (not method)
2118 gnus-select-method method))
2119 (gnus-group-real-name (car info))
2120 (gnus-group-prefixed-name
2121 (gnus-group-real-name (car info)) method))
2123 (when (and new-group
2124 (not (equal new-group group)))
2125 (when (gnus-group-goto-group group)
2126 (gnus-group-kill-group 1))
2127 (gnus-activate-group new-group))
2129 (if (not (and info new-group))
2130 (gnus-group-set-info form (or new-group group) part)
2131 (setq info (gnus-copy-sequence info))
2132 (setcar info new-group)
2133 (unless (gnus-server-equal method "native")
2134 (unless (nthcdr 3 info)
2135 (nconc info (list nil nil)))
2136 (unless (nthcdr 4 info)
2137 (nconc info (list nil)))
2138 (gnus-info-set-method info method))
2139 (gnus-group-set-info info))
2140 (gnus-group-update-group (or new-group group))
2141 (gnus-group-position-point)))
2143 (defun gnus-group-make-useful-group (group method)
2144 "Create one of the groups described in `gnus-useful-groups'."
2146 (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2148 gnus-useful-groups)))
2149 (list (cadr entry) (caddr entry))))
2150 (setq method (gnus-copy-sequence method))
2152 (while (setq entry (memq (assq 'eval method) method))
2153 (setcar entry (eval (cadar entry)))))
2154 (gnus-group-make-group group method))
2156 (defun gnus-group-make-help-group ()
2157 "Create the Gnus documentation group."
2159 (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2160 (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2161 (when (gnus-gethash name gnus-newsrc-hashtb)
2162 (error "Documentation group already exists"))
2164 (gnus-message 1 "Couldn't find doc group")
2165 (gnus-group-make-group
2166 (gnus-group-real-name name)
2167 (list 'nndoc "gnus-help"
2168 (list 'nndoc-address file)
2169 (list 'nndoc-article-type 'mbox)))))
2170 (gnus-group-position-point))
2172 (defun gnus-group-make-doc-group (file type)
2173 "Create a group that uses a single file as the source."
2175 (list (read-file-name "File name: ")
2176 (and current-prefix-arg 'ask)))
2177 (when (eq type 'ask)
2182 "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [mbdfag]: "
2184 (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2185 ((= char ?b) 'babyl)
2186 ((= char ?d) 'digest)
2187 ((= char ?f) 'forward)
2189 ((= char ?g) 'guess)
2190 (t (setq err (format "%c unknown. " char))
2193 (let* ((file (expand-file-name file))
2194 (name (gnus-generate-new-group-name
2195 (gnus-group-prefixed-name
2196 (file-name-nondirectory file) '(nndoc "")))))
2197 (gnus-group-make-group
2198 (gnus-group-real-name name)
2200 (list 'nndoc-address file)
2201 (list 'nndoc-article-type (or type 'guess))))))
2203 (defvar nnweb-type-definition)
2204 (defvar gnus-group-web-type-history nil)
2205 (defvar gnus-group-web-search-history nil)
2206 (defun gnus-group-make-web-group (&optional solid)
2207 "Create an ephemeral nnweb group.
2208 If SOLID (the prefix), create a solid group."
2212 (if solid (gnus-read-group "Group name: ")
2213 (message-unique-id)))
2214 (default-type (or (car gnus-group-web-type-history)
2215 (symbol-name (caar nnweb-type-definition))))
2219 (format "Search engine type (default %s): " default-type)
2220 (mapcar (lambda (elem) (list (symbol-name (car elem))))
2221 nnweb-type-definition)
2222 nil t nil 'gnus-group-web-type-history)
2227 (cons (or (car gnus-group-web-search-history) "") 0)
2228 'gnus-group-web-search-history))
2230 `(nnweb ,group (nnweb-search ,search)
2231 (nnweb-type ,(intern type))
2232 (nnweb-ephemeral-p t))))
2234 (gnus-group-make-group group "nnweb" "" `(,(intern type) ,search))
2235 (gnus-group-read-ephemeral-group
2237 (cons (current-buffer)
2238 (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2240 (defvar nnwarchive-type-definition)
2241 (defvar gnus-group-warchive-type-history nil)
2242 (defvar gnus-group-warchive-login-history nil)
2243 (defvar gnus-group-warchive-address-history nil)
2245 (defun gnus-group-make-warchive-group ()
2246 "Create a nnwarchive group."
2248 (require 'nnwarchive)
2249 (let* ((group (gnus-read-group "Group name: "))
2250 (default-type (or (car gnus-group-warchive-type-history)
2251 (symbol-name (caar nnwarchive-type-definition))))
2255 (format "Warchive type (default %s): " default-type)
2256 (mapcar (lambda (elem) (list (symbol-name (car elem))))
2257 nnwarchive-type-definition)
2258 nil t nil 'gnus-group-warchive-type-history)
2260 (address (read-string "Warchive address: "
2261 nil 'gnus-group-warchive-address-history))
2262 (default-login (or (car gnus-group-warchive-login-history)
2267 (format "Warchive login (default %s): " user-mail-address)
2268 default-login 'gnus-group-warchive-login-history)
2271 `(nnwarchive ,address
2272 (nnwarchive-type ,(intern type))
2273 (nnwarchive-login ,login))))
2274 (gnus-group-make-group group method)))
2276 (defun gnus-group-make-archive-group (&optional all)
2277 "Create the (ding) Gnus archive group of the most recent articles.
2278 Given a prefix, create a full group."
2280 (let ((group (gnus-group-prefixed-name
2281 (if all "ding.archives" "ding.recent") '(nndir ""))))
2282 (when (gnus-gethash group gnus-newsrc-hashtb)
2283 (error "Archive group already exists"))
2284 (gnus-group-make-group
2285 (gnus-group-real-name group)
2286 (list 'nndir (if all "hpc" "edu")
2287 (list 'nndir-directory
2288 (if all gnus-group-archive-directory
2289 gnus-group-recent-archive-directory))))
2290 (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2292 (defun gnus-group-make-directory-group (dir)
2293 "Create an nndir group.
2294 The user will be prompted for a directory. The contents of this
2295 directory will be used as a newsgroup. The directory should contain
2296 mail messages or news articles in files that have numeric names."
2298 (list (read-file-name "Create group from directory: ")))
2299 (unless (file-exists-p dir)
2300 (error "No such directory"))
2301 (unless (file-directory-p dir)
2302 (error "Not a directory"))
2306 (while (or (not group) (gnus-gethash group gnus-newsrc-hashtb))
2308 (gnus-group-prefixed-name
2309 (concat (file-name-as-directory (directory-file-name dir))
2312 (setq ext (format "<%d>" (setq i (1+ i)))))
2313 (gnus-group-make-group
2314 (gnus-group-real-name group)
2315 (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2317 (defun gnus-group-make-kiboze-group (group address scores)
2318 "Create an nnkiboze group.
2319 The user will be prompted for a name, a regexp to match groups, and
2320 score file entries for articles to include in the group."
2323 (read-string "nnkiboze group name: ")
2324 (read-string "Source groups (regexp): ")
2325 (let ((headers (mapcar (lambda (group) (list group))
2326 '("subject" "from" "number" "date" "message-id"
2327 "references" "chars" "lines" "xref"
2328 "followup" "all" "body" "head")))
2329 scores header regexp regexps)
2330 (while (not (equal "" (setq header (completing-read
2331 "Match on header: " headers nil t))))
2333 (while (not (equal "" (setq regexp (read-string
2334 (format "Match on %s (regexp): "
2336 (push (list regexp nil nil 'r) regexps))
2337 (push (cons header regexps) scores))
2339 (gnus-group-make-group group "nnkiboze" address)
2340 (let* ((nnkiboze-current-group group)
2341 (score-file (car (nnkiboze-score-file "")))
2342 (score-dir (file-name-directory score-file)))
2343 (unless (file-exists-p score-dir)
2344 (make-directory score-dir))
2345 (with-temp-file score-file
2346 (let (emacs-lisp-mode-hook)
2347 (pp scores (current-buffer))))))
2349 (defun gnus-group-add-to-virtual (n vgroup)
2350 "Add the current group to a virtual group."
2352 (list current-prefix-arg
2353 (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2355 (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2356 (error "%s is not an nnvirtual group" vgroup))
2357 (gnus-close-group vgroup)
2358 (let* ((groups (gnus-group-process-prefix n))
2359 (method (gnus-info-method (gnus-get-info vgroup))))
2360 (setcar (cdr method)
2362 (nth 1 method) "\\|"
2365 (gnus-group-remove-mark s)
2366 (concat "\\(^" (regexp-quote s) "$\\)"))
2368 (gnus-group-position-point))
2370 (defun gnus-group-make-empty-virtual (group)
2371 "Create a new, fresh, empty virtual group."
2372 (interactive "sCreate new, empty virtual group: ")
2373 (let* ((method (list 'nnvirtual "^$"))
2374 (pgroup (gnus-group-prefixed-name group method)))
2375 ;; Check whether it exists already.
2376 (when (gnus-gethash pgroup gnus-newsrc-hashtb)
2377 (error "Group %s already exists" pgroup))
2378 ;; Subscribe the new group after the group on the current line.
2379 (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2380 (gnus-group-update-group pgroup)
2382 (gnus-group-position-point)))
2384 (defun gnus-group-enter-directory (dir)
2385 "Enter an ephemeral nneething group."
2386 (interactive "DDirectory to read: ")
2387 (let* ((method (list 'nneething dir '(nneething-read-only t)))
2388 (leaf (gnus-group-prefixed-name
2389 (file-name-nondirectory (directory-file-name dir))
2391 (name (gnus-generate-new-group-name leaf)))
2392 (unless (gnus-group-read-ephemeral-group
2394 (cons (current-buffer)
2395 (if (eq major-mode 'gnus-summary-mode)
2397 (error "Couldn't enter %s" dir))))
2400 (autoload 'nnimap-expunge "nnimap")
2401 (autoload 'nnimap-acl-get "nnimap")
2402 (autoload 'nnimap-acl-edit "nnimap"))
2404 (defun gnus-group-nnimap-expunge (group)
2405 "Expunge deleted articles in current nnimap GROUP."
2406 (interactive (list (gnus-group-group-name)))
2407 (let ((mailbox (gnus-group-real-name group)) method)
2409 (error "No group on current line"))
2410 (unless (gnus-get-info group)
2411 (error "Killed group; can't be edited"))
2412 (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
2413 (error "%s is not an nnimap group" group))
2414 (nnimap-expunge mailbox (cadr method))))
2416 (defun gnus-group-nnimap-edit-acl (group)
2417 "Edit the Access Control List of current nnimap GROUP."
2418 (interactive (list (gnus-group-group-name)))
2419 (let ((mailbox (gnus-group-real-name group)) method acl)
2421 (error "No group on current line"))
2422 (unless (gnus-get-info group)
2423 (error "Killed group; can't be edited"))
2424 (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
2425 (error "%s is not an nnimap group" group))
2426 (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
2427 (error "Server does not support ACL's"))
2428 (gnus-edit-form acl (format "Editing the access control list for `%s'.
2430 An access control list is a list of (identifier . rights) elements.
2432 The identifier string specifies the corresponding user. The
2433 identifier \"anyone\" is reserved to refer to the universal identity.
2435 Rights is a string listing a (possibly empty) set of alphanumeric
2436 characters, each character listing a set of operations which is being
2437 controlled. Letters are reserved for ``standard'' rights, listed
2438 below. Digits are reserved for implementation or site defined rights.
2440 l - lookup (mailbox is visible to LIST/LSUB commands)
2441 r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
2442 SEARCH, COPY from mailbox)
2443 s - keep seen/unseen information across sessions (STORE \\SEEN flag)
2444 w - write (STORE flags other than \\SEEN and \\DELETED)
2445 i - insert (perform APPEND, COPY into mailbox)
2446 p - post (send mail to submission address for mailbox,
2447 not enforced by IMAP4 itself)
2448 c - create and delete mailbox (CREATE new sub-mailboxes in any
2449 implementation-defined hierarchy, RENAME or DELETE mailbox)
2450 d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
2451 a - administer (perform SETACL)" group)
2454 ,mailbox ',method ',acl form)))))
2456 ;; Group sorting commands
2457 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
2459 (defun gnus-group-sort-groups (func &optional reverse)
2460 "Sort the group buffer according to FUNC.
2461 When used interactively, the sorting function used will be
2462 determined by the `gnus-group-sort-function' variable.
2463 If REVERSE (the prefix), reverse the sorting order."
2464 (interactive (list gnus-group-sort-function current-prefix-arg))
2465 (funcall gnus-group-sort-alist-function
2466 (gnus-make-sort-function func) reverse)
2467 (gnus-group-list-groups)
2468 (gnus-dribble-touch))
2470 (defun gnus-group-sort-flat (func reverse)
2471 ;; We peel off the dummy group from the alist.
2473 (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
2474 (pop gnus-newsrc-alist))
2476 (setq gnus-newsrc-alist
2477 (sort gnus-newsrc-alist func))
2479 (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
2480 ;; Regenerate the hash table.
2481 (gnus-make-hashtable-from-newsrc-alist)))
2483 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
2484 "Sort the group buffer alphabetically by group name.
2485 If REVERSE, sort in reverse order."
2487 (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
2489 (defun gnus-group-sort-groups-by-unread (&optional reverse)
2490 "Sort the group buffer by number of unread articles.
2491 If REVERSE, sort in reverse order."
2493 (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
2495 (defun gnus-group-sort-groups-by-level (&optional reverse)
2496 "Sort the group buffer by group level.
2497 If REVERSE, sort in reverse order."
2499 (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
2501 (defun gnus-group-sort-groups-by-score (&optional reverse)
2502 "Sort the group buffer by group score.
2503 If REVERSE, sort in reverse order."
2505 (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
2507 (defun gnus-group-sort-groups-by-rank (&optional reverse)
2508 "Sort the group buffer by group rank.
2509 If REVERSE, sort in reverse order."
2511 (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
2513 (defun gnus-group-sort-groups-by-method (&optional reverse)
2514 "Sort the group buffer alphabetically by backend name.
2515 If REVERSE, sort in reverse order."
2517 (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
2519 ;;; Selected group sorting.
2521 (defun gnus-group-sort-selected-groups (n func &optional reverse)
2522 "Sort the process/prefixed groups."
2523 (interactive (list current-prefix-arg gnus-group-sort-function))
2524 (let ((groups (gnus-group-process-prefix n)))
2525 (funcall gnus-group-sort-selected-function
2526 groups (gnus-make-sort-function func) reverse)
2527 (gnus-group-list-groups)))
2529 (defun gnus-group-sort-selected-flat (groups func reverse)
2530 (let (entries infos)
2531 ;; First find all the group entries for these groups.
2533 (push (nthcdr 2 (gnus-gethash (pop groups) gnus-newsrc-hashtb))
2535 ;; Then sort the infos.
2539 (lambda (entry) (car entry))
2540 (setq entries (nreverse entries)))
2543 (setq infos (nreverse infos)))
2544 ;; Go through all the infos and replace the old entries
2545 ;; with the new infos.
2547 (setcar (car entries) (pop infos))
2549 ;; Update the hashtable.
2550 (gnus-make-hashtable-from-newsrc-alist)))
2552 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
2553 "Sort the group buffer alphabetically by group name.
2554 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
2555 sort in reverse order."
2556 (interactive (gnus-interactive "P\ny"))
2557 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
2559 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
2560 "Sort the group buffer by number of unread articles.
2561 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
2562 sort in reverse order."
2563 (interactive (gnus-interactive "P\ny"))
2564 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
2566 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
2567 "Sort the group buffer by group level.
2568 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
2569 sort in reverse order."
2570 (interactive (gnus-interactive "P\ny"))
2571 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
2573 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
2574 "Sort the group buffer by group score.
2575 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
2576 sort in reverse order."
2577 (interactive (gnus-interactive "P\ny"))
2578 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
2580 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
2581 "Sort the group buffer by group rank.
2582 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
2583 sort in reverse order."
2584 (interactive (gnus-interactive "P\ny"))
2585 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
2587 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
2588 "Sort the group buffer alphabetically by backend name.
2589 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
2590 sort in reverse order."
2591 (interactive (gnus-interactive "P\ny"))
2592 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
2594 ;;; Sorting predicates.
2596 (defun gnus-group-sort-by-alphabet (info1 info2)
2597 "Sort alphabetically."
2598 (string< (gnus-info-group info1) (gnus-info-group info2)))
2600 (defun gnus-group-sort-by-real-name (info1 info2)
2601 "Sort alphabetically on real (unprefixed) names."
2602 (string< (gnus-group-real-name (gnus-info-group info1))
2603 (gnus-group-real-name (gnus-info-group info2))))
2605 (defun gnus-group-sort-by-unread (info1 info2)
2606 "Sort by number of unread articles."
2607 (let ((n1 (car (gnus-gethash (gnus-info-group info1) gnus-newsrc-hashtb)))
2608 (n2 (car (gnus-gethash (gnus-info-group info2) gnus-newsrc-hashtb))))
2609 (< (or (and (numberp n1) n1) 0)
2610 (or (and (numberp n2) n2) 0))))
2612 (defun gnus-group-sort-by-level (info1 info2)
2614 (< (gnus-info-level info1) (gnus-info-level info2)))
2616 (defun gnus-group-sort-by-method (info1 info2)
2617 "Sort alphabetically by backend name."
2618 (string< (symbol-name (car (gnus-find-method-for-group
2619 (gnus-info-group info1) info1)))
2620 (symbol-name (car (gnus-find-method-for-group
2621 (gnus-info-group info2) info2)))))
2623 (defun gnus-group-sort-by-score (info1 info2)
2624 "Sort by group score."
2625 (< (gnus-info-score info1) (gnus-info-score info2)))
2627 (defun gnus-group-sort-by-rank (info1 info2)
2628 "Sort by level and score."
2629 (let ((level1 (gnus-info-level info1))
2630 (level2 (gnus-info-level info2)))
2631 (or (< level1 level2)
2632 (and (= level1 level2)
2633 (> (gnus-info-score info1) (gnus-info-score info2))))))
2637 (defun gnus-group-clear-data (&optional arg)
2638 "Clear all marks and read ranges from the current group."
2640 (gnus-group-iterate arg
2643 (gnus-info-clear-data (setq info (gnus-get-info group)))
2644 (gnus-get-unread-articles-in-group info (gnus-active group) t)
2645 (when (gnus-group-goto-group group)
2646 (gnus-group-update-group-line))))))
2648 (defun gnus-group-clear-data-on-native-groups ()
2649 "Clear all marks and read ranges from all native groups."
2651 (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
2652 (let ((alist (cdr gnus-newsrc-alist))
2654 (while (setq info (pop alist))
2655 (when (gnus-group-native-p (gnus-info-group info))
2656 (gnus-info-clear-data info)))
2657 (gnus-get-unread-articles)
2658 (gnus-dribble-touch)
2659 (when (gnus-y-or-n-p
2660 "Move the cache away to avoid problems in the future? ")
2661 (call-interactively 'gnus-cache-move-cache)))))
2663 (defun gnus-info-clear-data (info)
2664 "Clear all marks and read ranges from INFO."
2665 (let ((group (gnus-info-group info)))
2668 (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
2669 (gnus-info-set-read ',info ',(gnus-info-read info))
2670 (when (gnus-group-goto-group ,group)
2671 (gnus-group-update-group-line))))
2672 (gnus-info-set-read info nil)
2673 (when (gnus-info-marks info)
2674 (gnus-info-set-marks info nil))))
2676 ;; Group catching up.
2678 (defun gnus-group-catchup-current (&optional n all)
2679 "Mark all unread articles in the current newsgroup as read.
2680 If prefix argument N is numeric, the next N newsgroups will be
2681 caught up. If ALL is non-nil, marked articles will also be marked as
2682 read. Cross references (Xref: header) of articles are ignored.
2683 The number of newsgroups that this function was unable to catch
2686 (let ((groups (gnus-group-process-prefix n))
2689 (unless groups (error "No groups selected"))
2691 (or (not gnus-interactive-catchup) ;Without confirmation?
2696 "Do you really want to mark all articles in %s as read? "
2697 "Mark all unread articles in %s as read? ")
2698 (if (= (length groups) 1)
2700 (format "these %d groups" (length groups)))))))
2702 (while (setq group (pop groups))
2703 (gnus-group-remove-mark group)
2704 ;; Virtual groups have to be given special treatment.
2705 (let ((method (gnus-find-method-for-group group)))
2706 (when (eq 'nnvirtual (car method))
2707 (nnvirtual-catchup-group
2708 (gnus-group-real-name group) (nth 1 method) all)))
2709 (if (>= (gnus-group-level group) gnus-level-zombie)
2710 (gnus-message 2 "Dead groups can't be caught up")
2712 (gnus-group-goto-group group)
2713 (gnus-group-catchup group all))
2714 (gnus-group-update-group-line)
2715 (setq ret (1+ ret)))))
2716 (gnus-group-next-unread-group 1)
2719 (defun gnus-group-catchup-current-all (&optional n)
2720 "Mark all articles in current newsgroup as read.
2721 Cross references (Xref: header) of articles are ignored."
2723 (gnus-group-catchup-current n 'all))
2725 (defun gnus-group-catchup (group &optional all)
2726 "Mark all articles in GROUP as read.
2727 If ALL is non-nil, all articles are marked as read.
2728 The return value is the number of articles that were marked as read,
2729 or nil if no action could be taken."
2730 (let* ((entry (gnus-gethash group gnus-newsrc-hashtb))
2732 ;; Remove entries for this group.
2733 (nnmail-purge-split-history (gnus-group-real-name group))
2734 ;; Do the updating only if the newsgroup isn't killed.
2735 (if (not (numberp (car entry)))
2736 (gnus-message 1 "Can't catch up %s; non-active group" group)
2737 ;; Do auto-expirable marks if that's required.
2738 (when (gnus-group-auto-expirable-p group)
2739 (gnus-add-marked-articles
2740 group 'expire (gnus-list-of-unread-articles group))
2742 (let ((marks (nth 3 (nth 2 entry))))
2743 (gnus-add-marked-articles
2744 group 'expire (gnus-uncompress-range (cdr (assq 'tick marks))))
2745 (gnus-add-marked-articles
2746 group 'expire (gnus-uncompress-range (cdr (assq 'tick marks)))))))
2748 (gnus-update-read-articles group nil)
2749 ;; Also nix out the lists of marks and dormants.
2751 (gnus-add-marked-articles group 'tick nil nil 'force)
2752 (gnus-add-marked-articles group 'dormant nil nil 'force))
2753 (let ((gnus-newsgroup-name group))
2754 (gnus-run-hooks 'gnus-group-catchup-group-hook))
2757 (defun gnus-group-expire-articles (&optional n)
2758 "Expire all expirable articles in the current newsgroup."
2760 (let ((groups (gnus-group-process-prefix n))
2763 (error "No groups to expire"))
2764 (while (setq group (pop groups))
2765 (gnus-group-remove-mark group)
2766 (gnus-group-expire-articles-1 group)
2767 (gnus-dribble-touch)
2768 (gnus-group-position-point))))
2770 (defun gnus-group-expire-articles-1 (group)
2771 (when (gnus-check-backend-function 'request-expire-articles group)
2772 (gnus-message 6 "Expiring articles in %s..." group)
2773 (let* ((info (gnus-get-info group))
2774 (expirable (if (gnus-group-total-expirable-p group)
2775 (cons nil (gnus-list-of-read-articles group))
2776 (assq 'expire (gnus-info-marks info))))
2777 (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
2778 (nnmail-expiry-target
2779 (or (gnus-group-find-parameter group 'expiry-target)
2780 nnmail-expiry-target)))
2782 (gnus-check-group group)
2785 (gnus-compress-sequence
2787 ;; We set the expiry variables to the group
2789 (let ((nnmail-expiry-wait-function nil)
2790 (nnmail-expiry-wait expiry-wait))
2791 (gnus-request-expire-articles
2792 (gnus-uncompress-sequence (cdr expirable)) group))
2793 ;; Just expire using the normal expiry values.
2794 (gnus-request-expire-articles
2795 (gnus-uncompress-sequence (cdr expirable)) group))))
2796 (gnus-close-group group))
2797 (gnus-message 6 "Expiring articles in %s...done" group)
2798 ;; Return the list of un-expired articles.
2801 (defun gnus-group-expire-all-groups ()
2802 "Expire all expirable articles in all newsgroups."
2805 (gnus-message 5 "Expiring...")
2806 (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
2807 (cdr gnus-newsrc-alist))))
2808 (gnus-group-expire-articles nil)))
2809 (gnus-group-position-point)
2810 (gnus-message 5 "Expiring...done"))
2812 (defun gnus-group-set-current-level (n level)
2813 "Set the level of the next N groups to LEVEL."
2818 (let ((s (read-string
2819 (format "Level (default %s): "
2820 (or (gnus-group-group-level)
2821 gnus-level-default-subscribed)))))
2822 (if (string-match "^\\s-*$" s)
2823 (int-to-string (or (gnus-group-group-level)
2824 gnus-level-default-subscribed))
2826 (unless (and (>= level 1) (<= level gnus-level-killed))
2827 (error "Invalid level: %d" level))
2828 (let ((groups (gnus-group-process-prefix n))
2830 (while (setq group (pop groups))
2831 (gnus-group-remove-mark group)
2832 (gnus-message 6 "Changed level of %s from %d to %d"
2833 group (or (gnus-group-group-level) gnus-level-killed)
2835 (gnus-group-change-level
2836 group level (or (gnus-group-group-level) gnus-level-killed))
2837 (gnus-group-update-group-line)))
2838 (gnus-group-position-point))
2840 (defun gnus-group-unsubscribe (&optional n)
2841 "Unsubscribe the current group."
2843 (gnus-group-unsubscribe-current-group n 'unsubscribe))
2845 (defun gnus-group-subscribe (&optional n)
2846 "Subscribe the current group."
2848 (gnus-group-unsubscribe-current-group n 'subscribe))
2850 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
2851 "Toggle subscription of the current group.
2852 If given numerical prefix, toggle the N next groups."
2854 (let ((groups (gnus-group-process-prefix n))
2857 (setq group (car groups)
2858 groups (cdr groups))
2859 (gnus-group-remove-mark group)
2860 (gnus-group-unsubscribe-group
2863 ((eq do-sub 'unsubscribe)
2864 gnus-level-default-unsubscribed)
2865 ((eq do-sub 'subscribe)
2866 gnus-level-default-subscribed)
2867 ((<= (gnus-group-group-level) gnus-level-subscribed)
2868 gnus-level-default-unsubscribed)
2870 gnus-level-default-subscribed))
2872 (gnus-group-update-group-line))
2873 (gnus-group-next-group 1)))
2875 (defun gnus-group-unsubscribe-group (group &optional level silent)
2876 "Toggle subscription to GROUP.
2877 Killed newsgroups are subscribed. If SILENT, don't try to update the
2880 (list (completing-read
2881 "Group: " gnus-active-hashtb nil
2882 (gnus-read-active-file-p)
2884 'gnus-group-history)))
2885 (let ((newsrc (gnus-gethash group gnus-newsrc-hashtb)))
2887 ((string-match "^[ \t]*$" group)
2888 (error "Empty group name"))
2890 ;; Toggle subscription flag.
2891 (gnus-group-change-level
2892 newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
2893 gnus-level-subscribed)
2894 (1+ gnus-level-subscribed)
2895 gnus-level-default-subscribed)))
2897 (gnus-group-update-group group)))
2898 ((and (stringp group)
2899 (or (not (gnus-read-active-file-p))
2900 (gnus-active group)))
2901 ;; Add new newsgroup.
2902 (gnus-group-change-level
2904 (if level level gnus-level-default-subscribed)
2905 (or (and (member group gnus-zombie-list)
2908 (when (gnus-group-group-name)
2909 (gnus-gethash (gnus-group-group-name) gnus-newsrc-hashtb)))
2911 (gnus-group-update-group group)))
2912 (t (error "No such newsgroup: %s" group)))
2913 (gnus-group-position-point)))
2915 (defun gnus-group-transpose-groups (n)
2916 "Move the current newsgroup up N places.
2917 If given a negative prefix, move down instead. The difference between
2918 N and the number of steps taken is returned."
2920 (unless (gnus-group-group-name)
2921 (error "No group on current line"))
2922 (gnus-group-kill-group 1)
2924 (forward-line (- n))
2925 (gnus-group-yank-group)
2926 (gnus-group-position-point)))
2928 (defun gnus-group-kill-all-zombies (&optional dummy)
2929 "Kill all zombie newsgroups.
2930 The optional DUMMY should always be nil."
2931 (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
2933 (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
2934 (setq gnus-zombie-list nil)
2935 (gnus-dribble-touch)
2936 (gnus-group-list-groups)))
2938 (defun gnus-group-kill-region (begin end)
2939 "Kill newsgroups in current region (excluding current point).
2940 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
2955 (beginning-of-line) ;Important when LINES < 1
2956 (gnus-group-kill-group lines)))
2958 (defun gnus-group-kill-group (&optional n discard)
2959 "Kill the next N groups.
2960 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
2961 However, only groups that were alive can be yanked; already killed
2962 groups or zombie groups can't be yanked.
2963 The return value is the name of the group that was killed, or a list
2966 (let ((buffer-read-only nil)
2967 (groups (gnus-group-process-prefix n))
2968 group entry level out)
2969 (if (< (length groups) 10)
2970 ;; This is faster when there are few groups.
2972 (push (setq group (pop groups)) out)
2973 (gnus-group-remove-mark group)
2974 (setq level (gnus-group-group-level))
2976 (when (and (not discard)
2977 (setq entry (gnus-gethash group gnus-newsrc-hashtb)))
2980 (gnus-group-goto-group ,(gnus-group-group-name))
2981 (gnus-group-yank-group)))
2982 (push (cons (car entry) (nth 2 entry))
2983 gnus-list-of-killed-groups))
2984 (gnus-group-change-level
2985 (if entry entry group) gnus-level-killed (if entry nil level))
2986 (message "Killed group %s" group))
2987 ;; If there are lots and lots of groups to be killed, we use
2988 ;; this thing instead.
2990 (setq groups (nreverse groups))
2992 (gnus-group-remove-mark (setq group (pop groups)))
2994 (push group gnus-killed-list)
2995 (setq gnus-newsrc-alist
2996 (delq (assoc group gnus-newsrc-alist)
2998 (when gnus-group-change-level-function
2999 (funcall gnus-group-change-level-function
3000 group gnus-level-killed 3))
3002 ((setq entry (gnus-gethash group gnus-newsrc-hashtb))
3003 (push (cons (car entry) (nth 2 entry))
3004 gnus-list-of-killed-groups)
3005 (setcdr (cdr entry) (cdddr entry)))
3006 ((member group gnus-zombie-list)
3007 (setq gnus-zombie-list (delete group gnus-zombie-list))))
3008 ;; There may be more than one instance displayed.
3009 (while (gnus-group-goto-group group)
3010 (gnus-delete-line)))
3011 (gnus-make-hashtable-from-newsrc-alist)))
3013 (gnus-group-position-point)
3014 (if (< (length out) 2) (car out) (nreverse out))))
3016 (defun gnus-group-yank-group (&optional arg)
3017 "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3018 The numeric ARG specifies how many newsgroups are to be yanked. The
3019 name of the newsgroup yanked is returned, or (if several groups are
3020 yanked) a list of yanked groups is returned."
3022 (setq arg (or arg 1))
3023 (let (info group prev out)
3024 (while (>= (decf arg) 0)
3025 (when (not (setq info (pop gnus-list-of-killed-groups)))
3026 (error "No more newsgroups to yank"))
3027 (push (setq group (nth 1 info)) out)
3028 ;; Find which newsgroup to insert this one before - search
3029 ;; backward until something suitable is found. If there are no
3030 ;; other newsgroups in this buffer, just make this newsgroup the
3032 (setq prev (gnus-group-group-name))
3033 (gnus-group-change-level
3034 info (gnus-info-level (cdr info)) gnus-level-killed
3035 (and prev (gnus-gethash prev gnus-newsrc-hashtb))
3037 (gnus-group-insert-group-line-info group)
3039 `(when (gnus-group-goto-group ,group)
3040 (gnus-group-kill-group 1))))
3042 (gnus-group-position-point)
3043 (if (< (length out) 2) (car out) (nreverse out))))
3045 (defun gnus-group-kill-level (level)
3046 "Kill all groups that is on a certain LEVEL."
3047 (interactive "nKill all groups on level: ")
3049 ((= level gnus-level-zombie)
3050 (setq gnus-killed-list
3051 (nconc gnus-zombie-list gnus-killed-list))
3052 (setq gnus-zombie-list nil))
3053 ((and (< level gnus-level-zombie)
3055 (or gnus-expert-user
3058 "Do you really want to kill all groups on level %d? "
3060 (let* ((prev gnus-newsrc-alist)
3063 (if (= (gnus-info-level (car alist)) level)
3065 (push (gnus-info-group (car alist)) gnus-killed-list)
3066 (setcdr prev (cdr alist)))
3068 (setq alist (cdr alist)))
3069 (gnus-make-hashtable-from-newsrc-alist)
3070 (gnus-group-list-groups)))
3072 (error "Can't kill; invalid level: %d" level))))
3074 (defun gnus-group-list-all-groups (&optional arg)
3075 "List all newsgroups with level ARG or lower.
3076 Default is gnus-level-unsubscribed, which lists all subscribed and most
3077 unsubscribed groups."
3079 (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3081 ;; Redefine this to list ALL killed groups if prefix arg used.
3082 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3083 (defun gnus-group-list-killed (&optional arg)
3084 "List all killed newsgroups in the group buffer.
3085 If ARG is non-nil, list ALL killed groups known to Gnus. This may
3086 entail asking the server for the groups."
3088 ;; Find all possible killed newsgroups if arg.
3090 (gnus-get-killed-groups))
3091 (if (not gnus-killed-list)
3092 (gnus-message 6 "No killed groups")
3093 (let (gnus-group-list-mode)
3094 (funcall gnus-group-prepare-function
3095 gnus-level-killed t gnus-level-killed))
3096 (goto-char (point-min)))
3097 (gnus-group-position-point))
3099 (defun gnus-group-list-zombies ()
3100 "List all zombie newsgroups in the group buffer."
3102 (if (not gnus-zombie-list)
3103 (gnus-message 6 "No zombie groups")
3104 (let (gnus-group-list-mode)
3105 (funcall gnus-group-prepare-function
3106 gnus-level-zombie t gnus-level-zombie))
3107 (goto-char (point-min)))
3108 (gnus-group-position-point))
3110 (defun gnus-group-list-active ()
3111 "List all groups that are available from the server(s)."
3113 ;; First we make sure that we have really read the active file.
3114 (unless (gnus-read-active-file-p)
3115 (let ((gnus-read-active-file t)
3116 (gnus-agent nil)) ; Trick the agent into ignoring the active file.
3117 (gnus-read-active-file)))
3118 ;; Find all groups and sort them.
3126 (push (symbol-name sym) list)))
3130 (buffer-read-only nil)
3134 (setq group (pop groups))
3135 (gnus-add-text-properties
3136 (point) (prog1 (1+ (point))
3138 (gnus-group-name-decode group
3139 (gnus-group-name-charset
3142 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3144 'gnus-level (inline (gnus-group-level group)))))
3145 (goto-char (point-min))))
3147 (defun gnus-activate-all-groups (level)
3148 "Activate absolutely all groups."
3149 (interactive (list gnus-level-unsubscribed))
3150 (let ((gnus-activate-level level)
3151 (gnus-activate-foreign-newsgroups level))
3152 (gnus-group-get-new-news)))
3154 (defun gnus-group-get-new-news (&optional arg)
3155 "Get newly arrived articles.
3156 If ARG is a number, it specifies which levels you are interested in
3157 re-scanning. If ARG is non-nil and not a number, this will force
3158 \"hard\" re-reading of the active files from all servers."
3161 (let ((gnus-inhibit-demon t)
3162 ;; Binding this variable will inhibit multiple fetchings
3163 ;; of the same mail source.
3164 (nnmail-fetched-sources (list t)))
3165 (gnus-run-hooks 'gnus-get-new-news-hook)
3167 ;; Read any slave files.
3169 (gnus-master-read-slave-newsrc))
3171 ;; We might read in new NoCeM messages here.
3172 (when (and gnus-use-nocem
3174 (gnus-nocem-scan-groups))
3175 ;; If ARG is not a number, then we read the active file.
3176 (when (and arg (not (numberp arg)))
3177 (let ((gnus-read-active-file t))
3178 (gnus-read-active-file))
3181 ;; If the user wants it, we scan for new groups.
3182 (when (eq gnus-check-new-newsgroups 'always)
3183 (gnus-find-new-newsgroups)))
3185 (setq arg (gnus-group-default-level arg t))
3186 (if (and gnus-read-active-file (not arg))
3188 (gnus-read-active-file)
3189 (gnus-get-unread-articles arg))
3190 (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
3191 (gnus-get-unread-articles arg)))
3192 (gnus-run-hooks 'gnus-after-getting-new-news-hook)
3193 (gnus-group-list-groups (and (numberp arg)
3194 (max (car gnus-group-list-mode) arg)))))
3196 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
3197 "Check for newly arrived news in the current group (and the N-1 next groups).
3198 The difference between N and the number of newsgroup checked is returned.
3199 If N is negative, this group and the N-1 previous groups will be checked."
3201 (let* ((groups (gnus-group-process-prefix n))
3202 (ret (if (numberp n) (- n (length groups)) 0))
3206 (gnus-inhibit-demon t)
3207 ;; Binding this variable will inhibit multiple fetchings
3208 ;; of the same mail source.
3209 (nnmail-fetched-sources (list t)))
3210 (gnus-run-hooks 'gnus-get-new-news-hook)
3211 (while (setq group (pop groups))
3212 (gnus-group-remove-mark group)
3213 ;; Bypass any previous denials from the server.
3214 (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
3215 (if (gnus-activate-group group (if dont-scan nil 'scan))
3217 (gnus-get-unread-articles-in-group
3218 (gnus-get-info group) (gnus-active group) t)
3219 (unless (gnus-virtual-group-p group)
3220 (gnus-close-group group))
3222 (gnus-agent-save-group-info
3223 method (gnus-group-real-name group) (gnus-active group)))
3224 (gnus-group-update-group group))
3225 (if (eq (gnus-server-status (gnus-find-method-for-group group))
3227 (gnus-error 3 "Server denied access")
3228 (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3231 (when gnus-goto-next-group-when-activating
3232 (gnus-group-next-unread-group 1 t))
3233 (gnus-summary-position-point)
3236 (defun gnus-group-fetch-faq (group &optional faq-dir)
3237 "Fetch the FAQ for the current group.
3238 If given a prefix argument, prompt for the FAQ dir
3242 (gnus-group-group-name)
3243 (when current-prefix-arg
3245 "Faq dir: " (and (listp gnus-group-faq-directory)
3246 (mapcar (lambda (file) (list file))
3247 gnus-group-faq-directory))))))
3249 (error "No group name given"))
3250 (let ((dirs (or faq-dir gnus-group-faq-directory))
3252 (unless (listp dirs)
3253 (setq dirs (list dirs)))
3254 (while (and (not found)
3255 (setq dir (pop dirs)))
3256 (let ((name (gnus-group-real-name group)))
3257 (setq file (concat (file-name-as-directory dir) name)))
3258 (if (not (file-exists-p file))
3259 (gnus-message 1 "No such file: %s" file)
3260 (let ((enable-local-variables nil))
3264 (defun gnus-group-describe-group (force &optional group)
3265 "Display a description of the current newsgroup."
3266 (interactive (list current-prefix-arg (gnus-group-group-name)))
3267 (let* ((method (gnus-find-method-for-group group))
3268 (mname (gnus-group-prefixed-name "" method))
3271 gnus-description-hashtb)
3272 (gnus-sethash mname nil gnus-description-hashtb))
3274 (error "No group name given"))
3275 (when (or (and gnus-description-hashtb
3276 ;; We check whether this group's method has been
3277 ;; queried for a description file.
3278 (gnus-gethash mname gnus-description-hashtb))
3279 (setq desc (gnus-group-get-description group))
3280 (gnus-read-descriptions-file method))
3282 (or desc (gnus-gethash group gnus-description-hashtb)
3283 "No description available")))))
3285 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3286 (defun gnus-group-describe-all-groups (&optional force)
3287 "Pop up a buffer with descriptions of all newsgroups."
3290 (setq gnus-description-hashtb nil))
3291 (when (not (or gnus-description-hashtb
3292 (gnus-read-all-descriptions-files)))
3293 (error "Couldn't request descriptions file"))
3294 (let ((buffer-read-only nil)
3300 (let ((charset (gnus-group-name-charset nil (symbol-name group))))
3301 (insert (format " *: %-20s %s\n"
3302 (gnus-group-name-decode
3303 (symbol-name group) charset)
3304 (gnus-group-name-decode
3305 (symbol-value group) charset))))
3306 (gnus-add-text-properties
3307 b (1+ b) (list 'gnus-group group
3308 'gnus-unread t 'gnus-marked nil
3309 'gnus-level (1+ gnus-level-subscribed))))
3310 gnus-description-hashtb)
3311 (goto-char (point-min))
3312 (gnus-group-position-point)))
3314 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
3315 (defun gnus-group-apropos (regexp &optional search-description)
3316 "List all newsgroups that have names that match a regexp."
3317 (interactive "sGnus apropos (regexp): ")
3319 (obuf (current-buffer))
3321 ;; Go through all newsgroups that are known to Gnus.
3324 (and (symbol-name group)
3325 (string-match regexp (symbol-name group))
3326 (symbol-value group)
3327 (push (symbol-name group) groups)))
3329 ;; Also go through all descriptions that are known to Gnus.
3330 (when search-description
3333 (and (string-match regexp (symbol-value group))
3334 (push (symbol-name group) groups)))
3335 gnus-description-hashtb))
3337 (gnus-message 3 "No groups matched \"%s\"." regexp)
3338 ;; Print out all the groups.
3340 (pop-to-buffer "*Gnus Help*")
3341 (buffer-disable-undo)
3343 (setq groups (sort groups 'string<))
3345 ;; Groups may be entered twice into the list of groups.
3346 (when (not (string= (car groups) prev))
3347 (setq prev (car groups))
3348 (let ((charset (gnus-group-name-charset nil prev)))
3349 (insert (gnus-group-name-decode prev charset) "\n")
3350 (when (and gnus-description-hashtb
3351 (setq des (gnus-gethash (car groups)
3352 gnus-description-hashtb)))
3353 (insert " " (gnus-group-name-decode des charset) "\n"))))
3354 (setq groups (cdr groups)))
3355 (goto-char (point-min))))
3356 (pop-to-buffer obuf)))
3358 (defun gnus-group-description-apropos (regexp)
3359 "List all newsgroups that have names or descriptions that match a regexp."
3360 (interactive "sGnus description apropos (regexp): ")
3361 (when (not (or gnus-description-hashtb
3362 (gnus-read-all-descriptions-files)))
3363 (error "Couldn't request descriptions file"))
3364 (gnus-group-apropos regexp t))
3366 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3367 (defun gnus-group-list-matching (level regexp &optional all lowest)
3368 "List all groups with unread articles that match REGEXP.
3369 If the prefix LEVEL is non-nil, it should be a number that says which
3370 level to cut off listing groups.
3371 If ALL, also list groups with no unread articles.
3372 If LOWEST, don't list groups with level lower than LOWEST.
3374 This command may read the active file."
3375 (interactive "P\nsList newsgroups matching: ")
3376 ;; First make sure active file has been read.
3378 (> (prefix-numeric-value level) gnus-level-killed))
3379 (gnus-get-killed-groups))
3380 (gnus-group-prepare-flat
3381 (or level gnus-level-subscribed) all (or lowest 1) regexp)
3382 (goto-char (point-min))
3383 (gnus-group-position-point))
3385 (defun gnus-group-list-all-matching (level regexp &optional lowest)
3386 "List all groups that match REGEXP.
3387 If the prefix LEVEL is non-nil, it should be a number that says which
3388 level to cut off listing groups.
3389 If LOWEST, don't list groups with level lower than LOWEST."
3390 (interactive "P\nsList newsgroups matching: ")
3392 (setq level (prefix-numeric-value level)))
3393 (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
3395 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
3396 (defun gnus-group-save-newsrc (&optional force)
3397 "Save the Gnus startup files.
3398 If FORCE, force saving whether it is necessary or not."
3400 (gnus-save-newsrc-file force))
3402 (defun gnus-group-restart (&optional arg)
3403 "Force Gnus to read the .newsrc file."
3405 (when (gnus-yes-or-no-p
3406 (format "Are you sure you want to restart Gnus? "))
3407 (gnus-save-newsrc-file)
3411 (defun gnus-group-read-init-file ()
3412 "Read the Gnus elisp init file."
3414 (gnus-read-init-file)
3415 (gnus-message 5 "Read %s" gnus-init-file))
3417 (defun gnus-group-check-bogus-groups (&optional silent)
3418 "Check bogus newsgroups.
3419 If given a prefix, don't ask for confirmation before removing a bogus
3422 (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
3423 (gnus-group-list-groups))
3425 (defun gnus-group-find-new-groups (&optional arg)
3426 "Search for new groups and add them.
3427 Each new group will be treated with `gnus-subscribe-newsgroup-method.'
3428 With 1 C-u, use the `ask-server' method to query the server for new
3430 With 2 C-u's, use most complete method possible to query the server
3431 for new groups, and subscribe the new groups as zombies."
3433 (gnus-find-new-newsgroups (or arg 1))
3434 (gnus-group-list-groups))
3436 (defun gnus-group-edit-global-kill (&optional article group)
3437 "Edit the global kill file.
3438 If GROUP, edit that local kill file instead."
3440 (setq gnus-current-kill-article article)
3441 (gnus-kill-file-edit-file group)
3444 (substitute-command-keys
3445 (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
3446 (if group "local" "global")))))
3448 (defun gnus-group-edit-local-kill (article group)
3449 "Edit a local kill file."
3450 (interactive (list nil (gnus-group-group-name)))
3451 (gnus-group-edit-global-kill article group))
3453 (defun gnus-group-force-update ()
3454 "Update `.newsrc' file."
3456 (gnus-save-newsrc-file))
3458 (defun gnus-group-suspend ()
3459 "Suspend the current Gnus session.
3460 In fact, cleanup buffers except for group mode buffer.
3461 The hook gnus-suspend-gnus-hook is called before actually suspending."
3463 (gnus-run-hooks 'gnus-suspend-gnus-hook)
3464 ;; Kill Gnus buffers except for group mode buffer.
3465 (let ((group-buf (get-buffer gnus-group-buffer)))
3466 (mapcar (lambda (buf)
3467 (unless (member buf (list group-buf gnus-dribble-buffer))
3470 (gnus-kill-gnus-frames)
3472 (bury-buffer group-buf)
3473 (delete-windows-on group-buf t))))
3475 (defun gnus-group-clear-dribble ()
3476 "Clear all information from the dribble buffer."
3478 (gnus-dribble-clear)
3479 (gnus-message 7 "Cleared dribble buffer"))
3481 (defun gnus-group-exit ()
3482 "Quit reading news after updating .newsrc.eld and .newsrc.
3483 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3486 (or noninteractive ;For gnus-batch-kill
3487 (not gnus-interactive-exit) ;Without confirmation
3489 (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
3490 (gnus-run-hooks 'gnus-exit-gnus-hook)
3491 ;; Offer to save data from non-quitted summary buffers.
3492 (gnus-offer-save-summaries)
3493 ;; Save the newsrc file(s).
3494 (gnus-save-newsrc-file)
3496 (gnus-close-backends)
3497 ;; Reset everything.
3499 ;; Allow the user to do things after cleaning up.
3500 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
3502 (defun gnus-group-quit ()
3503 "Quit reading news without updating .newsrc.eld or .newsrc.
3504 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3506 (when (or noninteractive ;For gnus-batch-kill
3507 (zerop (buffer-size))
3508 (not (gnus-server-opened gnus-select-method))
3510 (not gnus-current-startup-file)
3512 (format "Quit reading news without saving %s? "
3513 (file-name-nondirectory gnus-current-startup-file))))
3514 (gnus-run-hooks 'gnus-exit-gnus-hook)
3515 (gnus-configure-windows 'group t)
3517 (gnus-close-backends)
3519 (gnus-kill-buffer gnus-group-buffer)
3520 ;; Allow the user to do things after cleaning up.
3521 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
3523 (defun gnus-group-describe-briefly ()
3524 "Give a one line description of the group mode commands."
3526 (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")))
3528 (defun gnus-group-browse-foreign-server (method)
3529 "Browse a foreign news server.
3530 If called interactively, this function will ask for a select method
3531 (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
3532 If not, METHOD should be a list where the first element is the method
3533 and the second element is the address."
3535 (list (let ((how (completing-read
3537 (append gnus-valid-select-methods gnus-server-alist)
3538 nil t (cons "nntp" 0) 'gnus-method-history)))
3539 ;; We either got a backend name or a virtual server name.
3540 ;; If the first, we also need an address.
3541 (if (assoc how gnus-valid-select-methods)
3543 ;; Suggested by mapjph@bath.ac.uk.
3546 (mapcar (lambda (server) (list server))
3547 gnus-secondary-servers)))
3548 ;; We got a server name.
3550 (gnus-browse-foreign-server method))
3552 (defun gnus-group-set-info (info &optional method-only-group part)
3553 (when (or info part)
3554 (let* ((entry (gnus-gethash
3555 (or method-only-group (gnus-info-group info))
3556 gnus-newsrc-hashtb))
3558 (info (if method-only-group (nth 2 entry) info))
3560 (when method-only-group
3562 (error "Trying to change non-existent group %s" method-only-group))
3563 ;; We have received parts of the actual group info - either the
3564 ;; select method or the group parameters. We first check
3565 ;; whether we have to extend the info, and if so, do that.
3566 (let ((len (length info))
3567 (total (if (eq part 'method) 5 6)))
3569 (setcdr (nthcdr (1- len) info)
3570 (make-list (- total len) nil)))
3571 ;; Then we enter the new info.
3572 (setcar (nthcdr (1- total) info) part-info)))
3574 ;; This is a new group, so we just create it.
3576 (set-buffer gnus-group-buffer)
3577 (setq method (gnus-info-method info))
3578 (when (gnus-server-equal method "native")
3581 (set-buffer gnus-group-buffer)
3583 ;; It's a foreign group...
3584 (gnus-group-make-group
3585 (gnus-group-real-name (gnus-info-group info))
3586 (if (stringp method) method
3587 (prin1-to-string (car method)))
3589 (nth 1 (gnus-info-method info))))
3590 ;; It's a native group.
3591 (gnus-group-make-group (gnus-info-group info))))
3592 (gnus-message 6 "Note: New group created")
3594 (gnus-gethash (gnus-group-prefixed-name
3595 (gnus-group-real-name (gnus-info-group info))
3596 (or (gnus-info-method info) gnus-select-method))
3597 gnus-newsrc-hashtb))))
3598 ;; Whether it was a new group or not, we now have the entry, so we
3599 ;; can do the update.
3602 (setcar (nthcdr 2 entry) info)
3603 (when (and (not (eq (car entry) t))
3604 (gnus-active (gnus-info-group info)))
3605 (setcar entry (length (gnus-list-of-unread-articles (car info))))))
3606 (error "No such group: %s" (gnus-info-group info))))))
3608 (defun gnus-group-set-method-info (group select-method)
3609 (gnus-group-set-info select-method group 'method))
3611 (defun gnus-group-set-params-info (group params)
3612 (gnus-group-set-info params group 'params))
3614 (defun gnus-add-marked-articles (group type articles &optional info force)
3615 ;; Add ARTICLES of TYPE to the info of GROUP.
3616 ;; If INFO is non-nil, use that info. If FORCE is non-nil, don't
3617 ;; add, but replace marked articles of TYPE with ARTICLES.
3618 (let ((info (or info (gnus-get-info group)))
3621 (and (not (setq marked (nthcdr 3 info)))
3623 (setcdr (nthcdr 2 info)
3624 (list (list (cons type (gnus-compress-sequence
3626 (and (not (setq m (assq type (car marked))))
3629 (cons (cons type (gnus-compress-sequence articles t) )
3633 (setcar (nthcdr 3 info)
3634 (gnus-delete-alist type (car marked)))
3635 (setcdr m (gnus-compress-sequence articles t)))
3636 (setcdr m (gnus-compress-sequence
3637 (sort (nconc (gnus-uncompress-range (cdr m))
3638 (copy-sequence articles)) '<) t))))))
3641 ;;; Group timestamps
3644 (defun gnus-group-set-timestamp ()
3645 "Change the timestamp of the current group to the current time.
3646 This function can be used in hooks like `gnus-select-group-hook'
3647 or `gnus-group-catchup-group-hook'."
3648 (when gnus-newsgroup-name
3649 (let ((time (current-time)))
3650 (setcdr (cdr time) nil)
3651 (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
3653 (defsubst gnus-group-timestamp (group)
3654 "Return the timestamp for GROUP."
3655 (gnus-group-get-parameter group 'timestamp t))
3657 (defun gnus-group-timestamp-delta (group)
3658 "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
3659 (let* ((time (or (gnus-group-timestamp group)
3661 (delta (subtract-time (current-time) time)))
3662 (+ (* (nth 0 delta) 65536.0)
3665 (defun gnus-group-timestamp-string (group)
3666 "Return a string of the timestamp for GROUP."
3667 (let ((time (gnus-group-timestamp group)))
3670 (gnus-time-iso8601 time))))
3672 (defun gnus-group-prepare-flat-list-dead-predicate
3673 (groups level mark predicate)
3676 ;; This loop is used when listing groups that match some
3678 (while (setq group (pop groups))
3679 (when (funcall predicate group)
3680 (gnus-add-text-properties
3681 (point) (prog1 (1+ (point))
3682 (insert " " mark " *: "
3683 (gnus-group-name-decode group
3684 (gnus-group-name-charset
3687 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3689 'gnus-level level)))))))
3691 (defun gnus-group-prepare-flat-predicate (level predicate &optional lowest
3693 "List all newsgroups with unread articles of level LEVEL or lower.
3694 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
3695 If PREDICATE, only list groups which PREDICATE returns non-nil.
3696 If DEAD-PREDICATE, list dead groups which DEAD-PREDICATE returns non-nil."
3697 (set-buffer gnus-group-buffer)
3698 (let ((buffer-read-only nil)
3699 (newsrc (cdr gnus-newsrc-alist))
3700 (lowest (or lowest 1))
3701 info clevel unread group params)
3703 ;; List living groups.
3705 (setq info (car newsrc)
3706 group (gnus-info-group info)
3707 params (gnus-info-params info)
3709 unread (car (gnus-gethash group gnus-newsrc-hashtb)))
3710 (and unread ; This group might be unchecked
3711 (funcall predicate info)
3712 (<= (setq clevel (gnus-info-level info)) level)
3714 (gnus-group-insert-group-line
3715 group (gnus-info-level info)
3716 (gnus-info-marks info) unread (gnus-info-method info))))
3718 ;; List dead groups.
3719 (and (>= level gnus-level-zombie) (<= lowest gnus-level-zombie)
3720 (gnus-group-prepare-flat-list-dead-predicate
3721 (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
3722 gnus-level-zombie ?Z
3724 (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)
3725 (gnus-group-prepare-flat-list-dead-predicate
3726 (setq gnus-killed-list (sort gnus-killed-list 'string<))
3727 gnus-level-killed ?K dead-predicate))
3729 (gnus-group-set-mode-line)
3730 (setq gnus-group-list-mode (cons level t))
3731 (gnus-run-hooks 'gnus-group-prepare-hook)
3734 (defun gnus-group-list-cached (level &optional lowest)
3735 "List all groups with cached articles.
3736 If the prefix LEVEL is non-nil, it should be a number that says which
3737 level to cut off listing groups.
3738 If LOWEST, don't list groups with level lower than LOWEST.
3740 This command may read the active file."
3743 (setq level (prefix-numeric-value level)))
3744 (when (or (not level) (>= level gnus-level-zombie))
3746 (gnus-group-prepare-flat-predicate (or level gnus-level-subscribed)
3748 (let ((marks (gnus-info-marks info)))
3749 (assq 'cache marks)))
3752 (or (gnus-gethash group
3753 gnus-cache-active-hashtb)
3754 ;; Cache active file might use "."
3757 (mapconcat 'identity
3758 (split-string group ":")
3760 gnus-cache-active-hashtb))))
3761 (goto-char (point-min))
3762 (gnus-group-position-point))
3764 (defun gnus-group-list-dormant (level &optional lowest)
3765 "List all groups with dormant articles.
3766 If the prefix LEVEL is non-nil, it should be a number that says which
3767 level to cut off listing groups.
3768 If LOWEST, don't list groups with level lower than LOWEST.
3770 This command may read the active file."
3773 (setq level (prefix-numeric-value level)))
3774 (when (or (not level) (>= level gnus-level-zombie))
3776 (gnus-group-prepare-flat-predicate (or level gnus-level-subscribed)
3778 (let ((marks (gnus-info-marks info)))
3779 (assq 'dormant marks)))
3781 (goto-char (point-min))
3782 (gnus-group-position-point))
3784 (provide 'gnus-group)
3786 ;;; gnus-group.el ends here