| blob | cd9b6eeb9496bd29f8f07d03786ce75d04779079 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
9 ;; Version: 5.13
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;;; Code:
32 ;; For Emacs <22.2 and XEmacs.
41 ;; These are defined afterwards with gnus-define-group-parameter
55 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
60 "Starting your favorite newsreader."
64 "Dealing with formatting issues."
68 "Group character set issues."
74 "Cache interface."
79 "Article Registry."
83 "Server options at startup."
86 ;; These belong to gnus-group.el.
88 "Group buffers."
93 "Foreign groups."
98 "Automatic subscription of new groups."
102 "Group levels."
107 "Selecting a Group."
112 "Showing slices of the group list."
117 "Sorting the group buffer."
123 "Various group options."
127 ;; These belong to gnus-sum.el.
129 "Summary buffers."
134 "Leaving summary buffers."
139 "Marks used in summary buffers."
144 "Ordering articles according to replies."
149 "Formatting of the summary buffer."
154 "Choosing Articles."
159 "Summary movement commands."
164 "Show pictures of people, domains, and newsgroups."
168 "Mail group commands."
173 "Sorting the summary buffer."
178 "Highlighting and menus in the summary buffer."
184 "Various summary buffer options."
189 "Pick mode in the summary buffer."
195 "Tree display of threads in the summary buffer."
200 ;; Belongs to gnus-uu.el
202 "Viewing extracted files."
206 ;; Belongs to gnus-score.el
208 "Score and kill file handling."
212 "Kill files."
216 "Adaptive score files."
220 "Default values for score files."
224 "Expiring score rules."
228 "Decaying score rules."
232 "Score and kill file names."
237 "Various scoring and killing options."
240 ;; Other
242 "Options controlling the visual fluff."
247 "Offline support for Gnus."
251 "Files used by Gnus."
255 "Auto save file."
260 "Storing Gnus state."
264 "Options related to newsservers and other servers used by Gnus."
268 "Highlighting and menus in the server buffer."
273 "Composing replies and followups in Gnus."
277 "Meta variables controlling major portions of Gnus.
278 In general, modifying these variables does not take effect until Gnus
279 is restarted, and sometimes reloaded."
283 "Other Gnus options."
288 "Exiting Gnus."
293 "Frivolous Gnus extensions."
304 "If non-nil, the startup message will not be displayed.
305 This variable is used before `.gnus.el' is loaded, so it should
306 be set in `.emacs' instead."
335 0 5
344 gnus-mode-line-image-cache)
346 "This is %s, %s."
348 str)
350 line)))
355 ;;(defalias 'gnus-decode-rfc1522 'ignore)
356 )
358 ;; We define these group faces here to avoid the display
359 ;; update forced when creating new faces.
369 ()))
370 "Level 1 newsgroup face."
372 ;; backward-compatibility alias
384 ()))
385 "Level 1 empty newsgroup face."
387 ;; backward-compatibility alias
399 ()))
400 "Level 2 newsgroup face."
402 ;; backward-compatibility alias
414 ()))
415 "Level 2 empty newsgroup face."
417 ;; backward-compatibility alias
429 ()))
430 "Level 3 newsgroup face."
432 ;; backward-compatibility alias
439 ())
442 ())
444 ()))
445 "Level 3 empty newsgroup face."
447 ;; backward-compatibility alias
459 ()))
460 "Level 4 newsgroup face."
462 ;; backward-compatibility alias
469 ())
472 ())
474 ()))
475 "Level 4 empty newsgroup face."
477 ;; backward-compatibility alias
489 ()))
490 "Level 5 newsgroup face."
492 ;; backward-compatibility alias
499 ())
502 ())
504 ()))
505 "Level 5 empty newsgroup face."
507 ;; backward-compatibility alias
519 ()))
520 "Level 6 newsgroup face."
522 ;; backward-compatibility alias
529 ())
532 ())
534 ()))
535 "Level 6 empty newsgroup face."
537 ;; backward-compatibility alias
549 ()))
550 "Low level newsgroup face."
552 ;; backward-compatibility alias
564 ()))
565 "Low level empty newsgroup face."
567 ;; backward-compatibility alias
580 "Level 1 mailgroup face."
582 ;; backward-compatibility alias
595 "Level 1 empty mailgroup face."
597 ;; backward-compatibility alias
610 "Level 2 mailgroup face."
612 ;; backward-compatibility alias
625 "Level 2 empty mailgroup face."
627 ;; backward-compatibility alias
640 "Level 3 mailgroup face."
642 ;; backward-compatibility alias
654 ()))
655 "Level 3 empty mailgroup face."
657 ;; backward-compatibility alias
670 "Low level mailgroup face."
672 ;; backward-compatibility alias
685 "Low level empty mailgroup face."
687 ;; backward-compatibility alias
691 ;; Summary mode faces.
694 "Face used for selected articles."
696 ;; backward-compatibility alias
703 "Face used for cancelled articles."
705 ;; backward-compatibility alias
718 "Face used for high interest ticked articles."
720 ;; backward-compatibility alias
733 "Face used for low interest ticked articles."
735 ;; backward-compatibility alias
747 ()))
748 "Face used for normal interest ticked articles."
750 ;; backward-compatibility alias
763 "Face used for high interest ancient articles."
765 ;; backward-compatibility alias
778 "Face used for low interest ancient articles."
780 ;; backward-compatibility alias
792 ()))
793 "Face used for normal interest ancient articles."
795 ;; backward-compatibility alias
806 "Face used for high interest uncached articles."
808 ;; backward-compatibility alias
819 "Face used for low interest uncached articles."
821 ;; backward-compatibility alias
832 "Face used for normal interest uncached articles."
834 ;; backward-compatibility alias
841 "Face used for high interest unread articles."
843 ;; backward-compatibility alias
850 "Face used for low interest unread articles."
852 ;; backward-compatibility alias
858 ()))
859 "Face used for normal interest unread articles."
861 ;; backward-compatibility alias
876 "Face used for high interest read articles."
878 ;; backward-compatibility alias
893 "Face used for low interest read articles."
895 ;; backward-compatibility alias
907 ()))
908 "Face used for normal interest read articles."
910 ;; backward-compatibility alias
915 ;;;
916 ;;; Gnus buffers
917 ;;;
923 "Do the same as `get-buffer-create', but store the created buffer."
928 "Add the current buffer to the list of Gnus buffers."
932 "Kill BUFFER and remove from the list of Gnus buffers."
939 "Return a list of live Gnus buffers."
948 gnus-buffers)
950 ;;; Splash screen.
963 ()))
964 "Face for the splash screen."
966 ;; backward-compatibility alias
980 "Indent rigidly using only spaces and no tabs."
986 ;; We translate tabs into spaces -- not everybody uses
987 ;; an 8-character tab.
992 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1016 "*Color styles used for the Gnus logo."
1018 gnus-logo-color-alist))
1028 "Insert startup message in current buffer."
1029 ;; Insert the message.
1034 ;; Make sure the library defining `image-load-path' is
1035 ;; loaded (`find-image' is autoloaded) (and discard the
1036 ;; result). Else, we may get "defvar ignored because
1037 ;; image-load-path is let-bound" when calling `find-image'
1038 ;; below.
1048 :color-symbols
1052 :color-symbols
1057 ;; Account for the pbm's background.
1061 ;; Account for the xbm's background.
1072 t)))
1075 _ ___ _ _
1076 _ ___ __ ___ __ _ ___
1077 __ _ ___ __ ___
1078 _ ___ _
1079 _ _ __ _
1080 ___ __ _
1081 __ _
1082 _ _ _
1083 _ _ _
1084 _ _ _
1085 __ ___
1086 _ _ _ _
1087 _ _
1088 _ _
1089 _ _
1090 _
1091 __
1094 ;; And then hack it.
1103 ;; Fontify some.
1110 "Do color-symbol search-and-replace in svg file."
1121 color-symbols)
1123 list)))
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'.
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"))
1305 gnus-default-nntp-server)
1307 "Default method for selecting a newsgroup.
1308 This variable should be a list, where the first element is how the
1309 news is to be fetched, the second is the address.
1312 NNTP, you could say:
1316 If you want to use your local spool, say:
1318 \(setq gnus-select-method (list 'nnspool (system-name)))
1320 If you use this variable, you must set `gnus-nntp-server' to nil.
1322 There is a lot more to know about select methods and virtual servers -
1323 see the manual for details."
1330 "*Method used for archiving messages you've sent.
1331 This should be a mail method.
1333 See also `gnus-update-message-archive-method'."
1337 gnus-select-method))
1342 The archive method is initially set according to the value of
1344 so that it may be used as a real method of the server which is named
1346 updated if the value of this variable is nil, even if you change the
1347 value of `gnus-message-archive-method' afterward. If you want the
1349 `gnus-message-archive-method', set this variable to a non-nil value."
1356 "*Name of the group in which to save the messages you've written.
1357 This can either be a string; a list of strings; or an alist
1358 of regexps/functions/forms to be evaluated to return a string (or a list
1359 of strings). The functions are called with the name of the current
1360 group (or nil) as a parameter.
1362 If you want to save your mail in one group and the news articles you
1363 write in another group, you could say something like:
1365 \(setq gnus-message-archive-group
1366 '((if (message-news-p)
1370 Normally the group names returned by this variable should be
1372 However, you may wish to store the message on some other server. In
1373 that case, just return a fully prefixed name of the group --
1381 function
1382 sexp
1383 string))
1386 "List of NNTP servers that the user can choose between interactively.
1387 To make Gnus query you for a server, you have to give `gnus' a
1388 non-numeric prefix - `C-u M-x gnus', in short."
1394 "The name of the host running the NNTP server."
1397 string))
1401 "A list of secondary methods that will be used for reading news.
1402 This is a list where each element is a complete select method (see
1403 `gnus-select-method').
1405 If, for instance, you want to read your mail with the nnml back end,
1406 you could set this variable:
1413 "Local domain name without a host name.
1414 The DOMAINNAME environment variable is used instead if it is defined.
1415 If the function `system-name' returns the full Internet name, there is
1416 no need to set this variable."
1419 string))
1422 ;; Customization variables
1425 "Preferred method for fetching an article by Message-ID.
1426 The value of this variable must be a valid select method as discussed
1427 in the documentation of `gnus-select-method'.
1429 It can also be a list of select methods, as well as the special symbol
1430 `current', which means to use the current select method. If it is a
1431 list, Gnus will try all the methods in the list until it finds a match."
1437 gnus-select-method
1438 sexp
1446 gnus-select-method))))
1449 "*Non-nil means that cross referenced articles will be marked as read.
1450 If nil, ignore cross references. If t, mark articles as read in
1451 subscribed newsgroups. If neither t nor nil, mark as read in all
1452 newsgroups."
1460 "*Process mark."
1466 "*The number of articles which indicates a large newsgroup.
1467 If the number of articles in a newsgroup is greater than this value,
1468 confirmation is required for selecting the newsgroup.
1469 If it is nil, no confirmation is required.
1471 Also see `gnus-large-ephemeral-newsgroup'."
1474 integer))
1477 "Non-nil means that the default name of a file to save articles in is the group name.
1478 If it's nil, the directory form of the group name is used instead.
1480 If this variable is a list, and the list contains the element
1481 `not-score', long file names will not be used for score files; if it
1482 contains the element `not-save', long file names will not be used for
1483 saving; and if it contains the element `not-kill', long file names
1484 will not be used for kill files.
1486 Note that the default for this variable varies according to what system
1487 type you're using. On `usg-unix-v' this variable defaults to nil while
1488 on all other systems it defaults to t."
1506 "*If non-nil, save group scoring info."
1512 "*If non-nil, allow undoing in Gnus group mode buffers."
1517 "*If non-nil, use some adaptive scoring scheme.
1518 If a list, then the values `word' and `line' are meaningful. The
1519 former will perform adaption on individual words in the subject
1520 header while `line' will perform adaption on several headers."
1526 "*If nil, Gnus will ignore the article cache.
1527 If `passive', it will allow entering (and reading) articles
1528 explicitly entered into the cache. If anything else, use the
1529 cache to the full extent of the law."
1537 "*If non-nil, display a thread tree buffer."
1542 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1543 If it is a number N, then Gnus will only keep the last N articles
1544 read. If it is neither nil nor a number, Gnus will keep all read
1545 articles. This is not a good idea."
1548 integer
1553 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1558 "*If non-nil, enable scoring."
1564 "*A hook called when preparing to exit from the summary buffer.
1565 It calls `gnus-summary-expire-articles' by default."
1570 "*Non-nil means that you are a Usenet novice.
1571 If non-nil, verbose messages may be displayed and confirmations may be
1572 required."
1577 "*Non-nil means that you will never be asked for confirmation about anything.
1578 That doesn't mean *anything* anything; particularly destructive
1579 commands will still require prompting."
1584 "*If non-nil, require your confirmation when catching up a group."
1589 "*If non-nil, require your confirmation when exiting Gnus."
1594 "*Function for extracting address components from a From header.
1595 Two pre-defined function exist: `gnus-extract-address-components',
1596 which is the default, quite fast, and too simplistic solution, and
1597 `mail-extract-address-components', which works much better, but is
1598 slower."
1605 "String used to separate shell commands."
1627 server-marks)
1630 "*An alist of valid select methods.
1631 The first element of each list lists should be a string with the name
1632 of the select method. The other elements may be the category of
1633 this method (i. e., `post', `mail', `none' or whatever) or other
1634 properties that this method has (like being respoolable).
1635 If you implement a new select method, all you should have to change is
1636 this variable. I think."
1652 "Recomputes the select-method widget based on the value of
1653 `gnus-valid-select-methods'."
1655 "Widget for entering a select method."
1662 gnus-valid-select-methods)
1666 :inline t
1668 variable
1674 "List of buffers that should update their mode lines.
1675 The list may contain the symbols `group', `article', `tree' and
1676 `summary'. If the corresponding symbol is present, Gnus will keep
1677 that mode line updated with information that may be pertinent.
1678 If this variable is nil, screen refresh may be quicker."
1686 "*Max length of mode-line non-string contents.
1687 If this is nil, Gnus will take space as is needed, leaving the rest
1688 of the mode line intact."
1692 integer))
1694 ;; There should be special validation for this.
1699 to-address
1700 :function-document
1701 "Return GROUP's to-address."
1702 :variable-document
1703 "*Alist of group regexps and correspondent to-addresses."
1704 :variable-group gnus-group-parameter
1707 This will be used when doing followups and posts.
1709 This is primarily useful in mail groups that represent closed
1710 mailing lists--mailing lists where it's expected that everybody that
1711 writes to the mailing list is subscribed to it. Since using this
1712 parameter ensures that the mail only goes to the mailing list itself,
1713 it means that members won't receive two copies of your followups.
1715 Using `to-address' will actually work whether the group is foreign or
1716 not. Let's say there's a group on the server that is called
1717 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1718 articles from a mail-to-news gateway. Posting directly to this group
1719 is therefore impossible--you have to send mail to the mailing list
1720 address instead.
1722 The gnus-group-split mail splitting mechanism will behave as if this
1726 to-list
1727 :function-document
1728 "Return GROUP's to-list."
1729 :variable-document
1730 "*Alist of group regexps and correspondent to-lists."
1731 :variable-group gnus-group-parameter
1734 This address will be used when doing a `a' in the group.
1736 It is totally ignored when doing a followup--except that if it is
1737 present in a news group, you'll get mail group semantics when doing
1738 `f'.
1740 The gnus-group-split mail splitting mechanism will behave as if this
1744 subscribed
1745 :type bool
1746 :function-document
1747 "Return GROUP's subscription status."
1748 :variable-document
1749 "*Groups which are automatically considered subscribed."
1750 :variable-group gnus-group-parameter
1753 Gnus assumed that you are subscribed to the To/List address.
1755 When constructing a list of subscribed groups using
1756 `gnus-find-subscribed-addresses', Gnus includes the To address given
1760 auto-expire
1761 :type bool
1762 :function gnus-group-auto-expirable-p
1763 :function-document
1764 "Check whether GROUP is auto-expirable or not."
1765 :variable gnus-auto-expirable-newsgroups
1766 :variable-default nil
1767 :variable-document
1768 "*Groups in which to automatically mark read articles as expirable.
1769 If non-nil, this should be a regexp that should match all groups in
1770 which to perform auto-expiry. This only makes sense for mail groups."
1771 :variable-group nnmail-expire
1773 regexp)
1775 :parameter-document
1779 total-expire
1780 :type bool
1781 :function gnus-group-total-expirable-p
1782 :function-document
1783 "Check whether GROUP is total-expirable or not."
1784 :variable gnus-total-expirable-newsgroups
1785 :variable-default nil
1786 :variable-document
1787 "*Groups in which to perform expiry of all read articles.
1788 Use with extreme caution. All groups that match this regexp will be
1789 expiring - which means that all read articles will be deleted after
1790 \(say) one week. (This only goes for mail groups and the like, of
1791 course.)"
1792 :variable-group nnmail-expire
1794 regexp)
1796 :parameter-document
1797 "All read articles will be put through the expiry process
1799 This happens even if they are not marked as expirable.
1803 charset
1804 :function-document
1805 "Return the default charset of GROUP."
1806 :variable gnus-group-charset-alist
1807 :variable-default
1820 :variable-document
1821 "Alist of regexps (to match group names) and default charsets to be used when reading."
1822 :variable-group gnus-charset
1830 post-method
1831 :type list
1832 :function-document
1833 "Return a posting method for GROUP."
1834 :variable gnus-post-method-alist
1835 :variable-document
1836 "Alist of regexps (to match group names) and method to be used when
1837 posting an article."
1838 :variable-group gnus-group-foreign
1839 :parameter-type
1847 :parameter-document
1851 large-newsgroup-initial
1852 :type integer
1853 :function-document
1854 "Return GROUP's initial input of the number of articles."
1855 :variable-document
1856 "*Alist of group regexps and its initial input of the number of articles."
1857 :variable-group gnus-group-parameter
1863 This number will be prompted as the initial value of the number of
1864 articles to list when the group is a large newsgroup (see
1865 `gnus-large-newsgroup'). If it is nil, the default value is the
1868 ;; The Gnus registry's ignored groups
1870 registry-ignore
1871 :type list
1872 :function-document
1873 "Whether this group should be ignored by the registry."
1874 :variable gnus-registry-ignored-groups
1879 :variable-document
1880 "*Groups in which the registry should be turned off."
1881 :variable-group gnus-registry
1888 :parameter-document
1891 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1893 "*Disable the group parameters for spam detection.
1894 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1901 "Spam group classification (requires spam.el).
1902 This group contains spam messages. On summary entry, unread messages
1903 will be marked as spam. On summary exit, the specified spam
1904 processors will be invoked on spam-marked messages, then those
1905 messages will be expired, so the spam processor will only see a
1909 "The ham value for the spam group parameter (requires spam.el).
1910 On summary exit, the specified ham processors will be invoked on
1911 ham-marked messages. Exercise caution, since the ham processor will
1912 see the same message more than once because there is no ham message
1916 spam-contents
1917 :type list
1918 :function-document
1919 "The spam type (spam, ham, or neither) of the group."
1920 :variable gnus-spam-newsgroup-contents
1921 :variable-default nil
1922 :variable-document
1923 "*Group classification (spam, ham, or neither). Only
1924 meaningful when spam.el is loaded. If non-nil, this should be a
1925 list of group name regexps associated with a classification for
1926 each one. In spam groups, new articles are marked as spam on
1927 summary entry. There is other behavior associated with ham and
1928 no classification when spam.el is loaded - see the manual."
1929 :variable-group spam
1943 :parameter-document
1944 "The spam classification (spam, ham, or neither) of this group.
1945 When a spam group is entered, all unread articles are marked as
1946 spam. There is other behavior associated with ham and no
1950 spam-resend-to
1951 :type list
1952 :function-document
1953 "The address to get spam resent (through spam-report-resend)."
1954 :variable gnus-spam-resend-to
1955 :variable-default nil
1956 :variable-document
1957 "The address to get spam resent (through spam-report-resend)."
1958 :variable-group spam
1962 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1963 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1964 :parameter-document
1968 ham-resend-to
1969 :type list
1970 :function-document
1971 "The address to get ham resent (through spam-report-resend)."
1972 :variable gnus-ham-resend-to
1973 :variable-default nil
1974 :variable-document
1975 "The address to get ham resent (through spam-report-resend)."
1976 :variable-group spam
1980 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1981 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1982 :parameter-document
1998 "OBSOLETE: The Gmane reporting summary exit spam processor.
2005 "OBSOLETE: The ifile summary exit ham processor.
2009 "OBSOLETE: The Bogofilter summary exit ham processor.
2013 "OBSOLETE: The spam-stat summary exit ham processor.
2017 "OBSOLETE: The whitelist summary exit ham processor.
2021 "OBSOLETE: The BBDB summary exit ham processor.
2025 "OBSOLETE: The ham copy exit ham processor.
2029 "OBSOLETE: The spamoracle summary exit ham processor.
2033 spam-process
2034 :type list
2035 :parameter-type
2038 :value nil
2075 :function-document
2076 "Which spam or ham processors will be applied when the summary is exited."
2077 :variable gnus-spam-process-newsgroups
2078 :variable-default nil
2079 :variable-document
2080 "*Groups in which to automatically process spam or ham articles with
2081 a backend on summary exit. If non-nil, this should be a list of group
2082 name regexps that should match all groups in which to do automatic
2083 spam processing, associated with the appropriate processor."
2084 :variable-group spam
2085 :variable-type
2126 :parameter-document
2130 spam-autodetect
2131 :type list
2132 :parameter-type
2134 :function-document
2135 "Should spam be autodetected (with spam-split) in this group?"
2136 :variable gnus-spam-autodetect
2137 :variable-default nil
2138 :variable-document
2139 "*Groups in which spam should be autodetected when they are entered.
2140 Only unseen articles will be examined, unless
2141 spam-autodetect-recheck-messages is set."
2142 :variable-group spam
2143 :variable-type
2148 boolean))
2149 :parameter-document
2150 "Spam autodetection.
2151 Only unseen articles will be examined, unless
2155 spam-autodetect-methods
2156 :type list
2157 :parameter-type
2180 :function-document
2181 "Methods to be used for autodetection in each group"
2182 :variable gnus-spam-autodetect-methods
2183 :variable-default nil
2184 :variable-document
2185 "*Methods for autodetecting spam per group.
2186 Requires the spam-autodetect parameter. Only unseen articles
2187 will be examined, unless spam-autodetect-recheck-messages is
2188 set."
2189 :variable-group spam
2190 :variable-type
2217 :parameter-document
2218 "Spam autodetection methods.
2219 Requires the spam-autodetect parameter. Only unseen articles
2220 will be examined, unless spam-autodetect-recheck-messages is
2224 spam-process-destination
2225 :type list
2226 :parameter-type
2232 :function-document
2233 "Where spam-processed articles will go at summary exit."
2234 :variable gnus-spam-process-destinations
2235 :variable-default nil
2236 :variable-document
2237 "*Groups in which to explicitly send spam-processed articles to
2238 another group, or expire them (the default). If non-nil, this should
2239 be a list of group name regexps that should match all groups in which
2240 to do spam-processed article moving, associated with the destination
2241 group or nil for explicit expiration. This only makes sense for
2242 mail groups."
2243 :variable-group spam
2244 :variable-type
2255 :parameter-document
2259 ham-process-destination
2260 :type list
2261 :parameter-type
2269 :function-document
2270 "Where ham articles will go at summary exit from a spam group."
2271 :variable gnus-ham-process-destinations
2272 :variable-default nil
2273 :variable-document
2274 "*Groups in which to explicitly send ham articles to
2275 another group, or do nothing (the default). If non-nil, this should
2276 be a list of group name regexps that should match all groups in which
2277 to do ham article moving, associated with the destination
2278 group or nil for explicit ignoring. This only makes sense for
2279 mail groups, and only works in spam groups."
2280 :variable-group spam
2281 :variable-type
2293 :parameter-document
2297 ham-marks
2308 :parameter-document
2309 "Marks considered ham (positively not spam). Such articles will be
2310 processed as ham (non-spam) on group exit. When nil, the global
2311 spam-ham-marks variable takes precedence."
2313 gnus-read-mark
2314 gnus-killed-mark
2315 gnus-kill-file-mark
2316 gnus-low-score-mark))))
2317 :variable-group spam
2318 :variable-document
2322 spam-marks
2331 :parameter-document
2332 "Marks considered spam.
2333 Such articles will be processed as spam on group exit. When nil, the global
2334 spam-spam-marks variable takes precedence."
2336 :variable-group spam
2337 :variable-document
2341 "Number of group name elements to leave alone when making a short group name."
2346 "*If non-nil, once you set a level, Gnus will use this level."
2350 ;; Hooks.
2353 "A hook run while Gnus is loaded."
2358 "A hook called to apply kill files to a group.
2359 This hook is intended to apply a kill file to the selected newsgroup.
2360 The function `gnus-apply-kill-file' is called by default.
2362 Since a general kill file is too heavy to use only for a few
2363 newsgroups, I recommend you to use a lighter hook function. For
2364 example, if you'd like to apply a kill file to articles which contains
2365 a string `rmgroup' in subject in newsgroup `control', you can use the
2366 following hook:
2368 (setq gnus-apply-kill-hook
2369 (list
2370 (lambda ()
2379 "Function run when a group level is changed.
2380 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2383 function))
2385 ;;; Face thingies.
2389 mouse-face
2390 summary-menu group-menu article-menu
2391 tree-highlight menu highlight
2392 browse-menu server-menu
2393 page-marker tree-menu binary-menu pick-menu)
2394 "*Enable visual features.
2395 If `visual' is disabled, there will be no menus and few faces. Most of
2396 the visual customization options below will be ignored. Gnus will use
2397 less space and be faster as a result.
2399 This variable can also be a list of visual elements to switch on. For
2400 instance, to switch off all visual things except menus, you can say:
2402 (setq gnus-visual '(menu))
2404 Valid elements include `summary-highlight', `group-highlight',
2405 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2406 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2407 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2427 ;; Byte-compiler warning.
2429 ;; Find out whether the gnus-visual TYPE is wanted.
2433 gnus-visual
2437 t))))
2447 "*Face used for group or summary buffer mouse highlighting.
2448 The line beneath the mouse pointer will be highlighted with this
2449 face."
2462 "Controls use of the agent cache while plugged.
2463 When set, Gnus will prefer using the locally stored content rather
2464 than re-fetching it from the server. You also need to enable
2465 `gnus-agent' for this to have any affect."
2471 "Default charset assumed to be used when viewing non-ASCII characters.
2472 This variable is overridden on a group-to-group basis by the
2473 `gnus-group-charset-alist' variable and is only used on groups not
2474 covered by that variable."
2478 ;; Fixme: Doc reference to agent.
2480 "Whether we want to use the Gnus agent or not.
2482 You may customize gnus-agent to disable its use. However, some
2483 back ends have started to use the agent as a client-side cache.
2484 Disabling the agent may result in noticeable loss of performance."
2490 "Function called by the command `gnus-other-frame'."
2498 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2499 This should be an alist for Emacs, or a plist for XEmacs."
2510 "Which information should be exposed in the User-Agent header.
2512 Can be a list of symbols or a string. Valid symbols are `gnus'
2513 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2514 addition to the Emacs version, you can add `codename' \(show
2515 \(S\)XEmacs codename\) or either `config' \(show system
2516 configuration\) or `type' \(show system type\). If you set it to
2517 a string, be sure to use a valid format, see RFC 2616."
2530 ;; Convert old (< 2005-01-10) symbol type values:
2549 \f
2550 ;;; Internal variables
2555 ; Reset each time gnus-agent-covered-methods is changed else
2556 ; gnus-agent-method-p may mis-report a methods status.
2557 )
2567 ;; The carpal mode has been removed, but define the variable for
2568 ;; backwards compatibility.
2587 ;; Variable holding the user answers to all method prompts.
2590 ;; Variable holding the user answers to all mail method prompts.
2593 ;; Variable holding the user answers to all group prompts.
2601 "*The directory where cached articles will be stored."
2607 nnspool "cache"
2631 ;; Propagate flags to server, with the following exceptions:
2632 ;; `seen' is private to each gnus installation
2633 ;; `cache' is a internal gnus flag for each gnus installation
2634 ;; `download' is a agent flag private to each gnus installation
2635 ;; `unsend' are for nndraft groups only
2636 ;; `score' is not a proper mark
2637 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2640 "Marks that shouldn't be propagated to back ends.
2641 Typical marks are those that make no sense in a standalone back end,
2642 such as a mark that says whether an article is stored in the cache
2655 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
2659 "gnus"
2684 gnus-newsrc-last-checked-date
2685 gnus-newsrc-alist gnus-server-alist
2686 gnus-killed-list gnus-zombie-list
2687 gnus-topic-topology gnus-topic-alist
2688 gnus-format-specs)
2692 "Assoc list of read articles.
2696 "Assoc list of registry data.
2723 ;; Save window configuration.
2736 ;;; End of variables.
2738 ;; Define some autoload functions Gnus might use.
2741 ;; This little mapcar goes through the list below and marks the
2742 ;; symbols in question as autoloaded functions.
2762 message-send-and-exit message-yank-original)
2766 ;; This is only used in message.el, which has an autoload.
2768 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2770 ;; Next two only used in gnus-util.
2771 rmail-summary-exists rmail-select-summary)
2772 ;; Only used in gnus-util, which has an autoload.
2777 gnus-Folder-save-name gnus-folder-save-name)
2780 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2781 gnus-demon-add-disconnection gnus-demon-add-handler
2782 gnus-demon-remove-handler)
2784 gnus-demon-init gnus-demon-cancel)
2786 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2787 gnus-face-from-file)
2789 gnus-tree-open gnus-tree-close)
2791 gnus-server-server-name)
2794 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2795 gnus-article-hide-citation gnus-article-fill-cited-article
2796 gnus-article-hide-citation-in-followups
2797 gnus-article-fill-cited-long-lines)
2799 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2800 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2802 gnus-cache-possibly-remove-articles gnus-cache-request-article
2803 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2804 gnus-cache-enter-remove-article gnus-cached-article-p
2805 gnus-cache-open gnus-cache-close gnus-cache-update-article
2806 gnus-cache-articles-in-group)
2808 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2810 gnus-summary-increase-score gnus-summary-set-score
2811 gnus-summary-raise-thread gnus-summary-raise-same-subject
2812 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2813 gnus-summary-lower-thread gnus-summary-lower-same-subject
2814 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2815 gnus-summary-current-score gnus-score-delta-default
2816 gnus-score-flush-cache gnus-score-close
2817 gnus-possibly-score-headers gnus-score-followup-article
2818 gnus-score-followup-thread)
2821 gnus-current-score-file-nondirectory gnus-score-adaptive
2822 gnus-score-find-trace gnus-score-file-name)
2826 gnus-subscribe-topics)
2830 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2831 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2832 gnus-uu-mark-by-regexp gnus-uu-mark-all
2833 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2834 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2835 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2836 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2837 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2838 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2839 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2840 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2843 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2845 gnus-group-post-news gnus-group-mail gnus-group-news
2846 gnus-summary-post-news gnus-summary-news-other-window
2847 gnus-summary-followup gnus-summary-followup-with-original
2848 gnus-summary-cancel-article gnus-summary-supersede-article
2849 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2850 gnus-summary-mail-forward gnus-summary-mail-other-window
2851 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2852 gnus-summary-wide-reply gnus-summary-followup-to-mail
2853 gnus-summary-followup-to-mail-with-original gnus-bug
2854 gnus-summary-wide-reply-with-original
2855 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2856 gnus-summary-post-forward)
2861 gnus-list-of-unread-articles gnus-list-of-read-articles
2862 gnus-offer-save-summaries gnus-make-thread-indent-array
2863 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2864 gnus-summary-skip-intangible gnus-summary-article-number
2865 gnus-data-header gnus-data-find)
2867 gnus-group-list-groups gnus-group-first-unread-group
2868 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2869 gnus-group-setup-buffer gnus-group-get-new-news
2870 gnus-group-make-help-group gnus-group-update-group
2871 gnus-group-iterate gnus-group-group-name)
2873 gnus-backlog-remove-article)
2875 gnus-article-prepare gnus-article-set-window-start
2876 gnus-article-next-page gnus-article-prev-page
2877 gnus-request-article-this-buffer gnus-article-mode
2878 gnus-article-setup-buffer gnus-narrow-to-page
2879 gnus-article-delete-invisible-text gnus-treat-article)
2881 gnus-article-hide-headers gnus-article-hide-boring-headers
2882 gnus-article-treat-overstrike
2883 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2884 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2885 gnus-article-de-base64-unreadable
2886 gnus-article-decode-HZ
2887 gnus-article-wash-html
2888 gnus-article-unsplit-urls
2889 gnus-article-hide-pem gnus-article-hide-signature
2890 gnus-article-strip-leading-blank-lines gnus-article-date-local
2891 gnus-article-date-original gnus-article-date-lapsed
2892 ;;gnus-article-show-all-headers
2893 gnus-article-edit-mode gnus-article-edit-article
2894 gnus-article-edit-done gnus-article-decode-encoded-words
2895 gnus-start-date-timer gnus-stop-date-timer
2896 gnus-mime-view-all-parts)
2899 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2900 gnus-check-reasonable-setup)
2902 gnus-dup-enter-articles)
2908 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2909 gnus-async-halt-prefetch)
2911 gnus-agent-save-active gnus-agent-method-p
2912 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2913 gnus-summary-set-agent-mark gnus-agent-save-group-info
2914 gnus-agent-request-article gnus-agent-retrieve-headers
2915 gnus-agent-store-article gnus-agent-group-covered-p)
2917 gnus-unplugged gnus-agentize gnus-agent-batch)
2919 gnus-summary-save-article-vm)
2924 gnus-group-split-update)
2927 ;;; gnus-sum.el thingies
2931 "*The format specification of the lines in the summary buffer.
2933 It works along the same lines as a normal formatting string,
2934 with some simple extensions.
2936 %N Article number, left padded with spaces (string)
2937 %S Subject (string)
2939 otherwise (string)
2940 %n Name of the poster (string)
2941 %a Extracted name of the poster (string)
2942 %A Extracted address of the poster (string)
2943 %F Contents of the From: header (string)
2944 %f Contents of the From: or To: headers (string)
2945 %x Contents of the Xref: header (string)
2946 %D Date of the article (string)
2947 %d Date of the article (string) in DD-MMM format
2948 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2949 format
2950 %M Message-id of the article (string)
2951 %r References of the article (string)
2952 %c Number of characters in the article (integer)
2953 %k Pretty-printed version of the above (string)
2955 %L Number of lines in the article (integer)
2956 %I Indentation based on thread level (a string of
2957 spaces)
2958 %B A complex trn-style thread tree (string)
2959 The variables `gnus-sum-thread-*' can be used for
2960 customization.
2961 %T A string with two possible values: 80 spaces if the
2962 article is on thread level two or larger and 0 spaces
2963 on level one
2965 otherwise (character)
2967 See Info node `(gnus)Marking Articles'
2970 %> Spaces of length thread-level (string)
2971 %< Spaces of length (- 20 thread-level) (string)
2972 %i Article score (number)
2973 %z Article zcore (character)
2974 %t Number of articles under the current thread (number).
2975 %e Whether the thread is empty or not (character).
2976 %V Total thread score (number).
2977 %P The line number (number).
2978 %O Download mark (character).
2979 %* If present, indicates desired cursor position
2980 (instead of after first colon).
2981 %u User defined specifier. The next character in the
2982 format string should be a letter. Gnus will call the
2983 function gnus-user-format-function-X, where X is the
2984 letter following %u. The function will be passed the
2985 current header as argument. The function should
2986 return a string, which will be inserted into the
2987 summary just like information from any other summary
2988 specifier.
2989 &user-date; Age sensitive date format. Various date format is
2990 defined in `gnus-summary-user-date-format-alist'.
2993 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2994 with care. For reasons of efficiency, Gnus will compute what column
2996 it is invalid to have these specs after a variable-length spec. Well,
2997 you might not be arrested, but your summary buffer will look strange,
2998 which is bad enough.
3000 The smart choice is to have these specs as far to the left as
3001 possible.
3003 This restriction may disappear in later versions of Gnus.
3005 General format specifiers can also be used.
3006 See Info node `(gnus)Formatting Variables'."
3011 ;;;
3012 ;;; Skeleton keymaps
3013 ;;;
3018 (while keys
3019 (define-key keymap (pop keys) 'undefined))))
3021 (defvar gnus-article-mode-map
3022 (let ((keymap (make-sparse-keymap)))
3023 (gnus-suppress-keymap keymap)
3024 keymap))
3025 (defvar gnus-summary-mode-map
3026 (let ((keymap (make-keymap)))
3027 (gnus-suppress-keymap keymap)
3028 keymap))
3029 (defvar gnus-group-mode-map
3030 (let ((keymap (make-keymap)))
3031 (gnus-suppress-keymap keymap)
3032 keymap))
3034 \f
3036 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3037 ;; If you want the cursor to go somewhere else, set these two
3038 ;; functions in some startup hook to whatever you want.
3039 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3040 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3042 ;;; Various macros and substs.
3044 (defun gnus-header-from (header)
3045 (mail-header-from header))
3047 (defmacro gnus-gethash (string hashtable)
3048 "Get hash value of STRING in HASHTABLE."
3049 `(symbol-value (intern-soft ,string ,hashtable)))
3051 (defmacro gnus-gethash-safe (string hashtable)
3052 "Get hash value of STRING in HASHTABLE.
3053 Return nil if not defined."
3054 `(let ((sym (intern-soft ,string ,hashtable)))
3055 (and (boundp sym) (symbol-value sym))))
3057 (defmacro gnus-sethash (string value hashtable)
3058 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3059 `(set (intern ,string ,hashtable) ,value))
3060 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3062 (defmacro gnus-group-unread (group)
3063 "Get the currently computed number of unread articles in GROUP."
3064 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3066 (defmacro gnus-group-entry (group)
3067 "Get the newsrc entry for GROUP."
3068 `(gnus-gethash ,group gnus-newsrc-hashtb))
3070 (defmacro gnus-active (group)
3071 "Get active info on GROUP."
3072 `(gnus-gethash ,group gnus-active-hashtb))
3074 (defmacro gnus-set-active (group active)
3075 "Set GROUP's active info."
3076 `(gnus-sethash ,group ,active gnus-active-hashtb))
3078 ;; Info access macros.
3080 (defmacro gnus-info-group (info)
3081 `(nth 0 ,info))
3082 (defmacro gnus-info-rank (info)
3083 `(nth 1 ,info))
3084 (defmacro gnus-info-read (info)
3085 `(nth 2 ,info))
3086 (defmacro gnus-info-marks (info)
3087 `(nth 3 ,info))
3088 (defmacro gnus-info-method (info)
3089 `(nth 4 ,info))
3090 (defmacro gnus-info-params (info)
3091 `(nth 5 ,info))
3093 (defmacro gnus-info-level (info)
3094 `(let ((rank (gnus-info-rank ,info)))
3095 (if (consp rank)
3096 (car rank)
3097 rank)))
3098 (defmacro gnus-info-score (info)
3099 `(let ((rank (gnus-info-rank ,info)))
3100 (or (and (consp rank) (cdr rank)) 0)))
3102 (defmacro gnus-info-set-group (info group)
3103 `(setcar ,info ,group))
3104 (defmacro gnus-info-set-rank (info rank)
3105 `(setcar (nthcdr 1 ,info) ,rank))
3106 (defmacro gnus-info-set-read (info read)
3107 `(setcar (nthcdr 2 ,info) ,read))
3108 (defmacro gnus-info-set-marks (info marks &optional extend)
3109 (if extend
3110 `(gnus-info-set-entry ,info ,marks 3)
3111 `(setcar (nthcdr 3 ,info) ,marks)))
3112 (defmacro gnus-info-set-method (info method &optional extend)
3113 (if extend
3114 `(gnus-info-set-entry ,info ,method 4)
3115 `(setcar (nthcdr 4 ,info) ,method)))
3116 (defmacro gnus-info-set-params (info params &optional extend)
3117 (if extend
3118 `(gnus-info-set-entry ,info ,params 5)
3119 `(setcar (nthcdr 5 ,info) ,params)))
3121 (defun gnus-info-set-entry (info entry number)
3122 ;; Extend the info until we have enough elements.
3123 (while (<= (length info) number)
3124 (nconc info (list nil)))
3125 ;; Set the entry.
3126 (setcar (nthcdr number info) entry))
3128 (defmacro gnus-info-set-level (info level)
3129 `(let ((rank (cdr ,info)))
3130 (if (consp (car rank))
3131 (setcar (car rank) ,level)
3132 (setcar rank ,level))))
3133 (defmacro gnus-info-set-score (info score)
3134 `(let ((rank (cdr ,info)))
3135 (if (consp (car rank))
3136 (setcdr (car rank) ,score)
3137 (setcar rank (cons (car rank) ,score)))))
3139 (defmacro gnus-get-info (group)
3140 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3142 (defun gnus-set-info (group info)
3143 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3144 info))
3146 ;;; Load the compatibility functions.
3148 (require 'gnus-ems)
3150 \f
3151 ;;;
3152 ;;; Shutdown
3153 ;;;
3155 (defvar gnus-shutdown-alist nil)
3157 (defun gnus-add-shutdown (function &rest symbols)
3158 "Run FUNCTION whenever one of SYMBOLS is shut down."
3159 (push (cons function symbols) gnus-shutdown-alist))
3161 (defun gnus-shutdown (symbol)
3162 "Shut down everything that waits for SYMBOL."
3163 (dolist (entry gnus-shutdown-alist)
3164 (when (memq symbol (cdr entry))
3165 (funcall (car entry)))))
3167 \f
3168 ;;;
3169 ;;; Gnus Utility Functions
3170 ;;;
3172 (defun gnus-find-subscribed-addresses ()
3173 "Return a regexp matching the addresses of all subscribed mail groups.
3174 It consists of the `to-address' or `to-list' parameter of all groups
3175 with a `subscribed' parameter."
3176 (let (group address addresses)
3177 (dolist (entry (cdr gnus-newsrc-alist))
3178 (setq group (car entry))
3179 (when (gnus-parameter-subscribed group)
3180 (setq address (mail-strip-quoted-names
3181 (or (gnus-group-fast-parameter group 'to-address)
3182 (gnus-group-fast-parameter group 'to-list))))
3183 (when address
3184 (add-to-list 'addresses address))))
3185 (when addresses
3188 (defmacro gnus-string-or (&rest strings)
3189 "Return the first element of STRINGS that is a non-blank string.
3190 STRINGS will be evaluated in normal `or' order."
3191 `(gnus-string-or-1 (list ,@strings)))
3193 (defun gnus-string-or-1 (strings)
3194 (let (string)
3195 (while strings
3196 (setq string (pop strings))
3198 (setq string nil)
3199 (setq strings nil)))
3200 string))
3202 (defun gnus-version (&optional arg)
3203 "Version number of this version of Gnus.
3204 If ARG, insert string at point."
3205 (interactive "P")
3206 (if arg
3207 (insert (message gnus-version))
3208 (message gnus-version)))
3210 (defun gnus-continuum-version (&optional version)
3211 "Return VERSION as a floating point number."
3212 (unless version
3213 (setq version gnus-version))
3216 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3217 (number (match-string 2 version))
3218 major minor least)
3219 (unless (string-match
3221 (error "Invalid version string: %s" version))
3222 (setq major (string-to-number (match-string 1 number))
3223 minor (string-to-number (match-string 2 number))
3224 least (if (match-beginning 3)
3225 (string-to-number (match-string 3 number))
3226 0))
3227 (string-to-number
3228 (if (zerop major)
3229 (format "%s00%02d%02d"
3230 (if (member alpha '("(ding)" "d"))
3231 "4.99"
3232 (+ 5 (* 0.02
3233 (abs
3234 (- (mm-char-int (aref (downcase alpha) 0))
3235 (mm-char-int ?t))))
3236 -0.01))
3237 minor least)
3238 (format "%d.%02d%02d" major minor least))))))
3240 (defun gnus-info-find-node (&optional nodename)
3241 "Find Info documentation of Gnus."
3242 (interactive)
3243 ;; Enlarge info window if needed.
3244 (let (gnus-info-buffer)
3245 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3246 (setq gnus-info-buffer (current-buffer))
3247 (gnus-configure-windows 'info)))
3249 ;;;
3250 ;;; gnus-interactive
3251 ;;;
3253 (defvar gnus-current-prefix-symbol nil
3254 "Current prefix symbol.")
3256 (defvar gnus-current-prefix-symbols nil
3257 "List of current prefix symbols.")
3259 (defun gnus-interactive (string &optional params)
3260 "Return a list that can be fed to `interactive'.
3261 See `interactive' for full documentation.
3263 Adds the following specs:
3265 y -- The current symbolic prefix.
3266 Y -- A list of the current symbolic prefix(es).
3267 A -- Article number.
3268 H -- Article header.
3269 g -- Group name."
3270 (let ((i 0)
3271 out c prompt)
3272 (while (< i (length string))
3274 (setq c (aref string i))
3275 (when (match-end 1)
3276 (setq prompt (match-string 1 string)))
3277 (setq i (match-end 0))
3278 ;; We basically emulate just about everything that
3279 ;; `interactive' does, but add the specs listed above.
3280 (push
3281 (cond
3282 ((= c ?a)
3283 (completing-read prompt obarray 'fboundp t))
3284 ((= c ?b)
3285 (read-buffer prompt (current-buffer) t))
3286 ((= c ?B)
3287 (read-buffer prompt (other-buffer (current-buffer))))
3288 ((= c ?c)
3289 (read-char))
3290 ((= c ?C)
3291 (completing-read prompt obarray 'commandp t))
3292 ((= c ?d)
3293 (point))
3294 ((= c ?D)
3295 (read-directory-name prompt nil default-directory 'lambda))
3296 ((= c ?f)
3297 (read-file-name prompt nil nil 'lambda))
3298 ((= c ?F)
3299 (read-file-name prompt))
3300 ((= c ?k)
3301 (read-key-sequence prompt))
3302 ((= c ?K)
3303 (error "Not implemented spec"))
3304 ((= c ?e)
3305 (error "Not implemented spec"))
3306 ((= c ?m)
3307 (mark))
3308 ((= c ?N)
3309 (error "Not implemented spec"))
3310 ((= c ?n)
3311 (string-to-number (read-from-minibuffer prompt)))
3312 ((= c ?p)
3313 (prefix-numeric-value current-prefix-arg))
3314 ((= c ?P)
3315 current-prefix-arg)
3316 ((= c ?r)
3317 'gnus-prefix-nil)
3318 ((= c ?s)
3319 (read-string prompt))
3320 ((= c ?S)
3321 (intern (read-string prompt)))
3322 ((= c ?v)
3323 (read-variable prompt))
3324 ((= c ?x)
3325 (read-minibuffer prompt))
3326 ((= c ?x)
3327 (eval-minibuffer prompt))
3328 ;; And here the new specs come.
3329 ((= c ?y)
3330 gnus-current-prefix-symbol)
3331 ((= c ?Y)
3332 gnus-current-prefix-symbols)
3333 ((= c ?g)
3334 (gnus-group-group-name))
3335 ((= c ?A)
3336 (gnus-summary-skip-intangible)
3337 (or (get-text-property (point) 'gnus-number)
3338 (gnus-summary-last-subject)))
3339 ((= c ?H)
3340 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3341 (t
3342 (error "Non-implemented spec")))
3343 out)
3344 (cond
3345 ((= c ?r)
3346 (push (if (< (point) (mark)) (point) (mark)) out)
3347 (push (if (> (point) (mark)) (point) (mark)) out))))
3348 (setq out (delq 'gnus-prefix-nil out))
3349 (nreverse out)))
3351 (defun gnus-symbolic-argument (&optional arg)
3352 "Read a symbolic argument and a command, and then execute command."
3353 (interactive "P")
3354 (let* ((in-command (this-command-keys))
3355 (command in-command)
3356 gnus-current-prefix-symbols
3357 gnus-current-prefix-symbol
3358 syms)
3359 (while (equal in-command command)
3360 (message "%s-" (key-description (this-command-keys)))
3361 (push (intern (char-to-string (read-char))) syms)
3362 (setq command (read-key-sequence nil t)))
3363 (setq gnus-current-prefix-symbols (nreverse syms)
3364 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3365 (call-interactively (key-binding command t))))
3367 ;;; More various functions.
3369 (defsubst gnus-check-backend-function (func group)
3370 "Check whether GROUP supports function FUNC.
3371 GROUP can either be a string (a group name) or a select method."
3372 (ignore-errors
3373 (let ((method (if (stringp group)
3374 (car (gnus-find-method-for-group group))
3375 group)))
3376 (unless (featurep method)
3377 (require method))
3378 (fboundp (intern (format "%s-%s" method func))))))
3380 (defun gnus-group-read-only-p (&optional group)
3381 "Check whether GROUP supports editing or not.
3382 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3383 that that variable is buffer-local to the summary buffers."
3384 (let ((group (or group gnus-newsgroup-name)))
3385 (not (gnus-check-backend-function 'request-replace-article group))))
3387 (defun gnus-virtual-group-p (group)
3388 "Say whether GROUP is virtual or not."
3389 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3390 gnus-valid-select-methods)))
3392 (defun gnus-news-group-p (group &optional article)
3393 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3394 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3395 t) ;is news of course.
3396 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3397 nil) ;must be mail then.
3398 ((vectorp article) ;Has header info.
3399 (eq (gnus-request-type group (mail-header-id article)) 'news))
3400 ((null article) ;Hasn't header info
3401 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3402 ((< article 0) ;Virtual message
3403 nil) ;we don't know, guess mail.
3404 (t ;Has positive number
3405 (eq (gnus-request-type group article) 'news)))) ;use it.
3407 ;; Returns a list of writable groups.
3408 (defun gnus-writable-groups ()
3409 (let ((alist gnus-newsrc-alist)
3410 groups group)
3411 (while (setq group (car (pop alist)))
3412 (unless (gnus-group-read-only-p group)
3413 (push group groups)))
3414 (nreverse groups)))
3416 ;; Check whether to use long file names.
3417 (defun gnus-use-long-file-name (symbol)
3418 ;; The variable has to be set...
3419 (and gnus-use-long-file-name
3420 ;; If it isn't a list, then we return t.
3421 (or (not (listp gnus-use-long-file-name))
3422 ;; If it is a list, and the list contains `symbol', we
3423 ;; return nil.
3424 (not (memq symbol gnus-use-long-file-name)))))
3426 ;; Generate a unique new group name.
3427 (defun gnus-generate-new-group-name (leaf)
3428 (let ((name leaf)
3429 (num 0))
3430 (while (gnus-group-entry name)
3431 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3432 name))
3434 (defun gnus-ephemeral-group-p (group)
3435 "Say whether GROUP is ephemeral or not."
3436 (gnus-group-get-parameter group 'quit-config t))
3438 (defun gnus-group-quit-config (group)
3439 "Return the quit-config of GROUP."
3440 (gnus-group-get-parameter group 'quit-config t))
3442 (defun gnus-kill-ephemeral-group (group)
3443 "Remove ephemeral GROUP from relevant structures."
3444 (gnus-sethash group nil gnus-newsrc-hashtb))
3446 (defun gnus-simplify-mode-line ()
3447 "Make mode lines a bit simpler."
3448 (setq mode-line-modified (cdr gnus-mode-line-modified))
3449 (when (listp mode-line-format)
3450 (make-local-variable 'mode-line-format)
3451 (setq mode-line-format (copy-sequence mode-line-format))
3452 (when (equal (nth 3 mode-line-format) " ")
3453 (setcar (nthcdr 3 mode-line-format) " "))))
3455 ;;; Servers and groups.
3457 (defsubst gnus-server-add-address (method)
3458 (let ((method-name (symbol-name (car method))))
3459 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3460 (not (assq (intern (concat method-name "-address")) method))
3461 (memq 'physical-address (assq (car method)
3462 gnus-valid-select-methods)))
3463 (append method (list (list (intern (concat method-name "-address"))
3464 (nth 1 method))))
3465 method)))
3467 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3468 (catch 'server-name
3469 (setq method (or method gnus-select-method))
3471 ;; Perhaps it is already in the cache.
3472 (unless nocache
3473 (mapc (lambda (name-method)
3474 (if (equal (cdr name-method) method)
3475 (throw 'server-name (car name-method))))
3476 gnus-server-method-cache))
3478 (mapc
3479 (lambda (server-alist)
3480 (mapc (lambda (name-method)
3481 (when (gnus-methods-equal-p (cdr name-method) method)
3482 (unless (member name-method gnus-server-method-cache)
3483 (push name-method gnus-server-method-cache))
3484 (throw 'server-name (car name-method))))
3485 server-alist))
3486 (list gnus-server-alist
3487 gnus-predefined-server-alist))
3489 (let* ((name (if (member (cadr method) '(nil ""))
3490 (format "%s" (car method))
3491 (format "%s:%s" (car method) (cadr method))))
3492 (name-method (cons name method)))
3493 (when (and (not (member name-method gnus-server-method-cache))
3494 (not no-enter-cache)
3495 (not (assoc (car name-method) gnus-server-method-cache)))
3496 (push name-method gnus-server-method-cache))
3497 name)))
3499 (defsubst gnus-server-to-method (server)
3500 "Map virtual server names to select methods."
3501 (or (and server (listp server) server)
3502 (cdr (assoc server gnus-server-method-cache))
3503 (let ((result
3504 (or
3505 ;; Perhaps this is the native server?
3506 (and (equal server "native") gnus-select-method)
3507 ;; It should be in the server alist.
3508 (cdr (assoc server gnus-server-alist))
3509 ;; It could be in the predefined server alist.
3510 (cdr (assoc server gnus-predefined-server-alist))
3511 ;; If not, we look through all the opened server
3512 ;; to see whether we can find it there.
3513 (let ((opened gnus-opened-servers))
3514 (while (and opened
3515 (not (equal server (format "%s:%s" (caaar opened)
3516 (cadaar opened)))))
3517 (pop opened))
3518 (caar opened))
3519 ;; It could be a named method, search all servers
3520 (let ((servers gnus-secondary-select-methods))
3521 (while (and servers
3522 (not (equal server (format "%s:%s" (caar servers)
3523 (cadar servers)))))
3524 (pop servers))
3525 (car servers))
3526 ;; This could be some sort of foreign server that I
3527 ;; simply haven't opened (yet). Do a brute-force scan
3528 ;; of the entire gnus-newsrc-alist for the server name
3529 ;; of every method. As a side-effect, loads the
3530 ;; gnus-server-method-cache so this only happens once,
3531 ;; if at all.
3532 (let ((alist (cdr gnus-newsrc-alist))
3533 method match)
3534 (while alist
3535 (setq method (gnus-info-method (pop alist)))
3536 (when (and (not (stringp method))
3537 (equal server
3538 (gnus-method-to-server method nil t)))
3539 (setq match method
3540 alist nil)))
3541 match))))
3542 (when (and result
3543 (not (assoc server gnus-server-method-cache)))
3544 (push (cons server result) gnus-server-method-cache))
3545 result)))
3547 (defsubst gnus-server-get-method (group method)
3548 ;; Input either a server name, and extended server name, or a
3549 ;; select method, and return a select method.
3550 (cond ((stringp method)
3551 (gnus-server-to-method method))
3552 ((equal method gnus-select-method)
3553 gnus-select-method)
3554 ((and (stringp (car method))
3555 group)
3556 (gnus-server-extend-method group method))
3557 ((and method
3558 (not group)
3559 (equal (cadr method) ""))
3560 method)
3561 (t
3562 (gnus-server-add-address method))))
3564 (defmacro gnus-method-equal (ss1 ss2)
3565 "Say whether two servers are equal."
3566 `(let ((s1 ,ss1)
3567 (s2 ,ss2))
3568 (or (equal s1 s2)
3569 (and (= (length s1) (length s2))
3570 (progn
3571 (while (and s1 (member (car s1) s2))
3572 (setq s1 (cdr s1)))
3573 (null s1))))))
3575 (defun gnus-methods-equal-p (m1 m2)
3576 (let ((m1 (or m1 gnus-select-method))
3577 (m2 (or m2 gnus-select-method)))
3578 (or (equal m1 m2)
3579 (and (eq (car m1) (car m2))
3580 (or (not (memq 'address (assoc (symbol-name (car m1))
3581 gnus-valid-select-methods)))
3582 (equal (nth 1 m1) (nth 1 m2)))))))
3584 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3585 ;; Check parameters for sloppy equalness.
3586 (let ((p1 (copy-sequence (cddr m1)))
3587 (p2 (copy-sequence (cddr m2)))
3588 e1 e2)
3589 (block nil
3590 (while (setq e1 (pop p1))
3591 (unless (setq e2 (assq (car e1) p2))
3592 ;; The parameter doesn't exist in p2.
3593 (return nil))
3594 (setq p2 (delq e2 p2))
3595 (unless (equal e1 e2)
3596 (if (not (and (stringp (cadr e1))
3597 (stringp (cadr e2))))
3598 (return nil)
3599 ;; Special-case string parameter comparison so that we
3600 ;; can uniquify them.
3601 (let ((s1 (cadr e1))
3602 (s2 (cadr e2)))
3603 (when (string-match "/$" s1)
3604 (setq s1 (directory-file-name s1)))
3605 (when (string-match "/$" s2)
3606 (setq s2 (directory-file-name s2)))
3607 (unless (equal s1 s2)
3608 (return nil))))))
3609 ;; If p2 now is empty, they were equal.
3610 (null p2))))
3612 (defun gnus-methods-sloppily-equal (m1 m2)
3613 ;; Same method.
3614 (or
3615 (eq m1 m2)
3616 ;; Type and name are equal.
3617 (and
3618 (eq (car m1) (car m2))
3619 (equal (cadr m1) (cadr m2))
3620 (gnus-sloppily-equal-method-parameters m1 m2))))
3622 (defun gnus-server-equal (m1 m2)
3623 "Say whether two methods are equal."
3624 (let ((m1 (cond ((null m1) gnus-select-method)
3625 ((stringp m1) (gnus-server-to-method m1))
3626 (t m1)))
3627 (m2 (cond ((null m2) gnus-select-method)
3628 ((stringp m2) (gnus-server-to-method m2))
3629 (t m2))))
3630 (gnus-method-equal m1 m2)))
3632 (defun gnus-servers-using-backend (backend)
3633 "Return a list of known servers using BACKEND."
3634 (let ((opened gnus-opened-servers)
3635 out)
3636 (while opened
3637 (when (eq backend (caaar opened))
3638 (push (caar opened) out))
3639 (pop opened))
3640 out))
3642 (defun gnus-archive-server-wanted-p ()
3643 "Say whether the user wants to use the archive server."
3644 (cond
3645 ((or (not gnus-message-archive-method)
3646 (not gnus-message-archive-group))
3647 nil)
3648 ((and gnus-message-archive-method gnus-message-archive-group)
3649 t)
3650 (t
3651 (let ((active (cadr (assq 'nnfolder-active-file
3652 gnus-message-archive-method))))
3653 (and active
3654 (file-exists-p active))))))
3656 (defsubst gnus-method-to-server-name (method)
3657 (concat
3658 (format "%s" (car method))
3659 (when (and
3660 (or (assoc (format "%s" (car method))
3661 (gnus-methods-using 'address))
3662 (gnus-server-equal method gnus-message-archive-method))
3663 (nth 1 method)
3664 (not (string= (nth 1 method) "")))
3665 (concat "+" (nth 1 method)))))
3667 (defsubst gnus-method-to-full-server-name (method)
3668 (format "%s+%s" (car method) (nth 1 method)))
3670 (defun gnus-group-prefixed-name (group method &optional full)
3671 "Return the whole name from GROUP and METHOD.
3672 Call with full set to get the fully qualified group name (even if the
3673 server is native)."
3674 (when (stringp method)
3675 (setq method (gnus-server-to-method method)))
3676 (if (or (not method)
3677 (and (not full) (gnus-server-equal method "native"))
3678 ;;;!!! This might not be right. We'll see...
3679 ;(string-match ":" group)
3680 )
3681 group
3682 (concat (gnus-method-to-server-name method) ":" group)))
3684 (defun gnus-group-guess-prefixed-name (group)
3685 "Guess the whole name from GROUP and METHOD."
3686 (gnus-group-prefixed-name group (gnus-find-method-for-group
3687 group)))
3689 (defun gnus-group-full-name (group method)
3690 "Return the full name from GROUP and METHOD, even if the method is native."
3691 (gnus-group-prefixed-name group method t))
3693 (defun gnus-group-guess-full-name (group)
3694 "Guess the full name from GROUP, even if the method is native."
3695 (if (gnus-group-prefixed-p group)
3696 group
3697 (gnus-group-full-name group (gnus-find-method-for-group group))))
3699 (defun gnus-group-guess-full-name-from-command-method (group)
3700 "Guess the full name from GROUP, even if the method is native."
3701 (if (gnus-group-prefixed-p group)
3702 group
3703 (gnus-group-full-name group gnus-command-method)))
3705 (defun gnus-group-real-prefix (group)
3706 "Return the prefix of the current group name."
3707 (if (stringp group)
3708 (if (string-match "^[^:]+:" group)
3709 (substring group 0 (match-end 0))
3710 "")
3711 nil))
3713 (defun gnus-group-short-name (group)
3714 "Return the short group name."
3715 (let ((prefix (gnus-group-real-prefix group)))
3716 (if (< 0 (length prefix))
3717 (substring group (length prefix) nil)
3718 group)))
3720 (defun gnus-group-prefixed-p (group)
3721 "Return the prefix of the current group name."
3722 (< 0 (length (gnus-group-real-prefix group))))
3724 (declare-function gnus-group-decoded-name "gnus-group" (string))
3726 (defun gnus-summary-buffer-name (group)
3727 "Return the summary buffer name of GROUP."
3728 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3730 (defun gnus-group-method (group)
3731 "Return the server or method used for selecting GROUP.
3732 You should probably use `gnus-find-method-for-group' instead."
3733 (let ((prefix (gnus-group-real-prefix group)))
3734 (if (equal prefix "")
3735 gnus-select-method
3736 (let ((servers gnus-opened-servers)
3737 (server "")
3738 backend possible found)
3740 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3741 server (substring prefix (match-end 0) (1- (length prefix))))
3742 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3743 (while servers
3744 (when (eq (caaar servers) backend)
3745 (setq possible (caar servers))
3746 (when (equal (cadaar servers) server)
3747 (setq found (caar servers))))
3748 (pop servers))
3749 (or (car (rassoc found gnus-server-alist))
3750 found
3751 (car (rassoc possible gnus-server-alist))
3752 possible
3753 (list backend server))))))
3755 (defsubst gnus-native-method-p (method)
3756 "Return whether METHOD is the native select method."
3757 (gnus-method-equal method gnus-select-method))
3759 (defsubst gnus-secondary-method-p (method)
3760 "Return whether METHOD is a secondary select method."
3761 (let ((methods gnus-secondary-select-methods)
3762 (gmethod (inline (gnus-server-get-method nil method))))
3763 (while (and methods
3764 (not (gnus-method-equal
3765 (inline (gnus-server-get-method nil (car methods)))
3766 gmethod)))
3767 (setq methods (cdr methods)))
3768 methods))
3770 (defun gnus-method-simplify (method)
3771 "Return the shortest uniquely identifying string or method for METHOD."
3772 (cond ((stringp method)
3773 method)
3774 ((gnus-native-method-p method)
3775 nil)
3776 ((gnus-secondary-method-p method)
3777 (format "%s:%s" (nth 0 method) (nth 1 method)))
3778 (t
3779 method)))
3781 (defun gnus-groups-from-server (server)
3782 "Return a list of all groups that are fetched from SERVER."
3783 (let ((alist (cdr gnus-newsrc-alist))
3784 info groups)
3785 (while (setq info (pop alist))
3786 (when (gnus-server-equal (gnus-info-method info) server)
3787 (push (gnus-info-group info) groups)))
3788 (sort groups 'string<)))
3790 (defun gnus-group-foreign-p (group)
3791 "Say whether a group is foreign or not."
3792 (and (not (gnus-group-native-p group))
3793 (not (gnus-group-secondary-p group))))
3795 (defun gnus-group-native-p (group)
3796 "Say whether the group is native or not."
3797 (not (string-match ":" group)))
3799 (defun gnus-group-secondary-p (group)
3800 "Say whether the group is secondary or not."
3801 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3803 (defun gnus-parameters-get-parameter (group)
3804 "Return the group parameters for GROUP from `gnus-parameters'."
3805 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3806 case-fold-search
3807 gnus-parameters-case-fold-search))
3808 params-list)
3809 (dolist (elem gnus-parameters)
3810 (when (string-match (car elem) group)
3811 (setq params-list
3812 (nconc (gnus-expand-group-parameters
3813 (car elem) (cdr elem) group)
3814 params-list))))
3815 params-list))
3817 (defun gnus-expand-group-parameter (match value group)
3818 "Use MATCH to expand VALUE in GROUP."
3819 (let ((start (string-match match group)))
3820 (if start
3821 (let ((matched-string (substring group start (match-end 0))))
3822 ;; Build match groups
3823 (string-match match matched-string)
3824 (replace-match value nil nil matched-string))
3825 group)))
3827 (defun gnus-expand-group-parameters (match parameters group)
3828 "Go through PARAMETERS and expand them according to the match data."
3829 (let (new)
3830 (dolist (elem parameters)
3831 (if (and (stringp (cdr elem))
3833 (push (cons (car elem)
3834 (gnus-expand-group-parameter match (cdr elem) group))
3835 new)
3836 (push elem new)))
3837 new))
3839 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3840 "For GROUP, return the value of SYMBOL.
3842 You should call this in the `gnus-group-buffer' buffer.
3843 The function `gnus-group-find-parameter' will do that for you."
3844 ;; The speed trick: No cons'ing and quit early.
3845 (let* ((params (funcall gnus-group-get-parameter-function group))
3846 ;; Start easy, check the "real" group parameters.
3847 (simple-results
3848 (gnus-group-parameter-value params symbol allow-list t)))
3849 (if simple-results
3850 ;; Found results; return them.
3851 (car simple-results)
3852 ;; We didn't find it there, try `gnus-parameters'.
3853 (let ((result nil)
3854 (head nil)
3855 (tail gnus-parameters))
3856 ;; A good old-fashioned non-cl loop.
3857 (while tail
3858 (setq head (car tail)
3859 tail (cdr tail))
3860 ;; The car is regexp matching for matching the group name.
3861 (when (string-match (car head) group)
3862 ;; The cdr is the parameters.
3863 (setq result (gnus-group-parameter-value (cdr head)
3864 symbol allow-list))
3865 (when result
3866 ;; Expand if necessary.
3868 (setq result (gnus-expand-group-parameter (car head)
3869 result group))))))
3870 ;; Done.
3871 result))))
3873 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3874 "Return the group parameters for GROUP.
3875 If SYMBOL, return the value of that symbol in the group parameters.
3877 If you call this function inside a loop, consider using the faster
3878 `gnus-group-fast-parameter' instead."
3879 (with-current-buffer gnus-group-buffer
3880 (if symbol
3881 (gnus-group-fast-parameter group symbol allow-list)
3882 (nconc
3883 (copy-sequence
3884 (funcall gnus-group-get-parameter-function group))
3885 (gnus-parameters-get-parameter group)))))
3887 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3888 "Return the group parameters for GROUP.
3889 If SYMBOL, return the value of that symbol in the group parameters.
3890 If ALLOW-LIST, also allow list as a result.
3891 Most functions should use `gnus-group-find-parameter', which
3892 also examines the topic parameters."
3893 (let ((params (gnus-info-params (gnus-get-info group))))
3894 (if symbol
3895 (gnus-group-parameter-value params symbol allow-list)
3896 params)))
3898 (defun gnus-group-parameter-value (params symbol &optional
3899 allow-list present-p)
3900 "Return the value of SYMBOL in group PARAMS.
3901 If ALLOW-LIST, also allow list as a result."
3902 ;; We only wish to return group parameters (dotted lists) and
3903 ;; not local variables, which may have the same names.
3904 ;; But first we handle single elements...
3905 (or (car (memq symbol params))
3906 ;; Handle alist.
3907 (let (elem)
3908 (catch 'found
3909 (while (setq elem (pop params))
3910 (when (and (consp elem)
3911 (eq (car elem) symbol)
3912 (or allow-list
3913 (atom (cdr elem))))
3914 (throw 'found (if present-p (list (cdr elem))
3915 (cdr elem)))))))))
3917 (defun gnus-group-add-parameter (group param)
3918 "Add parameter PARAM to GROUP."
3919 (let ((info (gnus-get-info group)))
3920 (when info
3921 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3922 ;; Cons the new param to the old one and update.
3923 (gnus-group-set-info (cons param (gnus-info-params info))
3924 group 'params))))
3926 (defun gnus-group-set-parameter (group name value)
3927 "Set parameter NAME to VALUE in GROUP.
3928 GROUP can also be an INFO structure."
3929 (let ((info (if (listp group)
3930 group
3931 (gnus-get-info group))))
3932 (when info
3933 (gnus-group-remove-parameter group name)
3934 (let ((old-params (gnus-info-params info))
3935 (new-params (list (cons name value))))
3936 (while old-params
3937 (when (or (not (listp (car old-params)))
3938 (not (eq (caar old-params) name)))
3939 (setq new-params (append new-params (list (car old-params)))))
3940 (setq old-params (cdr old-params)))
3941 (if (listp group)
3942 (gnus-info-set-params info new-params t)
3943 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3945 (defun gnus-group-remove-parameter (group name)
3946 "Remove parameter NAME from GROUP.
3947 GROUP can also be an INFO structure."
3948 (let ((info (if (listp group)
3949 group
3950 (gnus-get-info group))))
3951 (when info
3952 (let ((params (gnus-info-params info)))
3953 (when params
3954 (setq params (delq name params))
3955 (while (assq name params)
3956 (gnus-alist-pull name params))
3957 (gnus-info-set-params info params))))))
3959 (defun gnus-group-add-score (group &optional score)
3960 "Add SCORE to the GROUP score.
3961 If SCORE is nil, add 1 to the score of GROUP."
3962 (let ((info (gnus-get-info group)))
3963 (when info
3964 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3966 (defun gnus-short-group-name (group &optional levels)
3967 "Collapse GROUP name LEVELS.
3968 Select methods are stripped and any remote host name is stripped down to
3969 just the host name."
3970 (let* ((name "")
3971 (foreign "")
3972 (depth 0)
3973 (skip 1)
3974 (levels (or levels
3975 gnus-group-uncollapsed-levels
3976 (progn
3978 (setq skip (match-end 0)
3979 depth (+ depth 1)))
3980 depth))))
3981 ;; Separate foreign select method from group name and collapse.
3982 ;; If method contains a server, collapse to non-domain server name,
3983 ;; otherwise collapse to select method.
3984 (let* ((colon (string-match ":" group))
3985 (server (and colon (substring group 0 colon)))
3986 (plus (and server (string-match "+" server))))
3987 (when server
3988 (if plus
3989 (setq foreign (substring server (+ 1 plus)
3991 group (substring group (+ 1 colon)))
3992 (setq foreign server
3993 group (substring group (+ 1 colon))))
3994 (setq foreign (concat foreign ":")))
3995 ;; Collapse group name leaving LEVELS uncollapsed elements
3996 (let* ((slist (split-string group "/"))
3997 (slen (length slist))
3999 (dlen (length dlist))
4000 glist
4001 glen
4002 gsep
4003 res)
4004 (if (> slen dlen)
4005 (setq glist slist
4006 glen slen
4007 gsep "/")
4008 (setq glist dlist
4009 glen dlen
4010 gsep "."))
4011 (setq levels (- glen levels))
4012 (dolist (g glist)
4013 (push (if (>= (decf levels) 0)
4014 (if (zerop (length g))
4015 ""
4016 (substring g 0 1))
4017 g)
4018 res))
4019 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4021 (defun gnus-narrow-to-body ()
4022 "Narrow to the body of an article."
4023 (narrow-to-region
4024 (progn
4025 (goto-char (point-min))
4027 (point-max)))
4028 (point-max)))
4030 \f
4031 ;;;
4032 ;;; Kill file handling.
4033 ;;;
4035 (defun gnus-apply-kill-file ()
4036 "Apply a kill file to the current newsgroup.
4037 Returns the number of articles marked as read."
4038 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4039 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4040 (gnus-apply-kill-file-internal)
4041 0))
4043 (defun gnus-kill-save-kill-buffer ()
4044 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4045 (when (get-file-buffer file)
4046 (with-current-buffer (get-file-buffer file)
4047 (when (buffer-modified-p)
4048 (save-buffer))
4049 (kill-buffer (current-buffer))))))
4051 (defcustom gnus-kill-file-name "KILL"
4052 "Suffix of the kill files."
4053 :group 'gnus-score-kill
4054 :group 'gnus-score-files
4055 :type 'string)
4057 (defun gnus-newsgroup-kill-file (newsgroup)
4058 "Return the name of a kill file name for NEWSGROUP.
4059 If NEWSGROUP is nil, return the global kill file name instead."
4060 (cond
4061 ;; The global KILL file is placed at top of the directory.
4062 ((or (null newsgroup)
4063 (string-equal newsgroup ""))
4064 (expand-file-name gnus-kill-file-name
4065 gnus-kill-files-directory))
4066 ;; Append ".KILL" to newsgroup name.
4067 ((gnus-use-long-file-name 'not-kill)
4068 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4069 "." gnus-kill-file-name)
4070 gnus-kill-files-directory))
4071 ;; Place "KILL" under the hierarchical directory.
4072 (t
4073 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4074 "/" gnus-kill-file-name)
4075 gnus-kill-files-directory))))
4077 ;;; Server things.
4079 (defun gnus-member-of-valid (symbol group)
4081 (memq symbol (assoc
4082 (symbol-name (car (gnus-find-method-for-group group)))
4083 gnus-valid-select-methods)))
4085 (defun gnus-method-option-p (method option)
4086 "Return non-nil if select METHOD has OPTION as a parameter."
4087 (when (stringp method)
4088 (setq method (gnus-server-to-method method)))
4089 (memq option (assoc (format "%s" (car method))
4090 gnus-valid-select-methods)))
4092 (defun gnus-similar-server-opened (method)
4093 "Return non-nil if we have a similar server opened.
4094 This is defined as a server with the same name, but different
4095 parameters."
4096 (let ((opened gnus-opened-servers)
4097 open)
4098 (while (and method opened)
4099 (setq open (car (pop opened)))
4100 ;; Type and name are the same...
4101 (when (and (equal (car method) (car open))
4102 (equal (cadr method) (cadr open))
4103 ;; ... but the rest of the parameters differ.
4104 (not (gnus-methods-sloppily-equal method open)))
4105 (setq method nil)))
4106 (not method)))
4108 (defun gnus-server-extend-method (group method)
4109 ;; This function "extends" a virtual server. If the server is
4110 ;; "hello", and the select method is ("hello" (my-var "something"))
4111 ;; in the group "alt.alt", this will result in a new virtual server
4112 ;; called "hello+alt.alt".
4113 (if (or (not (inline (gnus-similar-server-opened method)))
4114 (not (cddr method)))
4115 method
4116 (setq method
4117 `(,(car method) ,(concat (cadr method) "+" group)
4118 (,(intern (format "%s-address" (car method))) ,(cadr method))
4119 ,@(cddr method)))
4120 (push method gnus-extended-servers)
4121 method))
4123 (defun gnus-server-status (method)
4124 "Return the status of METHOD."
4125 (nth 1 (assoc method gnus-opened-servers)))
4127 (defun gnus-group-name-to-method (group)
4128 "Guess a select method based on GROUP."
4129 (if (string-match ":" group)
4130 (let ((server (substring group 0 (match-beginning 0))))
4132 (list (intern (substring server 0 (match-beginning 0)))
4133 (substring server (match-end 0)))
4134 (list (intern server) "")))
4135 gnus-select-method))
4137 (defun gnus-server-string (server)
4138 "Return a readable string that describes SERVER."
4139 (let* ((server (gnus-server-to-method server))
4140 (address (nth 1 server)))
4141 (if (and address
4142 (not (zerop (length address))))
4143 (format "%s using %s" address (car server))
4144 (format "%s" (car server)))))
4146 (defun gnus-same-method-different-name (method)
4147 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4148 (unless (assq slot (cddr method))
4149 (setq method
4150 (append method (list (list slot (nth 1 method)))))))
4151 (let ((methods gnus-extended-servers)
4152 open found)
4153 (while (and (not found)
4154 (setq open (pop methods)))
4155 (when (and (eq (car method) (car open))
4156 (gnus-sloppily-equal-method-parameters method open))
4157 (setq found open)))
4158 found))
4160 (defun gnus-find-method-for-group (group &optional info)
4161 "Find the select method that GROUP uses."
4162 (or gnus-override-method
4163 (and (not group)
4164 gnus-select-method)
4165 (and (not (gnus-group-entry group))
4166 ;; Killed or otherwise unknown group.
4167 (or
4168 ;; If we know a virtual server by that name, return its method.
4169 (gnus-server-to-method (gnus-group-server group))
4170 ;; Guess a new method as last resort.
4171 (gnus-group-name-to-method group)))
4172 (let ((info (or info (gnus-get-info group)))
4173 method)
4174 (if (or (not info)
4175 (not (setq method (gnus-info-method info)))
4176 (equal method "native"))
4177 gnus-select-method
4178 (setq method
4179 (cond ((stringp method)
4180 (inline (gnus-server-to-method method)))
4181 ((stringp (cadr method))
4182 (or
4183 (inline
4184 (gnus-same-method-different-name method))
4185 (inline (gnus-server-extend-method group method))))
4186 (t
4187 method)))
4188 (cond ((equal (cadr method) "")
4189 method)
4190 ((null (cadr method))
4191 (list (car method) ""))
4192 (t
4193 (gnus-server-add-address method)))))))
4195 (defun gnus-methods-using (feature)
4196 "Find all methods that have FEATURE."
4197 (let ((valids gnus-valid-select-methods)
4198 outs)
4199 (while valids
4200 (when (memq feature (car valids))
4201 (push (car valids) outs))
4202 (setq valids (cdr valids)))
4203 outs))
4205 (eval-and-compile
4206 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4208 (defun gnus-read-group (prompt &optional default)
4209 "Prompt the user for a group name.
4210 Disallow invalid group names."
4211 (let ((prefix "")
4212 group)
4213 (while (not group)
4214 (when (string-match
4215 gnus-invalid-group-regexp
4216 (setq group (read-string (concat prefix prompt)
4217 (cons (or default "") 0)
4218 'gnus-group-history)))
4219 (let ((match (match-string 0 group)))
4220 ;; Might be okay (e.g. for nnimap), so ask the user:
4222 (message-y-or-n-p
4223 "Proceed and create group anyway? " t
4226 Usually, it's dangerous to create a group with this name, because it's not
4227 supported by all back ends and servers. On IMAP servers it should work,
4228 though. If you are really sure, you can proceed anyway and create the group.
4230 You may customize the variable `gnus-invalid-group-regexp', which currently is
4234 group nil)))))
4235 group))
4237 (defun gnus-read-method (prompt)
4238 "Prompt the user for a method.
4239 Allow completion over sensible values."
4240 (let* ((open-servers
4241 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4242 gnus-opened-servers))
4243 (valid-methods
4244 (let (methods)
4245 (dolist (method gnus-valid-select-methods)
4246 (if (or (memq 'prompt-address method)
4247 (not (assoc (format "%s:" (car method)) open-servers)))
4248 (push method methods)))
4249 methods))
4250 (servers
4251 (append valid-methods
4252 open-servers
4253 gnus-predefined-server-alist
4254 gnus-server-alist))
4255 (method
4256 (gnus-completing-read
4257 prompt (mapcar 'car servers)
4258 t nil 'gnus-method-history)))
4259 (cond
4260 ((equal method "")
4261 (setq method gnus-select-method))
4262 ((assoc method gnus-valid-select-methods)
4263 (let ((address (if (memq 'prompt-address
4264 (assoc method gnus-valid-select-methods))
4265 (read-string "Address: ")
4266 "")))
4267 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4268 (list (intern method) address))))
4269 ((assoc method servers)
4270 method)
4271 (t
4272 (list (intern method) "")))))
4274 ;;; Agent functions
4276 (defun gnus-agent-method-p (method-or-server)
4277 "Say whether METHOD is covered by the agent."
4278 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4279 (let* ((method (if (stringp method-or-server)
4280 (gnus-server-to-method method-or-server)
4281 method-or-server))
4282 (server (gnus-method-to-server method t)))
4283 (setq gnus-agent-method-p-cache
4284 (cons method-or-server
4285 (member server gnus-agent-covered-methods)))))
4286 (cdr gnus-agent-method-p-cache))
4288 (defun gnus-online (method)
4289 (not
4290 (if gnus-plugged
4291 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4292 (gnus-agent-method-p method))))
4294 ;;; User-level commands.
4296 ;;;###autoload
4297 (defun gnus-slave-no-server (&optional arg)
4298 "Read network news as a slave, without connecting to the local server."
4299 (interactive "P")
4300 (gnus-no-server arg t))
4302 ;;;###autoload
4303 (defun gnus-no-server (&optional arg slave)
4304 "Read network news.
4305 If ARG is a positive number, Gnus will use that as the startup
4306 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4307 non-nil and not a positive number, Gnus will prompt the user for the
4308 name of an NNTP server to use.
4309 As opposed to `gnus', this command will not connect to the local
4310 server."
4311 (interactive "P")
4312 (gnus-no-server-1 arg slave))
4314 ;;;###autoload
4315 (defun gnus-slave (&optional arg)
4316 "Read news as a slave."
4317 (interactive "P")
4318 (gnus arg nil 'slave))
4320 ;;;###autoload
4321 (defun gnus-other-frame (&optional arg display)
4322 "Pop up a frame to read news.
4323 This will call one of the Gnus commands which is specified by the user
4324 option `gnus-other-frame-function' (default `gnus') with the argument
4325 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4326 optional second argument DISPLAY should be a standard display string
4328 omitted or the function `make-frame-on-display' is not available, the
4329 current display is used."
4330 (interactive "P")
4331 (if (fboundp 'make-frame-on-display)
4332 (unless display
4333 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4334 (setq display nil))
4335 (let ((alive (gnus-alive-p)))
4336 (unless (and alive
4337 (catch 'found
4338 (walk-windows
4339 (lambda (window)
4340 (when (and (or (not display)
4341 (equal display
4342 (gnus-frame-or-window-display-name
4343 window)))
4344 (with-current-buffer (window-buffer window)
4346 (symbol-name major-mode))))
4347 (gnus-select-frame-set-input-focus
4348 (setq gnus-other-frame-object (window-frame window)))
4349 (select-window window)
4350 (throw 'found t)))
4351 'ignore t)))
4352 (gnus-select-frame-set-input-focus
4353 (setq gnus-other-frame-object
4354 (if display
4355 (make-frame-on-display display gnus-other-frame-parameters)
4356 (make-frame gnus-other-frame-parameters))))
4357 (if alive
4358 (switch-to-buffer gnus-group-buffer)
4359 (funcall gnus-other-frame-function arg)
4360 (add-hook 'gnus-exit-gnus-hook
4361 (lambda nil
4362 (when (and (frame-live-p gnus-other-frame-object)
4363 (cdr (frame-list)))
4364 (delete-frame gnus-other-frame-object))
4365 (setq gnus-other-frame-object nil)))))))
4367 ;;;###autoload
4368 (defun gnus (&optional arg dont-connect slave)
4369 "Read network news.
4370 If ARG is non-nil and a positive number, Gnus will use that as the
4371 startup level. If ARG is non-nil and not a positive number, Gnus will
4372 prompt the user for the name of an NNTP server to use."
4373 (interactive "P")
4374 ;; When using the development version of Gnus, load the gnus-load
4375 ;; file.
4376 (unless (string-match "^Gnus" gnus-version)
4377 (load "gnus-load" nil t))
4378 (unless (byte-code-function-p (symbol-function 'gnus))
4379 (message "You should byte-compile Gnus")
4380 (sit-for 2))
4381 (let ((gnus-action-message-log (list nil)))
4382 (gnus-1 arg dont-connect slave)
4383 (gnus-final-warning)))
4385 (autoload 'debbugs-gnu "debbugs-gnu")
4386 (defun gnus-list-debbugs ()
4387 "List all open Gnus bug reports."
4388 (interactive)
4389 (debbugs-gnu nil "gnus"))
4391 ;; Allow redefinition of Gnus functions.
4393 (gnus-ems-redefine)
4395 (provide 'gnus)
4397 ;;; gnus.el ends here