1 ;;; gnus-group.el --- group mode commands for Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
32 (defvar tool-bar-mode))
48 (let ((features (cons 'gnus-group features)))
50 (unless (boundp 'gnus-cache-active-hashtb)
51 (defvar gnus-cache-active-hashtb nil)))
53 (autoload 'gnus-agent-total-fetched-for "gnus-agent")
54 (autoload 'gnus-cache-total-fetched-for "gnus-cache")
56 (defcustom gnus-group-archive-directory
57 "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
58 "*The address of the (ding) archives."
59 :group 'gnus-group-foreign
62 (defcustom gnus-group-recent-archive-directory
63 "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list-recent/"
64 "*The address of the most recent (ding) articles."
65 :group 'gnus-group-foreign
68 (defcustom gnus-no-groups-message "No Gnus is good news"
69 "*Message displayed by Gnus when no groups are available."
73 (defcustom gnus-keep-same-level nil
74 "*Non-nil means that the next newsgroup after the current will be on the same level.
75 When you type, for instance, `n' after reading the last article in the
76 current newsgroup, you will go to the next newsgroup. If this variable
77 is nil, the next newsgroup will be the next from the group
79 If this variable is non-nil, Gnus will either put you in the
80 next newsgroup with the same level, or, if no such newsgroup is
81 available, the next newsgroup with the lowest possible level higher
82 than the current level.
83 If this variable is `best', Gnus will make the next newsgroup the one
85 :group 'gnus-group-levels
86 :type '(choice (const nil)
88 (sexp :tag "other" t)))
90 (defcustom gnus-group-goto-unread t
91 "*If non-nil, movement commands will go to the next unread and subscribed group."
92 :link '(custom-manual "(gnus)Group Maneuvering")
93 :group 'gnus-group-various
96 (defcustom gnus-goto-next-group-when-activating t
97 "*If non-nil, the \\<gnus-group-mode-map>\\[gnus-group-get-new-news-this-group] command will advance point to the next group."
98 :link '(custom-manual "(gnus)Scanning New Messages")
99 :group 'gnus-group-various
102 (defcustom gnus-permanently-visible-groups nil
103 "*Regexp to match groups that should always be listed in the group buffer.
104 This means that they will still be listed even when there are no
105 unread articles in the groups.
107 If nil, no groups are permanently visible."
108 :group 'gnus-group-listing
109 :type '(choice regexp (const nil)))
111 (defcustom gnus-list-groups-with-ticked-articles t
112 "*If non-nil, list groups that have only ticked articles.
113 If nil, only list groups that have unread articles."
114 :group 'gnus-group-listing
117 (defcustom gnus-group-default-list-level gnus-level-subscribed
118 "*Default listing level.
119 Ignored if `gnus-group-use-permanent-levels' is non-nil."
120 :group 'gnus-group-listing
123 (defcustom gnus-group-list-inactive-groups t
124 "*If non-nil, inactive groups will be listed."
125 :group 'gnus-group-listing
126 :group 'gnus-group-levels
129 (defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
130 "*Function used for sorting the group buffer.
131 This function will be called with group info entries as the arguments
132 for the groups to be sorted. Pre-made functions include
133 `gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
134 `gnus-group-sort-by-unread', `gnus-group-sort-by-level',
135 `gnus-group-sort-by-score', `gnus-group-sort-by-method',
136 `gnus-group-sort-by-server', and `gnus-group-sort-by-rank'.
138 This variable can also be a list of sorting functions. In that case,
139 the most significant sort function should be the last function in the
141 :group 'gnus-group-listing
142 :link '(custom-manual "(gnus)Sorting Groups")
143 :type '(repeat :value-to-internal (lambda (widget value)
144 (if (listp value) value (list value)))
145 :match (lambda (widget value)
147 (widget-editable-list-match widget value)))
148 (choice (function-item gnus-group-sort-by-alphabet)
149 (function-item gnus-group-sort-by-real-name)
150 (function-item gnus-group-sort-by-unread)
151 (function-item gnus-group-sort-by-level)
152 (function-item gnus-group-sort-by-score)
153 (function-item gnus-group-sort-by-method)
154 (function-item gnus-group-sort-by-server)
155 (function-item gnus-group-sort-by-rank)
156 (function :tag "other" nil))))
158 (defcustom gnus-group-line-format "%M\%S\%p\%P\%5y:%B%(%g%)%O\n"
159 "*Format of group lines.
160 It works along the same lines as a normal formatting string,
161 with some simple extensions.
163 %M Only marked articles (character, \"*\" or \" \")
164 %S Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
165 %L Level of subscribedness (integer)
166 %N Number of unread articles (integer)
167 %I Number of dormant articles (integer)
168 %i Number of ticked and dormant (integer)
169 %T Number of ticked articles (integer)
170 %R Number of read articles (integer)
171 %U Number of unseen articles (integer)
172 %t Estimated total number of articles (integer)
173 %y Number of unread, unticked articles (integer)
174 %G Group name (string)
175 %g Qualified group name (string)
176 %c Short (collapsed) group name. See `gnus-group-uncollapsed-levels'.
177 %C Group comment (string)
178 %D Group description (string)
179 %s Select method (string)
180 %o Moderated group (char, \"m\")
181 %p Process mark (char)
182 %B Whether a summary buffer for the group is open (char, \"*\")
183 %O Moderated group (string, \"(m)\" or \"\")
184 %P Topic indentation (string)
185 %m Whether there is new(ish) mail in the group (char, \"%\")
186 %n Select from where (string)
187 %z A string that look like `<%s:%n>' if a foreign select method is used
188 %d The date the group was last entered.
189 %E Icon as defined by `gnus-group-icon-list'.
190 %F The disk space used by the articles fetched by both the cache and agent.
191 %u User defined specifier. The next character in the format string should
192 be a letter. Gnus will call the function gnus-user-format-function-X,
193 where X is the letter following %u. The function will be passed a
194 single dummy parameter as argument. The function should return a
195 string, which will be inserted into the buffer just like information
196 from any other group specifier.
198 Note that this format specification is not always respected. For
199 reasons of efficiency, when listing killed groups, this specification
200 is ignored altogether. If the spec is changed considerably, your
201 output may end up looking strange when listing both alive and killed
204 If you use %o or %O, reading the active file will be slower and quite
205 a bit of extra memory will be used. %D and %F will also worsen
206 performance. Also note that if you change the format specification to
207 include any of these specs, you must probably re-start Gnus to see
210 General format specifiers can also be used.
211 See Info node `(gnus)Formatting Variables'."
212 :link '(custom-manual "(gnus)Formatting Variables")
213 :group 'gnus-group-visual
216 (defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
217 "*The format specification for the group mode line.
218 It works along the same lines as a normal formatting string,
219 with some simple extensions:
221 %S The native news server.
222 %M The native select method.
223 %: \":\" if %S isn't \"\"."
224 :group 'gnus-group-visual
227 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
228 (when (featurep 'xemacs)
229 (add-hook 'gnus-group-mode-hook 'gnus-xmas-group-menu-add)
230 (add-hook 'gnus-group-mode-hook 'gnus-xmas-setup-group-toolbar))
232 (defcustom gnus-group-menu-hook nil
233 "Hook run after the creation of the group mode menu."
234 :group 'gnus-group-various
237 (defcustom gnus-group-catchup-group-hook nil
238 "Hook run when catching up a group from the group buffer."
239 :group 'gnus-group-various
240 :link '(custom-manual "(gnus)Group Data")
243 (defcustom gnus-group-update-group-hook nil
244 "Hook called when updating group lines."
245 :group 'gnus-group-visual
248 (defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
249 "*A function that is called to generate the group buffer.
250 The function is called with three arguments: The first is a number;
251 all group with a level less or equal to that number should be listed,
252 if the second is non-nil, empty groups should also be displayed. If
253 the third is non-nil, it is a number. No groups with a level lower
254 than this number should be displayed.
256 The only current function implemented is `gnus-group-prepare-flat'."
257 :group 'gnus-group-listing
260 (defcustom gnus-group-prepare-hook nil
261 "Hook called after the group buffer has been generated.
262 If you want to modify the group buffer, you can use this hook."
263 :group 'gnus-group-listing
266 (defcustom gnus-suspend-gnus-hook nil
267 "Hook called when suspending (not exiting) Gnus."
271 (defcustom gnus-exit-gnus-hook nil
272 "Hook called when exiting Gnus."
276 (defcustom gnus-after-exiting-gnus-hook nil
277 "Hook called after exiting Gnus."
281 (defcustom gnus-group-update-hook '(gnus-group-highlight-line)
282 "Hook called when a group line is changed.
283 The hook will not be called if `gnus-visual' is nil.
285 The default function `gnus-group-highlight-line' will
286 highlight the line according to the `gnus-group-highlight'
288 :group 'gnus-group-visual
291 (defcustom gnus-useful-groups
292 '(("(ding) mailing list mirrored at gmane.org"
293 "gmane.emacs.gnus.general"
295 (nntp-address "news.gmane.org")))
298 (nntp "news.gnus.org"
299 (nntp-address "news.gnus.org")))
300 ("Local Gnus help group"
303 (nndoc-article-type mbox)
304 (eval `(nndoc-address
305 ,(let ((file (nnheader-find-etc-directory
308 (error "Couldn't find doc group"))
310 "*Alist of useful group-server pairs."
311 :group 'gnus-group-listing
312 :type '(repeat (list (string :tag "Description")
314 (sexp :tag "Method"))))
316 (defcustom gnus-group-highlight
318 ((and mailp (= unread 0) (eq level 1)) .
319 gnus-group-mail-1-empty)
320 ((and mailp (eq level 1)) .
322 ((and mailp (= unread 0) (eq level 2)) .
323 gnus-group-mail-2-empty)
324 ((and mailp (eq level 2)) .
326 ((and mailp (= unread 0) (eq level 3)) .
327 gnus-group-mail-3-empty)
328 ((and mailp (eq level 3)) .
330 ((and mailp (= unread 0)) .
331 gnus-group-mail-low-empty)
335 ((and (= unread 0) (eq level 1)) .
336 gnus-group-news-1-empty)
337 ((and (eq level 1)) .
339 ((and (= unread 0) (eq level 2)) .
340 gnus-group-news-2-empty)
341 ((and (eq level 2)) .
343 ((and (= unread 0) (eq level 3)) .
344 gnus-group-news-3-empty)
345 ((and (eq level 3)) .
347 ((and (= unread 0) (eq level 4)) .
348 gnus-group-news-4-empty)
349 ((and (eq level 4)) .
351 ((and (= unread 0) (eq level 5)) .
352 gnus-group-news-5-empty)
353 ((and (eq level 5)) .
355 ((and (= unread 0) (eq level 6)) .
356 gnus-group-news-6-empty)
357 ((and (eq level 6)) .
359 ((and (= unread 0)) .
360 gnus-group-news-low-empty)
362 gnus-group-news-low))
363 "*Controls the highlighting of group buffer lines.
365 Below is a list of `Form'/`Face' pairs. When deciding how a a
366 particular group line should be displayed, each form is
367 evaluated. The content of the face field after the first true form is
368 used. You can change how those group lines are displayed by
369 editing the face field.
371 It is also possible to change and add form fields, but currently that
372 requires an understanding of Lisp expressions. Hopefully this will
373 change in a future release. For now, you can use the following
374 variables in the Lisp expression:
376 group: The name of the group.
377 unread: The number of unread articles in the group.
378 method: The select method used.
379 mailp: Whether it's a mail group or not.
380 level: The level of the group.
381 score: The score of the group.
382 ticked: The number of ticked articles."
383 :group 'gnus-group-visual
384 :type '(repeat (cons (sexp :tag "Form") face)))
386 (defcustom gnus-new-mail-mark ?%
387 "Mark used for groups with new mail."
388 :group 'gnus-group-visual
391 (defgroup gnus-group-icons nil
392 "Add Icons to your group buffer."
393 :group 'gnus-group-visual)
395 (defcustom gnus-group-icon-list
397 "*Controls the insertion of icons into group buffer lines.
399 Below is a list of `Form'/`File' pairs. When deciding how a
400 particular group line should be displayed, each form is evaluated.
401 The icon from the file field after the first true form is used. You
402 can change how those group lines are displayed by editing the file
403 field. The File will either be found in the
404 `gnus-group-glyph-directory' or by designating absolute name of the
407 It is also possible to change and add form fields, but currently that
408 requires an understanding of Lisp expressions. Hopefully this will
409 change in a future release. For now, you can use the following
410 variables in the Lisp expression:
412 group: The name of the group.
413 unread: The number of unread articles in the group.
414 method: The select method used.
415 mailp: Whether it's a mail group or not.
416 newsp: Whether it's a news group or not
417 level: The level of the group.
418 score: The score of the group.
419 ticked: The number of ticked articles."
420 :group 'gnus-group-icons
421 :type '(repeat (cons (sexp :tag "Form") file)))
423 (defcustom gnus-group-name-charset-method-alist nil
424 "Alist of method and the charset for group names.
427 (((nntp \"news.com.cn\") . cn-gb-2312))"
430 :type '(repeat (cons (sexp :tag "Method") (symbol :tag "Charset"))))
432 (defcustom gnus-group-name-charset-group-alist
433 (if (or (and (fboundp 'find-coding-system) (find-coding-system 'utf-8))
434 (mm-coding-system-p 'utf-8))
437 "Alist of group regexp and the charset for group names.
440 ((\"\\.com\\.cn:\" . cn-gb-2312))"
442 :type '(repeat (cons (regexp :tag "Group") (symbol :tag "Charset"))))
444 (defcustom gnus-group-jump-to-group-prompt nil
445 "Default prompt for `gnus-group-jump-to-group'.
447 If non-nil, the value should be a string or an alist. If it is a string,
448 e.g. \"nnml:\", in which case `gnus-group-jump-to-group' offers \"Group:
449 nnml:\" in the minibuffer prompt.
451 If it is an alist, it must consist of \(NUMBER . PROMPT\) pairs, for example:
452 \((1 . \"\") (2 . \"nnfolder+archive:\")). The element with number 0 is
453 used when no prefix argument is given to `gnus-group-jump-to-group'."
455 :group 'gnus-group-various
456 :type '(choice (string :tag "Prompt string")
457 (const :tag "Empty" nil)
458 (repeat (cons (integer :tag "Argument")
459 (string :tag "Prompt string")))))
461 (defvar gnus-group-listing-limit 1000
462 "*A limit of the number of groups when listing.
463 If the number of groups is larger than the limit, list them in a
466 ;;; Internal variables
468 (defvar gnus-group-is-exiting-p nil)
469 (defvar gnus-group-is-exiting-without-update-p nil)
470 (defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
471 "Function for sorting the group buffer.")
473 (defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
474 "Function for sorting the selected groups in the group buffer.")
476 (defvar gnus-group-indentation-function nil)
477 (defvar gnus-goto-missing-group-function nil)
478 (defvar gnus-group-update-group-function nil)
479 (defvar gnus-group-goto-next-group-function nil
480 "Function to override finding the next group after listing groups.")
482 (defvar gnus-group-edit-buffer nil)
484 (defvar gnus-group-line-format-alist
485 `((?M gnus-tmp-marked-mark ?c)
486 (?S gnus-tmp-subscribed ?c)
487 (?L gnus-tmp-level ?d)
488 (?N (cond ((eq number t) "*" )
492 (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
493 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
495 (?R gnus-tmp-number-of-read ?s)
496 (?U (gnus-number-of-unseen-articles-in-group gnus-tmp-group) ?d)
497 (?t gnus-tmp-number-total ?d)
498 (?y gnus-tmp-number-of-unread ?s)
499 (?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
500 (?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
501 (?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
502 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
503 (?g (if (boundp 'gnus-tmp-decoded-group)
504 gnus-tmp-decoded-group
507 (?G gnus-tmp-qualified-group ?s)
508 (?c (gnus-short-group-name (if (boundp 'gnus-tmp-decoded-group)
509 gnus-tmp-decoded-group
512 (?C gnus-tmp-comment ?s)
513 (?D gnus-tmp-newsgroup-description ?s)
514 (?o gnus-tmp-moderated ?c)
515 (?O gnus-tmp-moderated-string ?s)
516 (?p gnus-tmp-process-marked ?c)
517 (?s gnus-tmp-news-server ?s)
518 (?n ,(if (featurep 'xemacs)
519 '(symbol-name gnus-tmp-news-method)
520 'gnus-tmp-news-method)
522 (?P gnus-group-indentation ?s)
523 (?E gnus-tmp-group-icon ?s)
524 (?B gnus-tmp-summary-live ?c)
525 (?z gnus-tmp-news-method-string ?s)
526 (?m (gnus-group-new-mail gnus-tmp-group) ?c)
527 (?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
528 (?u gnus-tmp-user-defined ?s)
529 (?F (gnus-total-fetched-for gnus-tmp-group) ?s)
532 (defvar gnus-group-mode-line-format-alist
533 `((?S gnus-tmp-news-server ?s)
534 (?M gnus-tmp-news-method ?s)
535 (?u gnus-tmp-user-defined ?s)
536 (?: gnus-tmp-colon ?s)))
538 (defvar gnus-topic-topology nil
539 "The complete topic hierarchy.")
541 (defvar gnus-topic-alist nil
542 "The complete topic-group alist.")
544 (defvar gnus-group-marked nil)
546 (defvar gnus-group-list-mode nil)
549 (defvar gnus-group-icon-cache nil)
551 (defvar gnus-group-listed-groups nil)
552 (defvar gnus-group-list-option nil)
558 (put 'gnus-group-mode 'mode-class 'special)
560 (gnus-define-keys gnus-group-mode-map
561 " " gnus-group-read-group
562 "=" gnus-group-select-group
563 "\r" gnus-group-select-group
564 "\M-\r" gnus-group-quick-select-group
565 "\M- " gnus-group-visible-select-group
566 [(meta control return)] gnus-group-select-group-ephemerally
567 "j" gnus-group-jump-to-group
568 "n" gnus-group-next-unread-group
569 "p" gnus-group-prev-unread-group
570 "\177" gnus-group-prev-unread-group
571 [delete] gnus-group-prev-unread-group
572 [backspace] gnus-group-prev-unread-group
573 "N" gnus-group-next-group
574 "P" gnus-group-prev-group
575 "\M-n" gnus-group-next-unread-group-same-level
576 "\M-p" gnus-group-prev-unread-group-same-level
577 "," gnus-group-best-unread-group
578 "." gnus-group-first-unread-group
579 "u" gnus-group-unsubscribe-current-group
580 "U" gnus-group-unsubscribe-group
581 "c" gnus-group-catchup-current
582 "C" gnus-group-catchup-current-all
583 "\M-c" gnus-group-clear-data
584 "l" gnus-group-list-groups
585 "L" gnus-group-list-all-groups
588 "g" gnus-group-get-new-news
589 "\M-g" gnus-group-get-new-news-this-group
590 "R" gnus-group-restart
591 "r" gnus-group-read-init-file
592 "B" gnus-group-browse-foreign-server
593 "b" gnus-group-check-bogus-groups
594 "F" gnus-group-find-new-groups
595 "\C-c\C-d" gnus-group-describe-group
596 "\M-d" gnus-group-describe-all-groups
597 "\C-c\C-a" gnus-group-apropos
598 "\C-c\M-\C-a" gnus-group-description-apropos
599 "a" gnus-group-post-news
600 "\ek" gnus-group-edit-local-kill
601 "\eK" gnus-group-edit-global-kill
602 "\C-k" gnus-group-kill-group
603 "\C-y" gnus-group-yank-group
604 "\C-w" gnus-group-kill-region
605 "\C-x\C-t" gnus-group-transpose-groups
606 "\C-c\C-l" gnus-group-list-killed
607 "\C-c\C-x" gnus-group-expire-articles
608 "\C-c\M-\C-x" gnus-group-expire-all-groups
610 "s" gnus-group-save-newsrc
611 "z" gnus-group-suspend
614 "?" gnus-group-describe-briefly
615 "\C-c\C-i" gnus-info-find-node
616 "\M-e" gnus-group-edit-group-method
617 "^" gnus-group-enter-server-mode
618 gnus-mouse-2 gnus-mouse-pick-group
619 [follow-link] mouse-face
620 "<" beginning-of-buffer
623 "\C-c\C-s" gnus-group-sort-groups
625 "\C-c\M-g" gnus-activate-all-groups
626 "\M-&" gnus-group-universal-argument
627 "#" gnus-group-mark-group
628 "\M-#" gnus-group-unmark-group)
630 (gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
631 "m" gnus-group-mark-group
632 "u" gnus-group-unmark-group
633 "w" gnus-group-mark-region
634 "b" gnus-group-mark-buffer
635 "r" gnus-group-mark-regexp
636 "U" gnus-group-unmark-all-groups)
638 (gnus-define-keys (gnus-group-sieve-map "D" gnus-group-mode-map)
639 "u" gnus-sieve-update
640 "g" gnus-sieve-generate)
642 (gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
643 "d" gnus-group-make-directory-group
644 "h" gnus-group-make-help-group
645 "u" gnus-group-make-useful-group
646 "a" gnus-group-make-archive-group
647 "k" gnus-group-make-kiboze-group
648 "l" gnus-group-nnimap-edit-acl
649 "m" gnus-group-make-group
650 "E" gnus-group-edit-group
651 "e" gnus-group-edit-group-method
652 "p" gnus-group-edit-group-parameters
653 "v" gnus-group-add-to-virtual
654 "V" gnus-group-make-empty-virtual
655 "D" gnus-group-enter-directory
656 "f" gnus-group-make-doc-group
657 "w" gnus-group-make-web-group
658 "M" gnus-group-read-ephemeral-group
659 "r" gnus-group-rename-group
660 "R" gnus-group-make-rss-group
661 "c" gnus-group-customize
662 "z" gnus-group-compact-group
663 "x" gnus-group-nnimap-expunge
664 "\177" gnus-group-delete-group
665 [delete] gnus-group-delete-group)
667 (gnus-define-keys (gnus-group-soup-map "s" gnus-group-group-map)
668 "b" gnus-group-brew-soup
669 "w" gnus-soup-save-areas
670 "s" gnus-soup-send-replies
671 "p" gnus-soup-pack-packet
672 "r" nnsoup-pack-replies)
674 (gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
675 "s" gnus-group-sort-groups
676 "a" gnus-group-sort-groups-by-alphabet
677 "u" gnus-group-sort-groups-by-unread
678 "l" gnus-group-sort-groups-by-level
679 "v" gnus-group-sort-groups-by-score
680 "r" gnus-group-sort-groups-by-rank
681 "m" gnus-group-sort-groups-by-method
682 "n" gnus-group-sort-groups-by-real-name)
684 (gnus-define-keys (gnus-group-sort-selected-map "P" gnus-group-group-map)
685 "s" gnus-group-sort-selected-groups
686 "a" gnus-group-sort-selected-groups-by-alphabet
687 "u" gnus-group-sort-selected-groups-by-unread
688 "l" gnus-group-sort-selected-groups-by-level
689 "v" gnus-group-sort-selected-groups-by-score
690 "r" gnus-group-sort-selected-groups-by-rank
691 "m" gnus-group-sort-selected-groups-by-method
692 "n" gnus-group-sort-selected-groups-by-real-name)
694 (gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
695 "k" gnus-group-list-killed
696 "z" gnus-group-list-zombies
697 "s" gnus-group-list-groups
698 "u" gnus-group-list-all-groups
699 "A" gnus-group-list-active
700 "a" gnus-group-apropos
701 "d" gnus-group-description-apropos
702 "m" gnus-group-list-matching
703 "M" gnus-group-list-all-matching
704 "l" gnus-group-list-level
705 "c" gnus-group-list-cached
706 "?" gnus-group-list-dormant)
708 (gnus-define-keys (gnus-group-list-limit-map "/" gnus-group-list-map)
709 "k" gnus-group-list-limit
710 "z" gnus-group-list-limit
711 "s" gnus-group-list-limit
712 "u" gnus-group-list-limit
713 "A" gnus-group-list-limit
714 "m" gnus-group-list-limit
715 "M" gnus-group-list-limit
716 "l" gnus-group-list-limit
717 "c" gnus-group-list-limit
718 "?" gnus-group-list-limit)
720 (gnus-define-keys (gnus-group-list-flush-map "f" gnus-group-list-map)
721 "k" gnus-group-list-flush
722 "z" gnus-group-list-flush
723 "s" gnus-group-list-flush
724 "u" gnus-group-list-flush
725 "A" gnus-group-list-flush
726 "m" gnus-group-list-flush
727 "M" gnus-group-list-flush
728 "l" gnus-group-list-flush
729 "c" gnus-group-list-flush
730 "?" gnus-group-list-flush)
732 (gnus-define-keys (gnus-group-list-plus-map "p" gnus-group-list-map)
733 "k" gnus-group-list-plus
734 "z" gnus-group-list-plus
735 "s" gnus-group-list-plus
736 "u" gnus-group-list-plus
737 "A" gnus-group-list-plus
738 "m" gnus-group-list-plus
739 "M" gnus-group-list-plus
740 "l" gnus-group-list-plus
741 "c" gnus-group-list-plus
742 "?" gnus-group-list-plus)
744 (gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
745 "f" gnus-score-flush-cache
746 "e" gnus-score-edit-all-score)
748 (gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
749 "c" gnus-group-fetch-charter
750 "C" gnus-group-fetch-control
751 "d" gnus-group-describe-group
752 "f" gnus-group-fetch-faq
755 (gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
756 "l" gnus-group-set-current-level
757 "t" gnus-group-unsubscribe-current-group
758 "s" gnus-group-unsubscribe-group
759 "k" gnus-group-kill-group
760 "y" gnus-group-yank-group
761 "w" gnus-group-kill-region
762 "\C-k" gnus-group-kill-level
763 "z" gnus-group-kill-all-zombies)
765 (defun gnus-topic-mode-p ()
766 "Return non-nil in `gnus-topic-mode'."
767 (and (boundp 'gnus-topic-mode)
768 (symbol-value 'gnus-topic-mode)))
770 (defun gnus-group-make-menu-bar ()
771 (gnus-turn-off-edit-menu 'group)
772 (unless (boundp 'gnus-group-reading-menu)
775 gnus-group-reading-menu gnus-group-mode-map ""
777 ["Read" gnus-group-read-group
778 :included (not (gnus-topic-mode-p))
779 :active (gnus-group-group-name)]
780 ["Read " gnus-topic-read-group
781 :included (gnus-topic-mode-p)]
782 ["Select" gnus-group-select-group
783 :included (not (gnus-topic-mode-p))
784 :active (gnus-group-group-name)]
785 ["Select " gnus-topic-select-group
786 :included (gnus-topic-mode-p)]
787 ["See old articles" (gnus-group-select-group 'all)
788 :keys "C-u SPC" :active (gnus-group-group-name)]
789 ["Catch up" gnus-group-catchup-current
790 :included (not (gnus-topic-mode-p))
791 :active (gnus-group-group-name)
792 ,@(if (featurep 'xemacs) nil
793 '(:help "Mark unread articles in the current group as read"))]
794 ["Catch up " gnus-topic-catchup-articles
795 :included (gnus-topic-mode-p)
796 ,@(if (featurep 'xemacs) nil
797 '(:help "Mark unread articles in the current group or topic as read"))]
798 ["Catch up all articles" gnus-group-catchup-current-all
799 (gnus-group-group-name)]
800 ["Check for new articles" gnus-group-get-new-news-this-group
801 :included (not (gnus-topic-mode-p))
802 :active (gnus-group-group-name)
803 ,@(if (featurep 'xemacs) nil
804 '(:help "Check for new messages in current group"))]
805 ["Check for new articles " gnus-topic-get-new-news-this-topic
806 :included (gnus-topic-mode-p)
807 ,@(if (featurep 'xemacs) nil
808 '(:help "Check for new messages in current group or topic"))]
809 ["Toggle subscription" gnus-group-unsubscribe-current-group
810 (gnus-group-group-name)]
811 ["Kill" gnus-group-kill-group :active (gnus-group-group-name)
812 ,@(if (featurep 'xemacs) nil
813 '(:help "Kill (remove) current group"))]
814 ["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
815 ["Describe" gnus-group-describe-group :active (gnus-group-group-name)
816 ,@(if (featurep 'xemacs) nil
817 '(:help "Display description of the current group"))]
818 ["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
819 ["Fetch charter" gnus-group-fetch-charter
820 :active (gnus-group-group-name)
821 ,@(if (featurep 'xemacs) nil
822 '(:help "Display the charter of the current group"))]
823 ["Fetch control message" gnus-group-fetch-control
824 :active (gnus-group-group-name)
825 ,@(if (featurep 'xemacs) nil
826 '(:help "Display the archived control message for the current group"))]
827 ;; Actually one should check, if any of the marked groups gives t for
828 ;; (gnus-check-backend-function 'request-expire-articles ...)
829 ["Expire articles" gnus-group-expire-articles
830 :included (not (gnus-topic-mode-p))
831 :active (or (and (gnus-group-group-name)
832 (gnus-check-backend-function
833 'request-expire-articles
834 (gnus-group-group-name))) gnus-group-marked)]
835 ["Expire articles " gnus-topic-expire-articles
836 :included (gnus-topic-mode-p)]
837 ["Set group level..." gnus-group-set-current-level
838 (gnus-group-group-name)]
839 ["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
840 ["Customize" gnus-group-customize (gnus-group-group-name)]
841 ["Compact" gnus-group-compact-group
842 :active (gnus-group-group-name)]
844 ["Parameters" gnus-group-edit-group-parameters
845 :included (not (gnus-topic-mode-p))
846 :active (gnus-group-group-name)]
847 ["Parameters " gnus-topic-edit-parameters
848 :included (gnus-topic-mode-p)]
849 ["Select method" gnus-group-edit-group-method
850 (gnus-group-group-name)]
851 ["Info" gnus-group-edit-group (gnus-group-group-name)]
852 ["Local kill file" gnus-group-edit-local-kill (gnus-group-group-name)]
853 ["Global kill file" gnus-group-edit-global-kill t])))
856 gnus-group-group-menu gnus-group-mode-map ""
859 ["List unread subscribed groups" gnus-group-list-groups t]
860 ["List (un)subscribed groups" gnus-group-list-all-groups t]
861 ["List killed groups" gnus-group-list-killed gnus-killed-list]
862 ["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
863 ["List level..." gnus-group-list-level t]
864 ["Describe all groups" gnus-group-describe-all-groups t]
865 ["Group apropos..." gnus-group-apropos t]
866 ["Group and description apropos..." gnus-group-description-apropos t]
867 ["List groups matching..." gnus-group-list-matching t]
868 ["List all groups matching..." gnus-group-list-all-matching t]
869 ["List active file" gnus-group-list-active t]
870 ["List groups with cached" gnus-group-list-cached t]
871 ["List groups with dormant" gnus-group-list-dormant t])
873 ["Default sort" gnus-group-sort-groups t]
874 ["Sort by method" gnus-group-sort-groups-by-method t]
875 ["Sort by rank" gnus-group-sort-groups-by-rank t]
876 ["Sort by score" gnus-group-sort-groups-by-score t]
877 ["Sort by level" gnus-group-sort-groups-by-level t]
878 ["Sort by unread" gnus-group-sort-groups-by-unread t]
879 ["Sort by name" gnus-group-sort-groups-by-alphabet t]
880 ["Sort by real name" gnus-group-sort-groups-by-real-name t])
881 ("Sort process/prefixed"
882 ["Default sort" gnus-group-sort-selected-groups
883 (not (gnus-topic-mode-p))]
884 ["Sort by method" gnus-group-sort-selected-groups-by-method
885 (not (gnus-topic-mode-p))]
886 ["Sort by rank" gnus-group-sort-selected-groups-by-rank
887 (not (gnus-topic-mode-p))]
888 ["Sort by score" gnus-group-sort-selected-groups-by-score
889 (not (gnus-topic-mode-p))]
890 ["Sort by level" gnus-group-sort-selected-groups-by-level
891 (not (gnus-topic-mode-p))]
892 ["Sort by unread" gnus-group-sort-selected-groups-by-unread
893 (not (gnus-topic-mode-p))]
894 ["Sort by name" gnus-group-sort-selected-groups-by-alphabet
895 (not (gnus-topic-mode-p))]
896 ["Sort by real name" gnus-group-sort-selected-groups-by-real-name
897 (not (gnus-topic-mode-p))])
899 ["Mark group" gnus-group-mark-group
900 (and (gnus-group-group-name)
901 (not (memq (gnus-group-group-name) gnus-group-marked)))]
902 ["Unmark group" gnus-group-unmark-group
903 (and (gnus-group-group-name)
904 (memq (gnus-group-group-name) gnus-group-marked))]
905 ["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
906 ["Mark regexp..." gnus-group-mark-regexp t]
907 ["Mark region" gnus-group-mark-region :active (gnus-mark-active-p)]
908 ["Mark buffer" gnus-group-mark-buffer t]
909 ["Execute command" gnus-group-universal-argument
910 (or gnus-group-marked (gnus-group-group-name))])
912 ["Subscribe to a group..." gnus-group-unsubscribe-group t]
913 ["Kill all newsgroups in region" gnus-group-kill-region
914 :active (gnus-mark-active-p)]
915 ["Kill all zombie groups" gnus-group-kill-all-zombies
917 ["Kill all groups on level..." gnus-group-kill-level t])
919 ["Make a foreign group..." gnus-group-make-group t]
920 ["Add a directory group..." gnus-group-make-directory-group t]
921 ["Add the help group" gnus-group-make-help-group t]
922 ["Add the archive group" gnus-group-make-archive-group t]
923 ["Make a doc group..." gnus-group-make-doc-group t]
924 ["Make a web group..." gnus-group-make-web-group t]
925 ["Make a kiboze group..." gnus-group-make-kiboze-group t]
926 ["Make a virtual group..." gnus-group-make-empty-virtual t]
927 ["Add a group to a virtual..." gnus-group-add-to-virtual t]
928 ["Make an ephemeral group..." gnus-group-read-ephemeral-group t]
929 ["Make an RSS group..." gnus-group-make-rss-group t]
930 ["Rename group..." gnus-group-rename-group
931 (gnus-check-backend-function
932 'request-rename-group (gnus-group-group-name))]
933 ["Delete group" gnus-group-delete-group
934 (gnus-check-backend-function
935 'request-delete-group (gnus-group-group-name))])
937 ["Next" gnus-group-next-group t]
938 ["Previous" gnus-group-prev-group t]
939 ["Next unread" gnus-group-next-unread-group t]
940 ["Previous unread" gnus-group-prev-unread-group t]
941 ["Next unread same level" gnus-group-next-unread-group-same-level t]
942 ["Previous unread same level"
943 gnus-group-prev-unread-group-same-level t]
944 ["Jump to group..." gnus-group-jump-to-group t]
945 ["First unread group" gnus-group-first-unread-group t]
946 ["Best unread group" gnus-group-best-unread-group t])
948 ["Generate" gnus-sieve-generate t]
949 ["Generate and update" gnus-sieve-update t])
950 ["Delete bogus groups" gnus-group-check-bogus-groups t]
951 ["Find new newsgroups" gnus-group-find-new-groups t]
952 ["Transpose" gnus-group-transpose-groups
953 (gnus-group-group-name)]
954 ["Read a directory as a group..." gnus-group-enter-directory t]))
957 gnus-group-misc-menu gnus-group-mode-map ""
960 ["Pack replies" nnsoup-pack-replies (fboundp 'nnsoup-request-group)]
961 ["Send replies" gnus-soup-send-replies
962 (fboundp 'gnus-soup-pack-packet)]
963 ["Pack packet" gnus-soup-pack-packet (fboundp 'gnus-soup-pack-packet)]
964 ["Save areas" gnus-soup-save-areas (fboundp 'gnus-soup-pack-packet)]
965 ["Brew SOUP" gnus-group-brew-soup (fboundp 'gnus-soup-pack-packet)])
966 ["Send a mail" gnus-group-mail t]
967 ["Send a message (mail or news)" gnus-group-post-news t]
968 ["Create a local message" gnus-group-news t]
969 ["Check for new news" gnus-group-get-new-news
970 ,@(if (featurep 'xemacs) '(t)
971 '(:help "Get newly arrived articles"))
973 ["Send queued messages" gnus-delay-send-queue
974 ,@(if (featurep 'xemacs) '(t)
975 '(:help "Send all messages that are scheduled to be sent now"))
977 ["Activate all groups" gnus-activate-all-groups t]
978 ["Restart Gnus" gnus-group-restart t]
979 ["Read init file" gnus-group-read-init-file t]
980 ["Browse foreign server..." gnus-group-browse-foreign-server t]
981 ["Enter server buffer" gnus-group-enter-server-mode t]
982 ["Expire all expirable articles" gnus-group-expire-all-groups t]
983 ["Generate any kiboze groups" nnkiboze-generate-groups t]
984 ["Gnus version" gnus-version t]
985 ["Save .newsrc files" gnus-group-save-newsrc t]
986 ["Suspend Gnus" gnus-group-suspend t]
987 ["Clear dribble buffer" gnus-group-clear-dribble t]
988 ["Read manual" gnus-info-find-node t]
989 ["Flush score cache" gnus-score-flush-cache t]
990 ["Toggle topics" gnus-topic-mode t]
991 ["Send a bug report" gnus-bug t]
992 ["Exit from Gnus" gnus-group-exit
993 ,@(if (featurep 'xemacs) '(t)
994 '(:help "Quit reading news"))]
995 ["Exit without saving" gnus-group-quit t]))
997 (gnus-run-hooks 'gnus-group-menu-hook)))
1000 (defvar gnus-group-tool-bar-map nil)
1002 (defun gnus-group-tool-bar-update (&optional symbol value)
1003 "Update group buffer toolbar.
1004 Setter function for custom variables."
1006 (set-default symbol value))
1007 ;; (setq-default gnus-group-tool-bar-map nil)
1008 ;; (use-local-map gnus-group-mode-map)
1009 (when (gnus-alive-p)
1010 (with-current-buffer gnus-group-buffer
1011 (gnus-group-make-tool-bar t))))
1013 ;; The default will be changed when the new icons have been checked in:
1014 (defcustom gnus-group-tool-bar 'gnus-group-tool-bar-retro
1015 "Specifies the Gnus group tool bar.
1017 It can be either a list or a symbol refering to a list. See
1018 `gmm-tool-bar-from-list' for the format of the list. The
1019 default key map is `gnus-group-mode-map'.
1021 Pre-defined symbols include `gnus-group-tool-bar-gnome' and
1022 `gnus-group-tool-bar-retro'."
1023 :type '(choice (const :tag "GNOME style" gnus-group-tool-bar-gnome)
1024 (const :tag "Retro look" gnus-group-tool-bar-retro)
1025 (repeat :tag "User defined list" gmm-tool-bar-item)
1027 :version "23.0" ;; No Gnus
1028 :initialize 'custom-initialize-default
1029 :set 'gnus-group-tool-bar-update
1032 (defcustom gnus-group-tool-bar-gnome
1033 '((gnus-group-post-news "compose")
1034 (gnus-group-get-new-news "inbox") ;; Add... nil :visible gnus-plugged ?
1035 ;; FIXME: gnus-*-read-group should have a better help text.
1036 (gnus-topic-read-group "open" nil :visible gnus-topic-mode)
1037 (gnus-group-read-group "open" nil :visible (not gnus-topic-mode))
1038 ;; (gnus-group-find-new-groups "???" nil)
1039 (gnus-group-save-newsrc "save")
1040 (gnus-group-describe-group "describe")
1041 (gnus-group-unsubscribe-current-group "toggle-subscription")
1042 ;; (gnus-group-subscribe "subscribe" t
1043 ;; :help "Subscribe to the current group")
1044 ;; (gnus-group-unsubscribe "unsubscribe" t
1045 ;; :help "Unsubscribe from the current group")
1047 ;; Some useful agent icons? I don't use the agent so agent users should
1048 ;; suggest useful commands:
1049 (gnus-group-send-queue "outbox" t
1050 :visible (and gnus-agent gnus-plugged)
1051 :help "Send articles from the queue group")
1052 (gnus-agent-toggle-plugged "connect" nil
1053 :visible (and gnus-agent (not gnus-plugged)))
1054 (gnus-agent-toggle-plugged "disconnect" nil
1055 :visible (and gnus-agent gnus-plugged))
1057 (gnus-group-exit "exit-mode")
1058 (gnus-info-find-node "help"))
1059 "List of functions for the group tool bar (GNOME style).
1061 See `gmm-tool-bar-from-list' for the format of the list."
1062 :type '(repeat gmm-tool-bar-item)
1063 :version "23.0" ;; No Gnus
1064 :initialize 'custom-initialize-default
1065 :set 'gnus-group-tool-bar-update
1068 (defcustom gnus-group-tool-bar-retro
1069 '((gnus-group-get-new-news "get-news")
1070 (gnus-group-get-new-news-this-group "gnntg")
1071 (gnus-group-catchup-current "catchup")
1072 (gnus-group-describe-group "describe-group")
1073 (gnus-group-subscribe "subscribe" t
1074 :help "Subscribe to the current group")
1075 (gnus-group-unsubscribe "unsubscribe" t
1076 :help "Unsubscribe from the current group")
1077 (gnus-group-exit "exit-gnus" gnus-group-mode-map))
1078 "List of functions for the group tool bar (retro look).
1080 See `gmm-tool-bar-from-list' for the format of the list."
1081 :type '(repeat gmm-tool-bar-item)
1082 :version "23.0" ;; No Gnus
1083 :initialize 'custom-initialize-default
1084 :set 'gnus-group-tool-bar-update
1087 ;; FIXME: Moving through the Group buffer (in topic mode) e.g. with C-n
1088 ;; doesn't update the state (enabled/disabled) of the icon
1089 ;; `gnus-group-describe-group'. After `C-l' the state is correct.
1090 ;; See the following report on emacs-devel
1091 ;; <http://thread.gmane.org/v9acdmrcse.fsf@marauder.physik.uni-ulm.de>:
1092 ;; From: Reiner Steib
1093 ;; Subject: tool bar icons not updated according to :active condition
1094 ;; Newsgroups: gmane.emacs.devel
1095 ;; Date: Mon, 23 Jan 2006 19:59:13 +0100
1096 ;; Message-ID: <v9acdmrcse.fsf@marauder.physik.uni-ulm.de>
1098 (defcustom gnus-group-tool-bar-zap-list t
1099 "List of icon items from the global tool bar.
1100 These items are not displayed in the Gnus group mode tool bar.
1102 See `gmm-tool-bar-from-list' for the format of the list."
1103 :type 'gmm-tool-bar-zap-list
1104 :version "23.0" ;; No Gnus
1105 :initialize 'custom-initialize-default
1106 :set 'gnus-group-tool-bar-update
1109 (defun gnus-group-make-tool-bar (&optional force)
1110 "Make a group mode tool bar from `gnus-group-tool-bar'.
1111 When FORCE, rebuild the tool bar."
1112 (when (and (not (featurep 'xemacs))
1113 (boundp 'tool-bar-mode)
1115 ;; The Gnus 5.10.6 code checked (default-value 'tool-bar-mode).
1117 (or (not gnus-group-tool-bar-map) force))
1118 (let* ((load-path (mm-image-load-path))
1119 (map (gmm-tool-bar-from-list gnus-group-tool-bar
1120 gnus-group-tool-bar-zap-list
1121 'gnus-group-mode-map)))
1123 (set (make-local-variable 'tool-bar-map) map))))
1124 gnus-group-tool-bar-map)
1126 (defun gnus-group-mode ()
1127 "Major mode for reading news.
1129 All normal editing commands are switched off.
1130 \\<gnus-group-mode-map>
1131 The group buffer lists (some of) the groups available. For instance,
1132 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
1133 lists all zombie groups.
1135 Groups that are displayed can be entered with `\\[gnus-group-read-group]'. To subscribe
1136 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
1138 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
1140 The following commands are available:
1142 \\{gnus-group-mode-map}"
1144 (kill-all-local-variables)
1145 (when (gnus-visual-p 'group-menu 'menu)
1146 (gnus-group-make-menu-bar)
1147 (gnus-group-make-tool-bar))
1148 (gnus-simplify-mode-line)
1149 (setq major-mode 'gnus-group-mode)
1150 (setq mode-name "Group")
1151 (gnus-group-set-mode-line)
1152 (setq mode-line-process nil)
1153 (use-local-map gnus-group-mode-map)
1154 (buffer-disable-undo)
1155 (setq truncate-lines t)
1156 (setq buffer-read-only t
1157 show-trailing-whitespace nil)
1158 (gnus-set-default-directory)
1159 (gnus-update-format-specifications nil 'group 'group-mode)
1160 (gnus-update-group-mark-positions)
1165 (gnus-run-mode-hooks 'gnus-group-mode-hook))
1167 (defun gnus-update-group-mark-positions ()
1169 (let ((gnus-process-mark ?\200)
1170 (gnus-group-update-hook nil)
1171 (gnus-group-marked '("dummy.group"))
1172 (gnus-active-hashtb (make-vector 10 0))
1174 (gnus-set-active "dummy.group" '(0 . 0))
1175 (gnus-set-work-buffer)
1176 (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
1177 (goto-char (point-min))
1178 (setq gnus-group-mark-positions
1179 (list (cons 'process (and (search-forward
1180 (mm-string-as-multibyte "\200") nil t)
1181 (- (point) 2))))))))
1183 (defun gnus-mouse-pick-group (e)
1184 "Enter the group under the mouse pointer."
1187 (gnus-group-read-group nil))
1189 ;; Look at LEVEL and find out what the level is really supposed to be.
1190 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
1191 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
1192 (defun gnus-group-default-level (&optional level number-or-nil)
1194 (gnus-group-use-permanent-levels
1195 (or (setq gnus-group-use-permanent-levels
1196 (or level (if (numberp gnus-group-use-permanent-levels)
1197 gnus-group-use-permanent-levels
1198 (or gnus-group-default-list-level
1199 gnus-level-subscribed))))
1200 gnus-group-default-list-level gnus-level-subscribed))
1204 (or level gnus-group-default-list-level gnus-level-subscribed))))
1206 (defun gnus-group-setup-buffer ()
1207 (set-buffer (gnus-get-buffer-create gnus-group-buffer))
1208 (unless (eq major-mode 'gnus-group-mode)
1211 (gnus-carpal-setup-buffer 'group))))
1213 (defun gnus-group-name-charset (method group)
1215 (setq method (gnus-find-method-for-group group)))
1216 (let ((item (assoc method gnus-group-name-charset-method-alist))
1217 (alist gnus-group-name-charset-group-alist)
1221 (while (setq item (pop alist))
1222 (if (string-match (car item) group)
1224 result (cdr item))))
1227 (defun gnus-group-name-decode (string charset)
1228 ;; Fixme: Don't decode in unibyte mode.
1229 (if (and string charset (featurep 'mule))
1230 (mm-decode-coding-string string charset)
1233 (defun gnus-group-decoded-name (string)
1234 (let ((charset (gnus-group-name-charset nil string)))
1235 (gnus-group-name-decode string charset)))
1237 (defun gnus-group-list-groups (&optional level unread lowest)
1238 "List newsgroups with level LEVEL or lower that have unread articles.
1239 Default is all subscribed groups.
1240 If argument UNREAD is non-nil, groups with no unread articles are also
1243 Also see the `gnus-group-use-permanent-levels' variable."
1245 (list (if current-prefix-arg
1246 (prefix-numeric-value current-prefix-arg)
1248 (gnus-group-default-level nil t)
1249 gnus-group-default-list-level
1250 gnus-level-subscribed))))
1252 (setq level (car gnus-group-list-mode)
1253 unread (cdr gnus-group-list-mode)))
1254 (setq level (gnus-group-default-level level))
1255 (gnus-group-setup-buffer)
1256 (gnus-update-format-specifications nil 'group 'group-mode)
1257 (let ((case-fold-search nil)
1258 (props (text-properties-at (point-at-bol)))
1259 (empty (= (point-min) (point-max)))
1260 (group (gnus-group-group-name))
1262 (set-buffer gnus-group-buffer)
1263 (setq number (funcall gnus-group-prepare-function level unread lowest))
1264 (when (or (and (numberp number)
1266 (zerop (buffer-size)))
1267 ;; No groups in the buffer.
1268 (gnus-message 5 gnus-no-groups-message))
1269 ;; We have some groups displayed.
1270 (goto-char (point-max))
1271 (when (or (not gnus-group-goto-next-group-function)
1272 (not (funcall gnus-group-goto-next-group-function
1276 (goto-char (point-min)))
1278 ;; Go to the first group with unread articles.
1279 (gnus-group-search-forward t))
1281 ;; Find the right group to put point on. If the current group
1282 ;; has disappeared in the new listing, try to find the next
1283 ;; one. If no next one can be found, just leave point at the
1284 ;; first newsgroup in the buffer.
1285 (when (not (gnus-goto-char
1287 (point-min) (point-max)
1288 'gnus-group (gnus-intern-safe
1289 group gnus-active-hashtb))))
1290 (let ((newsrc (cdddr (gnus-group-entry group))))
1292 (not (gnus-goto-char
1294 (point-min) (point-max) 'gnus-group
1296 (caar newsrc) gnus-active-hashtb)))))
1297 (setq newsrc (cdr newsrc)))
1299 (goto-char (point-max))
1300 (forward-line -1)))))))
1301 ;; Adjust cursor point.
1302 (gnus-group-position-point)))
1304 (defun gnus-group-list-level (level &optional all)
1305 "List groups on LEVEL.
1306 If ALL (the prefix), also list groups that have no unread articles."
1307 (interactive "nList groups on level: \nP")
1308 (gnus-group-list-groups level all level))
1310 (defun gnus-group-prepare-logic (group test)
1311 (or (and gnus-group-listed-groups
1312 (null gnus-group-list-option)
1313 (member group gnus-group-listed-groups))
1315 ((null gnus-group-listed-groups) test)
1316 ((null gnus-group-list-option) test)
1317 (t (and (member group gnus-group-listed-groups)
1318 (if (eq gnus-group-list-option 'flush)
1322 (defun gnus-group-prepare-flat (level &optional predicate lowest regexp)
1323 "List all newsgroups with unread articles of level LEVEL or lower.
1324 If PREDICATE is a function, list groups that the function returns non-nil;
1325 if it is t, list groups that have no unread articles.
1326 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1327 If REGEXP is a function, list dead groups that the function returns non-nil;
1328 if it is a string, only list groups matching REGEXP."
1329 (set-buffer gnus-group-buffer)
1330 (let ((buffer-read-only nil)
1331 (newsrc (cdr gnus-newsrc-alist))
1332 (lowest (or lowest 1))
1333 (not-in-list (and gnus-group-listed-groups
1334 (copy-sequence gnus-group-listed-groups)))
1335 info clevel unread group params)
1337 (when (or (< lowest gnus-level-zombie)
1338 gnus-group-listed-groups)
1339 ;; List living groups.
1341 (setq info (car newsrc)
1342 group (gnus-info-group info)
1343 params (gnus-info-params info)
1345 unread (gnus-group-unread group))
1347 (setq not-in-list (delete group not-in-list)))
1348 (when (gnus-group-prepare-logic
1350 (and unread ; This group might be unchecked
1351 (or (not (stringp regexp))
1352 (string-match regexp group))
1353 (<= (setq clevel (gnus-info-level info)) level)
1356 ((functionp predicate)
1357 (funcall predicate info))
1358 (predicate t) ; We list all groups?
1361 (if (eq unread t) ; Unactivated?
1362 gnus-group-list-inactive-groups
1363 ; We list unactivated
1365 ; We list groups with unread articles
1366 (and gnus-list-groups-with-ticked-articles
1367 (cdr (assq 'tick (gnus-info-marks info))))
1368 ; And groups with tickeds
1369 ;; Check for permanent visibility.
1370 (and gnus-permanently-visible-groups
1371 (string-match gnus-permanently-visible-groups
1373 (memq 'visible params)
1374 (cdr (assq 'visible params)))))))
1375 (gnus-group-insert-group-line
1376 group (gnus-info-level info)
1377 (gnus-info-marks info) unread (gnus-info-method info)))))
1379 ;; List dead groups.
1380 (when (or gnus-group-listed-groups
1381 (and (>= level gnus-level-zombie)
1382 (<= lowest gnus-level-zombie)))
1383 (gnus-group-prepare-flat-list-dead
1384 (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1385 gnus-level-zombie ?Z
1388 (dolist (group gnus-zombie-list)
1389 (setq not-in-list (delete group not-in-list))))
1390 (when (or gnus-group-listed-groups
1391 (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)))
1392 (gnus-group-prepare-flat-list-dead
1395 (setq gnus-killed-list (sort gnus-killed-list 'string<)))
1396 gnus-level-killed ?K regexp))
1398 (gnus-group-set-mode-line)
1399 (setq gnus-group-list-mode (cons level predicate))
1400 (gnus-run-hooks 'gnus-group-prepare-hook)
1403 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1404 ;; List zombies and killed lists somewhat faster, which was
1405 ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>. It does
1406 ;; this by ignoring the group format specification altogether.
1408 (if (> (length groups) gnus-group-listing-limit)
1410 (setq group (pop groups))
1411 (when (gnus-group-prepare-logic
1414 (and (stringp regexp) (string-match regexp group))
1415 (and (functionp regexp) (funcall regexp group))))
1416 (gnus-add-text-properties
1417 (point) (prog1 (1+ (point))
1418 (insert " " mark " *: "
1419 (gnus-group-decoded-name group)
1421 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1423 'gnus-level level))))
1425 (setq group (pop groups))
1426 (when (gnus-group-prepare-logic
1429 (and (stringp regexp) (string-match regexp group))
1430 (and (functionp regexp) (funcall regexp group))))
1431 (gnus-group-insert-group-line
1433 (let ((active (gnus-active group)))
1435 (if (zerop (cdr active))
1437 (- (1+ (cdr active)) (car active)))
1439 (gnus-method-simplify (gnus-find-method-for-group group))))))))
1441 (defun gnus-group-update-group-line ()
1442 "Update the current line in the group buffer."
1443 (let* ((buffer-read-only nil)
1444 (group (gnus-group-group-name))
1445 (entry (and group (gnus-group-entry group)))
1446 gnus-group-indentation)
1449 (not (gnus-ephemeral-group-p group))
1451 (concat "(gnus-group-set-info '"
1452 (gnus-prin1-to-string (nth 2 entry))
1454 (setq gnus-group-indentation (gnus-group-group-indentation))
1456 (gnus-group-insert-group-line-info group)
1458 (gnus-group-position-point))))
1460 (defun gnus-group-insert-group-line-info (group)
1461 "Insert GROUP on the current line."
1462 (let ((entry (gnus-group-entry group))
1463 (gnus-group-indentation (gnus-group-group-indentation))
1467 ;; (Un)subscribed group.
1468 (setq info (nth 2 entry))
1469 (gnus-group-insert-group-line
1470 group (gnus-info-level info) (gnus-info-marks info)
1471 (or (car entry) t) (gnus-info-method info)))
1472 ;; This group is dead.
1473 (gnus-group-insert-group-line
1475 (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1477 (if (setq active (gnus-active group))
1478 (if (zerop (cdr active))
1480 (- (1+ (cdr active)) (car active)))
1482 (gnus-method-simplify (gnus-find-method-for-group group))))))
1484 (defun gnus-number-of-unseen-articles-in-group (group)
1485 (let* ((info (nth 2 (gnus-group-entry group)))
1486 (marked (gnus-info-marks info))
1487 (seen (cdr (assq 'seen marked)))
1488 (active (gnus-active group)))
1491 (length (gnus-uncompress-range
1492 (gnus-range-difference
1493 (gnus-range-difference (list active) (gnus-info-read info))
1496 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1497 gnus-tmp-marked number
1499 "Insert a group line in the group buffer."
1500 (let* ((gnus-tmp-method
1501 (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1502 (group-name-charset (gnus-group-name-charset gnus-tmp-method
1504 (gnus-tmp-active (gnus-active gnus-tmp-group))
1505 (gnus-tmp-number-total
1507 (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1509 (gnus-tmp-number-of-unread
1510 (if (numberp number) (int-to-string (max 0 number))
1512 (gnus-tmp-number-of-read
1513 (if (numberp number)
1514 (int-to-string (max 0 (- gnus-tmp-number-total number)))
1516 (gnus-tmp-subscribed
1517 (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1518 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1519 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1521 (gnus-tmp-qualified-group
1522 (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1523 group-name-charset))
1525 (or (gnus-group-get-parameter gnus-tmp-group 'comment t)
1527 (gnus-tmp-newsgroup-description
1528 (if gnus-description-hashtb
1529 (or (gnus-group-name-decode
1530 (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1531 group-name-charset) "")
1534 (if (and gnus-moderated-hashtb
1535 (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1537 (gnus-tmp-moderated-string
1538 (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1539 (gnus-tmp-group-icon "==&&==")
1540 (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1541 (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1542 (gnus-tmp-news-method-string
1544 (format "(%s:%s)" (car gnus-tmp-method)
1545 (cadr gnus-tmp-method)) ""))
1546 (gnus-tmp-marked-mark
1547 (if (and (numberp number)
1549 (cdr (assq 'tick gnus-tmp-marked)))
1551 (gnus-tmp-summary-live
1552 (if (and (not gnus-group-is-exiting-p)
1553 (gnus-buffer-live-p (gnus-summary-buffer-name
1556 (gnus-tmp-process-marked
1557 (if (member gnus-tmp-group gnus-group-marked)
1558 gnus-process-mark ? ))
1559 (buffer-read-only nil)
1560 header gnus-tmp-header) ; passed as parameter to user-funcs.
1562 (gnus-add-text-properties
1566 (let ((gnus-tmp-decoded-group (gnus-group-name-decode
1567 gnus-tmp-group group-name-charset)))
1568 (eval gnus-group-line-format-spec)))
1569 `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1570 gnus-unread ,(if (numberp number)
1571 (string-to-number gnus-tmp-number-of-unread)
1573 gnus-marked ,gnus-tmp-marked-mark
1574 gnus-indentation ,gnus-group-indentation
1575 gnus-level ,gnus-tmp-level))
1577 (when (inline (gnus-visual-p 'group-highlight 'highlight))
1578 (gnus-run-hooks 'gnus-group-update-hook))
1580 ;; Allow XEmacs to remove front-sticky text properties.
1581 (gnus-group-remove-excess-properties)))
1583 (defun gnus-group-highlight-line ()
1584 "Highlight the current line according to `gnus-group-highlight'."
1585 (let* ((list gnus-group-highlight)
1587 (end (point-at-eol))
1588 ;; now find out where the line starts and leave point there.
1589 (beg (progn (beginning-of-line) (point)))
1590 (group (gnus-group-group-name))
1591 (entry (gnus-group-entry group))
1592 (unread (if (numberp (car entry)) (car entry) 0))
1593 (active (gnus-active group))
1594 (total (if active (1+ (- (cdr active) (car active))) 0))
1595 (info (nth 2 entry))
1596 (method (inline (gnus-server-get-method group (gnus-info-method info))))
1597 (marked (gnus-info-marks info))
1598 (mailp (apply 'append
1601 (memq x (assoc (symbol-name
1602 (car (or method gnus-select-method)))
1603 gnus-valid-select-methods)))
1604 '(mail post-mail))))
1605 (level (or (gnus-info-level info) gnus-level-killed))
1606 (score (or (gnus-info-score info) 0))
1607 (ticked (gnus-range-length (cdr (assq 'tick marked))))
1608 (group-age (gnus-group-timestamp-delta group))
1609 (inhibit-read-only t))
1610 ;; Eval the cars of the lists until we find a match.
1612 (not (eval (caar list))))
1613 (setq list (cdr list)))
1614 (let ((face (cdar list)))
1615 (unless (eq face (get-text-property beg 'face))
1616 (gnus-put-text-property-excluding-characters-with-faces
1618 (setq face (if (boundp face) (symbol-value face) face)))
1619 (gnus-extent-start-open beg)))
1622 (defun gnus-group-update-group (group &optional visible-only)
1623 "Update all lines where GROUP appear.
1624 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1626 ;; Can't use `save-excursion' here, so we do it manually.
1627 (let ((buf (current-buffer))
1629 (set-buffer gnus-group-buffer)
1630 (setq mark (point-marker))
1631 ;; The buffer may be narrowed.
1634 (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1636 found buffer-read-only)
1637 ;; Enter the current status into the dribble buffer.
1638 (let ((entry (gnus-group-entry group)))
1640 (not (gnus-ephemeral-group-p group)))
1642 (concat "(gnus-group-set-info '"
1643 (gnus-prin1-to-string (nth 2 entry))
1645 ;; Find all group instances. If topics are in use, each group
1646 ;; may be listed in more than once.
1647 (while (setq loc (text-property-any
1648 loc (point-max) 'gnus-group ident))
1651 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1653 (gnus-group-insert-group-line-info group)
1656 (gnus-run-hooks 'gnus-group-update-group-hook)))
1657 (setq loc (1+ loc)))
1658 (unless (or found visible-only)
1659 ;; No such line in the buffer, find out where it's supposed to
1660 ;; go, and insert it there (or at the end of the buffer).
1661 (if gnus-goto-missing-group-function
1662 (funcall gnus-goto-missing-group-function group)
1663 (let ((entry (cddr (gnus-group-entry group))))
1664 (while (and entry (car entry)
1668 (point-min) (point-max)
1669 'gnus-group (gnus-intern-safe
1670 (caar entry) gnus-active-hashtb)))))
1671 (setq entry (cdr entry)))
1672 (or entry (goto-char (point-max)))))
1673 ;; Finally insert the line.
1674 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1675 (gnus-group-insert-group-line-info group)
1678 (gnus-run-hooks 'gnus-group-update-group-hook))))
1679 (when gnus-group-update-group-function
1680 (funcall gnus-group-update-group-function group))
1681 (gnus-group-set-mode-line)))
1683 (set-marker mark nil)
1686 (defun gnus-group-set-mode-line ()
1687 "Update the mode line in the group buffer."
1688 (when (memq 'group gnus-updated-mode-lines)
1689 ;; Yes, we want to keep this mode line updated.
1691 (set-buffer gnus-group-buffer)
1692 (let* ((gformat (or gnus-group-mode-line-format-spec
1693 (gnus-set-format 'group-mode)))
1694 (gnus-tmp-news-server (cadr gnus-select-method))
1695 (gnus-tmp-news-method (car gnus-select-method))
1696 (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1698 gnus-tmp-header ;Dummy binding for user-defined formats
1699 ;; Get the resulting string.
1701 (and gnus-dribble-buffer
1702 (buffer-name gnus-dribble-buffer)
1703 (buffer-modified-p gnus-dribble-buffer)
1705 (set-buffer gnus-dribble-buffer)
1706 (not (zerop (buffer-size))))))
1707 (mode-string (eval gformat)))
1708 ;; Say whether the dribble buffer has been modified.
1709 (setq mode-line-modified
1710 (if modified (car gnus-mode-line-modified)
1711 (cdr gnus-mode-line-modified)))
1712 ;; If the line is too long, we chop it off.
1713 (when (> (length mode-string) max-len)
1714 (setq mode-string (substring mode-string 0 (- max-len 4))))
1716 (setq mode-line-buffer-identification
1717 (gnus-mode-line-buffer-identification
1718 (list mode-string)))
1719 (set-buffer-modified-p modified))))))
1721 (defun gnus-group-group-name ()
1722 "Get the name of the newsgroup on the current line."
1723 (let ((group (get-text-property (point-at-bol) 'gnus-group)))
1725 (symbol-name group))))
1727 (defun gnus-group-group-level ()
1728 "Get the level of the newsgroup on the current line."
1729 (get-text-property (point-at-bol) 'gnus-level))
1731 (defun gnus-group-group-indentation ()
1732 "Get the indentation of the newsgroup on the current line."
1733 (or (get-text-property (point-at-bol) 'gnus-indentation)
1734 (and gnus-group-indentation-function
1735 (funcall gnus-group-indentation-function))
1738 (defun gnus-group-group-unread ()
1739 "Get the number of unread articles of the newsgroup on the current line."
1740 (get-text-property (point-at-bol) 'gnus-unread))
1742 (defun gnus-group-new-mail (group)
1743 (if (nnmail-new-mail-p (gnus-group-real-name group))
1747 (defun gnus-group-level (group)
1748 "Return the estimated level of GROUP."
1749 (or (gnus-info-level (gnus-get-info group))
1750 (and (member group gnus-zombie-list) gnus-level-zombie)
1753 (defun gnus-group-search-forward (&optional backward all level first-too)
1754 "Find the next newsgroup with unread articles.
1755 If BACKWARD is non-nil, find the previous newsgroup instead.
1756 If ALL is non-nil, just find any newsgroup.
1757 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1759 If FIRST-TOO, the current line is also eligible as a target."
1760 (let ((way (if backward -1 1))
1761 (low gnus-level-killed)
1764 (if (and backward (progn (beginning-of-line)) (bobp))
1773 (get-text-property (point) 'gnus-group)
1777 (get-text-property (point) 'gnus-unread)))
1778 (and (numberp unread) (> unread 0)))
1779 (setq lev (get-text-property (point)
1781 (<= lev gnus-level-subscribed)))
1783 (and (setq lev (get-text-property (point)
1792 (zerop (forward-line way)))))
1794 (progn (gnus-group-position-point) t)
1795 (goto-char (or pos beg))
1798 (defun gnus-total-fetched-for (group)
1799 (let* ((size-in-cache (or (gnus-cache-total-fetched-for group) 0))
1800 (size-in-agent (or (gnus-agent-total-fetched-for group) 0))
1801 (size (+ size-in-cache size-in-agent))
1802 (suffix '("B" "K" "M" "G"))
1805 (while (> size cutoff)
1806 (setq size (/ size scale)
1807 suffix (cdr suffix)))
1808 (format "%5.1f%s" size (car suffix))))
1810 ;;; Gnus group mode commands
1814 (defun gnus-group-mark-line-p ()
1817 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1818 (eq (char-after) gnus-process-mark)))
1820 (defun gnus-group-mark-group (n &optional unmark no-advance)
1821 "Mark the current group."
1823 (let ((buffer-read-only nil)
1827 (when (setq group (gnus-group-group-name))
1828 ;; Go to the mark position.
1830 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1834 (setq gnus-group-marked (delete group gnus-group-marked))
1835 (insert-char ? 1 t))
1836 (setq gnus-group-marked
1837 (cons group (delete group gnus-group-marked)))
1838 (insert-char gnus-process-mark 1 t)))
1840 (gnus-group-next-group 1))
1842 (gnus-summary-position-point)
1845 (defun gnus-group-unmark-group (n)
1846 "Remove the mark from the current group."
1848 (gnus-group-mark-group n 'unmark)
1849 (gnus-group-position-point))
1851 (defun gnus-group-unmark-all-groups ()
1852 "Unmark all groups."
1855 (mapc 'gnus-group-remove-mark gnus-group-marked))
1856 (gnus-group-position-point))
1858 (defun gnus-group-mark-region (unmark beg end)
1859 "Mark all groups between point and mark.
1860 If UNMARK, remove the mark instead."
1861 (interactive "P\nr")
1862 (let ((num (count-lines beg end)))
1865 (- num (gnus-group-mark-group num unmark)))))
1867 (defun gnus-group-mark-buffer (&optional unmark)
1868 "Mark all groups in the buffer.
1869 If UNMARK, remove the mark instead."
1871 (gnus-group-mark-region unmark (point-min) (point-max)))
1873 (defun gnus-group-mark-regexp (regexp)
1874 "Mark all groups that match some regexp."
1875 (interactive "sMark (regexp): ")
1876 (let ((alist (cdr gnus-newsrc-alist))
1880 (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1881 (gnus-group-jump-to-group group)
1882 (gnus-group-set-mark group)))))
1883 (gnus-group-position-point))
1885 (defun gnus-group-remove-mark (group &optional test-marked)
1886 "Remove the process mark from GROUP and move point there.
1887 Return nil if the group isn't displayed."
1888 (if (gnus-group-goto-group group nil test-marked)
1890 (gnus-group-mark-group 1 'unmark t)
1892 (setq gnus-group-marked
1893 (delete group gnus-group-marked))
1896 (defun gnus-group-set-mark (group)
1897 "Set the process mark on GROUP."
1898 (if (gnus-group-goto-group group)
1900 (gnus-group-mark-group 1 nil t))
1901 (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1903 (defun gnus-group-universal-argument (arg &optional groups func)
1904 "Perform any command on all groups according to the process/prefix convention."
1906 (if (eq (setq func (or func
1909 (substitute-command-keys
1910 "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1912 (gnus-error 1 "Undefined key")
1913 (gnus-group-iterate arg
1915 (command-execute func))))
1916 (gnus-group-position-point))
1918 (defun gnus-group-process-prefix (n)
1919 "Return a list of groups to work on.
1920 Take into consideration N (the prefix) and the list of marked groups."
1923 (setq n (prefix-numeric-value n))
1924 ;; There is a prefix, so we return a list of the N next
1926 (let ((way (if (< n 0) -1 1))
1931 (if (setq group (gnus-group-group-name))
1932 (push group groups))
1934 (gnus-group-next-group way)))
1936 ((and (gnus-region-active-p) (mark))
1937 ;; Work on the region between point and mark.
1938 (let ((max (max (point) (mark)))
1941 (goto-char (min (point) (mark)))
1944 (push (gnus-group-group-name) groups)
1945 (zerop (gnus-group-next-group 1))
1947 (nreverse groups))))
1949 ;; No prefix, but a list of marked articles.
1950 (reverse gnus-group-marked))
1952 ;; Neither marked articles or a prefix, so we return the
1954 (let ((group (gnus-group-group-name)))
1955 (and group (list group))))))
1957 ;;; !!!Surely gnus-group-iterate should be a macro instead? I can't
1958 ;;; imagine why I went through these contortions...
1960 (let ((function (make-symbol "gnus-group-iterate-function"))
1961 (window (make-symbol "gnus-group-iterate-window"))
1962 (groups (make-symbol "gnus-group-iterate-groups"))
1963 (group (make-symbol "gnus-group-iterate-group")))
1965 `(defun gnus-group-iterate (arg ,function)
1966 "Iterate FUNCTION over all process/prefixed groups.
1967 FUNCTION will be called with the group name as the parameter
1968 and with point over the group in question."
1969 (let ((,groups (gnus-group-process-prefix arg))
1970 (,window (selected-window))
1973 (setq ,group (car ,groups)
1974 ,groups (cdr ,groups))
1975 (select-window ,window)
1976 (gnus-group-remove-mark ,group)
1977 (save-selected-window
1979 (funcall ,function ,group)))))))))
1981 (put 'gnus-group-iterate 'lisp-indent-function 1)
1983 ;; Selecting groups.
1985 (defun gnus-group-read-group (&optional all no-article group select-articles)
1986 "Read news in this newsgroup.
1987 If the prefix argument ALL is non-nil, already read articles become
1988 readable. IF ALL is a number, fetch this number of articles. If the
1989 optional argument NO-ARTICLE is non-nil, no article will be
1990 auto-selected upon group entry. If GROUP is non-nil, fetch that
1993 (let ((no-display (eq all 0))
1994 (group (or group (gnus-group-group-name)))
1995 number active marked entry)
1999 (error "No group on current line"))
2000 (setq marked (gnus-info-marks
2001 (nth 2 (setq entry (gnus-group-entry group)))))
2002 ;; This group might be a dead group. In that case we have to get
2003 ;; the number of unread articles from `gnus-active-hashtb'.
2005 (cond ((numberp all) all)
2007 ((setq active (gnus-active group))
2008 (- (1+ (cdr active)) (car active)))))
2009 (gnus-summary-read-group
2010 group (or all (and (numberp number)
2011 (zerop (+ number (gnus-range-length
2012 (cdr (assq 'tick marked)))
2014 (cdr (assq 'dormant marked)))))))
2015 no-article nil no-display nil select-articles)))
2017 (defun gnus-group-select-group (&optional all)
2018 "Select this newsgroup.
2019 No article is selected automatically.
2020 If the group is opened, just switch the summary buffer.
2021 If ALL is non-nil, already read articles become readable.
2022 If ALL is a positive number, fetch this number of the latest
2023 articles in the group.
2024 If ALL is a negative number, fetch this number of the earliest
2025 articles in the group."
2027 (when (and (eobp) (not (gnus-group-group-name)))
2029 (gnus-group-read-group all t))
2031 (defun gnus-group-quick-select-group (&optional all)
2032 "Select the current group \"quickly\".
2033 This means that no highlighting or scoring will be performed.
2034 If ALL (the prefix argument) is 0, don't even generate the summary
2037 This might be useful if you want to toggle threading
2038 before entering the group."
2040 (require 'gnus-score)
2042 gnus-score-find-score-files-function
2043 gnus-home-score-file
2044 gnus-apply-kill-hook
2045 gnus-summary-expunge-below)
2046 (gnus-group-read-group all t)))
2048 (defun gnus-group-visible-select-group (&optional all)
2049 "Select the current group without hiding any articles."
2051 (let ((gnus-inhibit-limiting t))
2052 (gnus-group-read-group all t)))
2054 (defun gnus-group-select-group-ephemerally ()
2055 "Select the current group without doing any processing whatsoever.
2056 You will actually be entered into a group that's a copy of
2057 the current group; no changes you make while in this group will
2060 (require 'gnus-score)
2062 gnus-score-find-score-files-function gnus-apply-kill-hook
2063 gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
2064 gnus-summary-mode-hook gnus-select-group-hook
2065 (group (gnus-group-group-name))
2066 (method (gnus-find-method-for-group group)))
2067 (gnus-group-read-ephemeral-group
2068 (gnus-group-prefixed-name group method) method)))
2071 (defun gnus-fetch-group (group &optional articles)
2072 "Start Gnus if necessary and enter GROUP.
2073 Returns whether the fetching was successful or not."
2074 (interactive (list (completing-read "Group name: " gnus-active-hashtb)))
2075 (unless (get-buffer gnus-group-buffer)
2077 (gnus-group-read-group articles nil group))
2080 (defun gnus-fetch-group-other-frame (group)
2081 "Pop up a frame and enter GROUP."
2083 (let ((window (get-buffer-window gnus-group-buffer)))
2085 (select-frame (window-frame window)))
2086 ((= (length (frame-list)) 1)
2087 (select-frame (make-frame)))
2090 (gnus-fetch-group group))
2092 (defvar gnus-ephemeral-group-server 0)
2094 (defcustom gnus-large-ephemeral-newsgroup 200
2095 "The number of articles which indicates a large ephemeral newsgroup.
2096 Same as `gnus-large-newsgroup', but only used for ephemeral newsgroups.
2098 If the number of articles in a newsgroup is greater than this value,
2099 confirmation is required for selecting the newsgroup. If it is nil, no
2100 confirmation is required."
2102 :group 'gnus-group-select
2103 :type '(choice (const :tag "No limit" nil)
2106 (defcustom gnus-fetch-old-ephemeral-headers nil
2107 "Same as `gnus-fetch-old-headers', but only used for ephemeral newsgroups."
2110 :type '(choice (const :tag "off" nil)
2113 (sexp :menu-tag "other" t)))
2115 ;; Enter a group that is not in the group buffer. Non-nil is returned
2116 ;; if selection was successful.
2117 (defun gnus-group-read-ephemeral-group (group method &optional activate
2118 quit-config request-only
2122 "Read GROUP from METHOD as an ephemeral group.
2123 If ACTIVATE, request the group first.
2124 If QUIT-CONFIG, use that window configuration when exiting from the
2126 If REQUEST-ONLY, don't actually read the group; just request it.
2127 If SELECT-ARTICLES, only select those articles.
2128 If PARAMETERS, use those as the group parameters.
2129 If NUMBER, fetch this number of articles.
2131 Return the name of the group if selection was successful."
2134 ;; (gnus-read-group "Group name: ")
2136 "Group: " gnus-active-hashtb
2138 'gnus-group-history)
2139 (gnus-read-method "From method: ")))
2140 ;; Transform the select method into a unique server.
2141 (when (stringp method)
2142 (setq method (gnus-server-to-method method)))
2144 `(,(car method) ,(concat (cadr method) "-ephemeral")
2145 (,(intern (format "%s-address" (car method))) ,(cadr method))
2147 (let ((group (if (gnus-group-foreign-p group) group
2148 (gnus-group-prefixed-name (gnus-group-real-name group)
2153 ,gnus-level-default-subscribed nil nil ,method
2156 (cons 'quit-config quit-config)
2158 (cons gnus-summary-buffer
2159 gnus-current-window-configuration)))
2162 (push method gnus-ephemeral-servers)
2163 (set-buffer gnus-group-buffer)
2164 (unless (gnus-check-server method)
2165 (error "Unable to contact server: %s" (gnus-status-message method)))
2167 (gnus-activate-group group 'scan)
2168 (unless (gnus-request-group group)
2169 (error "Couldn't request group: %s"
2170 (nnheader-get-report (car method)))))
2174 (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2175 (gnus-fetch-old-headers
2176 gnus-fetch-old-ephemeral-headers))
2177 (gnus-group-read-group (or number t) t group select-articles))
2181 (message "Quit reading the ephemeral group")
2184 (defun gnus-group-jump-to-group (group &optional prompt)
2185 "Jump to newsgroup GROUP.
2187 If PROMPT (the prefix) is a number, use the prompt specified in
2188 `gnus-group-jump-to-group-prompt'."
2190 (list (mm-string-make-unibyte
2192 "Group: " gnus-active-hashtb nil
2193 (gnus-read-active-file-p)
2194 (if current-prefix-arg
2195 (cdr (assq current-prefix-arg gnus-group-jump-to-group-prompt))
2196 (or (and (stringp gnus-group-jump-to-group-prompt)
2197 gnus-group-jump-to-group-prompt)
2198 (let ((p (cdr (assq 0 gnus-group-jump-to-group-prompt))))
2199 (and (stringp p) p))))
2200 'gnus-group-history))))
2202 (when (equal group "")
2203 (error "Empty group name"))
2205 (unless (gnus-ephemeral-group-p group)
2206 ;; Either go to the line in the group buffer...
2207 (unless (gnus-group-goto-group group)
2208 ;; ... or insert the line.
2209 (gnus-group-update-group group)
2210 (gnus-group-goto-group group)))
2211 ;; Adjust cursor point.
2212 (gnus-group-position-point))
2214 (defun gnus-group-goto-group (group &optional far test-marked)
2215 "Goto to newsgroup GROUP.
2216 If FAR, it is likely that the group is not on the current line.
2217 If TEST-MARKED, the line must be marked."
2221 ;; It's quite likely that we are on the right line, so
2222 ;; we check the current line first.
2224 (eq (get-text-property (point) 'gnus-group)
2225 (gnus-intern-safe group gnus-active-hashtb))
2226 (or (not test-marked) (gnus-group-mark-line-p)))
2228 ;; Previous and next line are also likely, so we check them as well.
2232 (and (eq (get-text-property (point) 'gnus-group)
2233 (gnus-intern-safe group gnus-active-hashtb))
2234 (or (not test-marked) (gnus-group-mark-line-p)))))
2240 (and (eq (get-text-property (point) 'gnus-group)
2241 (gnus-intern-safe group gnus-active-hashtb))
2242 (or (not test-marked) (gnus-group-mark-line-p)))))
2246 (goto-char (point-min))
2248 (while (and (not found)
2253 (gnus-intern-safe group gnus-active-hashtb))))
2254 (if (gnus-group-mark-line-p)
2259 ;; Search through the entire buffer.
2262 (point-min) (point-max)
2263 'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2265 (defun gnus-group-next-group (n &optional silent)
2266 "Go to next N'th newsgroup.
2267 If N is negative, search backward instead.
2268 Returns the difference between N and the number of skips actually
2271 (gnus-group-next-unread-group n t nil silent))
2273 (defun gnus-group-next-unread-group (n &optional all level silent)
2274 "Go to next N'th unread newsgroup.
2275 If N is negative, search backward instead.
2276 If ALL is non-nil, choose any newsgroup, unread or not.
2277 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2278 such group can be found, the next group with a level higher than
2280 Returns the difference between N and the number of skips actually
2283 (let ((backward (< n 0))
2286 (gnus-group-search-forward
2287 backward (or (not gnus-group-goto-unread) all) level))
2291 (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2292 (if level " on this level or higher" "")))
2295 (defun gnus-group-prev-group (n)
2296 "Go to previous N'th newsgroup.
2297 Returns the difference between N and the number of skips actually
2300 (gnus-group-next-unread-group (- n) t))
2302 (defun gnus-group-prev-unread-group (n)
2303 "Go to previous N'th unread newsgroup.
2304 Returns the difference between N and the number of skips actually
2307 (gnus-group-next-unread-group (- n)))
2309 (defun gnus-group-next-unread-group-same-level (n)
2310 "Go to next N'th unread newsgroup on the same level.
2311 If N is negative, search backward instead.
2312 Returns the difference between N and the number of skips actually
2315 (gnus-group-next-unread-group n t (gnus-group-group-level))
2316 (gnus-group-position-point))
2318 (defun gnus-group-prev-unread-group-same-level (n)
2319 "Go to next N'th unread newsgroup on the same level.
2320 Returns the difference between N and the number of skips actually
2323 (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2324 (gnus-group-position-point))
2326 (defun gnus-group-best-unread-group (&optional exclude-group)
2327 "Go to the group with the highest level.
2328 If EXCLUDE-GROUP, do not go to that group."
2330 (goto-char (point-min))
2334 (setq unread (get-text-property (point) 'gnus-unread))
2335 (when (and (numberp unread) (> unread 0))
2336 (when (and (get-text-property (point) 'gnus-level)
2337 (< (get-text-property (point) 'gnus-level) best)
2338 (or (not exclude-group)
2339 (not (equal exclude-group (gnus-group-group-name)))))
2340 (setq best (get-text-property (point) 'gnus-level))
2341 (setq best-point (point))))
2344 (goto-char best-point))
2345 (gnus-group-position-point)
2346 (and best-point (gnus-group-group-name))))
2348 ;; Is there something like an after-point-motion-hook?
2349 ;; (inhibit-point-motion-hooks?). Is there a tool-bar-update function?
2351 ;; (defun gnus-group-menu-bar-update ()
2352 ;; (let* ((buf (list (with-current-buffer gnus-group-buffer
2353 ;; (current-buffer))))
2354 ;; (name (buffer-name (car buf))))
2356 ;; (if (> (length name) 27)
2357 ;; (concat (substring name 0 12)
2359 ;; (substring name -12))
2361 ;; (menu-bar-update-buffers-1 buf)))
2363 ;; (defun gnus-group-position-point ()
2364 ;; (gnus-goto-colon)
2365 ;; (gnus-group-menu-bar-update))
2367 (defun gnus-group-first-unread-group ()
2368 "Go to the first group with unread articles."
2371 (let ((opoint (point))
2373 (goto-char (point-min))
2374 (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2375 (and (numberp unread) ; Not a topic.
2376 (not (zerop unread))) ; Has unread articles.
2377 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2380 nil)) ; Not success.
2381 (gnus-group-position-point)))
2383 (defun gnus-group-enter-server-mode ()
2384 "Jump to the server buffer."
2386 (gnus-enter-server-buffer))
2388 (defun gnus-group-make-group-simple (&optional group)
2389 "Add a new newsgroup.
2390 The user will be prompted for GROUP."
2392 (list (completing-read "Group: " gnus-active-hashtb
2393 nil nil nil 'gnus-group-history)))
2394 (gnus-group-make-group
2395 (gnus-group-real-name group)
2396 (gnus-group-server group)))
2398 (defun gnus-group-make-group (name &optional method address args)
2399 "Add a new newsgroup.
2400 The user will be prompted for a NAME, for a select METHOD, and an
2404 (gnus-read-group "Group name: ")
2405 (gnus-read-method "From method: ")))
2407 (when (stringp method)
2408 (setq method (or (gnus-server-to-method method) method)))
2409 (let* ((meth (gnus-method-simplify
2411 (not (gnus-server-equal method gnus-select-method)))
2412 (if address (list (intern method) address)
2414 (nname (if method (gnus-group-prefixed-name name meth) name))
2416 (when (gnus-group-entry nname)
2417 (error "Group %s already exists" (gnus-group-decoded-name nname)))
2418 ;; Subscribe to the new group.
2419 (gnus-group-change-level
2420 (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2421 gnus-level-default-subscribed gnus-level-killed
2422 (and (gnus-group-group-name)
2423 (gnus-group-entry (gnus-group-group-name)))
2426 (gnus-set-active nname (cons 1 0))
2427 (unless (gnus-ephemeral-group-p name)
2429 (concat "(gnus-group-set-info '"
2430 (gnus-prin1-to-string (cdr info)) ")")))
2432 (gnus-group-insert-group-line-info nname)
2434 (gnus-group-position-point)
2436 ;; Load the back end and try to make the back end create
2437 ;; the group as well.
2438 (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2440 gnus-valid-select-methods)
2442 (gnus-check-server meth)
2443 (when (gnus-check-backend-function 'request-create-group nname)
2444 (unless (gnus-request-create-group nname nil args)
2445 (error "Could not create group on server: %s"
2446 (nnheader-get-report backend))))
2449 (defun gnus-group-delete-groups (&optional arg)
2450 "Delete the current group. Only meaningful with editable groups."
2452 (let ((n (length (gnus-group-process-prefix arg))))
2453 (when (gnus-yes-or-no-p
2455 "Delete this 1 group? "
2456 (format "Delete these %d groups? " n)))
2457 (gnus-group-iterate arg
2459 (gnus-group-delete-group group nil t))))))
2461 (defun gnus-group-delete-group (group &optional force no-prompt)
2462 "Delete the current group. Only meaningful with editable groups.
2463 If FORCE (the prefix) is non-nil, all the articles in the group will
2464 be deleted. This is \"deleted\" as in \"removed forever from the face
2465 of the Earth\". There is no undo. The user will be prompted before
2467 Note that you also have to specify FORCE if you want the group to
2468 be removed from the server, even when it's empty."
2470 (list (gnus-group-group-name)
2471 current-prefix-arg))
2473 (error "No group to delete"))
2474 (unless (gnus-check-backend-function 'request-delete-group group)
2475 (error "This back end does not support group deletion"))
2477 (let ((group-decoded (gnus-group-decoded-name group)))
2478 (if (and (not no-prompt)
2479 (not (gnus-yes-or-no-p
2481 "Do you really want to delete %s%s? "
2482 group-decoded (if force " and all its contents" "")))))
2484 (gnus-message 6 "Deleting group %s..." group-decoded)
2485 (if (not (gnus-request-delete-group group force))
2486 (gnus-error 3 "Couldn't delete group %s" group-decoded)
2487 (gnus-message 6 "Deleting group %s...done" group-decoded)
2488 (gnus-group-goto-group group)
2489 (gnus-group-kill-group 1 t)
2490 (gnus-set-active group nil)
2492 (gnus-group-position-point)))
2494 (defun gnus-group-rename-group (group new-name)
2495 "Rename group from GROUP to NEW-NAME.
2496 When used interactively, GROUP is the group under point
2497 and NEW-NAME will be prompted for."
2500 (gnus-group-group-name)
2502 (unless (gnus-check-backend-function
2503 'request-rename-group (gnus-group-group-name))
2504 (error "This back end does not support renaming groups"))
2505 (gnus-read-group "Rename group to: "
2506 (gnus-group-real-name (gnus-group-group-name))))))
2508 (unless (gnus-check-backend-function 'request-rename-group group)
2509 (error "This back end does not support renaming groups"))
2511 (error "No group to rename"))
2512 (when (equal (gnus-group-real-name group) new-name)
2513 (error "Can't rename to the same name"))
2515 ;; We find the proper prefixed name.
2517 (if (gnus-group-native-p group)
2521 (gnus-group-prefixed-name
2522 (gnus-group-real-name new-name)
2523 (gnus-info-method (gnus-get-info group)))))
2525 (when (gnus-active new-name)
2526 (error "The group %s already exists" new-name))
2528 (gnus-message 6 "Renaming group %s to %s..." group new-name)
2531 (gnus-group-goto-group group)
2532 (not (when (< (gnus-group-group-level) gnus-level-zombie)
2533 (gnus-request-rename-group group new-name))))
2534 (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
2535 ;; We rename the group internally by killing it...
2536 (gnus-group-kill-group)
2537 ;; ... changing its name ...
2538 (setcar (cdar gnus-list-of-killed-groups) new-name)
2539 ;; ... and then yanking it. Magic!
2540 (gnus-group-yank-group)
2541 (gnus-set-active new-name (gnus-active group))
2542 (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2544 (setq gnus-killed-list (delete group gnus-killed-list))
2545 (gnus-set-active group nil)
2546 (gnus-dribble-touch)
2547 (gnus-group-position-point)))
2549 (defun gnus-group-edit-group (group &optional part)
2550 "Edit the group on the current line."
2551 (interactive (list (gnus-group-group-name)))
2552 (let ((part (or part 'info))
2555 (error "No group on current line"))
2556 (unless (setq info (gnus-get-info group))
2557 (error "Killed group; can't be edited"))
2559 (gnus-close-group group))
2561 ;; Find the proper form to edit.
2562 (cond ((eq part 'method)
2563 (or (gnus-info-method info) "native"))
2565 (gnus-info-params info))
2567 ;; The proper documentation.
2569 "Editing the %s for `%s'."
2571 ((eq part 'method) "select method")
2572 ((eq part 'params) "group parameters")
2574 (gnus-group-decoded-name group))
2576 (gnus-group-edit-group-done ',part ,group form)))
2579 (gnus-create-info-command
2582 "(gnus)Select Methods")
2584 "(gnus)Group Parameters")
2586 "(gnus)Group Info"))))))
2588 (defun gnus-group-edit-group-method (group)
2589 "Edit the select method of GROUP."
2590 (interactive (list (gnus-group-group-name)))
2591 (gnus-group-edit-group group 'method))
2593 (defun gnus-group-edit-group-parameters (group)
2594 "Edit the group parameters of GROUP."
2595 (interactive (list (gnus-group-group-name)))
2596 (gnus-group-edit-group group 'params))
2598 (defun gnus-group-edit-group-done (part group form)
2600 (let* ((method (cond ((eq part 'info) (nth 4 form))
2601 ((eq part 'method) form)
2603 (info (cond ((eq part 'info) form)
2604 ((eq part 'method) (gnus-get-info group))
2607 (if (or (not method)
2609 gnus-select-method method))
2610 (gnus-group-real-name (car info))
2611 (gnus-group-prefixed-name
2612 (gnus-group-real-name (car info)) method))
2614 (when (and new-group
2615 (not (equal new-group group)))
2616 (when (gnus-group-goto-group group)
2617 (gnus-group-kill-group 1))
2618 (gnus-activate-group new-group))
2620 (if (not (and info new-group))
2621 (gnus-group-set-info form (or new-group group) part)
2622 (setq info (gnus-copy-sequence info))
2623 (setcar info new-group)
2624 (unless (gnus-server-equal method "native")
2625 (unless (nthcdr 3 info)
2626 (nconc info (list nil nil)))
2627 (unless (nthcdr 4 info)
2628 (nconc info (list nil)))
2629 (gnus-info-set-method info method))
2630 (gnus-group-set-info info))
2631 (gnus-group-update-group (or new-group group))
2632 (gnus-group-position-point)))
2634 (defun gnus-group-make-useful-group (group method)
2635 "Create one of the groups described in `gnus-useful-groups'."
2637 (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2639 gnus-useful-groups)))
2640 (list (cadr entry) (caddr entry))))
2641 (setq method (gnus-copy-sequence method))
2643 (while (setq entry (memq (assq 'eval method) method))
2644 (setcar entry (eval (cadar entry)))))
2645 (gnus-group-make-group group method))
2647 (defun gnus-group-make-help-group (&optional noerror)
2648 "Create the Gnus documentation group.
2649 Optional argument NOERROR modifies the behavior of this function when the
2650 group already exists:
2651 - if not given, and error is signaled,
2652 - if t, stay silent,
2653 - if anything else, just print a message."
2655 (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2656 (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2657 (if (gnus-group-entry name)
2658 (cond ((eq noerror nil)
2659 (error "Documentation group already exists"))
2664 (gnus-message 1 "Documentation group already exists")))
2667 (gnus-message 1 "Couldn't find doc group")
2668 (gnus-group-make-group
2669 (gnus-group-real-name name)
2670 (list 'nndoc "gnus-help"
2671 (list 'nndoc-address file)
2672 (list 'nndoc-article-type 'mbox))))
2674 (gnus-group-position-point))
2676 (defun gnus-group-make-doc-group (file type)
2677 "Create a group that uses a single file as the source.
2679 If called with a prefix argument, ask for the file type."
2681 (list (read-file-name "File name: ")
2682 (and current-prefix-arg 'ask)))
2683 (when (eq type 'ask)
2688 "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [m, b, d, f, a, g]: "
2690 (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2691 ((= char ?b) 'babyl)
2692 ((= char ?d) 'digest)
2693 ((= char ?f) 'forward)
2695 ((= char ?g) 'guess)
2696 (t (setq err (format "%c unknown. " char))
2699 (let* ((file (expand-file-name file))
2700 (name (gnus-generate-new-group-name
2701 (gnus-group-prefixed-name
2702 (file-name-nondirectory file) '(nndoc "")))))
2703 (gnus-group-make-group
2704 (gnus-group-real-name name)
2706 (list 'nndoc-address file)
2707 (list 'nndoc-article-type (or type 'guess))))))
2709 (defvar nnweb-type-definition)
2710 (defvar gnus-group-web-type-history nil)
2711 (defvar gnus-group-web-search-history nil)
2712 (defun gnus-group-make-web-group (&optional solid)
2713 "Create an ephemeral nnweb group.
2714 If SOLID (the prefix), create a solid group."
2718 (if solid (gnus-read-group "Group name: ")
2719 (message-unique-id)))
2720 (default-type (or (car gnus-group-web-type-history)
2721 (symbol-name (caar nnweb-type-definition))))
2725 (format "Search engine type (default %s): " default-type)
2726 (mapcar (lambda (elem) (list (symbol-name (car elem))))
2727 nnweb-type-definition)
2728 nil t nil 'gnus-group-web-type-history)
2733 (cons (or (car gnus-group-web-search-history) "") 0)
2734 'gnus-group-web-search-history))
2736 `(nnweb ,group (nnweb-search ,search)
2737 (nnweb-type ,(intern type))
2738 (nnweb-ephemeral-p t))))
2741 (gnus-pull 'nnweb-ephemeral-p method)
2742 (gnus-group-make-group group method))
2743 (gnus-group-read-ephemeral-group
2745 (cons (current-buffer)
2746 (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2749 (defvar nnrss-group-alist)
2750 (defun nnrss-discover-feed (arg))
2751 (defun nnrss-save-server-data (arg)))
2752 (defun gnus-group-make-rss-group (&optional url)
2753 "Given a URL, discover if there is an RSS feed.
2754 If there is, use Gnus to create an nnrss group"
2758 (setq url (read-from-minibuffer "URL to Search for RSS: ")))
2759 (let ((feedinfo (nnrss-discover-feed url)))
2761 (let ((title (gnus-newsgroup-savable-name
2762 (read-from-minibuffer "Title: "
2763 (gnus-newsgroup-savable-name
2764 (or (cdr (assoc 'title
2767 (desc (read-from-minibuffer "Description: "
2768 (cdr (assoc 'description
2770 (href (cdr (assoc 'href feedinfo)))
2771 (encodable (mm-coding-system-p 'utf-8)))
2773 ;; Unify non-ASCII text.
2774 (setq title (mm-decode-coding-string
2775 (mm-encode-coding-string title 'utf-8) 'utf-8)))
2776 (gnus-group-make-group (if encodable
2777 (mm-encode-coding-string title 'utf-8)
2780 (push (list title href desc) nnrss-group-alist)
2781 (nnrss-save-server-data nil))
2782 (error "No feeds found for %s" url))))
2784 (defvar nnwarchive-type-definition)
2785 (defvar gnus-group-warchive-type-history nil)
2786 (defvar gnus-group-warchive-login-history nil)
2787 (defvar gnus-group-warchive-address-history nil)
2789 (defun gnus-group-make-warchive-group ()
2790 "Create a nnwarchive group."
2792 (require 'nnwarchive)
2793 (let* ((group (gnus-read-group "Group name: "))
2794 (default-type (or (car gnus-group-warchive-type-history)
2795 (symbol-name (caar nnwarchive-type-definition))))
2799 (format "Warchive type (default %s): " default-type)
2800 (mapcar (lambda (elem) (list (symbol-name (car elem))))
2801 nnwarchive-type-definition)
2802 nil t nil 'gnus-group-warchive-type-history)
2804 (address (read-string "Warchive address: "
2805 nil 'gnus-group-warchive-address-history))
2806 (default-login (or (car gnus-group-warchive-login-history)
2811 (format "Warchive login (default %s): " user-mail-address)
2812 default-login 'gnus-group-warchive-login-history)
2815 `(nnwarchive ,address
2816 (nnwarchive-type ,(intern type))
2817 (nnwarchive-login ,login))))
2818 (gnus-group-make-group group method)))
2820 (defun gnus-group-make-archive-group (&optional all)
2821 "Create the (ding) Gnus archive group of the most recent articles.
2822 Given a prefix, create a full group."
2824 (let ((group (gnus-group-prefixed-name
2825 (if all "ding.archives" "ding.recent") '(nndir ""))))
2826 (when (gnus-group-entry group)
2827 (error "Archive group already exists"))
2828 (gnus-group-make-group
2829 (gnus-group-real-name group)
2830 (list 'nndir (if all "hpc" "edu")
2831 (list 'nndir-directory
2832 (if all gnus-group-archive-directory
2833 gnus-group-recent-archive-directory))))
2834 (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2836 (defun gnus-group-make-directory-group (dir)
2837 "Create an nndir group.
2838 The user will be prompted for a directory. The contents of this
2839 directory will be used as a newsgroup. The directory should contain
2840 mail messages or news articles in files that have numeric names."
2842 (list (read-file-name "Create group from directory: ")))
2843 (unless (file-exists-p dir)
2844 (error "No such directory"))
2845 (unless (file-directory-p dir)
2846 (error "Not a directory"))
2850 (while (or (not group) (gnus-group-entry group))
2852 (gnus-group-prefixed-name
2853 (expand-file-name ext dir)
2855 (setq ext (format "<%d>" (setq i (1+ i)))))
2856 (gnus-group-make-group
2857 (gnus-group-real-name group)
2858 (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2860 (defvar nnkiboze-score-file)
2861 (defun gnus-group-make-kiboze-group (group address scores)
2862 "Create an nnkiboze group.
2863 The user will be prompted for a name, a regexp to match groups, and
2864 score file entries for articles to include in the group."
2867 (read-string "nnkiboze group name: ")
2868 (read-string "Source groups (regexp): ")
2869 (let ((headers (mapcar 'list
2870 '("subject" "from" "number" "date" "message-id"
2871 "references" "chars" "lines" "xref"
2872 "followup" "all" "body" "head")))
2873 scores header regexp regexps)
2874 (while (not (equal "" (setq header (completing-read
2875 "Match on header: " headers nil t))))
2877 (while (not (equal "" (setq regexp (read-string
2878 (format "Match on %s (regexp): "
2880 (push (list regexp nil nil 'r) regexps))
2881 (push (cons header regexps) scores))
2883 (gnus-group-make-group group "nnkiboze" address)
2884 (let* ((nnkiboze-current-group group)
2885 (score-file (car (nnkiboze-score-file "")))
2886 (score-dir (file-name-directory score-file)))
2887 (unless (file-exists-p score-dir)
2888 (make-directory score-dir))
2889 (with-temp-file score-file
2890 (let (emacs-lisp-mode-hook)
2891 (gnus-pp scores)))))
2893 (defun gnus-group-add-to-virtual (n vgroup)
2894 "Add the current group to a virtual group."
2896 (list current-prefix-arg
2897 (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2899 (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2900 (error "%s is not an nnvirtual group" vgroup))
2901 (gnus-close-group vgroup)
2902 (let* ((groups (gnus-group-process-prefix n))
2903 (method (gnus-info-method (gnus-get-info vgroup))))
2904 (setcar (cdr method)
2906 (nth 1 method) "\\|"
2909 (gnus-group-remove-mark s)
2910 (concat "\\(^" (regexp-quote s) "$\\)"))
2912 (gnus-group-position-point))
2914 (defun gnus-group-make-empty-virtual (group)
2915 "Create a new, fresh, empty virtual group."
2916 (interactive "sCreate new, empty virtual group: ")
2917 (let* ((method (list 'nnvirtual "^$"))
2918 (pgroup (gnus-group-prefixed-name group method)))
2919 ;; Check whether it exists already.
2920 (when (gnus-group-entry pgroup)
2921 (error "Group %s already exists" pgroup))
2922 ;; Subscribe the new group after the group on the current line.
2923 (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2924 (gnus-group-update-group pgroup)
2926 (gnus-group-position-point)))
2928 (defun gnus-group-enter-directory (dir)
2929 "Enter an ephemeral nneething group."
2930 (interactive "DDirectory to read: ")
2931 (let* ((method (list 'nneething dir '(nneething-read-only t)))
2932 (leaf (gnus-group-prefixed-name
2933 (file-name-nondirectory (directory-file-name dir))
2935 (name (gnus-generate-new-group-name leaf)))
2936 (unless (gnus-group-read-ephemeral-group
2938 (cons (current-buffer)
2939 (if (eq major-mode 'gnus-summary-mode)
2941 (error "Couldn't enter %s" dir))))
2944 (autoload 'nnimap-expunge "nnimap")
2945 (autoload 'nnimap-acl-get "nnimap")
2946 (autoload 'nnimap-acl-edit "nnimap"))
2948 (defun gnus-group-nnimap-expunge (group)
2949 "Expunge deleted articles in current nnimap GROUP."
2950 (interactive (list (gnus-group-group-name)))
2951 (let ((mailbox (gnus-group-real-name group)) method)
2953 (error "No group on current line"))
2954 (unless (gnus-get-info group)
2955 (error "Killed group; can't be edited"))
2956 (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
2957 (error "%s is not an nnimap group" group))
2958 (nnimap-expunge mailbox (cadr method))))
2960 (defun gnus-group-nnimap-edit-acl (group)
2961 "Edit the Access Control List of current nnimap GROUP."
2962 (interactive (list (gnus-group-group-name)))
2963 (let ((mailbox (gnus-group-real-name group)) method acl)
2965 (error "No group on current line"))
2966 (unless (gnus-get-info group)
2967 (error "Killed group; can't be edited"))
2968 (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
2969 (error "%s is not an nnimap group" group))
2970 (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
2971 (error "Server does not support ACL's"))
2972 (gnus-edit-form acl (format "Editing the access control list for `%s'.
2974 An access control list is a list of (identifier . rights) elements.
2976 The identifier string specifies the corresponding user. The
2977 identifier \"anyone\" is reserved to refer to the universal identity.
2979 Rights is a string listing a (possibly empty) set of alphanumeric
2980 characters, each character listing a set of operations which is being
2981 controlled. Letters are reserved for ``standard'' rights, listed
2982 below. Digits are reserved for implementation or site defined rights.
2984 l - lookup (mailbox is visible to LIST/LSUB commands)
2985 r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
2986 SEARCH, COPY from mailbox)
2987 s - keep seen/unseen information across sessions (STORE \\SEEN flag)
2988 w - write (STORE flags other than \\SEEN and \\DELETED)
2989 i - insert (perform APPEND, COPY into mailbox)
2990 p - post (send mail to submission address for mailbox,
2991 not enforced by IMAP4 itself)
2992 c - create and delete mailbox (CREATE new sub-mailboxes in any
2993 implementation-defined hierarchy, RENAME or DELETE mailbox)
2994 d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
2995 a - administer (perform SETACL)" group)
2998 ,mailbox ',method ',acl form)))))
3000 ;; Group sorting commands
3001 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
3003 (defun gnus-group-sort-groups (func &optional reverse)
3004 "Sort the group buffer according to FUNC.
3005 When used interactively, the sorting function used will be
3006 determined by the `gnus-group-sort-function' variable.
3007 If REVERSE (the prefix), reverse the sorting order."
3008 (interactive (list gnus-group-sort-function current-prefix-arg))
3009 (funcall gnus-group-sort-alist-function
3010 (gnus-make-sort-function func) reverse)
3011 (gnus-group-unmark-all-groups)
3012 (gnus-group-list-groups)
3013 (gnus-dribble-touch))
3015 (defun gnus-group-sort-flat (func reverse)
3016 ;; We peel off the dummy group from the alist.
3018 (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
3019 (pop gnus-newsrc-alist))
3021 (setq gnus-newsrc-alist
3022 (sort gnus-newsrc-alist func))
3024 (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
3025 ;; Regenerate the hash table.
3026 (gnus-make-hashtable-from-newsrc-alist)))
3028 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
3029 "Sort the group buffer alphabetically by group name.
3030 If REVERSE, sort in reverse order."
3032 (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
3034 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
3035 "Sort the group buffer alphabetically by real (unprefixed) group name.
3036 If REVERSE, sort in reverse order."
3038 (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
3040 (defun gnus-group-sort-groups-by-unread (&optional reverse)
3041 "Sort the group buffer by number of unread articles.
3042 If REVERSE, sort in reverse order."
3044 (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
3046 (defun gnus-group-sort-groups-by-level (&optional reverse)
3047 "Sort the group buffer by group level.
3048 If REVERSE, sort in reverse order."
3050 (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
3052 (defun gnus-group-sort-groups-by-score (&optional reverse)
3053 "Sort the group buffer by group score.
3054 If REVERSE, sort in reverse order."
3056 (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
3058 (defun gnus-group-sort-groups-by-rank (&optional reverse)
3059 "Sort the group buffer by group rank.
3060 If REVERSE, sort in reverse order."
3062 (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
3064 (defun gnus-group-sort-groups-by-method (&optional reverse)
3065 "Sort the group buffer alphabetically by back end name.
3066 If REVERSE, sort in reverse order."
3068 (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
3070 (defun gnus-group-sort-groups-by-server (&optional reverse)
3071 "Sort the group buffer alphabetically by server name.
3072 If REVERSE, sort in reverse order."
3074 (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
3076 ;;; Selected group sorting.
3078 (defun gnus-group-sort-selected-groups (n func &optional reverse)
3079 "Sort the process/prefixed groups."
3080 (interactive (list current-prefix-arg gnus-group-sort-function))
3081 (let ((groups (gnus-group-process-prefix n)))
3082 (funcall gnus-group-sort-selected-function
3083 groups (gnus-make-sort-function func) reverse)
3084 (gnus-group-unmark-all-groups)
3085 (gnus-group-list-groups)
3086 (gnus-dribble-touch)))
3088 (defun gnus-group-sort-selected-flat (groups func reverse)
3089 (let (entries infos)
3090 ;; First find all the group entries for these groups.
3092 (push (nthcdr 2 (gnus-group-entry (pop groups)))
3094 ;; Then sort the infos.
3098 (lambda (entry) (car entry))
3099 (setq entries (nreverse entries)))
3102 (setq infos (nreverse infos)))
3103 ;; Go through all the infos and replace the old entries
3104 ;; with the new infos.
3106 (setcar (car entries) (pop infos))
3108 ;; Update the hashtable.
3109 (gnus-make-hashtable-from-newsrc-alist)))
3111 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
3112 "Sort the group buffer alphabetically by group name.
3113 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3114 sort in reverse order."
3115 (interactive (gnus-interactive "P\ny"))
3116 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
3118 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
3119 "Sort the group buffer alphabetically by real group name.
3120 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3121 sort in reverse order."
3122 (interactive (gnus-interactive "P\ny"))
3123 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
3125 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
3126 "Sort the group buffer by number of unread articles.
3127 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3128 sort in reverse order."
3129 (interactive (gnus-interactive "P\ny"))
3130 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
3132 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
3133 "Sort the group buffer by group level.
3134 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3135 sort in reverse order."
3136 (interactive (gnus-interactive "P\ny"))
3137 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
3139 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
3140 "Sort the group buffer by group score.
3141 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3142 sort in reverse order."
3143 (interactive (gnus-interactive "P\ny"))
3144 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
3146 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
3147 "Sort the group buffer by group rank.
3148 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3149 sort in reverse order."
3150 (interactive (gnus-interactive "P\ny"))
3151 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
3153 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
3154 "Sort the group buffer alphabetically by back end name.
3155 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3156 sort in reverse order."
3157 (interactive (gnus-interactive "P\ny"))
3158 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
3160 ;;; Sorting predicates.
3162 (defun gnus-group-sort-by-alphabet (info1 info2)
3163 "Sort alphabetically."
3164 (string< (gnus-info-group info1) (gnus-info-group info2)))
3166 (defun gnus-group-sort-by-real-name (info1 info2)
3167 "Sort alphabetically on real (unprefixed) names."
3168 (string< (gnus-group-real-name (gnus-info-group info1))
3169 (gnus-group-real-name (gnus-info-group info2))))
3171 (defun gnus-group-sort-by-unread (info1 info2)
3172 "Sort by number of unread articles."
3173 (let ((n1 (gnus-group-unread (gnus-info-group info1)))
3174 (n2 (gnus-group-unread (gnus-info-group info1))))
3175 (< (or (and (numberp n1) n1) 0)
3176 (or (and (numberp n2) n2) 0))))
3178 (defun gnus-group-sort-by-level (info1 info2)
3180 (< (gnus-info-level info1) (gnus-info-level info2)))
3182 (defun gnus-group-sort-by-method (info1 info2)
3183 "Sort alphabetically by back end name."
3184 (string< (car (gnus-find-method-for-group
3185 (gnus-info-group info1) info1))
3186 (car (gnus-find-method-for-group
3187 (gnus-info-group info2) info2))))
3189 (defun gnus-group-sort-by-server (info1 info2)
3190 "Sort alphabetically by server name."
3191 (string< (gnus-method-to-full-server-name
3192 (gnus-find-method-for-group
3193 (gnus-info-group info1) info1))
3194 (gnus-method-to-full-server-name
3195 (gnus-find-method-for-group
3196 (gnus-info-group info2) info2))))
3198 (defun gnus-group-sort-by-score (info1 info2)
3199 "Sort by group score."
3200 (> (gnus-info-score info1) (gnus-info-score info2)))
3202 (defun gnus-group-sort-by-rank (info1 info2)
3203 "Sort by level and score."
3204 (let ((level1 (gnus-info-level info1))
3205 (level2 (gnus-info-level info2)))
3206 (or (< level1 level2)
3207 (and (= level1 level2)
3208 (> (gnus-info-score info1) (gnus-info-score info2))))))
3212 (defun gnus-group-clear-data (&optional arg)
3213 "Clear all marks and read ranges from the current group.
3214 Obeys the process/prefix convention."
3216 (gnus-group-iterate arg
3219 (gnus-info-clear-data (setq info (gnus-get-info group)))
3220 (gnus-get-unread-articles-in-group info (gnus-active group) t)
3221 (when (gnus-group-goto-group group)
3222 (gnus-group-update-group-line))))))
3224 (defun gnus-group-clear-data-on-native-groups ()
3225 "Clear all marks and read ranges from all native groups."
3227 (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3228 (let ((alist (cdr gnus-newsrc-alist))
3230 (while (setq info (pop alist))
3231 (when (gnus-group-native-p (gnus-info-group info))
3232 (gnus-info-clear-data info)))
3233 (gnus-get-unread-articles)
3234 (gnus-dribble-touch)
3235 (when (gnus-y-or-n-p
3236 "Move the cache away to avoid problems in the future? ")
3237 (call-interactively 'gnus-cache-move-cache)))))
3239 (defun gnus-info-clear-data (info)
3240 "Clear all marks and read ranges from INFO."
3241 (let ((group (gnus-info-group info))
3243 (dolist (el (gnus-info-marks info))
3244 (push `(,(cdr el) add (,(car el))) action))
3245 (push `(,(gnus-info-read info) add (read)) action)
3248 (gnus-request-set-mark ,group ',action)
3249 (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3250 (gnus-info-set-read ',info ',(gnus-info-read info))
3251 (when (gnus-group-goto-group ,group)
3252 (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3253 (gnus-group-update-group-line))))
3254 (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3256 (gnus-request-set-mark group action)
3257 (gnus-info-set-read info nil)
3258 (when (gnus-info-marks info)
3259 (gnus-info-set-marks info nil))))
3261 ;; Group catching up.
3263 (defun gnus-group-catchup-current (&optional n all)
3264 "Mark all unread articles in the current newsgroup as read.
3265 If prefix argument N is numeric, the next N newsgroups will be
3266 caught up. If ALL is non-nil, marked articles will also be marked as
3267 read. Cross references (Xref: header) of articles are ignored.
3268 The number of newsgroups that this function was unable to catch
3271 (let ((groups (gnus-group-process-prefix n))
3274 (unless groups (error "No groups selected"))
3276 (or (not gnus-interactive-catchup) ;Without confirmation?
3281 "Do you really want to mark all articles in %s as read? "
3282 "Mark all unread articles in %s as read? ")
3283 (if (= (length groups) 1)
3284 (gnus-group-decoded-name (car groups))
3285 (format "these %d groups" (length groups)))))))
3287 (while (setq group (pop groups))
3288 (gnus-group-remove-mark group)
3289 ;; Virtual groups have to be given special treatment.
3290 (let ((method (gnus-find-method-for-group group)))
3291 (when (eq 'nnvirtual (car method))
3292 (nnvirtual-catchup-group
3293 (gnus-group-real-name group) (nth 1 method) all)))
3294 (if (>= (gnus-group-level group) gnus-level-zombie)
3295 (gnus-message 2 "Dead groups can't be caught up")
3297 (gnus-group-goto-group group)
3298 (gnus-group-catchup group all))
3299 (gnus-group-update-group-line)
3300 (setq ret (1+ ret)))))
3301 (gnus-group-next-unread-group 1)
3304 (defun gnus-group-catchup-current-all (&optional n)
3305 "Mark all articles in current newsgroup as read.
3306 Cross references (Xref: header) of articles are ignored."
3308 (gnus-group-catchup-current n 'all))
3310 (defun gnus-group-catchup (group &optional all)
3311 "Mark all articles in GROUP as read.
3312 If ALL is non-nil, all articles are marked as read.
3313 The return value is the number of articles that were marked as read,
3314 or nil if no action could be taken."
3315 (let* ((entry (gnus-group-entry group))
3317 (marks (gnus-info-marks (nth 2 entry)))
3318 (unread (gnus-sequence-of-unread-articles group)))
3319 ;; Remove entries for this group.
3320 (nnmail-purge-split-history (gnus-group-real-name group))
3321 ;; Do the updating only if the newsgroup isn't killed.
3322 (if (not (numberp (car entry)))
3323 (gnus-message 1 "Can't catch up %s; non-active group" group)
3324 (gnus-update-read-articles group nil)
3326 ;; Nix out the lists of marks and dormants.
3327 (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3329 (list (cdr (assq 'dormant marks))
3331 (setq unread (gnus-range-add (gnus-range-add
3332 unread (cdr (assq 'dormant marks)))
3333 (cdr (assq 'tick marks))))
3334 (gnus-add-marked-articles group 'tick nil nil 'force)
3335 (gnus-add-marked-articles group 'dormant nil nil 'force))
3336 ;; Do auto-expirable marks if that's required.
3337 (when (gnus-group-auto-expirable-p group)
3338 (gnus-range-map (lambda (article)
3339 (gnus-add-marked-articles group 'expire (list article))
3340 (gnus-request-set-mark group (list (list (list article) 'add '(expire)))))
3342 (let ((gnus-newsgroup-name group))
3343 (gnus-run-hooks 'gnus-group-catchup-group-hook))
3346 (defun gnus-group-expire-articles (&optional n)
3347 "Expire all expirable articles in the current newsgroup.
3348 Uses the process/prefix convention."
3350 (let ((groups (gnus-group-process-prefix n))
3353 (error "No groups to expire"))
3354 (while (setq group (pop groups))
3355 (gnus-group-remove-mark group)
3356 (gnus-group-expire-articles-1 group)
3357 (gnus-dribble-touch)
3358 (gnus-group-position-point))))
3360 (defun gnus-group-expire-articles-1 (group)
3361 (when (gnus-check-backend-function 'request-expire-articles group)
3362 (gnus-message 6 "Expiring articles in %s..."
3363 (gnus-group-decoded-name group))
3364 (let* ((info (gnus-get-info group))
3365 (expirable (if (gnus-group-total-expirable-p group)
3366 (cons nil (gnus-list-of-read-articles group))
3367 (assq 'expire (gnus-info-marks info))))
3368 (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3369 (nnmail-expiry-target
3370 (or (gnus-group-find-parameter group 'expiry-target)
3371 nnmail-expiry-target)))
3373 (gnus-check-group group)
3376 (gnus-compress-sequence
3378 ;; We set the expiry variables to the group
3380 (let ((nnmail-expiry-wait-function nil)
3381 (nnmail-expiry-wait expiry-wait))
3382 (gnus-request-expire-articles
3383 (gnus-uncompress-sequence (cdr expirable)) group))
3384 ;; Just expire using the normal expiry values.
3385 (gnus-request-expire-articles
3386 (gnus-uncompress-sequence (cdr expirable)) group))))
3387 (gnus-close-group group))
3388 (gnus-message 6 "Expiring articles in %s...done"
3389 (gnus-group-decoded-name group))
3390 ;; Return the list of un-expired articles.
3393 (defun gnus-group-expire-all-groups ()
3394 "Expire all expirable articles in all newsgroups."
3397 (gnus-message 5 "Expiring...")
3398 (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3399 (cdr gnus-newsrc-alist))))
3400 (gnus-group-expire-articles nil)))
3401 (gnus-group-position-point)
3402 (gnus-message 5 "Expiring...done"))
3404 (defun gnus-group-set-current-level (n level)
3405 "Set the level of the next N groups to LEVEL."
3410 (unless (gnus-group-process-prefix current-prefix-arg)
3411 (error "No group on the current line"))
3413 (let ((s (read-string
3414 (format "Level (default %s): "
3415 (or (gnus-group-group-level)
3416 gnus-level-default-subscribed)))))
3417 (if (string-match "^\\s-*$" s)
3418 (int-to-string (or (gnus-group-group-level)
3419 gnus-level-default-subscribed))
3421 (unless (and (>= level 1) (<= level gnus-level-killed))
3422 (error "Invalid level: %d" level))
3423 (dolist (group (gnus-group-process-prefix n))
3424 (gnus-group-remove-mark group)
3425 (gnus-message 6 "Changed level of %s from %d to %d"
3426 (gnus-group-decoded-name group)
3427 (or (gnus-group-group-level) gnus-level-killed)
3429 (gnus-group-change-level
3430 group level (or (gnus-group-group-level) gnus-level-killed))
3431 (gnus-group-update-group-line))
3432 (gnus-group-position-point))
3434 (defun gnus-group-unsubscribe (&optional n)
3435 "Unsubscribe the current group."
3437 (gnus-group-unsubscribe-current-group n 'unsubscribe))
3439 (defun gnus-group-subscribe (&optional n)
3440 "Subscribe the current group."
3442 (gnus-group-unsubscribe-current-group n 'subscribe))
3444 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3445 "Toggle subscription of the current group.
3446 If given numerical prefix, toggle the N next groups."
3448 (dolist (group (gnus-group-process-prefix n))
3449 (gnus-group-remove-mark group)
3450 (gnus-group-unsubscribe-group
3453 ((eq do-sub 'unsubscribe)
3454 gnus-level-default-unsubscribed)
3455 ((eq do-sub 'subscribe)
3456 gnus-level-default-subscribed)
3457 ((<= (gnus-group-group-level) gnus-level-subscribed)
3458 gnus-level-default-unsubscribed)
3460 gnus-level-default-subscribed))
3462 (gnus-group-update-group-line))
3463 (gnus-group-next-group 1))
3465 (defun gnus-group-unsubscribe-group (group &optional level silent)
3466 "Toggle subscription to GROUP.
3467 Killed newsgroups are subscribed. If SILENT, don't try to update the
3470 (list (completing-read
3471 "Group: " gnus-active-hashtb nil
3472 (gnus-read-active-file-p)
3474 'gnus-group-history)))
3475 (let ((newsrc (gnus-group-entry group)))
3477 ((string-match "^[ \t]*$" group)
3478 (error "Empty group name"))
3480 ;; Toggle subscription flag.
3481 (gnus-group-change-level
3482 newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3483 gnus-level-subscribed)
3484 (1+ gnus-level-subscribed)
3485 gnus-level-default-subscribed)))
3487 (gnus-group-update-group group)))
3488 ((and (stringp group)
3489 (or (not (gnus-read-active-file-p))
3490 (gnus-active group)))
3491 ;; Add new newsgroup.
3492 (gnus-group-change-level
3494 (if level level gnus-level-default-subscribed)
3495 (or (and (member group gnus-zombie-list)
3498 (when (gnus-group-group-name)
3499 (gnus-group-entry (gnus-group-group-name))))
3501 (gnus-group-update-group group)))
3502 (t (error "No such newsgroup: %s" group)))
3503 (gnus-group-position-point)))
3505 (defun gnus-group-transpose-groups (n)
3506 "Move the current newsgroup up N places.
3507 If given a negative prefix, move down instead. The difference between
3508 N and the number of steps taken is returned."
3510 (unless (gnus-group-group-name)
3511 (error "No group on current line"))
3512 (gnus-group-kill-group 1)
3514 (forward-line (- n))
3515 (gnus-group-yank-group)
3516 (gnus-group-position-point)))
3518 (defun gnus-group-kill-all-zombies (&optional dummy)
3519 "Kill all zombie newsgroups.
3520 The optional DUMMY should always be nil."
3521 (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3523 (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3524 (setq gnus-zombie-list nil)
3525 (gnus-dribble-touch)
3526 (gnus-group-list-groups)))
3528 (defun gnus-group-kill-region (begin end)
3529 "Kill newsgroups in current region (excluding current point).
3530 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3543 (beginning-of-line) ;Important when LINES < 1
3544 (gnus-group-kill-group lines)))
3546 (defun gnus-group-kill-group (&optional n discard)
3547 "Kill the next N groups.
3548 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3549 However, only groups that were alive can be yanked; already killed
3550 groups or zombie groups can't be yanked.
3551 The return value is the name of the group that was killed, or a list
3554 (let ((buffer-read-only nil)
3555 (groups (gnus-group-process-prefix n))
3556 group entry level out)
3557 (if (< (length groups) 10)
3558 ;; This is faster when there are few groups.
3560 (push (setq group (pop groups)) out)
3561 (gnus-group-remove-mark group)
3562 (setq level (gnus-group-group-level))
3564 (when (and (not discard)
3565 (setq entry (gnus-group-entry group)))
3568 (gnus-group-goto-group ,(gnus-group-group-name))
3569 (gnus-group-yank-group)))
3570 (push (cons (car entry) (nth 2 entry))
3571 gnus-list-of-killed-groups))
3572 (gnus-group-change-level
3573 (if entry entry group) gnus-level-killed (if entry nil level))
3574 (message "Killed group %s" (gnus-group-decoded-name group)))
3575 ;; If there are lots and lots of groups to be killed, we use
3576 ;; this thing instead.
3577 (dolist (group (nreverse groups))
3578 (gnus-group-remove-mark group)
3580 (push group gnus-killed-list)
3581 (setq gnus-newsrc-alist
3582 (delq (assoc group gnus-newsrc-alist)
3584 (when gnus-group-change-level-function
3585 (funcall gnus-group-change-level-function
3586 group gnus-level-killed 3))
3588 ((setq entry (gnus-group-entry group))
3589 (push (cons (car entry) (nth 2 entry))
3590 gnus-list-of-killed-groups)
3591 (setcdr (cdr entry) (cdddr entry)))
3592 ((member group gnus-zombie-list)
3593 (setq gnus-zombie-list (delete group gnus-zombie-list))))
3594 ;; There may be more than one instance displayed.
3595 (while (gnus-group-goto-group group)
3596 (gnus-delete-line)))
3597 (gnus-make-hashtable-from-newsrc-alist))
3599 (gnus-group-position-point)
3600 (if (< (length out) 2) (car out) (nreverse out))))
3602 (defun gnus-group-yank-group (&optional arg)
3603 "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3604 The numeric ARG specifies how many newsgroups are to be yanked. The
3605 name of the newsgroup yanked is returned, or (if several groups are
3606 yanked) a list of yanked groups is returned."
3608 (setq arg (or arg 1))
3609 (let (info group prev out)
3610 (while (>= (decf arg) 0)
3611 (when (not (setq info (pop gnus-list-of-killed-groups)))
3612 (error "No more newsgroups to yank"))
3613 (push (setq group (nth 1 info)) out)
3614 ;; Find which newsgroup to insert this one before - search
3615 ;; backward until something suitable is found. If there are no
3616 ;; other newsgroups in this buffer, just make this newsgroup the
3618 (setq prev (gnus-group-group-name))
3619 (gnus-group-change-level
3620 info (gnus-info-level (cdr info)) gnus-level-killed
3621 (and prev (gnus-group-entry prev))
3623 (gnus-group-insert-group-line-info group)
3625 `(when (gnus-group-goto-group ,group)
3626 (gnus-group-kill-group 1))))
3628 (gnus-group-position-point)
3629 (if (< (length out) 2) (car out) (nreverse out))))
3631 (defun gnus-group-kill-level (level)
3632 "Kill all groups that is on a certain LEVEL."
3633 (interactive "nKill all groups on level: ")
3635 ((= level gnus-level-zombie)
3636 (setq gnus-killed-list
3637 (nconc gnus-zombie-list gnus-killed-list))
3638 (setq gnus-zombie-list nil))
3639 ((and (< level gnus-level-zombie)
3641 (or gnus-expert-user
3644 "Do you really want to kill all groups on level %d? "
3646 (let* ((prev gnus-newsrc-alist)
3649 (if (= (gnus-info-level (car alist)) level)
3651 (push (gnus-info-group (car alist)) gnus-killed-list)
3652 (setcdr prev (cdr alist)))
3654 (setq alist (cdr alist)))
3655 (gnus-make-hashtable-from-newsrc-alist)
3656 (gnus-group-list-groups)))
3658 (error "Can't kill; invalid level: %d" level))))
3660 (defun gnus-group-list-all-groups (&optional arg)
3661 "List all newsgroups with level ARG or lower.
3662 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3663 unsubscribed groups."
3665 (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3667 ;; Redefine this to list ALL killed groups if prefix arg used.
3668 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3669 (defun gnus-group-list-killed (&optional arg)
3670 "List all killed newsgroups in the group buffer.
3671 If ARG is non-nil, list ALL killed groups known to Gnus. This may
3672 entail asking the server for the groups."
3674 ;; Find all possible killed newsgroups if arg.
3676 (gnus-get-killed-groups))
3677 (if (not gnus-killed-list)
3678 (gnus-message 6 "No killed groups")
3679 (let (gnus-group-list-mode)
3680 (funcall gnus-group-prepare-function
3681 gnus-level-killed t gnus-level-killed))
3682 (goto-char (point-min)))
3683 (gnus-group-position-point))
3685 (defun gnus-group-list-zombies ()
3686 "List all zombie newsgroups in the group buffer."
3688 (if (not gnus-zombie-list)
3689 (gnus-message 6 "No zombie groups")
3690 (let (gnus-group-list-mode)
3691 (funcall gnus-group-prepare-function
3692 gnus-level-zombie t gnus-level-zombie))
3693 (goto-char (point-min)))
3694 (gnus-group-position-point))
3696 (defun gnus-group-list-active ()
3697 "List all groups that are available from the server(s)."
3699 ;; First we make sure that we have really read the active file.
3700 (unless (gnus-read-active-file-p)
3701 (let ((gnus-read-active-file t)
3702 (gnus-agent gnus-plugged)); If we're actually plugged, store the active file in the agent.
3703 (gnus-read-active-file)))
3704 ;; Find all groups and sort them.
3712 (push (symbol-name sym) list)))
3716 (buffer-read-only nil)
3720 (setq group (pop groups))
3721 (gnus-add-text-properties
3722 (point) (prog1 (1+ (point))
3724 (gnus-group-decoded-name group)
3726 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3728 'gnus-level (inline (gnus-group-level group)))))
3729 (goto-char (point-min))))
3731 (defun gnus-activate-all-groups (level)
3732 "Activate absolutely all groups."
3733 (interactive (list gnus-level-unsubscribed))
3734 (let ((gnus-activate-level level)
3735 (gnus-activate-foreign-newsgroups level))
3736 (gnus-group-get-new-news)))
3738 (defun gnus-group-get-new-news (&optional arg)
3739 "Get newly arrived articles.
3740 If ARG is a number, it specifies which levels you are interested in
3741 re-scanning. If ARG is non-nil and not a number, this will force
3742 \"hard\" re-reading of the active files from all servers."
3745 (let ((gnus-inhibit-demon t)
3746 ;; Binding this variable will inhibit multiple fetchings
3747 ;; of the same mail source.
3748 (nnmail-fetched-sources (list t)))
3749 (gnus-run-hooks 'gnus-get-top-new-news-hook)
3750 (gnus-run-hooks 'gnus-get-new-news-hook)
3752 ;; Read any slave files.
3754 (gnus-master-read-slave-newsrc))
3756 ;; We might read in new NoCeM messages here.
3757 (when (and gnus-use-nocem
3759 (gnus-nocem-scan-groups))
3760 ;; If ARG is not a number, then we read the active file.
3761 (when (and arg (not (numberp arg)))
3762 (let ((gnus-read-active-file t))
3763 (gnus-read-active-file))
3766 ;; If the user wants it, we scan for new groups.
3767 (when (eq gnus-check-new-newsgroups 'always)
3768 (gnus-find-new-newsgroups)))
3770 (setq arg (gnus-group-default-level arg t))
3771 (if (and gnus-read-active-file (not arg))
3773 (gnus-read-active-file)
3774 (gnus-get-unread-articles arg))
3775 (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
3776 (gnus-get-unread-articles arg)))
3777 (gnus-check-reasonable-setup)
3778 (gnus-run-hooks 'gnus-after-getting-new-news-hook)
3779 (gnus-group-list-groups (and (numberp arg)
3780 (max (car gnus-group-list-mode) arg)))))
3782 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
3783 "Check for newly arrived news in the current group (and the N-1 next groups).
3784 The difference between N and the number of newsgroup checked is returned.
3785 If N is negative, this group and the N-1 previous groups will be checked.
3786 If DONT-SCAN is non-nil, scan non-activated groups as well."
3788 (let* ((groups (gnus-group-process-prefix n))
3789 (ret (if (numberp n) (- n (length groups)) 0))
3793 (gnus-inhibit-demon t)
3794 ;; Binding this variable will inhibit multiple fetchings
3795 ;; of the same mail source.
3796 (nnmail-fetched-sources (list t)))
3797 (gnus-run-hooks 'gnus-get-new-news-hook)
3798 (while (setq group (pop groups))
3799 (gnus-group-remove-mark group)
3800 ;; Bypass any previous denials from the server.
3801 (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
3802 (if (gnus-activate-group group (if dont-scan nil 'scan) nil method)
3803 (let ((info (gnus-get-info group))
3804 (active (gnus-active group)))
3806 (gnus-request-update-info info method))
3807 (gnus-get-unread-articles-in-group info active)
3808 (unless (gnus-virtual-group-p group)
3809 (gnus-close-group group))
3811 (gnus-agent-save-group-info
3812 method (gnus-group-real-name group) active))
3813 (gnus-group-update-group group))
3814 (if (eq (gnus-server-status (gnus-find-method-for-group group))
3816 (gnus-error 3 "Server denied access")
3817 (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3820 (when gnus-goto-next-group-when-activating
3821 (gnus-group-next-unread-group 1 t))
3822 (gnus-summary-position-point)
3825 (defun gnus-group-fetch-faq (group &optional faq-dir)
3826 "Fetch the FAQ for the current group.
3827 If given a prefix argument, prompt for the FAQ dir
3831 (gnus-group-group-name)
3832 (when current-prefix-arg
3834 "FAQ dir: " (and (listp gnus-group-faq-directory)
3836 gnus-group-faq-directory))))))
3838 (error "No group name given"))
3839 (let ((dirs (or faq-dir gnus-group-faq-directory))
3841 (unless (listp dirs)
3842 (setq dirs (list dirs)))
3843 (while (and (not found)
3844 (setq dir (pop dirs)))
3845 (let ((name (gnus-group-real-name group)))
3846 (setq file (expand-file-name name dir)))
3847 (if (not (file-exists-p file))
3848 (gnus-message 1 "No such file: %s" file)
3849 (let ((enable-local-variables nil))
3853 (defun gnus-group-fetch-charter (group)
3854 "Fetch the charter for the current group.
3855 If given a prefix argument, prompt for a group."
3857 (list (or (when current-prefix-arg
3858 (completing-read "Group: " gnus-active-hashtb))
3859 (gnus-group-group-name)
3860 gnus-newsgroup-name)))
3862 (error "No group name given"))
3864 (condition-case nil (require 'url-http) (error nil))
3865 (let ((name (mm-url-form-encode-xwfu (gnus-group-real-name group)))
3867 (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3868 (setq hierarchy (match-string 1 name))
3869 (if (and (setq url (cdr (assoc hierarchy gnus-group-charter-alist)))
3870 (if (fboundp 'url-http-file-exists-p)
3871 (url-http-file-exists-p (eval url))
3873 (browse-url (eval url))
3874 (setq url (concat "http://" hierarchy
3875 ".news-admin.org/charters/" name))
3876 (if (and (fboundp 'url-http-file-exists-p)
3877 (url-http-file-exists-p url))
3879 (gnus-group-fetch-control group))))))
3881 (defun gnus-group-fetch-control (group)
3882 "Fetch the archived control messages for the current group.
3883 If given a prefix argument, prompt for a group."
3885 (list (or (when current-prefix-arg
3886 (completing-read "Group: " gnus-active-hashtb))
3887 (gnus-group-group-name)
3888 gnus-newsgroup-name)))
3890 (error "No group name given"))
3891 (let ((name (gnus-group-real-name group))
3893 (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3894 (setq hierarchy (match-string 1 name))
3895 (if gnus-group-fetch-control-use-browse-url
3896 (browse-url (concat "ftp://ftp.isc.org/usenet/control/"
3897 hierarchy "/" name ".gz"))
3898 (let ((enable-local-variables nil))
3899 (gnus-group-read-ephemeral-group
3901 `(nndoc ,group (nndoc-address
3902 ,(find-file-noselect
3903 (concat "/ftp@ftp.isc.org:/usenet/control/"
3904 hierarchy "/" name ".gz")))
3905 (nndoc-article-type mbox)) t nil nil))))))
3907 (defun gnus-group-describe-group (force &optional group)
3908 "Display a description of the current newsgroup."
3909 (interactive (list current-prefix-arg (gnus-group-group-name)))
3910 (let* ((method (gnus-find-method-for-group group))
3911 (mname (gnus-group-prefixed-name "" method))
3914 gnus-description-hashtb)
3915 (gnus-sethash mname nil gnus-description-hashtb))
3917 (error "No group name given"))
3918 (when (or (and gnus-description-hashtb
3919 ;; We check whether this group's method has been
3920 ;; queried for a description file.
3921 (gnus-gethash mname gnus-description-hashtb))
3922 (setq desc (gnus-group-get-description group))
3923 (gnus-read-descriptions-file method))
3925 (or desc (gnus-gethash group gnus-description-hashtb)
3926 "No description available")))))
3928 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3929 (defun gnus-group-describe-all-groups (&optional force)
3930 "Pop up a buffer with descriptions of all newsgroups."
3933 (setq gnus-description-hashtb nil))
3934 (when (not (or gnus-description-hashtb
3935 (gnus-read-all-descriptions-files)))
3936 (error "Couldn't request descriptions file"))
3937 (let ((buffer-read-only nil)
3943 (let ((charset (gnus-group-name-charset nil (symbol-name group))))
3944 (insert (format " *: %-20s %s\n"
3945 (gnus-group-name-decode
3946 (symbol-name group) charset)
3947 (gnus-group-name-decode
3948 (symbol-value group) charset))))
3949 (gnus-add-text-properties
3950 b (1+ b) (list 'gnus-group group
3951 'gnus-unread t 'gnus-marked nil
3952 'gnus-level (1+ gnus-level-subscribed))))
3953 gnus-description-hashtb)
3954 (goto-char (point-min))
3955 (gnus-group-position-point)))
3957 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
3958 (defun gnus-group-apropos (regexp &optional search-description)
3959 "List all newsgroups that have names that match a regexp."
3960 (interactive "sGnus apropos (regexp): ")
3962 (obuf (current-buffer))
3964 ;; Go through all newsgroups that are known to Gnus.
3967 (and (symbol-name group)
3968 (string-match regexp (symbol-name group))
3969 (symbol-value group)
3970 (push (symbol-name group) groups)))
3972 ;; Also go through all descriptions that are known to Gnus.
3973 (when search-description
3976 (and (string-match regexp (symbol-value group))
3977 (push (symbol-name group) groups)))
3978 gnus-description-hashtb))
3980 (gnus-message 3 "No groups matched \"%s\"." regexp)
3981 ;; Print out all the groups.
3983 (pop-to-buffer "*Gnus Help*")
3984 (buffer-disable-undo)
3986 (setq groups (sort groups 'string<))
3988 ;; Groups may be entered twice into the list of groups.
3989 (when (not (string= (car groups) prev))
3990 (setq prev (car groups))
3991 (let ((charset (gnus-group-name-charset nil prev)))
3992 (insert (gnus-group-name-decode prev charset) "\n")
3993 (when (and gnus-description-hashtb
3994 (setq des (gnus-gethash (car groups)
3995 gnus-description-hashtb)))
3996 (insert " " (gnus-group-name-decode des charset) "\n"))))
3997 (setq groups (cdr groups)))
3998 (goto-char (point-min))))
3999 (pop-to-buffer obuf)))
4001 (defun gnus-group-description-apropos (regexp)
4002 "List all newsgroups that have names or descriptions that match REGEXP."
4003 (interactive "sGnus description apropos (regexp): ")
4004 (when (not (or gnus-description-hashtb
4005 (gnus-read-all-descriptions-files)))
4006 (error "Couldn't request descriptions file"))
4007 (gnus-group-apropos regexp t))
4009 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4010 (defun gnus-group-list-matching (level regexp &optional all lowest)
4011 "List all groups with unread articles that match REGEXP.
4012 If the prefix LEVEL is non-nil, it should be a number that says which
4013 level to cut off listing groups.
4014 If ALL, also list groups with no unread articles.
4015 If LOWEST, don't list groups with level lower than LOWEST.
4017 This command may read the active file."
4018 (interactive "P\nsList newsgroups matching: ")
4019 ;; First make sure active file has been read.
4021 (> (prefix-numeric-value level) gnus-level-killed))
4022 (gnus-get-killed-groups))
4023 (funcall gnus-group-prepare-function
4024 (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
4025 (goto-char (point-min))
4026 (gnus-group-position-point))
4028 (defun gnus-group-list-all-matching (level regexp &optional lowest)
4029 "List all groups that match REGEXP.
4030 If the prefix LEVEL is non-nil, it should be a number that says which
4031 level to cut off listing groups.
4032 If LOWEST, don't list groups with level lower than LOWEST."
4033 (interactive "P\nsList newsgroups matching: ")
4035 (setq level (prefix-numeric-value level)))
4036 (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
4038 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
4039 (defun gnus-group-save-newsrc (&optional force)
4040 "Save the Gnus startup files.
4041 If FORCE, force saving whether it is necessary or not."
4043 (gnus-save-newsrc-file force))
4045 (defun gnus-group-restart (&optional arg)
4046 "Force Gnus to read the .newsrc file."
4048 (when (gnus-yes-or-no-p
4049 (format "Are you sure you want to restart Gnus? "))
4050 (gnus-save-newsrc-file)
4054 (defun gnus-group-read-init-file ()
4055 "Read the Gnus elisp init file."
4057 (gnus-read-init-file)
4058 (gnus-message 5 "Read %s" gnus-init-file))
4060 (defun gnus-group-check-bogus-groups (&optional silent)
4061 "Check bogus newsgroups.
4062 If given a prefix, don't ask for confirmation before removing a bogus
4065 (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
4066 (gnus-group-list-groups))
4068 (defun gnus-group-find-new-groups (&optional arg)
4069 "Search for new groups and add them.
4070 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
4071 With 1 C-u, use the `ask-server' method to query the server for new
4073 With 2 C-u's, use most complete method possible to query the server
4074 for new groups, and subscribe the new groups as zombies."
4076 (gnus-find-new-newsgroups (or arg 1))
4077 (gnus-group-list-groups))
4079 (defun gnus-group-edit-global-kill (&optional article group)
4080 "Edit the global kill file.
4081 If GROUP, edit that local kill file instead."
4083 (setq gnus-current-kill-article article)
4084 (gnus-kill-file-edit-file group)
4087 (substitute-command-keys
4088 (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
4089 (if group "local" "global")))))
4091 (defun gnus-group-edit-local-kill (article group)
4092 "Edit a local kill file."
4093 (interactive (list nil (gnus-group-group-name)))
4094 (gnus-group-edit-global-kill article group))
4096 (defun gnus-group-force-update ()
4097 "Update `.newsrc' file."
4099 (gnus-save-newsrc-file))
4101 (defvar gnus-backlog-articles)
4103 (defun gnus-group-suspend ()
4104 "Suspend the current Gnus session.
4105 In fact, cleanup buffers except for group mode buffer.
4106 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
4108 (gnus-run-hooks 'gnus-suspend-gnus-hook)
4109 (gnus-offer-save-summaries)
4110 ;; Kill Gnus buffers except for group mode buffer.
4111 (let ((group-buf (get-buffer gnus-group-buffer)))
4112 (mapcar (lambda (buf)
4113 (unless (or (member buf (list group-buf gnus-dribble-buffer))
4114 (with-current-buffer buf
4115 (eq major-mode 'message-mode)))
4116 (gnus-kill-buffer buf)))
4118 (setq gnus-backlog-articles nil)
4119 (gnus-kill-gnus-frames)
4121 (bury-buffer group-buf)
4122 (delete-windows-on group-buf t))))
4124 (defun gnus-group-clear-dribble ()
4125 "Clear all information from the dribble buffer."
4127 (gnus-dribble-clear)
4128 (gnus-message 7 "Cleared dribble buffer"))
4130 (defun gnus-group-exit ()
4131 "Quit reading news after updating .newsrc.eld and .newsrc.
4132 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4135 (or noninteractive ;For gnus-batch-kill
4136 (not gnus-interactive-exit) ;Without confirmation
4138 (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
4139 (gnus-run-hooks 'gnus-exit-gnus-hook)
4140 ;; Offer to save data from non-quitted summary buffers.
4141 (gnus-offer-save-summaries)
4142 ;; Save the newsrc file(s).
4143 (gnus-save-newsrc-file)
4145 (gnus-close-backends)
4146 ;; Reset everything.
4148 ;; Allow the user to do things after cleaning up.
4149 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4151 (defun gnus-group-quit ()
4152 "Quit reading news without updating .newsrc.eld or .newsrc.
4153 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4155 (when (or noninteractive ;For gnus-batch-kill
4156 (zerop (buffer-size))
4157 (not (gnus-server-opened gnus-select-method))
4159 (not gnus-current-startup-file)
4161 (format "Quit reading news without saving %s? "
4162 (file-name-nondirectory gnus-current-startup-file))))
4163 (gnus-run-hooks 'gnus-exit-gnus-hook)
4164 (gnus-configure-windows 'group t)
4165 (when (and (gnus-buffer-live-p gnus-dribble-buffer)
4166 (not (zerop (save-excursion
4167 (set-buffer gnus-dribble-buffer)
4170 ";;; Gnus was exited on purpose without saving the .newsrc files."))
4172 (gnus-close-backends)
4174 (gnus-kill-buffer gnus-group-buffer)
4175 ;; Allow the user to do things after cleaning up.
4176 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4178 (defun gnus-group-describe-briefly ()
4179 "Give a one line description of the group mode commands."
4181 (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")))
4183 (defun gnus-group-browse-foreign-server (method)
4184 "Browse a foreign news server.
4185 If called interactively, this function will ask for a select method
4186 (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
4187 If not, METHOD should be a list where the first element is the method
4188 and the second element is the address."
4190 (list (let ((how (completing-read
4192 (append gnus-valid-select-methods gnus-server-alist)
4193 nil t (cons "nntp" 0) 'gnus-method-history)))
4194 ;; We either got a back end name or a virtual server name.
4195 ;; If the first, we also need an address.
4196 (if (assoc how gnus-valid-select-methods)
4198 ;; Suggested by mapjph@bath.ac.uk.
4201 (mapcar 'list gnus-secondary-servers)))
4202 ;; We got a server name.
4204 (gnus-browse-foreign-server method))
4206 (defun gnus-group-set-info (info &optional method-only-group part)
4207 (when (or info part)
4208 (let* ((entry (gnus-group-entry
4209 (or method-only-group (gnus-info-group info))))
4211 (info (if method-only-group (nth 2 entry) info))
4213 (when method-only-group
4215 (error "Trying to change non-existent group %s" method-only-group))
4216 ;; We have received parts of the actual group info - either the
4217 ;; select method or the group parameters. We first check
4218 ;; whether we have to extend the info, and if so, do that.
4219 (let ((len (length info))
4220 (total (if (eq part 'method) 5 6)))
4222 (setcdr (nthcdr (1- len) info)
4223 (make-list (- total len) nil)))
4224 ;; Then we enter the new info.
4225 (setcar (nthcdr (1- total) info) part-info)))
4227 ;; This is a new group, so we just create it.
4229 (set-buffer gnus-group-buffer)
4230 (setq method (gnus-info-method info))
4231 (when (gnus-server-equal method "native")
4234 (set-buffer gnus-group-buffer)
4236 ;; It's a foreign group...
4237 (gnus-group-make-group
4238 (gnus-group-real-name (gnus-info-group info))
4239 (if (stringp method) method
4240 (prin1-to-string (car method)))
4242 (nth 1 (gnus-info-method info))))
4243 ;; It's a native group.
4244 (gnus-group-make-group (gnus-info-group info))))
4245 (gnus-message 6 "Note: New group created")
4247 (gnus-group-entry (gnus-group-prefixed-name
4248 (gnus-group-real-name (gnus-info-group info))
4249 (or (gnus-info-method info) gnus-select-method))))))
4250 ;; Whether it was a new group or not, we now have the entry, so we
4251 ;; can do the update.
4254 (setcar (nthcdr 2 entry) info)
4255 (when (and (not (eq (car entry) t))
4256 (gnus-active (gnus-info-group info)))
4257 (setcar entry (length
4258 (gnus-list-of-unread-articles (car info))))))
4259 (error "No such group: %s" (gnus-info-group info))))))
4261 (defun gnus-group-set-method-info (group select-method)
4262 (gnus-group-set-info select-method group 'method))
4264 (defun gnus-group-set-params-info (group params)
4265 (gnus-group-set-info params group 'params))
4267 (defun gnus-add-marked-articles (group type articles &optional info force)
4268 ;; Add ARTICLES of TYPE to the info of GROUP.
4269 ;; If INFO is non-nil, use that info. If FORCE is non-nil, don't
4270 ;; add, but replace marked articles of TYPE with ARTICLES.
4271 (let ((info (or info (gnus-get-info group)))
4274 (and (not (setq marked (nthcdr 3 info)))
4276 (setcdr (nthcdr 2 info)
4277 (list (list (cons type (gnus-compress-sequence
4279 (and (not (setq m (assq type (car marked))))
4282 (cons (cons type (gnus-compress-sequence articles t) )
4286 (setcar (nthcdr 3 info)
4287 (gnus-delete-alist type (car marked)))
4288 (setcdr m (gnus-compress-sequence articles t)))
4289 (setcdr m (gnus-compress-sequence
4290 (sort (nconc (gnus-uncompress-range (cdr m))
4291 (copy-sequence articles)) '<) t))))))
4293 (defun gnus-add-mark (group mark article)
4294 "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4295 (let ((buffer (gnus-summary-buffer-name group)))
4296 (if (gnus-buffer-live-p buffer)
4298 (set-buffer (get-buffer buffer))
4299 (gnus-summary-add-mark article mark))
4300 (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4304 ;;; Group timestamps
4307 (defun gnus-group-set-timestamp ()
4308 "Change the timestamp of the current group to the current time.
4309 This function can be used in hooks like `gnus-select-group-hook'
4310 or `gnus-group-catchup-group-hook'."
4311 (when gnus-newsgroup-name
4312 (let ((time (current-time)))
4313 (setcdr (cdr time) nil)
4314 (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4316 (defsubst gnus-group-timestamp (group)
4317 "Return the timestamp for GROUP."
4318 (gnus-group-get-parameter group 'timestamp t))
4320 (defun gnus-group-timestamp-delta (group)
4321 "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4322 (let* ((time (or (gnus-group-timestamp group)
4324 (delta (subtract-time (current-time) time)))
4325 (+ (* (nth 0 delta) 65536.0)
4328 (defun gnus-group-timestamp-string (group)
4329 "Return a string of the timestamp for GROUP."
4330 (let ((time (gnus-group-timestamp group)))
4333 (gnus-time-iso8601 time))))
4335 (defun gnus-group-list-cached (level &optional lowest)
4336 "List all groups with cached articles.
4337 If the prefix LEVEL is non-nil, it should be a number that says which
4338 level to cut off listing groups.
4339 If LOWEST, don't list groups with level lower than LOWEST.
4341 This command may read the active file."
4344 (setq level (prefix-numeric-value level)))
4345 (when (or (not level) (>= level gnus-level-zombie))
4347 (funcall gnus-group-prepare-function
4348 (or level gnus-level-subscribed)
4350 (let ((marks (gnus-info-marks info)))
4351 (assq 'cache marks)))
4354 (or (gnus-gethash group
4355 gnus-cache-active-hashtb)
4356 ;; Cache active file might use "."
4359 (mapconcat 'identity
4360 (split-string group ":")
4362 gnus-cache-active-hashtb))))
4363 (goto-char (point-min))
4364 (gnus-group-position-point))
4366 (defun gnus-group-list-dormant (level &optional lowest)
4367 "List all groups with dormant articles.
4368 If the prefix LEVEL is non-nil, it should be a number that says which
4369 level to cut off listing groups.
4370 If LOWEST, don't list groups with level lower than LOWEST.
4372 This command may read the active file."
4375 (setq level (prefix-numeric-value level)))
4376 (when (or (not level) (>= level gnus-level-zombie))
4378 (funcall gnus-group-prepare-function
4379 (or level gnus-level-subscribed)
4381 (let ((marks (gnus-info-marks info)))
4382 (assq 'dormant marks)))
4385 (goto-char (point-min))
4386 (gnus-group-position-point))
4388 (defun gnus-group-listed-groups ()
4389 "Return a list of listed groups."
4391 (goto-char (point-min))
4392 (while (setq point (text-property-not-all (point) (point-max)
4395 (push (symbol-name (get-text-property point 'gnus-group)) groups)
4399 (defun gnus-group-list-plus (&optional args)
4400 "List groups plus the current selection."
4402 (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4403 (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4405 (push last-command-event unread-command-events)
4406 (if (featurep 'xemacs)
4407 (push (make-event 'key-press '(key ?A)) unread-command-events)
4408 (push ?A unread-command-events))
4409 (let (gnus-pick-mode keys)
4410 (setq keys (if (featurep 'xemacs)
4411 (events-to-keys (read-key-sequence nil))
4412 (read-key-sequence nil)))
4413 (setq func (lookup-key (current-local-map) keys)))
4417 (call-interactively func))))
4419 (defun gnus-group-list-flush (&optional args)
4420 "Flush groups from the current selection."
4422 (let ((gnus-group-list-option 'flush))
4423 (gnus-group-list-plus args)))
4425 (defun gnus-group-list-limit (&optional args)
4426 "List groups limited within the current selection."
4428 (let ((gnus-group-list-option 'limit))
4429 (gnus-group-list-plus args)))
4431 (defun gnus-group-mark-article-read (group article)
4432 "Mark ARTICLE read."
4433 (let ((buffer (gnus-summary-buffer-name group))
4434 (mark gnus-read-mark)
4436 (if (get-buffer buffer)
4437 (with-current-buffer buffer
4438 (setq active gnus-newsgroup-active)
4439 (gnus-activate-group group)
4440 (when gnus-newsgroup-prepared
4441 (when (and gnus-newsgroup-auto-expire
4442 (memq mark gnus-auto-expirable-marks))
4443 (setq mark gnus-expirable-mark))
4444 (setq mark (gnus-request-update-mark
4445 group article mark))
4446 (gnus-mark-article-as-read article mark)
4447 (setq gnus-newsgroup-active (gnus-active group))
4449 (setq n (1+ (cdr active)))
4450 (while (<= n (cdr gnus-newsgroup-active))
4451 (unless (eq n article)
4452 (push n gnus-newsgroup-unselected))
4454 (setq gnus-newsgroup-unselected
4455 (nreverse gnus-newsgroup-unselected)))))
4456 (gnus-activate-group group)
4457 (gnus-group-make-articles-read group (list article))
4458 (when (gnus-group-auto-expirable-p group)
4459 (gnus-add-marked-articles
4460 group 'expire (list article))))))
4464 ;;; Group compaction. -- dvl
4467 (defun gnus-group-compact-group (group)
4468 "Compact the current group.
4469 Compaction means removing gaps between article numbers. Hence, this
4470 operation is only meaningful for back ends using one file per article
4473 Note: currently only implemented in nnml."
4474 (interactive (list (gnus-group-group-name)))
4476 (error "No group to compact"))
4477 (unless (gnus-check-backend-function 'request-compact-group group)
4478 (error "This back end does not support group compaction"))
4479 (let ((group-decoded (gnus-group-decoded-name group)))
4481 Compacting group %s... (this may take a long time)"
4484 (if (not (gnus-request-compact-group group))
4485 (gnus-error 3 "Couldn't compact group %s" group-decoded)
4486 (gnus-message 6 "Compacting group %s...done" group-decoded)
4488 ;; Invalidate the "original article" buffer which might be out of date.
4489 ;; #### NOTE: Yes, this might be a bit rude, but since compaction
4490 ;; #### will not happen very often, I think this is acceptable.
4491 (let ((original (get-buffer gnus-original-article-buffer)))
4492 (and original (gnus-kill-buffer original)))
4493 ;; Update the group line to reflect new information (art number etc).
4494 (gnus-group-update-group-line))))
4496 (provide 'gnus-group)
4498 ;;; arch-tag: 2eb5440f-0bca-4091-814c-e37817536af6
4499 ;;; gnus-group.el ends here