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

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