cgit.sxemacs.org Git - gnus/blob - lisp/gnus-sum.el

   1 ;;; gnus-sum.el --- summary mode commands for Gnus
   2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile (require 'cl))
  30
  31 (require 'gnus)
  32 (require 'gnus-group)
  33 (require 'gnus-spec)
  34 (require 'gnus-range)
  35 (require 'gnus-int)
  36 (require 'gnus-undo)
  37 (require 'gnus-util)
  38 (require 'mm-decode)
  39 (require 'nnoo)
  40
  41 (autoload 'gnus-summary-limit-include-cached "gnus-cache" nil t)
  42 (autoload 'gnus-cache-write-active "gnus-cache")
  43 (autoload 'gnus-mailing-list-insinuate "gnus-ml" nil t)
  44 (autoload 'turn-on-gnus-mailing-list-mode "gnus-ml" nil t)
  45 (autoload 'mm-uu-dissect "mm-uu")
  46 (autoload 'gnus-article-outlook-deuglify-article "deuglify"
  47   "Deuglify broken Outlook (Express) articles and redisplay."
  48   t)
  49
  50 (defcustom gnus-kill-summary-on-exit t
  51   "*If non-nil, kill the summary buffer when you exit from it.
  52 If nil, the summary will become a \"*Dead Summary*\" buffer, and
  53 it will be killed sometime later."
  54   :group 'gnus-summary-exit
  55   :type 'boolean)
  56
  57 (defcustom gnus-fetch-old-headers nil
  58   "*Non-nil means that Gnus will try to build threads by grabbing old headers.
  59 If an unread article in the group refers to an older, already read (or
  60 just marked as read) article, the old article will not normally be
  61 displayed in the Summary buffer.  If this variable is non-nil, Gnus
  62 will attempt to grab the headers to the old articles, and thereby
  63 build complete threads.  If it has the value `some', only enough
  64 headers to connect otherwise loose threads will be displayed.  This
  65 variable can also be a number.  In that case, no more than that number
  66 of old headers will be fetched.  If it has the value `invisible', all
  67 old headers will be fetched, but none will be displayed.
  68
  69 The server has to support NOV for any of this to work."
  70   :group 'gnus-thread
  71   :type '(choice (const :tag "off" nil)
  72                  (const some)
  73                  number
  74                  (sexp :menu-tag "other" t)))
  75
  76 (defcustom gnus-refer-thread-limit 200
  77   "*The number of old headers to fetch when doing \\<gnus-summary-mode-map>\\[gnus-summary-refer-thread].
  78 If t, fetch all the available old headers."
  79   :group 'gnus-thread
  80   :type '(choice number
  81                  (sexp :menu-tag "other" t)))
  82
  83 (defcustom gnus-summary-make-false-root 'adopt
  84   "*nil means that Gnus won't gather loose threads.
  85 If the root of a thread has expired or been read in a previous
  86 session, the information necessary to build a complete thread has been
  87 lost.  Instead of having many small sub-threads from this original thread
  88 scattered all over the summary buffer, Gnus can gather them.
  89
  90 If non-nil, Gnus will try to gather all loose sub-threads from an
  91 original thread into one large thread.
  92
  93 If this variable is non-nil, it should be one of `none', `adopt',
  94 `dummy' or `empty'.
  95
  96 If this variable is `none', Gnus will not make a false root, but just
  97 present the sub-threads after another.
  98 If this variable is `dummy', Gnus will create a dummy root that will
  99 have all the sub-threads as children.
 100 If this variable is `adopt', Gnus will make one of the \"children\"
 101 the parent and mark all the step-children as such.
 102 If this variable is `empty', the \"children\" are printed with empty
 103 subject fields.  (Or rather, they will be printed with a string
 104 given by the `gnus-summary-same-subject' variable.)"
 105   :group 'gnus-thread
 106   :type '(choice (const :tag "off" nil)
 107                  (const none)
 108                  (const dummy)
 109                  (const adopt)
 110                  (const empty)))
 111
 112 (defcustom gnus-summary-gather-exclude-subject "^ *$\\|^(none)$"
 113   "*A regexp to match subjects to be excluded from loose thread gathering.
 114 As loose thread gathering is done on subjects only, that means that
 115 there can be many false gatherings performed.  By rooting out certain
 116 common subjects, gathering might become saner."
 117   :group 'gnus-thread
 118   :type 'regexp)
 119
 120 (defcustom gnus-summary-gather-subject-limit nil
 121   "*Maximum length of subject comparisons when gathering loose threads.
 122 Use nil to compare full subjects.  Setting this variable to a low
 123 number will help gather threads that have been corrupted by
 124 newsreaders chopping off subject lines, but it might also mean that
 125 unrelated articles that have subject that happen to begin with the
 126 same few characters will be incorrectly gathered.
 127
 128 If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
 129 comparing subjects."
 130   :group 'gnus-thread
 131   :type '(choice (const :tag "off" nil)
 132                  (const fuzzy)
 133                  (sexp :menu-tag "on" t)))
 134
 135 (defcustom gnus-simplify-subject-functions nil
 136   "List of functions taking a string argument that simplify subjects.
 137 The functions are applied recursively.
 138
 139 Useful functions to put in this list include:
 140 `gnus-simplify-subject-re', `gnus-simplify-subject-fuzzy',
 141 `gnus-simplify-whitespace', and `gnus-simplify-all-whitespace'."
 142   :group 'gnus-thread
 143   :type '(repeat function))
 144
 145 (defcustom gnus-simplify-ignored-prefixes nil
 146   "*Remove matches for this regexp from subject lines when simplifying fuzzily."
 147   :group 'gnus-thread
 148   :type '(choice (const :tag "off" nil)
 149                  regexp))
 150
 151 (defcustom gnus-build-sparse-threads nil
 152   "*If non-nil, fill in the gaps in threads.
 153 If `some', only fill in the gaps that are needed to tie loose threads
 154 together.  If `more', fill in all leaf nodes that Gnus can find.  If
 155 non-nil and non-`some', fill in all gaps that Gnus manages to guess."
 156   :group 'gnus-thread
 157   :type '(choice (const :tag "off" nil)
 158                  (const some)
 159                  (const more)
 160                  (sexp :menu-tag "all" t)))
 161
 162 (defcustom gnus-summary-thread-gathering-function
 163   'gnus-gather-threads-by-subject
 164   "*Function used for gathering loose threads.
 165 There are two pre-defined functions: `gnus-gather-threads-by-subject',
 166 which only takes Subjects into consideration; and
 167 `gnus-gather-threads-by-references', which compared the References
 168 headers of the articles to find matches."
 169   :group 'gnus-thread
 170   :type '(radio (function-item gnus-gather-threads-by-subject)
 171                 (function-item gnus-gather-threads-by-references)
 172                 (function :tag "other")))
 173
 174 (defcustom gnus-summary-same-subject ""
 175   "*String indicating that the current article has the same subject as the previous.
 176 This variable will only be used if the value of
 177 `gnus-summary-make-false-root' is `empty'."
 178   :group 'gnus-summary-format
 179   :type 'string)
 180
 181 (defcustom gnus-summary-goto-unread t
 182   "*If t, many commands will go to the next unread article.
 183 This applies to marking commands as well as other commands that
 184 \"naturally\" select the next article, like, for instance, `SPC' at
 185 the end of an article.
 186
 187 If nil, the marking commands do NOT go to the next unread article
 188 \(they go to the next article instead).  If `never', commands that
 189 usually go to the next unread article, will go to the next article,
 190 whether it is read or not."
 191   :group 'gnus-summary-marks
 192   :link '(custom-manual "(gnus)Setting Marks")
 193   :type '(choice (const :tag "off" nil)
 194                  (const never)
 195                  (sexp :menu-tag "on" t)))
 196
 197 (defcustom gnus-summary-default-score 0
 198   "*Default article score level.
 199 All scores generated by the score files will be added to this score.
 200 If this variable is nil, scoring will be disabled."
 201   :group 'gnus-score-default
 202   :type '(choice (const :tag "disable")
 203                  integer))
 204
 205 (defcustom gnus-summary-default-high-score 0
 206   "*Default threshold for a high scored article.
 207 An article will be highlighted as high scored if its score is greater
 208 than this score."
 209   :group 'gnus-score-default
 210   :type 'integer)
 211
 212 (defcustom gnus-summary-default-low-score 0
 213   "*Default threshold for a low scored article.
 214 An article will be highlighted as low scored if its score is smaller
 215 than this score."
 216   :group 'gnus-score-default
 217   :type 'integer)
 218
 219 (defcustom gnus-summary-zcore-fuzz 0
 220   "*Fuzziness factor for the zcore in the summary buffer.
 221 Articles with scores closer than this to `gnus-summary-default-score'
 222 will not be marked."
 223   :group 'gnus-summary-format
 224   :type 'integer)
 225
 226 (defcustom gnus-simplify-subject-fuzzy-regexp nil
 227   "*Strings to be removed when doing fuzzy matches.
 228 This can either be a regular expression or list of regular expressions
 229 that will be removed from subject strings if fuzzy subject
 230 simplification is selected."
 231   :group 'gnus-thread
 232   :type '(repeat regexp))
 233
 234 (defcustom gnus-show-threads t
 235   "*If non-nil, display threads in summary mode."
 236   :group 'gnus-thread
 237   :type 'boolean)
 238
 239 (defcustom gnus-thread-hide-subtree nil
 240   "*If non-nil, hide all threads initially.