| blob | 4a5f0f79d64447273ee2933b5a752816f0c150ad |
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))
1433 "String with a description of what organization (if any) the user belongs to.
1436 ;; Customization variables
1439 "Preferred method for fetching an article by Message-ID.
1440 If you are reading news from the local spool (with nnspool), fetching
1441 articles by Message-ID is painfully slow. By setting this method to an
1442 nntp method, you might get acceptable results.
1444 The value of this variable must be a valid select method as discussed
1445 in the documentation of `gnus-select-method'.
1447 It can also be a list of select methods, as well as the special symbol
1448 `current', which means to use the current select method. If it is a
1449 list, Gnus will try all the methods in the list until it finds a match."
1455 gnus-select-method
1463 gnus-select-method))))
1466 "*Non-nil means that control messages are displayed using `browse-url'.
1467 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1468 group."
1474 "*Non-nil means that cross referenced articles will be marked as read.
1475 If nil, ignore cross references. If t, mark articles as read in
1476 subscribed newsgroups. If neither t nor nil, mark as read in all
1477 newsgroups."
1485 "*Process mark."
1491 "*The number of articles which indicates a large newsgroup.
1492 If the number of articles in a newsgroup is greater than this value,
1493 confirmation is required for selecting the newsgroup.
1494 If it is nil, no confirmation is required.
1496 Also see `gnus-large-ephemeral-newsgroup'."
1499 integer))
1502 "*Non-nil means that the default name of a file to save articles in is the group name.
1503 If it's nil, the directory form of the group name is used instead.
1505 If this variable is a list, and the list contains the element
1506 `not-score', long file names will not be used for score files; if it
1507 contains the element `not-save', long file names will not be used for
1508 saving; and if it contains the element `not-kill', long file names
1509 will not be used for kill files.
1511 Note that the default for this variable varies according to what system
1512 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1513 to nil while on all other systems it defaults to t."
1531 "*If non-nil, save group scoring info."
1537 "*If non-nil, allow undoing in Gnus group mode buffers."
1542 "*If non-nil, use some adaptive scoring scheme.
1543 If a list, then the values `word' and `line' are meaningful. The
1544 former will perform adaption on individual words in the subject
1545 header while `line' will perform adaption on several headers."
1551 "*If nil, Gnus will ignore the article cache.
1552 If `passive', it will allow entering (and reading) articles
1553 explicitly entered into the cache. If anything else, use the
1554 cache to the full extent of the law."
1562 "*If non-nil, display a thread tree buffer."
1567 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1568 If it is a number N, then Gnus will only keep the last N articles
1569 read. If it is neither nil nor a number, Gnus will keep all read
1570 articles. This is not a good idea."
1573 integer
1578 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1583 "*If non-nil, enable scoring."
1589 "*A hook called when preparing to exit from the summary buffer.
1590 It calls `gnus-summary-expire-articles' by default."
1595 "*Non-nil means that you are a Usenet novice.
1596 If non-nil, verbose messages may be displayed and confirmations may be
1597 required."
1602 "*Non-nil means that you will never be asked for confirmation about anything.
1603 That doesn't mean *anything* anything; particularly destructive
1604 commands will still require prompting."
1609 "*If non-nil, require your confirmation when catching up a group."
1614 "*If non-nil, require your confirmation when exiting Gnus."
1619 "*Function for extracting address components from a From header.
1620 Two pre-defined function exist: `gnus-extract-address-components',
1621 which is the default, quite fast, and too simplistic solution, and
1622 `mail-extract-address-components', which works much better, but is
1623 slower."
1630 "*If non-nil, display clickable icons."
1635 "String used to separate shell commands."
1659 "*An alist of valid select methods.
1660 The first element of each list lists should be a string with the name
1661 of the select method. The other elements may be the category of
1662 this method (i. e., `post', `mail', `none' or whatever) or other
1663 properties that this method has (like being respoolable).
1664 If you implement a new select method, all you should have to change is
1665 this variable. I think."
1681 "Recomputes the select-method widget based on the value of
1682 `gnus-valid-select-methods'."
1684 "Widget for entering a select method."
1691 gnus-valid-select-methods)
1695 :inline t
1697 variable
1703 "List of buffers that should update their mode lines.
1704 The list may contain the symbols `group', `article', `tree' and
1705 `summary'. If the corresponding symbol is present, Gnus will keep
1706 that mode line updated with information that may be pertinent.
1707 If this variable is nil, screen refresh may be quicker."
1715 "*Max length of mode-line non-string contents.
1716 If this is nil, Gnus will take space as is needed, leaving the rest
1717 of the mode line intact."
1721 integer))
1723 ;; There should be special validation for this.
1728 to-address
1729 :function-document
1730 "Return GROUP's to-address."
1731 :variable-document
1732 "*Alist of group regexps and correspondent to-addresses."
1733 :variable-group gnus-group-parameter
1736 This will be used when doing followups and posts.
1738 This is primarily useful in mail groups that represent closed
1739 mailing lists--mailing lists where it's expected that everybody that
1740 writes to the mailing list is subscribed to it. Since using this
1741 parameter ensures that the mail only goes to the mailing list itself,
1742 it means that members won't receive two copies of your followups.
1744 Using `to-address' will actually work whether the group is foreign or
1745 not. Let's say there's a group on the server that is called
1746 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1747 articles from a mail-to-news gateway. Posting directly to this group
1748 is therefore impossible--you have to send mail to the mailing list
1749 address instead.
1751 The gnus-group-split mail splitting mechanism will behave as if this
1755 to-list
1756 :function-document
1757 "Return GROUP's to-list."
1758 :variable-document
1759 "*Alist of group regexps and correspondent to-lists."
1760 :variable-group gnus-group-parameter
1763 This address will be used when doing a `a' in the group.
1765 It is totally ignored when doing a followup--except that if it is
1766 present in a news group, you'll get mail group semantics when doing
1767 `f'.
1769 The gnus-group-split mail splitting mechanism will behave as if this
1773 subscribed
1774 :type bool
1775 :function-document
1776 "Return GROUP's subscription status."
1777 :variable-document
1778 "*Groups which are automatically considered subscribed."
1779 :variable-group gnus-group-parameter
1782 Gnus assumed that you are subscribed to the To/List address.
1784 When constructing a list of subscribed groups using
1785 `gnus-find-subscribed-addresses', Gnus includes the To address given
1789 auto-expire
1790 :type bool
1791 :function gnus-group-auto-expirable-p
1792 :function-document
1793 "Check whether GROUP is auto-expirable or not."
1794 :variable gnus-auto-expirable-newsgroups
1795 :variable-default nil
1796 :variable-document
1797 "*Groups in which to automatically mark read articles as expirable.
1798 If non-nil, this should be a regexp that should match all groups in
1799 which to perform auto-expiry. This only makes sense for mail groups."
1800 :variable-group nnmail-expire
1802 regexp)
1804 :parameter-document
1808 total-expire
1809 :type bool
1810 :function gnus-group-total-expirable-p
1811 :function-document
1812 "Check whether GROUP is total-expirable or not."
1813 :variable gnus-total-expirable-newsgroups
1814 :variable-default nil
1815 :variable-document
1816 "*Groups in which to perform expiry of all read articles.
1817 Use with extreme caution. All groups that match this regexp will be
1818 expiring - which means that all read articles will be deleted after
1819 \(say) one week. (This only goes for mail groups and the like, of
1820 course.)"
1821 :variable-group nnmail-expire
1823 regexp)
1825 :parameter-document
1826 "All read articles will be put through the expiry process
1828 This happens even if they are not marked as expirable.
1832 charset
1833 :function-document
1834 "Return the default charset of GROUP."
1835 :variable gnus-group-charset-alist
1836 :variable-default
1849 :variable-document
1850 "Alist of regexps (to match group names) and default charsets to be used when reading."
1851 :variable-group gnus-charset
1859 post-method
1860 :type list
1861 :function-document
1862 "Return a posting method for GROUP."
1863 :variable gnus-post-method-alist
1864 :variable-document
1865 "Alist of regexps (to match group names) and method to be used when
1866 posting an article."
1867 :variable-group gnus-group-foreign
1868 :parameter-type
1876 :parameter-document
1880 large-newsgroup-initial
1881 :type integer
1882 :function-document
1883 "Return GROUP's initial input of the number of articles."
1884 :variable-document
1885 "*Alist of group regexps and its initial input of the number of articles."
1886 :variable-group gnus-group-parameter
1892 This number will be prompted as the initial value of the number of
1893 articles to list when the group is a large newsgroup (see
1894 `gnus-large-newsgroup'). If it is nil, the default value is the
1897 ;; The Gnus registry's ignored groups
1899 registry-ignore
1900 :type list
1901 :function-document
1902 "Whether this group should be ignored by the registry."
1903 :variable gnus-registry-ignored-groups
1904 :variable-default nil
1905 :variable-document
1906 "*Groups in which the registry should be turned off."
1907 :variable-group gnus-registry
1914 :parameter-document
1917 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1919 "*Disable the group parameters for spam detection.
1920 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1927 "Spam group classification (requires spam.el).
1928 This group contains spam messages. On summary entry, unread messages
1929 will be marked as spam. On summary exit, the specified spam
1930 processors will be invoked on spam-marked messages, then those
1931 messages will be expired, so the spam processor will only see a
1935 "The ham value for the spam group parameter (requires spam.el).
1936 On summary exit, the specified ham processors will be invoked on
1937 ham-marked messages. Exercise caution, since the ham processor will
1938 see the same message more than once because there is no ham message
1942 spam-contents
1943 :type list
1944 :function-document
1945 "The spam type (spam, ham, or neither) of the group."
1946 :variable gnus-spam-newsgroup-contents
1947 :variable-default nil
1948 :variable-document
1949 "*Group classification (spam, ham, or neither). Only
1950 meaningful when spam.el is loaded. If non-nil, this should be a
1951 list of group name regexps associated with a classification for
1952 each one. In spam groups, new articles are marked as spam on
1953 summary entry. There is other behavior associated with ham and
1954 no classification when spam.el is loaded - see the manual."
1955 :variable-group spam
1969 :parameter-document
1970 "The spam classification (spam, ham, or neither) of this group.
1971 When a spam group is entered, all unread articles are marked as
1972 spam. There is other behavior associated with ham and no
1976 spam-resend-to
1977 :type list
1978 :function-document
1979 "The address to get spam resent (through spam-report-resend)."
1980 :variable gnus-spam-resend-to
1981 :variable-default nil
1982 :variable-document
1983 "The address to get spam resent (through spam-report-resend)."
1984 :variable-group spam
1988 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1989 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1990 :parameter-document
1994 ham-resend-to
1995 :type list
1996 :function-document
1997 "The address to get ham resent (through spam-report-resend)."
1998 :variable gnus-ham-resend-to
1999 :variable-default nil
2000 :variable-document
2001 "The address to get ham resent (through spam-report-resend)."
2002 :variable-group spam
2006 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2007 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2008 :parameter-document
2024 "OBSOLETE: The Gmane reporting summary exit spam processor.
2031 "OBSOLETE: The ifile summary exit ham processor.
2035 "OBSOLETE: The Bogofilter summary exit ham processor.
2039 "OBSOLETE: The spam-stat summary exit ham processor.
2043 "OBSOLETE: The whitelist summary exit ham processor.
2047 "OBSOLETE: The BBDB summary exit ham processor.
2051 "OBSOLETE: The ham copy exit ham processor.
2055 "OBSOLETE: The spamoracle summary exit ham processor.
2059 spam-process
2060 :type list
2061 :parameter-type
2064 :value nil
2101 :function-document
2102 "Which spam or ham processors will be applied when the summary is exited."
2103 :variable gnus-spam-process-newsgroups
2104 :variable-default nil
2105 :variable-document
2106 "*Groups in which to automatically process spam or ham articles with
2107 a backend on summary exit. If non-nil, this should be a list of group
2108 name regexps that should match all groups in which to do automatic
2109 spam processing, associated with the appropriate processor."
2110 :variable-group spam
2111 :variable-type
2152 :parameter-document
2156 spam-autodetect
2157 :type list
2158 :parameter-type
2160 :function-document
2161 "Should spam be autodetected (with spam-split) in this group?"
2162 :variable gnus-spam-autodetect
2163 :variable-default nil
2164 :variable-document
2165 "*Groups in which spam should be autodetected when they are entered.
2166 Only unseen articles will be examined, unless
2167 spam-autodetect-recheck-messages is set."
2168 :variable-group spam
2169 :variable-type
2174 boolean))
2175 :parameter-document
2176 "Spam autodetection.
2177 Only unseen articles will be examined, unless
2181 spam-autodetect-methods
2182 :type list
2183 :parameter-type
2206 :function-document
2207 "Methods to be used for autodetection in each group"
2208 :variable gnus-spam-autodetect-methods
2209 :variable-default nil
2210 :variable-document
2211 "*Methods for autodetecting spam per group.
2212 Requires the spam-autodetect parameter. Only unseen articles
2213 will be examined, unless spam-autodetect-recheck-messages is
2214 set."
2215 :variable-group spam
2216 :variable-type
2243 :parameter-document
2244 "Spam autodetection methods.
2245 Requires the spam-autodetect parameter. Only unseen articles
2246 will be examined, unless spam-autodetect-recheck-messages is
2250 spam-process-destination
2251 :type list
2252 :parameter-type
2258 :function-document
2259 "Where spam-processed articles will go at summary exit."
2260 :variable gnus-spam-process-destinations
2261 :variable-default nil
2262 :variable-document
2263 "*Groups in which to explicitly send spam-processed articles to
2264 another group, or expire them (the default). If non-nil, this should
2265 be a list of group name regexps that should match all groups in which
2266 to do spam-processed article moving, associated with the destination
2267 group or nil for explicit expiration. This only makes sense for
2268 mail groups."
2269 :variable-group spam
2270 :variable-type
2281 :parameter-document
2285 ham-process-destination
2286 :type list
2287 :parameter-type
2295 :function-document
2296 "Where ham articles will go at summary exit from a spam group."
2297 :variable gnus-ham-process-destinations
2298 :variable-default nil
2299 :variable-document
2300 "*Groups in which to explicitly send ham articles to
2301 another group, or do nothing (the default). If non-nil, this should
2302 be a list of group name regexps that should match all groups in which
2303 to do ham article moving, associated with the destination
2304 group or nil for explicit ignoring. This only makes sense for
2305 mail groups, and only works in spam groups."
2306 :variable-group spam
2307 :variable-type
2319 :parameter-document
2323 ham-marks
2334 :parameter-document
2335 "Marks considered ham (positively not spam). Such articles will be
2336 processed as ham (non-spam) on group exit. When nil, the global
2337 spam-ham-marks variable takes precedence."
2339 gnus-read-mark
2340 gnus-killed-mark
2341 gnus-kill-file-mark
2342 gnus-low-score-mark))))
2343 :variable-group spam
2344 :variable-document
2348 spam-marks
2357 :parameter-document
2358 "Marks considered spam.
2359 Such articles will be processed as spam on group exit. When nil, the global
2360 spam-spam-marks variable takes precedence."
2362 :variable-group spam
2363 :variable-document
2367 "Number of group name elements to leave alone when making a short group name."
2372 "*If non-nil, once you set a level, Gnus will use this level."
2376 ;; Hooks.
2379 "A hook run while Gnus is loaded."
2384 "A hook called to apply kill files to a group.
2385 This hook is intended to apply a kill file to the selected newsgroup.
2386 The function `gnus-apply-kill-file' is called by default.
2388 Since a general kill file is too heavy to use only for a few
2389 newsgroups, I recommend you to use a lighter hook function. For
2390 example, if you'd like to apply a kill file to articles which contains
2391 a string `rmgroup' in subject in newsgroup `control', you can use the
2392 following hook:
2394 (setq gnus-apply-kill-hook
2395 (list
2396 (lambda ()
2405 "Function run when a group level is changed.
2406 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2409 function))
2411 ;;; Face thingies.
2415 mouse-face
2416 summary-menu group-menu article-menu
2417 tree-highlight menu highlight
2418 browse-menu server-menu
2419 page-marker tree-menu binary-menu pick-menu)
2420 "*Enable visual features.
2421 If `visual' is disabled, there will be no menus and few faces. Most of
2422 the visual customization options below will be ignored. Gnus will use
2423 less space and be faster as a result.
2425 This variable can also be a list of visual elements to switch on. For
2426 instance, to switch off all visual things except menus, you can say:
2428 (setq gnus-visual '(menu))
2430 Valid elements include `summary-highlight', `group-highlight',
2431 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2432 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2433 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2453 ;; Byte-compiler warning.
2455 ;; Find out whether the gnus-visual TYPE is wanted.
2459 gnus-visual
2463 t))))
2473 "*Face used for group or summary buffer mouse highlighting.
2474 The line beneath the mouse pointer will be highlighted with this
2475 face."
2488 "Controls use of the agent cache while plugged.
2489 When set, Gnus will prefer using the locally stored content rather
2490 than re-fetching it from the server. You also need to enable
2491 `gnus-agent' for this to have any affect."
2497 "Default charset assumed to be used when viewing non-ASCII characters.
2498 This variable is overridden on a group-to-group basis by the
2499 `gnus-group-charset-alist' variable and is only used on groups not
2500 covered by that variable."
2504 ;; Fixme: Doc reference to agent.
2506 "Whether we want to use the Gnus agent or not.
2508 You may customize gnus-agent to disable its use. However, some
2509 back ends have started to use the agent as a client-side cache.
2510 Disabling the agent may result in noticeable loss of performance."
2516 "Function called by the command `gnus-other-frame'."
2524 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2525 This should be an alist for Emacs, or a plist for XEmacs."
2536 "Which information should be exposed in the User-Agent header.
2538 Can be a list of symbols or a string. Valid symbols are `gnus'
2539 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2540 addition to the Emacs version, you can add `codename' \(show
2541 \(S\)XEmacs codename\) or either `config' \(show system
2542 configuration\) or `type' \(show system type\). If you set it to
2543 a string, be sure to use a valid format, see RFC 2616."
2556 ;; Convert old (< 2005-01-10) symbol type values:
2575 \f
2576 ;;; Internal variables
2581 ; Reset each time gnus-agent-covered-methods is changed else
2582 ; gnus-agent-method-p may mis-report a methods status.
2583 )
2608 ;; Variable holding the user answers to all method prompts.
2611 ;; Variable holding the user answers to all mail method prompts.
2614 ;; Variable holding the user answers to all group prompts.
2622 "*The directory where cached articles will be stored."
2628 nnspool "cache"
2652 ;; Propagate flags to server, with the following exceptions:
2653 ;; `seen' is private to each gnus installation
2654 ;; `cache' is a internal gnus flag for each gnus installation
2655 ;; `download' is a agent flag private to each gnus installation
2656 ;; `unsend' are for nndraft groups only
2657 ;; `score' is not a proper mark
2658 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2661 "Marks that shouldn't be propagated to back ends.
2662 Typical marks are those that make no sense in a standalone back end,
2663 such as a mark that says whether an article is stored in the cache
2676 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2701 gnus-newsrc-last-checked-date
2702 gnus-newsrc-alist gnus-server-alist
2703 gnus-killed-list gnus-zombie-list
2704 gnus-topic-topology gnus-topic-alist
2705 gnus-format-specs)
2709 "Assoc list of read articles.
2713 "Assoc list of registry data.
2740 ;; Save window configuration.
2753 ;;; End of variables.
2755 ;; Define some autoload functions Gnus might use.
2758 ;; This little mapcar goes through the list below and marks the
2759 ;; symbols in question as autoloaded functions.
2779 message-send-and-exit message-yank-original)
2783 ;; This is only used in message.el, which has an autoload.
2785 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2787 ;; Next two only used in gnus-util.
2788 rmail-summary-exists rmail-select-summary)
2789 ;; Only used in gnus-util, which has an autoload.
2794 gnus-Folder-save-name gnus-folder-save-name)
2797 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2798 gnus-demon-add-disconnection gnus-demon-add-handler
2799 gnus-demon-remove-handler)
2801 gnus-demon-init gnus-demon-cancel)
2803 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2804 gnus-face-from-file)
2806 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2808 gnus-server-server-name)
2811 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2812 gnus-article-hide-citation gnus-article-fill-cited-article
2813 gnus-article-hide-citation-in-followups)
2815 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2816 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2818 gnus-cache-possibly-remove-articles gnus-cache-request-article
2819 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2820 gnus-cache-enter-remove-article gnus-cached-article-p
2821 gnus-cache-open gnus-cache-close gnus-cache-update-article
2822 gnus-cache-articles-in-group)
2824 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2826 gnus-summary-increase-score gnus-summary-set-score
2827 gnus-summary-raise-thread gnus-summary-raise-same-subject
2828 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2829 gnus-summary-lower-thread gnus-summary-lower-same-subject
2830 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2831 gnus-summary-current-score gnus-score-delta-default
2832 gnus-score-flush-cache gnus-score-close
2833 gnus-possibly-score-headers gnus-score-followup-article
2834 gnus-score-followup-thread)
2837 gnus-current-score-file-nondirectory gnus-score-adaptive
2838 gnus-score-find-trace gnus-score-file-name)
2842 gnus-subscribe-topics)
2846 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2847 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2848 gnus-uu-mark-by-regexp gnus-uu-mark-all
2849 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2850 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2851 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2852 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2853 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2854 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2855 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2856 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2859 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2861 gnus-group-post-news gnus-group-mail gnus-group-news
2862 gnus-summary-post-news gnus-summary-news-other-window
2863 gnus-summary-followup gnus-summary-followup-with-original
2864 gnus-summary-cancel-article gnus-summary-supersede-article
2865 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2866 gnus-summary-mail-forward gnus-summary-mail-other-window
2867 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2868 gnus-summary-wide-reply gnus-summary-followup-to-mail
2869 gnus-summary-followup-to-mail-with-original gnus-bug
2870 gnus-summary-wide-reply-with-original
2871 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2872 gnus-summary-post-forward)
2877 gnus-list-of-unread-articles gnus-list-of-read-articles
2878 gnus-offer-save-summaries gnus-make-thread-indent-array
2879 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2880 gnus-summary-skip-intangible gnus-summary-article-number
2881 gnus-data-header gnus-data-find)
2883 gnus-group-list-groups gnus-group-first-unread-group
2884 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2885 gnus-group-setup-buffer gnus-group-get-new-news
2886 gnus-group-make-help-group gnus-group-update-group
2887 gnus-group-iterate gnus-group-group-name)
2889 gnus-backlog-remove-article)
2891 gnus-article-prepare gnus-article-set-window-start
2892 gnus-article-next-page gnus-article-prev-page
2893 gnus-request-article-this-buffer gnus-article-mode
2894 gnus-article-setup-buffer gnus-narrow-to-page
2895 gnus-article-delete-invisible-text gnus-treat-article)
2897 gnus-article-hide-headers gnus-article-hide-boring-headers
2898 gnus-article-treat-overstrike
2899 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2900 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2901 gnus-article-de-base64-unreadable
2902 gnus-article-decode-HZ
2903 gnus-article-wash-html
2904 gnus-article-unsplit-urls
2905 gnus-article-hide-pem gnus-article-hide-signature
2906 gnus-article-strip-leading-blank-lines gnus-article-date-local
2907 gnus-article-date-original gnus-article-date-lapsed
2908 ;;gnus-article-show-all-headers
2909 gnus-article-edit-mode gnus-article-edit-article
2910 gnus-article-edit-done gnus-article-decode-encoded-words
2911 gnus-start-date-timer gnus-stop-date-timer
2912 gnus-mime-view-all-parts)
2915 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2916 gnus-check-reasonable-setup)
2918 gnus-dup-enter-articles)
2924 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2925 gnus-async-halt-prefetch)
2927 gnus-agent-save-active gnus-agent-method-p
2928 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2929 gnus-summary-set-agent-mark gnus-agent-save-group-info
2930 gnus-agent-request-article gnus-agent-retrieve-headers)
2932 gnus-unplugged gnus-agentize gnus-agent-batch)
2934 gnus-summary-save-article-vm)
2939 gnus-group-split-update)
2942 ;;; gnus-sum.el thingies
2946 "*The format specification of the lines in the summary buffer.
2948 It works along the same lines as a normal formatting string,
2949 with some simple extensions.
2951 %N Article number, left padded with spaces (string)
2952 %S Subject (string)
2954 %n Name of the poster (string)
2955 %a Extracted name of the poster (string)
2956 %A Extracted address of the poster (string)
2957 %F Contents of the From: header (string)
2958 %f Contents of the From: or To: headers (string)
2959 %x Contents of the Xref: header (string)
2960 %D Date of the article (string)
2961 %d Date of the article (string) in DD-MMM format
2962 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2963 %M Message-id of the article (string)
2964 %r References of the article (string)
2965 %c Number of characters in the article (integer)
2966 %k Pretty-printed version of the above (string)
2968 %L Number of lines in the article (integer)
2969 %I Indentation based on thread level (a string of spaces)
2970 %B A complex trn-style thread tree (string)
2971 The variables `gnus-sum-thread-*' can be used for customization.
2972 %T A string with two possible values: 80 spaces if the article
2973 is on thread level two or larger and 0 spaces on level one
2978 %> Spaces of length thread-level (string)
2979 %< Spaces of length (- 20 thread-level) (string)
2980 %i Article score (number)
2981 %z Article zcore (character)
2982 %t Number of articles under the current thread (number).
2983 %e Whether the thread is empty or not (character).
2984 %V Total thread score (number).
2985 %P The line number (number).
2986 %O Download mark (character).
2987 %* If present, indicates desired cursor position
2988 (instead of after first colon).
2989 %u User defined specifier. The next character in the format string should
2990 be a letter. Gnus will call the function gnus-user-format-function-X,
2991 where X is the letter following %u. The function will be passed the
2992 current header as argument. The function should return a string, which
2993 will be inserted into the summary just like information from any other
2994 summary specifier.
2996 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2997 with care. For reasons of efficiency, Gnus will compute what column
2999 it is invalid to have these specs after a variable-length spec. Well,
3000 you might not be arrested, but your summary buffer will look strange,
3001 which is bad enough.
3003 The smart choice is to have these specs as far to the left as
3004 possible.
3006 This restriction may disappear in later versions of Gnus.
3008 General format specifiers can also be used.
3009 See Info node `(gnus)Formatting Variables'."
3014 ;;;
3015 ;;; Skeleton keymaps
3016 ;;;
3021 (while keys
3022 (define-key keymap (pop keys) 'undefined))))
3024 (defvar gnus-article-mode-map
3025 (let ((keymap (make-sparse-keymap)))
3026 (gnus-suppress-keymap keymap)
3027 keymap))
3028 (defvar gnus-summary-mode-map
3029 (let ((keymap (make-keymap)))
3030 (gnus-suppress-keymap keymap)
3031 keymap))
3032 (defvar gnus-group-mode-map
3033 (let ((keymap (make-keymap)))
3034 (gnus-suppress-keymap keymap)
3035 keymap))
3037 \f
3039 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3040 ;; If you want the cursor to go somewhere else, set these two
3041 ;; functions in some startup hook to whatever you want.
3042 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3043 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3045 ;;; Various macros and substs.
3047 (defun gnus-header-from (header)
3048 (mail-header-from header))
3050 (defmacro gnus-gethash (string hashtable)
3051 "Get hash value of STRING in HASHTABLE."
3052 `(symbol-value (intern-soft ,string ,hashtable)))
3054 (defmacro gnus-gethash-safe (string hashtable)
3055 "Get hash value of STRING in HASHTABLE.
3056 Return nil if not defined."
3057 `(let ((sym (intern-soft ,string ,hashtable)))
3058 (and (boundp sym) (symbol-value sym))))
3060 (defmacro gnus-sethash (string value hashtable)
3061 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3062 `(set (intern ,string ,hashtable) ,value))
3063 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3065 (defmacro gnus-group-unread (group)
3066 "Get the currently computed number of unread articles in GROUP."
3067 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3069 (defmacro gnus-group-entry (group)
3070 "Get the newsrc entry for GROUP."
3071 `(gnus-gethash ,group gnus-newsrc-hashtb))
3073 (defmacro gnus-active (group)
3074 "Get active info on GROUP."
3075 `(gnus-gethash ,group gnus-active-hashtb))
3077 (defmacro gnus-set-active (group active)
3078 "Set GROUP's active info."
3079 `(gnus-sethash ,group ,active gnus-active-hashtb))
3081 ;; Info access macros.
3083 (defmacro gnus-info-group (info)
3084 `(nth 0 ,info))
3085 (defmacro gnus-info-rank (info)
3086 `(nth 1 ,info))
3087 (defmacro gnus-info-read (info)
3088 `(nth 2 ,info))
3089 (defmacro gnus-info-marks (info)
3090 `(nth 3 ,info))
3091 (defmacro gnus-info-method (info)
3092 `(nth 4 ,info))
3093 (defmacro gnus-info-params (info)
3094 `(nth 5 ,info))
3096 (defmacro gnus-info-level (info)
3097 `(let ((rank (gnus-info-rank ,info)))
3098 (if (consp rank)
3099 (car rank)
3100 rank)))
3101 (defmacro gnus-info-score (info)
3102 `(let ((rank (gnus-info-rank ,info)))
3103 (or (and (consp rank) (cdr rank)) 0)))
3105 (defmacro gnus-info-set-group (info group)
3106 `(setcar ,info ,group))
3107 (defmacro gnus-info-set-rank (info rank)
3108 `(setcar (nthcdr 1 ,info) ,rank))
3109 (defmacro gnus-info-set-read (info read)
3110 `(setcar (nthcdr 2 ,info) ,read))
3111 (defmacro gnus-info-set-marks (info marks &optional extend)
3112 (if extend
3113 `(gnus-info-set-entry ,info ,marks 3)
3114 `(setcar (nthcdr 3 ,info) ,marks)))
3115 (defmacro gnus-info-set-method (info method &optional extend)
3116 (if extend
3117 `(gnus-info-set-entry ,info ,method 4)
3118 `(setcar (nthcdr 4 ,info) ,method)))
3119 (defmacro gnus-info-set-params (info params &optional extend)
3120 (if extend
3121 `(gnus-info-set-entry ,info ,params 5)
3122 `(setcar (nthcdr 5 ,info) ,params)))
3124 (defun gnus-info-set-entry (info entry number)
3125 ;; Extend the info until we have enough elements.
3126 (while (<= (length info) number)
3127 (nconc info (list nil)))
3128 ;; Set the entry.
3129 (setcar (nthcdr number info) entry))
3131 (defmacro gnus-info-set-level (info level)
3132 `(let ((rank (cdr ,info)))
3133 (if (consp (car rank))
3134 (setcar (car rank) ,level)
3135 (setcar rank ,level))))
3136 (defmacro gnus-info-set-score (info score)
3137 `(let ((rank (cdr ,info)))
3138 (if (consp (car rank))
3139 (setcdr (car rank) ,score)
3140 (setcar rank (cons (car rank) ,score)))))
3142 (defmacro gnus-get-info (group)
3143 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3145 ;;; Load the compatibility functions.
3147 (require 'gnus-ems)
3149 \f
3150 ;;;
3151 ;;; Shutdown
3152 ;;;
3154 (defvar gnus-shutdown-alist nil)
3156 (defun gnus-add-shutdown (function &rest symbols)
3157 "Run FUNCTION whenever one of SYMBOLS is shut down."
3158 (push (cons function symbols) gnus-shutdown-alist))
3160 (defun gnus-shutdown (symbol)
3161 "Shut down everything that waits for SYMBOL."
3162 (dolist (entry gnus-shutdown-alist)
3163 (when (memq symbol (cdr entry))
3164 (funcall (car entry)))))
3166 \f
3167 ;;;
3168 ;;; Gnus Utility Functions
3169 ;;;
3171 (defun gnus-find-subscribed-addresses ()
3172 "Return a regexp matching the addresses of all subscribed mail groups.
3173 It consists of the `to-address' or `to-list' parameter of all groups
3174 with a `subscribed' parameter."
3175 (let (group address addresses)
3176 (dolist (entry (cdr gnus-newsrc-alist))
3177 (setq group (car entry))
3178 (when (gnus-parameter-subscribed group)
3179 (setq address (mail-strip-quoted-names
3180 (or (gnus-group-fast-parameter group 'to-address)
3181 (gnus-group-fast-parameter group 'to-list))))
3182 (when address
3183 (add-to-list 'addresses address))))
3184 (when addresses
3187 (defmacro gnus-string-or (&rest strings)
3188 "Return the first element of STRINGS that is a non-blank string.
3189 STRINGS will be evaluated in normal `or' order."
3190 `(gnus-string-or-1 (list ,@strings)))
3192 (defun gnus-string-or-1 (strings)
3193 (let (string)
3194 (while strings
3195 (setq string (pop strings))
3197 (setq string nil)
3198 (setq strings nil)))
3199 string))
3201 (defun gnus-version (&optional arg)
3202 "Version number of this version of Gnus.
3203 If ARG, insert string at point."
3204 (interactive "P")
3205 (if arg
3206 (insert (message gnus-version))
3207 (message gnus-version)))
3209 (defun gnus-continuum-version (&optional version)
3210 "Return VERSION as a floating point number."
3211 (unless version
3212 (setq version gnus-version))
3215 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3216 (number (match-string 2 version))
3217 major minor least)
3218 (unless (string-match
3220 (error "Invalid version string: %s" version))
3221 (setq major (string-to-number (match-string 1 number))
3222 minor (string-to-number (match-string 2 number))
3223 least (if (match-beginning 3)
3224 (string-to-number (match-string 3 number))
3225 0))
3226 (string-to-number
3227 (if (zerop major)
3228 (format "%s00%02d%02d"
3229 (if (member alpha '("(ding)" "d"))
3230 "4.99"
3231 (+ 5 (* 0.02
3232 (abs
3233 (- (mm-char-int (aref (downcase alpha) 0))
3234 (mm-char-int ?t))))
3235 -0.01))
3236 minor least)
3237 (format "%d.%02d%02d" major minor least))))))
3239 (defun gnus-info-find-node (&optional nodename)
3240 "Find Info documentation of Gnus."
3241 (interactive)
3242 ;; Enlarge info window if needed.
3243 (let (gnus-info-buffer)
3244 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3245 (setq gnus-info-buffer (current-buffer))
3246 (gnus-configure-windows 'info)))
3248 ;;;
3249 ;;; gnus-interactive
3250 ;;;
3252 (defvar gnus-current-prefix-symbol nil
3253 "Current prefix symbol.")
3255 (defvar gnus-current-prefix-symbols nil
3256 "List of current prefix symbols.")
3258 (defun gnus-interactive (string &optional params)
3259 "Return a list that can be fed to `interactive'.
3260 See `interactive' for full documentation.
3262 Adds the following specs:
3264 y -- The current symbolic prefix.
3265 Y -- A list of the current symbolic prefix(es).
3266 A -- Article number.
3267 H -- Article header.
3268 g -- Group name."
3269 (let ((i 0)
3270 out c prompt)
3271 (while (< i (length string))
3273 (setq c (aref string i))
3274 (when (match-end 1)
3275 (setq prompt (match-string 1 string)))
3276 (setq i (match-end 0))
3277 ;; We basically emulate just about everything that
3278 ;; `interactive' does, but add the specs listed above.
3279 (push
3280 (cond
3281 ((= c ?a)
3282 (completing-read prompt obarray 'fboundp t))
3283 ((= c ?b)
3284 (read-buffer prompt (current-buffer) t))
3285 ((= c ?B)
3286 (read-buffer prompt (other-buffer (current-buffer))))
3287 ((= c ?c)
3288 (read-char))
3289 ((= c ?C)
3290 (completing-read prompt obarray 'commandp t))
3291 ((= c ?d)
3292 (point))
3293 ((= c ?D)
3294 (read-file-name prompt nil default-directory 'lambda))
3295 ((= c ?f)
3296 (read-file-name prompt nil nil 'lambda))
3297 ((= c ?F)
3298 (read-file-name prompt))
3299 ((= c ?k)
3300 (read-key-sequence prompt))
3301 ((= c ?K)
3302 (error "Not implemented spec"))
3303 ((= c ?e)
3304 (error "Not implemented spec"))
3305 ((= c ?m)
3306 (mark))
3307 ((= c ?N)
3308 (error "Not implemented spec"))
3309 ((= c ?n)
3310 (string-to-number (read-from-minibuffer prompt)))
3311 ((= c ?p)
3312 (prefix-numeric-value current-prefix-arg))
3313 ((= c ?P)
3314 current-prefix-arg)
3315 ((= c ?r)
3316 'gnus-prefix-nil)
3317 ((= c ?s)
3318 (read-string prompt))
3319 ((= c ?S)
3320 (intern (read-string prompt)))
3321 ((= c ?v)
3322 (read-variable prompt))
3323 ((= c ?x)
3324 (read-minibuffer prompt))
3325 ((= c ?x)
3326 (eval-minibuffer prompt))
3327 ;; And here the new specs come.
3328 ((= c ?y)
3329 gnus-current-prefix-symbol)
3330 ((= c ?Y)
3331 gnus-current-prefix-symbols)
3332 ((= c ?g)
3333 (gnus-group-group-name))
3334 ((= c ?A)
3335 (gnus-summary-skip-intangible)
3336 (or (get-text-property (point) 'gnus-number)
3337 (gnus-summary-last-subject)))
3338 ((= c ?H)
3339 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3340 (t
3341 (error "Non-implemented spec")))
3342 out)
3343 (cond
3344 ((= c ?r)
3345 (push (if (< (point) (mark)) (point) (mark)) out)
3346 (push (if (> (point) (mark)) (point) (mark)) out))))
3347 (setq out (delq 'gnus-prefix-nil out))
3348 (nreverse out)))
3350 (defun gnus-symbolic-argument (&optional arg)
3351 "Read a symbolic argument and a command, and then execute command."
3352 (interactive "P")
3353 (let* ((in-command (this-command-keys))
3354 (command in-command)
3355 gnus-current-prefix-symbols
3356 gnus-current-prefix-symbol
3357 syms)
3358 (while (equal in-command command)
3359 (message "%s-" (key-description (this-command-keys)))
3360 (push (intern (char-to-string (read-char))) syms)
3361 (setq command (read-key-sequence nil t)))
3362 (setq gnus-current-prefix-symbols (nreverse syms)
3363 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3364 (call-interactively (key-binding command t))))
3366 ;;; More various functions.
3368 (defsubst gnus-check-backend-function (func group)
3369 "Check whether GROUP supports function FUNC.
3370 GROUP can either be a string (a group name) or a select method."
3371 (ignore-errors
3372 (let ((method (if (stringp group)
3373 (car (gnus-find-method-for-group group))
3374 group)))
3375 (unless (featurep method)
3376 (require method))
3377 (fboundp (intern (format "%s-%s" method func))))))
3379 (defun gnus-group-read-only-p (&optional group)
3380 "Check whether GROUP supports editing or not.
3381 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3382 that that variable is buffer-local to the summary buffers."
3383 (let ((group (or group gnus-newsgroup-name)))
3384 (not (gnus-check-backend-function 'request-replace-article group))))
3386 (defun gnus-virtual-group-p (group)
3387 "Say whether GROUP is virtual or not."
3388 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3389 gnus-valid-select-methods)))
3391 (defun gnus-news-group-p (group &optional article)
3392 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3393 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3394 t) ;is news of course.
3395 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3396 nil) ;must be mail then.
3397 ((vectorp article) ;Has header info.
3398 (eq (gnus-request-type group (mail-header-id article)) 'news))
3399 ((null article) ;Hasn't header info
3400 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3401 ((< article 0) ;Virtual message
3402 nil) ;we don't know, guess mail.
3403 (t ;Has positive number
3404 (eq (gnus-request-type group article) 'news)))) ;use it.
3406 ;; Returns a list of writable groups.
3407 (defun gnus-writable-groups ()
3408 (let ((alist gnus-newsrc-alist)
3409 groups group)
3410 (while (setq group (car (pop alist)))
3411 (unless (gnus-group-read-only-p group)
3412 (push group groups)))
3413 (nreverse groups)))
3415 ;; Check whether to use long file names.
3416 (defun gnus-use-long-file-name (symbol)
3417 ;; The variable has to be set...
3418 (and gnus-use-long-file-name
3419 ;; If it isn't a list, then we return t.
3420 (or (not (listp gnus-use-long-file-name))
3421 ;; If it is a list, and the list contains `symbol', we
3422 ;; return nil.
3423 (not (memq symbol gnus-use-long-file-name)))))
3425 ;; Generate a unique new group name.
3426 (defun gnus-generate-new-group-name (leaf)
3427 (let ((name leaf)
3428 (num 0))
3429 (while (gnus-group-entry name)
3430 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3431 name))
3433 (defun gnus-ephemeral-group-p (group)
3434 "Say whether GROUP is ephemeral or not."
3435 (gnus-group-get-parameter group 'quit-config t))
3437 (defun gnus-group-quit-config (group)
3438 "Return the quit-config of GROUP."
3439 (gnus-group-get-parameter group 'quit-config t))
3441 (defun gnus-kill-ephemeral-group (group)
3442 "Remove ephemeral GROUP from relevant structures."
3443 (gnus-sethash group nil gnus-newsrc-hashtb))
3445 (defun gnus-simplify-mode-line ()
3446 "Make mode lines a bit simpler."
3447 (setq mode-line-modified (cdr gnus-mode-line-modified))
3448 (when (listp mode-line-format)
3449 (make-local-variable 'mode-line-format)
3450 (setq mode-line-format (copy-sequence mode-line-format))
3451 (when (equal (nth 3 mode-line-format) " ")
3452 (setcar (nthcdr 3 mode-line-format) " "))))
3454 ;;; Servers and groups.
3456 (defsubst gnus-server-add-address (method)
3457 (let ((method-name (symbol-name (car method))))
3458 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3459 (not (assq (intern (concat method-name "-address")) method))
3460 (memq 'physical-address (assq (car method)
3461 gnus-valid-select-methods)))
3462 (append method (list (list (intern (concat method-name "-address"))
3463 (nth 1 method))))
3464 method)))
3466 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3467 (catch 'server-name
3468 (setq method (or method gnus-select-method))
3470 ;; Perhaps it is already in the cache.
3471 (unless nocache
3472 (mapc (lambda (name-method)
3473 (if (equal (cdr name-method) method)
3474 (throw 'server-name (car name-method))))
3475 gnus-server-method-cache))
3477 (mapc
3478 (lambda (server-alist)
3479 (mapc (lambda (name-method)
3480 (when (gnus-methods-equal-p (cdr name-method) method)
3481 (unless (member name-method gnus-server-method-cache)
3482 (push name-method gnus-server-method-cache))
3483 (throw 'server-name (car name-method))))
3484 server-alist))
3485 (list gnus-server-alist
3486 gnus-predefined-server-alist))
3488 (let* ((name (if (member (cadr method) '(nil ""))
3489 (format "%s" (car method))
3490 (format "%s:%s" (car method) (cadr method))))
3491 (name-method (cons name method)))
3492 (when (and (not (member name-method gnus-server-method-cache))
3493 (not no-enter-cache)
3494 (not (assoc (car name-method) gnus-server-method-cache)))
3495 (push name-method gnus-server-method-cache))
3496 name)))
3498 (defsubst gnus-server-to-method (server)
3499 "Map virtual server names to select methods."
3500 (or (and server (listp server) server)
3501 (cdr (assoc server gnus-server-method-cache))
3502 (let ((result
3503 (or
3504 ;; Perhaps this is the native server?
3505 (and (equal server "native") gnus-select-method)
3506 ;; It should be in the server alist.
3507 (cdr (assoc server gnus-server-alist))
3508 ;; It could be in the predefined server alist.
3509 (cdr (assoc server gnus-predefined-server-alist))
3510 ;; If not, we look through all the opened server
3511 ;; to see whether we can find it there.
3512 (let ((opened gnus-opened-servers))
3513 (while (and opened
3514 (not (equal server (format "%s:%s" (caaar opened)
3515 (cadaar opened)))))
3516 (pop opened))
3517 (caar opened))
3518 ;; It could be a named method, search all servers
3519 (let ((servers gnus-secondary-select-methods))
3520 (while (and servers
3521 (not (equal server (format "%s:%s" (caar servers)
3522 (cadar servers)))))
3523 (pop servers))
3524 (car servers))
3525 ;; This could be some sort of foreign server that I
3526 ;; simply haven't opened (yet). Do a brute-force scan
3527 ;; of the entire gnus-newsrc-alist for the server name
3528 ;; of every method. As a side-effect, loads the
3529 ;; gnus-server-method-cache so this only happens once,
3530 ;; if at all.
3531 (let ((alist (cdr gnus-newsrc-alist))
3532 method match)
3533 (while alist
3534 (setq method (gnus-info-method (pop alist)))
3535 (when (and (not (stringp method))
3536 (equal server
3537 (gnus-method-to-server method nil t)))
3538 (setq match method
3539 alist nil)))
3540 match))))
3541 (when (and result
3542 (not (assoc server gnus-server-method-cache)))
3543 (push (cons server result) gnus-server-method-cache))
3544 result)))
3546 (defsubst gnus-server-get-method (group method)
3547 ;; Input either a server name, and extended server name, or a
3548 ;; select method, and return a select method.
3549 (cond ((stringp method)
3550 (gnus-server-to-method method))
3551 ((equal method gnus-select-method)
3552 gnus-select-method)
3553 ((and (stringp (car method))
3554 group)
3555 (gnus-server-extend-method group method))
3556 ((and method
3557 (not group)
3558 (equal (cadr method) ""))
3559 method)
3560 (t
3561 (gnus-server-add-address method))))
3563 (defmacro gnus-method-equal (ss1 ss2)
3564 "Say whether two servers are equal."
3565 `(let ((s1 ,ss1)
3566 (s2 ,ss2))
3567 (or (equal s1 s2)
3568 (and (= (length s1) (length s2))
3569 (progn
3570 (while (and s1 (member (car s1) s2))
3571 (setq s1 (cdr s1)))
3572 (null s1))))))
3574 (defun gnus-methods-equal-p (m1 m2)
3575 (let ((m1 (or m1 gnus-select-method))
3576 (m2 (or m2 gnus-select-method)))
3577 (or (equal m1 m2)
3578 (and (eq (car m1) (car m2))
3579 (or (not (memq 'address (assoc (symbol-name (car m1))
3580 gnus-valid-select-methods)))
3581 (equal (nth 1 m1) (nth 1 m2)))))))
3583 (defun gnus-methods-sloppily-equal (m1 m2)
3584 ;; Same method.
3585 (or
3586 (eq m1 m2)
3587 ;; Type and name are equal.
3588 (and
3589 (eq (car m1) (car m2))
3590 (equal (cadr m1) (cadr m2))
3591 (gnus-sloppily-equal-method-parameters m1 m2))))
3593 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3594 ;; Check parameters for sloppy equalness.
3595 (let ((p1 (copy-sequence (cddr m1)))
3596 (p2 (copy-sequence (cddr m2)))
3597 e1 e2)
3598 (block nil
3599 (while (setq e1 (pop p1))
3600 (unless (setq e2 (assq (car e1) p2))
3601 ;; The parameter doesn't exist in p2.
3602 (return nil))
3603 (setq p2 (delq e2 p2))
3604 (unless (equal e1 e2)
3605 (if (not (and (stringp (cadr e1))
3606 (stringp (cadr e2))))
3607 (return nil)
3608 ;; Special-case string parameter comparison so that we
3609 ;; can uniquify them.
3610 (let ((s1 (cadr e1))
3611 (s2 (cadr e2)))
3612 (when (string-match "/$" s1)
3613 (setq s1 (directory-file-name s1)))
3614 (when (string-match "/$" s2)
3615 (setq s2 (directory-file-name s2)))
3616 (unless (equal s1 s2)
3617 (return nil))))))
3618 ;; If p2 now is empty, they were equal.
3619 (null p2))))
3621 (defun gnus-server-equal (m1 m2)
3622 "Say whether two methods are equal."
3623 (let ((m1 (cond ((null m1) gnus-select-method)
3624 ((stringp m1) (gnus-server-to-method m1))
3625 (t m1)))
3626 (m2 (cond ((null m2) gnus-select-method)
3627 ((stringp m2) (gnus-server-to-method m2))
3628 (t m2))))
3629 (gnus-method-equal m1 m2)))
3631 (defun gnus-servers-using-backend (backend)
3632 "Return a list of known servers using BACKEND."
3633 (let ((opened gnus-opened-servers)
3634 out)
3635 (while opened
3636 (when (eq backend (caaar opened))
3637 (push (caar opened) out))
3638 (pop opened))
3639 out))
3641 (defun gnus-archive-server-wanted-p ()
3642 "Say whether the user wants to use the archive server."
3643 (cond
3644 ((or (not gnus-message-archive-method)
3645 (not gnus-message-archive-group))
3646 nil)
3647 ((and gnus-message-archive-method gnus-message-archive-group)
3648 t)
3649 (t
3650 (let ((active (cadr (assq 'nnfolder-active-file
3651 gnus-message-archive-method))))
3652 (and active
3653 (file-exists-p active))))))
3655 (defsubst gnus-method-to-server-name (method)
3656 (concat
3657 (format "%s" (car method))
3658 (when (and
3659 (or (assoc (format "%s" (car method))
3660 (gnus-methods-using 'address))
3661 (gnus-server-equal method gnus-message-archive-method))
3662 (nth 1 method)
3663 (not (string= (nth 1 method) "")))
3664 (concat "+" (nth 1 method)))))
3666 (defsubst gnus-method-to-full-server-name (method)
3667 (format "%s+%s" (car method) (nth 1 method)))
3669 (defun gnus-group-prefixed-name (group method &optional full)
3670 "Return the whole name from GROUP and METHOD.
3671 Call with full set to get the fully qualified group name (even if the
3672 server is native)."
3673 (when (stringp method)
3674 (setq method (gnus-server-to-method method)))
3675 (if (or (not method)
3676 (and (not full) (gnus-server-equal method "native"))
3677 ;;;!!! This might not be right. We'll see...
3678 ;(string-match ":" group)
3679 )
3680 group
3681 (concat (gnus-method-to-server-name method) ":" group)))
3683 (defun gnus-group-guess-prefixed-name (group)
3684 "Guess the whole name from GROUP and METHOD."
3685 (gnus-group-prefixed-name group (gnus-find-method-for-group
3686 group)))
3688 (defun gnus-group-full-name (group method)
3689 "Return the full name from GROUP and METHOD, even if the method is native."
3690 (gnus-group-prefixed-name group method t))
3692 (defun gnus-group-guess-full-name (group)
3693 "Guess the full name from GROUP, even if the method is native."
3694 (if (gnus-group-prefixed-p group)
3695 group
3696 (gnus-group-full-name group (gnus-find-method-for-group group))))
3698 (defun gnus-group-guess-full-name-from-command-method (group)
3699 "Guess the full name from GROUP, even if the method is native."
3700 (if (gnus-group-prefixed-p group)
3701 group
3702 (gnus-group-full-name group gnus-command-method)))
3704 (defun gnus-group-real-prefix (group)
3705 "Return the prefix of the current group name."
3706 (if (stringp group)
3707 (if (string-match "^[^:]+:" group)
3708 (substring group 0 (match-end 0))
3709 "")
3710 nil))
3712 (defun gnus-group-short-name (group)
3713 "Return the short group name."
3714 (let ((prefix (gnus-group-real-prefix group)))
3715 (if (< 0 (length prefix))
3716 (substring group (length prefix) nil)
3717 group)))
3719 (defun gnus-group-prefixed-p (group)
3720 "Return the prefix of the current group name."
3721 (< 0 (length (gnus-group-real-prefix group))))
3723 (declare-function gnus-group-decoded-name "gnus-group" (string))
3725 (defun gnus-summary-buffer-name (group)
3726 "Return the summary buffer name of GROUP."
3727 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3729 (defun gnus-group-method (group)
3730 "Return the server or method used for selecting GROUP.
3731 You should probably use `gnus-find-method-for-group' instead."
3732 (let ((prefix (gnus-group-real-prefix group)))
3733 (if (equal prefix "")
3734 gnus-select-method
3735 (let ((servers gnus-opened-servers)
3736 (server "")
3737 backend possible found)
3739 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3740 server (substring prefix (match-end 0) (1- (length prefix))))
3741 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3742 (while servers
3743 (when (eq (caaar servers) backend)
3744 (setq possible (caar servers))
3745 (when (equal (cadaar servers) server)
3746 (setq found (caar servers))))
3747 (pop servers))
3748 (or (car (rassoc found gnus-server-alist))
3749 found
3750 (car (rassoc possible gnus-server-alist))
3751 possible
3752 (list backend server))))))
3754 (defsubst gnus-native-method-p (method)
3755 "Return whether METHOD is the native select method."
3756 (gnus-method-equal method gnus-select-method))
3758 (defsubst gnus-secondary-method-p (method)
3759 "Return whether METHOD is a secondary select method."
3760 (let ((methods gnus-secondary-select-methods)
3761 (gmethod (inline (gnus-server-get-method nil method))))
3762 (while (and methods
3763 (not (gnus-method-equal
3764 (inline (gnus-server-get-method nil (car methods)))
3765 gmethod)))
3766 (setq methods (cdr methods)))
3767 methods))
3769 (defun gnus-method-simplify (method)
3770 "Return the shortest uniquely identifying string or method for METHOD."
3771 (cond ((stringp method)
3772 method)
3773 ((gnus-native-method-p method)
3774 nil)
3775 ((gnus-secondary-method-p method)
3776 (format "%s:%s" (nth 0 method) (nth 1 method)))
3777 (t
3778 method)))
3780 (defun gnus-groups-from-server (server)
3781 "Return a list of all groups that are fetched from SERVER."
3782 (let ((alist (cdr gnus-newsrc-alist))
3783 info groups)
3784 (while (setq info (pop alist))
3785 (when (gnus-server-equal (gnus-info-method info) server)
3786 (push (gnus-info-group info) groups)))
3787 (sort groups 'string<)))
3789 (defun gnus-group-foreign-p (group)
3790 "Say whether a group is foreign or not."
3791 (and (not (gnus-group-native-p group))
3792 (not (gnus-group-secondary-p group))))
3794 (defun gnus-group-native-p (group)
3795 "Say whether the group is native or not."
3796 (not (string-match ":" group)))
3798 (defun gnus-group-secondary-p (group)
3799 "Say whether the group is secondary or not."
3800 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3802 (defun gnus-parameters-get-parameter (group)
3803 "Return the group parameters for GROUP from `gnus-parameters'."
3804 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3805 case-fold-search
3806 gnus-parameters-case-fold-search))
3807 params-list)
3808 (dolist (elem gnus-parameters)
3809 (when (string-match (car elem) group)
3810 (setq params-list
3811 (nconc (gnus-expand-group-parameters
3812 (car elem) (cdr elem) group)
3813 params-list))))
3814 params-list))
3816 (defun gnus-expand-group-parameter (match value group)
3817 "Use MATCH to expand VALUE in GROUP."
3818 (with-temp-buffer
3819 (insert group)
3820 (goto-char (point-min))
3821 (while (re-search-forward match nil t)
3822 (replace-match value))
3823 (buffer-string)))
3825 (defun gnus-expand-group-parameters (match parameters group)
3826 "Go through PARAMETERS and expand them according to the match data."
3827 (let (new)
3828 (dolist (elem parameters)
3829 (if (and (stringp (cdr elem))
3831 (push (cons (car elem)
3832 (gnus-expand-group-parameter match (cdr elem) group))
3833 new)
3834 (push elem new)))
3835 new))
3837 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3838 "For GROUP, return the value of SYMBOL.
3840 You should call this in the `gnus-group-buffer' buffer.
3841 The function `gnus-group-find-parameter' will do that for you."
3842 ;; The speed trick: No cons'ing and quit early.
3843 (let* ((params (funcall gnus-group-get-parameter-function group))
3844 ;; Start easy, check the "real" group parameters.
3845 (simple-results
3846 (gnus-group-parameter-value params symbol allow-list t)))
3847 (if simple-results
3848 ;; Found results; return them.
3849 (car simple-results)
3850 ;; We didn't find it there, try `gnus-parameters'.
3851 (let ((result nil)
3852 (head nil)
3853 (tail gnus-parameters))
3854 ;; A good old-fashioned non-cl loop.
3855 (while tail
3856 (setq head (car tail)
3857 tail (cdr tail))
3858 ;; The car is regexp matching for matching the group name.
3859 (when (string-match (car head) group)
3860 ;; The cdr is the parameters.
3861 (setq result (gnus-group-parameter-value (cdr head)
3862 symbol allow-list))
3863 (when result
3864 ;; Expand if necessary.
3866 (setq result (gnus-expand-group-parameter (car head)
3867 result group))))))
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 (gnus-completing-read
4247 prompt (mapcar 'car servers)
4248 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 (let ((gnus-action-message-log (list nil)))
4372 (gnus-1 arg dont-connect slave)
4373 (gnus-final-warning)))
4375 ;; Allow redefinition of Gnus functions.
4377 (gnus-ems-redefine)
4379 (provide 'gnus)
4381 ;;; gnus.el ends here