| blob | a59c3873890a29f155dfefcc544d6601979021e8 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987,88,89,90,93,94,95,96,97,98 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;;; Code:
42 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
47 "Cache interface."
51 "Starting your favorite newsreader."
55 "Server options at startup."
58 ;; These belong to gnus-group.el.
60 "Group buffers."
65 "Foreign groups."
70 "Automatic subscription of new groups."
74 "Group levels."
79 "Selecting a Group."
84 "Showing slices of the group list."
89 "Sorting the group buffer."
95 "Various group options."
99 ;; These belong to gnus-sum.el.
101 "Summary buffers."
106 "Leaving summary buffers."
111 "Marks used in summary buffers."
116 "Ordering articles according to replies."
121 "Formatting of the summary buffer."
126 "Choosing Articles."
131 "Summary movement commands."
136 "Mail group commands."
141 "Sorting the summary buffer."
146 "Highlighting and menus in the summary buffer."
152 "Various summary buffer options."
157 "Pick mode in the summary buffer."
163 "Tree display of threads in the summary buffer."
168 ;; Belongs to gnus-uu.el
170 "Viewing extracted files."
174 ;; Belongs to gnus-score.el
176 "Score and kill file handling."
180 "Kill files."
184 "Adaptive score files."
188 "Default values for score files."
192 "Expiring score rules."
196 "Decaying score rules."
200 "Score and kill file names."
205 "Various scoring and killing options."
208 ;; Other
210 "Options controling the visual fluff."
215 "Offline support for Gnus."
219 "Files used by Gnus."
223 "Auto save file."
228 "Storing Gnus state."
232 "Options related to newsservers and other servers used by Gnus."
236 "Composing replies and followups in Gnus."
240 "Meta variables controling major portions of Gnus.
241 In general, modifying these variables does not take affect until Gnus
242 is restarted, and sometimes reloaded."
246 "Other Gnus options."
251 "Exiting gnus."
262 "If non-nil, the startup message will not be displayed.
263 This variable is used before `.gnus.el' is loaded, so it should
264 be set in `.emacs' instead."
269 "If non-nil, play the Gnus jingle at startup."
273 ;;; Kludges to help the transition from the old `custom.el'.
296 ;; We define these group faces here to avoid the display
297 ;; update forced when creating new faces.
307 ()))
318 ()))
329 ()))
340 ()))
351 ()))
357 ())
360 ())
362 ()))
373 ()))
384 ()))
450 ()))
475 ;; Summary mode faces.
516 ()))
549 ()))
564 ()))
601 ()))
605 ;;;
606 ;;; Gnus buffers
607 ;;;
612 "Do the same as `get-buffer-create', but store the created buffer."
617 "Add the current buffer to the list of Gnus buffers."
621 "Return a list of live Gnus buffers."
630 gnus-buffers)
632 ;;; Splash screen.
647 ()))
662 "Indent rigidly using only spaces and no tabs."
668 ;; We translate tabs into spaces -- not everybody uses
669 ;; an 8-character tab.
677 "Insert startup message in current buffer."
678 ;; Insert the message.
682 _ ___ _ _
683 _ ___ __ ___ __ _ ___
684 __ _ ___ __ ___
685 _ ___ _
686 _ _ __ _
687 ___ __ _
688 __ _
689 _ _ _
690 _ _ _
691 _ _ _
692 __ ___
693 _ _ _ _
694 _ _
695 _ _
696 _ _
697 _
698 __
700 "
702 ;; And then hack it.
711 ;; Fontify some.
725 ;;; Do the rest.
733 All other Gnus path variables are initialized from this variable."
739 "*Directory variable from which all other Gnus file variables are derived.
741 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
742 This means that other directory variables that are initialized from
743 this variable won't be set properly if you set this variable in `.gnus.el'.
744 Set this variable in `.emacs' instead."
749 "*Default directory for all Gnus buffers."
752 directory))
754 ;; Site dependent variables. These variables should be defined in
755 ;; paths.el.
758 "Specify a default NNTP server.
759 This variable should be defined in paths.el, and should never be set
760 by the user.
761 If you want to change servers, you should use `gnus-select-method'.
764 ;; Don't touch this variable.
767 This is an obsolete variable, which is scarcely used. If you use an
768 nntp server for your newsgroup and want to change the port number
769 used to 899, you would say something along these lines:
774 "A file with only the name of the nntp server in it."
779 ;; This function is used to check both the environment variable
780 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
781 ;; an nntp server name default.
792 nil
793 name)
804 gnus-default-nntp-server)
808 nil
811 "*Default method for selecting a newsgroup.
812 This variable should be a list, where the first element is how the
813 news is to be fetched, the second is the address.
815 For instance, if you want to get your news via NNTP from
820 If you want to use your local spool, say:
822 \(setq gnus-select-method (list 'nnspool (system-name)))
824 If you use this variable, you must set `gnus-nntp-server' to nil.
826 There is a lot more to know about select methods and virtual servers -
827 see the manual for details."
833 "archive"
839 "*Method used for archiving messages you've sent.
840 This should be a mail method.
842 It's probably not a very effective to change this variable once you've
843 run Gnus once. After doing that, you must edit this server from the
844 server buffer."
850 "*Name of the group in which to save the messages you've written.
851 This can either be a string; a list of strings; or an alist
852 of regexps/functions/forms to be evaluated to return a string (or a list
853 of strings). The functions are called with the name of the current
854 group (or nil) as a parameter.
856 If you want to save your mail in one group and the news articles you
857 write in another group, you could say something like:
859 \(setq gnus-message-archive-group
860 '((if (message-news-p)
864 Normally the group names returned by this variable should be
866 However, you may wish to store the message on some other server. In
867 that case, just return a fully prefixed name of the group --
871 sexp
872 string))
875 "List of NNTP servers that the user can choose between interactively.
876 To make Gnus query you for a server, you have to give `gnus' a
877 non-numeric prefix - `C-u M-x gnus', in short."
882 "*The name of the host running the NNTP server.
883 This variable is semi-obsolete. Use the `gnus-select-method'
884 variable instead."
887 string))
890 "A list of secondary methods that will be used for reading news.
891 This is a list where each element is a complete select method (see
892 `gnus-select-method').
894 If, for instance, you want to read your mail with the nnml backend,
895 you could set this variable:
903 "Default default new newsgroups the first time Gnus is run.
907 "Local domain name without a host name.
908 The DOMAINNAME environment variable is used instead if it is defined.
909 If the `system-name' function returns the full Internet name, there is
910 no need to set this variable."
913 string))
916 "String with a description of what organization (if any) the user belongs to.
919 ;; Customization variables
922 "Preferred method for fetching an article by Message-ID.
923 If you are reading news from the local spool (with nnspool), fetching
924 articles by Message-ID is painfully slow. By setting this method to an
925 nntp method, you might get acceptable results.
927 The value of this variable must be a valid select method as discussed
928 in the documentation of `gnus-select-method'."
931 gnus-select-method))
935 "/ftp@sunsite.auc.dk:/pub/usenet/"
936 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
937 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
938 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
939 "/ftp@rtfm.mit.edu:/pub/usenet/"
940 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
941 "/ftp@ftp.sunet.se:/pub/usenet/"
942 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
943 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
945 "*Directory where the group FAQs are stored.
946 This will most commonly be on a remote machine, and the file will be
947 fetched by ange-ftp.
949 This variable can also be a list of directories. In that case, the
950 first element in the list will be used by default. The others can
951 be used when being prompted for a site.
953 Note that Gnus uses an aol machine as the default directory. If this
954 feels fundamentally unclean, just think of it as a way to finally get
955 something of value back from them.
957 If the default site is too slow, try one of these:
959 North America: mirrors.aol.com /pub/rtfm/usenet
960 ftp.seas.gwu.edu /pub/rtfm
961 rtfm.mit.edu /pub/usenet
962 Europe: ftp.uni-paderborn.de /pub/FAQ
963 src.doc.ic.ac.uk /usenet/news-FAQS
964 ftp.sunet.se /pub/usenet
965 sunsite.auc.dk /pub/usenet
966 Asia: nctuccca.edu.tw /USENET/FAQ
967 hwarang.postech.ac.kr /pub/usenet
968 ftp.hk.super.net /mirror/faqs"
974 "*Non-nil means that cross referenced articles will be marked as read.
975 If nil, ignore cross references. If t, mark articles as read in
976 subscribed newsgroups. If neither t nor nil, mark as read in all
977 newsgroups."
985 "*Process mark."
991 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
996 "*The number of articles which indicates a large newsgroup.
997 If the number of articles in a newsgroup is greater than this value,
998 confirmation is required for selecting the newsgroup."
1003 "*Non-nil means that the default name of a file to save articles in is the group name.
1004 If it's nil, the directory form of the group name is used instead.
1006 If this variable is a list, and the list contains the element
1007 `not-score', long file names will not be used for score files; if it
1008 contains the element `not-save', long file names will not be used for
1009 saving; and if it contains the element `not-kill', long file names
1010 will not be used for kill files.
1012 Note that the default for this variable varies according to what system
1013 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1014 to nil while on all other systems it defaults to t."
1025 "*If non-nil, save group scoring info."
1031 "*If non-nil, allow undoing in Gnus group mode buffers."
1036 "*If non-nil, use some adaptive scoring scheme.
1037 If a list, then the values `word' and `line' are meaningful. The
1038 former will perform adaption on individual words in the subject
1039 header while `line' will perform adaption on several headers."
1045 "*If nil, Gnus will ignore the article cache.
1046 If `passive', it will allow entering (and reading) articles
1047 explicitly entered into the cache. If anything else, use the
1048 cache to the full extent of the law."
1056 "*If non-nil, display a thread tree buffer."
1061 "*If non-nil, use GroupLens ratings."
1066 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1067 If it is a number N, then Gnus will only keep the last N articles
1068 read. If it is neither nil nor a number, Gnus will keep all read
1069 articles. This is not a good idea."
1072 integer
1077 "*If non-nil, Gnus will read NoCeM cancel messages."
1082 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1087 "If non-nil, Gnus might use some demons."
1092 "*If non-nil, enable scoring."
1097 "*If non-nil, display picons."
1103 "*A hook called when preparing to exit from the summary buffer.
1104 It calls `gnus-summary-expire-articles' by default."
1109 "*Non-nil means that you are a usenet novice.
1110 If non-nil, verbose messages may be displayed and confirmations may be
1111 required."
1116 "*Non-nil means that you will never be asked for confirmation about anything.
1117 That doesn't mean *anything* anything; particularly destructive
1118 commands will still require prompting."
1123 "*If non-nil, require your confirmation when catching up a group."
1128 "*If non-nil, require your confirmation when exiting Gnus."
1133 "*Function for extracting address components from a From header.
1134 Two pre-defined function exist: `gnus-extract-address-components',
1135 which is the default, quite fast, and too simplistic solution, and
1136 `mail-extract-address-components', which works much better, but is
1137 slower."
1144 "*If non-nil, display clickable icons."
1149 "String used to separate to shell commands."
1172 "*An alist of valid select methods.
1173 The first element of each list lists should be a string with the name
1174 of the select method. The other elements may be the category of
1175 this method (i. e., `post', `mail', `none' or whatever) or other
1176 properties that this method has (like being respoolable).
1177 If you implement a new select method, all you should have to change is
1178 this variable. I think."
1193 "Widget for entering a select method."
1198 gnus-valid-select-methods))
1202 variable
1206 "List of buffers that should update their mode lines.
1207 The list may contain the symbols `group', `article', `tree' and
1208 `summary'. If the corresponding symbol is present, Gnus will keep
1209 that mode line updated with information that may be pertinent.
1210 If this variable is nil, screen refresh may be quicker."
1217 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1219 "*Max length of mode-line non-string contents.
1220 If this is nil, Gnus will take space as is needed, leaving the rest
1221 of the modeline intact. Note that the default of nil is unlikely
1222 to be desirable; see the manual for further details."
1225 integer))
1228 "*Groups in which to automatically mark read articles as expirable.
1229 If non-nil, this should be a regexp that should match all groups in
1230 which to perform auto-expiry. This only makes sense for mail groups."
1233 regexp))
1236 "*Groups in which to perform expiry of all read articles.
1237 Use with extreme caution. All groups that match this regexp will be
1238 expiring - which means that all read articles will be deleted after
1239 \(say) one week. (This only goes for mail groups and the like, of
1240 course.)"
1243 regexp))
1246 "Number of group name elements to leave alone when making a short group name."
1251 "*If non-nil, once you set a level, Gnus will use this level."
1255 ;; Hooks.
1258 "A hook run while Gnus is loaded."
1263 "A hook called to apply kill files to a group.
1264 This hook is intended to apply a kill file to the selected newsgroup.
1265 The function `gnus-apply-kill-file' is called by default.
1267 Since a general kill file is too heavy to use only for a few
1268 newsgroups, I recommend you to use a lighter hook function. For
1269 example, if you'd like to apply a kill file to articles which contains
1270 a string `rmgroup' in subject in newsgroup `control', you can use the
1271 following hook:
1273 (setq gnus-apply-kill-hook
1274 (list
1275 (lambda ()
1284 "Function run when a group level is changed.
1285 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1289 ;;; Face thingies.
1293 mouse-face
1294 summary-menu group-menu article-menu
1295 tree-highlight menu highlight
1296 browse-menu server-menu
1297 page-marker tree-menu binary-menu pick-menu
1298 grouplens-menu)
1299 "*Enable visual features.
1300 If `visual' is disabled, there will be no menus and few faces. Most of
1301 the visual customization options below will be ignored. Gnus will use
1302 less space and be faster as a result.
1304 This variable can also be a list of visual elements to switch on. For
1305 instance, to switch off all visual things except menus, you can say:
1307 (setq gnus-visual '(menu))
1309 Valid elements include `summary-highlight', `group-highlight',
1310 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1311 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1312 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1313 and `grouplens-menu'."
1342 "*Face used for group or summary buffer mouse highlighting.
1343 The line beneath the mouse pointer will be highlighted with this
1344 face."
1352 gnus-article-hide-boring-headers
1353 gnus-article-treat-overstrike
1354 gnus-article-maybe-highlight
1355 gnus-article-display-x-face)
1357 gnus-article-hide-boring-headers
1358 gnus-article-treat-overstrike
1359 gnus-article-maybe-highlight))
1360 "*Controls how the article buffer will look.
1362 If you leave the list empty, the article will appear exactly as it is
1363 stored on the disk. The list entries will hide or highlight various
1364 parts of the article, making it easier to find the information you
1365 want."
1370 gnus-article-add-buttons-to-head
1371 gnus-article-emphasize
1372 gnus-article-fill-cited-article
1373 gnus-article-remove-cr
1374 gnus-article-de-quoted-unreadable
1375 gnus-summary-stop-page-breaking
1376 ;; gnus-summary-caesar-message
1377 ;; gnus-summary-verbose-headers
1378 gnus-summary-toggle-mime
1379 gnus-article-hide
1380 gnus-article-hide-headers
1381 gnus-article-hide-boring-headers
1382 gnus-article-hide-signature
1383 gnus-article-hide-citation
1384 gnus-article-hide-pgp
1385 gnus-article-hide-pem
1386 gnus-article-highlight
1387 gnus-article-highlight-headers
1388 gnus-article-highlight-citation
1389 gnus-article-highlight-signature
1390 gnus-article-date-ut
1391 gnus-article-date-local
1392 gnus-article-date-lapsed
1393 gnus-article-date-original
1394 gnus-article-remove-trailing-blank-lines
1395 gnus-article-strip-leading-blank-lines
1396 gnus-article-strip-multiple-blank-lines
1397 gnus-article-strip-blank-lines
1398 gnus-article-treat-overstrike
1399 gnus-article-display-x-face
1400 gnus-smiley-display))
1410 \f
1411 ;;; Internal variables
1430 ;; Dummy variable.
1433 ;; Variable holding the user answers to all method prompts.
1436 ;; Variable holding the user answers to all mail method prompts.
1439 ;; Variable holding the user answers to all group prompts.
1447 "*The directory where cached articles will be stored."
1453 nnspool "cache"
1481 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1507 gnus-newsrc-last-checked-date
1508 gnus-newsrc-alist gnus-server-alist
1509 gnus-killed-list gnus-zombie-list
1510 gnus-topic-topology gnus-topic-alist
1511 gnus-format-specs)
1515 "Assoc list of read articles.
1542 ;; Save window configuration.
1547 ;;; Let the byte-compiler know that we know about this variable.
1552 ;;; End of variables.
1554 ;; Define some autoload functions Gnus might use.
1557 ;; This little mapcar goes through the list below and marks the
1558 ;; symbols in question as autoloaded functions.
1580 message-send-and-exit message-yank-original)
1584 timezone-make-sortable-date timezone-make-time-string)
1587 rmail-show-message rmail-summary-exists
1588 rmail-select-summary rmail-update-summary)
1592 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1593 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1597 gnus-Folder-save-name gnus-folder-save-name)
1600 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1601 gnus-demon-add-disconnection gnus-demon-add-handler
1602 gnus-demon-remove-handler)
1604 gnus-demon-init gnus-demon-cancel)
1606 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1608 gnus-nocem-unwanted-article-p)
1610 gnus-server-server-name)
1613 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1614 gnus-article-hide-citation gnus-article-fill-cited-article
1615 gnus-article-hide-citation-in-followups)
1617 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1618 gnus-execute gnus-expunge)
1620 gnus-cache-possibly-remove-articles gnus-cache-request-article
1621 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1622 gnus-cache-enter-remove-article gnus-cached-article-p
1623 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1625 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1627 gnus-summary-increase-score gnus-summary-set-score
1628 gnus-summary-raise-thread gnus-summary-raise-same-subject
1629 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1630 gnus-summary-lower-thread gnus-summary-lower-same-subject
1631 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1632 gnus-summary-current-score gnus-score-default
1633 gnus-score-flush-cache gnus-score-close
1634 gnus-possibly-score-headers gnus-score-followup-article
1635 gnus-score-followup-thread)
1638 gnus-current-score-file-nondirectory gnus-score-adaptive
1639 gnus-score-find-trace gnus-score-file-name)
1646 gnus-uu-post-news
1647 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1648 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1649 gnus-uu-mark-by-regexp gnus-uu-mark-all
1650 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1651 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1652 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1653 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1654 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1655 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1656 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1657 gnus-uu-mark-over gnus-uu-post-news gnus-uu-post-news)
1659 gnus-uu-unmark-thread)
1661 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1663 gnus-summary-wide-reply
1664 gnus-summary-wide-reply-with-original
1665 gnus-summary-followup-to-mail
1666 gnus-summary-followup-to-mail-with-original
1667 gnus-summary-post-forward
1668 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1669 gnus-summary-followup gnus-summary-followup-with-original
1670 gnus-summary-cancel-article gnus-summary-supersede-article
1671 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1672 gnus-summary-mail-forward gnus-summary-mail-other-window
1673 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1674 gnus-summary-wide-reply gnus-summary-followup-to-mail
1675 gnus-summary-followup-to-mail-with-original gnus-bug
1676 gnus-summary-wide-reply-with-original
1677 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1678 gnus-summary-post-forward)
1680 gnus-group-display-picons gnus-picons-article-display-x-face
1681 gnus-picons-display-x-face)
1683 gnus-grouplens-mode)
1687 gnus-list-of-unread-articles gnus-list-of-read-articles
1688 gnus-offer-save-summaries gnus-make-thread-indent-array
1689 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1690 gnus-summary-skip-intangible gnus-summary-article-number
1691 gnus-data-header gnus-data-find)
1693 gnus-group-list-groups gnus-group-first-unread-group
1694 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1695 gnus-group-setup-buffer gnus-group-get-new-news
1696 gnus-group-make-help-group gnus-group-update-group
1697 gnus-clear-inboxes-moved gnus-group-iterate
1698 gnus-group-group-name)
1700 gnus-backlog-remove-article)
1702 gnus-article-prepare gnus-article-set-window-start
1703 gnus-article-next-page gnus-article-prev-page
1704 gnus-request-article-this-buffer gnus-article-mode
1705 gnus-article-setup-buffer gnus-narrow-to-page
1706 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1708 gnus-article-hide-headers gnus-article-hide-boring-headers
1709 gnus-article-treat-overstrike gnus-article-word-wrap
1710 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1711 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1712 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1713 gnus-article-hide-pem gnus-article-hide-signature
1714 gnus-article-strip-leading-blank-lines gnus-article-date-local
1715 gnus-article-date-original gnus-article-date-lapsed
1716 gnus-article-show-all-headers
1717 gnus-article-edit-mode gnus-article-edit-article
1718 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522
1719 gnus-start-date-timer gnus-stop-date-timer)
1722 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1724 gnus-dup-enter-articles)
1728 gnus-group-move-group-to-server gnus-change-server)
1732 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1733 gnus-async-halt-prefetch)
1735 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1736 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1737 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1739 gnus-unplugged gnus-agentize gnus-agent-batch)
1741 gnus-summary-save-article-vm)
1744 ;;; gnus-sum.el thingies
1748 "*The format specification of the lines in the summary buffer.
1750 It works along the same lines as a normal formatting string,
1751 with some simple extensions.
1753 %N Article number, left padded with spaces (string)
1754 %S Subject (string)
1756 %n Name of the poster (string)
1757 %a Extracted name of the poster (string)
1758 %A Extracted address of the poster (string)
1759 %F Contents of the From: header (string)
1760 %x Contents of the Xref: header (string)
1761 %D Date of the article (string)
1762 %d Date of the article (string) in DD-MMM format
1763 %M Message-id of the article (string)
1764 %r References of the article (string)
1765 %c Number of characters in the article (integer)
1766 %L Number of lines in the article (integer)
1767 %I Indentation based on thread level (a string of spaces)
1768 %T A string with two possible values: 80 spaces if the article
1769 is on thread level two or larger and 0 spaces on level one
1774 %> Spaces of length thread-level (string)
1775 %< Spaces of length (- 20 thread-level) (string)
1776 %i Article score (number)
1777 %z Article zcore (character)
1778 %t Number of articles under the current thread (number).
1779 %e Whether the thread is empty or not (character).
1780 %l GroupLens score (string).
1781 %V Total thread score (number).
1782 %P The line number (number).
1783 %O Download mark (character).
1784 %u User defined specifier. The next character in the format string should
1785 be a letter. Gnus will call the function gnus-user-format-function-X,
1786 where X is the letter following %u. The function will be passed the
1787 current header as argument. The function should return a string, which
1788 will be inserted into the summary just like information from any other
1789 summary specifier.
1791 Text between %( and %) will be highlighted with `gnus-mouse-face'
1792 when the mouse point is placed inside the area. There can only be one
1793 such area.
1795 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1796 with care. For reasons of efficiency, Gnus will compute what column
1798 it is illegal to have these specs after a variable-length spec. Well,
1799 you might not be arrested, but your summary buffer will look strange,
1800 which is bad enough.
1802 The smart choice is to have these specs as for to the left as
1803 possible.
1805 This restriction may disappear in later versions of Gnus."
1809 ;;;
1810 ;;; Skeleton keymaps
1811 ;;;
1816 (while keys
1817 (define-key keymap (pop keys) 'undefined))))
1819 (defvar gnus-article-mode-map
1820 (let ((keymap (make-keymap)))
1821 (gnus-suppress-keymap keymap)
1822 keymap))
1823 (defvar gnus-summary-mode-map
1824 (let ((keymap (make-keymap)))
1825 (gnus-suppress-keymap keymap)
1826 keymap))
1827 (defvar gnus-group-mode-map
1828 (let ((keymap (make-keymap)))
1829 (gnus-suppress-keymap keymap)
1830 keymap))
1832 \f
1834 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1835 ;; If you want the cursor to go somewhere else, set these two
1836 ;; functions in some startup hook to whatever you want.
1837 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1838 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1840 ;;; Various macros and substs.
1842 (defun gnus-header-from (header)
1843 (mail-header-from header))
1845 (defmacro gnus-gethash (string hashtable)
1846 "Get hash value of STRING in HASHTABLE."
1847 `(symbol-value (intern-soft ,string ,hashtable)))
1849 (defmacro gnus-sethash (string value hashtable)
1850 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1851 `(set (intern ,string ,hashtable) ,value))
1852 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1854 (defmacro gnus-group-unread (group)
1855 "Get the currently computed number of unread articles in GROUP."
1856 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1858 (defmacro gnus-group-entry (group)
1859 "Get the newsrc entry for GROUP."
1860 `(gnus-gethash ,group gnus-newsrc-hashtb))
1862 (defmacro gnus-active (group)
1863 "Get active info on GROUP."
1864 `(gnus-gethash ,group gnus-active-hashtb))
1866 (defmacro gnus-set-active (group active)
1867 "Set GROUP's active info."
1868 `(gnus-sethash ,group ,active gnus-active-hashtb))
1870 ;; Info access macros.
1872 (defmacro gnus-info-group (info)
1873 `(nth 0 ,info))
1874 (defmacro gnus-info-rank (info)
1875 `(nth 1 ,info))
1876 (defmacro gnus-info-read (info)
1877 `(nth 2 ,info))
1878 (defmacro gnus-info-marks (info)
1879 `(nth 3 ,info))
1880 (defmacro gnus-info-method (info)
1881 `(nth 4 ,info))
1882 (defmacro gnus-info-params (info)
1883 `(nth 5 ,info))
1885 (defmacro gnus-info-level (info)
1886 `(let ((rank (gnus-info-rank ,info)))
1887 (if (consp rank)
1888 (car rank)
1889 rank)))
1890 (defmacro gnus-info-score (info)
1891 `(let ((rank (gnus-info-rank ,info)))
1892 (or (and (consp rank) (cdr rank)) 0)))
1894 (defmacro gnus-info-set-group (info group)
1895 `(setcar ,info ,group))
1896 (defmacro gnus-info-set-rank (info rank)
1897 `(setcar (nthcdr 1 ,info) ,rank))
1898 (defmacro gnus-info-set-read (info read)
1899 `(setcar (nthcdr 2 ,info) ,read))
1900 (defmacro gnus-info-set-marks (info marks &optional extend)
1901 (if extend
1902 `(gnus-info-set-entry ,info ,marks 3)
1903 `(setcar (nthcdr 3 ,info) ,marks)))
1904 (defmacro gnus-info-set-method (info method &optional extend)
1905 (if extend
1906 `(gnus-info-set-entry ,info ,method 4)
1907 `(setcar (nthcdr 4 ,info) ,method)))
1908 (defmacro gnus-info-set-params (info params &optional extend)
1909 (if extend
1910 `(gnus-info-set-entry ,info ,params 5)
1911 `(setcar (nthcdr 5 ,info) ,params)))
1913 (defun gnus-info-set-entry (info entry number)
1914 ;; Extend the info until we have enough elements.
1915 (while (<= (length info) number)
1916 (nconc info (list nil)))
1917 ;; Set the entry.
1918 (setcar (nthcdr number info) entry))
1920 (defmacro gnus-info-set-level (info level)
1921 `(let ((rank (cdr ,info)))
1922 (if (consp (car rank))
1923 (setcar (car rank) ,level)
1924 (setcar rank ,level))))
1925 (defmacro gnus-info-set-score (info score)
1926 `(let ((rank (cdr ,info)))
1927 (if (consp (car rank))
1928 (setcdr (car rank) ,score)
1929 (setcar rank (cons (car rank) ,score)))))
1931 (defmacro gnus-get-info (group)
1932 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1934 ;; Byte-compiler warning.
1935 (defvar gnus-visual)
1936 ;; Find out whether the gnus-visual TYPE is wanted.
1937 (defun gnus-visual-p (&optional type class)
1938 (and gnus-visual ; Has to be non-nil, at least.
1939 (if (not type) ; We don't care about type.
1940 gnus-visual
1941 (if (listp gnus-visual) ; It's a list, so we check it.
1942 (or (memq type gnus-visual)
1943 (memq class gnus-visual))
1944 t))))
1946 ;;; Load the compatability functions.
1948 (require 'gnus-ems)
1950 \f
1951 ;;;
1952 ;;; Shutdown
1953 ;;;
1955 (defvar gnus-shutdown-alist nil)
1957 (defun gnus-add-shutdown (function &rest symbols)
1958 "Run FUNCTION whenever one of SYMBOLS is shut down."
1959 (push (cons function symbols) gnus-shutdown-alist))
1961 (defun gnus-shutdown (symbol)
1962 "Shut down everything that waits for SYMBOL."
1963 (let ((alist gnus-shutdown-alist)
1964 entry)
1965 (while (setq entry (pop alist))
1966 (when (memq symbol (cdr entry))
1967 (funcall (car entry))))))
1969 \f
1970 ;;;
1971 ;;; Gnus Utility Functions
1972 ;;;
1975 (defmacro gnus-string-or (&rest strings)
1976 "Return the first element of STRINGS that is a non-blank string.
1977 STRINGS will be evaluated in normal `or' order."
1978 `(gnus-string-or-1 ',strings))
1980 (defun gnus-string-or-1 (strings)
1981 (let (string)
1982 (while strings
1983 (setq string (eval (pop strings)))
1985 (setq string nil)
1986 (setq strings nil)))
1987 string))
1989 (defun gnus-version (&optional arg)
1990 "Version number of this version of Gnus.
1991 If ARG, insert string at point."
1992 (interactive "P")
1993 (if arg
1994 (insert (message gnus-version))
1995 (message gnus-version)))
1997 (defun gnus-continuum-version (version)
1998 "Return VERSION as a floating point number."
2001 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2002 (number (match-string 2 version))
2003 major minor least)
2004 (unless (string-match
2006 (error "Invalid version string: %s" version))
2007 (setq major (string-to-number (match-string 1 number))
2008 minor (string-to-number (match-string 2 number))
2009 least (if (match-beginning 3)
2010 (string-to-number (match-string 3 number))
2011 0))
2012 (string-to-number
2013 (if (zerop major)
2014 (format "%s00%02d%02d"
2015 (cond
2016 ((member alpha '("(ding)" "d")) "4.99")
2017 ((member alpha '("September" "s")) "5.01")
2018 ((member alpha '("Red" "r")) "5.03")
2019 ((member alpha '("Quassia" "q")) "5.05")
2020 ((member alpha '("p")) "5.07")
2021 ((member alpha '("o")) "5.09")
2022 ((member alpha '("n")) "5.11"))
2023 minor least)
2024 (format "%d.%02d%02d" major minor least))))))
2026 (defun gnus-info-find-node ()
2027 "Find Info documentation of Gnus."
2028 (interactive)
2029 ;; Enlarge info window if needed.
2030 (let (gnus-info-buffer)
2031 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2032 (setq gnus-info-buffer (current-buffer))
2033 (gnus-configure-windows 'info)))
2035 ;;;
2036 ;;; gnus-interactive
2037 ;;;
2039 (defvar gnus-current-prefix-symbol nil
2040 "Current prefix symbol.")
2042 (defvar gnus-current-prefix-symbols nil
2043 "List of current prefix symbols.")
2045 (defun gnus-interactive (string &optional params)
2046 "Return a list that can be fed to `interactive'.
2047 See `interactive' for full documentation.
2049 Adds the following specs:
2051 y -- The current symbolic prefix.
2052 Y -- A list of the current symbolic prefix(es).
2053 A -- Article number.
2054 H -- Article header.
2055 g -- Group name."
2056 (let ((i 0)
2057 out c prompt)
2058 (while (< i (length string))
2060 (setq c (aref string i))
2061 (when (match-end 1)
2062 (setq prompt (match-string 1 string)))
2063 (setq i (match-end 0))
2064 ;; We basically emulate just about everything that
2065 ;; `interactive' does, but add the specs listed above.
2066 (push
2067 (cond
2068 ((= c ?a)
2069 (completing-read prompt obarray 'fboundp t))
2070 ((= c ?b)
2071 (read-buffer prompt (current-buffer) t))
2072 ((= c ?B)
2073 (read-buffer prompt (other-buffer (current-buffer))))
2074 ((= c ?c)
2075 (read-char))
2076 ((= c ?C)
2077 (completing-read prompt obarray 'commandp t))
2078 ((= c ?d)
2079 (point))
2080 ((= c ?D)
2081 (read-file-name prompt nil default-directory 'lambda))
2082 ((= c ?f)
2083 (read-file-name prompt nil nil 'lambda))
2084 ((= c ?F)
2085 (read-file-name prompt))
2086 ((= c ?k)
2087 (read-key-sequence prompt))
2088 ((= c ?K)
2089 (error "Not implemented spec"))
2090 ((= c ?e)
2091 (error "Not implemented spec"))
2092 ((= c ?m)
2093 (mark))
2094 ((= c ?N)
2095 (error "Not implemented spec"))
2096 ((= c ?n)
2097 (string-to-number (read-from-minibuffer prompt)))
2098 ((= c ?p)
2099 (prefix-numeric-value current-prefix-arg))
2100 ((= c ?P)
2101 current-prefix-arg)
2102 ((= c ?r)
2103 'gnus-prefix-nil)
2104 ((= c ?s)
2105 (read-string prompt))
2106 ((= c ?S)
2107 (intern (read-string prompt)))
2108 ((= c ?v)
2109 (read-variable prompt))
2110 ((= c ?x)
2111 (read-minibuffer prompt))
2112 ((= c ?x)
2113 (eval-minibuffer prompt))
2114 ;; And here the new specs come.
2115 ((= c ?y)
2116 gnus-current-prefix-symbol)
2117 ((= c ?Y)
2118 gnus-current-prefix-symbols)
2119 ((= c ?g)
2120 (gnus-group-group-name))
2121 ((= c ?A)
2122 (gnus-summary-skip-intangible)
2123 (or (get-text-property (point) 'gnus-number)
2124 (gnus-summary-last-subject)))
2125 ((= c ?H)
2126 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2127 (t
2128 (error "Non-implemented spec")))
2129 out)
2130 (cond
2131 ((= c ?r)
2132 (push (if (< (point) (mark) (point) (mark))) out)
2133 (push (if (> (point) (mark) (point) (mark))) out))))
2134 (setq out (delq 'gnus-prefix-nil out))
2135 (nreverse out)))
2137 (defun gnus-symbolic-argument (&optional arg)
2138 "Read a symbolic argument and a command, and then execute command."
2139 (interactive "P")
2140 (let* ((in-command (this-command-keys))
2141 (command in-command)
2142 gnus-current-prefix-symbols
2143 gnus-current-prefix-symbol
2144 syms)
2145 (while (equal in-command command)
2146 (message "%s-" (key-description (this-command-keys)))
2147 (push (intern (char-to-string (read-char))) syms)
2148 (setq command (read-key-sequence nil t)))
2149 (setq gnus-current-prefix-symbols (nreverse syms)
2150 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2151 (call-interactively (key-binding command t))))
2153 ;;; More various functions.
2155 (defsubst gnus-check-backend-function (func group)
2156 "Check whether GROUP supports function FUNC.
2157 GROUP can either be a string (a group name) or a select method."
2158 (ignore-errors
2159 (let ((method (if (stringp group)
2160 (car (gnus-find-method-for-group group))
2161 group)))
2162 (unless (featurep method)
2163 (require method))
2164 (fboundp (intern (format "%s-%s" method func))))))
2166 (defun gnus-group-read-only-p (&optional group)
2167 "Check whether GROUP supports editing or not.
2168 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2169 that that variable is buffer-local to the summary buffers."
2170 (let ((group (or group gnus-newsgroup-name)))
2171 (not (gnus-check-backend-function 'request-replace-article group))))
2173 (defun gnus-group-total-expirable-p (group)
2174 "Check whether GROUP is total-expirable or not."
2175 (let ((params (gnus-group-find-parameter group))
2176 val)
2177 (cond
2178 ((memq 'total-expire params)
2179 t)
2180 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2181 (cdr val))
2182 (gnus-total-expirable-newsgroups ; Check var.
2183 (string-match gnus-total-expirable-newsgroups group)))))
2185 (defun gnus-group-auto-expirable-p (group)
2186 "Check whether GROUP is auto-expirable or not."
2187 (let ((params (gnus-group-find-parameter group))
2188 val)
2189 (cond
2190 ((memq 'auto-expire params)
2191 t)
2192 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2193 (cdr val))
2194 (gnus-auto-expirable-newsgroups ; Check var.
2195 (string-match gnus-auto-expirable-newsgroups group)))))
2197 (defun gnus-virtual-group-p (group)
2198 "Say whether GROUP is virtual or not."
2199 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2200 gnus-valid-select-methods)))
2202 (defun gnus-news-group-p (group &optional article)
2203 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2204 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2205 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2206 (if (or (null article)
2207 (not (< article 0)))
2208 (eq (gnus-request-type group article) 'news)
2209 (if (not (vectorp article))
2210 nil
2211 ;; It's a real article.
2212 (eq (gnus-request-type group (mail-header-id article))
2213 'news))))))
2215 ;; Returns a list of writable groups.
2216 (defun gnus-writable-groups ()
2217 (let ((alist gnus-newsrc-alist)
2218 groups group)
2219 (while (setq group (car (pop alist)))
2220 (unless (gnus-group-read-only-p group)
2221 (push group groups)))
2222 (nreverse groups)))
2224 ;; Check whether to use long file names.
2225 (defun gnus-use-long-file-name (symbol)
2226 ;; The variable has to be set...
2227 (and gnus-use-long-file-name
2228 ;; If it isn't a list, then we return t.
2229 (or (not (listp gnus-use-long-file-name))
2230 ;; If it is a list, and the list contains `symbol', we
2231 ;; return nil.
2232 (not (memq symbol gnus-use-long-file-name)))))
2234 ;; Generate a unique new group name.
2235 (defun gnus-generate-new-group-name (leaf)
2236 (let ((name leaf)
2237 (num 0))
2238 (while (gnus-gethash name gnus-newsrc-hashtb)
2239 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2240 name))
2242 (defun gnus-ephemeral-group-p (group)
2243 "Say whether GROUP is ephemeral or not."
2244 (gnus-group-get-parameter group 'quit-config t))
2246 (defun gnus-group-quit-config (group)
2247 "Return the quit-config of GROUP."
2248 (gnus-group-get-parameter group 'quit-config t))
2250 (defun gnus-kill-ephemeral-group (group)
2251 "Remove ephemeral GROUP from relevant structures."
2252 (gnus-sethash group nil gnus-newsrc-hashtb))
2254 (defun gnus-simplify-mode-line ()
2255 "Make mode lines a bit simpler."
2256 (setq mode-line-modified (cdr gnus-mode-line-modified))
2257 (when (listp mode-line-format)
2258 (make-local-variable 'mode-line-format)
2259 (setq mode-line-format (copy-sequence mode-line-format))
2260 (when (equal (nth 3 mode-line-format) " ")
2261 (setcar (nthcdr 3 mode-line-format) " "))))
2263 ;;; Servers and groups.
2265 (defsubst gnus-server-add-address (method)
2266 (let ((method-name (symbol-name (car method))))
2267 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2268 (not (assq (intern (concat method-name "-address")) method))
2269 (memq 'physical-address (assq (car method)
2270 gnus-valid-select-methods)))
2271 (append method (list (list (intern (concat method-name "-address"))
2272 (nth 1 method))))
2273 method)))
2275 (defsubst gnus-server-get-method (group method)
2276 ;; Input either a server name, and extended server name, or a
2277 ;; select method, and return a select method.
2278 (cond ((stringp method)
2279 (gnus-server-to-method method))
2280 ((equal method gnus-select-method)
2281 gnus-select-method)
2282 ((and (stringp (car method))
2283 group)
2284 (gnus-server-extend-method group method))
2285 ((and method
2286 (not group)
2287 (equal (cadr method) ""))
2288 method)
2289 (t
2290 (gnus-server-add-address method))))
2292 (defun gnus-server-to-method (server)
2293 "Map virtual server names to select methods."
2294 (or
2295 ;; Is this a method, perhaps?
2296 (and server (listp server) server)
2297 ;; Perhaps this is the native server?
2298 (and (equal server "native") gnus-select-method)
2299 ;; It should be in the server alist.
2300 (cdr (assoc server gnus-server-alist))
2301 ;; It could be in the predefined server alist.
2302 (cdr (assoc server gnus-predefined-server-alist))
2303 ;; If not, we look through all the opened server
2304 ;; to see whether we can find it there.
2305 (let ((opened gnus-opened-servers))
2306 (while (and opened
2307 (not (equal server (format "%s:%s" (caaar opened)
2308 (cadaar opened)))))
2309 (pop opened))
2310 (caar opened))))
2312 (defmacro gnus-method-equal (ss1 ss2)
2313 "Say whether two servers are equal."
2314 `(let ((s1 ,ss1)
2315 (s2 ,ss2))
2316 (or (equal s1 s2)
2317 (and (= (length s1) (length s2))
2318 (progn
2319 (while (and s1 (member (car s1) s2))
2320 (setq s1 (cdr s1)))
2321 (null s1))))))
2323 (defun gnus-server-equal (m1 m2)
2324 "Say whether two methods are equal."
2325 (let ((m1 (cond ((null m1) gnus-select-method)
2326 ((stringp m1) (gnus-server-to-method m1))
2327 (t m1)))
2328 (m2 (cond ((null m2) gnus-select-method)
2329 ((stringp m2) (gnus-server-to-method m2))
2330 (t m2))))
2331 (gnus-method-equal m1 m2)))
2333 (defun gnus-servers-using-backend (backend)
2334 "Return a list of known servers using BACKEND."
2335 (let ((opened gnus-opened-servers)
2336 out)
2337 (while opened
2338 (when (eq backend (caaar opened))
2339 (push (caar opened) out))
2340 (pop opened))
2341 out))
2343 (defun gnus-archive-server-wanted-p ()
2344 "Say whether the user wants to use the archive server."
2345 (cond
2346 ((or (not gnus-message-archive-method)
2347 (not gnus-message-archive-group))
2348 nil)
2349 ((and gnus-message-archive-method gnus-message-archive-group)
2350 t)
2351 (t
2352 (let ((active (cadr (assq 'nnfolder-active-file
2353 gnus-message-archive-method))))
2354 (and active
2355 (file-exists-p active))))))
2357 (defun gnus-group-prefixed-name (group method)
2358 "Return the whole name from GROUP and METHOD."
2359 (and (stringp method) (setq method (gnus-server-to-method method)))
2360 (if (or (not method)
2361 (gnus-server-equal method "native"))
2362 group
2363 (concat (format "%s" (car method))
2364 (when (and
2365 (or (assoc (format "%s" (car method))
2366 (gnus-methods-using 'address))
2367 (gnus-server-equal method gnus-message-archive-method))
2368 (nth 1 method)
2369 (not (string= (nth 1 method) "")))
2370 (concat "+" (nth 1 method)))
2371 ":" group)))
2373 (defun gnus-group-real-prefix (group)
2374 "Return the prefix of the current group name."
2375 (if (string-match "^[^:]+:" group)
2376 (substring group 0 (match-end 0))
2377 ""))
2379 (defun gnus-group-method (group)
2380 "Return the server or method used for selecting GROUP.
2381 You should probably use `gnus-find-method-for-group' instead."
2382 (let ((prefix (gnus-group-real-prefix group)))
2383 (if (equal prefix "")
2384 gnus-select-method
2385 (let ((servers gnus-opened-servers)
2386 (server "")
2387 backend possible found)
2389 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2390 server (substring prefix (match-end 0) (1- (length prefix))))
2391 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2392 (while servers
2393 (when (eq (caaar servers) backend)
2394 (setq possible (caar servers))
2395 (when (equal (cadaar servers) server)
2396 (setq found (caar servers))))
2397 (pop servers))
2398 (or (car (rassoc found gnus-server-alist))
2399 found
2400 (car (rassoc possible gnus-server-alist))
2401 possible
2402 (list backend server))))))
2404 (defsubst gnus-secondary-method-p (method)
2405 "Return whether METHOD is a secondary select method."
2406 (let ((methods gnus-secondary-select-methods)
2407 (gmethod (gnus-server-get-method nil method)))
2408 (while (and methods
2409 (not (equal (gnus-server-get-method nil (car methods))
2410 gmethod)))
2411 (setq methods (cdr methods)))
2412 methods))
2414 (defun gnus-groups-from-server (server)
2415 "Return a list of all groups that are fetched from SERVER."
2416 (let ((alist (cdr gnus-newsrc-alist))
2417 info groups)
2418 (while (setq info (pop alist))
2419 (when (gnus-server-equal (gnus-info-method info) server)
2420 (push (gnus-info-group info) groups)))
2421 (sort groups 'string<)))
2423 (defun gnus-group-foreign-p (group)
2424 "Say whether a group is foreign or not."
2425 (and (not (gnus-group-native-p group))
2426 (not (gnus-group-secondary-p group))))
2428 (defun gnus-group-native-p (group)
2429 "Say whether the group is native or not."
2430 (not (string-match ":" group)))
2432 (defun gnus-group-secondary-p (group)
2433 "Say whether the group is secondary or not."
2434 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2436 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2437 "Return the group parameters for GROUP.
2438 If SYMBOL, return the value of that symbol in the group parameters."
2439 (save-excursion
2440 (set-buffer gnus-group-buffer)
2441 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2442 (if symbol
2443 (gnus-group-parameter-value parameters symbol allow-list)
2444 parameters))))
2446 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2447 "Return the group parameters for GROUP.
2448 If SYMBOL, return the value of that symbol in the group parameters.
2449 Most functions should use `gnus-group-find-parameter', which
2450 also examines the topic parameters."
2451 (let ((params (gnus-info-params (gnus-get-info group))))
2452 (if symbol
2453 (gnus-group-parameter-value params symbol allow-list)
2454 params)))
2456 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2457 "Return the value of SYMBOL in group PARAMS."
2458 ;; We only wish to return group parameters (dotted lists) and
2459 ;; not local variables, which may have the same names.
2460 ;; But first we handle single elements...
2461 (or (car (memq symbol params))
2462 ;; Handle alist.
2463 (let (elem)
2464 (catch 'found
2465 (while (setq elem (pop params))
2466 (when (and (consp elem)
2467 (eq (car elem) symbol)
2468 (or allow-list
2469 (atom (cdr elem))))
2470 (throw 'found (cdr elem))))))))
2472 (defun gnus-group-add-parameter (group param)
2473 "Add parameter PARAM to GROUP."
2474 (let ((info (gnus-get-info group)))
2475 (when info
2476 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2477 ;; Cons the new param to the old one and update.
2478 (gnus-group-set-info (cons param (gnus-info-params info))
2479 group 'params))))
2481 (defun gnus-group-set-parameter (group name value)
2482 "Set parameter NAME to VALUE in GROUP."
2483 (let ((info (gnus-get-info group)))
2484 (when info
2485 (gnus-group-remove-parameter group name)
2486 (let ((old-params (gnus-info-params info))
2487 (new-params (list (cons name value))))
2488 (while old-params
2489 (when (or (not (listp (car old-params)))
2490 (not (eq (caar old-params) name)))
2491 (setq new-params (append new-params (list (car old-params)))))
2492 (setq old-params (cdr old-params)))
2493 (gnus-group-set-info new-params group 'params)))))
2495 (defun gnus-group-remove-parameter (group name)
2496 "Remove parameter NAME from GROUP."
2497 (let ((info (gnus-get-info group)))
2498 (when info
2499 (let ((params (gnus-info-params info)))
2500 (when params
2501 (setq params (delq name params))
2502 (while (assq name params)
2503 (gnus-pull name params))
2504 (gnus-info-set-params info params))))))
2506 (defun gnus-group-add-score (group &optional score)
2507 "Add SCORE to the GROUP score.
2508 If SCORE is nil, add 1 to the score of GROUP."
2509 (let ((info (gnus-get-info group)))
2510 (when info
2511 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2513 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2514 (defun gnus-short-group-name (group &optional levels)
2515 "Collapse GROUP name LEVELS.
2516 Select methods are stripped and any remote host name is stripped down to
2517 just the host name."
2518 (let* ((name "")
2519 (foreign "")
2520 (depth 0)
2521 (skip 1)
2522 (levels (or levels
2523 (progn
2525 (setq skip (match-end 0)
2526 depth (+ depth 1)))
2527 depth))))
2528 ;; separate foreign select method from group name and collapse.
2529 ;; if method contains a server, collapse to non-domain server name,
2530 ;; otherwise collapse to select method
2531 (when (string-match ":" group)
2532 (cond ((string-match "+" group)
2533 (let* ((plus (string-match "+" group))
2534 (colon (string-match ":" group (or plus 0)))
2536 (setq foreign (concat
2537 (substring group (+ 1 plus)
2538 (cond ((null dot) colon)
2539 ((< colon dot) colon)
2540 ((< dot colon) dot)))
2541 ":")
2542 group (substring group (+ 1 colon)))))
2543 (t
2544 (let* ((colon (string-match ":" group)))
2545 (setq foreign (concat (substring group 0 (+ 1 colon)))
2546 group (substring group (+ 1 colon)))))))
2547 ;; collapse group name leaving LEVELS uncollapsed elements
2548 (while group
2550 (setq name (concat name (substring group 0 1))
2551 group (substring group (match-end 0))
2552 levels (- levels 1)
2553 name (concat name "."))
2554 (setq name (concat foreign name group)
2555 group nil)))
2556 name))
2558 (defun gnus-narrow-to-body ()
2559 "Narrow to the body of an article."
2560 (narrow-to-region
2561 (progn
2562 (goto-char (point-min))
2564 (point-max)))
2565 (point-max)))
2567 \f
2568 ;;;
2569 ;;; Kill file handling.
2570 ;;;
2572 (defun gnus-apply-kill-file ()
2573 "Apply a kill file to the current newsgroup.
2574 Returns the number of articles marked as read."
2575 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2576 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2577 (gnus-apply-kill-file-internal)
2578 0))
2580 (defun gnus-kill-save-kill-buffer ()
2581 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2582 (when (get-file-buffer file)
2583 (save-excursion
2584 (set-buffer (get-file-buffer file))
2585 (when (buffer-modified-p)
2586 (save-buffer))
2587 (kill-buffer (current-buffer))))))
2589 (defcustom gnus-kill-file-name "KILL"
2590 "Suffix of the kill files."
2591 :group 'gnus-score-kill
2592 :group 'gnus-score-files
2593 :type 'string)
2595 (defun gnus-newsgroup-kill-file (newsgroup)
2596 "Return the name of a kill file name for NEWSGROUP.
2597 If NEWSGROUP is nil, return the global kill file name instead."
2598 (cond
2599 ;; The global KILL file is placed at top of the directory.
2600 ((or (null newsgroup)
2601 (string-equal newsgroup ""))
2602 (expand-file-name gnus-kill-file-name
2603 gnus-kill-files-directory))
2604 ;; Append ".KILL" to newsgroup name.
2605 ((gnus-use-long-file-name 'not-kill)
2606 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2607 "." gnus-kill-file-name)
2608 gnus-kill-files-directory))
2609 ;; Place "KILL" under the hierarchical directory.
2610 (t
2611 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2612 "/" gnus-kill-file-name)
2613 gnus-kill-files-directory))))
2615 ;;; Server things.
2617 (defun gnus-member-of-valid (symbol group)
2619 (memq symbol (assoc
2620 (symbol-name (car (gnus-find-method-for-group group)))
2621 gnus-valid-select-methods)))
2623 (defun gnus-method-option-p (method option)
2624 "Return non-nil if select METHOD has OPTION as a parameter."
2625 (when (stringp method)
2626 (setq method (gnus-server-to-method method)))
2627 (memq option (assoc (format "%s" (car method))
2628 gnus-valid-select-methods)))
2630 (defun gnus-similar-server-opened (method)
2631 (let ((opened gnus-opened-servers))
2632 (while (and method opened)
2633 (when (and (equal (cadr method) (cadaar opened))
2634 (not (equal method (caar opened))))
2635 (setq method nil))
2636 (pop opened))
2637 (not method)))
2639 (defun gnus-server-extend-method (group method)
2640 ;; This function "extends" a virtual server. If the server is
2641 ;; "hello", and the select method is ("hello" (my-var "something"))
2642 ;; in the group "alt.alt", this will result in a new virtual server
2643 ;; called "hello+alt.alt".
2644 (if (or (not (inline (gnus-similar-server-opened method)))
2645 (not (cddr method)))
2646 method
2647 `(,(car method) ,(concat (cadr method) "+" group)
2648 (,(intern (format "%s-address" (car method))) ,(cadr method))
2649 ,@(cddr method))))
2651 (defun gnus-server-status (method)
2652 "Return the status of METHOD."
2653 (nth 1 (assoc method gnus-opened-servers)))
2655 (defun gnus-group-name-to-method (group)
2656 "Guess a select method based on GROUP."
2657 (if (string-match ":" group)
2658 (let ((server (substring group 0 (match-beginning 0))))
2660 (list (intern (substring server 0 (match-beginning 0)))
2661 (substring server (match-end 0)))
2662 (list (intern server) "")))
2663 gnus-select-method))
2665 (defun gnus-find-method-for-group (group &optional info)
2666 "Find the select method that GROUP uses."
2667 (or gnus-override-method
2668 (and (not group)
2669 gnus-select-method)
2670 (let ((info (or info (gnus-get-info group)))
2671 method)
2672 (if (or (not info)
2673 (not (setq method (gnus-info-method info)))
2674 (equal method "native"))
2675 gnus-select-method
2676 (setq method
2677 (cond ((stringp method)
2678 (inline (gnus-server-to-method method)))
2679 ((stringp (cadr method))
2680 (inline (gnus-server-extend-method group method)))
2681 (t
2682 method)))
2683 (cond ((equal (cadr method) "")
2684 method)
2685 ((null (cadr method))
2686 (list (car method) ""))
2687 (t
2688 (gnus-server-add-address method)))))))
2690 (defun gnus-methods-using (feature)
2691 "Find all methods that have FEATURE."
2692 (let ((valids gnus-valid-select-methods)
2693 outs)
2694 (while valids
2695 (when (memq feature (car valids))
2696 (push (car valids) outs))
2697 (setq valids (cdr valids)))
2698 outs))
2700 (defun gnus-read-group (prompt &optional default)
2701 "Prompt the user for a group name.
2702 Disallow illegal group names."
2703 (let ((prefix "")
2704 group)
2705 (while (not group)
2706 (when (string-match
2708 (setq group (read-string (concat prefix prompt)
2709 (cons (or default "") 0)
2710 'gnus-group-history)))
2712 group nil)))
2713 group))
2715 (defun gnus-read-method (prompt)
2716 "Prompt the user for a method.
2717 Allow completion over sensible values."
2718 (let* ((servers
2719 (append gnus-valid-select-methods
2720 gnus-predefined-server-alist
2721 gnus-server-alist))
2722 (method
2723 (completing-read
2724 prompt servers
2725 nil t nil 'gnus-method-history)))
2726 (cond
2727 ((equal method "")
2728 (setq method gnus-select-method))
2729 ((assoc method gnus-valid-select-methods)
2730 (list (intern method)
2731 (if (memq 'prompt-address
2732 (assoc method gnus-valid-select-methods))
2733 (read-string "Address: ")
2734 "")))
2735 ((assoc method servers)
2736 method)
2737 (t
2738 (list (intern method) "")))))
2740 ;;; User-level commands.
2742 ;;;###autoload
2743 (defun gnus-slave-no-server (&optional arg)
2744 "Read network news as a slave, without connecting to local server."
2745 (interactive "P")
2746 (gnus-no-server arg t))
2748 ;;;###autoload
2749 (defun gnus-no-server (&optional arg slave)
2750 "Read network news.
2751 If ARG is a positive number, Gnus will use that as the
2752 startup level. If ARG is nil, Gnus will be started at level 2.
2753 If ARG is non-nil and not a positive number, Gnus will
2754 prompt the user for the name of an NNTP server to use.
2755 As opposed to `gnus', this command will not connect to the local server."
2756 (interactive "P")
2757 (gnus-no-server-1 arg slave))
2759 ;;;###autoload
2760 (defun gnus-slave (&optional arg)
2761 "Read news as a slave."
2762 (interactive "P")
2763 (gnus arg nil 'slave))
2765 ;;;###autoload
2766 (defun gnus-other-frame (&optional arg)
2767 "Pop up a frame to read news."
2768 (interactive "P")
2769 (let ((window (get-buffer-window gnus-group-buffer)))
2770 (cond (window
2771 (select-frame (window-frame window)))
2772 ((= (length (frame-list)) 1)
2773 (select-frame (make-frame)))
2774 (t
2775 (other-frame 1))))
2776 (gnus arg))
2778 ;;;###autoload
2779 (defun gnus (&optional arg dont-connect slave)
2780 "Read network news.
2781 If ARG is non-nil and a positive number, Gnus will use that as the
2782 startup level. If ARG is non-nil and not a positive number, Gnus will
2783 prompt the user for the name of an NNTP server to use."
2784 (interactive "P")
2785 (gnus-1 arg dont-connect slave))
2787 ;; Allow redefinition of Gnus functions.
2789 (gnus-ems-redefine)
2791 (provide 'gnus)
2793 ;;; gnus.el ends here