| blob | 0fec30f95627dbbbc80b7ee46c468705efe23fce |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 3 of the License, or
15 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;;; Code:
31 ;; For Emacs < 22.2.
40 ;; These are defined afterwards with gnus-define-group-parameter
54 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
59 "Starting your favorite newsreader."
63 "Dealing with formatting issues."
67 "Group character set issues."
73 "Cache interface."
78 "Article Registry."
82 "Server options at startup."
85 ;; These belong to gnus-group.el.
87 "Group buffers."
92 "Foreign groups."
97 "Automatic subscription of new groups."
101 "Group levels."
106 "Selecting a Group."
111 "Showing slices of the group list."
116 "Sorting the group buffer."
122 "Various group options."
126 ;; These belong to gnus-sum.el.
128 "Summary buffers."
133 "Leaving summary buffers."
138 "Marks used in summary buffers."
143 "Ordering articles according to replies."
148 "Formatting of the summary buffer."
153 "Choosing Articles."
158 "Summary movement commands."
163 "Show pictures of people, domains, and newsgroups."
167 "Mail group commands."
172 "Sorting the summary buffer."
177 "Highlighting and menus in the summary buffer."
183 "Various summary buffer options."
188 "Pick mode in the summary buffer."
194 "Tree display of threads in the summary buffer."
199 ;; Belongs to gnus-uu.el
201 "Viewing extracted files."
205 ;; Belongs to gnus-score.el
207 "Score and kill file handling."
211 "Kill files."
215 "Adaptive score files."
219 "Default values for score files."
223 "Expiring score rules."
227 "Decaying score rules."
231 "Score and kill file names."
236 "Various scoring and killing options."
239 ;; Other
241 "Options controlling the visual fluff."
246 "Offline support for Gnus."
250 "Files used by Gnus."
254 "Auto save file."
259 "Storing Gnus state."
263 "Options related to newsservers and other servers used by Gnus."
267 "Highlighting and menus in the server buffer."
272 "Composing replies and followups in Gnus."
276 "Meta variables controlling major portions of Gnus.
277 In general, modifying these variables does not take affect until Gnus
278 is restarted, and sometimes reloaded."
282 "Other Gnus options."
287 "Exiting Gnus."
292 "Frivolous Gnus extensions."
303 "If non-nil, the startup message will not be displayed.
304 This variable is used before `.gnus.el' is loaded, so it should
305 be set in `.emacs' instead."
310 "If non-nil, play the Gnus jingle at startup."
340 0 5
349 gnus-mode-line-image-cache)
351 "This is %s, %s."
353 str)
355 line)))
361 ;;(defalias 'gnus-decode-rfc1522 'ignore)
362 )
364 ;; We define these group faces here to avoid the display
365 ;; update forced when creating new faces.
375 ()))
376 "Level 1 newsgroup face."
378 ;; backward-compatibility alias
389 ()))
390 "Level 1 empty newsgroup face."
392 ;; backward-compatibility alias
403 ()))
404 "Level 2 newsgroup face."
406 ;; backward-compatibility alias
417 ()))
418 "Level 2 empty newsgroup face."
420 ;; backward-compatibility alias
431 ()))
432 "Level 3 newsgroup face."
434 ;; backward-compatibility alias
440 ())
443 ())
445 ()))
446 "Level 3 empty newsgroup face."
448 ;; backward-compatibility alias
459 ()))
460 "Level 4 newsgroup face."
462 ;; backward-compatibility alias
468 ())
471 ())
473 ()))
474 "Level 4 empty newsgroup face."
476 ;; backward-compatibility alias
487 ()))
488 "Level 5 newsgroup face."
490 ;; backward-compatibility alias
496 ())
499 ())
501 ()))
502 "Level 5 empty newsgroup face."
504 ;; backward-compatibility alias
515 ()))
516 "Level 6 newsgroup face."
518 ;; backward-compatibility alias
524 ())
527 ())
529 ()))
530 "Level 6 empty newsgroup face."
532 ;; backward-compatibility alias
543 ()))
544 "Low level newsgroup face."
546 ;; backward-compatibility alias
557 ()))
558 "Low level empty newsgroup face."
560 ;; backward-compatibility alias
572 "Level 1 mailgroup face."
574 ;; backward-compatibility alias
586 "Level 1 empty mailgroup face."
588 ;; backward-compatibility alias
600 "Level 2 mailgroup face."
602 ;; backward-compatibility alias
614 "Level 2 empty mailgroup face."
616 ;; backward-compatibility alias
628 "Level 3 mailgroup face."
630 ;; backward-compatibility alias
641 ()))
642 "Level 3 empty mailgroup face."
644 ;; backward-compatibility alias
656 "Low level mailgroup face."
658 ;; backward-compatibility alias
670 "Low level empty mailgroup face."
672 ;; backward-compatibility alias
675 ;; Summary mode faces.
678 "Face used for selected articles."
680 ;; backward-compatibility alias
686 "Face used for cancelled articles."
688 ;; backward-compatibility alias
700 "Face used for high interest ticked articles."
702 ;; backward-compatibility alias
714 "Face used for low interest ticked articles."
716 ;; backward-compatibility alias
727 ()))
728 "Face used for normal interest ticked articles."
730 ;; backward-compatibility alias
742 "Face used for high interest ancient articles."
744 ;; backward-compatibility alias
756 "Face used for low interest ancient articles."
758 ;; backward-compatibility alias
769 ()))
770 "Face used for normal interest ancient articles."
772 ;; backward-compatibility alias
782 "Face used for high interest uncached articles."
784 ;; backward-compatibility alias
794 "Face used for low interest uncached articles."
796 ;; backward-compatibility alias
806 "Face used for normal interest uncached articles."
808 ;; backward-compatibility alias
814 "Face used for high interest unread articles."
816 ;; backward-compatibility alias
822 "Face used for low interest unread articles."
824 ;; backward-compatibility alias
829 ()))
830 "Face used for normal interest unread articles."
832 ;; backward-compatibility alias
846 "Face used for high interest read articles."
848 ;; backward-compatibility alias
862 "Face used for low interest read articles."
864 ;; backward-compatibility alias
875 ()))
876 "Face used for normal interest read articles."
878 ;; backward-compatibility alias
882 ;;;
883 ;;; Gnus buffers
884 ;;;
889 "Do the same as `get-buffer-create', but store the created buffer."
894 "Add the current buffer to the list of Gnus buffers."
898 "Kill BUFFER and remove from the list of Gnus buffers."
905 "Return a list of live Gnus buffers."
914 gnus-buffers)
916 ;;; Splash screen.
931 ()))
932 "Face for the splash screen."
934 ;; backward-compatibility alias
949 "Indent rigidly using only spaces and no tabs."
955 ;; We translate tabs into spaces -- not everybody uses
956 ;; an 8-character tab.
963 ;;(format "%02x%02x%02x" 114 66 20) "724214"
987 "*Color styles used for the Gnus logo."
989 gnus-logo-color-alist))
997 "Insert startup message in current buffer."
998 ;; Insert the message.
1004 ;; Make sure the library defining `image-load-path' is loaded
1005 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1006 ;; get "defvar ignored because image-load-path is let-bound" when calling
1007 ;; `find-image' below.
1017 :color-symbols
1023 ;; Account for the pbm's blackground.
1027 ;; Account for the xbm's blackground.
1038 t))))
1042 _ ___ _ _
1043 _ ___ __ ___ __ _ ___
1044 __ _ ___ __ ___
1045 _ ___ _
1046 _ _ __ _
1047 ___ __ _
1048 __ _
1049 _ _ _
1050 _ _ _
1051 _ _ _
1052 __ ___
1053 _ _ _ _
1054 _ _
1055 _ _
1056 _ _
1057 _
1058 __
1060 "
1062 ;; And then hack it.
1071 ;; Fontify some.
1085 ;;; Do the rest.
1091 "Alist of group parameters.
1093 For example:
1095 (gnus-use-scoring nil)
1096 (gnus-summary-line-format
1098 (gcc-self . t)
1099 (display . all))
1102 (broken-reply-to . t)))"
1109 "If it is t, ignore case of group names specified in `gnus-parameters'.
1110 If it is nil, don't ignore case. If it is `default', which is for the
1111 backward compatibility, use the value of `case-fold-search'."
1122 "Define a group parameter PARAM.
1123 REST is a plist of following:
1124 :type One of `bool', `list' or nil.
1125 :function The name of the function.
1126 :function-document The documentation of the function.
1127 :parameter-type The type for customizing the parameter.
1128 :parameter-document The documentation for the parameter.
1129 :variable The name of the variable.
1130 :variable-document The documentation for the variable.
1131 :variable-group The group for customizing the variable.
1132 :variable-type The type for customizing the variable.
1133 :variable-default The default value of the variable."
1150 'progn
1152 ,variable-document
1158 gnus-group-parameters-more))
1161 ,parameter-type
1165 ,function-document
1167 val)
1170 t)
1175 (,variable
1177 elem value)
1185 ,function-document
1189 elem value)
1196 'value
1201 All other Gnus file and directory variables are initialized from this variable."
1207 "*Directory variable from which all other Gnus file variables are derived.
1209 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1210 This means that other directory variables that are initialized from
1211 this variable won't be set properly if you set this variable in `.gnus.el'.
1212 Set this variable in `.emacs' instead."
1217 "*Default directory for all Gnus buffers."
1220 directory))
1222 ;; Site dependent variables. These variables should be defined in
1223 ;; paths.el.
1226 "Specify a default NNTP server.
1227 This variable should be defined in paths.el, and should never be set
1228 by the user.
1229 If you want to change servers, you should use `gnus-select-method'.
1232 ;; Don't touch this variable.
1235 This is an obsolete variable, which is scarcely used. If you use an
1236 nntp server for your newsgroup and want to change the port number
1237 used to 899, you would say something along these lines:
1242 "A file with only the name of the nntp server in it."
1248 "Find default nntp server.
1249 Check the NNTPSERVER environment variable and the
1250 `gnus-nntpserver-file' file."
1258 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1259 ;; starting or even loading Gnus.
1260 ;;;###autoload(when (fboundp 'custom-autoload)
1261 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1271 gnus-default-nntp-server)
1275 nil
1278 "Default method for selecting a newsgroup.
1279 This variable should be a list, where the first element is how the
1280 news is to be fetched, the second is the address.
1283 NNTP, you could say:
1287 If you want to use your local spool, say:
1289 \(setq gnus-select-method (list 'nnspool (system-name)))
1291 If you use this variable, you must set `gnus-nntp-server' to nil.
1293 There is a lot more to know about select methods and virtual servers -
1294 see the manual for details."
1301 "*Method used for archiving messages you've sent.
1302 This should be a mail method.
1304 See also `gnus-update-message-archive-method'."
1308 gnus-select-method))
1313 The archive method is initially set according to the value of
1315 so that it may be used as a real method of the server which is named
1317 updated if the value of this variable is nil, even if you change the
1318 value of `gnus-message-archive-method' afterward. If you want the
1320 `gnus-message-archive-method', set this variable to a non-nil value."
1327 "*Name of the group in which to save the messages you've written.
1328 This can either be a string; a list of strings; or an alist
1329 of regexps/functions/forms to be evaluated to return a string (or a list
1330 of strings). The functions are called with the name of the current
1331 group (or nil) as a parameter.
1333 If you want to save your mail in one group and the news articles you
1334 write in another group, you could say something like:
1336 \(setq gnus-message-archive-group
1337 '((if (message-news-p)
1341 Normally the group names returned by this variable should be
1343 However, you may wish to store the message on some other server. In
1344 that case, just return a fully prefixed name of the group --
1348 function
1349 sexp
1350 string))
1353 "List of NNTP servers that the user can choose between interactively.
1354 To make Gnus query you for a server, you have to give `gnus' a
1355 non-numeric prefix - `C-u M-x gnus', in short."
1360 "*The name of the host running the NNTP server.
1361 This variable is semi-obsolete. Use the `gnus-select-method'
1362 variable instead."
1365 string))
1368 "A list of secondary methods that will be used for reading news.
1369 This is a list where each element is a complete select method (see
1370 `gnus-select-method').
1372 If, for instance, you want to read your mail with the nnml back end,
1373 you could set this variable:
1381 "Default default new newsgroups the first time Gnus is run.
1385 "Local domain name without a host name.
1386 The DOMAINNAME environment variable is used instead if it is defined.
1387 If the function `system-name' returns the full Internet name, there is
1388 no need to set this variable."
1391 string))
1394 "String with a description of what organization (if any) the user belongs to.
1397 ;; Customization variables
1400 "Preferred method for fetching an article by Message-ID.
1401 If you are reading news from the local spool (with nnspool), fetching
1402 articles by Message-ID is painfully slow. By setting this method to an
1403 nntp method, you might get acceptable results.
1405 The value of this variable must be a valid select method as discussed
1406 in the documentation of `gnus-select-method'.
1408 It can also be a list of select methods, as well as the special symbol
1409 `current', which means to use the current select method. If it is a
1410 list, Gnus will try all the methods in the list until it finds a match."
1415 gnus-select-method
1423 gnus-select-method))))
1427 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1428 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1429 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1430 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1431 "/ftp@rtfm.mit.edu:/pub/usenet/"
1432 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1433 "/ftp@ftp.sunet.se:/pub/usenet/"
1434 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1435 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1437 "*Directory where the group FAQs are stored.
1438 This will most commonly be on a remote machine, and the file will be
1439 fetched by ange-ftp.
1441 This variable can also be a list of directories. In that case, the
1442 first element in the list will be used by default. The others can
1443 be used when being prompted for a site.
1445 Note that Gnus uses an aol machine as the default directory. If this
1446 feels fundamentally unclean, just think of it as a way to finally get
1447 something of value back from them.
1449 If the default site is too slow, try one of these:
1451 North America: mirrors.aol.com /pub/rtfm/usenet
1452 ftp.seas.gwu.edu /pub/rtfm
1453 rtfm.mit.edu /pub/usenet
1454 Europe: ftp.uni-paderborn.de /pub/FAQ
1455 src.doc.ic.ac.uk /usenet/news-FAQS
1456 ftp.sunet.se /pub/usenet
1457 ftp.pasteur.fr /pub/FAQ
1458 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1459 hwarang.postech.ac.kr /pub/usenet
1460 ftp.hk.super.net /mirror/faqs"
1487 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1488 When FORM is evaluated `name' is bound to the name of the group."
1495 "*Non-nil means that control messages are displayed using `browse-url'.
1496 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1497 group."
1503 "*Non-nil means that cross referenced articles will be marked as read.
1504 If nil, ignore cross references. If t, mark articles as read in
1505 subscribed newsgroups. If neither t nor nil, mark as read in all
1506 newsgroups."
1514 "*Process mark."
1520 "*The number of articles which indicates a large newsgroup.
1521 If the number of articles in a newsgroup is greater than this value,
1522 confirmation is required for selecting the newsgroup.
1523 If it is nil, no confirmation is required."
1526 integer))
1529 "*Non-nil means that the default name of a file to save articles in is the group name.
1530 If it's nil, the directory form of the group name is used instead.
1532 If this variable is a list, and the list contains the element
1533 `not-score', long file names will not be used for score files; if it
1534 contains the element `not-save', long file names will not be used for
1535 saving; and if it contains the element `not-kill', long file names
1536 will not be used for kill files.
1538 Note that the default for this variable varies according to what system
1539 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1540 to nil while on all other systems it defaults to t."
1558 "*If non-nil, save group scoring info."
1564 "*If non-nil, allow undoing in Gnus group mode buffers."
1569 "*If non-nil, use some adaptive scoring scheme.
1570 If a list, then the values `word' and `line' are meaningful. The
1571 former will perform adaption on individual words in the subject
1572 header while `line' will perform adaption on several headers."
1578 "*If nil, Gnus will ignore the article cache.
1579 If `passive', it will allow entering (and reading) articles
1580 explicitly entered into the cache. If anything else, use the
1581 cache to the full extent of the law."
1589 "*If non-nil, display a thread tree buffer."
1594 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1595 If it is a number N, then Gnus will only keep the last N articles
1596 read. If it is neither nil nor a number, Gnus will keep all read
1597 articles. This is not a good idea."
1600 integer
1605 "*If non-nil, Gnus will read NoCeM cancel messages.
1606 You can also set this variable to a positive number as a group level.
1607 In that case, Gnus scans NoCeM messages when checking new news if this
1608 value is not exceeding a group level that you specify as the prefix
1609 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1610 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1611 level to those commands."
1620 gnus-level-default-subscribed
1624 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1629 "*If non-nil, enable scoring."
1635 "*A hook called when preparing to exit from the summary buffer.
1636 It calls `gnus-summary-expire-articles' by default."
1641 "*Non-nil means that you are a Usenet novice.
1642 If non-nil, verbose messages may be displayed and confirmations may be
1643 required."
1648 "*Non-nil means that you will never be asked for confirmation about anything.
1649 That doesn't mean *anything* anything; particularly destructive
1650 commands will still require prompting."
1655 "*If non-nil, require your confirmation when catching up a group."
1660 "*If non-nil, require your confirmation when exiting Gnus."
1665 "*Function for extracting address components from a From header.
1666 Two pre-defined function exist: `gnus-extract-address-components',
1667 which is the default, quite fast, and too simplistic solution, and
1668 `mail-extract-address-components', which works much better, but is
1669 slower."
1676 "*If non-nil, display clickable icons."
1681 "String used to separate shell commands."
1713 "*An alist of valid select methods.
1714 The first element of each list lists should be a string with the name
1715 of the select method. The other elements may be the category of
1716 this method (i. e., `post', `mail', `none' or whatever) or other
1717 properties that this method has (like being respoolable).
1718 If you implement a new select method, all you should have to change is
1719 this variable. I think."
1734 "Recomputes the select-method widget based on the value of
1735 `gnus-valid-select-methods'."
1737 "Widget for entering a select method."
1744 gnus-valid-select-methods)
1748 :inline t
1750 variable
1756 "List of buffers that should update their mode lines.
1757 The list may contain the symbols `group', `article', `tree' and
1758 `summary'. If the corresponding symbol is present, Gnus will keep
1759 that mode line updated with information that may be pertinent.
1760 If this variable is nil, screen refresh may be quicker."
1767 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1769 "*Max length of mode-line non-string contents.
1770 If this is nil, Gnus will take space as is needed, leaving the rest
1771 of the mode line intact. Note that the default of nil is unlikely
1772 to be desirable; see the manual for further details."
1775 integer))
1777 ;; There should be special validation for this.
1782 to-address
1783 :function-document
1784 "Return GROUP's to-address."
1785 :variable-document
1786 "*Alist of group regexps and correspondent to-addresses."
1787 :variable-group gnus-group-parameter
1790 This will be used when doing followups and posts.
1792 This is primarily useful in mail groups that represent closed
1793 mailing lists--mailing lists where it's expected that everybody that
1794 writes to the mailing list is subscribed to it. Since using this
1795 parameter ensures that the mail only goes to the mailing list itself,
1796 it means that members won't receive two copies of your followups.
1798 Using `to-address' will actually work whether the group is foreign or
1799 not. Let's say there's a group on the server that is called
1800 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1801 articles from a mail-to-news gateway. Posting directly to this group
1802 is therefore impossible--you have to send mail to the mailing list
1803 address instead.
1805 The gnus-group-split mail splitting mechanism will behave as if this
1809 to-list
1810 :function-document
1811 "Return GROUP's to-list."
1812 :variable-document
1813 "*Alist of group regexps and correspondent to-lists."
1814 :variable-group gnus-group-parameter
1817 This address will be used when doing a `a' in the group.
1819 It is totally ignored when doing a followup--except that if it is
1820 present in a news group, you'll get mail group semantics when doing
1821 `f'.
1823 The gnus-group-split mail splitting mechanism will behave as if this
1827 subscribed
1828 :type bool
1829 :function-document
1830 "Return GROUP's subscription status."
1831 :variable-document
1832 "*Groups which are automatically considered subscribed."
1833 :variable-group gnus-group-parameter
1836 Gnus assumed that you are subscribed to the To/List address.
1838 When constructing a list of subscribed groups using
1839 `gnus-find-subscribed-addresses', Gnus includes the To address given
1843 auto-expire
1844 :type bool
1845 :function gnus-group-auto-expirable-p
1846 :function-document
1847 "Check whether GROUP is auto-expirable or not."
1848 :variable gnus-auto-expirable-newsgroups
1849 :variable-default nil
1850 :variable-document
1851 "*Groups in which to automatically mark read articles as expirable.
1852 If non-nil, this should be a regexp that should match all groups in
1853 which to perform auto-expiry. This only makes sense for mail groups."
1854 :variable-group nnmail-expire
1856 regexp)
1858 :parameter-document
1862 total-expire
1863 :type bool
1864 :function gnus-group-total-expirable-p
1865 :function-document
1866 "Check whether GROUP is total-expirable or not."
1867 :variable gnus-total-expirable-newsgroups
1868 :variable-default nil
1869 :variable-document
1870 "*Groups in which to perform expiry of all read articles.
1871 Use with extreme caution. All groups that match this regexp will be
1872 expiring - which means that all read articles will be deleted after
1873 \(say) one week. (This only goes for mail groups and the like, of
1874 course.)"
1875 :variable-group nnmail-expire
1877 regexp)
1879 :parameter-document
1880 "All read articles will be put through the expiry process
1882 This happens even if they are not marked as expirable.
1886 charset
1887 :function-document
1888 "Return the default charset of GROUP."
1889 :variable gnus-group-charset-alist
1890 :variable-default
1903 :variable-document
1904 "Alist of regexps (to match group names) and default charsets to be used when reading."
1905 :variable-group gnus-charset
1913 post-method
1914 :type list
1915 :function-document
1916 "Return a posting method for GROUP."
1917 :variable gnus-post-method-alist
1918 :variable-document
1919 "Alist of regexps (to match group names) and method to be used when
1920 posting an article."
1921 :variable-group gnus-group-foreign
1922 :parameter-type
1930 :parameter-document
1934 large-newsgroup-initial
1935 :type integer
1936 :function-document
1937 "Return GROUP's initial input of the number of articles."
1938 :variable-document
1939 "*Alist of group regexps and its initial input of the number of articles."
1940 :variable-group gnus-group-parameter
1946 This number will be prompted as the initial value of the number of
1947 articles to list when the group is a large newsgroup (see
1948 `gnus-large-newsgroup'). If it is nil, the default value is the
1951 ;; The Gnus registry's ignored groups
1953 registry-ignore
1954 :type list
1955 :function-document
1956 "Whether this group should be ignored by the registry."
1957 :variable gnus-registry-ignored-groups
1958 :variable-default nil
1959 :variable-document
1960 "*Groups in which the registry should be turned off."
1961 :variable-group gnus-registry
1968 :parameter-document
1971 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1973 "*Disable the group parameters for spam detection.
1974 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1981 "Spam group classification (requires spam.el).
1982 This group contains spam messages. On summary entry, unread messages
1983 will be marked as spam. On summary exit, the specified spam
1984 processors will be invoked on spam-marked messages, then those
1985 messages will be expired, so the spam processor will only see a
1989 "The ham value for the spam group parameter (requires spam.el).
1990 On summary exit, the specified ham processors will be invoked on
1991 ham-marked messages. Exercise caution, since the ham processor will
1992 see the same message more than once because there is no ham message
1996 spam-contents
1997 :type list
1998 :function-document
1999 "The spam type (spam, ham, or neither) of the group."
2000 :variable gnus-spam-newsgroup-contents
2001 :variable-default nil
2002 :variable-document
2003 "*Group classification (spam, ham, or neither). Only
2004 meaningful when spam.el is loaded. If non-nil, this should be a
2005 list of group name regexps associated with a classification for
2006 each one. In spam groups, new articles are marked as spam on
2007 summary entry. There is other behavior associated with ham and
2008 no classification when spam.el is loaded - see the manual."
2009 :variable-group spam
2023 :parameter-document
2024 "The spam classification (spam, ham, or neither) of this group.
2025 When a spam group is entered, all unread articles are marked as
2026 spam. There is other behavior associated with ham and no
2030 spam-resend-to
2031 :type list
2032 :function-document
2033 "The address to get spam resent (through spam-report-resend)."
2034 :variable gnus-spam-resend-to
2035 :variable-default nil
2036 :variable-document
2037 "The address to get spam resent (through spam-report-resend)."
2038 :variable-group spam
2042 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2043 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2044 :parameter-document
2048 ham-resend-to
2049 :type list
2050 :function-document
2051 "The address to get ham resent (through spam-report-resend)."
2052 :variable gnus-ham-resend-to
2053 :variable-default nil
2054 :variable-document
2055 "The address to get ham resent (through spam-report-resend)."
2056 :variable-group spam
2060 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2061 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2062 :parameter-document
2078 "OBSOLETE: The Gmane reporting summary exit spam processor.
2085 "OBSOLETE: The ifile summary exit ham processor.
2089 "OBSOLETE: The Bogofilter summary exit ham processor.
2093 "OBSOLETE: The spam-stat summary exit ham processor.
2097 "OBSOLETE: The whitelist summary exit ham processor.
2101 "OBSOLETE: The BBDB summary exit ham processor.
2105 "OBSOLETE: The ham copy exit ham processor.
2109 "OBSOLETE: The spamoracle summary exit ham processor.
2113 spam-process
2114 :type list
2115 :parameter-type
2118 :value nil
2155 :function-document
2156 "Which spam or ham processors will be applied when the summary is exited."
2157 :variable gnus-spam-process-newsgroups
2158 :variable-default nil
2159 :variable-document
2160 "*Groups in which to automatically process spam or ham articles with
2161 a backend on summary exit. If non-nil, this should be a list of group
2162 name regexps that should match all groups in which to do automatic
2163 spam processing, associated with the appropriate processor."
2164 :variable-group spam
2165 :variable-type
2206 :parameter-document
2210 spam-autodetect
2211 :type list
2212 :parameter-type
2214 :function-document
2215 "Should spam be autodetected (with spam-split) in this group?"
2216 :variable gnus-spam-autodetect
2217 :variable-default nil
2218 :variable-document
2219 "*Groups in which spam should be autodetected when they are entered.
2220 Only unseen articles will be examined, unless
2221 spam-autodetect-recheck-messages is set."
2222 :variable-group spam
2223 :variable-type
2228 boolean))
2229 :parameter-document
2230 "Spam autodetection.
2231 Only unseen articles will be examined, unless
2235 spam-autodetect-methods
2236 :type list
2237 :parameter-type
2260 :function-document
2261 "Methods to be used for autodetection in each group"
2262 :variable gnus-spam-autodetect-methods
2263 :variable-default nil
2264 :variable-document
2265 "*Methods for autodetecting spam per group.
2266 Requires the spam-autodetect parameter. Only unseen articles
2267 will be examined, unless spam-autodetect-recheck-messages is
2268 set."
2269 :variable-group spam
2270 :variable-type
2297 :parameter-document
2298 "Spam autodetection methods.
2299 Requires the spam-autodetect parameter. Only unseen articles
2300 will be examined, unless spam-autodetect-recheck-messages is
2304 spam-process-destination
2305 :type list
2306 :parameter-type
2312 :function-document
2313 "Where spam-processed articles will go at summary exit."
2314 :variable gnus-spam-process-destinations
2315 :variable-default nil
2316 :variable-document
2317 "*Groups in which to explicitly send spam-processed articles to
2318 another group, or expire them (the default). If non-nil, this should
2319 be a list of group name regexps that should match all groups in which
2320 to do spam-processed article moving, associated with the destination
2321 group or nil for explicit expiration. This only makes sense for
2322 mail groups."
2323 :variable-group spam
2324 :variable-type
2335 :parameter-document
2339 ham-process-destination
2340 :type list
2341 :parameter-type
2349 :function-document
2350 "Where ham articles will go at summary exit from a spam group."
2351 :variable gnus-ham-process-destinations
2352 :variable-default nil
2353 :variable-document
2354 "*Groups in which to explicitly send ham articles to
2355 another group, or do nothing (the default). If non-nil, this should
2356 be a list of group name regexps that should match all groups in which
2357 to do ham article moving, associated with the destination
2358 group or nil for explicit ignoring. This only makes sense for
2359 mail groups, and only works in spam groups."
2360 :variable-group spam
2361 :variable-type
2373 :parameter-document
2377 ham-marks
2388 :parameter-document
2389 "Marks considered ham (positively not spam). Such articles will be
2390 processed as ham (non-spam) on group exit. When nil, the global
2391 spam-ham-marks variable takes precedence."
2393 gnus-read-mark
2394 gnus-killed-mark
2395 gnus-kill-file-mark
2396 gnus-low-score-mark))))
2397 :variable-group spam
2398 :variable-document
2402 spam-marks
2411 :parameter-document
2412 "Marks considered spam.
2413 Such articles will be processed as spam on group exit. When nil, the global
2414 spam-spam-marks variable takes precedence."
2416 :variable-group spam
2417 :variable-document
2421 "Number of group name elements to leave alone when making a short group name."
2426 "*If non-nil, once you set a level, Gnus will use this level."
2430 ;; Hooks.
2433 "A hook run while Gnus is loaded."
2438 "A hook called to apply kill files to a group.
2439 This hook is intended to apply a kill file to the selected newsgroup.
2440 The function `gnus-apply-kill-file' is called by default.
2442 Since a general kill file is too heavy to use only for a few
2443 newsgroups, I recommend you to use a lighter hook function. For
2444 example, if you'd like to apply a kill file to articles which contains
2445 a string `rmgroup' in subject in newsgroup `control', you can use the
2446 following hook:
2448 (setq gnus-apply-kill-hook
2449 (list
2450 (lambda ()
2459 "Function run when a group level is changed.
2460 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2463 function))
2465 ;;; Face thingies.
2469 mouse-face
2470 summary-menu group-menu article-menu
2471 tree-highlight menu highlight
2472 browse-menu server-menu
2473 page-marker tree-menu binary-menu pick-menu)
2474 "*Enable visual features.
2475 If `visual' is disabled, there will be no menus and few faces. Most of
2476 the visual customization options below will be ignored. Gnus will use
2477 less space and be faster as a result.
2479 This variable can also be a list of visual elements to switch on. For
2480 instance, to switch off all visual things except menus, you can say:
2482 (setq gnus-visual '(menu))
2484 Valid elements include `summary-highlight', `group-highlight',
2485 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2486 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2487 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2507 ;; Byte-compiler warning.
2509 ;; Find out whether the gnus-visual TYPE is wanted.
2513 gnus-visual
2517 t))))
2527 "*Face used for group or summary buffer mouse highlighting.
2528 The line beneath the mouse pointer will be highlighted with this
2529 face."
2542 "Controls use of the agent cache while plugged.
2543 When set, Gnus will prefer using the locally stored content rather
2544 than re-fetching it from the server. You also need to enable
2545 `gnus-agent' for this to have any affect."
2551 "Default charset assumed to be used when viewing non-ASCII characters.
2552 This variable is overridden on a group-to-group basis by the
2553 `gnus-group-charset-alist' variable and is only used on groups not
2554 covered by that variable."
2558 ;; Fixme: Doc reference to agent.
2560 "Whether we want to use the Gnus agent or not.
2562 You may customize gnus-agent to disable its use. However, some
2563 back ends have started to use the agent as a client-side cache.
2564 Disabling the agent may result in noticeable loss of performance."
2570 "Function called by the command `gnus-other-frame'."
2578 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2579 This should be an alist for Emacs, or a plist for XEmacs."
2590 "Which information should be exposed in the User-Agent header.
2592 Can be a list of symbols or a string. Valid symbols are `gnus'
2593 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2594 addition to the Emacs version, you can add `codename' \(show
2595 \(S\)XEmacs codename\) or either `config' \(show system
2596 configuration\) or `type' \(show system type\). If you set it to
2597 a string, be sure to use a valid format, see RFC 2616."
2610 ;; Convert old (< 2005-01-10) symbol type values:
2629 \f
2630 ;;; Internal variables
2635 ; Reset each time gnus-agent-covered-methods is changed else
2636 ; gnus-agent-method-p may mis-report a methods status.
2637 )
2661 ;; Dummy variable.
2664 ;; Variable holding the user answers to all method prompts.
2667 ;; Variable holding the user answers to all mail method prompts.
2670 ;; Variable holding the user answers to all group prompts.
2678 "*The directory where cached articles will be stored."
2684 nnspool "cache"
2708 ;; Propagate flags to server, with the following exceptions:
2709 ;; `seen' is private to each gnus installation
2710 ;; `cache' is a internal gnus flag for each gnus installation
2711 ;; `download' is a agent flag private to each gnus installation
2712 ;; `unsend' are for nndraft groups only
2713 ;; `score' is not a proper mark
2714 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2717 "Marks that shouldn't be propagated to back ends.
2718 Typical marks are those that make no sense in a standalone back end,
2719 such as a mark that says whether an article is stored in the cache
2732 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2757 gnus-newsrc-last-checked-date
2758 gnus-newsrc-alist gnus-server-alist
2759 gnus-killed-list gnus-zombie-list
2760 gnus-topic-topology gnus-topic-alist
2761 gnus-format-specs)
2765 "Assoc list of read articles.
2769 "Assoc list of registry data.
2796 ;; Save window configuration.
2801 ;;; Let the byte-compiler know that we know about this variable.
2812 ;;; End of variables.
2814 ;; Define some autoload functions Gnus might use.
2817 ;; This little mapcar goes through the list below and marks the
2818 ;; symbols in question as autoloaded functions.
2838 message-send-and-exit message-yank-original)
2844 rmail-show-message rmail-summary-exists
2845 rmail-select-summary rmail-update-summary)
2849 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2850 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2854 gnus-Folder-save-name gnus-folder-save-name)
2857 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2858 gnus-demon-add-disconnection gnus-demon-add-handler
2859 gnus-demon-remove-handler)
2861 gnus-demon-init gnus-demon-cancel)
2863 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2864 gnus-face-from-file)
2866 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2868 gnus-nocem-unwanted-article-p)
2870 gnus-server-server-name)
2873 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2874 gnus-article-hide-citation gnus-article-fill-cited-article
2875 gnus-article-hide-citation-in-followups)
2877 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2878 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2880 gnus-cache-possibly-remove-articles gnus-cache-request-article
2881 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2882 gnus-cache-enter-remove-article gnus-cached-article-p
2883 gnus-cache-open gnus-cache-close gnus-cache-update-article
2884 gnus-cache-articles-in-group)
2886 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2888 gnus-summary-increase-score gnus-summary-set-score
2889 gnus-summary-raise-thread gnus-summary-raise-same-subject
2890 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2891 gnus-summary-lower-thread gnus-summary-lower-same-subject
2892 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2893 gnus-summary-current-score gnus-score-delta-default
2894 gnus-score-flush-cache gnus-score-close
2895 gnus-possibly-score-headers gnus-score-followup-article
2896 gnus-score-followup-thread)
2899 gnus-current-score-file-nondirectory gnus-score-adaptive
2900 gnus-score-find-trace gnus-score-file-name)
2904 gnus-subscribe-topics)
2908 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2909 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2910 gnus-uu-mark-by-regexp gnus-uu-mark-all
2911 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2912 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2913 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2914 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2915 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2916 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2917 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2918 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2921 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2923 gnus-group-post-news gnus-group-mail gnus-group-news
2924 gnus-summary-post-news gnus-summary-news-other-window
2925 gnus-summary-followup gnus-summary-followup-with-original
2926 gnus-summary-cancel-article gnus-summary-supersede-article
2927 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2928 gnus-summary-mail-forward gnus-summary-mail-other-window
2929 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2930 gnus-summary-wide-reply gnus-summary-followup-to-mail
2931 gnus-summary-followup-to-mail-with-original gnus-bug
2932 gnus-summary-wide-reply-with-original
2933 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2934 gnus-summary-post-forward)
2939 gnus-list-of-unread-articles gnus-list-of-read-articles
2940 gnus-offer-save-summaries gnus-make-thread-indent-array
2941 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2942 gnus-summary-skip-intangible gnus-summary-article-number
2943 gnus-data-header gnus-data-find)
2945 gnus-group-list-groups gnus-group-first-unread-group
2946 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2947 gnus-group-setup-buffer gnus-group-get-new-news
2948 gnus-group-make-help-group gnus-group-update-group
2949 gnus-group-iterate gnus-group-group-name)
2951 gnus-backlog-remove-article)
2953 gnus-article-prepare gnus-article-set-window-start
2954 gnus-article-next-page gnus-article-prev-page
2955 gnus-request-article-this-buffer gnus-article-mode
2956 gnus-article-setup-buffer gnus-narrow-to-page
2957 gnus-article-delete-invisible-text gnus-treat-article)
2959 gnus-article-hide-headers gnus-article-hide-boring-headers
2960 gnus-article-treat-overstrike
2961 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2962 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2963 gnus-article-de-base64-unreadable
2964 gnus-article-decode-HZ
2965 gnus-article-wash-html
2966 gnus-article-unsplit-urls
2967 gnus-article-hide-pem gnus-article-hide-signature
2968 gnus-article-strip-leading-blank-lines gnus-article-date-local
2969 gnus-article-date-original gnus-article-date-lapsed
2970 ;;gnus-article-show-all-headers
2971 gnus-article-edit-mode gnus-article-edit-article
2972 gnus-article-edit-done gnus-article-decode-encoded-words
2973 gnus-start-date-timer gnus-stop-date-timer
2974 gnus-mime-view-all-parts)
2977 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2978 gnus-check-reasonable-setup)
2980 gnus-dup-enter-articles)
2984 gnus-group-move-group-to-server gnus-change-server)
2988 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2989 gnus-async-halt-prefetch)
2991 gnus-agent-save-active gnus-agent-method-p
2992 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2993 gnus-summary-set-agent-mark gnus-agent-save-group-info
2994 gnus-agent-request-article gnus-agent-retrieve-headers)
2996 gnus-unplugged gnus-agentize gnus-agent-batch)
2998 gnus-summary-save-article-vm)
3003 gnus-group-split-update)
3006 ;;; gnus-sum.el thingies
3010 "*The format specification of the lines in the summary buffer.
3012 It works along the same lines as a normal formatting string,
3013 with some simple extensions.
3015 %N Article number, left padded with spaces (string)
3016 %S Subject (string)
3018 %n Name of the poster (string)
3019 %a Extracted name of the poster (string)
3020 %A Extracted address of the poster (string)
3021 %F Contents of the From: header (string)
3022 %f Contents of the From: or To: headers (string)
3023 %x Contents of the Xref: header (string)
3024 %D Date of the article (string)
3025 %d Date of the article (string) in DD-MMM format
3026 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
3027 %M Message-id of the article (string)
3028 %r References of the article (string)
3029 %c Number of characters in the article (integer)
3030 %k Pretty-printed version of the above (string)
3032 %L Number of lines in the article (integer)
3033 %I Indentation based on thread level (a string of spaces)
3034 %B A complex trn-style thread tree (string)
3035 The variables `gnus-sum-thread-*' can be used for customization.
3036 %T A string with two possible values: 80 spaces if the article
3037 is on thread level two or larger and 0 spaces on level one
3042 %> Spaces of length thread-level (string)
3043 %< Spaces of length (- 20 thread-level) (string)
3044 %i Article score (number)
3045 %z Article zcore (character)
3046 %t Number of articles under the current thread (number).
3047 %e Whether the thread is empty or not (character).
3048 %V Total thread score (number).
3049 %P The line number (number).
3050 %O Download mark (character).
3051 %* If present, indicates desired cursor position
3052 (instead of after first colon).
3053 %u User defined specifier. The next character in the format string should
3054 be a letter. Gnus will call the function gnus-user-format-function-X,
3055 where X is the letter following %u. The function will be passed the
3056 current header as argument. The function should return a string, which
3057 will be inserted into the summary just like information from any other
3058 summary specifier.
3060 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3061 with care. For reasons of efficiency, Gnus will compute what column
3063 it is invalid to have these specs after a variable-length spec. Well,
3064 you might not be arrested, but your summary buffer will look strange,
3065 which is bad enough.
3067 The smart choice is to have these specs as far to the left as
3068 possible.
3070 This restriction may disappear in later versions of Gnus.
3072 General format specifiers can also be used.
3073 See Info node `(gnus)Formatting Variables'."
3078 ;;;
3079 ;;; Skeleton keymaps
3080 ;;;
3085 (while keys
3086 (define-key keymap (pop keys) 'undefined))))
3088 (defvar gnus-article-mode-map
3089 (let ((keymap (make-sparse-keymap)))
3090 (gnus-suppress-keymap keymap)
3091 keymap))
3092 (defvar gnus-summary-mode-map
3093 (let ((keymap (make-keymap)))
3094 (gnus-suppress-keymap keymap)
3095 keymap))
3096 (defvar gnus-group-mode-map
3097 (let ((keymap (make-keymap)))
3098 (gnus-suppress-keymap keymap)
3099 keymap))
3101 \f
3103 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3104 ;; If you want the cursor to go somewhere else, set these two
3105 ;; functions in some startup hook to whatever you want.
3106 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3107 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3109 ;;; Various macros and substs.
3111 (defun gnus-header-from (header)
3112 (mail-header-from header))
3114 (defmacro gnus-gethash (string hashtable)
3115 "Get hash value of STRING in HASHTABLE."
3116 `(symbol-value (intern-soft ,string ,hashtable)))
3118 (defmacro gnus-gethash-safe (string hashtable)
3119 "Get hash value of STRING in HASHTABLE.
3120 Return nil if not defined."
3121 `(let ((sym (intern-soft ,string ,hashtable)))
3122 (and (boundp sym) (symbol-value sym))))
3124 (defmacro gnus-sethash (string value hashtable)
3125 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3126 `(set (intern ,string ,hashtable) ,value))
3127 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3129 (defmacro gnus-group-unread (group)
3130 "Get the currently computed number of unread articles in GROUP."
3131 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3133 (defmacro gnus-group-entry (group)
3134 "Get the newsrc entry for GROUP."
3135 `(gnus-gethash ,group gnus-newsrc-hashtb))
3137 (defmacro gnus-active (group)
3138 "Get active info on GROUP."
3139 `(gnus-gethash ,group gnus-active-hashtb))
3141 (defmacro gnus-set-active (group active)
3142 "Set GROUP's active info."
3143 `(gnus-sethash ,group ,active gnus-active-hashtb))
3145 ;; Info access macros.
3147 (defmacro gnus-info-group (info)
3148 `(nth 0 ,info))
3149 (defmacro gnus-info-rank (info)
3150 `(nth 1 ,info))
3151 (defmacro gnus-info-read (info)
3152 `(nth 2 ,info))
3153 (defmacro gnus-info-marks (info)
3154 `(nth 3 ,info))
3155 (defmacro gnus-info-method (info)
3156 `(nth 4 ,info))
3157 (defmacro gnus-info-params (info)
3158 `(nth 5 ,info))
3160 (defmacro gnus-info-level (info)
3161 `(let ((rank (gnus-info-rank ,info)))
3162 (if (consp rank)
3163 (car rank)
3164 rank)))
3165 (defmacro gnus-info-score (info)
3166 `(let ((rank (gnus-info-rank ,info)))
3167 (or (and (consp rank) (cdr rank)) 0)))
3169 (defmacro gnus-info-set-group (info group)
3170 `(setcar ,info ,group))
3171 (defmacro gnus-info-set-rank (info rank)
3172 `(setcar (nthcdr 1 ,info) ,rank))
3173 (defmacro gnus-info-set-read (info read)
3174 `(setcar (nthcdr 2 ,info) ,read))
3175 (defmacro gnus-info-set-marks (info marks &optional extend)
3176 (if extend
3177 `(gnus-info-set-entry ,info ,marks 3)
3178 `(setcar (nthcdr 3 ,info) ,marks)))
3179 (defmacro gnus-info-set-method (info method &optional extend)
3180 (if extend
3181 `(gnus-info-set-entry ,info ,method 4)
3182 `(setcar (nthcdr 4 ,info) ,method)))
3183 (defmacro gnus-info-set-params (info params &optional extend)
3184 (if extend
3185 `(gnus-info-set-entry ,info ,params 5)
3186 `(setcar (nthcdr 5 ,info) ,params)))
3188 (defun gnus-info-set-entry (info entry number)
3189 ;; Extend the info until we have enough elements.
3190 (while (<= (length info) number)
3191 (nconc info (list nil)))
3192 ;; Set the entry.
3193 (setcar (nthcdr number info) entry))
3195 (defmacro gnus-info-set-level (info level)
3196 `(let ((rank (cdr ,info)))
3197 (if (consp (car rank))
3198 (setcar (car rank) ,level)
3199 (setcar rank ,level))))
3200 (defmacro gnus-info-set-score (info score)
3201 `(let ((rank (cdr ,info)))
3202 (if (consp (car rank))
3203 (setcdr (car rank) ,score)
3204 (setcar rank (cons (car rank) ,score)))))
3206 (defmacro gnus-get-info (group)
3207 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3209 ;;; Load the compatibility functions.
3211 (require 'gnus-ems)
3213 \f
3214 ;;;
3215 ;;; Shutdown
3216 ;;;
3218 (defvar gnus-shutdown-alist nil)
3220 (defun gnus-add-shutdown (function &rest symbols)
3221 "Run FUNCTION whenever one of SYMBOLS is shut down."
3222 (push (cons function symbols) gnus-shutdown-alist))
3224 (defun gnus-shutdown (symbol)
3225 "Shut down everything that waits for SYMBOL."
3226 (dolist (entry gnus-shutdown-alist)
3227 (when (memq symbol (cdr entry))
3228 (funcall (car entry)))))
3230 \f
3231 ;;;
3232 ;;; Gnus Utility Functions
3233 ;;;
3235 (defun gnus-find-subscribed-addresses ()
3236 "Return a regexp matching the addresses of all subscribed mail groups.
3237 It consists of the `to-address' or `to-list' parameter of all groups
3238 with a `subscribed' parameter."
3239 (let (group address addresses)
3240 (dolist (entry (cdr gnus-newsrc-alist))
3241 (setq group (car entry))
3242 (when (gnus-parameter-subscribed group)
3243 (setq address (mail-strip-quoted-names
3244 (or (gnus-group-fast-parameter group 'to-address)
3245 (gnus-group-fast-parameter group 'to-list))))
3246 (when address
3247 (add-to-list 'addresses address))))
3248 (when addresses
3251 (defmacro gnus-string-or (&rest strings)
3252 "Return the first element of STRINGS that is a non-blank string.
3253 STRINGS will be evaluated in normal `or' order."
3254 `(gnus-string-or-1 ',strings))
3256 (defun gnus-string-or-1 (strings)
3257 (let (string)
3258 (while strings
3259 (setq string (eval (pop strings)))
3261 (setq string nil)
3262 (setq strings nil)))
3263 string))
3265 (defun gnus-version (&optional arg)
3266 "Version number of this version of Gnus.
3267 If ARG, insert string at point."
3268 (interactive "P")
3269 (if arg
3270 (insert (message gnus-version))
3271 (message gnus-version)))
3273 (defun gnus-continuum-version (&optional version)
3274 "Return VERSION as a floating point number."
3275 (interactive)
3276 (unless version
3277 (setq version gnus-version))
3280 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3281 (number (match-string 2 version))
3282 major minor least)
3283 (unless (string-match
3285 (error "Invalid version string: %s" version))
3286 (setq major (string-to-number (match-string 1 number))
3287 minor (string-to-number (match-string 2 number))
3288 least (if (match-beginning 3)
3289 (string-to-number (match-string 3 number))
3290 0))
3291 (string-to-number
3292 (if (zerop major)
3293 (format "%s00%02d%02d"
3294 (if (member alpha '("(ding)" "d"))
3295 "4.99"
3296 (+ 5 (* 0.02
3297 (abs
3298 (- (mm-char-int (aref (downcase alpha) 0))
3299 (mm-char-int ?t))))
3300 -0.01))
3301 minor least)
3302 (format "%d.%02d%02d" major minor least))))))
3304 (defun gnus-info-find-node (&optional nodename)
3305 "Find Info documentation of Gnus."
3306 (interactive)
3307 ;; Enlarge info window if needed.
3308 (let (gnus-info-buffer)
3309 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3310 (setq gnus-info-buffer (current-buffer))
3311 (gnus-configure-windows 'info)))
3313 ;;;
3314 ;;; gnus-interactive
3315 ;;;
3317 (defvar gnus-current-prefix-symbol nil
3318 "Current prefix symbol.")
3320 (defvar gnus-current-prefix-symbols nil
3321 "List of current prefix symbols.")
3323 (defun gnus-interactive (string &optional params)
3324 "Return a list that can be fed to `interactive'.
3325 See `interactive' for full documentation.
3327 Adds the following specs:
3329 y -- The current symbolic prefix.
3330 Y -- A list of the current symbolic prefix(es).
3331 A -- Article number.
3332 H -- Article header.
3333 g -- Group name."
3334 (let ((i 0)
3335 out c prompt)
3336 (while (< i (length string))
3338 (setq c (aref string i))
3339 (when (match-end 1)
3340 (setq prompt (match-string 1 string)))
3341 (setq i (match-end 0))
3342 ;; We basically emulate just about everything that
3343 ;; `interactive' does, but add the specs listed above.
3344 (push
3345 (cond
3346 ((= c ?a)
3347 (completing-read prompt obarray 'fboundp t))
3348 ((= c ?b)
3349 (read-buffer prompt (current-buffer) t))
3350 ((= c ?B)
3351 (read-buffer prompt (other-buffer (current-buffer))))
3352 ((= c ?c)
3353 (read-char))
3354 ((= c ?C)
3355 (completing-read prompt obarray 'commandp t))
3356 ((= c ?d)
3357 (point))
3358 ((= c ?D)
3359 (read-file-name prompt nil default-directory 'lambda))
3360 ((= c ?f)
3361 (read-file-name prompt nil nil 'lambda))
3362 ((= c ?F)
3363 (read-file-name prompt))
3364 ((= c ?k)
3365 (read-key-sequence prompt))
3366 ((= c ?K)
3367 (error "Not implemented spec"))
3368 ((= c ?e)
3369 (error "Not implemented spec"))
3370 ((= c ?m)
3371 (mark))
3372 ((= c ?N)
3373 (error "Not implemented spec"))
3374 ((= c ?n)
3375 (string-to-number (read-from-minibuffer prompt)))
3376 ((= c ?p)
3377 (prefix-numeric-value current-prefix-arg))
3378 ((= c ?P)
3379 current-prefix-arg)
3380 ((= c ?r)
3381 'gnus-prefix-nil)
3382 ((= c ?s)
3383 (read-string prompt))
3384 ((= c ?S)
3385 (intern (read-string prompt)))
3386 ((= c ?v)
3387 (read-variable prompt))
3388 ((= c ?x)
3389 (read-minibuffer prompt))
3390 ((= c ?x)
3391 (eval-minibuffer prompt))
3392 ;; And here the new specs come.
3393 ((= c ?y)
3394 gnus-current-prefix-symbol)
3395 ((= c ?Y)
3396 gnus-current-prefix-symbols)
3397 ((= c ?g)
3398 (gnus-group-group-name))
3399 ((= c ?A)
3400 (gnus-summary-skip-intangible)
3401 (or (get-text-property (point) 'gnus-number)
3402 (gnus-summary-last-subject)))
3403 ((= c ?H)
3404 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3405 (t
3406 (error "Non-implemented spec")))
3407 out)
3408 (cond
3409 ((= c ?r)
3410 (push (if (< (point) (mark)) (point) (mark)) out)
3411 (push (if (> (point) (mark)) (point) (mark)) out))))
3412 (setq out (delq 'gnus-prefix-nil out))
3413 (nreverse out)))
3415 (defun gnus-symbolic-argument (&optional arg)
3416 "Read a symbolic argument and a command, and then execute command."
3417 (interactive "P")
3418 (let* ((in-command (this-command-keys))
3419 (command in-command)
3420 gnus-current-prefix-symbols
3421 gnus-current-prefix-symbol
3422 syms)
3423 (while (equal in-command command)
3424 (message "%s-" (key-description (this-command-keys)))
3425 (push (intern (char-to-string (read-char))) syms)
3426 (setq command (read-key-sequence nil t)))
3427 (setq gnus-current-prefix-symbols (nreverse syms)
3428 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3429 (call-interactively (key-binding command t))))
3431 ;;; More various functions.
3433 (defsubst gnus-check-backend-function (func group)
3434 "Check whether GROUP supports function FUNC.
3435 GROUP can either be a string (a group name) or a select method."
3436 (ignore-errors
3437 (let ((method (if (stringp group)
3438 (car (gnus-find-method-for-group group))
3439 group)))
3440 (unless (featurep method)
3441 (require method))
3442 (fboundp (intern (format "%s-%s" method func))))))
3444 (defun gnus-group-read-only-p (&optional group)
3445 "Check whether GROUP supports editing or not.
3446 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3447 that that variable is buffer-local to the summary buffers."
3448 (let ((group (or group gnus-newsgroup-name)))
3449 (not (gnus-check-backend-function 'request-replace-article group))))
3451 (defun gnus-virtual-group-p (group)
3452 "Say whether GROUP is virtual or not."
3453 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3454 gnus-valid-select-methods)))
3456 (defun gnus-news-group-p (group &optional article)
3457 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3458 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3459 t) ;is news of course.
3460 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3461 nil) ;must be mail then.
3462 ((vectorp article) ;Has header info.
3463 (eq (gnus-request-type group (mail-header-id article)) 'news))
3464 ((null article) ;Hasn't header info
3465 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3466 ((< article 0) ;Virtual message
3467 nil) ;we don't know, guess mail.
3468 (t ;Has positive number
3469 (eq (gnus-request-type group article) 'news)))) ;use it.
3471 ;; Returns a list of writable groups.
3472 (defun gnus-writable-groups ()
3473 (let ((alist gnus-newsrc-alist)
3474 groups group)
3475 (while (setq group (car (pop alist)))
3476 (unless (gnus-group-read-only-p group)
3477 (push group groups)))
3478 (nreverse groups)))
3480 ;; Check whether to use long file names.
3481 (defun gnus-use-long-file-name (symbol)
3482 ;; The variable has to be set...
3483 (and gnus-use-long-file-name
3484 ;; If it isn't a list, then we return t.
3485 (or (not (listp gnus-use-long-file-name))
3486 ;; If it is a list, and the list contains `symbol', we
3487 ;; return nil.
3488 (not (memq symbol gnus-use-long-file-name)))))
3490 ;; Generate a unique new group name.
3491 (defun gnus-generate-new-group-name (leaf)
3492 (let ((name leaf)
3493 (num 0))
3494 (while (gnus-group-entry name)
3495 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3496 name))
3498 (defun gnus-ephemeral-group-p (group)
3499 "Say whether GROUP is ephemeral or not."
3500 (gnus-group-get-parameter group 'quit-config t))
3502 (defun gnus-group-quit-config (group)
3503 "Return the quit-config of GROUP."
3504 (gnus-group-get-parameter group 'quit-config t))
3506 (defun gnus-kill-ephemeral-group (group)
3507 "Remove ephemeral GROUP from relevant structures."
3508 (gnus-sethash group nil gnus-newsrc-hashtb))
3510 (defun gnus-simplify-mode-line ()
3511 "Make mode lines a bit simpler."
3512 (setq mode-line-modified (cdr gnus-mode-line-modified))
3513 (when (listp mode-line-format)
3514 (make-local-variable 'mode-line-format)
3515 (setq mode-line-format (copy-sequence mode-line-format))
3516 (when (equal (nth 3 mode-line-format) " ")
3517 (setcar (nthcdr 3 mode-line-format) " "))))
3519 ;;; Servers and groups.
3521 (defsubst gnus-server-add-address (method)
3522 (let ((method-name (symbol-name (car method))))
3523 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3524 (not (assq (intern (concat method-name "-address")) method))
3525 (memq 'physical-address (assq (car method)
3526 gnus-valid-select-methods)))
3527 (append method (list (list (intern (concat method-name "-address"))
3528 (nth 1 method))))
3529 method)))
3531 (defsubst gnus-method-to-server (method &optional nocache)
3532 (catch 'server-name
3533 (setq method (or method gnus-select-method))
3535 ;; Perhaps it is already in the cache.
3536 (unless nocache
3537 (mapc (lambda (name-method)
3538 (if (equal (cdr name-method) method)
3539 (throw 'server-name (car name-method))))
3540 gnus-server-method-cache))
3542 (mapc
3543 (lambda (server-alist)
3544 (mapc (lambda (name-method)
3545 (when (gnus-methods-equal-p (cdr name-method) method)
3546 (unless (member name-method gnus-server-method-cache)
3547 (push name-method gnus-server-method-cache))
3548 (throw 'server-name (car name-method))))
3549 server-alist))
3550 (list gnus-server-alist
3551 gnus-predefined-server-alist))
3553 (let* ((name (if (member (cadr method) '(nil ""))
3554 (format "%s" (car method))
3555 (format "%s:%s" (car method) (cadr method))))
3556 (name-method (cons name method)))
3557 (unless (member name-method gnus-server-method-cache)
3558 (push name-method gnus-server-method-cache))
3559 name)))
3561 (defsubst gnus-server-to-method (server)
3562 "Map virtual server names to select methods."
3563 (or (and server (listp server) server)
3564 (cdr (assoc server gnus-server-method-cache))
3565 (let ((result
3566 (or
3567 ;; Perhaps this is the native server?
3568 (and (equal server "native") gnus-select-method)
3569 ;; It should be in the server alist.
3570 (cdr (assoc server gnus-server-alist))
3571 ;; It could be in the predefined server alist.
3572 (cdr (assoc server gnus-predefined-server-alist))
3573 ;; If not, we look through all the opened server
3574 ;; to see whether we can find it there.
3575 (let ((opened gnus-opened-servers))
3576 (while (and opened
3577 (not (equal server (format "%s:%s" (caaar opened)
3578 (cadaar opened)))))
3579 (pop opened))
3580 (caar opened))
3581 ;; It could be a named method, search all servers
3582 (let ((servers gnus-secondary-select-methods))
3583 (while (and servers
3584 (not (equal server (format "%s:%s" (caar servers)
3585 (cadar servers)))))
3586 (pop servers))
3587 (car servers))
3588 ;; This could be some sort of foreign server that I
3589 ;; simply haven't opened (yet). Do a brute-force scan
3590 ;; of the entire gnus-newsrc-alist for the server name
3591 ;; of every method. As a side-effect, loads the
3592 ;; gnus-server-method-cache so this only happens once,
3593 ;; if at all.
3594 (let ((alist (cdr gnus-newsrc-alist))
3595 method match)
3596 (while alist
3597 (setq method (gnus-info-method (pop alist)))
3598 (when (and (not (stringp method))
3599 (equal server (gnus-method-to-server method)))
3600 (setq match method
3601 alist nil)))
3602 match))))
3603 (when result
3604 (push (cons server result) gnus-server-method-cache))
3605 result)))
3607 (defsubst gnus-server-get-method (group method)
3608 ;; Input either a server name, and extended server name, or a
3609 ;; select method, and return a select method.
3610 (cond ((stringp method)
3611 (gnus-server-to-method method))
3612 ((equal method gnus-select-method)
3613 gnus-select-method)
3614 ((and (stringp (car method))
3615 group)
3616 (gnus-server-extend-method group method))
3617 ((and method
3618 (not group)
3619 (equal (cadr method) ""))
3620 method)
3621 (t
3622 (gnus-server-add-address method))))
3624 (defmacro gnus-method-equal (ss1 ss2)
3625 "Say whether two servers are equal."
3626 `(let ((s1 ,ss1)
3627 (s2 ,ss2))
3628 (or (equal s1 s2)
3629 (and (= (length s1) (length s2))
3630 (progn
3631 (while (and s1 (member (car s1) s2))
3632 (setq s1 (cdr s1)))
3633 (null s1))))))
3635 (defun gnus-methods-equal-p (m1 m2)
3636 (let ((m1 (or m1 gnus-select-method))
3637 (m2 (or m2 gnus-select-method)))
3638 (or (equal m1 m2)
3639 (and (eq (car m1) (car m2))
3640 (or (not (memq 'address (assoc (symbol-name (car m1))
3641 gnus-valid-select-methods)))
3642 (equal (nth 1 m1) (nth 1 m2)))))))
3644 (defun gnus-server-equal (m1 m2)
3645 "Say whether two methods are equal."
3646 (let ((m1 (cond ((null m1) gnus-select-method)
3647 ((stringp m1) (gnus-server-to-method m1))
3648 (t m1)))
3649 (m2 (cond ((null m2) gnus-select-method)
3650 ((stringp m2) (gnus-server-to-method m2))
3651 (t m2))))
3652 (gnus-method-equal m1 m2)))
3654 (defun gnus-servers-using-backend (backend)
3655 "Return a list of known servers using BACKEND."
3656 (let ((opened gnus-opened-servers)
3657 out)
3658 (while opened
3659 (when (eq backend (caaar opened))
3660 (push (caar opened) out))
3661 (pop opened))
3662 out))
3664 (defun gnus-archive-server-wanted-p ()
3665 "Say whether the user wants to use the archive server."
3666 (cond
3667 ((or (not gnus-message-archive-method)
3668 (not gnus-message-archive-group))
3669 nil)
3670 ((and gnus-message-archive-method gnus-message-archive-group)
3671 t)
3672 (t
3673 (let ((active (cadr (assq 'nnfolder-active-file
3674 gnus-message-archive-method))))
3675 (and active
3676 (file-exists-p active))))))
3678 (defsubst gnus-method-to-server-name (method)
3679 (concat
3680 (format "%s" (car method))
3681 (when (and
3682 (or (assoc (format "%s" (car method))
3683 (gnus-methods-using 'address))
3684 (gnus-server-equal method gnus-message-archive-method))
3685 (nth 1 method)
3686 (not (string= (nth 1 method) "")))
3687 (concat "+" (nth 1 method)))))
3689 (defsubst gnus-method-to-full-server-name (method)
3690 (format "%s+%s" (car method) (nth 1 method)))
3692 (defun gnus-group-prefixed-name (group method &optional full)
3693 "Return the whole name from GROUP and METHOD.
3694 Call with full set to get the fully qualified group name (even if the
3695 server is native)."
3696 (when (stringp method)
3697 (setq method (gnus-server-to-method method)))
3698 (if (or (not method)
3699 (and (not full) (gnus-server-equal method "native"))
3700 ;;;!!! This might not be right. We'll see...
3701 ;(string-match ":" group)
3702 )
3703 group
3704 (concat (gnus-method-to-server-name method) ":" group)))
3706 (defun gnus-group-guess-prefixed-name (group)
3707 "Guess the whole name from GROUP and METHOD."
3708 (gnus-group-prefixed-name group (gnus-find-method-for-group
3709 group)))
3711 (defun gnus-group-full-name (group method)
3712 "Return the full name from GROUP and METHOD, even if the method is native."
3713 (gnus-group-prefixed-name group method t))
3715 (defun gnus-group-guess-full-name (group)
3716 "Guess the full name from GROUP, even if the method is native."
3717 (if (gnus-group-prefixed-p group)
3718 group
3719 (gnus-group-full-name group (gnus-find-method-for-group group))))
3721 (defun gnus-group-guess-full-name-from-command-method (group)
3722 "Guess the full name from GROUP, even if the method is native."
3723 (if (gnus-group-prefixed-p group)
3724 group
3725 (gnus-group-full-name group gnus-command-method)))
3727 (defun gnus-group-real-prefix (group)
3728 "Return the prefix of the current group name."
3729 (if (stringp group)
3730 (if (string-match "^[^:]+:" group)
3731 (substring group 0 (match-end 0))
3732 "")
3733 nil))
3735 (defun gnus-group-short-name (group)
3736 "Return the short group name."
3737 (let ((prefix (gnus-group-real-prefix group)))
3738 (if (< 0 (length prefix))
3739 (substring group (length prefix) nil)
3740 group)))
3742 (defun gnus-group-prefixed-p (group)
3743 "Return the prefix of the current group name."
3744 (< 0 (length (gnus-group-real-prefix group))))
3746 (declare-function gnus-group-decoded-name "gnus-group" (string))
3748 (defun gnus-summary-buffer-name (group)
3749 "Return the summary buffer name of GROUP."
3750 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3752 (defun gnus-group-method (group)
3753 "Return the server or method used for selecting GROUP.
3754 You should probably use `gnus-find-method-for-group' instead."
3755 (let ((prefix (gnus-group-real-prefix group)))
3756 (if (equal prefix "")
3757 gnus-select-method
3758 (let ((servers gnus-opened-servers)
3759 (server "")
3760 backend possible found)
3762 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3763 server (substring prefix (match-end 0) (1- (length prefix))))
3764 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3765 (while servers
3766 (when (eq (caaar servers) backend)
3767 (setq possible (caar servers))
3768 (when (equal (cadaar servers) server)
3769 (setq found (caar servers))))
3770 (pop servers))
3771 (or (car (rassoc found gnus-server-alist))
3772 found
3773 (car (rassoc possible gnus-server-alist))
3774 possible
3775 (list backend server))))))
3777 (defsubst gnus-native-method-p (method)
3778 "Return whether METHOD is the native select method."
3779 (gnus-method-equal method gnus-select-method))
3781 (defsubst gnus-secondary-method-p (method)
3782 "Return whether METHOD is a secondary select method."
3783 (let ((methods gnus-secondary-select-methods)
3784 (gmethod (inline (gnus-server-get-method nil method))))
3785 (while (and methods
3786 (not (gnus-method-equal
3787 (inline (gnus-server-get-method nil (car methods)))
3788 gmethod)))
3789 (setq methods (cdr methods)))
3790 methods))
3792 (defun gnus-method-simplify (method)
3793 "Return the shortest uniquely identifying string or method for METHOD."
3794 (cond ((stringp method)
3795 method)
3796 ((gnus-native-method-p method)
3797 nil)
3798 ((gnus-secondary-method-p method)
3799 (format "%s:%s" (nth 0 method) (nth 1 method)))
3800 (t
3801 method)))
3803 (defun gnus-groups-from-server (server)
3804 "Return a list of all groups that are fetched from SERVER."
3805 (let ((alist (cdr gnus-newsrc-alist))
3806 info groups)
3807 (while (setq info (pop alist))
3808 (when (gnus-server-equal (gnus-info-method info) server)
3809 (push (gnus-info-group info) groups)))
3810 (sort groups 'string<)))
3812 (defun gnus-group-foreign-p (group)
3813 "Say whether a group is foreign or not."
3814 (and (not (gnus-group-native-p group))
3815 (not (gnus-group-secondary-p group))))
3817 (defun gnus-group-native-p (group)
3818 "Say whether the group is native or not."
3819 (not (string-match ":" group)))
3821 (defun gnus-group-secondary-p (group)
3822 "Say whether the group is secondary or not."
3823 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3825 (defun gnus-parameters-get-parameter (group)
3826 "Return the group parameters for GROUP from `gnus-parameters'."
3827 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3828 case-fold-search
3829 gnus-parameters-case-fold-search))
3830 params-list)
3831 (dolist (elem gnus-parameters)
3832 (when (string-match (car elem) group)
3833 (setq params-list
3834 (nconc (gnus-expand-group-parameters
3835 (car elem) (cdr elem) group)
3836 params-list))))
3837 params-list))
3839 (defun gnus-expand-group-parameter (match value group)
3840 "Use MATCH to expand VALUE in GROUP."
3841 (with-temp-buffer
3842 (insert group)
3843 (goto-char (point-min))
3844 (while (re-search-forward match nil t)
3845 (replace-match value))
3846 (buffer-string)))
3848 (defun gnus-expand-group-parameters (match parameters group)
3849 "Go through PARAMETERS and expand them according to the match data."
3850 (let (new)
3851 (dolist (elem parameters)
3852 (if (and (stringp (cdr elem))
3854 (push (cons (car elem)
3855 (gnus-expand-group-parameter match (cdr elem) group))
3856 new)
3857 (push elem new)))
3858 new))
3860 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3861 "For GROUP, return the value of SYMBOL.
3863 You should call this in the `gnus-group-buffer' buffer.
3864 The function `gnus-group-find-parameter' will do that for you."
3865 ;; The speed trick: No cons'ing and quit early.
3866 (let* ((params (funcall gnus-group-get-parameter-function group))
3867 ;; Start easy, check the "real" group parameters.
3868 (simple-results
3869 (gnus-group-parameter-value params symbol allow-list t)))
3870 (if simple-results
3871 ;; Found results; return them.
3872 (car simple-results)
3873 ;; We didn't find it there, try `gnus-parameters'.
3874 (let ((result nil)
3875 (head nil)
3876 (tail gnus-parameters))
3877 ;; A good old-fashioned non-cl loop.
3878 (while tail
3879 (setq head (car tail)
3880 tail (cdr tail))
3881 ;; The car is regexp matching for matching the group name.
3882 (when (string-match (car head) group)
3883 ;; The cdr is the parameters.
3884 (setq result (gnus-group-parameter-value (cdr head)
3885 symbol allow-list))
3886 (when result
3887 ;; Expand if necessary.
3889 (setq result (gnus-expand-group-parameter (car head)
3890 result group)))
3891 ;; Exit the loop early.
3892 (setq tail nil))))
3893 ;; Done.
3894 result))))
3896 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3897 "Return the group parameters for GROUP.
3898 If SYMBOL, return the value of that symbol in the group parameters.
3900 If you call this function inside a loop, consider using the faster
3901 `gnus-group-fast-parameter' instead."
3902 (save-excursion
3903 (set-buffer gnus-group-buffer)
3904 (if symbol
3905 (gnus-group-fast-parameter group symbol allow-list)
3906 (nconc
3907 (copy-sequence
3908 (funcall gnus-group-get-parameter-function group))
3909 (gnus-parameters-get-parameter group)))))
3911 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3912 "Return the group parameters for GROUP.
3913 If SYMBOL, return the value of that symbol in the group parameters.
3914 If ALLOW-LIST, also allow list as a result.
3915 Most functions should use `gnus-group-find-parameter', which
3916 also examines the topic parameters."
3917 (let ((params (gnus-info-params (gnus-get-info group))))
3918 (if symbol
3919 (gnus-group-parameter-value params symbol allow-list)
3920 params)))
3922 (defun gnus-group-parameter-value (params symbol &optional
3923 allow-list present-p)
3924 "Return the value of SYMBOL in group PARAMS.
3925 If ALLOW-LIST, also allow list as a result."
3926 ;; We only wish to return group parameters (dotted lists) and
3927 ;; not local variables, which may have the same names.
3928 ;; But first we handle single elements...
3929 (or (car (memq symbol params))
3930 ;; Handle alist.
3931 (let (elem)
3932 (catch 'found
3933 (while (setq elem (pop params))
3934 (when (and (consp elem)
3935 (eq (car elem) symbol)
3936 (or allow-list
3937 (atom (cdr elem))))
3938 (throw 'found (if present-p (list (cdr elem))
3939 (cdr elem)))))))))
3941 (defun gnus-group-add-parameter (group param)
3942 "Add parameter PARAM to GROUP."
3943 (let ((info (gnus-get-info group)))
3944 (when info
3945 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3946 ;; Cons the new param to the old one and update.
3947 (gnus-group-set-info (cons param (gnus-info-params info))
3948 group 'params))))
3950 (defun gnus-group-set-parameter (group name value)
3951 "Set parameter NAME to VALUE in GROUP."
3952 (let ((info (gnus-get-info group)))
3953 (when info
3954 (gnus-group-remove-parameter group name)
3955 (let ((old-params (gnus-info-params info))
3956 (new-params (list (cons name value))))
3957 (while old-params
3958 (when (or (not (listp (car old-params)))
3959 (not (eq (caar old-params) name)))
3960 (setq new-params (append new-params (list (car old-params)))))
3961 (setq old-params (cdr old-params)))
3962 (gnus-group-set-info new-params group 'params)))))
3964 (defun gnus-group-remove-parameter (group name)
3965 "Remove parameter NAME from GROUP."
3966 (let ((info (gnus-get-info group)))
3967 (when info
3968 (let ((params (gnus-info-params info)))
3969 (when params
3970 (setq params (delq name params))
3971 (while (assq name params)
3972 (gnus-pull name params))
3973 (gnus-info-set-params info params))))))
3975 (defun gnus-group-add-score (group &optional score)
3976 "Add SCORE to the GROUP score.
3977 If SCORE is nil, add 1 to the score of GROUP."
3978 (let ((info (gnus-get-info group)))
3979 (when info
3980 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3982 (defun gnus-short-group-name (group &optional levels)
3983 "Collapse GROUP name LEVELS.
3984 Select methods are stripped and any remote host name is stripped down to
3985 just the host name."
3986 (let* ((name "")
3987 (foreign "")
3988 (depth 0)
3989 (skip 1)
3990 (levels (or levels
3991 gnus-group-uncollapsed-levels
3992 (progn
3994 (setq skip (match-end 0)
3995 depth (+ depth 1)))
3996 depth))))
3997 ;; Separate foreign select method from group name and collapse.
3998 ;; If method contains a server, collapse to non-domain server name,
3999 ;; otherwise collapse to select method.
4000 (let* ((colon (string-match ":" group))
4001 (server (and colon (substring group 0 colon)))
4002 (plus (and server (string-match "+" server))))
4003 (when server
4004 (if plus
4005 (setq foreign (substring server (+ 1 plus)
4007 group (substring group (+ 1 colon)))
4008 (setq foreign server
4009 group (substring group (+ 1 colon))))
4010 (setq foreign (concat foreign ":")))
4011 ;; Collapse group name leaving LEVELS uncollapsed elements
4012 (let* ((slist (split-string group "/"))
4013 (slen (length slist))
4015 (dlen (length dlist))
4016 glist
4017 glen
4018 gsep
4019 res)
4020 (if (> slen dlen)
4021 (setq glist slist
4022 glen slen
4023 gsep "/")
4024 (setq glist dlist
4025 glen dlen
4026 gsep "."))
4027 (setq levels (- glen levels))
4028 (dolist (g glist)
4029 (push (if (>= (decf levels) 0)
4030 (if (zerop (length g))
4031 ""
4032 (substring g 0 1))
4033 g)
4034 res))
4035 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4037 (defun gnus-narrow-to-body ()
4038 "Narrow to the body of an article."
4039 (narrow-to-region
4040 (progn
4041 (goto-char (point-min))
4043 (point-max)))
4044 (point-max)))
4046 \f
4047 ;;;
4048 ;;; Kill file handling.
4049 ;;;
4051 (defun gnus-apply-kill-file ()
4052 "Apply a kill file to the current newsgroup.
4053 Returns the number of articles marked as read."
4054 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4055 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4056 (gnus-apply-kill-file-internal)
4057 0))
4059 (defun gnus-kill-save-kill-buffer ()
4060 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4061 (when (get-file-buffer file)
4062 (save-excursion
4063 (set-buffer (get-file-buffer file))
4064 (when (buffer-modified-p)
4065 (save-buffer))
4066 (kill-buffer (current-buffer))))))
4068 (defcustom gnus-kill-file-name "KILL"
4069 "Suffix of the kill files."
4070 :group 'gnus-score-kill
4071 :group 'gnus-score-files
4072 :type 'string)
4074 (defun gnus-newsgroup-kill-file (newsgroup)
4075 "Return the name of a kill file name for NEWSGROUP.
4076 If NEWSGROUP is nil, return the global kill file name instead."
4077 (cond
4078 ;; The global KILL file is placed at top of the directory.
4079 ((or (null newsgroup)
4080 (string-equal newsgroup ""))
4081 (expand-file-name gnus-kill-file-name
4082 gnus-kill-files-directory))
4083 ;; Append ".KILL" to newsgroup name.
4084 ((gnus-use-long-file-name 'not-kill)
4085 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4086 "." gnus-kill-file-name)
4087 gnus-kill-files-directory))
4088 ;; Place "KILL" under the hierarchical directory.
4089 (t
4090 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4091 "/" gnus-kill-file-name)
4092 gnus-kill-files-directory))))
4094 ;;; Server things.
4096 (defun gnus-member-of-valid (symbol group)
4098 (memq symbol (assoc
4099 (symbol-name (car (gnus-find-method-for-group group)))
4100 gnus-valid-select-methods)))
4102 (defun gnus-method-option-p (method option)
4103 "Return non-nil if select METHOD has OPTION as a parameter."
4104 (when (stringp method)
4105 (setq method (gnus-server-to-method method)))
4106 (memq option (assoc (format "%s" (car method))
4107 gnus-valid-select-methods)))
4109 (defun gnus-similar-server-opened (method)
4110 (let ((opened gnus-opened-servers))
4111 (while (and method opened)
4112 (when (and (equal (cadr method) (cadaar opened))
4113 (equal (car method) (caaar opened))
4114 (not (equal method (caar opened))))
4115 (setq method nil))
4116 (pop opened))
4117 (not method)))
4119 (defun gnus-server-extend-method (group method)
4120 ;; This function "extends" a virtual server. If the server is
4121 ;; "hello", and the select method is ("hello" (my-var "something"))
4122 ;; in the group "alt.alt", this will result in a new virtual server
4123 ;; called "hello+alt.alt".
4124 (if (or (not (inline (gnus-similar-server-opened method)))
4125 (not (cddr method)))
4126 method
4127 `(,(car method) ,(concat (cadr method) "+" group)
4128 (,(intern (format "%s-address" (car method))) ,(cadr method))
4129 ,@(cddr method))))
4131 (defun gnus-server-status (method)
4132 "Return the status of METHOD."
4133 (nth 1 (assoc method gnus-opened-servers)))
4135 (defun gnus-group-name-to-method (group)
4136 "Guess a select method based on GROUP."
4137 (if (string-match ":" group)
4138 (let ((server (substring group 0 (match-beginning 0))))
4140 (list (intern (substring server 0 (match-beginning 0)))
4141 (substring server (match-end 0)))
4142 (list (intern server) "")))
4143 gnus-select-method))
4145 (defun gnus-server-string (server)
4146 "Return a readable string that describes SERVER."
4147 (let* ((server (gnus-server-to-method server))
4148 (address (nth 1 server)))
4149 (if (and address
4150 (not (zerop (length address))))
4151 (format "%s using %s" address (car server))
4152 (format "%s" (car server)))))
4154 (defun gnus-find-method-for-group (group &optional info)
4155 "Find the select method that GROUP uses."
4156 (or gnus-override-method
4157 (and (not group)
4158 gnus-select-method)
4159 (and (not (gnus-group-entry group))
4160 ;; Killed or otherwise unknown group.
4161 (or
4162 ;; If we know a virtual server by that name, return its method.
4163 (gnus-server-to-method (gnus-group-server group))
4164 ;; Guess a new method as last resort.
4165 (gnus-group-name-to-method group)))
4166 (let ((info (or info (gnus-get-info group)))
4167 method)
4168 (if (or (not info)
4169 (not (setq method (gnus-info-method info)))
4170 (equal method "native"))
4171 gnus-select-method
4172 (setq method
4173 (cond ((stringp method)
4174 (inline (gnus-server-to-method method)))
4175 ((stringp (cadr method))
4176 (inline (gnus-server-extend-method group method)))
4177 (t
4178 method)))
4179 (cond ((equal (cadr method) "")
4180 method)
4181 ((null (cadr method))
4182 (list (car method) ""))
4183 (t
4184 (gnus-server-add-address method)))))))
4186 (defun gnus-methods-using (feature)
4187 "Find all methods that have FEATURE."
4188 (let ((valids gnus-valid-select-methods)
4189 outs)
4190 (while valids
4191 (when (memq feature (car valids))
4192 (push (car valids) outs))
4193 (setq valids (cdr valids)))
4194 outs))
4196 (eval-and-compile
4197 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4199 (defun gnus-read-group (prompt &optional default)
4200 "Prompt the user for a group name.
4201 Disallow invalid group names."
4202 (let ((prefix "")
4203 group)
4204 (while (not group)
4205 (when (string-match
4206 gnus-invalid-group-regexp
4207 (setq group (read-string (concat prefix prompt)
4208 (cons (or default "") 0)
4209 'gnus-group-history)))
4210 (let ((match (match-string 0 group)))
4211 ;; Might be okay (e.g. for nnimap), so ask the user:
4213 (message-y-or-n-p
4214 "Proceed and create group anyway? " t
4217 Usually, it's dangerous to create a group with this name, because it's not
4218 supported by all back ends and servers. On IMAP servers it should work,
4219 though. If you are really sure, you can proceed anyway and create the group.
4221 You may customize the variable `gnus-invalid-group-regexp', which currently is
4225 group nil)))))
4226 group))
4228 (defun gnus-read-method (prompt)
4229 "Prompt the user for a method.
4230 Allow completion over sensible values."
4231 (let* ((open-servers
4232 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4233 gnus-opened-servers))
4234 (valid-methods
4235 (let (methods)
4236 (dolist (method gnus-valid-select-methods)
4237 (if (or (memq 'prompt-address method)
4238 (not (assoc (format "%s:" (car method)) open-servers)))
4239 (push method methods)))
4240 methods))
4241 (servers
4242 (append valid-methods
4243 open-servers
4244 gnus-predefined-server-alist
4245 gnus-server-alist))
4246 (method
4247 (completing-read
4248 prompt servers
4249 nil t nil 'gnus-method-history)))
4250 (cond
4251 ((equal method "")
4252 (setq method gnus-select-method))
4253 ((assoc method gnus-valid-select-methods)
4254 (let ((address (if (memq 'prompt-address
4255 (assoc method gnus-valid-select-methods))
4256 (read-string "Address: ")
4257 "")))
4258 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4259 (list (intern method) address))))
4260 ((assoc method servers)
4261 method)
4262 (t
4263 (list (intern method) "")))))
4265 ;;; Agent functions
4267 (defun gnus-agent-method-p (method-or-server)
4268 "Say whether METHOD is covered by the agent."
4269 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4270 (let* ((method (if (stringp method-or-server)
4271 (gnus-server-to-method method-or-server)
4272 method-or-server))
4273 (server (gnus-method-to-server method t)))
4274 (setq gnus-agent-method-p-cache
4275 (cons method-or-server
4276 (member server gnus-agent-covered-methods)))))
4277 (cdr gnus-agent-method-p-cache))
4279 (defun gnus-online (method)
4280 (not
4281 (if gnus-plugged
4282 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4283 (gnus-agent-method-p method))))
4285 ;;; User-level commands.
4287 ;;;###autoload
4288 (defun gnus-slave-no-server (&optional arg)
4289 "Read network news as a slave, without connecting to the local server."
4290 (interactive "P")
4291 (gnus-no-server arg t))
4293 ;;;###autoload
4294 (defun gnus-no-server (&optional arg slave)
4295 "Read network news.
4296 If ARG is a positive number, Gnus will use that as the startup
4297 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4298 non-nil and not a positive number, Gnus will prompt the user for the
4299 name of an NNTP server to use.
4300 As opposed to `gnus', this command will not connect to the local
4301 server."
4302 (interactive "P")
4303 (gnus-no-server-1 arg slave))
4305 ;;;###autoload
4306 (defun gnus-slave (&optional arg)
4307 "Read news as a slave."
4308 (interactive "P")
4309 (gnus arg nil 'slave))
4311 ;;;###autoload
4312 (defun gnus-other-frame (&optional arg display)
4313 "Pop up a frame to read news.
4314 This will call one of the Gnus commands which is specified by the user
4315 option `gnus-other-frame-function' (default `gnus') with the argument
4316 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4317 optional second argument DISPLAY should be a standard display string
4319 omitted or the function `make-frame-on-display' is not available, the
4320 current display is used."
4321 (interactive "P")
4322 (if (fboundp 'make-frame-on-display)
4323 (unless display
4324 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4325 (setq display nil))
4326 (let ((alive (gnus-alive-p)))
4327 (unless (and alive
4328 (catch 'found
4329 (walk-windows
4330 (lambda (window)
4331 (when (and (or (not display)
4332 (equal display
4333 (gnus-frame-or-window-display-name
4334 window)))
4335 (with-current-buffer (window-buffer window)
4337 (symbol-name major-mode))))
4338 (gnus-select-frame-set-input-focus
4339 (setq gnus-other-frame-object (window-frame window)))
4340 (select-window window)
4341 (throw 'found t)))
4342 'ignore t)))
4343 (gnus-select-frame-set-input-focus
4344 (setq gnus-other-frame-object
4345 (if display
4346 (make-frame-on-display display gnus-other-frame-parameters)
4347 (make-frame gnus-other-frame-parameters))))
4348 (if alive
4349 (switch-to-buffer gnus-group-buffer)
4350 (funcall gnus-other-frame-function arg)
4351 (add-hook 'gnus-exit-gnus-hook
4352 '(lambda nil
4353 (when (and (frame-live-p gnus-other-frame-object)
4354 (cdr (frame-list)))
4355 (delete-frame gnus-other-frame-object))
4356 (setq gnus-other-frame-object nil)))))))
4358 ;;;###autoload
4359 (defun gnus (&optional arg dont-connect slave)
4360 "Read network news.
4361 If ARG is non-nil and a positive number, Gnus will use that as the
4362 startup level. If ARG is non-nil and not a positive number, Gnus will
4363 prompt the user for the name of an NNTP server to use."
4364 (interactive "P")
4365 (unless (byte-code-function-p (symbol-function 'gnus))
4366 (message "You should byte-compile Gnus")
4367 (sit-for 2))
4368 (gnus-1 arg dont-connect slave))
4370 ;; Allow redefinition of Gnus functions.
4372 (gnus-ems-redefine)
4374 (provide 'gnus)
4376 ;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4377 ;;; gnus.el ends here