| blob | aaa8ab9a888d3767f82e90c413cedc1e9b04fb5a |
1 ;;; gnus-start.el --- startup functions for Gnus
3 ;; Copyright (C) 1996-2017 Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
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 3 of the License, or
13 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
47 "Your `.newsrc' file.
48 `.newsrc-SERVER' will be used instead if that exists."
53 "Control use of version numbers for backups of `gnus-startup-file'.
54 This variable takes the same values as the `version-control'
55 variable."
63 "Whether to write the startup file contents to a buffer then save
64 the buffer or write directly to the file. The buffer is faster
65 because all of the contents are written at once. The direct write
66 uses considerably less memory."
73 "Your Gnus Emacs-Lisp startup file name.
74 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
84 "The site-wide Gnus Emacs-Lisp startup file name, or nil if none.
85 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
90 "Non-nil means that Gnus will use a dribble file to store user updates.
91 If Emacs should crash without saving the .newsrc files, complete
92 information can be restored from the dribble file."
97 "The directory where dribble files will be saved.
98 If this variable is nil, the directory where the .newsrc files are
99 saved will be used."
104 "Non-nil means that Gnus will run `gnus-find-new-newsgroups' at startup.
105 This normally finds new newsgroups by comparing the active groups the
106 servers have already reported with those Gnus already knows, either alive
107 or killed.
109 When any of the following are true, `gnus-find-new-newsgroups' will instead
110 ask the servers (primary, secondary, and archive servers) to list new
111 groups since the last time it checked:
112 1. This variable is `ask-server'.
113 2. This variable is a list of select methods (see below).
114 3. Option `gnus-read-active-file' is nil or `some'.
115 4. A prefix argument is given to `gnus-find-new-newsgroups' interactively.
117 Thus, if this variable is `ask-server' or a list of select methods or
118 `gnus-read-active-file' is nil or `some', then the killed list is no
119 longer necessary, so you could safely set `gnus-save-killed-list' to nil.
121 This variable can be a list of select methods which Gnus will query with
122 the `ask-server' method in addition to the primary, secondary, and archive
123 servers.
125 E.g.:
126 (setq gnus-check-new-newsgroups
129 If this variable is nil, then you have to tell Gnus explicitly to
141 "Non-nil means that Gnus will check and remove bogus newsgroup at startup.
142 If this variable is nil, then you have to tell Gnus explicitly to
148 "Non-nil means that Gnus will read the entire active file at startup.
149 If this variable is nil, Gnus will only know about the groups in your
150 `.newsrc' file.
152 If this variable is `some', Gnus will try to only read the relevant
153 parts of the active file from the server. Not all servers support
154 this, and it might be quite slow with other servers, but this should
155 generally be faster than both the t and nil value.
157 If you set this variable to nil or `some', you probably still want to
158 be told about new newsgroups that arrive. To do that, set
159 `gnus-check-new-newsgroups' to `ask-server'. This may not work
160 properly with all servers."
170 "Groups with levels less than or equal to this variable are unsubscribed.
172 Groups with levels less than `gnus-level-subscribed', which
173 should be less than this variable, are subscribed. Groups with
174 levels from `gnus-level-subscribed' (exclusive) upto this
175 variable (inclusive) are unsubscribed. See also
176 `gnus-level-zombie', `gnus-level-killed' and the Info node `(gnus)Group
186 "New subscribed groups will be subscribed at this level."
191 "New unsubscribed groups will be unsubscribed at this level."
196 "Groups higher than this level won't be activated on startup.
197 Setting this variable to something low might save lots of time when
198 you have many groups that you aren't interested in."
203 "If nil, Gnus will not check foreign newsgroups at startup.
204 If it is non-nil, it should be a number between one and nine. Foreign
205 newsgroups that have a level lower or equal to this number will be
206 activated on startup. For instance, if you want to active all
207 subscribed newsgroups, but not the rest, you'd set this variable to
208 `gnus-level-subscribed'.
210 If you subscribe to lots of newsgroups from different servers, startup
211 might take a while. By setting this variable to nil, you'll save time,
212 but you won't be told how many unread articles there are in the
213 groups."
219 "Non-nil means that Gnus will read the `.newsrc' file.
220 Gnus always reads its own startup file, which is called
222 be readily understood by other newsreaders. If you don't plan on
223 using other newsreaders, set this variable to nil to save some time on
224 entry."
230 "Non-nil means that Gnus will save the `.newsrc' file.
231 Gnus always saves its own startup file, which is called
233 be readily understood by other newsreaders. If you don't plan on
234 using other newsreaders, set this variable to nil to save some time on
235 exit."
240 "If non-nil, save the list of killed groups to the startup file.
241 If you set this variable to nil, you'll save both time (when starting
242 and quitting) and space (both memory and disk), but it will also mean
243 that Gnus has no record of which groups are new and which are old, so
244 the automatic new newsgroups subscription methods become meaningless.
246 You should always set `gnus-check-new-newsgroups' to `ask-server' or
247 nil if you set this variable to nil.
249 This variable can also be a regexp. In that case, all groups that do
250 not match this regexp will be removed before saving the list."
257 regexp))
264 )
266 "A regexp to match uninteresting newsgroups in the active file.
267 Any lines in the active file matching this regular expression are
268 removed from the newsgroup list before anything else is done to it,
269 thus making them effectively non-existent."
274 "Function(s) called with a group name when new group is detected.
275 A few pre-made functions are supplied: `gnus-subscribe-randomly'
276 inserts new groups at the beginning of the list of groups;
277 `gnus-subscribe-alphabetically' inserts new groups in strict
278 alphabetic order; `gnus-subscribe-hierarchically' inserts new groups
279 in hierarchical newsgroup order; `gnus-subscribe-interactively' asks
280 for your decision; `gnus-subscribe-killed' kills all new groups;
281 `gnus-subscribe-zombies' will make all new groups into zombies;
282 `gnus-subscribe-topics' will enter groups into the topics that
283 claim them."
292 function
298 "Hooks run after you subscribe to a new group.
299 The hooks will be called with new group's name as argument."
305 'gnus-subscribe-alphabetically
307 If, for instance, you want to subscribe to all newsgroups in the
309 .newsrc file:
311 options -n no.all alt.all
313 Gnus will then subscribe all new newsgroups in these hierarchies
314 with the subscription method in this variable."
323 function
327 "If non-nil, Gnus will offer to subscribe hierarchically.
328 When a new hierarchy appears, Gnus will ask the user:
330 'alt.binaries': Do you want to subscribe to this hierarchy? ([d]ys):
332 If the user pressed `d', Gnus will descend the hierarchy, `y' will
333 subscribe to all newsgroups in the hierarchy and `s' will skip this
334 hierarchy in its entirety."
339 "New groups from methods of these categories will be subscribed automatically.
340 Note that this variable only deals with new groups. It has no
341 effect whatsoever on old groups. The default is to automatically
342 subscribe all groups from mail-like backends."
349 "All new groups that match this regexp will be subscribed automatically.
350 Note that this variable only deals with new groups. It has no effect
351 whatsoever on old groups.
353 New groups that match this regexp will not be handled by
354 `gnus-subscribe-newsgroup-method'. Instead, they will
355 be subscribed using `gnus-subscribe-options-newsgroup-method'."
360 "All new groups matching this regexp will be subscribed unconditionally.
361 Note that this variable deals only with new newsgroups. This variable
362 does not affect old newsgroups.
364 New groups that match this regexp will not be handled by
365 `gnus-subscribe-newsgroup-method'. Instead, they will
366 be subscribed using `gnus-subscribe-options-newsgroup-method'."
372 "All new groups matching this regexp will be ignored.
373 Note that this variable deals only with new newsgroups. This variable
374 does not affect old (already subscribed) newsgroups."
380 "Non-nil means .newsrc should be deleted prior to save.
381 Its use is due to the bogus appearance that .newsrc was modified on
382 disc."
387 "A hook run after removing bogus groups."
392 "A hook called at startup.
393 This hook is called after Gnus is connected to the NNTP server."
398 "A hook called before startup.
399 This hook is called as the first thing when Gnus is started.
400 See also `gnus-before-resume-hook'."
405 "A hook called before resuming Gnus after suspend.
406 This hook is called as the first thing when Gnus is resumed after a suspend.
407 See also `gnus-before-startup-hook'."
413 "A hook called as the last thing after startup."
418 "A hook after reading the .newsrc file, but before generating the buffer."
423 "A hook run just before Gnus checks for new news globally."
429 "A hook run just before Gnus checks for new news."
435 "A hook run after Gnus checks for new news when Gnus is already running."
441 "A hook called after reading the newsrc.eld? file."
446 "A hook called before saving any of the newsrc files."
451 "A hook called just before saving the quick newsrc file.
452 Can be used to turn version control on or off."
457 "A hook called just before saving the standard newsrc file.
458 Can be used to turn version control on or off."
463 "Hook for Gnus group mode."
469 "Unconditionally read the dribble file."
473 ;;; Internal variables
475 ;; Fixme: deal with old emacs-mule when mm-universal-coding-system is
476 ;; utf-8-emacs.
495 ;; Byte-compiler warning.
498 ;; Suggested by Brian Edmonds <edmonds@cs.ubc.ca>.
501 ;; Don't load .gnus if the -q option was used.
516 ;; For subscribing new newsgroup
520 prefixes prefix start ans group starts real-group)
530 start)
592 "Subscribe new NEWSGROUP by making it the first newsgroup."
596 "Subscribe new NEWGROUP and insert it in alphabetical order."
598 before)
606 "Subscribe new NEWGROUP and insert it in hierarchical newsgroup order."
607 ;; Basic ideas by mike-w@cs.aukuni.ac.nz (Mike Williams)
619 ;; Remove tail of newsgroup name (eg. a.b.c -> a.b)
627 "Subscribe the new GROUP interactively.
628 It is inserted in hierarchical newsgroup order if subscribed. If not,
629 it is killed."
635 "Make the new GROUP into a zombie group."
639 "Make the new GROUP a killed group."
643 "Subscribe new NEWSGROUP.
644 If NEXT is non-nil, it is inserted before NEXT. Otherwise it is made
645 the first newsgroup."
648 ;; We subscribe the group by changing its level to `subscribed'.
650 newsgroup gnus-level-default-subscribed
655 t))
658 "Say whether the active file has been read from `gnus-select-method'."
661 ;;; General various misc type functions.
663 ;; Silence byte-compiler.
680 "Close all servers."
686 "Clear all variables and buffers."
687 ;; Clear Gnus variables.
692 ;; Clear other internal variables.
694 gnus-have-read-active-file nil
695 gnus-agent-covered-methods nil
696 gnus-agent-file-loading-local nil
697 gnus-agent-file-loading-cache nil
698 gnus-server-method-cache nil
699 gnus-newsrc-alist nil
700 gnus-newsrc-hashtb nil
701 gnus-killed-list nil
702 gnus-zombie-list nil
703 gnus-killed-hashtb nil
704 gnus-active-hashtb nil
705 gnus-moderated-hashtb nil
706 gnus-description-hashtb nil
707 gnus-current-headers nil
708 gnus-thread-indent-array nil
709 gnus-newsgroup-headers nil
710 gnus-newsgroup-name nil
711 gnus-server-alist nil
712 gnus-group-list-mode nil
713 gnus-opened-servers nil
714 gnus-group-mark-positions nil
715 gnus-newsgroup-data nil
716 gnus-newsgroup-unreads nil
717 nnoo-state-alist nil
718 gnus-current-select-method nil
719 nnmail-split-history nil
720 gnus-extended-servers nil
721 gnus-ephemeral-servers nil)
723 ;; Kill the startup file.
727 ;; Clear the dribble buffer.
729 ;; Kill global KILL file buffer.
733 ;; Kill Gnus buffers.
742 ;; Remove Gnus frames.
746 "Read network news.
747 If ARG is a positive number, Gnus will use that as the startup
748 level. If ARG is nil, Gnus will be started at level 2
749 \(`gnus-level-default-subscribed' minus one). If ARG is non-nil
750 and not a positive number, Gnus will prompt the user for the name
752 will not connect to the local server."
760 "Read network news.
761 If ARG is non-nil and a positive number, Gnus will use that as the
762 startup level. If ARG is non-nil and not a positive number, Gnus will
763 prompt the user for the name of an NNTP server to use."
782 ;; Add "native" to gnus-predefined-server-alist just to have a
783 ;; name for the native select method.
792 did-connect)
800 ;; Couldn't connect to the server, so bail out.
803 ;; Find the current startup file name.
807 ;; Read the dribble file.
811 ;; Do the actual startup.
817 ;; Generate the group buffer.
825 "Make sure the draft group exists."
837 \f
838 ;;;
839 ;;; Dribble file
840 ;;;
846 "Return the dribble file for the current .newsrc."
851 gnus-current-startup-file)
855 "Enter STRING into the dribble buffer.
856 If REGEXP is given, lines that match it will be deleted."
858 gnus-dribble-buffer
871 ;; Make sure that each dribble entry is a single line, so that
872 ;; the "remove" code above works.
880 "Touch the dribble buffer."
884 "Read the dribble file from disk."
895 ;; The buffer may be shrunk a lot when deleting old entries.
896 ;; It caused the auto-saving to stop.
905 modes)
907 ;; Load whichever file is newest -- the auto save file
908 ;; or the "real" file.
914 ;; Set the file modes to reflect the .newsrc file modes.
923 ;; Possibly eval the file later.
927 "Gnus exited on purpose without saving; read auto-save file anyway? "
964 \f
965 ;;;
966 ;;; Active & Newsrc File Handling
967 ;;;
970 "Setup news information.
971 If RAWFILE is non-nil, the .newsrc file will also be read.
972 If LEVEL is non-nil, the news will be set up at level LEVEL."
975 ;; Binding this variable will inhibit multiple fetchings
976 ;; of the same mail source.
980 ;; Clear some variables to re-initialize news information.
982 gnus-active-hashtb nil)
983 ;; Read the newsrc file and create `gnus-newsrc-hashtb'.
986 ;; Make sure the archive server is available to all and sundry.
989 gnus-message-archive-method))
990 gnus-message-archive-method)))
991 ;; Check whether the archive method is writable.
995 gnus-valid-select-methods)))
999 ,method
1012 gnus-server-alist))))
1016 ;; If we don't read the complete active file, we fill in the
1017 ;; hashtb here.
1023 ;; Initialize the cache.
1027 ;; Possibly eval the dribble file.
1032 ;; Slave Gnusii should then clear the dribble buffer.
1038 ;; See whether we need to read the description file.
1045 gnus-read-active-file)
1048 ;; Find new newsgroups and treat them.
1052 gnus-plugged)
1055 ;; Check and remove bogus newsgroups.
1061 ;; Read any slave files.
1064 ;; Find the number of unread articles in each non-dead group.
1069 "Call METHOD to subscribe GROUP.
1070 If no function returns `non-nil', call `gnus-subscribe-zombies'."
1079 nil))
1084 "Search for new newsgroups and add them.
1085 Each new newsgroup will be treated with `gnus-subscribe-newsgroup-method'.
1086 The `-n' option line from .newsrc is respected.
1088 With 1 C-u, use the `ask-server' method to query the server for new
1089 groups.
1090 With 2 C-u's, use most complete method possible to query the server
1091 for new groups, and subscribe the new groups as zombies."
1094 gnus-subscribe-newsgroup-method)
1104 t)
1108 ;; Ask the server for new groups.
1110 ;; Go through the active hashtb and look for new groups.
1112 group new-newsgroups)
1119 ;; Go though every newsgroup in `gnus-active-hashtb' and compare
1120 ;; with `gnus-newsrc-hashtb' and `gnus-killed-hashtb'.
1128 ()
1135 gnus-subscribe-options-newsgroup-method group))
1137 nil)
1144 gnus-subscribe-newsgroup-method group)))))))
1145 gnus-active-hashtb)
1152 groups))))
1155 ;; Returns `subscribe' if the group is to be unconditionally
1156 ;; subscribed, `ignore' if it is to be ignored, and nil if there is
1157 ;; no match for the group.
1159 ;; First we check the two user variables.
1168 do-subscribe)
1176 ;; Then we go through the list that was retrieved from the .newsrc
1177 ;; file. This list has elements on the form
1178 ;; `(REGEXP . {ignore,subscribe})'. The first match found (the list
1179 ;; is in the reverse order of the options line) is returned.
1196 gnus-check-new-newsgroups)
1197 gnus-secondary-select-methods))))
1199 group new-newsgroups got-new method hashtb
1200 gnus-override-subscribe-method)
1203 ;; Go through both primary and secondary select methods and
1204 ;; request new newsgroups.
1207 gnus-override-subscribe-method method)
1214 ;; Enter all the new groups into a hashtable.
1216 ;; Now all new groups from `method' are in `hashtb'.
1225 ;; The group is already known.
1226 ()
1227 ;; Make this group active.
1230 ;; Check whether we want it or not.
1237 gnus-subscribe-options-newsgroup-method group))
1239 nil)
1246 gnus-subscribe-newsgroup-method group)))))))
1247 hashtb))
1256 new-newsgroups))
1259 "Subscribe GROUP and put it after PREVIOUS."
1263 group)
1264 gnus-level-default-subscribed gnus-level-killed previous t)
1265 t)
1267 ;; `gnus-group-change-level' is the fundamental function for changing
1268 ;; subscription levels of newsgroups. This might mean just changing
1269 ;; from level 1 to 2, which is pretty trivial, from 2 to 6 or back
1270 ;; again, which subscribes/unsubscribes a group, which is equally
1271 ;; trivial. Changing from 1-7 to 8-9 means that you kill a group, and
1272 ;; from 8-9 to 1-7 means that you remove the group from the list of
1273 ;; killed (or zombie) groups and add them to the (kinda) subscribed
1274 ;; groups. And last but not least, moving from 8 to 9 and 9 to 8,
1275 ;; which is trivial.
1276 ;; ENTRY can either be a string (newsgroup name) or a list (if
1277 ;; FROMKILLED is t, it's a list on the format (NUM INFO-LIST),
1278 ;; otherwise it's a list in the format of the `gnus-newsrc-hashtb'
1279 ;; entries.
1280 ;; LEVEL is the new level of the group, OLDLEVEL is the old level and
1281 ;; PREVIOUS is the group (in hashtb entry format) to insert this group
1282 ;; after.
1284 previous fromkilled)
1286 ;; Glean what info we can from the arguments
1292 oldlevel
1304 ;; We are trying to subscribe a group that is already
1305 ;; subscribed.
1313 ;; Then we remove the newgroup from any old structures, if needed.
1314 ;; If the group was killed, we remove it from the killed or zombie
1315 ;; list. If not, and it is in fact going to be killed, we remove
1316 ;; it from the newsrc hash table and assoc.
1319 ;; oldlevel could be wrong.
1324 entry)
1331 ;; Finally we enter (if needed) the list where it is supposed to
1332 ;; go, and change the subscription level. If it is to be killed,
1333 ;; we enter it into the killed or zombie list.
1336 ;; Remove from the hash table.
1341 ;; Remove from active hashtb.
1343 ;; Don't add it into killed-list if it was killed.
1346 ;; If the list is to be entered into the newsrc assoc, and
1347 ;; it was killed, we have to create an entry in the newsrc
1348 ;; hashtb format and fix the pointers in the newsrc assoc.
1350 ;; It was alive, and it is going to stay alive, so we
1351 ;; just change the level and don't change any pointers or
1352 ;; hash table entries.
1360 ;; Shorten the select method if possible, if we need to
1361 ;; store it at all (native groups).
1373 p)))
1379 gnus-newsrc-hashtb))
1382 gnus-newsrc-hashtb))
1390 group level oldlevel previous)))))
1393 "Remove bogus newsgroups.
1394 If CONFIRM is non-nil, the user has to confirm the deletion of every
1395 newsgroup."
1397 bogus group entry info)
1402 ;; Find all bogus newsgroup that are subscribed.
1410 ;; Found a bogus newsgroup.
1416 ;; Remove all bogus subscribed groups by first killing them, and
1417 ;; then removing them from the list of killed groups.
1423 ;; Remove all bogus subscribed groups by first killing them, and
1424 ;; then removing them from the list of killed groups.
1428 ;; Then we remove all bogus groups from the list of killed and
1429 ;; zombie groups. They are removed without confirmation.
1431 killed)
1436 ;; The group is bogus.
1437 ;; !!!Slow as hell.
1445 "Remove duplicates from the list of killed groups."
1453 ;; We want to inline a function from gnus-cache, so we cheat here:
1457 "Alter the ACTIVE info for GROUP to reflect the articles in the cache."
1467 dont-sub-check)
1468 "Check whether a group has been activated or not.
1469 If SCAN, request a scan of that group as well. If METHOD, use
1470 that select method instead of determining the method based on the
1471 group name. If DONT-CHECK, don't check whether the group
1472 actually exists. If DONT-SUB-CHECK or DONT-CHECK, don't let the
1473 backend check whether the group actually exists."
1475 active)
1477 ;; We escape all bugs and quit here to make it possible to
1478 ;; continue if a group is so out-there that it reports bugs
1479 ;; and stuff.
1484 t)
1487 method
1491 method
1497 nil)))
1500 ;; If there are no articles in the group, the GROUP
1501 ;; command may have responded with the `(0 . 0)'. We
1502 ;; ignore this if we already have an active entry
1503 ;; for the group.
1509 ;; If a cache is present, we may have to alter the active info.
1512 group active)))
1514 ;; If the agent is enabled, we may have to alter the active info.
1519 ;; Return the new active info.
1520 active)))))
1524 ;; Allow the backend to update the info in the group.
1534 ;; These checks are present in gnus-activate-group but skipped
1535 ;; due to setting dont-check in the preceding call.
1537 ;; If a cache is present, we may have to alter the active info.
1542 ;; If the agent is enabled, we may have to alter the active info.
1546 ;; Modify the list of read articles according to what articles
1547 ;; are available; then tally the unread articles and add the
1548 ;; number to the group hash table entry.
1555 ;; Fix a single (num . num) range according to the
1556 ;; active hash table.
1557 ;; Fix by Carsten Bormann <cabo@Informatik.Uni-Bremen.DE>.
1560 ;; Compute number of unread articles.
1563 ;; The read list is a list of ranges. Fix them according to
1564 ;; the active hash table.
1565 ;; First peel off any elements that are below the lower
1566 ;; active limit.
1581 ;; Adjust the first element to be the same as the lower limit.
1585 ;; Then we want to peel off any elements that are higher
1586 ;; than the upper active limit.
1588 ;; Go past all valid elements.
1596 ;; Nuke all remaining invalid elements.
1599 ;; Adjust the final element.
1603 ;; Compute the number of unread articles.
1611 ;; Set the number of unread articles.
1615 num)))
1617 ;; Go though `gnus-newsrc-alist' and compare with `gnus-active-hashtb'
1618 ;; and compute how many unread articles there are in each group.
1626 level
1632 gnus-activate-foreign-newsgroups)
1634 alevel)))
1639 infos info group active method cmethod
1640 method-type method-group-list entry)
1646 ;; First go through all the groups, see what select methods they
1647 ;; belong to, and then collect them into lists per unique select
1648 ;; method.
1651 ;; There may be several similar methods. Possibly extend the
1652 ;; method.
1674 type-cache))
1675 ;; Only add groups that need updating.
1679 foreign-level
1680 alevel)))
1683 ;; The group is inactive, so we nix out the number of unread articles.
1684 ;; It leads `(gnus-group-unread group)' to return t. See also
1685 ;; `gnus-group-prepare-flat'.
1690 ;; Sort the methods based so that the primary and secondary
1691 ;; methods come first. This is done for legacy reasons to try to
1692 ;; ensure that side-effect behavior doesn't change from previous
1693 ;; Gnus versions.
1699 ;; Go through the list of servers and possibly extend methods that
1700 ;; aren't equal (and that need extension; i.e., they are async).
1710 method))
1714 ;; If we have primary/secondary select methods, but no groups from
1715 ;; them, we still want to issue a retrieval request from them.
1718 gnus-secondary-select-methods))
1724 ;; Clear out all the early methods.
1728 infos
1736 ;; Just mark this server as "cleared".
1739 ;; Start early async retrieval of data.
1741 sanity-spec)
1747 ;; If the open-server method doesn't exist, then the method
1748 ;; itself doesn't exist, so we ignore it.
1754 ;; This is a sanity check, so that we never
1755 ;; attempt to start two async requests to the
1756 ;; same server, because that will fail. This
1757 ;; should never happen, since the methods should
1758 ;; be unique at this point, but apparently it
1759 ;; does happen in the wild with some setups.
1767 ;; Store the token we get back from -early so that we
1768 ;; can pass it to -finish later.
1772 ;; Do the rest of the retrieval.
1779 ;; See if any of the groups from this method require updating.
1784 updatep)))))))
1789 ;; Get info for virtual groups last.
1794 ;; Compute the rank of the secondary methods based on where they
1795 ;; are in the secondary select list.
1803 i)))
1804 ;; Just say that all foreign groups have the same rank.
1811 ;; Finish up getting the data from the methods that have -early
1812 ;; methods.
1814 early-data
1819 ;; We may have altered the data now, so mark the dribble buffer
1820 ;; as dirty so that it gets saved.
1823 ;; Most backends have -retrieve-groups.
1831 method)))
1832 ;; Virtually all backends have -request-list.
1835 ;; Except nnvirtual and friends, where we request each group, one
1836 ;; by one.
1841 ;; Create a hash table out of the newsrc alist. The `car's of the
1842 ;; alist elements are used as keys.
1846 prev info method rest methods)
1852 gnus-newsrc-alist
1856 ;; Make the same select-methods identical Lisp objects.
1861 ;; Check for duplicates.
1863 ;; Remove this entry from the alist.
1867 ;; Preserve number of unread articles in groups.
1869 prev)
1870 gnus-newsrc-hashtb)
1873 ;; Make the same select-methods in `gnus-server-alist' identical
1874 ;; as well.
1881 "Create a hash table from the killed and zombie lists."
1883 list)
1893 "Parse active info in the nntp server buffer."
1896 ;; Parse the result we got from `gnus-request-group'.
1903 "Mark ARTICLES in GROUP as unread."
1908 news article)
1914 ;; Enter this list into the group info.
1918 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1921 ;; Insert the change into the group buffer and the dribble file.
1925 "Mark ascending ARTICLES in GROUP as unread."
1931 modified)
1938 ;; the articles extend past the end of the ranges
1939 ;; OK - I'm done
1942 ;; this range precedes the article. Leave the range unmodified.
1944 ranges)
1946 ;; this range exactly matches the article; REMOVE THE RANGE.
1947 ;; NOTE: When the range being removed is the last range, the list is corrupted by inserting null at its end.
1951 nil))
1954 ;; I have a min/max range to consider
1959 ranges)
1961 ;; replace min/max range with a single-value range
1963 ranges)
1965 ;; this range precedes the article. Leave the range unmodified.
1967 ranges)
1969 ;; this article precedes the range. Return null to move to the
1970 ;; next article
1971 nil)
1973 ;; this article splits the range into two parts
1977 ranges))))))))
1982 ;; Enter this list into the group info.
1985 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1988 ;; Insert the change into the group buffer and the dribble file.
1991 ;; Enter all dead groups into the hashtb.
1995 killed)
2004 "Go through the active hashtb and mark all unknown groups as killed."
2005 ;; First make sure active file has been read.
2011 ;; Go through all newsgroups that are known to Gnus - enlarge kill list.
2019 ()
2022 ()
2026 gnus-active-hashtb)
2029 ;; Get the active file(s) from the backend(s).
2038 ;; The native server is available.
2040 ;; The native server is down, so we just do the
2041 ;; secondary ones.
2042 gnus-secondary-select-methods)
2043 ;; Also read from the archive server.
2046 method)
2050 ;; Only do each method once, in case the methods appear more
2051 ;; than once in this list.
2053 ;; Check whether the backend exists.
2059 ;; We catch C-g so that we can continue past servers
2060 ;; that do not respond.
2065 nil))))))))
2076 ;; Request that the backend scan its incoming messages.
2088 groups info)
2095 gmethod))
2097 groups)))
2100 t)
2108 ;; We mark this active file as read.
2113 "Read an active file for GROUPS in METHOD using `gnus-retrieve-groups'."
2127 ;; Read an active file and place the results in `gnus-active-hashtb'.
2129 real-active)
2136 gnus-active-hashtb
2142 group max min)
2143 ;; Delete unnecessary lines.
2153 ;; Make the group names readable as a lisp expression even if they
2154 ;; contain special characters.
2159 ;; Let the Gnus agent save the active file.
2163 ;; If these are groups from a foreign select method, we insert the
2164 ;; group prefix in front of the group names.
2176 ;; Store the active file in a hash table.
2177 ;; Use a unibyte buffer in order to make `read' read non-ASCII
2178 ;; group names (which have been encoded) as unibyte strings.
2187 ;; group gets set to a symbol interned in the hash table
2188 ;; (what a hack!!) - jwz
2190 ;; ### The extended group name scheme makes
2191 ;; the previous optimization strategy sort of pointless...
2204 ;; if group is moderated, stick in moderation table
2209 gnus-moderated-hashtb)))
2223 ;; Parse a "groups" active file.
2227 gnus-active-hashtb
2237 ;; Let the Gnus agent save the active file.
2239 real-active
2247 ;; We split this into to separate loops, one with the prefix
2248 ;; and one without to speed the reading up somewhat.
2278 "Read startup file.
2279 If FORCE is non-nil, the .newsrc file is read."
2280 ;; Reset variables that might be defined in the .newsrc.eld file.
2288 ;; We always load the .newsrc.eld file. If always contains
2289 ;; much information that can not be gotten from the .newsrc
2290 ;; file (ticked articles, killed groups, foreign methods, etc.)
2300 ;; We read the .newsrc file. Note that if there if a
2301 ;; .newsrc.eld file exists, it has already been read, and
2302 ;; the `gnus-newsrc-hashtb' has been created. While reading
2303 ;; the .newsrc file, Gnus will only use the information it
2304 ;; can find there for changing the data already read -
2305 ;; i. e., reading the .newsrc file will not trash the data
2306 ;; already read (except for read articles).
2315 ;; Convert old to new.
2320 ;; Currently no cleanups.
2321 )
2324 "Convert old newsrc formats into the current format, if needed."
2329 ;; A newsrc file was loaded.
2335 date-func))
2336 ;; This is a list of converters that must be run
2337 ;; to bring the newsrc file up to the current
2338 ;; version. If you create an incompatibility
2339 ;; with older versions, you should create an
2340 ;; entry here. The entry should consist of the
2341 ;; current gnus version (hardcoded so that it
2342 ;; doesn't change with each release) and the
2343 ;; function that must be applied to convert the
2344 ;; previous version into the current version.
2346 gnus-convert-old-ticks)
2348 gnus-agent-convert-to-compressed-agentview)
2350 gnus-agent-unlist-expire-days)
2352 gnus-agent-unhook-expire-days)))
2354 ;; Skip converters older than the file version
2358 ;; Perform converters to bring older version up to date.
2375 gnus-newsrc-file-version gnus-version)
2382 nil)
2387 t)
2391 t)))))
2396 gnus-newsrc-file-version gnus-version)))))))
2399 "Indicate whether CONVERTER requires gnus-convert-old-newsrc to
2400 display the conversion prompt. NO-PROMPT may be nil (prompt),
2401 t (no prompt), or any form that can be called as a function.
2402 The form should return either t or nil."
2408 no-prompt
2413 marks info dormant ticked)
2420 info
2427 "Load FILE, but in such a way that read errors can be reported."
2445 ;; We always, always read the .eld file.
2449 ;; Older versions of `gnus-format-specs' are no longer valid
2450 ;; in Oort Gnus 0.01.
2460 ;; Protect against broken .newsrc.el files.
2465 ;; Old format quick file
2467 ;; The .el file is newer than the .eld file, so we read that one
2468 ;; as well.
2472 ;; Parse the old-style quick startup file
2477 gnus-marked-assoc gnus-newsrc-alist gnus-newsrc-assoc)
2482 killed gnus-killed-assoc
2483 marked gnus-marked-assoc)))
2491 gnus-level-default-unsubscribed))
2496 gnus-level-default-unsubscribed)
2498 gnus-newsrc-alist))
2499 ;; Copy marks into info.
2511 ;; The .el file version of this variable does not begin with
2512 ;; "options", while the .eld version does, so we just add it if it
2513 ;; isn't there.
2515 gnus-newsrc-options
2520 ;; Finally, if we read some options lines, we parse them.
2528 "Make server dependent file name by catenating FILE and server host name."
2534 real-file
2535 file)))
2545 group subscribed options-symbol newsrc Options-symbol
2546 symbol reads num1)
2548 ;; We intern the symbol `options' in the active hashtb so that we
2549 ;; can `eq' against it later.
2554 ;; We first read the first word on the line by narrowing and
2555 ;; then reading into `gnus-active-hashtb'. Most groups will
2556 ;; already exist in that hashtb, so this will save some string
2557 ;; space.
2566 ;; Now, the symbol we have read is either `options' or a group
2567 ;; name. If it is an options line, we just add it to a string.
2572 ;; This concatting is quite inefficient, but since our
2573 ;; thorough studies show that approx 99.37% of all
2574 ;; .newsrc files only contain a single options line, we
2575 ;; don't give a damn, frankly, my dear.
2579 ;; Options may continue on the next line.
2585 ;; Group names can be just numbers.
2590 ;; It was a group name.
2593 reads nil)
2595 ;; If the line ends here, this is clearly a buggy line, so
2596 ;; we put point a the beginning of line and let the cond
2597 ;; below do the error handling.
2599 ;; We skip to the beginning of the ranges.
2601 ;; We are now at the beginning of the list of read articles.
2602 ;; We read them range by range.
2606 ;; We narrow and read a number instead of buffer-substring/
2607 ;; string-to-number because it's faster. narrow/widen is
2608 ;; faster than save-restriction/narrow, and save-restriction
2609 ;; produces a garbage object.
2614 ;; If the next character is a dash, then this is a range.
2617 ;; We read the upper bound of the range.
2620 ;; This is a buggy line, by we pretend that
2621 ;; it's kinda OK. Perhaps the user should be
2622 ;; dinged?
2630 reads)
2632 ;; It was just a simple number, so we add it to the
2633 ;; list of ranges.
2635 ;; If the next char in ?\n, then we have reached the end
2636 ;; of the line and return nil.
2639 ;; End of line, so we end.
2640 nil)
2642 ;; Not numbers and not eol, so this might be a buggy
2643 ;; line...
2645 ;; If it was eob instead of ?\n, we allow it.
2646 ;; The line was buggy.
2651 nil))
2652 ;; Skip past ", ". Spaces are invalid in these ranges, but
2653 ;; we allow them, because it's a common mistake to put a
2654 ;; space after the comma.
2657 ;; We have already read .newsrc.eld, so we gently update the
2658 ;; data in the hash table with the information we have just
2659 ;; read.
2662 level)
2664 ;; There is an entry for this file in the alist.
2667 ;; We update the level very gently. In fact, we
2668 ;; only change it if there's been a status change
2669 ;; from subscribed to unsubscribed, or vice versa.
2674 gnus-level-default-unsubscribed
2679 ;; This is a new group.
2682 gnus-level-default-subscribed
2685 gnus-level-default-unsubscribed))
2693 ()
2694 ;; We now have two newsrc lists - `newsrc', which is what we
2695 ;; have read from .newsrc, and `gnus-newsrc-alist', which is
2696 ;; what we've read from .newsrc.eld. We have to merge these
2697 ;; lists. We do this by "attaching" any (foreign) groups in the
2698 ;; gnus-newsrc-alist to the (native) group that precedes them.
2701 entry mentry)
2713 ;; We make the newsrc hashtb.
2716 ;; Finally, if we read some options lines, we parse them.
2720 ;; Parse options lines to find "options -n !all rec.all" and stuff.
2721 ;; The return value will be a list on the form
2722 ;; ((regexp1 . ignore)
2723 ;; (regexp2 . subscribe)...)
2724 ;; When handling new newsgroups, groups that match a `ignore' regexp
2725 ;; will be ignored, and groups that match a `subscribe' regexp will be
2726 ;; subscribed. A line like
2727 ;; options -n !all rec.all
2728 ;; will lead to a list that looks like
2729 ;; (("^rec\\..+" . subscribe)
2730 ;; ("^.+" . ignore))
2731 ;; So all "rec.*" groups will be subscribed, while all the other
2732 ;; groups will be ignored. Note that "options -n !all rec.all" is very
2733 ;; different from "options -n rec.all !all".
2739 ;; First we treat all continuation lines.
2743 ;; Then we transform all "all"s into ".+"s.
2748 ;; We remove all other options than the "-n" ones.
2754 ;; We are only interested in "options -n" lines - we
2755 ;; ignore the other option lines.
2762 ;; Search for all "words"...
2765 ;; If the word begins with a bang (!), this is a "not"
2766 ;; spec. We put this spec (minus the bang) and the
2767 ;; symbol `ignore' into the list.
2774 out)
2775 ;; There was no bang, so this is a "yes" spec.
2778 out))))
2785 'msdos-long-file-names
2790 "Save .newsrc file."
2791 ;; Note: We cannot save .newsrc file if all newsgroups are removed
2792 ;; from the variable gnus-newsrc-alist.
2794 gnus-current-startup-file)
2795 ;; Save agent range limits for the currently active method.
2810 ;; Save .newsrc only if the select method is an NNTP method.
2811 ;; The .newsrc file is for interoperability with other
2812 ;; newsreaders, so saving non-NNTP groups there doesn't make
2813 ;; much sense.
2821 ;; Save .newsrc.eld.
2832 ;; check timestamp of `gnus-current-startup-file'.eld against
2833 ;; `gnus-save-newsrc-file-last-timestamp'
2838 mtime))
2841 checkfile
2843 "%c"
2844 gnus-save-newsrc-file-last-timestamp)))
2859 working-file
2861 ;; Generate the name of a non-existent file.
2877 ;; These bindings will mislead the current buffer
2878 ;; into thinking that it is visiting the startup
2879 ;; file.
2884 ;; Backup the current version of the startup file.
2887 ;; Replace the existing startup file with the temp file.
2903 "Print Gnus variables such as `gnus-newsrc-alist' in Lisp format."
2905 gnus-ding-file-coding-system))
2912 ;; Never delete this file -- if you want to force Gnus to read the
2930 gnus-killed-list))
2934 ;; Remove the `gnus-killed-list' from the list of variables
2935 ;; to be saved, if required.
2937 ;; Peel off the "dummy" group.
2939 variable)
2940 ;; Insert the variables into the file.
2951 "Return the killed list minus the groups that match `gnus-save-killed-list'."
2953 olist)
2962 ;; Generate and save the .newsrc file.
2966 info ranges range method)
2971 ;; Use a unibyte buffer since group names are unibyte strings;
2972 ;; in particular, non-ASCII group names are the ones encoded by
2973 ;; a certain coding system.
2975 ;; Write options.
2978 ;; Write subscribed and unsubscribed.
2980 ;; Don't write foreign groups to .newsrc.
2984 foreign-ok)
3007 ;; It has been reported that sometime the modtime on the .newsrc
3008 ;; file seems to be off. We really do want to overwrite it, so
3009 ;; we clear the modtime here before saving. It's a bit odd,
3010 ;; though...
3011 ;; sometimes the modtime clear isn't sufficient. most brute force:
3012 ;; delete the silly thing entirely first. but this fails to provide
3013 ;; such niceties as .newsrc~ creation.
3022 \f
3023 ;;;
3024 ;;; Slave functions.
3025 ;;;
3030 "Minor mode for slave Gnusae."
3031 ;; FIXME: gnus-slave-mode appears to never be set (i.e. it'll always be nil):
3032 ;; Remove, or fix and use define-minor-mode.
3056 t))
3057 file)
3065 slave-files)
3076 t)
3079 nil))
3087 \f
3088 ;;;
3089 ;;; Group description.
3090 ;;;
3097 gnus-secondary-select-methods))))
3101 t))
3105 group)
3108 ;; We create the hashtable whether we manage to read the desc file
3109 ;; to avoid trying to re-read after a failed read.
3113 ;; Mark this method's desc file as read.
3115 gnus-description-hashtb)
3120 t)
3123 nil)
3126 nil)
3129 ;; FIXME: Shouldn't save-restriction be done after set-buffer?
3137 ;; If these are groups from a foreign select method, we insert the
3138 ;; group prefix in front of the group names.
3143 nil gnus-select-method))))
3151 ;; If we get an error, we set group to 0, which is not a
3152 ;; symbol...
3156 ;; Group is set to a symbol interned in this
3157 ;; hash table.
3161 ;; ... which leads to this line being effectively ignored.
3169 gnus-default-charset)))
3170 ;; Fixme: Don't decode in unibyte mode.
3176 t))))
3179 "Get the description of a group by sending XGTITLE to the server."
3186 ;;;###autoload
3188 "Declare back end NAME with ABILITIES as a Gnus back end."
3195 "Set the default directory in the current buffer to `gnus-default-directory'.
3196 If this variable is nil, don't do anything."
3201 default-directory)))
3209 ;; Check whether nnml and nnfolder share a directory.
3227 ;;; gnus-start.el ends here