git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-art.el

   1 ;;; gnus-art.el --- article mode commands for Semi-gnus
   2 ;; Copyright (C) 1996,97,98,99 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   5 ;;      MORIOKA Tomohiko <morioka@jaist.ac.jp>
   6 ;;      Katsumi Yamaoka <yamaoka@jpl.org>
   7 ;; Keywords: mail, news, MIME
   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., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (eval-when-compile (require 'cl))
  31
  32 (require 'custom)
  33 (require 'gnus)
  34 (require 'gnus-sum)
  35 (require 'gnus-spec)
  36 (require 'gnus-int)
  37 (require 'browse-url)
  38 (require 'alist)
  39 (require 'mime-view)
  40
  41 ;; Avoid byte-compile warnings.
  42 (eval-when-compile
  43   (defvar gnus-article-decoded-p)
  44   (defvar gnus-article-mime-handles)
  45   (require 'mm-bodies)
  46   (require 'mail-parse)
  47   (require 'mm-decode)
  48   (require 'mm-view)
  49   (require 'wid-edit)
  50   (require 'mm-uu)
  51   )
  52
  53 (defgroup gnus-article nil
  54   "Article display."
  55   :link '(custom-manual "(gnus)The Article Buffer")
  56   :group 'gnus)
  57
  58 (defgroup gnus-article-treat nil
  59   "Treating article parts."
  60   :link '(custom-manual "(gnus)Article Hiding")
  61   :group 'gnus-article)
  62
  63 (defgroup gnus-article-hiding nil
  64   "Hiding article parts."
  65   :link '(custom-manual "(gnus)Article Hiding")
  66   :group 'gnus-article)
  67
  68 (defgroup gnus-article-highlight nil
  69   "Article highlighting."
  70   :link '(custom-manual "(gnus)Article Highlighting")
  71   :group 'gnus-article
  72   :group 'gnus-visual)
  73
  74 (defgroup gnus-article-signature nil
  75   "Article signatures."
  76   :link '(custom-manual "(gnus)Article Signature")
  77   :group 'gnus-article)
  78
  79 (defgroup gnus-article-headers nil
  80   "Article headers."
  81   :link '(custom-manual "(gnus)Hiding Headers")
  82   :group 'gnus-article)
  83
  84 (defgroup gnus-article-washing nil
  85   "Special commands on articles."
  86   :link '(custom-manual "(gnus)Article Washing")
  87   :group 'gnus-article)
  88
  89 (defgroup gnus-article-emphasis nil
  90   "Fontisizing articles."
  91   :link '(custom-manual "(gnus)Article Fontisizing")
  92   :group 'gnus-article)
  93
  94 (defgroup gnus-article-saving nil
  95   "Saving articles."
  96   :link '(custom-manual "(gnus)Saving Articles")
  97   :group 'gnus-article)
  98
  99 (defgroup gnus-article-mime nil
 100   "Worshiping the MIME wonder."
 101   :link '(custom-manual "(gnus)Using MIME")
 102   :group 'gnus-article)
 103
 104 (defgroup gnus-article-buttons nil
 105   "Pushable buttons in the article buffer."
 106   :link '(custom-manual "(gnus)Article Buttons")
 107   :group 'gnus-article)
 108
 109 (defgroup gnus-article-various nil
 110   "Other article options."
 111   :link '(custom-manual "(gnus)Misc Article")
 112   :group 'gnus-article)
 113
 114 (defcustom gnus-ignored-headers
 115   '("^Path:" "^Expires:" "^Date-Received:" "^References:" "^Xref:" "^Lines:"
 116     "^Relay-Version:" "^Message-ID:" "^Approved:" "^Sender:" "^Received:"
 117     "^X-UIDL:" "^MIME-Version:" "^Return-Path:" "^In-Reply-To:"
 118     "^Content-Type:" "^Content-Transfer-Encoding:" "^X-WebTV-Signature:"
 119     "^X-MimeOLE:" "^X-MSMail-Priority:" "^X-Priority:" "^X-Loop:"
 120     "^X-Authentication-Warning:" "^X-MIME-Autoconverted:" "^X-Face:"
 121     "^X-Attribution:" "^X-Originating-IP:" "^Delivered-To:"
 122     "^NNTP-[-A-Za-z]+:" "^Distribution:" "^X-no-archive:" "^X-Trace:"
 123     "^X-Complaints-To:" "^X-NNTP-Posting-Host:" "^X-Orig.*:"
 124     "^Abuse-Reports-To:" "^Cache-Post-Path:" "^X-Article-Creation-Date:"
 125     "^X-Poster:" "^X-Mail2News-Path:" "^X-Server-Date:" "^X-Cache:"
 126     "^Originator:" "^X-Problems-To:" "^X-Auth-User:" "^X-Post-Time:"
 127     "^X-Admin:" "^X-UID:" "^Resent-[-A-Za-z]+:" "^X-Mailing-List:"
 128     "^Precedence:" "^Original-[-A-Za-z]+:" "^X-filename:" "^X-Orcpt:"
 129     "^Old-Received:" "^X-Pgp-Fingerprint:" "^X-Pgp-Key-Id:"
 130     "^X-Pgp-Public-Key-Url:" "^X-Auth:" "^X-From-Line:"
 131     "^X-Gnus-Article-Number:" "^X-Majordomo:" "^X-Url:" "^X-Sender:"
 132     "^X-Mailing-List:" "^MBOX-Line" "^Priority:" "^X-Pgp" "^X400-[-A-Za-z]+:"
 133     "^Status:" "^X-Gnus-Mail-Source:" "^Cancel-Lock:")
 134   "*All headers that start with this regexp will be hidden.
 135 This variable can also be a list of regexps of headers to be ignored.
 136 If `gnus-visible-headers' is non-nil, this variable will be ignored."
 137   :type '(choice :custom-show nil
 138                  regexp
 139                  (repeat regexp))
 140   :group 'gnus-article-hiding)
 141
 142 (defcustom gnus-visible-headers
 143   "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^[BGF]?Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|^X-Sent:"
 144   "*All headers that do not match this regexp will be hidden.
 145 This variable can also be a list of regexp of headers to remain visible.
 146 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
 147   :type '(repeat :value-to-internal (lambda (widget value)
 148                                       (custom-split-regexp-maybe value))
 149                  :match (lambda (widget value)
 150                           (or (stringp value)
 151                               (widget-editable-list-match widget value)))
 152                  regexp)
 153   :group 'gnus-article-hiding)
 154
 155 (defcustom gnus-sorted-header-list
 156   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
 157     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
 158   "*This variable is a list of regular expressions.
 159 If it is non-nil, headers that match the regular expressions will
 160 be placed first in the article buffer in the sequence specified by
 161 this list."
 162   :type '(repeat regexp)
 163   :group 'gnus-article-hiding)
 164
 165 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
 166   "Headers that are only to be displayed if they have interesting data.
 167 Possible values in this list are `empty', `newsgroups', `followup-to',
 168 `reply-to', `date', `long-to', and `many-to'."
 169   :type '(set (const :tag "Headers with no content." empty)
 170               (const :tag "Newsgroups with only one group." newsgroups)
 171               (const :tag "Followup-to identical to newsgroups." followup-to)
 172               (const :tag "Reply-to identical to from." reply-to)
 173               (const :tag "Date less than four days old." date)
 174               (const :tag "Very long To header." long-to)
 175               (const :tag "Multiple To headers." many-to))
 176   :group 'gnus-article-hiding)
 177
 178 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
 179   "Regexp matching signature separator.
 180 This can also be a list of regexps.  In that case, it will be checked
 181 from head to tail looking for a separator.  Searches will be done from
 182 the end of the buffer."
 183   :type '(repeat string)
 184   :group 'gnus-article-signature)
 185
 186 (defcustom gnus-signature-limit nil
 187    "Provide a limit to what is considered a signature.
 188 If it is a number, no signature may not be longer (in characters) than
 189 that number.  If it is a floating point number, no signature may be
 190 longer (in lines) than that number.  If it is a function, the function
 191 will be called without any parameters, and if it returns nil, there is
 192 no signature in the buffer.  If it is a string, it will be used as a
 193 regexp.  If it matches, the text in question is not a signature."
 194   :type '(choice (integer :value 200)
 195                  (number :value 4.0)
 196                  (function :value fun)
 197                  (regexp :value ".*"))
 198   :group 'gnus-article-signature)
 199
 200 (defcustom gnus-hidden-properties '(invisible t intangible t)
 201   "Property list to use for hiding text."
 202   :type 'sexp
 203   :group 'gnus-article-hiding)
 204
 205 (defcustom gnus-article-x-face-command
 206   "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
 207   "*String or function to be executed to display an X-Face header.
 208 If it is a string, the command will be executed in a sub-shell
 209 asynchronously.  The compressed face will be piped to this command."
 210   :type 'string                         ;Leave function case to Lisp.
 211   :group 'gnus-article-washing)
 212
 213 (defcustom gnus-article-x-face-too-ugly nil
 214   "Regexp matching posters whose face shouldn't be shown automatically."
 215   :type '(choice regexp (const nil))
 216   :group 'gnus-article-washing)
 217
 218 (defcustom gnus-emphasis-alist
 219   (let ((format
 220          "\\(\\s-\\|^\\|[-\"]\\|\\s(\\|\\s)\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\s-\\|[-?!.,;:\"]\\|\\s(\\|\\s)\\)")
 221         (types
 222          '(("_" "_" underline)
 223            ("/" "/" italic)
 224            ("\\*" "\\*" bold)
 225            ("_/" "/_" underline-italic)
 226            ("_\\*" "\\*_" underline-bold)
 227            ("\\*/" "/\\*" bold-italic)
 228            ("_\\*/" "/\\*_" underline-bold-italic))))
 229     `(("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
 230        2 3 gnus-emphasis-underline)
 231       ,@(mapcar
 232          (lambda (spec)
 233            (list
 234             (format format (car spec) (cadr spec))
 235             2 3 (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
 236          types)))
 237   "*Alist that says how to fontify certain phrases.
 238 Each item looks like this:
 239
 240   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
 241
 242 The first element is a regular expression to be matched.  The second
 243 is a number that says what regular expression grouping used to find
 244 the entire emphasized word.  The third is a number that says what
 245 regexp grouping should be displayed and highlighted.  The fourth
 246 is the face used for highlighting."
 247   :type '(repeat (list :value ("" 0 0 default)
 248                        regexp
 249                        (integer :tag "Match group")
 250                        (integer :tag "Emphasize group")
 251                        face))
 252   :group 'gnus-article-emphasis)
 253
 254 (defface gnus-emphasis-bold '((t (:bold t)))
 255   "Face used for displaying strong emphasized text (*word*)."
 256   :group 'gnus-article-emphasis)
 257
 258 (defface gnus-emphasis-italic '((t (:italic t)))
 259   "Face used for displaying italic emphasized text (/word/)."
 260   :group 'gnus-article-emphasis)
 261
 262 (defface gnus-emphasis-underline '((t (:underline t)))
 263   "Face used for displaying underlined emphasized text (_word_)."
 264   :group 'gnus-article-emphasis)
 265
 266 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
 267   "Face used for displaying underlined bold emphasized text (_*word*_)."
 268   :group 'gnus-article-emphasis)
 269
 270 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
 271   "Face used for displaying underlined italic emphasized text (_*word*_)."
 272   :group 'gnus-article-emphasis)
 273
 274 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
 275   "Face used for displaying bold italic emphasized text (/*word*/)."
 276   :group 'gnus-article-emphasis)
 277
 278 (defface gnus-emphasis-underline-bold-italic
 279   '((t (:bold t :italic t :underline t)))
 280   "Face used for displaying underlined bold italic emphasized text.
 281 Esample: (_/*word*/_)."
 282   :group 'gnus-article-emphasis)
 283
 284 (defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
 285   "Format for display of Date headers in article bodies.
 286 See `format-time-string' for the possible values.
 287
 288 The variable can also be function, which should return a complete Date
 289 header.  The function is called with one argument, the time, which can
 290 be fed to `format-time-string'."
 291   :type '(choice string symbol)
 292   :link '(custom-manual "(gnus)Article Date")
 293   :group 'gnus-article-washing)
 294
 295 (eval-and-compile
 296   (autoload 'mail-extract-address-components "mail-extr"))
 297
 298 (defcustom gnus-save-all-headers t
 299   "*If non-nil, don't remove any headers before saving."
 300   :group 'gnus-article-saving
 301   :type 'boolean)
 302
 303 (defcustom gnus-prompt-before-saving 'always
 304   "*This variable says how much prompting is to be done when saving articles.
 305 If it is nil, no prompting will be done, and the articles will be
 306 saved to the default files.  If this variable is `always', each and
 307 every article that is saved will be preceded by a prompt, even when
 308 saving large batches of articles.  If this variable is neither nil not
 309 `always', there the user will be prompted once for a file name for
 310 each invocation of the saving commands."
 311   :group 'gnus-article-saving
 312   :type '(choice (item always)
 313                  (item :tag "never" nil)
 314                  (sexp :tag "once" :format "%t\n" :value t)))
 315
 316 (defcustom gnus-saved-headers gnus-visible-headers
 317   "Headers to keep if `gnus-save-all-headers' is nil.
 318 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
 319 If that variable is nil, however, all headers that match this regexp
 320 will be kept while the rest will be deleted before saving."
 321   :group 'gnus-article-saving
 322   :type 'regexp)
 323
 324 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
 325   "A function to save articles in your favourite format.
 326 The function must be interactively callable (in other words, it must
 327 be an Emacs command).
 328
 329 Gnus provides the following functions:
 330
 331 * gnus-summary-save-in-rmail (Rmail format)
 332 * gnus-summary-save-in-mail (Unix mail format)
 333 * gnus-summary-save-in-folder (MH folder)
 334 * gnus-summary-save-in-file (article format)
 335 * gnus-summary-save-in-vm (use VM's folder format)
 336 * gnus-summary-write-to-file (article format -- overwrite)."
 337   :group 'gnus-article-saving
 338   :type '(radio (function-item gnus-summary-save-in-rmail)
 339                 (function-item gnus-summary-save-in-mail)
 340                 (function-item gnus-summary-save-in-folder)
 341                 (function-item gnus-summary-save-in-file)
 342                 (function-item gnus-summary-save-in-vm)
 343                 (function-item gnus-summary-write-to-file)))
 344
 345 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
 346   "A function generating a file name to save articles in Rmail format.
 347 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 348   :group 'gnus-article-saving
 349   :type 'function)
 350
 351 (defcustom gnus-mail-save-name 'gnus-plain-save-name
 352   "A function generating a file name to save articles in Unix mail format.
 353 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 354   :group 'gnus-article-saving
 355   :type 'function)
 356
 357 (defcustom gnus-folder-save-name 'gnus-folder-save-name
 358   "A function generating a file name to save articles in MH folder.
 359 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
 360   :group 'gnus-article-saving
 361   :type 'function)
 362
 363 (defcustom gnus-file-save-name 'gnus-numeric-save-name
 364   "A function generating a file name to save articles in article format.
 365 The function is called with NEWSGROUP, HEADERS, and optional
 366 LAST-FILE."
 367   :group 'gnus-article-saving
 368   :type 'function)
 369
 370 (defcustom gnus-split-methods
 371   '((gnus-article-archive-name)
 372     (gnus-article-nndoc-name))
 373   "*Variable used to suggest where articles are to be saved.
 374 For instance, if you would like to save articles related to Gnus in
 375 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
 376 you could set this variable to something like:
 377
 378  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
 379    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
 380
 381 This variable is an alist where the where the key is the match and the
 382 value is a list of possible files to save in if the match is non-nil.
 383
 384 If the match is a string, it is used as a regexp match on the
 385 article.  If the match is a symbol, that symbol will be funcalled
 386 from the buffer of the article to be saved with the newsgroup as the
 387 parameter.  If it is a list, it will be evaled in the same buffer.
 388
 389 If this form or function returns a string, this string will be used as
 390 a possible file name; and if it returns a non-nil list, that list will
 391 be used as possible file names."
 392   :group 'gnus-article-saving
 393   :type '(repeat (choice (list :value (fun) function)
 394                          (cons :value ("" "") regexp (repeat string))
 395                          (sexp :value nil))))
 396
 397 (defcustom gnus-article-display-method-for-mime
 398   'gnus-article-display-mime-message
 399   "Function to display a MIME message.
 400 The function is called from the article buffer."
 401   :group 'gnus-article-mime
 402   :type 'function)
 403
 404 (defcustom gnus-article-display-method-for-traditional
 405   'gnus-article-display-traditional-message
 406   "*Function to display a traditional message.
 407 The function is called from the article buffer."
 408   :group 'gnus-article-mime
 409   :type 'function)
 410
 411 (defcustom gnus-page-delimiter "^\^L"
 412   "*Regexp describing what to use as article page delimiters.
 413 The default value is \"^\^L\", which is a form linefeed at the
 414 beginning of a line."
 415   :type 'regexp
 416   :group 'gnus-article-various)
 417
 418 (defcustom gnus-article-mode-line-format "Gnus: %g %S%m"
 419   "*The format specification for the article mode line.
 420 See `gnus-summary-mode-line-format' for a closer description.
 421
 422 The following additional specs are available:
 423
 424 %w  The article washing status.
 425 %m  The number of MIME parts in the article."
 426   :type 'string
 427   :group 'gnus-article-various)
 428
 429 (defcustom gnus-article-mode-hook nil
 430   "*A hook for Gnus article mode."
 431   :type 'hook
 432   :group 'gnus-article-various)
 433
 434 (defcustom gnus-article-menu-hook nil
 435   "*Hook run after the creation of the article mode menu."
 436   :type 'hook
 437   :group 'gnus-article-various)
 438
 439 (defcustom gnus-article-prepare-hook nil
 440   "*A hook called after an article has been prepared in the article buffer."
 441   :type 'hook
 442   :group 'gnus-article-various)
 443
 444 (defcustom gnus-article-hide-pgp-hook nil
 445   "*A hook called after successfully hiding a PGP signature."
 446   :type 'hook
 447   :group 'gnus-article-various)
 448
 449 (defcustom gnus-article-button-face 'bold
 450   "Face used for highlighting buttons in the article buffer.
 451
 452 An article button is a piece of text that you can activate by pressing
 453 `RET' or `mouse-2' above it."
 454   :type 'face
 455   :group 'gnus-article-buttons)
 456
 457 (defcustom gnus-article-mouse-face 'highlight
 458   "Face used for mouse highlighting in the article buffer.
 459
 460 Article buttons will be displayed in this face when the cursor is
 461 above them."
 462   :type 'face
 463   :group 'gnus-article-buttons)
 464
 465 (defcustom gnus-signature-face 'gnus-signature-face
 466   "Face used for highlighting a signature in the article buffer.
 467 Obsolete; use the face `gnus-signature-face' for customizations instead."
 468   :type 'face
 469   :group 'gnus-article-highlight
 470   :group 'gnus-article-signature)
 471
 472 (defface gnus-signature-face
 473   '((((type x))
 474      (:italic t)))
 475   "Face used for highlighting a signature in the article buffer."
 476   :group 'gnus-article-highlight
 477   :group 'gnus-article-signature)
 478
 479 (defface gnus-header-from-face
 480   '((((class color)
 481       (background dark))
 482      (:foreground "spring green"))
 483     (((class color)
 484       (background light))
 485      (:foreground "red3"))
 486     (t
 487      (:italic t)))
 488   "Face used for displaying from headers."
 489   :group 'gnus-article-headers
 490   :group 'gnus-article-highlight)
 491
 492 (defface gnus-header-subject-face
 493   '((((class color)
 494       (background dark))
 495      (:foreground "SeaGreen3"))
 496     (((class color)
 497       (background light))
 498      (:foreground "red4"))
 499     (t
 500      (:bold t :italic t)))
 501   "Face used for displaying subject headers."
 502   :group 'gnus-article-headers
 503   :group 'gnus-article-highlight)
 504
 505 (defface gnus-header-newsgroups-face
 506   '((((class color)
 507       (background dark))
 508      (:foreground "yellow" :italic t))
 509     (((class color)
 510       (background light))
 511      (:foreground "MidnightBlue" :italic t))
 512     (t
 513      (:italic t)))
 514   "Face used for displaying newsgroups headers."
 515   :group 'gnus-article-headers
 516   :group 'gnus-article-highlight)
 517
 518 (defface gnus-header-name-face
 519   '((((class color)
 520       (background dark))
 521      (:foreground "SeaGreen"))
 522     (((class color)
 523       (background light))
 524      (:foreground "maroon"))
 525     (t
 526      (:bold t)))
 527   "Face used for displaying header names."
 528   :group 'gnus-article-headers
 529   :group 'gnus-article-highlight)
 530
 531 (defface gnus-header-content-face
 532   '((((class color)
 533       (background dark))
 534      (:foreground "forest green" :italic t))
 535     (((class color)
 536       (background light))
 537      (:foreground "indianred4" :italic t))
 538     (t
 539      (:italic t)))  "Face used for displaying header content."
 540   :group 'gnus-article-headers
 541   :group 'gnus-article-highlight)
 542
 543 (defcustom gnus-header-face-alist
 544   '(("From" nil gnus-header-from-face)
 545     ("Subject" nil gnus-header-subject-face)
 546     ("Newsgroups:.*," nil gnus-header-newsgroups-face)
 547     ("" gnus-header-name-face gnus-header-content-face))
 548   "*Controls highlighting of article header.
 549
 550 An alist of the form (HEADER NAME CONTENT).
 551
 552 HEADER is a regular expression which should match the name of an
 553 header header and NAME and CONTENT are either face names or nil.
 554
 555 The name of each header field will be displayed using the face
 556 specified by the first element in the list where HEADER match the
 557 header name and NAME is non-nil.  Similarly, the content will be
 558 displayed by the first non-nil matching CONTENT face."
 559   :group 'gnus-article-headers
 560   :group 'gnus-article-highlight
 561   :type '(repeat (list (regexp :tag "Header")
 562                        (choice :tag "Name"
 563                                (item :tag "skip" nil)
 564                                (face :value default))
 565                        (choice :tag "Content"
 566                                (item :tag "skip" nil)
 567                                (face :value default)))))
 568
 569 (defcustom gnus-article-decode-hook nil
 570   "*Hook run to decode charsets in articles."
 571   :group 'gnus-article-headers
 572   :type 'hook)
 573
 574 (defcustom gnus-display-mime-function 'gnus-display-mime
 575   "Function to display MIME articles."
 576   :group 'gnus-article-mime
 577   :type 'function)
 578
 579 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
 580   "Function used to decode headers.")
 581
 582 (defvar gnus-article-dumbquotes-map
 583   '(("\202" ",")
 584     ("\203" "f")
 585     ("\204" ",,")
 586     ("\205" "...")
 587     ("\213" "<")
 588     ("\214" "OE")
 589     ("\221" "`")
 590     ("\222" "'")
 591     ("\223" "``")
 592     ("\224" "''")
 593     ("\225" "*")
 594     ("\226" "-")
 595     ("\227" "-")
 596     ("\231" "(TM)")
 597     ("\233" ">")
 598     ("\234" "oe")
 599     ("\264" "'"))
 600   "Table for MS-to-Latin1 translation.")
 601
 602 (defcustom gnus-ignored-mime-types nil
 603   "List of MIME types that should be ignored by Gnus."
 604   :group 'gnus-article-mime
 605   :type '(repeat regexp))
 606
 607 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
 608   "List of MIME types that should not be given buttons when rendered."
 609   :group 'gnus-article-mime
 610   :type '(repeat regexp))
 611
 612 (defcustom gnus-article-mime-part-function nil
 613   "Function called with a MIME handle as the argument.
 614 This is meant for people who want to do something automatic based
 615 on parts -- for instance, adding Vcard info to a database."
 616   :group 'gnus-article-mime
 617   :type 'function)
 618
 619 (defcustom gnus-mime-multipart-functions nil
 620   "An alist of MIME types to functions to display them.")
 621
 622 (defcustom gnus-article-date-lapsed-new-header nil
 623   "Whether the X-Sent and Date headers can coexist.
 624 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
 625 either replace the old \"Date:\" header (if this variable is nil), or
 626 be added below it (otherwise)."
 627   :group 'gnus-article-headers
 628   :type 'boolean)
 629
 630 ;;;
 631 ;;; The treatment variables
 632 ;;;
 633
 634 (defvar gnus-part-display-hook nil
 635   "Hook called on parts that are to receive treatment.")
 636
 637 (defvar gnus-article-treat-custom
 638   '(choice (const :tag "Off" nil)
 639            (const :tag "On" t)
 640            (const :tag "Header" head)
 641            (const :tag "Last" last)
 642            (integer :tag "Less")
 643            (sexp :tag "Predicate")))
 644
 645 (defvar gnus-article-treat-head-custom
 646   '(choice (const :tag "Off" nil)
 647            (const :tag "Header" head)))
 648
 649 (defvar gnus-article-treat-types '("text/plain")
 650   "Parts to treat.")
 651
 652 (defvar gnus-inhibit-treatment nil
 653   "Whether to inhibit treatment.")
 654
 655 (defcustom gnus-treat-highlight-signature '(or last (typep "text/x-vcard"))
 656   "Highlight the signature.
 657 Valid values are nil, t, `head', `last', an integer or a predicate.
 658 See the manual for details."
 659   :group 'gnus-article-treat
 660   :type gnus-article-treat-custom)
 661 (put 'gnus-treat-highlight-signature 'highlight t)
 662
 663 (defcustom gnus-treat-buttonize t
 664   "Add buttons.
 665 Valid values are nil, t, `head', `last', an integer or a predicate.
 666 See the manual for details."
 667   :group 'gnus-article-treat
 668   :type gnus-article-treat-custom)
 669 (put 'gnus-treat-buttonize 'highlight t)
 670
 671 (defcustom gnus-treat-buttonize-head 'head
 672   "Add buttons to the head.
 673 Valid values are nil, t, `head', `last', an integer or a predicate.
 674 See the manual for details."
 675   :group 'gnus-article-treat
 676   :type gnus-article-treat-head-custom)
 677 (put 'gnus-treat-buttonize-head 'highlight t)
 678
 679 (defcustom gnus-treat-emphasize t
 680   "Emphasize text.
 681 Valid values are nil, t, `head', `last', an integer or a predicate.
 682 See the manual for details."
 683   :group 'gnus-article-treat
 684   :type gnus-article-treat-custom)
 685 (put 'gnus-treat-emphasize 'highlight t)
 686
 687 (defcustom gnus-treat-strip-cr nil
 688   "Remove carriage returns.
 689 Valid values are nil, t, `head', `last', an integer or a predicate.
 690 See the manual for details."
 691   :group 'gnus-article-treat
 692   :type gnus-article-treat-custom)
 693
 694 (defcustom gnus-treat-hide-headers 'head
 695   "Hide headers.
 696 Valid values are nil, t, `head', `last', an integer or a predicate.
 697 See the manual for details."
 698   :group 'gnus-article-treat
 699   :type gnus-article-treat-head-custom)
 700
 701 (defcustom gnus-treat-hide-boring-headers nil
 702   "Hide boring headers.
 703 Valid values are nil, t, `head', `last', an integer or a predicate.
 704 See the manual for details."
 705   :group 'gnus-article-treat
 706   :type gnus-article-treat-head-custom)
 707
 708 (defcustom gnus-treat-hide-signature nil
 709   "Hide the signature.
 710 Valid values are nil, t, `head', `last', an integer or a predicate.
 711 See the manual for details."
 712   :group 'gnus-article-treat
 713   :type gnus-article-treat-custom)
 714
 715 (defcustom gnus-treat-fill-article nil
 716   "Fill the article.
 717 Valid values are nil, t, `head', `last', an integer or a predicate.
 718 See the manual for details."
 719   :group 'gnus-article-treat
 720   :type gnus-article-treat-custom)
 721
 722 (defcustom gnus-treat-hide-citation nil
 723   "Hide cited text.
 724 Valid values are nil, t, `head', `last', an integer or a predicate.
 725 See the manual for details."
 726   :group 'gnus-article-treat
 727   :type gnus-article-treat-custom)
 728
 729 (defcustom gnus-treat-strip-pgp t
 730   "Strip PGP signatures.
 731 Valid values are nil, t, `head', `last', an integer or a predicate.
 732 See the manual for details."
 733   :group 'gnus-article-treat
 734   :type gnus-article-treat-custom)
 735
 736 (defcustom gnus-treat-strip-pem nil
 737   "Strip PEM signatures.
 738 Valid values are nil, t, `head', `last', an integer or a predicate.
 739 See the manual for details."
 740   :group 'gnus-article-treat
 741   :type gnus-article-treat-custom)
 742
 743 (defcustom gnus-treat-strip-banner t
 744   "Strip banners from articles.
 745 The banner to be stripped is specified in the `banner' group parameter.
 746 Valid values are nil, t, `head', `last', an integer or a predicate.
 747 See the manual for details."
 748   :group 'gnus-article-treat
 749   :type gnus-article-treat-custom)
 750
 751 (defcustom gnus-treat-highlight-headers 'head
 752   "Highlight the headers.
 753 Valid values are nil, t, `head', `last', an integer or a predicate.
 754 See the manual for details."
 755   :group 'gnus-article-treat
 756   :type gnus-article-treat-head-custom)
 757 (put 'gnus-treat-highlight-headers 'highlight t)
 758
 759 (defcustom gnus-treat-highlight-citation t
 760   "Highlight cited text.
 761 Valid values are nil, t, `head', `last', an integer or a predicate.
 762 See the manual for details."
 763   :group 'gnus-article-treat
 764   :type gnus-article-treat-custom)
 765 (put 'gnus-treat-highlight-citation 'highlight t)
 766
 767 (defcustom gnus-treat-date-ut nil
 768   "Display the Date in UT (GMT).
 769 Valid values are nil, t, `head', `last', an integer or a predicate.
 770 See the manual for details."
 771   :group 'gnus-article-treat
 772   :type gnus-article-treat-head-custom)
 773
 774 (defcustom gnus-treat-date-local nil
 775   "Display the Date in the local timezone.
 776 Valid values are nil, t, `head', `last', an integer or a predicate.
 777 See the manual for details."
 778   :group 'gnus-article-treat
 779   :type gnus-article-treat-head-custom)
 780
 781 (defcustom gnus-treat-date-lapsed nil
 782   "Display the Date header in a way that says how much time has elapsed.
 783 Valid values are nil, t, `head', `last', an integer or a predicate.
 784 See the manual for details."
 785   :group 'gnus-article-treat
 786   :type gnus-article-treat-head-custom)
 787
 788 (defcustom gnus-treat-date-original nil
 789   "Display the date in the original timezone.
 790 Valid values are nil, t, `head', `last', an integer or a predicate.
 791 See the manual for details."
 792   :group 'gnus-article-treat
 793   :type gnus-article-treat-head-custom)
 794
 795 (defcustom gnus-treat-date-iso8601 nil
 796   "Display the date in the ISO8601 format.
 797 Valid values are nil, t, `head', `last', an integer or a predicate.
 798 See the manual for details."
 799   :group 'gnus-article-treat
 800   :type gnus-article-treat-head-custom)
 801
 802 (defcustom gnus-treat-date-user-defined nil
 803   "Display the date in a user-defined format.
 804 The format is defined by the `gnus-article-time-format' variable.
 805 Valid values are nil, t, `head', `last', an integer or a predicate.
 806 See the manual for details."
 807   :group 'gnus-article-treat
 808   :type gnus-article-treat-head-custom)
 809
 810 (defcustom gnus-treat-strip-headers-in-body t
 811   "Strip the X-No-Archive header line from the beginning of the body.
 812 Valid values are nil, t, `head', `last', an integer or a predicate.
 813 See the manual for details."
 814   :group 'gnus-article-treat
 815   :type gnus-article-treat-custom)
 816
 817 (defcustom gnus-treat-strip-trailing-blank-lines nil
 818   "Strip trailing blank lines.
 819 Valid values are nil, t, `head', `last', an integer or a predicate.
 820 See the manual for details."
 821   :group 'gnus-article-treat
 822   :type gnus-article-treat-custom)
 823
 824 (defcustom gnus-treat-strip-leading-blank-lines nil
 825   "Strip leading blank lines.
 826 Valid values are nil, t, `head', `last', an integer or a predicate.
 827 See the manual for details."
 828   :group 'gnus-article-treat
 829   :type gnus-article-treat-custom)
 830
 831 (defcustom gnus-treat-strip-multiple-blank-lines nil
 832   "Strip multiple blank lines.
 833 Valid values are nil, t, `head', `last', an integer or a predicate.
 834 See the manual for details."
 835   :group 'gnus-article-treat
 836   :type gnus-article-treat-custom)
 837
 838 (defcustom gnus-treat-strip-blank-lines nil
 839   "Strip all blank lines.
 840 Valid values are nil, t, `head', `last', an integer or a predicate.
 841 See the manual for details."
 842   :group 'gnus-article-treat
 843   :type gnus-article-treat-custom)
 844
 845 (defcustom gnus-treat-overstrike t
 846   "Treat overstrike highlighting.
 847 Valid values are nil, t, `head', `last', an integer or a predicate.
 848 See the manual for details."
 849   :group 'gnus-article-treat
 850   :type gnus-article-treat-custom)
 851 (put 'gnus-treat-overstrike 'highlight t)
 852
 853 (defcustom gnus-treat-display-xface (if (and gnus-xemacs (featurep 'xface))
 854                                         'head nil)
 855   "Display X-Face headers.
 856 Valid values are nil, t, `head', `last', an integer or a predicate.
 857 See the manual for details."
 858   :group 'gnus-article-treat
 859   :type gnus-article-treat-head-custom)
 860 (put 'gnus-treat-display-xface 'highlight t)
 861
 862 (defcustom gnus-treat-display-smileys (if (and gnus-xemacs
 863                                                (featurep 'xpm))
 864                                           t nil)
 865   "Display smileys.
 866 Valid values are nil, t, `head', `last', an integer or a predicate.
 867 See the manual for details."
 868   :group 'gnus-article-treat
 869   :type gnus-article-treat-custom)
 870 (put 'gnus-treat-display-smileys 'highlight t)
 871
 872 (defcustom gnus-treat-display-picons (if gnus-xemacs 'head nil)
 873   "Display picons.
 874 Valid values are nil, t, `head', `last', an integer or a predicate.
 875 See the manual for details."
 876   :group 'gnus-article-treat
 877   :type gnus-article-treat-head-custom)
 878 (put 'gnus-treat-display-picons 'highlight t)
 879
 880 (defcustom gnus-treat-capitalize-sentences nil
 881   "Capitalize sentence-starting words.
 882 Valid values are nil, t, `head', `last', an integer or a predicate.
 883 See the manual for details."
 884   :group 'gnus-article-treat
 885   :type gnus-article-treat-custom)
 886
 887 (defcustom gnus-treat-fill-long-lines nil
 888   "Fill long lines.
 889 Valid values are nil, t, `head', `last', an integer or a predicate.
 890 See the manual for details."
 891   :group 'gnus-article-treat
 892   :type gnus-article-treat-custom)
 893
 894 (defcustom gnus-treat-play-sounds nil
 895   "Play sounds.
 896 Valid values are nil, t, `head', `last', an integer or a predicate.
 897 See the manual for details."
 898   :group 'gnus-article-treat
 899   :type gnus-article-treat-custom)
 900
 901 ;;; Internal variables
 902
 903 (defvar article-goto-body-goes-to-point-min-p nil)
 904 (defvar gnus-article-wash-types nil)
 905
 906 (defvar gnus-article-mime-handle-alist-1 nil)
 907 (defvar gnus-treatment-function-alist
 908   '((gnus-treat-strip-banner gnus-article-strip-banner)
 909     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
 910     (gnus-treat-highlight-signature gnus-article-highlight-signature)
 911     (gnus-treat-buttonize gnus-article-add-buttons)
 912     (gnus-treat-fill-article gnus-article-fill-cited-article)
 913     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
 914     (gnus-treat-strip-cr gnus-article-remove-cr)
 915     (gnus-treat-emphasize gnus-article-emphasize)
 916     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
 917     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
 918     (gnus-treat-hide-signature gnus-article-hide-signature)
 919     (gnus-treat-hide-citation gnus-article-hide-citation)
 920     (gnus-treat-strip-pgp gnus-article-hide-pgp)
 921     (gnus-treat-strip-pem gnus-article-hide-pem)
 922     (gnus-treat-highlight-headers gnus-article-highlight-headers)
 923     (gnus-treat-highlight-citation gnus-article-highlight-citation)
 924     (gnus-treat-highlight-signature gnus-article-highlight-signature)
 925     (gnus-treat-date-ut gnus-article-date-ut)
 926     (gnus-treat-date-local gnus-article-date-local)
 927     (gnus-treat-date-lapsed gnus-article-date-lapsed)
 928     (gnus-treat-date-original gnus-article-date-original)
 929     (gnus-treat-date-user-defined gnus-article-date-user)
 930     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
 931     (gnus-treat-strip-trailing-blank-lines
 932      gnus-article-remove-trailing-blank-lines)
 933     (gnus-treat-strip-leading-blank-lines
 934      gnus-article-strip-leading-blank-lines)
 935     (gnus-treat-strip-multiple-blank-lines
 936      gnus-article-strip-multiple-blank-lines)
 937     (gnus-treat-strip-blank-lines gnus-article-strip-blank-lines)
 938     (gnus-treat-overstrike gnus-article-treat-overstrike)
 939     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
 940     (gnus-treat-display-xface gnus-article-display-x-face)
 941     (gnus-treat-display-smileys gnus-smiley-display)
 942     (gnus-treat-display-picons gnus-article-display-picons)
 943     (gnus-treat-play-sounds gnus-earcon-display)))
 944
 945 (defvar gnus-article-mime-handle-alist nil)
 946 (defvar article-lapsed-timer nil)
 947 (defvar gnus-article-current-summary nil)
 948
 949 (defvar gnus-article-mode-syntax-table
 950   (let ((table (copy-syntax-table text-mode-syntax-table)))
 951     (modify-syntax-entry ?- "w" table)
 952     (modify-syntax-entry ?> ")" table)
 953     (modify-syntax-entry ?< "(" table)
 954     table)
 955   "Syntax table used in article mode buffers.
 956 Initialized from `text-mode-syntax-table.")
 957
 958 (defvar gnus-save-article-buffer nil)
 959
 960 (defvar gnus-article-mode-line-format-alist
 961   (nconc '((?w (gnus-article-wash-status) ?s)
 962            (?m (gnus-article-mime-part-status) ?s))
 963          gnus-summary-mode-line-format-alist))
 964
 965 (defvar gnus-number-of-articles-to-be-saved nil)
 966
 967 (defvar gnus-inhibit-hiding nil)
 968
 969 (defsubst gnus-article-hide-text (b e props)
 970   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
 971   (add-text-properties b e props)
 972   (when (memq 'intangible props)
 973     (put-text-property
 974      (max (1- b) (point-min))
 975      b 'intangible (cddr (memq 'intangible props)))))
 976 (defsubst gnus-article-unhide-text (b e)
 977   "Remove hidden text properties from region between B and E."
 978   (remove-text-properties b e gnus-hidden-properties)
 979   (when (memq 'intangible gnus-hidden-properties)
 980     (put-text-property (max (1- b) (point-min))
 981                        b 'intangible nil)))
 982
 983 (defun gnus-article-hide-text-type (b e type)
 984   "Hide text of TYPE between B and E."
 985   (push type gnus-article-wash-types)
 986   (gnus-article-hide-text
 987    b e (cons 'article-type (cons type gnus-hidden-properties))))
 988
 989 (defun gnus-article-unhide-text-type (b e type)
 990   "Unhide text of TYPE between B and E."
 991   (setq gnus-article-wash-types
 992         (delq type gnus-article-wash-types))
 993   (remove-text-properties
 994    b e (cons 'article-type (cons type gnus-hidden-properties)))
 995   (when (memq 'intangible gnus-hidden-properties)
 996     (put-text-property (max (1- b) (point-min))
 997                        b 'intangible nil)))
 998
 999 (defun gnus-article-hide-text-of-type (type)
1000   "Hide text of TYPE in the current buffer."
1001   (save-excursion
1002     (let ((b (point-min))
1003           (e (point-max)))
1004       (while (setq b (text-property-any b e 'article-type type))
1005         (add-text-properties b (incf b) gnus-hidden-properties)))))
1006
1007 (defun gnus-article-delete-text-of-type (type)
1008   "Delete text of TYPE in the current buffer."
1009   (save-excursion
1010     (let ((b (point-min)))
1011       (while (setq b (text-property-any b (point-max) 'article-type type))
1012         (delete-region
1013          b (or (text-property-not-all b (point-max) 'article-type type)
1014                (point-max)))))))
1015
1016 (defun gnus-article-delete-invisible-text ()
1017   "Delete all invisible text in the current buffer."
1018   (save-excursion
1019     (let ((b (point-min)))
1020       (while (setq b (text-property-any b (point-max) 'invisible t))
1021         (delete-region
1022          b (or (text-property-not-all b (point-max) 'invisible t)
1023                (point-max)))))))
1024
1025 (defun gnus-article-text-type-exists-p (type)
1026   "Say whether any text of type TYPE exists in the buffer."
1027   (text-property-any (point-min) (point-max) 'article-type type))
1028
1029 (defsubst gnus-article-header-rank ()
1030   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1031   (let ((list gnus-sorted-header-list)
1032         (i 0))
1033     (while list
1034       (when (looking-at (car list))
1035         (setq list nil))
1036       (setq list (cdr list))
1037       (incf i))
1038     i))
1039
1040 (defun article-hide-headers (&optional arg delete)
1041   "Hide unwanted headers and possibly sort them as well."
1042   (interactive (gnus-article-hidden-arg))
1043   ;; Lars said that this function might be inhibited.
1044   (if (gnus-article-check-hidden-text 'headers arg)
1045       ;; Show boring headers as well.
1046       (progn
1047         (gnus-article-show-hidden-text 'boring-headers)
1048         (when (eq 1 (point-min))
1049           (set-window-start (get-buffer-window (current-buffer)) 1)))
1050   (unless gnus-inhibit-hiding
1051     (save-excursion
1052       (save-restriction
1053         (let ((buffer-read-only nil)
1054               (case-fold-search t)
1055               (max (1+ (length gnus-sorted-header-list)))
1056               (ignored (when (not gnus-visible-headers)
1057                          (cond ((stringp gnus-ignored-headers)
1058                                 gnus-ignored-headers)
1059                                ((listp gnus-ignored-headers)
1060                                 (mapconcat 'identity gnus-ignored-headers
1061                                            "\\|")))))
1062               (visible
1063                (cond ((stringp gnus-visible-headers)
1064                       gnus-visible-headers)
1065                      ((and gnus-visible-headers
1066                            (listp gnus-visible-headers))
1067                       (mapconcat 'identity gnus-visible-headers "\\|"))))
1068               (inhibit-point-motion-hooks t)
1069               beg)
1070           ;; First we narrow to just the headers.
1071           (article-narrow-to-head)
1072           ;; Hide any "From " lines at the beginning of (mail) articles.
1073           (while (looking-at "From ")
1074             (forward-line 1))
1075           (unless (bobp)
1076             (if delete
1077                 (delete-region (point-min) (point))
1078               (gnus-article-hide-text (point-min) (point)
1079                                       (nconc (list 'article-type 'headers)
1080                                              gnus-hidden-properties))))
1081           ;; Then treat the rest of the header lines.
1082           ;; Then we use the two regular expressions
1083           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1084           ;; select which header lines is to remain visible in the
1085           ;; article buffer.
1086           (while (re-search-forward "^[^ \t]*:" nil t)
1087             (beginning-of-line)
1088             ;; Mark the rank of the header.
1089             (put-text-property
1090              (point) (1+ (point)) 'message-rank
1091              (if (or (and visible (looking-at visible))
1092                      (and ignored
1093                           (not (looking-at ignored))))
1094                  (gnus-article-header-rank)
1095                (+ 2 max)))
1096             (forward-line 1))
1097           (message-sort-headers-1)
1098           (when (setq beg (text-property-any
1099                            (point-min) (point-max) 'message-rank (+ 2 max)))
1100             ;; We delete or make invisible the unwanted headers.
1101             (if delete
1102                 (progn
1103                   (add-text-properties
1104                    (point-min) (+ 5 (point-min))
1105                    '(article-type headers dummy-invisible t))
1106                   (delete-region beg (point-max)))
1107               (gnus-article-hide-text-type beg (point-max) 'headers))))))))
1108   )
1109
1110 (defun article-hide-boring-headers (&optional arg)
1111   "Toggle hiding of headers that aren't very interesting.
1112 If given a negative prefix, always show; if given a positive prefix,
1113 always hide."
1114   (interactive (gnus-article-hidden-arg))
1115   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1116              (not gnus-show-all-headers))
1117     (save-excursion
1118       (save-restriction
1119         (let ((buffer-read-only nil)
1120               (list gnus-boring-article-headers)
1121               (inhibit-point-motion-hooks t)
1122               elem)
1123           (article-narrow-to-head)
1124           (while list
1125             (setq elem (pop list))
1126             (goto-char (point-min))
1127             (cond
1128              ;; Hide empty headers.
1129              ((eq elem 'empty)
1130               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1131                 (forward-line -1)
1132                 (gnus-article-hide-text-type
1133                  (progn (beginning-of-line) (point))
1134                  (progn
1135                    (end-of-line)
1136                    (if (re-search-forward "^[^ \t]" nil t)
1137                        (match-beginning 0)
1138                      (point-max)))
1139                  'boring-headers)))
1140              ;; Hide boring Newsgroups header.
1141              ((eq elem 'newsgroups)
1142               (when (equal (gnus-fetch-field "newsgroups")
1143                            (gnus-group-real-name
1144                             (if (boundp 'gnus-newsgroup-name)
1145                                 gnus-newsgroup-name
1146                               "")))
1147                 (gnus-article-hide-header "newsgroups")))
1148              ((eq elem 'followup-to)
1149               (when (equal (message-fetch-field "followup-to")
1150                            (message-fetch-field "newsgroups"))
1151                 (gnus-article-hide-header "followup-to")))
1152              ((eq elem 'reply-to)
1153               (let ((from (message-fetch-field "from"))
1154                     (reply-to (message-fetch-field "reply-to")))
1155                 (when (and
1156                        from reply-to
1157                        (ignore-errors
1158                          (equal
1159                           (nth 1 (funcall gnus-extract-address-components from))
1160                           (nth 1 (funcall gnus-extract-address-components reply-to)))))
1161                   (gnus-article-hide-header "reply-to"))))
1162              ((eq elem 'date)
1163               (let ((date (message-fetch-field "date")))
1164                 (when (and date
1165                            (< (days-between (current-time-string) date)
1166                               4))
1167                   (gnus-article-hide-header "date"))))
1168              ((eq elem 'long-to)
1169               (let ((to (message-fetch-field "to")))
1170                 (when (> (length to) 1024)
1171                   (gnus-article-hide-header "to"))))
1172              ((eq elem 'many-to)
1173               (let ((to-count 0))
1174                 (goto-char (point-min))
1175                 (while (re-search-forward "^to:" nil t)
1176                   (setq to-count (1+ to-count)))
1177                 (when (> to-count 1)
1178                   (while (> to-count 0)
1179                     (goto-char (point-min))
1180                     (save-restriction
1181                       (re-search-forward "^to:" nil nil to-count)
1182                       (forward-line -1)
1183                       (narrow-to-region (point) (point-max))
1184                       (gnus-article-hide-header "to"))
1185                     (setq to-count (1- to-count)))))))))))))
1186
1187 (defun gnus-article-hide-header (header)
1188   (save-excursion
1189     (goto-char (point-min))
1190     (when (re-search-forward (concat "^" header ":") nil t)
1191       (gnus-article-hide-text-type
1192        (progn (beginning-of-line) (point))
1193        (progn
1194          (end-of-line)
1195          (if (re-search-forward "^[^ \t]" nil t)
1196              (match-beginning 0)
1197            (point-max)))
1198        'boring-headers))))
1199
1200 (defvar gnus-article-normalized-header-length 40
1201   "Length of normalized headers.")
1202
1203 (defun article-normalize-headers ()
1204   "Make all header lines 40 characters long."
1205   (interactive)
1206   (let ((buffer-read-only nil)
1207         column)
1208     (save-excursion
1209       (save-restriction
1210         (article-narrow-to-head)
1211         (while (not (eobp))
1212           (cond
1213            ((< (setq column (- (gnus-point-at-eol) (point)))
1214                gnus-article-normalized-header-length)
1215             (end-of-line)
1216             (insert (make-string
1217                      (- gnus-article-normalized-header-length column)
1218                      ? )))
1219            ((> column gnus-article-normalized-header-length)
1220             (gnus-put-text-property
1221              (progn
1222                (forward-char gnus-article-normalized-header-length)
1223                (point))
1224              (gnus-point-at-eol)
1225              'invisible t))
1226            (t
1227             ;; Do nothing.
1228             ))
1229           (forward-line 1))))))
1230
1231 (defun article-treat-dumbquotes ()
1232   "Translate M******** sm*rtq**t*s into proper text.
1233 Note that this function guesses whether a character is a sm*rtq**t* or
1234 not, so it should only be used interactively."
1235   (interactive)
1236   (article-translate-strings gnus-article-dumbquotes-map))
1237
1238 (defun article-translate-characters (from to)
1239   "Translate all characters in the body of the article according to FROM and TO.
1240 FROM is a string of characters to translate from; to is a string of
1241 characters to translate to."
1242   (save-excursion
1243     (when (article-goto-body)
1244       (let ((buffer-read-only nil)
1245             (x (make-string 225 ?x))
1246             (i -1))
1247         (while (< (incf i) (length x))
1248           (aset x i i))
1249         (setq i 0)
1250         (while (< i (length from))
1251           (aset x (aref from i) (aref to i))
1252           (incf i))
1253         (translate-region (point) (point-max) x)))))
1254
1255 (defun article-translate-strings (map)
1256   "Translate all string in the body of the article according to MAP.
1257 MAP is an alist where the elements are on the form (\"from\" \"to\")."
1258   (save-excursion
1259     (when (article-goto-body)
1260       (let ((buffer-read-only nil)
1261             elem)
1262         (while (setq elem (pop map))
1263           (save-excursion
1264             (while (search-forward (car elem) nil t)
1265               (replace-match (cadr elem)))))))))
1266
1267 (defun article-treat-overstrike ()
1268   "Translate overstrikes into bold text."
1269   (interactive)
1270   (save-excursion
1271     (when (article-goto-body)
1272       (let ((buffer-read-only nil))
1273         (while (search-forward "\b" nil t)
1274           (let ((next (char-after))
1275                 (previous (char-after (- (point) 2))))
1276             ;; We do the boldification/underlining by hiding the
1277             ;; overstrikes and putting the proper text property
1278             ;; on the letters.
1279             (cond
1280              ((eq next previous)
1281               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
1282               (put-text-property (point) (1+ (point)) 'face 'bold))
1283              ((eq next ?_)
1284               (gnus-article-hide-text-type
1285                (1- (point)) (1+ (point)) 'overstrike)
1286               (put-text-property
1287                (- (point) 2) (1- (point)) 'face 'underline))
1288              ((eq previous ?_)
1289               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
1290               (put-text-property
1291                (point) (1+ (point)) 'face 'underline)))))))))
1292
1293 (defun article-fill-long-lines ()
1294   "Fill lines that are wider than the window width."
1295   (interactive)
1296   (save-excursion
1297     (let ((buffer-read-only nil)
1298           (width (window-width (get-buffer-window (current-buffer)))))
1299       (save-restriction
1300         (article-goto-body)
1301         (let ((adaptive-fill-mode nil))
1302           (while (not (eobp))
1303             (end-of-line)
1304             (when (>= (current-column) (min fill-column width))
1305               (narrow-to-region (point) (gnus-point-at-bol))
1306               (fill-paragraph nil)
1307               (goto-char (point-max))
1308               (widen))
1309             (forward-line 1)))))))
1310
1311 (defun article-capitalize-sentences ()
1312   "Capitalize the first word in each sentence."
1313   (interactive)
1314   (save-excursion
1315     (let ((buffer-read-only nil)
1316           (paragraph-start "^[\n\^L]"))
1317       (article-goto-body)
1318       (while (not (eobp))
1319         (capitalize-word 1)
1320         (forward-sentence)))))
1321
1322 (defun article-remove-cr ()
1323   "Remove trailing CRs and then translate remaining CRs into LFs."
1324   (interactive)
1325   (save-excursion
1326     (let ((buffer-read-only nil))
1327       (goto-char (point-min))
1328       (while (re-search-forward "\r+$" nil t)
1329         (replace-match "" t t))
1330       (goto-char (point-min))
1331       (while (search-forward "\r" nil t)
1332         (replace-match "\n" t t)))))
1333
1334 (defun article-remove-trailing-blank-lines ()
1335   "Remove all trailing blank lines from the article."
1336   (interactive)
1337   (save-excursion
1338     (let ((buffer-read-only nil))
1339       (goto-char (point-max))
1340       (delete-region
1341        (point)
1342        (progn
1343          (while (and (not (bobp))
1344                      (looking-at "^[ \t]*$")
1345                      (not (gnus-annotation-in-region-p
1346                            (point) (gnus-point-at-eol))))
1347            (forward-line -1))
1348          (forward-line 1)
1349          (point))))))
1350
1351 (defun article-display-x-face (&optional force)
1352   "Look for an X-Face header and display it if present."
1353   (interactive (list 'force))
1354   (save-excursion
1355     ;; Delete the old process, if any.
1356     (when (process-status "article-x-face")
1357       (delete-process "article-x-face"))
1358     (let ((inhibit-point-motion-hooks t)
1359           (case-fold-search t)
1360           from last)
1361       (save-restriction
1362         (article-narrow-to-head)
1363         (goto-char (point-min))
1364         (setq from (message-fetch-field "from"))
1365         (goto-char (point-min))
1366         (while (and gnus-article-x-face-command
1367                     (not last)
1368                     (or force
1369                         ;; Check whether this face is censored.
1370                         (not gnus-article-x-face-too-ugly)
1371                         (and gnus-article-x-face-too-ugly from
1372                              (not (string-match gnus-article-x-face-too-ugly
1373                                                 from))))
1374                     ;; Has to be present.
1375                     (re-search-forward "^X-Face: " nil t))
1376           ;; This used to try to do multiple faces (`while' instead of
1377           ;; `when' above), but (a) sending multiple EOFs to xv doesn't
1378           ;; work (b) it can crash some versions of Emacs (c) are
1379           ;; multiple faces really something to encourage?
1380           (when (stringp gnus-article-x-face-command)
1381             (setq last t))
1382           ;; We now have the area of the buffer where the X-Face is stored.
1383           (save-excursion
1384             (let ((beg (point))
1385                   (end (1- (re-search-forward "^\\($\\|[^ \t]\\)" nil t))))
1386               ;; We display the face.
1387               (if (symbolp gnus-article-x-face-command)
1388                   ;; The command is a lisp function, so we call it.
1389                   (if (gnus-functionp gnus-article-x-face-command)
1390                       (funcall gnus-article-x-face-command beg end)
1391                     (error "%s is not a function" gnus-article-x-face-command))
1392                 ;; The command is a string, so we interpret the command
1393                 ;; as a, well, command, and fork it off.
1394                 (let ((process-connection-type nil))
1395                   (process-kill-without-query
1396                    (start-process
1397                     "article-x-face" nil shell-file-name shell-command-switch
1398                     gnus-article-x-face-command))
1399                   (process-send-region "article-x-face" beg end)
1400                   (process-send-eof "article-x-face"))))))))))
1401
1402 (defun article-decode-mime-words ()
1403   "Decode all MIME-encoded words in the article."
1404   (interactive)
1405   (save-excursion
1406     (set-buffer gnus-article-buffer)
1407     (let ((inhibit-point-motion-hooks t)
1408           buffer-read-only
1409           (mail-parse-charset gnus-newsgroup-charset))
1410       (mail-decode-encoded-word-region (point-min) (point-max)))))
1411
1412 (defun article-decode-charset (&optional prompt)
1413   "Decode charset-encoded text in the article.
1414 If PROMPT (the prefix), prompt for a coding system to use."
1415   (interactive "P")
1416   (save-excursion
1417     (save-restriction
1418       (article-narrow-to-head)
1419       (let* ((inhibit-point-motion-hooks t)
1420              (case-fold-search t)
1421              (ct (message-fetch-field "Content-Type" t))
1422              (cte (message-fetch-field "Content-Transfer-Encoding" t))
1423              (ctl (and ct (ignore-errors
1424                             (mail-header-parse-content-type ct))))
1425              (charset (cond
1426                        (prompt
1427                         (mm-read-coding-system "Charset to decode: "))
1428                        (ctl
1429                         (mail-content-type-get ctl 'charset))))
1430              (mail-parse-charset gnus-newsgroup-charset)
1431              buffer-read-only)
1432         (when (memq charset gnus-newsgroup-ignored-charsets)
1433           (setq charset nil))
1434         (goto-char (point-max))
1435         (widen)
1436         (forward-line 1)
1437         (narrow-to-region (point) (point-max))
1438         (when (and (or (not ctl)
1439                        (equal (car ctl) "text/plain"))
1440                    (not (mm-uu-test)))
1441           (mm-decode-body
1442            charset (and cte (intern (downcase
1443                                      (gnus-strip-whitespace cte))))
1444            (car ctl)))))))
1445
1446 (defun article-decode-encoded-words ()
1447   "Remove encoded-word encoding from headers."
1448   (let (buffer-read-only)
1449     (let ((charset (save-excursion
1450                      (set-buffer gnus-summary-buffer)
1451                      default-mime-charset)))
1452       (mime-decode-header-in-buffer charset)
1453       )))
1454
1455 (defun article-de-quoted-unreadable (&optional force)
1456   "Translate a quoted-printable-encoded article.
1457 If FORCE, decode the article whether it is marked as quoted-printable
1458 or not."
1459   (interactive (list 'force))
1460   (save-excursion
1461     (let ((buffer-read-only nil)
1462           (type (gnus-fetch-field "content-transfer-encoding"))
1463           (charset gnus-newsgroup-charset))
1464       (when (or force
1465                 (and type (string-match "quoted-printable" (downcase type))))
1466         (article-goto-body)
1467         (save-restriction
1468           (narrow-to-region (point) (point-max))
1469           (quoted-printable-decode-region (point-min) (point-max))
1470           (when charset
1471             (mm-decode-body charset)))))))
1472
1473 (defun article-hide-pgp ()
1474   "Remove any PGP headers and signatures in the current article."
1475   (interactive)
1476   (save-excursion
1477     (save-restriction
1478       (let ((inhibit-point-motion-hooks t)
1479             buffer-read-only beg end)
1480         (article-goto-body)
1481         ;; Hide the "header".
1482         (when (re-search-forward "^-----BEGIN PGP SIGNED MESSAGE-----\n" nil t)
1483           (push 'pgp gnus-article-wash-types)
1484           (delete-region (match-beginning 0) (match-end 0))
1485           ;; PGP 5 and GNU PG add a `Hash: <>' comment, hide that too
1486           (when (looking-at "Hash:.*$")
1487             (delete-region (point) (1+ (gnus-point-at-eol))))
1488           (setq beg (point))
1489           ;; Hide the actual signature.
1490           (and (search-forward "\n-----BEGIN PGP SIGNATURE-----\n" nil t)
1491                (setq end (1+ (match-beginning 0)))
1492                (delete-region
1493                 end
1494                 (if (search-forward "\n-----END PGP SIGNATURE-----\n" nil t)
1495                     (match-end 0)
1496                   ;; Perhaps we shouldn't hide to the end of the buffer
1497                   ;; if there is no end to the signature?
1498                   (point-max))))
1499           ;; Hide "- " PGP quotation markers.
1500           (when (and beg end)
1501             (narrow-to-region beg end)
1502             (goto-char (point-min))
1503             (while (re-search-forward "^- " nil t)
1504               (delete-region
1505                (match-beginning 0) (match-end 0)))
1506             (widen))
1507           (gnus-run-hooks 'gnus-article-hide-pgp-hook))))))
1508
1509 (defun article-hide-pem (&optional arg)
1510   "Toggle hiding of any PEM headers and signatures in the current article.
1511 If given a negative prefix, always show; if given a positive prefix,
1512 always hide."
1513   (interactive (gnus-article-hidden-arg))
1514   (unless (gnus-article-check-hidden-text 'pem arg)
1515     (save-excursion
1516       (let (buffer-read-only end)
1517         (goto-char (point-min))
1518         ;; Hide the horrendously ugly "header".
1519         (when (and (search-forward
1520                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
1521                     nil t)
1522                    (setq end (1+ (match-beginning 0))))
1523           (push 'pem gnus-article-wash-types)
1524           (gnus-article-hide-text-type
1525            end
1526            (if (search-forward "\n\n" nil t)
1527                (match-end 0)
1528              (point-max))
1529            'pem)
1530           ;; Hide the trailer as well
1531           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
1532                                 nil t)
1533             (gnus-article-hide-text-type
1534              (match-beginning 0) (match-end 0) 'pem)))))))
1535
1536 (defun article-strip-banner ()
1537   "Strip the banner specified by the `banner' group parameter."
1538   (interactive)
1539   (save-excursion
1540     (save-restriction
1541       (let ((inhibit-point-motion-hooks t)
1542             (banner (gnus-group-get-parameter gnus-newsgroup-name 'banner))
1543             (gnus-signature-limit nil)
1544             buffer-read-only beg end)
1545         (when banner
1546           (article-goto-body)
1547           (cond
1548            ((eq banner 'signature)
1549             (when (gnus-article-narrow-to-signature)
1550               (widen)
1551               (forward-line -1)
1552               (delete-region (point) (point-max))))
1553            ((stringp banner)
1554             (while (re-search-forward banner nil t)
1555               (delete-region (match-beginning 0) (match-end 0))))))))))
1556
1557 (defun article-hide-signature (&optional arg)
1558   "Hide the signature in the current article.
1559 If given a negative prefix, always show; if given a positive prefix,
1560 always hide."
1561   (interactive (gnus-article-hidden-arg))
1562   (unless (gnus-article-check-hidden-text 'signature arg)
1563     (save-excursion
1564       (save-restriction
1565         (let ((buffer-read-only nil))
1566           (when (gnus-article-narrow-to-signature)
1567             (gnus-article-hide-text-type
1568              (point-min) (point-max) 'signature)))))))
1569
1570 (defun article-strip-headers-in-body ()
1571   "Strip offensive headers from bodies."
1572   (interactive)
1573   (save-excursion
1574     (article-goto-body)
1575     (let ((case-fold-search t))
1576       (when (looking-at "x-no-archive:")
1577         (gnus-delete-line)))))
1578
1579 (defun article-strip-leading-blank-lines ()
1580   "Remove all blank lines from the beginning of the article."
1581   (interactive)
1582   (save-excursion
1583     (let ((inhibit-point-motion-hooks t)
1584           buffer-read-only)
1585       (when (article-goto-body)
1586         (while (and (not (eobp))
1587                     (looking-at "[ \t]*$"))
1588           (gnus-delete-line))))))
1589
1590 (defun article-narrow-to-head ()
1591   "Narrow the buffer to the head of the message.
1592 Point is left at the beginning of the narrowed-to region."
1593   (narrow-to-region
1594    (goto-char (point-min))
1595    (if (search-forward "\n\n" nil 1)
1596        (1- (point))
1597      (point-max)))
1598   (goto-char (point-min)))
1599
1600 (defun article-goto-body ()
1601   "Place point at the start of the body."
1602   (goto-char (point-min))
1603   (cond
1604    ;; This variable is only bound when dealing with separate
1605    ;; MIME body parts.
1606    (article-goto-body-goes-to-point-min-p
1607     t)
1608    ((search-forward "\n\n" nil t)
1609     t)
1610    (t
1611     (goto-char (point-max))
1612     nil)))
1613
1614 (defun article-strip-multiple-blank-lines ()
1615   "Replace consecutive blank lines with one empty line."
1616   (interactive)
1617   (save-excursion
1618     (let ((inhibit-point-motion-hooks t)
1619           buffer-read-only)
1620       ;; First make all blank lines empty.
1621       (article-goto-body)
1622       (while (re-search-forward "^[ \t]+$" nil t)
1623         (unless (gnus-annotation-in-region-p
1624                  (match-beginning 0) (match-end 0))
1625           (replace-match "" nil t)))
1626       ;; Then replace multiple empty lines with a single empty line.
1627       (article-goto-body)
1628       (while (re-search-forward "\n\n\n+" nil t)
1629         (unless (gnus-annotation-in-region-p
1630                  (match-beginning 0) (match-end 0))
1631           (replace-match "\n\n" t t))))))
1632
1633 (defun article-strip-leading-space ()
1634   "Remove all white space from the beginning of the lines in the article."
1635   (interactive)
1636   (save-excursion
1637     (let ((inhibit-point-motion-hooks t)
1638           buffer-read-only)
1639       (article-goto-body)
1640       (while (re-search-forward "^[ \t]+" nil t)
1641         (replace-match "" t t)))))
1642
1643 (defun article-strip-trailing-space ()
1644   "Remove all white space from the end of the lines in the article."
1645   (interactive)
1646   (save-excursion
1647     (let ((inhibit-point-motion-hooks t)
1648           buffer-read-only)
1649       (article-goto-body)
1650       (while (re-search-forward "[ \t]+$" nil t)
1651         (replace-match "" t t)))))
1652
1653 (defun article-strip-blank-lines ()
1654   "Strip leading, trailing and multiple blank lines."
1655   (interactive)
1656   (article-strip-leading-blank-lines)
1657   (article-remove-trailing-blank-lines)
1658   (article-strip-multiple-blank-lines))
1659
1660 (defun article-strip-all-blank-lines ()
1661   "Strip all blank lines."
1662   (interactive)
1663   (save-excursion
1664     (let ((inhibit-point-motion-hooks t)
1665           buffer-read-only)
1666       (article-goto-body)
1667       (while (re-search-forward "^[ \t]*\n" nil t)
1668         (replace-match "" t t)))))
1669
1670 (defun gnus-article-narrow-to-signature ()
1671   "Narrow to the signature; return t if a signature is found, else nil."
1672   (let ((inhibit-point-motion-hooks t))
1673     (when (gnus-article-search-signature)
1674       (forward-line 1)
1675       ;; Check whether we have some limits to what we consider
1676       ;; to be a signature.
1677       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
1678                       (list gnus-signature-limit)))
1679             limit limited)
1680         (while (setq limit (pop limits))
1681           (if (or (and (integerp limit)
1682                        (< (- (point-max) (point)) limit))
1683                   (and (floatp limit)
1684                        (< (count-lines (point) (point-max)) limit))
1685                   (and (gnus-functionp limit)
1686                        (funcall limit))
1687                   (and (stringp limit)
1688                        (not (re-search-forward limit nil t))))
1689               ()                        ; This limit did not succeed.
1690             (setq limited t
1691                   limits nil)))
1692         (unless limited
1693           (narrow-to-region (point) (point-max))
1694           t)))))
1695
1696 (defun gnus-article-search-signature ()
1697   "Search the current buffer for the signature separator.
1698 Put point at the beginning of the signature separator."
1699   (let ((cur (point)))
1700     (goto-char (point-max))
1701     (if (if (stringp gnus-signature-separator)
1702             (re-search-backward gnus-signature-separator nil t)
1703           (let ((seps gnus-signature-separator))
1704             (while (and seps
1705                         (not (re-search-backward (car seps) nil t)))
1706               (pop seps))
1707             seps))
1708         t
1709       (goto-char cur)
1710       nil)))
1711
1712 (defun gnus-article-hidden-arg ()
1713   "Return the current prefix arg as a number, or 0 if no prefix."
1714   (list (if current-prefix-arg
1715             (prefix-numeric-value current-prefix-arg)
1716           0)))
1717
1718 (defun gnus-article-check-hidden-text (type arg)
1719   "Return nil if hiding is necessary.
1720 Arg can be nil or a number.  Nil and positive means hide, negative
1721 means show, 0 means toggle."
1722   (save-excursion
1723     (save-restriction
1724       (let ((hide (gnus-article-hidden-text-p type)))
1725         (cond
1726          ((or (null arg)
1727               (> arg 0))
1728           nil)
1729          ((< arg 0)
1730           (gnus-article-show-hidden-text type))
1731          (t
1732           (if (eq hide 'hidden)
1733               (gnus-article-show-hidden-text type)
1734             nil)))))))
1735
1736 (defun gnus-article-hidden-text-p (type)
1737   "Say whether the current buffer contains hidden text of type TYPE."
1738   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
1739     (while (and pos
1740                 (not (get-text-property pos 'invisible))
1741                 (not (get-text-property pos 'dummy-invisible)))
1742       (setq pos
1743             (text-property-any (1+ pos) (point-max) 'article-type type)))
1744     (if pos
1745         'hidden
1746       nil)))
1747
1748 (defun gnus-article-show-hidden-text (type &optional hide)
1749   "Show all hidden text of type TYPE.
1750 If HIDE, hide the text instead."
1751   (save-excursion
1752     (let ((buffer-read-only nil)
1753           (inhibit-point-motion-hooks t)
1754           (end (point-min))
1755           beg)
1756       (while (setq beg (text-property-any end (point-max) 'article-type type))
1757         (goto-char beg)
1758         (setq end (or
1759                    (text-property-not-all beg (point-max) 'article-type type)
1760                    (point-max)))
1761         (if hide
1762             (gnus-article-hide-text beg end gnus-hidden-properties)
1763           (gnus-article-unhide-text beg end))
1764         (goto-char end))
1765       t)))
1766
1767 (defconst article-time-units
1768   `((year . ,(* 365.25 24 60 60))
1769     (week . ,(* 7 24 60 60))
1770     (day . ,(* 24 60 60))
1771     (hour . ,(* 60 60))
1772     (minute . 60)
1773     (second . 1))
1774   "Mapping from time units to seconds.")
1775
1776 (defun article-date-ut (&optional type highlight header)
1777   "Convert DATE date to universal time in the current article.
1778 If TYPE is `local', convert to local time; if it is `lapsed', output
1779 how much time has lapsed since DATE. For `lapsed', the value of
1780 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
1781 should replace the \"Date:\" one, or should be added below it."
1782   (interactive (list 'ut t))
1783   (let* ((header (or header
1784                      (mail-header-date (save-excursion
1785                                          (set-buffer gnus-summary-buffer)
1786                                          gnus-current-headers))
1787                      (message-fetch-field "date")
1788                      ""))
1789          (tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
1790          (date-regexp
1791           (cond
1792            ((not gnus-article-date-lapsed-new-header)
1793             tdate-regexp)
1794            ((eq type 'lapsed)
1795             "^X-Sent:[ \t]")
1796            (t
1797             "^Date:[ \t]")))
1798          (date (if (vectorp header) (mail-header-date header)
1799                  header))
1800          (inhibit-point-motion-hooks t)
1801          (newline t)
1802          bface eface)
1803     (when (and date (not (string= date "")))
1804       (save-excursion
1805         (save-restriction
1806           (article-narrow-to-head)
1807           (when (re-search-forward tdate-regexp nil t)
1808             (setq bface (get-text-property (gnus-point-at-bol) 'face)
1809                   eface (get-text-property (1- (gnus-point-at-eol))
1810                                            'face))
1811             (forward-line 1))
1812           (goto-char (point-min))
1813           (let ((buffer-read-only nil))
1814             ;; Delete any old Date headers.
1815             (while (re-search-forward date-regexp nil t)
1816               (if newline
1817                   (delete-region (progn (beginning-of-line) (point))
1818                                  (progn (end-of-line) (point)))
1819                 (delete-region (progn (beginning-of-line) (point))
1820                                (progn (forward-line 1) (point))))
1821               (setq newline nil))
1822             (insert (article-make-date-line date type))
1823             (when newline
1824               (insert "\n")
1825               (forward-line -1))
1826             ;; Do highlighting.
1827             (beginning-of-line)
1828             (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
1829               (put-text-property (match-beginning 1) (1+ (match-end 1))
1830                                  'face bface)
1831               (put-text-property (match-beginning 2) (match-end 2)
1832                                  'face eface))))))))
1833
1834 (defun article-make-date-line (date type)
1835   "Return a DATE line of TYPE."
1836   (let ((time (condition-case ()
1837                   (date-to-time date)
1838                 (error '(0 0)))))
1839     (cond
1840      ;; Convert to the local timezone.  We have to slap a
1841      ;; `condition-case' round the calls to the timezone
1842      ;; functions since they aren't particularly resistant to
1843      ;; buggy dates.
1844      ((eq type 'local)
1845       (let ((tz (car (current-time-zone))))
1846         (format "Date: %s %s%04d" (current-time-string time)
1847                 (if (> tz 0) "+" "-") (abs (/ tz 36)))))
1848      ;; Convert to Universal Time.
1849      ((eq type 'ut)
1850       (concat "Date: "
1851               (current-time-string
1852                (let* ((e (parse-time-string date))
1853                      (tm (apply 'encode-time e))
1854                      (ms (car tm))
1855                      (ls (- (cadr tm) (car (current-time-zone)))))
1856                  (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
1857                        ((> ls 65535) (list (1+ ms) (- ls 65536)))
1858                        (t (list ms ls)))))
1859               " UT"))
1860      ;; Get the original date from the article.
1861      ((eq type 'original)
1862       (concat "Date: " (if (string-match "\n+$" date)
1863                            (substring date 0 (match-beginning 0))
1864                          date)))
1865      ;; Let the user define the format.
1866      ((eq type 'user)
1867       (if (gnus-functionp gnus-article-time-format)
1868           (funcall gnus-article-time-format time)
1869         (concat
1870          "Date: "
1871          (format-time-string gnus-article-time-format time))))
1872      ;; ISO 8601.
1873      ((eq type 'iso8601)
1874       (concat
1875        "Date: "
1876        (format-time-string "%Y%m%dT%H%M%S" time)))
1877      ;; Do an X-Sent lapsed format.
1878      ((eq type 'lapsed)
1879       ;; If the date is seriously mangled, the timezone functions are
1880       ;; liable to bug out, so we ignore all errors.
1881       (let* ((now (current-time))
1882              (real-time (subtract-time now time))
1883              (real-sec (and real-time
1884                             (+ (* (float (car real-time)) 65536)
1885                                (cadr real-time))))
1886              (sec (and real-time (abs real-sec)))
1887              num prev)
1888         (cond
1889          ((null real-time)
1890           "X-Sent: Unknown")
1891          ((zerop sec)
1892           "X-Sent: Now")
1893          (t
1894           (concat
1895            "X-Sent: "
1896            ;; This is a bit convoluted, but basically we go
1897            ;; through the time units for years, weeks, etc,
1898            ;; and divide things to see whether that results
1899            ;; in positive answers.
1900            (mapconcat
1901             (lambda (unit)
1902               (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
1903                   ;; The (remaining) seconds are too few to
1904                   ;; be divided into this time unit.
1905                   ""
1906                 ;; It's big enough, so we output it.
1907                 (setq sec (- sec (* num (cdr unit))))
1908                 (prog1
1909                     (concat (if prev ", " "") (int-to-string
1910                                                (floor num))
1911                             " " (symbol-name (car unit))
1912                             (if (> num 1) "s" ""))
1913                   (setq prev t))))
1914             article-time-units "")
1915            ;; If dates are odd, then it might appear like the
1916            ;; article was sent in the future.
1917            (if (> real-sec 0)
1918                " ago"
1919              " in the future"))))))
1920      (t
1921       (error "Unknown conversion type: %s" type)))))
1922
1923 (defun article-date-local (&optional highlight)
1924   "Convert the current article date to the local timezone."
1925   (interactive (list t))
1926   (article-date-ut 'local highlight))
1927
1928 (defun article-date-original (&optional highlight)
1929   "Convert the current article date to what it was originally.
1930 This is only useful if you have used some other date conversion
1931 function and want to see what the date was before converting."
1932   (interactive (list t))
1933   (article-date-ut 'original highlight))
1934
1935 (defun article-date-lapsed (&optional highlight)
1936   "Convert the current article date to time lapsed since it was sent."
1937   (interactive (list t))
1938   (article-date-ut 'lapsed highlight))
1939
1940 (defun article-update-date-lapsed ()
1941   "Function to be run from a timer to update the lapsed time line."
1942   (let (deactivate-mark)
1943     (save-excursion
1944       (ignore-errors
1945         (walk-windows
1946          (lambda (w)
1947            (set-buffer (window-buffer w))
1948            (when (eq major-mode 'gnus-article-mode)
1949              (goto-char (point-min))
1950              (when (re-search-forward "^X-Sent:" nil t)
1951                (article-date-lapsed t))))
1952          nil 'visible)))))
1953
1954 (defun gnus-start-date-timer (&optional n)
1955   "Start a timer to update the X-Sent header in the article buffers.
1956 The numerical prefix says how frequently (in seconds) the function
1957 is to run."
1958   (interactive "p")
1959   (unless n
1960     (setq n 1))
1961   (gnus-stop-date-timer)
1962   (setq article-lapsed-timer
1963         (nnheader-run-at-time 1 n 'article-update-date-lapsed)))
1964
1965 (defun gnus-stop-date-timer ()
1966   "Stop the X-Sent timer."
1967   (interactive)
1968   (when article-lapsed-timer
1969     (nnheader-cancel-timer article-lapsed-timer)
1970     (setq article-lapsed-timer nil)))
1971
1972 (defun article-date-user (&optional highlight)
1973   "Convert the current article date to the user-defined format.
1974 This format is defined by the `gnus-article-time-format' variable."
1975   (interactive (list t))
1976   (article-date-ut 'user highlight))
1977
1978 (defun article-date-iso8601 (&optional highlight)
1979   "Convert the current article date to ISO8601."
1980   (interactive (list t))
1981   (article-date-ut 'iso8601 highlight))
1982
1983 (defun article-show-all ()
1984   "Show all hidden text in the article buffer."
1985   (interactive)
1986   (save-excursion
1987     (let ((buffer-read-only nil))
1988       (gnus-article-unhide-text (point-min) (point-max)))))
1989
1990 (defun article-emphasize (&optional arg)
1991   "Emphasize text according to `gnus-emphasis-alist'."
1992   (interactive (gnus-article-hidden-arg))
1993   (unless (gnus-article-check-hidden-text 'emphasis arg)
1994     (save-excursion
1995       (let ((alist gnus-emphasis-alist)
1996             (buffer-read-only nil)
1997             (props (append '(article-type emphasis)
1998                            gnus-hidden-properties))
1999             regexp elem beg invisible visible face)
2000         (article-goto-body)
2001         (setq beg (point))
2002         (while (setq elem (pop alist))
2003           (goto-char beg)
2004           (setq regexp (car elem)
2005                 invisible (nth 1 elem)
2006                 visible (nth 2 elem)
2007                 face (nth 3 elem))
2008           (while (re-search-forward regexp nil t)
2009             (when (and (match-beginning visible) (match-beginning invisible))
2010               (gnus-article-hide-text
2011                (match-beginning invisible) (match-end invisible) props)
2012               (gnus-article-unhide-text-type
2013                (match-beginning visible) (match-end visible) 'emphasis)
2014               (gnus-put-text-property-excluding-newlines
2015                (match-beginning visible) (match-end visible) 'face face)
2016               (goto-char (match-end invisible)))))))))
2017
2018 (defvar gnus-summary-article-menu)
2019 (defvar gnus-summary-post-menu)
2020
2021 ;;; Saving functions.
2022
2023 (defun gnus-article-save (save-buffer file &optional num)
2024   "Save the currently selected article."
2025   (unless gnus-save-all-headers
2026     ;; Remove headers according to `gnus-saved-headers'.
2027     (let ((gnus-visible-headers
2028            (or gnus-saved-headers gnus-visible-headers))
2029           (gnus-article-buffer save-buffer))
2030       (save-excursion
2031         (set-buffer save-buffer)
2032         (article-hide-headers 1 t))))
2033   (save-window-excursion
2034     (if (not gnus-default-article-saver)
2035         (error "No default saver is defined")
2036       ;; !!! Magic!  The saving functions all save
2037       ;; `gnus-save-article-buffer' (or so they think), but we
2038       ;; bind that variable to our save-buffer.
2039       (set-buffer gnus-article-buffer)
2040       (let* ((gnus-save-article-buffer save-buffer)
2041              (filename
2042               (cond
2043                ((not gnus-prompt-before-saving) 'default)
2044                ((eq gnus-prompt-before-saving 'always) nil)
2045                (t file)))
2046              (gnus-number-of-articles-to-be-saved
2047               (when (eq gnus-prompt-before-saving t)
2048                 num)))                  ; Magic
2049         (set-buffer gnus-article-current-summary)
2050         (funcall gnus-default-article-saver filename)))))
2051
2052 (defun gnus-read-save-file-name (prompt &optional filename
2053                                         function group headers variable)
2054   (let ((default-name
2055           (funcall function group headers (symbol-value variable)))
2056         result)
2057     (setq
2058      result
2059      (cond
2060       ((eq filename 'default)
2061        default-name)
2062       ((eq filename t)
2063        default-name)
2064       (filename filename)
2065       (t
2066        (let* ((split-name (gnus-get-split-value gnus-split-methods))
2067               (prompt
2068                (format prompt
2069                        (if (and gnus-number-of-articles-to-be-saved
2070                                 (> gnus-number-of-articles-to-be-saved 1))
2071                            (format "these %d articles"
2072                                    gnus-number-of-articles-to-be-saved)
2073                          "this article")))
2074               (file
2075                ;; Let the split methods have their say.
2076                (cond
2077                 ;; No split name was found.
2078                 ((null split-name)
2079                  (read-file-name
2080                   (concat prompt " (default "
2081                           (file-name-nondirectory default-name) ") ")
2082                   (file-name-directory default-name)
2083                   default-name))
2084                 ;; A single group name is returned.
2085                 ((stringp split-name)
2086                  (setq default-name
2087                        (funcall function split-name headers
2088                                 (symbol-value variable)))
2089                  (read-file-name
2090                   (concat prompt " (default "
2091                           (file-name-nondirectory default-name) ") ")
2092                   (file-name-directory default-name)
2093                   default-name))
2094                 ;; A single split name was found
2095                 ((= 1 (length split-name))
2096                  (let* ((name (expand-file-name
2097                                (car split-name) gnus-article-save-directory))
2098                         (dir (cond ((file-directory-p name)
2099                                     (file-name-as-directory name))
2100                                    ((file-exists-p name) name)
2101                                    (t gnus-article-save-directory))))
2102                    (read-file-name
2103                     (concat prompt " (default " name ") ")
2104                     dir name)))
2105                 ;; A list of splits was found.
2106                 (t
2107                  (setq split-name (nreverse split-name))
2108                  (let (result)
2109                    (let ((file-name-history
2110                           (nconc split-name file-name-history)))
2111                      (setq result
2112                            (expand-file-name
2113                             (read-file-name
2114                              (concat prompt " (`M-p' for defaults) ")
2115                              gnus-article-save-directory
2116                              (car split-name))
2117                             gnus-article-save-directory)))
2118                    (car (push result file-name-history)))))))
2119          ;; Create the directory.
2120          (gnus-make-directory (file-name-directory file))
2121          ;; If we have read a directory, we append the default file name.
2122          (when (file-directory-p file)
2123            (setq file (concat (file-name-as-directory file)
2124                               (file-name-nondirectory default-name))))
2125          ;; Possibly translate some characters.
2126          (nnheader-translate-file-chars file)))))
2127     (gnus-make-directory (file-name-directory result))
2128     (set variable result)))
2129
2130 (defun gnus-article-archive-name (group)
2131   "Return the first instance of an \"Archive-name\" in the current buffer."
2132   (let ((case-fold-search t))
2133     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
2134       (nnheader-concat gnus-article-save-directory
2135                        (match-string 1)))))
2136
2137 (defun gnus-article-nndoc-name (group)
2138   "If GROUP is an nndoc group, return the name of the parent group."
2139   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
2140     (gnus-group-get-parameter group 'save-article-group)))
2141
2142 (defun gnus-summary-save-in-rmail (&optional filename)
2143   "Append this article to Rmail file.
2144 Optional argument FILENAME specifies file name.
2145 Directory to save to is default to `gnus-article-save-directory'."
2146   (setq filename (gnus-read-save-file-name
2147                   "Save %s in rmail file:" filename
2148                   gnus-rmail-save-name gnus-newsgroup-name
2149                   gnus-current-headers 'gnus-newsgroup-last-rmail))
2150   (gnus-eval-in-buffer-window gnus-save-article-buffer
2151     (save-excursion
2152       (save-restriction
2153         (widen)
2154         (gnus-output-to-rmail filename))))
2155   filename)
2156
2157 (defun gnus-summary-save-in-mail (&optional filename)
2158   "Append this article to Unix mail file.
2159 Optional argument FILENAME specifies file name.
2160 Directory to save to is default to `gnus-article-save-directory'."
2161   (setq filename (gnus-read-save-file-name
2162                   "Save %s in Unix mail file:" filename
2163                   gnus-mail-save-name gnus-newsgroup-name
2164                   gnus-current-headers 'gnus-newsgroup-last-mail))
2165   (gnus-eval-in-buffer-window gnus-save-article-buffer
2166     (save-excursion
2167       (save-restriction
2168         (widen)
2169         (if (and (file-readable-p filename)
2170                  (mail-file-babyl-p filename))
2171             (rmail-output-to-rmail-file filename t)
2172           (gnus-output-to-mail filename)))))
2173   filename)
2174
2175 (defun gnus-summary-save-in-file (&optional filename overwrite)
2176   "Append this article to file.
2177 Optional argument FILENAME specifies file name.
2178 Directory to save to is default to `gnus-article-save-directory'."
2179   (setq filename (gnus-read-save-file-name
2180                   "Save %s in file:" filename
2181                   gnus-file-save-name gnus-newsgroup-name
2182                   gnus-current-headers 'gnus-newsgroup-last-file))
2183   (gnus-eval-in-buffer-window gnus-save-article-buffer
2184     (save-excursion
2185       (save-restriction
2186         (widen)
2187         (when (and overwrite
2188                    (file-exists-p filename))
2189           (delete-file filename))
2190         (gnus-output-to-file filename))))
2191   filename)
2192
2193 (defun gnus-summary-write-to-file (&optional filename)
2194   "Write this article to a file.
2195 Optional argument FILENAME specifies file name.
2196 The directory to save in defaults to `gnus-article-save-directory'."
2197   (gnus-summary-save-in-file nil t))
2198
2199 (defun gnus-summary-save-body-in-file (&optional filename)
2200   "Append this article body to a file.
2201 Optional argument FILENAME specifies file name.
2202 The directory to save in defaults to `gnus-article-save-directory'."
2203   (setq filename (gnus-read-save-file-name
2204                   "Save %s body in file:" filename
2205                   gnus-file-save-name gnus-newsgroup-name
2206                   gnus-current-headers 'gnus-newsgroup-last-file))
2207   (gnus-eval-in-buffer-window gnus-save-article-buffer
2208     (save-excursion
2209       (save-restriction
2210         (widen)
2211         (when (article-goto-body)
2212           (narrow-to-region (point) (point-max)))
2213         (gnus-output-to-file filename))))
2214   filename)
2215
2216 (defun gnus-summary-save-in-pipe (&optional command)
2217   "Pipe this article to subprocess."
2218   (setq command
2219         (cond ((and (eq command 'default)
2220                     gnus-last-shell-command)
2221                gnus-last-shell-command)
2222               (command command)
2223               (t (read-string
2224                   (format
2225                    "Shell command on %s: "
2226                    (if (and gnus-number-of-articles-to-be-saved
2227                             (> gnus-number-of-articles-to-be-saved 1))
2228                        (format "these %d articles"
2229                                gnus-number-of-articles-to-be-saved)
2230                      "this article"))
2231                   gnus-last-shell-command))))
2232   (when (string-equal command "")
2233     (setq command gnus-last-shell-command))
2234   (gnus-eval-in-buffer-window gnus-article-buffer
2235     (save-restriction
2236       (widen)
2237       (shell-command-on-region (point-min) (point-max) command nil)))
2238   (setq gnus-last-shell-command command))
2239
2240 ;;; Article file names when saving.
2241
2242 (defun gnus-capitalize-newsgroup (newsgroup)
2243   "Capitalize NEWSGROUP name."
2244   (when (not (zerop (length newsgroup)))
2245     (concat (char-to-string (upcase (aref newsgroup 0)))
2246             (substring newsgroup 1))))
2247
2248 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
2249   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2250 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
2251 Otherwise, it is like ~/News/news/group/num."
2252   (let ((default
2253           (expand-file-name
2254            (concat (if (gnus-use-long-file-name 'not-save)
2255                        (gnus-capitalize-newsgroup newsgroup)
2256                      (gnus-newsgroup-directory-form newsgroup))
2257                    "/" (int-to-string (mail-header-number headers)))
2258            gnus-article-save-directory)))
2259     (if (and last-file
2260              (string-equal (file-name-directory default)
2261                            (file-name-directory last-file))
2262              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
2263         default
2264       (or last-file default))))
2265
2266 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
2267   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2268 If variable `gnus-use-long-file-name' is non-nil, it is
2269 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
2270   (let ((default
2271           (expand-file-name
2272            (concat (if (gnus-use-long-file-name 'not-save)
2273                        newsgroup
2274                      (gnus-newsgroup-directory-form newsgroup))
2275                    "/" (int-to-string (mail-header-number headers)))
2276            gnus-article-save-directory)))
2277     (if (and last-file
2278              (string-equal (file-name-directory default)
2279                            (file-name-directory last-file))
2280              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
2281         default
2282       (or last-file default))))
2283
2284 (defun gnus-Plain-save-name (newsgroup headers &optional last-file)
2285   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2286 If variable `gnus-use-long-file-name' is non-nil, it is
2287 ~/News/News.group.  Otherwise, it is like ~/News/news/group/news."
2288   (or last-file
2289       (expand-file-name
2290        (if (gnus-use-long-file-name 'not-save)
2291            (gnus-capitalize-newsgroup newsgroup)
2292          (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
2293        gnus-article-save-directory)))
2294
2295 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
2296   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2297 If variable `gnus-use-long-file-name' is non-nil, it is
2298 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
2299   (or last-file
2300       (expand-file-name
2301        (if (gnus-use-long-file-name 'not-save)
2302            newsgroup
2303          (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
2304        gnus-article-save-directory)))
2305
2306 (eval-and-compile
2307   (mapcar
2308    (lambda (func)
2309      (let (afunc gfunc)
2310        (if (consp func)
2311            (setq afunc (car func)
2312                  gfunc (cdr func))
2313          (setq afunc func
2314                gfunc (intern (format "gnus-%s" func))))
2315        (fset gfunc
2316              (if (not (fboundp afunc))
2317                  nil
2318                `(lambda (&optional interactive &rest args)
2319                   ,(documentation afunc t)
2320                   (interactive (list t))
2321                   (save-excursion
2322                     (set-buffer gnus-article-buffer)
2323                     (if interactive
2324                         (call-interactively ',afunc)
2325                       (apply ',afunc args))))))))
2326    '(article-hide-headers
2327      article-hide-boring-headers
2328      article-treat-overstrike
2329      article-fill-long-lines
2330      article-capitalize-sentences
2331      article-remove-cr
2332      article-display-x-face
2333      article-de-quoted-unreadable
2334      article-hide-pgp
2335      article-strip-banner
2336      article-hide-pem
2337      article-hide-signature
2338      article-strip-headers-in-body
2339      article-remove-trailing-blank-lines
2340      article-strip-leading-blank-lines
2341      article-strip-multiple-blank-lines
2342      article-strip-leading-space
2343      article-strip-trailing-space
2344      article-strip-blank-lines
2345      article-strip-all-blank-lines
2346      article-date-local
2347      article-date-iso8601
2348      article-date-original
2349      article-date-ut
2350      article-decode-mime-words
2351      article-decode-charset
2352      article-decode-encoded-words
2353      article-date-user
2354      article-date-lapsed
2355      article-emphasize
2356      article-treat-dumbquotes
2357      article-normalize-headers
2358      (article-show-all . gnus-article-show-all-headers))))
2359 \f
2360 ;;;
2361 ;;; Gnus article mode
2362 ;;;
2363
2364 (put 'gnus-article-mode 'mode-class 'special)
2365
2366 (gnus-define-keys gnus-article-mode-map
2367   " " gnus-article-goto-next-page
2368   "\177" gnus-article-goto-prev-page
2369   [delete] gnus-article-goto-prev-page
2370   [backspace] gnus-article-goto-prev-page
2371   "\C-c^" gnus-article-refer-article
2372   "h" gnus-article-show-summary
2373   "s" gnus-article-show-summary
2374   "\C-c\C-m" gnus-article-mail
2375   "?" gnus-article-describe-briefly
2376   gnus-mouse-2 gnus-article-push-button
2377   "\r" gnus-article-press-button
2378   "\t" gnus-article-next-button
2379   "\M-\t" gnus-article-prev-button
2380   "e" gnus-article-edit
2381   "<" beginning-of-buffer
2382   ">" end-of-buffer
2383   "\C-c\C-i" gnus-info-find-node
2384   "\C-c\C-b" gnus-bug
2385
2386   "\C-d" gnus-article-read-summary-keys
2387   "\M-*" gnus-article-read-summary-keys
2388   "\M-#" gnus-article-read-summary-keys
2389   "\M-^" gnus-article-read-summary-keys
2390   "\M-g" gnus-article-read-summary-keys)
2391
2392 ;; Define almost undefined keys to `gnus-article-read-summary-keys'.
2393 (mapcar
2394  (lambda (key)
2395    (unless (lookup-key gnus-article-mode-map key)
2396      (define-key gnus-article-mode-map key
2397        'gnus-article-read-summary-keys)))
2398  (delq nil
2399        (append
2400         (mapcar
2401          (lambda (elt)
2402            (let ((key (car elt)))
2403              (and (> (length key) 0)
2404                   (not (eq 'menu-bar (aref key 0)))
2405                   (symbolp (lookup-key gnus-summary-mode-map key))
2406                   key)))
2407          (accessible-keymaps gnus-summary-mode-map))
2408         (let ((c 127)
2409               keys)
2410           (while (>= c 32)
2411             (push (char-to-string c) keys)
2412             (decf c))
2413           keys))))
2414
2415 (defun gnus-article-make-menu-bar ()
2416   (gnus-turn-off-edit-menu 'article)
2417   (unless (boundp 'gnus-article-article-menu)
2418     (easy-menu-define
2419      gnus-article-article-menu gnus-article-mode-map ""
2420      '("Article"
2421        ["Scroll forwards" gnus-article-goto-next-page t]
2422        ["Scroll backwards" gnus-article-goto-prev-page t]
2423        ["Show summary" gnus-article-show-summary t]
2424        ["Fetch Message-ID at point" gnus-article-refer-article t]
2425        ["Mail to address at point" gnus-article-mail t]
2426        ["Send a bug report" gnus-bug t]))
2427
2428     (easy-menu-define
2429      gnus-article-treatment-menu gnus-article-mode-map ""
2430      '("Treatment"
2431        ["Hide headers" gnus-article-hide-headers t]
2432        ["Hide signature" gnus-article-hide-signature t]
2433        ["Hide citation" gnus-article-hide-citation t]
2434        ["Treat overstrike" gnus-article-treat-overstrike t]
2435        ["Remove carriage return" gnus-article-remove-cr t]))
2436
2437     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
2438
2439     (when (boundp 'gnus-summary-post-menu)
2440       (define-key gnus-article-mode-map [menu-bar post]
2441         (cons "Post" gnus-summary-post-menu)))
2442
2443     (gnus-run-hooks 'gnus-article-menu-hook)))
2444
2445 (defun gnus-article-mode ()
2446   "Major mode for displaying an article.
2447
2448 All normal editing commands are switched off.
2449
2450 The following commands are available in addition to all summary mode
2451 commands:
2452 \\<gnus-article-mode-map>
2453 \\[gnus-article-next-page]\t Scroll the article one page forwards
2454 \\[gnus-article-prev-page]\t Scroll the article one page backwards
2455 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
2456 \\[gnus-article-show-summary]\t Display the summary buffer
2457 \\[gnus-article-mail]\t Send a reply to the address near point
2458 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
2459 \\[gnus-info-find-node]\t Go to the Gnus info node"
2460   (interactive)
2461   (when (gnus-visual-p 'article-menu 'menu)
2462     (gnus-article-make-menu-bar))
2463   (gnus-simplify-mode-line)
2464   (setq mode-name "Article")
2465   (setq major-mode 'gnus-article-mode)
2466   (make-local-variable 'minor-mode-alist)
2467   (unless (assq 'gnus-show-mime minor-mode-alist)
2468     (push (list 'gnus-show-mime " MIME") minor-mode-alist))
2469   (use-local-map gnus-article-mode-map)
2470   (gnus-update-format-specifications nil 'article-mode)
2471   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
2472   (make-local-variable 'gnus-page-broken)
2473   (make-local-variable 'gnus-button-marker-list)
2474   (make-local-variable 'gnus-article-current-summary)
2475   (make-local-variable 'gnus-article-mime-handles)
2476   (make-local-variable 'gnus-article-decoded-p)
2477   (make-local-variable 'gnus-article-mime-handle-alist)
2478   (make-local-variable 'gnus-article-washed-types)
2479   (gnus-set-default-directory)
2480   (buffer-disable-undo)
2481   (setq buffer-read-only t)
2482   (set-syntax-table gnus-article-mode-syntax-table)
2483   (gnus-run-hooks 'gnus-article-mode-hook))
2484
2485 (defun gnus-article-setup-buffer ()
2486   "Initialize the article buffer."
2487   (let* ((name (if gnus-single-article-buffer "*Article*"
2488                  (concat "*Article " gnus-newsgroup-name "*")))
2489          (original
2490           (progn (string-match "\\*Article" name)
2491                  (concat " *Original Article"
2492                          (substring name (match-end 0))))))
2493     (setq gnus-article-buffer name)
2494     (setq gnus-original-article-buffer original)
2495     (setq gnus-article-mime-handle-alist nil)
2496     ;; This might be a variable local to the summary buffer.
2497     (unless gnus-single-article-buffer
2498       (save-excursion
2499         (set-buffer gnus-summary-buffer)
2500         (setq gnus-article-buffer name)
2501         (setq gnus-original-article-buffer original)
2502         (gnus-set-global-variables)))
2503     ;; Init original article buffer.
2504     (save-excursion
2505       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
2506       (setq major-mode 'gnus-original-article-mode)
2507       (make-local-variable 'gnus-original-article))
2508     (if (get-buffer name)
2509         (save-excursion
2510           (set-buffer name)
2511           (buffer-disable-undo)
2512           (setq buffer-read-only t)
2513           (unless (eq major-mode 'gnus-article-mode)
2514             (gnus-article-mode))
2515           (current-buffer))
2516       (save-excursion
2517         (set-buffer (gnus-get-buffer-create name))
2518         (gnus-article-mode)
2519         (make-local-variable 'gnus-summary-buffer)
2520         (gnus-summary-set-local-parameters gnus-newsgroup-name)
2521         (current-buffer)))))
2522
2523 ;; Set article window start at LINE, where LINE is the number of lines
2524 ;; from the head of the article.
2525 (defun gnus-article-set-window-start (&optional line)
2526   (set-window-start
2527    (get-buffer-window gnus-article-buffer t)
2528    (save-excursion
2529      (set-buffer gnus-article-buffer)
2530      (goto-char (point-min))
2531      (if (not line)
2532          (point-min)
2533        (gnus-message 6 "Moved to bookmark")
2534        (search-forward "\n\n" nil t)
2535        (forward-line line)
2536        (point)))))
2537
2538 ;;; @@ article filters
2539 ;;;
2540
2541 (defun gnus-article-display-mime-message ()
2542   "Article display method for MIME message."
2543   ;; called from `gnus-original-article-buffer'.
2544   (let (charset all-headers)
2545     (with-current-buffer gnus-summary-buffer
2546       (setq charset default-mime-charset
2547             all-headers gnus-have-all-headers))
2548     (make-local-variable 'default-mime-charset)
2549     (setq default-mime-charset charset)
2550     (with-current-buffer (get-buffer-create gnus-article-buffer)
2551       (make-local-variable 'default-mime-charset)
2552       (setq default-mime-charset charset))
2553     (mime-display-message mime-message-structure
2554                           gnus-article-buffer nil gnus-article-mode-map)
2555     (when all-headers
2556       (gnus-article-hide-headers nil -1))
2557     )
2558   ;; `mime-display-message' changes current buffer to `gnus-article-buffer'.
2559   (make-local-variable 'mime-button-mother-dispatcher)
2560   (setq mime-button-mother-dispatcher
2561         (function gnus-article-push-button))
2562   (run-hooks 'gnus-mime-article-prepare-hook))
2563
2564 (defun gnus-article-display-traditional-message ()
2565   "Article display method for traditional message."
2566   (set-buffer gnus-article-buffer)
2567   (let (buffer-read-only)
2568     (erase-buffer)
2569     (insert-buffer-substring gnus-original-article-buffer)))
2570
2571 (defun gnus-article-make-full-mail-header (&optional number charset)
2572   "Create a new mail header structure in a raw article buffer."
2573   (unless (and number charset)
2574     (save-current-buffer
2575       (set-buffer gnus-summary-buffer)
2576       (unless number
2577         (setq number (or (cdr gnus-article-current) 0)))
2578       (unless charset
2579         (setq charset (or default-mime-charset 'x-ctext)))))
2580   (goto-char (point-min))
2581   (let ((header-end (if (search-forward "\n\n" nil t)
2582                         (1- (point))
2583                       (goto-char (point-max))))
2584         (chars (- (point-max) (point)))
2585         (lines (count-lines (point) (point-max)))
2586         (default-mime-charset charset)
2587         xref)
2588     (narrow-to-region (point-min) header-end)
2589     (setq xref (std11-fetch-field "xref"))
2590     (prog1
2591         (make-full-mail-header
2592          number
2593          (std11-fetch-field "subject")
2594          (std11-fetch-field "from")
2595          (std11-fetch-field "date")
2596          (std11-fetch-field "message-id")
2597          (std11-fetch-field "references")
2598          chars
2599          lines
2600          (when xref (concat "Xref: " xref)))
2601       (widen))))
2602
2603 (defun gnus-article-prepare (article &optional all-headers header)
2604   "Prepare ARTICLE in article mode buffer.
2605 ARTICLE should either be an article number or a Message-ID.
2606 If ARTICLE is an id, HEADER should be the article headers.
2607 If ALL-HEADERS is non-nil, no headers are hidden."
2608   (save-excursion
2609     ;; Make sure we start in a summary buffer.
2610     (unless (eq major-mode 'gnus-summary-mode)
2611       (set-buffer gnus-summary-buffer))
2612     (setq gnus-summary-buffer (current-buffer))
2613     (let* ((gnus-article (if header (mail-header-number header) article))
2614            (summary-buffer (current-buffer))
2615            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
2616            (group gnus-newsgroup-name)
2617            result)
2618       (save-excursion
2619         (gnus-article-setup-buffer)
2620         (set-buffer gnus-original-article-buffer)
2621         ;; Deactivate active regions.
2622         (when (and (boundp 'transient-mark-mode)
2623                    transient-mark-mode)
2624           (setq mark-active nil))
2625         (if (not (setq result (let ((buffer-read-only nil))
2626                                 (gnus-request-article-this-buffer
2627                                  article group))))
2628             ;; There is no such article.
2629             (save-excursion
2630               (when (and (numberp article)
2631                          (not (memq article gnus-newsgroup-sparse)))
2632                 (setq gnus-article-current
2633                       (cons gnus-newsgroup-name article))
2634                 (set-buffer gnus-summary-buffer)
2635                 (setq gnus-current-article article)
2636                 (if (eq (gnus-article-mark article) gnus-undownloaded-mark)
2637                     (progn
2638                       (gnus-summary-set-agent-mark article)
2639                       (message "Message marked for downloading"))
2640                   (gnus-summary-mark-article article gnus-canceled-mark)
2641                   (unless (memq article gnus-newsgroup-sparse)
2642                     (gnus-error 1
2643                      "No such article (may have expired or been canceled)")))))
2644           (if (or (eq result 'pseudo)
2645                   (eq result 'nneething))
2646               (progn
2647                 (save-excursion
2648                   (set-buffer summary-buffer)
2649                   (push article gnus-newsgroup-history)
2650                   (setq gnus-last-article gnus-current-article
2651                         gnus-current-article 0
2652                         gnus-current-headers nil
2653                         gnus-article-current nil)
2654                   (if (eq result 'nneething)
2655                       (gnus-configure-windows 'summary)
2656                     (gnus-configure-windows 'article))
2657                   (gnus-set-global-variables))
2658                 (let ((gnus-article-mime-handle-alist-1
2659                        gnus-article-mime-handle-alist))
2660                   (gnus-set-mode-line 'article)))
2661             ;; The result from the `request' was an actual article -
2662             ;; or at least some text that is now displayed in the
2663             ;; article buffer.
2664             (when (and (numberp article)
2665                        (not (eq article gnus-current-article)))
2666               ;; Seems like a new article has been selected.
2667               ;; `gnus-current-article' must be an article number.
2668               (save-excursion
2669                 (set-buffer summary-buffer)
2670                 (push article gnus-newsgroup-history)
2671                 (setq gnus-last-article gnus-current-article
2672                       gnus-current-article article
2673                       gnus-current-headers
2674                       (gnus-summary-article-header gnus-current-article)
2675                       gnus-article-current
2676                       (cons gnus-newsgroup-name gnus-current-article))
2677                 (unless (vectorp gnus-current-headers)
2678                   (setq gnus-current-headers nil))
2679                 (gnus-summary-goto-subject gnus-current-article)
2680                 (when (gnus-summary-show-thread)
2681                   ;; If the summary buffer really was folded, the
2682                   ;; previous goto may not actually have gone to
2683                   ;; the right article, but the thread root instead.
2684                   ;; So we go again.
2685                   (gnus-summary-goto-subject gnus-current-article))
2686                 (gnus-run-hooks 'gnus-mark-article-hook)
2687                 (gnus-set-mode-line 'summary)
2688                 (when (gnus-visual-p 'article-highlight 'highlight)
2689                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
2690                 ;; Set the global newsgroup variables here.
2691                 (gnus-set-global-variables)
2692                 (setq gnus-have-all-headers
2693                       (or all-headers gnus-show-all-headers))))
2694             (when (or (numberp article)
2695                       (stringp article))
2696               (gnus-article-prepare-display)
2697               ;; Do page break.
2698               (goto-char (point-min))
2699               (setq gnus-page-broken
2700                     (when gnus-break-pages
2701                       (gnus-narrow-to-page)
2702                       t)))
2703             (let ((gnus-article-mime-handle-alist-1
2704                    gnus-article-mime-handle-alist))
2705               (gnus-set-mode-line 'article))
2706             (article-goto-body)
2707             (set-window-point (get-buffer-window (current-buffer)) (point))
2708             (gnus-configure-windows 'article)
2709             t))))))
2710
2711 ;;;###autoload
2712 (defun gnus-article-prepare-display ()
2713   "Make the current buffer look like a nice article."
2714   (let ((method
2715          (if gnus-show-mime
2716              (progn
2717                (setq mime-message-structure gnus-current-headers)
2718                gnus-article-display-method-for-mime)
2719            gnus-article-display-method-for-traditional)))
2720     (gnus-run-hooks 'gnus-tmp-internal-hook)
2721     (gnus-run-hooks 'gnus-article-prepare-hook)
2722     ;; Display message.
2723     (funcall method)
2724     ;; Associate this article with the current summary buffer.
2725     (setq gnus-article-current-summary gnus-summary-buffer)
2726     ;; Perform the article display hooks.
2727     (gnus-run-hooks 'gnus-article-display-hook)))
2728
2729 ;;;
2730 ;;; Gnus MIME viewing functions
2731 ;;;
2732
2733 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
2734   "The following specs can be used:
2735 %t  The MIME type
2736 %T  MIME type, along with additional info
2737 %n  The `name' parameter
2738 %d  The description, if any
2739 %l  The length of the encoded part
2740 %p  The part identifier number
2741 %e  Dots if the part isn't displayed")
2742
2743 (defvar gnus-mime-button-line-format-alist
2744   '((?t gnus-tmp-type ?s)
2745     (?T gnus-tmp-type-long ?s)
2746     (?n gnus-tmp-name ?s)
2747     (?d gnus-tmp-description ?s)
2748     (?p gnus-tmp-id ?s)
2749     (?l gnus-tmp-length ?d)
2750     (?e gnus-tmp-dots ?s)))
2751
2752 (defvar gnus-mime-button-commands
2753   '((gnus-article-press-button  "\r"    "Toggle Display")
2754     (gnus-mime-view-part        "v"     "View Interactively...")
2755     (gnus-mime-save-part        "o"     "Save...")
2756     (gnus-mime-copy-part        "c"     "View As Text, In Other Buffer")
2757     (gnus-mime-inline-part      "i"     "View As Text, In This Buffer")
2758     (gnus-mime-internalize-part "E"     "View Internally")
2759     (gnus-mime-externalize-part "e"     "View Externally")
2760     (gnus-mime-pipe-part        "|"     "Pipe To Command...")))
2761
2762 (defun gnus-article-mime-part-status ()
2763   (if gnus-article-mime-handle-alist-1
2764       (format " (%d parts)" (length gnus-article-mime-handle-alist-1))
2765     ""))
2766
2767 (defvar gnus-mime-button-map nil)
2768 (unless gnus-mime-button-map
2769   (setq gnus-mime-button-map (make-sparse-keymap))
2770   (set-keymap-parent gnus-mime-button-map gnus-article-mode-map)
2771   (define-key gnus-mime-button-map gnus-mouse-2 'gnus-article-push-button)
2772   (define-key gnus-mime-button-map gnus-down-mouse-3 'gnus-mime-button-menu)
2773   (mapcar (lambda (c)
2774             (define-key gnus-mime-button-map (cadr c) (car c)))
2775           gnus-mime-button-commands))
2776
2777 (defun gnus-mime-button-menu (event)
2778   "Construct a context-sensitive menu of MIME commands."
2779   (interactive "e")
2780   (save-excursion
2781     (let ((pos (event-start event)))
2782       (set-buffer (window-buffer (posn-window pos)))
2783       (goto-char (posn-point pos))
2784       (gnus-article-check-buffer)
2785       (let ((response (x-popup-menu
2786                        t `("MIME Part"
2787                            ("" ,@(mapcar (lambda (c)
2788                                            (cons (caddr c) (car c)))
2789                                          gnus-mime-button-commands))))))
2790         (if response
2791             (funcall response))))))
2792
2793 (defun gnus-mime-view-all-parts (&optional handles)
2794   "View all the MIME parts."
2795   (interactive)
2796   (save-current-buffer
2797     (set-buffer gnus-article-buffer)
2798     (let ((handles (or handles gnus-article-mime-handles))
2799           (mail-parse-charset gnus-newsgroup-charset))
2800       (if (stringp (car handles))
2801           (gnus-mime-view-all-parts (cdr handles))
2802         (mapcar 'mm-display-part handles)))))
2803
2804 (defun gnus-mime-save-part ()
2805   "Save the MIME part under point."
2806   (interactive)
2807   (gnus-article-check-buffer)
2808   (let ((data (get-text-property (point) 'gnus-data)))
2809     (mm-save-part data)))
2810
2811 (defun gnus-mime-pipe-part ()
2812   "Pipe the MIME part under point to a process."
2813   (interactive)
2814   (gnus-article-check-buffer)
2815   (let ((data (get-text-property (point) 'gnus-data)))
2816     (mm-pipe-part data)))
2817
2818 (defun gnus-mime-view-part ()
2819   "Interactively choose a view method for the MIME part under point."
2820   (interactive)
2821   (gnus-article-check-buffer)
2822   (let ((data (get-text-property (point) 'gnus-data)))
2823     (mm-interactively-view-part data)))
2824
2825 (defun gnus-mime-copy-part (&optional handle)
2826   "Put the the MIME part under point into a new buffer."
2827   (interactive)
2828   (gnus-article-check-buffer)
2829   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
2830          (contents (mm-get-part handle))|
2831          (base (file-name-nondirectory
2832                 (or
2833                  (mail-content-type-get (mm-handle-type handle) 'name)
2834                  (mail-content-type-get (mm-handle-type handle)
2835                                         'filename)
2836                  "*decoded*")))
2837          (buffer (generate-new-buffer base)))
2838     (switch-to-buffer buffer)
2839     (insert contents)
2840     ;; We do it this way to make `normal-mode' set the appropriate mode.
2841     (unwind-protect
2842         (progn
2843           (setq buffer-file-name (expand-file-name base))
2844           (normal-mode))
2845       (setq buffer-file-name nil))
2846     (goto-char (point-min))))
2847
2848 (defun gnus-mime-inline-part (&optional handle)
2849   "Insert the MIME part under point into the current buffer."
2850   (interactive)
2851   (gnus-article-check-buffer)
2852   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
2853          contents
2854          (b (point))
2855          buffer-read-only)
2856     (if (mm-handle-undisplayer handle)
2857         (mm-remove-part handle)
2858       (setq contents (mm-get-part handle))
2859       (forward-line 2)
2860       (mm-insert-inline handle contents)
2861       (goto-char b))))
2862
2863 (defun gnus-mime-externalize-part (&optional handle)
2864   "View the MIME part under point with an external viewer."
2865   (interactive)
2866   (gnus-article-check-buffer)
2867   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
2868          (mm-user-display-methods nil)
2869          (mm-all-images-fit t)
2870          (mail-parse-charset gnus-newsgroup-charset))
2871     (if (mm-handle-undisplayer handle)
2872         (mm-remove-part handle)
2873       (mm-display-part handle))))
2874
2875 (defun gnus-mime-internalize-part (&optional handle)
2876   "View the MIME part under point with an internal viewer."
2877   (interactive)
2878   (gnus-article-check-buffer)
2879   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
2880          (mm-user-display-methods '((".*" . inline)))
2881          (mm-all-images-fit t)
2882          (mail-parse-charset gnus-newsgroup-charset))
2883     (if (mm-handle-undisplayer handle)
2884         (mm-remove-part handle)
2885       (mm-display-part handle))))
2886
2887 (defun gnus-article-part-wrapper (n function)
2888   (save-current-buffer
2889     (set-buffer gnus-article-buffer)
2890     (when (> n (length gnus-article-mime-handle-alist))
2891       (error "No such part"))
2892     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
2893       (funcall function handle))))
2894
2895 (defun gnus-article-pipe-part (n)
2896   "Pipe MIME part N, which is the numerical prefix."
2897   (interactive "p")
2898   (gnus-article-part-wrapper n 'mm-pipe-part))
2899
2900 (defun gnus-article-save-part (n)
2901   "Save MIME part N, which is the numerical prefix."
2902   (interactive "p")
2903   (gnus-article-part-wrapper n 'mm-save-part))
2904
2905 (defun gnus-article-interactively-view-part (n)
2906   "View MIME part N interactively, which is the numerical prefix."
2907   (interactive "p")
2908   (gnus-article-part-wrapper n 'mm-interactively-view-part))
2909
2910 (defun gnus-article-copy-part (n)
2911   "Copy MIME part N, which is the numerical prefix."
2912   (interactive "p")
2913   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
2914
2915 (defun gnus-article-externalize-part (n)
2916   "View MIME part N externally, which is the numerical prefix."
2917   (interactive "p")
2918   (gnus-article-part-wrapper n 'gnus-mime-externalize-part))
2919
2920 (defun gnus-article-inline-part (n)
2921   "Inline MIME part N, which is the numerical prefix."
2922   (interactive "p")
2923   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
2924
2925 (defun gnus-article-view-part (n)
2926   "View MIME part N, which is the numerical prefix."
2927   (interactive "p")
2928   (save-current-buffer
2929     (set-buffer gnus-article-buffer)
2930     (when (> n (length gnus-article-mime-handle-alist))
2931       (error "No such part"))
2932     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
2933       (when (gnus-article-goto-part n)
2934         (if (equal (car handle) "multipart/alternative")
2935             (gnus-article-press-button)
2936           (when (eq (gnus-mm-display-part handle) 'internal)
2937             (gnus-set-window-start)))))))
2938
2939 (defun gnus-mm-display-part (handle)
2940   "Display HANDLE and fix MIME button."
2941   (let ((id (get-text-property (point) 'gnus-part))
2942         (point (point))
2943         buffer-read-only)
2944     (forward-line 1)
2945     (prog1
2946         (let ((window (selected-window))
2947               (mail-parse-charset gnus-newsgroup-charset))
2948           (save-excursion
2949             (unwind-protect
2950                 (let ((win (get-buffer-window (current-buffer) t))
2951                       (beg (point)))
2952                   (when win
2953                     (select-window win))
2954                   (goto-char point)
2955                   (forward-line)
2956                   (if (mm-handle-displayed-p handle)
2957                       ;; This will remove the part.
2958                       (mm-display-part handle)
2959                     (save-restriction
2960                       (narrow-to-region (point) (1+ (point)))
2961                       (mm-display-part handle)
2962                       ;; We narrow to the part itself and
2963                       ;; then call the treatment functions.
2964                       (goto-char (point-min))
2965                       (forward-line 1)
2966                       (narrow-to-region (point) (point-max))
2967                       (gnus-treat-article
2968                        nil id
2969                        (1- (length gnus-article-mime-handles))
2970                        (car (mm-handle-type handle))))))
2971               (select-window window))))
2972       (goto-char point)
2973       (delete-region (gnus-point-at-bol) (progn (forward-line 1) (point)))
2974       (gnus-insert-mime-button
2975        handle id (list (mm-handle-displayed-p handle)))
2976       (goto-char point))))
2977
2978 (defun gnus-article-goto-part (n)
2979   "Go to MIME part N."
2980   (let ((point (text-property-any (point-min) (point-max) 'gnus-part n)))
2981     (when point
2982       (goto-char point))))
2983
2984 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
2985   (let ((gnus-tmp-name
2986          (or (mail-content-type-get (mm-handle-type handle)
2987                                     'name)
2988              (mail-content-type-get (mm-handle-disposition handle)
2989                                     'filename)
2990              ""))
2991         (gnus-tmp-type (car (mm-handle-type handle)))
2992         (gnus-tmp-description
2993          (mail-decode-encoded-word-string (or (mm-handle-description handle)
2994                                               "")))
2995         (gnus-tmp-dots
2996          (if (if displayed (car displayed)
2997                (mm-handle-displayed-p handle))
2998              "" "..."))
2999         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
3000                            (buffer-size)))
3001         gnus-tmp-type-long b e)
3002     (when (string-match ".*/" gnus-tmp-name)
3003       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
3004     (setq gnus-tmp-type-long (concat gnus-tmp-type
3005                                      (and (not (equal gnus-tmp-name ""))
3006                                           (concat "; " gnus-tmp-name))))
3007     (or (equal gnus-tmp-description "")
3008         (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
3009     (unless (bolp)
3010       (insert "\n"))
3011     (setq b (point))
3012     (gnus-eval-format
3013      gnus-mime-button-line-format gnus-mime-button-line-format-alist
3014      `(local-map ,gnus-mime-button-map
3015                  keymap ,gnus-mime-button-map
3016                  gnus-callback gnus-mm-display-part
3017                  gnus-part ,gnus-tmp-id
3018                  article-type annotation
3019                  gnus-data ,handle))
3020     (setq e (point))
3021     (widget-convert-button 'link b e
3022                            :mime-handle handle
3023                            :action 'gnus-widget-press-button
3024                            :button-keymap gnus-mime-button-map
3025                            :help-echo
3026                            (lambda (widget)
3027                              ;; Needed to properly clear the message
3028                              ;; due to a bug in wid-edit
3029                              (setq help-echo-owns-message t)
3030                              (format
3031                               "Click to %s the MIME part; %s for more options"
3032                               (if (mm-handle-displayed-p
3033                                    (widget-get widget :mime-handle))
3034                                   "hide" "show")
3035                               (if gnus-xemacs "button3" "mouse-3"))))))
3036
3037 (defun gnus-widget-press-button (elems el)
3038   (goto-char (widget-get elems :from))
3039   (gnus-article-press-button))
3040
3041 (defvar gnus-displaying-mime nil)
3042
3043 (defun gnus-display-mime (&optional ihandles)
3044   "Display the MIME parts."
3045   (save-excursion
3046     (save-selected-window
3047       (let ((window (get-buffer-window gnus-article-buffer))
3048             (point (point)))
3049         (when window
3050           (select-window window)
3051           ;; We have to do this since selecting the window
3052           ;; may change the point.  So we set the window point.
3053           (set-window-point window point)))
3054       (let* ((handles (or ihandles (mm-dissect-buffer) (mm-uu-dissect)))
3055              buffer-read-only handle name type b e display)
3056         (when (and (not ihandles)
3057                    (not gnus-displaying-mime))
3058           ;; Top-level call; we clean up.
3059           (mm-destroy-parts gnus-article-mime-handles)
3060           (setq gnus-article-mime-handles handles
3061                 gnus-article-mime-handle-alist nil)
3062           ;; We allow users to glean info from the handles.
3063           (when gnus-article-mime-part-function
3064             (gnus-mime-part-function handles)))
3065         (if (and handles
3066                  (or (not (stringp (car handles)))
3067                      (cdr handles)))
3068             (progn
3069               (when (and (not ihandles)
3070                          (not gnus-displaying-mime))
3071                 ;; Clean up for mime parts.
3072                 (article-goto-body)
3073                 (delete-region (point) (point-max)))
3074               (let ((gnus-displaying-mime t))
3075                 (gnus-mime-display-part handles)))
3076           (save-restriction
3077             (article-goto-body)
3078             (narrow-to-region (point) (point-max))
3079             (gnus-treat-article nil 1 1)
3080             (widen)))
3081         ;; Highlight the headers.
3082         (save-excursion
3083           (save-restriction
3084             (article-goto-body)
3085             (narrow-to-region (point-min) (point))
3086             (gnus-treat-article 'head)))))))
3087
3088 (defvar gnus-mime-display-multipart-as-mixed nil)
3089
3090 (defun gnus-mime-display-part (handle)
3091   (cond
3092    ;; Single part.
3093    ((not (stringp (car handle)))
3094     (gnus-mime-display-single handle))
3095    ;; User-defined multipart
3096    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
3097     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
3098              handle))
3099    ;; multipart/alternative
3100    ((and (equal (car handle) "multipart/alternative")
3101          (not gnus-mime-display-multipart-as-mixed))
3102     (let ((id (1+ (length gnus-article-mime-handle-alist))))
3103       (push (cons id handle) gnus-article-mime-handle-alist)
3104       (gnus-mime-display-alternative (cdr handle) nil nil id)))
3105    ;; multipart/related
3106    ((and (equal (car handle) "multipart/related")
3107          (not gnus-mime-display-multipart-as-mixed))
3108     ;;;!!!We should find the start part, but we just default
3109     ;;;!!!to the first part.
3110     (gnus-mime-display-part (cadr handle)))
3111    ;; Other multiparts are handled like multipart/mixed.
3112    (t
3113     (gnus-mime-display-mixed (cdr handle)))))
3114
3115 (defun gnus-mime-part-function (handles)
3116   (if (stringp (car handles))
3117       (mapcar 'gnus-mime-part-function (cdr handles))
3118     (funcall gnus-article-mime-part-function handles)))
3119
3120 (defun gnus-mime-display-mixed (handles)
3121   (mapcar 'gnus-mime-display-part handles))
3122
3123 (defun gnus-mime-display-single (handle)
3124   (let ((type (car (mm-handle-type handle)))
3125         (ignored gnus-ignored-mime-types)
3126         (not-attachment t)
3127         (move nil)
3128         display text)
3129     (catch 'ignored
3130       (progn
3131         (while ignored
3132           (when (string-match (pop ignored) type)
3133             (throw 'ignored nil)))
3134         (if (and (setq not-attachment
3135                        (or (not (mm-handle-disposition handle))
3136                            (equal (car (mm-handle-disposition handle))
3137                                   "inline")
3138                            (mm-attachment-override-p type)))
3139                  (mm-automatic-display-p type)
3140                  (or (mm-inlinable-part-p type)
3141                      (mm-automatic-external-display-p type)))
3142             (setq display t)
3143           (when (equal (car (split-string type "/"))
3144                        "text")
3145             (setq text t)))
3146         (let ((id (1+ (length gnus-article-mime-handle-alist))))
3147           (push (cons id handle) gnus-article-mime-handle-alist)
3148           (when (or (not display)
3149                     (not (gnus-unbuttonized-mime-type-p type)))
3150             (gnus-article-insert-newline)
3151             (gnus-insert-mime-button
3152              handle id (list (or display (and not-attachment text))))
3153             (gnus-article-insert-newline)
3154             (gnus-article-insert-newline)
3155             (setq move t)))
3156         (let ((beg (point)))
3157           (cond
3158            (display
3159             (when move
3160               (forward-line -2))
3161             (let ((mail-parse-charset gnus-newsgroup-charset))
3162               (mm-display-part handle t))
3163             (goto-char (point-max)))
3164            ((and text not-attachment)
3165             (when move
3166               (forward-line -2))
3167             (gnus-article-insert-newline)
3168             (mm-insert-inline handle (mm-get-part handle))
3169             (goto-char (point-max))))
3170           ;; Do highlighting.
3171           (save-excursion
3172             (save-restriction
3173               (narrow-to-region beg (point))
3174               (gnus-treat-article
3175                nil (length gnus-article-mime-handle-alist)
3176                (1- (length gnus-article-mime-handles))
3177                (car (mm-handle-type handle))))))))))
3178
3179 (defun gnus-unbuttonized-mime-type-p (type)
3180   "Say whether TYPE is to be unbuttonized."
3181   (unless gnus-inhibit-mime-unbuttonizing
3182     (catch 'found
3183       (let ((types gnus-unbuttonized-mime-types))
3184         (while types
3185           (when (string-match (pop types) type)
3186             (throw 'found t)))))))
3187
3188 (defun gnus-article-insert-newline ()
3189   "Insert a newline, but mark it as undeletable."
3190   (gnus-put-text-property
3191    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
3192
3193 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
3194   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
3195          (ihandles handles)
3196          (point (point))
3197          handle buffer-read-only from props begend not-pref)
3198     (save-window-excursion
3199       (save-restriction
3200         (when ibegend
3201           (narrow-to-region (car ibegend)
3202                             (or (cdr ibegend)
3203                                 (progn
3204                                   (goto-char (car ibegend))
3205                                   (forward-line 2)
3206                                   (point))))
3207           (delete-region (point-min) (point-max))
3208           (mm-remove-parts handles))
3209         (setq begend (list (point-marker)))
3210         ;; Do the toggle.
3211         (unless (setq not-pref (cadr (member preferred ihandles)))
3212           (setq not-pref (car ihandles)))
3213         (when (or ibegend
3214                   (not (gnus-unbuttonized-mime-type-p
3215                         "multipart/alternative")))
3216           (gnus-add-text-properties
3217            (setq from (point))
3218            (progn
3219              (insert (format "%d.  " id))
3220              (point))
3221            `(gnus-callback
3222              (lambda (handles)
3223                (unless ,(not ibegend)
3224                  (setq gnus-article-mime-handle-alist
3225                        ',gnus-article-mime-handle-alist))
3226                (gnus-mime-display-alternative
3227                 ',ihandles ',not-pref ',begend ,id))
3228              local-map ,gnus-mime-button-map
3229              ,gnus-mouse-face-prop ,gnus-article-mouse-face
3230              face ,gnus-article-button-face
3231              keymap ,gnus-mime-button-map
3232              gnus-part ,id
3233              gnus-data ,handle))
3234           (widget-convert-button 'link from (point)
3235                                  :action 'gnus-widget-press-button
3236                                  :button-keymap gnus-widget-button-keymap)
3237           ;; Do the handles
3238           (while (setq handle (pop handles))
3239             (gnus-add-text-properties
3240              (setq from (point))
3241              (progn
3242                (insert (format "(%c) %-18s"
3243                                (if (equal handle preferred) ?* ? )
3244                                (if (stringp (car handle))
3245                                    (car handle)
3246                                  (car (mm-handle-type handle)))))
3247                (point))
3248              `(gnus-callback
3249                (lambda (handles)
3250                  (unless ,(not ibegend)
3251                    (setq gnus-article-mime-handle-alist
3252                          ',gnus-article-mime-handle-alist))
3253                  (gnus-mime-display-alternative
3254                   ',ihandles ',handle ',begend ,id))
3255                local-map ,gnus-mime-button-map
3256                ,gnus-mouse-face-prop ,gnus-article-mouse-face
3257                face ,gnus-article-button-face
3258                keymap ,gnus-mime-button-map
3259                gnus-part ,id
3260                gnus-data ,handle))
3261             (widget-convert-button 'link from (point)
3262                                    :action 'gnus-widget-press-button
3263                                    :button-keymap gnus-widget-button-keymap)
3264             (insert "  "))
3265           (insert "\n\n"))
3266         (when preferred
3267           (if (stringp (car preferred))
3268               (gnus-display-mime preferred)
3269             (let ((mail-parse-charset gnus-newsgroup-charset))
3270               (mm-display-part preferred)))
3271           (goto-char (point-max))
3272           (setcdr begend (point-marker)))))
3273     (when ibegend
3274       (goto-char point))))
3275
3276 (defun gnus-article-wash-status ()
3277   "Return a string which display status of article washing."
3278   (save-excursion
3279     (set-buffer gnus-article-buffer)
3280     (let ((cite (gnus-article-hidden-text-p 'cite))
3281           (headers (gnus-article-hidden-text-p 'headers))
3282           (boring (gnus-article-hidden-text-p 'boring-headers))
3283           (pgp (gnus-article-hidden-text-p 'pgp))
3284           (pem (gnus-article-hidden-text-p 'pem))
3285           (signature (gnus-article-hidden-text-p 'signature))
3286           (overstrike (gnus-article-hidden-text-p 'overstrike))
3287           (emphasis (gnus-article-hidden-text-p 'emphasis))
3288           (mime gnus-show-mime))
3289       (format "%c%c%c%c%c%c%c"
3290               (if cite ?c ? )
3291               (if (or headers boring) ?h ? )
3292               (if (or pgp pem) ?p ? )
3293               (if signature ?s ? )
3294               (if overstrike ?o ? )
3295               (if mime ?m ? )
3296               (if emphasis ?e ? )))))
3297
3298 (fset 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
3299
3300 (defun gnus-article-maybe-hide-headers ()
3301   "Hide unwanted headers if `gnus-have-all-headers' is nil.
3302 Provided for backwards compatibility."
3303   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
3304                  (not (save-excursion (set-buffer gnus-summary-buffer)
3305                                       gnus-have-all-headers)))
3306              (not gnus-inhibit-hiding))
3307     (gnus-article-hide-headers)))
3308
3309 ;;; Article savers.
3310
3311 (defun gnus-output-to-file (file-name)
3312   "Append the current article to a file named FILE-NAME."
3313   (let ((artbuf (current-buffer)))
3314     (with-temp-buffer
3315       (insert-buffer-substring artbuf)
3316       ;; Append newline at end of the buffer as separator, and then
3317       ;; save it to file.
3318       (goto-char (point-max))
3319       (insert "\n")
3320       (append-to-file (point-min) (point-max) file-name)
3321       t)))
3322
3323 (defun gnus-narrow-to-page (&optional arg)
3324   "Narrow the article buffer to a page.
3325 If given a numerical ARG, move forward ARG pages."
3326   (interactive "P")
3327   (setq arg (if arg (prefix-numeric-value arg) 0))
3328   (save-excursion
3329     (set-buffer gnus-article-buffer)
3330     (goto-char (point-min))
3331     (widen)
3332     ;; Remove any old next/prev buttons.
3333     (when (gnus-visual-p 'page-marker)
3334       (let ((buffer-read-only nil))
3335         (gnus-remove-text-with-property 'gnus-prev)
3336         (gnus-remove-text-with-property 'gnus-next)))
3337     (when
3338         (cond ((< arg 0)
3339                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
3340               ((> arg 0)
3341                (re-search-forward page-delimiter nil 'move arg)))
3342       (goto-char (match-end 0)))
3343     (narrow-to-region
3344      (point)
3345      (if (re-search-forward page-delimiter nil 'move)
3346          (match-beginning 0)
3347        (point)))
3348     (when (and (gnus-visual-p 'page-marker)
3349                (not (= (point-min) 1)))
3350       (save-excursion
3351         (goto-char (point-min))
3352         (gnus-insert-prev-page-button)))
3353     (when (and (gnus-visual-p 'page-marker)
3354                (< (+ (point-max) 2) (buffer-size)))
3355       (save-excursion
3356         (goto-char (point-max))
3357         (gnus-insert-next-page-button)))))
3358
3359 ;; Article mode commands
3360
3361 (defun gnus-article-goto-next-page ()
3362   "Show the next page of the article."
3363   (interactive)
3364   (when (gnus-article-next-page)
3365     (goto-char (point-min))
3366     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
3367
3368 (defun gnus-article-goto-prev-page ()
3369   "Show the next page of the article."
3370   (interactive)
3371   (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
3372     (gnus-article-prev-page nil)))
3373
3374 (defun gnus-article-next-page (&optional lines)
3375   "Show the next page of the current article.
3376 If end of article, return non-nil.  Otherwise return nil.
3377 Argument LINES specifies lines to be scrolled up."
3378   (interactive "p")
3379   (move-to-window-line -1)
3380   (if (save-excursion
3381         (end-of-line)
3382         (and (pos-visible-in-window-p)  ;Not continuation line.
3383              (eobp)))
3384       ;; Nothing in this page.
3385       (if (or (not gnus-page-broken)
3386               (save-excursion
3387                 (save-restriction
3388                   (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
3389           t                             ;Nothing more.
3390         (gnus-narrow-to-page 1)         ;Go to next page.
3391         nil)
3392     ;; More in this page.
3393     (let ((scroll-in-place nil))
3394       (condition-case ()
3395           (scroll-up lines)
3396         (end-of-buffer
3397          ;; Long lines may cause an end-of-buffer error.
3398          (goto-char (point-max)))))
3399     (move-to-window-line 0)
3400     nil))
3401
3402 (defun gnus-article-prev-page (&optional lines)
3403   "Show previous page of current article.
3404 Argument LINES specifies lines to be scrolled down."
3405   (interactive "p")
3406   (move-to-window-line 0)
3407   (if (and gnus-page-broken
3408            (bobp)
3409            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
3410       (progn
3411         (gnus-narrow-to-page -1)        ;Go to previous page.
3412         (goto-char (point-max))
3413         (recenter -1))
3414     (let ((scroll-in-place nil))
3415       (prog1
3416           (condition-case ()
3417               (scroll-down lines)
3418             (beginning-of-buffer
3419              (goto-char (point-min))))
3420         (move-to-window-line 0)))))
3421
3422 (defun gnus-article-refer-article ()
3423   "Read article specified by message-id around point."
3424   (interactive)
3425   (let ((point (point)))
3426     (search-forward ">" nil t)          ;Move point to end of "<....>".
3427     (if (re-search-backward "\\(<[^<> \t\n]+>\\)" nil t)
3428         (let ((message-id (match-string 1)))
3429           (goto-char point)
3430           (set-buffer gnus-summary-buffer)
3431           (gnus-summary-refer-article message-id))
3432       (goto-char (point))
3433       (error "No references around point"))))
3434
3435 (defun gnus-article-show-summary ()
3436   "Reconfigure windows to show summary buffer."
3437   (interactive)
3438   (if (not (gnus-buffer-live-p gnus-summary-buffer))
3439       (error "There is no summary buffer for this article buffer")
3440     (gnus-article-set-globals)
3441     (gnus-configure-windows 'article)
3442     (gnus-summary-goto-subject gnus-current-article)
3443     (gnus-summary-position-point)))
3444
3445 (defun gnus-article-describe-briefly ()
3446   "Describe article mode commands briefly."
3447   (interactive)
3448   (gnus-message 6 (substitute-command-keys "\\<gnus-article-mode-map>\\[gnus-article-goto-next-page]:Next page   \\[gnus-article-goto-prev-page]:Prev page  \\[gnus-article-show-summary]:Show summary  \\[gnus-info-find-node]:Run Info  \\[gnus-article-describe-briefly]:This help")))
3449
3450 (defun gnus-article-summary-command ()
3451   "Execute the last keystroke in the summary buffer."
3452   (interactive)
3453   (let ((obuf (current-buffer))
3454         (owin (current-window-configuration))
3455         func)
3456     (switch-to-buffer gnus-article-current-summary 'norecord)
3457     (setq func (lookup-key (current-local-map) (this-command-keys)))
3458     (call-interactively func)
3459     (set-buffer obuf)
3460     (set-window-configuration owin)
3461     (set-window-point (get-buffer-window (current-buffer)) (point))))
3462
3463 (defun gnus-article-summary-command-nosave ()
3464   "Execute the last keystroke in the summary buffer."
3465   (interactive)
3466   (let (func)
3467     (pop-to-buffer gnus-article-current-summary 'norecord)
3468     (setq func (lookup-key (current-local-map) (this-command-keys)))
3469     (call-interactively func)))
3470
3471 (defun gnus-article-check-buffer ()
3472   "Beep if not in an article buffer."
3473   (unless (eq (get-buffer gnus-article-buffer) (current-buffer))
3474     (error "Command invoked outside of a Gnus article buffer")))
3475
3476 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
3477   "Read a summary buffer key sequence and execute it from the article buffer."
3478   (interactive "P")
3479   (gnus-article-check-buffer)
3480   (let ((nosaves
3481          '("q" "Q"  "c" "r" "R" "\C-c\C-f" "m"  "a" "f" "F"
3482            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
3483            "=" "^" "\M-^" "|"))
3484         (nosave-but-article
3485          '("A\r"))
3486         (nosave-in-article
3487          '("\C-d"))
3488         (up-to-top
3489          '("n" "Gn" "p" "Gp"))
3490         keys new-sum-point)
3491     (save-excursion
3492       (set-buffer gnus-article-current-summary)
3493       (let (gnus-pick-mode)
3494         (push (or key last-command-event) unread-command-events)
3495         (setq keys (read-key-sequence nil))))
3496     (message "")
3497
3498     (if (or (member keys nosaves)
3499             (member keys nosave-but-article)
3500             (member keys nosave-in-article))
3501         (let (func)
3502           (save-window-excursion
3503             (pop-to-buffer gnus-article-current-summary 'norecord)
3504             ;; We disable the pick minor mode commands.
3505             (let (gnus-pick-mode)
3506               (setq func (lookup-key (current-local-map) keys))))
3507           (if (not func)
3508               (ding)
3509             (unless (member keys nosave-in-article)
3510               (set-buffer gnus-article-current-summary))
3511             (call-interactively func)
3512             (setq new-sum-point (point)))
3513           (when (member keys nosave-but-article)
3514             (pop-to-buffer gnus-article-buffer 'norecord)))
3515       ;; These commands should restore window configuration.
3516       (let ((obuf (current-buffer))
3517             (owin (current-window-configuration))
3518             (opoint (point))
3519             (summary gnus-article-current-summary)
3520             func in-buffer selected)
3521         (if not-restore-window
3522             (pop-to-buffer summary 'norecord)
3523           (switch-to-buffer summary 'norecord))
3524         (setq in-buffer (current-buffer))
3525         ;; We disable the pick minor mode commands.
3526         (if (setq func (let (gnus-pick-mode)
3527                          (lookup-key (current-local-map) keys)))
3528             (progn
3529               (call-interactively func)
3530               (setq new-sum-point (point)))
3531           (ding))
3532         (when (eq in-buffer (current-buffer))
3533           (setq selected (gnus-summary-select-article))
3534           (set-buffer obuf)
3535           (unless not-restore-window
3536             (set-window-configuration owin))
3537           (when (eq selected 'old)
3538             (article-goto-body)
3539             (set-window-start (get-buffer-window (current-buffer))
3540                               1)
3541             (set-window-point (get-buffer-window (current-buffer))
3542                               (point)))
3543           (let ((win (get-buffer-window gnus-article-current-summary)))
3544             (when win
3545               (set-window-point win new-sum-point))))))))
3546
3547 (defun gnus-article-hide (&optional arg force)
3548   "Hide all the gruft in the current article.
3549 This means that PGP stuff, signatures, cited text and (some)
3550 headers will be hidden.
3551 If given a prefix, show the hidden text instead."
3552   (interactive (append (gnus-article-hidden-arg) (list 'force)))
3553   (gnus-article-hide-headers arg)
3554   (gnus-article-hide-pgp arg)
3555   (gnus-article-hide-citation-maybe arg force)
3556   (gnus-article-hide-signature arg))
3557
3558 (defun gnus-article-maybe-highlight ()
3559   "Do some article highlighting if article highlighting is requested."
3560   (when (gnus-visual-p 'article-highlight 'highlight)
3561     (gnus-article-highlight-some)))
3562
3563 (defun gnus-check-group-server ()
3564   ;; Make sure the connection to the server is alive.
3565   (unless (gnus-server-opened
3566            (gnus-find-method-for-group gnus-newsgroup-name))
3567     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
3568     (gnus-request-group gnus-newsgroup-name t)))
3569
3570 (defun gnus-request-article-this-buffer (article group)
3571   "Get an article and insert it into this buffer."
3572   (let (do-update-line sparse-header)
3573     (prog1
3574         (save-excursion
3575           (erase-buffer)
3576           (gnus-kill-all-overlays)
3577           (setq group (or group gnus-newsgroup-name))
3578
3579           ;; Using `gnus-request-article' directly will insert the article into
3580           ;; `nntp-server-buffer' - so we'll save some time by not having to
3581           ;; copy it from the server buffer into the article buffer.
3582
3583           ;; We only request an article by message-id when we do not have the
3584           ;; headers for it, so we'll have to get those.
3585           (when (stringp article)
3586             (let ((gnus-override-method gnus-refer-article-method))
3587               (gnus-read-header article)))
3588
3589           ;; If the article number is negative, that means that this article
3590           ;; doesn't belong in this newsgroup (possibly), so we find its
3591           ;; message-id and request it by id instead of number.
3592           (when (and (numberp article)
3593                      gnus-summary-buffer
3594                      (get-buffer gnus-summary-buffer)
3595                      (gnus-buffer-exists-p gnus-summary-buffer))
3596             (save-excursion
3597               (set-buffer gnus-summary-buffer)
3598               (let ((header (gnus-summary-article-header article)))
3599                 (when (< article 0)
3600                   (cond
3601                    ((memq article gnus-newsgroup-sparse)
3602                     ;; This is a sparse gap article.
3603                     (setq do-update-line article)
3604                     (setq article (mail-header-id header))
3605                     (let ((gnus-override-method gnus-refer-article-method))
3606                       (setq sparse-header (gnus-read-header article)))
3607                     (setq gnus-newsgroup-sparse
3608                           (delq article gnus-newsgroup-sparse)))
3609                    ((vectorp header)
3610                     ;; It's a real article.
3611                     (setq article (mail-header-id header)))
3612                    (t
3613                     ;; It is an extracted pseudo-article.
3614                     (setq article 'pseudo)
3615                     (gnus-request-pseudo-article header))))
3616
3617                 (let ((method (gnus-find-method-for-group
3618                                gnus-newsgroup-name)))
3619                   (when (and (eq (car method) 'nneething)
3620                              (vectorp header))
3621                     (let ((dir (concat
3622                                 (file-name-as-directory
3623                                  (or (cadr (assq 'nneething-address method))
3624                                      (nth 1 method)))
3625                                 (mail-header-subject header))))
3626                       (when (file-directory-p dir)
3627                         (setq article 'nneething)
3628                         (gnus-group-enter-directory dir))))))))
3629
3630           (cond
3631            ;; Refuse to select canceled articles.
3632            ((and (numberp article)
3633                  gnus-summary-buffer
3634                  (get-buffer gnus-summary-buffer)
3635                  (gnus-buffer-exists-p gnus-summary-buffer)
3636                  (eq (cdr (save-excursion
3637                             (set-buffer gnus-summary-buffer)
3638                             (assq article gnus-newsgroup-reads)))
3639                      gnus-canceled-mark))
3640             nil)
3641            ;; Check the backlog.
3642            ((and gnus-keep-backlog
3643                  (gnus-backlog-request-article group article (current-buffer)))
3644             'article)
3645            ;; Check asynchronous pre-fetch.
3646            ((gnus-async-request-fetched-article group article (current-buffer))
3647             (gnus-async-prefetch-next group article gnus-summary-buffer)
3648             (when (and (numberp article) gnus-keep-backlog)
3649               (gnus-backlog-enter-article group article (current-buffer)))
3650             'article)
3651            ;; Check the cache.
3652            ((and gnus-use-cache
3653                  (numberp article)
3654                  (gnus-cache-request-article article group))
3655             'article)
3656            ;; Get the article and put into the article buffer.
3657            ((or (stringp article) (numberp article))
3658             (let ((gnus-override-method
3659                    (and (stringp article) gnus-refer-article-method))
3660                   (buffer-read-only nil))
3661               (erase-buffer)
3662               (gnus-kill-all-overlays)
3663               (gnus-check-group-server)
3664               (when (gnus-request-article article group (current-buffer))
3665                 (when (numberp article)
3666                   (gnus-async-prefetch-next group article gnus-summary-buffer)
3667                   (when gnus-keep-backlog
3668                     (gnus-backlog-enter-article
3669                      group article (current-buffer))))
3670                 'article)))
3671            ;; It was a pseudo.
3672            (t article)))
3673
3674       ;; Associate this article with the current summary buffer.
3675       (setq gnus-article-current-summary gnus-summary-buffer)
3676
3677       ;; Take the article from the original article buffer
3678       ;; and place it in the buffer it's supposed to be in.
3679       (when (and (get-buffer gnus-article-buffer)
3680                  (equal (buffer-name (current-buffer))
3681                         (buffer-name (get-buffer gnus-article-buffer))))
3682         (save-excursion
3683           (if (get-buffer gnus-original-article-buffer)
3684               (set-buffer gnus-original-article-buffer)
3685             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
3686             (buffer-disable-undo)
3687             (setq major-mode 'gnus-original-article-mode)
3688             (setq buffer-read-only t))
3689           (let (buffer-read-only)
3690             (erase-buffer)
3691             (insert-buffer-substring gnus-article-buffer))
3692           (setq gnus-original-article (cons group article)))
3693
3694         ;; Decode charsets.
3695         (run-hooks 'gnus-article-decode-hook)
3696         ;; Mark article as decoded or not.
3697         (setq gnus-article-decoded-p gnus-article-decode-hook))
3698
3699       ;; Update sparse articles.
3700       (when (and do-update-line
3701                  (or (numberp article)
3702                      (stringp article)))
3703         (let ((buf (current-buffer)))
3704           (set-buffer gnus-summary-buffer)
3705           (gnus-summary-update-article do-update-line sparse-header)
3706           (gnus-summary-goto-subject do-update-line nil t)
3707           (set-window-point (get-buffer-window (current-buffer) t)
3708                             (point))
3709           (set-buffer buf))))))
3710
3711 ;;;
3712 ;;; Article editing
3713 ;;;
3714
3715 (defcustom gnus-article-edit-mode-hook nil
3716   "Hook run in article edit mode buffers."
3717   :group 'gnus-article-various
3718   :type 'hook)
3719
3720 (defcustom gnus-article-edit-article-setup-function
3721   'gnus-article-mime-edit-article-setup
3722   "Function called to setup an editing article buffer."
3723   :group 'gnus-article-various
3724   :type 'function)
3725
3726 (defvar gnus-article-edit-done-function nil)
3727
3728 (defvar gnus-article-edit-mode-map nil)
3729
3730 ;; Should we be using derived.el for this?
3731 (unless gnus-article-edit-mode-map
3732   (setq gnus-article-edit-mode-map (make-sparse-keymap))
3733   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
3734
3735   (gnus-define-keys gnus-article-edit-mode-map
3736     "\C-c\C-c" gnus-article-edit-done
3737     "\C-c\C-k" gnus-article-edit-exit)
3738
3739   (gnus-define-keys (gnus-article-edit-wash-map
3740                      "\C-c\C-w" gnus-article-edit-mode-map)
3741     "f" gnus-article-edit-full-stops))
3742
3743 (defun gnus-article-edit-mode ()
3744   "Major mode for editing articles.
3745 This is an extended text-mode.
3746
3747 \\{gnus-article-edit-mode-map}"
3748   (interactive)
3749   (setq major-mode 'gnus-article-edit-mode)
3750   (setq mode-name "Article Edit")
3751   (use-local-map gnus-article-edit-mode-map)
3752   (make-local-variable 'gnus-article-edit-done-function)
3753   (make-local-variable 'gnus-prev-winconf)
3754   (setq buffer-read-only nil)
3755   (buffer-enable-undo)
3756   (widen)
3757   (gnus-run-hooks 'text-mode-hook 'gnus-article-edit-mode-hook))
3758
3759 (defun gnus-article-edit (&optional force)
3760   "Edit the current article.
3761 This will have permanent effect only in mail groups.
3762 If FORCE is non-nil, allow editing of articles even in read-only
3763 groups."
3764   (interactive "P")
3765   (when (and (not force)
3766              (gnus-group-read-only-p))
3767     (error "The current newsgroup does not support article editing"))
3768   (gnus-article-date-original)
3769   (gnus-article-edit-article
3770    'ignore
3771    `(lambda (no-highlight)
3772       'ignore
3773       (gnus-summary-edit-article-done
3774        ,(or (mail-header-references gnus-current-headers) "")
3775        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
3776
3777 (defun gnus-article-edit-article (start-func exit-func)
3778   "Start editing the contents of the current article buffer."
3779   (let ((winconf (current-window-configuration)))
3780     (set-buffer gnus-article-buffer)
3781     (gnus-article-edit-mode)
3782     (funcall start-func)
3783     ;;(gnus-article-delete-text-of-type 'annotation)
3784     ;;(gnus-set-text-properties (point-min) (point-max) nil)
3785     (gnus-configure-windows 'edit-article)
3786     (setq gnus-article-edit-done-function exit-func)
3787     (setq gnus-prev-winconf winconf)
3788     (when gnus-article-edit-article-setup-function
3789       (funcall gnus-article-edit-article-setup-function))
3790     (gnus-message 6 "C-c C-c to end edits")))
3791
3792 (defun gnus-article-edit-done (&optional arg)
3793   "Update the article edits and exit."
3794   (interactive "P")
3795   (save-excursion
3796     (save-restriction
3797       (widen)
3798       (when (article-goto-body)
3799         (let ((lines (count-lines (point) (point-max)))
3800               (length (- (point-max) (point)))
3801               (case-fold-search t)
3802               (body (copy-marker (point))))
3803           (goto-char (point-min))
3804           (when (re-search-forward "^content-length:[ \t]\\([0-9]+\\)" body t)
3805             (delete-region (match-beginning 1) (match-end 1))
3806             (insert (number-to-string length)))
3807           (goto-char (point-min))
3808           (when (re-search-forward
3809                  "^x-content-length:[ \t]\\([0-9]+\\)" body t)
3810             (delete-region (match-beginning 1) (match-end 1))
3811             (insert (number-to-string length)))
3812           (goto-char (point-min))
3813           (when (re-search-forward "^lines:[ \t]\\([0-9]+\\)" body t)
3814             (delete-region (match-beginning 1) (match-end 1))
3815             (insert (number-to-string lines)))))))
3816   (let ((func gnus-article-edit-done-function)
3817         (buf (current-buffer))
3818         (start (window-start)))
3819     (remove-hook 'gnus-article-mode-hook
3820                  'gnus-article-mime-edit-article-unwind)
3821     (gnus-article-edit-exit)
3822     (save-excursion
3823       (set-buffer buf)
3824       (let ((buffer-read-only nil))
3825         (funcall func arg))
3826       ;; The cache and backlog have to be flushed somewhat.
3827       (when gnus-keep-backlog
3828         (gnus-backlog-remove-article
3829          (car gnus-article-current) (cdr gnus-article-current)))
3830       ;; Flush original article as well.
3831       (save-excursion
3832         (when (get-buffer gnus-original-article-buffer)
3833           (set-buffer gnus-original-article-buffer)
3834           (setq gnus-original-article nil)))
3835       (when gnus-use-cache
3836         (gnus-cache-update-article
3837          (car gnus-article-current) (cdr gnus-article-current))))
3838     (set-buffer buf)
3839     (set-window-start (get-buffer-window buf) start)
3840     (set-window-point (get-buffer-window buf) (point))))
3841
3842 (defun gnus-article-edit-exit ()
3843   "Exit the article editing without updating."
3844   (interactive)
3845   ;; We remove all text props from the article buffer.
3846   (let ((buf (format "%s" (buffer-string)))
3847         (curbuf (current-buffer))
3848         (p (point))
3849         (window-start (window-start)))
3850     (erase-buffer)
3851     (insert buf)
3852     (let ((winconf gnus-prev-winconf))
3853       (gnus-article-mode)
3854       (set-window-configuration winconf)
3855       ;; Tippy-toe some to make sure that point remains where it was.
3856       (save-current-buffer
3857         (set-buffer curbuf)
3858         (set-window-start (get-buffer-window (current-buffer)) window-start)
3859         (goto-char p)))))
3860
3861 (defun gnus-article-edit-full-stops ()
3862   "Interactively repair spacing at end of sentences."
3863   (interactive)
3864   (save-excursion
3865     (goto-char (point-min))
3866     (search-forward-regexp "^$" nil t)
3867     (let ((case-fold-search nil))
3868       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
3869
3870 ;;;
3871 ;;; Article editing with MIME-Edit
3872 ;;;
3873
3874 (defcustom gnus-article-mime-edit-article-setup-hook nil
3875   "Hook run after setting up a MIME editing article buffer."
3876   :group 'gnus-article-various
3877   :type 'hook)
3878
3879 (defun gnus-article-mime-edit-article-unwind ()
3880   "Unwind `gnus-article-buffer' if article editing was given up."
3881   (remove-hook 'gnus-article-mode-hook 'gnus-article-mime-edit-article-unwind)
3882   (when mime-edit-mode-flag
3883     (mime-edit-exit 'nomime 'no-error)
3884     (message ""))
3885   (when (featurep 'font-lock)
3886     (setq font-lock-defaults nil)
3887     (font-lock-mode 0)))
3888
3889 (defun gnus-article-mime-edit-article-setup ()
3890   "Convert current buffer to MIME-Edit buffer and turn on MIME-Edit mode
3891 after replacing with the original article."
3892   (setq gnus-show-mime t)
3893   (setq gnus-article-edit-done-function
3894         `(lambda (&rest args)
3895            (when mime-edit-mode-flag
3896              (mime-edit-exit)
3897              (message ""))
3898            (goto-char (point-min))
3899            (let (case-fold-search)
3900              (when (re-search-forward
3901                     (format "^%s$" (regexp-quote mail-header-separator))
3902                     nil t)
3903                (replace-match "")))
3904            (when (featurep 'font-lock)
3905              (setq font-lock-defaults nil)
3906              (font-lock-mode 0))
3907            (apply ,gnus-article-edit-done-function args)
3908            (set-buffer gnus-original-article-buffer)
3909            (erase-buffer)
3910            (insert-buffer gnus-article-buffer)
3911            (setq gnus-current-headers (gnus-article-make-full-mail-header))
3912            (gnus-article-prepare-display)))
3913   (substitute-key-definition
3914    'gnus-article-edit-exit 'gnus-article-mime-edit-exit
3915    gnus-article-edit-mode-map)
3916   (erase-buffer)
3917   (insert-buffer gnus-original-article-buffer)
3918   (mime-edit-again)
3919   (when (featurep 'font-lock)
3920     (set (make-local-variable 'font-lock-defaults)
3921          '(message-font-lock-keywords t))
3922     (font-lock-set-defaults)
3923     (turn-on-font-lock))
3924   (add-hook 'gnus-article-mode-hook 'gnus-article-mime-edit-article-unwind)
3925   (gnus-run-hooks 'gnus-article-mime-edit-article-setup-hook))
3926
3927 (defun gnus-article-mime-edit-exit ()
3928   "Exit the article MIME editing without updating."
3929   (interactive)
3930   (let ((winconf gnus-prev-winconf)
3931         buf)
3932     (when mime-edit-mode-flag
3933       (mime-edit-exit)
3934       (message ""))
3935     (goto-char (point-min))
3936     (let (case-fold-search)
3937       (when (re-search-forward
3938              (format "^%s$" (regexp-quote mail-header-separator)) nil t)
3939         (replace-match "")))
3940     (when (featurep 'font-lock)
3941       (setq font-lock-defaults nil)
3942       (font-lock-mode 0))
3943     ;; We remove all text props from the article buffer.
3944     (setq buf (format "%s" (buffer-string)))
3945     (set-buffer (get-buffer-create gnus-original-article-buffer))
3946     (erase-buffer)
3947     (insert buf)
3948     (setq gnus-current-headers (gnus-article-make-full-mail-header))
3949     (gnus-article-prepare-display)
3950     (set-window-configuration winconf)))
3951
3952 ;;;
3953 ;;; Article highlights
3954 ;;;
3955
3956 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
3957
3958 ;;; Internal Variables:
3959
3960 (defcustom gnus-button-url-regexp "\\b\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\):\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?\\([-a-zA-Z0-9_=!?#$@~`%&*+|\\/:;.,]\\|\\w\\)+\\([-a-zA-Z0-9_=#$@~`%&*+|\\/]\\|\\w\\)"
3961   "Regular expression that matches URLs."
3962   :group 'gnus-article-buttons
3963   :type 'regexp)
3964
3965 (defcustom gnus-button-alist
3966   `(("<\\(url:[>\n\t ]*?\\)?news:[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
3967      0 t gnus-button-message-id 2)
3968     ("\\bnews:\\([^>\n\t ]*@[^>)!;:,\n\t ]*\\)" 0 t gnus-button-message-id 1)
3969     ("\\(\\b<\\(url:[>\n\t ]*\\)?news:[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
3970      1 t
3971      gnus-button-fetch-group 4)
3972     ("\\bnews:\\(//\\)?\\([^'\">\n\t ]+\\)" 0 t gnus-button-fetch-group 2)
3973     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)" 2
3974      t gnus-button-message-id 3)
3975     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>" 0 t gnus-url-mailto 2)
3976     ("mailto:\\([-a-zA-Z.@_+0-9%]+\\)" 0 t gnus-url-mailto 1)
3977     ("\\bmailto:\\([^ \n\t]+\\)" 0 t gnus-url-mailto 1)
3978     ;; This is how URLs _should_ be embedded in text...
3979     ("<URL: *\\([^>]*\\)>" 0 t gnus-button-embedded-url 1)
3980     ;; Raw URLs.
3981     (,gnus-button-url-regexp 0 t gnus-button-url 0))
3982   "*Alist of regexps matching buttons in article bodies.
3983
3984 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
3985 REGEXP: is the string matching text around the button,
3986 BUTTON: is the number of the regexp grouping actually matching the button,
3987 FORM: is a lisp expression which must eval to true for the button to
3988 be added,
3989 CALLBACK: is the function to call when the user push this button, and each
3990 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
3991
3992 CALLBACK can also be a variable, in that case the value of that
3993 variable it the real callback function."
3994   :group 'gnus-article-buttons
3995   :type '(repeat (list regexp
3996                        (integer :tag "Button")
3997                        (sexp :tag "Form")
3998                        (function :tag "Callback")
3999                        (repeat :tag "Par"
4000                                :inline t
4001                                (integer :tag "Regexp group")))))
4002
4003 (defcustom gnus-header-button-alist
4004   `(("^\\(References\\|Message-I[Dd]\\):" "<[^>]+>"
4005      0 t gnus-button-message-id 0)
4006     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$" 1 t gnus-button-reply 1)
4007     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
4008      0 t gnus-button-mailto 0)
4009     ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
4010     ("^Subject:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
4011     ("^[^:]+:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
4012     ("^[^:]+:" "\\(<\\(url: \\)?news:\\([^>\n ]*\\)>\\)" 1 t
4013      gnus-button-message-id 3))
4014   "*Alist of headers and regexps to match buttons in article heads.
4015
4016 This alist is very similar to `gnus-button-alist', except that each
4017 alist has an additional HEADER element first in each entry:
4018
4019 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
4020
4021 HEADER is a regexp to match a header.  For a fuller explanation, see
4022 `gnus-button-alist'."
4023   :group 'gnus-article-buttons
4024   :group 'gnus-article-headers
4025   :type '(repeat (list (regexp :tag "Header")
4026                        regexp
4027                        (integer :tag "Button")
4028                        (sexp :tag "Form")
4029                        (function :tag "Callback")
4030                        (repeat :tag "Par"
4031                                :inline t
4032                                (integer :tag "Regexp group")))))
4033
4034 (defvar gnus-button-regexp nil)
4035 (defvar gnus-button-marker-list nil)
4036 ;; Regexp matching any of the regexps from `gnus-button-alist'.
4037
4038 (defvar gnus-button-last nil)
4039 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
4040
4041 ;;; Commands:
4042
4043 (defun gnus-article-push-button (event)
4044   "Check text under the mouse pointer for a callback function.
4045 If the text under the mouse pointer has a `gnus-callback' property,
4046 call it with the value of the `gnus-data' text property."
4047   (interactive "e")
4048   (set-buffer (window-buffer (posn-window (event-start event))))
4049   (let* ((pos (posn-point (event-start event)))
4050          (data (get-text-property pos 'gnus-data))
4051          (fun (get-text-property pos 'gnus-callback)))
4052     (goto-char pos)
4053     (when fun
4054       (funcall fun data))))
4055
4056 (defun gnus-article-press-button ()
4057   "Check text at point for a callback function.
4058 If the text at point has a `gnus-callback' property,
4059 call it with the value of the `gnus-data' text property."
4060   (interactive)
4061   (let* ((data (get-text-property (point) 'gnus-data))
4062          (fun (get-text-property (point) 'gnus-callback)))
4063     (when fun
4064       (funcall fun data))))
4065
4066 (defun gnus-article-prev-button (n)
4067   "Move point to N buttons backward.
4068 If N is negative, move forward instead."
4069   (interactive "p")
4070   (gnus-article-next-button (- n)))
4071
4072 (defun gnus-article-next-button (n)
4073   "Move point to N buttons forward.
4074 If N is negative, move backward instead."
4075   (interactive "p")
4076   (let ((function (if (< n 0) 'previous-single-property-change
4077                     'next-single-property-change))
4078         (inhibit-point-motion-hooks t)
4079         (backward (< n 0))
4080         (limit (if (< n 0) (point-min) (point-max))))
4081     (setq n (abs n))
4082     (while (and (not (= limit (point)))
4083                 (> n 0))
4084       ;; Skip past the current button.
4085       (when (get-text-property (point) 'gnus-callback)
4086         (goto-char (funcall function (point) 'gnus-callback nil limit)))
4087       ;; Go to the next (or previous) button.
4088       (gnus-goto-char (funcall function (point) 'gnus-callback nil limit))
4089       ;; Put point at the start of the button.
4090       (when (and backward (not (get-text-property (point) 'gnus-callback)))
4091         (goto-char (funcall function (point) 'gnus-callback nil limit)))
4092       ;; Skip past intangible buttons.
4093       (when (get-text-property (point) 'intangible)
4094         (incf n))
4095       (decf n))
4096     (unless (zerop n)
4097       (gnus-message 5 "No more buttons"))
4098     n))
4099
4100 (defun gnus-article-highlight (&optional force)
4101   "Highlight current article.
4102 This function calls `gnus-article-highlight-headers',
4103 `gnus-article-highlight-citation',
4104 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4105 do the highlighting.  See the documentation for those functions."
4106   (interactive (list 'force))
4107   (gnus-article-highlight-headers)
4108   (gnus-article-highlight-citation force)
4109   (gnus-article-highlight-signature)
4110   (gnus-article-add-buttons force)
4111   (gnus-article-add-buttons-to-head))
4112
4113 (defun gnus-article-highlight-some (&optional force)
4114   "Highlight current article.
4115 This function calls `gnus-article-highlight-headers',
4116 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4117 do the highlighting.  See the documentation for those functions."
4118   (interactive (list 'force))
4119   (gnus-article-highlight-headers)
4120   (gnus-article-highlight-signature)
4121   (gnus-article-add-buttons))
4122
4123 (defun gnus-article-highlight-headers ()
4124   "Highlight article headers as specified by `gnus-header-face-alist'."
4125   (interactive)
4126   (save-excursion
4127     (set-buffer gnus-article-buffer)
4128     (save-restriction
4129       (let ((alist gnus-header-face-alist)
4130             (buffer-read-only nil)
4131             (case-fold-search t)
4132             (inhibit-point-motion-hooks t)
4133             entry regexp header-face field-face from hpoints fpoints)
4134         (article-narrow-to-head)
4135         (while (setq entry (pop alist))
4136           (goto-char (point-min))
4137           (setq regexp (concat "^\\("
4138                                (if (string-equal "" (nth 0 entry))
4139                                    "[^\t ]"
4140                                  (nth 0 entry))
4141                                "\\)")
4142                 header-face (nth 1 entry)
4143                 field-face (nth 2 entry))
4144           (while (and (re-search-forward regexp nil t)
4145                       (not (eobp)))
4146             (beginning-of-line)
4147             (setq from (point))
4148             (unless (search-forward ":" nil t)
4149               (forward-char 1))
4150             (when (and header-face
4151                        (not (memq (point) hpoints)))
4152               (push (point) hpoints)
4153               (gnus-put-text-property from (point) 'face header-face))
4154             (when (and field-face
4155                        (not (memq (setq from (point)) fpoints)))
4156               (push from fpoints)
4157               (if (re-search-forward "^[^ \t]" nil t)
4158                   (forward-char -2)
4159                 (goto-char (point-max)))
4160               (gnus-put-text-property from (point) 'face field-face))))))))
4161
4162 (defun gnus-article-highlight-signature ()
4163   "Highlight the signature in an article.
4164 It does this by highlighting everything after
4165 `gnus-signature-separator' using `gnus-signature-face'."
4166   (interactive)
4167   (save-excursion
4168     (set-buffer gnus-article-buffer)
4169     (let ((buffer-read-only nil)
4170           (inhibit-point-motion-hooks t))
4171       (save-restriction
4172         (when (and gnus-signature-face
4173                    (gnus-article-narrow-to-signature))
4174           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
4175                             'face gnus-signature-face)
4176           (widen)
4177           (gnus-article-search-signature)
4178           (let ((start (match-beginning 0))
4179                 (end (set-marker (make-marker) (1+ (match-end 0)))))
4180             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
4181                                      end)))))))
4182
4183 (defun gnus-button-in-region-p (b e prop)
4184   "Say whether PROP exists in the region."
4185   (text-property-not-all b e prop nil))
4186
4187 (defun gnus-article-add-buttons (&optional force)
4188   "Find external references in the article and make buttons of them.
4189 \"External references\" are things like Message-IDs and URLs, as
4190 specified by `gnus-button-alist'."
4191   (interactive (list 'force))
4192   (save-excursion
4193     (set-buffer gnus-article-buffer)
4194     (let ((buffer-read-only nil)
4195           (inhibit-point-motion-hooks t)
4196           (case-fold-search t)
4197           (alist gnus-button-alist)
4198           beg entry regexp)
4199       ;; Remove all old markers.
4200       (let (marker entry)
4201         (while (setq marker (pop gnus-button-marker-list))
4202           (goto-char marker)
4203           (when (setq entry (gnus-button-entry))
4204             (put-text-property (match-beginning (nth 1 entry))
4205                                (match-end (nth 1 entry))
4206                                'gnus-callback nil))
4207           (set-marker marker nil)))
4208       ;; We skip the headers.
4209       (article-goto-body)
4210       (setq beg (point))
4211       (while (setq entry (pop alist))
4212         (setq regexp (car entry))
4213         (goto-char beg)
4214         (while (re-search-forward regexp nil t)
4215           (let* ((start (and entry (match-beginning (nth 1 entry))))
4216                  (end (and entry (match-end (nth 1 entry))))
4217                  (from (match-beginning 0)))
4218             (when (and (or (eq t (nth 2 entry))
4219                            (eval (nth 2 entry)))
4220                        (not (gnus-button-in-region-p
4221                              start end 'gnus-callback)))
4222               ;; That optional form returned non-nil, so we add the
4223               ;; button.
4224               (gnus-article-add-button
4225                start end 'gnus-button-push
4226                (car (push (set-marker (make-marker) from)
4227                           gnus-button-marker-list))))))))))
4228
4229 ;; Add buttons to the head of an article.
4230 (defun gnus-article-add-buttons-to-head ()
4231   "Add buttons to the head of the article."
4232   (interactive)
4233   (save-excursion
4234     (set-buffer gnus-article-buffer)
4235     (save-restriction
4236       (let ((buffer-read-only nil)
4237             (inhibit-point-motion-hooks t)
4238             (case-fold-search t)
4239             (alist gnus-header-button-alist)
4240             entry beg end)
4241         (article-narrow-to-head)
4242         (while alist
4243           ;; Each alist entry.
4244           (setq entry (car alist)
4245                 alist (cdr alist))
4246           (goto-char (point-min))
4247           (while (re-search-forward (car entry) nil t)
4248             ;; Each header matching the entry.
4249             (setq beg (match-beginning 0))
4250             (setq end (or (and (re-search-forward "^[^ \t]" nil t)
4251                                (match-beginning 0))
4252                           (point-max)))
4253             (goto-char beg)
4254             (while (re-search-forward (nth 1 entry) end t)
4255               ;; Each match within a header.
4256               (let* ((entry (cdr entry))
4257                      (start (match-beginning (nth 1 entry)))
4258                      (end (match-end (nth 1 entry)))
4259                      (form (nth 2 entry)))
4260                 (goto-char (match-end 0))
4261                 (when (eval form)
4262                   (gnus-article-add-button
4263                    start end (nth 3 entry)
4264                    (buffer-substring (match-beginning (nth 4 entry))
4265                                      (match-end (nth 4 entry)))))))
4266             (goto-char end)))))))
4267
4268 ;;; External functions:
4269
4270 (defun gnus-article-add-button (from to fun &optional data)
4271   "Create a button between FROM and TO with callback FUN and data DATA."
4272   (when gnus-article-button-face
4273     (gnus-overlay-put (gnus-make-overlay from to)
4274                       'face gnus-article-button-face))
4275   (gnus-add-text-properties
4276    from to
4277    (nconc (and gnus-article-mouse-face
4278                (list gnus-mouse-face-prop gnus-article-mouse-face))
4279           (list 'gnus-callback fun)
4280           (and data (list 'gnus-data data)))))
4281
4282 ;;; Internal functions:
4283
4284 (defun gnus-article-set-globals ()
4285   (save-excursion
4286     (set-buffer gnus-summary-buffer)
4287     (gnus-set-global-variables)))
4288
4289 (defun gnus-signature-toggle (end)
4290   (save-excursion
4291     (set-buffer gnus-article-buffer)
4292     (let ((buffer-read-only nil)
4293           (inhibit-point-motion-hooks t))
4294       (if (get-text-property end 'invisible)
4295           (gnus-article-unhide-text end (point-max))
4296         (gnus-article-hide-text end (point-max) gnus-hidden-properties)))))
4297
4298 (defun gnus-button-entry ()
4299   ;; Return the first entry in `gnus-button-alist' matching this place.
4300   (let ((alist gnus-button-alist)
4301         (entry nil))
4302     (while alist
4303       (setq entry (pop alist))
4304       (if (looking-at (car entry))
4305           (setq alist nil)
4306         (setq entry nil)))
4307     entry))
4308
4309 (defun gnus-button-push (marker)
4310   ;; Push button starting at MARKER.
4311   (save-excursion
4312     (goto-char marker)
4313     (let* ((entry (gnus-button-entry))
4314            (inhibit-point-motion-hooks t)
4315            (fun (nth 3 entry))
4316            (args (mapcar (lambda (group)
4317                            (let ((string (match-string group)))
4318                              (gnus-set-text-properties
4319                               0 (length string) nil string)
4320                              string))
4321                          (nthcdr 4 entry))))
4322       (cond
4323        ((fboundp fun)
4324         (apply fun args))
4325        ((and (boundp fun)
4326              (fboundp (symbol-value fun)))
4327         (apply (symbol-value fun) args))
4328        (t
4329         (gnus-message 1 "You must define `%S' to use this button"
4330                       (cons fun args)))))))
4331
4332 (defun gnus-button-message-id (message-id)
4333   "Fetch MESSAGE-ID."
4334   (save-excursion
4335     (set-buffer gnus-summary-buffer)
4336     (gnus-summary-refer-article message-id)))
4337
4338 (defun gnus-button-fetch-group (address)
4339   "Fetch GROUP specified by ADDRESS."
4340   (if (not (string-match "[:/]" address))
4341       ;; This is just a simple group url.
4342       (gnus-group-read-ephemeral-group address gnus-select-method)
4343     (if (not (string-match "^\\([^:/]+\\)\\(:\\([^/]+\\)/\\)?\\(.*\\)$"
4344                            address))
4345         (error "Can't parse %s" address)
4346       (gnus-group-read-ephemeral-group
4347        (match-string 4 address)
4348        `(nntp ,(match-string 1 address)
4349               (nntp-address ,(match-string 1 address))
4350               (nntp-port-number ,(if (match-end 3)
4351                                      (match-string 3 address)
4352                                    "nntp")))))))
4353
4354 (defun gnus-url-parse-query-string (query &optional downcase)
4355   (let (retval pairs cur key val)
4356     (setq pairs (split-string query "&"))
4357     (while pairs
4358       (setq cur (car pairs)
4359             pairs (cdr pairs))
4360       (if (not (string-match "=" cur))
4361           nil                           ; Grace
4362         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
4363               val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
4364         (if downcase
4365             (setq key (downcase key)))
4366         (setq cur (assoc key retval))
4367         (if cur
4368             (setcdr cur (cons val (cdr cur)))
4369           (setq retval (cons (list key val) retval)))))
4370     retval))
4371
4372 (defun gnus-url-unhex (x)
4373   (if (> x ?9)
4374       (if (>= x ?a)
4375           (+ 10 (- x ?a))
4376         (+ 10 (- x ?A)))
4377     (- x ?0)))
4378
4379 (defun gnus-url-unhex-string (str &optional allow-newlines)
4380   "Remove %XXX embedded spaces, etc in a url.
4381 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
4382 decoding of carriage returns and line feeds in the string, which is normally
4383 forbidden in URL encoding."
4384   (setq str (or str ""))
4385   (let ((tmp "")
4386         (case-fold-search t))
4387     (while (string-match "%[0-9a-f][0-9a-f]" str)
4388       (let* ((start (match-beginning 0))
4389              (ch1 (gnus-url-unhex (elt str (+ start 1))))
4390              (code (+ (* 16 ch1)
4391                       (gnus-url-unhex (elt str (+ start 2))))))
4392         (setq tmp (concat
4393                    tmp (substring str 0 start)
4394                    (cond
4395                     (allow-newlines
4396                      (char-to-string code))
4397                     ((or (= code ?\n) (= code ?\r))
4398                      " ")
4399                     (t (char-to-string code))))
4400               str (substring str (match-end 0)))))
4401     (setq tmp (concat tmp str))
4402     tmp))
4403
4404 (defun gnus-url-mailto (url)
4405   ;; Send mail to someone
4406   (when (string-match "mailto:/*\\(.*\\)" url)
4407     (setq url (substring url (match-beginning 1) nil)))
4408   (let (to args subject func)
4409     (if (string-match (regexp-quote "?") url)
4410         (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
4411               args (gnus-url-parse-query-string
4412                     (substring url (match-end 0) nil) t))
4413       (setq to (gnus-url-unhex-string url)))
4414     (setq args (cons (list "to" to) args)
4415           subject (cdr-safe (assoc "subject" args)))
4416     (gnus-setup-message 'reply
4417       (message-mail)
4418       (while args
4419         (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
4420         (if (fboundp func)
4421             (funcall func)
4422           (message-position-on-field (caar args)))
4423         (insert (mapconcat 'identity (cdar args) ", "))
4424         (setq args (cdr args)))
4425       (if subject
4426           (message-goto-body)
4427         (message-goto-subject)))))
4428
4429 (defun gnus-button-mailto (address)
4430   ;; Mail to ADDRESS.
4431   (set-buffer (gnus-copy-article-buffer))
4432   (gnus-setup-message 'reply
4433     (message-reply address)))
4434
4435 (defun gnus-button-reply (address)
4436   ;; Reply to ADDRESS.
4437   (gnus-setup-message 'reply
4438     (message-reply address)))
4439
4440 (defun gnus-button-url (address)
4441   "Browse ADDRESS."
4442   ;; In Emacs 20, `browse-url-browser-function' may be an alist.
4443   (if (listp browse-url-browser-function)
4444       (browse-url address)
4445     (funcall browse-url-browser-function address)))
4446
4447 (defun gnus-button-embedded-url (address)
4448   "Browse ADDRESS."
4449   ;; In Emacs 20, `browse-url-browser-function' may be an alist.
4450   (if (listp browse-url-browser-function)
4451       (browse-url (gnus-strip-whitespace address))
4452     (funcall browse-url-browser-function (gnus-strip-whitespace address))))
4453
4454 ;;; Next/prev buttons in the article buffer.
4455
4456 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
4457 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
4458
4459 (defvar gnus-prev-page-map nil)
4460 (unless gnus-prev-page-map
4461   (setq gnus-prev-page-map (make-sparse-keymap))
4462   (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
4463   (define-key gnus-prev-page-map "\r" 'gnus-button-prev-page))
4464
4465 (defun gnus-insert-prev-page-button ()
4466   (let ((buffer-read-only nil))
4467     (gnus-eval-format
4468      gnus-prev-page-line-format nil
4469      `(gnus-prev t local-map ,gnus-prev-page-map
4470                  gnus-callback gnus-article-button-prev-page
4471                  article-type annotation))))
4472
4473 (defvar gnus-next-page-map nil)
4474 (unless gnus-next-page-map
4475   (setq gnus-next-page-map (make-keymap))
4476   (suppress-keymap gnus-prev-page-map)
4477   (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
4478   (define-key gnus-next-page-map "\r" 'gnus-button-next-page))
4479
4480 (defun gnus-button-next-page ()
4481   "Go to the next page."
4482   (interactive)
4483   (let ((win (selected-window)))
4484     (select-window (get-buffer-window gnus-article-buffer t))
4485     (gnus-article-next-page)
4486     (select-window win)))
4487
4488 (defun gnus-button-prev-page ()
4489   "Go to the prev page."
4490   (interactive)
4491   (let ((win (selected-window)))
4492     (select-window (get-buffer-window gnus-article-buffer t))
4493     (gnus-article-prev-page)
4494     (select-window win)))
4495
4496 (defun gnus-insert-next-page-button ()
4497   (let ((buffer-read-only nil))
4498     (gnus-eval-format gnus-next-page-line-format nil
4499                       `(gnus-next
4500                         t local-map ,gnus-next-page-map
4501                         gnus-callback gnus-article-button-next-page
4502                         article-type annotation))))
4503
4504 (defun gnus-article-button-next-page (arg)
4505   "Go to the next page."
4506   (interactive "P")
4507   (let ((win (selected-window)))
4508     (select-window (get-buffer-window gnus-article-buffer t))
4509     (gnus-article-next-page)
4510     (select-window win)))
4511
4512 (defun gnus-article-button-prev-page (arg)
4513   "Go to the prev page."
4514   (interactive "P")
4515   (let ((win (selected-window)))
4516     (select-window (get-buffer-window gnus-article-buffer t))
4517     (gnus-article-prev-page)
4518     (select-window win)))
4519
4520 (defvar gnus-decode-header-methods
4521   '(mail-decode-encoded-word-region)
4522   "List of methods used to decode headers.
4523
4524 This variable is a list of FUNCTION or (REGEXP . FUNCTION). If item is
4525 FUNCTION, FUNCTION will be apply to all newsgroups. If item is a
4526 (REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
4527 whose names match REGEXP.
4528
4529 For example:
4530 ((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
4531  mail-decode-encoded-word-region
4532  (\"chinese\" . rfc1843-decode-region))
4533 ")
4534
4535 (defvar gnus-decode-header-methods-cache nil)
4536
4537 (defun gnus-multi-decode-header (start end)
4538   "Apply the functions from `gnus-encoded-word-methods' that match."
4539   (unless (and gnus-decode-header-methods-cache
4540                (eq gnus-newsgroup-name
4541                    (car gnus-decode-header-methods-cache)))
4542     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
4543     (mapc '(lambda (x)
4544              (if (symbolp x)
4545                  (nconc gnus-decode-header-methods-cache (list x))
4546                (if (and gnus-newsgroup-name
4547                         (string-match (car x) gnus-newsgroup-name))
4548                    (nconc gnus-decode-header-methods-cache
4549                           (list (cdr x))))))
4550           gnus-decode-header-methods))
4551   (let ((xlist gnus-decode-header-methods-cache))
4552     (pop xlist)
4553     (save-restriction
4554       (narrow-to-region start end)
4555       (while xlist
4556         (funcall (pop xlist) (point-min) (point-max))))))
4557
4558 ;;;
4559 ;;; Treatment top-level handling.
4560 ;;;
4561
4562 (defun gnus-treat-article (condition &optional part-number total-parts type)
4563   (let ((length (- (point-max) (point-min)))
4564         (alist gnus-treatment-function-alist)
4565         (article-goto-body-goes-to-point-min-p t)
4566         (treated-type
4567          (or (not type)
4568              (catch 'found
4569                (let ((list gnus-article-treat-types))
4570                  (while list
4571                    (when (string-match (pop list) type)
4572                      (throw 'found t)))))))
4573         (highlightp (gnus-visual-p 'article-highlight 'highlight))
4574         val elem)
4575     (gnus-run-hooks 'gnus-part-display-hook)
4576     (while (setq elem (pop alist))
4577       (setq val (symbol-value (car elem)))
4578       (when (and (or (consp val)
4579                      treated-type)
4580                  (gnus-treat-predicate val)
4581                  (or (not (get (car elem) 'highlight))
4582                      highlightp))
4583         (save-restriction
4584           (funcall (cadr elem)))))))
4585
4586 ;; Dynamic variables.
4587 (defvar part-number)
4588 (defvar total-parts)
4589 (defvar type)
4590 (defvar condition)
4591 (defvar length)
4592 (defun gnus-treat-predicate (val)
4593   (cond
4594    (condition
4595     (eq condition val))
4596    ((null val)
4597     nil)
4598    ((eq val t)
4599     t)
4600    ((eq val 'head)
4601     nil)
4602    ((eq val 'last)
4603     (eq part-number total-parts))
4604    ((numberp val)
4605     (< length val))
4606    ((listp val)
4607     (let ((pred (pop val)))
4608       (cond
4609        ((eq pred 'or)
4610         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
4611        ((eq pred 'and)
4612         (apply 'gnus-and (mapcar 'gnus-tread-predicate val)))
4613        ((eq pred 'not)
4614         (not (gnus-treat-predicate val)))
4615        ((eq pred 'typep)
4616         (equal (cadr val) type))
4617        (t
4618         (error "%S is not a valid predicate" pred)))))
4619    (t
4620     (error "%S is not a valid value" val))))
4621
4622
4623 ;;; @ for mime-view
4624 ;;;
4625
4626 (defun gnus-article-header-presentation-method (entity situation)
4627   (mime-insert-header entity)
4628   )
4629
4630 (set-alist 'mime-header-presentation-method-alist
4631            'gnus-original-article-mode
4632            #'gnus-article-header-presentation-method)
4633
4634 (defun gnus-mime-preview-quitting-method ()
4635   (mime-preview-kill-buffer)
4636   (delete-other-windows)
4637   (gnus-article-show-summary)
4638   (gnus-summary-select-article gnus-show-all-headers t))
4639
4640 (set-alist 'mime-preview-quitting-method-alist
4641            'gnus-original-article-mode #'gnus-mime-preview-quitting-method)
4642
4643 (defun gnus-following-method (buf)
4644   (set-buffer buf)
4645   (message-followup)
4646   (message-yank-original)
4647   (kill-buffer buf)
4648   (goto-char (point-min))
4649   )
4650
4651 (set-alist 'mime-preview-following-method-alist
4652            'gnus-original-article-mode #'gnus-following-method)
4653
4654 (set-alist 'mime-preview-over-to-previous-method-alist
4655            'gnus-original-article-mode
4656            (lambda ()
4657              (gnus-article-read-summary-keys
4658               nil (gnus-character-to-event ?P))))
4659
4660 (set-alist 'mime-preview-over-to-next-method-alist
4661            'gnus-original-article-mode'
4662            (lambda ()
4663              (gnus-article-read-summary-keys
4664               nil (gnus-character-to-event ?N))))
4665
4666
4667 ;;; @ end
4668 ;;;
4669
4670 (gnus-ems-redefine)
4671
4672 (provide 'gnus-art)
4673
4674 (run-hooks 'gnus-art-load-hook)
4675
4676 ;;; gnus-art.el ends here