| blob | 5d2ce7ee19f0310a482cca1ace462df0c21f40c7 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2016 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
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."
1650 "Recomputes the select-method widget based on the value of
1651 `gnus-valid-select-methods'."
1653 "Widget for entering a select method."
1660 gnus-valid-select-methods)
1664 :inline t
1666 variable
1672 "List of buffers that should update their mode lines.
1673 The list may contain the symbols `group', `article', `tree' and
1674 `summary'. If the corresponding symbol is present, Gnus will keep
1675 that mode line updated with information that may be pertinent.
1676 If this variable is nil, screen refresh may be quicker."
1684 "*Max length of mode-line non-string contents.
1685 If this is nil, Gnus will take space as is needed, leaving the rest
1686 of the mode line intact."
1690 integer))
1692 ;; There should be special validation for this.
1697 to-address
1698 :function-document
1699 "Return GROUP's to-address."
1700 :variable-document
1701 "*Alist of group regexps and correspondent to-addresses."
1702 :variable-group gnus-group-parameter
1705 This will be used when doing followups and posts.
1707 This is primarily useful in mail groups that represent closed
1708 mailing lists--mailing lists where it's expected that everybody that
1709 writes to the mailing list is subscribed to it. Since using this
1710 parameter ensures that the mail only goes to the mailing list itself,
1711 it means that members won't receive two copies of your followups.
1713 Using `to-address' will actually work whether the group is foreign or
1714 not. Let's say there's a group on the server that is called
1715 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1716 articles from a mail-to-news gateway. Posting directly to this group
1717 is therefore impossible--you have to send mail to the mailing list
1718 address instead.
1720 The gnus-group-split mail splitting mechanism will behave as if this
1724 to-list
1725 :function-document
1726 "Return GROUP's to-list."
1727 :variable-document
1728 "*Alist of group regexps and correspondent to-lists."
1729 :variable-group gnus-group-parameter
1732 This address will be used when doing a `a' in the group.
1734 It is totally ignored when doing a followup--except that if it is
1735 present in a news group, you'll get mail group semantics when doing
1736 `f'.
1738 The gnus-group-split mail splitting mechanism will behave as if this
1742 subscribed
1743 :type bool
1744 :function-document
1745 "Return GROUP's subscription status."
1746 :variable-document
1747 "*Groups which are automatically considered subscribed."
1748 :variable-group gnus-group-parameter
1751 Gnus assumed that you are subscribed to the To/List address.
1753 When constructing a list of subscribed groups using
1754 `gnus-find-subscribed-addresses', Gnus includes the To address given
1758 auto-expire
1759 :type bool
1760 :function gnus-group-auto-expirable-p
1761 :function-document
1762 "Check whether GROUP is auto-expirable or not."
1763 :variable gnus-auto-expirable-newsgroups
1764 :variable-default nil
1765 :variable-document
1766 "*Groups in which to automatically mark read articles as expirable.
1767 If non-nil, this should be a regexp that should match all groups in
1768 which to perform auto-expiry. This only makes sense for mail groups."
1769 :variable-group nnmail-expire
1771 regexp)
1773 :parameter-document
1777 total-expire
1778 :type bool
1779 :function gnus-group-total-expirable-p
1780 :function-document
1781 "Check whether GROUP is total-expirable or not."
1782 :variable gnus-total-expirable-newsgroups
1783 :variable-default nil
1784 :variable-document
1785 "*Groups in which to perform expiry of all read articles.
1786 Use with extreme caution. All groups that match this regexp will be
1787 expiring - which means that all read articles will be deleted after
1788 \(say) one week. (This only goes for mail groups and the like, of
1789 course.)"
1790 :variable-group nnmail-expire
1792 regexp)
1794 :parameter-document
1795 "All read articles will be put through the expiry process
1797 This happens even if they are not marked as expirable.
1801 charset
1802 :function-document
1803 "Return the default charset of GROUP."
1804 :variable gnus-group-charset-alist
1805 :variable-default
1818 :variable-document
1819 "Alist of regexps (to match group names) and default charsets to be used when reading."
1820 :variable-group gnus-charset
1828 post-method
1829 :type list
1830 :function-document
1831 "Return a posting method for GROUP."
1832 :variable gnus-post-method-alist
1833 :variable-document
1834 "Alist of regexps (to match group names) and method to be used when
1835 posting an article."
1836 :variable-group gnus-group-foreign
1837 :parameter-type
1845 :parameter-document
1849 large-newsgroup-initial
1850 :type integer
1851 :function-document
1852 "Return GROUP's initial input of the number of articles."
1853 :variable-document
1854 "*Alist of group regexps and its initial input of the number of articles."
1855 :variable-group gnus-group-parameter
1861 This number will be prompted as the initial value of the number of
1862 articles to list when the group is a large newsgroup (see
1863 `gnus-large-newsgroup'). If it is nil, the default value is the
1866 ;; The Gnus registry's ignored groups
1868 registry-ignore
1869 :type list
1870 :function-document
1871 "Whether this group should be ignored by the registry."
1872 :variable gnus-registry-ignored-groups
1877 :variable-document
1878 "*Groups in which the registry should be turned off."
1879 :variable-group gnus-registry
1886 :parameter-document
1889 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1891 "*Disable the group parameters for spam detection.
1892 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1899 "Spam group classification (requires spam.el).
1900 This group contains spam messages. On summary entry, unread messages
1901 will be marked as spam. On summary exit, the specified spam
1902 processors will be invoked on spam-marked messages, then those
1903 messages will be expired, so the spam processor will only see a
1907 "The ham value for the spam group parameter (requires spam.el).
1908 On summary exit, the specified ham processors will be invoked on
1909 ham-marked messages. Exercise caution, since the ham processor will
1910 see the same message more than once because there is no ham message
1914 spam-contents
1915 :type list
1916 :function-document
1917 "The spam type (spam, ham, or neither) of the group."
1918 :variable gnus-spam-newsgroup-contents
1919 :variable-default nil
1920 :variable-document
1921 "*Group classification (spam, ham, or neither). Only
1922 meaningful when spam.el is loaded. If non-nil, this should be a
1923 list of group name regexps associated with a classification for
1924 each one. In spam groups, new articles are marked as spam on
1925 summary entry. There is other behavior associated with ham and
1926 no classification when spam.el is loaded - see the manual."
1927 :variable-group spam
1941 :parameter-document
1942 "The spam classification (spam, ham, or neither) of this group.
1943 When a spam group is entered, all unread articles are marked as
1944 spam. There is other behavior associated with ham and no
1948 spam-resend-to
1949 :type list
1950 :function-document
1951 "The address to get spam resent (through spam-report-resend)."
1952 :variable gnus-spam-resend-to
1953 :variable-default nil
1954 :variable-document
1955 "The address to get spam resent (through spam-report-resend)."
1956 :variable-group spam
1960 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1961 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1962 :parameter-document
1966 ham-resend-to
1967 :type list
1968 :function-document
1969 "The address to get ham resent (through spam-report-resend)."
1970 :variable gnus-ham-resend-to
1971 :variable-default nil
1972 :variable-document
1973 "The address to get ham resent (through spam-report-resend)."
1974 :variable-group spam
1978 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1979 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1980 :parameter-document
1996 "OBSOLETE: The Gmane reporting summary exit spam processor.
2003 "OBSOLETE: The ifile summary exit ham processor.
2007 "OBSOLETE: The Bogofilter summary exit ham processor.
2011 "OBSOLETE: The spam-stat summary exit ham processor.
2015 "OBSOLETE: The whitelist summary exit ham processor.
2019 "OBSOLETE: The BBDB summary exit ham processor.
2023 "OBSOLETE: The ham copy exit ham processor.
2027 "OBSOLETE: The spamoracle summary exit ham processor.
2031 spam-process
2032 :type list
2033 :parameter-type
2036 :value nil
2073 :function-document
2074 "Which spam or ham processors will be applied when the summary is exited."
2075 :variable gnus-spam-process-newsgroups
2076 :variable-default nil
2077 :variable-document
2078 "*Groups in which to automatically process spam or ham articles with
2079 a backend on summary exit. If non-nil, this should be a list of group
2080 name regexps that should match all groups in which to do automatic
2081 spam processing, associated with the appropriate processor."
2082 :variable-group spam
2083 :variable-type
2124 :parameter-document
2128 spam-autodetect
2129 :type list
2130 :parameter-type
2132 :function-document
2133 "Should spam be autodetected (with spam-split) in this group?"
2134 :variable gnus-spam-autodetect
2135 :variable-default nil
2136 :variable-document
2137 "*Groups in which spam should be autodetected when they are entered.
2138 Only unseen articles will be examined, unless
2139 spam-autodetect-recheck-messages is set."
2140 :variable-group spam
2141 :variable-type
2146 boolean))
2147 :parameter-document
2148 "Spam autodetection.
2149 Only unseen articles will be examined, unless
2153 spam-autodetect-methods
2154 :type list
2155 :parameter-type
2178 :function-document
2179 "Methods to be used for autodetection in each group"
2180 :variable gnus-spam-autodetect-methods
2181 :variable-default nil
2182 :variable-document
2183 "*Methods for autodetecting spam per group.
2184 Requires the spam-autodetect parameter. Only unseen articles
2185 will be examined, unless spam-autodetect-recheck-messages is
2186 set."
2187 :variable-group spam
2188 :variable-type
2215 :parameter-document
2216 "Spam autodetection methods.
2217 Requires the spam-autodetect parameter. Only unseen articles
2218 will be examined, unless spam-autodetect-recheck-messages is
2222 spam-process-destination
2223 :type list
2224 :parameter-type
2230 :function-document
2231 "Where spam-processed articles will go at summary exit."
2232 :variable gnus-spam-process-destinations
2233 :variable-default nil
2234 :variable-document
2235 "*Groups in which to explicitly send spam-processed articles to
2236 another group, or expire them (the default). If non-nil, this should
2237 be a list of group name regexps that should match all groups in which
2238 to do spam-processed article moving, associated with the destination
2239 group or nil for explicit expiration. This only makes sense for
2240 mail groups."
2241 :variable-group spam
2242 :variable-type
2253 :parameter-document
2257 ham-process-destination
2258 :type list
2259 :parameter-type
2267 :function-document
2268 "Where ham articles will go at summary exit from a spam group."
2269 :variable gnus-ham-process-destinations
2270 :variable-default nil
2271 :variable-document
2272 "*Groups in which to explicitly send ham articles to
2273 another group, or do nothing (the default). If non-nil, this should
2274 be a list of group name regexps that should match all groups in which
2275 to do ham article moving, associated with the destination
2276 group or nil for explicit ignoring. This only makes sense for
2277 mail groups, and only works in spam groups."
2278 :variable-group spam
2279 :variable-type
2291 :parameter-document
2295 ham-marks
2306 :parameter-document
2307 "Marks considered ham (positively not spam). Such articles will be
2308 processed as ham (non-spam) on group exit. When nil, the global
2309 spam-ham-marks variable takes precedence."
2311 gnus-read-mark
2312 gnus-killed-mark
2313 gnus-kill-file-mark
2314 gnus-low-score-mark))))
2315 :variable-group spam
2316 :variable-document
2320 spam-marks
2329 :parameter-document
2330 "Marks considered spam.
2331 Such articles will be processed as spam on group exit. When nil, the global
2332 spam-spam-marks variable takes precedence."
2334 :variable-group spam
2335 :variable-document
2339 "Number of group name elements to leave alone when making a short group name."
2344 "*If non-nil, once you set a level, Gnus will use this level."
2348 ;; Hooks.
2351 "A hook run while Gnus is loaded."
2356 "A hook called to apply kill files to a group.
2357 This hook is intended to apply a kill file to the selected newsgroup.
2358 The function `gnus-apply-kill-file' is called by default.
2360 Since a general kill file is too heavy to use only for a few
2361 newsgroups, I recommend you to use a lighter hook function. For
2362 example, if you'd like to apply a kill file to articles which contains
2363 a string `rmgroup' in subject in newsgroup `control', you can use the
2364 following hook:
2366 (setq gnus-apply-kill-hook
2367 (list
2368 (lambda ()
2377 "Function run when a group level is changed.
2378 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2381 function))
2383 ;;; Face thingies.
2387 mouse-face
2388 summary-menu group-menu article-menu
2389 tree-highlight menu highlight
2390 browse-menu server-menu
2391 page-marker tree-menu binary-menu pick-menu)
2392 "*Enable visual features.
2393 If `visual' is disabled, there will be no menus and few faces. Most of
2394 the visual customization options below will be ignored. Gnus will use
2395 less space and be faster as a result.
2397 This variable can also be a list of visual elements to switch on. For
2398 instance, to switch off all visual things except menus, you can say:
2402 Valid elements include `summary-highlight', `group-highlight',
2403 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2404 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2405 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2425 ;; Byte-compiler warning.
2427 ;; Find out whether the gnus-visual TYPE is wanted.
2431 gnus-visual
2435 t))))
2445 "*Face used for group or summary buffer mouse highlighting.
2446 The line beneath the mouse pointer will be highlighted with this
2447 face."
2460 "Controls use of the agent cache while plugged.
2461 When set, Gnus will prefer using the locally stored content rather
2462 than re-fetching it from the server. You also need to enable
2463 `gnus-agent' for this to have any affect."
2469 "Default charset assumed to be used when viewing non-ASCII characters.
2470 This variable is overridden on a group-to-group basis by the
2471 `gnus-group-charset-alist' variable and is only used on groups not
2472 covered by that variable."
2476 ;; Fixme: Doc reference to agent.
2478 "Whether we want to use the Gnus agent or not.
2480 You may customize gnus-agent to disable its use. However, some
2481 back ends have started to use the agent as a client-side cache.
2482 Disabling the agent may result in noticeable loss of performance."
2488 "Function called by the command `gnus-other-frame' when starting Gnus."
2496 "Function called by the command `gnus-other-frame' when resuming Gnus."
2506 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2507 This should be an alist for Emacs, or a plist for XEmacs."
2518 "Which information should be exposed in the User-Agent header.
2520 Can be a list of symbols or a string. Valid symbols are `gnus'
2521 \(show Gnus version) and `emacs' \(show Emacs version). In
2522 addition to the Emacs version, you can add `codename' \(show
2523 \(S)XEmacs codename) or either `config' \(show system
2524 configuration) or `type' \(show system type). If you set it to
2525 a string, be sure to use a valid format, see RFC 2616."
2538 ;; Convert old (< 2005-01-10) symbol type values:
2557 \f
2558 ;;; Internal variables
2563 ; Reset each time gnus-agent-covered-methods is changed else
2564 ; gnus-agent-method-p may mis-report a methods status.
2565 )
2575 ;; The carpal mode has been removed, but define the variable for
2576 ;; backwards compatibility.
2595 ;; Variable holding the user answers to all method prompts.
2598 ;; Variable holding the user answers to all mail method prompts.
2601 ;; Variable holding the user answers to all group prompts.
2609 "*The directory where cached articles will be stored."
2615 nnspool "cache"
2640 ;; Propagate flags to server, with the following exceptions:
2641 ;; `seen' is private to each gnus installation
2642 ;; `cache' is a internal gnus flag for each gnus installation
2643 ;; `download' is a agent flag private to each gnus installation
2644 ;; `unsend' are for nndraft groups only
2645 ;; `score' is not a proper mark
2646 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2649 "Marks that shouldn't be propagated to back ends.
2650 Typical marks are those that make no sense in a standalone back end,
2651 such as a mark that says whether an article is stored in the cache
2664 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
2668 "gnus"
2692 gnus-newsrc-last-checked-date
2693 gnus-newsrc-alist gnus-server-alist
2694 gnus-killed-list gnus-zombie-list
2695 gnus-topic-topology gnus-topic-alist
2696 gnus-cloud-sequence
2697 gnus-cloud-covered-servers
2698 gnus-cloud-file-timestamps)
2702 "Assoc list of read articles.
2706 "Assoc list of registry data.
2733 ;; Save window configuration.
2746 ;;; End of variables.
2748 ;; Define some autoload functions Gnus might use.
2751 ;; This little mapcar goes through the list below and marks the
2752 ;; symbols in question as autoloaded functions.
2772 message-send-and-exit message-yank-original)
2776 ;; This is only used in message.el, which has an autoload.
2778 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2780 ;; Next two only used in gnus-util.
2781 rmail-summary-exists rmail-select-summary)
2782 ;; Only used in gnus-util, which has an autoload.
2787 gnus-Folder-save-name gnus-folder-save-name)
2790 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2791 gnus-demon-add-disconnection gnus-demon-add-handler
2792 gnus-demon-remove-handler)
2794 gnus-demon-init gnus-demon-cancel)
2796 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2797 gnus-face-from-file)
2799 gnus-tree-open gnus-tree-close)
2801 gnus-server-server-name)
2804 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2805 gnus-article-hide-citation gnus-article-fill-cited-article
2806 gnus-article-hide-citation-in-followups
2807 gnus-article-fill-cited-long-lines)
2809 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2810 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2812 gnus-registry-handle-action)
2814 gnus-cache-possibly-remove-articles gnus-cache-request-article
2815 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2816 gnus-cache-enter-remove-article gnus-cached-article-p
2817 gnus-cache-open gnus-cache-close gnus-cache-update-article
2818 gnus-cache-articles-in-group)
2820 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2822 gnus-summary-increase-score gnus-summary-set-score
2823 gnus-summary-raise-thread gnus-summary-raise-same-subject
2824 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2825 gnus-summary-lower-thread gnus-summary-lower-same-subject
2826 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2827 gnus-summary-current-score gnus-score-delta-default
2828 gnus-score-flush-cache gnus-score-close
2829 gnus-possibly-score-headers gnus-score-followup-article
2830 gnus-score-followup-thread)
2833 gnus-current-score-file-nondirectory gnus-score-adaptive
2834 gnus-score-find-trace gnus-score-file-name)
2838 gnus-subscribe-topics)
2842 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2843 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2844 gnus-uu-mark-by-regexp gnus-uu-mark-all
2845 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2846 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2847 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2848 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2849 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2850 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2851 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2852 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2855 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2857 gnus-group-post-news gnus-group-mail gnus-group-news
2858 gnus-summary-post-news gnus-summary-news-other-window
2859 gnus-summary-followup gnus-summary-followup-with-original
2860 gnus-summary-cancel-article gnus-summary-supersede-article
2861 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2862 gnus-summary-mail-forward gnus-summary-mail-other-window
2863 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2864 gnus-summary-wide-reply gnus-summary-followup-to-mail
2865 gnus-summary-followup-to-mail-with-original gnus-bug
2866 gnus-summary-wide-reply-with-original
2867 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2868 gnus-summary-post-forward)
2873 gnus-list-of-unread-articles gnus-list-of-read-articles
2874 gnus-offer-save-summaries gnus-make-thread-indent-array
2875 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2876 gnus-summary-skip-intangible gnus-summary-article-number
2877 gnus-data-header gnus-data-find)
2879 gnus-group-list-groups gnus-group-first-unread-group
2880 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2881 gnus-group-setup-buffer gnus-group-get-new-news
2882 gnus-group-make-help-group gnus-group-update-group
2883 gnus-group-iterate gnus-group-group-name)
2885 gnus-backlog-remove-article)
2887 gnus-article-prepare gnus-article-set-window-start
2888 gnus-article-next-page gnus-article-prev-page
2889 gnus-request-article-this-buffer gnus-article-mode
2890 gnus-article-setup-buffer gnus-narrow-to-page
2891 gnus-article-delete-invisible-text gnus-treat-article)
2893 gnus-article-hide-headers gnus-article-hide-boring-headers
2894 gnus-article-treat-overstrike
2895 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2896 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2897 gnus-article-de-base64-unreadable
2898 gnus-article-decode-HZ
2899 gnus-article-wash-html
2900 gnus-article-unsplit-urls
2901 gnus-article-hide-pem gnus-article-hide-signature
2902 gnus-article-strip-leading-blank-lines gnus-article-date-local
2903 gnus-article-date-original gnus-article-date-lapsed
2904 ;;gnus-article-show-all-headers
2905 gnus-article-edit-mode gnus-article-edit-article
2906 gnus-article-edit-done gnus-article-decode-encoded-words
2907 gnus-start-date-timer gnus-stop-date-timer
2908 gnus-mime-view-all-parts)
2911 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2912 gnus-check-reasonable-setup)
2914 gnus-dup-enter-articles)
2920 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2921 gnus-async-halt-prefetch)
2923 gnus-agent-save-active gnus-agent-method-p
2924 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2925 gnus-summary-set-agent-mark gnus-agent-save-group-info
2926 gnus-agent-request-article gnus-agent-retrieve-headers
2927 gnus-agent-store-article gnus-agent-group-covered-p)
2929 gnus-unplugged gnus-agentize gnus-agent-batch)
2931 gnus-summary-save-article-vm)
2936 gnus-group-split-update)
2939 ;;; gnus-sum.el thingies
2943 "*The format specification of the lines in the summary buffer.
2945 It works along the same lines as a normal formatting string,
2946 with some simple extensions.
2948 %N Article number, left padded with spaces (string)
2949 %S Subject (string)
2951 otherwise (string)
2952 %n Name of the poster (string)
2953 %a Extracted name of the poster (string)
2954 %A Extracted address of the poster (string)
2955 %F Contents of the From: header (string)
2956 %f Contents of the From: or To: headers (string)
2957 %x Contents of the Xref: header (string)
2958 %D Date of the article (string)
2959 %d Date of the article (string) in DD-MMM format
2960 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2961 format
2962 %M Message-id of the article (string)
2963 %r References of the article (string)
2964 %c Number of characters in the article (integer)
2965 %k Pretty-printed version of the above (string)
2967 %L Number of lines in the article (integer)
2968 %I Indentation based on thread level (a string of
2969 spaces)
2970 %B A complex trn-style thread tree (string)
2971 The variables `gnus-sum-thread-*' can be used for
2972 customization.
2973 %T A string with two possible values: 80 spaces if the
2974 article is on thread level two or larger and 0 spaces
2975 on level one
2977 otherwise (character)
2979 See Info node `(gnus)Marking Articles'
2982 %> Spaces of length thread-level (string)
2983 %< Spaces of length (- 20 thread-level) (string)
2984 %i Article score (number)
2985 %z Article zcore (character)
2986 %t Number of articles under the current thread (number).
2987 %e Whether the thread is empty or not (character).
2988 %V Total thread score (number).
2989 %P The line number (number).
2990 %O Download mark (character).
2991 %* If present, indicates desired cursor position
2992 (instead of after first colon).
2993 %u User defined specifier. The next character in the
2994 format string should be a letter. Gnus will call the
2995 function gnus-user-format-function-X, where X is the
2996 letter following %u. The function will be passed the
2997 current header as argument. The function should
2998 return a string, which will be inserted into the
2999 summary just like information from any other summary
3000 specifier.
3001 &user-date; Age sensitive date format. Various date format is
3002 defined in `gnus-user-date-format-alist'.
3005 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3006 with care. For reasons of efficiency, Gnus will compute what column
3008 it is invalid to have these specs after a variable-length spec. Well,
3009 you might not be arrested, but your summary buffer will look strange,
3010 which is bad enough.
3012 The smart choice is to have these specs as far to the left as
3013 possible.
3015 This restriction may disappear in later versions of Gnus.
3017 General format specifiers can also be used.
3018 See Info node `(gnus)Formatting Variables'."
3023 ;;;
3024 ;;; Skeleton keymaps
3025 ;;;
3030 (while keys
3031 (define-key keymap (pop keys) 'undefined))))
3033 (defvar gnus-article-mode-map
3034 (let ((keymap (make-sparse-keymap)))
3035 (gnus-suppress-keymap keymap)
3036 keymap))
3037 (defvar gnus-summary-mode-map
3038 (let ((keymap (make-keymap)))
3039 (gnus-suppress-keymap keymap)
3040 keymap))
3041 (defvar gnus-group-mode-map
3042 (let ((keymap (make-keymap)))
3043 (gnus-suppress-keymap keymap)
3044 keymap))
3046 \f
3048 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3049 ;; If you want the cursor to go somewhere else, set these two
3050 ;; functions in some startup hook to whatever you want.
3051 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3052 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3054 ;;; Various macros and substs.
3056 (defun gnus-header-from (header)
3057 (mail-header-from header))
3059 (defmacro gnus-gethash (string hashtable)
3060 "Get hash value of STRING in HASHTABLE."
3061 `(symbol-value (intern-soft ,string ,hashtable)))
3063 (defmacro gnus-gethash-safe (string hashtable)
3064 "Get hash value of STRING in HASHTABLE.
3065 Return nil if not defined."
3066 `(let ((sym (intern-soft ,string ,hashtable)))
3067 (and (boundp sym) (symbol-value sym))))
3069 (defmacro gnus-sethash (string value hashtable)
3070 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3071 `(set (intern ,string ,hashtable) ,value))
3072 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3074 (defmacro gnus-group-unread (group)
3075 "Get the currently computed number of unread articles in GROUP."
3076 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3078 (defmacro gnus-group-entry (group)
3079 "Get the newsrc entry for GROUP."
3080 `(gnus-gethash ,group gnus-newsrc-hashtb))
3082 (defmacro gnus-active (group)
3083 "Get active info on GROUP."
3084 `(gnus-gethash ,group gnus-active-hashtb))
3086 (defmacro gnus-set-active (group active)
3087 "Set GROUP's active info."
3088 `(gnus-sethash ,group ,active gnus-active-hashtb))
3090 ;; Info access macros.
3092 (defmacro gnus-info-group (info)
3093 `(nth 0 ,info))
3094 (defmacro gnus-info-rank (info)
3095 `(nth 1 ,info))
3096 (defmacro gnus-info-read (info)
3097 `(nth 2 ,info))
3098 (defmacro gnus-info-marks (info)
3099 `(nth 3 ,info))
3100 (defmacro gnus-info-method (info)
3101 `(nth 4 ,info))
3102 (defmacro gnus-info-params (info)
3103 `(nth 5 ,info))
3105 (defmacro gnus-info-level (info)
3106 `(let ((rank (gnus-info-rank ,info)))
3107 (if (consp rank)
3108 (car rank)
3109 rank)))
3110 (defmacro gnus-info-score (info)
3111 `(let ((rank (gnus-info-rank ,info)))
3112 (or (and (consp rank) (cdr rank)) 0)))
3114 (defmacro gnus-info-set-group (info group)
3115 `(setcar ,info ,group))
3116 (defmacro gnus-info-set-rank (info rank)
3117 `(setcar (nthcdr 1 ,info) ,rank))
3118 (defmacro gnus-info-set-read (info read)
3119 `(setcar (nthcdr 2 ,info) ,read))
3120 (defmacro gnus-info-set-marks (info marks &optional extend)
3121 (if extend
3122 `(gnus-info-set-entry ,info ,marks 3)
3123 `(setcar (nthcdr 3 ,info) ,marks)))
3124 (defmacro gnus-info-set-method (info method &optional extend)
3125 (if extend
3126 `(gnus-info-set-entry ,info ,method 4)
3127 `(setcar (nthcdr 4 ,info) ,method)))
3128 (defmacro gnus-info-set-params (info params &optional extend)
3129 (if extend
3130 `(gnus-info-set-entry ,info ,params 5)
3131 `(setcar (nthcdr 5 ,info) ,params)))
3133 (defun gnus-info-set-entry (info entry number)
3134 ;; Extend the info until we have enough elements.
3135 (while (<= (length info) number)
3136 (nconc info (list nil)))
3137 ;; Set the entry.
3138 (setcar (nthcdr number info) entry))
3140 (defmacro gnus-info-set-level (info level)
3141 `(let ((rank (cdr ,info)))
3142 (if (consp (car rank))
3143 (setcar (car rank) ,level)
3144 (setcar rank ,level))))
3145 (defmacro gnus-info-set-score (info score)
3146 `(let ((rank (cdr ,info)))
3147 (if (consp (car rank))
3148 (setcdr (car rank) ,score)
3149 (setcar rank (cons (car rank) ,score)))))
3151 (defmacro gnus-get-info (group)
3152 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3154 (defun gnus-set-info (group info)
3155 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3156 info))
3158 ;;; Load the compatibility functions.
3160 (require 'gnus-ems)
3162 \f
3163 ;;;
3164 ;;; Shutdown
3165 ;;;
3167 (defvar gnus-shutdown-alist nil)
3169 (defun gnus-add-shutdown (function &rest symbols)
3170 "Run FUNCTION whenever one of SYMBOLS is shut down."
3171 (push (cons function symbols) gnus-shutdown-alist))
3173 (defun gnus-shutdown (symbol)
3174 "Shut down everything that waits for SYMBOL."
3175 (dolist (entry gnus-shutdown-alist)
3176 (when (memq symbol (cdr entry))
3177 (funcall (car entry)))))
3179 \f
3180 ;;;
3181 ;;; Gnus Utility Functions
3182 ;;;
3184 (defun gnus-find-subscribed-addresses ()
3185 "Return a regexp matching the addresses of all subscribed mail groups.
3186 It consists of the `to-address' or `to-list' parameter of all groups
3187 with a `subscribed' parameter."
3188 (let (group address addresses)
3189 (dolist (entry (cdr gnus-newsrc-alist))
3190 (setq group (car entry))
3191 (when (gnus-parameter-subscribed group)
3192 (setq address (mail-strip-quoted-names
3193 (or (gnus-group-fast-parameter group 'to-address)
3194 (gnus-group-fast-parameter group 'to-list))))
3195 (when address
3196 (add-to-list 'addresses address))))
3197 (when addresses
3200 (defmacro gnus-string-or (&rest strings)
3201 "Return the first element of STRINGS that is a non-blank string.
3202 STRINGS will be evaluated in normal `or' order."
3203 `(gnus-string-or-1 (list ,@strings)))
3205 (defun gnus-string-or-1 (strings)
3206 (let (string)
3207 (while strings
3208 (setq string (pop strings))
3210 (setq string nil)
3211 (setq strings nil)))
3212 string))
3214 (defun gnus-version (&optional arg)
3215 "Version number of this version of Gnus.
3216 If ARG, insert string at point."
3217 (interactive "P")
3218 (if arg
3219 (insert (message gnus-version))
3220 (message gnus-version)))
3222 (defun gnus-continuum-version (&optional version)
3223 "Return VERSION as a floating point number."
3224 (unless version
3225 (setq version gnus-version))
3228 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3229 (number (match-string 2 version))
3230 major minor least)
3231 (unless (string-match
3233 (error "Invalid version string: %s" version))
3234 (setq major (string-to-number (match-string 1 number))
3235 minor (string-to-number (match-string 2 number))
3236 least (if (match-beginning 3)
3237 (string-to-number (match-string 3 number))
3238 0))
3239 (string-to-number
3240 (if (zerop major)
3241 (format "%1.2f00%02d%02d"
3242 (if (member alpha '("(ding)" "d"))
3243 4.99
3244 (+ 5 (* 0.02
3245 (abs
3246 (- (mm-char-int (aref (downcase alpha) 0))
3247 (mm-char-int ?t))))
3248 -0.01))
3249 minor least)
3250 (format "%d.%02d%02d" major minor least))))))
3252 (defun gnus-info-find-node (&optional nodename)
3253 "Find Info documentation of Gnus."
3254 (interactive)
3255 ;; Enlarge info window if needed.
3256 (let (gnus-info-buffer)
3257 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3258 (setq gnus-info-buffer (current-buffer))
3259 (gnus-configure-windows 'info)))
3261 ;;;
3262 ;;; gnus-interactive
3263 ;;;
3265 (defvar gnus-current-prefix-symbol nil
3266 "Current prefix symbol.")
3268 (defvar gnus-current-prefix-symbols nil
3269 "List of current prefix symbols.")
3271 (defun gnus-interactive (string &optional params)
3272 "Return a list that can be fed to `interactive'.
3273 See `interactive' for full documentation.
3275 Adds the following specs:
3277 y -- The current symbolic prefix.
3278 Y -- A list of the current symbolic prefix(es).
3279 A -- Article number.
3280 H -- Article header.
3281 g -- Group name."
3282 (let ((i 0)
3283 out c prompt)
3284 (while (< i (length string))
3286 (setq c (aref string i))
3287 (when (match-end 1)
3288 (setq prompt (match-string 1 string)))
3289 (setq i (match-end 0))
3290 ;; We basically emulate just about everything that
3291 ;; `interactive' does, but add the specs listed above.
3292 (push
3293 (cond
3294 ((= c ?a)
3295 (completing-read prompt obarray 'fboundp t))
3296 ((= c ?b)
3297 (read-buffer prompt (current-buffer) t))
3298 ((= c ?B)
3299 (read-buffer prompt (other-buffer (current-buffer))))
3300 ((= c ?c)
3301 (read-char))
3302 ((= c ?C)
3303 (completing-read prompt obarray 'commandp t))
3304 ((= c ?d)
3305 (point))
3306 ((= c ?D)
3307 (read-directory-name prompt nil default-directory 'lambda))
3308 ((= c ?f)
3309 (read-file-name prompt nil nil 'lambda))
3310 ((= c ?F)
3311 (read-file-name prompt))
3312 ((= c ?k)
3313 (read-key-sequence prompt))
3314 ((= c ?K)
3315 (error "Not implemented spec"))
3316 ((= c ?e)
3317 (error "Not implemented spec"))
3318 ((= c ?m)
3319 (mark))
3320 ((= c ?N)
3321 (error "Not implemented spec"))
3322 ((= c ?n)
3323 (string-to-number (read-from-minibuffer prompt)))
3324 ((= c ?p)
3325 (prefix-numeric-value current-prefix-arg))
3326 ((= c ?P)
3327 current-prefix-arg)
3328 ((= c ?r)
3329 'gnus-prefix-nil)
3330 ((= c ?s)
3331 (read-string prompt))
3332 ((= c ?S)
3333 (intern (read-string prompt)))
3334 ((= c ?v)
3335 (read-variable prompt))
3336 ((= c ?x)
3337 (read-minibuffer prompt))
3338 ((= c ?x)
3339 (eval-minibuffer prompt))
3340 ;; And here the new specs come.
3341 ((= c ?y)
3342 gnus-current-prefix-symbol)
3343 ((= c ?Y)
3344 gnus-current-prefix-symbols)
3345 ((= c ?g)
3346 (gnus-group-group-name))
3347 ((= c ?A)
3348 (gnus-summary-skip-intangible)
3349 (or (get-text-property (point) 'gnus-number)
3350 (gnus-summary-last-subject)))
3351 ((= c ?H)
3352 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3353 (t
3354 (error "Non-implemented spec")))
3355 out)
3356 (cond
3357 ((= c ?r)
3358 (push (if (< (point) (mark)) (point) (mark)) out)
3359 (push (if (> (point) (mark)) (point) (mark)) out))))
3360 (setq out (delq 'gnus-prefix-nil out))
3361 (nreverse out)))
3363 (defun gnus-symbolic-argument (&optional arg)
3364 "Read a symbolic argument and a command, and then execute command."
3365 (interactive "P")
3366 (let* ((in-command (this-command-keys))
3367 (command in-command)
3368 gnus-current-prefix-symbols
3369 gnus-current-prefix-symbol
3370 syms)
3371 (while (equal in-command command)
3372 (message "%s-" (key-description (this-command-keys)))
3373 (push (intern (char-to-string (read-char))) syms)
3374 (setq command (read-key-sequence nil t)))
3375 (setq gnus-current-prefix-symbols (nreverse syms)
3376 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3377 (call-interactively (key-binding command t))))
3379 ;;; More various functions.
3381 (defsubst gnus-check-backend-function (func group)
3382 "Check whether GROUP supports function FUNC.
3383 GROUP can either be a string (a group name) or a select method."
3384 (ignore-errors
3385 (let ((method (if (stringp group)
3386 (car (gnus-find-method-for-group group))
3387 group)))
3388 (unless (featurep method)
3389 (require method))
3390 (fboundp (intern (format "%s-%s" method func))))))
3392 (defun gnus-group-read-only-p (&optional group)
3393 "Check whether GROUP supports editing or not.
3394 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3395 that that variable is buffer-local to the summary buffers."
3396 (let ((group (or group gnus-newsgroup-name)))
3397 (not (gnus-check-backend-function 'request-replace-article group))))
3399 (defun gnus-virtual-group-p (group)
3400 "Say whether GROUP is virtual or not."
3401 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3402 gnus-valid-select-methods)))
3404 (defun gnus-news-group-p (group &optional article)
3405 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3406 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3407 t) ;is news of course.
3408 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3409 nil) ;must be mail then.
3410 ((vectorp article) ;Has header info.
3411 (eq (gnus-request-type group (mail-header-id article)) 'news))
3412 ((null article) ;Hasn't header info
3413 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3414 ((< article 0) ;Virtual message
3415 nil) ;we don't know, guess mail.
3416 (t ;Has positive number
3417 (eq (gnus-request-type group article) 'news)))) ;use it.
3419 ;; Check whether to use long file names.
3420 (defun gnus-use-long-file-name (symbol)
3421 ;; The variable has to be set...
3422 (and gnus-use-long-file-name
3423 ;; If it isn't a list, then we return t.
3424 (or (not (listp gnus-use-long-file-name))
3425 ;; If it is a list, and the list contains `symbol', we
3426 ;; return nil.
3427 (not (memq symbol gnus-use-long-file-name)))))
3429 ;; Generate a unique new group name.
3430 (defun gnus-generate-new-group-name (leaf)
3431 (let ((name leaf)
3432 (num 0))
3433 (while (gnus-group-entry name)
3434 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3435 name))
3437 (defun gnus-ephemeral-group-p (group)
3438 "Say whether GROUP is ephemeral or not."
3439 (gnus-group-get-parameter group 'quit-config t))
3441 (defun gnus-group-quit-config (group)
3442 "Return the quit-config of GROUP."
3443 (gnus-group-get-parameter group 'quit-config t))
3445 (defun gnus-kill-ephemeral-group (group)
3446 "Remove ephemeral GROUP from relevant structures."
3447 (gnus-sethash group nil gnus-newsrc-hashtb))
3449 (defun gnus-simplify-mode-line ()
3450 "Make mode lines a bit simpler."
3451 (setq mode-line-modified (cdr gnus-mode-line-modified))
3452 (when (listp mode-line-format)
3453 (make-local-variable 'mode-line-format)
3454 (setq mode-line-format (copy-sequence mode-line-format))
3455 (when (equal (nth 3 mode-line-format) " ")
3456 (setcar (nthcdr 3 mode-line-format) " "))))
3458 ;;; Servers and groups.
3460 (defsubst gnus-server-add-address (method)
3461 (let ((method-name (symbol-name (car method))))
3462 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3463 (not (assq (intern (concat method-name "-address")) method))
3464 (memq 'physical-address (assq (car method)
3465 gnus-valid-select-methods)))
3466 (append method (list (list (intern (concat method-name "-address"))
3467 (nth 1 method))))
3468 method)))
3470 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3471 (catch 'server-name
3472 (setq method (or method gnus-select-method))
3474 ;; Perhaps it is already in the cache.
3475 (unless nocache
3476 (mapc (lambda (name-method)
3477 (if (equal (cdr name-method) method)
3478 (throw 'server-name (car name-method))))
3479 gnus-server-method-cache))
3481 (mapc
3482 (lambda (server-alist)
3483 (mapc (lambda (name-method)
3484 (when (gnus-methods-equal-p (cdr name-method) method)
3485 (unless (member name-method gnus-server-method-cache)
3486 (push name-method gnus-server-method-cache))
3487 (throw 'server-name (car name-method))))
3488 server-alist))
3489 (list gnus-server-alist
3490 gnus-predefined-server-alist))
3492 (let* ((name (if (member (cadr method) '(nil ""))
3493 (format "%s" (car method))
3494 (format "%s:%s" (car method) (cadr method))))
3495 (name-method (cons name method)))
3496 (when (and (not (member name-method gnus-server-method-cache))
3497 (not no-enter-cache)
3498 (not (assoc (car name-method) gnus-server-method-cache)))
3499 (push name-method gnus-server-method-cache))
3500 name)))
3502 (defsubst gnus-server-to-method (server)
3503 "Map virtual server names to select methods."
3504 (or (and server (listp server) server)
3505 (cdr (assoc server gnus-server-method-cache))
3506 (let ((result
3507 (or
3508 ;; Perhaps this is the native server?
3509 (and (equal server "native") gnus-select-method)
3510 ;; It should be in the server alist.
3511 (cdr (assoc server gnus-server-alist))
3512 ;; It could be in the predefined server alist.
3513 (cdr (assoc server gnus-predefined-server-alist))
3514 ;; If not, we look through all the opened server
3515 ;; to see whether we can find it there.
3516 (let ((opened gnus-opened-servers))
3517 (while (and opened
3518 (not (equal server (format "%s:%s" (caaar opened)
3519 (cadaar opened)))))
3520 (pop opened))
3521 (caar opened))
3522 ;; It could be a named method, search all servers
3523 (let ((servers gnus-secondary-select-methods))
3524 (while (and servers
3525 (not (equal server (format "%s:%s" (caar servers)
3526 (cadar servers)))))
3527 (pop servers))
3528 (car servers))
3529 ;; This could be some sort of foreign server that I
3530 ;; simply haven't opened (yet). Do a brute-force scan
3531 ;; of the entire gnus-newsrc-alist for the server name
3532 ;; of every method. As a side-effect, loads the
3533 ;; gnus-server-method-cache so this only happens once,
3534 ;; if at all.
3535 (let ((alist (cdr gnus-newsrc-alist))
3536 method match)
3537 (while alist
3538 (setq method (gnus-info-method (pop alist)))
3539 (when (and (not (stringp method))
3540 (equal server
3541 (gnus-method-to-server method nil t)))
3542 (setq match method
3543 alist nil)))
3544 match))))
3545 (when (and result
3546 (not (assoc server gnus-server-method-cache)))
3547 (push (cons server result) gnus-server-method-cache))
3548 result)))
3550 (defsubst gnus-server-get-method (group method)
3551 ;; Input either a server name, and extended server name, or a
3552 ;; select method, and return a select method.
3553 (cond ((stringp method)
3554 (gnus-server-to-method method))
3555 ((equal method gnus-select-method)
3556 gnus-select-method)
3557 ((and (stringp (car method))
3558 group)
3559 (gnus-server-extend-method group method))
3560 ((and method
3561 (not group)
3562 (equal (cadr method) ""))
3563 method)
3564 (t
3565 (gnus-server-add-address method))))
3567 (defmacro gnus-method-equal (ss1 ss2)
3568 "Say whether two servers are equal."
3569 `(let ((s1 ,ss1)
3570 (s2 ,ss2))
3571 (or (equal s1 s2)
3572 (and (= (length s1) (length s2))
3573 (progn
3574 (while (and s1 (member (car s1) s2))
3575 (setq s1 (cdr s1)))
3576 (null s1))))))
3578 (defun gnus-methods-equal-p (m1 m2)
3579 (let ((m1 (or m1 gnus-select-method))
3580 (m2 (or m2 gnus-select-method)))
3581 (or (equal m1 m2)
3582 (and (eq (car m1) (car m2))
3583 (or (not (memq 'address (assoc (symbol-name (car m1))
3584 gnus-valid-select-methods)))
3585 (equal (nth 1 m1) (nth 1 m2)))))))
3587 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3588 ;; Check parameters for sloppy equality.
3589 (let ((p1 (copy-sequence (cddr m1)))
3590 (p2 (copy-sequence (cddr m2)))
3591 e1 e2)
3592 (block nil
3593 (while (setq e1 (pop p1))
3594 (unless (setq e2 (assq (car e1) p2))
3595 ;; The parameter doesn't exist in p2.
3596 (return nil))
3597 (setq p2 (delq e2 p2))
3598 (unless (equal e1 e2)
3599 (if (not (and (stringp (cadr e1))
3600 (stringp (cadr e2))))
3601 (return nil)
3602 ;; Special-case string parameter comparison so that we
3603 ;; can uniquify them.
3604 (let ((s1 (cadr e1))
3605 (s2 (cadr e2)))
3606 (when (string-match "/$" s1)
3607 (setq s1 (directory-file-name s1)))
3608 (when (string-match "/$" s2)
3609 (setq s2 (directory-file-name s2)))
3610 (unless (equal s1 s2)
3611 (return nil))))))
3612 ;; If p2 now is empty, they were equal.
3613 (null p2))))
3615 (defun gnus-method-ephemeral-p (method)
3616 (let ((equal nil))
3617 (dolist (ephemeral gnus-ephemeral-servers)
3618 (when (gnus-sloppily-equal-method-parameters method ephemeral)
3619 (setq equal t)))
3620 equal))
3622 (defun gnus-methods-sloppily-equal (m1 m2)
3623 ;; Same method.
3624 (or
3625 (eq m1 m2)
3626 ;; Type and name are equal.
3627 (and
3628 (eq (car m1) (car m2))
3629 (equal (cadr m1) (cadr m2))
3630 (gnus-sloppily-equal-method-parameters m1 m2))))
3632 (defun gnus-server-equal (m1 m2)
3633 "Say whether two methods are equal."
3634 (let ((m1 (cond ((null m1) gnus-select-method)
3635 ((stringp m1) (gnus-server-to-method m1))
3636 (t m1)))
3637 (m2 (cond ((null m2) gnus-select-method)
3638 ((stringp m2) (gnus-server-to-method m2))
3639 (t m2))))
3640 (gnus-method-equal m1 m2)))
3642 (defun gnus-servers-using-backend (backend)
3643 "Return a list of known servers using BACKEND."
3644 (let ((opened gnus-opened-servers)
3645 out)
3646 (while opened
3647 (when (eq backend (caaar opened))
3648 (push (caar opened) out))
3649 (pop opened))
3650 out))
3652 (defun gnus-archive-server-wanted-p ()
3653 "Say whether the user wants to use the archive server."
3654 (cond
3655 ((or (not gnus-message-archive-method)
3656 (not gnus-message-archive-group))
3657 nil)
3658 ((and gnus-message-archive-method gnus-message-archive-group)
3659 t)
3660 (t
3661 (let ((active (cadr (assq 'nnfolder-active-file
3662 gnus-message-archive-method))))
3663 (and active
3664 (file-exists-p active))))))
3666 (defsubst gnus-method-to-server-name (method)
3667 (concat
3668 (format "%s" (car method))
3669 (when (and
3670 (or (assoc (format "%s" (car method))
3671 (gnus-methods-using 'address))
3672 (gnus-server-equal method gnus-message-archive-method))
3673 (nth 1 method)
3674 (not (string= (nth 1 method) "")))
3675 (concat "+" (nth 1 method)))))
3677 (defsubst gnus-method-to-full-server-name (method)
3678 (format "%s+%s" (car method) (nth 1 method)))
3680 (defun gnus-group-prefixed-name (group method &optional full)
3681 "Return the whole name from GROUP and METHOD.
3682 Call with full set to get the fully qualified group name (even if the
3683 server is native)."
3684 (when (stringp method)
3685 (setq method (gnus-server-to-method method)))
3686 (if (or (not method)
3687 (and (not full) (gnus-server-equal method "native"))
3688 ;;;!!! This might not be right. We'll see...
3689 ;(string-match ":" group)
3690 )
3691 group
3692 (concat (gnus-method-to-server-name method) ":" group)))
3694 (defun gnus-group-full-name (group method)
3695 "Return the full name from GROUP and METHOD, even if the method is native."
3696 (gnus-group-prefixed-name group method t))
3698 (defun gnus-group-guess-full-name-from-command-method (group)
3699 "Guess the full name from GROUP, even if the method is native."
3700 (if (gnus-group-prefixed-p group)
3701 group
3702 (gnus-group-full-name group gnus-command-method)))
3704 (defun gnus-group-real-prefix (group)
3705 "Return the prefix of the current group name."
3706 (if (stringp group)
3707 (if (string-match "^[^:]+:" group)
3708 (substring group 0 (match-end 0))
3709 "")
3710 nil))
3712 (defun gnus-group-short-name (group)
3713 "Return the short group name."
3714 (let ((prefix (gnus-group-real-prefix group)))
3715 (if (< 0 (length prefix))
3716 (substring group (length prefix) nil)
3717 group)))
3719 (defun gnus-group-prefixed-p (group)
3720 "Return the prefix of the current group name."
3721 (< 0 (length (gnus-group-real-prefix group))))
3723 (declare-function gnus-group-decoded-name "gnus-group" (string))
3725 (defun gnus-summary-buffer-name (group)
3726 "Return the summary buffer name of GROUP."
3727 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3729 (defun gnus-group-method (group)
3730 "Return the server or method used for selecting GROUP.
3731 You should probably use `gnus-find-method-for-group' instead."
3732 (let ((prefix (gnus-group-real-prefix group)))
3733 (if (equal prefix "")
3734 gnus-select-method
3735 (let ((servers gnus-opened-servers)
3736 (server "")
3737 backend possible found)
3739 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3740 server (substring prefix (match-end 0) (1- (length prefix))))
3741 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3742 (while servers
3743 (when (eq (caaar servers) backend)
3744 (setq possible (caar servers))
3745 (when (equal (cadaar servers) server)
3746 (setq found (caar servers))))
3747 (pop servers))
3748 (or (car (rassoc found gnus-server-alist))
3749 found
3750 (car (rassoc possible gnus-server-alist))
3751 possible
3752 (list backend server))))))
3754 (defsubst gnus-native-method-p (method)
3755 "Return whether METHOD is the native select method."
3756 (gnus-method-equal method gnus-select-method))
3758 (defsubst gnus-secondary-method-p (method)
3759 "Return whether METHOD is a secondary select method."
3760 (let ((methods gnus-secondary-select-methods)
3761 (gmethod (inline (gnus-server-get-method nil method))))
3762 (while (and methods
3763 (not (gnus-method-equal
3764 (inline (gnus-server-get-method nil (car methods)))
3765 gmethod)))
3766 (setq methods (cdr methods)))
3767 methods))
3769 (defun gnus-method-simplify (method)
3770 "Return the shortest uniquely identifying string or method for METHOD."
3771 (cond ((stringp method)
3772 method)
3773 ((gnus-native-method-p method)
3774 nil)
3775 ((gnus-secondary-method-p method)
3776 (format "%s:%s" (nth 0 method) (nth 1 method)))
3777 (t
3778 method)))
3780 (defun gnus-groups-from-server (server)
3781 "Return a list of all groups that are fetched from SERVER."
3782 (let ((alist (cdr gnus-newsrc-alist))
3783 info groups)
3784 (while (setq info (pop alist))
3785 (when (gnus-server-equal (gnus-info-method info) server)
3786 (push (gnus-info-group info) groups)))
3787 (sort groups 'string<)))
3789 (defun gnus-group-foreign-p (group)
3790 "Say whether a group is foreign or not."
3791 (and (not (gnus-group-native-p group))
3792 (not (gnus-group-secondary-p group))))
3794 (defun gnus-group-native-p (group)
3795 "Say whether the group is native or not."
3796 (not (string-match ":" group)))
3798 (defun gnus-group-secondary-p (group)
3799 "Say whether the group is secondary or not."
3800 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3802 (defun gnus-parameters-get-parameter (group)
3803 "Return the group parameters for GROUP from `gnus-parameters'."
3804 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3805 case-fold-search
3806 gnus-parameters-case-fold-search))
3807 params-list)
3808 (dolist (elem gnus-parameters)
3809 (when (string-match (car elem) group)
3810 (setq params-list
3811 (nconc (gnus-expand-group-parameters
3812 (car elem) (cdr elem) group)
3813 params-list))))
3814 params-list))
3816 (defun gnus-expand-group-parameter (match value group)
3817 "Use MATCH to expand VALUE in GROUP."
3818 (let ((start (string-match match group)))
3819 (if start
3820 (let ((matched-string (substring group start (match-end 0))))
3821 ;; Build match groups
3822 (string-match match matched-string)
3823 (replace-match value nil nil matched-string))
3824 group)))
3826 (defun gnus-expand-group-parameters (match parameters group)
3827 "Go through PARAMETERS and expand them according to the match data."
3828 (let (new)
3829 (dolist (elem parameters)
3830 (cond
3831 ((and (stringp (cdr elem))
3833 (push (cons (car elem)
3834 (gnus-expand-group-parameter match (cdr elem) group))
3835 new))
3836 ;; For `sieve' group parameters, perform substitutions for every
3837 ;; string within the match rule. This allows for parameters such
3838 ;; as:
3841 ((eq 'sieve (car elem))
3842 (push (mapcar (lambda (sieve-elem)
3843 (if (and (stringp sieve-elem)
3845 (gnus-expand-group-parameter match sieve-elem
3846 group)
3847 sieve-elem))
3848 (cdr elem))
3849 new))
3850 (t
3851 (push elem new))))
3852 new))
3854 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3855 "For GROUP, return the value of SYMBOL.
3857 You should call this in the `gnus-group-buffer' buffer.
3858 The function `gnus-group-find-parameter' will do that for you."
3859 ;; The speed trick: No cons'ing and quit early.
3860 (let* ((params (funcall gnus-group-get-parameter-function group))
3861 ;; Start easy, check the "real" group parameters.
3862 (simple-results
3863 (gnus-group-parameter-value params symbol allow-list t)))
3864 (if simple-results
3865 ;; Found results; return them.
3866 (car simple-results)
3867 ;; We didn't find it there, try `gnus-parameters'.
3868 (let ((result nil)
3869 (head nil)
3870 (tail gnus-parameters))
3871 ;; A good old-fashioned non-cl loop.
3872 (while tail
3873 (setq head (car tail)
3874 tail (cdr tail))
3875 ;; The car is regexp matching for matching the group name.
3876 (when (string-match (car head) group)
3877 ;; The cdr is the parameters.
3878 (let ((this-result
3879 (gnus-group-parameter-value (cdr head) symbol allow-list t)))
3880 (when this-result
3881 (setq result (car this-result))
3882 ;; Expand if necessary.
3883 (cond
3885 (setq result (gnus-expand-group-parameter
3886 (car head) result group)))
3887 ;; For `sieve' group parameters, perform substitutions
3888 ;; for every string within the match rule (see above).
3889 ((eq symbol 'sieve)
3890 (setq result
3891 (mapcar (lambda (elem)
3892 (if (stringp elem)
3893 (gnus-expand-group-parameter (car head)
3894 elem group)
3895 elem))
3896 result))))))))
3897 ;; Done.
3898 result))))
3900 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3901 "Return the group parameters for GROUP.
3902 If SYMBOL, return the value of that symbol in the group parameters.
3904 If you call this function inside a loop, consider using the faster
3905 `gnus-group-fast-parameter' instead."
3906 (with-current-buffer (if (buffer-live-p (get-buffer gnus-group-buffer))
3907 gnus-group-buffer
3908 (current-buffer))
3909 (if symbol
3910 (gnus-group-fast-parameter group symbol allow-list)
3911 (nconc
3912 (copy-sequence
3913 (funcall gnus-group-get-parameter-function group))
3914 (gnus-parameters-get-parameter group)))))
3916 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3917 "Return the group parameters for GROUP.
3918 If SYMBOL, return the value of that symbol in the group parameters.
3919 If ALLOW-LIST, also allow list as a result.
3920 Most functions should use `gnus-group-find-parameter', which
3921 also examines the topic parameters."
3922 (let ((params (gnus-info-params (gnus-get-info group))))
3923 (if symbol
3924 (gnus-group-parameter-value params symbol allow-list)
3925 params)))
3927 (defun gnus-group-parameter-value (params symbol &optional
3928 allow-list present-p)
3929 "Return the value of SYMBOL in group PARAMS.
3930 If ALLOW-LIST, also allow list as a result."
3931 ;; We only wish to return group parameters (dotted lists) and
3932 ;; not local variables, which may have the same names.
3933 ;; But first we handle single elements...
3934 (or (car (memq symbol params))
3935 ;; Handle alist.
3936 (let (elem)
3937 (catch 'found
3938 (while (setq elem (pop params))
3939 (when (and (consp elem)
3940 (eq (car elem) symbol)
3941 (or allow-list
3942 (atom (cdr elem))))
3943 (throw 'found (if present-p (list (cdr elem))
3944 (cdr elem)))))))))
3946 (defun gnus-group-add-parameter (group param)
3947 "Add parameter PARAM to GROUP."
3948 (let ((info (gnus-get-info group)))
3949 (when info
3950 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3951 ;; Cons the new param to the old one and update.
3952 (gnus-group-set-info (cons param (gnus-info-params info))
3953 group 'params))))
3955 (defun gnus-group-set-parameter (group name value)
3956 "Set parameter NAME to VALUE in GROUP.
3957 GROUP can also be an INFO structure."
3958 (let ((info (if (listp group)
3959 group
3960 (gnus-get-info group))))
3961 (when info
3962 (gnus-group-remove-parameter group name)
3963 (let ((old-params (gnus-info-params info))
3964 (new-params (list (cons name value))))
3965 (while old-params
3966 (when (or (not (listp (car old-params)))
3967 (not (eq (caar old-params) name)))
3968 (setq new-params (append new-params (list (car old-params)))))
3969 (setq old-params (cdr old-params)))
3970 (if (listp group)
3971 (gnus-info-set-params info new-params t)
3972 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3974 (defun gnus-group-remove-parameter (group name)
3975 "Remove parameter NAME from GROUP.
3976 GROUP can also be an INFO structure."
3977 (let ((info (if (listp group)
3978 group
3979 (gnus-get-info group))))
3980 (when info
3981 (let ((params (gnus-info-params info)))
3982 (when params
3983 (setq params (delq name params))
3984 (while (assq name params)
3985 (gnus-alist-pull name params))
3986 (gnus-info-set-params info params))))))
3988 (defun gnus-group-add-score (group &optional score)
3989 "Add SCORE to the GROUP score.
3990 If SCORE is nil, add 1 to the score of GROUP."
3991 (let ((info (gnus-get-info group)))
3992 (when info
3993 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3995 (defun gnus-short-group-name (group &optional levels)
3996 "Collapse GROUP name LEVELS.
3997 Select methods are stripped and any remote host name is stripped down to
3998 just the host name."
3999 (let* ((name "")
4000 (foreign "")
4001 (depth 0)
4002 (skip 1)
4003 (levels (or levels
4004 gnus-group-uncollapsed-levels
4005 (progn
4007 (setq skip (match-end 0)
4008 depth (+ depth 1)))
4009 depth))))
4010 ;; Separate foreign select method from group name and collapse.
4011 ;; If method contains a server, collapse to non-domain server name,
4012 ;; otherwise collapse to select method.
4013 (let* ((colon (string-match ":" group))
4014 (server (and colon (substring group 0 colon)))
4015 (plus (and server (string-match "+" server))))
4016 (when server
4017 (if plus
4018 (setq foreign (substring server (+ 1 plus)
4020 group (substring group (+ 1 colon)))
4021 (setq foreign server
4022 group (substring group (+ 1 colon))))
4023 (setq foreign (concat foreign ":")))
4024 ;; Collapse group name leaving LEVELS uncollapsed elements
4025 (let* ((slist (split-string group "/"))
4026 (slen (length slist))
4028 (dlen (length dlist))
4029 glist
4030 glen
4031 gsep
4032 res)
4033 (if (> slen dlen)
4034 (setq glist slist
4035 glen slen
4036 gsep "/")
4037 (setq glist dlist
4038 glen dlen
4039 gsep "."))
4040 (setq levels (- glen levels))
4041 (dolist (g glist)
4042 (push (if (>= (decf levels) 0)
4043 (if (zerop (length g))
4044 ""
4045 (substring g 0 1))
4046 g)
4047 res))
4048 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4050 (defun gnus-narrow-to-body ()
4051 "Narrow to the body of an article."
4052 (narrow-to-region
4053 (progn
4054 (goto-char (point-min))
4056 (point-max)))
4057 (point-max)))
4059 \f
4060 ;;;
4061 ;;; Kill file handling.
4062 ;;;
4064 (defun gnus-apply-kill-file ()
4065 "Apply a kill file to the current newsgroup.
4066 Returns the number of articles marked as read."
4067 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4068 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4069 (gnus-apply-kill-file-internal)
4070 0))
4072 (defun gnus-kill-save-kill-buffer ()
4073 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4074 (when (get-file-buffer file)
4075 (with-current-buffer (get-file-buffer file)
4076 (when (buffer-modified-p)
4077 (save-buffer))
4078 (kill-buffer (current-buffer))))))
4080 (defcustom gnus-kill-file-name "KILL"
4081 "Suffix of the kill files."
4082 :group 'gnus-score-kill
4083 :group 'gnus-score-files
4084 :type 'string)
4086 (defun gnus-newsgroup-kill-file (newsgroup)
4087 "Return the name of a kill file name for NEWSGROUP.
4088 If NEWSGROUP is nil, return the global kill file name instead."
4089 (cond
4090 ;; The global KILL file is placed at top of the directory.
4091 ((or (null newsgroup)
4092 (string-equal newsgroup ""))
4093 (expand-file-name gnus-kill-file-name
4094 gnus-kill-files-directory))
4095 ;; Append ".KILL" to newsgroup name.
4096 ((gnus-use-long-file-name 'not-kill)
4097 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4098 "." gnus-kill-file-name)
4099 gnus-kill-files-directory))
4100 ;; Place "KILL" under the hierarchical directory.
4101 (t
4102 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4103 "/" gnus-kill-file-name)
4104 gnus-kill-files-directory))))
4106 ;;; Server things.
4108 (defun gnus-member-of-valid (symbol group)
4110 (memq symbol (assoc
4111 (symbol-name (car (gnus-find-method-for-group group)))
4112 gnus-valid-select-methods)))
4114 (defun gnus-method-option-p (method option)
4115 "Return non-nil if select METHOD has OPTION as a parameter."
4116 (when (stringp method)
4117 (setq method (gnus-server-to-method method)))
4118 (memq option (assoc (format "%s" (car method))
4119 gnus-valid-select-methods)))
4121 (defun gnus-similar-server-opened (method)
4122 "Return non-nil if we have a similar server opened.
4123 This is defined as a server with the same name, but different
4124 parameters."
4125 (let ((opened gnus-opened-servers)
4126 open)
4127 (while (and method opened)
4128 (setq open (car (pop opened)))
4129 ;; Type and name are the same...
4130 (when (and (equal (car method) (car open))
4131 (equal (cadr method) (cadr open))
4132 ;; ... but the rest of the parameters differ.
4133 (not (gnus-methods-sloppily-equal method open)))
4134 (setq method nil)))
4135 (not method)))
4137 (defun gnus-server-extend-method (group method)
4138 ;; This function "extends" a virtual server. If the server is
4139 ;; "hello", and the select method is ("hello" (my-var "something"))
4140 ;; in the group "alt.alt", this will result in a new virtual server
4141 ;; called "hello+alt.alt".
4142 (if (or (not (inline (gnus-similar-server-opened method)))
4143 (not (cddr method)))
4144 method
4145 (let ((address-slot
4146 (intern (format "%s-address" (car method)))))
4147 (setq method
4148 (if (assq address-slot (cddr method))
4149 `(,(car method) ,(concat (cadr method) "+" group)
4150 ,@(cddr method))
4151 `(,(car method) ,(concat (cadr method) "+" group)
4152 (,address-slot ,(cadr method))
4153 ,@(cddr method))))
4154 (push method gnus-extended-servers)
4155 method)))
4157 (defun gnus-server-status (method)
4158 "Return the status of METHOD."
4159 (nth 1 (assoc method gnus-opened-servers)))
4161 (defun gnus-group-name-to-method (group)
4162 "Guess a select method based on GROUP."
4163 (if (string-match ":" group)
4164 (let ((server (substring group 0 (match-beginning 0))))
4166 (list (intern (substring server 0 (match-beginning 0)))
4167 (substring server (match-end 0)))
4168 (list (intern server) "")))
4169 gnus-select-method))
4171 (defun gnus-server-string (server)
4172 "Return a readable string that describes SERVER."
4173 (let* ((server (gnus-server-to-method server))
4174 (address (nth 1 server)))
4175 (if (and address
4176 (not (zerop (length address))))
4177 (format "%s using %s" address (car server))
4178 (format "%s" (car server)))))
4180 (defun gnus-same-method-different-name (method)
4181 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4182 (unless (assq slot (cddr method))
4183 (setq method
4184 (append method (list (list slot (nth 1 method)))))))
4185 (let ((methods gnus-extended-servers)
4186 open found)
4187 (while (and (not found)
4188 (setq open (pop methods)))
4189 (when (and (eq (car method) (car open))
4190 (gnus-sloppily-equal-method-parameters method open))
4191 (setq found open)))
4192 found))
4194 (defun gnus-find-method-for-group (group &optional info)
4195 "Find the select method that GROUP uses."
4196 (or gnus-override-method
4197 (and (not group)
4198 gnus-select-method)
4199 (and (not (gnus-group-entry group))
4200 ;; Killed or otherwise unknown group.
4201 (or
4202 ;; If we know a virtual server by that name, return its method.
4203 (gnus-server-to-method (gnus-group-server group))
4204 ;; Guess a new method as last resort.
4205 (gnus-group-name-to-method group)))
4206 (let ((info (or info (gnus-get-info group)))
4207 method)
4208 (if (or (not info)
4209 (not (setq method (gnus-info-method info)))
4210 (equal method "native"))
4211 gnus-select-method
4212 (setq method
4213 (cond ((stringp method)
4214 (inline (gnus-server-to-method method)))
4215 ((stringp (cadr method))
4216 (or
4217 (inline
4218 (gnus-same-method-different-name method))
4219 (inline (gnus-server-extend-method group method))))
4220 (t
4221 method)))
4222 (cond ((equal (cadr method) "")
4223 method)
4224 ((null (cadr method))
4225 (list (car method) ""))
4226 (t
4227 (gnus-server-add-address method)))))))
4229 (defun gnus-methods-using (feature)
4230 "Find all methods that have FEATURE."
4231 (let ((valids gnus-valid-select-methods)
4232 outs)
4233 (while valids
4234 (when (memq feature (car valids))
4235 (push (car valids) outs))
4236 (setq valids (cdr valids)))
4237 outs))
4239 (autoload 'message-y-or-n-p "message" nil nil 'macro)
4241 (defun gnus-read-group (prompt &optional default)
4242 "Prompt the user for a group name.
4243 Disallow invalid group names."
4244 (let ((prefix "")
4245 group)
4246 (while (not group)
4247 (when (string-match
4248 gnus-invalid-group-regexp
4249 (setq group (read-string (concat prefix prompt)
4250 (cons (or default "") 0)
4251 'gnus-group-history)))
4252 (let ((match (match-string 0 group)))
4253 ;; Might be okay (e.g. for nnimap), so ask the user:
4255 (message-y-or-n-p
4256 "Proceed and create group anyway? " t
4259 Usually, it's dangerous to create a group with this name, because it's not
4260 supported by all back ends and servers. On IMAP servers it should work,
4261 though. If you are really sure, you can proceed anyway and create the group.
4263 You may customize the variable `gnus-invalid-group-regexp', which currently is
4267 group nil)))))
4268 group))
4270 (defun gnus-read-method (prompt)
4271 "Prompt the user for a method.
4272 Allow completion over sensible values."
4273 (let* ((open-servers
4274 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4275 gnus-opened-servers))
4276 (valid-methods
4277 (let (methods)
4278 (dolist (method gnus-valid-select-methods)
4279 (if (or (memq 'prompt-address method)
4280 (not (assoc (format "%s:" (car method)) open-servers)))
4281 (push method methods)))
4282 methods))
4283 (servers
4284 (append valid-methods
4285 open-servers
4286 gnus-predefined-server-alist
4287 gnus-server-alist))
4288 (method
4289 (gnus-completing-read
4290 prompt (mapcar 'car servers)
4291 t nil 'gnus-method-history)))
4292 (cond
4293 ((equal method "")
4294 (setq method gnus-select-method))
4295 ((assoc method gnus-valid-select-methods)
4296 (let ((address (if (memq 'prompt-address
4297 (assoc method gnus-valid-select-methods))
4298 (read-string "Address: ")
4299 "")))
4300 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4301 (list (intern method) address))))
4302 ((assoc method servers)
4303 method)
4304 (t
4305 (list (intern method) "")))))
4307 ;;; Agent functions
4309 (defun gnus-agent-method-p (method-or-server)
4310 "Say whether METHOD is covered by the agent."
4311 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4312 (let* ((method (if (stringp method-or-server)
4313 (gnus-server-to-method method-or-server)
4314 method-or-server))
4315 (server (gnus-method-to-server method t)))
4316 (setq gnus-agent-method-p-cache
4317 (cons method-or-server
4318 (member server gnus-agent-covered-methods)))))
4319 (cdr gnus-agent-method-p-cache))
4321 (defun gnus-online (method)
4322 (not
4323 (if gnus-plugged
4324 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4325 (gnus-agent-method-p method))))
4327 ;;; User-level commands.
4329 ;;;###autoload
4330 (defun gnus-slave-no-server (&optional arg)
4331 "Read network news as a slave, without connecting to the local server."
4332 (interactive "P")
4333 (gnus-no-server arg t))
4335 ;;;###autoload
4336 (defun gnus-no-server (&optional arg slave)
4337 "Read network news.
4338 If ARG is a positive number, Gnus will use that as the startup
4339 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4340 non-nil and not a positive number, Gnus will prompt the user for the
4341 name of an NNTP server to use.
4342 As opposed to `gnus', this command will not connect to the local
4343 server."
4344 (interactive "P")
4345 (gnus-no-server-1 arg slave))
4347 ;;;###autoload
4348 (defun gnus-slave (&optional arg)
4349 "Read news as a slave."
4350 (interactive "P")
4351 (gnus arg nil 'slave))
4353 (defun gnus-delete-gnus-frame ()
4354 "Delete gnus frame unless it is the only one.
4355 Used for `gnus-exit-gnus-hook' in `gnus-other-frame'."
4356 (when (and (frame-live-p gnus-other-frame-object)
4357 (cdr (frame-list)))
4358 (delete-frame gnus-other-frame-object))
4359 (setq gnus-other-frame-object nil))
4361 ;;;###autoload
4362 (defun gnus-other-frame (&optional arg display)
4363 "Pop up a frame to read news.
4364 This will call one of the Gnus commands which is specified by the user
4365 option `gnus-other-frame-function' (default `gnus') with the argument
4366 ARG if Gnus is not running, otherwise pop up a Gnus frame and run the
4367 command specified by `gnus-other-frame-resume-function'.
4368 The optional second argument DISPLAY should be a standard display string
4370 omitted or the function `make-frame-on-display' is not available, the
4371 current display is used."
4372 (interactive "P")
4373 (if (fboundp 'make-frame-on-display)
4374 (unless display
4375 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4376 (setq display nil))
4377 (let ((alive (gnus-alive-p)))
4378 (unless (and alive
4379 (catch 'found
4380 (walk-windows
4381 (lambda (window)
4382 (when (and (or (not display)
4383 (equal display
4384 (gnus-frame-or-window-display-name
4385 window)))
4386 (with-current-buffer (window-buffer window)
4388 (symbol-name major-mode))))
4389 (gnus-select-frame-set-input-focus
4390 (setq gnus-other-frame-object (window-frame window)))
4391 (select-window window)
4392 (throw 'found t)))
4393 'ignore t)))
4394 (gnus-select-frame-set-input-focus
4395 (setq gnus-other-frame-object
4396 (if display
4397 (make-frame-on-display display gnus-other-frame-parameters)
4398 (make-frame gnus-other-frame-parameters))))
4399 (if alive
4400 (progn (switch-to-buffer gnus-group-buffer)
4401 (funcall gnus-other-frame-resume-function arg))
4402 (funcall gnus-other-frame-function arg)
4403 (add-hook 'gnus-exit-gnus-hook 'gnus-delete-gnus-frame)
4404 ;; One might argue that `gnus-delete-gnus-frame' should not be called
4405 ;; from `gnus-suspend-gnus-hook', but, on the other hand, one might
4406 ;; argue that it should. No matter what you think, for the sake of
4407 ;; those who want it to be called from it, please keep (defun
4408 ;; gnus-delete-gnus-frame) even if you remove the next `add-hook'.
4409 (add-hook 'gnus-suspend-gnus-hook 'gnus-delete-gnus-frame)))))
4411 ;;;###autoload
4412 (defun gnus (&optional arg dont-connect slave)
4413 "Read network news.
4414 If ARG is non-nil and a positive number, Gnus will use that as the
4415 startup level. If ARG is non-nil and not a positive number, Gnus will
4416 prompt the user for the name of an NNTP server to use."
4417 (interactive "P")
4418 ;; When using the development version of Gnus, load the gnus-load
4419 ;; file.
4420 (unless (string-match "^Gnus" gnus-version)
4421 (load "gnus-load" nil t))
4422 (unless (byte-code-function-p (symbol-function 'gnus))
4423 (message "You should byte-compile Gnus")
4424 (sit-for 2))
4425 (let ((gnus-action-message-log (list nil)))
4426 (gnus-1 arg dont-connect slave)
4427 (gnus-final-warning)))
4429 (declare-function debbugs-gnu "ext:debbugs-gnu"
4430 (severities &optional packages archivedp suppress tags))
4432 (defun gnus-list-debbugs ()
4433 "List all open Gnus bug reports."
4434 (interactive)
4435 (require 'debbugs-gnu)
4436 (debbugs-gnu nil "gnus"))
4438 ;; Allow redefinition of Gnus functions.
4440 (gnus-ems-redefine)
4442 (provide 'gnus)
4444 ;;; gnus.el ends here