Merge branch 'master' of https://git.gnus.org/gnus
[gnus] / lisp / gnus-sum.el
1 ;;; gnus-sum.el --- summary mode commands for Gnus
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 ;; For Emacs < 22.2.
29 (eval-and-compile
30   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
31 (eval-when-compile
32   (require 'cl))
33 (eval-when-compile
34   (when (featurep 'xemacs)
35     (require 'easy-mmode))) ; for `define-minor-mode'
36
37 (defvar tool-bar-mode)
38 (defvar gnus-tmp-header)
39
40 (require 'gnus)
41 (require 'gnus-group)
42 (require 'gnus-spec)
43 (require 'gnus-range)
44 (require 'gnus-int)
45 (require 'gnus-undo)
46 (require 'gnus-util)
47 (require 'gmm-utils)
48 (require 'mm-decode)
49 (require 'nnoo)
50
51 (autoload 'gnus-summary-limit-include-cached "gnus-cache" nil t)
52 (autoload 'gnus-cache-write-active "gnus-cache")
53 (autoload 'gnus-mailing-list-insinuate "gnus-ml" nil t)
54 (autoload 'turn-on-gnus-mailing-list-mode "gnus-ml" nil t)
55 (autoload 'gnus-pick-line-number "gnus-salt" nil t)
56 (autoload 'mm-uu-dissect "mm-uu")
57 (autoload 'gnus-article-outlook-deuglify-article "deuglify"
58   "Deuglify broken Outlook (Express) articles and redisplay."
59   t)
60 (autoload 'gnus-article-outlook-unwrap-lines "deuglify" nil t)
61 (autoload 'gnus-article-outlook-repair-attribution "deuglify" nil t)
62 (autoload 'gnus-article-outlook-rearrange-citation "deuglify" nil t)
63
64 (defcustom gnus-kill-summary-on-exit t
65   "*If non-nil, kill the summary buffer when you exit from it.
66 If nil, the summary will become a \"*Dead Summary*\" buffer, and
67 it will be killed sometime later."
68   :group 'gnus-summary-exit
69   :type 'boolean)
70
71 (defcustom gnus-summary-next-group-on-exit t
72   "If non-nil, go to the next unread newsgroup on summary exit.
73 See `gnus-group-goto-unread'."
74   :link '(custom-manual "(gnus)Group Maneuvering")
75   :group 'gnus-summary-exit
76   :version "23.1" ;; No Gnus
77   :type 'boolean)
78
79 (defcustom gnus-summary-stop-at-end-of-message nil
80   "If non-nil, don't select the next message when using `SPC'."
81   :link '(custom-manual "(gnus)Group Maneuvering")
82   :group 'gnus-summary-maneuvering
83   :version "24.1"
84   :type 'boolean)
85
86 (defcustom gnus-fetch-old-headers nil
87   "*Non-nil means that Gnus will try to build threads by grabbing old headers.
88 If an unread article in the group refers to an older, already
89 read (or just marked as read) article, the old article will not
90 normally be displayed in the Summary buffer.  If this variable is
91 t, Gnus will attempt to grab the headers to the old articles, and
92 thereby build complete threads.  If it has the value `some', all
93 old headers will be fetched but only enough headers to connect
94 otherwise loose threads will be displayed.  This variable can
95 also be a number.  In that case, no more than that number of old
96 headers will be fetched.  If it has the value `invisible', all
97 old headers will be fetched, but none will be displayed.
98
99 The server has to support NOV for any of this to work.
100
101 This feature can seriously impact performance it ignores all
102 locally cached header entries.  Setting it to t for groups for a
103 server that doesn't expire articles (such as news.gmane.org),
104 leads to very slow summary generation."
105   :group 'gnus-thread
106   :type '(choice (const :tag "off" nil)
107                  (const :tag "on" t)
108                  (const some)
109                  (const invisible)
110                  number
111                  (sexp :menu-tag "other" t)))
112
113 (defcustom gnus-refer-thread-limit 500
114   "*The number of old headers to fetch when doing \\<gnus-summary-mode-map>\\[gnus-summary-refer-thread].
115 If t, fetch all the available old headers."
116   :group 'gnus-thread
117   :type '(choice number
118                  (sexp :menu-tag "other" t)))
119
120 (defcustom gnus-summary-make-false-root 'adopt
121   "*nil means that Gnus won't gather loose threads.
122 If the root of a thread has expired or been read in a previous
123 session, the information necessary to build a complete thread has been
124 lost.  Instead of having many small sub-threads from this original thread
125 scattered all over the summary buffer, Gnus can gather them.
126
127 If non-nil, Gnus will try to gather all loose sub-threads from an
128 original thread into one large thread.
129
130 If this variable is non-nil, it should be one of `none', `adopt',
131 `dummy' or `empty'.
132
133 If this variable is `none', Gnus will not make a false root, but just
134 present the sub-threads after another.
135 If this variable is `dummy', Gnus will create a dummy root that will
136 have all the sub-threads as children.
137 If this variable is `adopt', Gnus will make one of the \"children\"
138 the parent and mark all the step-children as such.
139 If this variable is `empty', the \"children\" are printed with empty
140 subject fields.  (Or rather, they will be printed with a string
141 given by the `gnus-summary-same-subject' variable.)"
142   :group 'gnus-thread
143   :type '(choice (const :tag "off" nil)
144                  (const none)
145                  (const dummy)
146                  (const adopt)
147                  (const empty)))
148
149 (defcustom gnus-summary-make-false-root-always nil
150   "Always make a false dummy root."
151   :version "22.1"
152   :group 'gnus-thread
153   :type 'boolean)
154
155 (defcustom gnus-summary-gather-exclude-subject "^ *$\\|^(none)$"
156   "*A regexp to match subjects to be excluded from loose thread gathering.
157 As loose thread gathering is done on subjects only, that means that
158 there can be many false gatherings performed.  By rooting out certain
159 common subjects, gathering might become saner."
160   :group 'gnus-thread
161   :type 'regexp)
162
163 (defcustom gnus-summary-gather-subject-limit nil
164   "*Maximum length of subject comparisons when gathering loose threads.
165 Use nil to compare full subjects.  Setting this variable to a low
166 number will help gather threads that have been corrupted by
167 newsreaders chopping off subject lines, but it might also mean that
168 unrelated articles that have subject that happen to begin with the
169 same few characters will be incorrectly gathered.
170
171 If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
172 comparing subjects."
173   :group 'gnus-thread
174   :type '(choice (const :tag "off" nil)
175                  (const fuzzy)
176                  (sexp :menu-tag "on" t)))
177
178 (defcustom gnus-simplify-subject-functions nil
179   "List of functions taking a string argument that simplify subjects.
180 The functions are applied recursively.
181
182 Useful functions to put in this list include:
183 `gnus-simplify-subject-re', `gnus-simplify-subject-fuzzy',
184 `gnus-simplify-whitespace', and `gnus-simplify-all-whitespace'."
185   :group 'gnus-thread
186   :type '(repeat function))
187
188 (defcustom gnus-simplify-ignored-prefixes nil
189   "*Remove matches for this regexp from subject lines when simplifying fuzzily."
190   :group 'gnus-thread
191   :type '(choice (const :tag "off" nil)
192                  regexp))
193
194 (defcustom gnus-build-sparse-threads nil
195   "*If non-nil, fill in the gaps in threads.
196 If `some', only fill in the gaps that are needed to tie loose threads
197 together.  If `more', fill in all leaf nodes that Gnus can find.  If
198 non-nil and non-`some', fill in all gaps that Gnus manages to guess."
199   :group 'gnus-thread
200   :type '(choice (const :tag "off" nil)
201                  (const some)
202                  (const more)
203                  (sexp :menu-tag "all" t)))
204
205 (defcustom gnus-summary-thread-gathering-function
206   'gnus-gather-threads-by-subject
207   "*Function used for gathering loose threads.
208 There are two pre-defined functions: `gnus-gather-threads-by-subject',
209 which only takes Subjects into consideration; and
210 `gnus-gather-threads-by-references', which compared the References
211 headers of the articles to find matches."
212   :group 'gnus-thread
213   :type '(radio (function-item gnus-gather-threads-by-subject)
214                 (function-item gnus-gather-threads-by-references)
215                 (function :tag "other")))
216
217 (defcustom gnus-summary-same-subject ""
218   "*String indicating that the current article has the same subject as the previous.
219 This variable will only be used if the value of
220 `gnus-summary-make-false-root' is `empty'."
221   :group 'gnus-summary-format
222   :type 'string)
223
224 (defcustom gnus-summary-goto-unread nil
225   "*If t, many commands will go to the next unread article.
226 This applies to marking commands as well as other commands that
227 \"naturally\" select the next article, like, for instance, `SPC' at
228 the end of an article.
229
230 If nil, the marking commands do NOT go to the next unread article
231 \(they go to the next article instead).  If `never', commands that
232 usually go to the next unread article, will go to the next article,
233 whether it is read or not."
234   :version "24.1"
235   :group 'gnus-summary-marks
236   :link '(custom-manual "(gnus)Setting Marks")
237   :type '(choice (const :tag "off" nil)
238                  (const never)
239                  (sexp :menu-tag "on" t)))
240
241 (defcustom gnus-summary-default-score 0
242   "*Default article score level.
243 All scores generated by the score files will be added to this score.
244 If this variable is nil, scoring will be disabled."
245   :group 'gnus-score-default
246   :type '(choice (const :tag "disable")
247                  integer))
248
249 (defcustom gnus-summary-default-high-score 0
250   "*Default threshold for a high scored article.
251 An article will be highlighted as high scored if its score is greater
252 than this score."
253   :version "22.1"
254   :group 'gnus-score-default
255   :type 'integer)
256
257 (defcustom gnus-summary-default-low-score 0
258   "*Default threshold for a low scored article.
259 An article will be highlighted as low scored if its score is smaller
260 than this score."
261   :version "22.1"
262   :group 'gnus-score-default
263   :type 'integer)
264
265 (defcustom gnus-summary-zcore-fuzz 0
266   "*Fuzziness factor for the zcore in the summary buffer.
267 Articles with scores closer than this to `gnus-summary-default-score'
268 will not be marked."
269   :group 'gnus-summary-format
270   :type 'integer)
271
272 (defcustom gnus-simplify-subject-fuzzy-regexp nil
273   "*Strings to be removed when doing fuzzy matches.
274 This can either be a regular expression or list of regular expressions
275 that will be removed from subject strings if fuzzy subject
276 simplification is selected."
277   :group 'gnus-thread
278   :type '(repeat regexp))
279
280 (defcustom gnus-show-threads t
281   "*If non-nil, display threads in summary mode."
282   :group 'gnus-thread
283   :type 'boolean)
284
285 (defcustom gnus-thread-hide-subtree nil
286   "*If non-nil, hide all threads initially.
287 This can be a predicate specifier which says which threads to hide.
288 If threads are hidden, you have to run the command
289 `gnus-summary-show-thread' by hand or select an article."
290   :group 'gnus-thread
291   :type '(radio (sexp :format "Non-nil\n"
292                       :match (lambda (widget value)
293                                (not (or (consp value) (functionp value))))
294                       :value t)
295                 (const nil)
296                 (sexp :tag "Predicate specifier")))
297
298 (defcustom gnus-thread-hide-killed t
299   "*If non-nil, hide killed threads automatically."
300   :group 'gnus-thread
301   :type 'boolean)
302
303 (defcustom gnus-thread-ignore-subject t
304   "*If non-nil, which is the default, ignore subjects and do all threading based on the Reference header.
305 If nil, articles that have different subjects from their parents will
306 start separate threads."
307   :group 'gnus-thread
308   :type 'boolean)
309
310 (defcustom gnus-thread-operation-ignore-subject t
311   "*If non-nil, subjects will be ignored when doing thread commands.
312 This affects commands like `gnus-summary-kill-thread' and
313 `gnus-summary-lower-thread'.
314
315 If this variable is nil, articles in the same thread with different
316 subjects will not be included in the operation in question.  If this
317 variable is `fuzzy', only articles that have subjects that are fuzzily
318 equal will be included."
319   :group 'gnus-thread
320   :type '(choice (const :tag "off" nil)
321                  (const fuzzy)
322                  (sexp :tag "on" t)))
323
324 (defcustom gnus-thread-indent-level 4
325   "*Number that says how much each sub-thread should be indented."
326   :group 'gnus-thread
327   :type 'integer)
328
329 (defcustom gnus-auto-extend-newsgroup t
330   "*If non-nil, extend newsgroup forward and backward when requested."
331   :group 'gnus-summary-choose
332   :type 'boolean)
333
334 (defcustom gnus-auto-select-first t
335   "If non-nil, select an article on group entry.
336 An article is selected automatically when entering a group
337 e.g. with \\<gnus-group-mode-map>\\[gnus-group-read-group], or via `gnus-summary-next-page' or
338 `gnus-summary-catchup-and-goto-next-group'.
339
340 Which article is selected is controlled by the variable
341 `gnus-auto-select-subject'.
342
343 If you want to prevent automatic selection of articles in some
344 newsgroups, set the variable to nil in `gnus-select-group-hook'."
345   ;; Commands include...
346   ;; \\<gnus-group-mode-map>\\[gnus-group-read-group]
347   ;; \\<gnus-summary-mode-map>\\[gnus-summary-next-page]
348   ;; \\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]
349   :group 'gnus-group-select
350   :type '(choice (const :tag "none" nil)
351                  (sexp :menu-tag "first" t)))
352
353 (defcustom gnus-auto-select-subject 'unread
354   "*Says what subject to place under point when entering a group.
355
356 This variable can either be the symbols `first' (place point on the
357 first subject), `unread' (place point on the subject line of the first
358 unread article), `best' (place point on the subject line of the
359 higest-scored article), `unseen' (place point on the subject line of
360 the first unseen article), `unseen-or-unread' (place point on the subject
361 line of the first unseen article or, if all article have been seen, on the
362 subject line of the first unread article), or a function to be called to
363 place point on some subject line."
364   :version "22.1"
365   :group 'gnus-group-select
366   :type '(choice (const best)
367                  (const unread)
368                  (const first)
369                  (const unseen)
370                  (const unseen-or-unread)))
371
372 (defcustom gnus-auto-select-next t
373   "*If non-nil, offer to go to the next group from the end of the previous.
374 If the value is t and the next newsgroup is empty, Gnus will exit
375 summary mode and go back to group mode.  If the value is neither nil
376 nor t, Gnus will select the following unread newsgroup.  In
377 particular, if the value is the symbol `quietly', the next unread
378 newsgroup will be selected without any confirmation, and if it is
379 `almost-quietly', the next group will be selected without any
380 confirmation if you are located on the last article in the group.
381 Finally, if this variable is `slightly-quietly', the `\\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]' command
382 will go to the next group without confirmation."
383   :group 'gnus-summary-maneuvering
384   :type '(choice (const :tag "off" nil)
385                  (const quietly)
386                  (const almost-quietly)
387                  (const slightly-quietly)
388                  (sexp :menu-tag "on" t)))
389
390 (defcustom gnus-auto-select-same nil
391   "*If non-nil, select the next article with the same subject.
392 If there are no more articles with the same subject, go to
393 the first unread article."
394   :group 'gnus-summary-maneuvering
395   :type 'boolean)
396
397 (defcustom gnus-auto-select-on-ephemeral-exit 'next-noselect
398   "What article should be selected after exiting an ephemeral group.
399 Valid values include:
400
401 `next'
402   Select the next article.
403 `next-unread'
404   Select the next unread article.
405 `next-noselect'
406   Move the cursor to the next article.  This is the default.
407 `next-unread-noselect'
408   Move the cursor to the next unread article.
409
410 If it has any other value or there is no next (unread) article, the
411 article selected before entering to the ephemeral group will appear."
412   :version "23.1" ;; No Gnus
413   :group 'gnus-summary-maneuvering
414   :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
415                  (const next) (const next-unread)
416                  (const next-noselect) (const next-unread-noselect)
417                  (sexp :tag "other" :value nil)))
418
419 (defcustom gnus-auto-goto-ignores 'unfetched
420   "*Says how to handle unfetched articles when maneuvering.
421
422 This variable can either be the symbols nil (maneuver to any
423 article), `undownloaded' (maneuvering while unplugged ignores articles
424 that have not been fetched), `always-undownloaded' (maneuvering always
425 ignores articles that have not been fetched), `unfetched' (maneuvering
426 ignores articles whose headers have not been fetched).
427
428 NOTE: The list of unfetched articles will always be nil when plugged
429 and, when unplugged, a subset of the undownloaded article list."
430   :version "22.1"
431   :group 'gnus-summary-maneuvering
432   :type '(choice (const :tag "None" nil)
433                  (const :tag "Undownloaded when unplugged" undownloaded)
434                  (const :tag "Undownloaded" always-undownloaded)
435                  (const :tag "Unfetched" unfetched)))
436
437 (defcustom gnus-summary-check-current nil
438   "*If non-nil, consider the current article when moving.
439 The \"unread\" movement commands will stay on the same line if the
440 current article is unread."
441   :group 'gnus-summary-maneuvering
442   :type 'boolean)
443
444 (defcustom gnus-auto-center-summary 2
445   "*If non-nil, always center the current summary buffer.
446 In particular, if `vertical' do only vertical recentering.  If non-nil
447 and non-`vertical', do both horizontal and vertical recentering."
448   :group 'gnus-summary-maneuvering
449   :type '(choice (const :tag "none" nil)
450                  (const vertical)
451                  (integer :tag "height")
452                  (sexp :menu-tag "both" t)))
453
454 (defvar gnus-auto-center-group t
455   "*If non-nil, always center the group buffer.")
456
457 (defcustom gnus-show-all-headers nil
458   "*If non-nil, don't hide any headers."
459   :group 'gnus-article-hiding
460   :group 'gnus-article-headers
461   :type 'boolean)
462
463 (defcustom gnus-summary-ignore-duplicates nil
464   "*If non-nil, ignore articles with identical Message-ID headers."
465   :group 'gnus-summary
466   :type 'boolean)
467
468 (defcustom gnus-single-article-buffer nil
469   "*If non-nil, display all articles in the same buffer.
470 If nil, each group will get its own article buffer."
471   :version "24.1"
472   :group 'gnus-article-various
473   :type 'boolean)
474
475 (defcustom gnus-break-pages t
476   "*If non-nil, do page breaking on articles.
477 The page delimiter is specified by the `gnus-page-delimiter'
478 variable."
479   :group 'gnus-article-various
480   :type 'boolean)
481
482 (defcustom gnus-move-split-methods nil
483   "*Variable used to suggest where articles are to be moved to.
484 It uses the same syntax as the `gnus-split-methods' variable.
485 However, whereas `gnus-split-methods' specifies file names as targets,
486 this variable specifies group names."
487   :group 'gnus-summary-mail
488   :type '(repeat (choice (list :value (fun) function)
489                          (cons :value ("" "") regexp (repeat string))
490                          (sexp :value nil))))
491
492 (defcustom gnus-move-group-prefix-function 'gnus-group-real-prefix
493   "Function used to compute default prefix for article move/copy/etc prompts.
494 The function should take one argument, a group name, and return a
495 string with the suggested prefix."
496   :group 'gnus-summary-mail
497   :type 'function)
498
499 ;; FIXME: Although the custom type is `character' for the following variables,
500 ;; using multibyte characters (Latin-1, UTF-8) doesn't work.  -- rs
501
502 (defcustom gnus-unread-mark ?           ;Whitespace
503   "*Mark used for unread articles."
504   :group 'gnus-summary-marks
505   :type 'character)
506
507 (defcustom gnus-ticked-mark ?!
508   "*Mark used for ticked articles."
509   :group 'gnus-summary-marks
510   :type 'character)
511
512 (defcustom gnus-dormant-mark ??
513   "*Mark used for dormant articles."
514   :group 'gnus-summary-marks
515   :type 'character)
516
517 (defcustom gnus-del-mark ?r
518   "*Mark used for del'd articles."
519   :group 'gnus-summary-marks
520   :type 'character)
521
522 (defcustom gnus-read-mark ?R
523   "*Mark used for read articles."
524   :group 'gnus-summary-marks
525   :type 'character)
526
527 (defcustom gnus-expirable-mark ?E
528   "*Mark used for expirable articles."
529   :group 'gnus-summary-marks
530   :type 'character)
531
532 (defcustom gnus-killed-mark ?K
533   "*Mark used for killed articles."
534   :group 'gnus-summary-marks
535   :type 'character)
536
537 (defcustom gnus-spam-mark ?$
538   "*Mark used for spam articles."
539   :version "22.1"
540   :group 'gnus-summary-marks
541   :type 'character)
542
543 (defcustom gnus-kill-file-mark ?X
544   "*Mark used for articles killed by kill files."
545   :group 'gnus-summary-marks
546   :type 'character)
547
548 (defcustom gnus-low-score-mark ?Y
549   "*Mark used for articles with a low score."
550   :group 'gnus-summary-marks
551   :type 'character)
552
553 (defcustom gnus-catchup-mark ?C
554   "*Mark used for articles that are caught up."
555   :group 'gnus-summary-marks
556   :type 'character)
557
558 (defcustom gnus-replied-mark ?A
559   "*Mark used for articles that have been replied to."
560   :group 'gnus-summary-marks
561   :type 'character)
562
563 (defcustom gnus-forwarded-mark ?F
564   "*Mark used for articles that have been forwarded."
565   :version "22.1"
566   :group 'gnus-summary-marks
567   :type 'character)
568
569 (defcustom gnus-recent-mark ?N
570   "*Mark used for articles that are recent."
571   :version "22.1"
572   :group 'gnus-summary-marks
573   :type 'character)
574
575 (defcustom gnus-cached-mark ?*
576   "*Mark used for articles that are in the cache."
577   :group 'gnus-summary-marks
578   :type 'character)
579
580 (defcustom gnus-saved-mark ?S
581   "*Mark used for articles that have been saved."
582   :group 'gnus-summary-marks
583   :type 'character)
584
585 (defcustom gnus-unseen-mark ?.
586   "*Mark used for articles that haven't been seen."
587   :version "22.1"
588   :group 'gnus-summary-marks
589   :type 'character)
590
591 (defcustom gnus-no-mark ?               ;Whitespace
592   "*Mark used for articles that have no other secondary mark."
593   :version "22.1"
594   :group 'gnus-summary-marks
595   :type 'character)
596
597 (defcustom gnus-ancient-mark ?O
598   "*Mark used for ancient articles."
599   :group 'gnus-summary-marks
600   :type 'character)
601
602 (defcustom gnus-sparse-mark ?Q
603   "*Mark used for sparsely reffed articles."
604   :group 'gnus-summary-marks
605   :type 'character)
606
607 (defcustom gnus-canceled-mark ?G
608   "*Mark used for canceled articles."
609   :group 'gnus-summary-marks
610   :type 'character)
611
612 (defcustom gnus-duplicate-mark ?M
613   "*Mark used for duplicate articles."
614   :group 'gnus-summary-marks
615   :type 'character)
616
617 (defcustom gnus-undownloaded-mark ?-
618   "*Mark used for articles that weren't downloaded."
619   :version "22.1"
620   :group 'gnus-summary-marks
621   :type 'character)
622
623 (defcustom gnus-downloaded-mark ?+
624   "*Mark used for articles that were downloaded."
625   :group 'gnus-summary-marks
626   :type 'character)
627
628 (defcustom gnus-downloadable-mark ?%
629   "*Mark used for articles that are to be downloaded."
630   :group 'gnus-summary-marks
631   :type 'character)
632
633 (defcustom gnus-unsendable-mark ?=
634   "*Mark used for articles that won't be sent."
635   :group 'gnus-summary-marks
636   :type 'character)
637
638 (defcustom gnus-score-over-mark ?+
639   "*Score mark used for articles with high scores."
640   :group 'gnus-summary-marks
641   :type 'character)
642
643 (defcustom gnus-score-below-mark ?-
644   "*Score mark used for articles with low scores."
645   :group 'gnus-summary-marks
646   :type 'character)
647
648 (defcustom gnus-empty-thread-mark ?     ;Whitespace
649   "*There is no thread under the article."
650   :group 'gnus-summary-marks
651   :type 'character)
652
653 (defcustom gnus-not-empty-thread-mark ?=
654   "*There is a thread under the article."
655   :group 'gnus-summary-marks
656   :type 'character)
657
658 (defcustom gnus-view-pseudo-asynchronously nil
659   "*If non-nil, Gnus will view pseudo-articles asynchronously."
660   :group 'gnus-extract-view
661   :type 'boolean)
662
663 (defcustom gnus-auto-expirable-marks
664   (list gnus-killed-mark gnus-del-mark gnus-catchup-mark
665         gnus-low-score-mark gnus-ancient-mark gnus-read-mark
666         gnus-duplicate-mark)
667   "*The list of marks converted into expiration if a group is auto-expirable."
668   :version "24.1"
669   :group 'gnus-summary
670   :type '(repeat character))
671
672 (defcustom gnus-inhibit-user-auto-expire t
673   "*If non-nil, user marking commands will not mark an article as expirable, even if the group has auto-expire turned on."
674   :version "21.1"
675   :group 'gnus-summary
676   :type 'boolean)
677
678 (defcustom gnus-mark-copied-or-moved-articles-as-expirable nil
679   "If non-nil, mark articles copied or moved to auto-expire group as expirable.
680 If nil, the expirable marks will be unchanged except that the marks
681 will be removed when copying or moving articles to a group that has
682 not turned auto-expire on.  If non-nil, articles that have been read
683 will be marked as expirable when being copied or moved to a group in
684 which auto-expire is turned on."
685   :version "23.2"
686   :type 'boolean
687   :group 'gnus-summary-marks)
688
689 (defcustom gnus-view-pseudos nil
690   "*If `automatic', pseudo-articles will be viewed automatically.
691 If `not-confirm', pseudos will be viewed automatically, and the user
692 will not be asked to confirm the command."
693   :group 'gnus-extract-view
694   :type '(choice (const :tag "off" nil)
695                  (const automatic)
696                  (const not-confirm)))
697
698 (defcustom gnus-view-pseudos-separately t
699   "*If non-nil, one pseudo-article will be created for each file to be viewed.
700 If nil, all files that use the same viewing command will be given as a
701 list of parameters to that command."
702   :group 'gnus-extract-view
703   :type 'boolean)
704
705 (defcustom gnus-insert-pseudo-articles t
706   "*If non-nil, insert pseudo-articles when decoding articles."
707   :group 'gnus-extract-view
708   :type 'boolean)
709
710 (defcustom gnus-summary-dummy-line-format
711   "   %(:                             :%) %S\n"
712   "*The format specification for the dummy roots in the summary buffer.
713 It works along the same lines as a normal formatting string,
714 with some simple extensions.
715
716 %S  The subject
717
718 General format specifiers can also be used.
719 See `(gnus)Formatting Variables'."
720   :link '(custom-manual "(gnus)Formatting Variables")
721   :group 'gnus-threading
722   :type 'string)
723
724 (defcustom gnus-summary-mode-line-format "Gnus: %g [%A] %Z"
725   "*The format specification for the summary mode line.
726 It works along the same lines as a normal formatting string,
727 with some simple extensions:
728
729 %G  Group name
730 %p  Unprefixed group name
731 %A  Current article number
732 %z  Current article score
733 %V  Gnus version
734 %U  Number of unread articles in the group
735 %e  Number of unselected articles in the group
736 %Z  A string with unread/unselected article counts
737 %g  Shortish group name
738 %S  Subject of the current article
739 %u  User-defined spec
740 %s  Current score file name
741 %d  Number of dormant articles
742 %r  Number of articles that have been marked as read in this session
743 %E  Number of articles expunged by the score files"
744   :group 'gnus-summary-format
745   :type 'string)
746
747 (defcustom gnus-list-identifiers nil
748   "Regexp that matches list identifiers to be removed from subject.
749 This can also be a list of regexps."
750   :version "21.1"
751   :group 'gnus-summary-format
752   :group 'gnus-article-hiding
753   :type '(choice (const :tag "none" nil)
754                  (regexp :value ".*")
755                  (repeat :value (".*") regexp)))
756
757 (defcustom gnus-summary-mark-below 0
758   "*Mark all articles with a score below this variable as read.
759 This variable is local to each summary buffer and usually set by the
760 score file."
761   :group 'gnus-score-default
762   :type 'integer)
763
764 (defun gnus-widget-reversible-match (widget value)
765   "Ignoring WIDGET, convert VALUE to internal form.
766 VALUE should have the form `FOO' or `(not FOO)', where FOO is an symbol."
767   ;; (debug value)
768   (or (symbolp value)
769       (and (listp value)
770            (eq (length value) 2)
771            (eq (nth 0 value) 'not)
772            (symbolp (nth 1 value)))))
773
774 (defun gnus-widget-reversible-to-internal (widget value)
775   "Ignoring WIDGET, convert VALUE to internal form.
776 VALUE should have the form `FOO' or `(not FOO)', where FOO is an atom.
777 FOO is converted to (FOO nil) and (not FOO) is converted to (FOO t)."
778   ;; (debug value)
779   (if (atom value)
780       (list value nil)
781     (list (nth 1 value) t)))
782
783 (defun gnus-widget-reversible-to-external (widget value)
784   "Ignoring WIDGET, convert VALUE to external form.
785 VALUE should have the form `(FOO nil)' or `(FOO t)', where FOO is an atom.
786 \(FOO  nil) is converted to FOO and (FOO t) is converted to (not FOO)."
787   ;; (debug value)
788   (if (nth 1 value)
789       (list 'not (nth 0 value))
790     (nth 0 value)))
791
792 (define-widget 'gnus-widget-reversible 'group
793   "A `group' that convert values."
794   :match 'gnus-widget-reversible-match
795   :value-to-internal 'gnus-widget-reversible-to-internal
796   :value-to-external 'gnus-widget-reversible-to-external)
797
798 (defcustom gnus-article-sort-functions '(gnus-article-sort-by-number)
799   "*List of functions used for sorting articles in the summary buffer.
800
801 Each function takes two articles and returns non-nil if the first
802 article should be sorted before the other.  If you use more than one
803 function, the primary sort function should be the last.  You should
804 probably always include `gnus-article-sort-by-number' in the list of
805 sorting functions -- preferably first.  Also note that sorting by date
806 is often much slower than sorting by number, and the sorting order is
807 very similar.  (Sorting by date means sorting by the time the message
808 was sent, sorting by number means sorting by arrival time.)
809
810 Each item can also be a list `(not F)' where F is a function;
811 this reverses the sort order.
812
813 Ready-made functions include `gnus-article-sort-by-number',
814 `gnus-article-sort-by-author', `gnus-article-sort-by-subject',
815 `gnus-article-sort-by-date', `gnus-article-sort-by-random'
816 and `gnus-article-sort-by-score'.
817
818 When threading is turned on, the variable `gnus-thread-sort-functions'
819 controls how articles are sorted."
820   :group 'gnus-summary-sort
821   :type '(repeat (gnus-widget-reversible
822                   (choice (function-item gnus-article-sort-by-number)
823                           (function-item gnus-article-sort-by-author)
824                           (function-item gnus-article-sort-by-subject)
825                           (function-item gnus-article-sort-by-date)
826                           (function-item gnus-article-sort-by-score)
827                           (function-item gnus-article-sort-by-random)
828                           (function :tag "other"))
829                   (boolean :tag "Reverse order"))))
830
831
832 (defcustom gnus-thread-sort-functions '(gnus-thread-sort-by-number)
833   "*List of functions used for sorting threads in the summary buffer.
834 By default, threads are sorted by article number.
835
836 Each function takes two threads and returns non-nil if the first
837 thread should be sorted before the other.  If you use more than one
838 function, the primary sort function should be the last.  You should
839 probably always include `gnus-thread-sort-by-number' in the list of
840 sorting functions -- preferably first.  Also note that sorting by date
841 is often much slower than sorting by number, and the sorting order is
842 very similar.  (Sorting by date means sorting by the time the message
843 was sent, sorting by number means sorting by arrival time.)
844
845 Each list item can also be a list `(not F)' where F is a
846 function; this specifies reversed sort order.
847
848 Ready-made functions include `gnus-thread-sort-by-number',
849 `gnus-thread-sort-by-author', `gnus-thread-sort-by-recipient'
850 `gnus-thread-sort-by-subject', `gnus-thread-sort-by-date',
851 `gnus-thread-sort-by-score', `gnus-thread-sort-by-most-recent-number',
852 `gnus-thread-sort-by-most-recent-date', `gnus-thread-sort-by-random',
853 and `gnus-thread-sort-by-total-score' (see
854 `gnus-thread-score-function').
855
856 When threading is turned off, the variable
857 `gnus-article-sort-functions' controls how articles are sorted."
858   :group 'gnus-summary-sort
859   :type '(repeat
860           (gnus-widget-reversible
861            (choice (function-item gnus-thread-sort-by-number)
862                    (function-item gnus-thread-sort-by-author)
863                    (function-item gnus-thread-sort-by-recipient)
864                    (function-item gnus-thread-sort-by-subject)
865                    (function-item gnus-thread-sort-by-date)
866                    (function-item gnus-thread-sort-by-score)
867                    (function-item gnus-thread-sort-by-most-recent-number)
868                    (function-item gnus-thread-sort-by-most-recent-date)
869                    (function-item gnus-thread-sort-by-random)
870                    (function-item gnus-thread-sort-by-total-score)
871                    (function :tag "other"))
872            (boolean :tag "Reverse order"))))
873
874 (defcustom gnus-thread-score-function '+
875   "*Function used for calculating the total score of a thread.
876
877 The function is called with the scores of the article and each
878 subthread and should then return the score of the thread.
879
880 Some functions you can use are `+', `max', or `min'."
881   :group 'gnus-summary-sort
882   :type 'function)
883
884 (defcustom gnus-summary-expunge-below nil
885   "All articles that have a score less than this variable will be expunged.
886 This variable is local to the summary buffers."
887   :group 'gnus-score-default
888   :type '(choice (const :tag "off" nil)
889                  integer))
890
891 (defcustom gnus-thread-expunge-below nil
892   "All threads that have a total score less than this variable will be expunged.
893 See `gnus-thread-score-function' for en explanation of what a
894 \"thread score\" is.
895
896 This variable is local to the summary buffers."
897   :group 'gnus-threading
898   :group 'gnus-score-default
899   :type '(choice (const :tag "off" nil)
900                  integer))
901
902 (defcustom gnus-summary-mode-hook nil
903   "*A hook for Gnus summary mode.
904 This hook is run before any variables are set in the summary buffer."
905   :options '(turn-on-gnus-mailing-list-mode gnus-pick-mode)
906   :group 'gnus-summary-various
907   :type 'hook)
908
909 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
910 (when (featurep 'xemacs)
911   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-summary-menu-add)
912   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-setup-summary-toolbar)
913   (add-hook 'gnus-summary-mode-hook
914             'gnus-xmas-switch-horizontal-scrollbar-off))
915
916 (defcustom gnus-summary-menu-hook nil
917   "*Hook run after the creation of the summary mode menu."
918   :group 'gnus-summary-visual
919   :type 'hook)
920
921 (defcustom gnus-summary-exit-hook nil
922   "*A hook called on exit from the summary buffer.
923 It will be called with point in the group buffer."
924   :group 'gnus-summary-exit
925   :type 'hook)
926
927 (defcustom gnus-summary-prepare-hook nil
928   "*A hook called after the summary buffer has been generated.
929 If you want to modify the summary buffer, you can use this hook."
930   :group 'gnus-summary-various
931   :type 'hook)
932
933 (defcustom gnus-summary-prepared-hook nil
934   "*A hook called as the last thing after the summary buffer has been generated."
935   :group 'gnus-summary-various
936   :type 'hook)
937
938 (defcustom gnus-summary-generate-hook nil
939   "*A hook run just before generating the summary buffer.
940 This hook is commonly used to customize threading variables and the
941 like."
942   :group 'gnus-summary-various
943   :type 'hook)
944
945 (defcustom gnus-select-group-hook nil
946   "*A hook called when a newsgroup is selected.
947
948 If you'd like to simplify subjects like the
949 `gnus-summary-next-same-subject' command does, you can use the
950 following hook:
951
952  (add-hook gnus-select-group-hook
953            (lambda ()
954              (mapcar (lambda (header)
955                        (mail-header-set-subject
956                         header
957                         (gnus-simplify-subject
958                          (mail-header-subject header) 're-only)))
959                      gnus-newsgroup-headers)))"
960   :group 'gnus-group-select
961   :type 'hook)
962
963 (defcustom gnus-select-article-hook nil
964   "*A hook called when an article is selected."
965   :group 'gnus-summary-choose
966   :options '(gnus-agent-fetch-selected-article)
967   :type 'hook)
968
969 (defcustom gnus-visual-mark-article-hook
970   (list 'gnus-highlight-selected-summary)
971   "*Hook run after selecting an article in the summary buffer.
972 It is meant to be used for highlighting the article in some way.  It
973 is not run if `gnus-visual' is nil."
974   :group 'gnus-summary-visual
975   :type 'hook)
976
977 (defcustom gnus-parse-headers-hook nil
978   "*A hook called before parsing the headers."
979   :group 'gnus-various
980   :type 'hook)
981
982 (defcustom gnus-exit-group-hook nil
983   "*A hook called when exiting summary mode.
984 This hook is not called from the non-updating exit commands like `Q'."
985   :group 'gnus-various
986   :type 'hook)
987
988 (defcustom gnus-summary-update-hook
989   (list 'gnus-summary-highlight-line)
990   "*A hook called when a summary line is changed.
991 The hook will not be called if `gnus-visual' is nil.
992
993 The default function `gnus-summary-highlight-line' will
994 highlight the line according to the `gnus-summary-highlight'
995 variable."
996   :group 'gnus-summary-visual
997   :type 'hook)
998
999 (defcustom gnus-mark-article-hook '(gnus-summary-mark-read-and-unread-as-read)
1000   "*A hook called when an article is selected for the first time.
1001 The hook is intended to mark an article as read (or unread)
1002 automatically when it is selected."
1003   :group 'gnus-summary-choose
1004   :type 'hook)
1005
1006 (defcustom gnus-group-no-more-groups-hook nil
1007   "*A hook run when returning to group mode having no more (unread) groups."
1008   :group 'gnus-group-select
1009   :type 'hook)
1010
1011 (defcustom gnus-ps-print-hook nil
1012   "*A hook run before ps-printing something from Gnus."
1013   :group 'gnus-summary
1014   :type 'hook)
1015
1016 (defcustom gnus-summary-article-move-hook nil
1017   "*A hook called after an article is moved, copied, respooled, or crossposted."
1018   :version "22.1"
1019   :group 'gnus-summary
1020   :type 'hook)
1021
1022 (defcustom gnus-summary-article-delete-hook nil
1023   "*A hook called after an article is deleted."
1024   :version "22.1"
1025   :group 'gnus-summary
1026   :type 'hook)
1027
1028 (defcustom gnus-summary-article-expire-hook nil
1029   "*A hook called after an article is expired."
1030   :version "22.1"
1031   :group 'gnus-summary
1032   :type 'hook)
1033
1034 (defcustom gnus-summary-display-arrow
1035   (and (fboundp 'display-graphic-p)
1036        (display-graphic-p))
1037   "*If non-nil, display an arrow highlighting the current article."
1038   :version "22.1"
1039   :group 'gnus-summary
1040   :type 'boolean)
1041
1042 (defcustom gnus-summary-selected-face 'gnus-summary-selected
1043   "Face used for highlighting the current article in the summary buffer."
1044   :group 'gnus-summary-visual
1045   :type 'face)
1046
1047 (defvar gnus-tmp-downloaded nil)
1048
1049 (defcustom gnus-summary-highlight
1050   '(((eq mark gnus-canceled-mark)
1051      . gnus-summary-cancelled)
1052     ((and uncached (> score default-high))
1053      . gnus-summary-high-undownloaded)
1054     ((and uncached (< score default-low))
1055      . gnus-summary-low-undownloaded)
1056     (uncached
1057      . gnus-summary-normal-undownloaded)
1058     ((and (> score default-high)
1059           (or (eq mark gnus-dormant-mark)
1060               (eq mark gnus-ticked-mark)))
1061      . gnus-summary-high-ticked)
1062     ((and (< score default-low)
1063           (or (eq mark gnus-dormant-mark)
1064               (eq mark gnus-ticked-mark)))
1065      . gnus-summary-low-ticked)
1066     ((or (eq mark gnus-dormant-mark)
1067          (eq mark gnus-ticked-mark))
1068      . gnus-summary-normal-ticked)
1069     ((and (> score default-high) (eq mark gnus-ancient-mark))
1070      . gnus-summary-high-ancient)
1071     ((and (< score default-low) (eq mark gnus-ancient-mark))
1072      . gnus-summary-low-ancient)
1073     ((eq mark gnus-ancient-mark)
1074      . gnus-summary-normal-ancient)
1075     ((and (> score default-high) (eq mark gnus-unread-mark))
1076      . gnus-summary-high-unread)
1077     ((and (< score default-low) (eq mark gnus-unread-mark))
1078      . gnus-summary-low-unread)
1079     ((eq mark gnus-unread-mark)
1080      . gnus-summary-normal-unread)
1081     ((> score default-high)
1082      . gnus-summary-high-read)
1083     ((< score default-low)
1084      . gnus-summary-low-read)
1085     (t
1086      . gnus-summary-normal-read))
1087   "*Controls the highlighting of summary buffer lines.
1088
1089 A list of (FORM . FACE) pairs.  When deciding how a particular
1090 summary line should be displayed, each form is evaluated.  The content
1091 of the face field after the first true form is used.  You can change
1092 how those summary lines are displayed, by editing the face field.
1093
1094 You can use the following variables in the FORM field.
1095
1096 score:        The article's score.
1097 default:      The default article score.
1098 default-high: The default score for high scored articles.
1099 default-low:  The default score for low scored articles.
1100 below:        The score below which articles are automatically marked as read.
1101 mark:         The article's mark.
1102 uncached:     Non-nil if the article is uncached."
1103   :group 'gnus-summary-visual
1104   :type '(repeat (cons (sexp :tag "Form" nil)
1105                        face)))
1106 (put 'gnus-summary-highlight 'risky-local-variable t)
1107
1108 (defcustom gnus-alter-header-function nil
1109   "Function called to allow alteration of article header structures.
1110 The function is called with one parameter, the article header vector,
1111 which it may alter in any way."
1112   :type '(choice (const :tag "None" nil)
1113                  function)
1114   :group 'gnus-summary)
1115
1116 (defvar gnus-decode-encoded-word-function 'mail-decode-encoded-word-string
1117   "Function used to decode a string with encoded words.")
1118
1119 (defvar gnus-decode-encoded-address-function
1120   'mail-decode-encoded-address-string
1121   "Function used to decode addresses with encoded words.")
1122
1123 (defcustom gnus-extra-headers '(To Newsgroups)
1124   "*Extra headers to parse."
1125   :version "21.1"
1126   :group 'gnus-summary
1127   :type '(repeat symbol))
1128
1129 (defcustom gnus-ignored-from-addresses
1130   (and user-mail-address
1131        (not (string= user-mail-address ""))
1132        (regexp-quote user-mail-address))
1133   "*From headers that may be suppressed in favor of To headers.
1134 This can be a regexp or a list of regexps."
1135   :version "21.1"
1136   :group 'gnus-summary
1137   :type '(choice regexp
1138                  (repeat :tag "Regexp List" regexp)))
1139
1140 (defsubst gnus-ignored-from-addresses ()
1141   (gmm-regexp-concat gnus-ignored-from-addresses))
1142
1143 (defcustom gnus-summary-to-prefix "-> "
1144   "*String prefixed to the To field in the summary line when
1145 using `gnus-ignored-from-addresses'."
1146   :version "22.1"
1147   :group 'gnus-summary
1148   :type 'string)
1149
1150 (defcustom gnus-summary-newsgroup-prefix "=> "
1151   "*String prefixed to the Newsgroup field in the summary
1152 line when using `gnus-ignored-from-addresses'."
1153   :version "22.1"
1154   :group 'gnus-summary
1155   :type 'string)
1156
1157 (defcustom gnus-newsgroup-ignored-charsets '(unknown-8bit x-unknown)
1158   "List of charsets that should be ignored.
1159 When these charsets are used in the \"charset\" parameter, the
1160 default charset will be used instead."
1161   :version "21.1"
1162   :type '(repeat symbol)
1163   :group 'gnus-charset)
1164
1165 (defcustom gnus-newsgroup-maximum-articles nil
1166   "The maximum number of articles a newsgroup.
1167 If this is a number, old articles in a newsgroup exceeding this number
1168 are silently ignored.  If it is nil, no article is ignored.  Note that
1169 setting this variable to a number might prevent you from reading very
1170 old articles."
1171   :group 'gnus-group-select
1172   :version "22.2"
1173   :type '(choice (const :tag "No limit" nil)
1174                  integer))
1175
1176 (gnus-define-group-parameter
1177  ignored-charsets
1178  :type list
1179  :function-document
1180  "Return the ignored charsets of GROUP."
1181  :variable gnus-group-ignored-charsets-alist
1182  :variable-default
1183  '(("alt\\.chinese\\.text" iso-8859-1))
1184  :variable-document
1185  "Alist of regexps (to match group names) and charsets that should be ignored.
1186 When these charsets are used in the \"charset\" parameter, the
1187 default charset will be used instead."
1188  :variable-group gnus-charset
1189  :variable-type '(repeat (cons (regexp :tag "Group")
1190                                (repeat symbol)))
1191  :parameter-type '(choice :tag "Ignored charsets"
1192                           :value nil
1193                           (repeat (symbol)))
1194  :parameter-document       "\
1195 List of charsets that should be ignored.
1196
1197 When these charsets are used in the \"charset\" parameter, the
1198 default charset will be used instead.")
1199
1200 (defcustom gnus-group-highlight-words-alist nil
1201   "Alist of group regexps and highlight regexps.
1202 This variable uses the same syntax as `gnus-emphasis-alist'."
1203   :version "21.1"
1204   :type '(repeat (cons (regexp :tag "Group")
1205                        (repeat (list (regexp :tag "Highlight regexp")
1206                                      (number :tag "Group for entire word" 0)
1207                                      (number :tag "Group for displayed part" 0)
1208                                      (symbol :tag "Face"
1209                                              gnus-emphasis-highlight-words)))))
1210   :group 'gnus-summary-visual)
1211
1212 (defcustom gnus-summary-show-article-charset-alist
1213   nil
1214   "Alist of number and charset.
1215 The article will be shown with the charset corresponding to the
1216 numbered argument.
1217 For example: ((1 . cn-gb-2312) (2 . big5))."
1218   :version "21.1"
1219   :type '(repeat (cons (number :tag "Argument" 1)
1220                        (symbol :tag "Charset")))
1221   :group 'gnus-charset)
1222
1223 (defcustom gnus-preserve-marks t
1224   "Whether marks are preserved when moving, copying and respooling messages."
1225   :version "21.1"
1226   :type 'boolean
1227   :group 'gnus-summary-marks)
1228
1229 (defcustom gnus-propagate-marks t
1230   "If non-nil, do not propagate marks to the backends."
1231   :version "23.1" ;; No Gnus
1232   :type 'boolean
1233   :group 'gnus-summary-marks)
1234
1235 (defcustom gnus-alter-articles-to-read-function nil
1236   "Function to be called to alter the list of articles to be selected."
1237   :type '(choice (const nil) function)
1238   :group 'gnus-summary)
1239
1240 (defcustom gnus-orphan-score nil
1241   "*All orphans get this score added.  Set in the score file."
1242   :group 'gnus-score-default
1243   :type '(choice (const nil)
1244                  integer))
1245
1246 (defcustom gnus-summary-save-parts-default-mime "image/.*"
1247   "*A regexp to match MIME parts when saving multiple parts of a
1248 message with `gnus-summary-save-parts' (\\<gnus-summary-mode-map>\\[gnus-summary-save-parts]).
1249 This regexp will be used by default when prompting the user for which
1250 type of files to save."
1251   :group 'gnus-summary
1252   :type 'regexp)
1253
1254 (defcustom gnus-read-all-available-headers nil
1255   "Whether Gnus should parse all headers made available to it.
1256 This is mostly relevant for slow back ends where the user may
1257 wish to widen the summary buffer to include all headers
1258 that were fetched."
1259   :version "22.1"
1260   :group 'gnus-summary
1261   :type '(choice boolean regexp))
1262
1263 (defcustom gnus-summary-pipe-output-default-command nil
1264   "Command (and optional arguments) used to pipe article to subprocess.
1265 This will be used as the default command if it is non-nil.  The value
1266 will be updated if you modify it when executing the command
1267 `gnus-summary-pipe-output' or the function `gnus-summary-save-in-pipe'."
1268   :version "23.1" ;; No Gnus
1269   :group 'gnus-summary
1270   :type '(radio (const :tag "None" nil) (string :tag "Command")))
1271
1272 (defcustom gnus-summary-muttprint-program "muttprint"
1273   "Command (and optional arguments) used to run Muttprint.
1274 The value will be updated if you modify it when executing the command
1275 `gnus-summary-muttprint'."
1276   :version "22.1"
1277   :group 'gnus-summary
1278   :type 'string)
1279
1280 (defcustom gnus-article-loose-mime t
1281   "If non-nil, don't require MIME-Version header.
1282 Some brain-damaged MUA/MTA, e.g. Lotus Domino 5.0.6 clients, does not
1283 supply the MIME-Version header or deliberately strip it from the mail.
1284 If non-nil (the default), Gnus will treat some articles as MIME
1285 even if the MIME-Version header is missing."
1286   :version "22.1"
1287   :type 'boolean
1288   :group 'gnus-article-mime)
1289
1290 (defcustom gnus-article-emulate-mime t
1291   "If non-nil, use MIME emulation for uuencode and the like.
1292 This means that Gnus will search message bodies for text that look
1293 like uuencoded bits, yEncoded bits, and so on, and present that using
1294 the normal Gnus MIME machinery."
1295   :version "22.1"
1296   :type 'boolean
1297   :group 'gnus-article-mime)
1298
1299 ;;; Internal variables
1300
1301 (defvar gnus-summary-display-cache nil)
1302 (defvar gnus-article-mime-handles nil)
1303 (defvar gnus-article-decoded-p nil)
1304 (defvar gnus-article-charset nil)
1305 (defvar gnus-article-ignored-charsets nil)
1306 (defvar gnus-scores-exclude-files nil)
1307 (defvar gnus-page-broken nil)
1308
1309 (defvar gnus-original-article nil)
1310 (defvar gnus-article-internal-prepare-hook nil)
1311 (defvar gnus-newsgroup-process-stack nil)
1312
1313 (defvar gnus-thread-indent-array nil)
1314 (defvar gnus-thread-indent-array-level gnus-thread-indent-level)
1315 (defvar gnus-sort-gathered-threads-function 'gnus-thread-sort-by-number
1316   "Function called to sort the articles within a thread after it has been gathered together.")
1317
1318 (defvar gnus-summary-save-parts-type-history nil)
1319 (defvar gnus-summary-save-parts-last-directory mm-default-directory)
1320
1321 ;; Avoid highlighting in kill files.
1322 (defvar gnus-summary-inhibit-highlight nil)
1323 (defvar gnus-newsgroup-selected-overlay nil)
1324 (defvar gnus-inhibit-limiting nil)
1325 (defvar gnus-newsgroup-adaptive-score-file nil)
1326 (defvar gnus-current-score-file nil)
1327 (defvar gnus-current-move-group nil)
1328 (defvar gnus-current-copy-group nil)
1329 (defvar gnus-current-crosspost-group nil)
1330 (defvar gnus-newsgroup-display nil)
1331
1332 (defvar gnus-newsgroup-dependencies nil)
1333 (defvar gnus-newsgroup-adaptive nil)
1334 (defvar gnus-summary-display-article-function nil)
1335 (defvar gnus-summary-highlight-line-function nil
1336   "Function called after highlighting a summary line.")
1337
1338 (defvar gnus-summary-line-format-alist
1339   `((?N ,(macroexpand '(mail-header-number gnus-tmp-header)) ?d)
1340     (?S ,(macroexpand '(mail-header-subject gnus-tmp-header)) ?s)
1341     (?s gnus-tmp-subject-or-nil ?s)
1342     (?n gnus-tmp-name ?s)
1343     (?A (car (cdr (funcall gnus-extract-address-components gnus-tmp-from)))
1344         ?s)
1345     (?a (or (car (funcall gnus-extract-address-components gnus-tmp-from))
1346             gnus-tmp-from) ?s)
1347     (?F gnus-tmp-from ?s)
1348     (?x ,(macroexpand '(mail-header-xref gnus-tmp-header)) ?s)
1349     (?D ,(macroexpand '(mail-header-date gnus-tmp-header)) ?s)
1350     (?d (gnus-dd-mmm (mail-header-date gnus-tmp-header)) ?s)
1351     (?o (gnus-date-iso8601 (mail-header-date gnus-tmp-header)) ?s)
1352     (?M ,(macroexpand '(mail-header-id gnus-tmp-header)) ?s)
1353     (?r ,(macroexpand '(mail-header-references gnus-tmp-header)) ?s)
1354     (?c (or (mail-header-chars gnus-tmp-header) 0) ?d)
1355     (?k (gnus-summary-line-message-size gnus-tmp-header) ?s)
1356     (?L gnus-tmp-lines ?s)
1357     (?O gnus-tmp-downloaded ?c)
1358     (?I gnus-tmp-indentation ?s)
1359     (?T (if (= gnus-tmp-level 0) "" (make-string (frame-width) ? )) ?s)
1360     (?R gnus-tmp-replied ?c)
1361     (?\[ gnus-tmp-opening-bracket ?c)
1362     (?\] gnus-tmp-closing-bracket ?c)
1363     (?\> (make-string gnus-tmp-level ? ) ?s)
1364     (?\< (make-string (max 0 (- 20 gnus-tmp-level)) ? ) ?s)
1365     (?i gnus-tmp-score ?d)
1366     (?z gnus-tmp-score-char ?c)
1367     (?V (gnus-thread-total-score (and (boundp 'thread) (car thread))) ?d)
1368     (?U gnus-tmp-unread ?c)
1369     (?f (gnus-summary-from-or-to-or-newsgroups gnus-tmp-header gnus-tmp-from)
1370         ?s)
1371     (?t (gnus-summary-number-of-articles-in-thread
1372          (and (boundp 'thread) (car thread)) gnus-tmp-level)
1373         ?d)
1374     (?e (gnus-summary-number-of-articles-in-thread
1375          (and (boundp 'thread) (car thread)) gnus-tmp-level t)
1376         ?c)
1377     (?u gnus-tmp-user-defined ?s)
1378     (?P (gnus-pick-line-number) ?d)
1379     (?B gnus-tmp-thread-tree-header-string ?s)
1380     (user-date (gnus-user-date
1381                 ,(macroexpand '(mail-header-date gnus-tmp-header))) ?s))
1382   "An alist of format specifications that can appear in summary lines.
1383 These are paired with what variables they correspond with, along with
1384 the type of the variable (string, integer, character, etc).")
1385
1386 (defvar gnus-summary-dummy-line-format-alist
1387   `((?S gnus-tmp-subject ?s)
1388     (?N gnus-tmp-number ?d)
1389     (?u gnus-tmp-user-defined ?s)))
1390
1391 (defvar gnus-summary-mode-line-format-alist
1392   `((?G gnus-tmp-group-name ?s)
1393     (?g (gnus-short-group-name gnus-tmp-group-name) ?s)
1394     (?p (gnus-group-real-name gnus-tmp-group-name) ?s)
1395     (?A gnus-tmp-article-number ?d)
1396     (?Z gnus-tmp-unread-and-unselected ?s)
1397     (?V gnus-version ?s)
1398     (?U gnus-tmp-unread-and-unticked ?d)
1399     (?S gnus-tmp-subject ?s)
1400     (?e gnus-tmp-unselected ?d)
1401     (?u gnus-tmp-user-defined ?s)
1402     (?d (length gnus-newsgroup-dormant) ?d)
1403     (?t (length gnus-newsgroup-marked) ?d)
1404     (?h (length gnus-newsgroup-spam-marked) ?d)
1405     (?r (length gnus-newsgroup-reads) ?d)
1406     (?z (gnus-summary-article-score gnus-tmp-article-number) ?d)
1407     (?E gnus-newsgroup-expunged-tally ?d)
1408     (?s (gnus-current-score-file-nondirectory) ?s)))
1409
1410 ;; This is here rather than in gnus-art for compilation reasons.
1411 (defvar gnus-article-mode-line-format-alist
1412   (nconc '((?w (gnus-article-wash-status) ?s)
1413            (?m (gnus-article-mime-part-status) ?s))
1414          gnus-summary-mode-line-format-alist))
1415
1416 (defvar gnus-last-search-regexp nil
1417   "Default regexp for article search command.")
1418
1419 (defvar gnus-last-shell-command nil
1420   "Default shell command on article.")
1421
1422 (defvar gnus-newsgroup-agentized nil
1423   "Locally bound in each summary buffer to indicate whether the server has been agentized.")
1424 (defvar gnus-newsgroup-begin nil)
1425 (defvar gnus-newsgroup-end nil)
1426 (defvar gnus-newsgroup-last-rmail nil)
1427 (defvar gnus-newsgroup-last-mail nil)
1428 (defvar gnus-newsgroup-last-folder nil)
1429 (defvar gnus-newsgroup-last-file nil)
1430 (defvar gnus-newsgroup-last-directory nil)
1431 (defvar gnus-newsgroup-auto-expire nil)
1432 (defvar gnus-newsgroup-active nil)
1433
1434 (defvar gnus-newsgroup-data nil)
1435 (defvar gnus-newsgroup-data-reverse nil)
1436 (defvar gnus-newsgroup-limit nil)
1437 (defvar gnus-newsgroup-limits nil)
1438 (defvar gnus-summary-use-undownloaded-faces nil)
1439
1440 (defvar gnus-newsgroup-unreads nil
1441   "Sorted list of unread articles in the current newsgroup.")
1442
1443 (defvar gnus-newsgroup-unselected nil
1444   "Sorted list of unselected unread articles in the current newsgroup.")
1445
1446 (defvar gnus-newsgroup-reads nil
1447   "Alist of read articles and article marks in the current newsgroup.")
1448
1449 (defvar gnus-newsgroup-expunged-tally nil)
1450
1451 (defvar gnus-newsgroup-marked nil
1452   "Sorted list of ticked articles in the current newsgroup (a subset of unread art).")
1453
1454 (defvar gnus-newsgroup-spam-marked nil
1455   "List of ranges of articles that have been marked as spam.")
1456
1457 (defvar gnus-newsgroup-killed nil
1458   "List of ranges of articles that have been through the scoring process.")
1459
1460 (defvar gnus-newsgroup-cached nil
1461   "Sorted list of articles that come from the article cache.")
1462
1463 (defvar gnus-newsgroup-saved nil
1464   "List of articles that have been saved.")
1465
1466 (defvar gnus-newsgroup-kill-headers nil)
1467
1468 (defvar gnus-newsgroup-replied nil
1469   "List of articles that have been replied to in the current newsgroup.")
1470
1471 (defvar gnus-newsgroup-forwarded nil
1472   "List of articles that have been forwarded in the current newsgroup.")
1473
1474 (defvar gnus-newsgroup-recent nil
1475   "List of articles that have are recent in the current newsgroup.")
1476
1477 (defvar gnus-newsgroup-expirable nil
1478   "Sorted list of articles in the current newsgroup that can be expired.")
1479
1480 (defvar gnus-newsgroup-processable nil
1481   "List of articles in the current newsgroup that can be processed.")
1482
1483 (defvar gnus-newsgroup-downloadable nil
1484   "Sorted list of articles in the current newsgroup that can be processed.")
1485
1486 (defvar gnus-newsgroup-unfetched nil
1487   "Sorted list of articles in the current newsgroup whose headers have
1488 not been fetched into the agent.
1489
1490 This list will always be a subset of gnus-newsgroup-undownloaded.")
1491
1492 (defvar gnus-newsgroup-undownloaded nil
1493   "List of articles in the current newsgroup that haven't been downloaded.")
1494
1495 (defvar gnus-newsgroup-unsendable nil
1496   "List of articles in the current newsgroup that won't be sent.")
1497
1498 (defvar gnus-newsgroup-bookmarks nil
1499   "List of articles in the current newsgroup that have bookmarks.")
1500
1501 (defvar gnus-newsgroup-dormant nil
1502   "Sorted list of dormant articles in the current newsgroup.")
1503
1504 (defvar gnus-newsgroup-unseen nil
1505   "List of unseen articles in the current newsgroup.")
1506
1507 (defvar gnus-newsgroup-seen nil
1508   "Range of seen articles in the current newsgroup.")
1509
1510 (defvar gnus-newsgroup-articles nil
1511   "List of articles in the current newsgroup.")
1512
1513 (defvar gnus-newsgroup-scored nil
1514   "List of scored articles in the current newsgroup.")
1515
1516 (defvar gnus-newsgroup-headers nil
1517   "List of article headers in the current newsgroup.")
1518
1519 (defvar gnus-newsgroup-threads nil)
1520
1521 (defvar gnus-newsgroup-prepared nil
1522   "Whether the current group has been prepared properly.")
1523
1524 (defvar gnus-newsgroup-ancient nil
1525   "List of `gnus-fetch-old-headers' articles in the current newsgroup.")
1526
1527 (defvar gnus-newsgroup-sparse nil)
1528
1529 (defvar gnus-current-article nil)
1530 (defvar gnus-article-current nil)
1531 (defvar gnus-current-headers nil)
1532 (defvar gnus-have-all-headers nil)
1533 (defvar gnus-last-article nil)
1534 (defvar gnus-newsgroup-history nil)
1535 (defvar gnus-newsgroup-charset nil)
1536 (defvar gnus-newsgroup-ephemeral-charset nil)
1537 (defvar gnus-newsgroup-ephemeral-ignored-charsets nil)
1538
1539 (defvar gnus-article-before-search nil)
1540
1541 (defvar gnus-summary-local-variables
1542   '(gnus-newsgroup-name
1543     gnus-newsgroup-begin gnus-newsgroup-end
1544     gnus-newsgroup-last-rmail gnus-newsgroup-last-mail
1545     gnus-newsgroup-last-folder gnus-newsgroup-last-file
1546     gnus-newsgroup-last-directory
1547     gnus-newsgroup-auto-expire gnus-newsgroup-unreads
1548     gnus-newsgroup-unselected gnus-newsgroup-marked
1549     gnus-newsgroup-spam-marked
1550     gnus-newsgroup-reads gnus-newsgroup-saved
1551     gnus-newsgroup-replied gnus-newsgroup-forwarded
1552     gnus-newsgroup-recent
1553     gnus-newsgroup-expirable
1554     gnus-newsgroup-processable gnus-newsgroup-killed
1555     gnus-newsgroup-downloadable gnus-newsgroup-undownloaded
1556     gnus-newsgroup-unfetched
1557     gnus-newsgroup-unsendable gnus-newsgroup-unseen
1558     gnus-newsgroup-seen gnus-newsgroup-articles
1559     gnus-newsgroup-bookmarks gnus-newsgroup-dormant
1560     gnus-newsgroup-headers gnus-newsgroup-threads
1561     gnus-newsgroup-prepared gnus-summary-highlight-line-function
1562     gnus-current-article gnus-current-headers gnus-have-all-headers
1563     gnus-last-article gnus-article-internal-prepare-hook
1564     gnus-newsgroup-dependencies gnus-newsgroup-selected-overlay
1565     gnus-newsgroup-scored gnus-newsgroup-kill-headers
1566     gnus-thread-expunge-below
1567     gnus-score-alist gnus-current-score-file
1568     (gnus-summary-expunge-below . global)
1569     (gnus-summary-mark-below . global)
1570     (gnus-orphan-score . global)
1571     gnus-newsgroup-active gnus-scores-exclude-files
1572     gnus-newsgroup-history gnus-newsgroup-ancient
1573     gnus-newsgroup-sparse gnus-newsgroup-process-stack
1574     (gnus-newsgroup-adaptive . gnus-use-adaptive-scoring)
1575     gnus-newsgroup-adaptive-score-file (gnus-reffed-article-number . -1)
1576     (gnus-newsgroup-expunged-tally . 0)
1577     gnus-cache-removable-articles gnus-newsgroup-cached
1578     gnus-newsgroup-data gnus-newsgroup-data-reverse
1579     gnus-newsgroup-limit gnus-newsgroup-limits
1580     gnus-newsgroup-charset gnus-newsgroup-display
1581     gnus-summary-use-undownloaded-faces)
1582   "Variables that are buffer-local to the summary buffers.")
1583
1584 (defvar gnus-newsgroup-variables nil
1585   "A list of variables that have separate values in different newsgroups.
1586 A list of newsgroup (summary buffer) local variables, or cons of
1587 variables and their default expressions to be evalled (when the default
1588 values are not nil), that should be made global while the summary buffer
1589 is active.
1590
1591 Note: The default expressions will be evaluated (using function `eval')
1592 before assignment to the local variable rather than just assigned to it.
1593 If the default expression is the symbol `global', that symbol will not
1594 be evaluated but the global value of the local variable will be used
1595 instead.
1596
1597 These variables can be used to set variables in the group parameters
1598 while still allowing them to affect operations done in other buffers.
1599 For example:
1600
1601 \(setq gnus-newsgroup-variables
1602      '(message-use-followup-to
1603        (gnus-visible-headers .
1604          \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\")))
1605 ")
1606
1607 (eval-when-compile
1608   ;; Bind features so that require will believe that gnus-sum has
1609   ;; already been loaded (avoids infinite recursion)
1610   (let ((features (cons 'gnus-sum features)))
1611     (require 'gnus-art)))
1612
1613 ;; MIME stuff.
1614
1615 (defvar gnus-decode-encoded-word-methods
1616   '(mail-decode-encoded-word-string)
1617   "List of methods used to decode encoded words.
1618
1619 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
1620 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
1621 \(REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
1622 whose names match REGEXP.
1623
1624 For example:
1625 \((\"chinese\" . gnus-decode-encoded-word-string-by-guess)
1626  mail-decode-encoded-word-string
1627  (\"chinese\" . rfc1843-decode-string))")
1628
1629 (defvar gnus-decode-encoded-word-methods-cache nil)
1630
1631 (defun gnus-multi-decode-encoded-word-string (string)
1632   "Apply the functions from `gnus-encoded-word-methods' that match."
1633   (unless (and gnus-decode-encoded-word-methods-cache
1634                (eq gnus-newsgroup-name
1635                    (car gnus-decode-encoded-word-methods-cache)))
1636     (setq gnus-decode-encoded-word-methods-cache (list gnus-newsgroup-name))
1637     (dolist (method gnus-decode-encoded-word-methods)
1638       (if (symbolp method)
1639           (nconc gnus-decode-encoded-word-methods-cache (list method))
1640         (if (and gnus-newsgroup-name
1641                  (string-match (car method) gnus-newsgroup-name))
1642             (nconc gnus-decode-encoded-word-methods-cache
1643                    (list (cdr method)))))))
1644   (dolist (method (cdr gnus-decode-encoded-word-methods-cache) string)
1645     (setq string (funcall method string))))
1646
1647 ;; Subject simplification.
1648
1649 (defun gnus-simplify-whitespace (str)
1650   "Remove excessive whitespace from STR."
1651   ;; Multiple spaces.
1652   (while (string-match "[ \t][ \t]+" str)
1653     (setq str (concat (substring str 0 (match-beginning 0))
1654                         " "
1655                         (substring str (match-end 0)))))
1656   ;; Leading spaces.
1657   (when (string-match "^[ \t]+" str)
1658     (setq str (substring str (match-end 0))))
1659   ;; Trailing spaces.
1660   (when (string-match "[ \t]+$" str)
1661     (setq str (substring str 0 (match-beginning 0))))
1662   str)
1663
1664 (defun gnus-simplify-all-whitespace (str)
1665   "Remove all whitespace from STR."
1666   (while (string-match "[ \t\n]+" str)
1667     (setq str (replace-match "" nil nil str)))
1668   str)
1669
1670 (defsubst gnus-simplify-subject-re (subject)
1671   "Remove \"Re:\" from subject lines."
1672   (if (string-match message-subject-re-regexp subject)
1673       (substring subject (match-end 0))
1674     subject))
1675
1676 (defun gnus-simplify-subject (subject &optional re-only)
1677   "Remove `Re:' and words in parentheses.
1678 If RE-ONLY is non-nil, strip leading `Re:'s only."
1679   (let ((case-fold-search t))           ;Ignore case.
1680     ;; Remove `Re:', `Re^N:', `Re(n)', and `Re[n]:'.
1681     (when (string-match "\\`\\(re\\([[(^][0-9]+[])]?\\)?:[ \t]*\\)+" subject)
1682       (setq subject (substring subject (match-end 0))))
1683     ;; Remove uninteresting prefixes.
1684     (when (and (not re-only)
1685                gnus-simplify-ignored-prefixes
1686                (string-match gnus-simplify-ignored-prefixes subject))
1687       (setq subject (substring subject (match-end 0))))
1688     ;; Remove words in parentheses from end.
1689     (unless re-only
1690       (while (string-match "[ \t\n]*([^()]*)[ \t\n]*\\'" subject)
1691         (setq subject (substring subject 0 (match-beginning 0)))))
1692     ;; Return subject string.
1693     subject))
1694
1695 ;; Remove any leading "re:"s, any trailing paren phrases, and simplify
1696 ;; all whitespace.
1697 (defsubst gnus-simplify-buffer-fuzzy-step (regexp &optional newtext)
1698   (goto-char (point-min))
1699   (while (re-search-forward regexp nil t)
1700     (replace-match (or newtext ""))))
1701
1702 (defun gnus-simplify-buffer-fuzzy ()
1703   "Simplify string in the buffer fuzzily.
1704 The string in the accessible portion of the current buffer is simplified.
1705 It is assumed to be a single-line subject.
1706 Whitespace is generally cleaned up, and miscellaneous leading/trailing
1707 matter is removed.  Additional things can be deleted by setting
1708 `gnus-simplify-subject-fuzzy-regexp'."
1709   (let ((case-fold-search t)
1710         (modified-tick))
1711     (gnus-simplify-buffer-fuzzy-step "\t" " ")
1712
1713     (while (not (eq modified-tick (buffer-modified-tick)))
1714       (setq modified-tick (buffer-modified-tick))
1715       (cond
1716        ((listp gnus-simplify-subject-fuzzy-regexp)
1717         (mapc 'gnus-simplify-buffer-fuzzy-step
1718               gnus-simplify-subject-fuzzy-regexp))
1719        (gnus-simplify-subject-fuzzy-regexp
1720         (gnus-simplify-buffer-fuzzy-step gnus-simplify-subject-fuzzy-regexp)))
1721       (gnus-simplify-buffer-fuzzy-step "^ *\\[[-+?*!][-+?*!]\\] *")
1722       (gnus-simplify-buffer-fuzzy-step
1723        "^ *\\(re\\|fw\\|fwd\\)[[{(^0-9]*[])}]?[:;] *")
1724       (gnus-simplify-buffer-fuzzy-step "^[[].*:\\( .*\\)[]]$" "\\1"))
1725
1726     (gnus-simplify-buffer-fuzzy-step " *[[{(][^()\n]*[]})] *$")
1727     (gnus-simplify-buffer-fuzzy-step "  +" " ")
1728     (gnus-simplify-buffer-fuzzy-step " $")
1729     (gnus-simplify-buffer-fuzzy-step "^ +")))
1730
1731 (defun gnus-simplify-subject-fuzzy (subject)
1732   "Simplify a subject string fuzzily.
1733 See `gnus-simplify-buffer-fuzzy' for details."
1734   (save-excursion
1735     (gnus-set-work-buffer)
1736     (let ((case-fold-search t))
1737       ;; Remove uninteresting prefixes.
1738       (when (and gnus-simplify-ignored-prefixes
1739                  (string-match gnus-simplify-ignored-prefixes subject))
1740         (setq subject (substring subject (match-end 0))))
1741       (insert subject)
1742       (inline (gnus-simplify-buffer-fuzzy))
1743       (buffer-string))))
1744
1745 (defsubst gnus-simplify-subject-fully (subject)
1746   "Simplify a subject string according to `gnus-summary-gather-subject-limit'."
1747   (cond
1748    (gnus-simplify-subject-functions
1749     (gnus-map-function gnus-simplify-subject-functions subject))
1750    ((null gnus-summary-gather-subject-limit)
1751     (gnus-simplify-subject-re subject))
1752    ((eq gnus-summary-gather-subject-limit 'fuzzy)
1753     (gnus-simplify-subject-fuzzy subject))
1754    ((numberp gnus-summary-gather-subject-limit)
1755     (truncate-string-to-width (gnus-simplify-subject-re subject)
1756                               gnus-summary-gather-subject-limit))
1757    (t
1758     subject)))
1759
1760 (defsubst gnus-subject-equal (s1 s2 &optional simple-first)
1761   "Check whether two subjects are equal.
1762 If optional argument SIMPLE-FIRST is t, first argument is already
1763 simplified."
1764   (cond
1765    ((null simple-first)
1766     (equal (gnus-simplify-subject-fully s1)
1767            (gnus-simplify-subject-fully s2)))
1768    (t
1769     (equal s1
1770            (gnus-simplify-subject-fully s2)))))
1771
1772 (defun gnus-summary-bubble-group ()
1773   "Increase the score of the current group.
1774 This is a handy function to add to `gnus-summary-exit-hook' to
1775 increase the score of each group you read."
1776   (gnus-group-add-score gnus-newsgroup-name))
1777
1778 \f
1779 ;;;
1780 ;;; Gnus summary mode
1781 ;;;
1782
1783 (put 'gnus-summary-mode 'mode-class 'special)
1784
1785 (defvar gnus-article-commands-menu)
1786
1787 ;; Non-orthogonal keys
1788
1789 (gnus-define-keys gnus-summary-mode-map
1790   " " gnus-summary-next-page
1791   "\177" gnus-summary-prev-page
1792   [delete] gnus-summary-prev-page
1793   [backspace] gnus-summary-prev-page
1794   "\r" gnus-summary-scroll-up
1795   "\M-\r" gnus-summary-scroll-down
1796   "n" gnus-summary-next-unread-article
1797   "p" gnus-summary-prev-unread-article
1798   "N" gnus-summary-next-article
1799   "P" gnus-summary-prev-article
1800   "\M-\C-n" gnus-summary-next-same-subject
1801   "\M-\C-p" gnus-summary-prev-same-subject
1802   "\M-n" gnus-summary-next-unread-subject
1803   "\M-p" gnus-summary-prev-unread-subject
1804   "." gnus-summary-first-unread-article
1805   "," gnus-summary-best-unread-article
1806   "\M-s" gnus-summary-search-article-forward
1807   "\M-r" gnus-summary-search-article-backward
1808   "\M-S" gnus-summary-repeat-search-article-forward
1809   "\M-R" gnus-summary-repeat-search-article-backward
1810   "<" gnus-summary-beginning-of-article
1811   ">" gnus-summary-end-of-article
1812   "j" gnus-summary-goto-article
1813   "^" gnus-summary-refer-parent-article
1814   "\M-^" gnus-summary-refer-article
1815   "u" gnus-summary-tick-article-forward
1816   "!" gnus-summary-tick-article-forward
1817   "U" gnus-summary-tick-article-backward
1818   "d" gnus-summary-mark-as-read-forward
1819   "D" gnus-summary-mark-as-read-backward
1820   "E" gnus-summary-mark-as-expirable
1821   "\M-u" gnus-summary-clear-mark-forward
1822   "\M-U" gnus-summary-clear-mark-backward
1823   "k" gnus-summary-kill-same-subject-and-select
1824   "\C-k" gnus-summary-kill-same-subject
1825   "\M-\C-k" gnus-summary-kill-thread
1826   "\M-\C-l" gnus-summary-lower-thread
1827   "e" gnus-summary-edit-article
1828   "#" gnus-summary-mark-as-processable
1829   "\M-#" gnus-summary-unmark-as-processable
1830   "\M-\C-t" gnus-summary-toggle-threads
1831   "\M-\C-s" gnus-summary-show-thread
1832   "\M-\C-h" gnus-summary-hide-thread
1833   "\M-\C-f" gnus-summary-next-thread
1834   "\M-\C-b" gnus-summary-prev-thread
1835   [(meta down)] gnus-summary-next-thread
1836   [(meta up)] gnus-summary-prev-thread
1837   "\M-\C-u" gnus-summary-up-thread
1838   "\M-\C-d" gnus-summary-down-thread
1839   "&" gnus-summary-execute-command
1840   "c" gnus-summary-catchup-and-exit
1841   "\C-w" gnus-summary-mark-region-as-read
1842   "\C-t" gnus-summary-toggle-truncation
1843   "?" gnus-summary-mark-as-dormant
1844   "\C-c\M-\C-s" gnus-summary-limit-include-expunged
1845   "\C-c\C-s\C-n" gnus-summary-sort-by-number
1846   "\C-c\C-s\C-m\C-n" gnus-summary-sort-by-most-recent-number
1847   "\C-c\C-s\C-l" gnus-summary-sort-by-lines
1848   "\C-c\C-s\C-c" gnus-summary-sort-by-chars
1849   "\C-c\C-s\C-a" gnus-summary-sort-by-author
1850   "\C-c\C-s\C-t" gnus-summary-sort-by-recipient
1851   "\C-c\C-s\C-s" gnus-summary-sort-by-subject
1852   "\C-c\C-s\C-d" gnus-summary-sort-by-date
1853   "\C-c\C-s\C-m\C-d" gnus-summary-sort-by-most-recent-date
1854   "\C-c\C-s\C-i" gnus-summary-sort-by-score
1855   "\C-c\C-s\C-o" gnus-summary-sort-by-original
1856   "\C-c\C-s\C-r" gnus-summary-sort-by-random
1857   "=" gnus-summary-expand-window
1858   "\C-x\C-s" gnus-summary-reselect-current-group
1859   "\M-g" gnus-summary-rescan-group
1860   "\C-c\C-r" gnus-summary-caesar-message
1861   "f" gnus-summary-followup
1862   "F" gnus-summary-followup-with-original
1863   "C" gnus-summary-cancel-article
1864   "r" gnus-summary-reply
1865   "R" gnus-summary-reply-with-original
1866   "\C-c\C-f" gnus-summary-mail-forward
1867   "o" gnus-summary-save-article
1868   "\C-o" gnus-summary-save-article-mail
1869   "|" gnus-summary-pipe-output
1870   "\M-k" gnus-summary-edit-local-kill
1871   "\M-K" gnus-summary-edit-global-kill
1872   ;; "V" gnus-version
1873   "\C-c\C-d" gnus-summary-describe-group
1874   "q" gnus-summary-exit
1875   "Q" gnus-summary-exit-no-update
1876   "\C-c\C-i" gnus-info-find-node
1877   gnus-mouse-2 gnus-mouse-pick-article
1878   [follow-link] mouse-face
1879   "m" gnus-summary-mail-other-window
1880   "a" gnus-summary-post-news
1881   "x" gnus-summary-limit-to-unread
1882   "s" gnus-summary-isearch-article
1883   "t" gnus-summary-toggle-header
1884   "g" gnus-summary-show-article
1885   "l" gnus-summary-goto-last-article
1886   "\C-c\C-v\C-v" gnus-uu-decode-uu-view
1887   "\C-d" gnus-summary-enter-digest-group
1888   "\M-\C-d" gnus-summary-read-document
1889   "\M-\C-e" gnus-summary-edit-parameters
1890   "\M-\C-a" gnus-summary-customize-parameters
1891   "\C-c\C-b" gnus-bug
1892   "*" gnus-cache-enter-article
1893   "\M-*" gnus-cache-remove-article
1894   "\M-&" gnus-summary-universal-argument
1895   "\C-l" gnus-recenter
1896   "I" gnus-summary-increase-score
1897   "L" gnus-summary-lower-score
1898   "\M-i" gnus-symbolic-argument
1899   "h" gnus-summary-select-article-buffer
1900
1901   "b" gnus-article-view-part
1902   "\M-t" gnus-summary-toggle-display-buttonized
1903
1904   "V" gnus-summary-score-map
1905   "X" gnus-uu-extract-map
1906   "S" gnus-summary-send-map)
1907
1908 ;; Sort of orthogonal keymap
1909 (gnus-define-keys (gnus-summary-mark-map "M" gnus-summary-mode-map)
1910   "t" gnus-summary-tick-article-forward
1911   "!" gnus-summary-tick-article-forward
1912   "d" gnus-summary-mark-as-read-forward
1913   "r" gnus-summary-mark-as-read-forward
1914   "c" gnus-summary-clear-mark-forward
1915   " " gnus-summary-clear-mark-forward
1916   "e" gnus-summary-mark-as-expirable
1917   "x" gnus-summary-mark-as-expirable
1918   "?" gnus-summary-mark-as-dormant
1919   "b" gnus-summary-set-bookmark
1920   "B" gnus-summary-remove-bookmark
1921   "#" gnus-summary-mark-as-processable
1922   "\M-#" gnus-summary-unmark-as-processable
1923   "S" gnus-summary-limit-include-expunged
1924   "C" gnus-summary-catchup
1925   "H" gnus-summary-catchup-to-here
1926   "h" gnus-summary-catchup-from-here
1927   "\C-c" gnus-summary-catchup-all
1928   "k" gnus-summary-kill-same-subject-and-select
1929   "K" gnus-summary-kill-same-subject
1930   "P" gnus-uu-mark-map)
1931
1932 (gnus-define-keys (gnus-summary-mscore-map "V" gnus-summary-mark-map)
1933   "c" gnus-summary-clear-above
1934   "u" gnus-summary-tick-above
1935   "m" gnus-summary-mark-above
1936   "k" gnus-summary-kill-below)
1937
1938 (gnus-define-keys (gnus-summary-limit-map "/" gnus-summary-mode-map)
1939   "/" gnus-summary-limit-to-subject
1940   "n" gnus-summary-limit-to-articles
1941   "b" gnus-summary-limit-to-bodies
1942   "h" gnus-summary-limit-to-headers
1943   "w" gnus-summary-pop-limit
1944   "s" gnus-summary-limit-to-subject
1945   "a" gnus-summary-limit-to-author
1946   "u" gnus-summary-limit-to-unread
1947   "m" gnus-summary-limit-to-marks
1948   "M" gnus-summary-limit-exclude-marks
1949   "v" gnus-summary-limit-to-score
1950   "*" gnus-summary-limit-include-cached
1951   "D" gnus-summary-limit-include-dormant
1952   "T" gnus-summary-limit-include-thread
1953   "d" gnus-summary-limit-exclude-dormant
1954   "t" gnus-summary-limit-to-age
1955   "." gnus-summary-limit-to-unseen
1956   "x" gnus-summary-limit-to-extra
1957   "p" gnus-summary-limit-to-display-predicate
1958   "E" gnus-summary-limit-include-expunged
1959   "c" gnus-summary-limit-exclude-childless-dormant
1960   "C" gnus-summary-limit-mark-excluded-as-read
1961   "o" gnus-summary-insert-old-articles
1962   "N" gnus-summary-insert-new-articles
1963   "S" gnus-summary-limit-to-singletons
1964   "r" gnus-summary-limit-to-replied
1965   "R" gnus-summary-limit-to-recipient
1966   "A" gnus-summary-limit-to-address)
1967
1968 (gnus-define-keys (gnus-summary-goto-map "G" gnus-summary-mode-map)
1969   "n" gnus-summary-next-unread-article
1970   "p" gnus-summary-prev-unread-article
1971   "N" gnus-summary-next-article
1972   "P" gnus-summary-prev-article
1973   "\C-n" gnus-summary-next-same-subject
1974   "\C-p" gnus-summary-prev-same-subject
1975   "\M-n" gnus-summary-next-unread-subject
1976   "\M-p" gnus-summary-prev-unread-subject
1977   "f" gnus-summary-first-unread-article
1978   "b" gnus-summary-best-unread-article
1979   "j" gnus-summary-goto-article
1980   "g" gnus-summary-goto-subject
1981   "l" gnus-summary-goto-last-article
1982   "o" gnus-summary-pop-article)
1983
1984 (gnus-define-keys (gnus-summary-thread-map "T" gnus-summary-mode-map)
1985   "k" gnus-summary-kill-thread
1986   "E" gnus-summary-expire-thread
1987   "l" gnus-summary-lower-thread
1988   "i" gnus-summary-raise-thread
1989   "T" gnus-summary-toggle-threads
1990   "t" gnus-summary-rethread-current
1991   "^" gnus-summary-reparent-thread
1992   "\M-^" gnus-summary-reparent-children
1993   "s" gnus-summary-show-thread
1994   "S" gnus-summary-show-all-threads
1995   "h" gnus-summary-hide-thread
1996   "H" gnus-summary-hide-all-threads
1997   "n" gnus-summary-next-thread
1998   "p" gnus-summary-prev-thread
1999   "u" gnus-summary-up-thread
2000   "o" gnus-summary-top-thread
2001   "d" gnus-summary-down-thread
2002   "#" gnus-uu-mark-thread
2003   "\M-#" gnus-uu-unmark-thread)
2004
2005 (gnus-define-keys (gnus-summary-buffer-map "Y" gnus-summary-mode-map)
2006   "g" gnus-summary-prepare
2007   "c" gnus-summary-insert-cached-articles
2008   "d" gnus-summary-insert-dormant-articles
2009   "t" gnus-summary-insert-ticked-articles)
2010
2011 (gnus-define-keys (gnus-summary-exit-map "Z" gnus-summary-mode-map)
2012   "c" gnus-summary-catchup-and-exit
2013   "C" gnus-summary-catchup-all-and-exit
2014   "E" gnus-summary-exit-no-update
2015   "Q" gnus-summary-exit
2016   "Z" gnus-summary-exit
2017   "n" gnus-summary-catchup-and-goto-next-group
2018   "p" gnus-summary-catchup-and-goto-prev-group
2019   "R" gnus-summary-reselect-current-group
2020   "G" gnus-summary-rescan-group
2021   "N" gnus-summary-next-group
2022   "s" gnus-summary-save-newsrc
2023   "P" gnus-summary-prev-group)
2024
2025 (gnus-define-keys (gnus-summary-article-map "A" gnus-summary-mode-map)
2026   " " gnus-summary-next-page
2027   "n" gnus-summary-next-page
2028   "\177" gnus-summary-prev-page
2029   [delete] gnus-summary-prev-page
2030   "p" gnus-summary-prev-page
2031   "\r" gnus-summary-scroll-up
2032   "\M-\r" gnus-summary-scroll-down
2033   "<" gnus-summary-beginning-of-article
2034   ">" gnus-summary-end-of-article
2035   "b" gnus-summary-beginning-of-article
2036   "e" gnus-summary-end-of-article
2037   "^" gnus-summary-refer-parent-article
2038   "r" gnus-summary-refer-parent-article
2039   "D" gnus-summary-enter-digest-group
2040   "R" gnus-summary-refer-references
2041   "T" gnus-summary-refer-thread
2042   "g" gnus-summary-show-article
2043   "s" gnus-summary-isearch-article
2044   "P" gnus-summary-print-article
2045   "S" gnus-sticky-article
2046   "M" gnus-mailing-list-insinuate
2047   "t" gnus-article-babel)
2048
2049 (gnus-define-keys (gnus-summary-wash-map "W" gnus-summary-mode-map)
2050   "b" gnus-article-add-buttons
2051   "B" gnus-article-add-buttons-to-head
2052   "o" gnus-article-treat-overstrike
2053   "e" gnus-article-emphasize
2054   "w" gnus-article-fill-cited-article
2055   "Q" gnus-article-fill-long-lines
2056   "L" gnus-article-toggle-truncate-lines
2057   "C" gnus-article-capitalize-sentences
2058   "c" gnus-article-remove-cr
2059   "q" gnus-article-de-quoted-unreadable
2060   "6" gnus-article-de-base64-unreadable
2061   "Z" gnus-article-decode-HZ
2062   "A" gnus-article-treat-ansi-sequences
2063   "h" gnus-article-wash-html
2064   "u" gnus-article-unsplit-urls
2065   "s" gnus-summary-force-verify-and-decrypt
2066   "f" gnus-article-display-x-face
2067   "l" gnus-summary-stop-page-breaking
2068   "r" gnus-summary-caesar-message
2069   "m" gnus-summary-morse-message
2070   "t" gnus-summary-toggle-header
2071   "g" gnus-treat-smiley
2072   "v" gnus-summary-verbose-headers
2073   "a" gnus-article-strip-headers-in-body ;; mnemonic: wash archive
2074   "p" gnus-article-verify-x-pgp-sig
2075   "d" gnus-article-treat-dumbquotes
2076   "i" gnus-summary-idna-message)
2077
2078 (gnus-define-keys (gnus-summary-wash-deuglify-map "Y" gnus-summary-wash-map)
2079   ;; mnemonic: deuglif*Y*
2080   "u" gnus-article-outlook-unwrap-lines
2081   "a" gnus-article-outlook-repair-attribution
2082   "c" gnus-article-outlook-rearrange-citation
2083   "f" gnus-article-outlook-deuglify-article) ;; mnemonic: full deuglify
2084
2085 (gnus-define-keys (gnus-summary-wash-hide-map "W" gnus-summary-wash-map)
2086   "a" gnus-article-hide
2087   "h" gnus-article-hide-headers
2088   "b" gnus-article-hide-boring-headers
2089   "s" gnus-article-hide-signature
2090   "c" gnus-article-hide-citation
2091   "C" gnus-article-hide-citation-in-followups
2092   "l" gnus-article-hide-list-identifiers
2093   "B" gnus-article-strip-banner
2094   "P" gnus-article-hide-pem
2095   "\C-c" gnus-article-hide-citation-maybe)
2096
2097 (gnus-define-keys (gnus-summary-wash-highlight-map "H" gnus-summary-wash-map)
2098   "a" gnus-article-highlight
2099   "h" gnus-article-highlight-headers
2100   "c" gnus-article-highlight-citation
2101   "s" gnus-article-highlight-signature)
2102
2103 (gnus-define-keys (gnus-summary-wash-header-map "G" gnus-summary-wash-map)
2104   "f" gnus-article-treat-fold-headers
2105   "u" gnus-article-treat-unfold-headers
2106   "n" gnus-article-treat-fold-newsgroups)
2107
2108 (gnus-define-keys (gnus-summary-wash-display-map "D" gnus-summary-wash-map)
2109   "x" gnus-article-display-x-face
2110   "d" gnus-article-display-face
2111   "s" gnus-treat-smiley
2112   "D" gnus-article-remove-images
2113   "f" gnus-treat-from-picon
2114   "m" gnus-treat-mail-picon
2115   "n" gnus-treat-newsgroups-picon)
2116
2117 (gnus-define-keys (gnus-summary-wash-mime-map "M" gnus-summary-wash-map)
2118   "w" gnus-article-decode-mime-words
2119   "c" gnus-article-decode-charset
2120   "v" gnus-mime-view-all-parts
2121   "b" gnus-article-view-part)
2122
2123 (gnus-define-keys (gnus-summary-wash-time-map "T" gnus-summary-wash-map)
2124   "z" gnus-article-date-ut
2125   "u" gnus-article-date-ut
2126   "l" gnus-article-date-local
2127   "p" gnus-article-date-english
2128   "e" gnus-article-date-lapsed
2129   "o" gnus-article-date-original
2130   "i" gnus-article-date-iso8601
2131   "s" gnus-article-date-user)
2132
2133 (gnus-define-keys (gnus-summary-wash-empty-map "E" gnus-summary-wash-map)
2134   "t" gnus-article-remove-trailing-blank-lines
2135   "l" gnus-article-strip-leading-blank-lines
2136   "m" gnus-article-strip-multiple-blank-lines
2137   "a" gnus-article-strip-blank-lines
2138   "A" gnus-article-strip-all-blank-lines
2139   "s" gnus-article-strip-leading-space
2140   "e" gnus-article-strip-trailing-space
2141   "w" gnus-article-remove-leading-whitespace)
2142
2143 (gnus-define-keys (gnus-summary-help-map "H" gnus-summary-mode-map)
2144   "v" gnus-version
2145   "f" gnus-summary-fetch-faq
2146   "d" gnus-summary-describe-group
2147   "h" gnus-summary-describe-briefly
2148   "i" gnus-info-find-node
2149   "c" gnus-group-fetch-charter
2150   "C" gnus-group-fetch-control)
2151
2152 (gnus-define-keys (gnus-summary-backend-map "B" gnus-summary-mode-map)
2153   "e" gnus-summary-expire-articles
2154   "\M-\C-e" gnus-summary-expire-articles-now
2155   "\177" gnus-summary-delete-article
2156   [delete] gnus-summary-delete-article
2157   [backspace] gnus-summary-delete-article
2158   "m" gnus-summary-move-article
2159   "r" gnus-summary-respool-article
2160   "w" gnus-summary-edit-article
2161   "c" gnus-summary-copy-article
2162   "B" gnus-summary-crosspost-article
2163   "q" gnus-summary-respool-query
2164   "t" gnus-summary-respool-trace
2165   "i" gnus-summary-import-article
2166   "I" gnus-summary-create-article
2167   "p" gnus-summary-article-posted-p)
2168
2169 (gnus-define-keys (gnus-summary-save-map "O" gnus-summary-mode-map)
2170   "o" gnus-summary-save-article
2171   "m" gnus-summary-save-article-mail
2172   "F" gnus-summary-write-article-file
2173   "r" gnus-summary-save-article-rmail
2174   "f" gnus-summary-save-article-file
2175   "b" gnus-summary-save-article-body-file
2176   "B" gnus-summary-write-article-body-file
2177   "h" gnus-summary-save-article-folder
2178   "v" gnus-summary-save-article-vm
2179   "p" gnus-summary-pipe-output
2180   "P" gnus-summary-muttprint)
2181
2182 (gnus-define-keys (gnus-summary-mime-map "K" gnus-summary-mode-map)
2183   "b" gnus-summary-display-buttonized
2184   "m" gnus-summary-repair-multipart
2185   "v" gnus-article-view-part
2186   "o" gnus-article-save-part
2187   "O" gnus-article-save-part-and-strip
2188   "r" gnus-article-replace-part
2189   "d" gnus-article-delete-part
2190   "t" gnus-article-view-part-as-type
2191   "j" gnus-article-jump-to-part
2192   "c" gnus-article-copy-part
2193   "C" gnus-article-view-part-as-charset
2194   "e" gnus-article-view-part-externally
2195   "H" gnus-article-browse-html-article
2196   "E" gnus-article-encrypt-body
2197   "i" gnus-article-inline-part
2198   "|" gnus-article-pipe-part)
2199
2200 (gnus-define-keys (gnus-uu-mark-map "P" gnus-summary-mark-map)
2201   "p" gnus-summary-mark-as-processable
2202   "u" gnus-summary-unmark-as-processable
2203   "U" gnus-summary-unmark-all-processable
2204   "v" gnus-uu-mark-over
2205   "s" gnus-uu-mark-series
2206   "r" gnus-uu-mark-region
2207   "g" gnus-uu-unmark-region
2208   "R" gnus-uu-mark-by-regexp
2209   "G" gnus-uu-unmark-by-regexp
2210   "t" gnus-uu-mark-thread
2211   "T" gnus-uu-unmark-thread
2212   "a" gnus-uu-mark-all
2213   "b" gnus-uu-mark-buffer
2214   "S" gnus-uu-mark-sparse
2215   "k" gnus-summary-kill-process-mark
2216   "y" gnus-summary-yank-process-mark
2217   "w" gnus-summary-save-process-mark
2218   "i" gnus-uu-invert-processable)
2219
2220 (gnus-define-keys (gnus-uu-extract-map "X" gnus-summary-mode-map)
2221   ;;"x" gnus-uu-extract-any
2222   "m" gnus-summary-save-parts
2223   "u" gnus-uu-decode-uu
2224   "U" gnus-uu-decode-uu-and-save
2225   "s" gnus-uu-decode-unshar
2226   "S" gnus-uu-decode-unshar-and-save
2227   "o" gnus-uu-decode-save
2228   "O" gnus-uu-decode-save
2229   "b" gnus-uu-decode-binhex
2230   "B" gnus-uu-decode-binhex
2231   "Y" gnus-uu-decode-yenc
2232   "p" gnus-uu-decode-postscript
2233   "P" gnus-uu-decode-postscript-and-save)
2234
2235 (gnus-define-keys
2236     (gnus-uu-extract-view-map "v" gnus-uu-extract-map)
2237   "u" gnus-uu-decode-uu-view
2238   "U" gnus-uu-decode-uu-and-save-view
2239   "s" gnus-uu-decode-unshar-view
2240   "S" gnus-uu-decode-unshar-and-save-view
2241   "o" gnus-uu-decode-save-view
2242   "O" gnus-uu-decode-save-view
2243   "b" gnus-uu-decode-binhex-view
2244   "B" gnus-uu-decode-binhex-view
2245   "p" gnus-uu-decode-postscript-view
2246   "P" gnus-uu-decode-postscript-and-save-view)
2247
2248 (defvar gnus-article-post-menu nil)
2249
2250 (defconst gnus-summary-menu-maxlen 20)
2251
2252 (defun gnus-summary-menu-split (menu)
2253   ;; If we have lots of elements, divide them into groups of 20
2254   ;; and make a pane (or submenu) for each one.
2255   (if (> (length menu) (/ (* gnus-summary-menu-maxlen 3) 2))
2256       (let ((menu menu) sublists next
2257             (i 1))
2258         (while menu
2259           ;; Pull off the next gnus-summary-menu-maxlen elements
2260           ;; and make them the next element of sublist.
2261           (setq next (nthcdr gnus-summary-menu-maxlen menu))
2262           (if next
2263               (setcdr (nthcdr (1- gnus-summary-menu-maxlen) menu)
2264                       nil))
2265           (setq sublists (cons (cons (format "%s ... %s" (aref (car menu) 0)
2266                                              (aref (car (last menu)) 0)) menu)
2267                                sublists))
2268           (setq i (1+ i))
2269           (setq menu next))
2270         (nreverse sublists))
2271     ;; Few elements--put them all in one pane.
2272     menu))
2273
2274 (defun gnus-summary-make-menu-bar ()
2275   (gnus-turn-off-edit-menu 'summary)
2276
2277   (unless (boundp 'gnus-summary-misc-menu)
2278
2279     (easy-menu-define
2280       gnus-summary-kill-menu gnus-summary-mode-map ""
2281       (cons
2282        "Score"
2283        (nconc
2284         (list
2285          ["Customize" gnus-score-customize t])
2286         (gnus-make-score-map 'increase)
2287         (gnus-make-score-map 'lower)
2288         '(("Mark"
2289            ["Kill below" gnus-summary-kill-below t]
2290            ["Mark above" gnus-summary-mark-above t]
2291            ["Tick above" gnus-summary-tick-above t]
2292            ["Clear above" gnus-summary-clear-above t])
2293           ["Current score" gnus-summary-current-score t]
2294           ["Set score" gnus-summary-set-score t]
2295           ["Switch current score file..." gnus-score-change-score-file t]
2296           ["Set mark below..." gnus-score-set-mark-below t]
2297           ["Set expunge below..." gnus-score-set-expunge-below t]
2298           ["Edit current score file" gnus-score-edit-current-scores t]
2299           ["Edit score file..." gnus-score-edit-file t]
2300           ["Trace score" gnus-score-find-trace t]
2301           ["Find words" gnus-score-find-favourite-words t]
2302           ["Rescore buffer" gnus-summary-rescore t]
2303           ["Increase score..." gnus-summary-increase-score t]
2304           ["Lower score..." gnus-summary-lower-score t]))))
2305
2306     ;; Define both the Article menu in the summary buffer and the
2307     ;; equivalent Commands menu in the article buffer here for
2308     ;; consistency.
2309     (let ((innards
2310            `(("Hide"
2311               ["All" gnus-article-hide t]
2312               ["Headers" gnus-article-hide-headers t]
2313               ["Signature" gnus-article-hide-signature t]
2314               ["Citation" gnus-article-hide-citation t]
2315               ["List identifiers" gnus-article-hide-list-identifiers t]
2316               ["Banner" gnus-article-strip-banner t]
2317               ["Boring headers" gnus-article-hide-boring-headers t])
2318              ("Highlight"
2319               ["All" gnus-article-highlight t]
2320               ["Headers" gnus-article-highlight-headers t]
2321               ["Signature" gnus-article-highlight-signature t]
2322               ["Citation" gnus-article-highlight-citation t])
2323              ("MIME"
2324               ["Words" gnus-article-decode-mime-words t]
2325               ["Charset" gnus-article-decode-charset t]
2326               ["QP" gnus-article-de-quoted-unreadable t]
2327               ["Base64" gnus-article-de-base64-unreadable t]
2328               ["View MIME buttons" gnus-summary-display-buttonized t]
2329               ["View all" gnus-mime-view-all-parts t]
2330               ["Verify and Decrypt" gnus-summary-force-verify-and-decrypt t]
2331               ["Encrypt body" gnus-article-encrypt-body
2332                :active (not (gnus-group-read-only-p))
2333                ,@(if (featurep 'xemacs) nil
2334                    '(:help "Encrypt the message body on disk"))]
2335               ["Extract all parts..." gnus-summary-save-parts t]
2336               ("Multipart"
2337                ["Repair multipart" gnus-summary-repair-multipart t]
2338                ["Pipe part..." gnus-article-pipe-part t]
2339                ["Inline part" gnus-article-inline-part t]
2340                ["View part as type..." gnus-article-view-part-as-type t]
2341                ["Encrypt body" gnus-article-encrypt-body
2342                 :active (not (gnus-group-read-only-p))
2343                ,@(if (featurep 'xemacs) nil
2344                    '(:help "Encrypt the message body on disk"))]
2345                ["View part externally" gnus-article-view-part-externally t]
2346                ["View HTML parts in browser" gnus-article-browse-html-article t]
2347                ["View part with charset..." gnus-article-view-part-as-charset t]
2348                ["Copy part" gnus-article-copy-part t]
2349                ["Save part..." gnus-article-save-part t]
2350                ["View part" gnus-article-view-part t]))
2351              ("Date"
2352               ["Local" gnus-article-date-local t]
2353               ["ISO8601" gnus-article-date-iso8601 t]
2354               ["UT" gnus-article-date-ut t]
2355               ["Original" gnus-article-date-original t]
2356               ["Lapsed" gnus-article-date-lapsed t]
2357               ["User-defined" gnus-article-date-user t])
2358              ("Display"
2359               ["Remove images" gnus-article-remove-images t]
2360               ["Toggle smiley" gnus-treat-smiley t]
2361               ["Show X-Face" gnus-article-display-x-face t]
2362               ["Show picons in From" gnus-treat-from-picon t]
2363               ["Show picons in mail headers" gnus-treat-mail-picon t]
2364               ["Show picons in news headers" gnus-treat-newsgroups-picon t]
2365               ("View as different encoding"
2366                ,@(gnus-summary-menu-split
2367                   (mapcar
2368                    (lambda (cs)
2369                      ;; Since easymenu under Emacs doesn't allow
2370                      ;; lambda forms for menu commands, we should
2371                      ;; provide intern'ed function symbols.
2372                      (let ((command (intern (format "\
2373 gnus-summary-show-article-from-menu-as-charset-%s" cs))))
2374                        (fset command
2375                              `(lambda ()
2376                                 (interactive)
2377                                 (let ((gnus-summary-show-article-charset-alist
2378                                        '((1 . ,cs))))
2379                                   (gnus-summary-show-article 1))))
2380                        `[,(symbol-name cs) ,command t]))
2381                    (sort (if (fboundp 'coding-system-list)
2382                              (coding-system-list)
2383                            (mapcar 'car mm-mime-mule-charset-alist))
2384                          'string<)))))
2385              ("Washing"
2386               ("Remove Blanks"
2387                ["Leading" gnus-article-strip-leading-blank-lines t]
2388                ["Multiple" gnus-article-strip-multiple-blank-lines t]
2389                ["Trailing" gnus-article-remove-trailing-blank-lines t]
2390                ["All of the above" gnus-article-strip-blank-lines t]
2391                ["All" gnus-article-strip-all-blank-lines t]
2392                ["Leading space" gnus-article-strip-leading-space t]
2393                ["Trailing space" gnus-article-strip-trailing-space t]
2394                ["Leading space in headers"
2395                 gnus-article-remove-leading-whitespace t])
2396               ["Overstrike" gnus-article-treat-overstrike t]
2397               ["Dumb quotes" gnus-article-treat-dumbquotes t]
2398               ["Emphasis" gnus-article-emphasize t]
2399               ["Word wrap" gnus-article-fill-cited-article t]
2400               ["Fill long lines" gnus-article-fill-long-lines t]
2401               ["Toggle truncate long lines" gnus-article-toggle-truncate-lines t]
2402               ["Capitalize sentences" gnus-article-capitalize-sentences t]
2403               ["Remove CR" gnus-article-remove-cr t]
2404               ["Quoted-Printable" gnus-article-de-quoted-unreadable t]
2405               ["Base64" gnus-article-de-base64-unreadable t]
2406               ["Rot 13" gnus-summary-caesar-message
2407                ,@(if (featurep 'xemacs) '(t)
2408                    '(:help "\"Caesar rotate\" article by 13"))]
2409               ["De-IDNA" gnus-summary-idna-message t]
2410               ["Morse decode" gnus-summary-morse-message t]
2411               ["Unix pipe..." gnus-summary-pipe-message t]
2412               ["Add buttons" gnus-article-add-buttons t]
2413               ["Add buttons to head" gnus-article-add-buttons-to-head t]
2414               ["Stop page breaking" gnus-summary-stop-page-breaking t]
2415               ["Verbose header" gnus-summary-verbose-headers t]
2416               ["Toggle header" gnus-summary-toggle-header t]
2417               ["Unfold headers" gnus-article-treat-unfold-headers t]
2418               ["Fold newsgroups" gnus-article-treat-fold-newsgroups t]
2419               ["Html" gnus-article-wash-html t]
2420               ["Unsplit URLs" gnus-article-unsplit-urls t]
2421               ["Verify X-PGP-Sig" gnus-article-verify-x-pgp-sig t]
2422               ["Decode HZ" gnus-article-decode-HZ t]
2423               ["ANSI sequences" gnus-article-treat-ansi-sequences t]
2424               ("(Outlook) Deuglify"
2425                ["Unwrap lines" gnus-article-outlook-unwrap-lines t]
2426                ["Repair attribution" gnus-article-outlook-repair-attribution t]
2427                ["Rearrange citation" gnus-article-outlook-rearrange-citation t]
2428                ["Full (Outlook) deuglify"
2429                 gnus-article-outlook-deuglify-article t])
2430               )
2431              ("Output"
2432               ["Save in default format..." gnus-summary-save-article
2433                ,@(if (featurep 'xemacs) '(t)
2434                    '(:help "Save article using default method"))]
2435               ["Save in file..." gnus-summary-save-article-file
2436                ,@(if (featurep 'xemacs) '(t)
2437                    '(:help "Save article in file"))]
2438               ["Save in Unix mail format..." gnus-summary-save-article-mail t]
2439               ["Save in MH folder..." gnus-summary-save-article-folder t]
2440               ["Save in VM folder..." gnus-summary-save-article-vm t]
2441               ["Save in RMAIL mbox..." gnus-summary-save-article-rmail t]
2442               ["Save body in file..." gnus-summary-save-article-body-file t]
2443               ["Pipe through a filter..." gnus-summary-pipe-output t]
2444               ["Print with Muttprint..." gnus-summary-muttprint t]
2445               ["Print" gnus-summary-print-article
2446                ,@(if (featurep 'xemacs) '(t)
2447                    '(:help "Generate and print a PostScript image"))])
2448              ("Copy, move,... (Backend)"
2449               ,@(if (featurep 'xemacs) nil
2450                   '(:help "Copying, moving, expiring articles..."))
2451               ["Respool article..." gnus-summary-respool-article t]
2452               ["Move article..." gnus-summary-move-article
2453                (gnus-check-backend-function
2454                 'request-move-article gnus-newsgroup-name)]
2455               ["Copy article..." gnus-summary-copy-article t]
2456               ["Crosspost article..." gnus-summary-crosspost-article
2457                (gnus-check-backend-function
2458                 'request-replace-article gnus-newsgroup-name)]
2459               ["Import file..." gnus-summary-import-article
2460                (gnus-check-backend-function
2461                 'request-accept-article gnus-newsgroup-name)]
2462               ["Create article..." gnus-summary-create-article
2463                (gnus-check-backend-function
2464                 'request-accept-article gnus-newsgroup-name)]
2465               ["Check if posted" gnus-summary-article-posted-p t]
2466               ["Edit article" gnus-summary-edit-article
2467                (not (gnus-group-read-only-p))]
2468               ["Delete article" gnus-summary-delete-article
2469                (gnus-check-backend-function
2470                 'request-expire-articles gnus-newsgroup-name)]
2471               ["Query respool" gnus-summary-respool-query t]
2472               ["Trace respool" gnus-summary-respool-trace t]
2473               ["Delete expirable articles" gnus-summary-expire-articles-now
2474                (gnus-check-backend-function
2475                 'request-expire-articles gnus-newsgroup-name)])
2476              ("Extract"
2477               ["Uudecode" gnus-uu-decode-uu
2478                ,@(if (featurep 'xemacs) '(t)
2479                    '(:help "Decode uuencoded article(s)"))]
2480               ["Uudecode and save" gnus-uu-decode-uu-and-save t]
2481               ["Unshar" gnus-uu-decode-unshar t]
2482               ["Unshar and save" gnus-uu-decode-unshar-and-save t]
2483               ["Save" gnus-uu-decode-save t]
2484               ["Binhex" gnus-uu-decode-binhex t]
2485               ["Postscript" gnus-uu-decode-postscript t]
2486               ["All MIME parts" gnus-summary-save-parts t])
2487              ("Cache"
2488               ["Enter article" gnus-cache-enter-article t]
2489               ["Remove article" gnus-cache-remove-article t])
2490              ["Translate" gnus-article-babel t]
2491              ["Select article buffer" gnus-summary-select-article-buffer t]
2492              ["Make article buffer sticky" gnus-sticky-article t]
2493              ["Enter digest buffer" gnus-summary-enter-digest-group t]
2494              ["Isearch article..." gnus-summary-isearch-article t]
2495              ["Beginning of the article" gnus-summary-beginning-of-article t]
2496              ["End of the article" gnus-summary-end-of-article t]
2497              ["Fetch parent of article" gnus-summary-refer-parent-article t]
2498              ["Fetch referenced articles" gnus-summary-refer-references t]
2499              ["Fetch current thread" gnus-summary-refer-thread t]
2500              ["Fetch article with id..." gnus-summary-refer-article t]
2501              ["Setup Mailing List Params" gnus-mailing-list-insinuate t]
2502              ["Redisplay" gnus-summary-show-article t]
2503              ["Raw article" gnus-summary-show-raw-article :keys "C-u g"])))
2504       (easy-menu-define
2505         gnus-summary-article-menu gnus-summary-mode-map ""
2506         (cons "Article" innards))
2507
2508       (if (not (keymapp gnus-summary-article-menu))
2509           (easy-menu-define
2510             gnus-article-commands-menu gnus-article-mode-map ""
2511             (cons "Commands" innards))
2512         ;; in Emacs, don't share menu.
2513         (setq gnus-article-commands-menu
2514               (copy-keymap gnus-summary-article-menu))
2515         (define-key gnus-article-mode-map [menu-bar commands]
2516           (cons "Commands" gnus-article-commands-menu))))
2517
2518     (easy-menu-define
2519       gnus-summary-thread-menu gnus-summary-mode-map ""
2520       '("Threads"
2521         ["Find all messages in thread" gnus-summary-refer-thread t]
2522         ["Toggle threading" gnus-summary-toggle-threads t]
2523         ["Hide threads" gnus-summary-hide-all-threads t]
2524         ["Show threads" gnus-summary-show-all-threads t]
2525         ["Hide thread" gnus-summary-hide-thread t]
2526         ["Show thread" gnus-summary-show-thread t]
2527         ["Go to next thread" gnus-summary-next-thread t]
2528         ["Go to previous thread" gnus-summary-prev-thread t]
2529         ["Go down thread" gnus-summary-down-thread t]
2530         ["Go up thread" gnus-summary-up-thread t]
2531         ["Top of thread" gnus-summary-top-thread t]
2532         ["Mark thread as read" gnus-summary-kill-thread t]
2533         ["Mark thread as expired" gnus-summary-expire-thread t]
2534         ["Lower thread score" gnus-summary-lower-thread t]
2535         ["Raise thread score" gnus-summary-raise-thread t]
2536         ["Rethread current" gnus-summary-rethread-current t]))
2537
2538     (easy-menu-define
2539       gnus-summary-post-menu gnus-summary-mode-map ""
2540       `("Post"
2541         ["Send a message (mail or news)" gnus-summary-post-news
2542          ,@(if (featurep 'xemacs) '(t)
2543              '(:help "Compose a new message (mail or news)"))]
2544         ["Followup" gnus-summary-followup
2545          ,@(if (featurep 'xemacs) '(t)
2546              '(:help "Post followup to this article"))]
2547         ["Followup and yank" gnus-summary-followup-with-original
2548          ,@(if (featurep 'xemacs) '(t)
2549              '(:help "Post followup to this article, quoting its contents"))]
2550         ["Supersede article" gnus-summary-supersede-article t]
2551         ["Cancel article" gnus-summary-cancel-article
2552          ,@(if (featurep 'xemacs) '(t)
2553              '(:help "Cancel an article you posted"))]
2554         ["Reply" gnus-summary-reply t]
2555         ["Reply and yank" gnus-summary-reply-with-original t]
2556         ["Wide reply" gnus-summary-wide-reply t]
2557         ["Wide reply and yank" gnus-summary-wide-reply-with-original
2558          ,@(if (featurep 'xemacs) '(t)
2559              '(:help "Mail a reply, quoting this article"))]
2560         ["Very wide reply" gnus-summary-very-wide-reply t]
2561         ["Very wide reply and yank" gnus-summary-very-wide-reply-with-original
2562          ,@(if (featurep 'xemacs) '(t)
2563              '(:help "Mail a very wide reply, quoting this article"))]
2564         ["Mail forward" gnus-summary-mail-forward t]
2565         ["Post forward" gnus-summary-post-forward t]
2566         ["Digest and mail" gnus-uu-digest-mail-forward t]
2567         ["Digest and post" gnus-uu-digest-post-forward t]
2568         ["Resend message" gnus-summary-resend-message t]
2569         ["Resend message edit" gnus-summary-resend-message-edit t]
2570         ["Send bounced mail" gnus-summary-resend-bounced-mail t]
2571         ["Send a mail" gnus-summary-mail-other-window t]
2572         ["Create a local message" gnus-summary-news-other-window t]
2573         ["Uuencode and post" gnus-uu-post-news
2574          ,@(if (featurep 'xemacs) '(t)
2575              '(:help "Post a uuencoded article"))]
2576         ["Followup via news" gnus-summary-followup-to-mail t]
2577         ["Followup via news and yank"
2578          gnus-summary-followup-to-mail-with-original t]
2579         ["Strip signature on reply"
2580          (lambda ()
2581            (interactive)
2582            (if (not (memq message-cite-function
2583                           '(message-cite-original-without-signature
2584                             message-cite-original)))
2585                ;; Stupid workaround for XEmacs not honoring :visible.
2586                (message "Can't toggle this value of `message-cite-function'")
2587              (setq message-cite-function
2588                    (if (eq message-cite-function
2589                            'message-cite-original-without-signature)
2590                        'message-cite-original
2591                      'message-cite-original-without-signature))))
2592          ;; XEmacs barfs on :visible.
2593          ,@(if (featurep 'xemacs) nil
2594              '(:visible (memq message-cite-function
2595                               '(message-cite-original-without-signature
2596                                 message-cite-original))))
2597          :style toggle
2598          :selected (eq message-cite-function
2599                        'message-cite-original-without-signature)
2600          ,@(if (featurep 'xemacs) nil
2601              '(:help "Strip signature from cited article when replying."))]
2602         ;;("Draft"
2603         ;;["Send" gnus-summary-send-draft t]
2604         ;;["Send bounced" gnus-resend-bounced-mail t])
2605         ))
2606
2607     (cond
2608      ((not (keymapp gnus-summary-post-menu))
2609       (setq gnus-article-post-menu gnus-summary-post-menu))
2610      ((not gnus-article-post-menu)
2611       ;; Don't share post menu.
2612       (setq gnus-article-post-menu
2613             (copy-keymap gnus-summary-post-menu))))
2614     (define-key gnus-article-mode-map [menu-bar post]
2615       (cons "Post" gnus-article-post-menu))
2616
2617     (easy-menu-define
2618       gnus-summary-misc-menu gnus-summary-mode-map ""
2619       `("Gnus"
2620         ("Mark Read"
2621          ["Mark as read" gnus-summary-mark-as-read-forward t]
2622          ["Mark same subject and select"
2623           gnus-summary-kill-same-subject-and-select t]
2624          ["Mark same subject" gnus-summary-kill-same-subject t]
2625          ["Catchup" gnus-summary-catchup
2626           ,@(if (featurep 'xemacs) '(t)
2627               '(:help "Mark unread articles in this group as read"))]
2628          ["Catchup all" gnus-summary-catchup-all t]
2629          ["Catchup to here" gnus-summary-catchup-to-here t]
2630          ["Catchup from here" gnus-summary-catchup-from-here t]
2631          ["Catchup region" gnus-summary-mark-region-as-read
2632           (gnus-mark-active-p)]
2633          ["Mark excluded" gnus-summary-limit-mark-excluded-as-read t])
2634         ("Mark Various"
2635          ["Tick" gnus-summary-tick-article-forward t]
2636          ["Mark as dormant" gnus-summary-mark-as-dormant t]
2637          ["Remove marks" gnus-summary-clear-mark-forward t]
2638          ["Set expirable mark" gnus-summary-mark-as-expirable t]
2639          ["Set bookmark" gnus-summary-set-bookmark t]
2640          ["Remove bookmark" gnus-summary-remove-bookmark t])
2641         ("Limit to"
2642          ["Marks..." gnus-summary-limit-to-marks t]
2643          ["Subject..." gnus-summary-limit-to-subject t]
2644          ["Author..." gnus-summary-limit-to-author t]
2645          ["Recipient..." gnus-summary-limit-to-recipient t]
2646          ["Address..." gnus-summary-limit-to-address t]
2647          ["Age..." gnus-summary-limit-to-age t]
2648          ["Extra..." gnus-summary-limit-to-extra t]
2649          ["Score..." gnus-summary-limit-to-score t]
2650          ["Display Predicate" gnus-summary-limit-to-display-predicate t]
2651          ["Unread" gnus-summary-limit-to-unread t]
2652          ["Unseen" gnus-summary-limit-to-unseen t]
2653          ["Singletons" gnus-summary-limit-to-singletons t]
2654          ["Replied" gnus-summary-limit-to-replied t]
2655          ["Non-dormant" gnus-summary-limit-exclude-dormant t]
2656          ["Next or process marked articles" gnus-summary-limit-to-articles t]
2657          ["Pop limit" gnus-summary-pop-limit t]
2658          ["Show dormant" gnus-summary-limit-include-dormant t]
2659          ["Hide childless dormant"
2660           gnus-summary-limit-exclude-childless-dormant t]
2661          ;;["Hide thread" gnus-summary-limit-exclude-thread t]
2662          ["Hide marked" gnus-summary-limit-exclude-marks t]
2663          ["Show expunged" gnus-summary-limit-include-expunged t])
2664         ("Process Mark"
2665          ["Set mark" gnus-summary-mark-as-processable t]
2666          ["Remove mark" gnus-summary-unmark-as-processable t]
2667          ["Remove all marks" gnus-summary-unmark-all-processable t]
2668          ["Invert marks" gnus-uu-invert-processable t]
2669          ["Mark above" gnus-uu-mark-over t]
2670          ["Mark series" gnus-uu-mark-series t]
2671          ["Mark region" gnus-uu-mark-region (gnus-mark-active-p)]
2672          ["Unmark region" gnus-uu-unmark-region (gnus-mark-active-p)]
2673          ["Mark by regexp..." gnus-uu-mark-by-regexp t]
2674          ["Unmark by regexp..." gnus-uu-unmark-by-regexp t]
2675          ["Mark all" gnus-uu-mark-all t]
2676          ["Mark buffer" gnus-uu-mark-buffer t]
2677          ["Mark sparse" gnus-uu-mark-sparse t]
2678          ["Mark thread" gnus-uu-mark-thread t]
2679          ["Unmark thread" gnus-uu-unmark-thread t]
2680          ("Process Mark Sets"
2681           ["Kill" gnus-summary-kill-process-mark t]
2682           ["Yank" gnus-summary-yank-process-mark
2683            gnus-newsgroup-process-stack]
2684           ["Save" gnus-summary-save-process-mark t]
2685           ["Run command on marked..." gnus-summary-universal-argument t]))
2686         ("Registry Marks")
2687         ("Scroll article"
2688          ["Page forward" gnus-summary-next-page
2689           ,@(if (featurep 'xemacs) '(t)
2690               '(:help "Show next page of article"))]
2691          ["Page backward" gnus-summary-prev-page
2692           ,@(if (featurep 'xemacs) '(t)
2693               '(:help "Show previous page of article"))]
2694          ["Line forward" gnus-summary-scroll-up t])
2695         ("Move"
2696          ["Next unread article" gnus-summary-next-unread-article t]
2697          ["Previous unread article" gnus-summary-prev-unread-article t]
2698          ["Next article" gnus-summary-next-article t]
2699          ["Previous article" gnus-summary-prev-article t]
2700          ["Next unread subject" gnus-summary-next-unread-subject t]
2701          ["Previous unread subject" gnus-summary-prev-unread-subject t]
2702          ["Next article same subject" gnus-summary-next-same-subject t]
2703          ["Previous article same subject" gnus-summary-prev-same-subject t]
2704          ["First unread article" gnus-summary-first-unread-article t]
2705          ["Best unread article" gnus-summary-best-unread-article t]
2706          ["Go to subject number..." gnus-summary-goto-subject t]
2707          ["Go to article number..." gnus-summary-goto-article t]
2708          ["Go to the last article" gnus-summary-goto-last-article t]
2709          ["Pop article off history" gnus-summary-pop-article t])
2710         ("Sort"
2711          ["Sort by number" gnus-summary-sort-by-number t]
2712          ["Sort by most recent number" gnus-summary-sort-by-most-recent-number t]
2713          ["Sort by author" gnus-summary-sort-by-author t]
2714          ["Sort by recipient" gnus-summary-sort-by-recipient t]
2715          ["Sort by subject" gnus-summary-sort-by-subject t]
2716          ["Sort by date" gnus-summary-sort-by-date t]
2717          ["Sort by most recent date" gnus-summary-sort-by-most-recent-date t]
2718          ["Sort by score" gnus-summary-sort-by-score t]
2719          ["Sort by lines" gnus-summary-sort-by-lines t]
2720          ["Sort by characters" gnus-summary-sort-by-chars t]
2721          ["Randomize" gnus-summary-sort-by-random t]
2722          ["Original sort" gnus-summary-sort-by-original t])
2723         ("Help"
2724          ["Fetch group FAQ" gnus-summary-fetch-faq t]
2725          ["Describe group" gnus-summary-describe-group t]
2726          ["Fetch charter" gnus-group-fetch-charter
2727           ,@(if (featurep 'xemacs) nil
2728               '(:help "Display the charter of the current group"))]
2729          ["Fetch control message" gnus-group-fetch-control
2730           ,@(if (featurep 'xemacs) nil
2731               '(:help "Display the archived control message for the current group"))]
2732          ["Read manual" gnus-info-find-node t])
2733         ("Modes"
2734          ["Pick and read" gnus-pick-mode t]
2735          ["Binary" gnus-binary-mode t])
2736         ("Regeneration"
2737          ["Regenerate" gnus-summary-prepare t]
2738          ["Insert cached articles" gnus-summary-insert-cached-articles t]
2739          ["Insert dormant articles" gnus-summary-insert-dormant-articles t]
2740          ["Insert ticked articles" gnus-summary-insert-ticked-articles t]
2741          ["Toggle threading" gnus-summary-toggle-threads t])
2742         ["See old articles" gnus-summary-insert-old-articles t]
2743         ["See new articles" gnus-summary-insert-new-articles t]
2744         ["Filter articles..." gnus-summary-execute-command t]
2745         ["Run command on articles..." gnus-summary-universal-argument t]
2746         ["Search articles forward..." gnus-summary-search-article-forward t]
2747         ["Search articles backward..." gnus-summary-search-article-backward t]
2748         ["Toggle line truncation" gnus-summary-toggle-truncation t]
2749         ["Expand window" gnus-summary-expand-window t]
2750         ["Expire expirable articles" gnus-summary-expire-articles
2751          (gnus-check-backend-function
2752           'request-expire-articles gnus-newsgroup-name)]
2753         ["Edit local kill file" gnus-summary-edit-local-kill t]
2754         ["Edit main kill file" gnus-summary-edit-global-kill t]
2755         ["Edit group parameters" gnus-summary-edit-parameters t]
2756         ["Customize group parameters" gnus-summary-customize-parameters t]
2757         ["Send a bug report" gnus-bug t]
2758         ("Exit"
2759          ["Catchup and exit" gnus-summary-catchup-and-exit
2760           ,@(if (featurep 'xemacs) '(t)
2761               '(:help "Mark unread articles in this group as read, then exit"))]
2762          ["Catchup all and exit" gnus-summary-catchup-all-and-exit t]
2763          ["Catchup and goto next" gnus-summary-catchup-and-goto-next-group t]
2764          ["Catchup and goto prev" gnus-summary-catchup-and-goto-prev-group t]
2765          ["Exit group" gnus-summary-exit
2766           ,@(if (featurep 'xemacs) '(t)
2767               '(:help "Exit current group, return to group selection mode"))]
2768          ["Exit group without updating" gnus-summary-exit-no-update t]
2769          ["Exit and goto next group" gnus-summary-next-group t]
2770          ["Exit and goto prev group" gnus-summary-prev-group t]
2771          ["Reselect group" gnus-summary-reselect-current-group t]
2772          ["Rescan group" gnus-summary-rescan-group t]
2773          ["Update dribble" gnus-summary-save-newsrc t])))
2774
2775     (gnus-run-hooks 'gnus-summary-menu-hook)))
2776
2777 (defvar gnus-summary-tool-bar-map nil)
2778
2779 ;; Note: The :set function in the `gnus-summary-tool-bar*' variables will only
2780 ;; affect _new_ message buffers.  We might add a function that walks thru all
2781 ;; summary-mode buffers and force the update.
2782 (defun gnus-summary-tool-bar-update (&optional symbol value)
2783   "Update summary mode toolbar.
2784 Setter function for custom variables."
2785   (setq-default gnus-summary-tool-bar-map nil)
2786   (when symbol
2787     ;; When used as ":set" function:
2788     (set-default symbol value))
2789   (when (gnus-buffer-live-p gnus-summary-buffer)
2790     (with-current-buffer gnus-summary-buffer
2791       (gnus-summary-make-tool-bar))))
2792
2793 (defcustom gnus-summary-tool-bar (if (eq gmm-tool-bar-style 'gnome)
2794                                      'gnus-summary-tool-bar-gnome
2795                                    'gnus-summary-tool-bar-retro)
2796   "Specifies the Gnus summary tool bar.
2797
2798 It can be either a list or a symbol refering to a list.  See
2799 `gmm-tool-bar-from-list' for the format of the list.  The
2800 default key map is `gnus-summary-mode-map'.
2801
2802 Pre-defined symbols include `gnus-summary-tool-bar-gnome' and
2803 `gnus-summary-tool-bar-retro'."
2804   :type '(choice (const :tag "GNOME style" gnus-summary-tool-bar-gnome)
2805                  (const :tag "Retro look"  gnus-summary-tool-bar-retro)
2806                  (repeat :tag "User defined list" gmm-tool-bar-item)
2807                  (symbol))
2808   :version "23.1" ;; No Gnus
2809   :initialize 'custom-initialize-default
2810   :set 'gnus-summary-tool-bar-update
2811   :group 'gnus-summary)
2812
2813 (defcustom gnus-summary-tool-bar-gnome
2814   '((gnus-summary-post-news "mail/compose" nil)
2815     (gnus-summary-insert-new-articles "mail/inbox" nil
2816                                       :visible (or (not gnus-agent)
2817                                                    gnus-plugged))
2818     (gnus-summary-reply-with-original "mail/reply")
2819     (gnus-summary-reply "mail/reply" nil :visible nil)
2820     (gnus-summary-followup-with-original "mail/reply-all")
2821     (gnus-summary-followup "mail/reply-all" nil :visible nil)
2822     (gnus-summary-mail-forward "mail/forward")
2823     (gnus-summary-save-article "mail/save")
2824     (gnus-summary-search-article-forward "search" nil :visible nil)
2825     (gnus-summary-print-article "print")
2826     (gnus-summary-tick-article-forward "flag-followup" nil :visible nil)
2827     ;; Some new commands that may need more suitable icons:
2828     (gnus-summary-save-newsrc "save" nil :visible nil)
2829     ;; (gnus-summary-show-article "stock_message-display" nil :visible nil)
2830     (gnus-summary-prev-article "left-arrow")
2831     (gnus-summary-next-article "right-arrow")
2832     (gnus-summary-next-page "next-page")
2833     ;; (gnus-summary-enter-digest-group "right_arrow" nil :visible nil)
2834     ;;
2835     ;; Maybe some sort-by-... could be added:
2836     ;; (gnus-summary-sort-by-author "sort-a-z" nil :visible nil)
2837     ;; (gnus-summary-sort-by-date "sort-1-9" nil :visible nil)
2838     (gnus-summary-mark-as-expirable
2839      "delete" nil
2840      :visible (gnus-check-backend-function 'request-expire-articles
2841                                            gnus-newsgroup-name))
2842     (gnus-summary-mark-as-spam
2843      "mail/spam" t
2844      :visible (and (fboundp 'spam-group-ham-contents-p)
2845                    (spam-group-ham-contents-p gnus-newsgroup-name))
2846      :help "Mark as spam")
2847     (gnus-summary-mark-as-read-forward
2848      "mail/not-spam" nil
2849      :visible (and (fboundp 'spam-group-spam-contents-p)
2850                    (spam-group-spam-contents-p gnus-newsgroup-name)))
2851     ;;
2852     (gnus-summary-exit "exit")
2853     (gmm-customize-mode "preferences" t :help "Edit mode preferences")
2854     (gnus-info-find-node "help"))
2855   "List of functions for the summary tool bar (GNOME style).
2856
2857 See `gmm-tool-bar-from-list' for the format of the list."
2858   :type '(repeat gmm-tool-bar-item)
2859   :version "23.1" ;; No Gnus
2860   :initialize 'custom-initialize-default
2861   :set 'gnus-summary-tool-bar-update
2862   :group 'gnus-summary)
2863
2864 (defcustom gnus-summary-tool-bar-retro
2865   '((gnus-summary-prev-unread-article "gnus/prev-ur")
2866     (gnus-summary-next-unread-article "gnus/next-ur")
2867     (gnus-summary-post-news "gnus/post")
2868     (gnus-summary-followup-with-original "gnus/fuwo")
2869     (gnus-summary-followup "gnus/followup")
2870     (gnus-summary-reply-with-original "gnus/reply-wo")
2871     (gnus-summary-reply "gnus/reply")
2872     (gnus-summary-caesar-message "gnus/rot13")
2873     (gnus-uu-decode-uu "gnus/uu-decode")
2874     (gnus-summary-save-article-file "gnus/save-aif")
2875     (gnus-summary-save-article "gnus/save-art")
2876     (gnus-uu-post-news "gnus/uu-post")
2877     (gnus-summary-catchup "gnus/catchup")
2878     (gnus-summary-catchup-and-exit "gnus/cu-exit")
2879     (gnus-summary-exit "gnus/exit-summ")
2880     ;; Some new command that may need more suitable icons:
2881     (gnus-summary-print-article "gnus/print" nil :visible nil)
2882     (gnus-summary-mark-as-expirable "gnus/close" nil :visible nil)
2883     (gnus-summary-save-newsrc "gnus/save" nil :visible nil)
2884     ;; (gnus-summary-enter-digest-group "gnus/right_arrow" nil :visible nil)
2885     (gnus-summary-search-article-forward "gnus/search" nil :visible nil)
2886     ;; (gnus-summary-insert-new-articles "gnus/paste" nil :visible nil)
2887     ;; (gnus-summary-toggle-threads "gnus/open" nil :visible nil)
2888     ;;
2889     (gnus-info-find-node "gnus/help" nil :visible nil))
2890   "List of functions for the summary tool bar (retro look).
2891
2892 See `gmm-tool-bar-from-list' for the format of the list."
2893   :type '(repeat gmm-tool-bar-item)
2894   :version "23.1" ;; No Gnus
2895   :initialize 'custom-initialize-default
2896   :set 'gnus-summary-tool-bar-update
2897   :group 'gnus-summary)
2898
2899 (defcustom gnus-summary-tool-bar-zap-list t
2900   "List of icon items from the global tool bar.
2901 These items are not displayed in the Gnus summary mode tool bar.
2902
2903 See `gmm-tool-bar-from-list' for the format of the list."
2904   :type 'gmm-tool-bar-zap-list
2905   :version "23.1" ;; No Gnus
2906   :initialize 'custom-initialize-default
2907   :set 'gnus-summary-tool-bar-update
2908   :group 'gnus-summary)
2909
2910 (defvar image-load-path)
2911 (defvar tool-bar-map)
2912
2913 (defun gnus-summary-make-tool-bar (&optional force)
2914   "Make a summary mode tool bar from `gnus-summary-tool-bar'.
2915 When FORCE, rebuild the tool bar."
2916   (when (and (not (featurep 'xemacs))
2917              (boundp 'tool-bar-mode)
2918              tool-bar-mode
2919              (or (not gnus-summary-tool-bar-map) force))
2920     (let* ((load-path
2921             (gmm-image-load-path-for-library "gnus"
2922                                              "mail/save.xpm"
2923                                              nil t))
2924            (image-load-path (cons (car load-path)
2925                                   (when (boundp 'image-load-path)
2926                                     image-load-path)))
2927            (map (gmm-tool-bar-from-list gnus-summary-tool-bar
2928                                         gnus-summary-tool-bar-zap-list
2929                                         'gnus-summary-mode-map)))
2930       (when map
2931         ;; Need to set `gnus-summary-tool-bar-map' because `gnus-article-mode'
2932         ;; uses it's value.
2933         (setq gnus-summary-tool-bar-map map))))
2934   (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map))
2935
2936 (defun gnus-score-set-default (var value)
2937   "A version of set that updates the GNU Emacs menu-bar."
2938   (set var value)
2939   ;; It is the message that forces the active status to be updated.
2940   (message ""))
2941
2942 (defun gnus-make-score-map (type)
2943   "Make a summary score map of type TYPE."
2944   (if t
2945       nil
2946     (let ((headers '(("author" "from" string)
2947                      ("subject" "subject" string)
2948                      ("article body" "body" string)
2949                      ("article head" "head" string)
2950                      ("xref" "xref" string)
2951                      ("extra header" "extra" string)
2952                      ("lines" "lines" number)
2953                      ("followups to author" "followup" string)))
2954           (types '((number ("less than" <)
2955                            ("greater than" >)
2956                            ("equal" =))
2957                    (string ("substring" s)
2958                            ("exact string" e)
2959                            ("fuzzy string" f)
2960                            ("regexp" r))))
2961           (perms '(("temporary" (current-time-string))
2962                    ("permanent" nil)
2963                    ("immediate" now)))
2964           header)
2965       (list
2966        (apply
2967         'nconc
2968         (list
2969          (if (eq type 'lower)
2970              "Lower score"
2971            "Increase score"))
2972         (let (outh)
2973           (while headers
2974             (setq header (car headers))
2975             (setq outh
2976                   (cons
2977                    (apply
2978                     'nconc
2979                     (list (car header))
2980                     (let ((ts (cdr (assoc (nth 2 header) types)))
2981                           outt)
2982                       (while ts
2983                         (setq outt
2984                               (cons
2985                                (apply
2986                                 'nconc
2987                                 (list (caar ts))
2988                                 (let ((ps perms)
2989                                       outp)
2990                                   (while ps
2991                                     (setq outp
2992                                           (cons
2993                                            (vector
2994                                             (caar ps)
2995                                             (list
2996                                              'gnus-summary-score-entry
2997                                              (nth 1 header)
2998                                              (if (or (string= (nth 1 header)
2999                                                               "head")
3000                                                      (string= (nth 1 header)
3001                                                               "body"))
3002                                                  ""
3003                                                (list 'gnus-summary-header
3004                                                      (nth 1 header)))
3005                                              (list 'quote (nth 1 (car ts)))
3006                                              (list 'gnus-score-delta-default
3007                                                    nil)
3008                                              (nth 1 (car ps))
3009                                              t)
3010                                             t)
3011                                            outp))
3012                                     (setq ps (cdr ps)))
3013                                   (list (nreverse outp))))
3014                                outt))
3015                         (setq ts (cdr ts)))
3016                       (list (nreverse outt))))
3017                    outh))
3018             (setq headers (cdr headers)))
3019           (list (nreverse outh))))))))
3020
3021
3022 (declare-function turn-on-gnus-mailing-list-mode "gnus-ml" ())
3023 (defvar bookmark-make-record-function)
3024 \f
3025
3026 (defun gnus-summary-mode (&optional group)
3027   "Major mode for reading articles.
3028
3029 All normal editing commands are switched off.
3030 \\<gnus-summary-mode-map>
3031 Each line in this buffer represents one article.  To read an
3032 article, you can, for instance, type `\\[gnus-summary-next-page]'.  To move forwards
3033 and backwards while displaying articles, type `\\[gnus-summary-next-unread-article]' and `\\[gnus-summary-prev-unread-article]',
3034 respectively.
3035
3036 You can also post articles and send mail from this buffer.  To
3037 follow up an article, type `\\[gnus-summary-followup]'.  To mail a reply to the author
3038 of an article, type `\\[gnus-summary-reply]'.
3039
3040 There are approx. one gazillion commands you can execute in this
3041 buffer; read the info pages for more information (`\\[gnus-info-find-node]').
3042
3043 The following commands are available:
3044
3045 \\{gnus-summary-mode-map}"
3046   (interactive)
3047   (kill-all-local-variables)
3048   (let ((gnus-summary-local-variables gnus-newsgroup-variables))
3049     (gnus-summary-make-local-variables))
3050   (gnus-summary-make-local-variables)
3051   (setq gnus-newsgroup-name group)
3052   (when (gnus-visual-p 'summary-menu 'menu)
3053     (gnus-summary-make-menu-bar)
3054     (gnus-summary-make-tool-bar))
3055   (gnus-make-thread-indent-array)
3056   (gnus-simplify-mode-line)
3057   (setq major-mode 'gnus-summary-mode)
3058   (setq mode-name "Summary")
3059   (use-local-map gnus-summary-mode-map)
3060   (buffer-disable-undo)
3061   (setq buffer-read-only t              ;Disable modification
3062         show-trailing-whitespace nil)
3063   (setq truncate-lines t)
3064   (add-to-invisibility-spec '(gnus-sum . t))
3065   (gnus-summary-set-display-table)
3066   (gnus-set-default-directory)
3067   (make-local-variable 'gnus-summary-line-format)
3068   (make-local-variable 'gnus-summary-line-format-spec)
3069   (make-local-variable 'gnus-summary-dummy-line-format)
3070   (make-local-variable 'gnus-summary-dummy-line-format-spec)
3071   (make-local-variable 'gnus-summary-mark-positions)
3072   (gnus-make-local-hook 'pre-command-hook)
3073   (add-hook 'pre-command-hook 'gnus-set-global-variables nil t)
3074   (gnus-run-mode-hooks 'gnus-summary-mode-hook)
3075   (turn-on-gnus-mailing-list-mode)
3076   (mm-enable-multibyte)
3077   (set (make-local-variable 'bookmark-make-record-function)
3078        'gnus-summary-bookmark-make-record)
3079   (gnus-update-format-specifications nil 'summary 'summary-mode 'summary-dummy)
3080   (gnus-update-summary-mark-positions))
3081
3082 (defun gnus-summary-make-local-variables ()
3083   "Make all the local summary buffer variables."
3084   (let (global)
3085     (dolist (local gnus-summary-local-variables)
3086       (if (consp local)
3087           (progn
3088             (if (eq (cdr local) 'global)
3089                 ;; Copy the global value of the variable.
3090                 (setq global (symbol-value (car local)))
3091               ;; Use the value from the list.
3092               (setq global (eval (cdr local))))
3093             (set (make-local-variable (car local)) global))
3094         ;; Simple nil-valued local variable.
3095         (set (make-local-variable local) nil)))))
3096
3097 (defun gnus-summary-clear-local-variables ()
3098   (let ((locals gnus-summary-local-variables))
3099     (while locals
3100       (if (consp (car locals))
3101           (and (symbolp (caar locals))
3102                (set (caar locals) nil))
3103         (and (symbolp (car locals))
3104              (set (car locals) nil)))
3105       (setq locals (cdr locals)))))
3106
3107 ;; Summary data functions.
3108
3109 (defmacro gnus-data-number (data)
3110   `(car ,data))
3111
3112 (defmacro gnus-data-set-number (data number)
3113   `(setcar ,data ,number))
3114
3115 (defmacro gnus-data-mark (data)
3116   `(nth 1 ,data))
3117
3118 (defmacro gnus-data-set-mark (data mark)
3119   `(setcar (nthcdr 1 ,data) ,mark))
3120
3121 (defmacro gnus-data-pos (data)
3122   `(nth 2 ,data))
3123
3124 (defmacro gnus-data-set-pos (data pos)
3125   `(setcar (nthcdr 2 ,data) ,pos))
3126
3127 (defmacro gnus-data-header (data)
3128   `(nth 3 ,data))
3129
3130 (defmacro gnus-data-set-header (data header)
3131   `(setf (nth 3 ,data) ,header))
3132
3133 (defmacro gnus-data-level (data)
3134   `(nth 4 ,data))
3135
3136 (defmacro gnus-data-unread-p (data)
3137   `(= (nth 1 ,data) gnus-unread-mark))
3138
3139 (defmacro gnus-data-read-p (data)
3140   `(/= (nth 1 ,data) gnus-unread-mark))
3141
3142 (defmacro gnus-data-pseudo-p (data)
3143   `(consp (nth 3 ,data)))
3144
3145 (defmacro gnus-data-find (number)
3146   `(assq ,number gnus-newsgroup-data))
3147
3148 (defmacro gnus-data-find-list (number &optional data)
3149   `(let ((bdata ,(or data 'gnus-newsgroup-data)))
3150      (memq (assq ,number bdata)
3151            bdata)))
3152
3153 (defmacro gnus-data-make (number mark pos header level)
3154   `(list ,number ,mark ,pos ,header ,level))
3155
3156 (defun gnus-data-enter (after-article number mark pos header level offset)
3157   (let ((data (gnus-data-find-list after-article)))
3158     (unless data
3159       (error "No such article: %d" after-article))
3160     (setcdr data (cons (gnus-data-make number mark pos header level)
3161                        (cdr data)))
3162     (setq gnus-newsgroup-data-reverse nil)
3163     (gnus-data-update-list (cddr data) offset)))
3164
3165 (defun gnus-data-enter-list (after-article list &optional offset)
3166   (when list
3167     (let ((data (and after-article (gnus-data-find-list after-article)))
3168           (ilist list))
3169       (if (not (or data
3170                    after-article))
3171           (let ((odata gnus-newsgroup-data))
3172             (setq gnus-newsgroup-data (nconc list gnus-newsgroup-data))
3173             (when offset
3174               (gnus-data-update-list odata offset)))
3175         ;; Find the last element in the list to be spliced into the main
3176         ;; list.
3177         (setq list (last list))
3178         (if (not data)
3179             (progn
3180               (setcdr list gnus-newsgroup-data)
3181               (setq gnus-newsgroup-data ilist)
3182               (when offset
3183                 (gnus-data-update-list (cdr list) offset)))
3184           (setcdr list (cdr data))
3185           (setcdr data ilist)
3186           (when offset
3187             (gnus-data-update-list (cdr list) offset))))
3188       (setq gnus-newsgroup-data-reverse nil))))
3189
3190 (defun gnus-data-remove (article &optional offset)
3191   (let ((data gnus-newsgroup-data))
3192     (if (= (gnus-data-number (car data)) article)
3193         (progn
3194           (setq gnus-newsgroup-data (cdr gnus-newsgroup-data)
3195                 gnus-newsgroup-data-reverse nil)
3196           (when offset
3197             (gnus-data-update-list gnus-newsgroup-data offset)))
3198       (while (cdr data)
3199         (when (= (gnus-data-number (cadr data)) article)
3200           (setcdr data (cddr data))
3201           (when offset
3202             (gnus-data-update-list (cdr data) offset))
3203           (setq data nil
3204                 gnus-newsgroup-data-reverse nil))
3205         (setq data (cdr data))))))
3206
3207 (defmacro gnus-data-list (backward)
3208   `(if ,backward
3209        (or gnus-newsgroup-data-reverse
3210            (setq gnus-newsgroup-data-reverse
3211                  (reverse gnus-newsgroup-data)))
3212      gnus-newsgroup-data))
3213
3214 (defun gnus-data-update-list (data offset)
3215   "Add OFFSET to the POS of all data entries in DATA."
3216   (setq gnus-newsgroup-data-reverse nil)
3217   (while data
3218     (setcar (nthcdr 2 (car data)) (+ offset (nth 2 (car data))))
3219     (setq data (cdr data))))
3220
3221 (defun gnus-summary-article-pseudo-p (article)
3222   "Say whether this article is a pseudo article or not."
3223   (not (vectorp (gnus-data-header (gnus-data-find article)))))
3224
3225 (defmacro gnus-summary-article-sparse-p (article)
3226   "Say whether this article is a sparse article or not."
3227   `(memq ,article gnus-newsgroup-sparse))
3228
3229 (defmacro gnus-summary-article-ancient-p (article)
3230   "Say whether this article is a sparse article or not."
3231   `(memq ,article gnus-newsgroup-ancient))
3232
3233 (defun gnus-article-parent-p (number)
3234   "Say whether this article is a parent or not."
3235   (let ((data (gnus-data-find-list number)))
3236     (and (cdr data)              ; There has to be an article after...
3237          (< (gnus-data-level (car data)) ; And it has to have a higher level.
3238             (gnus-data-level (nth 1 data))))))
3239
3240 (defun gnus-article-children (number)
3241   "Return a list of all children to NUMBER."
3242   (let* ((data (gnus-data-find-list number))
3243          (level (gnus-data-level (car data)))
3244          children)
3245     (setq data (cdr data))
3246     (while (and data
3247                 (= (gnus-data-level (car data)) (1+ level)))
3248       (push (gnus-data-number (car data)) children)
3249       (setq data (cdr data)))
3250     children))
3251
3252 (defmacro gnus-summary-skip-intangible ()
3253   "If the current article is intangible, then jump to a different article."
3254   '(let ((to (get-text-property (point) 'gnus-intangible)))
3255      (and to (gnus-summary-goto-subject to))))
3256
3257 (defmacro gnus-summary-article-intangible-p ()
3258   "Say whether this article is intangible or not."
3259   '(get-text-property (point) 'gnus-intangible))
3260
3261 (defun gnus-article-read-p (article)
3262   "Say whether ARTICLE is read or not."
3263   (not (or (memq article gnus-newsgroup-marked)
3264            (memq article gnus-newsgroup-spam-marked)
3265            (memq article gnus-newsgroup-unreads)
3266            (memq article gnus-newsgroup-unselected)
3267            (memq article gnus-newsgroup-dormant))))
3268
3269 ;; Some summary mode macros.
3270
3271 (defmacro gnus-summary-article-number ()
3272   "The article number of the article on the current line.
3273 If there isn't an article number here, then we return the current
3274 article number."
3275   '(progn
3276      (gnus-summary-skip-intangible)
3277      (or (get-text-property (point) 'gnus-number)
3278          (gnus-summary-last-subject))))
3279
3280 (defmacro gnus-summary-article-header (&optional number)
3281   "Return the header of article NUMBER."
3282   `(gnus-data-header (gnus-data-find
3283                       ,(or number '(gnus-summary-article-number)))))
3284
3285 (defmacro gnus-summary-thread-level (&optional number)
3286   "Return the level of thread that starts with article NUMBER."
3287   `(if (and (eq gnus-summary-make-false-root 'dummy)
3288             (get-text-property (point) 'gnus-intangible))
3289        0
3290      (gnus-data-level (gnus-data-find
3291                        ,(or number '(gnus-summary-article-number))))))
3292
3293 (defmacro gnus-summary-article-mark (&optional number)
3294   "Return the mark of article NUMBER."
3295   `(gnus-data-mark (gnus-data-find
3296                     ,(or number '(gnus-summary-article-number)))))
3297
3298 (defmacro gnus-summary-article-pos (&optional number)
3299   "Return the position of the line of article NUMBER."
3300   `(gnus-data-pos (gnus-data-find
3301                    ,(or number '(gnus-summary-article-number)))))
3302
3303 (defalias 'gnus-summary-subject-string 'gnus-summary-article-subject)
3304 (defmacro gnus-summary-article-subject (&optional number)
3305   "Return current subject string or nil if nothing."
3306   `(let ((headers
3307           ,(if number
3308                `(gnus-data-header (assq ,number gnus-newsgroup-data))
3309              '(gnus-data-header (assq (gnus-summary-article-number)
3310                                       gnus-newsgroup-data)))))
3311      (and headers
3312           (vectorp headers)
3313           (mail-header-subject headers))))
3314
3315 (defmacro gnus-summary-article-score (&optional number)
3316   "Return current article score."
3317   `(or (cdr (assq ,(or number '(gnus-summary-article-number))
3318                   gnus-newsgroup-scored))
3319        gnus-summary-default-score 0))
3320
3321 (defun gnus-summary-article-children (&optional number)
3322   "Return a list of article numbers that are children of article NUMBER."
3323   (let* ((data (gnus-data-find-list (or number (gnus-summary-article-number))))
3324          (level (gnus-data-level (car data)))
3325          l children)
3326     (while (and (setq data (cdr data))
3327                 (> (setq l (gnus-data-level (car data))) level))
3328       (and (= (1+ level) l)
3329            (push (gnus-data-number (car data))
3330                  children)))
3331     (nreverse children)))
3332
3333 (defun gnus-summary-article-parent (&optional number)
3334   "Return the article number of the parent of article NUMBER."
3335   (let* ((data (gnus-data-find-list (or number (gnus-summary-article-number))
3336                                     (gnus-data-list t)))
3337          (level (gnus-data-level (car data))))
3338     (if (zerop level)
3339         ()                              ; This is a root.
3340       ;; We search until we find an article with a level less than
3341       ;; this one.  That function has to be the parent.
3342       (while (and (setq data (cdr data))
3343                   (not (< (gnus-data-level (car data)) level))))
3344       (and data (gnus-data-number (car data))))))
3345
3346 (defun gnus-unread-mark-p (mark)
3347   "Say whether MARK is the unread mark."
3348   (= mark gnus-unread-mark))
3349
3350 (defun gnus-read-mark-p (mark)
3351   "Say whether MARK is one of the marks that mark as read.
3352 This is all marks except unread, ticked, dormant, and expirable."
3353   (not (or (= mark gnus-unread-mark)
3354            (= mark gnus-ticked-mark)
3355            (= mark gnus-spam-mark)
3356            (= mark gnus-dormant-mark)
3357            (= mark gnus-expirable-mark))))
3358
3359 (defmacro gnus-article-mark (number)
3360   "Return the MARK of article NUMBER.
3361 This macro should only be used when computing the mark the \"first\"
3362 time; i.e., when generating the summary lines.  After that,
3363 `gnus-summary-article-mark' should be used to examine the
3364 marks of articles."
3365   `(cond
3366     ((memq ,number gnus-newsgroup-unsendable) gnus-unsendable-mark)
3367     ((memq ,number gnus-newsgroup-downloadable) gnus-downloadable-mark)
3368     ((memq ,number gnus-newsgroup-unreads) gnus-unread-mark)
3369     ((memq ,number gnus-newsgroup-marked) gnus-ticked-mark)
3370     ((memq ,number gnus-newsgroup-spam-marked) gnus-spam-mark)
3371     ((memq ,number gnus-newsgroup-dormant) gnus-dormant-mark)
3372     ((memq ,number gnus-newsgroup-expirable) gnus-expirable-mark)
3373     (t (or (cdr (assq ,number gnus-newsgroup-reads))
3374            gnus-ancient-mark))))
3375
3376 ;; Saving hidden threads.
3377
3378 (defmacro gnus-save-hidden-threads (&rest forms)
3379   "Save hidden threads, eval FORMS, and restore the hidden threads."
3380   (let ((config (make-symbol "config")))
3381     `(let ((,config (gnus-hidden-threads-configuration)))
3382        (unwind-protect
3383            (save-excursion
3384              ,@forms)
3385          (gnus-restore-hidden-threads-configuration ,config)))))
3386 (put 'gnus-save-hidden-threads 'lisp-indent-function 0)
3387 (put 'gnus-save-hidden-threads 'edebug-form-spec '(body))
3388
3389 (defun gnus-data-compute-positions ()
3390   "Compute the positions of all articles."
3391   (setq gnus-newsgroup-data-reverse nil)
3392   (let ((data gnus-newsgroup-data))
3393     (save-excursion
3394       (gnus-save-hidden-threads
3395         (gnus-summary-show-all-threads)
3396         (goto-char (point-min))
3397         (while data
3398           (while (get-text-property (point) 'gnus-intangible)
3399             (forward-line 1))
3400           (gnus-data-set-pos (car data) (+ (point) 3))
3401           (setq data (cdr data))
3402           (forward-line 1))))))
3403
3404 (defun gnus-hidden-threads-configuration ()
3405   "Return the current hidden threads configuration."
3406   (save-excursion
3407     (let (config)
3408       (goto-char (point-min))
3409       (while (not (eobp))
3410         (when (eq (get-char-property (point-at-eol) 'invisible) 'gnus-sum)
3411           (push (save-excursion (forward-line 0) (point)) config))
3412         (forward-line 1))
3413       config)))
3414
3415 (defun gnus-restore-hidden-threads-configuration (config)
3416   "Restore hidden threads configuration from CONFIG."
3417   (save-excursion
3418     (let (point (inhibit-read-only t))
3419       (while (setq point (pop config))
3420         (goto-char point)
3421         (gnus-summary-hide-thread)))))
3422
3423 ;; Various summary mode internalish functions.
3424
3425 (defun gnus-mouse-pick-article (e)
3426   (interactive "e")
3427   (mouse-set-point e)
3428   (gnus-summary-next-page nil t))
3429
3430 (defun gnus-summary-set-display-table ()
3431   "Change the display table.
3432 Odd characters have a tendency to mess
3433 up nicely formatted displays - we make all possible glyphs
3434 display only a single character."
3435
3436   ;; We start from the standard display table, if any.
3437   (let ((table (or (copy-sequence standard-display-table)
3438                    (make-display-table)))
3439         (i 32))
3440     ;; Nix out all the control chars...
3441     (while (>= (setq i (1- i)) 0)
3442       (gnus-put-display-table i [??] table))
3443    ;; ... but not newline and cr, of course.  (cr is necessary for the
3444     ;; selective display).
3445     (gnus-put-display-table ?\n nil table)
3446     (gnus-put-display-table ?\r nil table)
3447     ;; We keep TAB as well.
3448     (gnus-put-display-table ?\t nil table)
3449     ;; We nix out any glyphs 127 through 255, or 127 through 159 in
3450     ;; Emacs 23 (unicode), that are not set already.
3451     (let ((i (if (ignore-errors (= (make-char 'latin-iso8859-1 160) 160))
3452                  160
3453                256)))
3454       (while (>= (setq i (1- i)) 127)
3455         ;; Only modify if the entry is nil.
3456         (unless (gnus-get-display-table i table)
3457           (gnus-put-display-table i [??] table))))
3458     (setq buffer-display-table table)))
3459
3460 (defun gnus-summary-set-article-display-arrow (pos)
3461   "Update the overlay arrow to point to line at position POS."
3462   (when gnus-summary-display-arrow
3463     (make-local-variable 'overlay-arrow-position)
3464     (make-local-variable 'overlay-arrow-string)
3465     (save-excursion
3466       (goto-char pos)
3467       (beginning-of-line)
3468       (unless overlay-arrow-position
3469         (setq overlay-arrow-position (make-marker)))
3470       (setq overlay-arrow-string "=>"
3471             overlay-arrow-position (set-marker overlay-arrow-position
3472                                                (point)
3473                                                (current-buffer))))))
3474
3475 (defun gnus-summary-setup-buffer (group)
3476   "Initialize summary buffer."
3477   (let ((buffer (gnus-summary-buffer-name group))
3478         (dead-name (concat "*Dead Summary "
3479                            (gnus-group-decoded-name group) "*")))
3480     ;; If a dead summary buffer exists, we kill it.
3481     (when (gnus-buffer-live-p dead-name)
3482       (gnus-kill-buffer dead-name))
3483     (if (get-buffer buffer)
3484         (progn
3485           (set-buffer buffer)
3486           (setq gnus-summary-buffer (current-buffer))
3487           (not gnus-newsgroup-prepared))
3488       ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
3489       (setq gnus-summary-buffer (set-buffer (gnus-get-buffer-create buffer)))
3490       (gnus-summary-mode group)
3491       (when gnus-carpal
3492         (gnus-carpal-setup-buffer 'summary))
3493       (when (gnus-group-quit-config group)
3494         (set (make-local-variable 'gnus-single-article-buffer) nil))
3495       (make-local-variable 'gnus-article-buffer)
3496       (make-local-variable 'gnus-article-current)
3497       (make-local-variable 'gnus-original-article-buffer)
3498       (setq gnus-newsgroup-name group)
3499       ;; Set any local variables in the group parameters.
3500       (gnus-summary-set-local-parameters gnus-newsgroup-name)
3501       t)))
3502
3503 (defun gnus-set-global-variables ()
3504   "Set the global equivalents of the buffer-local variables.
3505 They are set to the latest values they had.  These reflect the summary
3506 buffer that was in action when the last article was fetched."
3507   (when (eq major-mode 'gnus-summary-mode)
3508     (setq gnus-summary-buffer (current-buffer))
3509     (let ((name gnus-newsgroup-name)
3510           (marked gnus-newsgroup-marked)
3511           (spam gnus-newsgroup-spam-marked)
3512           (unread gnus-newsgroup-unreads)
3513           (headers gnus-current-headers)
3514           (data gnus-newsgroup-data)
3515           (summary gnus-summary-buffer)
3516           (article-buffer gnus-article-buffer)
3517           (original gnus-original-article-buffer)
3518           (gac gnus-article-current)
3519           (reffed gnus-reffed-article-number)
3520           (score-file gnus-current-score-file)
3521           (default-charset gnus-newsgroup-charset)
3522           vlist)
3523       (let ((locals gnus-newsgroup-variables))
3524         (while locals
3525           (if (consp (car locals))
3526               (push (eval (caar locals)) vlist)
3527             (push (eval (car locals)) vlist))
3528           (setq locals (cdr locals)))
3529         (setq vlist (nreverse vlist)))
3530       (with-current-buffer gnus-group-buffer
3531         (setq gnus-newsgroup-name name
3532               gnus-newsgroup-marked marked
3533               gnus-newsgroup-spam-marked spam
3534               gnus-newsgroup-unreads unread
3535               gnus-current-headers headers
3536               gnus-newsgroup-data data
3537               gnus-article-current gac
3538               gnus-summary-buffer summary
3539               gnus-article-buffer article-buffer
3540               gnus-original-article-buffer original
3541               gnus-reffed-article-number reffed
3542               gnus-current-score-file score-file
3543               gnus-newsgroup-charset default-charset)
3544         (let ((locals gnus-newsgroup-variables))
3545           (while locals
3546             (if (consp (car locals))
3547                 (set (caar locals) (pop vlist))
3548               (set (car locals) (pop vlist)))
3549             (setq locals (cdr locals))))
3550         ;; The article buffer also has local variables.
3551         (when (gnus-buffer-live-p gnus-article-buffer)
3552           (set-buffer gnus-article-buffer)
3553           (setq gnus-summary-buffer summary))))))
3554
3555 (defun gnus-summary-article-unread-p (article)
3556   "Say whether ARTICLE is unread or not."
3557   (memq article gnus-newsgroup-unreads))
3558
3559 (defun gnus-summary-first-article-p (&optional article)
3560   "Return whether ARTICLE is the first article in the buffer."
3561   (if (not (setq article (or article (gnus-summary-article-number))))
3562       nil
3563     (eq article (caar gnus-newsgroup-data))))
3564
3565 (defun gnus-summary-last-article-p (&optional article)
3566   "Return whether ARTICLE is the last article in the buffer."
3567   (if (not (setq article (or article (gnus-summary-article-number))))
3568       ;; All non-existent numbers are the last article.  :-)
3569       t
3570     (not (cdr (gnus-data-find-list article)))))
3571
3572 (defun gnus-make-thread-indent-array (&optional n)
3573   (when (or n
3574             (progn (setq n 200) nil)
3575             (null gnus-thread-indent-array)
3576             (/= gnus-thread-indent-level gnus-thread-indent-array-level))
3577     (setq gnus-thread-indent-array (make-vector (1+ n) "")
3578           gnus-thread-indent-array-level gnus-thread-indent-level)
3579     (while (>= n 0)
3580       (aset gnus-thread-indent-array n
3581             (make-string (* n gnus-thread-indent-level) ? ))
3582       (setq n (1- n)))))
3583
3584 (defun gnus-update-summary-mark-positions ()
3585   "Compute where the summary marks are to go."
3586   (save-excursion
3587     (when (gnus-buffer-exists-p gnus-summary-buffer)
3588       (set-buffer gnus-summary-buffer))
3589     (let ((spec gnus-summary-line-format-spec)
3590           pos)
3591       (save-excursion
3592         (gnus-set-work-buffer)
3593         (let ((gnus-tmp-unread ?Z)
3594               (gnus-replied-mark ?Z)
3595               (gnus-score-below-mark ?Z)
3596               (gnus-score-over-mark ?Z)
3597               (gnus-undownloaded-mark ?Z)
3598               (gnus-summary-line-format-spec spec)
3599               (gnus-newsgroup-downloadable '(0))
3600               (header [0 "" "" "05 Apr 2001 23:33:09 +0400" "" "" 0 0 "" nil])
3601               case-fold-search ignores)
3602           ;; Here, all marks are bound to Z.
3603           (gnus-summary-insert-line header
3604                                     0 nil t gnus-tmp-unread t nil "" nil 1)
3605           (goto-char (point-min))
3606           ;; Memorize the positions of the same characters as dummy marks.
3607           (while (re-search-forward "[A-D]" nil t)
3608             (push (point) ignores))
3609           (erase-buffer)
3610           ;; We use A-D as dummy marks in order to know column positions
3611           ;; where marks should be inserted.
3612           (setq gnus-tmp-unread ?A
3613                 gnus-replied-mark ?B
3614                 gnus-score-below-mark ?C
3615                 gnus-score-over-mark ?C
3616                 gnus-undownloaded-mark ?D)
3617           (gnus-summary-insert-line header
3618                                     0 nil t gnus-tmp-unread t nil "" nil 1)
3619           ;; Ignore characters which aren't dummy marks.
3620           (dolist (p ignores)
3621             (delete-region (goto-char (1- p)) p)
3622             (insert ?Z))
3623           (goto-char (point-min))
3624           (setq pos (list (cons 'unread
3625                                 (and (search-forward "A" nil t)
3626                                      (- (point) (point-min) 1)))))
3627           (goto-char (point-min))
3628           (push (cons 'replied (and (search-forward "B" nil t)
3629                                     (- (point) (point-min) 1)))
3630                 pos)
3631           (goto-char (point-min))
3632           (push (cons 'score (and (search-forward "C" nil t)
3633                                   (- (point) (point-min) 1)))
3634                 pos)
3635           (goto-char (point-min))
3636           (push (cons 'download (and (search-forward "D" nil t)
3637                                      (- (point) (point-min) 1)))
3638                 pos)))
3639       (setq gnus-summary-mark-positions pos))))
3640
3641 (defun gnus-summary-insert-dummy-line (gnus-tmp-subject gnus-tmp-number)
3642   "Insert a dummy root in the summary buffer."
3643   (beginning-of-line)
3644   (gnus-add-text-properties
3645    (point) (progn (eval gnus-summary-dummy-line-format-spec) (point))
3646    (list 'gnus-number gnus-tmp-number 'gnus-intangible gnus-tmp-number)))
3647
3648 (defun gnus-summary-extract-address-component (from)
3649   (or (car (funcall gnus-extract-address-components from))
3650       from))
3651
3652 (defun gnus-summary-from-or-to-or-newsgroups (header gnus-tmp-from)
3653   (let ((mail-parse-charset gnus-newsgroup-charset)
3654         (ignored-from-addresses (gnus-ignored-from-addresses))
3655         ; Is it really necessary to do this next part for each summary line?
3656         ; Luckily, doesn't seem to slow things down much.
3657         (mail-parse-ignored-charsets
3658          (with-current-buffer gnus-summary-buffer
3659            gnus-newsgroup-ignored-charsets)))
3660     (or
3661      (and ignored-from-addresses
3662           (string-match ignored-from-addresses gnus-tmp-from)
3663           (let ((extra-headers (mail-header-extra header))
3664                 to
3665                 newsgroups)
3666             (cond
3667              ((setq to (cdr (assq 'To extra-headers)))
3668               (concat gnus-summary-to-prefix
3669                       (inline
3670                         (gnus-summary-extract-address-component
3671                          (funcall gnus-decode-encoded-address-function to)))))
3672              ((setq newsgroups
3673                     (or
3674                      (cdr (assq 'Newsgroups extra-headers))
3675                      (and
3676                       (memq 'Newsgroups gnus-extra-headers)
3677                       (eq (car (gnus-find-method-for-group
3678                                 gnus-newsgroup-name)) 'nntp)
3679                       (gnus-group-real-name gnus-newsgroup-name))))
3680               (concat gnus-summary-newsgroup-prefix newsgroups)))))
3681      (inline (gnus-summary-extract-address-component gnus-tmp-from)))))
3682
3683 (defun gnus-summary-insert-line (gnus-tmp-header
3684                                  gnus-tmp-level gnus-tmp-current
3685                                  undownloaded gnus-tmp-unread gnus-tmp-replied
3686                                  gnus-tmp-expirable gnus-tmp-subject-or-nil
3687                                  &optional gnus-tmp-dummy gnus-tmp-score
3688                                  gnus-tmp-process)
3689   (if (>= gnus-tmp-level (length gnus-thread-indent-array))
3690       (gnus-make-thread-indent-array (max (* 2 (length gnus-thread-indent-array))
3691                                           gnus-tmp-level)))
3692   (let* ((gnus-tmp-indentation (aref gnus-thread-indent-array gnus-tmp-level))
3693          (gnus-tmp-lines (mail-header-lines gnus-tmp-header))
3694          (gnus-tmp-score (or gnus-tmp-score gnus-summary-default-score 0))
3695          (gnus-tmp-score-char
3696           (if (or (null gnus-summary-default-score)
3697                   (<= (abs (- gnus-tmp-score gnus-summary-default-score))
3698                       gnus-summary-zcore-fuzz))
3699               ?                         ;Whitespace
3700             (if (< gnus-tmp-score gnus-summary-default-score)
3701                 gnus-score-below-mark gnus-score-over-mark)))
3702          (gnus-tmp-number (mail-header-number gnus-tmp-header))
3703          (gnus-tmp-replied
3704           (cond (gnus-tmp-process gnus-process-mark)
3705                 ((memq gnus-tmp-current gnus-newsgroup-cached)
3706                  gnus-cached-mark)
3707                 (gnus-tmp-replied gnus-replied-mark)
3708                 ((memq gnus-tmp-current gnus-newsgroup-forwarded)
3709                  gnus-forwarded-mark)
3710                 ((memq gnus-tmp-current gnus-newsgroup-saved)
3711                  gnus-saved-mark)
3712                 ((memq gnus-tmp-number gnus-newsgroup-recent)
3713                  gnus-recent-mark)
3714                 ((memq gnus-tmp-number gnus-newsgroup-unseen)
3715                  gnus-unseen-mark)
3716                 (t gnus-no-mark)))
3717          (gnus-tmp-downloaded
3718           (cond (undownloaded
3719                  gnus-undownloaded-mark)
3720                 (gnus-newsgroup-agentized
3721                  gnus-downloaded-mark)
3722                 (t
3723                  gnus-no-mark)))
3724          (gnus-tmp-from (mail-header-from gnus-tmp-header))
3725          (gnus-tmp-name
3726           (cond
3727            ((string-match "<[^>]+> *$" gnus-tmp-from)
3728             (let ((beg (match-beginning 0)))
3729               (or (and (string-match "^\".+\"" gnus-tmp-from)
3730                        (substring gnus-tmp-from 1 (1- (match-end 0))))
3731                   (substring gnus-tmp-from 0 beg))))
3732            ((string-match "(.+)" gnus-tmp-from)
3733             (substring gnus-tmp-from
3734                        (1+ (match-beginning 0)) (1- (match-end 0))))
3735            (t gnus-tmp-from)))
3736          (gnus-tmp-subject (mail-header-subject gnus-tmp-header))
3737          (gnus-tmp-opening-bracket (if gnus-tmp-dummy ?\< ?\[))
3738          (gnus-tmp-closing-bracket (if gnus-tmp-dummy ?\> ?\]))
3739          (inhibit-read-only t))
3740     (when (string= gnus-tmp-name "")
3741       (setq gnus-tmp-name gnus-tmp-from))
3742     (unless (numberp gnus-tmp-lines)
3743       (setq gnus-tmp-lines -1))
3744     (if (= gnus-tmp-lines -1)
3745         (setq gnus-tmp-lines "?")
3746       (setq gnus-tmp-lines (number-to-string gnus-tmp-lines)))
3747     (condition-case ()
3748         (gnus-put-text-property
3749          (point)
3750          (progn (eval gnus-summary-line-format-spec) (point))
3751          'gnus-number gnus-tmp-number)
3752       (error (gnus-message 5 "Error updating the summary line")))
3753     (when (gnus-visual-p 'summary-highlight 'highlight)
3754       (forward-line -1)
3755       (gnus-run-hooks 'gnus-summary-update-hook)
3756       (forward-line 1))))
3757
3758 (defun gnus-summary-update-line (&optional dont-update)
3759   "Update summary line after change."
3760   (when (and gnus-summary-default-score
3761              (not gnus-summary-inhibit-highlight))
3762     (let* ((gnus-summary-inhibit-highlight t) ; Prevent recursion.
3763            (article (gnus-summary-article-number))
3764            (score (gnus-summary-article-score article)))
3765       (unless dont-update
3766         (if (and gnus-summary-mark-below
3767                  (< (gnus-summary-article-score)
3768                     gnus-summary-mark-below))
3769             ;; This article has a low score, so we mark it as read.
3770             (when (memq article gnus-newsgroup-unreads)
3771               (gnus-summary-mark-article-as-read gnus-low-score-mark))
3772           (when (eq (gnus-summary-article-mark) gnus-low-score-mark)
3773             ;; This article was previously marked as read on account
3774             ;; of a low score, but now it has risen, so we mark it as
3775             ;; unread.
3776             (gnus-summary-mark-article-as-unread gnus-unread-mark)))
3777         (gnus-summary-update-mark
3778          (if (or (null gnus-summary-default-score)
3779                  (<= (abs (- score gnus-summary-default-score))
3780                      gnus-summary-zcore-fuzz))
3781              ?                          ;Whitespace
3782            (if (< score gnus-summary-default-score)
3783                gnus-score-below-mark gnus-score-over-mark))
3784          'score))
3785       ;; Do visual highlighting.
3786       (when (gnus-visual-p 'summary-highlight 'highlight)
3787         (gnus-run-hooks 'gnus-summary-update-hook)))))
3788
3789 (defvar gnus-tmp-new-adopts nil)
3790
3791 (defun gnus-summary-number-of-articles-in-thread (thread &optional level char)
3792   "Return the number of articles in THREAD.
3793 This may be 0 in some cases -- if none of the articles in
3794 the thread are to be displayed."
3795   (let* ((number
3796          ;; Fix by Luc Van Eycken <Luc.VanEycken@esat.kuleuven.ac.be>.
3797           (cond
3798            ((not (listp thread))
3799             1)
3800            ((and (consp thread) (cdr thread))
3801             (apply
3802              '+ 1 (mapcar
3803                    'gnus-summary-number-of-articles-in-thread (cdr thread))))
3804            ((null thread)
3805             1)
3806            ((memq (mail-header-number (car thread)) gnus-newsgroup-limit)
3807             1)
3808            (t 0))))
3809     (when (and level (zerop level) gnus-tmp-new-adopts)
3810       (incf number
3811             (apply '+ (mapcar
3812                        'gnus-summary-number-of-articles-in-thread
3813                        gnus-tmp-new-adopts))))
3814     (if char
3815         (if (> number 1) gnus-not-empty-thread-mark
3816           gnus-empty-thread-mark)
3817       number)))
3818
3819 (defsubst gnus-summary-line-message-size (head)
3820   "Return pretty-printed version of message size.
3821 This function is intended to be used in
3822 `gnus-summary-line-format-alist'."
3823   (let ((c (or (mail-header-chars head) -1)))
3824     (cond ((< c 0) "n/a")               ; chars not available
3825           ((< c (* 1000 10)) (format "%1.1fk" (/ c 1024.0)))
3826           ((< c (* 1000 100)) (format "%dk" (/ c 1024.0)))
3827           ((< c (* 1000 10000)) (format "%1.1fM" (/ c (* 1024.0 1024))))
3828           (t (format "%dM" (/ c (* 1024.0 1024)))))))
3829
3830
3831 (defun gnus-summary-set-local-parameters (group)
3832   "Go through the local params of GROUP and set all variable specs in that list."
3833   (let ((vars '(quit-config)))          ; Ignore quit-config.
3834     (dolist (elem (gnus-group-find-parameter group))
3835       (and (consp elem)                 ; Has to be a cons.
3836            (consp (cdr elem))           ; The cdr has to be a list.
3837            (symbolp (car elem))         ; Has to be a symbol in there.
3838            (not (memq (car elem) vars))
3839            (ignore-errors
3840              (push (car elem) vars)
3841              ;; Variables like `gnus-show-threads' that are globally
3842              ;; bound, if used as group parameters, need to get to be
3843              ;; buffer-local, whereas just parameters like `gcc-self',
3844              ;; `timestamp', etc. should not be bound as variables.
3845              (if (boundp (car elem))
3846                  (set (make-local-variable (car elem)) (eval (nth 1 elem)))
3847                (eval (nth 1 elem))))))))
3848
3849 (defun gnus-summary-read-group (group &optional show-all no-article
3850                                       kill-buffer no-display backward
3851                                       select-articles)
3852   "Start reading news in newsgroup GROUP.
3853 If SHOW-ALL is non-nil, already read articles are also listed.
3854 If NO-ARTICLE is non-nil, no article is selected initially.
3855 If NO-DISPLAY, don't generate a summary buffer."
3856   (let (result)
3857     (while (and group
3858                 (null (setq result
3859                             (let ((gnus-auto-select-next nil))
3860                               (or (gnus-summary-read-group-1
3861                                    group show-all no-article
3862                                    kill-buffer no-display
3863                                    select-articles)
3864                                   (setq show-all nil
3865                                         select-articles nil)))))
3866                 (eq gnus-auto-select-next 'quietly))
3867       (set-buffer gnus-group-buffer)
3868       ;; The entry function called above goes to the next
3869       ;; group automatically, so we go two groups back
3870       ;; if we are searching for the previous group.
3871       (when backward
3872         (gnus-group-prev-unread-group 2))
3873       (if (not (equal group (gnus-group-group-name)))
3874           (setq group (gnus-group-group-name))
3875         (setq group nil)))
3876     result))
3877
3878 (defun gnus-summary-read-group-1 (group show-all no-article
3879                                         kill-buffer no-display
3880                                         &optional select-articles)
3881   ;; Killed foreign groups can't be entered.
3882   ;;  (when (and (not (gnus-group-native-p group))
3883   ;;         (not (gnus-gethash group gnus-newsrc-hashtb)))
3884   ;;    (error "Dead non-native groups can't be entered"))
3885   (gnus-message 5 "Retrieving newsgroup: %s..."
3886                 (gnus-group-decoded-name group))
3887   (let* ((new-group (gnus-summary-setup-buffer group))
3888          (quit-config (gnus-group-quit-config group))
3889          (did-select (and new-group (gnus-select-newsgroup
3890                                      group show-all select-articles))))
3891     (cond
3892      ;; This summary buffer exists already, so we just select it.
3893      ((not new-group)
3894       (gnus-set-global-variables)
3895       (when kill-buffer
3896         (gnus-kill-or-deaden-summary kill-buffer))
3897       (gnus-configure-windows 'summary 'force)
3898       (gnus-set-mode-line 'summary)
3899       (gnus-summary-position-point)
3900       (message "")
3901       t)
3902      ;; We couldn't select this group.
3903      ((null did-select)
3904       (when (and (eq major-mode 'gnus-summary-mode)
3905                  (not (equal (current-buffer) kill-buffer)))
3906         (kill-buffer (current-buffer))
3907         (if (not quit-config)
3908             (progn
3909               ;; Update the info -- marks might need to be removed,
3910               ;; for instance.
3911               (gnus-summary-update-info)
3912               (set-buffer gnus-group-buffer)
3913               (gnus-group-jump-to-group group)
3914               (gnus-group-next-unread-group 1))
3915           (gnus-handle-ephemeral-exit quit-config)))
3916       (let ((grpinfo (gnus-get-info group)))
3917         (if (null (gnus-info-read grpinfo))
3918             (gnus-message 3 "Group %s contains no messages"
3919                           (gnus-group-decoded-name group))
3920           (gnus-message 3 "Can't select group")))
3921       nil)
3922      ;; The user did a `C-g' while prompting for number of articles,
3923      ;; so we exit this group.
3924      ((eq did-select 'quit)
3925       (and (eq major-mode 'gnus-summary-mode)
3926            (not (equal (current-buffer) kill-buffer))
3927            (kill-buffer (current-buffer)))
3928       (when kill-buffer
3929         (gnus-kill-or-deaden-summary kill-buffer))
3930       (if (not quit-config)
3931           (progn
3932             (set-buffer gnus-group-buffer)
3933             (gnus-group-jump-to-group group)
3934             (gnus-configure-windows 'group 'force))
3935         (gnus-handle-ephemeral-exit quit-config))
3936       ;; Finally signal the quit.
3937       (signal 'quit nil))
3938      ;; The group was successfully selected.
3939      (t
3940       (gnus-set-global-variables)
3941       ;; Save the active value in effect when the group was entered.
3942       (setq gnus-newsgroup-active
3943             (gnus-copy-sequence
3944              (gnus-active gnus-newsgroup-name)))
3945       ;; You can change the summary buffer in some way with this hook.
3946       (gnus-run-hooks 'gnus-select-group-hook)
3947       (when (memq 'summary (gnus-update-format-specifications
3948                             nil 'summary 'summary-mode 'summary-dummy))
3949         ;; The format specification for the summary line was updated,
3950         ;; so we need to update the mark positions as well.
3951         (gnus-update-summary-mark-positions))
3952       ;; Do score processing.
3953       (when gnus-use-scoring
3954         (gnus-possibly-score-headers))
3955       ;; Check whether to fill in the gaps in the threads.
3956       (when gnus-build-sparse-threads
3957         (gnus-build-sparse-threads))
3958       ;; Find the initial limit.
3959       (if show-all
3960           (let ((gnus-newsgroup-dormant nil))
3961             (gnus-summary-initial-limit show-all))
3962         (gnus-summary-initial-limit show-all))
3963       ;; Generate the summary buffer.
3964       (unless no-display
3965         (gnus-summary-prepare))
3966       (when gnus-use-trees
3967         (gnus-tree-open group)
3968         (setq gnus-summary-highlight-line-function
3969               'gnus-tree-highlight-article))
3970       ;; If the summary buffer is empty, but there are some low-scored
3971       ;; articles or some excluded dormants, we include these in the
3972       ;; buffer.
3973       (when (and (zerop (buffer-size))
3974                  (not no-display))
3975         (cond (gnus-newsgroup-dormant
3976                (gnus-summary-limit-include-dormant))
3977               ((and gnus-newsgroup-scored show-all)
3978                (gnus-summary-limit-include-expunged t))))
3979       ;; Function `gnus-apply-kill-file' must be called in this hook.
3980       (gnus-run-hooks 'gnus-apply-kill-hook)
3981       (if (and (zerop (buffer-size))
3982                (not no-display))
3983           (progn
3984             ;; This newsgroup is empty.
3985             (gnus-summary-catchup-and-exit nil t)
3986             (gnus-message 6 "No unread news")
3987             (when kill-buffer
3988               (gnus-kill-or-deaden-summary kill-buffer))
3989             ;; Return nil from this function.
3990             nil)
3991         ;; Hide conversation thread subtrees.  We cannot do this in
3992         ;; gnus-summary-prepare-hook since kill processing may not
3993         ;; work with hidden articles.
3994         (gnus-summary-maybe-hide-threads)
3995         (when kill-buffer
3996           (gnus-kill-or-deaden-summary kill-buffer))
3997         (gnus-summary-auto-select-subject)
3998         ;; Show first unread article if requested.
3999         (if (and (not no-article)
4000                  (not no-display)
4001                  gnus-newsgroup-unreads
4002                  gnus-auto-select-first)
4003             (progn
4004               (gnus-configure-windows 'summary)
4005               (let ((art (gnus-summary-article-number)))
4006                 (unless (and (not gnus-plugged)
4007                              (or (memq art gnus-newsgroup-undownloaded)
4008                                  (memq art gnus-newsgroup-downloadable)))
4009                   (gnus-summary-goto-article art))))
4010           ;; Don't select any articles.
4011           (gnus-summary-position-point)
4012           (gnus-configure-windows 'summary 'force)
4013           (gnus-set-mode-line 'summary))
4014         (when (and gnus-auto-center-group
4015                    (get-buffer-window gnus-group-buffer t))
4016           ;; Gotta use windows, because recenter does weird stuff if
4017           ;; the current buffer ain't the displayed window.
4018           (let ((owin (selected-window)))
4019             (select-window (get-buffer-window gnus-group-buffer t))
4020             (when (gnus-group-goto-group group)
4021               (recenter))
4022             (select-window owin)))
4023         ;; Mark this buffer as "prepared".
4024         (setq gnus-newsgroup-prepared t)
4025         (gnus-run-hooks 'gnus-summary-prepared-hook)
4026         (unless (gnus-ephemeral-group-p group)
4027           (gnus-group-update-group group))
4028         t)))))
4029
4030 (defun gnus-summary-auto-select-subject ()
4031   "Select the subject line on initial group entry."
4032   (goto-char (point-min))
4033   (cond
4034    ((eq gnus-auto-select-subject 'best)
4035     (gnus-summary-best-unread-subject))
4036    ((eq gnus-auto-select-subject 'unread)
4037     (gnus-summary-first-unread-subject))
4038    ((eq gnus-auto-select-subject 'unseen)
4039     (gnus-summary-first-unseen-subject))
4040    ((eq gnus-auto-select-subject 'unseen-or-unread)
4041     (gnus-summary-first-unseen-or-unread-subject))
4042    ((eq gnus-auto-select-subject 'first)
4043     ;; Do nothing.
4044     )
4045    ((functionp gnus-auto-select-subject)
4046     (funcall gnus-auto-select-subject))))
4047
4048 (defun gnus-summary-prepare ()
4049   "Generate the summary buffer."
4050   (interactive)
4051   (let ((inhibit-read-only t))
4052     (erase-buffer)
4053     (setq gnus-newsgroup-data nil
4054           gnus-newsgroup-data-reverse nil)
4055     (gnus-run-hooks 'gnus-summary-generate-hook)
4056     ;; Generate the buffer, either with threads or without.
4057     (when gnus-newsgroup-headers
4058       (gnus-summary-prepare-threads
4059        (if gnus-show-threads
4060            (gnus-sort-gathered-threads
4061             (funcall gnus-summary-thread-gathering-function
4062                      (gnus-sort-threads
4063                       (gnus-cut-threads (gnus-make-threads)))))
4064          ;; Unthreaded display.
4065          (gnus-sort-articles gnus-newsgroup-headers))))
4066     (setq gnus-newsgroup-data (nreverse gnus-newsgroup-data))
4067     ;; Call hooks for modifying summary buffer.
4068     (goto-char (point-min))
4069     (gnus-run-hooks 'gnus-summary-prepare-hook)))
4070
4071 (defsubst gnus-general-simplify-subject (subject)
4072   "Simplify subject by the same rules as `gnus-gather-threads-by-subject'."
4073   (setq subject
4074         (cond
4075          ;; Truncate the subject.
4076          (gnus-simplify-subject-functions
4077           (gnus-map-function gnus-simplify-subject-functions subject))
4078          ((numberp gnus-summary-gather-subject-limit)
4079           (setq subject (gnus-simplify-subject-re subject))
4080           (if (> (length subject) gnus-summary-gather-subject-limit)
4081               (substring subject 0 gnus-summary-gather-subject-limit)
4082             subject))
4083          ;; Fuzzily simplify it.
4084          ((eq 'fuzzy gnus-summary-gather-subject-limit)
4085           (gnus-simplify-subject-fuzzy subject))
4086          ;; Just remove the leading "Re:".
4087          (t
4088           (gnus-simplify-subject-re subject))))
4089
4090   (if (and gnus-summary-gather-exclude-subject
4091            (string-match gnus-summary-gather-exclude-subject subject))
4092       nil                         ; This article shouldn't be gathered
4093     subject))
4094
4095 (defun gnus-summary-simplify-subject-query ()
4096   "Query where the respool algorithm would put this article."
4097   (interactive)
4098   (gnus-summary-select-article)
4099   (message "%s" (gnus-general-simplify-subject (gnus-summary-article-subject))))
4100
4101 (defun gnus-gather-threads-by-subject (threads)
4102   "Gather threads by looking at Subject headers."
4103   (if (not gnus-summary-make-false-root)
4104       threads
4105     (let ((hashtb (gnus-make-hashtable 1024))
4106           (prev threads)
4107           (result threads)
4108           subject hthread whole-subject)
4109       (while threads
4110         (setq subject (gnus-general-simplify-subject
4111                        (setq whole-subject (mail-header-subject
4112                                             (caar threads)))))
4113         (when subject
4114           (if (setq hthread (gnus-gethash subject hashtb))
4115               (progn
4116                 ;; We enter a dummy root into the thread, if we
4117                 ;; haven't done that already.
4118                 (unless (stringp (caar hthread))
4119                   (setcar hthread (list whole-subject (car hthread))))
4120                 ;; We add this new gathered thread to this gathered
4121                 ;; thread.
4122                 (setcdr (car hthread)
4123                         (nconc (cdar hthread) (list (car threads))))
4124                 ;; Remove it from the list of threads.
4125                 (setcdr prev (cdr threads))
4126                 (setq threads prev))
4127             ;; Enter this thread into the hash table.
4128             (gnus-sethash subject
4129                           (if gnus-summary-make-false-root-always
4130                               (progn
4131                                 ;; If you want a dummy root above all
4132                                 ;; threads...
4133                                 (setcar threads (list whole-subject
4134                                                       (car threads)))
4135                                 threads)
4136                             threads)
4137                           hashtb)))
4138         (setq prev threads)
4139         (setq threads (cdr threads)))
4140       result)))
4141
4142 (defun gnus-gather-threads-by-references (threads)
4143   "Gather threads by looking at References headers."
4144   (let ((idhashtb (gnus-make-hashtable 1024))
4145         (thhashtb (gnus-make-hashtable 1024))
4146         (prev threads)
4147         (result threads)
4148         ids references id gthread gid entered ref)
4149     (while threads
4150       (when (setq references (mail-header-references (caar threads)))
4151         (setq id (mail-header-id (caar threads))
4152               ids (inline (gnus-split-references references))
4153               entered nil)
4154         (while (setq ref (pop ids))
4155           (setq ids (delete ref ids))
4156           (if (not (setq gid (gnus-gethash ref idhashtb)))
4157               (progn
4158                 (gnus-sethash ref id idhashtb)
4159                 (gnus-sethash id threads thhashtb))
4160             (setq gthread (gnus-gethash gid thhashtb))
4161             (unless entered
4162               ;; We enter a dummy root into the thread, if we
4163               ;; haven't done that already.
4164               (unless (stringp (caar gthread))
4165                 (setcar gthread (list (mail-header-subject (caar gthread))
4166                                       (car gthread))))
4167               ;; We add this new gathered thread to this gathered
4168               ;; thread.
4169               (setcdr (car gthread)
4170                       (nconc (cdar gthread) (list (car threads)))))
4171             ;; Add it into the thread hash table.
4172             (gnus-sethash id gthread thhashtb)
4173             (setq entered t)
4174             ;; Remove it from the list of threads.
4175             (setcdr prev (cdr threads))
4176             (setq threads prev))))
4177       (setq prev threads)
4178       (setq threads (cdr threads)))
4179     result))
4180
4181 (defun gnus-sort-gathered-threads (threads)
4182   "Sort subtreads inside each gathered thread by `gnus-sort-gathered-threads-function'."
4183   (let ((result threads))
4184     (while threads
4185       (when (stringp (caar threads))
4186         (setcdr (car threads)
4187                 (sort (cdar threads) gnus-sort-gathered-threads-function)))
4188       (setq threads (cdr threads)))
4189     result))
4190
4191 (defun gnus-thread-loop-p (root thread)
4192   "Say whether ROOT is in THREAD."
4193   (let ((stack (list thread))
4194         (infloop 0)
4195         th)
4196     (while (setq thread (pop stack))
4197       (setq th (cdr thread))
4198       (while (and th
4199                   (not (eq (caar th) root)))
4200         (pop th))
4201       (if th
4202           ;; We have found a loop.
4203           (let (ref-dep)
4204             (setcdr thread (delq (car th) (cdr thread)))
4205             (if (boundp (setq ref-dep (intern "none"
4206                                               gnus-newsgroup-dependencies)))
4207                 (setcdr (symbol-value ref-dep)
4208                         (nconc (cdr (symbol-value ref-dep))
4209                                (list (car th))))
4210               (set ref-dep (list nil (car th))))
4211             (setq infloop 1
4212                   stack nil))
4213         ;; Push all the subthreads onto the stack.
4214         (push (cdr thread) stack)))
4215     infloop))
4216
4217 (defun gnus-make-threads ()
4218   "Go through the dependency hashtb and find the roots.  Return all threads."
4219   (let (threads)
4220     (while (catch 'infloop
4221              (mapatoms
4222               (lambda (refs)
4223                 ;; Deal with self-referencing References loops.
4224                 (when (and (car (symbol-value refs))
4225                            (not (zerop
4226                                  (apply
4227                                   '+
4228                                   (mapcar
4229                                    (lambda (thread)
4230                                      (gnus-thread-loop-p
4231                                       (car (symbol-value refs)) thread))
4232                                    (cdr (symbol-value refs)))))))
4233                   (setq threads nil)
4234                   (throw 'infloop t))
4235                 (unless (car (symbol-value refs))
4236                   ;; These threads do not refer back to any other
4237                   ;; articles, so they're roots.
4238                   (setq threads (append (cdr (symbol-value refs)) threads))))
4239               gnus-newsgroup-dependencies)))
4240     threads))
4241
4242 ;; Build the thread tree.
4243 (defsubst gnus-dependencies-add-header (header dependencies force-new)
4244   "Enter HEADER into the DEPENDENCIES table if it is not already there.
4245
4246 If FORCE-NEW is not nil, enter HEADER into the DEPENDENCIES table even
4247 if it was already present.
4248
4249 If `gnus-summary-ignore-duplicates' is nil then duplicate Message-IDs
4250 will not be entered in the DEPENDENCIES table.  Otherwise duplicate
4251 Message-IDs will be renamed to a unique Message-ID before being
4252 entered.
4253
4254 Returns HEADER if it was entered in the DEPENDENCIES.  Returns nil otherwise."
4255   (let* ((id (mail-header-id header))
4256          (id-dep (and id (intern id dependencies)))
4257          parent-id ref ref-dep ref-header replaced)
4258     ;; Enter this `header' in the `dependencies' table.
4259     (cond
4260      ((not id-dep)
4261       (setq header nil))
4262      ;; The first two cases do the normal part: enter a new `header'
4263      ;; in the `dependencies' table.
4264      ((not (boundp id-dep))
4265       (set id-dep (list header)))
4266      ((null (car (symbol-value id-dep)))
4267       (setcar (symbol-value id-dep) header))
4268
4269      ;; From here the `header' was already present in the
4270      ;; `dependencies' table.
4271      (force-new
4272       ;; Overrides an existing entry;
4273       ;; just set the header part of the entry.
4274       (setcar (symbol-value id-dep) header)
4275       (setq replaced t))
4276
4277      ;; Renames the existing `header' to a unique Message-ID.
4278      ((not gnus-summary-ignore-duplicates)
4279       ;; An article with this Message-ID has already been seen.
4280       ;; We rename the Message-ID.
4281       (set (setq id-dep (intern (setq id (nnmail-message-id)) dependencies))
4282            (list header))
4283       (mail-header-set-id header id))
4284
4285      ;; The last case ignores an existing entry, except it adds any
4286      ;; additional Xrefs (in case the two articles came from different
4287      ;; servers.
4288      ;; Also sets `header' to `nil' meaning that the `dependencies'
4289      ;; table was *not* modified.
4290      (t
4291       (mail-header-set-xref
4292        (car (symbol-value id-dep))
4293        (concat (or (mail-header-xref (car (symbol-value id-dep)))
4294                    "")
4295                (or (mail-header-xref header) "")))
4296       (setq header nil)))
4297
4298     (when (and header (not replaced))
4299       ;; First check that we are not creating a References loop.
4300       (setq parent-id (gnus-parent-id (mail-header-references header)))
4301       (setq ref parent-id)
4302       (while (and ref
4303                   (setq ref-dep (intern-soft ref dependencies))
4304                   (boundp ref-dep)
4305                   (setq ref-header (car (symbol-value ref-dep))))
4306         (if (string= id ref)
4307             ;; Yuk!  This is a reference loop.  Make the article be a
4308             ;; root article.
4309             (progn
4310               (mail-header-set-references (car (symbol-value id-dep)) "none")
4311               (setq ref nil)
4312               (setq parent-id nil))
4313           (setq ref (gnus-parent-id (mail-header-references ref-header)))))
4314       (setq ref-dep (intern (or parent-id "none") dependencies))
4315       (if (boundp ref-dep)
4316           (setcdr (symbol-value ref-dep)
4317                   (nconc (cdr (symbol-value ref-dep))
4318                          (list (symbol-value id-dep))))
4319         (set ref-dep (list nil (symbol-value id-dep)))))
4320     header))
4321
4322 (defun gnus-extract-message-id-from-in-reply-to (string)
4323   (if (string-match "<[^>]+>" string)
4324       (substring string (match-beginning 0) (match-end 0))
4325     nil))
4326
4327 (defun gnus-build-sparse-threads ()
4328   (let ((headers gnus-newsgroup-headers)
4329         (mail-parse-charset gnus-newsgroup-charset)
4330         (gnus-summary-ignore-duplicates t)
4331         header references generation relations
4332         subject child end new-child date)
4333     ;; First we create an alist of generations/relations, where
4334     ;; generations is how much we trust the relation, and the relation
4335     ;; is parent/child.
4336     (gnus-message 7 "Making sparse threads...")
4337     (save-excursion
4338       (nnheader-set-temp-buffer " *gnus sparse threads*")
4339       (while (setq header (pop headers))
4340         (when (and (setq references (mail-header-references header))
4341                    (not (string= references "")))
4342           (insert references)
4343           (setq child (mail-header-id header)
4344                 subject (mail-header-subject header)
4345                 date (mail-header-date header)
4346                 generation 0)
4347           (while (search-backward ">" nil t)
4348             (setq end (1+ (point)))
4349             (when (search-backward "<" nil t)
4350               (setq new-child (buffer-substring (point) end))
4351               (push (list (incf generation)
4352                           child (setq child new-child)
4353                           subject date)
4354                     relations)))
4355           (when child
4356             (push (list (1+ generation) child nil subject) relations))
4357           (erase-buffer)))
4358       (kill-buffer (current-buffer)))
4359     ;; Sort over trustworthiness.
4360     (dolist (relation (sort relations 'car-less-than-car))
4361       (when (gnus-dependencies-add-header
4362              (make-full-mail-header
4363               gnus-reffed-article-number
4364               (nth 3 relation) "" (or (nth 4 relation) "")
4365               (nth 1 relation)
4366               (or (nth 2 relation) "") 0 0 "")
4367              gnus-newsgroup-dependencies nil)
4368         (push gnus-reffed-article-number gnus-newsgroup-limit)
4369         (push gnus-reffed-article-number gnus-newsgroup-sparse)
4370         (push (cons gnus-reffed-article-number gnus-sparse-mark)
4371               gnus-newsgroup-reads)
4372         (decf gnus-reffed-article-number)))
4373     (gnus-message 7 "Making sparse threads...done")))
4374
4375 (defun gnus-build-old-threads ()
4376   ;; Look at all the articles that refer back to old articles, and
4377   ;; fetch the headers for the articles that aren't there.  This will
4378   ;; build complete threads - if the roots haven't been expired by the
4379   ;; server, that is.
4380   (let ((mail-parse-charset gnus-newsgroup-charset)
4381         id heads)
4382     (mapatoms
4383      (lambda (refs)
4384        (when (not (car (symbol-value refs)))
4385          (setq heads (cdr (symbol-value refs)))
4386          (while heads
4387            (if (memq (mail-header-number (caar heads))
4388                      gnus-newsgroup-dormant)
4389                (setq heads (cdr heads))
4390              (setq id (symbol-name refs))
4391              (while (and (setq id (gnus-build-get-header id))
4392                          (not (car (gnus-id-to-thread id)))))
4393              (setq heads nil)))))
4394      gnus-newsgroup-dependencies)))
4395
4396 (defsubst gnus-remove-odd-characters (string)
4397   "Translate STRING into something that doesn't contain weird characters."
4398   (mm-subst-char-in-string
4399    ?\r ?\-
4400    (mm-subst-char-in-string ?\n ?\- string t) t))
4401
4402 ;; This function has to be called with point after the article number
4403 ;; on the beginning of the line.
4404 (defsubst gnus-nov-parse-line (number dependencies &optional force-new)
4405   (let ((eol (point-at-eol))
4406         (buffer (current-buffer))
4407         header references in-reply-to)
4408
4409     ;; overview: [num subject from date id refs chars lines misc]
4410     (unwind-protect
4411         (let (x)
4412           (narrow-to-region (point) eol)
4413           (unless (eobp)
4414             (forward-char))
4415
4416           (setq header
4417                 (make-full-mail-header
4418                  number                 ; number
4419                  (condition-case ()     ; subject
4420                      (gnus-remove-odd-characters
4421                       (funcall gnus-decode-encoded-word-function
4422                                (setq x (nnheader-nov-field))))
4423                    (error x))
4424                  (condition-case ()     ; from
4425                      (gnus-remove-odd-characters
4426                       (funcall gnus-decode-encoded-address-function
4427                                (setq x (nnheader-nov-field))))
4428                    (error x))
4429                  (nnheader-nov-field)   ; date
4430                  (nnheader-nov-read-message-id number)  ; id
4431                  (setq references (nnheader-nov-field)) ; refs
4432                  (nnheader-nov-read-integer) ; chars
4433                  (nnheader-nov-read-integer) ; lines
4434                  (unless (eobp)
4435                    (if (looking-at "Xref: ")
4436                        (goto-char (match-end 0)))
4437                    (nnheader-nov-field)) ; Xref
4438                  (nnheader-nov-parse-extra)))) ; extra
4439
4440       (widen))
4441
4442     (when (and (string= references "")
4443                (setq in-reply-to (mail-header-extra header))
4444                (setq in-reply-to (cdr (assq 'In-Reply-To in-reply-to))))
4445       (mail-header-set-references
4446        header (gnus-extract-message-id-from-in-reply-to in-reply-to)))
4447
4448     (when gnus-alter-header-function
4449       (funcall gnus-alter-header-function header))
4450     (gnus-dependencies-add-header header dependencies force-new)))
4451
4452 (defun gnus-build-get-header (id)
4453   "Look through the buffer of NOV lines and find the header to ID.
4454 Enter this line into the dependencies hash table, and return
4455 the id of the parent article (if any)."
4456   (let ((deps gnus-newsgroup-dependencies)
4457         found header)
4458     (prog1
4459         (with-current-buffer nntp-server-buffer
4460           (let ((case-fold-search nil))
4461             (goto-char (point-min))
4462             (while (and (not found)
4463                         (search-forward id nil t))
4464               (beginning-of-line)
4465               (setq found (looking-at
4466                            (format "^[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t%s"
4467                                    (regexp-quote id))))
4468               (or found (beginning-of-line 2)))
4469             (when found
4470               (beginning-of-line)
4471               (and
4472                (setq header (gnus-nov-parse-line
4473                              (read (current-buffer)) deps))
4474                (gnus-parent-id (mail-header-references header))))))
4475       (when header
4476         (let ((number (mail-header-number header)))
4477           (push number gnus-newsgroup-limit)
4478           (push header gnus-newsgroup-headers)
4479           (if (memq number gnus-newsgroup-unselected)
4480               (progn
4481                 (setq gnus-newsgroup-unreads
4482                       (gnus-add-to-sorted-list gnus-newsgroup-unreads
4483                                                number))
4484                 (setq gnus-newsgroup-unselected
4485                       (delq number gnus-newsgroup-unselected)))
4486             (push number gnus-newsgroup-ancient)))))))
4487
4488 (defun gnus-build-all-threads ()
4489   "Read all the headers."
4490   (let ((gnus-summary-ignore-duplicates t)
4491         (mail-parse-charset gnus-newsgroup-charset)
4492         (dependencies gnus-newsgroup-dependencies)
4493         header article)
4494     (with-current-buffer nntp-server-buffer
4495       (let ((case-fold-search nil))
4496         (goto-char (point-min))
4497         (while (not (eobp))
4498           (ignore-errors
4499             (setq article (read (current-buffer))
4500                   header (gnus-nov-parse-line article dependencies)))
4501           (when header
4502             (with-current-buffer gnus-summary-buffer
4503               (push header gnus-newsgroup-headers)
4504               (if (memq (setq article (mail-header-number header))
4505                         gnus-newsgroup-unselected)
4506                   (progn
4507                     (setq gnus-newsgroup-unreads
4508                           (gnus-add-to-sorted-list
4509                            gnus-newsgroup-unreads article))
4510                     (setq gnus-newsgroup-unselected
4511                           (delq article gnus-newsgroup-unselected)))
4512                 (push article gnus-newsgroup-ancient)))
4513             (forward-line 1)))))))
4514
4515 (defun gnus-summary-update-article-line (article header)
4516   "Update the line for ARTICLE using HEADER."
4517   (let* ((id (mail-header-id header))
4518          (thread (gnus-id-to-thread id)))
4519     (unless thread
4520       (error "Article in no thread"))
4521     ;; Update the thread.
4522     (setcar thread header)
4523     (gnus-summary-goto-subject article)
4524     (let* ((datal (gnus-data-find-list article))
4525            (data (car datal))
4526            (inhibit-read-only t)
4527            (level (gnus-summary-thread-level)))
4528       (gnus-delete-line)
4529       (let ((inserted (- (point)
4530                          (progn
4531                            (gnus-summary-insert-line
4532                             header level nil
4533                             (memq article gnus-newsgroup-undownloaded)
4534                             (gnus-article-mark article)
4535                             (memq article gnus-newsgroup-replied)
4536                             (memq article gnus-newsgroup-expirable)
4537                             ;; Only insert the Subject string when it's different
4538                             ;; from the previous Subject string.
4539                             (if (and
4540                                  gnus-show-threads
4541                                  (gnus-subject-equal
4542                                   (condition-case ()
4543                                       (mail-header-subject
4544                                        (gnus-data-header
4545                                         (cadr
4546                                          (gnus-data-find-list
4547                                           article
4548                                           (gnus-data-list t)))))
4549                                     ;; Error on the side of excessive subjects.
4550                                     (error ""))
4551                                   (mail-header-subject header)))
4552                                 ""
4553                               (mail-header-subject header))
4554                             nil (cdr (assq article gnus-newsgroup-scored))
4555                             (memq article gnus-newsgroup-processable))
4556                            (point)))))
4557         (when (cdr datal)
4558           (gnus-data-update-list
4559            (cdr datal)
4560            (- (gnus-data-pos data) (gnus-data-pos (cadr datal)) inserted)))))))
4561
4562 (defun gnus-summary-update-article (article &optional iheader)
4563   "Update ARTICLE in the summary buffer."
4564   (set-buffer gnus-summary-buffer)
4565   (let* ((header (gnus-summary-article-header article))
4566          (id (mail-header-id header))
4567          (data (gnus-data-find article))
4568          (thread (gnus-id-to-thread id))
4569          (references (mail-header-references header))
4570          (parent
4571           (gnus-id-to-thread
4572            (or (gnus-parent-id
4573                 (when (and references
4574                            (not (equal "" references)))
4575                   references))
4576                "none")))
4577          (inhibit-read-only t)
4578          (old (car thread)))
4579     (when thread
4580       (unless iheader
4581         (setcar thread nil)
4582         (when parent
4583           (delq thread parent)))
4584       (if (gnus-summary-insert-subject id header)
4585           ;; Set the (possibly) new article number in the data structure.
4586           (gnus-data-set-number data (gnus-id-to-article id))
4587         (setcar thread old)
4588         nil))))
4589
4590 (defun gnus-rebuild-thread (id &optional line)
4591   "Rebuild the thread containing ID.
4592 If LINE, insert the rebuilt thread starting on line LINE."
4593   (let ((inhibit-read-only t)
4594         old-pos current thread data)
4595     (if (not gnus-show-threads)
4596         (setq thread (list (car (gnus-id-to-thread id))))
4597       ;; Get the thread this article is part of.
4598       (setq thread (gnus-remove-thread id)))
4599     (setq old-pos (point-at-bol))
4600     (setq current (save-excursion
4601                     (and (re-search-backward "[\r\n]" nil t)
4602                          (gnus-summary-article-number))))
4603     ;; If this is a gathered thread, we have to go some re-gathering.
4604     (when (stringp (car thread))
4605       (let ((subject (car thread))
4606             roots thr)
4607         (setq thread (cdr thread))
4608         (while thread
4609           (unless (memq (setq thr (gnus-id-to-thread
4610                                    (gnus-root-id
4611                                     (mail-header-id (caar thread)))))
4612                         roots)
4613             (push thr roots))
4614           (setq thread (cdr thread)))
4615         ;; We now have all (unique) roots.
4616         (if (= (length roots) 1)
4617             ;; All the loose roots are now one solid root.
4618             (setq thread (car roots))
4619           (setq thread (cons subject (gnus-sort-threads roots))))))
4620     (let (threads)
4621       ;; We then insert this thread into the summary buffer.
4622       (when line
4623         (goto-char (point-min))
4624         (forward-line (1- line)))
4625       (let (gnus-newsgroup-data gnus-newsgroup-threads)
4626         (if gnus-show-threads
4627             (gnus-summary-prepare-threads (gnus-cut-threads (list thread)))
4628           (gnus-summary-prepare-unthreaded thread))
4629         (setq data (nreverse gnus-newsgroup-data))
4630         (setq threads gnus-newsgroup-threads))
4631       ;; We splice the new data into the data structure.
4632       ;;!!! This is kinda bogus.  We assume that in LINE is non-nil,
4633       ;;!!! then we want to insert at the beginning of the buffer.
4634       ;;!!! That happens to be true with Gnus now, but that may
4635       ;;!!! change in the future.  Perhaps.
4636       (gnus-data-enter-list
4637        (if line nil current) data (- (point) old-pos))
4638       (setq gnus-newsgroup-threads
4639             (nconc threads gnus-newsgroup-threads))
4640       (gnus-data-compute-positions))))
4641
4642 (defun gnus-number-to-header (number)
4643   "Return the header for article NUMBER."
4644   (let ((headers gnus-newsgroup-headers))
4645     (while (and headers
4646                 (not (= number (mail-header-number (car headers)))))
4647       (pop headers))
4648     (when headers
4649       (car headers))))
4650
4651 (defun gnus-parent-headers (in-headers &optional generation)
4652   "Return the headers of the GENERATIONeth parent of HEADERS."
4653   (unless generation
4654     (setq generation 1))
4655   (let ((parent t)
4656         (headers in-headers)
4657         references)
4658     (while (and parent
4659                 (not (zerop generation))
4660                 (setq references (mail-header-references headers)))
4661       (setq headers (if (and references
4662                              (setq parent (gnus-parent-id references)))
4663                         (car (gnus-id-to-thread parent))
4664                       nil))
4665       (decf generation))
4666     (and (not (eq headers in-headers))
4667          headers)))
4668
4669 (defun gnus-id-to-thread (id)
4670   "Return the (sub-)thread where ID appears."
4671   (gnus-gethash id gnus-newsgroup-dependencies))
4672
4673 (defun gnus-id-to-article (id)
4674   "Return the article number of ID."
4675   (let ((thread (gnus-id-to-thread id)))
4676     (when (and thread
4677                (car thread))
4678       (mail-header-number (car thread)))))
4679
4680 (defun gnus-id-to-header (id)
4681   "Return the article headers of ID."
4682   (car (gnus-id-to-thread id)))
4683
4684 (defun gnus-article-displayed-root-p (article)
4685   "Say whether ARTICLE is a root(ish) article."
4686   (let ((level (gnus-summary-thread-level article))
4687         (refs (mail-header-references  (gnus-summary-article-header article)))
4688         particle)
4689     (cond
4690      ((null level) nil)
4691      ((zerop level) t)
4692      ((null refs) t)
4693      ((null (gnus-parent-id refs)) t)
4694      ((and (= 1 level)
4695            (null (setq particle (gnus-id-to-article
4696                                  (gnus-parent-id refs))))
4697            (null (gnus-summary-thread-level particle)))))))
4698
4699 (defun gnus-root-id (id)
4700   "Return the id of the root of the thread where ID appears."
4701   (let (last-id prev)
4702     (while (and id (setq prev (car (gnus-id-to-thread id))))
4703       (setq last-id id
4704             id (gnus-parent-id (mail-header-references prev))))
4705     last-id))
4706
4707 (defun gnus-articles-in-thread (thread)
4708   "Return the list of articles in THREAD."
4709   (cons (mail-header-number (car thread))
4710         (apply 'nconc (mapcar 'gnus-articles-in-thread (cdr thread)))))
4711
4712 (defun gnus-remove-thread (id &optional dont-remove)
4713   "Remove the thread that has ID in it."
4714   (let (headers thread last-id)
4715     ;; First go up in this thread until we find the root.
4716     (setq last-id (gnus-root-id id)
4717           headers (message-flatten-list (gnus-id-to-thread last-id)))
4718     ;; We have now found the real root of this thread.  It might have
4719     ;; been gathered into some loose thread, so we have to search
4720     ;; through the threads to find the thread we wanted.
4721     (let ((threads gnus-newsgroup-threads)
4722           sub)
4723       (while threads
4724         (setq sub (car threads))
4725         (if (stringp (car sub))
4726             ;; This is a gathered thread, so we look at the roots
4727             ;; below it to find whether this article is in this
4728             ;; gathered root.
4729             (progn
4730               (setq sub (cdr sub))
4731               (while sub
4732                 (when (member (caar sub) headers)
4733                   (setq thread (car threads)
4734                         threads nil
4735                         sub nil))
4736                 (setq sub (cdr sub))))
4737           ;; It's an ordinary thread, so we check it.
4738           (when (eq (car sub) (car headers))
4739             (setq thread sub
4740                   threads nil)))
4741         (setq threads (cdr threads)))
4742       ;; If this article is in no thread, then it's a root.
4743       (if thread
4744           (unless dont-remove
4745             (setq gnus-newsgroup-threads (delq thread gnus-newsgroup-threads)))
4746         (setq thread (gnus-id-to-thread last-id)))
4747       (when thread
4748         (prog1
4749             thread                      ; We return this thread.
4750           (unless dont-remove
4751             (if (stringp (car thread))
4752                 (progn
4753                   ;; If we use dummy roots, then we have to remove the
4754                   ;; dummy root as well.
4755                   (when (eq gnus-summary-make-false-root 'dummy)
4756                     ;; We go to the dummy root by going to
4757                     ;; the first sub-"thread", and then one line up.
4758                     (gnus-summary-goto-article
4759                      (mail-header-number (caadr thread)))
4760                     (forward-line -1)
4761                     (gnus-delete-line)
4762                     (gnus-data-compute-positions))
4763                   (setq thread (cdr thread))
4764                   (while thread
4765                     (gnus-remove-thread-1 (car thread))
4766                     (setq thread (cdr thread))))
4767               (gnus-remove-thread-1 thread))))))))
4768
4769 (defun gnus-remove-thread-1 (thread)
4770   "Remove the thread THREAD recursively."
4771   (let ((number (mail-header-number (pop thread)))
4772         d)
4773     (setq thread (reverse thread))
4774     (while thread
4775       (gnus-remove-thread-1 (pop thread)))
4776     (when (setq d (gnus-data-find number))
4777       (goto-char (gnus-data-pos d))
4778       (gnus-summary-show-thread)
4779       (gnus-data-remove
4780        number
4781        (- (point-at-bol)
4782           (prog1
4783               (1+ (point-at-eol))
4784             (gnus-delete-line)))))))
4785
4786 (defun gnus-sort-threads-recursive (threads func)
4787   (sort (mapcar (lambda (thread)
4788                   (cons (car thread)
4789                         (and (cdr thread)
4790                              (gnus-sort-threads-recursive (cdr thread) func))))
4791                 threads) func))
4792
4793 (defun gnus-sort-threads-loop (threads func)
4794   (let* ((superthread (cons nil threads))
4795          (stack (list (cons superthread threads)))
4796          remaining-threads thread)
4797     (while stack
4798       (setq remaining-threads (cdr (car stack)))
4799       (if remaining-threads
4800           (progn (setq thread (car remaining-threads))
4801                  (setcdr (car stack) (cdr remaining-threads))
4802                  (if (cdr thread)
4803                      (push (cons thread (cdr thread)) stack)))
4804         (setq thread (caar stack))
4805         (setcdr thread (sort (cdr thread) func))
4806         (pop stack)))
4807     (cdr superthread)))
4808
4809 (defun gnus-sort-threads (threads)
4810   "Sort THREADS."
4811   (if (not gnus-thread-sort-functions)
4812       threads
4813     (gnus-message 8 "Sorting threads...")
4814     (prog1
4815         (condition-case nil
4816             (let ((max-lisp-eval-depth (max max-lisp-eval-depth 5000)))
4817               (gnus-sort-threads-recursive
4818                threads (gnus-make-sort-function gnus-thread-sort-functions)))
4819           ;; Even after binding max-lisp-eval-depth, the recursive
4820           ;; sorter might fail for very long threads.  In that case,
4821           ;; try using a (less well-tested) non-recursive sorter.
4822           (error (gnus-message 9 "Sorting threads with loop...")
4823                  (gnus-sort-threads-loop
4824                   threads (gnus-make-sort-function
4825                            gnus-thread-sort-functions))))
4826       (gnus-message 8 "Sorting threads...done"))))
4827
4828 (defun gnus-sort-articles (articles)
4829   "Sort ARTICLES."
4830   (when gnus-article-sort-functions
4831     (gnus-message 7 "Sorting articles...")
4832     (prog1
4833         (setq gnus-newsgroup-headers
4834               (sort articles (gnus-make-sort-function
4835                               gnus-article-sort-functions)))
4836       (gnus-message 7 "Sorting articles...done"))))
4837
4838 ;; Written by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
4839 (defmacro gnus-thread-header (thread)
4840   "Return header of first article in THREAD.
4841 Note that THREAD must never, ever be anything else than a variable -
4842 using some other form will lead to serious barfage."
4843   (or (symbolp thread) (signal 'wrong-type-argument '(symbolp thread)))
4844   ;; (8% speedup to gnus-summary-prepare, just for fun :-)
4845   (list 'byte-code "\10\211:\203\17\0\211@;\203\16\0A@@\207"
4846         (vector thread) 2))
4847
4848 (defsubst gnus-article-sort-by-number (h1 h2)
4849   "Sort articles by article number."
4850   (< (mail-header-number h1)
4851      (mail-header-number h2)))
4852
4853 (defun gnus-thread-sort-by-number (h1 h2)
4854   "Sort threads by root article number."
4855   (gnus-article-sort-by-number
4856    (gnus-thread-header h1) (gnus-thread-header h2)))
4857
4858 (defsubst gnus-article-sort-by-random (h1 h2)
4859   "Sort articles randomly."
4860   (zerop (random 2)))
4861
4862 (defun gnus-thread-sort-by-random (h1 h2)
4863   "Sort threads randomly."
4864   (gnus-article-sort-by-random
4865    (gnus-thread-header h1) (gnus-thread-header h2)))
4866
4867 (defsubst gnus-article-sort-by-lines (h1 h2)
4868   "Sort articles by article Lines header."
4869   (< (mail-header-lines h1)
4870      (mail-header-lines h2)))
4871
4872 (defun gnus-thread-sort-by-lines (h1 h2)
4873   "Sort threads by root article Lines header."
4874   (gnus-article-sort-by-lines
4875    (gnus-thread-header h1) (gnus-thread-header h2)))
4876
4877 (defsubst gnus-article-sort-by-chars (h1 h2)
4878   "Sort articles by octet length."
4879   (< (mail-header-chars h1)
4880      (mail-header-chars h2)))
4881
4882 (defun gnus-thread-sort-by-chars (h1 h2)
4883   "Sort threads by root article octet length."
4884   (gnus-article-sort-by-chars
4885    (gnus-thread-header h1) (gnus-thread-header h2)))
4886
4887 (defsubst gnus-article-sort-by-author (h1 h2)
4888   "Sort articles by root author."
4889   (gnus-string<
4890    (let ((extract (funcall
4891                    gnus-extract-address-components
4892                    (mail-header-from h1))))
4893      (or (car extract) (cadr extract) ""))
4894    (let ((extract (funcall
4895                    gnus-extract-address-components
4896                    (mail-header-from h2))))
4897      (or (car extract) (cadr extract) ""))))
4898
4899 (defun gnus-thread-sort-by-author (h1 h2)
4900   "Sort threads by root author."
4901   (gnus-article-sort-by-author
4902    (gnus-thread-header h1)  (gnus-thread-header h2)))
4903
4904 (defsubst gnus-article-sort-by-recipient (h1 h2)
4905   "Sort articles by recipient."
4906   (gnus-string<
4907    (let ((extract (funcall
4908                    gnus-extract-address-components
4909                    (or (cdr (assq 'To (mail-header-extra h1))) ""))))
4910      (or (car extract) (cadr extract)))
4911    (let ((extract (funcall
4912                    gnus-extract-address-components
4913                    (or (cdr (assq 'To (mail-header-extra h2))) ""))))
4914      (or (car extract) (cadr extract)))))
4915
4916 (defun gnus-thread-sort-by-recipient (h1 h2)
4917   "Sort threads by root recipient."
4918   (gnus-article-sort-by-recipient
4919    (gnus-thread-header h1) (gnus-thread-header h2)))
4920
4921 (defsubst gnus-article-sort-by-subject (h1 h2)
4922   "Sort articles by root subject."
4923   (gnus-string<
4924    (downcase (gnus-simplify-subject-re (mail-header-subject h1)))
4925    (downcase (gnus-simplify-subject-re (mail-header-subject h2)))))
4926
4927 (defun gnus-thread-sort-by-subject (h1 h2)
4928   "Sort threads by root subject."
4929   (gnus-article-sort-by-subject
4930    (gnus-thread-header h1) (gnus-thread-header h2)))
4931
4932 (defsubst gnus-article-sort-by-date (h1 h2)
4933   "Sort articles by root article date."
4934   (time-less-p
4935    (gnus-date-get-time (mail-header-date h1))
4936    (gnus-date-get-time (mail-header-date h2))))
4937
4938 (defun gnus-thread-sort-by-date (h1 h2)
4939   "Sort threads by root article date."
4940   (gnus-article-sort-by-date
4941    (gnus-thread-header h1) (gnus-thread-header h2)))
4942
4943 (defsubst gnus-article-sort-by-score (h1 h2)
4944   "Sort articles by root article score.
4945 Unscored articles will be counted as having a score of zero."
4946   (> (or (cdr (assq (mail-header-number h1)
4947                     gnus-newsgroup-scored))
4948          gnus-summary-default-score 0)
4949      (or (cdr (assq (mail-header-number h2)
4950                     gnus-newsgroup-scored))
4951          gnus-summary-default-score 0)))
4952
4953 (defun gnus-thread-sort-by-score (h1 h2)
4954   "Sort threads by root article score."
4955   (gnus-article-sort-by-score
4956    (gnus-thread-header h1) (gnus-thread-header h2)))
4957
4958 (defun gnus-thread-sort-by-total-score (h1 h2)
4959   "Sort threads by the sum of all scores in the thread.
4960 Unscored articles will be counted as having a score of zero."
4961   (> (gnus-thread-total-score h1) (gnus-thread-total-score h2)))
4962
4963 (defun gnus-thread-total-score (thread)
4964   ;; This function find the total score of THREAD.
4965   (cond
4966    ((null thread)
4967     0)
4968    ((consp thread)
4969     (if (stringp (car thread))
4970         (apply gnus-thread-score-function 0
4971                (mapcar 'gnus-thread-total-score-1 (cdr thread)))
4972       (gnus-thread-total-score-1 thread)))
4973    (t
4974     (gnus-thread-total-score-1 (list thread)))))
4975
4976 (defun gnus-thread-sort-by-most-recent-number (h1 h2)
4977   "Sort threads such that the thread with the most recently arrived article comes first."
4978   (> (gnus-thread-highest-number h1) (gnus-thread-highest-number h2)))
4979
4980 (defun gnus-thread-highest-number (thread)
4981   "Return the highest article number in THREAD."
4982   (apply 'max (mapcar (lambda (header)
4983                         (mail-header-number header))
4984                       (message-flatten-list thread))))
4985
4986 (defun gnus-thread-sort-by-most-recent-date (h1 h2)
4987   "Sort threads such that the thread with the most recently dated article comes first."
4988   (> (gnus-thread-latest-date h1) (gnus-thread-latest-date h2)))
4989
4990 ; Since this is called not only to sort the top-level threads, but
4991 ; also in recursive sorts to order the articles within a thread, each
4992 ; article will be processed many times.  Thus it speeds things up
4993 ; quite a bit to use gnus-date-get-time, which caches the time value.
4994 (defun gnus-thread-latest-date (thread)
4995   "Return the highest article date in THREAD."
4996   (apply 'max
4997          (mapcar (lambda (header) (gnus-float-time
4998                                    (gnus-date-get-time
4999                                     (mail-header-date header))))
5000                  (message-flatten-list thread))))
5001
5002 (defun gnus-thread-total-score-1 (root)
5003   ;; This function find the total score of the thread below ROOT.
5004   (setq root (car root))
5005   (apply gnus-thread-score-function
5006          (or (append
5007               (mapcar 'gnus-thread-total-score
5008                       (cdr (gnus-id-to-thread (mail-header-id root))))
5009               (when (> (mail-header-number root) 0)
5010                 (list (or (cdr (assq (mail-header-number root)
5011                                      gnus-newsgroup-scored))
5012                           gnus-summary-default-score 0))))
5013              (list gnus-summary-default-score)
5014              '(0))))
5015
5016 ;; Added by Per Abrahamsen <amanda@iesd.auc.dk>.
5017 (defvar gnus-tmp-prev-subject nil)
5018 (defvar gnus-tmp-false-parent nil)
5019 (defvar gnus-tmp-root-expunged nil)
5020 (defvar gnus-tmp-dummy-line nil)
5021
5022 (defun gnus-extra-header (type &optional header)
5023   "Return the extra header of TYPE."
5024   (or (cdr (assq type (mail-header-extra (or header gnus-tmp-header))))
5025       ""))
5026
5027 (defvar gnus-tmp-thread-tree-header-string "")
5028
5029 (defcustom gnus-sum-thread-tree-root "> "
5030   "With %B spec, used for the root of a thread.
5031 If nil, use subject instead."
5032   :version "22.1"
5033   :type '(radio (const :format "%v  " nil) string)
5034   :group 'gnus-thread)
5035
5036 (defcustom gnus-sum-thread-tree-false-root "> "
5037   "With %B spec, used for a false root of a thread.
5038 If nil, use subject instead."
5039   :version "22.1"
5040   :type '(radio (const :format "%v  " nil) string)
5041   :group 'gnus-thread)
5042
5043 (defcustom gnus-sum-thread-tree-single-indent ""
5044   "With %B spec, used for a thread with just one message.
5045 If nil, use subject instead."
5046   :version "22.1"
5047   :type '(radio (const :format "%v  " nil) string)
5048   :group 'gnus-thread)
5049
5050 (defcustom gnus-sum-thread-tree-vertical "| "
5051   "With %B spec, used for drawing a vertical line."
5052   :version "22.1"
5053   :type 'string
5054   :group 'gnus-thread)
5055
5056 (defcustom gnus-sum-thread-tree-indent "  "
5057   "With %B spec, used for indenting."
5058   :version "22.1"
5059   :type 'string
5060   :group 'gnus-thread)
5061
5062 (defcustom gnus-sum-thread-tree-leaf-with-other "+-> "
5063   "With %B spec, used for a leaf with brothers."
5064   :version "22.1"
5065   :type 'string
5066   :group 'gnus-thread)
5067
5068 (defcustom gnus-sum-thread-tree-single-leaf "\\-> "
5069   "With %B spec, used for a leaf without brothers."
5070   :version "22.1"
5071   :type 'string
5072   :group 'gnus-thread)
5073
5074 (defcustom gnus-summary-display-while-building nil
5075   "If non-nil, show and update the summary buffer as it's being built.
5076 If the value is t, update the buffer after every line is inserted.  If
5077 the value is an integer (N), update the display every N lines."
5078   :version "22.1"
5079   :group 'gnus-thread
5080   :type '(choice (const :tag "off" nil)
5081                  number
5082                  (const :tag "frequently" t)))
5083
5084 (defun gnus-summary-prepare-threads (threads)
5085   "Prepare summary buffer from THREADS and indentation LEVEL.
5086 THREADS is either a list of `(PARENT [(CHILD1 [(GRANDCHILD ...]...) ...])'
5087 or a straight list of headers."
5088   (gnus-message 7 "Generating summary...")
5089
5090   (setq gnus-newsgroup-threads threads)
5091   (beginning-of-line)
5092
5093   (let ((gnus-tmp-level 0)
5094         (default-score (or gnus-summary-default-score 0))
5095         (gnus-visual-p (gnus-visual-p 'summary-highlight 'highlight))
5096         (building-line-count gnus-summary-display-while-building)
5097         (building-count (integerp gnus-summary-display-while-building))
5098         thread number subject stack state gnus-tmp-gathered beg-match
5099         new-roots gnus-tmp-new-adopts thread-end simp-subject
5100         gnus-tmp-header gnus-tmp-unread gnus-tmp-downloaded
5101         gnus-tmp-replied gnus-tmp-subject-or-nil
5102         gnus-tmp-dummy gnus-tmp-indentation gnus-tmp-lines gnus-tmp-score
5103         gnus-tmp-score-char gnus-tmp-from gnus-tmp-name
5104         gnus-tmp-number gnus-tmp-opening-bracket gnus-tmp-closing-bracket
5105         tree-stack)
5106
5107     (setq gnus-tmp-prev-subject nil
5108           gnus-tmp-thread-tree-header-string "")
5109
5110     (if (vectorp (car threads))
5111         ;; If this is a straight (sic) list of headers, then a
5112         ;; threaded summary display isn't required, so we just create
5113         ;; an unthreaded one.
5114         (gnus-summary-prepare-unthreaded threads)
5115
5116       ;; Do the threaded display.
5117
5118       (if gnus-summary-display-while-building
5119           (switch-to-buffer (buffer-name)))
5120       (while (or threads stack gnus-tmp-new-adopts new-roots)
5121
5122         (if (and (= gnus-tmp-level 0)
5123                  (or (not stack)
5124                      (= (caar stack) 0))
5125                  (not gnus-tmp-false-parent)
5126                  (or gnus-tmp-new-adopts new-roots))
5127             (if gnus-tmp-new-adopts
5128                 (setq gnus-tmp-level (if gnus-tmp-root-expunged 0 1)
5129                       thread (list (car gnus-tmp-new-adopts))
5130                       gnus-tmp-header (caar thread)
5131                       gnus-tmp-new-adopts (cdr gnus-tmp-new-adopts))
5132               (when new-roots
5133                 (setq thread (list (car new-roots))
5134                       gnus-tmp-header (caar thread)
5135                       new-roots (cdr new-roots))))
5136
5137           (if threads
5138               ;; If there are some threads, we do them before the
5139               ;; threads on the stack.
5140               (setq thread threads
5141                     gnus-tmp-header (caar thread))
5142             ;; There were no current threads, so we pop something off
5143             ;; the stack.
5144             (setq state (car stack)
5145                   gnus-tmp-level (car state)
5146                   tree-stack (cadr state)
5147                   thread (caddr state)
5148                   stack (cdr stack)
5149                   gnus-tmp-header (caar thread))))
5150
5151         (setq gnus-tmp-false-parent nil)
5152         (setq gnus-tmp-root-expunged nil)
5153         (setq thread-end nil)
5154
5155         (if (stringp gnus-tmp-header)
5156             ;; The header is a dummy root.
5157             (cond
5158              ((eq gnus-summary-make-false-root 'adopt)
5159               ;; We let the first article adopt the rest.
5160               (setq gnus-tmp-new-adopts (nconc gnus-tmp-new-adopts
5161                                                (cddar thread)))
5162               (setq gnus-tmp-gathered
5163                     (nconc (mapcar
5164                             (lambda (h) (mail-header-number (car h)))
5165                             (cddar thread))
5166                            gnus-tmp-gathered))
5167               (setq thread (cons (list (caar thread)
5168                                        (cadar thread))
5169                                  (cdr thread)))
5170               (setq gnus-tmp-level -1
5171                     gnus-tmp-false-parent t))
5172              ((eq gnus-summary-make-false-root 'empty)
5173               ;; We print adopted articles with empty subject fields.
5174               (setq gnus-tmp-gathered
5175                     (nconc (mapcar
5176                             (lambda (h) (mail-header-number (car h)))
5177                             (cddar thread))
5178                            gnus-tmp-gathered))
5179               (setq gnus-tmp-level -1))
5180              ((eq gnus-summary-make-false-root 'dummy)
5181               ;; We remember that we probably want to output a dummy
5182               ;; root.
5183               (setq gnus-tmp-dummy-line gnus-tmp-header)
5184               (setq gnus-tmp-prev-subject gnus-tmp-header))
5185              (t
5186               ;; We do not make a root for the gathered
5187               ;; sub-threads at all.
5188               (setq gnus-tmp-level -1)))
5189
5190           (setq number (mail-header-number gnus-tmp-header)
5191                 subject (mail-header-subject gnus-tmp-header)
5192                 simp-subject (gnus-simplify-subject-fully subject))
5193
5194           (cond
5195            ;; If the thread has changed subject, we might want to make
5196            ;; this subthread into a root.
5197            ((and (null gnus-thread-ignore-subject)
5198                  (not (zerop gnus-tmp-level))
5199                  gnus-tmp-prev-subject
5200                  (not (string= gnus-tmp-prev-subject simp-subject)))
5201             (setq new-roots (nconc new-roots (list (car thread)))
5202                   thread-end t
5203                   gnus-tmp-header nil))
5204            ;; If the article lies outside the current limit,
5205            ;; then we do not display it.
5206            ((not (memq number gnus-newsgroup-limit))
5207             (setq gnus-tmp-gathered
5208                   (nconc (mapcar
5209                           (lambda (h) (mail-header-number (car h)))
5210                           (cdar thread))
5211                          gnus-tmp-gathered))
5212             (setq gnus-tmp-new-adopts (if (cdar thread)
5213                                           (append gnus-tmp-new-adopts
5214                                                   (cdar thread))
5215                                         gnus-tmp-new-adopts)
5216                   thread-end t
5217                   gnus-tmp-header nil)
5218             (when (zerop gnus-tmp-level)
5219               (setq gnus-tmp-root-expunged t)))
5220            ;; Perhaps this article is to be marked as read?
5221            ((and gnus-summary-mark-below
5222                  (< (or (cdr (assq number gnus-newsgroup-scored))
5223                         default-score)
5224                     gnus-summary-mark-below)
5225                  ;; Don't touch sparse articles.
5226                  (not (gnus-summary-article-sparse-p number))
5227                  (not (gnus-summary-article-ancient-p number)))
5228             (setq gnus-newsgroup-unreads
5229                   (delq number gnus-newsgroup-unreads))
5230             (if gnus-newsgroup-auto-expire
5231                 (setq gnus-newsgroup-expirable
5232                       (gnus-add-to-sorted-list
5233                        gnus-newsgroup-expirable number))
5234               (push (cons number gnus-low-score-mark)
5235                     gnus-newsgroup-reads))))
5236
5237           (when gnus-tmp-header
5238             ;; We may have an old dummy line to output before this
5239             ;; article.
5240             (when (and gnus-tmp-dummy-line
5241                        (gnus-subject-equal
5242                         gnus-tmp-dummy-line
5243                         (mail-header-subject gnus-tmp-header)))
5244               (gnus-summary-insert-dummy-line
5245                gnus-tmp-dummy-line (mail-header-number gnus-tmp-header))
5246               (setq gnus-tmp-dummy-line nil))
5247
5248             ;; Compute the mark.
5249             (setq gnus-tmp-unread (gnus-article-mark number))
5250
5251             (push (gnus-data-make number gnus-tmp-unread (1+ (point))
5252                                   gnus-tmp-header gnus-tmp-level)
5253                   gnus-newsgroup-data)
5254
5255             ;; Actually insert the line.
5256             (setq
5257              gnus-tmp-subject-or-nil
5258              (cond
5259               ((and gnus-thread-ignore-subject
5260                     gnus-tmp-prev-subject
5261                     (not (string= gnus-tmp-prev-subject simp-subject)))
5262                subject)
5263               ((zerop gnus-tmp-level)
5264                (if (and (eq gnus-summary-make-false-root 'empty)
5265                         (memq number gnus-tmp-gathered)
5266                         gnus-tmp-prev-subject
5267                         (string= gnus-tmp-prev-subject simp-subject))
5268                    gnus-summary-same-subject
5269                  subject))
5270               (t gnus-summary-same-subject)))
5271             (if (and (eq gnus-summary-make-false-root 'adopt)
5272                      (= gnus-tmp-level 1)
5273                      (memq number gnus-tmp-gathered))
5274                 (setq gnus-tmp-opening-bracket ?\<
5275                       gnus-tmp-closing-bracket ?\>)
5276               (setq gnus-tmp-opening-bracket ?\[
5277                     gnus-tmp-closing-bracket ?\]))
5278             (if (>= gnus-tmp-level (length gnus-thread-indent-array))
5279                 (gnus-make-thread-indent-array
5280                  (max (* 2 (length gnus-thread-indent-array))
5281                       gnus-tmp-level)))
5282             (setq
5283              gnus-tmp-indentation
5284              (aref gnus-thread-indent-array gnus-tmp-level)
5285              gnus-tmp-lines (mail-header-lines gnus-tmp-header)
5286              gnus-tmp-score (or (cdr (assq number gnus-newsgroup-scored))
5287                                 gnus-summary-default-score 0)
5288              gnus-tmp-score-char
5289              (if (or (null gnus-summary-default-score)
5290                      (<= (abs (- gnus-tmp-score gnus-summary-default-score))
5291                          gnus-summary-zcore-fuzz))
5292                  ?                      ;Whitespace
5293                (if (< gnus-tmp-score gnus-summary-default-score)
5294                    gnus-score-below-mark gnus-score-over-mark))
5295              gnus-tmp-replied
5296              (cond ((memq number gnus-newsgroup-processable)
5297                     gnus-process-mark)
5298                    ((memq number gnus-newsgroup-cached)
5299                     gnus-cached-mark)
5300                    ((memq number gnus-newsgroup-replied)
5301                     gnus-replied-mark)
5302                    ((memq number gnus-newsgroup-forwarded)
5303                     gnus-forwarded-mark)
5304                    ((memq number gnus-newsgroup-saved)
5305                     gnus-saved-mark)
5306                    ((memq number gnus-newsgroup-recent)
5307                     gnus-recent-mark)
5308                    ((memq number gnus-newsgroup-unseen)
5309                     gnus-unseen-mark)
5310                    (t gnus-no-mark))
5311              gnus-tmp-downloaded
5312              (cond ((memq number gnus-newsgroup-undownloaded)
5313                     gnus-undownloaded-mark)
5314                    (gnus-newsgroup-agentized
5315                     gnus-downloaded-mark)
5316                    (t
5317                     gnus-no-mark))
5318              gnus-tmp-from (mail-header-from gnus-tmp-header)
5319              gnus-tmp-name
5320              (cond
5321               ((string-match "<[^>]+> *$" gnus-tmp-from)
5322                (setq beg-match (match-beginning 0))
5323                (or (and (string-match "^\".+\"" gnus-tmp-from)
5324                         (substring gnus-tmp-from 1 (1- (match-end 0))))
5325                    (substring gnus-tmp-from 0 beg-match)))
5326               ((string-match "(.+)" gnus-tmp-from)
5327                (substring gnus-tmp-from
5328                           (1+ (match-beginning 0)) (1- (match-end 0))))
5329               (t gnus-tmp-from))
5330
5331              ;; Do the %B string
5332              gnus-tmp-thread-tree-header-string
5333              (cond
5334               ((not gnus-show-threads) "")
5335               ((zerop gnus-tmp-level)
5336                (cond ((cdar thread)
5337                       (or gnus-sum-thread-tree-root subject))
5338                      (gnus-tmp-new-adopts
5339                       (or gnus-sum-thread-tree-false-root subject))
5340                      (t
5341                       (or gnus-sum-thread-tree-single-indent subject))))
5342               (t
5343                (concat (apply 'concat
5344                               (mapcar (lambda (item)
5345                                         (if (= item 1)
5346                                             gnus-sum-thread-tree-vertical
5347                                           gnus-sum-thread-tree-indent))
5348                                       (cdr (reverse tree-stack))))
5349                        (if (nth 1 thread)
5350                            gnus-sum-thread-tree-leaf-with-other
5351                          gnus-sum-thread-tree-single-leaf)))))
5352             (when (string= gnus-tmp-name "")
5353               (setq gnus-tmp-name gnus-tmp-from))
5354             (unless (numberp gnus-tmp-lines)
5355               (setq gnus-tmp-lines -1))
5356             (if (= gnus-tmp-lines -1)
5357                 (setq gnus-tmp-lines "?")
5358               (setq gnus-tmp-lines (number-to-string gnus-tmp-lines)))
5359               (gnus-put-text-property
5360                (point)
5361                (progn (eval gnus-summary-line-format-spec) (point))
5362                'gnus-number number)
5363               (when gnus-visual-p
5364                 (forward-line -1)
5365                 (gnus-run-hooks 'gnus-summary-update-hook)
5366                 (forward-line 1))
5367
5368               (setq gnus-tmp-prev-subject simp-subject)))
5369
5370         (when (nth 1 thread)
5371           (push (list (max 0 gnus-tmp-level)
5372                       (copy-sequence tree-stack)
5373                       (nthcdr 1 thread))
5374                 stack))
5375         (push (if (nth 1 thread) 1 0) tree-stack)
5376         (incf gnus-tmp-level)
5377         (setq threads (if thread-end nil (cdar thread)))
5378         (if gnus-summary-display-while-building
5379             (if building-count
5380                 (progn
5381                   ;; use a set frequency
5382                   (setq building-line-count (1- building-line-count))
5383                   (when (= building-line-count 0)
5384                     (sit-for 0)
5385                     (setq building-line-count
5386                           gnus-summary-display-while-building)))
5387               ;; always
5388               (sit-for 0)))
5389         (unless threads
5390           (setq gnus-tmp-level 0)))))
5391   (gnus-message 7 "Generating summary...done"))
5392
5393 (defun gnus-summary-prepare-unthreaded (headers)
5394   "Generate an unthreaded summary buffer based on HEADERS."
5395   (let (header number mark)
5396
5397     (beginning-of-line)
5398
5399     (while headers
5400       ;; We may have to root out some bad articles...
5401       (when (memq (setq number (mail-header-number
5402                                 (setq header (pop headers))))
5403                   gnus-newsgroup-limit)
5404         ;; Mark article as read when it has a low score.
5405         (when (and gnus-summary-mark-below
5406                    (< (or (cdr (assq number gnus-newsgroup-scored))
5407                           gnus-summary-default-score 0)
5408                       gnus-summary-mark-below)
5409                    (not (gnus-summary-article-ancient-p number)))
5410           (setq gnus-newsgroup-unreads
5411                 (delq number gnus-newsgroup-unreads))
5412           (if gnus-newsgroup-auto-expire
5413               (push number gnus-newsgroup-expirable)
5414             (push (cons number gnus-low-score-mark)
5415                   gnus-newsgroup-reads)))
5416
5417         (setq mark (gnus-article-mark number))
5418         (push (gnus-data-make number mark (1+ (point)) header 0)
5419               gnus-newsgroup-data)
5420         (gnus-summary-insert-line
5421          header 0 number
5422          (memq number gnus-newsgroup-undownloaded)
5423          mark (memq number gnus-newsgroup-replied)
5424          (memq number gnus-newsgroup-expirable)
5425          (mail-header-subject header) nil
5426          (cdr (assq number gnus-newsgroup-scored))
5427          (memq number gnus-newsgroup-processable))))))
5428
5429 (defun gnus-summary-remove-list-identifiers ()
5430   "Remove list identifiers in `gnus-list-identifiers' from articles in the current group."
5431   (let ((regexp (if (consp gnus-list-identifiers)
5432                     (mapconcat 'identity gnus-list-identifiers " *\\|")
5433                   gnus-list-identifiers))
5434         changed subject)
5435     (when regexp
5436       (setq regexp (concat "^\\(?:R[Ee]: +\\)*\\(" regexp " *\\)"))
5437       (dolist (header gnus-newsgroup-headers)
5438         (setq subject (mail-header-subject header)
5439               changed nil)
5440         (while (string-match regexp subject)
5441           (setq subject
5442                 (concat (substring subject 0 (match-beginning 1))
5443                         (substring subject (match-end 0)))
5444                 changed t))
5445         (when changed
5446           (when (string-match "^\\(\\(?:R[Ee]: +\\)+\\)R[Ee]: +" subject)
5447             (setq subject
5448                   (concat (substring subject 0 (match-beginning 1))
5449                           (substring subject (match-end 1)))))
5450           (mail-header-set-subject header subject))))))
5451
5452 (defun gnus-fetch-headers (articles)
5453   "Fetch headers of ARTICLES."
5454   (let ((name (gnus-group-decoded-name gnus-newsgroup-name)))
5455     (gnus-message 5 "Fetching headers for %s..." name)
5456     (prog1
5457         (if (eq 'nov
5458                 (setq gnus-headers-retrieved-by
5459                       (gnus-retrieve-headers
5460                        articles gnus-newsgroup-name
5461                        ;; We might want to fetch old headers, but
5462                        ;; not if there is only 1 article.
5463                        (and (or (and
5464                                  (not (eq gnus-fetch-old-headers 'some))
5465                                  (not (numberp gnus-fetch-old-headers)))
5466                                 (> (length articles) 1))
5467                             gnus-fetch-old-headers))))
5468             (gnus-get-newsgroup-headers-xover
5469              articles nil nil gnus-newsgroup-name t)
5470           (gnus-get-newsgroup-headers))
5471       (gnus-message 5 "Fetching headers for %s...done" name))))
5472
5473 (defun gnus-select-newsgroup (group &optional read-all select-articles)
5474   "Select newsgroup GROUP.
5475 If READ-ALL is non-nil, all articles in the group are selected.
5476 If SELECT-ARTICLES, only select those articles from GROUP."
5477   (let* ((entry (gnus-group-entry group))
5478          ;;!!! Dirty hack; should be removed.
5479          (gnus-summary-ignore-duplicates
5480           (if (eq (car (gnus-find-method-for-group group)) 'nnvirtual)
5481               t
5482             gnus-summary-ignore-duplicates))
5483          (info (nth 2 entry))
5484          charset articles fetched-articles cached)
5485
5486     (unless (gnus-check-server
5487              (set (make-local-variable 'gnus-current-select-method)
5488                   (gnus-find-method-for-group group)))
5489       (error "Couldn't open server"))
5490     (setq charset (gnus-group-name-charset gnus-current-select-method group))
5491
5492     (or (and entry (not (eq (car entry) t))) ; Either it's active...
5493         (gnus-activate-group group)     ; Or we can activate it...
5494         (progn                          ; Or we bug out.
5495           (when (equal major-mode 'gnus-summary-mode)
5496             (gnus-kill-buffer (current-buffer)))
5497           (error
5498            "Couldn't activate group %s: %s"
5499            (mm-decode-coding-string group charset)
5500            (mm-decode-coding-string (gnus-status-message group) charset))))
5501
5502     (unless (gnus-request-group group t)
5503         (when (equal major-mode 'gnus-summary-mode)
5504           (gnus-kill-buffer (current-buffer)))
5505         (error "Couldn't request group %s: %s"
5506                (mm-decode-coding-string group charset)
5507                (mm-decode-coding-string (gnus-status-message group) charset)))
5508
5509     (when gnus-agent
5510       (gnus-agent-possibly-alter-active group (gnus-active group) info)
5511
5512       (setq gnus-summary-use-undownloaded-faces
5513             (gnus-agent-find-parameter
5514              group
5515              'agent-enable-undownloaded-faces)))
5516
5517     (setq gnus-newsgroup-name group
5518           gnus-newsgroup-unselected nil
5519           gnus-newsgroup-unreads (gnus-list-of-unread-articles group))
5520
5521     (let ((display (gnus-group-find-parameter group 'display)))
5522       (setq gnus-newsgroup-display
5523             (cond
5524              ((not (zerop (or (car-safe read-all) 0)))
5525               ;; The user entered the group with C-u SPC/RET, let's show
5526               ;; all articles.
5527               'gnus-not-ignore)
5528              ((eq display 'all)
5529               'gnus-not-ignore)
5530              ((arrayp display)
5531               (gnus-summary-display-make-predicate (mapcar 'identity display)))
5532              ((numberp display)
5533               ;; The following is probably the "correct" solution, but
5534               ;; it makes Gnus fetch all headers and then limit the
5535               ;; articles (which is slow), so instead we hack the
5536               ;; select-articles parameter instead. -- Simon Josefsson
5537               ;; <jas@kth.se>
5538               ;;
5539               ;; (gnus-byte-compile
5540               ;;  `(lambda () (> number ,(- (cdr (gnus-active group))
5541               ;;                         display)))))
5542               (setq select-articles
5543                     (gnus-uncompress-range
5544                      (cons (let ((tmp (- (cdr (gnus-active group)) display)))
5545                              (if (> tmp 0)
5546                                  tmp
5547                                1))
5548                            (cdr (gnus-active group)))))
5549               nil)
5550              (t
5551               nil))))
5552
5553     (gnus-summary-setup-default-charset)
5554
5555     ;; Kludge to avoid having cached articles nixed out in virtual groups.
5556     (when (gnus-virtual-group-p group)
5557       (setq cached gnus-newsgroup-cached))
5558
5559     (setq gnus-newsgroup-unreads
5560           (gnus-sorted-ndifference
5561            (gnus-sorted-ndifference gnus-newsgroup-unreads
5562                                     gnus-newsgroup-marked)
5563            gnus-newsgroup-dormant))
5564
5565     (setq gnus-newsgroup-processable nil)
5566
5567     (gnus-update-read-articles group gnus-newsgroup-unreads)
5568
5569     ;; Adjust and set lists of article marks.
5570     (when info
5571       (gnus-adjust-marked-articles info))
5572     (if (setq articles select-articles)
5573         (setq gnus-newsgroup-unselected
5574               (gnus-sorted-difference gnus-newsgroup-unreads articles))
5575       (setq articles (gnus-articles-to-read group read-all)))
5576
5577     (cond
5578      ((null articles)
5579       ;;(gnus-message 3 "Couldn't select newsgroup -- no articles to display")
5580       'quit)
5581      ((eq articles 0) nil)
5582      (t
5583       ;; Init the dependencies hash table.
5584       (setq gnus-newsgroup-dependencies
5585             (gnus-make-hashtable (length articles)))
5586       (gnus-set-global-variables)
5587       ;; Retrieve the headers and read them in.
5588
5589       (setq gnus-newsgroup-headers (gnus-fetch-headers articles))
5590
5591       ;; Kludge to avoid having cached articles nixed out in virtual groups.
5592       (when cached
5593         (setq gnus-newsgroup-cached cached))
5594
5595       ;; Suppress duplicates?
5596       (when gnus-suppress-duplicates
5597         (gnus-dup-suppress-articles))
5598
5599       ;; Set the initial limit.
5600       (setq gnus-newsgroup-limit (copy-sequence articles))
5601       ;; Remove canceled articles from the list of unread articles.
5602       (setq fetched-articles
5603             (mapcar (lambda (headers) (mail-header-number headers))
5604                     gnus-newsgroup-headers))
5605       (setq gnus-newsgroup-articles fetched-articles)
5606       (setq gnus-newsgroup-unreads
5607             (gnus-sorted-nintersection
5608              gnus-newsgroup-unreads fetched-articles))
5609       (gnus-compute-unseen-list)
5610
5611       ;; Removed marked articles that do not exist.
5612       (gnus-update-missing-marks
5613        (gnus-sorted-difference articles fetched-articles))
5614       ;; We might want to build some more threads first.
5615       (when (and gnus-fetch-old-headers
5616                  (eq gnus-headers-retrieved-by 'nov))
5617         (if (eq gnus-fetch-old-headers 'invisible)
5618             (gnus-build-all-threads)
5619           (gnus-build-old-threads)))
5620       ;; Let the Gnus agent mark articles as read.
5621       (when gnus-agent
5622         (gnus-agent-get-undownloaded-list))
5623       ;; Remove list identifiers from subject
5624       (when gnus-list-identifiers
5625         (gnus-summary-remove-list-identifiers))
5626       ;; Check whether auto-expire is to be done in this group.
5627       (setq gnus-newsgroup-auto-expire
5628             (gnus-group-auto-expirable-p group))
5629       ;; Set up the article buffer now, if necessary.
5630       (unless (and gnus-single-article-buffer
5631                    (equal gnus-article-buffer "*Article*"))
5632         (gnus-article-setup-buffer))
5633       ;; First and last article in this newsgroup.
5634       (when gnus-newsgroup-headers
5635         (setq gnus-newsgroup-begin
5636               (mail-header-number (car gnus-newsgroup-headers))
5637               gnus-newsgroup-end
5638               (mail-header-number
5639                (gnus-last-element gnus-newsgroup-headers))))
5640       ;; GROUP is successfully selected.
5641       (or gnus-newsgroup-headers t)))))
5642
5643 (defun gnus-compute-unseen-list ()
5644   ;; The `seen' marks are treated specially.
5645   (if (not gnus-newsgroup-seen)
5646       (setq gnus-newsgroup-unseen gnus-newsgroup-articles)
5647     (setq gnus-newsgroup-unseen
5648           (gnus-inverse-list-range-intersection
5649            gnus-newsgroup-articles gnus-newsgroup-seen))))
5650
5651 (declare-function gnus-get-predicate "gnus-agent" (predicate))
5652
5653 (defun gnus-summary-display-make-predicate (display)
5654   (require 'gnus-agent)
5655   (when (= (length display) 1)
5656     (setq display (car display)))
5657   (unless gnus-summary-display-cache
5658     (dolist (elem (append '((unread . unread)
5659                             (read . read)
5660                             (unseen . unseen))
5661                           gnus-article-mark-lists))
5662       (push (cons (cdr elem)
5663                   (gnus-byte-compile
5664                    `(lambda () (gnus-article-marked-p ',(cdr elem)))))
5665             gnus-summary-display-cache)))
5666   (let ((gnus-category-predicate-alist gnus-summary-display-cache)
5667         (gnus-category-predicate-cache gnus-summary-display-cache))
5668     (gnus-get-predicate display)))
5669
5670 ;; Uses the dynamically bound `number' variable.
5671 (defvar number)
5672 (defun gnus-article-marked-p (type &optional article)
5673   (let ((article (or article number)))
5674     (cond
5675      ((eq type 'tick)
5676       (memq article gnus-newsgroup-marked))
5677      ((eq type 'spam)
5678       (memq article gnus-newsgroup-spam-marked))
5679      ((eq type 'unsend)
5680       (memq article gnus-newsgroup-unsendable))
5681      ((eq type 'undownload)
5682       (memq article gnus-newsgroup-undownloaded))
5683      ((eq type 'download)
5684       (memq article gnus-newsgroup-downloadable))
5685      ((eq type 'unread)
5686       (memq article gnus-newsgroup-unreads))
5687      ((eq type 'read)
5688       (memq article gnus-newsgroup-reads))
5689      ((eq type 'dormant)
5690       (memq article gnus-newsgroup-dormant) )
5691      ((eq type 'expire)
5692       (memq article gnus-newsgroup-expirable))
5693      ((eq type 'reply)
5694       (memq article gnus-newsgroup-replied))
5695      ((eq type 'killed)
5696       (memq article gnus-newsgroup-killed))
5697      ((eq type 'bookmark)
5698       (assq article gnus-newsgroup-bookmarks))
5699      ((eq type 'score)
5700       (assq article gnus-newsgroup-scored))
5701      ((eq type 'save)
5702       (memq article gnus-newsgroup-saved))
5703      ((eq type 'cache)
5704       (memq article gnus-newsgroup-cached))
5705      ((eq type 'forward)
5706       (memq article gnus-newsgroup-forwarded))
5707      ((eq type 'seen)
5708       (not (memq article gnus-newsgroup-unseen)))
5709      ((eq type 'recent)
5710       (memq article gnus-newsgroup-recent))
5711      (t t))))
5712
5713 (defun gnus-articles-to-read (group &optional read-all)
5714   "Find out what articles the user wants to read."
5715   (let* ((articles
5716           ;; Select all articles if `read-all' is non-nil, or if there
5717           ;; are no unread articles.
5718           (if (or read-all
5719                   (and (zerop (length gnus-newsgroup-marked))
5720                        (zerop (length gnus-newsgroup-unreads)))
5721                   ;; Fetch all if the predicate is non-nil.
5722                   gnus-newsgroup-display)
5723               ;; We want to select the headers for all the articles in
5724               ;; the group, so we select either all the active
5725               ;; articles in the group, or (if that's nil), the
5726               ;; articles in the cache.
5727               (or
5728                (if gnus-newsgroup-maximum-articles
5729                    (let ((active (gnus-active group)))
5730                      (gnus-uncompress-range
5731                       (cons (max (car active)
5732                                  (- (cdr active)
5733                                     gnus-newsgroup-maximum-articles
5734                                     -1))
5735                             (cdr active))))
5736                  (gnus-uncompress-range (gnus-active group)))
5737                (gnus-cache-articles-in-group group))
5738             ;; Select only the "normal" subset of articles.
5739             (gnus-sorted-nunion
5740              (gnus-sorted-union gnus-newsgroup-dormant gnus-newsgroup-marked)
5741              gnus-newsgroup-unreads)))
5742          (scored-list (gnus-killed-articles gnus-newsgroup-killed articles))
5743          (scored (length scored-list))
5744          (number (length articles))
5745          (marked (+ (length gnus-newsgroup-marked)
5746                     (length gnus-newsgroup-dormant)))
5747          (select
5748           (cond
5749            ((numberp read-all)
5750             read-all)
5751            ((numberp gnus-newsgroup-display)
5752             gnus-newsgroup-display)
5753            (t
5754             (condition-case ()
5755                 (cond
5756                  ((and (or (<= scored marked) (= scored number))
5757                        (numberp gnus-large-newsgroup)
5758                        (> number gnus-large-newsgroup))
5759                   (let* ((cursor-in-echo-area nil)
5760                          (initial (gnus-parameter-large-newsgroup-initial
5761                                    gnus-newsgroup-name))
5762                          (input
5763                           (read-string
5764                            (format
5765                             "How many articles from %s (%s %d): "
5766                             (gnus-group-decoded-name gnus-newsgroup-name)
5767                             (if initial "max" "default")
5768                             number)
5769                            (if initial
5770                                (cons (number-to-string initial)
5771                                      0)))))
5772                     (if (string-match "^[ \t]*$" input) number input)))
5773                  ((and (> scored marked) (< scored number)
5774                        (> (- scored number) 20))
5775                   (let ((input
5776                          (read-string
5777                           (format "%s %s (%d scored, %d total): "
5778                                   "How many articles from"
5779                                   (gnus-group-decoded-name group)
5780                                   scored number))))
5781                     (if (string-match "^[ \t]*$" input)
5782                         number input)))
5783                  (t number))
5784               (quit
5785                (message "Quit getting the articles to read")
5786                nil))))))
5787     (setq select (if (stringp select) (string-to-number select) select))
5788     (if (or (null select) (zerop select))
5789         select
5790       (if (and (not (zerop scored)) (<= (abs select) scored))
5791           (progn
5792             (setq articles (sort scored-list '<))
5793             (setq number (length articles)))
5794         (setq articles (copy-sequence articles)))
5795
5796       (when (< (abs select) number)
5797         (if (< select 0)
5798             ;; Select the N oldest articles.
5799             (setcdr (nthcdr (1- (abs select)) articles) nil)
5800           ;; Select the N most recent articles.
5801           (setq articles (nthcdr (- number select) articles))))
5802       (setq gnus-newsgroup-unselected
5803             (gnus-sorted-difference gnus-newsgroup-unreads articles))
5804       (when gnus-alter-articles-to-read-function
5805         (setq articles
5806               (sort
5807                (funcall gnus-alter-articles-to-read-function
5808                         gnus-newsgroup-name articles)
5809                '<)))
5810       articles)))
5811
5812 (defun gnus-killed-articles (killed articles)
5813   (let (out)
5814     (while articles
5815       (when (inline (gnus-member-of-range (car articles) killed))
5816         (push (car articles) out))
5817       (setq articles (cdr articles)))
5818     out))
5819
5820 (defun gnus-uncompress-marks (marks)
5821   "Uncompress the mark ranges in MARKS."
5822   (let ((uncompressed '(score bookmark))
5823         out)
5824     (while marks
5825       (if (memq (caar marks) uncompressed)
5826           (push (car marks) out)
5827         (push (cons (caar marks) (gnus-uncompress-range (cdar marks))) out))
5828       (setq marks (cdr marks)))
5829     out))
5830
5831 (defun gnus-article-mark-to-type (mark)
5832   "Return the type of MARK."
5833   (or (cadr (assq mark gnus-article-special-mark-lists))
5834       'list))
5835
5836 (defun gnus-article-unpropagatable-p (mark)
5837   "Return whether MARK should be propagated to back end."
5838   (memq mark gnus-article-unpropagated-mark-lists))
5839
5840 (defun gnus-adjust-marked-articles (info)
5841   "Set all article lists and remove all marks that are no longer valid."
5842   (let* ((marked-lists (gnus-info-marks info))
5843          (active (gnus-active (gnus-info-group info)))
5844          (min (car active))
5845          (max (cdr active))
5846          (types gnus-article-mark-lists)
5847          marks var articles article mark mark-type
5848          bgn end)
5849
5850     (dolist (marks marked-lists)
5851       (setq mark (car marks)
5852             mark-type (gnus-article-mark-to-type mark)
5853             var (intern (format "gnus-newsgroup-%s" (car (rassq mark types)))))
5854
5855       ;; We set the variable according to the type of the marks list,
5856       ;; and then adjust the marks to a subset of the active articles.
5857       (cond
5858        ;; Adjust "simple" lists - compressed yet unsorted
5859        ((eq mark-type 'list)
5860         ;; Simultaneously uncompress and clip to active range
5861         ;; See gnus-uncompress-range for a description of possible marks
5862         (let (l lh)
5863           (if (not (cadr marks))
5864               (set var nil)
5865             (setq articles (if (numberp (cddr marks))
5866                                (list (cdr marks))
5867                              (cdr marks))
5868                   lh (cons nil nil)
5869                   l lh)
5870
5871             (while (setq article (pop articles))
5872               (cond ((consp article)
5873                      (setq bgn (max (car article) min)
5874                            end (min (cdr article) max))
5875                      (while (<= bgn end)
5876                        (setq l (setcdr l (cons bgn nil))
5877                              bgn (1+ bgn))))
5878                     ((and (<= min article)
5879                           (>= max article))
5880                      (setq l (setcdr l (cons article nil))))))
5881             (set var (cdr lh)))))
5882        ;; Adjust assocs.
5883        ((eq mark-type 'tuple)
5884         (set var (setq articles (cdr marks)))
5885         (when (not (listp (cdr (symbol-value var))))
5886           (set var (list (symbol-value var))))
5887         (when (not (listp (cdr articles)))
5888           (setq articles (list articles)))
5889         (while articles
5890           (when (or (not (consp (setq article (pop articles))))
5891                     (< (car article) min)
5892                     (> (car article) max))
5893             (set var (delq article (symbol-value var))))))
5894        ;; Adjust ranges (sloppily).
5895        ((eq mark-type 'range)
5896         (cond
5897          ((eq mark 'seen)
5898           ;; Fix the record for `seen' if it looks like (seen NUM1 . NUM2).
5899           ;; It should be (seen (NUM1 . NUM2)).
5900           (when (numberp (cddr marks))
5901             (setcdr marks (list (cdr marks))))
5902           (setq articles (cdr marks))
5903           (while (and articles
5904                       (or (and (consp (car articles))
5905                                (> min (cdar articles)))
5906                           (and (numberp (car articles))
5907                                (> min (car articles)))))
5908             (pop articles))
5909           (set var articles))))))))
5910
5911 (defun gnus-update-missing-marks (missing)
5912   "Go through the list of MISSING articles and remove them from the mark lists."
5913   (when missing
5914     (let (var m)
5915       ;; Go through all types.
5916       (dolist (elem gnus-article-mark-lists)
5917         (when (eq (gnus-article-mark-to-type (cdr elem)) 'list)
5918           (setq var (intern (format "gnus-newsgroup-%s" (car elem))))
5919           (when (symbol-value var)
5920             ;; This list has articles.  So we delete all missing
5921             ;; articles from it.
5922             (setq m missing)
5923             (while m
5924               (set var (delq (pop m) (symbol-value var))))))))))
5925
5926 (defun gnus-update-marks ()
5927   "Enter the various lists of marked articles into the newsgroup info list."
5928   (let ((types gnus-article-mark-lists)
5929         (info (gnus-get-info gnus-newsgroup-name))
5930         type list newmarked symbol delta-marks)
5931     (when info
5932       ;; Add all marks lists to the list of marks lists.
5933       (while (setq type (pop types))
5934         (setq list (symbol-value
5935                     (setq symbol
5936                           (intern (format "gnus-newsgroup-%s" (car type))))))
5937
5938         (when list
5939           ;; Get rid of the entries of the articles that have the
5940           ;; default score.
5941           (when (and (eq (cdr type) 'score)
5942                      gnus-save-score
5943                      list)
5944             (let* ((arts list)
5945                    (prev (cons nil list))
5946                    (all prev))
5947               (while arts
5948                 (if (or (not (consp (car arts)))
5949                         (= (cdar arts) gnus-summary-default-score))
5950                     (setcdr prev (cdr arts))
5951                   (setq prev arts))
5952                 (setq arts (cdr arts)))
5953               (setq list (cdr all)))))
5954
5955         (when (eq (cdr type) 'seen)
5956           (setq list (gnus-range-add list gnus-newsgroup-unseen)))
5957
5958         (when (eq (gnus-article-mark-to-type (cdr type)) 'list)
5959           (setq list (gnus-compress-sequence (set symbol (sort list '<)) t)))
5960
5961         (when (and (gnus-check-backend-function
5962                     'request-set-mark gnus-newsgroup-name)
5963                    (not (gnus-article-unpropagatable-p (cdr type))))
5964           (let* ((old (cdr (assq (cdr type) (gnus-info-marks info))))
5965                  (del (gnus-remove-from-range (gnus-copy-sequence old) list))
5966                  (add (gnus-remove-from-range
5967                        (gnus-copy-sequence list) old)))
5968             (when add
5969               (push (list add 'add (list (cdr type))) delta-marks))
5970             (when del
5971               (push (list del 'del (list (cdr type))) delta-marks))))
5972
5973         (when list
5974           (push (cons (cdr type) list) newmarked)))
5975
5976       (when delta-marks
5977         (unless (gnus-check-group gnus-newsgroup-name)
5978           (error "Can't open server for %s" gnus-newsgroup-name))
5979         (gnus-request-set-mark gnus-newsgroup-name delta-marks))
5980
5981       ;; Enter these new marks into the info of the group.
5982       (if (nthcdr 3 info)
5983           (setcar (nthcdr 3 info) newmarked)
5984         ;; Add the marks lists to the end of the info.
5985         (when newmarked
5986           (setcdr (nthcdr 2 info) (list newmarked))))
5987
5988       ;; Cut off the end of the info if there's nothing else there.
5989       (let ((i 5))
5990         (while (and (> i 2)
5991                     (not (nth i info)))
5992           (when (nthcdr (decf i) info)
5993             (setcdr (nthcdr i info) nil)))))))
5994
5995 (defun gnus-set-mode-line (where)
5996   "Set the mode line of the article or summary buffers.
5997 If WHERE is `summary', the summary mode line format will be used."
5998   ;; Is this mode line one we keep updated?
5999   (when (and (memq where gnus-updated-mode-lines)
6000              (symbol-value
6001               (intern (format "gnus-%s-mode-line-format-spec" where))))
6002     (let (mode-string)
6003       ;; We evaluate this in the summary buffer since these
6004       ;; variables are buffer-local to that buffer.
6005       (with-current-buffer gnus-summary-buffer
6006         ;; We bind all these variables that are used in the `eval' form
6007         ;; below.
6008         (let* ((mformat (symbol-value
6009                          (intern
6010                           (format "gnus-%s-mode-line-format-spec" where))))
6011                (gnus-tmp-group-name (gnus-mode-string-quote
6012                                      (gnus-group-decoded-name
6013                                       gnus-newsgroup-name)))
6014                (gnus-tmp-article-number (or gnus-current-article 0))
6015                (gnus-tmp-unread gnus-newsgroup-unreads)
6016                (gnus-tmp-unread-and-unticked (length gnus-newsgroup-unreads))
6017                (gnus-tmp-unselected (length gnus-newsgroup-unselected))
6018                (gnus-tmp-unread-and-unselected
6019                 (cond ((and (zerop gnus-tmp-unread-and-unticked)
6020                             (zerop gnus-tmp-unselected))
6021                        "")
6022                       ((zerop gnus-tmp-unselected)
6023                        (format "{%d more}" gnus-tmp-unread-and-unticked))
6024                       (t (format "{%d(+%d) more}"
6025                                  gnus-tmp-unread-and-unticked
6026                                  gnus-tmp-unselected))))
6027                (gnus-tmp-subject
6028                 (if (and gnus-current-headers
6029                          (vectorp gnus-current-headers))
6030                     (gnus-mode-string-quote
6031                      (mail-header-subject gnus-current-headers))
6032                   ""))
6033                bufname-length max-len
6034                gnus-tmp-header) ;; passed as argument to any user-format-funcs
6035           (setq mode-string (eval mformat))
6036           (setq bufname-length (if (string-match "%b" mode-string)
6037                                    (- (length
6038                                        (buffer-name
6039                                         (if (eq where 'summary)
6040                                             nil
6041                                           (get-buffer gnus-article-buffer))))
6042                                       2)
6043                                  0))
6044           (setq max-len (max 4 (if gnus-mode-non-string-length
6045                                    (- (window-width)
6046                                       gnus-mode-non-string-length
6047                                       bufname-length)
6048                                  (length mode-string))))
6049           ;; We might have to chop a bit of the string off...
6050           (when (> (length mode-string) max-len)
6051             (setq mode-string
6052                   (concat (truncate-string-to-width mode-string (- max-len 3))
6053                           "...")))
6054           ;; Pad the mode string a bit.
6055           (setq mode-string (format (format "%%-%ds" max-len) mode-string))))
6056       ;; Update the mode line.
6057       (setq mode-line-buffer-identification
6058             (gnus-mode-line-buffer-identification (list mode-string)))
6059       (set-buffer-modified-p t))))
6060
6061 (defun gnus-create-xref-hashtb (from-newsgroup headers unreads)
6062   "Go through the HEADERS list and add all Xrefs to a hash table.
6063 The resulting hash table is returned, or nil if no Xrefs were found."
6064   (let* ((virtual (gnus-virtual-group-p from-newsgroup))
6065          (prefix (if virtual "" (gnus-group-real-prefix from-newsgroup)))
6066          (xref-hashtb (gnus-make-hashtable))
6067          start group entry number xrefs header)
6068     (while headers
6069       (setq header (pop headers))
6070       (when (and (setq xrefs (mail-header-xref header))
6071                  (not (memq (setq number (mail-header-number header))
6072                             unreads)))
6073         (setq start 0)
6074         (while (string-match "\\([^ ]+\\)[:/]\\([0-9]+\\)" xrefs start)
6075           (setq start (match-end 0))
6076           (setq group (if prefix
6077                           (concat prefix (substring xrefs (match-beginning 1)
6078                                                     (match-end 1)))
6079                         (substring xrefs (match-beginning 1) (match-end 1))))
6080           (setq number
6081                 (string-to-number (substring xrefs (match-beginning 2)
6082                                           (match-end 2))))
6083           (if (setq entry (gnus-gethash group xref-hashtb))
6084               (setcdr entry (cons number (cdr entry)))
6085             (gnus-sethash group (cons number nil) xref-hashtb)))))
6086     (and start xref-hashtb)))
6087
6088 (defun gnus-mark-xrefs-as-read (from-newsgroup headers unreads)
6089   "Look through all the headers and mark the Xrefs as read."
6090   (let ((virtual (gnus-virtual-group-p from-newsgroup))
6091         name info xref-hashtb idlist method nth4)
6092     (with-current-buffer gnus-group-buffer
6093       (when (setq xref-hashtb
6094                   (gnus-create-xref-hashtb from-newsgroup headers unreads))
6095         (mapatoms
6096          (lambda (group)
6097            (unless (string= from-newsgroup (setq name (symbol-name group)))
6098              (setq idlist (symbol-value group))
6099              ;; Dead groups are not updated.
6100              (and (prog1
6101                       (setq info (gnus-get-info name))
6102                     (when (stringp (setq nth4 (gnus-info-method info)))
6103                       (setq nth4 (gnus-server-to-method nth4))))
6104                   ;; Only do the xrefs if the group has the same
6105                   ;; select method as the group we have just read.
6106                   (or (gnus-methods-equal-p
6107                        nth4 (gnus-find-method-for-group from-newsgroup))
6108                       virtual
6109                       (equal nth4 (setq method (gnus-find-method-for-group
6110                                                 from-newsgroup)))
6111                       (and (equal (car nth4) (car method))
6112                            (equal (nth 1 nth4) (nth 1 method))))
6113                   gnus-use-cross-reference
6114                   (or (not (eq gnus-use-cross-reference t))
6115                       virtual
6116                       ;; Only do cross-references on subscribed
6117                       ;; groups, if that is what is wanted.
6118                       (<= (gnus-info-level info) gnus-level-subscribed))
6119                   (gnus-group-make-articles-read name idlist))))
6120          xref-hashtb)))))
6121
6122 (defun gnus-compute-read-articles (group articles)
6123   (let* ((entry (gnus-group-entry group))
6124          (info (nth 2 entry))
6125          (active (gnus-active group))
6126          ninfo)
6127     (when entry
6128       ;; First peel off all invalid article numbers.
6129       (when active
6130         (let ((ids articles)
6131               id first)
6132           (while (setq id (pop ids))
6133             (when (and first (> id (cdr active)))
6134               ;; We'll end up in this situation in one particular
6135               ;; obscure situation.  If you re-scan a group and get
6136               ;; a new article that is cross-posted to a different
6137               ;; group that has not been re-scanned, you might get
6138               ;; crossposted article that has a higher number than
6139               ;; Gnus believes possible.  So we re-activate this
6140               ;; group as well.  This might mean doing the
6141               ;; crossposting thingy will *increase* the number
6142               ;; of articles in some groups.  Tsk, tsk.
6143               (setq active (or (gnus-activate-group group) active)))
6144             (when (or (> id (cdr active))
6145                       (< id (car active)))
6146               (setq articles (delq id articles))))))
6147       ;; If the read list is nil, we init it.
6148       (if (and active
6149                (null (gnus-info-read info))
6150                (> (car active) 1))
6151           (setq ninfo (cons 1 (1- (car active))))
6152         (setq ninfo (gnus-info-read info)))
6153       ;; Then we add the read articles to the range.
6154       (gnus-add-to-range
6155        ninfo (setq articles (sort articles '<))))))
6156
6157 (defun gnus-group-make-articles-read (group articles)
6158   "Update the info of GROUP to say that ARTICLES are read."
6159   (let* ((num 0)
6160          (entry (gnus-group-entry group))
6161          (info (nth 2 entry))
6162          (active (gnus-active group))
6163          range)
6164     (when entry
6165       (setq range (gnus-compute-read-articles group articles))
6166       (with-current-buffer gnus-group-buffer
6167         (gnus-undo-register
6168           `(progn
6169              (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
6170              (gnus-info-set-read ',info ',(gnus-info-read info))
6171              (gnus-get-unread-articles-in-group ',info (gnus-active ,group))
6172              (gnus-request-set-mark ,group (list (list ',range 'del '(read))))
6173              (gnus-group-update-group ,group t))))
6174       ;; Add the read articles to the range.
6175       (gnus-info-set-read info range)
6176       (gnus-request-set-mark group (list (list range 'add '(read))))
6177       ;; Then we have to re-compute how many unread
6178       ;; articles there are in this group.
6179       (when active
6180         (cond
6181          ((not range)
6182           (setq num (- (1+ (cdr active)) (car active))))
6183          ((not (listp (cdr range)))
6184           (setq num (- (cdr active) (- (1+ (cdr range))
6185                                        (car range)))))
6186          (t
6187           (while range
6188             (if (numberp (car range))
6189                 (setq num (1+ num))
6190               (setq num (+ num (- (1+ (cdar range)) (caar range)))))
6191             (setq range (cdr range)))
6192           (setq num (- (cdr active) num))))
6193         ;; Update the number of unread articles.
6194         (setcar entry num)
6195         ;; Update the group buffer.
6196         (unless (gnus-ephemeral-group-p group)
6197           (gnus-group-update-group group t))))))
6198
6199 (defvar gnus-newsgroup-none-id 0)
6200
6201 (defun gnus-get-newsgroup-headers (&optional dependencies force-new)
6202   (let ((cur nntp-server-buffer)
6203         (dependencies
6204          (or dependencies
6205              (with-current-buffer gnus-summary-buffer
6206                gnus-newsgroup-dependencies)))
6207         headers id end ref number
6208         (mail-parse-charset gnus-newsgroup-charset)
6209         (mail-parse-ignored-charsets
6210          (save-current-buffer (condition-case nil
6211                                   (set-buffer gnus-summary-buffer)
6212                                 (error))
6213                               gnus-newsgroup-ignored-charsets)))
6214     (with-current-buffer nntp-server-buffer
6215       ;; Translate all TAB characters into SPACE characters.
6216       (subst-char-in-region (point-min) (point-max) ?\t ?  t)
6217       (subst-char-in-region (point-min) (point-max) ?\r ?  t)
6218       (ietf-drums-unfold-fws)
6219       (gnus-run-hooks 'gnus-parse-headers-hook)
6220       (let ((case-fold-search t)
6221             in-reply-to header p lines chars)
6222         (goto-char (point-min))
6223         ;; Search to the beginning of the next header.  Error messages
6224         ;; do not begin with 2 or 3.
6225         (while (re-search-forward "^[23][0-9]+ " nil t)
6226           (setq id nil
6227                 ref nil)
6228           ;; This implementation of this function, with nine
6229           ;; search-forwards instead of the one re-search-forward and
6230           ;; a case (which basically was the old function) is actually
6231           ;; about twice as fast, even though it looks messier.  You
6232           ;; can't have everything, I guess.  Speed and elegance
6233           ;; doesn't always go hand in hand.
6234           (setq
6235            header
6236            (vector
6237             ;; Number.
6238             (prog1
6239                 (setq number (read cur))
6240               (end-of-line)
6241               (setq p (point))
6242               (narrow-to-region (point)
6243                                 (or (and (search-forward "\n.\n" nil t)
6244                                          (- (point) 2))
6245                                     (point))))
6246             ;; Subject.
6247             (progn
6248               (goto-char p)
6249               (if (search-forward "\nsubject:" nil t)
6250                   (funcall gnus-decode-encoded-word-function
6251                            (nnheader-header-value))
6252                 "(none)"))
6253             ;; From.
6254             (progn
6255               (goto-char p)
6256               (if (search-forward "\nfrom:" nil t)
6257                   (funcall gnus-decode-encoded-address-function
6258                            (nnheader-header-value))
6259                 "(nobody)"))
6260             ;; Date.
6261             (progn
6262               (goto-char p)
6263               (if (search-forward "\ndate:" nil t)
6264                   (nnheader-header-value) ""))
6265             ;; Message-ID.
6266             (progn
6267               (goto-char p)
6268               (setq id (if (re-search-forward
6269                             "^message-id: *\\(<[^\n\t> ]+>\\)" nil t)
6270                            ;; We do it this way to make sure the Message-ID
6271                            ;; is (somewhat) syntactically valid.
6272                            (buffer-substring (match-beginning 1)
6273                                              (match-end 1))
6274                          ;; If there was no message-id, we just fake one
6275                          ;; to make subsequent routines simpler.
6276                          (nnheader-generate-fake-message-id number))))
6277             ;; References.
6278             (progn
6279               (goto-char p)
6280               (if (search-forward "\nreferences:" nil t)
6281                   (progn
6282                     (setq end (point))
6283                     (prog1
6284                         (nnheader-header-value)
6285                       (setq ref
6286                             (buffer-substring
6287                              (progn
6288                                (end-of-line)
6289                                (search-backward ">" end t)
6290                                (1+ (point)))
6291                              (progn
6292                                (search-backward "<" end t)
6293                                (point))))))
6294                 ;; Get the references from the in-reply-to header if there
6295                 ;; were no references and the in-reply-to header looks
6296                 ;; promising.
6297                 (if (and (search-forward "\nin-reply-to:" nil t)
6298                          (setq in-reply-to (nnheader-header-value))
6299                          (string-match "<[^>]+>" in-reply-to))
6300                     (let (ref2)
6301                       (setq ref (substring in-reply-to (match-beginning 0)
6302                                            (match-end 0)))
6303                       (while (string-match "<[^>]+>" in-reply-to (match-end 0))
6304                         (setq ref2 (substring in-reply-to (match-beginning 0)
6305                                               (match-end 0)))
6306                         (when (> (length ref2) (length ref))
6307                           (setq ref ref2)))
6308                       ref)
6309                   (setq ref nil))))
6310             ;; Chars.
6311             (progn
6312               (goto-char p)
6313               (if (search-forward "\nchars: " nil t)
6314                   (if (numberp (setq chars (ignore-errors (read cur))))
6315                       chars -1)
6316                 -1))
6317             ;; Lines.
6318             (progn
6319               (goto-char p)
6320               (if (search-forward "\nlines: " nil t)
6321                   (if (numberp (setq lines (ignore-errors (read cur))))
6322                       lines -1)
6323                 -1))
6324             ;; Xref.
6325             (progn
6326               (goto-char p)
6327               (and (search-forward "\nxref:" nil t)
6328                    (nnheader-header-value)))
6329             ;; Extra.
6330             (when gnus-extra-headers
6331               (let ((extra gnus-extra-headers)
6332                     out)
6333                 (while extra
6334                   (goto-char p)
6335                   (when (search-forward
6336                          (concat "\n" (symbol-name (car extra)) ":") nil t)
6337                     (push (cons (car extra) (nnheader-header-value))
6338                           out))
6339                   (pop extra))
6340                 out))))
6341           (when (equal id ref)
6342             (setq ref nil))
6343
6344           (when gnus-alter-header-function
6345             (funcall gnus-alter-header-function header)
6346             (setq id (mail-header-id header)
6347                   ref (gnus-parent-id (mail-header-references header))))
6348
6349           (when (setq header
6350                       (gnus-dependencies-add-header
6351                        header dependencies force-new))
6352             (push header headers))
6353           (goto-char (point-max))
6354           (widen))
6355         (nreverse headers)))))
6356
6357 ;; Goes through the xover lines and returns a list of vectors
6358 (defun gnus-get-newsgroup-headers-xover (sequence &optional
6359                                                   force-new dependencies
6360                                                   group also-fetch-heads)
6361   "Parse the news overview data in the server buffer.
6362 Return a list of headers that match SEQUENCE (see
6363 `nntp-retrieve-headers')."
6364   ;; Get the Xref when the users reads the articles since most/some
6365   ;; NNTP servers do not include Xrefs when using XOVER.
6366   (setq gnus-article-internal-prepare-hook '(gnus-article-get-xrefs))
6367   (let ((mail-parse-charset gnus-newsgroup-charset)
6368         (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
6369         (cur nntp-server-buffer)
6370         (dependencies (or dependencies gnus-newsgroup-dependencies))
6371         (allp (cond
6372                ((eq gnus-read-all-available-headers t)
6373                 t)
6374                ((and (stringp gnus-read-all-available-headers)
6375                      group)
6376                 (string-match gnus-read-all-available-headers group))
6377                (t
6378                 nil)))
6379         number headers header)
6380     (with-current-buffer nntp-server-buffer
6381       (subst-char-in-region (point-min) (point-max) ?\r ?  t)
6382       ;; Allow the user to mangle the headers before parsing them.
6383       (gnus-run-hooks 'gnus-parse-headers-hook)
6384       (goto-char (point-min))
6385       (gnus-parse-without-error
6386         (while (and (or sequence allp)
6387                     (not (eobp)))
6388           (setq number (read cur))
6389           (when (not allp)
6390             (while (and sequence
6391                         (< (car sequence) number))
6392               (setq sequence (cdr sequence))))
6393           (when (and (or allp
6394                          (and sequence
6395                               (eq number (car sequence))))
6396                      (progn
6397                        (setq sequence (cdr sequence))
6398                        (setq header (inline
6399                                       (gnus-nov-parse-line
6400                                        number dependencies force-new)))))
6401             (push header headers))
6402           (forward-line 1)))
6403       ;; A common bug in inn is that if you have posted an article and
6404       ;; then retrieves the active file, it will answer correctly --
6405       ;; the new article is included.  However, a NOV entry for the
6406       ;; article may not have been generated yet, so this may fail.
6407       ;; We work around this problem by retrieving the last few
6408       ;; headers using HEAD.
6409       (if (or (not also-fetch-heads)
6410               (not sequence))
6411           ;; We (probably) got all the headers.
6412           (nreverse headers)
6413         (let ((gnus-nov-is-evil t))
6414           (nconc
6415            (nreverse headers)
6416            (when (eq (gnus-retrieve-headers sequence group) 'headers)
6417              (gnus-get-newsgroup-headers))))))))
6418
6419 (defun gnus-article-get-xrefs ()
6420   "Fill in the Xref value in `gnus-current-headers', if necessary.
6421 This is meant to be called in `gnus-article-internal-prepare-hook'."
6422   (let ((headers (with-current-buffer gnus-summary-buffer
6423                    gnus-current-headers)))
6424     (or (not gnus-use-cross-reference)
6425         (not headers)
6426         (and (mail-header-xref headers)
6427              (not (string= (mail-header-xref headers) "")))
6428         (let ((case-fold-search t)
6429               xref)
6430           (save-restriction
6431             (nnheader-narrow-to-headers)
6432             (goto-char (point-min))
6433             (when (or (and (not (eobp))
6434                            (eq (downcase (char-after)) ?x)
6435                            (looking-at "Xref:"))
6436                       (search-forward "\nXref:" nil t))
6437               (goto-char (1+ (match-end 0)))
6438               (setq xref (buffer-substring (point) (point-at-eol)))
6439               (mail-header-set-xref headers xref)))))))
6440
6441 (defun gnus-summary-insert-subject (id &optional old-header use-old-header)
6442   "Find article ID and insert the summary line for that article.
6443 OLD-HEADER can either be a header or a line number to insert
6444 the subject line on."
6445   (let* ((line (and (numberp old-header) old-header))
6446          (old-header (and (vectorp old-header) old-header))
6447          (header (cond ((and old-header use-old-header)
6448                         old-header)
6449                        ((and (numberp id)
6450                              (gnus-number-to-header id))
6451                         (gnus-number-to-header id))
6452                        (t
6453                         (gnus-read-header id))))
6454          (number (and (numberp id) id))
6455          d)
6456     (when header
6457       ;; Rebuild the thread that this article is part of and go to the
6458       ;; article we have fetched.
6459       (when (and (not gnus-show-threads)
6460                  old-header)
6461         (when (and number
6462                    (setq d (gnus-data-find (mail-header-number old-header))))
6463           (goto-char (gnus-data-pos d))
6464           (gnus-data-remove
6465            number
6466            (- (point-at-bol)
6467               (prog1
6468                   (1+ (point-at-eol))
6469                 (gnus-delete-line))))))
6470       ;; Remove list identifiers from subject.
6471       (when gnus-list-identifiers
6472         (let ((gnus-newsgroup-headers (list header)))
6473           (gnus-summary-remove-list-identifiers)))
6474       (when old-header
6475         (mail-header-set-number header (mail-header-number old-header)))
6476       (setq gnus-newsgroup-sparse
6477             (delq (setq number (mail-header-number header))
6478                   gnus-newsgroup-sparse))
6479       (setq gnus-newsgroup-ancient (delq number gnus-newsgroup-ancient))
6480       (push number gnus-newsgroup-limit)
6481       (gnus-rebuild-thread (mail-header-id header) line)
6482       (gnus-summary-goto-subject number nil t))
6483     (when (and (numberp number)
6484                (> number 0))
6485       ;; We have to update the boundaries even if we can't fetch the
6486       ;; article if ID is a number -- so that the next `P' or `N'
6487       ;; command will fetch the previous (or next) article even
6488       ;; if the one we tried to fetch this time has been canceled.
6489       (when (> number gnus-newsgroup-end)
6490         (setq gnus-newsgroup-end number))
6491       (when (< number gnus-newsgroup-begin)
6492         (setq gnus-newsgroup-begin number))
6493       (setq gnus-newsgroup-unselected
6494             (delq number gnus-newsgroup-unselected)))
6495     ;; Report back a success?
6496     (and header (mail-header-number header))))
6497
6498 ;;; Process/prefix in the summary buffer
6499
6500 (defun gnus-summary-work-articles (n)
6501   "Return a list of articles to be worked upon.
6502 The prefix argument, the list of process marked articles, and the
6503 current article will be taken into consideration."
6504   (with-current-buffer gnus-summary-buffer
6505     (cond
6506      (n
6507       ;; A numerical prefix has been given.
6508       (setq n (prefix-numeric-value n))
6509       (let ((backward (< n 0))
6510             (n (abs (prefix-numeric-value n)))
6511             articles article)
6512         (save-excursion
6513           (while
6514               (and (> n 0)
6515                    (push (setq article (gnus-summary-article-number))
6516                          articles)
6517                    (if backward
6518                        (gnus-summary-find-prev nil article)
6519                      (gnus-summary-find-next nil article)))
6520             (decf n)))
6521         (nreverse articles)))
6522      ((and (gnus-region-active-p) (mark))
6523       (message "region active")
6524       ;; Work on the region between point and mark.
6525       (let ((max (max (point) (mark)))
6526             articles article)
6527         (save-excursion
6528           (goto-char (min (point) (mark)))
6529           (while
6530               (and
6531                (push (setq article (gnus-summary-article-number)) articles)
6532                (gnus-summary-find-next nil article)
6533                (< (point) max)))
6534           (nreverse articles))))
6535      (gnus-newsgroup-processable
6536       ;; There are process-marked articles present.
6537       ;; Save current state.
6538       (gnus-summary-save-process-mark)
6539       ;; Return the list.
6540       (reverse gnus-newsgroup-processable))
6541      (t
6542       ;; Just return the current article.
6543       (list (gnus-summary-article-number))))))
6544
6545 (defmacro gnus-summary-iterate (arg &rest forms)
6546   "Iterate over the process/prefixed articles and do FORMS.
6547 ARG is the interactive prefix given to the command.  FORMS will be
6548 executed with point over the summary line of the articles."
6549   (let ((articles (make-symbol "gnus-summary-iterate-articles")))
6550     `(let ((,articles (gnus-summary-work-articles ,arg)))
6551        (while ,articles
6552          (gnus-summary-goto-subject (car ,articles))
6553          ,@forms
6554          (pop ,articles)))))
6555
6556 (put 'gnus-summary-iterate 'lisp-indent-function 1)
6557 (put 'gnus-summary-iterate 'edebug-form-spec '(form body))
6558
6559 (defun gnus-summary-save-process-mark ()
6560   "Push the current set of process marked articles on the stack."
6561   (interactive)
6562   (push (copy-sequence gnus-newsgroup-processable)
6563         gnus-newsgroup-process-stack))
6564
6565 (defun gnus-summary-kill-process-mark ()
6566   "Push the current set of process marked articles on the stack and unmark."
6567   (interactive)
6568   (gnus-summary-save-process-mark)
6569   (gnus-summary-unmark-all-processable))
6570
6571 (defun gnus-summary-yank-process-mark ()
6572   "Pop the last process mark state off the stack and restore it."
6573   (interactive)
6574   (unless gnus-newsgroup-process-stack
6575     (error "Empty mark stack"))
6576   (gnus-summary-process-mark-set (pop gnus-newsgroup-process-stack)))
6577
6578 (defun gnus-summary-process-mark-set (set)
6579   "Make SET into the current process marked articles."
6580   (gnus-summary-unmark-all-processable)
6581   (mapc 'gnus-summary-set-process-mark set))
6582
6583 ;;; Searching and stuff
6584
6585 (defun gnus-summary-search-group (&optional backward use-level)
6586   "Search for next unread newsgroup.
6587 If optional argument BACKWARD is non-nil, search backward instead."
6588   (with-current-buffer gnus-group-buffer
6589     (when (gnus-group-search-forward
6590            backward nil (if use-level (gnus-group-group-level) nil))
6591       (gnus-group-group-name))))
6592
6593 (defun gnus-summary-best-group (&optional exclude-group)
6594   "Find the name of the best unread group.
6595 If EXCLUDE-GROUP, do not go to this group."
6596   (with-current-buffer gnus-group-buffer
6597     (save-excursion
6598       (gnus-group-best-unread-group exclude-group))))
6599
6600 (defun gnus-summary-find-next (&optional unread article backward)
6601   (if backward
6602       (gnus-summary-find-prev unread article)
6603     (let* ((dummy (gnus-summary-article-intangible-p))
6604            (article (or article (gnus-summary-article-number)))
6605            (data (gnus-data-find-list article))
6606            result)
6607       (when (and (not dummy)
6608                  (or (not gnus-summary-check-current)
6609                      (not unread)
6610                      (not (gnus-data-unread-p (car data)))))
6611         (setq data (cdr data)))
6612       (when (setq result
6613                   (if unread
6614                       (progn
6615                         (while data
6616                           (unless (memq (gnus-data-number (car data))
6617                                         (cond
6618                                          ((eq gnus-auto-goto-ignores
6619                                               'always-undownloaded)
6620                                           gnus-newsgroup-undownloaded)
6621                                          (gnus-plugged
6622                                           nil)
6623                                          ((eq gnus-auto-goto-ignores
6624                                               'unfetched)
6625                                           gnus-newsgroup-unfetched)
6626                                          ((eq gnus-auto-goto-ignores
6627                                               'undownloaded)
6628                                           gnus-newsgroup-undownloaded)))
6629                             (when (gnus-data-unread-p (car data))
6630                               (setq result (car data)
6631                                     data nil)))
6632                           (setq data (cdr data)))
6633                         result)
6634                     (car data)))
6635         (goto-char (gnus-data-pos result))
6636         (gnus-data-number result)))))
6637
6638 (defun gnus-summary-find-prev (&optional unread article)
6639   (let* ((eobp (eobp))
6640          (article (or article (gnus-summary-article-number)))
6641          (data (gnus-data-find-list article (gnus-data-list 'rev)))
6642          result)
6643     (when (and (not eobp)
6644                (or (not gnus-summary-check-current)
6645                    (not unread)
6646                    (not (gnus-data-unread-p (car data)))))
6647       (setq data (cdr data)))
6648     (when (setq result
6649                 (if unread
6650                     (progn
6651                       (while data
6652                         (unless (memq (gnus-data-number (car data))
6653                                       (cond
6654                                        ((eq gnus-auto-goto-ignores
6655                                             'always-undownloaded)
6656                                         gnus-newsgroup-undownloaded)
6657                                        (gnus-plugged
6658                                         nil)
6659                                        ((eq gnus-auto-goto-ignores
6660                                             'unfetched)
6661                                         gnus-newsgroup-unfetched)
6662                                        ((eq gnus-auto-goto-ignores
6663                                             'undownloaded)
6664                                         gnus-newsgroup-undownloaded)))
6665                           (when (gnus-data-unread-p (car data))
6666                             (setq result (car data)
6667                                   data nil)))
6668                         (setq data (cdr data)))
6669                       result)
6670                   (car data)))
6671       (goto-char (gnus-data-pos result))
6672       (gnus-data-number result))))
6673
6674 (defun gnus-summary-find-subject (subject &optional unread backward article)
6675   (let* ((simp-subject (gnus-simplify-subject-fully subject))
6676          (article (or article (gnus-summary-article-number)))
6677          (articles (gnus-data-list backward))
6678          (arts (gnus-data-find-list article articles))
6679          result)
6680     (when (or (not gnus-summary-check-current)
6681               (not unread)
6682               (not (gnus-data-unread-p (car arts))))
6683       (setq arts (cdr arts)))
6684     (while arts
6685       (and (or (not unread)
6686                (gnus-data-unread-p (car arts)))
6687            (vectorp (gnus-data-header (car arts)))
6688            (gnus-subject-equal
6689             simp-subject (mail-header-subject (gnus-data-header (car arts))) t)
6690            (setq result (car arts)
6691                  arts nil))
6692       (setq arts (cdr arts)))
6693     (and result
6694          (goto-char (gnus-data-pos result))
6695          (gnus-data-number result))))
6696
6697 (defun gnus-summary-search-forward (&optional unread subject backward)
6698   "Search forward for an article.
6699 If UNREAD, look for unread articles.  If SUBJECT, look for
6700 articles with that subject.  If BACKWARD, search backward instead."
6701   (cond (subject (gnus-summary-find-subject subject unread backward))
6702         (backward (gnus-summary-find-prev unread))
6703         (t (gnus-summary-find-next unread))))
6704
6705 (defun gnus-recenter (&optional n)
6706   "Center point in window and redisplay frame.
6707 Also do horizontal recentering."
6708   (interactive "P")
6709   (when (and gnus-auto-center-summary
6710              (not (eq gnus-auto-center-summary 'vertical)))
6711     (gnus-horizontal-recenter))
6712   (if (fboundp 'recenter-top-bottom)
6713       (recenter-top-bottom n)
6714     (recenter n)))
6715
6716 (put 'gnus-recenter 'isearch-scroll t)
6717
6718 (defun gnus-forward-line-ignore-invisible (n)
6719   "Move N lines forward (backward if N is negative).
6720 Like forward-line, but skip over (and don't count) invisible lines."
6721   (let (done)
6722     (while (and (> n 0) (not done))
6723       ;; If the following character is currently invisible,
6724       ;; skip all characters with that same `invisible' property value.
6725       (while (gnus-invisible-p (point))
6726         (goto-char (gnus-next-char-property-change (point))))
6727       (forward-line 1)
6728       (if (eobp)
6729           (setq done t)
6730         (setq n (1- n))))
6731     (while (and (< n 0) (not done))
6732       (forward-line -1)
6733       (if (bobp) (setq done t)
6734         (setq n (1+ n))
6735         (while (and (not (bobp)) (gnus-invisible-p (1- (point))))
6736           (goto-char (gnus-previous-char-property-change (point))))))))
6737
6738 (defun gnus-summary-recenter ()
6739   "Center point in the summary window.
6740 If `gnus-auto-center-summary' is nil, or the article buffer isn't
6741 displayed, no centering will be performed."
6742   ;; Suggested by earle@mahendo.JPL.NASA.GOV (Greg Earle).
6743   ;; Recenter only when requested.  Suggested by popovich@park.cs.columbia.edu.
6744   (interactive)
6745   ;; The user has to want it.
6746   (when gnus-auto-center-summary
6747     (let* ((top (cond ((< (window-height) 4) 0)
6748                       ((< (window-height) 7) 1)
6749                       (t (if (numberp gnus-auto-center-summary)
6750                              gnus-auto-center-summary
6751                            (/ (1- (window-height)) 2)))))
6752            (height (1- (window-height)))
6753            (bottom (save-excursion
6754                      (goto-char (point-max))
6755                      (gnus-forward-line-ignore-invisible (- height))
6756                      (point)))
6757            (window (get-buffer-window (current-buffer))))
6758       (when (get-buffer-window gnus-article-buffer)
6759         ;; Only do recentering when the article buffer is displayed,
6760         ;; Set the window start to either `bottom', which is the biggest
6761         ;; possible valid number, or the second line from the top,
6762         ;; whichever is the least.
6763         (let ((top-pos (save-excursion
6764                          (gnus-forward-line-ignore-invisible (- top))
6765                          (point))))
6766           (if (> bottom top-pos)
6767               ;; Keep the second line from the top visible
6768               (set-window-start window top-pos)
6769             ;; Try to keep the bottom line visible; if it's partially
6770             ;; obscured, either scroll one more line to make it fully
6771             ;; visible, or revert to using TOP-POS.
6772             (save-excursion
6773               (goto-char (point-max))
6774               (gnus-forward-line-ignore-invisible -1)
6775               (let ((last-line-start (point)))
6776                 (goto-char bottom)
6777                 (set-window-start window (point) t)
6778                 (when (not (pos-visible-in-window-p last-line-start window))
6779                   (gnus-forward-line-ignore-invisible 1)
6780                   (set-window-start window (min (point) top-pos) t)))))))
6781       ;; Do horizontal recentering while we're at it.
6782       (when (and (get-buffer-window (current-buffer) t)
6783                  (not (eq gnus-auto-center-summary 'vertical)))
6784         (let ((selected (selected-window)))
6785           (select-window (get-buffer-window (current-buffer) t))
6786           (gnus-summary-position-point)
6787           (gnus-horizontal-recenter)
6788           (select-window selected))))))
6789
6790 (defun gnus-summary-jump-to-group (newsgroup)
6791   "Move point to NEWSGROUP in group mode buffer."
6792   ;; Keep update point of group mode buffer if visible.
6793   (if (eq (current-buffer) (get-buffer gnus-group-buffer))
6794       (save-window-excursion
6795         ;; Take care of tree window mode.
6796         (when (get-buffer-window gnus-group-buffer)
6797           (pop-to-buffer gnus-group-buffer))
6798         (gnus-group-jump-to-group newsgroup))
6799     (save-excursion
6800       ;; Take care of tree window mode.
6801       (if (get-buffer-window gnus-group-buffer 0)
6802           (pop-to-buffer gnus-group-buffer)
6803         (set-buffer gnus-group-buffer))
6804       (gnus-group-jump-to-group newsgroup))))
6805
6806 ;; This function returns a list of article numbers based on the
6807 ;; difference between the ranges of read articles in this group and
6808 ;; the range of active articles.
6809 (defun gnus-list-of-unread-articles (group)
6810   (let* ((read (gnus-info-read (gnus-get-info group)))
6811          (active (or (gnus-active group) (gnus-activate-group group)))
6812          (last (or (cdr active)
6813                    (error "Group %s couldn't be activated " group)))
6814          (bottom (if gnus-newsgroup-maximum-articles
6815                      (max (car active)
6816                           (- last gnus-newsgroup-maximum-articles -1))
6817                    (car active)))
6818          first nlast unread)
6819     ;; If none are read, then all are unread.
6820     (if (not read)
6821         (setq first bottom)
6822       ;; If the range of read articles is a single range, then the
6823       ;; first unread article is the article after the last read
6824       ;; article.  Sounds logical, doesn't it?
6825       (if (and (not (listp (cdr read)))
6826                (or (< (car read) bottom)
6827                    (progn (setq read (list read))
6828                           nil)))
6829           (setq first (max bottom (1+ (cdr read))))
6830         ;; `read' is a list of ranges.
6831         (when (/= (setq nlast (or (and (numberp (car read)) (car read))
6832                                   (caar read)))
6833                   1)
6834           (setq first bottom))
6835         (while read
6836           (when first
6837             (while (< first nlast)
6838               (setq unread (cons first unread)
6839                     first (1+ first))))
6840           (setq first (1+ (if (atom (car read)) (car read) (cdar read))))
6841           (setq nlast (if (atom (cadr read)) (cadr read) (caadr read)))
6842           (setq read (cdr read)))))
6843     ;; And add the last unread articles.
6844     (while (<= first last)
6845       (setq unread (cons first unread)
6846             first (1+ first)))
6847     ;; Return the list of unread articles.
6848     (delq 0 (nreverse unread))))
6849
6850 (defun gnus-list-of-read-articles (group)
6851   "Return a list of unread, unticked and non-dormant articles."
6852   (let* ((info (gnus-get-info group))
6853          (marked (gnus-info-marks info))
6854          (active (gnus-active group)))
6855     (and info active
6856          (gnus-list-range-difference
6857           (gnus-list-range-difference
6858            (gnus-sorted-complement
6859             (gnus-uncompress-range
6860              (if gnus-newsgroup-maximum-articles
6861                  (cons (max (car active)
6862                             (- (cdr active)
6863                                gnus-newsgroup-maximum-articles
6864                                -1))
6865                        (cdr active))
6866                active))
6867             (gnus-list-of-unread-articles group))
6868            (cdr (assq 'dormant marked)))
6869           (cdr (assq 'tick marked))))))
6870
6871 ;; This function returns a sequence of article numbers based on the
6872 ;; difference between the ranges of read articles in this group and
6873 ;; the range of active articles.
6874 (defun gnus-sequence-of-unread-articles (group)
6875   (let* ((read (gnus-info-read (gnus-get-info group)))
6876          (active (or (gnus-active group) (gnus-activate-group group)))
6877          (last (cdr active))
6878          (bottom (if gnus-newsgroup-maximum-articles
6879                      (max (car active)
6880                           (- last gnus-newsgroup-maximum-articles -1))
6881                    (car active)))
6882          first nlast unread)
6883     ;; If none are read, then all are unread.
6884     (if (not read)
6885         (setq first bottom)
6886       ;; If the range of read articles is a single range, then the
6887       ;; first unread article is the article after the last read
6888       ;; article.  Sounds logical, doesn't it?
6889       (if (and (not (listp (cdr read)))
6890                (or (< (car read) bottom)
6891                    (progn (setq read (list read))
6892                           nil)))
6893           (setq first (max bottom (1+ (cdr read))))
6894         ;; `read' is a list of ranges.
6895         (when (/= (setq nlast (or (and (numberp (car read)) (car read))
6896                                   (caar read)))
6897                   1)
6898           (setq first bottom))
6899         (while read
6900           (when first
6901             (push (cons first nlast) unread))
6902           (setq first (1+ (if (atom (car read)) (car read) (cdar read))))
6903           (setq nlast (if (atom (cadr read)) (cadr read) (caadr read)))
6904           (setq read (cdr read)))))
6905     ;; And add the last unread articles.
6906     (cond ((not (and first last))
6907            nil)
6908           ((< first last)
6909            (push (cons first last) unread))
6910           ((= first last)
6911            (push first unread)))
6912     ;; Return the sequence of unread articles.
6913     (delq 0 (nreverse unread))))
6914
6915 ;; Various summary commands
6916
6917 (defun gnus-summary-select-article-buffer ()
6918   "Reconfigure windows to show article buffer."
6919   (interactive)
6920   (if (not (gnus-buffer-live-p gnus-article-buffer))
6921       (error "There is no article buffer for this summary buffer")
6922     (gnus-configure-windows 'article)
6923     (select-window (get-buffer-window gnus-article-buffer))))
6924
6925 (defun gnus-summary-universal-argument (arg)
6926   "Perform any operation on all articles that are process/prefixed."
6927   (interactive "P")
6928   (let ((articles (gnus-summary-work-articles arg))
6929         func article)
6930     (if (eq
6931          (setq
6932           func
6933           (key-binding
6934            (read-key-sequence
6935             (substitute-command-keys
6936              "\\<gnus-summary-mode-map>\\[gnus-summary-universal-argument]"))))
6937          'undefined)
6938         (gnus-error 1 "Undefined key")
6939       (save-excursion
6940         (while articles
6941           (gnus-summary-goto-subject (setq article (pop articles)))
6942           (let (gnus-newsgroup-processable)
6943             (command-execute func))
6944           (gnus-summary-remove-process-mark article)))))
6945   (gnus-summary-position-point))
6946
6947 (defun gnus-summary-toggle-truncation (&optional arg)
6948   "Toggle truncation of summary lines.
6949 With ARG, turn line truncation on if ARG is positive."
6950   (interactive "P")
6951   (setq truncate-lines
6952         (if (null arg) (not truncate-lines)
6953           (> (prefix-numeric-value arg) 0)))
6954   (redraw-display))
6955
6956 (defun gnus-summary-find-for-reselect ()
6957   "Return the number of an article to stay on across a reselect.
6958 The current article is considered, then following articles, then previous
6959 articles.  An article is sought which is not cancelled and isn't a temporary
6960 insertion from another group.  If there's no such then return a dummy 0."
6961   (let (found)
6962     (dolist (rev '(nil t))
6963       (unless found      ; don't demand the reverse list if we don't need it
6964         (let ((data (gnus-data-find-list
6965                      (gnus-summary-article-number) (gnus-data-list rev))))
6966           (while (and data (not found))
6967             (if (and (< 0 (gnus-data-number (car data)))
6968                      (not (eq gnus-canceled-mark (gnus-data-mark (car data)))))
6969                 (setq found (gnus-data-number (car data))))
6970             (setq data (cdr data))))))
6971     (or found 0)))
6972
6973 (defun gnus-summary-reselect-current-group (&optional all rescan)
6974   "Exit and then reselect the current newsgroup.
6975 The prefix argument ALL means to select all articles."
6976   (interactive "P")
6977   (when (gnus-ephemeral-group-p gnus-newsgroup-name)
6978     (error "Ephemeral groups can't be reselected"))
6979   (let ((current-subject (gnus-summary-find-for-reselect))
6980         (group gnus-newsgroup-name))
6981     (setq gnus-newsgroup-begin nil)
6982     (gnus-summary-exit nil 'leave-hidden)
6983     ;; We have to adjust the point of group mode buffer because
6984     ;; point was moved to the next unread newsgroup by exiting.
6985     (gnus-summary-jump-to-group group)
6986     (when rescan
6987       (save-excursion
6988         (gnus-group-get-new-news-this-group 1)))
6989     (gnus-group-read-group all t)
6990     (gnus-summary-goto-subject current-subject nil t)))
6991
6992 (defun gnus-summary-rescan-group (&optional all)
6993   "Exit the newsgroup, ask for new articles, and select the newsgroup."
6994   (interactive "P")
6995   (gnus-summary-reselect-current-group all t))
6996
6997 (defun gnus-summary-update-info (&optional non-destructive)
6998   (save-excursion
6999     (let ((group gnus-newsgroup-name))
7000       (when group
7001         (when gnus-newsgroup-kill-headers
7002           (setq gnus-newsgroup-killed
7003                 (gnus-compress-sequence
7004                  (gnus-sorted-union
7005                   (gnus-list-range-intersection
7006                    gnus-newsgroup-unselected gnus-newsgroup-killed)
7007                   gnus-newsgroup-unreads)
7008                  t)))
7009         (unless (listp (cdr gnus-newsgroup-killed))
7010           (setq gnus-newsgroup-killed (list gnus-newsgroup-killed)))
7011         (let ((headers gnus-newsgroup-headers))
7012           ;; Set the new ranges of read articles.
7013           (with-current-buffer gnus-group-buffer
7014             (gnus-undo-force-boundary))
7015           (gnus-update-read-articles
7016            group (gnus-sorted-union
7017                   gnus-newsgroup-unreads gnus-newsgroup-unselected))
7018           ;; Set the current article marks.
7019           (let ((gnus-newsgroup-scored
7020                  (if (and (not gnus-save-score)
7021                           (not non-destructive))
7022                      nil
7023                    gnus-newsgroup-scored)))
7024             (save-excursion
7025               (gnus-update-marks)))
7026           ;; Do the cross-ref thing.
7027           (when gnus-use-cross-reference
7028             (gnus-mark-xrefs-as-read group headers gnus-newsgroup-unreads))
7029           ;; Do not switch windows but change the buffer to work.
7030           (set-buffer gnus-group-buffer)
7031           (unless (gnus-ephemeral-group-p group)
7032             (gnus-group-update-group group)))))))
7033
7034 (defun gnus-summary-save-newsrc (&optional force)
7035   "Save the current number of read/marked articles in the dribble buffer.
7036 The dribble buffer will then be saved.
7037 If FORCE (the prefix), also save the .newsrc file(s)."
7038   (interactive "P")
7039   (gnus-summary-update-info t)
7040   (if force
7041       (gnus-save-newsrc-file)
7042     (gnus-dribble-save)))
7043
7044 (declare-function gnus-cache-write-active "gnus-cache" (&optional force))
7045
7046 (defun gnus-summary-exit (&optional temporary leave-hidden)
7047   "Exit reading current newsgroup, and then return to group selection mode.
7048 `gnus-exit-group-hook' is called with no arguments if that value is non-nil."
7049   (interactive)
7050   (gnus-set-global-variables)
7051   (when (gnus-buffer-live-p gnus-article-buffer)
7052     (with-current-buffer gnus-article-buffer
7053       (mm-destroy-parts gnus-article-mime-handles)
7054       ;; Set it to nil for safety reason.
7055       (setq gnus-article-mime-handle-alist nil)
7056       (setq gnus-article-mime-handles nil)))
7057   (gnus-kill-save-kill-buffer)
7058   (gnus-async-halt-prefetch)
7059   (let* ((group gnus-newsgroup-name)
7060          (quit-config (gnus-group-quit-config gnus-newsgroup-name))
7061          (gnus-group-is-exiting-p t)
7062          (mode major-mode)
7063          (group-point nil)
7064          (buf (current-buffer)))
7065     (unless quit-config
7066       ;; Do adaptive scoring, and possibly save score files.
7067       (when gnus-newsgroup-adaptive
7068         (gnus-score-adaptive))
7069       (when gnus-use-scoring
7070         (gnus-score-save)))
7071     (gnus-run-hooks 'gnus-summary-prepare-exit-hook)
7072     ;; If we have several article buffers, we kill them at exit.
7073     (unless gnus-single-article-buffer
7074       (when (gnus-buffer-live-p gnus-article-buffer)
7075         (with-current-buffer gnus-article-buffer
7076           ;; Don't kill sticky article buffers
7077           (unless (eq major-mode 'gnus-sticky-article-mode)
7078             (gnus-kill-buffer gnus-article-buffer)
7079             (setq gnus-article-current nil))))
7080       (gnus-kill-buffer gnus-original-article-buffer))
7081     (when gnus-use-cache
7082       (gnus-cache-possibly-remove-articles)
7083       (gnus-cache-save-buffers))
7084     (gnus-async-prefetch-remove-group group)
7085     (when gnus-suppress-duplicates
7086       (gnus-dup-enter-articles))
7087     (when gnus-use-trees
7088       (gnus-tree-close group))
7089     (when gnus-use-cache
7090       (gnus-cache-write-active))
7091     ;; Remove entries for this group.
7092     (nnmail-purge-split-history (gnus-group-real-name group))
7093     ;; Make all changes in this group permanent.
7094     (unless quit-config
7095       (gnus-run-hooks 'gnus-exit-group-hook)
7096       (gnus-summary-update-info))
7097     (gnus-close-group group)
7098     ;; Make sure where we were, and go to next newsgroup.
7099     (set-buffer gnus-group-buffer)
7100     (unless quit-config
7101       (gnus-group-jump-to-group group))
7102     (gnus-run-hooks 'gnus-summary-exit-hook)
7103     (unless (or quit-config
7104                 (not gnus-summary-next-group-on-exit)
7105                 ;; If this group has disappeared from the summary
7106                 ;; buffer, don't skip forwards.
7107                 (not (string= group (gnus-group-group-name))))
7108       (gnus-group-next-unread-group 1))
7109     (setq group-point (point))
7110     (if temporary
7111         nil                             ;Nothing to do.
7112       (set-buffer buf)
7113       (if (not gnus-kill-summary-on-exit)
7114           (progn
7115             (gnus-deaden-summary)
7116             (setq mode nil))
7117         ;; We set all buffer-local variables to nil.  It is unclear why
7118         ;; this is needed, but if we don't, buffer-local variables are
7119         ;; not garbage-collected, it seems.  This would the lead to en
7120         ;; ever-growing Emacs.
7121         (gnus-summary-clear-local-variables)
7122         (let ((gnus-summary-local-variables gnus-newsgroup-variables))
7123           (gnus-summary-clear-local-variables))
7124         (when (get-buffer gnus-article-buffer)
7125           (bury-buffer gnus-article-buffer))
7126         ;; Return to group mode buffer.
7127         (when (eq mode 'gnus-summary-mode)
7128           (gnus-kill-buffer buf)))
7129       (setq gnus-current-select-method gnus-select-method)
7130       (set-buffer gnus-group-buffer)
7131       (if quit-config
7132           (gnus-handle-ephemeral-exit quit-config)
7133         (goto-char group-point)
7134         ;; If gnus-group-buffer is already displayed, make sure we also move
7135         ;; the cursor in the window that displays it.
7136         (let ((win (get-buffer-window (current-buffer) 0)))
7137           (if win (set-window-point win (point))))
7138         (unless leave-hidden
7139           (gnus-configure-windows 'group 'force)))
7140       ;; Clear the current group name.
7141       (unless quit-config
7142         (setq gnus-newsgroup-name nil)))))
7143
7144 (defalias 'gnus-summary-quit 'gnus-summary-exit-no-update)
7145 (defun gnus-summary-exit-no-update (&optional no-questions)
7146   "Quit reading current newsgroup without updating read article info."
7147   (interactive)
7148   (let* ((group gnus-newsgroup-name)
7149          (gnus-group-is-exiting-p t)
7150          (gnus-group-is-exiting-without-update-p t)
7151          (quit-config (gnus-group-quit-config group)))
7152     (when (or no-questions
7153               gnus-expert-user
7154               (gnus-y-or-n-p "Discard changes to this group and exit? "))
7155       (gnus-async-halt-prefetch)
7156       (run-hooks 'gnus-summary-prepare-exit-hook)
7157       (when (gnus-buffer-live-p gnus-article-buffer)
7158         (with-current-buffer gnus-article-buffer
7159           (mm-destroy-parts gnus-article-mime-handles)
7160           ;; Set it to nil for safety reason.
7161           (setq gnus-article-mime-handle-alist nil)
7162           (setq gnus-article-mime-handles nil)))
7163       ;; If we have several article buffers, we kill them at exit.
7164       (unless gnus-single-article-buffer
7165         (gnus-kill-buffer gnus-article-buffer)
7166         (gnus-kill-buffer gnus-original-article-buffer)
7167         (setq gnus-article-current nil))
7168       (if (not gnus-kill-summary-on-exit)
7169           (gnus-deaden-summary)
7170         (gnus-close-group group)
7171         (gnus-summary-clear-local-variables)
7172         (let ((gnus-summary-local-variables gnus-newsgroup-variables))
7173           (gnus-summary-clear-local-variables))
7174         (gnus-kill-buffer gnus-summary-buffer))
7175       (unless gnus-single-article-buffer
7176         (setq gnus-article-current nil))
7177       (when gnus-use-trees
7178         (gnus-tree-close group))
7179       (gnus-async-prefetch-remove-group group)
7180       (when (get-buffer gnus-article-buffer)
7181         (bury-buffer gnus-article-buffer))
7182       ;; Return to the group buffer.
7183       (gnus-configure-windows 'group 'force)
7184       ;; Clear the current group name.
7185       (setq gnus-newsgroup-name nil)
7186       (unless (gnus-ephemeral-group-p group)
7187         (gnus-group-update-group group))
7188       (when (equal (gnus-group-group-name) group)
7189         (gnus-group-next-unread-group 1))
7190       (when quit-config
7191         (gnus-handle-ephemeral-exit quit-config)))))
7192
7193 (defun gnus-handle-ephemeral-exit (quit-config)
7194   "Handle movement when leaving an ephemeral group.
7195 The state which existed when entering the ephemeral is reset."
7196   (if (not (buffer-name (car quit-config)))
7197       (gnus-configure-windows 'group 'force)
7198     (set-buffer (car quit-config))
7199     (cond ((eq major-mode 'gnus-summary-mode)
7200            (gnus-set-global-variables))
7201           ((eq major-mode 'gnus-article-mode)
7202            (save-current-buffer
7203              ;; The `gnus-summary-buffer' variable may point
7204              ;; to the old summary buffer when using a single
7205              ;; article buffer.
7206              (unless (gnus-buffer-live-p gnus-summary-buffer)
7207                (set-buffer gnus-group-buffer))
7208              (set-buffer gnus-summary-buffer)
7209              (gnus-set-global-variables))))
7210     (if (or (eq (cdr quit-config) 'article)
7211             (eq (cdr quit-config) 'pick))
7212         (if (and (boundp 'gnus-pick-mode) (symbol-value 'gnus-pick-mode))
7213             (gnus-configure-windows 'pick 'force)
7214           (gnus-configure-windows (cdr quit-config) 'force))
7215       (gnus-configure-windows (cdr quit-config) 'force))
7216     (when (eq major-mode 'gnus-summary-mode)
7217       (if (memq gnus-auto-select-on-ephemeral-exit '(next-noselect
7218                                                      next-unread-noselect))
7219           (when (zerop (cond ((eq gnus-auto-select-on-ephemeral-exit
7220                                   'next-noselect)
7221                               (gnus-summary-next-subject 1 nil t))
7222                              ((eq gnus-auto-select-on-ephemeral-exit
7223                                   'next-unread-noselect)
7224                               (gnus-summary-next-subject 1 t t))))
7225             ;; Hide the article buffer which displays the article different
7226             ;; from the one that the cursor points to in the summary buffer.
7227             (gnus-configure-windows 'summary 'force))
7228         (cond ((eq gnus-auto-select-on-ephemeral-exit 'next)
7229                (gnus-summary-next-subject 1))
7230               ((eq gnus-auto-select-on-ephemeral-exit 'next-unread)
7231                (gnus-summary-next-subject 1 t))))
7232       (gnus-summary-recenter)
7233       (gnus-summary-position-point))))
7234
7235 ;;; Dead summaries.
7236
7237 (defvar gnus-dead-summary-mode-map
7238   (let ((map (make-keymap)))
7239     (suppress-keymap map)
7240     (substitute-key-definition 'undefined 'gnus-summary-wake-up-the-dead map)
7241     (dolist (key '("\C-d" "\r" "\177" [delete]))
7242       (define-key map key 'gnus-summary-wake-up-the-dead))
7243     (dolist (key '("q" "Q"))
7244       (define-key map key 'bury-buffer))
7245     map))
7246
7247 (define-minor-mode gnus-dead-summary-mode
7248   "Minor mode for Gnus summary buffers."
7249   :lighter " Dead" :keymap gnus-dead-summary-mode-map
7250   (unless (derived-mode-p 'gnus-summary-mode)
7251     (setq gnus-dead-summary-mode nil)))
7252
7253 (defun gnus-deaden-summary ()
7254   "Make the current summary buffer into a dead summary buffer."
7255   ;; Kill any previous dead summary buffer.
7256   (when (and gnus-dead-summary
7257              (buffer-name gnus-dead-summary))
7258     (with-current-buffer gnus-dead-summary
7259       (when gnus-dead-summary-mode
7260         (kill-buffer (current-buffer)))))
7261   ;; Make this the current dead summary.
7262   (setq gnus-dead-summary (current-buffer))
7263   (gnus-dead-summary-mode 1)
7264   (let ((name (buffer-name)))
7265     (when (string-match "Summary" name)
7266       (rename-buffer
7267        (concat (substring name 0 (match-beginning 0)) "Dead "
7268                (substring name (match-beginning 0)))
7269        t)
7270       (bury-buffer))))
7271
7272 (defun gnus-kill-or-deaden-summary (buffer)
7273   "Kill or deaden the summary BUFFER."
7274   (save-excursion
7275     (when (and (buffer-name buffer)
7276                (not gnus-single-article-buffer))
7277       (with-current-buffer buffer
7278         (gnus-kill-buffer gnus-article-buffer)
7279         (gnus-kill-buffer gnus-original-article-buffer)))
7280     (cond
7281      ;; Kill the buffer.
7282      (gnus-kill-summary-on-exit
7283       (when (and gnus-use-trees
7284                  (gnus-buffer-exists-p buffer))
7285         (with-current-buffer buffer
7286           (gnus-tree-close gnus-newsgroup-name)))
7287       (gnus-kill-buffer buffer))
7288      ;; Deaden the buffer.
7289      ((gnus-buffer-exists-p buffer)
7290       (with-current-buffer buffer
7291         (gnus-deaden-summary))))))
7292
7293 (defun gnus-summary-wake-up-the-dead (&rest args)
7294   "Wake up the dead summary buffer."
7295   (interactive)
7296   (gnus-dead-summary-mode -1)
7297   (let ((name (buffer-name)))
7298     (when (string-match "Dead " name)
7299       (rename-buffer
7300        (concat (substring name 0 (match-beginning 0))
7301                (substring name (match-end 0)))
7302        t)))
7303   (gnus-message 3 "This dead summary is now alive again"))
7304
7305 ;; Suggested by Andrew Eskilsson <pi92ae@pt.hk-r.se>.
7306 (defun gnus-summary-fetch-faq (&optional faq-dir)
7307   "Fetch the FAQ for the current group.
7308 If FAQ-DIR (the prefix), prompt for a directory to search for the faq
7309 in."
7310   (interactive
7311    (list
7312     (when current-prefix-arg
7313       (completing-read
7314        "FAQ dir: " (and (listp gnus-group-faq-directory)
7315                         (mapcar 'list
7316                                 gnus-group-faq-directory))))))
7317   (let (gnus-faq-buffer)
7318     (when (setq gnus-faq-buffer
7319                 (gnus-group-fetch-faq gnus-newsgroup-name faq-dir))
7320       (gnus-configure-windows 'summary-faq))))
7321
7322 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
7323 (defun gnus-summary-describe-group (&optional force)
7324   "Describe the current newsgroup."
7325   (interactive "P")
7326   (gnus-group-describe-group force gnus-newsgroup-name))
7327
7328 (defun gnus-summary-describe-briefly ()
7329   "Describe summary mode commands briefly."
7330   (interactive)
7331   (gnus-message 6 (substitute-command-keys "\\<gnus-summary-mode-map>\\[gnus-summary-next-page]:Select  \\[gnus-summary-next-unread-article]:Forward  \\[gnus-summary-prev-unread-article]:Backward  \\[gnus-summary-exit]:Exit  \\[gnus-info-find-node]:Run Info        \\[gnus-summary-describe-briefly]:This help")))
7332
7333 ;; Walking around group mode buffer from summary mode.
7334
7335 (defun gnus-summary-next-group (&optional no-article target-group backward)
7336   "Exit current newsgroup and then select next unread newsgroup.
7337 If prefix argument NO-ARTICLE is non-nil, no article is selected
7338 initially.  If TARGET-GROUP, go to this group.  If BACKWARD, go to
7339 previous group instead."
7340   (interactive "P")
7341   ;; Stop pre-fetching.
7342   (gnus-async-halt-prefetch)
7343   (let ((current-group gnus-newsgroup-name)
7344         (current-buffer (current-buffer))
7345         entered)
7346     ;; First we semi-exit this group to update Xrefs and all variables.
7347     ;; We can't do a real exit, because the window conf must remain
7348     ;; the same in case the user is prompted for info, and we don't
7349     ;; want the window conf to change before that...
7350     (gnus-summary-exit t)
7351     (while (not entered)
7352       ;; Then we find what group we are supposed to enter.
7353       (set-buffer gnus-group-buffer)
7354       (gnus-group-jump-to-group current-group)
7355       (setq target-group
7356             (or target-group
7357                 (if (eq gnus-keep-same-level 'best)
7358                     (gnus-summary-best-group gnus-newsgroup-name)
7359                   (gnus-summary-search-group backward gnus-keep-same-level))))
7360       (if (not target-group)
7361           ;; There are no further groups, so we return to the group
7362           ;; buffer.
7363           (progn
7364             (gnus-message 5 "Returning to the group buffer")
7365             (setq entered t)
7366             (when (gnus-buffer-live-p current-buffer)
7367               (set-buffer current-buffer)
7368               (gnus-summary-exit))
7369             (gnus-run-hooks 'gnus-group-no-more-groups-hook))
7370         ;; We try to enter the target group.
7371         (gnus-group-jump-to-group target-group)
7372         (let ((unreads (gnus-group-group-unread)))
7373           (if (and (or (eq t unreads)
7374                        (and unreads (not (zerop unreads))))
7375                    (gnus-summary-read-group
7376                     target-group nil no-article
7377                     (and (buffer-name current-buffer) current-buffer)
7378                     nil backward))
7379               (setq entered t)
7380             (setq current-group target-group
7381                   target-group nil)))))))
7382
7383 (defun gnus-summary-prev-group (&optional no-article)
7384   "Exit current newsgroup and then select previous unread newsgroup.
7385 If prefix argument NO-ARTICLE is non-nil, no article is selected initially."
7386   (interactive "P")
7387   (gnus-summary-next-group no-article nil t))
7388
7389 ;; Walking around summary lines.
7390
7391 (defun gnus-summary-first-subject (&optional unread undownloaded unseen)
7392   "Go to the first subject satisfying any non-nil constraint.
7393 If UNREAD is non-nil, the article should be unread.
7394 If UNDOWNLOADED is non-nil, the article should be undownloaded.
7395 If UNSEEN is non-nil, the article should be unseen.
7396 Returns the article selected or nil if there are no matching articles."
7397   (interactive "P")
7398   (cond
7399    ;; Empty summary.
7400    ((null gnus-newsgroup-data)
7401     (gnus-message 3 "No articles in the group")
7402     nil)
7403    ;; Pick the first article.
7404    ((not (or unread undownloaded unseen))
7405     (goto-char (gnus-data-pos (car gnus-newsgroup-data)))
7406     (gnus-data-number (car gnus-newsgroup-data)))
7407    ;; Find the first unread article.
7408    (t
7409     (let ((data gnus-newsgroup-data))
7410       (while (and data
7411                   (let ((num (gnus-data-number (car data))))
7412                     (or (memq num gnus-newsgroup-unfetched)
7413                         (not (or (and unread
7414                                       (memq num gnus-newsgroup-unreads))
7415                                  (and undownloaded
7416                                       (memq num gnus-newsgroup-undownloaded))
7417                                  (and unseen
7418                                       (memq num gnus-newsgroup-unseen)))))))
7419         (setq data (cdr data)))
7420       (prog1
7421           (if data
7422               (progn
7423                 (goto-char (gnus-data-pos (car data)))
7424                 (gnus-data-number (car data)))
7425             (gnus-message 3 "No more%s articles"
7426                           (let* ((r (when unread " unread"))
7427                                  (d (when undownloaded " undownloaded"))
7428                                  (s (when unseen " unseen"))
7429                                  (l (delq nil (list r d s))))
7430                             (cond ((= 3 (length l))
7431                                    (concat r "," d ", or" s))
7432                                   ((= 2 (length l))
7433                                    (concat (car l) ", or" (cadr l)))
7434                                   ((= 1 (length l))
7435                                    (car l))
7436                                   (t
7437                                    ""))))
7438             nil
7439             )
7440         (gnus-summary-position-point))))))
7441
7442 (defun gnus-summary-next-subject (n &optional unread dont-display)
7443   "Go to next N'th summary line.
7444 If N is negative, go to the previous N'th subject line.
7445 If UNREAD is non-nil, only unread articles are selected.
7446 The difference between N and the actual number of steps taken is
7447 returned."
7448   (interactive "p")
7449   (let ((backward (< n 0))
7450         (n (abs n)))
7451     (while (and (> n 0)
7452                 (if backward
7453                     (gnus-summary-find-prev unread)
7454                   (gnus-summary-find-next unread)))
7455       (unless (zerop (setq n (1- n)))
7456         (gnus-summary-show-thread)))
7457     (when (/= 0 n)
7458       (gnus-message 7 "No more%s articles"
7459                     (if unread " unread" "")))
7460     (unless dont-display
7461       (gnus-summary-recenter)
7462       (gnus-summary-position-point))
7463     n))
7464
7465 (defun gnus-summary-next-unread-subject (n)
7466   "Go to next N'th unread summary line."
7467   (interactive "p")
7468   (gnus-summary-next-subject n t))
7469
7470 (defun gnus-summary-prev-subject (n &optional unread)
7471   "Go to previous N'th summary line.
7472 If optional argument UNREAD is non-nil, only unread article is selected."
7473   (interactive "p")
7474   (gnus-summary-next-subject (- n) unread))
7475
7476 (defun gnus-summary-prev-unread-subject (n)
7477   "Go to previous N'th unread summary line."
7478   (interactive "p")
7479   (gnus-summary-next-subject (- n) t))
7480
7481 (defun gnus-summary-goto-subjects (articles)
7482   "Insert the subject header for ARTICLES in the current buffer."
7483   (save-excursion
7484     (dolist (article articles)
7485       (gnus-summary-goto-subject article t)))
7486   (gnus-summary-limit (append articles gnus-newsgroup-limit))
7487   (gnus-summary-position-point))
7488
7489 (defun gnus-summary-goto-subject (article &optional force silent)
7490   "Go to the subject line of ARTICLE.
7491 If FORCE, also allow jumping to articles not currently shown."
7492   (interactive "nArticle number: ")
7493   (unless (numberp article)
7494     (error "Article %s is not a number" article))
7495   (let ((b (point))
7496         (data (gnus-data-find article)))
7497     ;; We read in the article if we have to.
7498     (and (not data)
7499          force
7500          (gnus-summary-insert-subject
7501           article
7502           (if (or (numberp force) (vectorp force)) force)
7503           t)
7504          (setq data (gnus-data-find article)))
7505     (goto-char b)
7506     (if (not data)
7507         (progn
7508           (unless silent
7509             (gnus-message 3 "Can't find article %d" article))
7510           nil)
7511       (let ((pt (gnus-data-pos data)))
7512         (goto-char pt)
7513         (gnus-summary-set-article-display-arrow pt))
7514       (gnus-summary-position-point)
7515       article)))
7516
7517 ;; Walking around summary lines with displaying articles.
7518
7519 (defun gnus-summary-expand-window (&optional arg)
7520   "Make the summary buffer take up the entire Emacs frame.
7521 Given a prefix, will force an `article' buffer configuration."
7522   (interactive "P")
7523   (if arg
7524       (gnus-configure-windows 'article 'force)
7525     (gnus-configure-windows 'summary 'force)))
7526
7527 (defun gnus-summary-display-article (article &optional all-header)
7528   "Display ARTICLE in article buffer."
7529   (unless (and (gnus-buffer-live-p gnus-article-buffer)
7530                (with-current-buffer gnus-article-buffer
7531                  (eq major-mode 'gnus-article-mode)))
7532     (gnus-article-setup-buffer))
7533   (gnus-set-global-variables)
7534   (with-current-buffer gnus-article-buffer
7535     (setq gnus-article-charset gnus-newsgroup-charset)
7536     (setq gnus-article-ignored-charsets gnus-newsgroup-ignored-charsets)
7537     (mm-enable-multibyte))
7538   (if (null article)
7539       nil
7540     (prog1
7541         (if gnus-summary-display-article-function
7542             (funcall gnus-summary-display-article-function article all-header)
7543           (gnus-article-prepare article all-header))
7544       (gnus-run-hooks 'gnus-select-article-hook)
7545       (when (and gnus-current-article
7546                  (not (zerop gnus-current-article)))
7547         (gnus-summary-goto-subject gnus-current-article))
7548       (gnus-summary-recenter)
7549       (when (and gnus-use-trees gnus-show-threads)
7550         (gnus-possibly-generate-tree article)
7551         (gnus-highlight-selected-tree article))
7552       ;; Successfully display article.
7553       (gnus-article-set-window-start
7554        (cdr (assq article gnus-newsgroup-bookmarks))))))
7555
7556 (defun gnus-summary-select-article (&optional all-headers force pseudo article)
7557   "Select the current article.
7558 If ALL-HEADERS is non-nil, show all header fields.  If FORCE is
7559 non-nil, the article will be re-fetched even if it already present in
7560 the article buffer.  If PSEUDO is non-nil, pseudo-articles will also
7561 be displayed."
7562   ;; Make sure we are in the summary buffer to work around bbdb bug.
7563   (unless (eq major-mode 'gnus-summary-mode)
7564     (set-buffer gnus-summary-buffer))
7565   (let ((article (or article (gnus-summary-article-number)))
7566         (all-headers (not (not all-headers))) ;Must be t or nil.
7567         gnus-summary-display-article-function)
7568     (and (not pseudo)
7569          (gnus-summary-article-pseudo-p article)
7570          (error "This is a pseudo-article"))
7571     (with-current-buffer gnus-summary-buffer
7572       (if (or (and gnus-single-article-buffer
7573                    (or (null gnus-current-article)
7574                        (null gnus-article-current)
7575                        (null (get-buffer gnus-article-buffer))
7576                        (not (eq article (cdr gnus-article-current)))
7577                        (not (equal (car gnus-article-current)
7578                                    gnus-newsgroup-name))))
7579               (and (not gnus-single-article-buffer)
7580                    (or (null gnus-current-article)
7581                        (not (eq gnus-current-article article))))
7582               force)
7583           ;; The requested article is different from the current article.
7584           (progn
7585             (gnus-summary-display-article article all-headers)
7586             (when (gnus-buffer-live-p gnus-article-buffer)
7587               (with-current-buffer gnus-article-buffer
7588                 (if (not gnus-article-decoded-p) ;; a local variable
7589                     (mm-disable-multibyte))))
7590             (gnus-article-set-window-start
7591              (cdr (assq article gnus-newsgroup-bookmarks)))
7592             article)
7593         'old))))
7594
7595 (defun gnus-summary-force-verify-and-decrypt ()
7596   "Display buttons for signed/encrypted parts and verify/decrypt them."
7597   (interactive)
7598   (let ((mm-verify-option 'known)
7599         (mm-decrypt-option 'known)
7600         (gnus-article-emulate-mime t)
7601         (gnus-buttonized-mime-types (append (list "multipart/signed"
7602                                                   "multipart/encrypted")
7603                                             gnus-buttonized-mime-types)))
7604     (gnus-summary-select-article nil 'force)))
7605
7606 (defun gnus-summary-set-current-mark (&optional current-mark)
7607   "Obsolete function."
7608   nil)
7609
7610 (defun gnus-summary-next-article (&optional unread subject backward push)
7611   "Select the next article.
7612 If UNREAD, only unread articles are selected.
7613 If SUBJECT, only articles with SUBJECT are selected.
7614 If BACKWARD, the previous article is selected instead of the next."
7615   (interactive "P")
7616   ;; Make sure we are in the summary buffer.
7617   (unless (eq major-mode 'gnus-summary-mode)
7618     (set-buffer gnus-summary-buffer))
7619   (cond
7620    ;; Is there such an article?
7621    ((and (gnus-summary-search-forward unread subject backward)
7622          (or (gnus-summary-display-article (gnus-summary-article-number))
7623              (eq (gnus-summary-article-mark) gnus-canceled-mark)))
7624     (gnus-summary-position-point))
7625    ;; If not, we try the first unread, if that is wanted.
7626    ((and subject
7627          gnus-auto-select-same
7628          (gnus-summary-first-unread-article))
7629     (gnus-summary-position-point)
7630     (gnus-message 6 "Wrapped"))
7631    ;; Try to get next/previous article not displayed in this group.
7632    ((and gnus-auto-extend-newsgroup
7633          (not unread) (not subject))
7634     (gnus-summary-goto-article
7635      (if backward (1- gnus-newsgroup-begin) (1+ gnus-newsgroup-end))
7636      nil (count-lines (point-min) (point))))
7637    ;; Go to next/previous group.
7638    (t
7639     (unless (gnus-ephemeral-group-p gnus-newsgroup-name)
7640       (gnus-summary-jump-to-group gnus-newsgroup-name))
7641     (let ((cmd (if (featurep 'xemacs)
7642                    last-command-char
7643                  last-command-event))
7644           (point
7645            (with-current-buffer gnus-group-buffer
7646              (point)))
7647           (group
7648            (if (eq gnus-keep-same-level 'best)
7649                (gnus-summary-best-group gnus-newsgroup-name)
7650              (gnus-summary-search-group backward gnus-keep-same-level))))
7651       ;; For some reason, the group window gets selected.  We change
7652       ;; it back.
7653       (select-window (get-buffer-window (current-buffer)))
7654       ;; Select next unread newsgroup automagically.
7655       (cond
7656        ((or (not gnus-auto-select-next)
7657             (not cmd))
7658         (gnus-message 7 "No more%s articles" (if unread " unread" "")))
7659        ((or (eq gnus-auto-select-next 'quietly)
7660             (and (eq gnus-auto-select-next 'slightly-quietly)
7661                  push)
7662             (and (eq gnus-auto-select-next 'almost-quietly)
7663                  (gnus-summary-last-article-p)))
7664         ;; Select quietly.
7665         (if (gnus-ephemeral-group-p gnus-newsgroup-name)
7666             (gnus-summary-exit)
7667           (gnus-message 7 "No more%s articles (%s)..."
7668                         (if unread " unread" "")
7669                         (if group (concat "selecting " group)
7670                           "exiting"))
7671           (gnus-summary-next-group nil group backward)))
7672        (t
7673         (when (gnus-key-press-event-p last-input-event)
7674           (gnus-summary-walk-group-buffer
7675            gnus-newsgroup-name cmd unread backward point))))))))
7676
7677 (defun gnus-summary-walk-group-buffer (from-group cmd unread backward start)
7678   (let ((keystrokes '((?\C-n (gnus-group-next-unread-group 1))
7679                       (?\C-p (gnus-group-prev-unread-group 1))))
7680         (cursor-in-echo-area t)
7681         keve key group ended prompt)
7682     (with-current-buffer gnus-group-buffer
7683       (goto-char start)
7684       (setq group
7685             (if (eq gnus-keep-same-level 'best)
7686                 (gnus-summary-best-group gnus-newsgroup-name)
7687               (gnus-summary-search-group backward gnus-keep-same-level))))
7688     (while (not ended)
7689       (setq prompt
7690             (format
7691              "No more%s articles%s " (if unread " unread" "")
7692              (if (and group
7693                       (not (gnus-ephemeral-group-p gnus-newsgroup-name)))
7694                  (format " (Type %s for %s [%s])"
7695                          (single-key-description cmd)
7696                          (gnus-group-decoded-name group)
7697                          (gnus-group-unread group))
7698                (format " (Type %s to exit %s)"
7699                        (single-key-description cmd)
7700                        (gnus-group-decoded-name gnus-newsgroup-name)))))
7701       ;; Confirm auto selection.
7702       (setq key (car (setq keve (gnus-read-event-char prompt)))
7703             ended t)
7704       (cond
7705        ((assq key keystrokes)
7706         (let ((obuf (current-buffer)))
7707           (switch-to-buffer gnus-group-buffer)
7708           (when group
7709             (gnus-group-jump-to-group group))
7710           (eval (cadr (assq key keystrokes)))
7711           (setq group (gnus-group-group-name))
7712           (switch-to-buffer obuf))
7713         (setq ended nil))
7714        ((equal key cmd)
7715         (if (or (not group)
7716                 (gnus-ephemeral-group-p gnus-newsgroup-name))
7717             (gnus-summary-exit)
7718           (gnus-summary-next-group nil group backward)))
7719        (t
7720         (push (cdr keve) unread-command-events))))))
7721
7722 (defun gnus-summary-next-unread-article ()
7723   "Select unread article after current one."
7724   (interactive)
7725   (gnus-summary-next-article
7726    (or (not (eq gnus-summary-goto-unread 'never))
7727        (gnus-summary-last-article-p (gnus-summary-article-number)))
7728    (and gnus-auto-select-same
7729         (gnus-summary-article-subject))))
7730
7731 (defun gnus-summary-prev-article (&optional unread subject)
7732   "Select the article before the current one.
7733 If UNREAD is non-nil, only unread articles are selected."
7734   (interactive "P")
7735   (gnus-summary-next-article unread subject t))
7736
7737 (defun gnus-summary-prev-unread-article ()
7738   "Select unread article before current one."
7739   (interactive)
7740   (gnus-summary-prev-article
7741    (or (not (eq gnus-summary-goto-unread 'never))
7742        (gnus-summary-first-article-p (gnus-summary-article-number)))
7743    (and gnus-auto-select-same
7744         (gnus-summary-article-subject))))
7745
7746 (defun gnus-summary-next-page (&optional lines circular stop)
7747   "Show next page of the selected article.
7748 If at the end of the current article, select the next article.
7749 LINES says how many lines should be scrolled up.
7750
7751 If CIRCULAR is non-nil, go to the start of the article instead of
7752 selecting the next article when reaching the end of the current
7753 article.
7754
7755 If STOP is non-nil, just stop when reaching the end of the message.
7756
7757 Also see the variable `gnus-article-skip-boring'."
7758   (interactive "P")
7759   (setq gnus-summary-buffer (current-buffer))
7760   (gnus-set-global-variables)
7761   (let ((article (gnus-summary-article-number))
7762         (article-window (get-buffer-window gnus-article-buffer t))
7763         endp)
7764     ;; If the buffer is empty, we have no article.
7765     (unless article
7766       (error "No article to select"))
7767     (gnus-configure-windows 'article)
7768     (if (eq (cdr (assq article gnus-newsgroup-reads)) gnus-canceled-mark)
7769         (if (and (eq gnus-summary-goto-unread 'never)
7770                  (not (gnus-summary-last-article-p article)))
7771             (gnus-summary-next-article)
7772           (gnus-summary-next-unread-article))
7773       (if (or (null gnus-current-article)
7774               (null gnus-article-current)
7775               (/= article (cdr gnus-article-current))
7776               (not (equal (car gnus-article-current) gnus-newsgroup-name)))
7777           ;; Selected subject is different from current article's.
7778           (gnus-summary-display-article article)
7779         (when article-window
7780           (gnus-eval-in-buffer-window gnus-article-buffer
7781             (setq endp (or (gnus-article-next-page lines)
7782                            (gnus-article-only-boring-p))))
7783           (when endp
7784             (cond ((or stop gnus-summary-stop-at-end-of-message)
7785                    (gnus-message 3 "End of message"))
7786                   (circular
7787                    (gnus-summary-beginning-of-article))
7788                   (lines
7789                    (gnus-message 3 "End of message"))
7790                   ((null lines)
7791                    (if (and (eq gnus-summary-goto-unread 'never)
7792                             (not (gnus-summary-last-article-p article)))
7793                        (gnus-summary-next-article)
7794                      (gnus-summary-next-unread-article))))))))
7795     (gnus-summary-recenter)
7796     (gnus-summary-position-point)))
7797
7798 (defun gnus-summary-prev-page (&optional lines move)
7799   "Show previous page of selected article.
7800 Argument LINES specifies lines to be scrolled down.
7801 If MOVE, move to the previous unread article if point is at
7802 the beginning of the buffer."
7803   (interactive "P")
7804   (let ((article (gnus-summary-article-number))
7805         (article-window (get-buffer-window gnus-article-buffer t))
7806         endp)
7807     (gnus-configure-windows 'article)
7808     (if (or (null gnus-current-article)
7809             (null gnus-article-current)
7810             (/= article (cdr gnus-article-current))
7811             (not (equal (car gnus-article-current) gnus-newsgroup-name)))
7812         ;; Selected subject is different from current article's.
7813         (gnus-summary-display-article article)
7814       (gnus-summary-recenter)
7815       (when article-window
7816         (gnus-eval-in-buffer-window gnus-article-buffer
7817           (setq endp (gnus-article-prev-page lines)))
7818         (when (and move endp)
7819           (cond (lines
7820                  (gnus-message 3 "Beginning of message"))
7821                 ((null lines)
7822                  (if (and (eq gnus-summary-goto-unread 'never)
7823                           (not (gnus-summary-first-article-p article)))
7824                      (gnus-summary-prev-article)
7825                    (gnus-summary-prev-unread-article))))))))
7826   (gnus-summary-position-point))
7827
7828 (defun gnus-summary-prev-page-or-article (&optional lines)
7829   "Show previous page of selected article.
7830 Argument LINES specifies lines to be scrolled down.
7831 If at the beginning of the article, go to the next article."
7832   (interactive "P")
7833   (gnus-summary-prev-page lines t))
7834
7835 (defun gnus-summary-scroll-up (lines)
7836   "Scroll up (or down) one line current article.
7837 Argument LINES specifies lines to be scrolled up (or down if negative)."
7838   (interactive "p")
7839   (gnus-configure-windows 'article)
7840   (gnus-summary-show-thread)
7841   (when (eq (gnus-summary-select-article nil nil 'pseudo) 'old)
7842     (gnus-eval-in-buffer-window gnus-article-buffer
7843       (cond ((> lines 0)
7844              (when (gnus-article-next-page lines)
7845                (gnus-message 3 "End of message")))
7846             ((< lines 0)
7847              (gnus-article-prev-page (- lines))))))
7848   (gnus-summary-recenter)
7849   (gnus-summary-position-point))
7850
7851 (defun gnus-summary-scroll-down (lines)
7852   "Scroll down (or up) one line current article.
7853 Argument LINES specifies lines to be scrolled down (or up if negative)."
7854   (interactive "p")
7855   (gnus-summary-scroll-up (- lines)))
7856
7857 (defun gnus-summary-next-same-subject ()
7858   "Select next article which has the same subject as current one."
7859   (interactive)
7860   (gnus-summary-next-article nil (gnus-summary-article-subject)))
7861
7862 (defun gnus-summary-prev-same-subject ()
7863   "Select previous article which has the same subject as current one."
7864   (interactive)
7865   (gnus-summary-prev-article nil (gnus-summary-article-subject)))
7866
7867 (defun gnus-summary-next-unread-same-subject ()
7868   "Select next unread article which has the same subject as current one."
7869   (interactive)
7870   (gnus-summary-next-article t (gnus-summary-article-subject)))
7871
7872 (defun gnus-summary-prev-unread-same-subject ()
7873   "Select previous unread article which has the same subject as current one."
7874   (interactive)
7875   (gnus-summary-prev-article t (gnus-summary-article-subject)))
7876
7877 (defun gnus-summary-first-unread-article ()
7878   "Select the first unread article.
7879 Return nil if there are no unread articles."
7880   (interactive)
7881   (prog1
7882       (when (gnus-summary-first-subject t)
7883         (gnus-summary-show-thread)
7884         (gnus-summary-first-subject t)
7885         (gnus-summary-display-article (gnus-summary-article-number)))
7886     (gnus-summary-position-point)))
7887
7888 (defun gnus-summary-first-unread-subject ()
7889   "Place the point on the subject line of the first unread article.
7890 Return nil if there are no unread articles."
7891   (interactive)
7892   (prog1
7893       (when (gnus-summary-first-subject t)
7894         (gnus-summary-show-thread)
7895         (gnus-summary-first-subject t))
7896     (gnus-summary-position-point)))
7897
7898 (defun gnus-summary-first-unseen-subject ()
7899   "Place the point on the subject line of the first unseen article.
7900 Return nil if there are no unseen articles."
7901   (interactive)
7902   (prog1
7903       (when (gnus-summary-first-subject nil nil t)
7904         (gnus-summary-show-thread)
7905         (gnus-summary-first-subject nil nil t))
7906     (gnus-summary-position-point)))
7907
7908 (defun gnus-summary-first-unseen-or-unread-subject ()
7909   "Place the point on the subject line of the first unseen article or,
7910 if all article have been seen, on the subject line of the first unread
7911 article."
7912   (interactive)
7913   (prog1
7914       (unless (when (gnus-summary-first-subject nil nil t)
7915                 (gnus-summary-show-thread)
7916                 (gnus-summary-first-subject nil nil t))
7917         (when (gnus-summary-first-subject t)
7918           (gnus-summary-show-thread)
7919           (gnus-summary-first-subject t)))
7920     (gnus-summary-position-point)))
7921
7922 (defun gnus-summary-first-article ()
7923   "Select the first article.
7924 Return nil if there are no articles."
7925   (interactive)
7926   (prog1
7927       (when (gnus-summary-first-subject)
7928         (gnus-summary-show-thread)
7929         (gnus-summary-first-subject)
7930         (gnus-summary-display-article (gnus-summary-article-number)))
7931     (gnus-summary-position-point)))
7932
7933 (defun gnus-summary-best-unread-article (&optional arg)
7934   "Select the unread article with the highest score.
7935 If given a prefix argument, select the next unread article that has a
7936 score higher than the default score."
7937   (interactive "P")
7938   (let ((article (if arg
7939                      (gnus-summary-better-unread-subject)
7940                    (gnus-summary-best-unread-subject))))
7941     (if article
7942         (gnus-summary-goto-article article)
7943       (error "No unread articles"))))
7944
7945 (defun gnus-summary-best-unread-subject ()
7946   "Select the unread subject with the highest score."
7947   (interactive)
7948   (let ((best -1000000)
7949         (data gnus-newsgroup-data)
7950         article score)
7951     (while data
7952       (and (gnus-data-unread-p (car data))
7953            (> (setq score
7954                     (gnus-summary-article-score (gnus-data-number (car data))))
7955               best)
7956            (setq best score
7957                  article (gnus-data-number (car data))))
7958       (setq data (cdr data)))
7959     (when article
7960       (gnus-summary-goto-subject article))
7961     (gnus-summary-position-point)
7962     article))
7963
7964 (defun gnus-summary-better-unread-subject ()
7965   "Select the first unread subject that has a score over the default score."
7966   (interactive)
7967   (let ((data gnus-newsgroup-data)
7968         article score)
7969     (while (and (setq article (gnus-data-number (car data)))
7970                 (or (gnus-data-read-p (car data))
7971                     (not (> (gnus-summary-article-score article)
7972                             gnus-summary-default-score))))
7973       (setq data (cdr data)))
7974     (when article
7975       (gnus-summary-goto-subject article))
7976     (gnus-summary-position-point)
7977     article))
7978
7979 (defun gnus-summary-last-subject ()
7980   "Go to the last displayed subject line in the group."
7981   (let ((article (gnus-data-number (car (gnus-data-list t)))))
7982     (when article
7983       (gnus-summary-goto-subject article))))
7984
7985 (defun gnus-summary-goto-article (article &optional all-headers force)
7986   "Fetch ARTICLE (article number or Message-ID) and display it if it exists.
7987 If ALL-HEADERS is non-nil, no header lines are hidden.
7988 If FORCE, go to the article even if it isn't displayed.  If FORCE
7989 is a number, it is the line the article is to be displayed on."
7990   (interactive
7991    (list
7992     (completing-read
7993      "Article number or Message-ID: "
7994      (mapcar (lambda (number) (list (int-to-string number)))
7995              gnus-newsgroup-limit))
7996     current-prefix-arg
7997     t))
7998   (prog1
7999       (if (and (stringp article)
8000                (string-match "@\\|%40" article))
8001           (gnus-summary-refer-article article)
8002         (when (stringp article)
8003           (setq article (string-to-number article)))
8004         (if (gnus-summary-goto-subject article force)
8005             (gnus-summary-display-article article all-headers)
8006           (gnus-message 4 "Couldn't go to article %s" article) nil))
8007     (gnus-summary-position-point)))
8008
8009 (defun gnus-summary-goto-last-article ()
8010   "Go to the previously read article."
8011   (interactive)
8012   (prog1
8013       (when gnus-last-article
8014         (gnus-summary-goto-article gnus-last-article nil t))
8015     (gnus-summary-position-point)))
8016
8017 (defun gnus-summary-pop-article (number)
8018   "Pop one article off the history and go to the previous.
8019 NUMBER articles will be popped off."
8020   (interactive "p")
8021   (let (to)
8022     (setq gnus-newsgroup-history
8023           (cdr (setq to (nthcdr number gnus-newsgroup-history))))
8024     (if to
8025         (gnus-summary-goto-article (car to) nil t)
8026       (error "Article history empty")))
8027   (gnus-summary-position-point))
8028
8029 ;; Summary commands and functions for limiting the summary buffer.
8030
8031 (defun gnus-summary-limit-to-articles (n)
8032   "Limit the summary buffer to the next N articles.
8033 If not given a prefix, use the process marked articles instead."
8034   (interactive "P")
8035   (prog1
8036       (let ((articles (gnus-summary-work-articles n)))
8037         (setq gnus-newsgroup-processable nil)
8038         (gnus-summary-limit articles))
8039     (gnus-summary-position-point)))
8040
8041 (defun gnus-summary-pop-limit (&optional total)
8042   "Restore the previous limit.
8043 If given a prefix, remove all limits."
8044   (interactive "P")
8045   (when total
8046     (setq gnus-newsgroup-limits
8047           (list (mapcar (lambda (h) (mail-header-number h))
8048                         gnus-newsgroup-headers))))
8049   (unless gnus-newsgroup-limits
8050     (error "No limit to pop"))
8051   (prog1
8052       (gnus-summary-limit nil 'pop)
8053     (gnus-summary-position-point)))
8054
8055 (defun gnus-summary-limit-to-subject (subject &optional header not-matching)
8056   "Limit the summary buffer to articles that have subjects that match a regexp.
8057 If NOT-MATCHING, excluding articles that have subjects that match a regexp."
8058   (interactive
8059    (list (read-string (if current-prefix-arg
8060                           "Exclude subject (regexp): "
8061                         "Limit to subject (regexp): "))
8062          nil current-prefix-arg))
8063   (unless header
8064     (setq header "subject"))
8065   (when (not (equal "" subject))
8066     (prog1
8067         (let ((articles (gnus-summary-find-matching
8068                          (or header "subject") subject 'all nil nil
8069                          not-matching)))
8070           (unless articles
8071             (error "Found no matches for \"%s\"" subject))
8072           (gnus-summary-limit articles))
8073       (gnus-summary-position-point))))
8074
8075 (defun gnus-summary-limit-to-author (from &optional not-matching)
8076   "Limit the summary buffer to articles that have authors that match a regexp.
8077 If NOT-MATCHING, excluding articles that have authors that match a regexp."
8078   (interactive
8079    (list (read-string (if current-prefix-arg
8080                           "Exclude author (regexp): "
8081                         "Limit to author (regexp): "))
8082          current-prefix-arg))
8083   (gnus-summary-limit-to-subject from "from" not-matching))
8084
8085 (defun gnus-summary-limit-to-recipient (recipient &optional not-matching)
8086   "Limit the summary buffer to articles with the given RECIPIENT.
8087
8088 If NOT-MATCHING, exclude RECIPIENT.
8089
8090 To and Cc headers are checked.  You need to include them in
8091 `nnmail-extra-headers'."
8092   ;; Unlike `rmail-summary-by-recipients', doesn't include From.
8093   (interactive
8094    (list (read-string (format "%s recipient (regexp): "
8095                               (if current-prefix-arg "Exclude" "Limit to")))
8096          current-prefix-arg))
8097   (when (not (equal "" recipient))
8098     (prog1 (let* ((to
8099                    (if (memq 'To nnmail-extra-headers)
8100                        (gnus-summary-find-matching
8101                         (cons 'extra 'To) recipient 'all nil nil
8102                         not-matching)
8103                      (gnus-message
8104                       1 "`To' isn't present in `nnmail-extra-headers'")
8105                      (sit-for 1)
8106                      nil))
8107                   (cc
8108                    (if (memq 'Cc nnmail-extra-headers)
8109                        (gnus-summary-find-matching
8110                         (cons 'extra 'Cc) recipient 'all nil nil
8111                         not-matching)
8112                      (gnus-message
8113                       1 "`Cc' isn't present in `nnmail-extra-headers'")
8114                      (sit-for 1)
8115                      nil))
8116                   (articles
8117                    (if not-matching
8118                        ;; We need the numbers that are in both lists:
8119                        (mapcar (lambda (a)
8120                                  (and (memq a to) a))
8121                                cc)
8122                      (nconc to cc))))
8123              (unless articles
8124                (error "Found no matches for \"%s\"" recipient))
8125              (gnus-summary-limit articles))
8126       (gnus-summary-position-point))))
8127
8128 (defun gnus-summary-limit-to-address (address &optional not-matching)
8129   "Limit the summary buffer to articles with the given ADDRESS.
8130
8131 If NOT-MATCHING, exclude ADDRESS.
8132
8133 To, Cc and From headers are checked.  You need to include `To' and `Cc'
8134 in `nnmail-extra-headers'."
8135   (interactive
8136    (list (read-string (format "%s address (regexp): "
8137                               (if current-prefix-arg "Exclude" "Limit to")))
8138          current-prefix-arg))
8139   (when (not (equal "" address))
8140     (prog1 (let* ((to
8141                    (if (memq 'To nnmail-extra-headers)
8142                        (gnus-summary-find-matching
8143                         (cons 'extra 'To) address 'all nil nil
8144                         not-matching)
8145                      (gnus-message
8146                       1 "`To' isn't present in `nnmail-extra-headers'")
8147                      (sit-for 1)
8148                      t))
8149                   (cc
8150                    (if (memq 'Cc nnmail-extra-headers)
8151                        (gnus-summary-find-matching
8152                         (cons 'extra 'Cc) address 'all nil nil
8153                         not-matching)
8154                      (gnus-message
8155                       1 "`Cc' isn't present in `nnmail-extra-headers'")
8156                      (sit-for 1)
8157                      t))
8158                   (from
8159                    (gnus-summary-find-matching "from" address
8160                                                'all nil nil not-matching))
8161                   (articles
8162                    (if not-matching
8163                        ;; We need the numbers that are in all lists:
8164                        (if (eq cc t)
8165                            (if (eq to t)
8166                                from
8167                              (mapcar (lambda (a) (car (memq a from))) to))
8168                          (if (eq to t)
8169                              (mapcar (lambda (a) (car (memq a from))) cc)
8170                            (mapcar (lambda (a) (car (memq a from)))
8171                                    (mapcar (lambda (a) (car (memq a to)))
8172                                            cc))))
8173                      (nconc (if (eq to t) nil to)
8174                             (if (eq cc t) nil cc)
8175                             from))))
8176              (unless articles
8177                (error "Found no matches for \"%s\"" address))
8178              (gnus-summary-limit articles))
8179       (gnus-summary-position-point))))
8180
8181 (defun gnus-summary-limit-strange-charsets-predicate (header)
8182   (when (fboundp 'char-charset)
8183     (let ((string (concat (mail-header-subject header)
8184                           (mail-header-from header)))
8185           charset found)
8186       (dotimes (i (1- (length string)))
8187         (setq charset (format "%s" (char-charset (aref string (1+ i)))))
8188         (when (string-match "unicode\\|big\\|japanese" charset)
8189           (setq found t)))
8190       found)))
8191
8192 (defun gnus-summary-limit-to-predicate (predicate)
8193   "Limit to articles where PREDICATE returns non-nil.
8194 PREDICATE will be called with the header structures of the
8195 articles."
8196   (let ((articles nil)
8197         (case-fold-search t))
8198     (dolist (header gnus-newsgroup-headers)
8199       (when (funcall predicate header)
8200         (push (mail-header-number header) articles)))
8201     (gnus-summary-limit (nreverse articles))))
8202
8203 (defun gnus-summary-limit-to-age (age &optional younger-p)
8204   "Limit the summary buffer to articles that are older than (or equal) AGE days.
8205 If YOUNGER-P (the prefix) is non-nil, limit the summary buffer to
8206 articles that are younger than AGE days."
8207   (interactive
8208    (let ((younger current-prefix-arg)
8209          (days-got nil)
8210          days)
8211      (while (not days-got)
8212        (setq days (if younger
8213                       (read-string "Limit to articles younger than (in days, older when negative): ")
8214                     (read-string
8215                      "Limit to articles older than (in days, younger when negative): ")))
8216        (when (> (length days) 0)
8217          (setq days (read days)))
8218        (if (numberp days)
8219            (progn
8220              (setq days-got t)
8221              (when (< days 0)
8222                (setq younger (not younger))
8223                (setq days (* days -1))))
8224          (message "Please enter a number.")
8225          (sleep-for 1)))
8226      (list days younger)))
8227   (prog1
8228       (let ((data gnus-newsgroup-data)
8229             (cutoff (days-to-time age))
8230             articles d date is-younger)
8231         (while (setq d (pop data))
8232           (when (and (vectorp (gnus-data-header d))
8233                      (setq date (mail-header-date (gnus-data-header d))))
8234             (setq is-younger (time-less-p
8235                               (time-since (gnus-date-get-time date))
8236                               cutoff))
8237             (when (if younger-p
8238                       is-younger
8239                     (not is-younger))
8240               (push (gnus-data-number d) articles))))
8241         (gnus-summary-limit (nreverse articles)))
8242     (gnus-summary-position-point)))
8243
8244 (defun gnus-summary-limit-to-extra (header regexp &optional not-matching)
8245   "Limit the summary buffer to articles that match an 'extra' header."
8246   (interactive
8247    (let ((header
8248           (intern
8249            (gnus-completing-read-with-default
8250             (symbol-name (car gnus-extra-headers))
8251             (if current-prefix-arg
8252                 "Exclude extra header"
8253               "Limit extra header")
8254             (mapcar (lambda (x)
8255                       (cons (symbol-name x) x))
8256                     gnus-extra-headers)
8257             nil
8258             t))))
8259      (list header
8260            (read-string (format "%s header %s (regexp): "
8261                                 (if current-prefix-arg "Exclude" "Limit to")
8262                                 header))
8263            current-prefix-arg)))
8264   (when (not (equal "" regexp))
8265     (prog1
8266         (let ((articles (gnus-summary-find-matching
8267                          (cons 'extra header) regexp 'all nil nil
8268                          not-matching)))
8269           (unless articles
8270             (error "Found no matches for \"%s\"" regexp))
8271           (gnus-summary-limit articles))
8272       (gnus-summary-position-point))))
8273
8274 (defun gnus-summary-limit-to-display-predicate ()
8275   "Limit the summary buffer to the predicated in the `display' group parameter."
8276   (interactive)
8277   (unless gnus-newsgroup-display
8278     (error "There is no `display' group parameter"))
8279   (let (articles)
8280     (dolist (number gnus-newsgroup-articles)
8281       (when (funcall gnus-newsgroup-display)
8282         (push number articles)))
8283     (gnus-summary-limit articles))
8284   (gnus-summary-position-point))
8285
8286 (defalias 'gnus-summary-delete-marked-as-read 'gnus-summary-limit-to-unread)
8287 (make-obsolete
8288  'gnus-summary-delete-marked-as-read 'gnus-summary-limit-to-unread "Emacs 20.4")
8289
8290 (defun gnus-summary-limit-to-unread (&optional all)
8291   "Limit the summary buffer to articles that are not marked as read.
8292 If ALL is non-nil, limit strictly to unread articles."
8293   (interactive "P")
8294   (if all
8295       (gnus-summary-limit-to-marks (char-to-string gnus-unread-mark))
8296     (gnus-summary-limit-to-marks
8297      ;; Concat all the marks that say that an article is read and have
8298      ;; those removed.
8299      (list gnus-del-mark gnus-read-mark gnus-ancient-mark
8300            gnus-killed-mark gnus-spam-mark gnus-kill-file-mark
8301            gnus-low-score-mark gnus-expirable-mark
8302            gnus-canceled-mark gnus-catchup-mark gnus-sparse-mark
8303            gnus-duplicate-mark)
8304      'reverse)))
8305
8306 (defun gnus-summary-limit-to-headers (match &optional reverse)
8307   "Limit the summary buffer to articles that have headers that match MATCH.
8308 If REVERSE (the prefix), limit to articles that don't match."
8309   (interactive "sMatch headers (regexp): \nP")
8310   (gnus-summary-limit-to-bodies match reverse t))
8311
8312 (defun gnus-summary-limit-to-bodies (match &optional reverse headersp)
8313   "Limit the summary buffer to articles that have bodies that match MATCH.
8314 If REVERSE (the prefix), limit to articles that don't match."
8315   (interactive "sMatch body (regexp): \nP")
8316   (let ((articles nil)
8317         (gnus-select-article-hook nil)  ;Disable hook.
8318         (gnus-article-prepare-hook nil)
8319         (gnus-use-article-prefetch nil)
8320         (gnus-keep-backlog nil)
8321         (gnus-break-pages nil)
8322         (gnus-summary-display-arrow nil)
8323         (gnus-updated-mode-lines nil)
8324         (gnus-auto-center-summary nil)
8325         (gnus-display-mime-function nil))
8326     (dolist (data gnus-newsgroup-data)
8327       (let (gnus-mark-article-hook)
8328         (gnus-summary-select-article t t nil (gnus-data-number data)))
8329       (with-current-buffer gnus-article-buffer
8330         (article-goto-body)
8331         (let* ((case-fold-search t)
8332                (found (if headersp
8333                           (re-search-backward match nil t)
8334                         (re-search-forward match nil t))))
8335           (when (or (and found
8336                          (not reverse))
8337                     (and (not found)
8338                          reverse))
8339             (push (gnus-data-number data) articles)))))
8340     (if (not articles)
8341         (message "No messages matched")
8342       (gnus-summary-limit articles)))
8343   (gnus-summary-position-point))
8344
8345 (defun gnus-summary-limit-to-singletons (&optional threadsp)
8346   "Limit the summary buffer to articles that aren't part on any thread.
8347 If THREADSP (the prefix), limit to articles that are in threads."
8348   (interactive "P")
8349   (let ((articles nil)
8350         thread-articles
8351         threads)
8352     (dolist (thread gnus-newsgroup-threads)
8353       (if (stringp (car thread))
8354           (dolist (thread (cdr thread))
8355             (push thread threads))
8356         (push thread threads)))
8357     (dolist (thread threads)
8358       (setq thread-articles (gnus-articles-in-thread thread))
8359       (when (or (and threadsp
8360                      (> (length thread-articles) 1))
8361                 (and (not threadsp)
8362                      (= (length thread-articles) 1)))
8363         (setq articles (nconc thread-articles articles))))
8364     (if (not articles)
8365         (message "No messages matched")
8366       (gnus-summary-limit articles))
8367     (gnus-summary-position-point)))
8368
8369 (defun gnus-summary-limit-to-replied (&optional unreplied)
8370   "Limit the summary buffer to replied articles.
8371 If UNREPLIED (the prefix), limit to unreplied articles."
8372   (interactive "P")
8373   (if unreplied
8374       (gnus-summary-limit
8375        (gnus-set-difference gnus-newsgroup-articles
8376         gnus-newsgroup-replied))
8377     (gnus-summary-limit gnus-newsgroup-replied))
8378   (gnus-summary-position-point))
8379
8380 (defalias 'gnus-summary-delete-marked-with 'gnus-summary-limit-exclude-marks)
8381 (make-obsolete 'gnus-summary-delete-marked-with
8382                'gnus-summary-limit-exclude-marks "Emacs 20.4")
8383
8384 (defun gnus-summary-limit-exclude-marks (marks &optional reverse)
8385   "Exclude articles that are marked with MARKS (e.g. \"DK\").
8386 If REVERSE, limit the summary buffer to articles that are marked
8387 with MARKS.  MARKS can either be a string of marks or a list of marks.
8388 Returns how many articles were removed."
8389   (interactive "sMarks: ")
8390   (gnus-summary-limit-to-marks marks t))
8391
8392 (defun gnus-summary-limit-to-marks (marks &optional reverse)
8393   "Limit the summary buffer to articles that are marked with MARKS (e.g. \"DK\").
8394 If REVERSE (the prefix), limit the summary buffer to articles that are
8395 not marked with MARKS.  MARKS can either be a string of marks or a
8396 list of marks.
8397 Returns how many articles were removed."
8398   (interactive "sMarks: \nP")
8399   (prog1
8400       (let ((data gnus-newsgroup-data)
8401             (marks (if (listp marks) marks
8402                      (append marks nil))) ; Transform to list.
8403             articles)
8404         (while data
8405           (when (if reverse (not (memq (gnus-data-mark (car data)) marks))
8406                   (memq (gnus-data-mark (car data)) marks))
8407             (push (gnus-data-number (car data)) articles))
8408           (setq data (cdr data)))
8409         (gnus-summary-limit articles))
8410     (gnus-summary-position-point)))
8411
8412 (defun gnus-summary-limit-to-score (score)
8413   "Limit to articles with score at or above SCORE."
8414   (interactive "NLimit to articles with score of at least: ")
8415   (let ((data gnus-newsgroup-data)
8416         articles)
8417     (while data
8418       (when (>= (gnus-summary-article-score (gnus-data-number (car data)))
8419                 score)
8420         (push (gnus-data-number (car data)) articles))
8421       (setq data (cdr data)))
8422     (prog1
8423         (gnus-summary-limit articles)
8424       (gnus-summary-position-point))))
8425
8426 (defun gnus-summary-limit-to-unseen ()
8427   "Limit to unseen articles."
8428   (interactive)
8429   (prog1
8430       (gnus-summary-limit gnus-newsgroup-unseen)
8431     (gnus-summary-position-point)))
8432
8433 (defun gnus-summary-limit-include-thread (id)
8434   "Display all the hidden articles that is in the thread with ID in it.
8435 When called interactively, ID is the Message-ID of the current
8436 article."
8437   (interactive (list (mail-header-id (gnus-summary-article-header))))
8438   (let ((articles (gnus-articles-in-thread
8439                    (gnus-id-to-thread (gnus-root-id id)))))
8440     (prog1
8441         (gnus-summary-limit (nconc articles gnus-newsgroup-limit))
8442       (gnus-summary-limit-include-matching-articles
8443        "subject"
8444        (regexp-quote (gnus-simplify-subject-re
8445                       (mail-header-subject (gnus-id-to-header id)))))
8446       (gnus-summary-position-point))))
8447
8448 (defun gnus-summary-limit-include-matching-articles (header regexp)
8449   "Display all the hidden articles that have HEADERs that match REGEXP."
8450   (interactive (list (read-string "Match on header: ")
8451                      (read-string "Regexp: ")))
8452   (let ((articles (gnus-find-matching-articles header regexp)))
8453     (prog1
8454         (gnus-summary-limit (nconc articles gnus-newsgroup-limit))
8455       (gnus-summary-position-point))))
8456
8457 (defun gnus-summary-insert-dormant-articles ()
8458   "Insert all the dormant articles for this group into the current buffer."
8459   (interactive)
8460   (let ((gnus-verbose (max 6 gnus-verbose)))
8461     (if (not gnus-newsgroup-dormant)
8462         (gnus-message 3 "No dormant articles for this group")
8463       (gnus-summary-goto-subjects gnus-newsgroup-dormant))))
8464
8465 (defun gnus-summary-insert-ticked-articles ()
8466   "Insert ticked articles for this group into the current buffer."
8467   (interactive)
8468   (let ((gnus-verbose (max 6 gnus-verbose)))
8469     (if (not gnus-newsgroup-marked)
8470         (gnus-message 3 "No ticked articles for this group")
8471       (gnus-summary-goto-subjects gnus-newsgroup-marked))))
8472
8473 (defun gnus-summary-limit-include-dormant ()
8474   "Display all the hidden articles that are marked as dormant.
8475 Note that this command only works on a subset of the articles currently
8476 fetched for this group."
8477   (interactive)
8478   (unless gnus-newsgroup-dormant
8479     (error "There are no dormant articles in this group"))
8480   (prog1
8481       (gnus-summary-limit (append gnus-newsgroup-dormant gnus-newsgroup-limit))
8482     (gnus-summary-position-point)))
8483
8484 (defun gnus-summary-limit-exclude-dormant ()
8485   "Hide all dormant articles."
8486   (interactive)
8487   (prog1
8488       (gnus-summary-limit-to-marks (list gnus-dormant-mark) 'reverse)
8489     (gnus-summary-position-point)))
8490
8491 (defun gnus-summary-limit-exclude-childless-dormant ()
8492   "Hide all dormant articles that have no children."
8493   (interactive)
8494   (let ((data (gnus-data-list t))
8495         articles d children)
8496     ;; Find all articles that are either not dormant or have
8497     ;; children.
8498     (while (setq d (pop data))
8499       (when (or (not (= (gnus-data-mark d) gnus-dormant-mark))
8500                 (and (setq children
8501                            (gnus-article-children (gnus-data-number d)))
8502                      (let (found)
8503                        (while children
8504                          (when (memq (car children) articles)
8505                            (setq children nil
8506                                  found t))
8507                          (pop children))
8508                        found)))
8509         (push (gnus-data-number d) articles)))
8510     ;; Do the limiting.
8511     (prog1
8512         (gnus-summary-limit articles)
8513       (gnus-summary-position-point))))
8514
8515 (defun gnus-summary-limit-mark-excluded-as-read (&optional all)
8516   "Mark all unread excluded articles as read.
8517 If ALL, mark even excluded ticked and dormants as read."
8518   (interactive "P")
8519   (setq gnus-newsgroup-limit (sort gnus-newsgroup-limit '<))
8520   (let ((articles (gnus-sorted-ndifference
8521                    (sort
8522                     (mapcar (lambda (h) (mail-header-number h))
8523                             gnus-newsgroup-headers)
8524                     '<)
8525                    gnus-newsgroup-limit))
8526         article)
8527     (setq gnus-newsgroup-unreads
8528           (gnus-sorted-intersection gnus-newsgroup-unreads
8529                                     gnus-newsgroup-limit))
8530     (if all
8531         (setq gnus-newsgroup-dormant nil
8532               gnus-newsgroup-marked nil
8533               gnus-newsgroup-reads
8534               (nconc
8535                (mapcar (lambda (n) (cons n gnus-catchup-mark)) articles)
8536                gnus-newsgroup-reads))
8537       (while (setq article (pop articles))
8538         (unless (or (memq article gnus-newsgroup-dormant)
8539                     (memq article gnus-newsgroup-marked))
8540           (push (cons article gnus-catchup-mark) gnus-newsgroup-reads))))))
8541
8542 (defun gnus-summary-limit (articles &optional pop)
8543   (if pop
8544       ;; We pop the previous limit off the stack and use that.
8545       (setq articles (car gnus-newsgroup-limits)
8546             gnus-newsgroup-limits (cdr gnus-newsgroup-limits))
8547     ;; We use the new limit, so we push the old limit on the stack.
8548     (push gnus-newsgroup-limit gnus-newsgroup-limits))
8549   ;; Set the limit.
8550   (setq gnus-newsgroup-limit articles)
8551   (let ((total (length gnus-newsgroup-data))
8552         (data (gnus-data-find-list (gnus-summary-article-number)))
8553         (gnus-summary-mark-below nil)   ; Inhibit this.
8554         found)
8555     ;; This will do all the work of generating the new summary buffer
8556     ;; according to the new limit.
8557     (gnus-summary-prepare)
8558     ;; Hide any threads, possibly.
8559     (gnus-summary-maybe-hide-threads)
8560     ;; Try to return to the article you were at, or one in the
8561     ;; neighborhood.
8562     (when data
8563       ;; We try to find some article after the current one.
8564       (while data
8565         (when (gnus-summary-goto-subject (gnus-data-number (car data)) nil t)
8566           (setq data nil
8567                 found t))
8568         (setq data (cdr data))))
8569     (unless found
8570       ;; If there is no data, that means that we were after the last
8571       ;; article.  The same goes when we can't find any articles
8572       ;; after the current one.
8573       (goto-char (point-max))
8574       (gnus-summary-find-prev))
8575     (gnus-set-mode-line 'summary)
8576     ;; We return how many articles were removed from the summary
8577     ;; buffer as a result of the new limit.
8578     (- total (length gnus-newsgroup-data))))
8579
8580 (defsubst gnus-invisible-cut-children (threads)
8581   (let ((num 0))
8582     (while threads
8583       (when (memq (mail-header-number (caar threads)) gnus-newsgroup-limit)
8584         (incf num))
8585       (pop threads))
8586     (< num 2)))
8587
8588 (defsubst gnus-cut-thread (thread)
8589   "Go forwards in the thread until we find an article that we want to display."
8590   (when (or (eq gnus-fetch-old-headers 'some)
8591             (eq gnus-fetch-old-headers 'invisible)
8592             (numberp gnus-fetch-old-headers)
8593             (eq gnus-build-sparse-threads 'some)
8594             (eq gnus-build-sparse-threads 'more))
8595     ;; Deal with old-fetched headers and sparse threads.
8596     (while (and
8597             thread
8598             (or
8599              (gnus-summary-article-sparse-p (mail-header-number (car thread)))
8600              (gnus-summary-article-ancient-p
8601               (mail-header-number (car thread))))
8602             (if (or (<= (length (cdr thread)) 1)
8603                     (eq gnus-fetch-old-headers 'invisible))
8604                 (setq gnus-newsgroup-limit
8605                       (delq (mail-header-number (car thread))
8606                             gnus-newsgroup-limit)
8607                       thread (cadr thread))
8608               (when (gnus-invisible-cut-children (cdr thread))
8609                 (let ((th (cdr thread)))
8610                   (while th
8611                     (if (memq (mail-header-number (caar th))
8612                               gnus-newsgroup-limit)
8613                         (setq thread (car th)
8614                               th nil)
8615                       (setq th (cdr th))))))))))
8616   thread)
8617
8618 (defun gnus-cut-threads (threads)
8619   "Cut off all uninteresting articles from the beginning of THREADS."
8620   (when (or (eq gnus-fetch-old-headers 'some)
8621             (eq gnus-fetch-old-headers 'invisible)
8622             (numberp gnus-fetch-old-headers)
8623             (eq gnus-build-sparse-threads 'some)
8624             (eq gnus-build-sparse-threads 'more))
8625     (let ((th threads))
8626       (while th
8627         (setcar th (gnus-cut-thread (car th)))
8628         (setq th (cdr th)))))
8629   ;; Remove nixed out threads.
8630   (delq nil threads))
8631
8632 (defun gnus-summary-initial-limit (&optional show-if-empty)
8633   "Figure out what the initial limit is supposed to be on group entry.
8634 This entails weeding out unwanted dormants, low-scored articles,
8635 fetch-old-headers verbiage, and so on."
8636   ;; Most groups have nothing to remove.
8637   (unless (or gnus-inhibit-limiting
8638               (and (null gnus-newsgroup-dormant)
8639                    (eq gnus-newsgroup-display 'gnus-not-ignore)
8640                    (not (eq gnus-fetch-old-headers 'some))
8641                    (not (numberp gnus-fetch-old-headers))
8642                    (not (eq gnus-fetch-old-headers 'invisible))
8643                    (null gnus-summary-expunge-below)
8644                    (not (eq gnus-build-sparse-threads 'some))
8645                    (not (eq gnus-build-sparse-threads 'more))
8646                    (null gnus-thread-expunge-below)
8647                    (not gnus-use-nocem)))
8648     (push gnus-newsgroup-limit gnus-newsgroup-limits)
8649     (setq gnus-newsgroup-limit nil)
8650     (mapatoms
8651      (lambda (node)
8652        (unless (car (symbol-value node))
8653          ;; These threads have no parents -- they are roots.
8654          (let ((nodes (cdr (symbol-value node)))
8655                thread)
8656            (while nodes
8657              (if (and gnus-thread-expunge-below
8658                       (< (gnus-thread-total-score (car nodes))
8659                          gnus-thread-expunge-below))
8660                  (gnus-expunge-thread (pop nodes))
8661                (setq thread (pop nodes))
8662                (gnus-summary-limit-children thread))))))
8663      gnus-newsgroup-dependencies)
8664     ;; If this limitation resulted in an empty group, we might
8665     ;; pop the previous limit and use it instead.
8666     (when (and (not gnus-newsgroup-limit)
8667                show-if-empty)
8668       (setq gnus-newsgroup-limit (pop gnus-newsgroup-limits)))
8669     gnus-newsgroup-limit))
8670
8671 (defun gnus-summary-limit-children (thread)
8672   "Return 1 if this subthread is visible and 0 if it is not."
8673   ;; First we get the number of visible children to this thread.  This
8674   ;; is done by recursing down the thread using this function, so this
8675   ;; will really go down to a leaf article first, before slowly
8676   ;; working its way up towards the root.
8677   (when thread
8678     (let* ((max-lisp-eval-depth (max 5000 max-lisp-eval-depth))
8679            (children
8680            (if (cdr thread)
8681                (apply '+ (mapcar 'gnus-summary-limit-children
8682                                  (cdr thread)))
8683              0))
8684           (number (mail-header-number (car thread)))
8685           score)
8686       (if (and
8687            (not (memq number gnus-newsgroup-marked))
8688            (or
8689             ;; If this article is dormant and has absolutely no visible
8690             ;; children, then this article isn't visible.
8691             (and (memq number gnus-newsgroup-dormant)
8692                  (zerop children))
8693             ;; If this is "fetch-old-headered" and there is no
8694             ;; visible children, then we don't want this article.
8695             (and (or (eq gnus-fetch-old-headers 'some)
8696                      (numberp gnus-fetch-old-headers))
8697                  (gnus-summary-article-ancient-p number)
8698                  (zerop children))
8699             ;; If this is "fetch-old-headered" and `invisible', then
8700             ;; we don't want this article.
8701             (and (eq gnus-fetch-old-headers 'invisible)
8702                  (gnus-summary-article-ancient-p number))
8703             ;; If this is a sparsely inserted article with no children,
8704             ;; we don't want it.
8705             (and (eq gnus-build-sparse-threads 'some)
8706                  (gnus-summary-article-sparse-p number)
8707                  (zerop children))
8708             ;; If we use expunging, and this article is really
8709             ;; low-scored, then we don't want this article.
8710             (when (and gnus-summary-expunge-below
8711                        (< (setq score
8712                                 (or (cdr (assq number gnus-newsgroup-scored))
8713                                     gnus-summary-default-score))
8714                           gnus-summary-expunge-below))
8715               ;; We increase the expunge-tally here, but that has
8716               ;; nothing to do with the limits, really.
8717               (incf gnus-newsgroup-expunged-tally)
8718               ;; We also mark as read here, if that's wanted.
8719               (when (and gnus-summary-mark-below
8720                          (< score gnus-summary-mark-below))
8721                 (setq gnus-newsgroup-unreads
8722                       (delq number gnus-newsgroup-unreads))
8723                 (if gnus-newsgroup-auto-expire
8724                     (push number gnus-newsgroup-expirable)
8725                   (push (cons number gnus-low-score-mark)
8726                         gnus-newsgroup-reads)))
8727               t)
8728             ;; Do the `display' group parameter.
8729             (and gnus-newsgroup-display
8730                  (not (funcall gnus-newsgroup-display)))
8731             ;; Check NoCeM things.
8732             (when (and gnus-use-nocem
8733                        (gnus-nocem-unwanted-article-p
8734                         (mail-header-id (car thread))))
8735               (setq gnus-newsgroup-unreads
8736                     (delq number gnus-newsgroup-unreads))
8737               t)))
8738           ;; Nope, invisible article.
8739           0
8740         ;; Ok, this article is to be visible, so we add it to the limit
8741         ;; and return 1.
8742         (push number gnus-newsgroup-limit)
8743         1))))
8744
8745 (defun gnus-expunge-thread (thread)
8746   "Mark all articles in THREAD as read."
8747   (let* ((number (mail-header-number (car thread))))
8748     (incf gnus-newsgroup-expunged-tally)
8749     ;; We also mark as read here, if that's wanted.
8750     (setq gnus-newsgroup-unreads
8751           (delq number gnus-newsgroup-unreads))
8752     (if gnus-newsgroup-auto-expire
8753         (push number gnus-newsgroup-expirable)
8754       (push (cons number gnus-low-score-mark)
8755             gnus-newsgroup-reads)))
8756   ;; Go recursively through all subthreads.
8757   (mapcar 'gnus-expunge-thread (cdr thread)))
8758
8759 ;; Summary article oriented commands
8760
8761 (defun gnus-summary-refer-parent-article (n)
8762   "Refer parent article N times.
8763 If N is negative, go to ancestor -N instead.
8764 The difference between N and the number of articles fetched is returned."
8765   (interactive "p")
8766   (let ((skip 1)
8767         error header ref)
8768     (when (not (natnump n))
8769       (setq skip (abs n)
8770             n 1))
8771     (while (and (> n 0)
8772                 (not error))
8773       (setq header (gnus-summary-article-header))
8774       (if (and (eq (mail-header-number header)
8775                    (cdr gnus-article-current))
8776                (equal gnus-newsgroup-name
8777                       (car gnus-article-current)))
8778           ;; If we try to find the parent of the currently
8779           ;; displayed article, then we take a look at the actual
8780           ;; References header, since this is slightly more
8781           ;; reliable than the References field we got from the
8782           ;; server.
8783           (with-current-buffer gnus-original-article-buffer
8784             (nnheader-narrow-to-headers)
8785             (unless (setq ref (message-fetch-field "references"))
8786               (when (setq ref (message-fetch-field "in-reply-to"))
8787                 (setq ref (gnus-extract-message-id-from-in-reply-to ref))))
8788             (widen))
8789         (setq ref
8790               ;; It's not the current article, so we take a bet on
8791               ;; the value we got from the server.
8792               (mail-header-references header)))
8793       (if (and ref
8794                (not (equal ref "")))
8795           (unless (gnus-summary-refer-article (gnus-parent-id ref skip))
8796             (gnus-message 1 "Couldn't find parent"))
8797         (gnus-message 1 "No references in article %d"
8798                       (gnus-summary-article-number))
8799         (setq error t))
8800       (decf n))
8801     (gnus-summary-position-point)
8802     n))
8803
8804 (defun gnus-summary-refer-references ()
8805   "Fetch all articles mentioned in the References header.
8806 Return the number of articles fetched."
8807   (interactive)
8808   (let ((ref (mail-header-references (gnus-summary-article-header)))
8809         (current (gnus-summary-article-number))
8810         (n 0))
8811     (if (or (not ref)
8812             (equal ref ""))
8813         (error "No References in the current article")
8814       ;; For each Message-ID in the References header...
8815       (while (string-match "<[^>]*>" ref)
8816         (incf n)
8817         ;; ... fetch that article.
8818         (gnus-summary-refer-article
8819          (prog1 (match-string 0 ref)
8820            (setq ref (substring ref (match-end 0))))))
8821       (gnus-summary-goto-subject current)
8822       (gnus-summary-position-point)
8823       n)))
8824
8825 (defun gnus-summary-refer-thread (&optional limit)
8826   "Fetch all articles in the current thread.
8827 If LIMIT (the numerical prefix), fetch that many old headers instead
8828 of what's specified by the `gnus-refer-thread-limit' variable."
8829   (interactive "P")
8830   (let ((id (mail-header-id (gnus-summary-article-header)))
8831         (limit (if limit (prefix-numeric-value limit)
8832                  gnus-refer-thread-limit)))
8833     (unless (eq gnus-fetch-old-headers 'invisible)
8834       (gnus-message 5 "Fetching headers for %s..." gnus-newsgroup-name)
8835       ;; Retrieve the headers and read them in.
8836       (if (eq (if (numberp limit)
8837                   (gnus-retrieve-headers
8838                    (list (min
8839                           (+ (mail-header-number
8840                               (gnus-summary-article-header))
8841                              limit)
8842                           gnus-newsgroup-end))
8843                    gnus-newsgroup-name (* limit 2))
8844                 ;; gnus-refer-thread-limit is t, i.e. fetch _all_
8845                 ;; headers.
8846                 (gnus-retrieve-headers (list gnus-newsgroup-end)
8847                                        gnus-newsgroup-name limit))
8848               'nov)
8849           (gnus-build-all-threads)
8850         (error "Can't fetch thread from back ends that don't support NOV"))
8851       (gnus-message 5 "Fetching headers for %s...done" gnus-newsgroup-name))
8852     (gnus-summary-limit-include-thread id)))
8853
8854 (defun gnus-summary-refer-article (message-id)
8855   "Fetch an article specified by MESSAGE-ID."
8856   (interactive "sMessage-ID: ")
8857   (when (and (stringp message-id)
8858              (not (zerop (length message-id))))
8859     (setq message-id (gnus-replace-in-string message-id " " ""))
8860     ;; Construct the correct Message-ID if necessary.
8861     ;; Suggested by tale@pawl.rpi.edu.
8862     (unless (string-match "^<" message-id)
8863       (setq message-id (concat "<" message-id)))
8864     (unless (string-match ">$" message-id)
8865       (setq message-id (concat message-id ">")))
8866     ;; People often post MIDs from URLs, so unhex it:
8867     (unless (string-match "@" message-id)
8868       (setq message-id (gnus-url-unhex-string message-id)))
8869     (let* ((header (gnus-id-to-header message-id))
8870            (sparse (and header
8871                         (gnus-summary-article-sparse-p
8872                          (mail-header-number header))
8873                         (memq (mail-header-number header)
8874                               gnus-newsgroup-limit)))
8875            number)
8876       (cond
8877        ;; If the article is present in the buffer we just go to it.
8878        ((and header
8879              (or (not (gnus-summary-article-sparse-p
8880                        (mail-header-number header)))
8881                  sparse))
8882         (prog1
8883             (gnus-summary-goto-article
8884              (mail-header-number header) nil t)
8885           (when sparse
8886             (gnus-summary-update-article (mail-header-number header)))))
8887        (t
8888         ;; We fetch the article.
8889         (catch 'found
8890           (dolist (gnus-override-method (gnus-refer-article-methods))
8891             (when (and (gnus-check-server gnus-override-method)
8892                        ;; Fetch the header,
8893                        (setq number (gnus-summary-insert-subject message-id)))
8894               ;; and display the article.
8895               (gnus-summary-select-article nil nil nil number)
8896               (throw 'found t)))
8897           (gnus-message 3 "Couldn't fetch article %s" message-id)))))))
8898
8899 (defun gnus-refer-article-methods ()
8900   "Return a list of referable methods."
8901   (cond
8902    ;; No method, so we default to current and native.
8903    ((null gnus-refer-article-method)
8904     (list gnus-current-select-method gnus-select-method))
8905    ;; Current.
8906    ((eq 'current gnus-refer-article-method)
8907     (list gnus-current-select-method))
8908    ;; List of select methods.
8909    ((not (and (symbolp (car gnus-refer-article-method))
8910               (assq (car gnus-refer-article-method) nnoo-definition-alist)))
8911     (let (out)
8912       (dolist (method gnus-refer-article-method)
8913         (push (if (eq 'current method)
8914                   gnus-current-select-method
8915                 method)
8916               out))
8917       (nreverse out)))
8918    ;; One single select method.
8919    (t
8920     (list gnus-refer-article-method))))
8921
8922 (defun gnus-summary-edit-parameters ()
8923   "Edit the group parameters of the current group."
8924   (interactive)
8925   (gnus-group-edit-group gnus-newsgroup-name 'params))
8926
8927 (defun gnus-summary-customize-parameters ()
8928   "Customize the group parameters of the current group."
8929   (interactive)
8930   (gnus-group-customize gnus-newsgroup-name))
8931
8932 (defun gnus-summary-enter-digest-group (&optional force)
8933   "Enter an nndoc group based on the current article.
8934 If FORCE, force a digest interpretation.  If not, try
8935 to guess what the document format is."
8936   (interactive "P")
8937   (let ((conf gnus-current-window-configuration))
8938     (save-window-excursion
8939       (save-excursion
8940         (let (gnus-article-prepare-hook
8941               gnus-display-mime-function
8942               gnus-break-pages)
8943           (gnus-summary-select-article))))
8944     (setq gnus-current-window-configuration conf)
8945     (let* ((name (format "%s-%d"
8946                          (gnus-group-prefixed-name
8947                           gnus-newsgroup-name (list 'nndoc ""))
8948                          (with-current-buffer gnus-summary-buffer
8949                            gnus-current-article)))
8950            (ogroup gnus-newsgroup-name)
8951            (params (append (gnus-info-params (gnus-get-info ogroup))
8952                            (list (cons 'to-group ogroup))
8953                            (list (cons 'parent-group ogroup))
8954                            (list (cons 'save-article-group ogroup))))
8955            (case-fold-search t)
8956            (buf (current-buffer))
8957            dig to-address)
8958       (with-current-buffer gnus-original-article-buffer
8959         ;; Have the digest group inherit the main mail address of
8960         ;; the parent article.
8961         (when (setq to-address (or (gnus-fetch-field "reply-to")
8962                                    (gnus-fetch-field "from")))
8963           (setq params
8964                 (append
8965                  (list (cons 'to-address
8966                              (funcall gnus-decode-encoded-address-function
8967                                       to-address))))))
8968         (setq dig (nnheader-set-temp-buffer " *gnus digest buffer*"))
8969         (insert-buffer-substring gnus-original-article-buffer)
8970         ;; Remove lines that may lead nndoc to misinterpret the
8971         ;; document type.
8972         (narrow-to-region
8973          (goto-char (point-min))
8974          (or (search-forward "\n\n" nil t) (point)))
8975         (goto-char (point-min))
8976         (delete-matching-lines "^Path:\\|^From ")
8977         (widen))
8978       (unwind-protect
8979           (if (let ((gnus-newsgroup-ephemeral-charset gnus-newsgroup-charset)
8980                     (gnus-newsgroup-ephemeral-ignored-charsets
8981                      gnus-newsgroup-ignored-charsets))
8982                 (gnus-group-read-ephemeral-group
8983                  name `(nndoc ,name (nndoc-address ,(get-buffer dig))
8984                               (nndoc-article-type
8985                                ,(if force 'mbox 'guess)))
8986                  t nil nil nil
8987                  `((adapt-file . ,(gnus-score-file-name gnus-newsgroup-name
8988                                                         "ADAPT")))))
8989               ;; Make all postings to this group go to the parent group.
8990               (nconc (gnus-info-params (gnus-get-info name))
8991                      params)
8992             ;; Couldn't select this doc group.
8993             (switch-to-buffer buf)
8994             (gnus-set-global-variables)
8995             (gnus-configure-windows 'summary)
8996             (gnus-message 3 "Article couldn't be entered?"))
8997         (kill-buffer dig)))))
8998
8999 (defun gnus-summary-read-document (n)
9000   "Open a new group based on the current article(s).
9001 This will allow you to read digests and other similar
9002 documents as newsgroups.
9003 Obeys the standard process/prefix convention."
9004   (interactive "P")
9005   (let* ((ogroup gnus-newsgroup-name)
9006          (params (append (gnus-info-params (gnus-get-info ogroup))
9007                          (list (cons 'to-group ogroup))))
9008          group egroup groups vgroup)
9009     (dolist (article (gnus-summary-work-articles n))
9010       (setq group (format "%s-%d" gnus-newsgroup-name article))
9011       (gnus-summary-remove-process-mark article)
9012       (when (gnus-summary-display-article article)
9013         (save-excursion ;;What for?
9014           (with-temp-buffer
9015             (insert-buffer-substring gnus-original-article-buffer)
9016             ;; Remove some headers that may lead nndoc to make
9017             ;; the wrong guess.
9018             (message-narrow-to-head)
9019             (goto-char (point-min))
9020             (delete-matching-lines "^Path:\\|^From ")
9021             (widen)
9022             (if (setq egroup
9023                       (gnus-group-read-ephemeral-group
9024                        group `(nndoc ,group (nndoc-address ,(current-buffer))
9025                                      (nndoc-article-type guess))
9026                        t nil t))
9027                 (progn
9028                   ;; Make all postings to this group go to the parent group.
9029                   (nconc (gnus-info-params (gnus-get-info egroup))
9030                          params)
9031                   (push egroup groups))
9032               ;; Couldn't select this doc group.
9033               (gnus-error 3 "Article couldn't be entered"))))))
9034     ;; Now we have selected all the documents.
9035     (cond
9036      ((not groups)
9037       (error "None of the articles could be interpreted as documents"))
9038      ((gnus-group-read-ephemeral-group
9039        (setq vgroup (format
9040                      "nnvirtual:%s-%s" gnus-newsgroup-name
9041                      (format-time-string "%Y%m%dT%H%M%S" (current-time))))
9042        `(nnvirtual ,vgroup (nnvirtual-component-groups ,groups))
9043        t
9044        (cons (current-buffer) 'summary)))
9045      (t
9046       (error "Couldn't select virtual nndoc group")))))
9047
9048 (defun gnus-summary-isearch-article (&optional regexp-p)
9049   "Do incremental search forward on the current article.
9050 If REGEXP-P (the prefix) is non-nil, do regexp isearch."
9051   (interactive "P")
9052   (gnus-summary-select-article)
9053   (gnus-configure-windows 'article)
9054   (gnus-eval-in-buffer-window gnus-article-buffer
9055     (save-restriction
9056       (widen)
9057       (isearch-forward regexp-p))))
9058
9059 (defun gnus-summary-repeat-search-article-forward ()
9060   "Repeat the previous search forwards."
9061   (interactive)
9062   (unless gnus-last-search-regexp
9063     (error "No previous search"))
9064   (gnus-summary-search-article-forward gnus-last-search-regexp))
9065
9066 (defun gnus-summary-repeat-search-article-backward ()
9067   "Repeat the previous search backwards."
9068   (interactive)
9069   (unless gnus-last-search-regexp
9070     (error "No previous search"))
9071   (gnus-summary-search-article-forward gnus-last-search-regexp t))
9072
9073 (defun gnus-summary-search-article-forward (regexp &optional backward)
9074   "Search for an article containing REGEXP forward.
9075 If BACKWARD, search backward instead."
9076   (interactive
9077    (list (read-string
9078           (format "Search article %s (regexp%s): "
9079                   (if current-prefix-arg "backward" "forward")
9080                   (if gnus-last-search-regexp
9081                       (concat ", default " gnus-last-search-regexp)
9082                     "")))
9083          current-prefix-arg))
9084   (if (string-equal regexp "")
9085       (setq regexp (or gnus-last-search-regexp ""))
9086     (setq gnus-last-search-regexp regexp)
9087     (setq gnus-article-before-search gnus-current-article))
9088   ;; Intentionally set gnus-last-article.
9089   (setq gnus-last-article gnus-article-before-search)
9090   (let ((gnus-last-article gnus-last-article))
9091     (if (gnus-summary-search-article regexp backward)
9092         (gnus-summary-show-thread)
9093       (signal 'search-failed (list regexp)))))
9094
9095 (defun gnus-summary-search-article-backward (regexp)
9096   "Search for an article containing REGEXP backward."
9097   (interactive
9098    (list (read-string
9099           (format "Search article backward (regexp%s): "
9100                   (if gnus-last-search-regexp
9101                       (concat ", default " gnus-last-search-regexp)
9102                     "")))))
9103   (gnus-summary-search-article-forward regexp 'backward))
9104
9105 (defun gnus-summary-search-article (regexp &optional backward)
9106   "Search for an article containing REGEXP.
9107 Optional argument BACKWARD means do search for backward.
9108 `gnus-select-article-hook' is not called during the search."
9109   ;; We have to require this here to make sure that the following
9110   ;; dynamic binding isn't shadowed by autoloading.
9111   (require 'gnus-async)
9112   (require 'gnus-art)
9113   (let ((gnus-select-article-hook nil)  ;Disable hook.
9114         (gnus-article-prepare-hook nil)
9115         (gnus-mark-article-hook nil)    ;Inhibit marking as read.
9116         (gnus-use-article-prefetch nil)
9117         (gnus-xmas-force-redisplay nil) ;Inhibit XEmacs redisplay.
9118         (gnus-use-trees nil)            ;Inhibit updating tree buffer.
9119         (gnus-visual nil)
9120         (gnus-keep-backlog nil)
9121         (gnus-break-pages nil)
9122         (gnus-summary-display-arrow nil)
9123         (gnus-updated-mode-lines nil)
9124         (gnus-auto-center-summary nil)
9125         (sum (current-buffer))
9126         (gnus-display-mime-function nil)
9127         (found nil)
9128         point)
9129     (gnus-save-hidden-threads
9130       (gnus-summary-select-article)
9131       (set-buffer gnus-article-buffer)
9132       (goto-char (window-point (get-buffer-window (current-buffer))))
9133       (when backward
9134         (forward-line -1))
9135       (while (not found)
9136         (gnus-message 7 "Searching article: %d..." (cdr gnus-article-current))
9137         (if (if backward
9138                 (re-search-backward regexp nil t)
9139               (re-search-forward regexp nil t))
9140             ;; We found the regexp.
9141             (progn
9142               (setq found 'found)
9143               (beginning-of-line)
9144               (set-window-start
9145                (get-buffer-window (current-buffer))
9146                (point))
9147               (forward-line 1)
9148               (set-window-point
9149                (get-buffer-window (current-buffer))
9150                (point))
9151               (set-buffer sum)
9152               (setq point (point)))
9153           ;; We didn't find it, so we go to the next article.
9154           (set-buffer sum)
9155           (setq found 'not)
9156           (while (eq found 'not)
9157             (if (not (if backward (gnus-summary-find-prev)
9158                        (gnus-summary-find-next)))
9159                 ;; No more articles.
9160                 (setq found t)
9161               ;; Select the next article and adjust point.
9162               (unless (gnus-summary-article-sparse-p
9163                        (gnus-summary-article-number))
9164                 (setq found nil)
9165                 (gnus-summary-select-article)
9166                 (set-buffer gnus-article-buffer)
9167                 (widen)
9168                 (goto-char (if backward (point-max) (point-min))))))))
9169       (gnus-message 7 ""))
9170     ;; Return whether we found the regexp.
9171     (when (eq found 'found)
9172       (goto-char point)
9173       (gnus-summary-show-thread)
9174       (gnus-summary-goto-subject gnus-current-article)
9175       (gnus-summary-position-point)
9176       t)))
9177
9178 (defun gnus-find-matching-articles (header regexp)
9179   "Return a list of all articles that match REGEXP on HEADER.
9180 This search includes all articles in the current group that Gnus has
9181 fetched headers for, whether they are displayed or not."
9182   (let ((articles nil)
9183         ;; Can't eta-reduce because it's a macro.
9184         (func `(lambda (h) (,(intern (concat "mail-header-" header)) h)))
9185         (case-fold-search t))
9186     (dolist (header gnus-newsgroup-headers)
9187       (when (string-match regexp (funcall func header))
9188         (push (mail-header-number header) articles)))
9189     (nreverse articles)))
9190
9191 (defun gnus-summary-find-matching (header regexp &optional backward unread
9192                                           not-case-fold not-matching)
9193   "Return a list of all articles that match REGEXP on HEADER.
9194 The search stars on the current article and goes forwards unless
9195 BACKWARD is non-nil.  If BACKWARD is `all', do all articles.
9196 If UNREAD is non-nil, only unread articles will
9197 be taken into consideration.  If NOT-CASE-FOLD, case won't be folded
9198 in the comparisons. If NOT-MATCHING, return a list of all articles that
9199 not match REGEXP on HEADER."
9200   (let ((case-fold-search (not not-case-fold))
9201         articles d func)
9202     (if (consp header)
9203         (if (eq (car header) 'extra)
9204             (setq func
9205                   `(lambda (h)
9206                      (or (cdr (assq ',(cdr header) (mail-header-extra h)))
9207                          "")))
9208           (error "%s is an invalid header" header))
9209       (unless (fboundp (intern (concat "mail-header-" header)))
9210         (error "%s is not a valid header" header))
9211       (setq func `(lambda (h) (,(intern (concat "mail-header-" header)) h))))
9212     (dolist (d (if (eq backward 'all)
9213                    gnus-newsgroup-data
9214                  (gnus-data-find-list
9215                   (gnus-summary-article-number)
9216                   (gnus-data-list backward))))
9217       (when (and (or (not unread)       ; We want all articles...
9218                      (gnus-data-unread-p d)) ; Or just unreads.
9219                  (vectorp (gnus-data-header d)) ; It's not a pseudo.
9220                  (if not-matching
9221                      (not (string-match
9222                            regexp
9223                            (funcall func (gnus-data-header d))))
9224                    (string-match regexp
9225                                  (funcall func (gnus-data-header d)))))
9226         (push (gnus-data-number d) articles))) ; Success!
9227     (nreverse articles)))
9228
9229 (defun gnus-summary-execute-command (header regexp command &optional backward)
9230   "Search forward for an article whose HEADER matches REGEXP and execute COMMAND.
9231 If HEADER is an empty string (or nil), the match is done on the entire
9232 article.  If BACKWARD (the prefix) is non-nil, search backward instead."
9233   (interactive
9234    (list (let ((completion-ignore-case t))
9235            (completing-read
9236             "Header name: "
9237             (mapcar (lambda (header) (list (format "%s" header)))
9238                     (append
9239                      '("Number" "Subject" "From" "Lines" "Date"
9240                        "Message-ID" "Xref" "References" "Body")
9241                      gnus-extra-headers))
9242             nil 'require-match))
9243          (read-string "Regexp: ")
9244          (read-key-sequence "Command: ")
9245          current-prefix-arg))
9246   (when (equal header "Body")
9247     (setq header ""))
9248   ;; Hidden thread subtrees must be searched as well.
9249   (gnus-summary-show-all-threads)
9250   ;; We don't want to change current point nor window configuration.
9251   (save-excursion
9252     (save-window-excursion
9253       (let (gnus-visual
9254             gnus-treat-strip-trailing-blank-lines
9255             gnus-treat-strip-leading-blank-lines
9256             gnus-treat-strip-multiple-blank-lines
9257             gnus-treat-hide-boring-headers
9258             gnus-treat-fold-newsgroups
9259             gnus-article-prepare-hook)
9260         (gnus-message 6 "Executing %s..." (key-description command))
9261         ;; We'd like to execute COMMAND interactively so as to give arguments.
9262         (gnus-execute header regexp
9263                       `(call-interactively ',(key-binding command))
9264                       backward)
9265         (gnus-message 6 "Executing %s...done" (key-description command))))))
9266
9267 (defun gnus-summary-beginning-of-article ()
9268   "Scroll the article back to the beginning."
9269   (interactive)
9270   (gnus-summary-select-article)
9271   (gnus-configure-windows 'article)
9272   (gnus-eval-in-buffer-window gnus-article-buffer
9273     (widen)
9274     (goto-char (point-min))
9275     (when gnus-break-pages
9276       (gnus-narrow-to-page))))
9277
9278 (defun gnus-summary-end-of-article ()
9279   "Scroll to the end of the article."
9280   (interactive)
9281   (gnus-summary-select-article)
9282   (gnus-configure-windows 'article)
9283   (gnus-eval-in-buffer-window gnus-article-buffer
9284     (widen)
9285     (goto-char (point-max))
9286     (recenter -3)
9287     (when gnus-break-pages
9288       (gnus-narrow-to-page))))
9289
9290 (defun gnus-summary-print-truncate-and-quote (string &optional len)
9291   "Truncate to LEN and quote all \"(\"'s in STRING."
9292   (gnus-replace-in-string (if (and len (> (length string) len))
9293                               (substring string 0 len)
9294                             string)
9295                           "[()]" "\\\\\\&"))
9296
9297 (defun gnus-summary-print-article (&optional filename n)
9298   "Generate and print a PostScript image of the process-marked (mail) articles.
9299
9300 If used interactively, print the current article if none are
9301 process-marked.  With prefix arg, prompt the user for the name of the
9302 file to save in.
9303
9304 When used from Lisp, accept two optional args FILENAME and N.  N means
9305 to print the next N articles.  If N is negative, print the N previous
9306 articles.  If N is nil and articles have been marked with the process
9307 mark, print these instead.
9308
9309 If the optional first argument FILENAME is nil, send the image to the
9310 printer.  If FILENAME is a string, save the PostScript image in a file with
9311 that name.  If FILENAME is a number, prompt the user for the name of the file
9312 to save in."
9313   (interactive (list (ps-print-preprint current-prefix-arg)))
9314   (dolist (article (gnus-summary-work-articles n))
9315     (gnus-summary-select-article nil nil 'pseudo article)
9316     (gnus-eval-in-buffer-window gnus-article-buffer
9317       (gnus-print-buffer))
9318     (gnus-summary-remove-process-mark article))
9319   (ps-despool filename))
9320
9321 (defun gnus-print-buffer ()
9322   (let ((buffer (generate-new-buffer " *print*")))
9323     (unwind-protect
9324         (progn
9325           (copy-to-buffer buffer (point-min) (point-max))
9326           (set-buffer buffer)
9327           (gnus-remove-text-with-property 'gnus-decoration)
9328           (when (gnus-visual-p 'article-highlight 'highlight)
9329             ;; Copy-to-buffer doesn't copy overlay.  So redo
9330             ;; highlight.
9331             (let ((gnus-article-buffer buffer))
9332               (gnus-article-highlight-citation t)
9333               (gnus-article-highlight-signature)
9334               (gnus-article-emphasize)
9335               (gnus-article-delete-invisible-text)))
9336           (let ((ps-left-header
9337                  (list
9338                   (concat "("
9339                           (gnus-summary-print-truncate-and-quote
9340                            (mail-header-subject gnus-current-headers)
9341                            66) ")")
9342                   (concat "("
9343                           (gnus-summary-print-truncate-and-quote
9344                            (mail-header-from gnus-current-headers)
9345                            45) ")")))
9346                 (ps-right-header
9347                  (list
9348                   "/pagenumberstring load"
9349                   (concat "("
9350                           (mail-header-date gnus-current-headers) ")"))))
9351             (gnus-run-hooks 'gnus-ps-print-hook)
9352             (save-excursion
9353               (if ps-print-color-p
9354                   (ps-spool-buffer-with-faces)
9355                 (ps-spool-buffer)))))
9356       (kill-buffer buffer))))
9357
9358 (defun gnus-summary-show-article (&optional arg)
9359   "Force redisplaying of the current article.
9360 If ARG (the prefix) is a number, show the article with the charset
9361 defined in `gnus-summary-show-article-charset-alist', or the charset
9362 input.
9363 If ARG (the prefix) is non-nil and not a number, show the raw article
9364 without any article massaging functions being run.  Normally, the key
9365 strokes are `C-u g'."
9366   (interactive "P")
9367   (cond
9368    ((numberp arg)
9369     (gnus-summary-show-article t)
9370     (let ((gnus-newsgroup-charset
9371            (or (cdr (assq arg gnus-summary-show-article-charset-alist))
9372                (mm-read-coding-system
9373                 "View as charset: " ;; actually it is coding system.
9374                 (with-current-buffer gnus-article-buffer
9375                   (mm-detect-coding-region (point) (point-max))))))
9376           (gnus-newsgroup-ignored-charsets 'gnus-all))
9377       (gnus-summary-select-article nil 'force)
9378       (let ((deps gnus-newsgroup-dependencies)
9379             head header lines)
9380         (with-current-buffer gnus-original-article-buffer
9381           (save-restriction
9382             (message-narrow-to-head)
9383             (setq head (buffer-string))
9384             (goto-char (point-min))
9385             (unless (re-search-forward "^lines:[ \t]\\([0-9]+\\)" nil t)
9386               (goto-char (point-max))
9387               (widen)
9388               (setq lines (1- (count-lines (point) (point-max))))))
9389           (with-temp-buffer
9390             (insert (format "211 %d Article retrieved.\n"
9391                             (cdr gnus-article-current)))
9392             (insert head)
9393             (if lines (insert (format "Lines: %d\n" lines)))
9394             (insert ".\n")
9395             (let ((nntp-server-buffer (current-buffer)))
9396               (setq header (car (gnus-get-newsgroup-headers deps t))))))
9397         (gnus-data-set-header
9398          (gnus-data-find (cdr gnus-article-current))
9399          header)
9400         (gnus-summary-update-article-line
9401          (cdr gnus-article-current) header)
9402         (when (gnus-summary-goto-subject (cdr gnus-article-current) nil t)
9403           (gnus-summary-update-secondary-mark (cdr gnus-article-current))))))
9404    ((not arg)
9405     ;; Select the article the normal way.
9406     (gnus-summary-select-article nil 'force))
9407    (t
9408     ;; We have to require this here to make sure that the following
9409     ;; dynamic binding isn't shadowed by autoloading.
9410     (require 'gnus-async)
9411     (require 'gnus-art)
9412     ;; Bind the article treatment functions to nil.
9413     (let ((gnus-have-all-headers t)
9414           gnus-article-prepare-hook
9415           gnus-article-decode-hook
9416           gnus-display-mime-function
9417           gnus-break-pages)
9418       ;; Destroy any MIME parts.
9419       (when (gnus-buffer-live-p gnus-article-buffer)
9420         (with-current-buffer gnus-article-buffer
9421           (mm-destroy-parts gnus-article-mime-handles)
9422           ;; Set it to nil for safety reason.
9423           (setq gnus-article-mime-handle-alist nil)
9424           (setq gnus-article-mime-handles nil)))
9425       (gnus-summary-select-article nil 'force))))
9426   (gnus-summary-goto-subject gnus-current-article)
9427   (gnus-summary-position-point))
9428
9429 (defun gnus-summary-show-raw-article ()
9430   "Show the raw article without any article massaging functions being run."
9431   (interactive)
9432   (gnus-summary-show-article t))
9433
9434 (defun gnus-summary-verbose-headers (&optional arg)
9435   "Toggle permanent full header display.
9436 If ARG is a positive number, turn header display on.
9437 If ARG is a negative number, turn header display off."
9438   (interactive "P")
9439   (setq gnus-show-all-headers
9440         (cond ((or (not (numberp arg))
9441                    (zerop arg))
9442                (not gnus-show-all-headers))
9443               ((natnump arg)
9444                t)))
9445   (gnus-summary-show-article))
9446
9447 (defun gnus-summary-toggle-header (&optional arg)
9448   "Show the headers if they are hidden, or hide them if they are shown.
9449 If ARG is a positive number, show the entire header.
9450 If ARG is a negative number, hide the unwanted header lines."
9451   (interactive "P")
9452   (let ((window (and (gnus-buffer-live-p gnus-article-buffer)
9453                      (get-buffer-window gnus-article-buffer t))))
9454     (with-current-buffer gnus-article-buffer
9455       (widen)
9456       (article-narrow-to-head)
9457       (let* ((inhibit-read-only t)
9458              (inhibit-point-motion-hooks t)
9459              (hidden (if (numberp arg)
9460                          (>= arg 0)
9461                        (or (not (looking-at "[^ \t\n]+:"))
9462                            (gnus-article-hidden-text-p 'headers))))
9463              s e)
9464         (delete-region (point-min) (point-max))
9465         (with-current-buffer gnus-original-article-buffer
9466           (goto-char (setq s (point-min)))
9467           (setq e (if (search-forward "\n\n" nil t)
9468                       (1- (point))
9469                     (point-max))))
9470         (insert-buffer-substring gnus-original-article-buffer s e)
9471         (run-hooks 'gnus-article-decode-hook)
9472         (if hidden
9473             (let ((gnus-treat-hide-headers nil)
9474                   (gnus-treat-hide-boring-headers nil))
9475               (gnus-delete-wash-type 'headers)
9476               (gnus-treat-article 'head))
9477           (gnus-treat-article 'head))
9478         (widen)
9479         (if window
9480             (set-window-start window (goto-char (point-min))))
9481         (if gnus-break-pages
9482             (gnus-narrow-to-page)
9483           (when (gnus-visual-p 'page-marker)
9484             (let ((inhibit-read-only t))
9485               (gnus-remove-text-with-property 'gnus-prev)
9486               (gnus-remove-text-with-property 'gnus-next))))
9487         (gnus-set-mode-line 'article)))))
9488
9489 (defun gnus-summary-show-all-headers ()
9490   "Make all header lines visible."
9491   (interactive)
9492   (gnus-summary-toggle-header 1))
9493
9494 (defun gnus-summary-caesar-message (&optional arg)
9495   "Caesar rotate the current article by 13.
9496 With a non-numerical prefix, also rotate headers.  A numerical
9497 prefix specifies how many places to rotate each letter forward."
9498   (interactive "P")
9499   (gnus-summary-select-article)
9500   (let ((mail-header-separator ""))
9501     (gnus-eval-in-buffer-window gnus-article-buffer
9502       (save-restriction
9503         (widen)
9504         (let ((start (window-start))
9505               (inhibit-read-only t))
9506           (if (equal arg '(4))
9507               (message-caesar-buffer-body nil t)
9508             (message-caesar-buffer-body arg))
9509           (set-window-start (get-buffer-window (current-buffer)) start)))))
9510   ;; Create buttons and stuff...
9511   (gnus-treat-article nil))
9512
9513 (declare-function idna-to-unicode "ext:idna" (str))
9514
9515 (defun gnus-summary-idna-message (&optional arg)
9516   "Decode IDNA encoded domain names in the current articles.
9517 IDNA encoded domain names looks like `xn--bar'.  If a string
9518 remain unencoded after running this function, it is likely an
9519 invalid IDNA string (`xn--bar' is invalid).
9520
9521 You must have GNU Libidn (URL `http://www.gnu.org/software/libidn/')
9522 installed for this command to work."
9523   (interactive "P")
9524   (if (not (and (condition-case nil (require 'idna)
9525                   (file-error))
9526                 (mm-coding-system-p 'utf-8)
9527                 (executable-find (symbol-value 'idna-program))))
9528       (gnus-message
9529        5 "GNU Libidn not installed properly (`idn' or `idna.el' missing)")
9530     (gnus-summary-select-article)
9531     (let ((mail-header-separator ""))
9532       (gnus-eval-in-buffer-window gnus-article-buffer
9533         (save-restriction
9534           (widen)
9535           (let ((start (window-start))
9536                 buffer-read-only)
9537             (while (re-search-forward "\\(xn--[-0-9a-z]+\\)" nil t)
9538               (replace-match (idna-to-unicode (match-string 1))))
9539             (set-window-start (get-buffer-window (current-buffer)) start)))))))
9540
9541 (defun gnus-summary-morse-message (&optional arg)
9542   "Morse decode the current article."
9543   (interactive "P")
9544   (gnus-summary-select-article)
9545   (let ((mail-header-separator ""))
9546     (gnus-eval-in-buffer-window gnus-article-buffer
9547       (save-excursion
9548         (save-restriction
9549           (widen)
9550           (let ((pos (window-start))
9551                 (inhibit-read-only t))
9552             (goto-char (point-min))
9553             (when (message-goto-body)
9554               (gnus-narrow-to-body))
9555             (goto-char (point-min))
9556             (while (search-forward "·" (point-max) t)
9557               (replace-match "."))
9558             (unmorse-region (point-min) (point-max))
9559             (widen)
9560             (set-window-start (get-buffer-window (current-buffer)) pos)))))))
9561
9562 (defun gnus-summary-stop-page-breaking ()
9563   "Stop page breaking in the current article."
9564   (interactive)
9565   (gnus-summary-select-article)
9566   (gnus-eval-in-buffer-window gnus-article-buffer
9567     (widen)
9568     (when (gnus-visual-p 'page-marker)
9569       (let ((inhibit-read-only t))
9570         (gnus-remove-text-with-property 'gnus-prev)
9571         (gnus-remove-text-with-property 'gnus-next))
9572       (setq gnus-page-broken nil))))
9573
9574 (defun gnus-summary-move-article (&optional n to-newsgroup
9575                                             select-method action)
9576   "Move the current article to a different newsgroup.
9577 If N is a positive number, move the N next articles.
9578 If N is a negative number, move the N previous articles.
9579 If N is nil and any articles have been marked with the process mark,
9580 move those articles instead.
9581 If TO-NEWSGROUP is string, do not prompt for a newsgroup to move to.
9582 If SELECT-METHOD is non-nil, do not move to a specific newsgroup, but
9583 re-spool using this method.
9584
9585 When called interactively with TO-NEWSGROUP being nil, the value of
9586 the variable `gnus-move-split-methods' is used for finding a default
9587 for the target newsgroup.
9588
9589 For this function to work, both the current newsgroup and the
9590 newsgroup that you want to move to have to support the `request-move'
9591 and `request-accept' functions.
9592
9593 ACTION can be either `move' (the default), `crosspost' or `copy'."
9594   (interactive "P")
9595   (unless action
9596     (setq action 'move))
9597   ;; Check whether the source group supports the required functions.
9598   (cond ((and (eq action 'move)
9599               (not (gnus-check-backend-function
9600                     'request-move-article gnus-newsgroup-name)))
9601          (error "The current group does not support article moving"))
9602         ((and (eq action 'crosspost)
9603               (not (gnus-check-backend-function
9604                     'request-replace-article gnus-newsgroup-name)))
9605          (error "The current group does not support article editing")))
9606   (let ((articles (gnus-summary-work-articles n))
9607         (prefix (if (gnus-check-backend-function
9608                      'request-move-article gnus-newsgroup-name)
9609                     (funcall gnus-move-group-prefix-function
9610                              gnus-newsgroup-name)
9611                   ""))
9612         (names '((move "Move" "Moving")
9613                  (copy "Copy" "Copying")
9614                  (crosspost "Crosspost" "Crossposting")))
9615         (copy-buf (save-excursion
9616                     (nnheader-set-temp-buffer " *copy article*")))
9617         art-group to-method new-xref article to-groups
9618         articles-to-update-marks encoded)
9619     (unless (assq action names)
9620       (error "Unknown action %s" action))
9621     ;; Read the newsgroup name.
9622     (when (and (not to-newsgroup)
9623                (not select-method))
9624       (if (and gnus-move-split-methods
9625                (not
9626                 (and (memq gnus-current-article articles)
9627                      (gnus-buffer-live-p gnus-original-article-buffer))))
9628           ;; When `gnus-move-split-methods' is non-nil, we have to
9629           ;; select an article to give `gnus-read-move-group-name' an
9630           ;; opportunity to suggest an appropriate default.  However,
9631           ;; we needn't render or mark the article.
9632           (let ((gnus-display-mime-function nil)
9633                 (gnus-article-prepare-hook nil)
9634                 (gnus-mark-article-hook nil))
9635             (gnus-summary-select-article nil nil nil (car articles))))
9636       (setq to-newsgroup (gnus-read-move-group-name
9637                           (cadr (assq action names))
9638                           (symbol-value
9639                            (intern (format "gnus-current-%s-group" action)))
9640                           articles prefix)
9641             encoded to-newsgroup
9642             to-method (gnus-server-to-method (gnus-group-method to-newsgroup)))
9643       (set (intern (format "gnus-current-%s-group" action))
9644            (mm-decode-coding-string
9645             to-newsgroup
9646             (gnus-group-name-charset to-method to-newsgroup))))
9647     (unless to-method
9648       (setq to-method (or select-method
9649                           (gnus-server-to-method
9650                            (gnus-group-method to-newsgroup)))))
9651     (setq to-newsgroup
9652           (or encoded
9653               (and to-newsgroup
9654                    (mm-encode-coding-string
9655                     to-newsgroup
9656                     (gnus-group-name-charset to-method to-newsgroup)))))
9657     ;; Check the method we are to move this article to...
9658     (unless (gnus-check-backend-function
9659              'request-accept-article (car to-method))
9660       (error "%s does not support article copying" (car to-method)))
9661     (unless (gnus-check-server to-method)
9662       (error "Can't open server %s" (car to-method)))
9663     (gnus-message 6 "%s to %s: %s..."
9664                   (caddr (assq action names))
9665                   (or (car select-method)
9666                       (gnus-group-decoded-name to-newsgroup))
9667                   articles)
9668     (while articles
9669       (setq article (pop articles))
9670       (setq
9671        art-group
9672        (cond
9673         ;; Move the article.
9674         ((eq action 'move)
9675          ;; Remove this article from future suppression.
9676          (gnus-dup-unsuppress-article article)
9677          (let* ((from-method (gnus-find-method-for-group
9678                               gnus-newsgroup-name))
9679                 (to-method (or select-method
9680                                (gnus-find-method-for-group to-newsgroup)))
9681                 (move-is-internal (gnus-method-equal from-method to-method)))
9682            (gnus-request-move-article
9683             article                     ; Article to move
9684             gnus-newsgroup-name         ; From newsgroup
9685             (nth 1 (gnus-find-method-for-group
9686                     gnus-newsgroup-name)) ; Server
9687             (list 'gnus-request-accept-article
9688                   to-newsgroup (list 'quote select-method)
9689                   (not articles) t)     ; Accept form
9690             (not articles)              ; Only save nov last time
9691             move-is-internal)))         ; is this move internal?
9692         ;; Copy the article.
9693         ((eq action 'copy)
9694          (with-current-buffer copy-buf
9695            (when (gnus-request-article-this-buffer article gnus-newsgroup-name)
9696              (save-restriction
9697                (nnheader-narrow-to-headers)
9698                (dolist (hdr gnus-copy-article-ignored-headers)
9699                  (message-remove-header hdr t)))
9700              (gnus-request-accept-article
9701               to-newsgroup select-method (not articles) t))))
9702         ;; Crosspost the article.
9703         ((eq action 'crosspost)
9704          (let ((xref (message-tokenize-header
9705                       (mail-header-xref (gnus-summary-article-header article))
9706                       " ")))
9707            (setq new-xref (concat (gnus-group-real-name gnus-newsgroup-name)
9708                                   ":" (number-to-string article)))
9709            (unless xref
9710              (setq xref (list (system-name))))
9711            (setq new-xref
9712                  (concat
9713                   (mapconcat 'identity
9714                              (delete "Xref:" (delete new-xref xref))
9715                              " ")
9716                   " " new-xref))
9717            (with-current-buffer copy-buf
9718              ;; First put the article in the destination group.
9719              (gnus-request-article-this-buffer article gnus-newsgroup-name)
9720              (when (consp (setq art-group
9721                                 (gnus-request-accept-article
9722                                  to-newsgroup select-method (not articles) t)))
9723                (setq new-xref (concat new-xref " " (car art-group)
9724                                       ":"
9725                                       (number-to-string (cdr art-group))))
9726                ;; Now we have the new Xrefs header, so we insert
9727                ;; it and replace the new article.
9728                (nnheader-replace-header "Xref" new-xref)
9729                (gnus-request-replace-article
9730                 (cdr art-group) to-newsgroup (current-buffer) t)
9731                art-group))))))
9732       (cond
9733        ((not art-group)
9734         (gnus-message 1 "Couldn't %s article %s: %s"
9735                       (cadr (assq action names)) article
9736                       (nnheader-get-report (car to-method))))
9737        ((eq art-group 'junk)
9738         (when (eq action 'move)
9739           (gnus-summary-mark-article article gnus-canceled-mark)
9740           (gnus-message 4 "Deleted article %s" article)
9741           ;; run the delete hook
9742           (run-hook-with-args 'gnus-summary-article-delete-hook
9743                               action
9744                               (gnus-data-header
9745                                (assoc article (gnus-data-list nil)))
9746                               gnus-newsgroup-name nil
9747                               select-method)))
9748        (t
9749         (let* ((pto-group (gnus-group-prefixed-name
9750                            (car art-group) to-method))
9751                (info (gnus-get-info pto-group))
9752                (to-group (gnus-info-group info))
9753                to-marks)
9754           ;; Update the group that has been moved to.
9755           (when (and info
9756                      (memq action '(move copy)))
9757             (unless (member to-group to-groups)
9758               (push to-group to-groups))
9759
9760             (unless (memq article gnus-newsgroup-unreads)
9761               (push 'read to-marks)
9762               (gnus-info-set-read
9763                info (gnus-add-to-range (gnus-info-read info)
9764                                        (list (cdr art-group)))))
9765
9766             ;; See whether the article is to be put in the cache.
9767             (let* ((expirable (gnus-group-auto-expirable-p to-group))
9768                    (marks (if expirable
9769                               gnus-article-mark-lists
9770                             (delete '(expirable . expire)
9771                                     (copy-sequence gnus-article-mark-lists))))
9772                    (to-article (cdr art-group)))
9773
9774               ;; Enter the article into the cache in the new group,
9775               ;; if that is required.
9776               (when gnus-use-cache
9777                 (gnus-cache-possibly-enter-article
9778                  to-group to-article
9779                  (memq article gnus-newsgroup-marked)
9780                  (memq article gnus-newsgroup-dormant)
9781                  (memq article gnus-newsgroup-unreads)))
9782
9783               (when gnus-preserve-marks
9784                 ;; Copy any marks over to the new group.
9785                 (when (and (equal to-group gnus-newsgroup-name)
9786                            (not (memq article gnus-newsgroup-unreads)))
9787                   ;; Mark this article as read in this group.
9788                   (push (cons to-article gnus-read-mark) gnus-newsgroup-reads)
9789                   (setcdr (gnus-active to-group) to-article)
9790                   (setcdr gnus-newsgroup-active to-article))
9791
9792                 (while marks
9793                   (when (eq (gnus-article-mark-to-type (cdar marks)) 'list)
9794                     (when (memq article (symbol-value
9795                                          (intern (format "gnus-newsgroup-%s"
9796                                                          (caar marks)))))
9797                       (push (cdar marks) to-marks)
9798                       ;; If the other group is the same as this group,
9799                       ;; then we have to add the mark to the list.
9800                       (when (equal to-group gnus-newsgroup-name)
9801                         (set (intern (format "gnus-newsgroup-%s" (caar marks)))
9802                              (cons to-article
9803                                    (symbol-value
9804                                     (intern (format "gnus-newsgroup-%s"
9805                                                     (caar marks)))))))
9806                       ;; Copy the marks to other group.
9807                       (gnus-add-marked-articles
9808                        to-group (cdar marks) (list to-article) info)))
9809                   (setq marks (cdr marks)))
9810
9811                 (when (and expirable
9812                            gnus-mark-copied-or-moved-articles-as-expirable
9813                            (not (memq 'expire to-marks)))
9814                   ;; Mark this article as expirable.
9815                   (push 'expire to-marks)
9816                   (when (equal to-group gnus-newsgroup-name)
9817                     (push to-article gnus-newsgroup-expirable))
9818                   ;; Copy the expirable mark to other group.
9819                   (gnus-add-marked-articles
9820                    to-group 'expire (list to-article) info))
9821
9822                 (gnus-request-set-mark
9823                  to-group (list (list (list to-article) 'add to-marks))))
9824
9825               (gnus-dribble-enter
9826                (concat "(gnus-group-set-info '"
9827                        (gnus-prin1-to-string (gnus-get-info to-group))
9828                        ")"))))
9829
9830           ;; Update the Xref header in this article to point to
9831           ;; the new crossposted article we have just created.
9832           (when (eq action 'crosspost)
9833             (with-current-buffer copy-buf
9834               (gnus-request-article-this-buffer article gnus-newsgroup-name)
9835               (nnheader-replace-header "Xref" new-xref)
9836               (gnus-request-replace-article
9837                article gnus-newsgroup-name (current-buffer) t)))
9838
9839           ;; run the move/copy/crosspost/respool hook
9840           (run-hook-with-args 'gnus-summary-article-move-hook
9841                               action
9842                               (gnus-data-header
9843                                (assoc article (gnus-data-list nil)))
9844                               gnus-newsgroup-name
9845                               to-newsgroup
9846                               select-method))
9847
9848         ;;;!!!Why is this necessary?
9849         (set-buffer gnus-summary-buffer)
9850
9851         (when (eq action 'move)
9852           (save-excursion
9853             (gnus-summary-goto-subject article)
9854             (gnus-summary-mark-article article gnus-canceled-mark)))))
9855       (push article articles-to-update-marks))
9856
9857     (save-excursion
9858       (apply 'gnus-summary-remove-process-mark articles-to-update-marks))
9859     ;; Re-activate all groups that have been moved to.
9860     (with-current-buffer gnus-group-buffer
9861       (let ((gnus-group-marked to-groups))
9862         (gnus-group-get-new-news-this-group nil t)))
9863
9864     (gnus-kill-buffer copy-buf)
9865     (gnus-summary-position-point)
9866     (gnus-set-mode-line 'summary)))
9867
9868 (defun gnus-summary-copy-article (&optional n to-newsgroup select-method)
9869   "Copy the current article to some other group.
9870 If TO-NEWSGROUP is string, do not prompt for a newsgroup to copy to.
9871 When called interactively, if TO-NEWSGROUP is nil, use the value of
9872 the variable `gnus-move-split-methods' for finding a default target
9873 newsgroup.
9874 If SELECT-METHOD is non-nil, do not move to a specific newsgroup, but
9875 re-spool using this method."
9876   (interactive "P")
9877   (gnus-summary-move-article n to-newsgroup select-method 'copy))
9878
9879 (defun gnus-summary-crosspost-article (&optional n)
9880   "Crosspost the current article to some other group."
9881   (interactive "P")
9882   (gnus-summary-move-article n nil nil 'crosspost))
9883
9884 (defcustom gnus-summary-respool-default-method nil
9885   "Default method type for respooling an article.
9886 If nil, use to the current newsgroup method."
9887   :type 'symbol
9888   :group 'gnus-summary-mail)
9889
9890 (defun gnus-summary-respool-article (&optional n method)
9891   "Respool the current article.
9892 The article will be squeezed through the mail spooling process again,
9893 which means that it will be put in some mail newsgroup or other
9894 depending on `nnmail-split-methods'.
9895 If N is a positive number, respool the N next articles.
9896 If N is a negative number, respool the N previous articles.
9897 If N is nil and any articles have been marked with the process mark,
9898 respool those articles instead.
9899
9900 Respooling can be done both from mail groups and \"real\" newsgroups.
9901 In the former case, the articles in question will be moved from the
9902 current group into whatever groups they are destined to.  In the
9903 latter case, they will be copied into the relevant groups."
9904   (interactive
9905    (list current-prefix-arg
9906          (let* ((methods (gnus-methods-using 'respool))
9907                 (methname
9908                  (symbol-name (or gnus-summary-respool-default-method
9909                                   (car (gnus-find-method-for-group
9910                                         gnus-newsgroup-name)))))
9911                 (method
9912                  (gnus-completing-read-with-default
9913                   methname "Backend to use when respooling"
9914                   methods nil t nil 'gnus-mail-method-history))
9915                 ms)
9916            (cond
9917             ((zerop (length (setq ms (gnus-servers-using-backend
9918                                       (intern method)))))
9919              (list (intern method) ""))
9920             ((= 1 (length ms))
9921              (car ms))
9922             (t
9923              (let ((ms-alist (mapcar (lambda (m) (cons (cadr m) m)) ms)))
9924                (cdr (assoc (completing-read "Server name: " ms-alist nil t)
9925                            ms-alist))))))))
9926   (unless method
9927     (error "No method given for respooling"))
9928   (if (assoc (symbol-name
9929               (car (gnus-find-method-for-group gnus-newsgroup-name)))
9930              (gnus-methods-using 'respool))
9931       (gnus-summary-move-article n nil method)
9932     (gnus-summary-copy-article n nil method)))
9933
9934 (defun gnus-summary-import-article (file &optional edit)
9935   "Import an arbitrary file into a mail newsgroup."
9936   (interactive "fImport file: \nP")
9937   (let ((group gnus-newsgroup-name)
9938         (now (current-time))
9939         atts lines group-art)
9940     (unless (gnus-check-backend-function 'request-accept-article group)
9941       (error "%s does not support article importing" group))
9942     (or (file-readable-p file)
9943         (not (file-regular-p file))
9944         (error "Can't read %s" file))
9945     (with-current-buffer (gnus-get-buffer-create " *import file*")
9946       (erase-buffer)
9947       (nnheader-insert-file-contents file)
9948       (goto-char (point-min))
9949       (if (nnheader-article-p)
9950           (save-restriction
9951             (goto-char (point-min))
9952             (search-forward "\n\n" nil t)
9953             (narrow-to-region (point-min) (1- (point)))
9954             (goto-char (point-min))
9955             (unless (re-search-forward "^date:" nil t)
9956               (goto-char (point-max))
9957               (insert "Date: " (message-make-date (nth 5 atts)) "\n")))
9958        ;; This doesn't look like an article, so we fudge some headers.
9959         (setq atts (file-attributes file)
9960               lines (count-lines (point-min) (point-max)))
9961         (insert "From: " (read-string "From: ") "\n"
9962                 "Subject: " (read-string "Subject: ") "\n"
9963                 "Date: " (message-make-date (nth 5 atts)) "\n"
9964                 "Message-ID: " (message-make-message-id) "\n"
9965                 "Lines: " (int-to-string lines) "\n"
9966                 "Chars: " (int-to-string (nth 7 atts)) "\n\n"))
9967       (setq group-art (gnus-request-accept-article group nil t))
9968       (kill-buffer (current-buffer)))
9969     (setq gnus-newsgroup-active (gnus-activate-group group))
9970     (forward-line 1)
9971     (gnus-summary-goto-article (cdr group-art) nil t)
9972     (when edit
9973       (gnus-summary-edit-article))))
9974
9975 (defun gnus-summary-create-article ()
9976   "Create an article in a mail newsgroup."
9977   (interactive)
9978   (let ((group gnus-newsgroup-name)
9979         (now (current-time))
9980         group-art)
9981     (unless (gnus-check-backend-function 'request-accept-article group)
9982       (error "%s does not support article importing" group))
9983     (with-current-buffer (gnus-get-buffer-create " *import file*")
9984       (erase-buffer)
9985       (goto-char (point-min))
9986       ;; This doesn't look like an article, so we fudge some headers.
9987       (insert "From: " (read-string "From: ") "\n"
9988               "Subject: " (read-string "Subject: ") "\n"
9989               "Date: " (message-make-date now) "\n"
9990               "Message-ID: " (message-make-message-id) "\n")
9991       (setq group-art (gnus-request-accept-article group nil t))
9992       (kill-buffer (current-buffer)))
9993     (setq gnus-newsgroup-active (gnus-activate-group group))
9994     (forward-line 1)
9995     (gnus-summary-goto-article (cdr group-art) nil t)
9996     (gnus-summary-edit-article)))
9997
9998 (defun gnus-summary-article-posted-p ()
9999   "Say whether the current (mail) article is available from news as well.
10000 This will be the case if the article has both been mailed and posted."
10001   (interactive)
10002   (let ((id (mail-header-references (gnus-summary-article-header)))
10003         (gnus-override-method (car (gnus-refer-article-methods))))
10004     (if (gnus-request-head id "")
10005         (gnus-message 2 "The current message was found on %s"
10006                       gnus-override-method)
10007       (gnus-message 2 "The current message couldn't be found on %s"
10008                     gnus-override-method)
10009       nil)))
10010
10011 (defun gnus-summary-expire-articles (&optional now)
10012   "Expire all articles that are marked as expirable in the current group."
10013   (interactive)
10014   (when (and (not gnus-group-is-exiting-without-update-p)
10015              (gnus-check-backend-function
10016               'request-expire-articles gnus-newsgroup-name))
10017     ;; This backend supports expiry.
10018     (let* ((total (gnus-group-total-expirable-p gnus-newsgroup-name))
10019            (expirable (if total
10020                           (progn
10021                             ;; We need to update the info for
10022                             ;; this group for `gnus-list-of-read-articles'
10023                             ;; to give us the right answer.
10024                             (gnus-run-hooks 'gnus-exit-group-hook)
10025                             (gnus-summary-update-info)
10026                             (gnus-list-of-read-articles gnus-newsgroup-name))
10027                         (setq gnus-newsgroup-expirable
10028                               (sort gnus-newsgroup-expirable '<))))
10029            (expiry-wait (if now 'immediate
10030                           (gnus-group-find-parameter
10031                            gnus-newsgroup-name 'expiry-wait)))
10032            (nnmail-expiry-target
10033             (or (gnus-group-find-parameter gnus-newsgroup-name 'expiry-target)
10034                 nnmail-expiry-target))
10035            es)
10036       (when expirable
10037         ;; There are expirable articles in this group, so we run them
10038         ;; through the expiry process.
10039         (gnus-message 6 "Expiring articles...")
10040         (unless (gnus-check-group gnus-newsgroup-name)
10041           (error "Can't open server for %s" gnus-newsgroup-name))
10042         ;; The list of articles that weren't expired is returned.
10043         (save-excursion
10044           (if expiry-wait
10045               (let ((nnmail-expiry-wait-function nil)
10046                     (nnmail-expiry-wait expiry-wait))
10047                 (setq es (gnus-request-expire-articles
10048                           expirable gnus-newsgroup-name)))
10049             (setq es (gnus-request-expire-articles
10050                       expirable gnus-newsgroup-name)))
10051           (unless total
10052             (setq gnus-newsgroup-expirable es))
10053           ;; We go through the old list of expirable, and mark all
10054           ;; really expired articles as nonexistent.
10055           (unless (eq es expirable) ;If nothing was expired, we don't mark.
10056             (let ((gnus-use-cache nil))
10057               (dolist (article expirable)
10058                 (when (and (not (memq article es))
10059                            (gnus-data-find article))
10060                   (gnus-summary-mark-article article gnus-canceled-mark)
10061                   (run-hook-with-args 'gnus-summary-article-expire-hook
10062                                       'delete
10063                                       (gnus-data-header
10064                                        (assoc article (gnus-data-list nil)))
10065                                       gnus-newsgroup-name
10066                                       nil
10067                                       nil))))))
10068         (gnus-message 6 "Expiring articles...done")))))
10069
10070 (defun gnus-summary-expire-articles-now ()
10071   "Expunge all expirable articles in the current group.
10072 This means that *all* articles that are marked as expirable will be
10073 deleted forever, right now."
10074   (interactive)
10075   (or gnus-expert-user
10076       (gnus-yes-or-no-p
10077        "Are you really, really sure you want to delete all expirable messages? ")
10078       (error "Phew!"))
10079   (gnus-summary-expire-articles t))
10080
10081 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
10082 (defun gnus-summary-delete-article (&optional n)
10083   "Delete the N next (mail) articles.
10084 This command actually deletes articles.  This is not a marking
10085 command.  The article will disappear forever from your life, never to
10086 return.
10087
10088 If N is negative, delete backwards.
10089 If N is nil and articles have been marked with the process mark,
10090 delete these instead.
10091
10092 If `gnus-novice-user' is non-nil you will be asked for
10093 confirmation before the articles are deleted."
10094   (interactive "P")
10095   (unless (gnus-check-backend-function 'request-expire-articles
10096                                        gnus-newsgroup-name)
10097     (error "The current newsgroup does not support article deletion"))
10098   (unless (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
10099     (error "Couldn't open server"))
10100   ;; Compute the list of articles to delete.
10101   (let ((articles (sort (copy-sequence (gnus-summary-work-articles n)) '<))
10102         (nnmail-expiry-target 'delete)
10103         not-deleted)
10104     (if (and gnus-novice-user
10105              (not (gnus-yes-or-no-p
10106                    (format "Do you really want to delete %s forever? "
10107                            (if (> (length articles) 1)
10108                                (format "these %s articles" (length articles))
10109                              "this article")))))
10110         ()
10111       ;; Delete the articles.
10112       (setq not-deleted (gnus-request-expire-articles
10113                          articles gnus-newsgroup-name 'force))
10114       (save-excursion
10115         (while articles
10116           (gnus-summary-remove-process-mark (car articles))
10117           ;; The backend might not have been able to delete the article
10118           ;; after all.
10119           (unless (memq (car articles) not-deleted)
10120             (gnus-summary-mark-article (car articles) gnus-canceled-mark))
10121           (let* ((article (car articles))
10122                  (ghead  (gnus-data-header
10123                           (assoc article (gnus-data-list nil)))))
10124             (run-hook-with-args 'gnus-summary-article-delete-hook
10125                                 'delete ghead gnus-newsgroup-name nil
10126                                 nil))
10127           (setq articles (cdr articles))))
10128       (when not-deleted
10129         (gnus-message 4 "Couldn't delete articles %s" not-deleted)))
10130     (gnus-summary-position-point)
10131     (gnus-set-mode-line 'summary)
10132     not-deleted))
10133
10134 (defun gnus-summary-edit-article (&optional arg)
10135   "Edit the current article.
10136 This will have permanent effect only in mail groups.
10137 If ARG is nil, edit the decoded articles.
10138 If ARG is 1, edit the raw articles.
10139 If ARG is 2, edit the raw articles even in read-only groups.
10140 If ARG is 3, edit the articles with the current handles.
10141 Otherwise, allow editing of articles even in read-only
10142 groups."
10143   (interactive "P")
10144   (let (force raw current-handles)
10145     (cond
10146      ((null arg))
10147      ((eq arg 1)
10148       (setq raw t))
10149      ((eq arg 2)
10150       (setq raw t
10151             force t))
10152      ((eq arg 3)
10153       (setq current-handles
10154             (and (gnus-buffer-live-p gnus-article-buffer)
10155                  (with-current-buffer gnus-article-buffer
10156                    (prog1
10157                        gnus-article-mime-handles
10158                      (setq gnus-article-mime-handles nil))))))
10159      (t
10160       (setq force t)))
10161     (when (and raw (not force)
10162                (member gnus-newsgroup-name '("nndraft:delayed"
10163                                              "nndraft:drafts"
10164                                              "nndraft:queue")))
10165       (error "Can't edit the raw article in group %s"
10166              gnus-newsgroup-name))
10167     (with-current-buffer gnus-summary-buffer
10168       (let ((mail-parse-charset gnus-newsgroup-charset)
10169             (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets))
10170         (gnus-set-global-variables)
10171         (when (and (not force)
10172                    (gnus-group-read-only-p))
10173           (error "The current newsgroup does not support article editing"))
10174         (gnus-summary-show-article t)
10175         (when (and (not raw) (gnus-buffer-live-p gnus-article-buffer))
10176           (with-current-buffer gnus-article-buffer
10177             (mm-enable-multibyte)))
10178         (if (member gnus-newsgroup-name '("nndraft:delayed" "nndraft:drafts"))
10179             (setq raw t))
10180         (gnus-article-edit-article
10181          (if raw 'ignore
10182            `(lambda ()
10183               (let ((mbl mml-buffer-list))
10184                 (setq mml-buffer-list nil)
10185                 (let ((rfc2047-quote-decoded-words-containing-tspecials t))
10186                   (mime-to-mml ,'current-handles))
10187                 (let ((mbl1 mml-buffer-list))
10188                   (setq mml-buffer-list mbl)
10189                   (set (make-local-variable 'mml-buffer-list) mbl1))
10190                 (gnus-make-local-hook 'kill-buffer-hook)
10191                 (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t))))
10192          `(lambda (no-highlight)
10193             (let ((mail-parse-charset ',gnus-newsgroup-charset)
10194                   (message-options message-options)
10195                   (message-options-set-recipient)
10196                   (mail-parse-ignored-charsets
10197                    ',gnus-newsgroup-ignored-charsets)
10198                   (rfc2047-header-encoding-alist
10199                    ',(let ((charset (gnus-group-name-charset
10200                                      (gnus-find-method-for-group
10201                                       gnus-newsgroup-name)
10202                                      gnus-newsgroup-name)))
10203                        (append (list (cons "Newsgroups" charset)
10204                                      (cons "Followup-To" charset)
10205                                      (cons "Xref" charset))
10206                                rfc2047-header-encoding-alist))))
10207               ,(if (not raw) '(progn
10208                                 (mml-to-mime)
10209                                 (mml-destroy-buffers)
10210                                 (remove-hook 'kill-buffer-hook
10211                                              'mml-destroy-buffers t)
10212                                 (kill-local-variable 'mml-buffer-list)))
10213               (gnus-summary-edit-article-done
10214                ,(or (mail-header-references gnus-current-headers) "")
10215                ,(gnus-group-read-only-p)
10216                ,gnus-summary-buffer no-highlight))))))))
10217
10218 (defalias 'gnus-summary-edit-article-postpone 'gnus-article-edit-exit)
10219
10220 (defun gnus-summary-edit-article-done (&optional references read-only buffer
10221                                                  no-highlight)
10222   "Make edits to the current article permanent."
10223   (interactive)
10224   (save-excursion
10225    ;; The buffer restriction contains the entire article if it exists.
10226     (when (article-goto-body)
10227       (let ((lines (count-lines (point) (point-max)))
10228             (length (- (point-max) (point)))
10229             (case-fold-search t)
10230             (body (copy-marker (point))))
10231         (goto-char (point-min))
10232         (when (re-search-forward "^content-length:[ \t]\\([0-9]+\\)" body t)
10233           (delete-region (match-beginning 1) (match-end 1))
10234           (insert (number-to-string length)))
10235         (goto-char (point-min))
10236         (when (re-search-forward
10237                "^x-content-length:[ \t]\\([0-9]+\\)" body t)
10238           (delete-region (match-beginning 1) (match-end 1))
10239           (insert (number-to-string length)))
10240         (goto-char (point-min))
10241         (when (re-search-forward "^lines:[ \t]\\([0-9]+\\)" body t)
10242           (delete-region (match-beginning 1) (match-end 1))
10243           (insert (number-to-string lines))))))
10244   ;; Replace the article.
10245   (let ((buf (current-buffer)))
10246     (with-temp-buffer
10247       (insert-buffer-substring buf)
10248
10249       (if (and (not read-only)
10250                (not (gnus-request-replace-article
10251                      (cdr gnus-article-current) (car gnus-article-current)
10252                      (current-buffer) t)))
10253           (error "Couldn't replace article")
10254         ;; Update the summary buffer.
10255         (if (and references
10256                  (equal (message-tokenize-header references " ")
10257                         (message-tokenize-header
10258                          (or (message-fetch-field "references") "") " ")))
10259             ;; We only have to update this line.
10260             (save-excursion
10261               (save-restriction
10262                 (message-narrow-to-head)
10263                 (let ((head (buffer-substring-no-properties
10264                              (point-min) (point-max)))
10265                       header)
10266                   (with-temp-buffer
10267                     (insert (format "211 %d Article retrieved.\n"
10268                                     (cdr gnus-article-current)))
10269                     (insert head)
10270                     (insert ".\n")
10271                     (let ((nntp-server-buffer (current-buffer)))
10272                       (setq header (car (gnus-get-newsgroup-headers
10273                                          nil t))))
10274                     (with-current-buffer gnus-summary-buffer
10275                       (gnus-data-set-header
10276                        (gnus-data-find (cdr gnus-article-current))
10277                        header)
10278                       (gnus-summary-update-article-line
10279                        (cdr gnus-article-current) header)
10280                       (if (gnus-summary-goto-subject
10281                            (cdr gnus-article-current) nil t)
10282                           (gnus-summary-update-secondary-mark
10283                            (cdr gnus-article-current))))))))
10284           ;; Update threads.
10285           (set-buffer (or buffer gnus-summary-buffer))
10286           (gnus-summary-update-article (cdr gnus-article-current))
10287           (if (gnus-summary-goto-subject (cdr gnus-article-current) nil t)
10288               (gnus-summary-update-secondary-mark
10289                (cdr gnus-article-current))))
10290         ;; Prettify the article buffer again.
10291         (unless no-highlight
10292           (with-current-buffer gnus-article-buffer
10293             ;;;!!! Fix this -- article should be rehighlighted.
10294             ;;;(gnus-run-hooks 'gnus-article-display-hook)
10295             (set-buffer gnus-original-article-buffer)
10296             (gnus-request-article
10297              (cdr gnus-article-current)
10298              (car gnus-article-current) (current-buffer))))
10299         ;; Prettify the summary buffer line.
10300         (when (gnus-visual-p 'summary-highlight 'highlight)
10301           (gnus-run-hooks 'gnus-visual-mark-article-hook))))))
10302
10303 (defun gnus-summary-edit-wash (key)
10304   "Perform editing command KEY in the article buffer."
10305   (interactive
10306    (list
10307     (progn
10308       (message "%s" (concat (this-command-keys) "- "))
10309       (read-char))))
10310   (message "")
10311   (gnus-summary-edit-article)
10312   (execute-kbd-macro (concat (this-command-keys) key))
10313   (gnus-article-edit-done))
10314
10315 ;;; Respooling
10316
10317 (defun gnus-summary-respool-query (&optional silent trace)
10318   "Query where the respool algorithm would put this article."
10319   (interactive)
10320   (let (gnus-mark-article-hook)
10321     (gnus-summary-select-article)
10322     (with-current-buffer gnus-original-article-buffer
10323       (let ((groups (nnmail-article-group 'identity trace)))
10324         (unless silent
10325           (if groups
10326               (message "This message would go to %s"
10327                        (mapconcat 'car groups ", "))
10328             (message "This message would go to no groups"))
10329           groups)))))
10330
10331 (defun gnus-summary-respool-trace ()
10332   "Trace where the respool algorithm would put this article.
10333 Display a buffer showing all fancy splitting patterns which matched."
10334   (interactive)
10335   (gnus-summary-respool-query nil t))
10336
10337 ;; Summary marking commands.
10338
10339 (defun gnus-summary-kill-same-subject-and-select (&optional unmark)
10340   "Mark articles which has the same subject as read, and then select the next.
10341 If UNMARK is positive, remove any kind of mark.
10342 If UNMARK is negative, tick articles."
10343   (interactive "P")
10344   (when unmark
10345     (setq unmark (prefix-numeric-value unmark)))
10346   (let ((count
10347          (gnus-summary-mark-same-subject
10348           (gnus-summary-article-subject) unmark)))
10349     ;; Select next unread article.  If auto-select-same mode, should
10350     ;; select the first unread article.
10351     (gnus-summary-next-article t (and gnus-auto-select-same
10352                                       (gnus-summary-article-subject)))
10353     (gnus-message 7 "%d article%s marked as %s"
10354                   count (if (= count 1) " is" "s are")
10355                   (if unmark "unread" "read"))))
10356
10357 (defun gnus-summary-kill-same-subject (&optional unmark)
10358   "Mark articles which has the same subject as read.
10359 If UNMARK is positive, remove any kind of mark.
10360 If UNMARK is negative, tick articles."
10361   (interactive "P")
10362   (when unmark
10363     (setq unmark (prefix-numeric-value unmark)))
10364   (let ((count
10365          (gnus-summary-mark-same-subject
10366           (gnus-summary-article-subject) unmark)))
10367     ;; If marked as read, go to next unread subject.
10368     (when (null unmark)
10369       ;; Go to next unread subject.
10370       (gnus-summary-next-subject 1 t))
10371     (gnus-message 7 "%d articles are marked as %s"
10372                   count (if unmark "unread" "read"))))
10373
10374 (defun gnus-summary-mark-same-subject (subject &optional unmark)
10375   "Mark articles with same SUBJECT as read, and return marked number.
10376 If optional argument UNMARK is positive, remove any kinds of marks.
10377 If optional argument UNMARK is negative, mark articles as unread instead."
10378   (let ((count 1))
10379     (save-excursion
10380       (cond
10381        ((null unmark)                   ; Mark as read.
10382         (while (and
10383                 (progn
10384                   (gnus-summary-mark-article-as-read gnus-killed-mark)
10385                   (gnus-summary-show-thread) t)
10386                 (gnus-summary-find-subject subject))
10387           (setq count (1+ count))))
10388        ((> unmark 0)                    ; Tick.
10389         (while (and
10390                 (progn
10391                   (gnus-summary-mark-article-as-unread gnus-ticked-mark)
10392                   (gnus-summary-show-thread) t)
10393                 (gnus-summary-find-subject subject))
10394           (setq count (1+ count))))
10395        (t                               ; Mark as unread.
10396         (while (and
10397                 (progn
10398                   (gnus-summary-mark-article-as-unread gnus-unread-mark)
10399                   (gnus-summary-show-thread) t)
10400                 (gnus-summary-find-subject subject))
10401           (setq count (1+ count)))))
10402       (gnus-set-mode-line 'summary)
10403       ;; Return the number of marked articles.
10404       count)))
10405
10406 (defun gnus-summary-mark-as-processable (n &optional unmark)
10407   "Set the process mark on the next N articles.
10408 If N is negative, mark backward instead.  If UNMARK is non-nil, remove
10409 the process mark instead.  The difference between N and the actual
10410 number of articles marked is returned."
10411   (interactive "P")
10412   (if (and (null n) (gnus-region-active-p))
10413       (gnus-uu-mark-region (region-beginning) (region-end) unmark)
10414     (setq n (prefix-numeric-value n))
10415     (let ((backward (< n 0))
10416           (n (abs n)))
10417       (while (and
10418               (> n 0)
10419               (if unmark
10420                   (gnus-summary-remove-process-mark
10421                    (gnus-summary-article-number))
10422                 (gnus-summary-set-process-mark (gnus-summary-article-number)))
10423               (zerop (gnus-summary-next-subject (if backward -1 1) nil t)))
10424         (setq n (1- n)))
10425       (when (/= 0 n)
10426         (gnus-message 7 "No more articles"))
10427       (gnus-summary-recenter)
10428       (gnus-summary-position-point)
10429       n)))
10430
10431 (defun gnus-summary-unmark-as-processable (n)
10432   "Remove the process mark from the next N articles.
10433 If N is negative, unmark backward instead.  The difference between N and
10434 the actual number of articles unmarked is returned."
10435   (interactive "P")
10436   (gnus-summary-mark-as-processable n t))
10437
10438 (defun gnus-summary-unmark-all-processable ()
10439   "Remove the process mark from all articles."
10440   (interactive)
10441   (save-excursion
10442     (while gnus-newsgroup-processable
10443       (gnus-summary-remove-process-mark (car gnus-newsgroup-processable))))
10444   (gnus-summary-position-point))
10445
10446 (defun gnus-summary-add-mark (article type)
10447   "Mark ARTICLE with a mark of TYPE."
10448   (let ((vtype (car (assq type gnus-article-mark-lists)))
10449         var)
10450     (if (not vtype)
10451         (error "No such mark type: %s" type)
10452       (setq var (intern (format "gnus-newsgroup-%s" type)))
10453       (set var (cons article (symbol-value var)))
10454       (if (memq type '(processable cached replied forwarded recent saved))
10455           (gnus-summary-update-secondary-mark article)
10456         ;;; !!! This is bogus.  We should find out what primary
10457         ;;; !!! mark we want to set.
10458         (gnus-summary-update-mark gnus-del-mark 'unread)))))
10459
10460 (defun gnus-summary-mark-as-expirable (n)
10461   "Mark N articles forward as expirable.
10462 If N is negative, mark backward instead.  The difference between N and
10463 the actual number of articles marked is returned."
10464   (interactive "p")
10465   (gnus-summary-mark-forward n gnus-expirable-mark))
10466
10467 (defun gnus-summary-mark-as-spam (n)
10468   "Mark N articles forward as spam.
10469 If N is negative, mark backward instead.  The difference between N and
10470 the actual number of articles marked is returned."
10471   (interactive "p")
10472   (gnus-summary-mark-forward n gnus-spam-mark))
10473
10474 (defun gnus-summary-mark-article-as-replied (article)
10475   "Mark ARTICLE as replied to and update the summary line.
10476 ARTICLE can also be a list of articles."
10477   (interactive (list (gnus-summary-article-number)))
10478   (let ((articles (if (listp article) article (list article))))
10479     (dolist (article articles)
10480       (unless (numberp article)
10481         (error "%s is not a number" article))
10482       (push article gnus-newsgroup-replied)
10483       (let ((inhibit-read-only t))
10484         (when (gnus-summary-goto-subject article nil t)
10485           (gnus-summary-update-secondary-mark article))))))
10486
10487 (defun gnus-summary-mark-article-as-forwarded (article)
10488   "Mark ARTICLE as forwarded and update the summary line.
10489 ARTICLE can also be a list of articles."
10490   (let ((articles (if (listp article) article (list article))))
10491     (dolist (article articles)
10492       (push article gnus-newsgroup-forwarded)
10493       (let ((inhibit-read-only t))
10494         (when (gnus-summary-goto-subject article nil t)
10495           (gnus-summary-update-secondary-mark article))))))
10496
10497 (defun gnus-summary-set-bookmark (article)
10498   "Set a bookmark in current article."
10499   (interactive (list (gnus-summary-article-number)))
10500   (when (or (not (get-buffer gnus-article-buffer))
10501             (not gnus-current-article)
10502             (not gnus-article-current)
10503             (not (equal gnus-newsgroup-name (car gnus-article-current))))
10504     (error "No current article selected"))
10505   ;; Remove old bookmark, if one exists.
10506   (gnus-pull article gnus-newsgroup-bookmarks)
10507   ;; Set the new bookmark, which is on the form
10508   ;; (article-number . line-number-in-body).
10509   (push
10510    (cons article
10511          (with-current-buffer gnus-article-buffer
10512            (count-lines
10513             (min (point)
10514                  (save-excursion
10515                    (article-goto-body)
10516                    (point)))
10517             (point))))
10518    gnus-newsgroup-bookmarks)
10519   (gnus-message 6 "A bookmark has been added to the current article."))
10520
10521 (defun gnus-summary-remove-bookmark (article)
10522   "Remove the bookmark from the current article."
10523   (interactive (list (gnus-summary-article-number)))
10524   ;; Remove old bookmark, if one exists.
10525   (if (not (assq article gnus-newsgroup-bookmarks))
10526       (gnus-message 6 "No bookmark in current article.")
10527     (gnus-pull article gnus-newsgroup-bookmarks)
10528     (gnus-message 6 "Removed bookmark.")))
10529
10530 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
10531 (defun gnus-summary-mark-as-dormant (n)
10532   "Mark N articles forward as dormant.
10533 If N is negative, mark backward instead.  The difference between N and
10534 the actual number of articles marked is returned."
10535   (interactive "p")
10536   (gnus-summary-mark-forward n gnus-dormant-mark))
10537
10538 (defun gnus-summary-set-process-mark (article)
10539   "Set the process mark on ARTICLE and update the summary line."
10540   (setq gnus-newsgroup-processable
10541         (cons article
10542               (delq article gnus-newsgroup-processable)))
10543   (when (gnus-summary-goto-subject article)
10544     (gnus-summary-show-thread)
10545     (gnus-summary-goto-subject article)
10546     (gnus-summary-update-secondary-mark article)))
10547
10548 (defun gnus-summary-remove-process-mark (&rest articles)
10549   "Remove the process mark from ARTICLES and update the summary line."
10550   (dolist (article articles)
10551     (setq gnus-newsgroup-processable (delq article gnus-newsgroup-processable))
10552     (when (gnus-summary-goto-subject article)
10553       (gnus-summary-show-thread)
10554       (gnus-summary-goto-subject article)
10555       (gnus-summary-update-secondary-mark article)))
10556   t)
10557
10558 (defun gnus-summary-set-saved-mark (article)
10559   "Set the process mark on ARTICLE and update the summary line."
10560   (push article gnus-newsgroup-saved)
10561   (when (gnus-summary-goto-subject article)
10562     (gnus-summary-update-secondary-mark article)))
10563
10564 (defun gnus-summary-mark-forward (n &optional mark no-expire)
10565   "Mark N articles as read forwards.
10566 If N is negative, mark backwards instead.  Mark with MARK, ?r by default.
10567 The difference between N and the actual number of articles marked is
10568 returned.
10569 If NO-EXPIRE, auto-expiry will be inhibited."
10570   (interactive "p")
10571   (gnus-summary-show-thread)
10572   (let ((backward (< n 0))
10573         (gnus-summary-goto-unread
10574          (and gnus-summary-goto-unread
10575               (not (eq gnus-summary-goto-unread 'never))
10576               (not (memq mark (list gnus-unread-mark gnus-spam-mark
10577                                     gnus-ticked-mark gnus-dormant-mark)))))
10578         (n (abs n))
10579         (mark (or mark gnus-del-mark)))
10580     (while (and (> n 0)
10581                 (gnus-summary-mark-article nil mark no-expire)
10582                 (zerop (gnus-summary-next-subject
10583                         (if backward -1 1)
10584                         (and gnus-summary-goto-unread
10585                              (not (eq gnus-summary-goto-unread 'never)))
10586                         t)))
10587       (setq n (1- n)))
10588     (when (/= 0 n)
10589       (gnus-message 7 "No more %sarticles" (if mark "" "unread ")))
10590     (gnus-summary-recenter)
10591     (gnus-summary-position-point)
10592     (gnus-set-mode-line 'summary)
10593     n))
10594
10595 (defun gnus-summary-mark-article-as-read (mark)
10596   "Mark the current article quickly as read with MARK."
10597   (let ((article (gnus-summary-article-number)))
10598     (setq gnus-newsgroup-unreads (delq article gnus-newsgroup-unreads))
10599     (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked))
10600     (setq gnus-newsgroup-spam-marked (delq article gnus-newsgroup-spam-marked))
10601     (setq gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant))
10602     (push (cons article mark) gnus-newsgroup-reads)
10603     ;; Possibly remove from cache, if that is used.
10604     (when gnus-use-cache
10605       (gnus-cache-enter-remove-article article))
10606     ;; Allow the backend to change the mark.
10607     (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10608     ;; Check for auto-expiry.
10609     (when (and gnus-newsgroup-auto-expire
10610                (memq mark gnus-auto-expirable-marks))
10611       (setq mark gnus-expirable-mark)
10612       ;; Let the backend know about the mark change.
10613       (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10614       (push article gnus-newsgroup-expirable))
10615     ;; Set the mark in the buffer.
10616     (gnus-summary-update-mark mark 'unread)
10617     t))
10618
10619 (defun gnus-summary-mark-article-as-unread (mark)
10620   "Mark the current article quickly as unread with MARK."
10621   (let* ((article (gnus-summary-article-number))
10622          (old-mark (gnus-summary-article-mark article)))
10623     ;; Allow the backend to change the mark.
10624     (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10625     (if (eq mark old-mark)
10626         t
10627       (if (<= article 0)
10628           (progn
10629             (gnus-error 1 "Can't mark negative article numbers")
10630             nil)
10631         (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked))
10632         (setq gnus-newsgroup-spam-marked
10633               (delq article gnus-newsgroup-spam-marked))
10634         (setq gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant))
10635         (setq gnus-newsgroup-expirable (delq article gnus-newsgroup-expirable))
10636         (setq gnus-newsgroup-reads (delq article gnus-newsgroup-reads))
10637         (cond ((= mark gnus-ticked-mark)
10638                (setq gnus-newsgroup-marked
10639                      (gnus-add-to-sorted-list gnus-newsgroup-marked
10640                                               article)))
10641               ((= mark gnus-spam-mark)
10642                (setq gnus-newsgroup-spam-marked
10643                      (gnus-add-to-sorted-list gnus-newsgroup-spam-marked
10644                                               article)))
10645               ((= mark gnus-dormant-mark)
10646                (setq gnus-newsgroup-dormant
10647                      (gnus-add-to-sorted-list gnus-newsgroup-dormant
10648                                               article)))
10649               (t
10650                (setq gnus-newsgroup-unreads
10651                      (gnus-add-to-sorted-list gnus-newsgroup-unreads
10652                                               article))))
10653         (gnus-pull article gnus-newsgroup-reads)
10654
10655         ;; See whether the article is to be put in the cache.
10656         (and gnus-use-cache
10657              (vectorp (gnus-summary-article-header article))
10658              (save-excursion
10659                (gnus-cache-possibly-enter-article
10660                 gnus-newsgroup-name article
10661                 (= mark gnus-ticked-mark)
10662                 (= mark gnus-dormant-mark) (= mark gnus-unread-mark))))
10663
10664         ;; Fix the mark.
10665         (gnus-summary-update-mark mark 'unread)
10666         t))))
10667
10668 (defun gnus-summary-mark-article (&optional article mark no-expire)
10669   "Mark ARTICLE with MARK.  MARK can be any character.
10670 Four MARK strings are reserved: `? ' (unread), `?!' (ticked),
10671 `??' (dormant) and `?E' (expirable).
10672 If MARK is nil, then the default character `?r' is used.
10673 If ARTICLE is nil, then the article on the current line will be
10674 marked.
10675 If NO-EXPIRE, auto-expiry will be inhibited."
10676   ;; The mark might be a string.
10677   (when (stringp mark)
10678     (setq mark (aref mark 0)))
10679   ;; If no mark is given, then we check auto-expiring.
10680   (when (null mark)
10681     (setq mark gnus-del-mark))
10682   (when (and (not no-expire)
10683              gnus-newsgroup-auto-expire
10684              (memq mark gnus-auto-expirable-marks))
10685     (setq mark gnus-expirable-mark))
10686   (let ((article (or article (gnus-summary-article-number)))
10687         (old-mark (gnus-summary-article-mark article)))
10688     ;; Allow the backend to change the mark.
10689     (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10690     (if (eq mark old-mark)
10691         t
10692       (unless article
10693         (error "No article on current line"))
10694       (if (not (if (or (= mark gnus-unread-mark)
10695                        (= mark gnus-ticked-mark)
10696                        (= mark gnus-spam-mark)
10697                        (= mark gnus-dormant-mark))
10698                    (gnus-mark-article-as-unread article mark)
10699                  (gnus-mark-article-as-read article mark)))
10700           t
10701         ;; See whether the article is to be put in the cache.
10702         (and gnus-use-cache
10703              (not (= mark gnus-canceled-mark))
10704              (vectorp (gnus-summary-article-header article))
10705              (save-excursion
10706                (gnus-cache-possibly-enter-article
10707                 gnus-newsgroup-name article
10708                 (= mark gnus-ticked-mark)
10709                 (= mark gnus-dormant-mark) (= mark gnus-unread-mark))))
10710
10711         (when (gnus-summary-goto-subject article nil t)
10712           (let ((inhibit-read-only t))
10713             (gnus-summary-show-thread)
10714             ;; Fix the mark.
10715             (gnus-summary-update-mark mark 'unread)
10716             t))))))
10717
10718 (defun gnus-summary-update-secondary-mark (article)
10719   "Update the secondary (read, process, cache) mark."
10720   (gnus-summary-update-mark
10721    (cond ((memq article gnus-newsgroup-processable)
10722           gnus-process-mark)
10723          ((memq article gnus-newsgroup-cached)
10724           gnus-cached-mark)
10725          ((memq article gnus-newsgroup-replied)
10726           gnus-replied-mark)
10727          ((memq article gnus-newsgroup-forwarded)
10728           gnus-forwarded-mark)
10729          ((memq article gnus-newsgroup-saved)
10730           gnus-saved-mark)
10731          ((memq article gnus-newsgroup-recent)
10732           gnus-recent-mark)
10733          ((memq article gnus-newsgroup-unseen)
10734           gnus-unseen-mark)
10735          (t gnus-no-mark))
10736    'replied)
10737   (when (gnus-visual-p 'summary-highlight 'highlight)
10738     (gnus-run-hooks 'gnus-summary-update-hook))
10739   t)
10740
10741 (defun gnus-summary-update-download-mark (article)
10742   "Update the download mark."
10743   (gnus-summary-update-mark
10744    (cond ((memq article gnus-newsgroup-undownloaded)
10745           gnus-undownloaded-mark)
10746          (gnus-newsgroup-agentized
10747           gnus-downloaded-mark)
10748          (t
10749           gnus-no-mark))
10750    'download)
10751   (gnus-summary-update-line t)
10752   t)
10753
10754 (defun gnus-summary-update-mark (mark type)
10755   (let ((forward (cdr (assq type gnus-summary-mark-positions)))
10756         (inhibit-read-only t))
10757     (re-search-backward "[\n\r]" (point-at-bol) 'move-to-limit)
10758     (when forward
10759       (when (looking-at "\r")
10760         (incf forward))
10761       (when (<= (+ forward (point)) (point-max))
10762         ;; Go to the right position on the line.
10763         (goto-char (+ forward (point)))
10764         ;; Replace the old mark with the new mark.
10765         (subst-char-in-region (point) (1+ (point)) (char-after) mark)
10766         ;; Optionally update the marks by some user rule.
10767         (when (eq type 'unread)
10768           (gnus-data-set-mark
10769            (gnus-data-find (gnus-summary-article-number)) mark)
10770           (gnus-summary-update-line (eq mark gnus-unread-mark)))))))
10771
10772 (defun gnus-mark-article-as-read (article &optional mark)
10773   "Enter ARTICLE in the pertinent lists and remove it from others."
10774   ;; Make the article expirable.
10775   (let ((mark (or mark gnus-del-mark)))
10776     (setq gnus-newsgroup-expirable
10777           (if (= mark gnus-expirable-mark)
10778               (gnus-add-to-sorted-list gnus-newsgroup-expirable article)
10779             (delq article gnus-newsgroup-expirable)))
10780     ;; Remove from unread and marked lists.
10781     (setq gnus-newsgroup-unreads (delq article gnus-newsgroup-unreads))
10782     (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked))
10783     (setq gnus-newsgroup-spam-marked (delq article gnus-newsgroup-spam-marked))
10784     (setq gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant))
10785     (push (cons article mark) gnus-newsgroup-reads)
10786     ;; Possibly remove from cache, if that is used.
10787     (when gnus-use-cache
10788       (gnus-cache-enter-remove-article article))
10789     t))
10790
10791 (defun gnus-mark-article-as-unread (article &optional mark)
10792   "Enter ARTICLE in the pertinent lists and remove it from others."
10793   (let ((mark (or mark gnus-ticked-mark)))
10794     (if (<= article 0)
10795         (progn
10796           (gnus-error 1 "Can't mark negative article numbers")
10797           nil)
10798       (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked)
10799             gnus-newsgroup-spam-marked (delq article gnus-newsgroup-spam-marked)
10800             gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant)
10801             gnus-newsgroup-expirable (delq article gnus-newsgroup-expirable)
10802             gnus-newsgroup-unreads (delq article gnus-newsgroup-unreads))
10803
10804       ;; Unsuppress duplicates?
10805       (when gnus-suppress-duplicates
10806         (gnus-dup-unsuppress-article article))
10807
10808       (cond ((= mark gnus-ticked-mark)
10809              (setq gnus-newsgroup-marked
10810                    (gnus-add-to-sorted-list gnus-newsgroup-marked article)))
10811             ((= mark gnus-spam-mark)
10812              (setq gnus-newsgroup-spam-marked
10813                    (gnus-add-to-sorted-list gnus-newsgroup-spam-marked
10814                                             article)))
10815             ((= mark gnus-dormant-mark)
10816              (setq gnus-newsgroup-dormant
10817                    (gnus-add-to-sorted-list gnus-newsgroup-dormant article)))
10818             (t
10819              (setq gnus-newsgroup-unreads
10820                    (gnus-add-to-sorted-list gnus-newsgroup-unreads article))))
10821       (gnus-pull article gnus-newsgroup-reads)
10822       t)))
10823
10824 (defalias 'gnus-summary-mark-as-unread-forward
10825   'gnus-summary-tick-article-forward)
10826 (make-obsolete 'gnus-summary-mark-as-unread-forward
10827                'gnus-summary-tick-article-forward "Emacs 20.4")
10828 (defun gnus-summary-tick-article-forward (n)
10829   "Tick N articles forwards.
10830 If N is negative, tick backwards instead.
10831 The difference between N and the number of articles ticked is returned."
10832   (interactive "p")
10833   (gnus-summary-mark-forward n gnus-ticked-mark))
10834
10835 (defalias 'gnus-summary-mark-as-unread-backward
10836   'gnus-summary-tick-article-backward)
10837 (make-obsolete 'gnus-summary-mark-as-unread-backward
10838                'gnus-summary-tick-article-backward "Emacs 20.4")
10839 (defun gnus-summary-tick-article-backward (n)
10840   "Tick N articles backwards.
10841 The difference between N and the number of articles ticked is returned."
10842   (interactive "p")
10843   (gnus-summary-mark-forward (- n) gnus-ticked-mark))
10844
10845 (defalias 'gnus-summary-mark-as-unread 'gnus-summary-tick-article)
10846 (make-obsolete 'gnus-summary-mark-as-unread 'gnus-summary-tick-article "Emacs 20.4")
10847 (defun gnus-summary-tick-article (&optional article clear-mark)
10848   "Mark current article as unread.
10849 Optional 1st argument ARTICLE specifies article number to be marked as unread.
10850 Optional 2nd argument CLEAR-MARK remove any kinds of mark."
10851   (interactive)
10852   (gnus-summary-mark-article article (if clear-mark gnus-unread-mark
10853                                        gnus-ticked-mark)))
10854
10855 (defun gnus-summary-mark-as-read-forward (n)
10856   "Mark N articles as read forwards.
10857 If N is negative, mark backwards instead.
10858 The difference between N and the actual number of articles marked is
10859 returned."
10860   (interactive "p")
10861   (gnus-summary-mark-forward n gnus-del-mark gnus-inhibit-user-auto-expire))
10862
10863 (defun gnus-summary-mark-as-read-backward (n)
10864   "Mark the N articles as read backwards.
10865 The difference between N and the actual number of articles marked is
10866 returned."
10867   (interactive "p")
10868   (gnus-summary-mark-forward
10869    (- n) gnus-del-mark gnus-inhibit-user-auto-expire))
10870
10871 (defun gnus-summary-mark-as-read (&optional article mark)
10872   "Mark current article as read.
10873 ARTICLE specifies the article to be marked as read.
10874 MARK specifies a string to be inserted at the beginning of the line."
10875   (gnus-summary-mark-article article mark))
10876
10877 (defun gnus-summary-clear-mark-forward (n)
10878   "Clear marks from N articles forward.
10879 If N is negative, clear backward instead.
10880 The difference between N and the number of marks cleared is returned."
10881   (interactive "p")
10882   (gnus-summary-mark-forward n gnus-unread-mark))
10883
10884 (defun gnus-summary-clear-mark-backward (n)
10885   "Clear marks from N articles backward.
10886 The difference between N and the number of marks cleared is returned."
10887   (interactive "p")
10888   (gnus-summary-mark-forward (- n) gnus-unread-mark))
10889
10890 (defun gnus-summary-mark-unread-as-read ()
10891   "Intended to be used by `gnus-mark-article-hook'."
10892   (when (memq gnus-current-article gnus-newsgroup-unreads)
10893     (gnus-summary-mark-article gnus-current-article gnus-read-mark)))
10894
10895 (defun gnus-summary-mark-read-and-unread-as-read (&optional new-mark)
10896   "Intended to be used by `gnus-mark-article-hook'."
10897   (let ((mark (gnus-summary-article-mark)))
10898     (when (or (gnus-unread-mark-p mark)
10899               (gnus-read-mark-p mark))
10900       (gnus-summary-mark-article gnus-current-article
10901                                  (or new-mark gnus-read-mark)))))
10902
10903 (defun gnus-summary-mark-current-read-and-unread-as-read (&optional new-mark)
10904   "Intended to be used by `gnus-mark-article-hook'."
10905   (let ((mark (gnus-summary-article-mark)))
10906     (when (or (gnus-unread-mark-p mark)
10907               (gnus-read-mark-p mark))
10908       (gnus-summary-mark-article (gnus-summary-article-number)
10909                                  (or new-mark gnus-read-mark)))))
10910
10911 (defun gnus-summary-mark-unread-as-ticked ()
10912   "Intended to be used by `gnus-mark-article-hook'."
10913   (when (memq gnus-current-article gnus-newsgroup-unreads)
10914     (gnus-summary-mark-article gnus-current-article gnus-ticked-mark)))
10915
10916 (defun gnus-summary-mark-region-as-read (point mark all)
10917   "Mark all unread articles between point and mark as read.
10918 If given a prefix, mark all articles between point and mark as read,
10919 even ticked and dormant ones."
10920   (interactive "r\nP")
10921   (save-excursion
10922     (let (article)
10923       (goto-char point)
10924       (beginning-of-line)
10925       (while (and
10926               (< (point) mark)
10927               (progn
10928                 (when (or all
10929                           (memq (setq article (gnus-summary-article-number))
10930                                 gnus-newsgroup-unreads))
10931                   (gnus-summary-mark-article article gnus-del-mark))
10932                 t)
10933               (gnus-summary-find-next))))))
10934
10935 (defun gnus-summary-mark-below (score mark)
10936   "Mark articles with score less than SCORE with MARK."
10937   (interactive "P\ncMark: ")
10938   (setq score (if score
10939                   (prefix-numeric-value score)
10940                 (or gnus-summary-default-score 0)))
10941   (with-current-buffer gnus-summary-buffer
10942     (goto-char (point-min))
10943     (while
10944         (progn
10945           (and (< (gnus-summary-article-score) score)
10946                (gnus-summary-mark-article nil mark))
10947           (gnus-summary-find-next)))))
10948
10949 (defun gnus-summary-kill-below (&optional score)
10950   "Mark articles with score below SCORE as read."
10951   (interactive "P")
10952   (gnus-summary-mark-below score gnus-killed-mark))
10953
10954 (defun gnus-summary-clear-above (&optional score)
10955   "Clear all marks from articles with score above SCORE."
10956   (interactive "P")
10957   (gnus-summary-mark-above score gnus-unread-mark))
10958
10959 (defun gnus-summary-tick-above (&optional score)
10960   "Tick all articles with score above SCORE."
10961   (interactive "P")
10962   (gnus-summary-mark-above score gnus-ticked-mark))
10963
10964 (defun gnus-summary-mark-above (score mark)
10965   "Mark articles with score over SCORE with MARK."
10966   (interactive "P\ncMark: ")
10967   (setq score (if score
10968                   (prefix-numeric-value score)
10969                 (or gnus-summary-default-score 0)))
10970   (with-current-buffer gnus-summary-buffer
10971     (goto-char (point-min))
10972     (while (and (progn
10973                   (when (> (gnus-summary-article-score) score)
10974                     (gnus-summary-mark-article nil mark))
10975                   t)
10976                 (gnus-summary-find-next)))))
10977
10978 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
10979 (defalias 'gnus-summary-show-all-expunged 'gnus-summary-limit-include-expunged)
10980 (defun gnus-summary-limit-include-expunged (&optional no-error)
10981   "Display all the hidden articles that were expunged for low scores."
10982   (interactive)
10983   (let ((inhibit-read-only t))
10984     (let ((scored gnus-newsgroup-scored)
10985           headers h)
10986       (while scored
10987         (unless (gnus-summary-article-header (caar scored))
10988           (and (setq h (gnus-number-to-header (caar scored)))
10989                (< (cdar scored) gnus-summary-expunge-below)
10990                (push h headers)))
10991         (setq scored (cdr scored)))
10992       (if (not headers)
10993           (when (not no-error)
10994             (error "No expunged articles hidden"))
10995         (goto-char (point-min))
10996         (push gnus-newsgroup-limit gnus-newsgroup-limits)
10997         (setq gnus-newsgroup-limit (copy-sequence gnus-newsgroup-limit))
10998         (dolist (x headers)
10999           (push (mail-header-number x) gnus-newsgroup-limit))
11000         (gnus-summary-prepare-unthreaded (nreverse headers))
11001         (goto-char (point-min))
11002         (gnus-summary-position-point)
11003         t))))
11004
11005 (defun gnus-summary-catchup (&optional all quietly to-here not-mark reverse)
11006   "Mark all unread articles in this newsgroup as read.
11007 If prefix argument ALL is non-nil, ticked and dormant articles will
11008 also be marked as read.
11009 If QUIETLY is non-nil, no questions will be asked.
11010
11011 If TO-HERE is non-nil, it should be a point in the buffer.  All
11012 articles before (after, if REVERSE is set) this point will be marked
11013 as read.
11014
11015 Note that this function will only catch up the unread article
11016 in the current summary buffer limitation.
11017
11018 The number of articles marked as read is returned."
11019   (interactive "P")
11020   (prog1
11021       (save-excursion
11022         (when (or quietly
11023                   (not gnus-interactive-catchup) ;Without confirmation?
11024                   gnus-expert-user
11025                   (gnus-y-or-n-p
11026                    (if all
11027                        "Mark absolutely all articles as read? "
11028                      "Mark all unread articles as read? ")))
11029           (if (and not-mark
11030                    (not gnus-newsgroup-adaptive)
11031                    (not gnus-newsgroup-auto-expire)
11032                    (not gnus-suppress-duplicates)
11033                    (or (not gnus-use-cache)
11034                        (eq gnus-use-cache 'passive)))
11035               (progn
11036                 (when all
11037                   (setq gnus-newsgroup-marked nil
11038                         gnus-newsgroup-spam-marked nil
11039                         gnus-newsgroup-dormant nil))
11040                 (setq gnus-newsgroup-unreads
11041                       (gnus-sorted-nunion
11042                        (gnus-sorted-intersection gnus-newsgroup-unreads
11043                                                  gnus-newsgroup-downloadable)
11044                        (gnus-sorted-difference gnus-newsgroup-unfetched
11045                                                gnus-newsgroup-cached))))
11046             ;; We actually mark all articles as canceled, which we
11047             ;; have to do when using auto-expiry or adaptive scoring.
11048             (gnus-summary-show-all-threads)
11049             (if (and to-here reverse)
11050                 (progn
11051                   (goto-char to-here)
11052                   (gnus-summary-mark-current-read-and-unread-as-read
11053                    gnus-catchup-mark)
11054                   (while (gnus-summary-find-next (not all))
11055                     (gnus-summary-mark-article-as-read gnus-catchup-mark)))
11056               (when (gnus-summary-first-subject (not all))
11057                 (while (and
11058                         (if to-here (< (point) to-here) t)
11059                         (gnus-summary-mark-article-as-read gnus-catchup-mark)
11060                         (gnus-summary-find-next (not all))))))
11061             (gnus-set-mode-line 'summary))
11062           t))
11063     (gnus-summary-position-point)))
11064
11065 (defun gnus-summary-catchup-to-here (&optional all)
11066   "Mark all unticked articles before the current one as read.
11067 If ALL is non-nil, also mark ticked and dormant articles as read."
11068   (interactive "P")
11069   (save-excursion
11070     (gnus-save-hidden-threads
11071       (let ((beg (point)))
11072         ;; We check that there are unread articles.
11073         (when (or all (gnus-summary-find-prev))
11074           (gnus-summary-catchup all t beg)))))
11075   (gnus-summary-position-point))
11076
11077 (defun gnus-summary-catchup-from-here (&optional all)
11078   "Mark all unticked articles after (and including) the current one as read.
11079 If ALL is non-nil, also mark ticked and dormant articles as read."
11080   (interactive "P")
11081   (save-excursion
11082     (gnus-save-hidden-threads
11083       (let ((beg (point)))
11084         ;; We check that there are unread articles.
11085         (when (or all (gnus-summary-find-next))
11086           (gnus-summary-catchup all t beg nil t)))))
11087   (gnus-summary-position-point))
11088
11089 (defun gnus-summary-catchup-all (&optional quietly)
11090   "Mark all articles in this newsgroup as read.
11091 This command is dangerous.  Normally, you want \\[gnus-summary-catchup]
11092 instead, which marks only unread articles as read."
11093   (interactive "P")
11094   (gnus-summary-catchup t quietly))
11095
11096 (defun gnus-summary-catchup-and-exit (&optional all quietly)
11097   "Mark all unread articles in this group as read, then exit.
11098 If prefix argument ALL is non-nil, all articles are marked as read.
11099 If QUIETLY is non-nil, no questions will be asked."
11100   (interactive "P")
11101   (when (gnus-summary-catchup all quietly nil 'fast)
11102     ;; Select next newsgroup or exit.
11103     (if (and (not (gnus-group-quit-config gnus-newsgroup-name))
11104              (eq gnus-auto-select-next 'quietly))
11105         (gnus-summary-next-group nil)
11106       (gnus-summary-exit))))
11107
11108 (defun gnus-summary-catchup-all-and-exit (&optional quietly)
11109   "Mark all articles in this newsgroup as read, and then exit.
11110 This command is dangerous.  Normally, you want \\[gnus-summary-catchup-and-exit]
11111 instead, which marks only unread articles as read."
11112   (interactive "P")
11113   (gnus-summary-catchup-and-exit t quietly))
11114
11115 (defun gnus-summary-catchup-and-goto-next-group (&optional all)
11116   "Mark all articles in this group as read and select the next group.
11117 If given a prefix, mark all articles, unread as well as ticked, as
11118 read."
11119   (interactive "P")
11120   (save-excursion
11121     (gnus-summary-catchup all))
11122   (gnus-summary-next-group))
11123
11124 (defun gnus-summary-catchup-and-goto-prev-group (&optional all)
11125   "Mark all articles in this group as read and select the previous group.
11126 If given a prefix, mark all articles, unread as well as ticked, as
11127 read."
11128   (interactive "P")
11129   (save-excursion
11130     (gnus-summary-catchup all))
11131   (gnus-summary-next-group nil nil t))
11132
11133 ;;;
11134 ;;; with article
11135 ;;;
11136
11137 (defmacro gnus-with-article (article &rest forms)
11138   "Select ARTICLE and perform FORMS in the original article buffer.
11139 Then replace the article with the result."
11140   `(progn
11141      ;; We don't want the article to be marked as read.
11142      (let (gnus-mark-article-hook)
11143        (gnus-summary-select-article t t nil ,article))
11144      (set-buffer gnus-original-article-buffer)
11145      ,@forms
11146      (if (not (gnus-check-backend-function
11147                'request-replace-article (car gnus-article-current)))
11148          (gnus-message 5 "Read-only group; not replacing")
11149        (unless (gnus-request-replace-article
11150                 ,article (car gnus-article-current)
11151                 (current-buffer) t)
11152          (error "Couldn't replace article")))
11153      ;; The cache and backlog have to be flushed somewhat.
11154      (when gnus-keep-backlog
11155        (gnus-backlog-remove-article
11156         (car gnus-article-current) (cdr gnus-article-current)))
11157      (when gnus-use-cache
11158        (gnus-cache-update-article
11159         (car gnus-article-current) (cdr gnus-article-current)))))
11160
11161 (put 'gnus-with-article 'lisp-indent-function 1)
11162 (put 'gnus-with-article 'edebug-form-spec '(form body))
11163
11164 ;; Thread-based commands.
11165
11166 (defun gnus-summary-articles-in-thread (&optional article)
11167   "Return a list of all articles in the current thread.
11168 If ARTICLE is non-nil, return all articles in the thread that starts
11169 with that article."
11170   (let* ((article (or article (gnus-summary-article-number)))
11171          (data (gnus-data-find-list article))
11172          (top-level (gnus-data-level (car data)))
11173          (top-subject
11174           (cond ((null gnus-thread-operation-ignore-subject)
11175                  (gnus-simplify-subject-re
11176                   (mail-header-subject (gnus-data-header (car data)))))
11177                 ((eq gnus-thread-operation-ignore-subject 'fuzzy)
11178                  (gnus-simplify-subject-fuzzy
11179                   (mail-header-subject (gnus-data-header (car data)))))
11180                 (t nil)))
11181          (end-point (save-excursion
11182                       (if (gnus-summary-go-to-next-thread)
11183                           (point) (point-max))))
11184          articles)
11185     (while (and data
11186                 (< (gnus-data-pos (car data)) end-point))
11187       (when (or (not top-subject)
11188                 (string= top-subject
11189                          (if (eq gnus-thread-operation-ignore-subject 'fuzzy)
11190                              (gnus-simplify-subject-fuzzy
11191                               (mail-header-subject
11192                                (gnus-data-header (car data))))
11193                            (gnus-simplify-subject-re
11194                             (mail-header-subject
11195                              (gnus-data-header (car data)))))))
11196         (push (gnus-data-number (car data)) articles))
11197       (unless (and (setq data (cdr data))
11198                    (> (gnus-data-level (car data)) top-level))
11199         (setq data nil)))
11200     ;; Return the list of articles.
11201     (nreverse articles)))
11202
11203 (defun gnus-summary-rethread-current ()
11204   "Rethread the thread the current article is part of."
11205   (interactive)
11206   (let* ((gnus-show-threads t)
11207          (article (gnus-summary-article-number))
11208          (id (mail-header-id (gnus-summary-article-header)))
11209          (gnus-newsgroup-threads (list (gnus-id-to-thread (gnus-root-id id)))))
11210     (unless id
11211       (error "No article on the current line"))
11212     (gnus-rebuild-thread id)
11213     (gnus-summary-goto-subject article)))
11214
11215 (defun gnus-summary-reparent-thread ()
11216   "Make the current article child of the marked (or previous) article.
11217
11218 Note that the re-threading will only work if `gnus-thread-ignore-subject'
11219 is non-nil or the Subject: of both articles are the same."
11220   (interactive)
11221   (unless (not (gnus-group-read-only-p))
11222     (error "The current newsgroup does not support article editing"))
11223   (unless (<= (length gnus-newsgroup-processable) 1)
11224     (error "No more than one article may be marked"))
11225   (let ((child (gnus-summary-article-number))
11226         ;; First grab the marked article, otherwise one line up.
11227         (parent (if (not (null gnus-newsgroup-processable))
11228                     (car gnus-newsgroup-processable)
11229                   (save-excursion
11230                     (if (eq (forward-line -1) 0)
11231                         (gnus-summary-article-number)
11232                       (error "Beginning of summary buffer"))))))
11233     (gnus-summary-reparent-children parent (list child))))
11234
11235 (defun gnus-summary-reparent-children (parent children)
11236   "Make PARENT the parent of CHILDREN.
11237 When called interactively, PARENT is the current article and CHILDREN
11238 are the process-marked articles."
11239   (interactive
11240    (list (gnus-summary-article-number)
11241          (gnus-summary-work-articles nil)))
11242   (dolist (child children)
11243     (save-window-excursion
11244       (let ((gnus-article-buffer " *reparent*"))
11245         (unless (not (eq parent child))
11246           (error "An article may not be self-referential"))
11247         (let ((message-id (mail-header-id
11248                            (gnus-summary-article-header parent))))
11249           (unless (and message-id (not (equal message-id "")))
11250             (error "No message-id in desired parent"))
11251           (gnus-with-article child
11252             (save-restriction
11253               (goto-char (point-min))
11254               (message-narrow-to-head)
11255               (if (re-search-forward "^References: " nil t)
11256                   (progn
11257                     (re-search-forward "^[^ \t]" nil t)
11258                     (forward-line -1)
11259                     (end-of-line)
11260                     (insert " " message-id))
11261                 (insert "References: " message-id "\n"))))
11262           (set-buffer gnus-summary-buffer)
11263           (gnus-summary-unmark-all-processable)
11264           (gnus-summary-update-article child)
11265           (when (gnus-summary-goto-subject (cdr gnus-article-current) nil t)
11266             (gnus-summary-update-secondary-mark (cdr gnus-article-current)))
11267           (gnus-summary-rethread-current)
11268           (gnus-message 3 "Article %d is now the child of article %d"
11269                         child parent))))))
11270
11271 (defun gnus-summary-toggle-threads (&optional arg)
11272   "Toggle showing conversation threads.
11273 If ARG is positive number, turn showing conversation threads on."
11274   (interactive "P")
11275   (let ((current (or (gnus-summary-article-number) gnus-newsgroup-end)))
11276     (setq gnus-show-threads
11277           (if (null arg) (not gnus-show-threads)
11278             (> (prefix-numeric-value arg) 0)))
11279     (gnus-summary-prepare)
11280     (gnus-summary-goto-subject current)
11281     (gnus-message 6 "Threading is now %s" (if gnus-show-threads "on" "off"))
11282     (gnus-summary-position-point)))
11283
11284 (eval-and-compile
11285   (if (fboundp 'remove-overlays)
11286       (defalias 'gnus-remove-overlays 'remove-overlays)
11287     (defun gnus-remove-overlays (beg end name val)
11288       "Clear BEG and END of overlays whose property NAME has value VAL.
11289 For compatibility with Emacs 21 and XEmacs."
11290       (dolist (ov (gnus-overlays-in beg end))
11291         (when (eq (gnus-overlay-get ov name) val)
11292           (gnus-delete-overlay ov))))))
11293
11294 (defun gnus-summary-show-all-threads ()
11295   "Show all threads."
11296   (interactive)
11297   (gnus-remove-overlays (point-min) (point-max) 'invisible 'gnus-sum)
11298   (gnus-summary-position-point))
11299
11300 (defun gnus-summary-show-thread ()
11301   "Show thread subtrees.
11302 Returns nil if no thread was there to be shown."
11303   (interactive)
11304   (let* ((orig (point))
11305          (end (point-at-eol))
11306          ;; Leave point at bol
11307          (beg (progn (beginning-of-line) (if (bobp) (point) (1- (point)))))
11308          (eoi (when (eq (get-char-property end 'invisible) 'gnus-sum)
11309                 (if (fboundp 'next-single-char-property-change)
11310                     (or (next-single-char-property-change end 'invisible)
11311                         (point-max))
11312                   (while (progn
11313                            (end-of-line 2)
11314                            (and (not (eobp))
11315                                 (eq (get-char-property (point) 'invisible)
11316                                     'gnus-sum))))
11317                   (point)))))
11318     (when eoi
11319       (gnus-remove-overlays beg eoi 'invisible 'gnus-sum)
11320       (goto-char orig)
11321       (gnus-summary-position-point)
11322       eoi)))
11323
11324 (defun gnus-summary-maybe-hide-threads ()
11325   "If requested, hide the threads that should be hidden."
11326   (when (and gnus-show-threads
11327              gnus-thread-hide-subtree)
11328     (gnus-summary-hide-all-threads
11329      (if (or (consp gnus-thread-hide-subtree)
11330              (functionp gnus-thread-hide-subtree))
11331          (gnus-make-predicate gnus-thread-hide-subtree)
11332        nil))))
11333
11334 ;;; Hiding predicates.
11335
11336 (defun gnus-article-unread-p (header)
11337   (memq (mail-header-number header) gnus-newsgroup-unreads))
11338
11339 (defun gnus-article-unseen-p (header)
11340   (memq (mail-header-number header) gnus-newsgroup-unseen))
11341
11342 (defun gnus-map-articles (predicate articles)
11343   "Map PREDICATE over ARTICLES and return non-nil if any predicate is non-nil."
11344   (apply 'gnus-or (mapcar predicate
11345                           (mapcar (lambda (number)
11346                                     (gnus-summary-article-header number))
11347                                   articles))))
11348
11349 (defun gnus-summary-hide-all-threads (&optional predicate)
11350   "Hide all thread subtrees.
11351 If PREDICATE is supplied, threads that satisfy this predicate
11352 will not be hidden."
11353   (interactive)
11354   (save-excursion
11355     (goto-char (point-min))
11356     (let ((end nil))
11357       (while (not end)
11358         (when (or (not predicate)
11359                   (gnus-map-articles
11360                    predicate (gnus-summary-article-children)))
11361             (gnus-summary-hide-thread))
11362         (setq end (not (zerop (gnus-summary-next-thread 1 t)))))))
11363   (gnus-summary-position-point))
11364
11365 (defun gnus-summary-hide-thread ()
11366   "Hide thread subtrees.
11367 If PREDICATE is supplied, threads that satisfy this predicate
11368 will not be hidden.
11369 Returns nil if no threads were there to be hidden."
11370   (interactive)
11371   (let ((start (point))
11372         (starteol (line-end-position))
11373         (article (gnus-summary-article-number)))
11374     (goto-char start)
11375     ;; Go forward until either the buffer ends or the subthread ends.
11376     (when (and (not (eobp))
11377                (or (zerop (gnus-summary-next-thread 1 t))
11378                    (goto-char (point-max))))
11379       (if (and (> (point) start)
11380                ;; FIXME: this should actually search for a non-invisible \n.
11381                (search-backward "\n" start t))
11382           (progn
11383             (when (> (point) starteol)
11384               (gnus-remove-overlays starteol (point) 'invisible 'gnus-sum)
11385               (let ((ol (gnus-make-overlay starteol (point) nil t nil)))
11386                 (gnus-overlay-put ol 'invisible 'gnus-sum)
11387                 (gnus-overlay-put ol 'evaporate t)))
11388             (gnus-summary-goto-subject article))
11389         (goto-char start)
11390         nil))))
11391
11392 (defun gnus-summary-go-to-next-thread (&optional previous)
11393   "Go to the same level (or less) next thread.
11394 If PREVIOUS is non-nil, go to previous thread instead.
11395 Return the article number moved to, or nil if moving was impossible."
11396   (let ((level (gnus-summary-thread-level))
11397         (way (if previous -1 1))
11398         (beg (point)))
11399     (forward-line way)
11400     (while (and (not (eobp))
11401                 (< level (gnus-summary-thread-level)))
11402       (forward-line way))
11403     (if (eobp)
11404         (progn
11405           (goto-char beg)
11406           nil)
11407       (setq beg (point))
11408       (prog1
11409           (gnus-summary-article-number)
11410         (goto-char beg)))))
11411
11412 (defun gnus-summary-next-thread (n &optional silent)
11413   "Go to the same level next N'th thread.
11414 If N is negative, search backward instead.
11415 Returns the difference between N and the number of skips actually
11416 done.
11417
11418 If SILENT, don't output messages."
11419   (interactive "p")
11420   (let ((backward (< n 0))
11421         (n (abs n)))
11422     (while (and (> n 0)
11423                 (gnus-summary-go-to-next-thread backward))
11424       (decf n))
11425     (unless silent
11426       (gnus-summary-position-point))
11427     (when (and (not silent) (/= 0 n))
11428       (gnus-message 7 "No more threads"))
11429     n))
11430
11431 (defun gnus-summary-prev-thread (n)
11432   "Go to the same level previous N'th thread.
11433 Returns the difference between N and the number of skips actually
11434 done."
11435   (interactive "p")
11436   (gnus-summary-next-thread (- n)))
11437
11438 (defun gnus-summary-go-down-thread ()
11439   "Go down one level in the current thread."
11440   (let ((children (gnus-summary-article-children)))
11441     (when children
11442       (gnus-summary-goto-subject (car children)))))
11443
11444 (defun gnus-summary-go-up-thread ()
11445   "Go up one level in the current thread."
11446   (let ((parent (gnus-summary-article-parent)))
11447     (when parent
11448       (gnus-summary-goto-subject parent))))
11449
11450 (defun gnus-summary-down-thread (n)
11451   "Go down thread N steps.
11452 If N is negative, go up instead.
11453 Returns the difference between N and how many steps down that were
11454 taken."
11455   (interactive "p")
11456   (let ((up (< n 0))
11457         (n (abs n)))
11458     (while (and (> n 0)
11459                 (if up (gnus-summary-go-up-thread)
11460                   (gnus-summary-go-down-thread)))
11461       (setq n (1- n)))
11462     (gnus-summary-position-point)
11463     (when (/= 0 n)
11464       (gnus-message 7 "Can't go further"))
11465     n))
11466
11467 (defun gnus-summary-up-thread (n)
11468   "Go up thread N steps.
11469 If N is negative, go down instead.
11470 Returns the difference between N and how many steps down that were
11471 taken."
11472   (interactive "p")
11473   (gnus-summary-down-thread (- n)))
11474
11475 (defun gnus-summary-top-thread ()
11476   "Go to the top of the thread."
11477   (interactive)
11478   (while (gnus-summary-go-up-thread))
11479   (gnus-summary-article-number))
11480
11481 (defun gnus-summary-expire-thread ()
11482   "Mark articles under current thread as expired."
11483   (interactive)
11484   (gnus-summary-kill-thread 0))
11485
11486 (defun gnus-summary-kill-thread (&optional unmark)
11487   "Mark articles under current thread as read.
11488 If the prefix argument is positive, remove any kinds of marks.
11489 If the prefix argument is zero, mark thread as expired.
11490 If the prefix argument is negative, tick articles instead."
11491   (interactive "P")
11492   (when unmark
11493     (setq unmark (prefix-numeric-value unmark)))
11494   (let ((articles (gnus-summary-articles-in-thread))
11495         (hide (or (null unmark) (= unmark 0))))
11496     (save-excursion
11497       ;; Expand the thread.
11498       (gnus-summary-show-thread)
11499       ;; Mark all the articles.
11500       (while articles
11501         (gnus-summary-goto-subject (car articles))
11502         (cond ((null unmark)
11503                (gnus-summary-mark-article-as-read gnus-killed-mark))
11504               ((> unmark 0)
11505                (gnus-summary-mark-article-as-unread gnus-unread-mark))
11506               ((= unmark 0)
11507                (gnus-summary-mark-article nil gnus-expirable-mark))
11508               (t
11509                (gnus-summary-mark-article-as-unread gnus-ticked-mark)))
11510         (setq articles (cdr articles))))
11511     ;; Hide killed subtrees when hide is true.
11512     (and hide
11513          gnus-thread-hide-killed
11514          (gnus-summary-hide-thread))
11515     ;; If hide is t, go to next unread subject.
11516     (when hide
11517       ;; Go to next unread subject.
11518       (gnus-summary-next-subject 1 t)))
11519   (gnus-set-mode-line 'summary))
11520
11521 ;; Summary sorting commands
11522
11523 (defun gnus-summary-sort-by-number (&optional reverse)
11524   "Sort the summary buffer by article number.
11525 Argument REVERSE means reverse order."
11526   (interactive "P")
11527   (gnus-summary-sort 'number reverse))
11528
11529 (defun gnus-summary-sort-by-most-recent-number (&optional reverse)
11530   "Sort the summary buffer by most recent article number.
11531 Argument REVERSE means reverse order."
11532   (interactive "P")
11533   (gnus-summary-sort 'most-recent-number reverse))
11534
11535 (defun gnus-summary-sort-by-random (&optional reverse)
11536   "Randomize the order in the summary buffer.
11537 Argument REVERSE means to randomize in reverse order."
11538   (interactive "P")
11539   (gnus-summary-sort 'random reverse))
11540
11541 (defun gnus-summary-sort-by-author (&optional reverse)
11542   "Sort the summary buffer by author name alphabetically.
11543 If `case-fold-search' is non-nil, case of letters is ignored.
11544 Argument REVERSE means reverse order."
11545   (interactive "P")
11546   (gnus-summary-sort 'author reverse))
11547
11548 (defun gnus-summary-sort-by-recipient (&optional reverse)
11549   "Sort the summary buffer by recipient name alphabetically.
11550 If `case-fold-search' is non-nil, case of letters is ignored.
11551 Argument REVERSE means reverse order."
11552   (interactive "P")
11553   (gnus-summary-sort 'recipient reverse))
11554
11555 (defun gnus-summary-sort-by-subject (&optional reverse)
11556   "Sort the summary buffer by subject alphabetically.  `Re:'s are ignored.
11557 If `case-fold-search' is non-nil, case of letters is ignored.
11558 Argument REVERSE means reverse order."
11559   (interactive "P")
11560   (gnus-summary-sort 'subject reverse))
11561
11562 (defun gnus-summary-sort-by-date (&optional reverse)
11563   "Sort the summary buffer by date.
11564 Argument REVERSE means reverse order."
11565   (interactive "P")
11566   (gnus-summary-sort 'date reverse))
11567
11568 (defun gnus-summary-sort-by-most-recent-date (&optional reverse)
11569   "Sort the summary buffer by most recent date.
11570 Argument REVERSE means reverse order."
11571   (interactive "P")
11572   (gnus-summary-sort 'most-recent-date reverse))
11573
11574 (defun gnus-summary-sort-by-score (&optional reverse)
11575   "Sort the summary buffer by score.
11576 Argument REVERSE means reverse order."
11577   (interactive "P")
11578   (gnus-summary-sort 'score reverse))
11579
11580 (defun gnus-summary-sort-by-lines (&optional reverse)
11581   "Sort the summary buffer by the number of lines.
11582 Argument REVERSE means reverse order."
11583   (interactive "P")
11584   (gnus-summary-sort 'lines reverse))
11585
11586 (defun gnus-summary-sort-by-chars (&optional reverse)
11587   "Sort the summary buffer by article length.
11588 Argument REVERSE means reverse order."
11589   (interactive "P")
11590   (gnus-summary-sort 'chars reverse))
11591
11592 (defun gnus-summary-sort-by-original (&optional reverse)
11593   "Sort the summary buffer using the default sorting method.
11594 Argument REVERSE means reverse order."
11595   (interactive "P")
11596   (let* ((inhibit-read-only t)
11597          (gnus-summary-prepare-hook nil))
11598     ;; We do the sorting by regenerating the threads.
11599     (gnus-summary-prepare)
11600     ;; Hide subthreads if needed.
11601     (gnus-summary-maybe-hide-threads)))
11602
11603 (defun gnus-summary-sort (predicate reverse)
11604   "Sort summary buffer by PREDICATE.  REVERSE means reverse order."
11605   (let* ((thread (intern (format "gnus-thread-sort-by-%s" predicate)))
11606          (article (intern (format "gnus-article-sort-by-%s" predicate)))
11607          (gnus-thread-sort-functions
11608           (if (not reverse)
11609               thread
11610             `(lambda (t1 t2)
11611                (,thread t2 t1))))
11612          (gnus-sort-gathered-threads-function
11613           gnus-thread-sort-functions)
11614          (gnus-article-sort-functions
11615           (if (not reverse)
11616               article
11617             `(lambda (t1 t2)
11618                (,article t2 t1))))
11619          (inhibit-read-only t)
11620          (gnus-summary-prepare-hook nil))
11621     ;; We do the sorting by regenerating the threads.
11622     (gnus-summary-prepare)
11623     ;; Hide subthreads if needed.
11624     (gnus-summary-maybe-hide-threads)))
11625
11626 ;; Summary saving commands.
11627
11628 (defun gnus-summary-save-article (&optional n not-saved)
11629   "Save the current article using the default saver function.
11630 If N is a positive number, save the N next articles.
11631 If N is a negative number, save the N previous articles.
11632 If N is nil and any articles have been marked with the process mark,
11633 save those articles instead.
11634 The variable `gnus-default-article-saver' specifies the saver function.
11635
11636 If the optional second argument NOT-SAVED is non-nil, articles saved
11637 will not be marked as saved."
11638   (interactive "P")
11639   (require 'gnus-art)
11640   (let* ((articles (gnus-summary-work-articles n))
11641          (save-buffer (save-excursion
11642                         (nnheader-set-temp-buffer " *Gnus Save*")))
11643          (num (length articles))
11644          ;; Whether to save decoded articles or raw articles.
11645          (decode (when gnus-article-save-coding-system
11646                    (get gnus-default-article-saver :decode)))
11647          ;; When saving many articles in a single file, use the other
11648          ;; function to save articles other than the first one.
11649          (saver2 (get gnus-default-article-saver :function))
11650          (gnus-prompt-before-saving (if saver2
11651                                         t
11652                                       gnus-prompt-before-saving))
11653          (gnus-default-article-saver gnus-default-article-saver)
11654          header file)
11655     (dolist (article articles)
11656       (setq header (gnus-summary-article-header article))
11657       (if (not (vectorp header))
11658           ;; This is a pseudo-article.
11659           (if (assq 'name header)
11660               (gnus-copy-file (cdr (assq 'name header)))
11661             (gnus-message 1 "Article %d is unsaveable" article))
11662         ;; This is a real article.
11663         (save-window-excursion
11664           (gnus-summary-select-article decode decode nil article)
11665           (gnus-summary-goto-subject article))
11666         (with-current-buffer save-buffer
11667           (erase-buffer)
11668           (insert-buffer-substring (if decode
11669                                        gnus-article-buffer
11670                                      gnus-original-article-buffer)))
11671         (setq file (gnus-article-save save-buffer file num))
11672         (gnus-summary-remove-process-mark article)
11673         (unless not-saved
11674           (gnus-summary-set-saved-mark article)))
11675       (when saver2
11676         (setq gnus-default-article-saver saver2
11677               saver2 nil)))
11678     (gnus-kill-buffer save-buffer)
11679     (gnus-summary-position-point)
11680     (gnus-set-mode-line 'summary)
11681     n))
11682
11683 (defun gnus-summary-pipe-output (&optional n sym)
11684   "Pipe the current article to a subprocess.
11685 If N is a positive number, pipe the N next articles.
11686 If N is a negative number, pipe the N previous articles.
11687 If N is nil and any articles have been marked with the process mark,
11688 pipe those articles instead.
11689 The default command to which articles are piped is specified by the
11690 variable `gnus-summary-pipe-output-default-command'; if it is nil, you
11691 will be prompted for the command.
11692
11693 The properties `:decode' and `:headers' that are put to the function
11694 symbol `gnus-summary-save-in-pipe' control whether this function
11695 decodes articles and what headers to keep (see the doc string for the
11696 `gnus-default-article-saver' variable).  If SYM (the symbolic prefix)
11697 is neither omitted nor the symbol `r', force including all headers
11698 regardless of the `:headers' property.  If it is the symbol `r',
11699 articles that are not decoded and include all headers will be piped
11700 no matter what the properties `:decode' and `:headers' are."
11701   (interactive (gnus-interactive "P\ny"))
11702   (require 'gnus-art)
11703   (let* ((articles (gnus-summary-work-articles n))
11704          (result-buffer "*Shell Command Output*")
11705          (all-headers (not (memq sym '(nil r))))
11706          (gnus-save-all-headers (or all-headers gnus-save-all-headers))
11707          (raw (eq sym 'r))
11708          (headers (get 'gnus-summary-save-in-pipe :headers))
11709          command result)
11710     (unless (numberp (car articles))
11711       (error "No article to pipe"))
11712     (setq command (gnus-read-shell-command
11713                    (concat "Shell command on "
11714                            (if (cdr articles)
11715                                (format "these %d articles" (length articles))
11716                              "this article")
11717                            ": ")
11718                    gnus-summary-pipe-output-default-command))
11719     (when (string-equal command "")
11720       (error "A command is required"))
11721     (when all-headers
11722       (put 'gnus-summary-save-in-pipe :headers nil))
11723     (unwind-protect
11724         (while articles
11725           (gnus-summary-goto-subject (pop articles))
11726           (save-window-excursion (gnus-summary-save-in-pipe command raw))
11727           (when (and (get-buffer result-buffer)
11728                      (not (zerop (buffer-size (get-buffer result-buffer)))))
11729             (setq result (concat result (with-current-buffer result-buffer
11730                                           (buffer-string))))))
11731       (put 'gnus-summary-save-in-pipe :headers headers))
11732     (unless (zerop (length result))
11733       (if (with-current-buffer (get-buffer-create result-buffer)
11734             (erase-buffer)
11735             (insert result)
11736             (prog1
11737                 (and (= (count-lines (point-min) (point)) 1)
11738                      (progn
11739                        (end-of-line 0)
11740                        (<= (current-column)
11741                            (window-width (minibuffer-window)))))
11742               (goto-char (point-min))))
11743           (message "%s" (substring result 0 -1))
11744         (message nil)
11745         (gnus-configure-windows 'pipe)))))
11746
11747 (defun gnus-summary-save-article-mail (&optional arg)
11748   "Append the current article to a Unix mail box file.
11749 If N is a positive number, save the N next articles.
11750 If N is a negative number, save the N previous articles.
11751 If N is nil and any articles have been marked with the process mark,
11752 save those articles instead."
11753   (interactive "P")
11754   (require 'gnus-art)
11755   (let ((gnus-default-article-saver 'gnus-summary-save-in-mail))
11756     (gnus-summary-save-article arg)))
11757
11758 (defun gnus-summary-save-article-rmail (&optional arg)
11759   "Append the current article to an rmail file.
11760 If N is a positive number, save the N next articles.
11761 If N is a negative number, save the N previous articles.
11762 If N is nil and any articles have been marked with the process mark,
11763 save those articles instead."
11764   (interactive "P")
11765   (require 'gnus-art)
11766   (let ((gnus-default-article-saver 'gnus-summary-save-in-rmail))
11767     (gnus-summary-save-article arg)))
11768
11769 (defun gnus-summary-save-article-file (&optional arg)
11770   "Append the current article to a file.
11771 If N is a positive number, save the N next articles.
11772 If N is a negative number, save the N previous articles.
11773 If N is nil and any articles have been marked with the process mark,
11774 save those articles instead."
11775   (interactive "P")
11776   (require 'gnus-art)
11777   (let ((gnus-default-article-saver 'gnus-summary-save-in-file))
11778     (gnus-summary-save-article arg)))
11779
11780 (defun gnus-summary-write-article-file (&optional arg)
11781   "Write the current article to a file, deleting the previous file.
11782 If N is a positive number, save the N next articles.
11783 If N is a negative number, save the N previous articles.
11784 If N is nil and any articles have been marked with the process mark,
11785 save those articles instead."
11786   (interactive "P")
11787   (require 'gnus-art)
11788   (let ((gnus-default-article-saver 'gnus-summary-write-to-file))
11789     (gnus-summary-save-article arg)))
11790
11791 (defun gnus-summary-save-article-body-file (&optional arg)
11792   "Append the current article body to a file.
11793 If N is a positive number, save the N next articles.
11794 If N is a negative number, save the N previous articles.
11795 If N is nil and any articles have been marked with the process mark,
11796 save those articles instead."
11797   (interactive "P")
11798   (require 'gnus-art)
11799   (let ((gnus-default-article-saver 'gnus-summary-save-body-in-file))
11800     (gnus-summary-save-article arg)))
11801
11802 (defun gnus-summary-write-article-body-file (&optional arg)
11803   "Write the current article body to a file, deleting the previous file.
11804 If N is a positive number, save the N next articles.
11805 If N is a negative number, save the N previous articles.
11806 If N is nil and any articles have been marked with the process mark,
11807 save those articles instead."
11808   (interactive "P")
11809   (require 'gnus-art)
11810   (let ((gnus-default-article-saver 'gnus-summary-write-body-to-file))
11811     (gnus-summary-save-article arg)))
11812
11813 (defun gnus-summary-muttprint (&optional arg)
11814   "Print the current article using Muttprint.
11815 If N is a positive number, save the N next articles.
11816 If N is a negative number, save the N previous articles.
11817 If N is nil and any articles have been marked with the process mark,
11818 save those articles instead."
11819   (interactive "P")
11820   (require 'gnus-art)
11821   (let ((gnus-default-article-saver 'gnus-summary-pipe-to-muttprint))
11822     (gnus-summary-save-article arg t)))
11823
11824 (defun gnus-summary-pipe-message (program)
11825   "Pipe the current article through PROGRAM."
11826   (interactive "sProgram: ")
11827   (gnus-summary-select-article)
11828   (let ((mail-header-separator ""))
11829     (gnus-eval-in-buffer-window gnus-article-buffer
11830       (save-restriction
11831         (widen)
11832         (let ((start (window-start))
11833               (inhibit-read-only t))
11834           (message-pipe-buffer-body program)
11835           (set-window-start (get-buffer-window (current-buffer)) start))))))
11836
11837 (defun gnus-get-split-value (methods)
11838   "Return a value based on the split METHODS."
11839   (let (split-name method result match)
11840     (when methods
11841       (with-current-buffer gnus-original-article-buffer
11842         (save-restriction
11843           (nnheader-narrow-to-headers)
11844           (while (and methods (not split-name))
11845             (goto-char (point-min))
11846             (setq method (pop methods))
11847             (setq match (car method))
11848             (when (cond
11849                    ((stringp match)
11850                     ;; Regular expression.
11851                     (ignore-errors
11852                       (re-search-forward match nil t)))
11853                    ((functionp match)
11854                     ;; Function.
11855                     (save-restriction
11856                       (widen)
11857                       (setq result (funcall match gnus-newsgroup-name))))
11858                    ((consp match)
11859                     ;; Form.
11860                     (save-restriction
11861                       (widen)
11862                       (setq result (eval match)))))
11863               (setq split-name (cdr method))
11864               (cond ((stringp result)
11865                      (push (expand-file-name
11866                             result gnus-article-save-directory)
11867                            split-name))
11868                     ((consp result)
11869                      (setq split-name (append result split-name)))))))))
11870     (nreverse split-name)))
11871
11872 (defun gnus-valid-move-group-p (group)
11873   (and (boundp group)
11874        (symbol-name group)
11875        (symbol-value group)
11876        (gnus-get-function (gnus-find-method-for-group
11877                            (symbol-name group)) 'request-accept-article t)))
11878
11879 (defun gnus-read-move-group-name (prompt default articles prefix)
11880   "Read a group name."
11881   (let* ((split-name (gnus-get-split-value gnus-move-split-methods))
11882          (minibuffer-confirm-incomplete nil) ; XEmacs
11883          (prom
11884           (format "%s %s to"
11885                   prompt
11886                   (if (> (length articles) 1)
11887                       (format "these %d articles" (length articles))
11888                     "this article")))
11889          (to-newsgroup
11890           (let (active group)
11891             (when (or (null split-name) (= 1 (length split-name)))
11892               (setq active (gnus-make-hashtable (length gnus-active-hashtb)))
11893               (mapatoms (lambda (symbol)
11894                           (setq group (symbol-name symbol))
11895                           (when (string-match "[^\000-\177]" group)
11896                             (setq group (gnus-group-decoded-name group)))
11897                           (set (intern group active) group))
11898                         gnus-active-hashtb))
11899             (cond
11900              ((null split-name)
11901               (gnus-completing-read-with-default
11902                default prom active 'gnus-valid-move-group-p nil prefix
11903                'gnus-group-history))
11904              ((= 1 (length split-name))
11905               (gnus-completing-read-with-default
11906                (car split-name) prom active 'gnus-valid-move-group-p nil nil
11907                'gnus-group-history))
11908              (t
11909               (gnus-completing-read-with-default
11910                nil prom (mapcar 'list (nreverse split-name)) nil nil nil
11911                'gnus-group-history)))))
11912          (to-method (gnus-server-to-method (gnus-group-method to-newsgroup)))
11913          encoded)
11914     (when to-newsgroup
11915       (if (or (string= to-newsgroup "")
11916               (string= to-newsgroup prefix))
11917           (setq to-newsgroup default))
11918       (unless to-newsgroup
11919         (error "No group name entered"))
11920       (setq encoded (mm-encode-coding-string
11921                      to-newsgroup
11922                      (gnus-group-name-charset to-method to-newsgroup)))
11923       (or (gnus-active encoded)
11924           (gnus-activate-group encoded nil nil to-method)
11925           (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
11926                                      to-newsgroup))
11927               (or (and (gnus-request-create-group encoded to-method)
11928                        (gnus-activate-group encoded nil nil to-method)
11929                        (gnus-subscribe-group encoded))
11930                   (error "Couldn't create group %s" to-newsgroup)))
11931           (error "No such group: %s" to-newsgroup))
11932       encoded)))
11933
11934 (defvar gnus-summary-save-parts-counter)
11935 (declare-function mm-uu-dissect "mm-uu" (&optional noheader mime-type))
11936
11937 (defun gnus-summary-save-parts (type dir n &optional reverse)
11938   "Save parts matching TYPE to DIR.
11939 If REVERSE, save parts that do not match TYPE."
11940   (interactive
11941    (list (read-string "Save parts of type: "
11942                       (or (car gnus-summary-save-parts-type-history)
11943                           gnus-summary-save-parts-default-mime)
11944                       'gnus-summary-save-parts-type-history)
11945          (setq gnus-summary-save-parts-last-directory
11946                (read-file-name "Save to directory: "
11947                                gnus-summary-save-parts-last-directory
11948                                nil t))
11949          current-prefix-arg))
11950   (gnus-summary-iterate n
11951     (let ((gnus-display-mime-function nil)
11952           gnus-article-prepare-hook
11953           gnus-article-decode-hook
11954           gnus-display-mime-function
11955           gnus-break-pages
11956           (gnus-inhibit-treatment t))
11957       (gnus-summary-select-article))
11958     (with-current-buffer gnus-article-buffer
11959       (let ((handles (or gnus-article-mime-handles
11960                          (mm-dissect-buffer nil gnus-article-loose-mime)
11961                          (and gnus-article-emulate-mime
11962                               (mm-uu-dissect))))
11963             (gnus-summary-save-parts-counter 1))
11964         (when handles
11965           (gnus-summary-save-parts-1 type dir handles reverse)
11966           (unless gnus-article-mime-handles ;; Don't destroy this case.
11967             (mm-destroy-parts handles)))))))
11968
11969 (defun gnus-summary-save-parts-1 (type dir handle reverse)
11970   (if (stringp (car handle))
11971       (mapcar (lambda (h) (gnus-summary-save-parts-1 type dir h reverse))
11972               (cdr handle))
11973     (when (if reverse
11974               (not (string-match type (mm-handle-media-type handle)))
11975             (string-match type (mm-handle-media-type handle)))
11976       (let ((file (expand-file-name
11977                    (gnus-map-function
11978                     mm-file-name-rewrite-functions
11979                     (file-name-nondirectory
11980                      (or
11981                       (mail-content-type-get
11982                        (mm-handle-disposition handle) 'filename)
11983                       (mail-content-type-get
11984                        (mm-handle-type handle) 'name)
11985                       (format "%s.%d.%d" gnus-newsgroup-name
11986                               (cdr gnus-article-current)
11987                               gnus-summary-save-parts-counter))))
11988                    dir)))
11989         (incf gnus-summary-save-parts-counter)
11990         (unless (file-exists-p file)
11991           (mm-save-part-to-file handle file))))))
11992
11993 ;; Summary extract commands
11994
11995 (defun gnus-summary-insert-pseudos (pslist &optional not-view)
11996   (let ((inhibit-read-only t)
11997         (article (gnus-summary-article-number))
11998         after-article b e)
11999     (unless (gnus-summary-goto-subject article)
12000       (error "No such article: %d" article))
12001     (gnus-summary-position-point)
12002     ;; If all commands are to be bunched up on one line, we collect
12003     ;; them here.
12004     (unless gnus-view-pseudos-separately
12005       (let ((ps (setq pslist (sort pslist 'gnus-pseudos<)))
12006             files action)
12007         (while ps
12008           (setq action (cdr (assq 'action (car ps))))
12009           (setq files (list (cdr (assq 'name (car ps)))))
12010           (while (and ps (cdr ps)
12011                       (string= (or action "1")
12012                                (or (cdr (assq 'action (cadr ps))) "2")))
12013             (push (cdr (assq 'name (cadr ps))) files)
12014             (setcdr ps (cddr ps)))
12015           (when files
12016             (when (not (string-match "%s" action))
12017               (push " " files))
12018             (push " " files)
12019             (when (assq 'execute (car ps))
12020               (setcdr (assq 'execute (car ps))
12021                       (funcall (if (string-match "%s" action)
12022                                    'format 'concat)
12023                                action
12024                                (mapconcat
12025                                 (lambda (f)
12026                                   (if (equal f " ")
12027                                       f
12028                                     (shell-quote-argument f)))
12029                                 files " ")))))
12030           (setq ps (cdr ps)))))
12031     (if (and gnus-view-pseudos (not not-view))
12032         (while pslist
12033           (when (assq 'execute (car pslist))
12034             (gnus-execute-command (cdr (assq 'execute (car pslist)))
12035                                   (eq gnus-view-pseudos 'not-confirm)))
12036           (setq pslist (cdr pslist)))
12037       (save-excursion
12038         (while pslist
12039           (setq after-article (or (cdr (assq 'article (car pslist)))
12040                                   (gnus-summary-article-number)))
12041           (gnus-summary-goto-subject after-article)
12042           (forward-line 1)
12043           (setq b (point))
12044           (insert "    " (file-name-nondirectory
12045                           (cdr (assq 'name (car pslist))))
12046                   ": " (or (cdr (assq 'execute (car pslist))) "") "\n")
12047           (setq e (point))
12048           (forward-line -1)             ; back to `b'
12049           (gnus-add-text-properties
12050            b (1- e) (list 'gnus-number gnus-reffed-article-number
12051                           gnus-mouse-face-prop gnus-mouse-face))
12052           (gnus-data-enter
12053            after-article gnus-reffed-article-number
12054            gnus-unread-mark b (car pslist) 0 (- e b))
12055           (setq gnus-newsgroup-unreads
12056                 (gnus-add-to-sorted-list gnus-newsgroup-unreads
12057                                          gnus-reffed-article-number))
12058           (setq gnus-reffed-article-number (1- gnus-reffed-article-number))
12059           (setq pslist (cdr pslist)))))))
12060
12061 (defun gnus-pseudos< (p1 p2)
12062   (let ((c1 (cdr (assq 'action p1)))
12063         (c2 (cdr (assq 'action p2))))
12064     (and c1 c2 (string< c1 c2))))
12065
12066 (defun gnus-request-pseudo-article (props)
12067   (cond ((assq 'execute props)
12068          (gnus-execute-command (cdr (assq 'execute props)))))
12069   (let ((gnus-current-article (gnus-summary-article-number)))
12070     (gnus-run-hooks 'gnus-mark-article-hook)))
12071
12072 (defun gnus-execute-command (command &optional automatic)
12073   (save-excursion
12074     (gnus-article-setup-buffer)
12075     (set-buffer gnus-article-buffer)
12076     (setq buffer-read-only nil)
12077     (let ((command (if automatic command
12078                      (read-string "Command: " (cons command 0)))))
12079       (erase-buffer)
12080       (insert "$ " command "\n\n")
12081       (if gnus-view-pseudo-asynchronously
12082           (start-process "gnus-execute" (current-buffer) shell-file-name
12083                          shell-command-switch command)
12084         (call-process shell-file-name nil t nil
12085                       shell-command-switch command)))))
12086
12087 ;; Summary kill commands.
12088
12089 (defun gnus-summary-edit-global-kill (article)
12090   "Edit the \"global\" kill file."
12091   (interactive (list (gnus-summary-article-number)))
12092   (gnus-group-edit-global-kill article))
12093
12094 (defun gnus-summary-edit-local-kill ()
12095   "Edit a local kill file applied to the current newsgroup."
12096   (interactive)
12097   (setq gnus-current-headers (gnus-summary-article-header))
12098   (gnus-group-edit-local-kill
12099    (gnus-summary-article-number) gnus-newsgroup-name))
12100
12101 ;;; Header reading.
12102
12103 (defun gnus-read-header (id &optional header)
12104   "Read the headers of article ID and enter them into the Gnus system."
12105   (let ((group gnus-newsgroup-name)
12106         (gnus-override-method
12107          (or
12108           gnus-override-method
12109           (and (gnus-news-group-p gnus-newsgroup-name)
12110                (car (gnus-refer-article-methods)))))
12111         where)
12112     ;; First we check to see whether the header in question is already
12113     ;; fetched.
12114     (if (stringp id)
12115         ;; This is a Message-ID.
12116         (setq header (or header (gnus-id-to-header id)))
12117       ;; This is an article number.
12118       (setq header (or header (gnus-summary-article-header id))))
12119     (if (and header
12120              (not (gnus-summary-article-sparse-p (mail-header-number header))))
12121         ;; We have found the header.
12122         header
12123       ;; We have to really fetch the header to this article.
12124       (with-current-buffer nntp-server-buffer
12125         (when (setq where (gnus-request-head id group))
12126           (nnheader-fold-continuation-lines)
12127           (goto-char (point-max))
12128           (insert ".\n")
12129           (goto-char (point-min))
12130           (insert "211 ")
12131           (princ (cond
12132                   ((numberp id) id)
12133                   ((cdr where) (cdr where))
12134                   (header (mail-header-number header))
12135                   (t gnus-reffed-article-number))
12136                  (current-buffer))
12137           (insert " Article retrieved.\n"))
12138         (if (or (not where)
12139                 (not (setq header (car (gnus-get-newsgroup-headers nil t)))))
12140             ()                          ; Malformed head.
12141           (unless (gnus-summary-article-sparse-p (mail-header-number header))
12142             (when (and (stringp id)
12143                        (or
12144                         (not (string= (gnus-group-real-name group)
12145                                       (car where)))
12146                         (not (gnus-server-equal gnus-override-method
12147                                                 (gnus-group-method group)))))
12148               ;; If we fetched by Message-ID and the article came from
12149               ;; a different group (or server), we fudge some bogus
12150               ;; article numbers for this article.
12151               (mail-header-set-number header gnus-reffed-article-number))
12152             (with-current-buffer gnus-summary-buffer
12153               (decf gnus-reffed-article-number)
12154               (gnus-remove-header (mail-header-number header))
12155               (push header gnus-newsgroup-headers)
12156               (setq gnus-current-headers header)
12157               (push (mail-header-number header) gnus-newsgroup-limit)))
12158           header)))))
12159
12160 (defun gnus-remove-header (number)
12161   "Remove header NUMBER from `gnus-newsgroup-headers'."
12162   (if (and gnus-newsgroup-headers
12163            (= number (mail-header-number (car gnus-newsgroup-headers))))
12164       (pop gnus-newsgroup-headers)
12165     (let ((headers gnus-newsgroup-headers))
12166       (while (and (cdr headers)
12167                   (not (= number (mail-header-number (cadr headers)))))
12168         (pop headers))
12169       (when (cdr headers)
12170         (setcdr headers (cddr headers))))))
12171
12172 ;;;
12173 ;;; summary highlights
12174 ;;;
12175
12176 (defun gnus-highlight-selected-summary ()
12177   "Highlight selected article in summary buffer."
12178   ;; Added by Per Abrahamsen <amanda@iesd.auc.dk>.
12179   (when gnus-summary-selected-face
12180     (save-excursion
12181       (let* ((beg (point-at-bol))
12182              (end (point-at-eol))
12183              ;; Fix by Mike Dugan <dugan@bucrf16.bu.edu>.
12184              (from (if (get-text-property beg gnus-mouse-face-prop)
12185                        beg
12186                      (or (next-single-property-change
12187                           beg gnus-mouse-face-prop nil end)
12188                          beg)))
12189              (to
12190               (if (= from end)
12191                   (- from 2)
12192                 (or (next-single-property-change
12193                      from gnus-mouse-face-prop nil end)
12194                     end))))
12195         ;; If no mouse-face prop on line we will have to = from = end,
12196         ;; so we highlight the entire line instead.
12197         (when (= (+ to 2) from)
12198           (setq from beg)
12199           (setq to end))
12200         (if gnus-newsgroup-selected-overlay
12201             ;; Move old overlay.
12202             (gnus-move-overlay
12203              gnus-newsgroup-selected-overlay from to (current-buffer))
12204           ;; Create new overlay.
12205           (gnus-overlay-put
12206            (setq gnus-newsgroup-selected-overlay (gnus-make-overlay from to))
12207            'face gnus-summary-selected-face))))))
12208
12209 (defvar gnus-summary-highlight-line-cached nil)
12210 (defvar gnus-summary-highlight-line-trigger nil)
12211
12212 (defun gnus-summary-highlight-line-0 ()
12213   (if (and (eq gnus-summary-highlight-line-trigger
12214                gnus-summary-highlight)
12215            gnus-summary-highlight-line-cached)
12216       gnus-summary-highlight-line-cached
12217     (setq gnus-summary-highlight-line-trigger gnus-summary-highlight
12218           gnus-summary-highlight-line-cached
12219           (let* ((cond (list 'cond))
12220                  (c cond)
12221                  (list gnus-summary-highlight))
12222             (while list
12223               (setcdr c (cons (list (caar list) (list 'quote (cdar list)))
12224                               nil))
12225               (setq c (cdr c)
12226                     list (cdr list)))
12227             (gnus-byte-compile (list 'lambda nil cond))))))
12228
12229 (defun gnus-summary-highlight-line ()
12230   "Highlight current line according to `gnus-summary-highlight'."
12231   (let* ((beg (point-at-bol))
12232          (article (or (gnus-summary-article-number) gnus-current-article))
12233          (score (or (cdr (assq article
12234                                gnus-newsgroup-scored))
12235                     gnus-summary-default-score 0))
12236          (mark (or (gnus-summary-article-mark) gnus-unread-mark))
12237          (inhibit-read-only t)
12238          (default gnus-summary-default-score)
12239          (default-high gnus-summary-default-high-score)
12240          (default-low gnus-summary-default-low-score)
12241          (uncached (and gnus-summary-use-undownloaded-faces
12242                         (memq article gnus-newsgroup-undownloaded)
12243                         (not (memq article gnus-newsgroup-cached)))))
12244     (let ((face (funcall (gnus-summary-highlight-line-0))))
12245       (unless (eq face (get-text-property beg 'face))
12246         (gnus-put-text-property-excluding-characters-with-faces
12247          beg (point-at-eol) 'face
12248          (setq face (if (boundp face) (symbol-value face) face)))
12249         (when gnus-summary-highlight-line-function
12250           (funcall gnus-summary-highlight-line-function article face))))))
12251
12252 (defun gnus-update-read-articles (group unread &optional compute)
12253   "Update the list of read articles in GROUP.
12254 UNREAD is a sorted list."
12255   (let ((active (or gnus-newsgroup-active (gnus-active group)))
12256         (info (gnus-get-info group))
12257         (prev 1)
12258         read)
12259     (if (or (not info) (not active))
12260         ;; There is no info on this group if it was, in fact,
12261         ;; killed.  Gnus stores no information on killed groups, so
12262         ;; there's nothing to be done.
12263         ;; One could store the information somewhere temporarily,
12264         ;; perhaps...  Hmmm...
12265         ()
12266       ;; Remove any negative articles numbers.
12267       (while (and unread (< (car unread) 0))
12268         (setq unread (cdr unread)))
12269       ;; Remove any expired article numbers
12270       (while (and unread (< (car unread) (car active)))
12271         (setq unread (cdr unread)))
12272       ;; Compute the ranges of read articles by looking at the list of
12273       ;; unread articles.
12274       (while unread
12275         (when (/= (car unread) prev)
12276           (push (if (= prev (1- (car unread))) prev
12277                   (cons prev (1- (car unread))))
12278                 read))
12279         (setq prev (1+ (car unread)))
12280         (setq unread (cdr unread)))
12281       (when (<= prev (cdr active))
12282         (push (cons prev (cdr active)) read))
12283       (setq read (if (> (length read) 1) (nreverse read) read))
12284       (if compute
12285           read
12286         (save-excursion
12287           (let (setmarkundo)
12288             ;; Propagate the read marks to the backend.
12289             (when (and gnus-propagate-marks
12290                        (gnus-check-backend-function 'request-set-mark group))
12291               (let ((del (gnus-remove-from-range (gnus-info-read info) read))
12292                     (add (gnus-remove-from-range read (gnus-info-read info))))
12293                 (when (or add del)
12294                   (unless (gnus-check-group group)
12295                     (error "Can't open server for %s" group))
12296                   (gnus-request-set-mark
12297                    group (delq nil (list (if add (list add 'add '(read)))
12298                                          (if del (list del 'del '(read))))))
12299                   (setq setmarkundo
12300                         `(gnus-request-set-mark
12301                           ,group
12302                           ',(delq nil (list
12303                                        (if del (list del 'add '(read)))
12304                                        (if add (list add 'del '(read))))))))))
12305             (set-buffer gnus-group-buffer)
12306             (gnus-undo-register
12307               `(progn
12308                  (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
12309                  (gnus-info-set-read ',info ',(gnus-info-read info))
12310                  (gnus-get-unread-articles-in-group ',info
12311                                                     (gnus-active ,group))
12312                  (gnus-group-update-group ,group t)
12313                  ,setmarkundo))))
12314         ;; Enter this list into the group info.
12315         (gnus-info-set-read info read)
12316         ;; Set the number of unread articles in gnus-newsrc-hashtb.
12317         (gnus-get-unread-articles-in-group info (gnus-active group))
12318         t))))
12319
12320 (defun gnus-offer-save-summaries ()
12321   "Offer to save all active summary buffers."
12322   (let (buffers)
12323     ;; Go through all buffers and find all summaries.
12324     (dolist (buffer (buffer-list))
12325       (when (and (setq buffer (buffer-name buffer))
12326                  (string-match "Summary" buffer)
12327                  (with-current-buffer buffer
12328                    ;; We check that this is, indeed, a summary buffer.
12329                    (and (eq major-mode 'gnus-summary-mode)
12330                         ;; Also make sure this isn't bogus.
12331                         gnus-newsgroup-prepared
12332                         ;; Also make sure that this isn't a
12333                         ;; dead summary buffer.
12334                         (not gnus-dead-summary-mode))))
12335         (push buffer buffers)))
12336     ;; Go through all these summary buffers and offer to save them.
12337     (when buffers
12338       (save-excursion
12339         (map-y-or-n-p
12340          "Update summary buffer %s? "
12341          (lambda (buf)
12342            (switch-to-buffer buf)
12343            (gnus-summary-exit))
12344          buffers)))))
12345
12346 (defun gnus-summary-setup-default-charset ()
12347   "Setup newsgroup default charset."
12348   (if (member gnus-newsgroup-name '("nndraft:delayed" "nndraft:drafts"))
12349       (setq gnus-newsgroup-charset nil)
12350     (let* ((ignored-charsets
12351             (or gnus-newsgroup-ephemeral-ignored-charsets
12352                 (append
12353                  (and gnus-newsgroup-name
12354                       (gnus-parameter-ignored-charsets gnus-newsgroup-name))
12355                  gnus-newsgroup-ignored-charsets))))
12356       (setq gnus-newsgroup-charset
12357             (or gnus-newsgroup-ephemeral-charset
12358                 (and gnus-newsgroup-name
12359                      (gnus-parameter-charset gnus-newsgroup-name))
12360                 gnus-default-charset))
12361       (set (make-local-variable 'gnus-newsgroup-ignored-charsets)
12362            ignored-charsets))))
12363
12364 ;;;
12365 ;;; Mime Commands
12366 ;;;
12367
12368 (defun gnus-summary-display-buttonized (&optional show-all-parts)
12369   "Display the current article buffer fully MIME-buttonized.
12370 If SHOW-ALL-PARTS (the prefix) is non-nil, all multipart/* parts are
12371 treated as multipart/mixed."
12372   (interactive "P")
12373   (require 'gnus-art)
12374   (let ((gnus-unbuttonized-mime-types nil)
12375         (gnus-mime-display-multipart-as-mixed show-all-parts))
12376     (gnus-summary-show-article)))
12377
12378 (defun gnus-summary-repair-multipart (article)
12379   "Add a Content-Type header to a multipart article without one."
12380   (interactive (list (gnus-summary-article-number)))
12381   (gnus-with-article article
12382     (message-narrow-to-head)
12383     (message-remove-header "Mime-Version")
12384     (goto-char (point-max))
12385     (insert "Mime-Version: 1.0\n")
12386     (widen)
12387     (when (search-forward "\n--" nil t)
12388       (let ((separator (buffer-substring (point) (point-at-eol))))
12389         (message-narrow-to-head)
12390         (message-remove-header "Content-Type")
12391         (goto-char (point-max))
12392         (insert (format "Content-Type: multipart/mixed; boundary=\"%s\"\n"
12393                         separator))
12394         (widen))))
12395   (let (gnus-mark-article-hook)
12396     (gnus-summary-select-article t t nil article)))
12397
12398 (defun gnus-summary-toggle-display-buttonized ()
12399   "Toggle the buttonizing of the article buffer."
12400   (interactive)
12401   (require 'gnus-art)
12402   (if (setq gnus-inhibit-mime-unbuttonizing
12403             (not gnus-inhibit-mime-unbuttonizing))
12404       (let ((gnus-unbuttonized-mime-types nil))
12405         (gnus-summary-show-article))
12406     (gnus-summary-show-article)))
12407
12408 ;;;
12409 ;;; Generic summary marking commands
12410 ;;;
12411
12412 (defvar gnus-summary-marking-alist
12413   '((read gnus-del-mark "d")
12414     (unread gnus-unread-mark "u")
12415     (ticked gnus-ticked-mark "!")
12416     (dormant gnus-dormant-mark "?")
12417     (expirable gnus-expirable-mark "e"))
12418   "An alist of names/marks/keystrokes.")
12419
12420 (defvar gnus-summary-generic-mark-map (make-sparse-keymap))
12421 (defvar gnus-summary-mark-map)
12422
12423 (defun gnus-summary-make-all-marking-commands ()
12424   (define-key gnus-summary-mark-map "M" gnus-summary-generic-mark-map)
12425   (dolist (elem gnus-summary-marking-alist)
12426     (apply 'gnus-summary-make-marking-command elem)))
12427
12428 (defun gnus-summary-make-marking-command (name mark keystroke)
12429   (let ((map (make-sparse-keymap)))
12430     (define-key gnus-summary-generic-mark-map keystroke map)
12431     (dolist (lway `((next "next" next nil "n")
12432                     (next-unread "next unread" next t "N")
12433                     (prev "previous" prev nil "p")
12434                     (prev-unread "previous unread" prev t "P")
12435                     (nomove "" nil nil ,keystroke)))
12436       (let ((func (gnus-summary-make-marking-command-1
12437                    mark (car lway) lway name)))
12438         (setq func (eval func))
12439         (define-key map (nth 4 lway) func)))))
12440
12441 (defun gnus-summary-make-marking-command-1 (mark way lway name)
12442   `(defun ,(intern
12443             (format "gnus-summary-put-mark-as-%s%s"
12444                     name (if (eq way 'nomove)
12445                              ""
12446                            (concat "-" (symbol-name way)))))
12447      (n)
12448      ,(format
12449        "Mark the current article as %s%s.
12450 If N, the prefix, then repeat N times.
12451 If N is negative, move in reverse order.
12452 The difference between N and the actual number of articles marked is
12453 returned."
12454        name (cadr lway))
12455      (interactive "p")
12456      (gnus-summary-generic-mark n ,mark ',(nth 2 lway) ,(nth 3 lway))))
12457
12458 (defun gnus-summary-generic-mark (n mark move unread)
12459   "Mark N articles with MARK."
12460   (unless (eq major-mode 'gnus-summary-mode)
12461     (error "This command can only be used in the summary buffer"))
12462   (gnus-summary-show-thread)
12463   (let ((nummove
12464          (cond
12465           ((eq move 'next) 1)
12466           ((eq move 'prev) -1)
12467           (t 0))))
12468     (if (zerop nummove)
12469         (setq n 1)
12470       (when (< n 0)
12471         (setq n (abs n)
12472               nummove (* -1 nummove))))
12473     (while (and (> n 0)
12474                 (gnus-summary-mark-article nil mark)
12475                 (zerop (gnus-summary-next-subject nummove unread t)))
12476       (setq n (1- n)))
12477     (when (/= 0 n)
12478       (gnus-message 7 "No more %sarticles" (if mark "" "unread ")))
12479     (gnus-summary-recenter)
12480     (gnus-summary-position-point)
12481     (gnus-set-mode-line 'summary)
12482     n))
12483
12484 (defun gnus-summary-insert-articles (articles)
12485   (when (setq articles
12486               (gnus-sorted-difference articles
12487                                       (mapcar (lambda (h)
12488                                                 (mail-header-number h))
12489                                               gnus-newsgroup-headers)))
12490     (setq gnus-newsgroup-headers
12491           (gnus-merge 'list
12492                       gnus-newsgroup-headers
12493                       (gnus-fetch-headers articles)
12494                       'gnus-article-sort-by-number))
12495     ;; Suppress duplicates?
12496     (when gnus-suppress-duplicates
12497       (gnus-dup-suppress-articles))
12498
12499     (if (and gnus-fetch-old-headers
12500              (eq gnus-headers-retrieved-by 'nov))
12501         ;; We might want to build some more threads first.
12502         (if (eq gnus-fetch-old-headers 'invisible)
12503             (gnus-build-all-threads)
12504           (gnus-build-old-threads))
12505       ;; Mark the inserted articles that are unread as unread.
12506       (setq gnus-newsgroup-unreads
12507             (gnus-sorted-nunion
12508              gnus-newsgroup-unreads
12509              (gnus-sorted-nintersection
12510               (gnus-list-of-unread-articles gnus-newsgroup-name)
12511               articles)))
12512       ;; Mark the inserted articles as selected so that the information
12513       ;; of the marks having been changed by a user may be updated when
12514       ;; exiting this group.  See `gnus-summary-update-info'.
12515       (dolist (art articles)
12516         (setq gnus-newsgroup-unselected (delq art gnus-newsgroup-unselected))))
12517     ;; Let the Gnus agent mark articles as read.
12518     (when gnus-agent
12519       (gnus-agent-get-undownloaded-list))
12520     ;; Remove list identifiers from subject
12521     (when gnus-list-identifiers
12522       (gnus-summary-remove-list-identifiers))
12523     ;; First and last article in this newsgroup.
12524     (when gnus-newsgroup-headers
12525       (setq gnus-newsgroup-begin
12526             (mail-header-number (car gnus-newsgroup-headers))
12527             gnus-newsgroup-end
12528             (mail-header-number
12529              (gnus-last-element gnus-newsgroup-headers))))
12530     (when gnus-use-scoring
12531       (gnus-possibly-score-headers))))
12532
12533 (defun gnus-summary-insert-old-articles (&optional all)
12534   "Insert all old articles in this group.
12535 If ALL is non-nil, already read articles become readable.
12536 If ALL is a number, fetch this number of articles."
12537   (interactive "P")
12538   (prog1
12539       (let ((old (sort (mapcar 'car gnus-newsgroup-data) '<))
12540             older len)
12541         (setq older
12542               ;; Some nntp servers lie about their active range.  When
12543               ;; this happens, the active range can be in the millions.
12544               ;; Use a compressed range to avoid creating a huge list.
12545               (gnus-range-difference (list gnus-newsgroup-active) old))
12546         (setq len (gnus-range-length older))
12547         (cond
12548          ((null older) nil)
12549          ((numberp all)
12550           (if (< all len)
12551               (let ((older-range (nreverse older)))
12552                 (setq older nil)
12553
12554                 (while (> all 0)
12555                   (let* ((r (pop older-range))
12556                          (min (if (numberp r) r (car r)))
12557                          (max (if (numberp r) r (cdr r))))
12558                     (while (and (<= min max)
12559                                 (> all 0))
12560                       (push max older)
12561                       (setq all (1- all)
12562                             max (1- max))))))
12563             (setq older (gnus-uncompress-range older))))
12564          (all
12565           (setq older (gnus-uncompress-range older)))
12566          (t
12567           (when (and (numberp gnus-large-newsgroup)
12568                    (> len gnus-large-newsgroup))
12569               (let* ((cursor-in-echo-area nil)
12570                      (initial (gnus-parameter-large-newsgroup-initial
12571                                gnus-newsgroup-name))
12572                      (input
12573                       (read-string
12574                        (format
12575                         "How many articles from %s (%s %d): "
12576                         (gnus-group-decoded-name gnus-newsgroup-name)
12577                         (if initial "max" "default")
12578                         len)
12579                        (if initial
12580                            (cons (number-to-string initial)
12581                                  0)))))
12582                 (unless (string-match "^[ \t]*$" input)
12583                   (setq all (string-to-number input))
12584                   (if (< all len)
12585                       (let ((older-range (nreverse older)))
12586                         (setq older nil)
12587
12588                         (while (> all 0)
12589                           (let* ((r (pop older-range))
12590                                  (min (if (numberp r) r (car r)))
12591                                  (max (if (numberp r) r (cdr r))))
12592                             (while (and (<= min max)
12593                                         (> all 0))
12594                               (push max older)
12595                               (setq all (1- all)
12596                                     max (1- max))))))))))
12597           (setq older (gnus-uncompress-range older))))
12598         (if (not older)
12599             (message "No old news.")
12600           (gnus-summary-insert-articles older)
12601           (gnus-summary-limit (gnus-sorted-nunion old older))))
12602     (gnus-summary-position-point)))
12603
12604 (defun gnus-summary-insert-new-articles ()
12605   "Insert all new articles in this group."
12606   (interactive)
12607   (prog1
12608       (let ((old (sort (mapcar 'car gnus-newsgroup-data) '<))
12609             (old-active gnus-newsgroup-active)
12610             (nnmail-fetched-sources (list t))
12611             i new)
12612         (setq gnus-newsgroup-active
12613               (gnus-activate-group gnus-newsgroup-name 'scan))
12614         (setq i (cdr gnus-newsgroup-active))
12615         (while (> i (cdr old-active))
12616           (push i new)
12617           (decf i))
12618         (if (not new)
12619             (message "No gnus is bad news")
12620           (gnus-summary-insert-articles new)
12621           (setq gnus-newsgroup-unreads
12622                 (gnus-sorted-nunion gnus-newsgroup-unreads new))
12623           (gnus-summary-limit (gnus-sorted-nunion old new))))
12624     (gnus-summary-position-point)))
12625
12626 ;;; Bookmark support for Gnus.
12627 (declare-function bookmark-make-record-default
12628                   "bookmark" (&optional no-file no-context posn))
12629 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
12630 (declare-function bookmark-default-handler "bookmark" (bmk))
12631 (declare-function bookmark-get-bookmark-record "bookmark" (bmk))
12632 (defvar bookmark-yank-point)
12633 (defvar bookmark-current-buffer)
12634
12635 (defun gnus-summary-bookmark-make-record ()
12636   "Make a bookmark entry for a Gnus summary buffer."
12637   (let (pos buf)
12638     (unless (and (derived-mode-p 'gnus-summary-mode) gnus-article-current)
12639       (save-restriction              ; FIXME is it necessary to widen?
12640         (widen) (setq pos (point))) ; Set position in gnus-article buffer.
12641       (setq buf "art") ; We are recording bookmark from article buffer.
12642       (setq bookmark-yank-point (point))
12643       (setq bookmark-current-buffer (current-buffer))
12644       (gnus-article-show-summary))      ; Go back in summary buffer.
12645     ;; We are now recording bookmark from summary buffer.
12646     (unless buf (setq buf "sum"))
12647     (let* ((subject (elt (gnus-summary-article-header) 1))
12648            (grp     (car gnus-article-current))
12649            (art     (cdr gnus-article-current))
12650            (head    (gnus-summary-article-header art))
12651            (id      (mail-header-id head)))
12652       `(,subject
12653         ,@(condition-case nil
12654               (bookmark-make-record-default 'no-file 'no-context pos)
12655             (wrong-number-of-arguments
12656              (bookmark-make-record-default 'point-only)))
12657         (location . ,(format "Gnus-%s %s:%d:%s" buf grp art id))
12658         (group . ,grp) (article . ,art)
12659         (message-id . ,id) (handler . gnus-summary-bookmark-jump)))))
12660
12661 ;;;###autoload
12662 (defun gnus-summary-bookmark-jump (bookmark)
12663   "Handler function for record returned by `gnus-summary-bookmark-make-record'.
12664 BOOKMARK is a bookmark name or a bookmark record."
12665   (let ((group    (bookmark-prop-get bookmark 'group))
12666         (article  (bookmark-prop-get bookmark 'article))
12667         (id       (bookmark-prop-get bookmark 'message-id))
12668         (buf      (car (split-string (bookmark-prop-get bookmark 'location)))))
12669     (gnus-fetch-group group (list article))
12670     (gnus-summary-insert-cached-articles)
12671     (gnus-summary-goto-article id nil 'force)
12672     ;; FIXME we have to wait article buffer is ready (only large buffer)
12673     ;; Is there a better solution to know that?
12674     ;; If we don't wait `bookmark-default-handler' will have no chance
12675     ;; to set position. However there is no error, just wrong pos.
12676     (sit-for 1)
12677     (when (string= buf "Gnus-art")
12678       (other-window 1))
12679     (bookmark-default-handler
12680      `(""
12681        (buffer . ,(current-buffer))
12682        . ,(bookmark-get-bookmark-record bookmark)))))
12683
12684 (gnus-summary-make-all-marking-commands)
12685
12686 (gnus-ems-redefine)
12687
12688 (provide 'gnus-sum)
12689
12690 (run-hooks 'gnus-sum-load-hook)
12691
12692 ;; Local Variables:
12693 ;; coding: iso-8859-1
12694 ;; End:
12695
12696 ;;; gnus-sum.el ends here