cgit.sxemacs.org Git - gnus/blob - 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 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 2, or (at your option)
  14 ;; 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; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (eval-when-compile
  31   (require 'cl)
  32   (defvar tool-bar-map))
  33
  34 (require 'gnus)
  35 (require 'gnus-group)
  36 (require 'gnus-spec)
  37 (require 'gnus-range)
  38 (require 'gnus-int)
  39 (require 'gnus-undo)
  40 (require 'gnus-util)
  41 (require 'mm-decode)
  42 (require 'nnoo)
  43
  44 (autoload 'gnus-summary-limit-include-cached "gnus-cache" nil t)
  45 (autoload 'gnus-cache-write-active "gnus-cache")
  46 (autoload 'gnus-mailing-list-insinuate "gnus-ml" nil t)
  47 (autoload 'turn-on-gnus-mailing-list-mode "gnus-ml" nil t)
  48 (autoload 'gnus-pick-line-number "gnus-salt" nil t)
  49 (autoload 'mm-uu-dissect "mm-uu")
  50 (autoload 'gnus-article-outlook-deuglify-article "deuglify"
  51   "Deuglify broken Outlook (Express) articles and redisplay."
  52   t)
  53 (autoload 'gnus-article-outlook-unwrap-lines "deuglify" nil t)
  54 (autoload 'gnus-article-outlook-repair-attribution "deuglify" nil t)
  55 (autoload 'gnus-article-outlook-rearrange-citation "deuglify" nil t)
  56
  57 (defcustom gnus-kill-summary-on-exit t
  58   "*If non-nil, kill the summary buffer when you exit from it.
  59 If nil, the summary will become a \"*Dead Summary*\" buffer, and
  60 it will be killed sometime later."
  61   :group 'gnus-summary-exit
  62   :type 'boolean)
  63
  64 (defcustom gnus-fetch-old-headers nil
  65   "*Non-nil means that Gnus will try to build threads by grabbing old headers.
  66 If an unread article in the group refers to an older, already read (or
  67 just marked as read) article, the old article will not normally be
  68 displayed in the Summary buffer.  If this variable is t, Gnus
  69 will attempt to grab the headers to the old articles, and thereby
  70 build complete threads.  If it has the value `some', only enough
  71 headers to connect otherwise loose threads will be displayed.  This
  72 variable can also be a number.  In that case, no more than that number
  73 of old headers will be fetched.  If it has the value `invisible', all
  74 old headers will be fetched, but none will be displayed.
  75
  76 The server has to support NOV for any of this to work."
  77   :group 'gnus-thread
  78   :type '(choice (const :tag "off" nil)
  79                  (const :tag "on" t)
  80                  (const some)
  81                  (const invisible)
  82                  number
  83                  (sexp :menu-tag "other" t)))
  84
  85 (defcustom gnus-refer-thread-limit 200
  86   "*The number of old headers to fetch when doing \\<gnus-summary-mode-map>\\[gnus-summary-refer-thread].
  87 If t, fetch all the available old headers."
  88   :group 'gnus-thread
  89   :type '(choice number
  90                  (sexp :menu-tag "other" t)))
  91
  92 (defcustom gnus-summary-make-false-root 'adopt
  93   "*nil means that Gnus won't gather loose threads.
  94 If the root of a thread has expired or been read in a previous
  95 session, the information necessary to build a complete thread has been
  96 lost.  Instead of having many small sub-threads from this original thread
  97 scattered all over the summary buffer, Gnus can gather them.
  98
  99 If non-nil, Gnus will try to gather all loose sub-threads from an
 100 original thread into one large thread.
 101
 102 If this variable is non-nil, it should be one of `none', `adopt',
 103 `dummy' or `empty'.
 104
 105 If this variable is `none', Gnus will not make a false root, but just
 106 present the sub-threads after another.
 107 If this variable is `dummy', Gnus will create a dummy root that will
 108 have all the sub-threads as children.
 109 If this variable is `adopt', Gnus will make one of the \"children\"
 110 the parent and mark all the step-children as such.
 111 If this variable is `empty', the \"children\" are printed with empty
 112 subject fields.  (Or rather, they will be printed with a string
 113 given by the `gnus-summary-same-subject' variable.)"
 114   :group 'gnus-thread
 115   :type '(choice (const :tag "off" nil)
 116                  (const none)
 117                  (const dummy)
 118                  (const adopt)
 119                  (const empty)))
 120
 121 (defcustom gnus-summary-make-false-root-always nil
 122   "Always make a false dummy root."
 123   :version "22.1"
 124   :group 'gnus-thread
 125   :type 'boolean)
 126
 127 (defcustom gnus-summary-gather-exclude-subject "^ *$\\|^(none)$"
 128   "*A regexp to match subjects to be excluded from loose thread gathering.
 129 As loose thread gathering is done on subjects only, that means that
 130 there can be many false gatherings performed.  By rooting out certain
 131 common subjects, gathering might become saner."
 132   :group 'gnus-thread
 133   :type 'regexp)
 134
 135 (defcustom gnus-summary-gather-subject-limit nil
 136   "*Maximum length of subject comparisons when gathering loose threads.
 137 Use nil to compare full subjects.  Setting this variable to a low
 138 number will help gather threads that have been corrupted by
 139 newsreaders chopping off subject lines, but it might also mean that
 140 unrelated articles that have subject that happen to begin with the
 141 same few characters will be incorrectly gathered.
 142
 143 If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
 144 comparing subjects."
 145   :group 'gnus-thread
 146   :type '(choice (const :tag "off" nil)
 147                  (const fuzzy)
 148                  (sexp :menu-tag "on" t)))
 149
 150 (defcustom gnus-simplify-subject-functions nil
 151   "List of functions taking a string argument that simplify subjects.
 152 The functions are applied recursively.
 153
 154 Useful functions to put in this list include:
 155 `gnus-simplify-subject-re', `gnus-simplify-subject-fuzzy',
 156 `gnus-simplify-whitespace', and `gnus-simplify-all-whitespace'."
 157   :group 'gnus-thread
 158   :type '(repeat function))
 159
 160 (defcustom gnus-simplify-ignored-prefixes nil
 161   "*Remove matches for this regexp from subject lines when simplifying fuzzily."
 162   :group 'gnus-thread
 163   :type '(choice (const :tag "off" nil)
 164                  regexp))
 165
 166 (defcustom gnus-build-sparse-threads nil
 167   "*If non-nil, fill in the gaps in threads.
 168 If `some', only fill in the gaps that are needed to tie loose threads
 169 together.  If `more', fill in all leaf nodes that Gnus can find.  If
 170 non-nil and non-`some', fill in all gaps that Gnus manages to guess."
 171   :group 'gnus-thread
 172   :type '(choice (const :tag "off" nil)
 173                  (const some)
 174                  (const more)
 175                  (sexp :menu-tag "all" t)))
 176
 177 (defcustom gnus-summary-thread-gathering-function
 178   'gnus-gather-threads-by-subject
 179   "*Function used for gathering loose threads.
 180 There are two pre-defined functions: `gnus-gather-threads-by-subject',
 181 which only takes Subjects into consideration; and
 182 `gnus-gather-threads-by-references', which compared the References
 183 headers of the articles to find matches."
 184   :group 'gnus-thread
 185   :type '(radio (function-item gnus-gather-threads-by-subject)
 186                 (function-item gnus-gather-threads-by-references)
 187                 (function :tag "other")))
 188
 189 (defcustom gnus-summary-same-subject ""
 190   "*String indicating that the current article has the same subject as the previous.
 191 This variable will only be used if the value of
 192 `gnus-summary-make-false-root' is `empty'."
 193   :group 'gnus-summary-format
 194   :type 'string)
 195
 196 (defcustom gnus-summary-goto-unread t
 197   "*If t, many commands will go to the next unread article.
 198 This applies to marking commands as well as other commands that
 199 \"naturally\" select the next article, like, for instance, `SPC' at
 200 the end of an article.
 201
 202 If nil, the marking commands do NOT go to the next unread article
 203 \(they go to the next article instead).  If `never', commands that
 204 usually go to the next unread article, will go to the next article,
 205 whether it is read or not."
 206   :group 'gnus-summary-marks
 207   :link '(custom-manual "(gnus)Setting Marks")
 208   :type '(choice (const :tag "off" nil)
 209                  (const never)
 210                  (sexp :menu-tag "on" t)))
 211
 212 (defcustom gnus-summary-default-score 0
 213   "*Default article score level.
 214 All scores generated by the score files will be added to this score.
 215 If this variable is nil, scoring will be disabled."
 216   :group 'gnus-score-default
 217   :type '(choice (const :tag "disable")
 218                  integer))
 219
 220 (defcustom gnus-summary-default-high-score 0
 221   "*Default threshold for a high scored article.
 222 An article will be highlighted as high scored if its score is greater
 223 than this score."
 224   :version "22.1"
 225   :group 'gnus-score-default
 226   :type 'integer)
 227
 228 (defcustom gnus-summary-default-low-score 0
 229   "*Default threshold for a low scored article.
 230 An article will be highlighted as low scored if its score is smaller
 231 than this score."
 232   :version "22.1"
 233   :group 'gnus-score-default
 234   :type 'integer)
 235
 236 (defcustom gnus-summary-zcore-fuzz 0
 237   "*Fuzziness factor for the zcore in the summary buffer.
 238 Articles with scores closer than this to `gnus-summary-default-score'
 239 will not be marked."
 240   :group 'gnus-summary-format
 241   :type 'integer)
 242
 243 (defcustom gnus-simplify-subject-fuzzy-regexp nil
 244   "*Strings to be removed when doing fuzzy matches.
 245 This can either be a regular expression or list of regular expressions
 246 that will be removed from subject strings if fuzzy subject
 247 simplification is selected."
 248   :group 'gnus-thread
 249   :type '(repeat regexp))
 250
 251 (defcustom gnus-show-threads t
 252   "*If non-nil, display threads in summary mode."
 253   :group 'gnus-thread
 254   :type 'boolean)
 255
 256 (defcustom gnus-thread-hide-subtree nil
 257   "*If non-nil, hide all threads initially.
 258 This can be a predicate specifier which says which threads to hide.
 259 If threads are hidden, you have to run the command
 260 `gnus-summary-show-thread' by hand or select an article."
 261   :group 'gnus-thread
 262   :type '(radio (sexp :format "Non-nil\n"
 263                       :match (lambda (widget value)
 264                                (not (or (consp value) (functionp value))))
 265                       :value t)
 266                 (const nil)
 267                 (sexp :tag "Predicate specifier")))
 268
 269 (defcustom gnus-thread-hide-killed t
 270   "*If non-nil, hide killed threads automatically."
 271   :group 'gnus-thread
 272   :type 'boolean)
 273
 274 (defcustom gnus-thread-ignore-subject t
 275   "*If non-nil, which is the default, ignore subjects and do all threading based on the Reference header.
 276 If nil, articles that have different subjects from their parents will
 277 start separate threads."
 278   :group 'gnus-thread
 279   :type 'boolean)
 280
 281 (defcustom gnus-thread-operation-ignore-subject t
 282   "*If non-nil, subjects will be ignored when doing thread commands.
 283 This affects commands like `gnus-summary-kill-thread' and
 284 `gnus-summary-lower-thread'.
 285
 286 If this variable is nil, articles in the same thread with different
 287 subjects will not be included in the operation in question.  If this
 288 variable is `fuzzy', only articles that have subjects that are fuzzily
 289 equal will be included."
 290   :group 'gnus-thread
 291   :type '(choice (const :tag "off" nil)
 292                  (const fuzzy)
 293                  (sexp :tag "on" t)))
 294
 295 (defcustom gnus-thread-indent-level 4
 296   "*Number that says how much each sub-thread should be indented."
 297   :group 'gnus-thread
 298   :type 'integer)
 299
 300 (defcustom gnus-auto-extend-newsgroup t
 301   "*If non-nil, extend newsgroup forward and backward when requested."
 302   :group 'gnus-summary-choose
 303   :type 'boolean)
 304
 305 (defcustom gnus-auto-select-first t
 306   "*If non-nil, select the article under point.
 307 Which article this is is controlled by the `gnus-auto-select-subject'
 308 variable.
 309
 310 If you want to prevent automatic selection of articles in some
 311 newsgroups, set the variable to nil in `gnus-select-group-hook'."
 312   :group 'gnus-group-select
 313   :type '(choice (const :tag "none" nil)
 314                  (sexp :menu-tag "first" t)))
 315
 316 (defcustom gnus-auto-select-subject 'unread
 317   "*Says what subject to place under point when entering a group.
 318
 319 This variable can either be the symbols `first' (place point on the
 320 first subject), `unread' (place point on the subject line of the first
 321 unread article), `best' (place point on the subject line of the
 322 higest-scored article), `unseen' (place point on the subject line of
 323 the first unseen article), `unseen-or-unread' (place point on the subject
 324 line of the first unseen article or, if all article have been seen, on the
 325 subject line of the first unread article), or a function to be called to
 326 place point on some subject line."
 327   :version "22.1"
 328   :group 'gnus-group-select
 329   :type '(choice (const best)
 330                  (const unread)
 331                  (const first)
 332                  (const unseen)
 333                  (const unseen-or-unread)))
 334
 335 (defcustom gnus-auto-select-next t
 336   "*If non-nil, offer to go to the next group from the end of the previous.
 337 If the value is t and the next newsgroup is empty, Gnus will exit
 338 summary mode and go back to group mode.  If the value is neither nil
 339 nor t, Gnus will select the following unread newsgroup.  In
 340 particular, if the value is the symbol `quietly', the next unread
 341 newsgroup will be selected without any confirmation, and if it is
 342 `almost-quietly', the next group will be selected without any
 343 confirmation if you are located on the last article in the group.
 344 Finally, if this variable is `slightly-quietly', the `\\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]' command
 345 will go to the next group without confirmation."
 346   :group 'gnus-summary-maneuvering
 347   :type '(choice (const :tag "off" nil)
 348                  (const quietly)
 349                  (const almost-quietly)
 350                  (const slightly-quietly)
 351                  (sexp :menu-tag "on" t)))
 352
 353 (defcustom gnus-auto-select-same nil
 354   "*If non-nil, select the next article with the same subject.
 355 If there are no more articles with the same subject, go to
 356 the first unread article."
 357   :group 'gnus-summary-maneuvering
 358   :type 'boolean)
 359
 360 (defcustom gnus-auto-goto-ignores 'unfetched
 361   "*Says how to handle unfetched articles when maneuvering.
 362
 363 This variable can either be the symbols nil (maneuver to any
 364 article), `undownloaded' (maneuvering while unplugged ignores articles
 365 that have not been fetched), `always-undownloaded' (maneuvering always
 366 ignores articles that have not been fetched), `unfetched' (maneuvering
 367 ignores articles whose headers have not been fetched).
 368
 369 NOTE: The list of unfetched articles will always be nil when plugged
 370 and, when unplugged, a subset of the undownloaded article list."
 371   :version "22.1"
 372   :group 'gnus-summary-maneuvering
 373   :type '(choice (const :tag "None" nil)
 374                  (const :tag "Undownloaded when unplugged" undownloaded)
 375                  (const :tag "Undownloaded" always-undownloaded)
 376                  (const :tag "Unfetched" unfetched)))
 377
 378 (defcustom gnus-summary-check-current nil
 379   "*If non-nil, consider the current article when moving.
 380 The \"unread\" movement commands will stay on the same line if the
 381 current article is unread."
 382   :group 'gnus-summary-maneuvering
 383   :type 'boolean)
 384
 385 (defcustom gnus-auto-center-summary 2
 386   "*If non-nil, always center the current summary buffer.
 387 In particular, if `vertical' do only vertical recentering.  If non-nil
 388 and non-`vertical', do both horizontal and vertical recentering."
 389   :group 'gnus-summary-maneuvering
 390   :type '(choice (const :tag "none" nil)
 391                  (const vertical)
 392                  (integer :tag "height")
 393                  (sexp :menu-tag "both" t)))
 394
 395 (defvar gnus-auto-center-group t
 396   "*If non-nil, always center the group buffer.")
 397
 398 (defcustom gnus-show-all-headers nil
 399   "*If non-nil, don't hide any headers."
 400   :group 'gnus-article-hiding
 401   :group 'gnus-article-headers
 402   :type 'boolean)
 403
 404 (defcustom gnus-summary-ignore-duplicates nil
 405   "*If non-nil, ignore articles with identical Message-ID headers."
 406   :group 'gnus-summary
 407   :type 'boolean)
 408
 409 (defcustom gnus-single-article-buffer t
 410   "*If non-nil, display all articles in the same buffer.
 411 If nil, each group will get its own article buffer."
 412   :group 'gnus-article-various
 413   :type 'boolean)
 414
 415 (defcustom gnus-break-pages t
 416   "*If non-nil, do page breaking on articles.
 417 The page delimiter is specified by the `gnus-page-delimiter'
 418 variable."
 419   :group 'gnus-article-various
 420   :type 'boolean)
 421
 422 (defcustom gnus-move-split-methods nil
 423   "*Variable used to suggest where articles are to be moved to.
 424 It uses the same syntax as the `gnus-split-methods' variable.
 425 However, whereas `gnus-split-methods' specifies file names as targets,
 426 this variable specifies group names."
 427   :group 'gnus-summary-mail
 428   :type '(repeat (choice (list :value (fun) function)
 429                          (cons :value ("" "") regexp (repeat string))
 430                          (sexp :value nil))))
 431
 432 (defcustom gnus-move-group-prefix-function 'gnus-group-real-prefix
 433   "Function used to compute default prefix for article move/copy/etc prompts.
 434 The function should take one argument, a group name, and return a
 435 string with the suggested prefix."
 436   :group 'gnus-summary-mail
 437   :type 'function)
 438
 439 ;; FIXME: Although the custom type is `character' for the following variables,
 440 ;; using multibyte characters (Latin-1, UTF-8) doesn't work.  -- rs
 441
 442 (defcustom gnus-unread-mark ?           ;Whitespace
 443   "*Mark used for unread articles."
 444   :group 'gnus-summary-marks
 445   :type 'character)
 446
 447 (defcustom gnus-ticked-mark ?!
 448   "*Mark used for ticked articles."
 449   :group 'gnus-summary-marks
 450   :type 'character)
 451
 452 (defcustom gnus-dormant-mark ??
 453   "*Mark used for dormant articles."
 454   :group 'gnus-summary-marks
 455   :type 'character)
 456
 457 (defcustom gnus-del-mark ?r
 458   "*Mark used for del'd articles."
 459   :group 'gnus-summary-marks
 460   :type 'character)
 461
 462 (defcustom gnus-read-mark ?R
 463   "*Mark used for read articles."
 464   :group 'gnus-summary-marks
 465   :type 'character)
 466
 467 (defcustom gnus-expirable-mark ?E
 468   "*Mark used for expirable articles."
 469   :group 'gnus-summary-marks
 470   :type 'character)
 471
 472 (defcustom gnus-killed-mark ?K
 473   "*Mark used for killed articles."
 474   :group 'gnus-summary-marks
 475   :type 'character)
 476
 477 (defcustom gnus-spam-mark ?$
 478   "*Mark used for spam articles."
 479   :version "22.1"
 480   :group 'gnus-summary-marks
 481   :type 'character)
 482
 483 (defcustom gnus-souped-mark ?F
 484   "*Mark used for souped articles."
 485   :group 'gnus-summary-marks
 486   :type 'character)
 487
 488 (defcustom gnus-kill-file-mark ?X
 489   "*Mark used for articles killed by kill files."
 490   :group 'gnus-summary-marks
 491   :type 'character)
 492
 493 (defcustom gnus-low-score-mark ?Y
 494   "*Mark used for articles with a low score."
 495   :group 'gnus-summary-marks
 496   :type 'character)
 497
 498 (defcustom gnus-catchup-mark ?C
 499   "*Mark used for articles that are caught up."
 500   :group 'gnus-summary-marks
 501   :type 'character)
 502
 503 (defcustom gnus-replied-mark ?A
 504   "*Mark used for articles that have been replied to."
 505   :group 'gnus-summary-marks
 506   :type 'character)
 507
 508 (defcustom gnus-forwarded-mark ?F
 509   "*Mark used for articles that have been forwarded."
 510   :version "22.1"
 511   :group 'gnus-summary-marks
 512   :type 'character)
 513
 514 (defcustom gnus-recent-mark ?N
 515   "*Mark used for articles that are recent."
 516   :version "22.1"
 517   :group 'gnus-summary-marks
 518   :type 'character)
 519
 520 (defcustom gnus-cached-mark ?*
 521   "*Mark used for articles that are in the cache."
 522   :group 'gnus-summary-marks
 523   :type 'character)
 524
 525 (defcustom gnus-saved-mark ?S
 526   "*Mark used for articles that have been saved."
 527   :group 'gnus-summary-marks
 528   :type 'character)
 529
 530 (defcustom gnus-unseen-mark ?.
 531   "*Mark used for articles that haven't been seen."
 532   :version "22.1"
 533   :group 'gnus-summary-marks
 534   :type 'character)
 535
 536 (defcustom gnus-no-mark ?               ;Whitespace
 537   "*Mark used for articles that have no other secondary mark."
 538   :version "22.1"
 539   :group 'gnus-summary-marks
 540   :type 'character)
 541
 542 (defcustom gnus-ancient-mark ?O
 543   "*Mark used for ancient articles."
 544   :group 'gnus-summary-marks
 545   :type 'character)
 546
 547 (defcustom gnus-sparse-mark ?Q
 548   "*Mark used for sparsely reffed articles."
 549   :group 'gnus-summary-marks
 550 &n