| blob | 56b749f65272a38f7f723d598bc4f874e9af4fcf |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2014 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
9 ;; Version: 5.13
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;;; Code:
32 ;; For Emacs <22.2 and XEmacs.
41 ;; These are defined afterwards with gnus-define-group-parameter
55 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
60 "Starting your favorite newsreader."
64 "Dealing with formatting issues."
68 "Group character set issues."
74 "Cache interface."
79 "Article Registry."
83 "Server options at startup."
86 ;; These belong to gnus-group.el.
88 "Group buffers."
93 "Foreign groups."
98 "Automatic subscription of new groups."
102 "Group levels."
107 "Selecting a Group."
112 "Showing slices of the group list."
117 "Sorting the group buffer."
123 "Various group options."
127 ;; These belong to gnus-sum.el.
129 "Summary buffers."
134 "Leaving summary buffers."
139 "Marks used in summary buffers."
144 "Ordering articles according to replies."
149 "Formatting of the summary buffer."
154 "Choosing Articles."
159 "Summary movement commands."
164 "Show pictures of people, domains, and newsgroups."
168 "Mail group commands."
173 "Sorting the summary buffer."
178 "Highlighting and menus in the summary buffer."
184 "Various summary buffer options."
189 "Pick mode in the summary buffer."
195 "Tree display of threads in the summary buffer."
200 ;; Belongs to gnus-uu.el
202 "Viewing extracted files."
206 ;; Belongs to gnus-score.el
208 "Score and kill file handling."
212 "Kill files."
216 "Adaptive score files."
220 "Default values for score files."
224 "Expiring score rules."
228 "Decaying score rules."
232 "Score and kill file names."
237 "Various scoring and killing options."
240 ;; Other
242 "Options controlling the visual fluff."
247 "Offline support for Gnus."
251 "Files used by Gnus."
255 "Auto save file."
260 "Storing Gnus state."
264 "Options related to newsservers and other servers used by Gnus."
268 "Highlighting and menus in the server buffer."
273 "Composing replies and followups in Gnus."
277 "Meta variables controlling major portions of Gnus.
278 In general, modifying these variables does not take effect until Gnus
279 is restarted, and sometimes reloaded."
283 "Other Gnus options."
288 "Exiting Gnus."
293 "Frivolous Gnus extensions."
304 "If non-nil, the startup message will not be displayed.
305 This variable is used before `.gnus.el' is loaded, so it should
306 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 canceled 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"
1018 "*Color styles used for the Gnus logo."
1020 gnus-logo-color-alist))
1030 "Insert startup message in current buffer."
1031 ;; Insert the message.
1036 ;; Make sure the library defining `image-load-path' is
1037 ;; loaded (`find-image' is autoloaded) (and discard the
1038 ;; result). Else, we may get "defvar ignored because
1039 ;; image-load-path is let-bound" when calling `find-image'
1040 ;; below.
1050 :color-symbols
1054 :color-symbols
1059 ;; Account for the pbm's background.
1063 ;; Account for the xbm's background.
1074 t)))
1077 _ ___ _ _
1078 _ ___ __ ___ __ _ ___
1079 __ _ ___ __ ___
1080 _ ___ _
1081 _ _ __ _
1082 ___ __ _
1083 __ _
1084 _ _ _
1085 _ _ _
1086 _ _ _
1087 __ ___
1088 _ _ _ _
1089 _ _
1090 _ _
1091 _ _
1092 _
1093 __
1096 ;; And then hack it.
1105 ;; Fontify some.
1112 "Do color-symbol search-and-replace in svg file."
1123 color-symbols)
1125 list)))
1134 ;;; Do the rest.
1140 "Alist of group parameters.
1142 For example:
1144 (gnus-use-scoring nil)
1145 (gnus-summary-line-format
1147 (gcc-self . t)
1148 (display . all))
1151 (broken-reply-to . t)))"
1158 "If it is t, ignore case of group names specified in `gnus-parameters'.
1159 If it is nil, don't ignore case. If it is `default', which is for the
1160 backward compatibility, use the value of `case-fold-search'."
1171 "Define a group parameter PARAM.
1172 REST is a plist of following:
1173 :type One of `bool', `list' or nil.
1174 :function The name of the function.
1175 :function-document The documentation of the function.
1176 :parameter-type The type for customizing the parameter.
1177 :parameter-document The documentation for the parameter.
1178 :variable The name of the variable.
1179 :variable-document The documentation for the variable.
1180 :variable-group The group for customizing the variable.
1181 :variable-type The type for customizing the variable.
1182 :variable-default The default value of the variable."
1199 'progn
1201 ,variable-document
1207 gnus-group-parameters-more))
1210 ,parameter-type
1214 ,function-document
1216 val)
1219 t)
1224 (,variable
1226 elem value)
1234 ,function-document
1238 elem value)
1245 'value
1250 All other Gnus file and directory variables are initialized from this variable.
1252 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1253 This means that other directory variables that are initialized
1254 from this variable won't be set properly if you set this variable
1255 in `.gnus.el'. Set this variable in `.emacs' instead."
1261 "*Directory variable from which all other Gnus file variables are derived.
1263 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1264 This means that other directory variables that are initialized from
1265 this variable won't be set properly if you set this variable in `.gnus.el'.
1266 Set this variable in `.emacs' instead."
1271 "*Default directory for all Gnus buffers."
1274 directory))
1276 ;; Site dependent variables.
1278 ;; Should this be obsolete?
1280 "The hostname of the default NNTP server.
1281 The empty string, or nil, means to use the local host.
1282 You may wish to set this on a site-wide basis.
1284 If you want to change servers, you should use `gnus-select-method'."
1290 "A file with only the name of the nntp server in it."
1296 "Find default nntp server.
1297 Check the NNTPSERVER environment variable and the
1298 `gnus-nntpserver-file' file."
1306 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1307 ;; starting or even loading Gnus.
1308 ;;;###autoload(when (fboundp 'custom-autoload)
1309 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1315 gnus-default-nntp-server)
1317 "Default method for selecting a newsgroup.
1318 This variable should be a list, where the first element is how the
1319 news is to be fetched, the second is the address.
1322 NNTP, you could say:
1326 If you want to use your local spool, say:
1328 \(setq gnus-select-method (list 'nnspool (system-name)))
1330 If you use this variable, you must set `gnus-nntp-server' to nil.
1332 There is a lot more to know about select methods and virtual servers -
1333 see the manual for details."
1334 ;; Emacs has set-after since 22.1.
1335 ;set-after '(gnus-default-nntp-server)
1342 "*Method used for archiving messages you've sent.
1343 This should be a mail method.
1345 See also `gnus-update-message-archive-method'."
1349 gnus-select-method))
1354 The archive method is initially set according to the value of
1356 so that it may be used as a real method of the server which is named
1358 updated if the value of this variable is nil, even if you change the
1359 value of `gnus-message-archive-method' afterward. If you want the
1361 `gnus-message-archive-method', set this variable to a non-nil value."
1368 "*Name of the group in which to save the messages you've written.
1369 This can either be a string; a list of strings; or an alist
1370 of regexps/functions/forms to be evaluated to return a string (or a list
1371 of strings). The functions are called with the name of the current
1372 group (or nil) as a parameter.
1374 If you want to save your mail in one group and the news articles you
1375 write in another group, you could say something like:
1377 \(setq gnus-message-archive-group
1378 '((if (message-news-p)
1382 Normally the group names returned by this variable should be
1384 However, you may wish to store the message on some other server. In
1385 that case, just return a fully prefixed name of the group --
1393 function
1394 sexp
1395 string))
1398 "List of NNTP servers that the user can choose between interactively.
1399 To make Gnus query you for a server, you have to give `gnus' a
1400 non-numeric prefix - `C-u M-x gnus', in short."
1406 "A list of secondary methods that will be used for reading news.
1407 This is a list where each element is a complete select method (see
1408 `gnus-select-method').
1410 If, for instance, you want to read your mail with the nnml back end,
1411 you could set this variable:
1418 "Local domain name without a host name.
1419 The DOMAINNAME environment variable is used instead if it is defined.
1420 If the function `system-name' returns the full Internet name, there is
1421 no need to set this variable."
1424 string))
1427 ;; Customization variables
1430 "Preferred method for fetching an article by Message-ID.
1431 The value of this variable must be a valid select method as discussed
1432 in the documentation of `gnus-select-method'.
1434 It can also be a list of select methods, as well as the special symbol
1435 `current', which means to use the current select method. If it is a
1436 list, Gnus will try all the methods in the list until it finds a match."
1442 gnus-select-method
1443 sexp
1451 gnus-select-method))))
1454 "*Non-nil means that cross referenced articles will be marked as read.
1455 If nil, ignore cross references. If t, mark articles as read in
1456 subscribed newsgroups. If neither t nor nil, mark as read in all
1457 newsgroups."
1465 "*Process mark."
1471 "*The number of articles which indicates a large newsgroup.
1472 If the number of articles in a newsgroup is greater than this value,
1473 confirmation is required for selecting the newsgroup.
1474 If it is nil, no confirmation is required.
1476 Also see `gnus-large-ephemeral-newsgroup'."
1479 integer))
1482 "Non-nil means that the default name of a file to save articles in is the group name.
1483 If it's nil, the directory form of the group name is used instead.
1485 If this variable is a list, and the list contains the element
1486 `not-score', long file names will not be used for score files; if it
1487 contains the element `not-save', long file names will not be used for
1488 saving; and if it contains the element `not-kill', long file names
1489 will not be used for kill files.
1491 Note that the default for this variable varies according to what system
1492 type you're using. On `usg-unix-v' this variable defaults to nil while
1493 on all other systems it defaults to t."
1511 "*If non-nil, save group scoring info."
1517 "*If non-nil, allow undoing in Gnus group mode buffers."
1522 "*If non-nil, use some adaptive scoring scheme.
1523 If a list, then the values `word' and `line' are meaningful. The
1524 former will perform adaption on individual words in the subject
1525 header while `line' will perform adaption on several headers."
1531 "*If nil, Gnus will ignore the article cache.
1532 If `passive', it will allow entering (and reading) articles
1533 explicitly entered into the cache. If anything else, use the
1534 cache to the full extent of the law."
1542 "*If non-nil, display a thread tree buffer."
1547 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1548 If it is a number N, then Gnus will only keep the last N articles
1549 read. If it is neither nil nor a number, Gnus will keep all read
1550 articles. This is not a good idea."
1553 integer
1558 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1563 "*If non-nil, enable scoring."
1569 "*A hook called when preparing to exit from the summary buffer.
1570 It calls `gnus-summary-expire-articles' by default."
1575 "*Non-nil means that you are a Usenet novice.
1576 If non-nil, verbose messages may be displayed and confirmations may be
1577 required."
1582 "*Non-nil means that you will never be asked for confirmation about anything.
1583 That doesn't mean *anything* anything; particularly destructive
1584 commands will still require prompting."
1589 "*If non-nil, require your confirmation when catching up a group."
1594 "*If non-nil, require your confirmation when exiting Gnus.
1595 If `quiet', update any active summary buffers automatically
1596 first before exiting."
1602 "*Function for extracting address components from a From header.
1603 Two pre-defined function exist: `gnus-extract-address-components',
1604 which is the default, quite fast, and too simplistic solution, and
1605 `mail-extract-address-components', which works much better, but is
1606 slower."
1613 "String used to separate shell commands."
1635 server-marks)
1638 "*An alist of valid select methods.
1639 The first element of each list lists should be a string with the name
1640 of the select method. The other elements may be the category of
1641 this method (i. e., `post', `mail', `none' or whatever) or other
1642 properties that this method has (like being respoolable).
1643 If you implement a new select method, all you should have to change is
1644 this variable. I think."
1662 "Recomputes the select-method widget based on the value of
1663 `gnus-valid-select-methods'."
1665 "Widget for entering a select method."
1672 gnus-valid-select-methods)
1676 :inline t
1678 variable
1684 "List of buffers that should update their mode lines.
1685 The list may contain the symbols `group', `article', `tree' and
1686 `summary'. If the corresponding symbol is present, Gnus will keep
1687 that mode line updated with information that may be pertinent.
1688 If this variable is nil, screen refresh may be quicker."
1696 "*Max length of mode-line non-string contents.
1697 If this is nil, Gnus will take space as is needed, leaving the rest
1698 of the mode line intact."
1702 integer))
1704 ;; There should be special validation for this.
1709 to-address
1710 :function-document
1711 "Return GROUP's to-address."
1712 :variable-document
1713 "*Alist of group regexps and correspondent to-addresses."
1714 :variable-group gnus-group-parameter
1717 This will be used when doing followups and posts.
1719 This is primarily useful in mail groups that represent closed
1720 mailing lists--mailing lists where it's expected that everybody that
1721 writes to the mailing list is subscribed to it. Since using this
1722 parameter ensures that the mail only goes to the mailing list itself,
1723 it means that members won't receive two copies of your followups.
1725 Using `to-address' will actually work whether the group is foreign or
1726 not. Let's say there's a group on the server that is called
1727 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1728 articles from a mail-to-news gateway. Posting directly to this group
1729 is therefore impossible--you have to send mail to the mailing list
1730 address instead.
1732 The gnus-group-split mail splitting mechanism will behave as if this
1736 to-list
1737 :function-document
1738 "Return GROUP's to-list."
1739 :variable-document
1740 "*Alist of group regexps and correspondent to-lists."
1741 :variable-group gnus-group-parameter
1744 This address will be used when doing a `a' in the group.
1746 It is totally ignored when doing a followup--except that if it is
1747 present in a news group, you'll get mail group semantics when doing
1748 `f'.
1750 The gnus-group-split mail splitting mechanism will behave as if this
1754 subscribed
1755 :type bool
1756 :function-document
1757 "Return GROUP's subscription status."
1758 :variable-document
1759 "*Groups which are automatically considered subscribed."
1760 :variable-group gnus-group-parameter
1763 Gnus assumed that you are subscribed to the To/List address.
1765 When constructing a list of subscribed groups using
1766 `gnus-find-subscribed-addresses', Gnus includes the To address given
1770 auto-expire
1771 :type bool
1772 :function gnus-group-auto-expirable-p
1773 :function-document
1774 "Check whether GROUP is auto-expirable or not."
1775 :variable gnus-auto-expirable-newsgroups
1776 :variable-default nil
1777 :variable-document
1778 "*Groups in which to automatically mark read articles as expirable.
1779 If non-nil, this should be a regexp that should match all groups in
1780 which to perform auto-expiry. This only makes sense for mail groups."
1781 :variable-group nnmail-expire
1783 regexp)
1785 :parameter-document
1789 total-expire
1790 :type bool
1791 :function gnus-group-total-expirable-p
1792 :function-document
1793 "Check whether GROUP is total-expirable or not."
1794 :variable gnus-total-expirable-newsgroups
1795 :variable-default nil
1796 :variable-document
1797 "*Groups in which to perform expiry of all read articles.
1798 Use with extreme caution. All groups that match this regexp will be
1799 expiring - which means that all read articles will be deleted after
1800 \(say) one week. (This only goes for mail groups and the like, of
1801 course.)"
1802 :variable-group nnmail-expire
1804 regexp)
1806 :parameter-document
1807 "All read articles will be put through the expiry process
1809 This happens even if they are not marked as expirable.
1813 charset
1814 :function-document
1815 "Return the default charset of GROUP."
1816 :variable gnus-group-charset-alist
1817 :variable-default
1830 :variable-document
1831 "Alist of regexps (to match group names) and default charsets to be used when reading."
1832 :variable-group gnus-charset
1840 post-method
1841 :type list
1842 :function-document
1843 "Return a posting method for GROUP."
1844 :variable gnus-post-method-alist
1845 :variable-document
1846 "Alist of regexps (to match group names) and method to be used when
1847 posting an article."
1848 :variable-group gnus-group-foreign
1849 :parameter-type
1857 :parameter-document
1861 large-newsgroup-initial
1862 :type integer
1863 :function-document
1864 "Return GROUP's initial input of the number of articles."
1865 :variable-document
1866 "*Alist of group regexps and its initial input of the number of articles."
1867 :variable-group gnus-group-parameter
1873 This number will be prompted as the initial value of the number of
1874 articles to list when the group is a large newsgroup (see
1875 `gnus-large-newsgroup'). If it is nil, the default value is the
1878 ;; The Gnus registry's ignored groups
1880 registry-ignore
1881 :type list
1882 :function-document
1883 "Whether this group should be ignored by the registry."
1884 :variable gnus-registry-ignored-groups
1889 :variable-document
1890 "*Groups in which the registry should be turned off."
1891 :variable-group gnus-registry
1898 :parameter-document
1901 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1903 "*Disable the group parameters for spam detection.
1904 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1911 "Spam group classification (requires spam.el).
1912 This group contains spam messages. On summary entry, unread messages
1913 will be marked as spam. On summary exit, the specified spam
1914 processors will be invoked on spam-marked messages, then those
1915 messages will be expired, so the spam processor will only see a
1919 "The ham value for the spam group parameter (requires spam.el).
1920 On summary exit, the specified ham processors will be invoked on
1921 ham-marked messages. Exercise caution, since the ham processor will
1922 see the same message more than once because there is no ham message
1926 spam-contents
1927 :type list
1928 :function-document
1929 "The spam type (spam, ham, or neither) of the group."
1930 :variable gnus-spam-newsgroup-contents
1931 :variable-default nil
1932 :variable-document
1933 "*Group classification (spam, ham, or neither). Only
1934 meaningful when spam.el is loaded. If non-nil, this should be a
1935 list of group name regexps associated with a classification for
1936 each one. In spam groups, new articles are marked as spam on
1937 summary entry. There is other behavior associated with ham and
1938 no classification when spam.el is loaded - see the manual."
1939 :variable-group spam
1953 :parameter-document
1954 "The spam classification (spam, ham, or neither) of this group.
1955 When a spam group is entered, all unread articles are marked as
1956 spam. There is other behavior associated with ham and no
1960 spam-resend-to
1961 :type list
1962 :function-document
1963 "The address to get spam resent (through spam-report-resend)."
1964 :variable gnus-spam-resend-to
1965 :variable-default nil
1966 :variable-document
1967 "The address to get spam resent (through spam-report-resend)."
1968 :variable-group spam
1972 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1973 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1974 :parameter-document
1978 ham-resend-to
1979 :type list
1980 :function-document
1981 "The address to get ham resent (through spam-report-resend)."
1982 :variable gnus-ham-resend-to
1983 :variable-default nil
1984 :variable-document
1985 "The address to get ham resent (through spam-report-resend)."
1986 :variable-group spam
1990 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1991 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1992 :parameter-document
2008 "OBSOLETE: The Gmane reporting summary exit spam processor.
2015 "OBSOLETE: The ifile summary exit ham processor.
2019 "OBSOLETE: The Bogofilter summary exit ham processor.
2023 "OBSOLETE: The spam-stat summary exit ham processor.
2027 "OBSOLETE: The whitelist summary exit ham processor.
2031 "OBSOLETE: The BBDB summary exit ham processor.
2035 "OBSOLETE: The ham copy exit ham processor.
2039 "OBSOLETE: The spamoracle summary exit ham processor.
2043 spam-process
2044 :type list
2045 :parameter-type
2048 :value nil
2085 :function-document
2086 "Which spam or ham processors will be applied when the summary is exited."
2087 :variable gnus-spam-process-newsgroups
2088 :variable-default nil
2089 :variable-document
2090 "*Groups in which to automatically process spam or ham articles with
2091 a backend on summary exit. If non-nil, this should be a list of group
2092 name regexps that should match all groups in which to do automatic
2093 spam processing, associated with the appropriate processor."
2094 :variable-group spam
2095 :variable-type
2136 :parameter-document
2140 spam-autodetect
2141 :type list
2142 :parameter-type
2144 :function-document
2145 "Should spam be autodetected (with spam-split) in this group?"
2146 :variable gnus-spam-autodetect
2147 :variable-default nil
2148 :variable-document
2149 "*Groups in which spam should be autodetected when they are entered.
2150 Only unseen articles will be examined, unless
2151 spam-autodetect-recheck-messages is set."
2152 :variable-group spam
2153 :variable-type
2158 boolean))
2159 :parameter-document
2160 "Spam autodetection.
2161 Only unseen articles will be examined, unless
2165 spam-autodetect-methods
2166 :type list
2167 :parameter-type
2190 :function-document
2191 "Methods to be used for autodetection in each group"
2192 :variable gnus-spam-autodetect-methods
2193 :variable-default nil
2194 :variable-document
2195 "*Methods for autodetecting spam per group.
2196 Requires the spam-autodetect parameter. Only unseen articles
2197 will be examined, unless spam-autodetect-recheck-messages is
2198 set."
2199 :variable-group spam
2200 :variable-type
2227 :parameter-document
2228 "Spam autodetection methods.
2229 Requires the spam-autodetect parameter. Only unseen articles
2230 will be examined, unless spam-autodetect-recheck-messages is
2234 spam-process-destination
2235 :type list
2236 :parameter-type
2242 :function-document
2243 "Where spam-processed articles will go at summary exit."
2244 :variable gnus-spam-process-destinations
2245 :variable-default nil
2246 :variable-document
2247 "*Groups in which to explicitly send spam-processed articles to
2248 another group, or expire them (the default). If non-nil, this should
2249 be a list of group name regexps that should match all groups in which
2250 to do spam-processed article moving, associated with the destination
2251 group or nil for explicit expiration. This only makes sense for
2252 mail groups."
2253 :variable-group spam
2254 :variable-type
2265 :parameter-document
2269 ham-process-destination
2270 :type list
2271 :parameter-type
2279 :function-document
2280 "Where ham articles will go at summary exit from a spam group."
2281 :variable gnus-ham-process-destinations
2282 :variable-default nil
2283 :variable-document
2284 "*Groups in which to explicitly send ham articles to
2285 another group, or do nothing (the default). If non-nil, this should
2286 be a list of group name regexps that should match all groups in which
2287 to do ham article moving, associated with the destination
2288 group or nil for explicit ignoring. This only makes sense for
2289 mail groups, and only works in spam groups."
2290 :variable-group spam
2291 :variable-type
2303 :parameter-document
2307 ham-marks
2318 :parameter-document
2319 "Marks considered ham (positively not spam). Such articles will be
2320 processed as ham (non-spam) on group exit. When nil, the global
2321 spam-ham-marks variable takes precedence."
2323 gnus-read-mark
2324 gnus-killed-mark
2325 gnus-kill-file-mark
2326 gnus-low-score-mark))))
2327 :variable-group spam
2328 :variable-document
2332 spam-marks
2341 :parameter-document
2342 "Marks considered spam.
2343 Such articles will be processed as spam on group exit. When nil, the global
2344 spam-spam-marks variable takes precedence."
2346 :variable-group spam
2347 :variable-document
2351 "Number of group name elements to leave alone when making a short group name."
2356 "*If non-nil, once you set a level, Gnus will use this level."
2360 ;; Hooks.
2363 "A hook run while Gnus is loaded."
2368 "A hook called to apply kill files to a group.
2369 This hook is intended to apply a kill file to the selected newsgroup.
2370 The function `gnus-apply-kill-file' is called by default.
2372 Since a general kill file is too heavy to use only for a few
2373 newsgroups, I recommend you to use a lighter hook function. For
2374 example, if you'd like to apply a kill file to articles which contains
2375 a string `rmgroup' in subject in newsgroup `control', you can use the
2376 following hook:
2378 (setq gnus-apply-kill-hook
2379 (list
2380 (lambda ()
2389 "Function run when a group level is changed.
2390 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2393 function))
2395 ;;; Face thingies.
2399 mouse-face
2400 summary-menu group-menu article-menu
2401 tree-highlight menu highlight
2402 browse-menu server-menu
2403 page-marker tree-menu binary-menu pick-menu)
2404 "*Enable visual features.
2405 If `visual' is disabled, there will be no menus and few faces. Most of
2406 the visual customization options below will be ignored. Gnus will use
2407 less space and be faster as a result.
2409 This variable can also be a list of visual elements to switch on. For
2410 instance, to switch off all visual things except menus, you can say:
2412 (setq gnus-visual '(menu))
2414 Valid elements include `summary-highlight', `group-highlight',
2415 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2416 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2417 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2437 ;; Byte-compiler warning.
2439 ;; Find out whether the gnus-visual TYPE is wanted.
2443 gnus-visual
2447 t))))
2457 "*Face used for group or summary buffer mouse highlighting.
2458 The line beneath the mouse pointer will be highlighted with this
2459 face."
2472 "Controls use of the agent cache while plugged.
2473 When set, Gnus will prefer using the locally stored content rather
2474 than re-fetching it from the server. You also need to enable
2475 `gnus-agent' for this to have any affect."
2481 "Default charset assumed to be used when viewing non-ASCII characters.
2482 This variable is overridden on a group-to-group basis by the
2483 `gnus-group-charset-alist' variable and is only used on groups not
2484 covered by that variable."
2488 ;; Fixme: Doc reference to agent.
2490 "Whether we want to use the Gnus agent or not.
2492 You may customize gnus-agent to disable its use. However, some
2493 back ends have started to use the agent as a client-side cache.
2494 Disabling the agent may result in noticeable loss of performance."
2500 "Function called by the command `gnus-other-frame' when starting Gnus."
2508 "Function called by the command `gnus-other-frame' when resuming Gnus."
2518 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2519 This should be an alist for Emacs, or a plist for XEmacs."
2530 "Which information should be exposed in the User-Agent header.
2532 Can be a list of symbols or a string. Valid symbols are `gnus'
2533 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2534 addition to the Emacs version, you can add `codename' \(show
2535 \(S\)XEmacs codename\) or either `config' \(show system
2536 configuration\) or `type' \(show system type\). If you set it to
2537 a string, be sure to use a valid format, see RFC 2616."
2550 ;; Convert old (< 2005-01-10) symbol type values:
2569 \f
2570 ;;; Internal variables
2575 ; Reset each time gnus-agent-covered-methods is changed else
2576 ; gnus-agent-method-p may mis-report a methods status.
2577 )
2587 ;; The carpal mode has been removed, but define the variable for
2588 ;; backwards compatibility.
2607 ;; Variable holding the user answers to all method prompts.
2610 ;; Variable holding the user answers to all mail method prompts.
2613 ;; Variable holding the user answers to all group prompts.
2621 "*The directory where cached articles will be stored."
2627 nnspool "cache"
2652 ;; Propagate flags to server, with the following exceptions:
2653 ;; `seen' is private to each gnus installation
2654 ;; `cache' is a internal gnus flag for each gnus installation
2655 ;; `download' is a agent flag private to each gnus installation
2656 ;; `unsend' are for nndraft groups only
2657 ;; `score' is not a proper mark
2658 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2661 "Marks that shouldn't be propagated to back ends.
2662 Typical marks are those that make no sense in a standalone back end,
2663 such as a mark that says whether an article is stored in the cache
2676 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
2680 "gnus"
2704 gnus-newsrc-last-checked-date
2705 gnus-newsrc-alist gnus-server-alist
2706 gnus-killed-list gnus-zombie-list
2707 gnus-topic-topology gnus-topic-alist)
2711 "Assoc list of read articles.
2715 "Assoc list of registry data.
2742 ;; Save window configuration.
2755 ;;; End of variables.
2757 ;; Define some autoload functions Gnus might use.
2760 ;; This little mapcar goes through the list below and marks the
2761 ;; symbols in question as autoloaded functions.
2781 message-send-and-exit message-yank-original)
2785 ;; This is only used in message.el, which has an autoload.
2787 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2789 ;; Next two only used in gnus-util.
2790 rmail-summary-exists rmail-select-summary)
2791 ;; Only used in gnus-util, which has an autoload.
2796 gnus-Folder-save-name gnus-folder-save-name)
2799 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2800 gnus-demon-add-disconnection gnus-demon-add-handler
2801 gnus-demon-remove-handler)
2803 gnus-demon-init gnus-demon-cancel)
2805 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2806 gnus-face-from-file)
2808 gnus-tree-open gnus-tree-close)
2810 gnus-server-server-name)
2813 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2814 gnus-article-hide-citation gnus-article-fill-cited-article
2815 gnus-article-hide-citation-in-followups
2816 gnus-article-fill-cited-long-lines)
2818 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2819 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2821 gnus-registry-handle-action)
2823 gnus-cache-possibly-remove-articles gnus-cache-request-article
2824 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2825 gnus-cache-enter-remove-article gnus-cached-article-p
2826 gnus-cache-open gnus-cache-close gnus-cache-update-article
2827 gnus-cache-articles-in-group)
2829 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2831 gnus-summary-increase-score gnus-summary-set-score
2832 gnus-summary-raise-thread gnus-summary-raise-same-subject
2833 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2834 gnus-summary-lower-thread gnus-summary-lower-same-subject
2835 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2836 gnus-summary-current-score gnus-score-delta-default
2837 gnus-score-flush-cache gnus-score-close
2838 gnus-possibly-score-headers gnus-score-followup-article
2839 gnus-score-followup-thread)
2842 gnus-current-score-file-nondirectory gnus-score-adaptive
2843 gnus-score-find-trace gnus-score-file-name)
2847 gnus-subscribe-topics)
2851 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2852 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2853 gnus-uu-mark-by-regexp gnus-uu-mark-all
2854 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2855 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2856 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2857 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2858 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2859 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2860 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2861 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2864 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2866 gnus-group-post-news gnus-group-mail gnus-group-news
2867 gnus-summary-post-news gnus-summary-news-other-window
2868 gnus-summary-followup gnus-summary-followup-with-original
2869 gnus-summary-cancel-article gnus-summary-supersede-article
2870 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2871 gnus-summary-mail-forward gnus-summary-mail-other-window
2872 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2873 gnus-summary-wide-reply gnus-summary-followup-to-mail
2874 gnus-summary-followup-to-mail-with-original gnus-bug
2875 gnus-summary-wide-reply-with-original
2876 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2877 gnus-summary-post-forward)
2882 gnus-list-of-unread-articles gnus-list-of-read-articles
2883 gnus-offer-save-summaries gnus-make-thread-indent-array
2884 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2885 gnus-summary-skip-intangible gnus-summary-article-number
2886 gnus-data-header gnus-data-find)
2888 gnus-group-list-groups gnus-group-first-unread-group
2889 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2890 gnus-group-setup-buffer gnus-group-get-new-news
2891 gnus-group-make-help-group gnus-group-update-group
2892 gnus-group-iterate gnus-group-group-name)
2894 gnus-backlog-remove-article)
2896 gnus-article-prepare gnus-article-set-window-start
2897 gnus-article-next-page gnus-article-prev-page
2898 gnus-request-article-this-buffer gnus-article-mode
2899 gnus-article-setup-buffer gnus-narrow-to-page
2900 gnus-article-delete-invisible-text gnus-treat-article)
2902 gnus-article-hide-headers gnus-article-hide-boring-headers
2903 gnus-article-treat-overstrike
2904 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2905 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2906 gnus-article-de-base64-unreadable
2907 gnus-article-decode-HZ
2908 gnus-article-wash-html
2909 gnus-article-unsplit-urls
2910 gnus-article-hide-pem gnus-article-hide-signature
2911 gnus-article-strip-leading-blank-lines gnus-article-date-local
2912 gnus-article-date-original gnus-article-date-lapsed
2913 ;;gnus-article-show-all-headers
2914 gnus-article-edit-mode gnus-article-edit-article
2915 gnus-article-edit-done gnus-article-decode-encoded-words
2916 gnus-start-date-timer gnus-stop-date-timer
2917 gnus-mime-view-all-parts)
2920 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2921 gnus-check-reasonable-setup)
2923 gnus-dup-enter-articles)
2929 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2930 gnus-async-halt-prefetch)
2932 gnus-agent-save-active gnus-agent-method-p
2933 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2934 gnus-summary-set-agent-mark gnus-agent-save-group-info
2935 gnus-agent-request-article gnus-agent-retrieve-headers
2936 gnus-agent-store-article gnus-agent-group-covered-p)
2938 gnus-unplugged gnus-agentize gnus-agent-batch)
2940 gnus-summary-save-article-vm)
2945 gnus-group-split-update)
2948 ;;; gnus-sum.el thingies
2952 "*The format specification of the lines in the summary buffer.
2954 It works along the same lines as a normal formatting string,
2955 with some simple extensions.
2957 %N Article number, left padded with spaces (string)
2958 %S Subject (string)
2960 otherwise (string)
2961 %n Name of the poster (string)
2962 %a Extracted name of the poster (string)
2963 %A Extracted address of the poster (string)
2964 %F Contents of the From: header (string)
2965 %f Contents of the From: or To: headers (string)
2966 %x Contents of the Xref: header (string)
2967 %D Date of the article (string)
2968 %d Date of the article (string) in DD-MMM format
2969 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2970 format
2971 %M Message-id of the article (string)
2972 %r References of the article (string)
2973 %c Number of characters in the article (integer)
2974 %k Pretty-printed version of the above (string)
2976 %L Number of lines in the article (integer)
2977 %I Indentation based on thread level (a string of
2978 spaces)
2979 %B A complex trn-style thread tree (string)
2980 The variables `gnus-sum-thread-*' can be used for
2981 customization.
2982 %T A string with two possible values: 80 spaces if the
2983 article is on thread level two or larger and 0 spaces
2984 on level one
2986 otherwise (character)
2988 See Info node `(gnus)Marking Articles'
2991 %> Spaces of length thread-level (string)
2992 %< Spaces of length (- 20 thread-level) (string)
2993 %i Article score (number)
2994 %z Article zcore (character)
2995 %t Number of articles under the current thread (number).
2996 %e Whether the thread is empty or not (character).
2997 %V Total thread score (number).
2998 %P The line number (number).
2999 %O Download mark (character).
3000 %* If present, indicates desired cursor position
3001 (instead of after first colon).
3002 %u User defined specifier. The next character in the
3003 format string should be a letter. Gnus will call the
3004 function gnus-user-format-function-X, where X is the
3005 letter following %u. The function will be passed the
3006 current header as argument. The function should
3007 return a string, which will be inserted into the
3008 summary just like information from any other summary
3009 specifier.
3010 &user-date; Age sensitive date format. Various date format is
3011 defined in `gnus-user-date-format-alist'.
3014 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3015 with care. For reasons of efficiency, Gnus will compute what column
3017 it is invalid to have these specs after a variable-length spec. Well,
3018 you might not be arrested, but your summary buffer will look strange,
3019 which is bad enough.
3021 The smart choice is to have these specs as far to the left as
3022 possible.
3024 This restriction may disappear in later versions of Gnus.
3026 General format specifiers can also be used.
3027 See Info node `(gnus)Formatting Variables'."
3032 ;;;
3033 ;;; Skeleton keymaps
3034 ;;;
3039 (while keys
3040 (define-key keymap (pop keys) 'undefined))))
3042 (defvar gnus-article-mode-map
3043 (let ((keymap (make-sparse-keymap)))
3044 (gnus-suppress-keymap keymap)
3045 keymap))
3046 (defvar gnus-summary-mode-map
3047 (let ((keymap (make-keymap)))
3048 (gnus-suppress-keymap keymap)
3049 keymap))
3050 (defvar gnus-group-mode-map
3051 (let ((keymap (make-keymap)))
3052 (gnus-suppress-keymap keymap)
3053 keymap))
3055 \f
3057 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3058 ;; If you want the cursor to go somewhere else, set these two
3059 ;; functions in some startup hook to whatever you want.
3060 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3061 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3063 ;;; Various macros and substs.
3065 (defun gnus-header-from (header)
3066 (mail-header-from header))
3068 (defmacro gnus-gethash (string hashtable)
3069 "Get hash value of STRING in HASHTABLE."
3070 `(symbol-value (intern-soft ,string ,hashtable)))
3072 (defmacro gnus-gethash-safe (string hashtable)
3073 "Get hash value of STRING in HASHTABLE.
3074 Return nil if not defined."
3075 `(let ((sym (intern-soft ,string ,hashtable)))
3076 (and (boundp sym) (symbol-value sym))))
3078 (defmacro gnus-sethash (string value hashtable)
3079 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3080 `(set (intern ,string ,hashtable) ,value))
3081 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3083 (defmacro gnus-group-unread (group)
3084 "Get the currently computed number of unread articles in GROUP."
3085 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3087 (defmacro gnus-group-entry (group)
3088 "Get the newsrc entry for GROUP."
3089 `(gnus-gethash ,group gnus-newsrc-hashtb))
3091 (defmacro gnus-active (group)
3092 "Get active info on GROUP."
3093 `(gnus-gethash ,group gnus-active-hashtb))
3095 (defmacro gnus-set-active (group active)
3096 "Set GROUP's active info."
3097 `(gnus-sethash ,group ,active gnus-active-hashtb))
3099 ;; Info access macros.
3101 (defmacro gnus-info-group (info)
3102 `(nth 0 ,info))
3103 (defmacro gnus-info-rank (info)
3104 `(nth 1 ,info))
3105 (defmacro gnus-info-read (info)
3106 `(nth 2 ,info))
3107 (defmacro gnus-info-marks (info)
3108 `(nth 3 ,info))
3109 (defmacro gnus-info-method (info)
3110 `(nth 4 ,info))
3111 (defmacro gnus-info-params (info)
3112 `(nth 5 ,info))
3114 (defmacro gnus-info-level (info)
3115 `(let ((rank (gnus-info-rank ,info)))
3116 (if (consp rank)
3117 (car rank)
3118 rank)))
3119 (defmacro gnus-info-score (info)
3120 `(let ((rank (gnus-info-rank ,info)))
3121 (or (and (consp rank) (cdr rank)) 0)))
3123 (defmacro gnus-info-set-group (info group)
3124 `(setcar ,info ,group))
3125 (defmacro gnus-info-set-rank (info rank)
3126 `(setcar (nthcdr 1 ,info) ,rank))
3127 (defmacro gnus-info-set-read (info read)
3128 `(setcar (nthcdr 2 ,info) ,read))
3129 (defmacro gnus-info-set-marks (info marks &optional extend)
3130 (if extend
3131 `(gnus-info-set-entry ,info ,marks 3)
3132 `(setcar (nthcdr 3 ,info) ,marks)))
3133 (defmacro gnus-info-set-method (info method &optional extend)
3134 (if extend
3135 `(gnus-info-set-entry ,info ,method 4)
3136 `(setcar (nthcdr 4 ,info) ,method)))
3137 (defmacro gnus-info-set-params (info params &optional extend)
3138 (if extend
3139 `(gnus-info-set-entry ,info ,params 5)
3140 `(setcar (nthcdr 5 ,info) ,params)))
3142 (defun gnus-info-set-entry (info entry number)
3143 ;; Extend the info until we have enough elements.
3144 (while (<= (length info) number)
3145 (nconc info (list nil)))
3146 ;; Set the entry.
3147 (setcar (nthcdr number info) entry))
3149 (defmacro gnus-info-set-level (info level)
3150 `(let ((rank (cdr ,info)))
3151 (if (consp (car rank))
3152 (setcar (car rank) ,level)
3153 (setcar rank ,level))))
3154 (defmacro gnus-info-set-score (info score)
3155 `(let ((rank (cdr ,info)))
3156 (if (consp (car rank))
3157 (setcdr (car rank) ,score)
3158 (setcar rank (cons (car rank) ,score)))))
3160 (defmacro gnus-get-info (group)
3161 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3163 (defun gnus-set-info (group info)
3164 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3165 info))
3167 ;;; Load the compatibility functions.
3169 (require 'gnus-ems)
3171 \f
3172 ;;;
3173 ;;; Shutdown
3174 ;;;
3176 (defvar gnus-shutdown-alist nil)
3178 (defun gnus-add-shutdown (function &rest symbols)
3179 "Run FUNCTION whenever one of SYMBOLS is shut down."
3180 (push (cons function symbols) gnus-shutdown-alist))
3182 (defun gnus-shutdown (symbol)
3183 "Shut down everything that waits for SYMBOL."
3184 (dolist (entry gnus-shutdown-alist)
3185 (when (memq symbol (cdr entry))
3186 (funcall (car entry)))))
3188 \f
3189 ;;;
3190 ;;; Gnus Utility Functions
3191 ;;;
3193 (defun gnus-find-subscribed-addresses ()
3194 "Return a regexp matching the addresses of all subscribed mail groups.
3195 It consists of the `to-address' or `to-list' parameter of all groups
3196 with a `subscribed' parameter."
3197 (let (group address addresses)
3198 (dolist (entry (cdr gnus-newsrc-alist))
3199 (setq group (car entry))
3200 (when (gnus-parameter-subscribed group)
3201 (setq address (mail-strip-quoted-names
3202 (or (gnus-group-fast-parameter group 'to-address)
3203 (gnus-group-fast-parameter group 'to-list))))
3204 (when address
3205 (add-to-list 'addresses address))))
3206 (when addresses
3209 (defmacro gnus-string-or (&rest strings)
3210 "Return the first element of STRINGS that is a non-blank string.
3211 STRINGS will be evaluated in normal `or' order."
3212 `(gnus-string-or-1 (list ,@strings)))
3214 (defun gnus-string-or-1 (strings)
3215 (let (string)
3216 (while strings
3217 (setq string (pop strings))
3219 (setq string nil)
3220 (setq strings nil)))
3221 string))
3223 (defun gnus-version (&optional arg)
3224 "Version number of this version of Gnus.
3225 If ARG, insert string at point."
3226 (interactive "P")
3227 (if arg
3228 (insert (message gnus-version))
3229 (message gnus-version)))
3231 (defun gnus-continuum-version (&optional version)
3232 "Return VERSION as a floating point number."
3233 (unless version
3234 (setq version gnus-version))
3237 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3238 (number (match-string 2 version))
3239 major minor least)
3240 (unless (string-match
3242 (error "Invalid version string: %s" version))
3243 (setq major (string-to-number (match-string 1 number))
3244 minor (string-to-number (match-string 2 number))
3245 least (if (match-beginning 3)
3246 (string-to-number (match-string 3 number))
3247 0))
3248 (string-to-number
3249 (if (zerop major)
3250 (format "%1.2f00%02d%02d"
3251 (if (member alpha '("(ding)" "d"))
3252 4.99
3253 (+ 5 (* 0.02
3254 (abs
3255 (- (mm-char-int (aref (downcase alpha) 0))
3256 (mm-char-int ?t))))
3257 -0.01))
3258 minor least)
3259 (format "%d.%02d%02d" major minor least))))))
3261 (defun gnus-info-find-node (&optional nodename)
3262 "Find Info documentation of Gnus."
3263 (interactive)
3264 ;; Enlarge info window if needed.
3265 (let (gnus-info-buffer)
3266 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3267 (setq gnus-info-buffer (current-buffer))
3268 (gnus-configure-windows 'info)))
3270 ;;;
3271 ;;; gnus-interactive
3272 ;;;
3274 (defvar gnus-current-prefix-symbol nil
3275 "Current prefix symbol.")
3277 (defvar gnus-current-prefix-symbols nil
3278 "List of current prefix symbols.")
3280 (defun gnus-interactive (string &optional params)
3281 "Return a list that can be fed to `interactive'.
3282 See `interactive' for full documentation.
3284 Adds the following specs:
3286 y -- The current symbolic prefix.
3287 Y -- A list of the current symbolic prefix(es).
3288 A -- Article number.
3289 H -- Article header.
3290 g -- Group name."
3291 (let ((i 0)
3292 out c prompt)
3293 (while (< i (length string))
3295 (setq c (aref string i))
3296 (when (match-end 1)
3297 (setq prompt (match-string 1 string)))
3298 (setq i (match-end 0))
3299 ;; We basically emulate just about everything that
3300 ;; `interactive' does, but add the specs listed above.
3301 (push
3302 (cond
3303 ((= c ?a)
3304 (completing-read prompt obarray 'fboundp t))
3305 ((= c ?b)
3306 (read-buffer prompt (current-buffer) t))
3307 ((= c ?B)
3308 (read-buffer prompt (other-buffer (current-buffer))))
3309 ((= c ?c)
3310 (read-char))
3311 ((= c ?C)
3312 (completing-read prompt obarray 'commandp t))
3313 ((= c ?d)
3314 (point))
3315 ((= c ?D)
3316 (read-directory-name prompt nil default-directory 'lambda))
3317 ((= c ?f)
3318 (read-file-name prompt nil nil 'lambda))
3319 ((= c ?F)
3320 (read-file-name prompt))
3321 ((= c ?k)
3322 (read-key-sequence prompt))
3323 ((= c ?K)
3324 (error "Not implemented spec"))
3325 ((= c ?e)
3326 (error "Not implemented spec"))
3327 ((= c ?m)
3328 (mark))
3329 ((= c ?N)
3330 (error "Not implemented spec"))
3331 ((= c ?n)
3332 (string-to-number (read-from-minibuffer prompt)))
3333 ((= c ?p)
3334 (prefix-numeric-value current-prefix-arg))
3335 ((= c ?P)
3336 current-prefix-arg)
3337 ((= c ?r)
3338 'gnus-prefix-nil)
3339 ((= c ?s)
3340 (read-string prompt))
3341 ((= c ?S)
3342 (intern (read-string prompt)))
3343 ((= c ?v)
3344 (read-variable prompt))
3345 ((= c ?x)
3346 (read-minibuffer prompt))
3347 ((= c ?x)
3348 (eval-minibuffer prompt))
3349 ;; And here the new specs come.
3350 ((= c ?y)
3351 gnus-current-prefix-symbol)
3352 ((= c ?Y)
3353 gnus-current-prefix-symbols)
3354 ((= c ?g)
3355 (gnus-group-group-name))
3356 ((= c ?A)
3357 (gnus-summary-skip-intangible)
3358 (or (get-text-property (point) 'gnus-number)
3359 (gnus-summary-last-subject)))
3360 ((= c ?H)
3361 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3362 (t
3363 (error "Non-implemented spec")))
3364 out)
3365 (cond
3366 ((= c ?r)
3367 (push (if (< (point) (mark)) (point) (mark)) out)
3368 (push (if (> (point) (mark)) (point) (mark)) out))))
3369 (setq out (delq 'gnus-prefix-nil out))
3370 (nreverse out)))
3372 (defun gnus-symbolic-argument (&optional arg)
3373 "Read a symbolic argument and a command, and then execute command."
3374 (interactive "P")
3375 (let* ((in-command (this-command-keys))
3376 (command in-command)
3377 gnus-current-prefix-symbols
3378 gnus-current-prefix-symbol
3379 syms)
3380 (while (equal in-command command)
3381 (message "%s-" (key-description (this-command-keys)))
3382 (push (intern (char-to-string (read-char))) syms)
3383 (setq command (read-key-sequence nil t)))
3384 (setq gnus-current-prefix-symbols (nreverse syms)
3385 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3386 (call-interactively (key-binding command t))))
3388 ;;; More various functions.
3390 (defsubst gnus-check-backend-function (func group)
3391 "Check whether GROUP supports function FUNC.
3392 GROUP can either be a string (a group name) or a select method."
3393 (ignore-errors
3394 (let ((method (if (stringp group)
3395 (car (gnus-find-method-for-group group))
3396 group)))
3397 (unless (featurep method)
3398 (require method))
3399 (fboundp (intern (format "%s-%s" method func))))))
3401 (defun gnus-group-read-only-p (&optional group)
3402 "Check whether GROUP supports editing or not.
3403 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3404 that that variable is buffer-local to the summary buffers."
3405 (let ((group (or group gnus-newsgroup-name)))
3406 (not (gnus-check-backend-function 'request-replace-article group))))
3408 (defun gnus-virtual-group-p (group)
3409 "Say whether GROUP is virtual or not."
3410 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3411 gnus-valid-select-methods)))
3413 (defun gnus-news-group-p (group &optional article)
3414 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3415 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3416 t) ;is news of course.
3417 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3418 nil) ;must be mail then.
3419 ((vectorp article) ;Has header info.
3420 (eq (gnus-request-type group (mail-header-id article)) 'news))
3421 ((null article) ;Hasn't header info
3422 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3423 ((< article 0) ;Virtual message
3424 nil) ;we don't know, guess mail.
3425 (t ;Has positive number
3426 (eq (gnus-request-type group article) 'news)))) ;use it.
3428 ;; Check whether to use long file names.
3429 (defun gnus-use-long-file-name (symbol)
3430 ;; The variable has to be set...
3431 (and gnus-use-long-file-name
3432 ;; If it isn't a list, then we return t.
3433 (or (not (listp gnus-use-long-file-name))
3434 ;; If it is a list, and the list contains `symbol', we
3435 ;; return nil.
3436 (not (memq symbol gnus-use-long-file-name)))))
3438 ;; Generate a unique new group name.
3439 (defun gnus-generate-new-group-name (leaf)
3440 (let ((name leaf)
3441 (num 0))
3442 (while (gnus-group-entry name)
3443 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3444 name))
3446 (defun gnus-ephemeral-group-p (group)
3447 "Say whether GROUP is ephemeral or not."
3448 (gnus-group-get-parameter group 'quit-config t))
3450 (defun gnus-group-quit-config (group)
3451 "Return the quit-config of GROUP."
3452 (gnus-group-get-parameter group 'quit-config t))
3454 (defun gnus-kill-ephemeral-group (group)
3455 "Remove ephemeral GROUP from relevant structures."
3456 (gnus-sethash group nil gnus-newsrc-hashtb))
3458 (defun gnus-simplify-mode-line ()
3459 "Make mode lines a bit simpler."
3460 (setq mode-line-modified (cdr gnus-mode-line-modified))
3461 (when (listp mode-line-format)
3462 (make-local-variable 'mode-line-format)
3463 (setq mode-line-format (copy-sequence mode-line-format))
3464 (when (equal (nth 3 mode-line-format) " ")
3465 (setcar (nthcdr 3 mode-line-format) " "))))
3467 ;;; Servers and groups.
3469 (defsubst gnus-server-add-address (method)
3470 (let ((method-name (symbol-name (car method))))
3471 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3472 (not (assq (intern (concat method-name "-address")) method))
3473 (memq 'physical-address (assq (car method)
3474 gnus-valid-select-methods)))
3475 (append method (list (list (intern (concat method-name "-address"))
3476 (nth 1 method))))
3477 method)))
3479 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3480 (catch 'server-name
3481 (setq method (or method gnus-select-method))
3483 ;; Perhaps it is already in the cache.
3484 (unless nocache
3485 (mapc (lambda (name-method)
3486 (if (equal (cdr name-method) method)
3487 (throw 'server-name (car name-method))))
3488 gnus-server-method-cache))
3490 (mapc
3491 (lambda (server-alist)
3492 (mapc (lambda (name-method)
3493 (when (gnus-methods-equal-p (cdr name-method) method)
3494 (unless (member name-method gnus-server-method-cache)
3495 (push name-method gnus-server-method-cache))
3496 (throw 'server-name (car name-method))))
3497 server-alist))
3498 (list gnus-server-alist
3499 gnus-predefined-server-alist))
3501 (let* ((name (if (member (cadr method) '(nil ""))
3502 (format "%s" (car method))
3503 (format "%s:%s" (car method) (cadr method))))
3504 (name-method (cons name method)))
3505 (when (and (not (member name-method gnus-server-method-cache))
3506 (not no-enter-cache)
3507 (not (assoc (car name-method) gnus-server-method-cache)))
3508 (push name-method gnus-server-method-cache))
3509 name)))
3511 (defsubst gnus-server-to-method (server)
3512 "Map virtual server names to select methods."
3513 (or (and server (listp server) server)
3514 (cdr (assoc server gnus-server-method-cache))
3515 (let ((result
3516 (or
3517 ;; Perhaps this is the native server?
3518 (and (equal server "native") gnus-select-method)
3519 ;; It should be in the server alist.
3520 (cdr (assoc server gnus-server-alist))
3521 ;; It could be in the predefined server alist.
3522 (cdr (assoc server gnus-predefined-server-alist))
3523 ;; If not, we look through all the opened server
3524 ;; to see whether we can find it there.
3525 (let ((opened gnus-opened-servers))
3526 (while (and opened
3527 (not (equal server (format "%s:%s" (caaar opened)
3528 (cadaar opened)))))
3529 (pop opened))
3530 (caar opened))
3531 ;; It could be a named method, search all servers
3532 (let ((servers gnus-secondary-select-methods))
3533 (while (and servers
3534 (not (equal server (format "%s:%s" (caar servers)
3535 (cadar servers)))))
3536 (pop servers))
3537 (car servers))
3538 ;; This could be some sort of foreign server that I
3539 ;; simply haven't opened (yet). Do a brute-force scan
3540 ;; of the entire gnus-newsrc-alist for the server name
3541 ;; of every method. As a side-effect, loads the
3542 ;; gnus-server-method-cache so this only happens once,
3543 ;; if at all.
3544 (let ((alist (cdr gnus-newsrc-alist))
3545 method match)
3546 (while alist
3547 (setq method (gnus-info-method (pop alist)))
3548 (when (and (not (stringp method))
3549 (equal server
3550 (gnus-method-to-server method nil t)))
3551 (setq match method
3552 alist nil)))
3553 match))))
3554 (when (and result
3555 (not (assoc server gnus-server-method-cache)))
3556 (push (cons server result) gnus-server-method-cache))
3557 result)))
3559 (defsubst gnus-server-get-method (group method)
3560 ;; Input either a server name, and extended server name, or a
3561 ;; select method, and return a select method.
3562 (cond ((stringp method)
3563 (gnus-server-to-method method))
3564 ((equal method gnus-select-method)
3565 gnus-select-method)
3566 ((and (stringp (car method))
3567 group)
3568 (gnus-server-extend-method group method))
3569 ((and method
3570 (not group)
3571 (equal (cadr method) ""))
3572 method)
3573 (t
3574 (gnus-server-add-address method))))
3576 (defmacro gnus-method-equal (ss1 ss2)
3577 "Say whether two servers are equal."
3578 `(let ((s1 ,ss1)
3579 (s2 ,ss2))
3580 (or (equal s1 s2)
3581 (and (= (length s1) (length s2))
3582 (progn
3583 (while (and s1 (member (car s1) s2))
3584 (setq s1 (cdr s1)))
3585 (null s1))))))
3587 (defun gnus-methods-equal-p (m1 m2)
3588 (let ((m1 (or m1 gnus-select-method))
3589 (m2 (or m2 gnus-select-method)))
3590 (or (equal m1 m2)
3591 (and (eq (car m1) (car m2))
3592 (or (not (memq 'address (assoc (symbol-name (car m1))
3593 gnus-valid-select-methods)))
3594 (equal (nth 1 m1) (nth 1 m2)))))))
3596 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3597 ;; Check parameters for sloppy equality.
3598 (let ((p1 (copy-sequence (cddr m1)))
3599 (p2 (copy-sequence (cddr m2)))
3600 e1 e2)
3601 (block nil
3602 (while (setq e1 (pop p1))
3603 (unless (setq e2 (assq (car e1) p2))
3604 ;; The parameter doesn't exist in p2.
3605 (return nil))
3606 (setq p2 (delq e2 p2))
3607 (unless (equal e1 e2)
3608 (if (not (and (stringp (cadr e1))
3609 (stringp (cadr e2))))
3610 (return nil)
3611 ;; Special-case string parameter comparison so that we
3612 ;; can uniquify them.
3613 (let ((s1 (cadr e1))
3614 (s2 (cadr e2)))
3615 (when (string-match "/$" s1)
3616 (setq s1 (directory-file-name s1)))
3617 (when (string-match "/$" s2)
3618 (setq s2 (directory-file-name s2)))
3619 (unless (equal s1 s2)
3620 (return nil))))))
3621 ;; If p2 now is empty, they were equal.
3622 (null p2))))
3624 (defun gnus-method-ephemeral-p (method)
3625 (let ((equal nil))
3626 (dolist (ephemeral gnus-ephemeral-servers)
3627 (when (gnus-sloppily-equal-method-parameters method ephemeral)
3628 (setq equal t)))
3629 equal))
3631 (defun gnus-methods-sloppily-equal (m1 m2)
3632 ;; Same method.
3633 (or
3634 (eq m1 m2)
3635 ;; Type and name are equal.
3636 (and
3637 (eq (car m1) (car m2))
3638 (equal (cadr m1) (cadr m2))
3639 (gnus-sloppily-equal-method-parameters m1 m2))))
3641 (defun gnus-server-equal (m1 m2)
3642 "Say whether two methods are equal."
3643 (let ((m1 (cond ((null m1) gnus-select-method)
3644 ((stringp m1) (gnus-server-to-method m1))
3645 (t m1)))
3646 (m2 (cond ((null m2) gnus-select-method)
3647 ((stringp m2) (gnus-server-to-method m2))
3648 (t m2))))
3649 (gnus-method-equal m1 m2)))
3651 (defun gnus-servers-using-backend (backend)
3652 "Return a list of known servers using BACKEND."
3653 (let ((opened gnus-opened-servers)
3654 out)
3655 (while opened
3656 (when (eq backend (caaar opened))
3657 (push (caar opened) out))
3658 (pop opened))
3659 out))
3661 (defun gnus-archive-server-wanted-p ()
3662 "Say whether the user wants to use the archive server."
3663 (cond
3664 ((or (not gnus-message-archive-method)
3665 (not gnus-message-archive-group))
3666 nil)
3667 ((and gnus-message-archive-method gnus-message-archive-group)
3668 t)
3669 (t
3670 (let ((active (cadr (assq 'nnfolder-active-file
3671 gnus-message-archive-method))))
3672 (and active
3673 (file-exists-p active))))))
3675 (defsubst gnus-method-to-server-name (method)
3676 (concat
3677 (format "%s" (car method))
3678 (when (and
3679 (or (assoc (format "%s" (car method))
3680 (gnus-methods-using 'address))
3681 (gnus-server-equal method gnus-message-archive-method))
3682 (nth 1 method)
3683 (not (string= (nth 1 method) "")))
3684 (concat "+" (nth 1 method)))))
3686 (defsubst gnus-method-to-full-server-name (method)
3687 (format "%s+%s" (car method) (nth 1 method)))
3689 (defun gnus-group-prefixed-name (group method &optional full)
3690 "Return the whole name from GROUP and METHOD.
3691 Call with full set to get the fully qualified group name (even if the
3692 server is native)."
3693 (when (stringp method)
3694 (setq method (gnus-server-to-method method)))
3695 (if (or (not method)
3696 (and (not full) (gnus-server-equal method "native"))
3697 ;;;!!! This might not be right. We'll see...
3698 ;(string-match ":" group)
3699 )
3700 group
3701 (concat (gnus-method-to-server-name method) ":" group)))
3703 (defun gnus-group-full-name (group method)
3704 "Return the full name from GROUP and METHOD, even if the method is native."
3705 (gnus-group-prefixed-name group method t))
3707 (defun gnus-group-guess-full-name-from-command-method (group)
3708 "Guess the full name from GROUP, even if the method is native."
3709 (if (gnus-group-prefixed-p group)
3710 group
3711 (gnus-group-full-name group gnus-command-method)))
3713 (defun gnus-group-real-prefix (group)
3714 "Return the prefix of the current group name."
3715 (if (stringp group)
3716 (if (string-match "^[^:]+:" group)
3717 (substring group 0 (match-end 0))
3718 "")
3719 nil))
3721 (defun gnus-group-short-name (group)
3722 "Return the short group name."
3723 (let ((prefix (gnus-group-real-prefix group)))
3724 (if (< 0 (length prefix))
3725 (substring group (length prefix) nil)
3726 group)))
3728 (defun gnus-group-prefixed-p (group)
3729 "Return the prefix of the current group name."
3730 (< 0 (length (gnus-group-real-prefix group))))
3732 (declare-function gnus-group-decoded-name "gnus-group" (string))
3734 (defun gnus-summary-buffer-name (group)
3735 "Return the summary buffer name of GROUP."
3736 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3738 (defun gnus-group-method (group)
3739 "Return the server or method used for selecting GROUP.
3740 You should probably use `gnus-find-method-for-group' instead."
3741 (let ((prefix (gnus-group-real-prefix group)))
3742 (if (equal prefix "")
3743 gnus-select-method
3744 (let ((servers gnus-opened-servers)
3745 (server "")
3746 backend possible found)
3748 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3749 server (substring prefix (match-end 0) (1- (length prefix))))
3750 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3751 (while servers
3752 (when (eq (caaar servers) backend)
3753 (setq possible (caar servers))
3754 (when (equal (cadaar servers) server)
3755 (setq found (caar servers))))
3756 (pop servers))
3757 (or (car (rassoc found gnus-server-alist))
3758 found
3759 (car (rassoc possible gnus-server-alist))
3760 possible
3761 (list backend server))))))
3763 (defsubst gnus-native-method-p (method)
3764 "Return whether METHOD is the native select method."
3765 (gnus-method-equal method gnus-select-method))
3767 (defsubst gnus-secondary-method-p (method)
3768 "Return whether METHOD is a secondary select method."
3769 (let ((methods gnus-secondary-select-methods)
3770 (gmethod (inline (gnus-server-get-method nil method))))
3771 (while (and methods
3772 (not (gnus-method-equal
3773 (inline (gnus-server-get-method nil (car methods)))
3774 gmethod)))
3775 (setq methods (cdr methods)))
3776 methods))
3778 (defun gnus-method-simplify (method)
3779 "Return the shortest uniquely identifying string or method for METHOD."
3780 (cond ((stringp method)
3781 method)
3782 ((gnus-native-method-p method)
3783 nil)
3784 ((gnus-secondary-method-p method)
3785 (format "%s:%s" (nth 0 method) (nth 1 method)))
3786 (t
3787 method)))
3789 (defun gnus-groups-from-server (server)
3790 "Return a list of all groups that are fetched from SERVER."
3791 (let ((alist (cdr gnus-newsrc-alist))
3792 info groups)
3793 (while (setq info (pop alist))
3794 (when (gnus-server-equal (gnus-info-method info) server)
3795 (push (gnus-info-group info) groups)))
3796 (sort groups 'string<)))
3798 (defun gnus-group-foreign-p (group)
3799 "Say whether a group is foreign or not."
3800 (and (not (gnus-group-native-p group))
3801 (not (gnus-group-secondary-p group))))
3803 (defun gnus-group-native-p (group)
3804 "Say whether the group is native or not."
3805 (not (string-match ":" group)))
3807 (defun gnus-group-secondary-p (group)
3808 "Say whether the group is secondary or not."
3809 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3811 (defun gnus-parameters-get-parameter (group)
3812 "Return the group parameters for GROUP from `gnus-parameters'."
3813 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3814 case-fold-search
3815 gnus-parameters-case-fold-search))
3816 params-list)
3817 (dolist (elem gnus-parameters)
3818 (when (string-match (car elem) group)
3819 (setq params-list
3820 (nconc (gnus-expand-group-parameters
3821 (car elem) (cdr elem) group)
3822 params-list))))
3823 params-list))
3825 (defun gnus-expand-group-parameter (match value group)
3826 "Use MATCH to expand VALUE in GROUP."
3827 (let ((start (string-match match group)))
3828 (if start
3829 (let ((matched-string (substring group start (match-end 0))))
3830 ;; Build match groups
3831 (string-match match matched-string)
3832 (replace-match value nil nil matched-string))
3833 group)))
3835 (defun gnus-expand-group-parameters (match parameters group)
3836 "Go through PARAMETERS and expand them according to the match data."
3837 (let (new)
3838 (dolist (elem parameters)
3839 (cond
3840 ((and (stringp (cdr elem))
3842 (push (cons (car elem)
3843 (gnus-expand-group-parameter match (cdr elem) group))
3844 new))
3845 ;; For `sieve' group parameters, perform substitutions for every
3846 ;; string within the match rule. This allows for parameters such
3847 ;; as:
3850 ((eq 'sieve (car elem))
3851 (push (mapcar (lambda (sieve-elem)
3852 (if (and (stringp sieve-elem)
3854 (gnus-expand-group-parameter match sieve-elem
3855 group)
3856 sieve-elem))
3857 (cdr elem))
3858 new))
3859 (t
3860 (push elem new))))
3861 new))
3863 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3864 "For GROUP, return the value of SYMBOL.
3866 You should call this in the `gnus-group-buffer' buffer.
3867 The function `gnus-group-find-parameter' will do that for you."
3868 ;; The speed trick: No cons'ing and quit early.
3869 (let* ((params (funcall gnus-group-get-parameter-function group))
3870 ;; Start easy, check the "real" group parameters.
3871 (simple-results
3872 (gnus-group-parameter-value params symbol allow-list t)))
3873 (if simple-results
3874 ;; Found results; return them.
3875 (car simple-results)
3876 ;; We didn't find it there, try `gnus-parameters'.
3877 (let ((result nil)
3878 (head nil)
3879 (tail gnus-parameters))
3880 ;; A good old-fashioned non-cl loop.
3881 (while tail
3882 (setq head (car tail)
3883 tail (cdr tail))
3884 ;; The car is regexp matching for matching the group name.
3885 (when (string-match (car head) group)
3886 ;; The cdr is the parameters.
3887 (let ((this-result
3888 (gnus-group-parameter-value (cdr head) symbol allow-list t)))
3889 (when this-result
3890 (setq result (car this-result))
3891 ;; Expand if necessary.
3892 (cond
3894 (setq result (gnus-expand-group-parameter
3895 (car head) result group)))
3896 ;; For `sieve' group parameters, perform substitutions
3897 ;; for every string within the match rule (see above).
3898 ((eq symbol 'sieve)
3899 (setq result
3900 (mapcar (lambda (elem)
3901 (if (stringp elem)
3902 (gnus-expand-group-parameter (car head)
3903 elem group)
3904 elem))
3905 result))))))))
3906 ;; Done.
3907 result))))
3909 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3910 "Return the group parameters for GROUP.
3911 If SYMBOL, return the value of that symbol in the group parameters.
3913 If you call this function inside a loop, consider using the faster
3914 `gnus-group-fast-parameter' instead."
3915 (with-current-buffer (if (buffer-live-p (get-buffer gnus-group-buffer))
3916 gnus-group-buffer
3917 (current-buffer))
3918 (if symbol
3919 (gnus-group-fast-parameter group symbol allow-list)
3920 (nconc
3921 (copy-sequence
3922 (funcall gnus-group-get-parameter-function group))
3923 (gnus-parameters-get-parameter group)))))
3925 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3926 "Return the group parameters for GROUP.
3927 If SYMBOL, return the value of that symbol in the group parameters.
3928 If ALLOW-LIST, also allow list as a result.
3929 Most functions should use `gnus-group-find-parameter', which
3930 also examines the topic parameters."
3931 (let ((params (gnus-info-params (gnus-get-info group))))
3932 (if symbol
3933 (gnus-group-parameter-value params symbol allow-list)
3934 params)))
3936 (defun gnus-group-parameter-value (params symbol &optional
3937 allow-list present-p)
3938 "Return the value of SYMBOL in group PARAMS.
3939 If ALLOW-LIST, also allow list as a result."
3940 ;; We only wish to return group parameters (dotted lists) and
3941 ;; not local variables, which may have the same names.
3942 ;; But first we handle single elements...
3943 (or (car (memq symbol params))
3944 ;; Handle alist.
3945 (let (elem)
3946 (catch 'found
3947 (while (setq elem (pop params))
3948 (when (and (consp elem)
3949 (eq (car elem) symbol)
3950 (or allow-list
3951 (atom (cdr elem))))
3952 (throw 'found (if present-p (list (cdr elem))
3953 (cdr elem)))))))))
3955 (defun gnus-group-add-parameter (group param)
3956 "Add parameter PARAM to GROUP."
3957 (let ((info (gnus-get-info group)))
3958 (when info
3959 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3960 ;; Cons the new param to the old one and update.
3961 (gnus-group-set-info (cons param (gnus-info-params info))
3962 group 'params))))
3964 (defun gnus-group-set-parameter (group name value)
3965 "Set parameter NAME to VALUE in GROUP.
3966 GROUP can also be an INFO structure."
3967 (let ((info (if (listp group)
3968 group
3969 (gnus-get-info group))))
3970 (when info
3971 (gnus-group-remove-parameter group name)
3972 (let ((old-params (gnus-info-params info))
3973 (new-params (list (cons name value))))
3974 (while old-params
3975 (when (or (not (listp (car old-params)))
3976 (not (eq (caar old-params) name)))
3977 (setq new-params (append new-params (list (car old-params)))))
3978 (setq old-params (cdr old-params)))
3979 (if (listp group)
3980 (gnus-info-set-params info new-params t)
3981 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3983 (defun gnus-group-remove-parameter (group name)
3984 "Remove parameter NAME from GROUP.
3985 GROUP can also be an INFO structure."
3986 (let ((info (if (listp group)
3987 group
3988 (gnus-get-info group))))
3989 (when info
3990 (let ((params (gnus-info-params info)))
3991 (when params
3992 (setq params (delq name params))
3993 (while (assq name params)
3994 (gnus-alist-pull name params))
3995 (gnus-info-set-params info params))))))
3997 (defun gnus-group-add-score (group &optional score)
3998 "Add SCORE to the GROUP score.
3999 If SCORE is nil, add 1 to the score of GROUP."
4000 (let ((info (gnus-get-info group)))
4001 (when info
4002 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
4004 (defun gnus-short-group-name (group &optional levels)
4005 "Collapse GROUP name LEVELS.
4006 Select methods are stripped and any remote host name is stripped down to
4007 just the host name."
4008 (let* ((name "")
4009 (foreign "")
4010 (depth 0)
4011 (skip 1)
4012 (levels (or levels
4013 gnus-group-uncollapsed-levels
4014 (progn
4016 (setq skip (match-end 0)
4017 depth (+ depth 1)))
4018 depth))))
4019 ;; Separate foreign select method from group name and collapse.
4020 ;; If method contains a server, collapse to non-domain server name,
4021 ;; otherwise collapse to select method.
4022 (let* ((colon (string-match ":" group))
4023 (server (and colon (substring group 0 colon)))
4024 (plus (and server (string-match "+" server))))
4025 (when server
4026 (if plus
4027 (setq foreign (substring server (+ 1 plus)
4029 group (substring group (+ 1 colon)))
4030 (setq foreign server
4031 group (substring group (+ 1 colon))))
4032 (setq foreign (concat foreign ":")))
4033 ;; Collapse group name leaving LEVELS uncollapsed elements
4034 (let* ((slist (split-string group "/"))
4035 (slen (length slist))
4037 (dlen (length dlist))
4038 glist
4039 glen
4040 gsep
4041 res)
4042 (if (> slen dlen)
4043 (setq glist slist
4044 glen slen
4045 gsep "/")
4046 (setq glist dlist
4047 glen dlen
4048 gsep "."))
4049 (setq levels (- glen levels))
4050 (dolist (g glist)
4051 (push (if (>= (decf levels) 0)
4052 (if (zerop (length g))
4053 ""
4054 (substring g 0 1))
4055 g)
4056 res))
4057 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4059 (defun gnus-narrow-to-body ()
4060 "Narrow to the body of an article."
4061 (narrow-to-region
4062 (progn
4063 (goto-char (point-min))
4065 (point-max)))
4066 (point-max)))
4068 \f
4069 ;;;
4070 ;;; Kill file handling.
4071 ;;;
4073 (defun gnus-apply-kill-file ()
4074 "Apply a kill file to the current newsgroup.
4075 Returns the number of articles marked as read."
4076 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4077 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4078 (gnus-apply-kill-file-internal)
4079 0))
4081 (defun gnus-kill-save-kill-buffer ()
4082 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4083 (when (get-file-buffer file)
4084 (with-current-buffer (get-file-buffer file)
4085 (when (buffer-modified-p)
4086 (save-buffer))
4087 (kill-buffer (current-buffer))))))
4089 (defcustom gnus-kill-file-name "KILL"
4090 "Suffix of the kill files."
4091 :group 'gnus-score-kill
4092 :group 'gnus-score-files
4093 :type 'string)
4095 (defun gnus-newsgroup-kill-file (newsgroup)
4096 "Return the name of a kill file name for NEWSGROUP.
4097 If NEWSGROUP is nil, return the global kill file name instead."
4098 (cond
4099 ;; The global KILL file is placed at top of the directory.
4100 ((or (null newsgroup)
4101 (string-equal newsgroup ""))
4102 (expand-file-name gnus-kill-file-name
4103 gnus-kill-files-directory))
4104 ;; Append ".KILL" to newsgroup name.
4105 ((gnus-use-long-file-name 'not-kill)
4106 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4107 "." gnus-kill-file-name)
4108 gnus-kill-files-directory))
4109 ;; Place "KILL" under the hierarchical directory.
4110 (t
4111 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4112 "/" gnus-kill-file-name)
4113 gnus-kill-files-directory))))
4115 ;;; Server things.
4117 (defun gnus-member-of-valid (symbol group)
4119 (memq symbol (assoc
4120 (symbol-name (car (gnus-find-method-for-group group)))
4121 gnus-valid-select-methods)))
4123 (defun gnus-method-option-p (method option)
4124 "Return non-nil if select METHOD has OPTION as a parameter."
4125 (when (stringp method)
4126 (setq method (gnus-server-to-method method)))
4127 (memq option (assoc (format "%s" (car method))
4128 gnus-valid-select-methods)))
4130 (defun gnus-similar-server-opened (method)
4131 "Return non-nil if we have a similar server opened.
4132 This is defined as a server with the same name, but different
4133 parameters."
4134 (let ((opened gnus-opened-servers)
4135 open)
4136 (while (and method opened)
4137 (setq open (car (pop opened)))
4138 ;; Type and name are the same...
4139 (when (and (equal (car method) (car open))
4140 (equal (cadr method) (cadr open))
4141 ;; ... but the rest of the parameters differ.
4142 (not (gnus-methods-sloppily-equal method open)))
4143 (setq method nil)))
4144 (not method)))
4146 (defun gnus-server-extend-method (group method)
4147 ;; This function "extends" a virtual server. If the server is
4148 ;; "hello", and the select method is ("hello" (my-var "something"))
4149 ;; in the group "alt.alt", this will result in a new virtual server
4150 ;; called "hello+alt.alt".
4151 (if (or (not (inline (gnus-similar-server-opened method)))
4152 (not (cddr method)))
4153 method
4154 (let ((address-slot
4155 (intern (format "%s-address" (car method)))))
4156 (setq method
4157 (if (assq address-slot (cddr method))
4158 `(,(car method) ,(concat (cadr method) "+" group)
4159 ,@(cddr method))
4160 `(,(car method) ,(concat (cadr method) "+" group)
4161 (,address-slot ,(cadr method))
4162 ,@(cddr method))))
4163 (push method gnus-extended-servers)
4164 method)))
4166 (defun gnus-server-status (method)
4167 "Return the status of METHOD."
4168 (nth 1 (assoc method gnus-opened-servers)))
4170 (defun gnus-group-name-to-method (group)
4171 "Guess a select method based on GROUP."
4172 (if (string-match ":" group)
4173 (let ((server (substring group 0 (match-beginning 0))))
4175 (list (intern (substring server 0 (match-beginning 0)))
4176 (substring server (match-end 0)))
4177 (list (intern server) "")))
4178 gnus-select-method))
4180 (defun gnus-server-string (server)
4181 "Return a readable string that describes SERVER."
4182 (let* ((server (gnus-server-to-method server))
4183 (address (nth 1 server)))
4184 (if (and address
4185 (not (zerop (length address))))
4186 (format "%s using %s" address (car server))
4187 (format "%s" (car server)))))
4189 (defun gnus-same-method-different-name (method)
4190 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4191 (unless (assq slot (cddr method))
4192 (setq method
4193 (append method (list (list slot (nth 1 method)))))))
4194 (let ((methods gnus-extended-servers)
4195 open found)
4196 (while (and (not found)
4197 (setq open (pop methods)))
4198 (when (and (eq (car method) (car open))
4199 (gnus-sloppily-equal-method-parameters method open))
4200 (setq found open)))
4201 found))
4203 (defun gnus-find-method-for-group (group &optional info)
4204 "Find the select method that GROUP uses."
4205 (or gnus-override-method
4206 (and (not group)
4207 gnus-select-method)
4208 (and (not (gnus-group-entry group))
4209 ;; Killed or otherwise unknown group.
4210 (or
4211 ;; If we know a virtual server by that name, return its method.
4212 (gnus-server-to-method (gnus-group-server group))
4213 ;; Guess a new method as last resort.
4214 (gnus-group-name-to-method group)))
4215 (let ((info (or info (gnus-get-info group)))
4216 method)
4217 (if (or (not info)
4218 (not (setq method (gnus-info-method info)))
4219 (equal method "native"))
4220 gnus-select-method
4221 (setq method
4222 (cond ((stringp method)
4223 (inline (gnus-server-to-method method)))
4224 ((stringp (cadr method))
4225 (or
4226 (inline
4227 (gnus-same-method-different-name method))
4228 (inline (gnus-server-extend-method group method))))
4229 (t
4230 method)))
4231 (cond ((equal (cadr method) "")
4232 method)
4233 ((null (cadr method))
4234 (list (car method) ""))
4235 (t
4236 (gnus-server-add-address method)))))))
4238 (defun gnus-methods-using (feature)
4239 "Find all methods that have FEATURE."
4240 (let ((valids gnus-valid-select-methods)
4241 outs)
4242 (while valids
4243 (when (memq feature (car valids))
4244 (push (car valids) outs))
4245 (setq valids (cdr valids)))
4246 outs))
4248 (autoload 'message-y-or-n-p "message" nil nil 'macro)
4250 (defun gnus-read-group (prompt &optional default)
4251 "Prompt the user for a group name.
4252 Disallow invalid group names."
4253 (let ((prefix "")
4254 group)
4255 (while (not group)
4256 (when (string-match
4257 gnus-invalid-group-regexp
4258 (setq group (read-string (concat prefix prompt)
4259 (cons (or default "") 0)
4260 'gnus-group-history)))
4261 (let ((match (match-string 0 group)))
4262 ;; Might be okay (e.g. for nnimap), so ask the user:
4264 (message-y-or-n-p
4265 "Proceed and create group anyway? " t
4268 Usually, it's dangerous to create a group with this name, because it's not
4269 supported by all back ends and servers. On IMAP servers it should work,
4270 though. If you are really sure, you can proceed anyway and create the group.
4272 You may customize the variable `gnus-invalid-group-regexp', which currently is
4276 group nil)))))
4277 group))
4279 (defun gnus-read-method (prompt)
4280 "Prompt the user for a method.
4281 Allow completion over sensible values."
4282 (let* ((open-servers
4283 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4284 gnus-opened-servers))
4285 (valid-methods
4286 (let (methods)
4287 (dolist (method gnus-valid-select-methods)
4288 (if (or (memq 'prompt-address method)
4289 (not (assoc (format "%s:" (car method)) open-servers)))
4290 (push method methods)))
4291 methods))
4292 (servers
4293 (append valid-methods
4294 open-servers
4295 gnus-predefined-server-alist
4296 gnus-server-alist))
4297 (method
4298 (gnus-completing-read
4299 prompt (mapcar 'car servers)
4300 t nil 'gnus-method-history)))
4301 (cond
4302 ((equal method "")
4303 (setq method gnus-select-method))
4304 ((assoc method gnus-valid-select-methods)
4305 (let ((address (if (memq 'prompt-address
4306 (assoc method gnus-valid-select-methods))
4307 (read-string "Address: ")
4308 "")))
4309 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4310 (list (intern method) address))))
4311 ((assoc method servers)
4312 method)
4313 (t
4314 (list (intern method) "")))))
4316 ;;; Agent functions
4318 (defun gnus-agent-method-p (method-or-server)
4319 "Say whether METHOD is covered by the agent."
4320 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4321 (let* ((method (if (stringp method-or-server)
4322 (gnus-server-to-method method-or-server)
4323 method-or-server))
4324 (server (gnus-method-to-server method t)))
4325 (setq gnus-agent-method-p-cache
4326 (cons method-or-server
4327 (member server gnus-agent-covered-methods)))))
4328 (cdr gnus-agent-method-p-cache))
4330 (defun gnus-online (method)
4331 (not
4332 (if gnus-plugged
4333 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4334 (gnus-agent-method-p method))))
4336 ;;; User-level commands.
4338 ;;;###autoload
4339 (defun gnus-slave-no-server (&optional arg)
4340 "Read network news as a slave, without connecting to the local server."
4341 (interactive "P")
4342 (gnus-no-server arg t))
4344 ;;;###autoload
4345 (defun gnus-no-server (&optional arg slave)
4346 "Read network news.
4347 If ARG is a positive number, Gnus will use that as the startup
4348 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4349 non-nil and not a positive number, Gnus will prompt the user for the
4350 name of an NNTP server to use.
4351 As opposed to `gnus', this command will not connect to the local
4352 server."
4353 (interactive "P")
4354 (gnus-no-server-1 arg slave))
4356 ;;;###autoload
4357 (defun gnus-slave (&optional arg)
4358 "Read news as a slave."
4359 (interactive "P")
4360 (gnus arg nil 'slave))
4362 (defun gnus-delete-gnus-frame ()
4363 "Delete gnus frame unless it is the only one.
4364 Used for `gnus-exit-gnus-hook' in `gnus-other-frame'."
4365 (when (and (frame-live-p gnus-other-frame-object)
4366 (cdr (frame-list)))
4367 (delete-frame gnus-other-frame-object))
4368 (setq gnus-other-frame-object nil))
4370 ;;;###autoload
4371 (defun gnus-other-frame (&optional arg display)
4372 "Pop up a frame to read news.
4373 This will call one of the Gnus commands which is specified by the user
4374 option `gnus-other-frame-function' (default `gnus') with the argument
4375 ARG if Gnus is not running, otherwise pop up a Gnus frame and run the
4376 command specified by `gnus-other-frame-resume-function'.
4377 The optional second argument DISPLAY should be a standard display string
4379 omitted or the function `make-frame-on-display' is not available, the
4380 current display is used."
4381 (interactive "P")
4382 (if (fboundp 'make-frame-on-display)
4383 (unless display
4384 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4385 (setq display nil))
4386 (let ((alive (gnus-alive-p)))
4387 (unless (and alive
4388 (catch 'found
4389 (walk-windows
4390 (lambda (window)
4391 (when (and (or (not display)
4392 (equal display
4393 (gnus-frame-or-window-display-name
4394 window)))
4395 (with-current-buffer (window-buffer window)
4397 (symbol-name major-mode))))
4398 (gnus-select-frame-set-input-focus
4399 (setq gnus-other-frame-object (window-frame window)))
4400 (select-window window)
4401 (throw 'found t)))
4402 'ignore t)))
4403 (gnus-select-frame-set-input-focus
4404 (setq gnus-other-frame-object
4405 (if display
4406 (make-frame-on-display display gnus-other-frame-parameters)
4407 (make-frame gnus-other-frame-parameters))))
4408 (if alive
4409 (progn (switch-to-buffer gnus-group-buffer)
4410 (funcall gnus-other-frame-resume-function arg))
4411 (funcall gnus-other-frame-function arg)
4412 (add-hook 'gnus-exit-gnus-hook 'gnus-delete-gnus-frame)
4413 ;; One might argue that `gnus-delete-gnus-frame' should not be called
4414 ;; from `gnus-suspend-gnus-hook', but, on the other hand, one might
4415 ;; argue that it should. No matter what you think, for the sake of
4416 ;; those who want it to be called from it, please keep (defun
4417 ;; gnus-delete-gnus-frame) even if you remove the next `add-hook'.
4418 (add-hook 'gnus-suspend-gnus-hook 'gnus-delete-gnus-frame)))))
4420 ;;;###autoload
4421 (defun gnus (&optional arg dont-connect slave)
4422 "Read network news.
4423 If ARG is non-nil and a positive number, Gnus will use that as the
4424 startup level. If ARG is non-nil and not a positive number, Gnus will
4425 prompt the user for the name of an NNTP server to use."
4426 (interactive "P")
4427 ;; When using the development version of Gnus, load the gnus-load
4428 ;; file.
4429 (unless (string-match "^Gnus" gnus-version)
4430 (load "gnus-load" nil t))
4431 (unless (byte-code-function-p (symbol-function 'gnus))
4432 (message "You should byte-compile Gnus")
4433 (sit-for 2))
4434 (let ((gnus-action-message-log (list nil)))
4435 (gnus-1 arg dont-connect slave)
4436 (gnus-final-warning)))
4438 (declare-function debbugs-gnu "ext:debbugs-gnu"
4439 (severities &optional packages archivedp suppress tags))
4441 (defun gnus-list-debbugs ()
4442 "List all open Gnus bug reports."
4443 (interactive)
4444 (require 'debbugs-gnu)
4445 (debbugs-gnu nil "gnus"))
4447 ;; Allow redefinition of Gnus functions.
4449 (gnus-ems-redefine)
4451 (provide 'gnus)
4453 ;;; gnus.el ends here