| blob | bd78c6aef35a090821f6570bf135996dfcb5d555 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; Keywords: news, mail
10 ;; Version: 5.13
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;;; Code:
33 ;; For Emacs <22.2 and XEmacs.
42 ;; These are defined afterwards with gnus-define-group-parameter
56 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
61 "Starting your favorite newsreader."
65 "Dealing with formatting issues."
69 "Group character set issues."
75 "Cache interface."
80 "Article Registry."
84 "Server options at startup."
87 ;; These belong to gnus-group.el.
89 "Group buffers."
94 "Foreign groups."
99 "Automatic subscription of new groups."
103 "Group levels."
108 "Selecting a Group."
113 "Showing slices of the group list."
118 "Sorting the group buffer."
124 "Various group options."
128 ;; These belong to gnus-sum.el.
130 "Summary buffers."
135 "Leaving summary buffers."
140 "Marks used in summary buffers."
145 "Ordering articles according to replies."
150 "Formatting of the summary buffer."
155 "Choosing Articles."
160 "Summary movement commands."
165 "Show pictures of people, domains, and newsgroups."
169 "Mail group commands."
174 "Sorting the summary buffer."
179 "Highlighting and menus in the summary buffer."
185 "Various summary buffer options."
190 "Pick mode in the summary buffer."
196 "Tree display of threads in the summary buffer."
201 ;; Belongs to gnus-uu.el
203 "Viewing extracted files."
207 ;; Belongs to gnus-score.el
209 "Score and kill file handling."
213 "Kill files."
217 "Adaptive score files."
221 "Default values for score files."
225 "Expiring score rules."
229 "Decaying score rules."
233 "Score and kill file names."
238 "Various scoring and killing options."
241 ;; Other
243 "Options controlling the visual fluff."
248 "Offline support for Gnus."
252 "Files used by Gnus."
256 "Auto save file."
261 "Storing Gnus state."
265 "Options related to newsservers and other servers used by Gnus."
269 "Highlighting and menus in the server buffer."
274 "Composing replies and followups in Gnus."
278 "Meta variables controlling major portions of Gnus.
279 In general, modifying these variables does not take affect until Gnus
280 is restarted, and sometimes reloaded."
284 "Other Gnus options."
289 "Exiting Gnus."
294 "Frivolous Gnus extensions."
305 "If non-nil, the startup message will not be displayed.
306 This variable is used before `.gnus.el' is loaded, so it should
307 be set in `.emacs' instead."
339 0 5
348 gnus-mode-line-image-cache)
350 "This is %s, %s."
352 str)
354 line)))
360 ;;(defalias 'gnus-decode-rfc1522 'ignore)
361 )
363 ;; We define these group faces here to avoid the display
364 ;; update forced when creating new faces.
374 ()))
375 "Level 1 newsgroup face."
377 ;; backward-compatibility alias
389 ()))
390 "Level 1 empty newsgroup face."
392 ;; backward-compatibility alias
404 ()))
405 "Level 2 newsgroup face."
407 ;; backward-compatibility alias
419 ()))
420 "Level 2 empty newsgroup face."
422 ;; backward-compatibility alias
434 ()))
435 "Level 3 newsgroup face."
437 ;; backward-compatibility alias
444 ())
447 ())
449 ()))
450 "Level 3 empty newsgroup face."
452 ;; backward-compatibility alias
464 ()))
465 "Level 4 newsgroup face."
467 ;; backward-compatibility alias
474 ())
477 ())
479 ()))
480 "Level 4 empty newsgroup face."
482 ;; backward-compatibility alias
494 ()))
495 "Level 5 newsgroup face."
497 ;; backward-compatibility alias
504 ())
507 ())
509 ()))
510 "Level 5 empty newsgroup face."
512 ;; backward-compatibility alias
524 ()))
525 "Level 6 newsgroup face."
527 ;; backward-compatibility alias
534 ())
537 ())
539 ()))
540 "Level 6 empty newsgroup face."
542 ;; backward-compatibility alias
554 ()))
555 "Low level newsgroup face."
557 ;; backward-compatibility alias
569 ()))
570 "Low level empty newsgroup face."
572 ;; backward-compatibility alias
585 "Level 1 mailgroup face."
587 ;; backward-compatibility alias
600 "Level 1 empty mailgroup face."
602 ;; backward-compatibility alias
615 "Level 2 mailgroup face."
617 ;; backward-compatibility alias
630 "Level 2 empty mailgroup face."
632 ;; backward-compatibility alias
645 "Level 3 mailgroup face."
647 ;; backward-compatibility alias
659 ()))
660 "Level 3 empty mailgroup face."
662 ;; backward-compatibility alias
675 "Low level mailgroup face."
677 ;; backward-compatibility alias
690 "Low level empty mailgroup face."
692 ;; backward-compatibility alias
696 ;; Summary mode faces.
699 "Face used for selected articles."
701 ;; backward-compatibility alias
708 "Face used for cancelled articles."
710 ;; backward-compatibility alias
723 "Face used for high interest ticked articles."
725 ;; backward-compatibility alias
738 "Face used for low interest ticked articles."
740 ;; backward-compatibility alias
752 ()))
753 "Face used for normal interest ticked articles."
755 ;; backward-compatibility alias
768 "Face used for high interest ancient articles."
770 ;; backward-compatibility alias
783 "Face used for low interest ancient articles."
785 ;; backward-compatibility alias
797 ()))
798 "Face used for normal interest ancient articles."
800 ;; backward-compatibility alias
811 "Face used for high interest uncached articles."
813 ;; backward-compatibility alias
824 "Face used for low interest uncached articles."
826 ;; backward-compatibility alias
837 "Face used for normal interest uncached articles."
839 ;; backward-compatibility alias
846 "Face used for high interest unread articles."
848 ;; backward-compatibility alias
855 "Face used for low interest unread articles."
857 ;; backward-compatibility alias
863 ()))
864 "Face used for normal interest unread articles."
866 ;; backward-compatibility alias
881 "Face used for high interest read articles."
883 ;; backward-compatibility alias
898 "Face used for low interest read articles."
900 ;; backward-compatibility alias
912 ()))
913 "Face used for normal interest read articles."
915 ;; backward-compatibility alias
920 ;;;
921 ;;; Gnus buffers
922 ;;;
927 "Do the same as `get-buffer-create', but store the created buffer."
932 "Add the current buffer to the list of Gnus buffers."
936 "Kill BUFFER and remove from the list of Gnus buffers."
943 "Return a list of live Gnus buffers."
952 gnus-buffers)
954 ;;; Splash screen.
966 ()))
967 "Face for the splash screen."
969 ;; backward-compatibility alias
983 "Indent rigidly using only spaces and no tabs."
989 ;; We translate tabs into spaces -- not everybody uses
990 ;; an 8-character tab.
997 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1021 "*Color styles used for the Gnus logo."
1023 gnus-logo-color-alist))
1033 "Insert startup message in current buffer."
1034 ;; Insert the message.
1040 ;; Make sure the library defining `image-load-path' is loaded
1041 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1042 ;; get "defvar ignored because image-load-path is let-bound" when calling
1043 ;; `find-image' below.
1053 :color-symbols
1061 ;; Account for the pbm's blackground.
1065 ;; Account for the xbm's blackground.
1076 t))))
1080 _ ___ _ _
1081 _ ___ __ ___ __ _ ___
1082 __ _ ___ __ ___
1083 _ ___ _
1084 _ _ __ _
1085 ___ __ _
1086 __ _
1087 _ _ _
1088 _ _ _
1089 _ _ _
1090 __ ___
1091 _ _ _ _
1092 _ _
1093 _ _
1094 _ _
1095 _
1096 __
1098 "
1100 ;; And then hack it.
1109 ;; Fontify some.
1123 ;;; Do the rest.
1129 "Alist of group parameters.
1131 For example:
1133 (gnus-use-scoring nil)
1134 (gnus-summary-line-format
1136 (gcc-self . t)
1137 (display . all))
1140 (broken-reply-to . t)))"
1147 "If it is t, ignore case of group names specified in `gnus-parameters'.
1148 If it is nil, don't ignore case. If it is `default', which is for the
1149 backward compatibility, use the value of `case-fold-search'."
1160 "Define a group parameter PARAM.
1161 REST is a plist of following:
1162 :type One of `bool', `list' or nil.
1163 :function The name of the function.
1164 :function-document The documentation of the function.
1165 :parameter-type The type for customizing the parameter.
1166 :parameter-document The documentation for the parameter.
1167 :variable The name of the variable.
1168 :variable-document The documentation for the variable.
1169 :variable-group The group for customizing the variable.
1170 :variable-type The type for customizing the variable.
1171 :variable-default The default value of the variable."
1188 'progn
1190 ,variable-document
1196 gnus-group-parameters-more))
1199 ,parameter-type
1203 ,function-document
1205 val)
1208 t)
1213 (,variable
1215 elem value)
1223 ,function-document
1227 elem value)
1234 'value
1239 All other Gnus file and directory variables are initialized from this variable."
1245 "*Directory variable from which all other Gnus file variables are derived.
1247 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1248 This means that other directory variables that are initialized from
1249 this variable won't be set properly if you set this variable in `.gnus.el'.
1250 Set this variable in `.emacs' instead."
1255 "*Default directory for all Gnus buffers."
1258 directory))
1260 ;; Site dependent variables. These variables should be defined in
1261 ;; paths.el.
1264 "Specify a default NNTP server.
1265 This variable should be defined in paths.el, and should never be set
1266 by the user.
1267 If you want to change servers, you should use `gnus-select-method'.
1270 ;; Don't touch this variable.
1273 This is an obsolete variable, which is scarcely used. If you use an
1274 nntp server for your newsgroup and want to change the port number
1275 used to 899, you would say something along these lines:
1280 "A file with only the name of the nntp server in it."
1286 "Find default nntp server.
1287 Check the NNTPSERVER environment variable and the
1288 `gnus-nntpserver-file' file."
1296 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1297 ;; starting or even loading Gnus.
1298 ;;;###autoload(when (fboundp 'custom-autoload)
1299 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1309 gnus-default-nntp-server)
1313 nil
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."
1339 "*Method used for archiving messages you've sent.
1340 This should be a mail method.
1342 See also `gnus-update-message-archive-method'."
1346 gnus-select-method))
1351 The archive method is initially set according to the value of
1353 so that it may be used as a real method of the server which is named
1355 updated if the value of this variable is nil, even if you change the
1356 value of `gnus-message-archive-method' afterward. If you want the
1358 `gnus-message-archive-method', set this variable to a non-nil value."
1365 "*Name of the group in which to save the messages you've written.
1366 This can either be a string; a list of strings; or an alist
1367 of regexps/functions/forms to be evaluated to return a string (or a list
1368 of strings). The functions are called with the name of the current
1369 group (or nil) as a parameter.
1371 If you want to save your mail in one group and the news articles you
1372 write in another group, you could say something like:
1374 \(setq gnus-message-archive-group
1375 '((if (message-news-p)
1379 Normally the group names returned by this variable should be
1381 However, you may wish to store the message on some other server. In
1382 that case, just return a fully prefixed name of the group --
1390 function
1391 sexp
1392 string))
1395 "List of NNTP servers that the user can choose between interactively.
1396 To make Gnus query you for a server, you have to give `gnus' a
1397 non-numeric prefix - `C-u M-x gnus', in short."
1402 "*The name of the host running the NNTP server.
1403 This variable is semi-obsolete. Use the `gnus-select-method'
1404 variable instead."
1407 string))
1410 "A list of secondary methods that will be used for reading news.
1411 This is a list where each element is a complete select method (see
1412 `gnus-select-method').
1414 If, for instance, you want to read your mail with the nnml back end,
1415 you could set this variable:
1423 "Default default new newsgroups the first time Gnus is run.
1427 "Local domain name without a host name.
1428 The DOMAINNAME environment variable is used instead if it is defined.
1429 If the function `system-name' returns the full Internet name, there is
1430 no need to set this variable."
1433 string))
1437 "String with a description of what organization (if any) the user belongs to.
1440 ;; Customization variables
1443 "Preferred method for fetching an article by Message-ID.
1444 If you are reading news from the local spool (with nnspool), fetching
1445 articles by Message-ID is painfully slow. By setting this method to an
1446 nntp method, you might get acceptable results.
1448 The value of this variable must be a valid select method as discussed
1449 in the documentation of `gnus-select-method'.
1451 It can also be a list of select methods, as well as the special symbol
1452 `current', which means to use the current select method. If it is a
1453 list, Gnus will try all the methods in the list until it finds a match."
1459 gnus-select-method
1467 gnus-select-method))))
1470 "*Non-nil means that control messages are displayed using `browse-url'.
1471 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1472 group."
1478 "*Non-nil means that cross referenced articles will be marked as read.
1479 If nil, ignore cross references. If t, mark articles as read in
1480 subscribed newsgroups. If neither t nor nil, mark as read in all
1481 newsgroups."
1489 "*Process mark."
1495 "*The number of articles which indicates a large newsgroup.
1496 If the number of articles in a newsgroup is greater than this value,
1497 confirmation is required for selecting the newsgroup.
1498 If it is nil, no confirmation is required.
1500 Also see `gnus-large-ephemeral-newsgroup'."
1503 integer))
1506 "*Non-nil means that the default name of a file to save articles in is the group name.
1507 If it's nil, the directory form of the group name is used instead.
1509 If this variable is a list, and the list contains the element
1510 `not-score', long file names will not be used for score files; if it
1511 contains the element `not-save', long file names will not be used for
1512 saving; and if it contains the element `not-kill', long file names
1513 will not be used for kill files.
1515 Note that the default for this variable varies according to what system
1516 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1517 to nil while on all other systems it defaults to t."
1535 "*If non-nil, save group scoring info."
1541 "*If non-nil, allow undoing in Gnus group mode buffers."
1546 "*If non-nil, use some adaptive scoring scheme.
1547 If a list, then the values `word' and `line' are meaningful. The
1548 former will perform adaption on individual words in the subject
1549 header while `line' will perform adaption on several headers."
1555 "*If nil, Gnus will ignore the article cache.
1556 If `passive', it will allow entering (and reading) articles
1557 explicitly entered into the cache. If anything else, use the
1558 cache to the full extent of the law."
1566 "*If non-nil, display a thread tree buffer."
1571 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1572 If it is a number N, then Gnus will only keep the last N articles
1573 read. If it is neither nil nor a number, Gnus will keep all read
1574 articles. This is not a good idea."
1577 integer
1582 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1587 "*If non-nil, enable scoring."
1593 "*A hook called when preparing to exit from the summary buffer.
1594 It calls `gnus-summary-expire-articles' by default."
1599 "*Non-nil means that you are a Usenet novice.
1600 If non-nil, verbose messages may be displayed and confirmations may be
1601 required."
1606 "*Non-nil means that you will never be asked for confirmation about anything.
1607 That doesn't mean *anything* anything; particularly destructive
1608 commands will still require prompting."
1613 "*If non-nil, require your confirmation when catching up a group."
1618 "*If non-nil, require your confirmation when exiting Gnus."
1623 "*Function for extracting address components from a From header.
1624 Two pre-defined function exist: `gnus-extract-address-components',
1625 which is the default, quite fast, and too simplistic solution, and
1626 `mail-extract-address-components', which works much better, but is
1627 slower."
1634 "String used to separate shell commands."
1658 "*An alist of valid select methods.
1659 The first element of each list lists should be a string with the name
1660 of the select method. The other elements may be the category of
1661 this method (i. e., `post', `mail', `none' or whatever) or other
1662 properties that this method has (like being respoolable).
1663 If you implement a new select method, all you should have to change is
1664 this variable. I think."
1680 "Recomputes the select-method widget based on the value of
1681 `gnus-valid-select-methods'."
1683 "Widget for entering a select method."
1690 gnus-valid-select-methods)
1694 :inline t
1696 variable
1702 "List of buffers that should update their mode lines.
1703 The list may contain the symbols `group', `article', `tree' and
1704 `summary'. If the corresponding symbol is present, Gnus will keep
1705 that mode line updated with information that may be pertinent.
1706 If this variable is nil, screen refresh may be quicker."
1714 "*Max length of mode-line non-string contents.
1715 If this is nil, Gnus will take space as is needed, leaving the rest
1716 of the mode line intact."
1720 integer))
1722 ;; There should be special validation for this.
1727 to-address
1728 :function-document
1729 "Return GROUP's to-address."
1730 :variable-document
1731 "*Alist of group regexps and correspondent to-addresses."
1732 :variable-group gnus-group-parameter
1735 This will be used when doing followups and posts.
1737 This is primarily useful in mail groups that represent closed
1738 mailing lists--mailing lists where it's expected that everybody that
1739 writes to the mailing list is subscribed to it. Since using this
1740 parameter ensures that the mail only goes to the mailing list itself,
1741 it means that members won't receive two copies of your followups.
1743 Using `to-address' will actually work whether the group is foreign or
1744 not. Let's say there's a group on the server that is called
1745 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1746 articles from a mail-to-news gateway. Posting directly to this group
1747 is therefore impossible--you have to send mail to the mailing list
1748 address instead.
1750 The gnus-group-split mail splitting mechanism will behave as if this
1754 to-list
1755 :function-document
1756 "Return GROUP's to-list."
1757 :variable-document
1758 "*Alist of group regexps and correspondent to-lists."
1759 :variable-group gnus-group-parameter
1762 This address will be used when doing a `a' in the group.
1764 It is totally ignored when doing a followup--except that if it is
1765 present in a news group, you'll get mail group semantics when doing
1766 `f'.
1768 The gnus-group-split mail splitting mechanism will behave as if this
1772 subscribed
1773 :type bool
1774 :function-document
1775 "Return GROUP's subscription status."
1776 :variable-document
1777 "*Groups which are automatically considered subscribed."
1778 :variable-group gnus-group-parameter
1781 Gnus assumed that you are subscribed to the To/List address.
1783 When constructing a list of subscribed groups using
1784 `gnus-find-subscribed-addresses', Gnus includes the To address given
1788 auto-expire
1789 :type bool
1790 :function gnus-group-auto-expirable-p
1791 :function-document
1792 "Check whether GROUP is auto-expirable or not."
1793 :variable gnus-auto-expirable-newsgroups
1794 :variable-default nil
1795 :variable-document
1796 "*Groups in which to automatically mark read articles as expirable.
1797 If non-nil, this should be a regexp that should match all groups in
1798 which to perform auto-expiry. This only makes sense for mail groups."
1799 :variable-group nnmail-expire
1801 regexp)
1803 :parameter-document
1807 total-expire
1808 :type bool
1809 :function gnus-group-total-expirable-p
1810 :function-document
1811 "Check whether GROUP is total-expirable or not."
1812 :variable gnus-total-expirable-newsgroups
1813 :variable-default nil
1814 :variable-document
1815 "*Groups in which to perform expiry of all read articles.
1816 Use with extreme caution. All groups that match this regexp will be
1817 expiring - which means that all read articles will be deleted after
1818 \(say) one week. (This only goes for mail groups and the like, of
1819 course.)"
1820 :variable-group nnmail-expire
1822 regexp)
1824 :parameter-document
1825 "All read articles will be put through the expiry process
1827 This happens even if they are not marked as expirable.
1831 charset
1832 :function-document
1833 "Return the default charset of GROUP."
1834 :variable gnus-group-charset-alist
1835 :variable-default
1848 :variable-document
1849 "Alist of regexps (to match group names) and default charsets to be used when reading."
1850 :variable-group gnus-charset
1858 post-method
1859 :type list
1860 :function-document
1861 "Return a posting method for GROUP."
1862 :variable gnus-post-method-alist
1863 :variable-document
1864 "Alist of regexps (to match group names) and method to be used when
1865 posting an article."
1866 :variable-group gnus-group-foreign
1867 :parameter-type
1875 :parameter-document
1879 large-newsgroup-initial
1880 :type integer
1881 :function-document
1882 "Return GROUP's initial input of the number of articles."
1883 :variable-document
1884 "*Alist of group regexps and its initial input of the number of articles."
1885 :variable-group gnus-group-parameter
1891 This number will be prompted as the initial value of the number of
1892 articles to list when the group is a large newsgroup (see
1893 `gnus-large-newsgroup'). If it is nil, the default value is the
1896 ;; The Gnus registry's ignored groups
1898 registry-ignore
1899 :type list
1900 :function-document
1901 "Whether this group should be ignored by the registry."
1902 :variable gnus-registry-ignored-groups
1903 :variable-default nil
1904 :variable-document
1905 "*Groups in which the registry should be turned off."
1906 :variable-group gnus-registry
1913 :parameter-document
1916 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1918 "*Disable the group parameters for spam detection.
1919 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1926 "Spam group classification (requires spam.el).
1927 This group contains spam messages. On summary entry, unread messages
1928 will be marked as spam. On summary exit, the specified spam
1929 processors will be invoked on spam-marked messages, then those
1930 messages will be expired, so the spam processor will only see a
1934 "The ham value for the spam group parameter (requires spam.el).
1935 On summary exit, the specified ham processors will be invoked on
1936 ham-marked messages. Exercise caution, since the ham processor will
1937 see the same message more than once because there is no ham message
1941 spam-contents
1942 :type list
1943 :function-document
1944 "The spam type (spam, ham, or neither) of the group."
1945 :variable gnus-spam-newsgroup-contents
1946 :variable-default nil
1947 :variable-document
1948 "*Group classification (spam, ham, or neither). Only
1949 meaningful when spam.el is loaded. If non-nil, this should be a
1950 list of group name regexps associated with a classification for
1951 each one. In spam groups, new articles are marked as spam on
1952 summary entry. There is other behavior associated with ham and
1953 no classification when spam.el is loaded - see the manual."
1954 :variable-group spam
1968 :parameter-document
1969 "The spam classification (spam, ham, or neither) of this group.
1970 When a spam group is entered, all unread articles are marked as
1971 spam. There is other behavior associated with ham and no
1975 spam-resend-to
1976 :type list
1977 :function-document
1978 "The address to get spam resent (through spam-report-resend)."
1979 :variable gnus-spam-resend-to
1980 :variable-default nil
1981 :variable-document
1982 "The address to get spam resent (through spam-report-resend)."
1983 :variable-group spam
1987 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1988 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1989 :parameter-document
1993 ham-resend-to
1994 :type list
1995 :function-document
1996 "The address to get ham resent (through spam-report-resend)."
1997 :variable gnus-ham-resend-to
1998 :variable-default nil
1999 :variable-document
2000 "The address to get ham resent (through spam-report-resend)."
2001 :variable-group spam
2005 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2006 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2007 :parameter-document
2023 "OBSOLETE: The Gmane reporting summary exit spam processor.
2030 "OBSOLETE: The ifile summary exit ham processor.
2034 "OBSOLETE: The Bogofilter summary exit ham processor.
2038 "OBSOLETE: The spam-stat summary exit ham processor.
2042 "OBSOLETE: The whitelist summary exit ham processor.
2046 "OBSOLETE: The BBDB summary exit ham processor.
2050 "OBSOLETE: The ham copy exit ham processor.
2054 "OBSOLETE: The spamoracle summary exit ham processor.
2058 spam-process
2059 :type list
2060 :parameter-type
2063 :value nil
2100 :function-document
2101 "Which spam or ham processors will be applied when the summary is exited."
2102 :variable gnus-spam-process-newsgroups
2103 :variable-default nil
2104 :variable-document
2105 "*Groups in which to automatically process spam or ham articles with
2106 a backend on summary exit. If non-nil, this should be a list of group
2107 name regexps that should match all groups in which to do automatic
2108 spam processing, associated with the appropriate processor."
2109 :variable-group spam
2110 :variable-type
2151 :parameter-document
2155 spam-autodetect
2156 :type list
2157 :parameter-type
2159 :function-document
2160 "Should spam be autodetected (with spam-split) in this group?"
2161 :variable gnus-spam-autodetect
2162 :variable-default nil
2163 :variable-document
2164 "*Groups in which spam should be autodetected when they are entered.
2165 Only unseen articles will be examined, unless
2166 spam-autodetect-recheck-messages is set."
2167 :variable-group spam
2168 :variable-type
2173 boolean))
2174 :parameter-document
2175 "Spam autodetection.
2176 Only unseen articles will be examined, unless
2180 spam-autodetect-methods
2181 :type list
2182 :parameter-type
2205 :function-document
2206 "Methods to be used for autodetection in each group"
2207 :variable gnus-spam-autodetect-methods
2208 :variable-default nil
2209 :variable-document
2210 "*Methods for autodetecting spam per group.
2211 Requires the spam-autodetect parameter. Only unseen articles
2212 will be examined, unless spam-autodetect-recheck-messages is
2213 set."
2214 :variable-group spam
2215 :variable-type
2242 :parameter-document
2243 "Spam autodetection methods.
2244 Requires the spam-autodetect parameter. Only unseen articles
2245 will be examined, unless spam-autodetect-recheck-messages is
2249 spam-process-destination
2250 :type list
2251 :parameter-type
2257 :function-document
2258 "Where spam-processed articles will go at summary exit."
2259 :variable gnus-spam-process-destinations
2260 :variable-default nil
2261 :variable-document
2262 "*Groups in which to explicitly send spam-processed articles to
2263 another group, or expire them (the default). If non-nil, this should
2264 be a list of group name regexps that should match all groups in which
2265 to do spam-processed article moving, associated with the destination
2266 group or nil for explicit expiration. This only makes sense for
2267 mail groups."
2268 :variable-group spam
2269 :variable-type
2280 :parameter-document
2284 ham-process-destination
2285 :type list
2286 :parameter-type
2294 :function-document
2295 "Where ham articles will go at summary exit from a spam group."
2296 :variable gnus-ham-process-destinations
2297 :variable-default nil
2298 :variable-document
2299 "*Groups in which to explicitly send ham articles to
2300 another group, or do nothing (the default). If non-nil, this should
2301 be a list of group name regexps that should match all groups in which
2302 to do ham article moving, associated with the destination
2303 group or nil for explicit ignoring. This only makes sense for
2304 mail groups, and only works in spam groups."
2305 :variable-group spam
2306 :variable-type
2318 :parameter-document
2322 ham-marks
2333 :parameter-document
2334 "Marks considered ham (positively not spam). Such articles will be
2335 processed as ham (non-spam) on group exit. When nil, the global
2336 spam-ham-marks variable takes precedence."
2338 gnus-read-mark
2339 gnus-killed-mark
2340 gnus-kill-file-mark
2341 gnus-low-score-mark))))
2342 :variable-group spam
2343 :variable-document
2347 spam-marks
2356 :parameter-document
2357 "Marks considered spam.
2358 Such articles will be processed as spam on group exit. When nil, the global
2359 spam-spam-marks variable takes precedence."
2361 :variable-group spam
2362 :variable-document
2366 "Number of group name elements to leave alone when making a short group name."
2371 "*If non-nil, once you set a level, Gnus will use this level."
2375 ;; Hooks.
2378 "A hook run while Gnus is loaded."
2383 "A hook called to apply kill files to a group.
2384 This hook is intended to apply a kill file to the selected newsgroup.
2385 The function `gnus-apply-kill-file' is called by default.
2387 Since a general kill file is too heavy to use only for a few
2388 newsgroups, I recommend you to use a lighter hook function. For
2389 example, if you'd like to apply a kill file to articles which contains
2390 a string `rmgroup' in subject in newsgroup `control', you can use the
2391 following hook:
2393 (setq gnus-apply-kill-hook
2394 (list
2395 (lambda ()
2404 "Function run when a group level is changed.
2405 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2408 function))
2410 ;;; Face thingies.
2414 mouse-face
2415 summary-menu group-menu article-menu
2416 tree-highlight menu highlight
2417 browse-menu server-menu
2418 page-marker tree-menu binary-menu pick-menu)
2419 "*Enable visual features.
2420 If `visual' is disabled, there will be no menus and few faces. Most of
2421 the visual customization options below will be ignored. Gnus will use
2422 less space and be faster as a result.
2424 This variable can also be a list of visual elements to switch on. For
2425 instance, to switch off all visual things except menus, you can say:
2427 (setq gnus-visual '(menu))
2429 Valid elements include `summary-highlight', `group-highlight',
2430 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2431 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2432 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2452 ;; Byte-compiler warning.
2454 ;; Find out whether the gnus-visual TYPE is wanted.
2458 gnus-visual
2462 t))))
2472 "*Face used for group or summary buffer mouse highlighting.
2473 The line beneath the mouse pointer will be highlighted with this
2474 face."
2487 "Controls use of the agent cache while plugged.
2488 When set, Gnus will prefer using the locally stored content rather
2489 than re-fetching it from the server. You also need to enable
2490 `gnus-agent' for this to have any affect."
2496 "Default charset assumed to be used when viewing non-ASCII characters.
2497 This variable is overridden on a group-to-group basis by the
2498 `gnus-group-charset-alist' variable and is only used on groups not
2499 covered by that variable."
2503 ;; Fixme: Doc reference to agent.
2505 "Whether we want to use the Gnus agent or not.
2507 You may customize gnus-agent to disable its use. However, some
2508 back ends have started to use the agent as a client-side cache.
2509 Disabling the agent may result in noticeable loss of performance."
2515 "Function called by the command `gnus-other-frame'."
2523 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2524 This should be an alist for Emacs, or a plist for XEmacs."
2535 "Which information should be exposed in the User-Agent header.
2537 Can be a list of symbols or a string. Valid symbols are `gnus'
2538 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2539 addition to the Emacs version, you can add `codename' \(show
2540 \(S\)XEmacs codename\) or either `config' \(show system
2541 configuration\) or `type' \(show system type\). If you set it to
2542 a string, be sure to use a valid format, see RFC 2616."
2555 ;; Convert old (< 2005-01-10) symbol type values:
2574 \f
2575 ;;; Internal variables
2580 ; Reset each time gnus-agent-covered-methods is changed else
2581 ; gnus-agent-method-p may mis-report a methods status.
2582 )
2592 ;; The carpal mode has been removed, but define the variable for
2593 ;; backwards compatability.
2612 ;; Variable holding the user answers to all method prompts.
2615 ;; Variable holding the user answers to all mail method prompts.
2618 ;; Variable holding the user answers to all group prompts.
2626 "*The directory where cached articles will be stored."
2632 nnspool "cache"
2656 ;; Propagate flags to server, with the following exceptions:
2657 ;; `seen' is private to each gnus installation
2658 ;; `cache' is a internal gnus flag for each gnus installation
2659 ;; `download' is a agent flag private to each gnus installation
2660 ;; `unsend' are for nndraft groups only
2661 ;; `score' is not a proper mark
2662 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2665 "Marks that shouldn't be propagated to back ends.
2666 Typical marks are those that make no sense in a standalone back end,
2667 such as a mark that says whether an article is stored in the cache
2680 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2705 gnus-newsrc-last-checked-date
2706 gnus-newsrc-alist gnus-server-alist
2707 gnus-killed-list gnus-zombie-list
2708 gnus-topic-topology gnus-topic-alist
2709 gnus-format-specs)
2713 "Assoc list of read articles.
2717 "Assoc list of registry data.
2744 ;; Save window configuration.
2757 ;;; End of variables.
2759 ;; Define some autoload functions Gnus might use.
2762 ;; This little mapcar goes through the list below and marks the
2763 ;; symbols in question as autoloaded functions.
2783 message-send-and-exit message-yank-original)
2787 ;; This is only used in message.el, which has an autoload.
2789 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2791 ;; Next two only used in gnus-util.
2792 rmail-summary-exists rmail-select-summary)
2793 ;; Only used in gnus-util, which has an autoload.
2798 gnus-Folder-save-name gnus-folder-save-name)
2801 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2802 gnus-demon-add-disconnection gnus-demon-add-handler
2803 gnus-demon-remove-handler)
2805 gnus-demon-init gnus-demon-cancel)
2807 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2808 gnus-face-from-file)
2810 gnus-tree-open gnus-tree-close)
2812 gnus-server-server-name)
2815 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2816 gnus-article-hide-citation gnus-article-fill-cited-article
2817 gnus-article-hide-citation-in-followups)
2819 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2820 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
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)
2920 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2921 gnus-check-reasonable-setup)
2923 gnus-dup-enter-articles)
2929 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2930 gnus-async-halt-prefetch)
2932 gnus-agent-save-active gnus-agent-method-p
2933 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2934 gnus-summary-set-agent-mark gnus-agent-save-group-info
2935 gnus-agent-request-article gnus-agent-retrieve-headers)
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 %n Name of the poster (string)
2960 %a Extracted name of the poster (string)
2961 %A Extracted address of the poster (string)
2962 %F Contents of the From: header (string)
2963 %f Contents of the From: or To: headers (string)
2964 %x Contents of the Xref: header (string)
2965 %D Date of the article (string)
2966 %d Date of the article (string) in DD-MMM format
2967 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2968 %M Message-id of the article (string)
2969 %r References of the article (string)
2970 %c Number of characters in the article (integer)
2971 %k Pretty-printed version of the above (string)
2973 %L Number of lines in the article (integer)
2974 %I Indentation based on thread level (a string of spaces)
2975 %B A complex trn-style thread tree (string)
2976 The variables `gnus-sum-thread-*' can be used for customization.
2977 %T A string with two possible values: 80 spaces if the article
2978 is on thread level two or larger and 0 spaces on level one
2983 %> Spaces of length thread-level (string)
2984 %< Spaces of length (- 20 thread-level) (string)
2985 %i Article score (number)
2986 %z Article zcore (character)
2987 %t Number of articles under the current thread (number).
2988 %e Whether the thread is empty or not (character).
2989 %V Total thread score (number).
2990 %P The line number (number).
2991 %O Download mark (character).
2992 %* If present, indicates desired cursor position
2993 (instead of after first colon).
2994 %u User defined specifier. The next character in the format string should
2995 be a letter. Gnus will call the function gnus-user-format-function-X,
2996 where X is the letter following %u. The function will be passed the
2997 current header as argument. The function should return a string, which
2998 will be inserted into the summary just like information from any other
2999 summary specifier.
3001 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3002 with care. For reasons of efficiency, Gnus will compute what column
3004 it is invalid to have these specs after a variable-length spec. Well,
3005 you might not be arrested, but your summary buffer will look strange,
3006 which is bad enough.
3008 The smart choice is to have these specs as far to the left as
3009 possible.
3011 This restriction may disappear in later versions of Gnus.
3013 General format specifiers can also be used.
3014 See Info node `(gnus)Formatting Variables'."
3019 ;;;
3020 ;;; Skeleton keymaps
3021 ;;;
3026 (while keys
3027 (define-key keymap (pop keys) 'undefined))))
3029 (defvar gnus-article-mode-map
3030 (let ((keymap (make-sparse-keymap)))
3031 (gnus-suppress-keymap keymap)
3032 keymap))
3033 (defvar gnus-summary-mode-map
3034 (let ((keymap (make-keymap)))
3035 (gnus-suppress-keymap keymap)
3036 keymap))
3037 (defvar gnus-group-mode-map
3038 (let ((keymap (make-keymap)))
3039 (gnus-suppress-keymap keymap)
3040 keymap))
3042 \f
3044 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3045 ;; If you want the cursor to go somewhere else, set these two
3046 ;; functions in some startup hook to whatever you want.
3047 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3048 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3050 ;;; Various macros and substs.
3052 (defun gnus-header-from (header)
3053 (mail-header-from header))
3055 (defmacro gnus-gethash (string hashtable)
3056 "Get hash value of STRING in HASHTABLE."
3057 `(symbol-value (intern-soft ,string ,hashtable)))
3059 (defmacro gnus-gethash-safe (string hashtable)
3060 "Get hash value of STRING in HASHTABLE.
3061 Return nil if not defined."
3062 `(let ((sym (intern-soft ,string ,hashtable)))
3063 (and (boundp sym) (symbol-value sym))))
3065 (defmacro gnus-sethash (string value hashtable)
3066 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3067 `(set (intern ,string ,hashtable) ,value))
3068 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3070 (defmacro gnus-group-unread (group)
3071 "Get the currently computed number of unread articles in GROUP."
3072 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3074 (defmacro gnus-group-entry (group)
3075 "Get the newsrc entry for GROUP."
3076 `(gnus-gethash ,group gnus-newsrc-hashtb))
3078 (defmacro gnus-active (group)
3079 "Get active info on GROUP."
3080 `(gnus-gethash ,group gnus-active-hashtb))
3082 (defmacro gnus-set-active (group active)
3083 "Set GROUP's active info."
3084 `(gnus-sethash ,group ,active gnus-active-hashtb))
3086 ;; Info access macros.
3088 (defmacro gnus-info-group (info)
3089 `(nth 0 ,info))
3090 (defmacro gnus-info-rank (info)
3091 `(nth 1 ,info))
3092 (defmacro gnus-info-read (info)
3093 `(nth 2 ,info))
3094 (defmacro gnus-info-marks (info)
3095 `(nth 3 ,info))
3096 (defmacro gnus-info-method (info)
3097 `(nth 4 ,info))
3098 (defmacro gnus-info-params (info)
3099 `(nth 5 ,info))
3101 (defmacro gnus-info-level (info)
3102 `(let ((rank (gnus-info-rank ,info)))
3103 (if (consp rank)
3104 (car rank)
3105 rank)))
3106 (defmacro gnus-info-score (info)
3107 `(let ((rank (gnus-info-rank ,info)))
3108 (or (and (consp rank) (cdr rank)) 0)))
3110 (defmacro gnus-info-set-group (info group)
3111 `(setcar ,info ,group))
3112 (defmacro gnus-info-set-rank (info rank)
3113 `(setcar (nthcdr 1 ,info) ,rank))
3114 (defmacro gnus-info-set-read (info read)
3115 `(setcar (nthcdr 2 ,info) ,read))
3116 (defmacro gnus-info-set-marks (info marks &optional extend)
3117 (if extend
3118 `(gnus-info-set-entry ,info ,marks 3)
3119 `(setcar (nthcdr 3 ,info) ,marks)))
3120 (defmacro gnus-info-set-method (info method &optional extend)
3121 (if extend
3122 `(gnus-info-set-entry ,info ,method 4)
3123 `(setcar (nthcdr 4 ,info) ,method)))
3124 (defmacro gnus-info-set-params (info params &optional extend)
3125 (if extend
3126 `(gnus-info-set-entry ,info ,params 5)
3127 `(setcar (nthcdr 5 ,info) ,params)))
3129 (defun gnus-info-set-entry (info entry number)
3130 ;; Extend the info until we have enough elements.
3131 (while (<= (length info) number)
3132 (nconc info (list nil)))
3133 ;; Set the entry.
3134 (setcar (nthcdr number info) entry))
3136 (defmacro gnus-info-set-level (info level)
3137 `(let ((rank (cdr ,info)))
3138 (if (consp (car rank))
3139 (setcar (car rank) ,level)
3140 (setcar rank ,level))))
3141 (defmacro gnus-info-set-score (info score)
3142 `(let ((rank (cdr ,info)))
3143 (if (consp (car rank))
3144 (setcdr (car rank) ,score)
3145 (setcar rank (cons (car rank) ,score)))))
3147 (defmacro gnus-get-info (group)
3148 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3150 ;;; Load the compatibility functions.
3152 (require 'gnus-ems)
3154 \f
3155 ;;;
3156 ;;; Shutdown
3157 ;;;
3159 (defvar gnus-shutdown-alist nil)
3161 (defun gnus-add-shutdown (function &rest symbols)
3162 "Run FUNCTION whenever one of SYMBOLS is shut down."
3163 (push (cons function symbols) gnus-shutdown-alist))
3165 (defun gnus-shutdown (symbol)
3166 "Shut down everything that waits for SYMBOL."
3167 (dolist (entry gnus-shutdown-alist)
3168 (when (memq symbol (cdr entry))
3169 (funcall (car entry)))))
3171 \f
3172 ;;;
3173 ;;; Gnus Utility Functions
3174 ;;;
3176 (defun gnus-find-subscribed-addresses ()
3177 "Return a regexp matching the addresses of all subscribed mail groups.
3178 It consists of the `to-address' or `to-list' parameter of all groups
3179 with a `subscribed' parameter."
3180 (let (group address addresses)
3181 (dolist (entry (cdr gnus-newsrc-alist))
3182 (setq group (car entry))
3183 (when (gnus-parameter-subscribed group)
3184 (setq address (mail-strip-quoted-names
3185 (or (gnus-group-fast-parameter group 'to-address)
3186 (gnus-group-fast-parameter group 'to-list))))
3187 (when address
3188 (add-to-list 'addresses address))))
3189 (when addresses
3192 (defmacro gnus-string-or (&rest strings)
3193 "Return the first element of STRINGS that is a non-blank string.
3194 STRINGS will be evaluated in normal `or' order."
3195 `(gnus-string-or-1 (list ,@strings)))
3197 (defun gnus-string-or-1 (strings)
3198 (let (string)
3199 (while strings
3200 (setq string (pop strings))
3202 (setq string nil)
3203 (setq strings nil)))
3204 string))
3206 (defun gnus-version (&optional arg)
3207 "Version number of this version of Gnus.
3208 If ARG, insert string at point."
3209 (interactive "P")
3210 (if arg
3211 (insert (message gnus-version))
3212 (message gnus-version)))
3214 (defun gnus-continuum-version (&optional version)
3215 "Return VERSION as a floating point number."
3216 (unless version
3217 (setq version gnus-version))
3220 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3221 (number (match-string 2 version))
3222 major minor least)
3223 (unless (string-match
3225 (error "Invalid version string: %s" version))
3226 (setq major (string-to-number (match-string 1 number))
3227 minor (string-to-number (match-string 2 number))
3228 least (if (match-beginning 3)
3229 (string-to-number (match-string 3 number))
3230 0))
3231 (string-to-number
3232 (if (zerop major)
3233 (format "%s00%02d%02d"
3234 (if (member alpha '("(ding)" "d"))
3235 "4.99"
3236 (+ 5 (* 0.02
3237 (abs
3238 (- (mm-char-int (aref (downcase alpha) 0))
3239 (mm-char-int ?t))))
3240 -0.01))
3241 minor least)
3242 (format "%d.%02d%02d" major minor least))))))
3244 (defun gnus-info-find-node (&optional nodename)
3245 "Find Info documentation of Gnus."
3246 (interactive)
3247 ;; Enlarge info window if needed.
3248 (let (gnus-info-buffer)
3249 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3250 (setq gnus-info-buffer (current-buffer))
3251 (gnus-configure-windows 'info)))
3253 ;;;
3254 ;;; gnus-interactive
3255 ;;;
3257 (defvar gnus-current-prefix-symbol nil
3258 "Current prefix symbol.")
3260 (defvar gnus-current-prefix-symbols nil
3261 "List of current prefix symbols.")
3263 (defun gnus-interactive (string &optional params)
3264 "Return a list that can be fed to `interactive'.
3265 See `interactive' for full documentation.
3267 Adds the following specs:
3269 y -- The current symbolic prefix.
3270 Y -- A list of the current symbolic prefix(es).
3271 A -- Article number.
3272 H -- Article header.
3273 g -- Group name."
3274 (let ((i 0)
3275 out c prompt)
3276 (while (< i (length string))
3278 (setq c (aref string i))
3279 (when (match-end 1)
3280 (setq prompt (match-string 1 string)))
3281 (setq i (match-end 0))
3282 ;; We basically emulate just about everything that
3283 ;; `interactive' does, but add the specs listed above.
3284 (push
3285 (cond
3286 ((= c ?a)
3287 (completing-read prompt obarray 'fboundp t))
3288 ((= c ?b)
3289 (read-buffer prompt (current-buffer) t))
3290 ((= c ?B)
3291 (read-buffer prompt (other-buffer (current-buffer))))
3292 ((= c ?c)
3293 (read-char))
3294 ((= c ?C)
3295 (completing-read prompt obarray 'commandp t))
3296 ((= c ?d)
3297 (point))
3298 ((= c ?D)
3299 (read-file-name prompt nil default-directory 'lambda))
3300 ((= c ?f)
3301 (read-file-name prompt nil nil 'lambda))
3302 ((= c ?F)
3303 (read-file-name prompt))
3304 ((= c ?k)
3305 (read-key-sequence prompt))
3306 ((= c ?K)
3307 (error "Not implemented spec"))
3308 ((= c ?e)
3309 (error "Not implemented spec"))
3310 ((= c ?m)
3311 (mark))
3312 ((= c ?N)
3313 (error "Not implemented spec"))
3314 ((= c ?n)
3315 (string-to-number (read-from-minibuffer prompt)))
3316 ((= c ?p)
3317 (prefix-numeric-value current-prefix-arg))
3318 ((= c ?P)
3319 current-prefix-arg)
3320 ((= c ?r)
3321 'gnus-prefix-nil)
3322 ((= c ?s)
3323 (read-string prompt))
3324 ((= c ?S)
3325 (intern (read-string prompt)))
3326 ((= c ?v)
3327 (read-variable prompt))
3328 ((= c ?x)
3329 (read-minibuffer prompt))
3330 ((= c ?x)
3331 (eval-minibuffer prompt))
3332 ;; And here the new specs come.
3333 ((= c ?y)
3334 gnus-current-prefix-symbol)
3335 ((= c ?Y)
3336 gnus-current-prefix-symbols)
3337 ((= c ?g)
3338 (gnus-group-group-name))
3339 ((= c ?A)
3340 (gnus-summary-skip-intangible)
3341 (or (get-text-property (point) 'gnus-number)
3342 (gnus-summary-last-subject)))
3343 ((= c ?H)
3344 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3345 (t
3346 (error "Non-implemented spec")))
3347 out)
3348 (cond
3349 ((= c ?r)
3350 (push (if (< (point) (mark)) (point) (mark)) out)
3351 (push (if (> (point) (mark)) (point) (mark)) out))))
3352 (setq out (delq 'gnus-prefix-nil out))
3353 (nreverse out)))
3355 (defun gnus-symbolic-argument (&optional arg)
3356 "Read a symbolic argument and a command, and then execute command."
3357 (interactive "P")
3358 (let* ((in-command (this-command-keys))
3359 (command in-command)
3360 gnus-current-prefix-symbols
3361 gnus-current-prefix-symbol
3362 syms)
3363 (while (equal in-command command)
3364 (message "%s-" (key-description (this-command-keys)))
3365 (push (intern (char-to-string (read-char))) syms)
3366 (setq command (read-key-sequence nil t)))
3367 (setq gnus-current-prefix-symbols (nreverse syms)
3368 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3369 (call-interactively (key-binding command t))))
3371 ;;; More various functions.
3373 (defsubst gnus-check-backend-function (func group)
3374 "Check whether GROUP supports function FUNC.
3375 GROUP can either be a string (a group name) or a select method."
3376 (ignore-errors
3377 (let ((method (if (stringp group)
3378 (car (gnus-find-method-for-group group))
3379 group)))
3380 (unless (featurep method)
3381 (require method))
3382 (fboundp (intern (format "%s-%s" method func))))))
3384 (defun gnus-group-read-only-p (&optional group)
3385 "Check whether GROUP supports editing or not.
3386 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3387 that that variable is buffer-local to the summary buffers."
3388 (let ((group (or group gnus-newsgroup-name)))
3389 (not (gnus-check-backend-function 'request-replace-article group))))
3391 (defun gnus-virtual-group-p (group)
3392 "Say whether GROUP is virtual or not."
3393 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3394 gnus-valid-select-methods)))
3396 (defun gnus-news-group-p (group &optional article)
3397 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3398 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3399 t) ;is news of course.
3400 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3401 nil) ;must be mail then.
3402 ((vectorp article) ;Has header info.
3403 (eq (gnus-request-type group (mail-header-id article)) 'news))
3404 ((null article) ;Hasn't header info
3405 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3406 ((< article 0) ;Virtual message
3407 nil) ;we don't know, guess mail.
3408 (t ;Has positive number
3409 (eq (gnus-request-type group article) 'news)))) ;use it.
3411 ;; Returns a list of writable groups.
3412 (defun gnus-writable-groups ()
3413 (let ((alist gnus-newsrc-alist)
3414 groups group)
3415 (while (setq group (car (pop alist)))
3416 (unless (gnus-group-read-only-p group)
3417 (push group groups)))
3418 (nreverse groups)))
3420 ;; Check whether to use long file names.
3421 (defun gnus-use-long-file-name (symbol)
3422 ;; The variable has to be set...
3423 (and gnus-use-long-file-name
3424 ;; If it isn't a list, then we return t.
3425 (or (not (listp gnus-use-long-file-name))
3426 ;; If it is a list, and the list contains `symbol', we
3427 ;; return nil.
3428 (not (memq symbol gnus-use-long-file-name)))))
3430 ;; Generate a unique new group name.
3431 (defun gnus-generate-new-group-name (leaf)
3432 (let ((name leaf)
3433 (num 0))
3434 (while (gnus-group-entry name)
3435 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3436 name))
3438 (defun gnus-ephemeral-group-p (group)
3439 "Say whether GROUP is ephemeral or not."
3440 (gnus-group-get-parameter group 'quit-config t))
3442 (defun gnus-group-quit-config (group)
3443 "Return the quit-config of GROUP."
3444 (gnus-group-get-parameter group 'quit-config t))
3446 (defun gnus-kill-ephemeral-group (group)
3447 "Remove ephemeral GROUP from relevant structures."
3448 (gnus-sethash group nil gnus-newsrc-hashtb))
3450 (defun gnus-simplify-mode-line ()
3451 "Make mode lines a bit simpler."
3452 (setq mode-line-modified (cdr gnus-mode-line-modified))
3453 (when (listp mode-line-format)
3454 (make-local-variable 'mode-line-format)
3455 (setq mode-line-format (copy-sequence mode-line-format))
3456 (when (equal (nth 3 mode-line-format) " ")
3457 (setcar (nthcdr 3 mode-line-format) " "))))
3459 ;;; Servers and groups.
3461 (defsubst gnus-server-add-address (method)
3462 (let ((method-name (symbol-name (car method))))
3463 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3464 (not (assq (intern (concat method-name "-address")) method))
3465 (memq 'physical-address (assq (car method)
3466 gnus-valid-select-methods)))
3467 (append method (list (list (intern (concat method-name "-address"))
3468 (nth 1 method))))
3469 method)))
3471 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3472 (catch 'server-name
3473 (setq method (or method gnus-select-method))
3475 ;; Perhaps it is already in the cache.
3476 (unless nocache
3477 (mapc (lambda (name-method)
3478 (if (equal (cdr name-method) method)
3479 (throw 'server-name (car name-method))))
3480 gnus-server-method-cache))
3482 (mapc
3483 (lambda (server-alist)
3484 (mapc (lambda (name-method)
3485 (when (gnus-methods-equal-p (cdr name-method) method)
3486 (unless (member name-method gnus-server-method-cache)
3487 (push name-method gnus-server-method-cache))
3488 (throw 'server-name (car name-method))))
3489 server-alist))
3490 (list gnus-server-alist
3491 gnus-predefined-server-alist))
3493 (let* ((name (if (member (cadr method) '(nil ""))
3494 (format "%s" (car method))
3495 (format "%s:%s" (car method) (cadr method))))
3496 (name-method (cons name method)))
3497 (when (and (not (member name-method gnus-server-method-cache))
3498 (not no-enter-cache)
3499 (not (assoc (car name-method) gnus-server-method-cache)))
3500 (push name-method gnus-server-method-cache))
3501 name)))
3503 (defsubst gnus-server-to-method (server)
3504 "Map virtual server names to select methods."
3505 (or (and server (listp server) server)
3506 (cdr (assoc server gnus-server-method-cache))
3507 (let ((result
3508 (or
3509 ;; Perhaps this is the native server?
3510 (and (equal server "native") gnus-select-method)
3511 ;; It should be in the server alist.
3512 (cdr (assoc server gnus-server-alist))
3513 ;; It could be in the predefined server alist.
3514 (cdr (assoc server gnus-predefined-server-alist))
3515 ;; If not, we look through all the opened server
3516 ;; to see whether we can find it there.
3517 (let ((opened gnus-opened-servers))
3518 (while (and opened
3519 (not (equal server (format "%s:%s" (caaar opened)
3520 (cadaar opened)))))
3521 (pop opened))
3522 (caar opened))
3523 ;; It could be a named method, search all servers
3524 (let ((servers gnus-secondary-select-methods))
3525 (while (and servers
3526 (not (equal server (format "%s:%s" (caar servers)
3527 (cadar servers)))))
3528 (pop servers))
3529 (car servers))
3530 ;; This could be some sort of foreign server that I
3531 ;; simply haven't opened (yet). Do a brute-force scan
3532 ;; of the entire gnus-newsrc-alist for the server name
3533 ;; of every method. As a side-effect, loads the
3534 ;; gnus-server-method-cache so this only happens once,
3535 ;; if at all.
3536 (let ((alist (cdr gnus-newsrc-alist))
3537 method match)
3538 (while alist
3539 (setq method (gnus-info-method (pop alist)))
3540 (when (and (not (stringp method))
3541 (equal server
3542 (gnus-method-to-server method nil t)))
3543 (setq match method
3544 alist nil)))
3545 match))))
3546 (when (and result
3547 (not (assoc server gnus-server-method-cache)))
3548 (push (cons server result) gnus-server-method-cache))
3549 result)))
3551 (defsubst gnus-server-get-method (group method)
3552 ;; Input either a server name, and extended server name, or a
3553 ;; select method, and return a select method.
3554 (cond ((stringp method)
3555 (gnus-server-to-method method))
3556 ((equal method gnus-select-method)
3557 gnus-select-method)
3558 ((and (stringp (car method))
3559 group)
3560 (gnus-server-extend-method group method))
3561 ((and method
3562 (not group)
3563 (equal (cadr method) ""))
3564 method)
3565 (t
3566 (gnus-server-add-address method))))
3568 (defmacro gnus-method-equal (ss1 ss2)
3569 "Say whether two servers are equal."
3570 `(let ((s1 ,ss1)
3571 (s2 ,ss2))
3572 (or (equal s1 s2)
3573 (and (= (length s1) (length s2))
3574 (progn
3575 (while (and s1 (member (car s1) s2))
3576 (setq s1 (cdr s1)))
3577 (null s1))))))
3579 (defun gnus-methods-equal-p (m1 m2)
3580 (let ((m1 (or m1 gnus-select-method))
3581 (m2 (or m2 gnus-select-method)))
3582 (or (equal m1 m2)
3583 (and (eq (car m1) (car m2))
3584 (or (not (memq 'address (assoc (symbol-name (car m1))
3585 gnus-valid-select-methods)))
3586 (equal (nth 1 m1) (nth 1 m2)))))))
3588 (defun gnus-methods-sloppily-equal (m1 m2)
3589 ;; Same method.
3590 (or
3591 (eq m1 m2)
3592 ;; Type and name are equal.
3593 (and
3594 (eq (car m1) (car m2))
3595 (equal (cadr m1) (cadr m2))
3596 (gnus-sloppily-equal-method-parameters m1 m2))))
3598 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3599 ;; Check parameters for sloppy equalness.
3600 (let ((p1 (copy-sequence (cddr m1)))
3601 (p2 (copy-sequence (cddr m2)))
3602 e1 e2)
3603 (block nil
3604 (while (setq e1 (pop p1))
3605 (unless (setq e2 (assq (car e1) p2))
3606 ;; The parameter doesn't exist in p2.
3607 (return nil))
3608 (setq p2 (delq e2 p2))
3609 (unless (equal e1 e2)
3610 (if (not (and (stringp (cadr e1))
3611 (stringp (cadr e2))))
3612 (return nil)
3613 ;; Special-case string parameter comparison so that we
3614 ;; can uniquify them.
3615 (let ((s1 (cadr e1))
3616 (s2 (cadr e2)))
3617 (when (string-match "/$" s1)
3618 (setq s1 (directory-file-name s1)))
3619 (when (string-match "/$" s2)
3620 (setq s2 (directory-file-name s2)))
3621 (unless (equal s1 s2)
3622 (return nil))))))
3623 ;; If p2 now is empty, they were equal.
3624 (null p2))))
3626 (defun gnus-server-equal (m1 m2)
3627 "Say whether two methods are equal."
3628 (let ((m1 (cond ((null m1) gnus-select-method)
3629 ((stringp m1) (gnus-server-to-method m1))
3630 (t m1)))
3631 (m2 (cond ((null m2) gnus-select-method)
3632 ((stringp m2) (gnus-server-to-method m2))
3633 (t m2))))
3634 (gnus-method-equal m1 m2)))
3636 (defun gnus-servers-using-backend (backend)
3637 "Return a list of known servers using BACKEND."
3638 (let ((opened gnus-opened-servers)
3639 out)
3640 (while opened
3641 (when (eq backend (caaar opened))
3642 (push (caar opened) out))
3643 (pop opened))
3644 out))
3646 (defun gnus-archive-server-wanted-p ()
3647 "Say whether the user wants to use the archive server."
3648 (cond
3649 ((or (not gnus-message-archive-method)
3650 (not gnus-message-archive-group))
3651 nil)
3652 ((and gnus-message-archive-method gnus-message-archive-group)
3653 t)
3654 (t
3655 (let ((active (cadr (assq 'nnfolder-active-file
3656 gnus-message-archive-method))))
3657 (and active
3658 (file-exists-p active))))))
3660 (defsubst gnus-method-to-server-name (method)
3661 (concat
3662 (format "%s" (car method))
3663 (when (and
3664 (or (assoc (format "%s" (car method))
3665 (gnus-methods-using 'address))
3666 (gnus-server-equal method gnus-message-archive-method))
3667 (nth 1 method)
3668 (not (string= (nth 1 method) "")))
3669 (concat "+" (nth 1 method)))))
3671 (defsubst gnus-method-to-full-server-name (method)
3672 (format "%s+%s" (car method) (nth 1 method)))
3674 (defun gnus-group-prefixed-name (group method &optional full)
3675 "Return the whole name from GROUP and METHOD.
3676 Call with full set to get the fully qualified group name (even if the
3677 server is native)."
3678 (when (stringp method)
3679 (setq method (gnus-server-to-method method)))
3680 (if (or (not method)
3681 (and (not full) (gnus-server-equal method "native"))
3682 ;;;!!! This might not be right. We'll see...
3683 ;(string-match ":" group)
3684 )
3685 group
3686 (concat (gnus-method-to-server-name method) ":" group)))
3688 (defun gnus-group-guess-prefixed-name (group)
3689 "Guess the whole name from GROUP and METHOD."
3690 (gnus-group-prefixed-name group (gnus-find-method-for-group
3691 group)))
3693 (defun gnus-group-full-name (group method)
3694 "Return the full name from GROUP and METHOD, even if the method is native."
3695 (gnus-group-prefixed-name group method t))
3697 (defun gnus-group-guess-full-name (group)
3698 "Guess the full name from GROUP, even if the method is native."
3699 (if (gnus-group-prefixed-p group)
3700 group
3701 (gnus-group-full-name group (gnus-find-method-for-group group))))
3703 (defun gnus-group-guess-full-name-from-command-method (group)
3704 "Guess the full name from GROUP, even if the method is native."
3705 (if (gnus-group-prefixed-p group)
3706 group
3707 (gnus-group-full-name group gnus-command-method)))
3709 (defun gnus-group-real-prefix (group)
3710 "Return the prefix of the current group name."
3711 (if (stringp group)
3712 (if (string-match "^[^:]+:" group)
3713 (substring group 0 (match-end 0))
3714 "")
3715 nil))
3717 (defun gnus-group-short-name (group)
3718 "Return the short group name."
3719 (let ((prefix (gnus-group-real-prefix group)))
3720 (if (< 0 (length prefix))
3721 (substring group (length prefix) nil)
3722 group)))
3724 (defun gnus-group-prefixed-p (group)
3725 "Return the prefix of the current group name."
3726 (< 0 (length (gnus-group-real-prefix group))))
3728 (declare-function gnus-group-decoded-name "gnus-group" (string))
3730 (defun gnus-summary-buffer-name (group)
3731 "Return the summary buffer name of GROUP."
3732 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3734 (defun gnus-group-method (group)
3735 "Return the server or method used for selecting GROUP.
3736 You should probably use `gnus-find-method-for-group' instead."
3737 (let ((prefix (gnus-group-real-prefix group)))
3738 (if (equal prefix "")
3739 gnus-select-method
3740 (let ((servers gnus-opened-servers)
3741 (server "")
3742 backend possible found)
3744 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3745 server (substring prefix (match-end 0) (1- (length prefix))))
3746 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3747 (while servers
3748 (when (eq (caaar servers) backend)
3749 (setq possible (caar servers))
3750 (when (equal (cadaar servers) server)
3751 (setq found (caar servers))))
3752 (pop servers))
3753 (or (car (rassoc found gnus-server-alist))
3754 found
3755 (car (rassoc possible gnus-server-alist))
3756 possible
3757 (list backend server))))))
3759 (defsubst gnus-native-method-p (method)
3760 "Return whether METHOD is the native select method."
3761 (gnus-method-equal method gnus-select-method))
3763 (defsubst gnus-secondary-method-p (method)
3764 "Return whether METHOD is a secondary select method."
3765 (let ((methods gnus-secondary-select-methods)
3766 (gmethod (inline (gnus-server-get-method nil method))))
3767 (while (and methods
3768 (not (gnus-method-equal
3769 (inline (gnus-server-get-method nil (car methods)))
3770 gmethod)))
3771 (setq methods (cdr methods)))
3772 methods))
3774 (defun gnus-method-simplify (method)
3775 "Return the shortest uniquely identifying string or method for METHOD."
3776 (cond ((stringp method)
3777 method)
3778 ((gnus-native-method-p method)
3779 nil)
3780 ((gnus-secondary-method-p method)
3781 (format "%s:%s" (nth 0 method) (nth 1 method)))
3782 (t
3783 method)))
3785 (defun gnus-groups-from-server (server)
3786 "Return a list of all groups that are fetched from SERVER."
3787 (let ((alist (cdr gnus-newsrc-alist))
3788 info groups)
3789 (while (setq info (pop alist))
3790 (when (gnus-server-equal (gnus-info-method info) server)
3791 (push (gnus-info-group info) groups)))
3792 (sort groups 'string<)))
3794 (defun gnus-group-foreign-p (group)
3795 "Say whether a group is foreign or not."
3796 (and (not (gnus-group-native-p group))
3797 (not (gnus-group-secondary-p group))))
3799 (defun gnus-group-native-p (group)
3800 "Say whether the group is native or not."
3801 (not (string-match ":" group)))
3803 (defun gnus-group-secondary-p (group)
3804 "Say whether the group is secondary or not."
3805 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3807 (defun gnus-parameters-get-parameter (group)
3808 "Return the group parameters for GROUP from `gnus-parameters'."
3809 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3810 case-fold-search
3811 gnus-parameters-case-fold-search))
3812 params-list)
3813 (dolist (elem gnus-parameters)
3814 (when (string-match (car elem) group)
3815 (setq params-list
3816 (nconc (gnus-expand-group-parameters
3817 (car elem) (cdr elem) group)
3818 params-list))))
3819 params-list))
3821 (defun gnus-expand-group-parameter (match value group)
3822 "Use MATCH to expand VALUE in GROUP."
3823 (let ((start (string-match match group)))
3824 (if start
3825 (let ((matched-string (substring group start (match-end 0))))
3826 ;; Build match groups
3827 (string-match match matched-string)
3828 (replace-match value nil nil matched-string))
3829 group)))
3831 (defun gnus-expand-group-parameters (match parameters group)
3832 "Go through PARAMETERS and expand them according to the match data."
3833 (let (new)
3834 (dolist (elem parameters)
3835 (if (and (stringp (cdr elem))
3837 (push (cons (car elem)
3838 (gnus-expand-group-parameter match (cdr elem) group))
3839 new)
3840 (push elem new)))
3841 new))
3843 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3844 "For GROUP, return the value of SYMBOL.
3846 You should call this in the `gnus-group-buffer' buffer.
3847 The function `gnus-group-find-parameter' will do that for you."
3848 ;; The speed trick: No cons'ing and quit early.
3849 (let* ((params (funcall gnus-group-get-parameter-function group))
3850 ;; Start easy, check the "real" group parameters.
3851 (simple-results
3852 (gnus-group-parameter-value params symbol allow-list t)))
3853 (if simple-results
3854 ;; Found results; return them.
3855 (car simple-results)
3856 ;; We didn't find it there, try `gnus-parameters'.
3857 (let ((result nil)
3858 (head nil)
3859 (tail gnus-parameters))
3860 ;; A good old-fashioned non-cl loop.
3861 (while tail
3862 (setq head (car tail)
3863 tail (cdr tail))
3864 ;; The car is regexp matching for matching the group name.
3865 (when (string-match (car head) group)
3866 ;; The cdr is the parameters.
3867 (setq result (gnus-group-parameter-value (cdr head)
3868 symbol allow-list))
3869 (when result
3870 ;; Expand if necessary.
3872 (setq result (gnus-expand-group-parameter (car head)
3873 result group))))))
3874 ;; Done.
3875 result))))
3877 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3878 "Return the group parameters for GROUP.
3879 If SYMBOL, return the value of that symbol in the group parameters.
3881 If you call this function inside a loop, consider using the faster
3882 `gnus-group-fast-parameter' instead."
3883 (with-current-buffer gnus-group-buffer
3884 (if symbol
3885 (gnus-group-fast-parameter group symbol allow-list)
3886 (nconc
3887 (copy-sequence
3888 (funcall gnus-group-get-parameter-function group))
3889 (gnus-parameters-get-parameter group)))))
3891 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3892 "Return the group parameters for GROUP.
3893 If SYMBOL, return the value of that symbol in the group parameters.
3894 If ALLOW-LIST, also allow list as a result.
3895 Most functions should use `gnus-group-find-parameter', which
3896 also examines the topic parameters."
3897 (let ((params (gnus-info-params (gnus-get-info group))))
3898 (if symbol
3899 (gnus-group-parameter-value params symbol allow-list)
3900 params)))
3902 (defun gnus-group-parameter-value (params symbol &optional
3903 allow-list present-p)
3904 "Return the value of SYMBOL in group PARAMS.
3905 If ALLOW-LIST, also allow list as a result."
3906 ;; We only wish to return group parameters (dotted lists) and
3907 ;; not local variables, which may have the same names.
3908 ;; But first we handle single elements...
3909 (or (car (memq symbol params))
3910 ;; Handle alist.
3911 (let (elem)
3912 (catch 'found
3913 (while (setq elem (pop params))
3914 (when (and (consp elem)
3915 (eq (car elem) symbol)
3916 (or allow-list
3917 (atom (cdr elem))))
3918 (throw 'found (if present-p (list (cdr elem))
3919 (cdr elem)))))))))
3921 (defun gnus-group-add-parameter (group param)
3922 "Add parameter PARAM to GROUP."
3923 (let ((info (gnus-get-info group)))
3924 (when info
3925 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3926 ;; Cons the new param to the old one and update.
3927 (gnus-group-set-info (cons param (gnus-info-params info))
3928 group 'params))))
3930 (defun gnus-group-set-parameter (group name value)
3931 "Set parameter NAME to VALUE in GROUP.
3932 GROUP can also be an INFO structure."
3933 (let ((info (if (listp group)
3934 group
3935 (gnus-get-info group))))
3936 (when info
3937 (gnus-group-remove-parameter group name)
3938 (let ((old-params (gnus-info-params info))
3939 (new-params (list (cons name value))))
3940 (while old-params
3941 (when (or (not (listp (car old-params)))
3942 (not (eq (caar old-params) name)))
3943 (setq new-params (append new-params (list (car old-params)))))
3944 (setq old-params (cdr old-params)))
3945 (if (listp group)
3946 (gnus-info-set-params info new-params t)
3947 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3949 (defun gnus-group-remove-parameter (group name)
3950 "Remove parameter NAME from GROUP.
3951 GROUP can also be an INFO structure."
3952 (let ((info (if (listp group)
3953 group
3954 (gnus-get-info group))))
3955 (when info
3956 (let ((params (gnus-info-params info)))
3957 (when params
3958 (setq params (delq name params))
3959 (while (assq name params)
3960 (gnus-alist-pull name params))
3961 (gnus-info-set-params info params))))))
3963 (defun gnus-group-add-score (group &optional score)
3964 "Add SCORE to the GROUP score.
3965 If SCORE is nil, add 1 to the score of GROUP."
3966 (let ((info (gnus-get-info group)))
3967 (when info
3968 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3970 (defun gnus-short-group-name (group &optional levels)
3971 "Collapse GROUP name LEVELS.
3972 Select methods are stripped and any remote host name is stripped down to
3973 just the host name."
3974 (let* ((name "")
3975 (foreign "")
3976 (depth 0)
3977 (skip 1)
3978 (levels (or levels
3979 gnus-group-uncollapsed-levels
3980 (progn
3982 (setq skip (match-end 0)
3983 depth (+ depth 1)))
3984 depth))))
3985 ;; Separate foreign select method from group name and collapse.
3986 ;; If method contains a server, collapse to non-domain server name,
3987 ;; otherwise collapse to select method.
3988 (let* ((colon (string-match ":" group))
3989 (server (and colon (substring group 0 colon)))
3990 (plus (and server (string-match "+" server))))
3991 (when server
3992 (if plus
3993 (setq foreign (substring server (+ 1 plus)
3995 group (substring group (+ 1 colon)))
3996 (setq foreign server
3997 group (substring group (+ 1 colon))))
3998 (setq foreign (concat foreign ":")))
3999 ;; Collapse group name leaving LEVELS uncollapsed elements
4000 (let* ((slist (split-string group "/"))
4001 (slen (length slist))
4003 (dlen (length dlist))
4004 glist
4005 glen
4006 gsep
4007 res)
4008 (if (> slen dlen)
4009 (setq glist slist
4010 glen slen
4011 gsep "/")
4012 (setq glist dlist
4013 glen dlen
4014 gsep "."))
4015 (setq levels (- glen levels))
4016 (dolist (g glist)
4017 (push (if (>= (decf levels) 0)
4018 (if (zerop (length g))
4019 ""
4020 (substring g 0 1))
4021 g)
4022 res))
4023 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4025 (defun gnus-narrow-to-body ()
4026 "Narrow to the body of an article."
4027 (narrow-to-region
4028 (progn
4029 (goto-char (point-min))
4031 (point-max)))
4032 (point-max)))
4034 \f
4035 ;;;
4036 ;;; Kill file handling.
4037 ;;;
4039 (defun gnus-apply-kill-file ()
4040 "Apply a kill file to the current newsgroup.
4041 Returns the number of articles marked as read."
4042 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4043 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4044 (gnus-apply-kill-file-internal)
4045 0))
4047 (defun gnus-kill-save-kill-buffer ()
4048 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4049 (when (get-file-buffer file)
4050 (with-current-buffer (get-file-buffer file)
4051 (when (buffer-modified-p)
4052 (save-buffer))
4053 (kill-buffer (current-buffer))))))
4055 (defcustom gnus-kill-file-name "KILL"
4056 "Suffix of the kill files."
4057 :group 'gnus-score-kill
4058 :group 'gnus-score-files
4059 :type 'string)
4061 (defun gnus-newsgroup-kill-file (newsgroup)
4062 "Return the name of a kill file name for NEWSGROUP.
4063 If NEWSGROUP is nil, return the global kill file name instead."
4064 (cond
4065 ;; The global KILL file is placed at top of the directory.
4066 ((or (null newsgroup)
4067 (string-equal newsgroup ""))
4068 (expand-file-name gnus-kill-file-name
4069 gnus-kill-files-directory))
4070 ;; Append ".KILL" to newsgroup name.
4071 ((gnus-use-long-file-name 'not-kill)
4072 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4073 "." gnus-kill-file-name)
4074 gnus-kill-files-directory))
4075 ;; Place "KILL" under the hierarchical directory.
4076 (t
4077 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4078 "/" gnus-kill-file-name)
4079 gnus-kill-files-directory))))
4081 ;;; Server things.
4083 (defun gnus-member-of-valid (symbol group)
4085 (memq symbol (assoc
4086 (symbol-name (car (gnus-find-method-for-group group)))
4087 gnus-valid-select-methods)))
4089 (defun gnus-method-option-p (method option)
4090 "Return non-nil if select METHOD has OPTION as a parameter."
4091 (when (stringp method)
4092 (setq method (gnus-server-to-method method)))
4093 (memq option (assoc (format "%s" (car method))
4094 gnus-valid-select-methods)))
4096 (defun gnus-similar-server-opened (method)
4097 "Return non-nil if we have a similar server opened.
4098 This is defined as a server with the same name, but different
4099 parameters."
4100 (let ((opened gnus-opened-servers)
4101 open)
4102 (while (and method opened)
4103 (setq open (car (pop opened)))
4104 ;; Type and name are the same...
4105 (when (and (equal (car method) (car open))
4106 (equal (cadr method) (cadr open))
4107 ;; ... but the rest of the parameters differ.
4108 (not (gnus-methods-sloppily-equal method open)))
4109 (setq method nil)))
4110 (not method)))
4112 (defun gnus-server-extend-method (group method)
4113 ;; This function "extends" a virtual server. If the server is
4114 ;; "hello", and the select method is ("hello" (my-var "something"))
4115 ;; in the group "alt.alt", this will result in a new virtual server
4116 ;; called "hello+alt.alt".
4117 (if (or (not (inline (gnus-similar-server-opened method)))
4118 (not (cddr method)))
4119 method
4120 (setq method
4121 `(,(car method) ,(concat (cadr method) "+" group)
4122 (,(intern (format "%s-address" (car method))) ,(cadr method))
4123 ,@(cddr method)))
4124 (push method gnus-extended-servers)
4125 method))
4127 (defun gnus-server-status (method)
4128 "Return the status of METHOD."
4129 (nth 1 (assoc method gnus-opened-servers)))
4131 (defun gnus-group-name-to-method (group)
4132 "Guess a select method based on GROUP."
4133 (if (string-match ":" group)
4134 (let ((server (substring group 0 (match-beginning 0))))
4136 (list (intern (substring server 0 (match-beginning 0)))
4137 (substring server (match-end 0)))
4138 (list (intern server) "")))
4139 gnus-select-method))
4141 (defun gnus-server-string (server)
4142 "Return a readable string that describes SERVER."
4143 (let* ((server (gnus-server-to-method server))
4144 (address (nth 1 server)))
4145 (if (and address
4146 (not (zerop (length address))))
4147 (format "%s using %s" address (car server))
4148 (format "%s" (car server)))))
4150 (defun gnus-same-method-different-name (method)
4151 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4152 (unless (assq slot (cddr method))
4153 (setq method
4154 (append method (list (list slot (nth 1 method)))))))
4155 (let ((methods gnus-extended-servers)
4156 open found)
4157 (while (and (not found)
4158 (setq open (pop methods)))
4159 (when (and (eq (car method) (car open))
4160 (gnus-sloppily-equal-method-parameters method open))
4161 (setq found open)))
4162 found))
4164 (defun gnus-find-method-for-group (group &optional info)
4165 "Find the select method that GROUP uses."
4166 (or gnus-override-method
4167 (and (not group)
4168 gnus-select-method)
4169 (and (not (gnus-group-entry group))
4170 ;; Killed or otherwise unknown group.
4171 (or
4172 ;; If we know a virtual server by that name, return its method.
4173 (gnus-server-to-method (gnus-group-server group))
4174 ;; Guess a new method as last resort.
4175 (gnus-group-name-to-method group)))
4176 (let ((info (or info (gnus-get-info group)))
4177 method)
4178 (if (or (not info)
4179 (not (setq method (gnus-info-method info)))
4180 (equal method "native"))
4181 gnus-select-method
4182 (setq method
4183 (cond ((stringp method)
4184 (inline (gnus-server-to-method method)))
4185 ((stringp (cadr method))
4186 (or
4187 (inline
4188 (gnus-same-method-different-name method))
4189 (inline (gnus-server-extend-method group method))))
4190 (t
4191 method)))
4192 (cond ((equal (cadr method) "")
4193 method)
4194 ((null (cadr method))
4195 (list (car method) ""))
4196 (t
4197 (gnus-server-add-address method)))))))
4199 (defun gnus-methods-using (feature)
4200 "Find all methods that have FEATURE."
4201 (let ((valids gnus-valid-select-methods)
4202 outs)
4203 (while valids
4204 (when (memq feature (car valids))
4205 (push (car valids) outs))
4206 (setq valids (cdr valids)))
4207 outs))
4209 (eval-and-compile
4210 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4212 (defun gnus-read-group (prompt &optional default)
4213 "Prompt the user for a group name.
4214 Disallow invalid group names."
4215 (let ((prefix "")
4216 group)
4217 (while (not group)
4218 (when (string-match
4219 gnus-invalid-group-regexp
4220 (setq group (read-string (concat prefix prompt)
4221 (cons (or default "") 0)
4222 'gnus-group-history)))
4223 (let ((match (match-string 0 group)))
4224 ;; Might be okay (e.g. for nnimap), so ask the user:
4226 (message-y-or-n-p
4227 "Proceed and create group anyway? " t
4230 Usually, it's dangerous to create a group with this name, because it's not
4231 supported by all back ends and servers. On IMAP servers it should work,
4232 though. If you are really sure, you can proceed anyway and create the group.
4234 You may customize the variable `gnus-invalid-group-regexp', which currently is
4238 group nil)))))
4239 group))
4241 (defun gnus-read-method (prompt)
4242 "Prompt the user for a method.
4243 Allow completion over sensible values."
4244 (let* ((open-servers
4245 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4246 gnus-opened-servers))
4247 (valid-methods
4248 (let (methods)
4249 (dolist (method gnus-valid-select-methods)
4250 (if (or (memq 'prompt-address method)
4251 (not (assoc (format "%s:" (car method)) open-servers)))
4252 (push method methods)))
4253 methods))
4254 (servers
4255 (append valid-methods
4256 open-servers
4257 gnus-predefined-server-alist
4258 gnus-server-alist))
4259 (method
4260 (gnus-completing-read
4261 prompt (mapcar 'car servers)
4262 t nil 'gnus-method-history)))
4263 (cond
4264 ((equal method "")
4265 (setq method gnus-select-method))
4266 ((assoc method gnus-valid-select-methods)
4267 (let ((address (if (memq 'prompt-address
4268 (assoc method gnus-valid-select-methods))
4269 (read-string "Address: ")
4270 "")))
4271 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4272 (list (intern method) address))))
4273 ((assoc method servers)
4274 method)
4275 (t
4276 (list (intern method) "")))))
4278 ;;; Agent functions
4280 (defun gnus-agent-method-p (method-or-server)
4281 "Say whether METHOD is covered by the agent."
4282 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4283 (let* ((method (if (stringp method-or-server)
4284 (gnus-server-to-method method-or-server)
4285 method-or-server))
4286 (server (gnus-method-to-server method t)))
4287 (setq gnus-agent-method-p-cache
4288 (cons method-or-server
4289 (member server gnus-agent-covered-methods)))))
4290 (cdr gnus-agent-method-p-cache))
4292 (defun gnus-online (method)
4293 (not
4294 (if gnus-plugged
4295 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4296 (gnus-agent-method-p method))))
4298 ;;; User-level commands.
4300 ;;;###autoload
4301 (defun gnus-slave-no-server (&optional arg)
4302 "Read network news as a slave, without connecting to the local server."
4303 (interactive "P")
4304 (gnus-no-server arg t))
4306 ;;;###autoload
4307 (defun gnus-no-server (&optional arg slave)
4308 "Read network news.
4309 If ARG is a positive number, Gnus will use that as the startup
4310 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4311 non-nil and not a positive number, Gnus will prompt the user for the
4312 name of an NNTP server to use.
4313 As opposed to `gnus', this command will not connect to the local
4314 server."
4315 (interactive "P")
4316 (gnus-no-server-1 arg slave))
4318 ;;;###autoload
4319 (defun gnus-slave (&optional arg)
4320 "Read news as a slave."
4321 (interactive "P")
4322 (gnus arg nil 'slave))
4324 ;;;###autoload
4325 (defun gnus-other-frame (&optional arg display)
4326 "Pop up a frame to read news.
4327 This will call one of the Gnus commands which is specified by the user
4328 option `gnus-other-frame-function' (default `gnus') with the argument
4329 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4330 optional second argument DISPLAY should be a standard display string
4332 omitted or the function `make-frame-on-display' is not available, the
4333 current display is used."
4334 (interactive "P")
4335 (if (fboundp 'make-frame-on-display)
4336 (unless display
4337 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4338 (setq display nil))
4339 (let ((alive (gnus-alive-p)))
4340 (unless (and alive
4341 (catch 'found
4342 (walk-windows
4343 (lambda (window)
4344 (when (and (or (not display)
4345 (equal display
4346 (gnus-frame-or-window-display-name
4347 window)))
4348 (with-current-buffer (window-buffer window)
4350 (symbol-name major-mode))))
4351 (gnus-select-frame-set-input-focus
4352 (setq gnus-other-frame-object (window-frame window)))
4353 (select-window window)
4354 (throw 'found t)))
4355 'ignore t)))
4356 (gnus-select-frame-set-input-focus
4357 (setq gnus-other-frame-object
4358 (if display
4359 (make-frame-on-display display gnus-other-frame-parameters)
4360 (make-frame gnus-other-frame-parameters))))
4361 (if alive
4362 (switch-to-buffer gnus-group-buffer)
4363 (funcall gnus-other-frame-function arg)
4364 (add-hook 'gnus-exit-gnus-hook
4365 '(lambda nil
4366 (when (and (frame-live-p gnus-other-frame-object)
4367 (cdr (frame-list)))
4368 (delete-frame gnus-other-frame-object))
4369 (setq gnus-other-frame-object nil)))))))
4371 ;;;###autoload
4372 (defun gnus (&optional arg dont-connect slave)
4373 "Read network news.
4374 If ARG is non-nil and a positive number, Gnus will use that as the
4375 startup level. If ARG is non-nil and not a positive number, Gnus will
4376 prompt the user for the name of an NNTP server to use."
4377 (interactive "P")
4378 ;; When using the development version of Gnus, load the gnus-load
4379 ;; file.
4380 (unless (string-match "^Gnus" gnus-version)
4381 (load "gnus-load" nil t))
4382 (unless (byte-code-function-p (symbol-function 'gnus))
4383 (message "You should byte-compile Gnus")
4384 (sit-for 2))
4385 (let ((gnus-action-message-log (list nil)))
4386 (gnus-1 arg dont-connect slave)
4387 (gnus-final-warning)))
4389 ;; Allow redefinition of Gnus functions.
4391 (gnus-ems-redefine)
4393 (provide 'gnus)
4395 ;;; gnus.el ends here