| blob | 45d944947530b3a0112229d047d27fd73d988391 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; Keywords: news, mail
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;;; Code:
32 ;; For Emacs < 22.2.
41 ;; These are defined afterwards with gnus-define-group-parameter
55 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
60 "Starting your favorite newsreader."
64 "Dealing with formatting issues."
68 "Group character set issues."
74 "Cache interface."
79 "Article Registry."
83 "Server options at startup."
86 ;; These belong to gnus-group.el.
88 "Group buffers."
93 "Foreign groups."
98 "Automatic subscription of new groups."
102 "Group levels."
107 "Selecting a Group."
112 "Showing slices of the group list."
117 "Sorting the group buffer."
123 "Various group options."
127 ;; These belong to gnus-sum.el.
129 "Summary buffers."
134 "Leaving summary buffers."
139 "Marks used in summary buffers."
144 "Ordering articles according to replies."
149 "Formatting of the summary buffer."
154 "Choosing Articles."
159 "Summary movement commands."
164 "Show pictures of people, domains, and newsgroups."
168 "Mail group commands."
173 "Sorting the summary buffer."
178 "Highlighting and menus in the summary buffer."
184 "Various summary buffer options."
189 "Pick mode in the summary buffer."
195 "Tree display of threads in the summary buffer."
200 ;; Belongs to gnus-uu.el
202 "Viewing extracted files."
206 ;; Belongs to gnus-score.el
208 "Score and kill file handling."
212 "Kill files."
216 "Adaptive score files."
220 "Default values for score files."
224 "Expiring score rules."
228 "Decaying score rules."
232 "Score and kill file names."
237 "Various scoring and killing options."
240 ;; Other
242 "Options controlling the visual fluff."
247 "Offline support for Gnus."
251 "Files used by Gnus."
255 "Auto save file."
260 "Storing Gnus state."
264 "Options related to newsservers and other servers used by Gnus."
268 "Highlighting and menus in the server buffer."
273 "Composing replies and followups in Gnus."
277 "Meta variables controlling major portions of Gnus.
278 In general, modifying these variables does not take affect until Gnus
279 is restarted, and sometimes reloaded."
283 "Other Gnus options."
288 "Exiting Gnus."
293 "Frivolous Gnus extensions."
304 "If non-nil, the startup message will not be displayed.
305 This variable is used before `.gnus.el' is loaded, so it should
306 be set in `.emacs' instead."
311 "If non-nil, play the Gnus jingle at startup."
341 0 5
350 gnus-mode-line-image-cache)
352 "This is %s, %s."
354 str)
356 line)))
362 ;;(defalias 'gnus-decode-rfc1522 'ignore)
363 )
365 ;; We define these group faces here to avoid the display
366 ;; update forced when creating new faces.
376 ()))
377 "Level 1 newsgroup face."
379 ;; backward-compatibility alias
390 ()))
391 "Level 1 empty newsgroup face."
393 ;; backward-compatibility alias
404 ()))
405 "Level 2 newsgroup face."
407 ;; backward-compatibility alias
418 ()))
419 "Level 2 empty newsgroup face."
421 ;; backward-compatibility alias
432 ()))
433 "Level 3 newsgroup face."
435 ;; backward-compatibility alias
441 ())
444 ())
446 ()))
447 "Level 3 empty newsgroup face."
449 ;; backward-compatibility alias
460 ()))
461 "Level 4 newsgroup face."
463 ;; backward-compatibility alias
469 ())
472 ())
474 ()))
475 "Level 4 empty newsgroup face."
477 ;; backward-compatibility alias
488 ()))
489 "Level 5 newsgroup face."
491 ;; backward-compatibility alias
497 ())
500 ())
502 ()))
503 "Level 5 empty newsgroup face."
505 ;; backward-compatibility alias
516 ()))
517 "Level 6 newsgroup face."
519 ;; backward-compatibility alias
525 ())
528 ())
530 ()))
531 "Level 6 empty newsgroup face."
533 ;; backward-compatibility alias
544 ()))
545 "Low level newsgroup face."
547 ;; backward-compatibility alias
558 ()))
559 "Low level empty newsgroup face."
561 ;; backward-compatibility alias
573 "Level 1 mailgroup face."
575 ;; backward-compatibility alias
587 "Level 1 empty mailgroup face."
589 ;; backward-compatibility alias
601 "Level 2 mailgroup face."
603 ;; backward-compatibility alias
615 "Level 2 empty mailgroup face."
617 ;; backward-compatibility alias
629 "Level 3 mailgroup face."
631 ;; backward-compatibility alias
642 ()))
643 "Level 3 empty mailgroup face."
645 ;; backward-compatibility alias
657 "Low level mailgroup face."
659 ;; backward-compatibility alias
671 "Low level empty mailgroup face."
673 ;; backward-compatibility alias
676 ;; Summary mode faces.
679 "Face used for selected articles."
681 ;; backward-compatibility alias
687 "Face used for cancelled articles."
689 ;; backward-compatibility alias
701 "Face used for high interest ticked articles."
703 ;; backward-compatibility alias
715 "Face used for low interest ticked articles."
717 ;; backward-compatibility alias
728 ()))
729 "Face used for normal interest ticked articles."
731 ;; backward-compatibility alias
743 "Face used for high interest ancient articles."
745 ;; backward-compatibility alias
757 "Face used for low interest ancient articles."
759 ;; backward-compatibility alias
770 ()))
771 "Face used for normal interest ancient articles."
773 ;; backward-compatibility alias
783 "Face used for high interest uncached articles."
785 ;; backward-compatibility alias
795 "Face used for low interest uncached articles."
797 ;; backward-compatibility alias
807 "Face used for normal interest uncached articles."
809 ;; backward-compatibility alias
815 "Face used for high interest unread articles."
817 ;; backward-compatibility alias
823 "Face used for low interest unread articles."
825 ;; backward-compatibility alias
830 ()))
831 "Face used for normal interest unread articles."
833 ;; backward-compatibility alias
847 "Face used for high interest read articles."
849 ;; backward-compatibility alias
863 "Face used for low interest read articles."
865 ;; backward-compatibility alias
876 ()))
877 "Face used for normal interest read articles."
879 ;; backward-compatibility alias
883 ;;;
884 ;;; Gnus buffers
885 ;;;
890 "Do the same as `get-buffer-create', but store the created buffer."
895 "Add the current buffer to the list of Gnus buffers."
899 "Kill BUFFER and remove from the list of Gnus buffers."
906 "Return a list of live Gnus buffers."
915 gnus-buffers)
917 ;;; 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))
999 "Insert startup message in current buffer."
1000 ;; Insert the message.
1006 ;; Make sure the library defining `image-load-path' is loaded
1007 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1008 ;; get "defvar ignored because image-load-path is let-bound" when calling
1009 ;; `find-image' below.
1021 :color-symbols
1027 ;; Account for the pbm's blackground.
1031 ;; Account for the xbm's blackground.
1042 t))))
1046 _ ___ _ _
1047 _ ___ __ ___ __ _ ___
1048 __ _ ___ __ ___
1049 _ ___ _
1050 _ _ __ _
1051 ___ __ _
1052 __ _
1053 _ _ _
1054 _ _ _
1055 _ _ _
1056 __ ___
1057 _ _ _ _
1058 _ _
1059 _ _
1060 _ _
1061 _
1062 __
1064 "
1066 ;; And then hack it.
1075 ;; Fontify some.
1089 ;;; Do the rest.
1095 "Alist of group parameters.
1097 For example:
1099 (gnus-use-scoring nil)
1100 (gnus-summary-line-format
1102 (gcc-self . t)
1103 (display . all))
1106 (broken-reply-to . t)))"
1113 "If it is t, ignore case of group names specified in `gnus-parameters'.
1114 If it is nil, don't ignore case. If it is `default', which is for the
1115 backward compatibility, use the value of `case-fold-search'."
1126 "Define a group parameter PARAM.
1127 REST is a plist of following:
1128 :type One of `bool', `list' or nil.
1129 :function The name of the function.
1130 :function-document The documentation of the function.
1131 :parameter-type The type for customizing the parameter.
1132 :parameter-document The documentation for the parameter.
1133 :variable The name of the variable.
1134 :variable-document The documentation for the variable.
1135 :variable-group The group for customizing the variable.
1136 :variable-type The type for customizing the variable.
1137 :variable-default The default value of the variable."
1154 'progn
1156 ,variable-document
1162 gnus-group-parameters-more))
1165 ,parameter-type
1169 ,function-document
1171 val)
1174 t)
1179 (,variable
1181 elem value)
1189 ,function-document
1193 elem value)
1200 'value
1205 All other Gnus file and directory variables are initialized from this variable."
1211 "*Directory variable from which all other Gnus file variables are derived.
1213 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1214 This means that other directory variables that are initialized from
1215 this variable won't be set properly if you set this variable in `.gnus.el'.
1216 Set this variable in `.emacs' instead."
1221 "*Default directory for all Gnus buffers."
1224 directory))
1226 ;; Site dependent variables. These variables should be defined in
1227 ;; paths.el.
1230 "Specify a default NNTP server.
1231 This variable should be defined in paths.el, and should never be set
1232 by the user.
1233 If you want to change servers, you should use `gnus-select-method'.
1236 ;; Don't touch this variable.
1239 This is an obsolete variable, which is scarcely used. If you use an
1240 nntp server for your newsgroup and want to change the port number
1241 used to 899, you would say something along these lines:
1246 "A file with only the name of the nntp server in it."
1252 "Find default nntp server.
1253 Check the NNTPSERVER environment variable and the
1254 `gnus-nntpserver-file' file."
1262 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1263 ;; starting or even loading Gnus.
1264 ;;;###autoload(when (fboundp 'custom-autoload)
1265 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1275 gnus-default-nntp-server)
1279 nil
1282 "Default method for selecting a newsgroup.
1283 This variable should be a list, where the first element is how the
1284 news is to be fetched, the second is the address.
1287 NNTP, you could say:
1291 If you want to use your local spool, say:
1293 \(setq gnus-select-method (list 'nnspool (system-name)))
1295 If you use this variable, you must set `gnus-nntp-server' to nil.
1297 There is a lot more to know about select methods and virtual servers -
1298 see the manual for details."
1305 "*Method used for archiving messages you've sent.
1306 This should be a mail method.
1308 See also `gnus-update-message-archive-method'."
1312 gnus-select-method))
1317 The archive method is initially set according to the value of
1319 so that it may be used as a real method of the server which is named
1321 updated if the value of this variable is nil, even if you change the
1322 value of `gnus-message-archive-method' afterward. If you want the
1324 `gnus-message-archive-method', set this variable to a non-nil value."
1331 "*Name of the group in which to save the messages you've written.
1332 This can either be a string; a list of strings; or an alist
1333 of regexps/functions/forms to be evaluated to return a string (or a list
1334 of strings). The functions are called with the name of the current
1335 group (or nil) as a parameter.
1337 If you want to save your mail in one group and the news articles you
1338 write in another group, you could say something like:
1340 \(setq gnus-message-archive-group
1341 '((if (message-news-p)
1345 Normally the group names returned by this variable should be
1347 However, you may wish to store the message on some other server. In
1348 that case, just return a fully prefixed name of the group --
1352 function
1353 sexp
1354 string))
1357 "List of NNTP servers that the user can choose between interactively.
1358 To make Gnus query you for a server, you have to give `gnus' a
1359 non-numeric prefix - `C-u M-x gnus', in short."
1364 "*The name of the host running the NNTP server.
1365 This variable is semi-obsolete. Use the `gnus-select-method'
1366 variable instead."
1369 string))
1372 "A list of secondary methods that will be used for reading news.
1373 This is a list where each element is a complete select method (see
1374 `gnus-select-method').
1376 If, for instance, you want to read your mail with the nnml back end,
1377 you could set this variable:
1385 "Default default new newsgroups the first time Gnus is run.
1389 "Local domain name without a host name.
1390 The DOMAINNAME environment variable is used instead if it is defined.
1391 If the function `system-name' returns the full Internet name, there is
1392 no need to set this variable."
1395 string))
1398 "String with a description of what organization (if any) the user belongs to.
1401 ;; Customization variables
1404 "Preferred method for fetching an article by Message-ID.
1405 If you are reading news from the local spool (with nnspool), fetching
1406 articles by Message-ID is painfully slow. By setting this method to an
1407 nntp method, you might get acceptable results.
1409 The value of this variable must be a valid select method as discussed
1410 in the documentation of `gnus-select-method'.
1412 It can also be a list of select methods, as well as the special symbol
1413 `current', which means to use the current select method. If it is a
1414 list, Gnus will try all the methods in the list until it finds a match."
1419 gnus-select-method
1427 gnus-select-method))))
1431 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1432 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1433 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1434 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1435 "/ftp@rtfm.mit.edu:/pub/usenet/"
1436 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1437 "/ftp@ftp.sunet.se:/pub/usenet/"
1438 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1439 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1441 "*Directory where the group FAQs are stored.
1442 This will most commonly be on a remote machine, and the file will be
1443 fetched by ange-ftp.
1445 This variable can also be a list of directories. In that case, the
1446 first element in the list will be used by default. The others can
1447 be used when being prompted for a site.
1449 Note that Gnus uses an aol machine as the default directory. If this
1450 feels fundamentally unclean, just think of it as a way to finally get
1451 something of value back from them.
1453 If the default site is too slow, try one of these:
1455 North America: mirrors.aol.com /pub/rtfm/usenet
1456 ftp.seas.gwu.edu /pub/rtfm
1457 rtfm.mit.edu /pub/usenet
1458 Europe: ftp.uni-paderborn.de /pub/FAQ
1459 src.doc.ic.ac.uk /usenet/news-FAQS
1460 ftp.sunet.se /pub/usenet
1461 ftp.pasteur.fr /pub/FAQ
1462 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1463 hwarang.postech.ac.kr /pub/usenet
1464 ftp.hk.super.net /mirror/faqs"
1491 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1492 When FORM is evaluated `name' is bound to the name of the group."
1499 "*Non-nil means that control messages are displayed using `browse-url'.
1500 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1501 group."
1507 "*Non-nil means that cross referenced articles will be marked as read.
1508 If nil, ignore cross references. If t, mark articles as read in
1509 subscribed newsgroups. If neither t nor nil, mark as read in all
1510 newsgroups."
1518 "*Process mark."
1524 "*The number of articles which indicates a large newsgroup.
1525 If the number of articles in a newsgroup is greater than this value,
1526 confirmation is required for selecting the newsgroup.
1527 If it is nil, no confirmation is required."
1530 integer))
1533 "*Non-nil means that the default name of a file to save articles in is the group name.
1534 If it's nil, the directory form of the group name is used instead.
1536 If this variable is a list, and the list contains the element
1537 `not-score', long file names will not be used for score files; if it
1538 contains the element `not-save', long file names will not be used for
1539 saving; and if it contains the element `not-kill', long file names
1540 will not be used for kill files.
1542 Note that the default for this variable varies according to what system
1543 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1544 to nil while on all other systems it defaults to t."
1562 "*If non-nil, save group scoring info."
1568 "*If non-nil, allow undoing in Gnus group mode buffers."
1573 "*If non-nil, use some adaptive scoring scheme.
1574 If a list, then the values `word' and `line' are meaningful. The
1575 former will perform adaption on individual words in the subject
1576 header while `line' will perform adaption on several headers."
1582 "*If nil, Gnus will ignore the article cache.
1583 If `passive', it will allow entering (and reading) articles
1584 explicitly entered into the cache. If anything else, use the
1585 cache to the full extent of the law."
1593 "*If non-nil, display a thread tree buffer."
1598 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1599 If it is a number N, then Gnus will only keep the last N articles
1600 read. If it is neither nil nor a number, Gnus will keep all read
1601 articles. This is not a good idea."
1604 integer
1609 "*If non-nil, Gnus will read NoCeM cancel messages.
1610 You can also set this variable to a positive number as a group level.
1611 In that case, Gnus scans NoCeM messages when checking new news if this
1612 value is not exceeding a group level that you specify as the prefix
1613 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1614 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1615 level to those commands."
1624 gnus-level-default-subscribed
1628 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1633 "*If non-nil, enable scoring."
1639 "*A hook called when preparing to exit from the summary buffer.
1640 It calls `gnus-summary-expire-articles' by default."
1645 "*Non-nil means that you are a Usenet novice.
1646 If non-nil, verbose messages may be displayed and confirmations may be
1647 required."
1652 "*Non-nil means that you will never be asked for confirmation about anything.
1653 That doesn't mean *anything* anything; particularly destructive
1654 commands will still require prompting."
1659 "*If non-nil, require your confirmation when catching up a group."
1664 "*If non-nil, require your confirmation when exiting Gnus."
1669 "*Function for extracting address components from a From header.
1670 Two pre-defined function exist: `gnus-extract-address-components',
1671 which is the default, quite fast, and too simplistic solution, and
1672 `mail-extract-address-components', which works much better, but is
1673 slower."
1680 "*If non-nil, display clickable icons."
1685 "String used to separate shell commands."
1717 "*An alist of valid select methods.
1718 The first element of each list lists should be a string with the name
1719 of the select method. The other elements may be the category of
1720 this method (i. e., `post', `mail', `none' or whatever) or other
1721 properties that this method has (like being respoolable).
1722 If you implement a new select method, all you should have to change is
1723 this variable. I think."
1738 "Recomputes the select-method widget based on the value of
1739 `gnus-valid-select-methods'."
1741 "Widget for entering a select method."
1748 gnus-valid-select-methods)
1752 :inline t
1754 variable
1760 "List of buffers that should update their mode lines.
1761 The list may contain the symbols `group', `article', `tree' and
1762 `summary'. If the corresponding symbol is present, Gnus will keep
1763 that mode line updated with information that may be pertinent.
1764 If this variable is nil, screen refresh may be quicker."
1771 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1773 "*Max length of mode-line non-string contents.
1774 If this is nil, Gnus will take space as is needed, leaving the rest
1775 of the mode line intact. Note that the default of nil is unlikely
1776 to be desirable; see the manual for further details."
1779 integer))
1781 ;; There should be special validation for this.
1786 to-address
1787 :function-document
1788 "Return GROUP's to-address."
1789 :variable-document
1790 "*Alist of group regexps and correspondent to-addresses."
1791 :variable-group gnus-group-parameter
1794 This will be used when doing followups and posts.
1796 This is primarily useful in mail groups that represent closed
1797 mailing lists--mailing lists where it's expected that everybody that
1798 writes to the mailing list is subscribed to it. Since using this
1799 parameter ensures that the mail only goes to the mailing list itself,
1800 it means that members won't receive two copies of your followups.
1802 Using `to-address' will actually work whether the group is foreign or
1803 not. Let's say there's a group on the server that is called
1804 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1805 articles from a mail-to-news gateway. Posting directly to this group
1806 is therefore impossible--you have to send mail to the mailing list
1807 address instead.
1809 The gnus-group-split mail splitting mechanism will behave as if this
1813 to-list
1814 :function-document
1815 "Return GROUP's to-list."
1816 :variable-document
1817 "*Alist of group regexps and correspondent to-lists."
1818 :variable-group gnus-group-parameter
1821 This address will be used when doing a `a' in the group.
1823 It is totally ignored when doing a followup--except that if it is
1824 present in a news group, you'll get mail group semantics when doing
1825 `f'.
1827 The gnus-group-split mail splitting mechanism will behave as if this
1831 subscribed
1832 :type bool
1833 :function-document
1834 "Return GROUP's subscription status."
1835 :variable-document
1836 "*Groups which are automatically considered subscribed."
1837 :variable-group gnus-group-parameter
1840 Gnus assumed that you are subscribed to the To/List address.
1842 When constructing a list of subscribed groups using
1843 `gnus-find-subscribed-addresses', Gnus includes the To address given
1847 auto-expire
1848 :type bool
1849 :function gnus-group-auto-expirable-p
1850 :function-document
1851 "Check whether GROUP is auto-expirable or not."
1852 :variable gnus-auto-expirable-newsgroups
1853 :variable-default nil
1854 :variable-document
1855 "*Groups in which to automatically mark read articles as expirable.
1856 If non-nil, this should be a regexp that should match all groups in
1857 which to perform auto-expiry. This only makes sense for mail groups."
1858 :variable-group nnmail-expire
1860 regexp)
1862 :parameter-document
1866 total-expire
1867 :type bool
1868 :function gnus-group-total-expirable-p
1869 :function-document
1870 "Check whether GROUP is total-expirable or not."
1871 :variable gnus-total-expirable-newsgroups
1872 :variable-default nil
1873 :variable-document
1874 "*Groups in which to perform expiry of all read articles.
1875 Use with extreme caution. All groups that match this regexp will be
1876 expiring - which means that all read articles will be deleted after
1877 \(say) one week. (This only goes for mail groups and the like, of
1878 course.)"
1879 :variable-group nnmail-expire
1881 regexp)
1883 :parameter-document
1884 "All read articles will be put through the expiry process
1886 This happens even if they are not marked as expirable.
1890 charset
1891 :function-document
1892 "Return the default charset of GROUP."
1893 :variable gnus-group-charset-alist
1894 :variable-default
1907 :variable-document
1908 "Alist of regexps (to match group names) and default charsets to be used when reading."
1909 :variable-group gnus-charset
1917 post-method
1918 :type list
1919 :function-document
1920 "Return a posting method for GROUP."
1921 :variable gnus-post-method-alist
1922 :variable-document
1923 "Alist of regexps (to match group names) and method to be used when
1924 posting an article."
1925 :variable-group gnus-group-foreign
1926 :parameter-type
1934 :parameter-document
1938 large-newsgroup-initial
1939 :type integer
1940 :function-document
1941 "Return GROUP's initial input of the number of articles."
1942 :variable-document
1943 "*Alist of group regexps and its initial input of the number of articles."
1944 :variable-group gnus-group-parameter
1950 This number will be prompted as the initial value of the number of
1951 articles to list when the group is a large newsgroup (see
1952 `gnus-large-newsgroup'). If it is nil, the default value is the
1955 ;; The Gnus registry's ignored groups
1957 registry-ignore
1958 :type list
1959 :function-document
1960 "Whether this group should be ignored by the registry."
1961 :variable gnus-registry-ignored-groups
1962 :variable-default nil
1963 :variable-document
1964 "*Groups in which the registry should be turned off."
1965 :variable-group gnus-registry
1972 :parameter-document
1975 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1977 "*Disable the group parameters for spam detection.
1978 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1985 "Spam group classification (requires spam.el).
1986 This group contains spam messages. On summary entry, unread messages
1987 will be marked as spam. On summary exit, the specified spam
1988 processors will be invoked on spam-marked messages, then those
1989 messages will be expired, so the spam processor will only see a
1993 "The ham value for the spam group parameter (requires spam.el).
1994 On summary exit, the specified ham processors will be invoked on
1995 ham-marked messages. Exercise caution, since the ham processor will
1996 see the same message more than once because there is no ham message
2000 spam-contents
2001 :type list
2002 :function-document
2003 "The spam type (spam, ham, or neither) of the group."
2004 :variable gnus-spam-newsgroup-contents
2005 :variable-default nil
2006 :variable-document
2007 "*Group classification (spam, ham, or neither). Only
2008 meaningful when spam.el is loaded. If non-nil, this should be a
2009 list of group name regexps associated with a classification for
2010 each one. In spam groups, new articles are marked as spam on
2011 summary entry. There is other behavior associated with ham and
2012 no classification when spam.el is loaded - see the manual."
2013 :variable-group spam
2027 :parameter-document
2028 "The spam classification (spam, ham, or neither) of this group.
2029 When a spam group is entered, all unread articles are marked as
2030 spam. There is other behavior associated with ham and no
2034 spam-resend-to
2035 :type list
2036 :function-document
2037 "The address to get spam resent (through spam-report-resend)."
2038 :variable gnus-spam-resend-to
2039 :variable-default nil
2040 :variable-document
2041 "The address to get spam resent (through spam-report-resend)."
2042 :variable-group spam
2046 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2047 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2048 :parameter-document
2052 ham-resend-to
2053 :type list
2054 :function-document
2055 "The address to get ham resent (through spam-report-resend)."
2056 :variable gnus-ham-resend-to
2057 :variable-default nil
2058 :variable-document
2059 "The address to get ham resent (through spam-report-resend)."
2060 :variable-group spam
2064 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2065 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2066 :parameter-document
2082 "OBSOLETE: The Gmane reporting summary exit spam processor.
2089 "OBSOLETE: The ifile summary exit ham processor.
2093 "OBSOLETE: The Bogofilter summary exit ham processor.
2097 "OBSOLETE: The spam-stat summary exit ham processor.
2101 "OBSOLETE: The whitelist summary exit ham processor.
2105 "OBSOLETE: The BBDB summary exit ham processor.
2109 "OBSOLETE: The ham copy exit ham processor.
2113 "OBSOLETE: The spamoracle summary exit ham processor.
2117 spam-process
2118 :type list
2119 :parameter-type
2122 :value nil
2159 :function-document
2160 "Which spam or ham processors will be applied when the summary is exited."
2161 :variable gnus-spam-process-newsgroups
2162 :variable-default nil
2163 :variable-document
2164 "*Groups in which to automatically process spam or ham articles with
2165 a backend on summary exit. If non-nil, this should be a list of group
2166 name regexps that should match all groups in which to do automatic
2167 spam processing, associated with the appropriate processor."
2168 :variable-group spam
2169 :variable-type
2210 :parameter-document
2214 spam-autodetect
2215 :type list
2216 :parameter-type
2218 :function-document
2219 "Should spam be autodetected (with spam-split) in this group?"
2220 :variable gnus-spam-autodetect
2221 :variable-default nil
2222 :variable-document
2223 "*Groups in which spam should be autodetected when they are entered.
2224 Only unseen articles will be examined, unless
2225 spam-autodetect-recheck-messages is set."
2226 :variable-group spam
2227 :variable-type
2232 boolean))
2233 :parameter-document
2234 "Spam autodetection.
2235 Only unseen articles will be examined, unless
2239 spam-autodetect-methods
2240 :type list
2241 :parameter-type
2264 :function-document
2265 "Methods to be used for autodetection in each group"
2266 :variable gnus-spam-autodetect-methods
2267 :variable-default nil
2268 :variable-document
2269 "*Methods for autodetecting spam per group.
2270 Requires the spam-autodetect parameter. Only unseen articles
2271 will be examined, unless spam-autodetect-recheck-messages is
2272 set."
2273 :variable-group spam
2274 :variable-type
2301 :parameter-document
2302 "Spam autodetection methods.
2303 Requires the spam-autodetect parameter. Only unseen articles
2304 will be examined, unless spam-autodetect-recheck-messages is
2308 spam-process-destination
2309 :type list
2310 :parameter-type
2316 :function-document
2317 "Where spam-processed articles will go at summary exit."
2318 :variable gnus-spam-process-destinations
2319 :variable-default nil
2320 :variable-document
2321 "*Groups in which to explicitly send spam-processed articles to
2322 another group, or expire them (the default). If non-nil, this should
2323 be a list of group name regexps that should match all groups in which
2324 to do spam-processed article moving, associated with the destination
2325 group or nil for explicit expiration. This only makes sense for
2326 mail groups."
2327 :variable-group spam
2328 :variable-type
2339 :parameter-document
2343 ham-process-destination
2344 :type list
2345 :parameter-type
2353 :function-document
2354 "Where ham articles will go at summary exit from a spam group."
2355 :variable gnus-ham-process-destinations
2356 :variable-default nil
2357 :variable-document
2358 "*Groups in which to explicitly send ham articles to
2359 another group, or do nothing (the default). If non-nil, this should
2360 be a list of group name regexps that should match all groups in which
2361 to do ham article moving, associated with the destination
2362 group or nil for explicit ignoring. This only makes sense for
2363 mail groups, and only works in spam groups."
2364 :variable-group spam
2365 :variable-type
2377 :parameter-document
2381 ham-marks
2392 :parameter-document
2393 "Marks considered ham (positively not spam). Such articles will be
2394 processed as ham (non-spam) on group exit. When nil, the global
2395 spam-ham-marks variable takes precedence."
2397 gnus-read-mark
2398 gnus-killed-mark
2399 gnus-kill-file-mark
2400 gnus-low-score-mark))))
2401 :variable-group spam
2402 :variable-document
2406 spam-marks
2415 :parameter-document
2416 "Marks considered spam.
2417 Such articles will be processed as spam on group exit. When nil, the global
2418 spam-spam-marks variable takes precedence."
2420 :variable-group spam
2421 :variable-document
2425 "Number of group name elements to leave alone when making a short group name."
2430 "*If non-nil, once you set a level, Gnus will use this level."
2434 ;; Hooks.
2437 "A hook run while Gnus is loaded."
2442 "A hook called to apply kill files to a group.
2443 This hook is intended to apply a kill file to the selected newsgroup.
2444 The function `gnus-apply-kill-file' is called by default.
2446 Since a general kill file is too heavy to use only for a few
2447 newsgroups, I recommend you to use a lighter hook function. For
2448 example, if you'd like to apply a kill file to articles which contains
2449 a string `rmgroup' in subject in newsgroup `control', you can use the
2450 following hook:
2452 (setq gnus-apply-kill-hook
2453 (list
2454 (lambda ()
2463 "Function run when a group level is changed.
2464 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2467 function))
2469 ;;; Face thingies.
2473 mouse-face
2474 summary-menu group-menu article-menu
2475 tree-highlight menu highlight
2476 browse-menu server-menu
2477 page-marker tree-menu binary-menu pick-menu)
2478 "*Enable visual features.
2479 If `visual' is disabled, there will be no menus and few faces. Most of
2480 the visual customization options below will be ignored. Gnus will use
2481 less space and be faster as a result.
2483 This variable can also be a list of visual elements to switch on. For
2484 instance, to switch off all visual things except menus, you can say:
2486 (setq gnus-visual '(menu))
2488 Valid elements include `summary-highlight', `group-highlight',
2489 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2490 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2491 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2511 ;; Byte-compiler warning.
2513 ;; Find out whether the gnus-visual TYPE is wanted.
2517 gnus-visual
2521 t))))
2531 "*Face used for group or summary buffer mouse highlighting.
2532 The line beneath the mouse pointer will be highlighted with this
2533 face."
2546 "Controls use of the agent cache while plugged.
2547 When set, Gnus will prefer using the locally stored content rather
2548 than re-fetching it from the server. You also need to enable
2549 `gnus-agent' for this to have any affect."
2555 "Default charset assumed to be used when viewing non-ASCII characters.
2556 This variable is overridden on a group-to-group basis by the
2557 `gnus-group-charset-alist' variable and is only used on groups not
2558 covered by that variable."
2562 ;; Fixme: Doc reference to agent.
2564 "Whether we want to use the Gnus agent or not.
2566 You may customize gnus-agent to disable its use. However, some
2567 back ends have started to use the agent as a client-side cache.
2568 Disabling the agent may result in noticeable loss of performance."
2574 "Function called by the command `gnus-other-frame'."
2582 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2583 This should be an alist for Emacs, or a plist for XEmacs."
2594 "Which information should be exposed in the User-Agent header.
2596 Can be a list of symbols or a string. Valid symbols are `gnus'
2597 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2598 addition to the Emacs version, you can add `codename' \(show
2599 \(S\)XEmacs codename\) or either `config' \(show system
2600 configuration\) or `type' \(show system type\). If you set it to
2601 a string, be sure to use a valid format, see RFC 2616."
2614 ;; Convert old (< 2005-01-10) symbol type values:
2633 \f
2634 ;;; Internal variables
2639 ; Reset each time gnus-agent-covered-methods is changed else
2640 ; gnus-agent-method-p may mis-report a methods status.
2641 )
2665 ;; Dummy variable.
2668 ;; Variable holding the user answers to all method prompts.
2671 ;; Variable holding the user answers to all mail method prompts.
2674 ;; Variable holding the user answers to all group prompts.
2682 "*The directory where cached articles will be stored."
2688 nnspool "cache"
2712 ;; Propagate flags to server, with the following exceptions:
2713 ;; `seen' is private to each gnus installation
2714 ;; `cache' is a internal gnus flag for each gnus installation
2715 ;; `download' is a agent flag private to each gnus installation
2716 ;; `unsend' are for nndraft groups only
2717 ;; `score' is not a proper mark
2718 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2721 "Marks that shouldn't be propagated to back ends.
2722 Typical marks are those that make no sense in a standalone back end,
2723 such as a mark that says whether an article is stored in the cache
2736 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2761 gnus-newsrc-last-checked-date
2762 gnus-newsrc-alist gnus-server-alist
2763 gnus-killed-list gnus-zombie-list
2764 gnus-topic-topology gnus-topic-alist
2765 gnus-format-specs)
2769 "Assoc list of read articles.
2773 "Assoc list of registry data.
2800 ;; Save window configuration.
2805 ;;; Let the byte-compiler know that we know about this variable.
2816 ;;; End of variables.
2818 ;; Define some autoload functions Gnus might use.
2821 ;; This little mapcar goes through the list below and marks the
2822 ;; symbols in question as autoloaded functions.
2842 message-send-and-exit message-yank-original)
2848 rmail-show-message rmail-summary-exists
2849 rmail-select-summary rmail-update-summary)
2853 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2854 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2858 gnus-Folder-save-name gnus-folder-save-name)
2861 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2862 gnus-demon-add-disconnection gnus-demon-add-handler
2863 gnus-demon-remove-handler)
2865 gnus-demon-init gnus-demon-cancel)
2867 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2868 gnus-face-from-file)
2870 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2872 gnus-nocem-unwanted-article-p)
2874 gnus-server-server-name)
2877 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2878 gnus-article-hide-citation gnus-article-fill-cited-article
2879 gnus-article-hide-citation-in-followups)
2881 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2882 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2884 gnus-cache-possibly-remove-articles gnus-cache-request-article
2885 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2886 gnus-cache-enter-remove-article gnus-cached-article-p
2887 gnus-cache-open gnus-cache-close gnus-cache-update-article
2888 gnus-cache-articles-in-group)
2890 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2892 gnus-summary-increase-score gnus-summary-set-score
2893 gnus-summary-raise-thread gnus-summary-raise-same-subject
2894 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2895 gnus-summary-lower-thread gnus-summary-lower-same-subject
2896 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2897 gnus-summary-current-score gnus-score-delta-default
2898 gnus-score-flush-cache gnus-score-close
2899 gnus-possibly-score-headers gnus-score-followup-article
2900 gnus-score-followup-thread)
2903 gnus-current-score-file-nondirectory gnus-score-adaptive
2904 gnus-score-find-trace gnus-score-file-name)
2908 gnus-subscribe-topics)
2912 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2913 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2914 gnus-uu-mark-by-regexp gnus-uu-mark-all
2915 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2916 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2917 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2918 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2919 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2920 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2921 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2922 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2925 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2927 gnus-group-post-news gnus-group-mail gnus-group-news
2928 gnus-summary-post-news gnus-summary-news-other-window
2929 gnus-summary-followup gnus-summary-followup-with-original
2930 gnus-summary-cancel-article gnus-summary-supersede-article
2931 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2932 gnus-summary-mail-forward gnus-summary-mail-other-window
2933 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2934 gnus-summary-wide-reply gnus-summary-followup-to-mail
2935 gnus-summary-followup-to-mail-with-original gnus-bug
2936 gnus-summary-wide-reply-with-original
2937 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2938 gnus-summary-post-forward)
2943 gnus-list-of-unread-articles gnus-list-of-read-articles
2944 gnus-offer-save-summaries gnus-make-thread-indent-array
2945 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2946 gnus-summary-skip-intangible gnus-summary-article-number
2947 gnus-data-header gnus-data-find)
2949 gnus-group-list-groups gnus-group-first-unread-group
2950 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2951 gnus-group-setup-buffer gnus-group-get-new-news
2952 gnus-group-make-help-group gnus-group-update-group
2953 gnus-group-iterate gnus-group-group-name)
2955 gnus-backlog-remove-article)
2957 gnus-article-prepare gnus-article-set-window-start
2958 gnus-article-next-page gnus-article-prev-page
2959 gnus-request-article-this-buffer gnus-article-mode
2960 gnus-article-setup-buffer gnus-narrow-to-page
2961 gnus-article-delete-invisible-text gnus-treat-article)
2963 gnus-article-hide-headers gnus-article-hide-boring-headers
2964 gnus-article-treat-overstrike
2965 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2966 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2967 gnus-article-de-base64-unreadable
2968 gnus-article-decode-HZ
2969 gnus-article-wash-html
2970 gnus-article-unsplit-urls
2971 gnus-article-hide-pem gnus-article-hide-signature
2972 gnus-article-strip-leading-blank-lines gnus-article-date-local
2973 gnus-article-date-original gnus-article-date-lapsed
2974 ;;gnus-article-show-all-headers
2975 gnus-article-edit-mode gnus-article-edit-article
2976 gnus-article-edit-done gnus-article-decode-encoded-words
2977 gnus-start-date-timer gnus-stop-date-timer
2978 gnus-mime-view-all-parts)
2981 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2982 gnus-check-reasonable-setup)
2984 gnus-dup-enter-articles)
2988 gnus-group-move-group-to-server gnus-change-server)
2992 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2993 gnus-async-halt-prefetch)
2995 gnus-agent-save-active gnus-agent-method-p
2996 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2997 gnus-summary-set-agent-mark gnus-agent-save-group-info
2998 gnus-agent-request-article gnus-agent-retrieve-headers)
3000 gnus-unplugged gnus-agentize gnus-agent-batch)
3002 gnus-summary-save-article-vm)
3007 gnus-group-split-update)
3010 ;;; gnus-sum.el thingies
3014 "*The format specification of the lines in the summary buffer.
3016 It works along the same lines as a normal formatting string,
3017 with some simple extensions.
3019 %N Article number, left padded with spaces (string)
3020 %S Subject (string)
3022 %n Name of the poster (string)
3023 %a Extracted name of the poster (string)
3024 %A Extracted address of the poster (string)
3025 %F Contents of the From: header (string)
3026 %f Contents of the From: or To: headers (string)
3027 %x Contents of the Xref: header (string)
3028 %D Date of the article (string)
3029 %d Date of the article (string) in DD-MMM format
3030 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
3031 %M Message-id of the article (string)
3032 %r References of the article (string)
3033 %c Number of characters in the article (integer)
3034 %k Pretty-printed version of the above (string)
3036 %L Number of lines in the article (integer)
3037 %I Indentation based on thread level (a string of spaces)
3038 %B A complex trn-style thread tree (string)
3039 The variables `gnus-sum-thread-*' can be used for customization.
3040 %T A string with two possible values: 80 spaces if the article
3041 is on thread level two or larger and 0 spaces on level one
3046 %> Spaces of length thread-level (string)
3047 %< Spaces of length (- 20 thread-level) (string)
3048 %i Article score (number)
3049 %z Article zcore (character)
3050 %t Number of articles under the current thread (number).
3051 %e Whether the thread is empty or not (character).
3052 %V Total thread score (number).
3053 %P The line number (number).
3054 %O Download mark (character).
3055 %* If present, indicates desired cursor position
3056 (instead of after first colon).
3057 %u User defined specifier. The next character in the format string should
3058 be a letter. Gnus will call the function gnus-user-format-function-X,
3059 where X is the letter following %u. The function will be passed the
3060 current header as argument. The function should return a string, which
3061 will be inserted into the summary just like information from any other
3062 summary specifier.
3064 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3065 with care. For reasons of efficiency, Gnus will compute what column
3067 it is invalid to have these specs after a variable-length spec. Well,
3068 you might not be arrested, but your summary buffer will look strange,
3069 which is bad enough.
3071 The smart choice is to have these specs as far to the left as
3072 possible.
3074 This restriction may disappear in later versions of Gnus.
3076 General format specifiers can also be used.
3077 See Info node `(gnus)Formatting Variables'."
3082 ;;;
3083 ;;; Skeleton keymaps
3084 ;;;
3089 (while keys
3090 (define-key keymap (pop keys) 'undefined))))
3092 (defvar gnus-article-mode-map
3093 (let ((keymap (make-sparse-keymap)))
3094 (gnus-suppress-keymap keymap)
3095 keymap))
3096 (defvar gnus-summary-mode-map
3097 (let ((keymap (make-keymap)))
3098 (gnus-suppress-keymap keymap)
3099 keymap))
3100 (defvar gnus-group-mode-map
3101 (let ((keymap (make-keymap)))
3102 (gnus-suppress-keymap keymap)
3103 keymap))
3105 \f
3107 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3108 ;; If you want the cursor to go somewhere else, set these two
3109 ;; functions in some startup hook to whatever you want.
3110 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3111 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3113 ;;; Various macros and substs.
3115 (defun gnus-header-from (header)
3116 (mail-header-from header))
3118 (defmacro gnus-gethash (string hashtable)
3119 "Get hash value of STRING in HASHTABLE."
3120 `(symbol-value (intern-soft ,string ,hashtable)))
3122 (defmacro gnus-gethash-safe (string hashtable)
3123 "Get hash value of STRING in HASHTABLE.
3124 Return nil if not defined."
3125 `(let ((sym (intern-soft ,string ,hashtable)))
3126 (and (boundp sym) (symbol-value sym))))
3128 (defmacro gnus-sethash (string value hashtable)
3129 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3130 `(set (intern ,string ,hashtable) ,value))
3131 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3133 (defmacro gnus-group-unread (group)
3134 "Get the currently computed number of unread articles in GROUP."
3135 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3137 (defmacro gnus-group-entry (group)
3138 "Get the newsrc entry for GROUP."
3139 `(gnus-gethash ,group gnus-newsrc-hashtb))
3141 (defmacro gnus-active (group)
3142 "Get active info on GROUP."
3143 `(gnus-gethash ,group gnus-active-hashtb))
3145 (defmacro gnus-set-active (group active)
3146 "Set GROUP's active info."
3147 `(gnus-sethash ,group ,active gnus-active-hashtb))
3149 ;; Info access macros.
3151 (defmacro gnus-info-group (info)
3152 `(nth 0 ,info))
3153 (defmacro gnus-info-rank (info)
3154 `(nth 1 ,info))
3155 (defmacro gnus-info-read (info)
3156 `(nth 2 ,info))
3157 (defmacro gnus-info-marks (info)
3158 `(nth 3 ,info))
3159 (defmacro gnus-info-method (info)
3160 `(nth 4 ,info))
3161 (defmacro gnus-info-params (info)
3162 `(nth 5 ,info))
3164 (defmacro gnus-info-level (info)
3165 `(let ((rank (gnus-info-rank ,info)))
3166 (if (consp rank)
3167 (car rank)
3168 rank)))
3169 (defmacro gnus-info-score (info)
3170 `(let ((rank (gnus-info-rank ,info)))
3171 (or (and (consp rank) (cdr rank)) 0)))
3173 (defmacro gnus-info-set-group (info group)
3174 `(setcar ,info ,group))
3175 (defmacro gnus-info-set-rank (info rank)
3176 `(setcar (nthcdr 1 ,info) ,rank))
3177 (defmacro gnus-info-set-read (info read)
3178 `(setcar (nthcdr 2 ,info) ,read))
3179 (defmacro gnus-info-set-marks (info marks &optional extend)
3180 (if extend
3181 `(gnus-info-set-entry ,info ,marks 3)
3182 `(setcar (nthcdr 3 ,info) ,marks)))
3183 (defmacro gnus-info-set-method (info method &optional extend)
3184 (if extend
3185 `(gnus-info-set-entry ,info ,method 4)
3186 `(setcar (nthcdr 4 ,info) ,method)))
3187 (defmacro gnus-info-set-params (info params &optional extend)
3188 (if extend
3189 `(gnus-info-set-entry ,info ,params 5)
3190 `(setcar (nthcdr 5 ,info) ,params)))
3192 (defun gnus-info-set-entry (info entry number)
3193 ;; Extend the info until we have enough elements.
3194 (while (<= (length info) number)
3195 (nconc info (list nil)))
3196 ;; Set the entry.
3197 (setcar (nthcdr number info) entry))
3199 (defmacro gnus-info-set-level (info level)
3200 `(let ((rank (cdr ,info)))
3201 (if (consp (car rank))
3202 (setcar (car rank) ,level)
3203 (setcar rank ,level))))
3204 (defmacro gnus-info-set-score (info score)
3205 `(let ((rank (cdr ,info)))
3206 (if (consp (car rank))
3207 (setcdr (car rank) ,score)
3208 (setcar rank (cons (car rank) ,score)))))
3210 (defmacro gnus-get-info (group)
3211 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3213 ;;; Load the compatibility functions.
3215 (require 'gnus-ems)
3217 \f
3218 ;;;
3219 ;;; Shutdown
3220 ;;;
3222 (defvar gnus-shutdown-alist nil)
3224 (defun gnus-add-shutdown (function &rest symbols)
3225 "Run FUNCTION whenever one of SYMBOLS is shut down."
3226 (push (cons function symbols) gnus-shutdown-alist))
3228 (defun gnus-shutdown (symbol)
3229 "Shut down everything that waits for SYMBOL."
3230 (dolist (entry gnus-shutdown-alist)
3231 (when (memq symbol (cdr entry))
3232 (funcall (car entry)))))
3234 \f
3235 ;;;
3236 ;;; Gnus Utility Functions
3237 ;;;
3239 (defun gnus-find-subscribed-addresses ()
3240 "Return a regexp matching the addresses of all subscribed mail groups.
3241 It consists of the `to-address' or `to-list' parameter of all groups
3242 with a `subscribed' parameter."
3243 (let (group address addresses)
3244 (dolist (entry (cdr gnus-newsrc-alist))
3245 (setq group (car entry))
3246 (when (gnus-parameter-subscribed group)
3247 (setq address (mail-strip-quoted-names
3248 (or (gnus-group-fast-parameter group 'to-address)
3249 (gnus-group-fast-parameter group 'to-list))))
3250 (when address
3251 (add-to-list 'addresses address))))
3252 (when addresses
3255 (defmacro gnus-string-or (&rest strings)
3256 "Return the first element of STRINGS that is a non-blank string.
3257 STRINGS will be evaluated in normal `or' order."
3258 `(gnus-string-or-1 ',strings))
3260 (defun gnus-string-or-1 (strings)
3261 (let (string)
3262 (while strings
3263 (setq string (eval (pop strings)))
3265 (setq string nil)
3266 (setq strings nil)))
3267 string))
3269 (defun gnus-version (&optional arg)
3270 "Version number of this version of Gnus.
3271 If ARG, insert string at point."
3272 (interactive "P")
3273 (if arg
3274 (insert (message gnus-version))
3275 (message gnus-version)))
3277 (defun gnus-continuum-version (&optional version)
3278 "Return VERSION as a floating point number."
3279 (interactive)
3280 (unless version
3281 (setq version gnus-version))
3284 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3285 (number (match-string 2 version))
3286 major minor least)
3287 (unless (string-match
3289 (error "Invalid version string: %s" version))
3290 (setq major (string-to-number (match-string 1 number))
3291 minor (string-to-number (match-string 2 number))
3292 least (if (match-beginning 3)
3293 (string-to-number (match-string 3 number))
3294 0))
3295 (string-to-number
3296 (if (zerop major)
3297 (format "%s00%02d%02d"
3298 (if (member alpha '("(ding)" "d"))
3299 "4.99"
3300 (+ 5 (* 0.02
3301 (abs
3302 (- (mm-char-int (aref (downcase alpha) 0))
3303 (mm-char-int ?t))))
3304 -0.01))
3305 minor least)
3306 (format "%d.%02d%02d" major minor least))))))
3308 (defun gnus-info-find-node (&optional nodename)
3309 "Find Info documentation of Gnus."
3310 (interactive)
3311 ;; Enlarge info window if needed.
3312 (let (gnus-info-buffer)
3313 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3314 (setq gnus-info-buffer (current-buffer))
3315 (gnus-configure-windows 'info)))
3317 ;;;
3318 ;;; gnus-interactive
3319 ;;;
3321 (defvar gnus-current-prefix-symbol nil
3322 "Current prefix symbol.")
3324 (defvar gnus-current-prefix-symbols nil
3325 "List of current prefix symbols.")
3327 (defun gnus-interactive (string &optional params)
3328 "Return a list that can be fed to `interactive'.
3329 See `interactive' for full documentation.
3331 Adds the following specs:
3333 y -- The current symbolic prefix.
3334 Y -- A list of the current symbolic prefix(es).
3335 A -- Article number.
3336 H -- Article header.
3337 g -- Group name."
3338 (let ((i 0)
3339 out c prompt)
3340 (while (< i (length string))
3342 (setq c (aref string i))
3343 (when (match-end 1)
3344 (setq prompt (match-string 1 string)))
3345 (setq i (match-end 0))
3346 ;; We basically emulate just about everything that
3347 ;; `interactive' does, but add the specs listed above.
3348 (push
3349 (cond
3350 ((= c ?a)
3351 (completing-read prompt obarray 'fboundp t))
3352 ((= c ?b)
3353 (read-buffer prompt (current-buffer) t))
3354 ((= c ?B)
3355 (read-buffer prompt (other-buffer (current-buffer))))
3356 ((= c ?c)
3357 (read-char))
3358 ((= c ?C)
3359 (completing-read prompt obarray 'commandp t))
3360 ((= c ?d)
3361 (point))
3362 ((= c ?D)
3363 (read-file-name prompt nil default-directory 'lambda))
3364 ((= c ?f)
3365 (read-file-name prompt nil nil 'lambda))
3366 ((= c ?F)
3367 (read-file-name prompt))
3368 ((= c ?k)
3369 (read-key-sequence prompt))
3370 ((= c ?K)
3371 (error "Not implemented spec"))
3372 ((= c ?e)
3373 (error "Not implemented spec"))
3374 ((= c ?m)
3375 (mark))
3376 ((= c ?N)
3377 (error "Not implemented spec"))
3378 ((= c ?n)
3379 (string-to-number (read-from-minibuffer prompt)))
3380 ((= c ?p)
3381 (prefix-numeric-value current-prefix-arg))
3382 ((= c ?P)
3383 current-prefix-arg)
3384 ((= c ?r)
3385 'gnus-prefix-nil)
3386 ((= c ?s)
3387 (read-string prompt))
3388 ((= c ?S)
3389 (intern (read-string prompt)))
3390 ((= c ?v)
3391 (read-variable prompt))
3392 ((= c ?x)
3393 (read-minibuffer prompt))
3394 ((= c ?x)
3395 (eval-minibuffer prompt))
3396 ;; And here the new specs come.
3397 ((= c ?y)
3398 gnus-current-prefix-symbol)
3399 ((= c ?Y)
3400 gnus-current-prefix-symbols)
3401 ((= c ?g)
3402 (gnus-group-group-name))
3403 ((= c ?A)
3404 (gnus-summary-skip-intangible)
3405 (or (get-text-property (point) 'gnus-number)
3406 (gnus-summary-last-subject)))
3407 ((= c ?H)
3408 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3409 (t
3410 (error "Non-implemented spec")))
3411 out)
3412 (cond
3413 ((= c ?r)
3414 (push (if (< (point) (mark)) (point) (mark)) out)
3415 (push (if (> (point) (mark)) (point) (mark)) out))))
3416 (setq out (delq 'gnus-prefix-nil out))
3417 (nreverse out)))
3419 (defun gnus-symbolic-argument (&optional arg)
3420 "Read a symbolic argument and a command, and then execute command."
3421 (interactive "P")
3422 (let* ((in-command (this-command-keys))
3423 (command in-command)
3424 gnus-current-prefix-symbols
3425 gnus-current-prefix-symbol
3426 syms)
3427 (while (equal in-command command)
3428 (message "%s-" (key-description (this-command-keys)))
3429 (push (intern (char-to-string (read-char))) syms)
3430 (setq command (read-key-sequence nil t)))
3431 (setq gnus-current-prefix-symbols (nreverse syms)
3432 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3433 (call-interactively (key-binding command t))))
3435 ;;; More various functions.
3437 (defsubst gnus-check-backend-function (func group)
3438 "Check whether GROUP supports function FUNC.
3439 GROUP can either be a string (a group name) or a select method."
3440 (ignore-errors
3441 (let ((method (if (stringp group)
3442 (car (gnus-find-method-for-group group))
3443 group)))
3444 (unless (featurep method)
3445 (require method))
3446 (fboundp (intern (format "%s-%s" method func))))))
3448 (defun gnus-group-read-only-p (&optional group)
3449 "Check whether GROUP supports editing or not.
3450 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3451 that that variable is buffer-local to the summary buffers."
3452 (let ((group (or group gnus-newsgroup-name)))
3453 (not (gnus-check-backend-function 'request-replace-article group))))
3455 (defun gnus-virtual-group-p (group)
3456 "Say whether GROUP is virtual or not."
3457 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3458 gnus-valid-select-methods)))
3460 (defun gnus-news-group-p (group &optional article)
3461 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3462 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3463 t) ;is news of course.
3464 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3465 nil) ;must be mail then.
3466 ((vectorp article) ;Has header info.
3467 (eq (gnus-request-type group (mail-header-id article)) 'news))
3468 ((null article) ;Hasn't header info
3469 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3470 ((< article 0) ;Virtual message
3471 nil) ;we don't know, guess mail.
3472 (t ;Has positive number
3473 (eq (gnus-request-type group article) 'news)))) ;use it.
3475 ;; Returns a list of writable groups.
3476 (defun gnus-writable-groups ()
3477 (let ((alist gnus-newsrc-alist)
3478 groups group)
3479 (while (setq group (car (pop alist)))
3480 (unless (gnus-group-read-only-p group)
3481 (push group groups)))
3482 (nreverse groups)))
3484 ;; Check whether to use long file names.
3485 (defun gnus-use-long-file-name (symbol)
3486 ;; The variable has to be set...
3487 (and gnus-use-long-file-name
3488 ;; If it isn't a list, then we return t.
3489 (or (not (listp gnus-use-long-file-name))
3490 ;; If it is a list, and the list contains `symbol', we
3491 ;; return nil.
3492 (not (memq symbol gnus-use-long-file-name)))))
3494 ;; Generate a unique new group name.
3495 (defun gnus-generate-new-group-name (leaf)
3496 (let ((name leaf)
3497 (num 0))
3498 (while (gnus-group-entry name)
3499 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3500 name))
3502 (defun gnus-ephemeral-group-p (group)
3503 "Say whether GROUP is ephemeral or not."
3504 (gnus-group-get-parameter group 'quit-config t))
3506 (defun gnus-group-quit-config (group)
3507 "Return the quit-config of GROUP."
3508 (gnus-group-get-parameter group 'quit-config t))
3510 (defun gnus-kill-ephemeral-group (group)
3511 "Remove ephemeral GROUP from relevant structures."
3512 (gnus-sethash group nil gnus-newsrc-hashtb))
3514 (defun gnus-simplify-mode-line ()
3515 "Make mode lines a bit simpler."
3516 (setq mode-line-modified (cdr gnus-mode-line-modified))
3517 (when (listp mode-line-format)
3518 (make-local-variable 'mode-line-format)
3519 (setq mode-line-format (copy-sequence mode-line-format))
3520 (when (equal (nth 3 mode-line-format) " ")
3521 (setcar (nthcdr 3 mode-line-format) " "))))
3523 ;;; Servers and groups.
3525 (defsubst gnus-server-add-address (method)
3526 (let ((method-name (symbol-name (car method))))
3527 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3528 (not (assq (intern (concat method-name "-address")) method))
3529 (memq 'physical-address (assq (car method)
3530 gnus-valid-select-methods)))
3531 (append method (list (list (intern (concat method-name "-address"))
3532 (nth 1 method))))
3533 method)))
3535 (defsubst gnus-method-to-server (method &optional nocache)
3536 (catch 'server-name
3537 (setq method (or method gnus-select-method))
3539 ;; Perhaps it is already in the cache.
3540 (unless nocache
3541 (mapc (lambda (name-method)
3542 (if (equal (cdr name-method) method)
3543 (throw 'server-name (car name-method))))
3544 gnus-server-method-cache))
3546 (mapc
3547 (lambda (server-alist)
3548 (mapc (lambda (name-method)
3549 (when (gnus-methods-equal-p (cdr name-method) method)
3550 (unless (member name-method gnus-server-method-cache)
3551 (push name-method gnus-server-method-cache))
3552 (throw 'server-name (car name-method))))
3553 server-alist))
3554 (list gnus-server-alist
3555 gnus-predefined-server-alist))
3557 (let* ((name (if (member (cadr method) '(nil ""))
3558 (format "%s" (car method))
3559 (format "%s:%s" (car method) (cadr method))))
3560 (name-method (cons name method)))
3561 (unless (member name-method gnus-server-method-cache)
3562 (push name-method gnus-server-method-cache))
3563 name)))
3565 (defsubst gnus-server-to-method (server)
3566 "Map virtual server names to select methods."
3567 (or (and server (listp server) server)
3568 (cdr (assoc server gnus-server-method-cache))
3569 (let ((result
3570 (or
3571 ;; Perhaps this is the native server?
3572 (and (equal server "native") gnus-select-method)
3573 ;; It should be in the server alist.
3574 (cdr (assoc server gnus-server-alist))
3575 ;; It could be in the predefined server alist.
3576 (cdr (assoc server gnus-predefined-server-alist))
3577 ;; If not, we look through all the opened server
3578 ;; to see whether we can find it there.
3579 (let ((opened gnus-opened-servers))
3580 (while (and opened
3581 (not (equal server (format "%s:%s" (caaar opened)
3582 (cadaar opened)))))
3583 (pop opened))
3584 (caar opened))
3585 ;; It could be a named method, search all servers
3586 (let ((servers gnus-secondary-select-methods))
3587 (while (and servers
3588 (not (equal server (format "%s:%s" (caar servers)
3589 (cadar servers)))))
3590 (pop servers))
3591 (car servers))
3592 ;; This could be some sort of foreign server that I
3593 ;; simply haven't opened (yet). Do a brute-force scan
3594 ;; of the entire gnus-newsrc-alist for the server name
3595 ;; of every method. As a side-effect, loads the
3596 ;; gnus-server-method-cache so this only happens once,
3597 ;; if at all.
3598 (let ((alist (cdr gnus-newsrc-alist))
3599 method match)
3600 (while alist
3601 (setq method (gnus-info-method (pop alist)))
3602 (when (and (not (stringp method))
3603 (equal server (gnus-method-to-server method)))
3604 (setq match method
3605 alist nil)))
3606 match))))
3607 (when result
3608 (push (cons server result) gnus-server-method-cache))
3609 result)))
3611 (defsubst gnus-server-get-method (group method)
3612 ;; Input either a server name, and extended server name, or a
3613 ;; select method, and return a select method.
3614 (cond ((stringp method)
3615 (gnus-server-to-method method))
3616 ((equal method gnus-select-method)
3617 gnus-select-method)
3618 ((and (stringp (car method))
3619 group)
3620 (gnus-server-extend-method group method))
3621 ((and method
3622 (not group)
3623 (equal (cadr method) ""))
3624 method)
3625 (t
3626 (gnus-server-add-address method))))
3628 (defmacro gnus-method-equal (ss1 ss2)
3629 "Say whether two servers are equal."
3630 `(let ((s1 ,ss1)
3631 (s2 ,ss2))
3632 (or (equal s1 s2)
3633 (and (= (length s1) (length s2))
3634 (progn
3635 (while (and s1 (member (car s1) s2))
3636 (setq s1 (cdr s1)))
3637 (null s1))))))
3639 (defun gnus-methods-equal-p (m1 m2)
3640 (let ((m1 (or m1 gnus-select-method))
3641 (m2 (or m2 gnus-select-method)))
3642 (or (equal m1 m2)
3643 (and (eq (car m1) (car m2))
3644 (or (not (memq 'address (assoc (symbol-name (car m1))
3645 gnus-valid-select-methods)))
3646 (equal (nth 1 m1) (nth 1 m2)))))))
3648 (defun gnus-server-equal (m1 m2)
3649 "Say whether two methods are equal."
3650 (let ((m1 (cond ((null m1) gnus-select-method)
3651 ((stringp m1) (gnus-server-to-method m1))
3652 (t m1)))
3653 (m2 (cond ((null m2) gnus-select-method)
3654 ((stringp m2) (gnus-server-to-method m2))
3655 (t m2))))
3656 (gnus-method-equal m1 m2)))
3658 (defun gnus-servers-using-backend (backend)
3659 "Return a list of known servers using BACKEND."
3660 (let ((opened gnus-opened-servers)
3661 out)
3662 (while opened
3663 (when (eq backend (caaar opened))
3664 (push (caar opened) out))
3665 (pop opened))
3666 out))
3668 (defun gnus-archive-server-wanted-p ()
3669 "Say whether the user wants to use the archive server."
3670 (cond
3671 ((or (not gnus-message-archive-method)
3672 (not gnus-message-archive-group))
3673 nil)
3674 ((and gnus-message-archive-method gnus-message-archive-group)
3675 t)
3676 (t
3677 (let ((active (cadr (assq 'nnfolder-active-file
3678 gnus-message-archive-method))))
3679 (and active
3680 (file-exists-p active))))))
3682 (defsubst gnus-method-to-server-name (method)
3683 (concat
3684 (format "%s" (car method))
3685 (when (and
3686 (or (assoc (format "%s" (car method))
3687 (gnus-methods-using 'address))
3688 (gnus-server-equal method gnus-message-archive-method))
3689 (nth 1 method)
3690 (not (string= (nth 1 method) "")))
3691 (concat "+" (nth 1 method)))))
3693 (defsubst gnus-method-to-full-server-name (method)
3694 (format "%s+%s" (car method) (nth 1 method)))
3696 (defun gnus-group-prefixed-name (group method &optional full)
3697 "Return the whole name from GROUP and METHOD.
3698 Call with full set to get the fully qualified group name (even if the
3699 server is native)."
3700 (when (stringp method)
3701 (setq method (gnus-server-to-method method)))
3702 (if (or (not method)
3703 (and (not full) (gnus-server-equal method "native"))
3704 ;;;!!! This might not be right. We'll see...
3705 ;(string-match ":" group)
3706 )
3707 group
3708 (concat (gnus-method-to-server-name method) ":" group)))
3710 (defun gnus-group-guess-prefixed-name (group)
3711 "Guess the whole name from GROUP and METHOD."
3712 (gnus-group-prefixed-name group (gnus-find-method-for-group
3713 group)))
3715 (defun gnus-group-full-name (group method)
3716 "Return the full name from GROUP and METHOD, even if the method is native."
3717 (gnus-group-prefixed-name group method t))
3719 (defun gnus-group-guess-full-name (group)
3720 "Guess the full name from GROUP, even if the method is native."
3721 (if (gnus-group-prefixed-p group)
3722 group
3723 (gnus-group-full-name group (gnus-find-method-for-group group))))
3725 (defun gnus-group-guess-full-name-from-command-method (group)
3726 "Guess the full name from GROUP, even if the method is native."
3727 (if (gnus-group-prefixed-p group)
3728 group
3729 (gnus-group-full-name group gnus-command-method)))
3731 (defun gnus-group-real-prefix (group)
3732 "Return the prefix of the current group name."
3733 (if (stringp group)
3734 (if (string-match "^[^:]+:" group)
3735 (substring group 0 (match-end 0))
3736 "")
3737 nil))
3739 (defun gnus-group-short-name (group)
3740 "Return the short group name."
3741 (let ((prefix (gnus-group-real-prefix group)))
3742 (if (< 0 (length prefix))
3743 (substring group (length prefix) nil)
3744 group)))
3746 (defun gnus-group-prefixed-p (group)
3747 "Return the prefix of the current group name."
3748 (< 0 (length (gnus-group-real-prefix group))))
3750 (declare-function gnus-group-decoded-name "gnus-group" (string))
3752 (defun gnus-summary-buffer-name (group)
3753 "Return the summary buffer name of GROUP."
3754 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3756 (defun gnus-group-method (group)
3757 "Return the server or method used for selecting GROUP.
3758 You should probably use `gnus-find-method-for-group' instead."
3759 (let ((prefix (gnus-group-real-prefix group)))
3760 (if (equal prefix "")
3761 gnus-select-method
3762 (let ((servers gnus-opened-servers)
3763 (server "")
3764 backend possible found)
3766 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3767 server (substring prefix (match-end 0) (1- (length prefix))))
3768 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3769 (while servers
3770 (when (eq (caaar servers) backend)
3771 (setq possible (caar servers))
3772 (when (equal (cadaar servers) server)
3773 (setq found (caar servers))))
3774 (pop servers))
3775 (or (car (rassoc found gnus-server-alist))
3776 found
3777 (car (rassoc possible gnus-server-alist))
3778 possible
3779 (list backend server))))))
3781 (defsubst gnus-native-method-p (method)
3782 "Return whether METHOD is the native select method."
3783 (gnus-method-equal method gnus-select-method))
3785 (defsubst gnus-secondary-method-p (method)
3786 "Return whether METHOD is a secondary select method."
3787 (let ((methods gnus-secondary-select-methods)
3788 (gmethod (inline (gnus-server-get-method nil method))))
3789 (while (and methods
3790 (not (gnus-method-equal
3791 (inline (gnus-server-get-method nil (car methods)))
3792 gmethod)))
3793 (setq methods (cdr methods)))
3794 methods))
3796 (defun gnus-method-simplify (method)
3797 "Return the shortest uniquely identifying string or method for METHOD."
3798 (cond ((stringp method)
3799 method)
3800 ((gnus-native-method-p method)
3801 nil)
3802 ((gnus-secondary-method-p method)
3803 (format "%s:%s" (nth 0 method) (nth 1 method)))
3804 (t
3805 method)))
3807 (defun gnus-groups-from-server (server)
3808 "Return a list of all groups that are fetched from SERVER."
3809 (let ((alist (cdr gnus-newsrc-alist))
3810 info groups)
3811 (while (setq info (pop alist))
3812 (when (gnus-server-equal (gnus-info-method info) server)
3813 (push (gnus-info-group info) groups)))
3814 (sort groups 'string<)))
3816 (defun gnus-group-foreign-p (group)
3817 "Say whether a group is foreign or not."
3818 (and (not (gnus-group-native-p group))
3819 (not (gnus-group-secondary-p group))))
3821 (defun gnus-group-native-p (group)
3822 "Say whether the group is native or not."
3823 (not (string-match ":" group)))
3825 (defun gnus-group-secondary-p (group)
3826 "Say whether the group is secondary or not."
3827 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3829 (defun gnus-parameters-get-parameter (group)
3830 "Return the group parameters for GROUP from `gnus-parameters'."
3831 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3832 case-fold-search
3833 gnus-parameters-case-fold-search))
3834 params-list)
3835 (dolist (elem gnus-parameters)
3836 (when (string-match (car elem) group)
3837 (setq params-list
3838 (nconc (gnus-expand-group-parameters
3839 (car elem) (cdr elem) group)
3840 params-list))))
3841 params-list))
3843 (defun gnus-expand-group-parameter (match value group)
3844 "Use MATCH to expand VALUE in GROUP."
3845 (with-temp-buffer
3846 (insert group)
3847 (goto-char (point-min))
3848 (while (re-search-forward match nil t)
3849 (replace-match value))
3850 (buffer-string)))
3852 (defun gnus-expand-group-parameters (match parameters group)
3853 "Go through PARAMETERS and expand them according to the match data."
3854 (let (new)
3855 (dolist (elem parameters)
3856 (if (and (stringp (cdr elem))
3858 (push (cons (car elem)
3859 (gnus-expand-group-parameter match (cdr elem) group))
3860 new)
3861 (push elem new)))
3862 new))
3864 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3865 "For GROUP, return the value of SYMBOL.
3867 You should call this in the `gnus-group-buffer' buffer.
3868 The function `gnus-group-find-parameter' will do that for you."
3869 ;; The speed trick: No cons'ing and quit early.
3870 (let* ((params (funcall gnus-group-get-parameter-function group))
3871 ;; Start easy, check the "real" group parameters.
3872 (simple-results
3873 (gnus-group-parameter-value params symbol allow-list t)))
3874 (if simple-results
3875 ;; Found results; return them.
3876 (car simple-results)
3877 ;; We didn't find it there, try `gnus-parameters'.
3878 (let ((result nil)
3879 (head nil)
3880 (tail gnus-parameters))
3881 ;; A good old-fashioned non-cl loop.
3882 (while tail
3883 (setq head (car tail)
3884 tail (cdr tail))
3885 ;; The car is regexp matching for matching the group name.
3886 (when (string-match (car head) group)
3887 ;; The cdr is the parameters.
3888 (setq result (gnus-group-parameter-value (cdr head)
3889 symbol allow-list))
3890 (when result
3891 ;; Expand if necessary.
3893 (setq result (gnus-expand-group-parameter (car head)
3894 result group)))
3895 ;; Exit the loop early.
3896 (setq tail nil))))
3897 ;; Done.
3898 result))))
3900 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3901 "Return the group parameters for GROUP.
3902 If SYMBOL, return the value of that symbol in the group parameters.
3904 If you call this function inside a loop, consider using the faster
3905 `gnus-group-fast-parameter' instead."
3906 (save-excursion
3907 (set-buffer gnus-group-buffer)
3908 (if symbol
3909 (gnus-group-fast-parameter group symbol allow-list)
3910 (nconc
3911 (copy-sequence
3912 (funcall gnus-group-get-parameter-function group))
3913 (gnus-parameters-get-parameter group)))))
3915 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3916 "Return the group parameters for GROUP.
3917 If SYMBOL, return the value of that symbol in the group parameters.
3918 If ALLOW-LIST, also allow list as a result.
3919 Most functions should use `gnus-group-find-parameter', which
3920 also examines the topic parameters."
3921 (let ((params (gnus-info-params (gnus-get-info group))))
3922 (if symbol
3923 (gnus-group-parameter-value params symbol allow-list)
3924 params)))
3926 (defun gnus-group-parameter-value (params symbol &optional
3927 allow-list present-p)
3928 "Return the value of SYMBOL in group PARAMS.
3929 If ALLOW-LIST, also allow list as a result."
3930 ;; We only wish to return group parameters (dotted lists) and
3931 ;; not local variables, which may have the same names.
3932 ;; But first we handle single elements...
3933 (or (car (memq symbol params))
3934 ;; Handle alist.
3935 (let (elem)
3936 (catch 'found
3937 (while (setq elem (pop params))
3938 (when (and (consp elem)
3939 (eq (car elem) symbol)
3940 (or allow-list
3941 (atom (cdr elem))))
3942 (throw 'found (if present-p (list (cdr elem))
3943 (cdr elem)))))))))
3945 (defun gnus-group-add-parameter (group param)
3946 "Add parameter PARAM to GROUP."
3947 (let ((info (gnus-get-info group)))
3948 (when info
3949 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3950 ;; Cons the new param to the old one and update.
3951 (gnus-group-set-info (cons param (gnus-info-params info))
3952 group 'params))))
3954 (defun gnus-group-set-parameter (group name value)
3955 "Set parameter NAME to VALUE in GROUP."
3956 (let ((info (gnus-get-info group)))
3957 (when info
3958 (gnus-group-remove-parameter group name)
3959 (let ((old-params (gnus-info-params info))
3960 (new-params (list (cons name value))))
3961 (while old-params
3962 (when (or (not (listp (car old-params)))
3963 (not (eq (caar old-params) name)))
3964 (setq new-params (append new-params (list (car old-params)))))
3965 (setq old-params (cdr old-params)))
3966 (gnus-group-set-info new-params group 'params)))))
3968 (defun gnus-group-remove-parameter (group name)
3969 "Remove parameter NAME from GROUP."
3970 (let ((info (gnus-get-info group)))
3971 (when info
3972 (let ((params (gnus-info-params info)))
3973 (when params
3974 (setq params (delq name params))
3975 (while (assq name params)
3976 (gnus-pull name params))
3977 (gnus-info-set-params info params))))))
3979 (defun gnus-group-add-score (group &optional score)
3980 "Add SCORE to the GROUP score.
3981 If SCORE is nil, add 1 to the score of GROUP."
3982 (let ((info (gnus-get-info group)))
3983 (when info
3984 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3986 (defun gnus-short-group-name (group &optional levels)
3987 "Collapse GROUP name LEVELS.
3988 Select methods are stripped and any remote host name is stripped down to
3989 just the host name."
3990 (let* ((name "")
3991 (foreign "")
3992 (depth 0)
3993 (skip 1)
3994 (levels (or levels
3995 gnus-group-uncollapsed-levels
3996 (progn
3998 (setq skip (match-end 0)
3999 depth (+ depth 1)))
4000 depth))))
4001 ;; Separate foreign select method from group name and collapse.
4002 ;; If method contains a server, collapse to non-domain server name,
4003 ;; otherwise collapse to select method.
4004 (let* ((colon (string-match ":" group))
4005 (server (and colon (substring group 0 colon)))
4006 (plus (and server (string-match "+" server))))
4007 (when server
4008 (if plus
4009 (setq foreign (substring server (+ 1 plus)
4011 group (substring group (+ 1 colon)))
4012 (setq foreign server
4013 group (substring group (+ 1 colon))))
4014 (setq foreign (concat foreign ":")))
4015 ;; Collapse group name leaving LEVELS uncollapsed elements
4016 (let* ((slist (split-string group "/"))
4017 (slen (length slist))
4019 (dlen (length dlist))
4020 glist
4021 glen
4022 gsep
4023 res)
4024 (if (> slen dlen)
4025 (setq glist slist
4026 glen slen
4027 gsep "/")
4028 (setq glist dlist
4029 glen dlen
4030 gsep "."))
4031 (setq levels (- glen levels))
4032 (dolist (g glist)
4033 (push (if (>= (decf levels) 0)
4034 (if (zerop (length g))
4035 ""
4036 (substring g 0 1))
4037 g)
4038 res))
4039 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4041 (defun gnus-narrow-to-body ()
4042 "Narrow to the body of an article."
4043 (narrow-to-region
4044 (progn
4045 (goto-char (point-min))
4047 (point-max)))
4048 (point-max)))
4050 \f
4051 ;;;
4052 ;;; Kill file handling.
4053 ;;;
4055 (defun gnus-apply-kill-file ()
4056 "Apply a kill file to the current newsgroup.
4057 Returns the number of articles marked as read."
4058 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4059 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4060 (gnus-apply-kill-file-internal)
4061 0))
4063 (defun gnus-kill-save-kill-buffer ()
4064 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4065 (when (get-file-buffer file)
4066 (save-excursion
4067 (set-buffer (get-file-buffer file))
4068 (when (buffer-modified-p)
4069 (save-buffer))
4070 (kill-buffer (current-buffer))))))
4072 (defcustom gnus-kill-file-name "KILL"
4073 "Suffix of the kill files."
4074 :group 'gnus-score-kill
4075 :group 'gnus-score-files
4076 :type 'string)
4078 (defun gnus-newsgroup-kill-file (newsgroup)
4079 "Return the name of a kill file name for NEWSGROUP.
4080 If NEWSGROUP is nil, return the global kill file name instead."
4081 (cond
4082 ;; The global KILL file is placed at top of the directory.
4083 ((or (null newsgroup)
4084 (string-equal newsgroup ""))
4085 (expand-file-name gnus-kill-file-name
4086 gnus-kill-files-directory))
4087 ;; Append ".KILL" to newsgroup name.
4088 ((gnus-use-long-file-name 'not-kill)
4089 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4090 "." gnus-kill-file-name)
4091 gnus-kill-files-directory))
4092 ;; Place "KILL" under the hierarchical directory.
4093 (t
4094 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4095 "/" gnus-kill-file-name)
4096 gnus-kill-files-directory))))
4098 ;;; Server things.
4100 (defun gnus-member-of-valid (symbol group)
4102 (memq symbol (assoc
4103 (symbol-name (car (gnus-find-method-for-group group)))
4104 gnus-valid-select-methods)))
4106 (defun gnus-method-option-p (method option)
4107 "Return non-nil if select METHOD has OPTION as a parameter."
4108 (when (stringp method)
4109 (setq method (gnus-server-to-method method)))
4110 (memq option (assoc (format "%s" (car method))
4111 gnus-valid-select-methods)))
4113 (defun gnus-similar-server-opened (method)
4114 (let ((opened gnus-opened-servers))
4115 (while (and method opened)
4116 (when (and (equal (cadr method) (cadaar opened))
4117 (equal (car method) (caaar opened))
4118 (not (equal method (caar opened))))
4119 (setq method nil))
4120 (pop opened))
4121 (not method)))
4123 (defun gnus-server-extend-method (group method)
4124 ;; This function "extends" a virtual server. If the server is
4125 ;; "hello", and the select method is ("hello" (my-var "something"))
4126 ;; in the group "alt.alt", this will result in a new virtual server
4127 ;; called "hello+alt.alt".
4128 (if (or (not (inline (gnus-similar-server-opened method)))
4129 (not (cddr method)))
4130 method
4131 `(,(car method) ,(concat (cadr method) "+" group)
4132 (,(intern (format "%s-address" (car method))) ,(cadr method))
4133 ,@(cddr method))))
4135 (defun gnus-server-status (method)
4136 "Return the status of METHOD."
4137 (nth 1 (assoc method gnus-opened-servers)))
4139 (defun gnus-group-name-to-method (group)
4140 "Guess a select method based on GROUP."
4141 (if (string-match ":" group)
4142 (let ((server (substring group 0 (match-beginning 0))))
4144 (list (intern (substring server 0 (match-beginning 0)))
4145 (substring server (match-end 0)))
4146 (list (intern server) "")))
4147 gnus-select-method))
4149 (defun gnus-server-string (server)
4150 "Return a readable string that describes SERVER."
4151 (let* ((server (gnus-server-to-method server))
4152 (address (nth 1 server)))
4153 (if (and address
4154 (not (zerop (length address))))
4155 (format "%s using %s" address (car server))
4156 (format "%s" (car server)))))
4158 (defun gnus-find-method-for-group (group &optional info)
4159 "Find the select method that GROUP uses."
4160 (or gnus-override-method
4161 (and (not group)
4162 gnus-select-method)
4163 (and (not (gnus-group-entry group))
4164 ;; Killed or otherwise unknown group.
4165 (or
4166 ;; If we know a virtual server by that name, return its method.
4167 (gnus-server-to-method (gnus-group-server group))
4168 ;; Guess a new method as last resort.
4169 (gnus-group-name-to-method group)))
4170 (let ((info (or info (gnus-get-info group)))
4171 method)
4172 (if (or (not info)
4173 (not (setq method (gnus-info-method info)))
4174 (equal method "native"))
4175 gnus-select-method
4176 (setq method
4177 (cond ((stringp method)
4178 (inline (gnus-server-to-method method)))
4179 ((stringp (cadr method))
4180 (inline (gnus-server-extend-method group method)))
4181 (t
4182 method)))
4183 (cond ((equal (cadr method) "")
4184 method)
4185 ((null (cadr method))
4186 (list (car method) ""))
4187 (t
4188 (gnus-server-add-address method)))))))
4190 (defun gnus-methods-using (feature)
4191 "Find all methods that have FEATURE."
4192 (let ((valids gnus-valid-select-methods)
4193 outs)
4194 (while valids
4195 (when (memq feature (car valids))
4196 (push (car valids) outs))
4197 (setq valids (cdr valids)))
4198 outs))
4200 (eval-and-compile
4201 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4203 (defun gnus-read-group (prompt &optional default)
4204 "Prompt the user for a group name.
4205 Disallow invalid group names."
4206 (let ((prefix "")
4207 group)
4208 (while (not group)
4209 (when (string-match
4210 gnus-invalid-group-regexp
4211 (setq group (read-string (concat prefix prompt)
4212 (cons (or default "") 0)
4213 'gnus-group-history)))
4214 (let ((match (match-string 0 group)))
4215 ;; Might be okay (e.g. for nnimap), so ask the user:
4217 (message-y-or-n-p
4218 "Proceed and create group anyway? " t
4221 Usually, it's dangerous to create a group with this name, because it's not
4222 supported by all back ends and servers. On IMAP servers it should work,
4223 though. If you are really sure, you can proceed anyway and create the group.
4225 You may customize the variable `gnus-invalid-group-regexp', which currently is
4229 group nil)))))
4230 group))
4232 (defun gnus-read-method (prompt)
4233 "Prompt the user for a method.
4234 Allow completion over sensible values."
4235 (let* ((open-servers
4236 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4237 gnus-opened-servers))
4238 (valid-methods
4239 (let (methods)
4240 (dolist (method gnus-valid-select-methods)
4241 (if (or (memq 'prompt-address method)
4242 (not (assoc (format "%s:" (car method)) open-servers)))
4243 (push method methods)))
4244 methods))
4245 (servers
4246 (append valid-methods
4247 open-servers
4248 gnus-predefined-server-alist
4249 gnus-server-alist))
4250 (method
4251 (completing-read
4252 prompt servers
4253 nil t nil 'gnus-method-history)))
4254 (cond
4255 ((equal method "")
4256 (setq method gnus-select-method))
4257 ((assoc method gnus-valid-select-methods)
4258 (let ((address (if (memq 'prompt-address
4259 (assoc method gnus-valid-select-methods))
4260 (read-string "Address: ")
4261 "")))
4262 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4263 (list (intern method) address))))
4264 ((assoc method servers)
4265 method)
4266 (t
4267 (list (intern method) "")))))
4269 ;;; Agent functions
4271 (defun gnus-agent-method-p (method-or-server)
4272 "Say whether METHOD is covered by the agent."
4273 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4274 (let* ((method (if (stringp method-or-server)
4275 (gnus-server-to-method method-or-server)
4276 method-or-server))
4277 (server (gnus-method-to-server method t)))
4278 (setq gnus-agent-method-p-cache
4279 (cons method-or-server
4280 (member server gnus-agent-covered-methods)))))
4281 (cdr gnus-agent-method-p-cache))
4283 (defun gnus-online (method)
4284 (not
4285 (if gnus-plugged
4286 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4287 (gnus-agent-method-p method))))
4289 ;;; User-level commands.
4291 ;;;###autoload
4292 (defun gnus-slave-no-server (&optional arg)
4293 "Read network news as a slave, without connecting to the local server."
4294 (interactive "P")
4295 (gnus-no-server arg t))
4297 ;;;###autoload
4298 (defun gnus-no-server (&optional arg slave)
4299 "Read network news.
4300 If ARG is a positive number, Gnus will use that as the startup
4301 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4302 non-nil and not a positive number, Gnus will prompt the user for the
4303 name of an NNTP server to use.
4304 As opposed to `gnus', this command will not connect to the local
4305 server."
4306 (interactive "P")
4307 (gnus-no-server-1 arg slave))
4309 ;;;###autoload
4310 (defun gnus-slave (&optional arg)
4311 "Read news as a slave."
4312 (interactive "P")
4313 (gnus arg nil 'slave))
4315 ;;;###autoload
4316 (defun gnus-other-frame (&optional arg display)
4317 "Pop up a frame to read news.
4318 This will call one of the Gnus commands which is specified by the user
4319 option `gnus-other-frame-function' (default `gnus') with the argument
4320 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4321 optional second argument DISPLAY should be a standard display string
4323 omitted or the function `make-frame-on-display' is not available, the
4324 current display is used."
4325 (interactive "P")
4326 (if (fboundp 'make-frame-on-display)
4327 (unless display
4328 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4329 (setq display nil))
4330 (let ((alive (gnus-alive-p)))
4331 (unless (and alive
4332 (catch 'found
4333 (walk-windows
4334 (lambda (window)
4335 (when (and (or (not display)
4336 (equal display
4337 (gnus-frame-or-window-display-name
4338 window)))
4339 (with-current-buffer (window-buffer window)
4341 (symbol-name major-mode))))
4342 (gnus-select-frame-set-input-focus
4343 (setq gnus-other-frame-object (window-frame window)))
4344 (select-window window)
4345 (throw 'found t)))
4346 'ignore t)))
4347 (gnus-select-frame-set-input-focus
4348 (setq gnus-other-frame-object
4349 (if display
4350 (make-frame-on-display display gnus-other-frame-parameters)
4351 (make-frame gnus-other-frame-parameters))))
4352 (if alive
4353 (switch-to-buffer gnus-group-buffer)
4354 (funcall gnus-other-frame-function arg)
4355 (add-hook 'gnus-exit-gnus-hook
4356 '(lambda nil
4357 (when (and (frame-live-p gnus-other-frame-object)
4358 (cdr (frame-list)))
4359 (delete-frame gnus-other-frame-object))
4360 (setq gnus-other-frame-object nil)))))))
4362 ;;;###autoload
4363 (defun gnus (&optional arg dont-connect slave)
4364 "Read network news.
4365 If ARG is non-nil and a positive number, Gnus will use that as the
4366 startup level. If ARG is non-nil and not a positive number, Gnus will
4367 prompt the user for the name of an NNTP server to use."
4368 (interactive "P")
4369 (unless (byte-code-function-p (symbol-function 'gnus))
4370 (message "You should byte-compile Gnus")
4371 (sit-for 2))
4372 (gnus-1 arg dont-connect slave))
4374 ;; Allow redefinition of Gnus functions.
4376 (gnus-ems-redefine)
4378 (provide 'gnus)
4380 ;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4381 ;;; gnus.el ends here