| blob | 2a5533db0799fe02a4e4341e25f26fd3c6e50496 |
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."
312 "If non-nil, play the Gnus jingle at startup."
344 0 5
353 gnus-mode-line-image-cache)
355 "This is %s, %s."
357 str)
359 line)))
365 ;;(defalias 'gnus-decode-rfc1522 'ignore)
366 )
368 ;; We define these group faces here to avoid the display
369 ;; update forced when creating new faces.
379 ()))
380 "Level 1 newsgroup face."
382 ;; backward-compatibility alias
394 ()))
395 "Level 1 empty newsgroup face."
397 ;; backward-compatibility alias
409 ()))
410 "Level 2 newsgroup face."
412 ;; backward-compatibility alias
424 ()))
425 "Level 2 empty newsgroup face."
427 ;; backward-compatibility alias
439 ()))
440 "Level 3 newsgroup face."
442 ;; backward-compatibility alias
449 ())
452 ())
454 ()))
455 "Level 3 empty newsgroup face."
457 ;; backward-compatibility alias
469 ()))
470 "Level 4 newsgroup face."
472 ;; backward-compatibility alias
479 ())
482 ())
484 ()))
485 "Level 4 empty newsgroup face."
487 ;; backward-compatibility alias
499 ()))
500 "Level 5 newsgroup face."
502 ;; backward-compatibility alias
509 ())
512 ())
514 ()))
515 "Level 5 empty newsgroup face."
517 ;; backward-compatibility alias
529 ()))
530 "Level 6 newsgroup face."
532 ;; backward-compatibility alias
539 ())
542 ())
544 ()))
545 "Level 6 empty newsgroup face."
547 ;; backward-compatibility alias
559 ()))
560 "Low level newsgroup face."
562 ;; backward-compatibility alias
574 ()))
575 "Low level empty newsgroup face."
577 ;; backward-compatibility alias
590 "Level 1 mailgroup face."
592 ;; backward-compatibility alias
605 "Level 1 empty mailgroup face."
607 ;; backward-compatibility alias
620 "Level 2 mailgroup face."
622 ;; backward-compatibility alias
635 "Level 2 empty mailgroup face."
637 ;; backward-compatibility alias
650 "Level 3 mailgroup face."
652 ;; backward-compatibility alias
664 ()))
665 "Level 3 empty mailgroup face."
667 ;; backward-compatibility alias
680 "Low level mailgroup face."
682 ;; backward-compatibility alias
695 "Low level empty mailgroup face."
697 ;; backward-compatibility alias
701 ;; Summary mode faces.
704 "Face used for selected articles."
706 ;; backward-compatibility alias
713 "Face used for cancelled articles."
715 ;; backward-compatibility alias
728 "Face used for high interest ticked articles."
730 ;; backward-compatibility alias
743 "Face used for low interest ticked articles."
745 ;; backward-compatibility alias
757 ()))
758 "Face used for normal interest ticked articles."
760 ;; backward-compatibility alias
773 "Face used for high interest ancient articles."
775 ;; backward-compatibility alias
788 "Face used for low interest ancient articles."
790 ;; backward-compatibility alias
802 ()))
803 "Face used for normal interest ancient articles."
805 ;; backward-compatibility alias
816 "Face used for high interest uncached articles."
818 ;; backward-compatibility alias
829 "Face used for low interest uncached articles."
831 ;; backward-compatibility alias
842 "Face used for normal interest uncached articles."
844 ;; backward-compatibility alias
851 "Face used for high interest unread articles."
853 ;; backward-compatibility alias
860 "Face used for low interest unread articles."
862 ;; backward-compatibility alias
868 ()))
869 "Face used for normal interest unread articles."
871 ;; backward-compatibility alias
886 "Face used for high interest read articles."
888 ;; backward-compatibility alias
903 "Face used for low interest read articles."
905 ;; backward-compatibility alias
917 ()))
918 "Face used for normal interest read articles."
920 ;; backward-compatibility alias
925 ;;;
926 ;;; Gnus buffers
927 ;;;
932 "Do the same as `get-buffer-create', but store the created buffer."
937 "Add the current buffer to the list of Gnus buffers."
941 "Kill BUFFER and remove from the list of Gnus buffers."
948 "Return a list of live Gnus buffers."
957 gnus-buffers)
959 ;;; Splash screen.
973 ()))
974 "Face for the splash screen."
976 ;; backward-compatibility alias
992 "Indent rigidly using only spaces and no tabs."
998 ;; We translate tabs into spaces -- not everybody uses
999 ;; an 8-character tab.
1006 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1030 "*Color styles used for the Gnus logo."
1032 gnus-logo-color-alist))
1042 "Insert startup message in current buffer."
1043 ;; Insert the message.
1049 ;; Make sure the library defining `image-load-path' is loaded
1050 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1051 ;; get "defvar ignored because image-load-path is let-bound" when calling
1052 ;; `find-image' below.
1062 :color-symbols
1070 ;; Account for the pbm's blackground.
1074 ;; Account for the xbm's blackground.
1085 t))))
1089 _ ___ _ _
1090 _ ___ __ ___ __ _ ___
1091 __ _ ___ __ ___
1092 _ ___ _
1093 _ _ __ _
1094 ___ __ _
1095 __ _
1096 _ _ _
1097 _ _ _
1098 _ _ _
1099 __ ___
1100 _ _ _ _
1101 _ _
1102 _ _
1103 _ _
1104 _
1105 __
1107 "
1109 ;; And then hack it.
1118 ;; Fontify some.
1132 ;;; Do the rest.
1138 "Alist of group parameters.
1140 For example:
1142 (gnus-use-scoring nil)
1143 (gnus-summary-line-format
1145 (gcc-self . t)
1146 (display . all))
1149 (broken-reply-to . t)))"
1156 "If it is t, ignore case of group names specified in `gnus-parameters'.
1157 If it is nil, don't ignore case. If it is `default', which is for the
1158 backward compatibility, use the value of `case-fold-search'."
1169 "Define a group parameter PARAM.
1170 REST is a plist of following:
1171 :type One of `bool', `list' or nil.
1172 :function The name of the function.
1173 :function-document The documentation of the function.
1174 :parameter-type The type for customizing the parameter.
1175 :parameter-document The documentation for the parameter.
1176 :variable The name of the variable.
1177 :variable-document The documentation for the variable.
1178 :variable-group The group for customizing the variable.
1179 :variable-type The type for customizing the variable.
1180 :variable-default The default value of the variable."
1197 'progn
1199 ,variable-document
1205 gnus-group-parameters-more))
1208 ,parameter-type
1212 ,function-document
1214 val)
1217 t)
1222 (,variable
1224 elem value)
1232 ,function-document
1236 elem value)
1243 'value
1248 All other Gnus file and directory variables are initialized from this variable."
1254 "*Directory variable from which all other Gnus file variables are derived.
1256 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1257 This means that other directory variables that are initialized from
1258 this variable won't be set properly if you set this variable in `.gnus.el'.
1259 Set this variable in `.emacs' instead."
1264 "*Default directory for all Gnus buffers."
1267 directory))
1269 ;; Site dependent variables. These variables should be defined in
1270 ;; paths.el.
1273 "Specify a default NNTP server.
1274 This variable should be defined in paths.el, and should never be set
1275 by the user.
1276 If you want to change servers, you should use `gnus-select-method'.
1279 ;; Don't touch this variable.
1282 This is an obsolete variable, which is scarcely used. If you use an
1283 nntp server for your newsgroup and want to change the port number
1284 used to 899, you would say something along these lines:
1289 "A file with only the name of the nntp server in it."
1295 "Find default nntp server.
1296 Check the NNTPSERVER environment variable and the
1297 `gnus-nntpserver-file' file."
1305 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1306 ;; starting or even loading Gnus.
1307 ;;;###autoload(when (fboundp 'custom-autoload)
1308 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1318 gnus-default-nntp-server)
1322 nil
1325 "Default method for selecting a newsgroup.
1326 This variable should be a list, where the first element is how the
1327 news is to be fetched, the second is the address.
1330 NNTP, you could say:
1334 If you want to use your local spool, say:
1336 \(setq gnus-select-method (list 'nnspool (system-name)))
1338 If you use this variable, you must set `gnus-nntp-server' to nil.
1340 There is a lot more to know about select methods and virtual servers -
1341 see the manual for details."
1348 "*Method used for archiving messages you've sent.
1349 This should be a mail method.
1351 See also `gnus-update-message-archive-method'."
1355 gnus-select-method))
1360 The archive method is initially set according to the value of
1362 so that it may be used as a real method of the server which is named
1364 updated if the value of this variable is nil, even if you change the
1365 value of `gnus-message-archive-method' afterward. If you want the
1367 `gnus-message-archive-method', set this variable to a non-nil value."
1374 "*Name of the group in which to save the messages you've written.
1375 This can either be a string; a list of strings; or an alist
1376 of regexps/functions/forms to be evaluated to return a string (or a list
1377 of strings). The functions are called with the name of the current
1378 group (or nil) as a parameter.
1380 If you want to save your mail in one group and the news articles you
1381 write in another group, you could say something like:
1383 \(setq gnus-message-archive-group
1384 '((if (message-news-p)
1388 Normally the group names returned by this variable should be
1390 However, you may wish to store the message on some other server. In
1391 that case, just return a fully prefixed name of the group --
1395 function
1396 sexp
1397 string))
1400 "List of NNTP servers that the user can choose between interactively.
1401 To make Gnus query you for a server, you have to give `gnus' a
1402 non-numeric prefix - `C-u M-x gnus', in short."
1407 "*The name of the host running the NNTP server.
1408 This variable is semi-obsolete. Use the `gnus-select-method'
1409 variable instead."
1412 string))
1415 "A list of secondary methods that will be used for reading news.
1416 This is a list where each element is a complete select method (see
1417 `gnus-select-method').
1419 If, for instance, you want to read your mail with the nnml back end,
1420 you could set this variable:
1428 "Default default new newsgroups the first time Gnus is run.
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 read NoCeM cancel messages.
1576 You can also set this variable to a positive number as a group level.
1577 In that case, Gnus scans NoCeM messages when checking new news if this
1578 value is not exceeding a group level that you specify as the prefix
1579 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1580 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1581 level to those commands."
1590 gnus-level-default-subscribed
1594 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1599 "*If non-nil, enable scoring."
1605 "*A hook called when preparing to exit from the summary buffer.
1606 It calls `gnus-summary-expire-articles' by default."
1611 "*Non-nil means that you are a Usenet novice.
1612 If non-nil, verbose messages may be displayed and confirmations may be
1613 required."
1618 "*Non-nil means that you will never be asked for confirmation about anything.
1619 That doesn't mean *anything* anything; particularly destructive
1620 commands will still require prompting."
1625 "*If non-nil, require your confirmation when catching up a group."
1630 "*If non-nil, require your confirmation when exiting Gnus."
1635 "*Function for extracting address components from a From header.
1636 Two pre-defined function exist: `gnus-extract-address-components',
1637 which is the default, quite fast, and too simplistic solution, and
1638 `mail-extract-address-components', which works much better, but is
1639 slower."
1646 "*If non-nil, display clickable icons."
1651 "String used to separate shell commands."
1675 "*An alist of valid select methods.
1676 The first element of each list lists should be a string with the name
1677 of the select method. The other elements may be the category of
1678 this method (i. e., `post', `mail', `none' or whatever) or other
1679 properties that this method has (like being respoolable).
1680 If you implement a new select method, all you should have to change is
1681 this variable. I think."
1697 "Recomputes the select-method widget based on the value of
1698 `gnus-valid-select-methods'."
1700 "Widget for entering a select method."
1707 gnus-valid-select-methods)
1711 :inline t
1713 variable
1719 "List of buffers that should update their mode lines.
1720 The list may contain the symbols `group', `article', `tree' and
1721 `summary'. If the corresponding symbol is present, Gnus will keep
1722 that mode line updated with information that may be pertinent.
1723 If this variable is nil, screen refresh may be quicker."
1731 "*Max length of mode-line non-string contents.
1732 If this is nil, Gnus will take space as is needed, leaving the rest
1733 of the mode line intact."
1737 integer))
1739 ;; There should be special validation for this.
1744 to-address
1745 :function-document
1746 "Return GROUP's to-address."
1747 :variable-document
1748 "*Alist of group regexps and correspondent to-addresses."
1749 :variable-group gnus-group-parameter
1752 This will be used when doing followups and posts.
1754 This is primarily useful in mail groups that represent closed
1755 mailing lists--mailing lists where it's expected that everybody that
1756 writes to the mailing list is subscribed to it. Since using this
1757 parameter ensures that the mail only goes to the mailing list itself,
1758 it means that members won't receive two copies of your followups.
1760 Using `to-address' will actually work whether the group is foreign or
1761 not. Let's say there's a group on the server that is called
1762 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1763 articles from a mail-to-news gateway. Posting directly to this group
1764 is therefore impossible--you have to send mail to the mailing list
1765 address instead.
1767 The gnus-group-split mail splitting mechanism will behave as if this
1771 to-list
1772 :function-document
1773 "Return GROUP's to-list."
1774 :variable-document
1775 "*Alist of group regexps and correspondent to-lists."
1776 :variable-group gnus-group-parameter
1779 This address will be used when doing a `a' in the group.
1781 It is totally ignored when doing a followup--except that if it is
1782 present in a news group, you'll get mail group semantics when doing
1783 `f'.
1785 The gnus-group-split mail splitting mechanism will behave as if this
1789 subscribed
1790 :type bool
1791 :function-document
1792 "Return GROUP's subscription status."
1793 :variable-document
1794 "*Groups which are automatically considered subscribed."
1795 :variable-group gnus-group-parameter
1798 Gnus assumed that you are subscribed to the To/List address.
1800 When constructing a list of subscribed groups using
1801 `gnus-find-subscribed-addresses', Gnus includes the To address given
1805 auto-expire
1806 :type bool
1807 :function gnus-group-auto-expirable-p
1808 :function-document
1809 "Check whether GROUP is auto-expirable or not."
1810 :variable gnus-auto-expirable-newsgroups
1811 :variable-default nil
1812 :variable-document
1813 "*Groups in which to automatically mark read articles as expirable.
1814 If non-nil, this should be a regexp that should match all groups in
1815 which to perform auto-expiry. This only makes sense for mail groups."
1816 :variable-group nnmail-expire
1818 regexp)
1820 :parameter-document
1824 total-expire
1825 :type bool
1826 :function gnus-group-total-expirable-p
1827 :function-document
1828 "Check whether GROUP is total-expirable or not."
1829 :variable gnus-total-expirable-newsgroups
1830 :variable-default nil
1831 :variable-document
1832 "*Groups in which to perform expiry of all read articles.
1833 Use with extreme caution. All groups that match this regexp will be
1834 expiring - which means that all read articles will be deleted after
1835 \(say) one week. (This only goes for mail groups and the like, of
1836 course.)"
1837 :variable-group nnmail-expire
1839 regexp)
1841 :parameter-document
1842 "All read articles will be put through the expiry process
1844 This happens even if they are not marked as expirable.
1848 charset
1849 :function-document
1850 "Return the default charset of GROUP."
1851 :variable gnus-group-charset-alist
1852 :variable-default
1865 :variable-document
1866 "Alist of regexps (to match group names) and default charsets to be used when reading."
1867 :variable-group gnus-charset
1875 post-method
1876 :type list
1877 :function-document
1878 "Return a posting method for GROUP."
1879 :variable gnus-post-method-alist
1880 :variable-document
1881 "Alist of regexps (to match group names) and method to be used when
1882 posting an article."
1883 :variable-group gnus-group-foreign
1884 :parameter-type
1892 :parameter-document
1896 large-newsgroup-initial
1897 :type integer
1898 :function-document
1899 "Return GROUP's initial input of the number of articles."
1900 :variable-document
1901 "*Alist of group regexps and its initial input of the number of articles."
1902 :variable-group gnus-group-parameter
1908 This number will be prompted as the initial value of the number of
1909 articles to list when the group is a large newsgroup (see
1910 `gnus-large-newsgroup'). If it is nil, the default value is the
1913 ;; The Gnus registry's ignored groups
1915 registry-ignore
1916 :type list
1917 :function-document
1918 "Whether this group should be ignored by the registry."
1919 :variable gnus-registry-ignored-groups
1920 :variable-default nil
1921 :variable-document
1922 "*Groups in which the registry should be turned off."
1923 :variable-group gnus-registry
1930 :parameter-document
1933 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1935 "*Disable the group parameters for spam detection.
1936 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1943 "Spam group classification (requires spam.el).
1944 This group contains spam messages. On summary entry, unread messages
1945 will be marked as spam. On summary exit, the specified spam
1946 processors will be invoked on spam-marked messages, then those
1947 messages will be expired, so the spam processor will only see a
1951 "The ham value for the spam group parameter (requires spam.el).
1952 On summary exit, the specified ham processors will be invoked on
1953 ham-marked messages. Exercise caution, since the ham processor will
1954 see the same message more than once because there is no ham message
1958 spam-contents
1959 :type list
1960 :function-document
1961 "The spam type (spam, ham, or neither) of the group."
1962 :variable gnus-spam-newsgroup-contents
1963 :variable-default nil
1964 :variable-document
1965 "*Group classification (spam, ham, or neither). Only
1966 meaningful when spam.el is loaded. If non-nil, this should be a
1967 list of group name regexps associated with a classification for
1968 each one. In spam groups, new articles are marked as spam on
1969 summary entry. There is other behavior associated with ham and
1970 no classification when spam.el is loaded - see the manual."
1971 :variable-group spam
1985 :parameter-document
1986 "The spam classification (spam, ham, or neither) of this group.
1987 When a spam group is entered, all unread articles are marked as
1988 spam. There is other behavior associated with ham and no
1992 spam-resend-to
1993 :type list
1994 :function-document
1995 "The address to get spam resent (through spam-report-resend)."
1996 :variable gnus-spam-resend-to
1997 :variable-default nil
1998 :variable-document
1999 "The address to get spam resent (through spam-report-resend)."
2000 :variable-group spam
2004 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2005 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2006 :parameter-document
2010 ham-resend-to
2011 :type list
2012 :function-document
2013 "The address to get ham resent (through spam-report-resend)."
2014 :variable gnus-ham-resend-to
2015 :variable-default nil
2016 :variable-document
2017 "The address to get ham resent (through spam-report-resend)."
2018 :variable-group spam
2022 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2023 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2024 :parameter-document
2040 "OBSOLETE: The Gmane reporting summary exit spam processor.
2047 "OBSOLETE: The ifile summary exit ham processor.
2051 "OBSOLETE: The Bogofilter summary exit ham processor.
2055 "OBSOLETE: The spam-stat summary exit ham processor.
2059 "OBSOLETE: The whitelist summary exit ham processor.
2063 "OBSOLETE: The BBDB summary exit ham processor.
2067 "OBSOLETE: The ham copy exit ham processor.
2071 "OBSOLETE: The spamoracle summary exit ham processor.
2075 spam-process
2076 :type list
2077 :parameter-type
2080 :value nil
2117 :function-document
2118 "Which spam or ham processors will be applied when the summary is exited."
2119 :variable gnus-spam-process-newsgroups
2120 :variable-default nil
2121 :variable-document
2122 "*Groups in which to automatically process spam or ham articles with
2123 a backend on summary exit. If non-nil, this should be a list of group
2124 name regexps that should match all groups in which to do automatic
2125 spam processing, associated with the appropriate processor."
2126 :variable-group spam
2127 :variable-type
2168 :parameter-document
2172 spam-autodetect
2173 :type list
2174 :parameter-type
2176 :function-document
2177 "Should spam be autodetected (with spam-split) in this group?"
2178 :variable gnus-spam-autodetect
2179 :variable-default nil
2180 :variable-document
2181 "*Groups in which spam should be autodetected when they are entered.
2182 Only unseen articles will be examined, unless
2183 spam-autodetect-recheck-messages is set."
2184 :variable-group spam
2185 :variable-type
2190 boolean))
2191 :parameter-document
2192 "Spam autodetection.
2193 Only unseen articles will be examined, unless
2197 spam-autodetect-methods
2198 :type list
2199 :parameter-type
2222 :function-document
2223 "Methods to be used for autodetection in each group"
2224 :variable gnus-spam-autodetect-methods
2225 :variable-default nil
2226 :variable-document
2227 "*Methods for autodetecting spam per group.
2228 Requires the spam-autodetect parameter. Only unseen articles
2229 will be examined, unless spam-autodetect-recheck-messages is
2230 set."
2231 :variable-group spam
2232 :variable-type
2259 :parameter-document
2260 "Spam autodetection methods.
2261 Requires the spam-autodetect parameter. Only unseen articles
2262 will be examined, unless spam-autodetect-recheck-messages is
2266 spam-process-destination
2267 :type list
2268 :parameter-type
2274 :function-document
2275 "Where spam-processed articles will go at summary exit."
2276 :variable gnus-spam-process-destinations
2277 :variable-default nil
2278 :variable-document
2279 "*Groups in which to explicitly send spam-processed articles to
2280 another group, or expire them (the default). If non-nil, this should
2281 be a list of group name regexps that should match all groups in which
2282 to do spam-processed article moving, associated with the destination
2283 group or nil for explicit expiration. This only makes sense for
2284 mail groups."
2285 :variable-group spam
2286 :variable-type
2297 :parameter-document
2301 ham-process-destination
2302 :type list
2303 :parameter-type
2311 :function-document
2312 "Where ham articles will go at summary exit from a spam group."
2313 :variable gnus-ham-process-destinations
2314 :variable-default nil
2315 :variable-document
2316 "*Groups in which to explicitly send ham articles to
2317 another group, or do nothing (the default). If non-nil, this should
2318 be a list of group name regexps that should match all groups in which
2319 to do ham article moving, associated with the destination
2320 group or nil for explicit ignoring. This only makes sense for
2321 mail groups, and only works in spam groups."
2322 :variable-group spam
2323 :variable-type
2335 :parameter-document
2339 ham-marks
2350 :parameter-document
2351 "Marks considered ham (positively not spam). Such articles will be
2352 processed as ham (non-spam) on group exit. When nil, the global
2353 spam-ham-marks variable takes precedence."
2355 gnus-read-mark
2356 gnus-killed-mark
2357 gnus-kill-file-mark
2358 gnus-low-score-mark))))
2359 :variable-group spam
2360 :variable-document
2364 spam-marks
2373 :parameter-document
2374 "Marks considered spam.
2375 Such articles will be processed as spam on group exit. When nil, the global
2376 spam-spam-marks variable takes precedence."
2378 :variable-group spam
2379 :variable-document
2383 "Number of group name elements to leave alone when making a short group name."
2388 "*If non-nil, once you set a level, Gnus will use this level."
2392 ;; Hooks.
2395 "A hook run while Gnus is loaded."
2400 "A hook called to apply kill files to a group.
2401 This hook is intended to apply a kill file to the selected newsgroup.
2402 The function `gnus-apply-kill-file' is called by default.
2404 Since a general kill file is too heavy to use only for a few
2405 newsgroups, I recommend you to use a lighter hook function. For
2406 example, if you'd like to apply a kill file to articles which contains
2407 a string `rmgroup' in subject in newsgroup `control', you can use the
2408 following hook:
2410 (setq gnus-apply-kill-hook
2411 (list
2412 (lambda ()
2421 "Function run when a group level is changed.
2422 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2425 function))
2427 ;;; Face thingies.
2431 mouse-face
2432 summary-menu group-menu article-menu
2433 tree-highlight menu highlight
2434 browse-menu server-menu
2435 page-marker tree-menu binary-menu pick-menu)
2436 "*Enable visual features.
2437 If `visual' is disabled, there will be no menus and few faces. Most of
2438 the visual customization options below will be ignored. Gnus will use
2439 less space and be faster as a result.
2441 This variable can also be a list of visual elements to switch on. For
2442 instance, to switch off all visual things except menus, you can say:
2444 (setq gnus-visual '(menu))
2446 Valid elements include `summary-highlight', `group-highlight',
2447 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2448 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2449 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2469 ;; Byte-compiler warning.
2471 ;; Find out whether the gnus-visual TYPE is wanted.
2475 gnus-visual
2479 t))))
2489 "*Face used for group or summary buffer mouse highlighting.
2490 The line beneath the mouse pointer will be highlighted with this
2491 face."
2504 "Controls use of the agent cache while plugged.
2505 When set, Gnus will prefer using the locally stored content rather
2506 than re-fetching it from the server. You also need to enable
2507 `gnus-agent' for this to have any affect."
2513 "Default charset assumed to be used when viewing non-ASCII characters.
2514 This variable is overridden on a group-to-group basis by the
2515 `gnus-group-charset-alist' variable and is only used on groups not
2516 covered by that variable."
2520 ;; Fixme: Doc reference to agent.
2522 "Whether we want to use the Gnus agent or not.
2524 You may customize gnus-agent to disable its use. However, some
2525 back ends have started to use the agent as a client-side cache.
2526 Disabling the agent may result in noticeable loss of performance."
2532 "Function called by the command `gnus-other-frame'."
2540 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2541 This should be an alist for Emacs, or a plist for XEmacs."
2552 "Which information should be exposed in the User-Agent header.
2554 Can be a list of symbols or a string. Valid symbols are `gnus'
2555 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2556 addition to the Emacs version, you can add `codename' \(show
2557 \(S\)XEmacs codename\) or either `config' \(show system
2558 configuration\) or `type' \(show system type\). If you set it to
2559 a string, be sure to use a valid format, see RFC 2616."
2572 ;; Convert old (< 2005-01-10) symbol type values:
2591 \f
2592 ;;; Internal variables
2597 ; Reset each time gnus-agent-covered-methods is changed else
2598 ; gnus-agent-method-p may mis-report a methods status.
2599 )
2624 ;; Variable holding the user answers to all method prompts.
2627 ;; Variable holding the user answers to all mail method prompts.
2630 ;; Variable holding the user answers to all group prompts.
2638 "*The directory where cached articles will be stored."
2644 nnspool "cache"
2668 ;; Propagate flags to server, with the following exceptions:
2669 ;; `seen' is private to each gnus installation
2670 ;; `cache' is a internal gnus flag for each gnus installation
2671 ;; `download' is a agent flag private to each gnus installation
2672 ;; `unsend' are for nndraft groups only
2673 ;; `score' is not a proper mark
2674 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2677 "Marks that shouldn't be propagated to back ends.
2678 Typical marks are those that make no sense in a standalone back end,
2679 such as a mark that says whether an article is stored in the cache
2692 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2717 gnus-newsrc-last-checked-date
2718 gnus-newsrc-alist gnus-server-alist
2719 gnus-killed-list gnus-zombie-list
2720 gnus-topic-topology gnus-topic-alist
2721 gnus-format-specs)
2725 "Assoc list of read articles.
2729 "Assoc list of registry data.
2756 ;; Save window configuration.
2769 ;;; End of variables.
2771 ;; Define some autoload functions Gnus might use.
2774 ;; This little mapcar goes through the list below and marks the
2775 ;; symbols in question as autoloaded functions.
2795 message-send-and-exit message-yank-original)
2799 ;; This is only used in message.el, which has an autoload.
2801 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2803 ;; Next two only used in gnus-util.
2804 rmail-summary-exists rmail-select-summary)
2805 ;; Only used in gnus-util, which has an autoload.
2811 gnus-Folder-save-name gnus-folder-save-name)
2814 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2815 gnus-demon-add-disconnection gnus-demon-add-handler
2816 gnus-demon-remove-handler)
2818 gnus-demon-init gnus-demon-cancel)
2820 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2821 gnus-face-from-file)
2823 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2825 gnus-nocem-unwanted-article-p)
2827 gnus-server-server-name)
2830 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2831 gnus-article-hide-citation gnus-article-fill-cited-article
2832 gnus-article-hide-citation-in-followups)
2834 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2835 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2837 gnus-cache-possibly-remove-articles gnus-cache-request-article
2838 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2839 gnus-cache-enter-remove-article gnus-cached-article-p
2840 gnus-cache-open gnus-cache-close gnus-cache-update-article
2841 gnus-cache-articles-in-group)
2843 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2845 gnus-summary-increase-score gnus-summary-set-score
2846 gnus-summary-raise-thread gnus-summary-raise-same-subject
2847 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2848 gnus-summary-lower-thread gnus-summary-lower-same-subject
2849 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2850 gnus-summary-current-score gnus-score-delta-default
2851 gnus-score-flush-cache gnus-score-close
2852 gnus-possibly-score-headers gnus-score-followup-article
2853 gnus-score-followup-thread)
2856 gnus-current-score-file-nondirectory gnus-score-adaptive
2857 gnus-score-find-trace gnus-score-file-name)
2861 gnus-subscribe-topics)
2865 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2866 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2867 gnus-uu-mark-by-regexp gnus-uu-mark-all
2868 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2869 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2870 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2871 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2872 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2873 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2874 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2875 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2878 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2880 gnus-group-post-news gnus-group-mail gnus-group-news
2881 gnus-summary-post-news gnus-summary-news-other-window
2882 gnus-summary-followup gnus-summary-followup-with-original
2883 gnus-summary-cancel-article gnus-summary-supersede-article
2884 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2885 gnus-summary-mail-forward gnus-summary-mail-other-window
2886 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2887 gnus-summary-wide-reply gnus-summary-followup-to-mail
2888 gnus-summary-followup-to-mail-with-original gnus-bug
2889 gnus-summary-wide-reply-with-original
2890 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2891 gnus-summary-post-forward)
2896 gnus-list-of-unread-articles gnus-list-of-read-articles
2897 gnus-offer-save-summaries gnus-make-thread-indent-array
2898 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2899 gnus-summary-skip-intangible gnus-summary-article-number
2900 gnus-data-header gnus-data-find)
2902 gnus-group-list-groups gnus-group-first-unread-group
2903 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2904 gnus-group-setup-buffer gnus-group-get-new-news
2905 gnus-group-make-help-group gnus-group-update-group
2906 gnus-group-iterate gnus-group-group-name)
2908 gnus-backlog-remove-article)
2910 gnus-article-prepare gnus-article-set-window-start
2911 gnus-article-next-page gnus-article-prev-page
2912 gnus-request-article-this-buffer gnus-article-mode
2913 gnus-article-setup-buffer gnus-narrow-to-page
2914 gnus-article-delete-invisible-text gnus-treat-article)
2916 gnus-article-hide-headers gnus-article-hide-boring-headers
2917 gnus-article-treat-overstrike
2918 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2919 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2920 gnus-article-de-base64-unreadable
2921 gnus-article-decode-HZ
2922 gnus-article-wash-html
2923 gnus-article-unsplit-urls
2924 gnus-article-hide-pem gnus-article-hide-signature
2925 gnus-article-strip-leading-blank-lines gnus-article-date-local
2926 gnus-article-date-original gnus-article-date-lapsed
2927 ;;gnus-article-show-all-headers
2928 gnus-article-edit-mode gnus-article-edit-article
2929 gnus-article-edit-done gnus-article-decode-encoded-words
2930 gnus-start-date-timer gnus-stop-date-timer
2931 gnus-mime-view-all-parts)
2934 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2935 gnus-check-reasonable-setup)
2937 gnus-dup-enter-articles)
2943 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2944 gnus-async-halt-prefetch)
2946 gnus-agent-save-active gnus-agent-method-p
2947 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2948 gnus-summary-set-agent-mark gnus-agent-save-group-info
2949 gnus-agent-request-article gnus-agent-retrieve-headers)
2951 gnus-unplugged gnus-agentize gnus-agent-batch)
2953 gnus-summary-save-article-vm)
2958 gnus-group-split-update)
2961 ;;; gnus-sum.el thingies
2965 "*The format specification of the lines in the summary buffer.
2967 It works along the same lines as a normal formatting string,
2968 with some simple extensions.
2970 %N Article number, left padded with spaces (string)
2971 %S Subject (string)
2973 %n Name of the poster (string)
2974 %a Extracted name of the poster (string)
2975 %A Extracted address of the poster (string)
2976 %F Contents of the From: header (string)
2977 %f Contents of the From: or To: headers (string)
2978 %x Contents of the Xref: header (string)
2979 %D Date of the article (string)
2980 %d Date of the article (string) in DD-MMM format
2981 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2982 %M Message-id of the article (string)
2983 %r References of the article (string)
2984 %c Number of characters in the article (integer)
2985 %k Pretty-printed version of the above (string)
2987 %L Number of lines in the article (integer)
2988 %I Indentation based on thread level (a string of spaces)
2989 %B A complex trn-style thread tree (string)
2990 The variables `gnus-sum-thread-*' can be used for customization.
2991 %T A string with two possible values: 80 spaces if the article
2992 is on thread level two or larger and 0 spaces on level one
2997 %> Spaces of length thread-level (string)
2998 %< Spaces of length (- 20 thread-level) (string)
2999 %i Article score (number)
3000 %z Article zcore (character)
3001 %t Number of articles under the current thread (number).
3002 %e Whether the thread is empty or not (character).
3003 %V Total thread score (number).
3004 %P The line number (number).
3005 %O Download mark (character).
3006 %* If present, indicates desired cursor position
3007 (instead of after first colon).
3008 %u User defined specifier. The next character in the format string should
3009 be a letter. Gnus will call the function gnus-user-format-function-X,
3010 where X is the letter following %u. The function will be passed the
3011 current header as argument. The function should return a string, which
3012 will be inserted into the summary just like information from any other
3013 summary specifier.
3015 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3016 with care. For reasons of efficiency, Gnus will compute what column
3018 it is invalid to have these specs after a variable-length spec. Well,
3019 you might not be arrested, but your summary buffer will look strange,
3020 which is bad enough.
3022 The smart choice is to have these specs as far to the left as
3023 possible.
3025 This restriction may disappear in later versions of Gnus.
3027 General format specifiers can also be used.
3028 See Info node `(gnus)Formatting Variables'."
3033 ;;;
3034 ;;; Skeleton keymaps
3035 ;;;
3040 (while keys
3041 (define-key keymap (pop keys) 'undefined))))
3043 (defvar gnus-article-mode-map
3044 (let ((keymap (make-sparse-keymap)))
3045 (gnus-suppress-keymap keymap)
3046 keymap))
3047 (defvar gnus-summary-mode-map
3048 (let ((keymap (make-keymap)))
3049 (gnus-suppress-keymap keymap)
3050 keymap))
3051 (defvar gnus-group-mode-map
3052 (let ((keymap (make-keymap)))
3053 (gnus-suppress-keymap keymap)
3054 keymap))
3056 \f
3058 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3059 ;; If you want the cursor to go somewhere else, set these two
3060 ;; functions in some startup hook to whatever you want.
3061 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3062 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3064 ;;; Various macros and substs.
3066 (defun gnus-header-from (header)
3067 (mail-header-from header))
3069 (defmacro gnus-gethash (string hashtable)
3070 "Get hash value of STRING in HASHTABLE."
3071 `(symbol-value (intern-soft ,string ,hashtable)))
3073 (defmacro gnus-gethash-safe (string hashtable)
3074 "Get hash value of STRING in HASHTABLE.
3075 Return nil if not defined."
3076 `(let ((sym (intern-soft ,string ,hashtable)))
3077 (and (boundp sym) (symbol-value sym))))
3079 (defmacro gnus-sethash (string value hashtable)
3080 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3081 `(set (intern ,string ,hashtable) ,value))
3082 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3084 (defmacro gnus-group-unread (group)
3085 "Get the currently computed number of unread articles in GROUP."
3086 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3088 (defmacro gnus-group-entry (group)
3089 "Get the newsrc entry for GROUP."
3090 `(gnus-gethash ,group gnus-newsrc-hashtb))
3092 (defmacro gnus-active (group)
3093 "Get active info on GROUP."
3094 `(gnus-gethash ,group gnus-active-hashtb))
3096 (defmacro gnus-set-active (group active)
3097 "Set GROUP's active info."
3098 `(gnus-sethash ,group ,active gnus-active-hashtb))
3100 ;; Info access macros.
3102 (defmacro gnus-info-group (info)
3103 `(nth 0 ,info))
3104 (defmacro gnus-info-rank (info)
3105 `(nth 1 ,info))
3106 (defmacro gnus-info-read (info)
3107 `(nth 2 ,info))
3108 (defmacro gnus-info-marks (info)
3109 `(nth 3 ,info))
3110 (defmacro gnus-info-method (info)
3111 `(nth 4 ,info))
3112 (defmacro gnus-info-params (info)
3113 `(nth 5 ,info))
3115 (defmacro gnus-info-level (info)
3116 `(let ((rank (gnus-info-rank ,info)))
3117 (if (consp rank)
3118 (car rank)
3119 rank)))
3120 (defmacro gnus-info-score (info)
3121 `(let ((rank (gnus-info-rank ,info)))
3122 (or (and (consp rank) (cdr rank)) 0)))
3124 (defmacro gnus-info-set-group (info group)
3125 `(setcar ,info ,group))
3126 (defmacro gnus-info-set-rank (info rank)
3127 `(setcar (nthcdr 1 ,info) ,rank))
3128 (defmacro gnus-info-set-read (info read)
3129 `(setcar (nthcdr 2 ,info) ,read))
3130 (defmacro gnus-info-set-marks (info marks &optional extend)
3131 (if extend
3132 `(gnus-info-set-entry ,info ,marks 3)
3133 `(setcar (nthcdr 3 ,info) ,marks)))
3134 (defmacro gnus-info-set-method (info method &optional extend)
3135 (if extend
3136 `(gnus-info-set-entry ,info ,method 4)
3137 `(setcar (nthcdr 4 ,info) ,method)))
3138 (defmacro gnus-info-set-params (info params &optional extend)
3139 (if extend
3140 `(gnus-info-set-entry ,info ,params 5)
3141 `(setcar (nthcdr 5 ,info) ,params)))
3143 (defun gnus-info-set-entry (info entry number)
3144 ;; Extend the info until we have enough elements.
3145 (while (<= (length info) number)
3146 (nconc info (list nil)))
3147 ;; Set the entry.
3148 (setcar (nthcdr number info) entry))
3150 (defmacro gnus-info-set-level (info level)
3151 `(let ((rank (cdr ,info)))
3152 (if (consp (car rank))
3153 (setcar (car rank) ,level)
3154 (setcar rank ,level))))
3155 (defmacro gnus-info-set-score (info score)
3156 `(let ((rank (cdr ,info)))
3157 (if (consp (car rank))
3158 (setcdr (car rank) ,score)
3159 (setcar rank (cons (car rank) ,score)))))
3161 (defmacro gnus-get-info (group)
3162 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3164 ;;; Load the compatibility functions.
3166 (require 'gnus-ems)
3168 \f
3169 ;;;
3170 ;;; Shutdown
3171 ;;;
3173 (defvar gnus-shutdown-alist nil)
3175 (defun gnus-add-shutdown (function &rest symbols)
3176 "Run FUNCTION whenever one of SYMBOLS is shut down."
3177 (push (cons function symbols) gnus-shutdown-alist))
3179 (defun gnus-shutdown (symbol)
3180 "Shut down everything that waits for SYMBOL."
3181 (dolist (entry gnus-shutdown-alist)
3182 (when (memq symbol (cdr entry))
3183 (funcall (car entry)))))
3185 \f
3186 ;;;
3187 ;;; Gnus Utility Functions
3188 ;;;
3190 (defun gnus-find-subscribed-addresses ()
3191 "Return a regexp matching the addresses of all subscribed mail groups.
3192 It consists of the `to-address' or `to-list' parameter of all groups
3193 with a `subscribed' parameter."
3194 (let (group address addresses)
3195 (dolist (entry (cdr gnus-newsrc-alist))
3196 (setq group (car entry))
3197 (when (gnus-parameter-subscribed group)
3198 (setq address (mail-strip-quoted-names
3199 (or (gnus-group-fast-parameter group 'to-address)
3200 (gnus-group-fast-parameter group 'to-list))))
3201 (when address
3202 (add-to-list 'addresses address))))
3203 (when addresses
3206 (defmacro gnus-string-or (&rest strings)
3207 "Return the first element of STRINGS that is a non-blank string.
3208 STRINGS will be evaluated in normal `or' order."
3209 `(gnus-string-or-1 (list ,@strings)))
3211 (defun gnus-string-or-1 (strings)
3212 (let (string)
3213 (while strings
3214 (setq string (pop strings))
3216 (setq string nil)
3217 (setq strings nil)))
3218 string))
3220 (defun gnus-version (&optional arg)
3221 "Version number of this version of Gnus.
3222 If ARG, insert string at point."
3223 (interactive "P")
3224 (if arg
3225 (insert (message gnus-version))
3226 (message gnus-version)))
3228 (defun gnus-continuum-version (&optional version)
3229 "Return VERSION as a floating point number."
3230 (interactive)
3231 (unless version
3232 (setq version gnus-version))
3235 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3236 (number (match-string 2 version))
3237 major minor least)
3238 (unless (string-match
3240 (error "Invalid version string: %s" version))
3241 (setq major (string-to-number (match-string 1 number))
3242 minor (string-to-number (match-string 2 number))
3243 least (if (match-beginning 3)
3244 (string-to-number (match-string 3 number))
3245 0))
3246 (string-to-number
3247 (if (zerop major)
3248 (format "%s00%02d%02d"
3249 (if (member alpha '("(ding)" "d"))
3250 "4.99"
3251 (+ 5 (* 0.02
3252 (abs
3253 (- (mm-char-int (aref (downcase alpha) 0))
3254 (mm-char-int ?t))))
3255 -0.01))
3256 minor least)
3257 (format "%d.%02d%02d" major minor least))))))
3259 (defun gnus-info-find-node (&optional nodename)
3260 "Find Info documentation of Gnus."
3261 (interactive)
3262 ;; Enlarge info window if needed.
3263 (let (gnus-info-buffer)
3264 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3265 (setq gnus-info-buffer (current-buffer))
3266 (gnus-configure-windows 'info)))
3268 ;;;
3269 ;;; gnus-interactive
3270 ;;;
3272 (defvar gnus-current-prefix-symbol nil
3273 "Current prefix symbol.")
3275 (defvar gnus-current-prefix-symbols nil
3276 "List of current prefix symbols.")
3278 (defun gnus-interactive (string &optional params)
3279 "Return a list that can be fed to `interactive'.
3280 See `interactive' for full documentation.
3282 Adds the following specs:
3284 y -- The current symbolic prefix.
3285 Y -- A list of the current symbolic prefix(es).
3286 A -- Article number.
3287 H -- Article header.
3288 g -- Group name."
3289 (let ((i 0)
3290 out c prompt)
3291 (while (< i (length string))
3293 (setq c (aref string i))
3294 (when (match-end 1)
3295 (setq prompt (match-string 1 string)))
3296 (setq i (match-end 0))
3297 ;; We basically emulate just about everything that
3298 ;; `interactive' does, but add the specs listed above.
3299 (push
3300 (cond
3301 ((= c ?a)
3302 (completing-read prompt obarray 'fboundp t))
3303 ((= c ?b)
3304 (read-buffer prompt (current-buffer) t))
3305 ((= c ?B)
3306 (read-buffer prompt (other-buffer (current-buffer))))
3307 ((= c ?c)
3308 (read-char))
3309 ((= c ?C)
3310 (completing-read prompt obarray 'commandp t))
3311 ((= c ?d)
3312 (point))
3313 ((= c ?D)
3314 (read-file-name prompt nil default-directory 'lambda))
3315 ((= c ?f)
3316 (read-file-name prompt nil nil 'lambda))
3317 ((= c ?F)
3318 (read-file-name prompt))
3319 ((= c ?k)
3320 (read-key-sequence prompt))
3321 ((= c ?K)
3322 (error "Not implemented spec"))
3323 ((= c ?e)
3324 (error "Not implemented spec"))
3325 ((= c ?m)
3326 (mark))
3327 ((= c ?N)
3328 (error "Not implemented spec"))
3329 ((= c ?n)
3330 (string-to-number (read-from-minibuffer prompt)))
3331 ((= c ?p)
3332 (prefix-numeric-value current-prefix-arg))
3333 ((= c ?P)
3334 current-prefix-arg)
3335 ((= c ?r)
3336 'gnus-prefix-nil)
3337 ((= c ?s)
3338 (read-string prompt))
3339 ((= c ?S)
3340 (intern (read-string prompt)))
3341 ((= c ?v)
3342 (read-variable prompt))
3343 ((= c ?x)
3344 (read-minibuffer prompt))
3345 ((= c ?x)
3346 (eval-minibuffer prompt))
3347 ;; And here the new specs come.
3348 ((= c ?y)
3349 gnus-current-prefix-symbol)
3350 ((= c ?Y)
3351 gnus-current-prefix-symbols)
3352 ((= c ?g)
3353 (gnus-group-group-name))
3354 ((= c ?A)
3355 (gnus-summary-skip-intangible)
3356 (or (get-text-property (point) 'gnus-number)
3357 (gnus-summary-last-subject)))
3358 ((= c ?H)
3359 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3360 (t
3361 (error "Non-implemented spec")))
3362 out)
3363 (cond
3364 ((= c ?r)
3365 (push (if (< (point) (mark)) (point) (mark)) out)
3366 (push (if (> (point) (mark)) (point) (mark)) out))))
3367 (setq out (delq 'gnus-prefix-nil out))
3368 (nreverse out)))
3370 (defun gnus-symbolic-argument (&optional arg)
3371 "Read a symbolic argument and a command, and then execute command."
3372 (interactive "P")
3373 (let* ((in-command (this-command-keys))
3374 (command in-command)
3375 gnus-current-prefix-symbols
3376 gnus-current-prefix-symbol
3377 syms)
3378 (while (equal in-command command)
3379 (message "%s-" (key-description (this-command-keys)))
3380 (push (intern (char-to-string (read-char))) syms)
3381 (setq command (read-key-sequence nil t)))
3382 (setq gnus-current-prefix-symbols (nreverse syms)
3383 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3384 (call-interactively (key-binding command t))))
3386 ;;; More various functions.
3388 (defsubst gnus-check-backend-function (func group)
3389 "Check whether GROUP supports function FUNC.
3390 GROUP can either be a string (a group name) or a select method."
3391 (ignore-errors
3392 (let ((method (if (stringp group)
3393 (car (gnus-find-method-for-group group))
3394 group)))
3395 (unless (featurep method)
3396 (require method))
3397 (fboundp (intern (format "%s-%s" method func))))))
3399 (defun gnus-group-read-only-p (&optional group)
3400 "Check whether GROUP supports editing or not.
3401 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3402 that that variable is buffer-local to the summary buffers."
3403 (let ((group (or group gnus-newsgroup-name)))
3404 (not (gnus-check-backend-function 'request-replace-article group))))
3406 (defun gnus-virtual-group-p (group)
3407 "Say whether GROUP is virtual or not."
3408 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3409 gnus-valid-select-methods)))
3411 (defun gnus-news-group-p (group &optional article)
3412 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3413 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3414 t) ;is news of course.
3415 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3416 nil) ;must be mail then.
3417 ((vectorp article) ;Has header info.
3418 (eq (gnus-request-type group (mail-header-id article)) 'news))
3419 ((null article) ;Hasn't header info
3420 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3421 ((< article 0) ;Virtual message
3422 nil) ;we don't know, guess mail.
3423 (t ;Has positive number
3424 (eq (gnus-request-type group article) 'news)))) ;use it.
3426 ;; Returns a list of writable groups.
3427 (defun gnus-writable-groups ()
3428 (let ((alist gnus-newsrc-alist)
3429 groups group)
3430 (while (setq group (car (pop alist)))
3431 (unless (gnus-group-read-only-p group)
3432 (push group groups)))
3433 (nreverse groups)))
3435 ;; Check whether to use long file names.
3436 (defun gnus-use-long-file-name (symbol)
3437 ;; The variable has to be set...
3438 (and gnus-use-long-file-name
3439 ;; If it isn't a list, then we return t.
3440 (or (not (listp gnus-use-long-file-name))
3441 ;; If it is a list, and the list contains `symbol', we
3442 ;; return nil.
3443 (not (memq symbol gnus-use-long-file-name)))))
3445 ;; Generate a unique new group name.
3446 (defun gnus-generate-new-group-name (leaf)
3447 (let ((name leaf)
3448 (num 0))
3449 (while (gnus-group-entry name)
3450 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3451 name))
3453 (defun gnus-ephemeral-group-p (group)
3454 "Say whether GROUP is ephemeral or not."
3455 (gnus-group-get-parameter group 'quit-config t))
3457 (defun gnus-group-quit-config (group)
3458 "Return the quit-config of GROUP."
3459 (gnus-group-get-parameter group 'quit-config t))
3461 (defun gnus-kill-ephemeral-group (group)
3462 "Remove ephemeral GROUP from relevant structures."
3463 (gnus-sethash group nil gnus-newsrc-hashtb))
3465 (defun gnus-simplify-mode-line ()
3466 "Make mode lines a bit simpler."
3467 (setq mode-line-modified (cdr gnus-mode-line-modified))
3468 (when (listp mode-line-format)
3469 (make-local-variable 'mode-line-format)
3470 (setq mode-line-format (copy-sequence mode-line-format))
3471 (when (equal (nth 3 mode-line-format) " ")
3472 (setcar (nthcdr 3 mode-line-format) " "))))
3474 ;;; Servers and groups.
3476 (defsubst gnus-server-add-address (method)
3477 (let ((method-name (symbol-name (car method))))
3478 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3479 (not (assq (intern (concat method-name "-address")) method))
3480 (memq 'physical-address (assq (car method)
3481 gnus-valid-select-methods)))
3482 (append method (list (list (intern (concat method-name "-address"))
3483 (nth 1 method))))
3484 method)))
3486 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3487 (catch 'server-name
3488 (setq method (or method gnus-select-method))
3490 ;; Perhaps it is already in the cache.
3491 (unless nocache
3492 (mapc (lambda (name-method)
3493 (if (equal (cdr name-method) method)
3494 (throw 'server-name (car name-method))))
3495 gnus-server-method-cache))
3497 (mapc
3498 (lambda (server-alist)
3499 (mapc (lambda (name-method)
3500 (when (gnus-methods-equal-p (cdr name-method) method)
3501 (unless (member name-method gnus-server-method-cache)
3502 (push name-method gnus-server-method-cache))
3503 (throw 'server-name (car name-method))))
3504 server-alist))
3505 (list gnus-server-alist
3506 gnus-predefined-server-alist))
3508 (let* ((name (if (member (cadr method) '(nil ""))
3509 (format "%s" (car method))
3510 (format "%s:%s" (car method) (cadr method))))
3511 (name-method (cons name method)))
3512 (when (and (not (member name-method gnus-server-method-cache))
3513 (not no-enter-cache)
3514 (not (assoc (car name-method) gnus-server-method-cache)))
3515 (push name-method gnus-server-method-cache))
3516 name)))
3518 (defsubst gnus-server-to-method (server)
3519 "Map virtual server names to select methods."
3520 (or (and server (listp server) server)
3521 (cdr (assoc server gnus-server-method-cache))
3522 (let ((result
3523 (or
3524 ;; Perhaps this is the native server?
3525 (and (equal server "native") gnus-select-method)
3526 ;; It should be in the server alist.
3527 (cdr (assoc server gnus-server-alist))
3528 ;; It could be in the predefined server alist.
3529 (cdr (assoc server gnus-predefined-server-alist))
3530 ;; If not, we look through all the opened server
3531 ;; to see whether we can find it there.
3532 (let ((opened gnus-opened-servers))
3533 (while (and opened
3534 (not (equal server (format "%s:%s" (caaar opened)
3535 (cadaar opened)))))
3536 (pop opened))
3537 (caar opened))
3538 ;; It could be a named method, search all servers
3539 (let ((servers gnus-secondary-select-methods))
3540 (while (and servers
3541 (not (equal server (format "%s:%s" (caar servers)
3542 (cadar servers)))))
3543 (pop servers))
3544 (car servers))
3545 ;; This could be some sort of foreign server that I
3546 ;; simply haven't opened (yet). Do a brute-force scan
3547 ;; of the entire gnus-newsrc-alist for the server name
3548 ;; of every method. As a side-effect, loads the
3549 ;; gnus-server-method-cache so this only happens once,
3550 ;; if at all.
3551 (let ((alist (cdr gnus-newsrc-alist))
3552 method match)
3553 (while alist
3554 (setq method (gnus-info-method (pop alist)))
3555 (when (and (not (stringp method))
3556 (equal server
3557 (gnus-method-to-server method nil t)))
3558 (setq match method
3559 alist nil)))
3560 match))))
3561 (when (and result
3562 (not (assoc server gnus-server-method-cache)))
3563 (push (cons server result) gnus-server-method-cache))
3564 result)))
3566 (defsubst gnus-server-get-method (group method)
3567 ;; Input either a server name, and extended server name, or a
3568 ;; select method, and return a select method.
3569 (cond ((stringp method)
3570 (gnus-server-to-method method))
3571 ((equal method gnus-select-method)
3572 gnus-select-method)
3573 ((and (stringp (car method))
3574 group)
3575 (gnus-server-extend-method group method))
3576 ((and method
3577 (not group)
3578 (equal (cadr method) ""))
3579 method)
3580 (t
3581 (gnus-server-add-address method))))
3583 (defmacro gnus-method-equal (ss1 ss2)
3584 "Say whether two servers are equal."
3585 `(let ((s1 ,ss1)
3586 (s2 ,ss2))
3587 (or (equal s1 s2)
3588 (and (= (length s1) (length s2))
3589 (progn
3590 (while (and s1 (member (car s1) s2))
3591 (setq s1 (cdr s1)))
3592 (null s1))))))
3594 (defun gnus-methods-equal-p (m1 m2)
3595 (let ((m1 (or m1 gnus-select-method))
3596 (m2 (or m2 gnus-select-method)))
3597 (or (equal m1 m2)
3598 (and (eq (car m1) (car m2))
3599 (or (not (memq 'address (assoc (symbol-name (car m1))
3600 gnus-valid-select-methods)))
3601 (equal (nth 1 m1) (nth 1 m2)))))))
3603 (defun gnus-methods-sloppily-equal (m1 m2)
3604 ;; Same method.
3605 (or
3606 (eq m1 m2)
3607 ;; Type and name are equal.
3608 (and
3609 (eq (car m1) (car m2))
3610 (equal (cadr m1) (cadr m2))
3611 (gnus-sloppily-equal-method-parameters m1 m2))))
3613 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3614 ;; Check parameters for sloppy equalness.
3615 (let ((p1 (copy-sequence (cddr m1)))
3616 (p2 (copy-sequence (cddr m2)))
3617 e1 e2)
3618 (block nil
3619 (while (setq e1 (pop p1))
3620 (unless (setq e2 (assq (car e1) p2))
3621 ;; The parameter doesn't exist in p2.
3622 (return nil))
3623 (setq p2 (delq e2 p2))
3624 (unless (equal e1 e2)
3625 (if (not (and (stringp (cadr e1))
3626 (stringp (cadr e2))))
3627 (return nil)
3628 ;; Special-case string parameter comparison so that we
3629 ;; can uniquify them.
3630 (let ((s1 (cadr e1))
3631 (s2 (cadr e2)))
3632 (when (string-match "/$" s1)
3633 (setq s1 (directory-file-name s1)))
3634 (when (string-match "/$" s2)
3635 (setq s2 (directory-file-name s2)))
3636 (unless (equal s1 s2)
3637 (return nil))))))
3638 ;; If p2 now is empty, they were equal.
3639 (null p2))))
3641 (defun gnus-server-equal (m1 m2)
3642 "Say whether two methods are equal."
3643 (let ((m1 (cond ((null m1) gnus-select-method)
3644 ((stringp m1) (gnus-server-to-method m1))
3645 (t m1)))
3646 (m2 (cond ((null m2) gnus-select-method)
3647 ((stringp m2) (gnus-server-to-method m2))
3648 (t m2))))
3649 (gnus-method-equal m1 m2)))
3651 (defun gnus-servers-using-backend (backend)
3652 "Return a list of known servers using BACKEND."
3653 (let ((opened gnus-opened-servers)
3654 out)
3655 (while opened
3656 (when (eq backend (caaar opened))
3657 (push (caar opened) out))
3658 (pop opened))
3659 out))
3661 (defun gnus-archive-server-wanted-p ()
3662 "Say whether the user wants to use the archive server."
3663 (cond
3664 ((or (not gnus-message-archive-method)
3665 (not gnus-message-archive-group))
3666 nil)
3667 ((and gnus-message-archive-method gnus-message-archive-group)
3668 t)
3669 (t
3670 (let ((active (cadr (assq 'nnfolder-active-file
3671 gnus-message-archive-method))))
3672 (and active
3673 (file-exists-p active))))))
3675 (defsubst gnus-method-to-server-name (method)
3676 (concat
3677 (format "%s" (car method))
3678 (when (and
3679 (or (assoc (format "%s" (car method))
3680 (gnus-methods-using 'address))
3681 (gnus-server-equal method gnus-message-archive-method))
3682 (nth 1 method)
3683 (not (string= (nth 1 method) "")))
3684 (concat "+" (nth 1 method)))))
3686 (defsubst gnus-method-to-full-server-name (method)
3687 (format "%s+%s" (car method) (nth 1 method)))
3689 (defun gnus-group-prefixed-name (group method &optional full)
3690 "Return the whole name from GROUP and METHOD.
3691 Call with full set to get the fully qualified group name (even if the
3692 server is native)."
3693 (when (stringp method)
3694 (setq method (gnus-server-to-method method)))
3695 (if (or (not method)
3696 (and (not full) (gnus-server-equal method "native"))
3697 ;;;!!! This might not be right. We'll see...
3698 ;(string-match ":" group)
3699 )
3700 group
3701 (concat (gnus-method-to-server-name method) ":" group)))
3703 (defun gnus-group-guess-prefixed-name (group)
3704 "Guess the whole name from GROUP and METHOD."
3705 (gnus-group-prefixed-name group (gnus-find-method-for-group
3706 group)))
3708 (defun gnus-group-full-name (group method)
3709 "Return the full name from GROUP and METHOD, even if the method is native."
3710 (gnus-group-prefixed-name group method t))
3712 (defun gnus-group-guess-full-name (group)
3713 "Guess the full name from GROUP, even if the method is native."
3714 (if (gnus-group-prefixed-p group)
3715 group
3716 (gnus-group-full-name group (gnus-find-method-for-group group))))
3718 (defun gnus-group-guess-full-name-from-command-method (group)
3719 "Guess the full name from GROUP, even if the method is native."
3720 (if (gnus-group-prefixed-p group)
3721 group
3722 (gnus-group-full-name group gnus-command-method)))
3724 (defun gnus-group-real-prefix (group)
3725 "Return the prefix of the current group name."
3726 (if (stringp group)
3727 (if (string-match "^[^:]+:" group)
3728 (substring group 0 (match-end 0))
3729 "")
3730 nil))
3732 (defun gnus-group-short-name (group)
3733 "Return the short group name."
3734 (let ((prefix (gnus-group-real-prefix group)))
3735 (if (< 0 (length prefix))
3736 (substring group (length prefix) nil)
3737 group)))
3739 (defun gnus-group-prefixed-p (group)
3740 "Return the prefix of the current group name."
3741 (< 0 (length (gnus-group-real-prefix group))))
3743 (declare-function gnus-group-decoded-name "gnus-group" (string))
3745 (defun gnus-summary-buffer-name (group)
3746 "Return the summary buffer name of GROUP."
3747 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3749 (defun gnus-group-method (group)
3750 "Return the server or method used for selecting GROUP.
3751 You should probably use `gnus-find-method-for-group' instead."
3752 (let ((prefix (gnus-group-real-prefix group)))
3753 (if (equal prefix "")
3754 gnus-select-method
3755 (let ((servers gnus-opened-servers)
3756 (server "")
3757 backend possible found)
3759 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3760 server (substring prefix (match-end 0) (1- (length prefix))))
3761 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3762 (while servers
3763 (when (eq (caaar servers) backend)
3764 (setq possible (caar servers))
3765 (when (equal (cadaar servers) server)
3766 (setq found (caar servers))))
3767 (pop servers))
3768 (or (car (rassoc found gnus-server-alist))
3769 found
3770 (car (rassoc possible gnus-server-alist))
3771 possible
3772 (list backend server))))))
3774 (defsubst gnus-native-method-p (method)
3775 "Return whether METHOD is the native select method."
3776 (gnus-method-equal method gnus-select-method))
3778 (defsubst gnus-secondary-method-p (method)
3779 "Return whether METHOD is a secondary select method."
3780 (let ((methods gnus-secondary-select-methods)
3781 (gmethod (inline (gnus-server-get-method nil method))))
3782 (while (and methods
3783 (not (gnus-method-equal
3784 (inline (gnus-server-get-method nil (car methods)))
3785 gmethod)))
3786 (setq methods (cdr methods)))
3787 methods))
3789 (defun gnus-method-simplify (method)
3790 "Return the shortest uniquely identifying string or method for METHOD."
3791 (cond ((stringp method)
3792 method)
3793 ((gnus-native-method-p method)
3794 nil)
3795 ((gnus-secondary-method-p method)
3796 (format "%s:%s" (nth 0 method) (nth 1 method)))
3797 (t
3798 method)))
3800 (defun gnus-groups-from-server (server)
3801 "Return a list of all groups that are fetched from SERVER."
3802 (let ((alist (cdr gnus-newsrc-alist))
3803 info groups)
3804 (while (setq info (pop alist))
3805 (when (gnus-server-equal (gnus-info-method info) server)
3806 (push (gnus-info-group info) groups)))
3807 (sort groups 'string<)))
3809 (defun gnus-group-foreign-p (group)
3810 "Say whether a group is foreign or not."
3811 (and (not (gnus-group-native-p group))
3812 (not (gnus-group-secondary-p group))))
3814 (defun gnus-group-native-p (group)
3815 "Say whether the group is native or not."
3816 (not (string-match ":" group)))
3818 (defun gnus-group-secondary-p (group)
3819 "Say whether the group is secondary or not."
3820 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3822 (defun gnus-parameters-get-parameter (group)
3823 "Return the group parameters for GROUP from `gnus-parameters'."
3824 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3825 case-fold-search
3826 gnus-parameters-case-fold-search))
3827 params-list)
3828 (dolist (elem gnus-parameters)
3829 (when (string-match (car elem) group)
3830 (setq params-list
3831 (nconc (gnus-expand-group-parameters
3832 (car elem) (cdr elem) group)
3833 params-list))))
3834 params-list))
3836 (defun gnus-expand-group-parameter (match value group)
3837 "Use MATCH to expand VALUE in GROUP."
3838 (with-temp-buffer
3839 (insert group)
3840 (goto-char (point-min))
3841 (while (re-search-forward match nil t)
3842 (replace-match value))
3843 (buffer-string)))
3845 (defun gnus-expand-group-parameters (match parameters group)
3846 "Go through PARAMETERS and expand them according to the match data."
3847 (let (new)
3848 (dolist (elem parameters)
3849 (if (and (stringp (cdr elem))
3851 (push (cons (car elem)
3852 (gnus-expand-group-parameter match (cdr elem) group))
3853 new)
3854 (push elem new)))
3855 new))
3857 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3858 "For GROUP, return the value of SYMBOL.
3860 You should call this in the `gnus-group-buffer' buffer.
3861 The function `gnus-group-find-parameter' will do that for you."
3862 ;; The speed trick: No cons'ing and quit early.
3863 (let* ((params (funcall gnus-group-get-parameter-function group))
3864 ;; Start easy, check the "real" group parameters.
3865 (simple-results
3866 (gnus-group-parameter-value params symbol allow-list t)))
3867 (if simple-results
3868 ;; Found results; return them.
3869 (car simple-results)
3870 ;; We didn't find it there, try `gnus-parameters'.
3871 (let ((result nil)
3872 (head nil)
3873 (tail gnus-parameters))
3874 ;; A good old-fashioned non-cl loop.
3875 (while tail
3876 (setq head (car tail)
3877 tail (cdr tail))
3878 ;; The car is regexp matching for matching the group name.
3879 (when (string-match (car head) group)
3880 ;; The cdr is the parameters.
3881 (setq result (gnus-group-parameter-value (cdr head)
3882 symbol allow-list))
3883 (when result
3884 ;; Expand if necessary.
3886 (setq result (gnus-expand-group-parameter (car head)
3887 result group)))
3888 ;; Exit the loop early.
3889 (setq tail nil))))
3890 ;; Done.
3891 result))))
3893 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3894 "Return the group parameters for GROUP.
3895 If SYMBOL, return the value of that symbol in the group parameters.
3897 If you call this function inside a loop, consider using the faster
3898 `gnus-group-fast-parameter' instead."
3899 (with-current-buffer gnus-group-buffer
3900 (if symbol
3901 (gnus-group-fast-parameter group symbol allow-list)
3902 (nconc
3903 (copy-sequence
3904 (funcall gnus-group-get-parameter-function group))
3905 (gnus-parameters-get-parameter group)))))
3907 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3908 "Return the group parameters for GROUP.
3909 If SYMBOL, return the value of that symbol in the group parameters.
3910 If ALLOW-LIST, also allow list as a result.
3911 Most functions should use `gnus-group-find-parameter', which
3912 also examines the topic parameters."
3913 (let ((params (gnus-info-params (gnus-get-info group))))
3914 (if symbol
3915 (gnus-group-parameter-value params symbol allow-list)
3916 params)))
3918 (defun gnus-group-parameter-value (params symbol &optional
3919 allow-list present-p)
3920 "Return the value of SYMBOL in group PARAMS.
3921 If ALLOW-LIST, also allow list as a result."
3922 ;; We only wish to return group parameters (dotted lists) and
3923 ;; not local variables, which may have the same names.
3924 ;; But first we handle single elements...
3925 (or (car (memq symbol params))
3926 ;; Handle alist.
3927 (let (elem)
3928 (catch 'found
3929 (while (setq elem (pop params))
3930 (when (and (consp elem)
3931 (eq (car elem) symbol)
3932 (or allow-list
3933 (atom (cdr elem))))
3934 (throw 'found (if present-p (list (cdr elem))
3935 (cdr elem)))))))))
3937 (defun gnus-group-add-parameter (group param)
3938 "Add parameter PARAM to GROUP."
3939 (let ((info (gnus-get-info group)))
3940 (when info
3941 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3942 ;; Cons the new param to the old one and update.
3943 (gnus-group-set-info (cons param (gnus-info-params info))
3944 group 'params))))
3946 (defun gnus-group-set-parameter (group name value)
3947 "Set parameter NAME to VALUE in GROUP."
3948 (let ((info (gnus-get-info group)))
3949 (when info
3950 (gnus-group-remove-parameter group name)
3951 (let ((old-params (gnus-info-params info))
3952 (new-params (list (cons name value))))
3953 (while old-params
3954 (when (or (not (listp (car old-params)))
3955 (not (eq (caar old-params) name)))
3956 (setq new-params (append new-params (list (car old-params)))))
3957 (setq old-params (cdr old-params)))
3958 (gnus-group-set-info new-params group 'params)))))
3960 (defun gnus-group-remove-parameter (group name)
3961 "Remove parameter NAME from GROUP."
3962 (let ((info (gnus-get-info group)))
3963 (when info
3964 (let ((params (gnus-info-params info)))
3965 (when params
3966 (setq params (delq name params))
3967 (while (assq name params)
3968 (gnus-pull name params))
3969 (gnus-info-set-params info params))))))
3971 (defun gnus-group-add-score (group &optional score)
3972 "Add SCORE to the GROUP score.
3973 If SCORE is nil, add 1 to the score of GROUP."
3974 (let ((info (gnus-get-info group)))
3975 (when info
3976 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3978 (defun gnus-short-group-name (group &optional levels)
3979 "Collapse GROUP name LEVELS.
3980 Select methods are stripped and any remote host name is stripped down to
3981 just the host name."
3982 (let* ((name "")
3983 (foreign "")
3984 (depth 0)
3985 (skip 1)
3986 (levels (or levels
3987 gnus-group-uncollapsed-levels
3988 (progn
3990 (setq skip (match-end 0)
3991 depth (+ depth 1)))
3992 depth))))
3993 ;; Separate foreign select method from group name and collapse.
3994 ;; If method contains a server, collapse to non-domain server name,
3995 ;; otherwise collapse to select method.
3996 (let* ((colon (string-match ":" group))
3997 (server (and colon (substring group 0 colon)))
3998 (plus (and server (string-match "+" server))))
3999 (when server
4000 (if plus
4001 (setq foreign (substring server (+ 1 plus)
4003 group (substring group (+ 1 colon)))
4004 (setq foreign server
4005 group (substring group (+ 1 colon))))
4006 (setq foreign (concat foreign ":")))
4007 ;; Collapse group name leaving LEVELS uncollapsed elements
4008 (let* ((slist (split-string group "/"))
4009 (slen (length slist))
4011 (dlen (length dlist))
4012 glist
4013 glen
4014 gsep
4015 res)
4016 (if (> slen dlen)
4017 (setq glist slist
4018 glen slen
4019 gsep "/")
4020 (setq glist dlist
4021 glen dlen
4022 gsep "."))
4023 (setq levels (- glen levels))
4024 (dolist (g glist)
4025 (push (if (>= (decf levels) 0)
4026 (if (zerop (length g))
4027 ""
4028 (substring g 0 1))
4029 g)
4030 res))
4031 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4033 (defun gnus-narrow-to-body ()
4034 "Narrow to the body of an article."
4035 (narrow-to-region
4036 (progn
4037 (goto-char (point-min))
4039 (point-max)))
4040 (point-max)))
4042 \f
4043 ;;;
4044 ;;; Kill file handling.
4045 ;;;
4047 (defun gnus-apply-kill-file ()
4048 "Apply a kill file to the current newsgroup.
4049 Returns the number of articles marked as read."
4050 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4051 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4052 (gnus-apply-kill-file-internal)
4053 0))
4055 (defun gnus-kill-save-kill-buffer ()
4056 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4057 (when (get-file-buffer file)
4058 (with-current-buffer (get-file-buffer file)
4059 (when (buffer-modified-p)
4060 (save-buffer))
4061 (kill-buffer (current-buffer))))))
4063 (defcustom gnus-kill-file-name "KILL"
4064 "Suffix of the kill files."
4065 :group 'gnus-score-kill
4066 :group 'gnus-score-files
4067 :type 'string)
4069 (defun gnus-newsgroup-kill-file (newsgroup)
4070 "Return the name of a kill file name for NEWSGROUP.
4071 If NEWSGROUP is nil, return the global kill file name instead."
4072 (cond
4073 ;; The global KILL file is placed at top of the directory.
4074 ((or (null newsgroup)
4075 (string-equal newsgroup ""))
4076 (expand-file-name gnus-kill-file-name
4077 gnus-kill-files-directory))
4078 ;; Append ".KILL" to newsgroup name.
4079 ((gnus-use-long-file-name 'not-kill)
4080 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4081 "." gnus-kill-file-name)
4082 gnus-kill-files-directory))
4083 ;; Place "KILL" under the hierarchical directory.
4084 (t
4085 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4086 "/" gnus-kill-file-name)
4087 gnus-kill-files-directory))))
4089 ;;; Server things.
4091 (defun gnus-member-of-valid (symbol group)
4093 (memq symbol (assoc
4094 (symbol-name (car (gnus-find-method-for-group group)))
4095 gnus-valid-select-methods)))
4097 (defun gnus-method-option-p (method option)
4098 "Return non-nil if select METHOD has OPTION as a parameter."
4099 (when (stringp method)
4100 (setq method (gnus-server-to-method method)))
4101 (memq option (assoc (format "%s" (car method))
4102 gnus-valid-select-methods)))
4104 (defun gnus-similar-server-opened (method)
4105 "Return non-nil if we have a similar server opened.
4106 This is defined as a server with the same name, but different
4107 parameters."
4108 (let ((opened gnus-opened-servers)
4109 open)
4110 (while (and method opened)
4111 (setq open (car (pop opened)))
4112 ;; Type and name are the same...
4113 (when (and (equal (car method) (car open))
4114 (equal (cadr method) (cadr open))
4115 ;; ... but the rest of the parameters differ.
4116 (not (gnus-methods-sloppily-equal method open)))
4117 (setq method nil)))
4118 (not method)))
4120 (defun gnus-server-extend-method (group method)
4121 ;; This function "extends" a virtual server. If the server is
4122 ;; "hello", and the select method is ("hello" (my-var "something"))
4123 ;; in the group "alt.alt", this will result in a new virtual server
4124 ;; called "hello+alt.alt".
4125 (if (or (not (inline (gnus-similar-server-opened method)))
4126 (not (cddr method)))
4127 method
4128 (setq method
4129 `(,(car method) ,(concat (cadr method) "+" group)
4130 (,(intern (format "%s-address" (car method))) ,(cadr method))
4131 ,@(cddr method)))
4132 (push method gnus-extended-servers)
4133 method))
4135 (defun gnus-server-status (method)
4136 "Return the status of METHOD."
4137 (nth 1 (assoc method gnus-opened-servers)))
4139 (defun gnus-group-name-to-method (group)
4140 "Guess a select method based on GROUP."
4141 (if (string-match ":" group)
4142 (let ((server (substring group 0 (match-beginning 0))))
4144 (list (intern (substring server 0 (match-beginning 0)))
4145 (substring server (match-end 0)))
4146 (list (intern server) "")))
4147 gnus-select-method))
4149 (defun gnus-server-string (server)
4150 "Return a readable string that describes SERVER."
4151 (let* ((server (gnus-server-to-method server))
4152 (address (nth 1 server)))
4153 (if (and address
4154 (not (zerop (length address))))
4155 (format "%s using %s" address (car server))
4156 (format "%s" (car server)))))
4158 (defun gnus-same-method-different-name (method)
4159 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4160 (unless (assq slot (cddr method))
4161 (setq method
4162 (append method (list (list slot (nth 1 method)))))))
4163 (let ((methods gnus-extended-servers)
4164 open found)
4165 (while (and (not found)
4166 (setq open (pop methods)))
4167 (when (and (eq (car method) (car open))
4168 (gnus-sloppily-equal-method-parameters method open))
4169 (setq found open)))
4170 found))
4172 (defun gnus-find-method-for-group (group &optional info)
4173 "Find the select method that GROUP uses."
4174 (or gnus-override-method
4175 (and (not group)
4176 gnus-select-method)
4177 (and (not (gnus-group-entry group))
4178 ;; Killed or otherwise unknown group.
4179 (or
4180 ;; If we know a virtual server by that name, return its method.
4181 (gnus-server-to-method (gnus-group-server group))
4182 ;; Guess a new method as last resort.
4183 (gnus-group-name-to-method group)))
4184 (let ((info (or info (gnus-get-info group)))
4185 method)
4186 (if (or (not info)
4187 (not (setq method (gnus-info-method info)))
4188 (equal method "native"))
4189 gnus-select-method
4190 (setq method
4191 (cond ((stringp method)
4192 (inline (gnus-server-to-method method)))
4193 ((stringp (cadr method))
4194 (or
4195 (inline
4196 (gnus-same-method-different-name method))
4197 (inline (gnus-server-extend-method group method))))
4198 (t
4199 method)))
4200 (cond ((equal (cadr method) "")
4201 method)
4202 ((null (cadr method))
4203 (list (car method) ""))
4204 (t
4205 (gnus-server-add-address method)))))))
4207 (defun gnus-methods-using (feature)
4208 "Find all methods that have FEATURE."
4209 (let ((valids gnus-valid-select-methods)
4210 outs)
4211 (while valids
4212 (when (memq feature (car valids))
4213 (push (car valids) outs))
4214 (setq valids (cdr valids)))
4215 outs))
4217 (eval-and-compile
4218 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4220 (defun gnus-read-group (prompt &optional default)
4221 "Prompt the user for a group name.
4222 Disallow invalid group names."
4223 (let ((prefix "")
4224 group)
4225 (while (not group)
4226 (when (string-match
4227 gnus-invalid-group-regexp
4228 (setq group (read-string (concat prefix prompt)
4229 (cons (or default "") 0)
4230 'gnus-group-history)))
4231 (let ((match (match-string 0 group)))
4232 ;; Might be okay (e.g. for nnimap), so ask the user:
4234 (message-y-or-n-p
4235 "Proceed and create group anyway? " t
4238 Usually, it's dangerous to create a group with this name, because it's not
4239 supported by all back ends and servers. On IMAP servers it should work,
4240 though. If you are really sure, you can proceed anyway and create the group.
4242 You may customize the variable `gnus-invalid-group-regexp', which currently is
4246 group nil)))))
4247 group))
4249 (defun gnus-read-method (prompt)
4250 "Prompt the user for a method.
4251 Allow completion over sensible values."
4252 (let* ((open-servers
4253 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4254 gnus-opened-servers))
4255 (valid-methods
4256 (let (methods)
4257 (dolist (method gnus-valid-select-methods)
4258 (if (or (memq 'prompt-address method)
4259 (not (assoc (format "%s:" (car method)) open-servers)))
4260 (push method methods)))
4261 methods))
4262 (servers
4263 (append valid-methods
4264 open-servers
4265 gnus-predefined-server-alist
4266 gnus-server-alist))
4267 (method
4268 (completing-read
4269 prompt servers
4270 nil t nil 'gnus-method-history)))
4271 (cond
4272 ((equal method "")
4273 (setq method gnus-select-method))
4274 ((assoc method gnus-valid-select-methods)
4275 (let ((address (if (memq 'prompt-address
4276 (assoc method gnus-valid-select-methods))
4277 (read-string "Address: ")
4278 "")))
4279 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4280 (list (intern method) address))))
4281 ((assoc method servers)
4282 method)
4283 (t
4284 (list (intern method) "")))))
4286 ;;; Agent functions
4288 (defun gnus-agent-method-p (method-or-server)
4289 "Say whether METHOD is covered by the agent."
4290 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4291 (let* ((method (if (stringp method-or-server)
4292 (gnus-server-to-method method-or-server)
4293 method-or-server))
4294 (server (gnus-method-to-server method t)))
4295 (setq gnus-agent-method-p-cache
4296 (cons method-or-server
4297 (member server gnus-agent-covered-methods)))))
4298 (cdr gnus-agent-method-p-cache))
4300 (defun gnus-online (method)
4301 (not
4302 (if gnus-plugged
4303 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4304 (gnus-agent-method-p method))))
4306 ;;; User-level commands.
4308 ;;;###autoload
4309 (defun gnus-slave-no-server (&optional arg)
4310 "Read network news as a slave, without connecting to the local server."
4311 (interactive "P")
4312 (gnus-no-server arg t))
4314 ;;;###autoload
4315 (defun gnus-no-server (&optional arg slave)
4316 "Read network news.
4317 If ARG is a positive number, Gnus will use that as the startup
4318 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4319 non-nil and not a positive number, Gnus will prompt the user for the
4320 name of an NNTP server to use.
4321 As opposed to `gnus', this command will not connect to the local
4322 server."
4323 (interactive "P")
4324 (gnus-no-server-1 arg slave))
4326 ;;;###autoload
4327 (defun gnus-slave (&optional arg)
4328 "Read news as a slave."
4329 (interactive "P")
4330 (gnus arg nil 'slave))
4332 ;;;###autoload
4333 (defun gnus-other-frame (&optional arg display)
4334 "Pop up a frame to read news.
4335 This will call one of the Gnus commands which is specified by the user
4336 option `gnus-other-frame-function' (default `gnus') with the argument
4337 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4338 optional second argument DISPLAY should be a standard display string
4340 omitted or the function `make-frame-on-display' is not available, the
4341 current display is used."
4342 (interactive "P")
4343 (if (fboundp 'make-frame-on-display)
4344 (unless display
4345 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4346 (setq display nil))
4347 (let ((alive (gnus-alive-p)))
4348 (unless (and alive
4349 (catch 'found
4350 (walk-windows
4351 (lambda (window)
4352 (when (and (or (not display)
4353 (equal display
4354 (gnus-frame-or-window-display-name
4355 window)))
4356 (with-current-buffer (window-buffer window)
4358 (symbol-name major-mode))))
4359 (gnus-select-frame-set-input-focus
4360 (setq gnus-other-frame-object (window-frame window)))
4361 (select-window window)
4362 (throw 'found t)))
4363 'ignore t)))
4364 (gnus-select-frame-set-input-focus
4365 (setq gnus-other-frame-object
4366 (if display
4367 (make-frame-on-display display gnus-other-frame-parameters)
4368 (make-frame gnus-other-frame-parameters))))
4369 (if alive
4370 (switch-to-buffer gnus-group-buffer)
4371 (funcall gnus-other-frame-function arg)
4372 (add-hook 'gnus-exit-gnus-hook
4373 '(lambda nil
4374 (when (and (frame-live-p gnus-other-frame-object)
4375 (cdr (frame-list)))
4376 (delete-frame gnus-other-frame-object))
4377 (setq gnus-other-frame-object nil)))))))
4379 ;;;###autoload
4380 (defun gnus (&optional arg dont-connect slave)
4381 "Read network news.
4382 If ARG is non-nil and a positive number, Gnus will use that as the
4383 startup level. If ARG is non-nil and not a positive number, Gnus will
4384 prompt the user for the name of an NNTP server to use."
4385 (interactive "P")
4386 ;; When using the development version of Gnus, load the gnus-load
4387 ;; file.
4388 (unless (string-match "^Gnus" gnus-version)
4389 (load "gnus-load"))
4390 (unless (byte-code-function-p (symbol-function 'gnus))
4391 (message "You should byte-compile Gnus")
4392 (sit-for 2))
4393 (gnus-1 arg dont-connect slave))
4395 ;; Allow redefinition of Gnus functions.
4397 (gnus-ems-redefine)
4399 (provide 'gnus)
4401 ;;; gnus.el ends here