| blob | 6362d9a951b1d17cabf6a53013123b32f9750cd5 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2015 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:
37 ;; These are defined afterwards with gnus-define-group-parameter
51 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
56 "Starting your favorite newsreader."
60 "Dealing with formatting issues."
64 "Group character set issues."
70 "Cache interface."
75 "Article Registry."
79 "Server options at startup."
82 ;; These belong to gnus-group.el.
84 "Group buffers."
89 "Foreign groups."
94 "Automatic subscription of new groups."
98 "Group levels."
103 "Selecting a Group."
108 "Showing slices of the group list."
113 "Sorting the group buffer."
119 "Various group options."
123 ;; These belong to gnus-sum.el.
125 "Summary buffers."
130 "Leaving summary buffers."
135 "Marks used in summary buffers."
140 "Ordering articles according to replies."
145 "Formatting of the summary buffer."
150 "Choosing Articles."
155 "Summary movement commands."
160 "Show pictures of people, domains, and newsgroups."
164 "Mail group commands."
169 "Sorting the summary buffer."
174 "Highlighting and menus in the summary buffer."
180 "Various summary buffer options."
185 "Pick mode in the summary buffer."
191 "Tree display of threads in the summary buffer."
196 ;; Belongs to gnus-uu.el
198 "Viewing extracted files."
202 ;; Belongs to gnus-score.el
204 "Score and kill file handling."
208 "Kill files."
212 "Adaptive score files."
216 "Default values for score files."
220 "Expiring score rules."
224 "Decaying score rules."
228 "Score and kill file names."
233 "Various scoring and killing options."
236 ;; Other
238 "Options controlling the visual fluff."
243 "Offline support for Gnus."
247 "Files used by Gnus."
251 "Auto save file."
256 "Storing Gnus state."
260 "Options related to newsservers and other servers used by Gnus."
264 "Highlighting and menus in the server buffer."
269 "Composing replies and followups in Gnus."
273 "Meta variables controlling major portions of Gnus.
274 In general, modifying these variables does not take effect until Gnus
275 is restarted, and sometimes reloaded."
279 "Other Gnus options."
284 "Exiting Gnus."
289 "Frivolous Gnus extensions."
300 "If non-nil, the startup message will not be displayed.
301 This variable is used before `.gnus.el' is loaded, so it should
302 be set in `.emacs' instead."
323 0 5
332 gnus-mode-line-image-cache)
334 "This is %s, %s."
336 str)
338 line)))
343 ;;(defalias 'gnus-decode-rfc1522 'ignore)
344 )
346 ;; We define these group faces here to avoid the display
347 ;; update forced when creating new faces.
357 ()))
358 "Level 1 newsgroup face."
360 ;; backward-compatibility alias
372 ()))
373 "Level 1 empty newsgroup face."
375 ;; backward-compatibility alias
387 ()))
388 "Level 2 newsgroup face."
390 ;; backward-compatibility alias
402 ()))
403 "Level 2 empty newsgroup face."
405 ;; backward-compatibility alias
417 ()))
418 "Level 3 newsgroup face."
420 ;; backward-compatibility alias
427 ())
430 ())
432 ()))
433 "Level 3 empty newsgroup face."
435 ;; backward-compatibility alias
447 ()))
448 "Level 4 newsgroup face."
450 ;; backward-compatibility alias
457 ())
460 ())
462 ()))
463 "Level 4 empty newsgroup face."
465 ;; backward-compatibility alias
477 ()))
478 "Level 5 newsgroup face."
480 ;; backward-compatibility alias
487 ())
490 ())
492 ()))
493 "Level 5 empty newsgroup face."
495 ;; backward-compatibility alias
507 ()))
508 "Level 6 newsgroup face."
510 ;; backward-compatibility alias
517 ())
520 ())
522 ()))
523 "Level 6 empty newsgroup face."
525 ;; backward-compatibility alias
537 ()))
538 "Low level newsgroup face."
540 ;; backward-compatibility alias
552 ()))
553 "Low level empty newsgroup face."
555 ;; backward-compatibility alias
568 "Level 1 mailgroup face."
570 ;; backward-compatibility alias
583 "Level 1 empty mailgroup face."
585 ;; backward-compatibility alias
598 "Level 2 mailgroup face."
600 ;; backward-compatibility alias
613 "Level 2 empty mailgroup face."
615 ;; backward-compatibility alias
628 "Level 3 mailgroup face."
630 ;; backward-compatibility alias
642 ()))
643 "Level 3 empty mailgroup face."
645 ;; backward-compatibility alias
658 "Low level mailgroup face."
660 ;; backward-compatibility alias
673 "Low level empty mailgroup face."
675 ;; backward-compatibility alias
679 ;; Summary mode faces.
682 "Face used for selected articles."
684 ;; backward-compatibility alias
691 "Face used for canceled articles."
693 ;; backward-compatibility alias
706 "Face used for high interest ticked articles."
708 ;; backward-compatibility alias
721 "Face used for low interest ticked articles."
723 ;; backward-compatibility alias
735 ()))
736 "Face used for normal interest ticked articles."
738 ;; backward-compatibility alias
751 "Face used for high interest ancient articles."
753 ;; backward-compatibility alias
766 "Face used for low interest ancient articles."
768 ;; backward-compatibility alias
780 ()))
781 "Face used for normal interest ancient articles."
783 ;; backward-compatibility alias
794 "Face used for high interest uncached articles."
796 ;; backward-compatibility alias
807 "Face used for low interest uncached articles."
809 ;; backward-compatibility alias
820 "Face used for normal interest uncached articles."
822 ;; backward-compatibility alias
829 "Face used for high interest unread articles."
831 ;; backward-compatibility alias
838 "Face used for low interest unread articles."
840 ;; backward-compatibility alias
846 ()))
847 "Face used for normal interest unread articles."
849 ;; backward-compatibility alias
864 "Face used for high interest read articles."
866 ;; backward-compatibility alias
881 "Face used for low interest read articles."
883 ;; backward-compatibility alias
895 ()))
896 "Face used for normal interest read articles."
898 ;; backward-compatibility alias
903 ;;;
904 ;;; Gnus buffers
905 ;;;
911 "Do the same as `get-buffer-create', but store the created buffer."
916 "Add the current buffer to the list of Gnus buffers."
920 "Kill BUFFER and remove from the list of Gnus buffers."
927 "Return a list of live Gnus buffers."
936 gnus-buffers)
938 ;;; Splash screen.
951 ()))
952 "Face for the splash screen."
954 ;; backward-compatibility alias
968 "Indent rigidly using only spaces and no tabs."
974 ;; We translate tabs into spaces -- not everybody uses
975 ;; an 8-character tab.
980 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1005 "*Color styles used for the Gnus logo."
1007 gnus-logo-color-alist))
1017 "Insert startup message in current buffer."
1018 ;; Insert the message.
1023 ;; Make sure the library defining `image-load-path' is
1024 ;; loaded (`find-image' is autoloaded) (and discard the
1025 ;; result). Else, we may get "defvar ignored because
1026 ;; image-load-path is let-bound" when calling `find-image'
1027 ;; below.
1037 :color-symbols
1041 :color-symbols
1046 ;; Account for the pbm's background.
1050 ;; Account for the xbm's background.
1061 t)))
1064 _ ___ _ _
1065 _ ___ __ ___ __ _ ___
1066 __ _ ___ __ ___
1067 _ ___ _
1068 _ _ __ _
1069 ___ __ _
1070 __ _
1071 _ _ _
1072 _ _ _
1073 _ _ _
1074 __ ___
1075 _ _ _ _
1076 _ _
1077 _ _
1078 _ _
1079 _
1080 __
1083 ;; And then hack it.
1092 ;; Fontify some.
1099 "Do color-symbol search-and-replace in svg file."
1110 color-symbols)
1112 list)))
1121 ;;; Do the rest.
1127 "Alist of group parameters.
1129 For example:
1131 (gnus-use-scoring nil)
1132 (gnus-summary-line-format
1134 (gcc-self . t)
1135 (display . all))
1138 (broken-reply-to . t)))"
1145 "If it is t, ignore case of group names specified in `gnus-parameters'.
1146 If it is nil, don't ignore case. If it is `default', which is for the
1147 backward compatibility, use the value of `case-fold-search'."
1158 "Define a group parameter PARAM.
1159 REST is a plist of following:
1160 :type One of `bool', `list' or nil.
1161 :function The name of the function.
1162 :function-document The documentation of the function.
1163 :parameter-type The type for customizing the parameter.
1164 :parameter-document The documentation for the parameter.
1165 :variable The name of the variable.
1166 :variable-document The documentation for the variable.
1167 :variable-group The group for customizing the variable.
1168 :variable-type The type for customizing the variable.
1169 :variable-default The default value of the variable."
1186 'progn
1188 ,variable-document
1194 gnus-group-parameters-more))
1197 ,parameter-type
1201 ,function-document
1203 val)
1206 t)
1211 (,variable
1213 elem value)
1221 ,function-document
1225 elem value)
1232 'value
1237 All other Gnus file and directory variables are initialized from this variable.
1239 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1240 This means that other directory variables that are initialized
1241 from this variable won't be set properly if you set this variable
1242 in `.gnus.el'. Set this variable in `.emacs' instead."
1248 "*Directory variable from which all other Gnus file variables are derived.
1250 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1251 This means that other directory variables that are initialized from
1252 this variable won't be set properly if you set this variable in `.gnus.el'.
1253 Set this variable in `.emacs' instead."
1258 "*Default directory for all Gnus buffers."
1261 directory))
1263 ;; Site dependent variables.
1265 ;; Should this be obsolete?
1267 "The hostname of the default NNTP server.
1268 The empty string, or nil, means to use the local host.
1269 You may wish to set this on a site-wide basis.
1271 If you want to change servers, you should use `gnus-select-method'."
1277 "A file with only the name of the nntp server in it."
1283 "Find default nntp server.
1284 Check the NNTPSERVER environment variable and the
1285 `gnus-nntpserver-file' file."
1293 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1294 ;; starting or even loading Gnus.
1295 ;;;###autoload(when (fboundp 'custom-autoload)
1296 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1302 gnus-default-nntp-server)
1304 "Default method for selecting a newsgroup.
1305 This variable should be a list, where the first element is how the
1306 news is to be fetched, the second is the address.
1309 NNTP, you could say:
1313 If you want to use your local spool, say:
1317 If you use this variable, you must set `gnus-nntp-server' to nil.
1319 There is a lot more to know about select methods and virtual servers -
1320 see the manual for details."
1321 ;; Emacs has set-after since 22.1.
1322 ;set-after '(gnus-default-nntp-server)
1329 "*Method used for archiving messages you've sent.
1330 This should be a mail method.
1332 See also `gnus-update-message-archive-method'."
1336 gnus-select-method))
1341 The archive method is initially set according to the value of
1343 so that it may be used as a real method of the server which is named
1345 updated if the value of this variable is nil, even if you change the
1346 value of `gnus-message-archive-method' afterward. If you want the
1348 `gnus-message-archive-method', set this variable to a non-nil value."
1355 "*Name of the group in which to save the messages you've written.
1356 This can either be a string; a list of strings; or an alist
1357 of regexps/functions/forms to be evaluated to return a string (or a list
1358 of strings). The functions are called with the name of the current
1359 group (or nil) as a parameter.
1361 If you want to save your mail in one group and the news articles you
1362 write in another group, you could say something like:
1364 \(setq gnus-message-archive-group
1365 '((if (message-news-p)
1369 Normally the group names returned by this variable should be
1371 However, you may wish to store the message on some other server. In
1372 that case, just return a fully prefixed name of the group --
1380 function
1381 sexp
1382 string))
1385 "List of NNTP servers that the user can choose between interactively.
1386 To make Gnus query you for a server, you have to give `gnus' a
1387 non-numeric prefix - `C-u M-x gnus', in short."
1393 "A list of secondary methods that will be used for reading news.
1394 This is a list where each element is a complete select method (see
1395 `gnus-select-method').
1397 If, for instance, you want to read your mail with the nnml back end,
1398 you could set this variable:
1405 "Local domain name without a host name.
1406 The DOMAINNAME environment variable is used instead if it is defined.
1407 If the function `system-name' returns the full Internet name, there is
1408 no need to set this variable."
1411 string))
1414 ;; Customization variables
1417 "Preferred method for fetching an article by Message-ID.
1418 The value of this variable must be a valid select method as discussed
1419 in the documentation of `gnus-select-method'.
1421 It can also be a list of select methods, as well as the special symbol
1422 `current', which means to use the current select method. If it is a
1423 list, Gnus will try all the methods in the list until it finds a match."
1429 gnus-select-method
1430 sexp
1438 gnus-select-method))))
1441 "*Non-nil means that cross referenced articles will be marked as read.
1442 If nil, ignore cross references. If t, mark articles as read in
1443 subscribed newsgroups. If neither t nor nil, mark as read in all
1444 newsgroups."
1452 "*Process mark."
1458 "*The number of articles which indicates a large newsgroup.
1459 If the number of articles in a newsgroup is greater than this value,
1460 confirmation is required for selecting the newsgroup.
1461 If it is nil, no confirmation is required.
1463 Also see `gnus-large-ephemeral-newsgroup'."
1466 integer))
1469 "Non-nil means that the default name of a file to save articles in is the group name.
1470 If it's nil, the directory form of the group name is used instead.
1472 If this variable is a list, and the list contains the element
1473 `not-score', long file names will not be used for score files; if it
1474 contains the element `not-save', long file names will not be used for
1475 saving; and if it contains the element `not-kill', long file names
1476 will not be used for kill files.
1478 Note that the default for this variable varies according to what system
1479 type you're using. On `usg-unix-v' this variable defaults to nil while
1480 on all other systems it defaults to t."
1498 "*If non-nil, save group scoring info."
1504 "*If non-nil, allow undoing in Gnus group mode buffers."
1509 "*If non-nil, use some adaptive scoring scheme.
1510 If a list, then the values `word' and `line' are meaningful. The
1511 former will perform adaption on individual words in the subject
1512 header while `line' will perform adaption on several headers."
1518 "*If nil, Gnus will ignore the article cache.
1519 If `passive', it will allow entering (and reading) articles
1520 explicitly entered into the cache. If anything else, use the
1521 cache to the full extent of the law."
1529 "*If non-nil, display a thread tree buffer."
1534 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1535 If it is a number N, then Gnus will only keep the last N articles
1536 read. If it is neither nil nor a number, Gnus will keep all read
1537 articles. This is not a good idea."
1540 integer
1545 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1550 "*If non-nil, enable scoring."
1556 "*A hook called when preparing to exit from the summary buffer.
1557 It calls `gnus-summary-expire-articles' by default."
1562 "*Non-nil means that you are a Usenet novice.
1563 If non-nil, verbose messages may be displayed and confirmations may be
1564 required."
1569 "*Non-nil means that you will never be asked for confirmation about anything.
1570 That doesn't mean *anything* anything; particularly destructive
1571 commands will still require prompting."
1576 "*If non-nil, require your confirmation when catching up a group."
1581 "*If non-nil, require your confirmation when exiting Gnus.
1582 If `quiet', update any active summary buffers automatically
1583 first before exiting."
1589 "*Function for extracting address components from a From header.
1590 Two pre-defined function exist: `gnus-extract-address-components',
1591 which is the default, quite fast, and too simplistic solution, and
1592 `mail-extract-address-components', which works much better, but is
1593 slower."
1600 "String used to separate shell commands."
1622 server-marks cloud)
1625 "*An alist of valid select methods.
1626 The first element of each list lists should be a string with the name
1627 of the select method. The other elements may be the category of
1628 this method (i. e., `post', `mail', `none' or whatever) or other
1629 properties that this method has (like being respoolable).
1630 If you implement a new select method, all you should have to change is
1631 this variable. I think."
1649 "Recomputes the select-method widget based on the value of
1650 `gnus-valid-select-methods'."
1652 "Widget for entering a select method."
1659 gnus-valid-select-methods)
1663 :inline t
1665 variable
1671 "List of buffers that should update their mode lines.
1672 The list may contain the symbols `group', `article', `tree' and
1673 `summary'. If the corresponding symbol is present, Gnus will keep
1674 that mode line updated with information that may be pertinent.
1675 If this variable is nil, screen refresh may be quicker."
1683 "*Max length of mode-line non-string contents.
1684 If this is nil, Gnus will take space as is needed, leaving the rest
1685 of the mode line intact."
1689 integer))
1691 ;; There should be special validation for this.
1696 to-address
1697 :function-document
1698 "Return GROUP's to-address."
1699 :variable-document
1700 "*Alist of group regexps and correspondent to-addresses."
1701 :variable-group gnus-group-parameter
1704 This will be used when doing followups and posts.
1706 This is primarily useful in mail groups that represent closed
1707 mailing lists--mailing lists where it's expected that everybody that
1708 writes to the mailing list is subscribed to it. Since using this
1709 parameter ensures that the mail only goes to the mailing list itself,
1710 it means that members won't receive two copies of your followups.
1712 Using `to-address' will actually work whether the group is foreign or
1713 not. Let's say there's a group on the server that is called
1714 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1715 articles from a mail-to-news gateway. Posting directly to this group
1716 is therefore impossible--you have to send mail to the mailing list
1717 address instead.
1719 The gnus-group-split mail splitting mechanism will behave as if this
1723 to-list
1724 :function-document
1725 "Return GROUP's to-list."
1726 :variable-document
1727 "*Alist of group regexps and correspondent to-lists."
1728 :variable-group gnus-group-parameter
1731 This address will be used when doing a `a' in the group.
1733 It is totally ignored when doing a followup--except that if it is
1734 present in a news group, you'll get mail group semantics when doing
1735 `f'.
1737 The gnus-group-split mail splitting mechanism will behave as if this
1741 subscribed
1742 :type bool
1743 :function-document
1744 "Return GROUP's subscription status."
1745 :variable-document
1746 "*Groups which are automatically considered subscribed."
1747 :variable-group gnus-group-parameter
1750 Gnus assumed that you are subscribed to the To/List address.
1752 When constructing a list of subscribed groups using
1753 `gnus-find-subscribed-addresses', Gnus includes the To address given
1757 auto-expire
1758 :type bool
1759 :function gnus-group-auto-expirable-p
1760 :function-document
1761 "Check whether GROUP is auto-expirable or not."
1762 :variable gnus-auto-expirable-newsgroups
1763 :variable-default nil
1764 :variable-document
1765 "*Groups in which to automatically mark read articles as expirable.
1766 If non-nil, this should be a regexp that should match all groups in
1767 which to perform auto-expiry. This only makes sense for mail groups."
1768 :variable-group nnmail-expire
1770 regexp)
1772 :parameter-document
1776 total-expire
1777 :type bool
1778 :function gnus-group-total-expirable-p
1779 :function-document
1780 "Check whether GROUP is total-expirable or not."
1781 :variable gnus-total-expirable-newsgroups
1782 :variable-default nil
1783 :variable-document
1784 "*Groups in which to perform expiry of all read articles.
1785 Use with extreme caution. All groups that match this regexp will be
1786 expiring - which means that all read articles will be deleted after
1787 \(say) one week. (This only goes for mail groups and the like, of
1788 course.)"
1789 :variable-group nnmail-expire
1791 regexp)
1793 :parameter-document
1794 "All read articles will be put through the expiry process
1796 This happens even if they are not marked as expirable.
1800 charset
1801 :function-document
1802 "Return the default charset of GROUP."
1803 :variable gnus-group-charset-alist
1804 :variable-default
1817 :variable-document
1818 "Alist of regexps (to match group names) and default charsets to be used when reading."
1819 :variable-group gnus-charset
1827 post-method
1828 :type list
1829 :function-document
1830 "Return a posting method for GROUP."
1831 :variable gnus-post-method-alist
1832 :variable-document
1833 "Alist of regexps (to match group names) and method to be used when
1834 posting an article."
1835 :variable-group gnus-group-foreign
1836 :parameter-type
1844 :parameter-document
1848 large-newsgroup-initial
1849 :type integer
1850 :function-document
1851 "Return GROUP's initial input of the number of articles."
1852 :variable-document
1853 "*Alist of group regexps and its initial input of the number of articles."
1854 :variable-group gnus-group-parameter
1860 This number will be prompted as the initial value of the number of
1861 articles to list when the group is a large newsgroup (see
1862 `gnus-large-newsgroup'). If it is nil, the default value is the
1865 ;; The Gnus registry's ignored groups
1867 registry-ignore
1868 :type list
1869 :function-document
1870 "Whether this group should be ignored by the registry."
1871 :variable gnus-registry-ignored-groups
1876 :variable-document
1877 "*Groups in which the registry should be turned off."
1878 :variable-group gnus-registry
1885 :parameter-document
1888 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1890 "*Disable the group parameters for spam detection.
1891 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1898 "Spam group classification (requires spam.el).
1899 This group contains spam messages. On summary entry, unread messages
1900 will be marked as spam. On summary exit, the specified spam
1901 processors will be invoked on spam-marked messages, then those
1902 messages will be expired, so the spam processor will only see a
1906 "The ham value for the spam group parameter (requires spam.el).
1907 On summary exit, the specified ham processors will be invoked on
1908 ham-marked messages. Exercise caution, since the ham processor will
1909 see the same message more than once because there is no ham message
1913 spam-contents
1914 :type list
1915 :function-document
1916 "The spam type (spam, ham, or neither) of the group."
1917 :variable gnus-spam-newsgroup-contents
1918 :variable-default nil
1919 :variable-document
1920 "*Group classification (spam, ham, or neither). Only
1921 meaningful when spam.el is loaded. If non-nil, this should be a
1922 list of group name regexps associated with a classification for
1923 each one. In spam groups, new articles are marked as spam on
1924 summary entry. There is other behavior associated with ham and
1925 no classification when spam.el is loaded - see the manual."
1926 :variable-group spam
1940 :parameter-document
1941 "The spam classification (spam, ham, or neither) of this group.
1942 When a spam group is entered, all unread articles are marked as
1943 spam. There is other behavior associated with ham and no
1947 spam-resend-to
1948 :type list
1949 :function-document
1950 "The address to get spam resent (through spam-report-resend)."
1951 :variable gnus-spam-resend-to
1952 :variable-default nil
1953 :variable-document
1954 "The address to get spam resent (through spam-report-resend)."
1955 :variable-group spam
1959 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1960 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1961 :parameter-document
1965 ham-resend-to
1966 :type list
1967 :function-document
1968 "The address to get ham resent (through spam-report-resend)."
1969 :variable gnus-ham-resend-to
1970 :variable-default nil
1971 :variable-document
1972 "The address to get ham resent (through spam-report-resend)."
1973 :variable-group spam
1977 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1978 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1979 :parameter-document
1995 "OBSOLETE: The Gmane reporting summary exit spam processor.
2002 "OBSOLETE: The ifile summary exit ham processor.
2006 "OBSOLETE: The Bogofilter summary exit ham processor.
2010 "OBSOLETE: The spam-stat summary exit ham processor.
2014 "OBSOLETE: The whitelist summary exit ham processor.
2018 "OBSOLETE: The BBDB summary exit ham processor.
2022 "OBSOLETE: The ham copy exit ham processor.
2026 "OBSOLETE: The spamoracle summary exit ham processor.
2030 spam-process
2031 :type list
2032 :parameter-type
2035 :value nil
2072 :function-document
2073 "Which spam or ham processors will be applied when the summary is exited."
2074 :variable gnus-spam-process-newsgroups
2075 :variable-default nil
2076 :variable-document
2077 "*Groups in which to automatically process spam or ham articles with
2078 a backend on summary exit. If non-nil, this should be a list of group
2079 name regexps that should match all groups in which to do automatic
2080 spam processing, associated with the appropriate processor."
2081 :variable-group spam
2082 :variable-type
2123 :parameter-document
2127 spam-autodetect
2128 :type list
2129 :parameter-type
2131 :function-document
2132 "Should spam be autodetected (with spam-split) in this group?"
2133 :variable gnus-spam-autodetect
2134 :variable-default nil
2135 :variable-document
2136 "*Groups in which spam should be autodetected when they are entered.
2137 Only unseen articles will be examined, unless
2138 spam-autodetect-recheck-messages is set."
2139 :variable-group spam
2140 :variable-type
2145 boolean))
2146 :parameter-document
2147 "Spam autodetection.
2148 Only unseen articles will be examined, unless
2152 spam-autodetect-methods
2153 :type list
2154 :parameter-type
2177 :function-document
2178 "Methods to be used for autodetection in each group"
2179 :variable gnus-spam-autodetect-methods
2180 :variable-default nil
2181 :variable-document
2182 "*Methods for autodetecting spam per group.
2183 Requires the spam-autodetect parameter. Only unseen articles
2184 will be examined, unless spam-autodetect-recheck-messages is
2185 set."
2186 :variable-group spam
2187 :variable-type
2214 :parameter-document
2215 "Spam autodetection methods.
2216 Requires the spam-autodetect parameter. Only unseen articles
2217 will be examined, unless spam-autodetect-recheck-messages is
2221 spam-process-destination
2222 :type list
2223 :parameter-type
2229 :function-document
2230 "Where spam-processed articles will go at summary exit."
2231 :variable gnus-spam-process-destinations
2232 :variable-default nil
2233 :variable-document
2234 "*Groups in which to explicitly send spam-processed articles to
2235 another group, or expire them (the default). If non-nil, this should
2236 be a list of group name regexps that should match all groups in which
2237 to do spam-processed article moving, associated with the destination
2238 group or nil for explicit expiration. This only makes sense for
2239 mail groups."
2240 :variable-group spam
2241 :variable-type
2252 :parameter-document
2256 ham-process-destination
2257 :type list
2258 :parameter-type
2266 :function-document
2267 "Where ham articles will go at summary exit from a spam group."
2268 :variable gnus-ham-process-destinations
2269 :variable-default nil
2270 :variable-document
2271 "*Groups in which to explicitly send ham articles to
2272 another group, or do nothing (the default). If non-nil, this should
2273 be a list of group name regexps that should match all groups in which
2274 to do ham article moving, associated with the destination
2275 group or nil for explicit ignoring. This only makes sense for
2276 mail groups, and only works in spam groups."
2277 :variable-group spam
2278 :variable-type
2290 :parameter-document
2294 ham-marks
2305 :parameter-document
2306 "Marks considered ham (positively not spam). Such articles will be
2307 processed as ham (non-spam) on group exit. When nil, the global
2308 spam-ham-marks variable takes precedence."
2310 gnus-read-mark
2311 gnus-killed-mark
2312 gnus-kill-file-mark
2313 gnus-low-score-mark))))
2314 :variable-group spam
2315 :variable-document
2319 spam-marks
2328 :parameter-document
2329 "Marks considered spam.
2330 Such articles will be processed as spam on group exit. When nil, the global
2331 spam-spam-marks variable takes precedence."
2333 :variable-group spam
2334 :variable-document
2338 "Number of group name elements to leave alone when making a short group name."
2343 "*If non-nil, once you set a level, Gnus will use this level."
2347 ;; Hooks.
2350 "A hook run while Gnus is loaded."
2355 "A hook called to apply kill files to a group.
2356 This hook is intended to apply a kill file to the selected newsgroup.
2357 The function `gnus-apply-kill-file' is called by default.
2359 Since a general kill file is too heavy to use only for a few
2360 newsgroups, I recommend you to use a lighter hook function. For
2361 example, if you'd like to apply a kill file to articles which contains
2362 a string `rmgroup' in subject in newsgroup `control', you can use the
2363 following hook:
2365 (setq gnus-apply-kill-hook
2366 (list
2367 (lambda ()
2376 "Function run when a group level is changed.
2377 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2380 function))
2382 ;;; Face thingies.
2386 mouse-face
2387 summary-menu group-menu article-menu
2388 tree-highlight menu highlight
2389 browse-menu server-menu
2390 page-marker tree-menu binary-menu pick-menu)
2391 "*Enable visual features.
2392 If `visual' is disabled, there will be no menus and few faces. Most of
2393 the visual customization options below will be ignored. Gnus will use
2394 less space and be faster as a result.
2396 This variable can also be a list of visual elements to switch on. For
2397 instance, to switch off all visual things except menus, you can say:
2399 (setq gnus-visual '(menu))
2401 Valid elements include `summary-highlight', `group-highlight',
2402 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2403 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2404 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2424 ;; Byte-compiler warning.
2426 ;; Find out whether the gnus-visual TYPE is wanted.
2430 gnus-visual
2434 t))))
2444 "*Face used for group or summary buffer mouse highlighting.
2445 The line beneath the mouse pointer will be highlighted with this
2446 face."
2459 "Controls use of the agent cache while plugged.
2460 When set, Gnus will prefer using the locally stored content rather
2461 than re-fetching it from the server. You also need to enable
2462 `gnus-agent' for this to have any affect."
2468 "Default charset assumed to be used when viewing non-ASCII characters.
2469 This variable is overridden on a group-to-group basis by the
2470 `gnus-group-charset-alist' variable and is only used on groups not
2471 covered by that variable."
2475 ;; Fixme: Doc reference to agent.
2477 "Whether we want to use the Gnus agent or not.
2479 You may customize gnus-agent to disable its use. However, some
2480 back ends have started to use the agent as a client-side cache.
2481 Disabling the agent may result in noticeable loss of performance."
2487 "Function called by the command `gnus-other-frame' when starting Gnus."
2495 "Function called by the command `gnus-other-frame' when resuming Gnus."
2505 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2506 This should be an alist for Emacs, or a plist for XEmacs."
2517 "Which information should be exposed in the User-Agent header.
2519 Can be a list of symbols or a string. Valid symbols are `gnus'
2520 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2521 addition to the Emacs version, you can add `codename' \(show
2522 \(S\)XEmacs codename\) or either `config' \(show system
2523 configuration\) or `type' \(show system type\). If you set it to
2524 a string, be sure to use a valid format, see RFC 2616."
2537 ;; Convert old (< 2005-01-10) symbol type values:
2556 \f
2557 ;;; Internal variables
2562 ; Reset each time gnus-agent-covered-methods is changed else
2563 ; gnus-agent-method-p may mis-report a methods status.
2564 )
2574 ;; The carpal mode has been removed, but define the variable for
2575 ;; backwards compatibility.
2594 ;; Variable holding the user answers to all method prompts.
2597 ;; Variable holding the user answers to all mail method prompts.
2600 ;; Variable holding the user answers to all group prompts.
2608 "*The directory where cached articles will be stored."
2614 nnspool "cache"
2639 ;; Propagate flags to server, with the following exceptions:
2640 ;; `seen' is private to each gnus installation
2641 ;; `cache' is a internal gnus flag for each gnus installation
2642 ;; `download' is a agent flag private to each gnus installation
2643 ;; `unsend' are for nndraft groups only
2644 ;; `score' is not a proper mark
2645 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2648 "Marks that shouldn't be propagated to back ends.
2649 Typical marks are those that make no sense in a standalone back end,
2650 such as a mark that says whether an article is stored in the cache
2663 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
2667 "gnus"
2691 gnus-newsrc-last-checked-date
2692 gnus-newsrc-alist gnus-server-alist
2693 gnus-killed-list gnus-zombie-list
2694 gnus-topic-topology gnus-topic-alist
2695 gnus-cloud-sequence
2696 gnus-cloud-covered-servers
2697 gnus-cloud-file-timestamps)
2701 "Assoc list of read articles.
2705 "Assoc list of registry data.
2732 ;; Save window configuration.
2745 ;;; End of variables.
2747 ;; Define some autoload functions Gnus might use.
2750 ;; This little mapcar goes through the list below and marks the
2751 ;; symbols in question as autoloaded functions.
2771 message-send-and-exit message-yank-original)
2775 ;; This is only used in message.el, which has an autoload.
2777 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2779 ;; Next two only used in gnus-util.
2780 rmail-summary-exists rmail-select-summary)
2781 ;; Only used in gnus-util, which has an autoload.
2786 gnus-Folder-save-name gnus-folder-save-name)
2789 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2790 gnus-demon-add-disconnection gnus-demon-add-handler
2791 gnus-demon-remove-handler)
2793 gnus-demon-init gnus-demon-cancel)
2795 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2796 gnus-face-from-file)
2798 gnus-tree-open gnus-tree-close)
2800 gnus-server-server-name)
2803 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2804 gnus-article-hide-citation gnus-article-fill-cited-article
2805 gnus-article-hide-citation-in-followups
2806 gnus-article-fill-cited-long-lines)
2808 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2809 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2811 gnus-registry-handle-action)
2813 gnus-cache-possibly-remove-articles gnus-cache-request-article
2814 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2815 gnus-cache-enter-remove-article gnus-cached-article-p
2816 gnus-cache-open gnus-cache-close gnus-cache-update-article
2817 gnus-cache-articles-in-group)
2819 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2821 gnus-summary-increase-score gnus-summary-set-score
2822 gnus-summary-raise-thread gnus-summary-raise-same-subject
2823 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2824 gnus-summary-lower-thread gnus-summary-lower-same-subject
2825 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2826 gnus-summary-current-score gnus-score-delta-default
2827 gnus-score-flush-cache gnus-score-close
2828 gnus-possibly-score-headers gnus-score-followup-article
2829 gnus-score-followup-thread)
2832 gnus-current-score-file-nondirectory gnus-score-adaptive
2833 gnus-score-find-trace gnus-score-file-name)
2837 gnus-subscribe-topics)
2841 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2842 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2843 gnus-uu-mark-by-regexp gnus-uu-mark-all
2844 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2845 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2846 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2847 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2848 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2849 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2850 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2851 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2854 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2856 gnus-group-post-news gnus-group-mail gnus-group-news
2857 gnus-summary-post-news gnus-summary-news-other-window
2858 gnus-summary-followup gnus-summary-followup-with-original
2859 gnus-summary-cancel-article gnus-summary-supersede-article
2860 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2861 gnus-summary-mail-forward gnus-summary-mail-other-window
2862 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2863 gnus-summary-wide-reply gnus-summary-followup-to-mail
2864 gnus-summary-followup-to-mail-with-original gnus-bug
2865 gnus-summary-wide-reply-with-original
2866 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2867 gnus-summary-post-forward)
2872 gnus-list-of-unread-articles gnus-list-of-read-articles
2873 gnus-offer-save-summaries gnus-make-thread-indent-array
2874 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2875 gnus-summary-skip-intangible gnus-summary-article-number
2876 gnus-data-header gnus-data-find)
2878 gnus-group-list-groups gnus-group-first-unread-group
2879 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2880 gnus-group-setup-buffer gnus-group-get-new-news
2881 gnus-group-make-help-group gnus-group-update-group
2882 gnus-group-iterate gnus-group-group-name)
2884 gnus-backlog-remove-article)
2886 gnus-article-prepare gnus-article-set-window-start
2887 gnus-article-next-page gnus-article-prev-page
2888 gnus-request-article-this-buffer gnus-article-mode
2889 gnus-article-setup-buffer gnus-narrow-to-page
2890 gnus-article-delete-invisible-text gnus-treat-article)
2892 gnus-article-hide-headers gnus-article-hide-boring-headers
2893 gnus-article-treat-overstrike
2894 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2895 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2896 gnus-article-de-base64-unreadable
2897 gnus-article-decode-HZ
2898 gnus-article-wash-html
2899 gnus-article-unsplit-urls
2900 gnus-article-hide-pem gnus-article-hide-signature
2901 gnus-article-strip-leading-blank-lines gnus-article-date-local
2902 gnus-article-date-original gnus-article-date-lapsed
2903 ;;gnus-article-show-all-headers
2904 gnus-article-edit-mode gnus-article-edit-article
2905 gnus-article-edit-done gnus-article-decode-encoded-words
2906 gnus-start-date-timer gnus-stop-date-timer
2907 gnus-mime-view-all-parts)
2910 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2911 gnus-check-reasonable-setup)
2913 gnus-dup-enter-articles)
2919 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2920 gnus-async-halt-prefetch)
2922 gnus-agent-save-active gnus-agent-method-p
2923 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2924 gnus-summary-set-agent-mark gnus-agent-save-group-info
2925 gnus-agent-request-article gnus-agent-retrieve-headers
2926 gnus-agent-store-article gnus-agent-group-covered-p)
2928 gnus-unplugged gnus-agentize gnus-agent-batch)
2930 gnus-summary-save-article-vm)
2935 gnus-group-split-update)
2938 ;;; gnus-sum.el thingies
2942 "*The format specification of the lines in the summary buffer.
2944 It works along the same lines as a normal formatting string,
2945 with some simple extensions.
2947 %N Article number, left padded with spaces (string)
2948 %S Subject (string)
2950 otherwise (string)
2951 %n Name of the poster (string)
2952 %a Extracted name of the poster (string)
2953 %A Extracted address of the poster (string)
2954 %F Contents of the From: header (string)
2955 %f Contents of the From: or To: headers (string)
2956 %x Contents of the Xref: header (string)
2957 %D Date of the article (string)
2958 %d Date of the article (string) in DD-MMM format
2959 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2960 format
2961 %M Message-id of the article (string)
2962 %r References of the article (string)
2963 %c Number of characters in the article (integer)
2964 %k Pretty-printed version of the above (string)
2966 %L Number of lines in the article (integer)
2967 %I Indentation based on thread level (a string of
2968 spaces)
2969 %B A complex trn-style thread tree (string)
2970 The variables `gnus-sum-thread-*' can be used for
2971 customization.
2972 %T A string with two possible values: 80 spaces if the
2973 article is on thread level two or larger and 0 spaces
2974 on level one
2976 otherwise (character)
2978 See Info node `(gnus)Marking Articles'
2981 %> Spaces of length thread-level (string)
2982 %< Spaces of length (- 20 thread-level) (string)
2983 %i Article score (number)
2984 %z Article zcore (character)
2985 %t Number of articles under the current thread (number).
2986 %e Whether the thread is empty or not (character).
2987 %V Total thread score (number).
2988 %P The line number (number).
2989 %O Download mark (character).
2990 %* If present, indicates desired cursor position
2991 (instead of after first colon).
2992 %u User defined specifier. The next character in the
2993 format string should be a letter. Gnus will call the
2994 function gnus-user-format-function-X, where X is the
2995 letter following %u. The function will be passed the
2996 current header as argument. The function should
2997 return a string, which will be inserted into the
2998 summary just like information from any other summary
2999 specifier.
3000 &user-date; Age sensitive date format. Various date format is
3001 defined in `gnus-user-date-format-alist'.
3004 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3005 with care. For reasons of efficiency, Gnus will compute what column
3007 it is invalid to have these specs after a variable-length spec. Well,
3008 you might not be arrested, but your summary buffer will look strange,
3009 which is bad enough.
3011 The smart choice is to have these specs as far to the left as
3012 possible.
3014 This restriction may disappear in later versions of Gnus.
3016 General format specifiers can also be used.
3017 See Info node `(gnus)Formatting Variables'."
3022 ;;;
3023 ;;; Skeleton keymaps
3024 ;;;
3029 (while keys
3030 (define-key keymap (pop keys) 'undefined))))
3032 (defvar gnus-article-mode-map
3033 (let ((keymap (make-sparse-keymap)))
3034 (gnus-suppress-keymap keymap)
3035 keymap))
3036 (defvar gnus-summary-mode-map
3037 (let ((keymap (make-keymap)))
3038 (gnus-suppress-keymap keymap)
3039 keymap))
3040 (defvar gnus-group-mode-map
3041 (let ((keymap (make-keymap)))
3042 (gnus-suppress-keymap keymap)
3043 keymap))
3045 \f
3047 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3048 ;; If you want the cursor to go somewhere else, set these two
3049 ;; functions in some startup hook to whatever you want.
3050 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3051 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3053 ;;; Various macros and substs.
3055 (defun gnus-header-from (header)
3056 (mail-header-from header))
3058 (defmacro gnus-gethash (string hashtable)
3059 "Get hash value of STRING in HASHTABLE."
3060 `(symbol-value (intern-soft ,string ,hashtable)))
3062 (defmacro gnus-gethash-safe (string hashtable)
3063 "Get hash value of STRING in HASHTABLE.
3064 Return nil if not defined."
3065 `(let ((sym (intern-soft ,string ,hashtable)))
3066 (and (boundp sym) (symbol-value sym))))
3068 (defmacro gnus-sethash (string value hashtable)
3069 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3070 `(set (intern ,string ,hashtable) ,value))
3071 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3073 (defmacro gnus-group-unread (group)
3074 "Get the currently computed number of unread articles in GROUP."
3075 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3077 (defmacro gnus-group-entry (group)
3078 "Get the newsrc entry for GROUP."
3079 `(gnus-gethash ,group gnus-newsrc-hashtb))
3081 (defmacro gnus-active (group)
3082 "Get active info on GROUP."
3083 `(gnus-gethash ,group gnus-active-hashtb))
3085 (defmacro gnus-set-active (group active)
3086 "Set GROUP's active info."
3087 `(gnus-sethash ,group ,active gnus-active-hashtb))
3089 ;; Info access macros.
3091 (defmacro gnus-info-group (info)
3092 `(nth 0 ,info))
3093 (defmacro gnus-info-rank (info)
3094 `(nth 1 ,info))
3095 (defmacro gnus-info-read (info)
3096 `(nth 2 ,info))
3097 (defmacro gnus-info-marks (info)
3098 `(nth 3 ,info))
3099 (defmacro gnus-info-method (info)
3100 `(nth 4 ,info))
3101 (defmacro gnus-info-params (info)
3102 `(nth 5 ,info))
3104 (defmacro gnus-info-level (info)
3105 `(let ((rank (gnus-info-rank ,info)))
3106 (if (consp rank)
3107 (car rank)
3108 rank)))
3109 (defmacro gnus-info-score (info)
3110 `(let ((rank (gnus-info-rank ,info)))
3111 (or (and (consp rank) (cdr rank)) 0)))
3113 (defmacro gnus-info-set-group (info group)
3114 `(setcar ,info ,group))
3115 (defmacro gnus-info-set-rank (info rank)
3116 `(setcar (nthcdr 1 ,info) ,rank))
3117 (defmacro gnus-info-set-read (info read)
3118 `(setcar (nthcdr 2 ,info) ,read))
3119 (defmacro gnus-info-set-marks (info marks &optional extend)
3120 (if extend
3121 `(gnus-info-set-entry ,info ,marks 3)
3122 `(setcar (nthcdr 3 ,info) ,marks)))
3123 (defmacro gnus-info-set-method (info method &optional extend)
3124 (if extend
3125 `(gnus-info-set-entry ,info ,method 4)
3126 `(setcar (nthcdr 4 ,info) ,method)))
3127 (defmacro gnus-info-set-params (info params &optional extend)
3128 (if extend
3129 `(gnus-info-set-entry ,info ,params 5)
3130 `(setcar (nthcdr 5 ,info) ,params)))
3132 (defun gnus-info-set-entry (info entry number)
3133 ;; Extend the info until we have enough elements.
3134 (while (<= (length info) number)
3135 (nconc info (list nil)))
3136 ;; Set the entry.
3137 (setcar (nthcdr number info) entry))
3139 (defmacro gnus-info-set-level (info level)
3140 `(let ((rank (cdr ,info)))
3141 (if (consp (car rank))
3142 (setcar (car rank) ,level)
3143 (setcar rank ,level))))
3144 (defmacro gnus-info-set-score (info score)
3145 `(let ((rank (cdr ,info)))
3146 (if (consp (car rank))
3147 (setcdr (car rank) ,score)
3148 (setcar rank (cons (car rank) ,score)))))
3150 (defmacro gnus-get-info (group)
3151 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3153 (defun gnus-set-info (group info)
3154 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3155 info))
3157 ;;; Load the compatibility functions.
3159 (require 'gnus-ems)
3161 \f
3162 ;;;
3163 ;;; Shutdown
3164 ;;;
3166 (defvar gnus-shutdown-alist nil)
3168 (defun gnus-add-shutdown (function &rest symbols)
3169 "Run FUNCTION whenever one of SYMBOLS is shut down."
3170 (push (cons function symbols) gnus-shutdown-alist))
3172 (defun gnus-shutdown (symbol)
3173 "Shut down everything that waits for SYMBOL."
3174 (dolist (entry gnus-shutdown-alist)
3175 (when (memq symbol (cdr entry))
3176 (funcall (car entry)))))
3178 \f
3179 ;;;
3180 ;;; Gnus Utility Functions
3181 ;;;
3183 (defun gnus-find-subscribed-addresses ()
3184 "Return a regexp matching the addresses of all subscribed mail groups.
3185 It consists of the `to-address' or `to-list' parameter of all groups
3186 with a `subscribed' parameter."
3187 (let (group address addresses)
3188 (dolist (entry (cdr gnus-newsrc-alist))
3189 (setq group (car entry))
3190 (when (gnus-parameter-subscribed group)
3191 (setq address (mail-strip-quoted-names
3192 (or (gnus-group-fast-parameter group 'to-address)
3193 (gnus-group-fast-parameter group 'to-list))))
3194 (when address
3195 (add-to-list 'addresses address))))
3196 (when addresses
3199 (defmacro gnus-string-or (&rest strings)
3200 "Return the first element of STRINGS that is a non-blank string.
3201 STRINGS will be evaluated in normal `or' order."
3202 `(gnus-string-or-1 (list ,@strings)))
3204 (defun gnus-string-or-1 (strings)
3205 (let (string)
3206 (while strings
3207 (setq string (pop strings))
3209 (setq string nil)
3210 (setq strings nil)))
3211 string))
3213 (defun gnus-version (&optional arg)
3214 "Version number of this version of Gnus.
3215 If ARG, insert string at point."
3216 (interactive "P")
3217 (if arg
3218 (insert (message gnus-version))
3219 (message gnus-version)))
3221 (defun gnus-continuum-version (&optional version)
3222 "Return VERSION as a floating point number."
3223 (unless version
3224 (setq version gnus-version))
3227 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3228 (number (match-string 2 version))
3229 major minor least)
3230 (unless (string-match
3232 (error "Invalid version string: %s" version))
3233 (setq major (string-to-number (match-string 1 number))
3234 minor (string-to-number (match-string 2 number))
3235 least (if (match-beginning 3)
3236 (string-to-number (match-string 3 number))
3237 0))
3238 (string-to-number
3239 (if (zerop major)
3240 (format "%1.2f00%02d%02d"
3241 (if (member alpha '("(ding)" "d"))
3242 4.99
3243 (+ 5 (* 0.02
3244 (abs
3245 (- (mm-char-int (aref (downcase alpha) 0))
3246 (mm-char-int ?t))))
3247 -0.01))
3248 minor least)
3249 (format "%d.%02d%02d" major minor least))))))
3251 (defun gnus-info-find-node (&optional nodename)
3252 "Find Info documentation of Gnus."
3253 (interactive)
3254 ;; Enlarge info window if needed.
3255 (let (gnus-info-buffer)
3256 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3257 (setq gnus-info-buffer (current-buffer))
3258 (gnus-configure-windows 'info)))
3260 ;;;
3261 ;;; gnus-interactive
3262 ;;;
3264 (defvar gnus-current-prefix-symbol nil
3265 "Current prefix symbol.")
3267 (defvar gnus-current-prefix-symbols nil
3268 "List of current prefix symbols.")
3270 (defun gnus-interactive (string &optional params)
3271 "Return a list that can be fed to `interactive'.
3272 See `interactive' for full documentation.
3274 Adds the following specs:
3276 y -- The current symbolic prefix.
3277 Y -- A list of the current symbolic prefix(es).
3278 A -- Article number.
3279 H -- Article header.
3280 g -- Group name."
3281 (let ((i 0)
3282 out c prompt)
3283 (while (< i (length string))
3285 (setq c (aref string i))
3286 (when (match-end 1)
3287 (setq prompt (match-string 1 string)))
3288 (setq i (match-end 0))
3289 ;; We basically emulate just about everything that
3290 ;; `interactive' does, but add the specs listed above.
3291 (push
3292 (cond
3293 ((= c ?a)
3294 (completing-read prompt obarray 'fboundp t))
3295 ((= c ?b)
3296 (read-buffer prompt (current-buffer) t))
3297 ((= c ?B)
3298 (read-buffer prompt (other-buffer (current-buffer))))
3299 ((= c ?c)
3300 (read-char))
3301 ((= c ?C)
3302 (completing-read prompt obarray 'commandp t))
3303 ((= c ?d)
3304 (point))
3305 ((= c ?D)
3306 (read-directory-name prompt nil default-directory 'lambda))
3307 ((= c ?f)
3308 (read-file-name prompt nil nil 'lambda))
3309 ((= c ?F)
3310 (read-file-name prompt))
3311 ((= c ?k)
3312 (read-key-sequence prompt))
3313 ((= c ?K)
3314 (error "Not implemented spec"))
3315 ((= c ?e)
3316 (error "Not implemented spec"))
3317 ((= c ?m)
3318 (mark))
3319 ((= c ?N)
3320 (error "Not implemented spec"))
3321 ((= c ?n)
3322 (string-to-number (read-from-minibuffer prompt)))
3323 ((= c ?p)
3324 (prefix-numeric-value current-prefix-arg))
3325 ((= c ?P)
3326 current-prefix-arg)
3327 ((= c ?r)
3328 'gnus-prefix-nil)
3329 ((= c ?s)
3330 (read-string prompt))
3331 ((= c ?S)
3332 (intern (read-string prompt)))
3333 ((= c ?v)
3334 (read-variable prompt))
3335 ((= c ?x)
3336 (read-minibuffer prompt))
3337 ((= c ?x)
3338 (eval-minibuffer prompt))
3339 ;; And here the new specs come.
3340 ((= c ?y)
3341 gnus-current-prefix-symbol)
3342 ((= c ?Y)
3343 gnus-current-prefix-symbols)
3344 ((= c ?g)
3345 (gnus-group-group-name))
3346 ((= c ?A)
3347 (gnus-summary-skip-intangible)
3348 (or (get-text-property (point) 'gnus-number)
3349 (gnus-summary-last-subject)))
3350 ((= c ?H)
3351 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3352 (t
3353 (error "Non-implemented spec")))
3354 out)
3355 (cond
3356 ((= c ?r)
3357 (push (if (< (point) (mark)) (point) (mark)) out)
3358 (push (if (> (point) (mark)) (point) (mark)) out))))
3359 (setq out (delq 'gnus-prefix-nil out))
3360 (nreverse out)))
3362 (defun gnus-symbolic-argument (&optional arg)
3363 "Read a symbolic argument and a command, and then execute command."
3364 (interactive "P")
3365 (let* ((in-command (this-command-keys))
3366 (command in-command)
3367 gnus-current-prefix-symbols
3368 gnus-current-prefix-symbol
3369 syms)
3370 (while (equal in-command command)
3371 (message "%s-" (key-description (this-command-keys)))
3372 (push (intern (char-to-string (read-char))) syms)
3373 (setq command (read-key-sequence nil t)))
3374 (setq gnus-current-prefix-symbols (nreverse syms)
3375 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3376 (call-interactively (key-binding command t))))
3378 ;;; More various functions.
3380 (defsubst gnus-check-backend-function (func group)
3381 "Check whether GROUP supports function FUNC.
3382 GROUP can either be a string (a group name) or a select method."
3383 (ignore-errors
3384 (let ((method (if (stringp group)
3385 (car (gnus-find-method-for-group group))
3386 group)))
3387 (unless (featurep method)
3388 (require method))
3389 (fboundp (intern (format "%s-%s" method func))))))
3391 (defun gnus-group-read-only-p (&optional group)
3392 "Check whether GROUP supports editing or not.
3393 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3394 that that variable is buffer-local to the summary buffers."
3395 (let ((group (or group gnus-newsgroup-name)))
3396 (not (gnus-check-backend-function 'request-replace-article group))))
3398 (defun gnus-virtual-group-p (group)
3399 "Say whether GROUP is virtual or not."
3400 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3401 gnus-valid-select-methods)))
3403 (defun gnus-news-group-p (group &optional article)
3404 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3405 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3406 t) ;is news of course.
3407 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3408 nil) ;must be mail then.
3409 ((vectorp article) ;Has header info.
3410 (eq (gnus-request-type group (mail-header-id article)) 'news))
3411 ((null article) ;Hasn't header info
3412 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3413 ((< article 0) ;Virtual message
3414 nil) ;we don't know, guess mail.
3415 (t ;Has positive number
3416 (eq (gnus-request-type group article) 'news)))) ;use it.
3418 ;; Check whether to use long file names.
3419 (defun gnus-use-long-file-name (symbol)
3420 ;; The variable has to be set...
3421 (and gnus-use-long-file-name
3422 ;; If it isn't a list, then we return t.
3423 (or (not (listp gnus-use-long-file-name))
3424 ;; If it is a list, and the list contains `symbol', we
3425 ;; return nil.
3426 (not (memq symbol gnus-use-long-file-name)))))
3428 ;; Generate a unique new group name.
3429 (defun gnus-generate-new-group-name (leaf)
3430 (let ((name leaf)
3431 (num 0))
3432 (while (gnus-group-entry name)
3433 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3434 name))
3436 (defun gnus-ephemeral-group-p (group)
3437 "Say whether GROUP is ephemeral or not."
3438 (gnus-group-get-parameter group 'quit-config t))
3440 (defun gnus-group-quit-config (group)
3441 "Return the quit-config of GROUP."
3442 (gnus-group-get-parameter group 'quit-config t))
3444 (defun gnus-kill-ephemeral-group (group)
3445 "Remove ephemeral GROUP from relevant structures."
3446 (gnus-sethash group nil gnus-newsrc-hashtb))
3448 (defun gnus-simplify-mode-line ()
3449 "Make mode lines a bit simpler."
3450 (setq mode-line-modified (cdr gnus-mode-line-modified))
3451 (when (listp mode-line-format)
3452 (make-local-variable 'mode-line-format)
3453 (setq mode-line-format (copy-sequence mode-line-format))
3454 (when (equal (nth 3 mode-line-format) " ")
3455 (setcar (nthcdr 3 mode-line-format) " "))))
3457 ;;; Servers and groups.
3459 (defsubst gnus-server-add-address (method)
3460 (let ((method-name (symbol-name (car method))))
3461 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3462 (not (assq (intern (concat method-name "-address")) method))
3463 (memq 'physical-address (assq (car method)
3464 gnus-valid-select-methods)))
3465 (append method (list (list (intern (concat method-name "-address"))
3466 (nth 1 method))))
3467 method)))
3469 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3470 (catch 'server-name
3471 (setq method (or method gnus-select-method))
3473 ;; Perhaps it is already in the cache.
3474 (unless nocache
3475 (mapc (lambda (name-method)
3476 (if (equal (cdr name-method) method)
3477 (throw 'server-name (car name-method))))
3478 gnus-server-method-cache))
3480 (mapc
3481 (lambda (server-alist)
3482 (mapc (lambda (name-method)
3483 (when (gnus-methods-equal-p (cdr name-method) method)
3484 (unless (member name-method gnus-server-method-cache)
3485 (push name-method gnus-server-method-cache))
3486 (throw 'server-name (car name-method))))
3487 server-alist))
3488 (list gnus-server-alist
3489 gnus-predefined-server-alist))
3491 (let* ((name (if (member (cadr method) '(nil ""))
3492 (format "%s" (car method))
3493 (format "%s:%s" (car method) (cadr method))))
3494 (name-method (cons name method)))
3495 (when (and (not (member name-method gnus-server-method-cache))
3496 (not no-enter-cache)
3497 (not (assoc (car name-method) gnus-server-method-cache)))
3498 (push name-method gnus-server-method-cache))
3499 name)))
3501 (defsubst gnus-server-to-method (server)
3502 "Map virtual server names to select methods."
3503 (or (and server (listp server) server)
3504 (cdr (assoc server gnus-server-method-cache))
3505 (let ((result
3506 (or
3507 ;; Perhaps this is the native server?
3508 (and (equal server "native") gnus-select-method)
3509 ;; It should be in the server alist.
3510 (cdr (assoc server gnus-server-alist))
3511 ;; It could be in the predefined server alist.
3512 (cdr (assoc server gnus-predefined-server-alist))
3513 ;; If not, we look through all the opened server
3514 ;; to see whether we can find it there.
3515 (let ((opened gnus-opened-servers))
3516 (while (and opened
3517 (not (equal server (format "%s:%s" (caaar opened)
3518 (cadaar opened)))))
3519 (pop opened))
3520 (caar opened))
3521 ;; It could be a named method, search all servers
3522 (let ((servers gnus-secondary-select-methods))
3523 (while (and servers
3524 (not (equal server (format "%s:%s" (caar servers)
3525 (cadar servers)))))
3526 (pop servers))
3527 (car servers))
3528 ;; This could be some sort of foreign server that I
3529 ;; simply haven't opened (yet). Do a brute-force scan
3530 ;; of the entire gnus-newsrc-alist for the server name
3531 ;; of every method. As a side-effect, loads the
3532 ;; gnus-server-method-cache so this only happens once,
3533 ;; if at all.
3534 (let ((alist (cdr gnus-newsrc-alist))
3535 method match)
3536 (while alist
3537 (setq method (gnus-info-method (pop alist)))
3538 (when (and (not (stringp method))
3539 (equal server
3540 (gnus-method-to-server method nil t)))
3541 (setq match method
3542 alist nil)))
3543 match))))
3544 (when (and result
3545 (not (assoc server gnus-server-method-cache)))
3546 (push (cons server result) gnus-server-method-cache))
3547 result)))
3549 (defsubst gnus-server-get-method (group method)
3550 ;; Input either a server name, and extended server name, or a
3551 ;; select method, and return a select method.
3552 (cond ((stringp method)
3553 (gnus-server-to-method method))
3554 ((equal method gnus-select-method)
3555 gnus-select-method)
3556 ((and (stringp (car method))
3557 group)
3558 (gnus-server-extend-method group method))
3559 ((and method
3560 (not group)
3561 (equal (cadr method) ""))
3562 method)
3563 (t
3564 (gnus-server-add-address method))))
3566 (defmacro gnus-method-equal (ss1 ss2)
3567 "Say whether two servers are equal."
3568 `(let ((s1 ,ss1)
3569 (s2 ,ss2))
3570 (or (equal s1 s2)
3571 (and (= (length s1) (length s2))
3572 (progn
3573 (while (and s1 (member (car s1) s2))
3574 (setq s1 (cdr s1)))
3575 (null s1))))))
3577 (defun gnus-methods-equal-p (m1 m2)
3578 (let ((m1 (or m1 gnus-select-method))
3579 (m2 (or m2 gnus-select-method)))
3580 (or (equal m1 m2)
3581 (and (eq (car m1) (car m2))
3582 (or (not (memq 'address (assoc (symbol-name (car m1))
3583 gnus-valid-select-methods)))
3584 (equal (nth 1 m1) (nth 1 m2)))))))
3586 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3587 ;; Check parameters for sloppy equality.
3588 (let ((p1 (copy-sequence (cddr m1)))
3589 (p2 (copy-sequence (cddr m2)))
3590 e1 e2)
3591 (block nil
3592 (while (setq e1 (pop p1))
3593 (unless (setq e2 (assq (car e1) p2))
3594 ;; The parameter doesn't exist in p2.
3595 (return nil))
3596 (setq p2 (delq e2 p2))
3597 (unless (equal e1 e2)
3598 (if (not (and (stringp (cadr e1))
3599 (stringp (cadr e2))))
3600 (return nil)
3601 ;; Special-case string parameter comparison so that we
3602 ;; can uniquify them.
3603 (let ((s1 (cadr e1))
3604 (s2 (cadr e2)))
3605 (when (string-match "/$" s1)
3606 (setq s1 (directory-file-name s1)))
3607 (when (string-match "/$" s2)
3608 (setq s2 (directory-file-name s2)))
3609 (unless (equal s1 s2)
3610 (return nil))))))
3611 ;; If p2 now is empty, they were equal.
3612 (null p2))))
3614 (defun gnus-method-ephemeral-p (method)
3615 (let ((equal nil))
3616 (dolist (ephemeral gnus-ephemeral-servers)
3617 (when (gnus-sloppily-equal-method-parameters method ephemeral)
3618 (setq equal t)))
3619 equal))
3621 (defun gnus-methods-sloppily-equal (m1 m2)
3622 ;; Same method.
3623 (or
3624 (eq m1 m2)
3625 ;; Type and name are equal.
3626 (and
3627 (eq (car m1) (car m2))
3628 (equal (cadr m1) (cadr m2))
3629 (gnus-sloppily-equal-method-parameters m1 m2))))
3631 (defun gnus-server-equal (m1 m2)
3632 "Say whether two methods are equal."
3633 (let ((m1 (cond ((null m1) gnus-select-method)
3634 ((stringp m1) (gnus-server-to-method m1))
3635 (t m1)))
3636 (m2 (cond ((null m2) gnus-select-method)
3637 ((stringp m2) (gnus-server-to-method m2))
3638 (t m2))))
3639 (gnus-method-equal m1 m2)))
3641 (defun gnus-servers-using-backend (backend)
3642 "Return a list of known servers using BACKEND."
3643 (let ((opened gnus-opened-servers)
3644 out)
3645 (while opened
3646 (when (eq backend (caaar opened))
3647 (push (caar opened) out))
3648 (pop opened))
3649 out))
3651 (defun gnus-archive-server-wanted-p ()
3652 "Say whether the user wants to use the archive server."
3653 (cond
3654 ((or (not gnus-message-archive-method)
3655 (not gnus-message-archive-group))
3656 nil)
3657 ((and gnus-message-archive-method gnus-message-archive-group)
3658 t)
3659 (t
3660 (let ((active (cadr (assq 'nnfolder-active-file
3661 gnus-message-archive-method))))
3662 (and active
3663 (file-exists-p active))))))
3665 (defsubst gnus-method-to-server-name (method)
3666 (concat
3667 (format "%s" (car method))
3668 (when (and
3669 (or (assoc (format "%s" (car method))
3670 (gnus-methods-using 'address))
3671 (gnus-server-equal method gnus-message-archive-method))
3672 (nth 1 method)
3673 (not (string= (nth 1 method) "")))
3674 (concat "+" (nth 1 method)))))
3676 (defsubst gnus-method-to-full-server-name (method)
3677 (format "%s+%s" (car method) (nth 1 method)))
3679 (defun gnus-group-prefixed-name (group method &optional full)
3680 "Return the whole name from GROUP and METHOD.
3681 Call with full set to get the fully qualified group name (even if the
3682 server is native)."
3683 (when (stringp method)
3684 (setq method (gnus-server-to-method method)))
3685 (if (or (not method)
3686 (and (not full) (gnus-server-equal method "native"))
3687 ;;;!!! This might not be right. We'll see...
3688 ;(string-match ":" group)
3689 )
3690 group
3691 (concat (gnus-method-to-server-name method) ":" group)))
3693 (defun gnus-group-full-name (group method)
3694 "Return the full name from GROUP and METHOD, even if the method is native."
3695 (gnus-group-prefixed-name group method t))
3697 (defun gnus-group-guess-full-name-from-command-method (group)
3698 "Guess the full name from GROUP, even if the method is native."
3699 (if (gnus-group-prefixed-p group)
3700 group
3701 (gnus-group-full-name group gnus-command-method)))
3703 (defun gnus-group-real-prefix (group)
3704 "Return the prefix of the current group name."
3705 (if (stringp group)
3706 (if (string-match "^[^:]+:" group)
3707 (substring group 0 (match-end 0))
3708 "")
3709 nil))
3711 (defun gnus-group-short-name (group)
3712 "Return the short group name."
3713 (let ((prefix (gnus-group-real-prefix group)))
3714 (if (< 0 (length prefix))
3715 (substring group (length prefix) nil)
3716 group)))
3718 (defun gnus-group-prefixed-p (group)
3719 "Return the prefix of the current group name."
3720 (< 0 (length (gnus-group-real-prefix group))))
3722 (declare-function gnus-group-decoded-name "gnus-group" (string))
3724 (defun gnus-summary-buffer-name (group)
3725 "Return the summary buffer name of GROUP."
3726 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3728 (defun gnus-group-method (group)
3729 "Return the server or method used for selecting GROUP.
3730 You should probably use `gnus-find-method-for-group' instead."
3731 (let ((prefix (gnus-group-real-prefix group)))
3732 (if (equal prefix "")
3733 gnus-select-method
3734 (let ((servers gnus-opened-servers)
3735 (server "")
3736 backend possible found)
3738 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3739 server (substring prefix (match-end 0) (1- (length prefix))))
3740 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3741 (while servers
3742 (when (eq (caaar servers) backend)
3743 (setq possible (caar servers))
3744 (when (equal (cadaar servers) server)
3745 (setq found (caar servers))))
3746 (pop servers))
3747 (or (car (rassoc found gnus-server-alist))
3748 found
3749 (car (rassoc possible gnus-server-alist))
3750 possible
3751 (list backend server))))))
3753 (defsubst gnus-native-method-p (method)
3754 "Return whether METHOD is the native select method."
3755 (gnus-method-equal method gnus-select-method))
3757 (defsubst gnus-secondary-method-p (method)
3758 "Return whether METHOD is a secondary select method."
3759 (let ((methods gnus-secondary-select-methods)
3760 (gmethod (inline (gnus-server-get-method nil method))))
3761 (while (and methods
3762 (not (gnus-method-equal
3763 (inline (gnus-server-get-method nil (car methods)))
3764 gmethod)))
3765 (setq methods (cdr methods)))
3766 methods))
3768 (defun gnus-method-simplify (method)
3769 "Return the shortest uniquely identifying string or method for METHOD."
3770 (cond ((stringp method)
3771 method)
3772 ((gnus-native-method-p method)
3773 nil)
3774 ((gnus-secondary-method-p method)
3775 (format "%s:%s" (nth 0 method) (nth 1 method)))
3776 (t
3777 method)))
3779 (defun gnus-groups-from-server (server)
3780 "Return a list of all groups that are fetched from SERVER."
3781 (let ((alist (cdr gnus-newsrc-alist))
3782 info groups)
3783 (while (setq info (pop alist))
3784 (when (gnus-server-equal (gnus-info-method info) server)
3785 (push (gnus-info-group info) groups)))
3786 (sort groups 'string<)))
3788 (defun gnus-group-foreign-p (group)
3789 "Say whether a group is foreign or not."
3790 (and (not (gnus-group-native-p group))
3791 (not (gnus-group-secondary-p group))))
3793 (defun gnus-group-native-p (group)
3794 "Say whether the group is native or not."
3795 (not (string-match ":" group)))
3797 (defun gnus-group-secondary-p (group)
3798 "Say whether the group is secondary or not."
3799 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3801 (defun gnus-parameters-get-parameter (group)
3802 "Return the group parameters for GROUP from `gnus-parameters'."
3803 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3804 case-fold-search
3805 gnus-parameters-case-fold-search))
3806 params-list)
3807 (dolist (elem gnus-parameters)
3808 (when (string-match (car elem) group)
3809 (setq params-list
3810 (nconc (gnus-expand-group-parameters
3811 (car elem) (cdr elem) group)
3812 params-list))))
3813 params-list))
3815 (defun gnus-expand-group-parameter (match value group)
3816 "Use MATCH to expand VALUE in GROUP."
3817 (let ((start (string-match match group)))
3818 (if start
3819 (let ((matched-string (substring group start (match-end 0))))
3820 ;; Build match groups
3821 (string-match match matched-string)
3822 (replace-match value nil nil matched-string))
3823 group)))
3825 (defun gnus-expand-group-parameters (match parameters group)
3826 "Go through PARAMETERS and expand them according to the match data."
3827 (let (new)
3828 (dolist (elem parameters)
3829 (cond
3830 ((and (stringp (cdr elem))
3832 (push (cons (car elem)
3833 (gnus-expand-group-parameter match (cdr elem) group))
3834 new))
3835 ;; For `sieve' group parameters, perform substitutions for every
3836 ;; string within the match rule. This allows for parameters such
3837 ;; as:
3840 ((eq 'sieve (car elem))
3841 (push (mapcar (lambda (sieve-elem)
3842 (if (and (stringp sieve-elem)
3844 (gnus-expand-group-parameter match sieve-elem
3845 group)
3846 sieve-elem))
3847 (cdr elem))
3848 new))
3849 (t
3850 (push elem new))))
3851 new))
3853 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3854 "For GROUP, return the value of SYMBOL.
3856 You should call this in the `gnus-group-buffer' buffer.
3857 The function `gnus-group-find-parameter' will do that for you."
3858 ;; The speed trick: No cons'ing and quit early.
3859 (let* ((params (funcall gnus-group-get-parameter-function group))
3860 ;; Start easy, check the "real" group parameters.
3861 (simple-results
3862 (gnus-group-parameter-value params symbol allow-list t)))
3863 (if simple-results
3864 ;; Found results; return them.
3865 (car simple-results)
3866 ;; We didn't find it there, try `gnus-parameters'.
3867 (let ((result nil)
3868 (head nil)
3869 (tail gnus-parameters))
3870 ;; A good old-fashioned non-cl loop.
3871 (while tail
3872 (setq head (car tail)
3873 tail (cdr tail))
3874 ;; The car is regexp matching for matching the group name.
3875 (when (string-match (car head) group)
3876 ;; The cdr is the parameters.
3877 (let ((this-result
3878 (gnus-group-parameter-value (cdr head) symbol allow-list t)))
3879 (when this-result
3880 (setq result (car this-result))
3881 ;; Expand if necessary.
3882 (cond
3884 (setq result (gnus-expand-group-parameter
3885 (car head) result group)))
3886 ;; For `sieve' group parameters, perform substitutions
3887 ;; for every string within the match rule (see above).
3888 ((eq symbol 'sieve)
3889 (setq result
3890 (mapcar (lambda (elem)
3891 (if (stringp elem)
3892 (gnus-expand-group-parameter (car head)
3893 elem group)
3894 elem))
3895 result))))))))
3896 ;; Done.
3897 result))))
3899 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3900 "Return the group parameters for GROUP.
3901 If SYMBOL, return the value of that symbol in the group parameters.
3903 If you call this function inside a loop, consider using the faster
3904 `gnus-group-fast-parameter' instead."
3905 (with-current-buffer (if (buffer-live-p (get-buffer gnus-group-buffer))
3906 gnus-group-buffer
3907 (current-buffer))
3908 (if symbol
3909 (gnus-group-fast-parameter group symbol allow-list)
3910 (nconc
3911 (copy-sequence
3912 (funcall gnus-group-get-parameter-function group))
3913 (gnus-parameters-get-parameter group)))))
3915 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3916 "Return the group parameters for GROUP.
3917 If SYMBOL, return the value of that symbol in the group parameters.
3918 If ALLOW-LIST, also allow list as a result.
3919 Most functions should use `gnus-group-find-parameter', which
3920 also examines the topic parameters."
3921 (let ((params (gnus-info-params (gnus-get-info group))))
3922 (if symbol
3923 (gnus-group-parameter-value params symbol allow-list)
3924 params)))
3926 (defun gnus-group-parameter-value (params symbol &optional
3927 allow-list present-p)
3928 "Return the value of SYMBOL in group PARAMS.
3929 If ALLOW-LIST, also allow list as a result."
3930 ;; We only wish to return group parameters (dotted lists) and
3931 ;; not local variables, which may have the same names.
3932 ;; But first we handle single elements...
3933 (or (car (memq symbol params))
3934 ;; Handle alist.
3935 (let (elem)
3936 (catch 'found
3937 (while (setq elem (pop params))
3938 (when (and (consp elem)
3939 (eq (car elem) symbol)
3940 (or allow-list
3941 (atom (cdr elem))))
3942 (throw 'found (if present-p (list (cdr elem))
3943 (cdr elem)))))))))
3945 (defun gnus-group-add-parameter (group param)
3946 "Add parameter PARAM to GROUP."
3947 (let ((info (gnus-get-info group)))
3948 (when info
3949 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3950 ;; Cons the new param to the old one and update.
3951 (gnus-group-set-info (cons param (gnus-info-params info))
3952 group 'params))))
3954 (defun gnus-group-set-parameter (group name value)
3955 "Set parameter NAME to VALUE in GROUP.
3956 GROUP can also be an INFO structure."
3957 (let ((info (if (listp group)
3958 group
3959 (gnus-get-info group))))
3960 (when info
3961 (gnus-group-remove-parameter group name)
3962 (let ((old-params (gnus-info-params info))
3963 (new-params (list (cons name value))))
3964 (while old-params
3965 (when (or (not (listp (car old-params)))
3966 (not (eq (caar old-params) name)))
3967 (setq new-params (append new-params (list (car old-params)))))
3968 (setq old-params (cdr old-params)))
3969 (if (listp group)
3970 (gnus-info-set-params info new-params t)
3971 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3973 (defun gnus-group-remove-parameter (group name)
3974 "Remove parameter NAME from GROUP.
3975 GROUP can also be an INFO structure."
3976 (let ((info (if (listp group)
3977 group
3978 (gnus-get-info group))))
3979 (when info
3980 (let ((params (gnus-info-params info)))
3981 (when params
3982 (setq params (delq name params))
3983 (while (assq name params)
3984 (gnus-alist-pull name params))
3985 (gnus-info-set-params info params))))))
3987 (defun gnus-group-add-score (group &optional score)
3988 "Add SCORE to the GROUP score.
3989 If SCORE is nil, add 1 to the score of GROUP."
3990 (let ((info (gnus-get-info group)))
3991 (when info
3992 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3994 (defun gnus-short-group-name (group &optional levels)
3995 "Collapse GROUP name LEVELS.
3996 Select methods are stripped and any remote host name is stripped down to
3997 just the host name."
3998 (let* ((name "")
3999 (foreign "")
4000 (depth 0)
4001 (skip 1)
4002 (levels (or levels
4003 gnus-group-uncollapsed-levels
4004 (progn
4006 (setq skip (match-end 0)
4007 depth (+ depth 1)))
4008 depth))))
4009 ;; Separate foreign select method from group name and collapse.
4010 ;; If method contains a server, collapse to non-domain server name,
4011 ;; otherwise collapse to select method.
4012 (let* ((colon (string-match ":" group))
4013 (server (and colon (substring group 0 colon)))
4014 (plus (and server (string-match "+" server))))
4015 (when server
4016 (if plus
4017 (setq foreign (substring server (+ 1 plus)
4019 group (substring group (+ 1 colon)))
4020 (setq foreign server
4021 group (substring group (+ 1 colon))))
4022 (setq foreign (concat foreign ":")))
4023 ;; Collapse group name leaving LEVELS uncollapsed elements
4024 (let* ((slist (split-string group "/"))
4025 (slen (length slist))
4027 (dlen (length dlist))
4028 glist
4029 glen
4030 gsep
4031 res)
4032 (if (> slen dlen)
4033 (setq glist slist
4034 glen slen
4035 gsep "/")
4036 (setq glist dlist
4037 glen dlen
4038 gsep "."))
4039 (setq levels (- glen levels))
4040 (dolist (g glist)
4041 (push (if (>= (decf levels) 0)
4042 (if (zerop (length g))
4043 ""
4044 (substring g 0 1))
4045 g)
4046 res))
4047 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4049 (defun gnus-narrow-to-body ()
4050 "Narrow to the body of an article."
4051 (narrow-to-region
4052 (progn
4053 (goto-char (point-min))
4055 (point-max)))
4056 (point-max)))
4058 \f
4059 ;;;
4060 ;;; Kill file handling.
4061 ;;;
4063 (defun gnus-apply-kill-file ()
4064 "Apply a kill file to the current newsgroup.
4065 Returns the number of articles marked as read."
4066 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4067 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4068 (gnus-apply-kill-file-internal)
4069 0))
4071 (defun gnus-kill-save-kill-buffer ()
4072 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4073 (when (get-file-buffer file)
4074 (with-current-buffer (get-file-buffer file)
4075 (when (buffer-modified-p)
4076 (save-buffer))
4077 (kill-buffer (current-buffer))))))
4079 (defcustom gnus-kill-file-name "KILL"
4080 "Suffix of the kill files."
4081 :group 'gnus-score-kill
4082 :group 'gnus-score-files
4083 :type 'string)
4085 (defun gnus-newsgroup-kill-file (newsgroup)
4086 "Return the name of a kill file name for NEWSGROUP.
4087 If NEWSGROUP is nil, return the global kill file name instead."
4088 (cond
4089 ;; The global KILL file is placed at top of the directory.
4090 ((or (null newsgroup)
4091 (string-equal newsgroup ""))
4092 (expand-file-name gnus-kill-file-name
4093 gnus-kill-files-directory))
4094 ;; Append ".KILL" to newsgroup name.
4095 ((gnus-use-long-file-name 'not-kill)
4096 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4097 "." gnus-kill-file-name)
4098 gnus-kill-files-directory))
4099 ;; Place "KILL" under the hierarchical directory.
4100 (t
4101 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4102 "/" gnus-kill-file-name)
4103 gnus-kill-files-directory))))
4105 ;;; Server things.
4107 (defun gnus-member-of-valid (symbol group)
4109 (memq symbol (assoc
4110 (symbol-name (car (gnus-find-method-for-group group)))
4111 gnus-valid-select-methods)))
4113 (defun gnus-method-option-p (method option)
4114 "Return non-nil if select METHOD has OPTION as a parameter."
4115 (when (stringp method)
4116 (setq method (gnus-server-to-method method)))
4117 (memq option (assoc (format "%s" (car method))
4118 gnus-valid-select-methods)))
4120 (defun gnus-similar-server-opened (method)
4121 "Return non-nil if we have a similar server opened.
4122 This is defined as a server with the same name, but different
4123 parameters."
4124 (let ((opened gnus-opened-servers)
4125 open)
4126 (while (and method opened)
4127 (setq open (car (pop opened)))
4128 ;; Type and name are the same...
4129 (when (and (equal (car method) (car open))
4130 (equal (cadr method) (cadr open))
4131 ;; ... but the rest of the parameters differ.
4132 (not (gnus-methods-sloppily-equal method open)))
4133 (setq method nil)))
4134 (not method)))
4136 (defun gnus-server-extend-method (group method)
4137 ;; This function "extends" a virtual server. If the server is
4138 ;; "hello", and the select method is ("hello" (my-var "something"))
4139 ;; in the group "alt.alt", this will result in a new virtual server
4140 ;; called "hello+alt.alt".
4141 (if (or (not (inline (gnus-similar-server-opened method)))
4142 (not (cddr method)))
4143 method
4144 (let ((address-slot
4145 (intern (format "%s-address" (car method)))))
4146 (setq method
4147 (if (assq address-slot (cddr method))
4148 `(,(car method) ,(concat (cadr method) "+" group)
4149 ,@(cddr method))
4150 `(,(car method) ,(concat (cadr method) "+" group)
4151 (,address-slot ,(cadr method))
4152 ,@(cddr method))))
4153 (push method gnus-extended-servers)
4154 method)))
4156 (defun gnus-server-status (method)
4157 "Return the status of METHOD."
4158 (nth 1 (assoc method gnus-opened-servers)))
4160 (defun gnus-group-name-to-method (group)
4161 "Guess a select method based on GROUP."
4162 (if (string-match ":" group)
4163 (let ((server (substring group 0 (match-beginning 0))))
4165 (list (intern (substring server 0 (match-beginning 0)))
4166 (substring server (match-end 0)))
4167 (list (intern server) "")))
4168 gnus-select-method))
4170 (defun gnus-server-string (server)
4171 "Return a readable string that describes SERVER."
4172 (let* ((server (gnus-server-to-method server))
4173 (address (nth 1 server)))
4174 (if (and address
4175 (not (zerop (length address))))
4176 (format "%s using %s" address (car server))
4177 (format "%s" (car server)))))
4179 (defun gnus-same-method-different-name (method)
4180 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4181 (unless (assq slot (cddr method))
4182 (setq method
4183 (append method (list (list slot (nth 1 method)))))))
4184 (let ((methods gnus-extended-servers)
4185 open found)
4186 (while (and (not found)
4187 (setq open (pop methods)))
4188 (when (and (eq (car method) (car open))
4189 (gnus-sloppily-equal-method-parameters method open))
4190 (setq found open)))
4191 found))
4193 (defun gnus-find-method-for-group (group &optional info)
4194 "Find the select method that GROUP uses."
4195 (or gnus-override-method
4196 (and (not group)
4197 gnus-select-method)
4198 (and (not (gnus-group-entry group))
4199 ;; Killed or otherwise unknown group.
4200 (or
4201 ;; If we know a virtual server by that name, return its method.
4202 (gnus-server-to-method (gnus-group-server group))
4203 ;; Guess a new method as last resort.
4204 (gnus-group-name-to-method group)))
4205 (let ((info (or info (gnus-get-info group)))
4206 method)
4207 (if (or (not info)
4208 (not (setq method (gnus-info-method info)))
4209 (equal method "native"))
4210 gnus-select-method
4211 (setq method
4212 (cond ((stringp method)
4213 (inline (gnus-server-to-method method)))
4214 ((stringp (cadr method))
4215 (or
4216 (inline
4217 (gnus-same-method-different-name method))
4218 (inline (gnus-server-extend-method group method))))
4219 (t
4220 method)))
4221 (cond ((equal (cadr method) "")
4222 method)
4223 ((null (cadr method))
4224 (list (car method) ""))
4225 (t
4226 (gnus-server-add-address method)))))))
4228 (defun gnus-methods-using (feature)
4229 "Find all methods that have FEATURE."
4230 (let ((valids gnus-valid-select-methods)
4231 outs)
4232 (while valids
4233 (when (memq feature (car valids))
4234 (push (car valids) outs))
4235 (setq valids (cdr valids)))
4236 outs))
4238 (autoload 'message-y-or-n-p "message" nil nil 'macro)
4240 (defun gnus-read-group (prompt &optional default)
4241 "Prompt the user for a group name.
4242 Disallow invalid group names."
4243 (let ((prefix "")
4244 group)
4245 (while (not group)
4246 (when (string-match
4247 gnus-invalid-group-regexp
4248 (setq group (read-string (concat prefix prompt)
4249 (cons (or default "") 0)
4250 'gnus-group-history)))
4251 (let ((match (match-string 0 group)))
4252 ;; Might be okay (e.g. for nnimap), so ask the user:
4254 (message-y-or-n-p
4255 "Proceed and create group anyway? " t
4258 Usually, it's dangerous to create a group with this name, because it's not
4259 supported by all back ends and servers. On IMAP servers it should work,
4260 though. If you are really sure, you can proceed anyway and create the group.
4262 You may customize the variable `gnus-invalid-group-regexp', which currently is
4266 group nil)))))
4267 group))
4269 (defun gnus-read-method (prompt)
4270 "Prompt the user for a method.
4271 Allow completion over sensible values."
4272 (let* ((open-servers
4273 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4274 gnus-opened-servers))
4275 (valid-methods
4276 (let (methods)
4277 (dolist (method gnus-valid-select-methods)
4278 (if (or (memq 'prompt-address method)
4279 (not (assoc (format "%s:" (car method)) open-servers)))
4280 (push method methods)))
4281 methods))
4282 (servers
4283 (append valid-methods
4284 open-servers
4285 gnus-predefined-server-alist
4286 gnus-server-alist))
4287 (method
4288 (gnus-completing-read
4289 prompt (mapcar 'car servers)
4290 t nil 'gnus-method-history)))
4291 (cond
4292 ((equal method "")
4293 (setq method gnus-select-method))
4294 ((assoc method gnus-valid-select-methods)
4295 (let ((address (if (memq 'prompt-address
4296 (assoc method gnus-valid-select-methods))
4297 (read-string "Address: ")
4298 "")))
4299 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4300 (list (intern method) address))))
4301 ((assoc method servers)
4302 method)
4303 (t
4304 (list (intern method) "")))))
4306 ;;; Agent functions
4308 (defun gnus-agent-method-p (method-or-server)
4309 "Say whether METHOD is covered by the agent."
4310 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4311 (let* ((method (if (stringp method-or-server)
4312 (gnus-server-to-method method-or-server)
4313 method-or-server))
4314 (server (gnus-method-to-server method t)))
4315 (setq gnus-agent-method-p-cache
4316 (cons method-or-server
4317 (member server gnus-agent-covered-methods)))))
4318 (cdr gnus-agent-method-p-cache))
4320 (defun gnus-online (method)
4321 (not
4322 (if gnus-plugged
4323 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4324 (gnus-agent-method-p method))))
4326 ;;; User-level commands.
4328 ;;;###autoload
4329 (defun gnus-slave-no-server (&optional arg)
4330 "Read network news as a slave, without connecting to the local server."
4331 (interactive "P")
4332 (gnus-no-server arg t))
4334 ;;;###autoload
4335 (defun gnus-no-server (&optional arg slave)
4336 "Read network news.
4337 If ARG is a positive number, Gnus will use that as the startup
4338 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4339 non-nil and not a positive number, Gnus will prompt the user for the
4340 name of an NNTP server to use.
4341 As opposed to `gnus', this command will not connect to the local
4342 server."
4343 (interactive "P")
4344 (gnus-no-server-1 arg slave))
4346 ;;;###autoload
4347 (defun gnus-slave (&optional arg)
4348 "Read news as a slave."
4349 (interactive "P")
4350 (gnus arg nil 'slave))
4352 (defun gnus-delete-gnus-frame ()
4353 "Delete gnus frame unless it is the only one.
4354 Used for `gnus-exit-gnus-hook' in `gnus-other-frame'."
4355 (when (and (frame-live-p gnus-other-frame-object)
4356 (cdr (frame-list)))
4357 (delete-frame gnus-other-frame-object))
4358 (setq gnus-other-frame-object nil))
4360 ;;;###autoload
4361 (defun gnus-other-frame (&optional arg display)
4362 "Pop up a frame to read news.
4363 This will call one of the Gnus commands which is specified by the user
4364 option `gnus-other-frame-function' (default `gnus') with the argument
4365 ARG if Gnus is not running, otherwise pop up a Gnus frame and run the
4366 command specified by `gnus-other-frame-resume-function'.
4367 The optional second argument DISPLAY should be a standard display string
4369 omitted or the function `make-frame-on-display' is not available, the
4370 current display is used."
4371 (interactive "P")
4372 (if (fboundp 'make-frame-on-display)
4373 (unless display
4374 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4375 (setq display nil))
4376 (let ((alive (gnus-alive-p)))
4377 (unless (and alive
4378 (catch 'found
4379 (walk-windows
4380 (lambda (window)
4381 (when (and (or (not display)
4382 (equal display
4383 (gnus-frame-or-window-display-name
4384 window)))
4385 (with-current-buffer (window-buffer window)
4387 (symbol-name major-mode))))
4388 (gnus-select-frame-set-input-focus
4389 (setq gnus-other-frame-object (window-frame window)))
4390 (select-window window)
4391 (throw 'found t)))
4392 'ignore t)))
4393 (gnus-select-frame-set-input-focus
4394 (setq gnus-other-frame-object
4395 (if display
4396 (make-frame-on-display display gnus-other-frame-parameters)
4397 (make-frame gnus-other-frame-parameters))))
4398 (if alive
4399 (progn (switch-to-buffer gnus-group-buffer)
4400 (funcall gnus-other-frame-resume-function arg))
4401 (funcall gnus-other-frame-function arg)
4402 (add-hook 'gnus-exit-gnus-hook 'gnus-delete-gnus-frame)
4403 ;; One might argue that `gnus-delete-gnus-frame' should not be called
4404 ;; from `gnus-suspend-gnus-hook', but, on the other hand, one might
4405 ;; argue that it should. No matter what you think, for the sake of
4406 ;; those who want it to be called from it, please keep (defun
4407 ;; gnus-delete-gnus-frame) even if you remove the next `add-hook'.
4408 (add-hook 'gnus-suspend-gnus-hook 'gnus-delete-gnus-frame)))))
4410 ;;;###autoload
4411 (defun gnus (&optional arg dont-connect slave)
4412 "Read network news.
4413 If ARG is non-nil and a positive number, Gnus will use that as the
4414 startup level. If ARG is non-nil and not a positive number, Gnus will
4415 prompt the user for the name of an NNTP server to use."
4416 (interactive "P")
4417 ;; When using the development version of Gnus, load the gnus-load
4418 ;; file.
4419 (unless (string-match "^Gnus" gnus-version)
4420 (load "gnus-load" nil t))
4421 (unless (byte-code-function-p (symbol-function 'gnus))
4422 (message "You should byte-compile Gnus")
4423 (sit-for 2))
4424 (let ((gnus-action-message-log (list nil)))
4425 (gnus-1 arg dont-connect slave)
4426 (gnus-final-warning)))
4428 (declare-function debbugs-gnu "ext:debbugs-gnu"
4429 (severities &optional packages archivedp suppress tags))
4431 (defun gnus-list-debbugs ()
4432 "List all open Gnus bug reports."
4433 (interactive)
4434 (require 'debbugs-gnu)
4435 (debbugs-gnu nil "gnus"))
4437 ;; Allow redefinition of Gnus functions.
4439 (gnus-ems-redefine)
4441 (provide 'gnus)
4443 ;;; gnus.el ends here