Remove useless gnus-newsgroup-none-id
[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 'unseen-or-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 "24.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 nil
989   "*A hook called when a summary line is changed.
990 The hook will not be called if `gnus-visual' is nil.
991
992 The default function `gnus-summary-highlight-line' will
993 highlight the line according to the `gnus-summary-highlight'
994 variable."
995   :group 'gnus-summary-visual
996   :type 'hook)
997
998 (defcustom gnus-mark-article-hook '(gnus-summary-mark-read-and-unread-as-read)
999   "*A hook called when an article is selected for the first time.
1000 The hook is intended to mark an article as read (or unread)
1001 automatically when it is selected."
1002   :group 'gnus-summary-choose
1003   :type 'hook)
1004
1005 (defcustom gnus-group-no-more-groups-hook nil
1006   "*A hook run when returning to group mode having no more (unread) groups."
1007   :group 'gnus-group-select
1008   :type 'hook)
1009
1010 (defcustom gnus-ps-print-hook nil
1011   "*A hook run before ps-printing something from Gnus."
1012   :group 'gnus-summary
1013   :type 'hook)
1014
1015 (defcustom gnus-summary-article-move-hook nil
1016   "*A hook called after an article is moved, copied, respooled, or crossposted."
1017   :version "22.1"
1018   :group 'gnus-summary
1019   :type 'hook)
1020
1021 (defcustom gnus-summary-article-delete-hook nil
1022   "*A hook called after an article is deleted."
1023   :version "22.1"
1024   :group 'gnus-summary
1025   :type 'hook)
1026
1027 (defcustom gnus-summary-article-expire-hook nil
1028   "*A hook called after an article is expired."
1029   :version "22.1"
1030   :group 'gnus-summary
1031   :type 'hook)
1032
1033 (defcustom gnus-summary-display-arrow
1034   (and (fboundp 'display-graphic-p)
1035        (display-graphic-p))
1036   "*If non-nil, display an arrow highlighting the current article."
1037   :version "22.1"
1038   :group 'gnus-summary
1039   :type 'boolean)
1040
1041 (defcustom gnus-summary-selected-face 'gnus-summary-selected
1042   "Face used for highlighting the current article in the summary buffer."
1043   :group 'gnus-summary-visual
1044   :type 'face)
1045
1046 (defvar gnus-tmp-downloaded nil)
1047
1048 (defcustom gnus-summary-highlight
1049   '(((eq mark gnus-canceled-mark)
1050      . gnus-summary-cancelled)
1051     ((and uncached (> score default-high))
1052      . gnus-summary-high-undownloaded)
1053     ((and uncached (< score default-low))
1054      . gnus-summary-low-undownloaded)
1055     (uncached
1056      . gnus-summary-normal-undownloaded)
1057     ((and (> score default-high)
1058           (or (eq mark gnus-dormant-mark)
1059               (eq mark gnus-ticked-mark)))
1060      . gnus-summary-high-ticked)
1061     ((and (< score default-low)
1062           (or (eq mark gnus-dormant-mark)
1063               (eq mark gnus-ticked-mark)))
1064      . gnus-summary-low-ticked)
1065     ((or (eq mark gnus-dormant-mark)
1066          (eq mark gnus-ticked-mark))
1067      . gnus-summary-normal-ticked)
1068     ((and (> score default-high) (eq mark gnus-ancient-mark))
1069      . gnus-summary-high-ancient)
1070     ((and (< score default-low) (eq mark gnus-ancient-mark))
1071      . gnus-summary-low-ancient)
1072     ((eq mark gnus-ancient-mark)
1073      . gnus-summary-normal-ancient)
1074     ((and (> score default-high) (eq mark gnus-unread-mark))
1075      . gnus-summary-high-unread)
1076     ((and (< score default-low) (eq mark gnus-unread-mark))
1077      . gnus-summary-low-unread)
1078     ((eq mark gnus-unread-mark)
1079      . gnus-summary-normal-unread)
1080     ((> score default-high)
1081      . gnus-summary-high-read)
1082     ((< score default-low)
1083      . gnus-summary-low-read)
1084     (t
1085      . gnus-summary-normal-read))
1086   "*Controls the highlighting of summary buffer lines.
1087
1088 A list of (FORM . FACE) pairs.  When deciding how a particular
1089 summary line should be displayed, each form is evaluated.  The content
1090 of the face field after the first true form is used.  You can change
1091 how those summary lines are displayed, by editing the face field.
1092
1093 You can use the following variables in the FORM field.
1094
1095 score:        The article's score.
1096 default:      The default article score.
1097 default-high: The default score for high scored articles.
1098 default-low:  The default score for low scored articles.
1099 below:        The score below which articles are automatically marked as read.
1100 mark:         The article's mark.
1101 uncached:     Non-nil if the article is uncached."
1102   :group 'gnus-summary-visual
1103   :type '(repeat (cons (sexp :tag "Form" nil)
1104                        face)))
1105 (put 'gnus-summary-highlight 'risky-local-variable t)
1106
1107 (defcustom gnus-alter-header-function nil
1108   "Function called to allow alteration of article header structures.
1109 The function is called with one parameter, the article header vector,
1110 which it may alter in any way."
1111   :type '(choice (const :tag "None" nil)
1112                  function)
1113   :group 'gnus-summary)
1114
1115 (defvar gnus-decode-encoded-word-function 'mail-decode-encoded-word-string
1116   "Function used to decode a string with encoded words.")
1117
1118 (defvar gnus-decode-encoded-address-function
1119   'mail-decode-encoded-address-string
1120   "Function used to decode addresses with encoded words.")
1121
1122 (defcustom gnus-extra-headers '(To Newsgroups)
1123   "*Extra headers to parse."
1124   :version "21.1"
1125   :group 'gnus-summary
1126   :type '(repeat symbol))
1127
1128 (defcustom gnus-ignored-from-addresses
1129   (and user-mail-address
1130        (not (string= user-mail-address ""))
1131        (regexp-quote user-mail-address))
1132   "*From headers that may be suppressed in favor of To headers.
1133 This can be a regexp or a list of regexps."
1134   :version "21.1"
1135   :group 'gnus-summary
1136   :type '(choice regexp
1137                  (repeat :tag "Regexp List" regexp)))
1138
1139 (defsubst gnus-ignored-from-addresses ()
1140   (gmm-regexp-concat gnus-ignored-from-addresses))
1141
1142 (defcustom gnus-summary-to-prefix "-> "
1143   "*String prefixed to the To field in the summary line when
1144 using `gnus-ignored-from-addresses'."
1145   :version "22.1"
1146   :group 'gnus-summary
1147   :type 'string)
1148
1149 (defcustom gnus-summary-newsgroup-prefix "=> "
1150   "*String prefixed to the Newsgroup field in the summary
1151 line when using `gnus-ignored-from-addresses'."
1152   :version "22.1"
1153   :group 'gnus-summary
1154   :type 'string)
1155
1156 (defcustom gnus-newsgroup-ignored-charsets '(unknown-8bit x-unknown)
1157   "List of charsets that should be ignored.
1158 When these charsets are used in the \"charset\" parameter, the
1159 default charset will be used instead."
1160   :version "21.1"
1161   :type '(repeat symbol)
1162   :group 'gnus-charset)
1163
1164 (defcustom gnus-newsgroup-maximum-articles nil
1165   "The maximum number of articles a newsgroup.
1166 If this is a number, old articles in a newsgroup exceeding this number
1167 are silently ignored.  If it is nil, no article is ignored.  Note that
1168 setting this variable to a number might prevent you from reading very
1169 old articles."
1170   :group 'gnus-group-select
1171   :version "22.2"
1172   :type '(choice (const :tag "No limit" nil)
1173                  integer))
1174
1175 (gnus-define-group-parameter
1176  ignored-charsets
1177  :type list
1178  :function-document
1179  "Return the ignored charsets of GROUP."
1180  :variable gnus-group-ignored-charsets-alist
1181  :variable-default
1182  '(("alt\\.chinese\\.text" iso-8859-1))
1183  :variable-document
1184  "Alist of regexps (to match group names) and charsets that should be ignored.
1185 When these charsets are used in the \"charset\" parameter, the
1186 default charset will be used instead."
1187  :variable-group gnus-charset
1188  :variable-type '(repeat (cons (regexp :tag "Group")
1189                                (repeat symbol)))
1190  :parameter-type '(choice :tag "Ignored charsets"
1191                           :value nil
1192                           (repeat (symbol)))
1193  :parameter-document       "\
1194 List of charsets that should be ignored.
1195
1196 When these charsets are used in the \"charset\" parameter, the
1197 default charset will be used instead.")
1198
1199 (defcustom gnus-group-highlight-words-alist nil
1200   "Alist of group regexps and highlight regexps.
1201 This variable uses the same syntax as `gnus-emphasis-alist'."
1202   :version "21.1"
1203   :type '(repeat (cons (regexp :tag "Group")
1204                        (repeat (list (regexp :tag "Highlight regexp")
1205                                      (number :tag "Group for entire word" 0)
1206                                      (number :tag "Group for displayed part" 0)
1207                                      (symbol :tag "Face"
1208                                              gnus-emphasis-highlight-words)))))
1209   :group 'gnus-summary-visual)
1210
1211 (defcustom gnus-summary-show-article-charset-alist
1212   nil
1213   "Alist of number and charset.
1214 The article will be shown with the charset corresponding to the
1215 numbered argument.
1216 For example: ((1 . cn-gb-2312) (2 . big5))."
1217   :version "21.1"
1218   :type '(repeat (cons (number :tag "Argument" 1)
1219                        (symbol :tag "Charset")))
1220   :group 'gnus-charset)
1221
1222 (defcustom gnus-preserve-marks t
1223   "Whether marks are preserved when moving, copying and respooling messages."
1224   :version "21.1"
1225   :type 'boolean
1226   :group 'gnus-summary-marks)
1227
1228 (defcustom gnus-propagate-marks t
1229   "If non-nil, do not propagate marks to the backends."
1230   :version "23.1" ;; No Gnus
1231   :type 'boolean
1232   :group 'gnus-summary-marks)
1233
1234 (defcustom gnus-alter-articles-to-read-function nil
1235   "Function to be called to alter the list of articles to be selected."
1236   :type '(choice (const nil) function)
1237   :group 'gnus-summary)
1238
1239 (defcustom gnus-orphan-score nil
1240   "*All orphans get this score added.  Set in the score file."
1241   :group 'gnus-score-default
1242   :type '(choice (const nil)
1243                  integer))
1244
1245 (defcustom gnus-summary-save-parts-default-mime "image/.*"
1246   "*A regexp to match MIME parts when saving multiple parts of a
1247 message with `gnus-summary-save-parts' (\\<gnus-summary-mode-map>\\[gnus-summary-save-parts]).
1248 This regexp will be used by default when prompting the user for which
1249 type of files to save."
1250   :group 'gnus-summary
1251   :type 'regexp)
1252
1253 (defcustom gnus-read-all-available-headers nil
1254   "Whether Gnus should parse all headers made available to it.
1255 This is mostly relevant for slow back ends where the user may
1256 wish to widen the summary buffer to include all headers
1257 that were fetched."
1258   :version "22.1"
1259   :group 'gnus-summary
1260   :type '(choice boolean regexp))
1261
1262 (defcustom gnus-summary-pipe-output-default-command nil
1263   "Command (and optional arguments) used to pipe article to subprocess.
1264 This will be used as the default command if it is non-nil.  The value
1265 will be updated if you modify it when executing the command
1266 `gnus-summary-pipe-output' or the function `gnus-summary-save-in-pipe'."
1267   :version "23.1" ;; No Gnus
1268   :group 'gnus-summary
1269   :type '(radio (const :tag "None" nil) (string :tag "Command")))
1270
1271 (defcustom gnus-summary-muttprint-program "muttprint"
1272   "Command (and optional arguments) used to run Muttprint.
1273 The value will be updated if you modify it when executing the command
1274 `gnus-summary-muttprint'."
1275   :version "22.1"
1276   :group 'gnus-summary
1277   :type 'string)
1278
1279 (defcustom gnus-article-loose-mime t
1280   "If non-nil, don't require MIME-Version header.
1281 Some brain-damaged MUA/MTA, e.g. Lotus Domino 5.0.6 clients, does not
1282 supply the MIME-Version header or deliberately strip it from the mail.
1283 If non-nil (the default), Gnus will treat some articles as MIME
1284 even if the MIME-Version header is missing."
1285   :version "22.1"
1286   :type 'boolean
1287   :group 'gnus-article-mime)
1288
1289 (defcustom gnus-article-emulate-mime t
1290   "If non-nil, use MIME emulation for uuencode and the like.
1291 This means that Gnus will search message bodies for text that look
1292 like uuencoded bits, yEncoded bits, and so on, and present that using
1293 the normal Gnus MIME machinery."
1294   :version "22.1"
1295   :type 'boolean
1296   :group 'gnus-article-mime)
1297
1298 ;;; Internal variables
1299
1300 (defvar gnus-summary-display-cache nil)
1301 (defvar gnus-article-mime-handles nil)
1302 (defvar gnus-article-decoded-p nil)
1303 (defvar gnus-article-charset nil)
1304 (defvar gnus-article-ignored-charsets nil)
1305 (defvar gnus-scores-exclude-files nil)
1306 (defvar gnus-page-broken nil)
1307
1308 (defvar gnus-original-article nil)
1309 (defvar gnus-article-internal-prepare-hook nil)
1310 (defvar gnus-newsgroup-process-stack nil)
1311
1312 (defvar gnus-thread-indent-array nil)
1313 (defvar gnus-thread-indent-array-level gnus-thread-indent-level)
1314 (defvar gnus-sort-gathered-threads-function 'gnus-thread-sort-by-number
1315   "Function called to sort the articles within a thread after it has been gathered together.")
1316
1317 (defvar gnus-summary-save-parts-type-history nil)
1318 (defvar gnus-summary-save-parts-last-directory mm-default-directory)
1319
1320 ;; Avoid highlighting in kill files.
1321 (defvar gnus-summary-inhibit-highlight nil)
1322 (defvar gnus-newsgroup-selected-overlay nil)
1323 (defvar gnus-inhibit-limiting nil)
1324 (defvar gnus-newsgroup-adaptive-score-file nil)
1325 (defvar gnus-current-score-file nil)
1326 (defvar gnus-current-move-group nil)
1327 (defvar gnus-current-copy-group nil)
1328 (defvar gnus-current-crosspost-group nil)
1329 (defvar gnus-newsgroup-display nil)
1330
1331 (defvar gnus-newsgroup-dependencies nil)
1332 (defvar gnus-newsgroup-adaptive nil)
1333 (defvar gnus-summary-display-article-function nil)
1334 (defvar gnus-summary-highlight-line-function nil
1335   "Function called after highlighting a summary line.")
1336
1337 (defvar gnus-summary-line-format-alist
1338   `((?N ,(macroexpand '(mail-header-number gnus-tmp-header)) ?d)
1339     (?S ,(macroexpand '(mail-header-subject gnus-tmp-header)) ?s)
1340     (?s gnus-tmp-subject-or-nil ?s)
1341     (?n gnus-tmp-name ?s)
1342     (?A (car (cdr (funcall gnus-extract-address-components gnus-tmp-from)))
1343         ?s)
1344     (?a (or (car (funcall gnus-extract-address-components gnus-tmp-from))
1345             gnus-tmp-from) ?s)
1346     (?F gnus-tmp-from ?s)
1347     (?x ,(macroexpand '(mail-header-xref gnus-tmp-header)) ?s)
1348     (?D ,(macroexpand '(mail-header-date gnus-tmp-header)) ?s)
1349     (?d (gnus-dd-mmm (mail-header-date gnus-tmp-header)) ?s)
1350     (?o (gnus-date-iso8601 (mail-header-date gnus-tmp-header)) ?s)
1351     (?M ,(macroexpand '(mail-header-id gnus-tmp-header)) ?s)
1352     (?r ,(macroexpand '(mail-header-references gnus-tmp-header)) ?s)
1353     (?c (or (mail-header-chars gnus-tmp-header) 0) ?d)
1354     (?k (gnus-summary-line-message-size gnus-tmp-header) ?s)
1355     (?L gnus-tmp-lines ?s)
1356     (?O gnus-tmp-downloaded ?c)
1357     (?I gnus-tmp-indentation ?s)
1358     (?T (if (= gnus-tmp-level 0) "" (make-string (frame-width) ? )) ?s)
1359     (?R gnus-tmp-replied ?c)
1360     (?\[ gnus-tmp-opening-bracket ?c)
1361     (?\] gnus-tmp-closing-bracket ?c)
1362     (?\> (make-string gnus-tmp-level ? ) ?s)
1363     (?\< (make-string (max 0 (- 20 gnus-tmp-level)) ? ) ?s)
1364     (?i gnus-tmp-score ?d)
1365     (?z gnus-tmp-score-char ?c)
1366     (?V (gnus-thread-total-score (and (boundp 'thread) (car thread))) ?d)
1367     (?U gnus-tmp-unread ?c)
1368     (?f (gnus-summary-from-or-to-or-newsgroups gnus-tmp-header gnus-tmp-from)
1369         ?s)
1370     (?t (gnus-summary-number-of-articles-in-thread
1371          (and (boundp 'thread) (car thread)) gnus-tmp-level)
1372         ?d)
1373     (?e (gnus-summary-number-of-articles-in-thread
1374          (and (boundp 'thread) (car thread)) gnus-tmp-level t)
1375         ?c)
1376     (?u gnus-tmp-user-defined ?s)
1377     (?P (gnus-pick-line-number) ?d)
1378     (?B gnus-tmp-thread-tree-header-string ?s)
1379     (user-date (gnus-user-date
1380                 ,(macroexpand '(mail-header-date gnus-tmp-header))) ?s))
1381   "An alist of format specifications that can appear in summary lines.
1382 These are paired with what variables they correspond with, along with
1383 the type of the variable (string, integer, character, etc).")
1384
1385 (defvar gnus-summary-dummy-line-format-alist
1386   `((?S gnus-tmp-subject ?s)
1387     (?N gnus-tmp-number ?d)
1388     (?u gnus-tmp-user-defined ?s)))
1389
1390 (defvar gnus-summary-mode-line-format-alist
1391   `((?G gnus-tmp-group-name ?s)
1392     (?g (gnus-short-group-name gnus-tmp-group-name) ?s)
1393     (?p (gnus-group-real-name gnus-tmp-group-name) ?s)
1394     (?A gnus-tmp-article-number ?d)
1395     (?Z gnus-tmp-unread-and-unselected ?s)
1396     (?V gnus-version ?s)
1397     (?U gnus-tmp-unread-and-unticked ?d)
1398     (?S gnus-tmp-subject ?s)
1399     (?e gnus-tmp-unselected ?d)
1400     (?u gnus-tmp-user-defined ?s)
1401     (?d (length gnus-newsgroup-dormant) ?d)
1402     (?t (length gnus-newsgroup-marked) ?d)
1403     (?h (length gnus-newsgroup-spam-marked) ?d)
1404     (?r (length gnus-newsgroup-reads) ?d)
1405     (?z (gnus-summary-article-score gnus-tmp-article-number) ?d)
1406     (?E gnus-newsgroup-expunged-tally ?d)
1407     (?s (gnus-current-score-file-nondirectory) ?s)))
1408
1409 ;; This is here rather than in gnus-art for compilation reasons.
1410 (defvar gnus-article-mode-line-format-alist
1411   (nconc '((?w (gnus-article-wash-status) ?s)
1412            (?m (gnus-article-mime-part-status) ?s))
1413          gnus-summary-mode-line-format-alist))
1414
1415 (defvar gnus-last-search-regexp nil
1416   "Default regexp for article search command.")
1417
1418 (defvar gnus-last-shell-command nil
1419   "Default shell command on article.")
1420
1421 (defvar gnus-newsgroup-agentized nil
1422   "Locally bound in each summary buffer to indicate whether the server has been agentized.")
1423 (defvar gnus-newsgroup-begin nil)
1424 (defvar gnus-newsgroup-end nil)
1425 (defvar gnus-newsgroup-last-rmail nil)
1426 (defvar gnus-newsgroup-last-mail nil)
1427 (defvar gnus-newsgroup-last-folder nil)
1428 (defvar gnus-newsgroup-last-file nil)
1429 (defvar gnus-newsgroup-last-directory nil)
1430 (defvar gnus-newsgroup-auto-expire nil)
1431 (defvar gnus-newsgroup-active nil)
1432
1433 (defvar gnus-newsgroup-data nil)
1434 (defvar gnus-newsgroup-data-reverse nil)
1435 (defvar gnus-newsgroup-limit nil)
1436 (defvar gnus-newsgroup-limits nil)
1437 (defvar gnus-summary-use-undownloaded-faces nil)
1438
1439 (defvar gnus-newsgroup-unreads nil
1440   "Sorted list of unread articles in the current newsgroup.")
1441
1442 (defvar gnus-newsgroup-unselected nil
1443   "Sorted list of unselected unread articles in the current newsgroup.")
1444
1445 (defvar gnus-newsgroup-reads nil
1446   "Alist of read articles and article marks in the current newsgroup.")
1447
1448 (defvar gnus-newsgroup-expunged-tally nil)
1449
1450 (defvar gnus-newsgroup-marked nil
1451   "Sorted list of ticked articles in the current newsgroup (a subset of unread art).")
1452
1453 (defvar gnus-newsgroup-spam-marked nil
1454   "List of ranges of articles that have been marked as spam.")
1455
1456 (defvar gnus-newsgroup-killed nil
1457   "List of ranges of articles that have been through the scoring process.")
1458
1459 (defvar gnus-newsgroup-cached nil
1460   "Sorted list of articles that come from the article cache.")
1461
1462 (defvar gnus-newsgroup-saved nil
1463   "List of articles that have been saved.")
1464
1465 (defvar gnus-newsgroup-kill-headers nil)
1466
1467 (defvar gnus-newsgroup-replied nil
1468   "List of articles that have been replied to in the current newsgroup.")
1469
1470 (defvar gnus-newsgroup-forwarded nil
1471   "List of articles that have been forwarded in the current newsgroup.")
1472
1473 (defvar gnus-newsgroup-recent nil
1474   "List of articles that have are recent in the current newsgroup.")
1475
1476 (defvar gnus-newsgroup-expirable nil
1477   "Sorted list of articles in the current newsgroup that can be expired.")
1478
1479 (defvar gnus-newsgroup-processable nil
1480   "List of articles in the current newsgroup that can be processed.")
1481
1482 (defvar gnus-newsgroup-downloadable nil
1483   "Sorted list of articles in the current newsgroup that can be processed.")
1484
1485 (defvar gnus-newsgroup-unfetched nil
1486   "Sorted list of articles in the current newsgroup whose headers have
1487 not been fetched into the agent.
1488
1489 This list will always be a subset of gnus-newsgroup-undownloaded.")
1490
1491 (defvar gnus-newsgroup-undownloaded nil
1492   "List of articles in the current newsgroup that haven't been downloaded.")
1493
1494 (defvar gnus-newsgroup-unsendable nil
1495   "List of articles in the current newsgroup that won't be sent.")
1496
1497 (defvar gnus-newsgroup-bookmarks nil
1498   "List of articles in the current newsgroup that have bookmarks.")
1499
1500 (defvar gnus-newsgroup-dormant nil
1501   "Sorted list of dormant articles in the current newsgroup.")
1502
1503 (defvar gnus-newsgroup-unseen nil
1504   "List of unseen articles in the current newsgroup.")
1505
1506 (defvar gnus-newsgroup-seen nil
1507   "Range of seen articles in the current newsgroup.")
1508
1509 (defvar gnus-newsgroup-articles nil
1510   "List of articles in the current newsgroup.")
1511
1512 (defvar gnus-newsgroup-scored nil
1513   "List of scored articles in the current newsgroup.")
1514
1515 (defvar gnus-newsgroup-headers nil
1516   "List of article headers in the current newsgroup.")
1517
1518 (defvar gnus-newsgroup-threads nil)
1519
1520 (defvar gnus-newsgroup-prepared nil
1521   "Whether the current group has been prepared properly.")
1522
1523 (defvar gnus-newsgroup-ancient nil
1524   "List of `gnus-fetch-old-headers' articles in the current newsgroup.")
1525
1526 (defvar gnus-newsgroup-sparse nil)
1527
1528 (defvar gnus-current-article nil)
1529 (defvar gnus-article-current nil)
1530 (defvar gnus-current-headers nil)
1531 (defvar gnus-have-all-headers nil)
1532 (defvar gnus-last-article nil)
1533 (defvar gnus-newsgroup-history nil)
1534 (defvar gnus-newsgroup-charset nil)
1535 (defvar gnus-newsgroup-ephemeral-charset nil)
1536 (defvar gnus-newsgroup-ephemeral-ignored-charsets nil)
1537
1538 (defvar gnus-article-before-search nil)
1539
1540 (defvar gnus-summary-local-variables
1541   '(gnus-newsgroup-name
1542
1543     ;; Marks lists
1544     gnus-newsgroup-unreads
1545     gnus-newsgroup-unselected
1546     gnus-newsgroup-marked
1547     gnus-newsgroup-spam-marked
1548     gnus-newsgroup-reads
1549     gnus-newsgroup-saved
1550     gnus-newsgroup-replied
1551     gnus-newsgroup-forwarded
1552     gnus-newsgroup-recent
1553     gnus-newsgroup-expirable
1554     gnus-newsgroup-killed
1555     gnus-newsgroup-unseen
1556     gnus-newsgroup-seen
1557     gnus-newsgroup-cached
1558     gnus-newsgroup-downloadable
1559     gnus-newsgroup-undownloaded
1560     gnus-newsgroup-unsendable
1561
1562     gnus-newsgroup-begin gnus-newsgroup-end
1563     gnus-newsgroup-last-rmail gnus-newsgroup-last-mail
1564     gnus-newsgroup-last-folder gnus-newsgroup-last-file
1565     gnus-newsgroup-last-directory
1566     gnus-newsgroup-auto-expire
1567     gnus-newsgroup-processable
1568     gnus-newsgroup-unfetched
1569     gnus-newsgroup-articles
1570     gnus-newsgroup-bookmarks gnus-newsgroup-dormant
1571     gnus-newsgroup-headers gnus-newsgroup-threads
1572     gnus-newsgroup-prepared gnus-summary-highlight-line-function
1573     gnus-current-article gnus-current-headers gnus-have-all-headers
1574     gnus-last-article gnus-article-internal-prepare-hook
1575     gnus-newsgroup-dependencies gnus-newsgroup-selected-overlay
1576     gnus-newsgroup-scored gnus-newsgroup-kill-headers
1577     gnus-thread-expunge-below
1578     gnus-score-alist gnus-current-score-file
1579     (gnus-summary-expunge-below . global)
1580     (gnus-summary-mark-below . global)
1581     (gnus-orphan-score . global)
1582     gnus-newsgroup-active gnus-scores-exclude-files
1583     gnus-newsgroup-history gnus-newsgroup-ancient
1584     gnus-newsgroup-sparse gnus-newsgroup-process-stack
1585     (gnus-newsgroup-adaptive . gnus-use-adaptive-scoring)
1586     gnus-newsgroup-adaptive-score-file (gnus-reffed-article-number . -1)
1587     (gnus-newsgroup-expunged-tally . 0)
1588     gnus-cache-removable-articles
1589     gnus-newsgroup-data gnus-newsgroup-data-reverse
1590     gnus-newsgroup-limit gnus-newsgroup-limits
1591     gnus-newsgroup-charset gnus-newsgroup-display
1592     gnus-summary-use-undownloaded-faces)
1593   "Variables that are buffer-local to the summary buffers.")
1594
1595 (defvar gnus-newsgroup-variables nil
1596   "A list of variables that have separate values in different newsgroups.
1597 A list of newsgroup (summary buffer) local variables, or cons of
1598 variables and their default expressions to be evalled (when the default
1599 values are not nil), that should be made global while the summary buffer
1600 is active.
1601
1602 Note: The default expressions will be evaluated (using function `eval')
1603 before assignment to the local variable rather than just assigned to it.
1604 If the default expression is the symbol `global', that symbol will not
1605 be evaluated but the global value of the local variable will be used
1606 instead.
1607
1608 These variables can be used to set variables in the group parameters
1609 while still allowing them to affect operations done in other buffers.
1610 For example:
1611
1612 \(setq gnus-newsgroup-variables
1613      '(message-use-followup-to
1614        (gnus-visible-headers .
1615          \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\")))
1616 ")
1617
1618 (eval-when-compile
1619   ;; Bind features so that require will believe that gnus-sum has
1620   ;; already been loaded (avoids infinite recursion)
1621   (let ((features (cons 'gnus-sum features)))
1622     (require 'gnus-art)))
1623
1624 ;; MIME stuff.
1625
1626 (defvar gnus-decode-encoded-word-methods
1627   '(mail-decode-encoded-word-string)
1628   "List of methods used to decode encoded words.
1629
1630 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
1631 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
1632 \(REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
1633 whose names match REGEXP.
1634
1635 For example:
1636 \((\"chinese\" . gnus-decode-encoded-word-string-by-guess)
1637  mail-decode-encoded-word-string
1638  (\"chinese\" . rfc1843-decode-string))")
1639
1640 (defvar gnus-decode-encoded-word-methods-cache nil)
1641
1642 (defun gnus-multi-decode-encoded-word-string (string)
1643   "Apply the functions from `gnus-encoded-word-methods' that match."
1644   (unless (and gnus-decode-encoded-word-methods-cache
1645                (eq gnus-newsgroup-name
1646                    (car gnus-decode-encoded-word-methods-cache)))
1647     (setq gnus-decode-encoded-word-methods-cache (list gnus-newsgroup-name))
1648     (dolist (method gnus-decode-encoded-word-methods)
1649       (if (symbolp method)
1650           (nconc gnus-decode-encoded-word-methods-cache (list method))
1651         (if (and gnus-newsgroup-name
1652                  (string-match (car method) gnus-newsgroup-name))
1653             (nconc gnus-decode-encoded-word-methods-cache
1654                    (list (cdr method)))))))
1655   (dolist (method (cdr gnus-decode-encoded-word-methods-cache) string)
1656     (setq string (funcall method string))))
1657
1658 ;; Subject simplification.
1659
1660 (defun gnus-simplify-whitespace (str)
1661   "Remove excessive whitespace from STR."
1662   ;; Multiple spaces.
1663   (while (string-match "[ \t][ \t]+" str)
1664     (setq str (concat (substring str 0 (match-beginning 0))
1665                         " "
1666                         (substring str (match-end 0)))))
1667   ;; Leading spaces.
1668   (when (string-match "^[ \t]+" str)
1669     (setq str (substring str (match-end 0))))
1670   ;; Trailing spaces.
1671   (when (string-match "[ \t]+$" str)
1672     (setq str (substring str 0 (match-beginning 0))))
1673   str)
1674
1675 (defun gnus-simplify-all-whitespace (str)
1676   "Remove all whitespace from STR."
1677   (while (string-match "[ \t\n]+" str)
1678     (setq str (replace-match "" nil nil str)))
1679   str)
1680
1681 (defsubst gnus-simplify-subject-re (subject)
1682   "Remove \"Re:\" from subject lines."
1683   (if (string-match message-subject-re-regexp subject)
1684       (substring subject (match-end 0))
1685     subject))
1686
1687 (defun gnus-simplify-subject (subject &optional re-only)
1688   "Remove `Re:' and words in parentheses.
1689 If RE-ONLY is non-nil, strip leading `Re:'s only."
1690   (let ((case-fold-search t))           ;Ignore case.
1691     ;; Remove `Re:', `Re^N:', `Re(n)', and `Re[n]:'.
1692     (when (string-match "\\`\\(re\\([[(^][0-9]+[])]?\\)?:[ \t]*\\)+" subject)
1693       (setq subject (substring subject (match-end 0))))
1694     ;; Remove uninteresting prefixes.
1695     (when (and (not re-only)
1696                gnus-simplify-ignored-prefixes
1697                (string-match gnus-simplify-ignored-prefixes subject))
1698       (setq subject (substring subject (match-end 0))))
1699     ;; Remove words in parentheses from end.
1700     (unless re-only
1701       (while (string-match "[ \t\n]*([^()]*)[ \t\n]*\\'" subject)
1702         (setq subject (substring subject 0 (match-beginning 0)))))
1703     ;; Return subject string.
1704     subject))
1705
1706 ;; Remove any leading "re:"s, any trailing paren phrases, and simplify
1707 ;; all whitespace.
1708 (defsubst gnus-simplify-buffer-fuzzy-step (regexp &optional newtext)
1709   (goto-char (point-min))
1710   (while (re-search-forward regexp nil t)
1711     (replace-match (or newtext ""))))
1712
1713 (defun gnus-simplify-buffer-fuzzy ()
1714   "Simplify string in the buffer fuzzily.
1715 The string in the accessible portion of the current buffer is simplified.
1716 It is assumed to be a single-line subject.
1717 Whitespace is generally cleaned up, and miscellaneous leading/trailing
1718 matter is removed.  Additional things can be deleted by setting
1719 `gnus-simplify-subject-fuzzy-regexp'."
1720   (let ((case-fold-search t)
1721         (modified-tick))
1722     (gnus-simplify-buffer-fuzzy-step "\t" " ")
1723
1724     (while (not (eq modified-tick (buffer-modified-tick)))
1725       (setq modified-tick (buffer-modified-tick))
1726       (cond
1727        ((listp gnus-simplify-subject-fuzzy-regexp)
1728         (mapc 'gnus-simplify-buffer-fuzzy-step
1729               gnus-simplify-subject-fuzzy-regexp))
1730        (gnus-simplify-subject-fuzzy-regexp
1731         (gnus-simplify-buffer-fuzzy-step gnus-simplify-subject-fuzzy-regexp)))
1732       (gnus-simplify-buffer-fuzzy-step "^ *\\[[-+?*!][-+?*!]\\] *")
1733       (gnus-simplify-buffer-fuzzy-step
1734        "^ *\\(re\\|fw\\|fwd\\)[[{(^0-9]*[])}]?[:;] *")
1735       (gnus-simplify-buffer-fuzzy-step "^[[].*:\\( .*\\)[]]$" "\\1"))
1736
1737     (gnus-simplify-buffer-fuzzy-step " *[[{(][^()\n]*[]})] *$")
1738     (gnus-simplify-buffer-fuzzy-step "  +" " ")
1739     (gnus-simplify-buffer-fuzzy-step " $")
1740     (gnus-simplify-buffer-fuzzy-step "^ +")))
1741
1742 (defun gnus-simplify-subject-fuzzy (subject)
1743   "Simplify a subject string fuzzily.
1744 See `gnus-simplify-buffer-fuzzy' for details."
1745   (save-excursion
1746     (gnus-set-work-buffer)
1747     (let ((case-fold-search t))
1748       ;; Remove uninteresting prefixes.
1749       (when (and gnus-simplify-ignored-prefixes
1750                  (string-match gnus-simplify-ignored-prefixes subject))
1751         (setq subject (substring subject (match-end 0))))
1752       (insert subject)
1753       (inline (gnus-simplify-buffer-fuzzy))
1754       (buffer-string))))
1755
1756 (defsubst gnus-simplify-subject-fully (subject)
1757   "Simplify a subject string according to `gnus-summary-gather-subject-limit'."
1758   (cond
1759    (gnus-simplify-subject-functions
1760     (gnus-map-function gnus-simplify-subject-functions subject))
1761    ((null gnus-summary-gather-subject-limit)
1762     (gnus-simplify-subject-re subject))
1763    ((eq gnus-summary-gather-subject-limit 'fuzzy)
1764     (gnus-simplify-subject-fuzzy subject))
1765    ((numberp gnus-summary-gather-subject-limit)
1766     (truncate-string-to-width (gnus-simplify-subject-re subject)
1767                               gnus-summary-gather-subject-limit))
1768    (t
1769     subject)))
1770
1771 (defsubst gnus-subject-equal (s1 s2 &optional simple-first)
1772   "Check whether two subjects are equal.
1773 If optional argument SIMPLE-FIRST is t, first argument is already
1774 simplified."
1775   (cond
1776    ((null simple-first)
1777     (equal (gnus-simplify-subject-fully s1)
1778            (gnus-simplify-subject-fully s2)))
1779    (t
1780     (equal s1
1781            (gnus-simplify-subject-fully s2)))))
1782
1783 (defun gnus-summary-bubble-group ()
1784   "Increase the score of the current group.
1785 This is a handy function to add to `gnus-summary-exit-hook' to
1786 increase the score of each group you read."
1787   (gnus-group-add-score gnus-newsgroup-name))
1788
1789 \f
1790 ;;;
1791 ;;; Gnus summary mode
1792 ;;;
1793
1794 (put 'gnus-summary-mode 'mode-class 'special)
1795
1796 (defvar gnus-article-commands-menu)
1797
1798 ;; Non-orthogonal keys
1799
1800 (gnus-define-keys gnus-summary-mode-map
1801   " " gnus-summary-next-page
1802   "\177" gnus-summary-prev-page
1803   [delete] gnus-summary-prev-page
1804   [backspace] gnus-summary-prev-page
1805   "\r" gnus-summary-scroll-up
1806   "\M-\r" gnus-summary-scroll-down
1807   "n" gnus-summary-next-unread-article
1808   "p" gnus-summary-prev-unread-article
1809   "N" gnus-summary-next-article
1810   "P" gnus-summary-prev-article
1811   "\M-\C-n" gnus-summary-next-same-subject
1812   "\M-\C-p" gnus-summary-prev-same-subject
1813   "\M-n" gnus-summary-next-unread-subject
1814   "\M-p" gnus-summary-prev-unread-subject
1815   "." gnus-summary-first-unread-article
1816   "," gnus-summary-best-unread-article
1817   "\M-s" gnus-summary-search-article-forward
1818   "\M-r" gnus-summary-search-article-backward
1819   "\M-S" gnus-summary-repeat-search-article-forward
1820   "\M-R" gnus-summary-repeat-search-article-backward
1821   "<" gnus-summary-beginning-of-article
1822   ">" gnus-summary-end-of-article
1823   "j" gnus-summary-goto-article
1824   "^" gnus-summary-refer-parent-article
1825   "\M-^" gnus-summary-refer-article
1826   "u" gnus-summary-tick-article-forward
1827   "!" gnus-summary-tick-article-forward
1828   "U" gnus-summary-tick-article-backward
1829   "d" gnus-summary-mark-as-read-forward
1830   "D" gnus-summary-mark-as-read-backward
1831   "E" gnus-summary-mark-as-expirable
1832   "\M-u" gnus-summary-clear-mark-forward
1833   "\M-U" gnus-summary-clear-mark-backward
1834   "k" gnus-summary-kill-same-subject-and-select
1835   "\C-k" gnus-summary-kill-same-subject
1836   "\M-\C-k" gnus-summary-kill-thread
1837   "\M-\C-l" gnus-summary-lower-thread
1838   "e" gnus-summary-edit-article
1839   "#" gnus-summary-mark-as-processable
1840   "\M-#" gnus-summary-unmark-as-processable
1841   "\M-\C-t" gnus-summary-toggle-threads
1842   "\M-\C-s" gnus-summary-show-thread
1843   "\M-\C-h" gnus-summary-hide-thread
1844   "\M-\C-f" gnus-summary-next-thread
1845   "\M-\C-b" gnus-summary-prev-thread
1846   [(meta down)] gnus-summary-next-thread
1847   [(meta up)] gnus-summary-prev-thread
1848   "\M-\C-u" gnus-summary-up-thread
1849   "\M-\C-d" gnus-summary-down-thread
1850   "&" gnus-summary-execute-command
1851   "c" gnus-summary-catchup-and-exit
1852   "\C-w" gnus-summary-mark-region-as-read
1853   "\C-t" gnus-summary-toggle-truncation
1854   "?" gnus-summary-mark-as-dormant
1855   "\C-c\M-\C-s" gnus-summary-limit-include-expunged
1856   "\C-c\C-s\C-n" gnus-summary-sort-by-number
1857   "\C-c\C-s\C-m\C-n" gnus-summary-sort-by-most-recent-number
1858   "\C-c\C-s\C-l" gnus-summary-sort-by-lines
1859   "\C-c\C-s\C-c" gnus-summary-sort-by-chars
1860   "\C-c\C-s\C-a" gnus-summary-sort-by-author
1861   "\C-c\C-s\C-t" gnus-summary-sort-by-recipient
1862   "\C-c\C-s\C-s" gnus-summary-sort-by-subject
1863   "\C-c\C-s\C-d" gnus-summary-sort-by-date
1864   "\C-c\C-s\C-m\C-d" gnus-summary-sort-by-most-recent-date
1865   "\C-c\C-s\C-i" gnus-summary-sort-by-score
1866   "\C-c\C-s\C-o" gnus-summary-sort-by-original
1867   "\C-c\C-s\C-r" gnus-summary-sort-by-random
1868   "=" gnus-summary-expand-window
1869   "\C-x\C-s" gnus-summary-reselect-current-group
1870   "\M-g" gnus-summary-rescan-group
1871   "\C-c\C-r" gnus-summary-caesar-message
1872   "f" gnus-summary-followup
1873   "F" gnus-summary-followup-with-original
1874   "C" gnus-summary-cancel-article
1875   "r" gnus-summary-reply
1876   "R" gnus-summary-reply-with-original
1877   "\C-c\C-f" gnus-summary-mail-forward
1878   "o" gnus-summary-save-article
1879   "\C-o" gnus-summary-save-article-mail
1880   "|" gnus-summary-pipe-output
1881   "\M-k" gnus-summary-edit-local-kill
1882   "\M-K" gnus-summary-edit-global-kill
1883   ;; "V" gnus-version
1884   "\C-c\C-d" gnus-summary-describe-group
1885   "q" gnus-summary-exit
1886   "Q" gnus-summary-exit-no-update
1887   "\C-c\C-i" gnus-info-find-node
1888   gnus-mouse-2 gnus-mouse-pick-article
1889   [follow-link] mouse-face
1890   "m" gnus-summary-mail-other-window
1891   "a" gnus-summary-post-news
1892   "x" gnus-summary-limit-to-unread
1893   "s" gnus-summary-isearch-article
1894   "t" gnus-summary-toggle-header
1895   "g" gnus-summary-show-article
1896   "l" gnus-summary-goto-last-article
1897   "\C-c\C-v\C-v" gnus-uu-decode-uu-view
1898   "\C-d" gnus-summary-enter-digest-group
1899   "\M-\C-d" gnus-summary-read-document
1900   "\M-\C-e" gnus-summary-edit-parameters
1901   "\M-\C-a" gnus-summary-customize-parameters
1902   "\C-c\C-b" gnus-bug
1903   "*" gnus-cache-enter-article
1904   "\M-*" gnus-cache-remove-article
1905   "\M-&" gnus-summary-universal-argument
1906   "\C-l" gnus-recenter
1907   "I" gnus-summary-increase-score
1908   "L" gnus-summary-lower-score
1909   "\M-i" gnus-symbolic-argument
1910   "h" gnus-summary-select-article-buffer
1911
1912   "b" gnus-article-view-part
1913   "\M-t" gnus-summary-toggle-display-buttonized
1914
1915   "V" gnus-summary-score-map
1916   "X" gnus-uu-extract-map
1917   "S" gnus-summary-send-map)
1918
1919 ;; Sort of orthogonal keymap
1920 (gnus-define-keys (gnus-summary-mark-map "M" gnus-summary-mode-map)
1921   "t" gnus-summary-tick-article-forward
1922   "!" gnus-summary-tick-article-forward
1923   "d" gnus-summary-mark-as-read-forward
1924   "r" gnus-summary-mark-as-read-forward
1925   "c" gnus-summary-clear-mark-forward
1926   " " gnus-summary-clear-mark-forward
1927   "e" gnus-summary-mark-as-expirable
1928   "x" gnus-summary-mark-as-expirable
1929   "?" gnus-summary-mark-as-dormant
1930   "b" gnus-summary-set-bookmark
1931   "B" gnus-summary-remove-bookmark
1932   "#" gnus-summary-mark-as-processable
1933   "\M-#" gnus-summary-unmark-as-processable
1934   "S" gnus-summary-limit-include-expunged
1935   "C" gnus-summary-catchup
1936   "H" gnus-summary-catchup-to-here
1937   "h" gnus-summary-catchup-from-here
1938   "\C-c" gnus-summary-catchup-all
1939   "k" gnus-summary-kill-same-subject-and-select
1940   "K" gnus-summary-kill-same-subject
1941   "P" gnus-uu-mark-map)
1942
1943 (gnus-define-keys (gnus-summary-mscore-map "V" gnus-summary-mark-map)
1944   "c" gnus-summary-clear-above
1945   "u" gnus-summary-tick-above
1946   "m" gnus-summary-mark-above
1947   "k" gnus-summary-kill-below)
1948
1949 (gnus-define-keys (gnus-summary-limit-map "/" gnus-summary-mode-map)
1950   "/" gnus-summary-limit-to-subject
1951   "n" gnus-summary-limit-to-articles
1952   "b" gnus-summary-limit-to-bodies
1953   "h" gnus-summary-limit-to-headers
1954   "w" gnus-summary-pop-limit
1955   "s" gnus-summary-limit-to-subject
1956   "a" gnus-summary-limit-to-author
1957   "u" gnus-summary-limit-to-unread
1958   "m" gnus-summary-limit-to-marks
1959   "M" gnus-summary-limit-exclude-marks
1960   "v" gnus-summary-limit-to-score
1961   "*" gnus-summary-limit-include-cached
1962   "D" gnus-summary-limit-include-dormant
1963   "T" gnus-summary-limit-include-thread
1964   "d" gnus-summary-limit-exclude-dormant
1965   "t" gnus-summary-limit-to-age
1966   "." gnus-summary-limit-to-unseen
1967   "x" gnus-summary-limit-to-extra
1968   "p" gnus-summary-limit-to-display-predicate
1969   "E" gnus-summary-limit-include-expunged
1970   "c" gnus-summary-limit-exclude-childless-dormant
1971   "C" gnus-summary-limit-mark-excluded-as-read
1972   "o" gnus-summary-insert-old-articles
1973   "N" gnus-summary-insert-new-articles
1974   "S" gnus-summary-limit-to-singletons
1975   "r" gnus-summary-limit-to-replied
1976   "R" gnus-summary-limit-to-recipient
1977   "A" gnus-summary-limit-to-address)
1978
1979 (gnus-define-keys (gnus-summary-goto-map "G" gnus-summary-mode-map)
1980   "n" gnus-summary-next-unread-article
1981   "p" gnus-summary-prev-unread-article
1982   "N" gnus-summary-next-article
1983   "P" gnus-summary-prev-article
1984   "\C-n" gnus-summary-next-same-subject
1985   "\C-p" gnus-summary-prev-same-subject
1986   "\M-n" gnus-summary-next-unread-subject
1987   "\M-p" gnus-summary-prev-unread-subject
1988   "f" gnus-summary-first-unread-article
1989   "b" gnus-summary-best-unread-article
1990   "j" gnus-summary-goto-article
1991   "g" gnus-summary-goto-subject
1992   "l" gnus-summary-goto-last-article
1993   "o" gnus-summary-pop-article)
1994
1995 (gnus-define-keys (gnus-summary-thread-map "T" gnus-summary-mode-map)
1996   "k" gnus-summary-kill-thread
1997   "E" gnus-summary-expire-thread
1998   "l" gnus-summary-lower-thread
1999   "i" gnus-summary-raise-thread
2000   "T" gnus-summary-toggle-threads
2001   "t" gnus-summary-rethread-current
2002   "^" gnus-summary-reparent-thread
2003   "\M-^" gnus-summary-reparent-children
2004   "s" gnus-summary-show-thread
2005   "S" gnus-summary-show-all-threads
2006   "h" gnus-summary-hide-thread
2007   "H" gnus-summary-hide-all-threads
2008   "n" gnus-summary-next-thread
2009   "p" gnus-summary-prev-thread
2010   "u" gnus-summary-up-thread
2011   "o" gnus-summary-top-thread
2012   "d" gnus-summary-down-thread
2013   "#" gnus-uu-mark-thread
2014   "\M-#" gnus-uu-unmark-thread)
2015
2016 (gnus-define-keys (gnus-summary-buffer-map "Y" gnus-summary-mode-map)
2017   "g" gnus-summary-prepare
2018   "c" gnus-summary-insert-cached-articles
2019   "d" gnus-summary-insert-dormant-articles
2020   "t" gnus-summary-insert-ticked-articles)
2021
2022 (gnus-define-keys (gnus-summary-exit-map "Z" gnus-summary-mode-map)
2023   "c" gnus-summary-catchup-and-exit
2024   "C" gnus-summary-catchup-all-and-exit
2025   "E" gnus-summary-exit-no-update
2026   "Q" gnus-summary-exit
2027   "Z" gnus-summary-exit
2028   "n" gnus-summary-catchup-and-goto-next-group
2029   "p" gnus-summary-catchup-and-goto-prev-group
2030   "R" gnus-summary-reselect-current-group
2031   "G" gnus-summary-rescan-group
2032   "N" gnus-summary-next-group
2033   "s" gnus-summary-save-newsrc
2034   "P" gnus-summary-prev-group)
2035
2036 (gnus-define-keys (gnus-summary-article-map "A" gnus-summary-mode-map)
2037   " " gnus-summary-next-page
2038   "n" gnus-summary-next-page
2039   "\177" gnus-summary-prev-page
2040   [delete] gnus-summary-prev-page
2041   "p" gnus-summary-prev-page
2042   "\r" gnus-summary-scroll-up
2043   "\M-\r" gnus-summary-scroll-down
2044   "<" gnus-summary-beginning-of-article
2045   ">" gnus-summary-end-of-article
2046   "b" gnus-summary-beginning-of-article
2047   "e" gnus-summary-end-of-article
2048   "^" gnus-summary-refer-parent-article
2049   "r" gnus-summary-refer-parent-article
2050   "D" gnus-summary-enter-digest-group
2051   "R" gnus-summary-refer-references
2052   "T" gnus-summary-refer-thread
2053   "g" gnus-summary-show-article
2054   "s" gnus-summary-isearch-article
2055   "P" gnus-summary-print-article
2056   "S" gnus-sticky-article
2057   "M" gnus-mailing-list-insinuate
2058   "t" gnus-article-babel)
2059
2060 (gnus-define-keys (gnus-summary-wash-map "W" gnus-summary-mode-map)
2061   "b" gnus-article-add-buttons
2062   "B" gnus-article-add-buttons-to-head
2063   "o" gnus-article-treat-overstrike
2064   "e" gnus-article-emphasize
2065   "w" gnus-article-fill-cited-article
2066   "Q" gnus-article-fill-long-lines
2067   "L" gnus-article-toggle-truncate-lines
2068   "C" gnus-article-capitalize-sentences
2069   "c" gnus-article-remove-cr
2070   "q" gnus-article-de-quoted-unreadable
2071   "6" gnus-article-de-base64-unreadable
2072   "Z" gnus-article-decode-HZ
2073   "A" gnus-article-treat-ansi-sequences
2074   "h" gnus-article-wash-html
2075   "u" gnus-article-unsplit-urls
2076   "s" gnus-summary-force-verify-and-decrypt
2077   "f" gnus-article-display-x-face
2078   "l" gnus-summary-stop-page-breaking
2079   "r" gnus-summary-caesar-message
2080   "m" gnus-summary-morse-message
2081   "t" gnus-summary-toggle-header
2082   "g" gnus-treat-smiley
2083   "v" gnus-summary-verbose-headers
2084   "a" gnus-article-strip-headers-in-body ;; mnemonic: wash archive
2085   "p" gnus-article-verify-x-pgp-sig
2086   "d" gnus-article-treat-dumbquotes
2087   "i" gnus-summary-idna-message)
2088
2089 (gnus-define-keys (gnus-summary-wash-deuglify-map "Y" gnus-summary-wash-map)
2090   ;; mnemonic: deuglif*Y*
2091   "u" gnus-article-outlook-unwrap-lines
2092   "a" gnus-article-outlook-repair-attribution
2093   "c" gnus-article-outlook-rearrange-citation
2094   "f" gnus-article-outlook-deuglify-article) ;; mnemonic: full deuglify
2095
2096 (gnus-define-keys (gnus-summary-wash-hide-map "W" gnus-summary-wash-map)
2097   "a" gnus-article-hide
2098   "h" gnus-article-hide-headers
2099   "b" gnus-article-hide-boring-headers
2100   "s" gnus-article-hide-signature
2101   "c" gnus-article-hide-citation
2102   "C" gnus-article-hide-citation-in-followups
2103   "l" gnus-article-hide-list-identifiers
2104   "B" gnus-article-strip-banner
2105   "P" gnus-article-hide-pem
2106   "\C-c" gnus-article-hide-citation-maybe)
2107
2108 (gnus-define-keys (gnus-summary-wash-highlight-map "H" gnus-summary-wash-map)
2109   "a" gnus-article-highlight
2110   "h" gnus-article-highlight-headers
2111   "c" gnus-article-highlight-citation
2112   "s" gnus-article-highlight-signature)
2113
2114 (gnus-define-keys (gnus-summary-wash-header-map "G" gnus-summary-wash-map)
2115   "f" gnus-article-treat-fold-headers
2116   "u" gnus-article-treat-unfold-headers
2117   "n" gnus-article-treat-fold-newsgroups)
2118
2119 (gnus-define-keys (gnus-summary-wash-display-map "D" gnus-summary-wash-map)
2120   "x" gnus-article-display-x-face
2121   "d" gnus-article-display-face
2122   "s" gnus-treat-smiley
2123   "D" gnus-article-remove-images
2124   "W" gnus-html-show-images
2125   "f" gnus-treat-from-picon
2126   "m" gnus-treat-mail-picon
2127   "n" gnus-treat-newsgroups-picon
2128   "g" gnus-treat-from-gravatar
2129   "h" gnus-treat-mail-gravatar)
2130
2131 (gnus-define-keys (gnus-summary-wash-mime-map "M" gnus-summary-wash-map)
2132   "w" gnus-article-decode-mime-words
2133   "c" gnus-article-decode-charset
2134   "v" gnus-mime-view-all-parts
2135   "b" gnus-article-view-part)
2136
2137 (gnus-define-keys (gnus-summary-wash-time-map "T" gnus-summary-wash-map)
2138   "z" gnus-article-date-ut
2139   "u" gnus-article-date-ut
2140   "l" gnus-article-date-local
2141   "p" gnus-article-date-english
2142   "e" gnus-article-date-lapsed
2143   "o" gnus-article-date-original
2144   "i" gnus-article-date-iso8601
2145   "s" gnus-article-date-user)
2146
2147 (gnus-define-keys (gnus-summary-wash-empty-map "E" gnus-summary-wash-map)
2148   "t" gnus-article-remove-trailing-blank-lines
2149   "l" gnus-article-strip-leading-blank-lines
2150   "m" gnus-article-strip-multiple-blank-lines
2151   "a" gnus-article-strip-blank-lines
2152   "A" gnus-article-strip-all-blank-lines
2153   "s" gnus-article-strip-leading-space
2154   "e" gnus-article-strip-trailing-space
2155   "w" gnus-article-remove-leading-whitespace)
2156
2157 (gnus-define-keys (gnus-summary-help-map "H" gnus-summary-mode-map)
2158   "v" gnus-version
2159   "d" gnus-summary-describe-group
2160   "h" gnus-summary-describe-briefly
2161   "i" gnus-info-find-node
2162   "C" gnus-group-fetch-control)
2163
2164 (gnus-define-keys (gnus-summary-backend-map "B" gnus-summary-mode-map)
2165   "e" gnus-summary-expire-articles
2166   "\M-\C-e" gnus-summary-expire-articles-now
2167   "\177" gnus-summary-delete-article
2168   [delete] gnus-summary-delete-article
2169   [backspace] gnus-summary-delete-article
2170   "m" gnus-summary-move-article
2171   "r" gnus-summary-respool-article
2172   "w" gnus-summary-edit-article
2173   "c" gnus-summary-copy-article
2174   "B" gnus-summary-crosspost-article
2175   "q" gnus-summary-respool-query
2176   "t" gnus-summary-respool-trace
2177   "i" gnus-summary-import-article
2178   "I" gnus-summary-create-article
2179   "p" gnus-summary-article-posted-p)
2180
2181 (gnus-define-keys (gnus-summary-save-map "O" gnus-summary-mode-map)
2182   "o" gnus-summary-save-article
2183   "m" gnus-summary-save-article-mail
2184   "F" gnus-summary-write-article-file
2185   "r" gnus-summary-save-article-rmail
2186   "f" gnus-summary-save-article-file
2187   "b" gnus-summary-save-article-body-file
2188   "B" gnus-summary-write-article-body-file
2189   "h" gnus-summary-save-article-folder
2190   "v" gnus-summary-save-article-vm
2191   "p" gnus-summary-pipe-output
2192   "P" gnus-summary-muttprint)
2193
2194 (gnus-define-keys (gnus-summary-mime-map "K" gnus-summary-mode-map)
2195   "b" gnus-summary-display-buttonized
2196   "m" gnus-summary-repair-multipart
2197   "v" gnus-article-view-part
2198   "o" gnus-article-save-part
2199   "O" gnus-article-save-part-and-strip
2200   "r" gnus-article-replace-part
2201   "d" gnus-article-delete-part
2202   "t" gnus-article-view-part-as-type
2203   "j" gnus-article-jump-to-part
2204   "c" gnus-article-copy-part
2205   "C" gnus-article-view-part-as-charset
2206   "e" gnus-article-view-part-externally
2207   "H" gnus-article-browse-html-article
2208   "E" gnus-article-encrypt-body
2209   "i" gnus-article-inline-part
2210   "|" gnus-article-pipe-part)
2211
2212 (gnus-define-keys (gnus-uu-mark-map "P" gnus-summary-mark-map)
2213   "p" gnus-summary-mark-as-processable
2214   "u" gnus-summary-unmark-as-processable
2215   "U" gnus-summary-unmark-all-processable
2216   "v" gnus-uu-mark-over
2217   "s" gnus-uu-mark-series
2218   "r" gnus-uu-mark-region
2219   "g" gnus-uu-unmark-region
2220   "R" gnus-uu-mark-by-regexp
2221   "G" gnus-uu-unmark-by-regexp
2222   "t" gnus-uu-mark-thread
2223   "T" gnus-uu-unmark-thread
2224   "a" gnus-uu-mark-all
2225   "b" gnus-uu-mark-buffer
2226   "S" gnus-uu-mark-sparse
2227   "k" gnus-summary-kill-process-mark
2228   "y" gnus-summary-yank-process-mark
2229   "w" gnus-summary-save-process-mark
2230   "i" gnus-uu-invert-processable)
2231
2232 (gnus-define-keys (gnus-uu-extract-map "X" gnus-summary-mode-map)
2233   ;;"x" gnus-uu-extract-any
2234   "m" gnus-summary-save-parts
2235   "u" gnus-uu-decode-uu
2236   "U" gnus-uu-decode-uu-and-save
2237   "s" gnus-uu-decode-unshar
2238   "S" gnus-uu-decode-unshar-and-save
2239   "o" gnus-uu-decode-save
2240   "O" gnus-uu-decode-save
2241   "b" gnus-uu-decode-binhex
2242   "B" gnus-uu-decode-binhex
2243   "Y" gnus-uu-decode-yenc
2244   "p" gnus-uu-decode-postscript
2245   "P" gnus-uu-decode-postscript-and-save)
2246
2247 (gnus-define-keys
2248     (gnus-uu-extract-view-map "v" gnus-uu-extract-map)
2249   "u" gnus-uu-decode-uu-view
2250   "U" gnus-uu-decode-uu-and-save-view
2251   "s" gnus-uu-decode-unshar-view
2252   "S" gnus-uu-decode-unshar-and-save-view
2253   "o" gnus-uu-decode-save-view
2254   "O" gnus-uu-decode-save-view
2255   "b" gnus-uu-decode-binhex-view
2256   "B" gnus-uu-decode-binhex-view
2257   "p" gnus-uu-decode-postscript-view
2258   "P" gnus-uu-decode-postscript-and-save-view)
2259
2260 (defvar gnus-article-post-menu nil)
2261
2262 (defconst gnus-summary-menu-maxlen 20)
2263
2264 (defun gnus-summary-menu-split (menu)
2265   ;; If we have lots of elements, divide them into groups of 20
2266   ;; and make a pane (or submenu) for each one.
2267   (if (> (length menu) (/ (* gnus-summary-menu-maxlen 3) 2))
2268       (let ((menu menu) sublists next
2269             (i 1))
2270         (while menu
2271           ;; Pull off the next gnus-summary-menu-maxlen elements
2272           ;; and make them the next element of sublist.
2273           (setq next (nthcdr gnus-summary-menu-maxlen menu))
2274           (if next
2275               (setcdr (nthcdr (1- gnus-summary-menu-maxlen) menu)
2276                       nil))
2277           (setq sublists (cons (cons (format "%s ... %s" (aref (car menu) 0)
2278                                              (aref (car (last menu)) 0)) menu)
2279                                sublists))
2280           (setq i (1+ i))
2281           (setq menu next))
2282         (nreverse sublists))
2283     ;; Few elements--put them all in one pane.
2284     menu))
2285
2286 (defun gnus-summary-make-menu-bar ()
2287   (gnus-turn-off-edit-menu 'summary)
2288
2289   (unless (boundp 'gnus-summary-misc-menu)
2290
2291     (easy-menu-define
2292       gnus-summary-kill-menu gnus-summary-mode-map ""
2293       (cons
2294        "Score"
2295        (nconc
2296         (list
2297          ["Customize" gnus-score-customize t])
2298         (gnus-make-score-map 'increase)
2299         (gnus-make-score-map 'lower)
2300         '(("Mark"
2301            ["Kill below" gnus-summary-kill-below t]
2302            ["Mark above" gnus-summary-mark-above t]
2303            ["Tick above" gnus-summary-tick-above t]
2304            ["Clear above" gnus-summary-clear-above t])
2305           ["Current score" gnus-summary-current-score t]
2306           ["Set score" gnus-summary-set-score t]
2307           ["Switch current score file..." gnus-score-change-score-file t]
2308           ["Set mark below..." gnus-score-set-mark-below t]
2309           ["Set expunge below..." gnus-score-set-expunge-below t]
2310           ["Edit current score file" gnus-score-edit-current-scores t]
2311           ["Edit score file..." gnus-score-edit-file t]
2312           ["Trace score" gnus-score-find-trace t]
2313           ["Find words" gnus-score-find-favourite-words t]
2314           ["Rescore buffer" gnus-summary-rescore t]
2315           ["Increase score..." gnus-summary-increase-score t]
2316           ["Lower score..." gnus-summary-lower-score t]))))
2317
2318     ;; Define both the Article menu in the summary buffer and the
2319     ;; equivalent Commands menu in the article buffer here for
2320     ;; consistency.
2321     (let ((innards
2322            `(("Hide"
2323               ["All" gnus-article-hide t]
2324               ["Headers" gnus-article-hide-headers t]
2325               ["Signature" gnus-article-hide-signature t]
2326               ["Citation" gnus-article-hide-citation t]
2327               ["List identifiers" gnus-article-hide-list-identifiers t]
2328               ["Banner" gnus-article-strip-banner t]
2329               ["Boring headers" gnus-article-hide-boring-headers t])
2330              ("Highlight"
2331               ["All" gnus-article-highlight t]
2332               ["Headers" gnus-article-highlight-headers t]
2333               ["Signature" gnus-article-highlight-signature t]
2334               ["Citation" gnus-article-highlight-citation t])
2335              ("MIME"
2336               ["Words" gnus-article-decode-mime-words t]
2337               ["Charset" gnus-article-decode-charset t]
2338               ["QP" gnus-article-de-quoted-unreadable t]
2339               ["Base64" gnus-article-de-base64-unreadable t]
2340               ["View MIME buttons" gnus-summary-display-buttonized t]
2341               ["View all" gnus-mime-view-all-parts t]
2342               ["Verify and Decrypt" gnus-summary-force-verify-and-decrypt t]
2343               ["Encrypt body" gnus-article-encrypt-body
2344                :active (not (gnus-group-read-only-p))
2345                ,@(if (featurep 'xemacs) nil
2346                    '(:help "Encrypt the message body on disk"))]
2347               ["Extract all parts..." gnus-summary-save-parts t]
2348               ("Multipart"
2349                ["Repair multipart" gnus-summary-repair-multipart t]
2350                ["Pipe part..." gnus-article-pipe-part t]
2351                ["Inline part" gnus-article-inline-part t]
2352                ["View part as type..." gnus-article-view-part-as-type t]
2353                ["Encrypt body" gnus-article-encrypt-body
2354                 :active (not (gnus-group-read-only-p))
2355                ,@(if (featurep 'xemacs) nil
2356                    '(:help "Encrypt the message body on disk"))]
2357                ["View part externally" gnus-article-view-part-externally t]
2358                ["View HTML parts in browser" gnus-article-browse-html-article t]
2359                ["View part with charset..." gnus-article-view-part-as-charset t]
2360                ["Copy part" gnus-article-copy-part t]
2361                ["Save part..." gnus-article-save-part t]
2362                ["View part" gnus-article-view-part t]))
2363              ("Date"
2364               ["Local" gnus-article-date-local t]
2365               ["ISO8601" gnus-article-date-iso8601 t]
2366               ["UT" gnus-article-date-ut t]
2367               ["Original" gnus-article-date-original t]
2368               ["Lapsed" gnus-article-date-lapsed t]
2369               ["User-defined" gnus-article-date-user t])
2370              ("Display"
2371               ["Remove images" gnus-article-remove-images t]
2372               ["Toggle smiley" gnus-treat-smiley t]
2373               ["Show X-Face" gnus-article-display-x-face t]
2374               ["Show picons in From" gnus-treat-from-picon t]
2375               ["Show picons in mail headers" gnus-treat-mail-picon t]
2376               ["Show picons in news headers" gnus-treat-newsgroups-picon t]
2377               ["Show Gravatars in From" gnus-treat-from-gravatar t]
2378               ["Show Gravatars in mail headers" gnus-treat-mail-gravatar t]
2379               ("View as different encoding"
2380                ,@(gnus-summary-menu-split
2381                   (mapcar
2382                    (lambda (cs)
2383                      ;; Since easymenu under Emacs doesn't allow
2384                      ;; lambda forms for menu commands, we should
2385                      ;; provide intern'ed function symbols.
2386                      (let ((command (intern (format "\
2387 gnus-summary-show-article-from-menu-as-charset-%s" cs))))
2388                        (fset command
2389                              `(lambda ()
2390                                 (interactive)
2391                                 (let ((gnus-summary-show-article-charset-alist
2392                                        '((1 . ,cs))))
2393                                   (gnus-summary-show-article 1))))
2394                        `[,(symbol-name cs) ,command t]))
2395                    (sort (if (fboundp 'coding-system-list)
2396                              (coding-system-list)
2397                            (mapcar 'car mm-mime-mule-charset-alist))
2398                          'string<)))))
2399              ("Washing"
2400               ("Remove Blanks"
2401                ["Leading" gnus-article-strip-leading-blank-lines t]
2402                ["Multiple" gnus-article-strip-multiple-blank-lines t]
2403                ["Trailing" gnus-article-remove-trailing-blank-lines t]
2404                ["All of the above" gnus-article-strip-blank-lines t]
2405                ["All" gnus-article-strip-all-blank-lines t]
2406                ["Leading space" gnus-article-strip-leading-space t]
2407                ["Trailing space" gnus-article-strip-trailing-space t]
2408                ["Leading space in headers"
2409                 gnus-article-remove-leading-whitespace t])
2410               ["Overstrike" gnus-article-treat-overstrike t]
2411               ["Dumb quotes" gnus-article-treat-dumbquotes t]
2412               ["Emphasis" gnus-article-emphasize t]
2413               ["Word wrap" gnus-article-fill-cited-article t]
2414               ["Fill long lines" gnus-article-fill-long-lines t]
2415               ["Toggle truncate long lines" gnus-article-toggle-truncate-lines t]
2416               ["Capitalize sentences" gnus-article-capitalize-sentences t]
2417               ["Remove CR" gnus-article-remove-cr t]
2418               ["Quoted-Printable" gnus-article-de-quoted-unreadable t]
2419               ["Base64" gnus-article-de-base64-unreadable t]
2420               ["Rot 13" gnus-summary-caesar-message
2421                ,@(if (featurep 'xemacs) '(t)
2422                    '(:help "\"Caesar rotate\" article by 13"))]
2423               ["De-IDNA" gnus-summary-idna-message t]
2424               ["Morse decode" gnus-summary-morse-message t]
2425               ["Unix pipe..." gnus-summary-pipe-message t]
2426               ["Add buttons" gnus-article-add-buttons t]
2427               ["Add buttons to head" gnus-article-add-buttons-to-head t]
2428               ["Stop page breaking" gnus-summary-stop-page-breaking t]
2429               ["Verbose header" gnus-summary-verbose-headers t]
2430               ["Toggle header" gnus-summary-toggle-header t]
2431               ["Unfold headers" gnus-article-treat-unfold-headers t]
2432               ["Fold newsgroups" gnus-article-treat-fold-newsgroups t]
2433               ["Html" gnus-article-wash-html t]
2434               ["Unsplit URLs" gnus-article-unsplit-urls t]
2435               ["Verify X-PGP-Sig" gnus-article-verify-x-pgp-sig t]
2436               ["Decode HZ" gnus-article-decode-HZ t]
2437               ["ANSI sequences" gnus-article-treat-ansi-sequences t]
2438               ("(Outlook) Deuglify"
2439                ["Unwrap lines" gnus-article-outlook-unwrap-lines t]
2440                ["Repair attribution" gnus-article-outlook-repair-attribution t]
2441                ["Rearrange citation" gnus-article-outlook-rearrange-citation t]
2442                ["Full (Outlook) deuglify"
2443                 gnus-article-outlook-deuglify-article t])
2444               )
2445              ("Output"
2446               ["Save in default format..." gnus-summary-save-article
2447                ,@(if (featurep 'xemacs) '(t)
2448                    '(:help "Save article using default method"))]
2449               ["Save in file..." gnus-summary-save-article-file
2450                ,@(if (featurep 'xemacs) '(t)
2451                    '(:help "Save article in file"))]
2452               ["Save in Unix mail format..." gnus-summary-save-article-mail t]
2453               ["Save in MH folder..." gnus-summary-save-article-folder t]
2454               ["Save in VM folder..." gnus-summary-save-article-vm t]
2455               ["Save in RMAIL mbox..." gnus-summary-save-article-rmail t]
2456               ["Save body in file..." gnus-summary-save-article-body-file t]
2457               ["Pipe through a filter..." gnus-summary-pipe-output t]
2458               ["Print with Muttprint..." gnus-summary-muttprint t]
2459               ["Print" gnus-summary-print-article
2460                ,@(if (featurep 'xemacs) '(t)
2461                    '(:help "Generate and print a PostScript image"))])
2462              ("Copy, move,... (Backend)"
2463               ,@(if (featurep 'xemacs) nil
2464                   '(:help "Copying, moving, expiring articles..."))
2465               ["Respool article..." gnus-summary-respool-article t]
2466               ["Move article..." gnus-summary-move-article
2467                (gnus-check-backend-function
2468                 'request-move-article gnus-newsgroup-name)]
2469               ["Copy article..." gnus-summary-copy-article t]
2470               ["Crosspost article..." gnus-summary-crosspost-article
2471                (gnus-check-backend-function
2472                 'request-replace-article gnus-newsgroup-name)]
2473               ["Import file..." gnus-summary-import-article
2474                (gnus-check-backend-function
2475                 'request-accept-article gnus-newsgroup-name)]
2476               ["Create article..." gnus-summary-create-article
2477                (gnus-check-backend-function
2478                 'request-accept-article gnus-newsgroup-name)]
2479               ["Check if posted" gnus-summary-article-posted-p t]
2480               ["Edit article" gnus-summary-edit-article
2481                (not (gnus-group-read-only-p))]
2482               ["Delete article" gnus-summary-delete-article
2483                (gnus-check-backend-function
2484                 'request-expire-articles gnus-newsgroup-name)]
2485               ["Query respool" gnus-summary-respool-query t]
2486               ["Trace respool" gnus-summary-respool-trace t]
2487               ["Delete expirable articles" gnus-summary-expire-articles-now
2488                (gnus-check-backend-function
2489                 'request-expire-articles gnus-newsgroup-name)])
2490              ("Extract"
2491               ["Uudecode" gnus-uu-decode-uu
2492                ,@(if (featurep 'xemacs) '(t)
2493                    '(:help "Decode uuencoded article(s)"))]
2494               ["Uudecode and save" gnus-uu-decode-uu-and-save t]
2495               ["Unshar" gnus-uu-decode-unshar t]
2496               ["Unshar and save" gnus-uu-decode-unshar-and-save t]
2497               ["Save" gnus-uu-decode-save t]
2498               ["Binhex" gnus-uu-decode-binhex t]
2499               ["Postscript" gnus-uu-decode-postscript t]
2500               ["All MIME parts" gnus-summary-save-parts t])
2501              ("Cache"
2502               ["Enter article" gnus-cache-enter-article t]
2503               ["Remove article" gnus-cache-remove-article t])
2504              ["Translate" gnus-article-babel t]
2505              ["Select article buffer" gnus-summary-select-article-buffer t]
2506              ["Make article buffer sticky" gnus-sticky-article t]
2507              ["Enter digest buffer" gnus-summary-enter-digest-group t]
2508              ["Isearch article..." gnus-summary-isearch-article t]
2509              ["Beginning of the article" gnus-summary-beginning-of-article t]
2510              ["End of the article" gnus-summary-end-of-article t]
2511              ["Fetch parent of article" gnus-summary-refer-parent-article t]
2512              ["Fetch referenced articles" gnus-summary-refer-references t]
2513              ["Fetch current thread" gnus-summary-refer-thread t]
2514              ["Fetch article with id..." gnus-summary-refer-article t]
2515              ["Setup Mailing List Params" gnus-mailing-list-insinuate t]
2516              ["Redisplay" gnus-summary-show-article t]
2517              ["Raw article" gnus-summary-show-raw-article :keys "C-u g"])))
2518       (easy-menu-define
2519         gnus-summary-article-menu gnus-summary-mode-map ""
2520         (cons "Article" innards))
2521
2522       (if (not (keymapp gnus-summary-article-menu))
2523           (easy-menu-define
2524             gnus-article-commands-menu gnus-article-mode-map ""
2525             (cons "Commands" innards))
2526         ;; in Emacs, don't share menu.
2527         (setq gnus-article-commands-menu
2528               (copy-keymap gnus-summary-article-menu))
2529         (define-key gnus-article-mode-map [menu-bar commands]
2530           (cons "Commands" gnus-article-commands-menu))))
2531
2532     (easy-menu-define
2533       gnus-summary-thread-menu gnus-summary-mode-map ""
2534       '("Threads"
2535         ["Find all messages in thread" gnus-summary-refer-thread t]
2536         ["Toggle threading" gnus-summary-toggle-threads t]
2537         ["Hide threads" gnus-summary-hide-all-threads t]
2538         ["Show threads" gnus-summary-show-all-threads t]
2539         ["Hide thread" gnus-summary-hide-thread t]
2540         ["Show thread" gnus-summary-show-thread t]
2541         ["Go to next thread" gnus-summary-next-thread t]
2542         ["Go to previous thread" gnus-summary-prev-thread t]
2543         ["Go down thread" gnus-summary-down-thread t]
2544         ["Go up thread" gnus-summary-up-thread t]
2545         ["Top of thread" gnus-summary-top-thread t]
2546         ["Mark thread as read" gnus-summary-kill-thread t]
2547         ["Mark thread as expired" gnus-summary-expire-thread t]
2548         ["Lower thread score" gnus-summary-lower-thread t]
2549         ["Raise thread score" gnus-summary-raise-thread t]
2550         ["Rethread current" gnus-summary-rethread-current t]))
2551
2552     (easy-menu-define
2553       gnus-summary-post-menu gnus-summary-mode-map ""
2554       `("Post"
2555         ["Send a message (mail or news)" gnus-summary-post-news
2556          ,@(if (featurep 'xemacs) '(t)
2557              '(:help "Compose a new message (mail or news)"))]
2558         ["Followup" gnus-summary-followup
2559          ,@(if (featurep 'xemacs) '(t)
2560              '(:help "Post followup to this article"))]
2561         ["Followup and yank" gnus-summary-followup-with-original
2562          ,@(if (featurep 'xemacs) '(t)
2563              '(:help "Post followup to this article, quoting its contents"))]
2564         ["Supersede article" gnus-summary-supersede-article t]
2565         ["Cancel article" gnus-summary-cancel-article
2566          ,@(if (featurep 'xemacs) '(t)
2567              '(:help "Cancel an article you posted"))]
2568         ["Reply" gnus-summary-reply t]
2569         ["Reply and yank" gnus-summary-reply-with-original t]
2570         ["Wide reply" gnus-summary-wide-reply t]
2571         ["Wide reply and yank" gnus-summary-wide-reply-with-original
2572          ,@(if (featurep 'xemacs) '(t)
2573              '(:help "Mail a reply, quoting this article"))]
2574         ["Very wide reply" gnus-summary-very-wide-reply t]
2575         ["Very wide reply and yank" gnus-summary-very-wide-reply-with-original
2576          ,@(if (featurep 'xemacs) '(t)
2577              '(:help "Mail a very wide reply, quoting this article"))]
2578         ["Mail forward" gnus-summary-mail-forward t]
2579         ["Post forward" gnus-summary-post-forward t]
2580         ["Digest and mail" gnus-uu-digest-mail-forward t]
2581         ["Digest and post" gnus-uu-digest-post-forward t]
2582         ["Resend message" gnus-summary-resend-message t]
2583         ["Resend message edit" gnus-summary-resend-message-edit t]
2584         ["Send bounced mail" gnus-summary-resend-bounced-mail t]
2585         ["Send a mail" gnus-summary-mail-other-window t]
2586         ["Create a local message" gnus-summary-news-other-window t]
2587         ["Uuencode and post" gnus-uu-post-news
2588          ,@(if (featurep 'xemacs) '(t)
2589              '(:help "Post a uuencoded article"))]
2590         ["Followup via news" gnus-summary-followup-to-mail t]
2591         ["Followup via news and yank"
2592          gnus-summary-followup-to-mail-with-original t]
2593         ["Strip signature on reply"
2594          (lambda ()
2595            (interactive)
2596            (if (not (memq message-cite-function
2597                           '(message-cite-original-without-signature
2598                             message-cite-original)))
2599                ;; Stupid workaround for XEmacs not honoring :visible.
2600                (message "Can't toggle this value of `message-cite-function'")
2601              (setq message-cite-function
2602                    (if (eq message-cite-function
2603                            'message-cite-original-without-signature)
2604                        'message-cite-original
2605                      'message-cite-original-without-signature))))
2606          ;; XEmacs barfs on :visible.
2607          ,@(if (featurep 'xemacs) nil
2608              '(:visible (memq message-cite-function
2609                               '(message-cite-original-without-signature
2610                                 message-cite-original))))
2611          :style toggle
2612          :selected (eq message-cite-function
2613                        'message-cite-original-without-signature)
2614          ,@(if (featurep 'xemacs) nil
2615              '(:help "Strip signature from cited article when replying."))]
2616         ;;("Draft"
2617         ;;["Send" gnus-summary-send-draft t]
2618         ;;["Send bounced" gnus-resend-bounced-mail t])
2619         ))
2620
2621     (cond
2622      ((not (keymapp gnus-summary-post-menu))
2623       (setq gnus-article-post-menu gnus-summary-post-menu))
2624      ((not gnus-article-post-menu)
2625       ;; Don't share post menu.
2626       (setq gnus-article-post-menu
2627             (copy-keymap gnus-summary-post-menu))))
2628     (define-key gnus-article-mode-map [menu-bar post]
2629       (cons "Post" gnus-article-post-menu))
2630
2631     (easy-menu-define
2632       gnus-summary-misc-menu gnus-summary-mode-map ""
2633       `("Gnus"
2634         ("Mark Read"
2635          ["Mark as read" gnus-summary-mark-as-read-forward t]
2636          ["Mark same subject and select"
2637           gnus-summary-kill-same-subject-and-select t]
2638          ["Mark same subject" gnus-summary-kill-same-subject t]
2639          ["Catchup" gnus-summary-catchup
2640           ,@(if (featurep 'xemacs) '(t)
2641               '(:help "Mark unread articles in this group as read"))]
2642          ["Catchup all" gnus-summary-catchup-all t]
2643          ["Catchup to here" gnus-summary-catchup-to-here t]
2644          ["Catchup from here" gnus-summary-catchup-from-here t]
2645          ["Catchup region" gnus-summary-mark-region-as-read
2646           (gnus-mark-active-p)]
2647          ["Mark excluded" gnus-summary-limit-mark-excluded-as-read t])
2648         ("Mark Various"
2649          ["Tick" gnus-summary-tick-article-forward t]
2650          ["Mark as dormant" gnus-summary-mark-as-dormant t]
2651          ["Remove marks" gnus-summary-clear-mark-forward t]
2652          ["Set expirable mark" gnus-summary-mark-as-expirable t]
2653          ["Set bookmark" gnus-summary-set-bookmark t]
2654          ["Remove bookmark" gnus-summary-remove-bookmark t])
2655         ("Limit to"
2656          ["Marks..." gnus-summary-limit-to-marks t]
2657          ["Subject..." gnus-summary-limit-to-subject t]
2658          ["Author..." gnus-summary-limit-to-author t]
2659          ["Recipient..." gnus-summary-limit-to-recipient t]
2660          ["Address..." gnus-summary-limit-to-address t]
2661          ["Age..." gnus-summary-limit-to-age t]
2662          ["Extra..." gnus-summary-limit-to-extra t]
2663          ["Score..." gnus-summary-limit-to-score t]
2664          ["Display Predicate" gnus-summary-limit-to-display-predicate t]
2665          ["Unread" gnus-summary-limit-to-unread t]
2666          ["Unseen" gnus-summary-limit-to-unseen t]
2667          ["Singletons" gnus-summary-limit-to-singletons t]
2668          ["Replied" gnus-summary-limit-to-replied t]
2669          ["Non-dormant" gnus-summary-limit-exclude-dormant t]
2670          ["Next or process marked articles" gnus-summary-limit-to-articles t]
2671          ["Pop limit" gnus-summary-pop-limit t]
2672          ["Show dormant" gnus-summary-limit-include-dormant t]
2673          ["Hide childless dormant"
2674           gnus-summary-limit-exclude-childless-dormant t]
2675          ;;["Hide thread" gnus-summary-limit-exclude-thread t]
2676          ["Hide marked" gnus-summary-limit-exclude-marks t]
2677          ["Show expunged" gnus-summary-limit-include-expunged t])
2678         ("Process Mark"
2679          ["Set mark" gnus-summary-mark-as-processable t]
2680          ["Remove mark" gnus-summary-unmark-as-processable t]
2681          ["Remove all marks" gnus-summary-unmark-all-processable t]
2682          ["Invert marks" gnus-uu-invert-processable t]
2683          ["Mark above" gnus-uu-mark-over t]
2684          ["Mark series" gnus-uu-mark-series t]
2685          ["Mark region" gnus-uu-mark-region (gnus-mark-active-p)]
2686          ["Unmark region" gnus-uu-unmark-region (gnus-mark-active-p)]
2687          ["Mark by regexp..." gnus-uu-mark-by-regexp t]
2688          ["Unmark by regexp..." gnus-uu-unmark-by-regexp t]
2689          ["Mark all" gnus-uu-mark-all t]
2690          ["Mark buffer" gnus-uu-mark-buffer t]
2691          ["Mark sparse" gnus-uu-mark-sparse t]
2692          ["Mark thread" gnus-uu-mark-thread t]
2693          ["Unmark thread" gnus-uu-unmark-thread t]
2694          ("Process Mark Sets"
2695           ["Kill" gnus-summary-kill-process-mark t]
2696           ["Yank" gnus-summary-yank-process-mark
2697            gnus-newsgroup-process-stack]
2698           ["Save" gnus-summary-save-process-mark t]
2699           ["Run command on marked..." gnus-summary-universal-argument t]))
2700         ("Registry Marks")
2701         ("Scroll article"
2702          ["Page forward" gnus-summary-next-page
2703           ,@(if (featurep 'xemacs) '(t)
2704               '(:help "Show next page of article"))]
2705          ["Page backward" gnus-summary-prev-page
2706           ,@(if (featurep 'xemacs) '(t)
2707               '(:help "Show previous page of article"))]
2708          ["Line forward" gnus-summary-scroll-up t])
2709         ("Move"
2710          ["Next unread article" gnus-summary-next-unread-article t]
2711          ["Previous unread article" gnus-summary-prev-unread-article t]
2712          ["Next article" gnus-summary-next-article t]
2713          ["Previous article" gnus-summary-prev-article t]
2714          ["Next unread subject" gnus-summary-next-unread-subject t]
2715          ["Previous unread subject" gnus-summary-prev-unread-subject t]
2716          ["Next article same subject" gnus-summary-next-same-subject t]
2717          ["Previous article same subject" gnus-summary-prev-same-subject t]
2718          ["First unread article" gnus-summary-first-unread-article t]
2719          ["Best unread article" gnus-summary-best-unread-article t]
2720          ["Go to subject number..." gnus-summary-goto-subject t]
2721          ["Go to article number..." gnus-summary-goto-article t]
2722          ["Go to the last article" gnus-summary-goto-last-article t]
2723          ["Pop article off history" gnus-summary-pop-article t])
2724         ("Sort"
2725          ["Sort by number" gnus-summary-sort-by-number t]
2726          ["Sort by most recent number" gnus-summary-sort-by-most-recent-number t]
2727          ["Sort by author" gnus-summary-sort-by-author t]
2728          ["Sort by recipient" gnus-summary-sort-by-recipient t]
2729          ["Sort by subject" gnus-summary-sort-by-subject t]
2730          ["Sort by date" gnus-summary-sort-by-date t]
2731          ["Sort by most recent date" gnus-summary-sort-by-most-recent-date t]
2732          ["Sort by score" gnus-summary-sort-by-score t]
2733          ["Sort by lines" gnus-summary-sort-by-lines t]
2734          ["Sort by characters" gnus-summary-sort-by-chars t]
2735          ["Randomize" gnus-summary-sort-by-random t]
2736          ["Original sort" gnus-summary-sort-by-original t])
2737         ("Help"
2738          ["Describe group" gnus-summary-describe-group t]
2739          ["Fetch control message" gnus-group-fetch-control
2740           ,@(if (featurep 'xemacs) nil
2741               '(:help "Display the archived control message for the current group"))]
2742          ["Read manual" gnus-info-find-node t])
2743         ("Modes"
2744          ["Pick and read" gnus-pick-mode t]
2745          ["Binary" gnus-binary-mode t])
2746         ("Regeneration"
2747          ["Regenerate" gnus-summary-prepare t]
2748          ["Insert cached articles" gnus-summary-insert-cached-articles t]
2749          ["Insert dormant articles" gnus-summary-insert-dormant-articles t]
2750          ["Insert ticked articles" gnus-summary-insert-ticked-articles t]
2751          ["Toggle threading" gnus-summary-toggle-threads t])
2752         ["See old articles" gnus-summary-insert-old-articles t]
2753         ["See new articles" gnus-summary-insert-new-articles t]
2754         ["Filter articles..." gnus-summary-execute-command t]
2755         ["Run command on articles..." gnus-summary-universal-argument t]
2756         ["Search articles forward..." gnus-summary-search-article-forward t]
2757         ["Search articles backward..." gnus-summary-search-article-backward t]
2758         ["Toggle line truncation" gnus-summary-toggle-truncation t]
2759         ["Expand window" gnus-summary-expand-window t]
2760         ["Expire expirable articles" gnus-summary-expire-articles
2761          (gnus-check-backend-function
2762           'request-expire-articles gnus-newsgroup-name)]
2763         ["Edit local kill file" gnus-summary-edit-local-kill t]
2764         ["Edit main kill file" gnus-summary-edit-global-kill t]
2765         ["Edit group parameters" gnus-summary-edit-parameters t]
2766         ["Customize group parameters" gnus-summary-customize-parameters t]
2767         ["Send a bug report" gnus-bug t]
2768         ("Exit"
2769          ["Catchup and exit" gnus-summary-catchup-and-exit
2770           ,@(if (featurep 'xemacs) '(t)
2771               '(:help "Mark unread articles in this group as read, then exit"))]
2772          ["Catchup all and exit" gnus-summary-catchup-all-and-exit t]
2773          ["Catchup and goto next" gnus-summary-catchup-and-goto-next-group t]
2774          ["Catchup and goto prev" gnus-summary-catchup-and-goto-prev-group t]
2775          ["Exit group" gnus-summary-exit
2776           ,@(if (featurep 'xemacs) '(t)
2777               '(:help "Exit current group, return to group selection mode"))]
2778          ["Exit group without updating" gnus-summary-exit-no-update t]
2779          ["Exit and goto next group" gnus-summary-next-group t]
2780          ["Exit and goto prev group" gnus-summary-prev-group t]
2781          ["Reselect group" gnus-summary-reselect-current-group t]
2782          ["Rescan group" gnus-summary-rescan-group t]
2783          ["Update dribble" gnus-summary-save-newsrc t])))
2784
2785     (gnus-run-hooks 'gnus-summary-menu-hook)))
2786
2787 (defvar gnus-summary-tool-bar-map nil)
2788
2789 ;; Note: The :set function in the `gnus-summary-tool-bar*' variables will only
2790 ;; affect _new_ message buffers.  We might add a function that walks thru all
2791 ;; summary-mode buffers and force the update.
2792 (defun gnus-summary-tool-bar-update (&optional symbol value)
2793   "Update summary mode toolbar.
2794 Setter function for custom variables."
2795   (setq-default gnus-summary-tool-bar-map nil)
2796   (when symbol
2797     ;; When used as ":set" function:
2798     (set-default symbol value))
2799   (when (gnus-buffer-live-p gnus-summary-buffer)
2800     (with-current-buffer gnus-summary-buffer
2801       (gnus-summary-make-tool-bar))))
2802
2803 (defcustom gnus-summary-tool-bar (if (eq gmm-tool-bar-style 'gnome)
2804                                      'gnus-summary-tool-bar-gnome
2805                                    'gnus-summary-tool-bar-retro)
2806   "Specifies the Gnus summary tool bar.
2807
2808 It can be either a list or a symbol refering to a list.  See
2809 `gmm-tool-bar-from-list' for the format of the list.  The
2810 default key map is `gnus-summary-mode-map'.
2811
2812 Pre-defined symbols include `gnus-summary-tool-bar-gnome' and
2813 `gnus-summary-tool-bar-retro'."
2814   :type '(choice (const :tag "GNOME style" gnus-summary-tool-bar-gnome)
2815                  (const :tag "Retro look"  gnus-summary-tool-bar-retro)
2816                  (repeat :tag "User defined list" gmm-tool-bar-item)
2817                  (symbol))
2818   :version "23.1" ;; No Gnus
2819   :initialize 'custom-initialize-default
2820   :set 'gnus-summary-tool-bar-update
2821   :group 'gnus-summary)
2822
2823 (defcustom gnus-summary-tool-bar-gnome
2824   '((gnus-summary-post-news "mail/compose" nil)
2825     (gnus-summary-insert-new-articles "mail/inbox" nil
2826                                       :visible (or (not gnus-agent)
2827                                                    gnus-plugged))
2828     (gnus-summary-reply-with-original "mail/reply")
2829     (gnus-summary-reply "mail/reply" nil :visible nil)
2830     (gnus-summary-followup-with-original "mail/reply-all")
2831     (gnus-summary-followup "mail/reply-all" nil :visible nil)
2832     (gnus-summary-mail-forward "mail/forward")
2833     (gnus-summary-save-article "mail/save")
2834     (gnus-summary-search-article-forward "search" nil :visible nil)
2835     (gnus-summary-print-article "print")
2836     (gnus-summary-tick-article-forward "flag-followup" nil :visible nil)
2837     ;; Some new commands that may need more suitable icons:
2838     (gnus-summary-save-newsrc "save" nil :visible nil)
2839     ;; (gnus-summary-show-article "stock_message-display" nil :visible nil)
2840     (gnus-summary-prev-article "left-arrow")
2841     (gnus-summary-next-article "right-arrow")
2842     (gnus-summary-next-page "next-page")
2843     ;; (gnus-summary-enter-digest-group "right_arrow" nil :visible nil)
2844     ;;
2845     ;; Maybe some sort-by-... could be added:
2846     ;; (gnus-summary-sort-by-author "sort-a-z" nil :visible nil)
2847     ;; (gnus-summary-sort-by-date "sort-1-9" nil :visible nil)
2848     (gnus-summary-mark-as-expirable
2849      "delete" nil
2850      :visible (gnus-check-backend-function 'request-expire-articles
2851                                            gnus-newsgroup-name))
2852     (gnus-summary-mark-as-spam
2853      "mail/spam" t
2854      :visible (and (fboundp 'spam-group-ham-contents-p)
2855                    (spam-group-ham-contents-p gnus-newsgroup-name))
2856      :help "Mark as spam")
2857     (gnus-summary-mark-as-read-forward
2858      "mail/not-spam" nil
2859      :visible (and (fboundp 'spam-group-spam-contents-p)
2860                    (spam-group-spam-contents-p gnus-newsgroup-name)))
2861     ;;
2862     (gnus-summary-exit "exit")
2863     (gmm-customize-mode "preferences" t :help "Edit mode preferences")
2864     (gnus-info-find-node "help"))
2865   "List of functions for the summary tool bar (GNOME style).
2866
2867 See `gmm-tool-bar-from-list' for the format of the list."
2868   :type '(repeat gmm-tool-bar-item)
2869   :version "23.1" ;; No Gnus
2870   :initialize 'custom-initialize-default
2871   :set 'gnus-summary-tool-bar-update
2872   :group 'gnus-summary)
2873
2874 (defcustom gnus-summary-tool-bar-retro
2875   '((gnus-summary-prev-unread-article "gnus/prev-ur")
2876     (gnus-summary-next-unread-article "gnus/next-ur")
2877     (gnus-summary-post-news "gnus/post")
2878     (gnus-summary-followup-with-original "gnus/fuwo")
2879     (gnus-summary-followup "gnus/followup")
2880     (gnus-summary-reply-with-original "gnus/reply-wo")
2881     (gnus-summary-reply "gnus/reply")
2882     (gnus-summary-caesar-message "gnus/rot13")
2883     (gnus-uu-decode-uu "gnus/uu-decode")
2884     (gnus-summary-save-article-file "gnus/save-aif")
2885     (gnus-summary-save-article "gnus/save-art")
2886     (gnus-uu-post-news "gnus/uu-post")
2887     (gnus-summary-catchup "gnus/catchup")
2888     (gnus-summary-catchup-and-exit "gnus/cu-exit")
2889     (gnus-summary-exit "gnus/exit-summ")
2890     ;; Some new command that may need more suitable icons:
2891     (gnus-summary-print-article "gnus/print" nil :visible nil)
2892     (gnus-summary-mark-as-expirable "gnus/close" nil :visible nil)
2893     (gnus-summary-save-newsrc "gnus/save" nil :visible nil)
2894     ;; (gnus-summary-enter-digest-group "gnus/right_arrow" nil :visible nil)
2895     (gnus-summary-search-article-forward "gnus/search" nil :visible nil)
2896     ;; (gnus-summary-insert-new-articles "gnus/paste" nil :visible nil)
2897     ;; (gnus-summary-toggle-threads "gnus/open" nil :visible nil)
2898     ;;
2899     (gnus-info-find-node "gnus/help" nil :visible nil))
2900   "List of functions for the summary tool bar (retro look).
2901
2902 See `gmm-tool-bar-from-list' for the format of the list."
2903   :type '(repeat gmm-tool-bar-item)
2904   :version "23.1" ;; No Gnus
2905   :initialize 'custom-initialize-default
2906   :set 'gnus-summary-tool-bar-update
2907   :group 'gnus-summary)
2908
2909 (defcustom gnus-summary-tool-bar-zap-list t
2910   "List of icon items from the global tool bar.
2911 These items are not displayed in the Gnus summary mode tool bar.
2912
2913 See `gmm-tool-bar-from-list' for the format of the list."
2914   :type 'gmm-tool-bar-zap-list
2915   :version "23.1" ;; No Gnus
2916   :initialize 'custom-initialize-default
2917   :set 'gnus-summary-tool-bar-update
2918   :group 'gnus-summary)
2919
2920 (defvar image-load-path)
2921 (defvar tool-bar-map)
2922
2923 (defun gnus-summary-make-tool-bar (&optional force)
2924   "Make a summary mode tool bar from `gnus-summary-tool-bar'.
2925 When FORCE, rebuild the tool bar."
2926   (when (and (not (featurep 'xemacs))
2927              (boundp 'tool-bar-mode)
2928              tool-bar-mode
2929              (or (not gnus-summary-tool-bar-map) force))
2930     (let* ((load-path
2931             (gmm-image-load-path-for-library "gnus"
2932                                              "mail/save.xpm"
2933                                              nil t))
2934            (image-load-path (cons (car load-path)
2935                                   (when (boundp 'image-load-path)
2936                                     image-load-path)))
2937            (map (gmm-tool-bar-from-list gnus-summary-tool-bar
2938                                         gnus-summary-tool-bar-zap-list
2939                                         'gnus-summary-mode-map)))
2940       (when map
2941         ;; Need to set `gnus-summary-tool-bar-map' because `gnus-article-mode'
2942         ;; uses it's value.
2943         (setq gnus-summary-tool-bar-map map))))
2944   (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map))
2945
2946 (defun gnus-score-set-default (var value)
2947   "A version of set that updates the GNU Emacs menu-bar."
2948   (set var value)
2949   ;; It is the message that forces the active status to be updated.
2950   (message ""))
2951
2952 (defun gnus-make-score-map (type)
2953   "Make a summary score map of type TYPE."
2954   (if t
2955       nil
2956     (let ((headers '(("author" "from" string)
2957                      ("subject" "subject" string)
2958                      ("article body" "body" string)
2959                      ("article head" "head" string)
2960                      ("xref" "xref" string)
2961                      ("extra header" "extra" string)
2962                      ("lines" "lines" number)
2963                      ("followups to author" "followup" string)))
2964           (types '((number ("less than" <)
2965                            ("greater than" >)
2966                            ("equal" =))
2967                    (string ("substring" s)
2968                            ("exact string" e)
2969                            ("fuzzy string" f)
2970                            ("regexp" r))))
2971           (perms '(("temporary" (current-time-string))
2972                    ("permanent" nil)
2973                    ("immediate" now)))
2974           header)
2975       (list
2976        (apply
2977         'nconc
2978         (list
2979          (if (eq type 'lower)
2980              "Lower score"
2981            "Increase score"))
2982         (let (outh)
2983           (while headers
2984             (setq header (car headers))
2985             (setq outh
2986                   (cons
2987                    (apply
2988                     'nconc
2989                     (list (car header))
2990                     (let ((ts (cdr (assoc (nth 2 header) types)))
2991                           outt)
2992                       (while ts
2993                         (setq outt
2994                               (cons
2995                                (apply
2996                                 'nconc
2997                                 (list (caar ts))
2998                                 (let ((ps perms)
2999                                       outp)
3000                                   (while ps
3001                                     (setq outp
3002                                           (cons
3003                                            (vector
3004                                             (caar ps)
3005                                             (list
3006                                              'gnus-summary-score-entry
3007                                              (nth 1 header)
3008                                              (if (or (string= (nth 1 header)
3009                                                               "head")
3010                                                      (string= (nth 1 header)
3011                                                               "body"))
3012                                                  ""
3013                                                (list 'gnus-summary-header
3014                                                      (nth 1 header)))
3015                                              (list 'quote (nth 1 (car ts)))
3016                                              (list 'gnus-score-delta-default
3017                                                    nil)
3018                                              (nth 1 (car ps))
3019                                              t)
3020                                             t)
3021                                            outp))
3022                                     (setq ps (cdr ps)))
3023                                   (list (nreverse outp))))
3024                                outt))
3025                         (setq ts (cdr ts)))
3026                       (list (nreverse outt))))
3027                    outh))
3028             (setq headers (cdr headers)))
3029           (list (nreverse outh))))))))
3030
3031
3032 (declare-function turn-on-gnus-mailing-list-mode "gnus-ml" ())
3033 (defvar bookmark-make-record-function)
3034 \f
3035
3036 (defun gnus-summary-mode (&optional group)
3037   "Major mode for reading articles.
3038
3039 All normal editing commands are switched off.
3040 \\<gnus-summary-mode-map>
3041 Each line in this buffer represents one article.  To read an
3042 article, you can, for instance, type `\\[gnus-summary-next-page]'.  To move forwards
3043 and backwards while displaying articles, type `\\[gnus-summary-next-unread-article]' and `\\[gnus-summary-prev-unread-article]',
3044 respectively.
3045
3046 You can also post articles and send mail from this buffer.  To
3047 follow up an article, type `\\[gnus-summary-followup]'.  To mail a reply to the author
3048 of an article, type `\\[gnus-summary-reply]'.
3049
3050 There are approx. one gazillion commands you can execute in this
3051 buffer; read the info pages for more information (`\\[gnus-info-find-node]').
3052
3053 The following commands are available:
3054
3055 \\{gnus-summary-mode-map}"
3056   (interactive)
3057   (kill-all-local-variables)
3058   (let ((gnus-summary-local-variables gnus-newsgroup-variables))
3059     (gnus-summary-make-local-variables))
3060   (gnus-summary-make-local-variables)
3061   (setq gnus-newsgroup-name group)
3062   (when (gnus-visual-p 'summary-menu 'menu)
3063     (gnus-summary-make-menu-bar)
3064     (gnus-summary-make-tool-bar))
3065   (gnus-make-thread-indent-array)
3066   (gnus-simplify-mode-line)
3067   (setq major-mode 'gnus-summary-mode)
3068   (setq mode-name "Summary")
3069   (use-local-map gnus-summary-mode-map)
3070   (buffer-disable-undo)
3071   (setq buffer-read-only t              ;Disable modification
3072         show-trailing-whitespace nil)
3073   (setq truncate-lines t)
3074   (add-to-invisibility-spec '(gnus-sum . t))
3075   (gnus-summary-set-display-table)
3076   (gnus-set-default-directory)
3077   (make-local-variable 'gnus-summary-line-format)
3078   (make-local-variable 'gnus-summary-line-format-spec)
3079   (make-local-variable 'gnus-summary-dummy-line-format)
3080   (make-local-variable 'gnus-summary-dummy-line-format-spec)
3081   (make-local-variable 'gnus-summary-mark-positions)
3082   (gnus-make-local-hook 'pre-command-hook)
3083   (add-hook 'pre-command-hook 'gnus-set-global-variables nil t)
3084   (gnus-run-mode-hooks 'gnus-summary-mode-hook)
3085   (turn-on-gnus-mailing-list-mode)
3086   (mm-enable-multibyte)
3087   (set (make-local-variable 'bookmark-make-record-function)
3088        'gnus-summary-bookmark-make-record)
3089   (gnus-update-format-specifications nil 'summary 'summary-mode 'summary-dummy)
3090   (gnus-update-summary-mark-positions))
3091
3092 (defun gnus-summary-make-local-variables ()
3093   "Make all the local summary buffer variables."
3094   (let (global)
3095     (dolist (local gnus-summary-local-variables)
3096       (if (consp local)
3097           (progn
3098             (if (eq (cdr local) 'global)
3099                 ;; Copy the global value of the variable.
3100                 (setq global (symbol-value (car local)))
3101               ;; Use the value from the list.
3102               (setq global (eval (cdr local))))
3103             (set (make-local-variable (car local)) global))
3104         ;; Simple nil-valued local variable.
3105         (set (make-local-variable local) nil)))))
3106
3107 (defun gnus-summary-clear-local-variables ()
3108   (let ((locals gnus-summary-local-variables))
3109     (while locals
3110       (if (consp (car locals))
3111           (and (symbolp (caar locals))
3112                (set (caar locals) nil))
3113         (and (symbolp (car locals))
3114              (set (car locals) nil)))
3115       (setq locals (cdr locals)))))
3116
3117 ;; Summary data functions.
3118
3119 (defmacro gnus-data-number (data)
3120   `(car ,data))
3121
3122 (defmacro gnus-data-set-number (data number)
3123   `(setcar ,data ,number))
3124
3125 (defmacro gnus-data-mark (data)
3126   `(nth 1 ,data))
3127
3128 (defmacro gnus-data-set-mark (data mark)
3129   `(setcar (nthcdr 1 ,data) ,mark))
3130
3131 (defmacro gnus-data-pos (data)
3132   `(nth 2 ,data))
3133
3134 (defmacro gnus-data-set-pos (data pos)
3135   `(setcar (nthcdr 2 ,data) ,pos))
3136
3137 (defmacro gnus-data-header (data)
3138   `(nth 3 ,data))
3139
3140 (defmacro gnus-data-set-header (data header)
3141   `(setf (nth 3 ,data) ,header))
3142
3143 (defmacro gnus-data-level (data)
3144   `(nth 4 ,data))
3145
3146 (defmacro gnus-data-unread-p (data)
3147   `(= (nth 1 ,data) gnus-unread-mark))
3148
3149 (defmacro gnus-data-read-p (data)
3150   `(/= (nth 1 ,data) gnus-unread-mark))
3151
3152 (defmacro gnus-data-pseudo-p (data)
3153   `(consp (nth 3 ,data)))
3154
3155 (defmacro gnus-data-find (number)
3156   `(assq ,number gnus-newsgroup-data))
3157
3158 (defmacro gnus-data-find-list (number &optional data)
3159   `(let ((bdata ,(or data 'gnus-newsgroup-data)))
3160      (memq (assq ,number bdata)
3161            bdata)))
3162
3163 (defmacro gnus-data-make (number mark pos header level)
3164   `(list ,number ,mark ,pos ,header ,level))
3165
3166 (defun gnus-data-enter (after-article number mark pos header level offset)
3167   (let ((data (gnus-data-find-list after-article)))
3168     (unless data
3169       (error "No such article: %d" after-article))
3170     (setcdr data (cons (gnus-data-make number mark pos header level)
3171                        (cdr data)))
3172     (setq gnus-newsgroup-data-reverse nil)
3173     (gnus-data-update-list (cddr data) offset)))
3174
3175 (defun gnus-data-enter-list (after-article list &optional offset)
3176   (when list
3177     (let ((data (and after-article (gnus-data-find-list after-article)))
3178           (ilist list))
3179       (if (not (or data
3180                    after-article))
3181           (let ((odata gnus-newsgroup-data))
3182             (setq gnus-newsgroup-data (nconc list gnus-newsgroup-data))
3183             (when offset
3184               (gnus-data-update-list odata offset)))
3185         ;; Find the last element in the list to be spliced into the main
3186         ;; list.
3187         (setq list (last list))
3188         (if (not data)
3189             (progn
3190               (setcdr list gnus-newsgroup-data)
3191               (setq gnus-newsgroup-data ilist)
3192               (when offset
3193                 (gnus-data-update-list (cdr list) offset)))
3194           (setcdr list (cdr data))
3195           (setcdr data ilist)
3196           (when offset
3197             (gnus-data-update-list (cdr list) offset))))
3198       (setq gnus-newsgroup-data-reverse nil))))
3199
3200 (defun gnus-data-remove (article &optional offset)
3201   (let ((data gnus-newsgroup-data))
3202     (if (= (gnus-data-number (car data)) article)
3203         (progn
3204           (setq gnus-newsgroup-data (cdr gnus-newsgroup-data)
3205                 gnus-newsgroup-data-reverse nil)
3206           (when offset
3207             (gnus-data-update-list gnus-newsgroup-data offset)))
3208       (while (cdr data)
3209         (when (= (gnus-data-number (cadr data)) article)
3210           (setcdr data (cddr data))
3211           (when offset
3212             (gnus-data-update-list (cdr data) offset))
3213           (setq data nil
3214                 gnus-newsgroup-data-reverse nil))
3215         (setq data (cdr data))))))
3216
3217 (defmacro gnus-data-list (backward)
3218   `(if ,backward
3219        (or gnus-newsgroup-data-reverse
3220            (setq gnus-newsgroup-data-reverse
3221                  (reverse gnus-newsgroup-data)))
3222      gnus-newsgroup-data))
3223
3224 (defun gnus-data-update-list (data offset)
3225   "Add OFFSET to the POS of all data entries in DATA."
3226   (setq gnus-newsgroup-data-reverse nil)
3227   (while data
3228     (setcar (nthcdr 2 (car data)) (+ offset (nth 2 (car data))))
3229     (setq data (cdr data))))
3230
3231 (defun gnus-summary-article-pseudo-p (article)
3232   "Say whether this article is a pseudo article or not."
3233   (not (vectorp (gnus-data-header (gnus-data-find article)))))
3234
3235 (defmacro gnus-summary-article-sparse-p (article)
3236   "Say whether this article is a sparse article or not."
3237   `(memq ,article gnus-newsgroup-sparse))
3238
3239 (defmacro gnus-summary-article-ancient-p (article)
3240   "Say whether this article is a sparse article or not."
3241   `(memq ,article gnus-newsgroup-ancient))
3242
3243 (defun gnus-article-parent-p (number)
3244   "Say whether this article is a parent or not."
3245   (let ((data (gnus-data-find-list number)))
3246     (and (cdr data)              ; There has to be an article after...
3247          (< (gnus-data-level (car data)) ; And it has to have a higher level.
3248             (gnus-data-level (nth 1 data))))))
3249
3250 (defun gnus-article-children (number)
3251   "Return a list of all children to NUMBER."
3252   (let* ((data (gnus-data-find-list number))
3253          (level (gnus-data-level (car data)))
3254          children)
3255     (setq data (cdr data))
3256     (while (and data
3257                 (= (gnus-data-level (car data)) (1+ level)))
3258       (push (gnus-data-number (car data)) children)
3259       (setq data (cdr data)))
3260     children))
3261
3262 (defmacro gnus-summary-skip-intangible ()
3263   "If the current article is intangible, then jump to a different article."
3264   '(let ((to (get-text-property (point) 'gnus-intangible)))
3265      (and to (gnus-summary-goto-subject to))))
3266
3267 (defmacro gnus-summary-article-intangible-p ()
3268   "Say whether this article is intangible or not."
3269   '(get-text-property (point) 'gnus-intangible))
3270
3271 (defun gnus-article-read-p (article)
3272   "Say whether ARTICLE is read or not."
3273   (not (or (memq article gnus-newsgroup-marked)
3274            (memq article gnus-newsgroup-spam-marked)
3275            (memq article gnus-newsgroup-unreads)
3276            (memq article gnus-newsgroup-unselected)
3277            (memq article gnus-newsgroup-dormant))))
3278
3279 ;; Some summary mode macros.
3280
3281 (defmacro gnus-summary-article-number ()
3282   "The article number of the article on the current line.
3283 If there isn't an article number here, then we return the current
3284 article number."
3285   '(progn
3286      (gnus-summary-skip-intangible)
3287      (or (get-text-property (point) 'gnus-number)
3288          (gnus-summary-last-subject))))
3289
3290 (defmacro gnus-summary-article-header (&optional number)
3291   "Return the header of article NUMBER."
3292   `(gnus-data-header (gnus-data-find
3293                       ,(or number '(gnus-summary-article-number)))))
3294
3295 (defmacro gnus-summary-thread-level (&optional number)
3296   "Return the level of thread that starts with article NUMBER."
3297   `(if (and (eq gnus-summary-make-false-root 'dummy)
3298             (get-text-property (point) 'gnus-intangible))
3299        0
3300      (gnus-data-level (gnus-data-find
3301                        ,(or number '(gnus-summary-article-number))))))
3302
3303 (defmacro gnus-summary-article-mark (&optional number)
3304   "Return the mark of article NUMBER."
3305   `(gnus-data-mark (gnus-data-find
3306                     ,(or number '(gnus-summary-article-number)))))
3307
3308 (defmacro gnus-summary-article-pos (&optional number)
3309   "Return the position of the line of article NUMBER."
3310   `(gnus-data-pos (gnus-data-find
3311                    ,(or number '(gnus-summary-article-number)))))
3312
3313 (defalias 'gnus-summary-subject-string 'gnus-summary-article-subject)
3314 (defmacro gnus-summary-article-subject (&optional number)
3315   "Return current subject string or nil if nothing."
3316   `(let ((headers
3317           ,(if number
3318                `(gnus-data-header (assq ,number gnus-newsgroup-data))
3319              '(gnus-data-header (assq (gnus-summary-article-number)
3320                                       gnus-newsgroup-data)))))
3321      (and headers
3322           (vectorp headers)
3323           (mail-header-subject headers))))
3324
3325 (defmacro gnus-summary-article-score (&optional number)
3326   "Return current article score."
3327   `(or (cdr (assq ,(or number '(gnus-summary-article-number))
3328                   gnus-newsgroup-scored))
3329        gnus-summary-default-score 0))
3330
3331 (defun gnus-summary-article-children (&optional number)
3332   "Return a list of article numbers that are children of article NUMBER."
3333   (let* ((data (gnus-data-find-list (or number (gnus-summary-article-number))))
3334          (level (gnus-data-level (car data)))
3335          l children)
3336     (while (and (setq data (cdr data))
3337                 (> (setq l (gnus-data-level (car data))) level))
3338       (and (= (1+ level) l)
3339            (push (gnus-data-number (car data))
3340                  children)))
3341     (nreverse children)))
3342
3343 (defun gnus-summary-article-parent (&optional number)
3344   "Return the article number of the parent of article NUMBER."
3345   (let* ((data (gnus-data-find-list (or number (gnus-summary-article-number))
3346                                     (gnus-data-list t)))
3347          (level (gnus-data-level (car data))))
3348     (if (zerop level)
3349         ()                              ; This is a root.
3350       ;; We search until we find an article with a level less than
3351       ;; this one.  That function has to be the parent.
3352       (while (and (setq data (cdr data))
3353                   (not (< (gnus-data-level (car data)) level))))
3354       (and data (gnus-data-number (car data))))))
3355
3356 (defun gnus-unread-mark-p (mark)
3357   "Say whether MARK is the unread mark."
3358   (= mark gnus-unread-mark))
3359
3360 (defun gnus-read-mark-p (mark)
3361   "Say whether MARK is one of the marks that mark as read.
3362 This is all marks except unread, ticked, dormant, and expirable."
3363   (not (or (= mark gnus-unread-mark)
3364            (= mark gnus-ticked-mark)
3365            (= mark gnus-spam-mark)
3366            (= mark gnus-dormant-mark)
3367            (= mark gnus-expirable-mark))))
3368
3369 (defmacro gnus-article-mark (number)
3370   "Return the MARK of article NUMBER.
3371 This macro should only be used when computing the mark the \"first\"
3372 time; i.e., when generating the summary lines.  After that,
3373 `gnus-summary-article-mark' should be used to examine the
3374 marks of articles."
3375   `(cond
3376     ((memq ,number gnus-newsgroup-unsendable) gnus-unsendable-mark)
3377     ((memq ,number gnus-newsgroup-downloadable) gnus-downloadable-mark)
3378     ((memq ,number gnus-newsgroup-unreads) gnus-unread-mark)
3379     ((memq ,number gnus-newsgroup-marked) gnus-ticked-mark)
3380     ((memq ,number gnus-newsgroup-spam-marked) gnus-spam-mark)
3381     ((memq ,number gnus-newsgroup-dormant) gnus-dormant-mark)
3382     ((memq ,number gnus-newsgroup-expirable) gnus-expirable-mark)
3383     (t (or (cdr (assq ,number gnus-newsgroup-reads))
3384            gnus-ancient-mark))))
3385
3386 ;; Saving hidden threads.
3387
3388 (defmacro gnus-save-hidden-threads (&rest forms)
3389   "Save hidden threads, eval FORMS, and restore the hidden threads."
3390   (let ((config (make-symbol "config")))
3391     `(let ((,config (gnus-hidden-threads-configuration)))
3392        (unwind-protect
3393            (save-excursion
3394              ,@forms)
3395          (gnus-restore-hidden-threads-configuration ,config)))))
3396 (put 'gnus-save-hidden-threads 'lisp-indent-function 0)
3397 (put 'gnus-save-hidden-threads 'edebug-form-spec '(body))
3398
3399 (defun gnus-data-compute-positions ()
3400   "Compute the positions of all articles."
3401   (setq gnus-newsgroup-data-reverse nil)
3402   (let ((data gnus-newsgroup-data))
3403     (save-excursion
3404       (gnus-save-hidden-threads
3405         (gnus-summary-show-all-threads)
3406         (goto-char (point-min))
3407         (while data
3408           (while (get-text-property (point) 'gnus-intangible)
3409             (forward-line 1))
3410           (gnus-data-set-pos (car data) (+ (point) 3))
3411           (setq data (cdr data))
3412           (forward-line 1))))))
3413
3414 (defun gnus-hidden-threads-configuration ()
3415   "Return the current hidden threads configuration."
3416   (save-excursion
3417     (let (config)
3418       (goto-char (point-min))
3419       (while (not (eobp))
3420         (when (eq (get-char-property (point-at-eol) 'invisible) 'gnus-sum)
3421           (push (save-excursion (forward-line 0) (point)) config))
3422         (forward-line 1))
3423       config)))
3424
3425 (defun gnus-restore-hidden-threads-configuration (config)
3426   "Restore hidden threads configuration from CONFIG."
3427   (save-excursion
3428     (let (point (inhibit-read-only t))
3429       (while (setq point (pop config))
3430         (goto-char point)
3431         (gnus-summary-hide-thread)))))
3432
3433 ;; Various summary mode internalish functions.
3434
3435 (defun gnus-mouse-pick-article (e)
3436   (interactive "e")
3437   (mouse-set-point e)
3438   (gnus-summary-next-page nil t))
3439
3440 (defun gnus-summary-set-display-table ()
3441   "Change the display table.
3442 Odd characters have a tendency to mess
3443 up nicely formatted displays - we make all possible glyphs
3444 display only a single character."
3445
3446   ;; We start from the standard display table, if any.
3447   (let ((table (or (copy-sequence standard-display-table)
3448                    (make-display-table)))
3449         (i 32))
3450     ;; Nix out all the control chars...
3451     (while (>= (setq i (1- i)) 0)
3452       (gnus-put-display-table i [??] table))
3453    ;; ... but not newline and cr, of course.  (cr is necessary for the
3454     ;; selective display).
3455     (gnus-put-display-table ?\n nil table)
3456     (gnus-put-display-table ?\r nil table)
3457     ;; We keep TAB as well.
3458     (gnus-put-display-table ?\t nil table)
3459     ;; We nix out any glyphs 127 through 255, or 127 through 159 in
3460     ;; Emacs 23 (unicode), that are not set already.
3461     (let ((i (if (ignore-errors (= (make-char 'latin-iso8859-1 160) 160))
3462                  160
3463                256)))
3464       (while (>= (setq i (1- i)) 127)
3465         ;; Only modify if the entry is nil.
3466         (unless (gnus-get-display-table i table)
3467           (gnus-put-display-table i [??] table))))
3468     (setq buffer-display-table table)))
3469
3470 (defun gnus-summary-set-article-display-arrow (pos)
3471   "Update the overlay arrow to point to line at position POS."
3472   (when gnus-summary-display-arrow
3473     (make-local-variable 'overlay-arrow-position)
3474     (make-local-variable 'overlay-arrow-string)
3475     (save-excursion
3476       (goto-char pos)
3477       (beginning-of-line)
3478       (unless overlay-arrow-position
3479         (setq overlay-arrow-position (make-marker)))
3480       (setq overlay-arrow-string "=>"
3481             overlay-arrow-position (set-marker overlay-arrow-position
3482                                                (point)
3483                                                (current-buffer))))))
3484
3485 (defun gnus-summary-setup-buffer (group)
3486   "Initialize summary buffer."
3487   (let ((buffer (gnus-summary-buffer-name group))
3488         (dead-name (concat "*Dead Summary "
3489                            (gnus-group-decoded-name group) "*")))
3490     ;; If a dead summary buffer exists, we kill it.
3491     (when (gnus-buffer-live-p dead-name)
3492       (gnus-kill-buffer dead-name))
3493     (if (get-buffer buffer)
3494         (progn
3495           (set-buffer buffer)
3496           (setq gnus-summary-buffer (current-buffer))
3497           (not gnus-newsgroup-prepared))
3498       ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
3499       (setq gnus-summary-buffer (set-buffer (gnus-get-buffer-create buffer)))
3500       (gnus-summary-mode group)
3501       (when gnus-carpal
3502         (gnus-carpal-setup-buffer 'summary))
3503       (when (gnus-group-quit-config group)
3504         (set (make-local-variable 'gnus-single-article-buffer) nil))
3505       (make-local-variable 'gnus-article-buffer)
3506       (make-local-variable 'gnus-article-current)
3507       (make-local-variable 'gnus-original-article-buffer)
3508       (setq gnus-newsgroup-name group)
3509       ;; Set any local variables in the group parameters.
3510       (gnus-summary-set-local-parameters gnus-newsgroup-name)
3511       t)))
3512
3513 (defun gnus-set-global-variables ()
3514   "Set the global equivalents of the buffer-local variables.
3515 They are set to the latest values they had.  These reflect the summary
3516 buffer that was in action when the last article was fetched."
3517   (when (eq major-mode 'gnus-summary-mode)
3518     (setq gnus-summary-buffer (current-buffer))
3519     (let ((name gnus-newsgroup-name)
3520           (marked gnus-newsgroup-marked)
3521           (spam gnus-newsgroup-spam-marked)
3522           (unread gnus-newsgroup-unreads)
3523           (headers gnus-current-headers)
3524           (data gnus-newsgroup-data)
3525           (summary gnus-summary-buffer)
3526           (article-buffer gnus-article-buffer)
3527           (original gnus-original-article-buffer)
3528           (gac gnus-article-current)
3529           (reffed gnus-reffed-article-number)
3530           (score-file gnus-current-score-file)
3531           (default-charset gnus-newsgroup-charset)
3532           vlist)
3533       (let ((locals gnus-newsgroup-variables))
3534         (while locals
3535           (if (consp (car locals))
3536               (push (eval (caar locals)) vlist)
3537             (push (eval (car locals)) vlist))
3538           (setq locals (cdr locals)))
3539         (setq vlist (nreverse vlist)))
3540       (with-current-buffer gnus-group-buffer
3541         (setq gnus-newsgroup-name name
3542               gnus-newsgroup-marked marked
3543               gnus-newsgroup-spam-marked spam
3544               gnus-newsgroup-unreads unread
3545               gnus-current-headers headers
3546               gnus-newsgroup-data data
3547               gnus-article-current gac
3548               gnus-summary-buffer summary
3549               gnus-article-buffer article-buffer
3550               gnus-original-article-buffer original
3551               gnus-reffed-article-number reffed
3552               gnus-current-score-file score-file
3553               gnus-newsgroup-charset default-charset)
3554         (let ((locals gnus-newsgroup-variables))
3555           (while locals
3556             (if (consp (car locals))
3557                 (set (caar locals) (pop vlist))
3558               (set (car locals) (pop vlist)))
3559             (setq locals (cdr locals))))
3560         ;; The article buffer also has local variables.
3561         (when (gnus-buffer-live-p gnus-article-buffer)
3562           (set-buffer gnus-article-buffer)
3563           (setq gnus-summary-buffer summary))))))
3564
3565 (defun gnus-summary-article-unread-p (article)
3566   "Say whether ARTICLE is unread or not."
3567   (memq article gnus-newsgroup-unreads))
3568
3569 (defun gnus-summary-first-article-p (&optional article)
3570   "Return whether ARTICLE is the first article in the buffer."
3571   (if (not (setq article (or article (gnus-summary-article-number))))
3572       nil
3573     (eq article (caar gnus-newsgroup-data))))
3574
3575 (defun gnus-summary-last-article-p (&optional article)
3576   "Return whether ARTICLE is the last article in the buffer."
3577   (if (not (setq article (or article (gnus-summary-article-number))))
3578       ;; All non-existent numbers are the last article.  :-)
3579       t
3580     (not (cdr (gnus-data-find-list article)))))
3581
3582 (defun gnus-make-thread-indent-array (&optional n)
3583   (when (or n
3584             (progn (setq n 200) nil)
3585             (null gnus-thread-indent-array)
3586             (/= gnus-thread-indent-level gnus-thread-indent-array-level))
3587     (setq gnus-thread-indent-array (make-vector (1+ n) "")
3588           gnus-thread-indent-array-level gnus-thread-indent-level)
3589     (while (>= n 0)
3590       (aset gnus-thread-indent-array n
3591             (make-string (* n gnus-thread-indent-level) ? ))
3592       (setq n (1- n)))))
3593
3594 (defun gnus-update-summary-mark-positions ()
3595   "Compute where the summary marks are to go."
3596   (save-excursion
3597     (when (gnus-buffer-exists-p gnus-summary-buffer)
3598       (set-buffer gnus-summary-buffer))
3599     (let ((spec gnus-summary-line-format-spec)
3600           pos)
3601       (save-excursion
3602         (gnus-set-work-buffer)
3603         (let ((gnus-tmp-unread ?Z)
3604               (gnus-replied-mark ?Z)
3605               (gnus-score-below-mark ?Z)
3606               (gnus-score-over-mark ?Z)
3607               (gnus-undownloaded-mark ?Z)
3608               (gnus-summary-line-format-spec spec)
3609               (gnus-newsgroup-downloadable '(0))
3610               (header [0 "" "" "05 Apr 2001 23:33:09 +0400" "" "" 0 0 "" nil])
3611               case-fold-search ignores)
3612           ;; Here, all marks are bound to Z.
3613           (gnus-summary-insert-line header
3614                                     0 nil t gnus-tmp-unread t nil "" nil 1)
3615           (goto-char (point-min))
3616           ;; Memorize the positions of the same characters as dummy marks.
3617           (while (re-search-forward "[A-D]" nil t)
3618             (push (point) ignores))
3619           (erase-buffer)
3620           ;; We use A-D as dummy marks in order to know column positions
3621           ;; where marks should be inserted.
3622           (setq gnus-tmp-unread ?A
3623                 gnus-replied-mark ?B
3624                 gnus-score-below-mark ?C
3625                 gnus-score-over-mark ?C
3626                 gnus-undownloaded-mark ?D)
3627           (gnus-summary-insert-line header
3628                                     0 nil t gnus-tmp-unread t nil "" nil 1)
3629           ;; Ignore characters which aren't dummy marks.
3630           (dolist (p ignores)
3631             (delete-region (goto-char (1- p)) p)
3632             (insert ?Z))
3633           (goto-char (point-min))
3634           (setq pos (list (cons 'unread
3635                                 (and (search-forward "A" nil t)
3636                                      (- (point) (point-min) 1)))))
3637           (goto-char (point-min))
3638           (push (cons 'replied (and (search-forward "B" nil t)
3639                                     (- (point) (point-min) 1)))
3640                 pos)
3641           (goto-char (point-min))
3642           (push (cons 'score (and (search-forward "C" nil t)
3643                                   (- (point) (point-min) 1)))
3644                 pos)
3645           (goto-char (point-min))
3646           (push (cons 'download (and (search-forward "D" nil t)
3647                                      (- (point) (point-min) 1)))
3648                 pos)))
3649       (setq gnus-summary-mark-positions pos))))
3650
3651 (defun gnus-summary-insert-dummy-line (gnus-tmp-subject gnus-tmp-number)
3652   "Insert a dummy root in the summary buffer."
3653   (beginning-of-line)
3654   (gnus-add-text-properties
3655    (point) (progn (eval gnus-summary-dummy-line-format-spec) (point))
3656    (list 'gnus-number gnus-tmp-number 'gnus-intangible gnus-tmp-number)))
3657
3658 (defun gnus-summary-extract-address-component (from)
3659   (or (car (funcall gnus-extract-address-components from))
3660       from))
3661
3662 (defun gnus-summary-from-or-to-or-newsgroups (header gnus-tmp-from)
3663   (let ((mail-parse-charset gnus-newsgroup-charset)
3664         (ignored-from-addresses (gnus-ignored-from-addresses))
3665         ; Is it really necessary to do this next part for each summary line?
3666         ; Luckily, doesn't seem to slow things down much.
3667         (mail-parse-ignored-charsets
3668          (with-current-buffer gnus-summary-buffer
3669            gnus-newsgroup-ignored-charsets)))
3670     (or
3671      (and ignored-from-addresses
3672           (string-match ignored-from-addresses gnus-tmp-from)
3673           (let ((extra-headers (mail-header-extra header))
3674                 to
3675                 newsgroups)
3676             (cond
3677              ((setq to (cdr (assq 'To extra-headers)))
3678               (concat gnus-summary-to-prefix
3679                       (inline
3680                         (gnus-summary-extract-address-component
3681                          (funcall gnus-decode-encoded-address-function to)))))
3682              ((setq newsgroups
3683                     (or
3684                      (cdr (assq 'Newsgroups extra-headers))
3685                      (and
3686                       (memq 'Newsgroups gnus-extra-headers)
3687                       (eq (car (gnus-find-method-for-group
3688                                 gnus-newsgroup-name)) 'nntp)
3689                       (gnus-group-real-name gnus-newsgroup-name))))
3690               (concat gnus-summary-newsgroup-prefix newsgroups)))))
3691      (inline (gnus-summary-extract-address-component gnus-tmp-from)))))
3692
3693 (defun gnus-summary-insert-line (gnus-tmp-header
3694                                  gnus-tmp-level gnus-tmp-current
3695                                  undownloaded gnus-tmp-unread gnus-tmp-replied
3696                                  gnus-tmp-expirable gnus-tmp-subject-or-nil
3697                                  &optional gnus-tmp-dummy gnus-tmp-score
3698                                  gnus-tmp-process)
3699   (if (>= gnus-tmp-level (length gnus-thread-indent-array))
3700       (gnus-make-thread-indent-array (max (* 2 (length gnus-thread-indent-array))
3701                                           gnus-tmp-level)))
3702   (let* ((gnus-tmp-indentation (aref gnus-thread-indent-array gnus-tmp-level))
3703          (gnus-tmp-lines (mail-header-lines gnus-tmp-header))
3704          (gnus-tmp-score (or gnus-tmp-score gnus-summary-default-score 0))
3705          (gnus-tmp-score-char
3706           (if (or (null gnus-summary-default-score)
3707                   (<= (abs (- gnus-tmp-score gnus-summary-default-score))
3708                       gnus-summary-zcore-fuzz))
3709               ?                         ;Whitespace
3710             (if (< gnus-tmp-score gnus-summary-default-score)
3711                 gnus-score-below-mark gnus-score-over-mark)))
3712          (gnus-tmp-number (mail-header-number gnus-tmp-header))
3713          (gnus-tmp-replied
3714           (cond (gnus-tmp-process gnus-process-mark)
3715                 ((memq gnus-tmp-current gnus-newsgroup-cached)
3716                  gnus-cached-mark)
3717                 (gnus-tmp-replied gnus-replied-mark)
3718                 ((memq gnus-tmp-current gnus-newsgroup-forwarded)
3719                  gnus-forwarded-mark)
3720                 ((memq gnus-tmp-current gnus-newsgroup-saved)
3721                  gnus-saved-mark)
3722                 ((memq gnus-tmp-number gnus-newsgroup-recent)
3723                  gnus-recent-mark)
3724                 ((memq gnus-tmp-number gnus-newsgroup-unseen)
3725                  gnus-unseen-mark)
3726                 (t gnus-no-mark)))
3727          (gnus-tmp-downloaded
3728           (cond (undownloaded
3729                  gnus-undownloaded-mark)
3730                 (gnus-newsgroup-agentized
3731                  gnus-downloaded-mark)
3732                 (t
3733                  gnus-no-mark)))
3734          (gnus-tmp-from (mail-header-from gnus-tmp-header))
3735          (gnus-tmp-name
3736           (cond
3737            ((string-match "<[^>]+> *$" gnus-tmp-from)
3738             (let ((beg (match-beginning 0)))
3739               (or (and (string-match "^\".+\"" gnus-tmp-from)
3740                        (substring gnus-tmp-from 1 (1- (match-end 0))))
3741                   (substring gnus-tmp-from 0 beg))))
3742            ((string-match "(.+)" gnus-tmp-from)
3743             (substring gnus-tmp-from
3744                        (1+ (match-beginning 0)) (1- (match-end 0))))
3745            (t gnus-tmp-from)))
3746          (gnus-tmp-subject (mail-header-subject gnus-tmp-header))
3747          (gnus-tmp-opening-bracket (if gnus-tmp-dummy ?\< ?\[))
3748          (gnus-tmp-closing-bracket (if gnus-tmp-dummy ?\> ?\]))
3749          (inhibit-read-only t))
3750     (when (string= gnus-tmp-name "")
3751       (setq gnus-tmp-name gnus-tmp-from))
3752     (unless (numberp gnus-tmp-lines)
3753       (setq gnus-tmp-lines -1))
3754     (if (= gnus-tmp-lines -1)
3755         (setq gnus-tmp-lines "?")
3756       (setq gnus-tmp-lines (number-to-string gnus-tmp-lines)))
3757     (condition-case ()
3758         (gnus-put-text-property
3759          (point)
3760          (progn (eval gnus-summary-line-format-spec) (point))
3761          'gnus-number gnus-tmp-number)
3762       (error (gnus-message 5 "Error updating the summary line")))
3763     (when (gnus-visual-p 'summary-highlight 'highlight)
3764       (forward-line -1)
3765       (gnus-summary-highlight-line)
3766       (gnus-run-hooks 'gnus-summary-update-hook)
3767       (forward-line 1))))
3768
3769 (defun gnus-summary-update-line (&optional dont-update)
3770   "Update summary line after change."
3771   (when (and gnus-summary-default-score
3772              (not gnus-summary-inhibit-highlight))
3773     (let* ((gnus-summary-inhibit-highlight t) ; Prevent recursion.
3774            (article (gnus-summary-article-number))
3775            (score (gnus-summary-article-score article)))
3776       (unless dont-update
3777         (if (and gnus-summary-mark-below
3778                  (< (gnus-summary-article-score)
3779                     gnus-summary-mark-below))
3780             ;; This article has a low score, so we mark it as read.
3781             (when (memq article gnus-newsgroup-unreads)
3782               (gnus-summary-mark-article-as-read gnus-low-score-mark))
3783           (when (eq (gnus-summary-article-mark) gnus-low-score-mark)
3784             ;; This article was previously marked as read on account
3785             ;; of a low score, but now it has risen, so we mark it as
3786             ;; unread.
3787             (gnus-summary-mark-article-as-unread gnus-unread-mark)))
3788         (gnus-summary-update-mark
3789          (if (or (null gnus-summary-default-score)
3790                  (<= (abs (- score gnus-summary-default-score))
3791                      gnus-summary-zcore-fuzz))
3792              ?                          ;Whitespace
3793            (if (< score gnus-summary-default-score)
3794                gnus-score-below-mark gnus-score-over-mark))
3795          'score))
3796       ;; Do visual highlighting.
3797       (when (gnus-visual-p 'summary-highlight 'highlight)
3798         (gnus-summary-highlight-line)
3799         (gnus-run-hooks 'gnus-summary-update-hook)))))
3800
3801 (defvar gnus-tmp-new-adopts nil)
3802
3803 (defun gnus-summary-number-of-articles-in-thread (thread &optional level char)
3804   "Return the number of articles in THREAD.
3805 This may be 0 in some cases -- if none of the articles in
3806 the thread are to be displayed."
3807   (let* ((number
3808          ;; Fix by Luc Van Eycken <Luc.VanEycken@esat.kuleuven.ac.be>.
3809           (cond
3810            ((not (listp thread))
3811             1)
3812            ((and (consp thread) (cdr thread))
3813             (apply
3814              '+ 1 (mapcar
3815                    'gnus-summary-number-of-articles-in-thread (cdr thread))))
3816            ((null thread)
3817             1)
3818            ((memq (mail-header-number (car thread)) gnus-newsgroup-limit)
3819             1)
3820            (t 0))))
3821     (when (and level (zerop level) gnus-tmp-new-adopts)
3822       (incf number
3823             (apply '+ (mapcar
3824                        'gnus-summary-number-of-articles-in-thread
3825                        gnus-tmp-new-adopts))))
3826     (if char
3827         (if (> number 1) gnus-not-empty-thread-mark
3828           gnus-empty-thread-mark)
3829       number)))
3830
3831 (defsubst gnus-summary-line-message-size (head)
3832   "Return pretty-printed version of message size.
3833 This function is intended to be used in
3834 `gnus-summary-line-format-alist'."
3835   (let ((c (or (mail-header-chars head) -1)))
3836     (cond ((< c 0) "n/a")               ; chars not available
3837           ((< c (* 1000 10)) (format "%1.1fk" (/ c 1024.0)))
3838           ((< c (* 1000 100)) (format "%dk" (/ c 1024.0)))
3839           ((< c (* 1000 10000)) (format "%1.1fM" (/ c (* 1024.0 1024))))
3840           (t (format "%dM" (/ c (* 1024.0 1024)))))))
3841
3842
3843 (defun gnus-summary-set-local-parameters (group)
3844   "Go through the local params of GROUP and set all variable specs in that list."
3845   (let ((vars '(quit-config)))          ; Ignore quit-config.
3846     (dolist (elem (gnus-group-find-parameter group))
3847       (and (consp elem)                 ; Has to be a cons.
3848            (consp (cdr elem))           ; The cdr has to be a list.
3849            (symbolp (car elem))         ; Has to be a symbol in there.
3850            (not (memq (car elem) vars))
3851            (ignore-errors
3852              (push (car elem) vars)
3853              ;; Variables like `gnus-show-threads' that are globally
3854              ;; bound, if used as group parameters, need to get to be
3855              ;; buffer-local, whereas just parameters like `gcc-self',
3856              ;; `timestamp', etc. should not be bound as variables.
3857              (if (boundp (car elem))
3858                  (set (make-local-variable (car elem)) (eval (nth 1 elem)))
3859                (eval (nth 1 elem))))))))
3860
3861 (defun gnus-summary-read-group (group &optional show-all no-article
3862                                       kill-buffer no-display backward
3863                                       select-articles)
3864   "Start reading news in newsgroup GROUP.
3865 If SHOW-ALL is non-nil, already read articles are also listed.
3866 If NO-ARTICLE is non-nil, no article is selected initially.
3867 If NO-DISPLAY, don't generate a summary buffer."
3868   (let (result)
3869     (while (and group
3870                 (null (setq result
3871                             (let ((gnus-auto-select-next nil))
3872                               (or (gnus-summary-read-group-1
3873                                    group show-all no-article
3874                                    kill-buffer no-display
3875                                    select-articles)
3876                                   (setq show-all nil
3877                                         select-articles nil)))))
3878                 (eq gnus-auto-select-next 'quietly))
3879       (set-buffer gnus-group-buffer)
3880       ;; The entry function called above goes to the next
3881       ;; group automatically, so we go two groups back
3882       ;; if we are searching for the previous group.
3883       (when backward
3884         (gnus-group-prev-unread-group 2))
3885       (if (not (equal group (gnus-group-group-name)))
3886           (setq group (gnus-group-group-name))
3887         (setq group nil)))
3888     result))
3889
3890 (defun gnus-summary-read-group-1 (group show-all no-article
3891                                         kill-buffer no-display
3892                                         &optional select-articles)
3893   ;; Killed foreign groups can't be entered.
3894   ;;  (when (and (not (gnus-group-native-p group))
3895   ;;         (not (gnus-gethash group gnus-newsrc-hashtb)))
3896   ;;    (error "Dead non-native groups can't be entered"))
3897   (gnus-message 5 "Retrieving newsgroup: %s..."
3898                 (gnus-group-decoded-name group))
3899   (let* ((new-group (gnus-summary-setup-buffer group))
3900          (quit-config (gnus-group-quit-config group))
3901          (did-select (and new-group (gnus-select-newsgroup
3902                                      group show-all select-articles))))
3903     (cond
3904      ;; This summary buffer exists already, so we just select it.
3905      ((not new-group)
3906       (gnus-set-global-variables)
3907       (when kill-buffer
3908         (gnus-kill-or-deaden-summary kill-buffer))
3909       (gnus-configure-windows 'summary 'force)
3910       (gnus-set-mode-line 'summary)
3911       (gnus-summary-position-point)
3912       (message "")
3913       t)
3914      ;; We couldn't select this group.
3915      ((null did-select)
3916       (when (and (eq major-mode 'gnus-summary-mode)
3917                  (not (equal (current-buffer) kill-buffer)))
3918         (kill-buffer (current-buffer))
3919         (if (not quit-config)
3920             (progn
3921               ;; Update the info -- marks might need to be removed,
3922               ;; for instance.
3923               (gnus-summary-update-info)
3924               (set-buffer gnus-group-buffer)
3925               (gnus-group-jump-to-group group)
3926               (gnus-group-next-unread-group 1))
3927           (gnus-handle-ephemeral-exit quit-config)))
3928       (let ((grpinfo (gnus-get-info group)))
3929         (if (null (gnus-info-read grpinfo))
3930             (gnus-message 3 "Group %s contains no messages"
3931                           (gnus-group-decoded-name group))
3932           (gnus-message 3 "Can't select group")))
3933       nil)
3934      ;; The user did a `C-g' while prompting for number of articles,
3935      ;; so we exit this group.
3936      ((eq did-select 'quit)
3937       (and (eq major-mode 'gnus-summary-mode)
3938            (not (equal (current-buffer) kill-buffer))
3939            (kill-buffer (current-buffer)))
3940       (when kill-buffer
3941         (gnus-kill-or-deaden-summary kill-buffer))
3942       (if (not quit-config)
3943           (progn
3944             (set-buffer gnus-group-buffer)
3945             (gnus-group-jump-to-group group)
3946             (gnus-configure-windows 'group 'force))
3947         (gnus-handle-ephemeral-exit quit-config))
3948       ;; Finally signal the quit.
3949       (signal 'quit nil))
3950      ;; The group was successfully selected.
3951      (t
3952       (gnus-set-global-variables)
3953       ;; Save the active value in effect when the group was entered.
3954       (setq gnus-newsgroup-active
3955             (gnus-copy-sequence
3956              (gnus-active gnus-newsgroup-name)))
3957       ;; You can change the summary buffer in some way with this hook.
3958       (gnus-run-hooks 'gnus-select-group-hook)
3959       (when (memq 'summary (gnus-update-format-specifications
3960                             nil 'summary 'summary-mode 'summary-dummy))
3961         ;; The format specification for the summary line was updated,
3962         ;; so we need to update the mark positions as well.
3963         (gnus-update-summary-mark-positions))
3964       ;; Do score processing.
3965       (when gnus-use-scoring
3966         (gnus-possibly-score-headers))
3967       ;; Check whether to fill in the gaps in the threads.
3968       (when gnus-build-sparse-threads
3969         (gnus-build-sparse-threads))
3970       ;; Find the initial limit.
3971       (if show-all
3972           (let ((gnus-newsgroup-dormant nil))
3973             (gnus-summary-initial-limit show-all))
3974         (gnus-summary-initial-limit show-all))
3975       ;; Generate the summary buffer.
3976       (unless no-display
3977         (gnus-summary-prepare))
3978       (when gnus-use-trees
3979         (gnus-tree-open group)
3980         (setq gnus-summary-highlight-line-function
3981               'gnus-tree-highlight-article))
3982       ;; If the summary buffer is empty, but there are some low-scored
3983       ;; articles or some excluded dormants, we include these in the
3984       ;; buffer.
3985       (when (and (zerop (buffer-size))
3986                  (not no-display))
3987         (cond (gnus-newsgroup-dormant
3988                (gnus-summary-limit-include-dormant))
3989               ((and gnus-newsgroup-scored show-all)
3990                (gnus-summary-limit-include-expunged t))))
3991       ;; Function `gnus-apply-kill-file' must be called in this hook.
3992       (gnus-run-hooks 'gnus-apply-kill-hook)
3993       (if (and (zerop (buffer-size))
3994                (not no-display))
3995           (progn
3996             ;; This newsgroup is empty.
3997             (gnus-summary-catchup-and-exit nil t)
3998             (gnus-message 6 "No unread news")
3999             (when kill-buffer
4000               (gnus-kill-or-deaden-summary kill-buffer))
4001             ;; Return nil from this function.
4002             nil)
4003         ;; Hide conversation thread subtrees.  We cannot do this in
4004         ;; gnus-summary-prepare-hook since kill processing may not
4005         ;; work with hidden articles.
4006         (gnus-summary-maybe-hide-threads)
4007         (when kill-buffer
4008           (gnus-kill-or-deaden-summary kill-buffer))
4009         (gnus-summary-auto-select-subject)
4010         ;; Show first unread article if requested.
4011         (if (and (not no-article)
4012                  (not no-display)
4013                  gnus-newsgroup-unreads
4014                  gnus-auto-select-first)
4015             (progn
4016               (gnus-configure-windows 'summary)
4017               (let ((art (gnus-summary-article-number)))
4018                 (unless (and (not gnus-plugged)
4019                              (or (memq art gnus-newsgroup-undownloaded)
4020                                  (memq art gnus-newsgroup-downloadable)))
4021                   (gnus-summary-goto-article art))))
4022           ;; Don't select any articles.
4023           (gnus-summary-position-point)
4024           (gnus-configure-windows 'summary 'force)
4025           (gnus-set-mode-line 'summary))
4026         (when (and gnus-auto-center-group
4027                    (get-buffer-window gnus-group-buffer t))
4028           ;; Gotta use windows, because recenter does weird stuff if
4029           ;; the current buffer ain't the displayed window.
4030           (let ((owin (selected-window)))
4031             (select-window (get-buffer-window gnus-group-buffer t))
4032             (when (gnus-group-goto-group group)
4033               (recenter))
4034             (select-window owin)))
4035         ;; Mark this buffer as "prepared".
4036         (setq gnus-newsgroup-prepared t)
4037         (gnus-run-hooks 'gnus-summary-prepared-hook)
4038         (unless (gnus-ephemeral-group-p group)
4039           (gnus-group-update-group group))
4040         t)))))
4041
4042 (defun gnus-summary-auto-select-subject ()
4043   "Select the subject line on initial group entry."
4044   (goto-char (point-min))
4045   (cond
4046    ((eq gnus-auto-select-subject 'best)
4047     (gnus-summary-best-unread-subject))
4048    ((eq gnus-auto-select-subject 'unread)
4049     (gnus-summary-first-unread-subject))
4050    ((eq gnus-auto-select-subject 'unseen)
4051     (gnus-summary-first-unseen-subject))
4052    ((eq gnus-auto-select-subject 'unseen-or-unread)
4053     (gnus-summary-first-unseen-or-unread-subject))
4054    ((eq gnus-auto-select-subject 'first)
4055     ;; Do nothing.
4056     )
4057    ((functionp gnus-auto-select-subject)
4058     (funcall gnus-auto-select-subject))))
4059
4060 (defun gnus-summary-prepare ()
4061   "Generate the summary buffer."
4062   (interactive)
4063   (let ((inhibit-read-only t))
4064     (erase-buffer)
4065     (setq gnus-newsgroup-data nil
4066           gnus-newsgroup-data-reverse nil)
4067     (gnus-run-hooks 'gnus-summary-generate-hook)
4068     ;; Generate the buffer, either with threads or without.
4069     (when gnus-newsgroup-headers
4070       (gnus-summary-prepare-threads
4071        (if gnus-show-threads
4072            (gnus-sort-gathered-threads
4073             (funcall gnus-summary-thread-gathering-function
4074                      (gnus-sort-threads
4075                       (gnus-cut-threads (gnus-make-threads)))))
4076          ;; Unthreaded display.
4077          (gnus-sort-articles gnus-newsgroup-headers))))
4078     (setq gnus-newsgroup-data (nreverse gnus-newsgroup-data))
4079     ;; Call hooks for modifying summary buffer.
4080     (goto-char (point-min))
4081     (gnus-run-hooks 'gnus-summary-prepare-hook)))
4082
4083 (defsubst gnus-general-simplify-subject (subject)
4084   "Simplify subject by the same rules as `gnus-gather-threads-by-subject'."
4085   (setq subject
4086         (cond
4087          ;; Truncate the subject.
4088          (gnus-simplify-subject-functions
4089           (gnus-map-function gnus-simplify-subject-functions subject))
4090          ((numberp gnus-summary-gather-subject-limit)
4091           (setq subject (gnus-simplify-subject-re subject))
4092           (if (> (length subject) gnus-summary-gather-subject-limit)
4093               (substring subject 0 gnus-summary-gather-subject-limit)
4094             subject))
4095          ;; Fuzzily simplify it.
4096          ((eq 'fuzzy gnus-summary-gather-subject-limit)
4097           (gnus-simplify-subject-fuzzy subject))
4098          ;; Just remove the leading "Re:".
4099          (t
4100           (gnus-simplify-subject-re subject))))
4101
4102   (if (and gnus-summary-gather-exclude-subject
4103            (string-match gnus-summary-gather-exclude-subject subject))
4104       nil                         ; This article shouldn't be gathered
4105     subject))
4106
4107 (defun gnus-summary-simplify-subject-query ()
4108   "Query where the respool algorithm would put this article."
4109   (interactive)
4110   (gnus-summary-select-article)
4111   (message "%s" (gnus-general-simplify-subject (gnus-summary-article-subject))))
4112
4113 (defun gnus-gather-threads-by-subject (threads)
4114   "Gather threads by looking at Subject headers."
4115   (if (not gnus-summary-make-false-root)
4116       threads
4117     (let ((hashtb (gnus-make-hashtable 1024))
4118           (prev threads)
4119           (result threads)
4120           subject hthread whole-subject)
4121       (while threads
4122         (setq subject (gnus-general-simplify-subject
4123                        (setq whole-subject (mail-header-subject
4124                                             (caar threads)))))
4125         (when subject
4126           (if (setq hthread (gnus-gethash subject hashtb))
4127               (progn
4128                 ;; We enter a dummy root into the thread, if we
4129                 ;; haven't done that already.
4130                 (unless (stringp (caar hthread))
4131                   (setcar hthread (list whole-subject (car hthread))))
4132                 ;; We add this new gathered thread to this gathered
4133                 ;; thread.
4134                 (setcdr (car hthread)
4135                         (nconc (cdar hthread) (list (car threads))))
4136                 ;; Remove it from the list of threads.
4137                 (setcdr prev (cdr threads))
4138                 (setq threads prev))
4139             ;; Enter this thread into the hash table.
4140             (gnus-sethash subject
4141                           (if gnus-summary-make-false-root-always
4142                               (progn
4143                                 ;; If you want a dummy root above all
4144                                 ;; threads...
4145                                 (setcar threads (list whole-subject
4146                                                       (car threads)))
4147                                 threads)
4148                             threads)
4149                           hashtb)))
4150         (setq prev threads)
4151         (setq threads (cdr threads)))
4152       result)))
4153
4154 (defun gnus-gather-threads-by-references (threads)
4155   "Gather threads by looking at References headers."
4156   (let ((idhashtb (gnus-make-hashtable 1024))
4157         (thhashtb (gnus-make-hashtable 1024))
4158         (prev threads)
4159         (result threads)
4160         ids references id gthread gid entered ref)
4161     (while threads
4162       (when (setq references (mail-header-references (caar threads)))
4163         (setq id (mail-header-id (caar threads))
4164               ids (inline (gnus-split-references references))
4165               entered nil)
4166         (while (setq ref (pop ids))
4167           (setq ids (delete ref ids))
4168           (if (not (setq gid (gnus-gethash ref idhashtb)))
4169               (progn
4170                 (gnus-sethash ref id idhashtb)
4171                 (gnus-sethash id threads thhashtb))
4172             (setq gthread (gnus-gethash gid thhashtb))
4173             (unless entered
4174               ;; We enter a dummy root into the thread, if we
4175               ;; haven't done that already.
4176               (unless (stringp (caar gthread))
4177                 (setcar gthread (list (mail-header-subject (caar gthread))
4178                                       (car gthread))))
4179               ;; We add this new gathered thread to this gathered
4180               ;; thread.
4181               (setcdr (car gthread)
4182                       (nconc (cdar gthread) (list (car threads)))))
4183             ;; Add it into the thread hash table.
4184             (gnus-sethash id gthread thhashtb)
4185             (setq entered t)
4186             ;; Remove it from the list of threads.
4187             (setcdr prev (cdr threads))
4188             (setq threads prev))))
4189       (setq prev threads)
4190       (setq threads (cdr threads)))
4191     result))
4192
4193 (defun gnus-sort-gathered-threads (threads)
4194   "Sort subtreads inside each gathered thread by `gnus-sort-gathered-threads-function'."
4195   (let ((result threads))
4196     (while threads
4197       (when (stringp (caar threads))
4198         (setcdr (car threads)
4199                 (sort (cdar threads) gnus-sort-gathered-threads-function)))
4200       (setq threads (cdr threads)))
4201     result))
4202
4203 (defun gnus-thread-loop-p (root thread)
4204   "Say whether ROOT is in THREAD."
4205   (let ((stack (list thread))
4206         (infloop 0)
4207         th)
4208     (while (setq thread (pop stack))
4209       (setq th (cdr thread))
4210       (while (and th
4211                   (not (eq (caar th) root)))
4212         (pop th))
4213       (if th
4214           ;; We have found a loop.
4215           (let (ref-dep)
4216             (setcdr thread (delq (car th) (cdr thread)))
4217             (if (boundp (setq ref-dep (intern "none"
4218                                               gnus-newsgroup-dependencies)))
4219                 (setcdr (symbol-value ref-dep)
4220                         (nconc (cdr (symbol-value ref-dep))
4221                                (list (car th))))
4222               (set ref-dep (list nil (car th))))
4223             (setq infloop 1
4224                   stack nil))
4225         ;; Push all the subthreads onto the stack.
4226         (push (cdr thread) stack)))
4227     infloop))
4228
4229 (defun gnus-make-threads ()
4230   "Go through the dependency hashtb and find the roots.  Return all threads."
4231   (let (threads)
4232     (while (catch 'infloop
4233              (mapatoms
4234               (lambda (refs)
4235                 ;; Deal with self-referencing References loops.
4236                 (when (and (car (symbol-value refs))
4237                            (not (zerop
4238                                  (apply
4239                                   '+
4240                                   (mapcar
4241                                    (lambda (thread)
4242                                      (gnus-thread-loop-p
4243                                       (car (symbol-value refs)) thread))
4244                                    (cdr (symbol-value refs)))))))
4245                   (setq threads nil)
4246                   (throw 'infloop t))
4247                 (unless (car (symbol-value refs))
4248                   ;; These threads do not refer back to any other
4249                   ;; articles, so they're roots.
4250                   (setq threads (append (cdr (symbol-value refs)) threads))))
4251               gnus-newsgroup-dependencies)))
4252     threads))
4253
4254 ;; Build the thread tree.
4255 (defsubst gnus-dependencies-add-header (header dependencies force-new)
4256   "Enter HEADER into the DEPENDENCIES table if it is not already there.
4257
4258 If FORCE-NEW is not nil, enter HEADER into the DEPENDENCIES table even
4259 if it was already present.
4260
4261 If `gnus-summary-ignore-duplicates' is nil then duplicate Message-IDs
4262 will not be entered in the DEPENDENCIES table.  Otherwise duplicate
4263 Message-IDs will be renamed to a unique Message-ID before being
4264 entered.
4265
4266 Returns HEADER if it was entered in the DEPENDENCIES.  Returns nil otherwise."
4267   (let* ((id (mail-header-id header))
4268          (id-dep (and id (intern id dependencies)))
4269          parent-id ref ref-dep ref-header replaced)
4270     ;; Enter this `header' in the `dependencies' table.
4271     (cond
4272      ((not id-dep)
4273       (setq header nil))
4274      ;; The first two cases do the normal part: enter a new `header'
4275      ;; in the `dependencies' table.
4276      ((not (boundp id-dep))
4277       (set id-dep (list header)))
4278      ((null (car (symbol-value id-dep)))
4279       (setcar (symbol-value id-dep) header))
4280
4281      ;; From here the `header' was already present in the
4282      ;; `dependencies' table.
4283      (force-new
4284       ;; Overrides an existing entry;
4285       ;; just set the header part of the entry.
4286       (setcar (symbol-value id-dep) header)
4287       (setq replaced t))
4288
4289      ;; Renames the existing `header' to a unique Message-ID.
4290      ((not gnus-summary-ignore-duplicates)
4291       ;; An article with this Message-ID has already been seen.
4292       ;; We rename the Message-ID.
4293       (set (setq id-dep (intern (setq id (nnmail-message-id)) dependencies))
4294            (list header))
4295       (mail-header-set-id header id))
4296
4297      ;; The last case ignores an existing entry, except it adds any
4298      ;; additional Xrefs (in case the two articles came from different
4299      ;; servers.
4300      ;; Also sets `header' to `nil' meaning that the `dependencies'
4301      ;; table was *not* modified.
4302      (t
4303       (mail-header-set-xref
4304        (car (symbol-value id-dep))
4305        (concat (or (mail-header-xref (car (symbol-value id-dep)))
4306                    "")
4307                (or (mail-header-xref header) "")))
4308       (setq header nil)))
4309
4310     (when (and header (not replaced))
4311       ;; First check that we are not creating a References loop.
4312       (setq parent-id (gnus-parent-id (mail-header-references header)))
4313       (setq ref parent-id)
4314       (while (and ref
4315                   (setq ref-dep (intern-soft ref dependencies))
4316                   (boundp ref-dep)
4317                   (setq ref-header (car (symbol-value ref-dep))))
4318         (if (string= id ref)
4319             ;; Yuk!  This is a reference loop.  Make the article be a
4320             ;; root article.
4321             (progn
4322               (mail-header-set-references (car (symbol-value id-dep)) "none")
4323               (setq ref nil)
4324               (setq parent-id nil))
4325           (setq ref (gnus-parent-id (mail-header-references ref-header)))))
4326       (setq ref-dep (intern (or parent-id "none") dependencies))
4327       (if (boundp ref-dep)
4328           (setcdr (symbol-value ref-dep)
4329                   (nconc (cdr (symbol-value ref-dep))
4330                          (list (symbol-value id-dep))))
4331         (set ref-dep (list nil (symbol-value id-dep)))))
4332     header))
4333
4334 (defun gnus-extract-message-id-from-in-reply-to (string)
4335   (if (string-match "<[^>]+>" string)
4336       (substring string (match-beginning 0) (match-end 0))
4337     nil))
4338
4339 (defun gnus-build-sparse-threads ()
4340   (let ((headers gnus-newsgroup-headers)
4341         (mail-parse-charset gnus-newsgroup-charset)
4342         (gnus-summary-ignore-duplicates t)
4343         header references generation relations
4344         subject child end new-child date)
4345     ;; First we create an alist of generations/relations, where
4346     ;; generations is how much we trust the relation, and the relation
4347     ;; is parent/child.
4348     (gnus-message 7 "Making sparse threads...")
4349     (save-excursion
4350       (nnheader-set-temp-buffer " *gnus sparse threads*")
4351       (while (setq header (pop headers))
4352         (when (and (setq references (mail-header-references header))
4353                    (not (string= references "")))
4354           (insert references)
4355           (setq child (mail-header-id header)
4356                 subject (mail-header-subject header)
4357                 date (mail-header-date header)
4358                 generation 0)
4359           (while (search-backward ">" nil t)
4360             (setq end (1+ (point)))
4361             (when (search-backward "<" nil t)
4362               (setq new-child (buffer-substring (point) end))
4363               (push (list (incf generation)
4364                           child (setq child new-child)
4365                           subject date)
4366                     relations)))
4367           (when child
4368             (push (list (1+ generation) child nil subject) relations))
4369           (erase-buffer)))
4370       (kill-buffer (current-buffer)))
4371     ;; Sort over trustworthiness.
4372     (dolist (relation (sort relations 'car-less-than-car))
4373       (when (gnus-dependencies-add-header
4374              (make-full-mail-header
4375               gnus-reffed-article-number
4376               (nth 3 relation) "" (or (nth 4 relation) "")
4377               (nth 1 relation)
4378               (or (nth 2 relation) "") 0 0 "")
4379              gnus-newsgroup-dependencies nil)
4380         (push gnus-reffed-article-number gnus-newsgroup-limit)
4381         (push gnus-reffed-article-number gnus-newsgroup-sparse)
4382         (push (cons gnus-reffed-article-number gnus-sparse-mark)
4383               gnus-newsgroup-reads)
4384         (decf gnus-reffed-article-number)))
4385     (gnus-message 7 "Making sparse threads...done")))
4386
4387 (defun gnus-build-old-threads ()
4388   ;; Look at all the articles that refer back to old articles, and
4389   ;; fetch the headers for the articles that aren't there.  This will
4390   ;; build complete threads - if the roots haven't been expired by the
4391   ;; server, that is.
4392   (let ((mail-parse-charset gnus-newsgroup-charset)
4393         id heads)
4394     (mapatoms
4395      (lambda (refs)
4396        (when (not (car (symbol-value refs)))
4397          (setq heads (cdr (symbol-value refs)))
4398          (while heads
4399            (if (memq (mail-header-number (caar heads))
4400                      gnus-newsgroup-dormant)
4401                (setq heads (cdr heads))
4402              (setq id (symbol-name refs))
4403              (while (and (setq id (gnus-build-get-header id))
4404                          (not (car (gnus-id-to-thread id)))))
4405              (setq heads nil)))))
4406      gnus-newsgroup-dependencies)))
4407
4408 (defsubst gnus-remove-odd-characters (string)
4409   "Translate STRING into something that doesn't contain weird characters."
4410   (mm-subst-char-in-string
4411    ?\r ?\-
4412    (mm-subst-char-in-string ?\n ?\- string t) t))
4413
4414 ;; This function has to be called with point after the article number
4415 ;; on the beginning of the line.
4416 (defsubst gnus-nov-parse-line (number dependencies &optional force-new)
4417   (let ((eol (point-at-eol))
4418         (buffer (current-buffer))
4419         header references in-reply-to)
4420
4421     ;; overview: [num subject from date id refs chars lines misc]
4422     (unwind-protect
4423         (let (x)
4424           (narrow-to-region (point) eol)
4425           (unless (eobp)
4426             (forward-char))
4427
4428           (setq header
4429                 (make-full-mail-header
4430                  number                 ; number
4431                  (condition-case ()     ; subject
4432                      (gnus-remove-odd-characters
4433                       (funcall gnus-decode-encoded-word-function
4434                                (setq x (nnheader-nov-field))))
4435                    (error x))
4436                  (condition-case ()     ; from
4437                      (gnus-remove-odd-characters
4438                       (funcall gnus-decode-encoded-address-function
4439                                (setq x (nnheader-nov-field))))
4440                    (error x))
4441                  (nnheader-nov-field)   ; date
4442                  (nnheader-nov-read-message-id number)  ; id
4443                  (setq references (nnheader-nov-field)) ; refs
4444                  (nnheader-nov-read-integer) ; chars
4445                  (nnheader-nov-read-integer) ; lines
4446                  (unless (eobp)
4447                    (if (looking-at "Xref: ")
4448                        (goto-char (match-end 0)))
4449                    (nnheader-nov-field)) ; Xref
4450                  (nnheader-nov-parse-extra)))) ; extra
4451
4452       (widen))
4453
4454     (when (and (string= references "")
4455                (setq in-reply-to (mail-header-extra header))
4456                (setq in-reply-to (cdr (assq 'In-Reply-To in-reply-to))))
4457       (mail-header-set-references
4458        header (gnus-extract-message-id-from-in-reply-to in-reply-to)))
4459
4460     (when gnus-alter-header-function
4461       (funcall gnus-alter-header-function header))
4462     (gnus-dependencies-add-header header dependencies force-new)))
4463
4464 (defun gnus-build-get-header (id)
4465   "Look through the buffer of NOV lines and find the header to ID.
4466 Enter this line into the dependencies hash table, and return
4467 the id of the parent article (if any)."
4468   (let ((deps gnus-newsgroup-dependencies)
4469         found header)
4470     (prog1
4471         (with-current-buffer nntp-server-buffer
4472           (let ((case-fold-search nil))
4473             (goto-char (point-min))
4474             (while (and (not found)
4475                         (search-forward id nil t))
4476               (beginning-of-line)
4477               (setq found (looking-at
4478                            (format "^[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t%s"
4479                                    (regexp-quote id))))
4480               (or found (beginning-of-line 2)))
4481             (when found
4482               (beginning-of-line)
4483               (and
4484                (setq header (gnus-nov-parse-line
4485                              (read (current-buffer)) deps))
4486                (gnus-parent-id (mail-header-references header))))))
4487       (when header
4488         (let ((number (mail-header-number header)))
4489           (push number gnus-newsgroup-limit)
4490           (push header gnus-newsgroup-headers)
4491           (if (memq number gnus-newsgroup-unselected)
4492               (progn
4493                 (setq gnus-newsgroup-unreads
4494                       (gnus-add-to-sorted-list gnus-newsgroup-unreads
4495                                                number))
4496                 (setq gnus-newsgroup-unselected
4497                       (delq number gnus-newsgroup-unselected)))
4498             (push number gnus-newsgroup-ancient)))))))
4499
4500 (defun gnus-build-all-threads ()
4501   "Read all the headers."
4502   (let ((gnus-summary-ignore-duplicates t)
4503         (mail-parse-charset gnus-newsgroup-charset)
4504         (dependencies gnus-newsgroup-dependencies)
4505         header article)
4506     (with-current-buffer nntp-server-buffer
4507       (let ((case-fold-search nil))
4508         (goto-char (point-min))
4509         (while (not (eobp))
4510           (ignore-errors
4511             (setq article (read (current-buffer))
4512                   header (gnus-nov-parse-line article dependencies)))
4513           (when header
4514             (with-current-buffer gnus-summary-buffer
4515               (push header gnus-newsgroup-headers)
4516               (if (memq (setq article (mail-header-number header))
4517                         gnus-newsgroup-unselected)
4518                   (progn
4519                     (setq gnus-newsgroup-unreads
4520                           (gnus-add-to-sorted-list
4521                            gnus-newsgroup-unreads article))
4522                     (setq gnus-newsgroup-unselected
4523                           (delq article gnus-newsgroup-unselected)))
4524                 (push article gnus-newsgroup-ancient)))
4525             (forward-line 1)))))))
4526
4527 (defun gnus-summary-update-article-line (article header)
4528   "Update the line for ARTICLE using HEADER."
4529   (let* ((id (mail-header-id header))
4530          (thread (gnus-id-to-thread id)))
4531     (unless thread
4532       (error "Article in no thread"))
4533     ;; Update the thread.
4534     (setcar thread header)
4535     (gnus-summary-goto-subject article)
4536     (let* ((datal (gnus-data-find-list article))
4537            (data (car datal))
4538            (inhibit-read-only t)
4539            (level (gnus-summary-thread-level)))
4540       (gnus-delete-line)
4541       (let ((inserted (- (point)
4542                          (progn
4543                            (gnus-summary-insert-line
4544                             header level nil
4545                             (memq article gnus-newsgroup-undownloaded)
4546                             (gnus-article-mark article)
4547                             (memq article gnus-newsgroup-replied)
4548                             (memq article gnus-newsgroup-expirable)
4549                             ;; Only insert the Subject string when it's different
4550                             ;; from the previous Subject string.
4551                             (if (and
4552                                  gnus-show-threads
4553                                  (gnus-subject-equal
4554                                   (condition-case ()
4555                                       (mail-header-subject
4556                                        (gnus-data-header
4557                                         (cadr
4558                                          (gnus-data-find-list
4559                                           article
4560                                           (gnus-data-list t)))))
4561                                     ;; Error on the side of excessive subjects.
4562                                     (error ""))
4563                                   (mail-header-subject header)))
4564                                 ""
4565                               (mail-header-subject header))
4566                             nil (cdr (assq article gnus-newsgroup-scored))
4567                             (memq article gnus-newsgroup-processable))
4568                            (point)))))
4569         (when (cdr datal)
4570           (gnus-data-update-list
4571            (cdr datal)
4572            (- (gnus-data-pos data) (gnus-data-pos (cadr datal)) inserted)))))))
4573
4574 (defun gnus-summary-update-article (article &optional iheader)
4575   "Update ARTICLE in the summary buffer."
4576   (set-buffer gnus-summary-buffer)
4577   (let* ((header (gnus-summary-article-header article))
4578          (id (mail-header-id header))
4579          (data (gnus-data-find article))
4580          (thread (gnus-id-to-thread id))
4581          (references (mail-header-references header))
4582          (parent
4583           (gnus-id-to-thread
4584            (or (gnus-parent-id
4585                 (when (and references
4586                            (not (equal "" references)))
4587                   references))
4588                "none")))
4589          (inhibit-read-only t)
4590          (old (car thread)))
4591     (when thread
4592       (unless iheader
4593         (setcar thread nil)
4594         (when parent
4595           (delq thread parent)))
4596       (if (gnus-summary-insert-subject id header)
4597           ;; Set the (possibly) new article number in the data structure.
4598           (gnus-data-set-number data (gnus-id-to-article id))
4599         (setcar thread old)
4600         nil))))
4601
4602 (defun gnus-rebuild-thread (id &optional line)
4603   "Rebuild the thread containing ID.
4604 If LINE, insert the rebuilt thread starting on line LINE."
4605   (let ((inhibit-read-only t)
4606         old-pos current thread data)
4607     (if (not gnus-show-threads)
4608         (setq thread (list (car (gnus-id-to-thread id))))
4609       ;; Get the thread this article is part of.
4610       (setq thread (gnus-remove-thread id)))
4611     (setq old-pos (point-at-bol))
4612     (setq current (save-excursion
4613                     (and (re-search-backward "[\r\n]" nil t)
4614                          (gnus-summary-article-number))))
4615     ;; If this is a gathered thread, we have to go some re-gathering.
4616     (when (stringp (car thread))
4617       (let ((subject (car thread))
4618             roots thr)
4619         (setq thread (cdr thread))
4620         (while thread
4621           (unless (memq (setq thr (gnus-id-to-thread
4622                                    (gnus-root-id
4623                                     (mail-header-id (caar thread)))))
4624                         roots)
4625             (push thr roots))
4626           (setq thread (cdr thread)))
4627         ;; We now have all (unique) roots.
4628         (if (= (length roots) 1)
4629             ;; All the loose roots are now one solid root.
4630             (setq thread (car roots))
4631           (setq thread (cons subject (gnus-sort-threads roots))))))
4632     (let (threads)
4633       ;; We then insert this thread into the summary buffer.
4634       (when line
4635         (goto-char (point-min))
4636         (forward-line (1- line)))
4637       (let (gnus-newsgroup-data gnus-newsgroup-threads)
4638         (if gnus-show-threads
4639             (gnus-summary-prepare-threads (gnus-cut-threads (list thread)))
4640           (gnus-summary-prepare-unthreaded thread))
4641         (setq data (nreverse gnus-newsgroup-data))
4642         (setq threads gnus-newsgroup-threads))
4643       ;; We splice the new data into the data structure.
4644       ;;!!! This is kinda bogus.  We assume that in LINE is non-nil,
4645       ;;!!! then we want to insert at the beginning of the buffer.
4646       ;;!!! That happens to be true with Gnus now, but that may
4647       ;;!!! change in the future.  Perhaps.
4648       (gnus-data-enter-list
4649        (if line nil current) data (- (point) old-pos))
4650       (setq gnus-newsgroup-threads
4651             (nconc threads gnus-newsgroup-threads))
4652       (gnus-data-compute-positions))))
4653
4654 (defun gnus-number-to-header (number)
4655   "Return the header for article NUMBER."
4656   (let ((headers gnus-newsgroup-headers))
4657     (while (and headers
4658                 (not (= number (mail-header-number (car headers)))))
4659       (pop headers))
4660     (when headers
4661       (car headers))))
4662
4663 (defun gnus-parent-headers (in-headers &optional generation)
4664   "Return the headers of the GENERATIONeth parent of HEADERS."
4665   (unless generation
4666     (setq generation 1))
4667   (let ((parent t)
4668         (headers in-headers)
4669         references)
4670     (while (and parent
4671                 (not (zerop generation))
4672                 (setq references (mail-header-references headers)))
4673       (setq headers (if (and references
4674                              (setq parent (gnus-parent-id references)))
4675                         (car (gnus-id-to-thread parent))
4676                       nil))
4677       (decf generation))
4678     (and (not (eq headers in-headers))
4679          headers)))
4680
4681 (defun gnus-id-to-thread (id)
4682   "Return the (sub-)thread where ID appears."
4683   (gnus-gethash id gnus-newsgroup-dependencies))
4684
4685 (defun gnus-id-to-article (id)
4686   "Return the article number of ID."
4687   (let ((thread (gnus-id-to-thread id)))
4688     (when (and thread
4689                (car thread))
4690       (mail-header-number (car thread)))))
4691
4692 (defun gnus-id-to-header (id)
4693   "Return the article headers of ID."
4694   (car (gnus-id-to-thread id)))
4695
4696 (defun gnus-article-displayed-root-p (article)
4697   "Say whether ARTICLE is a root(ish) article."
4698   (let ((level (gnus-summary-thread-level article))
4699         (refs (mail-header-references  (gnus-summary-article-header article)))
4700         particle)
4701     (cond
4702      ((null level) nil)
4703      ((zerop level) t)
4704      ((null refs) t)
4705      ((null (gnus-parent-id refs)) t)
4706      ((and (= 1 level)
4707            (null (setq particle (gnus-id-to-article
4708                                  (gnus-parent-id refs))))
4709            (null (gnus-summary-thread-level particle)))))))
4710
4711 (defun gnus-root-id (id)
4712   "Return the id of the root of the thread where ID appears."
4713   (let (last-id prev)
4714     (while (and id (setq prev (car (gnus-id-to-thread id))))
4715       (setq last-id id
4716             id (gnus-parent-id (mail-header-references prev))))
4717     last-id))
4718
4719 (defun gnus-articles-in-thread (thread)
4720   "Return the list of articles in THREAD."
4721   (cons (mail-header-number (car thread))
4722         (apply 'nconc (mapcar 'gnus-articles-in-thread (cdr thread)))))
4723
4724 (defun gnus-remove-thread (id &optional dont-remove)
4725   "Remove the thread that has ID in it."
4726   (let (headers thread last-id)
4727     ;; First go up in this thread until we find the root.
4728     (setq last-id (gnus-root-id id)
4729           headers (message-flatten-list (gnus-id-to-thread last-id)))
4730     ;; We have now found the real root of this thread.  It might have
4731     ;; been gathered into some loose thread, so we have to search
4732     ;; through the threads to find the thread we wanted.
4733     (let ((threads gnus-newsgroup-threads)
4734           sub)
4735       (while threads
4736         (setq sub (car threads))
4737         (if (stringp (car sub))
4738             ;; This is a gathered thread, so we look at the roots
4739             ;; below it to find whether this article is in this
4740             ;; gathered root.
4741             (progn
4742               (setq sub (cdr sub))
4743               (while sub
4744                 (when (member (caar sub) headers)
4745                   (setq thread (car threads)
4746                         threads nil
4747                         sub nil))
4748                 (setq sub (cdr sub))))
4749           ;; It's an ordinary thread, so we check it.
4750           (when (eq (car sub) (car headers))
4751             (setq thread sub
4752                   threads nil)))
4753         (setq threads (cdr threads)))
4754       ;; If this article is in no thread, then it's a root.
4755       (if thread
4756           (unless dont-remove
4757             (setq gnus-newsgroup-threads (delq thread gnus-newsgroup-threads)))
4758         (setq thread (gnus-id-to-thread last-id)))
4759       (when thread
4760         (prog1
4761             thread                      ; We return this thread.
4762           (unless dont-remove
4763             (if (stringp (car thread))
4764                 (progn
4765                   ;; If we use dummy roots, then we have to remove the
4766                   ;; dummy root as well.
4767                   (when (eq gnus-summary-make-false-root 'dummy)
4768                     ;; We go to the dummy root by going to
4769                     ;; the first sub-"thread", and then one line up.
4770                     (gnus-summary-goto-article
4771                      (mail-header-number (caadr thread)))
4772                     (forward-line -1)
4773                     (gnus-delete-line)
4774                     (gnus-data-compute-positions))
4775                   (setq thread (cdr thread))
4776                   (while thread
4777                     (gnus-remove-thread-1 (car thread))
4778                     (setq thread (cdr thread))))
4779               (gnus-remove-thread-1 thread))))))))
4780
4781 (defun gnus-remove-thread-1 (thread)
4782   "Remove the thread THREAD recursively."
4783   (let ((number (mail-header-number (pop thread)))
4784         d)
4785     (setq thread (reverse thread))
4786     (while thread
4787       (gnus-remove-thread-1 (pop thread)))
4788     (when (setq d (gnus-data-find number))
4789       (goto-char (gnus-data-pos d))
4790       (gnus-summary-show-thread)
4791       (gnus-data-remove
4792        number
4793        (- (point-at-bol)
4794           (prog1
4795               (1+ (point-at-eol))
4796             (gnus-delete-line)))))))
4797
4798 (defun gnus-sort-threads-recursive (threads func)
4799   (sort (mapcar (lambda (thread)
4800                   (cons (car thread)
4801                         (and (cdr thread)
4802                              (gnus-sort-threads-recursive (cdr thread) func))))
4803                 threads) func))
4804
4805 (defun gnus-sort-threads-loop (threads func)
4806   (let* ((superthread (cons nil threads))
4807          (stack (list (cons superthread threads)))
4808          remaining-threads thread)
4809     (while stack
4810       (setq remaining-threads (cdr (car stack)))
4811       (if remaining-threads
4812           (progn (setq thread (car remaining-threads))
4813                  (setcdr (car stack) (cdr remaining-threads))
4814                  (if (cdr thread)
4815                      (push (cons thread (cdr thread)) stack)))
4816         (setq thread (caar stack))
4817         (setcdr thread (sort (cdr thread) func))
4818         (pop stack)))
4819     (cdr superthread)))
4820
4821 (defun gnus-sort-threads (threads)
4822   "Sort THREADS."
4823   (if (not gnus-thread-sort-functions)
4824       threads
4825     (gnus-message 8 "Sorting threads...")
4826     (prog1
4827         (condition-case nil
4828             (let ((max-lisp-eval-depth (max max-lisp-eval-depth 5000)))
4829               (gnus-sort-threads-recursive
4830                threads (gnus-make-sort-function gnus-thread-sort-functions)))
4831           ;; Even after binding max-lisp-eval-depth, the recursive
4832           ;; sorter might fail for very long threads.  In that case,
4833           ;; try using a (less well-tested) non-recursive sorter.
4834           (error (gnus-message 9 "Sorting threads with loop...")
4835                  (gnus-sort-threads-loop
4836                   threads (gnus-make-sort-function
4837                            gnus-thread-sort-functions))))
4838       (gnus-message 8 "Sorting threads...done"))))
4839
4840 (defun gnus-sort-articles (articles)
4841   "Sort ARTICLES."
4842   (when gnus-article-sort-functions
4843     (gnus-message 7 "Sorting articles...")
4844     (prog1
4845         (setq gnus-newsgroup-headers
4846               (sort articles (gnus-make-sort-function
4847                               gnus-article-sort-functions)))
4848       (gnus-message 7 "Sorting articles...done"))))
4849
4850 ;; Written by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
4851 (defmacro gnus-thread-header (thread)
4852   "Return header of first article in THREAD.
4853 Note that THREAD must never, ever be anything else than a variable -
4854 using some other form will lead to serious barfage."
4855   (or (symbolp thread) (signal 'wrong-type-argument '(symbolp thread)))
4856   ;; (8% speedup to gnus-summary-prepare, just for fun :-)
4857   (list 'byte-code "\10\211:\203\17\0\211@;\203\16\0A@@\207"
4858         (vector thread) 2))
4859
4860 (defsubst gnus-article-sort-by-number (h1 h2)
4861   "Sort articles by article number."
4862   (< (mail-header-number h1)
4863      (mail-header-number h2)))
4864
4865 (defun gnus-thread-sort-by-number (h1 h2)
4866   "Sort threads by root article number."
4867   (gnus-article-sort-by-number
4868    (gnus-thread-header h1) (gnus-thread-header h2)))
4869
4870 (defsubst gnus-article-sort-by-random (h1 h2)
4871   "Sort articles randomly."
4872   (zerop (random 2)))
4873
4874 (defun gnus-thread-sort-by-random (h1 h2)
4875   "Sort threads randomly."
4876   (gnus-article-sort-by-random
4877    (gnus-thread-header h1) (gnus-thread-header h2)))
4878
4879 (defsubst gnus-article-sort-by-lines (h1 h2)
4880   "Sort articles by article Lines header."
4881   (< (mail-header-lines h1)
4882      (mail-header-lines h2)))
4883
4884 (defun gnus-thread-sort-by-lines (h1 h2)
4885   "Sort threads by root article Lines header."
4886   (gnus-article-sort-by-lines
4887    (gnus-thread-header h1) (gnus-thread-header h2)))
4888
4889 (defsubst gnus-article-sort-by-chars (h1 h2)
4890   "Sort articles by octet length."
4891   (< (mail-header-chars h1)
4892      (mail-header-chars h2)))
4893
4894 (defun gnus-thread-sort-by-chars (h1 h2)
4895   "Sort threads by root article octet length."
4896   (gnus-article-sort-by-chars
4897    (gnus-thread-header h1) (gnus-thread-header h2)))
4898
4899 (defsubst gnus-article-sort-by-author (h1 h2)
4900   "Sort articles by root author."
4901   (gnus-string<
4902    (let ((extract (funcall
4903                    gnus-extract-address-components
4904                    (mail-header-from h1))))
4905      (or (car extract) (cadr extract) ""))
4906    (let ((extract (funcall
4907                    gnus-extract-address-components
4908                    (mail-header-from h2))))
4909      (or (car extract) (cadr extract) ""))))
4910
4911 (defun gnus-thread-sort-by-author (h1 h2)
4912   "Sort threads by root author."
4913   (gnus-article-sort-by-author
4914    (gnus-thread-header h1)  (gnus-thread-header h2)))
4915
4916 (defsubst gnus-article-sort-by-recipient (h1 h2)
4917   "Sort articles by recipient."
4918   (gnus-string<
4919    (let ((extract (funcall
4920                    gnus-extract-address-components
4921                    (or (cdr (assq 'To (mail-header-extra h1))) ""))))
4922      (or (car extract) (cadr extract)))
4923    (let ((extract (funcall
4924                    gnus-extract-address-components
4925                    (or (cdr (assq 'To (mail-header-extra h2))) ""))))
4926      (or (car extract) (cadr extract)))))
4927
4928 (defun gnus-thread-sort-by-recipient (h1 h2)
4929   "Sort threads by root recipient."
4930   (gnus-article-sort-by-recipient
4931    (gnus-thread-header h1) (gnus-thread-header h2)))
4932
4933 (defsubst gnus-article-sort-by-subject (h1 h2)
4934   "Sort articles by root subject."
4935   (gnus-string<
4936    (downcase (gnus-simplify-subject-re (mail-header-subject h1)))
4937    (downcase (gnus-simplify-subject-re (mail-header-subject h2)))))
4938
4939 (defun gnus-thread-sort-by-subject (h1 h2)
4940   "Sort threads by root subject."
4941   (gnus-article-sort-by-subject
4942    (gnus-thread-header h1) (gnus-thread-header h2)))
4943
4944 (defsubst gnus-article-sort-by-date (h1 h2)
4945   "Sort articles by root article date."
4946   (time-less-p
4947    (gnus-date-get-time (mail-header-date h1))
4948    (gnus-date-get-time (mail-header-date h2))))
4949
4950 (defun gnus-thread-sort-by-date (h1 h2)
4951   "Sort threads by root article date."
4952   (gnus-article-sort-by-date
4953    (gnus-thread-header h1) (gnus-thread-header h2)))
4954
4955 (defsubst gnus-article-sort-by-score (h1 h2)
4956   "Sort articles by root article score.
4957 Unscored articles will be counted as having a score of zero."
4958   (> (or (cdr (assq (mail-header-number h1)
4959                     gnus-newsgroup-scored))
4960          gnus-summary-default-score 0)
4961      (or (cdr (assq (mail-header-number h2)
4962                     gnus-newsgroup-scored))
4963          gnus-summary-default-score 0)))
4964
4965 (defun gnus-thread-sort-by-score (h1 h2)
4966   "Sort threads by root article score."
4967   (gnus-article-sort-by-score
4968    (gnus-thread-header h1) (gnus-thread-header h2)))
4969
4970 (defun gnus-thread-sort-by-total-score (h1 h2)
4971   "Sort threads by the sum of all scores in the thread.
4972 Unscored articles will be counted as having a score of zero."
4973   (> (gnus-thread-total-score h1) (gnus-thread-total-score h2)))
4974
4975 (defun gnus-thread-total-score (thread)
4976   ;; This function find the total score of THREAD.
4977   (cond
4978    ((null thread)
4979     0)
4980    ((consp thread)
4981     (if (stringp (car thread))
4982         (apply gnus-thread-score-function 0
4983                (mapcar 'gnus-thread-total-score-1 (cdr thread)))
4984       (gnus-thread-total-score-1 thread)))
4985    (t
4986     (gnus-thread-total-score-1 (list thread)))))
4987
4988 (defun gnus-thread-sort-by-most-recent-number (h1 h2)
4989   "Sort threads such that the thread with the most recently arrived article comes first."
4990   (> (gnus-thread-highest-number h1) (gnus-thread-highest-number h2)))
4991
4992 (defun gnus-thread-highest-number (thread)
4993   "Return the highest article number in THREAD."
4994   (apply 'max (mapcar (lambda (header)
4995                         (mail-header-number header))
4996                       (message-flatten-list thread))))
4997
4998 (defun gnus-thread-sort-by-most-recent-date (h1 h2)
4999   "Sort threads such that the thread with the most recently dated article comes first."
5000   (> (gnus-thread-latest-date h1) (gnus-thread-latest-date h2)))
5001
5002 ; Since this is called not only to sort the top-level threads, but
5003 ; also in recursive sorts to order the articles within a thread, each
5004 ; article will be processed many times.  Thus it speeds things up
5005 ; quite a bit to use gnus-date-get-time, which caches the time value.
5006 (defun gnus-thread-latest-date (thread)
5007   "Return the highest article date in THREAD."
5008   (apply 'max
5009          (mapcar (lambda (header) (gnus-float-time
5010                                    (gnus-date-get-time
5011                                     (mail-header-date header))))
5012                  (message-flatten-list thread))))
5013
5014 (defun gnus-thread-total-score-1 (root)
5015   ;; This function find the total score of the thread below ROOT.
5016   (setq root (car root))
5017   (apply gnus-thread-score-function
5018          (or (append
5019               (mapcar 'gnus-thread-total-score
5020                       (cdr (gnus-id-to-thread (mail-header-id root))))
5021               (when (> (mail-header-number root) 0)
5022                 (list (or (cdr (assq (mail-header-number root)
5023                                      gnus-newsgroup-scored))
5024                           gnus-summary-default-score 0))))
5025              (list gnus-summary-default-score)
5026              '(0))))
5027
5028 ;; Added by Per Abrahamsen <amanda@iesd.auc.dk>.
5029 (defvar gnus-tmp-prev-subject nil)
5030 (defvar gnus-tmp-false-parent nil)
5031 (defvar gnus-tmp-root-expunged nil)
5032 (defvar gnus-tmp-dummy-line nil)
5033
5034 (defun gnus-extra-header (type &optional header)
5035   "Return the extra header of TYPE."
5036   (or (cdr (assq type (mail-header-extra (or header gnus-tmp-header))))
5037       ""))
5038
5039 (defvar gnus-tmp-thread-tree-header-string "")
5040
5041 (defcustom gnus-sum-thread-tree-root "> "
5042   "With %B spec, used for the root of a thread.
5043 If nil, use subject instead."
5044   :version "22.1"
5045   :type '(radio (const :format "%v  " nil) string)
5046   :group 'gnus-thread)
5047
5048 (defcustom gnus-sum-thread-tree-false-root "> "
5049   "With %B spec, used for a false root of a thread.
5050 If nil, use subject instead."
5051   :version "22.1"
5052   :type '(radio (const :format "%v  " nil) string)
5053   :group 'gnus-thread)
5054
5055 (defcustom gnus-sum-thread-tree-single-indent ""
5056   "With %B spec, used for a thread with just one message.
5057 If nil, use subject instead."
5058   :version "22.1"
5059   :type '(radio (const :format "%v  " nil) string)
5060   :group 'gnus-thread)
5061
5062 (defcustom gnus-sum-thread-tree-vertical "| "
5063   "With %B spec, used for drawing a vertical line."
5064   :version "22.1"
5065   :type 'string
5066   :group 'gnus-thread)
5067
5068 (defcustom gnus-sum-thread-tree-indent "  "
5069   "With %B spec, used for indenting."
5070   :version "22.1"
5071   :type 'string
5072   :group 'gnus-thread)
5073
5074 (defcustom gnus-sum-thread-tree-leaf-with-other "+-> "
5075   "With %B spec, used for a leaf with brothers."
5076   :version "22.1"
5077   :type 'string
5078   :group 'gnus-thread)
5079
5080 (defcustom gnus-sum-thread-tree-single-leaf "\\-> "
5081   "With %B spec, used for a leaf without brothers."
5082   :version "22.1"
5083   :type 'string
5084   :group 'gnus-thread)
5085
5086 (defcustom gnus-summary-display-while-building nil
5087   "If non-nil, show and update the summary buffer as it's being built.
5088 If the value is t, update the buffer after every line is inserted.  If
5089 the value is an integer (N), update the display every N lines."
5090   :version "22.1"
5091   :group 'gnus-thread
5092   :type '(choice (const :tag "off" nil)
5093                  number
5094                  (const :tag "frequently" t)))
5095
5096 (defun gnus-summary-prepare-threads (threads)
5097   "Prepare summary buffer from THREADS and indentation LEVEL.
5098 THREADS is either a list of `(PARENT [(CHILD1 [(GRANDCHILD ...]...) ...])'
5099 or a straight list of headers."
5100   (gnus-message 7 "Generating summary...")
5101
5102   (setq gnus-newsgroup-threads threads)
5103   (beginning-of-line)
5104
5105   (let ((gnus-tmp-level 0)
5106         (default-score (or gnus-summary-default-score 0))
5107         (gnus-visual-p (gnus-visual-p 'summary-highlight 'highlight))
5108         (building-line-count gnus-summary-display-while-building)
5109         (building-count (integerp gnus-summary-display-while-building))
5110         thread number subject stack state gnus-tmp-gathered beg-match
5111         new-roots gnus-tmp-new-adopts thread-end simp-subject
5112         gnus-tmp-header gnus-tmp-unread gnus-tmp-downloaded
5113         gnus-tmp-replied gnus-tmp-subject-or-nil
5114         gnus-tmp-dummy gnus-tmp-indentation gnus-tmp-lines gnus-tmp-score
5115         gnus-tmp-score-char gnus-tmp-from gnus-tmp-name
5116         gnus-tmp-number gnus-tmp-opening-bracket gnus-tmp-closing-bracket
5117         tree-stack)
5118
5119     (setq gnus-tmp-prev-subject nil
5120           gnus-tmp-thread-tree-header-string "")
5121
5122     (if (vectorp (car threads))
5123         ;; If this is a straight (sic) list of headers, then a
5124         ;; threaded summary display isn't required, so we just create
5125         ;; an unthreaded one.
5126         (gnus-summary-prepare-unthreaded threads)
5127
5128       ;; Do the threaded display.
5129
5130       (if gnus-summary-display-while-building
5131           (switch-to-buffer (buffer-name)))
5132       (while (or threads stack gnus-tmp-new-adopts new-roots)
5133
5134         (if (and (= gnus-tmp-level 0)
5135                  (or (not stack)
5136                      (= (caar stack) 0))
5137                  (not gnus-tmp-false-parent)
5138                  (or gnus-tmp-new-adopts new-roots))
5139             (if gnus-tmp-new-adopts
5140                 (setq gnus-tmp-level (if gnus-tmp-root-expunged 0 1)
5141                       thread (list (car gnus-tmp-new-adopts))
5142                       gnus-tmp-header (caar thread)
5143                       gnus-tmp-new-adopts (cdr gnus-tmp-new-adopts))
5144               (when new-roots
5145                 (setq thread (list (car new-roots))
5146                       gnus-tmp-header (caar thread)
5147                       new-roots (cdr new-roots))))
5148
5149           (if threads
5150               ;; If there are some threads, we do them before the
5151               ;; threads on the stack.
5152               (setq thread threads
5153                     gnus-tmp-header (caar thread))
5154             ;; There were no current threads, so we pop something off
5155             ;; the stack.
5156             (setq state (car stack)
5157                   gnus-tmp-level (car state)
5158                   tree-stack (cadr state)
5159                   thread (caddr state)
5160                   stack (cdr stack)
5161                   gnus-tmp-header (caar thread))))
5162
5163         (setq gnus-tmp-false-parent nil)
5164         (setq gnus-tmp-root-expunged nil)
5165         (setq thread-end nil)
5166
5167         (if (stringp gnus-tmp-header)
5168             ;; The header is a dummy root.
5169             (cond
5170              ((eq gnus-summary-make-false-root 'adopt)
5171               ;; We let the first article adopt the rest.
5172               (setq gnus-tmp-new-adopts (nconc gnus-tmp-new-adopts
5173                                                (cddar thread)))
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 thread (cons (list (caar thread)
5180                                        (cadar thread))
5181                                  (cdr thread)))
5182               (setq gnus-tmp-level -1
5183                     gnus-tmp-false-parent t))
5184              ((eq gnus-summary-make-false-root 'empty)
5185               ;; We print adopted articles with empty subject fields.
5186               (setq gnus-tmp-gathered
5187                     (nconc (mapcar
5188                             (lambda (h) (mail-header-number (car h)))
5189                             (cddar thread))
5190                            gnus-tmp-gathered))
5191               (setq gnus-tmp-level -1))
5192              ((eq gnus-summary-make-false-root 'dummy)
5193               ;; We remember that we probably want to output a dummy
5194               ;; root.
5195               (setq gnus-tmp-dummy-line gnus-tmp-header)
5196               (setq gnus-tmp-prev-subject gnus-tmp-header))
5197              (t
5198               ;; We do not make a root for the gathered
5199               ;; sub-threads at all.
5200               (setq gnus-tmp-level -1)))
5201
5202           (setq number (mail-header-number gnus-tmp-header)
5203                 subject (mail-header-subject gnus-tmp-header)
5204                 simp-subject (gnus-simplify-subject-fully subject))
5205
5206           (cond
5207            ;; If the thread has changed subject, we might want to make
5208            ;; this subthread into a root.
5209            ((and (null gnus-thread-ignore-subject)
5210                  (not (zerop gnus-tmp-level))
5211                  gnus-tmp-prev-subject
5212                  (not (string= gnus-tmp-prev-subject simp-subject)))
5213             (setq new-roots (nconc new-roots (list (car thread)))
5214                   thread-end t
5215                   gnus-tmp-header nil))
5216            ;; If the article lies outside the current limit,
5217            ;; then we do not display it.
5218            ((not (memq number gnus-newsgroup-limit))
5219             (setq gnus-tmp-gathered
5220                   (nconc (mapcar
5221                           (lambda (h) (mail-header-number (car h)))
5222                           (cdar thread))
5223                          gnus-tmp-gathered))
5224             (setq gnus-tmp-new-adopts (if (cdar thread)
5225                                           (append gnus-tmp-new-adopts
5226                                                   (cdar thread))
5227                                         gnus-tmp-new-adopts)
5228                   thread-end t
5229                   gnus-tmp-header nil)
5230             (when (zerop gnus-tmp-level)
5231               (setq gnus-tmp-root-expunged t)))
5232            ;; Perhaps this article is to be marked as read?
5233            ((and gnus-summary-mark-below
5234                  (< (or (cdr (assq number gnus-newsgroup-scored))
5235                         default-score)
5236                     gnus-summary-mark-below)
5237                  ;; Don't touch sparse articles.
5238                  (not (gnus-summary-article-sparse-p number))
5239                  (not (gnus-summary-article-ancient-p number)))
5240             (setq gnus-newsgroup-unreads
5241                   (delq number gnus-newsgroup-unreads))
5242             (if gnus-newsgroup-auto-expire
5243                 (setq gnus-newsgroup-expirable
5244                       (gnus-add-to-sorted-list
5245                        gnus-newsgroup-expirable number))
5246               (push (cons number gnus-low-score-mark)
5247                     gnus-newsgroup-reads))))
5248
5249           (when gnus-tmp-header
5250             ;; We may have an old dummy line to output before this
5251             ;; article.
5252             (when (and gnus-tmp-dummy-line
5253                        (gnus-subject-equal
5254                         gnus-tmp-dummy-line
5255                         (mail-header-subject gnus-tmp-header)))
5256               (gnus-summary-insert-dummy-line
5257                gnus-tmp-dummy-line (mail-header-number gnus-tmp-header))
5258               (setq gnus-tmp-dummy-line nil))
5259
5260             ;; Compute the mark.
5261             (setq gnus-tmp-unread (gnus-article-mark number))
5262
5263             (push (gnus-data-make number gnus-tmp-unread (1+ (point))
5264                                   gnus-tmp-header gnus-tmp-level)
5265                   gnus-newsgroup-data)
5266
5267             ;; Actually insert the line.
5268             (setq
5269              gnus-tmp-subject-or-nil
5270              (cond
5271               ((and gnus-thread-ignore-subject
5272                     gnus-tmp-prev-subject
5273                     (not (string= gnus-tmp-prev-subject simp-subject)))
5274                subject)
5275               ((zerop gnus-tmp-level)
5276                (if (and (eq gnus-summary-make-false-root 'empty)
5277                         (memq number gnus-tmp-gathered)
5278                         gnus-tmp-prev-subject
5279                         (string= gnus-tmp-prev-subject simp-subject))
5280                    gnus-summary-same-subject
5281                  subject))
5282               (t gnus-summary-same-subject)))
5283             (if (and (eq gnus-summary-make-false-root 'adopt)
5284                      (= gnus-tmp-level 1)
5285                      (memq number gnus-tmp-gathered))
5286                 (setq gnus-tmp-opening-bracket ?\<
5287                       gnus-tmp-closing-bracket ?\>)
5288               (setq gnus-tmp-opening-bracket ?\[
5289                     gnus-tmp-closing-bracket ?\]))
5290             (if (>= gnus-tmp-level (length gnus-thread-indent-array))
5291                 (gnus-make-thread-indent-array
5292                  (max (* 2 (length gnus-thread-indent-array))
5293                       gnus-tmp-level)))
5294             (setq
5295              gnus-tmp-indentation
5296              (aref gnus-thread-indent-array gnus-tmp-level)
5297              gnus-tmp-lines (mail-header-lines gnus-tmp-header)
5298              gnus-tmp-score (or (cdr (assq number gnus-newsgroup-scored))
5299                                 gnus-summary-default-score 0)
5300              gnus-tmp-score-char
5301              (if (or (null gnus-summary-default-score)
5302                      (<= (abs (- gnus-tmp-score gnus-summary-default-score))
5303                          gnus-summary-zcore-fuzz))
5304                  ?                      ;Whitespace
5305                (if (< gnus-tmp-score gnus-summary-default-score)
5306                    gnus-score-below-mark gnus-score-over-mark))
5307              gnus-tmp-replied
5308              (cond ((memq number gnus-newsgroup-processable)
5309                     gnus-process-mark)
5310                    ((memq number gnus-newsgroup-cached)
5311                     gnus-cached-mark)
5312                    ((memq number gnus-newsgroup-replied)
5313                     gnus-replied-mark)
5314                    ((memq number gnus-newsgroup-forwarded)
5315                     gnus-forwarded-mark)
5316                    ((memq number gnus-newsgroup-saved)
5317                     gnus-saved-mark)
5318                    ((memq number gnus-newsgroup-recent)
5319                     gnus-recent-mark)
5320                    ((memq number gnus-newsgroup-unseen)
5321                     gnus-unseen-mark)
5322                    (t gnus-no-mark))
5323              gnus-tmp-downloaded
5324              (cond ((memq number gnus-newsgroup-undownloaded)
5325                     gnus-undownloaded-mark)
5326                    (gnus-newsgroup-agentized
5327                     gnus-downloaded-mark)
5328                    (t
5329                     gnus-no-mark))
5330              gnus-tmp-from (mail-header-from gnus-tmp-header)
5331              gnus-tmp-name
5332              (cond
5333               ((string-match "<[^>]+> *$" gnus-tmp-from)
5334                (setq beg-match (match-beginning 0))
5335                (or (and (string-match "^\".+\"" gnus-tmp-from)
5336                         (substring gnus-tmp-from 1 (1- (match-end 0))))
5337                    (substring gnus-tmp-from 0 beg-match)))
5338               ((string-match "(.+)" gnus-tmp-from)
5339                (substring gnus-tmp-from
5340                           (1+ (match-beginning 0)) (1- (match-end 0))))
5341               (t gnus-tmp-from))
5342
5343              ;; Do the %B string
5344              gnus-tmp-thread-tree-header-string
5345              (cond
5346               ((not gnus-show-threads) "")
5347               ((zerop gnus-tmp-level)
5348                (cond ((cdar thread)
5349                       (or gnus-sum-thread-tree-root subject))
5350                      (gnus-tmp-new-adopts
5351                       (or gnus-sum-thread-tree-false-root subject))
5352                      (t
5353                       (or gnus-sum-thread-tree-single-indent subject))))
5354               (t
5355                (concat (apply 'concat
5356                               (mapcar (lambda (item)
5357                                         (if (= item 1)
5358                                             gnus-sum-thread-tree-vertical
5359                                           gnus-sum-thread-tree-indent))
5360                                       (cdr (reverse tree-stack))))
5361                        (if (nth 1 thread)
5362                            gnus-sum-thread-tree-leaf-with-other
5363                          gnus-sum-thread-tree-single-leaf)))))
5364             (when (string= gnus-tmp-name "")
5365               (setq gnus-tmp-name gnus-tmp-from))
5366             (unless (numberp gnus-tmp-lines)
5367               (setq gnus-tmp-lines -1))
5368             (if (= gnus-tmp-lines -1)
5369                 (setq gnus-tmp-lines "?")
5370               (setq gnus-tmp-lines (number-to-string gnus-tmp-lines)))
5371             (gnus-put-text-property
5372              (point)
5373              (progn (eval gnus-summary-line-format-spec) (point))
5374              'gnus-number number)
5375             (when gnus-visual-p
5376               (forward-line -1)
5377               (gnus-summary-highlight-line)
5378               (when gnus-summary-update-hook
5379                 (gnus-run-hooks 'gnus-summary-update-hook))
5380               (forward-line 1))
5381
5382             (setq gnus-tmp-prev-subject simp-subject)))
5383
5384         (when (nth 1 thread)
5385           (push (list (max 0 gnus-tmp-level)
5386                       (copy-sequence tree-stack)
5387                       (nthcdr 1 thread))
5388                 stack))
5389         (push (if (nth 1 thread) 1 0) tree-stack)
5390         (incf gnus-tmp-level)
5391         (setq threads (if thread-end nil (cdar thread)))
5392         (if gnus-summary-display-while-building
5393             (if building-count
5394                 (progn
5395                   ;; use a set frequency
5396                   (setq building-line-count (1- building-line-count))
5397                   (when (= building-line-count 0)
5398                     (sit-for 0)
5399                     (setq building-line-count
5400                           gnus-summary-display-while-building)))
5401               ;; always
5402               (sit-for 0)))
5403         (unless threads
5404           (setq gnus-tmp-level 0)))))
5405   (gnus-message 7 "Generating summary...done"))
5406
5407 (defun gnus-summary-prepare-unthreaded (headers)
5408   "Generate an unthreaded summary buffer based on HEADERS."
5409   (let (header number mark)
5410
5411     (beginning-of-line)
5412
5413     (while headers
5414       ;; We may have to root out some bad articles...
5415       (when (memq (setq number (mail-header-number
5416                                 (setq header (pop headers))))
5417                   gnus-newsgroup-limit)
5418         ;; Mark article as read when it has a low score.
5419         (when (and gnus-summary-mark-below
5420                    (< (or (cdr (assq number gnus-newsgroup-scored))
5421                           gnus-summary-default-score 0)
5422                       gnus-summary-mark-below)
5423                    (not (gnus-summary-article-ancient-p number)))
5424           (setq gnus-newsgroup-unreads
5425                 (delq number gnus-newsgroup-unreads))
5426           (if gnus-newsgroup-auto-expire
5427               (push number gnus-newsgroup-expirable)
5428             (push (cons number gnus-low-score-mark)
5429                   gnus-newsgroup-reads)))
5430
5431         (setq mark (gnus-article-mark number))
5432         (push (gnus-data-make number mark (1+ (point)) header 0)
5433               gnus-newsgroup-data)
5434         (gnus-summary-insert-line
5435          header 0 number
5436          (memq number gnus-newsgroup-undownloaded)
5437          mark (memq number gnus-newsgroup-replied)
5438          (memq number gnus-newsgroup-expirable)
5439          (mail-header-subject header) nil
5440          (cdr (assq number gnus-newsgroup-scored))
5441          (memq number gnus-newsgroup-processable))))))
5442
5443 (defun gnus-summary-remove-list-identifiers ()
5444   "Remove list identifiers in `gnus-list-identifiers' from articles in the current group."
5445   (let ((regexp (if (consp gnus-list-identifiers)
5446                     (mapconcat 'identity gnus-list-identifiers " *\\|")
5447                   gnus-list-identifiers))
5448         changed subject)
5449     (when regexp
5450       (setq regexp (concat "^\\(?:R[Ee]: +\\)*\\(" regexp " *\\)"))
5451       (dolist (header gnus-newsgroup-headers)
5452         (setq subject (mail-header-subject header)
5453               changed nil)
5454         (while (string-match regexp subject)
5455           (setq subject
5456                 (concat (substring subject 0 (match-beginning 1))
5457                         (substring subject (match-end 0)))
5458                 changed t))
5459         (when changed
5460           (when (string-match "^\\(\\(?:R[Ee]: +\\)+\\)R[Ee]: +" subject)
5461             (setq subject
5462                   (concat (substring subject 0 (match-beginning 1))
5463                           (substring subject (match-end 1)))))
5464           (mail-header-set-subject header subject))))))
5465
5466 (defun gnus-fetch-headers (articles)
5467   "Fetch headers of ARTICLES."
5468   (let ((name (gnus-group-decoded-name gnus-newsgroup-name)))
5469     (gnus-message 5 "Fetching headers for %s..." name)
5470     (prog1
5471         (if (eq 'nov
5472                 (setq gnus-headers-retrieved-by
5473                       (gnus-retrieve-headers
5474                        articles gnus-newsgroup-name
5475                        ;; We might want to fetch old headers, but
5476                        ;; not if there is only 1 article.
5477                        (and (or (and
5478                                  (not (eq gnus-fetch-old-headers 'some))
5479                                  (not (numberp gnus-fetch-old-headers)))
5480                                 (> (length articles) 1))
5481                             gnus-fetch-old-headers))))
5482             (gnus-get-newsgroup-headers-xover
5483              articles nil nil gnus-newsgroup-name t)
5484           (gnus-get-newsgroup-headers))
5485       (gnus-message 5 "Fetching headers for %s...done" name))))
5486
5487 (defun gnus-select-newsgroup (group &optional read-all select-articles)
5488   "Select newsgroup GROUP.
5489 If READ-ALL is non-nil, all articles in the group are selected.
5490 If SELECT-ARTICLES, only select those articles from GROUP."
5491   (let* ((entry (gnus-group-entry group))
5492          ;;!!! Dirty hack; should be removed.
5493          (gnus-summary-ignore-duplicates
5494           (if (eq (car (gnus-find-method-for-group group)) 'nnvirtual)
5495               t
5496             gnus-summary-ignore-duplicates))
5497          (info (nth 2 entry))
5498          charset articles fetched-articles cached)
5499
5500     (unless (gnus-check-server
5501              (set (make-local-variable 'gnus-current-select-method)
5502                   (gnus-find-method-for-group group)))
5503       (error "Couldn't open server"))
5504     (setq charset (gnus-group-name-charset gnus-current-select-method group))
5505
5506     (or (and entry (not (eq (car entry) t))) ; Either it's active...
5507         (gnus-activate-group group)     ; Or we can activate it...
5508         (progn                          ; Or we bug out.
5509           (when (equal major-mode 'gnus-summary-mode)
5510             (gnus-kill-buffer (current-buffer)))
5511           (error
5512            "Couldn't activate group %s: %s"
5513            (mm-decode-coding-string group charset)
5514            (mm-decode-coding-string (gnus-status-message group) charset))))
5515
5516     (unless (gnus-request-group group t)
5517       (when (equal major-mode 'gnus-summary-mode)
5518         (gnus-kill-buffer (current-buffer)))
5519       (error "Couldn't request group %s: %s"
5520              (mm-decode-coding-string group charset)
5521              (mm-decode-coding-string (gnus-status-message group) charset)))
5522
5523     (when gnus-agent
5524       (gnus-agent-possibly-alter-active group (gnus-active group) info)
5525
5526       (setq gnus-summary-use-undownloaded-faces
5527             (gnus-agent-find-parameter
5528              group
5529              'agent-enable-undownloaded-faces)))
5530
5531     (setq gnus-newsgroup-name group
5532           gnus-newsgroup-unselected nil
5533           gnus-newsgroup-unreads (gnus-list-of-unread-articles group))
5534
5535     (let ((display (gnus-group-find-parameter group 'display)))
5536       (setq gnus-newsgroup-display
5537             (cond
5538              ((not (zerop (or (car-safe read-all) 0)))
5539               ;; The user entered the group with C-u SPC/RET, let's show
5540               ;; all articles.
5541               'gnus-not-ignore)
5542              ((eq display 'all)
5543               'gnus-not-ignore)
5544              ((arrayp display)
5545               (gnus-summary-display-make-predicate (mapcar 'identity display)))
5546              ((numberp display)
5547               ;; The following is probably the "correct" solution, but
5548               ;; it makes Gnus fetch all headers and then limit the
5549               ;; articles (which is slow), so instead we hack the
5550               ;; select-articles parameter instead. -- Simon Josefsson
5551               ;; <jas@kth.se>
5552               ;;
5553               ;; (gnus-byte-compile
5554               ;;  `(lambda () (> number ,(- (cdr (gnus-active group))
5555               ;;                         display)))))
5556               (setq select-articles
5557                     (gnus-uncompress-range
5558                      (cons (let ((tmp (- (cdr (gnus-active group)) display)))
5559                              (if (> tmp 0)
5560                                  tmp
5561                                1))
5562                            (cdr (gnus-active group)))))
5563               nil)
5564              (t
5565               nil))))
5566
5567     (gnus-summary-setup-default-charset)
5568
5569     ;; Kludge to avoid having cached articles nixed out in virtual groups.
5570     (when (gnus-virtual-group-p group)
5571       (setq cached gnus-newsgroup-cached))
5572
5573     (setq gnus-newsgroup-unreads
5574           (gnus-sorted-ndifference
5575            (gnus-sorted-ndifference gnus-newsgroup-unreads
5576                                     gnus-newsgroup-marked)
5577            gnus-newsgroup-dormant))
5578
5579     (setq gnus-newsgroup-processable nil)
5580
5581     (gnus-update-read-articles group gnus-newsgroup-unreads)
5582
5583     ;; Adjust and set lists of article marks.
5584     (when info
5585       (gnus-adjust-marked-articles info))
5586     (if (setq articles select-articles)
5587         (setq gnus-newsgroup-unselected
5588               (gnus-sorted-difference gnus-newsgroup-unreads articles))
5589       (setq articles (gnus-articles-to-read group read-all)))
5590
5591     (cond
5592      ((null articles)
5593       ;;(gnus-message 3 "Couldn't select newsgroup -- no articles to display")
5594       'quit)
5595      ((eq articles 0) nil)
5596      (t
5597       ;; Init the dependencies hash table.
5598       (setq gnus-newsgroup-dependencies
5599             (gnus-make-hashtable (length articles)))
5600       (gnus-set-global-variables)
5601       ;; Retrieve the headers and read them in.
5602
5603       (setq gnus-newsgroup-headers (gnus-fetch-headers articles))
5604
5605       ;; Kludge to avoid having cached articles nixed out in virtual groups.
5606       (when cached
5607         (setq gnus-newsgroup-cached cached))
5608
5609       ;; Suppress duplicates?
5610       (when gnus-suppress-duplicates
5611         (gnus-dup-suppress-articles))
5612
5613       ;; Set the initial limit.
5614       (setq gnus-newsgroup-limit (copy-sequence articles))
5615       ;; Remove canceled articles from the list of unread articles.
5616       (setq fetched-articles
5617             (mapcar (lambda (headers) (mail-header-number headers))
5618                     gnus-newsgroup-headers))
5619       (setq gnus-newsgroup-articles fetched-articles)
5620       (setq gnus-newsgroup-unreads
5621             (gnus-sorted-nintersection
5622              gnus-newsgroup-unreads fetched-articles))
5623       (gnus-compute-unseen-list)
5624
5625       ;; Removed marked articles that do not exist.
5626       (gnus-update-missing-marks
5627        (gnus-sorted-difference articles fetched-articles))
5628       ;; We might want to build some more threads first.
5629       (when (and gnus-fetch-old-headers
5630                  (eq gnus-headers-retrieved-by 'nov))
5631         (if (eq gnus-fetch-old-headers 'invisible)
5632             (gnus-build-all-threads)
5633           (gnus-build-old-threads)))
5634       ;; Let the Gnus agent mark articles as read.
5635       (when gnus-agent
5636         (gnus-agent-get-undownloaded-list))
5637       ;; Remove list identifiers from subject
5638       (when gnus-list-identifiers
5639         (gnus-summary-remove-list-identifiers))
5640       ;; Check whether auto-expire is to be done in this group.
5641       (setq gnus-newsgroup-auto-expire
5642             (gnus-group-auto-expirable-p group))
5643       ;; Set up the article buffer now, if necessary.
5644       (unless (and gnus-single-article-buffer
5645                    (equal gnus-article-buffer "*Article*"))
5646         (gnus-article-setup-buffer))
5647       ;; First and last article in this newsgroup.
5648       (when gnus-newsgroup-headers
5649         (setq gnus-newsgroup-begin
5650               (mail-header-number (car gnus-newsgroup-headers))
5651               gnus-newsgroup-end
5652               (mail-header-number
5653                (gnus-last-element gnus-newsgroup-headers))))
5654       ;; GROUP is successfully selected.
5655       (or gnus-newsgroup-headers t)))))
5656
5657 (defun gnus-compute-unseen-list ()
5658   ;; The `seen' marks are treated specially.
5659   (if (not gnus-newsgroup-seen)
5660       (setq gnus-newsgroup-unseen gnus-newsgroup-articles)
5661     (setq gnus-newsgroup-unseen
5662           (gnus-inverse-list-range-intersection
5663            gnus-newsgroup-articles gnus-newsgroup-seen))))
5664
5665 (declare-function gnus-get-predicate "gnus-agent" (predicate))
5666
5667 (defun gnus-summary-display-make-predicate (display)
5668   (require 'gnus-agent)
5669   (when (= (length display) 1)
5670     (setq display (car display)))
5671   (unless gnus-summary-display-cache
5672     (dolist (elem (append '((unread . unread)
5673                             (read . read)
5674                             (unseen . unseen))
5675                           gnus-article-mark-lists))
5676       (push (cons (cdr elem)
5677                   (gnus-byte-compile
5678                    `(lambda () (gnus-article-marked-p ',(cdr elem)))))
5679             gnus-summary-display-cache)))
5680   (let ((gnus-category-predicate-alist gnus-summary-display-cache)
5681         (gnus-category-predicate-cache gnus-summary-display-cache))
5682     (gnus-get-predicate display)))
5683
5684 ;; Uses the dynamically bound `number' variable.
5685 (defvar number)
5686 (defun gnus-article-marked-p (type &optional article)
5687   (let ((article (or article number)))
5688     (cond
5689      ((eq type 'tick)
5690       (memq article gnus-newsgroup-marked))
5691      ((eq type 'spam)
5692       (memq article gnus-newsgroup-spam-marked))
5693      ((eq type 'unsend)
5694       (memq article gnus-newsgroup-unsendable))
5695      ((eq type 'undownload)
5696       (memq article gnus-newsgroup-undownloaded))
5697      ((eq type 'download)
5698       (memq article gnus-newsgroup-downloadable))
5699      ((eq type 'unread)
5700       (memq article gnus-newsgroup-unreads))
5701      ((eq type 'read)
5702       (memq article gnus-newsgroup-reads))
5703      ((eq type 'dormant)
5704       (memq article gnus-newsgroup-dormant) )
5705      ((eq type 'expire)
5706       (memq article gnus-newsgroup-expirable))
5707      ((eq type 'reply)
5708       (memq article gnus-newsgroup-replied))
5709      ((eq type 'killed)
5710       (memq article gnus-newsgroup-killed))
5711      ((eq type 'bookmark)
5712       (assq article gnus-newsgroup-bookmarks))
5713      ((eq type 'score)
5714       (assq article gnus-newsgroup-scored))
5715      ((eq type 'save)
5716       (memq article gnus-newsgroup-saved))
5717      ((eq type 'cache)
5718       (memq article gnus-newsgroup-cached))
5719      ((eq type 'forward)
5720       (memq article gnus-newsgroup-forwarded))
5721      ((eq type 'seen)
5722       (not (memq article gnus-newsgroup-unseen)))
5723      ((eq type 'recent)
5724       (memq article gnus-newsgroup-recent))
5725      (t t))))
5726
5727 (defun gnus-articles-to-read (group &optional read-all)
5728   "Find out what articles the user wants to read."
5729   (let* ((articles
5730           ;; Select all articles if `read-all' is non-nil, or if there
5731           ;; are no unread articles.
5732           (if (or read-all
5733                   (and (zerop (length gnus-newsgroup-marked))
5734                        (zerop (length gnus-newsgroup-unreads)))
5735                   ;; Fetch all if the predicate is non-nil.
5736                   gnus-newsgroup-display)
5737               ;; We want to select the headers for all the articles in
5738               ;; the group, so we select either all the active
5739               ;; articles in the group, or (if that's nil), the
5740               ;; articles in the cache.
5741               (or
5742                (if gnus-newsgroup-maximum-articles
5743                    (let ((active (gnus-active group)))
5744                      (gnus-uncompress-range
5745                       (cons (max (car active)
5746                                  (- (cdr active)
5747                                     gnus-newsgroup-maximum-articles
5748                                     -1))
5749                             (cdr active))))
5750                  (gnus-uncompress-range (gnus-active group)))
5751                (gnus-cache-articles-in-group group))
5752             ;; Select only the "normal" subset of articles.
5753             (gnus-sorted-nunion
5754              (gnus-sorted-union gnus-newsgroup-dormant gnus-newsgroup-marked)
5755              gnus-newsgroup-unreads)))
5756          (scored-list (gnus-killed-articles gnus-newsgroup-killed articles))
5757          (scored (length scored-list))
5758          (number (length articles))
5759          (marked (+ (length gnus-newsgroup-marked)
5760                     (length gnus-newsgroup-dormant)))
5761          (select
5762           (cond
5763            ((numberp read-all)
5764             read-all)
5765            ((numberp gnus-newsgroup-display)
5766             gnus-newsgroup-display)
5767            (t
5768             (condition-case ()
5769                 (cond
5770                  ((and (or (<= scored marked) (= scored number))
5771                        (numberp gnus-large-newsgroup)
5772                        (> number gnus-large-newsgroup))
5773                   (let* ((cursor-in-echo-area nil)
5774                          (initial (gnus-parameter-large-newsgroup-initial
5775                                    gnus-newsgroup-name))
5776                          (input
5777                           (read-string
5778                            (format
5779                             "How many articles from %s (%s %d): "
5780                             (gnus-group-decoded-name gnus-newsgroup-name)
5781                             (if initial "max" "default")
5782                             number)
5783                            (if initial
5784                                (cons (number-to-string initial)
5785                                      0)))))
5786                     (if (string-match "^[ \t]*$" input) number input)))
5787                  ((and (> scored marked) (< scored number)
5788                        (> (- scored number) 20))
5789                   (let ((input
5790                          (read-string
5791                           (format "%s %s (%d scored, %d total): "
5792                                   "How many articles from"
5793                                   (gnus-group-decoded-name group)
5794                                   scored number))))
5795                     (if (string-match "^[ \t]*$" input)
5796                         number input)))
5797                  (t number))
5798               (quit
5799                (message "Quit getting the articles to read")
5800                nil))))))
5801     (setq select (if (stringp select) (string-to-number select) select))
5802     (if (or (null select) (zerop select))
5803         select
5804       (if (and (not (zerop scored)) (<= (abs select) scored))
5805           (progn
5806             (setq articles (sort scored-list '<))
5807             (setq number (length articles)))
5808         (setq articles (copy-sequence articles)))
5809
5810       (when (< (abs select) number)
5811         (if (< select 0)
5812             ;; Select the N oldest articles.
5813             (setcdr (nthcdr (1- (abs select)) articles) nil)
5814           ;; Select the N most recent articles.
5815           (setq articles (nthcdr (- number select) articles))))
5816       (setq gnus-newsgroup-unselected
5817             (gnus-sorted-difference gnus-newsgroup-unreads articles))
5818       (when gnus-alter-articles-to-read-function
5819         (setq articles
5820               (sort
5821                (funcall gnus-alter-articles-to-read-function
5822                         gnus-newsgroup-name articles)
5823                '<)))
5824       articles)))
5825
5826 (defun gnus-killed-articles (killed articles)
5827   (let (out)
5828     (while articles
5829       (when (inline (gnus-member-of-range (car articles) killed))
5830         (push (car articles) out))
5831       (setq articles (cdr articles)))
5832     out))
5833
5834 (defun gnus-uncompress-marks (marks)
5835   "Uncompress the mark ranges in MARKS."
5836   (let ((uncompressed '(score bookmark))
5837         out)
5838     (while marks
5839       (if (memq (caar marks) uncompressed)
5840           (push (car marks) out)
5841         (push (cons (caar marks) (gnus-uncompress-range (cdar marks))) out))
5842       (setq marks (cdr marks)))
5843     out))
5844
5845 (defun gnus-article-mark-to-type (mark)
5846   "Return the type of MARK."
5847   (or (cadr (assq mark gnus-article-special-mark-lists))
5848       'list))
5849
5850 (defun gnus-article-unpropagatable-p (mark)
5851   "Return whether MARK should be propagated to back end."
5852   (memq mark gnus-article-unpropagated-mark-lists))
5853
5854 (defun gnus-adjust-marked-articles (info)
5855   "Set all article lists and remove all marks that are no longer valid."
5856   (let* ((marked-lists (gnus-info-marks info))
5857          (active (gnus-active (gnus-info-group info)))
5858          (min (car active))
5859          (max (cdr active))
5860          (types gnus-article-mark-lists)
5861          marks var articles article mark mark-type
5862          bgn end)
5863     ;; Hack to avoid adjusting marks for imap.
5864     (when (eq (car (gnus-find-method-for-group (gnus-info-group info)))
5865               'nnimap)
5866       (setq min 1))
5867
5868     (dolist (marks marked-lists)
5869       (setq mark (car marks)
5870             mark-type (gnus-article-mark-to-type mark)
5871             var (intern (format "gnus-newsgroup-%s" (car (rassq mark types)))))
5872
5873       ;; We set the variable according to the type of the marks list,
5874       ;; and then adjust the marks to a subset of the active articles.
5875       (cond
5876        ;; Adjust "simple" lists - compressed yet unsorted
5877        ((eq mark-type 'list)
5878         ;; Simultaneously uncompress and clip to active range
5879         ;; See gnus-uncompress-range for a description of possible marks
5880         (let (l lh)
5881           (if (not (cadr marks))
5882               (set var nil)
5883             (setq articles (if (numberp (cddr marks))
5884                                (list (cdr marks))
5885                              (cdr marks))
5886                   lh (cons nil nil)
5887                   l lh)
5888
5889             (while (setq article (pop articles))
5890               (cond ((consp article)
5891                      (setq bgn (max (car article) min)
5892                            end (min (cdr article) max))
5893                      (while (<= bgn end)
5894                        (setq l (setcdr l (cons bgn nil))
5895                              bgn (1+ bgn))))
5896                     ((and (<= min article)
5897                           (>= max article))
5898                      (setq l (setcdr l (cons article nil))))))
5899             (set var (cdr lh)))))
5900        ;; Adjust assocs.
5901        ((eq mark-type 'tuple)
5902         (set var (setq articles (cdr marks)))
5903         (when (not (listp (cdr (symbol-value var))))
5904           (set var (list (symbol-value var))))
5905         (when (not (listp (cdr articles)))
5906           (setq articles (list articles)))
5907         (while articles
5908           (when (or (not (consp (setq article (pop articles))))
5909                     (< (car article) min)
5910                     (> (car article) max))
5911             (set var (delq article (symbol-value var))))))
5912        ;; Adjust ranges (sloppily).
5913        ((eq mark-type 'range)
5914         (cond
5915          ((eq mark 'seen)
5916           ;; Fix the record for `seen' if it looks like (seen NUM1 . NUM2).
5917           ;; It should be (seen (NUM1 . NUM2)).
5918           (when (numberp (cddr marks))
5919             (setcdr marks (list (cdr marks))))
5920           (setq articles (cdr marks))
5921           (while (and articles
5922                       (or (and (consp (car articles))
5923                                (> min (cdar articles)))
5924                           (and (numberp (car articles))
5925                                (> min (car articles)))))
5926             (pop articles))
5927           (set var articles))))))))
5928
5929 (defun gnus-update-missing-marks (missing)
5930   "Go through the list of MISSING articles and remove them from the mark lists."
5931   (when missing
5932     (let (var m)
5933       ;; Go through all types.
5934       (dolist (elem gnus-article-mark-lists)
5935         (when (eq (gnus-article-mark-to-type (cdr elem)) 'list)
5936           (setq var (intern (format "gnus-newsgroup-%s" (car elem))))
5937           (when (symbol-value var)
5938             ;; This list has articles.  So we delete all missing
5939             ;; articles from it.
5940             (setq m missing)
5941             (while m
5942               (set var (delq (pop m) (symbol-value var))))))))))
5943
5944 (defun gnus-update-marks ()
5945   "Enter the various lists of marked articles into the newsgroup info list."
5946   (let ((types gnus-article-mark-lists)
5947         (info (gnus-get-info gnus-newsgroup-name))
5948         type list newmarked symbol delta-marks)
5949     (when info
5950       ;; Add all marks lists to the list of marks lists.
5951       (while (setq type (pop types))
5952         (setq list (symbol-value
5953                     (setq symbol
5954                           (intern (format "gnus-newsgroup-%s" (car type))))))
5955
5956         (when list
5957           ;; Get rid of the entries of the articles that have the
5958           ;; default score.
5959           (when (and (eq (cdr type) 'score)
5960                      gnus-save-score
5961                      list)
5962             (let* ((arts list)
5963                    (prev (cons nil list))
5964                    (all prev))
5965               (while arts
5966                 (if (or (not (consp (car arts)))
5967                         (= (cdar arts) gnus-summary-default-score))
5968                     (setcdr prev (cdr arts))
5969                   (setq prev arts))
5970                 (setq arts (cdr arts)))
5971               (setq list (cdr all)))))
5972
5973         (when (eq (cdr type) 'seen)
5974           (setq list (gnus-range-add list gnus-newsgroup-unseen)))
5975
5976         (when (eq (gnus-article-mark-to-type (cdr type)) 'list)
5977           (setq list (gnus-compress-sequence (set symbol (sort list '<)) t)))
5978
5979         (when (and (gnus-check-backend-function
5980                     'request-set-mark gnus-newsgroup-name)
5981                    (not (gnus-article-unpropagatable-p (cdr type))))
5982           (let* ((old (cdr (assq (cdr type) (gnus-info-marks info))))
5983                  (del (gnus-remove-from-range (gnus-copy-sequence old) list))
5984                  (add (gnus-remove-from-range
5985                        (gnus-copy-sequence list) old)))
5986             (when add
5987               (push (list add 'add (list (cdr type))) delta-marks))
5988             (when del
5989               ;; Don't delete marks from outside the active range.  This
5990               ;; shouldn't happen, but is a sanity check.
5991               (setq del (gnus-sorted-range-intersection
5992                          (gnus-active gnus-newsgroup-name) del))
5993               (push (list del 'del (list (cdr type))) delta-marks))))
5994
5995         (when list
5996           (push (cons (cdr type) list) newmarked)))
5997
5998       (when delta-marks
5999         (unless (gnus-check-group gnus-newsgroup-name)
6000           (error "Can't open server for %s" gnus-newsgroup-name))
6001         (gnus-request-set-mark gnus-newsgroup-name delta-marks))
6002
6003       ;; Enter these new marks into the info of the group.
6004       (if (nthcdr 3 info)
6005           (setcar (nthcdr 3 info) newmarked)
6006         ;; Add the marks lists to the end of the info.
6007         (when newmarked
6008           (setcdr (nthcdr 2 info) (list newmarked))))
6009
6010       ;; Cut off the end of the info if there's nothing else there.
6011       (let ((i 5))
6012         (while (and (> i 2)
6013                     (not (nth i info)))
6014           (when (nthcdr (decf i) info)
6015             (setcdr (nthcdr i info) nil)))))))
6016
6017 (defun gnus-set-mode-line (where)
6018   "Set the mode line of the article or summary buffers.
6019 If WHERE is `summary', the summary mode line format will be used."
6020   ;; Is this mode line one we keep updated?
6021   (when (and (memq where gnus-updated-mode-lines)
6022              (symbol-value
6023               (intern (format "gnus-%s-mode-line-format-spec" where))))
6024     (let (mode-string)
6025       ;; We evaluate this in the summary buffer since these
6026       ;; variables are buffer-local to that buffer.
6027       (with-current-buffer gnus-summary-buffer
6028         ;; We bind all these variables that are used in the `eval' form
6029         ;; below.
6030         (let* ((mformat (symbol-value
6031                          (intern
6032                           (format "gnus-%s-mode-line-format-spec" where))))
6033                (gnus-tmp-group-name (gnus-mode-string-quote
6034                                      (gnus-group-decoded-name
6035                                       gnus-newsgroup-name)))
6036                (gnus-tmp-article-number (or gnus-current-article 0))
6037                (gnus-tmp-unread gnus-newsgroup-unreads)
6038                (gnus-tmp-unread-and-unticked (length gnus-newsgroup-unreads))
6039                (gnus-tmp-unselected (length gnus-newsgroup-unselected))
6040                (gnus-tmp-unread-and-unselected
6041                 (cond ((and (zerop gnus-tmp-unread-and-unticked)
6042                             (zerop gnus-tmp-unselected))
6043                        "")
6044                       ((zerop gnus-tmp-unselected)
6045                        (format "{%d more}" gnus-tmp-unread-and-unticked))
6046                       (t (format "{%d(+%d) more}"
6047                                  gnus-tmp-unread-and-unticked
6048                                  gnus-tmp-unselected))))
6049                (gnus-tmp-subject
6050                 (if (and gnus-current-headers
6051                          (vectorp gnus-current-headers))
6052                     (gnus-mode-string-quote
6053                      (mail-header-subject gnus-current-headers))
6054                   ""))
6055                bufname-length max-len
6056                gnus-tmp-header) ;; passed as argument to any user-format-funcs
6057           (setq mode-string (eval mformat))
6058           (setq bufname-length (if (string-match "%b" mode-string)
6059                                    (- (length
6060                                        (buffer-name
6061                                         (if (eq where 'summary)
6062                                             nil
6063                                           (get-buffer gnus-article-buffer))))
6064                                       2)
6065                                  0))
6066           (setq max-len (max 4 (if gnus-mode-non-string-length
6067                                    (- (window-width)
6068                                       gnus-mode-non-string-length
6069                                       bufname-length)
6070                                  (length mode-string))))
6071           ;; We might have to chop a bit of the string off...
6072           (when (> (length mode-string) max-len)
6073             (setq mode-string
6074                   (concat (truncate-string-to-width mode-string (- max-len 3))
6075                           "...")))))
6076       ;; Update the mode line.
6077       (setq mode-line-buffer-identification
6078             (gnus-mode-line-buffer-identification (list mode-string)))
6079       (set-buffer-modified-p t))))
6080
6081 (defun gnus-create-xref-hashtb (from-newsgroup headers unreads)
6082   "Go through the HEADERS list and add all Xrefs to a hash table.
6083 The resulting hash table is returned, or nil if no Xrefs were found."
6084   (let* ((virtual (gnus-virtual-group-p from-newsgroup))
6085          (prefix (if virtual "" (gnus-group-real-prefix from-newsgroup)))
6086          (xref-hashtb (gnus-make-hashtable))
6087          start group entry number xrefs header)
6088     (while headers
6089       (setq header (pop headers))
6090       (when (and (setq xrefs (mail-header-xref header))
6091                  (not (memq (setq number (mail-header-number header))
6092                             unreads)))
6093         (setq start 0)
6094         (while (string-match "\\([^ ]+\\)[:/]\\([0-9]+\\)" xrefs start)
6095           (setq start (match-end 0))
6096           (setq group (if prefix
6097                           (concat prefix (substring xrefs (match-beginning 1)
6098                                                     (match-end 1)))
6099                         (substring xrefs (match-beginning 1) (match-end 1))))
6100           (setq number
6101                 (string-to-number (substring xrefs (match-beginning 2)
6102                                           (match-end 2))))
6103           (if (setq entry (gnus-gethash group xref-hashtb))
6104               (setcdr entry (cons number (cdr entry)))
6105             (gnus-sethash group (cons number nil) xref-hashtb)))))
6106     (and start xref-hashtb)))
6107
6108 (defun gnus-mark-xrefs-as-read (from-newsgroup headers unreads)
6109   "Look through all the headers and mark the Xrefs as read."
6110   (let ((virtual (gnus-virtual-group-p from-newsgroup))
6111         name info xref-hashtb idlist method nth4)
6112     (with-current-buffer gnus-group-buffer
6113       (when (setq xref-hashtb
6114                   (gnus-create-xref-hashtb from-newsgroup headers unreads))
6115         (mapatoms
6116          (lambda (group)
6117            (unless (string= from-newsgroup (setq name (symbol-name group)))
6118              (setq idlist (symbol-value group))
6119              ;; Dead groups are not updated.
6120              (and (prog1
6121                       (setq info (gnus-get-info name))
6122                     (when (stringp (setq nth4 (gnus-info-method info)))
6123                       (setq nth4 (gnus-server-to-method nth4))))
6124                   ;; Only do the xrefs if the group has the same
6125                   ;; select method as the group we have just read.
6126                   (or (gnus-methods-equal-p
6127                        nth4 (gnus-find-method-for-group from-newsgroup))
6128                       virtual
6129                       (equal nth4 (setq method (gnus-find-method-for-group
6130                                                 from-newsgroup)))
6131                       (and (equal (car nth4) (car method))
6132                            (equal (nth 1 nth4) (nth 1 method))))
6133                   gnus-use-cross-reference
6134                   (or (not (eq gnus-use-cross-reference t))
6135                       virtual
6136                       ;; Only do cross-references on subscribed
6137                       ;; groups, if that is what is wanted.
6138                       (<= (gnus-info-level info) gnus-level-subscribed))
6139                   (gnus-group-make-articles-read name idlist))))
6140          xref-hashtb)))))
6141
6142 (defun gnus-compute-read-articles (group articles)
6143   (let* ((entry (gnus-group-entry group))
6144          (info (nth 2 entry))
6145          (active (gnus-active group))
6146          ninfo)
6147     (when entry
6148       ;; First peel off all invalid article numbers.
6149       (when active
6150         (let ((ids articles)
6151               id first)
6152           (while (setq id (pop ids))
6153             (when (and first (> id (cdr active)))
6154               ;; We'll end up in this situation in one particular
6155               ;; obscure situation.  If you re-scan a group and get
6156               ;; a new article that is cross-posted to a different
6157               ;; group that has not been re-scanned, you might get
6158               ;; crossposted article that has a higher number than
6159               ;; Gnus believes possible.  So we re-activate this
6160               ;; group as well.  This might mean doing the
6161               ;; crossposting thingy will *increase* the number
6162               ;; of articles in some groups.  Tsk, tsk.
6163               (setq active (or (gnus-activate-group group) active)))
6164             (when (or (> id (cdr active))
6165                       (< id (car active)))
6166               (setq articles (delq id articles))))))
6167       ;; If the read list is nil, we init it.
6168       (if (and active
6169                (null (gnus-info-read info))
6170                (> (car active) 1))
6171           (setq ninfo (cons 1 (1- (car active))))
6172         (setq ninfo (gnus-info-read info)))
6173       ;; Then we add the read articles to the range.
6174       (gnus-add-to-range
6175        ninfo (setq articles (sort articles '<))))))
6176
6177 (defun gnus-group-make-articles-read (group articles)
6178   "Update the info of GROUP to say that ARTICLES are read."
6179   (let* ((num 0)
6180          (entry (gnus-group-entry group))
6181          (info (nth 2 entry))
6182          (active (gnus-active group))
6183          range)
6184     (when entry
6185       (setq range (gnus-compute-read-articles group articles))
6186       (with-current-buffer gnus-group-buffer
6187         (gnus-undo-register
6188           `(progn
6189              (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
6190              (gnus-info-set-read ',info ',(gnus-info-read info))
6191              (gnus-get-unread-articles-in-group ',info (gnus-active ,group))
6192              (gnus-request-set-mark ,group (list (list ',range 'del '(read))))
6193              (gnus-group-update-group ,group t))))
6194       ;; Add the read articles to the range.
6195       (gnus-info-set-read info range)
6196       (gnus-request-set-mark group (list (list range 'add '(read))))
6197       ;; Then we have to re-compute how many unread
6198       ;; articles there are in this group.
6199       (when active
6200         (cond
6201          ((not range)
6202           (setq num (- (1+ (cdr active)) (car active))))
6203          ((not (listp (cdr range)))
6204           (setq num (- (cdr active) (- (1+ (cdr range))
6205                                        (car range)))))
6206          (t
6207           (while range
6208             (if (numberp (car range))
6209                 (setq num (1+ num))
6210               (setq num (+ num (- (1+ (cdar range)) (caar range)))))
6211             (setq range (cdr range)))
6212           (setq num (- (cdr active) num))))
6213         ;; Update the number of unread articles.
6214         (setcar entry num)
6215         ;; Update the group buffer.
6216         (unless (gnus-ephemeral-group-p group)
6217           (gnus-group-update-group group t))))))
6218
6219 (defun gnus-get-newsgroup-headers (&optional dependencies force-new)
6220   (let ((cur nntp-server-buffer)
6221         (dependencies
6222          (or dependencies
6223              (with-current-buffer gnus-summary-buffer
6224                gnus-newsgroup-dependencies)))
6225         headers id end ref number
6226         (mail-parse-charset gnus-newsgroup-charset)
6227         (mail-parse-ignored-charsets
6228          (save-current-buffer (condition-case nil
6229                                   (set-buffer gnus-summary-buffer)
6230                                 (error))
6231                               gnus-newsgroup-ignored-charsets)))
6232     (with-current-buffer nntp-server-buffer
6233       ;; Translate all TAB characters into SPACE characters.
6234       (subst-char-in-region (point-min) (point-max) ?\t ?  t)
6235       (subst-char-in-region (point-min) (point-max) ?\r ?  t)
6236       (ietf-drums-unfold-fws)
6237       (gnus-run-hooks 'gnus-parse-headers-hook)
6238       (let ((case-fold-search t)
6239             in-reply-to header p lines chars)
6240         (goto-char (point-min))
6241         ;; Search to the beginning of the next header.  Error messages
6242         ;; do not begin with 2 or 3.
6243         (while (re-search-forward "^[23][0-9]+ " nil t)
6244           (setq id nil
6245                 ref nil)
6246           ;; This implementation of this function, with nine
6247           ;; search-forwards instead of the one re-search-forward and
6248           ;; a case (which basically was the old function) is actually
6249           ;; about twice as fast, even though it looks messier.  You
6250           ;; can't have everything, I guess.  Speed and elegance
6251           ;; doesn't always go hand in hand.
6252           (setq
6253            header
6254            (vector
6255             ;; Number.
6256             (prog1
6257                 (setq number (read cur))
6258               (end-of-line)
6259               (setq p (point))
6260               (narrow-to-region (point)
6261                                 (or (and (search-forward "\n.\n" nil t)
6262                                          (- (point) 2))
6263                                     (point))))
6264             ;; Subject.
6265             (progn
6266               (goto-char p)
6267               (if (search-forward "\nsubject:" nil t)
6268                   (funcall gnus-decode-encoded-word-function
6269                            (nnheader-header-value))
6270                 "(none)"))
6271             ;; From.
6272             (progn
6273               (goto-char p)
6274               (if (search-forward "\nfrom:" nil t)
6275                   (funcall gnus-decode-encoded-address-function
6276                            (nnheader-header-value))
6277                 "(nobody)"))
6278             ;; Date.
6279             (progn
6280               (goto-char p)
6281               (if (search-forward "\ndate:" nil t)
6282                   (nnheader-header-value) ""))
6283             ;; Message-ID.
6284             (progn
6285               (goto-char p)
6286               (setq id (if (re-search-forward
6287                             "^message-id: *\\(<[^\n\t> ]+>\\)" nil t)
6288                            ;; We do it this way to make sure the Message-ID
6289                            ;; is (somewhat) syntactically valid.
6290                            (buffer-substring (match-beginning 1)
6291                                              (match-end 1))
6292                          ;; If there was no message-id, we just fake one
6293                          ;; to make subsequent routines simpler.
6294                          (nnheader-generate-fake-message-id number))))
6295             ;; References.
6296             (progn
6297               (goto-char p)
6298               (if (search-forward "\nreferences:" nil t)
6299                   (progn
6300                     (setq end (point))
6301                     (prog1
6302                         (nnheader-header-value)
6303                       (setq ref
6304                             (buffer-substring
6305                              (progn
6306                                (end-of-line)
6307                                (search-backward ">" end t)
6308                                (1+ (point)))
6309                              (progn
6310                                (search-backward "<" end t)
6311                                (point))))))
6312                 ;; Get the references from the in-reply-to header if there
6313                 ;; were no references and the in-reply-to header looks
6314                 ;; promising.
6315                 (if (and (search-forward "\nin-reply-to:" nil t)
6316                          (setq in-reply-to (nnheader-header-value))
6317                          (string-match "<[^>]+>" in-reply-to))
6318                     (let (ref2)
6319                       (setq ref (substring in-reply-to (match-beginning 0)
6320                                            (match-end 0)))
6321                       (while (string-match "<[^>]+>" in-reply-to (match-end 0))
6322                         (setq ref2 (substring in-reply-to (match-beginning 0)
6323                                               (match-end 0)))
6324                         (when (> (length ref2) (length ref))
6325                           (setq ref ref2)))
6326                       ref)
6327                   (setq ref nil))))
6328             ;; Chars.
6329             (progn
6330               (goto-char p)
6331               (if (search-forward "\nchars: " nil t)
6332                   (if (numberp (setq chars (ignore-errors (read cur))))
6333                       chars -1)
6334                 -1))
6335             ;; Lines.
6336             (progn
6337               (goto-char p)
6338               (if (search-forward "\nlines: " nil t)
6339                   (if (numberp (setq lines (ignore-errors (read cur))))
6340                       lines -1)
6341                 -1))
6342             ;; Xref.
6343             (progn
6344               (goto-char p)
6345               (and (search-forward "\nxref:" nil t)
6346                    (nnheader-header-value)))
6347             ;; Extra.
6348             (when gnus-extra-headers
6349               (let ((extra gnus-extra-headers)
6350                     out)
6351                 (while extra
6352                   (goto-char p)
6353                   (when (search-forward
6354                          (concat "\n" (symbol-name (car extra)) ":") nil t)
6355                     (push (cons (car extra) (nnheader-header-value))
6356                           out))
6357                   (pop extra))
6358                 out))))
6359           (when (equal id ref)
6360             (setq ref nil))
6361
6362           (when gnus-alter-header-function
6363             (funcall gnus-alter-header-function header)
6364             (setq id (mail-header-id header)
6365                   ref (gnus-parent-id (mail-header-references header))))
6366
6367           (when (setq header
6368                       (gnus-dependencies-add-header
6369                        header dependencies force-new))
6370             (push header headers))
6371           (goto-char (point-max))
6372           (widen))
6373         (nreverse headers)))))
6374
6375 ;; Goes through the xover lines and returns a list of vectors
6376 (defun gnus-get-newsgroup-headers-xover (sequence &optional
6377                                                   force-new dependencies
6378                                                   group also-fetch-heads)
6379   "Parse the news overview data in the server buffer.
6380 Return a list of headers that match SEQUENCE (see
6381 `nntp-retrieve-headers')."
6382   ;; Get the Xref when the users reads the articles since most/some
6383   ;; NNTP servers do not include Xrefs when using XOVER.
6384   (setq gnus-article-internal-prepare-hook '(gnus-article-get-xrefs))
6385   (let ((mail-parse-charset gnus-newsgroup-charset)
6386         (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
6387         (cur nntp-server-buffer)
6388         (dependencies (or dependencies gnus-newsgroup-dependencies))
6389         (allp (cond
6390                ((eq gnus-read-all-available-headers t)
6391                 t)
6392                ((and (stringp gnus-read-all-available-headers)
6393                      group)
6394                 (string-match gnus-read-all-available-headers group))
6395                (t
6396                 nil)))
6397         number headers header)
6398     (with-current-buffer nntp-server-buffer
6399       (subst-char-in-region (point-min) (point-max) ?\r ?  t)
6400       ;; Allow the user to mangle the headers before parsing them.
6401       (gnus-run-hooks 'gnus-parse-headers-hook)
6402       (goto-char (point-min))
6403       (gnus-parse-without-error
6404         (while (and (or sequence allp)
6405                     (not (eobp)))
6406           (setq number (read cur))
6407           (when (not allp)
6408             (while (and sequence
6409                         (< (car sequence) number))
6410               (setq sequence (cdr sequence))))
6411           (when (and (or allp
6412                          (and sequence
6413                               (eq number (car sequence))))
6414                      (progn
6415                        (setq sequence (cdr sequence))
6416                        (setq header (inline
6417                                       (gnus-nov-parse-line
6418                                        number dependencies force-new)))))
6419             (push header headers))
6420           (forward-line 1)))
6421       ;; A common bug in inn is that if you have posted an article and
6422       ;; then retrieves the active file, it will answer correctly --
6423       ;; the new article is included.  However, a NOV entry for the
6424       ;; article may not have been generated yet, so this may fail.
6425       ;; We work around this problem by retrieving the last few
6426       ;; headers using HEAD.
6427       (if (or (not also-fetch-heads)
6428               (not sequence))
6429           ;; We (probably) got all the headers.
6430           (nreverse headers)
6431         (let ((gnus-nov-is-evil t))
6432           (nconc
6433            (nreverse headers)
6434            (when (eq (gnus-retrieve-headers sequence group) 'headers)
6435              (gnus-get-newsgroup-headers))))))))
6436
6437 (defun gnus-article-get-xrefs ()
6438   "Fill in the Xref value in `gnus-current-headers', if necessary.
6439 This is meant to be called in `gnus-article-internal-prepare-hook'."
6440   (let ((headers (with-current-buffer gnus-summary-buffer
6441                    gnus-current-headers)))
6442     (or (not gnus-use-cross-reference)
6443         (not headers)
6444         (and (mail-header-xref headers)
6445              (not (string= (mail-header-xref headers) "")))
6446         (let ((case-fold-search t)
6447               xref)
6448           (save-restriction
6449             (nnheader-narrow-to-headers)
6450             (goto-char (point-min))
6451             (when (or (and (not (eobp))
6452                            (eq (downcase (char-after)) ?x)
6453                            (looking-at "Xref:"))
6454                       (search-forward "\nXref:" nil t))
6455               (goto-char (1+ (match-end 0)))
6456               (setq xref (buffer-substring (point) (point-at-eol)))
6457               (mail-header-set-xref headers xref)))))))
6458
6459 (defun gnus-summary-insert-subject (id &optional old-header use-old-header)
6460   "Find article ID and insert the summary line for that article.
6461 OLD-HEADER can either be a header or a line number to insert
6462 the subject line on."
6463   (let* ((line (and (numberp old-header) old-header))
6464          (old-header (and (vectorp old-header) old-header))
6465          (header (cond ((and old-header use-old-header)
6466                         old-header)
6467                        ((and (numberp id)
6468                              (gnus-number-to-header id))
6469                         (gnus-number-to-header id))
6470                        (t
6471                         (gnus-read-header id))))
6472          (number (and (numberp id) id))
6473          d)
6474     (when header
6475       ;; Rebuild the thread that this article is part of and go to the
6476       ;; article we have fetched.
6477       (when (and (not gnus-show-threads)
6478                  old-header)
6479         (when (and number
6480                    (setq d (gnus-data-find (mail-header-number old-header))))
6481           (goto-char (gnus-data-pos d))
6482           (gnus-data-remove
6483            number
6484            (- (point-at-bol)
6485               (prog1
6486                   (1+ (point-at-eol))
6487                 (gnus-delete-line))))))
6488       ;; Remove list identifiers from subject.
6489       (when gnus-list-identifiers
6490         (let ((gnus-newsgroup-headers (list header)))
6491           (gnus-summary-remove-list-identifiers)))
6492       (when old-header
6493         (mail-header-set-number header (mail-header-number old-header)))
6494       (setq gnus-newsgroup-sparse
6495             (delq (setq number (mail-header-number header))
6496                   gnus-newsgroup-sparse))
6497       (setq gnus-newsgroup-ancient (delq number gnus-newsgroup-ancient))
6498       (push number gnus-newsgroup-limit)
6499       (gnus-rebuild-thread (mail-header-id header) line)
6500       (gnus-summary-goto-subject number nil t))
6501     (when (and (numberp number)
6502                (> number 0))
6503       ;; We have to update the boundaries even if we can't fetch the
6504       ;; article if ID is a number -- so that the next `P' or `N'
6505       ;; command will fetch the previous (or next) article even
6506       ;; if the one we tried to fetch this time has been canceled.
6507       (when (> number gnus-newsgroup-end)
6508         (setq gnus-newsgroup-end number))
6509       (when (< number gnus-newsgroup-begin)
6510         (setq gnus-newsgroup-begin number))
6511       (setq gnus-newsgroup-unselected
6512             (delq number gnus-newsgroup-unselected)))
6513     ;; Report back a success?
6514     (and header (mail-header-number header))))
6515
6516 ;;; Process/prefix in the summary buffer
6517
6518 (defun gnus-summary-work-articles (n)
6519   "Return a list of articles to be worked upon.
6520 The prefix argument, the list of process marked articles, and the
6521 current article will be taken into consideration."
6522   (with-current-buffer gnus-summary-buffer
6523     (cond
6524      (n
6525       ;; A numerical prefix has been given.
6526       (setq n (prefix-numeric-value n))
6527       (let ((backward (< n 0))
6528             (n (abs (prefix-numeric-value n)))
6529             articles article)
6530         (save-excursion
6531           (while
6532               (and (> n 0)
6533                    (push (setq article (gnus-summary-article-number))
6534                          articles)
6535                    (if backward
6536                        (gnus-summary-find-prev nil article)
6537                      (gnus-summary-find-next nil article)))
6538             (decf n)))
6539         (nreverse articles)))
6540      ((and (gnus-region-active-p) (mark))
6541       (message "region active")
6542       ;; Work on the region between point and mark.
6543       (let ((max (max (point) (mark)))
6544             articles article)
6545         (save-excursion
6546           (goto-char (min (point) (mark)))
6547           (while
6548               (and
6549                (push (setq article (gnus-summary-article-number)) articles)
6550                (gnus-summary-find-next nil article)
6551                (< (point) max)))
6552           (nreverse articles))))
6553      (gnus-newsgroup-processable
6554       ;; There are process-marked articles present.
6555       ;; Save current state.
6556       (gnus-summary-save-process-mark)
6557       ;; Return the list.
6558       (reverse gnus-newsgroup-processable))
6559      (t
6560       ;; Just return the current article.
6561       (list (gnus-summary-article-number))))))
6562
6563 (defmacro gnus-summary-iterate (arg &rest forms)
6564   "Iterate over the process/prefixed articles and do FORMS.
6565 ARG is the interactive prefix given to the command.  FORMS will be
6566 executed with point over the summary line of the articles."
6567   (let ((articles (make-symbol "gnus-summary-iterate-articles")))
6568     `(let ((,articles (gnus-summary-work-articles ,arg)))
6569        (while ,articles
6570          (gnus-summary-goto-subject (car ,articles))
6571          ,@forms
6572          (pop ,articles)))))
6573
6574 (put 'gnus-summary-iterate 'lisp-indent-function 1)
6575 (put 'gnus-summary-iterate 'edebug-form-spec '(form body))
6576
6577 (defun gnus-summary-save-process-mark ()
6578   "Push the current set of process marked articles on the stack."
6579   (interactive)
6580   (push (copy-sequence gnus-newsgroup-processable)
6581         gnus-newsgroup-process-stack))
6582
6583 (defun gnus-summary-kill-process-mark ()
6584   "Push the current set of process marked articles on the stack and unmark."
6585   (interactive)
6586   (gnus-summary-save-process-mark)
6587   (gnus-summary-unmark-all-processable))
6588
6589 (defun gnus-summary-yank-process-mark ()
6590   "Pop the last process mark state off the stack and restore it."
6591   (interactive)
6592   (unless gnus-newsgroup-process-stack
6593     (error "Empty mark stack"))
6594   (gnus-summary-process-mark-set (pop gnus-newsgroup-process-stack)))
6595
6596 (defun gnus-summary-process-mark-set (set)
6597   "Make SET into the current process marked articles."
6598   (gnus-summary-unmark-all-processable)
6599   (mapc 'gnus-summary-set-process-mark set))
6600
6601 ;;; Searching and stuff
6602
6603 (defun gnus-summary-search-group (&optional backward use-level)
6604   "Search for next unread newsgroup.
6605 If optional argument BACKWARD is non-nil, search backward instead."
6606   (with-current-buffer gnus-group-buffer
6607     (when (gnus-group-search-forward
6608            backward nil (if use-level (gnus-group-group-level) nil))
6609       (gnus-group-group-name))))
6610
6611 (defun gnus-summary-best-group (&optional exclude-group)
6612   "Find the name of the best unread group.
6613 If EXCLUDE-GROUP, do not go to this group."
6614   (with-current-buffer gnus-group-buffer
6615     (save-excursion
6616       (gnus-group-best-unread-group exclude-group))))
6617
6618 (defun gnus-summary-find-next (&optional unread article backward)
6619   (if backward
6620       (gnus-summary-find-prev unread article)
6621     (let* ((dummy (gnus-summary-article-intangible-p))
6622            (article (or article (gnus-summary-article-number)))
6623            (data (gnus-data-find-list article))
6624            result)
6625       (when (and (not dummy)
6626                  (or (not gnus-summary-check-current)
6627                      (not unread)
6628                      (not (gnus-data-unread-p (car data)))))
6629         (setq data (cdr data)))
6630       (when (setq result
6631                   (if unread
6632                       (progn
6633                         (while data
6634                           (unless (memq (gnus-data-number (car data))
6635                                         (cond
6636                                          ((eq gnus-auto-goto-ignores
6637                                               'always-undownloaded)
6638                                           gnus-newsgroup-undownloaded)
6639                                          (gnus-plugged
6640                                           nil)
6641                                          ((eq gnus-auto-goto-ignores
6642                                               'unfetched)
6643                                           gnus-newsgroup-unfetched)
6644                                          ((eq gnus-auto-goto-ignores
6645                                               'undownloaded)
6646                                           gnus-newsgroup-undownloaded)))
6647                             (when (gnus-data-unread-p (car data))
6648                               (setq result (car data)
6649                                     data nil)))
6650                           (setq data (cdr data)))
6651                         result)
6652                     (car data)))
6653         (goto-char (gnus-data-pos result))
6654         (gnus-data-number result)))))
6655
6656 (defun gnus-summary-find-prev (&optional unread article)
6657   (let* ((eobp (eobp))
6658          (article (or article (gnus-summary-article-number)))
6659          (data (gnus-data-find-list article (gnus-data-list 'rev)))
6660          result)
6661     (when (and (not eobp)
6662                (or (not gnus-summary-check-current)
6663                    (not unread)
6664                    (not (gnus-data-unread-p (car data)))))
6665       (setq data (cdr data)))
6666     (when (setq result
6667                 (if unread
6668                     (progn
6669                       (while data
6670                         (unless (memq (gnus-data-number (car data))
6671                                       (cond
6672                                        ((eq gnus-auto-goto-ignores
6673                                             'always-undownloaded)
6674                                         gnus-newsgroup-undownloaded)
6675                                        (gnus-plugged
6676                                         nil)
6677                                        ((eq gnus-auto-goto-ignores
6678                                             'unfetched)
6679                                         gnus-newsgroup-unfetched)
6680                                        ((eq gnus-auto-goto-ignores
6681                                             'undownloaded)
6682                                         gnus-newsgroup-undownloaded)))
6683                           (when (gnus-data-unread-p (car data))
6684                             (setq result (car data)
6685                                   data nil)))
6686                         (setq data (cdr data)))
6687                       result)
6688                   (car data)))
6689       (goto-char (gnus-data-pos result))
6690       (gnus-data-number result))))
6691
6692 (defun gnus-summary-find-subject (subject &optional unread backward article)
6693   (let* ((simp-subject (gnus-simplify-subject-fully subject))
6694          (article (or article (gnus-summary-article-number)))
6695          (articles (gnus-data-list backward))
6696          (arts (gnus-data-find-list article articles))
6697          result)
6698     (when (or (not gnus-summary-check-current)
6699               (not unread)
6700               (not (gnus-data-unread-p (car arts))))
6701       (setq arts (cdr arts)))
6702     (while arts
6703       (and (or (not unread)
6704                (gnus-data-unread-p (car arts)))
6705            (vectorp (gnus-data-header (car arts)))
6706            (gnus-subject-equal
6707             simp-subject (mail-header-subject (gnus-data-header (car arts))) t)
6708            (setq result (car arts)
6709                  arts nil))
6710       (setq arts (cdr arts)))
6711     (and result
6712          (goto-char (gnus-data-pos result))
6713          (gnus-data-number result))))
6714
6715 (defun gnus-summary-search-forward (&optional unread subject backward)
6716   "Search forward for an article.
6717 If UNREAD, look for unread articles.  If SUBJECT, look for
6718 articles with that subject.  If BACKWARD, search backward instead."
6719   (cond (subject (gnus-summary-find-subject subject unread backward))
6720         (backward (gnus-summary-find-prev unread))
6721         (t (gnus-summary-find-next unread))))
6722
6723 (defun gnus-recenter (&optional n)
6724   "Center point in window and redisplay frame.
6725 Also do horizontal recentering."
6726   (interactive "P")
6727   (when (and gnus-auto-center-summary
6728              (not (eq gnus-auto-center-summary 'vertical)))
6729     (gnus-horizontal-recenter))
6730   (if (fboundp 'recenter-top-bottom)
6731       (recenter-top-bottom n)
6732     (recenter n)))
6733
6734 (put 'gnus-recenter 'isearch-scroll t)
6735
6736 (defun gnus-forward-line-ignore-invisible (n)
6737   "Move N lines forward (backward if N is negative).
6738 Like forward-line, but skip over (and don't count) invisible lines."
6739   (let (done)
6740     (while (and (> n 0) (not done))
6741       ;; If the following character is currently invisible,
6742       ;; skip all characters with that same `invisible' property value.
6743       (while (gnus-invisible-p (point))
6744         (goto-char (gnus-next-char-property-change (point))))
6745       (forward-line 1)
6746       (if (eobp)
6747           (setq done t)
6748         (setq n (1- n))))
6749     (while (and (< n 0) (not done))
6750       (forward-line -1)
6751       (if (bobp) (setq done t)
6752         (setq n (1+ n))
6753         (while (and (not (bobp)) (gnus-invisible-p (1- (point))))
6754           (goto-char (gnus-previous-char-property-change (point))))))))
6755
6756 (defun gnus-summary-recenter ()
6757   "Center point in the summary window.
6758 If `gnus-auto-center-summary' is nil, or the article buffer isn't
6759 displayed, no centering will be performed."
6760   ;; Suggested by earle@mahendo.JPL.NASA.GOV (Greg Earle).
6761   ;; Recenter only when requested.  Suggested by popovich@park.cs.columbia.edu.
6762   (interactive)
6763   ;; The user has to want it.
6764   (when gnus-auto-center-summary
6765     (let* ((top (cond ((< (window-height) 4) 0)
6766                       ((< (window-height) 7) 1)
6767                       (t (if (numberp gnus-auto-center-summary)
6768                              gnus-auto-center-summary
6769                            (/ (1- (window-height)) 2)))))
6770            (height (1- (window-height)))
6771            (bottom (save-excursion
6772                      (goto-char (point-max))
6773                      (gnus-forward-line-ignore-invisible (- height))
6774                      (point)))
6775            (window (get-buffer-window (current-buffer))))
6776       (when (get-buffer-window gnus-article-buffer)
6777         ;; Only do recentering when the article buffer is displayed,
6778         ;; Set the window start to either `bottom', which is the biggest
6779         ;; possible valid number, or the second line from the top,
6780         ;; whichever is the least.
6781         (let ((top-pos (save-excursion
6782                          (gnus-forward-line-ignore-invisible (- top))
6783                          (point))))
6784           (if (> bottom top-pos)
6785               ;; Keep the second line from the top visible
6786               (set-window-start window top-pos)
6787             ;; Try to keep the bottom line visible; if it's partially
6788             ;; obscured, either scroll one more line to make it fully
6789             ;; visible, or revert to using TOP-POS.
6790             (save-excursion
6791               (goto-char (point-max))
6792               (gnus-forward-line-ignore-invisible -1)
6793               (let ((last-line-start (point)))
6794                 (goto-char bottom)
6795                 (set-window-start window (point) t)
6796                 (when (not (pos-visible-in-window-p last-line-start window))
6797                   (gnus-forward-line-ignore-invisible 1)
6798                   (set-window-start window (min (point) top-pos) t)))))))
6799       ;; Do horizontal recentering while we're at it.
6800       (when (and (get-buffer-window (current-buffer) t)
6801                  (not (eq gnus-auto-center-summary 'vertical)))
6802         (let ((selected (selected-window)))
6803           (select-window (get-buffer-window (current-buffer) t))
6804           (gnus-summary-position-point)
6805           (gnus-horizontal-recenter)
6806           (select-window selected))))))
6807
6808 (defun gnus-summary-jump-to-group (newsgroup)
6809   "Move point to NEWSGROUP in group mode buffer."
6810   ;; Keep update point of group mode buffer if visible.
6811   (if (eq (current-buffer) (get-buffer gnus-group-buffer))
6812       (save-window-excursion
6813         ;; Take care of tree window mode.
6814         (when (get-buffer-window gnus-group-buffer)
6815           (pop-to-buffer gnus-group-buffer))
6816         (gnus-group-jump-to-group newsgroup))
6817     (save-excursion
6818       ;; Take care of tree window mode.
6819       (if (get-buffer-window gnus-group-buffer 0)
6820           (pop-to-buffer gnus-group-buffer)
6821         (set-buffer gnus-group-buffer))
6822       (gnus-group-jump-to-group newsgroup))))
6823
6824 ;; This function returns a list of article numbers based on the
6825 ;; difference between the ranges of read articles in this group and
6826 ;; the range of active articles.
6827 (defun gnus-list-of-unread-articles (group)
6828   (let* ((read (gnus-info-read (gnus-get-info group)))
6829          (active (or (gnus-active group) (gnus-activate-group group)))
6830          (last (or (cdr active)
6831                    (error "Group %s couldn't be activated " group)))
6832          (bottom (if gnus-newsgroup-maximum-articles
6833                      (max (car active)
6834                           (- last gnus-newsgroup-maximum-articles -1))
6835                    (car active)))
6836          first nlast unread)
6837     ;; If none are read, then all are unread.
6838     (if (not read)
6839         (setq first bottom)
6840       ;; If the range of read articles is a single range, then the
6841       ;; first unread article is the article after the last read
6842       ;; article.  Sounds logical, doesn't it?
6843       (if (and (not (listp (cdr read)))
6844                (or (< (car read) bottom)
6845                    (progn (setq read (list read))
6846                           nil)))
6847           (setq first (max bottom (1+ (cdr read))))
6848         ;; `read' is a list of ranges.
6849         (when (/= (setq nlast (or (and (numberp (car read)) (car read))
6850                                   (caar read)))
6851                   1)
6852           (setq first bottom))
6853         (while read
6854           (when first
6855             (while (< first nlast)
6856               (setq unread (cons first unread)
6857                     first (1+ first))))
6858           (setq first (1+ (if (atom (car read)) (car read) (cdar read))))
6859           (setq nlast (if (atom (cadr read)) (cadr read) (caadr read)))
6860           (setq read (cdr read)))))
6861     ;; And add the last unread articles.
6862     (while (<= first last)
6863       (setq unread (cons first unread)
6864             first (1+ first)))
6865     ;; Return the list of unread articles.
6866     (delq 0 (nreverse unread))))
6867
6868 (defun gnus-list-of-read-articles (group)
6869   "Return a list of unread, unticked and non-dormant articles."
6870   (let* ((info (gnus-get-info group))
6871          (marked (gnus-info-marks info))
6872          (active (gnus-active group)))
6873     (and info active
6874          (gnus-list-range-difference
6875           (gnus-list-range-difference
6876            (gnus-sorted-complement
6877             (gnus-uncompress-range
6878              (if gnus-newsgroup-maximum-articles
6879                  (cons (max (car active)
6880                             (- (cdr active)
6881                                gnus-newsgroup-maximum-articles
6882                                -1))
6883                        (cdr active))
6884                active))
6885             (gnus-list-of-unread-articles group))
6886            (cdr (assq 'dormant marked)))
6887           (cdr (assq 'tick marked))))))
6888
6889 ;; This function returns a sequence of article numbers based on the
6890 ;; difference between the ranges of read articles in this group and
6891 ;; the range of active articles.
6892 (defun gnus-sequence-of-unread-articles (group)
6893   (let* ((read (gnus-info-read (gnus-get-info group)))
6894          (active (or (gnus-active group) (gnus-activate-group group)))
6895          (last (cdr active))
6896          (bottom (if gnus-newsgroup-maximum-articles
6897                      (max (car active)
6898                           (- last gnus-newsgroup-maximum-articles -1))
6899                    (car active)))
6900          first nlast unread)
6901     ;; If none are read, then all are unread.
6902     (if (not read)
6903         (setq first bottom)
6904       ;; If the range of read articles is a single range, then the
6905       ;; first unread article is the article after the last read
6906       ;; article.  Sounds logical, doesn't it?
6907       (if (and (not (listp (cdr read)))
6908                (or (< (car read) bottom)
6909                    (progn (setq read (list read))
6910                           nil)))
6911           (setq first (max bottom (1+ (cdr read))))
6912         ;; `read' is a list of ranges.
6913         (when (/= (setq nlast (or (and (numberp (car read)) (car read))
6914                                   (caar read)))
6915                   1)
6916           (setq first bottom))
6917         (while read
6918           (when first
6919             (push (cons first nlast) unread))
6920           (setq first (1+ (if (atom (car read)) (car read) (cdar read))))
6921           (setq nlast (if (atom (cadr read)) (cadr read) (caadr read)))
6922           (setq read (cdr read)))))
6923     ;; And add the last unread articles.
6924     (cond ((not (and first last))
6925            nil)
6926           ((< first last)
6927            (push (cons first last) unread))
6928           ((= first last)
6929            (push first unread)))
6930     ;; Return the sequence of unread articles.
6931     (delq 0 (nreverse unread))))
6932
6933 ;; Various summary commands
6934
6935 (defun gnus-summary-select-article-buffer ()
6936   "Reconfigure windows to show article buffer."
6937   (interactive)
6938   (if (not (gnus-buffer-live-p gnus-article-buffer))
6939       (error "There is no article buffer for this summary buffer")
6940     (gnus-configure-windows 'article)
6941     (select-window (get-buffer-window gnus-article-buffer))))
6942
6943 (defun gnus-summary-universal-argument (arg)
6944   "Perform any operation on all articles that are process/prefixed."
6945   (interactive "P")
6946   (let ((articles (gnus-summary-work-articles arg))
6947         func article)
6948     (if (eq
6949          (setq
6950           func
6951           (key-binding
6952            (read-key-sequence
6953             (substitute-command-keys
6954              "\\<gnus-summary-mode-map>\\[gnus-summary-universal-argument]"))))
6955          'undefined)
6956         (gnus-error 1 "Undefined key")
6957       (save-excursion
6958         (while articles
6959           (gnus-summary-goto-subject (setq article (pop articles)))
6960           (let (gnus-newsgroup-processable)
6961             (command-execute func))
6962           (gnus-summary-remove-process-mark article)))))
6963   (gnus-summary-position-point))
6964
6965 (defun gnus-summary-toggle-truncation (&optional arg)
6966   "Toggle truncation of summary lines.
6967 With ARG, turn line truncation on if ARG is positive."
6968   (interactive "P")
6969   (setq truncate-lines
6970         (if (null arg) (not truncate-lines)
6971           (> (prefix-numeric-value arg) 0)))
6972   (redraw-display))
6973
6974 (defun gnus-summary-find-for-reselect ()
6975   "Return the number of an article to stay on across a reselect.
6976 The current article is considered, then following articles, then previous
6977 articles.  An article is sought which is not cancelled and isn't a temporary
6978 insertion from another group.  If there's no such then return a dummy 0."
6979   (let (found)
6980     (dolist (rev '(nil t))
6981       (unless found      ; don't demand the reverse list if we don't need it
6982         (let ((data (gnus-data-find-list
6983                      (gnus-summary-article-number) (gnus-data-list rev))))
6984           (while (and data (not found))
6985             (if (and (< 0 (gnus-data-number (car data)))
6986                      (not (eq gnus-canceled-mark (gnus-data-mark (car data)))))
6987                 (setq found (gnus-data-number (car data))))
6988             (setq data (cdr data))))))
6989     (or found 0)))
6990
6991 (defun gnus-summary-reselect-current-group (&optional all rescan)
6992   "Exit and then reselect the current newsgroup.
6993 The prefix argument ALL means to select all articles."
6994   (interactive "P")
6995   (when (gnus-ephemeral-group-p gnus-newsgroup-name)
6996     (error "Ephemeral groups can't be reselected"))
6997   (let ((current-subject (gnus-summary-find-for-reselect))
6998         (group gnus-newsgroup-name))
6999     (setq gnus-newsgroup-begin nil)
7000     (gnus-summary-exit nil 'leave-hidden)
7001     ;; We have to adjust the point of group mode buffer because
7002     ;; point was moved to the next unread newsgroup by exiting.
7003     (gnus-summary-jump-to-group group)
7004     (when rescan
7005       (save-excursion
7006         (gnus-group-get-new-news-this-group 1)))
7007     (gnus-group-read-group all t)
7008     (gnus-summary-goto-subject current-subject nil t)))
7009
7010 (defun gnus-summary-rescan-group (&optional all)
7011   "Exit the newsgroup, ask for new articles, and select the newsgroup."
7012   (interactive "P")
7013   (gnus-summary-reselect-current-group all t))
7014
7015 (defun gnus-summary-update-info (&optional non-destructive)
7016   (save-excursion
7017     (let ((group gnus-newsgroup-name))
7018       (when group
7019         (when gnus-newsgroup-kill-headers
7020           (setq gnus-newsgroup-killed
7021                 (gnus-compress-sequence
7022                  (gnus-sorted-union
7023                   (gnus-list-range-intersection
7024                    gnus-newsgroup-unselected gnus-newsgroup-killed)
7025                   gnus-newsgroup-unreads)
7026                  t)))
7027         (unless (listp (cdr gnus-newsgroup-killed))
7028           (setq gnus-newsgroup-killed (list gnus-newsgroup-killed)))
7029         (let ((headers gnus-newsgroup-headers))
7030           ;; Set the new ranges of read articles.
7031           (with-current-buffer gnus-group-buffer
7032             (gnus-undo-force-boundary))
7033           (gnus-update-read-articles
7034            group (gnus-sorted-union
7035                   gnus-newsgroup-unreads gnus-newsgroup-unselected))
7036           ;; Set the current article marks.
7037           (let ((gnus-newsgroup-scored
7038                  (if (and (not gnus-save-score)
7039                           (not non-destructive))
7040                      nil
7041                    gnus-newsgroup-scored)))
7042             (save-excursion
7043               (gnus-update-marks)))
7044           ;; Do the cross-ref thing.
7045           (when gnus-use-cross-reference
7046             (gnus-mark-xrefs-as-read group headers gnus-newsgroup-unreads))
7047           ;; Do not switch windows but change the buffer to work.
7048           (set-buffer gnus-group-buffer)
7049           (unless (gnus-ephemeral-group-p group)
7050             (gnus-group-update-group group)))))))
7051
7052 (defun gnus-summary-save-newsrc (&optional force)
7053   "Save the current number of read/marked articles in the dribble buffer.
7054 The dribble buffer will then be saved.
7055 If FORCE (the prefix), also save the .newsrc file(s)."
7056   (interactive "P")
7057   (gnus-summary-update-info t)
7058   (if force
7059       (gnus-save-newsrc-file)
7060     (gnus-dribble-save)))
7061
7062 (declare-function gnus-cache-write-active "gnus-cache" (&optional force))
7063
7064 (defun gnus-summary-exit (&optional temporary leave-hidden)
7065   "Exit reading current newsgroup, and then return to group selection mode.
7066 `gnus-exit-group-hook' is called with no arguments if that value is non-nil."
7067   (interactive)
7068   (gnus-set-global-variables)
7069   (when (gnus-buffer-live-p gnus-article-buffer)
7070     (with-current-buffer gnus-article-buffer
7071       (mm-destroy-parts gnus-article-mime-handles)
7072       ;; Set it to nil for safety reason.
7073       (setq gnus-article-mime-handle-alist nil)
7074       (setq gnus-article-mime-handles nil)))
7075   (gnus-kill-save-kill-buffer)
7076   (gnus-async-halt-prefetch)
7077   (let* ((group gnus-newsgroup-name)
7078          (quit-config (gnus-group-quit-config gnus-newsgroup-name))
7079          (gnus-group-is-exiting-p t)
7080          (mode major-mode)
7081          (group-point nil)
7082          (buf (current-buffer)))
7083     (unless quit-config
7084       ;; Do adaptive scoring, and possibly save score files.
7085       (when gnus-newsgroup-adaptive
7086         (gnus-score-adaptive))
7087       (when gnus-use-scoring
7088         (gnus-score-save)))
7089     (gnus-run-hooks 'gnus-summary-prepare-exit-hook)
7090     ;; If we have several article buffers, we kill them at exit.
7091     (unless gnus-single-article-buffer
7092       (when (gnus-buffer-live-p gnus-article-buffer)
7093         (with-current-buffer gnus-article-buffer
7094           ;; Don't kill sticky article buffers
7095           (unless (eq major-mode 'gnus-sticky-article-mode)
7096             (gnus-kill-buffer gnus-article-buffer)
7097             (setq gnus-article-current nil))))
7098       (gnus-kill-buffer gnus-original-article-buffer))
7099     (when gnus-use-cache
7100       (gnus-cache-possibly-remove-articles)
7101       (gnus-cache-save-buffers))
7102     (gnus-async-prefetch-remove-group group)
7103     (when gnus-suppress-duplicates
7104       (gnus-dup-enter-articles))
7105     (when gnus-use-trees
7106       (gnus-tree-close group))
7107     (when gnus-use-cache
7108       (gnus-cache-write-active))
7109     ;; Remove entries for this group.
7110     (nnmail-purge-split-history (gnus-group-real-name group))
7111     ;; Make all changes in this group permanent.
7112     (unless quit-config
7113       (gnus-run-hooks 'gnus-exit-group-hook)
7114       (gnus-summary-update-info))
7115     (gnus-close-group group)
7116     ;; Make sure where we were, and go to next newsgroup.
7117     (set-buffer gnus-group-buffer)
7118     (unless quit-config
7119       (gnus-group-jump-to-group group))
7120     (gnus-run-hooks 'gnus-summary-exit-hook)
7121     (unless (or quit-config
7122                 (not gnus-summary-next-group-on-exit)
7123                 ;; If this group has disappeared from the summary
7124                 ;; buffer, don't skip forwards.
7125                 (not (string= group (gnus-group-group-name))))
7126       (gnus-group-next-unread-group 1))
7127     (setq group-point (point))
7128     (if temporary
7129         nil                             ;Nothing to do.
7130       (set-buffer buf)
7131       (if (not gnus-kill-summary-on-exit)
7132           (progn
7133             (gnus-deaden-summary)
7134             (setq mode nil))
7135         ;; We set all buffer-local variables to nil.  It is unclear why
7136         ;; this is needed, but if we don't, buffer-local variables are
7137         ;; not garbage-collected, it seems.  This would the lead to en
7138         ;; ever-growing Emacs.
7139         (gnus-summary-clear-local-variables)
7140         (let ((gnus-summary-local-variables gnus-newsgroup-variables))
7141           (gnus-summary-clear-local-variables))
7142         (when (get-buffer gnus-article-buffer)
7143           (bury-buffer gnus-article-buffer))
7144         ;; Return to group mode buffer.
7145         (when (eq mode 'gnus-summary-mode)
7146           (gnus-kill-buffer buf)))
7147       (setq gnus-current-select-method gnus-select-method)
7148       (set-buffer gnus-group-buffer)
7149       (if quit-config
7150           (gnus-handle-ephemeral-exit quit-config)
7151         (goto-char group-point)
7152         ;; If gnus-group-buffer is already displayed, make sure we also move
7153         ;; the cursor in the window that displays it.
7154         (let ((win (get-buffer-window (current-buffer) 0)))
7155           (if win (set-window-point win (point))))
7156         (unless leave-hidden
7157           (gnus-configure-windows 'group 'force)))
7158       ;; Clear the current group name.
7159       (unless quit-config
7160         (setq gnus-newsgroup-name nil)))))
7161
7162 (defalias 'gnus-summary-quit 'gnus-summary-exit-no-update)
7163 (defun gnus-summary-exit-no-update (&optional no-questions)
7164   "Quit reading current newsgroup without updating read article info."
7165   (interactive)
7166   (let* ((group gnus-newsgroup-name)
7167          (gnus-group-is-exiting-p t)
7168          (gnus-group-is-exiting-without-update-p t)
7169          (quit-config (gnus-group-quit-config group)))
7170     (when (or no-questions
7171               gnus-expert-user
7172               (gnus-y-or-n-p "Discard changes to this group and exit? "))
7173       (gnus-async-halt-prefetch)
7174       (run-hooks 'gnus-summary-prepare-exit-hook)
7175       (when (gnus-buffer-live-p gnus-article-buffer)
7176         (with-current-buffer gnus-article-buffer
7177           (mm-destroy-parts gnus-article-mime-handles)
7178           ;; Set it to nil for safety reason.
7179           (setq gnus-article-mime-handle-alist nil)
7180           (setq gnus-article-mime-handles nil)))
7181       ;; If we have several article buffers, we kill them at exit.
7182       (unless gnus-single-article-buffer
7183         (gnus-kill-buffer gnus-article-buffer)
7184         (gnus-kill-buffer gnus-original-article-buffer)
7185         (setq gnus-article-current nil))
7186       (if (not gnus-kill-summary-on-exit)
7187           (gnus-deaden-summary)
7188         (gnus-close-group group)
7189         (gnus-summary-clear-local-variables)
7190         (let ((gnus-summary-local-variables gnus-newsgroup-variables))
7191           (gnus-summary-clear-local-variables))
7192         (gnus-kill-buffer gnus-summary-buffer))
7193       (unless gnus-single-article-buffer
7194         (setq gnus-article-current nil))
7195       (when gnus-use-trees
7196         (gnus-tree-close group))
7197       (gnus-async-prefetch-remove-group group)
7198       (when (get-buffer gnus-article-buffer)
7199         (bury-buffer gnus-article-buffer))
7200       ;; Return to the group buffer.
7201       (gnus-configure-windows 'group 'force)
7202       ;; Clear the current group name.
7203       (setq gnus-newsgroup-name nil)
7204       (unless (gnus-ephemeral-group-p group)
7205         (gnus-group-update-group group))
7206       (when (equal (gnus-group-group-name) group)
7207         (gnus-group-next-unread-group 1))
7208       (when quit-config
7209         (gnus-handle-ephemeral-exit quit-config)))))
7210
7211 (defun gnus-handle-ephemeral-exit (quit-config)
7212   "Handle movement when leaving an ephemeral group.
7213 The state which existed when entering the ephemeral is reset."
7214   (if (not (buffer-name (car quit-config)))
7215       (gnus-configure-windows 'group 'force)
7216     (set-buffer (car quit-config))
7217     (cond ((eq major-mode 'gnus-summary-mode)
7218            (gnus-set-global-variables))
7219           ((eq major-mode 'gnus-article-mode)
7220            (save-current-buffer
7221              ;; The `gnus-summary-buffer' variable may point
7222              ;; to the old summary buffer when using a single
7223              ;; article buffer.
7224              (unless (gnus-buffer-live-p gnus-summary-buffer)
7225                (set-buffer gnus-group-buffer))
7226              (set-buffer gnus-summary-buffer)
7227              (gnus-set-global-variables))))
7228     (if (or (eq (cdr quit-config) 'article)
7229             (eq (cdr quit-config) 'pick))
7230         (if (and (boundp 'gnus-pick-mode) (symbol-value 'gnus-pick-mode))
7231             (gnus-configure-windows 'pick 'force)
7232           (gnus-configure-windows (cdr quit-config) 'force))
7233       (gnus-configure-windows (cdr quit-config) 'force))
7234     (when (eq major-mode 'gnus-summary-mode)
7235       (if (memq gnus-auto-select-on-ephemeral-exit '(next-noselect
7236                                                      next-unread-noselect))
7237           (when (zerop (cond ((eq gnus-auto-select-on-ephemeral-exit
7238                                   'next-noselect)
7239                               (gnus-summary-next-subject 1 nil t))
7240                              ((eq gnus-auto-select-on-ephemeral-exit
7241                                   'next-unread-noselect)
7242                               (gnus-summary-next-subject 1 t t))))
7243             ;; Hide the article buffer which displays the article different
7244             ;; from the one that the cursor points to in the summary buffer.
7245             (gnus-configure-windows 'summary 'force))
7246         (cond ((eq gnus-auto-select-on-ephemeral-exit 'next)
7247                (gnus-summary-next-subject 1))
7248               ((eq gnus-auto-select-on-ephemeral-exit 'next-unread)
7249                (gnus-summary-next-subject 1 t))))
7250       (gnus-summary-recenter)
7251       (gnus-summary-position-point))))
7252
7253 ;;; Dead summaries.
7254
7255 (defvar gnus-dead-summary-mode-map
7256   (let ((map (make-keymap)))
7257     (suppress-keymap map)
7258     (substitute-key-definition 'undefined 'gnus-summary-wake-up-the-dead map)
7259     (dolist (key '("\C-d" "\r" "\177" [delete]))
7260       (define-key map key 'gnus-summary-wake-up-the-dead))
7261     (dolist (key '("q" "Q"))
7262       (define-key map key 'bury-buffer))
7263     map))
7264
7265 (define-minor-mode gnus-dead-summary-mode
7266   "Minor mode for Gnus summary buffers."
7267   :lighter " Dead" :keymap gnus-dead-summary-mode-map
7268   (unless (derived-mode-p 'gnus-summary-mode)
7269     (setq gnus-dead-summary-mode nil)))
7270
7271 (defun gnus-deaden-summary ()
7272   "Make the current summary buffer into a dead summary buffer."
7273   ;; Kill any previous dead summary buffer.
7274   (when (and gnus-dead-summary
7275              (buffer-name gnus-dead-summary))
7276     (with-current-buffer gnus-dead-summary
7277       (when gnus-dead-summary-mode
7278         (kill-buffer (current-buffer)))))
7279   ;; Make this the current dead summary.
7280   (setq gnus-dead-summary (current-buffer))
7281   (gnus-dead-summary-mode 1)
7282   (let ((name (buffer-name)))
7283     (when (string-match "Summary" name)
7284       (rename-buffer
7285        (concat (substring name 0 (match-beginning 0)) "Dead "
7286                (substring name (match-beginning 0)))
7287        t)
7288       (bury-buffer))))
7289
7290 (defun gnus-kill-or-deaden-summary (buffer)
7291   "Kill or deaden the summary BUFFER."
7292   (save-excursion
7293     (when (and (buffer-name buffer)
7294                (not gnus-single-article-buffer))
7295       (with-current-buffer buffer
7296         (gnus-kill-buffer gnus-article-buffer)
7297         (gnus-kill-buffer gnus-original-article-buffer)))
7298     (cond
7299      ;; Kill the buffer.
7300      (gnus-kill-summary-on-exit
7301       (when (and gnus-use-trees
7302                  (gnus-buffer-exists-p buffer))
7303         (with-current-buffer buffer
7304           (gnus-tree-close gnus-newsgroup-name)))
7305       (gnus-kill-buffer buffer))
7306      ;; Deaden the buffer.
7307      ((gnus-buffer-exists-p buffer)
7308       (with-current-buffer buffer
7309         (gnus-deaden-summary))))))
7310
7311 (defun gnus-summary-wake-up-the-dead (&rest args)
7312   "Wake up the dead summary buffer."
7313   (interactive)
7314   (gnus-dead-summary-mode -1)
7315   (let ((name (buffer-name)))
7316     (when (string-match "Dead " name)
7317       (rename-buffer
7318        (concat (substring name 0 (match-beginning 0))
7319                (substring name (match-end 0)))
7320        t)))
7321   (gnus-message 3 "This dead summary is now alive again"))
7322
7323 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
7324 (defun gnus-summary-describe-group (&optional force)
7325   "Describe the current newsgroup."
7326   (interactive "P")
7327   (gnus-group-describe-group force gnus-newsgroup-name))
7328
7329 (defun gnus-summary-describe-briefly ()
7330   "Describe summary mode commands briefly."
7331   (interactive)
7332   (gnus-message 6 "%s" (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")))
7333
7334 ;; Walking around group mode buffer from summary mode.
7335
7336 (defun gnus-summary-next-group (&optional no-article target-group backward)
7337   "Exit current newsgroup and then select next unread newsgroup.
7338 If prefix argument NO-ARTICLE is non-nil, no article is selected
7339 initially.  If TARGET-GROUP, go to this group.  If BACKWARD, go to
7340 previous group instead."
7341   (interactive "P")
7342   ;; Stop pre-fetching.
7343   (gnus-async-halt-prefetch)
7344   (let ((current-group gnus-newsgroup-name)
7345         (current-buffer (current-buffer))
7346         entered)
7347     ;; First we semi-exit this group to update Xrefs and all variables.
7348     ;; We can't do a real exit, because the window conf must remain
7349     ;; the same in case the user is prompted for info, and we don't
7350     ;; want the window conf to change before that...
7351     (gnus-summary-exit t)
7352     (while (not entered)
7353       ;; Then we find what group we are supposed to enter.
7354       (set-buffer gnus-group-buffer)
7355       (gnus-group-jump-to-group current-group)
7356       (setq target-group
7357             (or target-group
7358                 (if (eq gnus-keep-same-level 'best)
7359                     (gnus-summary-best-group gnus-newsgroup-name)
7360                   (gnus-summary-search-group backward gnus-keep-same-level))))
7361       (if (not target-group)
7362           ;; There are no further groups, so we return to the group
7363           ;; buffer.
7364           (progn
7365             (gnus-message 5 "Returning to the group buffer")
7366             (setq entered t)
7367             (when (gnus-buffer-live-p current-buffer)
7368               (set-buffer current-buffer)
7369               (gnus-summary-exit))
7370             (gnus-run-hooks 'gnus-group-no-more-groups-hook))
7371         ;; We try to enter the target group.
7372         (gnus-group-jump-to-group target-group)
7373         (let ((unreads (gnus-group-group-unread)))
7374           (if (and (or (eq t unreads)
7375                        (and unreads (not (zerop unreads))))
7376                    (gnus-summary-read-group
7377                     target-group nil no-article
7378                     (and (buffer-name current-buffer) current-buffer)
7379                     nil backward))
7380               (setq entered t)
7381             (setq current-group target-group
7382                   target-group nil)))))))
7383
7384 (defun gnus-summary-prev-group (&optional no-article)
7385   "Exit current newsgroup and then select previous unread newsgroup.
7386 If prefix argument NO-ARTICLE is non-nil, no article is selected initially."
7387   (interactive "P")
7388   (gnus-summary-next-group no-article nil t))
7389
7390 ;; Walking around summary lines.
7391
7392 (defun gnus-summary-first-subject (&optional unread undownloaded unseen)
7393   "Go to the first subject satisfying any non-nil constraint.
7394 If UNREAD is non-nil, the article should be unread.
7395 If UNDOWNLOADED is non-nil, the article should be undownloaded.
7396 If UNSEEN is non-nil, the article should be unseen as well as unread.
7397 Returns the article selected or nil if there are no matching articles."
7398   (interactive "P")
7399   (cond
7400    ;; Empty summary.
7401    ((null gnus-newsgroup-data)
7402     (gnus-message 3 "No articles in the group")
7403     nil)
7404    ;; Pick the first article.
7405    ((not (or unread undownloaded unseen))
7406     (goto-char (gnus-data-pos (car gnus-newsgroup-data)))
7407     (gnus-data-number (car gnus-newsgroup-data)))
7408    ;; Find the first unread article.
7409    (t
7410     (let ((data gnus-newsgroup-data))
7411       (while (and data
7412                   (let ((num (gnus-data-number (car data))))
7413                     (or (memq num gnus-newsgroup-unfetched)
7414                         (not (or (and unread
7415                                       (memq num gnus-newsgroup-unreads))
7416                                  (and undownloaded
7417                                       (memq num gnus-newsgroup-undownloaded))
7418                                  (and unseen
7419                                       (memq num gnus-newsgroup-unseen)
7420                                       (memq num gnus-newsgroup-unreads)))))))
7421         (setq data (cdr data)))
7422       (prog1
7423           (if data
7424               (progn
7425                 (goto-char (gnus-data-pos (car data)))
7426                 (gnus-data-number (car data)))
7427             (gnus-message 3 "No more%s articles"
7428                           (let* ((r (when unread " unread"))
7429                                  (d (when undownloaded " undownloaded"))
7430                                  (s (when unseen " unseen"))
7431                                  (l (delq nil (list r d s))))
7432                             (cond ((= 3 (length l))
7433                                    (concat r "," d ", or" s))
7434                                   ((= 2 (length l))
7435                                    (concat (car l) ", or" (cadr l)))
7436                                   ((= 1 (length l))
7437                                    (car l))
7438                                   (t
7439                                    ""))))
7440             nil
7441             )
7442         (gnus-summary-position-point))))))
7443
7444 (defun gnus-summary-next-subject (n &optional unread dont-display)
7445   "Go to next N'th summary line.
7446 If N is negative, go to the previous N'th subject line.
7447 If UNREAD is non-nil, only unread articles are selected.
7448 The difference between N and the actual number of steps taken is
7449 returned."
7450   (interactive "p")
7451   (let ((backward (< n 0))
7452         (n (abs n)))
7453     (while (and (> n 0)
7454                 (if backward
7455                     (gnus-summary-find-prev unread)
7456                   (gnus-summary-find-next unread)))
7457       (unless (zerop (setq n (1- n)))
7458         (gnus-summary-show-thread)))
7459     (when (/= 0 n)
7460       (gnus-message 7 "No more%s articles"
7461                     (if unread " unread" "")))
7462     (unless dont-display
7463       (gnus-summary-recenter)
7464       (gnus-summary-position-point))
7465     n))
7466
7467 (defun gnus-summary-next-unread-subject (n)
7468   "Go to next N'th unread summary line."
7469   (interactive "p")
7470   (gnus-summary-next-subject n t))
7471
7472 (defun gnus-summary-prev-subject (n &optional unread)
7473   "Go to previous N'th summary line.
7474 If optional argument UNREAD is non-nil, only unread article is selected."
7475   (interactive "p")
7476   (gnus-summary-next-subject (- n) unread))
7477
7478 (defun gnus-summary-prev-unread-subject (n)
7479   "Go to previous N'th unread summary line."
7480   (interactive "p")
7481   (gnus-summary-next-subject (- n) t))
7482
7483 (defun gnus-summary-goto-subjects (articles)
7484   "Insert the subject header for ARTICLES in the current buffer."
7485   (save-excursion
7486     (dolist (article articles)
7487       (gnus-summary-goto-subject article t)))
7488   (gnus-summary-limit (append articles gnus-newsgroup-limit))
7489   (gnus-summary-position-point))
7490
7491 (defun gnus-summary-goto-subject (article &optional force silent)
7492   "Go to the subject line of ARTICLE.
7493 If FORCE, also allow jumping to articles not currently shown."
7494   (interactive "nArticle number: ")
7495   (unless (numberp article)
7496     (error "Article %s is not a number" article))
7497   (let ((b (point))
7498         (data (gnus-data-find article)))
7499     ;; We read in the article if we have to.
7500     (and (not data)
7501          force
7502          (gnus-summary-insert-subject
7503           article
7504           (if (or (numberp force) (vectorp force)) force)
7505           t)
7506          (setq data (gnus-data-find article)))
7507     (goto-char b)
7508     (if (not data)
7509         (progn
7510           (unless silent
7511             (gnus-message 3 "Can't find article %d" article))
7512           nil)
7513       (let ((pt (gnus-data-pos data)))
7514         (goto-char pt)
7515         (gnus-summary-set-article-display-arrow pt))
7516       (gnus-summary-position-point)
7517       article)))
7518
7519 ;; Walking around summary lines with displaying articles.
7520
7521 (defun gnus-summary-expand-window (&optional arg)
7522   "Make the summary buffer take up the entire Emacs frame.
7523 Given a prefix, will force an `article' buffer configuration."
7524   (interactive "P")
7525   (if arg
7526       (gnus-configure-windows 'article 'force)
7527     (gnus-configure-windows 'summary 'force)))
7528
7529 (defun gnus-summary-display-article (article &optional all-header)
7530   "Display ARTICLE in article buffer."
7531   (unless (and (gnus-buffer-live-p gnus-article-buffer)
7532                (with-current-buffer gnus-article-buffer
7533                  (eq major-mode 'gnus-article-mode)))
7534     (gnus-article-setup-buffer))
7535   (gnus-set-global-variables)
7536   (with-current-buffer gnus-article-buffer
7537     (setq gnus-article-charset gnus-newsgroup-charset)
7538     (setq gnus-article-ignored-charsets gnus-newsgroup-ignored-charsets)
7539     (mm-enable-multibyte))
7540   (if (null article)
7541       nil
7542     (prog1
7543         (if gnus-summary-display-article-function
7544             (funcall gnus-summary-display-article-function article all-header)
7545           (gnus-article-prepare article all-header))
7546       (gnus-run-hooks 'gnus-select-article-hook)
7547       (when (and gnus-current-article
7548                  (not (zerop gnus-current-article)))
7549         (gnus-summary-goto-subject gnus-current-article))
7550       (gnus-summary-recenter)
7551       (when (and gnus-use-trees gnus-show-threads)
7552         (gnus-possibly-generate-tree article)
7553         (gnus-highlight-selected-tree article))
7554       ;; Successfully display article.
7555       (gnus-article-set-window-start
7556        (cdr (assq article gnus-newsgroup-bookmarks))))))
7557
7558 (defun gnus-summary-select-article (&optional all-headers force pseudo article)
7559   "Select the current article.
7560 If ALL-HEADERS is non-nil, show all header fields.  If FORCE is
7561 non-nil, the article will be re-fetched even if it already present in
7562 the article buffer.  If PSEUDO is non-nil, pseudo-articles will also
7563 be displayed."
7564   ;; Make sure we are in the summary buffer to work around bbdb bug.
7565   (unless (eq major-mode 'gnus-summary-mode)
7566     (set-buffer gnus-summary-buffer))
7567   (let ((article (or article (gnus-summary-article-number)))
7568         (all-headers (not (not all-headers))) ;Must be t or nil.
7569         gnus-summary-display-article-function)
7570     (and (not pseudo)
7571          (gnus-summary-article-pseudo-p article)
7572          (error "This is a pseudo-article"))
7573     (with-current-buffer gnus-summary-buffer
7574       (if (or (and gnus-single-article-buffer
7575                    (or (null gnus-current-article)
7576                        (null gnus-article-current)
7577                        (null (get-buffer gnus-article-buffer))
7578                        (not (eq article (cdr gnus-article-current)))
7579                        (not (equal (car gnus-article-current)
7580                                    gnus-newsgroup-name))))
7581               (and (not gnus-single-article-buffer)
7582                    (or (null gnus-current-article)
7583                        (not (eq gnus-current-article article))))
7584               force)
7585           ;; The requested article is different from the current article.
7586           (progn
7587             (gnus-summary-display-article article all-headers)
7588             (when (gnus-buffer-live-p gnus-article-buffer)
7589               (with-current-buffer gnus-article-buffer
7590                 (if (not gnus-article-decoded-p) ;; a local variable
7591                     (mm-disable-multibyte))))
7592             (gnus-article-set-window-start
7593              (cdr (assq article gnus-newsgroup-bookmarks)))
7594             article)
7595         'old))))
7596
7597 (defun gnus-summary-force-verify-and-decrypt ()
7598   "Display buttons for signed/encrypted parts and verify/decrypt them."
7599   (interactive)
7600   (let ((mm-verify-option 'known)
7601         (mm-decrypt-option 'known)
7602         (gnus-article-emulate-mime t)
7603         (gnus-buttonized-mime-types (append (list "multipart/signed"
7604                                                   "multipart/encrypted")
7605                                             gnus-buttonized-mime-types)))
7606     (gnus-summary-select-article nil 'force)))
7607
7608 (defun gnus-summary-set-current-mark (&optional current-mark)
7609   "Obsolete function."
7610   nil)
7611
7612 (defun gnus-summary-next-article (&optional unread subject backward push)
7613   "Select the next article.
7614 If UNREAD, only unread articles are selected.
7615 If SUBJECT, only articles with SUBJECT are selected.
7616 If BACKWARD, the previous article is selected instead of the next."
7617   (interactive "P")
7618   ;; Make sure we are in the summary buffer.
7619   (unless (eq major-mode 'gnus-summary-mode)
7620     (set-buffer gnus-summary-buffer))
7621   (cond
7622    ;; Is there such an article?
7623    ((and (gnus-summary-search-forward unread subject backward)
7624          (or (gnus-summary-display-article (gnus-summary-article-number))
7625              (eq (gnus-summary-article-mark) gnus-canceled-mark)))
7626     (gnus-summary-position-point))
7627    ;; If not, we try the first unread, if that is wanted.
7628    ((and subject
7629          gnus-auto-select-same
7630          (gnus-summary-first-unread-article))
7631     (gnus-summary-position-point)
7632     (gnus-message 6 "Wrapped"))
7633    ;; Try to get next/previous article not displayed in this group.
7634    ((and gnus-auto-extend-newsgroup
7635          (not unread) (not subject))
7636     (gnus-summary-goto-article
7637      (if backward (1- gnus-newsgroup-begin) (1+ gnus-newsgroup-end))
7638      nil (count-lines (point-min) (point))))
7639    ;; Go to next/previous group.
7640    (t
7641     (unless (gnus-ephemeral-group-p gnus-newsgroup-name)
7642       (gnus-summary-jump-to-group gnus-newsgroup-name))
7643     (let ((cmd (if (featurep 'xemacs)
7644                    last-command-char
7645                  last-command-event))
7646           (point
7647            (with-current-buffer gnus-group-buffer
7648              (point)))
7649           (group
7650            (if (eq gnus-keep-same-level 'best)
7651                (gnus-summary-best-group gnus-newsgroup-name)
7652              (gnus-summary-search-group backward gnus-keep-same-level))))
7653       ;; For some reason, the group window gets selected.  We change
7654       ;; it back.
7655       (select-window (get-buffer-window (current-buffer)))
7656       ;; Select next unread newsgroup automagically.
7657       (cond
7658        ((or (not gnus-auto-select-next)
7659             (not cmd))
7660         (gnus-message 7 "No more%s articles" (if unread " unread" "")))
7661        ((or (eq gnus-auto-select-next 'quietly)
7662             (and (eq gnus-auto-select-next 'slightly-quietly)
7663                  push)
7664             (and (eq gnus-auto-select-next 'almost-quietly)
7665                  (gnus-summary-last-article-p)))
7666         ;; Select quietly.
7667         (if (gnus-ephemeral-group-p gnus-newsgroup-name)
7668             (gnus-summary-exit)
7669           (gnus-message 7 "No more%s articles (%s)..."
7670                         (if unread " unread" "")
7671                         (if group (concat "selecting " group)
7672                           "exiting"))
7673           (gnus-summary-next-group nil group backward)))
7674        (t
7675         (when (gnus-key-press-event-p last-input-event)
7676           (gnus-summary-walk-group-buffer
7677            gnus-newsgroup-name cmd unread backward point))))))))
7678
7679 (defun gnus-summary-walk-group-buffer (from-group cmd unread backward start)
7680   (let ((keystrokes '((?\C-n (gnus-group-next-unread-group 1))
7681                       (?\C-p (gnus-group-prev-unread-group 1))))
7682         (cursor-in-echo-area t)
7683         keve key group ended prompt)
7684     (with-current-buffer gnus-group-buffer
7685       (goto-char start)
7686       (setq group
7687             (if (eq gnus-keep-same-level 'best)
7688                 (gnus-summary-best-group gnus-newsgroup-name)
7689               (gnus-summary-search-group backward gnus-keep-same-level))))
7690     (while (not ended)
7691       (setq prompt
7692             (format
7693              "No more%s articles%s " (if unread " unread" "")
7694              (if (and group
7695                       (not (gnus-ephemeral-group-p gnus-newsgroup-name)))
7696                  (format " (Type %s for %s [%s])"
7697                          (single-key-description cmd)
7698                          (gnus-group-decoded-name group)
7699                          (gnus-group-unread group))
7700                (format " (Type %s to exit %s)"
7701                        (single-key-description cmd)
7702                        (gnus-group-decoded-name gnus-newsgroup-name)))))
7703       ;; Confirm auto selection.
7704       (setq key (car (setq keve (gnus-read-event-char prompt)))
7705             ended t)
7706       (cond
7707        ((assq key keystrokes)
7708         (let ((obuf (current-buffer)))
7709           (switch-to-buffer gnus-group-buffer)
7710           (when group
7711             (gnus-group-jump-to-group group))
7712           (eval (cadr (assq key keystrokes)))
7713           (setq group (gnus-group-group-name))
7714           (switch-to-buffer obuf))
7715         (setq ended nil))
7716        ((equal key cmd)
7717         (if (or (not group)
7718                 (gnus-ephemeral-group-p gnus-newsgroup-name))
7719             (gnus-summary-exit)
7720           (gnus-summary-next-group nil group backward)))
7721        (t
7722         (push (cdr keve) unread-command-events))))))
7723
7724 (defun gnus-summary-next-unread-article ()
7725   "Select unread article after current one."
7726   (interactive)
7727   (gnus-summary-next-article
7728    (or (not (eq gnus-summary-goto-unread 'never))
7729        (gnus-summary-last-article-p (gnus-summary-article-number)))
7730    (and gnus-auto-select-same
7731         (gnus-summary-article-subject))))
7732
7733 (defun gnus-summary-prev-article (&optional unread subject)
7734   "Select the article before the current one.
7735 If UNREAD is non-nil, only unread articles are selected."
7736   (interactive "P")
7737   (gnus-summary-next-article unread subject t))
7738
7739 (defun gnus-summary-prev-unread-article ()
7740   "Select unread article before current one."
7741   (interactive)
7742   (gnus-summary-prev-article
7743    (or (not (eq gnus-summary-goto-unread 'never))
7744        (gnus-summary-first-article-p (gnus-summary-article-number)))
7745    (and gnus-auto-select-same
7746         (gnus-summary-article-subject))))
7747
7748 (defun gnus-summary-next-page (&optional lines circular stop)
7749   "Show next page of the selected article.
7750 If at the end of the current article, select the next article.
7751 LINES says how many lines should be scrolled up.
7752
7753 If CIRCULAR is non-nil, go to the start of the article instead of
7754 selecting the next article when reaching the end of the current
7755 article.
7756
7757 If STOP is non-nil, just stop when reaching the end of the message.
7758
7759 Also see the variable `gnus-article-skip-boring'."
7760   (interactive "P")
7761   (setq gnus-summary-buffer (current-buffer))
7762   (gnus-set-global-variables)
7763   (let ((article (gnus-summary-article-number))
7764         (article-window (get-buffer-window gnus-article-buffer t))
7765         endp)
7766     ;; If the buffer is empty, we have no article.
7767     (unless article
7768       (error "No article to select"))
7769     (gnus-configure-windows 'article)
7770     (if (eq (cdr (assq article gnus-newsgroup-reads)) gnus-canceled-mark)
7771         (if (and (eq gnus-summary-goto-unread 'never)
7772                  (not (gnus-summary-last-article-p article)))
7773             (gnus-summary-next-article)
7774           (gnus-summary-next-unread-article))
7775       (if (or (null gnus-current-article)
7776               (null gnus-article-current)
7777               (/= article (cdr gnus-article-current))
7778               (not (equal (car gnus-article-current) gnus-newsgroup-name)))
7779           ;; Selected subject is different from current article's.
7780           (gnus-summary-display-article article)
7781         (when article-window
7782           (gnus-eval-in-buffer-window gnus-article-buffer
7783             (setq endp (or (gnus-article-next-page lines)
7784                            (gnus-article-only-boring-p))))
7785           (when endp
7786             (cond ((or stop gnus-summary-stop-at-end-of-message)
7787                    (gnus-message 3 "End of message"))
7788                   (circular
7789                    (gnus-summary-beginning-of-article))
7790                   (lines
7791                    (gnus-message 3 "End of message"))
7792                   ((null lines)
7793                    (if (and (eq gnus-summary-goto-unread 'never)
7794                             (not (gnus-summary-last-article-p article)))
7795                        (gnus-summary-next-article)
7796                      (gnus-summary-next-unread-article))))))))
7797     (gnus-summary-recenter)
7798     (gnus-summary-position-point)))
7799
7800 (defun gnus-summary-prev-page (&optional lines move)
7801   "Show previous page of selected article.
7802 Argument LINES specifies lines to be scrolled down.
7803 If MOVE, move to the previous unread article if point is at
7804 the beginning of the buffer."
7805   (interactive "P")
7806   (let ((article (gnus-summary-article-number))
7807         (article-window (get-buffer-window gnus-article-buffer t))
7808         endp)
7809     (gnus-configure-windows 'article)
7810     (if (or (null gnus-current-article)
7811             (null gnus-article-current)
7812             (/= article (cdr gnus-article-current))
7813             (not (equal (car gnus-article-current) gnus-newsgroup-name)))
7814         ;; Selected subject is different from current article's.
7815         (gnus-summary-display-article article)
7816       (gnus-summary-recenter)
7817       (when article-window
7818         (gnus-eval-in-buffer-window gnus-article-buffer
7819           (setq endp (gnus-article-prev-page lines)))
7820         (when (and move endp)
7821           (cond (lines
7822                  (gnus-message 3 "Beginning of message"))
7823                 ((null lines)
7824                  (if (and (eq gnus-summary-goto-unread 'never)
7825                           (not (gnus-summary-first-article-p article)))
7826                      (gnus-summary-prev-article)
7827                    (gnus-summary-prev-unread-article))))))))
7828   (gnus-summary-position-point))
7829
7830 (defun gnus-summary-prev-page-or-article (&optional lines)
7831   "Show previous page of selected article.
7832 Argument LINES specifies lines to be scrolled down.
7833 If at the beginning of the article, go to the next article."
7834   (interactive "P")
7835   (gnus-summary-prev-page lines t))
7836
7837 (defun gnus-summary-scroll-up (lines)
7838   "Scroll up (or down) one line current article.
7839 Argument LINES specifies lines to be scrolled up (or down if negative)."
7840   (interactive "p")
7841   (gnus-configure-windows 'article)
7842   (gnus-summary-show-thread)
7843   (when (eq (gnus-summary-select-article nil nil 'pseudo) 'old)
7844     (gnus-eval-in-buffer-window gnus-article-buffer
7845       (cond ((> lines 0)
7846              (when (gnus-article-next-page lines)
7847                (gnus-message 3 "End of message")))
7848             ((< lines 0)
7849              (gnus-article-prev-page (- lines))))))
7850   (gnus-summary-recenter)
7851   (gnus-summary-position-point))
7852
7853 (defun gnus-summary-scroll-down (lines)
7854   "Scroll down (or up) one line current article.
7855 Argument LINES specifies lines to be scrolled down (or up if negative)."
7856   (interactive "p")
7857   (gnus-summary-scroll-up (- lines)))
7858
7859 (defun gnus-summary-next-same-subject ()
7860   "Select next article which has the same subject as current one."
7861   (interactive)
7862   (gnus-summary-next-article nil (gnus-summary-article-subject)))
7863
7864 (defun gnus-summary-prev-same-subject ()
7865   "Select previous article which has the same subject as current one."
7866   (interactive)
7867   (gnus-summary-prev-article nil (gnus-summary-article-subject)))
7868
7869 (defun gnus-summary-next-unread-same-subject ()
7870   "Select next unread article which has the same subject as current one."
7871   (interactive)
7872   (gnus-summary-next-article t (gnus-summary-article-subject)))
7873
7874 (defun gnus-summary-prev-unread-same-subject ()
7875   "Select previous unread article which has the same subject as current one."
7876   (interactive)
7877   (gnus-summary-prev-article t (gnus-summary-article-subject)))
7878
7879 (defun gnus-summary-first-unread-article ()
7880   "Select the first unread article.
7881 Return nil if there are no unread articles."
7882   (interactive)
7883   (prog1
7884       (when (gnus-summary-first-subject t)
7885         (gnus-summary-show-thread)
7886         (gnus-summary-first-subject t)
7887         (gnus-summary-display-article (gnus-summary-article-number)))
7888     (gnus-summary-position-point)))
7889
7890 (defun gnus-summary-first-unread-subject ()
7891   "Place the point on the subject line of the first unread article.
7892 Return nil if there are no unread articles."
7893   (interactive)
7894   (prog1
7895       (when (gnus-summary-first-subject t)
7896         (gnus-summary-show-thread)
7897         (gnus-summary-first-subject t))
7898     (gnus-summary-position-point)))
7899
7900 (defun gnus-summary-first-unseen-subject ()
7901   "Place the point on the subject line of the first unseen article.
7902 Return nil if there are no unseen articles."
7903   (interactive)
7904   (prog1
7905       (when (gnus-summary-first-subject nil nil t)
7906         (gnus-summary-show-thread)
7907         (gnus-summary-first-subject nil nil t))
7908     (gnus-summary-position-point)))
7909
7910 (defun gnus-summary-first-unseen-or-unread-subject ()
7911   "Place the point on the subject line of the first unseen and unread article.
7912 If all article have been seen, on the subject line of the first unread
7913 article."
7914   (interactive)
7915   (prog1
7916       (unless (when (gnus-summary-first-subject nil nil t)
7917                 (gnus-summary-show-thread)
7918                 (gnus-summary-first-subject nil nil t))
7919         (when (gnus-summary-first-subject t)
7920           (gnus-summary-show-thread)
7921           (gnus-summary-first-subject t)))
7922     (gnus-summary-position-point)))
7923
7924 (defun gnus-summary-first-article ()
7925   "Select the first article.
7926 Return nil if there are no articles."
7927   (interactive)
7928   (prog1
7929       (when (gnus-summary-first-subject)
7930         (gnus-summary-show-thread)
7931         (gnus-summary-first-subject)
7932         (gnus-summary-display-article (gnus-summary-article-number)))
7933     (gnus-summary-position-point)))
7934
7935 (defun gnus-summary-best-unread-article (&optional arg)
7936   "Select the unread article with the highest score.
7937 If given a prefix argument, select the next unread article that has a
7938 score higher than the default score."
7939   (interactive "P")
7940   (let ((article (if arg
7941                      (gnus-summary-better-unread-subject)
7942                    (gnus-summary-best-unread-subject))))
7943     (if article
7944         (gnus-summary-goto-article article)
7945       (error "No unread articles"))))
7946
7947 (defun gnus-summary-best-unread-subject ()
7948   "Select the unread subject with the highest score."
7949   (interactive)
7950   (let ((best -1000000)
7951         (data gnus-newsgroup-data)
7952         article score)
7953     (while data
7954       (and (gnus-data-unread-p (car data))
7955            (> (setq score
7956                     (gnus-summary-article-score (gnus-data-number (car data))))
7957               best)
7958            (setq best score
7959                  article (gnus-data-number (car data))))
7960       (setq data (cdr data)))
7961     (when article
7962       (gnus-summary-goto-subject article))
7963     (gnus-summary-position-point)
7964     article))
7965
7966 (defun gnus-summary-better-unread-subject ()
7967   "Select the first unread subject that has a score over the default score."
7968   (interactive)
7969   (let ((data gnus-newsgroup-data)
7970         article score)
7971     (while (and (setq article (gnus-data-number (car data)))
7972                 (or (gnus-data-read-p (car data))
7973                     (not (> (gnus-summary-article-score article)
7974                             gnus-summary-default-score))))
7975       (setq data (cdr data)))
7976     (when article
7977       (gnus-summary-goto-subject article))
7978     (gnus-summary-position-point)
7979     article))
7980
7981 (defun gnus-summary-last-subject ()
7982   "Go to the last displayed subject line in the group."
7983   (let ((article (gnus-data-number (car (gnus-data-list t)))))
7984     (when article
7985       (gnus-summary-goto-subject article))))
7986
7987 (defun gnus-summary-goto-article (article &optional all-headers force)
7988   "Fetch ARTICLE (article number or Message-ID) and display it if it exists.
7989 If ALL-HEADERS is non-nil, no header lines are hidden.
7990 If FORCE, go to the article even if it isn't displayed.  If FORCE
7991 is a number, it is the line the article is to be displayed on."
7992   (interactive
7993    (list
7994     (completing-read
7995      "Article number or Message-ID: "
7996      (mapcar (lambda (number) (list (int-to-string number)))
7997              gnus-newsgroup-limit))
7998     current-prefix-arg
7999     t))
8000   (prog1
8001       (if (and (stringp article)
8002                (string-match "@\\|%40" article))
8003           (gnus-summary-refer-article article)
8004         (when (stringp article)
8005           (setq article (string-to-number article)))
8006         (if (gnus-summary-goto-subject article force)
8007             (gnus-summary-display-article article all-headers)
8008           (gnus-message 4 "Couldn't go to article %s" article) nil))
8009     (gnus-summary-position-point)))
8010
8011 (defun gnus-summary-goto-last-article ()
8012   "Go to the previously read article."
8013   (interactive)
8014   (prog1
8015       (when gnus-last-article
8016         (gnus-summary-goto-article gnus-last-article nil t))
8017     (gnus-summary-position-point)))
8018
8019 (defun gnus-summary-pop-article (number)
8020   "Pop one article off the history and go to the previous.
8021 NUMBER articles will be popped off."
8022   (interactive "p")
8023   (let (to)
8024     (setq gnus-newsgroup-history
8025           (cdr (setq to (nthcdr number gnus-newsgroup-history))))
8026     (if to
8027         (gnus-summary-goto-article (car to) nil t)
8028       (error "Article history empty")))
8029   (gnus-summary-position-point))
8030
8031 ;; Summary commands and functions for limiting the summary buffer.
8032
8033 (defun gnus-summary-limit-to-articles (n)
8034   "Limit the summary buffer to the next N articles.
8035 If not given a prefix, use the process marked articles instead."
8036   (interactive "P")
8037   (prog1
8038       (let ((articles (gnus-summary-work-articles n)))
8039         (setq gnus-newsgroup-processable nil)
8040         (gnus-summary-limit articles))
8041     (gnus-summary-position-point)))
8042
8043 (defun gnus-summary-pop-limit (&optional total)
8044   "Restore the previous limit.
8045 If given a prefix, remove all limits."
8046   (interactive "P")
8047   (when total
8048     (setq gnus-newsgroup-limits
8049           (list (mapcar (lambda (h) (mail-header-number h))
8050                         gnus-newsgroup-headers))))
8051   (unless gnus-newsgroup-limits
8052     (error "No limit to pop"))
8053   (prog1
8054       (gnus-summary-limit nil 'pop)
8055     (gnus-summary-position-point)))
8056
8057 (defun gnus-summary-limit-to-subject (subject &optional header not-matching)
8058   "Limit the summary buffer to articles that have subjects that match a regexp.
8059 If NOT-MATCHING, excluding articles that have subjects that match a regexp."
8060   (interactive
8061    (list (read-string (if current-prefix-arg
8062                           "Exclude subject (regexp): "
8063                         "Limit to subject (regexp): "))
8064          nil current-prefix-arg))
8065   (unless header
8066     (setq header "subject"))
8067   (when (not (equal "" subject))
8068     (prog1
8069         (let ((articles (gnus-summary-find-matching
8070                          (or header "subject") subject 'all nil nil
8071                          not-matching)))
8072           (unless articles
8073             (error "Found no matches for \"%s\"" subject))
8074           (gnus-summary-limit articles))
8075       (gnus-summary-position-point))))
8076
8077 (defun gnus-summary-limit-to-author (from &optional not-matching)
8078   "Limit the summary buffer to articles that have authors that match a regexp.
8079 If NOT-MATCHING, excluding articles that have authors that match a regexp."
8080   (interactive
8081    (list (read-string (if current-prefix-arg
8082                           "Exclude author (regexp): "
8083                         "Limit to author (regexp): "))
8084          current-prefix-arg))
8085   (gnus-summary-limit-to-subject from "from" not-matching))
8086
8087 (defun gnus-summary-limit-to-recipient (recipient &optional not-matching)
8088   "Limit the summary buffer to articles with the given RECIPIENT.
8089
8090 If NOT-MATCHING, exclude RECIPIENT.
8091
8092 To and Cc headers are checked.  You need to include them in
8093 `nnmail-extra-headers'."
8094   ;; Unlike `rmail-summary-by-recipients', doesn't include From.
8095   (interactive
8096    (list (read-string (format "%s recipient (regexp): "
8097                               (if current-prefix-arg "Exclude" "Limit to")))
8098          current-prefix-arg))
8099   (when (not (equal "" recipient))
8100     (prog1 (let* ((to
8101                    (if (memq 'To nnmail-extra-headers)
8102                        (gnus-summary-find-matching
8103                         (cons 'extra 'To) recipient 'all nil nil
8104                         not-matching)
8105                      (gnus-message
8106                       1 "`To' isn't present in `nnmail-extra-headers'")
8107                      (sit-for 1)
8108                      nil))
8109                   (cc
8110                    (if (memq 'Cc nnmail-extra-headers)
8111                        (gnus-summary-find-matching
8112                         (cons 'extra 'Cc) recipient 'all nil nil
8113                         not-matching)
8114                      (gnus-message
8115                       1 "`Cc' isn't present in `nnmail-extra-headers'")
8116                      (sit-for 1)
8117                      nil))
8118                   (articles
8119                    (if not-matching
8120                        ;; We need the numbers that are in both lists:
8121                        (mapcar (lambda (a)
8122                                  (and (memq a to) a))
8123                                cc)
8124                      (nconc to cc))))
8125              (unless articles
8126                (error "Found no matches for \"%s\"" recipient))
8127              (gnus-summary-limit articles))
8128       (gnus-summary-position-point))))
8129
8130 (defun gnus-summary-limit-to-address (address &optional not-matching)
8131   "Limit the summary buffer to articles with the given ADDRESS.
8132
8133 If NOT-MATCHING, exclude ADDRESS.
8134
8135 To, Cc and From headers are checked.  You need to include `To' and `Cc'
8136 in `nnmail-extra-headers'."
8137   (interactive
8138    (list (read-string (format "%s address (regexp): "
8139                               (if current-prefix-arg "Exclude" "Limit to")))
8140          current-prefix-arg))
8141   (when (not (equal "" address))
8142     (prog1 (let* ((to
8143                    (if (memq 'To nnmail-extra-headers)
8144                        (gnus-summary-find-matching
8145                         (cons 'extra 'To) address 'all nil nil
8146                         not-matching)
8147                      (gnus-message
8148                       1 "`To' isn't present in `nnmail-extra-headers'")
8149                      (sit-for 1)
8150                      t))
8151                   (cc
8152                    (if (memq 'Cc nnmail-extra-headers)
8153                        (gnus-summary-find-matching
8154                         (cons 'extra 'Cc) address 'all nil nil
8155                         not-matching)
8156                      (gnus-message
8157                       1 "`Cc' isn't present in `nnmail-extra-headers'")
8158                      (sit-for 1)
8159                      t))
8160                   (from
8161                    (gnus-summary-find-matching "from" address
8162                                                'all nil nil not-matching))
8163                   (articles
8164                    (if not-matching
8165                        ;; We need the numbers that are in all lists:
8166                        (if (eq cc t)
8167                            (if (eq to t)
8168                                from
8169                              (mapcar (lambda (a) (car (memq a from))) to))
8170                          (if (eq to t)
8171                              (mapcar (lambda (a) (car (memq a from))) cc)
8172                            (mapcar (lambda (a) (car (memq a from)))
8173                                    (mapcar (lambda (a) (car (memq a to)))
8174                                            cc))))
8175                      (nconc (if (eq to t) nil to)
8176                             (if (eq cc t) nil cc)
8177                             from))))
8178              (unless articles
8179                (error "Found no matches for \"%s\"" address))
8180              (gnus-summary-limit articles))
8181       (gnus-summary-position-point))))
8182
8183 (defun gnus-summary-limit-strange-charsets-predicate (header)
8184   (when (fboundp 'char-charset)
8185     (let ((string (concat (mail-header-subject header)
8186                           (mail-header-from header)))
8187           charset found)
8188       (dotimes (i (1- (length string)))
8189         (setq charset (format "%s" (char-charset (aref string (1+ i)))))
8190         (when (string-match "unicode\\|big\\|japanese" charset)
8191           (setq found t)))
8192       found)))
8193
8194 (defun gnus-summary-limit-to-predicate (predicate)
8195   "Limit to articles where PREDICATE returns non-nil.
8196 PREDICATE will be called with the header structures of the
8197 articles."
8198   (let ((articles nil)
8199         (case-fold-search t))
8200     (dolist (header gnus-newsgroup-headers)
8201       (when (funcall predicate header)
8202         (push (mail-header-number header) articles)))
8203     (gnus-summary-limit (nreverse articles))))
8204
8205 (defun gnus-summary-limit-to-age (age &optional younger-p)
8206   "Limit the summary buffer to articles that are older than (or equal) AGE days.
8207 If YOUNGER-P (the prefix) is non-nil, limit the summary buffer to
8208 articles that are younger than AGE days."
8209   (interactive
8210    (let ((younger current-prefix-arg)
8211          (days-got nil)
8212          days)
8213      (while (not days-got)
8214        (setq days (if younger
8215                       (read-string "Limit to articles younger than (in days, older when negative): ")
8216                     (read-string
8217                      "Limit to articles older than (in days, younger when negative): ")))
8218        (when (> (length days) 0)
8219          (setq days (read days)))
8220        (if (numberp days)
8221            (progn
8222              (setq days-got t)
8223              (when (< days 0)
8224                (setq younger (not younger))
8225                (setq days (* days -1))))
8226          (message "Please enter a number.")
8227          (sleep-for 1)))
8228      (list days younger)))
8229   (prog1
8230       (let ((data gnus-newsgroup-data)
8231             (cutoff (days-to-time age))
8232             articles d date is-younger)
8233         (while (setq d (pop data))
8234           (when (and (vectorp (gnus-data-header d))
8235                      (setq date (mail-header-date (gnus-data-header d))))
8236             (setq is-younger (time-less-p
8237                               (time-since (gnus-date-get-time date))
8238                               cutoff))
8239             (when (if younger-p
8240                       is-younger
8241                     (not is-younger))
8242               (push (gnus-data-number d) articles))))
8243         (gnus-summary-limit (nreverse articles)))
8244     (gnus-summary-position-point)))
8245
8246 (defun gnus-summary-limit-to-extra (header regexp &optional not-matching)
8247   "Limit the summary buffer to articles that match an 'extra' header."
8248   (interactive
8249    (let ((header
8250           (intern
8251            (gnus-completing-read-with-default
8252             (symbol-name (car gnus-extra-headers))
8253             (if current-prefix-arg
8254                 "Exclude extra header"
8255               "Limit extra header")
8256             (mapcar (lambda (x)
8257                       (cons (symbol-name x) x))
8258                     gnus-extra-headers)
8259             nil
8260             t))))
8261      (list header
8262            (read-string (format "%s header %s (regexp): "
8263                                 (if current-prefix-arg "Exclude" "Limit to")
8264                                 header))
8265            current-prefix-arg)))
8266   (when (not (equal "" regexp))
8267     (prog1
8268         (let ((articles (gnus-summary-find-matching
8269                          (cons 'extra header) regexp 'all nil nil
8270                          not-matching)))
8271           (unless articles
8272             (error "Found no matches for \"%s\"" regexp))
8273           (gnus-summary-limit articles))
8274       (gnus-summary-position-point))))
8275
8276 (defun gnus-summary-limit-to-display-predicate ()
8277   "Limit the summary buffer to the predicated in the `display' group parameter."
8278   (interactive)
8279   (unless gnus-newsgroup-display
8280     (error "There is no `display' group parameter"))
8281   (let (articles)
8282     (dolist (number gnus-newsgroup-articles)
8283       (when (funcall gnus-newsgroup-display)
8284         (push number articles)))
8285     (gnus-summary-limit articles))
8286   (gnus-summary-position-point))
8287
8288 (defalias 'gnus-summary-delete-marked-as-read 'gnus-summary-limit-to-unread)
8289 (make-obsolete
8290  'gnus-summary-delete-marked-as-read 'gnus-summary-limit-to-unread "Emacs 20.4")
8291
8292 (defun gnus-summary-limit-to-unread (&optional all)
8293   "Limit the summary buffer to articles that are not marked as read.
8294 If ALL is non-nil, limit strictly to unread articles."
8295   (interactive "P")
8296   (if all
8297       (gnus-summary-limit-to-marks (char-to-string gnus-unread-mark))
8298     (gnus-summary-limit-to-marks
8299      ;; Concat all the marks that say that an article is read and have
8300      ;; those removed.
8301      (list gnus-del-mark gnus-read-mark gnus-ancient-mark
8302            gnus-killed-mark gnus-spam-mark gnus-kill-file-mark
8303            gnus-low-score-mark gnus-expirable-mark
8304            gnus-canceled-mark gnus-catchup-mark gnus-sparse-mark
8305            gnus-duplicate-mark)
8306      'reverse)))
8307
8308 (defun gnus-summary-limit-to-headers (match &optional reverse)
8309   "Limit the summary buffer to articles that have headers that match MATCH.
8310 If REVERSE (the prefix), limit to articles that don't match."
8311   (interactive "sMatch headers (regexp): \nP")
8312   (gnus-summary-limit-to-bodies match reverse t))
8313
8314 (defun gnus-summary-limit-to-bodies (match &optional reverse headersp)
8315   "Limit the summary buffer to articles that have bodies that match MATCH.
8316 If REVERSE (the prefix), limit to articles that don't match."
8317   (interactive "sMatch body (regexp): \nP")
8318   (let ((articles nil)
8319         (gnus-select-article-hook nil)  ;Disable hook.
8320         (gnus-article-prepare-hook nil)
8321         (gnus-use-article-prefetch nil)
8322         (gnus-keep-backlog nil)
8323         (gnus-break-pages nil)
8324         (gnus-summary-display-arrow nil)
8325         (gnus-updated-mode-lines nil)
8326         (gnus-auto-center-summary nil)
8327         (gnus-display-mime-function nil))
8328     (dolist (data gnus-newsgroup-data)
8329       (let (gnus-mark-article-hook)
8330         (gnus-summary-select-article t t nil (gnus-data-number data)))
8331       (with-current-buffer gnus-article-buffer
8332         (article-goto-body)
8333         (let* ((case-fold-search t)
8334                (found (if headersp
8335                           (re-search-backward match nil t)
8336                         (re-search-forward match nil t))))
8337           (when (or (and found
8338                          (not reverse))
8339                     (and (not found)
8340                          reverse))
8341             (push (gnus-data-number data) articles)))))
8342     (if (not articles)
8343         (message "No messages matched")
8344       (gnus-summary-limit articles)))
8345   (gnus-summary-position-point))
8346
8347 (defun gnus-summary-limit-to-singletons (&optional threadsp)
8348   "Limit the summary buffer to articles that aren't part on any thread.
8349 If THREADSP (the prefix), limit to articles that are in threads."
8350   (interactive "P")
8351   (let ((articles nil)
8352         thread-articles
8353         threads)
8354     (dolist (thread gnus-newsgroup-threads)
8355       (if (stringp (car thread))
8356           (dolist (thread (cdr thread))
8357             (push thread threads))
8358         (push thread threads)))
8359     (dolist (thread threads)
8360       (setq thread-articles (gnus-articles-in-thread thread))
8361       (when (or (and threadsp
8362                      (> (length thread-articles) 1))
8363                 (and (not threadsp)
8364                      (= (length thread-articles) 1)))
8365         (setq articles (nconc thread-articles articles))))
8366     (if (not articles)
8367         (message "No messages matched")
8368       (gnus-summary-limit articles))
8369     (gnus-summary-position-point)))
8370
8371 (defun gnus-summary-limit-to-replied (&optional unreplied)
8372   "Limit the summary buffer to replied articles.
8373 If UNREPLIED (the prefix), limit to unreplied articles."
8374   (interactive "P")
8375   (if unreplied
8376       (gnus-summary-limit
8377        (gnus-set-difference gnus-newsgroup-articles
8378         gnus-newsgroup-replied))
8379     (gnus-summary-limit gnus-newsgroup-replied))
8380   (gnus-summary-position-point))
8381
8382 (defalias 'gnus-summary-delete-marked-with 'gnus-summary-limit-exclude-marks)
8383 (make-obsolete 'gnus-summary-delete-marked-with
8384                'gnus-summary-limit-exclude-marks "Emacs 20.4")
8385
8386 (defun gnus-summary-limit-exclude-marks (marks &optional reverse)
8387   "Exclude articles that are marked with MARKS (e.g. \"DK\").
8388 If REVERSE, limit the summary buffer to articles that are marked
8389 with MARKS.  MARKS can either be a string of marks or a list of marks.
8390 Returns how many articles were removed."
8391   (interactive "sMarks: ")
8392   (gnus-summary-limit-to-marks marks t))
8393
8394 (defun gnus-summary-limit-to-marks (marks &optional reverse)
8395   "Limit the summary buffer to articles that are marked with MARKS (e.g. \"DK\").
8396 If REVERSE (the prefix), limit the summary buffer to articles that are
8397 not marked with MARKS.  MARKS can either be a string of marks or a
8398 list of marks.
8399 Returns how many articles were removed."
8400   (interactive "sMarks: \nP")
8401   (prog1
8402       (let ((data gnus-newsgroup-data)
8403             (marks (if (listp marks) marks
8404                      (append marks nil))) ; Transform to list.
8405             articles)
8406         (while data
8407           (when (if reverse (not (memq (gnus-data-mark (car data)) marks))
8408                   (memq (gnus-data-mark (car data)) marks))
8409             (push (gnus-data-number (car data)) articles))
8410           (setq data (cdr data)))
8411         (gnus-summary-limit articles))
8412     (gnus-summary-position-point)))
8413
8414 (defun gnus-summary-limit-to-score (score)
8415   "Limit to articles with score at or above SCORE."
8416   (interactive "NLimit to articles with score of at least: ")
8417   (let ((data gnus-newsgroup-data)
8418         articles)
8419     (while data
8420       (when (>= (gnus-summary-article-score (gnus-data-number (car data)))
8421                 score)
8422         (push (gnus-data-number (car data)) articles))
8423       (setq data (cdr data)))
8424     (prog1
8425         (gnus-summary-limit articles)
8426       (gnus-summary-position-point))))
8427
8428 (defun gnus-summary-limit-to-unseen ()
8429   "Limit to unseen articles."
8430   (interactive)
8431   (prog1
8432       (gnus-summary-limit gnus-newsgroup-unseen)
8433     (gnus-summary-position-point)))
8434
8435 (defun gnus-summary-limit-include-thread (id)
8436   "Display all the hidden articles that is in the thread with ID in it.
8437 When called interactively, ID is the Message-ID of the current
8438 article."
8439   (interactive (list (mail-header-id (gnus-summary-article-header))))
8440   (let ((articles (gnus-articles-in-thread
8441                    (gnus-id-to-thread (gnus-root-id id)))))
8442     (prog1
8443         (gnus-summary-limit (nconc articles gnus-newsgroup-limit))
8444       (gnus-summary-limit-include-matching-articles
8445        "subject"
8446        (regexp-quote (gnus-simplify-subject-re
8447                       (mail-header-subject (gnus-id-to-header id)))))
8448       (gnus-summary-position-point))))
8449
8450 (defun gnus-summary-limit-include-matching-articles (header regexp)
8451   "Display all the hidden articles that have HEADERs that match REGEXP."
8452   (interactive (list (read-string "Match on header: ")
8453                      (read-string "Regexp: ")))
8454   (let ((articles (gnus-find-matching-articles header regexp)))
8455     (prog1
8456         (gnus-summary-limit (nconc articles gnus-newsgroup-limit))
8457       (gnus-summary-position-point))))
8458
8459 (defun gnus-summary-insert-dormant-articles ()
8460   "Insert all the dormant articles for this group into the current buffer."
8461   (interactive)
8462   (let ((gnus-verbose (max 6 gnus-verbose)))
8463     (if (not gnus-newsgroup-dormant)
8464         (gnus-message 3 "No dormant articles for this group")
8465       (gnus-summary-goto-subjects gnus-newsgroup-dormant))))
8466
8467 (defun gnus-summary-insert-ticked-articles ()
8468   "Insert ticked articles for this group into the current buffer."
8469   (interactive)
8470   (let ((gnus-verbose (max 6 gnus-verbose)))
8471     (if (not gnus-newsgroup-marked)
8472         (gnus-message 3 "No ticked articles for this group")
8473       (gnus-summary-goto-subjects gnus-newsgroup-marked))))
8474
8475 (defun gnus-summary-limit-include-dormant ()
8476   "Display all the hidden articles that are marked as dormant.
8477 Note that this command only works on a subset of the articles currently
8478 fetched for this group."
8479   (interactive)
8480   (unless gnus-newsgroup-dormant
8481     (error "There are no dormant articles in this group"))
8482   (prog1
8483       (gnus-summary-limit (append gnus-newsgroup-dormant gnus-newsgroup-limit))
8484     (gnus-summary-position-point)))
8485
8486 (defun gnus-summary-limit-exclude-dormant ()
8487   "Hide all dormant articles."
8488   (interactive)
8489   (prog1
8490       (gnus-summary-limit-to-marks (list gnus-dormant-mark) 'reverse)
8491     (gnus-summary-position-point)))
8492
8493 (defun gnus-summary-limit-exclude-childless-dormant ()
8494   "Hide all dormant articles that have no children."
8495   (interactive)
8496   (let ((data (gnus-data-list t))
8497         articles d children)
8498     ;; Find all articles that are either not dormant or have
8499     ;; children.
8500     (while (setq d (pop data))
8501       (when (or (not (= (gnus-data-mark d) gnus-dormant-mark))
8502                 (and (setq children
8503                            (gnus-article-children (gnus-data-number d)))
8504                      (let (found)
8505                        (while children
8506                          (when (memq (car children) articles)
8507                            (setq children nil
8508                                  found t))
8509                          (pop children))
8510                        found)))
8511         (push (gnus-data-number d) articles)))
8512     ;; Do the limiting.
8513     (prog1
8514         (gnus-summary-limit articles)
8515       (gnus-summary-position-point))))
8516
8517 (defun gnus-summary-limit-mark-excluded-as-read (&optional all)
8518   "Mark all unread excluded articles as read.
8519 If ALL, mark even excluded ticked and dormants as read."
8520   (interactive "P")
8521   (setq gnus-newsgroup-limit (sort gnus-newsgroup-limit '<))
8522   (let ((articles (gnus-sorted-ndifference
8523                    (sort
8524                     (mapcar (lambda (h) (mail-header-number h))
8525                             gnus-newsgroup-headers)
8526                     '<)
8527                    gnus-newsgroup-limit))
8528         article)
8529     (setq gnus-newsgroup-unreads
8530           (gnus-sorted-intersection gnus-newsgroup-unreads
8531                                     gnus-newsgroup-limit))
8532     (if all
8533         (setq gnus-newsgroup-dormant nil
8534               gnus-newsgroup-marked nil
8535               gnus-newsgroup-reads
8536               (nconc
8537                (mapcar (lambda (n) (cons n gnus-catchup-mark)) articles)
8538                gnus-newsgroup-reads))
8539       (while (setq article (pop articles))
8540         (unless (or (memq article gnus-newsgroup-dormant)
8541                     (memq article gnus-newsgroup-marked))
8542           (push (cons article gnus-catchup-mark) gnus-newsgroup-reads))))))
8543
8544 (defun gnus-summary-limit (articles &optional pop)
8545   (if pop
8546       ;; We pop the previous limit off the stack and use that.
8547       (setq articles (car gnus-newsgroup-limits)
8548             gnus-newsgroup-limits (cdr gnus-newsgroup-limits))
8549     ;; We use the new limit, so we push the old limit on the stack.
8550     (push gnus-newsgroup-limit gnus-newsgroup-limits))
8551   ;; Set the limit.
8552   (setq gnus-newsgroup-limit articles)
8553   (let ((total (length gnus-newsgroup-data))
8554         (data (gnus-data-find-list (gnus-summary-article-number)))
8555         (gnus-summary-mark-below nil)   ; Inhibit this.
8556         found)
8557     ;; This will do all the work of generating the new summary buffer
8558     ;; according to the new limit.
8559     (gnus-summary-prepare)
8560     ;; Hide any threads, possibly.
8561     (gnus-summary-maybe-hide-threads)
8562     ;; Try to return to the article you were at, or one in the
8563     ;; neighborhood.
8564     (when data
8565       ;; We try to find some article after the current one.
8566       (while data
8567         (when (gnus-summary-goto-subject (gnus-data-number (car data)) nil t)
8568           (setq data nil
8569                 found t))
8570         (setq data (cdr data))))
8571     (unless found
8572       ;; If there is no data, that means that we were after the last
8573       ;; article.  The same goes when we can't find any articles
8574       ;; after the current one.
8575       (goto-char (point-max))
8576       (gnus-summary-find-prev))
8577     (gnus-set-mode-line 'summary)
8578     ;; We return how many articles were removed from the summary
8579     ;; buffer as a result of the new limit.
8580     (- total (length gnus-newsgroup-data))))
8581
8582 (defsubst gnus-invisible-cut-children (threads)
8583   (let ((num 0))
8584     (while threads
8585       (when (memq (mail-header-number (caar threads)) gnus-newsgroup-limit)
8586         (incf num))
8587       (pop threads))
8588     (< num 2)))
8589
8590 (defsubst gnus-cut-thread (thread)
8591   "Go forwards in the thread until we find an article that we want to display."
8592   (when (or (eq gnus-fetch-old-headers 'some)
8593             (eq gnus-fetch-old-headers 'invisible)
8594             (numberp gnus-fetch-old-headers)
8595             (eq gnus-build-sparse-threads 'some)
8596             (eq gnus-build-sparse-threads 'more))
8597     ;; Deal with old-fetched headers and sparse threads.
8598     (while (and
8599             thread
8600             (or
8601              (gnus-summary-article-sparse-p (mail-header-number (car thread)))
8602              (gnus-summary-article-ancient-p
8603               (mail-header-number (car thread))))
8604             (if (or (<= (length (cdr thread)) 1)
8605                     (eq gnus-fetch-old-headers 'invisible))
8606                 (setq gnus-newsgroup-limit
8607                       (delq (mail-header-number (car thread))
8608                             gnus-newsgroup-limit)
8609                       thread (cadr thread))
8610               (when (gnus-invisible-cut-children (cdr thread))
8611                 (let ((th (cdr thread)))
8612                   (while th
8613                     (if (memq (mail-header-number (caar th))
8614                               gnus-newsgroup-limit)
8615                         (setq thread (car th)
8616                               th nil)
8617                       (setq th (cdr th))))))))))
8618   thread)
8619
8620 (defun gnus-cut-threads (threads)
8621   "Cut off all uninteresting articles from the beginning of THREADS."
8622   (when (or (eq gnus-fetch-old-headers 'some)
8623             (eq gnus-fetch-old-headers 'invisible)
8624             (numberp gnus-fetch-old-headers)
8625             (eq gnus-build-sparse-threads 'some)
8626             (eq gnus-build-sparse-threads 'more))
8627     (let ((th threads))
8628       (while th
8629         (setcar th (gnus-cut-thread (car th)))
8630         (setq th (cdr th)))))
8631   ;; Remove nixed out threads.
8632   (delq nil threads))
8633
8634 (defun gnus-summary-initial-limit (&optional show-if-empty)
8635   "Figure out what the initial limit is supposed to be on group entry.
8636 This entails weeding out unwanted dormants, low-scored articles,
8637 fetch-old-headers verbiage, and so on."
8638   ;; Most groups have nothing to remove.
8639   (unless (or gnus-inhibit-limiting
8640               (and (null gnus-newsgroup-dormant)
8641                    (eq gnus-newsgroup-display 'gnus-not-ignore)
8642                    (not (eq gnus-fetch-old-headers 'some))
8643                    (not (numberp gnus-fetch-old-headers))
8644                    (not (eq gnus-fetch-old-headers 'invisible))
8645                    (null gnus-summary-expunge-below)
8646                    (not (eq gnus-build-sparse-threads 'some))
8647                    (not (eq gnus-build-sparse-threads 'more))
8648                    (null gnus-thread-expunge-below)
8649                    (not gnus-use-nocem)))
8650     (push gnus-newsgroup-limit gnus-newsgroup-limits)
8651     (setq gnus-newsgroup-limit nil)
8652     (mapatoms
8653      (lambda (node)
8654        (unless (car (symbol-value node))
8655          ;; These threads have no parents -- they are roots.
8656          (let ((nodes (cdr (symbol-value node)))
8657                thread)
8658            (while nodes
8659              (if (and gnus-thread-expunge-below
8660                       (< (gnus-thread-total-score (car nodes))
8661                          gnus-thread-expunge-below))
8662                  (gnus-expunge-thread (pop nodes))
8663                (setq thread (pop nodes))
8664                (gnus-summary-limit-children thread))))))
8665      gnus-newsgroup-dependencies)
8666     ;; If this limitation resulted in an empty group, we might
8667     ;; pop the previous limit and use it instead.
8668     (when (and (not gnus-newsgroup-limit)
8669                show-if-empty)
8670       (setq gnus-newsgroup-limit (pop gnus-newsgroup-limits)))
8671     gnus-newsgroup-limit))
8672
8673 (defun gnus-summary-limit-children (thread)
8674   "Return 1 if this subthread is visible and 0 if it is not."
8675   ;; First we get the number of visible children to this thread.  This
8676   ;; is done by recursing down the thread using this function, so this
8677   ;; will really go down to a leaf article first, before slowly
8678   ;; working its way up towards the root.
8679   (when thread
8680     (let* ((max-lisp-eval-depth (max 5000 max-lisp-eval-depth))
8681            (children
8682            (if (cdr thread)
8683                (apply '+ (mapcar 'gnus-summary-limit-children
8684                                  (cdr thread)))
8685              0))
8686           (number (mail-header-number (car thread)))
8687           score)
8688       (if (and
8689            (not (memq number gnus-newsgroup-marked))
8690            (or
8691             ;; If this article is dormant and has absolutely no visible
8692             ;; children, then this article isn't visible.
8693             (and (memq number gnus-newsgroup-dormant)
8694                  (zerop children))
8695             ;; If this is "fetch-old-headered" and there is no
8696             ;; visible children, then we don't want this article.
8697             (and (or (eq gnus-fetch-old-headers 'some)
8698                      (numberp gnus-fetch-old-headers))
8699                  (gnus-summary-article-ancient-p number)
8700                  (zerop children))
8701             ;; If this is "fetch-old-headered" and `invisible', then
8702             ;; we don't want this article.
8703             (and (eq gnus-fetch-old-headers 'invisible)
8704                  (gnus-summary-article-ancient-p number))
8705             ;; If this is a sparsely inserted article with no children,
8706             ;; we don't want it.
8707             (and (eq gnus-build-sparse-threads 'some)
8708                  (gnus-summary-article-sparse-p number)
8709                  (zerop children))
8710             ;; If we use expunging, and this article is really
8711             ;; low-scored, then we don't want this article.
8712             (when (and gnus-summary-expunge-below
8713                        (< (setq score
8714                                 (or (cdr (assq number gnus-newsgroup-scored))
8715                                     gnus-summary-default-score))
8716                           gnus-summary-expunge-below))
8717               ;; We increase the expunge-tally here, but that has
8718               ;; nothing to do with the limits, really.
8719               (incf gnus-newsgroup-expunged-tally)
8720               ;; We also mark as read here, if that's wanted.
8721               (when (and gnus-summary-mark-below
8722                          (< score gnus-summary-mark-below))
8723                 (setq gnus-newsgroup-unreads
8724                       (delq number gnus-newsgroup-unreads))
8725                 (if gnus-newsgroup-auto-expire
8726                     (push number gnus-newsgroup-expirable)
8727                   (push (cons number gnus-low-score-mark)
8728                         gnus-newsgroup-reads)))
8729               t)
8730             ;; Do the `display' group parameter.
8731             (and gnus-newsgroup-display
8732                  (not (funcall gnus-newsgroup-display)))
8733             ;; Check NoCeM things.
8734             (when (and gnus-use-nocem
8735                        (gnus-nocem-unwanted-article-p
8736                         (mail-header-id (car thread))))
8737               (setq gnus-newsgroup-unreads
8738                     (delq number gnus-newsgroup-unreads))
8739               t)))
8740           ;; Nope, invisible article.
8741           0
8742         ;; Ok, this article is to be visible, so we add it to the limit
8743         ;; and return 1.
8744         (push number gnus-newsgroup-limit)
8745         1))))
8746
8747 (defun gnus-expunge-thread (thread)
8748   "Mark all articles in THREAD as read."
8749   (let* ((number (mail-header-number (car thread))))
8750     (incf gnus-newsgroup-expunged-tally)
8751     ;; We also mark as read here, if that's wanted.
8752     (setq gnus-newsgroup-unreads
8753           (delq number gnus-newsgroup-unreads))
8754     (if gnus-newsgroup-auto-expire
8755         (push number gnus-newsgroup-expirable)
8756       (push (cons number gnus-low-score-mark)
8757             gnus-newsgroup-reads)))
8758   ;; Go recursively through all subthreads.
8759   (mapcar 'gnus-expunge-thread (cdr thread)))
8760
8761 ;; Summary article oriented commands
8762
8763 (defun gnus-summary-refer-parent-article (n)
8764   "Refer parent article N times.
8765 If N is negative, go to ancestor -N instead.
8766 The difference between N and the number of articles fetched is returned."
8767   (interactive "p")
8768   (let ((skip 1)
8769         error header ref)
8770     (when (not (natnump n))
8771       (setq skip (abs n)
8772             n 1))
8773     (while (and (> n 0)
8774                 (not error))
8775       (setq header (gnus-summary-article-header))
8776       (if (and (eq (mail-header-number header)
8777                    (cdr gnus-article-current))
8778                (equal gnus-newsgroup-name
8779                       (car gnus-article-current)))
8780           ;; If we try to find the parent of the currently
8781           ;; displayed article, then we take a look at the actual
8782           ;; References header, since this is slightly more
8783           ;; reliable than the References field we got from the
8784           ;; server.
8785           (with-current-buffer gnus-original-article-buffer
8786             (nnheader-narrow-to-headers)
8787             (unless (setq ref (message-fetch-field "references"))
8788               (when (setq ref (message-fetch-field "in-reply-to"))
8789                 (setq ref (gnus-extract-message-id-from-in-reply-to ref))))
8790             (widen))
8791         (setq ref
8792               ;; It's not the current article, so we take a bet on
8793               ;; the value we got from the server.
8794               (mail-header-references header)))
8795       (if (and ref
8796                (not (equal ref "")))
8797           (unless (gnus-summary-refer-article (gnus-parent-id ref skip))
8798             (gnus-message 1 "Couldn't find parent"))
8799         (gnus-message 1 "No references in article %d"
8800                       (gnus-summary-article-number))
8801         (setq error t))
8802       (decf n))
8803     (gnus-summary-position-point)
8804     n))
8805
8806 (defun gnus-summary-refer-references ()
8807   "Fetch all articles mentioned in the References header.
8808 Return the number of articles fetched."
8809   (interactive)
8810   (let ((ref (mail-header-references (gnus-summary-article-header)))
8811         (current (gnus-summary-article-number))
8812         (n 0))
8813     (if (or (not ref)
8814             (equal ref ""))
8815         (error "No References in the current article")
8816       ;; For each Message-ID in the References header...
8817       (while (string-match "<[^>]*>" ref)
8818         (incf n)
8819         ;; ... fetch that article.
8820         (gnus-summary-refer-article
8821          (prog1 (match-string 0 ref)
8822            (setq ref (substring ref (match-end 0))))))
8823       (gnus-summary-goto-subject current)
8824       (gnus-summary-position-point)
8825       n)))
8826
8827 (defun gnus-summary-refer-thread (&optional limit)
8828   "Fetch all articles in the current thread.
8829 If LIMIT (the numerical prefix), fetch that many old headers instead
8830 of what's specified by the `gnus-refer-thread-limit' variable."
8831   (interactive "P")
8832   (let ((id (mail-header-id (gnus-summary-article-header)))
8833         (limit (if limit (prefix-numeric-value limit)
8834                  gnus-refer-thread-limit)))
8835     (unless (eq gnus-fetch-old-headers 'invisible)
8836       (gnus-message 5 "Fetching headers for %s..." gnus-newsgroup-name)
8837       ;; Retrieve the headers and read them in.
8838       (if (eq (if (numberp limit)
8839                   (gnus-retrieve-headers
8840                    (list (min
8841                           (+ (mail-header-number
8842                               (gnus-summary-article-header))
8843                              limit)
8844                           gnus-newsgroup-end))
8845                    gnus-newsgroup-name (* limit 2))
8846                 ;; gnus-refer-thread-limit is t, i.e. fetch _all_
8847                 ;; headers.
8848                 (gnus-retrieve-headers (list gnus-newsgroup-end)
8849                                        gnus-newsgroup-name limit))
8850               'nov)
8851           (gnus-build-all-threads)
8852         (error "Can't fetch thread from back ends that don't support NOV"))
8853       (gnus-message 5 "Fetching headers for %s...done" gnus-newsgroup-name))
8854     (gnus-summary-limit-include-thread id)))
8855
8856 (defun gnus-summary-refer-article (message-id)
8857   "Fetch an article specified by MESSAGE-ID."
8858   (interactive "sMessage-ID: ")
8859   (when (and (stringp message-id)
8860              (not (zerop (length message-id))))
8861     (setq message-id (gnus-replace-in-string message-id " " ""))
8862     ;; Construct the correct Message-ID if necessary.
8863     ;; Suggested by tale@pawl.rpi.edu.
8864     (unless (string-match "^<" message-id)
8865       (setq message-id (concat "<" message-id)))
8866     (unless (string-match ">$" message-id)
8867       (setq message-id (concat message-id ">")))
8868     ;; People often post MIDs from URLs, so unhex it:
8869     (unless (string-match "@" message-id)
8870       (setq message-id (gnus-url-unhex-string message-id)))
8871     (let* ((header (gnus-id-to-header message-id))
8872            (sparse (and header
8873                         (gnus-summary-article-sparse-p
8874                          (mail-header-number header))
8875                         (memq (mail-header-number header)
8876                               gnus-newsgroup-limit)))
8877            number)
8878       (cond
8879        ;; If the article is present in the buffer we just go to it.
8880        ((and header
8881              (or (not (gnus-summary-article-sparse-p
8882                        (mail-header-number header)))
8883                  sparse))
8884         (prog1
8885             (gnus-summary-goto-article
8886              (mail-header-number header) nil t)
8887           (when sparse
8888             (gnus-summary-update-article (mail-header-number header)))))
8889        (t
8890         ;; We fetch the article.
8891         (catch 'found
8892           (dolist (gnus-override-method (gnus-refer-article-methods))
8893             (when (and (gnus-check-server gnus-override-method)
8894                        ;; Fetch the header,
8895                        (setq number (gnus-summary-insert-subject message-id)))
8896               ;; and display the article.
8897               (gnus-summary-select-article nil nil nil number)
8898               (throw 'found t)))
8899           (gnus-message 3 "Couldn't fetch article %s" message-id)))))))
8900
8901 (defun gnus-refer-article-methods ()
8902   "Return a list of referable methods."
8903   (cond
8904    ;; No method, so we default to current and native.
8905    ((null gnus-refer-article-method)
8906     (list gnus-current-select-method gnus-select-method))
8907    ;; Current.
8908    ((eq 'current gnus-refer-article-method)
8909     (list gnus-current-select-method))
8910    ;; List of select methods.
8911    ((not (and (symbolp (car gnus-refer-article-method))
8912               (assq (car gnus-refer-article-method) nnoo-definition-alist)))
8913     (let (out)
8914       (dolist (method gnus-refer-article-method)
8915         (push (if (eq 'current method)
8916                   gnus-current-select-method
8917                 method)
8918               out))
8919       (nreverse out)))
8920    ;; One single select method.
8921    (t
8922     (list gnus-refer-article-method))))
8923
8924 (defun gnus-summary-edit-parameters ()
8925   "Edit the group parameters of the current group."
8926   (interactive)
8927   (gnus-group-edit-group gnus-newsgroup-name 'params))
8928
8929 (defun gnus-summary-customize-parameters ()
8930   "Customize the group parameters of the current group."
8931   (interactive)
8932   (gnus-group-customize gnus-newsgroup-name))
8933
8934 (defun gnus-summary-enter-digest-group (&optional force)
8935   "Enter an nndoc group based on the current article.
8936 If FORCE, force a digest interpretation.  If not, try
8937 to guess what the document format is."
8938   (interactive "P")
8939   (let ((conf gnus-current-window-configuration))
8940     (save-window-excursion
8941       (save-excursion
8942         (let (gnus-article-prepare-hook
8943               gnus-display-mime-function
8944               gnus-break-pages)
8945           (gnus-summary-select-article))))
8946     (setq gnus-current-window-configuration conf)
8947     (let* ((name (format "%s-%d"
8948                          (gnus-group-prefixed-name
8949                           gnus-newsgroup-name (list 'nndoc ""))
8950                          (with-current-buffer gnus-summary-buffer
8951                            gnus-current-article)))
8952            (ogroup gnus-newsgroup-name)
8953            (params (append (gnus-info-params (gnus-get-info ogroup))
8954                            (list (cons 'to-group ogroup))
8955                            (list (cons 'parent-group ogroup))
8956                            (list (cons 'save-article-group ogroup))))
8957            (case-fold-search t)
8958            (buf (current-buffer))
8959            dig to-address)
8960       (with-current-buffer gnus-original-article-buffer
8961         ;; Have the digest group inherit the main mail address of
8962         ;; the parent article.
8963         (when (setq to-address (or (gnus-fetch-field "reply-to")
8964                                    (gnus-fetch-field "from")))
8965           (setq params
8966                 (append
8967                  (list (cons 'to-address
8968                              (funcall gnus-decode-encoded-address-function
8969                                       to-address))))))
8970         (setq dig (nnheader-set-temp-buffer " *gnus digest buffer*"))
8971         (insert-buffer-substring gnus-original-article-buffer)
8972         ;; Remove lines that may lead nndoc to misinterpret the
8973         ;; document type.
8974         (narrow-to-region
8975          (goto-char (point-min))
8976          (or (search-forward "\n\n" nil t) (point)))
8977         (goto-char (point-min))
8978         (delete-matching-lines "^Path:\\|^From ")
8979         (widen))
8980       (unwind-protect
8981           (if (let ((gnus-newsgroup-ephemeral-charset gnus-newsgroup-charset)
8982                     (gnus-newsgroup-ephemeral-ignored-charsets
8983                      gnus-newsgroup-ignored-charsets))
8984                 (gnus-group-read-ephemeral-group
8985                  name `(nndoc ,name (nndoc-address ,(get-buffer dig))
8986                               (nndoc-article-type
8987                                ,(if force 'mbox 'guess)))
8988                  t nil nil nil
8989                  `((adapt-file . ,(gnus-score-file-name gnus-newsgroup-name
8990                                                         "ADAPT")))))
8991               ;; Make all postings to this group go to the parent group.
8992               (nconc (gnus-info-params (gnus-get-info name))
8993                      params)
8994             ;; Couldn't select this doc group.
8995             (switch-to-buffer buf)
8996             (gnus-set-global-variables)
8997             (gnus-configure-windows 'summary)
8998             (gnus-message 3 "Article couldn't be entered?"))
8999         (kill-buffer dig)))))
9000
9001 (defun gnus-summary-read-document (n)
9002   "Open a new group based on the current article(s).
9003 This will allow you to read digests and other similar
9004 documents as newsgroups.
9005 Obeys the standard process/prefix convention."
9006   (interactive "P")
9007   (let* ((ogroup gnus-newsgroup-name)
9008          (params (append (gnus-info-params (gnus-get-info ogroup))
9009                          (list (cons 'to-group ogroup))))
9010          group egroup groups vgroup)
9011     (dolist (article (gnus-summary-work-articles n))
9012       (setq group (format "%s-%d" gnus-newsgroup-name article))
9013       (gnus-summary-remove-process-mark article)
9014       (when (gnus-summary-display-article article)
9015         (save-excursion ;;What for?
9016           (with-temp-buffer
9017             (insert-buffer-substring gnus-original-article-buffer)
9018             ;; Remove some headers that may lead nndoc to make
9019             ;; the wrong guess.
9020             (message-narrow-to-head)
9021             (goto-char (point-min))
9022             (delete-matching-lines "^Path:\\|^From ")
9023             (widen)
9024             (if (setq egroup
9025                       (gnus-group-read-ephemeral-group
9026                        group `(nndoc ,group (nndoc-address ,(current-buffer))
9027                                      (nndoc-article-type guess))
9028                        t nil t))
9029                 (progn
9030                   ;; Make all postings to this group go to the parent group.
9031                   (nconc (gnus-info-params (gnus-get-info egroup))
9032                          params)
9033                   (push egroup groups))
9034               ;; Couldn't select this doc group.
9035               (gnus-error 3 "Article couldn't be entered"))))))
9036     ;; Now we have selected all the documents.
9037     (cond
9038      ((not groups)
9039       (error "None of the articles could be interpreted as documents"))
9040      ((gnus-group-read-ephemeral-group
9041        (setq vgroup (format
9042                      "nnvirtual:%s-%s" gnus-newsgroup-name
9043                      (format-time-string "%Y%m%dT%H%M%S" (current-time))))
9044        `(nnvirtual ,vgroup (nnvirtual-component-groups ,groups))
9045        t
9046        (cons (current-buffer) 'summary)))
9047      (t
9048       (error "Couldn't select virtual nndoc group")))))
9049
9050 (defun gnus-summary-isearch-article (&optional regexp-p)
9051   "Do incremental search forward on the current article.
9052 If REGEXP-P (the prefix) is non-nil, do regexp isearch."
9053   (interactive "P")
9054   (gnus-summary-select-article)
9055   (gnus-configure-windows 'article)
9056   (gnus-eval-in-buffer-window gnus-article-buffer
9057     (save-restriction
9058       (widen)
9059       (isearch-forward regexp-p))))
9060
9061 (defun gnus-summary-repeat-search-article-forward ()
9062   "Repeat the previous search forwards."
9063   (interactive)
9064   (unless gnus-last-search-regexp
9065     (error "No previous search"))
9066   (gnus-summary-search-article-forward gnus-last-search-regexp))
9067
9068 (defun gnus-summary-repeat-search-article-backward ()
9069   "Repeat the previous search backwards."
9070   (interactive)
9071   (unless gnus-last-search-regexp
9072     (error "No previous search"))
9073   (gnus-summary-search-article-forward gnus-last-search-regexp t))
9074
9075 (defun gnus-summary-search-article-forward (regexp &optional backward)
9076   "Search for an article containing REGEXP forward.
9077 If BACKWARD, search backward instead."
9078   (interactive
9079    (list (read-string
9080           (format "Search article %s (regexp%s): "
9081                   (if current-prefix-arg "backward" "forward")
9082                   (if gnus-last-search-regexp
9083                       (concat ", default " gnus-last-search-regexp)
9084                     "")))
9085          current-prefix-arg))
9086   (if (string-equal regexp "")
9087       (setq regexp (or gnus-last-search-regexp ""))
9088     (setq gnus-last-search-regexp regexp)
9089     (setq gnus-article-before-search gnus-current-article))
9090   ;; Intentionally set gnus-last-article.
9091   (setq gnus-last-article gnus-article-before-search)
9092   (let ((gnus-last-article gnus-last-article))
9093     (if (gnus-summary-search-article regexp backward)
9094         (gnus-summary-show-thread)
9095       (signal 'search-failed (list regexp)))))
9096
9097 (defun gnus-summary-search-article-backward (regexp)
9098   "Search for an article containing REGEXP backward."
9099   (interactive
9100    (list (read-string
9101           (format "Search article backward (regexp%s): "
9102                   (if gnus-last-search-regexp
9103                       (concat ", default " gnus-last-search-regexp)
9104                     "")))))
9105   (gnus-summary-search-article-forward regexp 'backward))
9106
9107 (defun gnus-summary-search-article (regexp &optional backward)
9108   "Search for an article containing REGEXP.
9109 Optional argument BACKWARD means do search for backward.
9110 `gnus-select-article-hook' is not called during the search."
9111   ;; We have to require this here to make sure that the following
9112   ;; dynamic binding isn't shadowed by autoloading.
9113   (require 'gnus-async)
9114   (require 'gnus-art)
9115   (let ((gnus-select-article-hook nil)  ;Disable hook.
9116         (gnus-article-prepare-hook nil)
9117         (gnus-mark-article-hook nil)    ;Inhibit marking as read.
9118         (gnus-use-article-prefetch nil)
9119         (gnus-xmas-force-redisplay nil) ;Inhibit XEmacs redisplay.
9120         (gnus-use-trees nil)            ;Inhibit updating tree buffer.
9121         (gnus-visual nil)
9122         (gnus-keep-backlog nil)
9123         (gnus-break-pages nil)
9124         (gnus-summary-display-arrow nil)
9125         (gnus-updated-mode-lines nil)
9126         (gnus-auto-center-summary nil)
9127         (sum (current-buffer))
9128         (gnus-display-mime-function nil)
9129         (found nil)
9130         point)
9131     (gnus-save-hidden-threads
9132       (gnus-summary-select-article)
9133       (set-buffer gnus-article-buffer)
9134       (goto-char (window-point (get-buffer-window (current-buffer))))
9135       (when backward
9136         (forward-line -1))
9137       (while (not found)
9138         (gnus-message 7 "Searching article: %d..." (cdr gnus-article-current))
9139         (if (if backward
9140                 (re-search-backward regexp nil t)
9141               (re-search-forward regexp nil t))
9142             ;; We found the regexp.
9143             (progn
9144               (setq found 'found)
9145               (beginning-of-line)
9146               (set-window-start
9147                (get-buffer-window (current-buffer))
9148                (point))
9149               (forward-line 1)
9150               (set-window-point
9151                (get-buffer-window (current-buffer))
9152                (point))
9153               (set-buffer sum)
9154               (setq point (point)))
9155           ;; We didn't find it, so we go to the next article.
9156           (set-buffer sum)
9157           (setq found 'not)
9158           (while (eq found 'not)
9159             (if (not (if backward (gnus-summary-find-prev)
9160                        (gnus-summary-find-next)))
9161                 ;; No more articles.
9162                 (setq found t)
9163               ;; Select the next article and adjust point.
9164               (unless (gnus-summary-article-sparse-p
9165                        (gnus-summary-article-number))
9166                 (setq found nil)
9167                 (gnus-summary-select-article)
9168                 (set-buffer gnus-article-buffer)
9169                 (widen)
9170                 (goto-char (if backward (point-max) (point-min))))))))
9171       (gnus-message 7 ""))
9172     ;; Return whether we found the regexp.
9173     (when (eq found 'found)
9174       (goto-char point)
9175       (gnus-summary-show-thread)
9176       (gnus-summary-goto-subject gnus-current-article)
9177       (gnus-summary-position-point)
9178       t)))
9179
9180 (defun gnus-find-matching-articles (header regexp)
9181   "Return a list of all articles that match REGEXP on HEADER.
9182 This search includes all articles in the current group that Gnus has
9183 fetched headers for, whether they are displayed or not."
9184   (let ((articles nil)
9185         ;; Can't eta-reduce because it's a macro.
9186         (func `(lambda (h) (,(intern (concat "mail-header-" header)) h)))
9187         (case-fold-search t))
9188     (dolist (header gnus-newsgroup-headers)
9189       (when (string-match regexp (funcall func header))
9190         (push (mail-header-number header) articles)))
9191     (nreverse articles)))
9192
9193 (defun gnus-summary-find-matching (header regexp &optional backward unread
9194                                           not-case-fold not-matching)
9195   "Return a list of all articles that match REGEXP on HEADER.
9196 The search stars on the current article and goes forwards unless
9197 BACKWARD is non-nil.  If BACKWARD is `all', do all articles.
9198 If UNREAD is non-nil, only unread articles will
9199 be taken into consideration.  If NOT-CASE-FOLD, case won't be folded
9200 in the comparisons. If NOT-MATCHING, return a list of all articles that
9201 not match REGEXP on HEADER."
9202   (let ((case-fold-search (not not-case-fold))
9203         articles d func)
9204     (if (consp header)
9205         (if (eq (car header) 'extra)
9206             (setq func
9207                   `(lambda (h)
9208                      (or (cdr (assq ',(cdr header) (mail-header-extra h)))
9209                          "")))
9210           (error "%s is an invalid header" header))
9211       (unless (fboundp (intern (concat "mail-header-" header)))
9212         (error "%s is not a valid header" header))
9213       (setq func `(lambda (h) (,(intern (concat "mail-header-" header)) h))))
9214     (dolist (d (if (eq backward 'all)
9215                    gnus-newsgroup-data
9216                  (gnus-data-find-list
9217                   (gnus-summary-article-number)
9218                   (gnus-data-list backward))))
9219       (when (and (or (not unread)       ; We want all articles...
9220                      (gnus-data-unread-p d)) ; Or just unreads.
9221                  (vectorp (gnus-data-header d)) ; It's not a pseudo.
9222                  (if not-matching
9223                      (not (string-match
9224                            regexp
9225                            (funcall func (gnus-data-header d))))
9226                    (string-match regexp
9227                                  (funcall func (gnus-data-header d)))))
9228         (push (gnus-data-number d) articles))) ; Success!
9229     (nreverse articles)))
9230
9231 (defun gnus-summary-execute-command (header regexp command &optional backward)
9232   "Search forward for an article whose HEADER matches REGEXP and execute COMMAND.
9233 If HEADER is an empty string (or nil), the match is done on the entire
9234 article.  If BACKWARD (the prefix) is non-nil, search backward instead."
9235   (interactive
9236    (list (let ((completion-ignore-case t))
9237            (completing-read
9238             "Header name: "
9239             (mapcar (lambda (header) (list (format "%s" header)))
9240                     (append
9241                      '("Number" "Subject" "From" "Lines" "Date"
9242                        "Message-ID" "Xref" "References" "Body")
9243                      gnus-extra-headers))
9244             nil 'require-match))
9245          (read-string "Regexp: ")
9246          (read-key-sequence "Command: ")
9247          current-prefix-arg))
9248   (when (equal header "Body")
9249     (setq header ""))
9250   ;; Hidden thread subtrees must be searched as well.
9251   (gnus-summary-show-all-threads)
9252   ;; We don't want to change current point nor window configuration.
9253   (save-excursion
9254     (save-window-excursion
9255       (let (gnus-visual
9256             gnus-treat-strip-trailing-blank-lines
9257             gnus-treat-strip-leading-blank-lines
9258             gnus-treat-strip-multiple-blank-lines
9259             gnus-treat-hide-boring-headers
9260             gnus-treat-fold-newsgroups
9261             gnus-article-prepare-hook)
9262         (gnus-message 6 "Executing %s..." (key-description command))
9263         ;; We'd like to execute COMMAND interactively so as to give arguments.
9264         (gnus-execute header regexp
9265                       `(call-interactively ',(key-binding command))
9266                       backward)
9267         (gnus-message 6 "Executing %s...done" (key-description command))))))
9268
9269 (defun gnus-summary-beginning-of-article ()
9270   "Scroll the article back to the beginning."
9271   (interactive)
9272   (gnus-summary-select-article)
9273   (gnus-configure-windows 'article)
9274   (gnus-eval-in-buffer-window gnus-article-buffer
9275     (widen)
9276     (goto-char (point-min))
9277     (when gnus-break-pages
9278       (gnus-narrow-to-page))))
9279
9280 (defun gnus-summary-end-of-article ()
9281   "Scroll to the end of the article."
9282   (interactive)
9283   (gnus-summary-select-article)
9284   (gnus-configure-windows 'article)
9285   (gnus-eval-in-buffer-window gnus-article-buffer
9286     (widen)
9287     (goto-char (point-max))
9288     (recenter -3)
9289     (when gnus-break-pages
9290       (gnus-narrow-to-page))))
9291
9292 (defun gnus-summary-print-truncate-and-quote (string &optional len)
9293   "Truncate to LEN and quote all \"(\"'s in STRING."
9294   (gnus-replace-in-string (if (and len (> (length string) len))
9295                               (substring string 0 len)
9296                             string)
9297                           "[()]" "\\\\\\&"))
9298
9299 (defun gnus-summary-print-article (&optional filename n)
9300   "Generate and print a PostScript image of the process-marked (mail) articles.
9301
9302 If used interactively, print the current article if none are
9303 process-marked.  With prefix arg, prompt the user for the name of the
9304 file to save in.
9305
9306 When used from Lisp, accept two optional args FILENAME and N.  N means
9307 to print the next N articles.  If N is negative, print the N previous
9308 articles.  If N is nil and articles have been marked with the process
9309 mark, print these instead.
9310
9311 If the optional first argument FILENAME is nil, send the image to the
9312 printer.  If FILENAME is a string, save the PostScript image in a file with
9313 that name.  If FILENAME is a number, prompt the user for the name of the file
9314 to save in."
9315   (interactive (list (ps-print-preprint current-prefix-arg)))
9316   (dolist (article (gnus-summary-work-articles n))
9317     (gnus-summary-select-article nil nil 'pseudo article)
9318     (gnus-eval-in-buffer-window gnus-article-buffer
9319       (gnus-print-buffer))
9320     (gnus-summary-remove-process-mark article))
9321   (ps-despool filename))
9322
9323 (defun gnus-print-buffer ()
9324   (let ((buffer (generate-new-buffer " *print*")))
9325     (unwind-protect
9326         (progn
9327           (copy-to-buffer buffer (point-min) (point-max))
9328           (set-buffer buffer)
9329           (gnus-remove-text-with-property 'gnus-decoration)
9330           (when (gnus-visual-p 'article-highlight 'highlight)
9331             ;; Copy-to-buffer doesn't copy overlay.  So redo
9332             ;; highlight.
9333             (let ((gnus-article-buffer buffer))
9334               (gnus-article-highlight-citation t)
9335               (gnus-article-highlight-signature)
9336               (gnus-article-emphasize)
9337               (gnus-article-delete-invisible-text)))
9338           (let ((ps-left-header
9339                  (list
9340                   (concat "("
9341                           (gnus-summary-print-truncate-and-quote
9342                            (mail-header-subject gnus-current-headers)
9343                            66) ")")
9344                   (concat "("
9345                           (gnus-summary-print-truncate-and-quote
9346                            (mail-header-from gnus-current-headers)
9347                            45) ")")))
9348                 (ps-right-header
9349                  (list
9350                   "/pagenumberstring load"
9351                   (concat "("
9352                           (mail-header-date gnus-current-headers) ")"))))
9353             (gnus-run-hooks 'gnus-ps-print-hook)
9354             (save-excursion
9355               (if ps-print-color-p
9356                   (ps-spool-buffer-with-faces)
9357                 (ps-spool-buffer)))))
9358       (kill-buffer buffer))))
9359
9360 (defun gnus-summary-show-article (&optional arg)
9361   "Force redisplaying of the current article.
9362 If ARG (the prefix) is a number, show the article with the charset
9363 defined in `gnus-summary-show-article-charset-alist', or the charset
9364 input.
9365 If ARG (the prefix) is non-nil and not a number, show the raw article
9366 without any article massaging functions being run.  Normally, the key
9367 strokes are `C-u g'."
9368   (interactive "P")
9369   (cond
9370    ((numberp arg)
9371     (gnus-summary-show-article t)
9372     (let ((gnus-newsgroup-charset
9373            (or (cdr (assq arg gnus-summary-show-article-charset-alist))
9374                (mm-read-coding-system
9375                 "View as charset: " ;; actually it is coding system.
9376                 (with-current-buffer gnus-article-buffer
9377                   (mm-detect-coding-region (point) (point-max))))))
9378           (gnus-newsgroup-ignored-charsets 'gnus-all))
9379       (gnus-summary-select-article nil 'force)
9380       (let ((deps gnus-newsgroup-dependencies)
9381             head header lines)
9382         (with-current-buffer gnus-original-article-buffer
9383           (save-restriction
9384             (message-narrow-to-head)
9385             (setq head (buffer-string))
9386             (goto-char (point-min))
9387             (unless (re-search-forward "^lines:[ \t]\\([0-9]+\\)" nil t)
9388               (goto-char (point-max))
9389               (widen)
9390               (setq lines (1- (count-lines (point) (point-max))))))
9391           (with-temp-buffer
9392             (insert (format "211 %d Article retrieved.\n"
9393                             (cdr gnus-article-current)))
9394             (insert head)
9395             (if lines (insert (format "Lines: %d\n" lines)))
9396             (insert ".\n")
9397             (let ((nntp-server-buffer (current-buffer)))
9398               (setq header (car (gnus-get-newsgroup-headers deps t))))))
9399         (gnus-data-set-header
9400          (gnus-data-find (cdr gnus-article-current))
9401          header)
9402         (gnus-summary-update-article-line
9403          (cdr gnus-article-current) header)
9404         (when (gnus-summary-goto-subject (cdr gnus-article-current) nil t)
9405           (gnus-summary-update-secondary-mark (cdr gnus-article-current))))))
9406    ((not arg)
9407     ;; Select the article the normal way.
9408     (gnus-summary-select-article nil 'force))
9409    (t
9410     ;; We have to require this here to make sure that the following
9411     ;; dynamic binding isn't shadowed by autoloading.
9412     (require 'gnus-async)
9413     (require 'gnus-art)
9414     ;; Bind the article treatment functions to nil.
9415     (let ((gnus-have-all-headers t)
9416           gnus-article-prepare-hook
9417           gnus-article-decode-hook
9418           gnus-display-mime-function
9419           gnus-break-pages)
9420       ;; Destroy any MIME parts.
9421       (when (gnus-buffer-live-p gnus-article-buffer)
9422         (with-current-buffer gnus-article-buffer
9423           (mm-destroy-parts gnus-article-mime-handles)
9424           ;; Set it to nil for safety reason.
9425           (setq gnus-article-mime-handle-alist nil)
9426           (setq gnus-article-mime-handles nil)))
9427       (gnus-summary-select-article nil 'force))))
9428   (gnus-summary-goto-subject gnus-current-article)
9429   (gnus-summary-position-point))
9430
9431 (defun gnus-summary-show-raw-article ()
9432   "Show the raw article without any article massaging functions being run."
9433   (interactive)
9434   (gnus-summary-show-article t))
9435
9436 (defun gnus-summary-verbose-headers (&optional arg)
9437   "Toggle permanent full header display.
9438 If ARG is a positive number, turn header display on.
9439 If ARG is a negative number, turn header display off."
9440   (interactive "P")
9441   (setq gnus-show-all-headers
9442         (cond ((or (not (numberp arg))
9443                    (zerop arg))
9444                (not gnus-show-all-headers))
9445               ((natnump arg)
9446                t)))
9447   (gnus-summary-show-article))
9448
9449 (defun gnus-summary-toggle-header (&optional arg)
9450   "Show the headers if they are hidden, or hide them if they are shown.
9451 If ARG is a positive number, show the entire header.
9452 If ARG is a negative number, hide the unwanted header lines."
9453   (interactive "P")
9454   (let ((window (and (gnus-buffer-live-p gnus-article-buffer)
9455                      (get-buffer-window gnus-article-buffer t))))
9456     (with-current-buffer gnus-article-buffer
9457       (widen)
9458       (article-narrow-to-head)
9459       (let* ((inhibit-read-only t)
9460              (inhibit-point-motion-hooks t)
9461              (hidden (if (numberp arg)
9462                          (>= arg 0)
9463                        (or (not (looking-at "[^ \t\n]+:"))
9464                            (gnus-article-hidden-text-p 'headers))))
9465              s e)
9466         (delete-region (point-min) (point-max))
9467         (with-current-buffer gnus-original-article-buffer
9468           (goto-char (setq s (point-min)))
9469           (setq e (if (search-forward "\n\n" nil t)
9470                       (1- (point))
9471                     (point-max))))
9472         (insert-buffer-substring gnus-original-article-buffer s e)
9473         (run-hooks 'gnus-article-decode-hook)
9474         (if hidden
9475             (let ((gnus-treat-hide-headers nil)
9476                   (gnus-treat-hide-boring-headers nil))
9477               (gnus-delete-wash-type 'headers)
9478               (gnus-treat-article 'head))
9479           (gnus-treat-article 'head))
9480         (widen)
9481         (if window
9482             (set-window-start window (goto-char (point-min))))
9483         (if gnus-break-pages
9484             (gnus-narrow-to-page)
9485           (when (gnus-visual-p 'page-marker)
9486             (let ((inhibit-read-only t))
9487               (gnus-remove-text-with-property 'gnus-prev)
9488               (gnus-remove-text-with-property 'gnus-next))))
9489         (gnus-set-mode-line 'article)))))
9490
9491 (defun gnus-summary-show-all-headers ()
9492   "Make all header lines visible."
9493   (interactive)
9494   (gnus-summary-toggle-header 1))
9495
9496 (defun gnus-summary-caesar-message (&optional arg)
9497   "Caesar rotate the current article by 13.
9498 With a non-numerical prefix, also rotate headers.  A numerical
9499 prefix specifies how many places to rotate each letter forward."
9500   (interactive "P")
9501   (gnus-summary-select-article)
9502   (let ((mail-header-separator ""))
9503     (gnus-eval-in-buffer-window gnus-article-buffer
9504       (save-restriction
9505         (widen)
9506         (let ((start (window-start))
9507               (inhibit-read-only t))
9508           (if (equal arg '(4))
9509               (message-caesar-buffer-body nil t)
9510             (message-caesar-buffer-body arg))
9511           (set-window-start (get-buffer-window (current-buffer)) start)))))
9512   ;; Create buttons and stuff...
9513   (gnus-treat-article nil))
9514
9515 (declare-function idna-to-unicode "ext:idna" (str))
9516
9517 (defun gnus-summary-idna-message (&optional arg)
9518   "Decode IDNA encoded domain names in the current articles.
9519 IDNA encoded domain names looks like `xn--bar'.  If a string
9520 remain unencoded after running this function, it is likely an
9521 invalid IDNA string (`xn--bar' is invalid).
9522
9523 You must have GNU Libidn (URL `http://www.gnu.org/software/libidn/')
9524 installed for this command to work."
9525   (interactive "P")
9526   (if (not (and (condition-case nil (require 'idna)
9527                   (file-error))
9528                 (mm-coding-system-p 'utf-8)
9529                 (executable-find (symbol-value 'idna-program))))
9530       (gnus-message
9531        5 "GNU Libidn not installed properly (`idn' or `idna.el' missing)")
9532     (gnus-summary-select-article)
9533     (let ((mail-header-separator ""))
9534       (gnus-eval-in-buffer-window gnus-article-buffer
9535         (save-restriction
9536           (widen)
9537           (let ((start (window-start))
9538                 buffer-read-only)
9539             (while (re-search-forward "\\(xn--[-0-9a-z]+\\)" nil t)
9540               (replace-match (idna-to-unicode (match-string 1))))
9541             (set-window-start (get-buffer-window (current-buffer)) start)))))))
9542
9543 (defun gnus-summary-morse-message (&optional arg)
9544   "Morse decode the current article."
9545   (interactive "P")
9546   (gnus-summary-select-article)
9547   (let ((mail-header-separator ""))
9548     (gnus-eval-in-buffer-window gnus-article-buffer
9549       (save-excursion
9550         (save-restriction
9551           (widen)
9552           (let ((pos (window-start))
9553                 (inhibit-read-only t))
9554             (goto-char (point-min))
9555             (when (message-goto-body)
9556               (gnus-narrow-to-body))
9557             (goto-char (point-min))
9558             (while (search-forward "·" (point-max) t)
9559               (replace-match "."))
9560             (unmorse-region (point-min) (point-max))
9561             (widen)
9562             (set-window-start (get-buffer-window (current-buffer)) pos)))))))
9563
9564 (defun gnus-summary-stop-page-breaking ()
9565   "Stop page breaking in the current article."
9566   (interactive)
9567   (gnus-summary-select-article)
9568   (gnus-eval-in-buffer-window gnus-article-buffer
9569     (widen)
9570     (when (gnus-visual-p 'page-marker)
9571       (let ((inhibit-read-only t))
9572         (gnus-remove-text-with-property 'gnus-prev)
9573         (gnus-remove-text-with-property 'gnus-next))
9574       (setq gnus-page-broken nil))))
9575
9576 (defun gnus-summary-move-article (&optional n to-newsgroup
9577                                             select-method action)
9578   "Move the current article to a different newsgroup.
9579 If N is a positive number, move the N next articles.
9580 If N is a negative number, move the N previous articles.
9581 If N is nil and any articles have been marked with the process mark,
9582 move those articles instead.
9583 If TO-NEWSGROUP is string, do not prompt for a newsgroup to move to.
9584 If SELECT-METHOD is non-nil, do not move to a specific newsgroup, but
9585 re-spool using this method.
9586
9587 When called interactively with TO-NEWSGROUP being nil, the value of
9588 the variable `gnus-move-split-methods' is used for finding a default
9589 for the target newsgroup.
9590
9591 For this function to work, both the current newsgroup and the
9592 newsgroup that you want to move to have to support the `request-move'
9593 and `request-accept' functions.
9594
9595 ACTION can be either `move' (the default), `crosspost' or `copy'."
9596   (interactive "P")
9597   (unless action
9598     (setq action 'move))
9599   ;; Check whether the source group supports the required functions.
9600   (cond ((and (eq action 'move)
9601               (not (gnus-check-backend-function
9602                     'request-move-article gnus-newsgroup-name)))
9603          (error "The current group does not support article moving"))
9604         ((and (eq action 'crosspost)
9605               (not (gnus-check-backend-function
9606                     'request-replace-article gnus-newsgroup-name)))
9607          (error "The current group does not support article editing")))
9608   (let ((articles (gnus-summary-work-articles n))
9609         (prefix (if (gnus-check-backend-function
9610                      'request-move-article gnus-newsgroup-name)
9611                     (funcall gnus-move-group-prefix-function
9612                              gnus-newsgroup-name)
9613                   ""))
9614         (names '((move "Move" "Moving")
9615                  (copy "Copy" "Copying")
9616                  (crosspost "Crosspost" "Crossposting")))
9617         (copy-buf (save-excursion
9618                     (nnheader-set-temp-buffer " *copy article*")))
9619         art-group to-method new-xref article to-groups
9620         articles-to-update-marks encoded)
9621     (unless (assq action names)
9622       (error "Unknown action %s" action))
9623     ;; Read the newsgroup name.
9624     (when (and (not to-newsgroup)
9625                (not select-method))
9626       (if (and gnus-move-split-methods
9627                (not
9628                 (and (memq gnus-current-article articles)
9629                      (gnus-buffer-live-p gnus-original-article-buffer))))
9630           ;; When `gnus-move-split-methods' is non-nil, we have to
9631           ;; select an article to give `gnus-read-move-group-name' an
9632           ;; opportunity to suggest an appropriate default.  However,
9633           ;; we needn't render or mark the article.
9634           (let ((gnus-display-mime-function nil)
9635                 (gnus-article-prepare-hook nil)
9636                 (gnus-mark-article-hook nil))
9637             (gnus-summary-select-article nil nil nil (car articles))))
9638       (setq to-newsgroup (gnus-read-move-group-name
9639                           (cadr (assq action names))
9640                           (symbol-value
9641                            (intern (format "gnus-current-%s-group" action)))
9642                           articles prefix)
9643             encoded to-newsgroup
9644             to-method (gnus-server-to-method (gnus-group-method to-newsgroup)))
9645       (set (intern (format "gnus-current-%s-group" action))
9646            (mm-decode-coding-string
9647             to-newsgroup
9648             (gnus-group-name-charset to-method to-newsgroup))))
9649     (unless to-method
9650       (setq to-method (or select-method
9651                           (gnus-server-to-method
9652                            (gnus-group-method to-newsgroup)))))
9653     (setq to-newsgroup
9654           (or encoded
9655               (and to-newsgroup
9656                    (mm-encode-coding-string
9657                     to-newsgroup
9658                     (gnus-group-name-charset to-method to-newsgroup)))))
9659     ;; Check the method we are to move this article to...
9660     (unless (gnus-check-backend-function
9661              'request-accept-article (car to-method))
9662       (error "%s does not support article copying" (car to-method)))
9663     (unless (gnus-check-server to-method)
9664       (error "Can't open server %s" (car to-method)))
9665     (gnus-message 6 "%s to %s: %s..."
9666                   (caddr (assq action names))
9667                   (or (car select-method)
9668                       (gnus-group-decoded-name to-newsgroup))
9669                   articles)
9670     (while articles
9671       (setq article (pop articles))
9672       (setq
9673        art-group
9674        (cond
9675         ;; Move the article.
9676         ((eq action 'move)
9677          ;; Remove this article from future suppression.
9678          (gnus-dup-unsuppress-article article)
9679          (let* ((from-method (gnus-find-method-for-group
9680                               gnus-newsgroup-name))
9681                 (to-method (or select-method
9682                                (gnus-find-method-for-group to-newsgroup)))
9683                 (move-is-internal (gnus-server-equal from-method to-method)))
9684            (gnus-request-move-article
9685             article                     ; Article to move
9686             gnus-newsgroup-name         ; From newsgroup
9687             (nth 1 (gnus-find-method-for-group
9688                     gnus-newsgroup-name)) ; Server
9689             (list 'gnus-request-accept-article
9690                   to-newsgroup (list 'quote select-method)
9691                   (not articles) t)     ; Accept form
9692             (not articles)              ; Only save nov last time
9693             (and move-is-internal
9694                  to-newsgroup           ; Not respooling
9695                  (gnus-group-real-name to-newsgroup))))) ; Is this move internal?
9696         ;; Copy the article.
9697         ((eq action 'copy)
9698          (with-current-buffer copy-buf
9699            (when (gnus-request-article-this-buffer article gnus-newsgroup-name)
9700              (save-restriction
9701                (nnheader-narrow-to-headers)
9702                (dolist (hdr gnus-copy-article-ignored-headers)
9703                  (message-remove-header hdr t)))
9704              (gnus-request-accept-article
9705               to-newsgroup select-method (not articles) t))))
9706         ;; Crosspost the article.
9707         ((eq action 'crosspost)
9708          (let ((xref (message-tokenize-header
9709                       (mail-header-xref (gnus-summary-article-header article))
9710                       " ")))
9711            (setq new-xref (concat (gnus-group-real-name gnus-newsgroup-name)
9712                                   ":" (number-to-string article)))
9713            (unless xref
9714              (setq xref (list (system-name))))
9715            (setq new-xref
9716                  (concat
9717                   (mapconcat 'identity
9718                              (delete "Xref:" (delete new-xref xref))
9719                              " ")
9720                   " " new-xref))
9721            (with-current-buffer copy-buf
9722              ;; First put the article in the destination group.
9723              (gnus-request-article-this-buffer article gnus-newsgroup-name)
9724              (when (consp (setq art-group
9725                                 (gnus-request-accept-article
9726                                  to-newsgroup select-method (not articles) t)))
9727                (setq new-xref (concat new-xref " " (car art-group)
9728                                       ":"
9729                                       (number-to-string (cdr art-group))))
9730                ;; Now we have the new Xrefs header, so we insert
9731                ;; it and replace the new article.
9732                (nnheader-replace-header "Xref" new-xref)
9733                (gnus-request-replace-article
9734                 (cdr art-group) to-newsgroup (current-buffer) t)
9735                art-group))))))
9736       (cond
9737        ((not art-group)
9738         (gnus-message 1 "Couldn't %s article %s: %s"
9739                       (cadr (assq action names)) article
9740                       (nnheader-get-report (car to-method))))
9741        ((eq art-group 'junk)
9742         (when (eq action 'move)
9743           (gnus-summary-mark-article article gnus-canceled-mark)
9744           (gnus-message 4 "Deleted article %s" article)
9745           ;; run the delete hook
9746           (run-hook-with-args 'gnus-summary-article-delete-hook
9747                               action
9748                               (gnus-data-header
9749                                (assoc article (gnus-data-list nil)))
9750                               gnus-newsgroup-name nil
9751                               select-method)))
9752        (t
9753         (let* ((pto-group (gnus-group-prefixed-name
9754                            (car art-group) to-method))
9755                (info (gnus-get-info pto-group))
9756                (to-group (gnus-info-group info))
9757                to-marks)
9758           ;; Update the group that has been moved to.
9759           (when (and info
9760                      (memq action '(move copy)))
9761             (unless (member to-group to-groups)
9762               (push to-group to-groups))
9763
9764             (unless (memq article gnus-newsgroup-unreads)
9765               (push 'read to-marks)
9766               (gnus-info-set-read
9767                info (gnus-add-to-range (gnus-info-read info)
9768                                        (list (cdr art-group)))))
9769
9770             ;; See whether the article is to be put in the cache.
9771             (let* ((expirable (gnus-group-auto-expirable-p to-group))
9772                    (marks (if expirable
9773                               gnus-article-mark-lists
9774                             (delete '(expirable . expire)
9775                                     (copy-sequence gnus-article-mark-lists))))
9776                    (to-article (cdr art-group)))
9777
9778               ;; Enter the article into the cache in the new group,
9779               ;; if that is required.
9780               (when gnus-use-cache
9781                 (gnus-cache-possibly-enter-article
9782                  to-group to-article
9783                  (memq article gnus-newsgroup-marked)
9784                  (memq article gnus-newsgroup-dormant)
9785                  (memq article gnus-newsgroup-unreads)))
9786
9787               (when gnus-preserve-marks
9788                 ;; Copy any marks over to the new group.
9789                 (when (and (equal to-group gnus-newsgroup-name)
9790                            (not (memq article gnus-newsgroup-unreads)))
9791                   ;; Mark this article as read in this group.
9792                   (push (cons to-article gnus-read-mark) gnus-newsgroup-reads)
9793                   (setcdr (gnus-active to-group) to-article)
9794                   (setcdr gnus-newsgroup-active to-article))
9795
9796                 (while marks
9797                   (when (eq (gnus-article-mark-to-type (cdar marks)) 'list)
9798                     (when (memq article (symbol-value
9799                                          (intern (format "gnus-newsgroup-%s"
9800                                                          (caar marks)))))
9801                       (push (cdar marks) to-marks)
9802                       ;; If the other group is the same as this group,
9803                       ;; then we have to add the mark to the list.
9804                       (when (equal to-group gnus-newsgroup-name)
9805                         (set (intern (format "gnus-newsgroup-%s" (caar marks)))
9806                              (cons to-article
9807                                    (symbol-value
9808                                     (intern (format "gnus-newsgroup-%s"
9809                                                     (caar marks)))))))
9810                       ;; Copy the marks to other group.
9811                       (gnus-add-marked-articles
9812                        to-group (cdar marks) (list to-article) info)))
9813                   (setq marks (cdr marks)))
9814
9815                 (when (and expirable
9816                            gnus-mark-copied-or-moved-articles-as-expirable
9817                            (not (memq 'expire to-marks)))
9818                   ;; Mark this article as expirable.
9819                   (push 'expire to-marks)
9820                   (when (equal to-group gnus-newsgroup-name)
9821                     (push to-article gnus-newsgroup-expirable))
9822                   ;; Copy the expirable mark to other group.
9823                   (gnus-add-marked-articles
9824                    to-group 'expire (list to-article) info))
9825
9826                 (when to-marks
9827                   (gnus-request-set-mark
9828                    to-group (list (list (list to-article) 'add to-marks)))))
9829
9830               (gnus-dribble-enter
9831                (concat "(gnus-group-set-info '"
9832                        (gnus-prin1-to-string (gnus-get-info to-group))
9833                        ")"))))
9834
9835           ;; Update the Xref header in this article to point to
9836           ;; the new crossposted article we have just created.
9837           (when (eq action 'crosspost)
9838             (with-current-buffer copy-buf
9839               (gnus-request-article-this-buffer article gnus-newsgroup-name)
9840               (nnheader-replace-header "Xref" new-xref)
9841               (gnus-request-replace-article
9842                article gnus-newsgroup-name (current-buffer) t)))
9843
9844           ;; run the move/copy/crosspost/respool hook
9845           (run-hook-with-args 'gnus-summary-article-move-hook
9846                               action
9847                               (gnus-data-header
9848                                (assoc article (gnus-data-list nil)))
9849                               gnus-newsgroup-name
9850                               to-newsgroup
9851                               select-method))
9852
9853         ;;;!!!Why is this necessary?
9854         (set-buffer gnus-summary-buffer)
9855
9856         (when (eq action 'move)
9857           (save-excursion
9858             (gnus-summary-goto-subject article)
9859             (gnus-summary-mark-article article gnus-canceled-mark)))))
9860       (push article articles-to-update-marks))
9861
9862     (save-excursion
9863       (apply 'gnus-summary-remove-process-mark articles-to-update-marks))
9864     ;; Re-activate all groups that have been moved to.
9865     (with-current-buffer gnus-group-buffer
9866       (let ((gnus-group-marked to-groups))
9867         (gnus-group-get-new-news-this-group nil t)))
9868
9869     (gnus-kill-buffer copy-buf)
9870     (gnus-summary-position-point)
9871     (gnus-set-mode-line 'summary)))
9872
9873 (defun gnus-summary-copy-article (&optional n to-newsgroup select-method)
9874   "Copy the current article to some other group.
9875 If TO-NEWSGROUP is string, do not prompt for a newsgroup to copy to.
9876 When called interactively, if TO-NEWSGROUP is nil, use the value of
9877 the variable `gnus-move-split-methods' for finding a default target
9878 newsgroup.
9879 If SELECT-METHOD is non-nil, do not move to a specific newsgroup, but
9880 re-spool using this method."
9881   (interactive "P")
9882   (gnus-summary-move-article n to-newsgroup select-method 'copy))
9883
9884 (defun gnus-summary-crosspost-article (&optional n)
9885   "Crosspost the current article to some other group."
9886   (interactive "P")
9887   (gnus-summary-move-article n nil nil 'crosspost))
9888
9889 (defcustom gnus-summary-respool-default-method nil
9890   "Default method type for respooling an article.
9891 If nil, use to the current newsgroup method."
9892   :type 'symbol
9893   :group 'gnus-summary-mail)
9894
9895 (defun gnus-summary-respool-article (&optional n method)
9896   "Respool the current article.
9897 The article will be squeezed through the mail spooling process again,
9898 which means that it will be put in some mail newsgroup or other
9899 depending on `nnmail-split-methods'.
9900 If N is a positive number, respool the N next articles.
9901 If N is a negative number, respool the N previous articles.
9902 If N is nil and any articles have been marked with the process mark,
9903 respool those articles instead.
9904
9905 Respooling can be done both from mail groups and \"real\" newsgroups.
9906 In the former case, the articles in question will be moved from the
9907 current group into whatever groups they are destined to.  In the
9908 latter case, they will be copied into the relevant groups."
9909   (interactive
9910    (list current-prefix-arg
9911          (let* ((methods (gnus-methods-using 'respool))
9912                 (methname
9913                  (symbol-name (or gnus-summary-respool-default-method
9914                                   (car (gnus-find-method-for-group
9915                                         gnus-newsgroup-name)))))
9916                 (method
9917                  (gnus-completing-read-with-default
9918                   methname "Backend to use when respooling"
9919                   methods nil t nil 'gnus-mail-method-history))
9920                 ms)
9921            (cond
9922             ((zerop (length (setq ms (gnus-servers-using-backend
9923                                       (intern method)))))
9924              (list (intern method) ""))
9925             ((= 1 (length ms))
9926              (car ms))
9927             (t
9928              (let ((ms-alist (mapcar (lambda (m) (cons (cadr m) m)) ms)))
9929                (cdr (assoc (completing-read "Server name: " ms-alist nil t)
9930                            ms-alist))))))))
9931   (unless method
9932     (error "No method given for respooling"))
9933   (if (assoc (symbol-name
9934               (car (gnus-find-method-for-group gnus-newsgroup-name)))
9935              (gnus-methods-using 'respool))
9936       (gnus-summary-move-article n nil method)
9937     (gnus-summary-copy-article n nil method)))
9938
9939 (defun gnus-summary-import-article (file &optional edit)
9940   "Import an arbitrary file into a mail newsgroup."
9941   (interactive "fImport file: \nP")
9942   (let ((group gnus-newsgroup-name)
9943         (now (current-time))
9944         atts lines group-art)
9945     (unless (gnus-check-backend-function 'request-accept-article group)
9946       (error "%s does not support article importing" group))
9947     (or (file-readable-p file)
9948         (not (file-regular-p file))
9949         (error "Can't read %s" file))
9950     (with-current-buffer (gnus-get-buffer-create " *import file*")
9951       (erase-buffer)
9952       (nnheader-insert-file-contents file)
9953       (goto-char (point-min))
9954       (if (nnheader-article-p)
9955           (save-restriction
9956             (goto-char (point-min))
9957             (search-forward "\n\n" nil t)
9958             (narrow-to-region (point-min) (1- (point)))
9959             (goto-char (point-min))
9960             (unless (re-search-forward "^date:" nil t)
9961               (goto-char (point-max))
9962               (insert "Date: " (message-make-date (nth 5 atts)) "\n")))
9963        ;; This doesn't look like an article, so we fudge some headers.
9964         (setq atts (file-attributes file)
9965               lines (count-lines (point-min) (point-max)))
9966         (insert "From: " (read-string "From: ") "\n"
9967                 "Subject: " (read-string "Subject: ") "\n"
9968                 "Date: " (message-make-date (nth 5 atts)) "\n"
9969                 "Message-ID: " (message-make-message-id) "\n"
9970                 "Lines: " (int-to-string lines) "\n"
9971                 "Chars: " (int-to-string (nth 7 atts)) "\n\n"))
9972       (setq group-art (gnus-request-accept-article group nil t))
9973       (kill-buffer (current-buffer)))
9974     (setq gnus-newsgroup-active (gnus-activate-group group))
9975     (forward-line 1)
9976     (gnus-summary-goto-article (cdr group-art) nil t)
9977     (when edit
9978       (gnus-summary-edit-article))))
9979
9980 (defun gnus-summary-create-article ()
9981   "Create an article in a mail newsgroup."
9982   (interactive)
9983   (let ((group gnus-newsgroup-name)
9984         (now (current-time))
9985         group-art)
9986     (unless (gnus-check-backend-function 'request-accept-article group)
9987       (error "%s does not support article importing" group))
9988     (with-current-buffer (gnus-get-buffer-create " *import file*")
9989       (erase-buffer)
9990       (goto-char (point-min))
9991       ;; This doesn't look like an article, so we fudge some headers.
9992       (insert "From: " (read-string "From: ") "\n"
9993               "Subject: " (read-string "Subject: ") "\n"
9994               "Date: " (message-make-date now) "\n"
9995               "Message-ID: " (message-make-message-id) "\n")
9996       (setq group-art (gnus-request-accept-article group nil t))
9997       (kill-buffer (current-buffer)))
9998     (setq gnus-newsgroup-active (gnus-activate-group group))
9999     (forward-line 1)
10000     (gnus-summary-goto-article (cdr group-art) nil t)
10001     (gnus-summary-edit-article)))
10002
10003 (defun gnus-summary-article-posted-p ()
10004   "Say whether the current (mail) article is available from news as well.
10005 This will be the case if the article has both been mailed and posted."
10006   (interactive)
10007   (let ((id (mail-header-references (gnus-summary-article-header)))
10008         (gnus-override-method (car (gnus-refer-article-methods))))
10009     (if (gnus-request-head id "")
10010         (gnus-message 2 "The current message was found on %s"
10011                       gnus-override-method)
10012       (gnus-message 2 "The current message couldn't be found on %s"
10013                     gnus-override-method)
10014       nil)))
10015
10016 (defun gnus-summary-expire-articles (&optional now)
10017   "Expire all articles that are marked as expirable in the current group."
10018   (interactive)
10019   (when (and (not gnus-group-is-exiting-without-update-p)
10020              (gnus-check-backend-function
10021               'request-expire-articles gnus-newsgroup-name))
10022     ;; This backend supports expiry.
10023     (let* ((total (gnus-group-total-expirable-p gnus-newsgroup-name))
10024            (expirable (if total
10025                           (progn
10026                             ;; We need to update the info for
10027                             ;; this group for `gnus-list-of-read-articles'
10028                             ;; to give us the right answer.
10029                             (gnus-run-hooks 'gnus-exit-group-hook)
10030                             (gnus-summary-update-info)
10031                             (gnus-list-of-read-articles gnus-newsgroup-name))
10032                         (setq gnus-newsgroup-expirable
10033                               (sort gnus-newsgroup-expirable '<))))
10034            (expiry-wait (if now 'immediate
10035                           (gnus-group-find-parameter
10036                            gnus-newsgroup-name 'expiry-wait)))
10037            (nnmail-expiry-target
10038             (or (gnus-group-find-parameter gnus-newsgroup-name 'expiry-target)
10039                 nnmail-expiry-target))
10040            es)
10041       (when expirable
10042         ;; There are expirable articles in this group, so we run them
10043         ;; through the expiry process.
10044         (gnus-message 6 "Expiring articles...")
10045         (unless (gnus-check-group gnus-newsgroup-name)
10046           (error "Can't open server for %s" gnus-newsgroup-name))
10047         ;; The list of articles that weren't expired is returned.
10048         (save-excursion
10049           (if expiry-wait
10050               (let ((nnmail-expiry-wait-function nil)
10051                     (nnmail-expiry-wait expiry-wait))
10052                 (setq es (gnus-request-expire-articles
10053                           expirable gnus-newsgroup-name)))
10054             (setq es (gnus-request-expire-articles
10055                       expirable gnus-newsgroup-name)))
10056           (unless total
10057             (setq gnus-newsgroup-expirable es))
10058           ;; We go through the old list of expirable, and mark all
10059           ;; really expired articles as nonexistent.
10060           (unless (eq es expirable) ;If nothing was expired, we don't mark.
10061             (let ((gnus-use-cache nil))
10062               (dolist (article expirable)
10063                 (when (and (not (memq article es))
10064                            (gnus-data-find article))
10065                   (gnus-summary-mark-article article gnus-canceled-mark)
10066                   (run-hook-with-args 'gnus-summary-article-expire-hook
10067                                       'delete
10068                                       (gnus-data-header
10069                                        (assoc article (gnus-data-list nil)))
10070                                       gnus-newsgroup-name
10071                                       nil
10072                                       nil))))))
10073         (gnus-message 6 "Expiring articles...done")))))
10074
10075 (defun gnus-summary-expire-articles-now ()
10076   "Expunge all expirable articles in the current group.
10077 This means that *all* articles that are marked as expirable will be
10078 deleted forever, right now."
10079   (interactive)
10080   (or gnus-expert-user
10081       (gnus-yes-or-no-p
10082        "Are you really, really sure you want to delete all expirable messages? ")
10083       (error "Phew!"))
10084   (gnus-summary-expire-articles t))
10085
10086 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
10087 (defun gnus-summary-delete-article (&optional n)
10088   "Delete the N next (mail) articles.
10089 This command actually deletes articles.  This is not a marking
10090 command.  The article will disappear forever from your life, never to
10091 return.
10092
10093 If N is negative, delete backwards.
10094 If N is nil and articles have been marked with the process mark,
10095 delete these instead.
10096
10097 If `gnus-novice-user' is non-nil you will be asked for
10098 confirmation before the articles are deleted."
10099   (interactive "P")
10100   (unless (gnus-check-backend-function 'request-expire-articles
10101                                        gnus-newsgroup-name)
10102     (error "The current newsgroup does not support article deletion"))
10103   (unless (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
10104     (error "Couldn't open server"))
10105   ;; Compute the list of articles to delete.
10106   (let ((articles (sort (copy-sequence (gnus-summary-work-articles n)) '<))
10107         (nnmail-expiry-target 'delete)
10108         not-deleted)
10109     (if (and gnus-novice-user
10110              (not (gnus-yes-or-no-p
10111                    (format "Do you really want to delete %s forever? "
10112                            (if (> (length articles) 1)
10113                                (format "these %s articles" (length articles))
10114                              "this article")))))
10115         ()
10116       ;; Delete the articles.
10117       (setq not-deleted (gnus-request-expire-articles
10118                          articles gnus-newsgroup-name 'force))
10119       (save-excursion
10120         (while articles
10121           (gnus-summary-remove-process-mark (car articles))
10122           ;; The backend might not have been able to delete the article
10123           ;; after all.
10124           (unless (memq (car articles) not-deleted)
10125             (gnus-summary-mark-article (car articles) gnus-canceled-mark))
10126           (let* ((article (car articles))
10127                  (ghead  (gnus-data-header
10128                           (assoc article (gnus-data-list nil)))))
10129             (run-hook-with-args 'gnus-summary-article-delete-hook
10130                                 'delete ghead gnus-newsgroup-name nil
10131                                 nil))
10132           (setq articles (cdr articles))))
10133       (when not-deleted
10134         (gnus-message 4 "Couldn't delete articles %s" not-deleted)))
10135     (gnus-summary-position-point)
10136     (gnus-set-mode-line 'summary)
10137     not-deleted))
10138
10139 (defun gnus-summary-edit-article (&optional arg)
10140   "Edit the current article.
10141 This will have permanent effect only in mail groups.
10142 If ARG is nil, edit the decoded articles.
10143 If ARG is 1, edit the raw articles.
10144 If ARG is 2, edit the raw articles even in read-only groups.
10145 If ARG is 3, edit the articles with the current handles.
10146 Otherwise, allow editing of articles even in read-only
10147 groups."
10148   (interactive "P")
10149   (let (force raw current-handles)
10150     (cond
10151      ((null arg))
10152      ((eq arg 1)
10153       (setq raw t))
10154      ((eq arg 2)
10155       (setq raw t
10156             force t))
10157      ((eq arg 3)
10158       (setq current-handles
10159             (and (gnus-buffer-live-p gnus-article-buffer)
10160                  (with-current-buffer gnus-article-buffer
10161                    (prog1
10162                        gnus-article-mime-handles
10163                      (setq gnus-article-mime-handles nil))))))
10164      (t
10165       (setq force t)))
10166     (when (and raw (not force)
10167                (member gnus-newsgroup-name '("nndraft:delayed"
10168                                              "nndraft:drafts"
10169                                              "nndraft:queue")))
10170       (error "Can't edit the raw article in group %s"
10171              gnus-newsgroup-name))
10172     (with-current-buffer gnus-summary-buffer
10173       (let ((mail-parse-charset gnus-newsgroup-charset)
10174             (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets))
10175         (gnus-set-global-variables)
10176         (when (and (not force)
10177                    (gnus-group-read-only-p))
10178           (error "The current newsgroup does not support article editing"))
10179         (gnus-summary-show-article t)
10180         (when (and (not raw) (gnus-buffer-live-p gnus-article-buffer))
10181           (with-current-buffer gnus-article-buffer
10182             (mm-enable-multibyte)))
10183         (if (member gnus-newsgroup-name '("nndraft:delayed" "nndraft:drafts"))
10184             (setq raw t))
10185         (gnus-article-edit-article
10186          (if raw 'ignore
10187            `(lambda ()
10188               (let ((mbl mml-buffer-list))
10189                 (setq mml-buffer-list nil)
10190                 (let ((rfc2047-quote-decoded-words-containing-tspecials t))
10191                   (mime-to-mml ,'current-handles))
10192                 (let ((mbl1 mml-buffer-list))
10193                   (setq mml-buffer-list mbl)
10194                   (set (make-local-variable 'mml-buffer-list) mbl1))
10195                 (gnus-make-local-hook 'kill-buffer-hook)
10196                 (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t))))
10197          `(lambda (no-highlight)
10198             (let ((mail-parse-charset ',gnus-newsgroup-charset)
10199                   (message-options message-options)
10200                   (message-options-set-recipient)
10201                   (mail-parse-ignored-charsets
10202                    ',gnus-newsgroup-ignored-charsets)
10203                   (rfc2047-header-encoding-alist
10204                    ',(let ((charset (gnus-group-name-charset
10205                                      (gnus-find-method-for-group
10206                                       gnus-newsgroup-name)
10207                                      gnus-newsgroup-name)))
10208                        (append (list (cons "Newsgroups" charset)
10209                                      (cons "Followup-To" charset)
10210                                      (cons "Xref" charset))
10211                                rfc2047-header-encoding-alist))))
10212               ,(if (not raw) '(progn
10213                                 (mml-to-mime)
10214                                 (mml-destroy-buffers)
10215                                 (remove-hook 'kill-buffer-hook
10216                                              'mml-destroy-buffers t)
10217                                 (kill-local-variable 'mml-buffer-list)))
10218               (gnus-summary-edit-article-done
10219                ,(or (mail-header-references gnus-current-headers) "")
10220                ,(gnus-group-read-only-p)
10221                ,gnus-summary-buffer no-highlight))))))))
10222
10223 (defalias 'gnus-summary-edit-article-postpone 'gnus-article-edit-exit)
10224
10225 (defun gnus-summary-edit-article-done (&optional references read-only buffer
10226                                                  no-highlight)
10227   "Make edits to the current article permanent."
10228   (interactive)
10229   (save-excursion
10230    ;; The buffer restriction contains the entire article if it exists.
10231     (when (article-goto-body)
10232       (let ((lines (count-lines (point) (point-max)))
10233             (length (- (point-max) (point)))
10234             (case-fold-search t)
10235             (body (copy-marker (point))))
10236         (goto-char (point-min))
10237         (when (re-search-forward "^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
10242                "^x-content-length:[ \t]\\([0-9]+\\)" body t)
10243           (delete-region (match-beginning 1) (match-end 1))
10244           (insert (number-to-string length)))
10245         (goto-char (point-min))
10246         (when (re-search-forward "^lines:[ \t]\\([0-9]+\\)" body t)
10247           (delete-region (match-beginning 1) (match-end 1))
10248           (insert (number-to-string lines))))))
10249   ;; Replace the article.
10250   (let ((buf (current-buffer)))
10251     (with-temp-buffer
10252       (insert-buffer-substring buf)
10253
10254       (if (and (not read-only)
10255                (not (gnus-request-replace-article
10256                      (cdr gnus-article-current) (car gnus-article-current)
10257                      (current-buffer) t)))
10258           (error "Couldn't replace article")
10259         ;; Update the summary buffer.
10260         (if (and references
10261                  (equal (message-tokenize-header references " ")
10262                         (message-tokenize-header
10263                          (or (message-fetch-field "references") "") " ")))
10264             ;; We only have to update this line.
10265             (save-excursion
10266               (save-restriction
10267                 (message-narrow-to-head)
10268                 (let ((head (buffer-substring-no-properties
10269                              (point-min) (point-max)))
10270                       header)
10271                   (with-temp-buffer
10272                     (insert (format "211 %d Article retrieved.\n"
10273                                     (cdr gnus-article-current)))
10274                     (insert head)
10275                     (insert ".\n")
10276                     (let ((nntp-server-buffer (current-buffer)))
10277                       (setq header (car (gnus-get-newsgroup-headers
10278                                          nil t))))
10279                     (with-current-buffer gnus-summary-buffer
10280                       (gnus-data-set-header
10281                        (gnus-data-find (cdr gnus-article-current))
10282                        header)
10283                       (gnus-summary-update-article-line
10284                        (cdr gnus-article-current) header)
10285                       (if (gnus-summary-goto-subject
10286                            (cdr gnus-article-current) nil t)
10287                           (gnus-summary-update-secondary-mark
10288                            (cdr gnus-article-current))))))))
10289           ;; Update threads.
10290           (set-buffer (or buffer gnus-summary-buffer))
10291           (gnus-summary-update-article (cdr gnus-article-current))
10292           (if (gnus-summary-goto-subject (cdr gnus-article-current) nil t)
10293               (gnus-summary-update-secondary-mark
10294                (cdr gnus-article-current))))
10295         ;; Prettify the article buffer again.
10296         (unless no-highlight
10297           (with-current-buffer gnus-article-buffer
10298             ;;;!!! Fix this -- article should be rehighlighted.
10299             ;;;(gnus-run-hooks 'gnus-article-display-hook)
10300             (set-buffer gnus-original-article-buffer)
10301             (gnus-request-article
10302              (cdr gnus-article-current)
10303              (car gnus-article-current) (current-buffer))))
10304         ;; Prettify the summary buffer line.
10305         (when (gnus-visual-p 'summary-highlight 'highlight)
10306           (gnus-run-hooks 'gnus-visual-mark-article-hook))))))
10307
10308 (defun gnus-summary-edit-wash (key)
10309   "Perform editing command KEY in the article buffer."
10310   (interactive
10311    (list
10312     (progn
10313       (message "%s" (concat (this-command-keys) "- "))
10314       (read-char))))
10315   (message "")
10316   (gnus-summary-edit-article)
10317   (execute-kbd-macro (concat (this-command-keys) key))
10318   (gnus-article-edit-done))
10319
10320 ;;; Respooling
10321
10322 (defun gnus-summary-respool-query (&optional silent trace)
10323   "Query where the respool algorithm would put this article."
10324   (interactive)
10325   (let (gnus-mark-article-hook)
10326     (gnus-summary-select-article)
10327     (with-current-buffer gnus-original-article-buffer
10328       (let ((groups (nnmail-article-group 'identity trace)))
10329         (unless silent
10330           (if groups
10331               (message "This message would go to %s"
10332                        (mapconcat 'car groups ", "))
10333             (message "This message would go to no groups"))
10334           groups)))))
10335
10336 (defun gnus-summary-respool-trace ()
10337   "Trace where the respool algorithm would put this article.
10338 Display a buffer showing all fancy splitting patterns which matched."
10339   (interactive)
10340   (gnus-summary-respool-query nil t))
10341
10342 ;; Summary marking commands.
10343
10344 (defun gnus-summary-kill-same-subject-and-select (&optional unmark)
10345   "Mark articles which has the same subject as read, and then select the next.
10346 If UNMARK is positive, remove any kind of mark.
10347 If UNMARK is negative, tick articles."
10348   (interactive "P")
10349   (when unmark
10350     (setq unmark (prefix-numeric-value unmark)))
10351   (let ((count
10352          (gnus-summary-mark-same-subject
10353           (gnus-summary-article-subject) unmark)))
10354     ;; Select next unread article.  If auto-select-same mode, should
10355     ;; select the first unread article.
10356     (gnus-summary-next-article t (and gnus-auto-select-same
10357                                       (gnus-summary-article-subject)))
10358     (gnus-message 7 "%d article%s marked as %s"
10359                   count (if (= count 1) " is" "s are")
10360                   (if unmark "unread" "read"))))
10361
10362 (defun gnus-summary-kill-same-subject (&optional unmark)
10363   "Mark articles which has the same subject as read.
10364 If UNMARK is positive, remove any kind of mark.
10365 If UNMARK is negative, tick articles."
10366   (interactive "P")
10367   (when unmark
10368     (setq unmark (prefix-numeric-value unmark)))
10369   (let ((count
10370          (gnus-summary-mark-same-subject
10371           (gnus-summary-article-subject) unmark)))
10372     ;; If marked as read, go to next unread subject.
10373     (when (null unmark)
10374       ;; Go to next unread subject.
10375       (gnus-summary-next-subject 1 t))
10376     (gnus-message 7 "%d articles are marked as %s"
10377                   count (if unmark "unread" "read"))))
10378
10379 (defun gnus-summary-mark-same-subject (subject &optional unmark)
10380   "Mark articles with same SUBJECT as read, and return marked number.
10381 If optional argument UNMARK is positive, remove any kinds of marks.
10382 If optional argument UNMARK is negative, mark articles as unread instead."
10383   (let ((count 1))
10384     (save-excursion
10385       (cond
10386        ((null unmark)                   ; Mark as read.
10387         (while (and
10388                 (progn
10389                   (gnus-summary-mark-article-as-read gnus-killed-mark)
10390                   (gnus-summary-show-thread) t)
10391                 (gnus-summary-find-subject subject))
10392           (setq count (1+ count))))
10393        ((> unmark 0)                    ; Tick.
10394         (while (and
10395                 (progn
10396                   (gnus-summary-mark-article-as-unread gnus-ticked-mark)
10397                   (gnus-summary-show-thread) t)
10398                 (gnus-summary-find-subject subject))
10399           (setq count (1+ count))))
10400        (t                               ; Mark as unread.
10401         (while (and
10402                 (progn
10403                   (gnus-summary-mark-article-as-unread gnus-unread-mark)
10404                   (gnus-summary-show-thread) t)
10405                 (gnus-summary-find-subject subject))
10406           (setq count (1+ count)))))
10407       (gnus-set-mode-line 'summary)
10408       ;; Return the number of marked articles.
10409       count)))
10410
10411 (defun gnus-summary-mark-as-processable (n &optional unmark)
10412   "Set the process mark on the next N articles.
10413 If N is negative, mark backward instead.  If UNMARK is non-nil, remove
10414 the process mark instead.  The difference between N and the actual
10415 number of articles marked is returned."
10416   (interactive "P")
10417   (if (and (null n) (gnus-region-active-p))
10418       (gnus-uu-mark-region (region-beginning) (region-end) unmark)
10419     (setq n (prefix-numeric-value n))
10420     (let ((backward (< n 0))
10421           (n (abs n)))
10422       (while (and
10423               (> n 0)
10424               (if unmark
10425                   (gnus-summary-remove-process-mark
10426                    (gnus-summary-article-number))
10427                 (gnus-summary-set-process-mark (gnus-summary-article-number)))
10428               (zerop (gnus-summary-next-subject (if backward -1 1) nil t)))
10429         (setq n (1- n)))
10430       (when (/= 0 n)
10431         (gnus-message 7 "No more articles"))
10432       (gnus-summary-recenter)
10433       (gnus-summary-position-point)
10434       n)))
10435
10436 (defun gnus-summary-unmark-as-processable (n)
10437   "Remove the process mark from the next N articles.
10438 If N is negative, unmark backward instead.  The difference between N and
10439 the actual number of articles unmarked is returned."
10440   (interactive "P")
10441   (gnus-summary-mark-as-processable n t))
10442
10443 (defun gnus-summary-unmark-all-processable ()
10444   "Remove the process mark from all articles."
10445   (interactive)
10446   (save-excursion
10447     (while gnus-newsgroup-processable
10448       (gnus-summary-remove-process-mark (car gnus-newsgroup-processable))))
10449   (gnus-summary-position-point))
10450
10451 (defun gnus-summary-add-mark (article type)
10452   "Mark ARTICLE with a mark of TYPE."
10453   (let ((vtype (car (assq type gnus-article-mark-lists)))
10454         var)
10455     (if (not vtype)
10456         (error "No such mark type: %s" type)
10457       (setq var (intern (format "gnus-newsgroup-%s" type)))
10458       (set var (cons article (symbol-value var)))
10459       (if (memq type '(processable cached replied forwarded recent saved))
10460           (gnus-summary-update-secondary-mark article)
10461         ;;; !!! This is bogus.  We should find out what primary
10462         ;;; !!! mark we want to set.
10463         (gnus-summary-update-mark gnus-del-mark 'unread)))))
10464
10465 (defun gnus-summary-mark-as-expirable (n)
10466   "Mark N articles forward as expirable.
10467 If N is negative, mark backward instead.  The difference between N and
10468 the actual number of articles marked is returned."
10469   (interactive "p")
10470   (gnus-summary-mark-forward n gnus-expirable-mark))
10471
10472 (defun gnus-summary-mark-as-spam (n)
10473   "Mark N articles forward as spam.
10474 If N is negative, mark backward instead.  The difference between N and
10475 the actual number of articles marked is returned."
10476   (interactive "p")
10477   (gnus-summary-mark-forward n gnus-spam-mark))
10478
10479 (defun gnus-summary-mark-article-as-replied (article)
10480   "Mark ARTICLE as replied to and update the summary line.
10481 ARTICLE can also be a list of articles."
10482   (interactive (list (gnus-summary-article-number)))
10483   (let ((articles (if (listp article) article (list article))))
10484     (dolist (article articles)
10485       (unless (numberp article)
10486         (error "%s is not a number" article))
10487       (push article gnus-newsgroup-replied)
10488       (let ((inhibit-read-only t))
10489         (when (gnus-summary-goto-subject article nil t)
10490           (gnus-summary-update-secondary-mark article))))))
10491
10492 (defun gnus-summary-mark-article-as-forwarded (article)
10493   "Mark ARTICLE as forwarded and update the summary line.
10494 ARTICLE can also be a list of articles."
10495   (let ((articles (if (listp article) article (list article))))
10496     (dolist (article articles)
10497       (push article gnus-newsgroup-forwarded)
10498       (let ((inhibit-read-only t))
10499         (when (gnus-summary-goto-subject article nil t)
10500           (gnus-summary-update-secondary-mark article))))))
10501
10502 (defun gnus-summary-set-bookmark (article)
10503   "Set a bookmark in current article."
10504   (interactive (list (gnus-summary-article-number)))
10505   (when (or (not (get-buffer gnus-article-buffer))
10506             (not gnus-current-article)
10507             (not gnus-article-current)
10508             (not (equal gnus-newsgroup-name (car gnus-article-current))))
10509     (error "No current article selected"))
10510   ;; Remove old bookmark, if one exists.
10511   (gnus-pull article gnus-newsgroup-bookmarks)
10512   ;; Set the new bookmark, which is on the form
10513   ;; (article-number . line-number-in-body).
10514   (push
10515    (cons article
10516          (with-current-buffer gnus-article-buffer
10517            (count-lines
10518             (min (point)
10519                  (save-excursion
10520                    (article-goto-body)
10521                    (point)))
10522             (point))))
10523    gnus-newsgroup-bookmarks)
10524   (gnus-message 6 "A bookmark has been added to the current article."))
10525
10526 (defun gnus-summary-remove-bookmark (article)
10527   "Remove the bookmark from the current article."
10528   (interactive (list (gnus-summary-article-number)))
10529   ;; Remove old bookmark, if one exists.
10530   (if (not (assq article gnus-newsgroup-bookmarks))
10531       (gnus-message 6 "No bookmark in current article.")
10532     (gnus-pull article gnus-newsgroup-bookmarks)
10533     (gnus-message 6 "Removed bookmark.")))
10534
10535 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
10536 (defun gnus-summary-mark-as-dormant (n)
10537   "Mark N articles forward as dormant.
10538 If N is negative, mark backward instead.  The difference between N and
10539 the actual number of articles marked is returned."
10540   (interactive "p")
10541   (gnus-summary-mark-forward n gnus-dormant-mark))
10542
10543 (defun gnus-summary-set-process-mark (article)
10544   "Set the process mark on ARTICLE and update the summary line."
10545   (setq gnus-newsgroup-processable
10546         (cons article
10547               (delq article gnus-newsgroup-processable)))
10548   (when (gnus-summary-goto-subject article)
10549     (gnus-summary-show-thread)
10550     (gnus-summary-goto-subject article)
10551     (gnus-summary-update-secondary-mark article)))
10552
10553 (defun gnus-summary-remove-process-mark (&rest articles)
10554   "Remove the process mark from ARTICLES and update the summary line."
10555   (dolist (article articles)
10556     (setq gnus-newsgroup-processable (delq article gnus-newsgroup-processable))
10557     (when (gnus-summary-goto-subject article)
10558       (gnus-summary-show-thread)
10559       (gnus-summary-goto-subject article)
10560       (gnus-summary-update-secondary-mark article)))
10561   t)
10562
10563 (defun gnus-summary-set-saved-mark (article)
10564   "Set the process mark on ARTICLE and update the summary line."
10565   (push article gnus-newsgroup-saved)
10566   (when (gnus-summary-goto-subject article)
10567     (gnus-summary-update-secondary-mark article)))
10568
10569 (defun gnus-summary-mark-forward (n &optional mark no-expire)
10570   "Mark N articles as read forwards.
10571 If N is negative, mark backwards instead.  Mark with MARK, ?r by default.
10572 The difference between N and the actual number of articles marked is
10573 returned.
10574 If NO-EXPIRE, auto-expiry will be inhibited."
10575   (interactive "p")
10576   (gnus-summary-show-thread)
10577   (let ((backward (< n 0))
10578         (gnus-summary-goto-unread
10579          (and gnus-summary-goto-unread
10580               (not (eq gnus-summary-goto-unread 'never))
10581               (not (memq mark (list gnus-unread-mark gnus-spam-mark
10582                                     gnus-ticked-mark gnus-dormant-mark)))))
10583         (n (abs n))
10584         (mark (or mark gnus-del-mark)))
10585     (while (and (> n 0)
10586                 (gnus-summary-mark-article nil mark no-expire)
10587                 (zerop (gnus-summary-next-subject
10588                         (if backward -1 1)
10589                         (and gnus-summary-goto-unread
10590                              (not (eq gnus-summary-goto-unread 'never)))
10591                         t)))
10592       (setq n (1- n)))
10593     (when (/= 0 n)
10594       (gnus-message 7 "No more %sarticles" (if mark "" "unread ")))
10595     (gnus-summary-recenter)
10596     (gnus-summary-position-point)
10597     (gnus-set-mode-line 'summary)
10598     n))
10599
10600 (defun gnus-summary-mark-article-as-read (mark)
10601   "Mark the current article quickly as read with MARK."
10602   (let ((article (gnus-summary-article-number)))
10603     (setq gnus-newsgroup-unreads (delq article gnus-newsgroup-unreads))
10604     (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked))
10605     (setq gnus-newsgroup-spam-marked (delq article gnus-newsgroup-spam-marked))
10606     (setq gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant))
10607     (push (cons article mark) gnus-newsgroup-reads)
10608     ;; Possibly remove from cache, if that is used.
10609     (when gnus-use-cache
10610       (gnus-cache-enter-remove-article article))
10611     ;; Allow the backend to change the mark.
10612     (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10613     ;; Check for auto-expiry.
10614     (when (and gnus-newsgroup-auto-expire
10615                (memq mark gnus-auto-expirable-marks))
10616       (setq mark gnus-expirable-mark)
10617       ;; Let the backend know about the mark change.
10618       (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10619       (push article gnus-newsgroup-expirable))
10620     ;; Set the mark in the buffer.
10621     (gnus-summary-update-mark mark 'unread)
10622     t))
10623
10624 (defun gnus-summary-mark-article-as-unread (mark)
10625   "Mark the current article quickly as unread with MARK."
10626   (let* ((article (gnus-summary-article-number))
10627          (old-mark (gnus-summary-article-mark article)))
10628     ;; Allow the backend to change the mark.
10629     (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10630     (if (eq mark old-mark)
10631         t
10632       (if (<= article 0)
10633           (progn
10634             (gnus-error 1 "Can't mark negative article numbers")
10635             nil)
10636         (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked))
10637         (setq gnus-newsgroup-spam-marked
10638               (delq article gnus-newsgroup-spam-marked))
10639         (setq gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant))
10640         (setq gnus-newsgroup-expirable (delq article gnus-newsgroup-expirable))
10641         (setq gnus-newsgroup-reads (delq article gnus-newsgroup-reads))
10642         (cond ((= mark gnus-ticked-mark)
10643                (setq gnus-newsgroup-marked
10644                      (gnus-add-to-sorted-list gnus-newsgroup-marked
10645                                               article)))
10646               ((= mark gnus-spam-mark)
10647                (setq gnus-newsgroup-spam-marked
10648                      (gnus-add-to-sorted-list gnus-newsgroup-spam-marked
10649                                               article)))
10650               ((= mark gnus-dormant-mark)
10651                (setq gnus-newsgroup-dormant
10652                      (gnus-add-to-sorted-list gnus-newsgroup-dormant
10653                                               article)))
10654               (t
10655                (setq gnus-newsgroup-unreads
10656                      (gnus-add-to-sorted-list gnus-newsgroup-unreads
10657                                               article))))
10658         (gnus-pull article gnus-newsgroup-reads)
10659
10660         ;; See whether the article is to be put in the cache.
10661         (and gnus-use-cache
10662              (vectorp (gnus-summary-article-header article))
10663              (save-excursion
10664                (gnus-cache-possibly-enter-article
10665                 gnus-newsgroup-name article
10666                 (= mark gnus-ticked-mark)
10667                 (= mark gnus-dormant-mark) (= mark gnus-unread-mark))))
10668
10669         ;; Fix the mark.
10670         (gnus-summary-update-mark mark 'unread)
10671         t))))
10672
10673 (defun gnus-summary-mark-article (&optional article mark no-expire)
10674   "Mark ARTICLE with MARK.  MARK can be any character.
10675 Four MARK strings are reserved: `? ' (unread), `?!' (ticked),
10676 `??' (dormant) and `?E' (expirable).
10677 If MARK is nil, then the default character `?r' is used.
10678 If ARTICLE is nil, then the article on the current line will be
10679 marked.
10680 If NO-EXPIRE, auto-expiry will be inhibited."
10681   ;; The mark might be a string.
10682   (when (stringp mark)
10683     (setq mark (aref mark 0)))
10684   ;; If no mark is given, then we check auto-expiring.
10685   (when (null mark)
10686     (setq mark gnus-del-mark))
10687   (when (and (not no-expire)
10688              gnus-newsgroup-auto-expire
10689              (memq mark gnus-auto-expirable-marks))
10690     (setq mark gnus-expirable-mark))
10691   (let ((article (or article (gnus-summary-article-number)))
10692         (old-mark (gnus-summary-article-mark article)))
10693     ;; Allow the backend to change the mark.
10694     (setq mark (gnus-request-update-mark gnus-newsgroup-name article mark))
10695     (if (eq mark old-mark)
10696         t
10697       (unless article
10698         (error "No article on current line"))
10699       (if (not (if (or (= mark gnus-unread-mark)
10700                        (= mark gnus-ticked-mark)
10701                        (= mark gnus-spam-mark)
10702                        (= mark gnus-dormant-mark))
10703                    (gnus-mark-article-as-unread article mark)
10704                  (gnus-mark-article-as-read article mark)))
10705           t
10706         ;; See whether the article is to be put in the cache.
10707         (and gnus-use-cache
10708              (not (= mark gnus-canceled-mark))
10709              (vectorp (gnus-summary-article-header article))
10710              (save-excursion
10711                (gnus-cache-possibly-enter-article
10712                 gnus-newsgroup-name article
10713                 (= mark gnus-ticked-mark)
10714                 (= mark gnus-dormant-mark) (= mark gnus-unread-mark))))
10715
10716         (when (gnus-summary-goto-subject article nil t)
10717           (let ((inhibit-read-only t))
10718             (gnus-summary-show-thread)
10719             ;; Fix the mark.
10720             (gnus-summary-update-mark mark 'unread)
10721             t))))))
10722
10723 (defun gnus-summary-update-secondary-mark (article)
10724   "Update the secondary (read, process, cache) mark."
10725   (gnus-summary-update-mark
10726    (cond ((memq article gnus-newsgroup-processable)
10727           gnus-process-mark)
10728          ((memq article gnus-newsgroup-cached)
10729           gnus-cached-mark)
10730          ((memq article gnus-newsgroup-replied)
10731           gnus-replied-mark)
10732          ((memq article gnus-newsgroup-forwarded)
10733           gnus-forwarded-mark)
10734          ((memq article gnus-newsgroup-saved)
10735           gnus-saved-mark)
10736          ((memq article gnus-newsgroup-recent)
10737           gnus-recent-mark)
10738          ((memq article gnus-newsgroup-unseen)
10739           gnus-unseen-mark)
10740          (t gnus-no-mark))
10741    'replied)
10742   (when (gnus-visual-p 'summary-highlight 'highlight)
10743     (gnus-summary-highlight-line)
10744     (gnus-run-hooks 'gnus-summary-update-hook))
10745   t)
10746
10747 (defun gnus-summary-update-download-mark (article)
10748   "Update the download mark."
10749   (gnus-summary-update-mark
10750    (cond ((memq article gnus-newsgroup-undownloaded)
10751           gnus-undownloaded-mark)
10752          (gnus-newsgroup-agentized
10753           gnus-downloaded-mark)
10754          (t
10755           gnus-no-mark))
10756    'download)
10757   (gnus-summary-update-line t)
10758   t)
10759
10760 (defun gnus-summary-update-mark (mark type)
10761   (let ((forward (cdr (assq type gnus-summary-mark-positions)))
10762         (inhibit-read-only t))
10763     (re-search-backward "[\n\r]" (point-at-bol) 'move-to-limit)
10764     (when forward
10765       (when (looking-at "\r")
10766         (incf forward))
10767       (when (<= (+ forward (point)) (point-max))
10768         ;; Go to the right position on the line.
10769         (goto-char (+ forward (point)))
10770         ;; Replace the old mark with the new mark.
10771         (let ((to-insert
10772                (mm-subst-char-in-string
10773                 (char-after) mark
10774                 (buffer-substring (point) (1+ (point))))))
10775           (delete-region (point) (1+ (point)))
10776           (insert to-insert))
10777         ;; Optionally update the marks by some user rule.
10778         (when (eq type 'unread)
10779           (gnus-data-set-mark
10780            (gnus-data-find (gnus-summary-article-number)) mark)
10781           (gnus-summary-update-line (eq mark gnus-unread-mark)))))))
10782
10783 (defun gnus-mark-article-as-read (article &optional mark)
10784   "Enter ARTICLE in the pertinent lists and remove it from others."
10785   ;; Make the article expirable.
10786   (let ((mark (or mark gnus-del-mark)))
10787     (setq gnus-newsgroup-expirable
10788           (if (= mark gnus-expirable-mark)
10789               (gnus-add-to-sorted-list gnus-newsgroup-expirable article)
10790             (delq article gnus-newsgroup-expirable)))
10791     ;; Remove from unread and marked lists.
10792     (setq gnus-newsgroup-unreads (delq article gnus-newsgroup-unreads))
10793     (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked))
10794     (setq gnus-newsgroup-spam-marked (delq article gnus-newsgroup-spam-marked))
10795     (setq gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant))
10796     (push (cons article mark) gnus-newsgroup-reads)
10797     ;; Possibly remove from cache, if that is used.
10798     (when gnus-use-cache
10799       (gnus-cache-enter-remove-article article))
10800     t))
10801
10802 (defun gnus-mark-article-as-unread (article &optional mark)
10803   "Enter ARTICLE in the pertinent lists and remove it from others."
10804   (let ((mark (or mark gnus-ticked-mark)))
10805     (if (<= article 0)
10806         (progn
10807           (gnus-error 1 "Can't mark negative article numbers")
10808           nil)
10809       (setq gnus-newsgroup-marked (delq article gnus-newsgroup-marked)
10810             gnus-newsgroup-spam-marked (delq article gnus-newsgroup-spam-marked)
10811             gnus-newsgroup-dormant (delq article gnus-newsgroup-dormant)
10812             gnus-newsgroup-expirable (delq article gnus-newsgroup-expirable)
10813             gnus-newsgroup-unreads (delq article gnus-newsgroup-unreads))
10814
10815       ;; Unsuppress duplicates?
10816       (when gnus-suppress-duplicates
10817         (gnus-dup-unsuppress-article article))
10818
10819       (cond ((= mark gnus-ticked-mark)
10820              (setq gnus-newsgroup-marked
10821                    (gnus-add-to-sorted-list gnus-newsgroup-marked article)))
10822             ((= mark gnus-spam-mark)
10823              (setq gnus-newsgroup-spam-marked
10824                    (gnus-add-to-sorted-list gnus-newsgroup-spam-marked
10825                                             article)))
10826             ((= mark gnus-dormant-mark)
10827              (setq gnus-newsgroup-dormant
10828                    (gnus-add-to-sorted-list gnus-newsgroup-dormant article)))
10829             (t
10830              (setq gnus-newsgroup-unreads
10831                    (gnus-add-to-sorted-list gnus-newsgroup-unreads article))))
10832       (gnus-pull article gnus-newsgroup-reads)
10833       t)))
10834
10835 (defalias 'gnus-summary-mark-as-unread-forward
10836   'gnus-summary-tick-article-forward)
10837 (make-obsolete 'gnus-summary-mark-as-unread-forward
10838                'gnus-summary-tick-article-forward "Emacs 20.4")
10839 (defun gnus-summary-tick-article-forward (n)
10840   "Tick N articles forwards.
10841 If N is negative, tick backwards instead.
10842 The difference between N and the number of articles ticked is returned."
10843   (interactive "p")
10844   (gnus-summary-mark-forward n gnus-ticked-mark))
10845
10846 (defalias 'gnus-summary-mark-as-unread-backward
10847   'gnus-summary-tick-article-backward)
10848 (make-obsolete 'gnus-summary-mark-as-unread-backward
10849                'gnus-summary-tick-article-backward "Emacs 20.4")
10850 (defun gnus-summary-tick-article-backward (n)
10851   "Tick N articles backwards.
10852 The difference between N and the number of articles ticked is returned."
10853   (interactive "p")
10854   (gnus-summary-mark-forward (- n) gnus-ticked-mark))
10855
10856 (defalias 'gnus-summary-mark-as-unread 'gnus-summary-tick-article)
10857 (make-obsolete 'gnus-summary-mark-as-unread 'gnus-summary-tick-article "Emacs 20.4")
10858 (defun gnus-summary-tick-article (&optional article clear-mark)
10859   "Mark current article as unread.
10860 Optional 1st argument ARTICLE specifies article number to be marked as unread.
10861 Optional 2nd argument CLEAR-MARK remove any kinds of mark."
10862   (interactive)
10863   (gnus-summary-mark-article article (if clear-mark gnus-unread-mark
10864                                        gnus-ticked-mark)))
10865
10866 (defun gnus-summary-mark-as-read-forward (n)
10867   "Mark N articles as read forwards.
10868 If N is negative, mark backwards instead.
10869 The difference between N and the actual number of articles marked is
10870 returned."
10871   (interactive "p")
10872   (gnus-summary-mark-forward n gnus-del-mark gnus-inhibit-user-auto-expire))
10873
10874 (defun gnus-summary-mark-as-read-backward (n)
10875   "Mark the N articles as read backwards.
10876 The difference between N and the actual number of articles marked is
10877 returned."
10878   (interactive "p")
10879   (gnus-summary-mark-forward
10880    (- n) gnus-del-mark gnus-inhibit-user-auto-expire))
10881
10882 (defun gnus-summary-mark-as-read (&optional article mark)
10883   "Mark current article as read.
10884 ARTICLE specifies the article to be marked as read.
10885 MARK specifies a string to be inserted at the beginning of the line."
10886   (gnus-summary-mark-article article mark))
10887
10888 (defun gnus-summary-clear-mark-forward (n)
10889   "Clear marks from N articles forward.
10890 If N is negative, clear backward instead.
10891 The difference between N and the number of marks cleared is returned."
10892   (interactive "p")
10893   (gnus-summary-mark-forward n gnus-unread-mark))
10894
10895 (defun gnus-summary-clear-mark-backward (n)
10896   "Clear marks from N articles backward.
10897 The difference between N and the number of marks cleared is returned."
10898   (interactive "p")
10899   (gnus-summary-mark-forward (- n) gnus-unread-mark))
10900
10901 (defun gnus-summary-mark-unread-as-read ()
10902   "Intended to be used by `gnus-mark-article-hook'."
10903   (when (memq gnus-current-article gnus-newsgroup-unreads)
10904     (gnus-summary-mark-article gnus-current-article gnus-read-mark)))
10905
10906 (defun gnus-summary-mark-read-and-unread-as-read (&optional new-mark)
10907   "Intended to be used by `gnus-mark-article-hook'."
10908   (let ((mark (gnus-summary-article-mark)))
10909     (when (or (gnus-unread-mark-p mark)
10910               (gnus-read-mark-p mark))
10911       (gnus-summary-mark-article gnus-current-article
10912                                  (or new-mark gnus-read-mark)))))
10913
10914 (defun gnus-summary-mark-current-read-and-unread-as-read (&optional new-mark)
10915   "Intended to be used by `gnus-mark-article-hook'."
10916   (let ((mark (gnus-summary-article-mark)))
10917     (when (or (gnus-unread-mark-p mark)
10918               (gnus-read-mark-p mark))
10919       (gnus-summary-mark-article (gnus-summary-article-number)
10920                                  (or new-mark gnus-read-mark)))))
10921
10922 (defun gnus-summary-mark-unread-as-ticked ()
10923   "Intended to be used by `gnus-mark-article-hook'."
10924   (when (memq gnus-current-article gnus-newsgroup-unreads)
10925     (gnus-summary-mark-article gnus-current-article gnus-ticked-mark)))
10926
10927 (defun gnus-summary-mark-region-as-read (point mark all)
10928   "Mark all unread articles between point and mark as read.
10929 If given a prefix, mark all articles between point and mark as read,
10930 even ticked and dormant ones."
10931   (interactive "r\nP")
10932   (save-excursion
10933     (let (article)
10934       (goto-char point)
10935       (beginning-of-line)
10936       (while (and
10937               (< (point) mark)
10938               (progn
10939                 (when (or all
10940                           (memq (setq article (gnus-summary-article-number))
10941                                 gnus-newsgroup-unreads))
10942                   (gnus-summary-mark-article article gnus-del-mark))
10943                 t)
10944               (gnus-summary-find-next))))))
10945
10946 (defun gnus-summary-mark-below (score mark)
10947   "Mark articles with score less than SCORE with MARK."
10948   (interactive "P\ncMark: ")
10949   (setq score (if score
10950                   (prefix-numeric-value score)
10951                 (or gnus-summary-default-score 0)))
10952   (with-current-buffer gnus-summary-buffer
10953     (goto-char (point-min))
10954     (while
10955         (progn
10956           (and (< (gnus-summary-article-score) score)
10957                (gnus-summary-mark-article nil mark))
10958           (gnus-summary-find-next)))))
10959
10960 (defun gnus-summary-kill-below (&optional score)
10961   "Mark articles with score below SCORE as read."
10962   (interactive "P")
10963   (gnus-summary-mark-below score gnus-killed-mark))
10964
10965 (defun gnus-summary-clear-above (&optional score)
10966   "Clear all marks from articles with score above SCORE."
10967   (interactive "P")
10968   (gnus-summary-mark-above score gnus-unread-mark))
10969
10970 (defun gnus-summary-tick-above (&optional score)
10971   "Tick all articles with score above SCORE."
10972   (interactive "P")
10973   (gnus-summary-mark-above score gnus-ticked-mark))
10974
10975 (defun gnus-summary-mark-above (score mark)
10976   "Mark articles with score over SCORE with MARK."
10977   (interactive "P\ncMark: ")
10978   (setq score (if score
10979                   (prefix-numeric-value score)
10980                 (or gnus-summary-default-score 0)))
10981   (with-current-buffer gnus-summary-buffer
10982     (goto-char (point-min))
10983     (while (and (progn
10984                   (when (> (gnus-summary-article-score) score)
10985                     (gnus-summary-mark-article nil mark))
10986                   t)
10987                 (gnus-summary-find-next)))))
10988
10989 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
10990 (defalias 'gnus-summary-show-all-expunged 'gnus-summary-limit-include-expunged)
10991 (defun gnus-summary-limit-include-expunged (&optional no-error)
10992   "Display all the hidden articles that were expunged for low scores."
10993   (interactive)
10994   (let ((inhibit-read-only t))
10995     (let ((scored gnus-newsgroup-scored)
10996           headers h)
10997       (while scored
10998         (unless (gnus-summary-article-header (caar scored))
10999           (and (setq h (gnus-number-to-header (caar scored)))
11000                (< (cdar scored) gnus-summary-expunge-below)
11001                (push h headers)))
11002         (setq scored (cdr scored)))
11003       (if (not headers)
11004           (when (not no-error)
11005             (error "No expunged articles hidden"))
11006         (goto-char (point-min))
11007         (push gnus-newsgroup-limit gnus-newsgroup-limits)
11008         (setq gnus-newsgroup-limit (copy-sequence gnus-newsgroup-limit))
11009         (dolist (x headers)
11010           (push (mail-header-number x) gnus-newsgroup-limit))
11011         (gnus-summary-prepare-unthreaded (nreverse headers))
11012         (goto-char (point-min))
11013         (gnus-summary-position-point)
11014         t))))
11015
11016 (defun gnus-summary-catchup (&optional all quietly to-here not-mark reverse)
11017   "Mark all unread articles in this newsgroup as read.
11018 If prefix argument ALL is non-nil, ticked and dormant articles will
11019 also be marked as read.
11020 If QUIETLY is non-nil, no questions will be asked.
11021
11022 If TO-HERE is non-nil, it should be a point in the buffer.  All
11023 articles before (after, if REVERSE is set) this point will be marked
11024 as read.
11025
11026 Note that this function will only catch up the unread article
11027 in the current summary buffer limitation.
11028
11029 The number of articles marked as read is returned."
11030   (interactive "P")
11031   (prog1
11032       (save-excursion
11033         (when (or quietly
11034                   (not gnus-interactive-catchup) ;Without confirmation?
11035                   gnus-expert-user
11036                   (gnus-y-or-n-p
11037                    (if all
11038                        "Mark absolutely all articles as read? "
11039                      "Mark all unread articles as read? ")))
11040           (if (and not-mark
11041                    (not gnus-newsgroup-adaptive)
11042                    (not gnus-newsgroup-auto-expire)
11043                    (not gnus-suppress-duplicates)
11044                    (or (not gnus-use-cache)
11045                        (eq gnus-use-cache 'passive)))
11046               (progn
11047                 (when all
11048                   (setq gnus-newsgroup-marked nil
11049                         gnus-newsgroup-spam-marked nil
11050                         gnus-newsgroup-dormant nil))
11051                 (setq gnus-newsgroup-unreads
11052                       (gnus-sorted-nunion
11053                        (gnus-sorted-intersection gnus-newsgroup-unreads
11054                                                  gnus-newsgroup-downloadable)
11055                        (gnus-sorted-difference gnus-newsgroup-unfetched
11056                                                gnus-newsgroup-cached))))
11057             ;; We actually mark all articles as canceled, which we
11058             ;; have to do when using auto-expiry or adaptive scoring.
11059             (gnus-summary-show-all-threads)
11060             (if (and to-here reverse)
11061                 (progn
11062                   (goto-char to-here)
11063                   (gnus-summary-mark-current-read-and-unread-as-read
11064                    gnus-catchup-mark)
11065                   (while (gnus-summary-find-next (not all))
11066                     (gnus-summary-mark-article-as-read gnus-catchup-mark)))
11067               (when (gnus-summary-first-subject (not all))
11068                 (while (and
11069                         (if to-here (< (point) to-here) t)
11070                         (gnus-summary-mark-article-as-read gnus-catchup-mark)
11071                         (gnus-summary-find-next (not all))))))
11072             (gnus-set-mode-line 'summary))
11073           t))
11074     (gnus-summary-position-point)))
11075
11076 (defun gnus-summary-catchup-to-here (&optional all)
11077   "Mark all unticked articles before the current one as read.
11078 If ALL is non-nil, also mark ticked and dormant articles as read."
11079   (interactive "P")
11080   (save-excursion
11081     (gnus-save-hidden-threads
11082       (let ((beg (point)))
11083         ;; We check that there are unread articles.
11084         (when (or all (gnus-summary-find-prev))
11085           (gnus-summary-catchup all t beg)))))
11086   (gnus-summary-position-point))
11087
11088 (defun gnus-summary-catchup-from-here (&optional all)
11089   "Mark all unticked articles after (and including) the current one as read.
11090 If ALL is non-nil, also mark ticked and dormant articles as read."
11091   (interactive "P")
11092   (save-excursion
11093     (gnus-save-hidden-threads
11094       (let ((beg (point)))
11095         ;; We check that there are unread articles.
11096         (when (or all (gnus-summary-find-next))
11097           (gnus-summary-catchup all t beg nil t)))))
11098   (gnus-summary-position-point))
11099
11100 (defun gnus-summary-catchup-all (&optional quietly)
11101   "Mark all articles in this newsgroup as read.
11102 This command is dangerous.  Normally, you want \\[gnus-summary-catchup]
11103 instead, which marks only unread articles as read."
11104   (interactive "P")
11105   (gnus-summary-catchup t quietly))
11106
11107 (defun gnus-summary-catchup-and-exit (&optional all quietly)
11108   "Mark all unread articles in this group as read, then exit.
11109 If prefix argument ALL is non-nil, all articles are marked as read.
11110 If QUIETLY is non-nil, no questions will be asked."
11111   (interactive "P")
11112   (when (gnus-summary-catchup all quietly nil 'fast)
11113     ;; Select next newsgroup or exit.
11114     (if (and (not (gnus-group-quit-config gnus-newsgroup-name))
11115              (eq gnus-auto-select-next 'quietly))
11116         (gnus-summary-next-group nil)
11117       (gnus-summary-exit))))
11118
11119 (defun gnus-summary-catchup-all-and-exit (&optional quietly)
11120   "Mark all articles in this newsgroup as read, and then exit.
11121 This command is dangerous.  Normally, you want \\[gnus-summary-catchup-and-exit]
11122 instead, which marks only unread articles as read."
11123   (interactive "P")
11124   (gnus-summary-catchup-and-exit t quietly))
11125
11126 (defun gnus-summary-catchup-and-goto-next-group (&optional all)
11127   "Mark all articles in this group as read and select the next group.
11128 If given a prefix, mark all articles, unread as well as ticked, as
11129 read."
11130   (interactive "P")
11131   (save-excursion
11132     (gnus-summary-catchup all))
11133   (gnus-summary-next-group))
11134
11135 (defun gnus-summary-catchup-and-goto-prev-group (&optional all)
11136   "Mark all articles in this group as read and select the previous group.
11137 If given a prefix, mark all articles, unread as well as ticked, as
11138 read."
11139   (interactive "P")
11140   (save-excursion
11141     (gnus-summary-catchup all))
11142   (gnus-summary-next-group nil nil t))
11143
11144 ;;;
11145 ;;; with article
11146 ;;;
11147
11148 (defmacro gnus-with-article (article &rest forms)
11149   "Select ARTICLE and perform FORMS in the original article buffer.
11150 Then replace the article with the result."
11151   `(progn
11152      ;; We don't want the article to be marked as read.
11153      (let (gnus-mark-article-hook)
11154        (gnus-summary-select-article t t nil ,article))
11155      (set-buffer gnus-original-article-buffer)
11156      ,@forms
11157      (if (not (gnus-check-backend-function
11158                'request-replace-article (car gnus-article-current)))
11159          (gnus-message 5 "Read-only group; not replacing")
11160        (unless (gnus-request-replace-article
11161                 ,article (car gnus-article-current)
11162                 (current-buffer) t)
11163          (error "Couldn't replace article")))
11164      ;; The cache and backlog have to be flushed somewhat.
11165      (when gnus-keep-backlog
11166        (gnus-backlog-remove-article
11167         (car gnus-article-current) (cdr gnus-article-current)))
11168      (when gnus-use-cache
11169        (gnus-cache-update-article
11170         (car gnus-article-current) (cdr gnus-article-current)))))
11171
11172 (put 'gnus-with-article 'lisp-indent-function 1)
11173 (put 'gnus-with-article 'edebug-form-spec '(form body))
11174
11175 ;; Thread-based commands.
11176
11177 (defun gnus-summary-articles-in-thread (&optional article)
11178   "Return a list of all articles in the current thread.
11179 If ARTICLE is non-nil, return all articles in the thread that starts
11180 with that article."
11181   (let* ((article (or article (gnus-summary-article-number)))
11182          (data (gnus-data-find-list article))
11183          (top-level (gnus-data-level (car data)))
11184          (top-subject
11185           (cond ((null gnus-thread-operation-ignore-subject)
11186                  (gnus-simplify-subject-re
11187                   (mail-header-subject (gnus-data-header (car data)))))
11188                 ((eq gnus-thread-operation-ignore-subject 'fuzzy)
11189                  (gnus-simplify-subject-fuzzy
11190                   (mail-header-subject (gnus-data-header (car data)))))
11191                 (t nil)))
11192          (end-point (save-excursion
11193                       (if (gnus-summary-go-to-next-thread)
11194                           (point) (point-max))))
11195          articles)
11196     (while (and data
11197                 (< (gnus-data-pos (car data)) end-point))
11198       (when (or (not top-subject)
11199                 (string= top-subject
11200                          (if (eq gnus-thread-operation-ignore-subject 'fuzzy)
11201                              (gnus-simplify-subject-fuzzy
11202                               (mail-header-subject
11203                                (gnus-data-header (car data))))
11204                            (gnus-simplify-subject-re
11205                             (mail-header-subject
11206                              (gnus-data-header (car data)))))))
11207         (push (gnus-data-number (car data)) articles))
11208       (unless (and (setq data (cdr data))
11209                    (> (gnus-data-level (car data)) top-level))
11210         (setq data nil)))
11211     ;; Return the list of articles.
11212     (nreverse articles)))
11213
11214 (defun gnus-summary-rethread-current ()
11215   "Rethread the thread the current article is part of."
11216   (interactive)
11217   (let* ((gnus-show-threads t)
11218          (article (gnus-summary-article-number))
11219          (id (mail-header-id (gnus-summary-article-header)))
11220          (gnus-newsgroup-threads (list (gnus-id-to-thread (gnus-root-id id)))))
11221     (unless id
11222       (error "No article on the current line"))
11223     (gnus-rebuild-thread id)
11224     (gnus-summary-goto-subject article)))
11225
11226 (defun gnus-summary-reparent-thread ()
11227   "Make the current article child of the marked (or previous) article.
11228
11229 Note that the re-threading will only work if `gnus-thread-ignore-subject'
11230 is non-nil or the Subject: of both articles are the same."
11231   (interactive)
11232   (unless (not (gnus-group-read-only-p))
11233     (error "The current newsgroup does not support article editing"))
11234   (unless (<= (length gnus-newsgroup-processable) 1)
11235     (error "No more than one article may be marked"))
11236   (let ((child (gnus-summary-article-number))
11237         ;; First grab the marked article, otherwise one line up.
11238         (parent (if (not (null gnus-newsgroup-processable))
11239                     (car gnus-newsgroup-processable)
11240                   (save-excursion
11241                     (if (eq (forward-line -1) 0)
11242                         (gnus-summary-article-number)
11243                       (error "Beginning of summary buffer"))))))
11244     (gnus-summary-reparent-children parent (list child))))
11245
11246 (defun gnus-summary-reparent-children (parent children)
11247   "Make PARENT the parent of CHILDREN.
11248 When called interactively, PARENT is the current article and CHILDREN
11249 are the process-marked articles."
11250   (interactive
11251    (list (gnus-summary-article-number)
11252          (gnus-summary-work-articles nil)))
11253   (dolist (child children)
11254     (save-window-excursion
11255       (let ((gnus-article-buffer " *reparent*"))
11256         (unless (not (eq parent child))
11257           (error "An article may not be self-referential"))
11258         (let ((message-id (mail-header-id
11259                            (gnus-summary-article-header parent))))
11260           (unless (and message-id (not (equal message-id "")))
11261             (error "No message-id in desired parent"))
11262           (gnus-with-article child
11263             (save-restriction
11264               (goto-char (point-min))
11265               (message-narrow-to-head)
11266               (if (re-search-forward "^References: " nil t)
11267                   (progn
11268                     (re-search-forward "^[^ \t]" nil t)
11269                     (forward-line -1)
11270                     (end-of-line)
11271                     (insert " " message-id))
11272                 (insert "References: " message-id "\n"))))
11273           (set-buffer gnus-summary-buffer)
11274           (gnus-summary-unmark-all-processable)
11275           (gnus-summary-update-article child)
11276           (when (gnus-summary-goto-subject (cdr gnus-article-current) nil t)
11277             (gnus-summary-update-secondary-mark (cdr gnus-article-current)))
11278           (gnus-summary-rethread-current)
11279           (gnus-message 3 "Article %d is now the child of article %d"
11280                         child parent))))))
11281
11282 (defun gnus-summary-toggle-threads (&optional arg)
11283   "Toggle showing conversation threads.
11284 If ARG is positive number, turn showing conversation threads on."
11285   (interactive "P")
11286   (let ((current (or (gnus-summary-article-number) gnus-newsgroup-end)))
11287     (setq gnus-show-threads
11288           (if (null arg) (not gnus-show-threads)
11289             (> (prefix-numeric-value arg) 0)))
11290     (gnus-summary-prepare)
11291     (gnus-summary-goto-subject current)
11292     (gnus-message 6 "Threading is now %s" (if gnus-show-threads "on" "off"))
11293     (gnus-summary-position-point)))
11294
11295 (eval-and-compile
11296   (if (fboundp 'remove-overlays)
11297       (defalias 'gnus-remove-overlays 'remove-overlays)
11298     (defun gnus-remove-overlays (beg end name val)
11299       "Clear BEG and END of overlays whose property NAME has value VAL.
11300 For compatibility with XEmacs."
11301       (dolist (ov (gnus-overlays-in beg end))
11302         (when (eq (gnus-overlay-get ov name) val)
11303           (gnus-delete-overlay ov))))))
11304
11305 (defun gnus-summary-show-all-threads ()
11306   "Show all threads."
11307   (interactive)
11308   (gnus-remove-overlays (point-min) (point-max) 'invisible 'gnus-sum)
11309   (gnus-summary-position-point))
11310
11311 (defun gnus-summary-show-thread ()
11312   "Show thread subtrees.
11313 Returns nil if no thread was there to be shown."
11314   (interactive)
11315   (let* ((orig (point))
11316          (end (point-at-eol))
11317          ;; Leave point at bol
11318          (beg (progn (beginning-of-line) (if (bobp) (point) (1- (point)))))
11319          (eoi (when (eq (get-char-property end 'invisible) 'gnus-sum)
11320                 (if (fboundp 'next-single-char-property-change)
11321                     (or (next-single-char-property-change end 'invisible)
11322                         (point-max))
11323                   (while (progn
11324                            (end-of-line 2)
11325                            (and (not (eobp))
11326                                 (eq (get-char-property (point) 'invisible)
11327                                     'gnus-sum))))
11328                   (point)))))
11329     (when eoi
11330       (gnus-remove-overlays beg eoi 'invisible 'gnus-sum)
11331       (goto-char orig)
11332       (gnus-summary-position-point)
11333       eoi)))
11334
11335 (defun gnus-summary-maybe-hide-threads ()
11336   "If requested, hide the threads that should be hidden."
11337   (when (and gnus-show-threads
11338              gnus-thread-hide-subtree)
11339     (gnus-summary-hide-all-threads
11340      (if (or (consp gnus-thread-hide-subtree)
11341              (functionp gnus-thread-hide-subtree))
11342          (gnus-make-predicate gnus-thread-hide-subtree)
11343        nil))))
11344
11345 ;;; Hiding predicates.
11346
11347 (defun gnus-article-unread-p (header)
11348   (memq (mail-header-number header) gnus-newsgroup-unreads))
11349
11350 (defun gnus-article-unseen-p (header)
11351   (memq (mail-header-number header) gnus-newsgroup-unseen))
11352
11353 (defun gnus-map-articles (predicate articles)
11354   "Map PREDICATE over ARTICLES and return non-nil if any predicate is non-nil."
11355   (apply 'gnus-or (mapcar predicate
11356                           (mapcar (lambda (number)
11357                                     (gnus-summary-article-header number))
11358                                   articles))))
11359
11360 (defun gnus-summary-hide-all-threads (&optional predicate)
11361   "Hide all thread subtrees.
11362 If PREDICATE is supplied, threads that satisfy this predicate
11363 will not be hidden."
11364   (interactive)
11365   (save-excursion
11366     (goto-char (point-min))
11367     (let ((end nil))
11368       (while (not end)
11369         (when (or (not predicate)
11370                   (gnus-map-articles
11371                    predicate (gnus-summary-article-children)))
11372             (gnus-summary-hide-thread))
11373         (setq end (not (zerop (gnus-summary-next-thread 1 t)))))))
11374   (gnus-summary-position-point))
11375
11376 (defun gnus-summary-hide-thread ()
11377   "Hide thread subtrees.
11378 If PREDICATE is supplied, threads that satisfy this predicate
11379 will not be hidden.
11380 Returns nil if no threads were there to be hidden."
11381   (interactive)
11382   (let ((start (point))
11383         (starteol (line-end-position))
11384         (article (gnus-summary-article-number)))
11385     (goto-char start)
11386     ;; Go forward until either the buffer ends or the subthread ends.
11387     (when (and (not (eobp))
11388                (or (zerop (gnus-summary-next-thread 1 t))
11389                    (goto-char (point-max))))
11390       (if (and (> (point) start)
11391                ;; FIXME: this should actually search for a non-invisible \n.
11392                (search-backward "\n" start t))
11393           (progn
11394             (when (> (point) starteol)
11395               (gnus-remove-overlays starteol (point) 'invisible 'gnus-sum)
11396               (let ((ol (gnus-make-overlay starteol (point) nil t nil)))
11397                 (gnus-overlay-put ol 'invisible 'gnus-sum)
11398                 (gnus-overlay-put ol 'evaporate t)))
11399             (gnus-summary-goto-subject article))
11400         (goto-char start)
11401         nil))))
11402
11403 (defun gnus-summary-go-to-next-thread (&optional previous)
11404   "Go to the same level (or less) next thread.
11405 If PREVIOUS is non-nil, go to previous thread instead.
11406 Return the article number moved to, or nil if moving was impossible."
11407   (let ((level (gnus-summary-thread-level))
11408         (way (if previous -1 1))
11409         (beg (point)))
11410     (forward-line way)
11411     (while (and (not (eobp))
11412                 (< level (gnus-summary-thread-level)))
11413       (forward-line way))
11414     (if (eobp)
11415         (progn
11416           (goto-char beg)
11417           nil)
11418       (setq beg (point))
11419       (prog1
11420           (gnus-summary-article-number)
11421         (goto-char beg)))))
11422
11423 (defun gnus-summary-next-thread (n &optional silent)
11424   "Go to the same level next N'th thread.
11425 If N is negative, search backward instead.
11426 Returns the difference between N and the number of skips actually
11427 done.
11428
11429 If SILENT, don't output messages."
11430   (interactive "p")
11431   (let ((backward (< n 0))
11432         (n (abs n)))
11433     (while (and (> n 0)
11434                 (gnus-summary-go-to-next-thread backward))
11435       (decf n))
11436     (unless silent
11437       (gnus-summary-position-point))
11438     (when (and (not silent) (/= 0 n))
11439       (gnus-message 7 "No more threads"))
11440     n))
11441
11442 (defun gnus-summary-prev-thread (n)
11443   "Go to the same level previous N'th thread.
11444 Returns the difference between N and the number of skips actually
11445 done."
11446   (interactive "p")
11447   (gnus-summary-next-thread (- n)))
11448
11449 (defun gnus-summary-go-down-thread ()
11450   "Go down one level in the current thread."
11451   (let ((children (gnus-summary-article-children)))
11452     (when children
11453       (gnus-summary-goto-subject (car children)))))
11454
11455 (defun gnus-summary-go-up-thread ()
11456   "Go up one level in the current thread."
11457   (let ((parent (gnus-summary-article-parent)))
11458     (when parent
11459       (gnus-summary-goto-subject parent))))
11460
11461 (defun gnus-summary-down-thread (n)
11462   "Go down thread N steps.
11463 If N is negative, go up instead.
11464 Returns the difference between N and how many steps down that were
11465 taken."
11466   (interactive "p")
11467   (let ((up (< n 0))
11468         (n (abs n)))
11469     (while (and (> n 0)
11470                 (if up (gnus-summary-go-up-thread)
11471                   (gnus-summary-go-down-thread)))
11472       (setq n (1- n)))
11473     (gnus-summary-position-point)
11474     (when (/= 0 n)
11475       (gnus-message 7 "Can't go further"))
11476     n))
11477
11478 (defun gnus-summary-up-thread (n)
11479   "Go up thread N steps.
11480 If N is negative, go down instead.
11481 Returns the difference between N and how many steps down that were
11482 taken."
11483   (interactive "p")
11484   (gnus-summary-down-thread (- n)))
11485
11486 (defun gnus-summary-top-thread ()
11487   "Go to the top of the thread."
11488   (interactive)
11489   (while (gnus-summary-go-up-thread))
11490   (gnus-summary-article-number))
11491
11492 (defun gnus-summary-expire-thread ()
11493   "Mark articles under current thread as expired."
11494   (interactive)
11495   (gnus-summary-kill-thread 0))
11496
11497 (defun gnus-summary-kill-thread (&optional unmark)
11498   "Mark articles under current thread as read.
11499 If the prefix argument is positive, remove any kinds of marks.
11500 If the prefix argument is zero, mark thread as expired.
11501 If the prefix argument is negative, tick articles instead."
11502   (interactive "P")
11503   (when unmark
11504     (setq unmark (prefix-numeric-value unmark)))
11505   (let ((articles (gnus-summary-articles-in-thread))
11506         (hide (or (null unmark) (= unmark 0))))
11507     (save-excursion
11508       ;; Expand the thread.
11509       (gnus-summary-show-thread)
11510       ;; Mark all the articles.
11511       (while articles
11512         (gnus-summary-goto-subject (car articles))
11513         (cond ((null unmark)
11514                (gnus-summary-mark-article-as-read gnus-killed-mark))
11515               ((> unmark 0)
11516                (gnus-summary-mark-article-as-unread gnus-unread-mark))
11517               ((= unmark 0)
11518                (gnus-summary-mark-article nil gnus-expirable-mark))
11519               (t
11520                (gnus-summary-mark-article-as-unread gnus-ticked-mark)))
11521         (setq articles (cdr articles))))
11522     ;; Hide killed subtrees when hide is true.
11523     (and hide
11524          gnus-thread-hide-killed
11525          (gnus-summary-hide-thread))
11526     ;; If hide is t, go to next unread subject.
11527     (when hide
11528       ;; Go to next unread subject.
11529       (gnus-summary-next-subject 1 t)))
11530   (gnus-set-mode-line 'summary))
11531
11532 ;; Summary sorting commands
11533
11534 (defun gnus-summary-sort-by-number (&optional reverse)
11535   "Sort the summary buffer by article number.
11536 Argument REVERSE means reverse order."
11537   (interactive "P")
11538   (gnus-summary-sort 'number reverse))
11539
11540 (defun gnus-summary-sort-by-most-recent-number (&optional reverse)
11541   "Sort the summary buffer by most recent article number.
11542 Argument REVERSE means reverse order."
11543   (interactive "P")
11544   (gnus-summary-sort 'most-recent-number reverse))
11545
11546 (defun gnus-summary-sort-by-random (&optional reverse)
11547   "Randomize the order in the summary buffer.
11548 Argument REVERSE means to randomize in reverse order."
11549   (interactive "P")
11550   (gnus-summary-sort 'random reverse))
11551
11552 (defun gnus-summary-sort-by-author (&optional reverse)
11553   "Sort the summary buffer by author name alphabetically.
11554 If `case-fold-search' is non-nil, case of letters is ignored.
11555 Argument REVERSE means reverse order."
11556   (interactive "P")
11557   (gnus-summary-sort 'author reverse))
11558
11559 (defun gnus-summary-sort-by-recipient (&optional reverse)
11560   "Sort the summary buffer by recipient name alphabetically.
11561 If `case-fold-search' is non-nil, case of letters is ignored.
11562 Argument REVERSE means reverse order."
11563   (interactive "P")
11564   (gnus-summary-sort 'recipient reverse))
11565
11566 (defun gnus-summary-sort-by-subject (&optional reverse)
11567   "Sort the summary buffer by subject alphabetically.  `Re:'s are ignored.
11568 If `case-fold-search' is non-nil, case of letters is ignored.
11569 Argument REVERSE means reverse order."
11570   (interactive "P")
11571   (gnus-summary-sort 'subject reverse))
11572
11573 (defun gnus-summary-sort-by-date (&optional reverse)
11574   "Sort the summary buffer by date.
11575 Argument REVERSE means reverse order."
11576   (interactive "P")
11577   (gnus-summary-sort 'date reverse))
11578
11579 (defun gnus-summary-sort-by-most-recent-date (&optional reverse)
11580   "Sort the summary buffer by most recent date.
11581 Argument REVERSE means reverse order."
11582   (interactive "P")
11583   (gnus-summary-sort 'most-recent-date reverse))
11584
11585 (defun gnus-summary-sort-by-score (&optional reverse)
11586   "Sort the summary buffer by score.
11587 Argument REVERSE means reverse order."
11588   (interactive "P")
11589   (gnus-summary-sort 'score reverse))
11590
11591 (defun gnus-summary-sort-by-lines (&optional reverse)
11592   "Sort the summary buffer by the number of lines.
11593 Argument REVERSE means reverse order."
11594   (interactive "P")
11595   (gnus-summary-sort 'lines reverse))
11596
11597 (defun gnus-summary-sort-by-chars (&optional reverse)
11598   "Sort the summary buffer by article length.
11599 Argument REVERSE means reverse order."
11600   (interactive "P")
11601   (gnus-summary-sort 'chars reverse))
11602
11603 (defun gnus-summary-sort-by-original (&optional reverse)
11604   "Sort the summary buffer using the default sorting method.
11605 Argument REVERSE means reverse order."
11606   (interactive "P")
11607   (let* ((inhibit-read-only t)
11608          (gnus-summary-prepare-hook nil))
11609     ;; We do the sorting by regenerating the threads.
11610     (gnus-summary-prepare)
11611     ;; Hide subthreads if needed.
11612     (gnus-summary-maybe-hide-threads)))
11613
11614 (defun gnus-summary-sort (predicate reverse)
11615   "Sort summary buffer by PREDICATE.  REVERSE means reverse order."
11616   (let* ((thread (intern (format "gnus-thread-sort-by-%s" predicate)))
11617          (article (intern (format "gnus-article-sort-by-%s" predicate)))
11618          (gnus-thread-sort-functions
11619           (if (not reverse)
11620               thread
11621             `(lambda (t1 t2)
11622                (,thread t2 t1))))
11623          (gnus-sort-gathered-threads-function
11624           gnus-thread-sort-functions)
11625          (gnus-article-sort-functions
11626           (if (not reverse)
11627               article
11628             `(lambda (t1 t2)
11629                (,article t2 t1))))
11630          (inhibit-read-only t)
11631          (gnus-summary-prepare-hook nil))
11632     ;; We do the sorting by regenerating the threads.
11633     (gnus-summary-prepare)
11634     ;; Hide subthreads if needed.
11635     (gnus-summary-maybe-hide-threads)))
11636
11637 ;; Summary saving commands.
11638
11639 (defun gnus-summary-save-article (&optional n not-saved)
11640   "Save the current article using the default saver function.
11641 If N is a positive number, save the N next articles.
11642 If N is a negative number, save the N previous articles.
11643 If N is nil and any articles have been marked with the process mark,
11644 save those articles instead.
11645 The variable `gnus-default-article-saver' specifies the saver function.
11646
11647 If the optional second argument NOT-SAVED is non-nil, articles saved
11648 will not be marked as saved."
11649   (interactive "P")
11650   (require 'gnus-art)
11651   (let* ((articles (gnus-summary-work-articles n))
11652          (save-buffer (save-excursion
11653                         (nnheader-set-temp-buffer " *Gnus Save*")))
11654          (num (length articles))
11655          ;; Whether to save decoded articles or raw articles.
11656          (decode (when gnus-article-save-coding-system
11657                    (get gnus-default-article-saver :decode)))
11658          ;; When saving many articles in a single file, use the other
11659          ;; function to save articles other than the first one.
11660          (saver2 (get gnus-default-article-saver :function))
11661          (gnus-prompt-before-saving (if saver2
11662                                         t
11663                                       gnus-prompt-before-saving))
11664          (gnus-default-article-saver gnus-default-article-saver)
11665          header file)
11666     (dolist (article articles)
11667       (setq header (gnus-summary-article-header article))
11668       (if (not (vectorp header))
11669           ;; This is a pseudo-article.
11670           (if (assq 'name header)
11671               (gnus-copy-file (cdr (assq 'name header)))
11672             (gnus-message 1 "Article %d is unsaveable" article))
11673         ;; This is a real article.
11674         (save-window-excursion
11675           (gnus-summary-select-article decode decode nil article)
11676           (gnus-summary-goto-subject article))
11677         (with-current-buffer save-buffer
11678           (erase-buffer)
11679           (insert-buffer-substring (if decode
11680                                        gnus-article-buffer
11681                                      gnus-original-article-buffer)))
11682         (setq file (gnus-article-save save-buffer file num))
11683         (gnus-summary-remove-process-mark article)
11684         (unless not-saved
11685           (gnus-summary-set-saved-mark article)))
11686       (when saver2
11687         (setq gnus-default-article-saver saver2
11688               saver2 nil)))
11689     (gnus-kill-buffer save-buffer)
11690     (gnus-summary-position-point)
11691     (gnus-set-mode-line 'summary)
11692     n))
11693
11694 (defun gnus-summary-pipe-output (&optional n sym)
11695   "Pipe the current article to a subprocess.
11696 If N is a positive number, pipe the N next articles.
11697 If N is a negative number, pipe the N previous articles.
11698 If N is nil and any articles have been marked with the process mark,
11699 pipe those articles instead.
11700 The default command to which articles are piped is specified by the
11701 variable `gnus-summary-pipe-output-default-command'; if it is nil, you
11702 will be prompted for the command.
11703
11704 The properties `:decode' and `:headers' that are put to the function
11705 symbol `gnus-summary-save-in-pipe' control whether this function
11706 decodes articles and what headers to keep (see the doc string for the
11707 `gnus-default-article-saver' variable).  If SYM (the symbolic prefix)
11708 is neither omitted nor the symbol `r', force including all headers
11709 regardless of the `:headers' property.  If it is the symbol `r',
11710 articles that are not decoded and include all headers will be piped
11711 no matter what the properties `:decode' and `:headers' are."
11712   (interactive (gnus-interactive "P\ny"))
11713   (require 'gnus-art)
11714   (let* ((articles (gnus-summary-work-articles n))
11715          (result-buffer "*Shell Command Output*")
11716          (all-headers (not (memq sym '(nil r))))
11717          (gnus-save-all-headers (or all-headers gnus-save-all-headers))
11718          (raw (eq sym 'r))
11719          (headers (get 'gnus-summary-save-in-pipe :headers))
11720          command result)
11721     (unless (numberp (car articles))
11722       (error "No article to pipe"))
11723     (setq command (gnus-read-shell-command
11724                    (concat "Shell command on "
11725                            (if (cdr articles)
11726                                (format "these %d articles" (length articles))
11727                              "this article")
11728                            ": ")
11729                    gnus-summary-pipe-output-default-command))
11730     (when (string-equal command "")
11731       (error "A command is required"))
11732     (when all-headers
11733       (put 'gnus-summary-save-in-pipe :headers nil))
11734     (unwind-protect
11735         (while articles
11736           (gnus-summary-goto-subject (pop articles))
11737           (save-window-excursion (gnus-summary-save-in-pipe command raw))
11738           (when (and (get-buffer result-buffer)
11739                      (not (zerop (buffer-size (get-buffer result-buffer)))))
11740             (setq result (concat result (with-current-buffer result-buffer
11741                                           (buffer-string))))))
11742       (put 'gnus-summary-save-in-pipe :headers headers))
11743     (unless (zerop (length result))
11744       (if (with-current-buffer (get-buffer-create result-buffer)
11745             (erase-buffer)
11746             (insert result)
11747             (prog1
11748                 (and (= (count-lines (point-min) (point)) 1)
11749                      (progn
11750                        (end-of-line 0)
11751                        (<= (current-column)
11752                            (window-width (minibuffer-window)))))
11753               (goto-char (point-min))))
11754           (message "%s" (substring result 0 -1))
11755         (message nil)
11756         (gnus-configure-windows 'pipe)))))
11757
11758 (defun gnus-summary-save-article-mail (&optional arg)
11759   "Append the current article to a Unix mail box 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-mail))
11767     (gnus-summary-save-article arg)))
11768
11769 (defun gnus-summary-save-article-rmail (&optional arg)
11770   "Append the current article to an rmail 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-rmail))
11778     (gnus-summary-save-article arg)))
11779
11780 (defun gnus-summary-save-article-file (&optional arg)
11781   "Append the current article to a 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-save-in-file))
11789     (gnus-summary-save-article arg)))
11790
11791 (defun gnus-summary-write-article-file (&optional arg)
11792   "Write the current article to a file, deleting the previous 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-write-to-file))
11800     (gnus-summary-save-article arg)))
11801
11802 (defun gnus-summary-save-article-body-file (&optional arg)
11803   "Append the current article body to a 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-save-body-in-file))
11811     (gnus-summary-save-article arg)))
11812
11813 (defun gnus-summary-write-article-body-file (&optional arg)
11814   "Write the current article body to a file, deleting the previous file.
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-write-body-to-file))
11822     (gnus-summary-save-article arg)))
11823
11824 (defun gnus-summary-muttprint (&optional arg)
11825   "Print the current article using Muttprint.
11826 If N is a positive number, save the N next articles.
11827 If N is a negative number, save the N previous articles.
11828 If N is nil and any articles have been marked with the process mark,
11829 save those articles instead."
11830   (interactive "P")
11831   (require 'gnus-art)
11832   (let ((gnus-default-article-saver 'gnus-summary-pipe-to-muttprint))
11833     (gnus-summary-save-article arg t)))
11834
11835 (defun gnus-summary-pipe-message (program)
11836   "Pipe the current article through PROGRAM."
11837   (interactive "sProgram: ")
11838   (gnus-summary-select-article)
11839   (let ((mail-header-separator ""))
11840     (gnus-eval-in-buffer-window gnus-article-buffer
11841       (save-restriction
11842         (widen)
11843         (let ((start (window-start))
11844               (inhibit-read-only t))
11845           (message-pipe-buffer-body program)
11846           (set-window-start (get-buffer-window (current-buffer)) start))))))
11847
11848 (defun gnus-get-split-value (methods)
11849   "Return a value based on the split METHODS."
11850   (let (split-name method result match)
11851     (when methods
11852       (with-current-buffer gnus-original-article-buffer
11853         (save-restriction
11854           (nnheader-narrow-to-headers)
11855           (while (and methods (not split-name))
11856             (goto-char (point-min))
11857             (setq method (pop methods))
11858             (setq match (car method))
11859             (when (cond
11860                    ((stringp match)
11861                     ;; Regular expression.
11862                     (ignore-errors
11863                       (re-search-forward match nil t)))
11864                    ((functionp match)
11865                     ;; Function.
11866                     (save-restriction
11867                       (widen)
11868                       (setq result (funcall match gnus-newsgroup-name))))
11869                    ((consp match)
11870                     ;; Form.
11871                     (save-restriction
11872                       (widen)
11873                       (setq result (eval match)))))
11874               (setq split-name (cdr method))
11875               (cond ((stringp result)
11876                      (push (expand-file-name
11877                             result gnus-article-save-directory)
11878                            split-name))
11879                     ((consp result)
11880                      (setq split-name (append result split-name)))))))))
11881     (nreverse split-name)))
11882
11883 (defun gnus-valid-move-group-p (group)
11884   (and (boundp group)
11885        (symbol-name group)
11886        (symbol-value group)
11887        (gnus-get-function (gnus-find-method-for-group
11888                            (symbol-name group)) 'request-accept-article t)))
11889
11890 (defun gnus-read-move-group-name (prompt default articles prefix)
11891   "Read a group name."
11892   (let* ((split-name (gnus-get-split-value gnus-move-split-methods))
11893          (minibuffer-confirm-incomplete nil) ; XEmacs
11894          (prom
11895           (format "%s %s to"
11896                   prompt
11897                   (if (> (length articles) 1)
11898                       (format "these %d articles" (length articles))
11899                     "this article")))
11900          (to-newsgroup
11901           (let (active group)
11902             (when (or (null split-name) (= 1 (length split-name)))
11903               (setq active (gnus-make-hashtable (length gnus-active-hashtb)))
11904               (mapatoms (lambda (symbol)
11905                           (setq group (symbol-name symbol))
11906                           (when (string-match "[^\000-\177]" group)
11907                             (setq group (gnus-group-decoded-name group)))
11908                           (set (intern group active) group))
11909                         gnus-active-hashtb))
11910             (cond
11911              ((null split-name)
11912               (gnus-completing-read-with-default
11913                default prom active 'gnus-valid-move-group-p nil prefix
11914                'gnus-group-history))
11915              ((= 1 (length split-name))
11916               (gnus-completing-read-with-default
11917                (car split-name) prom active 'gnus-valid-move-group-p nil nil
11918                'gnus-group-history))
11919              (t
11920               (gnus-completing-read-with-default
11921                nil prom (mapcar 'list (nreverse split-name)) nil nil nil
11922                'gnus-group-history)))))
11923          (to-method (gnus-server-to-method (gnus-group-method to-newsgroup)))
11924          encoded)
11925     (when to-newsgroup
11926       (if (or (string= to-newsgroup "")
11927               (string= to-newsgroup prefix))
11928           (setq to-newsgroup default))
11929       (unless to-newsgroup
11930         (error "No group name entered"))
11931       (setq encoded (mm-encode-coding-string
11932                      to-newsgroup
11933                      (gnus-group-name-charset to-method to-newsgroup)))
11934       (or (gnus-active encoded)
11935           (gnus-activate-group encoded nil nil to-method)
11936           (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
11937                                      to-newsgroup))
11938               (or (and (gnus-request-create-group encoded to-method)
11939                        (gnus-activate-group encoded nil nil to-method)
11940                        (gnus-subscribe-group encoded))
11941                   (error "Couldn't create group %s" to-newsgroup)))
11942           (error "No such group: %s" to-newsgroup))
11943       encoded)))
11944
11945 (defvar gnus-summary-save-parts-counter)
11946 (declare-function mm-uu-dissect "mm-uu" (&optional noheader mime-type))
11947
11948 (defun gnus-summary-save-parts (type dir n &optional reverse)
11949   "Save parts matching TYPE to DIR.
11950 If REVERSE, save parts that do not match TYPE."
11951   (interactive
11952    (list (read-string "Save parts of type: "
11953                       (or (car gnus-summary-save-parts-type-history)
11954                           gnus-summary-save-parts-default-mime)
11955                       'gnus-summary-save-parts-type-history)
11956          (setq gnus-summary-save-parts-last-directory
11957                (read-file-name "Save to directory: "
11958                                gnus-summary-save-parts-last-directory
11959                                nil t))
11960          current-prefix-arg))
11961   (gnus-summary-iterate n
11962     (let ((gnus-display-mime-function nil)
11963           gnus-article-prepare-hook
11964           gnus-article-decode-hook
11965           gnus-display-mime-function
11966           gnus-break-pages
11967           (gnus-inhibit-treatment t))
11968       (gnus-summary-select-article))
11969     (with-current-buffer gnus-article-buffer
11970       (let ((handles (or gnus-article-mime-handles
11971                          (mm-dissect-buffer nil gnus-article-loose-mime)
11972                          (and gnus-article-emulate-mime
11973                               (mm-uu-dissect))))
11974             (gnus-summary-save-parts-counter 1))
11975         (when handles
11976           (gnus-summary-save-parts-1 type dir handles reverse)
11977           (unless gnus-article-mime-handles ;; Don't destroy this case.
11978             (mm-destroy-parts handles)))))))
11979
11980 (defun gnus-summary-save-parts-1 (type dir handle reverse)
11981   (if (stringp (car handle))
11982       (mapcar (lambda (h) (gnus-summary-save-parts-1 type dir h reverse))
11983               (cdr handle))
11984     (when (if reverse
11985               (not (string-match type (mm-handle-media-type handle)))
11986             (string-match type (mm-handle-media-type handle)))
11987       (let ((file (expand-file-name
11988                    (gnus-map-function
11989                     mm-file-name-rewrite-functions
11990                     (file-name-nondirectory
11991                      (or
11992                       (mail-content-type-get
11993                        (mm-handle-disposition handle) 'filename)
11994                       (mail-content-type-get
11995                        (mm-handle-type handle) 'name)
11996                       (format "%s.%d.%d" gnus-newsgroup-name
11997                               (cdr gnus-article-current)
11998                               gnus-summary-save-parts-counter))))
11999                    dir)))
12000         (incf gnus-summary-save-parts-counter)
12001         (unless (file-exists-p file)
12002           (mm-save-part-to-file handle file))))))
12003
12004 ;; Summary extract commands
12005
12006 (defun gnus-summary-insert-pseudos (pslist &optional not-view)
12007   (let ((inhibit-read-only t)
12008         (article (gnus-summary-article-number))
12009         after-article b e)
12010     (unless (gnus-summary-goto-subject article)
12011       (error "No such article: %d" article))
12012     (gnus-summary-position-point)
12013     ;; If all commands are to be bunched up on one line, we collect
12014     ;; them here.
12015     (unless gnus-view-pseudos-separately
12016       (let ((ps (setq pslist (sort pslist 'gnus-pseudos<)))
12017             files action)
12018         (while ps
12019           (setq action (cdr (assq 'action (car ps))))
12020           (setq files (list (cdr (assq 'name (car ps)))))
12021           (while (and ps (cdr ps)
12022                       (string= (or action "1")
12023                                (or (cdr (assq 'action (cadr ps))) "2")))
12024             (push (cdr (assq 'name (cadr ps))) files)
12025             (setcdr ps (cddr ps)))
12026           (when files
12027             (when (not (string-match "%s" action))
12028               (push " " files))
12029             (push " " files)
12030             (when (assq 'execute (car ps))
12031               (setcdr (assq 'execute (car ps))
12032                       (funcall (if (string-match "%s" action)
12033                                    'format 'concat)
12034                                action
12035                                (mapconcat
12036                                 (lambda (f)
12037                                   (if (equal f " ")
12038                                       f
12039                                     (shell-quote-argument f)))
12040                                 files " ")))))
12041           (setq ps (cdr ps)))))
12042     (if (and gnus-view-pseudos (not not-view))
12043         (while pslist
12044           (when (assq 'execute (car pslist))
12045             (gnus-execute-command (cdr (assq 'execute (car pslist)))
12046                                   (eq gnus-view-pseudos 'not-confirm)))
12047           (setq pslist (cdr pslist)))
12048       (save-excursion
12049         (while pslist
12050           (setq after-article (or (cdr (assq 'article (car pslist)))
12051                                   (gnus-summary-article-number)))
12052           (gnus-summary-goto-subject after-article)
12053           (forward-line 1)
12054           (setq b (point))
12055           (insert "    " (file-name-nondirectory
12056                           (cdr (assq 'name (car pslist))))
12057                   ": " (or (cdr (assq 'execute (car pslist))) "") "\n")
12058           (setq e (point))
12059           (forward-line -1)             ; back to `b'
12060           (gnus-add-text-properties
12061            b (1- e) (list 'gnus-number gnus-reffed-article-number
12062                           gnus-mouse-face-prop gnus-mouse-face))
12063           (gnus-data-enter
12064            after-article gnus-reffed-article-number
12065            gnus-unread-mark b (car pslist) 0 (- e b))
12066           (setq gnus-newsgroup-unreads
12067                 (gnus-add-to-sorted-list gnus-newsgroup-unreads
12068                                          gnus-reffed-article-number))
12069           (setq gnus-reffed-article-number (1- gnus-reffed-article-number))
12070           (setq pslist (cdr pslist)))))))
12071
12072 (defun gnus-pseudos< (p1 p2)
12073   (let ((c1 (cdr (assq 'action p1)))
12074         (c2 (cdr (assq 'action p2))))
12075     (and c1 c2 (string< c1 c2))))
12076
12077 (defun gnus-request-pseudo-article (props)
12078   (cond ((assq 'execute props)
12079          (gnus-execute-command (cdr (assq 'execute props)))))
12080   (let ((gnus-current-article (gnus-summary-article-number)))
12081     (gnus-run-hooks 'gnus-mark-article-hook)))
12082
12083 (defun gnus-execute-command (command &optional automatic)
12084   (save-excursion
12085     (gnus-article-setup-buffer)
12086     (set-buffer gnus-article-buffer)
12087     (setq buffer-read-only nil)
12088     (let ((command (if automatic command
12089                      (read-string "Command: " (cons command 0)))))
12090       (erase-buffer)
12091       (insert "$ " command "\n\n")
12092       (if gnus-view-pseudo-asynchronously
12093           (start-process "gnus-execute" (current-buffer) shell-file-name
12094                          shell-command-switch command)
12095         (call-process shell-file-name nil t nil
12096                       shell-command-switch command)))))
12097
12098 ;; Summary kill commands.
12099
12100 (defun gnus-summary-edit-global-kill (article)
12101   "Edit the \"global\" kill file."
12102   (interactive (list (gnus-summary-article-number)))
12103   (gnus-group-edit-global-kill article))
12104
12105 (defun gnus-summary-edit-local-kill ()
12106   "Edit a local kill file applied to the current newsgroup."
12107   (interactive)
12108   (setq gnus-current-headers (gnus-summary-article-header))
12109   (gnus-group-edit-local-kill
12110    (gnus-summary-article-number) gnus-newsgroup-name))
12111
12112 ;;; Header reading.
12113
12114 (defun gnus-read-header (id &optional header)
12115   "Read the headers of article ID and enter them into the Gnus system."
12116   (let ((group gnus-newsgroup-name)
12117         (gnus-override-method
12118          (or
12119           gnus-override-method
12120           (and (gnus-news-group-p gnus-newsgroup-name)
12121                (car (gnus-refer-article-methods)))))
12122         where)
12123     ;; First we check to see whether the header in question is already
12124     ;; fetched.
12125     (if (stringp id)
12126         ;; This is a Message-ID.
12127         (setq header (or header (gnus-id-to-header id)))
12128       ;; This is an article number.
12129       (setq header (or header (gnus-summary-article-header id))))
12130     (if (and header
12131              (not (gnus-summary-article-sparse-p (mail-header-number header))))
12132         ;; We have found the header.
12133         header
12134       ;; We have to really fetch the header to this article.
12135       (with-current-buffer nntp-server-buffer
12136         (when (setq where (gnus-request-head id group))
12137           (nnheader-fold-continuation-lines)
12138           (goto-char (point-max))
12139           (insert ".\n")
12140           (goto-char (point-min))
12141           (insert "211 ")
12142           (princ (cond
12143                   ((numberp id) id)
12144                   ((cdr where) (cdr where))
12145                   (header (mail-header-number header))
12146                   (t gnus-reffed-article-number))
12147                  (current-buffer))
12148           (insert " Article retrieved.\n"))
12149         (if (or (not where)
12150                 (not (setq header (car (gnus-get-newsgroup-headers nil t)))))
12151             ()                          ; Malformed head.
12152           (unless (gnus-summary-article-sparse-p (mail-header-number header))
12153             (when (and (stringp id)
12154                        (or
12155                         (not (string= (gnus-group-real-name group)
12156                                       (car where)))
12157                         (not (gnus-server-equal gnus-override-method
12158                                                 (gnus-group-method group)))))
12159               ;; If we fetched by Message-ID and the article came from
12160               ;; a different group (or server), we fudge some bogus
12161               ;; article numbers for this article.
12162               (mail-header-set-number header gnus-reffed-article-number))
12163             (with-current-buffer gnus-summary-buffer
12164               (decf gnus-reffed-article-number)
12165               (gnus-remove-header (mail-header-number header))
12166               (push header gnus-newsgroup-headers)
12167               (setq gnus-current-headers header)
12168               (push (mail-header-number header) gnus-newsgroup-limit)))
12169           header)))))
12170
12171 (defun gnus-remove-header (number)
12172   "Remove header NUMBER from `gnus-newsgroup-headers'."
12173   (if (and gnus-newsgroup-headers
12174            (= number (mail-header-number (car gnus-newsgroup-headers))))
12175       (pop gnus-newsgroup-headers)
12176     (let ((headers gnus-newsgroup-headers))
12177       (while (and (cdr headers)
12178                   (not (= number (mail-header-number (cadr headers)))))
12179         (pop headers))
12180       (when (cdr headers)
12181         (setcdr headers (cddr headers))))))
12182
12183 ;;;
12184 ;;; summary highlights
12185 ;;;
12186
12187 (defun gnus-highlight-selected-summary ()
12188   "Highlight selected article in summary buffer."
12189   ;; Added by Per Abrahamsen <amanda@iesd.auc.dk>.
12190   (when gnus-summary-selected-face
12191     (save-excursion
12192       (let* ((beg (point-at-bol))
12193              (end (point-at-eol))
12194              ;; Fix by Mike Dugan <dugan@bucrf16.bu.edu>.
12195              (from (if (get-text-property beg gnus-mouse-face-prop)
12196                        beg
12197                      (or (next-single-property-change
12198                           beg gnus-mouse-face-prop nil end)
12199                          beg)))
12200              (to
12201               (if (= from end)
12202                   (- from 2)
12203                 (or (next-single-property-change
12204                      from gnus-mouse-face-prop nil end)
12205                     end))))
12206         ;; If no mouse-face prop on line we will have to = from = end,
12207         ;; so we highlight the entire line instead.
12208         (when (= (+ to 2) from)
12209           (setq from beg)
12210           (setq to end))
12211         (if gnus-newsgroup-selected-overlay
12212             ;; Move old overlay.
12213             (gnus-move-overlay
12214              gnus-newsgroup-selected-overlay from to (current-buffer))
12215           ;; Create new overlay.
12216           (gnus-overlay-put
12217            (setq gnus-newsgroup-selected-overlay (gnus-make-overlay from to))
12218            'face gnus-summary-selected-face))))))
12219
12220 (defvar gnus-summary-highlight-line-cached nil)
12221 (defvar gnus-summary-highlight-line-trigger nil)
12222
12223 (defun gnus-summary-highlight-line-0 ()
12224   (if (and (eq gnus-summary-highlight-line-trigger
12225                gnus-summary-highlight)
12226            gnus-summary-highlight-line-cached)
12227       gnus-summary-highlight-line-cached
12228     (setq gnus-summary-highlight-line-trigger gnus-summary-highlight
12229           gnus-summary-highlight-line-cached
12230           (let* ((cond (list 'cond))
12231                  (c cond)
12232                  (list gnus-summary-highlight))
12233             (while list
12234               (setcdr c (cons (list (caar list) (list 'quote (cdar list)))
12235                               nil))
12236               (setq c (cdr c)
12237                     list (cdr list)))
12238             (gnus-byte-compile (list 'lambda nil cond))))))
12239
12240 (defun gnus-summary-highlight-line ()
12241   "Highlight current line according to `gnus-summary-highlight'."
12242   (let* ((beg (point-at-bol))
12243          (article (or (gnus-summary-article-number) gnus-current-article))
12244          (score (or (cdr (assq article
12245                                gnus-newsgroup-scored))
12246                     gnus-summary-default-score 0))
12247          (mark (or (gnus-summary-article-mark) gnus-unread-mark))
12248          (inhibit-read-only t)
12249          (default gnus-summary-default-score)
12250          (default-high gnus-summary-default-high-score)
12251          (default-low gnus-summary-default-low-score)
12252          (uncached (and gnus-summary-use-undownloaded-faces
12253                         (memq article gnus-newsgroup-undownloaded)
12254                         (not (memq article gnus-newsgroup-cached)))))
12255     (let ((face (funcall (gnus-summary-highlight-line-0))))
12256       (unless (eq face (get-text-property beg 'face))
12257         (gnus-put-text-property-excluding-characters-with-faces
12258          beg (point-at-eol) 'face
12259          (setq face (if (boundp face) (symbol-value face) face)))
12260         (when gnus-summary-highlight-line-function
12261           (funcall gnus-summary-highlight-line-function article face))))))
12262
12263 (defun gnus-update-read-articles (group unread &optional compute)
12264   "Update the list of read articles in GROUP.
12265 UNREAD is a sorted list."
12266   (let ((active (or gnus-newsgroup-active (gnus-active group)))
12267         (info (gnus-get-info group))
12268         (prev 1)
12269         read)
12270     (if (or (not info) (not active))
12271         ;; There is no info on this group if it was, in fact,
12272         ;; killed.  Gnus stores no information on killed groups, so
12273         ;; there's nothing to be done.
12274         ;; One could store the information somewhere temporarily,
12275         ;; perhaps...  Hmmm...
12276         ()
12277       ;; Remove any negative articles numbers.
12278       (while (and unread (< (car unread) 0))
12279         (setq unread (cdr unread)))
12280       ;; Remove any expired article numbers
12281       (while (and unread (< (car unread) (car active)))
12282         (setq unread (cdr unread)))
12283       ;; Compute the ranges of read articles by looking at the list of
12284       ;; unread articles.
12285       (while unread
12286         (when (/= (car unread) prev)
12287           (push (if (= prev (1- (car unread))) prev
12288                   (cons prev (1- (car unread))))
12289                 read))
12290         (setq prev (1+ (car unread)))
12291         (setq unread (cdr unread)))
12292       (when (<= prev (cdr active))
12293         (push (cons prev (cdr active)) read))
12294       (setq read (if (> (length read) 1) (nreverse read) read))
12295       (if compute
12296           read
12297         (save-excursion
12298           (let (setmarkundo)
12299             ;; Propagate the read marks to the backend.
12300             (when (and gnus-propagate-marks
12301                        (gnus-check-backend-function 'request-set-mark group))
12302               (let ((del (gnus-remove-from-range (gnus-info-read info) read))
12303                     (add (gnus-remove-from-range read (gnus-info-read info))))
12304                 (when (or add del)
12305                   (unless (gnus-check-group group)
12306                     (error "Can't open server for %s" group))
12307                   (gnus-request-set-mark
12308                    group (delq nil (list (if add (list add 'add '(read)))
12309                                          (if del (list del 'del '(read))))))
12310                   (setq setmarkundo
12311                         `(gnus-request-set-mark
12312                           ,group
12313                           ',(delq nil (list
12314                                        (if del (list del 'add '(read)))
12315                                        (if add (list add 'del '(read))))))))))
12316             (set-buffer gnus-group-buffer)
12317             (gnus-undo-register
12318               `(progn
12319                  (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
12320                  (gnus-info-set-read ',info ',(gnus-info-read info))
12321                  (gnus-get-unread-articles-in-group ',info
12322                                                     (gnus-active ,group))
12323                  (gnus-group-update-group ,group t)
12324                  ,setmarkundo))))
12325         ;; Enter this list into the group info.
12326         (gnus-info-set-read info read)
12327         ;; Set the number of unread articles in gnus-newsrc-hashtb.
12328         (gnus-get-unread-articles-in-group info (gnus-active group))
12329         t))))
12330
12331 (defun gnus-offer-save-summaries ()
12332   "Offer to save all active summary buffers."
12333   (let (buffers)
12334     ;; Go through all buffers and find all summaries.
12335     (dolist (buffer (buffer-list))
12336       (when (and (setq buffer (buffer-name buffer))
12337                  (string-match "Summary" buffer)
12338                  (with-current-buffer buffer
12339                    ;; We check that this is, indeed, a summary buffer.
12340                    (and (eq major-mode 'gnus-summary-mode)
12341                         ;; Also make sure this isn't bogus.
12342                         gnus-newsgroup-prepared
12343                         ;; Also make sure that this isn't a
12344                         ;; dead summary buffer.
12345                         (not gnus-dead-summary-mode))))
12346         (push buffer buffers)))
12347     ;; Go through all these summary buffers and offer to save them.
12348     (when buffers
12349       (save-excursion
12350         (map-y-or-n-p
12351          "Update summary buffer %s? "
12352          (lambda (buf)
12353            (switch-to-buffer buf)
12354            (gnus-summary-exit))
12355          buffers)))))
12356
12357 (defun gnus-summary-setup-default-charset ()
12358   "Setup newsgroup default charset."
12359   (if (member gnus-newsgroup-name '("nndraft:delayed" "nndraft:drafts"))
12360       (setq gnus-newsgroup-charset nil)
12361     (let* ((ignored-charsets
12362             (or gnus-newsgroup-ephemeral-ignored-charsets
12363                 (append
12364                  (and gnus-newsgroup-name
12365                       (gnus-parameter-ignored-charsets gnus-newsgroup-name))
12366                  gnus-newsgroup-ignored-charsets))))
12367       (setq gnus-newsgroup-charset
12368             (or gnus-newsgroup-ephemeral-charset
12369                 (and gnus-newsgroup-name
12370                      (gnus-parameter-charset gnus-newsgroup-name))
12371                 gnus-default-charset))
12372       (set (make-local-variable 'gnus-newsgroup-ignored-charsets)
12373            ignored-charsets))))
12374
12375 ;;;
12376 ;;; Mime Commands
12377 ;;;
12378
12379 (defun gnus-summary-display-buttonized (&optional show-all-parts)
12380   "Display the current article buffer fully MIME-buttonized.
12381 If SHOW-ALL-PARTS (the prefix) is non-nil, all multipart/* parts are
12382 treated as multipart/mixed."
12383   (interactive "P")
12384   (require 'gnus-art)
12385   (let ((gnus-unbuttonized-mime-types nil)
12386         (gnus-mime-display-multipart-as-mixed show-all-parts))
12387     (gnus-summary-show-article)))
12388
12389 (defun gnus-summary-repair-multipart (article)
12390   "Add a Content-Type header to a multipart article without one."
12391   (interactive (list (gnus-summary-article-number)))
12392   (gnus-with-article article
12393     (message-narrow-to-head)
12394     (message-remove-header "Mime-Version")
12395     (goto-char (point-max))
12396     (insert "Mime-Version: 1.0\n")
12397     (widen)
12398     (when (search-forward "\n--" nil t)
12399       (let ((separator (buffer-substring (point) (point-at-eol))))
12400         (message-narrow-to-head)
12401         (message-remove-header "Content-Type")
12402         (goto-char (point-max))
12403         (insert (format "Content-Type: multipart/mixed; boundary=\"%s\"\n"
12404                         separator))
12405         (widen))))
12406   (let (gnus-mark-article-hook)
12407     (gnus-summary-select-article t t nil article)))
12408
12409 (defun gnus-summary-toggle-display-buttonized ()
12410   "Toggle the buttonizing of the article buffer."
12411   (interactive)
12412   (require 'gnus-art)
12413   (if (setq gnus-inhibit-mime-unbuttonizing
12414             (not gnus-inhibit-mime-unbuttonizing))
12415       (let ((gnus-unbuttonized-mime-types nil))
12416         (gnus-summary-show-article))
12417     (gnus-summary-show-article)))
12418
12419 ;;;
12420 ;;; Generic summary marking commands
12421 ;;;
12422
12423 (defvar gnus-summary-marking-alist
12424   '((read gnus-del-mark "d")
12425     (unread gnus-unread-mark "u")
12426     (ticked gnus-ticked-mark "!")
12427     (dormant gnus-dormant-mark "?")
12428     (expirable gnus-expirable-mark "e"))
12429   "An alist of names/marks/keystrokes.")
12430
12431 (defvar gnus-summary-generic-mark-map (make-sparse-keymap))
12432 (defvar gnus-summary-mark-map)
12433
12434 (defun gnus-summary-make-all-marking-commands ()
12435   (define-key gnus-summary-mark-map "M" gnus-summary-generic-mark-map)
12436   (dolist (elem gnus-summary-marking-alist)
12437     (apply 'gnus-summary-make-marking-command elem)))
12438
12439 (defun gnus-summary-make-marking-command (name mark keystroke)
12440   (let ((map (make-sparse-keymap)))
12441     (define-key gnus-summary-generic-mark-map keystroke map)
12442     (dolist (lway `((next "next" next nil "n")
12443                     (next-unread "next unread" next t "N")
12444                     (prev "previous" prev nil "p")
12445                     (prev-unread "previous unread" prev t "P")
12446                     (nomove "" nil nil ,keystroke)))
12447       (let ((func (gnus-summary-make-marking-command-1
12448                    mark (car lway) lway name)))
12449         (setq func (eval func))
12450         (define-key map (nth 4 lway) func)))))
12451
12452 (defun gnus-summary-make-marking-command-1 (mark way lway name)
12453   `(defun ,(intern
12454             (format "gnus-summary-put-mark-as-%s%s"
12455                     name (if (eq way 'nomove)
12456                              ""
12457                            (concat "-" (symbol-name way)))))
12458      (n)
12459      ,(format
12460        "Mark the current article as %s%s.
12461 If N, the prefix, then repeat N times.
12462 If N is negative, move in reverse order.
12463 The difference between N and the actual number of articles marked is
12464 returned."
12465        name (cadr lway))
12466      (interactive "p")
12467      (gnus-summary-generic-mark n ,mark ',(nth 2 lway) ,(nth 3 lway))))
12468
12469 (defun gnus-summary-generic-mark (n mark move unread)
12470   "Mark N articles with MARK."
12471   (unless (eq major-mode 'gnus-summary-mode)
12472     (error "This command can only be used in the summary buffer"))
12473   (gnus-summary-show-thread)
12474   (let ((nummove
12475          (cond
12476           ((eq move 'next) 1)
12477           ((eq move 'prev) -1)
12478           (t 0))))
12479     (if (zerop nummove)
12480         (setq n 1)
12481       (when (< n 0)
12482         (setq n (abs n)
12483               nummove (* -1 nummove))))
12484     (while (and (> n 0)
12485                 (gnus-summary-mark-article nil mark)
12486                 (zerop (gnus-summary-next-subject nummove unread t)))
12487       (setq n (1- n)))
12488     (when (/= 0 n)
12489       (gnus-message 7 "No more %sarticles" (if mark "" "unread ")))
12490     (gnus-summary-recenter)
12491     (gnus-summary-position-point)
12492     (gnus-set-mode-line 'summary)
12493     n))
12494
12495 (defun gnus-summary-insert-articles (articles)
12496   (when (setq articles
12497               (gnus-sorted-difference articles
12498                                       (mapcar (lambda (h)
12499                                                 (mail-header-number h))
12500                                               gnus-newsgroup-headers)))
12501     (setq gnus-newsgroup-headers
12502           (gnus-merge 'list
12503                       gnus-newsgroup-headers
12504                       (gnus-fetch-headers articles)
12505                       'gnus-article-sort-by-number))
12506     ;; Suppress duplicates?
12507     (when gnus-suppress-duplicates
12508       (gnus-dup-suppress-articles))
12509
12510     (if (and gnus-fetch-old-headers
12511              (eq gnus-headers-retrieved-by 'nov))
12512         ;; We might want to build some more threads first.
12513         (if (eq gnus-fetch-old-headers 'invisible)
12514             (gnus-build-all-threads)
12515           (gnus-build-old-threads))
12516       ;; Mark the inserted articles that are unread as unread.
12517       (setq gnus-newsgroup-unreads
12518             (gnus-sorted-nunion
12519              gnus-newsgroup-unreads
12520              (gnus-sorted-nintersection
12521               (gnus-list-of-unread-articles gnus-newsgroup-name)
12522               articles)))
12523       ;; Mark the inserted articles as selected so that the information
12524       ;; of the marks having been changed by a user may be updated when
12525       ;; exiting this group.  See `gnus-summary-update-info'.
12526       (dolist (art articles)
12527         (setq gnus-newsgroup-unselected (delq art gnus-newsgroup-unselected))))
12528     ;; Let the Gnus agent mark articles as read.
12529     (when gnus-agent
12530       (gnus-agent-get-undownloaded-list))
12531     ;; Remove list identifiers from subject
12532     (when gnus-list-identifiers
12533       (gnus-summary-remove-list-identifiers))
12534     ;; First and last article in this newsgroup.
12535     (when gnus-newsgroup-headers
12536       (setq gnus-newsgroup-begin
12537             (mail-header-number (car gnus-newsgroup-headers))
12538             gnus-newsgroup-end
12539             (mail-header-number
12540              (gnus-last-element gnus-newsgroup-headers))))
12541     (when gnus-use-scoring
12542       (gnus-possibly-score-headers))))
12543
12544 (defun gnus-summary-insert-old-articles (&optional all)
12545   "Insert all old articles in this group.
12546 If ALL is non-nil, already read articles become readable.
12547 If ALL is a number, fetch this number of articles."
12548   (interactive "P")
12549   (prog1
12550       (let ((old (sort (mapcar 'car gnus-newsgroup-data) '<))
12551             older len)
12552         (setq older
12553               ;; Some nntp servers lie about their active range.  When
12554               ;; this happens, the active range can be in the millions.
12555               ;; Use a compressed range to avoid creating a huge list.
12556               (gnus-range-difference (list gnus-newsgroup-active) old))
12557         (setq len (gnus-range-length older))
12558         (cond
12559          ((null older) nil)
12560          ((numberp all)
12561           (if (< all len)
12562               (let ((older-range (nreverse older)))
12563                 (setq older nil)
12564
12565                 (while (> all 0)
12566                   (let* ((r (pop older-range))
12567                          (min (if (numberp r) r (car r)))
12568                          (max (if (numberp r) r (cdr r))))
12569                     (while (and (<= min max)
12570                                 (> all 0))
12571                       (push max older)
12572                       (setq all (1- all)
12573                             max (1- max))))))
12574             (setq older (gnus-uncompress-range older))))
12575          (all
12576           (setq older (gnus-uncompress-range older)))
12577          (t
12578           (when (and (numberp gnus-large-newsgroup)
12579                    (> len gnus-large-newsgroup))
12580               (let* ((cursor-in-echo-area nil)
12581                      (initial (gnus-parameter-large-newsgroup-initial
12582                                gnus-newsgroup-name))
12583                      (input
12584                       (read-string
12585                        (format
12586                         "How many articles from %s (%s %d): "
12587                         (gnus-group-decoded-name gnus-newsgroup-name)
12588                         (if initial "max" "default")
12589                         len)
12590                        (if initial
12591                            (cons (number-to-string initial)
12592                                  0)))))
12593                 (unless (string-match "^[ \t]*$" input)
12594                   (setq all (string-to-number input))
12595                   (if (< all len)
12596                       (let ((older-range (nreverse older)))
12597                         (setq older nil)
12598
12599                         (while (> all 0)
12600                           (let* ((r (pop older-range))
12601                                  (min (if (numberp r) r (car r)))
12602                                  (max (if (numberp r) r (cdr r))))
12603                             (while (and (<= min max)
12604                                         (> all 0))
12605                               (push max older)
12606                               (setq all (1- all)
12607                                     max (1- max))))))))))
12608           (setq older (gnus-uncompress-range older))))
12609         (if (not older)
12610             (message "No old news.")
12611           (gnus-summary-insert-articles older)
12612           (gnus-summary-limit (gnus-sorted-nunion old older))))
12613     (gnus-summary-position-point)))
12614
12615 (defun gnus-summary-insert-new-articles ()
12616   "Insert all new articles in this group."
12617   (interactive)
12618   (prog1
12619       (let ((old (sort (mapcar 'car gnus-newsgroup-data) '<))
12620             (old-active gnus-newsgroup-active)
12621             (nnmail-fetched-sources (list t))
12622             i new)
12623         (setq gnus-newsgroup-active
12624               (gnus-activate-group gnus-newsgroup-name 'scan))
12625         (setq i (cdr gnus-newsgroup-active))
12626         (while (> i (cdr old-active))
12627           (push i new)
12628           (decf i))
12629         (if (not new)
12630             (message "No gnus is bad news")
12631           (gnus-summary-insert-articles new)
12632           (setq gnus-newsgroup-unreads
12633                 (gnus-sorted-nunion gnus-newsgroup-unreads new))
12634           (gnus-summary-limit (gnus-sorted-nunion old new))))
12635     (gnus-summary-position-point)))
12636
12637 ;;; Bookmark support for Gnus.
12638 (declare-function bookmark-make-record-default
12639                   "bookmark" (&optional no-file no-context posn))
12640 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
12641 (declare-function bookmark-default-handler "bookmark" (bmk))
12642 (declare-function bookmark-get-bookmark-record "bookmark" (bmk))
12643 (defvar bookmark-yank-point)
12644 (defvar bookmark-current-buffer)
12645
12646 (defun gnus-summary-bookmark-make-record ()
12647   "Make a bookmark entry for a Gnus summary buffer."
12648   (let (pos buf)
12649     (unless (and (derived-mode-p 'gnus-summary-mode) gnus-article-current)
12650       (save-restriction              ; FIXME is it necessary to widen?
12651         (widen) (setq pos (point))) ; Set position in gnus-article buffer.
12652       (setq buf "art") ; We are recording bookmark from article buffer.
12653       (setq bookmark-yank-point (point))
12654       (setq bookmark-current-buffer (current-buffer))
12655       (gnus-article-show-summary))      ; Go back in summary buffer.
12656     ;; We are now recording bookmark from summary buffer.
12657     (unless buf (setq buf "sum"))
12658     (let* ((subject (elt (gnus-summary-article-header) 1))
12659            (grp     (car gnus-article-current))
12660            (art     (cdr gnus-article-current))
12661            (head    (gnus-summary-article-header art))
12662            (id      (mail-header-id head)))
12663       `(,subject
12664         ,@(condition-case nil
12665               (bookmark-make-record-default 'no-file 'no-context pos)
12666             (wrong-number-of-arguments
12667              (bookmark-make-record-default 'point-only)))
12668         (location . ,(format "Gnus-%s %s:%d:%s" buf grp art id))
12669         (group . ,grp) (article . ,art)
12670         (message-id . ,id) (handler . gnus-summary-bookmark-jump)))))
12671
12672 ;;;###autoload
12673 (defun gnus-summary-bookmark-jump (bookmark)
12674   "Handler function for record returned by `gnus-summary-bookmark-make-record'.
12675 BOOKMARK is a bookmark name or a bookmark record."
12676   (let ((group    (bookmark-prop-get bookmark 'group))
12677         (article  (bookmark-prop-get bookmark 'article))
12678         (id       (bookmark-prop-get bookmark 'message-id))
12679         (buf      (car (split-string (bookmark-prop-get bookmark 'location)))))
12680     (gnus-fetch-group group (list article))
12681     (gnus-summary-insert-cached-articles)
12682     (gnus-summary-goto-article id nil 'force)
12683     ;; FIXME we have to wait article buffer is ready (only large buffer)
12684     ;; Is there a better solution to know that?
12685     ;; If we don't wait `bookmark-default-handler' will have no chance
12686     ;; to set position. However there is no error, just wrong pos.
12687     (sit-for 1)
12688     (when (string= buf "Gnus-art")
12689       (other-window 1))
12690     (bookmark-default-handler
12691      `(""
12692        (buffer . ,(current-buffer))
12693        . ,(bookmark-get-bookmark-record bookmark)))))
12694
12695 (gnus-summary-make-all-marking-commands)
12696
12697 (gnus-ems-redefine)
12698
12699 (provide 'gnus-sum)
12700
12701 (run-hooks 'gnus-sum-load-hook)
12702
12703 ;; Local Variables:
12704 ;; coding: iso-8859-1
12705 ;; End:
12706
12707 ;;; gnus-sum.el ends here