| blob | cdac6e3e628d7e4c2326287348f7ff165daf8a1c |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
5 ;; 2010, 2011 Free Software Foundation, Inc.
7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; Keywords: news, mail
10 ;; Version: 5.13
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;;; Code:
33 ;; For Emacs <22.2 and XEmacs.
42 ;; These are defined afterwards with gnus-define-group-parameter
56 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
61 "Starting your favorite newsreader."
65 "Dealing with formatting issues."
69 "Group character set issues."
75 "Cache interface."
80 "Article Registry."
84 "Server options at startup."
87 ;; These belong to gnus-group.el.
89 "Group buffers."
94 "Foreign groups."
99 "Automatic subscription of new groups."
103 "Group levels."
108 "Selecting a Group."
113 "Showing slices of the group list."
118 "Sorting the group buffer."
124 "Various group options."
128 ;; These belong to gnus-sum.el.
130 "Summary buffers."
135 "Leaving summary buffers."
140 "Marks used in summary buffers."
145 "Ordering articles according to replies."
150 "Formatting of the summary buffer."
155 "Choosing Articles."
160 "Summary movement commands."
165 "Show pictures of people, domains, and newsgroups."
169 "Mail group commands."
174 "Sorting the summary buffer."
179 "Highlighting and menus in the summary buffer."
185 "Various summary buffer options."
190 "Pick mode in the summary buffer."
196 "Tree display of threads in the summary buffer."
201 ;; Belongs to gnus-uu.el
203 "Viewing extracted files."
207 ;; Belongs to gnus-score.el
209 "Score and kill file handling."
213 "Kill files."
217 "Adaptive score files."
221 "Default values for score files."
225 "Expiring score rules."
229 "Decaying score rules."
233 "Score and kill file names."
238 "Various scoring and killing options."
241 ;; Other
243 "Options controlling the visual fluff."
248 "Offline support for Gnus."
252 "Files used by Gnus."
256 "Auto save file."
261 "Storing Gnus state."
265 "Options related to newsservers and other servers used by Gnus."
269 "Highlighting and menus in the server buffer."
274 "Composing replies and followups in Gnus."
278 "Meta variables controlling major portions of Gnus.
279 In general, modifying these variables does not take affect until Gnus
280 is restarted, and sometimes reloaded."
284 "Other Gnus options."
289 "Exiting Gnus."
294 "Frivolous Gnus extensions."
305 "If non-nil, the startup message will not be displayed.
306 This variable is used before `.gnus.el' is loaded, so it should
307 be set in `.emacs' instead."
336 0 5
345 gnus-mode-line-image-cache)
347 "This is %s, %s."
349 str)
351 line)))
356 ;;(defalias 'gnus-decode-rfc1522 'ignore)
357 )
359 ;; We define these group faces here to avoid the display
360 ;; update forced when creating new faces.
370 ()))
371 "Level 1 newsgroup face."
373 ;; backward-compatibility alias
385 ()))
386 "Level 1 empty newsgroup face."
388 ;; backward-compatibility alias
400 ()))
401 "Level 2 newsgroup face."
403 ;; backward-compatibility alias
415 ()))
416 "Level 2 empty newsgroup face."
418 ;; backward-compatibility alias
430 ()))
431 "Level 3 newsgroup face."
433 ;; backward-compatibility alias
440 ())
443 ())
445 ()))
446 "Level 3 empty newsgroup face."
448 ;; backward-compatibility alias
460 ()))
461 "Level 4 newsgroup face."
463 ;; backward-compatibility alias
470 ())
473 ())
475 ()))
476 "Level 4 empty newsgroup face."
478 ;; backward-compatibility alias
490 ()))
491 "Level 5 newsgroup face."
493 ;; backward-compatibility alias
500 ())
503 ())
505 ()))
506 "Level 5 empty newsgroup face."
508 ;; backward-compatibility alias
520 ()))
521 "Level 6 newsgroup face."
523 ;; backward-compatibility alias
530 ())
533 ())
535 ()))
536 "Level 6 empty newsgroup face."
538 ;; backward-compatibility alias
550 ()))
551 "Low level newsgroup face."
553 ;; backward-compatibility alias
565 ()))
566 "Low level empty newsgroup face."
568 ;; backward-compatibility alias
581 "Level 1 mailgroup face."
583 ;; backward-compatibility alias
596 "Level 1 empty mailgroup face."
598 ;; backward-compatibility alias
611 "Level 2 mailgroup face."
613 ;; backward-compatibility alias
626 "Level 2 empty mailgroup face."
628 ;; backward-compatibility alias
641 "Level 3 mailgroup face."
643 ;; backward-compatibility alias
655 ()))
656 "Level 3 empty mailgroup face."
658 ;; backward-compatibility alias
671 "Low level mailgroup face."
673 ;; backward-compatibility alias
686 "Low level empty mailgroup face."
688 ;; backward-compatibility alias
692 ;; Summary mode faces.
695 "Face used for selected articles."
697 ;; backward-compatibility alias
704 "Face used for cancelled articles."
706 ;; backward-compatibility alias
719 "Face used for high interest ticked articles."
721 ;; backward-compatibility alias
734 "Face used for low interest ticked articles."
736 ;; backward-compatibility alias
748 ()))
749 "Face used for normal interest ticked articles."
751 ;; backward-compatibility alias
764 "Face used for high interest ancient articles."
766 ;; backward-compatibility alias
779 "Face used for low interest ancient articles."
781 ;; backward-compatibility alias
793 ()))
794 "Face used for normal interest ancient articles."
796 ;; backward-compatibility alias
807 "Face used for high interest uncached articles."
809 ;; backward-compatibility alias
820 "Face used for low interest uncached articles."
822 ;; backward-compatibility alias
833 "Face used for normal interest uncached articles."
835 ;; backward-compatibility alias
842 "Face used for high interest unread articles."
844 ;; backward-compatibility alias
851 "Face used for low interest unread articles."
853 ;; backward-compatibility alias
859 ()))
860 "Face used for normal interest unread articles."
862 ;; backward-compatibility alias
877 "Face used for high interest read articles."
879 ;; backward-compatibility alias
894 "Face used for low interest read articles."
896 ;; backward-compatibility alias
908 ()))
909 "Face used for normal interest read articles."
911 ;; backward-compatibility alias
916 ;;;
917 ;;; Gnus buffers
918 ;;;
924 "Do the same as `get-buffer-create', but store the created buffer."
929 "Add the current buffer to the list of Gnus buffers."
933 "Kill BUFFER and remove from the list of Gnus buffers."
940 "Return a list of live Gnus buffers."
949 gnus-buffers)
951 ;;; Splash screen.
964 ()))
965 "Face for the splash screen."
967 ;; backward-compatibility alias
981 "Indent rigidly using only spaces and no tabs."
987 ;; We translate tabs into spaces -- not everybody uses
988 ;; an 8-character tab.
993 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1017 "*Color styles used for the Gnus logo."
1019 gnus-logo-color-alist))
1029 "Insert startup message in current buffer."
1030 ;; Insert the message.
1035 ;; Make sure the library defining `image-load-path' is
1036 ;; loaded (`find-image' is autoloaded) (and discard the
1037 ;; result). Else, we may get "defvar ignored because
1038 ;; image-load-path is let-bound" when calling `find-image'
1039 ;; below.
1049 :color-symbols
1055 ;; Account for the pbm's background.
1059 ;; Account for the xbm's background.
1070 t)))
1073 _ ___ _ _
1074 _ ___ __ ___ __ _ ___
1075 __ _ ___ __ ___
1076 _ ___ _
1077 _ _ __ _
1078 ___ __ _
1079 __ _
1080 _ _ _
1081 _ _ _
1082 _ _ _
1083 __ ___
1084 _ _ _ _
1085 _ _
1086 _ _
1087 _ _
1088 _
1089 __
1092 ;; And then hack it.
1101 ;; Fontify some.
1114 ;;; Do the rest.
1120 "Alist of group parameters.
1122 For example:
1124 (gnus-use-scoring nil)
1125 (gnus-summary-line-format
1127 (gcc-self . t)
1128 (display . all))
1131 (broken-reply-to . t)))"
1138 "If it is t, ignore case of group names specified in `gnus-parameters'.
1139 If it is nil, don't ignore case. If it is `default', which is for the
1140 backward compatibility, use the value of `case-fold-search'."
1151 "Define a group parameter PARAM.
1152 REST is a plist of following:
1153 :type One of `bool', `list' or nil.
1154 :function The name of the function.
1155 :function-document The documentation of the function.
1156 :parameter-type The type for customizing the parameter.
1157 :parameter-document The documentation for the parameter.
1158 :variable The name of the variable.
1159 :variable-document The documentation for the variable.
1160 :variable-group The group for customizing the variable.
1161 :variable-type The type for customizing the variable.
1162 :variable-default The default value of the variable."
1179 'progn
1181 ,variable-document
1187 gnus-group-parameters-more))
1190 ,parameter-type
1194 ,function-document
1196 val)
1199 t)
1204 (,variable
1206 elem value)
1214 ,function-document
1218 elem value)
1225 'value
1230 All other Gnus file and directory variables are initialized from this variable."
1236 "*Directory variable from which all other Gnus file variables are derived.
1238 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1239 This means that other directory variables that are initialized from
1240 this variable won't be set properly if you set this variable in `.gnus.el'.
1241 Set this variable in `.emacs' instead."
1246 "*Default directory for all Gnus buffers."
1249 directory))
1251 ;; Site dependent variables. These variables should be defined in
1252 ;; paths.el.
1255 "Specify a default NNTP server.
1256 This variable should be defined in paths.el, and should never be set
1257 by the user.
1258 If you want to change servers, you should use `gnus-select-method'.
1262 "A file with only the name of the nntp server in it."
1268 "Find default nntp server.
1269 Check the NNTPSERVER environment variable and the
1270 `gnus-nntpserver-file' file."
1278 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1279 ;; starting or even loading Gnus.
1280 ;;;###autoload(when (fboundp 'custom-autoload)
1281 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1287 gnus-default-nntp-server)
1289 "Default method for selecting a newsgroup.
1290 This variable should be a list, where the first element is how the
1291 news is to be fetched, the second is the address.
1294 NNTP, you could say:
1298 If you want to use your local spool, say:
1300 \(setq gnus-select-method (list 'nnspool (system-name)))
1302 If you use this variable, you must set `gnus-nntp-server' to nil.
1304 There is a lot more to know about select methods and virtual servers -
1305 see the manual for details."
1312 "*Method used for archiving messages you've sent.
1313 This should be a mail method.
1315 See also `gnus-update-message-archive-method'."
1319 gnus-select-method))
1324 The archive method is initially set according to the value of
1326 so that it may be used as a real method of the server which is named
1328 updated if the value of this variable is nil, even if you change the
1329 value of `gnus-message-archive-method' afterward. If you want the
1331 `gnus-message-archive-method', set this variable to a non-nil value."
1338 "*Name of the group in which to save the messages you've written.
1339 This can either be a string; a list of strings; or an alist
1340 of regexps/functions/forms to be evaluated to return a string (or a list
1341 of strings). The functions are called with the name of the current
1342 group (or nil) as a parameter.
1344 If you want to save your mail in one group and the news articles you
1345 write in another group, you could say something like:
1347 \(setq gnus-message-archive-group
1348 '((if (message-news-p)
1352 Normally the group names returned by this variable should be
1354 However, you may wish to store the message on some other server. In
1355 that case, just return a fully prefixed name of the group --
1363 function
1364 sexp
1365 string))
1368 "List of NNTP servers that the user can choose between interactively.
1369 To make Gnus query you for a server, you have to give `gnus' a
1370 non-numeric prefix - `C-u M-x gnus', in short."
1376 "The name of the host running the NNTP server."
1379 string))
1383 "A list of secondary methods that will be used for reading news.
1384 This is a list where each element is a complete select method (see
1385 `gnus-select-method').
1387 If, for instance, you want to read your mail with the nnml back end,
1388 you could set this variable:
1395 "Local domain name without a host name.
1396 The DOMAINNAME environment variable is used instead if it is defined.
1397 If the function `system-name' returns the full Internet name, there is
1398 no need to set this variable."
1401 string))
1404 ;; Customization variables
1407 "Preferred method for fetching an article by Message-ID.
1408 If you are reading news from the local spool (with nnspool), fetching
1409 articles by Message-ID is painfully slow. By setting this method to an
1410 nntp method, you might get acceptable results.
1412 The value of this variable must be a valid select method as discussed
1413 in the documentation of `gnus-select-method'.
1415 It can also be a list of select methods, as well as the special symbol
1416 `current', which means to use the current select method. If it is a
1417 list, Gnus will try all the methods in the list until it finds a match."
1423 gnus-select-method
1431 gnus-select-method))))
1434 "*Non-nil means that cross referenced articles will be marked as read.
1435 If nil, ignore cross references. If t, mark articles as read in
1436 subscribed newsgroups. If neither t nor nil, mark as read in all
1437 newsgroups."
1445 "*Process mark."
1451 "*The number of articles which indicates a large newsgroup.
1452 If the number of articles in a newsgroup is greater than this value,
1453 confirmation is required for selecting the newsgroup.
1454 If it is nil, no confirmation is required.
1456 Also see `gnus-large-ephemeral-newsgroup'."
1459 integer))
1462 "Non-nil means that the default name of a file to save articles in is the group name.
1463 If it's nil, the directory form of the group name is used instead.
1465 If this variable is a list, and the list contains the element
1466 `not-score', long file names will not be used for score files; if it
1467 contains the element `not-save', long file names will not be used for
1468 saving; and if it contains the element `not-kill', long file names
1469 will not be used for kill files.
1471 Note that the default for this variable varies according to what system
1472 type you're using. On `usg-unix-v' this variable defaults to nil while
1473 on all other systems it defaults to t."
1491 "*If non-nil, save group scoring info."
1497 "*If non-nil, allow undoing in Gnus group mode buffers."
1502 "*If non-nil, use some adaptive scoring scheme.
1503 If a list, then the values `word' and `line' are meaningful. The
1504 former will perform adaption on individual words in the subject
1505 header while `line' will perform adaption on several headers."
1511 "*If nil, Gnus will ignore the article cache.
1512 If `passive', it will allow entering (and reading) articles
1513 explicitly entered into the cache. If anything else, use the
1514 cache to the full extent of the law."
1522 "*If non-nil, display a thread tree buffer."
1527 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1528 If it is a number N, then Gnus will only keep the last N articles
1529 read. If it is neither nil nor a number, Gnus will keep all read
1530 articles. This is not a good idea."
1533 integer
1538 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1543 "*If non-nil, enable scoring."
1549 "*A hook called when preparing to exit from the summary buffer.
1550 It calls `gnus-summary-expire-articles' by default."
1555 "*Non-nil means that you are a Usenet novice.
1556 If non-nil, verbose messages may be displayed and confirmations may be
1557 required."
1562 "*Non-nil means that you will never be asked for confirmation about anything.
1563 That doesn't mean *anything* anything; particularly destructive
1564 commands will still require prompting."
1569 "*If non-nil, require your confirmation when catching up a group."
1574 "*If non-nil, require your confirmation when exiting Gnus."
1579 "*Function for extracting address components from a From header.
1580 Two pre-defined function exist: `gnus-extract-address-components',
1581 which is the default, quite fast, and too simplistic solution, and
1582 `mail-extract-address-components', which works much better, but is
1583 slower."
1590 "String used to separate shell commands."
1614 "*An alist of valid select methods.
1615 The first element of each list lists should be a string with the name
1616 of the select method. The other elements may be the category of
1617 this method (i. e., `post', `mail', `none' or whatever) or other
1618 properties that this method has (like being respoolable).
1619 If you implement a new select method, all you should have to change is
1620 this variable. I think."
1636 "Recomputes the select-method widget based on the value of
1637 `gnus-valid-select-methods'."
1639 "Widget for entering a select method."
1646 gnus-valid-select-methods)
1650 :inline t
1652 variable
1658 "List of buffers that should update their mode lines.
1659 The list may contain the symbols `group', `article', `tree' and
1660 `summary'. If the corresponding symbol is present, Gnus will keep
1661 that mode line updated with information that may be pertinent.
1662 If this variable is nil, screen refresh may be quicker."
1670 "*Max length of mode-line non-string contents.
1671 If this is nil, Gnus will take space as is needed, leaving the rest
1672 of the mode line intact."
1676 integer))
1678 ;; There should be special validation for this.
1683 to-address
1684 :function-document
1685 "Return GROUP's to-address."
1686 :variable-document
1687 "*Alist of group regexps and correspondent to-addresses."
1688 :variable-group gnus-group-parameter
1691 This will be used when doing followups and posts.
1693 This is primarily useful in mail groups that represent closed
1694 mailing lists--mailing lists where it's expected that everybody that
1695 writes to the mailing list is subscribed to it. Since using this
1696 parameter ensures that the mail only goes to the mailing list itself,
1697 it means that members won't receive two copies of your followups.
1699 Using `to-address' will actually work whether the group is foreign or
1700 not. Let's say there's a group on the server that is called
1701 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1702 articles from a mail-to-news gateway. Posting directly to this group
1703 is therefore impossible--you have to send mail to the mailing list
1704 address instead.
1706 The gnus-group-split mail splitting mechanism will behave as if this
1710 to-list
1711 :function-document
1712 "Return GROUP's to-list."
1713 :variable-document
1714 "*Alist of group regexps and correspondent to-lists."
1715 :variable-group gnus-group-parameter
1718 This address will be used when doing a `a' in the group.
1720 It is totally ignored when doing a followup--except that if it is
1721 present in a news group, you'll get mail group semantics when doing
1722 `f'.
1724 The gnus-group-split mail splitting mechanism will behave as if this
1728 subscribed
1729 :type bool
1730 :function-document
1731 "Return GROUP's subscription status."
1732 :variable-document
1733 "*Groups which are automatically considered subscribed."
1734 :variable-group gnus-group-parameter
1737 Gnus assumed that you are subscribed to the To/List address.
1739 When constructing a list of subscribed groups using
1740 `gnus-find-subscribed-addresses', Gnus includes the To address given
1744 auto-expire
1745 :type bool
1746 :function gnus-group-auto-expirable-p
1747 :function-document
1748 "Check whether GROUP is auto-expirable or not."
1749 :variable gnus-auto-expirable-newsgroups
1750 :variable-default nil
1751 :variable-document
1752 "*Groups in which to automatically mark read articles as expirable.
1753 If non-nil, this should be a regexp that should match all groups in
1754 which to perform auto-expiry. This only makes sense for mail groups."
1755 :variable-group nnmail-expire
1757 regexp)
1759 :parameter-document
1763 total-expire
1764 :type bool
1765 :function gnus-group-total-expirable-p
1766 :function-document
1767 "Check whether GROUP is total-expirable or not."
1768 :variable gnus-total-expirable-newsgroups
1769 :variable-default nil
1770 :variable-document
1771 "*Groups in which to perform expiry of all read articles.
1772 Use with extreme caution. All groups that match this regexp will be
1773 expiring - which means that all read articles will be deleted after
1774 \(say) one week. (This only goes for mail groups and the like, of
1775 course.)"
1776 :variable-group nnmail-expire
1778 regexp)
1780 :parameter-document
1781 "All read articles will be put through the expiry process
1783 This happens even if they are not marked as expirable.
1787 charset
1788 :function-document
1789 "Return the default charset of GROUP."
1790 :variable gnus-group-charset-alist
1791 :variable-default
1804 :variable-document
1805 "Alist of regexps (to match group names) and default charsets to be used when reading."
1806 :variable-group gnus-charset
1814 post-method
1815 :type list
1816 :function-document
1817 "Return a posting method for GROUP."
1818 :variable gnus-post-method-alist
1819 :variable-document
1820 "Alist of regexps (to match group names) and method to be used when
1821 posting an article."
1822 :variable-group gnus-group-foreign
1823 :parameter-type
1831 :parameter-document
1835 large-newsgroup-initial
1836 :type integer
1837 :function-document
1838 "Return GROUP's initial input of the number of articles."
1839 :variable-document
1840 "*Alist of group regexps and its initial input of the number of articles."
1841 :variable-group gnus-group-parameter
1847 This number will be prompted as the initial value of the number of
1848 articles to list when the group is a large newsgroup (see
1849 `gnus-large-newsgroup'). If it is nil, the default value is the
1852 ;; The Gnus registry's ignored groups
1854 registry-ignore
1855 :type list
1856 :function-document
1857 "Whether this group should be ignored by the registry."
1858 :variable gnus-registry-ignored-groups
1859 :variable-default nil
1860 :variable-document
1861 "*Groups in which the registry should be turned off."
1862 :variable-group gnus-registry
1869 :parameter-document
1872 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1874 "*Disable the group parameters for spam detection.
1875 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1882 "Spam group classification (requires spam.el).
1883 This group contains spam messages. On summary entry, unread messages
1884 will be marked as spam. On summary exit, the specified spam
1885 processors will be invoked on spam-marked messages, then those
1886 messages will be expired, so the spam processor will only see a
1890 "The ham value for the spam group parameter (requires spam.el).
1891 On summary exit, the specified ham processors will be invoked on
1892 ham-marked messages. Exercise caution, since the ham processor will
1893 see the same message more than once because there is no ham message
1897 spam-contents
1898 :type list
1899 :function-document
1900 "The spam type (spam, ham, or neither) of the group."
1901 :variable gnus-spam-newsgroup-contents
1902 :variable-default nil
1903 :variable-document
1904 "*Group classification (spam, ham, or neither). Only
1905 meaningful when spam.el is loaded. If non-nil, this should be a
1906 list of group name regexps associated with a classification for
1907 each one. In spam groups, new articles are marked as spam on
1908 summary entry. There is other behavior associated with ham and
1909 no classification when spam.el is loaded - see the manual."
1910 :variable-group spam
1924 :parameter-document
1925 "The spam classification (spam, ham, or neither) of this group.
1926 When a spam group is entered, all unread articles are marked as
1927 spam. There is other behavior associated with ham and no
1931 spam-resend-to
1932 :type list
1933 :function-document
1934 "The address to get spam resent (through spam-report-resend)."
1935 :variable gnus-spam-resend-to
1936 :variable-default nil
1937 :variable-document
1938 "The address to get spam resent (through spam-report-resend)."
1939 :variable-group spam
1943 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1944 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1945 :parameter-document
1949 ham-resend-to
1950 :type list
1951 :function-document
1952 "The address to get ham resent (through spam-report-resend)."
1953 :variable gnus-ham-resend-to
1954 :variable-default nil
1955 :variable-document
1956 "The address to get ham resent (through spam-report-resend)."
1957 :variable-group spam
1961 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1962 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1963 :parameter-document
1979 "OBSOLETE: The Gmane reporting summary exit spam processor.
1986 "OBSOLETE: The ifile summary exit ham processor.
1990 "OBSOLETE: The Bogofilter summary exit ham processor.
1994 "OBSOLETE: The spam-stat summary exit ham processor.
1998 "OBSOLETE: The whitelist summary exit ham processor.
2002 "OBSOLETE: The BBDB summary exit ham processor.
2006 "OBSOLETE: The ham copy exit ham processor.
2010 "OBSOLETE: The spamoracle summary exit ham processor.
2014 spam-process
2015 :type list
2016 :parameter-type
2019 :value nil
2056 :function-document
2057 "Which spam or ham processors will be applied when the summary is exited."
2058 :variable gnus-spam-process-newsgroups
2059 :variable-default nil
2060 :variable-document
2061 "*Groups in which to automatically process spam or ham articles with
2062 a backend on summary exit. If non-nil, this should be a list of group
2063 name regexps that should match all groups in which to do automatic
2064 spam processing, associated with the appropriate processor."
2065 :variable-group spam
2066 :variable-type
2107 :parameter-document
2111 spam-autodetect
2112 :type list
2113 :parameter-type
2115 :function-document
2116 "Should spam be autodetected (with spam-split) in this group?"
2117 :variable gnus-spam-autodetect
2118 :variable-default nil
2119 :variable-document
2120 "*Groups in which spam should be autodetected when they are entered.
2121 Only unseen articles will be examined, unless
2122 spam-autodetect-recheck-messages is set."
2123 :variable-group spam
2124 :variable-type
2129 boolean))
2130 :parameter-document
2131 "Spam autodetection.
2132 Only unseen articles will be examined, unless
2136 spam-autodetect-methods
2137 :type list
2138 :parameter-type
2161 :function-document
2162 "Methods to be used for autodetection in each group"
2163 :variable gnus-spam-autodetect-methods
2164 :variable-default nil
2165 :variable-document
2166 "*Methods for autodetecting spam per group.
2167 Requires the spam-autodetect parameter. Only unseen articles
2168 will be examined, unless spam-autodetect-recheck-messages is
2169 set."
2170 :variable-group spam
2171 :variable-type
2198 :parameter-document
2199 "Spam autodetection methods.
2200 Requires the spam-autodetect parameter. Only unseen articles
2201 will be examined, unless spam-autodetect-recheck-messages is
2205 spam-process-destination
2206 :type list
2207 :parameter-type
2213 :function-document
2214 "Where spam-processed articles will go at summary exit."
2215 :variable gnus-spam-process-destinations
2216 :variable-default nil
2217 :variable-document
2218 "*Groups in which to explicitly send spam-processed articles to
2219 another group, or expire them (the default). If non-nil, this should
2220 be a list of group name regexps that should match all groups in which
2221 to do spam-processed article moving, associated with the destination
2222 group or nil for explicit expiration. This only makes sense for
2223 mail groups."
2224 :variable-group spam
2225 :variable-type
2236 :parameter-document
2240 ham-process-destination
2241 :type list
2242 :parameter-type
2250 :function-document
2251 "Where ham articles will go at summary exit from a spam group."
2252 :variable gnus-ham-process-destinations
2253 :variable-default nil
2254 :variable-document
2255 "*Groups in which to explicitly send ham articles to
2256 another group, or do nothing (the default). If non-nil, this should
2257 be a list of group name regexps that should match all groups in which
2258 to do ham article moving, associated with the destination
2259 group or nil for explicit ignoring. This only makes sense for
2260 mail groups, and only works in spam groups."
2261 :variable-group spam
2262 :variable-type
2274 :parameter-document
2278 ham-marks
2289 :parameter-document
2290 "Marks considered ham (positively not spam). Such articles will be
2291 processed as ham (non-spam) on group exit. When nil, the global
2292 spam-ham-marks variable takes precedence."
2294 gnus-read-mark
2295 gnus-killed-mark
2296 gnus-kill-file-mark
2297 gnus-low-score-mark))))
2298 :variable-group spam
2299 :variable-document
2303 spam-marks
2312 :parameter-document
2313 "Marks considered spam.
2314 Such articles will be processed as spam on group exit. When nil, the global
2315 spam-spam-marks variable takes precedence."
2317 :variable-group spam
2318 :variable-document
2322 "Number of group name elements to leave alone when making a short group name."
2327 "*If non-nil, once you set a level, Gnus will use this level."
2331 ;; Hooks.
2334 "A hook run while Gnus is loaded."
2339 "A hook called to apply kill files to a group.
2340 This hook is intended to apply a kill file to the selected newsgroup.
2341 The function `gnus-apply-kill-file' is called by default.
2343 Since a general kill file is too heavy to use only for a few
2344 newsgroups, I recommend you to use a lighter hook function. For
2345 example, if you'd like to apply a kill file to articles which contains
2346 a string `rmgroup' in subject in newsgroup `control', you can use the
2347 following hook:
2349 (setq gnus-apply-kill-hook
2350 (list
2351 (lambda ()
2360 "Function run when a group level is changed.
2361 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2364 function))
2366 ;;; Face thingies.
2370 mouse-face
2371 summary-menu group-menu article-menu
2372 tree-highlight menu highlight
2373 browse-menu server-menu
2374 page-marker tree-menu binary-menu pick-menu)
2375 "*Enable visual features.
2376 If `visual' is disabled, there will be no menus and few faces. Most of
2377 the visual customization options below will be ignored. Gnus will use
2378 less space and be faster as a result.
2380 This variable can also be a list of visual elements to switch on. For
2381 instance, to switch off all visual things except menus, you can say:
2383 (setq gnus-visual '(menu))
2385 Valid elements include `summary-highlight', `group-highlight',
2386 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2387 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2388 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2408 ;; Byte-compiler warning.
2410 ;; Find out whether the gnus-visual TYPE is wanted.
2414 gnus-visual
2418 t))))
2428 "*Face used for group or summary buffer mouse highlighting.
2429 The line beneath the mouse pointer will be highlighted with this
2430 face."
2443 "Controls use of the agent cache while plugged.
2444 When set, Gnus will prefer using the locally stored content rather
2445 than re-fetching it from the server. You also need to enable
2446 `gnus-agent' for this to have any affect."
2452 "Default charset assumed to be used when viewing non-ASCII characters.
2453 This variable is overridden on a group-to-group basis by the
2454 `gnus-group-charset-alist' variable and is only used on groups not
2455 covered by that variable."
2459 ;; Fixme: Doc reference to agent.
2461 "Whether we want to use the Gnus agent or not.
2463 You may customize gnus-agent to disable its use. However, some
2464 back ends have started to use the agent as a client-side cache.
2465 Disabling the agent may result in noticeable loss of performance."
2471 "Function called by the command `gnus-other-frame'."
2479 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2480 This should be an alist for Emacs, or a plist for XEmacs."
2491 "Which information should be exposed in the User-Agent header.
2493 Can be a list of symbols or a string. Valid symbols are `gnus'
2494 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2495 addition to the Emacs version, you can add `codename' \(show
2496 \(S\)XEmacs codename\) or either `config' \(show system
2497 configuration\) or `type' \(show system type\). If you set it to
2498 a string, be sure to use a valid format, see RFC 2616."
2511 ;; Convert old (< 2005-01-10) symbol type values:
2530 \f
2531 ;;; Internal variables
2536 ; Reset each time gnus-agent-covered-methods is changed else
2537 ; gnus-agent-method-p may mis-report a methods status.
2538 )
2548 ;; The carpal mode has been removed, but define the variable for
2549 ;; backwards compatability.
2568 ;; Variable holding the user answers to all method prompts.
2571 ;; Variable holding the user answers to all mail method prompts.
2574 ;; Variable holding the user answers to all group prompts.
2582 "*The directory where cached articles will be stored."
2588 nnspool "cache"
2612 ;; Propagate flags to server, with the following exceptions:
2613 ;; `seen' is private to each gnus installation
2614 ;; `cache' is a internal gnus flag for each gnus installation
2615 ;; `download' is a agent flag private to each gnus installation
2616 ;; `unsend' are for nndraft groups only
2617 ;; `score' is not a proper mark
2618 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2621 "Marks that shouldn't be propagated to back ends.
2622 Typical marks are those that make no sense in a standalone back end,
2623 such as a mark that says whether an article is stored in the cache
2636 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2661 gnus-newsrc-last-checked-date
2662 gnus-newsrc-alist gnus-server-alist
2663 gnus-killed-list gnus-zombie-list
2664 gnus-topic-topology gnus-topic-alist
2665 gnus-format-specs)
2669 "Assoc list of read articles.
2673 "Assoc list of registry data.
2700 ;; Save window configuration.
2713 ;;; End of variables.
2715 ;; Define some autoload functions Gnus might use.
2718 ;; This little mapcar goes through the list below and marks the
2719 ;; symbols in question as autoloaded functions.
2739 message-send-and-exit message-yank-original)
2743 ;; This is only used in message.el, which has an autoload.
2745 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2747 ;; Next two only used in gnus-util.
2748 rmail-summary-exists rmail-select-summary)
2749 ;; Only used in gnus-util, which has an autoload.
2754 gnus-Folder-save-name gnus-folder-save-name)
2757 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2758 gnus-demon-add-disconnection gnus-demon-add-handler
2759 gnus-demon-remove-handler)
2761 gnus-demon-init gnus-demon-cancel)
2763 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2764 gnus-face-from-file)
2766 gnus-tree-open gnus-tree-close)
2768 gnus-server-server-name)
2771 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2772 gnus-article-hide-citation gnus-article-fill-cited-article
2773 gnus-article-hide-citation-in-followups
2774 gnus-article-fill-cited-long-lines)
2776 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2777 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2779 gnus-cache-possibly-remove-articles gnus-cache-request-article
2780 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2781 gnus-cache-enter-remove-article gnus-cached-article-p
2782 gnus-cache-open gnus-cache-close gnus-cache-update-article
2783 gnus-cache-articles-in-group)
2785 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2787 gnus-summary-increase-score gnus-summary-set-score
2788 gnus-summary-raise-thread gnus-summary-raise-same-subject
2789 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2790 gnus-summary-lower-thread gnus-summary-lower-same-subject
2791 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2792 gnus-summary-current-score gnus-score-delta-default
2793 gnus-score-flush-cache gnus-score-close
2794 gnus-possibly-score-headers gnus-score-followup-article
2795 gnus-score-followup-thread)
2798 gnus-current-score-file-nondirectory gnus-score-adaptive
2799 gnus-score-find-trace gnus-score-file-name)
2803 gnus-subscribe-topics)
2807 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2808 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2809 gnus-uu-mark-by-regexp gnus-uu-mark-all
2810 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2811 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2812 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2813 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2814 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2815 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2816 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2817 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2820 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2822 gnus-group-post-news gnus-group-mail gnus-group-news
2823 gnus-summary-post-news gnus-summary-news-other-window
2824 gnus-summary-followup gnus-summary-followup-with-original
2825 gnus-summary-cancel-article gnus-summary-supersede-article
2826 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2827 gnus-summary-mail-forward gnus-summary-mail-other-window
2828 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2829 gnus-summary-wide-reply gnus-summary-followup-to-mail
2830 gnus-summary-followup-to-mail-with-original gnus-bug
2831 gnus-summary-wide-reply-with-original
2832 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2833 gnus-summary-post-forward)
2838 gnus-list-of-unread-articles gnus-list-of-read-articles
2839 gnus-offer-save-summaries gnus-make-thread-indent-array
2840 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2841 gnus-summary-skip-intangible gnus-summary-article-number
2842 gnus-data-header gnus-data-find)
2844 gnus-group-list-groups gnus-group-first-unread-group
2845 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2846 gnus-group-setup-buffer gnus-group-get-new-news
2847 gnus-group-make-help-group gnus-group-update-group
2848 gnus-group-iterate gnus-group-group-name)
2850 gnus-backlog-remove-article)
2852 gnus-article-prepare gnus-article-set-window-start
2853 gnus-article-next-page gnus-article-prev-page
2854 gnus-request-article-this-buffer gnus-article-mode
2855 gnus-article-setup-buffer gnus-narrow-to-page
2856 gnus-article-delete-invisible-text gnus-treat-article)
2858 gnus-article-hide-headers gnus-article-hide-boring-headers
2859 gnus-article-treat-overstrike
2860 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2861 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2862 gnus-article-de-base64-unreadable
2863 gnus-article-decode-HZ
2864 gnus-article-wash-html
2865 gnus-article-unsplit-urls
2866 gnus-article-hide-pem gnus-article-hide-signature
2867 gnus-article-strip-leading-blank-lines gnus-article-date-local
2868 gnus-article-date-original gnus-article-date-lapsed
2869 ;;gnus-article-show-all-headers
2870 gnus-article-edit-mode gnus-article-edit-article
2871 gnus-article-edit-done gnus-article-decode-encoded-words
2872 gnus-start-date-timer gnus-stop-date-timer
2873 gnus-mime-view-all-parts)
2876 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2877 gnus-check-reasonable-setup)
2879 gnus-dup-enter-articles)
2885 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2886 gnus-async-halt-prefetch)
2888 gnus-agent-save-active gnus-agent-method-p
2889 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2890 gnus-summary-set-agent-mark gnus-agent-save-group-info
2891 gnus-agent-request-article gnus-agent-retrieve-headers)
2893 gnus-unplugged gnus-agentize gnus-agent-batch)
2895 gnus-summary-save-article-vm)
2900 gnus-group-split-update)
2903 ;;; gnus-sum.el thingies
2907 "*The format specification of the lines in the summary buffer.
2909 It works along the same lines as a normal formatting string,
2910 with some simple extensions.
2912 %N Article number, left padded with spaces (string)
2913 %S Subject (string)
2915 %n Name of the poster (string)
2916 %a Extracted name of the poster (string)
2917 %A Extracted address of the poster (string)
2918 %F Contents of the From: header (string)
2919 %f Contents of the From: or To: headers (string)
2920 %x Contents of the Xref: header (string)
2921 %D Date of the article (string)
2922 %d Date of the article (string) in DD-MMM format
2923 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2924 %M Message-id of the article (string)
2925 %r References of the article (string)
2926 %c Number of characters in the article (integer)
2927 %k Pretty-printed version of the above (string)
2929 %L Number of lines in the article (integer)
2930 %I Indentation based on thread level (a string of spaces)
2931 %B A complex trn-style thread tree (string)
2932 The variables `gnus-sum-thread-*' can be used for customization.
2933 %T A string with two possible values: 80 spaces if the article
2934 is on thread level two or larger and 0 spaces on level one
2939 %> Spaces of length thread-level (string)
2940 %< Spaces of length (- 20 thread-level) (string)
2941 %i Article score (number)
2942 %z Article zcore (character)
2943 %t Number of articles under the current thread (number).
2944 %e Whether the thread is empty or not (character).
2945 %V Total thread score (number).
2946 %P The line number (number).
2947 %O Download mark (character).
2948 %* If present, indicates desired cursor position
2949 (instead of after first colon).
2950 %u User defined specifier. The next character in the format string should
2951 be a letter. Gnus will call the function gnus-user-format-function-X,
2952 where X is the letter following %u. The function will be passed the
2953 current header as argument. The function should return a string, which
2954 will be inserted into the summary just like information from any other
2955 summary specifier.
2957 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2958 with care. For reasons of efficiency, Gnus will compute what column
2960 it is invalid to have these specs after a variable-length spec. Well,
2961 you might not be arrested, but your summary buffer will look strange,
2962 which is bad enough.
2964 The smart choice is to have these specs as far to the left as
2965 possible.
2967 This restriction may disappear in later versions of Gnus.
2969 General format specifiers can also be used.
2970 See Info node `(gnus)Formatting Variables'."
2975 ;;;
2976 ;;; Skeleton keymaps
2977 ;;;
2982 (while keys
2983 (define-key keymap (pop keys) 'undefined))))
2985 (defvar gnus-article-mode-map
2986 (let ((keymap (make-sparse-keymap)))
2987 (gnus-suppress-keymap keymap)
2988 keymap))
2989 (defvar gnus-summary-mode-map
2990 (let ((keymap (make-keymap)))
2991 (gnus-suppress-keymap keymap)
2992 keymap))
2993 (defvar gnus-group-mode-map
2994 (let ((keymap (make-keymap)))
2995 (gnus-suppress-keymap keymap)
2996 keymap))
2998 \f
3000 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3001 ;; If you want the cursor to go somewhere else, set these two
3002 ;; functions in some startup hook to whatever you want.
3003 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3004 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3006 ;;; Various macros and substs.
3008 (defun gnus-header-from (header)
3009 (mail-header-from header))
3011 (defmacro gnus-gethash (string hashtable)
3012 "Get hash value of STRING in HASHTABLE."
3013 `(symbol-value (intern-soft ,string ,hashtable)))
3015 (defmacro gnus-gethash-safe (string hashtable)
3016 "Get hash value of STRING in HASHTABLE.
3017 Return nil if not defined."
3018 `(let ((sym (intern-soft ,string ,hashtable)))
3019 (and (boundp sym) (symbol-value sym))))
3021 (defmacro gnus-sethash (string value hashtable)
3022 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3023 `(set (intern ,string ,hashtable) ,value))
3024 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3026 (defmacro gnus-group-unread (group)
3027 "Get the currently computed number of unread articles in GROUP."
3028 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3030 (defmacro gnus-group-entry (group)
3031 "Get the newsrc entry for GROUP."
3032 `(gnus-gethash ,group gnus-newsrc-hashtb))
3034 (defmacro gnus-active (group)
3035 "Get active info on GROUP."
3036 `(gnus-gethash ,group gnus-active-hashtb))
3038 (defmacro gnus-set-active (group active)
3039 "Set GROUP's active info."
3040 `(gnus-sethash ,group ,active gnus-active-hashtb))
3042 ;; Info access macros.
3044 (defmacro gnus-info-group (info)
3045 `(nth 0 ,info))
3046 (defmacro gnus-info-rank (info)
3047 `(nth 1 ,info))
3048 (defmacro gnus-info-read (info)
3049 `(nth 2 ,info))
3050 (defmacro gnus-info-marks (info)
3051 `(nth 3 ,info))
3052 (defmacro gnus-info-method (info)
3053 `(nth 4 ,info))
3054 (defmacro gnus-info-params (info)
3055 `(nth 5 ,info))
3057 (defmacro gnus-info-level (info)
3058 `(let ((rank (gnus-info-rank ,info)))
3059 (if (consp rank)
3060 (car rank)
3061 rank)))
3062 (defmacro gnus-info-score (info)
3063 `(let ((rank (gnus-info-rank ,info)))
3064 (or (and (consp rank) (cdr rank)) 0)))
3066 (defmacro gnus-info-set-group (info group)
3067 `(setcar ,info ,group))
3068 (defmacro gnus-info-set-rank (info rank)
3069 `(setcar (nthcdr 1 ,info) ,rank))
3070 (defmacro gnus-info-set-read (info read)
3071 `(setcar (nthcdr 2 ,info) ,read))
3072 (defmacro gnus-info-set-marks (info marks &optional extend)
3073 (if extend
3074 `(gnus-info-set-entry ,info ,marks 3)
3075 `(setcar (nthcdr 3 ,info) ,marks)))
3076 (defmacro gnus-info-set-method (info method &optional extend)
3077 (if extend
3078 `(gnus-info-set-entry ,info ,method 4)
3079 `(setcar (nthcdr 4 ,info) ,method)))
3080 (defmacro gnus-info-set-params (info params &optional extend)
3081 (if extend
3082 `(gnus-info-set-entry ,info ,params 5)
3083 `(setcar (nthcdr 5 ,info) ,params)))
3085 (defun gnus-info-set-entry (info entry number)
3086 ;; Extend the info until we have enough elements.
3087 (while (<= (length info) number)
3088 (nconc info (list nil)))
3089 ;; Set the entry.
3090 (setcar (nthcdr number info) entry))
3092 (defmacro gnus-info-set-level (info level)
3093 `(let ((rank (cdr ,info)))
3094 (if (consp (car rank))
3095 (setcar (car rank) ,level)
3096 (setcar rank ,level))))
3097 (defmacro gnus-info-set-score (info score)
3098 `(let ((rank (cdr ,info)))
3099 (if (consp (car rank))
3100 (setcdr (car rank) ,score)
3101 (setcar rank (cons (car rank) ,score)))))
3103 (defmacro gnus-get-info (group)
3104 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3106 ;;; Load the compatibility functions.
3108 (require 'gnus-ems)
3110 \f
3111 ;;;
3112 ;;; Shutdown
3113 ;;;
3115 (defvar gnus-shutdown-alist nil)
3117 (defun gnus-add-shutdown (function &rest symbols)
3118 "Run FUNCTION whenever one of SYMBOLS is shut down."
3119 (push (cons function symbols) gnus-shutdown-alist))
3121 (defun gnus-shutdown (symbol)
3122 "Shut down everything that waits for SYMBOL."
3123 (dolist (entry gnus-shutdown-alist)
3124 (when (memq symbol (cdr entry))
3125 (funcall (car entry)))))
3127 \f
3128 ;;;
3129 ;;; Gnus Utility Functions
3130 ;;;
3132 (defun gnus-find-subscribed-addresses ()
3133 "Return a regexp matching the addresses of all subscribed mail groups.
3134 It consists of the `to-address' or `to-list' parameter of all groups
3135 with a `subscribed' parameter."
3136 (let (group address addresses)
3137 (dolist (entry (cdr gnus-newsrc-alist))
3138 (setq group (car entry))
3139 (when (gnus-parameter-subscribed group)
3140 (setq address (mail-strip-quoted-names
3141 (or (gnus-group-fast-parameter group 'to-address)
3142 (gnus-group-fast-parameter group 'to-list))))
3143 (when address
3144 (add-to-list 'addresses address))))
3145 (when addresses
3148 (defmacro gnus-string-or (&rest strings)
3149 "Return the first element of STRINGS that is a non-blank string.
3150 STRINGS will be evaluated in normal `or' order."
3151 `(gnus-string-or-1 (list ,@strings)))
3153 (defun gnus-string-or-1 (strings)
3154 (let (string)
3155 (while strings
3156 (setq string (pop strings))
3158 (setq string nil)
3159 (setq strings nil)))
3160 string))
3162 (defun gnus-version (&optional arg)
3163 "Version number of this version of Gnus.
3164 If ARG, insert string at point."
3165 (interactive "P")
3166 (if arg
3167 (insert (message gnus-version))
3168 (message gnus-version)))
3170 (defun gnus-continuum-version (&optional version)
3171 "Return VERSION as a floating point number."
3172 (unless version
3173 (setq version gnus-version))
3176 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3177 (number (match-string 2 version))
3178 major minor least)
3179 (unless (string-match
3181 (error "Invalid version string: %s" version))
3182 (setq major (string-to-number (match-string 1 number))
3183 minor (string-to-number (match-string 2 number))
3184 least (if (match-beginning 3)
3185 (string-to-number (match-string 3 number))
3186 0))
3187 (string-to-number
3188 (if (zerop major)
3189 (format "%s00%02d%02d"
3190 (if (member alpha '("(ding)" "d"))
3191 "4.99"
3192 (+ 5 (* 0.02
3193 (abs
3194 (- (mm-char-int (aref (downcase alpha) 0))
3195 (mm-char-int ?t))))
3196 -0.01))
3197 minor least)
3198 (format "%d.%02d%02d" major minor least))))))
3200 (defun gnus-info-find-node (&optional nodename)
3201 "Find Info documentation of Gnus."
3202 (interactive)
3203 ;; Enlarge info window if needed.
3204 (let (gnus-info-buffer)
3205 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3206 (setq gnus-info-buffer (current-buffer))
3207 (gnus-configure-windows 'info)))
3209 ;;;
3210 ;;; gnus-interactive
3211 ;;;
3213 (defvar gnus-current-prefix-symbol nil
3214 "Current prefix symbol.")
3216 (defvar gnus-current-prefix-symbols nil
3217 "List of current prefix symbols.")
3219 (defun gnus-interactive (string &optional params)
3220 "Return a list that can be fed to `interactive'.
3221 See `interactive' for full documentation.
3223 Adds the following specs:
3225 y -- The current symbolic prefix.
3226 Y -- A list of the current symbolic prefix(es).
3227 A -- Article number.
3228 H -- Article header.
3229 g -- Group name."
3230 (let ((i 0)
3231 out c prompt)
3232 (while (< i (length string))
3234 (setq c (aref string i))
3235 (when (match-end 1)
3236 (setq prompt (match-string 1 string)))
3237 (setq i (match-end 0))
3238 ;; We basically emulate just about everything that
3239 ;; `interactive' does, but add the specs listed above.
3240 (push
3241 (cond
3242 ((= c ?a)
3243 (completing-read prompt obarray 'fboundp t))
3244 ((= c ?b)
3245 (read-buffer prompt (current-buffer) t))
3246 ((= c ?B)
3247 (read-buffer prompt (other-buffer (current-buffer))))
3248 ((= c ?c)
3249 (read-char))
3250 ((= c ?C)
3251 (completing-read prompt obarray 'commandp t))
3252 ((= c ?d)
3253 (point))
3254 ((= c ?D)
3255 (read-file-name prompt nil default-directory 'lambda))
3256 ((= c ?f)
3257 (read-file-name prompt nil nil 'lambda))
3258 ((= c ?F)
3259 (read-file-name prompt))
3260 ((= c ?k)
3261 (read-key-sequence prompt))
3262 ((= c ?K)
3263 (error "Not implemented spec"))
3264 ((= c ?e)
3265 (error "Not implemented spec"))
3266 ((= c ?m)
3267 (mark))
3268 ((= c ?N)
3269 (error "Not implemented spec"))
3270 ((= c ?n)
3271 (string-to-number (read-from-minibuffer prompt)))
3272 ((= c ?p)
3273 (prefix-numeric-value current-prefix-arg))
3274 ((= c ?P)
3275 current-prefix-arg)
3276 ((= c ?r)
3277 'gnus-prefix-nil)
3278 ((= c ?s)
3279 (read-string prompt))
3280 ((= c ?S)
3281 (intern (read-string prompt)))
3282 ((= c ?v)
3283 (read-variable prompt))
3284 ((= c ?x)
3285 (read-minibuffer prompt))
3286 ((= c ?x)
3287 (eval-minibuffer prompt))
3288 ;; And here the new specs come.
3289 ((= c ?y)
3290 gnus-current-prefix-symbol)
3291 ((= c ?Y)
3292 gnus-current-prefix-symbols)
3293 ((= c ?g)
3294 (gnus-group-group-name))
3295 ((= c ?A)
3296 (gnus-summary-skip-intangible)
3297 (or (get-text-property (point) 'gnus-number)
3298 (gnus-summary-last-subject)))
3299 ((= c ?H)
3300 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3301 (t
3302 (error "Non-implemented spec")))
3303 out)
3304 (cond
3305 ((= c ?r)
3306 (push (if (< (point) (mark)) (point) (mark)) out)
3307 (push (if (> (point) (mark)) (point) (mark)) out))))
3308 (setq out (delq 'gnus-prefix-nil out))
3309 (nreverse out)))
3311 (defun gnus-symbolic-argument (&optional arg)
3312 "Read a symbolic argument and a command, and then execute command."
3313 (interactive "P")
3314 (let* ((in-command (this-command-keys))
3315 (command in-command)
3316 gnus-current-prefix-symbols
3317 gnus-current-prefix-symbol
3318 syms)
3319 (while (equal in-command command)
3320 (message "%s-" (key-description (this-command-keys)))
3321 (push (intern (char-to-string (read-char))) syms)
3322 (setq command (read-key-sequence nil t)))
3323 (setq gnus-current-prefix-symbols (nreverse syms)
3324 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3325 (call-interactively (key-binding command t))))
3327 ;;; More various functions.
3329 (defsubst gnus-check-backend-function (func group)
3330 "Check whether GROUP supports function FUNC.
3331 GROUP can either be a string (a group name) or a select method."
3332 (ignore-errors
3333 (let ((method (if (stringp group)
3334 (car (gnus-find-method-for-group group))
3335 group)))
3336 (unless (featurep method)
3337 (require method))
3338 (fboundp (intern (format "%s-%s" method func))))))
3340 (defun gnus-group-read-only-p (&optional group)
3341 "Check whether GROUP supports editing or not.
3342 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3343 that that variable is buffer-local to the summary buffers."
3344 (let ((group (or group gnus-newsgroup-name)))
3345 (not (gnus-check-backend-function 'request-replace-article group))))
3347 (defun gnus-virtual-group-p (group)
3348 "Say whether GROUP is virtual or not."
3349 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3350 gnus-valid-select-methods)))
3352 (defun gnus-news-group-p (group &optional article)
3353 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3354 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3355 t) ;is news of course.
3356 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3357 nil) ;must be mail then.
3358 ((vectorp article) ;Has header info.
3359 (eq (gnus-request-type group (mail-header-id article)) 'news))
3360 ((null article) ;Hasn't header info
3361 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3362 ((< article 0) ;Virtual message
3363 nil) ;we don't know, guess mail.
3364 (t ;Has positive number
3365 (eq (gnus-request-type group article) 'news)))) ;use it.
3367 ;; Returns a list of writable groups.
3368 (defun gnus-writable-groups ()
3369 (let ((alist gnus-newsrc-alist)
3370 groups group)
3371 (while (setq group (car (pop alist)))
3372 (unless (gnus-group-read-only-p group)
3373 (push group groups)))
3374 (nreverse groups)))
3376 ;; Check whether to use long file names.
3377 (defun gnus-use-long-file-name (symbol)
3378 ;; The variable has to be set...
3379 (and gnus-use-long-file-name
3380 ;; If it isn't a list, then we return t.
3381 (or (not (listp gnus-use-long-file-name))
3382 ;; If it is a list, and the list contains `symbol', we
3383 ;; return nil.
3384 (not (memq symbol gnus-use-long-file-name)))))
3386 ;; Generate a unique new group name.
3387 (defun gnus-generate-new-group-name (leaf)
3388 (let ((name leaf)
3389 (num 0))
3390 (while (gnus-group-entry name)
3391 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3392 name))
3394 (defun gnus-ephemeral-group-p (group)
3395 "Say whether GROUP is ephemeral or not."
3396 (gnus-group-get-parameter group 'quit-config t))
3398 (defun gnus-group-quit-config (group)
3399 "Return the quit-config of GROUP."
3400 (gnus-group-get-parameter group 'quit-config t))
3402 (defun gnus-kill-ephemeral-group (group)
3403 "Remove ephemeral GROUP from relevant structures."
3404 (gnus-sethash group nil gnus-newsrc-hashtb))
3406 (defun gnus-simplify-mode-line ()
3407 "Make mode lines a bit simpler."
3408 (setq mode-line-modified (cdr gnus-mode-line-modified))
3409 (when (listp mode-line-format)
3410 (make-local-variable 'mode-line-format)
3411 (setq mode-line-format (copy-sequence mode-line-format))
3412 (when (equal (nth 3 mode-line-format) " ")
3413 (setcar (nthcdr 3 mode-line-format) " "))))
3415 ;;; Servers and groups.
3417 (defsubst gnus-server-add-address (method)
3418 (let ((method-name (symbol-name (car method))))
3419 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3420 (not (assq (intern (concat method-name "-address")) method))
3421 (memq 'physical-address (assq (car method)
3422 gnus-valid-select-methods)))
3423 (append method (list (list (intern (concat method-name "-address"))
3424 (nth 1 method))))
3425 method)))
3427 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3428 (catch 'server-name
3429 (setq method (or method gnus-select-method))
3431 ;; Perhaps it is already in the cache.
3432 (unless nocache
3433 (mapc (lambda (name-method)
3434 (if (equal (cdr name-method) method)
3435 (throw 'server-name (car name-method))))
3436 gnus-server-method-cache))
3438 (mapc
3439 (lambda (server-alist)
3440 (mapc (lambda (name-method)
3441 (when (gnus-methods-equal-p (cdr name-method) method)
3442 (unless (member name-method gnus-server-method-cache)
3443 (push name-method gnus-server-method-cache))
3444 (throw 'server-name (car name-method))))
3445 server-alist))
3446 (list gnus-server-alist
3447 gnus-predefined-server-alist))
3449 (let* ((name (if (member (cadr method) '(nil ""))
3450 (format "%s" (car method))
3451 (format "%s:%s" (car method) (cadr method))))
3452 (name-method (cons name method)))
3453 (when (and (not (member name-method gnus-server-method-cache))
3454 (not no-enter-cache)
3455 (not (assoc (car name-method) gnus-server-method-cache)))
3456 (push name-method gnus-server-method-cache))
3457 name)))
3459 (defsubst gnus-server-to-method (server)
3460 "Map virtual server names to select methods."
3461 (or (and server (listp server) server)
3462 (cdr (assoc server gnus-server-method-cache))
3463 (let ((result
3464 (or
3465 ;; Perhaps this is the native server?
3466 (and (equal server "native") gnus-select-method)
3467 ;; It should be in the server alist.
3468 (cdr (assoc server gnus-server-alist))
3469 ;; It could be in the predefined server alist.
3470 (cdr (assoc server gnus-predefined-server-alist))
3471 ;; If not, we look through all the opened server
3472 ;; to see whether we can find it there.
3473 (let ((opened gnus-opened-servers))
3474 (while (and opened
3475 (not (equal server (format "%s:%s" (caaar opened)
3476 (cadaar opened)))))
3477 (pop opened))
3478 (caar opened))
3479 ;; It could be a named method, search all servers
3480 (let ((servers gnus-secondary-select-methods))
3481 (while (and servers
3482 (not (equal server (format "%s:%s" (caar servers)
3483 (cadar servers)))))
3484 (pop servers))
3485 (car servers))
3486 ;; This could be some sort of foreign server that I
3487 ;; simply haven't opened (yet). Do a brute-force scan
3488 ;; of the entire gnus-newsrc-alist for the server name
3489 ;; of every method. As a side-effect, loads the
3490 ;; gnus-server-method-cache so this only happens once,
3491 ;; if at all.
3492 (let ((alist (cdr gnus-newsrc-alist))
3493 method match)
3494 (while alist
3495 (setq method (gnus-info-method (pop alist)))
3496 (when (and (not (stringp method))
3497 (equal server
3498 (gnus-method-to-server method nil t)))
3499 (setq match method
3500 alist nil)))
3501 match))))
3502 (when (and result
3503 (not (assoc server gnus-server-method-cache)))
3504 (push (cons server result) gnus-server-method-cache))
3505 result)))
3507 (defsubst gnus-server-get-method (group method)
3508 ;; Input either a server name, and extended server name, or a
3509 ;; select method, and return a select method.
3510 (cond ((stringp method)
3511 (gnus-server-to-method method))
3512 ((equal method gnus-select-method)
3513 gnus-select-method)
3514 ((and (stringp (car method))
3515 group)
3516 (gnus-server-extend-method group method))
3517 ((and method
3518 (not group)
3519 (equal (cadr method) ""))
3520 method)
3521 (t
3522 (gnus-server-add-address method))))
3524 (defmacro gnus-method-equal (ss1 ss2)
3525 "Say whether two servers are equal."
3526 `(let ((s1 ,ss1)
3527 (s2 ,ss2))
3528 (or (equal s1 s2)
3529 (and (= (length s1) (length s2))
3530 (progn
3531 (while (and s1 (member (car s1) s2))
3532 (setq s1 (cdr s1)))
3533 (null s1))))))
3535 (defun gnus-methods-equal-p (m1 m2)
3536 (let ((m1 (or m1 gnus-select-method))
3537 (m2 (or m2 gnus-select-method)))
3538 (or (equal m1 m2)
3539 (and (eq (car m1) (car m2))
3540 (or (not (memq 'address (assoc (symbol-name (car m1))
3541 gnus-valid-select-methods)))
3542 (equal (nth 1 m1) (nth 1 m2)))))))
3544 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3545 ;; Check parameters for sloppy equalness.
3546 (let ((p1 (copy-sequence (cddr m1)))
3547 (p2 (copy-sequence (cddr m2)))
3548 e1 e2)
3549 (block nil
3550 (while (setq e1 (pop p1))
3551 (unless (setq e2 (assq (car e1) p2))
3552 ;; The parameter doesn't exist in p2.
3553 (return nil))
3554 (setq p2 (delq e2 p2))
3555 (unless (equal e1 e2)
3556 (if (not (and (stringp (cadr e1))
3557 (stringp (cadr e2))))
3558 (return nil)
3559 ;; Special-case string parameter comparison so that we
3560 ;; can uniquify them.
3561 (let ((s1 (cadr e1))
3562 (s2 (cadr e2)))
3563 (when (string-match "/$" s1)
3564 (setq s1 (directory-file-name s1)))
3565 (when (string-match "/$" s2)
3566 (setq s2 (directory-file-name s2)))
3567 (unless (equal s1 s2)
3568 (return nil))))))
3569 ;; If p2 now is empty, they were equal.
3570 (null p2))))
3572 (defun gnus-methods-sloppily-equal (m1 m2)
3573 ;; Same method.
3574 (or
3575 (eq m1 m2)
3576 ;; Type and name are equal.
3577 (and
3578 (eq (car m1) (car m2))
3579 (equal (cadr m1) (cadr m2))
3580 (gnus-sloppily-equal-method-parameters m1 m2))))
3582 (defun gnus-server-equal (m1 m2)
3583 "Say whether two methods are equal."
3584 (let ((m1 (cond ((null m1) gnus-select-method)
3585 ((stringp m1) (gnus-server-to-method m1))
3586 (t m1)))
3587 (m2 (cond ((null m2) gnus-select-method)
3588 ((stringp m2) (gnus-server-to-method m2))
3589 (t m2))))
3590 (gnus-method-equal m1 m2)))
3592 (defun gnus-servers-using-backend (backend)
3593 "Return a list of known servers using BACKEND."
3594 (let ((opened gnus-opened-servers)
3595 out)
3596 (while opened
3597 (when (eq backend (caaar opened))
3598 (push (caar opened) out))
3599 (pop opened))
3600 out))
3602 (defun gnus-archive-server-wanted-p ()
3603 "Say whether the user wants to use the archive server."
3604 (cond
3605 ((or (not gnus-message-archive-method)
3606 (not gnus-message-archive-group))
3607 nil)
3608 ((and gnus-message-archive-method gnus-message-archive-group)
3609 t)
3610 (t
3611 (let ((active (cadr (assq 'nnfolder-active-file
3612 gnus-message-archive-method))))
3613 (and active
3614 (file-exists-p active))))))
3616 (defsubst gnus-method-to-server-name (method)
3617 (concat
3618 (format "%s" (car method))
3619 (when (and
3620 (or (assoc (format "%s" (car method))
3621 (gnus-methods-using 'address))
3622 (gnus-server-equal method gnus-message-archive-method))
3623 (nth 1 method)
3624 (not (string= (nth 1 method) "")))
3625 (concat "+" (nth 1 method)))))
3627 (defsubst gnus-method-to-full-server-name (method)
3628 (format "%s+%s" (car method) (nth 1 method)))
3630 (defun gnus-group-prefixed-name (group method &optional full)
3631 "Return the whole name from GROUP and METHOD.
3632 Call with full set to get the fully qualified group name (even if the
3633 server is native)."
3634 (when (stringp method)
3635 (setq method (gnus-server-to-method method)))
3636 (if (or (not method)
3637 (and (not full) (gnus-server-equal method "native"))
3638 ;;;!!! This might not be right. We'll see...
3639 ;(string-match ":" group)
3640 )
3641 group
3642 (concat (gnus-method-to-server-name method) ":" group)))
3644 (defun gnus-group-guess-prefixed-name (group)
3645 "Guess the whole name from GROUP and METHOD."
3646 (gnus-group-prefixed-name group (gnus-find-method-for-group
3647 group)))
3649 (defun gnus-group-full-name (group method)
3650 "Return the full name from GROUP and METHOD, even if the method is native."
3651 (gnus-group-prefixed-name group method t))
3653 (defun gnus-group-guess-full-name (group)
3654 "Guess the full name from GROUP, even if the method is native."
3655 (if (gnus-group-prefixed-p group)
3656 group
3657 (gnus-group-full-name group (gnus-find-method-for-group group))))
3659 (defun gnus-group-guess-full-name-from-command-method (group)
3660 "Guess the full name from GROUP, even if the method is native."
3661 (if (gnus-group-prefixed-p group)
3662 group
3663 (gnus-group-full-name group gnus-command-method)))
3665 (defun gnus-group-real-prefix (group)
3666 "Return the prefix of the current group name."
3667 (if (stringp group)
3668 (if (string-match "^[^:]+:" group)
3669 (substring group 0 (match-end 0))
3670 "")
3671 nil))
3673 (defun gnus-group-short-name (group)
3674 "Return the short group name."
3675 (let ((prefix (gnus-group-real-prefix group)))
3676 (if (< 0 (length prefix))
3677 (substring group (length prefix) nil)
3678 group)))
3680 (defun gnus-group-prefixed-p (group)
3681 "Return the prefix of the current group name."
3682 (< 0 (length (gnus-group-real-prefix group))))
3684 (declare-function gnus-group-decoded-name "gnus-group" (string))
3686 (defun gnus-summary-buffer-name (group)
3687 "Return the summary buffer name of GROUP."
3688 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3690 (defun gnus-group-method (group)
3691 "Return the server or method used for selecting GROUP.
3692 You should probably use `gnus-find-method-for-group' instead."
3693 (let ((prefix (gnus-group-real-prefix group)))
3694 (if (equal prefix "")
3695 gnus-select-method
3696 (let ((servers gnus-opened-servers)
3697 (server "")
3698 backend possible found)
3700 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3701 server (substring prefix (match-end 0) (1- (length prefix))))
3702 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3703 (while servers
3704 (when (eq (caaar servers) backend)
3705 (setq possible (caar servers))
3706 (when (equal (cadaar servers) server)
3707 (setq found (caar servers))))
3708 (pop servers))
3709 (or (car (rassoc found gnus-server-alist))
3710 found
3711 (car (rassoc possible gnus-server-alist))
3712 possible
3713 (list backend server))))))
3715 (defsubst gnus-native-method-p (method)
3716 "Return whether METHOD is the native select method."
3717 (gnus-method-equal method gnus-select-method))
3719 (defsubst gnus-secondary-method-p (method)
3720 "Return whether METHOD is a secondary select method."
3721 (let ((methods gnus-secondary-select-methods)
3722 (gmethod (inline (gnus-server-get-method nil method))))
3723 (while (and methods
3724 (not (gnus-method-equal
3725 (inline (gnus-server-get-method nil (car methods)))
3726 gmethod)))
3727 (setq methods (cdr methods)))
3728 methods))
3730 (defun gnus-method-simplify (method)
3731 "Return the shortest uniquely identifying string or method for METHOD."
3732 (cond ((stringp method)
3733 method)
3734 ((gnus-native-method-p method)
3735 nil)
3736 ((gnus-secondary-method-p method)
3737 (format "%s:%s" (nth 0 method) (nth 1 method)))
3738 (t
3739 method)))
3741 (defun gnus-groups-from-server (server)
3742 "Return a list of all groups that are fetched from SERVER."
3743 (let ((alist (cdr gnus-newsrc-alist))
3744 info groups)
3745 (while (setq info (pop alist))
3746 (when (gnus-server-equal (gnus-info-method info) server)
3747 (push (gnus-info-group info) groups)))
3748 (sort groups 'string<)))
3750 (defun gnus-group-foreign-p (group)
3751 "Say whether a group is foreign or not."
3752 (and (not (gnus-group-native-p group))
3753 (not (gnus-group-secondary-p group))))
3755 (defun gnus-group-native-p (group)
3756 "Say whether the group is native or not."
3757 (not (string-match ":" group)))
3759 (defun gnus-group-secondary-p (group)
3760 "Say whether the group is secondary or not."
3761 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3763 (defun gnus-parameters-get-parameter (group)
3764 "Return the group parameters for GROUP from `gnus-parameters'."
3765 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3766 case-fold-search
3767 gnus-parameters-case-fold-search))
3768 params-list)
3769 (dolist (elem gnus-parameters)
3770 (when (string-match (car elem) group)
3771 (setq params-list
3772 (nconc (gnus-expand-group-parameters
3773 (car elem) (cdr elem) group)
3774 params-list))))
3775 params-list))
3777 (defun gnus-expand-group-parameter (match value group)
3778 "Use MATCH to expand VALUE in GROUP."
3779 (let ((start (string-match match group)))
3780 (if start
3781 (let ((matched-string (substring group start (match-end 0))))
3782 ;; Build match groups
3783 (string-match match matched-string)
3784 (replace-match value nil nil matched-string))
3785 group)))
3787 (defun gnus-expand-group-parameters (match parameters group)
3788 "Go through PARAMETERS and expand them according to the match data."
3789 (let (new)
3790 (dolist (elem parameters)
3791 (if (and (stringp (cdr elem))
3793 (push (cons (car elem)
3794 (gnus-expand-group-parameter match (cdr elem) group))
3795 new)
3796 (push elem new)))
3797 new))
3799 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3800 "For GROUP, return the value of SYMBOL.
3802 You should call this in the `gnus-group-buffer' buffer.
3803 The function `gnus-group-find-parameter' will do that for you."
3804 ;; The speed trick: No cons'ing and quit early.
3805 (let* ((params (funcall gnus-group-get-parameter-function group))
3806 ;; Start easy, check the "real" group parameters.
3807 (simple-results
3808 (gnus-group-parameter-value params symbol allow-list t)))
3809 (if simple-results
3810 ;; Found results; return them.
3811 (car simple-results)
3812 ;; We didn't find it there, try `gnus-parameters'.
3813 (let ((result nil)
3814 (head nil)
3815 (tail gnus-parameters))
3816 ;; A good old-fashioned non-cl loop.
3817 (while tail
3818 (setq head (car tail)
3819 tail (cdr tail))
3820 ;; The car is regexp matching for matching the group name.
3821 (when (string-match (car head) group)
3822 ;; The cdr is the parameters.
3823 (setq result (gnus-group-parameter-value (cdr head)
3824 symbol allow-list))
3825 (when result
3826 ;; Expand if necessary.
3828 (setq result (gnus-expand-group-parameter (car head)
3829 result group))))))
3830 ;; Done.
3831 result))))
3833 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3834 "Return the group parameters for GROUP.
3835 If SYMBOL, return the value of that symbol in the group parameters.
3837 If you call this function inside a loop, consider using the faster
3838 `gnus-group-fast-parameter' instead."
3839 (with-current-buffer gnus-group-buffer
3840 (if symbol
3841 (gnus-group-fast-parameter group symbol allow-list)
3842 (nconc
3843 (copy-sequence
3844 (funcall gnus-group-get-parameter-function group))
3845 (gnus-parameters-get-parameter group)))))
3847 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3848 "Return the group parameters for GROUP.
3849 If SYMBOL, return the value of that symbol in the group parameters.
3850 If ALLOW-LIST, also allow list as a result.
3851 Most functions should use `gnus-group-find-parameter', which
3852 also examines the topic parameters."
3853 (let ((params (gnus-info-params (gnus-get-info group))))
3854 (if symbol
3855 (gnus-group-parameter-value params symbol allow-list)
3856 params)))
3858 (defun gnus-group-parameter-value (params symbol &optional
3859 allow-list present-p)
3860 "Return the value of SYMBOL in group PARAMS.
3861 If ALLOW-LIST, also allow list as a result."
3862 ;; We only wish to return group parameters (dotted lists) and
3863 ;; not local variables, which may have the same names.
3864 ;; But first we handle single elements...
3865 (or (car (memq symbol params))
3866 ;; Handle alist.
3867 (let (elem)
3868 (catch 'found
3869 (while (setq elem (pop params))
3870 (when (and (consp elem)
3871 (eq (car elem) symbol)
3872 (or allow-list
3873 (atom (cdr elem))))
3874 (throw 'found (if present-p (list (cdr elem))
3875 (cdr elem)))))))))
3877 (defun gnus-group-add-parameter (group param)
3878 "Add parameter PARAM to GROUP."
3879 (let ((info (gnus-get-info group)))
3880 (when info
3881 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3882 ;; Cons the new param to the old one and update.
3883 (gnus-group-set-info (cons param (gnus-info-params info))
3884 group 'params))))
3886 (defun gnus-group-set-parameter (group name value)
3887 "Set parameter NAME to VALUE in GROUP.
3888 GROUP can also be an INFO structure."
3889 (let ((info (if (listp group)
3890 group
3891 (gnus-get-info group))))
3892 (when info
3893 (gnus-group-remove-parameter group name)
3894 (let ((old-params (gnus-info-params info))
3895 (new-params (list (cons name value))))
3896 (while old-params
3897 (when (or (not (listp (car old-params)))
3898 (not (eq (caar old-params) name)))
3899 (setq new-params (append new-params (list (car old-params)))))
3900 (setq old-params (cdr old-params)))
3901 (if (listp group)
3902 (gnus-info-set-params info new-params t)
3903 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3905 (defun gnus-group-remove-parameter (group name)
3906 "Remove parameter NAME from GROUP.
3907 GROUP can also be an INFO structure."
3908 (let ((info (if (listp group)
3909 group
3910 (gnus-get-info group))))
3911 (when info
3912 (let ((params (gnus-info-params info)))
3913 (when params
3914 (setq params (delq name params))
3915 (while (assq name params)
3916 (gnus-alist-pull name params))
3917 (gnus-info-set-params info params))))))
3919 (defun gnus-group-add-score (group &optional score)
3920 "Add SCORE to the GROUP score.
3921 If SCORE is nil, add 1 to the score of GROUP."
3922 (let ((info (gnus-get-info group)))
3923 (when info
3924 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3926 (defun gnus-short-group-name (group &optional levels)
3927 "Collapse GROUP name LEVELS.
3928 Select methods are stripped and any remote host name is stripped down to
3929 just the host name."
3930 (let* ((name "")
3931 (foreign "")
3932 (depth 0)
3933 (skip 1)
3934 (levels (or levels
3935 gnus-group-uncollapsed-levels
3936 (progn
3938 (setq skip (match-end 0)
3939 depth (+ depth 1)))
3940 depth))))
3941 ;; Separate foreign select method from group name and collapse.
3942 ;; If method contains a server, collapse to non-domain server name,
3943 ;; otherwise collapse to select method.
3944 (let* ((colon (string-match ":" group))
3945 (server (and colon (substring group 0 colon)))
3946 (plus (and server (string-match "+" server))))
3947 (when server
3948 (if plus
3949 (setq foreign (substring server (+ 1 plus)
3951 group (substring group (+ 1 colon)))
3952 (setq foreign server
3953 group (substring group (+ 1 colon))))
3954 (setq foreign (concat foreign ":")))
3955 ;; Collapse group name leaving LEVELS uncollapsed elements
3956 (let* ((slist (split-string group "/"))
3957 (slen (length slist))
3959 (dlen (length dlist))
3960 glist
3961 glen
3962 gsep
3963 res)
3964 (if (> slen dlen)
3965 (setq glist slist
3966 glen slen
3967 gsep "/")
3968 (setq glist dlist
3969 glen dlen
3970 gsep "."))
3971 (setq levels (- glen levels))
3972 (dolist (g glist)
3973 (push (if (>= (decf levels) 0)
3974 (if (zerop (length g))
3975 ""
3976 (substring g 0 1))
3977 g)
3978 res))
3979 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3981 (defun gnus-narrow-to-body ()
3982 "Narrow to the body of an article."
3983 (narrow-to-region
3984 (progn
3985 (goto-char (point-min))
3987 (point-max)))
3988 (point-max)))
3990 \f
3991 ;;;
3992 ;;; Kill file handling.
3993 ;;;
3995 (defun gnus-apply-kill-file ()
3996 "Apply a kill file to the current newsgroup.
3997 Returns the number of articles marked as read."
3998 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3999 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4000 (gnus-apply-kill-file-internal)
4001 0))
4003 (defun gnus-kill-save-kill-buffer ()
4004 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4005 (when (get-file-buffer file)
4006 (with-current-buffer (get-file-buffer file)
4007 (when (buffer-modified-p)
4008 (save-buffer))
4009 (kill-buffer (current-buffer))))))
4011 (defcustom gnus-kill-file-name "KILL"
4012 "Suffix of the kill files."
4013 :group 'gnus-score-kill
4014 :group 'gnus-score-files
4015 :type 'string)
4017 (defun gnus-newsgroup-kill-file (newsgroup)
4018 "Return the name of a kill file name for NEWSGROUP.
4019 If NEWSGROUP is nil, return the global kill file name instead."
4020 (cond
4021 ;; The global KILL file is placed at top of the directory.
4022 ((or (null newsgroup)
4023 (string-equal newsgroup ""))
4024 (expand-file-name gnus-kill-file-name
4025 gnus-kill-files-directory))
4026 ;; Append ".KILL" to newsgroup name.
4027 ((gnus-use-long-file-name 'not-kill)
4028 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4029 "." gnus-kill-file-name)
4030 gnus-kill-files-directory))
4031 ;; Place "KILL" under the hierarchical directory.
4032 (t
4033 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4034 "/" gnus-kill-file-name)
4035 gnus-kill-files-directory))))
4037 ;;; Server things.
4039 (defun gnus-member-of-valid (symbol group)
4041 (memq symbol (assoc
4042 (symbol-name (car (gnus-find-method-for-group group)))
4043 gnus-valid-select-methods)))
4045 (defun gnus-method-option-p (method option)
4046 "Return non-nil if select METHOD has OPTION as a parameter."
4047 (when (stringp method)
4048 (setq method (gnus-server-to-method method)))
4049 (memq option (assoc (format "%s" (car method))
4050 gnus-valid-select-methods)))
4052 (defun gnus-similar-server-opened (method)
4053 "Return non-nil if we have a similar server opened.
4054 This is defined as a server with the same name, but different
4055 parameters."
4056 (let ((opened gnus-opened-servers)
4057 open)
4058 (while (and method opened)
4059 (setq open (car (pop opened)))
4060 ;; Type and name are the same...
4061 (when (and (equal (car method) (car open))
4062 (equal (cadr method) (cadr open))
4063 ;; ... but the rest of the parameters differ.
4064 (not (gnus-methods-sloppily-equal method open)))
4065 (setq method nil)))
4066 (not method)))
4068 (defun gnus-server-extend-method (group method)
4069 ;; This function "extends" a virtual server. If the server is
4070 ;; "hello", and the select method is ("hello" (my-var "something"))
4071 ;; in the group "alt.alt", this will result in a new virtual server
4072 ;; called "hello+alt.alt".
4073 (if (or (not (inline (gnus-similar-server-opened method)))
4074 (not (cddr method)))
4075 method
4076 (setq method
4077 `(,(car method) ,(concat (cadr method) "+" group)
4078 (,(intern (format "%s-address" (car method))) ,(cadr method))
4079 ,@(cddr method)))
4080 (push method gnus-extended-servers)
4081 method))
4083 (defun gnus-server-status (method)
4084 "Return the status of METHOD."
4085 (nth 1 (assoc method gnus-opened-servers)))
4087 (defun gnus-group-name-to-method (group)
4088 "Guess a select method based on GROUP."
4089 (if (string-match ":" group)
4090 (let ((server (substring group 0 (match-beginning 0))))
4092 (list (intern (substring server 0 (match-beginning 0)))
4093 (substring server (match-end 0)))
4094 (list (intern server) "")))
4095 gnus-select-method))
4097 (defun gnus-server-string (server)
4098 "Return a readable string that describes SERVER."
4099 (let* ((server (gnus-server-to-method server))
4100 (address (nth 1 server)))
4101 (if (and address
4102 (not (zerop (length address))))
4103 (format "%s using %s" address (car server))
4104 (format "%s" (car server)))))
4106 (defun gnus-same-method-different-name (method)
4107 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4108 (unless (assq slot (cddr method))
4109 (setq method
4110 (append method (list (list slot (nth 1 method)))))))
4111 (let ((methods gnus-extended-servers)
4112 open found)
4113 (while (and (not found)
4114 (setq open (pop methods)))
4115 (when (and (eq (car method) (car open))
4116 (gnus-sloppily-equal-method-parameters method open))
4117 (setq found open)))
4118 found))
4120 (defun gnus-find-method-for-group (group &optional info)
4121 "Find the select method that GROUP uses."
4122 (or gnus-override-method
4123 (and (not group)
4124 gnus-select-method)
4125 (and (not (gnus-group-entry group))
4126 ;; Killed or otherwise unknown group.
4127 (or
4128 ;; If we know a virtual server by that name, return its method.
4129 (gnus-server-to-method (gnus-group-server group))
4130 ;; Guess a new method as last resort.
4131 (gnus-group-name-to-method group)))
4132 (let ((info (or info (gnus-get-info group)))
4133 method)
4134 (if (or (not info)
4135 (not (setq method (gnus-info-method info)))
4136 (equal method "native"))
4137 gnus-select-method
4138 (setq method
4139 (cond ((stringp method)
4140 (inline (gnus-server-to-method method)))
4141 ((stringp (cadr method))
4142 (or
4143 (inline
4144 (gnus-same-method-different-name method))
4145 (inline (gnus-server-extend-method group method))))
4146 (t
4147 method)))
4148 (cond ((equal (cadr method) "")
4149 method)
4150 ((null (cadr method))
4151 (list (car method) ""))
4152 (t
4153 (gnus-server-add-address method)))))))
4155 (defun gnus-methods-using (feature)
4156 "Find all methods that have FEATURE."
4157 (let ((valids gnus-valid-select-methods)
4158 outs)
4159 (while valids
4160 (when (memq feature (car valids))
4161 (push (car valids) outs))
4162 (setq valids (cdr valids)))
4163 outs))
4165 (eval-and-compile
4166 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4168 (defun gnus-read-group (prompt &optional default)
4169 "Prompt the user for a group name.
4170 Disallow invalid group names."
4171 (let ((prefix "")
4172 group)
4173 (while (not group)
4174 (when (string-match
4175 gnus-invalid-group-regexp
4176 (setq group (read-string (concat prefix prompt)
4177 (cons (or default "") 0)
4178 'gnus-group-history)))
4179 (let ((match (match-string 0 group)))
4180 ;; Might be okay (e.g. for nnimap), so ask the user:
4182 (message-y-or-n-p
4183 "Proceed and create group anyway? " t
4186 Usually, it's dangerous to create a group with this name, because it's not
4187 supported by all back ends and servers. On IMAP servers it should work,
4188 though. If you are really sure, you can proceed anyway and create the group.
4190 You may customize the variable `gnus-invalid-group-regexp', which currently is
4194 group nil)))))
4195 group))
4197 (defun gnus-read-method (prompt)
4198 "Prompt the user for a method.
4199 Allow completion over sensible values."
4200 (let* ((open-servers
4201 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4202 gnus-opened-servers))
4203 (valid-methods
4204 (let (methods)
4205 (dolist (method gnus-valid-select-methods)
4206 (if (or (memq 'prompt-address method)
4207 (not (assoc (format "%s:" (car method)) open-servers)))
4208 (push method methods)))
4209 methods))
4210 (servers
4211 (append valid-methods
4212 open-servers
4213 gnus-predefined-server-alist
4214 gnus-server-alist))
4215 (method
4216 (gnus-completing-read
4217 prompt (mapcar 'car servers)
4218 t nil 'gnus-method-history)))
4219 (cond
4220 ((equal method "")
4221 (setq method gnus-select-method))
4222 ((assoc method gnus-valid-select-methods)
4223 (let ((address (if (memq 'prompt-address
4224 (assoc method gnus-valid-select-methods))
4225 (read-string "Address: ")
4226 "")))
4227 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4228 (list (intern method) address))))
4229 ((assoc method servers)
4230 method)
4231 (t
4232 (list (intern method) "")))))
4234 ;;; Agent functions
4236 (defun gnus-agent-method-p (method-or-server)
4237 "Say whether METHOD is covered by the agent."
4238 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4239 (let* ((method (if (stringp method-or-server)
4240 (gnus-server-to-method method-or-server)
4241 method-or-server))
4242 (server (gnus-method-to-server method t)))
4243 (setq gnus-agent-method-p-cache
4244 (cons method-or-server
4245 (member server gnus-agent-covered-methods)))))
4246 (cdr gnus-agent-method-p-cache))
4248 (defun gnus-online (method)
4249 (not
4250 (if gnus-plugged
4251 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4252 (gnus-agent-method-p method))))
4254 ;;; User-level commands.
4256 ;;;###autoload
4257 (defun gnus-slave-no-server (&optional arg)
4258 "Read network news as a slave, without connecting to the local server."
4259 (interactive "P")
4260 (gnus-no-server arg t))
4262 ;;;###autoload
4263 (defun gnus-no-server (&optional arg slave)
4264 "Read network news.
4265 If ARG is a positive number, Gnus will use that as the startup
4266 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4267 non-nil and not a positive number, Gnus will prompt the user for the
4268 name of an NNTP server to use.
4269 As opposed to `gnus', this command will not connect to the local
4270 server."
4271 (interactive "P")
4272 (gnus-no-server-1 arg slave))
4274 ;;;###autoload
4275 (defun gnus-slave (&optional arg)
4276 "Read news as a slave."
4277 (interactive "P")
4278 (gnus arg nil 'slave))
4280 ;;;###autoload
4281 (defun gnus-other-frame (&optional arg display)
4282 "Pop up a frame to read news.
4283 This will call one of the Gnus commands which is specified by the user
4284 option `gnus-other-frame-function' (default `gnus') with the argument
4285 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4286 optional second argument DISPLAY should be a standard display string
4288 omitted or the function `make-frame-on-display' is not available, the
4289 current display is used."
4290 (interactive "P")
4291 (if (fboundp 'make-frame-on-display)
4292 (unless display
4293 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4294 (setq display nil))
4295 (let ((alive (gnus-alive-p)))
4296 (unless (and alive
4297 (catch 'found
4298 (walk-windows
4299 (lambda (window)
4300 (when (and (or (not display)
4301 (equal display
4302 (gnus-frame-or-window-display-name
4303 window)))
4304 (with-current-buffer (window-buffer window)
4306 (symbol-name major-mode))))
4307 (gnus-select-frame-set-input-focus
4308 (setq gnus-other-frame-object (window-frame window)))
4309 (select-window window)
4310 (throw 'found t)))
4311 'ignore t)))
4312 (gnus-select-frame-set-input-focus
4313 (setq gnus-other-frame-object
4314 (if display
4315 (make-frame-on-display display gnus-other-frame-parameters)
4316 (make-frame gnus-other-frame-parameters))))
4317 (if alive
4318 (switch-to-buffer gnus-group-buffer)
4319 (funcall gnus-other-frame-function arg)
4320 (add-hook 'gnus-exit-gnus-hook
4321 '(lambda nil
4322 (when (and (frame-live-p gnus-other-frame-object)
4323 (cdr (frame-list)))
4324 (delete-frame gnus-other-frame-object))
4325 (setq gnus-other-frame-object nil)))))))
4327 ;;;###autoload
4328 (defun gnus (&optional arg dont-connect slave)
4329 "Read network news.
4330 If ARG is non-nil and a positive number, Gnus will use that as the
4331 startup level. If ARG is non-nil and not a positive number, Gnus will
4332 prompt the user for the name of an NNTP server to use."
4333 (interactive "P")
4334 ;; When using the development version of Gnus, load the gnus-load
4335 ;; file.
4336 (unless (string-match "^Gnus" gnus-version)
4337 (load "gnus-load" nil t))
4338 (unless (byte-code-function-p (symbol-function 'gnus))
4339 (message "You should byte-compile Gnus")
4340 (sit-for 2))
4341 (let ((gnus-action-message-log (list nil)))
4342 (gnus-1 arg dont-connect slave)
4343 (gnus-final-warning)))
4345 ;; Allow redefinition of Gnus functions.
4347 (gnus-ems-redefine)
4349 (provide 'gnus)
4351 ;;; gnus.el ends here