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

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