1 ;;; gnus-sum.el --- summary mode commands for Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; This file is part of GNU Emacs.
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.
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.
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/>.
28 ;; For Emacs <22.2 and XEmacs.
30 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
34 (when (featurep 'xemacs)
35 (require 'easy-mmode))) ; for `define-minor-mode'
37 (defvar tool-bar-mode)
38 (defvar gnus-tmp-header)
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."
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)
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
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
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
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.
99 The server has to support NOV for any of this to work.
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."
106 :type '(choice (const :tag "off" nil)
111 (sexp :menu-tag "other" t)))
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."
117 :type '(choice number
118 (sexp :menu-tag "other" t)))
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.
127 If non-nil, Gnus will try to gather all loose sub-threads from an
128 original thread into one large thread.
130 If this variable is non-nil, it should be one of `none', `adopt',
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.)"
143 :type '(choice (const :tag "off" nil)
149 (defcustom gnus-summary-make-false-root-always nil
150 "Always make a false dummy root."
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."
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.
171 If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
174 :type '(choice (const :tag "off" nil)
176 (sexp :menu-tag "on" t)))
178 (defcustom gnus-simplify-subject-functions nil
179 "List of functions taking a string argument that simplify subjects.
180 The functions are applied recursively.
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'."
186 :type '(repeat function))
188 (defcustom gnus-simplify-ignored-prefixes nil
189 "*Remove matches for this regexp from subject lines when simplifying fuzzily."
191 :type '(choice (const :tag "off" nil)
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."
200 :type '(choice (const :tag "off" nil)
203 (sexp :menu-tag "all" t)))
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."
213 :type '(radio (function-item gnus-gather-threads-by-subject)
214 (function-item gnus-gather-threads-by-references)
215 (function :tag "other")))
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
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.
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."
235 :group 'gnus-summary-marks
236 :link '(custom-manual "(gnus)Setting Marks")
237 :type '(choice (const :tag "off" nil)
239 (sexp :menu-tag "on" t)))
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")
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
254 :group 'gnus-score-default
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
262 :group 'gnus-score-default
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'
269 :group 'gnus-summary-format
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."
278 :type '(repeat regexp))
280 (defcustom gnus-show-threads t
281 "*If non-nil, display threads in summary mode."
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."
291 :type '(radio (sexp :format "Non-nil\n"
292 :match (lambda (widget value)
293 (not (or (consp value) (functionp value))))
296 (sexp :tag "Predicate specifier")))
298 (defcustom gnus-thread-hide-killed t
299 "*If non-nil, hide killed threads automatically."
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."
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'.
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."
320 :type '(choice (const :tag "off" nil)
324 (defcustom gnus-thread-indent-level 4
325 "*Number that says how much each sub-thread should be indented."
329 (defcustom gnus-auto-extend-newsgroup t
330 "*If non-nil, extend newsgroup forward and backward when requested."
331 :group 'gnus-summary-choose
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'.
340 Which article is selected is controlled by the variable
341 `gnus-auto-select-subject'.
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)))
353 (defcustom gnus-auto-select-subject 'unseen-or-unread
354 "*Says what subject to place under point when entering a group.
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."
365 :group 'gnus-group-select
366 :type '(choice (const best)
370 (const unseen-or-unread)))
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)
386 (const almost-quietly)
387 (const slightly-quietly)
388 (sexp :menu-tag "on" t)))
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."