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, 2002, 2003
   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
  30   (require 'cl)
  31   (defvar tool-bar-map))
  32
  33 (require 'gnus)
  34 (require 'gnus-sum)
  35 (require 'gnus-spec)
  36 (require 'gnus-int)
  37 (require 'gnus-win)
  38 (require 'mm-bodies)
  39 (require 'mail-parse)
  40 (require 'mm-decode)
  41 (require 'mm-view)
  42 (require 'wid-edit)
  43 (require 'mm-uu)
  44 (require 'message)
  45
  46 (autoload 'gnus-msg-mail "gnus-msg" nil t)
  47 (autoload 'gnus-button-mailto "gnus-msg")
  48 (autoload 'gnus-button-reply "gnus-msg" nil t)
  49
  50 (defgroup gnus-article nil
  51   "Article display."
  52   :link '(custom-manual "(gnus)The Article Buffer")
  53   :group 'gnus)
  54
  55 (defgroup gnus-article-treat nil
  56   "Treating article parts."
  57   :link '(custom-manual "(gnus)Article Hiding")
  58   :group 'gnus-article)
  59
  60 (defgroup gnus-article-hiding nil
  61   "Hiding article parts."
  62   :link '(custom-manual "(gnus)Article Hiding")
  63   :group 'gnus-article)
  64
  65 (defgroup gnus-article-highlight nil
  66   "Article highlighting."
  67   :link '(custom-manual "(gnus)Article Highlighting")
  68   :group 'gnus-article
  69   :group 'gnus-visual)
  70
  71 (defgroup gnus-article-signature nil
  72   "Article signatures."
  73   :link '(custom-manual "(gnus)Article Signature")
  74   :group 'gnus-article)
  75
  76 (defgroup gnus-article-headers nil
  77   "Article headers."
  78   :link '(custom-manual "(gnus)Hiding Headers")
  79   :group 'gnus-article)
  80
  81 (defgroup gnus-article-washing nil
  82   "Special commands on articles."
  83   :link '(custom-manual "(gnus)Article Washing")
  84   :group 'gnus-article)
  85
  86 (defgroup gnus-article-emphasis nil
  87   "Fontisizing articles."
  88   :link '(custom-manual "(gnus)Article Fontisizing")
  89   :group 'gnus-article)
  90
  91 (defgroup gnus-article-saving nil
  92   "Saving articles."
  93   :link '(custom-manual "(gnus)Saving Articles")
  94   :group 'gnus-article)
  95
  96 (defgroup gnus-article-mime nil
  97   "Worshiping the MIME wonder."
  98   :link '(custom-manual "(gnus)Using MIME")
  99   :group 'gnus-article)
 100
 101 (defgroup gnus-article-buttons nil
 102   "Pushable buttons in the article buffer."
 103   :link '(custom-manual "(gnus)Article Buttons")
 104   :group 'gnus-article)
 105
 106 (defgroup gnus-article-various nil
 107   "Other article options."
 108   :link '(custom-manual "(gnus)Misc Article")
 109   :group 'gnus-article)
 110
 111 (defcustom gnus-ignored-headers
 112   (mapcar
 113    (lambda (header)
 114      (concat "^" header ":"))
 115    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
 116      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
 117      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
 118      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
 119      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
 120      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
 121      "X-Attribution" "X-Originating-IP" "Delivered-To"
 122      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
 123      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
 124      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
 125      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
 126      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
 127      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
 128      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
 129      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
 130      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
 131      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
 132      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
 133      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
 134      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
 135      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
 136      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
 137      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
 138      "List-[A-Za-z]+" "X-Listprocessor-Version"
 139      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
 140      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
 141      "X-Received" "Content-length" "X-precedence"
 142      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
 143      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
 144      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
 145      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
 146      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
 147      "X-Content-length" "X-Posting-Agent" "Original-Received"
 148      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
 149      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
 150      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
 151      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
 152      "X-Abuse-and-DMCA-Info" "X-Postfilter"))
 153   "*All headers that start with this regexp will be hidden.
 154 This variable can also be a list of regexps of headers to be ignored.
 155 If `gnus-visible-headers' is non-nil, this variable will be ignored."
 156   :type '(choice :custom-show nil
 157                  regexp
 158                  (repeat regexp))
 159   :group 'gnus-article-hiding)
 160
 161 (defcustom gnus-visible-headers
 162   "^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:"
 163   "*All headers that do not match this regexp will be hidden.
 164 This variable can also be a list of regexp of headers to remain visible.
 165 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
 166   :type '(repeat :value-to-internal (lambda (widget value)
 167                                       (custom-split-regexp-maybe value))
 168                  :match (lambda (widget value)
 169                           (or (stringp value)
 170                               (widget-editable-list-match widget value)))
 171                  regexp)
 172   :group 'gnus-article-hiding)
 173
 174 (defcustom gnus-sorted-header-list
 175   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
 176     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
 177   "*This variable is a list of regular expressions.
 178 If it is non-nil, headers that match the regular expressions will
 179 be placed first in the article buffer in the sequence specified by
 180 this list."
 181   :type '(repeat regexp)
 182   :group 'gnus-article-hiding)
 183
 184 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
 185   "Headers that are only to be displayed if they have interesting data.
 186 Possible values in this list are:
 187
 188   'empty       Headers with no content.
 189   'newsgroups  Newsgroup identical to Gnus group.
 190   'to-address  To identical to To-address.
 191   'to-list     To identical to To-list.
 192   'cc-list     CC identical to To-list.
 193   'followup-to Followup-to identical to Newsgroups.
 194   'reply-to    Reply-to identical to From.
 195   'date        Date less than four days old.
 196   'long-to     To and/or Cc longer than 1024 characters.
 197   'many-to     Multiple To and/or Cc."
 198   :type '(set (const :tag "Headers with no content." empty)
 199               (const :tag "Newsgroups identical to Gnus group." newsgroups)
 200               (const :tag "To identical to To-address." to-address)
 201               (const :tag "To identical to To-list." to-list)
 202               (const :tag "CC identical to To-list." cc-list)
 203               (const :tag "Followup-to identical to Newsgroups." followup-to)
 204               (const :tag "Reply-to identical to From." reply-to)
 205               (const :tag "Date less than four days old." date)
 206               (const :tag "To and/or Cc longer than 1024 characters." long-to)
 207               (const :tag "Multiple To and/or Cc headers." many-to))
 208   :group 'gnus-article-hiding)
 209
 210 (defcustom gnus-article-skip-boring nil
 211   "Skip over text that is not worth reading.
 212 By default, if you set this t, then Gnus will display citations and
 213 signatures, but will never scroll down to show you a page consisting
 214 only of boring text.  Boring text is controlled by
 215 `gnus-article-boring-faces'."
 216   :type 'boolean
 217   :group 'gnus-article-hiding)
 218
 219 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
 220   "Regexp matching signature separator.
 221 This can also be a list of regexps.  In that case, it will be checked
 222 from head to tail looking for a separator.  Searches will be done from
 223 the end of the buffer."
 224   :type '(repeat string)
 225   :group 'gnus-article-signature)
 226
 227 (defcustom gnus-signature-limit nil
 228   "Provide a limit to what is considered a signature.
 229 If it is a number, no signature may not be longer (in characters) than
 230 that number.  If it is a floating point number, no signature may be
 231 longer (in lines) than that number.  If it is a function, the function
 232 will be called without any parameters, and if it returns nil, there is
 233 no signature in the buffer.  If it is a string, it will be used as a
 234 regexp.  If it matches, the text in question is not a signature."
 235   :type '(choice (integer :value 200)
 236                  (number :value 4.0)
 237                  (function :value fun)
 238                  (regexp :value ".*"))
 239   :group 'gnus-article-signature)
 240
 241 (defcustom gnus-hidden-properties '(invisible t intangible t)
 242   "Property list to use for hiding text."
 243   :type 'sexp
 244   :group 'gnus-article-hiding)
 245
 246 ;; Fixme: This isn't the right thing for mixed graphical and and
 247 ;; non-graphical frames in a session.
 248 (defcustom gnus-article-x-face-command
 249   (if (featurep 'xemacs)
 250       (if (or (gnus-image-type-available-p 'xface)
 251               (gnus-image-type-available-p 'pbm))
 252           'gnus-display-x-face-in-from
 253         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
 254     (if (gnus-image-type-available-p 'pbm)
 255         'gnus-display-x-face-in-from
 256       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
 257 display -"))
 258   "*String or function to be executed to display an X-Face header.
 259 If it is a string, the command will be executed in a sub-shell
 260 asynchronously.  The compressed face will be piped to this command."
 261   :type `(choice string
 262                  (function-item gnus-display-x-face-in-from)
 263                  function)
 264   :version "21.1"
 265   :group 'gnus-picon
 266   :group 'gnus-article-washing)
 267
 268 (defcustom gnus-article-x-face-too-ugly nil
 269   "Regexp matching posters whose face shouldn't be shown automatically."
 270   :type '(choice regexp (const nil))
 271   :group 'gnus-article-washing)
 272
 273 (defcustom gnus-article-banner-alist nil
 274   "Banner alist for stripping.
 275 For example,
 276      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
 277   :version "21.1"
 278   :type '(repeat (cons symbol regexp))
 279   :group 'gnus-article-washing)
 280
 281 (gnus-define-group-parameter
 282  banner
 283  :variable-document
 284  "Alist of regexps (to match group names) and banner."
 285  :variable-group gnus-article-washing
 286  :parameter-type
 287  '(choice :tag "Banner"
 288           :value nil
 289           (const :tag "Remove signature" signature)
 290           (symbol :tag "Item in `gnus-article-banner-alist'" none)
 291           regexp
 292           (const :tag "None" nil))
 293  :parameter-document
 294  "If non-nil, specify how to remove `banners' from articles.
 295
 296 Symbol `signature' means to remove signatures delimited by
 297 `gnus-signature-separator'.  Any other symbol is used to look up a
 298 regular expression to match the banner in `gnus-article-banner-alist'.
 299 A string is used as a regular expression to match the banner
 300 directly.")
 301
 302 (defcustom gnus-article-address-banner-alist nil
 303   "Alist of mail addresses and banners.
 304 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
 305 to match a mail address in the From: header, BANNER is one of a symbol
 306 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
 307 If ADDRESS matches author's mail address, it will remove things like
 308 advertisements.  For example:
 309
 310 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
 311 "
 312   :type '(repeat
 313           (cons
 314            (regexp :tag "Address")
 315            (choice :tag "Banner" :value nil
 316                    (const :tag "Remove signature" signature)
 317                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
 318                    regexp
 319                    (const :tag "None" nil))))
 320   :group 'gnus-article-washing)
 321
 322 (defcustom gnus-emphasis-alist
 323   (let ((format
 324          "\\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)")
 325         (types
 326          '(("\\*" "\\*" bold)
 327            ("_" "_" underline)
 328            ("/" "/" italic)
 329            ("_/" "/_" underline-italic)
 330            ("_\\*" "\\*_" underline-bold)
 331            ("\\*/" "/\\*" bold-italic)
 332            ("_\\*/" "/\\*_" underline-bold-italic))))
 333     `(,@(mapcar
 334          (lambda (spec)
 335            (list
 336             (format format (car spec) (cadr spec))
 337             2 3 (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
 338          types)
 339         ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
 340          2 3 gnus-emphasis-strikethru)
 341         ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
 342          2 3 gnus-emphasis-underline)))
 343   "*Alist that says how to fontify certain phrases.
 344 Each item looks like this:
 345
 346   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
 347
 348 The first element is a regular expression to be matched.  The second
 349 is a number that says what regular expression grouping used to find
 350 the entire emphasized word.  The third is a number that says what
 351 regexp grouping should be displayed and highlighted.  The fourth
 352 is the face used for highlighting."
 353   :type '(repeat (list :value ("" 0 0 default)
 354                        regexp
 355                        (integer :tag "Match group")
 356                        (integer :tag "Emphasize group")
 357                        face))
 358   :group 'gnus-article-emphasis)
 359
 360 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
 361   "A regexp to describe whitespace which should not be emphasized.
 362 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
 363 The former avoids underlining of leading and trailing whitespace,
 364 and the latter avoids underlining any whitespace at all."
 365   :version "21.1"
 366   :group 'gnus-article-emphasis
 367   :type 'regexp)
 368
 369 (defface gnus-emphasis-bold '((t (:bold t)))
 370   "Face used for displaying strong emphasized text (*word*)."
 371   :group 'gnus-article-emphasis)
 372
 373 (defface gnus-emphasis-italic '((t (:italic t)))
 374   "Face used for displaying italic emphasized text (/word/)."
 375   :group 'gnus-article-emphasis)
 376
 377 (defface gnus-emphasis-underline '((t (:underline t)))
 378   "Face used for displaying underlined emphasized text (_word_)."
 379   :group 'gnus-article-emphasis)
 380
 381 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
 382   "Face used for displaying underlined bold emphasized text (_*word*_)."
 383   :group 'gnus-article-emphasis)
 384
 385 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
 386   "Face used for displaying underlined italic emphasized text (_/word/_)."
 387   :group 'gnus-article-emphasis)
 388
 389 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
 390   "Face used for displaying bold italic emphasized text (/*word*/)."
 391   :group 'gnus-article-emphasis)
 392
 393 (defface gnus-emphasis-underline-bold-italic
 394   '((t (:bold t :italic t :underline t)))
 395   "Face used for displaying underlined bold italic emphasized text.
 396 Example: (_/*word*/_)."
 397   :group 'gnus-article-emphasis)
 398
 399 (defface gnus-emphasis-strikethru '((t (:strikethru t)))
 400   "Face used for displaying strike-through text (-word-)."
 401   :group 'gnus-article-emphasis)
 402
 403 (defface gnus-emphasis-highlight-words
 404   '((t (:background "black" :foreground "yellow")))
 405   "Face used for displaying highlighted words."
 406   :group 'gnus-article-emphasis)
 407
 408 (defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
 409   "Format for display of Date headers in article bodies.
 410 See `format-time-string' for the possible values.
 411
 412 The variable can also be function, which should return a complete Date
 413 header.  The function is called with one argument, the time, which can
 414 be fed to `format-time-string'."
 415   :type '(choice string symbol)
 416   :link '(custom-manual "(gnus)Article Date")
 417   :group 'gnus-article-washing)
 418
 419 (eval-and-compile
 420   (autoload 'mail-extract-address-components "mail-extr"))
 421
 422 (defcustom gnus-save-all-headers t
 423   "*If non-nil, don't remove any headers before saving."
 424   :group 'gnus-article-saving
 425   :type 'boolean)
 426
 427 (defcustom gnus-prompt-before-saving 'always
 428   "*This variable says how much prompting is to be done when saving articles.
 429 If it is nil, no prompting will be done, and the articles will be
 430 saved to the default files.  If this variable is `always', each and
 431 every article that is saved will be preceded by a prompt, even when
 432 saving large batches of articles.  If this variable is neither nil not
 433 `always', there the user will be prompted once for a file name for
 434 each invocation of the saving commands."
 435   :group 'gnus-article-saving
 436   :type '(choice (item always)
 437                  (item :tag "never" nil)
 438                  (sexp :tag "once" :format "%t\n" :value t)))
 439
 440 (defcustom gnus-saved-headers gnus-visible-headers
 441   "Headers to keep if `gnus-save-all-headers' is nil.
 442 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
 443 If that variable is nil, however, all headers that match this regexp
 444 will be kept while the rest will be deleted before saving."
 445   :group 'gnus-article-saving
 446   :type 'regexp)
 447
 448 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
 449   "A function to save articles in your favourite format.
 450 The function must be interactively callable (in other words, it must
 451 be an Emacs command).
 452
 453 Gnus provides the following functions:
 454
 455 * gnus-summary-save-in-rmail (Rmail format)
 456 * gnus-summary-save-in-mail (Unix mail format)
 457 * gnus-summary-save-in-folder (MH folder)
 458 * gnus-summary-save-in-file (article format)
 459 * gnus-summary-save-body-in-file (article body)
 460 * gnus-summary-save-in-vm (use VM's folder format)
 461 * gnus-summary-write-to-file (article format -- overwrite)."
 462   :group 'gnus-article-saving
 463   :type '(radio (function-item gnus-summary-save-in-rmail)
 464                 (function-item gnus-summary-save-in-mail)
 465                 (function-item gnus-summary-save-in-folder)
 466                 (function-item gnus-summary-save-in-file)
 467                 (function-item gnus-summary-save-body-in-file)
 468                 (function-item gnus-summary-save-in-vm)
 469                 (function-item gnus-summary-write-to-file)))
 470
 471 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
 472   "A function generating a file name to save articles in Rmail format.
 473 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 474   :group 'gnus-article-saving
 475   :type 'function)
 476
 477 (defcustom gnus-mail-save-name 'gnus-plain-save-name
 478   "A function generating a file name to save articles in Unix mail format.
 479 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 480   :group 'gnus-article-saving
 481   :type 'function)
 482
 483 (defcustom gnus-folder-save-name 'gnus-folder-save-name
 484   "A function generating a file name to save articles in MH folder.
 485 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
 486   :group 'gnus-article-saving
 487   :type 'function)
 488
 489 (defcustom gnus-file-save-name 'gnus-numeric-save-name
 490   "A function generating a file name to save articles in article format.
 491 The function is called with NEWSGROUP, HEADERS, and optional
 492 LAST-FILE."
 493   :group 'gnus-article-saving
 494   :type 'function)
 495
 496 (defcustom gnus-split-methods
 497   '((gnus-article-archive-name)
 498     (gnus-article-nndoc-name))
 499   "*Variable used to suggest where articles are to be saved.
 500 For instance, if you would like to save articles related to Gnus in
 501 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
 502 you could set this variable to something like:
 503
 504  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
 505    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
 506
 507 This variable is an alist where the where the key is the match and the
 508 value is a list of possible files to save in if the match is non-nil.
 509
 510 If the match is a string, it is used as a regexp match on the
 511 article.  If the match is a symbol, that symbol will be funcalled
 512 from the buffer of the article to be saved with the newsgroup as the
 513 parameter.  If it is a list, it will be evaled in the same buffer.
 514
 515 If this form or function returns a string, this string will be used as
 516 a possible file name; and if it returns a non-nil list, that list will
 517 be used as possible file names."
 518   :group 'gnus-article-saving
 519   :type '(repeat (choice (list :value (fun) function)
 520                          (cons :value ("" "") regexp (repeat string))
 521                          (sexp :value nil))))
 522
 523 (defcustom gnus-page-delimiter "^\^L"
 524   "*Regexp describing what to use as article page delimiters.
 525 The default value is \"^\^L\", which is a form linefeed at the
 526 beginning of a line."
 527   :type 'regexp
 528   :group 'gnus-article-various)
 529
 530 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
 531   "*The format specification for the article mode line.
 532 See `gnus-summary-mode-line-format' for a closer description.
 533
 534 The following additional specs are available:
 535
 536 %w  The article washing status.
 537 %m  The number of MIME parts in the article."
 538   :type 'string
 539   :group 'gnus-article-various)
 540
 541 (defcustom gnus-article-mode-hook nil
 542   "*A hook for Gnus article mode."
 543   :type 'hook
 544   :group 'gnus-article-various)
 545
 546 (when (featurep 'xemacs)
 547   ;; Extracted from gnus-xmas-define in order to preserve user settings
 548   (when (fboundp 'turn-off-scroll-in-place)
 549     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
 550   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
 551   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
 552
 553 (defcustom gnus-article-menu-hook nil
 554   "*Hook run after the creation of the article mode menu."
 555   :type 'hook
 556   :group 'gnus-article-various)
 557
 558 (defcustom gnus-article-prepare-hook nil
 559   "*A hook called after an article has been prepared in the article buffer."
 560   :type 'hook
 561   :group 'gnus-article-various)
 562
 563 (make-obsolete-variable 'gnus-article-hide-pgp-hook
 564                         "This variable is obsolete in Gnus 5.10.")
 565
 566 (defcustom gnus-article-button-face 'bold
 567   "Face used for highlighting buttons in the article buffer.
 568
 569 An article button is a piece of text that you can activate by pressing
 570 `RET' or `mouse-2' above it."
 571   :type 'face
 572   :group 'gnus-article-buttons)
 573
 574 (defcustom gnus-article-mouse-face 'highlight
 575   "Face used for mouse highlighting in the article buffer.
 576
 577 Article buttons will be displayed in this face when the cursor is
 578 above them."
 579   :type 'face
 580   :group 'gnus-article-buttons)
 581
 582 (defcustom gnus-signature-face 'gnus-signature-face
 583   "Face used for highlighting a signature in the article buffer.
 584 Obsolete; use the face `gnus-signature-face' for customizations instead."
 585   :type 'face
 586   :group 'gnus-article-highlight
 587   :group 'gnus-article-signature)
 588
 589 (defface gnus-signature-face
 590   '((t
 591      (:italic t)))
 592   "Face used for highlighting a signature in the article buffer."
 593   :group 'gnus-article-highlight
 594   :group 'gnus-article-signature)
 595
 596 (defface gnus-header-from-face
 597   '((((class color)
 598       (background dark))
 599      (:foreground "spring green"))
 600     (((class color)
 601       (background light))
 602      (:foreground "red3"))
 603     (t
 604      (:italic t)))
 605   "Face used for displaying from headers."
 606   :group 'gnus-article-headers
 607   :group 'gnus-article-highlight)
 608
 609 (defface gnus-header-subject-face
 610   '((((class color)
 611       (background dark))
 612      (:foreground "SeaGreen3"))
 613     (((class color)
 614       (background light))
 615      (:foreground "red4"))
 616     (t
 617      (:bold t :italic t)))
 618   "Face used for displaying subject headers."
 619   :group 'gnus-article-headers
 620   :group 'gnus-article-highlight)
 621
 622 (defface gnus-header-newsgroups-face
 623   '((((class color)
 624       (background dark))
 625      (:foreground "yellow" :italic t))
 626     (((class color)
 627       (background light))
 628      (:foreground "MidnightBlue" :italic t))
 629     (t
 630      (:italic t)))
 631   "Face used for displaying newsgroups headers."
 632   :group 'gnus-article-headers
 633   :group 'gnus-article-highlight)
 634
 635 (defface gnus-header-name-face
 636   '((((class color)
 637       (background dark))
 638      (:foreground "SeaGreen"))
 639     (((class color)
 640       (background light))
 641      (:foreground "maroon"))
 642     (t
 643      (:bold t)))
 644   "Face used for displaying header names."
 645   :group 'gnus-article-headers
 646   :group 'gnus-article-highlight)
 647
 648 (defface gnus-header-content-face
 649   '((((class color)
 650       (background dark))
 651      (:foreground "forest green" :italic t))
 652     (((class color)
 653       (background light))
 654      (:foreground "indianred4" :italic t))
 655     (t
 656      (:italic t)))  "Face used for displaying header content."
 657   :group 'gnus-article-headers
 658   :group 'gnus-article-highlight)
 659
 660 (defcustom gnus-header-face-alist
 661   '(("From" nil gnus-header-from-face)
 662     ("Subject" nil gnus-header-subject-face)
 663     ("Newsgroups:.*," nil gnus-header-newsgroups-face)
 664     ("" gnus-header-name-face gnus-header-content-face))
 665   "*Controls highlighting of article header.
 666
 667 An alist of the form (HEADER NAME CONTENT).
 668
 669 HEADER is a regular expression which should match the name of an
 670 header header and NAME and CONTENT are either face names or nil.
 671
 672 The name of each header field will be displayed using the face
 673 specified by the first element in the list where HEADER match the
 674 header name and NAME is non-nil.  Similarly, the content will be
 675 displayed by the first non-nil matching CONTENT face."
 676   :group 'gnus-article-headers
 677   :group 'gnus-article-highlight
 678   :type '(repeat (list (regexp :tag "Header")
 679                        (choice :tag "Name"
 680                                (item :tag "skip" nil)
 681                                (face :value default))
 682                        (choice :tag "Content"
 683                                (item :tag "skip" nil)
 684                                (face :value default)))))
 685
 686 (defcustom gnus-article-decode-hook
 687   '(article-decode-charset article-decode-encoded-words
 688                            article-decode-group-name article-decode-idna-rhs)
 689   "*Hook run to decode charsets in articles."
 690   :group 'gnus-article-headers
 691   :type 'hook)
 692
 693 (defcustom gnus-display-mime-function 'gnus-display-mime
 694   "Function to display MIME articles."
 695   :group 'gnus-article-mime
 696   :type 'function)
 697
 698 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
 699   "Function used to decode headers.")
 700
 701 (defvar gnus-article-dumbquotes-map
 702   '(("\200" "EUR")
 703     ("\202" ",")
 704     ("\203" "f")
 705     ("\204" ",,")
 706     ("\205" "...")
 707     ("\213" "<")
 708     ("\214" "OE")
 709     ("\221" "`")
 710     ("\222" "'")
 711     ("\223" "``")
 712     ("\224" "\"")
 713     ("\225" "*")
 714     ("\226" "-")
 715     ("\227" "--")
 716     ("\230" "~")
 717     ("\231" "(TM)")
 718     ("\233" ">")
 719     ("\234" "oe")
 720     ("\264" "'"))
 721   "Table for MS-to-Latin1 translation.")
 722
 723 (defcustom gnus-ignored-mime-types nil
 724   "List of MIME types that should be ignored by Gnus."
 725   :version "21.1"
 726   :group 'gnus-article-mime
 727   :type '(repeat regexp))
 728
 729 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
 730   "List of MIME types that should not be given buttons when rendered inline.
 731 See also `gnus-buttonized-mime-types' which may override this variable.
 732 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
 733   :version "21.1"
 734   :group 'gnus-article-mime
 735   :type '(repeat regexp))
 736
 737 (defcustom gnus-buttonized-mime-types nil
 738   "List of MIME types that should be given buttons when rendered inline.
 739 If set, this variable overrides `gnus-unbuttonized-mime-types'.
 740 To see e.g. security buttons you could set this to
 741 `(\"multipart/signed\")'.
 742 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
 743   :version "21.1"
 744   :group 'gnus-article-mime
 745   :type '(repeat regexp))
 746
 747 (defcustom gnus-inhibit-mime-unbuttonizing nil
 748   "If non-nil, all MIME parts get buttons.
 749 When nil (the default value), then some MIME parts do not get buttons,
 750 as described by the variables `gnus-buttonized-mime-types' and
 751 `gnus-unbuttonized-mime-types'."
 752   :version "21.3"
 753   :type 'boolean)
 754
 755 (defcustom gnus-body-boundary-delimiter "_"
 756   "String used to delimit header and body.
 757 This variable is used by `gnus-article-treat-body-boundary' which can
 758 be controlled by `gnus-treat-body-boundary'."
 759   :group 'gnus-article-various
 760   :type '(choice (item :tag "None" :value nil)
 761                  string))
 762
 763 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces")
 764   "Defines the location of the faces database.
 765 For information on obtaining this database of pretty pictures, please
 766 see http://www.cs.indiana.edu/picons/ftp/index.html"
 767   :type '(repeat directory)
 768   :link '(url-link :tag "download"
 769                    "http://www.cs.indiana.edu/picons/ftp/index.html")
 770   :link '(custom-manual "(gnus)Picons")
 771   :group 'gnus-picon)
 772
 773 (defun gnus-picons-installed-p ()
 774   "Say whether picons are installed on your machine."
 775   (let ((installed nil))
 776     (dolist (database gnus-picon-databases)
 777       (when (file-exists-p database)
 778         (setq installed t)))
 779     installed))
 780
 781 (defcustom gnus-article-mime-part-function nil
 782   "Function called with a MIME handle as the argument.
 783 This is meant for people who want to do something automatic based
 784 on parts -- for instance, adding Vcard info to a database."
 785   :group 'gnus-article-mime
 786   :type 'function)
 787
 788 (defcustom gnus-mime-multipart-functions nil
 789   "An alist of MIME types to functions to display them."
 790   :version "21.1"
 791   :group 'gnus-article-mime
 792   :type 'alist)
 793
 794 (defcustom gnus-article-date-lapsed-new-header nil
 795   "Whether the X-Sent and Date headers can coexist.
 796 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
 797 either replace the old \"Date:\" header (if this variable is nil), or
 798 be added below it (otherwise)."
 799   :version "21.1"
 800   :group 'gnus-article-headers
 801   :type 'boolean)
 802
 803 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
 804   "Function called with a MIME handle as the argument.
 805 This is meant for people who want to view first matched part.
 806 For `undisplayed-alternative' (default), the first undisplayed
 807 part or alternative part is used.  For `undisplayed', the first
 808 undisplayed part is used.  For a function, the first part which
 809 the function return t is used.  For nil, the first part is
 810 used."
 811   :version "21.1"
 812   :group 'gnus-article-mime
 813   :type '(choice
 814           (item :tag "first" :value nil)
 815           (item :tag "undisplayed" :value undisplayed)
 816           (item :tag "undisplayed or alternative"
 817                 :value undisplayed-alternative)
 818           (function)))
 819
 820 (defcustom gnus-mime-action-alist
 821   '(("save to file" . gnus-mime-save-part)
 822     ("save and strip" . gnus-mime-save-part-and-strip)
 823     ("delete part" . gnus-mime-delete-part)
 824     ("display as text" . gnus-mime-inline-part)
 825     ("view the part" . gnus-mime-view-part)
 826     ("pipe to command" . gnus-mime-pipe-part)
 827     ("toggle display" . gnus-article-press-button)
 828     ("toggle display" . gnus-article-view-part-as-charset)
 829     ("view as type" . gnus-mime-view-part-as-type)
 830     ("view internally" . gnus-mime-view-part-internally)
 831     ("view externally" . gnus-mime-view-part-externally))
 832   "An alist of actions that run on the MIME attachment."
 833   :group 'gnus-article-mime
 834   :type '(repeat (cons (string :tag "name")
 835                        (function))))
 836
 837 ;;;
 838 ;;; The treatment variables
 839 ;;;
 840
 841 (defvar gnus-part-display-hook nil
 842   "Hook called on parts that are to receive treatment.")
 843
 844 (defvar gnus-article-treat-custom
 845   '(choice (const :tag "Off" nil)
 846            (const :tag "On" t)
 847            (const :tag "Header" head)
 848            (const :tag "Last" last)
 849            (integer :tag "Less")
 850            (repeat :tag "Groups" regexp)
 851            (sexp :tag "Predicate")))
 852
 853 (defvar gnus-article-treat-head-custom
 854   '(choice (const :tag "Off" nil)
 855            (const :tag "Header" head)))
 856
 857 (defvar gnus-article-treat-types '("text/plain")
 858   "Parts to treat.")
 859
 860 (defvar gnus-inhibit-treatment nil
 861   "Whether to inhibit treatment.")
 862
 863 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
 864   "Highlight the signature.
 865 Valid values are nil, t, `head', `last', an integer or a predicate.
 866 See Info node `(gnus)Customizing Articles'."
 867   :group 'gnus-article-treat
 868   :link '(custom-manual "(gnus)Customizing Articles")
 869   :type gnus-article-treat-custom)
 870 (put 'gnus-treat-highlight-signature 'highlight t)
 871
 872 (defcustom gnus-treat-buttonize 100000
 873   "Add buttons.
 874 Valid values are nil, t, `head', `last', an integer or a predicate.
 875 See Info node `(gnus)Customizing Articles'."
 876   :group 'gnus-article-treat
 877   :link '(custom-manual "(gnus)Customizing Articles")
 878   :type gnus-article-treat-custom)
 879 (put 'gnus-treat-buttonize 'highlight t)
 880
 881 (defcustom gnus-treat-buttonize-head 'head
 882   "Add buttons to the head.
 883 Valid values are nil, t, `head', `last', an integer or a predicate.
 884 See Info node `(gnus)Customizing Articles' for details."
 885   :group 'gnus-article-treat
 886   :link '(custom-manual "(gnus)Customizing Articles")
 887   :type gnus-article-treat-head-custom)
 888 (put 'gnus-treat-buttonize-head 'highlight t)
 889
 890 (defcustom gnus-treat-emphasize
 891   (and (or window-system
 892            (featurep 'xemacs)
 893            (>= (string-to-number emacs-version) 21))
 894        50000)
 895   "Emphasize text.
 896 Valid values are nil, t, `head', `last', an integer or a predicate.
 897 See Info node `(gnus)Customizing Articles' for details."
 898   :group 'gnus-article-treat
 899   :link '(custom-manual "(gnus)Customizing Articles")
 900   :type gnus-article-treat-custom)
 901 (put 'gnus-treat-emphasize 'highlight t)
 902
 903 (defcustom gnus-treat-strip-cr nil
 904   "Remove carriage returns.
 905 Valid values are nil, t, `head', `last', an integer or a predicate.
 906 See Info node `(gnus)Customizing Articles' for details."
 907   :group 'gnus-article-treat
 908   :link '(custom-manual "(gnus)Customizing Articles")
 909   :type gnus-article-treat-custom)
 910
 911 (defcustom gnus-treat-unsplit-urls nil
 912   "Remove newlines from within URLs.
 913 Valid values are nil, t, `head', `last', an integer or a predicate.
 914 See Info node `(gnus)Customizing Articles' for details."
 915   :group 'gnus-article-treat
 916   :link '(custom-manual "(gnus)Customizing Articles")
 917   :type gnus-article-treat-custom)
 918
 919 (defcustom gnus-treat-leading-whitespace nil
 920   "Remove leading whitespace in headers.
 921 Valid values are nil, t, `head', `last', an integer or a predicate.
 922 See Info node `(gnus)Customizing Articles' for details."
 923   :group 'gnus-article-treat
 924   :link '(custom-manual "(gnus)Customizing Articles")
 925   :type gnus-article-treat-custom)
 926
 927 (defcustom gnus-treat-hide-headers 'head
 928   "Hide headers.
 929 Valid values are nil, t, `head', `last', an integer or a predicate.
 930 See Info node `(gnus)Customizing Articles' for details."
 931   :group 'gnus-article-treat
 932   :link '(custom-manual "(gnus)Customizing Articles")
 933   :type gnus-article-treat-head-custom)
 934
 935 (defcustom gnus-treat-hide-boring-headers nil
 936   "Hide boring headers.
 937 Valid values are nil, t, `head', `last', an integer or a predicate.
 938 See Info node `(gnus)Customizing Articles' for details."
 939   :group 'gnus-article-treat
 940   :link '(custom-manual "(gnus)Customizing Articles")
 941   :type gnus-article-treat-head-custom)
 942
 943 (defcustom gnus-treat-hide-signature nil
 944   "Hide the signature.
 945 Valid values are nil, t, `head', `last', an integer or a predicate.
 946 See Info node `(gnus)Customizing Articles' for details."
 947   :group 'gnus-article-treat
 948   :link '(custom-manual "(gnus)Customizing Articles")
 949   :type gnus-article-treat-custom)
 950
 951 (defcustom gnus-treat-fill-article nil
 952   "Fill the article.
 953 Valid values are nil, t, `head', `last', an integer or a predicate.
 954 See Info node `(gnus)Customizing Articles' for details."
 955   :group 'gnus-article-treat
 956   :link '(custom-manual "(gnus)Customizing Articles")
 957   :type gnus-article-treat-custom)
 958
 959 (defcustom gnus-treat-hide-citation nil
 960   "Hide cited text.
 961 Valid values are nil, t, `head', `last', an integer or a predicate.
 962 See Info node `(gnus)Customizing Articles' for details."
 963   :group 'gnus-article-treat
 964   :link '(custom-manual "(gnus)Customizing Articles")
 965   :type gnus-article-treat-custom)
 966
 967 (defcustom gnus-treat-hide-citation-maybe nil
 968   "Hide cited text.
 969 Valid values are nil, t, `head', `last', an integer or a predicate.
 970 See Info node `(gnus)Customizing Articles' for details."
 971   :group 'gnus-article-treat
 972   :link '(custom-manual "(gnus)Customizing Articles")
 973   :type gnus-article-treat-custom)
 974
 975 (defcustom gnus-treat-strip-list-identifiers 'head
 976   "Strip list identifiers from `gnus-list-identifiers`.
 977 Valid values are nil, t, `head', `last', an integer or a predicate.
 978 See Info node `(gnus)Customizing Articles' for details."
 979   :version "21.1"
 980   :group 'gnus-article-treat
 981   :link '(custom-manual "(gnus)Customizing Articles")
 982   :type gnus-article-treat-custom)
 983
 984 (make-obsolete-variable 'gnus-treat-strip-pgp
 985                         "This option is obsolete in Gnus 5.10.")
 986
 987 (defcustom gnus-treat-strip-pem nil
 988   "Strip PEM signatures.
 989 Valid values are nil, t, `head', `last', an integer or a predicate.
 990 See Info node `(gnus)Customizing Articles' for details."
 991   :group 'gnus-article-treat
 992   :link '(custom-manual "(gnus)Customizing Articles")
 993   :type gnus-article-treat-custom)
 994
 995 (defcustom gnus-treat-strip-banner t
 996   "Strip banners from articles.
 997 The banner to be stripped is specified in the `banner' group parameter.
 998 Valid values are nil, t, `head', `last', an integer or a predicate.
 999 See Info node `(gnus)Customizing Articles' for details."
1000   :group 'gnus-article-treat
1001   :link '(custom-manual "(gnus)Customizing Articles")
1002   :type gnus-article-treat-custom)
1003
1004 (defcustom gnus-treat-highlight-headers 'head
1005   "Highlight the headers.
1006 Valid values are nil, t, `head', `last', an integer or a predicate.
1007 See Info node `(gnus)Customizing Articles' for details."
1008   :group 'gnus-article-treat
1009   :link '(custom-manual "(gnus)Customizing Articles")
1010   :type gnus-article-treat-head-custom)
1011 (put 'gnus-treat-highlight-headers 'highlight t)
1012
1013 (defcustom gnus-treat-highlight-citation t
1014   "Highlight cited text.
1015 Valid values are nil, t, `head', `last', an integer or a predicate.
1016 See Info node `(gnus)Customizing Articles' for details."
1017   :group 'gnus-article-treat
1018   :link '(custom-manual "(gnus)Customizing Articles")
1019   :type gnus-article-treat-custom)
1020 (put 'gnus-treat-highlight-citation 'highlight t)
1021
1022 (defcustom gnus-treat-date-ut nil
1023   "Display the Date in UT (GMT).
1024 Valid values are nil, t, `head', `last', an integer or a predicate.
1025 See Info node `(gnus)Customizing Articles' for details."
1026   :group 'gnus-article-treat
1027   :link '(custom-manual "(gnus)Customizing Articles")
1028   :type gnus-article-treat-head-custom)
1029
1030 (defcustom gnus-treat-date-local nil
1031   "Display the Date in the local timezone.
1032 Valid values are nil, t, `head', `last', an integer or a predicate.
1033 See Info node `(gnus)Customizing Articles' for details."
1034   :group 'gnus-article-treat
1035   :link '(custom-manual "(gnus)Customizing Articles")
1036   :type gnus-article-treat-head-custom)
1037
1038 (defcustom gnus-treat-date-english nil
1039   "Display the Date in a format that can be read aloud in English.
1040 Valid values are nil, t, `head', `last', an integer or a predicate.
1041 See Info node `(gnus)Customizing Articles' for details."
1042   :group 'gnus-article-treat
1043   :link '(custom-manual "(gnus)Customizing Articles")
1044   :type gnus-article-treat-head-custom)
1045
1046 (defcustom gnus-treat-date-lapsed nil
1047   "Display the Date header in a way that says how much time has elapsed.
1048 Valid values are nil, t, `head', `last', an integer or a predicate.
1049 See Info node `(gnus)Customizing Articles' for details."
1050   :group 'gnus-article-treat
1051   :link '(custom-manual "(gnus)Customizing Articles")
1052   :type gnus-article-treat-head-custom)
1053
1054 (defcustom gnus-treat-date-original nil
1055   "Display the date in the original timezone.
1056 Valid values are nil, t, `head', `last', an integer or a predicate.
1057 See Info node `(gnus)Customizing Articles' for details."
1058   :group 'gnus-article-treat
1059   :link '(custom-manual "(gnus)Customizing Articles")
1060   :type gnus-article-treat-head-custom)
1061
1062 (defcustom gnus-treat-date-iso8601 nil
1063   "Display the date in the ISO8601 format.
1064 Valid values are nil, t, `head', `last', an integer or a predicate.
1065 See Info node `(gnus)Customizing Articles' for details."
1066   :version "21.1"
1067   :group 'gnus-article-treat
1068   :link '(custom-manual "(gnus)Customizing Articles")
1069   :type gnus-article-treat-head-custom)
1070
1071 (defcustom gnus-treat-date-user-defined nil
1072   "Display the date in a user-defined format.
1073 The format is defined by the `gnus-article-time-format' variable.
1074 Valid values are nil, t, `head', `last', an integer or a predicate.
1075 See Info node `(gnus)Customizing Articles' for details."
1076   :group 'gnus-article-treat
1077   :link '(custom-manual "(gnus)Customizing Articles")
1078   :type gnus-article-treat-head-custom)
1079
1080 (defcustom gnus-treat-strip-headers-in-body t
1081   "Strip the X-No-Archive header line from the beginning of the body.
1082 Valid values are nil, t, `head', `last', an integer or a predicate.
1083 See Info node `(gnus)Customizing Articles' for details."
1084   :version "21.1"
1085   :group 'gnus-article-treat
1086   :link '(custom-manual "(gnus)Customizing Articles")
1087   :type gnus-article-treat-custom)
1088
1089 (defcustom gnus-treat-strip-trailing-blank-lines nil
1090   "Strip trailing blank lines.
1091 Valid values are nil, t, `head', `last', an integer or a predicate.
1092 See Info node `(gnus)Customizing Articles' for details."
1093   :group 'gnus-article-treat
1094   :link '(custom-manual "(gnus)Customizing Articles")
1095   :type gnus-article-treat-custom)
1096
1097 (defcustom gnus-treat-strip-leading-blank-lines nil
1098   "Strip leading blank lines.
1099 Valid values are nil, t, `head', `last', an integer or a predicate.
1100 See Info node `(gnus)Customizing Articles' for details."
1101   :group 'gnus-article-treat
1102   :link '(custom-manual "(gnus)Customizing Articles")
1103   :type gnus-article-treat-custom)
1104
1105 (defcustom gnus-treat-strip-multiple-blank-lines nil
1106   "Strip multiple blank lines.
1107 Valid values are nil, t, `head', `last', an integer or a predicate.
1108 See Info node `(gnus)Customizing Articles' for details."
1109   :group 'gnus-article-treat
1110   :link '(custom-manual "(gnus)Customizing Articles")
1111   :type gnus-article-treat-custom)
1112
1113 (defcustom gnus-treat-unfold-headers 'head
1114   "Unfold folded header lines.
1115 Valid values are nil, t, `head', `last', an integer or a predicate.
1116 See Info node `(gnus)Customizing Articles' for details."
1117   :group 'gnus-article-treat
1118   :link '(custom-manual "(gnus)Customizing Articles")
1119   :type gnus-article-treat-custom)
1120
1121 (defcustom gnus-treat-fold-headers nil
1122   "Fold headers.
1123 Valid values are nil, t, `head', `last', an integer or a predicate.
1124 See Info node `(gnus)Customizing Articles' for details."
1125   :group 'gnus-article-treat
1126   :link '(custom-manual "(gnus)Customizing Articles")
1127   :type gnus-article-treat-custom)
1128
1129 (defcustom gnus-treat-fold-newsgroups 'head
1130   "Fold the Newsgroups and Followup-To headers.
1131 Valid values are nil, t, `head', `last', an integer or a predicate.
1132 See Info node `(gnus)Customizing Articles' for details."
1133   :group 'gnus-article-treat
1134   :link '(custom-manual "(gnus)Customizing Articles")
1135   :type gnus-article-treat-custom)
1136
1137 (defcustom gnus-treat-overstrike t
1138   "Treat overstrike highlighting.
1139 Valid values are nil, t, `head', `last', an integer or a predicate.
1140 See Info node `(gnus)Customizing Articles' for details."
1141   :group 'gnus-article-treat
1142   :link '(custom-manual "(gnus)Customizing Articles")
1143   :type gnus-article-treat-custom)
1144 (put 'gnus-treat-overstrike 'highlight t)
1145
1146 (defcustom gnus-treat-display-xface
1147   (and (not noninteractive)
1148        (or (and (fboundp 'image-type-available-p)
1149                 (image-type-available-p 'xbm)
1150                 (string-match "^0x" (shell-command-to-string "uncompface"))
1151                 (executable-find "icontopbm"))
1152            (and (featurep 'xemacs)
1153                 (featurep 'xface)))
1154        'head)
1155   "Display X-Face headers.
1156 Valid values are nil, t, `head', `last', an integer or a predicate.
1157 See Info node `(gnus)Customizing Articles' and Info node
1158 `(gnus)X-Face' for details."
1159   :group 'gnus-article-treat
1160   :version "21.1"
1161   :link '(custom-manual "(gnus)Customizing Articles")
1162   :link '(custom-manual "(gnus)X-Face")
1163   :type gnus-article-treat-head-custom)
1164 (put 'gnus-treat-display-xface 'highlight t)
1165
1166 (defcustom gnus-treat-display-face
1167   (and (not noninteractive)
1168        (or (and (fboundp 'image-type-available-p)
1169                 (image-type-available-p 'png))
1170            (and (featurep 'xemacs)
1171                 (featurep 'png)))
1172        'head)
1173   "Display Face headers.
1174 Valid values are nil, t, `head', `last', an integer or a predicate.
1175 See Info node `(gnus)Customizing Articles' and Info node
1176 `(gnus)X-Face' for details."
1177   :group 'gnus-article-treat
1178   :version "21.1"
1179   :link '(custom-manual "(gnus)Customizing Articles")
1180   :link '(custom-manual "(gnus)X-Face")
1181   :type gnus-article-treat-head-custom)
1182 (put 'gnus-treat-display-xface 'highlight t)
1183
1184 (defcustom gnus-treat-display-smileys
1185   (if (or (and (featurep 'xemacs)
1186                (featurep 'xpm))
1187           (and (fboundp 'image-type-available-p)
1188                (image-type-available-p 'pbm)))
1189       t nil)
1190   "Display smileys.
1191 Valid values are nil, t, `head', `last', an integer or a predicate.
1192 See Info node `(gnus)Customizing Articles' and Info node
1193 `(gnus)Smileys' for details."
1194   :group 'gnus-article-treat
1195   :version "21.1"
1196   :link '(custom-manual "(gnus)Customizing Articles")
1197   :link '(custom-manual "(gnus)Smileys")
1198   :type gnus-article-treat-custom)
1199 (put 'gnus-treat-display-smileys 'highlight t)
1200
1201 (defcustom gnus-treat-from-picon
1202   (if (and (gnus-image-type-available-p 'xpm)
1203            (gnus-picons-installed-p))
1204       'head nil)
1205   "Display picons in the From header.
1206 Valid values are nil, t, `head', `last', an integer or a predicate.
1207 See Info node `(gnus)Customizing Articles' and Info node
1208 `(gnus)Picons' for details."
1209   :group 'gnus-article-treat
1210   :group 'gnus-picon
1211   :link '(custom-manual "(gnus)Customizing Articles")
1212   :link '(custom-manual "(gnus)Picons")
1213   :type gnus-article-treat-head-custom)
1214 (put 'gnus-treat-from-picon 'highlight t)
1215
1216 (defcustom gnus-treat-mail-picon
1217   (if (and (gnus-image-type-available-p 'xpm)
1218            (gnus-picons-installed-p))
1219       'head nil)
1220   "Display picons in To and Cc headers.
1221 Valid values are nil, t, `head', `last', an integer or a predicate.
1222 See Info node `(gnus)Customizing Articles' and Info node
1223 `(gnus)Picons' for details."
1224   :group 'gnus-article-treat
1225   :group 'gnus-picon
1226   :link '(custom-manual "(gnus)Customizing Articles")
1227   :link '(custom-manual "(gnus)Picons")
1228   :type gnus-article-treat-head-custom)
1229 (put 'gnus-treat-mail-picon 'highlight t)
1230
1231 (defcustom gnus-treat-newsgroups-picon
1232   (if (and (gnus-image-type-available-p 'xpm)
1233            (gnus-picons-installed-p))
1234       'head nil)
1235   "Display picons in the Newsgroups and Followup-To headers.
1236 Valid values are nil, t, `head', `last', an integer or a predicate.
1237 See Info node `(gnus)Customizing Articles' and Info node
1238 `(gnus)Picons' for details."
1239   :group 'gnus-article-treat
1240   :group 'gnus-picon
1241   :link '(custom-manual "(gnus)Customizing Articles")
1242   :link '(custom-manual "(gnus)Picons")
1243   :type gnus-article-treat-head-custom)
1244 (put 'gnus-treat-newsgroups-picon 'highlight t)
1245
1246 (defcustom gnus-treat-body-boundary
1247   (if (or gnus-treat-newsgroups-picon
1248           gnus-treat-mail-picon
1249           gnus-treat-from-picon)
1250       'head nil)
1251   "Draw a boundary at the end of the headers.
1252 Valid values are nil, t, `head', `last', an integer or a predicate.
1253 See Info node `(gnus)Customizing Articles' for details."
1254   :version "21.1"
1255   :group 'gnus-article-treat
1256   :link '(custom-manual "(gnus)Customizing Articles")
1257   :type gnus-article-treat-custom)
1258
1259 (defcustom gnus-treat-capitalize-sentences nil
1260   "Capitalize sentence-starting words.
1261 Valid values are nil, t, `head', `last', an integer or a predicate.
1262 See Info node `(gnus)Customizing Articles' for details."
1263   :version "21.1"
1264   :group 'gnus-article-treat
1265   :link '(custom-manual "(gnus)Customizing Articles")
1266   :type gnus-article-treat-custom)
1267
1268 (defcustom gnus-treat-wash-html nil
1269   "Format as HTML.
1270 Valid values are nil, t, `head', `last', an integer or a predicate.
1271 See Info node `(gnus)Customizing Articles' for details."
1272   :group 'gnus-article-treat
1273   :link '(custom-manual "(gnus)Customizing Articles")
1274   :type gnus-article-treat-custom)
1275
1276 (defcustom gnus-treat-fill-long-lines nil
1277   "Fill long lines.
1278 Valid values are nil, t, `head', `last', an integer or a predicate.
1279 See Info node `(gnus)Customizing Articles' for details."
1280   :group 'gnus-article-treat
1281   :link '(custom-manual "(gnus)Customizing Articles")
1282   :type gnus-article-treat-custom)
1283
1284 (defcustom gnus-treat-play-sounds nil
1285   "Play sounds.
1286 Valid values are nil, t, `head', `last', an integer or a predicate.
1287 See Info node `(gnus)Customizing Articles' for details."
1288   :version "21.1"
1289   :group 'gnus-article-treat
1290   :link '(custom-manual "(gnus)Customizing Articles")
1291   :type gnus-article-treat-custom)
1292
1293 (defcustom gnus-treat-translate nil
1294   "Translate articles from one language to another.
1295 Valid values are nil, t, `head', `last', an integer or a predicate.
1296 See Info node `(gnus)Customizing Articles' for details."
1297   :version "21.1"
1298   :group 'gnus-article-treat
1299   :link '(custom-manual "(gnus)Customizing Articles")
1300   :type gnus-article-treat-custom)
1301
1302 (defcustom gnus-treat-x-pgp-sig nil
1303   "Verify X-PGP-Sig.
1304 To automatically treat X-PGP-Sig, set it to head.
1305 Valid values are nil, t, `head', `last', an integer or a predicate.
1306 See Info node `(gnus)Customizing Articles' for details."
1307   :group 'gnus-article-treat
1308   :group 'mime-security
1309   :link '(custom-manual "(gnus)Customizing Articles")
1310   :type gnus-article-treat-custom)
1311
1312 (defvar gnus-article-encrypt-protocol-alist
1313   '(("PGP" . mml2015-self-encrypt)))
1314
1315 ;; Set to nil if more than one protocol added to
1316 ;; gnus-article-encrypt-protocol-alist.
1317 (defcustom gnus-article-encrypt-protocol "PGP"
1318   "The protocol used for encrypt articles.
1319 It is a string, such as \"PGP\". If nil, ask user."
1320   :type 'string
1321   :group 'mime-security)
1322
1323 (defvar gnus-article-wash-function nil
1324   "Function used for converting HTML into text.")
1325
1326 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1327                               (mm-coding-system-p 'utf-8))
1328   "Whether IDNA decoding of headers is used when viewing messages.
1329 This requires GNU Libidn, and by default only enabled if it is found."
1330   :group 'gnus-article-headers
1331   :type 'boolean)
1332
1333 (defcustom gnus-article-over-scroll nil
1334   "If non-nil, allow scrolling the article buffer even when there no more text."
1335   :group 'gnus-article
1336   :type 'boolean)
1337
1338 ;;; Internal variables
1339
1340 (defvar gnus-english-month-names
1341   '("January" "February" "March" "April" "May" "June" "July" "August"
1342     "September" "October" "November" "December"))
1343
1344 (defvar article-goto-body-goes-to-point-min-p nil)
1345 (defvar gnus-article-wash-types nil)
1346 (defvar gnus-article-emphasis-alist nil)
1347 (defvar gnus-article-image-alist nil)
1348
1349 (defvar gnus-article-mime-handle-alist-1 nil)
1350 (defvar gnus-treatment-function-alist
1351   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1352     (gnus-treat-strip-banner gnus-article-strip-banner)
1353     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1354     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1355     (gnus-treat-buttonize gnus-article-add-buttons)
1356     (gnus-treat-fill-article gnus-article-fill-cited-article)
1357     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
1358     (gnus-treat-strip-cr gnus-article-remove-cr)
1359     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1360     (gnus-treat-date-ut gnus-article-date-ut)
1361     (gnus-treat-date-local gnus-article-date-local)
1362     (gnus-treat-date-english gnus-article-date-english)
1363     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1364     (gnus-treat-date-original gnus-article-date-original)
1365     (gnus-treat-date-user-defined gnus-article-date-user)
1366     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1367     (gnus-treat-display-xface gnus-article-display-x-face)
1368     (gnus-treat-display-face gnus-article-display-face)
1369     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1370     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1371     (gnus-treat-hide-signature gnus-article-hide-signature)
1372     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1373     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1374     (gnus-treat-strip-pem gnus-article-hide-pem)
1375     (gnus-treat-from-picon gnus-treat-from-picon)
1376     (gnus-treat-mail-picon gnus-treat-mail-picon)
1377     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1378     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1379     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1380     (gnus-treat-strip-trailing-blank-lines
1381      gnus-article-remove-trailing-blank-lines)
1382     (gnus-treat-strip-leading-blank-lines
1383      gnus-article-strip-leading-blank-lines)
1384     (gnus-treat-strip-multiple-blank-lines
1385      gnus-article-strip-multiple-blank-lines)
1386     (gnus-treat-overstrike gnus-article-treat-overstrike)
1387     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1388     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1389     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1390     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1391     (gnus-treat-display-smileys gnus-treat-smiley)
1392     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1393     (gnus-treat-wash-html gnus-article-wash-html)
1394     (gnus-treat-emphasize gnus-article-emphasize)
1395     (gnus-treat-hide-citation gnus-article-hide-citation)
1396     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1397     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1398     (gnus-treat-body-boundary gnus-article-treat-body-boundary)
1399     (gnus-treat-play-sounds gnus-earcon-display)))
1400
1401 (defvar gnus-article-mime-handle-alist nil)
1402 (defvar article-lapsed-timer nil)
1403 (defvar gnus-article-current-summary nil)
1404
1405 (defvar gnus-article-mode-syntax-table
1406   (let ((table (copy-syntax-table text-mode-syntax-table)))
1407     ;; This causes the citation match run O(2^n).
1408     ;; (modify-syntax-entry ?- "w" table)
1409     (modify-syntax-entry ?> ")<" table)
1410     (modify-syntax-entry ?< "(>" table)
1411     ;; make M-. in article buffers work for `foo' strings
1412     (modify-syntax-entry ?' " " table)
1413     (modify-syntax-entry ?` " " table)
1414     table)
1415   "Syntax table used in article mode buffers.
1416 Initialized from `text-mode-syntax-table.")
1417
1418 (defvar gnus-save-article-buffer nil)
1419
1420 (defvar gnus-article-mode-line-format-alist
1421   (nconc '((?w (gnus-article-wash-status) ?s)
1422            (?m (gnus-article-mime-part-status) ?s))
1423          gnus-summary-mode-line-format-alist))
1424
1425 (defvar gnus-number-of-articles-to-be-saved nil)
1426
1427 (defvar gnus-inhibit-hiding nil)
1428
1429 ;;; Macros for dealing with the article buffer.
1430
1431 (defmacro gnus-with-article-headers (&rest forms)
1432   `(save-excursion
1433      (set-buffer gnus-article-buffer)
1434      (save-restriction
1435        (let ((buffer-read-only nil)
1436              (inhibit-point-motion-hooks t)
1437              (case-fold-search t))
1438          (article-narrow-to-head)
1439          ,@forms))))
1440
1441 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1442 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1443
1444 (defmacro gnus-with-article-buffer (&rest forms)
1445   `(save-excursion
1446      (set-buffer gnus-article-buffer)
1447      (let ((buffer-read-only nil))
1448        ,@forms)))
1449
1450 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1451 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1452
1453 (defun gnus-article-goto-header (header)
1454   "Go to HEADER, which is a regular expression."
1455   (re-search-forward (concat "^\\(" header "\\):") nil t))
1456
1457 (defsubst gnus-article-hide-text (b e props)
1458   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1459   (gnus-add-text-properties-when 'article-type nil b e props)
1460   (when (memq 'intangible props)
1461     (put-text-property
1462      (max (1- b) (point-min))
1463      b 'intangible (cddr (memq 'intangible props)))))
1464
1465 (defsubst gnus-article-unhide-text (b e)
1466   "Remove hidden text properties from region between B and E."
1467   (remove-text-properties b e gnus-hidden-properties)
1468   (when (memq 'intangible gnus-hidden-properties)
1469     (put-text-property (max (1- b) (point-min))
1470                        b 'intangible nil)))
1471
1472 (defun gnus-article-hide-text-type (b e type)
1473   "Hide text of TYPE between B and E."
1474   (gnus-add-wash-type type)
1475   (gnus-article-hide-text
1476    b e (cons 'article-type (cons type gnus-hidden-properties))))
1477
1478 (defun gnus-article-unhide-text-type (b e type)
1479   "Unhide text of TYPE between B and E."
1480   (gnus-delete-wash-type type)
1481   (remove-text-properties
1482    b e (cons 'article-type (cons type gnus-hidden-properties)))
1483   (when (memq 'intangible gnus-hidden-properties)
1484     (put-text-property (max (1- b) (point-min))
1485                        b 'intangible nil)))
1486
1487 (defun gnus-article-hide-text-of-type (type)
1488   "Hide text of TYPE in the current buffer."
1489   (save-excursion
1490     (let ((b (point-min))
1491           (e (point-max)))
1492       (while (setq b (text-property-any b e 'article-type type))
1493         (add-text-properties b (incf b) gnus-hidden-properties)))))
1494
1495 (defun gnus-article-delete-text-of-type (type)
1496   "Delete text of TYPE in the current buffer."
1497   (save-excursion
1498     (let ((b (point-min)))
1499       (while (setq b (text-property-any b (point-max) 'article-type type))
1500         (delete-region
1501          b (or (text-property-not-all b (point-max) 'article-type type)
1502                (point-max)))))))
1503
1504 (defun gnus-article-delete-invisible-text ()
1505   "Delete all invisible text in the current buffer."
1506   (save-excursion
1507     (let ((b (point-min)))
1508       (while (setq b (text-property-any b (point-max) 'invisible t))
1509         (delete-region
1510          b (or (text-property-not-all b (point-max) 'invisible t)
1511                (point-max)))))))
1512
1513 (defun gnus-article-text-type-exists-p (type)
1514   "Say whether any text of type TYPE exists in the buffer."
1515   (text-property-any (point-min) (point-max) 'article-type type))
1516
1517 (defsubst gnus-article-header-rank ()
1518   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1519   (let ((list gnus-sorted-header-list)
1520         (i 1))
1521     (while list
1522       (if (looking-at (car list))
1523           (setq list nil)
1524         (setq list (cdr list))
1525         (incf i)))
1526       i))
1527
1528 (defun article-hide-headers (&optional arg delete)
1529   "Hide unwanted headers and possibly sort them as well."
1530   (interactive)
1531   ;; This function might be inhibited.
1532   (unless gnus-inhibit-hiding
1533     (save-excursion
1534       (save-restriction
1535         (let ((buffer-read-only nil)
1536               (case-fold-search t)
1537               (max (1+ (length gnus-sorted-header-list)))
1538               (ignored (when (not gnus-visible-headers)
1539                          (cond ((stringp gnus-ignored-headers)
1540                                 gnus-ignored-headers)
1541                                ((listp gnus-ignored-headers)
1542                                 (mapconcat 'identity gnus-ignored-headers
1543                                            "\\|")))))
1544               (visible
1545                (cond ((stringp gnus-visible-headers)
1546                       gnus-visible-headers)
1547                      ((and gnus-visible-headers
1548                            (listp gnus-visible-headers))
1549                       (mapconcat 'identity gnus-visible-headers "\\|"))))
1550               (inhibit-point-motion-hooks t)
1551               beg)
1552           ;; First we narrow to just the headers.
1553           (article-narrow-to-head)
1554           ;; Hide any "From " lines at the beginning of (mail) articles.
1555           (while (looking-at "From ")
1556             (forward-line 1))
1557           (unless (bobp)
1558             (delete-region (point-min) (point)))
1559           ;; Then treat the rest of the header lines.
1560           ;; Then we use the two regular expressions
1561           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1562           ;; select which header lines is to remain visible in the
1563           ;; article buffer.
1564           (while (re-search-forward "^[^ \t:]*:" nil t)
1565             (beginning-of-line)
1566             ;; Mark the rank of the header.
1567             (put-text-property
1568              (point) (1+ (point)) 'message-rank
1569              (if (or (and visible (looking-at visible))
1570                      (and ignored
1571                           (not (looking-at ignored))))
1572                  (gnus-article-header-rank)
1573                (+ 2 max)))
1574             (forward-line 1))
1575           (message-sort-headers-1)
1576           (when (setq beg (text-property-any
1577                            (point-min) (point-max) 'message-rank (+ 2 max)))
1578             ;; We delete the unwanted headers.
1579             (gnus-add-wash-type 'headers)
1580             (add-text-properties (point-min) (+ 5 (point-min))
1581                                  '(article-type headers dummy-invisible t))
1582             (delete-region beg (point-max))))))))
1583
1584 (defun article-hide-boring-headers (&optional arg)
1585   "Toggle hiding of headers that aren't very interesting.
1586 If given a negative prefix, always show; if given a positive prefix,
1587 always hide."
1588   (interactive (gnus-article-hidden-arg))
1589   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1590              (not gnus-show-all-headers))
1591     (save-excursion
1592       (save-restriction
1593         (let ((buffer-read-only nil)
1594               (list gnus-boring-article-headers)
1595               (inhibit-point-motion-hooks t)
1596               elem)
1597           (article-narrow-to-head)
1598           (while list
1599             (setq elem (pop list))
1600             (goto-char (point-min))
1601             (cond
1602              ;; Hide empty headers.
1603              ((eq elem 'empty)
1604               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1605                 (forward-line -1)
1606                 (gnus-article-hide-text-type
1607                  (gnus-point-at-bol)
1608                  (progn
1609                    (end-of-line)
1610                    (if (re-search-forward "^[^ \t]" nil t)
1611                        (match-beginning 0)
1612                      (point-max)))
1613                  'boring-headers)))
1614              ;; Hide boring Newsgroups header.
1615              ((eq elem 'newsgroups)
1616               (when (gnus-string-equal
1617                      (gnus-fetch-field "newsgroups")
1618                      (gnus-group-real-name
1619                       (if (boundp 'gnus-newsgroup-name)
1620                           gnus-newsgroup-name
1621                         "")))
1622                 (gnus-article-hide-header "newsgroups")))
1623              ((eq elem 'to-address)
1624               (let ((to (message-fetch-field "to"))
1625                     (to-address
1626                      (gnus-parameter-to-address
1627                       (if (boundp 'gnus-newsgroup-name)
1628                           gnus-newsgroup-name ""))))
1629                 (when (and to to-address
1630                            (ignore-errors
1631                              (gnus-string-equal
1632                               ;; only one address in To
1633                               (nth 1 (mail-extract-address-components to))
1634                               to-address)))
1635                   (gnus-article-hide-header "to"))))
1636              ((eq elem 'to-list)
1637               (let ((to (message-fetch-field "to"))
1638                     (to-list
1639                      (gnus-parameter-to-list
1640                       (if (boundp 'gnus-newsgroup-name)
1641                           gnus-newsgroup-name ""))))
1642                 (when (and to to-list
1643                            (ignore-errors
1644                              (gnus-string-equal
1645                               ;; only one address in To
1646                               (nth 1 (mail-extract-address-components to))
1647                               to-list)))
1648                   (gnus-article-hide-header "to"))))
1649              ((eq elem 'cc-list)
1650               (let ((cc (message-fetch-field "cc"))
1651                     (to-list
1652                      (gnus-parameter-to-list
1653                       (if (boundp 'gnus-newsgroup-name)
1654                           gnus-newsgroup-name ""))))
1655                 (when (and cc to-list
1656                            (ignore-errors
1657                              (gnus-string-equal
1658                               ;; only one address in CC
1659                               (nth 1 (mail-extract-address-components cc))
1660                               to-list)))
1661                   (gnus-article-hide-header "cc"))))
1662              ((eq elem 'followup-to)
1663               (when (gnus-string-equal
1664                      (message-fetch-field "followup-to")
1665                      (message-fetch-field "newsgroups"))
1666                 (gnus-article-hide-header "followup-to")))
1667              ((eq elem 'reply-to)
1668               (if (gnus-group-find-parameter
1669                    gnus-newsgroup-name 'broken-reply-to)
1670                   (gnus-article-hide-header "reply-to")
1671                 (let ((from (message-fetch-field "from"))
1672                       (reply-to (message-fetch-field "reply-to")))
1673                   (when (and
1674                          from reply-to
1675                          (ignore-errors
1676                            (gnus-string-equal
1677                             (nth 1 (mail-extract-address-components from))
1678                             (nth 1 (mail-extract-address-components reply-to)))))
1679                     (gnus-article-hide-header "reply-to")))))
1680              ((eq elem 'date)
1681               (let ((date (message-fetch-field "date")))
1682                 (when (and date
1683                            (< (days-between (current-time-string) date)
1684                               4))
1685                   (gnus-article-hide-header "date"))))
1686              ((eq elem 'long-to)
1687               (let ((to (message-fetch-field "to"))
1688                     (cc (message-fetch-field "cc")))
1689                 (when (> (length to) 1024)
1690                   (gnus-article-hide-header "to"))
1691                 (when (> (length cc) 1024)
1692                   (gnus-article-hide-header "cc"))))
1693              ((eq elem 'many-to)
1694               (let ((to-count 0)
1695                     (cc-count 0))
1696                 (goto-char (point-min))
1697                 (while (re-search-forward "^to:" nil t)
1698                   (setq to-count (1+ to-count)))
1699                 (when (> to-count 1)
1700                   (while (> to-count 0)
1701                     (goto-char (point-min))
1702                     (save-restriction
1703                       (re-search-forward "^to:" nil nil to-count)
1704                       (forward-line -1)
1705                       (narrow-to-region (point) (point-max))
1706                       (gnus-article-hide-header "to"))
1707                     (setq to-count (1- to-count))))
1708                 (goto-char (point-min))
1709                 (while (re-search-forward "^cc:" nil t)
1710                   (setq cc-count (1+ cc-count)))
1711                 (when (> cc-count 1)
1712                   (while (> cc-count 0)
1713                     (goto-char (point-min))
1714                     (save-restriction
1715                       (re-search-forward "^cc:" nil nil cc-count)
1716                       (forward-line -1)
1717                       (narrow-to-region (point) (point-max))
1718                       (gnus-article-hide-header "cc"))
1719                     (setq cc-count (1- cc-count)))))))))))))
1720
1721 (defun gnus-article-hide-header (header)
1722   (save-excursion
1723     (goto-char (point-min))
1724     (when (re-search-forward (concat "^" header ":") nil t)
1725       (gnus-article-hide-text-type
1726        (gnus-point-at-bol)
1727        (progn
1728          (end-of-line)
1729          (if (re-search-forward "^[^ \t]" nil t)
1730              (match-beginning 0)
1731            (point-max)))
1732        'boring-headers))))
1733
1734 (defvar gnus-article-normalized-header-length 40
1735   "Length of normalized headers.")
1736
1737 (defun article-normalize-headers ()
1738   "Make all header lines 40 characters long."
1739   (interactive)
1740   (let ((buffer-read-only nil)
1741         column)
1742     (save-excursion
1743       (save-restriction
1744         (article-narrow-to-head)
1745         (while (not (eobp))
1746           (cond
1747            ((< (setq column (- (gnus-point-at-eol) (point)))
1748                gnus-article-normalized-header-length)
1749             (end-of-line)
1750             (insert (make-string
1751                      (- gnus-article-normalized-header-length column)
1752                      ? )))
1753            ((> column gnus-article-normalized-header-length)
1754             (gnus-put-text-property
1755              (progn
1756                (forward-char gnus-article-normalized-header-length)
1757                (point))
1758              (gnus-point-at-eol)
1759              'invisible t))
1760            (t
1761             ;; Do nothing.
1762             ))
1763           (forward-line 1))))))
1764
1765 (defun article-treat-dumbquotes ()
1766   "Translate M****s*** sm*rtq**t*s into proper text.
1767 Note that this function guesses whether a character is a sm*rtq**t* or
1768 not, so it should only be used interactively.
1769
1770 Sm*rtq**t*s are M****s***'s unilateral extension to the character map
1771 in an attempt to provide more quoting characters.  If you see
1772 something like \\222 or \\264 where you're expecting some kind of
1773 apostrophe or quotation mark, then try this wash."
1774   (interactive)
1775   (article-translate-strings gnus-article-dumbquotes-map))
1776
1777 (defun article-translate-characters (from to)
1778   "Translate all characters in the body of the article according to FROM and TO.
1779 FROM is a string of characters to translate from; to is a string of
1780 characters to translate to."
1781   (save-excursion
1782     (when (article-goto-body)
1783       (let ((buffer-read-only nil)
1784             (x (make-string 225 ?x))
1785             (i -1))
1786         (while (< (incf i) (length x))
1787           (aset x i i))
1788         (setq i 0)
1789         (while (< i (length from))
1790           (aset x (aref from i) (aref to i))
1791           (incf i))
1792         (translate-region (point) (point-max) x)))))
1793
1794 (defun article-translate-strings (map)
1795   "Translate all string in the body of the article according to MAP.
1796 MAP is an alist where the elements are on the form (\"from\" \"to\")."
1797   (save-excursion
1798     (when (article-goto-body)
1799       (let ((buffer-read-only nil)
1800             elem)
1801         (while (setq elem (pop map))
1802           (save-excursion
1803             (while (search-forward (car elem) nil t)
1804               (replace-match (cadr elem)))))))))
1805
1806 (defun article-treat-overstrike ()
1807   "Translate overstrikes into bold text."
1808   (interactive)
1809   (save-excursion
1810     (when (article-goto-body)
1811       (let ((buffer-read-only nil))
1812         (while (search-forward "\b" nil t)
1813           (let ((next (char-after))
1814                 (previous (char-after (- (point) 2))))
1815             ;; We do the boldification/underlining by hiding the
1816             ;; overstrikes and putting the proper text property
1817             ;; on the letters.
1818             (cond
1819              ((eq next previous)
1820               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
1821               (put-text-property (point) (1+ (point)) 'face 'bold))
1822              ((eq next ?_)
1823               (gnus-article-hide-text-type
1824                (1- (point)) (1+ (point)) 'overstrike)
1825               (put-text-property
1826                (- (point) 2) (1- (point)) 'face 'underline))
1827              ((eq previous ?_)
1828               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
1829               (put-text-property
1830                (point) (1+ (point)) 'face 'underline)))))))))
1831
1832 (defun gnus-article-treat-unfold-headers ()
1833   "Unfold folded message headers.
1834 Only the headers that fit into the current window width will be
1835 unfolded."
1836   (interactive)
1837   (gnus-with-article-headers
1838     (let (length)
1839       (while (not (eobp))
1840         (save-restriction
1841           (mail-header-narrow-to-field)
1842           (let ((header (buffer-string)))
1843             (with-temp-buffer
1844               (insert header)
1845               (goto-char (point-min))
1846               (while (re-search-forward "\n[\t ]" nil t)
1847                 (replace-match " " t t)))
1848             (setq length (- (point-max) (point-min) 1)))
1849           (when (< length (window-width))
1850             (while (re-search-forward "\n[\t ]" nil t)
1851               (replace-match " " t t)))
1852           (goto-char (point-max)))))))
1853
1854 (defun gnus-article-treat-fold-headers ()
1855   "Fold message headers."
1856   (interactive)
1857   (gnus-with-article-headers
1858     (while (not (eobp))
1859       (save-restriction
1860         (mail-header-narrow-to-field)
1861         (mail-header-fold-field)
1862         (goto-char (point-max))))))
1863
1864 (defun gnus-treat-smiley ()
1865   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
1866   (interactive)
1867   (gnus-with-article-buffer
1868     (if (memq 'smiley gnus-article-wash-types)
1869         (gnus-delete-images 'smiley)
1870       (article-goto-body)
1871       (let ((images (smiley-region (point) (point-max))))
1872         (when images
1873           (gnus-add-wash-type 'smiley)
1874           (dolist (image images)
1875             (gnus-add-image 'smiley image)))))))
1876
1877 (defun gnus-article-remove-images ()
1878   "Remove all images from the article buffer."
1879   (interactive)
1880   (gnus-with-article-buffer
1881     (dolist (elem gnus-article-image-alist)
1882       (gnus-delete-images (car elem)))))
1883
1884 (defun gnus-article-treat-fold-newsgroups ()
1885   "Unfold folded message headers.
1886 Only the headers that fit into the current window width will be
1887 unfolded."
1888   (interactive)
1889   (gnus-with-article-headers
1890     (while (gnus-article-goto-header "newsgroups\\|followup-to")
1891       (save-restriction
1892         (mail-header-narrow-to-field)
1893         (while (re-search-forward ", *" nil t)
1894           (replace-match ", " t t))
1895         (mail-header-fold-field)
1896         (goto-char (point-max))))))
1897
1898 (defun gnus-article-treat-body-boundary ()
1899   "Place a boundary line at the end of the headers."
1900   (interactive)
1901   (when (and gnus-body-boundary-delimiter
1902              (> (length gnus-body-boundary-delimiter) 0))
1903     (gnus-with-article-headers
1904       (goto-char (point-max))
1905       (let ((start (point)))
1906         (insert "X-Boundary: ")
1907         (gnus-add-text-properties start (point) '(invisible t intangible t))
1908         (insert (let (str)
1909                   (while (>= (1- (window-width)) (length str))
1910                     (setq str (concat str gnus-body-boundary-delimiter)))
1911                   (substring str 0 (1- (window-width))))
1912                 "\n")
1913         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
1914
1915 (defun article-fill-long-lines ()
1916   "Fill lines that are wider than the window width."
1917   (interactive)
1918   (save-excursion
1919     (let ((buffer-read-only nil)
1920           (width (window-width (get-buffer-window (current-buffer)))))
1921       (save-restriction
1922         (article-goto-body)
1923         (let ((adaptive-fill-mode nil)) ;Why?  -sm
1924           (while (not (eobp))
1925             (end-of-line)
1926             (when (>= (current-column) (min fill-column width))
1927               (narrow-to-region (min (1+ (point)) (point-max))
1928                                 (gnus-point-at-bol))
1929               (let ((goback (point-marker)))
1930                 (fill-paragraph nil)
1931                 (goto-char (marker-position goback)))
1932               (widen))
1933             (forward-line 1)))))))
1934
1935 (defun article-capitalize-sentences ()
1936   "Capitalize the first word in each sentence."
1937   (interactive)
1938   (save-excursion
1939     (let ((buffer-read-only nil)
1940           (paragraph-start "^[\n\^L]"))
1941       (article-goto-body)
1942       (while (not (eobp))
1943         (capitalize-word 1)
1944         (forward-sentence)))))
1945
1946 (defun article-remove-cr ()
1947   "Remove trailing CRs and then translate remaining CRs into LFs."
1948   (interactive)
1949   (save-excursion
1950     (let ((buffer-read-only nil))
1951       (goto-char (point-min))
1952       (while (re-search-forward "\r+$" nil t)
1953         (replace-match "" t t))
1954       (goto-char (point-min))
1955       (while (search-forward "\r" nil t)
1956         (replace-match "\n" t t)))))
1957
1958 (defun article-remove-trailing-blank-lines ()
1959   "Remove all trailing blank lines from the article."
1960   (interactive)
1961   (save-excursion
1962     (let ((buffer-read-only nil))
1963       (goto-char (point-max))
1964       (delete-region
1965        (point)
1966        (progn
1967          (while (and (not (bobp))
1968                      (looking-at "^[ \t]*$")
1969                      (not (gnus-annotation-in-region-p
1970                            (point) (gnus-point-at-eol))))
1971            (forward-line -1))
1972          (forward-line 1)
1973          (point))))))
1974
1975 (defun article-display-face ()
1976   "Display any Face headers in the header."
1977   (interactive)
1978   (gnus-with-article-headers
1979     (let ((face (message-fetch-field "face")))
1980       (when face
1981         (let ((png (gnus-convert-face-to-png face))
1982               image)
1983           (when png
1984             (setq image (gnus-create-image png 'png t))
1985             (gnus-article-goto-header "from")
1986             (when (bobp)
1987               (insert "From: [no `from' set]\n")
1988               (forward-char -17))
1989             (gnus-add-wash-type 'face)
1990             (gnus-add-image 'face image)
1991             (gnus-put-image image)))))))
1992
1993 (defun article-display-x-face (&optional force)
1994   "Look for an X-Face header and display it if present."
1995   (interactive (list 'force))
1996   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
1997     (gnus-with-article-headers
1998       ;; Delete the old process, if any.
1999       (when (process-status "article-x-face")
2000         (delete-process "article-x-face"))
2001       (if (memq 'xface gnus-article-wash-types)
2002           ;; We have already displayed X-Faces, so we remove them
2003           ;; instead.
2004           (gnus-delete-images 'xface)
2005         ;; Display X-Faces.
2006         (let (x-faces from face)
2007           (save-excursion
2008             (when (and wash-face-p
2009                        (progn
2010                          (goto-char (point-min))
2011                          (not (re-search-forward
2012                                "^X-Face\\(-[0-9]+\\)?:[\t ]*" nil t)))
2013                        (gnus-buffer-live-p gnus-original-article-buffer))
2014               ;; If type `W f', use gnus-original-article-buffer,
2015               ;; otherwise use the current buffer because displaying
2016               ;; RFC822 parts calls this function too.
2017               (set-buffer gnus-original-article-buffer))
2018             (save-restriction
2019               (mail-narrow-to-head)
2020               (while (gnus-article-goto-header "X-Face")
2021                 (push (mail-header-field-value) x-faces))
2022               (setq from (message-fetch-field "from"))))
2023           ;; Sending multiple EOFs to xv doesn't work, so we only do a
2024           ;; single external face.
2025           (when (stringp gnus-article-x-face-command)
2026             (setq x-faces (list (car x-faces))))
2027           (while (and (setq face (pop x-faces))
2028                       gnus-article-x-face-command
2029                       (or force
2030                           ;; Check whether this face is censored.
2031                           (not gnus-article-x-face-too-ugly)
2032                           (and gnus-article-x-face-too-ugly from
2033                                (not (string-match gnus-article-x-face-too-ugly
2034                                                   from)))))
2035             ;; We display the face.
2036             (if (symbolp gnus-article-x-face-command)
2037                 ;; The command is a lisp function, so we call it.
2038                 (if (functionp gnus-article-x-face-command)
2039                     (funcall gnus-article-x-face-command face)
2040                   (error "%s is not a function" gnus-article-x-face-command))
2041               ;; The command is a string, so we interpret the command
2042               ;; as a, well, command, and fork it off.
2043               (let ((process-connection-type nil))
2044                 (process-kill-without-query
2045                  (start-process
2046                   "article-x-face" nil shell-file-name shell-command-switch
2047                   gnus-article-x-face-command))
2048                 (with-temp-buffer
2049                   (insert face)
2050                   (process-send-region "article-x-face"
2051                                        (point-min) (point-max)))
2052                 (process-send-eof "article-x-face")))))))))
2053
2054 (defun article-decode-mime-words ()
2055   "Decode all MIME-encoded words in the article."
2056   (interactive)
2057   (save-excursion
2058     (set-buffer gnus-article-buffer)
2059     (let ((inhibit-point-motion-hooks t)
2060           buffer-read-only
2061           (mail-parse-charset gnus-newsgroup-charset)
2062           (mail-parse-ignored-charsets
2063            (save-excursion (set-buffer gnus-summary-buffer)
2064                            gnus-newsgroup-ignored-charsets)))
2065       (mail-decode-encoded-word-region (point-min) (point-max)))))
2066
2067 (defun article-decode-charset (&optional prompt)
2068   "Decode charset-encoded text in the article.
2069 If PROMPT (the prefix), prompt for a coding system to use."
2070   (interactive "P")
2071   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2072         buffer-read-only
2073         (mail-parse-charset gnus-newsgroup-charset)
2074         (mail-parse-ignored-charsets
2075          (save-excursion (condition-case nil
2076                              (set-buffer gnus-summary-buffer)
2077                            (error))
2078                          gnus-newsgroup-ignored-charsets))
2079         ct cte ctl charset format)
2080   (save-excursion
2081     (save-restriction
2082       (article-narrow-to-head)
2083       (setq ct (message-fetch-field "Content-Type" t)
2084             cte (message-fetch-field "Content-Transfer-Encoding" t)
2085             ctl (and ct (ignore-errors
2086                           (mail-header-parse-content-type ct)))
2087             charset (cond
2088                      (prompt
2089                       (mm-read-coding-system "Charset to decode: "))
2090                      (ctl
2091                       (mail-content-type-get ctl 'charset)))
2092             format (and ctl (mail-content-type-get ctl 'format)))
2093       (when cte
2094         (setq cte (mail-header-strip cte)))
2095       (if (and ctl (not (string-match "/" (car ctl))))
2096           (setq ctl nil))
2097       (goto-char (point-max)))
2098     (forward-line 1)
2099     (save-restriction
2100       (narrow-to-region (point) (point-max))
2101       (when (and (eq mail-parse-charset 'gnus-decoded)
2102                  (eq (mm-body-7-or-8) '8bit))
2103         ;; The text code could have been decoded.
2104         (setq charset mail-parse-charset))
2105       (when (and (or (not ctl)
2106                      (equal (car ctl) "text/plain"))
2107                  (not format)) ;; article with format will decode later.
2108         (mm-decode-body
2109          charset (and cte (intern (downcase
2110                                    (gnus-strip-whitespace cte))))
2111          (car ctl) prompt))))))
2112
2113 (defun article-decode-encoded-words ()
2114   "Remove encoded-word encoding from headers."
2115   (let ((inhibit-point-motion-hooks t)
2116         (mail-parse-charset gnus-newsgroup-charset)
2117         (mail-parse-ignored-charsets
2118          (save-excursion (condition-case nil
2119                              (set-buffer gnus-summary-buffer)
2120                            (error))
2121                          gnus-newsgroup-ignored-charsets))
2122         buffer-read-only)
2123     (save-restriction
2124       (article-narrow-to-head)
2125       (funcall gnus-decode-header-function (point-min) (point-max)))))
2126
2127 (defun article-decode-group-name ()
2128   "Decode group names in `Newsgroups:'."
2129   (let ((inhibit-point-motion-hooks t)
2130         buffer-read-only
2131         (method (gnus-find-method-for-group gnus-newsgroup-name)))
2132     (when (and (or gnus-group-name-charset-method-alist
2133                    gnus-group-name-charset-group-alist)
2134                (gnus-buffer-live-p gnus-original-article-buffer))
2135       (save-restriction
2136         (article-narrow-to-head)
2137         (with-current-buffer gnus-original-article-buffer
2138           (goto-char (point-min)))
2139         (while (re-search-forward
2140                 "^Newsgroups:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]" nil t)
2141           (replace-match (save-match-data
2142                            (gnus-decode-newsgroups
2143                             ;; XXX how to use data in article buffer?
2144                             (with-current-buffer gnus-original-article-buffer
2145                               (re-search-forward
2146                                "^Newsgroups:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]"
2147                                nil t)
2148                               (match-string 1))
2149                             gnus-newsgroup-name method))
2150                          t t nil 1))
2151         (goto-char (point-min))
2152         (with-current-buffer gnus-original-article-buffer
2153           (goto-char (point-min)))
2154         (while (re-search-forward
2155                 "^Followup-To:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]" nil t)
2156           (replace-match (save-match-data
2157                            (gnus-decode-newsgroups
2158                             ;; XXX how to use data in article buffer?
2159                             (with-current-buffer gnus-original-article-buffer
2160                               (re-search-forward
2161                                "^Followup-To:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]"
2162                                nil t)
2163                               (match-string 1))
2164                             gnus-newsgroup-name method))
2165                          t t nil 1))))))
2166
2167 (autoload 'idna-to-unicode "idna")
2168
2169 (defun article-decode-idna-rhs ()
2170   "Decode IDNA strings in RHS in From:, To: and Cc: headers in current buffer."
2171   (when gnus-use-idna
2172     (save-restriction
2173       (let ((inhibit-point-motion-hooks t)
2174             buffer-read-only)
2175         (article-narrow-to-head)
2176         (goto-char (point-min))
2177         (while (re-search-forward "\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2178           (let (ace unicode)
2179             (when (save-match-data
2180                     (and (setq ace (match-string 1))
2181                          (save-excursion
2182                            (and (re-search-backward "^[^ \t]" nil t)
2183                                 (looking-at "From\\|To\\|Cc")))
2184                          (save-excursion (backward-char)
2185                                          (message-idna-inside-rhs-p))
2186                          (setq unicode (idna-to-unicode ace))))
2187               (unless (string= ace unicode)
2188                 (replace-match unicode nil nil nil 1)))))))))
2189
2190 (defun article-de-quoted-unreadable (&optional force read-charset)
2191   "Translate a quoted-printable-encoded article.
2192 If FORCE, decode the article whether it is marked as quoted-printable
2193 or not.
2194 If READ-CHARSET, ask for a coding system."
2195   (interactive (list 'force current-prefix-arg))
2196   (save-excursion
2197     (let ((buffer-read-only nil) type charset)
2198       (if (gnus-buffer-live-p gnus-original-article-buffer)
2199           (with-current-buffer gnus-original-article-buffer
2200             (setq type
2201                   (gnus-fetch-field "content-transfer-encoding"))
2202             (let* ((ct (gnus-fetch-field "content-type"))
2203                    (ctl (and ct
2204                              (ignore-errors
2205                                (mail-header-parse-content-type ct)))))
2206               (setq charset (and ctl
2207                                  (mail-content-type-get ctl 'charset)))
2208               (if (stringp charset)
2209                   (setq charset (intern (downcase charset)))))))
2210       (if read-charset
2211           (setq charset (mm-read-coding-system "Charset: " charset)))
2212       (unless charset
2213         (setq charset gnus-newsgroup-charset))
2214       (when (or force
2215                 (and type (let ((case-fold-search t))
2216                             (string-match "quoted-printable" type))))
2217         (article-goto-body)
2218         (quoted-printable-decode-region
2219          (point) (point-max) (mm-charset-to-coding-system charset))))))
2220
2221 (defun article-de-base64-unreadable (&optional force read-charset)
2222   "Translate a base64 article.
2223 If FORCE, decode the article whether it is marked as base64 not.
2224 If READ-CHARSET, ask for a coding system."
2225   (interactive (list 'force current-prefix-arg))
2226   (save-excursion
2227     (let ((buffer-read-only nil) type charset)
2228       (if (gnus-buffer-live-p gnus-original-article-buffer)
2229           (with-current-buffer gnus-original-article-buffer
2230             (setq type
2231                   (gnus-fetch-field "content-transfer-encoding"))
2232             (let* ((ct (gnus-fetch-field "content-type"))
2233                    (ctl (and ct
2234                              (ignore-errors
2235                                (mail-header-parse-content-type ct)))))
2236               (setq charset (and ctl
2237                                  (mail-content-type-get ctl 'charset)))
2238               (if (stringp charset)
2239                   (setq charset (intern (downcase charset)))))))
2240       (if read-charset
2241           (setq charset (mm-read-coding-system "Charset: " charset)))
2242       (unless charset
2243         (setq charset gnus-newsgroup-charset))
2244       (when (or force
2245                 (and type (let ((case-fold-search t))
2246                             (string-match "base64" type))))
2247         (article-goto-body)
2248         (save-restriction
2249           (narrow-to-region (point) (point-max))
2250           (base64-decode-region (point-min) (point-max))
2251           (mm-decode-coding-region
2252            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2253
2254 (eval-when-compile
2255   (require 'rfc1843))
2256
2257 (defun article-decode-HZ ()
2258   "Translate a HZ-encoded article."
2259   (interactive)
2260   (require 'rfc1843)
2261   (save-excursion
2262     (let ((buffer-read-only nil))
2263       (rfc1843-decode-region (point-min) (point-max)))))
2264
2265 (defun article-unsplit-urls ()
2266   "Remove the newlines that some other mailers insert into URLs."
2267   (interactive)
2268   (save-excursion
2269     (let ((buffer-read-only nil))
2270       (goto-char (point-min))
2271       (while (re-search-forward
2272               "^\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2273         (replace-match "\\1\\3" t)))
2274     (when (and gnus-display-mime-function (interactive-p))
2275       (funcall gnus-display-mime-function))))
2276
2277
2278 (defun article-wash-html (&optional read-charset)
2279   "Format an HTML article.
2280 If READ-CHARSET, ask for a coding system."
2281   (interactive "P")
2282   (save-excursion
2283     (let ((buffer-read-only nil)
2284           charset)
2285       (when (gnus-buffer-live-p gnus-original-article-buffer)
2286         (with-current-buffer gnus-original-article-buffer
2287           (let* ((ct (gnus-fetch-field "content-type"))
2288                  (ctl (and ct
2289                            (ignore-errors
2290                              (mail-header-parse-content-type ct)))))
2291             (setq charset (and ctl
2292                                (mail-content-type-get ctl 'charset)))
2293             (when (stringp charset)
2294               (setq charset (intern (downcase charset)))))))
2295       (when read-charset
2296         (setq charset (mm-read-coding-system "Charset: " charset)))
2297       (unless charset
2298         (setq charset gnus-newsgroup-charset))
2299       (article-goto-body)
2300       (save-window-excursion
2301         (save-restriction
2302           (narrow-to-region (point) (point-max))
2303           (let* ((func (or gnus-article-wash-function mm-text-html-renderer))
2304                  (entry (assq func mm-text-html-washer-alist)))
2305             (when entry
2306               (setq func (cdr entry)))
2307             (cond
2308              ((functionp func)
2309               (funcall func))
2310              (t
2311               (apply (car func) (cdr func))))))))))
2312
2313 (defun gnus-article-wash-html-with-w3 ()
2314   "Wash the current buffer with w3."
2315   (mm-setup-w3)
2316   (let ((w3-strict-width (window-width))
2317         (url-standalone-mode t)
2318         (url-gateway-unplugged t)
2319         (w3-honor-stylesheets nil))
2320     (condition-case ()
2321         (w3-region (point-min) (point-max))
2322       (error))))
2323
2324 (defun gnus-article-wash-html-with-w3m ()
2325   "Wash the current buffer with emacs-w3m."
2326   (mm-setup-w3m)
2327   (save-restriction
2328     (narrow-to-region (point) (point-max))
2329     (let ((w3m-safe-url-regexp (if mm-inline-text-html-with-images
2330                                    nil
2331                                  "\\`cid:"))
2332           w3m-force-redisplay)
2333       (w3m-region (point-min) (point-max)))
2334     (when mm-inline-text-html-with-w3m-keymap
2335       (add-text-properties
2336        (point-min) (point-max)
2337        (nconc (mm-w3m-local-map-property)
2338               '(mm-inline-text-html-with-w3m t))))))
2339
2340 (defun article-hide-list-identifiers ()
2341   "Remove list identifies from the Subject header.
2342 The `gnus-list-identifiers' variable specifies what to do."
2343   (interactive)
2344   (let ((inhibit-point-motion-hooks t)
2345         (regexp (if (consp gnus-list-identifiers)
2346                     (mapconcat 'identity gnus-list-identifiers " *\\|")
2347                   gnus-list-identifiers))
2348         buffer-read-only)
2349     (when regexp
2350       (save-excursion
2351         (save-restriction
2352           (article-narrow-to-head)
2353           (goto-char (point-min))
2354           (while (re-search-forward
2355                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
2356                   nil t)
2357             (delete-region (match-beginning 2) (match-end 0))
2358             (beginning-of-line))
2359           (when (re-search-forward
2360                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
2361             (delete-region (match-beginning 1) (match-end 1))))))))
2362
2363 (defun article-hide-pem (&optional arg)
2364   "Toggle hiding of any PEM headers and signatures in the current article.
2365 If given a negative prefix, always show; if given a positive prefix,
2366 always hide."
2367   (interactive (gnus-article-hidden-arg))
2368   (unless (gnus-article-check-hidden-text 'pem arg)
2369     (save-excursion
2370       (let (buffer-read-only end)
2371         (goto-char (point-min))
2372         ;; Hide the horrendously ugly "header".
2373         (when (and (search-forward
2374                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
2375                     nil t)
2376                    (setq end (1+ (match-beginning 0))))
2377           (gnus-add-wash-type 'pem)
2378           (gnus-article-hide-text-type
2379            end
2380            (if (search-forward "\n\n" nil t)
2381                (match-end 0)
2382              (point-max))
2383            'pem)
2384           ;; Hide the trailer as well
2385           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
2386                                 nil t)
2387             (gnus-article-hide-text-type
2388              (match-beginning 0) (match-end 0) 'pem)))))))
2389
2390 (defun article-strip-banner ()
2391   "Strip the banners specified by the `banner' group parameter and by
2392 `gnus-article-address-banner-alist'."
2393   (interactive)
2394   (save-excursion
2395     (save-restriction
2396       (let ((inhibit-point-motion-hooks t))
2397         (when (gnus-parameter-banner gnus-newsgroup-name)
2398           (article-really-strip-banner
2399            (gnus-parameter-banner gnus-newsgroup-name)))
2400         (when gnus-article-address-banner-alist
2401           (article-really-strip-banner
2402            (let ((from (save-restriction
2403                          (widen)
2404                          (article-narrow-to-head)
2405                          (mail-fetch-field "from"))))
2406              (when (and from
2407                         (setq from
2408                               (caar (mail-header-parse-addresses from))))
2409                (catch 'found
2410                  (dolist (pair gnus-article-address-banner-alist)
2411                    (when (string-match (car pair) from)
2412                      (throw 'found (cdr pair)))))))))))))
2413
2414 (defun article-really-strip-banner (banner)
2415   "Strip the banner specified by the argument."
2416   (save-excursion
2417     (save-restriction
2418       (let ((inhibit-point-motion-hooks t)
2419             (gnus-signature-limit nil)
2420             buffer-read-only)
2421         (article-goto-body)
2422         (cond
2423          ((eq banner 'signature)
2424           (when (gnus-article-narrow-to-signature)
2425             (widen)
2426             (forward-line -1)
2427             (delete-region (point) (point-max))))
2428          ((symbolp banner)
2429           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
2430               (while (re-search-forward banner nil t)
2431                 (delete-region (match-beginning 0) (match-end 0)))))
2432          ((stringp banner)
2433           (while (re-search-forward banner nil t)
2434             (delete-region (match-beginning 0) (match-end 0)))))))))
2435
2436 (defun article-babel ()
2437   "Translate article using an online translation service."
2438   (interactive)
2439   (require 'babel)
2440   (save-excursion
2441     (set-buffer gnus-article-buffer)
2442     (when (article-goto-body)
2443       (let* ((buffer-read-only nil)
2444              (start (point))
2445              (end (point-max))
2446              (orig (buffer-substring start end))
2447              (trans (babel-as-string orig)))
2448         (save-restriction
2449           (narrow-to-region start end)
2450           (delete-region start end)
2451           (insert trans))))))
2452
2453 (defun article-hide-signature (&optional arg)
2454   "Hide the signature in the current article.
2455 If given a negative prefix, always show; if given a positive prefix,
2456 always hide."
2457   (interactive (gnus-article-hidden-arg))
2458   (unless (gnus-article-check-hidden-text 'signature arg)
2459     (save-excursion
2460       (save-restriction
2461         (let ((buffer-read-only nil))
2462           (when (gnus-article-narrow-to-signature)
2463             (gnus-article-hide-text-type
2464              (point-min) (point-max) 'signature))))))
2465   (gnus-set-mode-line 'article))
2466
2467 (defun article-strip-headers-in-body ()
2468   "Strip offensive headers from bodies."
2469   (interactive)
2470   (save-excursion
2471     (article-goto-body)
2472     (let ((case-fold-search t))
2473       (when (looking-at "x-no-archive:")
2474         (gnus-delete-line)))))
2475
2476 (defun article-strip-leading-blank-lines ()
2477   "Remove all blank lines from the beginning of the article."
2478   (interactive)
2479   (save-excursion
2480     (let ((inhibit-point-motion-hooks t)
2481           buffer-read-only)
2482       (when (article-goto-body)
2483         (while (and (not (eobp))
2484                     (looking-at "[ \t]*$"))
2485           (gnus-delete-line))))))
2486
2487 (defun article-narrow-to-head ()
2488   "Narrow the buffer to the head of the message.
2489 Point is left at the beginning of the narrowed-to region."
2490   (narrow-to-region
2491    (goto-char (point-min))
2492    (if (search-forward "\n\n" nil 1)
2493        (1- (point))
2494      (point-max)))
2495   (goto-char (point-min)))
2496
2497 (defun article-goto-body ()
2498   "Place point at the start of the body."
2499   (goto-char (point-min))
2500   (cond
2501    ;; This variable is only bound when dealing with separate
2502    ;; MIME body parts.
2503    (article-goto-body-goes-to-point-min-p
2504     t)
2505    ((search-forward "\n\n" nil t)
2506     t)
2507    (t
2508     (goto-char (point-max))
2509     nil)))
2510
2511 (defun article-strip-multiple-blank-lines ()
2512   "Replace consecutive blank lines with one empty line."
2513   (interactive)
2514   (save-excursion
2515     (let ((inhibit-point-motion-hooks t)
2516           buffer-read-only)
2517       ;; First make all blank lines empty.
2518       (article-goto-body)
2519       (while (re-search-forward "^[ \t]+$" nil t)
2520         (unless (gnus-annotation-in-region-p
2521                  (match-beginning 0) (match-end 0))
2522           (replace-match "" nil t)))
2523       ;; Then replace multiple empty lines with a single empty line.
2524       (article-goto-body)
2525       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
2526         (unless (gnus-annotation-in-region-p
2527                  (match-beginning 0) (match-end 0))
2528           (delete-region (match-beginning 1) (match-end 1)))))))
2529
2530 (defun article-strip-leading-space ()
2531   "Remove all white space from the beginning of the lines in the article."
2532   (interactive)
2533   (save-excursion
2534     (let ((inhibit-point-motion-hooks t)
2535           buffer-read-only)
2536       (article-goto-body)
2537       (while (re-search-forward "^[ \t]+" nil t)
2538         (replace-match "" t t)))))
2539
2540 (defun article-strip-trailing-space ()
2541   "Remove all white space from the end of the lines in the article."
2542   (interactive)
2543   (save-excursion
2544     (let ((inhibit-point-motion-hooks t)
2545           buffer-read-only)
2546       (article-goto-body)
2547       (while (re-search-forward "[ \t]+$" nil t)
2548         (replace-match "" t t)))))
2549
2550 (defun article-strip-blank-lines ()
2551   "Strip leading, trailing and multiple blank lines."
2552   (interactive)
2553   (article-strip-leading-blank-lines)
2554   (article-remove-trailing-blank-lines)
2555   (article-strip-multiple-blank-lines))
2556
2557 (defun article-strip-all-blank-lines ()
2558   "Strip all blank lines."
2559   (interactive)
2560   (save-excursion
2561     (let ((inhibit-point-motion-hooks t)
2562           buffer-read-only)
2563       (article-goto-body)
2564       (while (re-search-forward "^[ \t]*\n" nil t)
2565         (replace-match "" t t)))))
2566
2567 (defun gnus-article-narrow-to-signature ()
2568   "Narrow to the signature; return t if a signature is found, else nil."
2569   (let ((inhibit-point-motion-hooks t))
2570     (when (gnus-article-search-signature)
2571       (forward-line 1)
2572       ;; Check whether we have some limits to what we consider
2573       ;; to be a signature.
2574       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
2575                       (list gnus-signature-limit)))
2576             limit limited)
2577         (while (setq limit (pop limits))
2578           (if (or (and (integerp limit)
2579                        (< (- (point-max) (point)) limit))
2580                   (and (floatp limit)
2581                        (< (count-lines (point) (point-max)) limit))
2582                   (and (functionp limit)
2583                        (funcall limit))
2584                   (and (stringp limit)
2585                        (not (re-search-forward limit nil t))))
2586               ()                        ; This limit did not succeed.
2587             (setq limited t
2588                   limits nil)))
2589         (unless limited
2590           (narrow-to-region (point) (point-max))
2591           t)))))
2592
2593 (defun gnus-article-search-signature ()
2594   "Search the current buffer for the signature separator.
2595 Put point at the beginning of the signature separator."
2596   (let ((cur (point)))
2597     (goto-char (point-max))
2598     (if (if (stringp gnus-signature-separator)
2599             (re-search-backward gnus-signature-separator nil t)
2600           (let ((seps gnus-signature-separator))
2601             (while (and seps
2602                         (not (re-search-backward (car seps) nil t)))
2603               (pop seps))
2604             seps))
2605         t
2606       (goto-char cur)
2607       nil)))
2608
2609 (defun gnus-article-hidden-arg ()
2610   "Return the current prefix arg as a number, or 0 if no prefix."
2611   (list (if current-prefix-arg
2612             (prefix-numeric-value current-prefix-arg)
2613           0)))
2614
2615 (defun gnus-article-check-hidden-text (type arg)
2616   "Return nil if hiding is necessary.
2617 Arg can be nil or a number.  nil and positive means hide, negative
2618 means show, 0 means toggle."
2619   (save-excursion
2620     (save-restriction
2621       (let ((hide (gnus-article-hidden-text-p type)))
2622         (cond
2623          ((or (null arg)
2624               (> arg 0))
2625           nil)
2626          ((< arg 0)
2627           (gnus-article-show-hidden-text type)
2628           t)
2629          (t
2630           (if (eq hide 'hidden)
2631               (progn
2632                 (gnus-article-show-hidden-text type)
2633                 t)
2634             nil)))))))
2635
2636 (defun gnus-article-hidden-text-p (type)
2637   "Say whether the current buffer contains hidden text of type TYPE."
2638   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
2639     (while (and pos
2640                 (not (get-text-property pos 'invisible))
2641                 (not (get-text-property pos 'dummy-invisible)))
2642       (setq pos
2643             (text-property-any (1+ pos) (point-max) 'article-type type)))
2644     (if pos
2645         'hidden
2646       nil)))
2647
2648 (defun gnus-article-show-hidden-text (type &optional dummy)
2649   "Show all hidden text of type TYPE.
2650 Originally it is hide instead of DUMMY."
2651   (let ((buffer-read-only nil)
2652         (inhibit-point-motion-hooks t))
2653     (gnus-remove-text-properties-when
2654      'article-type type
2655      (point-min) (point-max)
2656      (cons 'article-type (cons type
2657                                gnus-hidden-properties)))
2658     (gnus-delete-wash-type type)))
2659
2660 (defconst article-time-units
2661   `((year . ,(* 365.25 24 60 60))
2662     (week . ,(* 7 24 60 60))
2663     (day . ,(* 24 60 60))
2664     (hour . ,(* 60 60))
2665     (minute . 60)
2666     (second . 1))
2667   "Mapping from time units to seconds.")
2668
2669 (defun gnus-article-forward-header ()
2670   "Move point to the start of the next header.
2671 If the current header is a continuation header, this can be several
2672 lines forward."
2673   (let ((ended nil))
2674     (while (not ended)
2675       (forward-line 1)
2676       (if (looking-at "[ \t]+[^ \t]")
2677           (forward-line 1)
2678         (setq ended t)))))
2679
2680 (defun article-date-ut (&optional type highlight header)
2681   "Convert DATE date to universal time in the current article.
2682 If TYPE is `local', convert to local time; if it is `lapsed', output
2683 how much time has lapsed since DATE.  For `lapsed', the value of
2684 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
2685 should replace the \"Date:\" one, or should be added below it."
2686   (interactive (list 'ut t))
2687   (let* ((header (or header
2688                      (message-fetch-field "date")
2689                      ""))
2690          (tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
2691          (date-regexp
2692           (cond
2693            ((not gnus-article-date-lapsed-new-header)
2694             tdate-regexp)
2695            ((eq type 'lapsed)
2696             "^X-Sent:[ \t]")
2697            (t
2698             "^Date:[ \t]")))
2699          (date (if (vectorp header) (mail-header-date header)
2700                  header))
2701          (inhibit-point-motion-hooks t)
2702          pos
2703          bface eface)
2704     (save-excursion
2705       (save-restriction
2706         (article-narrow-to-head)
2707         (when (re-search-forward tdate-regexp nil t)
2708           (setq bface (get-text-property (gnus-point-at-bol) 'face)
2709                 date (or (get-text-property (gnus-point-at-bol)
2710                                             'original-date)
2711                          date)
2712                 eface (get-text-property (1- (gnus-point-at-eol)) 'face))
2713           (forward-line 1))
2714         (when (and date (not (string= date "")))
2715           (goto-char (point-min))
2716           (let ((buffer-read-only nil))
2717             ;; Delete any old Date headers.
2718             (while (re-search-forward date-regexp nil t)
2719               (if pos
2720                   (delete-region (progn (beginning-of-line) (point))
2721                                  (progn (gnus-article-forward-header)
2722                                         (point)))
2723                 (delete-region (progn (beginning-of-line) (point))
2724                                  (progn (gnus-article-forward-header)
2725                                         (forward-char -1)
2726                                         (point)))
2727                 (setq pos (point))))
2728             (when (and (not pos)
2729                        (re-search-forward tdate-regexp nil t))
2730               (forward-line 1))
2731             (when pos
2732               (goto-char pos))
2733             (insert (article-make-date-line date (or type 'ut)))
2734             (unless pos
2735               (insert "\n")
2736               (forward-line -1))
2737             ;; Do highlighting.
2738             (beginning-of-line)
2739             (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
2740               (put-text-property (match-beginning 1) (1+ (match-end 1))
2741                                  'original-date date)
2742               (put-text-property (match-beginning 1) (1+ (match-end 1))
2743                                  'face bface)
2744               (put-text-property (match-beginning 2) (match-end 2)
2745                                  'face eface))))))))
2746
2747 (defun article-make-date-line (date type)
2748   "Return a DATE line of TYPE."
2749   (unless (memq type '(local ut original user iso8601 lapsed english))
2750     (error "Unknown conversion type: %s" type))
2751   (condition-case ()
2752       (let ((time (date-to-time date)))
2753         (cond
2754          ;; Convert to the local timezone.
2755          ((eq type 'local)
2756           (let ((tz (car (current-time-zone time))))
2757             (format "Date: %s %s%02d%02d" (current-time-string time)
2758                     (if (> tz 0) "+" "-") (/ (abs tz) 3600)
2759                     (/ (% (abs tz) 3600) 60))))
2760          ;; Convert to Universal Time.
2761          ((eq type 'ut)
2762           (concat "Date: "
2763                   (current-time-string
2764                    (let* ((e (parse-time-string date))
2765                           (tm (apply 'encode-time e))
2766                           (ms (car tm))
2767                           (ls (- (cadr tm) (car (current-time-zone time)))))
2768                      (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
2769                            ((> ls 65535) (list (1+ ms) (- ls 65536)))
2770                            (t (list ms ls)))))
2771                   " UT"))
2772          ;; Get the original date from the article.
2773          ((eq type 'original)
2774           (concat "Date: " (if (string-match "\n+$" date)
2775                                (substring date 0 (match-beginning 0))
2776                              date)))
2777          ;; Let the user define the format.
2778          ((eq type 'user)
2779           (let ((format (or (condition-case nil
2780                                 (with-current-buffer gnus-summary-buffer
2781                                   gnus-article-time-format)
2782                               (error nil))
2783                             gnus-article-time-format)))
2784             (if (functionp format)
2785                 (funcall format time)
2786               (concat "Date: " (format-time-string format time)))))
2787          ;; ISO 8601.
2788          ((eq type 'iso8601)
2789           (let ((tz (car (current-time-zone time))))
2790             (concat
2791              "Date: "
2792              (format-time-string "%Y%m%dT%H%M%S" time)
2793              (format "%s%02d%02d"
2794                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
2795                      (/ (% (abs tz) 3600) 60)))))
2796          ;; Do an X-Sent lapsed format.
2797          ((eq type 'lapsed)
2798           ;; If the date is seriously mangled, the timezone functions are
2799           ;; liable to bug out, so we ignore all errors.
2800           (let* ((now (current-time))
2801                  (real-time (subtract-time now time))
2802                  (real-sec (and real-time
2803                                 (+ (* (float (car real-time)) 65536)
2804                                    (cadr real-time))))
2805                  (sec (and real-time (abs real-sec)))
2806                  num prev)
2807             (cond
2808              ((null real-time)
2809               "X-Sent: Unknown")
2810              ((zerop sec)
2811               "X-Sent: Now")
2812              (t
2813               (concat
2814                "X-Sent: "
2815                ;; This is a bit convoluted, but basically we go
2816                ;; through the time units for years, weeks, etc,
2817                ;; and divide things to see whether that results
2818                ;; in positive answers.
2819                (mapconcat
2820                 (lambda (unit)
2821                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
2822                       ;; The (remaining) seconds are too few to
2823                       ;; be divided into this time unit.
2824                       ""
2825                     ;; It's big enough, so we output it.
2826                     (setq sec (- sec (* num (cdr unit))))
2827                     (prog1
2828                         (concat (if prev ", " "") (int-to-string
2829                                                    (floor num))
2830                                 " " (symbol-name (car unit))
2831                                 (if (> num 1) "s" ""))
2832                       (setq prev t))))
2833                 article-time-units "")
2834                ;; If dates are odd, then it might appear like the
2835                ;; article was sent in the future.
2836                (if (> real-sec 0)
2837                    " ago"
2838                  " in the future"))))))
2839          ;; Display the date in proper English
2840          ((eq type 'english)
2841           (let ((dtime (decode-time time)))
2842             (concat
2843              "Date: the "
2844              (number-to-string (nth 3 dtime))
2845              (let ((digit (% (nth 3 dtime) 10)))
2846                (cond
2847                 ((memq (nth 3 dtime) '(11 12 13)) "th")
2848                 ((= digit 1) "st")
2849                 ((= digit 2) "nd")
2850                 ((= digit 3) "rd")
2851                 (t "th")))
2852              " of "
2853              (nth (1- (nth 4 dtime)) gnus-english-month-names)
2854              " "
2855              (number-to-string (nth 5 dtime))
2856              " at "
2857              (format "%02d" (nth 2 dtime))
2858              ":"
2859              (format "%02d" (nth 1 dtime)))))))
2860     (error
2861      (format "Date: %s (from Gnus)" date))))
2862
2863 (defun article-date-local (&optional highlight)
2864   "Convert the current article date to the local timezone."
2865   (interactive (list t))
2866   (article-date-ut 'local highlight))
2867
2868 (defun article-date-english (&optional highlight)
2869   "Convert the current article date to something that is proper English."
2870   (interactive (list t))
2871   (article-date-ut 'english highlight))
2872
2873 (defun article-date-original (&optional highlight)
2874   "Convert the current article date to what it was originally.
2875 This is only useful if you have used some other date conversion
2876 function and want to see what the date was before converting."
2877   (interactive (list t))
2878   (article-date-ut 'original highlight))
2879
2880 (defun article-date-lapsed (&optional highlight)
2881   "Convert the current article date to time lapsed since it was sent."
2882   (interactive (list t))
2883   (article-date-ut 'lapsed highlight))
2884
2885 (defun article-update-date-lapsed ()
2886   "Function to be run from a timer to update the lapsed time line."
2887   (let (deactivate-mark)
2888     (save-excursion
2889       (ignore-errors
2890         (walk-windows
2891          (lambda (w)
2892            (set-buffer (window-buffer w))
2893            (when (eq major-mode 'gnus-article-mode)
2894              (goto-char (point-min))
2895              (when (re-search-forward "^X-Sent:" nil t)
2896                (article-date-lapsed t))))
2897          nil 'visible)))))
2898
2899 (defun gnus-start-date-timer (&optional n)
2900   "Start a timer to update the X-Sent header in the article buffers.
2901 The numerical prefix says how frequently (in seconds) the function
2902 is to run."
2903   (interactive "p")
2904   (unless n
2905     (setq n 1))
2906   (gnus-stop-date-timer)
2907   (setq article-lapsed-timer
2908         (nnheader-run-at-time 1 n 'article-update-date-lapsed)))
2909
2910 (defun gnus-stop-date-timer ()
2911   "Stop the X-Sent timer."
2912   (interactive)
2913   (when article-lapsed-timer
2914     (nnheader-cancel-timer article-lapsed-timer)
2915     (setq article-lapsed-timer nil)))
2916
2917 (defun article-date-user (&optional highlight)
2918   "Convert the current article date to the user-defined format.
2919 This format is defined by the `gnus-article-time-format' variable."
2920   (interactive (list t))
2921   (article-date-ut 'user highlight))
2922
2923 (defun article-date-iso8601 (&optional highlight)
2924   "Convert the current article date to ISO8601."
2925   (interactive (list t))
2926   (article-date-ut 'iso8601 highlight))
2927
2928 ;; (defun article-show-all ()
2929 ;;   "Show all hidden text in the article buffer."
2930 ;;   (interactive)
2931 ;;   (save-excursion
2932 ;;     (let ((buffer-read-only nil))
2933 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
2934
2935 (defun article-remove-leading-whitespace ()
2936   "Remove excessive whitespace from all headers."
2937   (interactive)
2938   (save-excursion
2939     (save-restriction
2940       (let ((buffer-read-only nil))
2941         (article-narrow-to-head)
2942         (goto-char (point-min))
2943         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
2944           (delete-region (match-beginning 1) (match-end 1)))))))
2945
2946 (defun article-emphasize (&optional arg)
2947   "Emphasize text according to `gnus-emphasis-alist'."
2948   (interactive (gnus-article-hidden-arg))
2949   (unless (gnus-article-check-hidden-text 'emphasis arg)
2950     (save-excursion
2951       (let ((alist (or
2952                     (condition-case nil
2953                         (with-current-buffer gnus-summary-buffer
2954                           gnus-article-emphasis-alist)
2955                       (error))
2956                     gnus-emphasis-alist))
2957             (buffer-read-only nil)
2958             (props (append '(article-type emphasis)
2959                            gnus-hidden-properties))
2960             regexp elem beg invisible visible face)
2961         (article-goto-body)
2962         (setq beg (point))
2963         (while (setq elem (pop alist))
2964           (goto-char beg)
2965           (setq regexp (car elem)
2966                 invisible (nth 1 elem)
2967                 visible (nth 2 elem)
2968                 face (nth 3 elem))
2969           (while (re-search-forward regexp nil t)
2970             (when (and (match-beginning visible) (match-beginning invisible))
2971               (gnus-article-hide-text
2972                (match-beginning invisible) (match-end invisible) props)
2973               (gnus-article-unhide-text-type
2974                (match-beginning visible) (match-end visible) 'emphasis)
2975               (gnus-put-overlay-excluding-newlines
2976                (match-beginning visible) (match-end visible) 'face face)
2977               (gnus-add-wash-type 'emphasis)
2978               (goto-char (match-end invisible)))))))))
2979
2980 (defun gnus-article-setup-highlight-words (&optional highlight-words)
2981   "Setup newsgroup emphasis alist."
2982   (unless gnus-article-emphasis-alist
2983     (let ((name (and gnus-newsgroup-name
2984                      (gnus-group-real-name gnus-newsgroup-name))))
2985       (make-local-variable 'gnus-article-emphasis-alist)
2986       (setq gnus-article-emphasis-alist
2987             (nconc
2988              (let ((alist gnus-group-highlight-words-alist) elem highlight)
2989                (while (setq elem (pop alist))
2990                  (when (and name (string-match (car elem) name))
2991                    (setq alist nil
2992                          highlight (copy-sequence (cdr elem)))))
2993                highlight)
2994              (copy-sequence highlight-words)
2995              (if gnus-newsgroup-name
2996                  (copy-sequence (gnus-group-find-parameter
2997                                  gnus-newsgroup-name 'highlight-words t)))
2998              gnus-emphasis-alist)))))
2999
3000 (eval-when-compile
3001   (defvar gnus-summary-article-menu)
3002   (defvar gnus-summary-post-menu))
3003
3004 ;;; Saving functions.
3005
3006 (defun gnus-article-save (save-buffer file &optional num)
3007   "Save the currently selected article."
3008   (unless gnus-save-all-headers
3009     ;; Remove headers according to `gnus-saved-headers'.
3010     (let ((gnus-visible-headers
3011            (or gnus-saved-headers gnus-visible-headers))
3012           (gnus-article-buffer save-buffer))
3013       (save-excursion
3014         (set-buffer save-buffer)
3015         (article-hide-headers 1 t))))
3016   (save-window-excursion
3017     (if (not gnus-default-article-saver)
3018         (error "No default saver is defined")
3019       ;; !!! Magic!  The saving functions all save
3020       ;; `gnus-save-article-buffer' (or so they think), but we
3021       ;; bind that variable to our save-buffer.
3022       (set-buffer gnus-article-buffer)
3023       (let* ((gnus-save-article-buffer save-buffer)
3024              (filename
3025               (cond
3026                ((not gnus-prompt-before-saving) 'default)
3027                ((eq gnus-prompt-before-saving 'always) nil)
3028                (t file)))
3029              (gnus-number-of-articles-to-be-saved
3030               (when (eq gnus-prompt-before-saving t)
3031                 num)))                  ; Magic
3032         (set-buffer gnus-article-current-summary)
3033         (funcall gnus-default-article-saver filename)))))
3034
3035 (defun gnus-read-save-file-name (prompt &optional filename
3036                                         function group headers variable)
3037   (let ((default-name
3038           (funcall function group headers (symbol-value variable)))
3039         result)
3040     (setq result
3041           (expand-file-name
3042            (cond
3043             ((eq filename 'default)
3044              default-name)
3045             ((eq filename t)
3046              default-name)
3047             (filename filename)
3048             (t
3049              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3050                     (prompt
3051                      (format prompt
3052                              (if (and gnus-number-of-articles-to-be-saved
3053                                       (> gnus-number-of-articles-to-be-saved 1))
3054                                  (format "these %d articles"
3055                                          gnus-number-of-articles-to-be-saved)
3056                                "this article")))
3057                     (file
3058                      ;; Let the split methods have their say.
3059                      (cond
3060                       ;; No split name was found.
3061                       ((null split-name)
3062                        (read-file-name
3063                         (concat prompt " (default "
3064                                 (file-name-nondirectory default-name) ") ")
3065                         (file-name-directory default-name)
3066                         default-name))
3067                       ;; A single group name is returned.
3068                       ((stringp split-name)
3069                        (setq default-name
3070                              (funcall function split-name headers
3071                                       (symbol-value variable)))
3072                        (read-file-name
3073                         (concat prompt " (default "
3074                                 (file-name-nondirectory default-name) ") ")
3075                         (file-name-directory default-name)
3076                         default-name))
3077                       ;; A single split name was found
3078                       ((= 1 (length split-name))
3079                        (let* ((name (expand-file-name
3080                                      (car split-name)
3081                                      gnus-article-save-directory))
3082                               (dir (cond ((file-directory-p name)
3083                                           (file-name-as-directory name))
3084                                          ((file-exists-p name) name)
3085                                          (t gnus-article-save-directory))))
3086                          (read-file-name
3087                           (concat prompt " (default " name ") ")
3088                           dir name)))
3089                       ;; A list of splits was found.
3090                       (t
3091                        (setq split-name (nreverse split-name))
3092                        (let (result)
3093                          (let ((file-name-history
3094                                 (nconc split-name file-name-history)))
3095                            (setq result
3096                                  (expand-file-name
3097                                   (read-file-name
3098                                    (concat prompt " (`M-p' for defaults) ")
3099                                    gnus-article-save-directory
3100                                    (car split-name))
3101                                   gnus-article-save-directory)))
3102                          (car (push result file-name-history)))))))
3103                ;; Create the directory.
3104                (gnus-make-directory (file-name-directory file))
3105                ;; If we have read a directory, we append the default file name.
3106                (when (file-directory-p file)
3107                  (setq file (expand-file-name (file-name-nondirectory
3108                                                default-name)
3109                                               (file-name-as-directory file))))
3110                ;; Possibly translate some characters.
3111                (nnheader-translate-file-chars file))))))
3112     (gnus-make-directory (file-name-directory result))
3113     (set variable result)))
3114
3115 (defun gnus-article-archive-name (group)
3116   "Return the first instance of an \"Archive-name\" in the current buffer."
3117   (let ((case-fold-search t))
3118     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3119       (nnheader-concat gnus-article-save-directory
3120                        (match-string 1)))))
3121
3122 (defun gnus-article-nndoc-name (group)
3123   "If GROUP is an nndoc group, return the name of the parent group."
3124   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3125     (gnus-group-get-parameter group 'save-article-group)))
3126
3127 (defun gnus-summary-save-in-rmail (&optional filename)
3128   "Append this article to Rmail file.
3129 Optional argument FILENAME specifies file name.
3130 Directory to save to is default to `gnus-article-save-directory'."
3131   (setq filename (gnus-read-save-file-name
3132                   "Save %s in rmail file:" filename
3133                   gnus-rmail-save-name gnus-newsgroup-name
3134                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3135   (gnus-eval-in-buffer-window gnus-save-article-buffer
3136     (save-excursion
3137       (save-restriction
3138         (widen)
3139         (gnus-output-to-rmail filename))))
3140   filename)
3141
3142 (defun gnus-summary-save-in-mail (&optional filename)
3143   "Append this article to Unix mail file.
3144 Optional argument FILENAME specifies file name.
3145 Directory to save to is default to `gnus-article-save-directory'."
3146   (setq filename (gnus-read-save-file-name
3147                   "Save %s in Unix mail file:" filename
3148                   gnus-mail-save-name gnus-newsgroup-name
3149                   gnus-current-headers 'gnus-newsgroup-last-mail))
3150   (gnus-eval-in-buffer-window gnus-save-article-buffer
3151     (save-excursion
3152       (save-restriction
3153         (widen)
3154         (if (and (file-readable-p filename)
3155                  (file-regular-p filename)
3156                  (mail-file-babyl-p filename))
3157             (rmail-output-to-rmail-file filename t)
3158           (gnus-output-to-mail filename)))))
3159   filename)
3160
3161 (defun gnus-summary-save-in-file (&optional filename overwrite)
3162   "Append this article to file.
3163 Optional argument FILENAME specifies file name.
3164 Directory to save to is default to `gnus-article-save-directory'."
3165   (setq filename (gnus-read-save-file-name
3166                   "Save %s in file:" filename
3167                   gnus-file-save-name gnus-newsgroup-name
3168                   gnus-current-headers 'gnus-newsgroup-last-file))
3169   (gnus-eval-in-buffer-window gnus-save-article-buffer
3170     (save-excursion
3171       (save-restriction
3172         (widen)
3173         (when (and overwrite
3174                    (file-exists-p filename))
3175           (delete-file filename))
3176         (gnus-output-to-file filename))))
3177   filename)
3178
3179 (defun gnus-summary-write-to-file (&optional filename)
3180   "Write this article to a file, overwriting it if the file exists.
3181 Optional argument FILENAME specifies file name.
3182 The directory to save in defaults to `gnus-article-save-directory'."
3183   (gnus-summary-save-in-file nil t))
3184
3185 (defun gnus-summary-save-body-in-file (&optional filename)
3186   "Append this article body to a file.
3187 Optional argument FILENAME specifies file name.
3188 The directory to save in defaults to `gnus-article-save-directory'."
3189   (setq filename (gnus-read-save-file-name
3190                   "Save %s body in file:" filename
3191                   gnus-file-save-name gnus-newsgroup-name
3192                   gnus-current-headers 'gnus-newsgroup-last-file))
3193   (gnus-eval-in-buffer-window gnus-save-article-buffer
3194     (save-excursion
3195       (save-restriction
3196         (widen)
3197         (when (article-goto-body)
3198           (narrow-to-region (point) (point-max)))
3199         (gnus-output-to-file filename))))
3200   filename)
3201
3202 (defun gnus-summary-save-in-pipe (&optional command)
3203   "Pipe this article to subprocess."
3204   (setq command
3205         (cond ((and (eq command 'default)
3206                     gnus-last-shell-command)
3207                gnus-last-shell-command)
3208               ((stringp command)
3209                command)
3210               (t (read-string
3211                   (format
3212                    "Shell command on %s: "
3213                    (if (and gnus-number-of-articles-to-be-saved
3214                             (> gnus-number-of-articles-to-be-saved 1))
3215                        (format "these %d articles"
3216                                gnus-number-of-articles-to-be-saved)
3217                      "this article"))
3218                   gnus-last-shell-command))))
3219   (when (string-equal command "")
3220     (if gnus-last-shell-command
3221         (setq command gnus-last-shell-command)
3222       (error "A command is required")))
3223   (gnus-eval-in-buffer-window gnus-article-buffer
3224     (save-restriction
3225       (widen)
3226       (shell-command-on-region (point-min) (point-max) command nil)))
3227   (setq gnus-last-shell-command command))
3228
3229 (defun gnus-summary-pipe-to-muttprint (&optional command)
3230   "Pipe this article to muttprint."
3231   (setq command (read-string
3232                  "Print using command: " gnus-summary-muttprint-program
3233                  nil gnus-summary-muttprint-program))
3234   (gnus-summary-save-in-pipe command))
3235
3236 ;;; Article file names when saving.
3237
3238 (defun gnus-capitalize-newsgroup (newsgroup)
3239   "Capitalize NEWSGROUP name."
3240   (when (not (zerop (length newsgroup)))
3241     (concat (char-to-string (upcase (aref newsgroup 0)))
3242             (substring newsgroup 1))))
3243
3244 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
3245   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3246 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
3247 Otherwise, it is like ~/News/news/group/num."
3248   (let ((default
3249           (expand-file-name
3250            (concat (if (gnus-use-long-file-name 'not-save)
3251                        (gnus-capitalize-newsgroup newsgroup)
3252                      (gnus-newsgroup-directory-form newsgroup))
3253                    "/" (int-to-string (mail-header-number headers)))
3254            gnus-article-save-directory)))
3255     (if (and last-file
3256              (string-equal (file-name-directory default)
3257                            (file-name-directory last-file))
3258              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3259         default
3260       (or last-file default))))
3261
3262 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
3263   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3264 If variable `gnus-use-long-file-name' is non-nil, it is
3265 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
3266   (let ((default
3267           (expand-file-name
3268            (concat (if (gnus-use-long-file-name 'not-save)
3269                        newsgroup
3270                      (gnus-newsgroup-directory-form newsgroup))
3271                    "/" (int-to-string (mail-header-number headers)))
3272            gnus-article-save-directory)))
3273     (if (and last-file
3274              (string-equal (file-name-directory default)
3275                            (file-name-directory last-file))
3276              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3277         default
3278       (or last-file default))))
3279
3280 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
3281   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3282 If variable `gnus-use-long-file-name' is non-nil, it is
3283 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
3284   (or last-file
3285       (expand-file-name
3286        (if (gnus-use-long-file-name 'not-save)
3287            newsgroup
3288          (file-relative-name
3289           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
3290           default-directory))
3291        gnus-article-save-directory)))
3292
3293 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
3294   "Generate file name from sender."
3295   (let ((from (mail-header-from headers)))
3296     (expand-file-name
3297      (if (and from (string-match "\\([^ <]+\\)@" from))
3298          (match-string 1 from)
3299        "nobody")
3300      gnus-article-save-directory)))
3301
3302 (defun article-verify-x-pgp-sig ()
3303   "Verify X-PGP-Sig."
3304   (interactive)
3305   (if (gnus-buffer-live-p gnus-original-article-buffer)
3306       (let ((sig (with-current-buffer gnus-original-article-buffer
3307                    (gnus-fetch-field "X-PGP-Sig")))
3308             items info headers)
3309         (when (and sig
3310                    mml2015-use
3311                    (mml2015-clear-verify-function))
3312           (with-temp-buffer
3313             (insert-buffer-substring gnus-original-article-buffer)
3314             (setq items (split-string sig))
3315             (message-narrow-to-head)
3316             (let ((inhibit-point-motion-hooks t)
3317                   (case-fold-search t))
3318               ;; Don't verify multiple headers.
3319               (setq headers (mapconcat (lambda (header)
3320                                          (concat header ": "
3321                                                  (mail-fetch-field header)
3322                                                  "\n"))
3323                                        (split-string (nth 1 items) ",") "")))
3324             (delete-region (point-min) (point-max))
3325             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
3326             (insert "X-Signed-Headers: " (nth 1 items) "\n")
3327             (insert headers)
3328             (widen)
3329             (forward-line)
3330             (while (not (eobp))
3331               (if (looking-at "^-")
3332                   (insert "- "))
3333               (forward-line))
3334             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
3335             (insert "Version: " (car items) "\n\n")
3336             (insert (mapconcat 'identity (cddr items) "\n"))
3337             (insert "\n-----END PGP SIGNATURE-----\n")
3338             (let ((mm-security-handle (list (format "multipart/signed"))))
3339               (mml2015-clean-buffer)
3340               (let ((coding-system-for-write (or gnus-newsgroup-charset
3341                                                  'iso-8859-1)))
3342                 (funcall (mml2015-clear-verify-function)))
3343               (setq info
3344                     (or (mm-handle-multipart-ctl-parameter
3345                          mm-security-handle 'gnus-details)
3346                         (mm-handle-multipart-ctl-parameter
3347                          mm-security-handle 'gnus-info)))))
3348           (when info
3349             (let (buffer-read-only bface eface)
3350               (save-restriction
3351                 (message-narrow-to-head)
3352                 (goto-char (point-max))
3353                 (forward-line -1)
3354                 (setq bface (get-text-property (gnus-point-at-bol) 'face)
3355                       eface (get-text-property (1- (gnus-point-at-eol)) 'face))
3356                 (message-remove-header "X-Gnus-PGP-Verify")
3357                 (if (re-search-forward "^X-PGP-Sig:" nil t)
3358                     (forward-line)
3359                   (goto-char (point-max)))
3360                 (narrow-to-region (point) (point))
3361                 (insert "X-Gnus-PGP-Verify: " info "\n")
3362                 (goto-char (point-min))
3363                 (forward-line)
3364                 (while (not (eobp))
3365                   (if (not (looking-at "^[ \t]"))
3366                       (insert " "))
3367                   (forward-line))
3368                 ;; Do highlighting.
3369                 (goto-char (point-min))
3370                 (when (looking-at "\\([^:]+\\): *")
3371                   (put-text-property (match-beginning 1) (1+ (match-end 1))
3372                                      'face bface)
3373                   (put-text-property (match-end 0) (point-max)
3374                                      'face eface)))))))))
3375
3376 (defun article-verify-cancel-lock ()
3377   "Verify Cancel-Lock header."
3378   (interactive)
3379   (if (gnus-buffer-live-p gnus-original-article-buffer)
3380       (canlock-verify gnus-original-article-buffer)))
3381
3382 (eval-and-compile
3383   (mapcar
3384    (lambda (func)
3385      (let (afunc gfunc)
3386        (if (consp func)
3387            (setq afunc (car func)
3388                  gfunc (cdr func))
3389          (setq afunc func
3390                gfunc (intern (format "gnus-%s" func))))
3391        (defalias gfunc
3392          (when (fboundp afunc)
3393            `(lambda (&optional interactive &rest args)
3394               ,(documentation afunc t)
3395               (interactive (list t))
3396               (save-excursion
3397                 (set-buffer gnus-article-buffer)
3398                 (if interactive
3399                     (call-interactively ',afunc)
3400                   (apply ',afunc args))))))))
3401    '(article-hide-headers
3402      article-verify-x-pgp-sig
3403      article-verify-cancel-lock
3404      article-hide-boring-headers
3405      article-treat-overstrike
3406      article-fill-long-lines
3407      article-capitalize-sentences
3408      article-remove-cr
3409      article-remove-leading-whitespace
3410      article-display-x-face
3411      article-display-face
3412      article-de-quoted-unreadable
3413      article-de-base64-unreadable
3414      article-decode-HZ
3415      article-wash-html
3416      article-unsplit-urls
3417      article-hide-list-identifiers
3418      article-strip-banner
3419      article-babel
3420      article-hide-pem
3421      article-hide-signature
3422      article-strip-headers-in-body
3423      article-remove-trailing-blank-lines
3424      article-strip-leading-blank-lines
3425      article-strip-multiple-blank-lines
3426      article-strip-leading-space
3427      article-strip-trailing-space
3428      article-strip-blank-lines
3429      article-strip-all-blank-lines
3430      article-date-local
3431      article-date-english
3432      article-date-iso8601
3433      article-date-original
3434      article-date-ut
3435      article-decode-mime-words
3436      article-decode-charset
3437      article-decode-encoded-words
3438      article-date-user
3439      article-date-lapsed
3440      article-emphasize
3441      article-treat-dumbquotes
3442      article-normalize-headers
3443 ;;     (article-show-all . gnus-article-show-all-headers)
3444      )))
3445 \f
3446 ;;;
3447 ;;; Gnus article mode
3448 ;;;
3449
3450 (put 'gnus-article-mode 'mode-class 'special)
3451
3452 (set-keymap-parent gnus-article-mode-map widget-keymap)
3453
3454 (gnus-define-keys gnus-article-mode-map
3455   " " gnus-article-goto-next-page
3456   "\177" gnus-article-goto-prev-page
3457   [delete] gnus-article-goto-prev-page
3458   [backspace] gnus-article-goto-prev-page
3459   "\C-c^" gnus-article-refer-article
3460   "h" gnus-article-show-summary
3461   "s" gnus-article-show-summary
3462   "\C-c\C-m" gnus-article-mail
3463   "?" gnus-article-describe-briefly
3464   "e" gnus-summary-edit-article
3465   "<" beginning-of-buffer
3466   ">" end-of-buffer
3467   "\C-c\C-i" gnus-info-find-node
3468   "\C-c\C-b" gnus-bug
3469   "R" gnus-article-reply-with-original
3470   "F" gnus-article-followup-with-original
3471   "\C-hk" gnus-article-describe-key
3472   "\C-hc" gnus-article-describe-key-briefly
3473
3474   "\C-d" gnus-article-read-summary-keys
3475   "\M-*" gnus-article-read-summary-keys
3476   "\M-#" gnus-article-read-summary-keys
3477   "\M-^" gnus-article-read-summary-keys
3478   "\M-g" gnus-article-read-summary-keys)
3479
3480 (substitute-key-definition
3481  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
3482
3483 (defun gnus-article-make-menu-bar ()
3484   (unless (boundp 'gnus-article-commands-menu)
3485     (gnus-summary-make-menu-bar))
3486   (gnus-turn-off-edit-menu 'article)
3487   (unless (boundp 'gnus-article-article-menu)
3488     (easy-menu-define
3489      gnus-article-article-menu gnus-article-mode-map ""
3490      '("Article"
3491        ["Scroll forwards" gnus-article-goto-next-page t]
3492        ["Scroll backwards" gnus-article-goto-prev-page t]
3493        ["Show summary" gnus-article-show-summary t]
3494        ["Fetch Message-ID at point" gnus-article-refer-article t]
3495        ["Mail to address at point" gnus-article-mail t]
3496        ["Send a bug report" gnus-bug t]))
3497
3498     (easy-menu-define
3499      gnus-article-treatment-menu gnus-article-mode-map ""
3500      ;; Fixme: this should use :active (and maybe :visible).
3501      '("Treatment"
3502        ["Hide headers" gnus-article-hide-headers t]
3503        ["Hide signature" gnus-article-hide-signature t]
3504        ["Hide citation" gnus-article-hide-citation t]
3505        ["Treat overstrike" gnus-article-treat-overstrike t]
3506        ["Remove carriage return" gnus-article-remove-cr t]
3507        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
3508        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
3509        ["Remove base64" gnus-article-de-base64-unreadable t]
3510        ["Treat html" gnus-article-wash-html t]
3511        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
3512        ["Decode HZ" gnus-article-decode-HZ t]))
3513
3514     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
3515
3516     ;; Note "Post" menu is defined in gnus-sum.el for consistency
3517
3518     (gnus-run-hooks 'gnus-article-menu-hook)))
3519
3520 (defun gnus-article-mode ()
3521   "Major mode for displaying an article.
3522
3523 All normal editing commands are switched off.
3524
3525 The following commands are available in addition to all summary mode
3526 commands:
3527 \\<gnus-article-mode-map>
3528 \\[gnus-article-next-page]\t Scroll the article one page forwards
3529 \\[gnus-article-prev-page]\t Scroll the article one page backwards
3530 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
3531 \\[gnus-article-show-summary]\t Display the summary buffer
3532 \\[gnus-article-mail]\t Send a reply to the address near point
3533 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
3534 \\[gnus-info-find-node]\t Go to the Gnus info node"
3535   (interactive)
3536   (gnus-simplify-mode-line)
3537   (setq mode-name "Article")
3538   (setq major-mode 'gnus-article-mode)
3539   (make-local-variable 'minor-mode-alist)
3540   (use-local-map gnus-article-mode-map)
3541   (when (gnus-visual-p 'article-menu 'menu)
3542     (gnus-article-make-menu-bar)
3543     (when gnus-summary-tool-bar-map
3544       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
3545   (gnus-update-format-specifications nil 'article-mode)
3546   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
3547   (make-local-variable 'gnus-page-broken)
3548   (make-local-variable 'gnus-button-marker-list)
3549   (make-local-variable 'gnus-article-current-summary)
3550   (make-local-variable 'gnus-article-mime-handles)
3551   (make-local-variable 'gnus-article-decoded-p)
3552   (make-local-variable 'gnus-article-mime-handle-alist)
3553   (make-local-variable 'gnus-article-wash-types)
3554   (make-local-variable 'gnus-article-image-alist)
3555   (make-local-variable 'gnus-article-charset)
3556   (make-local-variable 'gnus-article-ignored-charsets)
3557   (gnus-set-default-directory)
3558   (buffer-disable-undo)
3559   (setq buffer-read-only t)
3560   (set-syntax-table gnus-article-mode-syntax-table)
3561   (mm-enable-multibyte)
3562   (gnus-run-hooks 'gnus-article-mode-hook))
3563
3564 (defun gnus-article-setup-buffer ()
3565   "Initialize the article buffer."
3566   (let* ((name (if gnus-single-article-buffer "*Article*"
3567                  (concat "*Article " gnus-newsgroup-name "*")))
3568          (original
3569           (progn (string-match "\\*Article" name)
3570                  (concat " *Original Article"
3571                          (substring name (match-end 0))))))
3572     (setq gnus-article-buffer name)
3573     (setq gnus-original-article-buffer original)
3574     (setq gnus-article-mime-handle-alist nil)
3575     ;; This might be a variable local to the summary buffer.
3576     (unless gnus-single-article-buffer
3577       (save-excursion
3578         (set-buffer gnus-summary-buffer)
3579         (setq gnus-article-buffer name)
3580         (setq gnus-original-article-buffer original)
3581         (gnus-set-global-variables)))
3582     (gnus-article-setup-highlight-words)
3583     ;; Init original article buffer.
3584     (save-excursion
3585       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
3586       (mm-enable-multibyte)
3587       (setq major-mode 'gnus-original-article-mode)
3588       (make-local-variable 'gnus-original-article))
3589     (if (get-buffer name)
3590         (save-excursion
3591           (set-buffer name)
3592           (when (and gnus-article-edit-mode
3593                      (buffer-modified-p)
3594                      (not
3595                       (y-or-n-p "Article mode edit in progress; discard? ")))
3596             (error "Action aborted"))
3597           (set (make-local-variable 'gnus-article-edit-mode) nil)
3598           (when gnus-article-mime-handles
3599             (mm-destroy-parts gnus-article-mime-handles)
3600             (setq gnus-article-mime-handles nil))
3601           ;; Set it to nil in article-buffer!
3602           (setq gnus-article-mime-handle-alist nil)
3603           (buffer-disable-undo)
3604           (setq buffer-read-only t)
3605           ;; This list just keeps growing if we don't reset it.
3606           (setq gnus-button-marker-list nil)
3607           (unless (eq major-mode 'gnus-article-mode)
3608             (gnus-article-mode))
3609           (current-buffer))
3610       (save-excursion
3611         (set-buffer (gnus-get-buffer-create name))
3612         (gnus-article-mode)
3613         (make-local-variable 'gnus-summary-buffer)
3614         (gnus-summary-set-local-parameters gnus-newsgroup-name)
3615         (current-buffer)))))
3616
3617 ;; Set article window start at LINE, where LINE is the number of lines
3618 ;; from the head of the article.
3619 (defun gnus-article-set-window-start (&optional line)
3620   (set-window-start
3621    (gnus-get-buffer-window gnus-article-buffer t)
3622    (save-excursion
3623      (set-buffer gnus-article-buffer)
3624      (goto-char (point-min))
3625      (if (not line)
3626          (point-min)
3627        (gnus-message 6 "Moved to bookmark")
3628        (search-forward "\n\n" nil t)
3629        (forward-line line)
3630        (point)))))
3631
3632 (defun gnus-article-prepare (article &optional all-headers header)
3633   "Prepare ARTICLE in article mode buffer.
3634 ARTICLE should either be an article number or a Message-ID.
3635 If ARTICLE is an id, HEADER should be the article headers.
3636 If ALL-HEADERS is non-nil, no headers are hidden."
3637   (save-excursion
3638     ;; Make sure we start in a summary buffer.
3639     (unless (eq major-mode 'gnus-summary-mode)
3640       (set-buffer gnus-summary-buffer))
3641     (setq gnus-summary-buffer (current-buffer))
3642     (let* ((gnus-article (if header (mail-header-number header) article))
3643            (summary-buffer (current-buffer))
3644            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
3645            (group gnus-newsgroup-name)
3646            result)
3647       (save-excursion
3648         (gnus-article-setup-buffer)
3649         (set-buffer gnus-article-buffer)
3650         ;; Deactivate active regions.
3651         (when (and (boundp 'transient-mark-mode)
3652                    transient-mark-mode)
3653           (setq mark-active nil))
3654         (if (not (setq result (let ((buffer-read-only nil))
3655                                 (gnus-request-article-this-buffer
3656                                  article group))))
3657             ;; There is no such article.
3658             (save-excursion
3659               (when (and (numberp article)
3660                          (not (memq article gnus-newsgroup-sparse)))
3661                 (setq gnus-article-current
3662                       (cons gnus-newsgroup-name article))
3663                 (set-buffer gnus-summary-buffer)
3664                 (setq gnus-current-article article)
3665                 (if (and (memq article gnus-newsgroup-undownloaded)
3666                          (not (gnus-online (gnus-find-method-for-group
3667                                             gnus-newsgroup-name))))
3668                     (progn
3669                       (gnus-summary-set-agent-mark article)
3670                       (message "Message marked for downloading"))
3671                   (gnus-summary-mark-article article gnus-canceled-mark)
3672                   (unless (memq article gnus-newsgroup-sparse)
3673                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
3674           (if (or (eq result 'pseudo)
3675                   (eq result 'nneething))
3676               (progn
3677                 (save-excursion
3678                   (set-buffer summary-buffer)
3679                   (push article gnus-newsgroup-history)
3680                   (setq gnus-last-article gnus-current-article
3681                         gnus-current-article 0
3682                         gnus-current-headers nil
3683                         gnus-article-current nil)
3684                   (if (eq result 'nneething)
3685                       (gnus-configure-windows 'summary)
3686                     (gnus-configure-windows 'article))
3687                   (gnus-set-global-variables))
3688                 (let ((gnus-article-mime-handle-alist-1
3689                        gnus-article-mime-handle-alist))
3690                   (gnus-set-mode-line 'article)))
3691             ;; The result from the `request' was an actual article -
3692             ;; or at least some text that is now displayed in the
3693             ;; article buffer.
3694             (when (and (numberp article)
3695                        (not (eq article gnus-current-article)))
3696               ;; Seems like a new article has been selected.
3697               ;; `gnus-current-article' must be an article number.
3698               (save-excursion
3699                 (set-buffer summary-buffer)
3700                 (push article gnus-newsgroup-history)
3701                 (setq gnus-last-article gnus-current-article
3702                       gnus-current-article article
3703                       gnus-current-headers
3704                       (gnus-summary-article-header gnus-current-article)
3705                       gnus-article-current
3706                       (cons gnus-newsgroup-name gnus-current-article))
3707                 (unless (vectorp gnus-current-headers)
3708                   (setq gnus-current-headers nil))
3709                 (gnus-summary-goto-subject gnus-current-article)
3710                 (when (gnus-summary-show-thread)
3711                   ;; If the summary buffer really was folded, the
3712                   ;; previous goto may not actually have gone to
3713                   ;; the right article, but the thread root instead.
3714                   ;; So we go again.
3715                   (gnus-summary-goto-subject gnus-current-article))
3716                 (gnus-run-hooks 'gnus-mark-article-hook)
3717                 (gnus-set-mode-line 'summary)
3718                 (when (gnus-visual-p 'article-highlight 'highlight)
3719                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
3720                 ;; Set the global newsgroup variables here.
3721                 (gnus-set-global-variables)
3722                 (setq gnus-have-all-headers
3723                       (or all-headers gnus-show-all-headers))))
3724             (save-excursion
3725               (gnus-configure-windows 'article))
3726             (when (or (numberp article)
3727                       (stringp article))
3728               (gnus-article-prepare-display)
3729               ;; Do page break.
3730               (goto-char (point-min))
3731               (setq gnus-page-broken
3732                     (when gnus-break-pages
3733                       (gnus-narrow-to-page)
3734                       t)))
3735             (let ((gnus-article-mime-handle-alist-1
3736                    gnus-article-mime-handle-alist))
3737               (gnus-set-mode-line 'article))
3738             (article-goto-body)
3739             (unless (bobp)
3740               (forward-line -1))
3741             (set-window-point (get-buffer-window (current-buffer)) (point))
3742             (gnus-configure-windows 'article)
3743             t))))))
3744
3745 ;;;###autoload
3746 (defun gnus-article-prepare-display ()
3747   "Make the current buffer look like a nice article."
3748   ;; Hooks for getting information from the article.
3749   ;; This hook must be called before being narrowed.
3750   (let ((gnus-article-buffer (current-buffer))
3751         buffer-read-only)
3752     (unless (eq major-mode 'gnus-article-mode)
3753       (gnus-article-mode))
3754     (setq buffer-read-only nil
3755           gnus-article-wash-types nil
3756           gnus-article-image-alist nil)
3757     (gnus-run-hooks 'gnus-tmp-internal-hook)
3758     (when gnus-display-mime-function
3759       (funcall gnus-display-mime-function))
3760     (gnus-run-hooks 'gnus-article-prepare-hook)))
3761
3762 ;;;
3763 ;;; Gnus MIME viewing functions
3764 ;;;
3765
3766 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
3767   "Format of the MIME buttons.
3768
3769 Valid specifiers include:
3770 %t  The MIME type
3771 %T  MIME type, along with additional info
3772 %n  The `name' parameter
3773 %d  The description, if any
3774 %l  The length of the encoded part
3775 %p  The part identifier number
3776 %e  Dots if the part isn't displayed
3777
3778 General format specifiers can also be used.  See Info node
3779 `(gnus)Formatting Variables'.")
3780
3781 (defvar gnus-mime-button-line-format-alist
3782   '((?t gnus-tmp-type ?s)
3783     (?T gnus-tmp-type-long ?s)
3784     (?n gnus-tmp-name ?s)
3785     (?d gnus-tmp-description ?s)
3786     (?p gnus-tmp-id ?s)
3787     (?l gnus-tmp-length ?d)
3788     (?e gnus-tmp-dots ?s)))
3789
3790 (defvar gnus-mime-button-commands
3791   '((gnus-article-press-button "\r" "Toggle Display")
3792     (gnus-mime-view-part "v" "View Interactively...")
3793     (gnus-mime-view-part-as-type "t" "View As Type...")
3794     (gnus-mime-view-part-as-charset "C" "View As charset...")
3795     (gnus-mime-save-part "o" "Save...")
3796     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
3797     (gnus-mime-delete-part "d" "Delete part")
3798     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
3799     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
3800     (gnus-mime-view-part-internally "E" "View Internally")
3801     (gnus-mime-view-part-externally "e" "View Externally")
3802     (gnus-mime-print-part "p" "Print")
3803     (gnus-mime-pipe-part "|" "Pipe To Command...")
3804     (gnus-mime-action-on-part "." "Take action on the part...")))
3805
3806 (defun gnus-article-mime-part-status ()
3807   (if gnus-article-mime-handle-alist-1
3808       (if (eq 1 (length gnus-article-mime-handle-alist-1))
3809           " (1 part)"
3810         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
3811     ""))
3812
3813 (defvar gnus-mime-button-map
3814   (let ((map (make-sparse-keymap)))
3815     (unless (>= (string-to-number emacs-version) 21)
3816       ;; XEmacs doesn't care.
3817       (set-keymap-parent map gnus-article-mode-map))
3818     (define-key map gnus-mouse-2 'gnus-article-push-button)
3819     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
3820     (dolist (c gnus-mime-button-commands)
3821       (define-key map (cadr c) (car c)))
3822     map))
3823
3824 (easy-menu-define
3825   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
3826   `("MIME Part"
3827     ,@(mapcar (lambda (c)
3828                 (vector (caddr c) (car c) :enable t))
3829               gnus-mime-button-commands)))
3830
3831 (eval-when-compile
3832   (define-compiler-macro popup-menu (&whole form
3833                                             menu &optional position prefix)
3834     (if (and (fboundp 'popup-menu)
3835              (not (memq 'popup-menu (assoc "lmenu" load-history))))
3836         form
3837       ;; Gnus is probably running under Emacs 20.
3838       `(let* ((menu (cdr ,menu))
3839               (response (x-popup-menu
3840                          t (list (car menu)
3841                                  (cons "" (mapcar (lambda (c)
3842                                                     (cons (caddr c) (car c)))
3843                                                   (cdr menu)))))))
3844          (if response
3845              (call-interactively (nth 3 (assq response menu))))))))
3846
3847 (defun gnus-mime-button-menu (event prefix)
3848  "Construct a context-sensitive menu of MIME commands."
3849  (interactive "e\nP")
3850  (save-window-excursion
3851    (let ((pos (event-start event)))
3852      (select-window (posn-window pos))
3853      (goto-char (posn-point pos))
3854      (gnus-article-check-buffer)
3855      (popup-menu gnus-mime-button-menu nil prefix))))
3856
3857 (defun gnus-mime-view-all-parts (&optional handles)
3858   "View all the MIME parts."
3859   (interactive)
3860   (save-current-buffer
3861     (set-buffer gnus-article-buffer)
3862     (let ((handles (or handles gnus-article-mime-handles))
3863           (mail-parse-charset gnus-newsgroup-charset)
3864           (mail-parse-ignored-charsets
3865            (with-current-buffer gnus-summary-buffer
3866              gnus-newsgroup-ignored-charsets)))
3867       (when handles
3868         (mm-remove-parts handles)
3869         (goto-char (point-min))
3870         (or (search-forward "\n\n") (goto-char (point-max)))
3871         (let (buffer-read-only)
3872           (delete-region (point) (point-max))
3873           (mm-display-parts handles))))))
3874
3875 (defun gnus-mime-save-part-and-strip ()
3876   "Save the MIME part under point then replace it with an external body."
3877   (interactive)
3878   (gnus-article-check-buffer)
3879   (let* ((data (get-text-property (point) 'gnus-data))
3880          file param
3881          (handles gnus-article-mime-handles))
3882     (if (mm-multiple-handles gnus-article-mime-handles)
3883         (error "This function is not implemented"))
3884     (setq file (and data (mm-save-part data)))
3885     (when file
3886       (with-current-buffer (mm-handle-buffer data)
3887         (erase-buffer)
3888         (insert "Content-Type: " (mm-handle-media-type data))
3889         (mml-insert-parameter-string (cdr (mm-handle-type data))
3890                                      '(charset))
3891         (insert "\n")
3892         (insert "Content-ID: " (message-make-message-id) "\n")
3893         (insert "Content-Transfer-Encoding: binary\n")
3894         (insert "\n"))
3895       (setcdr data
3896               (cdr (mm-make-handle nil
3897                                    `("message/external-body"
3898                                      (access-type . "LOCAL-FILE")
3899                                      (name . ,file)))))
3900       (set-buffer gnus-summary-buffer)
3901       (gnus-article-edit-article
3902        `(lambda ()
3903            (erase-buffer)
3904            (let ((mail-parse-charset (or gnus-article-charset
3905                                          ',gnus-newsgroup-charset))
3906                  (mail-parse-ignored-charsets
3907                   (or gnus-article-ignored-charsets
3908                       ',gnus-newsgroup-ignored-charsets))
3909                  (mbl mml-buffer-list))
3910              (setq mml-buffer-list nil)
3911              (insert-buffer gnus-original-article-buffer)
3912              (mime-to-mml ',handles)
3913              (setq gnus-article-mime-handles nil)
3914              (let ((mbl1 mml-buffer-list))
3915                (setq mml-buffer-list mbl)
3916                (set (make-local-variable 'mml-buffer-list) mbl1))
3917              (gnus-make-local-hook 'kill-buffer-hook)
3918              (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
3919        `(lambda (no-highlight)
3920           (let ((mail-parse-charset (or gnus-article-charset
3921                                         ',gnus-newsgroup-charset))
3922                 (message-options message-options)
3923                 (message-options-set-recipient)
3924                 (mail-parse-ignored-charsets
3925                  (or gnus-article-ignored-charsets
3926                      ',gnus-newsgroup-ignored-charsets)))
3927            (mml-to-mime)
3928            (mml-destroy-buffers)
3929            (remove-hook 'kill-buffer-hook
3930                         'mml-destroy-buffers t)
3931            (kill-local-variable 'mml-buffer-list))
3932           (gnus-summary-edit-article-done
3933            ,(or (mail-header-references gnus-current-headers) "")
3934            ,(gnus-group-read-only-p)
3935            ,gnus-summary-buffer no-highlight))))))
3936
3937 (defun gnus-mime-delete-part ()
3938   "Delete the MIME part under point.
3939 Replace it with some information about the removed part."
3940   (interactive)
3941   (gnus-article-check-buffer)
3942   (unless (and gnus-novice-user
3943                (not (gnus-yes-or-no-p
3944                      "Really delete attachment forever? ")))
3945     (let* ((data (get-text-property (point) 'gnus-data))
3946            (handles gnus-article-mime-handles)
3947            (none "(none)")
3948            (description
3949             (or
3950              (mail-decode-encoded-word-string (or (mm-handle-description data)
3951                                                   none))))
3952            (filename
3953             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
3954                 none))
3955            (type (mm-handle-media-type data)))
3956       (if (mm-multiple-handles gnus-article-mime-handles)
3957           (error "This function is not implemented"))
3958       (with-current-buffer (mm-handle-buffer data)
3959         (let ((bsize (format "%s" (buffer-size))))
3960           (erase-buffer)
3961           (insert
3962            (concat
3963             "<#part type=text/plain nofile=yes disposition=attachment"
3964             " description=\"Deleted attachment (" bsize " Byte)\">"
3965             ",----\n"
3966             "| The following attachment has been deleted:\n"
3967             "|\n"
3968             "| Type:           " type "\n"
3969             "| Filename:       " filename "\n"
3970             "| Size (encoded): " bsize " Byte\n"
3971             "| Description:    " description "\n"
3972             "`----\n"
3973             "<#/part>"))
3974           (setcdr data
3975                   (cdr (mm-make-handle nil `("text/plain"))))))
3976       (set-buffer gnus-summary-buffer)
3977       ;; FIXME: maybe some of the following code (borrowed from
3978       ;; `gnus-mime-save-part-and-strip') isn't necessary?
3979       (gnus-article-edit-article
3980        `(lambda ()
3981           (erase-buffer)
3982           (let ((mail-parse-charset (or gnus-article-charset
3983                                         ',gnus-newsgroup-charset))
3984                 (mail-parse-ignored-charsets
3985                  (or gnus-article-ignored-charsets
3986                      ',gnus-newsgroup-ignored-charsets))
3987                 (mbl mml-buffer-list))
3988             (setq mml-buffer-list nil)
3989             (insert-buffer gnus-original-article-buffer)
3990             (mime-to-mml ',handles)
3991             (setq gnus-article-mime-handles nil)
3992             (let ((mbl1 mml-buffer-list))
3993               (setq mml-buffer-list mbl)
3994               (set (make-local-variable 'mml-buffer-list) mbl1))
3995             (gnus-make-local-hook 'kill-buffer-hook)
3996             (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
3997        `(lambda (no-highlight)
3998           (let ((mail-parse-charset (or gnus-article-charset
3999                                         ',gnus-newsgroup-charset))
4000                 (message-options message-options)
4001                 (message-options-set-recipient)
4002                 (mail-parse-ignored-charsets
4003                  (or gnus-article-ignored-charsets
4004                      ',gnus-newsgroup-ignored-charsets)))
4005             (mml-to-mime)
4006             (mml-destroy-buffers)
4007             (remove-hook 'kill-buffer-hook
4008                          'mml-destroy-buffers t)
4009             (kill-local-variable 'mml-buffer-list))
4010           (gnus-summary-edit-article-done
4011            ,(or (mail-header-references gnus-current-headers) "")
4012            ,(gnus-group-read-only-p)
4013            ,gnus-summary-buffer no-highlight)))))
4014   ;; Not in `gnus-mime-save-part-and-strip':
4015   (gnus-article-edit-done)
4016   (gnus-summary-expand-window)
4017   (gnus-summary-show-article))
4018
4019 (defun gnus-mime-save-part ()
4020   "Save the MIME part under point."
4021   (interactive)
4022   (gnus-article-check-buffer)
4023   (let ((data (get-text-property (point) 'gnus-data)))
4024     (when data
4025       (mm-save-part data))))
4026
4027 (defun gnus-mime-pipe-part ()
4028   "Pipe the MIME part under point to a process."
4029   (interactive)
4030   (gnus-article-check-buffer)
4031   (let ((data (get-text-property (point) 'gnus-data)))
4032     (when data
4033       (mm-pipe-part data))))
4034
4035 (defun gnus-mime-view-part ()
4036   "Interactively choose a viewing method for the MIME part under point."
4037   (interactive)
4038   (gnus-article-check-buffer)
4039   (let ((data (get-text-property (point) 'gnus-data)))
4040     (when data
4041       (setq gnus-article-mime-handles
4042             (mm-merge-handles
4043              gnus-article-mime-handles (setq data (copy-sequence data))))
4044       (mm-interactively-view-part data))))
4045
4046 (defun gnus-mime-view-part-as-type-internal ()
4047   (gnus-article-check-buffer)
4048   (let* ((name (mail-content-type-get
4049                 (mm-handle-type (get-text-property (point) 'gnus-data))
4050                 'name))
4051          (def-type (and name (mm-default-file-encoding name))))
4052     (and def-type (cons def-type 0))))
4053
4054 (defun gnus-mime-view-part-as-type (&optional mime-type)
4055   "Choose a MIME media type, and view the part as such."
4056   (interactive)
4057   (unless mime-type
4058     (setq mime-type (completing-read
4059                      "View as MIME type: "
4060                      (mapcar #'list (mailcap-mime-types))
4061                      nil nil
4062                      (gnus-mime-view-part-as-type-internal))))
4063   (gnus-article-check-buffer)
4064   (let ((handle (get-text-property (point) 'gnus-data)))
4065     (when handle
4066       (setq handle
4067             (mm-make-handle (mm-handle-buffer handle)
4068                             (cons mime-type (cdr (mm-handle-type handle)))
4069                             (mm-handle-encoding handle)
4070                             (mm-handle-undisplayer handle)
4071                             (mm-handle-disposition handle)
4072                             (mm-handle-description handle)
4073                             nil
4074                             (mm-handle-id handle)))
4075       (setq gnus-article-mime-handles
4076             (mm-merge-handles gnus-article-mime-handles handle))
4077       (gnus-mm-display-part handle))))
4078
4079 (eval-when-compile
4080   (require 'jka-compr))
4081
4082 ;; jka-compr.el uses a "sh -c" to direct stderr to err-file, but these days
4083 ;; emacs can do that itself.
4084 ;;
4085 (defun gnus-mime-jka-compr-maybe-uncompress ()
4086   "Uncompress the current buffer if `auto-compression-mode' is enabled.
4087 The uncompress method used is derived from `buffer-file-name'."
4088   (when (and (fboundp 'jka-compr-installed-p)
4089              (jka-compr-installed-p))
4090     (let ((info (jka-compr-get-compression-info buffer-file-name)))
4091       (when info
4092         (let ((basename (file-name-nondirectory buffer-file-name))
4093               (args     (jka-compr-info-uncompress-args    info))
4094               (prog     (jka-compr-info-uncompress-program info))
4095               (message  (jka-compr-info-uncompress-message info))
4096               (err-file (jka-compr-make-temp-name)))
4097           (if message
4098               (message "%s %s..." message basename))
4099           (unwind-protect
4100               (unless (memq (apply 'call-process-region
4101                                    (point-min) (point-max)
4102                                    prog
4103                                    t (list t err-file) nil
4104                                    args)
4105                             jka-compr-acceptable-retval-list)
4106                 (jka-compr-error prog args basename message err-file))
4107             (jka-compr-delete-temp-file err-file)))))))
4108
4109 (defun gnus-mime-copy-part (&optional handle)
4110   "Put the MIME part under point into a new buffer.
4111 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
4112 are decompressed."
4113   (interactive)
4114   (gnus-article-check-buffer)
4115   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4116          (contents (and handle (mm-get-part handle)))
4117          (base (and handle
4118                     (file-name-nondirectory
4119                      (or
4120                       (mail-content-type-get (mm-handle-type handle) 'name)
4121                       (mail-content-type-get (mm-handle-disposition handle)
4122                                              'filename)
4123                       "*decoded*"))))
4124          (buffer (and base (generate-new-buffer base))))
4125     (when contents
4126       (switch-to-buffer buffer)
4127       (insert contents)
4128       ;; We do it this way to make `normal-mode' set the appropriate mode.
4129       (unwind-protect
4130           (progn
4131             (setq buffer-file-name (expand-file-name base))
4132             (gnus-mime-jka-compr-maybe-uncompress)
4133             (normal-mode))
4134         (setq buffer-file-name nil))
4135       (goto-char (point-min)))))
4136
4137 (defun gnus-mime-print-part (&optional handle filename)
4138   "Print the MIME part under point."
4139   (interactive (list nil (ps-print-preprint current-prefix-arg)))
4140   (gnus-article-check-buffer)
4141   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4142          (contents (and handle (mm-get-part handle)))
4143          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
4144          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
4145     (when contents
4146         (if printer
4147             (unwind-protect
4148                 (progn
4149                   (mm-save-part-to-file handle file)
4150                   (call-process shell-file-name nil
4151                                 (generate-new-buffer " *mm*")
4152                                 nil
4153                                 shell-command-switch
4154                                 (mm-mailcap-command
4155                                  printer file (mm-handle-type handle))))
4156               (delete-file file))
4157           (with-temp-buffer
4158             (insert contents)
4159             (gnus-print-buffer))
4160           (ps-despool filename)))))
4161
4162 (defun gnus-mime-inline-part (&optional handle arg)
4163   "Insert the MIME part under point into the current buffer."
4164   (interactive (list nil current-prefix-arg))
4165   (gnus-article-check-buffer)
4166   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4167          contents charset
4168          (b (point))
4169          buffer-read-only)
4170     (when handle
4171       (if (and (not arg) (mm-handle-undisplayer handle))
4172           (mm-remove-part handle)
4173         (setq contents (mm-get-part handle))
4174         (cond
4175          ((not arg)
4176           (setq charset (or (mail-content-type-get
4177                              (mm-handle-type handle) 'charset)
4178                             gnus-newsgroup-charset)))
4179          ((numberp arg)
4180           (if (mm-handle-undisplayer handle)
4181               (mm-remove-part handle))
4182           (setq charset
4183                 (or (cdr (assq arg
4184                                gnus-summary-show-article-charset-alist))
4185                     (mm-read-coding-system "Charset: ")))))
4186         (forward-line 2)
4187         (mm-insert-inline handle
4188                           (if (and charset
4189                                    (setq charset (mm-charset-to-coding-system
4190                                                   charset))
4191                                    (not (eq charset 'ascii)))
4192                               (mm-decode-coding-string contents charset)
4193                             contents))
4194         (goto-char b)))))
4195
4196 (defun gnus-mime-view-part-as-charset (&optional handle arg)
4197   "Insert the MIME part under point into the current buffer using the
4198 specified charset."
4199   (interactive (list nil current-prefix-arg))
4200   (gnus-article-check-buffer)
4201   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4202          contents charset
4203          (b (point))
4204          buffer-read-only)
4205     (when handle
4206       (if (mm-handle-undisplayer handle)
4207           (mm-remove-part handle))
4208       (let ((gnus-newsgroup-charset
4209              (or (cdr (assq arg
4210                             gnus-summary-show-article-charset-alist))
4211                  (mm-read-coding-system "Charset: ")))
4212           (gnus-newsgroup-ignored-charsets 'gnus-all))
4213         (gnus-article-press-button)))))
4214
4215 (defun gnus-mime-view-part-externally (&optional handle)
4216   "View the MIME part under point with an external viewer."
4217   (interactive)
4218   (gnus-article-check-buffer)
4219   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4220          (mm-user-display-methods nil)
4221          (mm-inlined-types nil)
4222          (mail-parse-charset gnus-newsgroup-charset)
4223          (mail-parse-ignored-charsets
4224           (save-excursion (set-buffer gnus-summary-buffer)
4225                           gnus-newsgroup-ignored-charsets)))
4226     (when handle
4227       (if (mm-handle-undisplayer handle)
4228           (mm-remove-part handle)
4229         (mm-display-part handle)))))
4230
4231 (defun gnus-mime-view-part-internally (&optional handle)
4232   "View the MIME part under point with an internal viewer.
4233 If no internal viewer is available, use an external viewer."
4234   (interactive)
4235   (gnus-article-check-buffer)
4236   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4237          (mm-inlined-types '(".*"))
4238          (mm-inline-large-images t)
4239          (mail-parse-charset gnus-newsgroup-charset)
4240          (mail-parse-ignored-charsets
4241           (save-excursion (set-buffer gnus-summary-buffer)
4242                           gnus-newsgroup-ignored-charsets))
4243          buffer-read-only)
4244     (when handle
4245       (if (mm-handle-undisplayer handle)
4246           (mm-remove-part handle)
4247         (mm-display-part handle)))))
4248
4249 (defun gnus-mime-action-on-part (&optional action)
4250   "Do something with the MIME attachment at \(point\)."
4251   (interactive
4252    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
4253   (gnus-article-check-buffer)
4254   (let ((action-pair (assoc action gnus-mime-action-alist)))
4255     (if action-pair
4256         (funcall (cdr action-pair)))))
4257
4258 (defun gnus-article-part-wrapper (n function)
4259   (save-current-buffer
4260     (set-buffer gnus-article-buffer)
4261     (when (> n (length gnus-article-mime-handle-alist))
4262       (error "No such part"))
4263     (gnus-article-goto-part n)
4264     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4265       (funcall function handle))))
4266
4267 (defun gnus-article-pipe-part (n)
4268   "Pipe MIME part N, which is the numerical prefix."
4269   (interactive "p")
4270   (gnus-article-part-wrapper n 'mm-pipe-part))
4271
4272 (defun gnus-article-save-part (n)
4273   "Save MIME part N, which is the numerical prefix."
4274   (interactive "p")
4275   (gnus-article-part-wrapper n 'mm-save-part))
4276
4277 (defun gnus-article-interactively-view-part (n)
4278   "View MIME part N interactively, which is the numerical prefix."
4279   (interactive "p")
4280   (gnus-article-part-wrapper n 'mm-interactively-view-part))
4281
4282 (defun gnus-article-copy-part (n)
4283   "Copy MIME part N, which is the numerical prefix."
4284   (interactive "p")
4285   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
4286
4287 (defun gnus-article-view-part-as-charset (n)
4288   "Copy MIME part N, which is the numerical prefix."
4289   (interactive "p")
4290   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
4291
4292 (defun gnus-article-view-part-externally (n)
4293   "View MIME part N externally, which is the numerical prefix."
4294   (interactive "p")
4295   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
4296
4297 (defun gnus-article-inline-part (n)
4298   "Inline MIME part N, which is the numerical prefix."
4299   (interactive "p")
4300   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
4301
4302 (defun gnus-article-mime-match-handle-first (condition)
4303   (if condition
4304       (let ((alist gnus-article-mime-handle-alist) ihandle n)
4305         (while (setq ihandle (pop alist))
4306           (if (and (cond
4307                     ((functionp condition)
4308                      (funcall condition (cdr ihandle)))
4309                     ((eq condition 'undisplayed)
4310                      (not (or (mm-handle-undisplayer (cdr ihandle))
4311                               (equal (mm-handle-media-type (cdr ihandle))
4312                                      "multipart/alternative"))))
4313                     ((eq condition 'undisplayed-alternative)
4314                      (not (mm-handle-undisplayer (cdr ihandle))))
4315                     (t t))
4316                    (gnus-article-goto-part (car ihandle))
4317                    (or (not n) (< (car ihandle) n)))
4318               (setq n (car ihandle))))
4319         (or n 1))
4320     1))
4321
4322 (defun gnus-article-view-part (&optional n)
4323   "View MIME part N, which is the numerical prefix."
4324   (interactive "P")
4325   (save-current-buffer
4326     (set-buffer gnus-article-buffer)
4327     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
4328                              gnus-article-mime-match-handle-function)))
4329     (when (> n (length gnus-article-mime-handle-alist))
4330       (error "No such part"))
4331     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4332       (when (gnus-article-goto-part n)
4333         (if (equal (car handle) "multipart/alternative")
4334             (gnus-article-press-button)
4335           (when (eq (gnus-mm-display-part handle) 'internal)
4336             (gnus-set-window-start)))))))
4337
4338 (defsubst gnus-article-mime-total-parts ()
4339   (if (bufferp (car gnus-article-mime-handles))
4340       1 ;; single part
4341     (1- (length gnus-article-mime-handles))))
4342
4343 (defun gnus-mm-display-part (handle)
4344   "Display HANDLE and fix MIME button."
4345   (let ((id (get-text-property (point) 'gnus-part))
4346         (point (point))
4347         buffer-read-only)
4348     (forward-line 1)
4349     (prog1
4350         (let ((window (selected-window))
4351               (mail-parse-charset gnus-newsgroup-charset)
4352               (mail-parse-ignored-charsets
4353                (if (gnus-buffer-live-p gnus-summary-buffer)
4354                    (save-excursion
4355                      (set-buffer gnus-summary-buffer)
4356                      gnus-newsgroup-ignored-charsets)
4357                  nil)))
4358           (save-excursion
4359             (unwind-protect
4360                 (let ((win (gnus-get-buffer-window (current-buffer) t))
4361                       (beg (point)))
4362                   (when win
4363                     (select-window win))
4364                   (goto-char point)
4365                   (forward-line)
4366                   (if (mm-handle-displayed-p handle)
4367                       ;; This will remove the part.
4368                       (mm-display-part handle)
4369                     (save-restriction
4370                       (narrow-to-region (point)
4371                                         (if (eobp) (point) (1+ (point))))
4372                       (mm-display-part handle)
4373                       ;; We narrow to the part itself and
4374                       ;; then call the treatment functions.
4375                       (goto-char (point-min))
4376                       (forward-line 1)
4377                       (narrow-to-region (point) (point-max))
4378                       (gnus-treat-article
4379                        nil id
4380                        (gnus-article-mime-total-parts)
4381                        (mm-handle-media-type handle)))))
4382               (if (window-live-p window)
4383                   (select-window window)))))
4384       (goto-char point)
4385       (gnus-delete-line)
4386       (gnus-insert-mime-button
4387        handle id (list (mm-handle-displayed-p handle)))
4388       (goto-char point))))
4389
4390 (defun gnus-article-goto-part (n)
4391   "Go to MIME part N."
4392   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
4393
4394 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
4395   (let ((gnus-tmp-name
4396          (or (mail-content-type-get (mm-handle-type handle) 'name)
4397              (mail-content-type-get (mm-handle-disposition handle) 'filename)
4398              (mail-content-type-get (mm-handle-type handle) 'url)
4399              ""))
4400         (gnus-tmp-type (mm-handle-media-type handle))
4401         (gnus-tmp-description
4402          (mail-decode-encoded-word-string (or (mm-handle-description handle)
4403                                               "")))
4404         (gnus-tmp-dots
4405          (if (if displayed (car displayed)
4406                (mm-handle-displayed-p handle))
4407              "" "..."))
4408         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
4409                            (buffer-size)))
4410         gnus-tmp-type-long b e)
4411     (when (string-match ".*/" gnus-tmp-name)
4412       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
4413     (setq gnus-tmp-type-long (concat gnus-tmp-type
4414                                      (and (not (equal gnus-tmp-name ""))
4415                                           (concat "; " gnus-tmp-name))))
4416     (unless (equal gnus-tmp-description "")
4417       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
4418     (unless (bolp)
4419       (insert "\n"))
4420     (setq b (point))
4421     (gnus-eval-format
4422      gnus-mime-button-line-format gnus-mime-button-line-format-alist
4423      `(,@(gnus-local-map-property gnus-mime-button-map)
4424          gnus-callback gnus-mm-display-part
4425          gnus-part ,gnus-tmp-id
4426          article-type annotation
4427          gnus-data ,handle))
4428     (setq e (if (bolp)
4429                 ;; Exclude a newline.
4430                 (1- (point))
4431               (point)))
4432     (widget-convert-button
4433      'link b e
4434      :mime-handle handle
4435      :action 'gnus-widget-press-button
4436      :button-keymap gnus-mime-button-map
4437      :help-echo
4438      (lambda (widget/window &optional overlay pos)
4439        ;; Needed to properly clear the message due to a bug in
4440        ;; wid-edit (XEmacs only).
4441        (if (boundp 'help-echo-owns-message)
4442            (setq help-echo-owns-message t))
4443        (format
4444         "%S: %s the MIME part; %S: more options"
4445         (aref gnus-mouse-2 0)
4446         ;; XEmacs will get a single widget arg; Emacs 21 will get
4447         ;; window, overlay, position.
4448         (if (mm-handle-displayed-p
4449              (if overlay
4450                  (with-current-buffer (gnus-overlay-buffer overlay)
4451                    (widget-get (widget-at (gnus-overlay-start overlay))
4452                                :mime-handle))
4453                (widget-get widget/window :mime-handle)))
4454             "hide" "show")
4455         (aref gnus-down-mouse-3 0))))))
4456
4457 (defun gnus-widget-press-button (elems el)
4458   (goto-char (widget-get elems :from))
4459   (gnus-article-press-button))
4460
4461 (defvar gnus-displaying-mime nil)
4462
4463 (defun gnus-display-mime (&optional ihandles)
4464   "Display the MIME parts."
4465   (save-excursion
4466     (save-selected-window
4467       (let ((window (get-buffer-window gnus-article-buffer))
4468             (point (point)))
4469         (when window
4470           (select-window window)
4471           ;; We have to do this since selecting the window
4472           ;; may change the point.  So we set the window point.
4473           (set-window-point window point)))
4474       (let* ((handles (or ihandles
4475                           (mm-dissect-buffer nil gnus-article-loose-mime)
4476                           (and gnus-article-emulate-mime
4477                                (mm-uu-dissect))))
4478              buffer-read-only handle name type b e display)
4479         (when (and (not ihandles)
4480                    (not gnus-displaying-mime))
4481           ;; Top-level call; we clean up.
4482           (when gnus-article-mime-handles
4483             (mm-destroy-parts gnus-article-mime-handles)
4484             (setq gnus-article-mime-handle-alist nil));; A trick.
4485           (setq gnus-article-mime-handles handles)
4486           ;; We allow users to glean info from the handles.
4487           (when gnus-article-mime-part-function
4488             (gnus-mime-part-function handles)))
4489         (if (and handles
4490                  (or (not (stringp (car handles)))
4491                      (cdr handles)))
4492             (progn
4493               (when (and (not ihandles)
4494                          (not gnus-displaying-mime))
4495                 ;; Clean up for mime parts.
4496                 (article-goto-body)
4497                 (delete-region (point) (point-max)))
4498               (let ((gnus-displaying-mime t))
4499                 (gnus-mime-display-part handles)))
4500           (save-restriction
4501             (article-goto-body)
4502             (narrow-to-region (point) (point-max))
4503             (gnus-treat-article nil 1 1)
4504             (widen)))
4505         (unless ihandles
4506           ;; Highlight the headers.
4507           (save-excursion
4508             (save-restriction
4509               (article-goto-body)
4510               (narrow-to-region (point-min) (point))
4511               (gnus-treat-article 'head))))))))
4512
4513 (defcustom gnus-mime-display-multipart-as-mixed nil
4514   "Display \"multipart\" parts as  \"multipart/mixed\".
4515
4516 If `t', it overrides `nil' values of
4517 `gnus-mime-display-multipart-alternative-as-mixed' and
4518 `gnus-mime-display-multipart-related-as-mixed'."
4519   :group 'gnus-article-mime
4520   :type 'boolean)
4521
4522 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
4523   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
4524   :group 'gnus-article-mime
4525   :type 'boolean)
4526
4527 (defcustom gnus-mime-display-multipart-related-as-mixed nil
4528   "Display \"multipart/related\" parts as  \"multipart/mixed\".
4529
4530 If displaying \"text/html\" is discouraged \(see
4531 `mm-discouraged-alternatives'\) images or other material inside a
4532 \"multipart/related\" part might be overlooked when this variable is `nil'."
4533   :group 'gnus-article-mime
4534   :type 'boolean)
4535
4536 (defun gnus-mime-display-part (handle)
4537   (cond
4538    ;; Single part.
4539    ((not (stringp (car handle)))
4540     (gnus-mime-display-single handle))
4541    ;; User-defined multipart
4542    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
4543     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
4544              handle))
4545    ;; multipart/alternative
4546    ((and (equal (car handle) "multipart/alternative")
4547          (not (or gnus-mime-display-multipart-as-mixed
4548                   gnus-mime-display-multipart-alternative-as-mixed)))
4549     (let ((id (1+ (length gnus-article-mime-handle-alist))))
4550       (push (cons id handle) gnus-article-mime-handle-alist)
4551       (gnus-mime-display-alternative (cdr handle) nil nil id)))
4552    ;; multipart/related
4553    ((and (equal (car handle) "multipart/related")
4554          (not (or gnus-mime-display-multipart-as-mixed
4555                   gnus-mime-display-multipart-related-as-mixed)))
4556     ;;;!!!We should find the start part, but we just default
4557     ;;;!!!to the first part.
4558     ;;(gnus-mime-display-part (cadr handle))
4559     ;;;!!! Most multipart/related is an HTML message plus images.
4560     ;;;!!! Unfortunately we are unable to let W3 display those
4561     ;;;!!! included images, so we just display it as a mixed multipart.
4562     ;;(gnus-mime-display-mixed (cdr handle))
4563     ;;;!!! No, w3 can display everything just fine.
4564     (gnus-mime-display-part (cadr handle)))
4565    ((equal (car handle) "multipart/signed")
4566     (gnus-add-wash-type 'signed)
4567     (gnus-mime-display-security handle))
4568    ((equal (car handle) "multipart/encrypted")
4569     (gnus-add-wash-type 'encrypted)
4570     (gnus-mime-display-security handle))
4571    ;; Other multiparts are handled like multipart/mixed.
4572    (t
4573     (gnus-mime-display-mixed (cdr handle)))))
4574
4575 (defun gnus-mime-part-function (handles)
4576   (if (stringp (car handles))
4577       (mapcar 'gnus-mime-part-function (cdr handles))
4578     (funcall gnus-article-mime-part-function handles)))
4579
4580 (defun gnus-mime-display-mixed (handles)
4581   (mapcar 'gnus-mime-display-part handles))
4582
4583 (defun gnus-mime-display-single (handle)
4584   (let ((type (mm-handle-media-type handle))
4585         (ignored gnus-ignored-mime-types)
4586         (not-attachment t)
4587         (move nil)
4588         display text)
4589     (catch 'ignored
4590       (progn
4591         (while ignored
4592           (when (string-match (pop ignored) type)
4593             (throw 'ignored nil)))
4594         (if (and (setq not-attachment
4595                        (and (not (mm-inline-override-p handle))
4596                             (or (not (mm-handle-disposition handle))
4597                                 (equal (car (mm-handle-disposition handle))
4598                                        "inline")
4599                                 (mm-attachment-override-p handle))))
4600                  (mm-automatic-display-p handle)
4601                  (or (and
4602                       (mm-inlinable-p handle)
4603                       (mm-inlined-p handle))
4604                      (mm-automatic-external-display-p type)))
4605             (setq display t)
4606           (when (equal (mm-handle-media-supertype handle) "text")
4607             (setq text t)))
4608         (let ((id (1+ (length gnus-article-mime-handle-alist)))
4609               beg)
4610           (push (cons id handle) gnus-article-mime-handle-alist)
4611           (when (or (not display)
4612                     (not (gnus-unbuttonized-mime-type-p type)))
4613             ;(gnus-article-insert-newline)
4614             (gnus-insert-mime-button
4615              handle id (list (or display (and not-attachment text))))
4616             (gnus-article-insert-newline)
4617             ;(gnus-article-insert-newline)
4618             ;; Remember modify the number of forward lines.
4619             (setq move t))
4620           (setq beg (point))
4621           (cond
4622            (display
4623             (when move
4624               (forward-line -1)
4625               (setq beg (point)))
4626             (let ((mail-parse-charset gnus-newsgroup-charset)
4627                   (mail-parse-ignored-charsets
4628                    (save-excursion (condition-case ()
4629                                        (set-buffer gnus-summary-buffer)
4630                                      (error))
4631                                    gnus-newsgroup-ignored-charsets)))
4632               (mm-display-part handle t))
4633             (goto-char (point-max)))
4634            ((and text not-attachment)
4635             (when move
4636               (forward-line -1)
4637               (setq beg (point)))
4638             (gnus-article-insert-newline)
4639             (mm-insert-inline handle (mm-get-part handle))
4640             (goto-char (point-max))))
4641           ;; Do highlighting.
4642           (save-excursion
4643             (save-restriction
4644               (narrow-to-region beg (point))
4645               (gnus-treat-article
4646                nil id
4647                (gnus-article-mime-total-parts)
4648                (mm-handle-media-type handle)))))))))
4649
4650 (defun gnus-unbuttonized-mime-type-p (type)
4651   "Say whether TYPE is to be unbuttonized."
4652   (unless gnus-inhibit-mime-unbuttonizing
4653     (when (catch 'found
4654             (let ((types gnus-unbuttonized-mime-types))
4655               (while types
4656                 (when (string-match (pop types) type)
4657                   (throw 'found t)))))
4658       (not (catch 'found
4659              (let ((types gnus-buttonized-mime-types))
4660                (while types
4661                  (when (string-match (pop types) type)
4662                    (throw 'found t)))))))))
4663
4664 (defun gnus-article-insert-newline ()
4665   "Insert a newline, but mark it as undeletable."
4666   (gnus-put-text-property
4667    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
4668
4669 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
4670   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
4671          (ihandles handles)
4672          (point (point))
4673          handle buffer-read-only from props begend not-pref)
4674     (save-window-excursion
4675       (save-restriction
4676         (when ibegend
4677           (narrow-to-region (car ibegend)
4678                             (or (cdr ibegend)
4679                                 (progn
4680                                   (goto-char (car ibegend))
4681                                   (forward-line 2)
4682                                   (point))))
4683           (delete-region (point-min) (point-max))
4684           (mm-remove-parts handles))
4685         (setq begend (list (point-marker)))
4686         ;; Do the toggle.
4687         (unless (setq not-pref (cadr (member preferred ihandles)))
4688           (setq not-pref (car ihandles)))
4689         (when (or ibegend
4690                   (not preferred)
4691                   (not (gnus-unbuttonized-mime-type-p
4692                         "multipart/alternative")))
4693           (gnus-add-text-properties
4694            (setq from (point))
4695            (progn
4696              (insert (format "%d.  " id))
4697              (point))
4698            `(gnus-callback
4699              (lambda (handles)
4700                (unless ,(not ibegend)
4701                  (setq gnus-article-mime-handle-alist
4702                        ',gnus-article-mime-handle-alist))
4703                (gnus-mime-display-alternative
4704                 ',ihandles ',not-pref ',begend ,id))
4705              ,@(gnus-local-map-property gnus-mime-button-map)
4706              ,gnus-mouse-face-prop ,gnus-article-mouse-face
4707              face ,gnus-article-button-face
4708              gnus-part ,id
4709              gnus-data ,handle))
4710           (widget-convert-button 'link from (point)
4711                                  :action 'gnus-widget-press-button
4712                                  :button-keymap gnus-widget-button-keymap)
4713           ;; Do the handles
4714           (while (setq handle (pop handles))
4715             (gnus-add-text-properties
4716              (setq from (point))
4717              (progn
4718                (insert (format "(%c) %-18s"
4719                                (if (equal handle preferred) ?* ? )
4720                                (mm-handle-media-type handle)))
4721                (point))
4722              `(gnus-callback
4723                (lambda (handles)
4724                  (unless ,(not ibegend)
4725                    (setq gnus-article-mime-handle-alist
4726                          ',gnus-article-mime-handle-alist))
4727                  (gnus-mime-display-alternative
4728                   ',ihandles ',handle ',begend ,id))
4729                ,@(gnus-local-map-property gnus-mime-button-map)
4730                ,gnus-mouse-face-prop ,gnus-article-mouse-face
4731                face ,gnus-article-button-face
4732                gnus-part ,id
4733                gnus-data ,handle))
4734             (widget-convert-button 'link from (point)
4735                                    :action 'gnus-widget-press-button
4736                                    :button-keymap gnus-widget-button-keymap)
4737             (insert "  "))
4738           (insert "\n\n"))
4739         (when preferred
4740           (if (stringp (car preferred))
4741               (gnus-display-mime preferred)
4742             (let ((mail-parse-charset gnus-newsgroup-charset)
4743                   (mail-parse-ignored-charsets
4744                    (save-excursion (set-buffer gnus-summary-buffer)
4745                                    gnus-newsgroup-ignored-charsets)))
4746               (mm-display-part preferred)
4747               ;; Do highlighting.
4748               (save-excursion
4749                 (save-restriction
4750                   (narrow-to-region (car begend) (point-max))
4751                   (gnus-treat-article
4752                    nil (length gnus-article-mime-handle-alist)
4753                    (gnus-article-mime-total-parts)
4754                    (mm-handle-media-type handle))))))
4755           (goto-char (point-max))
4756           (setcdr begend (point-marker)))))
4757     (when ibegend
4758       (goto-char point))))
4759
4760 (defconst gnus-article-wash-status-strings
4761   (let ((alist '((cite "c" "Possible hidden citation text"
4762                        " " "All citation text visible")
4763                  (headers "h" "Hidden headers"
4764                           " " "All headers visible.")
4765                  (pgp "p" "Encrypted or signed message status hidden"
4766                       " " "No hidden encryption nor digital signature status")
4767                  (signature "s" "Signature has been hidden"
4768                             " " "Signature is visible")
4769                  (overstrike "o" "Overstrike (^H) characters applied"
4770                              " " "No overstrike characters applied")
4771                  (emphasis "e" "/*_Emphasis_*/ characters applied"
4772                            " " "No /*_emphasis_*/ characters applied")))
4773         result)
4774     (dolist (entry alist result)
4775       (let ((key (nth 0 entry))
4776             (on (copy-sequence (nth 1 entry)))
4777             (on-help (nth 2 entry))
4778             (off (copy-sequence (nth 3 entry)))
4779             (off-help (nth 4 entry)))
4780         (put-text-property 0 1 'help-echo on-help on)
4781         (put-text-property 0 1 'help-echo off-help off)
4782         (push (list key on off) result))))
4783   "Alist of strings describing wash status in the mode line.
4784 Each entry has the form (KEY ON OF), where the KEY is a symbol
4785 representing the particular washing function, ON is the string to use
4786 in the article mode line when the washing function is active, and OFF
4787 is the string to use when it is inactive.")
4788
4789 (defun gnus-article-wash-status-entry (key value)
4790   (let ((entry (assoc key gnus-article-wash-status-strings)))
4791     (if value (nth 1 entry) (nth 2 entry))))
4792
4793 (defun gnus-article-wash-status ()
4794   "Return a string which display status of article washing."
4795   (save-excursion
4796     (set-buffer gnus-article-buffer)
4797     (let ((cite (memq 'cite gnus-article-wash-types))
4798           (headers (memq 'headers gnus-article-wash-types))
4799           (boring (memq 'boring-headers gnus-article-wash-types))
4800           (pgp (memq 'pgp gnus-article-wash-types))
4801           (pem (memq 'pem gnus-article-wash-types))
4802           (signed (memq 'signed gnus-article-wash-types))
4803           (encrypted (memq 'encrypted gnus-article-wash-types))
4804           (signature (memq 'signature gnus-article-wash-types))
4805           (overstrike (memq 'overstrike gnus-article-wash-types))
4806           (emphasis (memq 'emphasis gnus-article-wash-types)))
4807       (concat
4808        (gnus-article-wash-status-entry 'cite cite)
4809        (gnus-article-wash-status-entry 'headers (or headers boring))
4810        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
4811        (gnus-article-wash-status-entry 'signature signature)
4812        (gnus-article-wash-status-entry 'overstrike overstrike)
4813        (gnus-article-wash-status-entry 'emphasis emphasis)))))
4814
4815 (defun gnus-add-wash-type (type)
4816   "Add a washing of TYPE to the current status."
4817   (add-to-list 'gnus-article-wash-types type))
4818
4819 (defun gnus-delete-wash-type (type)
4820   "Add a washing of TYPE to the current status."
4821   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
4822
4823 (defun gnus-add-image (category image)
4824   "Add IMAGE of CATEGORY to the list of displayed images."
4825   (let ((entry (assq category gnus-article-image-alist)))
4826     (unless entry
4827       (setq entry (list category))
4828       (push entry gnus-article-image-alist))
4829     (nconc entry (list image))))
4830
4831 (defun gnus-delete-images (category)
4832   "Delete all images in CATEGORY."
4833   (let ((entry (assq category gnus-article-image-alist)))
4834     (dolist (image (cdr entry))
4835       (gnus-remove-image image))
4836     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
4837     (gnus-delete-wash-type category)))
4838
4839 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
4840
4841 (defun gnus-article-maybe-hide-headers ()
4842   "Hide unwanted headers if `gnus-have-all-headers' is nil.
4843 Provided for backwards compatibility."
4844   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
4845                  (not (save-excursion (set-buffer gnus-summary-buffer)
4846                                       gnus-have-all-headers)))
4847              (not gnus-inhibit-hiding))
4848     (gnus-article-hide-headers)))
4849
4850 ;;; Article savers.
4851
4852 (defun gnus-output-to-file (file-name)
4853   "Append the current article to a file named FILE-NAME."
4854   (let ((artbuf (current-buffer)))
4855     (with-temp-buffer
4856       (insert-buffer-substring artbuf)
4857       ;; Append newline at end of the buffer as separator, and then
4858       ;; save it to file.
4859       (goto-char (point-max))
4860       (insert "\n")
4861       (let ((file-name-coding-system nnmail-pathname-coding-system))
4862         (mm-append-to-file (point-min) (point-max) file-name))
4863       t)))
4864
4865 (defun gnus-narrow-to-page (&optional arg)
4866   "Narrow the article buffer to a page.
4867 If given a numerical ARG, move forward ARG pages."
4868   (interactive "P")
4869   (setq arg (if arg (prefix-numeric-value arg) 0))
4870   (save-excursion
4871     (set-buffer gnus-article-buffer)
4872     (goto-char (point-min))
4873     (widen)
4874     ;; Remove any old next/prev buttons.
4875     (when (gnus-visual-p 'page-marker)
4876       (let ((buffer-read-only nil))
4877         (gnus-remove-text-with-property 'gnus-prev)
4878         (gnus-remove-text-with-property 'gnus-next)))
4879     (when
4880         (cond ((< arg 0)
4881                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
4882               ((> arg 0)
4883                (re-search-forward page-delimiter nil 'move arg)))
4884       (goto-char (match-end 0)))
4885     (narrow-to-region
4886      (point)
4887      (if (re-search-forward page-delimiter nil 'move)
4888          (match-beginning 0)
4889        (point)))
4890     (when (and (gnus-visual-p 'page-marker)
4891                (not (= (point-min) 1)))
4892       (save-excursion
4893         (goto-char (point-min))
4894         (gnus-insert-prev-page-button)))
4895     (when (and (gnus-visual-p 'page-marker)
4896                (< (+ (point-max) 2) (buffer-size)))
4897       (save-excursion
4898         (goto-char (point-max))
4899         (gnus-insert-next-page-button)))))
4900
4901 ;; Article mode commands
4902
4903 (defun gnus-article-goto-next-page ()
4904   "Show the next page of the article."
4905   (interactive)
4906   (when (gnus-article-next-page)
4907     (goto-char (point-min))
4908     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
4909
4910
4911 (defun gnus-article-goto-prev-page ()
4912   "Show the next page of the article."
4913   (interactive)
4914   (if (bobp)
4915       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
4916     (gnus-article-prev-page nil)))
4917
4918 ;; This is cleaner but currently breaks `gnus-pick-mode':
4919 ;;
4920 ;; (defun gnus-article-goto-next-page ()
4921 ;;   "Show the next page of the article."
4922 ;;   (interactive)
4923 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
4924 ;;     (gnus-summary-next-page)))
4925 ;;
4926 ;; (defun gnus-article-goto-prev-page ()
4927 ;;   "Show the next page of the article."
4928 ;;   (interactive)
4929 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
4930 ;;     (gnus-summary-prev-page)))
4931
4932 (defun gnus-article-next-page (&optional lines)
4933   "Show the next page of the current article.
4934 If end of article, return non-nil.  Otherwise return nil.
4935 Argument LINES specifies lines to be scrolled up."
4936   (interactive "p")
4937   (move-to-window-line -1)
4938   (if (save-excursion
4939         (end-of-line)
4940         (and (pos-visible-in-window-p)  ;Not continuation line.
4941              (>= (1+ (point)) (point-max)))) ;Allow for trailing newline.
4942       ;; Nothing in this page.
4943       (if (or (not gnus-page-broken)
4944               (save-excursion
4945                 (save-restriction
4946                   (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
4947           (progn
4948             (when gnus-article-over-scroll
4949               (gnus-article-next-page-1 lines))
4950             t)                  ;Nothing more.
4951         (gnus-narrow-to-page 1)         ;Go to next page.
4952         nil)
4953     ;; More in this page.
4954     (gnus-article-next-page-1 lines)
4955     nil))
4956
4957 (defun gnus-article-next-page-1 (lines)
4958   (let ((scroll-in-place nil))
4959     (condition-case ()
4960         (scroll-up lines)
4961       (end-of-buffer
4962        ;; Long lines may cause an end-of-buffer error.
4963        (goto-char (point-max)))))
4964   (move-to-window-line 0))
4965
4966 (defun gnus-article-prev-page (&optional lines)
4967   "Show previous page of current article.
4968 Argument LINES specifies lines to be scrolled down."
4969   (interactive "p")
4970   (move-to-window-line 0)
4971   (if (and gnus-page-broken
4972            (bobp)
4973            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
4974       (progn
4975         (gnus-narrow-to-page -1)        ;Go to previous page.
4976         (goto-char (point-max))
4977         (recenter -1))
4978     (let ((scroll-in-place nil))
4979       (prog1
4980           (condition-case ()
4981               (scroll-down lines)
4982             (beginning-of-buffer
4983              (goto-char (point-min))))
4984         (move-to-window-line 0)))))
4985
4986 (defun gnus-article-only-boring-p ()
4987   "Decide whether there is only boring text remaining in the article.
4988 Something \"interesting\" is a word of at least two letters that does
4989 not have a face in `gnus-article-boring-faces'."
4990   (when (and gnus-article-skip-boring
4991              (boundp 'gnus-article-boring-faces)
4992              (symbol-value 'gnus-article-boring-faces))
4993     (save-excursion
4994       (catch 'only-boring
4995         (while (re-search-forward "\\b\\w\\w" nil t)
4996           (forward-char -1)
4997           (when (not (gnus-intersection
4998                       (gnus-faces-at (point))
4999                       (symbol-value 'gnus-article-boring-faces)))
5000             (throw 'only-boring nil)))
5001         (throw 'only-boring t)))))
5002
5003 (defun gnus-article-refer-article ()
5004   "Read article specified by message-id around point."
5005   (interactive)
5006   (save-excursion
5007     (re-search-backward "[ \t]\\|^" (gnus-point-at-bol) t)
5008     (re-search-forward "<?news:<?\\|<" (gnus-point-at-eol) t)
5009     (if (re-search-forward "[^@ ]+@[^ \t>]+" (gnus-point-at-eol) t)
5010         (let ((msg-id (concat "<" (match-string 0) ">")))
5011           (set-buffer gnus-summary-buffer)
5012           (gnus-summary-refer-article msg-id))
5013       (error "No references around point"))))
5014
5015 (defun gnus-article-show-summary ()
5016   "Reconfigure windows to show summary buffer."
5017   (interactive)
5018   (if (not (gnus-buffer-live-p gnus-summary-buffer))
5019       (error "There is no summary buffer for this article buffer")
5020     (gnus-article-set-globals)
5021     (gnus-configure-windows 'article)
5022     (gnus-summary-goto-subject gnus-current-article)
5023     (gnus-summary-position-point)))
5024
5025 (defun gnus-article-describe-briefly ()
5026   "Describe article mode commands briefly."
5027   (interactive)
5028   (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")))
5029
5030 (defun gnus-article-summary-command ()
5031   "Execute the last keystroke in the summary buffer."
5032   (interactive)
5033   (let ((obuf (current-buffer))
5034         (owin (current-window-configuration))
5035         func)
5036     (switch-to-buffer gnus-article-current-summary 'norecord)
5037     (setq func (lookup-key (current-local-map) (this-command-keys)))
5038     (call-interactively func)
5039     (set-buffer obuf)
5040     (set-window-configuration owin)
5041     (set-window-point (get-buffer-window (current-buffer)) (point))))
5042
5043 (defun gnus-article-summary-command-nosave ()
5044   "Execute the last keystroke in the summary buffer."
5045   (interactive)
5046   (let (func)
5047     (pop-to-buffer gnus-article-current-summary 'norecord)
5048     (setq func (lookup-key (current-local-map) (this-command-keys)))
5049     (call-interactively func)))
5050
5051 (defun gnus-article-check-buffer ()
5052   "Beep if not in an article buffer."
5053   (unless (equal major-mode 'gnus-article-mode)
5054     (error "Command invoked outside of a Gnus article buffer")))
5055
5056 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
5057   "Read a summary buffer key sequence and execute it from the article buffer."
5058   (interactive "P")
5059   (gnus-article-check-buffer)
5060   (let ((nosaves
5061          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
5062            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
5063            "=" "^" "\M-^" "|"))
5064         (nosave-but-article
5065          '("A\r"))
5066         (nosave-in-article
5067          '("\C-d"))
5068         (up-to-top
5069          '("n" "Gn" "p" "Gp"))
5070         keys new-sum-point)
5071     (save-excursion
5072       (set-buffer gnus-article-current-summary)
5073       (let (gnus-pick-mode)
5074         (push (or key last-command-event) unread-command-events)
5075         (setq keys (if (featurep 'xemacs)
5076                        (events-to-keys (read-key-sequence nil))
5077                      (read-key-sequence nil)))))
5078
5079     (message "")
5080
5081     (if (or (member keys nosaves)
5082             (member keys nosave-but-article)
5083             (member keys nosave-in-article))
5084         (let (func)
5085           (save-window-excursion
5086             (pop-to-buffer gnus-article-current-summary 'norecord)
5087             ;; We disable the pick minor mode commands.
5088             (let (gnus-pick-mode)
5089               (setq func (lookup-key (current-local-map) keys))))
5090           (if (or (not func)
5091                   (numberp func))
5092               (ding)
5093             (unless (member keys nosave-in-article)
5094               (set-buffer gnus-article-current-summary))
5095             (call-interactively func)
5096             (setq new-sum-point (point)))
5097           (when (member keys nosave-but-article)
5098             (pop-to-buffer gnus-article-buffer 'norecord)))
5099       ;; These commands should restore window configuration.
5100       (let ((obuf (current-buffer))
5101             (owin (current-window-configuration))
5102             (opoint (point))
5103             (summary gnus-article-current-summary)
5104             func in-buffer selected)
5105         (if not-restore-window
5106             (pop-to-buffer summary 'norecord)
5107           (switch-to-buffer summary 'norecord))
5108         (setq in-buffer (current-buffer))
5109         ;; We disable the pick minor mode commands.
5110         (if (and (setq func (let (gnus-pick-mode)
5111                               (lookup-key (current-local-map) keys)))
5112                  (functionp func))
5113             (progn
5114               (call-interactively func)
5115               (setq new-sum-point (point))
5116               (when (eq in-buffer (current-buffer))
5117                 (setq selected (gnus-summary-select-article))
5118                 (set-buffer obuf)
5119                 (unless not-restore-window
5120                   (set-window-configuration owin))
5121                 (when (eq selected 'old)
5122                   (article-goto-body)
5123                   (set-window-start (get-buffer-window (current-buffer))
5124                                     1)
5125                   (set-window-point (get-buffer-window (current-buffer))
5126                                     (point)))
5127                 (let ((win (get-buffer-window gnus-article-current-summary)))
5128                   (when win
5129                     (set-window-point win new-sum-point))))    )
5130           (switch-to-buffer gnus-article-buffer)
5131           (ding))))))
5132
5133 (defun gnus-article-describe-key (key)
5134   "Display documentation of the function invoked by KEY.  KEY is a string."
5135   (interactive "kDescribe key: ")
5136   (gnus-article-check-buffer)
5137   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5138       (save-excursion
5139         (set-buffer gnus-article-current-summary)
5140         (let (gnus-pick-mode)
5141           (if (featurep 'xemacs)
5142               (progn
5143                 (push (elt key 0) unread-command-events)
5144                 (setq key (events-to-keys
5145                            (read-key-sequence "Describe key: "))))
5146             (setq unread-command-events
5147                   (mapcar
5148                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5149                    (string-to-list key)))
5150             (setq key (read-key-sequence "Describe key: "))))
5151         (describe-key key))
5152     (describe-key key)))
5153
5154 (defun gnus-article-describe-key-briefly (key &optional insert)
5155   "Display documentation of the function invoked by KEY.  KEY is a string."
5156   (interactive "kDescribe key: \nP")
5157   (gnus-article-check-buffer)
5158   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5159       (save-excursion
5160         (set-buffer gnus-article-current-summary)
5161         (let (gnus-pick-mode)
5162           (if (featurep 'xemacs)
5163               (progn
5164                 (push (elt key 0) unread-command-events)
5165                 (setq key (events-to-keys
5166                            (read-key-sequence "Describe key: "))))
5167             (setq unread-command-events
5168                   (mapcar
5169                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5170                    (string-to-list key)))
5171             (setq key (read-key-sequence "Describe key: "))))
5172         (describe-key-briefly key insert))
5173     (describe-key-briefly key insert)))
5174
5175 (defun gnus-article-reply-with-original (&optional wide)
5176   "Start composing a reply mail to the current message.
5177 The text in the region will be yanked.  If the region isn't active,
5178 the entire article will be yanked."
5179   (interactive "P")
5180   (let ((article (cdr gnus-article-current))
5181         contents)
5182     (if (not (gnus-mark-active-p))
5183         (with-current-buffer gnus-summary-buffer
5184           (gnus-summary-reply (list (list article)) wide))
5185       (setq contents (buffer-substring (point) (mark t)))
5186       ;; Deactivate active regions.
5187       (when (and (boundp 'transient-mark-mode)
5188                  transient-mark-mode)
5189         (setq mark-active nil))
5190       (with-current-buffer gnus-summary-buffer
5191         (gnus-summary-reply
5192          (list (list article contents)) wide)))))
5193
5194 (defun gnus-article-followup-with-original ()
5195   "Compose a followup to the current article.
5196 The text in the region will be yanked.  If the region isn't active,
5197 the entire article will be yanked."
5198   (interactive)
5199   (let ((article (cdr gnus-article-current))
5200         contents)
5201       (if (not (gnus-mark-active-p))
5202           (with-current-buffer gnus-summary-buffer
5203             (gnus-summary-followup (list (list article))))
5204         (setq contents (buffer-substring (point) (mark t)))
5205         ;; Deactivate active regions.
5206         (when (and (boundp 'transient-mark-mode)
5207                    transient-mark-mode)
5208           (setq mark-active nil))
5209         (with-current-buffer gnus-summary-buffer
5210           (gnus-summary-followup
5211            (list (list article contents)))))))
5212
5213 (defun gnus-article-hide (&optional arg force)
5214   "Hide all the gruft in the current article.
5215 This means that signatures, cited text and (some) headers will be
5216 hidden.
5217 If given a prefix, show the hidden text instead."
5218   (interactive (append (gnus-article-hidden-arg) (list 'force)))
5219   (gnus-article-hide-headers arg)
5220   (gnus-article-hide-list-identifiers arg)
5221   (gnus-article-hide-citation-maybe arg force)
5222   (gnus-article-hide-signature arg))
5223
5224 (defun gnus-article-maybe-highlight ()
5225   "Do some article highlighting if article highlighting is requested."
5226   (when (gnus-visual-p 'article-highlight 'highlight)
5227     (gnus-article-highlight-some)))
5228
5229 (defun gnus-check-group-server ()
5230   ;; Make sure the connection to the server is alive.
5231   (unless (gnus-server-opened
5232            (gnus-find-method-for-group gnus-newsgroup-name))
5233     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
5234     (gnus-request-group gnus-newsgroup-name t)))
5235
5236 (eval-when-compile
5237   (autoload 'nneething-get-file-name "nneething"))
5238
5239 (defun gnus-request-article-this-buffer (article group)
5240   "Get an article and insert it into this buffer."
5241   (let (do-update-line sparse-header)
5242     (prog1
5243         (save-excursion
5244           (erase-buffer)
5245           (gnus-kill-all-overlays)
5246           (setq group (or group gnus-newsgroup-name))
5247
5248           ;; Using `gnus-request-article' directly will insert the article into
5249           ;; `nntp-server-buffer' - so we'll save some time by not having to
5250           ;; copy it from the server buffer into the article buffer.
5251
5252           ;; We only request an article by message-id when we do not have the
5253           ;; headers for it, so we'll have to get those.
5254           (when (stringp article)
5255             (gnus-read-header article))
5256
5257           ;; If the article number is negative, that means that this article
5258           ;; doesn't belong in this newsgroup (possibly), so we find its
5259           ;; message-id and request it by id instead of number.
5260           (when (and (numberp article)
5261                      gnus-summary-buffer
5262                      (get-buffer gnus-summary-buffer)
5263                      (gnus-buffer-exists-p gnus-summary-buffer))
5264             (save-excursion
5265               (set-buffer gnus-summary-buffer)
5266               (let ((header (gnus-summary-article-header article)))
5267                 (when (< article 0)
5268                   (cond
5269                    ((memq article gnus-newsgroup-sparse)
5270                     ;; This is a sparse gap article.
5271                     (setq do-update-line article)
5272                     (setq article (mail-header-id header))
5273                     (setq sparse-header (gnus-read-header article))
5274                     (setq gnus-newsgroup-sparse
5275                           (delq article gnus-newsgroup-sparse)))
5276                    ((vectorp header)
5277                     ;; It's a real article.
5278                     (setq article (mail-header-id header)))
5279                    (t
5280                     ;; It is an extracted pseudo-article.
5281                     (setq article 'pseudo)
5282                     (gnus-request-pseudo-article header))))
5283
5284                 (let ((method (gnus-find-method-for-group
5285                                gnus-newsgroup-name)))
5286                   (when (and (eq (car method) 'nneething)
5287                              (vectorp header))
5288                     (let ((dir (nneething-get-file-name
5289                                 (mail-header-id header))))
5290                       (when (and (stringp dir)
5291                                  (file-directory-p dir))
5292                         (setq article 'nneething)
5293                         (gnus-group-enter-directory dir))))))))
5294
5295           (cond
5296            ;; Refuse to select canceled articles.
5297            ((and (numberp article)
5298                  gnus-summary-buffer
5299                  (get-buffer gnus-summary-buffer)
5300                  (gnus-buffer-exists-p gnus-summary-buffer)
5301                  (eq (cdr (save-excursion
5302                             (set-buffer gnus-summary-buffer)
5303                             (assq article gnus-newsgroup-reads)))
5304                      gnus-canceled-mark))
5305             nil)
5306            ;; We first check `gnus-original-article-buffer'.
5307            ((and (get-buffer gnus-original-article-buffer)
5308                  (numberp article)
5309                  (save-excursion
5310                    (set-buffer gnus-original-article-buffer)
5311                    (and (equal (car gnus-original-article) group)
5312                         (eq (cdr gnus-original-article) article))))
5313             (insert-buffer-substring gnus-original-article-buffer)
5314             'article)
5315            ;; Check the backlog.
5316            ((and gnus-keep-backlog
5317                  (gnus-backlog-request-article group article (current-buffer)))
5318             'article)
5319            ;; Check asynchronous pre-fetch.
5320            ((gnus-async-request-fetched-article group article (current-buffer))
5321             (gnus-async-prefetch-next group article gnus-summary-buffer)
5322             (when (and (numberp article) gnus-keep-backlog)
5323               (gnus-backlog-enter-article group article (current-buffer)))
5324             'article)
5325            ;; Check the cache.
5326            ((and gnus-use-cache
5327                  (numberp article)
5328                  (gnus-cache-request-article article group))
5329             'article)
5330            ;; Check the agent cache.
5331            ((gnus-agent-request-article article group)
5332             'article)
5333            ;; Get the article and put into the article buffer.
5334            ((or (stringp article)
5335                 (numberp article))
5336             (let ((gnus-override-method gnus-override-method)
5337                   (methods (and (stringp article)
5338                                 gnus-refer-article-method))
5339                   (backend (car (gnus-find-method-for-group
5340                                  gnus-newsgroup-name)))
5341                   result
5342                   (buffer-read-only nil))
5343               (if (or (not (listp methods))
5344                       (and (symbolp (car methods))
5345                            (assq (car methods) nnoo-definition-alist)))
5346                   (setq methods (list methods)))
5347               (when (and (null gnus-override-method)
5348                          methods)
5349                 (setq gnus-override-method (pop methods)))
5350               (while (not result)
5351                 (when (eq gnus-override-method 'current)
5352                   (setq gnus-override-method
5353                         (with-current-buffer gnus-summary-buffer
5354                           gnus-current-select-method)))
5355                 (erase-buffer)
5356                 (gnus-kill-all-overlays)
5357                 (let ((gnus-newsgroup-name group))
5358                   (gnus-check-group-server))
5359                 (cond
5360                  ((gnus-request-article article group (current-buffer))
5361                   (when (numberp article)
5362                     (gnus-async-prefetch-next group article
5363                                               gnus-summary-buffer)
5364                     (when gnus-keep-backlog
5365                       (gnus-backlog-enter-article
5366                        group article (current-buffer))))
5367                   (setq result 'article))
5368                  (methods
5369                   (setq gnus-override-method (pop methods)))
5370                  ((not (string-match "^400 "
5371                                      (nnheader-get-report backend)))
5372                   ;; If we get 400 server disconnect, reconnect and
5373                   ;; retry; otherwise, assume the article has expired.
5374                   (setq result 'done))))
5375               (and (eq result 'article) 'article)))
5376            ;; It was a pseudo.
5377            (t article)))
5378
5379       ;; Associate this article with the current summary buffer.
5380       (setq gnus-article-current-summary gnus-summary-buffer)
5381
5382       ;; Take the article from the original article buffer
5383       ;; and place it in the buffer it's supposed to be in.
5384       (when (and (get-buffer gnus-article-buffer)
5385                  (equal (buffer-name (current-buffer))
5386                         (buffer-name (get-buffer gnus-article-buffer))))
5387         (save-excursion
5388           (if (get-buffer gnus-original-article-buffer)
5389               (set-buffer gnus-original-article-buffer)
5390             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
5391             (buffer-disable-undo)
5392             (setq major-mode 'gnus-original-article-mode)
5393             (setq buffer-read-only t))
5394           (let (buffer-read-only)
5395             (erase-buffer)
5396             (insert-buffer-substring gnus-article-buffer))
5397           (setq gnus-original-article (cons group article)))
5398
5399         ;; Decode charsets.
5400         (run-hooks 'gnus-article-decode-hook)
5401         ;; Mark article as decoded or not.
5402         (setq gnus-article-decoded-p gnus-article-decode-hook))
5403
5404       ;; Update sparse articles.
5405       (when (and do-update-line
5406                  (or (numberp article)
5407                      (stringp article)))
5408         (let ((buf (current-buffer)))
5409           (set-buffer gnus-summary-buffer)
5410           (gnus-summary-update-article do-update-line sparse-header)
5411           (gnus-summary-goto-subject do-update-line nil t)
5412           (set-window-point (gnus-get-buffer-window (current-buffer) t)
5413                             (point))
5414           (set-buffer buf))))))
5415
5416 ;;;
5417 ;;; Article editing
5418 ;;;
5419
5420 (defcustom gnus-article-edit-mode-hook nil
5421   "Hook run in article edit mode buffers."
5422   :group 'gnus-article-various
5423   :type 'hook)
5424
5425 (defvar gnus-article-edit-done-function nil)
5426
5427 (defvar gnus-article-edit-mode-map nil)
5428 (defvar gnus-article-edit-mode nil)
5429
5430 ;; Should we be using derived.el for this?
5431 (unless gnus-article-edit-mode-map
5432   (setq gnus-article-edit-mode-map (make-keymap))
5433   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
5434
5435   (gnus-define-keys gnus-article-edit-mode-map
5436     "\C-c?"    describe-mode
5437     "\C-c\C-c" gnus-article-edit-done
5438     "\C-c\C-k" gnus-article-edit-exit
5439     "\C-c\C-f\C-t" message-goto-to
5440     "\C-c\C-f\C-o" message-goto-from
5441     "\C-c\C-f\C-b" message-goto-bcc
5442     ;;"\C-c\C-f\C-w" message-goto-fcc
5443     "\C-c\C-f\C-c" message-goto-cc
5444     "\C-c\C-f\C-s" message-goto-subject
5445     "\C-c\C-f\C-r" message-goto-reply-to
5446     "\C-c\C-f\C-n" message-goto-newsgroups
5447     "\C-c\C-f\C-d" message-goto-distribution
5448     "\C-c\C-f\C-f" message-goto-followup-to
5449     "\C-c\C-f\C-m" message-goto-mail-followup-to
5450     "\C-c\C-f\C-k" message-goto-keywords
5451     "\C-c\C-f\C-u" message-goto-summary
5452     "\C-c\C-f\C-i" message-insert-or-toggle-importance
5453     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
5454     "\C-c\C-b" message-goto-body
5455     "\C-c\C-i" message-goto-signature
5456
5457     "\C-c\C-t" message-insert-to
5458     "\C-c\C-n" message-insert-newsgroups
5459     "\C-c\C-o" message-sort-headers
5460     "\C-c\C-e" message-elide-region
5461     "\C-c\C-v" message-delete-not-region
5462     "\C-c\C-z" message-kill-to-signature
5463     "\M-\r" message-newline-and-reformat
5464     "\C-c\C-a" mml-attach-file
5465     "\C-a" message-beginning-of-line
5466     "\t" message-tab
5467     "\M-;" comment-region)
5468
5469   (gnus-define-keys (gnus-article-edit-wash-map
5470                      "\C-c\C-w" gnus-article-edit-mode-map)
5471     "f" gnus-article-edit-full-stops))
5472
5473 (easy-menu-define
5474   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
5475   '("Field"
5476     ["Fetch To" message-insert-to t]
5477     ["Fetch Newsgroups" message-insert-newsgroups t]
5478     "----"
5479     ["To" message-goto-to t]
5480     ["From" message-goto-from t]
5481     ["Subject" message-goto-subject t]
5482     ["Cc" message-goto-cc t]
5483     ["Reply-To" message-goto-reply-to t]
5484     ["Summary" message-goto-summary t]
5485     ["Keywords" message-goto-keywords t]
5486     ["Newsgroups" message-goto-newsgroups t]
5487     ["Followup-To" message-goto-followup-to t]
5488     ["Mail-Followup-To" message-goto-mail-followup-to t]
5489     ["Distribution" message-goto-distribution t]
5490     ["Body" message-goto-body t]
5491     ["Signature" message-goto-signature t]))
5492
5493 (define-derived-mode gnus-article-edit-mode text-mode "Article Edit"
5494   "Major mode for editing articles.
5495 This is an extended text-mode.
5496
5497 \\{gnus-article-edit-mode-map}"
5498   (make-local-variable 'gnus-article-edit-done-function)
5499   (make-local-variable 'gnus-prev-winconf)
5500   (set (make-local-variable 'font-lock-defaults)
5501        '(message-font-lock-keywords t))
5502   (set (make-local-variable 'mail-header-separator) "")
5503   (set (make-local-variable 'gnus-article-edit-mode) t)
5504   (easy-menu-add message-mode-field-menu message-mode-map)
5505   (mml-mode)
5506   (setq buffer-read-only nil)
5507   (buffer-enable-undo)
5508   (widen))
5509
5510 (defun gnus-article-edit (&optional force)
5511   "Edit the current article.
5512 This will have permanent effect only in mail groups.
5513 If FORCE is non-nil, allow editing of articles even in read-only
5514 groups."
5515   (interactive "P")
5516   (when (and (not force)
5517              (gnus-group-read-only-p))
5518     (error "The current newsgroup does not support article editing"))
5519   (gnus-article-date-original)
5520   (gnus-article-edit-article
5521    'ignore
5522    `(lambda (no-highlight)
5523       'ignore
5524       (gnus-summary-edit-article-done
5525        ,(or (mail-header-references gnus-current-headers) "")
5526        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
5527
5528 (defun gnus-article-edit-article (start-func exit-func)
5529   "Start editing the contents of the current article buffer."
5530   (let ((winconf (current-window-configuration)))
5531     (set-buffer gnus-article-buffer)
5532     (gnus-article-edit-mode)
5533     (funcall start-func)
5534     (set-buffer-modified-p nil)
5535     (gnus-configure-windows 'edit-article)
5536     (setq gnus-article-edit-done-function exit-func)
5537     (setq gnus-prev-winconf winconf)
5538     (gnus-message 6 "C-c C-c to end edits")))
5539
5540 (defun gnus-article-edit-done (&optional arg)
5541   "Update the article edits and exit."
5542   (interactive "P")
5543   (let ((func gnus-article-edit-done-function)
5544         (buf (current-buffer))
5545         (start (window-start))
5546         (p (point))
5547         (winconf gnus-prev-winconf))
5548     (widen) ;; Widen it in case that users narrowed the buffer.
5549     (funcall func arg)
5550     (set-buffer buf)
5551     ;; The cache and backlog have to be flushed somewhat.
5552     (when gnus-keep-backlog
5553       (gnus-backlog-remove-article
5554        (car gnus-article-current) (cdr gnus-article-current)))
5555     ;; Flush original article as well.
5556     (save-excursion
5557       (when (get-buffer gnus-original-article-buffer)
5558         (set-buffer gnus-original-article-buffer)
5559         (setq gnus-original-article nil)))
5560     (when gnus-use-cache
5561       (gnus-cache-update-article
5562        (car gnus-article-current) (cdr gnus-article-current)))
5563     ;; We remove all text props from the article buffer.
5564     (kill-all-local-variables)
5565     (gnus-set-text-properties (point-min) (point-max) nil)
5566     (gnus-article-mode)
5567     (set-window-configuration winconf)
5568     (set-buffer buf)
5569     (set-window-start (get-buffer-window buf) start)
5570     (set-window-point (get-buffer-window buf) (point))))
5571
5572 (defun gnus-article-edit-exit ()
5573   "Exit the article editing without updating."
5574   (interactive)
5575   (when (or (not (buffer-modified-p))
5576             (yes-or-no-p "Article modified; kill anyway? "))
5577     (let ((curbuf (current-buffer))
5578           (p (point))
5579           (window-start (window-start)))
5580       (erase-buffer)
5581       (if (gnus-buffer-live-p gnus-original-article-buffer)
5582           (insert-buffer gnus-original-article-buffer))
5583       (let ((winconf gnus-prev-winconf))
5584         (kill-all-local-variables)
5585         (gnus-article-mode)
5586         (set-window-configuration winconf)
5587         ;; Tippy-toe some to make sure that point remains where it was.
5588         (save-current-buffer
5589           (set-buffer curbuf)
5590           (set-window-start (get-buffer-window (current-buffer)) window-start)
5591           (goto-char p))))))
5592
5593 (defun gnus-article-edit-full-stops ()
5594   "Interactively repair spacing at end of sentences."
5595   (interactive)
5596   (save-excursion
5597     (goto-char (point-min))
5598     (search-forward-regexp "^$" nil t)
5599     (let ((case-fold-search nil))
5600       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
5601
5602 ;;;
5603 ;;; Article highlights
5604 ;;;
5605
5606 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
5607
5608 ;;; Internal Variables:
5609
5610 (defcustom gnus-button-url-regexp
5611   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
5612       "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)\\(//[-a-z0-9_.]+:[0-9]*\\)?[-a-z0-9_=!?#$@~%&*+\\/:;.,[:word:]]+[-a-z0-9_=#$@~%&*+\\/[:word:]]\\)"
5613     "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)\\(//[-a-z0-9_.]+:[0-9]*\\)?\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)\\)")
5614   "Regular expression that matches URLs."
5615   :group 'gnus-article-buttons
5616   :type 'regexp)
5617
5618 (defcustom gnus-button-valid-fqdn-regexp
5619   message-valid-fqdn-regexp
5620   "Regular expression that matches a valid FQDN."
5621   :group 'gnus-article-buttons
5622   :type 'regexp)
5623
5624 (defcustom gnus-button-man-handler 'manual-entry
5625   "Function to use for displaying man pages.
5626 The function must take at least one argument with a string naming the
5627 man page."
5628   :type '(choice (function-item :tag "Man" manual-entry)
5629                  (function-item :tag "Woman" woman)
5630                  (function :tag "Other"))
5631   :group 'gnus-article-buttons)
5632
5633 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
5634   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
5635 If the default site is too slow, try to find a CTAN mirror, see
5636 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
5637 the variable `gnus-button-handle-ctan'."
5638   :group 'gnus-article-buttons
5639   :link '(custom-manual "(gnus)Group Parameters")
5640   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
5641                  (const "http://tug.ctan.org/tex-archive/")
5642                  (const "http://www.dante.de/CTAN/")
5643                  (string :tag "Other")))
5644
5645 (defcustom gnus-button-ctan-handler 'browse-url
5646   "Function to use for displaying CTAN links.
5647 The function must take one argument, the string naming the URL."
5648   :type '(choice (function-item :tag "Browse Url" browse-url)
5649                  (function :tag "Other"))
5650   :group 'gnus-article-buttons)
5651
5652 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
5653   "Bogus strings removed from CTAN URLs."
5654   :group 'gnus-article-buttons
5655   :type '(choice (const "^/?tex-archive/\\|/")
5656                  (regexp :tag "Other")))
5657
5658 (defcustom gnus-button-ctan-directory-regexp
5659   (concat
5660    "\\("; Cannot use `\(?: ... \)' (compatibility with Emacs 20).
5661    "biblio\\|digests\\|dviware\\|fonts\\|graphics\\|help\\|"
5662    "indexing\\|info\\|language\\|macros\\|support\\|systems\\|"
5663    "tds\\|tools\\|usergrps\\|web\\|nonfree\\|obsolete"
5664    "\\)")
5665   "Regular expression for ctan directories.
5666 It should match all directories in the top level of `gnus-ctan-url'."
5667   :group 'gnus-article-buttons
5668   :type 'regexp)
5669
5670 (defcustom gnus-button-mid-or-mail-regexp
5671   (concat "\\b\\(<?[a-z0-9][^<>\")!;:,{}\n\t ]*@"
5672           gnus-button-valid-fqdn-regexp
5673           ">?\\)\\b")
5674   "Regular expression that matches a message ID or a mail address."
5675   :group 'gnus-article-buttons
5676   :type 'regexp)
5677
5678 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
5679   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
5680 Strings like this can be either a message ID or a mail address.  If it is one
5681 of the symbols `mid' or `mail', Gnus will always assume that the string is a
5682 message ID or a mail address, respectivly.  If this variable is set to the
5683 symbol `ask', always query the user what do do.  If it is a function, this
5684 function will be called with the string as it's only argument.  The function
5685 must return `mid', `mail', `invalid' or `ask'."
5686   :group 'gnus-article-buttons
5687   :type '(choice (function-item :tag "Heuristic function"
5688                                 gnus-button-mid-or-mail-heuristic)
5689                  (const ask)
5690                  (const mid)
5691                  (const mail)))
5692
5693 (defcustom gnus-button-mid-or-mail-heuristic-alist
5694   '((-10.0 . ".+\\$.+@")
5695     (-10.0 . "#")
5696     (-10.0 . "\\*")
5697     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
5698     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
5699     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
5700     (-1.0  . "^[^a-z]+@")
5701     ;;
5702     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
5703     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
5704     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
5705     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
5706     ;;
5707     (-2.0  . "^[0-9]")
5708     (-1.0  . "^[0-9][0-9]")
5709     ;;
5710     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
5711     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
5712     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
5713     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
5714     ;;
5715     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
5716     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
5717     ;;       "[0-9]{8,}.*\@"
5718     (-3.0
5719      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
5720     ;; "[0-9]{12,}.*\@"
5721     ;; compensation for TDMA dated mail addresses:
5722     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
5723     ;;
5724     (-20.0 . "\\.fsf@") ;; Gnus
5725     (-20.0 . "^slrn")
5726     (-20.0 . "^Pine")
5727     (-20.0 . "_-_") ;; Subject change in thread
5728     ;;
5729     (-20.0 . "\\.ln@") ;; leafnode
5730     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
5731     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
5732     ;;
5733     ;; (5.0 . "") ;; $local_part_len <= 7
5734     (10.0  . "^[^0-9]+@")
5735     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
5736     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
5737     (3.0   . "\@stud")
5738     ;;
5739     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
5740     ;;
5741     (0.5   . "^[A-Z][a-z]")
5742     (0.5   . "^[A-Z][a-z][a-z]")
5743     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
5744     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
5745   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
5746
5747 A negative RATE indicates a message IDs, whereas a positive indicates a mail
5748 address.  The REGEXP is processed with `case-fold-search' set to `nil'."
5749   :group 'gnus-article-buttons
5750   :type '(repeat (cons (number :tag "Rate")
5751                        (regexp :tag "Regexp"))))
5752
5753 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
5754   "Guess whether MID-OR-MAIL is a message ID or a mail address.
5755 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
5756 address, `ask' if unsure and `invalid' if the string is invalid."
5757   (let ((case-fold-search nil)
5758         (list gnus-button-mid-or-mail-heuristic-alist)
5759         (result 0) rate regexp lpartlen elem)
5760     (setq lpartlen
5761           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
5762     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
5763     ;; Certain special cases...
5764     (when (string-match
5765            (concat
5766             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$" "\\|"
5767             "^[0-9]+\.[0-9]+\@compuserve")
5768            mid-or-mail)
5769       (gnus-message 8 "`%s' is a known mail address.")
5770       (setq result 'mail))
5771     (when (string-match "@.*@\\| " mid-or-mail)
5772       (gnus-message 8 "`%s' is invalid.")
5773       (setq result 'invalid))
5774     ;; Nothing more to do, if result is not a number here...
5775     (when (numberp result)
5776       (while list
5777         (setq elem (car list)
5778               rate (car elem)
5779               regexp (cdr elem)
5780               list (cdr list))
5781         (when (string-match regexp mid-or-mail)
5782           (setq result (+ result rate))
5783           (gnus-message
5784            9 "`%s' matched `%s', rate `%s', result `%s'."
5785            mid-or-mail regexp rate result)))
5786       (when (<= lpartlen 7)
5787         (setq result (+ result 5.0))
5788         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
5789                       mid-or-mail result))
5790       (when (>= lpartlen 12)
5791         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
5792         (cond
5793          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
5794           ;; Long local part should contain realname if e-mail address,
5795           ;; too many digits: message-id.
5796           ;; $score -= 5.0 + 0.1 * $local_part_len;
5797           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
5798           (setq result (+ result rate))
5799           (gnus-message
5800            9 "Many digits in `%s', rate `%s', result `%s'."
5801            mid-or-mail rate result))
5802          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
5803                         mid-or-mail)
5804           ;; Too few vowels [^aeiouy]{4,}.*\@
5805           (setq result (+ result -5.0))
5806           (gnus-message
5807            9 "Few vowels in `%s', rate `%s', result `%s'."
5808            mid-or-mail -5.0 result))
5809          (t
5810           (setq result (+ result 5.0))
5811           (gnus-message
5812            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
5813     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
5814     (cond
5815      ;; Maybe we should make this a customizable alist: (condition . 'result)
5816      ((< result -10.0) 'mid)
5817      ((> result  10.0) 'mail)
5818      (t 'ask))))
5819
5820 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
5821   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
5822          (url-mid (concat "news" ":" mid-or-mail))
5823          (url-mailto (concat "mailto" ":" mid-or-mail)))
5824     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
5825     (when (fboundp pref)
5826       (setq guessed
5827             ;; get rid of surrounding angles...
5828             (funcall pref
5829                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
5830       (if (or (eq 'mid guessed) (eq 'mail guessed))
5831           (setq pref guessed)
5832         (setq pref 'ask)))
5833     (if (eq pref 'ask)
5834         (save-window-excursion
5835           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
5836               (setq pref 'mail)
5837             (setq pref 'mid))))
5838     (cond ((eq pref 'mid)
5839            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
5840            (gnus-button-handle-news url-mid))
5841           ((eq pref 'mail)
5842            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
5843            (gnus-url-mailto url-mailto))
5844           (t (gnus-message 3 "Invalid string.")))))
5845
5846 (defun gnus-button-handle-custom (url)
5847   "Follow a Custom URL."
5848   (customize-apropos (gnus-url-unhex-string url)))
5849
5850 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
5851
5852 ;; FIXME: Maybe we should merge some of the functions that do quite similar
5853 ;; stuff?
5854
5855 (defun gnus-button-handle-describe-function (url)
5856   "Call `describe-function' when pushing the corresponding URL button."
5857   (describe-function
5858    (intern
5859     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5860
5861 (defun gnus-button-handle-describe-variable (url)
5862   "Call `describe-variable' when pushing the corresponding URL button."
5863   (describe-variable
5864    (intern
5865     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5866
5867 (defun gnus-button-handle-symbol (url)
5868 "Display help on variable or function.
5869 Calls `describe-variable' or `describe-function'."
5870   (let ((sym (intern url)))
5871     (cond
5872      ((fboundp sym) (describe-function sym))
5873      ((boundp sym) (describe-variable sym))
5874      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
5875
5876 (defun gnus-button-handle-describe-key (url)
5877   "Call `describe-key' when pushing the corresponding URL button."
5878   (let* ((key-string
5879           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
5880          (keys (ignore-errors (eval `(kbd ,key-string)))))
5881     (if keys
5882         (describe-key keys)
5883       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
5884
5885 (defun gnus-button-handle-apropos (url)
5886   "Call `apropos' when pushing the corresponding URL button."
5887   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5888
5889 (defun gnus-button-handle-apropos-command (url)
5890   "Call `apropos' when pushing the corresponding URL button."
5891   (apropos-command
5892    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5893
5894 (defun gnus-button-handle-apropos-variable (url)
5895   "Call `apropos' when pushing the corresponding URL button."
5896   (funcall
5897    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
5898    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5899
5900 (defun gnus-button-handle-apropos-documentation (url)
5901   "Call `apropos' when pushing the corresponding URL button."
5902   (funcall
5903    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
5904    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5905
5906 (defun gnus-button-handle-library (url)
5907   "Call `locate-library' when pushing the corresponding URL button."
5908   (gnus-message 9 "url=`%s'" url)
5909   (let* ((lib (locate-library url))
5910          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
5911     (if (not lib)
5912         (gnus-message 1 "Cannot locale library `%s'." url)
5913       (find-file-read-only file))))
5914
5915 (defun gnus-button-handle-ctan (url)
5916   "Call `browse-url' when pushing a CTAN URL button."
5917   (funcall
5918    gnus-button-ctan-handler
5919    (concat
5920     gnus-ctan-url
5921     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
5922
5923 (defcustom gnus-button-tex-level 5
5924   "*Integer that says how many TeX-related buttons Gnus will show.
5925 The higher the number, the more buttons will appear and the more false
5926 positives are possible.  Note that you can set this variable local to
5927 specifific groups.  Setting it higher in TeX groups is probably a good idea.
5928 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
5929 how to set variables in specific groups."
5930   :group 'gnus-article-buttons
5931   :link '(custom-manual "(gnus)Group Parameters")
5932   :type 'integer)
5933
5934 (defcustom gnus-button-man-level 5
5935   "*Integer that says how many man-related buttons Gnus will show.
5936 The higher the number, the more buttons will appear and the more false
5937 positives are possible.  Note that you can set this variable local to
5938 specifific groups.  Setting it higher in Unix groups is probably a good idea.
5939 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
5940 how to set variables in specific groups."
5941   :group 'gnus-article-buttons
5942   :link '(custom-manual "(gnus)Group Parameters")
5943   :type 'integer)
5944
5945 (defcustom gnus-button-emacs-level 5
5946   "*Integer that says how many emacs-related buttons Gnus will show.
5947 The higher the number, the more buttons will appear and the more false
5948 positives are possible.  Note that you can set this variable local to
5949 specifific groups.  Setting it higher in Emacs or Gnus related groups is
5950 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
5951 `gnus-parameters' on how to set variables in specific groups."
5952   :group 'gnus-article-buttons
5953   :link '(custom-manual "(gnus)Group Parameters")
5954   :type 'integer)
5955
5956 (defcustom gnus-button-message-level 5
5957   "*Integer that says how many buttons for news or mail messages will appear.
5958 The higher the number, the more buttons will appear and the more false
5959 positives are possible."
5960   ;; mail addresses, MIDs, URLs for news, ...
5961   :group 'gnus-article-buttons
5962   :type 'integer)
5963
5964 (defcustom gnus-button-browse-level 5
5965   "*Integer that says how many buttons for browsing will appear.
5966 The higher the number, the more buttons will appear and the more false
5967 positives are possible."
5968   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
5969   :group 'gnus-article-buttons
5970   :type 'integer)
5971
5972 (defcustom gnus-button-alist
5973   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
5974      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
5975     ("\\b\\(nntp\\|news\\):\\([^>\n\t ]*@[^>)!;:,\n\t ]*\\)" 0 t
5976      gnus-button-handle-news 2)
5977     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
5978      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
5979     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
5980      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
5981     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
5982      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
5983     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
5984      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
5985     ("mailto:\\([-a-z.@_+0-9%=?]+\\)"
5986      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
5987     ("\\bmailto:\\([^ \n\t]+\\)"
5988      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
5989     ;; CTAN
5990     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
5991              gnus-button-ctan-directory-regexp
5992              "[^][>)!;:,'\n\t ]+\\)")
5993      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
5994     ((concat "\\btex-archive/\\("
5995              gnus-button-ctan-directory-regexp
5996              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
5997      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
5998     ((concat
5999       "\\b\\("
6000       gnus-button-ctan-directory-regexp
6001       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
6002      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
6003     ;; This is info
6004     ("\\binfo:\\(//\\)?\\([^'\">\n\t ]+\\)"
6005      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
6006     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
6007      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
6008     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
6009      ;; Info links like `C-h i d m CC Mode RET'
6010      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 2)
6011     ;; This is custom
6012     ("\\bcustom:\\(//\\)?\\([^'\">\n\t ]+\\)"
6013      0 (>= gnus-button-emacs-level 5) gnus-button-handle-custom 2)
6014     ("M-x[ \t\n]customize-[^ ]+[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
6015      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1)
6016     ;; Emacs help commands
6017     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6018      ;; regexp doesn't match arguments containing ` '.
6019      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
6020     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6021      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
6022     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6023      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
6024     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6025      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
6026     ;; The following entries may lead to many false positives so don't enable
6027     ;; them by default (use a high button level):
6028     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>"
6029      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6030     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
6031      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6032     ("`\\([a-z][a-z0-9]+-[a-z]+-[-a-z]+\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
6033      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
6034     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
6035      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
6036     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
6037      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
6038     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6039      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
6040     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6041      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
6042     ("`\\(\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
6043      ;; Unlike the other regexps we really have to require quoting
6044      ;; here to determine where it ends.
6045      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
6046     ;; This is how URLs _should_ be embedded in text (RFC 1738)...
6047     ("<URL: *\\([^<>]*\\)>"
6048      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6049     ;; Raw URLs.
6050     (gnus-button-url-regexp
6051      0 (>= gnus-button-browse-level 0) browse-url 0)
6052     ;; man pages
6053     ("\\b\\([a-z][a-z]+\\)([1-9])\\W"
6054      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
6055      gnus-button-handle-man 1)
6056     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
6057     ("\\b\\([a-z][-_.a-z0-9]+\\)([1-9])\\W"
6058      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
6059      gnus-button-handle-man 1)
6060     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
6061     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
6062     ("\\b\\([a-z][-_.:a-z0-9]+\\)([1-9][X1a-z]*)\\W\\|\\b\\(X\\)([1-9])\\W"
6063      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
6064     ;; MID or mail: To avoid too many false positives we don't try to catch
6065     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
6066     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
6067     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
6068     ;; so that non-ambiguous entries (see above) match first.
6069     (gnus-button-mid-or-mail-regexp
6070      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
6071   "*Alist of regexps matching buttons in article bodies.
6072
6073 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
6074 REGEXP: is the string (case insensitive) matching text around the button (can
6075 also be lisp expression evaluating to a string),
6076 BUTTON: is the number of the regexp grouping actually matching the button,
6077 FORM: is a lisp expression which must eval to true for the button to
6078 be added,
6079 CALLBACK: is the function to call when the user push this button, and each
6080 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
6081
6082 CALLBACK can also be a variable, in that case the value of that
6083 variable it the real callback function."
6084   :group 'gnus-article-buttons
6085   :type '(repeat (list (choice regexp variable)
6086                        (integer :tag "Button")
6087                        (sexp :tag "Form")
6088                        (function :tag "Callback")
6089                        (repeat :tag "Par"
6090                                :inline t
6091                                (integer :tag "Regexp group")))))
6092
6093 (defcustom gnus-header-button-alist
6094   '(("^\\(References\\|Message-I[Dd]\\):" "<[^<>]+>"
6095      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
6096     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
6097      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
6098     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
6099      0 (>= gnus-button-message-level 0) gnus-button-mailto 0)
6100     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
6101      0 (>= gnus-button-browse-level 0) browse-url 0)
6102     ("^Subject:" gnus-button-url-regexp
6103      0 (>= gnus-button-browse-level 0) browse-url 0)
6104     ("^[^:]+:" gnus-button-url-regexp
6105      0 (>= gnus-button-browse-level 0) browse-url 0)
6106     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?]+\\)"
6107      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6108     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
6109      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
6110   "*Alist of headers and regexps to match buttons in article heads.
6111
6112 This alist is very similar to `gnus-button-alist', except that each
6113 alist has an additional HEADER element first in each entry:
6114
6115 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
6116
6117 HEADER is a regexp to match a header.  For a fuller explanation, see
6118 `gnus-button-alist'."
6119   :group 'gnus-article-buttons
6120   :group 'gnus-article-headers
6121   :type '(repeat (list (regexp :tag "Header")
6122                        regexp
6123                        (integer :tag "Button")
6124                        (sexp :tag "Form")
6125                        (function :tag "Callback")
6126                        (repeat :tag "Par"
6127                                :inline t
6128                                (integer :tag "Regexp group")))))
6129
6130 (defvar gnus-button-regexp nil)
6131 (defvar gnus-button-marker-list nil)
6132 ;; Regexp matching any of the regexps from `gnus-button-alist'.
6133
6134 (defvar gnus-button-last nil)
6135 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
6136
6137 ;;; Commands:
6138
6139 (defun gnus-article-push-button (event)
6140   "Check text under the mouse pointer for a callback function.
6141 If the text under the mouse pointer has a `gnus-callback' property,
6142 call it with the value of the `gnus-data' text property."
6143   (interactive "e")
6144   (set-buffer (window-buffer (posn-window (event-start event))))
6145   (let* ((pos (posn-point (event-start event)))
6146          (data (get-text-property pos 'gnus-data))
6147          (fun (get-text-property pos 'gnus-callback)))
6148     (goto-char pos)
6149     (when fun
6150       (funcall fun data))))
6151
6152 (defun gnus-article-press-button ()
6153   "Check text at point for a callback function.
6154 If the text at point has a `gnus-callback' property,
6155 call it with the value of the `gnus-data' text property."
6156   (interactive)
6157   (let ((data (get-text-property (point) 'gnus-data))
6158         (fun (get-text-property (point) 'gnus-callback)))
6159     (when fun
6160       (funcall fun data))))
6161
6162 (defun gnus-article-highlight (&optional force)
6163   "Highlight current article.
6164 This function calls `gnus-article-highlight-headers',
6165 `gnus-article-highlight-citation',
6166 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6167 do the highlighting.  See the documentation for those functions."
6168   (interactive (list 'force))
6169   (gnus-article-highlight-headers)
6170   (gnus-article-highlight-citation force)
6171   (gnus-article-highlight-signature)
6172   (gnus-article-add-buttons force)
6173   (gnus-article-add-buttons-to-head))
6174
6175 (defun gnus-article-highlight-some (&optional force)
6176   "Highlight current article.
6177 This function calls `gnus-article-highlight-headers',
6178 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6179 do the highlighting.  See the documentation for those functions."
6180   (interactive (list 'force))
6181   (gnus-article-highlight-headers)
6182   (gnus-article-highlight-signature)
6183   (gnus-article-add-buttons))
6184
6185 (defun gnus-article-highlight-headers ()
6186   "Highlight article headers as specified by `gnus-header-face-alist'."
6187   (interactive)
6188   (save-excursion
6189     (set-buffer gnus-article-buffer)
6190     (save-restriction
6191       (let ((alist gnus-header-face-alist)
6192             (buffer-read-only nil)
6193             (case-fold-search t)
6194             (inhibit-point-motion-hooks t)
6195             entry regexp header-face field-face from hpoints fpoints)
6196         (article-narrow-to-head)
6197         (while (setq entry (pop alist))
6198           (goto-char (point-min))
6199           (setq regexp (concat "^\\("
6200                                (if (string-equal "" (nth 0 entry))
6201                                    "[^\t ]"
6202                                  (nth 0 entry))
6203                                "\\)")
6204                 header-face (nth 1 entry)
6205                 field-face (nth 2 entry))
6206           (while (and (re-search-forward regexp nil t)
6207                       (not (eobp)))
6208             (beginning-of-line)
6209             (setq from (point))
6210             (unless (search-forward ":" nil t)
6211               (forward-char 1))
6212             (when (and header-face
6213                        (not (memq (point) hpoints)))
6214               (push (point) hpoints)
6215               (gnus-put-text-property from (point) 'face header-face))
6216             (when (and field-face
6217                        (not (memq (setq from (point)) fpoints)))
6218               (push from fpoints)
6219               (if (re-search-forward "^[^ \t]" nil t)
6220                   (forward-char -2)
6221                 (goto-char (point-max)))
6222               (gnus-put-text-property from (point) 'face field-face))))))))
6223
6224 (defun gnus-article-highlight-signature ()
6225   "Highlight the signature in an article.
6226 It does this by highlighting everything after
6227 `gnus-signature-separator' using `gnus-signature-face'."
6228   (interactive)
6229   (save-excursion
6230     (set-buffer gnus-article-buffer)
6231     (let ((buffer-read-only nil)
6232           (inhibit-point-motion-hooks t))
6233       (save-restriction
6234         (when (and gnus-signature-face
6235                    (gnus-article-narrow-to-signature))
6236           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
6237                             'face gnus-signature-face)
6238           (widen)
6239           (gnus-article-search-signature)
6240           (let ((start (match-beginning 0))
6241                 (end (set-marker (make-marker) (1+ (match-end 0)))))
6242             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
6243                                      end)))))))
6244
6245 (defun gnus-button-in-region-p (b e prop)
6246   "Say whether PROP exists in the region."
6247   (text-property-not-all b e prop nil))
6248
6249 (defun gnus-article-add-buttons (&optional force)
6250   "Find external references in the article and make buttons of them.
6251 \"External references\" are things like Message-IDs and URLs, as
6252 specified by `gnus-button-alist'."
6253   (interactive (list 'force))
6254   (save-excursion
6255     (set-buffer gnus-article-buffer)
6256     (let ((buffer-read-only nil)
6257           (inhibit-point-motion-hooks t)
6258           (case-fold-search t)
6259           (alist gnus-button-alist)
6260           beg entry regexp)
6261       ;; Remove all old markers.
6262       (let (marker entry new-list)
6263         (while (setq marker (pop gnus-button-marker-list))
6264           (if (or (< marker (point-min)) (>= marker (point-max)))
6265               (push marker new-list)
6266             (goto-char marker)
6267             (when (setq entry (gnus-button-entry))
6268               (put-text-property (match-beginning (nth 1 entry))
6269                                  (match-end (nth 1 entry))
6270                                  'gnus-callback nil))
6271             (set-marker marker nil)))
6272         (setq gnus-button-marker-list new-list))
6273       ;; We skip the headers.
6274       (article-goto-body)
6275       (setq beg (point))
6276       (while (setq entry (pop alist))
6277         (setq regexp (eval (car entry)))
6278         (goto-char beg)
6279         (while (re-search-forward regexp nil t)
6280           (let* ((start (and entry (match-beginning (nth 1 entry))))
6281                  (end (and entry (match-end (nth 1 entry))))
6282                  (from (match-beginning 0)))
6283             (when (and (or (eq t (nth 2 entry))
6284                            (eval (nth 2 entry)))
6285                        (not (gnus-button-in-region-p
6286                              start end 'gnus-callback)))
6287               ;; That optional form returned non-nil, so we add the
6288               ;; button.
6289               (gnus-article-add-button
6290                start end 'gnus-button-push
6291                (car (push (set-marker (make-marker) from)
6292                           gnus-button-marker-list))))))))))
6293
6294 ;; Add buttons to the head of an article.
6295 (defun gnus-article-add-buttons-to-head ()
6296   "Add buttons to the head of the article."
6297   (interactive)
6298   (save-excursion
6299     (set-buffer gnus-article-buffer)
6300     (save-restriction
6301       (let ((buffer-read-only nil)
6302             (inhibit-point-motion-hooks t)
6303             (case-fold-search t)
6304             (alist gnus-header-button-alist)
6305             entry beg end)
6306         (article-narrow-to-head)
6307         (while alist
6308           ;; Each alist entry.
6309           (setq entry (car alist)
6310                 alist (cdr alist))
6311           (goto-char (point-min))
6312           (while (re-search-forward (car entry) nil t)
6313             ;; Each header matching the entry.
6314             (setq beg (match-beginning 0))
6315             (setq end (or (and (re-search-forward "^[^ \t]" nil t)
6316                                (match-beginning 0))
6317                           (point-max)))
6318             (goto-char beg)
6319             (while (re-search-forward (eval (nth 1 entry)) end t)
6320               ;; Each match within a header.
6321               (let* ((entry (cdr entry))
6322                      (start (match-beginning (nth 1 entry)))
6323                      (end (match-end (nth 1 entry)))
6324                      (form (nth 2 entry)))
6325                 (goto-char (match-end 0))
6326                 (when (eval form)
6327                   (gnus-article-add-button
6328                    start end (nth 3 entry)
6329                    (buffer-substring (match-beginning (nth 4 entry))
6330                                      (match-end (nth 4 entry)))))))
6331             (goto-char end)))))))
6332
6333 ;;; External functions:
6334
6335 (defun gnus-article-add-button (from to fun &optional data)
6336   "Create a button between FROM and TO with callback FUN and data DATA."
6337   (when gnus-article-button-face
6338     (gnus-overlay-put (gnus-make-overlay from to)
6339                       'face gnus-article-button-face))
6340   (gnus-add-text-properties
6341    from to
6342    (nconc (and gnus-article-mouse-face
6343                (list gnus-mouse-face-prop gnus-article-mouse-face))
6344           (list 'gnus-callback fun)
6345           (and data (list 'gnus-data data))))
6346   (widget-convert-button 'link from to :action 'gnus-widget-press-button
6347                          :button-keymap gnus-widget-button-keymap))
6348
6349 ;;; Internal functions:
6350
6351 (defun gnus-article-set-globals ()
6352   (save-excursion
6353     (set-buffer gnus-summary-buffer)
6354     (gnus-set-global-variables)))
6355
6356 (defun gnus-signature-toggle (end)
6357   (save-excursion
6358     (set-buffer gnus-article-buffer)
6359     (let ((buffer-read-only nil)
6360           (inhibit-point-motion-hooks t))
6361       (if (text-property-any end (point-max) 'article-type 'signature)
6362           (progn
6363             (gnus-delete-wash-type 'signature)
6364             (gnus-remove-text-properties-when
6365              'article-type 'signature end (point-max)
6366              (cons 'article-type (cons 'signature
6367                                        gnus-hidden-properties))))
6368         (gnus-add-wash-type 'signature)
6369         (gnus-add-text-properties-when
6370          'article-type nil end (point-max)
6371          (cons 'article-type (cons 'signature
6372                                    gnus-hidden-properties)))))
6373     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
6374       (gnus-set-mode-line 'article))))
6375
6376 (defun gnus-button-entry ()
6377   ;; Return the first entry in `gnus-button-alist' matching this place.
6378   (let ((alist gnus-button-alist)
6379         (entry nil))
6380     (while alist
6381       (setq entry (pop alist))
6382       (if (looking-at (eval (car entry)))
6383           (setq alist nil)
6384         (setq entry nil)))
6385     entry))
6386
6387 (defun gnus-button-push (marker)
6388   ;; Push button starting at MARKER.
6389   (save-excursion
6390     (goto-char marker)
6391     (let* ((entry (gnus-button-entry))
6392            (inhibit-point-motion-hooks t)
6393            (fun (nth 3 entry))
6394            (args (mapcar (lambda (group)
6395                            (let ((string (match-string group)))
6396                              (gnus-set-text-properties
6397                               0 (length string) nil string)
6398                              string))
6399                          (nthcdr 4 entry))))
6400       (cond
6401        ((fboundp fun)
6402         (apply fun args))
6403        ((and (boundp fun)
6404              (fboundp (symbol-value fun)))
6405         (apply (symbol-value fun) args))
6406        (t
6407         (gnus-message 1 "You must define `%S' to use this button"
6408                       (cons fun args)))))))
6409
6410 (defun gnus-parse-news-url (url)
6411   (let (scheme server group message-id articles)
6412     (with-temp-buffer
6413       (insert url)
6414       (goto-char (point-min))
6415       (when (looking-at "\\([A-Za-z]+\\):")
6416         (setq scheme (match-string 1))
6417         (goto-char (match-end 0)))
6418       (when (looking-at "//\\([^/]+\\)/")
6419         (setq server (match-string 1))
6420         (goto-char (match-end 0)))
6421
6422       (cond
6423        ((looking-at "\\(.*@.*\\)")
6424         (setq message-id (match-string 1)))
6425        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
6426         (setq group (match-string 1)
6427               articles (split-string (match-string 2) "-")))
6428        ((looking-at "\\([^/]+\\)/?")
6429         (setq group (match-string 1)))
6430        (t
6431         (error "Unknown news URL syntax"))))
6432     (list scheme server group message-id articles)))
6433
6434 (defun gnus-button-handle-news (url)
6435   "Fetch a news URL."
6436   (destructuring-bind (scheme server group message-id articles)
6437       (gnus-parse-news-url url)
6438     (cond
6439      (message-id
6440       (save-excursion
6441         (set-buffer gnus-summary-buffer)
6442         (if server
6443             (let ((gnus-refer-article-method (list (list 'nntp server))))
6444               (gnus-summary-refer-article message-id))
6445           (gnus-summary-refer-article message-id))))
6446      (group
6447       (gnus-button-fetch-group url)))))
6448
6449 (defun gnus-button-handle-man (url)
6450   "Fetch a man page."
6451   (funcall gnus-button-man-handler url))
6452
6453 (defun gnus-button-handle-info-url (url)
6454   "Fetch an info URL."
6455   (cond
6456    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
6457     (gnus-info-find-node
6458      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
6459                      "Gnus")
6460              ")" (gnus-url-unhex-string (match-string 2 url)))))
6461    ((string-match "([^)\"]+)[^\"]+" url)
6462     (setq url
6463           (gnus-replace-in-string
6464            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
6465     (gnus-info-find-node url))
6466    (t (error "Can't parse %s" url))))
6467
6468 (defun gnus-button-handle-info-keystrokes (url)
6469   "Call `info' when pushing the corresponding URL button."
6470   ;; For links like `C-h i d m gnus RET', `C-h i d m CC Mode RET'.
6471   (info)
6472   (Info-directory)
6473   (Info-menu url))
6474
6475 (defun gnus-button-message-id (message-id)
6476   "Fetch MESSAGE-ID."
6477   (save-excursion
6478     (set-buffer gnus-summary-buffer)
6479     (gnus-summary-refer-article message-id)))
6480
6481 (defun gnus-button-fetch-group (address)
6482   "Fetch GROUP specified by ADDRESS."
6483   (if (not (string-match "[:/]" address))
6484       ;; This is just a simple group url.
6485       (gnus-group-read-ephemeral-group address gnus-select-method)
6486     (if (not
6487          (string-match
6488           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
6489           address))
6490         (error "Can't parse %s" address)
6491       (gnus-group-read-ephemeral-group
6492        (match-string 4 address)
6493        `(nntp ,(match-string 1 address)
6494               (nntp-address ,(match-string 1 address))
6495               (nntp-port-number ,(if (match-end 3)
6496                                      (match-string 3 address)
6497                                    "nntp")))
6498        nil nil nil
6499        (and (match-end 6) (list (string-to-int (match-string 6 address))))))))
6500
6501 (defun gnus-url-parse-query-string (query &optional downcase)
6502   (let (retval pairs cur key val)
6503     (setq pairs (split-string query "&"))
6504     (while pairs
6505       (setq cur (car pairs)
6506             pairs (cdr pairs))
6507       (if (not (string-match "=" cur))
6508           nil                           ; Grace
6509         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
6510               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
6511         (if downcase
6512             (setq key (downcase key)))
6513         (setq cur (assoc key retval))
6514         (if cur
6515             (setcdr cur (cons val (cdr cur)))
6516           (setq retval (cons (list key val) retval)))))
6517     retval))
6518
6519 (defun gnus-url-mailto (url)
6520   ;; Send mail to someone
6521   (when (string-match "mailto:/*\\(.*\\)" url)
6522     (setq url (substring url (match-beginning 1) nil)))
6523   (let (to args subject func)
6524     (if (string-match (regexp-quote "?") url)
6525         (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
6526               args (gnus-url-parse-query-string
6527                     (substring url (match-end 0) nil) t))
6528       (setq to (gnus-url-unhex-string url)))
6529     (setq args (cons (list "to" to) args)
6530           subject (cdr-safe (assoc "subject" args)))
6531     (gnus-msg-mail)
6532     (while args
6533       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
6534       (if (fboundp func)
6535           (funcall func)
6536         (message-position-on-field (caar args)))
6537       (insert (mapconcat 'identity (cdar args) ", "))
6538       (setq args (cdr args)))
6539     (if subject
6540         (message-goto-body)
6541       (message-goto-subject))))
6542
6543 (defun gnus-button-embedded-url (address)
6544   "Activate ADDRESS with `browse-url'."
6545   (browse-url (gnus-strip-whitespace address)))
6546
6547 ;;; Next/prev buttons in the article buffer.
6548
6549 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
6550 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
6551
6552 (defvar gnus-prev-page-map
6553   (let ((map (make-sparse-keymap)))
6554     (unless (>= emacs-major-version 21)
6555       ;; XEmacs doesn't care.
6556       (set-keymap-parent map gnus-article-mode-map))
6557     (define-key map gnus-mouse-2 'gnus-button-prev-page)
6558     (define-key map "\r" 'gnus-button-prev-page)
6559     map))
6560
6561 (defun gnus-insert-prev-page-button ()
6562   (let ((b (point))
6563         (buffer-read-only nil))
6564     (gnus-eval-format
6565      gnus-prev-page-line-format nil
6566      `(,@(gnus-local-map-property gnus-prev-page-map)
6567          gnus-prev t
6568          gnus-callback gnus-article-button-prev-page
6569          article-type annotation))
6570     (widget-convert-button
6571      'link b (if (bolp)
6572                  ;; Exclude a newline.
6573                  (1- (point))
6574                (point))
6575      :action 'gnus-button-prev-page
6576      :button-keymap gnus-prev-page-map)))
6577
6578 (defvar gnus-prev-page-map
6579   (let ((map (make-sparse-keymap)))
6580     (unless (>= emacs-major-version 21)
6581       ;; XEmacs doesn't care.
6582       (set-keymap-parent map gnus-article-mode-map))
6583     (define-key map gnus-mouse-2 'gnus-button-prev-page)
6584     (define-key map "\r" 'gnus-button-prev-page)
6585     map))
6586
6587 (defvar gnus-next-page-map
6588   (let ((map (make-sparse-keymap)))
6589     (unless (>= emacs-major-version 21)
6590       ;; XEmacs doesn't care.
6591       (set-keymap-parent map gnus-article-mode-map))
6592     (define-key map gnus-mouse-2 'gnus-button-next-page)
6593     (define-key map "\r" 'gnus-button-next-page)
6594     map))
6595
6596 (defun gnus-button-next-page (&optional args more-args)
6597   "Go to the next page."
6598   (interactive)
6599   (let ((win (selected-window)))
6600     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6601     (gnus-article-next-page)
6602     (select-window win)))
6603
6604 (defun gnus-button-prev-page (&optional args more-args)
6605   "Go to the prev page."
6606   (interactive)
6607   (let ((win (selected-window)))
6608     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6609     (gnus-article-prev-page)
6610     (select-window win)))
6611
6612 (defun gnus-insert-next-page-button ()
6613   (let ((b (point))
6614         (buffer-read-only nil))
6615     (gnus-eval-format gnus-next-page-line-format nil
6616                       `(,@(gnus-local-map-property gnus-next-page-map)
6617                           gnus-next t
6618                           gnus-callback gnus-article-button-next-page
6619                           article-type annotation))
6620     (widget-convert-button
6621      'link b (if (bolp)
6622                  ;; Exclude a newline.
6623                  (1- (point))
6624                (point))
6625      :action 'gnus-button-next-page
6626      :button-keymap gnus-next-page-map)))
6627
6628 (defun gnus-article-button-next-page (arg)
6629   "Go to the next page."
6630   (interactive "P")
6631   (let ((win (selected-window)))
6632     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6633     (gnus-article-next-page)
6634     (select-window win)))
6635
6636 (defun gnus-article-button-prev-page (arg)
6637   "Go to the prev page."
6638   (interactive "P")
6639   (let ((win (selected-window)))
6640     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6641     (gnus-article-prev-page)
6642     (select-window win)))
6643
6644 (defvar gnus-decode-header-methods
6645   '(mail-decode-encoded-word-region)
6646   "List of methods used to decode headers.
6647
6648 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
6649 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
6650 \(REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
6651 whose names match REGEXP.
6652
6653 For example:
6654 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
6655  mail-decode-encoded-word-region
6656  (\"chinese\" . rfc1843-decode-region))
6657 ")
6658
6659 (defvar gnus-decode-header-methods-cache nil)
6660
6661 (defun gnus-multi-decode-header (start end)
6662   "Apply the functions from `gnus-encoded-word-methods' that match."
6663   (unless (and gnus-decode-header-methods-cache
6664                (eq gnus-newsgroup-name
6665                    (car gnus-decode-header-methods-cache)))
6666     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
6667     (mapcar (lambda (x)
6668               (if (symbolp x)
6669                   (nconc gnus-decode-header-methods-cache (list x))
6670                 (if (and gnus-newsgroup-name
6671                          (string-match (car x) gnus-newsgroup-name))
6672                     (nconc gnus-decode-header-methods-cache
6673                            (list (cdr x))))))
6674           gnus-decode-header-methods))
6675   (let ((xlist gnus-decode-header-methods-cache))
6676     (pop xlist)
6677     (save-restriction
6678       (narrow-to-region start end)
6679       (while xlist
6680         (funcall (pop xlist) (point-min) (point-max))))))
6681
6682 ;;;
6683 ;;; Treatment top-level handling.
6684 ;;;
6685
6686 (defun gnus-treat-article (condition &optional part-number total-parts type)
6687   (let ((length (- (point-max) (point-min)))
6688         (alist gnus-treatment-function-alist)
6689         (article-goto-body-goes-to-point-min-p t)
6690         (treated-type
6691          (or (not type)
6692              (catch 'found
6693                (let ((list gnus-article-treat-types))
6694                  (while list
6695                    (when (string-match (pop list) type)
6696                      (throw 'found t)))))))
6697         (highlightp (gnus-visual-p 'article-highlight 'highlight))
6698         val elem)
6699     (gnus-run-hooks 'gnus-part-display-hook)
6700     (dolist (elem alist)
6701       (setq val
6702             (save-excursion
6703               (when (gnus-buffer-live-p gnus-summary-buffer)
6704                 (set-buffer gnus-summary-buffer))
6705               (symbol-value (car elem))))
6706       (when (and (or (consp val)
6707                      treated-type)
6708                  (gnus-treat-predicate val)
6709                  (or (not (get (car elem) 'highlight))
6710                      highlightp))
6711         (save-restriction
6712           (funcall (cadr elem)))))))
6713
6714 ;; Dynamic variables.
6715 (eval-when-compile
6716   (defvar part-number)
6717   (defvar total-parts)
6718   (defvar type)
6719   (defvar condition)
6720   (defvar length))
6721
6722 (defun gnus-treat-predicate (val)
6723   (cond
6724    ((null val)
6725     nil)
6726    (condition
6727     (eq condition val))
6728    ((and (listp val)
6729          (stringp (car val)))
6730     (apply 'gnus-or (mapcar `(lambda (s)
6731                                (string-match s ,(or gnus-newsgroup-name "")))
6732                             val)))
6733    ((listp val)
6734     (let ((pred (pop val)))
6735       (cond
6736        ((eq pred 'or)
6737         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
6738        ((eq pred 'and)
6739         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
6740        ((eq pred 'not)
6741         (not (gnus-treat-predicate (car val))))
6742        ((eq pred 'typep)
6743         (equal (car val) type))
6744        (t
6745         (error "%S is not a valid predicate" pred)))))
6746    ((eq val t)
6747     t)
6748    ((eq val 'head)
6749     nil)
6750    ((eq val 'last)
6751     (eq part-number total-parts))
6752    ((numberp val)
6753     (< length val))
6754    (t
6755     (error "%S is not a valid value" val))))
6756
6757 (defun gnus-article-encrypt-body (protocol &optional n)
6758   "Encrypt the article body."
6759   (interactive
6760    (list
6761     (or gnus-article-encrypt-protocol
6762         (completing-read "Encrypt protocol: "
6763                          gnus-article-encrypt-protocol-alist
6764                          nil t))
6765     current-prefix-arg))
6766   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
6767     (unless func
6768       (error (format "Can't find the encrypt protocol %s" protocol)))
6769     (if (member gnus-newsgroup-name '("nndraft:delayed"
6770                                       "nndraft:drafts"
6771                                       "nndraft:queue"))
6772         (error "Can't encrypt the article in group %s"
6773                gnus-newsgroup-name))
6774     (gnus-summary-iterate n
6775       (save-excursion
6776         (set-buffer gnus-summary-buffer)
6777         (let ((mail-parse-charset gnus-newsgroup-charset)
6778               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
6779               (summary-buffer gnus-summary-buffer)
6780               references point)
6781           (gnus-set-global-variables)
6782           (when (gnus-group-read-only-p)
6783             (error "The current newsgroup does not support article encrypt"))
6784           (gnus-summary-show-article t)
6785           (setq references
6786               (or (mail-header-references gnus-current-headers) ""))
6787           (set-buffer gnus-article-buffer)
6788           (let* ((buffer-read-only nil)
6789                  (headers
6790                   (mapcar (lambda (field)
6791                             (and (save-restriction
6792                                    (message-narrow-to-head)
6793                                    (goto-char (point-min))
6794                                    (search-forward field nil t))
6795                                  (prog2
6796                                      (message-narrow-to-field)
6797                                      (buffer-string)
6798                                    (delete-region (point-min) (point-max))
6799                                    (widen))))
6800                           '("Content-Type:" "Content-Transfer-Encoding:"
6801                             "Content-Disposition:"))))
6802             (message-narrow-to-head)
6803             (message-remove-header "MIME-Version")
6804             (goto-char (point-max))
6805             (setq point (point))
6806             (insert (apply 'concat headers))
6807             (widen)
6808             (narrow-to-region point (point-max))
6809             (let ((message-options message-options))
6810               (message-options-set 'message-sender user-mail-address)
6811               (message-options-set 'message-recipients user-mail-address)
6812               (message-options-set 'message-sign-encrypt 'not)
6813               (funcall func))
6814             (goto-char (point-min))
6815             (insert "MIME-Version: 1.0\n")
6816             (widen)
6817             (gnus-summary-edit-article-done
6818              references nil summary-buffer t))
6819           (when gnus-keep-backlog
6820             (gnus-backlog-remove-article
6821              (car gnus-article-current) (cdr gnus-article-current)))
6822           (save-excursion
6823             (when (get-buffer gnus-original-article-buffer)
6824               (set-buffer gnus-original-article-buffer)
6825               (setq gnus-original-article nil)))
6826           (when gnus-use-cache
6827             (gnus-cache-update-article
6828              (car gnus-article-current) (cdr gnus-article-current))))))))
6829
6830 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
6831   "The following specs can be used:
6832 %t  The security MIME type
6833 %i  Additional info
6834 %d  Details
6835 %D  Details if button is pressed")
6836
6837 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
6838   "The following specs can be used:
6839 %t  The security MIME type
6840 %i  Additional info
6841 %d  Details
6842 %D  Details if button is pressed")
6843
6844 (defvar gnus-mime-security-button-line-format-alist
6845   '((?t gnus-tmp-type ?s)
6846     (?i gnus-tmp-info ?s)
6847     (?d gnus-tmp-details ?s)
6848     (?D gnus-tmp-pressed-details ?s)))
6849
6850 (defvar gnus-mime-security-button-map
6851   (let ((map (make-sparse-keymap)))
6852     (unless (>= (string-to-number emacs-version) 21)
6853       (set-keymap-parent map gnus-article-mode-map))
6854     (define-key map gnus-mouse-2 'gnus-article-push-button)
6855     (define-key map "\r" 'gnus-article-press-button)
6856     map))
6857
6858 (defvar gnus-mime-security-details-buffer nil)
6859
6860 (defvar gnus-mime-security-button-pressed nil)
6861
6862 (defvar gnus-mime-security-show-details-inline t
6863   "If non-nil, show details in the article buffer.")
6864
6865 (defun gnus-mime-security-verify-or-decrypt (handle)
6866   (mm-remove-parts (cdr handle))
6867   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
6868         point buffer-read-only)
6869     (if region
6870         (goto-char (car region)))
6871     (save-restriction
6872       (narrow-to-region (point) (point))
6873       (with-current-buffer (mm-handle-multipart-original-buffer handle)
6874         (let* ((mm-verify-option 'known)
6875                (mm-decrypt-option 'known)
6876                (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
6877           (unless (eq nparts (cdr handle))
6878             (mm-destroy-parts (cdr handle))
6879             (setcdr handle nparts))))
6880       (setq point (point))
6881       (gnus-mime-display-security handle)
6882       (goto-char (point-max)))
6883     (when region
6884       (delete-region (point) (cdr region))
6885       (set-marker (car region) nil)
6886       (set-marker (cdr region) nil))
6887     (goto-char point)))
6888
6889 (defun gnus-mime-security-show-details (handle)
6890   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
6891     (if (not details)
6892         (gnus-message 5 "No details.")
6893       (if gnus-mime-security-show-details-inline
6894           (let ((gnus-mime-security-button-pressed
6895                  (not (get-text-property (point) 'gnus-mime-details)))
6896                 (gnus-mime-security-button-line-format
6897                  (get-text-property (point) 'gnus-line-format))
6898                 buffer-read-only)
6899             (forward-char -1)
6900             (while (eq (get-text-property (point) 'gnus-line-format)
6901                        gnus-mime-security-button-line-format)
6902               (forward-char -1))
6903             (forward-char)
6904             (save-restriction
6905               (narrow-to-region (point) (point))
6906               (gnus-insert-mime-security-button handle))
6907             (delete-region (point)
6908                            (or (text-property-not-all
6909                                 (point) (point-max)
6910                                 'gnus-line-format
6911                                 gnus-mime-security-button-line-format)
6912                                (point-max))))
6913         ;; Not inlined.
6914         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
6915             (with-current-buffer gnus-mime-security-details-buffer
6916               (erase-buffer)
6917               t)
6918           (setq gnus-mime-security-details-buffer
6919                 (gnus-get-buffer-create "*MIME Security Details*")))
6920         (with-current-buffer gnus-mime-security-details-buffer
6921           (insert details)
6922           (goto-char (point-min)))
6923         (pop-to-buffer gnus-mime-security-details-buffer)))))
6924
6925 (defun gnus-mime-security-press-button (handle)
6926   (save-excursion
6927     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
6928         (gnus-mime-security-show-details handle)
6929       (gnus-mime-security-verify-or-decrypt handle))))
6930
6931 (defun gnus-insert-mime-security-button (handle &optional displayed)
6932   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
6933          (gnus-tmp-type
6934           (concat
6935            (or (nth 2 (assoc protocol mm-verify-function-alist))
6936                (nth 2 (assoc protocol mm-decrypt-function-alist))
6937                "Unknown")
6938            (if (equal (car handle) "multipart/signed")
6939                " Signed" " Encrypted")
6940            " Part"))
6941          (gnus-tmp-info
6942           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
6943               "Undecided"))
6944          (gnus-tmp-details
6945           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
6946          gnus-tmp-pressed-details
6947          b e)
6948     (setq gnus-tmp-details
6949           (if gnus-tmp-details
6950               (concat "\n" gnus-tmp-details)
6951             ""))
6952     (setq gnus-tmp-pressed-details
6953           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
6954     (unless (bolp)
6955       (insert "\n"))
6956     (setq b (point))
6957     (gnus-eval-format
6958      gnus-mime-security-button-line-format
6959      gnus-mime-security-button-line-format-alist
6960      `(,@(gnus-local-map-property gnus-mime-security-button-map)
6961          gnus-callback gnus-mime-security-press-button
6962          gnus-line-format ,gnus-mime-security-button-line-format
6963          gnus-mime-details ,gnus-mime-security-button-pressed
6964          article-type annotation
6965          gnus-data ,handle))
6966     (setq e (if (bolp)
6967                 ;; Exclude a newline.
6968                 (1- (point))
6969               (point)))
6970     (widget-convert-button
6971      'link b e
6972      :mime-handle handle
6973      :action 'gnus-widget-press-button
6974      :button-keymap gnus-mime-security-button-map
6975      :help-echo
6976      (lambda (widget/window &optional overlay pos)
6977        ;; Needed to properly clear the message due to a bug in
6978        ;; wid-edit (XEmacs only).
6979        (when (boundp 'help-echo-owns-message)
6980          (setq help-echo-owns-message t))
6981        (format
6982         "%S: show detail"
6983         (aref gnus-mouse-2 0))))))
6984
6985 (defun gnus-mime-display-security (handle)
6986   (save-restriction
6987     (narrow-to-region (point) (point))
6988     (unless (gnus-unbuttonized-mime-type-p (car handle))
6989       (gnus-insert-mime-security-button handle))
6990     (gnus-mime-display-mixed (cdr handle))
6991     (unless (bolp)
6992       (insert "\n"))
6993     (unless (gnus-unbuttonized-mime-type-p (car handle))
6994       (let ((gnus-mime-security-button-line-format
6995              gnus-mime-security-button-end-line-format))
6996         (gnus-insert-mime-security-button handle)))
6997     (mm-set-handle-multipart-parameter
6998      handle 'gnus-region
6999      (cons (set-marker (make-marker) (point-min))
7000            (set-marker (make-marker) (point-max))))))
7001
7002 (gnus-ems-redefine)
7003
7004 (provide 'gnus-art)
7005
7006 (run-hooks 'gnus-art-load-hook)
7007
7008 ;;; gnus-art.el ends here