1 ;;; gnus-group.el --- group mode commands for Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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 (defcustom gnus-group-tool-bar (if (eq gmm-tool-bar-style 'gnome)
1014 'gnus-group-tool-bar-gnome
1015 'gnus-group-tool-bar-retro)
1016 "Specifies the Gnus group tool bar.
1018 It can be either a list or a symbol refering to a list. See
1019 `gmm-tool-bar-from-list' for the format of the list. The
1020 default key map is `gnus-group-mode-map'.
1022 Pre-defined symbols include `gnus-group-tool-bar-gnome' and
1023 `gnus-group-tool-bar-retro'."
1024 :type '(choice (const :tag "GNOME style" gnus-group-tool-bar-gnome)
1025 (const :tag "Retro look" gnus-group-tool-bar-retro)
1026 (repeat :tag "User defined list" gmm-tool-bar-item)
1028 :version "23.0" ;; No Gnus
1029 :initialize 'custom-initialize-default
1030 :set 'gnus-group-tool-bar-update
1033 (defcustom gnus-group-tool-bar-gnome
1034 '((gnus-group-post-news "mail/compose")
1035 ;; Some useful agent icons? I don't use the agent so agent users should
1036 ;; suggest useful commands:
1037 (gnus-agent-toggle-plugged "disconnect" t
1038 :help "Gnus is currently unplugged. Click to work online."
1039 :visible (and gnus-agent (not gnus-plugged)))
1040 (gnus-agent-toggle-plugged "connect" t
1041 :help "Gnus is currently plugged. Click to work offline."
1042 :visible (and gnus-agent gnus-plugged))
1043 ;; FIXME: gnus-agent-toggle-plugged (in gnus-agent-group-make-menu-bar)
1044 ;; should have a better help text.
1045 (gnus-group-send-queue "mail/outbox" t
1046 :visible (and gnus-agent gnus-plugged)
1047 :help "Send articles from the queue group")
1048 (gnus-group-get-new-news "mail/inbox" nil
1049 :visible (or (not gnus-agent)
1051 ;; FIXME: gnus-*-read-group should have a better help text.
1052 (gnus-topic-read-group "open" nil
1053 :visible (and (boundp 'gnus-topic-mode)
1055 (gnus-group-read-group "open" nil
1056 :visible (not (and (boundp 'gnus-topic-mode)
1058 ;; (gnus-group-find-new-groups "???" nil)
1059 (gnus-group-save-newsrc "save")
1060 (gnus-group-describe-group "describe")
1061 (gnus-group-unsubscribe-current-group "gnus/toggle-subscription")
1062 (gnus-group-prev-unread-group "left-arrow")
1063 (gnus-group-next-unread-group "right-arrow")
1064 (gnus-group-exit "exit")
1065 (gmm-customize-mode "preferences" t :help "Edit mode preferences")
1066 (gnus-info-find-node "help"))
1067 "List of functions for the group tool bar (GNOME style).
1069 See `gmm-tool-bar-from-list' for the format of the list."
1070 :type '(repeat gmm-tool-bar-item)
1071 :version "23.0" ;; No Gnus
1072 :initialize 'custom-initialize-default
1073 :set 'gnus-group-tool-bar-update
1076 (defcustom gnus-group-tool-bar-retro
1077 '((gnus-group-get-new-news "gnus/get-news")
1078 (gnus-group-get-new-news-this-group "gnus/gnntg")
1079 (gnus-group-catchup-current "gnus/catchup")
1080 (gnus-group-describe-group "gnus/describe-group")
1081 (gnus-group-subscribe "gnus/subscribe" t
1082 :help "Subscribe to the current group")
1083 (gnus-group-unsubscribe "gnus/unsubscribe" t
1084 :help "Unsubscribe from the current group")
1085 (gnus-group-exit "gnus/exit-gnus" gnus-group-mode-map))
1086 "List of functions for the group tool bar (retro look).
1088 See `gmm-tool-bar-from-list' for the format of the list."
1089 :type '(repeat gmm-tool-bar-item)
1090 :version "23.0" ;; No Gnus
1091 :initialize 'custom-initialize-default
1092 :set 'gnus-group-tool-bar-update
1095 (defcustom gnus-group-tool-bar-zap-list t
1096 "List of icon items from the global tool bar.
1097 These items are not displayed in the Gnus group mode tool bar.
1099 See `gmm-tool-bar-from-list' for the format of the list."
1100 :type 'gmm-tool-bar-zap-list
1101 :version "23.0" ;; No Gnus
1102 :initialize 'custom-initialize-default
1103 :set 'gnus-group-tool-bar-update
1106 (defvar image-load-path)
1108 (defun gnus-group-make-tool-bar (&optional force)
1109 "Make a group mode tool bar from `gnus-group-tool-bar'.
1110 When FORCE, rebuild the tool bar."
1111 (when (and (not (featurep 'xemacs))
1112 (boundp 'tool-bar-mode)
1114 ;; The Gnus 5.10.6 code checked (default-value 'tool-bar-mode).
1116 (or (not gnus-group-tool-bar-map) force))
1118 (gmm-image-load-path-for-library "gnus"
1119 "gnus/toggle-subscription.xpm"
1121 (image-load-path (cons (car load-path)
1122 (when (boundp 'image-load-path)
1124 (map (gmm-tool-bar-from-list gnus-group-tool-bar
1125 gnus-group-tool-bar-zap-list
1126 'gnus-group-mode-map)))
1128 (set (make-local-variable 'tool-bar-map) map))))
1129 gnus-group-tool-bar-map)
1131 (defun gnus-group-mode ()
1132 "Major mode for reading news.
1134 All normal editing commands are switched off.
1135 \\<gnus-group-mode-map>
1136 The group buffer lists (some of) the groups available. For instance,
1137 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
1138 lists all zombie groups.
1140 Groups that are displayed can be entered with `\\[gnus-group-read-group]'. To subscribe
1141 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
1143 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
1145 The following commands are available:
1147 \\{gnus-group-mode-map}"
1149 (kill-all-local-variables)
1150 (when (gnus-visual-p 'group-menu 'menu)
1151 (gnus-group-make-menu-bar)
1152 (gnus-group-make-tool-bar))
1153 (gnus-simplify-mode-line)
1154 (setq major-mode 'gnus-group-mode)
1155 (setq mode-name "Group")
1156 (gnus-group-set-mode-line)
1157 (setq mode-line-process nil)
1158 (use-local-map gnus-group-mode-map)
1159 (buffer-disable-undo)
1160 (setq truncate-lines t)
1161 (setq buffer-read-only t
1162 show-trailing-whitespace nil)
1163 (gnus-set-default-directory)
1164 (gnus-update-format-specifications nil 'group 'group-mode)
1165 (gnus-update-group-mark-positions)
1170 (gnus-run-mode-hooks 'gnus-group-mode-hook))
1172 (defun gnus-update-group-mark-positions ()
1174 (let ((gnus-process-mark ?\200)
1175 (gnus-group-update-hook nil)
1176 (gnus-group-marked '("dummy.group"))
1177 (gnus-active-hashtb (make-vector 10 0))
1179 (gnus-set-active "dummy.group" '(0 . 0))
1180 (gnus-set-work-buffer)
1181 (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
1182 (goto-char (point-min))
1183 (setq gnus-group-mark-positions
1184 (list (cons 'process (and (search-forward
1185 (mm-string-as-multibyte "\200") nil t)
1186 (- (point) 2))))))))
1188 (defun gnus-mouse-pick-group (e)
1189 "Enter the group under the mouse pointer."
1192 (gnus-group-read-group nil))
1194 ;; Look at LEVEL and find out what the level is really supposed to be.
1195 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
1196 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
1197 (defun gnus-group-default-level (&optional level number-or-nil)
1199 (gnus-group-use-permanent-levels
1200 (or (setq gnus-group-use-permanent-levels
1201 (or level (if (numberp gnus-group-use-permanent-levels)
1202 gnus-group-use-permanent-levels
1203 (or gnus-group-default-list-level
1204 gnus-level-subscribed))))
1205 gnus-group-default-list-level gnus-level-subscribed))
1209 (or level gnus-group-default-list-level gnus-level-subscribed))))
1211 (defun gnus-group-setup-buffer ()
1212 (set-buffer (gnus-get-buffer-create gnus-group-buffer))
1213 (unless (eq major-mode 'gnus-group-mode)
1216 (gnus-carpal-setup-buffer 'group))))
1218 (defun gnus-group-name-charset (method group)
1220 (setq method (gnus-find-method-for-group group)))
1221 (let ((item (or (assoc method gnus-group-name-charset-method-alist)
1223 (assoc (list (car method) (cadr method))
1224 gnus-group-name-charset-method-alist))))
1225 (alist gnus-group-name-charset-group-alist)
1229 (while (setq item (pop alist))
1230 (if (string-match (car item) group)
1232 result (cdr item))))
1235 (defun gnus-group-name-decode (string charset)
1236 ;; Fixme: Don't decode in unibyte mode.
1237 (if (and string charset (featurep 'mule))
1238 (mm-decode-coding-string string charset)
1241 (defun gnus-group-decoded-name (string)
1242 (let ((charset (gnus-group-name-charset nil string)))
1243 (gnus-group-name-decode string charset)))
1245 (defun gnus-group-list-groups (&optional level unread lowest)
1246 "List newsgroups with level LEVEL or lower that have unread articles.
1247 Default is all subscribed groups.
1248 If argument UNREAD is non-nil, groups with no unread articles are also
1251 Also see the `gnus-group-use-permanent-levels' variable."
1253 (list (if current-prefix-arg
1254 (prefix-numeric-value current-prefix-arg)
1256 (gnus-group-default-level nil t)
1257 gnus-group-default-list-level
1258 gnus-level-subscribed))))
1260 (setq level (car gnus-group-list-mode)
1261 unread (cdr gnus-group-list-mode)))
1262 (setq level (gnus-group-default-level level))
1263 (gnus-group-setup-buffer)
1264 (gnus-update-format-specifications nil 'group 'group-mode)
1265 (let ((case-fold-search nil)
1266 (props (text-properties-at (point-at-bol)))
1267 (empty (= (point-min) (point-max)))
1268 (group (gnus-group-group-name))
1270 (set-buffer gnus-group-buffer)
1271 (setq number (funcall gnus-group-prepare-function level unread lowest))
1272 (when (or (and (numberp number)
1274 (zerop (buffer-size)))
1275 ;; No groups in the buffer.
1276 (gnus-message 5 gnus-no-groups-message))
1277 ;; We have some groups displayed.
1278 (goto-char (point-max))
1279 (when (or (not gnus-group-goto-next-group-function)
1280 (not (funcall gnus-group-goto-next-group-function
1284 (goto-char (point-min)))
1286 ;; Go to the first group with unread articles.
1287 (gnus-group-search-forward t))
1289 ;; Find the right group to put point on. If the current group
1290 ;; has disappeared in the new listing, try to find the next
1291 ;; one. If no next one can be found, just leave point at the
1292 ;; first newsgroup in the buffer.
1293 (when (not (gnus-goto-char
1295 (point-min) (point-max)
1296 'gnus-group (gnus-intern-safe
1297 group gnus-active-hashtb))))
1298 (let ((newsrc (cdddr (gnus-group-entry group))))
1300 (not (gnus-goto-char
1302 (point-min) (point-max) 'gnus-group
1304 (caar newsrc) gnus-active-hashtb)))))
1305 (setq newsrc (cdr newsrc)))
1307 (goto-char (point-max))
1308 (forward-line -1)))))))
1309 ;; Adjust cursor point.
1310 (gnus-group-position-point)))
1312 (defun gnus-group-list-level (level &optional all)
1313 "List groups on LEVEL.
1314 If ALL (the prefix), also list groups that have no unread articles."
1315 (interactive "nList groups on level: \nP")
1316 (gnus-group-list-groups level all level))
1318 (defun gnus-group-prepare-logic (group test)
1319 (or (and gnus-group-listed-groups
1320 (null gnus-group-list-option)
1321 (member group gnus-group-listed-groups))
1323 ((null gnus-group-listed-groups) test)
1324 ((null gnus-group-list-option) test)
1325 (t (and (member group gnus-group-listed-groups)
1326 (if (eq gnus-group-list-option 'flush)
1330 (defun gnus-group-prepare-flat (level &optional predicate lowest regexp)
1331 "List all newsgroups with unread articles of level LEVEL or lower.
1332 If PREDICATE is a function, list groups that the function returns non-nil;
1333 if it is t, list groups that have no unread articles.
1334 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1335 If REGEXP is a function, list dead groups that the function returns non-nil;
1336 if it is a string, only list groups matching REGEXP."
1337 (set-buffer gnus-group-buffer)
1338 (let ((buffer-read-only nil)
1339 (newsrc (cdr gnus-newsrc-alist))
1340 (lowest (or lowest 1))
1341 (not-in-list (and gnus-group-listed-groups
1342 (copy-sequence gnus-group-listed-groups)))
1343 info clevel unread group params)
1345 (when (or (< lowest gnus-level-zombie)
1346 gnus-group-listed-groups)
1347 ;; List living groups.
1349 (setq info (car newsrc)
1350 group (gnus-info-group info)
1351 params (gnus-info-params info)
1353 unread (gnus-group-unread group))
1355 (setq not-in-list (delete group not-in-list)))
1356 (when (gnus-group-prepare-logic
1358 (and unread ; This group might be unchecked
1359 (or (not (stringp regexp))
1360 (string-match regexp group))
1361 (<= (setq clevel (gnus-info-level info)) level)
1364 ((functionp predicate)
1365 (funcall predicate info))
1366 (predicate t) ; We list all groups?
1369 (if (eq unread t) ; Unactivated?
1370 gnus-group-list-inactive-groups
1371 ; We list unactivated
1373 ; We list groups with unread articles
1374 (and gnus-list-groups-with-ticked-articles
1375 (cdr (assq 'tick (gnus-info-marks info))))
1376 ; And groups with tickeds
1377 ;; Check for permanent visibility.
1378 (and gnus-permanently-visible-groups
1379 (string-match gnus-permanently-visible-groups
1381 (memq 'visible params)
1382 (cdr (assq 'visible params)))))))
1383 (gnus-group-insert-group-line
1384 group (gnus-info-level info)
1385 (gnus-info-marks info) unread (gnus-info-method info)))))
1387 ;; List dead groups.
1388 (when (or gnus-group-listed-groups
1389 (and (>= level gnus-level-zombie)
1390 (<= lowest gnus-level-zombie)))
1391 (gnus-group-prepare-flat-list-dead
1392 (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1393 gnus-level-zombie ?Z
1396 (dolist (group gnus-zombie-list)
1397 (setq not-in-list (delete group not-in-list))))
1398 (when (or gnus-group-listed-groups
1399 (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)))
1400 (gnus-group-prepare-flat-list-dead
1403 (setq gnus-killed-list (sort gnus-killed-list 'string<)))
1404 gnus-level-killed ?K regexp))
1406 (gnus-group-set-mode-line)
1407 (setq gnus-group-list-mode (cons level predicate))
1408 (gnus-run-hooks 'gnus-group-prepare-hook)
1411 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1412 ;; List zombies and killed lists somewhat faster, which was
1413 ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>. It does
1414 ;; this by ignoring the group format specification altogether.
1416 (if (> (length groups) gnus-group-listing-limit)
1418 (setq group (pop groups))
1419 (when (gnus-group-prepare-logic
1422 (and (stringp regexp) (string-match regexp group))
1423 (and (functionp regexp) (funcall regexp group))))
1424 (gnus-add-text-properties
1425 (point) (prog1 (1+ (point))
1426 (insert " " mark " *: "
1427 (gnus-group-decoded-name group)
1429 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1431 'gnus-level level))))
1433 (setq group (pop groups))
1434 (when (gnus-group-prepare-logic
1437 (and (stringp regexp) (string-match regexp group))
1438 (and (functionp regexp) (funcall regexp group))))
1439 (gnus-group-insert-group-line
1441 (let ((active (gnus-active group)))
1443 (if (zerop (cdr active))
1445 (- (1+ (cdr active)) (car active)))
1447 (gnus-method-simplify (gnus-find-method-for-group group))))))))
1449 (defun gnus-group-update-group-line ()
1450 "Update the current line in the group buffer."
1451 (let* ((buffer-read-only nil)
1452 (group (gnus-group-group-name))
1453 (entry (and group (gnus-group-entry group)))
1454 gnus-group-indentation)
1457 (not (gnus-ephemeral-group-p group))
1459 (concat "(gnus-group-set-info '"
1460 (gnus-prin1-to-string (nth 2 entry))
1462 (setq gnus-group-indentation (gnus-group-group-indentation))
1464 (gnus-group-insert-group-line-info group)
1466 (gnus-group-position-point))))
1468 (defun gnus-group-insert-group-line-info (group)
1469 "Insert GROUP on the current line."
1470 (let ((entry (gnus-group-entry group))
1471 (gnus-group-indentation (gnus-group-group-indentation))
1475 ;; (Un)subscribed group.
1476 (setq info (nth 2 entry))
1477 (gnus-group-insert-group-line
1478 group (gnus-info-level info) (gnus-info-marks info)
1479 (or (car entry) t) (gnus-info-method info)))
1480 ;; This group is dead.
1481 (gnus-group-insert-group-line
1483 (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1485 (if (setq active (gnus-active group))
1486 (if (zerop (cdr active))
1488 (- (1+ (cdr active)) (car active)))
1490 (gnus-method-simplify (gnus-find-method-for-group group))))))
1492 (defun gnus-number-of-unseen-articles-in-group (group)
1493 (let* ((info (nth 2 (gnus-group-entry group)))
1494 (marked (gnus-info-marks info))
1495 (seen (cdr (assq 'seen marked)))
1496 (active (gnus-active group)))
1499 (length (gnus-uncompress-range
1500 (gnus-range-difference
1501 (gnus-range-difference (list active) (gnus-info-read info))
1504 ;; Moving through the Group buffer (in topic mode) e.g. with C-n doesn't
1505 ;; update the state (enabled/disabled) of the icon `gnus-group-describe-group'
1506 ;; automatically. After `C-l' the state is correct. See the following report
1508 ;; <http://thread.gmane.org/v9acdmrcse.fsf@marauder.physik.uni-ulm.de>:
1509 ;; From: Reiner Steib
1510 ;; Subject: tool bar icons not updated according to :active condition
1511 ;; Newsgroups: gmane.emacs.devel
1512 ;; Date: Mon, 23 Jan 2006 19:59:13 +0100
1513 ;; Message-ID: <v9acdmrcse.fsf@marauder.physik.uni-ulm.de>
1515 (defcustom gnus-group-update-tool-bar
1516 (and (not (featurep 'xemacs))
1517 (boundp 'tool-bar-mode)
1519 ;; Using `redraw-frame' (see `gnus-tool-bar-update') in Emacs 21 might
1520 ;; be confusing, so maybe we shouldn't call it by default.
1521 (fboundp 'force-window-update))
1522 "Force updating the group buffer tool bar."
1525 :initialize 'custom-initialize-default
1526 :set (lambda (symbol value)
1527 (set-default symbol value)
1528 (when (gnus-alive-p)
1529 (with-current-buffer gnus-group-buffer
1530 ;; FIXME: Is there a better way to redraw the group buffer?
1531 (gnus-group-get-new-news 0))))
1534 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1535 gnus-tmp-marked number
1537 "Insert a group line in the group buffer."
1538 (let* ((gnus-tmp-method
1539 (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1540 (group-name-charset (gnus-group-name-charset gnus-tmp-method
1542 (gnus-tmp-active (gnus-active gnus-tmp-group))
1543 (gnus-tmp-number-total
1545 (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1547 (gnus-tmp-number-of-unread
1548 (if (numberp number) (int-to-string (max 0 number))
1550 (gnus-tmp-number-of-read
1551 (if (numberp number)
1552 (int-to-string (max 0 (- gnus-tmp-number-total number)))
1554 (gnus-tmp-subscribed
1555 (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1556 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1557 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1559 (gnus-tmp-qualified-group
1560 (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1561 group-name-charset))
1563 (or (gnus-group-get-parameter gnus-tmp-group 'comment t)
1565 (gnus-tmp-newsgroup-description
1566 (if gnus-description-hashtb
1567 (or (gnus-group-name-decode
1568 (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1569 group-name-charset) "")
1572 (if (and gnus-moderated-hashtb
1573 (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1575 (gnus-tmp-moderated-string
1576 (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1577 (gnus-tmp-group-icon "==&&==")
1578 (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1579 (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1580 (gnus-tmp-news-method-string
1582 (format "(%s:%s)" (car gnus-tmp-method)
1583 (cadr gnus-tmp-method)) ""))
1584 (gnus-tmp-marked-mark
1585 (if (and (numberp number)
1587 (cdr (assq 'tick gnus-tmp-marked)))
1589 (gnus-tmp-summary-live
1590 (if (and (not gnus-group-is-exiting-p)
1591 (gnus-buffer-live-p (gnus-summary-buffer-name
1594 (gnus-tmp-process-marked
1595 (if (member gnus-tmp-group gnus-group-marked)
1596 gnus-process-mark ? ))
1597 (buffer-read-only nil)
1599 header gnus-tmp-header) ; passed as parameter to user-funcs.
1602 (gnus-add-text-properties
1606 (let ((gnus-tmp-decoded-group (gnus-group-name-decode
1607 gnus-tmp-group group-name-charset)))
1608 (eval gnus-group-line-format-spec)))
1609 `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1610 gnus-unread ,(if (numberp number)
1611 (string-to-number gnus-tmp-number-of-unread)
1613 gnus-marked ,gnus-tmp-marked-mark
1614 gnus-indentation ,gnus-group-indentation
1615 gnus-level ,gnus-tmp-level))
1617 (when gnus-group-update-tool-bar
1618 (gnus-put-text-property beg end 'point-entered
1619 'gnus-tool-bar-update)
1620 (gnus-put-text-property beg end 'point-left
1621 'gnus-tool-bar-update))
1623 (when (inline (gnus-visual-p 'group-highlight 'highlight))
1624 (gnus-run-hooks 'gnus-group-update-hook))
1626 ;; Allow XEmacs to remove front-sticky text properties.
1627 (gnus-group-remove-excess-properties)))
1629 (defun gnus-group-highlight-line ()
1630 "Highlight the current line according to `gnus-group-highlight'."
1631 (let* ((list gnus-group-highlight)
1633 (end (point-at-eol))
1634 ;; now find out where the line starts and leave point there.
1635 (beg (progn (beginning-of-line) (point)))
1636 (group (gnus-group-group-name))
1637 (entry (gnus-group-entry group))
1638 (unread (if (numberp (car entry)) (car entry) 0))
1639 (active (gnus-active group))
1640 (total (if active (1+ (- (cdr active) (car active))) 0))
1641 (info (nth 2 entry))
1642 (method (inline (gnus-server-get-method group (gnus-info-method info))))
1643 (marked (gnus-info-marks info))
1644 (mailp (apply 'append
1647 (memq x (assoc (symbol-name
1648 (car (or method gnus-select-method)))
1649 gnus-valid-select-methods)))
1650 '(mail post-mail))))
1651 (level (or (gnus-info-level info) gnus-level-killed))
1652 (score (or (gnus-info-score info) 0))
1653 (ticked (gnus-range-length (cdr (assq 'tick marked))))
1654 (group-age (gnus-group-timestamp-delta group))
1655 (inhibit-read-only t))
1656 ;; Eval the cars of the lists until we find a match.
1658 (not (eval (caar list))))
1659 (setq list (cdr list)))
1660 (let ((face (cdar list)))
1661 (unless (eq face (get-text-property beg 'face))
1662 (gnus-put-text-property-excluding-characters-with-faces
1664 (setq face (if (boundp face) (symbol-value face) face)))
1665 (gnus-extent-start-open beg)))
1668 (defun gnus-group-update-group (group &optional visible-only)
1669 "Update all lines where GROUP appear.
1670 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1672 ;; Can't use `save-excursion' here, so we do it manually.
1673 (let ((buf (current-buffer))
1675 (set-buffer gnus-group-buffer)
1676 (setq mark (point-marker))
1677 ;; The buffer may be narrowed.
1680 (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1682 found buffer-read-only)
1683 ;; Enter the current status into the dribble buffer.
1684 (let ((entry (gnus-group-entry group)))
1686 (not (gnus-ephemeral-group-p group)))
1688 (concat "(gnus-group-set-info '"
1689 (gnus-prin1-to-string (nth 2 entry))
1691 ;; Find all group instances. If topics are in use, each group
1692 ;; may be listed in more than once.
1693 (while (setq loc (text-property-any
1694 loc (point-max) 'gnus-group ident))
1697 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1699 (gnus-group-insert-group-line-info group)
1702 (gnus-run-hooks 'gnus-group-update-group-hook)))
1703 (setq loc (1+ loc)))
1704 (unless (or found visible-only)
1705 ;; No such line in the buffer, find out where it's supposed to
1706 ;; go, and insert it there (or at the end of the buffer).
1707 (if gnus-goto-missing-group-function
1708 (funcall gnus-goto-missing-group-function group)
1709 (let ((entry (cddr (gnus-group-entry group))))
1710 (while (and entry (car entry)
1714 (point-min) (point-max)
1715 'gnus-group (gnus-intern-safe
1716 (caar entry) gnus-active-hashtb)))))
1717 (setq entry (cdr entry)))
1718 (or entry (goto-char (point-max)))))
1719 ;; Finally insert the line.
1720 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1721 (gnus-group-insert-group-line-info group)
1724 (gnus-run-hooks 'gnus-group-update-group-hook))))
1725 (when gnus-group-update-group-function
1726 (funcall gnus-group-update-group-function group))
1727 (gnus-group-set-mode-line)))
1729 (set-marker mark nil)
1732 (defun gnus-group-set-mode-line ()
1733 "Update the mode line in the group buffer."
1734 (when (memq 'group gnus-updated-mode-lines)
1735 ;; Yes, we want to keep this mode line updated.
1737 (set-buffer gnus-group-buffer)
1738 (let* ((gformat (or gnus-group-mode-line-format-spec
1739 (gnus-set-format 'group-mode)))
1740 (gnus-tmp-news-server (cadr gnus-select-method))
1741 (gnus-tmp-news-method (car gnus-select-method))
1742 (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1744 gnus-tmp-header ;Dummy binding for user-defined formats
1745 ;; Get the resulting string.
1747 (and gnus-dribble-buffer
1748 (buffer-name gnus-dribble-buffer)
1749 (buffer-modified-p gnus-dribble-buffer)
1751 (set-buffer gnus-dribble-buffer)
1752 (not (zerop (buffer-size))))))
1753 (mode-string (eval gformat)))
1754 ;; Say whether the dribble buffer has been modified.
1755 (setq mode-line-modified
1756 (if modified (car gnus-mode-line-modified)
1757 (cdr gnus-mode-line-modified)))
1758 ;; If the line is too long, we chop it off.
1759 (when (> (length mode-string) max-len)
1760 (setq mode-string (substring mode-string 0 (- max-len 4))))
1762 (setq mode-line-buffer-identification
1763 (gnus-mode-line-buffer-identification
1764 (list mode-string)))
1765 (set-buffer-modified-p modified))))))
1767 (defun gnus-group-group-name ()
1768 "Get the name of the newsgroup on the current line."
1769 (let ((group (get-text-property (point-at-bol) 'gnus-group)))
1771 (symbol-name group))))
1773 (defun gnus-group-group-level ()
1774 "Get the level of the newsgroup on the current line."
1775 (get-text-property (point-at-bol) 'gnus-level))
1777 (defun gnus-group-group-indentation ()
1778 "Get the indentation of the newsgroup on the current line."
1779 (or (get-text-property (point-at-bol) 'gnus-indentation)
1780 (and gnus-group-indentation-function
1781 (funcall gnus-group-indentation-function))
1784 (defun gnus-group-group-unread ()
1785 "Get the number of unread articles of the newsgroup on the current line."
1786 (get-text-property (point-at-bol) 'gnus-unread))
1788 (defun gnus-group-new-mail (group)
1789 (if (nnmail-new-mail-p (gnus-group-real-name group))
1793 (defun gnus-group-level (group)
1794 "Return the estimated level of GROUP."
1795 (or (gnus-info-level (gnus-get-info group))
1796 (and (member group gnus-zombie-list) gnus-level-zombie)
1799 (defun gnus-group-search-forward (&optional backward all level first-too)
1800 "Find the next newsgroup with unread articles.
1801 If BACKWARD is non-nil, find the previous newsgroup instead.
1802 If ALL is non-nil, just find any newsgroup.
1803 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1805 If FIRST-TOO, the current line is also eligible as a target."
1806 (let ((way (if backward -1 1))
1807 (low gnus-level-killed)
1810 (if (and backward (progn (beginning-of-line)) (bobp))
1819 (get-text-property (point) 'gnus-group)
1823 (get-text-property (point) 'gnus-unread)))
1824 (and (numberp unread) (> unread 0)))
1825 (setq lev (get-text-property (point)
1827 (<= lev gnus-level-subscribed)))
1829 (and (setq lev (get-text-property (point)
1838 (zerop (forward-line way)))))
1840 (progn (gnus-group-position-point) t)
1841 (goto-char (or pos beg))
1844 (defun gnus-total-fetched-for (group)
1845 (let* ((size-in-cache (or (gnus-cache-total-fetched-for group) 0))
1846 (size-in-agent (or (gnus-agent-total-fetched-for group) 0))
1847 (size (+ size-in-cache size-in-agent))
1848 (suffix '("B" "K" "M" "G"))
1851 (while (> size cutoff)
1852 (setq size (/ size scale)
1853 suffix (cdr suffix)))
1854 (format "%5.1f%s" size (car suffix))))
1856 ;;; Gnus group mode commands
1860 (defun gnus-group-mark-line-p ()
1863 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1864 (eq (char-after) gnus-process-mark)))
1866 (defun gnus-group-mark-group (n &optional unmark no-advance)
1867 "Mark the current group."
1869 (let ((buffer-read-only nil)
1873 (when (setq group (gnus-group-group-name))
1874 ;; Go to the mark position.
1876 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1880 (setq gnus-group-marked (delete group gnus-group-marked))
1881 (insert-char ? 1 t))
1882 (setq gnus-group-marked
1883 (cons group (delete group gnus-group-marked)))
1884 (insert-char gnus-process-mark 1 t)))
1886 (gnus-group-next-group 1))
1888 (gnus-summary-position-point)
1891 (defun gnus-group-unmark-group (n)
1892 "Remove the mark from the current group."
1894 (gnus-group-mark-group n 'unmark)
1895 (gnus-group-position-point))
1897 (defun gnus-group-unmark-all-groups ()
1898 "Unmark all groups."
1901 (mapc 'gnus-group-remove-mark gnus-group-marked))
1902 (gnus-group-position-point))
1904 (defun gnus-group-mark-region (unmark beg end)
1905 "Mark all groups between point and mark.
1906 If UNMARK, remove the mark instead."
1907 (interactive "P\nr")
1908 (let ((num (count-lines beg end)))
1911 (- num (gnus-group-mark-group num unmark)))))
1913 (defun gnus-group-mark-buffer (&optional unmark)
1914 "Mark all groups in the buffer.
1915 If UNMARK, remove the mark instead."
1917 (gnus-group-mark-region unmark (point-min) (point-max)))
1919 (defun gnus-group-mark-regexp (regexp)
1920 "Mark all groups that match some regexp."
1921 (interactive "sMark (regexp): ")
1922 (let ((alist (cdr gnus-newsrc-alist))
1926 (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1927 (gnus-group-jump-to-group group)
1928 (gnus-group-set-mark group)))))
1929 (gnus-group-position-point))
1931 (defun gnus-group-remove-mark (group &optional test-marked)
1932 "Remove the process mark from GROUP and move point there.
1933 Return nil if the group isn't displayed."
1934 (if (gnus-group-goto-group group nil test-marked)
1936 (gnus-group-mark-group 1 'unmark t)
1938 (setq gnus-group-marked
1939 (delete group gnus-group-marked))
1942 (defun gnus-group-set-mark (group)
1943 "Set the process mark on GROUP."
1944 (if (gnus-group-goto-group group)
1946 (gnus-group-mark-group 1 nil t))
1947 (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1949 (defun gnus-group-universal-argument (arg &optional groups func)
1950 "Perform any command on all groups according to the process/prefix convention."
1952 (if (eq (setq func (or func
1955 (substitute-command-keys
1956 "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1958 (gnus-error 1 "Undefined key")
1959 (gnus-group-iterate arg
1961 (command-execute func))))
1962 (gnus-group-position-point))
1964 (defun gnus-group-process-prefix (n)
1965 "Return a list of groups to work on.
1966 Take into consideration N (the prefix) and the list of marked groups."
1969 (setq n (prefix-numeric-value n))
1970 ;; There is a prefix, so we return a list of the N next
1972 (let ((way (if (< n 0) -1 1))
1977 (if (setq group (gnus-group-group-name))
1978 (push group groups))
1980 (gnus-group-next-group way)))
1982 ((and (gnus-region-active-p) (mark))
1983 ;; Work on the region between point and mark.
1984 (let ((max (max (point) (mark)))
1987 (goto-char (min (point) (mark)))
1990 (push (gnus-group-group-name) groups)
1991 (zerop (gnus-group-next-group 1))
1993 (nreverse groups))))
1995 ;; No prefix, but a list of marked articles.
1996 (reverse gnus-group-marked))
1998 ;; Neither marked articles or a prefix, so we return the
2000 (let ((group (gnus-group-group-name)))
2001 (and group (list group))))))
2003 ;;; !!!Surely gnus-group-iterate should be a macro instead? I can't
2004 ;;; imagine why I went through these contortions...
2006 (let ((function (make-symbol "gnus-group-iterate-function"))
2007 (window (make-symbol "gnus-group-iterate-window"))
2008 (groups (make-symbol "gnus-group-iterate-groups"))
2009 (group (make-symbol "gnus-group-iterate-group")))
2011 `(defun gnus-group-iterate (arg ,function)
2012 "Iterate FUNCTION over all process/prefixed groups.
2013 FUNCTION will be called with the group name as the parameter
2014 and with point over the group in question."
2015 (let ((,groups (gnus-group-process-prefix arg))
2016 (,window (selected-window))
2019 (setq ,group (car ,groups)
2020 ,groups (cdr ,groups))
2021 (select-window ,window)
2022 (gnus-group-remove-mark ,group)
2023 (save-selected-window
2025 (funcall ,function ,group)))))))))
2027 (put 'gnus-group-iterate 'lisp-indent-function 1)
2029 ;; Selecting groups.
2031 (defun gnus-group-read-group (&optional all no-article group select-articles)
2032 "Read news in this newsgroup.
2033 If the prefix argument ALL is non-nil, already read articles become
2034 readable. IF ALL is a number, fetch this number of articles. If the
2035 optional argument NO-ARTICLE is non-nil, no article will be
2036 auto-selected upon group entry. If GROUP is non-nil, fetch that
2039 (let ((no-display (eq all 0))
2040 (group (or group (gnus-group-group-name)))
2041 number active marked entry)
2045 (error "No group on current line"))
2046 (setq marked (gnus-info-marks
2047 (nth 2 (setq entry (gnus-group-entry group)))))
2048 ;; This group might be a dead group. In that case we have to get
2049 ;; the number of unread articles from `gnus-active-hashtb'.
2051 (cond ((numberp all) all)
2053 ((setq active (gnus-active group))
2054 (- (1+ (cdr active)) (car active)))))
2055 (gnus-summary-read-group
2056 group (or all (and (numberp number)
2057 (zerop (+ number (gnus-range-length
2058 (cdr (assq 'tick marked)))
2060 (cdr (assq 'dormant marked)))))))
2061 no-article nil no-display nil select-articles)))
2063 (defun gnus-group-select-group (&optional all)
2064 "Select this newsgroup.
2065 No article is selected automatically.
2066 If the group is opened, just switch the summary buffer.
2067 If ALL is non-nil, already read articles become readable.
2068 If ALL is a positive number, fetch this number of the latest
2069 articles in the group.
2070 If ALL is a negative number, fetch this number of the earliest
2071 articles in the group."
2073 (when (and (eobp) (not (gnus-group-group-name)))
2075 (gnus-group-read-group all t))
2077 (defun gnus-group-quick-select-group (&optional all group)
2078 "Select the GROUP \"quickly\".
2079 This means that no highlighting or scoring will be performed. If
2080 ALL (the prefix argument) is 0, don't even generate the summary
2081 buffer. If GROUP is nil, use current group.
2083 This might be useful if you want to toggle threading
2084 before entering the group."
2086 (require 'gnus-score)
2088 gnus-score-find-score-files-function
2089 gnus-home-score-file
2090 gnus-apply-kill-hook
2091 gnus-summary-expunge-below)
2092 (gnus-group-read-group all t group)))
2094 (defun gnus-group-visible-select-group (&optional all)
2095 "Select the current group without hiding any articles."
2097 (let ((gnus-inhibit-limiting t))
2098 (gnus-group-read-group all t)))
2100 (defun gnus-group-select-group-ephemerally ()
2101 "Select the current group without doing any processing whatsoever.
2102 You will actually be entered into a group that's a copy of
2103 the current group; no changes you make while in this group will
2106 (require 'gnus-score)
2108 gnus-score-find-score-files-function gnus-apply-kill-hook
2109 gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
2110 gnus-summary-mode-hook gnus-select-group-hook
2111 (group (gnus-group-group-name))
2112 (method (gnus-find-method-for-group group)))
2113 (gnus-group-read-ephemeral-group
2114 (gnus-group-prefixed-name group method) method)))
2116 (defun group-name-at-point ()
2117 (let ((regexp "[^-a-zA-Z+.:_]"))
2121 (re-search-backward regexp nil t)
2125 (re-search-forward regexp nil t)
2130 (defun gnus-fetch-group (group &optional articles)
2131 "Start Gnus if necessary and enter GROUP.
2132 If ARTICLES, display those articles.
2133 Returns whether the fetching was successful or not."
2134 (interactive (list (completing-read "Group name: " gnus-active-hashtb
2136 (group-name-at-point))))
2137 (unless (get-buffer gnus-group-buffer)
2139 (gnus-group-read-group (if articles nil t) nil group articles))
2142 (defun gnus-fetch-group-other-frame (group)
2143 "Pop up a frame and enter GROUP."
2145 (let ((window (get-buffer-window gnus-group-buffer)))
2147 (select-frame (window-frame window)))
2148 ((= (length (frame-list)) 1)
2149 (select-frame (make-frame)))
2152 (gnus-fetch-group group))
2154 (defvar gnus-ephemeral-group-server 0)
2156 (defcustom gnus-large-ephemeral-newsgroup 200
2157 "The number of articles which indicates a large ephemeral newsgroup.
2158 Same as `gnus-large-newsgroup', but only used for ephemeral newsgroups.
2160 If the number of articles in a newsgroup is greater than this value,
2161 confirmation is required for selecting the newsgroup. If it is nil, no
2162 confirmation is required."
2164 :group 'gnus-group-select
2165 :type '(choice (const :tag "No limit" nil)
2168 (defcustom gnus-fetch-old-ephemeral-headers nil
2169 "Same as `gnus-fetch-old-headers', but only used for ephemeral newsgroups."
2172 :type '(choice (const :tag "off" nil)
2175 (sexp :menu-tag "other" t)))
2177 ;; Enter a group that is not in the group buffer. Non-nil is returned
2178 ;; if selection was successful.
2179 (defun gnus-group-read-ephemeral-group (group method &optional activate
2180 quit-config request-only
2184 "Read GROUP from METHOD as an ephemeral group.
2185 If ACTIVATE, request the group first.
2186 If QUIT-CONFIG, use that window configuration when exiting from the
2188 If REQUEST-ONLY, don't actually read the group; just request it.
2189 If SELECT-ARTICLES, only select those articles.
2190 If PARAMETERS, use those as the group parameters.
2191 If NUMBER, fetch this number of articles.
2193 Return the name of the group if selection was successful."
2196 ;; (gnus-read-group "Group name: ")
2198 "Group: " gnus-active-hashtb
2200 'gnus-group-history)
2201 (gnus-read-method "From method: ")))
2202 ;; Transform the select method into a unique server.
2203 (when (stringp method)
2204 (setq method (gnus-server-to-method method)))
2206 `(,(car method) ,(concat (cadr method) "-ephemeral")
2207 (,(intern (format "%s-address" (car method))) ,(cadr method))
2209 (let ((group (if (gnus-group-foreign-p group) group
2210 (gnus-group-prefixed-name (gnus-group-real-name group)
2215 ,gnus-level-default-subscribed nil nil ,method
2218 (cons 'quit-config quit-config)
2220 (cons gnus-summary-buffer
2221 gnus-current-window-configuration)))
2224 (push method gnus-ephemeral-servers)
2225 (set-buffer gnus-group-buffer)
2226 (unless (gnus-check-server method)
2227 (error "Unable to contact server: %s" (gnus-status-message method)))
2229 (gnus-activate-group group 'scan)
2230 (unless (gnus-request-group group)
2231 (error "Couldn't request group: %s"
2232 (nnheader-get-report (car method)))))
2236 (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2237 (gnus-fetch-old-headers
2238 gnus-fetch-old-ephemeral-headers))
2239 (gnus-group-read-group (or number t) t group select-articles))
2243 (message "Quit reading the ephemeral group")
2246 (defun gnus-group-jump-to-group (group &optional prompt)
2247 "Jump to newsgroup GROUP.
2249 If PROMPT (the prefix) is a number, use the prompt specified in
2250 `gnus-group-jump-to-group-prompt'."
2252 (list (mm-string-make-unibyte
2254 "Group: " gnus-active-hashtb nil
2255 (gnus-read-active-file-p)
2256 (if current-prefix-arg
2257 (cdr (assq current-prefix-arg gnus-group-jump-to-group-prompt))
2258 (or (and (stringp gnus-group-jump-to-group-prompt)
2259 gnus-group-jump-to-group-prompt)
2260 (let ((p (cdr (assq 0 gnus-group-jump-to-group-prompt))))
2261 (and (stringp p) p))))
2262 'gnus-group-history))))
2264 (when (equal group "")
2265 (error "Empty group name"))
2267 (unless (gnus-ephemeral-group-p group)
2268 ;; Either go to the line in the group buffer...
2269 (unless (gnus-group-goto-group group)
2270 ;; ... or insert the line.
2271 (gnus-group-update-group group)
2272 (gnus-group-goto-group group)))
2273 ;; Adjust cursor point.
2274 (gnus-group-position-point))
2276 (defun gnus-group-goto-group (group &optional far test-marked)
2277 "Goto to newsgroup GROUP.
2278 If FAR, it is likely that the group is not on the current line.
2279 If TEST-MARKED, the line must be marked."
2283 ;; It's quite likely that we are on the right line, so
2284 ;; we check the current line first.
2286 (eq (get-text-property (point) 'gnus-group)
2287 (gnus-intern-safe group gnus-active-hashtb))
2288 (or (not test-marked) (gnus-group-mark-line-p)))
2290 ;; Previous and next line are also likely, so we check them as well.
2294 (and (eq (get-text-property (point) 'gnus-group)
2295 (gnus-intern-safe group gnus-active-hashtb))
2296 (or (not test-marked) (gnus-group-mark-line-p)))))
2302 (and (eq (get-text-property (point) 'gnus-group)
2303 (gnus-intern-safe group gnus-active-hashtb))
2304 (or (not test-marked) (gnus-group-mark-line-p)))))
2308 (goto-char (point-min))
2310 (while (and (not found)
2315 (gnus-intern-safe group gnus-active-hashtb))))
2316 (if (gnus-group-mark-line-p)
2321 ;; Search through the entire buffer.
2324 (point-min) (point-max)
2325 'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2327 (defun gnus-group-next-group (n &optional silent)
2328 "Go to next N'th newsgroup.
2329 If N is negative, search backward instead.
2330 Returns the difference between N and the number of skips actually
2333 (gnus-group-next-unread-group n t nil silent))
2335 (defun gnus-group-next-unread-group (n &optional all level silent)
2336 "Go to next N'th unread newsgroup.
2337 If N is negative, search backward instead.
2338 If ALL is non-nil, choose any newsgroup, unread or not.
2339 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2340 such group can be found, the next group with a level higher than
2342 Returns the difference between N and the number of skips actually
2345 (let ((backward (< n 0))
2348 (gnus-group-search-forward
2349 backward (or (not gnus-group-goto-unread) all) level))
2353 (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2354 (if level " on this level or higher" "")))
2357 (defun gnus-group-prev-group (n)
2358 "Go to previous N'th newsgroup.
2359 Returns the difference between N and the number of skips actually
2362 (gnus-group-next-unread-group (- n) t))
2364 (defun gnus-group-prev-unread-group (n)
2365 "Go to previous N'th unread newsgroup.
2366 Returns the difference between N and the number of skips actually
2369 (gnus-group-next-unread-group (- n)))
2371 (defun gnus-group-next-unread-group-same-level (n)
2372 "Go to next N'th unread newsgroup on the same level.
2373 If N is negative, search backward instead.
2374 Returns the difference between N and the number of skips actually
2377 (gnus-group-next-unread-group n t (gnus-group-group-level))
2378 (gnus-group-position-point))
2380 (defun gnus-group-prev-unread-group-same-level (n)
2381 "Go to next N'th unread newsgroup on the same level.
2382 Returns the difference between N and the number of skips actually
2385 (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2386 (gnus-group-position-point))
2388 (defun gnus-group-best-unread-group (&optional exclude-group)
2389 "Go to the group with the highest level.
2390 If EXCLUDE-GROUP, do not go to that group."
2392 (goto-char (point-min))
2396 (setq unread (get-text-property (point) 'gnus-unread))
2397 (when (and (numberp unread) (> unread 0))
2398 (when (and (get-text-property (point) 'gnus-level)
2399 (< (get-text-property (point) 'gnus-level) best)
2400 (or (not exclude-group)
2401 (not (equal exclude-group (gnus-group-group-name)))))
2402 (setq best (get-text-property (point) 'gnus-level))
2403 (setq best-point (point))))
2406 (goto-char best-point))
2407 (gnus-group-position-point)
2408 (and best-point (gnus-group-group-name))))
2410 ;; Is there something like an after-point-motion-hook?
2411 ;; (inhibit-point-motion-hooks?). Is there a tool-bar-update function?
2413 ;; (defun gnus-group-menu-bar-update ()
2414 ;; (let* ((buf (list (with-current-buffer gnus-group-buffer
2415 ;; (current-buffer))))
2416 ;; (name (buffer-name (car buf))))
2418 ;; (if (> (length name) 27)
2419 ;; (concat (substring name 0 12)
2421 ;; (substring name -12))
2423 ;; (menu-bar-update-buffers-1 buf)))
2425 ;; (defun gnus-group-position-point ()
2426 ;; (gnus-goto-colon)
2427 ;; (gnus-group-menu-bar-update))
2429 (defun gnus-group-first-unread-group ()
2430 "Go to the first group with unread articles."
2433 (let ((opoint (point))
2435 (goto-char (point-min))
2436 (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2437 (and (numberp unread) ; Not a topic.
2438 (not (zerop unread))) ; Has unread articles.
2439 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2442 nil)) ; Not success.
2443 (gnus-group-position-point)))
2445 (defun gnus-group-enter-server-mode ()
2446 "Jump to the server buffer."
2448 (gnus-enter-server-buffer))
2450 (defun gnus-group-make-group-simple (&optional group)
2451 "Add a new newsgroup.
2452 The user will be prompted for GROUP."
2454 (list (completing-read "Group: " gnus-active-hashtb
2455 nil nil nil 'gnus-group-history)))
2456 (gnus-group-make-group
2457 (gnus-group-real-name group)
2458 (gnus-group-server group)))
2460 (defun gnus-group-make-group (name &optional method address args)
2461 "Add a new newsgroup.
2462 The user will be prompted for a NAME, for a select METHOD, and an
2466 (gnus-read-group "Group name: ")
2467 (gnus-read-method "From method: ")))
2469 (when (stringp method)
2470 (setq method (or (gnus-server-to-method method) method)))
2471 (let* ((meth (gnus-method-simplify
2473 (not (gnus-server-equal method gnus-select-method)))
2474 (if address (list (intern method) address)
2476 (nname (if method (gnus-group-prefixed-name name meth) name))
2478 (when (gnus-group-entry nname)
2479 (error "Group %s already exists" (gnus-group-decoded-name nname)))
2480 ;; Subscribe to the new group.
2481 (gnus-group-change-level
2482 (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2483 gnus-level-default-subscribed gnus-level-killed
2484 (and (gnus-group-group-name)
2485 (gnus-group-entry (gnus-group-group-name)))
2488 (gnus-set-active nname (cons 1 0))
2489 (unless (gnus-ephemeral-group-p name)
2491 (concat "(gnus-group-set-info '"
2492 (gnus-prin1-to-string (cdr info)) ")")))
2494 (gnus-group-insert-group-line-info nname)
2496 (gnus-group-position-point)
2498 ;; Load the back end and try to make the back end create
2499 ;; the group as well.
2500 (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2502 gnus-valid-select-methods)
2504 (gnus-check-server meth)
2505 (when (gnus-check-backend-function 'request-create-group nname)
2506 (unless (gnus-request-create-group nname nil args)
2507 (error "Could not create group on server: %s"
2508 (nnheader-get-report backend))))
2511 (defun gnus-group-delete-groups (&optional arg)
2512 "Delete the current group. Only meaningful with editable groups."
2514 (let ((n (length (gnus-group-process-prefix arg))))
2515 (when (gnus-yes-or-no-p
2517 "Delete this 1 group? "
2518 (format "Delete these %d groups? " n)))
2519 (gnus-group-iterate arg
2521 (gnus-group-delete-group group nil t))))))
2523 (defun gnus-group-delete-group (group &optional force no-prompt)
2524 "Delete the current group. Only meaningful with editable groups.
2525 If FORCE (the prefix) is non-nil, all the articles in the group will
2526 be deleted. This is \"deleted\" as in \"removed forever from the face
2527 of the Earth\". There is no undo. The user will be prompted before
2529 Note that you also have to specify FORCE if you want the group to
2530 be removed from the server, even when it's empty."
2532 (list (gnus-group-group-name)
2533 current-prefix-arg))
2535 (error "No group to delete"))
2536 (unless (gnus-check-backend-function 'request-delete-group group)
2537 (error "This back end does not support group deletion"))
2539 (let ((group-decoded (gnus-group-decoded-name group)))
2540 (if (and (not no-prompt)
2541 (not (gnus-yes-or-no-p
2543 "Do you really want to delete %s%s? "
2544 group-decoded (if force " and all its contents" "")))))
2546 (gnus-message 6 "Deleting group %s..." group-decoded)
2547 (if (not (gnus-request-delete-group group force))
2548 (gnus-error 3 "Couldn't delete group %s" group-decoded)
2549 (gnus-message 6 "Deleting group %s...done" group-decoded)
2550 (gnus-group-goto-group group)
2551 (gnus-group-kill-group 1 t)
2552 (gnus-set-active group nil)
2554 (gnus-group-position-point)))
2556 (defun gnus-group-rename-group (group new-name)
2557 "Rename group from GROUP to NEW-NAME.
2558 When used interactively, GROUP is the group under point
2559 and NEW-NAME will be prompted for."
2562 (gnus-group-group-name)
2564 (unless (gnus-check-backend-function
2565 'request-rename-group (gnus-group-group-name))
2566 (error "This back end does not support renaming groups"))
2567 (gnus-read-group "Rename group to: "
2568 (gnus-group-real-name (gnus-group-group-name))))))
2570 (unless (gnus-check-backend-function 'request-rename-group group)
2571 (error "This back end does not support renaming groups"))
2573 (error "No group to rename"))
2574 (when (equal (gnus-group-real-name group) new-name)
2575 (error "Can't rename to the same name"))
2577 ;; We find the proper prefixed name.
2579 (if (gnus-group-native-p group)
2583 (gnus-group-prefixed-name
2584 (gnus-group-real-name new-name)
2585 (gnus-info-method (gnus-get-info group)))))
2587 (when (gnus-active new-name)
2588 (error "The group %s already exists" new-name))
2590 (gnus-message 6 "Renaming group %s to %s..." group new-name)
2593 (gnus-group-goto-group group)
2594 (not (when (< (gnus-group-group-level) gnus-level-zombie)
2595 (gnus-request-rename-group group new-name))))
2596 (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
2597 ;; We rename the group internally by killing it...
2598 (gnus-group-kill-group)
2599 ;; ... changing its name ...
2600 (setcar (cdar gnus-list-of-killed-groups) new-name)
2601 ;; ... and then yanking it. Magic!
2602 (gnus-group-yank-group)
2603 (gnus-set-active new-name (gnus-active group))
2604 (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2606 (setq gnus-killed-list (delete group gnus-killed-list))
2607 (gnus-set-active group nil)
2608 (gnus-dribble-touch)
2609 (gnus-group-position-point)))
2611 (defun gnus-group-edit-group (group &optional part)
2612 "Edit the group on the current line."
2613 (interactive (list (gnus-group-group-name)))
2614 (let ((part (or part 'info))
2617 (error "No group on current line"))
2618 (unless (setq info (gnus-get-info group))
2619 (error "Killed group; can't be edited"))
2621 (gnus-close-group group))
2623 ;; Find the proper form to edit.
2624 (cond ((eq part 'method)
2625 (or (gnus-info-method info) "native"))
2627 (gnus-info-params info))
2629 ;; The proper documentation.
2631 "Editing the %s for `%s'."
2633 ((eq part 'method) "select method")
2634 ((eq part 'params) "group parameters")
2636 (gnus-group-decoded-name group))
2638 (gnus-group-edit-group-done ',part ,group form)))
2641 (gnus-create-info-command
2644 "(gnus)Select Methods")
2646 "(gnus)Group Parameters")
2648 "(gnus)Group Info"))))))
2650 (defun gnus-group-edit-group-method (group)
2651 "Edit the select method of GROUP."
2652 (interactive (list (gnus-group-group-name)))
2653 (gnus-group-edit-group group 'method))
2655 (defun gnus-group-edit-group-parameters (group)
2656 "Edit the group parameters of GROUP."
2657 (interactive (list (gnus-group-group-name)))
2658 (gnus-group-edit-group group 'params))
2660 (defun gnus-group-edit-group-done (part group form)
2662 (let* ((method (cond ((eq part 'info) (nth 4 form))
2663 ((eq part 'method) form)
2665 (info (cond ((eq part 'info) form)
2666 ((eq part 'method) (gnus-get-info group))
2669 (if (or (not method)
2671 gnus-select-method method))
2672 (gnus-group-real-name (car info))
2673 (gnus-group-prefixed-name
2674 (gnus-group-real-name (car info)) method))
2676 (when (and new-group
2677 (not (equal new-group group)))
2678 (when (gnus-group-goto-group group)
2679 (gnus-group-kill-group 1))
2680 (gnus-activate-group new-group))
2682 (if (not (and info new-group))
2683 (gnus-group-set-info form (or new-group group) part)
2684 (setq info (gnus-copy-sequence info))
2685 (setcar info new-group)
2686 (unless (gnus-server-equal method "native")
2687 (unless (nthcdr 3 info)
2688 (nconc info (list nil nil)))
2689 (unless (nthcdr 4 info)
2690 (nconc info (list nil)))
2691 (gnus-info-set-method info method))
2692 (gnus-group-set-info info))
2693 (gnus-group-update-group (or new-group group))
2694 (gnus-group-position-point)))
2696 (defun gnus-group-make-useful-group (group method)
2697 "Create one of the groups described in `gnus-useful-groups'."
2699 (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2701 gnus-useful-groups)))
2702 (list (cadr entry) (caddr entry))))
2703 (setq method (gnus-copy-sequence method))
2705 (while (setq entry (memq (assq 'eval method) method))
2706 (setcar entry (eval (cadar entry)))))
2707 (gnus-group-make-group group method))
2709 (defun gnus-group-make-help-group (&optional noerror)
2710 "Create the Gnus documentation group.
2711 Optional argument NOERROR modifies the behavior of this function when the
2712 group already exists:
2713 - if not given, and error is signaled,
2714 - if t, stay silent,
2715 - if anything else, just print a message."
2717 (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2718 (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2719 (if (gnus-group-entry name)
2720 (cond ((eq noerror nil)
2721 (error "Documentation group already exists"))
2726 (gnus-message 1 "Documentation group already exists")))
2729 (gnus-message 1 "Couldn't find doc group")
2730 (gnus-group-make-group
2731 (gnus-group-real-name name)
2732 (list 'nndoc "gnus-help"
2733 (list 'nndoc-address file)
2734 (list 'nndoc-article-type 'mbox))))
2736 (gnus-group-position-point))
2738 (defun gnus-group-make-doc-group (file type)
2739 "Create a group that uses a single file as the source.
2741 If called with a prefix argument, ask for the file type."
2743 (list (read-file-name "File name: ")
2744 (and current-prefix-arg 'ask)))
2745 (when (eq type 'ask)
2750 "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [m, b, d, f, a, g]: "
2752 (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2753 ((= char ?b) 'babyl)
2754 ((= char ?d) 'digest)
2755 ((= char ?f) 'forward)
2757 ((= char ?g) 'guess)
2758 (t (setq err (format "%c unknown. " char))
2761 (setq file (expand-file-name file))
2762 (let ((name (gnus-generate-new-group-name
2763 (gnus-group-prefixed-name
2764 (file-name-nondirectory file) '(nndoc ""))))
2765 (encodable (mm-coding-system-p 'utf-8)))
2766 (gnus-group-make-group
2768 (mm-encode-coding-string (gnus-group-real-name name) 'utf-8)
2769 (gnus-group-real-name name))
2770 (list 'nndoc (if encodable
2771 (mm-encode-coding-string file 'utf-8)
2773 (list 'nndoc-address file)
2774 (list 'nndoc-article-type (or type 'guess))))))
2776 (defvar nnweb-type-definition)
2777 (defvar gnus-group-web-type-history nil)
2778 (defvar gnus-group-web-search-history nil)
2779 (defun gnus-group-make-web-group (&optional solid)
2780 "Create an ephemeral nnweb group.
2781 If SOLID (the prefix), create a solid group."
2785 (if solid (gnus-read-group "Group name: ")
2786 (message-unique-id)))
2787 (default-type (or (car gnus-group-web-type-history)
2788 (symbol-name (caar nnweb-type-definition))))
2792 (format "Search engine type (default %s): " default-type)
2793 (mapcar (lambda (elem) (list (symbol-name (car elem))))
2794 nnweb-type-definition)
2795 nil t nil 'gnus-group-web-type-history)
2800 (cons (or (car gnus-group-web-search-history) "") 0)
2801 'gnus-group-web-search-history))
2803 `(nnweb ,group (nnweb-search ,search)
2804 (nnweb-type ,(intern type))
2805 (nnweb-ephemeral-p t))))
2808 (gnus-pull 'nnweb-ephemeral-p method)
2809 (gnus-group-make-group group method))
2810 (gnus-group-read-ephemeral-group
2812 (cons (current-buffer)
2813 (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2816 (defvar nnrss-group-alist)
2817 (defun nnrss-discover-feed (arg))
2818 (defun nnrss-save-server-data (arg)))
2819 (defun gnus-group-make-rss-group (&optional url)
2820 "Given a URL, discover if there is an RSS feed.
2821 If there is, use Gnus to create an nnrss group"
2825 (setq url (read-from-minibuffer "URL to Search for RSS: ")))
2826 (let ((feedinfo (nnrss-discover-feed url)))
2828 (let ((title (gnus-newsgroup-savable-name
2829 (read-from-minibuffer "Title: "
2830 (gnus-newsgroup-savable-name
2831 (or (cdr (assoc 'title
2834 (desc (read-from-minibuffer "Description: "
2835 (cdr (assoc 'description
2837 (href (cdr (assoc 'href feedinfo)))
2838 (encodable (mm-coding-system-p 'utf-8)))
2840 ;; Unify non-ASCII text.
2841 (setq title (mm-decode-coding-string
2842 (mm-encode-coding-string title 'utf-8) 'utf-8)))
2843 (gnus-group-make-group (if encodable
2844 (mm-encode-coding-string title 'utf-8)
2847 (push (list title href desc) nnrss-group-alist)
2848 (nnrss-save-server-data nil))
2849 (error "No feeds found for %s" url))))
2851 (defvar nnwarchive-type-definition)
2852 (defvar gnus-group-warchive-type-history nil)
2853 (defvar gnus-group-warchive-login-history nil)
2854 (defvar gnus-group-warchive-address-history nil)
2856 (defun gnus-group-make-warchive-group ()
2857 "Create a nnwarchive group."
2859 (require 'nnwarchive)
2860 (let* ((group (gnus-read-group "Group name: "))
2861 (default-type (or (car gnus-group-warchive-type-history)
2862 (symbol-name (caar nnwarchive-type-definition))))
2866 (format "Warchive type (default %s): " default-type)
2867 (mapcar (lambda (elem) (list (symbol-name (car elem))))
2868 nnwarchive-type-definition)
2869 nil t nil 'gnus-group-warchive-type-history)
2871 (address (read-string "Warchive address: "
2872 nil 'gnus-group-warchive-address-history))
2873 (default-login (or (car gnus-group-warchive-login-history)
2878 (format "Warchive login (default %s): " user-mail-address)
2879 default-login 'gnus-group-warchive-login-history)
2882 `(nnwarchive ,address
2883 (nnwarchive-type ,(intern type))
2884 (nnwarchive-login ,login))))
2885 (gnus-group-make-group group method)))
2887 (defun gnus-group-make-archive-group (&optional all)
2888 "Create the (ding) Gnus archive group of the most recent articles.
2889 Given a prefix, create a full group."
2891 (let ((group (gnus-group-prefixed-name
2892 (if all "ding.archives" "ding.recent") '(nndir ""))))
2893 (when (gnus-group-entry group)
2894 (error "Archive group already exists"))
2895 (gnus-group-make-group
2896 (gnus-group-real-name group)
2897 (list 'nndir (if all "hpc" "edu")
2898 (list 'nndir-directory
2899 (if all gnus-group-archive-directory
2900 gnus-group-recent-archive-directory))))
2901 (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2903 (defun gnus-group-make-directory-group (dir)
2904 "Create an nndir group.
2905 The user will be prompted for a directory. The contents of this
2906 directory will be used as a newsgroup. The directory should contain
2907 mail messages or news articles in files that have numeric names."
2909 (list (read-file-name "Create group from directory: ")))
2910 (unless (file-exists-p dir)
2911 (error "No such directory"))
2912 (unless (file-directory-p dir)
2913 (error "Not a directory"))
2917 (while (or (not group) (gnus-group-entry group))
2919 (gnus-group-prefixed-name
2920 (expand-file-name ext dir)
2922 (setq ext (format "<%d>" (setq i (1+ i)))))
2923 (gnus-group-make-group
2924 (gnus-group-real-name group)
2925 (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2927 (defvar nnkiboze-score-file)
2928 (defun gnus-group-make-kiboze-group (group address scores)
2929 "Create an nnkiboze group.
2930 The user will be prompted for a name, a regexp to match groups, and
2931 score file entries for articles to include in the group."
2934 (read-string "nnkiboze group name: ")
2935 (read-string "Source groups (regexp): ")
2936 (let ((headers (mapcar 'list
2937 '("subject" "from" "number" "date" "message-id"
2938 "references" "chars" "lines" "xref"
2939 "followup" "all" "body" "head")))
2940 scores header regexp regexps)
2941 (while (not (equal "" (setq header (completing-read
2942 "Match on header: " headers nil t))))
2944 (while (not (equal "" (setq regexp (read-string
2945 (format "Match on %s (regexp): "
2947 (push (list regexp nil nil 'r) regexps))
2948 (push (cons header regexps) scores))
2950 (gnus-group-make-group group "nnkiboze" address)
2951 (let* ((nnkiboze-current-group group)
2952 (score-file (car (nnkiboze-score-file "")))
2953 (score-dir (file-name-directory score-file)))
2954 (unless (file-exists-p score-dir)
2955 (make-directory score-dir))
2956 (with-temp-file score-file
2957 (let (emacs-lisp-mode-hook)
2958 (gnus-pp scores)))))
2960 (defun gnus-group-add-to-virtual (n vgroup)
2961 "Add the current group to a virtual group."
2963 (list current-prefix-arg
2964 (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2966 (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2967 (error "%s is not an nnvirtual group" vgroup))
2968 (gnus-close-group vgroup)
2969 (let* ((groups (gnus-group-process-prefix n))
2970 (method (gnus-info-method (gnus-get-info vgroup))))
2971 (setcar (cdr method)
2973 (nth 1 method) "\\|"
2976 (gnus-group-remove-mark s)
2977 (concat "\\(^" (regexp-quote s) "$\\)"))
2979 (gnus-group-position-point))
2981 (defun gnus-group-make-empty-virtual (group)
2982 "Create a new, fresh, empty virtual group."
2983 (interactive "sCreate new, empty virtual group: ")
2984 (let* ((method (list 'nnvirtual "^$"))
2985 (pgroup (gnus-group-prefixed-name group method)))
2986 ;; Check whether it exists already.
2987 (when (gnus-group-entry pgroup)
2988 (error "Group %s already exists" pgroup))
2989 ;; Subscribe the new group after the group on the current line.
2990 (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2991 (gnus-group-update-group pgroup)
2993 (gnus-group-position-point)))
2995 (defun gnus-group-enter-directory (dir)
2996 "Enter an ephemeral nneething group."
2997 (interactive "DDirectory to read: ")
2998 (let* ((method (list 'nneething dir '(nneething-read-only t)))
2999 (leaf (gnus-group-prefixed-name
3000 (file-name-nondirectory (directory-file-name dir))
3002 (name (gnus-generate-new-group-name leaf)))
3003 (unless (gnus-group-read-ephemeral-group
3005 (cons (current-buffer)
3006 (if (eq major-mode 'gnus-summary-mode)
3008 (error "Couldn't enter %s" dir))))
3011 (autoload 'nnimap-expunge "nnimap")
3012 (autoload 'nnimap-acl-get "nnimap")
3013 (autoload 'nnimap-acl-edit "nnimap"))
3015 (defun gnus-group-nnimap-expunge (group)
3016 "Expunge deleted articles in current nnimap GROUP."
3017 (interactive (list (gnus-group-group-name)))
3018 (let ((mailbox (gnus-group-real-name group)) method)
3020 (error "No group on current line"))
3021 (unless (gnus-get-info group)
3022 (error "Killed group; can't be edited"))
3023 (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
3024 (error "%s is not an nnimap group" group))
3025 (nnimap-expunge mailbox (cadr method))))
3027 (defun gnus-group-nnimap-edit-acl (group)
3028 "Edit the Access Control List of current nnimap GROUP."
3029 (interactive (list (gnus-group-group-name)))
3030 (let ((mailbox (gnus-group-real-name group)) method acl)
3032 (error "No group on current line"))
3033 (unless (gnus-get-info group)
3034 (error "Killed group; can't be edited"))
3035 (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
3036 (error "%s is not an nnimap group" group))
3037 (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
3038 (error "Server does not support ACL's"))
3039 (gnus-edit-form acl (format "Editing the access control list for `%s'.
3041 An access control list is a list of (identifier . rights) elements.
3043 The identifier string specifies the corresponding user. The
3044 identifier \"anyone\" is reserved to refer to the universal identity.
3046 Rights is a string listing a (possibly empty) set of alphanumeric
3047 characters, each character listing a set of operations which is being
3048 controlled. Letters are reserved for ``standard'' rights, listed
3049 below. Digits are reserved for implementation or site defined rights.
3051 l - lookup (mailbox is visible to LIST/LSUB commands)
3052 r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
3053 SEARCH, COPY from mailbox)
3054 s - keep seen/unseen information across sessions (STORE \\SEEN flag)
3055 w - write (STORE flags other than \\SEEN and \\DELETED)
3056 i - insert (perform APPEND, COPY into mailbox)
3057 p - post (send mail to submission address for mailbox,
3058 not enforced by IMAP4 itself)
3059 c - create and delete mailbox (CREATE new sub-mailboxes in any
3060 implementation-defined hierarchy, RENAME or DELETE mailbox)
3061 d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
3062 a - administer (perform SETACL)" group)
3065 ,mailbox ',method ',acl form)))))
3067 ;; Group sorting commands
3068 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
3070 (defun gnus-group-sort-groups (func &optional reverse)
3071 "Sort the group buffer according to FUNC.
3072 When used interactively, the sorting function used will be
3073 determined by the `gnus-group-sort-function' variable.
3074 If REVERSE (the prefix), reverse the sorting order."
3075 (interactive (list gnus-group-sort-function current-prefix-arg))
3076 (funcall gnus-group-sort-alist-function
3077 (gnus-make-sort-function func) reverse)
3078 (gnus-group-unmark-all-groups)
3079 (gnus-group-list-groups)
3080 (gnus-dribble-touch))
3082 (defun gnus-group-sort-flat (func reverse)
3083 ;; We peel off the dummy group from the alist.
3085 (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
3086 (pop gnus-newsrc-alist))
3088 (setq gnus-newsrc-alist
3089 (sort gnus-newsrc-alist func))
3091 (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
3092 ;; Regenerate the hash table.
3093 (gnus-make-hashtable-from-newsrc-alist)))
3095 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
3096 "Sort the group buffer alphabetically by group name.
3097 If REVERSE, sort in reverse order."
3099 (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
3101 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
3102 "Sort the group buffer alphabetically by real (unprefixed) group name.
3103 If REVERSE, sort in reverse order."
3105 (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
3107 (defun gnus-group-sort-groups-by-unread (&optional reverse)
3108 "Sort the group buffer by number of unread articles.
3109 If REVERSE, sort in reverse order."
3111 (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
3113 (defun gnus-group-sort-groups-by-level (&optional reverse)
3114 "Sort the group buffer by group level.
3115 If REVERSE, sort in reverse order."
3117 (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
3119 (defun gnus-group-sort-groups-by-score (&optional reverse)
3120 "Sort the group buffer by group score.
3121 If REVERSE, sort in reverse order."
3123 (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
3125 (defun gnus-group-sort-groups-by-rank (&optional reverse)
3126 "Sort the group buffer by group rank.
3127 If REVERSE, sort in reverse order."
3129 (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
3131 (defun gnus-group-sort-groups-by-method (&optional reverse)
3132 "Sort the group buffer alphabetically by back end name.
3133 If REVERSE, sort in reverse order."
3135 (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
3137 (defun gnus-group-sort-groups-by-server (&optional reverse)
3138 "Sort the group buffer alphabetically by server name.
3139 If REVERSE, sort in reverse order."
3141 (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
3143 ;;; Selected group sorting.
3145 (defun gnus-group-sort-selected-groups (n func &optional reverse)
3146 "Sort the process/prefixed groups."
3147 (interactive (list current-prefix-arg gnus-group-sort-function))
3148 (let ((groups (gnus-group-process-prefix n)))
3149 (funcall gnus-group-sort-selected-function
3150 groups (gnus-make-sort-function func) reverse)
3151 (gnus-group-unmark-all-groups)
3152 (gnus-group-list-groups)
3153 (gnus-dribble-touch)))
3155 (defun gnus-group-sort-selected-flat (groups func reverse)
3156 (let (entries infos)
3157 ;; First find all the group entries for these groups.
3159 (push (nthcdr 2 (gnus-group-entry (pop groups)))
3161 ;; Then sort the infos.
3165 (lambda (entry) (car entry))
3166 (setq entries (nreverse entries)))
3169 (setq infos (nreverse infos)))
3170 ;; Go through all the infos and replace the old entries
3171 ;; with the new infos.
3173 (setcar (car entries) (pop infos))
3175 ;; Update the hashtable.
3176 (gnus-make-hashtable-from-newsrc-alist)))
3178 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
3179 "Sort the group buffer alphabetically by group name.
3180 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3181 sort in reverse order."
3182 (interactive (gnus-interactive "P\ny"))
3183 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
3185 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
3186 "Sort the group buffer alphabetically by real group name.
3187 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3188 sort in reverse order."
3189 (interactive (gnus-interactive "P\ny"))
3190 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
3192 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
3193 "Sort the group buffer by number of unread articles.
3194 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3195 sort in reverse order."
3196 (interactive (gnus-interactive "P\ny"))
3197 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
3199 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
3200 "Sort the group buffer by group level.
3201 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3202 sort in reverse order."
3203 (interactive (gnus-interactive "P\ny"))
3204 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
3206 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
3207 "Sort the group buffer by group score.
3208 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3209 sort in reverse order."
3210 (interactive (gnus-interactive "P\ny"))
3211 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
3213 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
3214 "Sort the group buffer by group rank.
3215 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3216 sort in reverse order."
3217 (interactive (gnus-interactive "P\ny"))
3218 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
3220 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
3221 "Sort the group buffer alphabetically by back end name.
3222 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3223 sort in reverse order."
3224 (interactive (gnus-interactive "P\ny"))
3225 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
3227 ;;; Sorting predicates.
3229 (defun gnus-group-sort-by-alphabet (info1 info2)
3230 "Sort alphabetically."
3231 (string< (gnus-info-group info1) (gnus-info-group info2)))
3233 (defun gnus-group-sort-by-real-name (info1 info2)
3234 "Sort alphabetically on real (unprefixed) names."
3235 (string< (gnus-group-real-name (gnus-info-group info1))
3236 (gnus-group-real-name (gnus-info-group info2))))
3238 (defun gnus-group-sort-by-unread (info1 info2)
3239 "Sort by number of unread articles."
3240 (let ((n1 (gnus-group-unread (gnus-info-group info1)))
3241 (n2 (gnus-group-unread (gnus-info-group info2))))
3242 (< (or (and (numberp n1) n1) 0)
3243 (or (and (numberp n2) n2) 0))))
3245 (defun gnus-group-sort-by-level (info1 info2)
3247 (< (gnus-info-level info1) (gnus-info-level info2)))
3249 (defun gnus-group-sort-by-method (info1 info2)
3250 "Sort alphabetically by back end name."
3251 (string< (car (gnus-find-method-for-group
3252 (gnus-info-group info1) info1))
3253 (car (gnus-find-method-for-group
3254 (gnus-info-group info2) info2))))
3256 (defun gnus-group-sort-by-server (info1 info2)
3257 "Sort alphabetically by server name."
3258 (string< (gnus-method-to-full-server-name
3259 (gnus-find-method-for-group
3260 (gnus-info-group info1) info1))
3261 (gnus-method-to-full-server-name
3262 (gnus-find-method-for-group
3263 (gnus-info-group info2) info2))))
3265 (defun gnus-group-sort-by-score (info1 info2)
3266 "Sort by group score."
3267 (> (gnus-info-score info1) (gnus-info-score info2)))
3269 (defun gnus-group-sort-by-rank (info1 info2)
3270 "Sort by level and score."
3271 (let ((level1 (gnus-info-level info1))
3272 (level2 (gnus-info-level info2)))
3273 (or (< level1 level2)
3274 (and (= level1 level2)
3275 (> (gnus-info-score info1) (gnus-info-score info2))))))
3279 (defun gnus-group-clear-data (&optional arg)
3280 "Clear all marks and read ranges from the current group.
3281 Obeys the process/prefix convention."
3283 (gnus-group-iterate arg
3286 (gnus-info-clear-data (setq info (gnus-get-info group)))
3287 (gnus-get-unread-articles-in-group info (gnus-active group) t)
3288 (when (gnus-group-goto-group group)
3289 (gnus-group-update-group-line))))))
3291 (defun gnus-group-clear-data-on-native-groups ()
3292 "Clear all marks and read ranges from all native groups."
3294 (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3295 (let ((alist (cdr gnus-newsrc-alist))
3297 (while (setq info (pop alist))
3298 (when (gnus-group-native-p (gnus-info-group info))
3299 (gnus-info-clear-data info)))
3300 (gnus-get-unread-articles)
3301 (gnus-dribble-touch)
3302 (when (gnus-y-or-n-p
3303 "Move the cache away to avoid problems in the future? ")
3304 (call-interactively 'gnus-cache-move-cache)))))
3306 (defun gnus-info-clear-data (info)
3307 "Clear all marks and read ranges from INFO."
3308 (let ((group (gnus-info-group info))
3310 (dolist (el (gnus-info-marks info))
3311 (push `(,(cdr el) add (,(car el))) action))
3312 (push `(,(gnus-info-read info) add (read)) action)
3315 (gnus-request-set-mark ,group ',action)
3316 (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3317 (gnus-info-set-read ',info ',(gnus-info-read info))
3318 (when (gnus-group-goto-group ,group)
3319 (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3320 (gnus-group-update-group-line))))
3321 (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3323 (gnus-request-set-mark group action)
3324 (gnus-info-set-read info nil)
3325 (when (gnus-info-marks info)
3326 (gnus-info-set-marks info nil))))
3328 ;; Group catching up.
3330 (defun gnus-group-catchup-current (&optional n all)
3331 "Mark all unread articles in the current newsgroup as read.
3332 If prefix argument N is numeric, the next N newsgroups will be
3333 caught up. If ALL is non-nil, marked articles will also be marked as
3334 read. Cross references (Xref: header) of articles are ignored.
3335 The number of newsgroups that this function was unable to catch
3338 (let ((groups (gnus-group-process-prefix n))
3341 (unless groups (error "No groups selected"))
3343 (or (not gnus-interactive-catchup) ;Without confirmation?
3348 "Do you really want to mark all articles in %s as read? "
3349 "Mark all unread articles in %s as read? ")
3350 (if (= (length groups) 1)
3351 (gnus-group-decoded-name (car groups))
3352 (format "these %d groups" (length groups)))))))
3354 (while (setq group (pop groups))
3355 (gnus-group-remove-mark group)
3356 ;; Virtual groups have to be given special treatment.
3357 (let ((method (gnus-find-method-for-group group)))
3358 (when (eq 'nnvirtual (car method))
3359 (nnvirtual-catchup-group
3360 (gnus-group-real-name group) (nth 1 method) all)))
3362 ((>= (gnus-group-level group) gnus-level-zombie)
3363 (gnus-message 2 "Dead groups can't be caught up"))
3365 (gnus-group-goto-group group)
3366 (gnus-group-catchup group all))
3367 (gnus-group-update-group-line))
3369 (setq ret (1+ ret)))))
3370 (gnus-group-next-unread-group 1)
3373 (defun gnus-group-catchup-current-all (&optional n)
3374 "Mark all articles in current newsgroup as read.
3375 Cross references (Xref: header) of articles are ignored."
3377 (gnus-group-catchup-current n 'all))
3379 (defun gnus-group-catchup (group &optional all)
3380 "Mark all articles in GROUP as read.
3381 If ALL is non-nil, all articles are marked as read.
3382 The return value is the number of articles that were marked as read,
3383 or nil if no action could be taken."
3384 (let* ((entry (gnus-group-entry group))
3386 (marks (gnus-info-marks (nth 2 entry)))
3387 (unread (gnus-sequence-of-unread-articles group)))
3388 ;; Remove entries for this group.
3389 (nnmail-purge-split-history (gnus-group-real-name group))
3390 ;; Do the updating only if the newsgroup isn't killed.
3391 (if (not (numberp (car entry)))
3392 (gnus-message 1 "Can't catch up %s; non-active group" group)
3393 (gnus-update-read-articles group nil)
3395 ;; Nix out the lists of marks and dormants.
3396 (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3398 (list (cdr (assq 'dormant marks))
3400 (setq unread (gnus-range-add (gnus-range-add
3401 unread (cdr (assq 'dormant marks)))
3402 (cdr (assq 'tick marks))))
3403 (gnus-add-marked-articles group 'tick nil nil 'force)
3404 (gnus-add-marked-articles group 'dormant nil nil 'force))
3405 ;; Do auto-expirable marks if that's required.
3406 (when (gnus-group-auto-expirable-p group)
3409 (gnus-add-marked-articles group 'expire (list article))
3410 (gnus-request-set-mark group (list (list (list article)
3413 (let ((gnus-newsgroup-name group))
3414 (gnus-run-hooks 'gnus-group-catchup-group-hook))
3417 (defun gnus-group-expire-articles (&optional n)
3418 "Expire all expirable articles in the current newsgroup.
3419 Uses the process/prefix convention."
3421 (let ((groups (gnus-group-process-prefix n))
3424 (error "No groups to expire"))
3425 (while (setq group (pop groups))
3426 (gnus-group-remove-mark group)
3427 (gnus-group-expire-articles-1 group)
3428 (gnus-dribble-touch)
3429 (gnus-group-position-point))))
3431 (defun gnus-group-expire-articles-1 (group)
3432 (when (gnus-check-backend-function 'request-expire-articles group)
3433 (gnus-message 6 "Expiring articles in %s..."
3434 (gnus-group-decoded-name group))
3435 (let* ((info (gnus-get-info group))
3436 (expirable (if (gnus-group-total-expirable-p group)
3437 (cons nil (gnus-list-of-read-articles group))
3438 (assq 'expire (gnus-info-marks info))))
3439 (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3440 (nnmail-expiry-target
3441 (or (gnus-group-find-parameter group 'expiry-target)
3442 nnmail-expiry-target)))
3444 (gnus-check-group group)
3447 (gnus-compress-sequence
3449 ;; We set the expiry variables to the group
3451 (let ((nnmail-expiry-wait-function nil)
3452 (nnmail-expiry-wait expiry-wait))
3453 (gnus-request-expire-articles
3454 (gnus-uncompress-sequence (cdr expirable)) group))
3455 ;; Just expire using the normal expiry values.
3456 (gnus-request-expire-articles
3457 (gnus-uncompress-sequence (cdr expirable)) group))))
3458 (gnus-close-group group))
3459 (gnus-message 6 "Expiring articles in %s...done"
3460 (gnus-group-decoded-name group))
3461 ;; Return the list of un-expired articles.
3464 (defun gnus-group-expire-all-groups ()
3465 "Expire all expirable articles in all newsgroups."
3468 (gnus-message 5 "Expiring...")
3469 (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3470 (cdr gnus-newsrc-alist))))
3471 (gnus-group-expire-articles nil)))
3472 (gnus-group-position-point)
3473 (gnus-message 5 "Expiring...done"))
3475 (defun gnus-group-set-current-level (n level)
3476 "Set the level of the next N groups to LEVEL."
3481 (unless (gnus-group-process-prefix current-prefix-arg)
3482 (error "No group on the current line"))
3484 (let ((s (read-string
3485 (format "Level (default %s): "
3486 (or (gnus-group-group-level)
3487 gnus-level-default-subscribed)))))
3488 (if (string-match "^\\s-*$" s)
3489 (int-to-string (or (gnus-group-group-level)
3490 gnus-level-default-subscribed))
3492 (unless (and (>= level 1) (<= level gnus-level-killed))
3493 (error "Invalid level: %d" level))
3494 (dolist (group (gnus-group-process-prefix n))
3495 (gnus-group-remove-mark group)
3496 (gnus-message 6 "Changed level of %s from %d to %d"
3497 (gnus-group-decoded-name group)
3498 (or (gnus-group-group-level) gnus-level-killed)
3500 (gnus-group-change-level
3501 group level (or (gnus-group-group-level) gnus-level-killed))
3502 (gnus-group-update-group-line))
3503 (gnus-group-position-point))
3505 (defun gnus-group-unsubscribe (&optional n)
3506 "Unsubscribe the current group."
3508 (gnus-group-unsubscribe-current-group n 'unsubscribe))
3510 (defun gnus-group-subscribe (&optional n)
3511 "Subscribe the current group."
3513 (gnus-group-unsubscribe-current-group n 'subscribe))
3515 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3516 "Toggle subscription of the current group.
3517 If given numerical prefix, toggle the N next groups."
3519 (dolist (group (gnus-group-process-prefix n))
3520 (gnus-group-remove-mark group)
3521 (gnus-group-unsubscribe-group
3524 ((eq do-sub 'unsubscribe)
3525 gnus-level-default-unsubscribed)
3526 ((eq do-sub 'subscribe)
3527 gnus-level-default-subscribed)
3528 ((<= (gnus-group-group-level) gnus-level-subscribed)
3529 gnus-level-default-unsubscribed)
3531 gnus-level-default-subscribed))
3533 (gnus-group-update-group-line))
3534 (gnus-group-next-group 1))
3536 (defun gnus-group-unsubscribe-group (group &optional level silent)
3537 "Toggle subscription to GROUP.
3538 Killed newsgroups are subscribed. If SILENT, don't try to update the
3541 (list (completing-read
3542 "Group: " gnus-active-hashtb nil
3543 (gnus-read-active-file-p)
3545 'gnus-group-history)))
3546 (let ((newsrc (gnus-group-entry group)))
3548 ((string-match "^[ \t]*$" group)
3549 (error "Empty group name"))
3551 ;; Toggle subscription flag.
3552 (gnus-group-change-level
3553 newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3554 gnus-level-subscribed)
3555 (1+ gnus-level-subscribed)
3556 gnus-level-default-subscribed)))
3558 (gnus-group-update-group group)))
3559 ((and (stringp group)
3560 (or (not (gnus-read-active-file-p))
3561 (gnus-active group)))
3562 ;; Add new newsgroup.
3563 (gnus-group-change-level
3565 (if level level gnus-level-default-subscribed)
3566 (or (and (member group gnus-zombie-list)
3569 (when (gnus-group-group-name)
3570 (gnus-group-entry (gnus-group-group-name))))
3572 (gnus-group-update-group group)))
3573 (t (error "No such newsgroup: %s" group)))
3574 (gnus-group-position-point)))
3576 (defun gnus-group-transpose-groups (n)
3577 "Move the current newsgroup up N places.
3578 If given a negative prefix, move down instead. The difference between
3579 N and the number of steps taken is returned."
3581 (unless (gnus-group-group-name)
3582 (error "No group on current line"))
3583 (gnus-group-kill-group 1)
3585 (forward-line (- n))
3586 (gnus-group-yank-group)
3587 (gnus-group-position-point)))
3589 (defun gnus-group-kill-all-zombies (&optional dummy)
3590 "Kill all zombie newsgroups.
3591 The optional DUMMY should always be nil."
3592 (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3594 (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3595 (setq gnus-zombie-list nil)
3596 (gnus-dribble-touch)
3597 (gnus-group-list-groups)))
3599 (defun gnus-group-kill-region (begin end)
3600 "Kill newsgroups in current region (excluding current point).
3601 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3614 (beginning-of-line) ;Important when LINES < 1
3615 (gnus-group-kill-group lines)))
3617 (defun gnus-group-kill-group (&optional n discard)
3618 "Kill the next N groups.
3619 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3620 However, only groups that were alive can be yanked; already killed
3621 groups or zombie groups can't be yanked.
3622 The return value is the name of the group that was killed, or a list
3625 (let ((buffer-read-only nil)
3626 (groups (gnus-group-process-prefix n))
3627 group entry level out)
3628 (if (< (length groups) 10)
3629 ;; This is faster when there are few groups.
3631 (push (setq group (pop groups)) out)
3632 (gnus-group-remove-mark group)
3633 (setq level (gnus-group-group-level))
3635 (when (and (not discard)
3636 (setq entry (gnus-group-entry group)))
3639 (gnus-group-goto-group ,(gnus-group-group-name))
3640 (gnus-group-yank-group)))
3641 (push (cons (car entry) (nth 2 entry))
3642 gnus-list-of-killed-groups))
3643 (gnus-group-change-level
3644 (if entry entry group) gnus-level-killed (if entry nil level))
3645 (message "Killed group %s" (gnus-group-decoded-name group)))
3646 ;; If there are lots and lots of groups to be killed, we use
3647 ;; this thing instead.
3648 (dolist (group (nreverse groups))
3649 (gnus-group-remove-mark group)
3651 (push group gnus-killed-list)
3652 (setq gnus-newsrc-alist
3653 (delq (assoc group gnus-newsrc-alist)
3655 (when gnus-group-change-level-function
3656 (funcall gnus-group-change-level-function
3657 group gnus-level-killed 3))
3659 ((setq entry (gnus-group-entry group))
3660 (push (cons (car entry) (nth 2 entry))
3661 gnus-list-of-killed-groups)
3662 (setcdr (cdr entry) (cdddr entry)))
3663 ((member group gnus-zombie-list)
3664 (setq gnus-zombie-list (delete group gnus-zombie-list))))
3665 ;; There may be more than one instance displayed.
3666 (while (gnus-group-goto-group group)
3667 (gnus-delete-line)))
3668 (gnus-make-hashtable-from-newsrc-alist))
3670 (gnus-group-position-point)
3671 (if (< (length out) 2) (car out) (nreverse out))))
3673 (defun gnus-group-yank-group (&optional arg)
3674 "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3675 The numeric ARG specifies how many newsgroups are to be yanked. The
3676 name of the newsgroup yanked is returned, or (if several groups are
3677 yanked) a list of yanked groups is returned."
3679 (setq arg (or arg 1))
3680 (let (info group prev out)
3681 (while (>= (decf arg) 0)
3682 (when (not (setq info (pop gnus-list-of-killed-groups)))
3683 (error "No more newsgroups to yank"))
3684 (push (setq group (nth 1 info)) out)
3685 ;; Find which newsgroup to insert this one before - search
3686 ;; backward until something suitable is found. If there are no
3687 ;; other newsgroups in this buffer, just make this newsgroup the
3689 (setq prev (gnus-group-group-name))
3690 (gnus-group-change-level
3691 info (gnus-info-level (cdr info)) gnus-level-killed
3692 (and prev (gnus-group-entry prev))
3694 (gnus-group-insert-group-line-info group)
3696 `(when (gnus-group-goto-group ,group)
3697 (gnus-group-kill-group 1))))
3699 (gnus-group-position-point)
3700 (if (< (length out) 2) (car out) (nreverse out))))
3702 (defun gnus-group-kill-level (level)
3703 "Kill all groups that is on a certain LEVEL."
3704 (interactive "nKill all groups on level: ")
3706 ((= level gnus-level-zombie)
3707 (setq gnus-killed-list
3708 (nconc gnus-zombie-list gnus-killed-list))
3709 (setq gnus-zombie-list nil))
3710 ((and (< level gnus-level-zombie)
3712 (or gnus-expert-user
3715 "Do you really want to kill all groups on level %d? "
3717 (let* ((prev gnus-newsrc-alist)
3720 (if (= (gnus-info-level (car alist)) level)
3722 (push (gnus-info-group (car alist)) gnus-killed-list)
3723 (setcdr prev (cdr alist)))
3725 (setq alist (cdr alist)))
3726 (gnus-make-hashtable-from-newsrc-alist)
3727 (gnus-group-list-groups)))
3729 (error "Can't kill; invalid level: %d" level))))
3731 (defun gnus-group-list-all-groups (&optional arg)
3732 "List all newsgroups with level ARG or lower.
3733 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3734 unsubscribed groups."
3736 (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3738 ;; Redefine this to list ALL killed groups if prefix arg used.
3739 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3740 (defun gnus-group-list-killed (&optional arg)
3741 "List all killed newsgroups in the group buffer.
3742 If ARG is non-nil, list ALL killed groups known to Gnus. This may
3743 entail asking the server for the groups."
3745 ;; Find all possible killed newsgroups if arg.
3747 (gnus-get-killed-groups))
3748 (if (not gnus-killed-list)
3749 (gnus-message 6 "No killed groups")
3750 (let (gnus-group-list-mode)
3751 (funcall gnus-group-prepare-function
3752 gnus-level-killed t gnus-level-killed))
3753 (goto-char (point-min)))
3754 (gnus-group-position-point))
3756 (defun gnus-group-list-zombies ()
3757 "List all zombie newsgroups in the group buffer."
3759 (if (not gnus-zombie-list)
3760 (gnus-message 6 "No zombie groups")
3761 (let (gnus-group-list-mode)
3762 (funcall gnus-group-prepare-function
3763 gnus-level-zombie t gnus-level-zombie))
3764 (goto-char (point-min)))
3765 (gnus-group-position-point))
3767 (defun gnus-group-list-active ()
3768 "List all groups that are available from the server(s)."
3770 ;; First we make sure that we have really read the active file.
3771 (unless (gnus-read-active-file-p)
3772 (let ((gnus-read-active-file t)
3773 (gnus-agent gnus-plugged)); If we're actually plugged, store the active file in the agent.
3774 (gnus-read-active-file)))
3775 ;; Find all groups and sort them.
3783 (push (symbol-name sym) list)))
3787 (buffer-read-only nil)
3791 (setq group (pop groups))
3792 (gnus-add-text-properties
3793 (point) (prog1 (1+ (point))
3795 (gnus-group-decoded-name group)
3797 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3799 'gnus-level (inline (gnus-group-level group)))))
3800 (goto-char (point-min))))
3802 (defun gnus-activate-all-groups (level)
3803 "Activate absolutely all groups."
3804 (interactive (list gnus-level-unsubscribed))
3805 (let ((gnus-activate-level level)
3806 (gnus-activate-foreign-newsgroups level))
3807 (gnus-group-get-new-news)))
3809 (defun gnus-group-get-new-news (&optional arg)
3810 "Get newly arrived articles.
3811 If ARG is a number, it specifies which levels you are interested in
3812 re-scanning. If ARG is non-nil and not a number, this will force
3813 \"hard\" re-reading of the active files from all servers."
3816 (let ((gnus-inhibit-demon t)
3817 ;; Binding this variable will inhibit multiple fetchings
3818 ;; of the same mail source.
3819 (nnmail-fetched-sources (list t)))
3820 (gnus-run-hooks 'gnus-get-top-new-news-hook)
3821 (gnus-run-hooks 'gnus-get-new-news-hook)
3823 ;; Read any slave files.
3825 (gnus-master-read-slave-newsrc))
3827 ;; We might read in new NoCeM messages here.
3828 (when (and gnus-use-nocem
3829 (or (and (numberp gnus-use-nocem)
3831 (>= arg gnus-use-nocem))
3833 (gnus-nocem-scan-groups))
3834 ;; If ARG is not a number, then we read the active file.
3835 (when (and arg (not (numberp arg)))
3836 (let ((gnus-read-active-file t))
3837 (gnus-read-active-file))
3840 ;; If the user wants it, we scan for new groups.
3841 (when (eq gnus-check-new-newsgroups 'always)
3842 (gnus-find-new-newsgroups)))
3844 (setq arg (gnus-group-default-level arg t))
3845 (if (and gnus-read-active-file (not arg))
3847 (gnus-read-active-file)
3848 (gnus-get-unread-articles arg))
3849 (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
3850 (gnus-get-unread-articles arg)))
3851 (gnus-check-reasonable-setup)
3852 (gnus-run-hooks 'gnus-after-getting-new-news-hook)
3853 (gnus-group-list-groups (and (numberp arg)
3854 (max (car gnus-group-list-mode) arg)))))
3856 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
3857 "Check for newly arrived news in the current group (and the N-1 next groups).
3858 The difference between N and the number of newsgroup checked is returned.
3859 If N is negative, this group and the N-1 previous groups will be checked.
3860 If DONT-SCAN is non-nil, scan non-activated groups as well."
3862 (let* ((groups (gnus-group-process-prefix n))
3863 (ret (if (numberp n) (- n (length groups)) 0))
3867 (gnus-inhibit-demon t)
3868 ;; Binding this variable will inhibit multiple fetchings
3869 ;; of the same mail source.
3870 (nnmail-fetched-sources (list t)))
3871 (gnus-run-hooks 'gnus-get-new-news-hook)
3872 (while (setq group (pop groups))
3873 (gnus-group-remove-mark group)
3874 ;; Bypass any previous denials from the server.
3875 (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
3876 (if (gnus-activate-group group (if dont-scan nil 'scan) nil method)
3877 (let ((info (gnus-get-info group))
3878 (active (gnus-active group)))
3880 (gnus-request-update-info info method))
3881 (gnus-get-unread-articles-in-group info active)
3882 (unless (gnus-virtual-group-p group)
3883 (gnus-close-group group))
3885 (gnus-agent-save-group-info
3886 method (gnus-group-real-name group) active))
3887 (gnus-group-update-group group))
3888 (if (eq (gnus-server-status (gnus-find-method-for-group group))
3890 (gnus-error 3 "Server denied access")
3891 (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3894 (when gnus-goto-next-group-when-activating
3895 (gnus-group-next-unread-group 1 t))
3896 (gnus-summary-position-point)
3899 (defun gnus-group-fetch-faq (group &optional faq-dir)
3900 "Fetch the FAQ for the current group.
3901 If given a prefix argument, prompt for the FAQ dir
3905 (gnus-group-group-name)
3906 (when current-prefix-arg
3908 "FAQ dir: " (and (listp gnus-group-faq-directory)
3910 gnus-group-faq-directory))))))
3912 (error "No group name given"))
3913 (let ((dirs (or faq-dir gnus-group-faq-directory))
3915 (unless (listp dirs)
3916 (setq dirs (list dirs)))
3917 (while (and (not found)
3918 (setq dir (pop dirs)))
3919 (let ((name (gnus-group-real-name group)))
3920 (setq file (expand-file-name name dir)))
3921 (if (not (file-exists-p file))
3922 (gnus-message 1 "No such file: %s" file)
3923 (let ((enable-local-variables nil))
3927 (defun gnus-group-fetch-charter (group)
3928 "Fetch the charter for the current group.
3929 If given a prefix argument, prompt for a group."
3931 (list (or (when current-prefix-arg
3932 (completing-read "Group: " gnus-active-hashtb))
3933 (gnus-group-group-name)
3934 gnus-newsgroup-name)))
3936 (error "No group name given"))
3938 (condition-case nil (require 'url-http) (error nil))
3939 (let ((name (mm-url-form-encode-xwfu (gnus-group-real-name group)))
3941 (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3942 (setq hierarchy (match-string 1 name))
3943 (if (and (setq url (cdr (assoc hierarchy gnus-group-charter-alist)))
3944 (if (fboundp 'url-http-file-exists-p)
3945 (url-http-file-exists-p (eval url))
3947 (browse-url (eval url))
3948 (setq url (concat "http://" hierarchy
3949 ".news-admin.org/charters/" name))
3950 (if (and (fboundp 'url-http-file-exists-p)
3951 (url-http-file-exists-p url))
3953 (gnus-group-fetch-control group))))))
3955 (defun gnus-group-fetch-control (group)
3956 "Fetch the archived control messages for the current group.
3957 If given a prefix argument, prompt for a group."
3959 (list (or (when current-prefix-arg
3960 (completing-read "Group: " gnus-active-hashtb))
3961 (gnus-group-group-name)
3962 gnus-newsgroup-name)))
3964 (error "No group name given"))
3965 (let ((name (gnus-group-real-name group))
3967 (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3968 (setq hierarchy (match-string 1 name))
3969 (if gnus-group-fetch-control-use-browse-url
3970 (browse-url (concat "ftp://ftp.isc.org/usenet/control/"
3971 hierarchy "/" name ".gz"))
3972 (let ((enable-local-variables nil))
3973 (gnus-group-read-ephemeral-group
3975 `(nndoc ,group (nndoc-address
3976 ,(find-file-noselect
3977 (concat "/ftp@ftp.isc.org:/usenet/control/"
3978 hierarchy "/" name ".gz")))
3979 (nndoc-article-type mbox)) t nil nil))))))
3981 (defun gnus-group-describe-group (force &optional group)
3982 "Display a description of the current newsgroup."
3983 (interactive (list current-prefix-arg (gnus-group-group-name)))
3984 (let* ((method (gnus-find-method-for-group group))
3985 (mname (gnus-group-prefixed-name "" method))
3988 gnus-description-hashtb)
3989 (gnus-sethash mname nil gnus-description-hashtb))
3991 (error "No group name given"))
3992 (when (or (and gnus-description-hashtb
3993 ;; We check whether this group's method has been
3994 ;; queried for a description file.
3995 (gnus-gethash mname gnus-description-hashtb))
3996 (setq desc (gnus-group-get-description group))
3997 (gnus-read-descriptions-file method))
3999 (or desc (gnus-gethash group gnus-description-hashtb)
4000 "No description available")))))
4002 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4003 (defun gnus-group-describe-all-groups (&optional force)
4004 "Pop up a buffer with descriptions of all newsgroups."
4007 (setq gnus-description-hashtb nil))
4008 (when (not (or gnus-description-hashtb
4009 (gnus-read-all-descriptions-files)))
4010 (error "Couldn't request descriptions file"))
4011 (let ((buffer-read-only nil)
4017 (let ((charset (gnus-group-name-charset nil (symbol-name group))))
4018 (insert (format " *: %-20s %s\n"
4019 (gnus-group-name-decode
4020 (symbol-name group) charset)
4021 (gnus-group-name-decode
4022 (symbol-value group) charset))))
4023 (gnus-add-text-properties
4024 b (1+ b) (list 'gnus-group group
4025 'gnus-unread t 'gnus-marked nil
4026 'gnus-level (1+ gnus-level-subscribed))))
4027 gnus-description-hashtb)
4028 (goto-char (point-min))
4029 (gnus-group-position-point)))
4031 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
4032 (defun gnus-group-apropos (regexp &optional search-description)
4033 "List all newsgroups that have names that match a regexp."
4034 (interactive "sGnus apropos (regexp): ")
4036 (obuf (current-buffer))
4038 ;; Go through all newsgroups that are known to Gnus.
4041 (and (symbol-name group)
4042 (string-match regexp (symbol-name group))
4043 (symbol-value group)
4044 (push (symbol-name group) groups)))
4046 ;; Also go through all descriptions that are known to Gnus.
4047 (when search-description
4050 (and (string-match regexp (symbol-value group))
4051 (push (symbol-name group) groups)))
4052 gnus-description-hashtb))
4054 (gnus-message 3 "No groups matched \"%s\"." regexp)
4055 ;; Print out all the groups.
4057 (pop-to-buffer "*Gnus Help*")
4058 (buffer-disable-undo)
4060 (setq groups (sort groups 'string<))
4062 ;; Groups may be entered twice into the list of groups.
4063 (when (not (string= (car groups) prev))
4064 (setq prev (car groups))
4065 (let ((charset (gnus-group-name-charset nil prev)))
4066 (insert (gnus-group-name-decode prev charset) "\n")
4067 (when (and gnus-description-hashtb
4068 (setq des (gnus-gethash (car groups)
4069 gnus-description-hashtb)))
4070 (insert " " (gnus-group-name-decode des charset) "\n"))))
4071 (setq groups (cdr groups)))
4072 (goto-char (point-min))))
4073 (pop-to-buffer obuf)))
4075 (defun gnus-group-description-apropos (regexp)
4076 "List all newsgroups that have names or descriptions that match REGEXP."
4077 (interactive "sGnus description apropos (regexp): ")
4078 (when (not (or gnus-description-hashtb
4079 (gnus-read-all-descriptions-files)))
4080 (error "Couldn't request descriptions file"))
4081 (gnus-group-apropos regexp t))
4083 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4084 (defun gnus-group-list-matching (level regexp &optional all lowest)
4085 "List all groups with unread articles that match REGEXP.
4086 If the prefix LEVEL is non-nil, it should be a number that says which
4087 level to cut off listing groups.
4088 If ALL, also list groups with no unread articles.
4089 If LOWEST, don't list groups with level lower than LOWEST.
4091 This command may read the active file."
4092 (interactive "P\nsList newsgroups matching: ")
4093 ;; First make sure active file has been read.
4095 (> (prefix-numeric-value level) gnus-level-killed))
4096 (gnus-get-killed-groups))
4097 (funcall gnus-group-prepare-function
4098 (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
4099 (goto-char (point-min))
4100 (gnus-group-position-point))
4102 (defun gnus-group-list-all-matching (level regexp &optional lowest)
4103 "List all groups that match REGEXP.
4104 If the prefix LEVEL is non-nil, it should be a number that says which
4105 level to cut off listing groups.
4106 If LOWEST, don't list groups with level lower than LOWEST."
4107 (interactive "P\nsList newsgroups matching: ")
4109 (setq level (prefix-numeric-value level)))
4110 (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
4112 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
4113 (defun gnus-group-save-newsrc (&optional force)
4114 "Save the Gnus startup files.
4115 If FORCE, force saving whether it is necessary or not."
4117 (gnus-save-newsrc-file force))
4119 (defun gnus-group-restart (&optional arg)
4120 "Force Gnus to read the .newsrc file."
4122 (when (gnus-yes-or-no-p
4123 (format "Are you sure you want to restart Gnus? "))
4124 (gnus-save-newsrc-file)
4128 (defun gnus-group-read-init-file ()
4129 "Read the Gnus elisp init file."
4131 (gnus-read-init-file)
4132 (gnus-message 5 "Read %s" gnus-init-file))
4134 (defun gnus-group-check-bogus-groups (&optional silent)
4135 "Check bogus newsgroups.
4136 If given a prefix, don't ask for confirmation before removing a bogus
4139 (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
4140 (gnus-group-list-groups))
4142 (defun gnus-group-find-new-groups (&optional arg)
4143 "Search for new groups and add them.
4144 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
4145 With 1 C-u, use the `ask-server' method to query the server for new
4147 With 2 C-u's, use most complete method possible to query the server
4148 for new groups, and subscribe the new groups as zombies."
4150 (gnus-find-new-newsgroups (or arg 1))
4151 (gnus-group-list-groups))
4153 (defun gnus-group-edit-global-kill (&optional article group)
4154 "Edit the global kill file.
4155 If GROUP, edit that local kill file instead."
4157 (setq gnus-current-kill-article article)
4158 (gnus-kill-file-edit-file group)
4161 (substitute-command-keys
4162 (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
4163 (if group "local" "global")))))
4165 (defun gnus-group-edit-local-kill (article group)
4166 "Edit a local kill file."
4167 (interactive (list nil (gnus-group-group-name)))
4168 (gnus-group-edit-global-kill article group))
4170 (defun gnus-group-force-update ()
4171 "Update `.newsrc' file."
4173 (gnus-save-newsrc-file))
4175 (defvar gnus-backlog-articles)
4177 (defun gnus-group-suspend ()
4178 "Suspend the current Gnus session.
4179 In fact, cleanup buffers except for group mode buffer.
4180 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
4182 (gnus-run-hooks 'gnus-suspend-gnus-hook)
4183 (gnus-offer-save-summaries)
4184 ;; Kill Gnus buffers except for group mode buffer.
4185 (let ((group-buf (get-buffer gnus-group-buffer)))
4186 (mapcar (lambda (buf)
4187 (unless (or (member buf (list group-buf gnus-dribble-buffer))
4188 (with-current-buffer buf
4189 (eq major-mode 'message-mode)))
4190 (gnus-kill-buffer buf)))
4192 (setq gnus-backlog-articles nil)
4193 (gnus-kill-gnus-frames)
4195 (bury-buffer group-buf)
4196 (delete-windows-on group-buf t))))
4198 (defun gnus-group-clear-dribble ()
4199 "Clear all information from the dribble buffer."
4201 (gnus-dribble-clear)
4202 (gnus-message 7 "Cleared dribble buffer"))
4204 (defun gnus-group-exit ()
4205 "Quit reading news after updating .newsrc.eld and .newsrc.
4206 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4209 (or noninteractive ;For gnus-batch-kill
4210 (not gnus-interactive-exit) ;Without confirmation
4212 (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
4213 (gnus-run-hooks 'gnus-exit-gnus-hook)
4214 ;; Offer to save data from non-quitted summary buffers.
4215 (gnus-offer-save-summaries)
4216 ;; Save the newsrc file(s).
4217 (gnus-save-newsrc-file)
4219 (gnus-close-backends)
4220 ;; Reset everything.
4222 ;; Allow the user to do things after cleaning up.
4223 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4225 (defun gnus-group-quit ()
4226 "Quit reading news without updating .newsrc.eld or .newsrc.
4227 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4229 (when (or noninteractive ;For gnus-batch-kill
4230 (zerop (buffer-size))
4231 (not (gnus-server-opened gnus-select-method))
4233 (not gnus-current-startup-file)
4235 (format "Quit reading news without saving %s? "
4236 (file-name-nondirectory gnus-current-startup-file))))
4237 (gnus-run-hooks 'gnus-exit-gnus-hook)
4238 (gnus-configure-windows 'group t)
4239 (when (and (gnus-buffer-live-p gnus-dribble-buffer)
4240 (not (zerop (save-excursion
4241 (set-buffer gnus-dribble-buffer)
4244 ";;; Gnus was exited on purpose without saving the .newsrc files."))
4246 (gnus-close-backends)
4248 (gnus-kill-buffer gnus-group-buffer)
4249 ;; Allow the user to do things after cleaning up.
4250 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4252 (defun gnus-group-describe-briefly ()
4253 "Give a one line description of the group mode commands."
4255 (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")))
4257 (defun gnus-group-browse-foreign-server (method)
4258 "Browse a foreign news server.
4259 If called interactively, this function will ask for a select method
4260 (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
4261 If not, METHOD should be a list where the first element is the method
4262 and the second element is the address."
4264 (list (let ((how (completing-read
4266 (append gnus-valid-select-methods gnus-server-alist)
4267 nil t (cons "nntp" 0) 'gnus-method-history)))
4268 ;; We either got a back end name or a virtual server name.
4269 ;; If the first, we also need an address.
4270 (if (assoc how gnus-valid-select-methods)
4272 ;; Suggested by mapjph@bath.ac.uk.
4275 (mapcar 'list gnus-secondary-servers)))
4276 ;; We got a server name.
4278 (gnus-browse-foreign-server method))
4280 (defun gnus-group-set-info (info &optional method-only-group part)
4281 (when (or info part)
4282 (let* ((entry (gnus-group-entry
4283 (or method-only-group (gnus-info-group info))))
4285 (info (if method-only-group (nth 2 entry) info))
4287 (when method-only-group
4289 (error "Trying to change non-existent group %s" method-only-group))
4290 ;; We have received parts of the actual group info - either the
4291 ;; select method or the group parameters. We first check
4292 ;; whether we have to extend the info, and if so, do that.
4293 (let ((len (length info))
4294 (total (if (eq part 'method) 5 6)))
4296 (setcdr (nthcdr (1- len) info)
4297 (make-list (- total len) nil)))
4298 ;; Then we enter the new info.
4299 (setcar (nthcdr (1- total) info) part-info)))
4301 ;; This is a new group, so we just create it.
4303 (set-buffer gnus-group-buffer)
4304 (setq method (gnus-info-method info))
4305 (when (gnus-server-equal method "native")
4308 (set-buffer gnus-group-buffer)
4310 ;; It's a foreign group...
4311 (gnus-group-make-group
4312 (gnus-group-real-name (gnus-info-group info))
4313 (if (stringp method) method
4314 (prin1-to-string (car method)))
4316 (nth 1 (gnus-info-method info))))
4317 ;; It's a native group.
4318 (gnus-group-make-group (gnus-info-group info))))
4319 (gnus-message 6 "Note: New group created")
4321 (gnus-group-entry (gnus-group-prefixed-name
4322 (gnus-group-real-name (gnus-info-group info))
4323 (or (gnus-info-method info) gnus-select-method))))))
4324 ;; Whether it was a new group or not, we now have the entry, so we
4325 ;; can do the update.
4328 (setcar (nthcdr 2 entry) info)
4329 (when (and (not (eq (car entry) t))
4330 (gnus-active (gnus-info-group info)))
4331 (setcar entry (length
4332 (gnus-list-of-unread-articles (car info))))))
4333 (error "No such group: %s" (gnus-info-group info))))))
4335 (defun gnus-group-set-method-info (group select-method)
4336 (gnus-group-set-info select-method group 'method))
4338 (defun gnus-group-set-params-info (group params)
4339 (gnus-group-set-info params group 'params))
4341 (defun gnus-add-marked-articles (group type articles &optional info force)
4342 ;; Add ARTICLES of TYPE to the info of GROUP.
4343 ;; If INFO is non-nil, use that info. If FORCE is non-nil, don't
4344 ;; add, but replace marked articles of TYPE with ARTICLES.
4345 (let ((info (or info (gnus-get-info group)))
4348 (and (not (setq marked (nthcdr 3 info)))
4350 (setcdr (nthcdr 2 info)
4351 (list (list (cons type (gnus-compress-sequence
4353 (and (not (setq m (assq type (car marked))))
4356 (cons (cons type (gnus-compress-sequence articles t) )
4360 (setcar (nthcdr 3 info)
4361 (gnus-delete-alist type (car marked)))
4362 (setcdr m (gnus-compress-sequence articles t)))
4363 (setcdr m (gnus-compress-sequence
4364 (sort (nconc (gnus-uncompress-range (cdr m))
4365 (copy-sequence articles)) '<) t))))))
4367 (defun gnus-add-mark (group mark article)
4368 "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4369 (let ((buffer (gnus-summary-buffer-name group)))
4370 (if (gnus-buffer-live-p buffer)
4372 (set-buffer (get-buffer buffer))
4373 (gnus-summary-add-mark article mark))
4374 (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4378 ;;; Group timestamps
4381 (defun gnus-group-set-timestamp ()
4382 "Change the timestamp of the current group to the current time.
4383 This function can be used in hooks like `gnus-select-group-hook'
4384 or `gnus-group-catchup-group-hook'."
4385 (when gnus-newsgroup-name
4386 (let ((time (current-time)))
4387 (setcdr (cdr time) nil)
4388 (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4390 (defsubst gnus-group-timestamp (group)
4391 "Return the timestamp for GROUP."
4392 (gnus-group-get-parameter group 'timestamp t))
4394 (defun gnus-group-timestamp-delta (group)
4395 "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4396 (let* ((time (or (gnus-group-timestamp group)
4398 (delta (subtract-time (current-time) time)))
4399 (+ (* (nth 0 delta) 65536.0)
4402 (defun gnus-group-timestamp-string (group)
4403 "Return a string of the timestamp for GROUP."
4404 (let ((time (gnus-group-timestamp group)))
4407 (gnus-time-iso8601 time))))
4409 (defun gnus-group-list-cached (level &optional lowest)
4410 "List all groups with cached articles.
4411 If the prefix LEVEL is non-nil, it should be a number that says which
4412 level to cut off listing groups.
4413 If LOWEST, don't list groups with level lower than LOWEST.
4415 This command may read the active file."
4418 (setq level (prefix-numeric-value level)))
4419 (when (or (not level) (>= level gnus-level-zombie))
4421 (funcall gnus-group-prepare-function
4422 (or level gnus-level-subscribed)
4424 (let ((marks (gnus-info-marks info)))
4425 (assq 'cache marks)))
4428 (or (gnus-gethash group
4429 gnus-cache-active-hashtb)
4430 ;; Cache active file might use "."
4433 (mapconcat 'identity
4434 (split-string group ":")
4436 gnus-cache-active-hashtb))))
4437 (goto-char (point-min))
4438 (gnus-group-position-point))
4440 (defun gnus-group-list-dormant (level &optional lowest)
4441 "List all groups with dormant articles.
4442 If the prefix LEVEL is non-nil, it should be a number that says which
4443 level to cut off listing groups.
4444 If LOWEST, don't list groups with level lower than LOWEST.
4446 This command may read the active file."
4449 (setq level (prefix-numeric-value level)))
4450 (when (or (not level) (>= level gnus-level-zombie))
4452 (funcall gnus-group-prepare-function
4453 (or level gnus-level-subscribed)
4455 (let ((marks (gnus-info-marks info)))
4456 (assq 'dormant marks)))
4459 (goto-char (point-min))
4460 (gnus-group-position-point))
4462 (defun gnus-group-listed-groups ()
4463 "Return a list of listed groups."
4465 (goto-char (point-min))
4466 (while (setq point (text-property-not-all (point) (point-max)
4469 (push (symbol-name (get-text-property point 'gnus-group)) groups)
4473 (defun gnus-group-list-plus (&optional args)
4474 "List groups plus the current selection."
4476 (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4477 (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4479 (push last-command-event unread-command-events)
4480 (if (featurep 'xemacs)
4481 (push (make-event 'key-press '(key ?A)) unread-command-events)
4482 (push ?A unread-command-events))
4483 (let (gnus-pick-mode keys)
4484 (setq keys (if (featurep 'xemacs)
4485 (events-to-keys (read-key-sequence nil))
4486 (read-key-sequence nil)))
4487 (setq func (lookup-key (current-local-map) keys)))
4491 (call-interactively func))))
4493 (defun gnus-group-list-flush (&optional args)
4494 "Flush groups from the current selection."
4496 (let ((gnus-group-list-option 'flush))
4497 (gnus-group-list-plus args)))
4499 (defun gnus-group-list-limit (&optional args)
4500 "List groups limited within the current selection."
4502 (let ((gnus-group-list-option 'limit))
4503 (gnus-group-list-plus args)))
4505 (defun gnus-group-mark-article-read (group article)
4506 "Mark ARTICLE read."
4507 (let ((buffer (gnus-summary-buffer-name group))
4508 (mark gnus-read-mark)
4510 (if (get-buffer buffer)
4511 (with-current-buffer buffer
4512 (setq active gnus-newsgroup-active)
4513 (gnus-activate-group group)
4514 (when gnus-newsgroup-prepared
4515 (when (and gnus-newsgroup-auto-expire
4516 (memq mark gnus-auto-expirable-marks))
4517 (setq mark gnus-expirable-mark))
4518 (setq mark (gnus-request-update-mark
4519 group article mark))
4520 (gnus-mark-article-as-read article mark)
4521 (setq gnus-newsgroup-active (gnus-active group))
4523 (setq n (1+ (cdr active)))
4524 (while (<= n (cdr gnus-newsgroup-active))
4525 (unless (eq n article)
4526 (push n gnus-newsgroup-unselected))
4528 (setq gnus-newsgroup-unselected
4529 (nreverse gnus-newsgroup-unselected)))))
4530 (gnus-activate-group group)
4531 (gnus-group-make-articles-read group (list article))
4532 (when (gnus-group-auto-expirable-p group)
4533 (gnus-add-marked-articles
4534 group 'expire (list article))))))
4538 ;;; Group compaction. -- dvl
4541 (defun gnus-group-compact-group (group)
4542 "Compact the current group.
4543 Compaction means removing gaps between article numbers. Hence, this
4544 operation is only meaningful for back ends using one file per article
4547 Note: currently only implemented in nnml."
4548 (interactive (list (gnus-group-group-name)))
4550 (error "No group to compact"))
4551 (unless (gnus-check-backend-function 'request-compact-group group)
4552 (error "This back end does not support group compaction"))
4553 (let ((group-decoded (gnus-group-decoded-name group)))
4555 Compacting group %s... (this may take a long time)"
4558 (if (not (gnus-request-compact-group group))
4559 (gnus-error 3 "Couldn't compact group %s" group-decoded)
4560 (gnus-message 6 "Compacting group %s...done" group-decoded)
4562 ;; Invalidate the "original article" buffer which might be out of date.
4563 ;; #### NOTE: Yes, this might be a bit rude, but since compaction
4564 ;; #### will not happen very often, I think this is acceptable.
4565 (let ((original (get-buffer gnus-original-article-buffer)))
4566 (and original (gnus-kill-buffer original)))
4567 ;; Update the group line to reflect new information (art number etc).
4568 (gnus-group-update-group-line))))
4570 (provide 'gnus-group)
4572 ;;; arch-tag: 2eb5440f-0bca-4091-814c-e37817536af6
4573 ;;; gnus-group.el ends here