| blob | 0c01d599cfcd2e36614e2ca073bd3aa29ffd0012 |
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.
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 --
1386 function
1387 sexp
1388 string))
1391 "List of NNTP servers that the user can choose between interactively.
1392 To make Gnus query you for a server, you have to give `gnus' a
1393 non-numeric prefix - `C-u M-x gnus', in short."
1398 "*The name of the host running the NNTP server.
1399 This variable is semi-obsolete. Use the `gnus-select-method'
1400 variable instead."
1403 string))
1406 "A list of secondary methods that will be used for reading news.
1407 This is a list where each element is a complete select method (see
1408 `gnus-select-method').
1410 If, for instance, you want to read your mail with the nnml back end,
1411 you could set this variable:
1419 "Default default new newsgroups the first time Gnus is run.
1423 "Local domain name without a host name.
1424 The DOMAINNAME environment variable is used instead if it is defined.
1425 If the function `system-name' returns the full Internet name, there is
1426 no need to set this variable."
1429 string))
1432 "String with a description of what organization (if any) the user belongs to.
1435 ;; Customization variables
1438 "Preferred method for fetching an article by Message-ID.
1439 If you are reading news from the local spool (with nnspool), fetching
1440 articles by Message-ID is painfully slow. By setting this method to an
1441 nntp method, you might get acceptable results.
1443 The value of this variable must be a valid select method as discussed
1444 in the documentation of `gnus-select-method'.
1446 It can also be a list of select methods, as well as the special symbol
1447 `current', which means to use the current select method. If it is a
1448 list, Gnus will try all the methods in the list until it finds a match."
1454 gnus-select-method
1462 gnus-select-method))))
1465 "*Non-nil means that control messages are displayed using `browse-url'.
1466 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1467 group."
1473 "*Non-nil means that cross referenced articles will be marked as read.
1474 If nil, ignore cross references. If t, mark articles as read in
1475 subscribed newsgroups. If neither t nor nil, mark as read in all
1476 newsgroups."
1484 "*Process mark."
1490 "*The number of articles which indicates a large newsgroup.
1491 If the number of articles in a newsgroup is greater than this value,
1492 confirmation is required for selecting the newsgroup.
1493 If it is nil, no confirmation is required."
1496 integer))
1499 "*Non-nil means that the default name of a file to save articles in is the group name.
1500 If it's nil, the directory form of the group name is used instead.
1502 If this variable is a list, and the list contains the element
1503 `not-score', long file names will not be used for score files; if it
1504 contains the element `not-save', long file names will not be used for
1505 saving; and if it contains the element `not-kill', long file names
1506 will not be used for kill files.
1508 Note that the default for this variable varies according to what system
1509 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1510 to nil while on all other systems it defaults to t."
1528 "*If non-nil, save group scoring info."
1534 "*If non-nil, allow undoing in Gnus group mode buffers."
1539 "*If non-nil, use some adaptive scoring scheme.
1540 If a list, then the values `word' and `line' are meaningful. The
1541 former will perform adaption on individual words in the subject
1542 header while `line' will perform adaption on several headers."
1548 "*If nil, Gnus will ignore the article cache.
1549 If `passive', it will allow entering (and reading) articles
1550 explicitly entered into the cache. If anything else, use the
1551 cache to the full extent of the law."
1559 "*If non-nil, display a thread tree buffer."
1564 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1565 If it is a number N, then Gnus will only keep the last N articles
1566 read. If it is neither nil nor a number, Gnus will keep all read
1567 articles. This is not a good idea."
1570 integer
1575 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1580 "*If non-nil, enable scoring."
1586 "*A hook called when preparing to exit from the summary buffer.
1587 It calls `gnus-summary-expire-articles' by default."
1592 "*Non-nil means that you are a Usenet novice.
1593 If non-nil, verbose messages may be displayed and confirmations may be
1594 required."
1599 "*Non-nil means that you will never be asked for confirmation about anything.
1600 That doesn't mean *anything* anything; particularly destructive
1601 commands will still require prompting."
1606 "*If non-nil, require your confirmation when catching up a group."
1611 "*If non-nil, require your confirmation when exiting Gnus."
1616 "*Function for extracting address components from a From header.
1617 Two pre-defined function exist: `gnus-extract-address-components',
1618 which is the default, quite fast, and too simplistic solution, and
1619 `mail-extract-address-components', which works much better, but is
1620 slower."
1627 "*If non-nil, display clickable icons."
1632 "String used to separate shell commands."
1656 "*An alist of valid select methods.
1657 The first element of each list lists should be a string with the name
1658 of the select method. The other elements may be the category of
1659 this method (i. e., `post', `mail', `none' or whatever) or other
1660 properties that this method has (like being respoolable).
1661 If you implement a new select method, all you should have to change is
1662 this variable. I think."
1678 "Recomputes the select-method widget based on the value of
1679 `gnus-valid-select-methods'."
1681 "Widget for entering a select method."
1688 gnus-valid-select-methods)
1692 :inline t
1694 variable
1700 "List of buffers that should update their mode lines.
1701 The list may contain the symbols `group', `article', `tree' and
1702 `summary'. If the corresponding symbol is present, Gnus will keep
1703 that mode line updated with information that may be pertinent.
1704 If this variable is nil, screen refresh may be quicker."
1712 "*Max length of mode-line non-string contents.
1713 If this is nil, Gnus will take space as is needed, leaving the rest
1714 of the mode line intact."
1718 integer))
1720 ;; There should be special validation for this.
1725 to-address
1726 :function-document
1727 "Return GROUP's to-address."
1728 :variable-document
1729 "*Alist of group regexps and correspondent to-addresses."
1730 :variable-group gnus-group-parameter
1733 This will be used when doing followups and posts.
1735 This is primarily useful in mail groups that represent closed
1736 mailing lists--mailing lists where it's expected that everybody that
1737 writes to the mailing list is subscribed to it. Since using this
1738 parameter ensures that the mail only goes to the mailing list itself,
1739 it means that members won't receive two copies of your followups.
1741 Using `to-address' will actually work whether the group is foreign or
1742 not. Let's say there's a group on the server that is called
1743 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1744 articles from a mail-to-news gateway. Posting directly to this group
1745 is therefore impossible--you have to send mail to the mailing list
1746 address instead.
1748 The gnus-group-split mail splitting mechanism will behave as if this
1752 to-list
1753 :function-document
1754 "Return GROUP's to-list."
1755 :variable-document
1756 "*Alist of group regexps and correspondent to-lists."
1757 :variable-group gnus-group-parameter
1760 This address will be used when doing a `a' in the group.
1762 It is totally ignored when doing a followup--except that if it is
1763 present in a news group, you'll get mail group semantics when doing
1764 `f'.
1766 The gnus-group-split mail splitting mechanism will behave as if this
1770 subscribed
1771 :type bool
1772 :function-document
1773 "Return GROUP's subscription status."
1774 :variable-document
1775 "*Groups which are automatically considered subscribed."
1776 :variable-group gnus-group-parameter
1779 Gnus assumed that you are subscribed to the To/List address.
1781 When constructing a list of subscribed groups using
1782 `gnus-find-subscribed-addresses', Gnus includes the To address given
1786 auto-expire
1787 :type bool
1788 :function gnus-group-auto-expirable-p
1789 :function-document
1790 "Check whether GROUP is auto-expirable or not."
1791 :variable gnus-auto-expirable-newsgroups
1792 :variable-default nil
1793 :variable-document
1794 "*Groups in which to automatically mark read articles as expirable.
1795 If non-nil, this should be a regexp that should match all groups in
1796 which to perform auto-expiry. This only makes sense for mail groups."
1797 :variable-group nnmail-expire
1799 regexp)
1801 :parameter-document
1805 total-expire
1806 :type bool
1807 :function gnus-group-total-expirable-p
1808 :function-document
1809 "Check whether GROUP is total-expirable or not."
1810 :variable gnus-total-expirable-newsgroups
1811 :variable-default nil
1812 :variable-document
1813 "*Groups in which to perform expiry of all read articles.
1814 Use with extreme caution. All groups that match this regexp will be
1815 expiring - which means that all read articles will be deleted after
1816 \(say) one week. (This only goes for mail groups and the like, of
1817 course.)"
1818 :variable-group nnmail-expire
1820 regexp)
1822 :parameter-document
1823 "All read articles will be put through the expiry process
1825 This happens even if they are not marked as expirable.
1829 charset
1830 :function-document
1831 "Return the default charset of GROUP."
1832 :variable gnus-group-charset-alist
1833 :variable-default
1846 :variable-document
1847 "Alist of regexps (to match group names) and default charsets to be used when reading."
1848 :variable-group gnus-charset
1856 post-method
1857 :type list
1858 :function-document
1859 "Return a posting method for GROUP."
1860 :variable gnus-post-method-alist
1861 :variable-document
1862 "Alist of regexps (to match group names) and method to be used when
1863 posting an article."
1864 :variable-group gnus-group-foreign
1865 :parameter-type
1873 :parameter-document
1877 large-newsgroup-initial
1878 :type integer
1879 :function-document
1880 "Return GROUP's initial input of the number of articles."
1881 :variable-document
1882 "*Alist of group regexps and its initial input of the number of articles."
1883 :variable-group gnus-group-parameter
1889 This number will be prompted as the initial value of the number of
1890 articles to list when the group is a large newsgroup (see
1891 `gnus-large-newsgroup'). If it is nil, the default value is the
1894 ;; The Gnus registry's ignored groups
1896 registry-ignore
1897 :type list
1898 :function-document
1899 "Whether this group should be ignored by the registry."
1900 :variable gnus-registry-ignored-groups
1901 :variable-default nil
1902 :variable-document
1903 "*Groups in which the registry should be turned off."
1904 :variable-group gnus-registry
1911 :parameter-document
1914 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1916 "*Disable the group parameters for spam detection.
1917 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1924 "Spam group classification (requires spam.el).
1925 This group contains spam messages. On summary entry, unread messages
1926 will be marked as spam. On summary exit, the specified spam
1927 processors will be invoked on spam-marked messages, then those
1928 messages will be expired, so the spam processor will only see a
1932 "The ham value for the spam group parameter (requires spam.el).
1933 On summary exit, the specified ham processors will be invoked on
1934 ham-marked messages. Exercise caution, since the ham processor will
1935 see the same message more than once because there is no ham message
1939 spam-contents
1940 :type list
1941 :function-document
1942 "The spam type (spam, ham, or neither) of the group."
1943 :variable gnus-spam-newsgroup-contents
1944 :variable-default nil
1945 :variable-document
1946 "*Group classification (spam, ham, or neither). Only
1947 meaningful when spam.el is loaded. If non-nil, this should be a
1948 list of group name regexps associated with a classification for
1949 each one. In spam groups, new articles are marked as spam on
1950 summary entry. There is other behavior associated with ham and
1951 no classification when spam.el is loaded - see the manual."
1952 :variable-group spam
1966 :parameter-document
1967 "The spam classification (spam, ham, or neither) of this group.
1968 When a spam group is entered, all unread articles are marked as
1969 spam. There is other behavior associated with ham and no
1973 spam-resend-to
1974 :type list
1975 :function-document
1976 "The address to get spam resent (through spam-report-resend)."
1977 :variable gnus-spam-resend-to
1978 :variable-default nil
1979 :variable-document
1980 "The address to get spam resent (through spam-report-resend)."
1981 :variable-group spam
1985 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1986 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1987 :parameter-document
1991 ham-resend-to
1992 :type list
1993 :function-document
1994 "The address to get ham resent (through spam-report-resend)."
1995 :variable gnus-ham-resend-to
1996 :variable-default nil
1997 :variable-document
1998 "The address to get ham resent (through spam-report-resend)."
1999 :variable-group spam
2003 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2004 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2005 :parameter-document
2021 "OBSOLETE: The Gmane reporting summary exit spam processor.
2028 "OBSOLETE: The ifile summary exit ham processor.
2032 "OBSOLETE: The Bogofilter summary exit ham processor.
2036 "OBSOLETE: The spam-stat summary exit ham processor.
2040 "OBSOLETE: The whitelist summary exit ham processor.
2044 "OBSOLETE: The BBDB summary exit ham processor.
2048 "OBSOLETE: The ham copy exit ham processor.
2052 "OBSOLETE: The spamoracle summary exit ham processor.
2056 spam-process
2057 :type list
2058 :parameter-type
2061 :value nil
2098 :function-document
2099 "Which spam or ham processors will be applied when the summary is exited."
2100 :variable gnus-spam-process-newsgroups
2101 :variable-default nil
2102 :variable-document
2103 "*Groups in which to automatically process spam or ham articles with
2104 a backend on summary exit. If non-nil, this should be a list of group
2105 name regexps that should match all groups in which to do automatic
2106 spam processing, associated with the appropriate processor."
2107 :variable-group spam
2108 :variable-type
2149 :parameter-document
2153 spam-autodetect
2154 :type list
2155 :parameter-type
2157 :function-document
2158 "Should spam be autodetected (with spam-split) in this group?"
2159 :variable gnus-spam-autodetect
2160 :variable-default nil
2161 :variable-document
2162 "*Groups in which spam should be autodetected when they are entered.
2163 Only unseen articles will be examined, unless
2164 spam-autodetect-recheck-messages is set."
2165 :variable-group spam
2166 :variable-type
2171 boolean))
2172 :parameter-document
2173 "Spam autodetection.
2174 Only unseen articles will be examined, unless
2178 spam-autodetect-methods
2179 :type list
2180 :parameter-type
2203 :function-document
2204 "Methods to be used for autodetection in each group"
2205 :variable gnus-spam-autodetect-methods
2206 :variable-default nil
2207 :variable-document
2208 "*Methods for autodetecting spam per group.
2209 Requires the spam-autodetect parameter. Only unseen articles
2210 will be examined, unless spam-autodetect-recheck-messages is
2211 set."
2212 :variable-group spam
2213 :variable-type
2240 :parameter-document
2241 "Spam autodetection methods.
2242 Requires the spam-autodetect parameter. Only unseen articles
2243 will be examined, unless spam-autodetect-recheck-messages is
2247 spam-process-destination
2248 :type list
2249 :parameter-type
2255 :function-document
2256 "Where spam-processed articles will go at summary exit."
2257 :variable gnus-spam-process-destinations
2258 :variable-default nil
2259 :variable-document
2260 "*Groups in which to explicitly send spam-processed articles to
2261 another group, or expire them (the default). If non-nil, this should
2262 be a list of group name regexps that should match all groups in which
2263 to do spam-processed article moving, associated with the destination
2264 group or nil for explicit expiration. This only makes sense for
2265 mail groups."
2266 :variable-group spam
2267 :variable-type
2278 :parameter-document
2282 ham-process-destination
2283 :type list
2284 :parameter-type
2292 :function-document
2293 "Where ham articles will go at summary exit from a spam group."
2294 :variable gnus-ham-process-destinations
2295 :variable-default nil
2296 :variable-document
2297 "*Groups in which to explicitly send ham articles to
2298 another group, or do nothing (the default). If non-nil, this should
2299 be a list of group name regexps that should match all groups in which
2300 to do ham article moving, associated with the destination
2301 group or nil for explicit ignoring. This only makes sense for
2302 mail groups, and only works in spam groups."
2303 :variable-group spam
2304 :variable-type
2316 :parameter-document
2320 ham-marks
2331 :parameter-document
2332 "Marks considered ham (positively not spam). Such articles will be
2333 processed as ham (non-spam) on group exit. When nil, the global
2334 spam-ham-marks variable takes precedence."
2336 gnus-read-mark
2337 gnus-killed-mark
2338 gnus-kill-file-mark
2339 gnus-low-score-mark))))
2340 :variable-group spam
2341 :variable-document
2345 spam-marks
2354 :parameter-document
2355 "Marks considered spam.
2356 Such articles will be processed as spam on group exit. When nil, the global
2357 spam-spam-marks variable takes precedence."
2359 :variable-group spam
2360 :variable-document
2364 "Number of group name elements to leave alone when making a short group name."
2369 "*If non-nil, once you set a level, Gnus will use this level."
2373 ;; Hooks.
2376 "A hook run while Gnus is loaded."
2381 "A hook called to apply kill files to a group.
2382 This hook is intended to apply a kill file to the selected newsgroup.
2383 The function `gnus-apply-kill-file' is called by default.
2385 Since a general kill file is too heavy to use only for a few
2386 newsgroups, I recommend you to use a lighter hook function. For
2387 example, if you'd like to apply a kill file to articles which contains
2388 a string `rmgroup' in subject in newsgroup `control', you can use the
2389 following hook:
2391 (setq gnus-apply-kill-hook
2392 (list
2393 (lambda ()
2402 "Function run when a group level is changed.
2403 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2406 function))
2408 ;;; Face thingies.
2412 mouse-face
2413 summary-menu group-menu article-menu
2414 tree-highlight menu highlight
2415 browse-menu server-menu
2416 page-marker tree-menu binary-menu pick-menu)
2417 "*Enable visual features.
2418 If `visual' is disabled, there will be no menus and few faces. Most of
2419 the visual customization options below will be ignored. Gnus will use
2420 less space and be faster as a result.
2422 This variable can also be a list of visual elements to switch on. For
2423 instance, to switch off all visual things except menus, you can say:
2425 (setq gnus-visual '(menu))
2427 Valid elements include `summary-highlight', `group-highlight',
2428 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2429 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2430 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2450 ;; Byte-compiler warning.
2452 ;; Find out whether the gnus-visual TYPE is wanted.
2456 gnus-visual
2460 t))))
2470 "*Face used for group or summary buffer mouse highlighting.
2471 The line beneath the mouse pointer will be highlighted with this
2472 face."
2485 "Controls use of the agent cache while plugged.
2486 When set, Gnus will prefer using the locally stored content rather
2487 than re-fetching it from the server. You also need to enable
2488 `gnus-agent' for this to have any affect."
2494 "Default charset assumed to be used when viewing non-ASCII characters.
2495 This variable is overridden on a group-to-group basis by the
2496 `gnus-group-charset-alist' variable and is only used on groups not
2497 covered by that variable."
2501 ;; Fixme: Doc reference to agent.
2503 "Whether we want to use the Gnus agent or not.
2505 You may customize gnus-agent to disable its use. However, some
2506 back ends have started to use the agent as a client-side cache.
2507 Disabling the agent may result in noticeable loss of performance."
2513 "Function called by the command `gnus-other-frame'."
2521 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2522 This should be an alist for Emacs, or a plist for XEmacs."
2533 "Which information should be exposed in the User-Agent header.
2535 Can be a list of symbols or a string. Valid symbols are `gnus'
2536 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2537 addition to the Emacs version, you can add `codename' \(show
2538 \(S\)XEmacs codename\) or either `config' \(show system
2539 configuration\) or `type' \(show system type\). If you set it to
2540 a string, be sure to use a valid format, see RFC 2616."
2553 ;; Convert old (< 2005-01-10) symbol type values:
2572 \f
2573 ;;; Internal variables
2578 ; Reset each time gnus-agent-covered-methods is changed else
2579 ; gnus-agent-method-p may mis-report a methods status.
2580 )
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"
2649 ;; Propagate flags to server, with the following exceptions:
2650 ;; `seen' is private to each gnus installation
2651 ;; `cache' is a internal gnus flag for each gnus installation
2652 ;; `download' is a agent flag private to each gnus installation
2653 ;; `unsend' are for nndraft groups only
2654 ;; `score' is not a proper mark
2655 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2658 "Marks that shouldn't be propagated to back ends.
2659 Typical marks are those that make no sense in a standalone back end,
2660 such as a mark that says whether an article is stored in the cache
2673 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2698 gnus-newsrc-last-checked-date
2699 gnus-newsrc-alist gnus-server-alist
2700 gnus-killed-list gnus-zombie-list
2701 gnus-topic-topology gnus-topic-alist
2702 gnus-format-specs)
2706 "Assoc list of read articles.
2710 "Assoc list of registry data.
2737 ;; Save window configuration.
2750 ;;; End of variables.
2752 ;; Define some autoload functions Gnus might use.
2755 ;; This little mapcar goes through the list below and marks the
2756 ;; symbols in question as autoloaded functions.
2776 message-send-and-exit message-yank-original)
2780 ;; This is only used in message.el, which has an autoload.
2782 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2784 ;; Next two only used in gnus-util.
2785 rmail-summary-exists rmail-select-summary)
2786 ;; Only used in gnus-util, which has an autoload.
2791 gnus-Folder-save-name gnus-folder-save-name)
2794 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2795 gnus-demon-add-disconnection gnus-demon-add-handler
2796 gnus-demon-remove-handler)
2798 gnus-demon-init gnus-demon-cancel)
2800 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2801 gnus-face-from-file)
2803 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2805 gnus-server-server-name)
2808 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2809 gnus-article-hide-citation gnus-article-fill-cited-article
2810 gnus-article-hide-citation-in-followups)
2812 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2813 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2815 gnus-cache-possibly-remove-articles gnus-cache-request-article
2816 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2817 gnus-cache-enter-remove-article gnus-cached-article-p
2818 gnus-cache-open gnus-cache-close gnus-cache-update-article
2819 gnus-cache-articles-in-group)
2821 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2823 gnus-summary-increase-score gnus-summary-set-score
2824 gnus-summary-raise-thread gnus-summary-raise-same-subject
2825 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2826 gnus-summary-lower-thread gnus-summary-lower-same-subject
2827 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2828 gnus-summary-current-score gnus-score-delta-default
2829 gnus-score-flush-cache gnus-score-close
2830 gnus-possibly-score-headers gnus-score-followup-article
2831 gnus-score-followup-thread)
2834 gnus-current-score-file-nondirectory gnus-score-adaptive
2835 gnus-score-find-trace gnus-score-file-name)
2839 gnus-subscribe-topics)
2843 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2844 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2845 gnus-uu-mark-by-regexp gnus-uu-mark-all
2846 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2847 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2848 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2849 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2850 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2851 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2852 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2853 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2856 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2858 gnus-group-post-news gnus-group-mail gnus-group-news
2859 gnus-summary-post-news gnus-summary-news-other-window
2860 gnus-summary-followup gnus-summary-followup-with-original
2861 gnus-summary-cancel-article gnus-summary-supersede-article
2862 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2863 gnus-summary-mail-forward gnus-summary-mail-other-window
2864 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2865 gnus-summary-wide-reply gnus-summary-followup-to-mail
2866 gnus-summary-followup-to-mail-with-original gnus-bug
2867 gnus-summary-wide-reply-with-original
2868 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2869 gnus-summary-post-forward)
2874 gnus-list-of-unread-articles gnus-list-of-read-articles
2875 gnus-offer-save-summaries gnus-make-thread-indent-array
2876 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2877 gnus-summary-skip-intangible gnus-summary-article-number
2878 gnus-data-header gnus-data-find)
2880 gnus-group-list-groups gnus-group-first-unread-group
2881 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2882 gnus-group-setup-buffer gnus-group-get-new-news
2883 gnus-group-make-help-group gnus-group-update-group
2884 gnus-group-iterate gnus-group-group-name)
2886 gnus-backlog-remove-article)
2888 gnus-article-prepare gnus-article-set-window-start
2889 gnus-article-next-page gnus-article-prev-page
2890 gnus-request-article-this-buffer gnus-article-mode
2891 gnus-article-setup-buffer gnus-narrow-to-page
2892 gnus-article-delete-invisible-text gnus-treat-article)
2894 gnus-article-hide-headers gnus-article-hide-boring-headers
2895 gnus-article-treat-overstrike
2896 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2897 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2898 gnus-article-de-base64-unreadable
2899 gnus-article-decode-HZ
2900 gnus-article-wash-html
2901 gnus-article-unsplit-urls
2902 gnus-article-hide-pem gnus-article-hide-signature
2903 gnus-article-strip-leading-blank-lines gnus-article-date-local
2904 gnus-article-date-original gnus-article-date-lapsed
2905 ;;gnus-article-show-all-headers
2906 gnus-article-edit-mode gnus-article-edit-article
2907 gnus-article-edit-done gnus-article-decode-encoded-words
2908 gnus-start-date-timer gnus-stop-date-timer
2909 gnus-mime-view-all-parts)
2912 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2913 gnus-check-reasonable-setup)
2915 gnus-dup-enter-articles)
2921 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2922 gnus-async-halt-prefetch)
2924 gnus-agent-save-active gnus-agent-method-p
2925 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2926 gnus-summary-set-agent-mark gnus-agent-save-group-info
2927 gnus-agent-request-article gnus-agent-retrieve-headers)
2929 gnus-unplugged gnus-agentize gnus-agent-batch)
2931 gnus-summary-save-article-vm)
2936 gnus-group-split-update)
2939 ;;; gnus-sum.el thingies
2943 "*The format specification of the lines in the summary buffer.
2945 It works along the same lines as a normal formatting string,
2946 with some simple extensions.
2948 %N Article number, left padded with spaces (string)
2949 %S Subject (string)
2951 %n Name of the poster (string)
2952 %a Extracted name of the poster (string)
2953 %A Extracted address of the poster (string)
2954 %F Contents of the From: header (string)
2955 %f Contents of the From: or To: headers (string)
2956 %x Contents of the Xref: header (string)
2957 %D Date of the article (string)
2958 %d Date of the article (string) in DD-MMM format
2959 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2960 %M Message-id of the article (string)
2961 %r References of the article (string)
2962 %c Number of characters in the article (integer)
2963 %k Pretty-printed version of the above (string)
2965 %L Number of lines in the article (integer)
2966 %I Indentation based on thread level (a string of spaces)
2967 %B A complex trn-style thread tree (string)
2968 The variables `gnus-sum-thread-*' can be used for customization.
2969 %T A string with two possible values: 80 spaces if the article
2970 is on thread level two or larger and 0 spaces on level one
2975 %> Spaces of length thread-level (string)
2976 %< Spaces of length (- 20 thread-level) (string)
2977 %i Article score (number)
2978 %z Article zcore (character)
2979 %t Number of articles under the current thread (number).
2980 %e Whether the thread is empty or not (character).
2981 %V Total thread score (number).
2982 %P The line number (number).
2983 %O Download mark (character).
2984 %* If present, indicates desired cursor position
2985 (instead of after first colon).
2986 %u User defined specifier. The next character in the format string should
2987 be a letter. Gnus will call the function gnus-user-format-function-X,
2988 where X is the letter following %u. The function will be passed the
2989 current header as argument. The function should return a string, which
2990 will be inserted into the summary just like information from any other
2991 summary specifier.
2993 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2994 with care. For reasons of efficiency, Gnus will compute what column
2996 it is invalid to have these specs after a variable-length spec. Well,
2997 you might not be arrested, but your summary buffer will look strange,
2998 which is bad enough.
3000 The smart choice is to have these specs as far to the left as
3001 possible.
3003 This restriction may disappear in later versions of Gnus.
3005 General format specifiers can also be used.
3006 See Info node `(gnus)Formatting Variables'."
3011 ;;;
3012 ;;; Skeleton keymaps
3013 ;;;
3018 (while keys
3019 (define-key keymap (pop keys) 'undefined))))
3021 (defvar gnus-article-mode-map
3022 (let ((keymap (make-sparse-keymap)))
3023 (gnus-suppress-keymap keymap)
3024 keymap))
3025 (defvar gnus-summary-mode-map
3026 (let ((keymap (make-keymap)))
3027 (gnus-suppress-keymap keymap)
3028 keymap))
3029 (defvar gnus-group-mode-map
3030 (let ((keymap (make-keymap)))
3031 (gnus-suppress-keymap keymap)
3032 keymap))
3034 \f
3036 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3037 ;; If you want the cursor to go somewhere else, set these two
3038 ;; functions in some startup hook to whatever you want.
3039 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3040 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3042 ;;; Various macros and substs.
3044 (defun gnus-header-from (header)
3045 (mail-header-from header))
3047 (defmacro gnus-gethash (string hashtable)
3048 "Get hash value of STRING in HASHTABLE."
3049 `(symbol-value (intern-soft ,string ,hashtable)))
3051 (defmacro gnus-gethash-safe (string hashtable)
3052 "Get hash value of STRING in HASHTABLE.
3053 Return nil if not defined."
3054 `(let ((sym (intern-soft ,string ,hashtable)))
3055 (and (boundp sym) (symbol-value sym))))
3057 (defmacro gnus-sethash (string value hashtable)
3058 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3059 `(set (intern ,string ,hashtable) ,value))
3060 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3062 (defmacro gnus-group-unread (group)
3063 "Get the currently computed number of unread articles in GROUP."
3064 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3066 (defmacro gnus-group-entry (group)
3067 "Get the newsrc entry for GROUP."
3068 `(gnus-gethash ,group gnus-newsrc-hashtb))
3070 (defmacro gnus-active (group)
3071 "Get active info on GROUP."
3072 `(gnus-gethash ,group gnus-active-hashtb))
3074 (defmacro gnus-set-active (group active)
3075 "Set GROUP's active info."
3076 `(gnus-sethash ,group ,active gnus-active-hashtb))
3078 ;; Info access macros.
3080 (defmacro gnus-info-group (info)
3081 `(nth 0 ,info))
3082 (defmacro gnus-info-rank (info)
3083 `(nth 1 ,info))
3084 (defmacro gnus-info-read (info)
3085 `(nth 2 ,info))
3086 (defmacro gnus-info-marks (info)
3087 `(nth 3 ,info))
3088 (defmacro gnus-info-method (info)
3089 `(nth 4 ,info))
3090 (defmacro gnus-info-params (info)
3091 `(nth 5 ,info))
3093 (defmacro gnus-info-level (info)
3094 `(let ((rank (gnus-info-rank ,info)))
3095 (if (consp rank)
3096 (car rank)
3097 rank)))
3098 (defmacro gnus-info-score (info)
3099 `(let ((rank (gnus-info-rank ,info)))
3100 (or (and (consp rank) (cdr rank)) 0)))
3102 (defmacro gnus-info-set-group (info group)
3103 `(setcar ,info ,group))
3104 (defmacro gnus-info-set-rank (info rank)
3105 `(setcar (nthcdr 1 ,info) ,rank))
3106 (defmacro gnus-info-set-read (info read)
3107 `(setcar (nthcdr 2 ,info) ,read))
3108 (defmacro gnus-info-set-marks (info marks &optional extend)
3109 (if extend
3110 `(gnus-info-set-entry ,info ,marks 3)
3111 `(setcar (nthcdr 3 ,info) ,marks)))
3112 (defmacro gnus-info-set-method (info method &optional extend)
3113 (if extend
3114 `(gnus-info-set-entry ,info ,method 4)
3115 `(setcar (nthcdr 4 ,info) ,method)))
3116 (defmacro gnus-info-set-params (info params &optional extend)
3117 (if extend
3118 `(gnus-info-set-entry ,info ,params 5)
3119 `(setcar (nthcdr 5 ,info) ,params)))
3121 (defun gnus-info-set-entry (info entry number)
3122 ;; Extend the info until we have enough elements.
3123 (while (<= (length info) number)
3124 (nconc info (list nil)))
3125 ;; Set the entry.
3126 (setcar (nthcdr number info) entry))
3128 (defmacro gnus-info-set-level (info level)
3129 `(let ((rank (cdr ,info)))
3130 (if (consp (car rank))
3131 (setcar (car rank) ,level)
3132 (setcar rank ,level))))
3133 (defmacro gnus-info-set-score (info score)
3134 `(let ((rank (cdr ,info)))
3135 (if (consp (car rank))
3136 (setcdr (car rank) ,score)
3137 (setcar rank (cons (car rank) ,score)))))
3139 (defmacro gnus-get-info (group)
3140 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3142 ;;; Load the compatibility functions.
3144 (require 'gnus-ems)
3146 \f
3147 ;;;
3148 ;;; Shutdown
3149 ;;;
3151 (defvar gnus-shutdown-alist nil)
3153 (defun gnus-add-shutdown (function &rest symbols)
3154 "Run FUNCTION whenever one of SYMBOLS is shut down."
3155 (push (cons function symbols) gnus-shutdown-alist))
3157 (defun gnus-shutdown (symbol)
3158 "Shut down everything that waits for SYMBOL."
3159 (dolist (entry gnus-shutdown-alist)
3160 (when (memq symbol (cdr entry))
3161 (funcall (car entry)))))
3163 \f
3164 ;;;
3165 ;;; Gnus Utility Functions
3166 ;;;
3168 (defun gnus-find-subscribed-addresses ()
3169 "Return a regexp matching the addresses of all subscribed mail groups.
3170 It consists of the `to-address' or `to-list' parameter of all groups
3171 with a `subscribed' parameter."
3172 (let (group address addresses)
3173 (dolist (entry (cdr gnus-newsrc-alist))
3174 (setq group (car entry))
3175 (when (gnus-parameter-subscribed group)
3176 (setq address (mail-strip-quoted-names
3177 (or (gnus-group-fast-parameter group 'to-address)
3178 (gnus-group-fast-parameter group 'to-list))))
3179 (when address
3180 (add-to-list 'addresses address))))
3181 (when addresses
3184 (defmacro gnus-string-or (&rest strings)
3185 "Return the first element of STRINGS that is a non-blank string.
3186 STRINGS will be evaluated in normal `or' order."
3187 `(gnus-string-or-1 (list ,@strings)))
3189 (defun gnus-string-or-1 (strings)
3190 (let (string)
3191 (while strings
3192 (setq string (pop strings))
3194 (setq string nil)
3195 (setq strings nil)))
3196 string))
3198 (defun gnus-version (&optional arg)
3199 "Version number of this version of Gnus.
3200 If ARG, insert string at point."
3201 (interactive "P")
3202 (if arg
3203 (insert (message gnus-version))
3204 (message gnus-version)))
3206 (defun gnus-continuum-version (&optional version)
3207 "Return VERSION as a floating point number."
3208 (interactive)
3209 (unless version
3210 (setq version gnus-version))
3213 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3214 (number (match-string 2 version))
3215 major minor least)
3216 (unless (string-match
3218 (error "Invalid version string: %s" version))
3219 (setq major (string-to-number (match-string 1 number))
3220 minor (string-to-number (match-string 2 number))
3221 least (if (match-beginning 3)
3222 (string-to-number (match-string 3 number))
3223 0))
3224 (string-to-number
3225 (if (zerop major)
3226 (format "%s00%02d%02d"
3227 (if (member alpha '("(ding)" "d"))
3228 "4.99"
3229 (+ 5 (* 0.02
3230 (abs
3231 (- (mm-char-int (aref (downcase alpha) 0))
3232 (mm-char-int ?t))))
3233 -0.01))
3234 minor least)
3235 (format "%d.%02d%02d" major minor least))))))
3237 (defun gnus-info-find-node (&optional nodename)
3238 "Find Info documentation of Gnus."
3239 (interactive)
3240 ;; Enlarge info window if needed.
3241 (let (gnus-info-buffer)
3242 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3243 (setq gnus-info-buffer (current-buffer))
3244 (gnus-configure-windows 'info)))
3246 ;;;
3247 ;;; gnus-interactive
3248 ;;;
3250 (defvar gnus-current-prefix-symbol nil
3251 "Current prefix symbol.")
3253 (defvar gnus-current-prefix-symbols nil
3254 "List of current prefix symbols.")
3256 (defun gnus-interactive (string &optional params)
3257 "Return a list that can be fed to `interactive'.
3258 See `interactive' for full documentation.
3260 Adds the following specs:
3262 y -- The current symbolic prefix.
3263 Y -- A list of the current symbolic prefix(es).
3264 A -- Article number.
3265 H -- Article header.
3266 g -- Group name."
3267 (let ((i 0)
3268 out c prompt)
3269 (while (< i (length string))
3271 (setq c (aref string i))
3272 (when (match-end 1)
3273 (setq prompt (match-string 1 string)))
3274 (setq i (match-end 0))
3275 ;; We basically emulate just about everything that
3276 ;; `interactive' does, but add the specs listed above.
3277 (push
3278 (cond
3279 ((= c ?a)
3280 (completing-read prompt obarray 'fboundp t))
3281 ((= c ?b)
3282 (read-buffer prompt (current-buffer) t))
3283 ((= c ?B)
3284 (read-buffer prompt (other-buffer (current-buffer))))
3285 ((= c ?c)
3286 (read-char))
3287 ((= c ?C)
3288 (completing-read prompt obarray 'commandp t))
3289 ((= c ?d)
3290 (point))
3291 ((= c ?D)
3292 (read-file-name prompt nil default-directory 'lambda))
3293 ((= c ?f)
3294 (read-file-name prompt nil nil 'lambda))
3295 ((= c ?F)
3296 (read-file-name prompt))
3297 ((= c ?k)
3298 (read-key-sequence prompt))
3299 ((= c ?K)
3300 (error "Not implemented spec"))
3301 ((= c ?e)
3302 (error "Not implemented spec"))
3303 ((= c ?m)
3304 (mark))
3305 ((= c ?N)
3306 (error "Not implemented spec"))
3307 ((= c ?n)
3308 (string-to-number (read-from-minibuffer prompt)))
3309 ((= c ?p)
3310 (prefix-numeric-value current-prefix-arg))
3311 ((= c ?P)
3312 current-prefix-arg)
3313 ((= c ?r)
3314 'gnus-prefix-nil)
3315 ((= c ?s)
3316 (read-string prompt))
3317 ((= c ?S)
3318 (intern (read-string prompt)))
3319 ((= c ?v)
3320 (read-variable prompt))
3321 ((= c ?x)
3322 (read-minibuffer prompt))
3323 ((= c ?x)
3324 (eval-minibuffer prompt))
3325 ;; And here the new specs come.
3326 ((= c ?y)
3327 gnus-current-prefix-symbol)
3328 ((= c ?Y)
3329 gnus-current-prefix-symbols)
3330 ((= c ?g)
3331 (gnus-group-group-name))
3332 ((= c ?A)
3333 (gnus-summary-skip-intangible)
3334 (or (get-text-property (point) 'gnus-number)
3335 (gnus-summary-last-subject)))
3336 ((= c ?H)
3337 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3338 (t
3339 (error "Non-implemented spec")))
3340 out)
3341 (cond
3342 ((= c ?r)
3343 (push (if (< (point) (mark)) (point) (mark)) out)
3344 (push (if (> (point) (mark)) (point) (mark)) out))))
3345 (setq out (delq 'gnus-prefix-nil out))
3346 (nreverse out)))
3348 (defun gnus-symbolic-argument (&optional arg)
3349 "Read a symbolic argument and a command, and then execute command."
3350 (interactive "P")
3351 (let* ((in-command (this-command-keys))
3352 (command in-command)
3353 gnus-current-prefix-symbols
3354 gnus-current-prefix-symbol
3355 syms)
3356 (while (equal in-command command)
3357 (message "%s-" (key-description (this-command-keys)))
3358 (push (intern (char-to-string (read-char))) syms)
3359 (setq command (read-key-sequence nil t)))
3360 (setq gnus-current-prefix-symbols (nreverse syms)
3361 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3362 (call-interactively (key-binding command t))))
3364 ;;; More various functions.
3366 (defsubst gnus-check-backend-function (func group)
3367 "Check whether GROUP supports function FUNC.
3368 GROUP can either be a string (a group name) or a select method."
3369 (ignore-errors
3370 (let ((method (if (stringp group)
3371 (car (gnus-find-method-for-group group))
3372 group)))
3373 (unless (featurep method)
3374 (require method))
3375 (fboundp (intern (format "%s-%s" method func))))))
3377 (defun gnus-group-read-only-p (&optional group)
3378 "Check whether GROUP supports editing or not.
3379 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3380 that that variable is buffer-local to the summary buffers."
3381 (let ((group (or group gnus-newsgroup-name)))
3382 (not (gnus-check-backend-function 'request-replace-article group))))
3384 (defun gnus-virtual-group-p (group)
3385 "Say whether GROUP is virtual or not."
3386 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3387 gnus-valid-select-methods)))
3389 (defun gnus-news-group-p (group &optional article)
3390 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3391 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3392 t) ;is news of course.
3393 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3394 nil) ;must be mail then.
3395 ((vectorp article) ;Has header info.
3396 (eq (gnus-request-type group (mail-header-id article)) 'news))
3397 ((null article) ;Hasn't header info
3398 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3399 ((< article 0) ;Virtual message
3400 nil) ;we don't know, guess mail.
3401 (t ;Has positive number
3402 (eq (gnus-request-type group article) 'news)))) ;use it.
3404 ;; Returns a list of writable groups.
3405 (defun gnus-writable-groups ()
3406 (let ((alist gnus-newsrc-alist)
3407 groups group)
3408 (while (setq group (car (pop alist)))
3409 (unless (gnus-group-read-only-p group)
3410 (push group groups)))
3411 (nreverse groups)))
3413 ;; Check whether to use long file names.
3414 (defun gnus-use-long-file-name (symbol)
3415 ;; The variable has to be set...
3416 (and gnus-use-long-file-name
3417 ;; If it isn't a list, then we return t.
3418 (or (not (listp gnus-use-long-file-name))
3419 ;; If it is a list, and the list contains `symbol', we
3420 ;; return nil.
3421 (not (memq symbol gnus-use-long-file-name)))))
3423 ;; Generate a unique new group name.
3424 (defun gnus-generate-new-group-name (leaf)
3425 (let ((name leaf)
3426 (num 0))
3427 (while (gnus-group-entry name)
3428 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3429 name))
3431 (defun gnus-ephemeral-group-p (group)
3432 "Say whether GROUP is ephemeral or not."
3433 (gnus-group-get-parameter group 'quit-config t))
3435 (defun gnus-group-quit-config (group)
3436 "Return the quit-config of GROUP."
3437 (gnus-group-get-parameter group 'quit-config t))
3439 (defun gnus-kill-ephemeral-group (group)
3440 "Remove ephemeral GROUP from relevant structures."
3441 (gnus-sethash group nil gnus-newsrc-hashtb))
3443 (defun gnus-simplify-mode-line ()
3444 "Make mode lines a bit simpler."
3445 (setq mode-line-modified (cdr gnus-mode-line-modified))
3446 (when (listp mode-line-format)
3447 (make-local-variable 'mode-line-format)
3448 (setq mode-line-format (copy-sequence mode-line-format))
3449 (when (equal (nth 3 mode-line-format) " ")
3450 (setcar (nthcdr 3 mode-line-format) " "))))
3452 ;;; Servers and groups.
3454 (defsubst gnus-server-add-address (method)
3455 (let ((method-name (symbol-name (car method))))
3456 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3457 (not (assq (intern (concat method-name "-address")) method))
3458 (memq 'physical-address (assq (car method)
3459 gnus-valid-select-methods)))
3460 (append method (list (list (intern (concat method-name "-address"))
3461 (nth 1 method))))
3462 method)))
3464 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3465 (catch 'server-name
3466 (setq method (or method gnus-select-method))
3468 ;; Perhaps it is already in the cache.
3469 (unless nocache
3470 (mapc (lambda (name-method)
3471 (if (equal (cdr name-method) method)
3472 (throw 'server-name (car name-method))))
3473 gnus-server-method-cache))
3475 (mapc
3476 (lambda (server-alist)
3477 (mapc (lambda (name-method)
3478 (when (gnus-methods-equal-p (cdr name-method) method)
3479 (unless (member name-method gnus-server-method-cache)
3480 (push name-method gnus-server-method-cache))
3481 (throw 'server-name (car name-method))))
3482 server-alist))
3483 (list gnus-server-alist
3484 gnus-predefined-server-alist))
3486 (let* ((name (if (member (cadr method) '(nil ""))
3487 (format "%s" (car method))
3488 (format "%s:%s" (car method) (cadr method))))
3489 (name-method (cons name method)))
3490 (when (and (not (member name-method gnus-server-method-cache))
3491 (not no-enter-cache)
3492 (not (assoc (car name-method) gnus-server-method-cache)))
3493 (push name-method gnus-server-method-cache))
3494 name)))
3496 (defsubst gnus-server-to-method (server)
3497 "Map virtual server names to select methods."
3498 (or (and server (listp server) server)
3499 (cdr (assoc server gnus-server-method-cache))
3500 (let ((result
3501 (or
3502 ;; Perhaps this is the native server?
3503 (and (equal server "native") gnus-select-method)
3504 ;; It should be in the server alist.
3505 (cdr (assoc server gnus-server-alist))
3506 ;; It could be in the predefined server alist.
3507 (cdr (assoc server gnus-predefined-server-alist))
3508 ;; If not, we look through all the opened server
3509 ;; to see whether we can find it there.
3510 (let ((opened gnus-opened-servers))
3511 (while (and opened
3512 (not (equal server (format "%s:%s" (caaar opened)
3513 (cadaar opened)))))
3514 (pop opened))
3515 (caar opened))
3516 ;; It could be a named method, search all servers
3517 (let ((servers gnus-secondary-select-methods))
3518 (while (and servers
3519 (not (equal server (format "%s:%s" (caar servers)
3520 (cadar servers)))))
3521 (pop servers))
3522 (car servers))
3523 ;; This could be some sort of foreign server that I
3524 ;; simply haven't opened (yet). Do a brute-force scan
3525 ;; of the entire gnus-newsrc-alist for the server name
3526 ;; of every method. As a side-effect, loads the
3527 ;; gnus-server-method-cache so this only happens once,
3528 ;; if at all.
3529 (let ((alist (cdr gnus-newsrc-alist))
3530 method match)
3531 (while alist
3532 (setq method (gnus-info-method (pop alist)))
3533 (when (and (not (stringp method))
3534 (equal server
3535 (gnus-method-to-server method nil t)))
3536 (setq match method
3537 alist nil)))
3538 match))))
3539 (when (and result
3540 (not (assoc server gnus-server-method-cache)))
3541 (push (cons server result) gnus-server-method-cache))
3542 result)))
3544 (defsubst gnus-server-get-method (group method)
3545 ;; Input either a server name, and extended server name, or a
3546 ;; select method, and return a select method.
3547 (cond ((stringp method)
3548 (gnus-server-to-method method))
3549 ((equal method gnus-select-method)
3550 gnus-select-method)
3551 ((and (stringp (car method))
3552 group)
3553 (gnus-server-extend-method group method))
3554 ((and method
3555 (not group)
3556 (equal (cadr method) ""))
3557 method)
3558 (t
3559 (gnus-server-add-address method))))
3561 (defmacro gnus-method-equal (ss1 ss2)
3562 "Say whether two servers are equal."
3563 `(let ((s1 ,ss1)
3564 (s2 ,ss2))
3565 (or (equal s1 s2)
3566 (and (= (length s1) (length s2))
3567 (progn
3568 (while (and s1 (member (car s1) s2))
3569 (setq s1 (cdr s1)))
3570 (null s1))))))
3572 (defun gnus-methods-equal-p (m1 m2)
3573 (let ((m1 (or m1 gnus-select-method))
3574 (m2 (or m2 gnus-select-method)))
3575 (or (equal m1 m2)
3576 (and (eq (car m1) (car m2))
3577 (or (not (memq 'address (assoc (symbol-name (car m1))
3578 gnus-valid-select-methods)))
3579 (equal (nth 1 m1) (nth 1 m2)))))))
3581 (defun gnus-methods-sloppily-equal (m1 m2)
3582 ;; Same method.
3583 (or
3584 (eq m1 m2)
3585 ;; Type and name are equal.
3586 (and
3587 (eq (car m1) (car m2))
3588 (equal (cadr m1) (cadr m2))
3589 (gnus-sloppily-equal-method-parameters m1 m2))))
3591 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3592 ;; Check parameters for sloppy equalness.
3593 (let ((p1 (copy-sequence (cddr m1)))
3594 (p2 (copy-sequence (cddr m2)))
3595 e1 e2)
3596 (block nil
3597 (while (setq e1 (pop p1))
3598 (unless (setq e2 (assq (car e1) p2))
3599 ;; The parameter doesn't exist in p2.
3600 (return nil))
3601 (setq p2 (delq e2 p2))
3602 (unless (equal e1 e2)
3603 (if (not (and (stringp (cadr e1))
3604 (stringp (cadr e2))))
3605 (return nil)
3606 ;; Special-case string parameter comparison so that we
3607 ;; can uniquify them.
3608 (let ((s1 (cadr e1))
3609 (s2 (cadr e2)))
3610 (when (string-match "/$" s1)
3611 (setq s1 (directory-file-name s1)))
3612 (when (string-match "/$" s2)
3613 (setq s2 (directory-file-name s2)))
3614 (unless (equal s1 s2)
3615 (return nil))))))
3616 ;; If p2 now is empty, they were equal.
3617 (null p2))))
3619 (defun gnus-server-equal (m1 m2)
3620 "Say whether two methods are equal."
3621 (let ((m1 (cond ((null m1) gnus-select-method)
3622 ((stringp m1) (gnus-server-to-method m1))
3623 (t m1)))
3624 (m2 (cond ((null m2) gnus-select-method)
3625 ((stringp m2) (gnus-server-to-method m2))
3626 (t m2))))
3627 (gnus-method-equal m1 m2)))
3629 (defun gnus-servers-using-backend (backend)
3630 "Return a list of known servers using BACKEND."
3631 (let ((opened gnus-opened-servers)
3632 out)
3633 (while opened
3634 (when (eq backend (caaar opened))
3635 (push (caar opened) out))
3636 (pop opened))
3637 out))
3639 (defun gnus-archive-server-wanted-p ()
3640 "Say whether the user wants to use the archive server."
3641 (cond
3642 ((or (not gnus-message-archive-method)
3643 (not gnus-message-archive-group))
3644 nil)
3645 ((and gnus-message-archive-method gnus-message-archive-group)
3646 t)
3647 (t
3648 (let ((active (cadr (assq 'nnfolder-active-file
3649 gnus-message-archive-method))))
3650 (and active
3651 (file-exists-p active))))))
3653 (defsubst gnus-method-to-server-name (method)
3654 (concat
3655 (format "%s" (car method))
3656 (when (and
3657 (or (assoc (format "%s" (car method))
3658 (gnus-methods-using 'address))
3659 (gnus-server-equal method gnus-message-archive-method))
3660 (nth 1 method)
3661 (not (string= (nth 1 method) "")))
3662 (concat "+" (nth 1 method)))))
3664 (defsubst gnus-method-to-full-server-name (method)
3665 (format "%s+%s" (car method) (nth 1 method)))
3667 (defun gnus-group-prefixed-name (group method &optional full)
3668 "Return the whole name from GROUP and METHOD.
3669 Call with full set to get the fully qualified group name (even if the
3670 server is native)."
3671 (when (stringp method)
3672 (setq method (gnus-server-to-method method)))
3673 (if (or (not method)
3674 (and (not full) (gnus-server-equal method "native"))
3675 ;;;!!! This might not be right. We'll see...
3676 ;(string-match ":" group)
3677 )
3678 group
3679 (concat (gnus-method-to-server-name method) ":" group)))
3681 (defun gnus-group-guess-prefixed-name (group)
3682 "Guess the whole name from GROUP and METHOD."
3683 (gnus-group-prefixed-name group (gnus-find-method-for-group
3684 group)))
3686 (defun gnus-group-full-name (group method)
3687 "Return the full name from GROUP and METHOD, even if the method is native."
3688 (gnus-group-prefixed-name group method t))
3690 (defun gnus-group-guess-full-name (group)
3691 "Guess the full name from GROUP, even if the method is native."
3692 (if (gnus-group-prefixed-p group)
3693 group
3694 (gnus-group-full-name group (gnus-find-method-for-group group))))
3696 (defun gnus-group-guess-full-name-from-command-method (group)
3697 "Guess the full name from GROUP, even if the method is native."
3698 (if (gnus-group-prefixed-p group)
3699 group
3700 (gnus-group-full-name group gnus-command-method)))
3702 (defun gnus-group-real-prefix (group)
3703 "Return the prefix of the current group name."
3704 (if (stringp group)
3705 (if (string-match "^[^:]+:" group)
3706 (substring group 0 (match-end 0))
3707 "")
3708 nil))
3710 (defun gnus-group-short-name (group)
3711 "Return the short group name."
3712 (let ((prefix (gnus-group-real-prefix group)))
3713 (if (< 0 (length prefix))
3714 (substring group (length prefix) nil)
3715 group)))
3717 (defun gnus-group-prefixed-p (group)
3718 "Return the prefix of the current group name."
3719 (< 0 (length (gnus-group-real-prefix group))))
3721 (declare-function gnus-group-decoded-name "gnus-group" (string))
3723 (defun gnus-summary-buffer-name (group)
3724 "Return the summary buffer name of GROUP."
3725 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3727 (defun gnus-group-method (group)
3728 "Return the server or method used for selecting GROUP.
3729 You should probably use `gnus-find-method-for-group' instead."
3730 (let ((prefix (gnus-group-real-prefix group)))
3731 (if (equal prefix "")
3732 gnus-select-method
3733 (let ((servers gnus-opened-servers)
3734 (server "")
3735 backend possible found)
3737 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3738 server (substring prefix (match-end 0) (1- (length prefix))))
3739 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3740 (while servers
3741 (when (eq (caaar servers) backend)
3742 (setq possible (caar servers))
3743 (when (equal (cadaar servers) server)
3744 (setq found (caar servers))))
3745 (pop servers))
3746 (or (car (rassoc found gnus-server-alist))
3747 found
3748 (car (rassoc possible gnus-server-alist))
3749 possible
3750 (list backend server))))))
3752 (defsubst gnus-native-method-p (method)
3753 "Return whether METHOD is the native select method."
3754 (gnus-method-equal method gnus-select-method))
3756 (defsubst gnus-secondary-method-p (method)
3757 "Return whether METHOD is a secondary select method."
3758 (let ((methods gnus-secondary-select-methods)
3759 (gmethod (inline (gnus-server-get-method nil method))))
3760 (while (and methods
3761 (not (gnus-method-equal
3762 (inline (gnus-server-get-method nil (car methods)))
3763 gmethod)))
3764 (setq methods (cdr methods)))
3765 methods))
3767 (defun gnus-method-simplify (method)
3768 "Return the shortest uniquely identifying string or method for METHOD."
3769 (cond ((stringp method)
3770 method)
3771 ((gnus-native-method-p method)
3772 nil)
3773 ((gnus-secondary-method-p method)
3774 (format "%s:%s" (nth 0 method) (nth 1 method)))
3775 (t
3776 method)))
3778 (defun gnus-groups-from-server (server)
3779 "Return a list of all groups that are fetched from SERVER."
3780 (let ((alist (cdr gnus-newsrc-alist))
3781 info groups)
3782 (while (setq info (pop alist))
3783 (when (gnus-server-equal (gnus-info-method info) server)
3784 (push (gnus-info-group info) groups)))
3785 (sort groups 'string<)))
3787 (defun gnus-group-foreign-p (group)
3788 "Say whether a group is foreign or not."
3789 (and (not (gnus-group-native-p group))
3790 (not (gnus-group-secondary-p group))))
3792 (defun gnus-group-native-p (group)
3793 "Say whether the group is native or not."
3794 (not (string-match ":" group)))
3796 (defun gnus-group-secondary-p (group)
3797 "Say whether the group is secondary or not."
3798 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3800 (defun gnus-parameters-get-parameter (group)
3801 "Return the group parameters for GROUP from `gnus-parameters'."
3802 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3803 case-fold-search
3804 gnus-parameters-case-fold-search))
3805 params-list)
3806 (dolist (elem gnus-parameters)
3807 (when (string-match (car elem) group)
3808 (setq params-list
3809 (nconc (gnus-expand-group-parameters
3810 (car elem) (cdr elem) group)
3811 params-list))))
3812 params-list))
3814 (defun gnus-expand-group-parameter (match value group)
3815 "Use MATCH to expand VALUE in GROUP."
3816 (with-temp-buffer
3817 (insert group)
3818 (goto-char (point-min))
3819 (while (re-search-forward match nil t)
3820 (replace-match value))
3821 (buffer-string)))
3823 (defun gnus-expand-group-parameters (match parameters group)
3824 "Go through PARAMETERS and expand them according to the match data."
3825 (let (new)
3826 (dolist (elem parameters)
3827 (if (and (stringp (cdr elem))
3829 (push (cons (car elem)
3830 (gnus-expand-group-parameter match (cdr elem) group))
3831 new)
3832 (push elem new)))
3833 new))
3835 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3836 "For GROUP, return the value of SYMBOL.
3838 You should call this in the `gnus-group-buffer' buffer.
3839 The function `gnus-group-find-parameter' will do that for you."
3840 ;; The speed trick: No cons'ing and quit early.
3841 (let* ((params (funcall gnus-group-get-parameter-function group))
3842 ;; Start easy, check the "real" group parameters.
3843 (simple-results
3844 (gnus-group-parameter-value params symbol allow-list t)))
3845 (if simple-results
3846 ;; Found results; return them.
3847 (car simple-results)
3848 ;; We didn't find it there, try `gnus-parameters'.
3849 (let ((result nil)
3850 (head nil)
3851 (tail gnus-parameters))
3852 ;; A good old-fashioned non-cl loop.
3853 (while tail
3854 (setq head (car tail)
3855 tail (cdr tail))
3856 ;; The car is regexp matching for matching the group name.
3857 (when (string-match (car head) group)
3858 ;; The cdr is the parameters.
3859 (setq result (gnus-group-parameter-value (cdr head)
3860 symbol allow-list))
3861 (when result
3862 ;; Expand if necessary.
3864 (setq result (gnus-expand-group-parameter (car head)
3865 result group)))
3866 ;; Exit the loop early.
3867 (setq tail nil))))
3868 ;; Done.
3869 result))))
3871 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3872 "Return the group parameters for GROUP.
3873 If SYMBOL, return the value of that symbol in the group parameters.
3875 If you call this function inside a loop, consider using the faster
3876 `gnus-group-fast-parameter' instead."
3877 (with-current-buffer gnus-group-buffer
3878 (if symbol
3879 (gnus-group-fast-parameter group symbol allow-list)
3880 (nconc
3881 (copy-sequence
3882 (funcall gnus-group-get-parameter-function group))
3883 (gnus-parameters-get-parameter group)))))
3885 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3886 "Return the group parameters for GROUP.
3887 If SYMBOL, return the value of that symbol in the group parameters.
3888 If ALLOW-LIST, also allow list as a result.
3889 Most functions should use `gnus-group-find-parameter', which
3890 also examines the topic parameters."
3891 (let ((params (gnus-info-params (gnus-get-info group))))
3892 (if symbol
3893 (gnus-group-parameter-value params symbol allow-list)
3894 params)))
3896 (defun gnus-group-parameter-value (params symbol &optional
3897 allow-list present-p)
3898 "Return the value of SYMBOL in group PARAMS.
3899 If ALLOW-LIST, also allow list as a result."
3900 ;; We only wish to return group parameters (dotted lists) and
3901 ;; not local variables, which may have the same names.
3902 ;; But first we handle single elements...
3903 (or (car (memq symbol params))
3904 ;; Handle alist.
3905 (let (elem)
3906 (catch 'found
3907 (while (setq elem (pop params))
3908 (when (and (consp elem)
3909 (eq (car elem) symbol)
3910 (or allow-list
3911 (atom (cdr elem))))
3912 (throw 'found (if present-p (list (cdr elem))
3913 (cdr elem)))))))))
3915 (defun gnus-group-add-parameter (group param)
3916 "Add parameter PARAM to GROUP."
3917 (let ((info (gnus-get-info group)))
3918 (when info
3919 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3920 ;; Cons the new param to the old one and update.
3921 (gnus-group-set-info (cons param (gnus-info-params info))
3922 group 'params))))
3924 (defun gnus-group-set-parameter (group name value)
3925 "Set parameter NAME to VALUE in GROUP."
3926 (let ((info (gnus-get-info group)))
3927 (when info
3928 (gnus-group-remove-parameter group name)
3929 (let ((old-params (gnus-info-params info))
3930 (new-params (list (cons name value))))
3931 (while old-params
3932 (when (or (not (listp (car old-params)))
3933 (not (eq (caar old-params) name)))
3934 (setq new-params (append new-params (list (car old-params)))))
3935 (setq old-params (cdr old-params)))
3936 (gnus-group-set-info new-params group 'params)))))
3938 (defun gnus-group-remove-parameter (group name)
3939 "Remove parameter NAME from GROUP."
3940 (let ((info (gnus-get-info group)))
3941 (when info
3942 (let ((params (gnus-info-params info)))
3943 (when params
3944 (setq params (delq name params))
3945 (while (assq name params)
3946 (gnus-pull name params))
3947 (gnus-info-set-params info params))))))
3949 (defun gnus-group-add-score (group &optional score)
3950 "Add SCORE to the GROUP score.
3951 If SCORE is nil, add 1 to the score of GROUP."
3952 (let ((info (gnus-get-info group)))
3953 (when info
3954 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3956 (defun gnus-short-group-name (group &optional levels)
3957 "Collapse GROUP name LEVELS.
3958 Select methods are stripped and any remote host name is stripped down to
3959 just the host name."
3960 (let* ((name "")
3961 (foreign "")
3962 (depth 0)
3963 (skip 1)
3964 (levels (or levels
3965 gnus-group-uncollapsed-levels
3966 (progn
3968 (setq skip (match-end 0)
3969 depth (+ depth 1)))
3970 depth))))
3971 ;; Separate foreign select method from group name and collapse.
3972 ;; If method contains a server, collapse to non-domain server name,
3973 ;; otherwise collapse to select method.
3974 (let* ((colon (string-match ":" group))
3975 (server (and colon (substring group 0 colon)))
3976 (plus (and server (string-match "+" server))))
3977 (when server
3978 (if plus
3979 (setq foreign (substring server (+ 1 plus)
3981 group (substring group (+ 1 colon)))
3982 (setq foreign server
3983 group (substring group (+ 1 colon))))
3984 (setq foreign (concat foreign ":")))
3985 ;; Collapse group name leaving LEVELS uncollapsed elements
3986 (let* ((slist (split-string group "/"))
3987 (slen (length slist))
3989 (dlen (length dlist))
3990 glist
3991 glen
3992 gsep
3993 res)
3994 (if (> slen dlen)
3995 (setq glist slist
3996 glen slen
3997 gsep "/")
3998 (setq glist dlist
3999 glen dlen
4000 gsep "."))
4001 (setq levels (- glen levels))
4002 (dolist (g glist)
4003 (push (if (>= (decf levels) 0)
4004 (if (zerop (length g))
4005 ""
4006 (substring g 0 1))
4007 g)
4008 res))
4009 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4011 (defun gnus-narrow-to-body ()
4012 "Narrow to the body of an article."
4013 (narrow-to-region
4014 (progn
4015 (goto-char (point-min))
4017 (point-max)))
4018 (point-max)))
4020 \f
4021 ;;;
4022 ;;; Kill file handling.
4023 ;;;
4025 (defun gnus-apply-kill-file ()
4026 "Apply a kill file to the current newsgroup.
4027 Returns the number of articles marked as read."
4028 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4029 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4030 (gnus-apply-kill-file-internal)
4031 0))
4033 (defun gnus-kill-save-kill-buffer ()
4034 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4035 (when (get-file-buffer file)
4036 (with-current-buffer (get-file-buffer file)
4037 (when (buffer-modified-p)
4038 (save-buffer))
4039 (kill-buffer (current-buffer))))))
4041 (defcustom gnus-kill-file-name "KILL"
4042 "Suffix of the kill files."
4043 :group 'gnus-score-kill
4044 :group 'gnus-score-files
4045 :type 'string)
4047 (defun gnus-newsgroup-kill-file (newsgroup)
4048 "Return the name of a kill file name for NEWSGROUP.
4049 If NEWSGROUP is nil, return the global kill file name instead."
4050 (cond
4051 ;; The global KILL file is placed at top of the directory.
4052 ((or (null newsgroup)
4053 (string-equal newsgroup ""))
4054 (expand-file-name gnus-kill-file-name
4055 gnus-kill-files-directory))
4056 ;; Append ".KILL" to newsgroup name.
4057 ((gnus-use-long-file-name 'not-kill)
4058 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4059 "." gnus-kill-file-name)
4060 gnus-kill-files-directory))
4061 ;; Place "KILL" under the hierarchical directory.
4062 (t
4063 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4064 "/" gnus-kill-file-name)
4065 gnus-kill-files-directory))))
4067 ;;; Server things.
4069 (defun gnus-member-of-valid (symbol group)
4071 (memq symbol (assoc
4072 (symbol-name (car (gnus-find-method-for-group group)))
4073 gnus-valid-select-methods)))
4075 (defun gnus-method-option-p (method option)
4076 "Return non-nil if select METHOD has OPTION as a parameter."
4077 (when (stringp method)
4078 (setq method (gnus-server-to-method method)))
4079 (memq option (assoc (format "%s" (car method))
4080 gnus-valid-select-methods)))
4082 (defun gnus-similar-server-opened (method)
4083 "Return non-nil if we have a similar server opened.
4084 This is defined as a server with the same name, but different
4085 parameters."
4086 (let ((opened gnus-opened-servers)
4087 open)
4088 (while (and method opened)
4089 (setq open (car (pop opened)))
4090 ;; Type and name are the same...
4091 (when (and (equal (car method) (car open))
4092 (equal (cadr method) (cadr open))
4093 ;; ... but the rest of the parameters differ.
4094 (not (gnus-methods-sloppily-equal method open)))
4095 (setq method nil)))
4096 (not method)))
4098 (defun gnus-server-extend-method (group method)
4099 ;; This function "extends" a virtual server. If the server is
4100 ;; "hello", and the select method is ("hello" (my-var "something"))
4101 ;; in the group "alt.alt", this will result in a new virtual server
4102 ;; called "hello+alt.alt".
4103 (if (or (not (inline (gnus-similar-server-opened method)))
4104 (not (cddr method)))
4105 method
4106 (setq method
4107 `(,(car method) ,(concat (cadr method) "+" group)
4108 (,(intern (format "%s-address" (car method))) ,(cadr method))
4109 ,@(cddr method)))
4110 (push method gnus-extended-servers)
4111 method))
4113 (defun gnus-server-status (method)
4114 "Return the status of METHOD."
4115 (nth 1 (assoc method gnus-opened-servers)))
4117 (defun gnus-group-name-to-method (group)
4118 "Guess a select method based on GROUP."
4119 (if (string-match ":" group)
4120 (let ((server (substring group 0 (match-beginning 0))))
4122 (list (intern (substring server 0 (match-beginning 0)))
4123 (substring server (match-end 0)))
4124 (list (intern server) "")))
4125 gnus-select-method))
4127 (defun gnus-server-string (server)
4128 "Return a readable string that describes SERVER."
4129 (let* ((server (gnus-server-to-method server))
4130 (address (nth 1 server)))
4131 (if (and address
4132 (not (zerop (length address))))
4133 (format "%s using %s" address (car server))
4134 (format "%s" (car server)))))
4136 (defun gnus-same-method-different-name (method)
4137 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4138 (unless (assq slot (cddr method))
4139 (setq method
4140 (append method (list (list slot (nth 1 method)))))))
4141 (let ((methods gnus-extended-servers)
4142 open found)
4143 (while (and (not found)
4144 (setq open (pop methods)))
4145 (when (and (eq (car method) (car open))
4146 (gnus-sloppily-equal-method-parameters method open))
4147 (setq found open)))
4148 found))
4150 (defun gnus-find-method-for-group (group &optional info)
4151 "Find the select method that GROUP uses."
4152 (or gnus-override-method
4153 (and (not group)
4154 gnus-select-method)
4155 (and (not (gnus-group-entry group))
4156 ;; Killed or otherwise unknown group.
4157 (or
4158 ;; If we know a virtual server by that name, return its method.
4159 (gnus-server-to-method (gnus-group-server group))
4160 ;; Guess a new method as last resort.
4161 (gnus-group-name-to-method group)))
4162 (let ((info (or info (gnus-get-info group)))
4163 method)
4164 (if (or (not info)
4165 (not (setq method (gnus-info-method info)))
4166 (equal method "native"))
4167 gnus-select-method
4168 (setq method
4169 (cond ((stringp method)
4170 (inline (gnus-server-to-method method)))
4171 ((stringp (cadr method))
4172 (or
4173 (inline
4174 (gnus-same-method-different-name method))
4175 (inline (gnus-server-extend-method group method))))
4176 (t
4177 method)))
4178 (cond ((equal (cadr method) "")
4179 method)
4180 ((null (cadr method))
4181 (list (car method) ""))
4182 (t
4183 (gnus-server-add-address method)))))))
4185 (defun gnus-methods-using (feature)
4186 "Find all methods that have FEATURE."
4187 (let ((valids gnus-valid-select-methods)
4188 outs)
4189 (while valids
4190 (when (memq feature (car valids))
4191 (push (car valids) outs))
4192 (setq valids (cdr valids)))
4193 outs))
4195 (eval-and-compile
4196 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4198 (defun gnus-read-group (prompt &optional default)
4199 "Prompt the user for a group name.
4200 Disallow invalid group names."
4201 (let ((prefix "")
4202 group)
4203 (while (not group)
4204 (when (string-match
4205 gnus-invalid-group-regexp
4206 (setq group (read-string (concat prefix prompt)
4207 (cons (or default "") 0)
4208 'gnus-group-history)))
4209 (let ((match (match-string 0 group)))
4210 ;; Might be okay (e.g. for nnimap), so ask the user:
4212 (message-y-or-n-p
4213 "Proceed and create group anyway? " t
4216 Usually, it's dangerous to create a group with this name, because it's not
4217 supported by all back ends and servers. On IMAP servers it should work,
4218 though. If you are really sure, you can proceed anyway and create the group.
4220 You may customize the variable `gnus-invalid-group-regexp', which currently is
4224 group nil)))))
4225 group))
4227 (defun gnus-read-method (prompt)
4228 "Prompt the user for a method.
4229 Allow completion over sensible values."
4230 (let* ((open-servers
4231 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4232 gnus-opened-servers))
4233 (valid-methods
4234 (let (methods)
4235 (dolist (method gnus-valid-select-methods)
4236 (if (or (memq 'prompt-address method)
4237 (not (assoc (format "%s:" (car method)) open-servers)))
4238 (push method methods)))
4239 methods))
4240 (servers
4241 (append valid-methods
4242 open-servers
4243 gnus-predefined-server-alist
4244 gnus-server-alist))
4245 (method
4246 (completing-read
4247 prompt servers
4248 nil t nil 'gnus-method-history)))
4249 (cond
4250 ((equal method "")
4251 (setq method gnus-select-method))
4252 ((assoc method gnus-valid-select-methods)
4253 (let ((address (if (memq 'prompt-address
4254 (assoc method gnus-valid-select-methods))
4255 (read-string "Address: ")
4256 "")))
4257 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4258 (list (intern method) address))))
4259 ((assoc method servers)
4260 method)
4261 (t
4262 (list (intern method) "")))))
4264 ;;; Agent functions
4266 (defun gnus-agent-method-p (method-or-server)
4267 "Say whether METHOD is covered by the agent."
4268 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4269 (let* ((method (if (stringp method-or-server)
4270 (gnus-server-to-method method-or-server)
4271 method-or-server))
4272 (server (gnus-method-to-server method t)))
4273 (setq gnus-agent-method-p-cache
4274 (cons method-or-server
4275 (member server gnus-agent-covered-methods)))))
4276 (cdr gnus-agent-method-p-cache))
4278 (defun gnus-online (method)
4279 (not
4280 (if gnus-plugged
4281 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4282 (gnus-agent-method-p method))))
4284 ;;; User-level commands.
4286 ;;;###autoload
4287 (defun gnus-slave-no-server (&optional arg)
4288 "Read network news as a slave, without connecting to the local server."
4289 (interactive "P")
4290 (gnus-no-server arg t))
4292 ;;;###autoload
4293 (defun gnus-no-server (&optional arg slave)
4294 "Read network news.
4295 If ARG is a positive number, Gnus will use that as the startup
4296 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4297 non-nil and not a positive number, Gnus will prompt the user for the
4298 name of an NNTP server to use.
4299 As opposed to `gnus', this command will not connect to the local
4300 server."
4301 (interactive "P")
4302 (gnus-no-server-1 arg slave))
4304 ;;;###autoload
4305 (defun gnus-slave (&optional arg)
4306 "Read news as a slave."
4307 (interactive "P")
4308 (gnus arg nil 'slave))
4310 ;;;###autoload
4311 (defun gnus-other-frame (&optional arg display)
4312 "Pop up a frame to read news.
4313 This will call one of the Gnus commands which is specified by the user
4314 option `gnus-other-frame-function' (default `gnus') with the argument
4315 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4316 optional second argument DISPLAY should be a standard display string
4318 omitted or the function `make-frame-on-display' is not available, the
4319 current display is used."
4320 (interactive "P")
4321 (if (fboundp 'make-frame-on-display)
4322 (unless display
4323 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4324 (setq display nil))
4325 (let ((alive (gnus-alive-p)))
4326 (unless (and alive
4327 (catch 'found
4328 (walk-windows
4329 (lambda (window)
4330 (when (and (or (not display)
4331 (equal display
4332 (gnus-frame-or-window-display-name
4333 window)))
4334 (with-current-buffer (window-buffer window)
4336 (symbol-name major-mode))))
4337 (gnus-select-frame-set-input-focus
4338 (setq gnus-other-frame-object (window-frame window)))
4339 (select-window window)
4340 (throw 'found t)))
4341 'ignore t)))
4342 (gnus-select-frame-set-input-focus
4343 (setq gnus-other-frame-object
4344 (if display
4345 (make-frame-on-display display gnus-other-frame-parameters)
4346 (make-frame gnus-other-frame-parameters))))
4347 (if alive
4348 (switch-to-buffer gnus-group-buffer)
4349 (funcall gnus-other-frame-function arg)
4350 (add-hook 'gnus-exit-gnus-hook
4351 '(lambda nil
4352 (when (and (frame-live-p gnus-other-frame-object)
4353 (cdr (frame-list)))
4354 (delete-frame gnus-other-frame-object))
4355 (setq gnus-other-frame-object nil)))))))
4357 ;;;###autoload
4358 (defun gnus (&optional arg dont-connect slave)
4359 "Read network news.
4360 If ARG is non-nil and a positive number, Gnus will use that as the
4361 startup level. If ARG is non-nil and not a positive number, Gnus will
4362 prompt the user for the name of an NNTP server to use."
4363 (interactive "P")
4364 ;; When using the development version of Gnus, load the gnus-load
4365 ;; file.
4366 (unless (string-match "^Gnus" gnus-version)
4367 (load "gnus-load" nil t))
4368 (unless (byte-code-function-p (symbol-function 'gnus))
4369 (message "You should byte-compile Gnus")
4370 (sit-for 2))
4371 (gnus-1 arg dont-connect slave))
4373 ;; Allow redefinition of Gnus functions.
4375 (gnus-ems-redefine)
4377 (provide 'gnus)
4379 ;;; gnus.el ends here