| blob | 674c8d2c0adf53e0caea1c4fb936db072043c734 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;;; Code:
40 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
45 "Dealing with formatting issues."
49 "Group character set issues."
55 "Cache interface."
60 "Article Registry."
64 "Starting your favorite newsreader."
68 "Server options at startup."
71 ;; These belong to gnus-group.el.
73 "Group buffers."
78 "Foreign groups."
83 "Automatic subscription of new groups."
87 "Group levels."
92 "Selecting a Group."
97 "Showing slices of the group list."
102 "Sorting the group buffer."
108 "Various group options."
112 ;; These belong to gnus-sum.el.
114 "Summary buffers."
119 "Leaving summary buffers."
124 "Marks used in summary buffers."
129 "Ordering articles according to replies."
134 "Formatting of the summary buffer."
139 "Choosing Articles."
144 "Summary movement commands."
149 "Show pictures of people, domains, and newsgroups."
153 "Mail group commands."
158 "Sorting the summary buffer."
163 "Highlighting and menus in the summary buffer."
169 "Various summary buffer options."
174 "Pick mode in the summary buffer."
180 "Tree display of threads in the summary buffer."
185 ;; Belongs to gnus-uu.el
187 "Viewing extracted files."
191 ;; Belongs to gnus-score.el
193 "Score and kill file handling."
197 "Kill files."
201 "Adaptive score files."
205 "Default values for score files."
209 "Expiring score rules."
213 "Decaying score rules."
217 "Score and kill file names."
222 "Various scoring and killing options."
225 ;; Other
227 "Options controlling the visual fluff."
232 "Offline support for Gnus."
236 "Files used by Gnus."
240 "Auto save file."
245 "Storing Gnus state."
249 "Options related to newsservers and other servers used by Gnus."
253 "Highlighting and menus in the server buffer."
258 "Composing replies and followups in Gnus."
262 "Meta variables controlling major portions of Gnus.
263 In general, modifying these variables does not take affect until Gnus
264 is restarted, and sometimes reloaded."
268 "Other Gnus options."
273 "Variables for controlling the Gnus MIME interface."
277 "Exiting gnus."
282 "Frivolous Gnus extensions."
293 "If non-nil, the startup message will not be displayed.
294 This variable is used before `.gnus.el' is loaded, so it should
295 be set in `.emacs' instead."
300 "If non-nil, play the Gnus jingle at startup."
333 0 5
342 gnus-mode-line-image-cache)
344 "This is %s, %s."
346 str)
348 line)))
354 ;;(defalias 'gnus-decode-rfc1522 'ignore)
355 )
357 ;; We define these group faces here to avoid the display
358 ;; update forced when creating new faces.
368 ()))
379 ()))
390 ()))
401 ()))
412 ()))
418 ())
421 ())
423 ()))
434 ()))
440 ())
443 ())
445 ()))
456 ()))
462 ())
465 ())
467 ()))
478 ()))
484 ())
487 ())
489 ()))
500 ()))
511 ()))
577 ()))
602 ;; Summary mode faces.
643 ()))
676 ()))
718 ()))
755 ()))
759 ;;;
760 ;;; Gnus buffers
761 ;;;
766 "Do the same as `get-buffer-create', but store the created buffer."
771 "Add the current buffer to the list of Gnus buffers."
775 "Kill BUFFER and remove from the list of Gnus buffers."
782 "Return a list of live Gnus buffers."
791 gnus-buffers)
793 ;;; Splash screen.
808 ()))
823 "Indent rigidly using only spaces and no tabs."
829 ;; We translate tabs into spaces -- not everybody uses
830 ;; an 8-character tab.
837 ;;(format "%02x%02x%02x" 114 66 20) "724214"
861 "*Color styles used for the Gnus logo."
863 gnus-logo-color-alist))
871 "Insert startup message in current buffer."
872 ;; Insert the message.
881 :color-symbols
887 ;; Account for the pbm's blackground.
891 ;; Account for the xbm's blackground.
902 t))))
906 _ ___ _ _
907 _ ___ __ ___ __ _ ___
908 __ _ ___ __ ___
909 _ ___ _
910 _ _ __ _
911 ___ __ _
912 __ _
913 _ _ _
914 _ _ _
915 _ _ _
916 __ ___
917 _ _ _ _
918 _ _
919 _ _
920 _ _
921 _
922 __
924 "
926 ;; And then hack it.
935 ;; Fontify some.
949 ;;; Do the rest.
955 "Alist of group parameters.
957 For example:
959 (gnus-use-scoring nil)
960 (gnus-summary-line-format
962 (gcc-self . t)
963 (display . all))
966 (broken-reply-to . t)))"
975 "Define a group parameter PARAM.
976 REST is a plist of following:
977 :type One of `bool', `list' or nil.
978 :function The name of the function.
979 :function-document The documentation of the function.
980 :parameter-type The type for customizing the parameter.
981 :parameter-document The documentation for the parameter.
982 :variable The name of the variable.
983 :variable-document The documentation for the variable.
984 :variable-group The group for customizing the variable.
985 :variable-type The type for customizing the variable.
986 :variable-default The default value of the variable."
1003 'progn
1005 ,variable-document
1011 gnus-group-parameters-more))
1014 ,parameter-type
1018 ,function-document
1020 val)
1023 t)
1028 (,variable
1030 elem value)
1038 ,function-document
1042 elem value)
1049 'value
1054 All other Gnus file and directory variables are initialized from this variable."
1060 "*Directory variable from which all other Gnus file variables are derived.
1062 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1063 This means that other directory variables that are initialized from
1064 this variable won't be set properly if you set this variable in `.gnus.el'.
1065 Set this variable in `.emacs' instead."
1070 "*Default directory for all Gnus buffers."
1073 directory))
1075 ;; Site dependent variables. These variables should be defined in
1076 ;; paths.el.
1079 "Specify a default NNTP server.
1080 This variable should be defined in paths.el, and should never be set
1081 by the user.
1082 If you want to change servers, you should use `gnus-select-method'.
1085 ;; Don't touch this variable.
1088 This is an obsolete variable, which is scarcely used. If you use an
1089 nntp server for your newsgroup and want to change the port number
1090 used to 899, you would say something along these lines:
1095 "A file with only the name of the nntp server in it."
1101 "Find default nntp server.
1102 Check the NNTPSERVER environment variable and the
1103 `gnus-nntpserver-file' file."
1119 gnus-default-nntp-server)
1123 nil
1126 "Default method for selecting a newsgroup.
1127 This variable should be a list, where the first element is how the
1128 news is to be fetched, the second is the address.
1131 NNTP, you could say:
1135 If you want to use your local spool, say:
1137 \(setq gnus-select-method (list 'nnspool (system-name)))
1139 If you use this variable, you must set `gnus-nntp-server' to nil.
1141 There is a lot more to know about select methods and virtual servers -
1142 see the manual for details."
1147 "*Method used for archiving messages you've sent.
1148 This should be a mail method."
1152 gnus-select-method))
1155 "*Name of the group in which to save the messages you've written.
1156 This can either be a string; a list of strings; or an alist
1157 of regexps/functions/forms to be evaluated to return a string (or a list
1158 of strings). The functions are called with the name of the current
1159 group (or nil) as a parameter.
1161 If you want to save your mail in one group and the news articles you
1162 write in another group, you could say something like:
1164 \(setq gnus-message-archive-group
1165 '((if (message-news-p)
1169 Normally the group names returned by this variable should be
1171 However, you may wish to store the message on some other server. In
1172 that case, just return a fully prefixed name of the group --
1176 function
1177 sexp
1178 string))
1181 "List of NNTP servers that the user can choose between interactively.
1182 To make Gnus query you for a server, you have to give `gnus' a
1183 non-numeric prefix - `C-u M-x gnus', in short."
1188 "*The name of the host running the NNTP server.
1189 This variable is semi-obsolete. Use the `gnus-select-method'
1190 variable instead."
1193 string))
1196 "A list of secondary methods that will be used for reading news.
1197 This is a list where each element is a complete select method (see
1198 `gnus-select-method').
1200 If, for instance, you want to read your mail with the nnml back end,
1201 you could set this variable:
1209 "Default default new newsgroups the first time Gnus is run.
1213 "Local domain name without a host name.
1214 The DOMAINNAME environment variable is used instead if it is defined.
1215 If the function `system-name' returns the full Internet name, there is
1216 no need to set this variable."
1219 string))
1222 "String with a description of what organization (if any) the user belongs to.
1225 ;; Customization variables
1228 "Preferred method for fetching an article by Message-ID.
1229 If you are reading news from the local spool (with nnspool), fetching
1230 articles by Message-ID is painfully slow. By setting this method to an
1231 nntp method, you might get acceptable results.
1233 The value of this variable must be a valid select method as discussed
1234 in the documentation of `gnus-select-method'.
1236 It can also be a list of select methods, as well as the special symbol
1237 `current', which means to use the current select method. If it is a
1238 list, Gnus will try all the methods in the list until it finds a match."
1243 gnus-select-method
1251 gnus-select-method))))
1255 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1256 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1257 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1258 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1259 "/ftp@rtfm.mit.edu:/pub/usenet/"
1260 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1261 "/ftp@ftp.sunet.se:/pub/usenet/"
1262 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1263 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1265 "*Directory where the group FAQs are stored.
1266 This will most commonly be on a remote machine, and the file will be
1267 fetched by ange-ftp.
1269 This variable can also be a list of directories. In that case, the
1270 first element in the list will be used by default. The others can
1271 be used when being prompted for a site.
1273 Note that Gnus uses an aol machine as the default directory. If this
1274 feels fundamentally unclean, just think of it as a way to finally get
1275 something of value back from them.
1277 If the default site is too slow, try one of these:
1279 North America: mirrors.aol.com /pub/rtfm/usenet
1280 ftp.seas.gwu.edu /pub/rtfm
1281 rtfm.mit.edu /pub/usenet
1282 Europe: ftp.uni-paderborn.de /pub/FAQ
1283 src.doc.ic.ac.uk /usenet/news-FAQS
1284 ftp.sunet.se /pub/usenet
1285 ftp.pasteur.fr /pub/FAQ
1286 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1287 hwarang.postech.ac.kr /pub/usenet
1288 ftp.hk.super.net /mirror/faqs"
1315 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1316 When FORM is evaluated `name' is bound to the name of the group."
1322 "*Non-nil means that control messages are displayed using `browse-url'.
1323 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1324 group."
1330 "*Non-nil means that cross referenced articles will be marked as read.
1331 If nil, ignore cross references. If t, mark articles as read in
1332 subscribed newsgroups. If neither t nor nil, mark as read in all
1333 newsgroups."
1341 "*Process mark."
1347 "*The number of articles which indicates a large newsgroup.
1348 If the number of articles in a newsgroup is greater than this value,
1349 confirmation is required for selecting the newsgroup.
1350 If it is nil, no confirmation is required."
1353 integer))
1356 "*Non-nil means that the default name of a file to save articles in is the group name.
1357 If it's nil, the directory form of the group name is used instead.
1359 If this variable is a list, and the list contains the element
1360 `not-score', long file names will not be used for score files; if it
1361 contains the element `not-save', long file names will not be used for
1362 saving; and if it contains the element `not-kill', long file names
1363 will not be used for kill files.
1365 Note that the default for this variable varies according to what system
1366 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1367 to nil while on all other systems it defaults to t."
1385 "*If non-nil, save group scoring info."
1391 "*If non-nil, allow undoing in Gnus group mode buffers."
1396 "*If non-nil, use some adaptive scoring scheme.
1397 If a list, then the values `word' and `line' are meaningful. The
1398 former will perform adaption on individual words in the subject
1399 header while `line' will perform adaption on several headers."
1405 "*If nil, Gnus will ignore the article cache.
1406 If `passive', it will allow entering (and reading) articles
1407 explicitly entered into the cache. If anything else, use the
1408 cache to the full extent of the law."
1416 "*If non-nil, display a thread tree buffer."
1421 "*If non-nil, use GroupLens ratings."
1426 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1427 If it is a number N, then Gnus will only keep the last N articles
1428 read. If it is neither nil nor a number, Gnus will keep all read
1429 articles. This is not a good idea."
1432 integer
1437 "*If non-nil, Gnus will read NoCeM cancel messages."
1442 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1447 "*If non-nil, enable scoring."
1453 "*A hook called when preparing to exit from the summary buffer.
1454 It calls `gnus-summary-expire-articles' by default."
1459 "*Non-nil means that you are a Usenet novice.
1460 If non-nil, verbose messages may be displayed and confirmations may be
1461 required."
1466 "*Non-nil means that you will never be asked for confirmation about anything.
1467 That doesn't mean *anything* anything; particularly destructive
1468 commands will still require prompting."
1473 "*If non-nil, require your confirmation when catching up a group."
1478 "*If non-nil, require your confirmation when exiting Gnus."
1483 "*Function for extracting address components from a From header.
1484 Two pre-defined function exist: `gnus-extract-address-components',
1485 which is the default, quite fast, and too simplistic solution, and
1486 `mail-extract-address-components', which works much better, but is
1487 slower."
1494 "*If non-nil, display clickable icons."
1499 "String used to separate shell commands."
1531 "*An alist of valid select methods.
1532 The first element of each list lists should be a string with the name
1533 of the select method. The other elements may be the category of
1534 this method (i. e., `post', `mail', `none' or whatever) or other
1535 properties that this method has (like being respoolable).
1536 If you implement a new select method, all you should have to change is
1537 this variable. I think."
1552 "Recomputes the select-method widget based on the value of
1553 `gnus-valid-select-methods'."
1555 "Widget for entering a select method."
1562 gnus-valid-select-methods)
1566 :inline t
1568 variable
1574 "List of buffers that should update their mode lines.
1575 The list may contain the symbols `group', `article', `tree' and
1576 `summary'. If the corresponding symbol is present, Gnus will keep
1577 that mode line updated with information that may be pertinent.
1578 If this variable is nil, screen refresh may be quicker."
1585 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1587 "*Max length of mode-line non-string contents.
1588 If this is nil, Gnus will take space as is needed, leaving the rest
1589 of the mode line intact. Note that the default of nil is unlikely
1590 to be desirable; see the manual for further details."
1593 integer))
1595 ;; There should be special validation for this.
1600 to-address
1601 :function-document
1602 "Return GROUP's to-address."
1603 :variable-document
1604 "*Alist of group regexps and correspondent to-addresses."
1605 :variable-group gnus-group-parameter
1608 This will be used when doing followups and posts.
1610 This is primarily useful in mail groups that represent closed
1611 mailing lists--mailing lists where it's expected that everybody that
1612 writes to the mailing list is subscribed to it. Since using this
1613 parameter ensures that the mail only goes to the mailing list itself,
1614 it means that members won't receive two copies of your followups.
1616 Using `to-address' will actually work whether the group is foreign or
1617 not. Let's say there's a group on the server that is called
1618 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1619 articles from a mail-to-news gateway. Posting directly to this group
1620 is therefore impossible--you have to send mail to the mailing list
1621 address instead.
1623 The gnus-group-split mail splitting mechanism will behave as if this
1627 to-list
1628 :function-document
1629 "Return GROUP's to-list."
1630 :variable-document
1631 "*Alist of group regexps and correspondent to-lists."
1632 :variable-group gnus-group-parameter
1635 This address will be used when doing a `a' in the group.
1637 It is totally ignored when doing a followup--except that if it is
1638 present in a news group, you'll get mail group semantics when doing
1639 `f'.
1641 The gnus-group-split mail splitting mechanism will behave as if this
1645 subscribed
1646 :type bool
1647 :function-document
1648 "Return GROUP's subscription status."
1649 :variable-document
1650 "*Groups which are automatically considered subscribed."
1651 :variable-group gnus-group-parameter
1654 Gnus assumed that you are subscribed to the To/List address.
1656 When constructing a list of subscribed groups using
1657 `gnus-find-subscribed-addresses', Gnus includes the To address given
1661 auto-expire
1662 :type bool
1663 :function gnus-group-auto-expirable-p
1664 :function-document
1665 "Check whether GROUP is auto-expirable or not."
1666 :variable gnus-auto-expirable-newsgroups
1667 :variable-default nil
1668 :variable-document
1669 "*Groups in which to automatically mark read articles as expirable.
1670 If non-nil, this should be a regexp that should match all groups in
1671 which to perform auto-expiry. This only makes sense for mail groups."
1672 :variable-group nnmail-expire
1674 regexp)
1676 :parameter-document
1680 total-expire
1681 :type bool
1682 :function gnus-group-total-expirable-p
1683 :function-document
1684 "Check whether GROUP is total-expirable or not."
1685 :variable gnus-total-expirable-newsgroups
1686 :variable-default nil
1687 :variable-document
1688 "*Groups in which to perform expiry of all read articles.
1689 Use with extreme caution. All groups that match this regexp will be
1690 expiring - which means that all read articles will be deleted after
1691 \(say) one week. (This only goes for mail groups and the like, of
1692 course.)"
1693 :variable-group nnmail-expire
1695 regexp)
1697 :parameter-document
1698 "All read articles will be put through the expiry process
1700 This happens even if they are not marked as expirable.
1704 charset
1705 :function-document
1706 "Return the default charset of GROUP."
1707 :variable gnus-group-charset-alist
1708 :variable-default
1721 :variable-document
1722 "Alist of regexps (to match group names) and default charsets to be used when reading."
1723 :variable-group gnus-charset
1731 post-method
1732 :type list
1733 :function-document
1734 "Return a posting method for GROUP."
1735 :variable gnus-post-method-alist
1736 :variable-document
1737 "Alist of regexps (to match group names) and method to be used when
1738 posting an article."
1739 :variable-group gnus-group-foreign
1740 :parameter-type
1748 :parameter-document
1752 large-newsgroup-initial
1753 :type integer
1754 :function-document
1755 "Return GROUP's initial input of the number of articles."
1756 :variable-document
1757 "*Alist of group regexps and its initial input of the number of articles."
1758 :variable-group gnus-group-parameter
1764 This number will be prompted as the initial value of the number of
1765 articles to list when the group is a large newsgroup (see
1766 `gnus-large-newsgroup'). If it is nil, the default value is the
1769 ;; The Gnus registry's ignored groups
1771 registry-ignore
1772 :type list
1773 :function-document
1774 "Whether this group should be ignored by the registry."
1775 :variable gnus-registry-ignored-groups
1776 :variable-default nil
1777 :variable-document
1778 "*Groups in which the registry should be turned off."
1779 :variable-group gnus-registry
1786 :parameter-document
1789 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1791 "*Disable the group parameters for spam detection.
1792 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1799 "Spam group classification (requires spam.el).
1800 This group contains spam messages. On summary entry, unread messages
1801 will be marked as spam. On summary exit, the specified spam
1802 processors will be invoked on spam-marked messages, then those
1803 messages will be expired, so the spam processor will only see a
1807 "The ham value for the spam group parameter (requires spam.el).
1808 On summary exit, the specified ham processors will be invoked on
1809 ham-marked messages. Exercise caution, since the ham processor will
1810 see the same message more than once because there is no ham message
1814 spam-contents
1815 :type list
1816 :function-document
1817 "The spam type (spam, ham, or neither) of the group."
1818 :variable gnus-spam-newsgroup-contents
1819 :variable-default nil
1820 :variable-document
1821 "*Groups in which to automatically mark new articles as spam on
1822 summary entry. If non-nil, this should be a list of group name
1823 regexps that should match all groups in which to do automatic spam
1824 tagging, associated with a classification (spam, ham, or neither).
1825 This only makes sense for mail groups."
1826 :variable-group spam
1840 :parameter-document
1841 "The spam classification (spam, ham, or neither) of this group.
1857 "OBSOLETE: The Gmane reporting summary exit spam processor.
1864 "OBSOLETE: The ifile summary exit ham processor.
1868 "OBSOLETE: The Bogofilter summary exit ham processor.
1872 "OBSOLETE: The spam-stat summary exit ham processor.
1876 "OBSOLETE: The whitelist summary exit ham processor.
1880 "OBSOLETE: The BBDB summary exit ham processor.
1884 "OBSOLETE: The ham copy exit ham processor.
1888 "OBSOLETE: The spamoracle summary exit ham processor.
1892 spam-process
1893 :type list
1894 :parameter-type
1897 :value nil
1926 :function-document
1927 "Which spam or ham processors will be applied when the summary is exited."
1928 :variable gnus-spam-process-newsgroups
1929 :variable-default nil
1930 :variable-document
1931 "*Groups in which to automatically process spam or ham articles with
1932 a backend on summary exit. If non-nil, this should be a list of group
1933 name regexps that should match all groups in which to do automatic
1934 spam processing, associated with the appropriate processor."
1935 :variable-group spam
1936 :variable-type
1969 :parameter-document
1973 spam-autodetect
1974 :type list
1975 :parameter-type
1977 :function-document
1978 "Should spam be autodetected (with spam-split) in this group?"
1979 :variable gnus-spam-autodetect
1980 :variable-default nil
1981 :variable-document
1982 "*Groups in which spam should be autodetected when they are entered.
1983 Only unseen articles will be examined, unless
1984 spam-autodetect-recheck-messages is set."
1985 :variable-group spam
1986 :variable-type
1991 boolean))
1992 :parameter-document
1993 "Spam autodetection.
1994 Only unseen articles will be examined, unless
1998 spam-autodetect-methods
1999 :type list
2000 :parameter-type
2017 :function-document
2018 "Methods to be used for autodetection in each group"
2019 :variable gnus-spam-autodetect-methods
2020 :variable-default nil
2021 :variable-document
2022 "*Methods for autodetecting spam per group.
2023 Requires the spam-autodetect parameter. Only unseen articles
2024 will be examined, unless spam-autodetect-recheck-messages is
2025 set."
2026 :variable-group spam
2027 :variable-type
2048 :parameter-document
2049 "Spam autodetection methods.
2050 Requires the spam-autodetect parameter. Only unseen articles
2051 will be examined, unless spam-autodetect-recheck-messages is
2055 spam-process-destination
2056 :type list
2057 :parameter-type
2063 :function-document
2064 "Where spam-processed articles will go at summary exit."
2065 :variable gnus-spam-process-destinations
2066 :variable-default nil
2067 :variable-document
2068 "*Groups in which to explicitly send spam-processed articles to
2069 another group, or expire them (the default). If non-nil, this should
2070 be a list of group name regexps that should match all groups in which
2071 to do spam-processed article moving, associated with the destination
2072 group or nil for explicit expiration. This only makes sense for
2073 mail groups."
2074 :variable-group spam
2075 :variable-type
2086 :parameter-document
2090 ham-process-destination
2091 :type list
2092 :parameter-type
2100 :function-document
2101 "Where ham articles will go at summary exit from a spam group."
2102 :variable gnus-ham-process-destinations
2103 :variable-default nil
2104 :variable-document
2105 "*Groups in which to explicitly send ham articles to
2106 another group, or do nothing (the default). If non-nil, this should
2107 be a list of group name regexps that should match all groups in which
2108 to do ham article moving, associated with the destination
2109 group or nil for explicit ignoring. This only makes sense for
2110 mail groups, and only works in spam groups."
2111 :variable-group spam
2112 :variable-type
2124 :parameter-document
2128 ham-marks
2139 :parameter-document
2140 "Marks considered ham (positively not spam). Such articles will be
2141 processed as ham (non-spam) on group exit. When nil, the global
2142 spam-ham-marks variable takes precedence."
2144 gnus-read-mark
2145 gnus-killed-mark
2146 gnus-kill-file-mark
2147 gnus-low-score-mark))))
2148 :variable-group spam
2149 :variable-document
2153 spam-marks
2162 :parameter-document
2163 "Marks considered spam.
2164 Such articles will be processed as spam on group exit. When nil, the global
2165 spam-spam-marks variable takes precedence."
2167 :variable-group spam
2168 :variable-document
2172 "Number of group name elements to leave alone when making a short group name."
2177 "*If non-nil, once you set a level, Gnus will use this level."
2181 ;; Hooks.
2184 "A hook run while Gnus is loaded."
2189 "A hook called to apply kill files to a group.
2190 This hook is intended to apply a kill file to the selected newsgroup.
2191 The function `gnus-apply-kill-file' is called by default.
2193 Since a general kill file is too heavy to use only for a few
2194 newsgroups, I recommend you to use a lighter hook function. For
2195 example, if you'd like to apply a kill file to articles which contains
2196 a string `rmgroup' in subject in newsgroup `control', you can use the
2197 following hook:
2199 (setq gnus-apply-kill-hook
2200 (list
2201 (lambda ()
2210 "Function run when a group level is changed.
2211 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2215 ;;; Face thingies.
2219 mouse-face
2220 summary-menu group-menu article-menu
2221 tree-highlight menu highlight
2222 browse-menu server-menu
2223 page-marker tree-menu binary-menu pick-menu
2224 grouplens-menu)
2225 "*Enable visual features.
2226 If `visual' is disabled, there will be no menus and few faces. Most of
2227 the visual customization options below will be ignored. Gnus will use
2228 less space and be faster as a result.
2230 This variable can also be a list of visual elements to switch on. For
2231 instance, to switch off all visual things except menus, you can say:
2233 (setq gnus-visual '(menu))
2235 Valid elements include `summary-highlight', `group-highlight',
2236 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2237 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2238 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2239 and `grouplens-menu'."
2260 ;; Byte-compiler warning.
2262 ;; Find out whether the gnus-visual TYPE is wanted.
2266 gnus-visual
2270 t))))
2280 "*Face used for group or summary buffer mouse highlighting.
2281 The line beneath the mouse pointer will be highlighted with this
2282 face."
2295 "Controls use of the agent cache while plugged.
2296 When set, Gnus will prefer using the locally stored content rather
2297 than re-fetching it from the server. You also need to enable
2298 `gnus-agent' for this to have any affect."
2304 "Default charset assumed to be used when viewing non-ASCII characters.
2305 This variable is overridden on a group-to-group basis by the
2306 `gnus-group-charset-alist' variable and is only used on groups not
2307 covered by that variable."
2311 ;; Fixme: Doc reference to agent.
2313 "Whether we want to use the Gnus agent or not.
2315 You may customize gnus-agent to disable its use. However, some
2316 back ends have started to use the agent as a client-side cache.
2317 Disabling the agent may result in noticeable loss of performance."
2323 "Function called by the command `gnus-other-frame'."
2331 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2332 This should be an alist for Emacs, or a plist for XEmacs."
2343 "Which information should be exposed in the User-Agent header.
2345 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2346 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2347 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2348 `emacs-gnus' plus system type\) or a custom string. If you set it to a
2349 string, be sure to use a valid format, see RFC 2616."
2354 emacs-gnus-type)
2356 emacs-gnus-config)
2361 \f
2362 ;;; Internal variables
2367 ; Reset each time gnus-agent-covered-methods is changed else
2368 ; gnus-agent-method-p may mis-report a methods status.
2369 )
2393 ;; Dummy variable.
2396 ;; Variable holding the user answers to all method prompts.
2399 ;; Variable holding the user answers to all mail method prompts.
2402 ;; Variable holding the user answers to all group prompts.
2410 "*The directory where cached articles will be stored."
2416 nnspool "cache"
2440 ;; Propagate flags to server, with the following exceptions:
2441 ;; `seen' is private to each gnus installation
2442 ;; `cache' is a internal gnus flag for each gnus installation
2443 ;; `download' is a agent flag private to each gnus installation
2444 ;; `unsend' are for nndraft groups only
2445 ;; `score' is not a proper mark
2446 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2449 "Marks that shouldn't be propagated to back ends.
2450 Typical marks are those that make no sense in a standalone back end,
2451 such as a mark that says whether an article is stored in the cache
2465 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2490 gnus-newsrc-last-checked-date
2491 gnus-newsrc-alist gnus-server-alist
2492 gnus-killed-list gnus-zombie-list
2493 gnus-topic-topology gnus-topic-alist
2494 gnus-format-specs)
2498 "Assoc list of read articles.
2502 "Assoc list of registry data.
2529 ;; Save window configuration.
2534 ;;; Let the byte-compiler know that we know about this variable.
2545 ;;; End of variables.
2547 ;; Define some autoload functions Gnus might use.
2550 ;; This little mapcar goes through the list below and marks the
2551 ;; symbols in question as autoloaded functions.
2571 message-send-and-exit message-yank-original)
2577 rmail-show-message rmail-summary-exists
2578 rmail-select-summary rmail-update-summary)
2582 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2583 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2587 gnus-Folder-save-name gnus-folder-save-name)
2590 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2591 gnus-demon-add-disconnection gnus-demon-add-handler
2592 gnus-demon-remove-handler)
2594 gnus-demon-init gnus-demon-cancel)
2596 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2597 gnus-face-from-file)
2599 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2601 gnus-nocem-unwanted-article-p)
2603 gnus-server-server-name)
2606 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2607 gnus-article-hide-citation gnus-article-fill-cited-article
2608 gnus-article-hide-citation-in-followups)
2610 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2611 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2613 gnus-cache-possibly-remove-articles gnus-cache-request-article
2614 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2615 gnus-cache-enter-remove-article gnus-cached-article-p
2616 gnus-cache-open gnus-cache-close gnus-cache-update-article
2617 gnus-cache-articles-in-group)
2619 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2621 gnus-summary-increase-score gnus-summary-set-score
2622 gnus-summary-raise-thread gnus-summary-raise-same-subject
2623 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2624 gnus-summary-lower-thread gnus-summary-lower-same-subject
2625 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2626 gnus-summary-current-score gnus-score-delta-default
2627 gnus-score-flush-cache gnus-score-close
2628 gnus-possibly-score-headers gnus-score-followup-article
2629 gnus-score-followup-thread)
2632 gnus-current-score-file-nondirectory gnus-score-adaptive
2633 gnus-score-find-trace gnus-score-file-name)
2637 gnus-subscribe-topics)
2641 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2642 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2643 gnus-uu-mark-by-regexp gnus-uu-mark-all
2644 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2645 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2646 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2647 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2648 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2649 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2650 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2651 gnus-uu-mark-over gnus-uu-post-news)
2654 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2656 gnus-group-post-news gnus-group-mail gnus-group-news
2657 gnus-summary-post-news gnus-summary-news-other-window
2658 gnus-summary-followup gnus-summary-followup-with-original
2659 gnus-summary-cancel-article gnus-summary-supersede-article
2660 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2661 gnus-summary-mail-forward gnus-summary-mail-other-window
2662 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2663 gnus-summary-wide-reply gnus-summary-followup-to-mail
2664 gnus-summary-followup-to-mail-with-original gnus-bug
2665 gnus-summary-wide-reply-with-original
2666 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2667 gnus-summary-post-forward)
2670 gnus-grouplens-mode)
2674 gnus-list-of-unread-articles gnus-list-of-read-articles
2675 gnus-offer-save-summaries gnus-make-thread-indent-array
2676 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2677 gnus-summary-skip-intangible gnus-summary-article-number
2678 gnus-data-header gnus-data-find)
2680 gnus-group-list-groups gnus-group-first-unread-group
2681 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2682 gnus-group-setup-buffer gnus-group-get-new-news
2683 gnus-group-make-help-group gnus-group-update-group
2684 gnus-group-iterate gnus-group-group-name)
2686 gnus-backlog-remove-article)
2688 gnus-article-prepare gnus-article-set-window-start
2689 gnus-article-next-page gnus-article-prev-page
2690 gnus-request-article-this-buffer gnus-article-mode
2691 gnus-article-setup-buffer gnus-narrow-to-page
2692 gnus-article-delete-invisible-text gnus-treat-article)
2694 gnus-article-hide-headers gnus-article-hide-boring-headers
2695 gnus-article-treat-overstrike
2696 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2697 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2698 gnus-article-de-base64-unreadable
2699 gnus-article-decode-HZ
2700 gnus-article-wash-html
2701 gnus-article-unsplit-urls
2702 gnus-article-hide-pem gnus-article-hide-signature
2703 gnus-article-strip-leading-blank-lines gnus-article-date-local
2704 gnus-article-date-original gnus-article-date-lapsed
2705 ;; gnus-article-show-all-headers
2706 gnus-article-edit-mode gnus-article-edit-article
2707 gnus-article-edit-done gnus-article-decode-encoded-words
2708 gnus-start-date-timer gnus-stop-date-timer
2709 gnus-mime-view-all-parts)
2712 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2714 gnus-dup-enter-articles)
2718 gnus-group-move-group-to-server gnus-change-server)
2722 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2723 gnus-async-halt-prefetch)
2725 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2726 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2727 gnus-summary-set-agent-mark gnus-agent-save-group-info
2728 gnus-agent-request-article gnus-agent-retrieve-headers)
2730 gnus-unplugged gnus-agentize gnus-agent-batch)
2732 gnus-summary-save-article-vm)
2737 gnus-group-split-update)
2740 ;;; gnus-sum.el thingies
2744 "*The format specification of the lines in the summary buffer.
2746 It works along the same lines as a normal formatting string,
2747 with some simple extensions.
2749 %N Article number, left padded with spaces (string)
2750 %S Subject (string)
2752 %n Name of the poster (string)
2753 %a Extracted name of the poster (string)
2754 %A Extracted address of the poster (string)
2755 %F Contents of the From: header (string)
2756 %f Contents of the From: or To: headers (string)
2757 %x Contents of the Xref: header (string)
2758 %D Date of the article (string)
2759 %d Date of the article (string) in DD-MMM format
2760 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2761 %M Message-id of the article (string)
2762 %r References of the article (string)
2763 %c Number of characters in the article (integer)
2764 %k Pretty-printed version of the above (string)
2766 %L Number of lines in the article (integer)
2767 %I Indentation based on thread level (a string of spaces)
2768 %B A complex trn-style thread tree (string)
2769 The variables `gnus-sum-thread-*' can be used for customization.
2770 %T A string with two possible values: 80 spaces if the article
2771 is on thread level two or larger and 0 spaces on level one
2776 %> Spaces of length thread-level (string)
2777 %< Spaces of length (- 20 thread-level) (string)
2778 %i Article score (number)
2779 %z Article zcore (character)
2780 %t Number of articles under the current thread (number).
2781 %e Whether the thread is empty or not (character).
2782 %l GroupLens score (string).
2783 %V Total thread score (number).
2784 %P The line number (number).
2785 %O Download mark (character).
2786 %* If present, indicates desired cursor position
2787 (instead of after first colon).
2788 %u User defined specifier. The next character in the format string should
2789 be a letter. Gnus will call the function gnus-user-format-function-X,
2790 where X is the letter following %u. The function will be passed the
2791 current header as argument. The function should return a string, which
2792 will be inserted into the summary just like information from any other
2793 summary specifier.
2795 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2796 with care. For reasons of efficiency, Gnus will compute what column
2798 it is invalid to have these specs after a variable-length spec. Well,
2799 you might not be arrested, but your summary buffer will look strange,
2800 which is bad enough.
2802 The smart choice is to have these specs as far to the left as
2803 possible.
2805 This restriction may disappear in later versions of Gnus.
2807 General format specifiers can also be used.
2808 See Info node `(gnus)Formatting Variables'."
2813 ;;;
2814 ;;; Skeleton keymaps
2815 ;;;
2820 (while keys
2821 (define-key keymap (pop keys) 'undefined))))
2823 (defvar gnus-article-mode-map
2824 (let ((keymap (make-sparse-keymap)))
2825 (gnus-suppress-keymap keymap)
2826 keymap))
2827 (defvar gnus-summary-mode-map
2828 (let ((keymap (make-keymap)))
2829 (gnus-suppress-keymap keymap)
2830 keymap))
2831 (defvar gnus-group-mode-map
2832 (let ((keymap (make-keymap)))
2833 (gnus-suppress-keymap keymap)
2834 keymap))
2836 \f
2838 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2839 ;; If you want the cursor to go somewhere else, set these two
2840 ;; functions in some startup hook to whatever you want.
2841 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2842 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2844 ;;; Various macros and substs.
2846 (defun gnus-header-from (header)
2847 (mail-header-from header))
2849 (defmacro gnus-gethash (string hashtable)
2850 "Get hash value of STRING in HASHTABLE."
2851 `(symbol-value (intern-soft ,string ,hashtable)))
2853 (defmacro gnus-gethash-safe (string hashtable)
2854 "Get hash value of STRING in HASHTABLE.
2855 Return nil if not defined."
2856 `(let ((sym (intern-soft ,string ,hashtable)))
2857 (and (boundp sym) (symbol-value sym))))
2859 (defmacro gnus-sethash (string value hashtable)
2860 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2861 `(set (intern ,string ,hashtable) ,value))
2862 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2864 (defmacro gnus-group-unread (group)
2865 "Get the currently computed number of unread articles in GROUP."
2866 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2868 (defmacro gnus-group-entry (group)
2869 "Get the newsrc entry for GROUP."
2870 `(gnus-gethash ,group gnus-newsrc-hashtb))
2872 (defmacro gnus-active (group)
2873 "Get active info on GROUP."
2874 `(gnus-gethash ,group gnus-active-hashtb))
2876 (defmacro gnus-set-active (group active)
2877 "Set GROUP's active info."
2878 `(gnus-sethash ,group ,active gnus-active-hashtb))
2880 ;; Info access macros.
2882 (defmacro gnus-info-group (info)
2883 `(nth 0 ,info))
2884 (defmacro gnus-info-rank (info)
2885 `(nth 1 ,info))
2886 (defmacro gnus-info-read (info)
2887 `(nth 2 ,info))
2888 (defmacro gnus-info-marks (info)
2889 `(nth 3 ,info))
2890 (defmacro gnus-info-method (info)
2891 `(nth 4 ,info))
2892 (defmacro gnus-info-params (info)
2893 `(nth 5 ,info))
2895 (defmacro gnus-info-level (info)
2896 `(let ((rank (gnus-info-rank ,info)))
2897 (if (consp rank)
2898 (car rank)
2899 rank)))
2900 (defmacro gnus-info-score (info)
2901 `(let ((rank (gnus-info-rank ,info)))
2902 (or (and (consp rank) (cdr rank)) 0)))
2904 (defmacro gnus-info-set-group (info group)
2905 `(setcar ,info ,group))
2906 (defmacro gnus-info-set-rank (info rank)
2907 `(setcar (nthcdr 1 ,info) ,rank))
2908 (defmacro gnus-info-set-read (info read)
2909 `(setcar (nthcdr 2 ,info) ,read))
2910 (defmacro gnus-info-set-marks (info marks &optional extend)
2911 (if extend
2912 `(gnus-info-set-entry ,info ,marks 3)
2913 `(setcar (nthcdr 3 ,info) ,marks)))
2914 (defmacro gnus-info-set-method (info method &optional extend)
2915 (if extend
2916 `(gnus-info-set-entry ,info ,method 4)
2917 `(setcar (nthcdr 4 ,info) ,method)))
2918 (defmacro gnus-info-set-params (info params &optional extend)
2919 (if extend
2920 `(gnus-info-set-entry ,info ,params 5)
2921 `(setcar (nthcdr 5 ,info) ,params)))
2923 (defun gnus-info-set-entry (info entry number)
2924 ;; Extend the info until we have enough elements.
2925 (while (<= (length info) number)
2926 (nconc info (list nil)))
2927 ;; Set the entry.
2928 (setcar (nthcdr number info) entry))
2930 (defmacro gnus-info-set-level (info level)
2931 `(let ((rank (cdr ,info)))
2932 (if (consp (car rank))
2933 (setcar (car rank) ,level)
2934 (setcar rank ,level))))
2935 (defmacro gnus-info-set-score (info score)
2936 `(let ((rank (cdr ,info)))
2937 (if (consp (car rank))
2938 (setcdr (car rank) ,score)
2939 (setcar rank (cons (car rank) ,score)))))
2941 (defmacro gnus-get-info (group)
2942 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2944 ;;; Load the compatibility functions.
2946 (require 'gnus-ems)
2948 \f
2949 ;;;
2950 ;;; Shutdown
2951 ;;;
2953 (defvar gnus-shutdown-alist nil)
2955 (defun gnus-add-shutdown (function &rest symbols)
2956 "Run FUNCTION whenever one of SYMBOLS is shut down."
2957 (push (cons function symbols) gnus-shutdown-alist))
2959 (defun gnus-shutdown (symbol)
2960 "Shut down everything that waits for SYMBOL."
2961 (let ((alist gnus-shutdown-alist)
2962 entry)
2963 (while (setq entry (pop alist))
2964 (when (memq symbol (cdr entry))
2965 (funcall (car entry))))))
2967 \f
2968 ;;;
2969 ;;; Gnus Utility Functions
2970 ;;;
2972 (defun gnus-find-subscribed-addresses ()
2973 "Return a regexp matching the addresses of all subscribed mail groups.
2974 It consists of the `to-address' or `to-list' parameter of all groups
2975 with a `subscribed' parameter."
2976 (let (group address addresses)
2977 (dolist (entry (cdr gnus-newsrc-alist))
2978 (setq group (car entry))
2979 (when (gnus-parameter-subscribed group)
2980 (setq address (mail-strip-quoted-names
2981 (or (gnus-group-fast-parameter group 'to-address)
2982 (gnus-group-fast-parameter group 'to-list))))
2983 (when address
2984 (add-to-list 'addresses address))))
2985 (when addresses
2988 (defmacro gnus-string-or (&rest strings)
2989 "Return the first element of STRINGS that is a non-blank string.
2990 STRINGS will be evaluated in normal `or' order."
2991 `(gnus-string-or-1 ',strings))
2993 (defun gnus-string-or-1 (strings)
2994 (let (string)
2995 (while strings
2996 (setq string (eval (pop strings)))
2998 (setq string nil)
2999 (setq strings nil)))
3000 string))
3002 (defun gnus-version (&optional arg)
3003 "Version number of this version of Gnus.
3004 If ARG, insert string at point."
3005 (interactive "P")
3006 (if arg
3007 (insert (message gnus-version))
3008 (message gnus-version)))
3010 (defun gnus-continuum-version (&optional version)
3011 "Return VERSION as a floating point number."
3012 (interactive)
3013 (unless version
3014 (setq version gnus-version))
3017 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3018 (number (match-string 2 version))
3019 major minor least)
3020 (unless (string-match
3022 (error "Invalid version string: %s" version))
3023 (setq major (string-to-number (match-string 1 number))
3024 minor (string-to-number (match-string 2 number))
3025 least (if (match-beginning 3)
3026 (string-to-number (match-string 3 number))
3027 0))
3028 (string-to-number
3029 (if (zerop major)
3030 (format "%s00%02d%02d"
3031 (if (member alpha '("(ding)" "d"))
3032 "4.99"
3033 (+ 5 (* 0.02
3034 (abs
3035 (- (mm-char-int (aref (downcase alpha) 0))
3036 (mm-char-int ?t))))
3037 -0.01))
3038 minor least)
3039 (format "%d.%02d%02d" major minor least))))))
3041 (defun gnus-info-find-node (&optional nodename)
3042 "Find Info documentation of Gnus."
3043 (interactive)
3044 ;; Enlarge info window if needed.
3045 (let (gnus-info-buffer)
3046 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3047 (setq gnus-info-buffer (current-buffer))
3048 (gnus-configure-windows 'info)))
3050 ;;;
3051 ;;; gnus-interactive
3052 ;;;
3054 (defvar gnus-current-prefix-symbol nil
3055 "Current prefix symbol.")
3057 (defvar gnus-current-prefix-symbols nil
3058 "List of current prefix symbols.")
3060 (defun gnus-interactive (string &optional params)
3061 "Return a list that can be fed to `interactive'.
3062 See `interactive' for full documentation.
3064 Adds the following specs:
3066 y -- The current symbolic prefix.
3067 Y -- A list of the current symbolic prefix(es).
3068 A -- Article number.
3069 H -- Article header.
3070 g -- Group name."
3071 (let ((i 0)
3072 out c prompt)
3073 (while (< i (length string))
3075 (setq c (aref string i))
3076 (when (match-end 1)
3077 (setq prompt (match-string 1 string)))
3078 (setq i (match-end 0))
3079 ;; We basically emulate just about everything that
3080 ;; `interactive' does, but add the specs listed above.
3081 (push
3082 (cond
3083 ((= c ?a)
3084 (completing-read prompt obarray 'fboundp t))
3085 ((= c ?b)
3086 (read-buffer prompt (current-buffer) t))
3087 ((= c ?B)
3088 (read-buffer prompt (other-buffer (current-buffer))))
3089 ((= c ?c)
3090 (read-char))
3091 ((= c ?C)
3092 (completing-read prompt obarray 'commandp t))
3093 ((= c ?d)
3094 (point))
3095 ((= c ?D)
3096 (read-file-name prompt nil default-directory 'lambda))
3097 ((= c ?f)
3098 (read-file-name prompt nil nil 'lambda))
3099 ((= c ?F)
3100 (read-file-name prompt))
3101 ((= c ?k)
3102 (read-key-sequence prompt))
3103 ((= c ?K)
3104 (error "Not implemented spec"))
3105 ((= c ?e)
3106 (error "Not implemented spec"))
3107 ((= c ?m)
3108 (mark))
3109 ((= c ?N)
3110 (error "Not implemented spec"))
3111 ((= c ?n)
3112 (string-to-number (read-from-minibuffer prompt)))
3113 ((= c ?p)
3114 (prefix-numeric-value current-prefix-arg))
3115 ((= c ?P)
3116 current-prefix-arg)
3117 ((= c ?r)
3118 'gnus-prefix-nil)
3119 ((= c ?s)
3120 (read-string prompt))
3121 ((= c ?S)
3122 (intern (read-string prompt)))
3123 ((= c ?v)
3124 (read-variable prompt))
3125 ((= c ?x)
3126 (read-minibuffer prompt))
3127 ((= c ?x)
3128 (eval-minibuffer prompt))
3129 ;; And here the new specs come.
3130 ((= c ?y)
3131 gnus-current-prefix-symbol)
3132 ((= c ?Y)
3133 gnus-current-prefix-symbols)
3134 ((= c ?g)
3135 (gnus-group-group-name))
3136 ((= c ?A)
3137 (gnus-summary-skip-intangible)
3138 (or (get-text-property (point) 'gnus-number)
3139 (gnus-summary-last-subject)))
3140 ((= c ?H)
3141 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3142 (t
3143 (error "Non-implemented spec")))
3144 out)
3145 (cond
3146 ((= c ?r)
3147 (push (if (< (point) (mark)) (point) (mark)) out)
3148 (push (if (> (point) (mark)) (point) (mark)) out))))
3149 (setq out (delq 'gnus-prefix-nil out))
3150 (nreverse out)))
3152 (defun gnus-symbolic-argument (&optional arg)
3153 "Read a symbolic argument and a command, and then execute command."
3154 (interactive "P")
3155 (let* ((in-command (this-command-keys))
3156 (command in-command)
3157 gnus-current-prefix-symbols
3158 gnus-current-prefix-symbol
3159 syms)
3160 (while (equal in-command command)
3161 (message "%s-" (key-description (this-command-keys)))
3162 (push (intern (char-to-string (read-char))) syms)
3163 (setq command (read-key-sequence nil t)))
3164 (setq gnus-current-prefix-symbols (nreverse syms)
3165 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3166 (call-interactively (key-binding command t))))
3168 ;;; More various functions.
3170 (defsubst gnus-check-backend-function (func group)
3171 "Check whether GROUP supports function FUNC.
3172 GROUP can either be a string (a group name) or a select method."
3173 (ignore-errors
3174 (let ((method (if (stringp group)
3175 (car (gnus-find-method-for-group group))
3176 group)))
3177 (unless (featurep method)
3178 (require method))
3179 (fboundp (intern (format "%s-%s" method func))))))
3181 (defun gnus-group-read-only-p (&optional group)
3182 "Check whether GROUP supports editing or not.
3183 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3184 that that variable is buffer-local to the summary buffers."
3185 (let ((group (or group gnus-newsgroup-name)))
3186 (not (gnus-check-backend-function 'request-replace-article group))))
3188 (defun gnus-virtual-group-p (group)
3189 "Say whether GROUP is virtual or not."
3190 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3191 gnus-valid-select-methods)))
3193 (defun gnus-news-group-p (group &optional article)
3194 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3195 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3196 t) ;is news of course.
3197 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3198 nil) ;must be mail then.
3199 ((vectorp article) ;Has header info.
3200 (eq (gnus-request-type group (mail-header-id article)) 'news))
3201 ((null article) ;Hasn't header info
3202 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3203 ((< article 0) ;Virtual message
3204 nil) ;we don't know, guess mail.
3205 (t ;Has positive number
3206 (eq (gnus-request-type group article) 'news)))) ;use it.
3208 ;; Returns a list of writable groups.
3209 (defun gnus-writable-groups ()
3210 (let ((alist gnus-newsrc-alist)
3211 groups group)
3212 (while (setq group (car (pop alist)))
3213 (unless (gnus-group-read-only-p group)
3214 (push group groups)))
3215 (nreverse groups)))
3217 ;; Check whether to use long file names.
3218 (defun gnus-use-long-file-name (symbol)
3219 ;; The variable has to be set...
3220 (and gnus-use-long-file-name
3221 ;; If it isn't a list, then we return t.
3222 (or (not (listp gnus-use-long-file-name))
3223 ;; If it is a list, and the list contains `symbol', we
3224 ;; return nil.
3225 (not (memq symbol gnus-use-long-file-name)))))
3227 ;; Generate a unique new group name.
3228 (defun gnus-generate-new-group-name (leaf)
3229 (let ((name leaf)
3230 (num 0))
3231 (while (gnus-gethash name gnus-newsrc-hashtb)
3232 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3233 name))
3235 (defun gnus-ephemeral-group-p (group)
3236 "Say whether GROUP is ephemeral or not."
3237 (gnus-group-get-parameter group 'quit-config t))
3239 (defun gnus-group-quit-config (group)
3240 "Return the quit-config of GROUP."
3241 (gnus-group-get-parameter group 'quit-config t))
3243 (defun gnus-kill-ephemeral-group (group)
3244 "Remove ephemeral GROUP from relevant structures."
3245 (gnus-sethash group nil gnus-newsrc-hashtb))
3247 (defun gnus-simplify-mode-line ()
3248 "Make mode lines a bit simpler."
3249 (setq mode-line-modified (cdr gnus-mode-line-modified))
3250 (when (listp mode-line-format)
3251 (make-local-variable 'mode-line-format)
3252 (setq mode-line-format (copy-sequence mode-line-format))
3253 (when (equal (nth 3 mode-line-format) " ")
3254 (setcar (nthcdr 3 mode-line-format) " "))))
3256 ;;; Servers and groups.
3258 (defsubst gnus-server-add-address (method)
3259 (let ((method-name (symbol-name (car method))))
3260 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3261 (not (assq (intern (concat method-name "-address")) method))
3262 (memq 'physical-address (assq (car method)
3263 gnus-valid-select-methods)))
3264 (append method (list (list (intern (concat method-name "-address"))
3265 (nth 1 method))))
3266 method)))
3268 (defsubst gnus-method-to-server (method)
3269 (catch 'server-name
3270 (setq method (or method gnus-select-method))
3272 ;; Perhaps it is already in the cache.
3273 (mapc (lambda (name-method)
3274 (if (equal (cdr name-method) method)
3275 (throw 'server-name (car name-method))))
3276 gnus-server-method-cache)
3278 (mapc
3279 (lambda (server-alist)
3280 (mapc (lambda (name-method)
3281 (when (gnus-methods-equal-p (cdr name-method) method)
3282 (unless (member name-method gnus-server-method-cache)
3283 (push name-method gnus-server-method-cache))
3284 (throw 'server-name (car name-method))))
3285 server-alist))
3286 (let ((alists (list gnus-server-alist
3287 gnus-predefined-server-alist)))
3288 (if gnus-select-method
3289 (push (list (cons "native" gnus-select-method)) alists))
3290 alists))
3292 (let* ((name (if (member (cadr method) '(nil ""))
3293 (format "%s" (car method))
3294 (format "%s:%s" (car method) (cadr method))))
3295 (name-method (cons name method)))
3296 (unless (member name-method gnus-server-method-cache)
3297 (push name-method gnus-server-method-cache))
3298 name)))
3300 (defsubst gnus-server-to-method (server)
3301 "Map virtual server names to select methods."
3302 (or (and server (listp server) server)
3303 (cdr (assoc server gnus-server-method-cache))
3304 (let ((result
3305 (or
3306 ;; Perhaps this is the native server?
3307 (and (equal server "native") gnus-select-method)
3308 ;; It should be in the server alist.
3309 (cdr (assoc server gnus-server-alist))
3310 ;; It could be in the predefined server alist.
3311 (cdr (assoc server gnus-predefined-server-alist))
3312 ;; If not, we look through all the opened server
3313 ;; to see whether we can find it there.
3314 (let ((opened gnus-opened-servers))
3315 (while (and opened
3316 (not (equal server (format "%s:%s" (caaar opened)
3317 (cadaar opened)))))
3318 (pop opened))
3319 (caar opened))
3320 ;; It could be a named method, search all servers
3321 (let ((servers gnus-secondary-select-methods))
3322 (while (and servers
3323 (not (equal server (format "%s:%s" (caar servers)
3324 (cadar servers)))))
3325 (pop servers))
3326 (car servers))
3327 ;; This could be some sort of foreign server that I
3328 ;; simply haven't opened (yet). Do a brute-force scan
3329 ;; of the entire gnus-newsrc-alist for the server name
3330 ;; of every method. As a side-effect, loads the
3331 ;; gnus-server-method-cache so this only happens once,
3332 ;; if at all.
3333 (let (match)
3334 (mapcar
3335 (lambda (info)
3336 (let ((info-method (gnus-info-method info)))
3337 (unless (stringp info-method)
3338 (let ((info-server (gnus-method-to-server info-method)))
3339 (when (equal server info-server)
3340 (setq match info-method))))))
3341 (cdr gnus-newsrc-alist))
3342 match))))
3343 (when result
3344 (push (cons server result) gnus-server-method-cache))
3345 result)))
3347 (defsubst gnus-server-get-method (group method)
3348 ;; Input either a server name, and extended server name, or a
3349 ;; select method, and return a select method.
3350 (cond ((stringp method)
3351 (gnus-server-to-method method))
3352 ((equal method gnus-select-method)
3353 gnus-select-method)
3354 ((and (stringp (car method))
3355 group)
3356 (gnus-server-extend-method group method))
3357 ((and method
3358 (not group)
3359 (equal (cadr method) ""))
3360 method)
3361 (t
3362 (gnus-server-add-address method))))
3364 (defmacro gnus-method-equal (ss1 ss2)
3365 "Say whether two servers are equal."
3366 `(let ((s1 ,ss1)
3367 (s2 ,ss2))
3368 (or (equal s1 s2)
3369 (and (= (length s1) (length s2))
3370 (progn
3371 (while (and s1 (member (car s1) s2))
3372 (setq s1 (cdr s1)))
3373 (null s1))))))
3375 (defun gnus-methods-equal-p (m1 m2)
3376 (let ((m1 (or m1 gnus-select-method))
3377 (m2 (or m2 gnus-select-method)))
3378 (or (equal m1 m2)
3379 (and (eq (car m1) (car m2))
3380 (or (not (memq 'address (assoc (symbol-name (car m1))
3381 gnus-valid-select-methods)))
3382 (equal (nth 1 m1) (nth 1 m2)))))))
3384 (defun gnus-server-equal (m1 m2)
3385 "Say whether two methods are equal."
3386 (let ((m1 (cond ((null m1) gnus-select-method)
3387 ((stringp m1) (gnus-server-to-method m1))
3388 (t m1)))
3389 (m2 (cond ((null m2) gnus-select-method)
3390 ((stringp m2) (gnus-server-to-method m2))
3391 (t m2))))
3392 (gnus-method-equal m1 m2)))
3394 (defun gnus-servers-using-backend (backend)
3395 "Return a list of known servers using BACKEND."
3396 (let ((opened gnus-opened-servers)
3397 out)
3398 (while opened
3399 (when (eq backend (caaar opened))
3400 (push (caar opened) out))
3401 (pop opened))
3402 out))
3404 (defun gnus-archive-server-wanted-p ()
3405 "Say whether the user wants to use the archive server."
3406 (cond
3407 ((or (not gnus-message-archive-method)
3408 (not gnus-message-archive-group))
3409 nil)
3410 ((and gnus-message-archive-method gnus-message-archive-group)
3411 t)
3412 (t
3413 (let ((active (cadr (assq 'nnfolder-active-file
3414 gnus-message-archive-method))))
3415 (and active
3416 (file-exists-p active))))))
3418 (defsubst gnus-method-to-server-name (method)
3419 (concat
3420 (format "%s" (car method))
3421 (when (and
3422 (or (assoc (format "%s" (car method))
3423 (gnus-methods-using 'address))
3424 (gnus-server-equal method gnus-message-archive-method))
3425 (nth 1 method)
3426 (not (string= (nth 1 method) "")))
3427 (concat "+" (nth 1 method)))))
3429 (defsubst gnus-method-to-full-server-name (method)
3430 (format "%s+%s" (car method) (nth 1 method)))
3432 (defun gnus-group-prefixed-name (group method &optional full)
3433 "Return the whole name from GROUP and METHOD.
3434 Call with full set to get the fully qualified group name (even if the
3435 server is native)."
3436 (when (stringp method)
3437 (setq method (gnus-server-to-method method)))
3438 (if (or (not method)
3439 (and (not full) (gnus-server-equal method "native"))
3440 ;;;!!! This might not be right. We'll see...
3441 ;(string-match ":" group)
3442 )
3443 group
3444 (concat (gnus-method-to-server-name method) ":" group)))
3446 (defun gnus-group-guess-prefixed-name (group)
3447 "Guess the whole name from GROUP and METHOD."
3448 (gnus-group-prefixed-name group (gnus-find-method-for-group
3449 group)))
3451 (defun gnus-group-full-name (group method)
3452 "Return the full name from GROUP and METHOD, even if the method is native."
3453 (gnus-group-prefixed-name group method t))
3455 (defun gnus-group-guess-full-name (group)
3456 "Guess the full name from GROUP, even if the method is native."
3457 (if (gnus-group-prefixed-p group)
3458 group
3459 (gnus-group-full-name group (gnus-find-method-for-group group))))
3461 (defun gnus-group-guess-full-name-from-command-method (group)
3462 "Guess the full name from GROUP, even if the method is native."
3463 (if (gnus-group-prefixed-p group)
3464 group
3465 (gnus-group-full-name group gnus-command-method)))
3467 (defun gnus-group-real-prefix (group)
3468 "Return the prefix of the current group name."
3469 (if (stringp group)
3470 (if (string-match "^[^:]+:" group)
3471 (substring group 0 (match-end 0))
3472 "")
3473 nil))
3475 (defun gnus-group-short-name (group)
3476 "Return the short group name."
3477 (let ((prefix (gnus-group-real-prefix group)))
3478 (if (< 0 (length prefix))
3479 (substring group (length prefix) nil)
3480 group)))
3482 (defun gnus-group-prefixed-p (group)
3483 "Return the prefix of the current group name."
3484 (< 0 (length (gnus-group-real-prefix group))))
3486 (defun gnus-summary-buffer-name (group)
3487 "Return the summary buffer name of GROUP."
3488 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3490 (defun gnus-group-method (group)
3491 "Return the server or method used for selecting GROUP.
3492 You should probably use `gnus-find-method-for-group' instead."
3493 (let ((prefix (gnus-group-real-prefix group)))
3494 (if (equal prefix "")
3495 gnus-select-method
3496 (let ((servers gnus-opened-servers)
3497 (server "")
3498 backend possible found)
3500 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3501 server (substring prefix (match-end 0) (1- (length prefix))))
3502 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3503 (while servers
3504 (when (eq (caaar servers) backend)
3505 (setq possible (caar servers))
3506 (when (equal (cadaar servers) server)
3507 (setq found (caar servers))))
3508 (pop servers))
3509 (or (car (rassoc found gnus-server-alist))
3510 found
3511 (car (rassoc possible gnus-server-alist))
3512 possible
3513 (list backend server))))))
3515 (defsubst gnus-native-method-p (method)
3516 "Return whether METHOD is the native select method."
3517 (gnus-method-equal method gnus-select-method))
3519 (defsubst gnus-secondary-method-p (method)
3520 "Return whether METHOD is a secondary select method."
3521 (let ((methods gnus-secondary-select-methods)
3522 (gmethod (inline (gnus-server-get-method nil method))))
3523 (while (and methods
3524 (not (gnus-method-equal
3525 (inline (gnus-server-get-method nil (car methods)))
3526 gmethod)))
3527 (setq methods (cdr methods)))
3528 methods))
3530 (defun gnus-method-simplify (method)
3531 "Return the shortest uniquely identifying string or method for METHOD."
3532 (cond ((stringp method)
3533 method)
3534 ((gnus-native-method-p method)
3535 nil)
3536 ((gnus-secondary-method-p method)
3537 (format "%s:%s" (nth 0 method) (nth 1 method)))
3538 (t
3539 method)))
3541 (defun gnus-groups-from-server (server)
3542 "Return a list of all groups that are fetched from SERVER."
3543 (let ((alist (cdr gnus-newsrc-alist))
3544 info groups)
3545 (while (setq info (pop alist))
3546 (when (gnus-server-equal (gnus-info-method info) server)
3547 (push (gnus-info-group info) groups)))
3548 (sort groups 'string<)))
3550 (defun gnus-group-foreign-p (group)
3551 "Say whether a group is foreign or not."
3552 (and (not (gnus-group-native-p group))
3553 (not (gnus-group-secondary-p group))))
3555 (defun gnus-group-native-p (group)
3556 "Say whether the group is native or not."
3557 (not (string-match ":" group)))
3559 (defun gnus-group-secondary-p (group)
3560 "Say whether the group is secondary or not."
3561 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3563 (defun gnus-parameters-get-parameter (group)
3564 "Return the group parameters for GROUP from `gnus-parameters'."
3565 (let (params-list)
3566 (dolist (elem gnus-parameters)
3567 (when (string-match (car elem) group)
3568 (setq params-list
3569 (nconc (gnus-expand-group-parameters
3570 (car elem) (cdr elem) group)
3571 params-list))))
3572 params-list))
3574 (defun gnus-expand-group-parameter (match value group)
3575 "Use MATCH to expand VALUE in GROUP."
3576 (with-temp-buffer
3577 (insert group)
3578 (goto-char (point-min))
3579 (while (re-search-forward match nil t)
3580 (replace-match value))
3581 (buffer-string)))
3583 (defun gnus-expand-group-parameters (match parameters group)
3584 "Go through PARAMETERS and expand them according to the match data."
3585 (let (new)
3586 (dolist (elem parameters)
3587 (if (and (stringp (cdr elem))
3589 (push (cons (car elem)
3590 (gnus-expand-group-parameter match (cdr elem) group))
3591 new)
3592 (push elem new)))
3593 new))
3595 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3596 "For GROUP, return the value of SYMBOL.
3598 You should call this in the `gnus-group-buffer' buffer.
3599 The function `gnus-group-find-parameter' will do that for you."
3600 ;; The speed trick: No cons'ing and quit early.
3601 (let* ((params (funcall gnus-group-get-parameter-function group))
3602 ;; Start easy, check the "real" group parameters.
3603 (simple-results
3604 (gnus-group-parameter-value params symbol allow-list t)))
3605 (if simple-results
3606 ;; Found results; return them.
3607 (car simple-results)
3608 ;; We didn't found it there, try `gnus-parameters'.
3609 (let ((result nil)
3610 (head nil)
3611 (tail gnus-parameters))
3612 ;; A good old-fashioned non-cl loop.
3613 (while tail
3614 (setq head (car tail)
3615 tail (cdr tail))
3616 ;; The car is regexp matching for matching the group name.
3617 (when (string-match (car head) group)
3618 ;; The cdr is the parameters.
3619 (setq result (gnus-group-parameter-value (cdr head)
3620 symbol allow-list))
3621 (when result
3622 ;; Expand if necessary.
3624 (setq result (gnus-expand-group-parameter (car head)
3625 result group)))
3626 ;; Exit the loop early.
3627 (setq tail nil))))
3628 ;; Done.
3629 result))))
3631 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3632 "Return the group parameters for GROUP.
3633 If SYMBOL, return the value of that symbol in the group parameters.
3635 If you call this function inside a loop, consider using the faster
3636 `gnus-group-fast-parameter' instead."
3637 (save-excursion
3638 (set-buffer gnus-group-buffer)
3639 (if symbol
3640 (gnus-group-fast-parameter group symbol allow-list)
3641 (nconc
3642 (copy-sequence
3643 (funcall gnus-group-get-parameter-function group))
3644 (gnus-parameters-get-parameter group)))))
3646 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3647 "Return the group parameters for GROUP.
3648 If SYMBOL, return the value of that symbol in the group parameters.
3649 Most functions should use `gnus-group-find-parameter', which
3650 also examines the topic parameters."
3651 (let ((params (gnus-info-params (gnus-get-info group))))
3652 (if symbol
3653 (gnus-group-parameter-value params symbol allow-list)
3654 params)))
3656 (defun gnus-group-parameter-value (params symbol &optional
3657 allow-list present-p)
3658 "Return the value of SYMBOL in group PARAMS."
3659 ;; We only wish to return group parameters (dotted lists) and
3660 ;; not local variables, which may have the same names.
3661 ;; But first we handle single elements...
3662 (or (car (memq symbol params))
3663 ;; Handle alist.
3664 (let (elem)
3665 (catch 'found
3666 (while (setq elem (pop params))
3667 (when (and (consp elem)
3668 (eq (car elem) symbol)
3669 (or allow-list
3670 (atom (cdr elem))))
3671 (throw 'found (if present-p (list (cdr elem))
3672 (cdr elem)))))))))
3674 (defun gnus-group-add-parameter (group param)
3675 "Add parameter PARAM to GROUP."
3676 (let ((info (gnus-get-info group)))
3677 (when info
3678 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3679 ;; Cons the new param to the old one and update.
3680 (gnus-group-set-info (cons param (gnus-info-params info))
3681 group 'params))))
3683 (defun gnus-group-set-parameter (group name value)
3684 "Set parameter NAME to VALUE in GROUP."
3685 (let ((info (gnus-get-info group)))
3686 (when info
3687 (gnus-group-remove-parameter group name)
3688 (let ((old-params (gnus-info-params info))
3689 (new-params (list (cons name value))))
3690 (while old-params
3691 (when (or (not (listp (car old-params)))
3692 (not (eq (caar old-params) name)))
3693 (setq new-params (append new-params (list (car old-params)))))
3694 (setq old-params (cdr old-params)))
3695 (gnus-group-set-info new-params group 'params)))))
3697 (defun gnus-group-remove-parameter (group name)
3698 "Remove parameter NAME from GROUP."
3699 (let ((info (gnus-get-info group)))
3700 (when info
3701 (let ((params (gnus-info-params info)))
3702 (when params
3703 (setq params (delq name params))
3704 (while (assq name params)
3705 (gnus-pull name params))
3706 (gnus-info-set-params info params))))))
3708 (defun gnus-group-add-score (group &optional score)
3709 "Add SCORE to the GROUP score.
3710 If SCORE is nil, add 1 to the score of GROUP."
3711 (let ((info (gnus-get-info group)))
3712 (when info
3713 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3715 (defun gnus-short-group-name (group &optional levels)
3716 "Collapse GROUP name LEVELS.
3717 Select methods are stripped and any remote host name is stripped down to
3718 just the host name."
3719 (let* ((name "")
3720 (foreign "")
3721 (depth 0)
3722 (skip 1)
3723 (levels (or levels
3724 gnus-group-uncollapsed-levels
3725 (progn
3727 (setq skip (match-end 0)
3728 depth (+ depth 1)))
3729 depth))))
3730 ;; Separate foreign select method from group name and collapse.
3731 ;; If method contains a server, collapse to non-domain server name,
3732 ;; otherwise collapse to select method.
3733 (let* ((colon (string-match ":" group))
3734 (server (and colon (substring group 0 colon)))
3735 (plus (and server (string-match "+" server))))
3736 (when server
3737 (if plus
3738 (setq foreign (substring server (+ 1 plus)
3740 group (substring group (+ 1 colon)))
3741 (setq foreign server
3742 group (substring group (+ 1 colon))))
3743 (setq foreign (concat foreign ":")))
3744 ;; Collapse group name leaving LEVELS uncollapsed elements
3745 (let* ((slist (split-string group "/"))
3746 (slen (length slist))
3748 (dlen (length dlist))
3749 glist
3750 glen
3751 gsep
3752 res)
3753 (if (> slen dlen)
3754 (setq glist slist
3755 glen slen
3756 gsep "/")
3757 (setq glist dlist
3758 glen dlen
3759 gsep "."))
3760 (setq levels (- glen levels))
3761 (dolist (g glist)
3762 (push (if (>= (decf levels) 0)
3763 (if (zerop (length g))
3764 ""
3765 (substring g 0 1))
3766 g)
3767 res))
3768 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3770 (defun gnus-narrow-to-body ()
3771 "Narrow to the body of an article."
3772 (narrow-to-region
3773 (progn
3774 (goto-char (point-min))
3776 (point-max)))
3777 (point-max)))
3779 \f
3780 ;;;
3781 ;;; Kill file handling.
3782 ;;;
3784 (defun gnus-apply-kill-file ()
3785 "Apply a kill file to the current newsgroup.
3786 Returns the number of articles marked as read."
3787 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3788 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3789 (gnus-apply-kill-file-internal)
3790 0))
3792 (defun gnus-kill-save-kill-buffer ()
3793 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3794 (when (get-file-buffer file)
3795 (save-excursion
3796 (set-buffer (get-file-buffer file))
3797 (when (buffer-modified-p)
3798 (save-buffer))
3799 (kill-buffer (current-buffer))))))
3801 (defcustom gnus-kill-file-name "KILL"
3802 "Suffix of the kill files."
3803 :group 'gnus-score-kill
3804 :group 'gnus-score-files
3805 :type 'string)
3807 (defun gnus-newsgroup-kill-file (newsgroup)
3808 "Return the name of a kill file name for NEWSGROUP.
3809 If NEWSGROUP is nil, return the global kill file name instead."
3810 (cond
3811 ;; The global KILL file is placed at top of the directory.
3812 ((or (null newsgroup)
3813 (string-equal newsgroup ""))
3814 (expand-file-name gnus-kill-file-name
3815 gnus-kill-files-directory))
3816 ;; Append ".KILL" to newsgroup name.
3817 ((gnus-use-long-file-name 'not-kill)
3818 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3819 "." gnus-kill-file-name)
3820 gnus-kill-files-directory))
3821 ;; Place "KILL" under the hierarchical directory.
3822 (t
3823 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3824 "/" gnus-kill-file-name)
3825 gnus-kill-files-directory))))
3827 ;;; Server things.
3829 (defun gnus-member-of-valid (symbol group)
3831 (memq symbol (assoc
3832 (symbol-name (car (gnus-find-method-for-group group)))
3833 gnus-valid-select-methods)))
3835 (defun gnus-method-option-p (method option)
3836 "Return non-nil if select METHOD has OPTION as a parameter."
3837 (when (stringp method)
3838 (setq method (gnus-server-to-method method)))
3839 (memq option (assoc (format "%s" (car method))
3840 gnus-valid-select-methods)))
3842 (defun gnus-similar-server-opened (method)
3843 (let ((opened gnus-opened-servers))
3844 (while (and method opened)
3845 (when (and (equal (cadr method) (cadaar opened))
3846 (equal (car method) (caaar opened))
3847 (not (equal method (caar opened))))
3848 (setq method nil))
3849 (pop opened))
3850 (not method)))
3852 (defun gnus-server-extend-method (group method)
3853 ;; This function "extends" a virtual server. If the server is
3854 ;; "hello", and the select method is ("hello" (my-var "something"))
3855 ;; in the group "alt.alt", this will result in a new virtual server
3856 ;; called "hello+alt.alt".
3857 (if (or (not (inline (gnus-similar-server-opened method)))
3858 (not (cddr method)))
3859 method
3860 `(,(car method) ,(concat (cadr method) "+" group)
3861 (,(intern (format "%s-address" (car method))) ,(cadr method))
3862 ,@(cddr method))))
3864 (defun gnus-server-status (method)
3865 "Return the status of METHOD."
3866 (nth 1 (assoc method gnus-opened-servers)))
3868 (defun gnus-group-name-to-method (group)
3869 "Guess a select method based on GROUP."
3870 (if (string-match ":" group)
3871 (let ((server (substring group 0 (match-beginning 0))))
3873 (list (intern (substring server 0 (match-beginning 0)))
3874 (substring server (match-end 0)))
3875 (list (intern server) "")))
3876 gnus-select-method))
3878 (defun gnus-server-string (server)
3879 "Return a readable string that describes SERVER."
3880 (let* ((server (gnus-server-to-method server))
3881 (address (nth 1 server)))
3882 (if (and address
3883 (not (zerop (length address))))
3884 (format "%s using %s" address (car server))
3885 (format "%s" (car server)))))
3887 (defun gnus-find-method-for-group (group &optional info)
3888 "Find the select method that GROUP uses."
3889 (or gnus-override-method
3890 (and (not group)
3891 gnus-select-method)
3892 (and (not (gnus-group-entry group)) ;; a new group
3893 (gnus-group-name-to-method group))
3894 (let ((info (or info (gnus-get-info group)))
3895 method)
3896 (if (or (not info)
3897 (not (setq method (gnus-info-method info)))
3898 (equal method "native"))
3899 gnus-select-method
3900 (setq method
3901 (cond ((stringp method)
3902 (inline (gnus-server-to-method method)))
3903 ((stringp (cadr method))
3904 (inline (gnus-server-extend-method group method)))
3905 (t
3906 method)))
3907 (cond ((equal (cadr method) "")
3908 method)
3909 ((null (cadr method))
3910 (list (car method) ""))
3911 (t
3912 (gnus-server-add-address method)))))))
3914 (defun gnus-methods-using (feature)
3915 "Find all methods that have FEATURE."
3916 (let ((valids gnus-valid-select-methods)
3917 outs)
3918 (while valids
3919 (when (memq feature (car valids))
3920 (push (car valids) outs))
3921 (setq valids (cdr valids)))
3922 outs))
3924 (defun gnus-read-group (prompt &optional default)
3925 "Prompt the user for a group name.
3926 Disallow invalid group names."
3927 (let ((prefix "")
3928 group)
3929 (while (not group)
3930 (when (string-match
3931 gnus-invalid-group-regexp
3932 (setq group (read-string (concat prefix prompt)
3933 (cons (or default "") 0)
3934 'gnus-group-history)))
3935 (let ((match (match-string 0 group)))
3936 ;; Might be okay (e.g. for nnimap), so ask the user:
3938 (message-y-or-n-p
3939 "Proceed and create group anyway? " t
3942 Usually, it's dangerous to create a group with this name, because it's not
3943 supported by all back ends and servers. On IMAP servers it should work,
3944 though. If you are really sure, you can proceed anyway and create the group.
3946 You may customize the variable `gnus-invalid-group-regexp', which currently is
3950 group nil)))))
3951 group))
3953 (defun gnus-read-method (prompt)
3954 "Prompt the user for a method.
3955 Allow completion over sensible values."
3956 (let* ((open-servers
3957 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3958 gnus-opened-servers))
3959 (valid-methods
3960 (let (methods)
3961 (dolist (method gnus-valid-select-methods)
3962 (if (or (memq 'prompt-address method)
3963 (not (assoc (format "%s:" (car method)) open-servers)))
3964 (push method methods)))
3965 methods))
3966 (servers
3967 (append valid-methods
3968 open-servers
3969 gnus-predefined-server-alist
3970 gnus-server-alist))
3971 (method
3972 (completing-read
3973 prompt servers
3974 nil t nil 'gnus-method-history)))
3975 (cond
3976 ((equal method "")
3977 (setq method gnus-select-method))
3978 ((assoc method gnus-valid-select-methods)
3979 (let ((address (if (memq 'prompt-address
3980 (assoc method gnus-valid-select-methods))
3981 (read-string "Address: ")
3982 "")))
3983 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3984 (list (intern method) address))))
3985 ((assoc method servers)
3986 method)
3987 (t
3988 (list (intern method) "")))))
3990 ;;; Agent functions
3992 (defun gnus-agent-method-p (method)
3993 "Say whether METHOD is covered by the agent."
3994 (or (eq (car gnus-agent-method-p-cache) method)
3995 (setq gnus-agent-method-p-cache
3996 (cons method
3997 (member (if (stringp method)
3998 method
3999 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4000 (cdr gnus-agent-method-p-cache))
4002 (defun gnus-online (method)
4003 (not
4004 (if gnus-plugged
4005 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4006 (gnus-agent-method-p method))))
4008 ;;; User-level commands.
4010 ;;;###autoload
4011 (defun gnus-slave-no-server (&optional arg)
4012 "Read network news as a slave, without connecting to the local server."
4013 (interactive "P")
4014 (gnus-no-server arg t))
4016 ;;;###autoload
4017 (defun gnus-no-server (&optional arg slave)
4018 "Read network news.
4019 If ARG is a positive number, Gnus will use that as the startup
4020 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4021 non-nil and not a positive number, Gnus will prompt the user for the
4022 name of an NNTP server to use.
4023 As opposed to `gnus', this command will not connect to the local
4024 server."
4025 (interactive "P")
4026 (gnus-no-server-1 arg slave))
4028 ;;;###autoload
4029 (defun gnus-slave (&optional arg)
4030 "Read news as a slave."
4031 (interactive "P")
4032 (gnus arg nil 'slave))
4034 ;;;###autoload
4035 (defun gnus-other-frame (&optional arg display)
4036 "Pop up a frame to read news.
4037 This will call one of the Gnus commands which is specified by the user
4038 option `gnus-other-frame-function' (default `gnus') with the argument
4039 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4040 optional second argument DISPLAY should be a standard display string
4042 omitted or the function `make-frame-on-display' is not available, the
4043 current display is used."
4044 (interactive "P")
4045 (if (fboundp 'make-frame-on-display)
4046 (unless display
4047 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4048 (setq display nil))
4049 (let ((alive (gnus-alive-p)))
4050 (unless (and alive
4051 (catch 'found
4052 (walk-windows
4053 (lambda (window)
4054 (when (and (or (not display)
4055 (equal display
4056 (gnus-frame-or-window-display-name
4057 window)))
4058 (with-current-buffer (window-buffer window)
4060 (symbol-name major-mode))))
4061 (gnus-select-frame-set-input-focus
4062 (setq gnus-other-frame-object (window-frame window)))
4063 (select-window window)
4064 (throw 'found t)))
4065 'ignore t)))
4066 (gnus-select-frame-set-input-focus
4067 (setq gnus-other-frame-object
4068 (if display
4069 (make-frame-on-display display gnus-other-frame-parameters)
4070 (make-frame gnus-other-frame-parameters))))
4071 (if alive
4072 (switch-to-buffer gnus-group-buffer)
4073 (funcall gnus-other-frame-function arg)
4074 (add-hook 'gnus-exit-gnus-hook
4075 '(lambda nil
4076 (when (and (frame-live-p gnus-other-frame-object)
4077 (cdr (frame-list)))
4078 (delete-frame gnus-other-frame-object))
4079 (setq gnus-other-frame-object nil)))))))
4081 ;;(setq thing ? ; this is a comment
4082 ;; more 'yes)
4084 ;;;###autoload
4085 (defun gnus (&optional arg dont-connect slave)
4086 "Read network news.
4087 If ARG is non-nil and a positive number, Gnus will use that as the
4088 startup level. If ARG is non-nil and not a positive number, Gnus will
4089 prompt the user for the name of an NNTP server to use."
4090 (interactive "P")
4091 (unless (byte-code-function-p (symbol-function 'gnus))
4092 (message "You should byte-compile Gnus")
4093 (sit-for 2))
4094 (gnus-1 arg dont-connect slave))
4096 ;; Allow redefinition of Gnus functions.
4098 (gnus-ems-redefine)
4100 (provide 'gnus)
4102 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4103 ;;; gnus.el ends here