mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00
Code Issues Releases Activity
83595c0c40
emacs/lisp/gnus/gnus-group.el
Dave Love 84b9b23e01 (gnus-group-make-menu-bar): Add some :help 
strings.
(gnus-group-make-tool-bar): New function.
(gnus-group-mode): Use it.
2000-10-27 17:13:45 +00:00

3813 lines
134 KiB
EmacsLisp
Raw Blame History

;;; gnus-group.el --- group mode commands for Gnus
;; Copyright (C) 1996, 1997, 1998, 1999, 2000
;; Free Software Foundation, Inc.
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: news
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;;; Code:
(eval-when-compile (require 'cl))
(require 'gnus)
(require 'gnus-start)
(require 'nnmail)
(require 'gnus-spec)
(require 'gnus-int)
(require 'gnus-range)
(require 'gnus-win)
(require 'gnus-undo)
(require 'time-date)
(defcustom gnus-group-archive-directory
"*ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
"*The address of the (ding) archives."
:group 'gnus-group-foreign
:type 'directory)
(defcustom gnus-group-recent-archive-directory
"*ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list-recent/"
"*The address of the most recent (ding) articles."
:group 'gnus-group-foreign
:type 'directory)
(defcustom gnus-no-groups-message "No gnus is bad news"
"*Message displayed by Gnus when no groups are available."
:group 'gnus-start
:type 'string)
(defcustom gnus-keep-same-level nil
"*Non-nil means that the next newsgroup after the current will be on the same level.
When you type, for instance, `n' after reading the last article in the
current newsgroup, you will go to the next newsgroup. If this variable
is nil, the next newsgroup will be the next from the group
buffer.
If this variable is non-nil, Gnus will either put you in the
next newsgroup with the same level, or, if no such newsgroup is
available, the next newsgroup with the lowest possible level higher
than the current level.
If this variable is `best', Gnus will make the next newsgroup the one
with the best level."
:group 'gnus-group-levels
:type '(choice (const nil)
(const best)
(sexp :tag "other" t)))
(defcustom gnus-group-goto-unread t
"*If non-nil, movement commands will go to the next unread and subscribed group."
:link '(custom-manual "(gnus)Group Maneuvering")
:group 'gnus-group-various
:type 'boolean)
(defcustom gnus-goto-next-group-when-activating t
"*If non-nil, the \\<gnus-group-mode-map>\\[gnus-group-get-new-news-this-group] command will advance point to the next group."
:link '(custom-manual "(gnus)Scanning New Messages")
:group 'gnus-group-various
:type 'boolean)
(defcustom gnus-permanently-visible-groups nil
"*Regexp to match groups that should always be listed in the group buffer.
This means that they will still be listed even when there are no
unread articles in the groups.
If nil, no groups are permanently visible."
:group 'gnus-group-listing
:type '(choice regexp (const nil)))
(defcustom gnus-list-groups-with-ticked-articles t
"*If non-nil, list groups that have only ticked articles.
If nil, only list groups that have unread articles."
:group 'gnus-group-listing
:type 'boolean)
(defcustom gnus-group-default-list-level gnus-level-subscribed
"*Default listing level.
Ignored if `gnus-group-use-permanent-levels' is non-nil."
:group 'gnus-group-listing
:type 'integer)
(defcustom gnus-group-list-inactive-groups t
"*If non-nil, inactive groups will be listed."
:group 'gnus-group-listing
:group 'gnus-group-levels
:type 'boolean)
(defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
"*Function used for sorting the group buffer.
This function will be called with group info entries as the arguments
for the groups to be sorted. Pre-made functions include
`gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
`gnus-group-sort-by-unread', `gnus-group-sort-by-level',
`gnus-group-sort-by-score', `gnus-group-sort-by-method', and
`gnus-group-sort-by-rank'.
This variable can also be a list of sorting functions. In that case,
the most significant sort function should be the last function in the
list."
:group 'gnus-group-listing
:link '(custom-manual "(gnus)Sorting Groups")
:type '(radio (function-item gnus-group-sort-by-alphabet)
(function-item gnus-group-sort-by-real-name)
(function-item gnus-group-sort-by-unread)
(function-item gnus-group-sort-by-level)
(function-item gnus-group-sort-by-score)
(function-item gnus-group-sort-by-method)
(function-item gnus-group-sort-by-rank)
(function :tag "other" nil)))
(defcustom gnus-group-line-format "%M\%S\%p\%P\%5y: %(%g%)%l\n"
"*Format of group lines.
It works along the same lines as a normal formatting string,
with some simple extensions.
%M Only marked articles (character, \"*\" or \" \")
%S Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
%L Level of subscribedness (integer)
%N Number of unread articles (integer)
%I Number of dormant articles (integer)
%i Number of ticked and dormant (integer)
%T Number of ticked articles (integer)
%R Number of read articles (integer)
%t Estimated total number of articles (integer)
%y Number of unread, unticked articles (integer)
%G Group name (string)
%g Qualified group name (string)
%D Group description (string)
%s Select method (string)
%o Moderated group (char, \"m\")
%p Process mark (char)
%O Moderated group (string, \"(m)\" or \"\")
%P Topic indentation (string)
%m Whether there is new(ish) mail in the group (char, \"%\")
%l Whether there are GroupLens predictions for this group (string)
%n Select from where (string)
%z A string that look like `<%s:%n>' if a foreign select method is used
%d The date the group was last entered.
%E Icon as defined by `gnus-group-icon-list'.
%u User defined specifier. The next character in the format string should
be a letter. Gnus will call the function gnus-user-format-function-X,
where X is the letter following %u. The function will be passed the
current header as argument. The function should return a string, which
will be inserted into the buffer just like information from any other
group specifier.
Text between %( and %) will be highlighted with `gnus-mouse-face' when
the mouse point move inside the area. There can only be one such area.
Note that this format specification is not always respected. For
reasons of efficiency, when listing killed groups, this specification
is ignored altogether. If the spec is changed considerably, your
output may end up looking strange when listing both alive and killed
groups.
If you use %o or %O, reading the active file will be slower and quite
a bit of extra memory will be used. %D will also worsen performance.
Also note that if you change the format specification to include any
of these specs, you must probably re-start Gnus to see them go into
effect."
:group 'gnus-group-visual
:type 'string)
(defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
"*The format specification for the group mode line.
It works along the same lines as a normal formatting string,
with some simple extensions:
%S The native news server.
%M The native select method.
%: \":\" if %S isn't \"\"."
:group 'gnus-group-visual
:type 'string)
(defcustom gnus-group-mode-hook nil
"Hook for Gnus group mode."
:group 'gnus-group-various
:options '(gnus-topic-mode)
:type 'hook)
(defcustom gnus-group-menu-hook nil
"Hook run after the creation of the group mode menu."
:group 'gnus-group-various
:type 'hook)
(defcustom gnus-group-catchup-group-hook nil
"Hook run when catching up a group from the group buffer."
:group 'gnus-group-various
:link '(custom-manual "(gnus)Group Data")
:type 'hook)
(defcustom gnus-group-update-group-hook nil
"Hook called when updating group lines."
:group 'gnus-group-visual
:type 'hook)
(defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
"*A function that is called to generate the group buffer.
The function is called with three arguments: The first is a number;
all group with a level less or equal to that number should be listed,
if the second is non-nil, empty groups should also be displayed. If
the third is non-nil, it is a number. No groups with a level lower
than this number should be displayed.
The only current function implemented is `gnus-group-prepare-flat'."
:group 'gnus-group-listing
:type 'function)
(defcustom gnus-group-prepare-hook nil
"Hook called after the group buffer has been generated.
If you want to modify the group buffer, you can use this hook."
:group 'gnus-group-listing
:type 'hook)
(defcustom gnus-suspend-gnus-hook nil
"Hook called when suspending (not exiting) Gnus."
:group 'gnus-exit
:type 'hook)
(defcustom gnus-exit-gnus-hook nil
"Hook called when exiting Gnus."
:group 'gnus-exit
:type 'hook)
(defcustom gnus-after-exiting-gnus-hook nil
"Hook called after exiting Gnus."
:group 'gnus-exit
:type 'hook)
(defcustom gnus-group-update-hook '(gnus-group-highlight-line)
"Hook called when a group line is changed.
The hook will not be called if `gnus-visual' is nil.
The default function `gnus-group-highlight-line' will
highlight the line according to the `gnus-group-highlight'
variable."
:group 'gnus-group-visual
:type 'hook)
(defcustom gnus-useful-groups
'(("(ding) mailing list mirrored at sunsite.auc.dk"
"emacs.ding"
(nntp "sunsite.auc.dk"
(nntp-address "sunsite.auc.dk")))
("gnus-bug archive"
"gnus-bug"
(nndir "/ftp@ftp.ifi.uio.no:/pub/emacs/gnus/gnus-bug/"))
("Gnus help group"
"gnus-help"
(nndoc "gnus-help"
(nndoc-article-type mbox)
(eval `(nndoc-address
,(let ((file (nnheader-find-etc-directory
"gnus-tut.txt" t)))
(unless file
(error "Couldn't find doc group"))
file))))))
"*Alist of useful group-server pairs."
:group 'gnus-group-listing
:type '(repeat (list (string :tag "Description")
(string :tag "Name")
(sexp :tag "Method"))))
(defcustom gnus-group-highlight
'(;; News.
((and (= unread 0) (not mailp) (eq level 1)) .
gnus-group-news-1-empty-face)
((and (not mailp) (eq level 1)) .
gnus-group-news-1-face)
((and (= unread 0) (not mailp) (eq level 2)) .
gnus-group-news-2-empty-face)
((and (not mailp) (eq level 2)) .
gnus-group-news-2-face)
((and (= unread 0) (not mailp) (eq level 3)) .
gnus-group-news-3-empty-face)
((and (not mailp) (eq level 3)) .
gnus-group-news-3-face)
((and (= unread 0) (not mailp) (eq level 4)) .
gnus-group-news-4-empty-face)
((and (not mailp) (eq level 4)) .
gnus-group-news-4-face)
((and (= unread 0) (not mailp) (eq level 5)) .
gnus-group-news-5-empty-face)
((and (not mailp) (eq level 5)) .
gnus-group-news-5-face)
((and (= unread 0) (not mailp) (eq level 6)) .
gnus-group-news-6-empty-face)
((and (not mailp) (eq level 6)) .
gnus-group-news-6-face)
((and (= unread 0) (not mailp)) .
gnus-group-news-low-empty-face)
((and (not mailp)) .
gnus-group-news-low-face)
;; Mail.
((and (= unread 0) (eq level 1)) .
gnus-group-mail-1-empty-face)
((eq level 1) .
gnus-group-mail-1-face)
((and (= unread 0) (eq level 2)) .
gnus-group-mail-2-empty-face)
((eq level 2) .
gnus-group-mail-2-face)
((and (= unread 0) (eq level 3)) .
gnus-group-mail-3-empty-face)
((eq level 3) .
gnus-group-mail-3-face)
((= unread 0) .
gnus-group-mail-low-empty-face)
(t .
gnus-group-mail-low-face))
"*Controls the highlighting of group buffer lines.
Below is a list of `Form'/`Face' pairs. When deciding how a a
particular group line should be displayed, each form is
evaluated. The content of the face field after the first true form is
used. You can change how those group lines are displayed by
editing the face field.
It is also possible to change and add form fields, but currently that
requires an understanding of Lisp expressions. Hopefully this will
change in a future release. For now, you can use the following
variables in the Lisp expression:
group: The name of the group.
unread: The number of unread articles in the group.
method: The select method used.
mailp: Whether it's a mail group or not.
level: The level of the group.
score: The score of the group.
ticked: The number of ticked articles."
:group 'gnus-group-visual
:type '(repeat (cons (sexp :tag "Form") face)))
(defcustom gnus-new-mail-mark ?%
"Mark used for groups with new mail."
:group 'gnus-group-visual
:type 'character)
(defgroup gnus-group-icons nil
"Add Icons to your group buffer. "
:group 'gnus-group-visual)
(defcustom gnus-group-icon-list
nil
"*Controls the insertion of icons into group buffer lines.
Below is a list of `Form'/`File' pairs. When deciding how a
particular group line should be displayed, each form is evaluated.
The icon from the file field after the first true form is used. You
can change how those group lines are displayed by editing the file
field. The File will either be found in the
`gnus-group-glyph-directory' or by designating absolute path to the
file.
It is also possible to change and add form fields, but currently that
requires an understanding of Lisp expressions. Hopefully this will
change in a future release. For now, you can use the following
variables in the Lisp expression:
group: The name of the group.
unread: The number of unread articles in the group.
method: The select method used.
mailp: Whether it's a mail group or not.
newsp: Whether it's a news group or not
level: The level of the group.
score: The score of the group.
ticked: The number of ticked articles."
:group 'gnus-group-icons
:type '(repeat (cons (sexp :tag "Form") file)))
(defcustom gnus-group-name-charset-method-alist nil
"*Alist of method and the charset for group names.
For example:
(((nntp \"news.com.cn\") . cn-gb-2312))
"
:group 'gnus-charset
:type '(repeat (cons (sexp :tag "Method") (symbol :tag "Charset"))))
(defcustom gnus-group-name-charset-group-alist nil
"*Alist of group regexp and the charset for group names.
For example:
((\"\\.com\\.cn:\" . cn-gb-2312))
"
:group 'gnus-charset
:type '(repeat (cons (regexp :tag "Group") (symbol :tag "Charset"))))
;;; Internal variables
(defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
"Function for sorting the group buffer.")
(defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
"Function for sorting the selected groups in the group buffer.")
(defvar gnus-group-indentation-function nil)
(defvar gnus-goto-missing-group-function nil)
(defvar gnus-group-update-group-function nil)
(defvar gnus-group-goto-next-group-function nil
"Function to override finding the next group after listing groups.")
(defvar gnus-group-edit-buffer nil)
(defvar gnus-group-line-format-alist
`((?M gnus-tmp-marked-mark ?c)
(?S gnus-tmp-subscribed ?c)
(?L gnus-tmp-level ?d)
(?N (cond ((eq number t) "*" )
((numberp number)
(int-to-string
(+ number
(gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
(gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
(t number)) ?s)
(?R gnus-tmp-number-of-read ?s)
(?t gnus-tmp-number-total ?d)
(?y gnus-tmp-number-of-unread ?s)
(?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
(?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
(?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
(gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
(?g gnus-tmp-group ?s)
(?G gnus-tmp-qualified-group ?s)
(?c (gnus-short-group-name gnus-tmp-group) ?s)
(?D gnus-tmp-newsgroup-description ?s)
(?o gnus-tmp-moderated ?c)
(?O gnus-tmp-moderated-string ?s)
(?p gnus-tmp-process-marked ?c)
(?s gnus-tmp-news-server ?s)
(?n gnus-tmp-news-method ?s)
(?P gnus-group-indentation ?s)
(?E gnus-tmp-group-icon ?s)
(?l gnus-tmp-grouplens ?s)
(?z gnus-tmp-news-method-string ?s)
(?m (gnus-group-new-mail gnus-tmp-group) ?c)
(?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
(?u gnus-tmp-user-defined ?s)))
(defvar gnus-group-mode-line-format-alist
`((?S gnus-tmp-news-server ?s)
(?M gnus-tmp-news-method ?s)
(?u gnus-tmp-user-defined ?s)
(?: gnus-tmp-colon ?s)))
(defvar gnus-topic-topology nil
"The complete topic hierarchy.")
(defvar gnus-topic-alist nil
"The complete topic-group alist.")
(defvar gnus-group-marked nil)
(defvar gnus-group-list-mode nil)
(defvar gnus-group-icon-cache nil)
;;;
;;; Gnus group mode
;;;
(put 'gnus-group-mode 'mode-class 'special)
(when t
(gnus-define-keys gnus-group-mode-map
" " gnus-group-read-group
"=" gnus-group-select-group
"\r" gnus-group-select-group
"\M-\r" gnus-group-quick-select-group
"\M- " gnus-group-visible-select-group
[(meta control return)] gnus-group-select-group-ephemerally
"j" gnus-group-jump-to-group
"n" gnus-group-next-unread-group
"p" gnus-group-prev-unread-group
"\177" gnus-group-prev-unread-group
[delete] gnus-group-prev-unread-group
[backspace] gnus-group-prev-unread-group
"N" gnus-group-next-group
"P" gnus-group-prev-group
"\M-n" gnus-group-next-unread-group-same-level
"\M-p" gnus-group-prev-unread-group-same-level
"," gnus-group-best-unread-group
"." gnus-group-first-unread-group
"u" gnus-group-unsubscribe-current-group
"U" gnus-group-unsubscribe-group
"c" gnus-group-catchup-current
"C" gnus-group-catchup-current-all
"\M-c" gnus-group-clear-data
"l" gnus-group-list-groups
"L" gnus-group-list-all-groups
"m" gnus-group-mail
"g" gnus-group-get-new-news
"\M-g" gnus-group-get-new-news-this-group
"R" gnus-group-restart
"r" gnus-group-read-init-file
"B" gnus-group-browse-foreign-server
"b" gnus-group-check-bogus-groups
"F" gnus-group-find-new-groups
"\C-c\C-d" gnus-group-describe-group
"\M-d" gnus-group-describe-all-groups
"\C-c\C-a" gnus-group-apropos
"\C-c\M-\C-a" gnus-group-description-apropos
"a" gnus-group-post-news
"\ek" gnus-group-edit-local-kill
"\eK" gnus-group-edit-global-kill
"\C-k" gnus-group-kill-group
"\C-y" gnus-group-yank-group
"\C-w" gnus-group-kill-region
"\C-x\C-t" gnus-group-transpose-groups
"\C-c\C-l" gnus-group-list-killed
"\C-c\C-x" gnus-group-expire-articles
"\C-c\M-\C-x" gnus-group-expire-all-groups
"V" gnus-version
"s" gnus-group-save-newsrc
"z" gnus-group-suspend
"q" gnus-group-exit
"Q" gnus-group-quit
"?" gnus-group-describe-briefly
"\C-c\C-i" gnus-info-find-node
"\M-e" gnus-group-edit-group-method
"^" gnus-group-enter-server-mode
gnus-mouse-2 gnus-mouse-pick-group
"<" beginning-of-buffer
">" end-of-buffer
"\C-c\C-b" gnus-bug
"\C-c\C-s" gnus-group-sort-groups
"t" gnus-topic-mode
"\C-c\M-g" gnus-activate-all-groups
"\M-&" gnus-group-universal-argument
"#" gnus-group-mark-group
"\M-#" gnus-group-unmark-group)
(gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
"m" gnus-group-mark-group
"u" gnus-group-unmark-group
"w" gnus-group-mark-region
"b" gnus-group-mark-buffer
"r" gnus-group-mark-regexp
"U" gnus-group-unmark-all-groups)
(gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
"d" gnus-group-make-directory-group
"h" gnus-group-make-help-group
"u" gnus-group-make-useful-group
"a" gnus-group-make-archive-group
"k" gnus-group-make-kiboze-group
"l" gnus-group-nnimap-edit-acl
"m" gnus-group-make-group
"E" gnus-group-edit-group
"e" gnus-group-edit-group-method
"p" gnus-group-edit-group-parameters
"v" gnus-group-add-to-virtual
"V" gnus-group-make-empty-virtual
"D" gnus-group-enter-directory
"f" gnus-group-make-doc-group
"w" gnus-group-make-web-group
"r" gnus-group-rename-group
"c" gnus-group-customize
"x" gnus-group-nnimap-expunge
"\177" gnus-group-delete-group
[delete] gnus-group-delete-group)
(gnus-define-keys (gnus-group-soup-map "s" gnus-group-group-map)
"b" gnus-group-brew-soup
"w" gnus-soup-save-areas
"s" gnus-soup-send-replies
"p" gnus-soup-pack-packet
"r" nnsoup-pack-replies)
(gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
"s" gnus-group-sort-groups
"a" gnus-group-sort-groups-by-alphabet
"u" gnus-group-sort-groups-by-unread
"l" gnus-group-sort-groups-by-level
"v" gnus-group-sort-groups-by-score
"r" gnus-group-sort-groups-by-rank
"m" gnus-group-sort-groups-by-method)
(gnus-define-keys (gnus-group-sort-selected-map "P" gnus-group-group-map)
"s" gnus-group-sort-selected-groups
"a" gnus-group-sort-selected-groups-by-alphabet
"u" gnus-group-sort-selected-groups-by-unread
"l" gnus-group-sort-selected-groups-by-level
"v" gnus-group-sort-selected-groups-by-score
"r" gnus-group-sort-selected-groups-by-rank
"m" gnus-group-sort-selected-groups-by-method)
(gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
"k" gnus-group-list-killed
"z" gnus-group-list-zombies
"s" gnus-group-list-groups
"u" gnus-group-list-all-groups
"A" gnus-group-list-active
"a" gnus-group-apropos
"d" gnus-group-description-apropos
"m" gnus-group-list-matching
"M" gnus-group-list-all-matching
"l" gnus-group-list-level
"c" gnus-group-list-cached
"?" gnus-group-list-dormant)
(gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
"f" gnus-score-flush-cache)
(gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
"d" gnus-group-describe-group
"f" gnus-group-fetch-faq
"v" gnus-version)
(gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
"l" gnus-group-set-current-level
"t" gnus-group-unsubscribe-current-group
"s" gnus-group-unsubscribe-group
"k" gnus-group-kill-group
"y" gnus-group-yank-group
"w" gnus-group-kill-region
"\C-k" gnus-group-kill-level
"z" gnus-group-kill-all-zombies))
(defun gnus-group-make-menu-bar ()
(gnus-turn-off-edit-menu 'group)
(unless (boundp 'gnus-group-reading-menu)
(easy-menu-define
gnus-group-reading-menu gnus-group-mode-map ""
'("Group"
["Read" gnus-group-read-group (gnus-group-group-name)]
["Select" gnus-group-select-group (gnus-group-group-name)]
["See old articles" (gnus-group-select-group 'all)
:keys "C-u SPC" :active (gnus-group-group-name)]
["Catch up" gnus-group-catchup-current :active (gnus-group-group-name)
:help "Mark unread articles in the current group as read"]
["Catch up all articles" gnus-group-catchup-current-all
(gnus-group-group-name)]
["Check for new articles" gnus-group-get-new-news-this-group
:active (gnus-group-group-name)
:help "Check for new messages in current group"]
["Toggle subscription" gnus-group-unsubscribe-current-group
(gnus-group-group-name)]
["Kill" gnus-group-kill-group :active (gnus-group-group-name)
:help "Kill (remove) current group"]
["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
["Describe" gnus-group-describe-group :active (gnus-group-group-name)
:help "Display description of the current group"]
["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
;; Actually one should check, if any of the marked groups gives t for
;; (gnus-check-backend-function 'request-expire-articles ...)
["Expire articles" gnus-group-expire-articles
(or (and (gnus-group-group-name)
(gnus-check-backend-function
'request-expire-articles
(gnus-group-group-name))) gnus-group-marked)]
["Set group level" gnus-group-set-current-level
(gnus-group-group-name)]
["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
["Customize" gnus-group-customize (gnus-group-group-name)]
("Edit"
["Parameters" gnus-group-edit-group-parameters
(gnus-group-group-name)]
["Select method" gnus-group-edit-group-method
(gnus-group-group-name)]
["Info" gnus-group-edit-group (gnus-group-group-name)]
["Local kill file" gnus-group-edit-local-kill (gnus-group-group-name)]
["Global kill file" gnus-group-edit-global-kill t])))
(easy-menu-define
gnus-group-group-menu gnus-group-mode-map ""
'("Groups"
("Listing"
["List unread subscribed groups" gnus-group-list-groups t]
["List (un)subscribed groups" gnus-group-list-all-groups t]
["List killed groups" gnus-group-list-killed gnus-killed-list]
["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
["List level..." gnus-group-list-level t]
["Describe all groups" gnus-group-describe-all-groups t]
["Group apropos..." gnus-group-apropos t]
["Group and description apropos..." gnus-group-description-apropos t]
["List groups matching..." gnus-group-list-matching t]
["List all groups matching..." gnus-group-list-all-matching t]
["List active file" gnus-group-list-active t]
["List groups with cached" gnus-group-list-cached t]
["List groups with dormant" gnus-group-list-dormant t])
("Sort"
["Default sort" gnus-group-sort-groups t]
["Sort by method" gnus-group-sort-groups-by-method t]
["Sort by rank" gnus-group-sort-groups-by-rank t]
["Sort by score" gnus-group-sort-groups-by-score t]
["Sort by level" gnus-group-sort-groups-by-level t]
["Sort by unread" gnus-group-sort-groups-by-unread t]
["Sort by name" gnus-group-sort-groups-by-alphabet t])
("Sort process/prefixed"
["Default sort" gnus-group-sort-selected-groups
(or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
["Sort by method" gnus-group-sort-selected-groups-by-method
(or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
["Sort by rank" gnus-group-sort-selected-groups-by-rank
(or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
["Sort by score" gnus-group-sort-selected-groups-by-score
(or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
["Sort by level" gnus-group-sort-selected-groups-by-level
(or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
["Sort by unread" gnus-group-sort-selected-groups-by-unread
(or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
["Sort by name" gnus-group-sort-selected-groups-by-alphabet
(or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))])
("Mark"
["Mark group" gnus-group-mark-group
(and (gnus-group-group-name)
(not (memq (gnus-group-group-name) gnus-group-marked)))]
["Unmark group" gnus-group-unmark-group
(and (gnus-group-group-name)
(memq (gnus-group-group-name) gnus-group-marked))]
["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
["Mark regexp..." gnus-group-mark-regexp t]
["Mark region" gnus-group-mark-region t]
["Mark buffer" gnus-group-mark-buffer t]
["Execute command" gnus-group-universal-argument
(or gnus-group-marked (gnus-group-group-name))])
("Subscribe"
["Subscribe to a group" gnus-group-unsubscribe-group t]
["Kill all newsgroups in region" gnus-group-kill-region t]
["Kill all zombie groups" gnus-group-kill-all-zombies
gnus-zombie-list]
["Kill all groups on level..." gnus-group-kill-level t])
("Foreign groups"
["Make a foreign group" gnus-group-make-group t]
["Add a directory group" gnus-group-make-directory-group t]
["Add the help group" gnus-group-make-help-group t]
["Add the archive group" gnus-group-make-archive-group t]
["Make a doc group" gnus-group-make-doc-group t]
["Make a web group" gnus-group-make-web-group t]
["Make a kiboze group" gnus-group-make-kiboze-group t]
["Make a virtual group" gnus-group-make-empty-virtual t]
["Add a group to a virtual" gnus-group-add-to-virtual t]
["Rename group" gnus-group-rename-group
(gnus-check-backend-function
'request-rename-group (gnus-group-group-name))]
["Delete group" gnus-group-delete-group
(gnus-check-backend-function
'request-delete-group (gnus-group-group-name))])
("Move"
["Next" gnus-group-next-group t]
["Previous" gnus-group-prev-group t]
["Next unread" gnus-group-next-unread-group t]
["Previous unread" gnus-group-prev-unread-group t]
["Next unread same level" gnus-group-next-unread-group-same-level t]
["Previous unread same level"
gnus-group-prev-unread-group-same-level t]
["Jump to group" gnus-group-jump-to-group t]
["First unread group" gnus-group-first-unread-group t]
["Best unread group" gnus-group-best-unread-group t])
["Delete bogus groups" gnus-group-check-bogus-groups t]
["Find new newsgroups" gnus-group-find-new-groups t]
["Transpose" gnus-group-transpose-groups
(gnus-group-group-name)]
["Read a directory as a group..." gnus-group-enter-directory t]))
(easy-menu-define
gnus-group-misc-menu gnus-group-mode-map ""
'("Misc"
("SOUP"
["Pack replies" nnsoup-pack-replies (fboundp 'nnsoup-request-group)]
["Send replies" gnus-soup-send-replies
(fboundp 'gnus-soup-pack-packet)]
["Pack packet" gnus-soup-pack-packet (fboundp 'gnus-soup-pack-packet)]
["Save areas" gnus-soup-save-areas (fboundp 'gnus-soup-pack-packet)]
["Brew SOUP" gnus-group-brew-soup (fboundp 'gnus-soup-pack-packet)])
["Send a mail" gnus-group-mail t]
["Post an article..." gnus-group-post-news t]
["Check for new news" gnus-group-get-new-news
:help "Get newly arrived articles"]
["Activate all groups" gnus-activate-all-groups t]
["Restart Gnus" gnus-group-restart t]
["Read init file" gnus-group-read-init-file t]
["Browse foreign server" gnus-group-browse-foreign-server t]
["Enter server buffer" gnus-group-enter-server-mode t]
["Expire all expirable articles" gnus-group-expire-all-groups t]
["Generate any kiboze groups" nnkiboze-generate-groups t]
["Gnus version" gnus-version t]
["Save .newsrc files" gnus-group-save-newsrc t]
["Suspend Gnus" gnus-group-suspend t]
["Clear dribble buffer" gnus-group-clear-dribble t]
["Read manual" gnus-info-find-node t]
["Flush score cache" gnus-score-flush-cache t]
["Toggle topics" gnus-topic-mode t]
["Send a bug report" gnus-bug t]
["Exit from Gnus" gnus-group-exit
:help "Quit reading news"]
["Exit without saving" gnus-group-quit t]))
(gnus-run-hooks 'gnus-group-menu-hook)))
(defun gnus-group-make-tool-bar ()
(when (and (fboundp 'tool-bar-add-item-from-menu)
(default-value 'tool-bar-mode)
(not (lookup-key gnus-group-mode-map [tool-bar])))
(let ((tool-bar-map (make-sparse-keymap)))
(tool-bar-add-item-from-menu
'gnus-group-get-new-news "get-news" gnus-group-mode-map)
(tool-bar-add-item-from-menu
'gnus-group-get-new-news-this-group "gnntg" gnus-group-mode-map)
(tool-bar-add-item-from-menu
'gnus-group-catchup-current "catchup" gnus-group-mode-map)
(tool-bar-add-item-from-menu
'gnus-group-describe-group "describe-group" gnus-group-mode-map)
(tool-bar-add-item "subscribe" 'gnus-group-subscribe 'subscribe
:help "Subscribe to the current group")
(tool-bar-add-item "unsubscribe" 'gnus-group-unsubscribe 'unsubscribe
:help "Unsubscribe from the current group")
(tool-bar-add-item-from-menu
'gnus-group-exit "exit-gnus" gnus-group-mode-map)
(define-key gnus-group-mode-map [tool-bar] tool-bar-map))))
(defun gnus-group-mode ()
"Major mode for reading news.
All normal editing commands are switched off.
\\<gnus-group-mode-map>
The group buffer lists (some of) the groups available. For instance,
`\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
lists all zombie groups.
Groups that are displayed can be entered with `\\[gnus-group-read-group]'. To subscribe
to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
The following commands are available:
\\{gnus-group-mode-map}"
(interactive)
(when (gnus-visual-p 'group-menu 'menu)
(gnus-group-make-menu-bar)
(gnus-group-make-tool-bar))
(kill-all-local-variables)
(gnus-simplify-mode-line)
(setq major-mode 'gnus-group-mode)
(setq mode-name "Group")
(gnus-group-set-mode-line)
(setq mode-line-process nil)
(use-local-map gnus-group-mode-map)
(buffer-disable-undo)
(setq truncate-lines t)
(setq buffer-read-only t)
(gnus-set-default-directory)
(gnus-update-format-specifications nil 'group 'group-mode)
(gnus-update-group-mark-positions)
(when gnus-use-undo
(gnus-undo-mode 1))
(when gnus-slave
(gnus-slave-mode))
(gnus-run-hooks 'gnus-group-mode-hook))
(defun gnus-update-group-mark-positions ()
(save-excursion
(let ((gnus-process-mark ?\200)
(gnus-group-marked '("dummy.group"))
(gnus-active-hashtb (make-vector 10 0))
(topic ""))
(gnus-set-active "dummy.group" '(0 . 0))
(gnus-set-work-buffer)
(gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
(goto-char (point-min))
(setq gnus-group-mark-positions
(list (cons 'process (and (search-forward "\200" nil t)
(- (point) 2))))))))
(defun gnus-mouse-pick-group (e)
"Enter the group under the mouse pointer."
(interactive "e")
(mouse-set-point e)
(gnus-group-read-group nil))
;; Look at LEVEL and find out what the level is really supposed to be.
;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
;; will depend on whether `gnus-group-use-permanent-levels' is used.
(defun gnus-group-default-level (&optional level number-or-nil)
(cond
(gnus-group-use-permanent-levels
(or (setq gnus-group-use-permanent-levels
(or level (if (numberp gnus-group-use-permanent-levels)
gnus-group-use-permanent-levels
(or gnus-group-default-list-level
gnus-level-subscribed))))
gnus-group-default-list-level gnus-level-subscribed))
(number-or-nil
level)
(t
(or level gnus-group-default-list-level gnus-level-subscribed))))
(defun gnus-group-setup-buffer ()
(set-buffer (gnus-get-buffer-create gnus-group-buffer))
(unless (eq major-mode 'gnus-group-mode)
(gnus-group-mode)
(when gnus-carpal
(gnus-carpal-setup-buffer 'group))))
(defsubst gnus-group-name-charset (method group)
(if (null method)
(setq method (gnus-find-method-for-group group)))
(let ((item (assoc method gnus-group-name-charset-method-alist))
(alist gnus-group-name-charset-group-alist)
result)
(if item
(cdr item)
(while (setq item (pop alist))
(if (string-match (car item) group)
(setq alist nil
result (cdr item))))
result)))
(defsubst gnus-group-name-decode (string charset)
(if (and string charset (featurep 'mule))
(mm-decode-coding-string string charset)
string))
(defun gnus-group-decoded-name (string)
(let ((charset (gnus-group-name-charset nil string)))
(gnus-group-name-decode string charset)))
(defun gnus-group-list-groups (&optional level unread lowest)
"List newsgroups with level LEVEL or lower that have unread articles.
Default is all subscribed groups.
If argument UNREAD is non-nil, groups with no unread articles are also
listed.
Also see the `gnus-group-use-permanent-levels' variable."
(interactive
(list (if current-prefix-arg
(prefix-numeric-value current-prefix-arg)
(or
(gnus-group-default-level nil t)
gnus-group-default-list-level
gnus-level-subscribed))))
(unless level
(setq level (car gnus-group-list-mode)
unread (cdr gnus-group-list-mode)))
(setq level (gnus-group-default-level level))
(gnus-group-setup-buffer)
(gnus-update-format-specifications nil 'group 'group-mode)
(let ((case-fold-search nil)
(props (text-properties-at (gnus-point-at-bol)))
(empty (= (point-min) (point-max)))
(group (gnus-group-group-name))
number)
(set-buffer gnus-group-buffer)
(setq number (funcall gnus-group-prepare-function level unread lowest))
(when (or (and (numberp number)
(zerop number))
(zerop (buffer-size)))
;; No groups in the buffer.
(gnus-message 5 gnus-no-groups-message))
;; We have some groups displayed.
(goto-char (point-max))
(when (or (not gnus-group-goto-next-group-function)
(not (funcall gnus-group-goto-next-group-function
group props)))
(cond
(empty
(goto-char (point-min)))
((not group)
;; Go to the first group with unread articles.
(gnus-group-search-forward t))
(t
;; Find the right group to put point on. If the current group
;; has disappeared in the new listing, try to find the next
;; one. If no next one can be found, just leave point at the
;; first newsgroup in the buffer.
(when (not (gnus-goto-char
(text-property-any
(point-min) (point-max)
'gnus-group (gnus-intern-safe
group gnus-active-hashtb))))
(let ((newsrc (cdddr (gnus-gethash group gnus-newsrc-hashtb))))
(while (and newsrc
(not (gnus-goto-char
(text-property-any
(point-min) (point-max) 'gnus-group
(gnus-intern-safe
(caar newsrc) gnus-active-hashtb)))))
(setq newsrc (cdr newsrc)))
(unless newsrc
(goto-char (point-max))
(forward-line -1)))))))
;; Adjust cursor point.
(gnus-group-position-point)))
(defun gnus-group-list-level (level &optional all)
"List groups on LEVEL.
If ALL (the prefix), also list groups that have no unread articles."
(interactive "nList groups on level: \nP")
(gnus-group-list-groups level all level))
(defun gnus-group-prepare-flat (level &optional all lowest regexp)
"List all newsgroups with unread articles of level LEVEL or lower.
If ALL is non-nil, list groups that have no unread articles.
If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
If REGEXP, only list groups matching REGEXP."
(set-buffer gnus-group-buffer)
(let ((buffer-read-only nil)
(newsrc (cdr gnus-newsrc-alist))
(lowest (or lowest 1))
info clevel unread group params)
(erase-buffer)
(when (< lowest gnus-level-zombie)
;; List living groups.
(while newsrc
(setq info (car newsrc)
group (gnus-info-group info)
params (gnus-info-params info)
newsrc (cdr newsrc)
unread (car (gnus-gethash group gnus-newsrc-hashtb)))
(and unread ; This group might be unchecked
(or (not regexp)
(string-match regexp group))
(<= (setq clevel (gnus-info-level info)) level)
(>= clevel lowest)
(or all ; We list all groups?
(if (eq unread t) ; Unactivated?
gnus-group-list-inactive-groups ; We list unactivated
(> unread 0)) ; We list groups with unread articles
(and gnus-list-groups-with-ticked-articles
(cdr (assq 'tick (gnus-info-marks info))))
; And groups with tickeds
;; Check for permanent visibility.
(and gnus-permanently-visible-groups
(string-match gnus-permanently-visible-groups
group))
(memq 'visible params)
(cdr (assq 'visible params)))
(gnus-group-insert-group-line
group (gnus-info-level info)
(gnus-info-marks info) unread (gnus-info-method info)))))
;; List dead groups.
(and (>= level gnus-level-zombie) (<= lowest gnus-level-zombie)
(gnus-group-prepare-flat-list-dead
(setq gnus-zombie-list (sort gnus-zombie-list 'string<))
gnus-level-zombie ?Z
regexp))
(and (>= level gnus-level-killed) (<= lowest gnus-level-killed)
(gnus-group-prepare-flat-list-dead
(setq gnus-killed-list (sort gnus-killed-list 'string<))
gnus-level-killed ?K regexp))
(gnus-group-set-mode-line)
(setq gnus-group-list-mode (cons level all))
(gnus-run-hooks 'gnus-group-prepare-hook)
t))
(defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
;; List zombies and killed lists somewhat faster, which was
;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>. It does
;; this by ignoring the group format specification altogether.
(let (group)
(if regexp
;; This loop is used when listing groups that match some
;; regexp.
(while groups
(setq group (pop groups))
(when (string-match regexp group)
(gnus-add-text-properties
(point) (prog1 (1+ (point))
(insert " " mark " *: "
(gnus-group-name-decode group
(gnus-group-name-charset
nil group))
"\n"))
(list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
'gnus-unread t
'gnus-level level))))
;; This loop is used when listing all groups.
(while groups
(setq group (pop groups))
(gnus-add-text-properties
(point) (prog1 (1+ (point))
(insert " " mark " *: "
(gnus-group-name-decode group
(gnus-group-name-charset
nil group))
"\n"))
(list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
'gnus-unread t
'gnus-level level))))))
(defun gnus-group-update-group-line ()
"Update the current line in the group buffer."
(let* ((buffer-read-only nil)
(group (gnus-group-group-name))
(entry (and group (gnus-gethash group gnus-newsrc-hashtb)))
gnus-group-indentation)
(when group
(and entry
(not (gnus-ephemeral-group-p group))
(gnus-dribble-enter
(concat "(gnus-group-set-info '"
(gnus-prin1-to-string (nth 2 entry))
")")))
(setq gnus-group-indentation (gnus-group-group-indentation))
(gnus-delete-line)
(gnus-group-insert-group-line-info group)
(forward-line -1)
(gnus-group-position-point))))
(defun gnus-group-insert-group-line-info (group)
"Insert GROUP on the current line."
(let ((entry (gnus-gethash group gnus-newsrc-hashtb))
(gnus-group-indentation (gnus-group-group-indentation))
active info)
(if entry
(progn
;; (Un)subscribed group.
(setq info (nth 2 entry))
(gnus-group-insert-group-line
group (gnus-info-level info) (gnus-info-marks info)
(or (car entry) t) (gnus-info-method info)))
;; This group is dead.
(gnus-group-insert-group-line
group
(if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
nil
(if (setq active (gnus-active group))
(if (zerop (cdr active))
0
(- (1+ (cdr active)) (car active)))
nil)
nil))))
(defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
gnus-tmp-marked number
gnus-tmp-method)
"Insert a group line in the group buffer."
(let* ((gnus-tmp-method
(gnus-server-get-method gnus-tmp-group gnus-tmp-method))
(group-name-charset (gnus-group-name-charset gnus-tmp-method
gnus-tmp-group))
(gnus-tmp-active (gnus-active gnus-tmp-group))
(gnus-tmp-number-total
(if gnus-tmp-active
(1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
0))
(gnus-tmp-number-of-unread
(if (numberp number) (int-to-string (max 0 number))
"*"))
(gnus-tmp-number-of-read
(if (numberp number)
(int-to-string (max 0 (- gnus-tmp-number-total number)))
"*"))
(gnus-tmp-subscribed
(cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
((= gnus-tmp-level gnus-level-zombie) ?Z)
(t ?K)))
(gnus-tmp-qualified-group
(gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
group-name-charset))
(gnus-tmp-newsgroup-description
(if gnus-description-hashtb
(or (gnus-group-name-decode
(gnus-gethash gnus-tmp-group gnus-description-hashtb)
group-name-charset) "")
""))
(gnus-tmp-moderated
(if (and gnus-moderated-hashtb
(gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
?m ? ))
(gnus-tmp-moderated-string
(if (eq gnus-tmp-moderated ?m) "(m)" ""))
(gnus-tmp-group-icon "==&&==")
(gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
(gnus-tmp-news-method (or (car gnus-tmp-method) ""))
(gnus-tmp-news-method-string
(if gnus-tmp-method
(format "(%s:%s)" (car gnus-tmp-method)
(cadr gnus-tmp-method)) ""))
(gnus-tmp-marked-mark
(if (and (numberp number)
(zerop number)
(cdr (assq 'tick gnus-tmp-marked)))
?* ? ))
(gnus-tmp-process-marked
(if (member gnus-tmp-group gnus-group-marked)
gnus-process-mark ? ))
(gnus-tmp-grouplens
(or (and gnus-use-grouplens
(bbb-grouplens-group-p gnus-tmp-group))
""))
(buffer-read-only nil)
header gnus-tmp-header) ; passed as parameter to user-funcs.
(beginning-of-line)
(gnus-add-text-properties
(point)
(prog1 (1+ (point))
;; Insert the text.
(eval gnus-group-line-format-spec))
`(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
gnus-unread ,(if (numberp number)
(string-to-int gnus-tmp-number-of-unread)
t)
gnus-marked ,gnus-tmp-marked-mark
gnus-indentation ,gnus-group-indentation
gnus-level ,gnus-tmp-level))
(forward-line -1)
(when (inline (gnus-visual-p 'group-highlight 'highlight))
(gnus-run-hooks 'gnus-group-update-hook))
(forward-line)
;; Allow XEmacs to remove front-sticky text properties.
(gnus-group-remove-excess-properties)))
(defun gnus-group-highlight-line ()
"Highlight the current line according to `gnus-group-highlight'."
(let* ((list gnus-group-highlight)
(p (point))
(end (progn (end-of-line) (point)))
;; now find out where the line starts and leave point there.
(beg (progn (beginning-of-line) (point)))
(group (gnus-group-group-name))
(entry (gnus-group-entry group))
(unread (if (numberp (car entry)) (car entry) 0))
(active (gnus-active group))
(total (if active (1+ (- (cdr active) (car active))) 0))
(info (nth 2 entry))
(method (gnus-server-get-method group (gnus-info-method info)))
(marked (gnus-info-marks info))
(mailp (memq 'mail (assoc (symbol-name
(car (or method gnus-select-method)))
gnus-valid-select-methods)))
(level (or (gnus-info-level info) gnus-level-killed))
(score (or (gnus-info-score info) 0))
(ticked (gnus-range-length (cdr (assq 'tick marked))))
(group-age (gnus-group-timestamp-delta group))
(inhibit-read-only t))
;; Eval the cars of the lists until we find a match.
(while (and list
(not (eval (caar list))))
(setq list (cdr list)))
(let ((face (cdar list)))
(unless (eq face (get-text-property beg 'face))
(gnus-put-text-property-excluding-characters-with-faces
beg end 'face
(setq face (if (boundp face) (symbol-value face) face)))
(gnus-extent-start-open beg)))
(goto-char p)))
(defun gnus-group-update-group (group &optional visible-only)
"Update all lines where GROUP appear.
If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
already."
;; Can't use `save-excursion' here, so we do it manually.
(let ((buf (current-buffer))
mark)
(set-buffer gnus-group-buffer)
(setq mark (point-marker))
;; The buffer may be narrowed.
(save-restriction
(widen)
(let ((ident (gnus-intern-safe group gnus-active-hashtb))
(loc (point-min))
found buffer-read-only)
;; Enter the current status into the dribble buffer.
(let ((entry (gnus-gethash group gnus-newsrc-hashtb)))
(when (and entry
(not (gnus-ephemeral-group-p group)))
(gnus-dribble-enter
(concat "(gnus-group-set-info '"
(gnus-prin1-to-string (nth 2 entry))
")"))))
;; Find all group instances. If topics are in use, each group
;; may be listed in more than once.
(while (setq loc (text-property-any
loc (point-max) 'gnus-group ident))
(setq found t)
(goto-char loc)
(let ((gnus-group-indentation (gnus-group-group-indentation)))
(gnus-delete-line)
(gnus-group-insert-group-line-info group)
(save-excursion
(forward-line -1)
(gnus-run-hooks 'gnus-group-update-group-hook)))
(setq loc (1+ loc)))
(unless (or found visible-only)
;; No such line in the buffer, find out where it's supposed to
;; go, and insert it there (or at the end of the buffer).
(if gnus-goto-missing-group-function
(funcall gnus-goto-missing-group-function group)
(let ((entry (cddr (gnus-gethash group gnus-newsrc-hashtb))))
(while (and entry (car entry)
(not
(gnus-goto-char
(text-property-any
(point-min) (point-max)
'gnus-group (gnus-intern-safe
(caar entry) gnus-active-hashtb)))))
(setq entry (cdr entry)))
(or entry (goto-char (point-max)))))
;; Finally insert the line.
(let ((gnus-group-indentation (gnus-group-group-indentation)))
(gnus-group-insert-group-line-info group)
(save-excursion
(forward-line -1)
(gnus-run-hooks 'gnus-group-update-group-hook))))
(when gnus-group-update-group-function
(funcall gnus-group-update-group-function group))
(gnus-group-set-mode-line)))
(goto-char mark)
(set-marker mark nil)
(set-buffer buf)))
(defun gnus-group-set-mode-line ()
"Update the mode line in the group buffer."
(when (memq 'group gnus-updated-mode-lines)
;; Yes, we want to keep this mode line updated.
(save-excursion
(set-buffer gnus-group-buffer)
(let* ((gformat (or gnus-group-mode-line-format-spec
(gnus-set-format 'group-mode)))
(gnus-tmp-news-server (cadr gnus-select-method))
(gnus-tmp-news-method (car gnus-select-method))
(gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
(max-len 60)
gnus-tmp-header ;Dummy binding for user-defined formats
;; Get the resulting string.
(modified
(and gnus-dribble-buffer
(buffer-name gnus-dribble-buffer)
(buffer-modified-p gnus-dribble-buffer)
(save-excursion
(set-buffer gnus-dribble-buffer)
(not (zerop (buffer-size))))))
(mode-string (eval gformat)))
;; Say whether the dribble buffer has been modified.
(setq mode-line-modified
(if modified (car gnus-mode-line-modified)
(cdr gnus-mode-line-modified)))
;; If the line is too long, we chop it off.
(when (> (length mode-string) max-len)
(setq mode-string (substring mode-string 0 (- max-len 4))))
(prog1
(setq mode-line-buffer-identification
(gnus-mode-line-buffer-identification
(list mode-string)))
(set-buffer-modified-p modified))))))
(defun gnus-group-group-name ()
"Get the name of the newsgroup on the current line."
(let ((group (get-text-property (gnus-point-at-bol) 'gnus-group)))
(when group
(symbol-name group))))
(defun gnus-group-group-level ()
"Get the level of the newsgroup on the current line."
(get-text-property (gnus-point-at-bol) 'gnus-level))
(defun gnus-group-group-indentation ()
"Get the indentation of the newsgroup on the current line."
(or (get-text-property (gnus-point-at-bol) 'gnus-indentation)
(and gnus-group-indentation-function
(funcall gnus-group-indentation-function))
""))
(defun gnus-group-group-unread ()
"Get the number of unread articles of the newsgroup on the current line."
(get-text-property (gnus-point-at-bol) 'gnus-unread))
(defun gnus-group-new-mail (group)
(if (nnmail-new-mail-p (gnus-group-real-name group))
gnus-new-mail-mark
? ))
(defun gnus-group-level (group)
"Return the estimated level of GROUP."
(or (gnus-info-level (gnus-get-info group))
(and (member group gnus-zombie-list) gnus-level-zombie)
gnus-level-killed))
(defun gnus-group-search-forward (&optional backward all level first-too)
"Find the next newsgroup with unread articles.
If BACKWARD is non-nil, find the previous newsgroup instead.
If ALL is non-nil, just find any newsgroup.
If LEVEL is non-nil, find group with level LEVEL, or higher if no such
group exists.
If FIRST-TOO, the current line is also eligible as a target."
(let ((way (if backward -1 1))
(low gnus-level-killed)
(beg (point))
pos found lev)
(if (and backward (progn (beginning-of-line)) (bobp))
nil
(unless first-too
(forward-line way))
(while (and
(not (eobp))
(not (setq
found
(and
(get-text-property (point) 'gnus-group)
(or all
(and
(let ((unread
(get-text-property (point) 'gnus-unread)))
(and (numberp unread) (> unread 0)))
(setq lev (get-text-property (point)
'gnus-level))
(<= lev gnus-level-subscribed)))
(or (not level)
(and (setq lev (get-text-property (point)
'gnus-level))
(or (= lev level)
(and (< lev low)
(< level lev)
(progn
(setq low lev)
(setq pos (point))
nil))))))))
(zerop (forward-line way)))))
(if found
(progn (gnus-group-position-point) t)
(goto-char (or pos beg))
(and pos t))))
;;; Gnus group mode commands
;; Group marking.
(defun gnus-group-mark-line-p ()
(save-excursion
(beginning-of-line)
(forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
(eq (char-after) gnus-process-mark)))
(defun gnus-group-mark-group (n &optional unmark no-advance)
"Mark the current group."
(interactive "p")
(let ((buffer-read-only nil)
group)
(while (and (> n 0)
(not (eobp)))
(when (setq group (gnus-group-group-name))
;; Go to the mark position.
(beginning-of-line)
(forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
(subst-char-in-region
(point) (1+ (point)) (char-after)
(if unmark
(progn
(setq gnus-group-marked (delete group gnus-group-marked))
? )
(setq gnus-group-marked
(cons group (delete group gnus-group-marked)))
gnus-process-mark)))
(unless no-advance
(gnus-group-next-group 1))
(decf n))
(gnus-summary-position-point)
n))
(defun gnus-group-unmark-group (n)
"Remove the mark from the current group."
(interactive "p")
(gnus-group-mark-group n 'unmark)
(gnus-group-position-point))
(defun gnus-group-unmark-all-groups ()
"Unmark all groups."
(interactive)
(let ((groups gnus-group-marked))
(save-excursion
(while groups
(gnus-group-remove-mark (pop groups)))))
(gnus-group-position-point))
(defun gnus-group-mark-region (unmark beg end)
"Mark all groups between point and mark.
If UNMARK, remove the mark instead."
(interactive "P\nr")
(let ((num (count-lines beg end)))
(save-excursion
(goto-char beg)
(- num (gnus-group-mark-group num unmark)))))
(defun gnus-group-mark-buffer (&optional unmark)
"Mark all groups in the buffer.
If UNMARK, remove the mark instead."
(interactive "P")
(gnus-group-mark-region unmark (point-min) (point-max)))
(defun gnus-group-mark-regexp (regexp)
"Mark all groups that match some regexp."
(interactive "sMark (regexp): ")
(let ((alist (cdr gnus-newsrc-alist))
group)
(while alist
(when (string-match regexp (setq group (gnus-info-group (pop alist))))
(gnus-group-set-mark group))))
(gnus-group-position-point))
(defun gnus-group-remove-mark (group &optional test-marked)
"Remove the process mark from GROUP and move point there.
Return nil if the group isn't displayed."
(if (gnus-group-goto-group group nil test-marked)
(save-excursion
(gnus-group-mark-group 1 'unmark t)
t)
(setq gnus-group-marked
(delete group gnus-group-marked))
nil))
(defun gnus-group-set-mark (group)
"Set the process mark on GROUP."
(if (gnus-group-goto-group group)
(save-excursion
(gnus-group-mark-group 1 nil t))
(setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
(defun gnus-group-universal-argument (arg &optional groups func)
"Perform any command on all groups according to the process/prefix convention."
(interactive "P")
(if (eq (setq func (or func
(key-binding
(read-key-sequence
(substitute-command-keys
"\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
'undefined)
(gnus-error 1 "Undefined key")
(gnus-group-iterate arg
(lambda (group)
(command-execute func))))
(gnus-group-position-point))
(defun gnus-group-process-prefix (n)
"Return a list of groups to work on.
Take into consideration N (the prefix) and the list of marked groups."
(cond
(n
(setq n (prefix-numeric-value n))
;; There is a prefix, so we return a list of the N next
;; groups.
(let ((way (if (< n 0) -1 1))
(n (abs n))
group groups)
(save-excursion
(while (> n 0)
(if (setq group (gnus-group-group-name))
(push group groups))
(setq n (1- n))
(gnus-group-next-group way)))
(nreverse groups)))
((gnus-region-active-p)
;; Work on the region between point and mark.
(let ((max (max (point) (mark)))
groups)
(save-excursion
(goto-char (min (point) (mark)))
(while
(and
(push (gnus-group-group-name) groups)
(zerop (gnus-group-next-group 1))
(< (point) max)))
(nreverse groups))))
(gnus-group-marked
;; No prefix, but a list of marked articles.
(reverse gnus-group-marked))
(t
;; Neither marked articles or a prefix, so we return the
;; current group.
(let ((group (gnus-group-group-name)))
(and group (list group))))))
;;; !!!Surely gnus-group-iterate should be a macro instead? I can't
;;; imagine why I went through these contortions...
(eval-and-compile
(let ((function (make-symbol "gnus-group-iterate-function"))
(window (make-symbol "gnus-group-iterate-window"))
(groups (make-symbol "gnus-group-iterate-groups"))
(group (make-symbol "gnus-group-iterate-group")))
(eval
`(defun gnus-group-iterate (arg ,function)
"Iterate FUNCTION over all process/prefixed groups.
FUNCTION will be called with the group name as the parameter
and with point over the group in question."
(let ((,groups (gnus-group-process-prefix arg))
(,window (selected-window))
,group)
(while ,groups
(setq ,group (car ,groups)
,groups (cdr ,groups))
(select-window ,window)
(gnus-group-remove-mark ,group)
(save-selected-window
(save-excursion
(funcall ,function ,group)))))))))
(put 'gnus-group-iterate 'lisp-indent-function 1)
;; Selecting groups.
(defun gnus-group-read-group (&optional all no-article group select-articles)
"Read news in this newsgroup.
If the prefix argument ALL is non-nil, already read articles become
readable. IF ALL is a number, fetch this number of articles. If the
optional argument NO-ARTICLE is non-nil, no article will be
auto-selected upon group entry. If GROUP is non-nil, fetch that
group."
(interactive "P")
(let ((no-display (eq all 0))
(group (or group (gnus-group-group-name)))
number active marked entry)
(when (eq all 0)
(setq all nil))
(unless group
(error "No group on current line"))
(setq marked (gnus-info-marks
(nth 2 (setq entry (gnus-gethash
group gnus-newsrc-hashtb)))))
;; This group might be a dead group. In that case we have to get
;; the number of unread articles from `gnus-active-hashtb'.
(setq number
(cond ((numberp all) all)
(entry (car entry))
((setq active (gnus-active group))
(- (1+ (cdr active)) (car active)))))
(gnus-summary-read-group
group (or all (and (numberp number)
(zerop (+ number (gnus-range-length
(cdr (assq 'tick marked)))
(gnus-range-length
(cdr (assq 'dormant marked)))))))
no-article nil no-display nil select-articles)))
(defun gnus-group-select-group (&optional all)
"Select this newsgroup.
No article is selected automatically.
If ALL is non-nil, already read articles become readable.
If ALL is a number, fetch this number of articles."
(interactive "P")
(gnus-group-read-group all t))
(defun gnus-group-quick-select-group (&optional all)
"Select the current group \"quickly\".
This means that no highlighting or scoring will be performed.
If ALL (the prefix argument) is 0, don't even generate the summary
buffer.
This might be useful if you want to toggle threading
before entering the group."
(interactive "P")
(require 'gnus-score)
(let (gnus-visual
gnus-score-find-score-files-function
gnus-home-score-file
gnus-apply-kill-hook
gnus-summary-expunge-below)
(gnus-group-read-group all t)))
(defun gnus-group-visible-select-group (&optional all)
"Select the current group without hiding any articles."
(interactive "P")
(let ((gnus-inhibit-limiting t))
(gnus-group-read-group all t)))
(defun gnus-group-select-group-ephemerally ()
"Select the current group without doing any processing whatsoever.
You will actually be entered into a group that's a copy of
the current group; no changes you make while in this group will
be permanent."
(interactive)
(require 'gnus-score)
(let* (gnus-visual
gnus-score-find-score-files-function gnus-apply-kill-hook
gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
gnus-summary-mode-hook gnus-select-group-hook
(group (gnus-group-group-name))
(method (gnus-find-method-for-group group)))
(gnus-group-read-ephemeral-group
(gnus-group-prefixed-name group method) method)))
;;;###autoload
(defun gnus-fetch-group (group)
"Start Gnus if necessary and enter GROUP.
Returns whether the fetching was successful or not."
(interactive (list (completing-read "Group name: " gnus-active-hashtb)))
(unless (get-buffer gnus-group-buffer)
(gnus-no-server))
(gnus-group-read-group nil nil group))
;;;###autoload
(defun gnus-fetch-group-other-frame (group)
"Pop up a frame and enter GROUP."
(interactive "P")
(let ((window (get-buffer-window gnus-group-buffer)))
(cond (window
(select-frame (window-frame window)))
((= (length (frame-list)) 1)
(select-frame (make-frame)))
(t
(other-frame 1))))
(gnus-fetch-group group))
(defvar gnus-ephemeral-group-server 0)
;; Enter a group that is not in the group buffer. Non-nil is returned
;; if selection was successful.
(defun gnus-group-read-ephemeral-group (group method &optional activate
quit-config request-only
select-articles)
"Read GROUP from METHOD as an ephemeral group.
If ACTIVATE, request the group first.
If QUIT-CONFIG, use that window configuration when exiting from the
ephemeral group.
If REQUEST-ONLY, don't actually read the group; just request it.
If SELECT-ARTICLES, only select those articles.
Return the name of the group if selection was successful."
;; Transform the select method into a unique server.
(when (stringp method)
(setq method (gnus-server-to-method method)))
(setq method
`(,(car method) ,(concat (cadr method) "-ephemeral")
(,(intern (format "%s-address" (car method))) ,(cadr method))
,@(cddr method)))
(let ((group (if (gnus-group-foreign-p group) group
(gnus-group-prefixed-name group method))))
(gnus-sethash
group
`(-1 nil (,group
,gnus-level-default-subscribed nil nil ,method
((quit-config .
,(if quit-config quit-config
(cons gnus-summary-buffer
gnus-current-window-configuration))))))
gnus-newsrc-hashtb)
(push method gnus-ephemeral-servers)
(set-buffer gnus-group-buffer)
(unless (gnus-check-server method)
(error "Unable to contact server: %s" (gnus-status-message method)))
(when activate
(gnus-activate-group group 'scan)
(unless (gnus-request-group group)
(error "Couldn't request group: %s"
(nnheader-get-report (car method)))))
(if request-only
group
(condition-case ()
(when (gnus-group-read-group t t group select-articles)
group)
;;(error nil)
(quit nil)))))
(defun gnus-group-jump-to-group (group)
"Jump to newsgroup GROUP."
(interactive
(list (completing-read
"Group: " gnus-active-hashtb nil
(gnus-read-active-file-p)
nil
'gnus-group-history)))
(when (equal group "")
(error "Empty group name"))
(unless (gnus-ephemeral-group-p group)
;; Either go to the line in the group buffer...
(unless (gnus-group-goto-group group)
;; ... or insert the line.
(gnus-group-update-group group)
(gnus-group-goto-group group)))
;; Adjust cursor point.
(gnus-group-position-point))
(defun gnus-group-goto-group (group &optional far test-marked)
"Goto to newsgroup GROUP.
If FAR, it is likely that the group is not on the current line.
If TEST-MARKED, the line must be marked."
(when group
(beginning-of-line)
(cond
;; It's quite likely that we are on the right line, so
;; we check the current line first.
((and (not far)
(eq (get-text-property (point) 'gnus-group)
(gnus-intern-safe group gnus-active-hashtb))
(or (not test-marked) (gnus-group-mark-line-p)))
(point))
;; Previous and next line are also likely, so we check them as well.
((and (not far)
(save-excursion
(forward-line -1)
(and (eq (get-text-property (point) 'gnus-group)
(gnus-intern-safe group gnus-active-hashtb))
(or (not test-marked) (gnus-group-mark-line-p)))))
(forward-line -1)
(point))
((and (not far)
(save-excursion
(forward-line 1)
(and (eq (get-text-property (point) 'gnus-group)
(gnus-intern-safe group gnus-active-hashtb))
(or (not test-marked) (gnus-group-mark-line-p)))))
(forward-line 1)
(point))
(test-marked
(goto-char (point-min))
(let (found)
(while (and (not found)
(gnus-goto-char
(text-property-any
(point) (point-max)
'gnus-group
(gnus-intern-safe group gnus-active-hashtb))))
(if (gnus-group-mark-line-p)
(setq found t)
(forward-line 1)))
found))
(t
;; Search through the entire buffer.
(gnus-goto-char
(text-property-any
(point-min) (point-max)
'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
(defun gnus-group-next-group (n &optional silent)
"Go to next N'th newsgroup.
If N is negative, search backward instead.
Returns the difference between N and the number of skips actually
done."
(interactive "p")
(gnus-group-next-unread-group n t nil silent))
(defun gnus-group-next-unread-group (n &optional all level silent)
"Go to next N'th unread newsgroup.
If N is negative, search backward instead.
If ALL is non-nil, choose any newsgroup, unread or not.
If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
such group can be found, the next group with a level higher than
LEVEL.
Returns the difference between N and the number of skips actually
made."
(interactive "p")
(let ((backward (< n 0))
(n (abs n)))
(while (and (> n 0)
(gnus-group-search-forward
backward (or (not gnus-group-goto-unread) all) level))
(setq n (1- n)))
(when (and (/= 0 n)
(not silent))
(gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
(if level " on this level or higher" "")))
n))
(defun gnus-group-prev-group (n)
"Go to previous N'th newsgroup.
Returns the difference between N and the number of skips actually
done."
(interactive "p")
(gnus-group-next-unread-group (- n) t))
(defun gnus-group-prev-unread-group (n)
"Go to previous N'th unread newsgroup.
Returns the difference between N and the number of skips actually
done."
(interactive "p")
(gnus-group-next-unread-group (- n)))
(defun gnus-group-next-unread-group-same-level (n)
"Go to next N'th unread newsgroup on the same level.
If N is negative, search backward instead.
Returns the difference between N and the number of skips actually
done."
(interactive "p")
(gnus-group-next-unread-group n t (gnus-group-group-level))
(gnus-group-position-point))
(defun gnus-group-prev-unread-group-same-level (n)
"Go to next N'th unread newsgroup on the same level.
Returns the difference between N and the number of skips actually
done."
(interactive "p")
(gnus-group-next-unread-group (- n) t (gnus-group-group-level))
(gnus-group-position-point))
(defun gnus-group-best-unread-group (&optional exclude-group)
"Go to the group with the highest level.
If EXCLUDE-GROUP, do not go to that group."
(interactive)
(goto-char (point-min))
(let ((best 100000)
unread best-point)
(while (not (eobp))
(setq unread (get-text-property (point) 'gnus-unread))
(when (and (numberp unread) (> unread 0))
(when (and (get-text-property (point) 'gnus-level)
(< (get-text-property (point) 'gnus-level) best)
(or (not exclude-group)
(not (equal exclude-group (gnus-group-group-name)))))
(setq best (get-text-property (point) 'gnus-level))
(setq best-point (point))))
(forward-line 1))
(when best-point
(goto-char best-point))
(gnus-summary-position-point)
(and best-point (gnus-group-group-name))))
(defun gnus-group-first-unread-group ()
"Go to the first group with unread articles."
(interactive)
(prog1
(let ((opoint (point))
unread)
(goto-char (point-min))
(if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
(and (numberp unread) ; Not a topic.
(not (zerop unread))) ; Has unread articles.
(zerop (gnus-group-next-unread-group 1))) ; Next unread group.
(point) ; Success.
(goto-char opoint)
nil)) ; Not success.
(gnus-group-position-point)))
(defun gnus-group-enter-server-mode ()
"Jump to the server buffer."
(interactive)
(gnus-enter-server-buffer))
(defun gnus-group-make-group (name &optional method address args)
"Add a new newsgroup.
The user will be prompted for a NAME, for a select METHOD, and an
ADDRESS."
(interactive
(list
(gnus-read-group "Group name: ")
(gnus-read-method "From method: ")))
(when (stringp method)
(setq method (or (gnus-server-to-method method) method)))
(let* ((meth (gnus-method-simplify
(when (and method
(not (gnus-server-equal method gnus-select-method)))
(if address (list (intern method) address)
method))))
(nname (if method (gnus-group-prefixed-name name meth) name))
backend info)
(when (gnus-gethash nname gnus-newsrc-hashtb)
(error "Group %s already exists" nname))
;; Subscribe to the new group.
(gnus-group-change-level
(setq info (list t nname gnus-level-default-subscribed nil nil meth))
gnus-level-default-subscribed gnus-level-killed
(and (gnus-group-group-name)
(gnus-gethash (gnus-group-group-name)
gnus-newsrc-hashtb))
t)
;; Make it active.
(gnus-set-active nname (cons 1 0))
(unless (gnus-ephemeral-group-p name)
(gnus-dribble-enter
(concat "(gnus-group-set-info '"
(gnus-prin1-to-string (cdr info)) ")")))
;; Insert the line.
(gnus-group-insert-group-line-info nname)
(forward-line -1)
(gnus-group-position-point)
;; Load the backend and try to make the backend create
;; the group as well.
(when (assoc (symbol-name (setq backend (car (gnus-server-get-method
nil meth))))
gnus-valid-select-methods)
(require backend))
(gnus-check-server meth)
(when (gnus-check-backend-function 'request-create-group nname)
(gnus-request-create-group nname nil args))
t))
(defun gnus-group-delete-groups (&optional arg)
"Delete the current group. Only meaningful with editable groups."
(interactive "P")
(let ((n (length (gnus-group-process-prefix arg))))
(when (gnus-yes-or-no-p
(if (= n 1)
"Delete this 1 group? "
(format "Delete these %d groups? " n)))
(gnus-group-iterate arg
(lambda (group)
(gnus-group-delete-group group nil t))))))
(defun gnus-group-delete-group (group &optional force no-prompt)
"Delete the current group. Only meaningful with editable groups.
If FORCE (the prefix) is non-nil, all the articles in the group will
be deleted. This is \"deleted\" as in \"removed forever from the face
of the Earth\". There is no undo. The user will be prompted before
doing the deletion."
(interactive
(list (gnus-group-group-name)
current-prefix-arg))
(unless group
(error "No group to rename"))
(unless (gnus-check-backend-function 'request-delete-group group)
(error "This backend does not support group deletion"))
(prog1
(if (and (not no-prompt)
(not (gnus-yes-or-no-p
(format
"Do you really want to delete %s%s? "
group (if force " and all its contents" "")))))
() ; Whew!
(gnus-message 6 "Deleting group %s..." group)
(if (not (gnus-request-delete-group group force))
(gnus-error 3 "Couldn't delete group %s" group)
(gnus-message 6 "Deleting group %s...done" group)
(gnus-group-goto-group group)
(gnus-group-kill-group 1 t)
(gnus-sethash group nil gnus-active-hashtb)
t))
(gnus-group-position-point)))
(defun gnus-group-rename-group (group new-name)
"Rename group from GROUP to NEW-NAME.
When used interactively, GROUP is the group under point
and NEW-NAME will be prompted for."
(interactive
(list
(gnus-group-group-name)
(progn
(unless (gnus-check-backend-function
'request-rename-group (gnus-group-group-name))
(error "This backend does not support renaming groups"))
(gnus-read-group "Rename group to: "
(gnus-group-real-name (gnus-group-group-name))))))
(unless (gnus-check-backend-function 'request-rename-group group)
(error "This backend does not support renaming groups"))
(unless group
(error "No group to rename"))
(when (equal (gnus-group-real-name group) new-name)
(error "Can't rename to the same name"))
;; We find the proper prefixed name.
(setq new-name
(if (gnus-group-native-p group)
;; Native group.
new-name
;; Foreign group.
(gnus-group-prefixed-name
(gnus-group-real-name new-name)
(gnus-info-method (gnus-get-info group)))))
(gnus-message 6 "Renaming group %s to %s..." group new-name)
(prog1
(if (progn
(gnus-group-goto-group group)
(not (when (< (gnus-group-group-level) gnus-level-zombie)
(gnus-request-rename-group group new-name))))
(gnus-error 3 "Couldn't rename group %s to %s" group new-name)
;; We rename the group internally by killing it...
(gnus-group-kill-group)
;; ... changing its name ...
(setcar (cdar gnus-list-of-killed-groups) new-name)
;; ... and then yanking it. Magic!
(gnus-group-yank-group)
(gnus-set-active new-name (gnus-active group))
(gnus-message 6 "Renaming group %s to %s...done" group new-name)
new-name)
(setq gnus-killed-list (delete group gnus-killed-list))
(gnus-set-active group nil)
(gnus-dribble-touch)
(gnus-group-position-point)))
(defun gnus-group-edit-group (group &optional part)
"Edit the group on the current line."
(interactive (list (gnus-group-group-name)))
(let ((part (or part 'info))
info)
(unless group
(error "No group on current line"))
(unless (setq info (gnus-get-info group))
(error "Killed group; can't be edited"))
(ignore-errors
(gnus-close-group group))
(gnus-edit-form
;; Find the proper form to edit.
(cond ((eq part 'method)
(or (gnus-info-method info) "native"))
((eq part 'params)
(gnus-info-params info))
(t info))
;; The proper documentation.
(format
"Editing the %s for `%s'."
(cond
((eq part 'method) "select method")
((eq part 'params) "group parameters")
(t "group info"))
(gnus-group-decoded-name group))
`(lambda (form)
(gnus-group-edit-group-done ',part ,group form)))))
(defun gnus-group-edit-group-method (group)
"Edit the select method of GROUP."
(interactive (list (gnus-group-group-name)))
(gnus-group-edit-group group 'method))
(defun gnus-group-edit-group-parameters (group)
"Edit the group parameters of GROUP."
(interactive (list (gnus-group-group-name)))
(gnus-group-edit-group group 'params))
(defun gnus-group-edit-group-done (part group form)
"Update variables."
(let* ((method (cond ((eq part 'info) (nth 4 form))
((eq part 'method) form)
(t nil)))
(info (cond ((eq part 'info) form)
((eq part 'method) (gnus-get-info group))
(t nil)))
(new-group (if info
(if (or (not method)
(gnus-server-equal
gnus-select-method method))
(gnus-group-real-name (car info))
(gnus-group-prefixed-name
(gnus-group-real-name (car info)) method))
nil)))
(when (and new-group
(not (equal new-group group)))
(when (gnus-group-goto-group group)
(gnus-group-kill-group 1))
(gnus-activate-group new-group))
;; Set the info.
(if (not (and info new-group))
(gnus-group-set-info form (or new-group group) part)
(setq info (gnus-copy-sequence info))
(setcar info new-group)
(unless (gnus-server-equal method "native")
(unless (nthcdr 3 info)
(nconc info (list nil nil)))
(unless (nthcdr 4 info)
(nconc info (list nil)))
(gnus-info-set-method info method))
(gnus-group-set-info info))
(gnus-group-update-group (or new-group group))
(gnus-group-position-point)))
(defun gnus-group-make-useful-group (group method)
"Create one of the groups described in `gnus-useful-groups'."
(interactive
(let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
nil t)
gnus-useful-groups)))
(list (cadr entry) (caddr entry))))
(setq method (gnus-copy-sequence method))
(let (entry)
(while (setq entry (memq (assq 'eval method) method))
(setcar entry (eval (cadar entry)))))
(gnus-group-make-group group method))
(defun gnus-group-make-help-group ()
"Create the Gnus documentation group."
(interactive)
(let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
(file (nnheader-find-etc-directory "gnus-tut.txt" t)))
(when (gnus-gethash name gnus-newsrc-hashtb)
(error "Documentation group already exists"))
(if (not file)
(gnus-message 1 "Couldn't find doc group")
(gnus-group-make-group
(gnus-group-real-name name)
(list 'nndoc "gnus-help"
(list 'nndoc-address file)
(list 'nndoc-article-type 'mbox)))))
(gnus-group-position-point))
(defun gnus-group-make-doc-group (file type)
"Create a group that uses a single file as the source."
(interactive
(list (read-file-name "File name: ")
(and current-prefix-arg 'ask)))
(when (eq type 'ask)
(let ((err "")
char found)
(while (not found)
(message
"%sFile type (mbox, babyl, digest, forward, mmdf, guess) [mbdfag]: "
err)
(setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
((= char ?b) 'babyl)
((= char ?d) 'digest)
((= char ?f) 'forward)
((= char ?a) 'mmfd)
((= char ?g) 'guess)
(t (setq err (format "%c unknown. " char))
nil))))
(setq type found)))
(let* ((file (expand-file-name file))
(name (gnus-generate-new-group-name
(gnus-group-prefixed-name
(file-name-nondirectory file) '(nndoc "")))))
(gnus-group-make-group
(gnus-group-real-name name)
(list 'nndoc file
(list 'nndoc-address file)
(list 'nndoc-article-type (or type 'guess))))))
(defvar nnweb-type-definition)
(defvar gnus-group-web-type-history nil)
(defvar gnus-group-web-search-history nil)
(defun gnus-group-make-web-group (&optional solid)
"Create an ephemeral nnweb group.
If SOLID (the prefix), create a solid group."
(interactive "P")
(require 'nnweb)
(let* ((group
(if solid (gnus-read-group "Group name: ")
(message-unique-id)))
(default-type (or (car gnus-group-web-type-history)
(symbol-name (caar nnweb-type-definition))))
(type
(gnus-string-or
(completing-read
(format "Search engine type (default %s): " default-type)
(mapcar (lambda (elem) (list (symbol-name (car elem))))
nnweb-type-definition)
nil t nil 'gnus-group-web-type-history)
default-type))
(search
(read-string
"Search string: "
(cons (or (car gnus-group-web-search-history) "") 0)
'gnus-group-web-search-history))
(method
`(nnweb ,group (nnweb-search ,search)
(nnweb-type ,(intern type))
(nnweb-ephemeral-p t))))
(if solid
(gnus-group-make-group group "nnweb" "" `(,(intern type) ,search))
(gnus-group-read-ephemeral-group
group method t
(cons (current-buffer)
(if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
(defvar nnwarchive-type-definition)
(defvar gnus-group-warchive-type-history nil)
(defvar gnus-group-warchive-login-history nil)
(defvar gnus-group-warchive-address-history nil)
(defun gnus-group-make-warchive-group ()
"Create a nnwarchive group."
(interactive)
(require 'nnwarchive)
(let* ((group (gnus-read-group "Group name: "))
(default-type (or (car gnus-group-warchive-type-history)
(symbol-name (caar nnwarchive-type-definition))))
(type
(gnus-string-or
(completing-read
(format "Warchive type (default %s): " default-type)
(mapcar (lambda (elem) (list (symbol-name (car elem))))
nnwarchive-type-definition)
nil t nil 'gnus-group-warchive-type-history)
default-type))
(address (read-string "Warchive address: "
nil 'gnus-group-warchive-address-history))
(default-login (or (car gnus-group-warchive-login-history)
user-mail-address))
(login
(gnus-string-or
(read-string
(format "Warchive login (default %s): " user-mail-address)
default-login 'gnus-group-warchive-login-history)
user-mail-address))
(method
`(nnwarchive ,address
(nnwarchive-type ,(intern type))
(nnwarchive-login ,login))))
(gnus-group-make-group group method)))
(defun gnus-group-make-archive-group (&optional all)
"Create the (ding) Gnus archive group of the most recent articles.
Given a prefix, create a full group."
(interactive "P")
(let ((group (gnus-group-prefixed-name
(if all "ding.archives" "ding.recent") '(nndir ""))))
(when (gnus-gethash group gnus-newsrc-hashtb)
(error "Archive group already exists"))
(gnus-group-make-group
(gnus-group-real-name group)
(list 'nndir (if all "hpc" "edu")
(list 'nndir-directory
(if all gnus-group-archive-directory
gnus-group-recent-archive-directory))))
(gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
(defun gnus-group-make-directory-group (dir)
"Create an nndir group.
The user will be prompted for a directory. The contents of this
directory will be used as a newsgroup. The directory should contain
mail messages or news articles in files that have numeric names."
(interactive
(list (read-file-name "Create group from directory: ")))
(unless (file-exists-p dir)
(error "No such directory"))
(unless (file-directory-p dir)
(error "Not a directory"))
(let ((ext "")
(i 0)
group)
(while (or (not group) (gnus-gethash group gnus-newsrc-hashtb))
(setq group
(gnus-group-prefixed-name
(concat (file-name-as-directory (directory-file-name dir))
ext)
'(nndir "")))
(setq ext (format "<%d>" (setq i (1+ i)))))
(gnus-group-make-group
(gnus-group-real-name group)
(list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
(defun gnus-group-make-kiboze-group (group address scores)
"Create an nnkiboze group.
The user will be prompted for a name, a regexp to match groups, and
score file entries for articles to include in the group."
(interactive
(list
(read-string "nnkiboze group name: ")
(read-string "Source groups (regexp): ")
(let ((headers (mapcar (lambda (group) (list group))
'("subject" "from" "number" "date" "message-id"
"references" "chars" "lines" "xref"
"followup" "all" "body" "head")))
scores header regexp regexps)
(while (not (equal "" (setq header (completing-read
"Match on header: " headers nil t))))
(setq regexps nil)
(while (not (equal "" (setq regexp (read-string
(format "Match on %s (string): "
header)))))
(push (list regexp nil nil 'r) regexps))
(push (cons header regexps) scores))
scores)))
(gnus-group-make-group group "nnkiboze" address)
(let* ((score-file (gnus-score-file-name (concat "nnkiboze:" group)))
(score-dir (file-name-directory score-file)))
(unless (file-exists-p score-dir)
(make-directory score-dir))
(with-temp-file score-file
(let (emacs-lisp-mode-hook)
(pp scores (current-buffer))))))
(defun gnus-group-add-to-virtual (n vgroup)
"Add the current group to a virtual group."
(interactive
(list current-prefix-arg
(completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
"nnvirtual:")))
(unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
(error "%s is not an nnvirtual group" vgroup))
(gnus-close-group vgroup)
(let* ((groups (gnus-group-process-prefix n))
(method (gnus-info-method (gnus-get-info vgroup))))
(setcar (cdr method)
(concat
(nth 1 method) "\\|"
(mapconcat
(lambda (s)
(gnus-group-remove-mark s)
(concat "\\(^" (regexp-quote s) "$\\)"))
groups "\\|"))))
(gnus-group-position-point))
(defun gnus-group-make-empty-virtual (group)
"Create a new, fresh, empty virtual group."
(interactive "sCreate new, empty virtual group: ")
(let* ((method (list 'nnvirtual "^$"))
(pgroup (gnus-group-prefixed-name group method)))
;; Check whether it exists already.
(when (gnus-gethash pgroup gnus-newsrc-hashtb)
(error "Group %s already exists" pgroup))
;; Subscribe the new group after the group on the current line.
(gnus-subscribe-group pgroup (gnus-group-group-name) method)
(gnus-group-update-group pgroup)
(forward-line -1)
(gnus-group-position-point)))
(defun gnus-group-enter-directory (dir)
"Enter an ephemeral nneething group."
(interactive "DDirectory to read: ")
(let* ((method (list 'nneething dir '(nneething-read-only t)))
(leaf (gnus-group-prefixed-name
(file-name-nondirectory (directory-file-name dir))
method))
(name (gnus-generate-new-group-name leaf)))
(unless (gnus-group-read-ephemeral-group
name method t
(cons (current-buffer)
(if (eq major-mode 'gnus-summary-mode)
'summary 'group)))
(error "Couldn't enter %s" dir))))
(eval-and-compile
(autoload 'nnimap-expunge "nnimap")
(autoload 'nnimap-acl-get "nnimap")
(autoload 'nnimap-acl-edit "nnimap"))
(defun gnus-group-nnimap-expunge (group)
"Expunge deleted articles in current nnimap GROUP."
(interactive (list (gnus-group-group-name)))
(let ((mailbox (gnus-group-real-name group)) method)
(unless group
(error "No group on current line"))
(unless (gnus-get-info group)
(error "Killed group; can't be edited"))
(unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
(error "%s is not an nnimap group" group))
(nnimap-expunge mailbox (cadr method))))
(defun gnus-group-nnimap-edit-acl (group)
"Edit the Access Control List of current nnimap GROUP."
(interactive (list (gnus-group-group-name)))
(let ((mailbox (gnus-group-real-name group)) method acl)
(unless group
(error "No group on current line"))
(unless (gnus-get-info group)
(error "Killed group; can't be edited"))
(unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
(error "%s is not an nnimap group" group))
(gnus-edit-form (setq acl (nnimap-acl-get mailbox (cadr method)))
(format "Editing the access control list for `%s'.
An access control list is a list of (identifier . rights) elements.
The identifier string specifies the corresponding user. The
identifier \"anyone\" is reserved to refer to the universal identity.
Rights is a string listing a (possibly empty) set of alphanumeric
characters, each character listing a set of operations which is being
controlled. Letters are reserved for ``standard'' rights, listed
below. Digits are reserved for implementation or site defined rights.
l - lookup (mailbox is visible to LIST/LSUB commands)
r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
SEARCH, COPY from mailbox)
s - keep seen/unseen information across sessions (STORE \\SEEN flag)
w - write (STORE flags other than \\SEEN and \\DELETED)
i - insert (perform APPEND, COPY into mailbox)
p - post (send mail to submission address for mailbox,
not enforced by IMAP4 itself)
c - create and delete mailbox (CREATE new sub-mailboxes in any
implementation-defined hierarchy, RENAME or DELETE mailbox)
d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
a - administer (perform SETACL)" group)
`(lambda (form)
(nnimap-acl-edit
,mailbox ',method ',acl form)))))
;; Group sorting commands
;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
(defun gnus-group-sort-groups (func &optional reverse)
"Sort the group buffer according to FUNC.
When used interactively, the sorting function used will be
determined by the `gnus-group-sort-function' variable.
If REVERSE (the prefix), reverse the sorting order."
(interactive (list gnus-group-sort-function current-prefix-arg))
(funcall gnus-group-sort-alist-function
(gnus-make-sort-function func) reverse)
(gnus-group-list-groups)
(gnus-dribble-touch))
(defun gnus-group-sort-flat (func reverse)
;; We peel off the dummy group from the alist.
(when func
(when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
(pop gnus-newsrc-alist))
;; Do the sorting.
(setq gnus-newsrc-alist
(sort gnus-newsrc-alist func))
(when reverse
(setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
;; Regenerate the hash table.
(gnus-make-hashtable-from-newsrc-alist)))
(defun gnus-group-sort-groups-by-alphabet (&optional reverse)
"Sort the group buffer alphabetically by group name.
If REVERSE, sort in reverse order."
(interactive "P")
(gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
(defun gnus-group-sort-groups-by-unread (&optional reverse)
"Sort the group buffer by number of unread articles.
If REVERSE, sort in reverse order."
(interactive "P")
(gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
(defun gnus-group-sort-groups-by-level (&optional reverse)
"Sort the group buffer by group level.
If REVERSE, sort in reverse order."
(interactive "P")
(gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
(defun gnus-group-sort-groups-by-score (&optional reverse)
"Sort the group buffer by group score.
If REVERSE, sort in reverse order."
(interactive "P")
(gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
(defun gnus-group-sort-groups-by-rank (&optional reverse)
"Sort the group buffer by group rank.
If REVERSE, sort in reverse order."
(interactive "P")
(gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
(defun gnus-group-sort-groups-by-method (&optional reverse)
"Sort the group buffer alphabetically by backend name.
If REVERSE, sort in reverse order."
(interactive "P")
(gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
;;; Selected group sorting.
(defun gnus-group-sort-selected-groups (n func &optional reverse)
"Sort the process/prefixed groups."
(interactive (list current-prefix-arg gnus-group-sort-function))
(let ((groups (gnus-group-process-prefix n)))
(funcall gnus-group-sort-selected-function
groups (gnus-make-sort-function func) reverse)
(gnus-group-list-groups)))
(defun gnus-group-sort-selected-flat (groups func reverse)
(let (entries infos)
;; First find all the group entries for these groups.
(while groups
(push (nthcdr 2 (gnus-gethash (pop groups) gnus-newsrc-hashtb))
entries))
;; Then sort the infos.
(setq infos
(sort
(mapcar
(lambda (entry) (car entry))
(setq entries (nreverse entries)))
func))
(when reverse
(setq infos (nreverse infos)))
;; Go through all the infos and replace the old entries
;; with the new infos.
(while infos
(setcar (car entries) (pop infos))
(pop entries))
;; Update the hashtable.
(gnus-make-hashtable-from-newsrc-alist)))
(defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
"Sort the group buffer alphabetically by group name.
Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
sort in reverse order."
(interactive (gnus-interactive "P\ny"))
(gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
(defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
"Sort the group buffer by number of unread articles.
Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
sort in reverse order."
(interactive (gnus-interactive "P\ny"))
(gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
(defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
"Sort the group buffer by group level.
Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
sort in reverse order."
(interactive (gnus-interactive "P\ny"))
(gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
(defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
"Sort the group buffer by group score.
Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
sort in reverse order."
(interactive (gnus-interactive "P\ny"))
(gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
(defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
"Sort the group buffer by group rank.
Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
sort in reverse order."
(interactive (gnus-interactive "P\ny"))
(gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
(defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
"Sort the group buffer alphabetically by backend name.
Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
sort in reverse order."
(interactive (gnus-interactive "P\ny"))
(gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
;;; Sorting predicates.
(defun gnus-group-sort-by-alphabet (info1 info2)
"Sort alphabetically."
(string< (gnus-info-group info1) (gnus-info-group info2)))
(defun gnus-group-sort-by-real-name (info1 info2)
"Sort alphabetically on real (unprefixed) names."
(string< (gnus-group-real-name (gnus-info-group info1))
(gnus-group-real-name (gnus-info-group info2))))
(defun gnus-group-sort-by-unread (info1 info2)
"Sort by number of unread articles."
(let ((n1 (car (gnus-gethash (gnus-info-group info1) gnus-newsrc-hashtb)))
(n2 (car (gnus-gethash (gnus-info-group info2) gnus-newsrc-hashtb))))
(< (or (and (numberp n1) n1) 0)
(or (and (numberp n2) n2) 0))))
(defun gnus-group-sort-by-level (info1 info2)
"Sort by level."
(< (gnus-info-level info1) (gnus-info-level info2)))
(defun gnus-group-sort-by-method (info1 info2)
"Sort alphabetically by backend name."
(string< (symbol-name (car (gnus-find-method-for-group
(gnus-info-group info1) info1)))
(symbol-name (car (gnus-find-method-for-group
(gnus-info-group info2) info2)))))
(defun gnus-group-sort-by-score (info1 info2)
"Sort by group score."
(< (gnus-info-score info1) (gnus-info-score info2)))
(defun gnus-group-sort-by-rank (info1 info2)
"Sort by level and score."
(let ((level1 (gnus-info-level info1))
(level2 (gnus-info-level info2)))
(or (< level1 level2)
(and (= level1 level2)
(> (gnus-info-score info1) (gnus-info-score info2))))))
;;; Clearing data
(defun gnus-group-clear-data (&optional arg)
"Clear all marks and read ranges from the current group."
(interactive "P")
(gnus-group-iterate arg
(lambda (group)
(let (info)
(gnus-info-clear-data (setq info (gnus-get-info group)))
(gnus-get-unread-articles-in-group info (gnus-active group) t)
(when (gnus-group-goto-group group)
(gnus-group-update-group-line))))))
(defun gnus-group-clear-data-on-native-groups ()
"Clear all marks and read ranges from all native groups."
(interactive)
(when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
(let ((alist (cdr gnus-newsrc-alist))
info)
(while (setq info (pop alist))
(when (gnus-group-native-p (gnus-info-group info))
(gnus-info-clear-data info)))
(gnus-get-unread-articles)
(gnus-dribble-touch)
(when (gnus-y-or-n-p
"Move the cache away to avoid problems in the future? ")
(call-interactively 'gnus-cache-move-cache)))))
(defun gnus-info-clear-data (info)
"Clear all marks and read ranges from INFO."
(let ((group (gnus-info-group info)))
(gnus-undo-register
`(progn
(gnus-info-set-marks ',info ',(gnus-info-marks info) t)
(gnus-info-set-read ',info ',(gnus-info-read info))
(when (gnus-group-goto-group ,group)
(gnus-group-update-group-line))))
(gnus-info-set-read info nil)
(when (gnus-info-marks info)
(gnus-info-set-marks info nil))))
;; Group catching up.
(defun gnus-group-catchup-current (&optional n all)
"Mark all unread articles in the current newsgroup as read.
If prefix argument N is numeric, the next N newsgroups will be
caught up. If ALL is non-nil, marked articles will also be marked as
read. Cross references (Xref: header) of articles are ignored.
The number of newsgroups that this function was unable to catch
up is returned."
(interactive "P")
(let ((groups (gnus-group-process-prefix n))
(ret 0)
group)
(unless groups (error "No groups selected"))
(if (not
(or (not gnus-interactive-catchup) ;Without confirmation?
gnus-expert-user
(gnus-y-or-n-p
(format
(if all
"Do you really want to mark all articles in %s as read? "
"Mark all unread articles in %s as read? ")
(if (= (length groups) 1)
(car groups)
(format "these %d groups" (length groups)))))))
n
(while (setq group (pop groups))
(gnus-group-remove-mark group)
;; Virtual groups have to be given special treatment.
(let ((method (gnus-find-method-for-group group)))
(when (eq 'nnvirtual (car method))
(nnvirtual-catchup-group
(gnus-group-real-name group) (nth 1 method) all)))
(if (>= (gnus-group-level group) gnus-level-zombie)
(gnus-message 2 "Dead groups can't be caught up")
(if (prog1
(gnus-group-goto-group group)
(gnus-group-catchup group all))
(gnus-group-update-group-line)
(setq ret (1+ ret)))))
(gnus-group-next-unread-group 1)
ret)))
(defun gnus-group-catchup-current-all (&optional n)
"Mark all articles in current newsgroup as read.
Cross references (Xref: header) of articles are ignored."
(interactive "P")
(gnus-group-catchup-current n 'all))
(defun gnus-group-catchup (group &optional all)
"Mark all articles in GROUP as read.
If ALL is non-nil, all articles are marked as read.
The return value is the number of articles that were marked as read,
or nil if no action could be taken."
(let* ((entry (gnus-gethash group gnus-newsrc-hashtb))
(num (car entry)))
;; Remove entries for this group.
(nnmail-purge-split-history (gnus-group-real-name group))
;; Do the updating only if the newsgroup isn't killed.
(if (not (numberp (car entry)))
(gnus-message 1 "Can't catch up %s; non-active group" group)
;; Do auto-expirable marks if that's required.
(when (gnus-group-auto-expirable-p group)
(gnus-add-marked-articles
group 'expire (gnus-list-of-unread-articles group))
(when all
(let ((marks (nth 3 (nth 2 entry))))
(gnus-add-marked-articles
group 'expire (gnus-uncompress-range (cdr (assq 'tick marks))))
(gnus-add-marked-articles
group 'expire (gnus-uncompress-range (cdr (assq 'tick marks)))))))
(when entry
(gnus-update-read-articles group nil)
;; Also nix out the lists of marks and dormants.
(when all
(gnus-add-marked-articles group 'tick nil nil 'force)
(gnus-add-marked-articles group 'dormant nil nil 'force))
(let ((gnus-newsgroup-name group))
(gnus-run-hooks 'gnus-group-catchup-group-hook))
num))))
(defun gnus-group-expire-articles (&optional n)
"Expire all expirable articles in the current newsgroup."
(interactive "P")
(let ((groups (gnus-group-process-prefix n))
group)
(unless groups
(error "No groups to expire"))
(while (setq group (pop groups))
(gnus-group-remove-mark group)
(gnus-group-expire-articles-1 group)
(gnus-dribble-touch)
(gnus-group-position-point))))
(defun gnus-group-expire-articles-1 (group)
(when (gnus-check-backend-function 'request-expire-articles group)
(gnus-message 6 "Expiring articles in %s..." group)
(let* ((info (gnus-get-info group))
(expirable (if (gnus-group-total-expirable-p group)
(cons nil (gnus-list-of-read-articles group))
(assq 'expire (gnus-info-marks info))))
(expiry-wait (gnus-group-find-parameter group 'expiry-wait))
(nnmail-expiry-target
(or (gnus-group-find-parameter group 'expiry-target)
nnmail-expiry-target)))
(when expirable
(gnus-check-group group)
(setcdr
expirable
(gnus-compress-sequence
(if expiry-wait
;; We set the expiry variables to the group
;; parameter.
(let ((nnmail-expiry-wait-function nil)
(nnmail-expiry-wait expiry-wait))
(gnus-request-expire-articles
(gnus-uncompress-sequence (cdr expirable)) group))
;; Just expire using the normal expiry values.
(gnus-request-expire-articles
(gnus-uncompress-sequence (cdr expirable)) group))))
(gnus-close-group group))
(gnus-message 6 "Expiring articles in %s...done" group)
;; Return the list of un-expired articles.
(cdr expirable))))
(defun gnus-group-expire-all-groups ()
"Expire all expirable articles in all newsgroups."
(interactive)
(save-excursion
(gnus-message 5 "Expiring...")
(let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
(cdr gnus-newsrc-alist))))
(gnus-group-expire-articles nil)))
(gnus-group-position-point)
(gnus-message 5 "Expiring...done"))
(defun gnus-group-set-current-level (n level)
"Set the level of the next N groups to LEVEL."
(interactive
(list
current-prefix-arg
(string-to-int
(let ((s (read-string
(format "Level (default %s): "
(or (gnus-group-group-level)
gnus-level-default-subscribed)))))
(if (string-match "^\\s-*$" s)
(int-to-string (or (gnus-group-group-level)
gnus-level-default-subscribed))
s)))))
(unless (and (>= level 1) (<= level gnus-level-killed))
(error "Invalid level: %d" level))
(let ((groups (gnus-group-process-prefix n))
group)
(while (setq group (pop groups))
(gnus-group-remove-mark group)
(gnus-message 6 "Changed level of %s from %d to %d"
group (or (gnus-group-group-level) gnus-level-killed)
level)
(gnus-group-change-level
group level (or (gnus-group-group-level) gnus-level-killed))
(gnus-group-update-group-line)))
(gnus-group-position-point))
(defun gnus-group-unsubscribe (&optional n)
"Unsubscribe the current group."
(interactive "P")
(gnus-group-unsubscribe-current-group n 'unsubscribe))
(defun gnus-group-subscribe (&optional n)
"Subscribe the current group."
(interactive "P")
(gnus-group-unsubscribe-current-group n 'subscribe))
(defun gnus-group-unsubscribe-current-group (&optional n do-sub)
"Toggle subscription of the current group.
If given numerical prefix, toggle the N next groups."
(interactive "P")
(let ((groups (gnus-group-process-prefix n))
group)
(while groups
(setq group (car groups)
groups (cdr groups))
(gnus-group-remove-mark group)
(gnus-group-unsubscribe-group
group
(cond
((eq do-sub 'unsubscribe)
gnus-level-default-unsubscribed)
((eq do-sub 'subscribe)
gnus-level-default-subscribed)
((<= (gnus-group-group-level) gnus-level-subscribed)
gnus-level-default-unsubscribed)
(t
gnus-level-default-subscribed))
t)
(gnus-group-update-group-line))
(gnus-group-next-group 1)))
(defun gnus-group-unsubscribe-group (group &optional level silent)
"Toggle subscription to GROUP.
Killed newsgroups are subscribed. If SILENT, don't try to update the
group line."
(interactive
(list (completing-read
"Group: " gnus-active-hashtb nil
(gnus-read-active-file-p)
nil
'gnus-group-history)))
(let ((newsrc (gnus-gethash group gnus-newsrc-hashtb)))
(cond
((string-match "^[ \t]*$" group)
(error "Empty group name"))
(newsrc
;; Toggle subscription flag.
(gnus-group-change-level
newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
gnus-level-subscribed)
(1+ gnus-level-subscribed)
gnus-level-default-subscribed)))
(unless silent
(gnus-group-update-group group)))
((and (stringp group)
(or (not (gnus-read-active-file-p))
(gnus-active group)))
;; Add new newsgroup.
(gnus-group-change-level
group
(if level level gnus-level-default-subscribed)
(or (and (member group gnus-zombie-list)
gnus-level-zombie)
gnus-level-killed)
(when (gnus-group-group-name)
(gnus-gethash (gnus-group-group-name) gnus-newsrc-hashtb)))
(unless silent
(gnus-group-update-group group)))
(t (error "No such newsgroup: %s" group)))
(gnus-group-position-point)))
(defun gnus-group-transpose-groups (n)
"Move the current newsgroup up N places.
If given a negative prefix, move down instead. The difference between
N and the number of steps taken is returned."
(interactive "p")
(unless (gnus-group-group-name)
(error "No group on current line"))
(gnus-group-kill-group 1)
(prog1
(forward-line (- n))
(gnus-group-yank-group)
(gnus-group-position-point)))
(defun gnus-group-kill-all-zombies (&optional dummy)
"Kill all zombie newsgroups.
The optional DUMMY should always be nil."
(interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
(unless dummy
(setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
(setq gnus-zombie-list nil)
(gnus-dribble-touch)
(gnus-group-list-groups)))
(defun gnus-group-kill-region (begin end)
"Kill newsgroups in current region (excluding current point).
The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
(interactive "r")
(let ((lines
;; Count lines.
(save-excursion
(count-lines
(progn
(goto-char begin)
(beginning-of-line)
(point))
(progn
(goto-char end)
(beginning-of-line)
(point))))))
(goto-char begin)
(beginning-of-line) ;Important when LINES < 1
(gnus-group-kill-group lines)))
(defun gnus-group-kill-group (&optional n discard)
"Kill the next N groups.
The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
However, only groups that were alive can be yanked; already killed
groups or zombie groups can't be yanked.
The return value is the name of the group that was killed, or a list
of groups killed."
(interactive "P")
(let ((buffer-read-only nil)
(groups (gnus-group-process-prefix n))
group entry level out)
(if (< (length groups) 10)
;; This is faster when there are few groups.
(while groups
(push (setq group (pop groups)) out)
(gnus-group-remove-mark group)
(setq level (gnus-group-group-level))
(gnus-delete-line)
(when (and (not discard)
(setq entry (gnus-gethash group gnus-newsrc-hashtb)))
(gnus-undo-register
`(progn
(gnus-group-goto-group ,(gnus-group-group-name))
(gnus-group-yank-group)))
(push (cons (car entry) (nth 2 entry))
gnus-list-of-killed-groups))
(gnus-group-change-level
(if entry entry group) gnus-level-killed (if entry nil level))
(message "Killed group %s" group))
;; If there are lots and lots of groups to be killed, we use
;; this thing instead.
(let (entry)
(setq groups (nreverse groups))
(while groups
(gnus-group-remove-mark (setq group (pop groups)))
(gnus-delete-line)
(push group gnus-killed-list)
(setq gnus-newsrc-alist
(delq (assoc group gnus-newsrc-alist)
gnus-newsrc-alist))
(when gnus-group-change-level-function
(funcall gnus-group-change-level-function
group gnus-level-killed 3))
(cond
((setq entry (gnus-gethash group gnus-newsrc-hashtb))
(push (cons (car entry) (nth 2 entry))
gnus-list-of-killed-groups)
(setcdr (cdr entry) (cdddr entry)))
((member group gnus-zombie-list)
(setq gnus-zombie-list (delete group gnus-zombie-list))))
;; There may be more than one instance displayed.
(while (gnus-group-goto-group group)
(gnus-delete-line)))
(gnus-make-hashtable-from-newsrc-alist)))
(gnus-group-position-point)
(if (< (length out) 2) (car out) (nreverse out))))
(defun gnus-group-yank-group (&optional arg)
"Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
The numeric ARG specifies how many newsgroups are to be yanked. The
name of the newsgroup yanked is returned, or (if several groups are
yanked) a list of yanked groups is returned."
(interactive "p")
(setq arg (or arg 1))
(let (info group prev out)
(while (>= (decf arg) 0)
(when (not (setq info (pop gnus-list-of-killed-groups)))
(error "No more newsgroups to yank"))
(push (setq group (nth 1 info)) out)
;; Find which newsgroup to insert this one before - search
;; backward until something suitable is found. If there are no
;; other newsgroups in this buffer, just make this newsgroup the
;; first newsgroup.
(setq prev (gnus-group-group-name))
(gnus-group-change-level
info (gnus-info-level (cdr info)) gnus-level-killed
(and prev (gnus-gethash prev gnus-newsrc-hashtb))
t)
(gnus-group-insert-group-line-info group)
(gnus-undo-register
`(when (gnus-group-goto-group ,group)
(gnus-group-kill-group 1))))
(forward-line -1)
(gnus-group-position-point)
(if (< (length out) 2) (car out) (nreverse out))))
(defun gnus-group-kill-level (level)
"Kill all groups that is on a certain LEVEL."
(interactive "nKill all groups on level: ")
(cond
((= level gnus-level-zombie)
(setq gnus-killed-list
(nconc gnus-zombie-list gnus-killed-list))
(setq gnus-zombie-list nil))
((and (< level gnus-level-zombie)
(> level 0)
(or gnus-expert-user
(gnus-yes-or-no-p
(format
"Do you really want to kill all groups on level %d? "
level))))
(let* ((prev gnus-newsrc-alist)
(alist (cdr prev)))
(while alist
(if (= (gnus-info-level (car alist)) level)
(progn
(push (gnus-info-group (car alist)) gnus-killed-list)
(setcdr prev (cdr alist)))
(setq prev alist))
(setq alist (cdr alist)))
(gnus-make-hashtable-from-newsrc-alist)
(gnus-group-list-groups)))
(t
(error "Can't kill; invalid level: %d" level))))
(defun gnus-group-list-all-groups (&optional arg)
"List all newsgroups with level ARG or lower.
Default is gnus-level-unsubscribed, which lists all subscribed and most
unsubscribed groups."
(interactive "P")
(gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
;; Redefine this to list ALL killed groups if prefix arg used.
;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
(defun gnus-group-list-killed (&optional arg)
"List all killed newsgroups in the group buffer.
If ARG is non-nil, list ALL killed groups known to Gnus. This may
entail asking the server for the groups."
(interactive "P")
;; Find all possible killed newsgroups if arg.
(when arg
(gnus-get-killed-groups))
(if (not gnus-killed-list)
(gnus-message 6 "No killed groups")
(let (gnus-group-list-mode)
(funcall gnus-group-prepare-function
gnus-level-killed t gnus-level-killed))
(goto-char (point-min)))
(gnus-group-position-point))
(defun gnus-group-list-zombies ()
"List all zombie newsgroups in the group buffer."
(interactive)
(if (not gnus-zombie-list)
(gnus-message 6 "No zombie groups")
(let (gnus-group-list-mode)
(funcall gnus-group-prepare-function
gnus-level-zombie t gnus-level-zombie))
(goto-char (point-min)))
(gnus-group-position-point))
(defun gnus-group-list-active ()
"List all groups that are available from the server(s)."
(interactive)
;; First we make sure that we have really read the active file.
(unless (gnus-read-active-file-p)
(let ((gnus-read-active-file t)
(gnus-agent nil)) ; Trick the agent into ignoring the active file.
(gnus-read-active-file)))
;; Find all groups and sort them.
(let ((groups
(sort
(let (list)
(mapatoms
(lambda (sym)
(and (boundp sym)
(symbol-value sym)
(push (symbol-name sym) list)))
gnus-active-hashtb)
list)
'string<))
(buffer-read-only nil)
group)
(erase-buffer)
(while groups
(setq group (pop groups))
(gnus-add-text-properties
(point) (prog1 (1+ (point))
(insert " *: "
(gnus-group-name-decode group
(gnus-group-name-charset
nil group))
"\n"))
(list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
'gnus-unread t
'gnus-level (inline (gnus-group-level group)))))
(goto-char (point-min))))
(defun gnus-activate-all-groups (level)
"Activate absolutely all groups."
(interactive (list gnus-level-unsubscribed))
(let ((gnus-activate-level level)
(gnus-activate-foreign-newsgroups level))
(gnus-group-get-new-news)))
(defun gnus-group-get-new-news (&optional arg)
"Get newly arrived articles.
If ARG is a number, it specifies which levels you are interested in
re-scanning. If ARG is non-nil and not a number, this will force
\"hard\" re-reading of the active files from all servers."
(interactive "P")
(require 'nnmail)
(let ((gnus-inhibit-demon t)
;; Binding this variable will inhibit multiple fetchings
;; of the same mail source.
(nnmail-fetched-sources (list t)))
(gnus-run-hooks 'gnus-get-new-news-hook)
;; Read any slave files.
(unless gnus-slave
(gnus-master-read-slave-newsrc))
;; We might read in new NoCeM messages here.
(when (and gnus-use-nocem
(null arg))
(gnus-nocem-scan-groups))
;; If ARG is not a number, then we read the active file.
(when (and arg (not (numberp arg)))
(let ((gnus-read-active-file t))
(gnus-read-active-file))
(setq arg nil)
;; If the user wants it, we scan for new groups.
(when (eq gnus-check-new-newsgroups 'always)
(gnus-find-new-newsgroups)))
(setq arg (gnus-group-default-level arg t))
(if (and gnus-read-active-file (not arg))
(progn
(gnus-read-active-file)
(gnus-get-unread-articles arg))
(let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
(gnus-get-unread-articles arg)))
(gnus-run-hooks 'gnus-after-getting-new-news-hook)
(gnus-group-list-groups (and (numberp arg)
(max (car gnus-group-list-mode) arg)))))
(defun gnus-group-get-new-news-this-group (&optional n dont-scan)
"Check for newly arrived news in the current group (and the N-1 next groups).
The difference between N and the number of newsgroup checked is returned.
If N is negative, this group and the N-1 previous groups will be checked."
(interactive "P")
(let* ((groups (gnus-group-process-prefix n))
(ret (if (numberp n) (- n (length groups)) 0))
(beg (unless n
(point)))
group method
(gnus-inhibit-demon t)
;; Binding this variable will inhibit multiple fetchings
;; of the same mail source.
(nnmail-fetched-sources (list t)))
(gnus-run-hooks 'gnus-get-new-news-hook)
(while (setq group (pop groups))
(gnus-group-remove-mark group)
;; Bypass any previous denials from the server.
(gnus-remove-denial (setq method (gnus-find-method-for-group group)))
(if (gnus-activate-group group (if dont-scan nil 'scan))
(progn
(gnus-get-unread-articles-in-group
(gnus-get-info group) (gnus-active group) t)
(unless (gnus-virtual-group-p group)
(gnus-close-group group))
(when gnus-agent
(gnus-agent-save-group-info
method (gnus-group-real-name group) (gnus-active group)))
(gnus-group-update-group group))
(if (eq (gnus-server-status (gnus-find-method-for-group group))
'denied)
(gnus-error 3 "Server denied access")
(gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
(when beg
(goto-char beg))
(when gnus-goto-next-group-when-activating
(gnus-group-next-unread-group 1 t))
(gnus-summary-position-point)
ret))
(defun gnus-group-fetch-faq (group &optional faq-dir)
"Fetch the FAQ for the current group.
If given a prefix argument, prompt for the FAQ dir
to use."
(interactive
(list
(gnus-group-group-name)
(when current-prefix-arg
(completing-read
"Faq dir: " (and (listp gnus-group-faq-directory)
(mapcar (lambda (file) (list file))
gnus-group-faq-directory))))))
(unless group
(error "No group name given"))
(let ((dirs (or faq-dir gnus-group-faq-directory))
dir found file)
(unless (listp dirs)
(setq dirs (list dirs)))
(while (and (not found)
(setq dir (pop dirs)))
(let ((name (gnus-group-real-name group)))
(setq file (concat (file-name-as-directory dir) name)))
(if (not (file-exists-p file))
(gnus-message 1 "No such file: %s" file)
(let ((enable-local-variables nil))
(find-file file)
(setq found t))))))
(defun gnus-group-describe-group (force &optional group)
"Display a description of the current newsgroup."
(interactive (list current-prefix-arg (gnus-group-group-name)))
(let* ((method (gnus-find-method-for-group group))
(mname (gnus-group-prefixed-name "" method))
desc)
(when (and force
gnus-description-hashtb)
(gnus-sethash mname nil gnus-description-hashtb))
(unless group
(error "No group name given"))
(when (or (and gnus-description-hashtb
;; We check whether this group's method has been
;; queried for a description file.
(gnus-gethash mname gnus-description-hashtb))
(setq desc (gnus-group-get-description group))
(gnus-read-descriptions-file method))
(gnus-message 1
(or desc (gnus-gethash group gnus-description-hashtb)
"No description available")))))
;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
(defun gnus-group-describe-all-groups (&optional force)
"Pop up a buffer with descriptions of all newsgroups."
(interactive "P")
(when force
(setq gnus-description-hashtb nil))
(when (not (or gnus-description-hashtb
(gnus-read-all-descriptions-files)))
(error "Couldn't request descriptions file"))
(let ((buffer-read-only nil)
b)
(erase-buffer)
(mapatoms
(lambda (group)
(setq b (point))
(let ((charset (gnus-group-name-charset nil (symbol-name group))))
(insert (format " *: %-20s %s\n"
(gnus-group-name-decode
(symbol-name group) charset)
(gnus-group-name-decode
(symbol-value group) charset))))
(gnus-add-text-properties
b (1+ b) (list 'gnus-group group
'gnus-unread t 'gnus-marked nil
'gnus-level (1+ gnus-level-subscribed))))
gnus-description-hashtb)
(goto-char (point-min))
(gnus-group-position-point)))
;; Suggested by Daniel Quinlan <quinlan@best.com>.
(defun gnus-group-apropos (regexp &optional search-description)
"List all newsgroups that have names that match a regexp."
(interactive "sGnus apropos (regexp): ")
(let ((prev "")
(obuf (current-buffer))
groups des)
;; Go through all newsgroups that are known to Gnus.
(mapatoms
(lambda (group)
(and (symbol-name group)
(string-match regexp (symbol-name group))
(symbol-value group)
(push (symbol-name group) groups)))
gnus-active-hashtb)
;; Also go through all descriptions that are known to Gnus.
(when search-description
(mapatoms
(lambda (group)
(and (string-match regexp (symbol-value group))
(push (symbol-name group) groups)))
gnus-description-hashtb))
(if (not groups)
(gnus-message 3 "No groups matched \"%s\"." regexp)
;; Print out all the groups.
(save-excursion
(pop-to-buffer "*Gnus Help*")
(buffer-disable-undo)
(erase-buffer)
(setq groups (sort groups 'string<))
(while groups
;; Groups may be entered twice into the list of groups.
(when (not (string= (car groups) prev))
(setq prev (car groups))
(let ((charset (gnus-group-name-charset nil prev)))
(insert (gnus-group-name-decode prev charset) "\n")
(when (and gnus-description-hashtb
(setq des (gnus-gethash (car groups)
gnus-description-hashtb)))
(insert " " (gnus-group-name-decode des charset) "\n"))))
(setq groups (cdr groups)))
(goto-char (point-min))))
(pop-to-buffer obuf)))
(defun gnus-group-description-apropos (regexp)
"List all newsgroups that have names or descriptions that match a regexp."
(interactive "sGnus description apropos (regexp): ")
(when (not (or gnus-description-hashtb
(gnus-read-all-descriptions-files)))
(error "Couldn't request descriptions file"))
(gnus-group-apropos regexp t))
;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
(defun gnus-group-list-matching (level regexp &optional all lowest)
"List all groups with unread articles that match REGEXP.
If the prefix LEVEL is non-nil, it should be a number that says which
level to cut off listing groups.
If ALL, also list groups with no unread articles.
If LOWEST, don't list groups with level lower than LOWEST.
This command may read the active file."
(interactive "P\nsList newsgroups matching: ")
;; First make sure active file has been read.
(when (and level
(> (prefix-numeric-value level) gnus-level-killed))
(gnus-get-killed-groups))
(gnus-group-prepare-flat
(or level gnus-level-subscribed) all (or lowest 1) regexp)
(goto-char (point-min))
(gnus-group-position-point))
(defun gnus-group-list-all-matching (level regexp &optional lowest)
"List all groups that match REGEXP.
If the prefix LEVEL is non-nil, it should be a number that says which
level to cut off listing groups.
If LOWEST, don't list groups with level lower than LOWEST."
(interactive "P\nsList newsgroups matching: ")
(when level
(setq level (prefix-numeric-value level)))
(gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
(defun gnus-group-save-newsrc (&optional force)
"Save the Gnus startup files.
If FORCE, force saving whether it is necessary or not."
(interactive "P")
(gnus-save-newsrc-file force))
(defun gnus-group-restart (&optional arg)
"Force Gnus to read the .newsrc file."
(interactive "P")
(when (gnus-yes-or-no-p
(format "Are you sure you want to restart Gnus? "))
(gnus-save-newsrc-file)
(gnus-clear-system)
(gnus)))
(defun gnus-group-read-init-file ()
"Read the Gnus elisp init file."
(interactive)
(gnus-read-init-file)
(gnus-message 5 "Read %s" gnus-init-file))
(defun gnus-group-check-bogus-groups (&optional silent)
"Check bogus newsgroups.
If given a prefix, don't ask for confirmation before removing a bogus
group."
(interactive "P")
(gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
(gnus-group-list-groups))
(defun gnus-group-find-new-groups (&optional arg)
"Search for new groups and add them.
Each new group will be treated with `gnus-subscribe-newsgroup-method.'
With 1 C-u, use the `ask-server' method to query the server for new
groups.
With 2 C-u's, use most complete method possible to query the server
for new groups, and subscribe the new groups as zombies."
(interactive "p")
(gnus-find-new-newsgroups (or arg 1))
(gnus-group-list-groups))
(defun gnus-group-edit-global-kill (&optional article group)
"Edit the global kill file.
If GROUP, edit that local kill file instead."
(interactive "P")
(setq gnus-current-kill-article article)
(gnus-kill-file-edit-file group)
(gnus-message
6
(substitute-command-keys
(format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
(if group "local" "global")))))
(defun gnus-group-edit-local-kill (article group)
"Edit a local kill file."
(interactive (list nil (gnus-group-group-name)))
(gnus-group-edit-global-kill article group))
(defun gnus-group-force-update ()
"Update `.newsrc' file."
(interactive)
(gnus-save-newsrc-file))
(defun gnus-group-suspend ()
"Suspend the current Gnus session.
In fact, cleanup buffers except for group mode buffer.
The hook gnus-suspend-gnus-hook is called before actually suspending."
(interactive)
(gnus-run-hooks 'gnus-suspend-gnus-hook)
;; Kill Gnus buffers except for group mode buffer.
(let ((group-buf (get-buffer gnus-group-buffer)))
(mapcar (lambda (buf)
(unless (member buf (list group-buf gnus-dribble-buffer))
(kill-buffer buf)))
(gnus-buffers))
(gnus-kill-gnus-frames)
(when group-buf
(bury-buffer group-buf)
(delete-windows-on group-buf t))))
(defun gnus-group-clear-dribble ()
"Clear all information from the dribble buffer."
(interactive)
(gnus-dribble-clear)
(gnus-message 7 "Cleared dribble buffer"))
(defun gnus-group-exit ()
"Quit reading news after updating .newsrc.eld and .newsrc.
The hook `gnus-exit-gnus-hook' is called before actually exiting."
(interactive)
(when
(or noninteractive ;For gnus-batch-kill
(not gnus-interactive-exit) ;Without confirmation
gnus-expert-user
(gnus-y-or-n-p "Are you sure you want to quit reading news? "))
(gnus-run-hooks 'gnus-exit-gnus-hook)
;; Offer to save data from non-quitted summary buffers.
(gnus-offer-save-summaries)
;; Save the newsrc file(s).
(gnus-save-newsrc-file)
;; Kill-em-all.
(gnus-close-backends)
;; Reset everything.
(gnus-clear-system)
;; Allow the user to do things after cleaning up.
(gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
(defun gnus-group-quit ()
"Quit reading news without updating .newsrc.eld or .newsrc.
The hook `gnus-exit-gnus-hook' is called before actually exiting."
(interactive)
(when (or noninteractive ;For gnus-batch-kill
(zerop (buffer-size))
(not (gnus-server-opened gnus-select-method))
gnus-expert-user
(not gnus-current-startup-file)
(gnus-yes-or-no-p
(format "Quit reading news without saving %s? "
(file-name-nondirectory gnus-current-startup-file))))
(gnus-run-hooks 'gnus-exit-gnus-hook)
(gnus-configure-windows 'group t)
(gnus-dribble-save)
(gnus-close-backends)
(gnus-clear-system)
(gnus-kill-buffer gnus-group-buffer)
;; Allow the user to do things after cleaning up.
(gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
(defun gnus-group-describe-briefly ()
"Give a one line description of the group mode commands."
(interactive)
(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")))
(defun gnus-group-browse-foreign-server (method)
"Browse a foreign news server.
If called interactively, this function will ask for a select method
(nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
If not, METHOD should be a list where the first element is the method
and the second element is the address."
(interactive
(list (let ((how (completing-read
"Which backend: "
(append gnus-valid-select-methods gnus-server-alist)
nil t (cons "nntp" 0) 'gnus-method-history)))
;; We either got a backend name or a virtual server name.
;; If the first, we also need an address.
(if (assoc how gnus-valid-select-methods)
(list (intern how)
;; Suggested by mapjph@bath.ac.uk.
(completing-read
"Address: "
(mapcar (lambda (server) (list server))
gnus-secondary-servers)))
;; We got a server name.
how))))
(gnus-browse-foreign-server method))
(defun gnus-group-set-info (info &optional method-only-group part)
(when (or info part)
(let* ((entry (gnus-gethash
(or method-only-group (gnus-info-group info))
gnus-newsrc-hashtb))
(part-info info)
(info (if method-only-group (nth 2 entry) info))
method)
(when method-only-group
(unless entry
(error "Trying to change non-existent group %s" method-only-group))
;; We have received parts of the actual group info - either the
;; select method or the group parameters. We first check
;; whether we have to extend the info, and if so, do that.
(let ((len (length info))
(total (if (eq part 'method) 5 6)))
(when (< len total)
(setcdr (nthcdr (1- len) info)
(make-list (- total len) nil)))
;; Then we enter the new info.
(setcar (nthcdr (1- total) info) part-info)))
(unless entry
;; This is a new group, so we just create it.
(save-excursion
(set-buffer gnus-group-buffer)
(setq method (gnus-info-method info))
(when (gnus-server-equal method "native")
(setq method nil))
(save-excursion
(set-buffer gnus-group-buffer)
(if method
;; It's a foreign group...
(gnus-group-make-group
(gnus-group-real-name (gnus-info-group info))
(if (stringp method) method
(prin1-to-string (car method)))
(and (consp method)
(nth 1 (gnus-info-method info))))
;; It's a native group.
(gnus-group-make-group (gnus-info-group info))))
(gnus-message 6 "Note: New group created")
(setq entry
(gnus-gethash (gnus-group-prefixed-name
(gnus-group-real-name (gnus-info-group info))
(or (gnus-info-method info) gnus-select-method))
gnus-newsrc-hashtb))))
;; Whether it was a new group or not, we now have the entry, so we
;; can do the update.
(if entry
(progn
(setcar (nthcdr 2 entry) info)
(when (and (not (eq (car entry) t))
(gnus-active (gnus-info-group info)))
(setcar entry (length (gnus-list-of-unread-articles (car info))))))
(error "No such group: %s" (gnus-info-group info))))))
(defun gnus-group-set-method-info (group select-method)
(gnus-group-set-info select-method group 'method))
(defun gnus-group-set-params-info (group params)
(gnus-group-set-info params group 'params))
(defun gnus-add-marked-articles (group type articles &optional info force)
;; Add ARTICLES of TYPE to the info of GROUP.
;; If INFO is non-nil, use that info. If FORCE is non-nil, don't
;; add, but replace marked articles of TYPE with ARTICLES.
(let ((info (or info (gnus-get-info group)))
marked m)
(or (not info)
(and (not (setq marked (nthcdr 3 info)))
(or (null articles)
(setcdr (nthcdr 2 info)
(list (list (cons type (gnus-compress-sequence
articles t)))))))
(and (not (setq m (assq type (car marked))))
(or (null articles)
(setcar marked
(cons (cons type (gnus-compress-sequence articles t) )
(car marked)))))
(if force
(if (null articles)
(setcar (nthcdr 3 info)
(gnus-delete-alist type (car marked)))
(setcdr m (gnus-compress-sequence articles t)))
(setcdr m (gnus-compress-sequence
(sort (nconc (gnus-uncompress-range (cdr m))
(copy-sequence articles)) '<) t))))))
;;;
;;; Group timestamps
;;;
(defun gnus-group-set-timestamp ()
"Change the timestamp of the current group to the current time.
This function can be used in hooks like `gnus-select-group-hook'
or `gnus-group-catchup-group-hook'."
(when gnus-newsgroup-name
(let ((time (current-time)))
(setcdr (cdr time) nil)
(gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
(defsubst gnus-group-timestamp (group)
"Return the timestamp for GROUP."
(gnus-group-get-parameter group 'timestamp t))
(defun gnus-group-timestamp-delta (group)
"Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
(let* ((time (or (gnus-group-timestamp group)
(list 0 0)))
(delta (subtract-time (current-time) time)))
(+ (* (nth 0 delta) 65536.0)
(nth 1 delta))))
(defun gnus-group-timestamp-string (group)
"Return a string of the timestamp for GROUP."
(let ((time (gnus-group-timestamp group)))
(if (not time)
""
(gnus-time-iso8601 time))))
(defun gnus-group-prepare-flat-list-dead-predicate
(groups level mark predicate)
(let (group)
(if predicate
;; This loop is used when listing groups that match some
;; regexp.
(while (setq group (pop groups))
(when (funcall predicate group)
(gnus-add-text-properties
(point) (prog1 (1+ (point))
(insert " " mark " *: "
(gnus-group-name-decode group
(gnus-group-name-charset
nil group))
"\n"))
(list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
'gnus-unread t
'gnus-level level)))))))
(defun gnus-group-prepare-flat-predicate (level predicate &optional lowest
dead-predicate)
"List all newsgroups with unread articles of level LEVEL or lower.
If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
If PREDICATE, only list groups which PREDICATE returns non-nil.
If DEAD-PREDICATE, list dead groups which DEAD-PREDICATE returns non-nil."
(set-buffer gnus-group-buffer)
(let ((buffer-read-only nil)
(newsrc (cdr gnus-newsrc-alist))
(lowest (or lowest 1))
info clevel unread group params)
(erase-buffer)
;; List living groups.
(while newsrc
(setq info (car newsrc)
group (gnus-info-group info)
params (gnus-info-params info)
newsrc (cdr newsrc)
unread (car (gnus-gethash group gnus-newsrc-hashtb)))
(and unread ; This group might be unchecked
(funcall predicate info)
(<= (setq clevel (gnus-info-level info)) level)
(>= clevel lowest)
(gnus-group-insert-group-line
group (gnus-info-level info)
(gnus-info-marks info) unread (gnus-info-method info))))
;; List dead groups.
(and (>= level gnus-level-zombie) (<= lowest gnus-level-zombie)
(gnus-group-prepare-flat-list-dead-predicate
(setq gnus-zombie-list (sort gnus-zombie-list 'string<))
gnus-level-zombie ?Z
dead-predicate))
(and (>= level gnus-level-killed) (<= lowest gnus-level-killed)
(gnus-group-prepare-flat-list-dead-predicate
(setq gnus-killed-list (sort gnus-killed-list 'string<))
gnus-level-killed ?K dead-predicate))
(gnus-group-set-mode-line)
(setq gnus-group-list-mode (cons level t))
(gnus-run-hooks 'gnus-group-prepare-hook)
t))
(defun gnus-group-list-cached (level &optional lowest)
"List all groups with cached articles.
If the prefix LEVEL is non-nil, it should be a number that says which
level to cut off listing groups.
If LOWEST, don't list groups with level lower than LOWEST.
This command may read the active file."
(interactive "P")
(when level
(setq level (prefix-numeric-value level)))
(when (or (not level) (>= level gnus-level-zombie))
(gnus-cache-open))
(gnus-group-prepare-flat-predicate (or level gnus-level-subscribed)
#'(lambda (info)
(let ((marks (gnus-info-marks info)))
(assq 'cache marks)))
lowest
#'(lambda (group)
(or (gnus-gethash group
gnus-cache-active-hashtb)
;; Cache active file might use "."
;; instead of ":".
(gnus-gethash
(mapconcat 'identity
(split-string group ":")
".")
gnus-cache-active-hashtb))))
(goto-char (point-min))
(gnus-group-position-point))
(defun gnus-group-list-dormant (level &optional lowest)
"List all groups with dormant articles.
If the prefix LEVEL is non-nil, it should be a number that says which
level to cut off listing groups.
If LOWEST, don't list groups with level lower than LOWEST.
This command may read the active file."
(interactive "P")
(when level
(setq level (prefix-numeric-value level)))
(when (or (not level) (>= level gnus-level-zombie))
(gnus-cache-open))
(gnus-group-prepare-flat-predicate (or level gnus-level-subscribed)
#'(lambda (info)
(let ((marks (gnus-info-marks info)))
(assq 'dormant marks)))
lowest)
(goto-char (point-min))
(gnus-group-position-point))
(provide 'gnus-group)
;;; gnus-group.el ends here
Reference in New Issue View Git Blame Copy Permalink