| blob | aa2568d5559ad8f1cb981807fa7a6b92ec96ea50 |
1 ;;; gnus-start.el --- startup functions for Gnus
3 ;; Copyright (C) 1996-2015 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 "Check the modification time of the newsrc.eld file before saving it.
447 When the newsrc.eld file is updated by multiple machines,
448 checking the file's modification time is a good way to avoid
449 overwriting updated data."
455 "A hook called before saving any of the newsrc files."
460 "A hook called just before saving the quick newsrc file.
461 Can be used to turn version control on or off."
466 "A hook called just before saving the standard newsrc file.
467 Can be used to turn version control on or off."
472 "Hook for Gnus group mode."
478 "Unconditionally read the dribble file."
482 ;;; Internal variables
484 ;; Fixme: deal with old emacs-mule when mm-universal-coding-system is
485 ;; utf-8-emacs.
504 ;; Byte-compiler warning.
507 ;; Suggested by Brian Edmonds <edmonds@cs.ubc.ca>.
510 ;; Don't load .gnus if the -q option was used.
525 ;; For subscribing new newsgroup
529 prefixes prefix start ans group starts real-group)
539 start)
601 "Subscribe new NEWSGROUP by making it the first newsgroup."
605 "Subscribe new NEWGROUP and insert it in alphabetical order."
607 before)
615 "Subscribe new NEWGROUP and insert it in hierarchical newsgroup order."
616 ;; Basic ideas by mike-w@cs.aukuni.ac.nz (Mike Williams)
628 ;; Remove tail of newsgroup name (eg. a.b.c -> a.b)
636 "Subscribe the new GROUP interactively.
637 It is inserted in hierarchical newsgroup order if subscribed. If not,
638 it is killed."
644 "Make the new GROUP into a zombie group."
648 "Make the new GROUP a killed group."
652 "Subscribe new NEWSGROUP.
653 If NEXT is non-nil, it is inserted before NEXT. Otherwise it is made
654 the first newsgroup."
657 ;; We subscribe the group by changing its level to `subscribed'.
659 newsgroup gnus-level-default-subscribed
664 t))
667 "Say whether the active file has been read from `gnus-select-method'."
670 ;;; General various misc type functions.
672 ;; Silence byte-compiler.
689 "Close all servers."
695 "Clear all variables and buffers."
696 ;; Clear Gnus variables.
701 ;; Clear other internal variables.
703 gnus-have-read-active-file nil
704 gnus-agent-covered-methods nil
705 gnus-agent-file-loading-local nil
706 gnus-agent-file-loading-cache nil
707 gnus-server-method-cache nil
708 gnus-newsrc-alist nil
709 gnus-newsrc-hashtb nil
710 gnus-killed-list nil
711 gnus-zombie-list nil
712 gnus-killed-hashtb nil
713 gnus-active-hashtb nil
714 gnus-moderated-hashtb nil
715 gnus-description-hashtb nil
716 gnus-current-headers nil
717 gnus-thread-indent-array nil
718 gnus-newsgroup-headers nil
719 gnus-newsgroup-name nil
720 gnus-server-alist nil
721 gnus-group-list-mode nil
722 gnus-opened-servers nil
723 gnus-group-mark-positions nil
724 gnus-newsgroup-data nil
725 gnus-newsgroup-unreads nil
726 nnoo-state-alist nil
727 gnus-current-select-method nil
728 nnmail-split-history nil
729 gnus-extended-servers nil
730 gnus-ephemeral-servers nil)
732 ;; Kill the startup file.
736 ;; Clear the dribble buffer.
738 ;; Kill global KILL file buffer.
742 ;; Kill Gnus buffers.
745 ;; Remove Gnus frames.
749 "Read network news.
750 If ARG is a positive number, Gnus will use that as the startup
751 level. If ARG is nil, Gnus will be started at level 2
752 \(`gnus-level-default-subscribed' minus one). If ARG is non-nil
753 and not a positive number, Gnus will prompt the user for the name
755 will not connect to the local server."
763 "Read network news.
764 If ARG is non-nil and a positive number, Gnus will use that as the
765 startup level. If ARG is non-nil and not a positive number, Gnus will
766 prompt the user for the name of an NNTP server to use."
785 ;; Add "native" to gnus-predefined-server-alist just to have a
786 ;; name for the native select method.
795 did-connect)
803 ;; Couldn't connect to the server, so bail out.
806 ;; Find the current startup file name.
810 ;; Read the dribble file.
814 ;; Do the actual startup.
820 ;; Generate the group buffer.
828 "Make sure the draft group exists."
840 \f
841 ;;;
842 ;;; Dribble file
843 ;;;
849 "Return the dribble file for the current .newsrc."
854 gnus-current-startup-file)
858 "Enter STRING into the dribble buffer.
859 If REGEXP is given, lines that match it will be deleted."
861 gnus-dribble-buffer
875 ;; This has been commented by Josh Huber <huber@alum.wpi.edu>
876 ;; It causes problems with both XEmacs and Emacs 21, and doesn't
877 ;; seem to be of much value. (FIXME: remove this after we make sure
878 ;; it's not needed).
879 ;; (set-window-point (get-buffer-window (current-buffer)) (point-max))
886 "Touch the dribble buffer."
890 "Read the dribble file from disk."
901 ;; The buffer may be shrunk a lot when deleting old entries.
902 ;; It caused the auto-saving to stop.
913 modes)
915 ;; Load whichever file is newest -- the auto save file
916 ;; or the "real" file.
922 ;; Set the file modes to reflect the .newsrc file modes.
931 ;; Possibly eval the file later.
935 "Gnus exited on purpose without saving; read auto-save file anyway? "
972 \f
973 ;;;
974 ;;; Active & Newsrc File Handling
975 ;;;
978 "Setup news information.
979 If RAWFILE is non-nil, the .newsrc file will also be read.
980 If LEVEL is non-nil, the news will be set up at level LEVEL."
983 ;; Binding this variable will inhibit multiple fetchings
984 ;; of the same mail source.
988 ;; Clear some variables to re-initialize news information.
990 gnus-active-hashtb nil)
991 ;; Read the newsrc file and create `gnus-newsrc-hashtb'.
994 ;; Make sure the archive server is available to all and sundry.
997 gnus-message-archive-method))
998 gnus-message-archive-method)))
999 ;; Check whether the archive method is writable.
1003 gnus-valid-select-methods)))
1007 ,method
1020 gnus-server-alist))))
1024 ;; If we don't read the complete active file, we fill in the
1025 ;; hashtb here.
1031 ;; Initialize the cache.
1035 ;; Possibly eval the dribble file.
1040 ;; Slave Gnusii should then clear the dribble buffer.
1046 ;; See whether we need to read the description file.
1053 gnus-read-active-file)
1056 ;; Find new newsgroups and treat them.
1060 gnus-plugged)
1063 ;; Check and remove bogus newsgroups.
1069 ;; Read any slave files.
1072 ;; Find the number of unread articles in each non-dead group.
1077 "Call METHOD to subscribe GROUP.
1078 If no function returns `non-nil', call `gnus-subscribe-zombies'."
1087 nil))
1092 "Search for new newsgroups and add them.
1093 Each new newsgroup will be treated with `gnus-subscribe-newsgroup-method'.
1094 The `-n' option line from .newsrc is respected.
1096 With 1 C-u, use the `ask-server' method to query the server for new
1097 groups.
1098 With 2 C-u's, use most complete method possible to query the server
1099 for new groups, and subscribe the new groups as zombies."
1102 gnus-subscribe-newsgroup-method)
1112 t)
1116 ;; Ask the server for new groups.
1118 ;; Go through the active hashtb and look for new groups.
1120 group new-newsgroups)
1127 ;; Go though every newsgroup in `gnus-active-hashtb' and compare
1128 ;; with `gnus-newsrc-hashtb' and `gnus-killed-hashtb'.
1136 ()
1143 gnus-subscribe-options-newsgroup-method group))
1145 nil)
1152 gnus-subscribe-newsgroup-method group)))))))
1153 gnus-active-hashtb)
1160 groups))))
1163 ;; Returns `subscribe' if the group is to be unconditionally
1164 ;; subscribed, `ignore' if it is to be ignored, and nil if there is
1165 ;; no match for the group.
1167 ;; First we check the two user variables.
1176 do-subscribe)
1184 ;; Then we go through the list that was retrieved from the .newsrc
1185 ;; file. This list has elements on the form
1186 ;; `(REGEXP . {ignore,subscribe})'. The first match found (the list
1187 ;; is in the reverse order of the options line) is returned.
1204 gnus-check-new-newsgroups)
1205 gnus-secondary-select-methods))))
1207 group new-newsgroups got-new method hashtb
1208 gnus-override-subscribe-method)
1211 ;; Go through both primary and secondary select methods and
1212 ;; request new newsgroups.
1215 gnus-override-subscribe-method method)
1222 ;; Enter all the new groups into a hashtable.
1224 ;; Now all new groups from `method' are in `hashtb'.
1233 ;; The group is already known.
1234 ()
1235 ;; Make this group active.
1238 ;; Check whether we want it or not.
1245 gnus-subscribe-options-newsgroup-method group))
1247 nil)
1254 gnus-subscribe-newsgroup-method group)))))))
1255 hashtb))
1264 new-newsgroups))
1267 "Subscribe GROUP and put it after PREVIOUS."
1271 group)
1272 gnus-level-default-subscribed gnus-level-killed previous t)
1273 t)
1275 ;; `gnus-group-change-level' is the fundamental function for changing
1276 ;; subscription levels of newsgroups. This might mean just changing
1277 ;; from level 1 to 2, which is pretty trivial, from 2 to 6 or back
1278 ;; again, which subscribes/unsubscribes a group, which is equally
1279 ;; trivial. Changing from 1-7 to 8-9 means that you kill a group, and
1280 ;; from 8-9 to 1-7 means that you remove the group from the list of
1281 ;; killed (or zombie) groups and add them to the (kinda) subscribed
1282 ;; groups. And last but not least, moving from 8 to 9 and 9 to 8,
1283 ;; which is trivial.
1284 ;; ENTRY can either be a string (newsgroup name) or a list (if
1285 ;; FROMKILLED is t, it's a list on the format (NUM INFO-LIST),
1286 ;; otherwise it's a list in the format of the `gnus-newsrc-hashtb'
1287 ;; entries.
1288 ;; LEVEL is the new level of the group, OLDLEVEL is the old level and
1289 ;; PREVIOUS is the group (in hashtb entry format) to insert this group
1290 ;; after.
1292 previous fromkilled)
1294 ;; Glean what info we can from the arguments
1300 oldlevel
1312 ;; We are trying to subscribe a group that is already
1313 ;; subscribed.
1321 ;; Then we remove the newgroup from any old structures, if needed.
1322 ;; If the group was killed, we remove it from the killed or zombie
1323 ;; list. If not, and it is in fact going to be killed, we remove
1324 ;; it from the newsrc hash table and assoc.
1327 ;; oldlevel could be wrong.
1332 entry)
1339 ;; Finally we enter (if needed) the list where it is supposed to
1340 ;; go, and change the subscription level. If it is to be killed,
1341 ;; we enter it into the killed or zombie list.
1344 ;; Remove from the hash table.
1349 ;; Remove from active hashtb.
1351 ;; Don't add it into killed-list if it was killed.
1354 ;; If the list is to be entered into the newsrc assoc, and
1355 ;; it was killed, we have to create an entry in the newsrc
1356 ;; hashtb format and fix the pointers in the newsrc assoc.
1358 ;; It was alive, and it is going to stay alive, so we
1359 ;; just change the level and don't change any pointers or
1360 ;; hash table entries.
1368 ;; Shorten the select method if possible, if we need to
1369 ;; store it at all (native groups).
1381 p)))
1387 gnus-newsrc-hashtb))
1390 gnus-newsrc-hashtb))
1398 group level oldlevel previous)))))
1401 "Remove bogus newsgroups.
1402 If CONFIRM is non-nil, the user has to confirm the deletion of every
1403 newsgroup."
1405 bogus group entry info)
1410 ;; Find all bogus newsgroup that are subscribed.
1418 ;; Found a bogus newsgroup.
1424 ;; Remove all bogus subscribed groups by first killing them, and
1425 ;; then removing them from the list of killed groups.
1431 ;; Remove all bogus subscribed groups by first killing them, and
1432 ;; then removing them from the list of killed groups.
1436 ;; Then we remove all bogus groups from the list of killed and
1437 ;; zombie groups. They are removed without confirmation.
1439 killed)
1444 ;; The group is bogus.
1445 ;; !!!Slow as hell.
1453 "Remove duplicates from the list of killed groups."
1461 ;; We want to inline a function from gnus-cache, so we cheat here:
1465 "Alter the ACTIVE info for GROUP to reflect the articles in the cache."
1475 dont-sub-check)
1476 "Check whether a group has been activated or not.
1477 If SCAN, request a scan of that group as well. If METHOD, use
1478 that select method instead of determining the method based on the
1479 group name. If DONT-CHECK, don't check whether the group
1480 actually exists. If DONT-SUB-CHECK or DONT-CHECK, don't let the
1481 backend check whether the group actually exists."
1483 active)
1485 ;; We escape all bugs and quit here to make it possible to
1486 ;; continue if a group is so out-there that it reports bugs
1487 ;; and stuff.
1492 t)
1495 method
1499 method
1505 nil)))
1508 ;; If there are no articles in the group, the GROUP
1509 ;; command may have responded with the `(0 . 0)'. We
1510 ;; ignore this if we already have an active entry
1511 ;; for the group.
1517 ;; If a cache is present, we may have to alter the active info.
1520 group active)))
1522 ;; If the agent is enabled, we may have to alter the active info.
1527 ;; Return the new active info.
1528 active)))))
1532 ;; Allow the backend to update the info in the group.
1542 ;; These checks are present in gnus-activate-group but skipped
1543 ;; due to setting dont-check in the preceding call.
1545 ;; If a cache is present, we may have to alter the active info.
1550 ;; If the agent is enabled, we may have to alter the active info.
1554 ;; Modify the list of read articles according to what articles
1555 ;; are available; then tally the unread articles and add the
1556 ;; number to the group hash table entry.
1563 ;; Fix a single (num . num) range according to the
1564 ;; active hash table.
1565 ;; Fix by Carsten Bormann <cabo@Informatik.Uni-Bremen.DE>.
1568 ;; Compute number of unread articles.
1571 ;; The read list is a list of ranges. Fix them according to
1572 ;; the active hash table.
1573 ;; First peel off any elements that are below the lower
1574 ;; active limit.
1589 ;; Adjust the first element to be the same as the lower limit.
1593 ;; Then we want to peel off any elements that are higher
1594 ;; than the upper active limit.
1596 ;; Go past all valid elements.
1604 ;; Nuke all remaining invalid elements.
1607 ;; Adjust the final element.
1611 ;; Compute the number of unread articles.
1619 ;; Set the number of unread articles.
1623 num)))
1625 ;; Go though `gnus-newsrc-alist' and compare with `gnus-active-hashtb'
1626 ;; and compute how many unread articles there are in each group.
1634 level
1640 gnus-activate-foreign-newsgroups)
1642 alevel)))
1647 infos info group active method cmethod
1648 method-type method-group-list entry)
1654 ;; First go through all the groups, see what select methods they
1655 ;; belong to, and then collect them into lists per unique select
1656 ;; method.
1659 ;; There may be several similar methods. Possibly extend the
1660 ;; method.
1682 type-cache))
1683 ;; Only add groups that need updating.
1686 foreign-level
1687 alevel))
1690 ;; The group is inactive, so we nix out the number of unread articles.
1691 ;; It leads `(gnus-group-unread group)' to return t. See also
1692 ;; `gnus-group-prepare-flat'.
1697 ;; Sort the methods based so that the primary and secondary
1698 ;; methods come first. This is done for legacy reasons to try to
1699 ;; ensure that side-effect behavior doesn't change from previous
1700 ;; Gnus versions.
1706 ;; Go through the list of servers and possibly extend methods that
1707 ;; aren't equal (and that need extension; i.e., they are async).
1717 method))
1721 ;; If we have primary/secondary select methods, but no groups from
1722 ;; them, we still want to issue a retrieval request from them.
1725 gnus-secondary-select-methods))
1731 ;; Clear out all the early methods.
1735 infos
1743 ;; Just mark this server as "cleared".
1746 ;; Start early async retrieval of data.
1748 sanity-spec)
1754 ;; If the open-server method doesn't exist, then the method
1755 ;; itself doesn't exist, so we ignore it.
1761 ;; This is a sanity check, so that we never
1762 ;; attempt to start two async requests to the
1763 ;; same server, because that will fail. This
1764 ;; should never happen, since the methods should
1765 ;; be unique at this point, but apparently it
1766 ;; does happen in the wild with some setups.
1774 ;; Store the token we get back from -early so that we
1775 ;; can pass it to -finish later.
1779 ;; Do the rest of the retrieval.
1786 ;; See if any of the groups from this method require updating.
1791 updatep)))))))
1796 ;; Get info for virtual groups last.
1801 ;; Compute the rank of the secondary methods based on where they
1802 ;; are in the secondary select list.
1810 i)))
1811 ;; Just say that all foreign groups have the same rank.
1818 ;; Finish up getting the data from the methods that have -early
1819 ;; methods.
1821 early-data
1826 ;; We may have altered the data now, so mark the dribble buffer
1827 ;; as dirty so that it gets saved.
1830 ;; Most backends have -retrieve-groups.
1838 method)))
1839 ;; Virtually all backends have -request-list.
1842 ;; Except nnvirtual and friends, where we request each group, one
1843 ;; by one.
1848 ;; Create a hash table out of the newsrc alist. The `car's of the
1849 ;; alist elements are used as keys.
1853 prev info method rest methods)
1859 gnus-newsrc-alist
1863 ;; Make the same select-methods identical Lisp objects.
1868 ;; Check for duplicates.
1870 ;; Remove this entry from the alist.
1874 ;; Preserve number of unread articles in groups.
1876 prev)
1877 gnus-newsrc-hashtb)
1880 ;; Make the same select-methods in `gnus-server-alist' identical
1881 ;; as well.
1888 "Create a hash table from the killed and zombie lists."
1890 list)
1900 "Parse active info in the nntp server buffer."
1903 ;; Parse the result we got from `gnus-request-group'.
1910 "Mark ARTICLES in GROUP as unread."
1915 news article)
1921 ;; Enter this list into the group info.
1925 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1928 ;; Insert the change into the group buffer and the dribble file.
1932 "Mark ascending ARTICLES in GROUP as unread."
1938 modified)
1945 ;; the articles extend past the end of the ranges
1946 ;; OK - I'm done
1949 ;; this range precedes the article. Leave the range unmodified.
1951 ranges)
1953 ;; this range exactly matches the article; REMOVE THE RANGE.
1954 ;; NOTE: When the range being removed is the last range, the list is corrupted by inserting null at its end.
1958 nil))
1961 ;; I have a min/max range to consider
1966 ranges)
1968 ;; replace min/max range with a single-value range
1970 ranges)
1972 ;; this range precedes the article. Leave the range unmodified.
1974 ranges)
1976 ;; this article precedes the range. Return null to move to the
1977 ;; next article
1978 nil)
1980 ;; this article splits the range into two parts
1984 ranges))))))))
1989 ;; Enter this list into the group info.
1992 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1995 ;; Insert the change into the group buffer and the dribble file.
1998 ;; Enter all dead groups into the hashtb.
2002 killed)
2011 "Go through the active hashtb and mark all unknown groups as killed."
2012 ;; First make sure active file has been read.
2018 ;; Go through all newsgroups that are known to Gnus - enlarge kill list.
2026 ()
2029 ()
2033 gnus-active-hashtb)
2036 ;; Get the active file(s) from the backend(s).
2045 ;; The native server is available.
2047 ;; The native server is down, so we just do the
2048 ;; secondary ones.
2049 gnus-secondary-select-methods)
2050 ;; Also read from the archive server.
2053 method)
2057 ;; Only do each method once, in case the methods appear more
2058 ;; than once in this list.
2060 ;; Check whether the backend exists.
2066 ;; We catch C-g so that we can continue past servers
2067 ;; that do not respond.
2072 nil))))))))
2083 ;; Request that the backend scan its incoming messages.
2095 groups info)
2102 gmethod))
2104 groups)))
2107 t)
2115 ;; We mark this active file as read.
2120 "Read an active file for GROUPS in METHOD using `gnus-retrieve-groups'."
2134 ;; Read an active file and place the results in `gnus-active-hashtb'.
2136 real-active)
2143 gnus-active-hashtb
2149 group max min)
2150 ;; Delete unnecessary lines.
2160 ;; Make the group names readable as a lisp expression even if they
2161 ;; contain special characters.
2166 ;; Let the Gnus agent save the active file.
2170 ;; If these are groups from a foreign select method, we insert the
2171 ;; group prefix in front of the group names.
2183 ;; Store the active file in a hash table.
2184 ;; Use a unibyte buffer in order to make `read' read non-ASCII
2185 ;; group names (which have been encoded) as unibyte strings.
2194 ;; group gets set to a symbol interned in the hash table
2195 ;; (what a hack!!) - jwz
2197 ;; ### The extended group name scheme makes
2198 ;; the previous optimization strategy sort of pointless...
2211 ;; if group is moderated, stick in moderation table
2216 gnus-moderated-hashtb)))
2230 ;; Parse a "groups" active file.
2234 gnus-active-hashtb
2244 ;; Let the Gnus agent save the active file.
2246 real-active
2254 ;; We split this into to separate loops, one with the prefix
2255 ;; and one without to speed the reading up somewhat.
2285 "Read startup file.
2286 If FORCE is non-nil, the .newsrc file is read."
2287 ;; Reset variables that might be defined in the .newsrc.eld file.
2295 ;; We always load the .newsrc.eld file. If always contains
2296 ;; much information that can not be gotten from the .newsrc
2297 ;; file (ticked articles, killed groups, foreign methods, etc.)
2307 ;; We read the .newsrc file. Note that if there if a
2308 ;; .newsrc.eld file exists, it has already been read, and
2309 ;; the `gnus-newsrc-hashtb' has been created. While reading
2310 ;; the .newsrc file, Gnus will only use the information it
2311 ;; can find there for changing the data already read -
2312 ;; i. e., reading the .newsrc file will not trash the data
2313 ;; already read (except for read articles).
2322 ;; Convert old to new.
2327 ;; Currently no cleanups.
2328 )
2331 "Convert old newsrc formats into the current format, if needed."
2336 ;; A newsrc file was loaded.
2342 date-func))
2343 ;; This is a list of converters that must be run
2344 ;; to bring the newsrc file up to the current
2345 ;; version. If you create an incompatibility
2346 ;; with older versions, you should create an
2347 ;; entry here. The entry should consist of the
2348 ;; current gnus version (hardcoded so that it
2349 ;; doesn't change with each release) and the
2350 ;; function that must be applied to convert the
2351 ;; previous version into the current version.
2353 gnus-convert-old-ticks)
2355 gnus-agent-convert-to-compressed-agentview)
2357 gnus-agent-unlist-expire-days)
2359 gnus-agent-unhook-expire-days)))
2361 ;; Skip converters older than the file version
2365 ;; Perform converters to bring older version up to date.
2382 gnus-newsrc-file-version gnus-version)
2389 nil)
2394 t)
2398 t)))))
2403 gnus-newsrc-file-version gnus-version)))))))
2406 "Indicate whether CONVERTER requires gnus-convert-old-newsrc to
2407 display the conversion prompt. NO-PROMPT may be nil (prompt),
2408 t (no prompt), or any form that can be called as a function.
2409 The form should return either t or nil."
2415 no-prompt
2420 marks info dormant ticked)
2427 info
2434 "Load FILE, but in such a way that read errors can be reported."
2452 ;; We always, always read the .eld file.
2456 ;; Older versions of `gnus-format-specs' are no longer valid
2457 ;; in Oort Gnus 0.01.
2467 ;; Protect against broken .newsrc.el files.
2472 ;; Old format quick file
2474 ;; The .el file is newer than the .eld file, so we read that one
2475 ;; as well.
2479 ;; Parse the old-style quick startup file
2484 gnus-marked-assoc gnus-newsrc-alist gnus-newsrc-assoc)
2489 killed gnus-killed-assoc
2490 marked gnus-marked-assoc)))
2498 gnus-level-default-unsubscribed))
2503 gnus-level-default-unsubscribed)
2505 gnus-newsrc-alist))
2506 ;; Copy marks into info.
2518 ;; The .el file version of this variable does not begin with
2519 ;; "options", while the .eld version does, so we just add it if it
2520 ;; isn't there.
2522 gnus-newsrc-options
2527 ;; Finally, if we read some options lines, we parse them.
2535 "Make server dependent file name by catenating FILE and server host name."
2541 real-file
2542 file)))
2552 group subscribed options-symbol newsrc Options-symbol
2553 symbol reads num1)
2555 ;; We intern the symbol `options' in the active hashtb so that we
2556 ;; can `eq' against it later.
2561 ;; We first read the first word on the line by narrowing and
2562 ;; then reading into `gnus-active-hashtb'. Most groups will
2563 ;; already exist in that hashtb, so this will save some string
2564 ;; space.
2573 ;; Now, the symbol we have read is either `options' or a group
2574 ;; name. If it is an options line, we just add it to a string.
2579 ;; This concatting is quite inefficient, but since our
2580 ;; thorough studies show that approx 99.37% of all
2581 ;; .newsrc files only contain a single options line, we
2582 ;; don't give a damn, frankly, my dear.
2586 ;; Options may continue on the next line.
2592 ;; Group names can be just numbers.
2597 ;; It was a group name.
2600 reads nil)
2602 ;; If the line ends here, this is clearly a buggy line, so
2603 ;; we put point a the beginning of line and let the cond
2604 ;; below do the error handling.
2606 ;; We skip to the beginning of the ranges.
2608 ;; We are now at the beginning of the list of read articles.
2609 ;; We read them range by range.
2613 ;; We narrow and read a number instead of buffer-substring/
2614 ;; string-to-number because it's faster. narrow/widen is
2615 ;; faster than save-restriction/narrow, and save-restriction
2616 ;; produces a garbage object.
2621 ;; If the next character is a dash, then this is a range.
2624 ;; We read the upper bound of the range.
2627 ;; This is a buggy line, by we pretend that
2628 ;; it's kinda OK. Perhaps the user should be
2629 ;; dinged?
2637 reads)
2639 ;; It was just a simple number, so we add it to the
2640 ;; list of ranges.
2642 ;; If the next char in ?\n, then we have reached the end
2643 ;; of the line and return nil.
2646 ;; End of line, so we end.
2647 nil)
2649 ;; Not numbers and not eol, so this might be a buggy
2650 ;; line...
2652 ;; If it was eob instead of ?\n, we allow it.
2653 ;; The line was buggy.
2658 nil))
2659 ;; Skip past ", ". Spaces are invalid in these ranges, but
2660 ;; we allow them, because it's a common mistake to put a
2661 ;; space after the comma.
2664 ;; We have already read .newsrc.eld, so we gently update the
2665 ;; data in the hash table with the information we have just
2666 ;; read.
2669 level)
2671 ;; There is an entry for this file in the alist.
2674 ;; We update the level very gently. In fact, we
2675 ;; only change it if there's been a status change
2676 ;; from subscribed to unsubscribed, or vice versa.
2681 gnus-level-default-unsubscribed
2686 ;; This is a new group.
2689 gnus-level-default-subscribed
2692 gnus-level-default-unsubscribed))
2700 ()
2701 ;; We now have two newsrc lists - `newsrc', which is what we
2702 ;; have read from .newsrc, and `gnus-newsrc-alist', which is
2703 ;; what we've read from .newsrc.eld. We have to merge these
2704 ;; lists. We do this by "attaching" any (foreign) groups in the
2705 ;; gnus-newsrc-alist to the (native) group that precedes them.
2708 entry mentry)
2720 ;; We make the newsrc hashtb.
2723 ;; Finally, if we read some options lines, we parse them.
2727 ;; Parse options lines to find "options -n !all rec.all" and stuff.
2728 ;; The return value will be a list on the form
2729 ;; ((regexp1 . ignore)
2730 ;; (regexp2 . subscribe)...)
2731 ;; When handling new newsgroups, groups that match a `ignore' regexp
2732 ;; will be ignored, and groups that match a `subscribe' regexp will be
2733 ;; subscribed. A line like
2734 ;; options -n !all rec.all
2735 ;; will lead to a list that looks like
2736 ;; (("^rec\\..+" . subscribe)
2737 ;; ("^.+" . ignore))
2738 ;; So all "rec.*" groups will be subscribed, while all the other
2739 ;; groups will be ignored. Note that "options -n !all rec.all" is very
2740 ;; different from "options -n rec.all !all".
2746 ;; First we treat all continuation lines.
2750 ;; Then we transform all "all"s into ".+"s.
2755 ;; We remove all other options than the "-n" ones.
2761 ;; We are only interested in "options -n" lines - we
2762 ;; ignore the other option lines.
2769 ;; Search for all "words"...
2772 ;; If the word begins with a bang (!), this is a "not"
2773 ;; spec. We put this spec (minus the bang) and the
2774 ;; symbol `ignore' into the list.
2781 out)
2782 ;; There was no bang, so this is a "yes" spec.
2785 out))))
2792 'msdos-long-file-names
2797 "Save .newsrc file."
2798 ;; Note: We cannot save .newsrc file if all newsgroups are removed
2799 ;; from the variable gnus-newsrc-alist.
2801 gnus-current-startup-file)
2802 ;; Save agent range limits for the currently active method.
2817 ;; Save .newsrc.
2823 ;; Save .newsrc.eld.
2834 ;; check timestamp of `gnus-current-startup-file'.eld against
2835 ;; `gnus-save-newsrc-file-last-timestamp'
2841 mtime))
2844 checkfile
2846 "%c"
2847 gnus-save-newsrc-file-last-timestamp)))
2862 working-file
2864 ;; Generate the name of a non-existent file.
2880 ;; These bindings will mislead the current buffer
2881 ;; into thinking that it is visiting the startup
2882 ;; file.
2887 ;; Backup the current version of the startup file.
2890 ;; Replace the existing startup file with the temp file.
2906 "Print Gnus variables such as `gnus-newsrc-alist' in Lisp format."
2908 gnus-ding-file-coding-system))
2915 ;; Never delete this file -- if you want to force Gnus to read the
2933 gnus-killed-list))
2937 ;; Remove the `gnus-killed-list' from the list of variables
2938 ;; to be saved, if required.
2940 ;; Peel off the "dummy" group.
2942 variable)
2943 ;; Insert the variables into the file.
2954 "Return the killed list minus the groups that match `gnus-save-killed-list'."
2956 olist)
2965 ;; Generate and save the .newsrc file.
2969 info ranges range method)
2974 ;; Use a unibyte buffer since group names are unibyte strings;
2975 ;; in particular, non-ASCII group names are the ones encoded by
2976 ;; a certain coding system.
2978 ;; Write options.
2981 ;; Write subscribed and unsubscribed.
2983 ;; Don't write foreign groups to .newsrc.
2987 foreign-ok)
3010 ;; It has been reported that sometime the modtime on the .newsrc
3011 ;; file seems to be off. We really do want to overwrite it, so
3012 ;; we clear the modtime here before saving. It's a bit odd,
3013 ;; though...
3014 ;; sometimes the modtime clear isn't sufficient. most brute force:
3015 ;; delete the silly thing entirely first. but this fails to provide
3016 ;; such niceties as .newsrc~ creation.
3025 \f
3026 ;;;
3027 ;;; Slave functions.
3028 ;;;
3033 "Minor mode for slave Gnusae."
3034 ;; FIXME: gnus-slave-mode appears to never be set (i.e. it'll always be nil):
3035 ;; Remove, or fix and use define-minor-mode.
3059 t))
3060 file)
3068 slave-files)
3079 t)
3082 nil))
3090 \f
3091 ;;;
3092 ;;; Group description.
3093 ;;;
3100 gnus-secondary-select-methods))))
3104 t))
3108 group)
3111 ;; We create the hashtable whether we manage to read the desc file
3112 ;; to avoid trying to re-read after a failed read.
3116 ;; Mark this method's desc file as read.
3118 gnus-description-hashtb)
3123 t)
3126 nil)
3129 nil)
3132 ;; FIXME: Shouldn't save-restriction be done after set-buffer?
3140 ;; If these are groups from a foreign select method, we insert the
3141 ;; group prefix in front of the group names.
3146 nil gnus-select-method))))
3154 ;; If we get an error, we set group to 0, which is not a
3155 ;; symbol...
3159 ;; Group is set to a symbol interned in this
3160 ;; hash table.
3164 ;; ... which leads to this line being effectively ignored.
3172 gnus-default-charset)))
3173 ;; Fixme: Don't decode in unibyte mode.
3179 t))))
3182 "Get the description of a group by sending XGTITLE to the server."
3189 ;;;###autoload
3191 "Declare back end NAME with ABILITIES as a Gnus back end."
3198 "Set the default directory in the current buffer to `gnus-default-directory'.
3199 If this variable is nil, don't do anything."
3204 default-directory)))
3212 ;; Check whether nnml and nnfolder share a directory.
3215 'display-warning
3227 window
3232 method active actives match)
3249 ;;; gnus-start.el ends here