| blob | 8741a03b54d8f1c16885f25fbcc6176b85dd5c2e |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2013 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
9 ;; Version: 5.13
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;;; Code:
32 ;; For Emacs <22.2 and XEmacs.
41 ;; These are defined afterwards with gnus-define-group-parameter
55 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
60 "Starting your favorite newsreader."
64 "Dealing with formatting issues."
68 "Group character set issues."
74 "Cache interface."
79 "Article Registry."
83 "Server options at startup."
86 ;; These belong to gnus-group.el.
88 "Group buffers."
93 "Foreign groups."
98 "Automatic subscription of new groups."
102 "Group levels."
107 "Selecting a Group."
112 "Showing slices of the group list."
117 "Sorting the group buffer."
123 "Various group options."
127 ;; These belong to gnus-sum.el.
129 "Summary buffers."
134 "Leaving summary buffers."
139 "Marks used in summary buffers."
144 "Ordering articles according to replies."
149 "Formatting of the summary buffer."
154 "Choosing Articles."
159 "Summary movement commands."
164 "Show pictures of people, domains, and newsgroups."
168 "Mail group commands."
173 "Sorting the summary buffer."
178 "Highlighting and menus in the summary buffer."
184 "Various summary buffer options."
189 "Pick mode in the summary buffer."
195 "Tree display of threads in the summary buffer."
200 ;; Belongs to gnus-uu.el
202 "Viewing extracted files."
206 ;; Belongs to gnus-score.el
208 "Score and kill file handling."
212 "Kill files."
216 "Adaptive score files."
220 "Default values for score files."
224 "Expiring score rules."
228 "Decaying score rules."
232 "Score and kill file names."
237 "Various scoring and killing options."
240 ;; Other
242 "Options controlling the visual fluff."
247 "Offline support for Gnus."
251 "Files used by Gnus."
255 "Auto save file."
260 "Storing Gnus state."
264 "Options related to newsservers and other servers used by Gnus."
268 "Highlighting and menus in the server buffer."
273 "Composing replies and followups in Gnus."
277 "Meta variables controlling major portions of Gnus.
278 In general, modifying these variables does not take effect until Gnus
279 is restarted, and sometimes reloaded."
283 "Other Gnus options."
288 "Exiting Gnus."
293 "Frivolous Gnus extensions."
304 "If non-nil, the startup message will not be displayed.
305 This variable is used before `.gnus.el' is loaded, so it should
306 be set in `.emacs' instead."
335 0 5
344 gnus-mode-line-image-cache)
346 "This is %s, %s."
348 str)
350 line)))
355 ;;(defalias 'gnus-decode-rfc1522 'ignore)
356 )
358 ;; We define these group faces here to avoid the display
359 ;; update forced when creating new faces.
369 ()))
370 "Level 1 newsgroup face."
372 ;; backward-compatibility alias
384 ()))
385 "Level 1 empty newsgroup face."
387 ;; backward-compatibility alias
399 ()))
400 "Level 2 newsgroup face."
402 ;; backward-compatibility alias
414 ()))
415 "Level 2 empty newsgroup face."
417 ;; backward-compatibility alias
429 ()))
430 "Level 3 newsgroup face."
432 ;; backward-compatibility alias
439 ())
442 ())
444 ()))
445 "Level 3 empty newsgroup face."
447 ;; backward-compatibility alias
459 ()))
460 "Level 4 newsgroup face."
462 ;; backward-compatibility alias
469 ())
472 ())
474 ()))
475 "Level 4 empty newsgroup face."
477 ;; backward-compatibility alias
489 ()))
490 "Level 5 newsgroup face."
492 ;; backward-compatibility alias
499 ())
502 ())
504 ()))
505 "Level 5 empty newsgroup face."
507 ;; backward-compatibility alias
519 ()))
520 "Level 6 newsgroup face."
522 ;; backward-compatibility alias
529 ())
532 ())
534 ()))
535 "Level 6 empty newsgroup face."
537 ;; backward-compatibility alias
549 ()))
550 "Low level newsgroup face."
552 ;; backward-compatibility alias
564 ()))
565 "Low level empty newsgroup face."
567 ;; backward-compatibility alias
580 "Level 1 mailgroup face."
582 ;; backward-compatibility alias
595 "Level 1 empty mailgroup face."
597 ;; backward-compatibility alias
610 "Level 2 mailgroup face."
612 ;; backward-compatibility alias
625 "Level 2 empty mailgroup face."
627 ;; backward-compatibility alias
640 "Level 3 mailgroup face."
642 ;; backward-compatibility alias
654 ()))
655 "Level 3 empty mailgroup face."
657 ;; backward-compatibility alias
670 "Low level mailgroup face."
672 ;; backward-compatibility alias
685 "Low level empty mailgroup face."
687 ;; backward-compatibility alias
691 ;; Summary mode faces.
694 "Face used for selected articles."
696 ;; backward-compatibility alias
703 "Face used for canceled articles."
705 ;; backward-compatibility alias
718 "Face used for high interest ticked articles."
720 ;; backward-compatibility alias
733 "Face used for low interest ticked articles."
735 ;; backward-compatibility alias
747 ()))
748 "Face used for normal interest ticked articles."
750 ;; backward-compatibility alias
763 "Face used for high interest ancient articles."
765 ;; backward-compatibility alias
778 "Face used for low interest ancient articles."
780 ;; backward-compatibility alias
792 ()))
793 "Face used for normal interest ancient articles."
795 ;; backward-compatibility alias
806 "Face used for high interest uncached articles."
808 ;; backward-compatibility alias
819 "Face used for low interest uncached articles."
821 ;; backward-compatibility alias
832 "Face used for normal interest uncached articles."
834 ;; backward-compatibility alias
841 "Face used for high interest unread articles."
843 ;; backward-compatibility alias
850 "Face used for low interest unread articles."
852 ;; backward-compatibility alias
858 ()))
859 "Face used for normal interest unread articles."
861 ;; backward-compatibility alias
876 "Face used for high interest read articles."
878 ;; backward-compatibility alias
893 "Face used for low interest read articles."
895 ;; backward-compatibility alias
907 ()))
908 "Face used for normal interest read articles."
910 ;; backward-compatibility alias
915 ;;;
916 ;;; Gnus buffers
917 ;;;
923 "Do the same as `get-buffer-create', but store the created buffer."
928 "Add the current buffer to the list of Gnus buffers."
932 "Kill BUFFER and remove from the list of Gnus buffers."
939 "Return a list of live Gnus buffers."
948 gnus-buffers)
950 ;;; Splash screen.
963 ()))
964 "Face for the splash screen."
966 ;; backward-compatibility alias
980 "Indent rigidly using only spaces and no tabs."
986 ;; We translate tabs into spaces -- not everybody uses
987 ;; an 8-character tab.
992 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1017 "*Color styles used for the Gnus logo."
1019 gnus-logo-color-alist))
1029 "Insert startup message in current buffer."
1030 ;; Insert the message.
1035 ;; Make sure the library defining `image-load-path' is
1036 ;; loaded (`find-image' is autoloaded) (and discard the
1037 ;; result). Else, we may get "defvar ignored because
1038 ;; image-load-path is let-bound" when calling `find-image'
1039 ;; below.
1049 :color-symbols
1053 :color-symbols
1058 ;; Account for the pbm's background.
1062 ;; Account for the xbm's background.
1073 t)))
1076 _ ___ _ _
1077 _ ___ __ ___ __ _ ___
1078 __ _ ___ __ ___
1079 _ ___ _
1080 _ _ __ _
1081 ___ __ _
1082 __ _
1083 _ _ _
1084 _ _ _
1085 _ _ _
1086 __ ___
1087 _ _ _ _
1088 _ _
1089 _ _
1090 _ _
1091 _
1092 __
1095 ;; And then hack it.
1104 ;; Fontify some.
1111 "Do color-symbol search-and-replace in svg file."
1122 color-symbols)
1124 list)))
1133 ;;; Do the rest.
1139 "Alist of group parameters.
1141 For example:
1143 (gnus-use-scoring nil)
1144 (gnus-summary-line-format
1146 (gcc-self . t)
1147 (display . all))
1150 (broken-reply-to . t)))"
1157 "If it is t, ignore case of group names specified in `gnus-parameters'.
1158 If it is nil, don't ignore case. If it is `default', which is for the
1159 backward compatibility, use the value of `case-fold-search'."
1170 "Define a group parameter PARAM.
1171 REST is a plist of following:
1172 :type One of `bool', `list' or nil.
1173 :function The name of the function.
1174 :function-document The documentation of the function.
1175 :parameter-type The type for customizing the parameter.
1176 :parameter-document The documentation for the parameter.
1177 :variable The name of the variable.
1178 :variable-document The documentation for the variable.
1179 :variable-group The group for customizing the variable.
1180 :variable-type The type for customizing the variable.
1181 :variable-default The default value of the variable."
1198 'progn
1200 ,variable-document
1206 gnus-group-parameters-more))
1209 ,parameter-type
1213 ,function-document
1215 val)
1218 t)
1223 (,variable
1225 elem value)
1233 ,function-document
1237 elem value)
1244 'value
1249 All other Gnus file and directory variables are initialized from this variable.
1251 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1252 This means that other directory variables that are initialized
1253 from this variable won't be set properly if you set this variable
1254 in `.gnus.el'. Set this variable in `.emacs' instead."
1260 "*Directory variable from which all other Gnus file variables are derived.
1262 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1263 This means that other directory variables that are initialized from
1264 this variable won't be set properly if you set this variable in `.gnus.el'.
1265 Set this variable in `.emacs' instead."
1270 "*Default directory for all Gnus buffers."
1273 directory))
1275 ;; Site dependent variables.
1277 ;; Should this be obsolete?
1279 "The hostname of the default NNTP server.
1280 The empty string, or nil, means to use the local host.
1281 You may wish to set this on a site-wide basis.
1283 If you want to change servers, you should use `gnus-select-method'."
1289 "A file with only the name of the nntp server in it."
1295 "Find default nntp server.
1296 Check the NNTPSERVER environment variable and the
1297 `gnus-nntpserver-file' file."
1305 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1306 ;; starting or even loading Gnus.
1307 ;;;###autoload(when (fboundp 'custom-autoload)
1308 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1314 gnus-default-nntp-server)
1316 "Default method for selecting a newsgroup.
1317 This variable should be a list, where the first element is how the
1318 news is to be fetched, the second is the address.
1321 NNTP, you could say:
1325 If you want to use your local spool, say:
1327 \(setq gnus-select-method (list 'nnspool (system-name)))
1329 If you use this variable, you must set `gnus-nntp-server' to nil.
1331 There is a lot more to know about select methods and virtual servers -
1332 see the manual for details."
1333 ;; Emacs has set-after since 22.1.
1334 ;set-after '(gnus-default-nntp-server)
1341 "*Method used for archiving messages you've sent.
1342 This should be a mail method.
1344 See also `gnus-update-message-archive-method'."
1348 gnus-select-method))
1353 The archive method is initially set according to the value of
1355 so that it may be used as a real method of the server which is named
1357 updated if the value of this variable is nil, even if you change the
1358 value of `gnus-message-archive-method' afterward. If you want the
1360 `gnus-message-archive-method', set this variable to a non-nil value."
1367 "*Name of the group in which to save the messages you've written.
1368 This can either be a string; a list of strings; or an alist
1369 of regexps/functions/forms to be evaluated to return a string (or a list
1370 of strings). The functions are called with the name of the current
1371 group (or nil) as a parameter.
1373 If you want to save your mail in one group and the news articles you
1374 write in another group, you could say something like:
1376 \(setq gnus-message-archive-group
1377 '((if (message-news-p)
1381 Normally the group names returned by this variable should be
1383 However, you may wish to store the message on some other server. In
1384 that case, just return a fully prefixed name of the group --
1392 function
1393 sexp
1394 string))
1397 "List of NNTP servers that the user can choose between interactively.
1398 To make Gnus query you for a server, you have to give `gnus' a
1399 non-numeric prefix - `C-u M-x gnus', in short."
1405 "A list of secondary methods that will be used for reading news.
1406 This is a list where each element is a complete select method (see
1407 `gnus-select-method').
1409 If, for instance, you want to read your mail with the nnml back end,
1410 you could set this variable:
1417 "Local domain name without a host name.
1418 The DOMAINNAME environment variable is used instead if it is defined.
1419 If the function `system-name' returns the full Internet name, there is
1420 no need to set this variable."
1423 string))
1426 ;; Customization variables
1429 "Preferred method for fetching an article by Message-ID.
1430 The value of this variable must be a valid select method as discussed
1431 in the documentation of `gnus-select-method'.
1433 It can also be a list of select methods, as well as the special symbol
1434 `current', which means to use the current select method. If it is a
1435 list, Gnus will try all the methods in the list until it finds a match."
1441 gnus-select-method
1442 sexp
1450 gnus-select-method))))
1453 "*Non-nil means that cross referenced articles will be marked as read.
1454 If nil, ignore cross references. If t, mark articles as read in
1455 subscribed newsgroups. If neither t nor nil, mark as read in all
1456 newsgroups."
1464 "*Process mark."
1470 "*The number of articles which indicates a large newsgroup.
1471 If the number of articles in a newsgroup is greater than this value,
1472 confirmation is required for selecting the newsgroup.
1473 If it is nil, no confirmation is required.
1475 Also see `gnus-large-ephemeral-newsgroup'."
1478 integer))
1481 "Non-nil means that the default name of a file to save articles in is the group name.
1482 If it's nil, the directory form of the group name is used instead.
1484 If this variable is a list, and the list contains the element
1485 `not-score', long file names will not be used for score files; if it
1486 contains the element `not-save', long file names will not be used for
1487 saving; and if it contains the element `not-kill', long file names
1488 will not be used for kill files.
1490 Note that the default for this variable varies according to what system
1491 type you're using. On `usg-unix-v' this variable defaults to nil while
1492 on all other systems it defaults to t."
1510 "*If non-nil, save group scoring info."
1516 "*If non-nil, allow undoing in Gnus group mode buffers."
1521 "*If non-nil, use some adaptive scoring scheme.
1522 If a list, then the values `word' and `line' are meaningful. The
1523 former will perform adaption on individual words in the subject
1524 header while `line' will perform adaption on several headers."
1530 "*If nil, Gnus will ignore the article cache.
1531 If `passive', it will allow entering (and reading) articles
1532 explicitly entered into the cache. If anything else, use the
1533 cache to the full extent of the law."
1541 "*If non-nil, display a thread tree buffer."
1546 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1547 If it is a number N, then Gnus will only keep the last N articles
1548 read. If it is neither nil nor a number, Gnus will keep all read
1549 articles. This is not a good idea."
1552 integer
1557 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1562 "*If non-nil, enable scoring."
1568 "*A hook called when preparing to exit from the summary buffer.
1569 It calls `gnus-summary-expire-articles' by default."
1574 "*Non-nil means that you are a Usenet novice.
1575 If non-nil, verbose messages may be displayed and confirmations may be
1576 required."
1581 "*Non-nil means that you will never be asked for confirmation about anything.
1582 That doesn't mean *anything* anything; particularly destructive
1583 commands will still require prompting."
1588 "*If non-nil, require your confirmation when catching up a group."
1593 "*If non-nil, require your confirmation when exiting Gnus.
1594 If `quiet', update any active summary buffers automatically
1595 first before exiting."
1601 "*Function for extracting address components from a From header.
1602 Two pre-defined function exist: `gnus-extract-address-components',
1603 which is the default, quite fast, and too simplistic solution, and
1604 `mail-extract-address-components', which works much better, but is
1605 slower."
1612 "String used to separate shell commands."
1634 server-marks)
1637 "*An alist of valid select methods.
1638 The first element of each list lists should be a string with the name
1639 of the select method. The other elements may be the category of
1640 this method (i. e., `post', `mail', `none' or whatever) or other
1641 properties that this method has (like being respoolable).
1642 If you implement a new select method, all you should have to change is
1643 this variable. I think."
1660 "Recomputes the select-method widget based on the value of
1661 `gnus-valid-select-methods'."
1663 "Widget for entering a select method."
1670 gnus-valid-select-methods)
1674 :inline t
1676 variable
1682 "List of buffers that should update their mode lines.
1683 The list may contain the symbols `group', `article', `tree' and
1684 `summary'. If the corresponding symbol is present, Gnus will keep
1685 that mode line updated with information that may be pertinent.
1686 If this variable is nil, screen refresh may be quicker."
1694 "*Max length of mode-line non-string contents.
1695 If this is nil, Gnus will take space as is needed, leaving the rest
1696 of the mode line intact."
1700 integer))
1702 ;; There should be special validation for this.
1707 to-address
1708 :function-document
1709 "Return GROUP's to-address."
1710 :variable-document
1711 "*Alist of group regexps and correspondent to-addresses."
1712 :variable-group gnus-group-parameter
1715 This will be used when doing followups and posts.
1717 This is primarily useful in mail groups that represent closed
1718 mailing lists--mailing lists where it's expected that everybody that
1719 writes to the mailing list is subscribed to it. Since using this
1720 parameter ensures that the mail only goes to the mailing list itself,
1721 it means that members won't receive two copies of your followups.
1723 Using `to-address' will actually work whether the group is foreign or
1724 not. Let's say there's a group on the server that is called
1725 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1726 articles from a mail-to-news gateway. Posting directly to this group
1727 is therefore impossible--you have to send mail to the mailing list
1728 address instead.
1730 The gnus-group-split mail splitting mechanism will behave as if this
1734 to-list
1735 :function-document
1736 "Return GROUP's to-list."
1737 :variable-document
1738 "*Alist of group regexps and correspondent to-lists."
1739 :variable-group gnus-group-parameter
1742 This address will be used when doing a `a' in the group.
1744 It is totally ignored when doing a followup--except that if it is
1745 present in a news group, you'll get mail group semantics when doing
1746 `f'.
1748 The gnus-group-split mail splitting mechanism will behave as if this
1752 subscribed
1753 :type bool
1754 :function-document
1755 "Return GROUP's subscription status."
1756 :variable-document
1757 "*Groups which are automatically considered subscribed."
1758 :variable-group gnus-group-parameter
1761 Gnus assumed that you are subscribed to the To/List address.
1763 When constructing a list of subscribed groups using
1764 `gnus-find-subscribed-addresses', Gnus includes the To address given
1768 auto-expire
1769 :type bool
1770 :function gnus-group-auto-expirable-p
1771 :function-document
1772 "Check whether GROUP is auto-expirable or not."
1773 :variable gnus-auto-expirable-newsgroups
1774 :variable-default nil
1775 :variable-document
1776 "*Groups in which to automatically mark read articles as expirable.
1777 If non-nil, this should be a regexp that should match all groups in
1778 which to perform auto-expiry. This only makes sense for mail groups."
1779 :variable-group nnmail-expire
1781 regexp)
1783 :parameter-document
1787 total-expire
1788 :type bool
1789 :function gnus-group-total-expirable-p
1790 :function-document
1791 "Check whether GROUP is total-expirable or not."
1792 :variable gnus-total-expirable-newsgroups
1793 :variable-default nil
1794 :variable-document
1795 "*Groups in which to perform expiry of all read articles.
1796 Use with extreme caution. All groups that match this regexp will be
1797 expiring - which means that all read articles will be deleted after
1798 \(say) one week. (This only goes for mail groups and the like, of
1799 course.)"
1800 :variable-group nnmail-expire
1802 regexp)
1804 :parameter-document
1805 "All read articles will be put through the expiry process
1807 This happens even if they are not marked as expirable.
1811 charset
1812 :function-document
1813 "Return the default charset of GROUP."
1814 :variable gnus-group-charset-alist
1815 :variable-default
1828 :variable-document
1829 "Alist of regexps (to match group names) and default charsets to be used when reading."
1830 :variable-group gnus-charset
1838 post-method
1839 :type list
1840 :function-document
1841 "Return a posting method for GROUP."
1842 :variable gnus-post-method-alist
1843 :variable-document
1844 "Alist of regexps (to match group names) and method to be used when
1845 posting an article."
1846 :variable-group gnus-group-foreign
1847 :parameter-type
1855 :parameter-document
1859 large-newsgroup-initial
1860 :type integer
1861 :function-document
1862 "Return GROUP's initial input of the number of articles."
1863 :variable-document
1864 "*Alist of group regexps and its initial input of the number of articles."
1865 :variable-group gnus-group-parameter
1871 This number will be prompted as the initial value of the number of
1872 articles to list when the group is a large newsgroup (see
1873 `gnus-large-newsgroup'). If it is nil, the default value is the
1876 ;; The Gnus registry's ignored groups
1878 registry-ignore
1879 :type list
1880 :function-document
1881 "Whether this group should be ignored by the registry."
1882 :variable gnus-registry-ignored-groups
1887 :variable-document
1888 "*Groups in which the registry should be turned off."
1889 :variable-group gnus-registry
1896 :parameter-document
1899 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1901 "*Disable the group parameters for spam detection.
1902 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1909 "Spam group classification (requires spam.el).
1910 This group contains spam messages. On summary entry, unread messages
1911 will be marked as spam. On summary exit, the specified spam
1912 processors will be invoked on spam-marked messages, then those
1913 messages will be expired, so the spam processor will only see a
1917 "The ham value for the spam group parameter (requires spam.el).
1918 On summary exit, the specified ham processors will be invoked on
1919 ham-marked messages. Exercise caution, since the ham processor will
1920 see the same message more than once because there is no ham message
1924 spam-contents
1925 :type list
1926 :function-document
1927 "The spam type (spam, ham, or neither) of the group."
1928 :variable gnus-spam-newsgroup-contents
1929 :variable-default nil
1930 :variable-document
1931 "*Group classification (spam, ham, or neither). Only
1932 meaningful when spam.el is loaded. If non-nil, this should be a
1933 list of group name regexps associated with a classification for
1934 each one. In spam groups, new articles are marked as spam on
1935 summary entry. There is other behavior associated with ham and
1936 no classification when spam.el is loaded - see the manual."
1937 :variable-group spam
1951 :parameter-document
1952 "The spam classification (spam, ham, or neither) of this group.
1953 When a spam group is entered, all unread articles are marked as
1954 spam. There is other behavior associated with ham and no
1958 spam-resend-to
1959 :type list
1960 :function-document
1961 "The address to get spam resent (through spam-report-resend)."
1962 :variable gnus-spam-resend-to
1963 :variable-default nil
1964 :variable-document
1965 "The address to get spam resent (through spam-report-resend)."
1966 :variable-group spam
1970 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1971 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1972 :parameter-document
1976 ham-resend-to
1977 :type list
1978 :function-document
1979 "The address to get ham resent (through spam-report-resend)."
1980 :variable gnus-ham-resend-to
1981 :variable-default nil
1982 :variable-document
1983 "The address to get ham resent (through spam-report-resend)."
1984 :variable-group spam
1988 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1989 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1990 :parameter-document
2006 "OBSOLETE: The Gmane reporting summary exit spam processor.
2013 "OBSOLETE: The ifile summary exit ham processor.
2017 "OBSOLETE: The Bogofilter summary exit ham processor.
2021 "OBSOLETE: The spam-stat summary exit ham processor.
2025 "OBSOLETE: The whitelist summary exit ham processor.
2029 "OBSOLETE: The BBDB summary exit ham processor.
2033 "OBSOLETE: The ham copy exit ham processor.
2037 "OBSOLETE: The spamoracle summary exit ham processor.
2041 spam-process
2042 :type list
2043 :parameter-type
2046 :value nil
2083 :function-document
2084 "Which spam or ham processors will be applied when the summary is exited."
2085 :variable gnus-spam-process-newsgroups
2086 :variable-default nil
2087 :variable-document
2088 "*Groups in which to automatically process spam or ham articles with
2089 a backend on summary exit. If non-nil, this should be a list of group
2090 name regexps that should match all groups in which to do automatic
2091 spam processing, associated with the appropriate processor."
2092 :variable-group spam
2093 :variable-type
2134 :parameter-document
2138 spam-autodetect
2139 :type list
2140 :parameter-type
2142 :function-document
2143 "Should spam be autodetected (with spam-split) in this group?"
2144 :variable gnus-spam-autodetect
2145 :variable-default nil
2146 :variable-document
2147 "*Groups in which spam should be autodetected when they are entered.
2148 Only unseen articles will be examined, unless
2149 spam-autodetect-recheck-messages is set."
2150 :variable-group spam
2151 :variable-type
2156 boolean))
2157 :parameter-document
2158 "Spam autodetection.
2159 Only unseen articles will be examined, unless
2163 spam-autodetect-methods
2164 :type list
2165 :parameter-type
2188 :function-document
2189 "Methods to be used for autodetection in each group"
2190 :variable gnus-spam-autodetect-methods
2191 :variable-default nil
2192 :variable-document
2193 "*Methods for autodetecting spam per group.
2194 Requires the spam-autodetect parameter. Only unseen articles
2195 will be examined, unless spam-autodetect-recheck-messages is
2196 set."
2197 :variable-group spam
2198 :variable-type
2225 :parameter-document
2226 "Spam autodetection methods.
2227 Requires the spam-autodetect parameter. Only unseen articles
2228 will be examined, unless spam-autodetect-recheck-messages is
2232 spam-process-destination
2233 :type list
2234 :parameter-type
2240 :function-document
2241 "Where spam-processed articles will go at summary exit."
2242 :variable gnus-spam-process-destinations
2243 :variable-default nil
2244 :variable-document
2245 "*Groups in which to explicitly send spam-processed articles to
2246 another group, or expire them (the default). If non-nil, this should
2247 be a list of group name regexps that should match all groups in which
2248 to do spam-processed article moving, associated with the destination
2249 group or nil for explicit expiration. This only makes sense for
2250 mail groups."
2251 :variable-group spam
2252 :variable-type
2263 :parameter-document
2267 ham-process-destination
2268 :type list
2269 :parameter-type
2277 :function-document
2278 "Where ham articles will go at summary exit from a spam group."
2279 :variable gnus-ham-process-destinations
2280 :variable-default nil
2281 :variable-document
2282 "*Groups in which to explicitly send ham articles to
2283 another group, or do nothing (the default). If non-nil, this should
2284 be a list of group name regexps that should match all groups in which
2285 to do ham article moving, associated with the destination
2286 group or nil for explicit ignoring. This only makes sense for
2287 mail groups, and only works in spam groups."
2288 :variable-group spam
2289 :variable-type
2301 :parameter-document
2305 ham-marks
2316 :parameter-document
2317 "Marks considered ham (positively not spam). Such articles will be
2318 processed as ham (non-spam) on group exit. When nil, the global
2319 spam-ham-marks variable takes precedence."
2321 gnus-read-mark
2322 gnus-killed-mark
2323 gnus-kill-file-mark
2324 gnus-low-score-mark))))
2325 :variable-group spam
2326 :variable-document
2330 spam-marks
2339 :parameter-document
2340 "Marks considered spam.
2341 Such articles will be processed as spam on group exit. When nil, the global
2342 spam-spam-marks variable takes precedence."
2344 :variable-group spam
2345 :variable-document
2349 "Number of group name elements to leave alone when making a short group name."
2354 "*If non-nil, once you set a level, Gnus will use this level."
2358 ;; Hooks.
2361 "A hook run while Gnus is loaded."
2366 "A hook called to apply kill files to a group.
2367 This hook is intended to apply a kill file to the selected newsgroup.
2368 The function `gnus-apply-kill-file' is called by default.
2370 Since a general kill file is too heavy to use only for a few
2371 newsgroups, I recommend you to use a lighter hook function. For
2372 example, if you'd like to apply a kill file to articles which contains
2373 a string `rmgroup' in subject in newsgroup `control', you can use the
2374 following hook:
2376 (setq gnus-apply-kill-hook
2377 (list
2378 (lambda ()
2387 "Function run when a group level is changed.
2388 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2391 function))
2393 ;;; Face thingies.
2397 mouse-face
2398 summary-menu group-menu article-menu
2399 tree-highlight menu highlight
2400 browse-menu server-menu
2401 page-marker tree-menu binary-menu pick-menu)
2402 "*Enable visual features.
2403 If `visual' is disabled, there will be no menus and few faces. Most of
2404 the visual customization options below will be ignored. Gnus will use
2405 less space and be faster as a result.
2407 This variable can also be a list of visual elements to switch on. For
2408 instance, to switch off all visual things except menus, you can say:
2410 (setq gnus-visual '(menu))
2412 Valid elements include `summary-highlight', `group-highlight',
2413 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2414 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2415 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2435 ;; Byte-compiler warning.
2437 ;; Find out whether the gnus-visual TYPE is wanted.
2441 gnus-visual
2445 t))))
2455 "*Face used for group or summary buffer mouse highlighting.
2456 The line beneath the mouse pointer will be highlighted with this
2457 face."
2470 "Controls use of the agent cache while plugged.
2471 When set, Gnus will prefer using the locally stored content rather
2472 than re-fetching it from the server. You also need to enable
2473 `gnus-agent' for this to have any affect."
2479 "Default charset assumed to be used when viewing non-ASCII characters.
2480 This variable is overridden on a group-to-group basis by the
2481 `gnus-group-charset-alist' variable and is only used on groups not
2482 covered by that variable."
2486 ;; Fixme: Doc reference to agent.
2488 "Whether we want to use the Gnus agent or not.
2490 You may customize gnus-agent to disable its use. However, some
2491 back ends have started to use the agent as a client-side cache.
2492 Disabling the agent may result in noticeable loss of performance."
2498 "Function called by the command `gnus-other-frame' when starting Gnus."
2506 "Function called by the command `gnus-other-frame' when resuming Gnus."
2516 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2517 This should be an alist for Emacs, or a plist for XEmacs."
2528 "Which information should be exposed in the User-Agent header.
2530 Can be a list of symbols or a string. Valid symbols are `gnus'
2531 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2532 addition to the Emacs version, you can add `codename' \(show
2533 \(S\)XEmacs codename\) or either `config' \(show system
2534 configuration\) or `type' \(show system type\). If you set it to
2535 a string, be sure to use a valid format, see RFC 2616."
2548 ;; Convert old (< 2005-01-10) symbol type values:
2567 \f
2568 ;;; Internal variables
2573 ; Reset each time gnus-agent-covered-methods is changed else
2574 ; gnus-agent-method-p may mis-report a methods status.
2575 )
2585 ;; The carpal mode has been removed, but define the variable for
2586 ;; backwards compatibility.
2605 ;; Variable holding the user answers to all method prompts.
2608 ;; Variable holding the user answers to all mail method prompts.
2611 ;; Variable holding the user answers to all group prompts.
2619 "*The directory where cached articles will be stored."
2625 nnspool "cache"
2650 ;; Propagate flags to server, with the following exceptions:
2651 ;; `seen' is private to each gnus installation
2652 ;; `cache' is a internal gnus flag for each gnus installation
2653 ;; `download' is a agent flag private to each gnus installation
2654 ;; `unsend' are for nndraft groups only
2655 ;; `score' is not a proper mark
2656 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2659 "Marks that shouldn't be propagated to back ends.
2660 Typical marks are those that make no sense in a standalone back end,
2661 such as a mark that says whether an article is stored in the cache
2674 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
2678 "gnus"
2703 gnus-newsrc-last-checked-date
2704 gnus-newsrc-alist gnus-server-alist
2705 gnus-killed-list gnus-zombie-list
2706 gnus-topic-topology gnus-topic-alist)
2710 "Assoc list of read articles.
2714 "Assoc list of registry data.
2741 ;; Save window configuration.
2754 ;;; End of variables.
2756 ;; Define some autoload functions Gnus might use.
2759 ;; This little mapcar goes through the list below and marks the
2760 ;; symbols in question as autoloaded functions.
2780 message-send-and-exit message-yank-original)
2784 ;; This is only used in message.el, which has an autoload.
2786 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2788 ;; Next two only used in gnus-util.
2789 rmail-summary-exists rmail-select-summary)
2790 ;; Only used in gnus-util, which has an autoload.
2795 gnus-Folder-save-name gnus-folder-save-name)
2798 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2799 gnus-demon-add-disconnection gnus-demon-add-handler
2800 gnus-demon-remove-handler)
2802 gnus-demon-init gnus-demon-cancel)
2804 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2805 gnus-face-from-file)
2807 gnus-tree-open gnus-tree-close)
2809 gnus-server-server-name)
2812 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2813 gnus-article-hide-citation gnus-article-fill-cited-article
2814 gnus-article-hide-citation-in-followups
2815 gnus-article-fill-cited-long-lines)
2817 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2818 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2820 gnus-registry-handle-action)
2822 gnus-cache-possibly-remove-articles gnus-cache-request-article
2823 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2824 gnus-cache-enter-remove-article gnus-cached-article-p
2825 gnus-cache-open gnus-cache-close gnus-cache-update-article
2826 gnus-cache-articles-in-group)
2828 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2830 gnus-summary-increase-score gnus-summary-set-score
2831 gnus-summary-raise-thread gnus-summary-raise-same-subject
2832 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2833 gnus-summary-lower-thread gnus-summary-lower-same-subject
2834 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2835 gnus-summary-current-score gnus-score-delta-default
2836 gnus-score-flush-cache gnus-score-close
2837 gnus-possibly-score-headers gnus-score-followup-article
2838 gnus-score-followup-thread)
2841 gnus-current-score-file-nondirectory gnus-score-adaptive
2842 gnus-score-find-trace gnus-score-file-name)
2846 gnus-subscribe-topics)
2850 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2851 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2852 gnus-uu-mark-by-regexp gnus-uu-mark-all
2853 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2854 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2855 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2856 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2857 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2858 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2859 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2860 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2863 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2865 gnus-group-post-news gnus-group-mail gnus-group-news
2866 gnus-summary-post-news gnus-summary-news-other-window
2867 gnus-summary-followup gnus-summary-followup-with-original
2868 gnus-summary-cancel-article gnus-summary-supersede-article
2869 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2870 gnus-summary-mail-forward gnus-summary-mail-other-window
2871 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2872 gnus-summary-wide-reply gnus-summary-followup-to-mail
2873 gnus-summary-followup-to-mail-with-original gnus-bug
2874 gnus-summary-wide-reply-with-original
2875 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2876 gnus-summary-post-forward)
2881 gnus-list-of-unread-articles gnus-list-of-read-articles
2882 gnus-offer-save-summaries gnus-make-thread-indent-array
2883 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2884 gnus-summary-skip-intangible gnus-summary-article-number
2885 gnus-data-header gnus-data-find)
2887 gnus-group-list-groups gnus-group-first-unread-group
2888 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2889 gnus-group-setup-buffer gnus-group-get-new-news
2890 gnus-group-make-help-group gnus-group-update-group
2891 gnus-group-iterate gnus-group-group-name)
2893 gnus-backlog-remove-article)
2895 gnus-article-prepare gnus-article-set-window-start
2896 gnus-article-next-page gnus-article-prev-page
2897 gnus-request-article-this-buffer gnus-article-mode
2898 gnus-article-setup-buffer gnus-narrow-to-page
2899 gnus-article-delete-invisible-text gnus-treat-article)
2901 gnus-article-hide-headers gnus-article-hide-boring-headers
2902 gnus-article-treat-overstrike
2903 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2904 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2905 gnus-article-de-base64-unreadable
2906 gnus-article-decode-HZ
2907 gnus-article-wash-html
2908 gnus-article-unsplit-urls
2909 gnus-article-hide-pem gnus-article-hide-signature
2910 gnus-article-strip-leading-blank-lines gnus-article-date-local
2911 gnus-article-date-original gnus-article-date-lapsed
2912 ;;gnus-article-show-all-headers
2913 gnus-article-edit-mode gnus-article-edit-article
2914 gnus-article-edit-done gnus-article-decode-encoded-words
2915 gnus-start-date-timer gnus-stop-date-timer
2916 gnus-mime-view-all-parts)
2919 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2920 gnus-check-reasonable-setup)
2922 gnus-dup-enter-articles)
2928 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2929 gnus-async-halt-prefetch)
2931 gnus-agent-save-active gnus-agent-method-p
2932 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2933 gnus-summary-set-agent-mark gnus-agent-save-group-info
2934 gnus-agent-request-article gnus-agent-retrieve-headers
2935 gnus-agent-store-article gnus-agent-group-covered-p)
2937 gnus-unplugged gnus-agentize gnus-agent-batch)
2939 gnus-summary-save-article-vm)
2944 gnus-group-split-update)
2947 ;;; gnus-sum.el thingies
2951 "*The format specification of the lines in the summary buffer.
2953 It works along the same lines as a normal formatting string,
2954 with some simple extensions.
2956 %N Article number, left padded with spaces (string)
2957 %S Subject (string)
2959 otherwise (string)
2960 %n Name of the poster (string)
2961 %a Extracted name of the poster (string)
2962 %A Extracted address of the poster (string)
2963 %F Contents of the From: header (string)
2964 %f Contents of the From: or To: headers (string)
2965 %x Contents of the Xref: header (string)
2966 %D Date of the article (string)
2967 %d Date of the article (string) in DD-MMM format
2968 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2969 format
2970 %M Message-id of the article (string)
2971 %r References of the article (string)
2972 %c Number of characters in the article (integer)
2973 %k Pretty-printed version of the above (string)
2975 %L Number of lines in the article (integer)
2976 %I Indentation based on thread level (a string of
2977 spaces)
2978 %B A complex trn-style thread tree (string)
2979 The variables `gnus-sum-thread-*' can be used for
2980 customization.
2981 %T A string with two possible values: 80 spaces if the
2982 article is on thread level two or larger and 0 spaces
2983 on level one
2985 otherwise (character)
2987 See Info node `(gnus)Marking Articles'
2990 %> Spaces of length thread-level (string)
2991 %< Spaces of length (- 20 thread-level) (string)
2992 %i Article score (number)
2993 %z Article zcore (character)
2994 %t Number of articles under the current thread (number).
2995 %e Whether the thread is empty or not (character).
2996 %V Total thread score (number).
2997 %P The line number (number).
2998 %O Download mark (character).
2999 %* If present, indicates desired cursor position
3000 (instead of after first colon).
3001 %u User defined specifier. The next character in the
3002 format string should be a letter. Gnus will call the
3003 function gnus-user-format-function-X, where X is the
3004 letter following %u. The function will be passed the
3005 current header as argument. The function should
3006 return a string, which will be inserted into the
3007 summary just like information from any other summary
3008 specifier.
3009 &user-date; Age sensitive date format. Various date format is
3010 defined in `gnus-user-date-format-alist'.
3013 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3014 with care. For reasons of efficiency, Gnus will compute what column
3016 it is invalid to have these specs after a variable-length spec. Well,
3017 you might not be arrested, but your summary buffer will look strange,
3018 which is bad enough.
3020 The smart choice is to have these specs as far to the left as
3021 possible.
3023 This restriction may disappear in later versions of Gnus.
3025 General format specifiers can also be used.
3026 See Info node `(gnus)Formatting Variables'."
3031 ;;;
3032 ;;; Skeleton keymaps
3033 ;;;
3038 (while keys
3039 (define-key keymap (pop keys) 'undefined))))
3041 (defvar gnus-article-mode-map
3042 (let ((keymap (make-sparse-keymap)))
3043 (gnus-suppress-keymap keymap)
3044 keymap))
3045 (defvar gnus-summary-mode-map
3046 (let ((keymap (make-keymap)))
3047 (gnus-suppress-keymap keymap)
3048 keymap))
3049 (defvar gnus-group-mode-map
3050 (let ((keymap (make-keymap)))
3051 (gnus-suppress-keymap keymap)
3052 keymap))
3054 \f
3056 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3057 ;; If you want the cursor to go somewhere else, set these two
3058 ;; functions in some startup hook to whatever you want.
3059 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3060 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3062 ;;; Various macros and substs.
3064 (defun gnus-header-from (header)
3065 (mail-header-from header))
3067 (defmacro gnus-gethash (string hashtable)
3068 "Get hash value of STRING in HASHTABLE."
3069 `(symbol-value (intern-soft ,string ,hashtable)))
3071 (defmacro gnus-gethash-safe (string hashtable)
3072 "Get hash value of STRING in HASHTABLE.
3073 Return nil if not defined."
3074 `(let ((sym (intern-soft ,string ,hashtable)))
3075 (and (boundp sym) (symbol-value sym))))
3077 (defmacro gnus-sethash (string value hashtable)
3078 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3079 `(set (intern ,string ,hashtable) ,value))
3080 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3082 (defmacro gnus-group-unread (group)
3083 "Get the currently computed number of unread articles in GROUP."
3084 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3086 (defmacro gnus-group-entry (group)
3087 "Get the newsrc entry for GROUP."
3088 `(gnus-gethash ,group gnus-newsrc-hashtb))
3090 (defmacro gnus-active (group)
3091 "Get active info on GROUP."
3092 `(gnus-gethash ,group gnus-active-hashtb))
3094 (defmacro gnus-set-active (group active)
3095 "Set GROUP's active info."
3096 `(gnus-sethash ,group ,active gnus-active-hashtb))
3098 ;; Info access macros.
3100 (defmacro gnus-info-group (info)
3101 `(nth 0 ,info))
3102 (defmacro gnus-info-rank (info)
3103 `(nth 1 ,info))
3104 (defmacro gnus-info-read (info)
3105 `(nth 2 ,info))
3106 (defmacro gnus-info-marks (info)
3107 `(nth 3 ,info))
3108 (defmacro gnus-info-method (info)
3109 `(nth 4 ,info))
3110 (defmacro gnus-info-params (info)
3111 `(nth 5 ,info))
3113 (defmacro gnus-info-level (info)
3114 `(let ((rank (gnus-info-rank ,info)))
3115 (if (consp rank)
3116 (car rank)
3117 rank)))
3118 (defmacro gnus-info-score (info)
3119 `(let ((rank (gnus-info-rank ,info)))
3120 (or (and (consp rank) (cdr rank)) 0)))
3122 (defmacro gnus-info-set-group (info group)
3123 `(setcar ,info ,group))
3124 (defmacro gnus-info-set-rank (info rank)
3125 `(setcar (nthcdr 1 ,info) ,rank))
3126 (defmacro gnus-info-set-read (info read)
3127 `(setcar (nthcdr 2 ,info) ,read))
3128 (defmacro gnus-info-set-marks (info marks &optional extend)
3129 (if extend
3130 `(gnus-info-set-entry ,info ,marks 3)
3131 `(setcar (nthcdr 3 ,info) ,marks)))
3132 (defmacro gnus-info-set-method (info method &optional extend)
3133 (if extend
3134 `(gnus-info-set-entry ,info ,method 4)
3135 `(setcar (nthcdr 4 ,info) ,method)))
3136 (defmacro gnus-info-set-params (info params &optional extend)
3137 (if extend
3138 `(gnus-info-set-entry ,info ,params 5)
3139 `(setcar (nthcdr 5 ,info) ,params)))
3141 (defun gnus-info-set-entry (info entry number)
3142 ;; Extend the info until we have enough elements.
3143 (while (<= (length info) number)
3144 (nconc info (list nil)))
3145 ;; Set the entry.
3146 (setcar (nthcdr number info) entry))
3148 (defmacro gnus-info-set-level (info level)
3149 `(let ((rank (cdr ,info)))
3150 (if (consp (car rank))
3151 (setcar (car rank) ,level)
3152 (setcar rank ,level))))
3153 (defmacro gnus-info-set-score (info score)
3154 `(let ((rank (cdr ,info)))
3155 (if (consp (car rank))
3156 (setcdr (car rank) ,score)
3157 (setcar rank (cons (car rank) ,score)))))
3159 (defmacro gnus-get-info (group)
3160 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3162 (defun gnus-set-info (group info)
3163 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3164 info))
3166 ;;; Load the compatibility functions.
3168 (require 'gnus-ems)
3170 \f
3171 ;;;
3172 ;;; Shutdown
3173 ;;;
3175 (defvar gnus-shutdown-alist nil)
3177 (defun gnus-add-shutdown (function &rest symbols)
3178 "Run FUNCTION whenever one of SYMBOLS is shut down."
3179 (push (cons function symbols) gnus-shutdown-alist))
3181 (defun gnus-shutdown (symbol)
3182 "Shut down everything that waits for SYMBOL."
3183 (dolist (entry gnus-shutdown-alist)
3184 (when (memq symbol (cdr entry))
3185 (funcall (car entry)))))
3187 \f
3188 ;;;
3189 ;;; Gnus Utility Functions
3190 ;;;
3192 (defun gnus-find-subscribed-addresses ()
3193 "Return a regexp matching the addresses of all subscribed mail groups.
3194 It consists of the `to-address' or `to-list' parameter of all groups
3195 with a `subscribed' parameter."
3196 (let (group address addresses)
3197 (dolist (entry (cdr gnus-newsrc-alist))
3198 (setq group (car entry))
3199 (when (gnus-parameter-subscribed group)
3200 (setq address (mail-strip-quoted-names
3201 (or (gnus-group-fast-parameter group 'to-address)
3202 (gnus-group-fast-parameter group 'to-list))))
3203 (when address
3204 (add-to-list 'addresses address))))
3205 (when addresses
3208 (defmacro gnus-string-or (&rest strings)
3209 "Return the first element of STRINGS that is a non-blank string.
3210 STRINGS will be evaluated in normal `or' order."
3211 `(gnus-string-or-1 (list ,@strings)))
3213 (defun gnus-string-or-1 (strings)
3214 (let (string)
3215 (while strings
3216 (setq string (pop strings))
3218 (setq string nil)
3219 (setq strings nil)))
3220 string))
3222 (defun gnus-version (&optional arg)
3223 "Version number of this version of Gnus.
3224 If ARG, insert string at point."
3225 (interactive "P")
3226 (if arg
3227 (insert (message gnus-version))
3228 (message gnus-version)))
3230 (defun gnus-continuum-version (&optional version)
3231 "Return VERSION as a floating point number."
3232 (unless version
3233 (setq version gnus-version))
3236 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3237 (number (match-string 2 version))
3238 major minor least)
3239 (unless (string-match
3241 (error "Invalid version string: %s" version))
3242 (setq major (string-to-number (match-string 1 number))
3243 minor (string-to-number (match-string 2 number))
3244 least (if (match-beginning 3)
3245 (string-to-number (match-string 3 number))
3246 0))
3247 (string-to-number
3248 (if (zerop major)
3249 (format "%s00%02d%02d"
3250 (if (member alpha '("(ding)" "d"))
3251 "4.99"
3252 (+ 5 (* 0.02
3253 (abs
3254 (- (mm-char-int (aref (downcase alpha) 0))
3255 (mm-char-int ?t))))
3256 -0.01))
3257 minor least)
3258 (format "%d.%02d%02d" major minor least))))))
3260 (defun gnus-info-find-node (&optional nodename)
3261 "Find Info documentation of Gnus."
3262 (interactive)
3263 ;; Enlarge info window if needed.
3264 (let (gnus-info-buffer)
3265 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3266 (setq gnus-info-buffer (current-buffer))
3267 (gnus-configure-windows 'info)))
3269 ;;;
3270 ;;; gnus-interactive
3271 ;;;
3273 (defvar gnus-current-prefix-symbol nil
3274 "Current prefix symbol.")
3276 (defvar gnus-current-prefix-symbols nil
3277 "List of current prefix symbols.")
3279 (defun gnus-interactive (string &optional params)
3280 "Return a list that can be fed to `interactive'.
3281 See `interactive' for full documentation.
3283 Adds the following specs:
3285 y -- The current symbolic prefix.
3286 Y -- A list of the current symbolic prefix(es).
3287 A -- Article number.
3288 H -- Article header.
3289 g -- Group name."
3290 (let ((i 0)
3291 out c prompt)
3292 (while (< i (length string))
3294 (setq c (aref string i))
3295 (when (match-end 1)
3296 (setq prompt (match-string 1 string)))
3297 (setq i (match-end 0))
3298 ;; We basically emulate just about everything that
3299 ;; `interactive' does, but add the specs listed above.
3300 (push
3301 (cond
3302 ((= c ?a)
3303 (completing-read prompt obarray 'fboundp t))
3304 ((= c ?b)
3305 (read-buffer prompt (current-buffer) t))
3306 ((= c ?B)
3307 (read-buffer prompt (other-buffer (current-buffer))))
3308 ((= c ?c)
3309 (read-char))
3310 ((= c ?C)
3311 (completing-read prompt obarray 'commandp t))
3312 ((= c ?d)
3313 (point))
3314 ((= c ?D)
3315 (read-directory-name prompt nil default-directory 'lambda))
3316 ((= c ?f)
3317 (read-file-name prompt nil nil 'lambda))
3318 ((= c ?F)
3319 (read-file-name prompt))
3320 ((= c ?k)
3321 (read-key-sequence prompt))
3322 ((= c ?K)
3323 (error "Not implemented spec"))
3324 ((= c ?e)
3325 (error "Not implemented spec"))
3326 ((= c ?m)
3327 (mark))
3328 ((= c ?N)
3329 (error "Not implemented spec"))
3330 ((= c ?n)
3331 (string-to-number (read-from-minibuffer prompt)))
3332 ((= c ?p)
3333 (prefix-numeric-value current-prefix-arg))
3334 ((= c ?P)
3335 current-prefix-arg)
3336 ((= c ?r)
3337 'gnus-prefix-nil)
3338 ((= c ?s)
3339 (read-string prompt))
3340 ((= c ?S)
3341 (intern (read-string prompt)))
3342 ((= c ?v)
3343 (read-variable prompt))
3344 ((= c ?x)
3345 (read-minibuffer prompt))
3346 ((= c ?x)
3347 (eval-minibuffer prompt))
3348 ;; And here the new specs come.
3349 ((= c ?y)
3350 gnus-current-prefix-symbol)
3351 ((= c ?Y)
3352 gnus-current-prefix-symbols)
3353 ((= c ?g)
3354 (gnus-group-group-name))
3355 ((= c ?A)
3356 (gnus-summary-skip-intangible)
3357 (or (get-text-property (point) 'gnus-number)
3358 (gnus-summary-last-subject)))
3359 ((= c ?H)
3360 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3361 (t
3362 (error "Non-implemented spec")))
3363 out)
3364 (cond
3365 ((= c ?r)
3366 (push (if (< (point) (mark)) (point) (mark)) out)
3367 (push (if (> (point) (mark)) (point) (mark)) out))))
3368 (setq out (delq 'gnus-prefix-nil out))
3369 (nreverse out)))
3371 (defun gnus-symbolic-argument (&optional arg)
3372 "Read a symbolic argument and a command, and then execute command."
3373 (interactive "P")
3374 (let* ((in-command (this-command-keys))
3375 (command in-command)
3376 gnus-current-prefix-symbols
3377 gnus-current-prefix-symbol
3378 syms)
3379 (while (equal in-command command)
3380 (message "%s-" (key-description (this-command-keys)))
3381 (push (intern (char-to-string (read-char))) syms)
3382 (setq command (read-key-sequence nil t)))
3383 (setq gnus-current-prefix-symbols (nreverse syms)
3384 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3385 (call-interactively (key-binding command t))))
3387 ;;; More various functions.
3389 (defsubst gnus-check-backend-function (func group)
3390 "Check whether GROUP supports function FUNC.
3391 GROUP can either be a string (a group name) or a select method."
3392 (ignore-errors
3393 (let ((method (if (stringp group)
3394 (car (gnus-find-method-for-group group))
3395 group)))
3396 (unless (featurep method)
3397 (require method))
3398 (fboundp (intern (format "%s-%s" method func))))))
3400 (defun gnus-group-read-only-p (&optional group)
3401 "Check whether GROUP supports editing or not.
3402 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3403 that that variable is buffer-local to the summary buffers."
3404 (let ((group (or group gnus-newsgroup-name)))
3405 (not (gnus-check-backend-function 'request-replace-article group))))
3407 (defun gnus-virtual-group-p (group)
3408 "Say whether GROUP is virtual or not."
3409 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3410 gnus-valid-select-methods)))
3412 (defun gnus-news-group-p (group &optional article)
3413 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3414 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3415 t) ;is news of course.
3416 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3417 nil) ;must be mail then.
3418 ((vectorp article) ;Has header info.
3419 (eq (gnus-request-type group (mail-header-id article)) 'news))
3420 ((null article) ;Hasn't header info
3421 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3422 ((< article 0) ;Virtual message
3423 nil) ;we don't know, guess mail.
3424 (t ;Has positive number
3425 (eq (gnus-request-type group article) 'news)))) ;use it.
3427 ;; Check whether to use long file names.
3428 (defun gnus-use-long-file-name (symbol)
3429 ;; The variable has to be set...
3430 (and gnus-use-long-file-name
3431 ;; If it isn't a list, then we return t.
3432 (or (not (listp gnus-use-long-file-name))
3433 ;; If it is a list, and the list contains `symbol', we
3434 ;; return nil.
3435 (not (memq symbol gnus-use-long-file-name)))))
3437 ;; Generate a unique new group name.
3438 (defun gnus-generate-new-group-name (leaf)
3439 (let ((name leaf)
3440 (num 0))
3441 (while (gnus-group-entry name)
3442 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3443 name))
3445 (defun gnus-ephemeral-group-p (group)
3446 "Say whether GROUP is ephemeral or not."
3447 (gnus-group-get-parameter group 'quit-config t))
3449 (defun gnus-group-quit-config (group)
3450 "Return the quit-config of GROUP."
3451 (gnus-group-get-parameter group 'quit-config t))
3453 (defun gnus-kill-ephemeral-group (group)
3454 "Remove ephemeral GROUP from relevant structures."
3455 (gnus-sethash group nil gnus-newsrc-hashtb))
3457 (defun gnus-simplify-mode-line ()
3458 "Make mode lines a bit simpler."
3459 (setq mode-line-modified (cdr gnus-mode-line-modified))
3460 (when (listp mode-line-format)
3461 (make-local-variable 'mode-line-format)
3462 (setq mode-line-format (copy-sequence mode-line-format))
3463 (when (equal (nth 3 mode-line-format) " ")
3464 (setcar (nthcdr 3 mode-line-format) " "))))
3466 ;;; Servers and groups.
3468 (defsubst gnus-server-add-address (method)
3469 (let ((method-name (symbol-name (car method))))
3470 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3471 (not (assq (intern (concat method-name "-address")) method))
3472 (memq 'physical-address (assq (car method)
3473 gnus-valid-select-methods)))
3474 (append method (list (list (intern (concat method-name "-address"))
3475 (nth 1 method))))
3476 method)))
3478 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3479 (catch 'server-name
3480 (setq method (or method gnus-select-method))
3482 ;; Perhaps it is already in the cache.
3483 (unless nocache
3484 (mapc (lambda (name-method)
3485 (if (equal (cdr name-method) method)
3486 (throw 'server-name (car name-method))))
3487 gnus-server-method-cache))
3489 (mapc
3490 (lambda (server-alist)
3491 (mapc (lambda (name-method)
3492 (when (gnus-methods-equal-p (cdr name-method) method)
3493 (unless (member name-method gnus-server-method-cache)
3494 (push name-method gnus-server-method-cache))
3495 (throw 'server-name (car name-method))))
3496 server-alist))
3497 (list gnus-server-alist
3498 gnus-predefined-server-alist))
3500 (let* ((name (if (member (cadr method) '(nil ""))
3501 (format "%s" (car method))
3502 (format "%s:%s" (car method) (cadr method))))
3503 (name-method (cons name method)))
3504 (when (and (not (member name-method gnus-server-method-cache))
3505 (not no-enter-cache)
3506 (not (assoc (car name-method) gnus-server-method-cache)))
3507 (push name-method gnus-server-method-cache))
3508 name)))
3510 (defsubst gnus-server-to-method (server)
3511 "Map virtual server names to select methods."
3512 (or (and server (listp server) server)
3513 (cdr (assoc server gnus-server-method-cache))
3514 (let ((result
3515 (or
3516 ;; Perhaps this is the native server?
3517 (and (equal server "native") gnus-select-method)
3518 ;; It should be in the server alist.
3519 (cdr (assoc server gnus-server-alist))
3520 ;; It could be in the predefined server alist.
3521 (cdr (assoc server gnus-predefined-server-alist))
3522 ;; If not, we look through all the opened server
3523 ;; to see whether we can find it there.
3524 (let ((opened gnus-opened-servers))
3525 (while (and opened
3526 (not (equal server (format "%s:%s" (caaar opened)
3527 (cadaar opened)))))
3528 (pop opened))
3529 (caar opened))
3530 ;; It could be a named method, search all servers
3531 (let ((servers gnus-secondary-select-methods))
3532 (while (and servers
3533 (not (equal server (format "%s:%s" (caar servers)
3534 (cadar servers)))))
3535 (pop servers))
3536 (car servers))
3537 ;; This could be some sort of foreign server that I
3538 ;; simply haven't opened (yet). Do a brute-force scan
3539 ;; of the entire gnus-newsrc-alist for the server name
3540 ;; of every method. As a side-effect, loads the
3541 ;; gnus-server-method-cache so this only happens once,
3542 ;; if at all.
3543 (let ((alist (cdr gnus-newsrc-alist))
3544 method match)
3545 (while alist
3546 (setq method (gnus-info-method (pop alist)))
3547 (when (and (not (stringp method))
3548 (equal server
3549 (gnus-method-to-server method nil t)))
3550 (setq match method
3551 alist nil)))
3552 match))))
3553 (when (and result
3554 (not (assoc server gnus-server-method-cache)))
3555 (push (cons server result) gnus-server-method-cache))
3556 result)))
3558 (defsubst gnus-server-get-method (group method)
3559 ;; Input either a server name, and extended server name, or a
3560 ;; select method, and return a select method.
3561 (cond ((stringp method)
3562 (gnus-server-to-method method))
3563 ((equal method gnus-select-method)
3564 gnus-select-method)
3565 ((and (stringp (car method))
3566 group)
3567 (gnus-server-extend-method group method))
3568 ((and method
3569 (not group)
3570 (equal (cadr method) ""))
3571 method)
3572 (t
3573 (gnus-server-add-address method))))
3575 (defmacro gnus-method-equal (ss1 ss2)
3576 "Say whether two servers are equal."
3577 `(let ((s1 ,ss1)
3578 (s2 ,ss2))
3579 (or (equal s1 s2)
3580 (and (= (length s1) (length s2))
3581 (progn
3582 (while (and s1 (member (car s1) s2))
3583 (setq s1 (cdr s1)))
3584 (null s1))))))
3586 (defun gnus-methods-equal-p (m1 m2)
3587 (let ((m1 (or m1 gnus-select-method))
3588 (m2 (or m2 gnus-select-method)))
3589 (or (equal m1 m2)
3590 (and (eq (car m1) (car m2))
3591 (or (not (memq 'address (assoc (symbol-name (car m1))
3592 gnus-valid-select-methods)))
3593 (equal (nth 1 m1) (nth 1 m2)))))))
3595 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3596 ;; Check parameters for sloppy equality.
3597 (let ((p1 (copy-sequence (cddr m1)))
3598 (p2 (copy-sequence (cddr m2)))
3599 e1 e2)
3600 (block nil
3601 (while (setq e1 (pop p1))
3602 (unless (setq e2 (assq (car e1) p2))
3603 ;; The parameter doesn't exist in p2.
3604 (return nil))
3605 (setq p2 (delq e2 p2))
3606 (unless (equal e1 e2)
3607 (if (not (and (stringp (cadr e1))
3608 (stringp (cadr e2))))
3609 (return nil)
3610 ;; Special-case string parameter comparison so that we
3611 ;; can uniquify them.
3612 (let ((s1 (cadr e1))
3613 (s2 (cadr e2)))
3614 (when (string-match "/$" s1)
3615 (setq s1 (directory-file-name s1)))
3616 (when (string-match "/$" s2)
3617 (setq s2 (directory-file-name s2)))
3618 (unless (equal s1 s2)
3619 (return nil))))))
3620 ;; If p2 now is empty, they were equal.
3621 (null p2))))
3623 (defun gnus-method-ephemeral-p (method)
3624 (let ((equal nil))
3625 (dolist (ephemeral gnus-ephemeral-servers)
3626 (when (gnus-sloppily-equal-method-parameters method ephemeral)
3627 (setq equal t)))
3628 equal))
3630 (defun gnus-methods-sloppily-equal (m1 m2)
3631 ;; Same method.
3632 (or
3633 (eq m1 m2)
3634 ;; Type and name are equal.
3635 (and
3636 (eq (car m1) (car m2))
3637 (equal (cadr m1) (cadr m2))
3638 (gnus-sloppily-equal-method-parameters m1 m2))))
3640 (defun gnus-server-equal (m1 m2)
3641 "Say whether two methods are equal."
3642 (let ((m1 (cond ((null m1) gnus-select-method)
3643 ((stringp m1) (gnus-server-to-method m1))
3644 (t m1)))
3645 (m2 (cond ((null m2) gnus-select-method)
3646 ((stringp m2) (gnus-server-to-method m2))
3647 (t m2))))
3648 (gnus-method-equal m1 m2)))
3650 (defun gnus-servers-using-backend (backend)
3651 "Return a list of known servers using BACKEND."
3652 (let ((opened gnus-opened-servers)
3653 out)
3654 (while opened
3655 (when (eq backend (caaar opened))
3656 (push (caar opened) out))
3657 (pop opened))
3658 out))
3660 (defun gnus-archive-server-wanted-p ()
3661 "Say whether the user wants to use the archive server."
3662 (cond
3663 ((or (not gnus-message-archive-method)
3664 (not gnus-message-archive-group))
3665 nil)
3666 ((and gnus-message-archive-method gnus-message-archive-group)
3667 t)
3668 (t
3669 (let ((active (cadr (assq 'nnfolder-active-file
3670 gnus-message-archive-method))))
3671 (and active
3672 (file-exists-p active))))))
3674 (defsubst gnus-method-to-server-name (method)
3675 (concat
3676 (format "%s" (car method))
3677 (when (and
3678 (or (assoc (format "%s" (car method))
3679 (gnus-methods-using 'address))
3680 (gnus-server-equal method gnus-message-archive-method))
3681 (nth 1 method)
3682 (not (string= (nth 1 method) "")))
3683 (concat "+" (nth 1 method)))))
3685 (defsubst gnus-method-to-full-server-name (method)
3686 (format "%s+%s" (car method) (nth 1 method)))
3688 (defun gnus-group-prefixed-name (group method &optional full)
3689 "Return the whole name from GROUP and METHOD.
3690 Call with full set to get the fully qualified group name (even if the
3691 server is native)."
3692 (when (stringp method)
3693 (setq method (gnus-server-to-method method)))
3694 (if (or (not method)
3695 (and (not full) (gnus-server-equal method "native"))
3696 ;;;!!! This might not be right. We'll see...
3697 ;(string-match ":" group)
3698 )
3699 group
3700 (concat (gnus-method-to-server-name method) ":" group)))
3702 (defun gnus-group-full-name (group method)
3703 "Return the full name from GROUP and METHOD, even if the method is native."
3704 (gnus-group-prefixed-name group method t))
3706 (defun gnus-group-guess-full-name-from-command-method (group)
3707 "Guess the full name from GROUP, even if the method is native."
3708 (if (gnus-group-prefixed-p group)
3709 group
3710 (gnus-group-full-name group gnus-command-method)))
3712 (defun gnus-group-real-prefix (group)
3713 "Return the prefix of the current group name."
3714 (if (stringp group)
3715 (if (string-match "^[^:]+:" group)
3716 (substring group 0 (match-end 0))
3717 "")
3718 nil))
3720 (defun gnus-group-short-name (group)
3721 "Return the short group name."
3722 (let ((prefix (gnus-group-real-prefix group)))
3723 (if (< 0 (length prefix))
3724 (substring group (length prefix) nil)
3725 group)))
3727 (defun gnus-group-prefixed-p (group)
3728 "Return the prefix of the current group name."
3729 (< 0 (length (gnus-group-real-prefix group))))
3731 (declare-function gnus-group-decoded-name "gnus-group" (string))
3733 (defun gnus-summary-buffer-name (group)
3734 "Return the summary buffer name of GROUP."
3735 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3737 (defun gnus-group-method (group)
3738 "Return the server or method used for selecting GROUP.
3739 You should probably use `gnus-find-method-for-group' instead."
3740 (let ((prefix (gnus-group-real-prefix group)))
3741 (if (equal prefix "")
3742 gnus-select-method
3743 (let ((servers gnus-opened-servers)
3744 (server "")
3745 backend possible found)
3747 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3748 server (substring prefix (match-end 0) (1- (length prefix))))
3749 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3750 (while servers
3751 (when (eq (caaar servers) backend)
3752 (setq possible (caar servers))
3753 (when (equal (cadaar servers) server)
3754 (setq found (caar servers))))
3755 (pop servers))
3756 (or (car (rassoc found gnus-server-alist))
3757 found
3758 (car (rassoc possible gnus-server-alist))
3759 possible
3760 (list backend server))))))
3762 (defsubst gnus-native-method-p (method)
3763 "Return whether METHOD is the native select method."
3764 (gnus-method-equal method gnus-select-method))
3766 (defsubst gnus-secondary-method-p (method)
3767 "Return whether METHOD is a secondary select method."
3768 (let ((methods gnus-secondary-select-methods)
3769 (gmethod (inline (gnus-server-get-method nil method))))
3770 (while (and methods
3771 (not (gnus-method-equal
3772 (inline (gnus-server-get-method nil (car methods)))
3773 gmethod)))
3774 (setq methods (cdr methods)))
3775 methods))
3777 (defun gnus-method-simplify (method)
3778 "Return the shortest uniquely identifying string or method for METHOD."
3779 (cond ((stringp method)
3780 method)
3781 ((gnus-native-method-p method)
3782 nil)
3783 ((gnus-secondary-method-p method)
3784 (format "%s:%s" (nth 0 method) (nth 1 method)))
3785 (t
3786 method)))
3788 (defun gnus-groups-from-server (server)
3789 "Return a list of all groups that are fetched from SERVER."
3790 (let ((alist (cdr gnus-newsrc-alist))
3791 info groups)
3792 (while (setq info (pop alist))
3793 (when (gnus-server-equal (gnus-info-method info) server)
3794 (push (gnus-info-group info) groups)))
3795 (sort groups 'string<)))
3797 (defun gnus-group-foreign-p (group)
3798 "Say whether a group is foreign or not."
3799 (and (not (gnus-group-native-p group))
3800 (not (gnus-group-secondary-p group))))
3802 (defun gnus-group-native-p (group)
3803 "Say whether the group is native or not."
3804 (not (string-match ":" group)))
3806 (defun gnus-group-secondary-p (group)
3807 "Say whether the group is secondary or not."
3808 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3810 (defun gnus-parameters-get-parameter (group)
3811 "Return the group parameters for GROUP from `gnus-parameters'."
3812 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3813 case-fold-search
3814 gnus-parameters-case-fold-search))
3815 params-list)
3816 (dolist (elem gnus-parameters)
3817 (when (string-match (car elem) group)
3818 (setq params-list
3819 (nconc (gnus-expand-group-parameters
3820 (car elem) (cdr elem) group)
3821 params-list))))
3822 params-list))
3824 (defun gnus-expand-group-parameter (match value group)
3825 "Use MATCH to expand VALUE in GROUP."
3826 (let ((start (string-match match group)))
3827 (if start
3828 (let ((matched-string (substring group start (match-end 0))))
3829 ;; Build match groups
3830 (string-match match matched-string)
3831 (replace-match value nil nil matched-string))
3832 group)))
3834 (defun gnus-expand-group-parameters (match parameters group)
3835 "Go through PARAMETERS and expand them according to the match data."
3836 (let (new)
3837 (dolist (elem parameters)
3838 (cond
3839 ((and (stringp (cdr elem))
3841 (push (cons (car elem)
3842 (gnus-expand-group-parameter match (cdr elem) group))
3843 new))
3844 ;; For `sieve' group parameters, perform substitutions for every
3845 ;; string within the match rule. This allows for parameters such
3846 ;; as:
3849 ((eq 'sieve (car elem))
3850 (push (mapcar (lambda (sieve-elem)
3851 (if (and (stringp sieve-elem)
3853 (gnus-expand-group-parameter match sieve-elem
3854 group)
3855 sieve-elem))
3856 (cdr elem))
3857 new))
3858 (t
3859 (push elem new))))
3860 new))
3862 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3863 "For GROUP, return the value of SYMBOL.
3865 You should call this in the `gnus-group-buffer' buffer.
3866 The function `gnus-group-find-parameter' will do that for you."
3867 ;; The speed trick: No cons'ing and quit early.
3868 (let* ((params (funcall gnus-group-get-parameter-function group))
3869 ;; Start easy, check the "real" group parameters.
3870 (simple-results
3871 (gnus-group-parameter-value params symbol allow-list t)))
3872 (if simple-results
3873 ;; Found results; return them.
3874 (car simple-results)
3875 ;; We didn't find it there, try `gnus-parameters'.
3876 (let ((result nil)
3877 (head nil)
3878 (tail gnus-parameters))
3879 ;; A good old-fashioned non-cl loop.
3880 (while tail
3881 (setq head (car tail)
3882 tail (cdr tail))
3883 ;; The car is regexp matching for matching the group name.
3884 (when (string-match (car head) group)
3885 ;; The cdr is the parameters.
3886 (let ((this-result
3887 (gnus-group-parameter-value (cdr head) symbol allow-list t)))
3888 (when this-result
3889 (setq result (car this-result))
3890 ;; Expand if necessary.
3891 (cond
3893 (setq result (gnus-expand-group-parameter
3894 (car head) result group)))
3895 ;; For `sieve' group parameters, perform substitutions
3896 ;; for every string within the match rule (see above).
3897 ((eq symbol 'sieve)
3898 (setq result
3899 (mapcar (lambda (elem)
3900 (if (stringp elem)
3901 (gnus-expand-group-parameter (car head)
3902 elem group)
3903 elem))
3904 result))))))))
3905 ;; Done.
3906 result))))
3908 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3909 "Return the group parameters for GROUP.
3910 If SYMBOL, return the value of that symbol in the group parameters.
3912 If you call this function inside a loop, consider using the faster
3913 `gnus-group-fast-parameter' instead."
3914 (with-current-buffer (if (buffer-live-p (get-buffer gnus-group-buffer))
3915 gnus-group-buffer
3916 (current-buffer))
3917 (if symbol
3918 (gnus-group-fast-parameter group symbol allow-list)
3919 (nconc
3920 (copy-sequence
3921 (funcall gnus-group-get-parameter-function group))
3922 (gnus-parameters-get-parameter group)))))
3924 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3925 "Return the group parameters for GROUP.
3926 If SYMBOL, return the value of that symbol in the group parameters.
3927 If ALLOW-LIST, also allow list as a result.
3928 Most functions should use `gnus-group-find-parameter', which
3929 also examines the topic parameters."
3930 (let ((params (gnus-info-params (gnus-get-info group))))
3931 (if symbol
3932 (gnus-group-parameter-value params symbol allow-list)
3933 params)))
3935 (defun gnus-group-parameter-value (params symbol &optional
3936 allow-list present-p)
3937 "Return the value of SYMBOL in group PARAMS.
3938 If ALLOW-LIST, also allow list as a result."
3939 ;; We only wish to return group parameters (dotted lists) and
3940 ;; not local variables, which may have the same names.
3941 ;; But first we handle single elements...
3942 (or (car (memq symbol params))
3943 ;; Handle alist.
3944 (let (elem)
3945 (catch 'found
3946 (while (setq elem (pop params))
3947 (when (and (consp elem)
3948 (eq (car elem) symbol)
3949 (or allow-list
3950 (atom (cdr elem))))
3951 (throw 'found (if present-p (list (cdr elem))
3952 (cdr elem)))))))))
3954 (defun gnus-group-add-parameter (group param)
3955 "Add parameter PARAM to GROUP."
3956 (let ((info (gnus-get-info group)))
3957 (when info
3958 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3959 ;; Cons the new param to the old one and update.
3960 (gnus-group-set-info (cons param (gnus-info-params info))
3961 group 'params))))
3963 (defun gnus-group-set-parameter (group name value)
3964 "Set parameter NAME to VALUE in GROUP.
3965 GROUP can also be an INFO structure."
3966 (let ((info (if (listp group)
3967 group
3968 (gnus-get-info group))))
3969 (when info
3970 (gnus-group-remove-parameter group name)
3971 (let ((old-params (gnus-info-params info))
3972 (new-params (list (cons name value))))
3973 (while old-params
3974 (when (or (not (listp (car old-params)))
3975 (not (eq (caar old-params) name)))
3976 (setq new-params (append new-params (list (car old-params)))))
3977 (setq old-params (cdr old-params)))
3978 (if (listp group)
3979 (gnus-info-set-params info new-params t)
3980 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3982 (defun gnus-group-remove-parameter (group name)
3983 "Remove parameter NAME from GROUP.
3984 GROUP can also be an INFO structure."
3985 (let ((info (if (listp group)
3986 group
3987 (gnus-get-info group))))
3988 (when info
3989 (let ((params (gnus-info-params info)))
3990 (when params
3991 (setq params (delq name params))
3992 (while (assq name params)
3993 (gnus-alist-pull name params))
3994 (gnus-info-set-params info params))))))
3996 (defun gnus-group-add-score (group &optional score)
3997 "Add SCORE to the GROUP score.
3998 If SCORE is nil, add 1 to the score of GROUP."
3999 (let ((info (gnus-get-info group)))
4000 (when info
4001 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
4003 (defun gnus-short-group-name (group &optional levels)
4004 "Collapse GROUP name LEVELS.
4005 Select methods are stripped and any remote host name is stripped down to
4006 just the host name."
4007 (let* ((name "")
4008 (foreign "")
4009 (depth 0)
4010 (skip 1)
4011 (levels (or levels
4012 gnus-group-uncollapsed-levels
4013 (progn
4015 (setq skip (match-end 0)
4016 depth (+ depth 1)))
4017 depth))))
4018 ;; Separate foreign select method from group name and collapse.
4019 ;; If method contains a server, collapse to non-domain server name,
4020 ;; otherwise collapse to select method.
4021 (let* ((colon (string-match ":" group))
4022 (server (and colon (substring group 0 colon)))
4023 (plus (and server (string-match "+" server))))
4024 (when server
4025 (if plus
4026 (setq foreign (substring server (+ 1 plus)
4028 group (substring group (+ 1 colon)))
4029 (setq foreign server
4030 group (substring group (+ 1 colon))))
4031 (setq foreign (concat foreign ":")))
4032 ;; Collapse group name leaving LEVELS uncollapsed elements
4033 (let* ((slist (split-string group "/"))
4034 (slen (length slist))
4036 (dlen (length dlist))
4037 glist
4038 glen
4039 gsep
4040 res)
4041 (if (> slen dlen)
4042 (setq glist slist
4043 glen slen
4044 gsep "/")
4045 (setq glist dlist
4046 glen dlen
4047 gsep "."))
4048 (setq levels (- glen levels))
4049 (dolist (g glist)
4050 (push (if (>= (decf levels) 0)
4051 (if (zerop (length g))
4052 ""
4053 (substring g 0 1))
4054 g)
4055 res))
4056 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4058 (defun gnus-narrow-to-body ()
4059 "Narrow to the body of an article."
4060 (narrow-to-region
4061 (progn
4062 (goto-char (point-min))
4064 (point-max)))
4065 (point-max)))
4067 \f
4068 ;;;
4069 ;;; Kill file handling.
4070 ;;;
4072 (defun gnus-apply-kill-file ()
4073 "Apply a kill file to the current newsgroup.
4074 Returns the number of articles marked as read."
4075 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4076 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4077 (gnus-apply-kill-file-internal)
4078 0))
4080 (defun gnus-kill-save-kill-buffer ()
4081 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4082 (when (get-file-buffer file)
4083 (with-current-buffer (get-file-buffer file)
4084 (when (buffer-modified-p)
4085 (save-buffer))
4086 (kill-buffer (current-buffer))))))
4088 (defcustom gnus-kill-file-name "KILL"
4089 "Suffix of the kill files."
4090 :group 'gnus-score-kill
4091 :group 'gnus-score-files
4092 :type 'string)
4094 (defun gnus-newsgroup-kill-file (newsgroup)
4095 "Return the name of a kill file name for NEWSGROUP.
4096 If NEWSGROUP is nil, return the global kill file name instead."
4097 (cond
4098 ;; The global KILL file is placed at top of the directory.
4099 ((or (null newsgroup)
4100 (string-equal newsgroup ""))
4101 (expand-file-name gnus-kill-file-name
4102 gnus-kill-files-directory))
4103 ;; Append ".KILL" to newsgroup name.
4104 ((gnus-use-long-file-name 'not-kill)
4105 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4106 "." gnus-kill-file-name)
4107 gnus-kill-files-directory))
4108 ;; Place "KILL" under the hierarchical directory.
4109 (t
4110 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4111 "/" gnus-kill-file-name)
4112 gnus-kill-files-directory))))
4114 ;;; Server things.
4116 (defun gnus-member-of-valid (symbol group)
4118 (memq symbol (assoc
4119 (symbol-name (car (gnus-find-method-for-group group)))
4120 gnus-valid-select-methods)))
4122 (defun gnus-method-option-p (method option)
4123 "Return non-nil if select METHOD has OPTION as a parameter."
4124 (when (stringp method)
4125 (setq method (gnus-server-to-method method)))
4126 (memq option (assoc (format "%s" (car method))
4127 gnus-valid-select-methods)))
4129 (defun gnus-similar-server-opened (method)
4130 "Return non-nil if we have a similar server opened.
4131 This is defined as a server with the same name, but different
4132 parameters."
4133 (let ((opened gnus-opened-servers)
4134 open)
4135 (while (and method opened)
4136 (setq open (car (pop opened)))
4137 ;; Type and name are the same...
4138 (when (and (equal (car method) (car open))
4139 (equal (cadr method) (cadr open))
4140 ;; ... but the rest of the parameters differ.
4141 (not (gnus-methods-sloppily-equal method open)))
4142 (setq method nil)))
4143 (not method)))
4145 (defun gnus-server-extend-method (group method)
4146 ;; This function "extends" a virtual server. If the server is
4147 ;; "hello", and the select method is ("hello" (my-var "something"))
4148 ;; in the group "alt.alt", this will result in a new virtual server
4149 ;; called "hello+alt.alt".
4150 (if (or (not (inline (gnus-similar-server-opened method)))
4151 (not (cddr method)))
4152 method
4153 (let ((address-slot
4154 (intern (format "%s-address" (car method)))))
4155 (setq method
4156 (if (assq address-slot (cddr method))
4157 `(,(car method) ,(concat (cadr method) "+" group)
4158 ,@(cddr method))
4159 `(,(car method) ,(concat (cadr method) "+" group)
4160 (,address-slot ,(cadr method))
4161 ,@(cddr method))))
4162 (push method gnus-extended-servers)
4163 method)))
4165 (defun gnus-server-status (method)
4166 "Return the status of METHOD."
4167 (nth 1 (assoc method gnus-opened-servers)))
4169 (defun gnus-group-name-to-method (group)
4170 "Guess a select method based on GROUP."
4171 (if (string-match ":" group)
4172 (let ((server (substring group 0 (match-beginning 0))))
4174 (list (intern (substring server 0 (match-beginning 0)))
4175 (substring server (match-end 0)))
4176 (list (intern server) "")))
4177 gnus-select-method))
4179 (defun gnus-server-string (server)
4180 "Return a readable string that describes SERVER."
4181 (let* ((server (gnus-server-to-method server))
4182 (address (nth 1 server)))
4183 (if (and address
4184 (not (zerop (length address))))
4185 (format "%s using %s" address (car server))
4186 (format "%s" (car server)))))
4188 (defun gnus-same-method-different-name (method)
4189 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4190 (unless (assq slot (cddr method))
4191 (setq method
4192 (append method (list (list slot (nth 1 method)))))))
4193 (let ((methods gnus-extended-servers)
4194 open found)
4195 (while (and (not found)
4196 (setq open (pop methods)))
4197 (when (and (eq (car method) (car open))
4198 (gnus-sloppily-equal-method-parameters method open))
4199 (setq found open)))
4200 found))
4202 (defun gnus-find-method-for-group (group &optional info)
4203 "Find the select method that GROUP uses."
4204 (or gnus-override-method
4205 (and (not group)
4206 gnus-select-method)
4207 (and (not (gnus-group-entry group))
4208 ;; Killed or otherwise unknown group.
4209 (or
4210 ;; If we know a virtual server by that name, return its method.
4211 (gnus-server-to-method (gnus-group-server group))
4212 ;; Guess a new method as last resort.
4213 (gnus-group-name-to-method group)))
4214 (let ((info (or info (gnus-get-info group)))
4215 method)
4216 (if (or (not info)
4217 (not (setq method (gnus-info-method info)))
4218 (equal method "native"))
4219 gnus-select-method
4220 (setq method
4221 (cond ((stringp method)
4222 (inline (gnus-server-to-method method)))
4223 ((stringp (cadr method))
4224 (or
4225 (inline
4226 (gnus-same-method-different-name method))
4227 (inline (gnus-server-extend-method group method))))
4228 (t
4229 method)))
4230 (cond ((equal (cadr method) "")
4231 method)
4232 ((null (cadr method))
4233 (list (car method) ""))
4234 (t
4235 (gnus-server-add-address method)))))))
4237 (defun gnus-methods-using (feature)
4238 "Find all methods that have FEATURE."
4239 (let ((valids gnus-valid-select-methods)
4240 outs)
4241 (while valids
4242 (when (memq feature (car valids))
4243 (push (car valids) outs))
4244 (setq valids (cdr valids)))
4245 outs))
4247 (autoload 'message-y-or-n-p "message" nil nil 'macro)
4249 (defun gnus-read-group (prompt &optional default)
4250 "Prompt the user for a group name.
4251 Disallow invalid group names."
4252 (let ((prefix "")
4253 group)
4254 (while (not group)
4255 (when (string-match
4256 gnus-invalid-group-regexp
4257 (setq group (read-string (concat prefix prompt)
4258 (cons (or default "") 0)
4259 'gnus-group-history)))
4260 (let ((match (match-string 0 group)))
4261 ;; Might be okay (e.g. for nnimap), so ask the user:
4263 (message-y-or-n-p
4264 "Proceed and create group anyway? " t
4267 Usually, it's dangerous to create a group with this name, because it's not
4268 supported by all back ends and servers. On IMAP servers it should work,
4269 though. If you are really sure, you can proceed anyway and create the group.
4271 You may customize the variable `gnus-invalid-group-regexp', which currently is
4275 group nil)))))
4276 group))
4278 (defun gnus-read-method (prompt)
4279 "Prompt the user for a method.
4280 Allow completion over sensible values."
4281 (let* ((open-servers
4282 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4283 gnus-opened-servers))
4284 (valid-methods
4285 (let (methods)
4286 (dolist (method gnus-valid-select-methods)
4287 (if (or (memq 'prompt-address method)
4288 (not (assoc (format "%s:" (car method)) open-servers)))
4289 (push method methods)))
4290 methods))
4291 (servers
4292 (append valid-methods
4293 open-servers
4294 gnus-predefined-server-alist
4295 gnus-server-alist))
4296 (method
4297 (gnus-completing-read
4298 prompt (mapcar 'car servers)
4299 t nil 'gnus-method-history)))
4300 (cond
4301 ((equal method "")
4302 (setq method gnus-select-method))
4303 ((assoc method gnus-valid-select-methods)
4304 (let ((address (if (memq 'prompt-address
4305 (assoc method gnus-valid-select-methods))
4306 (read-string "Address: ")
4307 "")))
4308 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4309 (list (intern method) address))))
4310 ((assoc method servers)
4311 method)
4312 (t
4313 (list (intern method) "")))))
4315 ;;; Agent functions
4317 (defun gnus-agent-method-p (method-or-server)
4318 "Say whether METHOD is covered by the agent."
4319 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4320 (let* ((method (if (stringp method-or-server)
4321 (gnus-server-to-method method-or-server)
4322 method-or-server))
4323 (server (gnus-method-to-server method t)))
4324 (setq gnus-agent-method-p-cache
4325 (cons method-or-server
4326 (member server gnus-agent-covered-methods)))))
4327 (cdr gnus-agent-method-p-cache))
4329 (defun gnus-online (method)
4330 (not
4331 (if gnus-plugged
4332 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4333 (gnus-agent-method-p method))))
4335 ;;; User-level commands.
4337 ;;;###autoload
4338 (defun gnus-slave-no-server (&optional arg)
4339 "Read network news as a slave, without connecting to the local server."
4340 (interactive "P")
4341 (gnus-no-server arg t))
4343 ;;;###autoload
4344 (defun gnus-no-server (&optional arg slave)
4345 "Read network news.
4346 If ARG is a positive number, Gnus will use that as the startup
4347 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4348 non-nil and not a positive number, Gnus will prompt the user for the
4349 name of an NNTP server to use.
4350 As opposed to `gnus', this command will not connect to the local
4351 server."
4352 (interactive "P")
4353 (gnus-no-server-1 arg slave))
4355 ;;;###autoload
4356 (defun gnus-slave (&optional arg)
4357 "Read news as a slave."
4358 (interactive "P")
4359 (gnus arg nil 'slave))
4361 (defun gnus-delete-gnus-frame ()
4362 "Delete gnus frame unless it is the only one.
4363 Used for `gnus-exit-gnus-hook' in `gnus-other-frame'."
4364 (when (and (frame-live-p gnus-other-frame-object)
4365 (cdr (frame-list)))
4366 (delete-frame gnus-other-frame-object))
4367 (setq gnus-other-frame-object nil))
4369 ;;;###autoload
4370 (defun gnus-other-frame (&optional arg display)
4371 "Pop up a frame to read news.
4372 This will call one of the Gnus commands which is specified by the user
4373 option `gnus-other-frame-function' (default `gnus') with the argument
4374 ARG if Gnus is not running, otherwise pop up a Gnus frame and run the
4375 command specified by `gnus-other-frame-resume-function'.
4376 The optional second argument DISPLAY should be a standard display string
4378 omitted or the function `make-frame-on-display' is not available, the
4379 current display is used."
4380 (interactive "P")
4381 (if (fboundp 'make-frame-on-display)
4382 (unless display
4383 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4384 (setq display nil))
4385 (let ((alive (gnus-alive-p)))
4386 (unless (and alive
4387 (catch 'found
4388 (walk-windows
4389 (lambda (window)
4390 (when (and (or (not display)
4391 (equal display
4392 (gnus-frame-or-window-display-name
4393 window)))
4394 (with-current-buffer (window-buffer window)
4396 (symbol-name major-mode))))
4397 (gnus-select-frame-set-input-focus
4398 (setq gnus-other-frame-object (window-frame window)))
4399 (select-window window)
4400 (throw 'found t)))
4401 'ignore t)))
4402 (gnus-select-frame-set-input-focus
4403 (setq gnus-other-frame-object
4404 (if display
4405 (make-frame-on-display display gnus-other-frame-parameters)
4406 (make-frame gnus-other-frame-parameters))))
4407 (if alive
4408 (progn (switch-to-buffer gnus-group-buffer)
4409 (funcall gnus-other-frame-resume-function arg))
4410 (funcall gnus-other-frame-function arg)
4411 (add-hook 'gnus-exit-gnus-hook 'gnus-delete-gnus-frame)
4412 ;; One might argue that `gnus-delete-gnus-frame' should not be called
4413 ;; from `gnus-suspend-gnus-hook', but, on the other hand, one might
4414 ;; argue that it should. No matter what you think, for the sake of
4415 ;; those who want it to be called from it, please keep (defun
4416 ;; gnus-delete-gnus-frame) even if you remove the next `add-hook'.
4417 (add-hook 'gnus-suspend-gnus-hook 'gnus-delete-gnus-frame)))))
4419 ;;;###autoload
4420 (defun gnus (&optional arg dont-connect slave)
4421 "Read network news.
4422 If ARG is non-nil and a positive number, Gnus will use that as the
4423 startup level. If ARG is non-nil and not a positive number, Gnus will
4424 prompt the user for the name of an NNTP server to use."
4425 (interactive "P")
4426 ;; When using the development version of Gnus, load the gnus-load
4427 ;; file.
4428 (unless (string-match "^Gnus" gnus-version)
4429 (load "gnus-load" nil t))
4430 (unless (byte-code-function-p (symbol-function 'gnus))
4431 (message "You should byte-compile Gnus")
4432 (sit-for 2))
4433 (let ((gnus-action-message-log (list nil)))
4434 (gnus-1 arg dont-connect slave)
4435 (gnus-final-warning)))
4437 (declare-function debbugs-gnu "ext:debbugs-gnu"
4438 (severities &optional packages archivedp suppress tags))
4440 (defun gnus-list-debbugs ()
4441 "List all open Gnus bug reports."
4442 (interactive)
4443 (require 'debbugs-gnu)
4444 (debbugs-gnu nil "gnus"))
4446 ;; Allow redefinition of Gnus functions.
4448 (gnus-ems-redefine)
4450 (provide 'gnus)
4452 ;;; gnus.el ends here